3 * SpecialPage: handling special pages and lists thereof.
5 * To add a special page in an extension, add to $wgSpecialPages either
6 * an object instance or an array containing the name and constructor
7 * parameters. The latter is preferred for performance reasons.
9 * The object instantiated must be either an instance of SpecialPage or a
10 * sub-class thereof. It must have an execute() method, which sends the HTML
11 * for the special page to $wgOut. The parent class has an execute() method
12 * which distributes the call to the historical global functions. Additionally,
13 * execute() also checks if the user has the necessary access privileges
14 * and bails out if not.
16 * To add a core special page, use the similar static list in
17 * SpecialPage::$mList. To remove a core static special page at runtime, use
18 * a SpecialPage_initList hook.
21 * @subpackage SpecialPage
29 * Parent special page class, also static functions for handling the special
39 * The name of the class, used in the URL.
40 * Also used for the default <h1> heading, @see getDescription()
44 * Minimum user level required to access this page, or "" for anyone.
45 * Also used to categorise the pages in Special:Specialpages
49 * Listed in Special:Specialpages?
53 * Function name called by the default execute()
57 * File which needs to be included before the function above can be called
61 * Whether or not this special page is being included from an article
65 * Whether the special page can be included in an article
69 static public $mList = array(
70 'DoubleRedirects' => array( 'SpecialPage', 'DoubleRedirects' ),
71 'BrokenRedirects' => array( 'SpecialPage', 'BrokenRedirects' ),
72 'Disambiguations' => array( 'SpecialPage', 'Disambiguations' ),
74 'Userlogin' => array( 'SpecialPage', 'Userlogin' ),
75 'Userlogout' => array( 'UnlistedSpecialPage', 'Userlogout' ),
76 'Preferences' => array( 'SpecialPage', 'Preferences' ),
77 'Watchlist' => array( 'SpecialPage', 'Watchlist' ),
79 'Recentchanges' => array( 'IncludableSpecialPage', 'Recentchanges' ),
80 'Upload' => array( 'SpecialPage', 'Upload' ),
81 'Imagelist' => array( 'SpecialPage', 'Imagelist' ),
82 'Newimages' => array( 'IncludableSpecialPage', 'Newimages' ),
83 'Listusers' => array( 'SpecialPage', 'Listusers' ),
84 'Statistics' => array( 'SpecialPage', 'Statistics' ),
85 'Random' => array( 'SpecialPage', 'Randompage' ),
86 'Lonelypages' => array( 'SpecialPage', 'Lonelypages' ),
87 'Uncategorizedpages'=> array( 'SpecialPage', 'Uncategorizedpages' ),
88 'Uncategorizedcategories'=> array( 'SpecialPage', 'Uncategorizedcategories' ),
89 'Uncategorizedimages' => array( 'SpecialPage', 'Uncategorizedimages' ),
90 'Unusedcategories' => array( 'SpecialPage', 'Unusedcategories' ),
91 'Unusedimages' => array( 'SpecialPage', 'Unusedimages' ),
92 'Wantedpages' => array( 'IncludableSpecialPage', 'Wantedpages' ),
93 'Wantedcategories' => array( 'SpecialPage', 'Wantedcategories' ),
94 'Mostlinked' => array( 'SpecialPage', 'Mostlinked' ),
95 'Mostlinkedcategories' => array( 'SpecialPage', 'Mostlinkedcategories' ),
96 'Mostcategories' => array( 'SpecialPage', 'Mostcategories' ),
97 'Mostimages' => array( 'SpecialPage', 'Mostimages' ),
98 'Mostrevisions' => array( 'SpecialPage', 'Mostrevisions' ),
99 'Shortpages' => array( 'SpecialPage', 'Shortpages' ),
100 'Longpages' => array( 'SpecialPage', 'Longpages' ),
101 'Newpages' => array( 'IncludableSpecialPage', 'Newpages' ),
102 'Ancientpages' => array( 'SpecialPage', 'Ancientpages' ),
103 'Deadendpages' => array( 'SpecialPage', 'Deadendpages' ),
104 'Allpages' => array( 'IncludableSpecialPage', 'Allpages' ),
105 'Prefixindex' => array( 'IncludableSpecialPage', 'Prefixindex' ) ,
106 'Ipblocklist' => array( 'SpecialPage', 'Ipblocklist' ),
107 'Specialpages' => array( 'UnlistedSpecialPage', 'Specialpages' ),
108 'Contributions' => array( 'UnlistedSpecialPage', 'Contributions' ),
109 'Emailuser' => array( 'UnlistedSpecialPage', 'Emailuser' ),
110 'Whatlinkshere' => array( 'UnlistedSpecialPage', 'Whatlinkshere' ),
111 'Recentchangeslinked' => array( 'UnlistedSpecialPage', 'Recentchangeslinked' ),
112 'Movepage' => array( 'UnlistedSpecialPage', 'Movepage' ),
113 'Blockme' => array( 'UnlistedSpecialPage', 'Blockme' ),
114 'Booksources' => array( 'SpecialPage', 'Booksources' ),
115 'Categories' => array( 'SpecialPage', 'Categories' ),
116 'Export' => array( 'SpecialPage', 'Export' ),
117 'Version' => array( 'SpecialPage', 'Version' ),
118 'Allmessages' => array( 'SpecialPage', 'Allmessages' ),
119 'Log' => array( 'SpecialPage', 'Log' ),
120 'Blockip' => array( 'SpecialPage', 'Blockip', 'block' ),
121 'Undelete' => array( 'SpecialPage', 'Undelete', 'deletedhistory' ),
122 "Import" => array( 'SpecialPage', "Import", 'import' ),
123 'Lockdb' => array( 'SpecialPage', 'Lockdb', 'siteadmin' ),
124 'Unlockdb' => array( 'SpecialPage', 'Unlockdb', 'siteadmin' ),
125 'Userrights' => array( 'SpecialPage', 'Userrights', 'userrights' ),
126 'MIMEsearch' => array( 'SpecialPage', 'MIMEsearch' ),
127 'Unwatchedpages' => array( 'SpecialPage', 'Unwatchedpages', 'unwatchedpages' ),
128 'Listredirects' => array( 'SpecialPage', 'Listredirects' ),
129 'Revisiondelete' => array( 'SpecialPage', 'Revisiondelete', 'deleterevision' ),
130 'Unusedtemplates' => array( 'SpecialPage', 'Unusedtemplates' ),
131 'Randomredirect' => array( 'SpecialPage', 'Randomredirect' ),
134 static public $mListInitialised = false;
139 * Initialise the special page list
140 * This must be called before accessing SpecialPage::$mList
142 static function initList() {
143 global $wgSpecialPages;
144 global $wgDisableCounters, $wgDisableInternalSearch, $wgEmailAuthentication;
146 if ( self
::$mListInitialised ) {
149 wfProfileIn( __METHOD__
);
151 if( !$wgDisableCounters ) {
152 self
::$mList['Popularpages'] = array( 'SpecialPage', 'Popularpages' );
155 if( !$wgDisableInternalSearch ) {
156 self
::$mList['Search'] = array( 'SpecialPage', 'Search' );
159 if( $wgEmailAuthentication ) {
160 self
::$mList['Confirmemail'] = array( 'UnlistedSpecialPage', 'Confirmemail' );
163 # Add extension special pages
164 self
::$mList = array_merge( self
::$mList, $wgSpecialPages );
166 # Better to set this now, to avoid infinite recursion in carelessly written hooks
167 self
::$mListInitialised = true;
170 # This hook can be used to remove undesired built-in special pages
171 wfRunHooks( 'SpecialPage_initList', array( &self
::$mList ) );
172 wfProfileOut( __METHOD__
);
176 * Add a page to the list of valid special pages. This used to be the preferred
177 * method for adding special pages in extensions. It's now suggested that you add
178 * an associative record to $wgSpecialPages. This avoids autoloading SpecialPage.
180 * @param mixed $page Must either be an array specifying a class name and
181 * constructor parameters, or an object. The object,
182 * when constructed, must have an execute() method which
183 * sends HTML to $wgOut.
186 static function addPage( &$page ) {
187 if ( !self
::$mListInitialised ) {
190 self
::$mList[$page->mName
] = $page;
194 * Remove a special page from the list
195 * Formerly used to disable expensive or dangerous special pages. The
196 * preferred method is now to add a SpecialPage_initList hook.
200 static function removePage( $name ) {
201 if ( !self
::$mListInitialised ) {
204 unset( self
::$mList[$name] );
208 * Find the object with a given name and return it (or NULL)
210 * @param string $name
212 static function getPage( $name ) {
213 if ( !self
::$mListInitialised ) {
216 if ( array_key_exists( $name, self
::$mList ) ) {
217 $rec = self
::$mList[$name];
218 if ( is_string( $rec ) ) {
220 self
::$mList[$name] = new $className;
221 } elseif ( is_array( $rec ) ) {
222 $className = array_shift( $rec );
223 self
::$mList[$name] = wfCreateObject( $className, $rec );
225 return self
::$mList[$name];
234 * @param string $name
235 * @return mixed Title object if the redirect exists, otherwise NULL
237 static function getRedirect( $name ) {
241 'Mypage' => Title
::makeTitle( NS_USER
, $wgUser->getName() ),
242 'Mytalk' => Title
::makeTitle( NS_USER_TALK
, $wgUser->getName() ),
243 'Mycontributions' => Title
::makeTitle( NS_SPECIAL
, 'Contributions/' . $wgUser->getName() ),
244 'Listadmins' => Title
::makeTitle( NS_SPECIAL
, 'Listusers/sysop' ), # @bug 2832
245 'Logs' => Title
::makeTitle( NS_SPECIAL
, 'Log' ),
246 'Randompage' => Title
::makeTitle( NS_SPECIAL
, 'Random' ),
247 'Userlist' => Title
::makeTitle( NS_SPECIAL
, 'Listusers' )
249 wfRunHooks( 'SpecialPageGetRedirect', array( &$redirects ) );
251 return isset( $redirects[$name] ) ?
$redirects[$name] : null;
255 * Return part of the request string for a special redirect page
256 * This allows passing, e.g. action=history to Special:Mypage, etc.
258 * @param $name Name of the redirect page
261 function getRedirectParams( $name ) {
269 $args = array( 'action' );
273 foreach( $args as $arg ) {
274 if( $val = $wgRequest->getVal( $arg, false ) )
275 $params[] = $arg . '=' . $val;
278 return count( $params ) ?
implode( '&', $params ) : false;
282 * Return categorised listable special pages
283 * Returns a 2d array where the first index is the restriction name
286 static function getPages() {
287 if ( !self
::$mListInitialised ) {
293 'developer' => array()
296 foreach ( self
::$mList as $name => $rec ) {
297 $page = self
::getPage( $name );
298 if ( $page->isListed() ) {
299 $pages[$page->getRestriction()][$page->getName()] = $page;
306 * Execute a special page path.
307 * The path may contain parameters, e.g. Special:Name/Params
308 * Extracts the special page name and call the execute method, passing the parameters
310 * Returns a title object if the page is redirected, false if there was no such special
311 * page, and true if it was successful.
313 * @param $title a title object
314 * @param $including output is being captured for use in {{special:whatever}}
316 static function executePath( &$title, $including = false ) {
317 global $wgOut, $wgTitle;
318 $fname = 'SpecialPage::executePath';
319 wfProfileIn( $fname );
321 $bits = split( "/", $title->getDBkey(), 2 );
323 if( !isset( $bits[1] ) ) { // bug 2087
329 $page = SpecialPage
::getPage( $name );
330 if ( is_null( $page ) ) {
332 wfProfileOut( $fname );
335 $redir = SpecialPage
::getRedirect( $name );
336 if ( isset( $redir ) ) {
338 $redir = Title
::makeTitle( $redir->getNamespace(), $redir->getText() . '/' . $par );
339 $params = SpecialPage
::getRedirectParams( $name );
341 $url = $redir->getFullUrl( $params );
343 $url = $redir->getFullUrl();
345 $wgOut->redirect( $url );
347 $wgOut->redirect( $url );
350 $wgOut->setArticleRelated( false );
351 $wgOut->setRobotpolicy( 'noindex,nofollow' );
352 $wgOut->setStatusCode( 404 );
353 $wgOut->showErrorPage( 'nosuchspecialpage', 'nospecialpagetext' );
358 if ( $including && !$page->includable() ) {
359 wfProfileOut( $fname );
361 } elseif ( !$including ) {
363 $wgTitle = Title
::makeTitle( NS_SPECIAL
, $name );
368 $page->including( $including );
370 $profName = 'Special:' . $page->getName();
371 wfProfileIn( $profName );
372 $page->execute( $par );
373 wfProfileOut( $profName );
376 wfProfileOut( $fname );
381 * Just like executePath() except it returns the HTML instead of outputting it
382 * Returns false if there was no such special page, or a title object if it was
386 static function capturePath( &$title ) {
387 global $wgOut, $wgTitle;
389 $oldTitle = $wgTitle;
391 $wgOut = new OutputPage
;
393 $ret = SpecialPage
::executePath( $title, true );
394 if ( $ret === true ) {
395 $ret = $wgOut->getHTML();
397 $wgTitle = $oldTitle;
403 * Default constructor for special pages
404 * Derivative classes should call this from their constructor
405 * Note that if the user does not have the required level, an error message will
406 * be displayed by the default execute() method, without the global function ever
409 * If you override execute(), you can recover the default behaviour with userCanExecute()
410 * and displayRestrictionError()
412 * @param string $name Name of the special page, as seen in links and URLs
413 * @param string $restriction User right required, e.g. "block" or "delete"
414 * @param boolean $listed Whether the page is listed in Special:Specialpages
415 * @param string $function Function called by execute(). By default it is constructed from $name
416 * @param string $file File which is included by execute(). It is also constructed from $name by default
418 function SpecialPage( $name = '', $restriction = '', $listed = true, $function = false, $file = 'default', $includable = false ) {
419 $this->mName
= $name;
420 $this->mRestriction
= $restriction;
421 $this->mListed
= $listed;
422 $this->mIncludable
= $includable;
423 if ( $function == false ) {
424 $this->mFunction
= 'wfSpecial'.$name;
426 $this->mFunction
= $function;
428 if ( $file === 'default' ) {
429 $this->mFile
= "Special{$name}.php";
431 $this->mFile
= $file;
440 function getName() { return $this->mName
; }
441 function getRestriction() { return $this->mRestriction
; }
442 function getFile() { return $this->mFile
; }
443 function isListed() { return $this->mListed
; }
447 * Accessor and mutator
449 function name( $x = NULL ) { return wfSetVar( $this->mName
, $x ); }
450 function restrictions( $x = NULL) { return wfSetVar( $this->mRestrictions
, $x ); }
451 function listed( $x = NULL) { return wfSetVar( $this->mListed
, $x ); }
452 function func( $x = NULL) { return wfSetVar( $this->mFunction
, $x ); }
453 function file( $x = NULL) { return wfSetVar( $this->mFile
, $x ); }
454 function includable( $x = NULL ) { return wfSetVar( $this->mIncludable
, $x ); }
455 function including( $x = NULL ) { return wfSetVar( $this->mIncluding
, $x ); }
459 * Checks if the given user (identified by an object) can execute this
460 * special page (as defined by $mRestriction)
462 function userCanExecute( &$user ) {
463 return $user->isAllowed( $this->mRestriction
);
467 * Output an error message telling the user what access level they have to have
469 function displayRestrictionError() {
471 $wgOut->permissionRequired( $this->mRestriction
);
475 * Sets headers - this should be called from the execute() method of all derived classes!
477 function setHeaders() {
479 $wgOut->setArticleRelated( false );
480 $wgOut->setRobotPolicy( "noindex,nofollow" );
481 $wgOut->setPageTitle( $this->getDescription() );
485 * Default execute method
486 * Checks user permissions, calls the function given in mFunction
488 function execute( $par ) {
493 if ( $this->userCanExecute( $wgUser ) ) {
494 $func = $this->mFunction
;
495 // only load file if the function does not exist
496 if(!function_exists($func) and $this->mFile
) {
497 require_once( $this->mFile
);
499 if ( wfRunHooks( 'SpecialPageExecuteBeforeHeader', array( &$this, &$par, &$func ) ) )
500 $this->outputHeader();
501 if ( ! wfRunHooks( 'SpecialPageExecuteBeforePage', array( &$this, &$par, &$func ) ) )
503 $func( $par, $this );
504 if ( ! wfRunHooks( 'SpecialPageExecuteAfterPage', array( &$this, &$par, &$func ) ) )
507 $this->displayRestrictionError();
511 function outputHeader() {
512 global $wgOut, $wgContLang;
514 $msg = $wgContLang->lc( $this->name() ) . '-summary';
515 $out = wfMsg( $msg );
516 if ( ! wfEmptyMsg( $msg, $out ) and $out !== '' and ! $this->including() )
517 $wgOut->addWikiText( $out );
521 # Returns the name that goes in the <h1> in the special page itself, and also the name that
522 # will be listed in Special:Specialpages
524 # Derived classes can override this, but usually it is easier to keep the default behaviour.
525 # Messages can be added at run-time, see MessageCache.php
526 function getDescription() {
527 return wfMsg( strtolower( $this->mName
) );
531 * Get a self-referential title object
533 function getTitle() {
534 return Title
::makeTitle( NS_SPECIAL
, $this->mName
);
538 * Set whether this page is listed in Special:Specialpages, at run-time
540 function setListed( $listed ) {
541 return wfSetVar( $this->mListed
, $listed );
547 * Shortcut to construct a special page which is unlisted by default
550 class UnlistedSpecialPage
extends SpecialPage
552 function UnlistedSpecialPage( $name, $restriction = '', $function = false, $file = 'default' ) {
553 SpecialPage
::SpecialPage( $name, $restriction, false, $function, $file );
558 * Shortcut to construct an includable special page
561 class IncludableSpecialPage
extends SpecialPage
563 function IncludableSpecialPage( $name, $restriction = '', $listed = true, $function = false, $file = 'default' ) {
564 SpecialPage
::SpecialPage( $name, $restriction, $listed, $function, $file, true );