3 * SpecialPage: handling special pages and lists thereof
4 * $wgSpecialPages is a list of all SpecialPage objects. These objects are
5 * either instances of SpecialPage or a sub-class thereof. They have an
6 * execute() method, which sends the HTML for the special page to $wgOut.
7 * The parent class has an execute() method which distributes the call to
8 * the historical global functions. Additionally, execute() also checks if the
9 * user has the necessary access privileges and bails out if not.
11 * To add a special page at run-time, use SpecialPage::addPage().
12 * DO NOT manipulate this array at run-time.
15 * @subpackage SpecialPage
22 $wgSpecialPages = array(
23 'DoubleRedirects' => new SpecialPage ( 'DoubleRedirects' ),
24 'BrokenRedirects' => new SpecialPage ( 'BrokenRedirects' ),
25 'Disambiguations' => new SpecialPage ( 'Disambiguations' ),
27 'Userlogin' => new SpecialPage( 'Userlogin' ),
28 'Userlogout' => new UnlistedSpecialPage( 'Userlogout' ),
29 'Preferences' => new SpecialPage( 'Preferences' ),
30 'Watchlist' => new SpecialPage( 'Watchlist' ),
32 'Recentchanges' => new IncludableSpecialPage( 'Recentchanges' ),
33 'Upload' => new SpecialPage( 'Upload' ),
34 'Imagelist' => new SpecialPage( 'Imagelist' ),
35 'Newimages' => new IncludableSpecialPage( 'Newimages' ),
36 'Listusers' => new SpecialPage( 'Listusers' ),
37 'Statistics' => new SpecialPage( 'Statistics' ),
38 'Random' => new SpecialPage( 'Randompage' ),
39 'Lonelypages' => new SpecialPage( 'Lonelypages' ),
40 'Uncategorizedpages'=> new SpecialPage( 'Uncategorizedpages' ),
41 'Uncategorizedcategories'=> new SpecialPage( 'Uncategorizedcategories' ),
42 'Unusedcategories' => new SpecialPage( 'Unusedcategories' ),
43 'Unusedimages' => new SpecialPage( 'Unusedimages' ),
44 'Wantedpages' => new IncludableSpecialPage( 'Wantedpages' ),
45 'Wantedcategories' => new SpecialPage( 'Wantedcategories' ),
46 'Mostlinked' => new SpecialPage( 'Mostlinked' ),
47 'Mostlinkedcategories' => new SpecialPage( 'Mostlinkedcategories' ),
48 'Mostcategories' => new SpecialPage( 'Mostcategories' ),
49 'Mostimages' => new SpecialPage( 'Mostimages' ),
50 'Mostrevisions' => new SpecialPage( 'Mostrevisions' ),
51 'Shortpages' => new SpecialPage( 'Shortpages' ),
52 'Longpages' => new SpecialPage( 'Longpages' ),
53 'Newpages' => new IncludableSpecialPage( 'Newpages' ),
54 'Ancientpages' => new SpecialPage( 'Ancientpages' ),
55 'Deadendpages' => new SpecialPage( 'Deadendpages' ),
56 'Allpages' => new IncludableSpecialPage( 'Allpages' ),
57 'Prefixindex' => new IncludableSpecialPage( 'Prefixindex' ) ,
58 'Ipblocklist' => new SpecialPage( 'Ipblocklist' ),
59 'Specialpages' => new UnlistedSpecialPage( 'Specialpages' ),
60 'Contributions' => new UnlistedSpecialPage( 'Contributions' ),
61 'Emailuser' => new UnlistedSpecialPage( 'Emailuser' ),
62 'Whatlinkshere' => new UnlistedSpecialPage( 'Whatlinkshere' ),
63 'Recentchangeslinked' => new UnlistedSpecialPage( 'Recentchangeslinked' ),
64 'Movepage' => new UnlistedSpecialPage( 'Movepage' ),
65 'Blockme' => new UnlistedSpecialPage( 'Blockme' ),
66 'Booksources' => new SpecialPage( 'Booksources' ),
67 'Categories' => new SpecialPage( 'Categories' ),
68 'Export' => new SpecialPage( 'Export' ),
69 'Version' => new SpecialPage( 'Version' ),
70 'Allmessages' => new SpecialPage( 'Allmessages' ),
71 'Log' => new SpecialPage( 'Log' ),
72 'Blockip' => new SpecialPage( 'Blockip', 'block' ),
73 'Undelete' => new SpecialPage( 'Undelete', 'deletedhistory' ),
74 "Import" => new SpecialPage( "Import", 'import' ),
75 'Lockdb' => new SpecialPage( 'Lockdb', 'siteadmin' ),
76 'Unlockdb' => new SpecialPage( 'Unlockdb', 'siteadmin' ),
77 'Userrights' => new SpecialPage( 'Userrights', 'userrights' ),
78 'MIMEsearch' => new SpecialPage( 'MIMEsearch' ),
79 'Unwatchedpages' => new SpecialPage( 'Unwatchedpages', 'unwatchedpages' ),
80 'Listredirects' => new SpecialPage( 'Listredirects' ),
81 'Revisiondelete' => new SpecialPage( 'Revisiondelete', 'deleterevision' ),
82 'Unusedtemplates' => new SpecialPage( 'Unusedtemplates' ),
83 'Randomredirect' => new SpecialPage( 'Randomredirect' ),
86 if( !$wgDisableCounters ) {
87 $wgSpecialPages['Popularpages'] = new SpecialPage( 'Popularpages' );
90 if( !$wgDisableInternalSearch ) {
91 $wgSpecialPages['Search'] = new SpecialPage( 'Search' );
94 if( $wgEmailAuthentication ) {
95 $wgSpecialPages['Confirmemail'] = new UnlistedSpecialPage( 'Confirmemail' );
99 * Parent special page class, also static functions for handling the special
109 * The name of the class, used in the URL.
110 * Also used for the default <h1> heading, @see getDescription()
114 * Minimum user level required to access this page, or "" for anyone.
115 * Also used to categorise the pages in Special:Specialpages
119 * Listed in Special:Specialpages?
123 * Function name called by the default execute()
127 * File which needs to be included before the function above can be called
131 * Whether or not this special page is being included from an article
135 * Whether the special page can be included in an article
144 * Add a page to the list of valid special pages
145 * $obj->execute() must send HTML to $wgOut then return
146 * Use this for a special page extension
149 function addPage( &$obj ) {
150 global $wgSpecialPages;
151 $wgSpecialPages[$obj->mName
] = $obj;
155 * Remove a special page from the list
156 * Occasionally used to disable expensive or dangerous special pages
159 function removePage( $name ) {
160 global $wgSpecialPages;
161 unset( $wgSpecialPages[$name] );
165 * Find the object with a given name and return it (or NULL)
167 * @param string $name
169 function getPage( $name ) {
170 global $wgSpecialPages;
171 if ( array_key_exists( $name, $wgSpecialPages ) ) {
172 return $wgSpecialPages[$name];
180 * @param string $name
181 * @return mixed Title object if the redirect exists, otherwise NULL
183 function getRedirect( $name ) {
187 'Mypage' => Title
::makeTitle( NS_USER
, $wgUser->getName() ),
188 'Mytalk' => Title
::makeTitle( NS_USER_TALK
, $wgUser->getName() ),
189 'Mycontributions' => Title
::makeTitle( NS_SPECIAL
, 'Contributions/' . $wgUser->getName() ),
190 'Listadmins' => Title
::makeTitle( NS_SPECIAL
, 'Listusers/sysop' ), # @bug 2832
191 'Randompage' => Title
::makeTitle( NS_SPECIAL
, 'Random' )
193 wfRunHooks( 'SpecialPageGetRedirect', array( &$redirects ) );
195 return isset( $redirects[$name] ) ?
$redirects[$name] : null;
199 * Return part of the request string for a special redirect page
200 * This allows passing, e.g. action=history to Special:Mypage, etc.
202 * @param $name Name of the redirect page
205 function getRedirectParams( $name ) {
213 $args = array( 'action' );
217 foreach( $args as $arg ) {
218 if( $val = $wgRequest->getVal( $arg, false ) )
219 $params[] = $arg . '=' . $val;
222 return count( $params ) ?
implode( '&', $params ) : false;
226 * Return categorised listable special pages
227 * Returns a 2d array where the first index is the restriction name
230 function getPages() {
231 global $wgSpecialPages;
235 'developer' => array()
238 foreach ( $wgSpecialPages as $name => $page ) {
239 if ( $page->isListed() ) {
240 $pages[$page->getRestriction()][$page->getName()] =& $wgSpecialPages[$name];
247 * Execute a special page path.
248 * The path may contain parameters, e.g. Special:Name/Params
249 * Extracts the special page name and call the execute method, passing the parameters
251 * Returns a title object if the page is redirected, false if there was no such special
252 * page, and true if it was successful.
254 * @param $title a title object
255 * @param $including output is being captured for use in {{special:whatever}}
257 function executePath( &$title, $including = false ) {
258 global $wgOut, $wgTitle;
259 $fname = 'SpecialPage::executePath';
260 wfProfileIn( $fname );
262 $bits = split( "/", $title->getDBkey(), 2 );
264 if( !isset( $bits[1] ) ) { // bug 2087
270 $page = SpecialPage
::getPage( $name );
271 if ( is_null( $page ) ) {
273 wfProfileOut( $fname );
276 $redir = SpecialPage
::getRedirect( $name );
277 if ( isset( $redir ) ) {
278 $params = SpecialPage
::getRedirectParams( $name );
280 $url = $redir->getFullUrl( $params );
282 $url = $redir->getFullUrl() . '/' . $par;
284 $url = $redir->getFullUrl();
286 $wgOut->redirect( $url );
289 $wgOut->setArticleRelated( false );
290 $wgOut->setRobotpolicy( 'noindex,follow' );
291 $wgOut->setStatusCode( 404 );
292 $wgOut->errorpage( 'nosuchspecialpage', 'nospecialpagetext' );
297 if ( $including && !$page->includable() ) {
298 wfProfileOut( $fname );
302 $wgTitle = Title
::makeTitle( NS_SPECIAL
, $name );
306 $page->including( $including );
308 $profName = 'Special:' . $page->getName();
309 wfProfileIn( $profName );
310 $page->execute( $par );
311 wfProfileOut( $profName );
314 wfProfileOut( $fname );
319 * Just like executePath() except it returns the HTML instead of outputting it
320 * Returns false if there was no such special page, or a title object if it was
324 function capturePath( &$title ) {
325 global $wgOut, $wgTitle;
327 $oldTitle = $wgTitle;
329 $wgOut = new OutputPage
;
331 $ret = SpecialPage
::executePath( $title, true );
332 if ( $ret === true ) {
333 $ret = $wgOut->getHTML();
335 $wgTitle = $oldTitle;
341 * Default constructor for special pages
342 * Derivative classes should call this from their constructor
343 * Note that if the user does not have the required level, an error message will
344 * be displayed by the default execute() method, without the global function ever
347 * If you override execute(), you can recover the default behaviour with userCanExecute()
348 * and displayRestrictionError()
350 * @param string $name Name of the special page, as seen in links and URLs
351 * @param string $restriction Minimum user level required, e.g. "sysop" or "developer".
352 * @param boolean $listed Whether the page is listed in Special:Specialpages
353 * @param string $function Function called by execute(). By default it is constructed from $name
354 * @param string $file File which is included by execute(). It is also constructed from $name by default
356 function SpecialPage( $name = '', $restriction = '', $listed = true, $function = false, $file = 'default', $includable = false ) {
357 $this->mName
= $name;
358 $this->mRestriction
= $restriction;
359 $this->mListed
= $listed;
360 $this->mIncludable
= $includable;
361 if ( $function == false ) {
362 $this->mFunction
= 'wfSpecial'.$name;
364 $this->mFunction
= $function;
366 if ( $file === 'default' ) {
367 $this->mFile
= "Special{$name}.php";
369 $this->mFile
= $file;
378 function getName() { return $this->mName
; }
379 function getRestriction() { return $this->mRestriction
; }
380 function getFile() { return $this->mFile
; }
381 function isListed() { return $this->mListed
; }
385 * Accessor and mutator
387 function name( $x = NULL ) { return wfSetVar( $this->mName
, $x ); }
388 function restrictions( $x = NULL) { return wfSetVar( $this->mRestrictions
, $x ); }
389 function listed( $x = NULL) { return wfSetVar( $this->mListed
, $x ); }
390 function func( $x = NULL) { return wfSetVar( $this->mFunction
, $x ); }
391 function file( $x = NULL) { return wfSetVar( $this->mFile
, $x ); }
392 function includable( $x = NULL ) { return wfSetVar( $this->mIncludable
, $x ); }
393 function including( $x = NULL ) { return wfSetVar( $this->mIncluding
, $x ); }
397 * Checks if the given user (identified by an object) can execute this
398 * special page (as defined by $mRestriction)
400 function userCanExecute( &$user ) {
401 if ( $this->mRestriction
== "" ) {
404 if ( in_array( $this->mRestriction
, $user->getRights() ) ) {
413 * Output an error message telling the user what access level they have to have
415 function displayRestrictionError() {
417 $wgOut->permissionRequired( $this->mRestriction
);
421 * Sets headers - this should be called from the execute() method of all derived classes!
423 function setHeaders() {
425 $wgOut->setArticleRelated( false );
426 $wgOut->setRobotPolicy( "noindex,follow" );
427 $wgOut->setPageTitle( $this->getDescription() );
431 * Default execute method
432 * Checks user permissions, calls the function given in mFunction
434 function execute( $par ) {
439 if ( $this->userCanExecute( $wgUser ) ) {
440 $func = $this->mFunction
;
441 // only load file if the function does not exist
442 if(!function_exists($func) and $this->mFile
) {
443 require_once( $this->mFile
);
445 if ( wfRunHooks( 'SpecialPageExecuteBeforeHeader', array( &$this, &$par, &$func ) ) )
446 $this->outputHeader();
447 if ( ! wfRunHooks( 'SpecialPageExecuteBeforePage', array( &$this, &$par, &$func ) ) )
449 $func( $par, $this );
450 if ( ! wfRunHooks( 'SpecialPageExecuteAfterPage', array( &$this, &$par, &$func ) ) )
453 $this->displayRestrictionError();
457 function outputHeader() {
458 global $wgOut, $wgContLang;
460 $msg = $wgContLang->lc( $this->name() ) . '-summary';
461 $out = wfMsg( $msg );
462 if ( ! wfEmptyMsg( $msg, $out ) and $out !== '' and ! $this->including() )
463 $wgOut->addWikiText( $out );
467 # Returns the name that goes in the <h1> in the special page itself, and also the name that
468 # will be listed in Special:Specialpages
470 # Derived classes can override this, but usually it is easier to keep the default behaviour.
471 # Messages can be added at run-time, see MessageCache.php
472 function getDescription() {
473 return wfMsg( strtolower( $this->mName
) );
477 * Get a self-referential title object
479 function getTitle() {
480 return Title
::makeTitle( NS_SPECIAL
, $this->mName
);
484 * Set whether this page is listed in Special:Specialpages, at run-time
486 function setListed( $listed ) {
487 return wfSetVar( $this->mListed
, $listed );
493 * Shortcut to construct a special page which is unlisted by default
496 class UnlistedSpecialPage
extends SpecialPage
498 function UnlistedSpecialPage( $name, $restriction = '', $function = false, $file = 'default' ) {
499 SpecialPage
::SpecialPage( $name, $restriction, false, $function, $file );
504 * Shortcut to construct an includable special page
507 class IncludableSpecialPage
extends SpecialPage
509 function IncludableSpecialPage( $name, $restriction = '', $listed = true, $function = false, $file = 'default' ) {
510 SpecialPage
::SpecialPage( $name, $restriction, $listed, $function, $file, true );