Special page to allow managing user group membership. More...

Inherits MediaWiki\SpecialPage\SpecialPage.

Collaboration diagram for MediaWiki\Specials\SpecialUserRights:

[legend]

Public Member Functions
	__construct (UserGroupManagerFactory $userGroupManagerFactory=null, UserNameUtils $userNameUtils=null, UserNamePrefixSearch $userNamePrefixSearch=null, UserFactory $userFactory=null, ActorStoreFactory $actorStoreFactory=null, WatchlistManager $watchlistManager=null, TempUserConfig $tempUserConfig=null)

	canProcessExpiries ()
	Returns true if this user rights form can set and change user group expiries.

	doesWrites ()
	Indicates whether POST requests to this special page require write access to the wiki.

	doSaveUserGroups ( $user, array $add, array $remove, string $reason='', array $tags=[], array $groupExpiries=[])
	Save user groups changes in the database.

	execute ( $par)
	Manage forms to be shown according to posted data.

	fetchUser ( $username, $writing=true)
	Normalize the input username, which may be local or remote, and return a user identity object, use it on other services for manipulating rights.

	makeGroupNameList ( $ids)

	prefixSearchSubpages ( $search, $limit, $offset)
	Return an array of subpages beginning with $search that this special page will accept.

	userCanChangeRights (UserIdentity $targetUser, $checkIfSelf=true)
	Check whether the current user (from context) can change the target user's rights.

Public Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
	__construct ( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false)
	Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called.

	addHelpLink ( $to, $overrideBaseUrl=false)
	Adds help link with an icon via page indicators.

	checkPermissions ()
	Checks if userCanExecute, and if not throws a PermissionsError.

	checkReadOnly ()
	If the wiki is currently in readonly mode, throws a ReadOnlyError.

	getAssociatedNavigationLinks ()
	Return an array of strings representing page titles that are discoverable to end users via UI.

	getAuthority ()
	Shortcut to get the Authority executing this instance.

	getConfig ()
	Shortcut to get main config object.

	getContentLanguage ()
	Shortcut to get content language.

	getContext ()
	Gets the context this SpecialPage is executed in.

	getDescription ()
	Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages.

	getFinalGroupName ()
	Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side.

	getFullTitle ()
	Return the full title, including $par.

	getLanguage ()
	Shortcut to get user's language.

	getLinkRenderer ()

	getLocalName ()
	Get the localised name of the special page.

	getName ()
	Get the canonical, unlocalized name of this special page without namespace.

	getOutput ()
	Get the OutputPage being used for this instance.

	getPageTitle ( $subpage=false)
	Get a self-referential title object.

	getRequest ()
	Get the WebRequest being used for this instance.

	getRestriction ()
	Get the permission that a user must have to execute this page.

	getShortDescription (string $path='')
	Similar to getDescription, but takes into account subpages and designed for display in tabs.

	getSkin ()
	Shortcut to get the skin being used for this instance.

	getUser ()
	Shortcut to get the User executing this instance.

	including ( $x=null)
	Whether the special page is being evaluated via transclusion.

	isCached ()
	Is this page cached? Expensive pages are cached or disabled in miser mode.

	isExpensive ()
	Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode.

	isIncludable ()
	Whether it's allowed to transclude the special page via {{Special:Foo/params}}.

	isListed ()
	Whether this special page is listed in Special:SpecialPages.

	isRestricted ()
	Can be overridden by subclasses with more complicated permissions schemes.

	maxIncludeCacheTime ()
	How long to cache page when it is being included.

	msg ( $key,... $params)
	Wrapper around wfMessage that sets the current context.

	requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
	If the user is not logged in, throws UserNotLoggedIn error.

	requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin', bool $alwaysRedirectToLoginPage=false)
	If the user is not logged in or is a temporary user, throws UserNotLoggedIn.

	run ( $subPage)
	Entry point.

	setContentLanguage (Language $contentLanguage)
	Set content language.

	setContext ( $context)
	Sets the context this SpecialPage is executed in.

	setHookContainer (HookContainer $hookContainer)

	setLinkRenderer (LinkRenderer $linkRenderer)

	setSpecialPageFactory (SpecialPageFactory $specialPageFactory)

	userCanExecute (User $user)
	Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).

Static Public Member Functions
static	expiryToTimestamp ( $expiry)
	Converts a user group membership expiry string into a timestamp.

