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 * @todo Turn this into a real ContextSource
31 * @ingroup SpecialPage
34 // The canonical name of this special page
35 // Also used for the default <h1> heading, @see getDescription()
38 // The local name of this special page
41 // Minimum user level required to access this page, or "" for anyone.
42 // Also used to categorise the pages in Special:Specialpages
43 private $mRestriction;
45 // Listed in Special:Specialpages?
48 // Whether or not this special page is being included from an article
49 protected $mIncluding;
51 // Whether the special page can be included in an article
52 protected $mIncludable;
55 * Current request context
61 * Get a localised Title object for a specified special page name
64 * @param string|bool $subpage Subpage string, or false to not use a subpage
65 * @param string $fragment The link fragment (after the "#")
69 public static function getTitleFor( $name, $subpage = false, $fragment = '' ) {
70 $name = SpecialPageFactory
::getLocalNameFor( $name, $subpage );
72 return Title
::makeTitle( NS_SPECIAL
, $name, $fragment );
76 * Get a localised Title object for a page name with a possibly unvalidated subpage
79 * @param string|bool $subpage Subpage string, or false to not use a subpage
80 * @return Title|null Title object or null if the page doesn't exist
82 public static function getSafeTitleFor( $name, $subpage = false ) {
83 $name = SpecialPageFactory
::getLocalNameFor( $name, $subpage );
85 return Title
::makeTitleSafe( NS_SPECIAL
, $name );
92 * Default constructor for special pages
93 * Derivative classes should call this from their constructor
94 * Note that if the user does not have the required level, an error message will
95 * be displayed by the default execute() method, without the global function ever
98 * If you override execute(), you can recover the default behavior with userCanExecute()
99 * and displayRestrictionError()
101 * @param string $name Name of the special page, as seen in links and URLs
102 * @param string $restriction User right required, e.g. "block" or "delete"
103 * @param bool $listed Whether the page is listed in Special:Specialpages
104 * @param callable|bool $function Unused
105 * @param string $file Unused
106 * @param bool $includable Whether the page can be included in normal pages
108 public function __construct(
109 $name = '', $restriction = '', $listed = true,
110 $function = false, $file = '', $includable = false
112 $this->mName
= $name;
113 $this->mRestriction
= $restriction;
114 $this->mListed
= $listed;
115 $this->mIncludable
= $includable;
119 * Get the name of this Special Page.
127 * Get the permission that a user must have to execute this page
130 function getRestriction() {
131 return $this->mRestriction
;
134 // @todo FIXME: Decide which syntax to use for this, and stick to it
136 * Whether this special page is listed in Special:SpecialPages
140 function isListed() {
141 return $this->mListed
;
145 * Set whether this page is listed in Special:Specialpages, at run-time
147 * @param bool $listed
150 function setListed( $listed ) {
151 return wfSetVar( $this->mListed
, $listed );
155 * Get or set whether this special page is listed in Special:SpecialPages
160 function listed( $x = null ) {
161 return wfSetVar( $this->mListed
, $x );
165 * Whether it's allowed to transclude the special page via {{Special:Foo/params}}
168 public function isIncludable() {
169 return $this->mIncludable
;
173 * Whether the special page is being evaluated via transclusion
177 function including( $x = null ) {
178 return wfSetVar( $this->mIncluding
, $x );
182 * Get the localised name of the special page
185 function getLocalName() {
186 if ( !isset( $this->mLocalName
) ) {
187 $this->mLocalName
= SpecialPageFactory
::getLocalNameFor( $this->mName
);
190 return $this->mLocalName
;
194 * Is this page expensive (for some definition of expensive)?
195 * Expensive pages are disabled or cached in miser mode. Originally used
196 * (and still overridden) by QueryPage and subclasses, moved here so that
197 * Special:SpecialPages can safely call it for all special pages.
201 public function isExpensive() {
206 * Is this page cached?
207 * Expensive pages are cached or disabled in miser mode.
208 * Used by QueryPage and subclasses, moved here so that
209 * Special:SpecialPages can safely call it for all special pages.
214 public function isCached() {
219 * Can be overridden by subclasses with more complicated permissions
222 * @return bool Should the page be displayed with the restricted-access
225 public function isRestricted() {
226 // DWIM: If anons can do something, then it is not restricted
227 return $this->mRestriction
!= '' && !User
::groupHasPermission( '*', $this->mRestriction
);
231 * Checks if the given user (identified by an object) can execute this
232 * special page (as defined by $mRestriction). Can be overridden by sub-
233 * classes with more complicated permissions schemes.
235 * @param User $user The user to check
236 * @return bool Does the user have permission to view the page?
238 public function userCanExecute( User
$user ) {
239 return $user->isAllowed( $this->mRestriction
);
243 * Output an error message telling the user what access level they have to have
244 * @throws PermissionsError
246 function displayRestrictionError() {
247 throw new PermissionsError( $this->mRestriction
);
251 * Checks if userCanExecute, and if not throws a PermissionsError
255 * @throws PermissionsError
257 public function checkPermissions() {
258 if ( !$this->userCanExecute( $this->getUser() ) ) {
259 $this->displayRestrictionError();
264 * If the wiki is currently in readonly mode, throws a ReadOnlyError
268 * @throws ReadOnlyError
270 public function checkReadOnly() {
271 if ( wfReadOnly() ) {
272 throw new ReadOnlyError
;
277 * If the user is not logged in, throws UserNotLoggedIn error
279 * The user will be redirected to Special:Userlogin with the given message as an error on
283 * @param string $reasonMsg [optional] Message key to be displayed on login page
284 * @param string $titleMsg [optional] Passed on to UserNotLoggedIn constructor
285 * @throws UserNotLoggedIn
287 public function requireLogin(
288 $reasonMsg = 'exception-nologin-text', $titleMsg = 'exception-nologin'
290 if ( $this->getUser()->isAnon() ) {
291 throw new UserNotLoggedIn( $reasonMsg, $titleMsg );
296 * Return an array of subpages beginning with $search that this special page will accept.
298 * For example, if a page supports subpages "foo", "bar" and "baz" (as in Special:PageName/foo,
301 * - `prefixSearchSubpages( "ba" )` should return `array( "bar", "baz" )`
302 * - `prefixSearchSubpages( "f" )` should return `array( "foo" )`
303 * - `prefixSearchSubpages( "z" )` should return `array()`
304 * - `prefixSearchSubpages( "" )` should return `array( foo", "bar", "baz" )`
306 * @param string $search Prefix to search for
307 * @param int $limit Maximum number of results to return
308 * @return string[] Matching subpages
310 public function prefixSearchSubpages( $search, $limit = 10 ) {
315 * Helper function for implementations of prefixSearchSubpages() that
316 * filter the values in memory (as oppposed to making a query).
319 * @param string $search
321 * @param array $subpages
324 protected static function prefixSearchArray( $search, $limit, array $subpages ) {
325 $escaped = preg_quote( $search, '/' );
326 return array_slice( preg_grep( "/^$escaped/i", $subpages ), 0, $limit );
330 * Sets headers - this should be called from the execute() method of all derived classes!
332 function setHeaders() {
333 $out = $this->getOutput();
334 $out->setArticleRelated( false );
335 $out->setRobotPolicy( $this->getRobotPolicy() );
336 $out->setPageTitle( $this->getDescription() );
344 * @param string|null $subPage
346 final public function run( $subPage ) {
348 * Gets called before @see SpecialPage::execute.
352 * @param SpecialPage $this
353 * @param string|null $subPage
355 wfRunHooks( 'SpecialPageBeforeExecute', array( $this, $subPage ) );
357 $this->beforeExecute( $subPage );
358 $this->execute( $subPage );
359 $this->afterExecute( $subPage );
362 * Gets called after @see SpecialPage::execute.
366 * @param SpecialPage $this
367 * @param string|null $subPage
369 wfRunHooks( 'SpecialPageAfterExecute', array( $this, $subPage ) );
373 * Gets called before @see SpecialPage::execute.
377 * @param string|null $subPage
379 protected function beforeExecute( $subPage ) {
384 * Gets called after @see SpecialPage::execute.
388 * @param string|null $subPage
390 protected function afterExecute( $subPage ) {
395 * Default execute method
396 * Checks user permissions
398 * This must be overridden by subclasses; it will be made abstract in a future version
400 * @param string|null $subPage
402 public function execute( $subPage ) {
404 $this->checkPermissions();
405 $this->outputHeader();
409 * Outputs a summary message on top of special pages
410 * Per default the message key is the canonical name of the special page
411 * May be overridden, i.e. by extensions to stick with the naming conventions
412 * for message keys: 'extensionname-xxx'
414 * @param string $summaryMessageKey Message key of the summary
416 function outputHeader( $summaryMessageKey = '' ) {
419 if ( $summaryMessageKey == '' ) {
420 $msg = $wgContLang->lc( $this->getName() ) . '-summary';
422 $msg = $summaryMessageKey;
424 if ( !$this->msg( $msg )->isDisabled() && !$this->including() ) {
425 $this->getOutput()->wrapWikiMsg(
426 "<div class='mw-specialpage-summary'>\n$1\n</div>", $msg );
431 * Returns the name that goes in the \<h1\> in the special page itself, and
432 * also the name that will be listed in Special:Specialpages
434 * Derived classes can override this, but usually it is easier to keep the
439 function getDescription() {
440 return $this->msg( strtolower( $this->mName
) )->text();
444 * Get a self-referential title object
446 * @param string|bool $subpage
448 * @deprecated since 1.23, use SpecialPage::getPageTitle
450 function getTitle( $subpage = false ) {
451 return $this->getPageTitle( $subpage );
455 * Get a self-referential title object
457 * @param string|bool $subpage
461 function getPageTitle( $subpage = false ) {
462 return self
::getTitleFor( $this->mName
, $subpage );
466 * Sets the context this SpecialPage is executed in
468 * @param IContextSource $context
471 public function setContext( $context ) {
472 $this->mContext
= $context;
476 * Gets the context this SpecialPage is executed in
478 * @return IContextSource|RequestContext
481 public function getContext() {
482 if ( $this->mContext
instanceof IContextSource
) {
483 return $this->mContext
;
485 wfDebug( __METHOD__
. " called and \$mContext is null. " .
486 "Return RequestContext::getMain(); for sanity\n" );
488 return RequestContext
::getMain();
493 * Get the WebRequest being used for this instance
498 public function getRequest() {
499 return $this->getContext()->getRequest();
503 * Get the OutputPage being used for this instance
508 public function getOutput() {
509 return $this->getContext()->getOutput();
513 * Shortcut to get the User executing this instance
518 public function getUser() {
519 return $this->getContext()->getUser();
523 * Shortcut to get the skin being used for this instance
528 public function getSkin() {
529 return $this->getContext()->getSkin();
533 * Shortcut to get user's language
538 public function getLanguage() {
539 return $this->getContext()->getLanguage();
543 * Shortcut to get main config object
547 public function getConfig() {
548 return $this->getContext()->getConfig();
552 * Return the full title, including $par
557 public function getFullTitle() {
558 return $this->getContext()->getTitle();
562 * Return the robot policy. Derived classes that override this can change
563 * the robot policy set by setHeaders() from the default 'noindex,nofollow'.
568 protected function getRobotPolicy() {
569 return 'noindex,nofollow';
573 * Wrapper around wfMessage that sets the current context.
578 public function msg( /* $args */ ) {
579 $message = call_user_func_array(
580 array( $this->getContext(), 'msg' ),
583 // RequestContext passes context to wfMessage, and the language is set from
584 // the context, but setting the language for Message class removes the
585 // interface message status, which breaks for example usernameless gender
586 // invocations. Restore the flag when not including special page in content.
587 if ( $this->including() ) {
588 $message->setInterfaceMessageFlag( false );
595 * Adds RSS/atom links
597 * @param array $params
599 protected function addFeedLinks( $params ) {
600 $feedTemplate = wfScript( 'api' );
602 foreach ( $this->getConfig()->get( 'FeedClasses' ) as $format => $class ) {
603 $theseParams = $params +
array( 'feedformat' => $format );
604 $url = wfAppendQuery( $feedTemplate, $theseParams );
605 $this->getOutput()->addFeedLink( $format, $url );
610 * Get the group that the special page belongs in on Special:SpecialPage
611 * Use this method, instead of getGroupName to allow customization
612 * of the group name from the wiki side
614 * @return string Group of this special page
617 public function getFinalGroupName() {
618 $name = $this->getName();
619 $specialPageGroups = $this->getConfig()->get( 'SpecialPageGroups' );
621 // Allow overbidding the group from the wiki side
622 $msg = $this->msg( 'specialpages-specialpagegroup-' . strtolower( $name ) )->inContentLanguage();
623 if ( !$msg->isBlank() ) {
624 $group = $msg->text();
626 // Than use the group from this object
627 $group = $this->getGroupName();
629 // Group '-' is used as default to have the chance to determine,
630 // if the special pages overrides this method,
631 // if not overridden, $wgSpecialPageGroups is checked for b/c
632 if ( $group === '-' && isset( $specialPageGroups[$name] ) ) {
633 $group = $specialPageGroups[$name];
637 // never give '-' back, change to 'other'
638 if ( $group === '-' ) {
646 * Under which header this special page is listed in Special:SpecialPages
647 * See messages 'specialpages-group-*' for valid names
648 * This method defaults to group 'other'
653 protected function getGroupName() {
654 // '-' used here to determine, if this group is overridden or has a hardcoded 'other'
655 // Needed for b/c in getFinalGroupName