MediaWiki  master
SpecialBlock Class Reference

A special page that allows users with 'block' right to block users from editing pages and other actions. More...

Inheritance diagram for SpecialBlock:
Collaboration diagram for SpecialBlock:

Public Member Functions

 __construct (BlockUtils $blockUtils, BlockPermissionCheckerFactory $blockPermissionCheckerFactory, BlockUserFactory $blockUserFactory, UserNameUtils $userNameUtils, UserNamePrefixSearch $userNamePrefixSearch, BlockActionInfo $blockActionInfo, TitleFormatter $titleFormatter, NamespaceInfo $namespaceInfo)
 
 doesWrites ()
 Indicates whether this special page may perform database writes. More...
 
 onSubmit (array $data, HTMLForm $form=null)
 Process the form on POST submission. More...
 
 onSuccess ()
 Do something exciting on successful processing of the form, most likely to show a confirmation message. More...
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept. More...
 
 requiresUnblock ()
 We allow certain special cases where user is blocked. More...
 
- Public Member Functions inherited from FormSpecialPage
 execute ( $par)
 Basic SpecialPage workflow: get a form, send it to the user; get some data back,. More...
 
 onSubmit (array $data)
 Process the form on POST submission. More...
 
 requiresWrite ()
 Whether this action requires the wiki not to be locked. 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 canBlockEmail (UserIdentity $user)
 Can we do an email block? More...
 
static checkUnblockSelf ( $target, Authority $performer)
 T17810: Sitewide blocked admins should not be able to block/unblock others with one exception; they can block the user who blocked them, to reduce advantage of a malicious account blocking all admins (T150826). More...
 
static getSuggestedDurations (Language $lang=null, $includeOther=true)
 Get an array of suggested block durations from MediaWiki:Ipboptions. More...
 
static getTargetAndType (?string $par, WebRequest $request=null)
 Get the target and type, given the request and the subpage parameter. More...
 
static parseExpiryInput ( $expiry)
 Convert a submitted expiry time, which may be relative ("2 weeks", etc) or absolute ("24 May 2034", etc), into an absolute timestamp we can put into the database. More...
 
static processForm (array $data, IContextSource $context)
 Given the form data, actually implement a block. 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

 alterForm (HTMLForm $form)
 Customizes the HTMLForm a bit. More...
 
 checkExecutePermissions (User $user)
 Checks that the user can unblock themselves if they are trying to do so. More...
 
 getDisplayFormat ()
 Get display format for the form. More...
 
 getFormFields ()
 Get the HTMLForm descriptor array for the block form. 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...
 
 maybeAlterFormDefaults (&$fields)
 If the user has already been blocked with similar settings, load that block and change the defaults for the form fields to match the existing settings. More...
 
 postText ()
 Add footer elements to the form. More...
 
 preText ()
 Add header elements like block log entries, etc. More...
 
 setParameter ( $par)
 Handle some magic here. More...
 
- Protected Member Functions inherited from FormSpecialPage
 getForm ()
 Get the HTMLForm to control behavior. More...
 
 getMessagePrefix ()
 Get message prefix for HTMLForm. More...
 
 setReauthPostData (array $data)
 Preserve POST data across reauthentication. 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...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Static Protected Member Functions

static getTargetUserTitle ( $target)
 Get a user page target for things like logs. 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

bool $alreadyBlocked
 
array $preErrors = []
 
User string $previousTarget
 The previous block target. More...
 
bool $requestedHideUser
 Whether the previous submission of the form asked for HideUser. More...
 
UserIdentity string null $target
 User to be blocked, as passed either by parameter (url?wpTarget=Foo) or as subpage (Special:Block/Foo) More...
 
int $type
 DatabaseBlock::TYPE_ constant. More...
 
- Protected Attributes inherited from FormSpecialPage
string null $par = null
 The sub-page of the special page. More...
 
array null $reauthPostData = null
 POST data preserved across re-authentication. 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...
 

Static Private Member Functions

static processFormInternal (array $data, Authority $performer, BlockUserFactory $blockUserFactory, BlockUtils $blockUtils)
 Implementation details for processForm Own function to allow sharing the deprecated code with non-deprecated and service code. More...
 

