User::isValidUserName()   D
last analyzed

Complexity

Conditions 10
Paths 4

Size

Total Lines 37
Code Lines 24

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 10
eloc 24
nc 4
nop 1
dl 0
loc 37
rs 4.8196
c 0
b 0
f 0

How to fix   Complexity   

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
use Wikimedia\ScopedCallback;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, ScopedCallback.

Let’s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let’s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
30
31
/**
32
 * String Some punctuation to prevent editing from broken text-mangling proxies.
33
 * @deprecated since 1.27, use \MediaWiki\Session\Token::SUFFIX
34
 * @ingroup Constants
35
 */
36
define( 'EDIT_TOKEN_SUFFIX', Token::SUFFIX );
37
38
/**
39
 * The User object encapsulates all of the user-specific settings (user_id,
40
 * name, rights, email address, options, last login time). Client
41
 * classes use the getXXX() functions to access these fields. These functions
42
 * do all the work of determining whether the user is logged in,
43
 * whether the requested option can be satisfied from cookies or
44
 * whether a database query is needed. Most of the settings needed
45
 * for rendering normal pages are set in the cookie to minimize use
46
 * of the database.
47
 */
48
class User implements IDBAccessObject {
49
	/**
50
	 * @const int Number of characters in user_token field.
51
	 */
52
	const TOKEN_LENGTH = 32;
53
54
	/**
55
	 * @const string An invalid value for user_token
56
	 */
57
	const INVALID_TOKEN = '*** INVALID ***';
58
59
	/**
60
	 * Global constant made accessible as class constants so that autoloader
61
	 * magic can be used.
62
	 * @deprecated since 1.27, use \MediaWiki\Session\Token::SUFFIX
63
	 */
64
	const EDIT_TOKEN_SUFFIX = EDIT_TOKEN_SUFFIX;
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...
65
66
	/**
67
	 * @const int Serialized record version.
68
	 */
69
	const VERSION = 10;
70
71
	/**
72
	 * Exclude user options that are set to their default value.
73
	 * @since 1.25
74
	 */
75
	const GETOPTIONS_EXCLUDE_DEFAULTS = 1;
76
77
	/**
78
	 * @since 1.27
79
	 */
80
	const CHECK_USER_RIGHTS = true;
81
82
	/**
83
	 * @since 1.27
84
	 */
85
	const IGNORE_USER_RIGHTS = false;
86
87
	/**
88
	 * Array of Strings List of member variables which are saved to the
89
	 * shared cache (memcached). Any operation which changes the
90
	 * corresponding database fields must call a cache-clearing function.
91
	 * @showinitializer
92
	 */
93
	protected static $mCacheVars = [
94
		// user table
95
		'mId',
96
		'mName',
97
		'mRealName',
98
		'mEmail',
99
		'mTouched',
100
		'mToken',
101
		'mEmailAuthenticated',
102
		'mEmailToken',
103
		'mEmailTokenExpires',
104
		'mRegistration',
105
		'mEditCount',
106
		// user_groups table
107
		'mGroups',
108
		// user_properties table
109
		'mOptionOverrides',
110
	];
111
112
	/**
113
	 * Array of Strings Core rights.
114
	 * Each of these should have a corresponding message of the form
115
	 * "right-$right".
116
	 * @showinitializer
117
	 */
118
	protected static $mCoreRights = [
119
		'apihighlimits',
120
		'applychangetags',
121
		'autoconfirmed',
122
		'autocreateaccount',
123
		'autopatrol',
124
		'bigdelete',
125
		'block',
126
		'blockemail',
127
		'bot',
128
		'browsearchive',
129
		'changetags',
130
		'createaccount',
131
		'createpage',
132
		'createtalk',
133
		'delete',
134
		'deletechangetags',
135
		'deletedhistory',
136
		'deletedtext',
137
		'deletelogentry',
138
		'deleterevision',
139
		'edit',
140
		'editcontentmodel',
141
		'editinterface',
142
		'editprotected',
143
		'editmyoptions',
144
		'editmyprivateinfo',
145
		'editmyusercss',
146
		'editmyuserjs',
147
		'editmywatchlist',
148
		'editsemiprotected',
149
		'editusercssjs', # deprecated
150
		'editusercss',
151
		'edituserjs',
152
		'hideuser',
153
		'import',
154
		'importupload',
155
		'ipblock-exempt',
156
		'managechangetags',
157
		'markbotedits',
158
		'mergehistory',
159
		'minoredit',
160
		'move',
161
		'movefile',
162
		'move-categorypages',
163
		'move-rootuserpages',
164
		'move-subpages',
165
		'nominornewtalk',
166
		'noratelimit',
167
		'override-export-depth',
168
		'pagelang',
169
		'passwordreset',
170
		'patrol',
171
		'patrolmarks',
172
		'protect',
173
		'purge',
174
		'read',
175
		'reupload',
176
		'reupload-own',
177
		'reupload-shared',
178
		'rollback',
179
		'sendemail',
180
		'siteadmin',
181
		'suppressionlog',
182
		'suppressredirect',
183
		'suppressrevision',
184
		'unblockself',
185
		'undelete',
186
		'unwatchedpages',
187
		'upload',
188
		'upload_by_url',
189
		'userrights',
190
		'userrights-interwiki',
191
		'viewmyprivateinfo',
192
		'viewmywatchlist',
193
		'viewsuppressed',
194
		'writeapi',
195
	];
196
197
	/**
198
	 * String Cached results of getAllRights()
199
	 */
200
	protected static $mAllRights = false;
201
202
	/** Cache variables */
203
	// @{
204
	/** @var int */
205
	public $mId;
206
	/** @var string */
207
	public $mName;
208
	/** @var string */
209
	public $mRealName;
210
211
	/** @var string */
212
	public $mEmail;
213
	/** @var string TS_MW timestamp from the DB */
214
	public $mTouched;
215
	/** @var string TS_MW timestamp from cache */
216
	protected $mQuickTouched;
217
	/** @var string */
218
	protected $mToken;
219
	/** @var string */
220
	public $mEmailAuthenticated;
221
	/** @var string */
222
	protected $mEmailToken;
223
	/** @var string */
224
	protected $mEmailTokenExpires;
225
	/** @var string */
226
	protected $mRegistration;
227
	/** @var int */
228
	protected $mEditCount;
229
	/** @var array */
230
	public $mGroups;
231
	/** @var array */
232
	protected $mOptionOverrides;
233
	// @}
234
235
	/**
236
	 * Bool Whether the cache variables have been loaded.
237
	 */
238
	// @{
239
	public $mOptionsLoaded;
240
241
	/**
242
	 * Array with already loaded items or true if all items have been loaded.
243
	 */
244
	protected $mLoadedItems = [];
245
	// @}
246
247
	/**
248
	 * String Initialization data source if mLoadedItems!==true. May be one of:
249
	 *  - 'defaults'   anonymous user initialised from class defaults
250
	 *  - 'name'       initialise from mName
251
	 *  - 'id'         initialise from mId
252
	 *  - 'session'    log in from session if possible
253
	 *
254
	 * Use the User::newFrom*() family of functions to set this.
255
	 */
256
	public $mFrom;
257
258
	/**
259
	 * Lazy-initialized variables, invalidated with clearInstanceCache
260
	 */
261
	protected $mNewtalk;
262
	/** @var string */
263
	protected $mDatePreference;
264
	/** @var string */
265
	public $mBlockedby;
266
	/** @var string */
267
	protected $mHash;
268
	/** @var array */
269
	public $mRights;
270
	/** @var string */
271
	protected $mBlockreason;
272
	/** @var array */
273
	protected $mEffectiveGroups;
274
	/** @var array */
275
	protected $mImplicitGroups;
276
	/** @var array */
277
	protected $mFormerGroups;
278
	/** @var Block */
279
	protected $mGlobalBlock;
280
	/** @var bool */
281
	protected $mLocked;
282
	/** @var bool */
283
	public $mHideName;
284
	/** @var array */
285
	public $mOptions;
286
287
	/**
288
	 * @var WebRequest
289
	 */
290
	private $mRequest;
291
292
	/** @var Block */
293
	public $mBlock;
294
295
	/** @var bool */
296
	protected $mAllowUsertalk;
297
298
	/** @var Block */
299
	private $mBlockedFromCreateAccount = false;
300
301
	/** @var integer User::READ_* constant bitfield used to load data */
302
	protected $queryFlagsUsed = self::READ_NORMAL;
303
304
	public static $idCacheByName = [];
305
306
	/**
307
	 * Lightweight constructor for an anonymous user.
308
	 * Use the User::newFrom* factory functions for other kinds of users.
309
	 *
310
	 * @see newFromName()
311
	 * @see newFromId()
312
	 * @see newFromConfirmationCode()
313
	 * @see newFromSession()
314
	 * @see newFromRow()
315
	 */
316
	public function __construct() {
317
		$this->clearInstanceCache( 'defaults' );
318
	}
319
320
	/**
321
	 * @return string
322
	 */
323
	public function __toString() {
324
		return (string)$this->getName();
325
	}
326
327
	/**
328
	 * Test if it's safe to load this User object.
329
	 *
330
	 * You should typically check this before using $wgUser or
331
	 * RequestContext::getUser in a method that might be called before the
332
	 * system has been fully initialized. If the object is unsafe, you should
333
	 * use an anonymous user:
334
	 * \code
335
	 * $user = $wgUser->isSafeToLoad() ? $wgUser : new User;
336
	 * \endcode
337
	 *
338
	 * @since 1.27
339
	 * @return bool
340
	 */
341
	public function isSafeToLoad() {
342
		global $wgFullyInitialised;
343
344
		// The user is safe to load if:
345
		// * MW_NO_SESSION is undefined AND $wgFullyInitialised is true (safe to use session data)
346
		// * mLoadedItems === true (already loaded)
347
		// * mFrom !== 'session' (sessions not involved at all)
348
349
		return ( !defined( 'MW_NO_SESSION' ) && $wgFullyInitialised ) ||
350
			$this->mLoadedItems === true || $this->mFrom !== 'session';
351
	}
352
353
	/**
354
	 * Load the user table data for this object from the source given by mFrom.
355
	 *
356
	 * @param integer $flags User::READ_* constant bitfield
357
	 */
358
	public function load( $flags = self::READ_NORMAL ) {
359
		global $wgFullyInitialised;
360
361
		if ( $this->mLoadedItems === true ) {
362
			return;
363
		}
364
365
		// Set it now to avoid infinite recursion in accessors
366
		$oldLoadedItems = $this->mLoadedItems;
367
		$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...
368
		$this->queryFlagsUsed = $flags;
369
370
		// If this is called too early, things are likely to break.
371
		if ( !$wgFullyInitialised && $this->mFrom === 'session' ) {
372
			\MediaWiki\Logger\LoggerFactory::getInstance( 'session' )
373
				->warning( 'User::loadFromSession called before the end of Setup.php', [
374
					'exception' => new Exception( 'User::loadFromSession called before the end of Setup.php' ),
375
				] );
376
			$this->loadDefaults();
377
			$this->mLoadedItems = $oldLoadedItems;
378
			return;
379
		}
380
381
		switch ( $this->mFrom ) {
382
			case 'defaults':
383
				$this->loadDefaults();
384
				break;
385
			case 'name':
386
				// Make sure this thread sees its own changes
387
				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...
388
					$flags |= self::READ_LATEST;
389
					$this->queryFlagsUsed = $flags;
390
				}
391
392
				$this->mId = self::idFromName( $this->mName, $flags );
393
				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...
394
					// Nonexistent user placeholder object
395
					$this->loadDefaults( $this->mName );
396
				} else {
397
					$this->loadFromId( $flags );
398
				}
399
				break;
400
			case 'id':
401
				$this->loadFromId( $flags );
402
				break;
403
			case 'session':
404
				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...
405
					// Loading from session failed. Load defaults.
406
					$this->loadDefaults();
407
				}
408
				Hooks::run( 'UserLoadAfterLoadFromSession', [ $this ] );
409
				break;
410
			default:
411
				throw new UnexpectedValueException(
412
					"Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
413
		}
414
	}
415
416
	/**
417
	 * Load user table data, given mId has already been set.
418
	 * @param integer $flags User::READ_* constant bitfield
419
	 * @return bool False if the ID does not exist, true otherwise
420
	 */
421
	public function loadFromId( $flags = self::READ_NORMAL ) {
422
		if ( $this->mId == 0 ) {
423
			// Anonymous users are not in the database (don't need cache)
424
			$this->loadDefaults();
425
			return false;
426
		}
427
428
		// Try cache (unless this needs data from the master DB).
429
		// NOTE: if this thread called saveSettings(), the cache was cleared.
430
		$latest = DBAccessObjectUtils::hasFlags( $flags, self::READ_LATEST );
431
		if ( $latest ) {
432
			if ( !$this->loadFromDatabase( $flags ) ) {
433
				// Can't load from ID
434
				return false;
435
			}
436
		} else {
437
			$this->loadFromCache();
438
		}
439
440
		$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...
441
		$this->queryFlagsUsed = $flags;
442
443
		return true;
444
	}
445
446
	/**
447
	 * @since 1.27
448
	 * @param string $wikiId
449
	 * @param integer $userId
450
	 */
451
	public static function purge( $wikiId, $userId ) {
452
		$cache = ObjectCache::getMainWANInstance();
453
		$key = $cache->makeGlobalKey( 'user', 'id', $wikiId, $userId );
454
		$cache->delete( $key );
455
	}
456
457
	/**
458
	 * @since 1.27
459
	 * @param WANObjectCache $cache
460
	 * @return string
461
	 */
462
	protected function getCacheKey( WANObjectCache $cache ) {
463
		return $cache->makeGlobalKey( 'user', 'id', wfWikiID(), $this->mId );
464
	}
465
466
	/**
467
	 * Load user data from shared cache, given mId has already been set.
468
	 *
469
	 * @return bool True
470
	 * @since 1.25
471
	 */
472
	protected function loadFromCache() {
473
		$cache = ObjectCache::getMainWANInstance();
474
		$data = $cache->getWithSetCallback(
475
			$this->getCacheKey( $cache ),
476
			$cache::TTL_HOUR,
477
			function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
478
				$setOpts += Database::getCacheSetOptions( wfGetDB( DB_REPLICA ) );
479
				wfDebug( "User: cache miss for user {$this->mId}\n" );
480
481
				$this->loadFromDatabase( self::READ_NORMAL );
482
				$this->loadGroups();
483
				$this->loadOptions();
484
485
				$data = [];
486
				foreach ( self::$mCacheVars as $name ) {
487
					$data[$name] = $this->$name;
488
				}
489
490
				$ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX, $this->mTouched ), $ttl );
491
492
				return $data;
493
494
			},
495
			[ 'pcTTL' => $cache::TTL_PROC_LONG, 'version' => self::VERSION ]
496
		);
497
498
		// Restore from cache
499
		foreach ( self::$mCacheVars as $name ) {
500
			$this->$name = $data[$name];
501
		}
502
503
		return true;
504
	}
505
506
	/** @name newFrom*() static factory methods */
507
	// @{
508
509
	/**
510
	 * Static factory method for creation from username.
511
	 *
512
	 * This is slightly less efficient than newFromId(), so use newFromId() if
513
	 * you have both an ID and a name handy.
514
	 *
515
	 * @param string $name Username, validated by Title::newFromText()
516
	 * @param string|bool $validate Validate username. Takes the same parameters as
517
	 *  User::getCanonicalName(), except that true is accepted as an alias
518
	 *  for 'valid', for BC.
519
	 *
520
	 * @return User|bool User object, or false if the username is invalid
521
	 *  (e.g. if it contains illegal characters or is an IP address). If the
522
	 *  username is not present in the database, the result will be a user object
523
	 *  with a name, zero user ID and default settings.
524
	 */
525
	public static function newFromName( $name, $validate = 'valid' ) {
526
		if ( $validate === true ) {
527
			$validate = 'valid';
528
		}
529
		$name = self::getCanonicalName( $name, $validate );
530
		if ( $name === false ) {
531
			return false;
532
		} else {
533
			// Create unloaded user object
534
			$u = new User;
535
			$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...
536
			$u->mFrom = 'name';
537
			$u->setItemLoaded( 'name' );
538
			return $u;
539
		}
540
	}
541
542
	/**
543
	 * Static factory method for creation from a given user ID.
544
	 *
545
	 * @param int $id Valid user ID
546
	 * @return User The corresponding User object
547
	 */
548
	public static function newFromId( $id ) {
549
		$u = new User;
550
		$u->mId = $id;
551
		$u->mFrom = 'id';
552
		$u->setItemLoaded( 'id' );
553
		return $u;
554
	}
555
556
	/**
557
	 * Factory method to fetch whichever user has a given email confirmation code.
558
	 * This code is generated when an account is created or its e-mail address
559
	 * has changed.
560
	 *
561
	 * If the code is invalid or has expired, returns NULL.
562
	 *
563
	 * @param string $code Confirmation code
564
	 * @param int $flags User::READ_* bitfield
565
	 * @return User|null
566
	 */
567
	public static function newFromConfirmationCode( $code, $flags = 0 ) {
568
		$db = ( $flags & self::READ_LATEST ) == self::READ_LATEST
569
			? wfGetDB( DB_MASTER )
570
			: wfGetDB( DB_REPLICA );
571
572
		$id = $db->selectField(
573
			'user',
574
			'user_id',
575
			[
576
				'user_email_token' => md5( $code ),
577
				'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
578
			]
579
		);
580
581
		return $id ? User::newFromId( $id ) : null;
582
	}
583
584
	/**
585
	 * Create a new user object using data from session. If the login
586
	 * credentials are invalid, the result is an anonymous user.
587
	 *
588
	 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
589
	 * @return User
590
	 */
591
	public static function newFromSession( WebRequest $request = null ) {
592
		$user = new User;
593
		$user->mFrom = 'session';
594
		$user->mRequest = $request;
595
		return $user;
596
	}
597
598
	/**
599
	 * Create a new user object from a user row.
600
	 * The row should have the following fields from the user table in it:
601
	 * - either user_name or user_id to load further data if needed (or both)
602
	 * - user_real_name
603
	 * - all other fields (email, etc.)
604
	 * It is useless to provide the remaining fields if either user_id,
605
	 * user_name and user_real_name are not provided because the whole row
606
	 * will be loaded once more from the database when accessing them.
607
	 *
608
	 * @param stdClass $row A row from the user table
609
	 * @param array $data Further data to load into the object (see User::loadFromRow for valid keys)
610
	 * @return User
611
	 */
612
	public static function newFromRow( $row, $data = null ) {
613
		$user = new User;
614
		$user->loadFromRow( $row, $data );
615
		return $user;
616
	}
617
618
	/**
619
	 * Static factory method for creation of a "system" user from username.
620
	 *
621
	 * A "system" user is an account that's used to attribute logged actions
622
	 * taken by MediaWiki itself, as opposed to a bot or human user. Examples
623
	 * might include the 'Maintenance script' or 'Conversion script' accounts
624
	 * used by various scripts in the maintenance/ directory or accounts such
625
	 * as 'MediaWiki message delivery' used by the MassMessage extension.
626
	 *
627
	 * This can optionally create the user if it doesn't exist, and "steal" the
628
	 * account if it does exist.
629
	 *
630
	 * "Stealing" an existing user is intended to make it impossible for normal
631
	 * authentication processes to use the account, effectively disabling the
632
	 * account for normal use:
633
	 * - Email is invalidated, to prevent account recovery by emailing a
634
	 *   temporary password and to disassociate the account from the existing
635
	 *   human.
636
	 * - The token is set to a magic invalid value, to kill existing sessions
637
	 *   and to prevent $this->setToken() calls from resetting the token to a
638
	 *   valid value.
639
	 * - SessionManager is instructed to prevent new sessions for the user, to
640
	 *   do things like deauthorizing OAuth consumers.
641
	 * - AuthManager is instructed to revoke access, to invalidate or remove
642
	 *   passwords and other credentials.
643
	 *
644
	 * @param string $name Username
645
	 * @param array $options Options are:
646
	 *  - validate: As for User::getCanonicalName(), default 'valid'
647
	 *  - create: Whether to create the user if it doesn't already exist, default true
648
	 *  - steal: Whether to "disable" the account for normal use if it already
649
	 *    exists, default false
650
	 * @return User|null
651
	 * @since 1.27
652
	 */
653
	public static function newSystemUser( $name, $options = [] ) {
654
		$options += [
655
			'validate' => 'valid',
656
			'create' => true,
657
			'steal' => false,
658
		];
659
660
		$name = self::getCanonicalName( $name, $options['validate'] );
661
		if ( $name === false ) {
662
			return null;
663
		}
664
665
		$fields = self::selectFields();
666
667
		$dbw = wfGetDB( DB_MASTER );
668
		$row = $dbw->selectRow(
669
			'user',
670
			$fields,
671
			[ 'user_name' => $name ],
672
			__METHOD__
673
		);
674
		if ( !$row ) {
675
			// No user. Create it?
676
			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 660 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...
677
		}
678
		$user = self::newFromRow( $row );
679
680
		// A user is considered to exist as a non-system user if it can
681
		// authenticate, or has an email set, or has a non-invalid token.
682
		if ( $user->mEmail || $user->mToken !== self::INVALID_TOKEN ||
683
			AuthManager::singleton()->userCanAuthenticate( $name )
0 ignored issues
show
Bug introduced by
It seems like $name defined by self::getCanonicalName($..., $options['validate']) on line 660 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...
684
		) {
685
			// User exists. Steal it?
686
			if ( !$options['steal'] ) {
687
				return null;
688
			}
689
690
			AuthManager::singleton()->revokeAccessForUser( $name );
0 ignored issues
show
Bug introduced by
It seems like $name defined by self::getCanonicalName($..., $options['validate']) on line 660 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...
691
692
			$user->invalidateEmail();
693
			$user->mToken = self::INVALID_TOKEN;
694
			$user->saveSettings();
695
			SessionManager::singleton()->preventSessionsForUser( $user->getName() );
696
		}
697
698
		return $user;
699
	}
700
701
	// @}
702
703
	/**
704
	 * Get the username corresponding to a given user ID
705
	 * @param int $id User ID
706
	 * @return string|bool The corresponding username
707
	 */
708
	public static function whoIs( $id ) {
709
		return UserCache::singleton()->getProp( $id, 'name' );
710
	}
711
712
	/**
713
	 * Get the real name of a user given their user ID
714
	 *
715
	 * @param int $id User ID
716
	 * @return string|bool The corresponding user's real name
717
	 */
718
	public static function whoIsReal( $id ) {
719
		return UserCache::singleton()->getProp( $id, 'real_name' );
720
	}
721
722
	/**
723
	 * Get database id given a user name
724
	 * @param string $name Username
725
	 * @param integer $flags User::READ_* constant bitfield
726
	 * @return int|null The corresponding user's ID, or null if user is nonexistent
727
	 */
728
	public static function idFromName( $name, $flags = self::READ_NORMAL ) {
729
		$nt = Title::makeTitleSafe( NS_USER, $name );
730
		if ( is_null( $nt ) ) {
731
			// Illegal name
732
			return null;
733
		}
734
735
		if ( !( $flags & self::READ_LATEST ) && isset( self::$idCacheByName[$name] ) ) {
736
			return self::$idCacheByName[$name];
737
		}
738
739
		list( $index, $options ) = DBAccessObjectUtils::getDBOptions( $flags );
740
		$db = wfGetDB( $index );
741
742
		$s = $db->selectRow(
743
			'user',
744
			[ 'user_id' ],
745
			[ 'user_name' => $nt->getText() ],
746
			__METHOD__,
747
			$options
748
		);
749
750
		if ( $s === false ) {
751
			$result = null;
752
		} else {
753
			$result = $s->user_id;
754
		}
755
756
		self::$idCacheByName[$name] = $result;
757
758
		if ( count( self::$idCacheByName ) > 1000 ) {
759
			self::$idCacheByName = [];
760
		}
761
762
		return $result;
763
	}
764
765
	/**
766
	 * Reset the cache used in idFromName(). For use in tests.
767
	 */
768
	public static function resetIdByNameCache() {
769
		self::$idCacheByName = [];
770
	}