Static Public Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
static	getSafeTitleFor ( $name, $subpage=false)
	Get a localised Title object for a page name with a possibly unvalidated subpage.

static	getTitleFor ( $name, $subpage=false, $fragment='')
	Get a localised Title object for a specified special page name If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below.

static	getTitleValueFor ( $name, $subpage=false, $fragment='')
	Get a localised TitleValue object for a specified special page name.

static	newSearchPage (User $user)
	Get the users preferred search page.

Protected Member Functions
	addLogEntry ( $user, array $oldGroups, array $newGroups, string $reason, array $tags, array $oldUGMs, array $newUGMs)
	Add a rights log entry for an action.

	changeableGroups ()

	getGroupName ()
	Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

	saveUserGroups (string $reason, UserIdentity $user)
	Save user groups changes in the database.

	showEditUserGroupsForm ( $user, $groups, $groupMemberships)
	Show the form to edit group memberships.

	showLogFragment ( $user, $output)
	Show a rights log fragment for the specified user.

	switchForm ()
	Display a HTMLUserTextField form to allow searching for a named user only.

Protected Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links.

	afterExecute ( $subPage)
	Gets called after.

	authorizeAction (?string $action=null)
	Utility function for authorizing an action to be performed by the special page.

	beforeExecute ( $subPage)
	Gets called before.

	buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
	Generate (prev x\| next x) (20\|50\|100...) type links for paging.

	checkLoginSecurityLevel ( $level=null)
	Verifies that the user meets the security level, possibly reauthenticating them in the process.

	displayRestrictionError ()
	Output an error message telling the user what access level they have to have.

	getAuthManager ()

	getCacheTTL ()

	getHookContainer ()

	getHookRunner ()

	getLoginSecurityLevel ()
	Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g.

	getRobotPolicy ()
	Return the robot policy.

	getSpecialPageFactory ()

	getSubpagesForPrefixSearch ()
	Return an array of subpages that this special page will accept for prefix searches.

	outputHeader ( $summaryMessageKey='')
	Outputs a summary message on top of special pages By default the message key is the canonical name of the special page May be overridden, i.e.

	prefixSearchString ( $search, $limit, $offset, SearchEngineFactory $searchEngineFactory=null)
	Perform a regular substring search for prefixSearchSubpages.

	setAuthManager (AuthManager $authManager)
	Set the injected AuthManager from the special page constructor.

	setHeaders ()
	Sets headers - this should be called from the execute() method of all derived classes!

	setReauthPostData (array $data)
	Record preserved POST data after a reauthentication.

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.

Static Protected Member Functions
static	serialiseUgmForLog ( $ugm)
	Serialise a UserGroupMembership object for storage in the log_params section of the logging table.

Static Protected Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
static	prefixSearchArray ( $search, $limit, array $subpages, $offset)
	Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query).

Protected Attributes
bool	$isself = false

null UserIdentity	$mFetchedUser = null
	The user object of the target username or null.

null string	$mTarget
	The target of the local right-adjuster's interest.

Protected Attributes inherited from MediaWiki\SpecialPage\SpecialPage
IContextSource	$mContext
	Current request context.

bool	$mIncludable
	Whether the special page can be included in an article.

bool	$mIncluding
	Whether or not this special page is being included from an article.

string	$mName
	The canonical name of this special page Also used as the message key for the default.

string	$mRestriction
	Minimum user level required to access this page, or "" for anyone.

Detailed Description

Special page to allow managing user group membership.

Definition at line 59 of file SpecialUserRights.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Specials\SpecialUserRights::__construct	(	UserGroupManagerFactory	$userGroupManagerFactory = null,
		UserNameUtils	$userNameUtils = null,
		UserNamePrefixSearch	$userNamePrefixSearch = null,
		UserFactory	$userFactory = null,
		ActorStoreFactory	$actorStoreFactory = null,
		WatchlistManager	$watchlistManager = null,
		TempUserConfig	$tempUserConfig = null )

Parameters

UserGroupManagerFactory \| null	$userGroupManagerFactory
UserNameUtils \| null	$userNameUtils
UserNamePrefixSearch \| null	$userNamePrefixSearch
UserFactory \| null	$userFactory
ActorStoreFactory \| null	$actorStoreFactory
WatchlistManager \| null	$watchlistManager
TempUserConfig \| null	$tempUserConfig

Definition at line 95 of file SpecialUserRights.php.

References MediaWiki\MediaWikiServices\getInstance().

