heading, @see getDescription()
protected $mName;
// The local name of this special page
private $mLocalName;
// Minimum user level required to access this page, or "" for anyone.
// Also used to categorise the pages in Special:Specialpages
protected $mRestriction;
// Listed in Special:Specialpages?
private $mListed;
// Whether or not this special page is being included from an article
protected $mIncluding;
// Whether the special page can be included in an article
protected $mIncludable;
/**
* Current request context
* @var IContextSource
*/
protected $mContext;
/**
* @var \MediaWiki\Linker\LinkRenderer|null
*/
private $linkRenderer;
/** @var HookContainer|null */
private $hookContainer;
/** @var HookRunner|null */
private $hookRunner;
/**
* 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.
*
* @since 1.9
* @since 1.21 $fragment parameter added
*
* @param string $name
* @param string|bool $subpage Subpage string, or false to not use a subpage
* @param string $fragment The link fragment (after the "#")
* @return Title
* @throws MWException
*/
public static function getTitleFor( $name, $subpage = false, $fragment = '' ) {
return Title::newFromLinkTarget(
self::getTitleValueFor( $name, $subpage, $fragment )
);
}
/**
* Get a localised TitleValue object for a specified special page name
*
* @since 1.28
* @param string $name
* @param string|bool $subpage Subpage string, or false to not use a subpage
* @param string $fragment The link fragment (after the "#")
* @return TitleValue
*/
public static function getTitleValueFor( $name, $subpage = false, $fragment = '' ) {
$name = MediaWikiServices::getInstance()->getSpecialPageFactory()->
getLocalNameFor( $name, $subpage );
return new TitleValue( NS_SPECIAL, $name, $fragment );
}
/**
* Get a localised Title object for a page name with a possibly unvalidated subpage
*
* @param string $name
* @param string|bool $subpage Subpage string, or false to not use a subpage
* @return Title|null Title object or null if the page doesn't exist
*/
public static function getSafeTitleFor( $name, $subpage = false ) {
$name = MediaWikiServices::getInstance()->getSpecialPageFactory()->
getLocalNameFor( $name, $subpage );
if ( $name ) {
return Title::makeTitleSafe( NS_SPECIAL, $name );
} else {
return null;
}
}
/**
* 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.
*
* If you override execute(), you can recover the default behavior with userCanExecute()
* and displayRestrictionError()
*
* @stable to call
*
* @param string $name Name of the special page, as seen in links and URLs
* @param string $restriction User right required, e.g. "block" or "delete"
* @param bool $listed Whether the page is listed in Special:Specialpages
* @param callable|bool $function Unused
* @param string $file Unused
* @param bool $includable Whether the page can be included in normal pages
*/
public function __construct(
$name = '', $restriction = '', $listed = true,
$function = false, $file = '', $includable = false
) {
$this->mName = $name;
$this->mRestriction = $restriction;
$this->mListed = $listed;
$this->mIncludable = $includable;
}
/**
* Get the name of this Special Page.
* @return string
*/
public function getName() {
return $this->mName;
}
/**
* Get the permission that a user must have to execute this page
* @return string
*/
public function getRestriction() {
return $this->mRestriction;
}
// @todo FIXME: Decide which syntax to use for this, and stick to it
/**
* Whether this special page is listed in Special:SpecialPages
* @stable to override
* @since 1.3 (r3583)
* @return bool
*/
public function isListed() {
return $this->mListed;
}
/**
* Set whether this page is listed in Special:Specialpages, at run-time
* @since 1.3
* @deprecated since 1.35
* @param bool $listed Set via subclassing UnlistedSpecialPage, get via
* isListed()
* @return bool
*/
public function setListed( $listed ) {
wfDeprecated( __METHOD__, '1.35' );
return wfSetVar( $this->mListed, $listed );
}
/**
* Get or set whether this special page is listed in Special:SpecialPages
* @since 1.6
* @deprecated since 1.35 Set via subclassing UnlistedSpecialPage, get via
* isListed()
* @param bool|null $x
* @return bool
*/
public function listed( $x = null ) {
wfDeprecated( __METHOD__, '1.35' );
return wfSetVar( $this->mListed, $x );
}
/**
* Whether it's allowed to transclude the special page via {{Special:Foo/params}}
* @stable to override
* @return bool
*/
public function isIncludable() {
return $this->mIncludable;
}
/**
* How long to cache page when it is being included.
*
* @note If cache time is not 0, then the current user becomes an anon
* if you want to do any per-user customizations, than this method
* must be overriden to return 0.
* @since 1.26
* @stable to override
* @return int Time in seconds, 0 to disable caching altogether,
* false to use the parent page's cache settings
*/
public function maxIncludeCacheTime() {
return $this->getConfig()->get( 'MiserMode' ) ? $this->getCacheTTL() : 0;
}
/**
* @stable to override
* @return int Seconds that this page can be cached
*/
protected function getCacheTTL() {
return 60 * 60;
}
/**
* Whether the special page is being evaluated via transclusion
* @param bool|null $x
* @return bool
*/
public function including( $x = null ) {
return wfSetVar( $this->mIncluding, $x );
}
/**
* Get the localised name of the special page
* @stable to override
* @return string
*/
public function getLocalName() {
if ( !isset( $this->mLocalName ) ) {
$this->mLocalName = MediaWikiServices::getInstance()->getSpecialPageFactory()->
getLocalNameFor( $this->mName );
}
return $this->mLocalName;
}
/**
* Is this page expensive (for some definition of expensive)?
* Expensive pages are disabled or cached in miser mode. Originally used
* (and still overridden) by QueryPage and subclasses, moved here so that
* Special:SpecialPages can safely call it for all special pages.
*
* @stable to override
* @return bool
*/
public function isExpensive() {
return false;
}
/**
* Is this page cached?
* Expensive pages are cached or disabled in miser mode.
* Used by QueryPage and subclasses, moved here so that
* Special:SpecialPages can safely call it for all special pages.
*
* @stable to override
* @return bool
* @since 1.21
*/
public function isCached() {
return false;
}
/**
* Can be overridden by subclasses with more complicated permissions
* schemes.
*
* @stable to override
* @return bool Should the page be displayed with the restricted-access
* pages?
*/
public function isRestricted() {
// DWIM: If anons can do something, then it is not restricted
return $this->mRestriction != '' && !MediaWikiServices::getInstance()
->getPermissionManager()
->groupHasPermission( '*', $this->mRestriction );
}
/**
* Checks if the given user (identified by an object) can execute this
* special page (as defined by $mRestriction). Can be overridden by sub-
* classes with more complicated permissions schemes.
*
* @stable to override
* @param User $user The user to check
* @return bool Does the user have permission to view the page?
*/
public function userCanExecute( User $user ) {
return MediaWikiServices::getInstance()
->getPermissionManager()
->userHasRight( $user, $this->mRestriction );
}
/**
* Output an error message telling the user what access level they have to have
* @stable to override
* @throws PermissionsError
*/
protected function displayRestrictionError() {
throw new PermissionsError( $this->mRestriction );
}
/**
* Checks if userCanExecute, and if not throws a PermissionsError
*
* @stable to override
* @since 1.19
* @return void
* @throws PermissionsError
*/
public function checkPermissions() {
if ( !$this->userCanExecute( $this->getUser() ) ) {
$this->displayRestrictionError();
}
}
/**
* If the wiki is currently in readonly mode, throws a ReadOnlyError
*
* @since 1.19
* @return void
* @throws ReadOnlyError
*/
public function checkReadOnly() {
if ( wfReadOnly() ) {
throw new ReadOnlyError;
}
}
/**
* If the user is not logged in, throws UserNotLoggedIn error
*
* The user will be redirected to Special:Userlogin with the given message as an error on
* the form.
*
* @since 1.23
* @param string $reasonMsg [optional] Message key to be displayed on login page
* @param string $titleMsg [optional] Passed on to UserNotLoggedIn constructor
* @throws UserNotLoggedIn
*/
public function requireLogin(
$reasonMsg = 'exception-nologin-text', $titleMsg = 'exception-nologin'
) {
if ( $this->getUser()->isAnon() ) {
throw new UserNotLoggedIn( $reasonMsg, $titleMsg );
}
}
/**
* Tells if the special page does something security-sensitive and needs extra defense against
* a stolen account (e.g. a reauthentication). What exactly that will mean is decided by the
* authentication framework.
* @stable to override
* @return bool|string False or the argument for AuthManager::securitySensitiveOperationStatus().
* Typically a special page needing elevated security would return its name here.
*/
protected function getLoginSecurityLevel() {
return false;
}
/**
* Record preserved POST data after a reauthentication.
*
* This is called from checkLoginSecurityLevel() when returning from the
* redirect for reauthentication, if the redirect had been served in
* response to a POST request.
*
* The base SpecialPage implementation does nothing. If your subclass uses
* getLoginSecurityLevel() or checkLoginSecurityLevel(), it should probably
* implement this to do something with the data.
*
* @stable to override
* @since 1.32
* @param array $data
*/
protected function setReauthPostData( array $data ) {
}
/**
* Verifies that the user meets the security level, possibly reauthenticating them in the process.
*
* This should be used when the page does something security-sensitive and needs extra defense
* against a stolen account (e.g. a reauthentication). The authentication framework will make
* an extra effort to make sure the user account is not compromised. What that exactly means
* will depend on the system and user settings; e.g. the user might be required to log in again
* unless their last login happened recently, or they might be given a second-factor challenge.
*
* Calling this method will result in one if these actions:
* - return true: all good.
* - return false and set a redirect: caller should abort; the redirect will take the user
* to the login page for reauthentication, and back.
* - throw an exception if there is no way for the user to meet the requirements without using
* a different access method (e.g. this functionality is only available from a specific IP).
*
* Note that this does not in any way check that the user is authorized to use this special page
* (use checkPermissions() for that).
*
* @param string|null $level A security level. Can be an arbitrary string, defaults to the page
* name.
* @return bool False means a redirect to the reauthentication page has been set and processing
* of the special page should be aborted.
* @throws ErrorPageError If the security level cannot be met, even with reauthentication.
*/
protected function checkLoginSecurityLevel( $level = null ) {
$level = $level ?: $this->getName();
$key = 'SpecialPage:reauth:' . $this->getName();
$request = $this->getRequest();
$securityStatus = MediaWikiServices::getInstance()->getAuthManager()
->securitySensitiveOperationStatus( $level );
if ( $securityStatus === AuthManager::SEC_OK ) {
$uniqueId = $request->getVal( 'postUniqueId' );
if ( $uniqueId ) {
$key .= ':' . $uniqueId;
$session = $request->getSession();
$data = $session->getSecret( $key );
if ( $data ) {
$session->remove( $key );
$this->setReauthPostData( $data );
}
}
return true;
} elseif ( $securityStatus === AuthManager::SEC_REAUTH ) {
$title = self::getTitleFor( 'Userlogin' );
$queryParams = $request->getQueryValues();
if ( $request->wasPosted() ) {
$data = array_diff_assoc( $request->getValues(), $request->getQueryValues() );
if ( $data ) {
// unique ID in case the same special page is open in multiple browser tabs
$uniqueId = MWCryptRand::generateHex( 6 );
$key .= ':' . $uniqueId;
$queryParams['postUniqueId'] = $uniqueId;
$session = $request->getSession();
$session->persist(); // Just in case
$session->setSecret( $key, $data );
}
}
$query = [
'returnto' => $this->getFullTitle()->getPrefixedDBkey(),
'returntoquery' => wfArrayToCgi( array_diff_key( $queryParams, [ 'title' => true ] ) ),
'force' => $level,
];
$url = $title->getFullURL( $query, false, PROTO_HTTPS );
$this->getOutput()->redirect( $url );
return false;
}
$titleMessage = wfMessage( 'specialpage-securitylevel-not-allowed-title' );
$errorMessage = wfMessage( 'specialpage-securitylevel-not-allowed' );
throw new ErrorPageError( $titleMessage, $errorMessage );
}
/**
* Return an array of subpages beginning with $search that this special page will accept.
*
* For example, if a page supports subpages "foo", "bar" and "baz" (as in Special:PageName/foo,
* etc.):
*
* - `prefixSearchSubpages( "ba" )` should return `[ "bar", "baz" ]`
* - `prefixSearchSubpages( "f" )` should return `[ "foo" ]`
* - `prefixSearchSubpages( "z" )` should return `[]`
* - `prefixSearchSubpages( "" )` should return `[ foo", "bar", "baz" ]`
*
* @stable to override
* @param string $search Prefix to search for
* @param int $limit Maximum number of results to return (usually 10)
* @param int $offset Number of results to skip (usually 0)
* @return string[] Matching subpages
*/
public function prefixSearchSubpages( $search, $limit, $offset ) {
$subpages = $this->getSubpagesForPrefixSearch();
if ( !$subpages ) {
return [];
}
return self::prefixSearchArray( $search, $limit, $subpages, $offset );
}
/**
* Return an array of subpages that this special page will accept for prefix
* searches. If this method requires a query you might instead want to implement
* prefixSearchSubpages() directly so you can support $limit and $offset. This
* method is better for static-ish lists of things.
*
* @stable to override
* @return string[] subpages to search from
*/
protected function getSubpagesForPrefixSearch() {
return [];
}
/**
* Perform a regular substring search for prefixSearchSubpages
* @param string $search Prefix to search for
* @param int $limit Maximum number of results to return (usually 10)
* @param int $offset Number of results to skip (usually 0)
* @return string[] Matching subpages
*/
protected function prefixSearchString( $search, $limit, $offset ) {
$title = Title::newFromText( $search );
if ( !$title || !$title->canExist() ) {
// No prefix suggestion in special and media namespace
return [];
}
$searchEngine = MediaWikiServices::getInstance()->newSearchEngine();
$searchEngine->setLimitOffset( $limit, $offset );
$searchEngine->setNamespaces( [] );
$result = $searchEngine->defaultPrefixSearch( $search );
return array_map( function ( Title $t ) {
return $t->getPrefixedText();
}, $result );
}
/**
* Helper function for implementations of prefixSearchSubpages() that
* filter the values in memory (as opposed to making a query).
*
* @since 1.24
* @param string $search
* @param int $limit
* @param array $subpages
* @param int $offset
* @return string[]
*/
protected static function prefixSearchArray( $search, $limit, array $subpages, $offset ) {
$escaped = preg_quote( $search, '/' );
return array_slice( preg_grep( "/^$escaped/i",
array_slice( $subpages, $offset ) ), 0, $limit );
}
/**
* Sets headers - this should be called from the execute() method of all derived classes!
* @stable to override
*/
protected function setHeaders() {
$out = $this->getOutput();
$out->setArticleRelated( false );
$out->setRobotPolicy( $this->getRobotPolicy() );
$out->setPageTitle( $this->getDescription() );
if ( $this->getConfig()->get( 'UseMediaWikiUIEverywhere' ) ) {
$out->addModuleStyles( [
'mediawiki.ui.input',
'mediawiki.ui.radio',
'mediawiki.ui.checkbox',
] );
}
}
/**
* Entry point.
*
* @since 1.20
*
* @param string|null $subPage
*/
final public function run( $subPage ) {
if ( !$this->getHookRunner()->onSpecialPageBeforeExecute( $this, $subPage ) ) {
return;
}
if ( $this->beforeExecute( $subPage ) === false ) {
return;
}
$this->execute( $subPage );
$this->afterExecute( $subPage );
$this->getHookRunner()->onSpecialPageAfterExecute( $this, $subPage );
}
/**
* Gets called before @see SpecialPage::execute.
* Return false to prevent calling execute() (since 1.27+).
*
* @stable to override
* @since 1.20
*
* @param string|null $subPage
* @return bool|void
*/
protected function beforeExecute( $subPage ) {
// No-op
}
/**
* Gets called after @see SpecialPage::execute.
*
* @stable to override
* @since 1.20
*
* @param string|null $subPage
*/
protected function afterExecute( $subPage ) {
// No-op
}
/**
* Default execute method
* Checks user permissions
*
* This must be overridden by subclasses; it will be made abstract in a future version
*
* @stable to override
*
* @param string|null $subPage
*/
public function execute( $subPage ) {
$this->setHeaders();
$this->checkPermissions();
$securityLevel = $this->getLoginSecurityLevel();
if ( $securityLevel !== false && !$this->checkLoginSecurityLevel( $securityLevel ) ) {
return;
}
$this->outputHeader();
}
/**
* 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. by extensions to stick with the naming conventions
* for message keys: 'extensionname-xxx'
*
* @stable to override
*
* @param string $summaryMessageKey Message key of the summary
*/
protected function outputHeader( $summaryMessageKey = '' ) {
if ( $summaryMessageKey == '' ) {
$msg = MediaWikiServices::getInstance()->getContentLanguage()->lc( $this->getName() ) .
'-summary';
} else {
$msg = $summaryMessageKey;
}
if ( !$this->msg( $msg )->isDisabled() && !$this->including() ) {
$this->getOutput()->wrapWikiMsg(
"\n$1\n
", $msg );
}
}
/**
* Returns the name that goes in the \ in the special page itself, and
* also the name that will be listed in Special:Specialpages
*
* Derived classes can override this, but usually it is easier to keep the
* default behavior.
*
* @stable to override
*
* @return string
*/
public function getDescription() {
return $this->msg( strtolower( $this->mName ) )->text();
}
/**
* Get a self-referential title object
*
* @param string|bool $subpage
* @return Title
* @since 1.23
*/
public function getPageTitle( $subpage = false ) {
return self::getTitleFor( $this->mName, $subpage );
}
/**
* Sets the context this SpecialPage is executed in
*
* @param IContextSource $context
* @since 1.18
*/
public function setContext( $context ) {
$this->mContext = $context;
}
/**
* Gets the context this SpecialPage is executed in
*
* @return IContextSource|RequestContext
* @since 1.18
*/
public function getContext() {
if ( $this->mContext instanceof IContextSource ) {
return $this->mContext;
} else {
wfDebug( __METHOD__ . " called and \$mContext is null. " .
"Return RequestContext::getMain(); for sanity" );
return RequestContext::getMain();
}
}
/**
* Get the WebRequest being used for this instance
*
* @return WebRequest
* @since 1.18
*/
public function getRequest() {
return $this->getContext()->getRequest();
}
/**
* Get the OutputPage being used for this instance
*
* @return OutputPage
* @since 1.18
*/
public function getOutput() {
return $this->getContext()->getOutput();
}
/**
* Shortcut to get the User executing this instance
*
* @return User
* @since 1.18
*/
public function getUser() {
return $this->getContext()->getUser();
}
/**
* Shortcut to get the skin being used for this instance
*
* @return Skin
* @since 1.18
*/
public function getSkin() {
return $this->getContext()->getSkin();
}
/**
* Shortcut to get user's language
*
* @return Language
* @since 1.19
*/
public function getLanguage() {
return $this->getContext()->getLanguage();
}
/**
* Shortcut to get language's converter
*
* @return ILanguageConverter
* @since 1.35
*/
protected function getLanguageConverter(): ILanguageConverter {
return MediaWikiServices::getInstance()->getLanguageConverterFactory()
->getLanguageConverter();
}
/**
* Shortcut to get main config object
* @return Config
* @since 1.24
*/
public function getConfig() {
return $this->getContext()->getConfig();
}
/**
* Return the full title, including $par
*
* @return Title
* @since 1.18
*/
public function getFullTitle() {
return $this->getContext()->getTitle();
}
/**
* Return the robot policy. Derived classes that override this can change
* the robot policy set by setHeaders() from the default 'noindex,nofollow'.
*
* @return string
* @since 1.23
*/
protected function getRobotPolicy() {
return 'noindex,nofollow';
}
/**
* Wrapper around wfMessage that sets the current context.
*
* @since 1.16
* @param string|string[]|MessageSpecifier $key
* @param mixed ...$params
* @return Message
* @see wfMessage
*/
public function msg( $key, ...$params ) {
$message = $this->getContext()->msg( $key, ...$params );
// RequestContext passes context to wfMessage, and the language is set from
// the context, but setting the language for Message class removes the
// interface message status, which breaks for example usernameless gender
// invocations. Restore the flag when not including special page in content.
if ( $this->including() ) {
$message->setInterfaceMessageFlag( false );
}
return $message;
}
/**
* Adds RSS/atom links
*
* @param array $params
*/
protected function addFeedLinks( $params ) {
$feedTemplate = wfScript( 'api' );
foreach ( $this->getConfig()->get( 'FeedClasses' ) as $format => $class ) {
$theseParams = $params + [ 'feedformat' => $format ];
$url = wfAppendQuery( $feedTemplate, $theseParams );
$this->getOutput()->addFeedLink( $format, $url );
}
}
/**
* Adds help link with an icon via page indicators.
* Link target can be overridden by a local message containing a wikilink:
* the message key is: lowercase special page name + '-helppage'.
* @param string $to Target MediaWiki.org page title or encoded URL.
* @param bool $overrideBaseUrl Whether $url is a full URL, to avoid MW.o.
* @since 1.25
*/
public function addHelpLink( $to, $overrideBaseUrl = false ) {
if ( $this->including() ) {
return;
}
$msg = $this->msg(
MediaWikiServices::getInstance()->getContentLanguage()->lc( $this->getName() ) .
'-helppage' );
if ( !$msg->isDisabled() ) {
$helpUrl = Skin::makeUrl( $msg->plain() );
$this->getOutput()->addHelpLink( $helpUrl, true );
} else {
$this->getOutput()->addHelpLink( $to, $overrideBaseUrl );
}
}
/**
* 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
*
* @return string Group of this special page
* @since 1.21
*/
public function getFinalGroupName() {
$name = $this->getName();
// Allow overriding the group from the wiki side
$msg = $this->msg( 'specialpages-specialpagegroup-' . strtolower( $name ) )->inContentLanguage();
if ( !$msg->isBlank() ) {
$group = $msg->text();
} else {
// Than use the group from this object
$group = $this->getGroupName();
}
return $group;
}
/**
* Indicates whether this special page may perform database writes
*
* @stable to override
*
* @return bool
* @since 1.27
*/
public function doesWrites() {
return false;
}
/**
* Under which header this special page is listed in Special:SpecialPages
* See messages 'specialpages-group-*' for valid names
* This method defaults to group 'other'
*
* @stable to override
*
* @return string
* @since 1.21
*/
protected function getGroupName() {
return 'other';
}
/**
* Call wfTransactionalTimeLimit() if this request was POSTed
* @since 1.26
*/
protected function useTransactionalTimeLimit() {
if ( $this->getRequest()->wasPosted() ) {
wfTransactionalTimeLimit();
}
}
/**
* @since 1.28
* @return \MediaWiki\Linker\LinkRenderer
*/
public function getLinkRenderer() {
if ( $this->linkRenderer ) {
return $this->linkRenderer;
} else {
return MediaWikiServices::getInstance()->getLinkRenderer();
}
}
/**
* @since 1.28
* @param \MediaWiki\Linker\LinkRenderer $linkRenderer
*/
public function setLinkRenderer( LinkRenderer $linkRenderer ) {
$this->linkRenderer = $linkRenderer;
}
/**
* Generate (prev x| next x) (20|50|100...) type links for paging
*
* @param int $offset
* @param int $limit
* @param array $query Optional URL query parameter string
* @param bool $atend Optional param for specified if this is the last page
* @param string|bool $subpage Optional param for specifying subpage
* @return string
*/
protected function buildPrevNextNavigation(
$offset,
$limit,
array $query = [],
$atend = false,
$subpage = false
) {
$title = $this->getPageTitle( $subpage );
$prevNext = new PrevNextNavigationRenderer( $this );
return $prevNext->buildPrevNextNavigation( $title, $offset, $limit, $query, $atend );
}
/**
* @since 1.35
* @internal
* @param HookContainer $hookContainer
*/
public function setHookContainer( HookContainer $hookContainer ) {
$this->hookContainer = $hookContainer;
$this->hookRunner = new HookRunner( $hookContainer );
}
/**
* @since 1.35
* @return HookContainer
*/
protected function getHookContainer() {
if ( !$this->hookContainer ) {
$this->hookContainer = MediaWikiServices::getInstance()->getHookContainer();
}
return $this->hookContainer;
}
/**
* @internal This is for use by core only. Hook interfaces may be removed
* without notice.
* @since 1.35
* @return HookRunner
*/
protected function getHookRunner() {
if ( !$this->hookRunner ) {
$this->hookRunner = new HookRunner( $this->getHookContainer() );
}
return $this->hookRunner;
}
}