771
772
	/**
773
	 * Does the string match an anonymous IP address?
774
	 *
775
	 * This function exists for username validation, in order to reject
776
	 * usernames which are similar in form to IP addresses. Strings such
777
	 * as 300.300.300.300 will return true because it looks like an IP
778
	 * address, despite not being strictly valid.
779
	 *
780
	 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
781
	 * address because the usemod software would "cloak" anonymous IP
782
	 * addresses like this, if we allowed accounts like this to be created
783
	 * new users could get the old edits of these anonymous users.
784
	 *
785
	 * @param string $name Name to match
786
	 * @return bool
787
	 */
788
	public static function isIP( $name ) {
789
		return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
790
			|| IP::isIPv6( $name );
791
	}
792
793
	/**
794
	 * Is the input a valid username?
795
	 *
796
	 * Checks if the input is a valid username, we don't want an empty string,
797
	 * an IP address, anything that contains slashes (would mess up subpages),
798
	 * is longer than the maximum allowed username size or doesn't begin with
799
	 * a capital letter.
800
	 *
801
	 * @param string $name Name to match
802
	 * @return bool
803
	 */
804
	public static function isValidUserName( $name ) {
805
		global $wgContLang, $wgMaxNameChars;
806
807
		if ( $name == ''
808
			|| User::isIP( $name )
809
			|| strpos( $name, '/' ) !== false
810
			|| strlen( $name ) > $wgMaxNameChars
811
			|| $name != $wgContLang->ucfirst( $name )
812
		) {
813
			return false;
814
		}
815
816
		// Ensure that the name can't be misresolved as a different title,
817
		// such as with extra namespace keys at the start.
818
		$parsed = Title::newFromText( $name );
819
		if ( is_null( $parsed )
820
			|| $parsed->getNamespace()
821
			|| strcmp( $name, $parsed->getPrefixedText() ) ) {
822
			return false;
823
		}
824
825
		// Check an additional blacklist of troublemaker characters.
826
		// Should these be merged into the title char list?
827
		$unicodeBlacklist = '/[' .
828
			'\x{0080}-\x{009f}' . # iso-8859-1 control chars
829
			'\x{00a0}' .          # non-breaking space
830
			'\x{2000}-\x{200f}' . # various whitespace
831
			'\x{2028}-\x{202f}' . # breaks and control chars
832
			'\x{3000}' .          # ideographic space
833
			'\x{e000}-\x{f8ff}' . # private use
834
			']/u';
835
		if ( preg_match( $unicodeBlacklist, $name ) ) {
836
			return false;
837
		}
838
839
		return true;
840
	}
841
842
	/**
843
	 * Usernames which fail to pass this function will be blocked
844
	 * from user login and new account registrations, but may be used
845
	 * internally by batch processes.
846
	 *
847
	 * If an account already exists in this form, login will be blocked
848
	 * by a failure to pass this function.
849
	 *
850
	 * @param string $name Name to match
851
	 * @return bool
852
	 */
853
	public static function isUsableName( $name ) {
854
		global $wgReservedUsernames;
855
		// Must be a valid username, obviously ;)
856
		if ( !self::isValidUserName( $name ) ) {
857
			return false;
858
		}
859
860
		static $reservedUsernames = false;
861
		if ( !$reservedUsernames ) {
862
			$reservedUsernames = $wgReservedUsernames;
863
			Hooks::run( 'UserGetReservedNames', [ &$reservedUsernames ] );
864
		}
865
866
		// Certain names may be reserved for batch processes.
867
		foreach ( $reservedUsernames as $reserved ) {
868
			if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
869
				$reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->text();
870
			}
871
			if ( $reserved == $name ) {
872
				return false;
873
			}
874
		}
875
		return true;
876
	}
877
878
	/**
879
	 * Return the users who are members of the given group(s). In case of multiple groups,
880
	 * users who are members of at least one of them are returned.
881
	 *
882
	 * @param string|array $groups A single group name or an array of group names
883
	 * @param int $limit Max number of users to return. The actual limit will never exceed 5000
884
	 *   records; larger values are ignored.
885
	 * @param int $after ID the user to start after
886
	 * @return UserArrayFromResult
887
	 */
888
	public static function findUsersByGroup( $groups, $limit = 5000, $after = null ) {
889
		if ( $groups === [] ) {
890
			return UserArrayFromResult::newFromIDs( [] );
891
		}
892
893
		$groups = array_unique( (array)$groups );
894
		$limit = min( 5000, $limit );
895
896
		$conds = [ 'ug_group' => $groups ];
897
		if ( $after !== null ) {
898
			$conds[] = 'ug_user > ' . (int)$after;
899
		}
900
901
		$dbr = wfGetDB( DB_REPLICA );
902
		$ids = $dbr->selectFieldValues(
903
			'user_groups',
904
			'ug_user',
905
			$conds,
906
			__METHOD__,
907
			[
908
				'DISTINCT' => true,
909
				'ORDER BY' => 'ug_user',
910
				'LIMIT' => $limit,
911
			]
912
		) ?: [];
913
		return UserArray::newFromIDs( $ids );
914
	}
915
916
	/**
917
	 * Usernames which fail to pass this function will be blocked
918
	 * from new account registrations, but may be used internally
919
	 * either by batch processes or by user accounts which have
920
	 * already been created.
921
	 *
922
	 * Additional blacklisting may be added here rather than in
923
	 * isValidUserName() to avoid disrupting existing accounts.
924
	 *
925
	 * @param string $name String to match
926
	 * @return bool
927
	 */
928
	public static function isCreatableName( $name ) {
929
		global $wgInvalidUsernameCharacters;
930
931
		// Ensure that the username isn't longer than 235 bytes, so that
932
		// (at least for the builtin skins) user javascript and css files
933
		// will work. (bug 23080)
934
		if ( strlen( $name ) > 235 ) {
935
			wfDebugLog( 'username', __METHOD__ .
936
				": '$name' invalid due to length" );
937
			return false;
938
		}
939
940
		// Preg yells if you try to give it an empty string
941
		if ( $wgInvalidUsernameCharacters !== '' ) {
942
			if ( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
943
				wfDebugLog( 'username', __METHOD__ .
944
					": '$name' invalid due to wgInvalidUsernameCharacters" );
945
				return false;
946
			}
947
		}
948
949
		return self::isUsableName( $name );
950
	}
951
952
	/**
953
	 * Is the input a valid password for this user?
954
	 *
955
	 * @param string $password Desired password
956
	 * @return bool
957
	 */
958
	public function isValidPassword( $password ) {
959
		// simple boolean wrapper for getPasswordValidity
960
		return $this->getPasswordValidity( $password ) === true;
961
	}
962
963
	/**
964
	 * Given unvalidated password input, return error message on failure.
965
	 *
966
	 * @param string $password Desired password
967
	 * @return bool|string|array True on success, string or array of error message on failure
968
	 */
969
	public function getPasswordValidity( $password ) {
970
		$result = $this->checkPasswordValidity( $password );
971
		if ( $result->isGood() ) {
972
			return true;
973
		} else {
974
			$messages = [];
975
			foreach ( $result->getErrorsByType( 'error' ) as $error ) {
976
				$messages[] = $error['message'];
977
			}
978
			foreach ( $result->getErrorsByType( 'warning' ) as $warning ) {
979
				$messages[] = $warning['message'];
980
			}
981
			if ( count( $messages ) === 1 ) {
982
				return $messages[0];
983
			}
984
			return $messages;
985
		}
986
	}
987
988
	/**
989
	 * Check if this is a valid password for this user
990
	 *
991
	 * Create a Status object based on the password's validity.
992
	 * The Status should be set to fatal if the user should not
993
	 * be allowed to log in, and should have any errors that
994
	 * would block changing the password.
995
	 *
996
	 * If the return value of this is not OK, the password
997
	 * should not be checked. If the return value is not Good,
998
	 * the password can be checked, but the user should not be
999
	 * able to set their password to this.
1000
	 *
1001
	 * @param string $password Desired password
1002
	 * @param string $purpose one of 'login', 'create', 'reset'
1003
	 * @return Status
1004
	 * @since 1.23
1005
	 */
1006
	public function checkPasswordValidity( $password, $purpose = 'login' ) {
1007
		global $wgPasswordPolicy;
1008
1009
		$upp = new UserPasswordPolicy(
1010
			$wgPasswordPolicy['policies'],
1011
			$wgPasswordPolicy['checks']
1012
		);
1013
1014
		$status = Status::newGood();
1015
		$result = false; // init $result to false for the internal checks
1016
1017
		if ( !Hooks::run( 'isValidPassword', [ $password, &$result, $this ] ) ) {
1018
			$status->error( $result );
1019
			return $status;
1020
		}
1021
1022
		if ( $result === false ) {
1023
			$status->merge( $upp->checkUserPassword( $this, $password, $purpose ) );
1024
			return $status;
1025
		} elseif ( $result === true ) {
1026
			return $status;
1027
		} else {
1028
			$status->error( $result );
1029
			return $status; // the isValidPassword hook set a string $result and returned true
1030
		}
1031
	}
1032
1033
	/**
1034
	 * Given unvalidated user input, return a canonical username, or false if
1035
	 * the username is invalid.
1036
	 * @param string $name User input
1037
	 * @param string|bool $validate Type of validation to use:
1038
	 *   - false        No validation
1039
	 *   - 'valid'      Valid for batch processes
1040
	 *   - 'usable'     Valid for batch processes and login
1041
	 *   - 'creatable'  Valid for batch processes, login and account creation
1042
	 *
1043
	 * @throws InvalidArgumentException
1044
	 * @return bool|string
1045
	 */
1046
	public static function getCanonicalName( $name, $validate = 'valid' ) {
1047
		// Force usernames to capital
1048
		global $wgContLang;
1049
		$name = $wgContLang->ucfirst( $name );
1050
1051
		# Reject names containing '#'; these will be cleaned up
1052
		# with title normalisation, but then it's too late to
1053
		# check elsewhere
1054
		if ( strpos( $name, '#' ) !== false ) {
1055
			return false;
1056
		}
1057
1058
		// Clean up name according to title rules,
1059
		// but only when validation is requested (bug 12654)
1060
		$t = ( $validate !== false ) ?
1061
			Title::newFromText( $name, NS_USER ) : Title::makeTitle( NS_USER, $name );
1062
		// Check for invalid titles
1063
		if ( is_null( $t ) || $t->getNamespace() !== NS_USER || $t->isExternal() ) {
1064
			return false;
1065
		}
1066
1067
		// Reject various classes of invalid names
1068
		$name = AuthManager::callLegacyAuthPlugin(
1069
			'getCanonicalName', [ $t->getText() ], $t->getText()
1070
		);
1071
1072
		switch ( $validate ) {
1073
			case false:
1074
				break;
1075
			case 'valid':
1076
				if ( !User::isValidUserName( $name ) ) {
1077
					$name = false;
1078
				}
1079
				break;
1080
			case 'usable':
1081
				if ( !User::isUsableName( $name ) ) {
1082
					$name = false;
1083
				}
1084
				break;
1085
			case 'creatable':
1086
				if ( !User::isCreatableName( $name ) ) {
1087
					$name = false;
1088
				}
1089
				break;
1090
			default:
1091
				throw new InvalidArgumentException(
1092
					'Invalid parameter value for $validate in ' . __METHOD__ );
1093
		}
1094
		return $name;
1095
	}
1096
1097
	/**
1098
	 * Count the number of edits of a user
1099
	 *
1100
	 * @param int $uid User ID to check
1101
	 * @return int The user's edit count
1102
	 *
1103
	 * @deprecated since 1.21 in favour of User::getEditCount
1104
	 */
1105
	public static function edits( $uid ) {
1106
		wfDeprecated( __METHOD__, '1.21' );
1107
		$user = self::newFromId( $uid );
1108
		return $user->getEditCount();
1109
	}
1110
1111
	/**
1112
	 * Return a random password.
1113
	 *
1114
	 * @deprecated since 1.27, use PasswordFactory::generateRandomPasswordString()
1115
	 * @return string New random password
1116
	 */
1117
	public static function randomPassword() {
1118
		global $wgMinimalPasswordLength;
1119
		return PasswordFactory::generateRandomPasswordString( $wgMinimalPasswordLength );
1120
	}
1121
1122
	/**
1123
	 * Set cached properties to default.
1124
	 *
1125
	 * @note This no longer clears uncached lazy-initialised properties;
1126
	 *       the constructor does that instead.
1127
	 *
1128
	 * @param string|bool $name
1129
	 */
1130
	public function loadDefaults( $name = false ) {
1131
		$this->mId = 0;
1132
		$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...
1133
		$this->mRealName = '';
1134
		$this->mEmail = '';
1135
		$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...
1136
		$this->mOptionsLoaded = false;
1137
1138
		$loggedOut = $this->mRequest && !defined( 'MW_NO_SESSION' )
1139
			? $this->mRequest->getSession()->getLoggedOutTimestamp() : 0;
1140
		if ( $loggedOut !== 0 ) {
1141
			$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...
1142
		} else {
1143
			$this->mTouched = '1'; # Allow any pages to be cached
1144
		}
1145
1146
		$this->mToken = null; // Don't run cryptographic functions till we need a token
1147
		$this->mEmailAuthenticated = null;
1148
		$this->mEmailToken = '';
1149
		$this->mEmailTokenExpires = null;
1150
		$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...
1151
		$this->mGroups = [];
1152
1153
		Hooks::run( 'UserLoadDefaults', [ $this, $name ] );
1154
	}
1155
1156
	/**
1157
	 * Return whether an item has been loaded.
1158
	 *
1159
	 * @param string $item Item to check. Current possibilities:
1160
	 *   - id
1161
	 *   - name
1162
	 *   - realname
1163
	 * @param string $all 'all' to check if the whole object has been loaded
1164
	 *   or any other string to check if only the item is available (e.g.
1165
	 *   for optimisation)
1166
	 * @return bool
1167
	 */
1168
	public function isItemLoaded( $item, $all = 'all' ) {
1169
		return ( $this->mLoadedItems === true && $all === 'all' ) ||
1170
			( isset( $this->mLoadedItems[$item] ) && $this->mLoadedItems[$item] === true );
1171
	}
1172
1173
	/**
1174
	 * Set that an item has been loaded
1175
	 *
1176
	 * @param string $item
1177
	 */
1178
	protected function setItemLoaded( $item ) {
1179
		if ( is_array( $this->mLoadedItems ) ) {
1180
			$this->mLoadedItems[$item] = true;
1181
		}
1182
	}
1183
1184
	/**
1185
	 * Load user data from the session.
1186
	 *
1187
	 * @return bool True if the user is logged in, false otherwise.
1188
	 */
1189
	private function loadFromSession() {
1190
		// Deprecated hook
1191
		$result = null;
1192
		Hooks::run( 'UserLoadFromSession', [ $this, &$result ], '1.27' );
1193
		if ( $result !== null ) {
1194
			return $result;
1195
		}
1196
1197
		// MediaWiki\Session\Session already did the necessary authentication of the user
1198
		// returned here, so just use it if applicable.
1199
		$session = $this->getRequest()->getSession();
1200
		$user = $session->getUser();
1201
		if ( $user->isLoggedIn() ) {
1202
			$this->loadFromUserObject( $user );
1203
			// Other code expects these to be set in the session, so set them.
1204
			$session->set( 'wsUserID', $this->getId() );
1205
			$session->set( 'wsUserName', $this->getName() );
1206
			$session->set( 'wsToken', $this->getToken() );
1207
			return true;
1208
		}
1209
1210
		return false;
1211
	}
1212
1213
	/**
1214
	 * Load user and user_group data from the database.
1215
	 * $this->mId must be set, this is how the user is identified.
1216
	 *
1217
	 * @param integer $flags User::READ_* constant bitfield
1218
	 * @return bool True if the user exists, false if the user is anonymous
1219
	 */
1220
	public function loadFromDatabase( $flags = self::READ_LATEST ) {
1221
		// Paranoia
1222
		$this->mId = intval( $this->mId );
1223
1224
		if ( !$this->mId ) {
1225
			// Anonymous users are not in the database
1226
			$this->loadDefaults();
1227
			return false;
1228
		}
1229
1230
		list( $index, $options ) = DBAccessObjectUtils::getDBOptions( $flags );
1231
		$db = wfGetDB( $index );
1232
1233
		$s = $db->selectRow(
1234
			'user',
1235
			self::selectFields(),
1236
			[ 'user_id' => $this->mId ],
1237
			__METHOD__,
1238
			$options
1239
		);
1240
1241
		$this->queryFlagsUsed = $flags;
1242
		Hooks::run( 'UserLoadFromDatabase', [ $this, &$s ] );
1243
1244
		if ( $s !== false ) {
1245
			// Initialise user table data
1246
			$this->loadFromRow( $s );
1247
			$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...
1248
			$this->getEditCount(); // revalidation for nulls
1249
			return true;
1250
		} else {
1251
			// Invalid user_id
1252
			$this->mId = 0;
1253
			$this->loadDefaults();
1254
			return false;
1255
		}
1256
	}
1257
1258
	/**
1259
	 * Initialize this object from a row from the user table.
1260
	 *
1261
	 * @param stdClass $row Row from the user table to load.
1262
	 * @param array $data Further user data to load into the object
1263
	 *
1264
	 *	user_groups		Array with groups out of the user_groups table
1265
	 *	user_properties		Array with properties out of the user_properties table
1266
	 */
1267
	protected function loadFromRow( $row, $data = null ) {
1268
		$all = true;
1269
1270
		$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...
1271
1272 View Code Duplication
		if ( isset( $row->user_name ) ) {
1273
			$this->mName = $row->user_name;
1274
			$this->mFrom = 'name';
1275
			$this->setItemLoaded( 'name' );
1276
		} else {
1277
			$all = false;
1278
		}
1279
1280
		if ( isset( $row->user_real_name ) ) {
1281
			$this->mRealName = $row->user_real_name;
1282
			$this->setItemLoaded( 'realname' );
1283
		} else {
1284
			$all = false;
1285
		}
1286
1287 View Code Duplication
		if ( isset( $row->user_id ) ) {
1288
			$this->mId = intval( $row->user_id );
1289
			$this->mFrom = 'id';
1290
			$this->setItemLoaded( 'id' );
1291
		} else {
1292
			$all = false;
1293
		}
1294
1295
		if ( isset( $row->user_id ) && isset( $row->user_name ) ) {
1296
			self::$idCacheByName[$row->user_name] = $row->user_id;
1297
		}
1298
1299
		if ( isset( $row->user_editcount ) ) {
1300
			$this->mEditCount = $row->user_editcount;
1301
		} else {
1302
			$all = false;
1303
		}
1304
1305
		if ( isset( $row->user_touched ) ) {
1306
			$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...
1307
		} else {
1308
			$all = false;
1309
		}
1310
1311
		if ( isset( $row->user_token ) ) {
1312
			// The definition for the column is binary(32), so trim the NULs
1313
			// that appends. The previous definition was char(32), so trim
1314
			// spaces too.
1315
			$this->mToken = rtrim( $row->user_token, " \0" );
1316
			if ( $this->mToken === '' ) {
1317
				$this->mToken = null;
1318
			}
1319
		} else {
1320
			$all = false;
1321
		}
1322
1323
		if ( isset( $row->user_email ) ) {
1324
			$this->mEmail = $row->user_email;
1325
			$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...
1326
			$this->mEmailToken = $row->user_email_token;
1327
			$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...
1328
			$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...
1329
		} else {
1330
			$all = false;
1331
		}
1332
1333
		if ( $all ) {
1334
			$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...
1335
		}
1336
1337
		if ( is_array( $data ) ) {
1338
			if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1339
				$this->mGroups = $data['user_groups'];
1340
			}
1341
			if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1342
				$this->loadOptions( $data['user_properties'] );
1343
			}
1344
		}
1345
	}
1346
1347
	/**
1348
	 * Load the data for this user object from another user object.
1349
	 *
1350
	 * @param User $user
1351
	 */
1352
	protected function loadFromUserObject( $user ) {
1353
		$user->load();
1354
		foreach ( self::$mCacheVars as $var ) {
1355
			$this->$var = $user->$var;
1356
		}
1357
	}
1358
1359
	/**
1360
	 * Load the groups from the database if they aren't already loaded.
1361
	 */
1362 View Code Duplication
	private function loadGroups() {
1363
		if ( is_null( $this->mGroups ) ) {
1364
			$db = ( $this->queryFlagsUsed & self::READ_LATEST )
1365
				? wfGetDB( DB_MASTER )
1366
				: wfGetDB( DB_REPLICA );
1367
			$res = $db->select( 'user_groups',
1368
				[ 'ug_group' ],
1369
				[ 'ug_user' => $this->mId ],
1370
				__METHOD__ );
1371
			$this->mGroups = [];
1372
			foreach ( $res as $row ) {
1373
				$this->mGroups[] = $row->ug_group;
1374
			}
1375
		}
1376
	}
1377
1378
	/**
1379
	 * Add the user to the group if he/she meets given criteria.
1380
	 *
1381
	 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1382
	 *   possible to remove manually via Special:UserRights. In such case it
1383
	 *   will not be re-added automatically. The user will also not lose the
1384
	 *   group if they no longer meet the criteria.
1385
	 *
1386
	 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1387
	 *
1388
	 * @return array Array of groups the user has been promoted to.
1389
	 *
1390
	 * @see $wgAutopromoteOnce
1391
	 */
1392
	public function addAutopromoteOnceGroups( $event ) {
1393
		global $wgAutopromoteOnceLogInRC;
1394
1395
		if ( wfReadOnly() || !$this->getId() ) {
1396
			return [];
1397
		}
1398
1399
		$toPromote = Autopromote::getAutopromoteOnceGroups( $this, $event );
1400
		if ( !count( $toPromote ) ) {
1401
			return [];
1402
		}
1403
1404
		if ( !$this->checkAndSetTouched() ) {
1405
			return []; // raced out (bug T48834)
1406
		}
1407
1408
		$oldGroups = $this->getGroups(); // previous groups
1409
		foreach ( $toPromote as $group ) {
1410
			$this->addGroup( $group );
1411
		}
1412
		// update groups in external authentication database
1413
		Hooks::run( 'UserGroupsChanged', [ $this, $toPromote, [], false, false ] );
1414
		AuthManager::callLegacyAuthPlugin( 'updateExternalDBGroups', [ $this, $toPromote ] );
1415
1416
		$newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1417
1418
		$logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1419
		$logEntry->setPerformer( $this );
1420
		$logEntry->setTarget( $this->getUserPage() );
1421
		$logEntry->setParameters( [
1422
			'4::oldgroups' => $oldGroups,
1423
			'5::newgroups' => $newGroups,
1424
		] );
1425
		$logid = $logEntry->insert();
1426
		if ( $wgAutopromoteOnceLogInRC ) {
1427
			$logEntry->publish( $logid );
1428
		}
1429
1430
		return $toPromote;
1431
	}
1432
1433
	/**
1434
	 * Builds update conditions. Additional conditions may be added to $conditions to
1435
	 * protected against race conditions using a compare-and-set (CAS) mechanism
1436
	 * based on comparing $this->mTouched with the user_touched field.
1437
	 *
1438
	 * @param Database $db
1439
	 * @param array $conditions WHERE conditions for use with Database::update
1440
	 * @return array WHERE conditions for use with Database::update
1441
	 */
1442
	protected function makeUpdateConditions( Database $db, array $conditions ) {
1443
		if ( $this->mTouched ) {
1444
			// CAS check: only update if the row wasn't changed sicne it was loaded.
1445
			$conditions['user_touched'] = $db->timestamp( $this->mTouched );
1446
		}
1447
1448
		return $conditions;
1449
	}
1450
1451
	/**
1452
	 * Bump user_touched if it didn't change since this object was loaded
1453
	 *
1454
	 * On success, the mTouched field is updated.
1455
	 * The user serialization cache is always cleared.
1456
	 *
1457
	 * @return bool Whether user_touched was actually updated
1458
	 * @since 1.26
1459
	 */
1460
	protected function checkAndSetTouched() {
1461
		$this->load();
1462
1463
		if ( !$this->mId ) {
1464
			return false; // anon
1465
		}
1466
1467
		// Get a new user_touched that is higher than the old one
1468
		$newTouched = $this->newTouchedTimestamp();
1469
1470
		$dbw = wfGetDB( DB_MASTER );
1471
		$dbw->update( 'user',
1472
			[ 'user_touched' => $dbw->timestamp( $newTouched ) ],
1473
			$this->makeUpdateConditions( $dbw, [
0 ignored issues
show
Bug introduced by
It seems like $dbw defined by wfGetDB(DB_MASTER) on line 1470 can be null; however, User::makeUpdateConditions() does not accept null, maybe add an additional type check?

Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code:

/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
Loading history...
1474
				'user_id' => $this->mId,
1475
			] ),
1476
			__METHOD__
1477
		);
1478
		$success = ( $dbw->affectedRows() > 0 );
1479
1480
		if ( $success ) {
1481
			$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...
1482
			$this->clearSharedCache();
1483
		} else {
1484
			// Clears on failure too since that is desired if the cache is stale
1485
			$this->clearSharedCache( 'refresh' );
1486
		}
1487
1488
		return $success;
1489
	}
1490
1491
	/**
1492
	 * Clear various cached data stored in this object. The cache of the user table
1493
	 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1494
	 *
1495
	 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1496
	 *   given source. May be "name", "id", "defaults", "session", or false for no reload.
1497
	 */
1498
	public function clearInstanceCache( $reloadFrom = false ) {
1499
		$this->mNewtalk = -1;
1500
		$this->mDatePreference = null;
1501
		$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...
1502
		$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...
1503
		$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...
1504
		$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...
1505
		$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...
1506
		$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...
1507
		$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...
1508
		$this->mOptionsLoaded = false;
1509
		$this->mEditCount = null;
1510
1511
		if ( $reloadFrom ) {
1512
			$this->mLoadedItems = [];
1513
			$this->mFrom = $reloadFrom;
1514
		}
1515
	}
1516
1517
	/**
1518
	 * Combine the language default options with any site-specific options
1519
	 * and add the default language variants.
1520
	 *
1521
	 * @return array Array of String options
1522
	 */
1523
	public static function getDefaultOptions() {
1524
		global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1525
1526
		static $defOpt = null;
1527
		static $defOptLang = null;
1528
1529
		if ( $defOpt !== null && $defOptLang === $wgContLang->getCode() ) {
1530
			// $wgContLang does not change (and should not change) mid-request,
1531
			// but the unit tests change it anyway, and expect this method to
1532
			// return values relevant to the current $wgContLang.
1533
			return $defOpt;
1534
		}
1535
1536
		$defOpt = $wgDefaultUserOptions;
1537
		// Default language setting
1538
		$defOptLang = $wgContLang->getCode();
1539
		$defOpt['language'] = $defOptLang;
1540
		foreach ( LanguageConverter::$languagesWithVariants as $langCode ) {
1541
			$defOpt[$langCode == $wgContLang->getCode() ? 'variant' : "variant-$langCode"] = $langCode;
1542
		}
1543
1544
		// NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
1545
		// since extensions may change the set of searchable namespaces depending
1546
		// on user groups/permissions.
1547
		foreach ( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
1548
			$defOpt['searchNs' . $nsnum] = (boolean)$val;
1549
		}
1550
		$defOpt['skin'] = Skin::normalizeKey( $wgDefaultSkin );
1551
1552
		Hooks::run( 'UserGetDefaultOptions', [ &$defOpt ] );
1553
1554
		return $defOpt;
1555
	}
1556
1557
	/**
1558
	 * Get a given default option value.
1559
	 *
1560
	 * @param string $opt Name of option to retrieve
1561
	 * @return string Default option value
1562
	 */
1563
	public static function getDefaultOption( $opt ) {
1564
		$defOpts = self::getDefaultOptions();
1565
		if ( isset( $defOpts[$opt] ) ) {
1566
			return $defOpts[$opt];
1567
		} else {
1568
			return null;
1569
		}
1570
	}
1571
1572
	/**
1573
	 * Get blocking information
1574
	 * @param bool $bFromSlave Whether to check the replica DB first.
1575
	 *   To improve performance, non-critical checks are done against replica DBs.
1576
	 *   Check when actually saving should be done against master.
1577
	 */
1578
	private function getBlockedStatus( $bFromSlave = true ) {
1579
		global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff;
1580
1581
		if ( -1 != $this->mBlockedby ) {
1582
			return;
1583
		}
1584
1585
		wfDebug( __METHOD__ . ": checking...\n" );
1586
1587
		// Initialize data...
1588
		// Otherwise something ends up stomping on $this->mBlockedby when
1589
		// things get lazy-loaded later, causing false positive block hits
1590
		// due to -1 !== 0. Probably session-related... Nothing should be
1591
		// overwriting mBlockedby, surely?
1592
		$this->load();
1593
1594
		# We only need to worry about passing the IP address to the Block generator if the
1595
		# user is not immune to autoblocks/hardblocks, and they are the current user so we
1596
		# know which IP address they're actually coming from
1597
		$ip = null;
1598
		if ( !$this->isAllowed( 'ipblock-exempt' ) ) {
1599
			// $wgUser->getName() only works after the end of Setup.php. Until
1600
			// then, assume it's a logged-out user.
1601
			$globalUserName = $wgUser->isSafeToLoad()
1602
				? $wgUser->getName()
1603
				: IP::sanitizeIP( $wgUser->getRequest()->getIP() );
1604
			if ( $this->getName() === $globalUserName ) {
1605
				$ip = $this->getRequest()->getIP();
1606
			}
1607
		}
1608
1609
		// User/IP blocking
1610
		$block = Block::newFromTarget( $this, $ip, !$bFromSlave );
1611
1612
		// Proxy blocking
1613
		if ( !$block instanceof Block && $ip !== null && !in_array( $ip, $wgProxyWhitelist ) ) {
1614
			// Local list
1615
			if ( self::isLocallyBlockedProxy( $ip ) ) {
1616
				$block = new Block;
1617
				$block->setBlocker( wfMessage( 'proxyblocker' )->text() );
1618
				$block->mReason = wfMessage( 'proxyblockreason' )->text();
1619
				$block->setTarget( $ip );
1620
			} elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1621
				$block = new Block;
1622
				$block->setBlocker( wfMessage( 'sorbs' )->text() );
1623
				$block->mReason = wfMessage( 'sorbsreason' )->text();
1624
				$block->setTarget( $ip );
1625
			}
1626
		}
1627
1628
		// (bug 23343) Apply IP blocks to the contents of XFF headers, if enabled
1629
		if ( !$block instanceof Block
1630
			&& $wgApplyIpBlocksToXff
1631
			&& $ip !== null
1632
			&& !in_array( $ip, $wgProxyWhitelist )
1633
		) {
1634
			$xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1635
			$xff = array_map( 'trim', explode( ',', $xff ) );
1636
			$xff = array_diff( $xff, [ $ip ] );
1637
			$xffblocks = Block::getBlocksForIPList( $xff, $this->isAnon(), !$bFromSlave );
1638
			$block = Block::chooseBlock( $xffblocks, $xff );
1639
			if ( $block instanceof Block ) {
1640
				# Mangle the reason to alert the user that the block
1641
				# originated from matching the X-Forwarded-For header.
1642
				$block->mReason = wfMessage( 'xffblockreason', $block->mReason )->text();
1643
			}
1644
		}
1645
1646
		if ( $block instanceof Block ) {
1647
			wfDebug( __METHOD__ . ": Found block.\n" );
1648
			$this->mBlock = $block;
1649
			$this->mBlockedby = $block->getByName();
1650
			$this->mBlockreason = $block->mReason;
1651
			$this->mHideName = $block->mHideName;
1652
			$this->mAllowUsertalk = !$block->prevents( 'editownusertalk' );
1653
		} else {
1654
			$this->mBlockedby = '';
1655
			$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...
1656
			$this->mAllowUsertalk = false;
1657
		}
1658
1659
		// Extensions
1660
		Hooks::run( 'GetBlockedStatus', [ &$this ] );
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
		$found = false;
1693
		// @todo FIXME: IPv6 ???  (https://bugs.php.net/bug.php?id=33170)
1694
		if ( IP::isIPv4( $ip ) ) {
1695
			// Reverse IP, bug 21255
1696
			$ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1697
1698
			foreach ( (array)$bases as $base ) {
1699
				// Make hostname
1700
				// If we have an access key, use that too (ProjectHoneypot, etc.)
1701
				$basename = $base;
1702
				if ( is_array( $base ) ) {
1703
					if ( count( $base ) >= 2 ) {
1704
						// Access key is 1, base URL is 0
1705
						$host = "{$base[1]}.$ipReversed.{$base[0]}";
1706
					} else {
1707
						$host = "$ipReversed.{$base[0]}";
1708
					}
1709
					$basename = $base[0];
1710
				} else {
1711
					$host = "$ipReversed.$base";
1712
				}
1713
1714
				// Send query
1715
				$ipList = gethostbynamel( $host );
1716
1717
				if ( $ipList ) {
1718
					wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
1719
					$found = true;
1720
					break;
1721
				} else {
1722
					wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
1723
				}
1724
			}
1725
		}
1726
1727
		return $found;
1728
	}
1729
1730
	/**
1731
	 * Check if an IP address is in the local proxy list
1732
	 *
1733
	 * @param string $ip
1734
	 *
1735
	 * @return bool
1736
	 */
1737
	public static function isLocallyBlockedProxy( $ip ) {
1738
		global $wgProxyList;
1739
1740
		if ( !$wgProxyList ) {
1741
			return false;
1742
		}
1743
1744
		if ( !is_array( $wgProxyList ) ) {
1745
			// Load from the specified file
1746
			$wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1747
		}
1748
1749
		if ( !is_array( $wgProxyList ) ) {
1750
			$ret = false;
1751
		} elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1752
			$ret = true;
1753
		} elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1754
			// Old-style flipped proxy list
1755
			$ret = true;
1756
		} else {
1757
			$ret = false;
1758
		}
1759
		return $ret;
1760
	}
1761
1762
	/**
1763
	 * Is this user subject to rate limiting?
1764
	 *
1765
	 * @return bool True if rate limited
1766
	 */
1767
	public function isPingLimitable() {
1768
		global $wgRateLimitsExcludedIPs;
1769
		if ( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1770
			// No other good way currently to disable rate limits
1771
			// for specific IPs. :P
1772
			// But this is a crappy hack and should die.
1773
			return false;
1774
		}
1775
		return !$this->isAllowed( 'noratelimit' );
1776
	}
1777
1778
	/**
1779
	 * Primitive rate limits: enforce maximum actions per time period
1780
	 * to put a brake on flooding.
1781
	 *
1782
	 * The method generates both a generic profiling point and a per action one
1783
	 * (suffix being "-$action".
1784
	 *
1785
	 * @note When using a shared cache like memcached, IP-address
1786
	 * last-hit counters will be shared across wikis.
1787
	 *
1788
	 * @param string $action Action to enforce; 'edit' if unspecified
1789
	 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
1790
	 * @return bool True if a rate limiter was tripped
1791
	 */
1792
	public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
1793
		// Call the 'PingLimiter' hook
1794
		$result = false;
1795
		if ( !Hooks::run( 'PingLimiter', [ &$this, $action, &$result, $incrBy ] ) ) {
1796
			return $result;
1797
		}
1798
1799
		global $wgRateLimits;
1800
		if ( !isset( $wgRateLimits[$action] ) ) {
1801
			return false;
1802
		}
1803
1804
		$limits = array_merge(
1805
			[ '&can-bypass' => true ],
1806
			$wgRateLimits[$action]
1807
		);
1808
1809
		// Some groups shouldn't trigger the ping limiter, ever
1810
		if ( $limits['&can-bypass'] && !$this->isPingLimitable() ) {
1811
			return false;
1812
		}
1813
1814
		$keys = [];
1815
		$id = $this->getId();
1816
		$userLimit = false;
1817
		$isNewbie = $this->isNewbie();
1818
1819
		if ( $id == 0 ) {
1820
			// limits for anons
1821 View Code Duplication
			if ( isset( $limits['anon'] ) ) {
1822
				$keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1823
			}
1824
		} else {
1825
			// limits for logged-in users
1826
			if ( isset( $limits['user'] ) ) {
1827
				$userLimit = $limits['user'];
1828
			}
1829
			// limits for newbie logged-in users
1830 View Code Duplication
			if ( $isNewbie && isset( $limits['newbie'] ) ) {
1831
				$keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1832
			}
1833
		}
1834
1835
		// limits for anons and for newbie logged-in users
1836
		if ( $isNewbie ) {
1837
			// ip-based limits
1838
			if ( isset( $limits['ip'] ) ) {
1839
				$ip = $this->getRequest()->getIP();
1840
				$keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1841
			}
1842
			// subnet-based limits
1843
			if ( isset( $limits['subnet'] ) ) {
1844
				$ip = $this->getRequest()->getIP();
1845
				$subnet = IP::getSubnet( $ip );
1846
				if ( $subnet !== false ) {
1847
					$keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1848
				}
1849
			}
1850
		}
1851
1852
		// Check for group-specific permissions
1853
		// If more than one group applies, use the group with the highest limit ratio (max/period)
1854
		foreach ( $this->getGroups() as $group ) {
1855
			if ( isset( $limits[$group] ) ) {
1856
				if ( $userLimit === false
1857
					|| $limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
1858
				) {
1859
					$userLimit = $limits[$group];
1860
				}
1861
			}
1862
		}
1863
1864
		// Set the user limit key
1865
		if ( $userLimit !== false ) {
1866
			list( $max, $period ) = $userLimit;
1867
			wfDebug( __METHOD__ . ": effective user limit: $max in {$period}s\n" );
1868
			$keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $userLimit;
1869
		}
1870
1871
		// ip-based limits for all ping-limitable users
1872
		if ( isset( $limits['ip-all'] ) ) {
1873
			$ip = $this->getRequest()->getIP();
1874
			// ignore if user limit is more permissive
1875 View Code Duplication
			if ( $isNewbie || $userLimit === false
1876
				|| $limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
1877
				$keys["mediawiki:limiter:$action:ip-all:$ip"] = $limits['ip-all'];
1878
			}
1879
		}
1880
1881
		// subnet-based limits for all ping-limitable users
1882
		if ( isset( $limits['subnet-all'] ) ) {
1883
			$ip = $this->getRequest()->getIP();
1884
			$subnet = IP::getSubnet( $ip );
1885 View Code Duplication
			if ( $subnet !== false ) {
1886
				// ignore if user limit is more permissive
1887
				if ( $isNewbie || $userLimit === false
1888
					|| $limits['ip-all'][0] / $limits['ip-all'][1]
1889
					> $userLimit[0] / $userLimit[1] ) {
1890
					$keys["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
1891
				}
1892
			}
1893
		}
1894
1895
		$cache = ObjectCache::getLocalClusterInstance();
1896
1897
		$triggered = false;
1898
		foreach ( $keys as $key => $limit ) {
1899
			list( $max, $period ) = $limit;
1900
			$summary = "(limit $max in {$period}s)";
1901
			$count = $cache->get( $key );
1902
			// Already pinged?
1903
			if ( $count ) {
1904
				if ( $count >= $max ) {
1905
					wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
1906
						"(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
1907
					$triggered = true;
1908
				} else {
1909
					wfDebug( __METHOD__ . ": ok. $key at $count $summary\n" );
1910
				}
1911
			} else {
1912
				wfDebug( __METHOD__ . ": adding record for $key $summary\n" );
1913
				if ( $incrBy > 0 ) {
1914
					$cache->add( $key, 0, intval( $period ) ); // first ping
1915
				}
1916
			}
1917
			if ( $incrBy > 0 ) {
1918
				$cache->incr( $key, $incrBy );
1919
			}
1920
		}
1921
1922
		return $triggered;
1923
	}
1924
1925
	/**
1926
	 * Check if user is blocked
1927
	 *
1928
	 * @param bool $bFromSlave Whether to check the replica DB instead of
1929
	 *   the master. Hacked from false due to horrible probs on site.
1930
	 * @return bool True if blocked, false otherwise
1931
	 */
1932
	public function isBlocked( $bFromSlave = true ) {
1933
		return $this->getBlock( $bFromSlave ) instanceof Block && $this->getBlock()->prevents( 'edit' );
1934
	}
1935
1936
	/**
1937
	 * Get the block affecting the user, or null if the user is not blocked
1938
	 *
1939
	 * @param bool $bFromSlave Whether to check the replica DB instead of the master
1940
	 * @return Block|null
1941
	 */
1942
	public function getBlock( $bFromSlave = true ) {
1943
		$this->getBlockedStatus( $bFromSlave );
1944
		return $this->mBlock instanceof Block ? $this->mBlock : null;
1945
	}
1946
1947
	/**
1948
	 * Check if user is blocked from editing a particular article
1949
	 *
1950
	 * @param Title $title Title to check
1951
	 * @param bool $bFromSlave Whether to check the replica DB instead of the master
1952
	 * @return bool
1953
	 */
1954
	public function isBlockedFrom( $title, $bFromSlave = false ) {
1955
		global $wgBlockAllowsUTEdit;
1956
1957
		$blocked = $this->isBlocked( $bFromSlave );
1958
		$allowUsertalk = ( $wgBlockAllowsUTEdit ? $this->mAllowUsertalk : false );
1959
		// If a user's name is suppressed, they cannot make edits anywhere
1960
		if ( !$this->mHideName && $allowUsertalk && $title->getText() === $this->getName()
1961
			&& $title->getNamespace() == NS_USER_TALK ) {
1962
			$blocked = false;
1963
			wfDebug( __METHOD__ . ": self-talk page, ignoring any blocks\n" );
1964
		}
1965
1966
		Hooks::run( 'UserIsBlockedFrom', [ $this, $title, &$blocked, &$allowUsertalk ] );
1967
1968
		return $blocked;
1969
	}
1970
1971
	/**
1972
	 * If user is blocked, return the name of the user who placed the block
1973
	 * @return string Name of blocker
1974
	 */
1975
	public function blockedBy() {
1976
		$this->getBlockedStatus();
1977
		return $this->mBlockedby;
1978
	}
1979
1980
	/**
1981
	 * If user is blocked, return the specified reason for the block
1982
	 * @return string Blocking reason
1983
	 */
1984
	public function blockedFor() {
1985
		$this->getBlockedStatus();
1986
		return $this->mBlockreason;
1987
	}
1988
1989
	/**
1990
	 * If user is blocked, return the ID for the block
1991
	 * @return int Block ID
1992
	 */
1993
	public function getBlockId() {
1994
		$this->getBlockedStatus();
1995
		return ( $this->mBlock ? $this->mBlock->getId() : false );
1996
	}
1997
1998
	/**
1999
	 * Check if user is blocked on all wikis.
2000
	 * Do not use for actual edit permission checks!
2001
	 * This is intended for quick UI checks.
2002
	 *
2003
	 * @param string $ip IP address, uses current client if none given
2004
	 * @return bool True if blocked, false otherwise
2005
	 */
2006
	public function isBlockedGlobally( $ip = '' ) {
2007
		return $this->getGlobalBlock( $ip ) instanceof Block;
2008
	}
2009
2010
	/**
2011
	 * Check if user is blocked on all wikis.
2012
	 * Do not use for actual edit permission checks!
2013
	 * This is intended for quick UI checks.
2014
	 *
2015
	 * @param string $ip IP address, uses current client if none given
2016
	 * @return Block|null Block object if blocked, null otherwise
2017
	 * @throws FatalError
2018
	 * @throws MWException
2019
	 */
2020
	public function getGlobalBlock( $ip = '' ) {
2021
		if ( $this->mGlobalBlock !== null ) {
2022
			return $this->mGlobalBlock ?: null;
2023
		}
2024
		// User is already an IP?
2025
		if ( IP::isIPAddress( $this->getName() ) ) {
2026
			$ip = $this->getName();
2027
		} elseif ( !$ip ) {
2028
			$ip = $this->getRequest()->getIP();
2029
		}
2030
		$blocked = false;
2031
		$block = null;
2032
		Hooks::run( 'UserIsBlockedGlobally', [ &$this, $ip, &$blocked, &$block ] );
2033
2034
		if ( $blocked && $block === null ) {
2035
			// back-compat: UserIsBlockedGlobally didn't have $block param first
2036
			$block = new Block;
2037
			$block->setTarget( $ip );
2038
		}
2039
2040
		$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...
2041
		return $this->mGlobalBlock ?: null;
2042
	}
2043
2044
	/**
2045
	 * Check if user account is locked
2046
	 *
2047
	 * @return bool True if locked, false otherwise
2048
	 */
2049 View Code Duplication
	public function isLocked() {
2050
		if ( $this->mLocked !== null ) {
2051
			return $this->mLocked;
2052
		}
2053
		$authUser = AuthManager::callLegacyAuthPlugin( 'getUserInstance', [ &$this ], null );
2054
		$this->mLocked = $authUser && $authUser->isLocked();
2055
		Hooks::run( 'UserIsLocked', [ $this, &$this->mLocked ] );
2056
		return $this->mLocked;
2057
	}
2058
2059
	/**
2060
	 * Check if user account is hidden
2061
	 *
2062
	 * @return bool True if hidden, false otherwise
2063
	 */
2064 View Code Duplication
	public function isHidden() {
2065
		if ( $this->mHideName !== null ) {
2066
			return $this->mHideName;
2067
		}
2068
		$this->getBlockedStatus();
2069
		if ( !$this->mHideName ) {
2070
			$authUser = AuthManager::callLegacyAuthPlugin( 'getUserInstance', [ &$this ], null );
2071
			$this->mHideName = $authUser && $authUser->isHidden();
2072
			Hooks::run( 'UserIsHidden', [ $this, &$this->mHideName ] );
2073
		}
2074
		return $this->mHideName;
2075
	}
2076
2077
	/**
2078
	 * Get the user's ID.
2079
	 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2080
	 */
2081
	public function getId() {
2082
		if ( $this->mId === null && $this->mName !== null && User::isIP( $this->mName ) ) {
2083
			// Special case, we know the user is anonymous
2084
			return 0;
2085
		} elseif ( !$this->isItemLoaded( 'id' ) ) {
2086
			// Don't load if this was initialized from an ID
2087
			$this->load();
2088
		}
2089
2090
		return (int)$this->mId;
2091
	}
2092
2093
	/**
2094
	 * Set the user and reload all fields according to a given ID
2095
	 * @param int $v User ID to reload
2096
	 */
2097
	public function setId( $v ) {
2098
		$this->mId = $v;
2099
		$this->clearInstanceCache( 'id' );
2100
	}
2101
2102
	/**
2103
	 * Get the user name, or the IP of an anonymous user
2104
	 * @return string User's name or IP address
2105
	 */
2106
	public function getName() {
2107
		if ( $this->isItemLoaded( 'name', 'only' ) ) {
2108
			// Special case optimisation
2109
			return $this->mName;
2110
		} else {
2111
			$this->load();
2112
			if ( $this->mName === false ) {
2113
				// Clean up IPs
2114
				$this->mName = IP::sanitizeIP( $this->getRequest()->getIP() );
2115
			}
2116
			return $this->mName;
2117
		}
2118
	}
2119
2120
	/**
2121
	 * Set the user name.
2122
	 *
2123
	 * This does not reload fields from the database according to the given
2124
	 * name. Rather, it is used to create a temporary "nonexistent user" for
2125
	 * later addition to the database. It can also be used to set the IP
2126
	 * address for an anonymous user to something other than the current
2127
	 * remote IP.
2128
	 *
2129
	 * @note User::newFromName() has roughly the same function, when the named user
2130
	 * does not exist.
2131
	 * @param string $str New user name to set
2132
	 */
2133
	public function setName( $str ) {
2134
		$this->load();
2135
		$this->mName = $str;
2136
	}
2137
2138
	/**
2139
	 * Get the user's name escaped by underscores.
2140
	 * @return string Username escaped by underscores.
2141
	 */
2142
	public function getTitleKey() {
2143
		return str_replace( ' ', '_', $this->getName() );
2144
	}
2145
2146
	/**
2147
	 * Check if the user has new messages.
2148
	 * @return bool True if the user has new messages
2149
	 */
2150
	public function getNewtalk() {
2151
		$this->load();
2152
2153
		// Load the newtalk status if it is unloaded (mNewtalk=-1)
2154
		if ( $this->mNewtalk === -1 ) {
2155
			$this->mNewtalk = false; # reset talk page status
2156
2157
			// Check memcached separately for anons, who have no
2158
			// entire User object stored in there.
2159
			if ( !$this->mId ) {
2160
				global $wgDisableAnonTalk;
2161
				if ( $wgDisableAnonTalk ) {
2162
					// Anon newtalk disabled by configuration.
2163
					$this->mNewtalk = false;
2164
				} else {
2165
					$this->mNewtalk = $this->checkNewtalk( 'user_ip', $this->getName() );
2166
				}
2167
			} else {
2168
				$this->mNewtalk = $this->checkNewtalk( 'user_id', $this->mId );
2169
			}
2170
		}
2171
2172
		return (bool)$this->mNewtalk;
2173
	}
2174
2175
	/**
2176
	 * Return the data needed to construct links for new talk page message
2177
	 * alerts. If there are new messages, this will return an associative array
2178
	 * with the following data:
2179
	 *     wiki: The database name of the wiki
2180
	 *     link: Root-relative link to the user's talk page
2181
	 *     rev: The last talk page revision that the user has seen or null. This
2182
	 *         is useful for building diff links.
2183
	 * If there are no new messages, it returns an empty array.
2184
	 * @note This function was designed to accomodate multiple talk pages, but
2185
	 * currently only returns a single link and revision.
2186
	 * @return array
2187
	 */
2188
	public function getNewMessageLinks() {
2189
		$talks = [];
2190
		if ( !Hooks::run( 'UserRetrieveNewTalks', [ &$this, &$talks ] ) ) {
2191
			return $talks;
2192
		} elseif ( !$this->getNewtalk() ) {
2193
			return [];
2194
		}
2195
		$utp = $this->getTalkPage();
2196
		$dbr = wfGetDB( DB_REPLICA );
2197
		// Get the "last viewed rev" timestamp from the oldest message notification
2198
		$timestamp = $dbr->selectField( 'user_newtalk',
2199
			'MIN(user_last_timestamp)',
2200
			$this->isAnon() ? [ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
2201
			__METHOD__ );
2202
		$rev = $timestamp ? Revision::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
0 ignored issues
show
Bug introduced by
It seems like $dbr defined by wfGetDB(DB_REPLICA) on line 2196 can be null; however, Revision::loadFromTimestamp() does not accept null, maybe add an additional type check?

Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code:

/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
Loading history...
2203
		return [ [ 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ] ];
2204
	}
2205
2206
	/**
2207
	 * Get the revision ID for the last talk page revision viewed by the talk
2208
	 * page owner.
2209
	 * @return int|null Revision ID or null
2210
	 */
2211
	public function getNewMessageRevisionId() {
2212
		$newMessageRevisionId = null;
2213
		$newMessageLinks = $this->getNewMessageLinks();
2214
		if ( $newMessageLinks ) {
2215
			// Note: getNewMessageLinks() never returns more than a single link
2216
			// and it is always for the same wiki, but we double-check here in
2217
			// case that changes some time in the future.
2218
			if ( count( $newMessageLinks ) === 1
2219
				&& $newMessageLinks[0]['wiki'] === wfWikiID()
2220
				&& $newMessageLinks[0]['rev']
2221
			) {
2222
				/** @var Revision $newMessageRevision */
2223
				$newMessageRevision = $newMessageLinks[0]['rev'];
2224
				$newMessageRevisionId = $newMessageRevision->getId();
2225
			}
2226
		}
2227
		return $newMessageRevisionId;
2228
	}
2229
2230
	/**
2231
	 * Internal uncached check for new messages
2232
	 *
2233
	 * @see getNewtalk()
2234
	 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2235
	 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2236
	 * @return bool True if the user has new messages
2237
	 */
2238
	protected function checkNewtalk( $field, $id ) {
2239
		$dbr = wfGetDB( DB_REPLICA );
2240
2241
		$ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__ );
2242
2243
		return $ok !== false;
2244
	}
2245
2246
	/**
2247
	 * Add or update the new messages flag
2248
	 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2249
	 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2250
	 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2251
	 * @return bool True if successful, false otherwise
2252
	 */
2253
	protected function updateNewtalk( $field, $id, $curRev = null ) {
2254
		// Get timestamp of the talk page revision prior to the current one
2255
		$prevRev = $curRev ? $curRev->getPrevious() : false;
2256
		$ts = $prevRev ? $prevRev->getTimestamp() : null;
2257
		// Mark the user as having new messages since this revision
2258
		$dbw = wfGetDB( DB_MASTER );
2259
		$dbw->insert( 'user_newtalk',
2260
			[ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
2261
			__METHOD__,
2262
			'IGNORE' );
2263 View Code Duplication
		if ( $dbw->affectedRows() ) {
2264
			wfDebug( __METHOD__ . ": set on ($field, $id)\n" );
2265
			return true;
2266
		} else {
2267
			wfDebug( __METHOD__ . " already set ($field, $id)\n" );
2268
			return false;
2269
		}
2270
	}
2271
2272
	/**
2273
	 * Clear the new messages flag for the given user
2274
	 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2275
	 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2276
	 * @return bool True if successful, false otherwise
2277
	 */
2278
	protected function deleteNewtalk( $field, $id ) {
2279
		$dbw = wfGetDB( DB_MASTER );
2280
		$dbw->delete( 'user_newtalk',
2281
			[ $field => $id ],
2282
			__METHOD__ );
2283 View Code Duplication
		if ( $dbw->affectedRows() ) {
2284
			wfDebug( __METHOD__ . ": killed on ($field, $id)\n" );
2285
			return true;
2286
		} else {
2287
			wfDebug( __METHOD__ . ": already gone ($field, $id)\n" );
2288
			return false;
2289
		}
2290
	}
2291
2292
	/**
2293
	 * Update the 'You have new messages!' status.
2294
	 * @param bool $val Whether the user has new messages
2295
	 * @param Revision $curRev New, as yet unseen revision of the user talk
2296
	 *   page. Ignored if null or !$val.
2297
	 */
2298
	public function setNewtalk( $val, $curRev = null ) {
2299
		if ( wfReadOnly() ) {
2300
			return;
2301
		}
2302
2303
		$this->load();
2304
		$this->mNewtalk = $val;
2305
2306
		if ( $this->isAnon() ) {
2307
			$field = 'user_ip';
2308
			$id = $this->getName();
2309
		} else {
2310
			$field = 'user_id';
2311
			$id = $this->getId();
2312
		}
2313
2314
		if ( $val ) {
2315
			$changed = $this->updateNewtalk( $field, $id, $curRev );
2316
		} else {
2317
			$changed = $this->deleteNewtalk( $field, $id );
2318
		}
2319
2320
		if ( $changed ) {
2321
			$this->invalidateCache();
2322
		}
2323
	}
2324
2325
	/**
2326
	 * Generate a current or new-future timestamp to be stored in the
2327
	 * user_touched field when we update things.
2328
	 * @return string Timestamp in TS_MW format
2329
	 */
2330
	private function newTouchedTimestamp() {
2331
		global $wgClockSkewFudge;
2332
2333
		$time = wfTimestamp( TS_MW, time() + $wgClockSkewFudge );
2334
		if ( $this->mTouched && $time <= $this->mTouched ) {
2335
			$time = wfTimestamp( TS_MW, wfTimestamp( TS_UNIX, $this->mTouched ) + 1 );
2336
		}
2337
2338
		return $time;
2339
	}
2340
2341
	/**
2342
	 * Clear user data from memcached
2343
	 *
2344
	 * Use after applying updates to the database; caller's
2345
	 * responsibility to update user_touched if appropriate.
2346
	 *
2347
	 * Called implicitly from invalidateCache() and saveSettings().
2348
	 *
2349
	 * @param string $mode Use 'refresh' to clear now; otherwise before DB commit
2350
	 */
2351
	public function clearSharedCache( $mode = 'changed' ) {
2352
		if ( !$this->getId() ) {
2353
			return;
2354
		}
2355
2356
		$cache = ObjectCache::getMainWANInstance();
2357
		$key = $this->getCacheKey( $cache );
2358
		if ( $mode === 'refresh' ) {
2359
			$cache->delete( $key, 1 );
2360
		} else {
2361
			wfGetDB( DB_MASTER )->onTransactionPreCommitOrIdle(
2362
				function() use ( $cache, $key ) {
2363
					$cache->delete( $key );
2364
				},
2365
				__METHOD__
2366
			);
2367
		}
2368
	}
2369
2370
	/**
2371
	 * Immediately touch the user data cache for this account
2372
	 *
2373
	 * Calls touch() and removes account data from memcached
2374
	 */
2375
	public function invalidateCache() {
2376
		$this->touch();
2377
		$this->clearSharedCache();
2378
	}
2379
2380
	/**
2381
	 * Update the "touched" timestamp for the user
2382
	 *
2383
	 * This is useful on various login/logout events when making sure that
2384
	 * a browser or proxy that has multiple tenants does not suffer cache
2385
	 * pollution where the new user sees the old users content. The value
2386
	 * of getTouched() is checked when determining 304 vs 200 responses.
2387
	 * Unlike invalidateCache(), this preserves the User object cache and
2388
	 * avoids database writes.
2389
	 *
2390
	 * @since 1.25
2391
	 */
2392
	public function touch() {
2393
		$id = $this->getId();
2394
		if ( $id ) {
2395
			$key = wfMemcKey( 'user-quicktouched', 'id', $id );
2396
			ObjectCache::getMainWANInstance()->touchCheckKey( $key );
2397
			$this->mQuickTouched = null;
2398
		}
2399
	}
2400
2401
	/**
2402
	 * Validate the cache for this account.
2403
	 * @param string $timestamp A timestamp in TS_MW format
2404
	 * @return bool
2405
	 */
2406
	public function validateCache( $timestamp ) {
2407
		return ( $timestamp >= $this->getTouched() );
2408
	}
2409
2410
	/**
2411
	 * Get the user touched timestamp
2412
	 *
2413
	 * Use this value only to validate caches via inequalities
2414
	 * such as in the case of HTTP If-Modified-Since response logic
2415
	 *
2416
	 * @return string TS_MW Timestamp
2417
	 */
2418
	public function getTouched() {
2419
		$this->load();
2420
2421
		if ( $this->mId ) {
2422
			if ( $this->mQuickTouched === null ) {
2423
				$key = wfMemcKey( 'user-quicktouched', 'id', $this->mId );
2424
				$cache = ObjectCache::getMainWANInstance();
2425
2426
				$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...
2427
			}
2428
2429
			return max( $this->mTouched, $this->mQuickTouched );
2430
		}
2431
2432
		return $this->mTouched;
2433
	}
2434
2435
	/**
2436
	 * Get the user_touched timestamp field (time of last DB updates)
2437
	 * @return string TS_MW Timestamp
2438
	 * @since 1.26
2439
	 */
2440
	public function getDBTouched() {
2441
		$this->load();
2442
2443
		return $this->mTouched;
2444
	}
2445
2446
	/**
2447
	 * @deprecated Removed in 1.27.
2448
	 * @return Password
2449
	 * @since 1.24
2450
	 */
2451
	public function getPassword() {
2452
		throw new BadMethodCallException( __METHOD__ . ' has been removed in 1.27' );
2453
	}
2454
2455
	/**
2456
	 * @deprecated Removed in 1.27.
2457
	 * @return Password
2458
	 * @since 1.24
2459
	 */
2460
	public function getTemporaryPassword() {
2461
		throw new BadMethodCallException( __METHOD__ . ' has been removed in 1.27' );
2462
	}
2463
2464
	/**
2465
	 * Set the password and reset the random token.
2466
	 * Calls through to authentication plugin if necessary;
2467
	 * will have no effect if the auth plugin refuses to
2468
	 * pass the change through or if the legal password
2469
	 * checks fail.
2470
	 *
2471
	 * As a special case, setting the password to null
2472
	 * wipes it, so the account cannot be logged in until
2473
	 * a new password is set, for instance via e-mail.
2474
	 *
2475
	 * @deprecated since 1.27, use AuthManager instead
2476
	 * @param string $str New password to set
2477
	 * @throws PasswordError On failure
2478
	 * @return bool
2479
	 */
2480
	public function setPassword( $str ) {
2481
		return $this->setPasswordInternal( $str );
2482
	}
2483
2484
	/**
2485
	 * Set the password and reset the random token unconditionally.
2486
	 *
2487
	 * @deprecated since 1.27, use AuthManager instead
2488
	 * @param string|null $str New password to set or null to set an invalid
2489
	 *  password hash meaning that the user will not be able to log in
2490
	 *  through the web interface.
2491
	 */
2492
	public function setInternalPassword( $str ) {
2493
		$this->setPasswordInternal( $str );
2494
	}
2495
2496
	/**
2497
	 * Actually set the password and such
2498
	 * @since 1.27 cannot set a password for a user not in the database
2499
	 * @param string|null $str New password to set or null to set an invalid
2500
	 *  password hash meaning that the user will not be able to log in
2501
	 *  through the web interface.
2502
	 * @return bool Success
2503
	 */
2504
	private function setPasswordInternal( $str ) {
2505
		$manager = AuthManager::singleton();
2506
2507
		// If the user doesn't exist yet, fail
2508
		if ( !$manager->userExists( $this->getName() ) ) {
2509
			throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
2510
		}
2511
2512
		$status = $this->changeAuthenticationData( [
2513
			'username' => $this->getName(),
2514
			'password' => $str,
2515
			'retype' => $str,
2516
		] );
2517
		if ( !$status->isGood() ) {
2518
			\MediaWiki\Logger\LoggerFactory::getInstance( 'authentication' )
2519
				->info( __METHOD__ . ': Password change rejected: '
2520
					. $status->getWikiText( null, null, 'en' ) );
2521
			return false;
2522
		}
2523
2524
		$this->setOption( 'watchlisttoken', false );
2525
		SessionManager::singleton()->invalidateSessionsForUser( $this );
2526
2527
		return true;
2528
	}
2529
2530
	/**
2531
	 * Changes credentials of the user.
2532
	 *
2533
	 * This is a convenience wrapper around AuthManager::changeAuthenticationData.
2534
	 * Note that this can return a status that isOK() but not isGood() on certain types of failures,
2535
	 * e.g. when no provider handled the change.
2536
	 *
2537
	 * @param array $data A set of authentication data in fieldname => value format. This is the
2538
	 *   same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
2539
	 * @return Status
2540
	 * @since 1.27
2541
	 */
2542
	public function changeAuthenticationData( array $data ) {
2543
		$manager = AuthManager::singleton();
2544
		$reqs = $manager->getAuthenticationRequests( AuthManager::ACTION_CHANGE, $this );
2545
		$reqs = AuthenticationRequest::loadRequestsFromSubmission( $reqs, $data );
2546
2547
		$status = Status::newGood( 'ignored' );
2548
		foreach ( $reqs as $req ) {
2549
			$status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
2550
		}
2551
		if ( $status->getValue() === 'ignored' ) {
2552
			$status->warning( 'authenticationdatachange-ignored' );
2553
		}
2554
2555
		if ( $status->isGood() ) {
2556
			foreach ( $reqs as $req ) {
2557
				$manager->changeAuthenticationData( $req );
2558
			}
2559
		}
2560
		return $status;
2561
	}
2562
2563
	/**
2564
	 * Get the user's current token.
2565
	 * @param bool $forceCreation Force the generation of a new token if the
2566
	 *   user doesn't have one (default=true for backwards compatibility).
2567
	 * @return string|null Token
2568
	 */
2569
	public function getToken( $forceCreation = true ) {
2570
		global $wgAuthenticationTokenVersion;
2571
2572
		$this->load();
2573
		if ( !$this->mToken && $forceCreation ) {
2574
			$this->setToken();
2575
		}
2576
2577
		if ( !$this->mToken ) {
2578
			// The user doesn't have a token, return null to indicate that.
2579
			return null;
2580
		} elseif ( $this->mToken === self::INVALID_TOKEN ) {
2581
			// We return a random value here so existing token checks are very
2582
			// likely to fail.
2583
			return MWCryptRand::generateHex( self::TOKEN_LENGTH );
2584
		} elseif ( $wgAuthenticationTokenVersion === null ) {
2585
			// $wgAuthenticationTokenVersion not in use, so return the raw secret
2586
			return $this->mToken;
2587
		} else {
2588
			// $wgAuthenticationTokenVersion in use, so hmac it.
2589
			$ret = MWCryptHash::hmac( $wgAuthenticationTokenVersion, $this->mToken, false );
2590
2591
			// The raw hash can be overly long. Shorten it up.
2592
			$len = max( 32, self::TOKEN_LENGTH );
2593
			if ( strlen( $ret ) < $len ) {
2594
				// Should never happen, even md5 is 128 bits
2595
				throw new \UnexpectedValueException( 'Hmac returned less than 128 bits' );
2596
			}
2597
			return substr( $ret, -$len );
2598
		}
2599
	}
2600
2601
	/**
2602
	 * Set the random token (used for persistent authentication)
2603
	 * Called from loadDefaults() among other places.
2604
	 *
2605
	 * @param string|bool $token If specified, set the token to this value
2606
	 */
2607
	public function setToken( $token = false ) {
2608
		$this->load();
2609
		if ( $this->mToken === self::INVALID_TOKEN ) {
2610
			\MediaWiki\Logger\LoggerFactory::getInstance( 'session' )
2611
				->debug( __METHOD__ . ": Ignoring attempt to set token for system user \"$this\"" );
2612
		} elseif ( !$token ) {
2613
			$this->mToken = MWCryptRand::generateHex( self::TOKEN_LENGTH );
2614
		} else {
2615
			$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...
2616
		}
2617
	}
2618
2619
	/**
2620
	 * Set the password for a password reminder or new account email
2621
	 *
2622
	 * @deprecated Removed in 1.27. Use PasswordReset instead.
2623
	 * @param string $str New password to set or null to set an invalid
2624
	 *  password hash meaning that the user will not be able to use it
2625
	 * @param bool $throttle If true, reset the throttle timestamp to the present
2626
	 */
2627
	public function setNewpassword( $str, $throttle = true ) {
2628
		throw new BadMethodCallException( __METHOD__ . ' has been removed in 1.27' );
2629
	}
2630
2631
	/**
2632
	 * Has password reminder email been sent within the last
2633
	 * $wgPasswordReminderResendTime hours?
2634
	 * @deprecated Removed in 1.27. See above.
2635
	 * @return bool
2636
	 */
2637
	public function isPasswordReminderThrottled() {
2638
		throw new BadMethodCallException( __METHOD__ . ' has been removed in 1.27' );
2639
	}
2640
2641
	/**
2642
	 * Get the user's e-mail address
2643
	 * @return string User's email address
2644
	 */
2645
	public function getEmail() {
2646
		$this->load();
2647
		Hooks::run( 'UserGetEmail', [ $this, &$this->mEmail ] );
2648
		return $this->mEmail;
2649
	}
2650
2651
	/**
2652
	 * Get the timestamp of the user's e-mail authentication
2653
	 * @return string TS_MW timestamp
2654
	 */
2655
	public function getEmailAuthenticationTimestamp() {
2656
		$this->load();
2657
		Hooks::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated ] );
2658
		return $this->mEmailAuthenticated;
2659
	}
2660
2661
	/**
2662
	 * Set the user's e-mail address
2663
	 * @param string $str New e-mail address
2664
	 */
2665
	public function setEmail( $str ) {
2666
		$this->load();
2667
		if ( $str == $this->mEmail ) {
2668
			return;
2669
		}
2670
		$this->invalidateEmail();
2671
		$this->mEmail = $str;
2672
		Hooks::run( 'UserSetEmail', [ $this, &$this->mEmail ] );
2673
	}
2674
2675
	/**
2676
	 * Set the user's e-mail address and a confirmation mail if needed.
2677
	 *
2678
	 * @since 1.20
2679
	 * @param string $str New e-mail address
2680
	 * @return Status
2681
	 */
2682
	public function setEmailWithConfirmation( $str ) {
2683
		global $wgEnableEmail, $wgEmailAuthentication;
2684
2685
		if ( !$wgEnableEmail ) {
2686
			return Status::newFatal( 'emaildisabled' );
2687
		}
2688
2689
		$oldaddr = $this->getEmail();
2690
		if ( $str === $oldaddr ) {
2691
			return Status::newGood( true );
2692
		}
2693
2694
		$type = $oldaddr != '' ? 'changed' : 'set';
2695
		$notificationResult = null;
2696
2697
		if ( $wgEmailAuthentication ) {
2698
			// Send the user an email notifying the user of the change in registered
2699
			// email address on their previous email address
2700
			if ( $type == 'changed' ) {
2701
				$change = $str != '' ? 'changed' : 'removed';
2702
				$notificationResult = $this->sendMail(
2703
					wfMessage( 'notificationemail_subject_' . $change )->text(),
2704
					wfMessage( 'notificationemail_body_' . $change,
2705
						$this->getRequest()->getIP(),
2706
						$this->getName(),
2707
						$str )->text()
2708
				);
2709
			}
2710
		}
2711
2712
		$this->setEmail( $str );
2713
2714
		if ( $str !== '' && $wgEmailAuthentication ) {
2715
			// Send a confirmation request to the new address if needed
2716
			$result = $this->sendConfirmationMail( $type );
2717
2718
			if ( $notificationResult !== null ) {
2719
				$result->merge( $notificationResult );
2720
			}
2721
2722
			if ( $result->isGood() ) {
2723
				// Say to the caller that a confirmation and notification mail has been sent
2724
				$result->value = 'eauth';
2725
			}
2726
		} else {
2727
			$result = Status::newGood( true );
2728
		}
2729
2730
		return $result;
2731
	}
2732
2733
	/**
2734
	 * Get the user's real name
2735
	 * @return string User's real name
2736
	 */
2737
	public function getRealName() {
2738
		if ( !$this->isItemLoaded( 'realname' ) ) {
2739
			$this->load();
2740
		}
2741
2742
		return $this->mRealName;
2743
	}
2744
2745
	/**
2746
	 * Set the user's real name
2747
	 * @param string $str New real name
2748
	 */
2749
	public function setRealName( $str ) {
2750
		$this->load();
2751
		$this->mRealName = $str;
2752
	}
2753
2754
	/**
2755
	 * Get the user's current setting for a given option.
2756
	 *
2757
	 * @param string $oname The option to check
2758
	 * @param string $defaultOverride A default value returned if the option does not exist
2759
	 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
2760
	 * @return string User's current value for the option
2761
	 * @see getBoolOption()
2762
	 * @see getIntOption()
2763
	 */
2764
	public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2765
		global $wgHiddenPrefs;
2766
		$this->loadOptions();
2767
2768
		# We want 'disabled' preferences to always behave as the default value for
2769
		# users, even if they have set the option explicitly in their settings (ie they
2770
		# set it, and then it was disabled removing their ability to change it).  But
2771
		# we don't want to erase the preferences in the database in case the preference
2772
		# is re-enabled again.  So don't touch $mOptions, just override the returned value
2773
		if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
2774
			return self::getDefaultOption( $oname );
2775
		}
2776
2777
		if ( array_key_exists( $oname, $this->mOptions ) ) {
2778
			return $this->mOptions[$oname];
2779
		} else {
2780
			return $defaultOverride;
2781
		}
2782
	}
2783
2784
	/**
2785
	 * Get all user's options
2786
	 *
2787
	 * @param int $flags Bitwise combination of:
2788
	 *   User::GETOPTIONS_EXCLUDE_DEFAULTS  Exclude user options that are set
2789
	 *                                      to the default value. (Since 1.25)
2790
	 * @return array
2791
	 */
2792
	public function getOptions( $flags = 0 ) {
2793
		global $wgHiddenPrefs;
2794
		$this->loadOptions();
2795
		$options = $this->mOptions;
2796
2797
		# We want 'disabled' preferences to always behave as the default value for
2798
		# users, even if they have set the option explicitly in their settings (ie they
2799
		# set it, and then it was disabled removing their ability to change it).  But
2800
		# we don't want to erase the preferences in the database in case the preference
2801
		# is re-enabled again.  So don't touch $mOptions, just override the returned value
2802
		foreach ( $wgHiddenPrefs as $pref ) {
2803
			$default = self::getDefaultOption( $pref );
2804
			if ( $default !== null ) {
2805
				$options[$pref] = $default;
2806
			}
2807
		}
2808
2809
		if ( $flags & self::GETOPTIONS_EXCLUDE_DEFAULTS ) {
2810
			$options = array_diff_assoc( $options, self::getDefaultOptions() );
2811
		}
2812
2813
		return $options;
2814
	}
2815
2816
	/**
2817
	 * Get the user's current setting for a given option, as a boolean value.
2818
	 *
2819
	 * @param string $oname The option to check
2820
	 * @return bool User's current value for the option
2821
	 * @see getOption()
2822
	 */
2823
	public function getBoolOption( $oname ) {
2824
		return (bool)$this->getOption( $oname );
2825
	}
2826
2827
	/**
2828
	 * Get the user's current setting for a given option, as an integer value.
2829
	 *
2830
	 * @param string $oname The option to check
2831
	 * @param int $defaultOverride A default value returned if the option does not exist
2832
	 * @return int User's current value for the option
2833
	 * @see getOption()
2834
	 */
2835
	public function getIntOption( $oname, $defaultOverride = 0 ) {
2836
		$val = $this->getOption( $oname );
2837
		if ( $val == '' ) {
2838
			$val = $defaultOverride;
2839
		}
2840
		return intval( $val );
2841
	}
2842
2843
	/**
2844
	 * Set the given option for a user.
2845
	 *
2846
	 * You need to call saveSettings() to actually write to the database.
2847
	 *
2848
	 * @param string $oname The option to set
2849
	 * @param mixed $val New value to set
2850
	 */
2851
	public function setOption( $oname, $val ) {
2852
		$this->loadOptions();
2853
2854
		// Explicitly NULL values should refer to defaults
2855
		if ( is_null( $val ) ) {
2856
			$val = self::getDefaultOption( $oname );
2857
		}
2858
2859
		$this->mOptions[$oname] = $val;
2860
	}
2861
2862
	/**
2863
	 * Get a token stored in the preferences (like the watchlist one),
2864
	 * resetting it if it's empty (and saving changes).
2865
	 *
2866
	 * @param string $oname The option name to retrieve the token from
2867
	 * @return string|bool User's current value for the option, or false if this option is disabled.
2868
	 * @see resetTokenFromOption()
2869
	 * @see getOption()
2870
	 * @deprecated since 1.26 Applications should use the OAuth extension
2871
	 */
2872
	public function getTokenFromOption( $oname ) {
2873
		global $wgHiddenPrefs;
2874
2875
		$id = $this->getId();
2876
		if ( !$id || in_array( $oname, $wgHiddenPrefs ) ) {
2877
			return false;
2878
		}
2879
2880
		$token = $this->getOption( $oname );
2881
		if ( !$token ) {
2882
			// Default to a value based on the user token to avoid space
2883
			// wasted on storing tokens for all users. When this option
2884
			// is set manually by the user, only then is it stored.
2885
			$token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
2886
		}
2887
2888
		return $token;
2889
	}
2890
2891
	/**
2892
	 * Reset a token stored in the preferences (like the watchlist one).
2893
	 * *Does not* save user's preferences (similarly to setOption()).
2894
	 *
2895
	 * @param string $oname The option name to reset the token in
2896
	 * @return string|bool New token value, or false if this option is disabled.
2897
	 * @see getTokenFromOption()
2898
	 * @see setOption()
2899
	 */
2900
	public function resetTokenFromOption( $oname ) {
2901
		global $wgHiddenPrefs;
2902
		if ( in_array( $oname, $wgHiddenPrefs ) ) {
2903
			return false;
2904
		}
2905
2906
		$token = MWCryptRand::generateHex( 40 );
2907
		$this->setOption( $oname, $token );
2908
		return $token;
2909
	}
2910
2911
	/**
2912
	 * Return a list of the types of user options currently returned by
2913
	 * User::getOptionKinds().
2914
	 *
2915
	 * Currently, the option kinds are:
2916
	 * - 'registered' - preferences which are registered in core MediaWiki or
2917
	 *                  by extensions using the UserGetDefaultOptions hook.
2918
	 * - 'registered-multiselect' - as above, using the 'multiselect' type.
2919
	 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
2920
	 * - 'userjs' - preferences with names starting with 'userjs-', intended to
2921
	 *              be used by user scripts.
2922
	 * - 'special' - "preferences" that are not accessible via User::getOptions
2923
	 *               or User::setOptions.
2924
	 * - 'unused' - preferences about which MediaWiki doesn't know anything.
2925
	 *              These are usually legacy options, removed in newer versions.
2926
	 *
2927
	 * The API (and possibly others) use this function to determine the possible
2928
	 * option types for validation purposes, so make sure to update this when a
2929
	 * new option kind is added.
2930
	 *
2931
	 * @see User::getOptionKinds
2932
	 * @return array Option kinds
2933
	 */
2934
	public static function listOptionKinds() {
2935
		return [
2936
			'registered',
2937
			'registered-multiselect',
2938
			'registered-checkmatrix',
2939
			'userjs',
2940
			'special',
2941
			'unused'
2942
		];
2943
	}
2944
2945
	/**
2946
	 * Return an associative array mapping preferences keys to the kind of a preference they're
2947
	 * used for. Different kinds are handled differently when setting or reading preferences.
2948
	 *
2949
	 * See User::listOptionKinds for the list of valid option types that can be provided.
2950
	 *
2951
	 * @see User::listOptionKinds
2952
	 * @param IContextSource $context
2953
	 * @param array $options Assoc. array with options keys to check as keys.
2954
	 *   Defaults to $this->mOptions.
2955
	 * @return array The key => kind mapping data
2956
	 */
2957
	public function getOptionKinds( IContextSource $context, $options = null ) {
2958
		$this->loadOptions();
2959
		if ( $options === null ) {
2960
			$options = $this->mOptions;
2961
		}
2962
2963
		$prefs = Preferences::getPreferences( $this, $context );
2964
		$mapping = [];
2965
2966
		// Pull out the "special" options, so they don't get converted as
2967
		// multiselect or checkmatrix.
2968
		$specialOptions = array_fill_keys( Preferences::getSaveBlacklist(), true );
2969
		foreach ( $specialOptions as $name => $value ) {
2970
			unset( $prefs[$name] );
2971
		}
2972
2973
		// Multiselect and checkmatrix options are stored in the database with
2974
		// one key per option, each having a boolean value. Extract those keys.
2975
		$multiselectOptions = [];
2976
		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...
2977 View Code Duplication
			if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
2978
					( isset( $info['class'] ) && $info['class'] == 'HTMLMultiSelectField' ) ) {
2979
				$opts = HTMLFormField::flattenOptions( $info['options'] );
2980
				$prefix = isset( $info['prefix'] ) ? $info['prefix'] : $name;
2981
2982
				foreach ( $opts as $value ) {
2983
					$multiselectOptions["$prefix$value"] = true;
2984
				}
2985
2986
				unset( $prefs[$name] );
2987
			}
2988
		}
2989
		$checkmatrixOptions = [];
2990
		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...
2991
			if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
2992
					( isset( $info['class'] ) && $info['class'] == 'HTMLCheckMatrix' ) ) {
2993
				$columns = HTMLFormField::flattenOptions( $info['columns'] );
2994
				$rows = HTMLFormField::flattenOptions( $info['rows'] );
2995
				$prefix = isset( $info['prefix'] ) ? $info['prefix'] : $name;
2996
2997
				foreach ( $columns as $column ) {
2998
					foreach ( $rows as $row ) {
2999
						$checkmatrixOptions["$prefix$column-$row"] = true;
3000
					}
3001
				}
3002
3003
				unset( $prefs[$name] );
3004
			}
3005
		}
3006
3007
		// $value is ignored
3008
		foreach ( $options as $key => $value ) {
3009
			if ( isset( $prefs[$key] ) ) {
3010
				$mapping[$key] = 'registered';
3011
			} elseif ( isset( $multiselectOptions[$key] ) ) {
3012
				$mapping[$key] = 'registered-multiselect';
3013
			} elseif ( isset( $checkmatrixOptions[$key] ) ) {
3014
				$mapping[$key] = 'registered-checkmatrix';
3015
			} elseif ( isset( $specialOptions[$key] ) ) {
3016
				$mapping[$key] = 'special';
3017
			} elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
3018
				$mapping[$key] = 'userjs';
3019
			} else {
3020
				$mapping[$key] = 'unused';
3021
			}
3022
		}
3023
3024
		return $mapping;
3025
	}
3026
3027
	/**
3028
	 * Reset certain (or all) options to the site defaults
3029
	 *
3030
	 * The optional parameter determines which kinds of preferences will be reset.
3031
	 * Supported values are everything that can be reported by getOptionKinds()
3032
	 * and 'all', which forces a reset of *all* preferences and overrides everything else.
3033
	 *
3034
	 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
3035
	 *  array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
3036
	 *  for backwards-compatibility.
3037
	 * @param IContextSource|null $context Context source used when $resetKinds
3038
	 *  does not contain 'all', passed to getOptionKinds().
3039
	 *  Defaults to RequestContext::getMain() when null.
3040
	 */
3041
	public function resetOptions(
3042
		$resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
3043
		IContextSource $context = null
3044
	) {
3045
		$this->load();
3046
		$defaultOptions = self::getDefaultOptions();
3047
3048
		if ( !is_array( $resetKinds ) ) {
3049
			$resetKinds = [ $resetKinds ];
3050
		}
3051
3052
		if ( in_array( 'all', $resetKinds ) ) {
3053
			$newOptions = $defaultOptions;
3054
		} else {
3055
			if ( $context === null ) {
3056
				$context = RequestContext::getMain();
3057
			}
3058
3059
			$optionKinds = $this->getOptionKinds( $context );
3060
			$resetKinds = array_intersect( $resetKinds, self::listOptionKinds() );
3061
			$newOptions = [];
3062
3063
			// Use default values for the options that should be deleted, and
3064
			// copy old values for the ones that shouldn't.
3065
			foreach ( $this->mOptions as $key => $value ) {
3066
				if ( in_array( $optionKinds[$key], $resetKinds ) ) {
3067
					if ( array_key_exists( $key, $defaultOptions ) ) {
3068
						$newOptions[$key] = $defaultOptions[$key];
3069
					}
3070
				} else {
3071
					$newOptions[$key] = $value;
3072
				}
3073
			}
3074
		}
3075
3076
		Hooks::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions, $resetKinds ] );
3077
3078
		$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...
3079
		$this->mOptionsLoaded = true;
3080
	}
3081
3082
	/**
3083
	 * Get the user's preferred date format.
3084
	 * @return string User's preferred date format
3085
	 */
3086
	public function getDatePreference() {
3087
		// Important migration for old data rows
3088
		if ( is_null( $this->mDatePreference ) ) {
3089
			global $wgLang;
3090
			$value = $this->getOption( 'date' );
3091
			$map = $wgLang->getDatePreferenceMigrationMap();
3092
			if ( isset( $map[$value] ) ) {
3093
				$value = $map[$value];
3094
			}
3095
			$this->mDatePreference = $value;
3096
		}
3097
		return $this->mDatePreference;
3098
	}
3099
3100
	/**
3101
	 * Determine based on the wiki configuration and the user's options,
3102
	 * whether this user must be over HTTPS no matter what.
3103
	 *
3104
	 * @return bool
3105
	 */
3106
	public function requiresHTTPS() {
3107
		global $wgSecureLogin;
3108
		if ( !$wgSecureLogin ) {
3109
			return false;
3110
		} else {
3111
			$https = $this->getBoolOption( 'prefershttps' );
3112
			Hooks::run( 'UserRequiresHTTPS', [ $this, &$https ] );
3113
			if ( $https ) {
3114
				$https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
3115
			}
3116
			return $https;
3117
		}
3118
	}
3119
3120
	/**
3121
	 * Get the user preferred stub threshold
3122
	 *
3123
	 * @return int
3124
	 */
3125
	public function getStubThreshold() {
3126
		global $wgMaxArticleSize; # Maximum article size, in Kb
3127
		$threshold = $this->getIntOption( 'stubthreshold' );
3128
		if ( $threshold > $wgMaxArticleSize * 1024 ) {
3129
			// If they have set an impossible value, disable the preference
3130
			// so we can use the parser cache again.
3131
			$threshold = 0;
3132
		}
3133
		return $threshold;
3134
	}
3135
3136
	/**
3137
	 * Get the permissions this user has.
3138
	 * @return array Array of String permission names
3139
	 */
3140
	public function getRights() {
3141
		if ( is_null( $this->mRights ) ) {
3142
			$this->mRights = self::getGroupPermissions( $this->getEffectiveGroups() );
3143
			Hooks::run( 'UserGetRights', [ $this, &$this->mRights ] );
3144
3145
			// Deny any rights denied by the user's session, unless this
3146
			// endpoint has no sessions.
3147
			if ( !defined( 'MW_NO_SESSION' ) ) {
3148
				$allowedRights = $this->getRequest()->getSession()->getAllowedUserRights();
3149
				if ( $allowedRights !== null ) {
3150
					$this->mRights = array_intersect( $this->mRights, $allowedRights );
3151
				}
3152
			}
3153
3154
			// Force reindexation of rights when a hook has unset one of them
3155
			$this->mRights = array_values( array_unique( $this->mRights ) );
3156
3157
			// If block disables login, we should also remove any
3158
			// extra rights blocked users might have, in case the
3159
			// blocked user has a pre-existing session (T129738).
3160
			// This is checked here for cases where people only call
3161
			// $user->isAllowed(). It is also checked in Title::checkUserBlock()
3162
			// to give a better error message in the common case.
3163
			$config = RequestContext::getMain()->getConfig();
3164
			if (
3165
				$this->isLoggedIn() &&
3166
				$config->get( 'BlockDisablesLogin' ) &&
3167
				$this->isBlocked()
3168
			) {
3169
				$anon = new User;
3170
				$this->mRights = array_intersect( $this->mRights, $anon->getRights() );
3171
			}
3172
		}
3173
		return $this->mRights;
3174
	}
3175
3176
	/**
3177
	 * Get the list of explicit group memberships this user has.
3178
	 * The implicit * and user groups are not included.
3179
	 * @return array Array of String internal group names
3180
	 */
3181
	public function getGroups() {
3182
		$this->load();
3183
		$this->loadGroups();
3184
		return $this->mGroups;
3185
	}
3186
3187
	/**
3188
	 * Get the list of implicit group memberships this user has.
3189
	 * This includes all explicit groups, plus 'user' if logged in,
3190
	 * '*' for all accounts, and autopromoted groups
3191
	 * @param bool $recache Whether to avoid the cache
3192
	 * @return array Array of String internal group names
3193
	 */
3194
	public function getEffectiveGroups( $recache = false ) {
3195
		if ( $recache || is_null( $this->mEffectiveGroups ) ) {
3196
			$this->mEffectiveGroups = array_unique( array_merge(
3197
				$this->getGroups(), // explicit groups
3198
				$this->getAutomaticGroups( $recache ) // implicit groups
3199
			) );
3200
			// Hook for additional groups
3201
			Hooks::run( 'UserEffectiveGroups', [ &$this, &$this->mEffectiveGroups ] );
3202
			// Force reindexation of groups when a hook has unset one of them
3203
			$this->mEffectiveGroups = array_values( array_unique( $this->mEffectiveGroups ) );
3204
		}
3205
		return $this->mEffectiveGroups;
3206
	}
3207
3208
	/**
3209
	 * Get the list of implicit group memberships this user has.
3210
	 * This includes 'user' if logged in, '*' for all accounts,
3211
	 * and autopromoted groups
3212
	 * @param bool $recache Whether to avoid the cache
3213
	 * @return array Array of String internal group names
3214
	 */
3215
	public function getAutomaticGroups( $recache = false ) {
3216
		if ( $recache || is_null( $this->mImplicitGroups ) ) {
3217
			$this->mImplicitGroups = [ '*' ];
3218
			if ( $this->getId() ) {
3219
				$this->mImplicitGroups[] = 'user';
3220
3221
				$this->mImplicitGroups = array_unique( array_merge(
3222
					$this->mImplicitGroups,
3223
					Autopromote::getAutopromoteGroups( $this )
3224
				) );
3225
			}
3226
			if ( $recache ) {
3227
				// Assure data consistency with rights/groups,
3228
				// as getEffectiveGroups() depends on this function
3229
				$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...
3230
			}
3231
		}
3232
		return $this->mImplicitGroups;
3233
	}
3234
3235
	/**
3236
	 * Returns the groups the user has belonged to.
3237
	 *
3238
	 * The user may still belong to the returned groups. Compare with getGroups().
3239
	 *
3240
	 * The function will not return groups the user had belonged to before MW 1.17
3241
	 *
3242
	 * @return array Names of the groups the user has belonged to.
3243
	 */
3244 View Code Duplication
	public function getFormerGroups() {
3245
		$this->load();
3246
3247
		if ( is_null( $this->mFormerGroups ) ) {
3248
			$db = ( $this->queryFlagsUsed & self::READ_LATEST )
3249
				? wfGetDB( DB_MASTER )
3250
				: wfGetDB( DB_REPLICA );
3251
			$res = $db->select( 'user_former_groups',
3252
				[ 'ufg_group' ],
3253
				[ 'ufg_user' => $this->mId ],
3254
				__METHOD__ );
3255
			$this->mFormerGroups = [];
3256
			foreach ( $res as $row ) {
3257
				$this->mFormerGroups[] = $row->ufg_group;
3258
			}
3259
		}
3260
3261
		return $this->mFormerGroups;
3262
	}
3263
3264
	/**
3265
	 * Get the user's edit count.
3266
	 * @return int|null Null for anonymous users
3267
	 */
3268
	public function getEditCount() {
3269
		if ( !$this->getId() ) {
3270
			return null;
3271
		}
3272
3273
		if ( $this->mEditCount === null ) {
3274
			/* Populate the count, if it has not been populated yet */
3275
			$dbr = wfGetDB( DB_REPLICA );
3276
			// check if the user_editcount field has been initialized
3277
			$count = $dbr->selectField(
3278
				'user', 'user_editcount',
3279
				[ 'user_id' => $this->mId ],
3280
				__METHOD__
3281
			);
3282
3283
			if ( $count === null ) {
3284
				// it has not been initialized. do so.
3285
				$count = $this->initEditCount();
3286
			}
3287
			$this->mEditCount = $count;
3288
		}
3289
		return (int)$this->mEditCount;
3290
	}
3291
3292
	/**
3293
	 * Add the user to the given group.
3294
	 * This takes immediate effect.
3295
	 * @param string $group Name of the group to add
3296
	 * @return bool
3297
	 */
3298
	public function addGroup( $group ) {
3299
		$this->load();
3300
3301
		if ( !Hooks::run( 'UserAddGroup', [ $this, &$group ] ) ) {
3302
			return false;
3303
		}
3304
3305
		$dbw = wfGetDB( DB_MASTER );
3306
		if ( $this->getId() ) {
3307
			$dbw->insert( 'user_groups',
3308
				[
3309
					'ug_user' => $this->getId(),
3310
					'ug_group' => $group,
3311
				],
3312
				__METHOD__,
3313
				[ 'IGNORE' ] );
3314
		}
3315
3316
		$this->loadGroups();
3317
		$this->mGroups[] = $group;
3318
		// In case loadGroups was not called before, we now have the right twice.
3319
		// Get rid of the duplicate.
3320
		$this->mGroups = array_unique( $this->mGroups );
3321
3322
		// Refresh the groups caches, and clear the rights cache so it will be
3323
		// refreshed on the next call to $this->getRights().
3324
		$this->getEffectiveGroups( true );
3325
		$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...
3326
3327
		$this->invalidateCache();
3328
3329
		return true;
3330
	}
3331
3332
	/**
3333
	 * Remove the user from the given group.
3334
	 * This takes immediate effect.
3335
	 * @param string $group Name of the group to remove
3336
	 * @return bool
3337
	 */
3338
	public function removeGroup( $group ) {
3339
		$this->load();
3340
		if ( !Hooks::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
3341
			return false;
3342
		}
3343
3344
		$dbw = wfGetDB( DB_MASTER );
3345
		$dbw->delete( 'user_groups',
3346
			[
3347
				'ug_user' => $this->getId(),
3348
				'ug_group' => $group,
3349
			], __METHOD__
3350
		);
3351
		// Remember that the user was in this group
3352
		$dbw->insert( 'user_former_groups',
3353
			[
3354
				'ufg_user' => $this->getId(),
3355
				'ufg_group' => $group,
3356
			],
3357
			__METHOD__,
3358
			[ 'IGNORE' ]
3359
		);
3360
3361
		$this->loadGroups();
3362
		$this->mGroups = array_diff( $this->mGroups, [ $group ] );
3363
3364
		// Refresh the groups caches, and clear the rights cache so it will be
3365
		// refreshed on the next call to $this->getRights().
3366
		$this->getEffectiveGroups( true );
3367
		$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...
3368
3369
		$this->invalidateCache();
3370
3371
		return true;
3372
	}
3373
3374
	/**
3375
	 * Get whether the user is logged in
3376
	 * @return bool
3377
	 */
3378
	public function isLoggedIn() {
3379
		return $this->getId() != 0;
3380
	}
3381
3382
	/**
3383
	 * Get whether the user is anonymous
3384
	 * @return bool
3385
	 */
3386
	public function isAnon() {
3387
		return !$this->isLoggedIn();
3388
	}
3389
3390
	/**
3391
	 * @return bool Whether this user is flagged as being a bot role account
3392
	 * @since 1.28
3393
	 */
3394
	public function isBot() {
3395
		if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
3396
			return true;
3397
		}
3398
3399
		$isBot = false;
3400
		Hooks::run( "UserIsBot", [ $this, &$isBot ] );
3401
3402
		return $isBot;
3403
	}
3404
3405
	/**
3406
	 * Check if user is allowed to access a feature / make an action
3407
	 *
3408
	 * @param string ... Permissions to test
3409
	 * @return bool True if user is allowed to perform *any* of the given actions
3410
	 */
3411 View Code Duplication
	public function isAllowedAny() {
3412
		$permissions = func_get_args();
3413
		foreach ( $permissions as $permission ) {
3414
			if ( $this->isAllowed( $permission ) ) {
3415
				return true;
3416
			}
3417
		}
3418
		return false;
3419
	}
3420
3421
	/**
3422
	 *
3423
	 * @param string ... Permissions to test
3424
	 * @return bool True if the user is allowed to perform *all* of the given actions
3425
	 */
3426 View Code Duplication
	public function isAllowedAll() {
3427
		$permissions = func_get_args();
3428
		foreach ( $permissions as $permission ) {
3429
			if ( !$this->isAllowed( $permission ) ) {
3430
				return false;
3431
			}
3432
		}
3433
		return true;
3434
	}
3435
3436
	/**
3437
	 * Internal mechanics of testing a permission
3438
	 * @param string $action
3439
	 * @return bool
3440
	 */
3441
	public function isAllowed( $action = '' ) {
3442
		if ( $action === '' ) {
3443
			return true; // In the spirit of DWIM
3444
		}
3445
		// Use strict parameter to avoid matching numeric 0 accidentally inserted
3446
		// by misconfiguration: 0 == 'foo'
3447
		return in_array( $action, $this->getRights(), true );
3448
	}
3449
3450
	/**
3451
	 * Check whether to enable recent changes patrol features for this user
3452
	 * @return bool True or false
3453
	 */
3454
	public function useRCPatrol() {
3455
		global $wgUseRCPatrol;
3456
		return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3457
	}
3458
3459
	/**
3460
	 * Check whether to enable new pages patrol features for this user
3461
	 * @return bool True or false
3462
	 */
3463
	public function useNPPatrol() {
3464
		global $wgUseRCPatrol, $wgUseNPPatrol;
3465
		return (
3466
			( $wgUseRCPatrol || $wgUseNPPatrol )
3467
				&& ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3468
		);
3469
	}
