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 ()
 
 canProcessExpiries ()
 Returns true if this user rights form can set and change user group expiries. More...
 
 changeableGroups ()
 Returns $this->getUser()->changeableGroups() More...
 
 doesWrites ()
 
 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...
 
 doesWrites ()
 Indicates whether this special page may perform database writes. More...
 
 execute ($subPage)
 Default execute method Checks user permissions. 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 ()
 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...
 
 prefixSearchSubpages ($search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept. 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 ()
 
 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 ()
 
 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...
 
 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

UserrightsPage::__construct ( )

Definition at line 43 of file SpecialUserrights.php.

Member Function Documentation

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$tagsChange tags for the log entry
array$oldUGMsAssociative array of (group name => UserGroupMembership)
array$newUGMsAssociative array of (group name => UserGroupMembership)

Definition at line 434 of file SpecialUserrights.php.

References $user, SpecialPage\getUser(), and use.

Referenced by doSaveUserGroups().

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

Definition at line 968 of file SpecialUserrights.php.

References changeableGroups().

Referenced by groupCheckboxes().

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.

References SpecialPage\getConfig().

Referenced by groupCheckboxes(), and saveUserGroups().

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

Definition at line 955 of file SpecialUserrights.php.

References changeableGroups().

Referenced by groupCheckboxes(), and saveUserGroups().

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 987 of file SpecialUserrights.php.

References SpecialPage\getUser().

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

UserrightsPage::doesWrites ( )

Definition at line 47 of file SpecialUserrights.php.

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$addArray of groups to add
array$removeArray of groups to remove
string$reasonReason for group change
array$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 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().

UserrightsPage::editUserGroupsForm (   $username)

Edit user groups membership.

Parameters
string$usernameName of the user.

Definition at line 471 of file SpecialUserrights.php.

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

Referenced by 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

Definition at line 82 of file SpecialUserrights.php.

References $mFetchedUser, $mTarget, $out, $request, $status, $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.

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 TS_MW, wfIsInfinity(), and wfTimestamp().

Referenced by ApiUserrights\execute().

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 499 of file SpecialUserrights.php.

References $name, $user, $username, 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().

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 756 of file SpecialUserrights.php.

References User\getAllGroups().

Referenced by groupCheckboxes(), and saveUserGroups().

UserrightsPage::getGroupName ( )
protected

Definition at line 1021 of file SpecialUserrights.php.

UserrightsPage::getSuccessURL ( )

Definition at line 207 of file SpecialUserrights.php.

References SpecialPage\getPageTitle().

Referenced by execute().

UserrightsPage::groupCheckboxes (   $usergroups,
  $user 
)
private

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

Parameters
array$usergroupsAssociative 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 769 of file SpecialUserrights.php.

References $attribs, $name, $ret, $t, $user, $value, as, canAdd(), canProcessExpiries(), canRemove(), Xml\checkLabel(), Xml\closeElement(), 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().

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

Definition at line 565 of file SpecialUserrights.php.

References SpecialPage\msg().

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

Definition at line 1011 of file SpecialUserrights.php.

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

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 255 of file SpecialUserrights.php.

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

Referenced by execute().

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 417 of file SpecialUserrights.php.

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

Show the form to edit group memberships.

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

Definition at line 621 of file SpecialUserrights.php.

References $user, as, Xml\closeElement(), 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().

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 997 of file SpecialUserrights.php.

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

Referenced by editUserGroupsForm().

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

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

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

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

Member Data Documentation

UserrightsPage::$isself = false
protected

Definition at line 41 of file SpecialUserrights.php.

Referenced by doSaveUserGroups(), and userCanChangeRights().

UserrightsPage::$mFetchedUser = null
protected

Definition at line 40 of file SpecialUserrights.php.

Referenced by execute().

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: