3 * Parent class for all special pages.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup SpecialPage
25 * Parent class for all special pages.
27 * Includes some static functions for handling the special page list deprecated
28 * in favor of SpecialPageFactory.
30 * @ingroup SpecialPage
33 // The canonical name of this special page
34 // Also used for the default <h1> heading, @see getDescription()
37 // The local name of this special page
40 // Minimum user level required to access this page, or "" for anyone.
41 // Also used to categorise the pages in Special:Specialpages
42 private $mRestriction;
44 // Listed in Special:Specialpages?
47 // Whether or not this special page is being included from an article
48 protected $mIncluding;
50 // Whether the special page can be included in an article
51 protected $mIncludable;
54 * Current request context
60 * Get a localised Title object for a specified special page name
63 * @param string|bool $subpage Subpage string, or false to not use a subpage
64 * @param string $fragment The link fragment (after the "#")
68 public static function getTitleFor( $name, $subpage = false, $fragment = '' ) {
69 $name = SpecialPageFactory
::getLocalNameFor( $name, $subpage );
71 return Title
::makeTitle( NS_SPECIAL
, $name, $fragment );
75 * Get a localised Title object for a page name with a possibly unvalidated subpage
78 * @param string|bool $subpage Subpage string, or false to not use a subpage
79 * @return Title|null Title object or null if the page doesn't exist
81 public static function getSafeTitleFor( $name, $subpage = false ) {
82 $name = SpecialPageFactory
::getLocalNameFor( $name, $subpage );
84 return Title
::makeTitleSafe( NS_SPECIAL
, $name );
91 * Default constructor for special pages
92 * Derivative classes should call this from their constructor
93 * Note that if the user does not have the required level, an error message will
94 * be displayed by the default execute() method, without the global function ever
97 * If you override execute(), you can recover the default behavior with userCanExecute()
98 * and displayRestrictionError()
100 * @param string $name Name of the special page, as seen in links and URLs
101 * @param string $restriction User right required, e.g. "block" or "delete"
102 * @param bool $listed Whether the page is listed in Special:Specialpages
103 * @param callable|bool $function Unused
104 * @param string $file Unused
105 * @param bool $includable Whether the page can be included in normal pages
107 public function __construct(
108 $name = '', $restriction = '', $listed = true,
109 $function = false, $file = '', $includable = false
111 $this->mName
= $name;
112 $this->mRestriction
= $restriction;
113 $this->mListed
= $listed;
114 $this->mIncludable
= $includable;
118 * Get the name of this Special Page.
126 * Get the permission that a user must have to execute this page
129 function getRestriction() {
130 return $this->mRestriction
;
133 // @todo FIXME: Decide which syntax to use for this, and stick to it
135 * Whether this special page is listed in Special:SpecialPages
139 function isListed() {
140 return $this->mListed
;
144 * Set whether this page is listed in Special:Specialpages, at run-time
146 * @param bool $listed
149 function setListed( $listed ) {
150 return wfSetVar( $this->mListed
, $listed );
154 * Get or set whether this special page is listed in Special:SpecialPages
159 function listed( $x = null ) {
160 return wfSetVar( $this->mListed
, $x );
164 * Whether it's allowed to transclude the special page via {{Special:Foo/params}}
167 public function isIncludable() {
168 return $this->mIncludable
;
172 * Whether the special page is being evaluated via transclusion
176 function including( $x = null ) {
177 return wfSetVar( $this->mIncluding
, $x );
181 * Get the localised name of the special page
184 function getLocalName() {
185 if ( !isset( $this->mLocalName
) ) {
186 $this->mLocalName
= SpecialPageFactory
::getLocalNameFor( $this->mName
);
189 return $this->mLocalName
;
193 * Is this page expensive (for some definition of expensive)?
194 * Expensive pages are disabled or cached in miser mode. Originally used
195 * (and still overridden) by QueryPage and subclasses, moved here so that
196 * Special:SpecialPages can safely call it for all special pages.
200 public function isExpensive() {
205 * Is this page cached?
206 * Expensive pages are cached or disabled in miser mode.
207 * Used by QueryPage and subclasses, moved here so that
208 * Special:SpecialPages can safely call it for all special pages.
213 public function isCached() {
218 * Can be overridden by subclasses with more complicated permissions
221 * @return bool Should the page be displayed with the restricted-access
224 public function isRestricted() {
225 // DWIM: If anons can do something, then it is not restricted
226 return $this->mRestriction
!= '' && !User
::groupHasPermission( '*', $this->mRestriction
);
230 * Checks if the given user (identified by an object) can execute this
231 * special page (as defined by $mRestriction). Can be overridden by sub-
232 * classes with more complicated permissions schemes.
234 * @param User $user The user to check
235 * @return bool Does the user have permission to view the page?
237 public function userCanExecute( User
$user ) {
238 return $user->isAllowed( $this->mRestriction
);
242 * Output an error message telling the user what access level they have to have
243 * @throws PermissionsError
245 function displayRestrictionError() {
246 throw new PermissionsError( $this->mRestriction
);
250 * Checks if userCanExecute, and if not throws a PermissionsError
254 * @throws PermissionsError
256 public function checkPermissions() {
257 if ( !$this->userCanExecute( $this->getUser() ) ) {
258 $this->displayRestrictionError();
263 * If the wiki is currently in readonly mode, throws a ReadOnlyError
267 * @throws ReadOnlyError
269 public function checkReadOnly() {
270 if ( wfReadOnly() ) {
271 throw new ReadOnlyError
;
276 * If the user is not logged in, throws UserNotLoggedIn error
278 * The user will be redirected to Special:Userlogin with the given message as an error on
282 * @param string $reasonMsg [optional] Message key to be displayed on login page
283 * @param string $titleMsg [optional] Passed on to UserNotLoggedIn constructor
284 * @throws UserNotLoggedIn
286 public function requireLogin(
287 $reasonMsg = 'exception-nologin-text', $titleMsg = 'exception-nologin'
289 if ( $this->getUser()->isAnon() ) {
290 throw new UserNotLoggedIn( $reasonMsg, $titleMsg );
295 * Return an array of subpages beginning with $search that this special page will accept.
297 * For example, if a page supports subpages "foo", "bar" and "baz" (as in Special:PageName/foo,
300 * - `prefixSearchSubpages( "ba" )` should return `array( "bar", "baz" )`
301 * - `prefixSearchSubpages( "f" )` should return `array( "foo" )`
302 * - `prefixSearchSubpages( "z" )` should return `array()`
303 * - `prefixSearchSubpages( "" )` should return `array( foo", "bar", "baz" )`
305 * @param string $search Prefix to search for
306 * @param int $limit Maximum number of results to return
307 * @return string[] Matching subpages
309 public function prefixSearchSubpages( $search, $limit = 10 ) {
314 * Helper function for implementations of prefixSearchSubpages() that
315 * filter the values in memory (as oppposed to making a query).
318 * @param string $search
320 * @param array $subpages
323 protected static function prefixSearchArray( $search, $limit, array $subpages ) {
324 $escaped = preg_quote( $search, '/' );
325 return array_slice( preg_grep( "/^$escaped/i", $subpages ), 0, $limit );
329 * Sets headers - this should be called from the execute() method of all derived classes!
331 function setHeaders() {
332 $out = $this->getOutput();
333 $out->setArticleRelated( false );
334 $out->setRobotPolicy( $this->getRobotPolicy() );
335 $out->setPageTitle( $this->getDescription() );
343 * @param string|null $subPage
345 final public function run( $subPage ) {
347 * Gets called before @see SpecialPage::execute.
351 * @param SpecialPage $this
352 * @param string|null $subPage
354 wfRunHooks( 'SpecialPageBeforeExecute', array( $this, $subPage ) );
356 $this->beforeExecute( $subPage );
357 $this->execute( $subPage );
358 $this->afterExecute( $subPage );
361 * Gets called after @see SpecialPage::execute.
365 * @param SpecialPage $this
366 * @param string|null $subPage
368 wfRunHooks( 'SpecialPageAfterExecute', array( $this, $subPage ) );
372 * Gets called before @see SpecialPage::execute.
376 * @param string|null $subPage
378 protected function beforeExecute( $subPage ) {
383 * Gets called after @see SpecialPage::execute.
387 * @param string|null $subPage
389 protected function afterExecute( $subPage ) {
394 * Default execute method
395 * Checks user permissions
397 * This must be overridden by subclasses; it will be made abstract in a future version
399 * @param string|null $subPage
401 public function execute( $subPage ) {
403 $this->checkPermissions();
404 $this->outputHeader();
408 * Outputs a summary message on top of special pages
409 * Per default the message key is the canonical name of the special page
410 * May be overridden, i.e. by extensions to stick with the naming conventions
411 * for message keys: 'extensionname-xxx'
413 * @param string $summaryMessageKey Message key of the summary
415 function outputHeader( $summaryMessageKey = '' ) {
418 if ( $summaryMessageKey == '' ) {
419 $msg = $wgContLang->lc( $this->getName() ) . '-summary';
421 $msg = $summaryMessageKey;
423 if ( !$this->msg( $msg )->isDisabled() && !$this->including() ) {
424 $this->getOutput()->wrapWikiMsg(
425 "<div class='mw-specialpage-summary'>\n$1\n</div>", $msg );
430 * Returns the name that goes in the \<h1\> in the special page itself, and
431 * also the name that will be listed in Special:Specialpages
433 * Derived classes can override this, but usually it is easier to keep the
438 function getDescription() {
439 return $this->msg( strtolower( $this->mName
) )->text();
443 * Get a self-referential title object
445 * @param string|bool $subpage
447 * @deprecated since 1.23, use SpecialPage::getPageTitle
449 function getTitle( $subpage = false ) {
450 return $this->getPageTitle( $subpage );
454 * Get a self-referential title object
456 * @param string|bool $subpage
460 function getPageTitle( $subpage = false ) {
461 return self
::getTitleFor( $this->mName
, $subpage );
465 * Sets the context this SpecialPage is executed in
467 * @param IContextSource $context
470 public function setContext( $context ) {
471 $this->mContext
= $context;
475 * Gets the context this SpecialPage is executed in
477 * @return IContextSource|RequestContext
480 public function getContext() {
481 if ( $this->mContext
instanceof IContextSource
) {
482 return $this->mContext
;
484 wfDebug( __METHOD__
. " called and \$mContext is null. " .
485 "Return RequestContext::getMain(); for sanity\n" );
487 return RequestContext
::getMain();
492 * Get the WebRequest being used for this instance
497 public function getRequest() {
498 return $this->getContext()->getRequest();
502 * Get the OutputPage being used for this instance
507 public function getOutput() {
508 return $this->getContext()->getOutput();
512 * Shortcut to get the User executing this instance
517 public function getUser() {
518 return $this->getContext()->getUser();
522 * Shortcut to get the skin being used for this instance
527 public function getSkin() {
528 return $this->getContext()->getSkin();
532 * Shortcut to get user's language
537 public function getLanguage() {
538 return $this->getContext()->getLanguage();
542 * Shortcut to get main config object
546 public function getConfig() {
547 return $this->getContext()->getConfig();
551 * Return the full title, including $par
556 public function getFullTitle() {
557 return $this->getContext()->getTitle();
561 * Return the robot policy. Derived classes that override this can change
562 * the robot policy set by setHeaders() from the default 'noindex,nofollow'.
567 protected function getRobotPolicy() {
568 return 'noindex,nofollow';
572 * Wrapper around wfMessage that sets the current context.
577 public function msg( /* $args */ ) {
578 $message = call_user_func_array(
579 array( $this->getContext(), 'msg' ),
582 // RequestContext passes context to wfMessage, and the language is set from
583 // the context, but setting the language for Message class removes the
584 // interface message status, which breaks for example usernameless gender
585 // invocations. Restore the flag when not including special page in content.
586 if ( $this->including() ) {
587 $message->setInterfaceMessageFlag( false );
594 * Adds RSS/atom links
596 * @param array $params
598 protected function addFeedLinks( $params ) {
599 $feedTemplate = wfScript( 'api' );
601 foreach ( $this->getConfig()->get( 'FeedClasses' ) as $format => $class ) {
602 $theseParams = $params +
array( 'feedformat' => $format );
603 $url = wfAppendQuery( $feedTemplate, $theseParams );
604 $this->getOutput()->addFeedLink( $format, $url );
609 * Get the group that the special page belongs in on Special:SpecialPage
610 * Use this method, instead of getGroupName to allow customization
611 * of the group name from the wiki side
613 * @return string Group of this special page
616 public function getFinalGroupName() {
617 $name = $this->getName();
618 $specialPageGroups = $this->getConfig()->get( 'SpecialPageGroups' );
620 // Allow overbidding the group from the wiki side
621 $msg = $this->msg( 'specialpages-specialpagegroup-' . strtolower( $name ) )->inContentLanguage();
622 if ( !$msg->isBlank() ) {
623 $group = $msg->text();
625 // Than use the group from this object
626 $group = $this->getGroupName();
628 // Group '-' is used as default to have the chance to determine,
629 // if the special pages overrides this method,
630 // if not overridden, $wgSpecialPageGroups is checked for b/c
631 if ( $group === '-' && isset( $specialPageGroups[$name] ) ) {
632 $group = $specialPageGroups[$name];
636 // never give '-' back, change to 'other'
637 if ( $group === '-' ) {
645 * Under which header this special page is listed in Special:SpecialPages
646 * See messages 'specialpages-group-*' for valid names
647 * This method defaults to group 'other'
652 protected function getGroupName() {
653 // '-' used here to determine, if this group is overridden or has a hardcoded 'other'
654 // Needed for b/c in getFinalGroupName