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

Inheritance diagram for UserrightsPage:

Collaboration diagram for UserrightsPage:

[legend]

Public Member Functions
	__construct ()

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

	changeableGroups ()
	Returns $this->getUser()->changeableGroups() More...

	doesWrites ()
	Indicates whether this special page may perform database writes. More...

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

	editUserGroupsForm ( $username)
	Edit user groups membership. More...

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

	fetchUser ( $username, $writing=true)
	Normalize the input username, which may be local or remote, and return a user (or proxy) object for manipulating it. More...

	getSuccessURL ()

	makeGroupNameList ( $ids)

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

	switchForm ()
	Output a form to allow searching for a user. More...

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

Public Member Functions inherited from 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. More...

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

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

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

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

	getConfig ()
	Shortcut to get main config object. More...

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

	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. More...

	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. More...

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

	getLanguage ()
	Shortcut to get user's language. More...

	getLinkRenderer ()

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

	getName ()
	Get the name of this Special Page. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

	listed ( $x=null)
	Get or set whether this special page is listed in Special:SpecialPages. More...

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

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

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

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

	run ( $subPage)
	Entry point. More...

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

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

	setLinkRenderer (LinkRenderer $linkRenderer)

	setListed ( $listed)
	Set whether this page is listed in Special:Specialpages, at run-time. More...

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

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

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

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. More...

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

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

	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'. More...

	saveUserGroups ( $username, $reason, $user)
	Save user groups changes in the database. More...

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

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

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

	afterExecute ( $subPage)
	Gets called after. More...

	beforeExecute ( $subPage)
	Gets called before. More...

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

	getCacheTTL ()

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

	getRobotPolicy ()
	Return the robot policy. More...

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

	prefixSearchString ( $search, $limit, $offset)
	Perform a regular substring search for prefixSearchSubpages. More...

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

Static Protected Member Functions
static	getAllGroups ()
	Returns an array of all groups that may be edited. More...

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

Static Protected Member Functions inherited from 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). More...

Protected Attributes
	$isself = false

	$mFetchedUser = null

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

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

	$mIncludable

	$mIncluding

	$mName

	$mRestriction

Private Member Functions
	canAdd ( $group)

	canRemove ( $group)

	groupCheckboxes ( $usergroups, $user)
	Adds a table with checkboxes where you can select what groups to add/remove. More...

Detailed Description

Special page to allow managing user group membership.

Definition at line 29 of file SpecialUserrights.php.

Constructor & Destructor Documentation

◆ __construct()

UserrightsPage::__construct ( )

Definition at line 43 of file SpecialUserrights.php.

Member Function Documentation

◆ addLogEntry()

UserrightsPage::addLogEntry	(	$user,
		$oldGroups,
		$newGroups,
		$reason,
		$tags,
		$oldUGMs,
		$newUGMs
	)

protected

Add a rights log entry for an action.

Parameters

User \| UserRightsProxy	$user
array	$oldGroups
array	$newGroups
array	$reason
array	$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 435 of file SpecialUserrights.php.

References $user, captcha-old\count, SpecialPage\getUser(), serialiseUgmForLog(), and use.

Referenced by doSaveUserGroups().

◆ canAdd()

UserrightsPage::canAdd ( $group )

private

Parameters

string $group The name of the group to check

Returns: bool Can we add the group?

Definition at line 969 of file SpecialUserrights.php.

References changeableGroups().

Referenced by groupCheckboxes().

◆ canProcessExpiries()

UserrightsPage::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 217 of file SpecialUserrights.php.

Referenced by groupCheckboxes(), and saveUserGroups().

◆ canRemove()

UserrightsPage::canRemove ( $group )

private

Parameters

string $group The name of the group to check

Returns: bool Can we remove the group?

Definition at line 956 of file SpecialUserrights.php.

References changeableGroups().

Referenced by groupCheckboxes(), and saveUserGroups().

◆ changeableGroups()

UserrightsPage::changeableGroups ( )

Returns $this->getUser()->changeableGroups()

Returns: array Array( 'add' => array( addablegroups ), 'remove' => array( removablegroups ), 'add-self' => array( addablegroups to self ), 'remove-self' => array( removable groups from self ) )

Definition at line 988 of file SpecialUserrights.php.

References SpecialPage\getUser().

Referenced by canAdd(), canRemove(), doSaveUserGroups(), and userCanChangeRights().

◆ doesWrites()

UserrightsPage::doesWrites ( )

Indicates whether this special page may perform database writes.

Returns: bool

Since: 1.27

Reimplemented from SpecialPage.