Private Attributes

BlockActionInfo $blockActionInfo
 
BlockPermissionCheckerFactory $blockPermissionCheckerFactory
 
BlockUserFactory $blockUserFactory
 
BlockUtils $blockUtils
 
NamespaceInfo $namespaceInfo
 
TitleFormatter $titleFormatter
 
UserNamePrefixSearch $userNamePrefixSearch
 
UserNameUtils $userNameUtils
 

Detailed Description

A special page that allows users with 'block' right to block users from editing pages and other actions.

Definition at line 48 of file SpecialBlock.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialBlock::__construct ( BlockUtils  $blockUtils,
BlockPermissionCheckerFactory  $blockPermissionCheckerFactory,
BlockUserFactory  $blockUserFactory,
UserNameUtils  $userNameUtils,
UserNamePrefixSearch  $userNamePrefixSearch,
BlockActionInfo  $blockActionInfo,
TitleFormatter  $titleFormatter,
NamespaceInfo  $namespaceInfo 
)
Parameters
BlockUtils$blockUtils
BlockPermissionCheckerFactory$blockPermissionCheckerFactory
BlockUserFactory$blockUserFactory
UserNameUtils$userNameUtils
UserNamePrefixSearch$userNamePrefixSearch
BlockActionInfo$blockActionInfo
TitleFormatter$titleFormatter
NamespaceInfo$namespaceInfo

Definition at line 104 of file SpecialBlock.php.

References $blockActionInfo, $blockPermissionCheckerFactory, $blockUserFactory, $blockUtils, $namespaceInfo, $titleFormatter, $userNamePrefixSearch, and $userNameUtils.

Member Function Documentation

◆ alterForm()

SpecialBlock::alterForm ( HTMLForm  $form)
protected

◆ canBlockEmail()

static SpecialBlock::canBlockEmail ( UserIdentity  $user)
static

Can we do an email block?

Deprecated:
since 1.36, use BlockPermissionChecker service instead
Parameters
UserIdentity$userThe sysop wanting to make a block
Returns
bool

Definition at line 986 of file SpecialBlock.php.

References User\newFromIdentity().

◆ checkExecutePermissions()

SpecialBlock::checkExecutePermissions ( User  $user)
protected

Checks that the user can unblock themselves if they are trying to do so.

Parameters
User$user
Exceptions
ErrorPageError

Reimplemented from FormSpecialPage.

Definition at line 136 of file SpecialBlock.php.

◆ checkUnblockSelf()

static SpecialBlock::checkUnblockSelf (   $target,
Authority  $performer 
)
static

T17810: Sitewide blocked admins should not be able to block/unblock others with one exception; they can block the user who blocked them, to reduce advantage of a malicious account blocking all admins (T150826).

T208965: Partially blocked admins can block and unblock others as normal.

Deprecated:
since 1.36, hard deprecated since 1.37, use BlockPermissionChecker instead
Parameters
UserIdentity | string | null$targetTarget to block or unblock; could be a UserIdentity object, or username/IP address, or null when the target is not known yet (e.g. when displaying Special:Block)
Authority$performerUser doing the request
Returns
bool|string True or error message key

Definition at line 1007 of file SpecialBlock.php.

References $target, and wfDeprecated().

◆ doesWrites()

SpecialBlock::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 126 of file SpecialBlock.php.

◆ getDisplayFormat()

SpecialBlock::getDisplayFormat ( )
protected

Get display format for the form.

See HTMLForm documentation for available values.

Since
1.25
Returns
string

Reimplemented from FormSpecialPage.

Definition at line 205 of file SpecialBlock.php.

◆ getFormFields()

◆ getGroupName()

SpecialBlock::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 1059 of file SpecialBlock.php.

◆ getSuggestedDurations()

static SpecialBlock::getSuggestedDurations ( Language  $lang = null,
  $includeOther = true 
)
static

Get an array of suggested block durations from MediaWiki:Ipboptions.

Todo:
FIXME: This uses a rather odd syntax for the options, should it be converted to the standard "**<duration>|<displayname>" format?
Parameters
Language | null$langThe language to get the durations in, or null to use the wiki's content language
bool$includeOtherWhether to include the 'other' option in the list of suggestions
Returns
string[]

