|
MediaWiki master
|
User class for the MediaWiki software. More...
Inherits Stringable, MediaWiki\Permissions\Authority, MediaWiki\User\UserIdentity, and MediaWiki\Mail\UserEmailContact.

Public Member Functions | |||||||
| __construct () | |||||||
| & | __get ( $name) | ||||||
| __set ( $name, $value) | |||||||
| __sleep () | |||||||
| __toString () | |||||||
| addToDatabase () | |||||||
| Add this existing user object to the database. | |||||||
| authorizeAction (string $action, ?PermissionStatus $status=null) | |||||||
Authorize an action.This should be used immediately before performing the action.Calling this method may have non-trivial side-effects, such as incrementing a rate limit counter.
| |||||||
| authorizeRead (string $action, PageIdentity $target, ?PermissionStatus $status=null) | |||||||
| authorizeWrite (string $action, PageIdentity $target, ?PermissionStatus $status=null) | |||||||
| canReceiveEmail () | |||||||
| Is this user allowed to receive e-mails within limits of current site configuration? | |||||||
| canSendEmail () | |||||||
| Is this user allowed to send e-mails within limits of current site configuration? | |||||||
| changeAuthenticationData (array $data) | |||||||
| Changes credentials of the user. | |||||||
| checkAndSetTouched () | |||||||
| Bump user_touched if it didn't change since this object was loaded. | |||||||
| checkPasswordValidity ( $password) | |||||||
| Check if this is a valid password for this user. | |||||||
| clearInstanceCache ( $reloadFrom=false) | |||||||
| Clear various cached data stored in this object. | |||||||
| clearSharedCache ( $mode='refresh') | |||||||
| Clear user data from memcached. | |||||||
| confirmEmail () | |||||||
| Mark the e-mail address confirmed. | |||||||
| debouncedDBTouch () | |||||||
| Update the db touched timestamp for the user if it hasn't been updated recently. | |||||||
| definitelyCan (string $action, PageIdentity $target, ?PermissionStatus $status=null) | |||||||
| doLogout () | |||||||
| Clear the user's session, and reset the instance cache. | |||||||
| equals (?UserIdentity $user) | |||||||
| Checks if two user objects point to the same user. | |||||||
| getActorId ( $dbwOrWikiId=self::LOCAL) | |||||||
| Get the user's actor ID. | |||||||
| getBlock ( $freshness=IDBAccessObject::READ_NORMAL, $disableIpBlockExemptChecking=false) | |||||||
| Get the block affecting the user, or null if the user is not blocked. | |||||||
| getConfirmationToken (?string &$expiration, ?int $tokenLifeTimeSeconds=null) | |||||||
| Generate, store, and return a new e-mail confirmation code. | |||||||
| getConfirmationTokenUrl (string $token) | |||||||
| Return a URL the user can use to confirm their email address. | |||||||
| getDatePreference () | |||||||
| Get the user's preferred date format. | |||||||
| getDBTouched () | |||||||
| Get the user_touched timestamp field (time of last DB updates). | |||||||
| getEditCount () | |||||||
| Get the user's edit count. | |||||||
| getEditToken ( $salt='', $request=null) | |||||||
| Initialize (if necessary) and return a session token value which can be used in edit forms to show that the user's login credentials aren't being hijacked with a foreign form submission. | |||||||
| getEditTokenObject ( $salt='', $request=null) | |||||||
| Initialize (if necessary) and return a session token value which can be used in edit forms to show that the user's login credentials aren't being hijacked with a foreign form submission. | |||||||
| getEmail () | |||||||
| Get the user's e-mail address. | |||||||
| getEmailAuthenticationTimestamp () | |||||||
| Get the timestamp of the user's e-mail authentication. | |||||||
| getExperienceLevel () | |||||||
| Compute experienced level based on edit count and registration date. | |||||||
| getId ( $wikiId=self::LOCAL) | |||||||
| Get the user's ID. | |||||||
| getInstanceForUpdate () | |||||||
| Get a new instance of this user that was loaded from the primary DB via a locking read. | |||||||
| getInstanceFromPrimary (int $loadFlags=IDBAccessObject::READ_LATEST) | |||||||
| Get an instance of this user that was loaded from the primary DB. | |||||||
| getInvalidationTokenUrl (string $token) | |||||||
| Return a URL the user can use to invalidate their email address. | |||||||
| getName () | |||||||
| Get the user name, or the IP of an anonymous user. | |||||||
| getRealName () | |||||||
| Get the user's real name. | |||||||
| getRegistration () | |||||||
| Get the timestamp of account creation. | |||||||
| getRequest () | |||||||
| Get the WebRequest object to use with this object. | |||||||
| getTalkPage () | |||||||
| Get this user's talk page title. | |||||||
| getTitleKey () | |||||||
| Get the user's name escaped by underscores. | |||||||
| getToken ( $forceCreation=true) | |||||||
| Get the user's current token. | |||||||
| getTokenFromOption ( $oname) | |||||||
| Get a token stored in the preferences (like the watchlist one), resetting it if it's empty (and saving changes). | |||||||
| getTokenUrl (string $page, string $token) | |||||||
| Function to create a special page URL with a token path parameter. | |||||||
| getTouched () | |||||||
| Get the user touched timestamp. | |||||||
| getUser () | |||||||
| getUserPage () | |||||||
| Get this user's personal page title. | |||||||
| getWikiId () | |||||||
| Returns self::LOCAL to indicate the user is associated with the local wiki. | |||||||
| idForName ( $flags=IDBAccessObject::READ_NORMAL) | |||||||
| If only this user's username is known, and it exists, return the user ID. | |||||||
| invalidateCache () | |||||||
| Immediately touch the user data cache for this account. | |||||||
| invalidateEmail () | |||||||
| Invalidate the user's e-mail confirmation, and unauthenticate the e-mail address if it was already confirmed. | |||||||
| isAllowed (string $permission, ?PermissionStatus $status=null) | |||||||
| Checks whether this authority has the given permission in general. | |||||||
| isAllowedAll (... $permissions) | |||||||
Checks whether this authority has any of the given permissions in general.Implementations must ensure that this method returns false if isAllowed would return false for any of the given permissions. Calling isAllowedAll() with one parameter must be equivalent to calling isAllowed(). Calling isAllowedAny() with no parameter is not allowed.
| |||||||
| isAllowedAny (... $permissions) | |||||||
Checks whether this authority has any of the given permissions in general.Implementations must ensure that this method returns true if isAllowed would return true for any of the given permissions. Calling isAllowedAny() with one parameter must be equivalent to calling isAllowed(). Calling isAllowedAny() with no parameter is not allowed.
| |||||||
| isAllowedToCreateAccount () | |||||||
| Get whether the user is allowed to create an account. | |||||||
| isAnon () | |||||||
| Get whether the user is anonymous, i.e. | |||||||
| isBlockedFromEmailuser () | |||||||
| Get whether the user is blocked from using Special:Emailuser. | |||||||
| isBlockedFromUpload () | |||||||
| Get whether the user is blocked from using Special:Upload. | |||||||
| isBot () | |||||||
| isDefinitelyAllowed (string $action, ?PermissionStatus $status=null) | |||||||
Checks whether this authority is allowed to perform the given action.This method performs a thorough check, but does not protect against race conditions. It is intended to be used when a user is intending to perform an action, but has not yet committed to it. For example, when a user visits their preferences page, this method may be used to determine whether the user should have the option to change their email address.This method may apply rate limit checks and evaluate user blocks.
| |||||||
| isEmailConfirmationPending () | |||||||
| Check whether there is an outstanding request for e-mail confirmation. | |||||||
| isEmailConfirmed () | |||||||
| Is this user's e-mail address valid-looking and confirmed within limits of the current site configuration? | |||||||
| isHidden () | |||||||
| Check if user account is hidden. | |||||||
| isItemLoaded ( $item, $all='all') | |||||||
| Return whether an item has been loaded. | |||||||
| isLocked () | |||||||
| Check if user account is locked. | |||||||
| isNamed () | |||||||
| Is the user a normal non-temporary registered user? | |||||||
| isNewbie () | |||||||
| Determine whether the user is a newbie. | |||||||
| isPingLimitable () | |||||||
| Is this user subject to rate limiting? | |||||||
| isRegistered () | |||||||
| Get whether the user is registered. | |||||||
| isSafeToLoad () | |||||||
| Test if it's safe to load this User object. | |||||||
| isSystemUser () | |||||||
| Get whether the user is a system user. | |||||||
| isTemp () | |||||||
| Is the user an autocreated temporary user? | |||||||
| isValidPassword ( $password) | |||||||
| Is the input a valid password for this user? | |||||||
| load ( $flags=IDBAccessObject::READ_NORMAL) | |||||||
| Load the user table data for this object from the source given by mFrom. | |||||||
| loadDefaults ( $name=false, $actorId=null) | |||||||
| Set cached properties to default. | |||||||
| loadFromDatabase ( $flags=IDBAccessObject::READ_LATEST) | |||||||
| Load user data from the database. | |||||||
| loadFromId ( $flags=IDBAccessObject::READ_NORMAL) | |||||||
| Load user table data, given mId has already been set. | |||||||
| logout () | |||||||
| Log this user out. | |||||||
| matchEditToken ( $val, $salt='', $request=null, $maxage=null) | |||||||
| Check given value against the token value stored in the session. | |||||||
| pingLimiter ( $action='edit', $incrBy=1) | |||||||
| Primitive rate limits: enforce maximum actions per time period to put a brake on flooding. | |||||||
| probablyCan (string $action, PageIdentity $target, ?PermissionStatus $status=null) | |||||||
| requiresHTTPS () | |||||||
| Determine based on the wiki configuration and the user's options, whether this user must be over HTTPS no matter what. | |||||||
| resetTokenFromOption ( $oname) | |||||||
| Reset a token stored in the preferences (like the watchlist one). | |||||||
| saveSettings () | |||||||
| Save this user's settings into the database. | |||||||
| scheduleSpreadBlock () | |||||||
| Schedule a deferred update which will block the IP address of the current user, if they are blocked with the autoblocking option. | |||||||
| sendConfirmationMail ( $type='created') | |||||||
| Generate a new e-mail confirmation token and send a confirmation/invalidation mail to the user's given address. | |||||||
| sendMail ( $subject, $body, $from=null, $replyto=null) | |||||||
| Send an e-mail to this user's account. | |||||||
| setActorId (int $actorId) | |||||||
| Sets the actor id. | |||||||
| setCookies ( $request=null, $secure=null, $rememberMe=false) | |||||||
| Persist this user's session (e.g. | |||||||
| setEmail (string $str) | |||||||
| Set the user's e-mail address. | |||||||
| setEmailAuthenticationTimestamp ( $timestamp) | |||||||
| Set the e-mail authentication timestamp. | |||||||
| setEmailWithConfirmation (string $str) | |||||||
| Set the user's e-mail address and send a confirmation mail if needed. | |||||||
| setId ( $v) | |||||||
| Set the user and reload all fields according to a given ID. | |||||||
| setItemLoaded ( $item) | |||||||
| Set that an item has been loaded. | |||||||
| setName ( $str) | |||||||
| Set the user name. | |||||||
| setRealName (string $str) | |||||||
| Set the user's real name. | |||||||
| setToken ( $token=false) | |||||||
| Set the random token (used for persistent authentication) Called from loadDefaults() among other places. | |||||||
| spreadAnyEditBlock () | |||||||
| If this user is logged-in and blocked, block any IP address they've successfully logged in from. | |||||||
| toRateLimitSubject () | |||||||
| touch () | |||||||
| Update the "touched" timestamp for the user. | |||||||
| useFilePatrol () | |||||||
| Check whether to enable new files patrol features for this user. | |||||||
| useNPPatrol () | |||||||
| Check whether to enable new pages patrol features for this user. | |||||||
| useRCPatrol () | |||||||
| Check whether to enable recent changes patrol features for this user. | |||||||
| validateCache ( $timestamp) | |||||||
| Validate the cache for this account. | |||||||
| Public Member Functions inherited from MediaWiki\Permissions\Authority | |||||||
| getBlock (int $freshness=IDBAccessObject::READ_NORMAL) | |||||||
| Returns any user block affecting the Authority. | |||||||
| Public Member Functions inherited from MediaWiki\DAO\WikiAwareEntity | |||||||
| assertWiki ( $wikiId) | |||||||
| Throws if $wikiId is different from the return value of getWikiId(). | |||||||
Static Public Member Functions | |
| static | createNew ( $name, $params=[]) |
| Add a user to the database, return the user object. | |
| static | findUsersByGroup ( $groups, $limit=5000, $after=null) |
| Return the users who are members of the given group(s). | |
| static | getQueryInfo () |
| Return the tables, fields, and join conditions to be selected to create a new user object. | |
| static | getRightDescription ( $right) |
| Get the description of a given right as wikitext. | |
| static | getRightDescriptionHtml ( $right) |
| Get the description of a given right as rendered HTML. | |
| static | isWellFormedConfirmationToken (string $token) |
| Check if the given email confirmation token is well-formed (to detect mangling by email clients). | |
| static | newFatalPermissionDeniedStatus ( $permission) |
| Factory function for fatal permission-denied errors. | |
| static | newQueryBuilder (IReadableDatabase $db) |
| Get a SelectQueryBuilder with the tables, fields and join conditions needed to create a new User object. | |
| static | purge ( $dbDomain, $userId) |
newFrom*() static factory methods | |
| static | newFromName ( $name, $validate='valid') |
| static | newFromId ( $id) |
| Static factory method for creation from a given user ID. | |
| static | newFromActorId ( $id) |
| Static factory method for creation from a given actor ID. | |
| static | newFromIdentity (UserIdentity $identity) |
| Returns a User object corresponding to the given UserIdentity. | |
| static | newFromAnyId ( $userId, $userName, $actorId, $dbDomain=false) |
| Static factory method for creation from an ID, name, and/or actor ID. | |
| static | newFromConfirmationCode ( $code, $flags=IDBAccessObject::READ_NORMAL) |
| Factory method to fetch whichever user has a given email confirmation code. | |
| static | newFromSession (?WebRequest $request=null) |
| Create a new user object using data from session. | |
| static | newFromRow ( $row, $data=null) |
| Create a new user object from a user row. | |
| static | newSystemUser ( $name, $options=[]) |
| Static factory method for creation of a "system" user from username. | |
Public Attributes | |
| int null | $mActorId |
| Switched from protected to public for use in UserFactory. | |
| string | $mEmail |
| string null | $mEmailAuthenticated |
| string | $mFrom |
| Initialization data source if mLoadedItems!==true. | |
| int | $mId |
| Cache variables. | |
| string false | $mName |
| string | $mRealName |
| string | $mTouched |
| TS::MW timestamp from the DB. | |
| const | INVALID_TOKEN = '*** INVALID ***' |
| An invalid string value for the user_token field. | |
| const | MAINTENANCE_SCRIPT_USER = 'Maintenance script' |
| Username used for various maintenance scripts. | |
| const | READ_EXCLUSIVE = IDBAccessObject::READ_EXCLUSIVE |
| const | READ_LOCKING = IDBAccessObject::READ_LOCKING |
| const | TOKEN_LENGTH = 32 |
| Number of characters required for the user_token field. | |
| Public Attributes inherited from MediaWiki\DAO\WikiAwareEntity | |
| const | LOCAL = false |
| Wiki ID value to use with instances that are defined relative to the local wiki. | |
Protected Member Functions | |
| confirmationToken (&$expiration) | |
| Deprecated alias for getConfirmationToken() for CentralAuth. | |
| getCacheKey (WANObjectCache $cache) | |
| invalidationTokenUrl ( $token) | |
| Deprecated alias for getInvalidationTokenUrl() for CentralAuth. | |
| loadFromCache () | |
| Load user data from shared cache, given mId has already been set. | |
| loadFromRow ( $row, $data=null) | |
| Initialize this object from a row from the user table. | |
| loadFromUserObject ( $user) | |
| Load the data for this user object from another user object. | |
| makeUpdateConditions (IReadableDatabase $db) | |
| Build additional update conditions to protect against race conditions using a compare-and-set (CAS) mechanism based on comparing $this->mTouched with the user_touched field. | |
| spreadBlock (Block $block) | |
| If this (non-anonymous) user is blocked, block the IP address they've successfully logged in from. | |
Protected Attributes | |
| string null | $mDatePreference |
| Lazy-initialized variables, invalidated with clearInstanceCache. | |
| string null | $mEmailToken |
| string null | $mEmailTokenExpires |
| AbstractBlock false null | $mGlobalBlock |
| Null when uninitialized, false when there is no block. | |
| array bool | $mLoadedItems = [] |
| Array with already loaded items or true if all items have been loaded. | |
| bool null | $mLocked |
| string null | $mQuickTouched |
| TS::MW timestamp from cache. | |
| string null | $mToken |
| int | $queryFlagsUsed = IDBAccessObject::READ_NORMAL |
| IDBAccessObject::READ_* constant bitfield used to load data. | |
Static Protected Attributes | |
| static string[] | $mCacheVars |
| List of member variables which are saved to the shared cache (memcached). | |
User class for the MediaWiki software.
User objects manage reading and writing of user-specific storage, including:
Callers use getter methods (getXXX) to read these fields. These getter functions manage all higher-level responsibilities such as expanding default user options, interpreting user groups into specific rights. Most user data needed when rendering page views are cached (or stored in the session) to minimize repeat database queries.
New code is encouraged to use the following narrower classes instead. If no replacement exist, and the User class method is not deprecated, feel free to use it in new code (instead of duplicating business logic).
| MediaWiki\User\User::__construct | ( | ) |
Definition at line 277 of file User.php.
References clearInstanceCache().
| & MediaWiki\User\User::__get | ( | $name | ) |
Definition at line 299 of file User.php.
References MediaWiki\MediaWikiServices\getInstance(), wfDeprecated(), and wfLogWarning().
| MediaWiki\User\User::__set | ( | $name, | |
| $value ) |
Definition at line 320 of file User.php.
References MediaWiki\MediaWikiServices\getInstance(), wfDeprecated(), and wfLogWarning().
| MediaWiki\User\User::__toString | ( | ) |
| MediaWiki\User\User::addToDatabase | ( | ) |
Add this existing user object to the database.
If the user already exists, a fatal status object is returned, and the user object is initialised with the data from the database.
Previously, this function generated a DB error due to a key conflict if the user already existed. Many extension callers use this function in code along the lines of:
$user = User::newFromName( $name ); if ( !$user->isRegistered() ) { $user->addToDatabase(); } // do something with $user...
However, this was vulnerable to a race condition (T18020). By initialising the user object if the user exists, we aim to support this calling sequence as far as possible.
Note that if the user exists, this function will acquire a write lock, so it is still advisable to make the call conditional on isRegistered(), and to commit the transaction after calling.
Definition at line 2528 of file User.php.
References Wikimedia\Rdbms\IDatabase\affectedRows(), clearInstanceCache(), MediaWiki\MediaWikiServices\getInstance(), Wikimedia\Rdbms\IDatabase\insertId(), isNamed(), load(), loadFromDatabase(), Wikimedia\Rdbms\IDatabase\newInsertQueryBuilder(), Wikimedia\Rdbms\IReadableDatabase\newSelectQueryBuilder(), setToken(), Wikimedia\Rdbms\Platform\ISQLPlatform\timestamp(), and Wikimedia\Rdbms\Platform\ISQLPlatform\timestampOrNull().
Referenced by MediaWiki\Auth\AuthManager\autoCreateUser().
| MediaWiki\User\User::authorizeAction | ( | string | $action, |
| ?PermissionStatus | $status = null ) |
Authorize an action.This should be used immediately before performing the action.Calling this method may have non-trivial side-effects, such as incrementing a rate limit counter.
| string | $action | |
| PermissionStatus | null | $status | aggregator for failures |
| string | $action | |
| PermissionStatus | null | $status |
Implements MediaWiki\Permissions\Authority.
Definition at line 3325 of file User.php.
References authorizeAction(), and return.
Referenced by authorizeAction().
| MediaWiki\User\User::authorizeRead | ( | string | $action, |
| PageIdentity | $target, | ||
| ?PermissionStatus | $status = null ) |
| string | $action | |
| PageIdentity | $target | |
| PermissionStatus | null | $status |
Implements MediaWiki\Permissions\Authority.
Definition at line 3336 of file User.php.
References authorizeRead(), and return.
Referenced by authorizeRead().
| MediaWiki\User\User::authorizeWrite | ( | string | $action, |
| PageIdentity | $target, | ||
| ?PermissionStatus | $status = null ) |
| string | $action | |
| PageIdentity | $target | |
| PermissionStatus | null | $status |
Implements MediaWiki\Permissions\Authority.
Definition at line 3351 of file User.php.
References authorizeWrite(), and return.
Referenced by authorizeWrite().
| MediaWiki\User\User::canReceiveEmail | ( | ) |
Is this user allowed to receive e-mails within limits of current site configuration?
Definition at line 3035 of file User.php.
References MediaWiki\MediaWikiServices\getInstance(), MediaWiki\User\Options\UserOptionsLookup\getOption(), and isEmailConfirmed().
| MediaWiki\User\User::canSendEmail | ( | ) |
Is this user allowed to send e-mails within limits of current site configuration?
Definition at line 3022 of file User.php.
References MediaWiki\MediaWikiServices\getInstance(), and wfDeprecated().
| MediaWiki\User\User::changeAuthenticationData | ( | array | $data | ) |
Changes credentials of the user.
This is a convenience wrapper around AuthManager::changeAuthenticationData. Note that this can return a status that isOK() but not isGood() on certain types of failures, e.g. when no provider handled the change.
| array | $data | A set of authentication data in fieldname => value format. This is the same data you would pass the changeauthenticationdata API - 'username', 'password' etc. |
Definition at line 1761 of file User.php.
References MediaWiki\MediaWikiServices\getInstance().
| MediaWiki\User\User::checkAndSetTouched | ( | ) |
Bump user_touched if it didn't change since this object was loaded.
On success, the mTouched field is updated. The user serialization cache is always cleared.
Definition at line 1276 of file User.php.
References $success, clearSharedCache(), MediaWiki\MediaWikiServices\getInstance(), load(), and makeUpdateConditions().
Referenced by debouncedDBTouch().
| MediaWiki\User\User::checkPasswordValidity | ( | $password | ) |
Check if this is a valid password for this user.
Returns a Status object with a set of messages describing problems with the password. If the return status is fatal, the action should be refused and the password should not be checked at all (this is mainly meant for DoS mitigation). If the return value is OK but not good, the password can be checked, but the user should not be able to set their password to this. The value of the returned Status object will be an array which can have the following fields:
| string | $password | Desired password |
Definition at line 960 of file User.php.
References MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\MainConfigNames\PasswordPolicy.
Referenced by isValidPassword().
| MediaWiki\User\User::clearInstanceCache | ( | $reloadFrom = false | ) |
Clear various cached data stored in this object.
The cache of the user table data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
| bool | string | $reloadFrom | Reload user and user_groups table data from a given source. May be "name", "id", "actor", "defaults", "session", or false for no reload. |
Definition at line 1313 of file User.php.
References $wgFullyInitialised, and MediaWiki\MediaWikiServices\getInstance().
Referenced by __construct(), addToDatabase(), doLogout(), and setId().
| MediaWiki\User\User::clearSharedCache | ( | $mode = 'refresh' | ) |
Clear user data from memcached.
Use after applying updates to the database; caller's responsibility to update user_touched if appropriate.
Called implicitly from invalidateCache() and saveSettings().
| string | $mode | Use 'refresh' to clear now or 'changed' to clear before DB commit |
Definition at line 1632 of file User.php.
References getCacheKey(), getId(), and MediaWiki\MediaWikiServices\getInstance().
Referenced by checkAndSetTouched(), invalidateCache(), and saveSettings().
|
protected |
Deprecated alias for getConfirmationToken() for CentralAuth.
| string | null | &$expiration |
Definition at line 2890 of file User.php.
References getConfirmationToken().
| MediaWiki\User\User::confirmEmail | ( | ) |
Mark the e-mail address confirmed.
Definition at line 2965 of file User.php.
References MediaWiki\MediaWikiServices\getInstance(), isEmailConfirmed(), setEmailAuthenticationTimestamp(), MediaWiki\MainConfigNames\UserEmailConfirmationTokenExpiry, wfTimestamp(), and wfTimestampNow().
|
static |
Add a user to the database, return the user object.
| string | $name | Username to add |
| array | $params | Array of Strings Non-default parameters to save to the database as user_* fields:
|
Definition at line 2433 of file User.php.
References MediaWiki\MediaWikiServices\getInstance().
| MediaWiki\User\User::debouncedDBTouch | ( | ) |
Update the db touched timestamp for the user if it hasn't been updated recently.
Definition at line 1690 of file User.php.
References checkAndSetTouched(), and getDBTouched().
| MediaWiki\User\User::definitelyCan | ( | string | $action, |
| PageIdentity | $target, | ||
| ?PermissionStatus | $status = null ) |
| string | $action | |
| PageIdentity | $target | |
| PermissionStatus | null | $status |
Implements MediaWiki\Permissions\Authority.
Definition at line 3297 of file User.php.
References definitelyCan(), and return.
Referenced by definitelyCan().
| MediaWiki\User\User::doLogout | ( | ) |
Clear the user's session, and reset the instance cache.
Definition at line 2284 of file User.php.
References clearInstanceCache(), MediaWiki\MediaWikiServices\getInstance(), and getRequest().
Referenced by logout().
| MediaWiki\User\User::equals | ( | ?UserIdentity | $user | ) |
Checks if two user objects point to the same user.
| UserIdentity | null | $user |
Implements MediaWiki\User\UserIdentity.
Definition at line 3258 of file User.php.
References if.
Referenced by MediaWiki\Actions\RevertAction\checkCanExecute().
|
static |
Return the users who are members of the given group(s).
In case of multiple groups, users who are members of at least one of them are returned.
| string | array | $groups | A single group name or an array of group names |
| int | $limit | Max number of users to return. The actual limit will never exceed 5000 records; larger values are ignored. |
| int | null | $after | ID the user to start after |
Definition at line 907 of file User.php.
References MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\User\UserArray\newFromIDs().
Referenced by EmptyUserGroup\execute().
| MediaWiki\User\User::getActorId | ( | $dbwOrWikiId = self::LOCAL | ) |
Get the user's actor ID.
| IDatabase | string | false | $dbwOrWikiId | Deprecated since 1.36. If a database connection is passed, a new actor ID is assigned if needed. ActorNormalization::acquireActorId() should be used for that purpose instead. |
| PreconditionException | if $dbwOrWikiId is a string and does not match the local wiki |
Definition at line 1557 of file User.php.
References if, and wfDeprecatedMsg().
| MediaWiki\User\User::getBlock | ( | $freshness = IDBAccessObject::READ_NORMAL, | |
| $disableIpBlockExemptChecking = false ) |
Get the block affecting the user, or null if the user is not blocked.
| int | bool | $freshness | One of the IDBAccessObject::READ_XXX constants. For backwards compatibility, a boolean is also accepted, with true meaning READ_NORMAL and false meaning READ_LATEST. |
| bool | $disableIpBlockExemptChecking | This is used internally to prevent an infinite recursion with autopromote. See T270145. |
Definition at line 1412 of file User.php.
References if.
Referenced by MediaWiki\Actions\Action\checkCanExecute(), MediaWiki\Actions\DeleteAction\checkCanExecute(), MediaWiki\SpecialPage\FormSpecialPage\checkExecutePermissions(), MediaWiki\SpecialPage\ContributionsSpecialPage\getUserLinks(), isBlockedFromEmailuser(), isBlockedFromUpload(), isHidden(), spreadAnyEditBlock(), and MediaWiki\Block\BlockManager\trackBlockWithCookie().
|
protected |
| WANObjectCache | $cache |
Definition at line 522 of file User.php.
References MediaWiki\MediaWikiServices\getInstance(), and Wikimedia\ObjectCache\WANObjectCache\makeGlobalKey().
Referenced by clearSharedCache(), and loadFromCache().
| MediaWiki\User\User::getConfirmationToken | ( | ?string & | $expiration, |
| ?int | $tokenLifeTimeSeconds = null ) |
Generate, store, and return a new e-mail confirmation code.
A hash (unsalted, since it's used as a key) is stored. Any preexisting e-mail confirmation token will be invalidated.
| null | string | &$expiration | Timestamp at which the generated token expires |
| int | null | $tokenLifeTimeSeconds | Optional lifetime of the token in seconds. Defaults to the value of $wgUserEmailConfirmationTokenExpiry if not set. |
Definition at line 2866 of file User.php.
References load(), and wfTimestamp().
Referenced by confirmationToken(), and sendConfirmationMail().
| MediaWiki\User\User::getConfirmationTokenUrl | ( | string | $token | ) |
Return a URL the user can use to confirm their email address.
| string | $token | Accepts the email confirmation token |
Definition at line 2911 of file User.php.
References getTokenUrl(), and return.
Referenced by sendConfirmationMail().
| MediaWiki\User\User::getDatePreference | ( | ) |
Get the user's preferred date format.
Definition at line 2020 of file User.php.
References MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\User\Options\UserOptionsLookup\getOption().
| MediaWiki\User\User::getDBTouched | ( | ) |
Get the user_touched timestamp field (time of last DB updates).
Definition at line 1743 of file User.php.
References load().
Referenced by debouncedDBTouch().
| MediaWiki\User\User::getEditCount | ( | ) |
Get the user's edit count.
Definition at line 2063 of file User.php.
References MediaWiki\MediaWikiServices\getInstance().
Referenced by getExperienceLevel(), and MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences().
| MediaWiki\User\User::getEditToken | ( | $salt = '', | |
| $request = null ) |
Initialize (if necessary) and return a session token value which can be used in edit forms to show that the user's login credentials aren't being hijacked with a foreign form submission.
The $salt for 'edit' and 'csrf' tokens is the default (empty string).
| string | string[] | $salt | Optional function-specific data for hashing |
| WebRequest | null | $request | WebRequest object to use, or null to use the global request |
Definition at line 2760 of file User.php.
References $request, and getEditTokenObject().
| MediaWiki\User\User::getEditTokenObject | ( | $salt = '', | |
| $request = null ) |
Initialize (if necessary) and return a session token value which can be used in edit forms to show that the user's login credentials aren't being hijacked with a foreign form submission.
| string | string[] | $salt | Optional function-specific data for hashing |
| WebRequest | null | $request | WebRequest object to use, or null to use the global request |
Definition at line 2735 of file User.php.
References $request, getRequest(), and isAnon().
Referenced by getEditToken(), MediaWiki\Api\ApiQueryTokens\getToken(), and matchEditToken().
| MediaWiki\User\User::getEmail | ( | ) |
Get the user's e-mail address.
Implements MediaWiki\Mail\UserEmailContact.
Definition at line 1848 of file User.php.
References load().
Referenced by isEmailConfirmed(), isSystemUser(), MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences(), setEmail(), and setEmailWithConfirmation().
| MediaWiki\User\User::getEmailAuthenticationTimestamp | ( | ) |
Get the timestamp of the user's e-mail authentication.
Definition at line 1861 of file User.php.
References load().
Referenced by isEmailConfirmed(), and MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences().
| MediaWiki\User\User::getExperienceLevel | ( | ) |
Compute experienced level based on edit count and registration date.
Definition at line 2193 of file User.php.
References MediaWiki\MainConfigNames\ExperiencedUserEdits, MediaWiki\MainConfigNames\ExperiencedUserMemberSince, getEditCount(), MediaWiki\MediaWikiServices\getInstance(), getRegistration(), isAnon(), MediaWiki\MainConfigNames\LearnerEdits, MediaWiki\MainConfigNames\LearnerMemberSince, and wfTimestamp().
| MediaWiki\User\User::getId | ( | $wikiId = self::LOCAL | ) |
Get the user's ID.
| string | false | $wikiId | The wiki ID expected by the caller. |
Implements MediaWiki\User\UserIdentity.
Definition at line 1478 of file User.php.
References MediaWiki\DAO\WikiAwareEntity\assertWiki(), MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\User\ExternalUserNames\isExternal().
Referenced by MediaWiki\Upload\UploadFromChunks\__construct(), MediaWiki\Auth\AuthManager\autoCreateUser(), MediaWiki\Auth\AuthManager\beginAccountLink(), clearSharedCache(), getTokenFromOption(), MediaWiki\SpecialPage\ContributionsSpecialPage\getUserLinks(), isRegistered(), MediaWiki\Actions\CreditsAction\link(), and touch().
| MediaWiki\User\User::getInstanceForUpdate | ( | ) |
Get a new instance of this user that was loaded from the primary DB via a locking read.
Use this instead of the main context User when updating that user. This avoids races where that user was loaded from a replica DB or even the primary DB but without proper locks.
Definition at line 3214 of file User.php.
References getInstanceFromPrimary(), and wfDeprecated().
| MediaWiki\User\User::getInstanceFromPrimary | ( | int | $loadFlags = IDBAccessObject::READ_LATEST | ) |
Get an instance of this user that was loaded from the primary DB.
If the user object was already from the primary DB (and more generally matches $loadFlags), it will be returned; otherwise a DB query will be performed and a new User instance returned.
Use this instead of the main context User when updating that user or updating something else based on the user's data, to avoid updating based on outdated information.
Optionally you can set a shared or exclusive lock on the user record with the $loadFlags option. Only use this (especially with an exclusive lock) when absolutely necessary, as overuse of locks can have significant performance impact.
| int | $loadFlags | Optional IDBAccessObject flags for locking |
Definition at line 3236 of file User.php.
Referenced by getInstanceForUpdate().
| MediaWiki\User\User::getInvalidationTokenUrl | ( | string | $token | ) |
Return a URL the user can use to invalidate their email address.
| string | $token | Accepts the email confirmation token |
Definition at line 2922 of file User.php.
References getTokenUrl(), and return.
Referenced by sendConfirmationMail().
| MediaWiki\User\User::getName | ( | ) |
Get the user name, or the IP of an anonymous user.
Implements MediaWiki\User\UserIdentity.
Definition at line 1511 of file User.php.
References if, and isItemLoaded().
Referenced by __toString(), MediaWiki\Auth\AuthManager\autoCreateUser(), MediaWiki\Auth\AuthManager\beginAccountLink(), MediaWiki\User\PasswordReset\execute(), MediaWiki\Preferences\DefaultPreferencesFactory\generateSkinOptions(), getTitleKey(), MediaWiki\SpecialPage\ContributionsSpecialPage\getUserLink(), MediaWiki\SpecialPage\ContributionsSpecialPage\getUserLinks(), MediaWiki\Specials\SpecialDeletedContributions\getUserLinks(), getUserPage(), idForName(), MediaWiki\Session\SessionManager\invalidateSessionsForUser(), MediaWiki\User\PasswordReset\isAllowed(), MediaWiki\Actions\CreditsAction\link(), MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences(), MediaWiki\Mail\NotificationEmail\NotificationEmailSender\sendNotificationMail(), MediaWiki\Preferences\DefaultPreferencesFactory\skinPreferences(), MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider\tryReset(), and MediaWiki\Actions\CreditsAction\userLink().
|
static |
Return the tables, fields, and join conditions to be selected to create a new user object.
| MediaWiki\User\User::getRealName | ( | ) |
Get the user's real name.
Implements MediaWiki\Mail\UserEmailContact.
Definition at line 1944 of file User.php.
References if, isItemLoaded(), and load().
Referenced by MediaWiki\Actions\CreditsAction\link(), MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences(), and MediaWiki\Actions\CreditsAction\userLink().
| MediaWiki\User\User::getRegistration | ( | ) |
Get the timestamp of account creation.
Definition at line 3086 of file User.php.
References MediaWiki\MediaWikiServices\getInstance().
Referenced by getExperienceLevel(), and MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences().
| MediaWiki\User\User::getRequest | ( | ) |
Get the WebRequest object to use with this object.
Definition at line 2184 of file User.php.
References getRequest(), and return.
Referenced by doLogout(), MediaWiki\User\PasswordReset\execute(), getEditTokenObject(), getRequest(), setCookies(), toRateLimitSubject(), and MediaWiki\Block\BlockManager\trackBlockWithCookie().
|
static |
Get the description of a given right as wikitext.
| string | $right | Right to query |
Definition at line 3099 of file User.php.
References wfMessage().
Referenced by CreateBotPassword\showGrants().
|
static |
Get the description of a given right as rendered HTML.
| string | $right | Right to query |
Definition at line 3112 of file User.php.
References wfMessage().
| MediaWiki\User\User::getTalkPage | ( | ) |
Get this user's talk page title.
Definition at line 2706 of file User.php.
References getUserPage().
Referenced by MediaWiki\SpecialPage\ContributionsSpecialPage\getUserLinks().
| MediaWiki\User\User::getTitleKey | ( | ) |
Get the user's name escaped by underscores.
Definition at line 1603 of file User.php.
References getName(), and return.
Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences().
| MediaWiki\User\User::getToken | ( | $forceCreation = true | ) |
Get the user's current token.
| bool | $forceCreation | Force the generation of a new token if the user doesn't have one (default=true for backwards compatibility). |
Definition at line 1788 of file User.php.
References MediaWiki\MainConfigNames\AuthenticationTokenVersion, MediaWiki\MediaWikiServices\getInstance(), load(), and setToken().
Referenced by getTokenFromOption().
| MediaWiki\User\User::getTokenFromOption | ( | $oname | ) |
Get a token stored in the preferences (like the watchlist one), resetting it if it's empty (and saving changes).
| string | $oname | The option name to retrieve the token from |
Definition at line 1971 of file User.php.
References getId(), MediaWiki\MediaWikiServices\getInstance(), MediaWiki\User\Options\UserOptionsLookup\getOption(), getToken(), and MediaWiki\MainConfigNames\HiddenPrefs.
| MediaWiki\User\User::getTokenUrl | ( | string | $page, |
| string | $token ) |
Function to create a special page URL with a token path parameter.
This uses a quickie hack to use the hardcoded English names of the Special: pages, for ASCII safety.
| string | $page | Special page |
| string | $token |
Definition at line 2952 of file User.php.
References NS_MAIN.
Referenced by getConfirmationTokenUrl(), getInvalidationTokenUrl(), and invalidationTokenUrl().
| MediaWiki\User\User::getTouched | ( | ) |
Get the user touched timestamp.
Use this value only to validate caches via inequalities such as in the case of HTTP If-Modified-Since response logic
Definition at line 1721 of file User.php.
References MediaWiki\MediaWikiServices\getInstance(), load(), and wfTimestamp().
Referenced by validateCache().
| MediaWiki\User\User::getUser | ( | ) |
Implements MediaWiki\Permissions\Authority.
Definition at line 3271 of file User.php.
References return.
Referenced by sendConfirmationMail().
| MediaWiki\User\User::getUserPage | ( | ) |
Get this user's personal page title.
Definition at line 2697 of file User.php.
References getName(), MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable\makeTitle(), and NS_USER.
Referenced by MediaWiki\Auth\AuthManager\autoCreateUser(), getTalkPage(), MediaWiki\SpecialPage\ContributionsSpecialPage\getUserLinks(), and saveSettings().
| MediaWiki\User\User::getWikiId | ( | ) |
Returns self::LOCAL to indicate the user is associated with the local wiki.
Implements MediaWiki\DAO\WikiAwareEntity.
Definition at line 288 of file User.php.
References MediaWiki\DAO\WikiAwareEntity\LOCAL, and return.
| MediaWiki\User\User::idForName | ( | $flags = IDBAccessObject::READ_NORMAL | ) |
If only this user's username is known, and it exists, return the user ID.
| int | $flags | Bitfield of IDBAccessObject::READ_* constants; useful for existence checks |
Definition at line 2400 of file User.php.
References MediaWiki\MediaWikiServices\getInstance(), and getName().
| MediaWiki\User\User::invalidateCache | ( | ) |
Immediately touch the user data cache for this account.
Calls touch() and removes account data from memcached
Definition at line 1658 of file User.php.
References clearSharedCache(), and touch().
| MediaWiki\User\User::invalidateEmail | ( | ) |
Invalidate the user's e-mail confirmation, and unauthenticate the e-mail address if it was already confirmed.
Definition at line 2994 of file User.php.
References load(), and setEmailAuthenticationTimestamp().
Referenced by setEmail().
|
protected |
Deprecated alias for getInvalidationTokenUrl() for CentralAuth.
| string | $token | Accepts the email confirmation token |
Definition at line 2933 of file User.php.
References getTokenUrl().
| MediaWiki\User\User::isAllowed | ( | string | $permission, |
| ?PermissionStatus | $status = null ) |
Checks whether this authority has the given permission in general.
For some permissions, exceptions may exist, both positive and negative, on a per-target basis. This method offers a fast, lightweight check, but may produce false positives. It is intended for determining which UI elements should be offered to the user.
This method will not apply rate limit checks or evaluate user blocks.
| string | $permission | |
| PermissionStatus | null | $status |
Implements MediaWiki\Permissions\Authority.
Definition at line 2137 of file User.php.
References isAllowed(), and return.
Referenced by MediaWiki\Actions\WatchAction\checkCanExecute(), MediaWiki\Preferences\DefaultPreferencesFactory\editingPreferences(), MediaWiki\Preferences\DefaultPreferencesFactory\getForm(), isAllowed(), isNewbie(), MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences(), MediaWiki\Preferences\DefaultPreferencesFactory\renderingPreferences(), toRateLimitSubject(), and MediaWiki\Preferences\DefaultPreferencesFactory\watchlistPreferences().
| MediaWiki\User\User::isAllowedAll | ( | ... | ) |
Checks whether this authority has any of the given permissions in general.Implementations must ensure that this method returns false if isAllowed would return false for any of the given permissions. Calling isAllowedAll() with one parameter must be equivalent to calling isAllowed(). Calling isAllowedAny() with no parameter is not allowed.
| string | ...$permissions Permissions to test. At least one must be given. |
Implements MediaWiki\Permissions\Authority.
Definition at line 2133 of file User.php.
References isAllowedAll(), and return.
Referenced by isAllowedAll().
| MediaWiki\User\User::isAllowedAny | ( | ... | ) |
Checks whether this authority has any of the given permissions in general.Implementations must ensure that this method returns true if isAllowed would return true for any of the given permissions. Calling isAllowedAny() with one parameter must be equivalent to calling isAllowed(). Calling isAllowedAny() with no parameter is not allowed.
| string | ...$permissions Permissions to test. At least one must be given. |
Implements MediaWiki\Permissions\Authority.
Definition at line 2128 of file User.php.
References isAllowedAny(), and return.
Referenced by MediaWiki\Actions\RevertAction\checkCanExecute(), isAllowedAny(), useFilePatrol(), useNPPatrol(), useRCPatrol(), and MediaWiki\Preferences\DefaultPreferencesFactory\watchlistPreferences().
| MediaWiki\User\User::isAllowedToCreateAccount | ( | ) |
| MediaWiki\User\User::isAnon | ( | ) |
Get whether the user is anonymous, i.e.
not registered. Please prefer UserIdentity::isRegistered from the more narrow interface if possible.
Definition at line 2086 of file User.php.
References isRegistered().
Referenced by getEditTokenObject(), getExperienceLevel(), getInstanceFromPrimary(), isEmailConfirmed(), MediaWiki\Actions\CreditsAction\link(), MediaWiki\Block\BlockManager\trackBlockWithCookie(), and MediaWiki\Actions\CreditsAction\userLink().
| MediaWiki\User\User::isBlockedFromEmailuser | ( | ) |
Get whether the user is blocked from using Special:Emailuser.
Definition at line 2667 of file User.php.
References getBlock(), and wfDeprecated().
| MediaWiki\User\User::isBlockedFromUpload | ( | ) |
Get whether the user is blocked from using Special:Upload.
Definition at line 2679 of file User.php.
References getBlock().
| MediaWiki\User\User::isBot | ( | ) |
Definition at line 2094 of file User.php.
References MediaWiki\MediaWikiServices\getInstance().
Referenced by MediaWiki\Api\getWatchlistValue().
| MediaWiki\User\User::isDefinitelyAllowed | ( | string | $action, |
| ?PermissionStatus | $status = null ) |
Checks whether this authority is allowed to perform the given action.This method performs a thorough check, but does not protect against race conditions. It is intended to be used when a user is intending to perform an action, but has not yet committed to it. For example, when a user visits their preferences page, this method may be used to determine whether the user should have the option to change their email address.This method may apply rate limit checks and evaluate user blocks.
| string | $action | |
| PermissionStatus | null | $status | aggregator for failures |
| string | $action | |
| PermissionStatus | null | $status |
Implements MediaWiki\Permissions\Authority.
Definition at line 3313 of file User.php.
References isDefinitelyAllowed(), and return.
Referenced by isDefinitelyAllowed().
| MediaWiki\User\User::isEmailConfirmationPending | ( | ) |
Check whether there is an outstanding request for e-mail confirmation.
Definition at line 3069 of file User.php.
References MediaWiki\MainConfigNames\EmailAuthentication, MediaWiki\MediaWikiServices\getInstance(), isEmailConfirmed(), and wfTimestamp().
| MediaWiki\User\User::isEmailConfirmed | ( | ) |
Is this user's e-mail address valid-looking and confirmed within limits of the current site configuration?
Implements MediaWiki\Mail\UserEmailContact.
Definition at line 3051 of file User.php.
References getEmail(), getEmailAuthenticationTimestamp(), isAnon(), and load().
Referenced by canReceiveEmail(), confirmEmail(), isEmailConfirmationPending(), and setEmailWithConfirmation().
| MediaWiki\User\User::isHidden | ( | ) |
Check if user account is hidden.
Definition at line 1468 of file User.php.
References getBlock().
| MediaWiki\User\User::isItemLoaded | ( | $item, | |
| $all = 'all' ) |
Return whether an item has been loaded.
| string | $item | Item to check. Current possibilities:
|
| string | $all | 'all' to check if the whole object has been loaded or any other string to check if only the item is available (e.g. for optimisation) |
Definition at line 1040 of file User.php.
Referenced by getName(), and getRealName().
| MediaWiki\User\User::isLocked | ( | ) |
| MediaWiki\User\User::isNamed | ( | ) |
Is the user a normal non-temporary registered user?
Implements MediaWiki\Permissions\Authority.
Definition at line 3420 of file User.php.
References isRegistered(), isTemp(), and return.
Referenced by addToDatabase(), and saveSettings().
| MediaWiki\User\User::isNewbie | ( | ) |
Determine whether the user is a newbie.
Newbies are one of:
Definition at line 2718 of file User.php.
References isAllowed().
Referenced by toRateLimitSubject().
| MediaWiki\User\User::isPingLimitable | ( | ) |
Is this user subject to rate limiting?
Definition at line 1362 of file User.php.
References MediaWiki\MediaWikiServices\getInstance(), and toRateLimitSubject().
| MediaWiki\User\User::isRegistered | ( | ) |
Get whether the user is registered.
Implements MediaWiki\Permissions\Authority.
Definition at line 2077 of file User.php.
References getId(), and return.
Referenced by MediaWiki\Auth\AuthManager\autoCreateUser(), MediaWiki\Auth\AuthManager\beginAccountLink(), MediaWiki\Actions\WatchAction\checkCanExecute(), MediaWiki\Language\LanguageConverter\getUserVariant(), isAnon(), isNamed(), requiresHTTPS(), and spreadAnyEditBlock().
| MediaWiki\User\User::isSafeToLoad | ( | ) |
Test if it's safe to load this User object.
You should typically check this before using RequestContext::getUser in a method that might be called before the system has been fully initialized. If the object is unsafe, you should use an anonymous user: \code $user = RequestContext::getUser(); if (!$user->isSafeToLoad()) { $user = new User; } \endcode
Definition at line 363 of file User.php.
References $wgFullyInitialised.
Referenced by MediaWiki\Language\LanguageConverter\getUserVariant(), and MediaWiki\Block\BlockManager\trackBlockWithCookie().
| MediaWiki\User\User::isSystemUser | ( | ) |
Get whether the user is a system user.
A user is considered to exist as a non-system user if it can authenticate, or has an email set, or has a non-invalid token.
Definition at line 2117 of file User.php.
References getEmail(), MediaWiki\MediaWikiServices\getInstance(), and load().
| MediaWiki\User\User::isTemp | ( | ) |
Is the user an autocreated temporary user?
Implements MediaWiki\Permissions\Authority.
Definition at line 3406 of file User.php.
References MediaWiki\MediaWikiServices\getInstance(), if, and isTemp().
Referenced by MediaWiki\Auth\AuthManager\autoCreateUser(), MediaWiki\Actions\WatchAction\checkCanExecute(), MediaWiki\SpecialPage\ContributionsSpecialPage\getUserLinks(), isNamed(), isTemp(), and loadDefaults().
| MediaWiki\User\User::isValidPassword | ( | $password | ) |
Is the input a valid password for this user?
| string | $password | Desired password |
Definition at line 934 of file User.php.
References checkPasswordValidity().
|
static |
| MediaWiki\User\User::load | ( | $flags = IDBAccessObject::READ_NORMAL | ) |
Load the user table data for this object from the source given by mFrom.
| int | $flags | IDBAccessObject::READ_* constant bitfield |
Definition at line 380 of file User.php.
References $wgFullyInitialised, MediaWiki\MediaWikiServices\getInstance(), loadDefaults(), loadFromId(), MW_ENTRY_POINT, and MW_NO_SESSION.
Referenced by addToDatabase(), checkAndSetTouched(), getConfirmationToken(), getDBTouched(), getEmail(), getEmailAuthenticationTimestamp(), getRealName(), getToken(), getTouched(), invalidateEmail(), isEmailConfirmed(), isSystemUser(), saveSettings(), setCookies(), setEmail(), setEmailAuthenticationTimestamp(), setName(), setRealName(), setToken(), and spreadBlock().
| MediaWiki\User\User::loadDefaults | ( | $name = false, | |
| $actorId = null ) |
Set cached properties to default.
| string | false | $name | |
| int | null | $actorId |
Definition at line 1004 of file User.php.
References isTemp(), and wfTimestamp().
Referenced by load(), loadFromDatabase(), and loadFromId().
|
protected |
Load user data from shared cache, given mId has already been set.
Definition at line 535 of file User.php.
References $wgFullyInitialised, getCacheKey(), MediaWiki\MediaWikiServices\getInstance(), loadFromDatabase(), wfDebug(), and wfTimestamp().
Referenced by loadFromId().
| MediaWiki\User\User::loadFromDatabase | ( | $flags = IDBAccessObject::READ_LATEST | ) |
Load user data from the database.
$this->mId must be set, this is how the user is identified.
| int | $flags | IDBAccessObject::READ_* constant bitfield |
Definition at line 1088 of file User.php.
References MediaWiki\MediaWikiServices\getInstance(), loadDefaults(), and loadFromRow().
Referenced by addToDatabase(), loadFromCache(), and loadFromId().
| MediaWiki\User\User::loadFromId | ( | $flags = IDBAccessObject::READ_NORMAL | ) |
Load user table data, given mId has already been set.
| int | $flags | IDBAccessObject::READ_* constant bitfield |
Definition at line 481 of file User.php.
References loadDefaults(), loadFromCache(), and loadFromDatabase().
Referenced by MediaWiki\Auth\AuthManager\autoCreateUser(), and load().
|
protected |
Initialize this object from a row from the user table.
| stdClass | $row | Row from the user table to load. |
| array | null | $data | Further user data to load into the object |
user_groups Array of arrays or stdClass result rows out of the user_groups table. Previously you were supposed to pass an array of strings here, but we also need expiry info nowadays, so an array of strings is ignored.
Definition at line 1134 of file User.php.
References MediaWiki\MediaWikiServices\getInstance(), setItemLoaded(), wfTimestamp(), and wfTimestampOrNull().
Referenced by loadFromDatabase(), and newFromRow().
|
protected |
| MediaWiki\User\User::logout | ( | ) |
|
protected |
Build additional update conditions to protect against race conditions using a compare-and-set (CAS) mechanism based on comparing $this->mTouched with the user_touched field.
| IReadableDatabase | $db |
Definition at line 1258 of file User.php.
References Wikimedia\Rdbms\Platform\ISQLPlatform\timestamp().
Referenced by checkAndSetTouched(), and saveSettings().
| MediaWiki\User\User::matchEditToken | ( | $val, | |
| $salt = '', | |||
| $request = null, | |||
| $maxage = null ) |
Check given value against the token value stored in the session.
A match should confirm that the form was submitted from the user's own login session, not a form submission from a third-party site.
| string | null | $val | Input value to compare |
| string | array | $salt | Optional function-specific data for hashing |
| WebRequest | null | $request | Object to use, or null to use the global request |
| int | null | $maxage | Fail tokens older than this, in seconds |
Definition at line 2777 of file User.php.
References $request, and getEditTokenObject().
|
static |
Factory function for fatal permission-denied errors.
| string | $permission | User right required |
Definition at line 3191 of file User.php.
References MediaWiki\MediaWikiServices\getInstance(), and newFatalPermissionDeniedStatus().
Referenced by newFatalPermissionDeniedStatus().
|
static |
Static factory method for creation from a given actor ID.
| int | $id | Valid actor ID |
Definition at line 653 of file User.php.
References MediaWiki\MediaWikiServices\getInstance().
|
static |
Static factory method for creation from an ID, name, and/or actor ID.
This does not check that the ID, name, and actor ID all correspond to the same user.
| int | null | $userId | User ID, if known |
| string | null | $userName | User name, if known |
| int | null | $actorId | Actor ID, if known |
| string | false | $dbDomain | remote wiki to which the User/Actor ID applies, or false if none |
Definition at line 702 of file User.php.
References MediaWiki\MediaWikiServices\getInstance().
|
static |
Factory method to fetch whichever user has a given email confirmation code.
This code is generated when an account is created or its e-mail address has changed.
If the code is invalid or has expired, returns NULL.
| string | $code | Confirmation code |
| int | $flags | IDBAccessObject::READ_* bitfield |
Definition at line 723 of file User.php.
References MediaWiki\MediaWikiServices\getInstance().
|
static |
Static factory method for creation from a given user ID.
| int | $id | Valid user ID |
Definition at line 636 of file User.php.
References MediaWiki\MediaWikiServices\getInstance().
Referenced by FixUserRegistration\execute(), MigrateUserGroup\execute(), RemoveInvalidEmails\execute(), WrapOldPasswords\execute(), and MediaWiki\User\Options\UserOptionsUpdateJob\run().
|
static |
Returns a User object corresponding to the given UserIdentity.
| UserIdentity | $identity |
Definition at line 672 of file User.php.
References MediaWiki\MediaWikiServices\getInstance().
Referenced by MediaWiki\User\UserGroupManager\getUserEffectiveGroups().
|
static |
This is slightly less efficient than newFromId(), so use newFromId() if you have both an ID and a name handy.
| string | $name | Username, validated by Title::newFromText() |
| string | bool | $validate | Validate username.Type of validation to use:
|
Definition at line 610 of file User.php.
References MediaWiki\MediaWikiServices\getInstance(), MediaWiki\User\UserRigorOptions\RIGOR_CREATABLE, MediaWiki\User\UserRigorOptions\RIGOR_NONE, MediaWiki\User\UserRigorOptions\RIGOR_USABLE, and MediaWiki\User\UserRigorOptions\RIGOR_VALID.
Referenced by DeleteBatch\execute(), EditCLI\execute(), ImportImages\execute(), ImportSiteScripts\execute(), ImportTextFiles\execute(), InvalidateUserSessions\execute(), MakeTestEdits\execute(), MoveBatch\execute(), Protect\execute(), Undelete\execute(), UppercaseTitlesForUnicodeTransition\execute(), MediaWiki\User\BotPassword\login(), and MediaWiki\Specials\SpecialEmailUser\userForm().
|
static |
Create a new user object from a user row.
The row should have the following fields from the user table in it:
| stdClass | $row | A row from the user table |
| array | null | $data | Further data to load into the object (see User::loadFromRow for valid keys) |
Definition at line 758 of file User.php.
References loadFromRow().
Referenced by MediaWiki\User\UserArrayFromResult\setCurrent().
|
static |
|
static |
Get a SelectQueryBuilder with the tables, fields and join conditions needed to create a new User object.
The return value is a plain SelectQueryBuilder, not a UserSelectQueryBuilder. That way, there is no need for an ActorStore.
Definition at line 3161 of file User.php.
References Wikimedia\Rdbms\IReadableDatabase\newSelectQueryBuilder().
|
static |
Static factory method for creation of a "system" user from username.
A "system" user is an account that's used to attribute logged actions taken by MediaWiki itself, as opposed to a bot or human user. Examples might include the 'Maintenance script' or 'Conversion script' accounts used by various scripts in the maintenance/ directory or accounts such as 'MediaWiki message delivery' used by the MassMessage extension.
This can optionally create the user if it doesn't exist, and "steal" the account if it does exist.
"Stealing" an existing user is intended to make it impossible for normal authentication processes to use the account, effectively disabling the account for normal use:
System users should usually be listed in $wgReservedUsernames.
| string | $name | Username |
| array | $options | Options are:
|
Definition at line 808 of file User.php.
References MediaWiki\MediaWikiServices\getInstance(), MediaWiki\User\UserRigorOptions\RIGOR_CREATABLE, MediaWiki\User\UserRigorOptions\RIGOR_NONE, MediaWiki\User\UserRigorOptions\RIGOR_USABLE, MediaWiki\User\UserRigorOptions\RIGOR_VALID, and wfDeprecatedMsg().
Referenced by AddChangeTag\execute(), BlockUsers\execute(), CleanupCaps\execute(), CleanupSpam\execute(), CompareLanguageConverterOutput\execute(), CreateAndPromote\execute(), DeleteBatch\execute(), DeleteDefaultMessages\execute(), DeleteEqualMessages\execute(), DemoteIneligibleUsers\execute(), DumpIterator\execute(), DumpRenderer\execute(), EditCLI\execute(), ImportImages\execute(), ImportSiteScripts\execute(), ImportTextFiles\execute(), MoveBatch\execute(), Protect\execute(), RenameUser\execute(), RenameUsersMatchingPattern\execute(), RollbackEdits\execute(), Undelete\execute(), and UppercaseTitlesForUnicodeTransition\execute().
| MediaWiki\User\User::pingLimiter | ( | $action = 'edit', | |
| $incrBy = 1 ) |
Primitive rate limits: enforce maximum actions per time period to put a brake on flooding.
The method generates both a generic profiling point and a per action one (suffix being "-$action").
| string | $action | Action to enforce; 'edit' if unspecified |
| int | $incrBy | Positive amount to increment counter by [defaults to 1] |
Definition at line 1383 of file User.php.
Referenced by MediaWiki\User\PasswordReset\execute().
| MediaWiki\User\User::probablyCan | ( | string | $action, |
| PageIdentity | $target, | ||
| ?PermissionStatus | $status = null ) |
| string | $action | |
| PageIdentity | $target | |
| PermissionStatus | null | $status |
Implements MediaWiki\Permissions\Authority.
Definition at line 3282 of file User.php.
References probablyCan(), and return.
Referenced by probablyCan().
|
static |
| string | $dbDomain | |
| int | $userId |
Definition at line 511 of file User.php.
References MediaWiki\MediaWikiServices\getInstance().
| MediaWiki\User\User::requiresHTTPS | ( | ) |
Determine based on the wiki configuration and the user's options, whether this user must be over HTTPS no matter what.
Definition at line 2042 of file User.php.
References MediaWiki\MainConfigNames\ForceHTTPS, MediaWiki\MediaWikiServices\getInstance(), isRegistered(), and MediaWiki\MainConfigNames\SecureLogin.
| MediaWiki\User\User::resetTokenFromOption | ( | $oname | ) |
Reset a token stored in the preferences (like the watchlist one).
Does not save user's preferences (similarly to UserOptionsManager::setOption()).
| string | $oname | The option name to reset the token in |
Definition at line 2002 of file User.php.
References MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\MainConfigNames\HiddenPrefs.
| MediaWiki\User\User::saveSettings | ( | ) |
Save this user's settings into the database.
Definition at line 2322 of file User.php.
References Wikimedia\Rdbms\IDatabase\affectedRows(), clearSharedCache(), MediaWiki\MediaWikiServices\getInstance(), getUserPage(), isNamed(), load(), makeUpdateConditions(), Wikimedia\Rdbms\IDatabase\newUpdateQueryBuilder(), Wikimedia\Rdbms\Platform\ISQLPlatform\timestamp(), and Wikimedia\Rdbms\Platform\ISQLPlatform\timestampOrNull().
Referenced by MediaWiki\Auth\AuthManager\autoCreateUser(), MediaWiki\Session\SessionManager\invalidateSessionsForUser(), and sendConfirmationMail().
| MediaWiki\User\User::scheduleSpreadBlock | ( | ) |
Schedule a deferred update which will block the IP address of the current user, if they are blocked with the autoblocking option.
Definition at line 2607 of file User.php.
References spreadAnyEditBlock().
| MediaWiki\User\User::sendConfirmationMail | ( | $type = 'created' | ) |
Generate a new e-mail confirmation token and send a confirmation/invalidation mail to the user's given address.
Any preexisting e-mail confirmation token will be invalidated.
| string | $type | Message to send, either "created", "changed" or "set" |
Definition at line 2789 of file User.php.
References getConfirmationToken(), getConfirmationTokenUrl(), MediaWiki\MediaWikiServices\getInstance(), getInvalidationTokenUrl(), getUser(), and saveSettings().
Referenced by setEmailWithConfirmation().
| MediaWiki\User\User::sendMail | ( | $subject, | |
| $body, | |||
| $from = null, | |||
| $replyto = null ) |
Send an e-mail to this user's account.
Does not check for confirmed status or validity.
| string | $subject | Message subject |
| string | string[] | $body | Message body or array containing keys text and html |
| User | null | $from | Optional sending user; if unspecified, default $wgPasswordSender will be used. |
| MailAddress | null | $replyto | Reply-To address |
Definition at line 2820 of file User.php.
References MediaWiki\MediaWikiServices\getInstance(), MediaWiki\MainConfigNames\PasswordSender, and wfMessage().
| MediaWiki\User\User::setActorId | ( | int | $actorId | ) |
Sets the actor id.
For use by ActorStore only. Should be removed once callers of getActorId() have been migrated to using ActorNormalization.
| int | $actorId |
Definition at line 1594 of file User.php.
References setItemLoaded().
| MediaWiki\User\User::setCookies | ( | $request = null, | |
| $secure = null, | |||
| $rememberMe = false ) |
Persist this user's session (e.g.
set cookies)
| WebRequest | null | $request | WebRequest object to use; the global request will be used if null is passed. |
| bool | null | $secure | Whether to force secure/insecure cookies or use default |
| bool | $rememberMe | Whether to add a Token cookie for elongated sessions |
Definition at line 2237 of file User.php.
References $request, getRequest(), and load().
| MediaWiki\User\User::setEmail | ( | string | $str | ) |
Set the user's e-mail address.
| string | $str | New e-mail address |
Definition at line 1872 of file User.php.
References getEmail(), invalidateEmail(), and load().
Referenced by setEmailWithConfirmation().
| MediaWiki\User\User::setEmailAuthenticationTimestamp | ( | $timestamp | ) |
Set the e-mail authentication timestamp.
| string | null | $timestamp | TS::MW timestamp |
Definition at line 3008 of file User.php.
References load().
Referenced by confirmEmail(), and invalidateEmail().
| MediaWiki\User\User::setEmailWithConfirmation | ( | string | $str | ) |
Set the user's e-mail address and send a confirmation mail if needed.
| string | $str | New e-mail address |
Definition at line 1889 of file User.php.
References MediaWiki\MainConfigNames\EmailAuthentication, MediaWiki\MainConfigNames\EnableEmail, getEmail(), MediaWiki\MediaWikiServices\getInstance(), isEmailConfirmed(), sendConfirmationMail(), and setEmail().
| MediaWiki\User\User::setId | ( | $v | ) |
Set the user and reload all fields according to a given ID.
| int | $v | User ID to reload |
Definition at line 1502 of file User.php.
References clearInstanceCache().
Referenced by MediaWiki\Auth\AuthManager\autoCreateUser().
| MediaWiki\User\User::setItemLoaded | ( | $item | ) |
Set that an item has been loaded.
| string | $item |
Definition at line 1052 of file User.php.
Referenced by loadFromRow(), and setActorId().
| MediaWiki\User\User::setName | ( | $str | ) |
Set the user name.
This does not reload fields from the database according to the given name. Rather, it is used to create a temporary "nonexistent user" for later addition to the database. It can also be used to set the IP address for an anonymous user to something other than the current remote IP.
| string | $str | New user name to set |
Definition at line 1539 of file User.php.
References load().
Referenced by MediaWiki\User\UserFactory\newAnonymous().
| MediaWiki\User\User::setRealName | ( | string | $str | ) |
| MediaWiki\User\User::setToken | ( | $token = false | ) |
Set the random token (used for persistent authentication) Called from loadDefaults() among other places.
| string | false | $token | If specified, set the token to this value |
Definition at line 1832 of file User.php.
References load().
Referenced by addToDatabase(), getToken(), and MediaWiki\Session\SessionManager\invalidateSessionsForUser().
| MediaWiki\User\User::spreadAnyEditBlock | ( | ) |
If this user is logged-in and blocked, block any IP address they've successfully logged in from.
Calls the "SpreadAnyEditBlock" hook, so this may block the IP address using a non-core blocking mechanism.
Definition at line 2622 of file User.php.
References getBlock(), isRegistered(), and spreadBlock().
Referenced by scheduleSpreadBlock().
|
protected |
If this (non-anonymous) user is blocked, block the IP address they've successfully logged in from.
| Block | $block | The active block on the user |
Definition at line 2644 of file User.php.
References load(), and wfDebug().
Referenced by spreadAnyEditBlock().
| MediaWiki\User\User::toRateLimitSubject | ( | ) |
Definition at line 1391 of file User.php.
References getRequest(), isAllowed(), and isNewbie().
Referenced by isPingLimitable().
| MediaWiki\User\User::touch | ( | ) |
Update the "touched" timestamp for the user.
This is useful on various login/logout events when making sure that a browser or proxy that has multiple tenants does not suffer cache pollution where the new user sees the old users content. The value of getTouched() is checked when determining 304 vs 200 responses. Unlike invalidateCache(), this preserves the User object cache and avoids database writes.
Definition at line 1675 of file User.php.
References getId(), and MediaWiki\MediaWikiServices\getInstance().
Referenced by invalidateCache().
| MediaWiki\User\User::useFilePatrol | ( | ) |
Check whether to enable new files patrol features for this user.
Definition at line 2170 of file User.php.
References MediaWiki\MediaWikiServices\getInstance(), isAllowedAny(), MediaWiki\MainConfigNames\UseFilePatrol, and MediaWiki\MainConfigNames\UseRCPatrol.
Referenced by MediaWiki\RecentChanges\ChangesList\isUnpatrolled().
| MediaWiki\User\User::useNPPatrol | ( | ) |
Check whether to enable new pages patrol features for this user.
Definition at line 2155 of file User.php.
References MediaWiki\MediaWikiServices\getInstance(), isAllowedAny(), MediaWiki\MainConfigNames\UseNPPatrol, and MediaWiki\MainConfigNames\UseRCPatrol.
Referenced by MediaWiki\RecentChanges\ChangesList\isUnpatrolled(), and MediaWiki\Preferences\DefaultPreferencesFactory\rcPreferences().
| MediaWiki\User\User::useRCPatrol | ( | ) |
Check whether to enable recent changes patrol features for this user.
Definition at line 2145 of file User.php.
References MediaWiki\MediaWikiServices\getInstance(), isAllowedAny(), and MediaWiki\MainConfigNames\UseRCPatrol.
Referenced by MediaWiki\RecentChanges\ChangesList\isUnpatrolled(), MediaWiki\Preferences\DefaultPreferencesFactory\rcPreferences(), and MediaWiki\Preferences\DefaultPreferencesFactory\watchlistPreferences().
| MediaWiki\User\User::validateCache | ( | $timestamp | ) |
Validate the cache for this account.
| string | $timestamp | A timestamp in TS::MW format |
Definition at line 1709 of file User.php.
References getTouched().
| int null MediaWiki\User\User::$mActorId |
|
staticprotected |
List of member variables which are saved to the shared cache (memcached).
Any operation which changes the corresponding database fields must call a cache-clearing function.
|
protected |
|
protected |
| string MediaWiki\User\User::$mFrom |
Initialization data source if mLoadedItems!==true.
May be one of:
Use the User::newFrom*() family of functions to set this.
|
protected |
|
protected |
|
protected |
| string MediaWiki\User\User::$mTouched |
|
protected |
| const MediaWiki\User\User::INVALID_TOKEN = '*** INVALID ***' |
| const MediaWiki\User\User::MAINTENANCE_SCRIPT_USER = 'Maintenance script' |
Username used for various maintenance scripts.
Definition at line 164 of file User.php.
Referenced by AddChangeTag\execute(), BlockUsers\execute(), CompareLanguageConverterOutput\execute(), CreateAndPromote\execute(), DemoteIneligibleUsers\execute(), DumpIterator\execute(), DumpRenderer\execute(), EditCLI\execute(), ImportImages\execute(), ImportTextFiles\execute(), Protect\execute(), RenameUser\execute(), RenameUsersMatchingPattern\execute(), RollbackEdits\execute(), and UppercaseTitlesForUnicodeTransition\execute().
| const MediaWiki\User\User::READ_EXCLUSIVE = IDBAccessObject::READ_EXCLUSIVE |
| const MediaWiki\User\User::READ_LOCKING = IDBAccessObject::READ_LOCKING |
| const MediaWiki\User\User::TOKEN_LENGTH = 32 |
Number of characters required for the user_token field.
Definition at line 147 of file User.php.
Referenced by MediaWiki\User\BotPasswordStore\insertBotPassword(), and MediaWiki\User\BotPasswordStore\updateBotPassword().