Definition at line 47 of file SpecialUserrights.php.

◆ doSaveUserGroups()

UserrightsPage::doSaveUserGroups	(	$user,
		$add,
		$remove,
		$reason = `''`,
		$tags = `[]`,
		$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.

Parameters

User \| UserRightsProxy	$user
array	$add	Array of groups to add
array	$remove	Array of groups to remove
string	$reason	Reason for group change
array	$tags	Array of change tags to add to the log entry
array	$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 328 of file SpecialUserrights.php.

References $isself, $user, addLogEntry(), array(), as, MediaWiki\Auth\AuthManager\callLegacyAuthPlugin(), changeableGroups(), SpecialPage\getUser(), Hooks\run(), use, and wfDebug().

Referenced by saveUserGroups().

◆ editUserGroupsForm()

UserrightsPage::editUserGroupsForm ( $username )

Edit user groups membership.

Parameters

string $username Name of the user.

Definition at line 472 of file SpecialUserrights.php.

References $user, $username, fetchUser(), SpecialPage\getOutput(), showEditUserGroupsForm(), and showLogFragment().

Referenced by execute().

◆ execute()

UserrightsPage::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 SpecialPage.

Definition at line 82 of file SpecialUserrights.php.

References $mFetchedUser, $mTarget, $out, $request, $user, SpecialPage\addHelpLink(), SpecialPage\checkReadOnly(), editUserGroupsForm(), Html\element(), fetchUser(), User\getCanonicalName(), SpecialPage\getOutput(), SpecialPage\getRequest(), SpecialPage\getSkin(), getSuccessURL(), SpecialPage\getUser(), SpecialPage\msg(), SpecialPage\outputHeader(), Html\rawElement(), saveUserGroups(), SpecialPage\setHeaders(), switchForm(), and text.

◆ expiryToTimestamp()

static UserrightsPage::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 230 of file SpecialUserrights.php.

References wfIsInfinity(), and wfTimestamp().

Referenced by ApiUserrights\execute(), and saveUserGroups().

◆ fetchUser()

UserrightsPage::fetchUser	(	$username,
		$writing = `true`
	)

Normalize the input username, which may be local or remote, and return a user (or proxy) object for manipulating it.

Side effects: error output for invalid access

Parameters

string	$username
bool	$writing

Returns: Status

Definition at line 500 of file SpecialUserrights.php.

References $name, $user, $username, captcha-old\count, User\getCanonicalName(), SpecialPage\getConfig(), SpecialPage\getUser(), list, StatusValue\newFatal(), UserRightsProxy\newFromName(), User\newFromName(), StatusValue\newGood(), UserRightsProxy\validDatabase(), wfWikiID(), UserRightsProxy\whoIs(), and User\whoIs().

Referenced by editUserGroupsForm(), and execute().

◆ getAllGroups()

static UserrightsPage::getAllGroups ( )

staticprotected

Returns an array of all groups that may be edited.

Returns: array Array of groups that may be edited.

Definition at line 757 of file SpecialUserrights.php.

References User\getAllGroups().

Referenced by groupCheckboxes(), and saveUserGroups().

◆ getGroupName()

UserrightsPage::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'.

Returns: string

Since: 1.21

Reimplemented from SpecialPage.

Definition at line 1022 of file SpecialUserrights.php.

◆ getSuccessURL()

UserrightsPage::getSuccessURL ( )

Definition at line 207 of file SpecialUserrights.php.

References SpecialPage\getPageTitle().

Referenced by execute().

◆ groupCheckboxes()

UserrightsPage::groupCheckboxes	(	$usergroups,
		$user
	)

private

Adds a table with checkboxes where you can select what groups to add/remove.

Parameters

array	$usergroups	Associative array of (group name as string => UserGroupMembership object) for groups the user belongs to
User	$user

Returns: Array with 2 elements: the XHTML table element with checkxboes, and whether any groups are changeable

Definition at line 770 of file SpecialUserrights.php.

References $attribs, $name, $ret, $t, $user, $value, as, canAdd(), canProcessExpiries(), canRemove(), Xml\checkLabel(), Xml\closeElement(), captcha-old\count, Xml\element(), getAllGroups(), UserGroupMembership\getGroupMemberName(), SpecialPage\getLanguage(), SpecialPage\getUser(), Html\hidden(), Xml\input(), list, SpecialPage\msg(), Xml\openElement(), Xml\tags(), and text.

Referenced by showEditUserGroupsForm().

◆ makeGroupNameList()

UserrightsPage::makeGroupNameList ( $ids )

Since: 1.15

Parameters

array $ids

Returns: string

Definition at line 566 of file SpecialUserrights.php.

References SpecialPage\msg().

◆ prefixSearchSubpages()

UserrightsPage::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 SpecialPage.

Definition at line 1012 of file SpecialUserrights.php.

References $user, User\newFromName(), and UserNamePrefixSearch\search().

◆ saveUserGroups()

UserrightsPage::saveUserGroups	(	$username,
		$reason,
		$user
	)

protected

Save user groups changes in the database.

Data comes from the editUserGroupsForm() form function

Parameters

string	$username	Username to apply changes to.
string	$reason	Reason for group change
User \| UserRightsProxy	$user	Target user object.

Returns: Status

Definition at line 255 of file SpecialUserrights.php.

References $user, as, canProcessExpiries(), canRemove(), doSaveUserGroups(), expiryToTimestamp(), getAllGroups(), SpecialPage\getRequest(), StatusValue\newFatal(), StatusValue\newGood(), and wfTimestampNow().

Referenced by execute().

◆ serialiseUgmForLog()

static UserrightsPage::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

Definition at line 418 of file SpecialUserrights.php.

Referenced by addLogEntry().

◆ showEditUserGroupsForm()

UserrightsPage::showEditUserGroupsForm	(	$user,
		$groups,
		$groupMemberships
	)

protected

Show the form to edit group memberships.

Parameters

User \| UserRightsProxy	$user	User or UserRightsProxy you're editing
array	$groups	Array of groups the user is in. Not used by this implementation anymore, but kept for backward compatibility with subclasses
array	$groupMemberships	Associative array of (group name => UserGroupMembership object) containing the groups the user is in

Definition at line 622 of file SpecialUserrights.php.

References $user, as, Xml\closeElement(), captcha-old\count, Xml\element(), Autopromote\getAutopromoteGroups(), SpecialPage\getContext(), SpecialPage\getLanguage(), UserGroupMembership\getLink(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), SpecialPage\getUser(), groupCheckboxes(), Html\hidden(), Xml\input(), Xml\label(), list, SpecialPage\msg(), Xml\openElement(), Xml\submitButton(), text, Linker\TOOL_LINKS_EMAIL, Linker\tooltipAndAccesskeyAttribs(), Linker\userToolLinks(), and wfEscapeWikiText().

Referenced by editUserGroupsForm().

◆ showLogFragment()

UserrightsPage::showLogFragment	(	$user,
		$output
	)

protected

Show a rights log fragment for the specified user.

Parameters

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

Definition at line 998 of file SpecialUserrights.php.

References $output, $user, Xml\element(), and LogEventsList\showLogExtract().

Referenced by editUserGroupsForm().

◆ switchForm()

UserrightsPage::switchForm ( )

Output a form to allow searching for a user.

Definition at line 577 of file SpecialUserrights.php.

References Html\closeElement(), Xml\fieldset(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), Html\hidden(), Xml\inputLabel(), SpecialPage\msg(), Html\openElement(), Xml\submitButton(), text, and wfScript().

Referenced by execute().

◆ userCanChangeRights()

UserrightsPage::userCanChangeRights	(	$targetUser,
		$checkIfSelf = `true`
	)

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

Parameters

User	$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 60 of file SpecialUserrights.php.

References $isself, changeableGroups(), and SpecialPage\getUser().

Member Data Documentation

◆ $isself

UserrightsPage::$isself = false

protected

Definition at line 41 of file SpecialUserrights.php.

Referenced by doSaveUserGroups(), and userCanChangeRights().

◆ $mFetchedUser

UserrightsPage::$mFetchedUser = null

protected

Definition at line 40 of file SpecialUserrights.php.

Referenced by execute().

◆ $mTarget

null string UserrightsPage::$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 36 of file SpecialUserrights.php.

Referenced by execute().

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

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addLogEntry()

◆ canAdd()

◆ canProcessExpiries()

◆ canRemove()

◆ changeableGroups()

◆ doesWrites()

◆ doSaveUserGroups()

◆ editUserGroupsForm()

◆ execute()

◆ expiryToTimestamp()

◆ fetchUser()

◆ getAllGroups()

◆ getGroupName()

◆ getSuccessURL()

◆ groupCheckboxes()

◆ makeGroupNameList()

◆ prefixSearchSubpages()

◆ saveUserGroups()

◆ serialiseUgmForLog()

◆ showEditUserGroupsForm()

◆ showLogFragment()

◆ switchForm()

◆ userCanChangeRights()

Member Data Documentation

◆ $isself

◆ $mFetchedUser

◆ $mTarget