Definition at line 946 of file SpecialBlock.php.

References $lang, XmlSelect\parseOptionsMessage(), and wfMessage().

Referenced by getFormFields(), and Language\translateBlockExpiry().

◆ getTargetAndType()

static SpecialBlock::getTargetAndType ( ?string  $par,
WebRequest  $request = null 
)
static

Get the target and type, given the request and the subpage parameter.

Several parameters are handled for backwards compatability. 'wpTarget' is prioritized, since it matches the HTML form.

Deprecated:
since 1.36. Use BlockUtils::parseBlockTarget directly instead.
Parameters
string | null$parSubpage parameter passed to setup, or data value from the HTMLForm
WebRequest | null$requestOptionally try and get data from a request too
Returns
array [ UserIdentity|string|null, DatabaseBlock::TYPE_ constant|null ]

Definition at line 732 of file SpecialBlock.php.

References FormSpecialPage\$par.

Referenced by setParameter().

◆ getTargetUserTitle()

static SpecialBlock::getTargetUserTitle (   $target)
staticprotected

Get a user page target for things like logs.

This handles account and IP range targets.

Parameters
UserIdentity | string$target
Returns
PageReference|null

Definition at line 710 of file SpecialBlock.php.

References $target, MediaWiki\User\UserIdentity\getName(), and NS_USER.

Referenced by postText().

◆ maybeAlterFormDefaults()

SpecialBlock::maybeAlterFormDefaults ( $fields)
protected

If the user has already been blocked with similar settings, load that block and change the defaults for the form fields to match the existing settings.

Parameters
array&$fieldsHTMLForm descriptor array

Definition at line 430 of file SpecialBlock.php.

References SpecialPage\getConfig(), SpecialPage\getName(), SpecialPage\getOutput(), SpecialPage\getRequest(), MediaWiki\Block\Restriction\PageRestriction\getTitle(), MediaWiki\Block\DatabaseBlock\getType(), SpecialPage\getUser(), wfEscapeWikiText(), and wfTimestamp().

Referenced by getFormFields().

◆ onSubmit()

SpecialBlock::onSubmit ( array  $data,
HTMLForm  $form = null 
)

Process the form on POST submission.

Parameters
array$data
HTMLForm | null$form
Returns
bool|string|array|Status As documented for HTMLForm::trySubmit.

Definition at line 1021 of file SpecialBlock.php.

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

◆ onSuccess()

SpecialBlock::onSuccess ( )

Do something exciting on successful processing of the form, most likely to show a confirmation message.

Reimplemented from FormSpecialPage.

Definition at line 1034 of file SpecialBlock.php.

References SpecialPage\getOutput(), SpecialPage\msg(), and wfEscapeWikiText().

◆ parseExpiryInput()

static SpecialBlock::parseExpiryInput (   $expiry)
static

Convert a submitted expiry time, which may be relative ("2 weeks", etc) or absolute ("24 May 2034", etc), into an absolute timestamp we can put into the database.

Deprecated:
since 1.36, use BlockUser::parseExpiryInput instead
Parameters
string$expiryWhatever was typed into the form
Returns
string|bool Timestamp or 'infinity' or false on error.

Definition at line 975 of file SpecialBlock.php.

◆ postText()

◆ prefixSearchSubpages()

SpecialBlock::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 1048 of file SpecialBlock.php.

◆ preText()

SpecialBlock::preText ( )
protected

Add header elements like block log entries, etc.

Returns
string

Reimplemented from FormSpecialPage.

Definition at line 555 of file SpecialBlock.php.

References $s, $target, SpecialPage\getConfig(), SpecialPage\getHookRunner(), MediaWiki\User\UserIdentity\getName(), SpecialPage\getOutput(), SpecialPage\msg(), and Html\rawElement().

◆ processForm()

static SpecialBlock::processForm ( array  $data,
IContextSource  $context 
)
static

Given the form data, actually implement a block.

Deprecated:
since 1.36, use BlockUserFactory service instead
Parameters
array$data
IContextSource$context
Returns
bool|string|array|Status

Definition at line 764 of file SpecialBlock.php.