Member Function Documentation

◆ addLogEntry()

MediaWiki\Specials\SpecialUserRights::addLogEntry	(		$user,
		array	$oldGroups,
		array	$newGroups,
		string	$reason,
		array	$tags,
		array	$oldUGMs,
		array	$newUGMs )

protected

Add a rights log entry for an action.

Parameters

UserIdentity	$user
array	$oldGroups
array	$newGroups
string	$reason
string[]	$tags	Change tags for the log entry
array	$oldUGMs	Associative array of (group name => UserGroupMembership)
array	$newUGMs	Associative array of (group name => UserGroupMembership)

Definition at line 558 of file SpecialUserRights.php.

References MediaWiki\SpecialPage\SpecialPage\getUser(), NS_USER, and MediaWiki\Specials\SpecialUserRights\serialiseUgmForLog().

Referenced by MediaWiki\Specials\SpecialUserRights\doSaveUserGroups().

◆ canProcessExpiries()

MediaWiki\Specials\SpecialUserRights::canProcessExpiries ( )

Returns true if this user rights form can set and change user group expiries.

Subclasses may wish to override this to return false.

Returns: bool

Definition at line 310 of file SpecialUserRights.php.

Referenced by MediaWiki\Specials\SpecialUserRights\saveUserGroups().

◆ changeableGroups()

MediaWiki\Specials\SpecialUserRights::changeableGroups ( )

protected

Returns: array [ 'add' => [ addablegroups ], 'remove' => [ removablegroups ], 'add-self' => [ addablegroups to self ], 'remove-self' => [ removable groups from self ] ]

Definition at line 1142 of file SpecialUserRights.php.

References MediaWiki\SpecialPage\SpecialPage\getAuthority(), and MediaWiki\SpecialPage\SpecialPage\getContext().

◆ doesWrites()

MediaWiki\Specials\SpecialUserRights::doesWrites ( )

Indicates whether POST requests to this special page require write access to the wiki.

Subclasses must override this method to return true if any of the operations that they perform on POST requests are not "safe" per RFC 7231 section 4.2.1. A subclass's operation is "safe" if it is essentially read-only, i.e. the client does not request nor expect any state change that would be observable in the responses to future requests.

Implementations of this method must always return the same value, regardless of the parameters passed to the constructor or system state.

When handling GET/HEAD requests, subclasses should only perform "safe" operations. Note that some subclasses might only perform "safe" operations even for POST requests, particularly in the case where large input parameters are required.

Stability: stable: to override

Returns: bool

Since: 1.27

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 116 of file SpecialUserRights.php.

◆ doSaveUserGroups()

MediaWiki\Specials\SpecialUserRights::doSaveUserGroups	(		$user,
		array	$add,
		array	$remove,
		string	$reason = '',
		array	$tags = [],
		array	$groupExpiries = [] )

Save user groups changes in the database.

This function does not throw errors; instead, it ignores groups that the performer does not have permission to set.

This function can be used without submitting the special page

Parameters

UserIdentity	$user
string[]	$add	Array of groups to add
string[]	$remove	Array of groups to remove
string	$reason	Reason for group change
string[]	$tags	Array of change tags to add to the log entry
	array<string,?string>	$groupExpiries Associative array of (group name => expiry), containing only those groups that are to have new expiry values set

Returns: array Tuple of added, then removed groups

Definition at line 442 of file SpecialUserRights.php.

References MediaWiki\Specials\SpecialUserRights\$isself, MediaWiki\Specials\SpecialUserRights\addLogEntry(), MediaWiki\User\UserGroupManager\addUserToGroup(), MediaWiki\SpecialPage\SpecialPage\getAuthority(), MediaWiki\User\UserGroupManager\getGroupsChangeableBy(), MediaWiki\SpecialPage\SpecialPage\getHookRunner(), MediaWiki\SpecialPage\SpecialPage\getUser(), MediaWiki\User\UserGroupManager\getUserGroupMemberships(), MediaWiki\User\UserGroupManager\getUserGroups(), MediaWiki\User\UserGroupManager\removeUserFromGroup(), and wfDebug().

Referenced by MediaWiki\Specials\SpecialUserRights\saveUserGroups().

◆ execute()

MediaWiki\Specials\SpecialUserRights::execute ( $par )

Manage forms to be shown according to posted data.

Depending on the submit button used, call a form or a save function.

Parameters