3470
3471
	/**
3472
	 * Check whether to enable new files patrol features for this user
3473
	 * @return bool True or false
3474
	 */
3475
	public function useFilePatrol() {
3476
		global $wgUseRCPatrol, $wgUseFilePatrol;
3477
		return (
3478
			( $wgUseRCPatrol || $wgUseFilePatrol )
3479
				&& ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3480
		);
3481
	}
3482
3483
	/**
3484
	 * Get the WebRequest object to use with this object
3485
	 *
3486
	 * @return WebRequest
3487
	 */
3488
	public function getRequest() {
3489
		if ( $this->mRequest ) {
3490
			return $this->mRequest;
3491
		} else {
3492
			global $wgRequest;
3493
			return $wgRequest;
3494
		}
3495
	}
3496
3497
	/**
3498
	 * Check the watched status of an article.
3499
	 * @since 1.22 $checkRights parameter added
3500
	 * @param Title $title Title of the article to look at
3501
	 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3502
	 *     Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3503
	 * @return bool
3504
	 */
3505
	public function isWatched( $title, $checkRights = self::CHECK_USER_RIGHTS ) {
3506
		if ( $title->isWatchable() && ( !$checkRights || $this->isAllowed( 'viewmywatchlist' ) ) ) {
3507
			return MediaWikiServices::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
3508
		}
3509
		return false;
3510
	}
3511
3512
	/**
3513
	 * Watch an article.
3514
	 * @since 1.22 $checkRights parameter added
3515
	 * @param Title $title Title of the article to look at
3516
	 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3517
	 *     Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3518
	 */
3519
	public function addWatch( $title, $checkRights = self::CHECK_USER_RIGHTS ) {
3520
		if ( !$checkRights || $this->isAllowed( 'editmywatchlist' ) ) {
3521
			MediaWikiServices::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
3522
				$this,
3523
				[ $title->getSubjectPage(), $title->getTalkPage() ]
3524
			);
3525
		}
3526
		$this->invalidateCache();
3527
	}
3528
3529
	/**
3530
	 * Stop watching an article.
3531
	 * @since 1.22 $checkRights parameter added
3532
	 * @param Title $title Title of the article to look at
3533
	 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3534
	 *     Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3535
	 */
3536
	public function removeWatch( $title, $checkRights = self::CHECK_USER_RIGHTS ) {
3537
		if ( !$checkRights || $this->isAllowed( 'editmywatchlist' ) ) {
3538
			$store = MediaWikiServices::getInstance()->getWatchedItemStore();
3539
			$store->removeWatch( $this, $title->getSubjectPage() );
3540
			$store->removeWatch( $this, $title->getTalkPage() );
3541
		}
3542
		$this->invalidateCache();
3543
	}
3544
3545
	/**
3546
	 * Clear the user's notification timestamp for the given title.
3547
	 * If e-notif e-mails are on, they will receive notification mails on
3548
	 * the next change of the page if it's watched etc.
3549
	 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3550
	 * @param Title $title Title of the article to look at
3551
	 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3552
	 */
3553
	public function clearNotification( &$title, $oldid = 0 ) {
3554
		global $wgUseEnotif, $wgShowUpdatedMarker;
3555
3556
		// Do nothing if the database is locked to writes
3557
		if ( wfReadOnly() ) {
3558
			return;
3559
		}
3560
3561
		// Do nothing if not allowed to edit the watchlist
3562
		if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3563
			return;
3564
		}
3565
3566
		// If we're working on user's talk page, we should update the talk page message indicator
3567
		if ( $title->getNamespace() == NS_USER_TALK && $title->getText() == $this->getName() ) {
3568
			if ( !Hooks::run( 'UserClearNewTalkNotification', [ &$this, $oldid ] ) ) {
3569
				return;
3570
			}
3571
3572
			// Try to update the DB post-send and only if needed...
3573
			DeferredUpdates::addCallableUpdate( function() use ( $title, $oldid ) {
3574
				if ( !$this->getNewtalk() ) {
3575
					return; // no notifications to clear
3576
				}
3577
3578
				// Delete the last notifications (they stack up)
3579
				$this->setNewtalk( false );
3580
3581
				// If there is a new, unseen, revision, use its timestamp
3582
				$nextid = $oldid
3583
					? $title->getNextRevisionID( $oldid, Title::GAID_FOR_UPDATE )
3584
					: null;
3585
				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...
3586
					$this->setNewtalk( true, Revision::newFromId( $nextid ) );
3587
				}
3588
			} );
3589
		}
3590
3591
		if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3592
			return;
3593
		}
3594
3595
		if ( $this->isAnon() ) {
3596
			// Nothing else to do...
3597
			return;
3598
		}
3599
3600
		// Only update the timestamp if the page is being watched.
3601
		// The query to find out if it is watched is cached both in memcached and per-invocation,
3602
		// and when it does have to be executed, it can be on a replica DB
3603
		// If this is the user's newtalk page, we always update the timestamp
3604
		$force = '';
3605
		if ( $title->getNamespace() == NS_USER_TALK && $title->getText() == $this->getName() ) {
3606
			$force = 'force';
3607
		}
3608
3609
		MediaWikiServices::getInstance()->getWatchedItemStore()
3610
			->resetNotificationTimestamp( $this, $title, $force, $oldid );
3611
	}
3612
3613
	/**
3614
	 * Resets all of the given user's page-change notification timestamps.
3615
	 * If e-notif e-mails are on, they will receive notification mails on
3616
	 * the next change of any watched page.
3617
	 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3618
	 */
3619
	public function clearAllNotifications() {
3620
		global $wgUseEnotif, $wgShowUpdatedMarker;
3621
		// Do nothing if not allowed to edit the watchlist
3622
		if ( wfReadOnly() || !$this->isAllowed( 'editmywatchlist' ) ) {
3623
			return;
3624
		}
3625
3626
		if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3627
			$this->setNewtalk( false );
3628
			return;
3629
		}
3630
3631
		$id = $this->getId();
3632
		if ( !$id ) {
3633
			return;
3634
		}
3635
3636
		$dbw = wfGetDB( DB_MASTER );
3637
		$asOfTimes = array_unique( $dbw->selectFieldValues(
3638
			'watchlist',
3639
			'wl_notificationtimestamp',
3640
			[ 'wl_user' => $id, 'wl_notificationtimestamp IS NOT NULL' ],
3641
			__METHOD__,
3642
			[ 'ORDER BY' => 'wl_notificationtimestamp DESC', 'LIMIT' => 500 ]
3643
		) );
3644
		if ( !$asOfTimes ) {
3645
			return;
3646
		}
3647
		// Immediately update the most recent touched rows, which hopefully covers what
3648
		// the user sees on the watchlist page before pressing "mark all pages visited"....
3649
		$dbw->update(
3650
			'watchlist',
3651
			[ 'wl_notificationtimestamp' => null ],
3652
			[ 'wl_user' => $id, 'wl_notificationtimestamp' => $asOfTimes ],
3653
			__METHOD__
3654
		);
3655
		// ...and finish the older ones in a post-send update with lag checks...
3656
		DeferredUpdates::addUpdate( new AutoCommitUpdate(
3657
			$dbw,
0 ignored issues
show
Bug introduced by
It seems like $dbw defined by wfGetDB(DB_MASTER) on line 3636 can be null; however, AutoCommitUpdate::__construct() does not accept null, maybe add an additional type check?

Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code:

/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
Loading history...
3658
			__METHOD__,
3659
			function () use ( $dbw, $id ) {
3660
				global $wgUpdateRowsPerQuery;
3661
3662
				$lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
3663
				$ticket = $lbFactory->getEmptyTransactionTicket( __METHOD__ );
3664
				$asOfTimes = array_unique( $dbw->selectFieldValues(
3665
					'watchlist',
3666
					'wl_notificationtimestamp',
3667
					[ 'wl_user' => $id, 'wl_notificationtimestamp IS NOT NULL' ],
3668
					__METHOD__
3669
				) );
3670
				foreach ( array_chunk( $asOfTimes, $wgUpdateRowsPerQuery ) as $asOfTimeBatch ) {
3671
					$dbw->update(
3672
						'watchlist',
3673
						[ 'wl_notificationtimestamp' => null ],
3674
						[ 'wl_user' => $id, 'wl_notificationtimestamp' => $asOfTimeBatch ],
3675
						__METHOD__
3676
					);
3677
					$lbFactory->commitAndWaitForReplication( __METHOD__, $ticket );
3678
				}
3679
			}
3680
		) );
3681
		// We also need to clear here the "you have new message" notification for the own
3682
		// user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
3683
	}
3684
3685
	/**
3686
	 * Set a cookie on the user's client. Wrapper for
3687
	 * WebResponse::setCookie
3688
	 * @deprecated since 1.27
3689
	 * @param string $name Name of the cookie to set
3690
	 * @param string $value Value to set
3691
	 * @param int $exp Expiration time, as a UNIX time value;
3692
	 *                   if 0 or not specified, use the default $wgCookieExpiration
3693
	 * @param bool $secure
3694
	 *  true: Force setting the secure attribute when setting the cookie
3695
	 *  false: Force NOT setting the secure attribute when setting the cookie
3696
	 *  null (default): Use the default ($wgCookieSecure) to set the secure attribute
3697
	 * @param array $params Array of options sent passed to WebResponse::setcookie()
3698
	 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3699
	 *        is passed.
3700
	 */
3701
	protected function setCookie(
3702
		$name, $value, $exp = 0, $secure = null, $params = [], $request = null
3703
	) {
3704
		wfDeprecated( __METHOD__, '1.27' );
3705
		if ( $request === null ) {
3706
			$request = $this->getRequest();
3707
		}
3708
		$params['secure'] = $secure;
3709
		$request->response()->setCookie( $name, $value, $exp, $params );
3710
	}
3711
3712
	/**
3713
	 * Clear a cookie on the user's client
3714
	 * @deprecated since 1.27
3715
	 * @param string $name Name of the cookie to clear
3716
	 * @param bool $secure
3717
	 *  true: Force setting the secure attribute when setting the cookie
3718
	 *  false: Force NOT setting the secure attribute when setting the cookie
3719
	 *  null (default): Use the default ($wgCookieSecure) to set the secure attribute
3720
	 * @param array $params Array of options sent passed to WebResponse::setcookie()
3721
	 */
3722
	protected function clearCookie( $name, $secure = null, $params = [] ) {
3723
		wfDeprecated( __METHOD__, '1.27' );
3724
		$this->setCookie( $name, '', time() - 86400, $secure, $params );
3725
	}
3726
3727
	/**
3728
	 * Set an extended login cookie on the user's client. The expiry of the cookie
3729
	 * is controlled by the $wgExtendedLoginCookieExpiration configuration
3730
	 * variable.
3731
	 *
3732
	 * @see User::setCookie
3733
	 *
3734
	 * @deprecated since 1.27
3735
	 * @param string $name Name of the cookie to set
3736
	 * @param string $value Value to set
3737
	 * @param bool $secure
3738
	 *  true: Force setting the secure attribute when setting the cookie
3739
	 *  false: Force NOT setting the secure attribute when setting the cookie
3740
	 *  null (default): Use the default ($wgCookieSecure) to set the secure attribute
3741
	 */
3742
	protected function setExtendedLoginCookie( $name, $value, $secure ) {
3743
		global $wgExtendedLoginCookieExpiration, $wgCookieExpiration;
3744
3745
		wfDeprecated( __METHOD__, '1.27' );
3746
3747
		$exp = time();
3748
		$exp += $wgExtendedLoginCookieExpiration !== null
3749
			? $wgExtendedLoginCookieExpiration
3750
			: $wgCookieExpiration;
3751
3752
		$this->setCookie( $name, $value, $exp, $secure );
3753
	}
3754
3755
	/**
3756
	 * Persist this user's session (e.g. set cookies)
3757
	 *
3758
	 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3759
	 *        is passed.
3760
	 * @param bool $secure Whether to force secure/insecure cookies or use default
3761
	 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
3762
	 */
3763
	public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
3764
		$this->load();
3765
		if ( 0 == $this->mId ) {
3766
			return;
3767
		}
3768
3769
		$session = $this->getRequest()->getSession();
3770
		if ( $request && $session->getRequest() !== $request ) {
3771
			$session = $session->sessionWithRequest( $request );
3772
		}
3773
		$delay = $session->delaySave();
3774
3775
		if ( !$session->getUser()->equals( $this ) ) {
3776
			if ( !$session->canSetUser() ) {
3777
				\MediaWiki\Logger\LoggerFactory::getInstance( 'session' )
3778
					->warning( __METHOD__ .
3779
						": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
3780
					);
3781
				return;
3782
			}
3783
			$session->setUser( $this );
3784
		}
3785
3786
		$session->setRememberUser( $rememberMe );
3787
		if ( $secure !== null ) {
3788
			$session->setForceHTTPS( $secure );
3789
		}
3790
3791
		$session->persist();
3792
3793
		ScopedCallback::consume( $delay );
3794
	}
3795
3796
	/**
3797
	 * Log this user out.
3798
	 */
3799
	public function logout() {
3800
		if ( Hooks::run( 'UserLogout', [ &$this ] ) ) {
3801
			$this->doLogout();
3802
		}
3803
	}
3804
3805
	/**
3806
	 * Clear the user's session, and reset the instance cache.
3807
	 * @see logout()
3808
	 */
3809
	public function doLogout() {
3810
		$session = $this->getRequest()->getSession();
3811
		if ( !$session->canSetUser() ) {
3812
			\MediaWiki\Logger\LoggerFactory::getInstance( 'session' )
3813
				->warning( __METHOD__ . ": Cannot log out of an immutable session" );
3814
			$error = 'immutable';
3815
		} elseif ( !$session->getUser()->equals( $this ) ) {
3816
			\MediaWiki\Logger\LoggerFactory::getInstance( 'session' )
3817
				->warning( __METHOD__ .
3818
					": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
3819
				);
3820
			// But we still may as well make this user object anon
3821
			$this->clearInstanceCache( 'defaults' );
3822
			$error = 'wronguser';
3823
		} else {
3824
			$this->clearInstanceCache( 'defaults' );
3825
			$delay = $session->delaySave();
3826
			$session->unpersist(); // Clear cookies (T127436)
3827
			$session->setLoggedOutTimestamp( time() );
3828
			$session->setUser( new User );
3829
			$session->set( 'wsUserID', 0 ); // Other code expects this
3830
			$session->resetAllTokens();
3831
			ScopedCallback::consume( $delay );
3832
			$error = false;
3833
		}
3834
		\MediaWiki\Logger\LoggerFactory::getInstance( 'authevents' )->info( 'Logout', [
3835
			'event' => 'logout',
3836
			'successful' => $error === false,
3837
			'status' => $error ?: 'success',
3838
		] );
3839
	}
3840
3841
	/**
3842
	 * Save this user's settings into the database.
3843
	 * @todo Only rarely do all these fields need to be set!
3844
	 */
3845
	public function saveSettings() {
3846
		if ( wfReadOnly() ) {
3847
			// @TODO: caller should deal with this instead!
3848
			// This should really just be an exception.
3849
			MWExceptionHandler::logException( new DBExpectedError(
3850
				null,
3851
				"Could not update user with ID '{$this->mId}'; DB is read-only."
3852
			) );
3853
			return;
3854
		}
3855
3856
		$this->load();
3857
		if ( 0 == $this->mId ) {
3858
			return; // anon
3859
		}
3860
3861
		// Get a new user_touched that is higher than the old one.
3862
		// This will be used for a CAS check as a last-resort safety
3863
		// check against race conditions and replica DB lag.
3864
		$newTouched = $this->newTouchedTimestamp();
3865
3866
		$dbw = wfGetDB( DB_MASTER );
3867
		$dbw->update( 'user',
3868
			[ /* SET */
3869
				'user_name' => $this->mName,
3870
				'user_real_name' => $this->mRealName,
3871
				'user_email' => $this->mEmail,
3872
				'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
3873
				'user_touched' => $dbw->timestamp( $newTouched ),
3874
				'user_token' => strval( $this->mToken ),
3875
				'user_email_token' => $this->mEmailToken,
3876
				'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires ),
3877
			], $this->makeUpdateConditions( $dbw, [ /* WHERE */
0 ignored issues
show
Bug introduced by
It seems like $dbw defined by wfGetDB(DB_MASTER) on line 3866 can be null; however, User::makeUpdateConditions() does not accept null, maybe add an additional type check?

Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code:

/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
Loading history...
3878
				'user_id' => $this->mId,
3879
			] ), __METHOD__
3880
		);
3881
3882
		if ( !$dbw->affectedRows() ) {
3883
			// Maybe the problem was a missed cache update; clear it to be safe
3884
			$this->clearSharedCache( 'refresh' );
3885
			// User was changed in the meantime or loaded with stale data
3886
			$from = ( $this->queryFlagsUsed & self::READ_LATEST ) ? 'master' : 'replica';
3887
			throw new MWException(
3888
				"CAS update failed on user_touched for user ID '{$this->mId}' (read from $from);" .
3889
				" the version of the user to be saved is older than the current version."
3890
			);
3891
		}
3892
3893
		$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...
3894
		$this->saveOptions();
3895
3896
		Hooks::run( 'UserSaveSettings', [ $this ] );
3897
		$this->clearSharedCache();
3898
		$this->getUserPage()->invalidateCache();
3899
	}
3900
3901
	/**
3902
	 * If only this user's username is known, and it exists, return the user ID.
3903
	 *
3904
	 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
3905
	 * @return int
3906
	 */
3907
	public function idForName( $flags = 0 ) {
3908
		$s = trim( $this->getName() );
3909
		if ( $s === '' ) {
3910
			return 0;
3911
		}
3912
3913
		$db = ( ( $flags & self::READ_LATEST ) == self::READ_LATEST )
3914
			? wfGetDB( DB_MASTER )
3915
			: wfGetDB( DB_REPLICA );
3916
3917
		$options = ( ( $flags & self::READ_LOCKING ) == self::READ_LOCKING )
3918
			? [ 'LOCK IN SHARE MODE' ]
3919
			: [];
3920
3921
		$id = $db->selectField( 'user',
3922
			'user_id', [ 'user_name' => $s ], __METHOD__, $options );
3923
3924
		return (int)$id;
3925
	}
3926
3927
	/**
3928
	 * Add a user to the database, return the user object
3929
	 *
3930
	 * @param string $name Username to add
3931
	 * @param array $params Array of Strings Non-default parameters to save to
3932
	 *   the database as user_* fields:
3933
	 *   - email: The user's email address.
3934
	 *   - email_authenticated: The email authentication timestamp.
3935
	 *   - real_name: The user's real name.
3936
	 *   - options: An associative array of non-default options.
3937
	 *   - token: Random authentication token. Do not set.
3938
	 *   - registration: Registration timestamp. Do not set.
3939
	 *
3940
	 * @return User|null User object, or null if the username already exists.
3941
	 */
3942
	public static function createNew( $name, $params = [] ) {
3943
		foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
3944
			if ( isset( $params[$field] ) ) {
3945
				wfDeprecated( __METHOD__ . " with param '$field'", '1.27' );
3946
				unset( $params[$field] );
3947
			}
3948
		}
3949
3950
		$user = new User;
3951
		$user->load();
3952
		$user->setToken(); // init token
3953
		if ( isset( $params['options'] ) ) {
3954
			$user->mOptions = $params['options'] + (array)$user->mOptions;
3955
			unset( $params['options'] );
3956
		}
3957
		$dbw = wfGetDB( DB_MASTER );
3958
		$seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3959
3960
		$noPass = PasswordFactory::newInvalidPassword()->toString();
3961
3962
		$fields = [
3963
			'user_id' => $seqVal,
3964
			'user_name' => $name,
3965
			'user_password' => $noPass,
3966
			'user_newpassword' => $noPass,
3967
			'user_email' => $user->mEmail,
3968
			'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated ),
3969
			'user_real_name' => $user->mRealName,
3970
			'user_token' => strval( $user->mToken ),
3971
			'user_registration' => $dbw->timestamp( $user->mRegistration ),
3972
			'user_editcount' => 0,
3973
			'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
3974
		];
3975
		foreach ( $params as $name => $value ) {
3976
			$fields["user_$name"] = $value;
3977
		}
3978
		$dbw->insert( 'user', $fields, __METHOD__, [ 'IGNORE' ] );
3979
		if ( $dbw->affectedRows() ) {
3980
			$newUser = User::newFromId( $dbw->insertId() );
3981
		} else {
3982
			$newUser = null;
3983
		}
3984
		return $newUser;
3985
	}
3986
3987
	/**
3988
	 * Add this existing user object to the database. If the user already
3989
	 * exists, a fatal status object is returned, and the user object is
3990
	 * initialised with the data from the database.
3991
	 *
3992
	 * Previously, this function generated a DB error due to a key conflict
3993
	 * if the user already existed. Many extension callers use this function
3994
	 * in code along the lines of:
3995
	 *
3996
	 *   $user = User::newFromName( $name );
3997
	 *   if ( !$user->isLoggedIn() ) {
3998
	 *       $user->addToDatabase();
3999
	 *   }
4000
	 *   // do something with $user...
4001
	 *
4002
	 * However, this was vulnerable to a race condition (bug 16020). By
4003
	 * initialising the user object if the user exists, we aim to support this
4004
	 * calling sequence as far as possible.
4005
	 *
4006
	 * Note that if the user exists, this function will acquire a write lock,
4007
	 * so it is still advisable to make the call conditional on isLoggedIn(),
4008
	 * and to commit the transaction after calling.
4009
	 *
4010
	 * @throws MWException
4011
	 * @return Status
4012
	 */
4013
	public function addToDatabase() {
4014
		$this->load();
4015
		if ( !$this->mToken ) {
4016
			$this->setToken(); // init token
4017
		}
4018
4019
		$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...
4020
4021
		$noPass = PasswordFactory::newInvalidPassword()->toString();
4022
4023
		$dbw = wfGetDB( DB_MASTER );
4024
		$seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
4025
		$dbw->insert( 'user',
4026
			[
4027
				'user_id' => $seqVal,
4028
				'user_name' => $this->mName,
4029
				'user_password' => $noPass,
4030
				'user_newpassword' => $noPass,
4031
				'user_email' => $this->mEmail,
4032
				'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
4033
				'user_real_name' => $this->mRealName,
4034
				'user_token' => strval( $this->mToken ),
4035
				'user_registration' => $dbw->timestamp( $this->mRegistration ),
4036
				'user_editcount' => 0,
4037
				'user_touched' => $dbw->timestamp( $this->mTouched ),
4038
			], __METHOD__,
4039
			[ 'IGNORE' ]
4040
		);
4041
		if ( !$dbw->affectedRows() ) {
4042
			// Use locking reads to bypass any REPEATABLE-READ snapshot.
4043
			$this->mId = $dbw->selectField(
4044
				'user',
4045
				'user_id',
4046
				[ 'user_name' => $this->mName ],
4047
				__METHOD__,
4048
				[ 'LOCK IN SHARE MODE' ]
4049
			);
4050
			$loaded = false;
4051
			if ( $this->mId ) {
4052
				if ( $this->loadFromDatabase( self::READ_LOCKING ) ) {
4053
					$loaded = true;
4054
				}
4055
			}
4056
			if ( !$loaded ) {
4057
				throw new MWException( __METHOD__ . ": hit a key conflict attempting " .
4058
					"to insert user '{$this->mName}' row, but it was not present in select!" );
4059
			}
4060
			return Status::newFatal( 'userexists' );
4061
		}
4062
		$this->mId = $dbw->insertId();
4063
		self::$idCacheByName[$this->mName] = $this->mId;
4064
4065
		// Clear instance cache other than user table data, which is already accurate
4066
		$this->clearInstanceCache();
4067
4068
		$this->saveOptions();
4069
		return Status::newGood();
4070
	}
4071
4072
	/**
4073
	 * If this user is logged-in and blocked,
4074
	 * block any IP address they've successfully logged in from.
4075
	 * @return bool A block was spread
4076
	 */
4077
	public function spreadAnyEditBlock() {
4078
		if ( $this->isLoggedIn() && $this->isBlocked() ) {
4079
			return $this->spreadBlock();
4080
		}
4081
4082
		return false;
4083
	}