References IContextSource\getAuthority(), and processFormInternal().

◆ processFormInternal()

static SpecialBlock::processFormInternal ( array  $data,
Authority  $performer,
BlockUserFactory  $blockUserFactory,
BlockUtils  $blockUtils 
)
staticprivate

Implementation details for processForm Own function to allow sharing the deprecated code with non-deprecated and service code.

Parameters
array$data
Authority$performer
BlockUserFactory$blockUserFactory
BlockUtils$blockUtils
Returns
bool|string|array|Status

Definition at line 784 of file SpecialBlock.php.

References $blockUserFactory, $blockUtils, $target, $title, $type, MediaWiki\User\UserIdentity\getName(), MediaWiki\Permissions\Authority\getUser(), Title\makeTitle(), MediaWiki\Block\BlockUserFactory\newBlockUser(), NS_USER, and MediaWiki\Block\BlockUtils\parseBlockTarget().

Referenced by onSubmit(), and processForm().

◆ requiresUnblock()

SpecialBlock::requiresUnblock ( )

We allow certain special cases where user is blocked.

Returns
bool

Reimplemented from FormSpecialPage.

Definition at line 152 of file SpecialBlock.php.

◆ setParameter()

SpecialBlock::setParameter (   $par)
protected

Handle some magic here.

Parameters
string$par

Reimplemented from FormSpecialPage.

Definition at line 161 of file SpecialBlock.php.

References FormSpecialPage\$par, SpecialPage\getRequest(), SpecialPage\getSkin(), and getTargetAndType().

Member Data Documentation

◆ $alreadyBlocked

bool SpecialBlock::$alreadyBlocked
protected

Definition at line 86 of file SpecialBlock.php.

◆ $blockActionInfo

BlockActionInfo SpecialBlock::$blockActionInfo
private

Definition at line 66 of file SpecialBlock.php.

Referenced by __construct().

◆ $blockPermissionCheckerFactory

BlockPermissionCheckerFactory SpecialBlock::$blockPermissionCheckerFactory
private

Definition at line 54 of file SpecialBlock.php.

Referenced by __construct().

◆ $blockUserFactory

BlockUserFactory SpecialBlock::$blockUserFactory
private

Definition at line 57 of file SpecialBlock.php.

Referenced by __construct(), and processFormInternal().

◆ $blockUtils

BlockUtils SpecialBlock::$blockUtils
private

Definition at line 51 of file SpecialBlock.php.

Referenced by __construct(), and processFormInternal().

◆ $namespaceInfo

NamespaceInfo SpecialBlock::$namespaceInfo
private

Definition at line 92 of file SpecialBlock.php.

Referenced by __construct().

◆ $preErrors

array SpecialBlock::$preErrors = []
protected

Definition at line 89 of file SpecialBlock.php.

◆ $previousTarget

User string SpecialBlock::$previousTarget
protected

The previous block target.

Definition at line 80 of file SpecialBlock.php.

◆ $requestedHideUser

bool SpecialBlock::$requestedHideUser
protected

Whether the previous submission of the form asked for HideUser.

Definition at line 83 of file SpecialBlock.php.

◆ $target

UserIdentity string null SpecialBlock::$target
protected

User to be blocked, as passed either by parameter (url?wpTarget=Foo) or as subpage (Special:Block/Foo)

Definition at line 74 of file SpecialBlock.php.

Referenced by checkUnblockSelf(), getTargetUserTitle(), preText(), and processFormInternal().

◆ $titleFormatter

TitleFormatter SpecialBlock::$titleFormatter
private

Definition at line 69 of file SpecialBlock.php.

Referenced by __construct().

◆ $type

int SpecialBlock::$type
protected

DatabaseBlock::TYPE_ constant.

Definition at line 77 of file SpecialBlock.php.

Referenced by processFormInternal().

◆ $userNamePrefixSearch

UserNamePrefixSearch SpecialBlock::$userNamePrefixSearch
private

Definition at line 63 of file SpecialBlock.php.

Referenced by __construct().

◆ $userNameUtils

UserNameUtils SpecialBlock::$userNameUtils
private

Definition at line 60 of file SpecialBlock.php.

Referenced by __construct().


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