MediaWiki  master
UserrightsPage Class Reference

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

Inheritance diagram for UserrightsPage:
Collaboration diagram for UserrightsPage:

Public Member Functions

 __construct (UserGroupManagerFactory $userGroupManagerFactory=null, UserNameUtils $userNameUtils=null, UserNamePrefixSearch $userNamePrefixSearch=null, UserFactory $userFactory=null)
 
 canProcessExpiries ()
 Returns true if this user rights form can set and change user group expiries. More...
 
 doesWrites ()
 Indicates whether this special page may perform database writes. More...
 
 doSaveUserGroups ( $user, array $add, array $remove, $reason='', array $tags=[], array $groupExpiries=[])
 Save user groups changes in the database. 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...
 
 makeGroupNameList ( $ids)
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept. More...
 
 userCanChangeRights (UserIdentity $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...
 
 getAuthority ()
 Shortcut to get the Authority executing this instance. More...
 
 getConfig ()
 Shortcut to get main config object. More...
 
 getContentLanguage ()
 Shortcut to get content language. 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...
 
 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,... $params)
 Wrapper around wfMessage that sets the current context. 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...
 
 setContentLanguage (Language $contentLanguage)
 Set content language. More...
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in. More...
 
 setHookContainer (HookContainer $hookContainer)
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setListed ( $listed)
 Set whether this page is listed in Special:Specialpages, at run-time. More...
 
 setSpecialPageFactory (SpecialPageFactory $specialPageFactory)
 
 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, array $oldGroups, array $newGroups, $reason, array $tags, array $oldUGMs, array $newUGMs)
 Add a rights log entry for an action. More...
 
 changeableGroups ()
 Returns $this->getUser()->changeableGroups() 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...
 
 switchForm ()
 Output a form to allow searching for a 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...
 
 buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
 Generate (prev x| next x) (20|50|100...) type links for paging. More...
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process. More...
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have. More...
 
 getAuthManager ()
 
 getCacheTTL ()
 
 getHookContainer ()
 
 getHookRunner ()
 
 getLanguageConverter ()
 Shortcut to get language's converter. More...
 
 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...
 
 getSpecialPageFactory ()
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches. 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...
 
 prefixSearchString ( $search, $limit, $offset, SearchEngineFactory $searchEngineFactory=null)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 setAuthManager (AuthManager $authManager)
 Set the injected AuthManager from the special page constructor. More...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! More...
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Static Protected Member Functions

static getAllGroups ()
 
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
 
null User $mFetchedUser = null
 The user object of the target username or null. More...
 
null string $mTarget
 The target of the local right-adjuster's interest. More...
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
bool $mIncludable
 Whether the special page can be included in an article. More...
 
bool $mIncluding
 Whether or not this special page is being included from an article. More...
 
string $mName
 The canonical name of this special page Also used for the default. More...
 
string $mRestriction
 Minimum user level required to access this page, or "" for anyone. More...
 

Private Member Functions

 canAdd ( $group)
 
 canRemove ( $group)
 
 editUserGroupsForm ( $username)
 Edit user groups membership. More...
 
 getSuccessURL ()
 
 groupCheckboxes ( $usergroups, $user)
 Adds a table with checkboxes where you can select what groups to add/remove. More...
 

Private Attributes

UserFactory $userFactory
 
UserGroupManager $userGroupManager
 
UserNamePrefixSearch $userNamePrefixSearch
 
UserNameUtils $userNameUtils
 

Detailed Description

Special page to allow managing user group membership.

Definition at line 37 of file SpecialUserrights.php.

Constructor & Destructor Documentation

◆ __construct()

UserrightsPage::__construct ( UserGroupManagerFactory  $userGroupManagerFactory = null,
UserNameUtils  $userNameUtils = null,
UserNamePrefixSearch  $userNamePrefixSearch = null,
UserFactory  $userFactory = null 
)
Parameters
UserGroupManagerFactory | null$userGroupManagerFactory
UserNameUtils | null$userNameUtils
UserNamePrefixSearch | null$userNamePrefixSearch
UserFactory | null$userFactory