4084
4085
	/**
4086
	 * If this (non-anonymous) user is blocked,
4087
	 * block the IP address they've successfully logged in from.
4088
	 * @return bool A block was spread
4089
	 */
4090
	protected function spreadBlock() {
4091
		wfDebug( __METHOD__ . "()\n" );
4092
		$this->load();
4093
		if ( $this->mId == 0 ) {
4094
			return false;
4095
		}
4096
4097
		$userblock = Block::newFromTarget( $this->getName() );
4098
		if ( !$userblock ) {
4099
			return false;
4100
		}
4101
4102
		return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
4103
	}
4104
4105
	/**
4106
	 * Get whether the user is explicitly blocked from account creation.
4107
	 * @return bool|Block
4108
	 */
4109
	public function isBlockedFromCreateAccount() {
4110
		$this->getBlockedStatus();
4111
		if ( $this->mBlock && $this->mBlock->prevents( 'createaccount' ) ) {
4112
			return $this->mBlock;
4113
		}
4114
4115
		# bug 13611: if the IP address the user is trying to create an account from is
4116
		# blocked with createaccount disabled, prevent new account creation there even
4117
		# when the user is logged in
4118
		if ( $this->mBlockedFromCreateAccount === false && !$this->isAllowed( 'ipblock-exempt' ) ) {
4119
			$this->mBlockedFromCreateAccount = Block::newFromTarget( null, $this->getRequest()->getIP() );
4120
		}
4121
		return $this->mBlockedFromCreateAccount instanceof Block
4122
			&& $this->mBlockedFromCreateAccount->prevents( 'createaccount' )
4123
			? $this->mBlockedFromCreateAccount
4124
			: false;
4125
	}
4126
4127
	/**
4128
	 * Get whether the user is blocked from using Special:Emailuser.
4129
	 * @return bool
4130
	 */
4131
	public function isBlockedFromEmailuser() {
4132
		$this->getBlockedStatus();
4133
		return $this->mBlock && $this->mBlock->prevents( 'sendemail' );
4134
	}
4135
4136
	/**
4137
	 * Get whether the user is allowed to create an account.
4138
	 * @return bool
4139
	 */
4140
	public function isAllowedToCreateAccount() {
4141
		return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
4142
	}
4143
4144
	/**
4145
	 * Get this user's personal page title.
4146
	 *
4147
	 * @return Title User's personal page title
4148
	 */
4149
	public function getUserPage() {
4150
		return Title::makeTitle( NS_USER, $this->getName() );
4151
	}
4152
4153
	/**
4154
	 * Get this user's talk page title.
4155
	 *
4156
	 * @return Title User's talk page title
4157
	 */
4158
	public function getTalkPage() {
4159
		$title = $this->getUserPage();
4160
		return $title->getTalkPage();
4161
	}
4162
4163
	/**
4164
	 * Determine whether the user is a newbie. Newbies are either
4165
	 * anonymous IPs, or the most recently created accounts.
4166
	 * @return bool
4167
	 */
4168
	public function isNewbie() {
4169
		return !$this->isAllowed( 'autoconfirmed' );
4170
	}
4171
4172
	/**
4173
	 * Check to see if the given clear-text password is one of the accepted passwords
4174
	 * @deprecated since 1.27, use AuthManager instead
4175
	 * @param string $password User password
4176
	 * @return bool True if the given password is correct, otherwise False
4177
	 */
4178
	public function checkPassword( $password ) {
4179
		$manager = AuthManager::singleton();
4180
		$reqs = AuthenticationRequest::loadRequestsFromSubmission(
4181
			$manager->getAuthenticationRequests( AuthManager::ACTION_LOGIN ),
4182
			[
4183
				'username' => $this->getName(),
4184
				'password' => $password,
4185
			]
4186
		);
4187
		$res = AuthManager::singleton()->beginAuthentication( $reqs, 'null:' );
4188
		switch ( $res->status ) {
4189
			case AuthenticationResponse::PASS:
4190
				return true;
4191
			case AuthenticationResponse::FAIL:
4192
				// Hope it's not a PreAuthenticationProvider that failed...
4193
				\MediaWiki\Logger\LoggerFactory::getInstance( 'authentication' )
4194
					->info( __METHOD__ . ': Authentication failed: ' . $res->message->plain() );
4195
				return false;
4196
			default:
4197
				throw new BadMethodCallException(
4198
					'AuthManager returned a response unsupported by ' . __METHOD__
4199
				);
4200
		}
4201
	}
4202
4203
	/**
4204
	 * Check if the given clear-text password matches the temporary password
4205
	 * sent by e-mail for password reset operations.
4206
	 *
4207
	 * @deprecated since 1.27, use AuthManager instead
4208
	 * @param string $plaintext
4209
	 * @return bool True if matches, false otherwise
4210
	 */
4211
	public function checkTemporaryPassword( $plaintext ) {
4212
		// Can't check the temporary password individually.
4213
		return $this->checkPassword( $plaintext );
4214
	}
4215
4216
	/**
4217
	 * Initialize (if necessary) and return a session token value
4218
	 * which can be used in edit forms to show that the user's
4219
	 * login credentials aren't being hijacked with a foreign form
4220
	 * submission.
4221
	 *
4222
	 * @since 1.27
4223
	 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4224
	 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4225
	 * @return MediaWiki\Session\Token The new edit token
4226
	 */
4227
	public function getEditTokenObject( $salt = '', $request = null ) {
4228
		if ( $this->isAnon() ) {
4229
			return new LoggedOutEditToken();
4230
		}
4231
4232
		if ( !$request ) {
4233
			$request = $this->getRequest();
4234
		}
4235
		return $request->getSession()->getToken( $salt );
0 ignored issues
show
Bug introduced by
It seems like $salt defined by parameter $salt on line 4227 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...
4236
	}
4237
4238
	/**
4239
	 * Initialize (if necessary) and return a session token value
4240
	 * which can be used in edit forms to show that the user's
4241
	 * login credentials aren't being hijacked with a foreign form
4242
	 * submission.
4243
	 *
4244
	 * The $salt for 'edit' and 'csrf' tokens is the default (empty string).
4245
	 *
4246
	 * @since 1.19
4247
	 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4248
	 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4249
	 * @return string The new edit token
4250
	 */
4251
	public function getEditToken( $salt = '', $request = null ) {
4252
		return $this->getEditTokenObject( $salt, $request )->toString();
4253
	}
4254
4255
	/**
4256
	 * Get the embedded timestamp from a token.
4257
	 * @deprecated since 1.27, use \MediaWiki\Session\Token::getTimestamp instead.
4258
	 * @param string $val Input token
4259
	 * @return int|null
4260
	 */
4261
	public static function getEditTokenTimestamp( $val ) {
4262
		wfDeprecated( __METHOD__, '1.27' );
4263
		return MediaWiki\Session\Token::getTimestamp( $val );
4264
	}
4265
4266
	/**
4267
	 * Check given value against the token value stored in the session.
4268
	 * A match should confirm that the form was submitted from the
4269
	 * user's own login session, not a form submission from a third-party
4270
	 * site.
4271
	 *
4272
	 * @param string $val Input value to compare
4273
	 * @param string $salt Optional function-specific data for hashing
4274
	 * @param WebRequest|null $request Object to use or null to use $wgRequest
4275
	 * @param int $maxage Fail tokens older than this, in seconds
4276
	 * @return bool Whether the token matches
4277
	 */
4278
	public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4279
		return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
4280
	}
4281
4282
	/**
4283
	 * Check given value against the token value stored in the session,
4284
	 * ignoring the suffix.
4285
	 *
4286
	 * @param string $val Input value to compare
4287
	 * @param string $salt Optional function-specific data for hashing
4288
	 * @param WebRequest|null $request Object to use or null to use $wgRequest
4289
	 * @param int $maxage Fail tokens older than this, in seconds
4290
	 * @return bool Whether the token matches
4291
	 */
4292
	public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4293
		$val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token::SUFFIX;
4294
		return $this->matchEditToken( $val, $salt, $request, $maxage );
4295
	}
4296
4297
	/**
4298
	 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4299
	 * mail to the user's given address.
4300
	 *
4301
	 * @param string $type Message to send, either "created", "changed" or "set"
4302
	 * @return Status
4303
	 */
4304
	public function sendConfirmationMail( $type = 'created' ) {
4305
		global $wgLang;
4306
		$expiration = null; // gets passed-by-ref and defined in next line.
4307
		$token = $this->confirmationToken( $expiration );
4308
		$url = $this->confirmationTokenUrl( $token );
4309
		$invalidateURL = $this->invalidationTokenUrl( $token );
4310
		$this->saveSettings();
4311
4312
		if ( $type == 'created' || $type === false ) {
4313
			$message = 'confirmemail_body';
4314
		} elseif ( $type === true ) {
4315
			$message = 'confirmemail_body_changed';
4316
		} else {
4317
			// Messages: confirmemail_body_changed, confirmemail_body_set
4318
			$message = 'confirmemail_body_' . $type;
4319
		}
4320
4321
		return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
4322
			wfMessage( $message,
4323
				$this->getRequest()->getIP(),
4324
				$this->getName(),
4325
				$url,
4326
				$wgLang->userTimeAndDate( $expiration, $this ),
4327
				$invalidateURL,
4328
				$wgLang->userDate( $expiration, $this ),
4329
				$wgLang->userTime( $expiration, $this ) )->text() );
4330
	}
4331
4332
	/**
4333
	 * Send an e-mail to this user's account. Does not check for
4334
	 * confirmed status or validity.
4335
	 *
4336
	 * @param string $subject Message subject
4337
	 * @param string $body Message body
4338
	 * @param User|null $from Optional sending user; if unspecified, default
4339
	 *   $wgPasswordSender will be used.
4340
	 * @param string $replyto Reply-To address
4341
	 * @return Status
4342
	 */
4343
	public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4344
		global $wgPasswordSender;
4345
4346
		if ( $from instanceof User ) {
4347
			$sender = MailAddress::newFromUser( $from );
4348
		} else {
4349
			$sender = new MailAddress( $wgPasswordSender,
4350
				wfMessage( 'emailsender' )->inContentLanguage()->text() );
4351
		}
4352
		$to = MailAddress::newFromUser( $this );
4353
4354
		return UserMailer::send( $to, $sender, $subject, $body, [
4355
			'replyTo' => $replyto,
4356
		] );
4357
	}
4358
4359
	/**
4360
	 * Generate, store, and return a new e-mail confirmation code.
4361
	 * A hash (unsalted, since it's used as a key) is stored.
4362
	 *
4363
	 * @note Call saveSettings() after calling this function to commit
4364
	 * this change to the database.
4365
	 *
4366
	 * @param string &$expiration Accepts the expiration time
4367
	 * @return string New token
4368
	 */
4369
	protected function confirmationToken( &$expiration ) {
4370
		global $wgUserEmailConfirmationTokenExpiry;
4371
		$now = time();
4372
		$expires = $now + $wgUserEmailConfirmationTokenExpiry;
4373
		$expiration = wfTimestamp( TS_MW, $expires );
4374
		$this->load();
4375
		$token = MWCryptRand::generateHex( 32 );
4376
		$hash = md5( $token );
4377
		$this->mEmailToken = $hash;
4378
		$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...
4379
		return $token;
4380
	}
4381
4382
	/**
4383
	 * Return a URL the user can use to confirm their email address.
4384
	 * @param string $token Accepts the email confirmation token
4385
	 * @return string New token URL
4386
	 */
4387
	protected function confirmationTokenUrl( $token ) {
4388
		return $this->getTokenUrl( 'ConfirmEmail', $token );
4389
	}
4390
4391
	/**
4392
	 * Return a URL the user can use to invalidate their email address.
4393
	 * @param string $token Accepts the email confirmation token
4394
	 * @return string New token URL
4395
	 */
4396
	protected function invalidationTokenUrl( $token ) {
4397
		return $this->getTokenUrl( 'InvalidateEmail', $token );
4398
	}
4399
4400
	/**
4401
	 * Internal function to format the e-mail validation/invalidation URLs.
4402
	 * This uses a quickie hack to use the
4403
	 * hardcoded English names of the Special: pages, for ASCII safety.
4404
	 *
4405
	 * @note Since these URLs get dropped directly into emails, using the
4406
	 * short English names avoids insanely long URL-encoded links, which
4407
	 * also sometimes can get corrupted in some browsers/mailers
4408
	 * (bug 6957 with Gmail and Internet Explorer).
4409
	 *
4410
	 * @param string $page Special page
4411
	 * @param string $token Token
4412
	 * @return string Formatted URL
4413
	 */
4414
	protected function getTokenUrl( $page, $token ) {
4415
		// Hack to bypass localization of 'Special:'
4416
		$title = Title::makeTitle( NS_MAIN, "Special:$page/$token" );
4417
		return $title->getCanonicalURL();
4418
	}
4419
4420
	/**
4421
	 * Mark the e-mail address confirmed.
4422
	 *
4423
	 * @note Call saveSettings() after calling this function to commit the change.
4424
	 *
4425
	 * @return bool
4426
	 */
4427
	public function confirmEmail() {
4428
		// Check if it's already confirmed, so we don't touch the database
4429
		// and fire the ConfirmEmailComplete hook on redundant confirmations.
4430
		if ( !$this->isEmailConfirmed() ) {
4431
			$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...
4432
			Hooks::run( 'ConfirmEmailComplete', [ $this ] );
4433
		}
4434
		return true;
4435
	}
4436
4437
	/**
4438
	 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4439
	 * address if it was already confirmed.
4440
	 *
4441
	 * @note Call saveSettings() after calling this function to commit the change.
4442
	 * @return bool Returns true
4443
	 */
4444
	public function invalidateEmail() {
4445
		$this->load();
4446
		$this->mEmailToken = null;
4447
		$this->mEmailTokenExpires = null;
4448
		$this->setEmailAuthenticationTimestamp( null );
4449
		$this->mEmail = '';
4450
		Hooks::run( 'InvalidateEmailComplete', [ $this ] );
4451
		return true;
4452
	}
4453
4454
	/**
4455
	 * Set the e-mail authentication timestamp.
4456
	 * @param string $timestamp TS_MW timestamp
4457
	 */
4458
	public function setEmailAuthenticationTimestamp( $timestamp ) {
4459
		$this->load();
4460
		$this->mEmailAuthenticated = $timestamp;
4461
		Hooks::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated ] );
4462
	}
4463
4464
	/**
4465
	 * Is this user allowed to send e-mails within limits of current
4466
	 * site configuration?
4467
	 * @return bool
4468
	 */
4469
	public function canSendEmail() {
4470
		global $wgEnableEmail, $wgEnableUserEmail;
4471
		if ( !$wgEnableEmail || !$wgEnableUserEmail || !$this->isAllowed( 'sendemail' ) ) {
4472
			return false;
4473
		}
4474
		$canSend = $this->isEmailConfirmed();
4475
		Hooks::run( 'UserCanSendEmail', [ &$this, &$canSend ] );
4476
		return $canSend;
4477
	}
4478
4479
	/**
4480
	 * Is this user allowed to receive e-mails within limits of current
4481
	 * site configuration?
4482
	 * @return bool
4483
	 */
4484
	public function canReceiveEmail() {
4485
		return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4486
	}
4487
4488
	/**
4489
	 * Is this user's e-mail address valid-looking and confirmed within
4490
	 * limits of the current site configuration?
4491
	 *
4492
	 * @note If $wgEmailAuthentication is on, this may require the user to have
4493
	 * confirmed their address by returning a code or using a password
4494
	 * sent to the address from the wiki.
4495
	 *
4496
	 * @return bool
4497
	 */
4498
	public function isEmailConfirmed() {
4499
		global $wgEmailAuthentication;
4500
		$this->load();
4501
		$confirmed = true;
4502
		if ( Hooks::run( 'EmailConfirmed', [ &$this, &$confirmed ] ) ) {
4503
			if ( $this->isAnon() ) {
4504
				return false;
4505
			}
4506
			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...
4507
				return false;
4508
			}
4509
			if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4510
				return false;
4511
			}
4512
			return true;
4513
		} else {
4514
			return $confirmed;
4515
		}
4516
	}
4517
4518
	/**
4519
	 * Check whether there is an outstanding request for e-mail confirmation.
4520
	 * @return bool
4521
	 */
4522
	public function isEmailConfirmationPending() {
4523
		global $wgEmailAuthentication;
4524
		return $wgEmailAuthentication &&
4525
			!$this->isEmailConfirmed() &&
4526
			$this->mEmailToken &&
4527
			$this->mEmailTokenExpires > wfTimestamp();
4528
	}
4529
4530
	/**
4531
	 * Get the timestamp of account creation.
4532
	 *
4533
	 * @return string|bool|null Timestamp of account creation, false for
4534
	 *  non-existent/anonymous user accounts, or null if existing account
4535
	 *  but information is not in database.
4536
	 */
4537
	public function getRegistration() {
4538
		if ( $this->isAnon() ) {
4539
			return false;
4540
		}
4541
		$this->load();
4542
		return $this->mRegistration;
4543
	}
4544
4545
	/**
4546
	 * Get the timestamp of the first edit
4547
	 *
4548
	 * @return string|bool Timestamp of first edit, or false for
4549
	 *  non-existent/anonymous user accounts.
4550
	 */
4551
	public function getFirstEditTimestamp() {
4552
		if ( $this->getId() == 0 ) {
4553
			return false; // anons
4554
		}
4555
		$dbr = wfGetDB( DB_REPLICA );
4556
		$time = $dbr->selectField( 'revision', 'rev_timestamp',
4557
			[ 'rev_user' => $this->getId() ],
4558
			__METHOD__,
4559
			[ 'ORDER BY' => 'rev_timestamp ASC' ]
4560
		);
4561
		if ( !$time ) {
4562
			return false; // no edits
4563
		}
4564
		return wfTimestamp( TS_MW, $time );
4565
	}
4566
4567
	/**
4568
	 * Get the permissions associated with a given list of groups
4569
	 *
4570
	 * @param array $groups Array of Strings List of internal group names
4571
	 * @return array Array of Strings List of permission key names for given groups combined
4572
	 */
4573
	public static function getGroupPermissions( $groups ) {
4574
		global $wgGroupPermissions, $wgRevokePermissions;
4575
		$rights = [];
4576
		// grant every granted permission first
4577
		foreach ( $groups as $group ) {
4578
			if ( isset( $wgGroupPermissions[$group] ) ) {
4579
				$rights = array_merge( $rights,
4580
					// array_filter removes empty items
4581
					array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
4582
			}
4583
		}
4584
		// now revoke the revoked permissions
4585
		foreach ( $groups as $group ) {
4586
			if ( isset( $wgRevokePermissions[$group] ) ) {
4587
				$rights = array_diff( $rights,
4588
					array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
4589
			}
4590
		}
4591
		return array_unique( $rights );
4592
	}
4593
4594
	/**
4595
	 * Get all the groups who have a given permission
4596
	 *
4597
	 * @param string $role Role to check
4598
	 * @return array Array of Strings List of internal group names with the given permission
4599
	 */
4600
	public static function getGroupsWithPermission( $role ) {
4601
		global $wgGroupPermissions;
4602
		$allowedGroups = [];
4603
		foreach ( array_keys( $wgGroupPermissions ) as $group ) {
4604
			if ( self::groupHasPermission( $group, $role ) ) {
4605
				$allowedGroups[] = $group;
4606
			}
4607
		}
4608
		return $allowedGroups;
4609
	}
4610
4611
	/**
4612
	 * Check, if the given group has the given permission
4613
	 *
4614
	 * If you're wanting to check whether all users have a permission, use
4615
	 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
4616
	 * from anyone.
4617
	 *
4618
	 * @since 1.21
4619
	 * @param string $group Group to check
4620
	 * @param string $role Role to check
4621
	 * @return bool
4622
	 */
4623
	public static function groupHasPermission( $group, $role ) {
4624
		global $wgGroupPermissions, $wgRevokePermissions;
4625
		return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
4626
			&& !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
4627
	}
4628
4629
	/**
4630
	 * Check if all users may be assumed to have the given permission
4631
	 *
4632
	 * We generally assume so if the right is granted to '*' and isn't revoked
4633
	 * on any group. It doesn't attempt to take grants or other extension
4634
	 * limitations on rights into account in the general case, though, as that
4635
	 * would require it to always return false and defeat the purpose.
4636
	 * Specifically, session-based rights restrictions (such as OAuth or bot
4637
	 * passwords) are applied based on the current session.
4638
	 *
4639
	 * @since 1.22
4640
	 * @param string $right Right to check
4641
	 * @return bool
4642
	 */
4643
	public static function isEveryoneAllowed( $right ) {
4644
		global $wgGroupPermissions, $wgRevokePermissions;
4645
		static $cache = [];
4646
4647
		// Use the cached results, except in unit tests which rely on
4648
		// being able change the permission mid-request
4649
		if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
4650
			return $cache[$right];
4651
		}
4652
4653
		if ( !isset( $wgGroupPermissions['*'][$right] ) || !$wgGroupPermissions['*'][$right] ) {
4654
			$cache[$right] = false;
4655
			return false;
4656
		}
4657
4658
		// If it's revoked anywhere, then everyone doesn't have it
4659
		foreach ( $wgRevokePermissions as $rights ) {
4660
			if ( isset( $rights[$right] ) && $rights[$right] ) {
4661
				$cache[$right] = false;
4662
				return false;
4663
			}
4664
		}
4665
4666
		// Remove any rights that aren't allowed to the global-session user,
4667
		// unless there are no sessions for this endpoint.
4668
		if ( !defined( 'MW_NO_SESSION' ) ) {
4669
			$allowedRights = SessionManager::getGlobalSession()->getAllowedUserRights();
4670
			if ( $allowedRights !== null && !in_array( $right, $allowedRights, true ) ) {
4671
				$cache[$right] = false;
4672
				return false;
4673
			}
4674
		}
4675
4676
		// Allow extensions to say false
4677
		if ( !Hooks::run( 'UserIsEveryoneAllowed', [ $right ] ) ) {
4678
			$cache[$right] = false;
4679
			return false;
4680
		}
4681
4682
		$cache[$right] = true;
4683
		return true;
4684
	}
4685
4686
	/**
4687
	 * Get the localized descriptive name for a group, if it exists
4688
	 *
4689
	 * @param string $group Internal group name
4690
	 * @return string Localized descriptive group name
4691
	 */
4692
	public static function getGroupName( $group ) {
4693
		$msg = wfMessage( "group-$group" );
4694
		return $msg->isBlank() ? $group : $msg->text();
4695
	}
4696
4697
	/**
4698
	 * Get the localized descriptive name for a member of a group, if it exists
4699
	 *
4700
	 * @param string $group Internal group name
4701
	 * @param string $username Username for gender (since 1.19)
4702
	 * @return string Localized name for group member
4703
	 */
4704
	public static function getGroupMember( $group, $username = '#' ) {
4705
		$msg = wfMessage( "group-$group-member", $username );
4706
		return $msg->isBlank() ? $group : $msg->text();
4707
	}
4708
4709
	/**
4710
	 * Return the set of defined explicit groups.
4711
	 * The implicit groups (by default *, 'user' and 'autoconfirmed')
4712
	 * are not included, as they are defined automatically, not in the database.
4713
	 * @return array Array of internal group names
4714
	 */
4715
	public static function getAllGroups() {
4716
		global $wgGroupPermissions, $wgRevokePermissions;
4717
		return array_diff(
4718
			array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
4719
			self::getImplicitGroups()
4720
		);
4721
	}
4722
4723
	/**
4724
	 * Get a list of all available permissions.
4725
	 * @return string[] Array of permission names
4726
	 */
4727
	public static function getAllRights() {
4728
		if ( self::$mAllRights === false ) {
4729
			global $wgAvailableRights;
4730
			if ( count( $wgAvailableRights ) ) {
4731
				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...
4732
			} else {
4733
				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...
4734
			}
4735
			Hooks::run( 'UserGetAllRights', [ &self::$mAllRights ] );
4736
		}
4737
		return self::$mAllRights;
4738
	}
4739
4740
	/**
4741
	 * Get a list of implicit groups
4742
	 * @return array Array of Strings Array of internal group names
4743
	 */
4744
	public static function getImplicitGroups() {
4745
		global $wgImplicitGroups;
4746
4747
		$groups = $wgImplicitGroups;
4748
		# Deprecated, use $wgImplicitGroups instead
4749
		Hooks::run( 'UserGetImplicitGroups', [ &$groups ], '1.25' );
4750
4751
		return $groups;
4752
	}
4753
4754
	/**
4755
	 * Get the title of a page describing a particular group
4756
	 *
4757
	 * @param string $group Internal group name
4758
	 * @return Title|bool Title of the page if it exists, false otherwise
4759
	 */
4760
	public static function getGroupPage( $group ) {
4761
		$msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
4762
		if ( $msg->exists() ) {
4763
			$title = Title::newFromText( $msg->text() );
4764
			if ( is_object( $title ) ) {
4765
				return $title;
4766
			}
4767
		}
4768
		return false;
4769
	}
4770
4771
	/**
4772
	 * Create a link to the group in HTML, if available;
4773
	 * else return the group name.
4774
	 *
4775
	 * @param string $group Internal name of the group
4776
	 * @param string $text The text of the link
4777
	 * @return string HTML link to the group
4778
	 */
4779
	public static function makeGroupLinkHTML( $group, $text = '' ) {
4780
		if ( $text == '' ) {
4781
			$text = self::getGroupName( $group );
4782
		}
4783
		$title = self::getGroupPage( $group );
4784
		if ( $title ) {
4785
			return Linker::link( $title, htmlspecialchars( $text ) );
4786
		} else {
4787
			return htmlspecialchars( $text );
4788
		}
4789
	}
4790
4791
	/**
4792
	 * Create a link to the group in Wikitext, if available;
4793
	 * else return the group name.
4794
	 *
4795
	 * @param string $group Internal name of the group
4796
	 * @param string $text The text of the link
4797
	 * @return string Wikilink to the group
4798
	 */
4799
	public static function makeGroupLinkWiki( $group, $text = '' ) {
4800
		if ( $text == '' ) {
4801
			$text = self::getGroupName( $group );
4802
		}
4803
		$title = self::getGroupPage( $group );
4804
		if ( $title ) {
4805
			$page = $title->getFullText();
4806
			return "[[$page|$text]]";
4807
		} else {
4808
			return $text;
4809
		}
4810
	}
4811
4812
	/**
4813
	 * Returns an array of the groups that a particular group can add/remove.
4814
	 *
4815
	 * @param string $group The group to check for whether it can add/remove
4816
	 * @return array Array( 'add' => array( addablegroups ),
4817
	 *     'remove' => array( removablegroups ),
4818
	 *     'add-self' => array( addablegroups to self),
4819
	 *     'remove-self' => array( removable groups from self) )
4820
	 */
4821
	public static function changeableByGroup( $group ) {
4822
		global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
4823
4824
		$groups = [
4825
			'add' => [],
4826
			'remove' => [],
4827
			'add-self' => [],
4828
			'remove-self' => []
4829
		];
4830
4831 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...
4832
			// Don't add anything to $groups
4833
		} elseif ( $wgAddGroups[$group] === true ) {
4834
			// You get everything
4835
			$groups['add'] = self::getAllGroups();
4836
		} elseif ( is_array( $wgAddGroups[$group] ) ) {
4837
			$groups['add'] = $wgAddGroups[$group];
4838
		}
4839
4840
		// Same thing for remove
4841 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...
4842
			// Do nothing
4843
		} elseif ( $wgRemoveGroups[$group] === true ) {
4844
			$groups['remove'] = self::getAllGroups();
4845
		} elseif ( is_array( $wgRemoveGroups[$group] ) ) {
4846
			$groups['remove'] = $wgRemoveGroups[$group];
4847
		}