string | null $par String if any subpage provided, else null

Exceptions

UserBlockedError|PermissionsError

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 165 of file SpecialUserRights.php.

◆ expiryToTimestamp()

static MediaWiki\Specials\SpecialUserRights::expiryToTimestamp ( $expiry )

static

Converts a user group membership expiry string into a timestamp.

Words like 'existing' or 'other' should have been filtered out before calling this function.

Parameters

string $expiry

Returns: string|null|false A string containing a valid timestamp, or null if the expiry is infinite, or false if the timestamp is not valid

Definition at line 323 of file SpecialUserRights.php.

References wfIsInfinity(), and wfTimestamp().

Referenced by MediaWiki\Api\ApiUserrights\execute(), and MediaWiki\Specials\SpecialUserRights\saveUserGroups().

◆ fetchUser()

MediaWiki\Specials\SpecialUserRights::fetchUser	(		$username,
			$writing = true )

Normalize the input username, which may be local or remote, and return a user identity object, use it on other services for manipulating rights.

Side effects: error output for invalid access

Parameters

string	$username
bool	$writing

Returns: Status

Definition at line 627 of file SpecialUserRights.php.

References MediaWiki\SpecialPage\SpecialPage\getAuthority(), MediaWiki\SpecialPage\SpecialPage\getConfig(), MediaWiki\MainConfigNames\LocalDatabases, and MediaWiki\MainConfigNames\UserrightsInterwikiDelimiter.

Referenced by MediaWiki\Specials\SpecialUserRights\execute().

◆ getGroupName()

MediaWiki\Specials\SpecialUserRights::getGroupName ( )

protected

Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

Stability: stable: to override

Returns: string

Since: 1.21

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 1195 of file SpecialUserRights.php.

◆ makeGroupNameList()

MediaWiki\Specials\SpecialUserRights::makeGroupNameList ( $ids )

Since: 1.15

Parameters

array $ids

Returns: string

Definition at line 711 of file SpecialUserRights.php.

References MediaWiki\SpecialPage\SpecialPage\msg().

◆ prefixSearchSubpages()

MediaWiki\Specials\SpecialUserRights::prefixSearchSubpages	(	$search,
		$limit,
		$offset )

Return an array of subpages beginning with $search that this special page will accept.

Parameters

string	$search	Prefix to search for
int	$limit	Maximum number of results to return (usually 10)
int	$offset	Number of results to skip (usually 0)

Returns: string[] Matching subpages

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 1184 of file SpecialUserRights.php.

References MediaWiki\User\UserNamePrefixSearch\AUDIENCE_PUBLIC.

◆ saveUserGroups()

MediaWiki\Specials\SpecialUserRights::saveUserGroups	(	string	$reason,
		UserIdentity	$user )

protected

Save user groups changes in the database.

Data comes from the editUserGroupsForm() form function

Parameters

string	$reason	Reason for group change
UserIdentity	$user

Returns: Status

Definition at line 347 of file SpecialUserRights.php.

References MediaWiki\Specials\SpecialUserRights\canProcessExpiries(), MediaWiki\Specials\SpecialUserRights\doSaveUserGroups(), MediaWiki\Specials\SpecialUserRights\expiryToTimestamp(), MediaWiki\User\UserIdentity\getName(), MediaWiki\SpecialPage\SpecialPage\getRequest(), MediaWiki\SpecialPage\SpecialPage\getUser(), MediaWiki\DAO\WikiAwareEntity\getWikiId(), NS_USER, and wfTimestampNow().

Referenced by MediaWiki\Specials\SpecialUserRights\execute().

◆ serialiseUgmForLog()

static MediaWiki\Specials\SpecialUserRights::serialiseUgmForLog ( $ugm )

staticprotected

Serialise a UserGroupMembership object for storage in the log_params section of the logging table.

Only keeps essential data, removing redundant fields.

Parameters

UserGroupMembership | null $ugm May be null if things get borked

Returns: array|null

Definition at line 541 of file SpecialUserRights.php.

Referenced by MediaWiki\Specials\SpecialUserRights\addLogEntry().

◆ showEditUserGroupsForm()

MediaWiki\Specials\SpecialUserRights::showEditUserGroupsForm	(	$user,
		$groups,
		$groupMemberships )

protected

Show the form to edit group memberships.

Parameters