Definition at line 69 of file SpecialUserrights.php.

References $userFactory, $userNamePrefixSearch, and $userNameUtils.

Member Function Documentation

◆ addLogEntry()

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

Add a rights log entry for an action.

Parameters
User | UserRightsProxy$user
array$oldGroups
array$newGroups
string$reason
string[]$tagsChange tags for the log entry
array$oldUGMsAssociative array of (group name => UserGroupMembership)
array$newUGMsAssociative array of (group name => UserGroupMembership)

Definition at line 490 of file SpecialUserrights.php.

References SpecialPage\getUser(), and serialiseUgmForLog().

Referenced by doSaveUserGroups().

◆ canAdd()

UserrightsPage::canAdd (   $group)
private
Parameters
string$groupThe name of the group to check
Returns
bool Can we add the group?

Definition at line 1065 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 278 of file SpecialUserrights.php.

Referenced by groupCheckboxes(), and saveUserGroups().

◆ canRemove()

UserrightsPage::canRemove (   $group)
private
Parameters
string$groupThe name of the group to check
Returns
bool Can we remove the group?

Definition at line 1052 of file SpecialUserrights.php.

References changeableGroups().

Referenced by groupCheckboxes(), and saveUserGroups().

◆ changeableGroups()

UserrightsPage::changeableGroups ( )
protected

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

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

Definition at line 1084 of file SpecialUserrights.php.

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

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

◆ doesWrites()

UserrightsPage::doesWrites ( )

Indicates whether this special page may perform database writes.

Stability: stable
to override
Returns
bool
Since
1.27

Reimplemented from SpecialPage.

Definition at line 87 of file SpecialUserrights.php.

◆ doSaveUserGroups()