4848
4849
		// Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
4850 View Code Duplication
		if ( empty( $wgGroupsAddToSelf['user'] ) || $wgGroupsAddToSelf['user'] !== true ) {
4851
			foreach ( $wgGroupsAddToSelf as $key => $value ) {
4852
				if ( is_int( $key ) ) {
4853
					$wgGroupsAddToSelf['user'][] = $value;
4854
				}
4855
			}
4856
		}
4857
4858 View Code Duplication
		if ( empty( $wgGroupsRemoveFromSelf['user'] ) || $wgGroupsRemoveFromSelf['user'] !== true ) {
4859
			foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
4860
				if ( is_int( $key ) ) {
4861
					$wgGroupsRemoveFromSelf['user'][] = $value;
4862
				}
4863
			}
4864
		}
4865
4866
		// Now figure out what groups the user can add to him/herself
4867 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...
4868
			// Do nothing
4869
		} elseif ( $wgGroupsAddToSelf[$group] === true ) {
4870
			// No idea WHY this would be used, but it's there
4871
			$groups['add-self'] = User::getAllGroups();
4872
		} elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
4873
			$groups['add-self'] = $wgGroupsAddToSelf[$group];
4874
		}
4875
4876 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...
4877
			// Do nothing
4878
		} elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
4879
			$groups['remove-self'] = User::getAllGroups();
4880
		} elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
4881
			$groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
4882
		}
4883
4884
		return $groups;
4885
	}
4886
4887
	/**
4888
	 * Returns an array of groups that this user can add and remove
4889
	 * @return array Array( 'add' => array( addablegroups ),
4890
	 *  'remove' => array( removablegroups ),
4891
	 *  'add-self' => array( addablegroups to self),
4892
	 *  'remove-self' => array( removable groups from self) )
4893
	 */
4894
	public function changeableGroups() {
4895
		if ( $this->isAllowed( 'userrights' ) ) {
4896
			// This group gives the right to modify everything (reverse-
4897
			// compatibility with old "userrights lets you change
4898
			// everything")
4899
			// Using array_merge to make the groups reindexed
4900
			$all = array_merge( User::getAllGroups() );
4901
			return [
4902
				'add' => $all,
4903
				'remove' => $all,
4904
				'add-self' => [],
4905
				'remove-self' => []
4906
			];
4907
		}
4908
4909
		// Okay, it's not so simple, we will have to go through the arrays
4910
		$groups = [
4911
			'add' => [],
4912
			'remove' => [],
4913
			'add-self' => [],
4914
			'remove-self' => []
4915
		];
4916
		$addergroups = $this->getEffectiveGroups();
4917
4918
		foreach ( $addergroups as $addergroup ) {
4919
			$groups = array_merge_recursive(
4920
				$groups, $this->changeableByGroup( $addergroup )
4921
			);
4922
			$groups['add'] = array_unique( $groups['add'] );
4923
			$groups['remove'] = array_unique( $groups['remove'] );
4924
			$groups['add-self'] = array_unique( $groups['add-self'] );
4925
			$groups['remove-self'] = array_unique( $groups['remove-self'] );
4926
		}
4927
		return $groups;
4928
	}
4929
4930
	/**
4931
	 * Deferred version of incEditCountImmediate()
4932
	 */
4933
	public function incEditCount() {
4934
		wfGetDB( DB_MASTER )->onTransactionPreCommitOrIdle(
4935
			function () {
4936
				$this->incEditCountImmediate();
4937
			},
4938
			__METHOD__
4939
		);
4940
	}
4941
4942
	/**
4943
	 * Increment the user's edit-count field.
4944
	 * Will have no effect for anonymous users.
4945
	 * @since 1.26
4946
	 */
4947
	public function incEditCountImmediate() {
4948
		if ( $this->isAnon() ) {
4949
			return;
4950
		}
4951
4952
		$dbw = wfGetDB( DB_MASTER );
4953
		// No rows will be "affected" if user_editcount is NULL
4954
		$dbw->update(
4955
			'user',
4956
			[ 'user_editcount=user_editcount+1' ],
4957
			[ 'user_id' => $this->getId(), 'user_editcount IS NOT NULL' ],
4958
			__METHOD__
4959
		);
4960
		// Lazy initialization check...
4961
		if ( $dbw->affectedRows() == 0 ) {
4962
			// Now here's a goddamn hack...
4963
			$dbr = wfGetDB( DB_REPLICA );
4964
			if ( $dbr !== $dbw ) {
4965
				// If we actually have a replica DB server, the count is
4966
				// at least one behind because the current transaction
4967
				// has not been committed and replicated.
4968
				$this->mEditCount = $this->initEditCount( 1 );
4969
			} else {
4970
				// But if DB_REPLICA is selecting the master, then the
4971
				// count we just read includes the revision that was
4972
				// just added in the working transaction.
4973
				$this->mEditCount = $this->initEditCount();
4974
			}
4975
		} else {
4976
			if ( $this->mEditCount === null ) {
4977
				$this->getEditCount();
4978
				$dbr = wfGetDB( DB_REPLICA );
4979
				$this->mEditCount += ( $dbr !== $dbw ) ? 1 : 0;
4980
			} else {
4981
				$this->mEditCount++;
4982
			}
4983
		}
4984
		// Edit count in user cache too
4985
		$this->invalidateCache();
4986
	}
4987
4988
	/**
4989
	 * Initialize user_editcount from data out of the revision table
4990
	 *
4991
	 * @param int $add Edits to add to the count from the revision table
4992
	 * @return int Number of edits
4993
	 */
4994
	protected function initEditCount( $add = 0 ) {
4995
		// Pull from a replica DB to be less cruel to servers
4996
		// Accuracy isn't the point anyway here
4997
		$dbr = wfGetDB( DB_REPLICA );
4998
		$count = (int)$dbr->selectField(
4999
			'revision',
5000
			'COUNT(rev_user)',
5001
			[ 'rev_user' => $this->getId() ],
5002
			__METHOD__
5003
		);
5004
		$count = $count + $add;
5005
5006
		$dbw = wfGetDB( DB_MASTER );
5007
		$dbw->update(
5008
			'user',
5009
			[ 'user_editcount' => $count ],
5010
			[ 'user_id' => $this->getId() ],
5011
			__METHOD__
5012
		);
5013
5014
		return $count;
5015
	}
5016
5017
	/**
5018
	 * Get the description of a given right
5019
	 *
5020
	 * @param string $right Right to query
5021
	 * @return string Localized description of the right
5022
	 */
5023
	public static function getRightDescription( $right ) {
5024
		$key = "right-$right";
5025
		$msg = wfMessage( $key );
5026
		return $msg->isBlank() ? $right : $msg->text();
5027
	}
5028
5029
	/**
5030
	 * Make a new-style password hash
5031
	 *
5032
	 * @param string $password Plain-text password
5033
	 * @param bool|string $salt Optional salt, may be random or the user ID.
5034
	 *  If unspecified or false, will generate one automatically
5035
	 * @return string Password hash
5036
	 * @deprecated since 1.24, use Password class
5037
	 */
5038
	public static function crypt( $password, $salt = false ) {
5039
		wfDeprecated( __METHOD__, '1.24' );
5040
		$passwordFactory = new PasswordFactory();
5041
		$passwordFactory->init( RequestContext::getMain()->getConfig() );
5042
		$hash = $passwordFactory->newFromPlaintext( $password );
5043
		return $hash->toString();
5044
	}
5045
5046
	/**
5047
	 * Compare a password hash with a plain-text password. Requires the user
5048
	 * ID if there's a chance that the hash is an old-style hash.
5049
	 *
5050
	 * @param string $hash Password hash
5051
	 * @param string $password Plain-text password to compare
5052
	 * @param string|bool $userId User ID for old-style password salt
5053
	 *
5054
	 * @return bool
5055
	 * @deprecated since 1.24, use Password class
5056
	 */
5057
	public static function comparePasswords( $hash, $password, $userId = false ) {
5058
		wfDeprecated( __METHOD__, '1.24' );
5059
5060
		// Check for *really* old password hashes that don't even have a type
5061
		// The old hash format was just an md5 hex hash, with no type information
5062
		if ( preg_match( '/^[0-9a-f]{32}$/', $hash ) ) {
5063
			global $wgPasswordSalt;
5064
			if ( $wgPasswordSalt ) {
5065
				$password = ":B:{$userId}:{$hash}";
5066
			} else {
5067
				$password = ":A:{$hash}";
5068
			}
5069
		}
5070
5071
		$passwordFactory = new PasswordFactory();
5072
		$passwordFactory->init( RequestContext::getMain()->getConfig() );
5073
		$hash = $passwordFactory->newFromCiphertext( $hash );
5074
		return $hash->equals( $password );
5075
	}
5076
5077
	/**
5078
	 * Add a newuser log entry for this user.
5079
	 * Before 1.19 the return value was always true.
5080
	 *
5081
	 * @deprecated since 1.27, AuthManager handles logging
5082
	 * @param string|bool $action Account creation type.
5083
	 *   - String, one of the following values:
5084
	 *     - 'create' for an anonymous user creating an account for himself.
5085
	 *       This will force the action's performer to be the created user itself,
5086
	 *       no matter the value of $wgUser
5087
	 *     - 'create2' for a logged in user creating an account for someone else
5088
	 *     - 'byemail' when the created user will receive its password by e-mail
5089
	 *     - 'autocreate' when the user is automatically created (such as by CentralAuth).
5090
	 *   - Boolean means whether the account was created by e-mail (deprecated):
5091
	 *     - true will be converted to 'byemail'
5092
	 *     - false will be converted to 'create' if this object is the same as
5093
	 *       $wgUser and to 'create2' otherwise
5094
	 * @param string $reason User supplied reason
5095
	 * @return bool true
5096
	 */
5097
	public function addNewUserLogEntry( $action = false, $reason = '' ) {
5098
		return true; // disabled
5099
	}
5100
5101
	/**
5102
	 * Add an autocreate newuser log entry for this user
5103
	 * Used by things like CentralAuth and perhaps other authplugins.
5104
	 * Consider calling addNewUserLogEntry() directly instead.
5105
	 *
5106
	 * @deprecated since 1.27, AuthManager handles logging
5107
	 * @return bool
5108
	 */
5109
	public function addNewUserLogEntryAutoCreate() {
5110
		$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...
5111
5112
		return true;
5113
	}
5114
5115
	/**
5116
	 * Load the user options either from cache, the database or an array
5117
	 *
5118
	 * @param array $data Rows for the current user out of the user_properties table
5119
	 */
5120
	protected function loadOptions( $data = null ) {
5121
		global $wgContLang;
5122
5123
		$this->load();
5124
5125
		if ( $this->mOptionsLoaded ) {
5126
			return;
5127
		}
5128
5129
		$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...
5130
5131
		if ( !$this->getId() ) {
5132
			// For unlogged-in users, load language/variant options from request.
5133
			// There's no need to do it for logged-in users: they can set preferences,
5134
			// and handling of page content is done by $pageLang->getPreferredVariant() and such,
5135
			// so don't override user's choice (especially when the user chooses site default).
5136
			$variant = $wgContLang->getDefaultVariant();
5137
			$this->mOptions['variant'] = $variant;
5138
			$this->mOptions['language'] = $variant;
5139
			$this->mOptionsLoaded = true;
5140
			return;
5141
		}
5142
5143
		// Maybe load from the object
5144
		if ( !is_null( $this->mOptionOverrides ) ) {
5145
			wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5146
			foreach ( $this->mOptionOverrides as $key => $value ) {
5147
				$this->mOptions[$key] = $value;
5148
			}
5149
		} else {
5150
			if ( !is_array( $data ) ) {
5151
				wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5152
				// Load from database
5153
				$dbr = ( $this->queryFlagsUsed & self::READ_LATEST )
5154
					? wfGetDB( DB_MASTER )
5155
					: wfGetDB( DB_REPLICA );
5156
5157
				$res = $dbr->select(
5158
					'user_properties',
5159
					[ 'up_property', 'up_value' ],
5160
					[ 'up_user' => $this->getId() ],
5161
					__METHOD__
5162
				);
5163
5164
				$this->mOptionOverrides = [];
5165
				$data = [];
5166
				foreach ( $res as $row ) {
5167
					$data[$row->up_property] = $row->up_value;
5168
				}
5169
			}
5170
			foreach ( $data as $property => $value ) {
5171
				$this->mOptionOverrides[$property] = $value;
5172
				$this->mOptions[$property] = $value;
5173
			}
5174
		}
5175
5176
		$this->mOptionsLoaded = true;
5177
5178
		Hooks::run( 'UserLoadOptions', [ $this, &$this->mOptions ] );
5179
	}
5180
5181
	/**
5182
	 * Saves the non-default options for this user, as previously set e.g. via
5183
	 * setOption(), in the database's "user_properties" (preferences) table.
5184
	 * Usually used via saveSettings().
5185
	 */
5186
	protected function saveOptions() {
5187
		$this->loadOptions();
5188
5189
		// Not using getOptions(), to keep hidden preferences in database
5190
		$saveOptions = $this->mOptions;
5191
5192
		// Allow hooks to abort, for instance to save to a global profile.
5193
		// Reset options to default state before saving.
5194
		if ( !Hooks::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
5195
			return;
5196
		}
5197
5198
		$userId = $this->getId();
5199
5200
		$insert_rows = []; // all the new preference rows
5201
		foreach ( $saveOptions as $key => $value ) {
5202
			// Don't bother storing default values
5203
			$defaultOption = self::getDefaultOption( $key );
5204
			if ( ( $defaultOption === null && $value !== false && $value !== null )
5205
				|| $value != $defaultOption
5206
			) {
5207
				$insert_rows[] = [
5208
					'up_user' => $userId,
5209
					'up_property' => $key,
5210
					'up_value' => $value,
5211
				];
5212
			}
5213
		}
5214
5215
		$dbw = wfGetDB( DB_MASTER );
5216
5217
		$res = $dbw->select( 'user_properties',
5218
			[ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__ );
5219
5220
		// Find prior rows that need to be removed or updated. These rows will
5221
		// all be deleted (the latter so that INSERT IGNORE applies the new values).
5222
		$keysDelete = [];
5223
		foreach ( $res as $row ) {
5224
			if ( !isset( $saveOptions[$row->up_property] )
5225
				|| strcmp( $saveOptions[$row->up_property], $row->up_value ) != 0
5226
			) {
5227
				$keysDelete[] = $row->up_property;
5228
			}
5229
		}
5230
5231
		if ( count( $keysDelete ) ) {
5232
			// Do the DELETE by PRIMARY KEY for prior rows.
5233
			// In the past a very large portion of calls to this function are for setting
5234
			// 'rememberpassword' for new accounts (a preference that has since been removed).
5235
			// Doing a blanket per-user DELETE for new accounts with no rows in the table
5236
			// caused gap locks on [max user ID,+infinity) which caused high contention since
5237
			// updates would pile up on each other as they are for higher (newer) user IDs.
5238
			// It might not be necessary these days, but it shouldn't hurt either.
5239
			$dbw->delete( 'user_properties',
5240
				[ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__ );
5241
		}
5242
		// Insert the new preference rows
5243
		$dbw->insert( 'user_properties', $insert_rows, __METHOD__, [ 'IGNORE' ] );
5244
	}
5245
5246
	/**
5247
	 * Lazily instantiate and return a factory object for making passwords
5248
	 *
5249
	 * @deprecated since 1.27, create a PasswordFactory directly instead
5250
	 * @return PasswordFactory
5251
	 */
5252
	public static function getPasswordFactory() {
5253
		wfDeprecated( __METHOD__, '1.27' );
5254
		$ret = new PasswordFactory();
5255
		$ret->init( RequestContext::getMain()->getConfig() );
5256
		return $ret;
5257
	}
5258
5259
	/**
5260
	 * Provide an array of HTML5 attributes to put on an input element
5261
	 * intended for the user to enter a new password.  This may include
5262
	 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
5263
	 *
5264
	 * Do *not* use this when asking the user to enter his current password!
5265
	 * Regardless of configuration, users may have invalid passwords for whatever
5266
	 * reason (e.g., they were set before requirements were tightened up).
5267
	 * Only use it when asking for a new password, like on account creation or
5268
	 * ResetPass.
5269
	 *
5270
	 * Obviously, you still need to do server-side checking.
5271
	 *
5272
	 * NOTE: A combination of bugs in various browsers means that this function
5273
	 * actually just returns array() unconditionally at the moment.  May as
5274
	 * well keep it around for when the browser bugs get fixed, though.
5275
	 *
5276
	 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
5277
	 *
5278
	 * @deprecated since 1.27
5279
	 * @return array Array of HTML attributes suitable for feeding to
5280
	 *   Html::element(), directly or indirectly.  (Don't feed to Xml::*()!
5281
	 *   That will get confused by the boolean attribute syntax used.)
5282
	 */
5283
	public static function passwordChangeInputAttribs() {
5284
		global $wgMinimalPasswordLength;
5285
5286
		if ( $wgMinimalPasswordLength == 0 ) {
5287
			return [];
5288
		}
5289
5290
		# Note that the pattern requirement will always be satisfied if the
5291
		# input is empty, so we need required in all cases.
5292
5293
		# @todo FIXME: Bug 23769: This needs to not claim the password is required
5294
		# if e-mail confirmation is being used.  Since HTML5 input validation
5295
		# is b0rked anyway in some browsers, just return nothing.  When it's
5296
		# re-enabled, fix this code to not output required for e-mail
5297
		# registration.
5298
		# $ret = array( 'required' );
5299
		$ret = [];
5300
5301
		# We can't actually do this right now, because Opera 9.6 will print out
5302
		# the entered password visibly in its error message!  When other
5303
		# browsers add support for this attribute, or Opera fixes its support,
5304
		# we can add support with a version check to avoid doing this on Opera
5305
		# versions where it will be a problem.  Reported to Opera as
5306
		# DSK-262266, but they don't have a public bug tracker for us to follow.
5307
		/*
5308
		if ( $wgMinimalPasswordLength > 1 ) {
5309
			$ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
5310
			$ret['title'] = wfMessage( 'passwordtooshort' )
5311
				->numParams( $wgMinimalPasswordLength )->text();
5312
		}
5313
		*/
5314
5315
		return $ret;
5316
	}
5317
5318
	/**
5319
	 * Return the list of user fields that should be selected to create
5320
	 * a new user object.
5321
	 * @return array
5322
	 */
5323
	public static function selectFields() {
5324
		return [
5325
			'user_id',
5326
			'user_name',
5327
			'user_real_name',
5328
			'user_email',
5329
			'user_touched',
5330
			'user_token',
5331
			'user_email_authenticated',
5332
			'user_email_token',
5333
			'user_email_token_expires',
5334
			'user_registration',
5335
			'user_editcount',
5336
		];
5337
	}
5338
5339
	/**
5340
	 * Factory function for fatal permission-denied errors
5341
	 *
5342
	 * @since 1.22
5343
	 * @param string $permission User right required
5344
	 * @return Status
5345
	 */
5346
	static function newFatalPermissionDeniedStatus( $permission ) {
5347
		global $wgLang;
5348
5349
		$groups = array_map(
5350
			[ 'User', 'makeGroupLinkWiki' ],
5351
			User::getGroupsWithPermission( $permission )
5352
		);
5353
5354
		if ( $groups ) {
5355
			return Status::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5356
		} else {
5357
			return Status::newFatal( 'badaccess-group0' );
5358
		}
5359
	}
5360
5361
	/**
5362
	 * Get a new instance of this user that was loaded from the master via a locking read
5363
	 *
5364
	 * Use this instead of the main context User when updating that user. This avoids races
5365
	 * where that user was loaded from a replica DB or even the master but without proper locks.
5366
	 *
5367
	 * @return User|null Returns null if the user was not found in the DB
5368
	 * @since 1.27
5369
	 */
5370
	public function getInstanceForUpdate() {
5371
		if ( !$this->getId() ) {
5372
			return null; // anon
5373
		}
5374
5375
		$user = self::newFromId( $this->getId() );
5376
		if ( !$user->loadFromId( self::READ_EXCLUSIVE ) ) {
5377
			return null;
5378
		}
5379
5380
		return $user;
5381
	}
5382
5383
	/**
5384
	 * Checks if two user objects point to the same user.
5385
	 *
5386
	 * @since 1.25
5387
	 * @param User $user
5388
	 * @return bool
5389
	 */
5390
	public function equals( User $user ) {
5391
		return $this->getName() === $user->getName();
5392
	}
5393
}
5394