UserIdentity	$user
string[]	$groups	Array of groups the user is in. Not used by this implementation anymore, but kept for backward compatibility with subclasses
UserGroupMembership[]	$groupMemberships	Associative array of (group name => UserGroupMembership object) containing the groups the user is in

Definition at line 758 of file SpecialUserRights.php.

References MediaWiki\Html\Html\closeElement(), MediaWiki\Html\element(), MediaWiki\SpecialPage\SpecialPage\getContext(), MediaWiki\SpecialPage\SpecialPage\getLanguage(), MediaWiki\SpecialPage\SpecialPage\getOutput(), MediaWiki\SpecialPage\SpecialPage\getPageTitle(), MediaWiki\SpecialPage\SpecialPage\getUser(), MediaWiki\Html\Html\input(), MediaWiki\SpecialPage\SpecialPage\msg(), and wfEscapeWikiText().

◆ showLogFragment()

MediaWiki\Specials\SpecialUserRights::showLogFragment	(		$user,
			$output )

protected

Show a rights log fragment for the specified user.

Parameters

UserIdentity	$user	User to show log for
OutputPage	$output	OutputPage to use

Definition at line 1169 of file SpecialUserRights.php.

References MediaWiki\Html\element(), and NS_USER.

◆ switchForm()

MediaWiki\Specials\SpecialUserRights::switchForm ( )

protected

Display a HTMLUserTextField form to allow searching for a named user only.

Definition at line 722 of file SpecialUserRights.php.

References MediaWiki\Specials\SpecialUserRights\$mTarget, MediaWiki\SpecialPage\SpecialPage\getContext(), MediaWiki\SpecialPage\SpecialPage\getTitleFor(), and wfScript().

Referenced by MediaWiki\Specials\SpecialUserRights\execute().

◆ userCanChangeRights()

MediaWiki\Specials\SpecialUserRights::userCanChangeRights	(	UserIdentity	$targetUser,
			$checkIfSelf = true )

Check whether the current user (from context) can change the target user's rights.

This function can be used without submitting the special page

Parameters

UserIdentity	$targetUser	User whose rights are being changed
bool	$checkIfSelf	If false, assume that the current user can add/remove groups defined in $wgGroupsAddToSelf / $wgGroupsRemoveFromSelf, without checking if it's the same as target user

Returns: bool

Definition at line 131 of file SpecialUserRights.php.

References MediaWiki\Specials\SpecialUserRights\$isself, MediaWiki\SpecialPage\SpecialPage\getAuthority(), MediaWiki\User\UserGroupManager\getGroupsChangeableBy(), MediaWiki\User\UserIdentity\getName(), MediaWiki\SpecialPage\SpecialPage\getUser(), MediaWiki\DAO\WikiAwareEntity\getWikiId(), and MediaWiki\User\UserIdentity\isRegistered().

Member Data Documentation

◆ $isself

bool MediaWiki\Specials\SpecialUserRights::$isself = false

protected

Definition at line 72 of file SpecialUserRights.php.

Referenced by MediaWiki\Specials\SpecialUserRights\doSaveUserGroups(), and MediaWiki\Specials\SpecialUserRights\userCanChangeRights().

◆ $mFetchedUser

null UserIdentity MediaWiki\Specials\SpecialUserRights::$mFetchedUser = null

protected

The user object of the target username or null.

Definition at line 70 of file SpecialUserRights.php.

Referenced by MediaWiki\Specials\SpecialUserRights\execute().

◆ $mTarget

null string MediaWiki\Specials\SpecialUserRights::$mTarget

protected

The target of the local right-adjuster's interest.

Can be gotten from either a GET parameter or a subpage-style parameter, so have a member variable for it.

Definition at line 66 of file SpecialUserRights.php.

Referenced by MediaWiki\Specials\SpecialUserRights\switchForm().

The documentation for this class was generated from the following file:

includes/specials/SpecialUserRights.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addLogEntry()

◆ canProcessExpiries()

◆ changeableGroups()

◆ doesWrites()

◆ doSaveUserGroups()

◆ execute()

◆ expiryToTimestamp()

◆ fetchUser()

◆ getGroupName()

◆ makeGroupNameList()

◆ prefixSearchSubpages()

◆ saveUserGroups()

◆ serialiseUgmForLog()

◆ showEditUserGroupsForm()

◆ showLogFragment()

◆ switchForm()

◆ userCanChangeRights()

Member Data Documentation

◆ $isself

◆ $mFetchedUser

◆ $mTarget