UserrightsPage::doSaveUserGroups (   $user,
array  $add,
array  $remove,
  $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.

Parameters
User | UserRightsProxy$user
array$addArray of groups to add
array$removeArray of groups to remove
string$reasonReason for group change
string[]$tagsArray of change tags to add to the log entry
array$groupExpiriesAssociative 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 389 of file SpecialUserrights.php.

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

Referenced by saveUserGroups().

◆ editUserGroupsForm()

UserrightsPage::editUserGroupsForm (   $username)
private

Edit user groups membership.

Parameters
string$usernameName of the user.

Definition at line 527 of file SpecialUserrights.php.

References 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$parString if any subpage provided, else null
Exceptions
UserBlockedError|PermissionsError

Reimplemented from SpecialPage.

Definition at line 130 of file SpecialUserrights.php.

References $mFetchedUser, SpecialPage\addHelpLink(), SpecialPage\checkReadOnly(), User\clearInstanceCache(), editUserGroupsForm(), Html\element(), Html\errorBox(), fetchUser(), SpecialPage\getAuthority(), SpecialPage\getLanguage(), SpecialPage\getOutput(), SpecialPage\getRequest(), SpecialPage\getSkin(), getSuccessURL(), SpecialPage\getUser(), SpecialPage\msg(), StatusValue\newFatal(), SpecialPage\outputHeader(), Html\rawElement(), saveUserGroups(), SpecialPage\setHeaders(), and switchForm().

◆ 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 291 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 559 of file SpecialUserrights.php.

References SpecialPage\getAuthority(), SpecialPage\getConfig(), WikiMap\isCurrentWikiId(), User\isHidden(), StatusValue\newFatal(), UserRightsProxy\newFromName(), StatusValue\newGood(), UserRightsProxy\validDatabase(), UserRightsProxy\whoIs(), and User\whoIs().

Referenced by editUserGroupsForm(), and execute().

◆ getAllGroups()

static UserrightsPage::getAllGroups ( )
staticprotected
Returns
string[] Array of groups that may be edited

Definition at line 843 of file SpecialUserrights.php.

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

Stability: stable
to override
Returns
string
Since
1.21

Reimplemented from SpecialPage.

Definition at line 1119 of file SpecialUserrights.php.

◆ getSuccessURL()

UserrightsPage::getSuccessURL ( )
private

Definition at line 268 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
UserGroupMembership[]$usergroupsAssociative array of (group name as string => UserGroupMembership object) for groups the user belongs to
User$user
Returns
array Array with 2 elements: the XHTML table element with checkxboes, and whether any groups are changeable

Definition at line 860 of file SpecialUserrights.php.

References $t, canAdd(), canProcessExpiries(), canRemove(), Xml\checkLabel(), Xml\closeElement(), Xml\element(), getAllGroups(), UserGroupMembership\getGroupMemberName(), SpecialPage\getLanguage(), SpecialPage\getUser(), Html\hidden(), Xml\input(), SpecialPage\msg(), Xml\openElement(), XmlSelect\parseOptionsMessage(), and Xml\tags().

Referenced by showEditUserGroupsForm().

◆ makeGroupNameList()

UserrightsPage::makeGroupNameList (   $ids)
Since
1.15
Parameters
array$ids
Returns
string

Definition at line 635 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$searchPrefix to search for
int$limitMaximum number of results to return (usually 10)
int$offsetNumber of results to skip (usually 0)
Returns
string[] Matching subpages

Reimplemented from SpecialPage.

Definition at line 1108 of file SpecialUserrights.php.

◆ saveUserGroups()

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

Save user groups changes in the database.

Data comes from the editUserGroupsForm() form function

Parameters
string$usernameUsername to apply changes to.
string$reasonReason for group change
User | UserRightsProxy$userTarget user object.
Returns
Status

Definition at line 316 of file SpecialUserrights.php.

References 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$ugmMay be null if things get borked
Returns
array

Definition at line 473 of file SpecialUserrights.php.

Referenced by addLogEntry().

◆ showEditUserGroupsForm()

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

Show the form to edit group memberships.

Parameters
User | UserRightsProxy$userUser or UserRightsProxy you're editing
string[]$groupsArray of groups the user is in. Not used by this implementation anymore, but kept for backward compatibility with subclasses
UserGroupMembership[]$groupMembershipsAssociative array of (group name => UserGroupMembership object) containing the groups the user is in

Definition at line 691 of file SpecialUserrights.php.

References Xml\closeElement(), CommentStore\COMMENT_CHARACTER_LIMIT, Xml\element(), SpecialPage\getContext(), SpecialPage\getLanguage(), UserGroupMembership\getLink(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getUser(), groupCheckboxes(), Html\hidden(), Xml\input(), Xml\label(), SpecialPage\msg(), Xml\openElement(), Xml\submitButton(), 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$userUser to show log for
OutputPage$outputOutputPage to use

Definition at line 1094 of file SpecialUserrights.php.

References Xml\element(), and LogEventsList\showLogExtract().

Referenced by editUserGroupsForm().

◆ switchForm()

UserrightsPage::switchForm ( )
protected

◆ userCanChangeRights()

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

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

Parameters
UserIdentity$targetUserUser whose rights are being changed
bool$checkIfSelfIf 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 100 of file SpecialUserrights.php.

References $isself, changeableGroups(), MediaWiki\User\UserIdentity\getId(), and SpecialPage\getUser().

Member Data Documentation

◆ $isself

UserrightsPage::$isself = false
protected

Definition at line 49 of file SpecialUserrights.php.

Referenced by doSaveUserGroups(), and userCanChangeRights().

◆ $mFetchedUser

null User UserrightsPage::$mFetchedUser = null
protected

The user object of the target username or null.

Definition at line 48 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 44 of file SpecialUserrights.php.

◆ $userFactory

UserFactory UserrightsPage::$userFactory
private

Definition at line 61 of file SpecialUserrights.php.

Referenced by __construct().

◆ $userGroupManager

UserGroupManager UserrightsPage::$userGroupManager
private

Definition at line 52 of file SpecialUserrights.php.

◆ $userNamePrefixSearch

UserNamePrefixSearch UserrightsPage::$userNamePrefixSearch
private

Definition at line 58 of file SpecialUserrights.php.

Referenced by __construct().

◆ $userNameUtils

UserNameUtils UserrightsPage::$userNameUtils
private

Definition at line 55 of file SpecialUserrights.php.

Referenced by __construct().


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