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' ),
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' ),
81 if ( $wgUseValidation )
82 $wgSpecialPages['Validate'] = new SpecialPage( 'Validate' );
84 if( !$wgDisableCounters ) {
85 $wgSpecialPages['Popularpages'] = new SpecialPage( 'Popularpages' );
88 if( !$wgDisableInternalSearch ) {
89 $wgSpecialPages['Search'] = new SpecialPage( 'Search' );
92 if( $wgEmailAuthentication ) {
93 $wgSpecialPages['Confirmemail'] = new UnlistedSpecialPage( 'Confirmemail' );
96 if ( $wgEnableUnwatchedpages )
97 $wgSpecialPages['Unwatchedpages'] = new SpecialPage( 'Unwatchedpages' );
100 * Parent special page class, also static functions for handling the special
110 * The name of the class, used in the URL.
111 * Also used for the default <h1> heading, @see getDescription()
115 * Minimum user level required to access this page, or "" for anyone.
116 * Also used to categorise the pages in Special:Specialpages
120 * Listed in Special:Specialpages?
124 * Function name called by the default execute()
128 * File which needs to be included before the function above can be called
132 * Whether or not this special page is being included from an article
136 * Whether the special page can be included in an article
145 * Add a page to the list of valid special pages
146 * $obj->execute() must send HTML to $wgOut then return
147 * Use this for a special page extension
150 function addPage( &$obj ) {
151 global $wgSpecialPages;
152 $wgSpecialPages[$obj->mName
] = $obj;
156 * Remove a special page from the list
157 * Occasionally used to disable expensive or dangerous special pages
160 function removePage( $name ) {
161 global $wgSpecialPages;
162 unset( $wgSpecialPages[$name] );
166 * Find the object with a given name and return it (or NULL)
168 * @param string $name
170 function getPage( $name ) {
171 global $wgSpecialPages;
172 if ( array_key_exists( $name, $wgSpecialPages ) ) {
173 return $wgSpecialPages[$name];
181 * @param string $name
182 * @return mixed Title object if the redirect exists, otherwise NULL
184 function getRedirect( $name ) {
188 'Mypage' => Title
::makeTitle( NS_USER
, $wgUser->getName() ),
189 'Mytalk' => Title
::makeTitle( NS_USER_TALK
, $wgUser->getName() ),
190 'Mycontributions' => Title
::makeTitle( NS_SPECIAL
, 'Contributions/' . $wgUser->getName() ),
191 'Listadmins' => Title
::makeTitle( NS_SPECIAL
, 'Listusers/sysop' ), # @bug 2832
192 'Randompage' => Title
::makeTitle( NS_SPECIAL
, 'Random' )
194 wfRunHooks( 'SpecialPageGetRedirect', array( &$redirects ) );
196 return isset( $redirects[$name] ) ?
$redirects[$name] : null;
200 * Return categorised listable special pages
201 * Returns a 2d array where the first index is the restriction name
204 function getPages() {
205 global $wgSpecialPages;
209 'developer' => array()
212 foreach ( $wgSpecialPages as $name => $page ) {
213 if ( $page->isListed() ) {
214 $pages[$page->getRestriction()][$page->getName()] =& $wgSpecialPages[$name];
221 * Execute a special page path.
222 * The path may contain parameters, e.g. Special:Name/Params
223 * Extracts the special page name and call the execute method, passing the parameters
225 * Returns a title object if the page is redirected, false if there was no such special
226 * page, and true if it was successful.
228 * @param $title a title object
229 * @param $including output is being captured for use in {{special:whatever}}
231 function executePath( &$title, $including = false ) {
232 global $wgSpecialPages, $wgOut, $wgTitle;
233 $fname = 'SpecialPage::executePath';
234 wfProfileIn( $fname );
236 $bits = split( "/", $title->getDBkey(), 2 );
238 if( !isset( $bits[1] ) ) { // bug 2087
244 $page = SpecialPage
::getPage( $name );
245 if ( is_null( $page ) ) {
247 wfProfileOut( $fname );
250 $redir = SpecialPage
::getRedirect( $name );
251 if ( isset( $redir ) ) {
253 $wgOut->redirect( $redir->getFullURL() . '/' . $par );
255 $wgOut->redirect( $redir->getFullURL() );
258 $wgOut->setArticleRelated( false );
259 $wgOut->setRobotpolicy( 'noindex,follow' );
260 $wgOut->setStatusCode( 404 );
261 $wgOut->errorpage( 'nosuchspecialpage', 'nospecialpagetext' );
266 if ( $including && !$page->includable() ) {
267 wfProfileOut( $fname );
271 $wgTitle = Title
::makeTitle( NS_SPECIAL
, $name );
275 $page->including( $including );
277 $profName = 'Special:' . $page->getName();
278 wfProfileIn( $profName );
279 $page->execute( $par );
280 wfProfileOut( $profName );
283 wfProfileOut( $fname );
288 * Just like executePath() except it returns the HTML instead of outputting it
289 * Returns false if there was no such special page, or a title object if it was
293 function capturePath( &$title ) {
294 global $wgOut, $wgTitle;
296 $oldTitle = $wgTitle;
298 $wgOut = new OutputPage
;
300 $ret = SpecialPage
::executePath( $title, true );
301 if ( $ret === true ) {
302 $ret = $wgOut->getHTML();
304 $wgTitle = $oldTitle;
310 * Default constructor for special pages
311 * Derivative classes should call this from their constructor
312 * Note that if the user does not have the required level, an error message will
313 * be displayed by the default execute() method, without the global function ever
316 * If you override execute(), you can recover the default behaviour with userCanExecute()
317 * and displayRestrictionError()
319 * @param string $name Name of the special page, as seen in links and URLs
320 * @param string $restriction Minimum user level required, e.g. "sysop" or "developer".
321 * @param boolean $listed Whether the page is listed in Special:Specialpages
322 * @param string $function Function called by execute(). By default it is constructed from $name
323 * @param string $file File which is included by execute(). It is also constructed from $name by default
325 function SpecialPage( $name = '', $restriction = '', $listed = true, $function = false, $file = 'default', $includable = false ) {
326 $this->mName
= $name;
327 $this->mRestriction
= $restriction;
328 $this->mListed
= $listed;
329 $this->mIncludable
= $includable;
330 if ( $function == false ) {
331 $this->mFunction
= 'wfSpecial'.$name;
333 $this->mFunction
= $function;
335 if ( $file === 'default' ) {
336 $this->mFile
= "Special{$name}.php";
338 $this->mFile
= $file;
347 function getName() { return $this->mName
; }
348 function getRestriction() { return $this->mRestriction
; }
349 function getFile() { return $this->mFile
; }
350 function isListed() { return $this->mListed
; }
354 * Accessor and mutator
356 function name( $x = NULL ) { return wfSetVar( $this->mName
, $x ); }
357 function restrictions( $x = NULL) { return wfSetVar( $this->mRestrictions
, $x ); }
358 function listed( $x = NULL) { return wfSetVar( $this->mListed
, $x ); }
359 function func( $x = NULL) { return wfSetVar( $this->mFunction
, $x ); }
360 function file( $x = NULL) { return wfSetVar( $this->mFile
, $x ); }
361 function includable( $x = NULL ) { return wfSetVar( $this->mIncludable
, $x ); }
362 function including( $x = NULL ) { return wfSetVar( $this->mIncluding
, $x ); }
366 * Checks if the given user (identified by an object) can execute this
367 * special page (as defined by $mRestriction)
369 function userCanExecute( &$user ) {
370 if ( $this->mRestriction
== "" ) {
373 if ( in_array( $this->mRestriction
, $user->getRights() ) ) {
382 * Output an error message telling the user what access level they have to have
384 function displayRestrictionError() {
386 $wgOut->permissionRequired( $this->mRestriction
);
390 * Sets headers - this should be called from the execute() method of all derived classes!
392 function setHeaders() {
394 $wgOut->setArticleRelated( false );
395 $wgOut->setRobotPolicy( "noindex,follow" );
396 $wgOut->setPageTitle( $this->getDescription() );
400 * Default execute method
401 * Checks user permissions, calls the function given in mFunction
403 function execute( $par ) {
404 global $wgUser, $wgOut, $wgTitle;
408 if ( $this->userCanExecute( $wgUser ) ) {
409 $func = $this->mFunction
;
410 // only load file if the function does not exist
411 if(!function_exists($func) and $this->mFile
) {
412 require_once( $this->mFile
);
414 $func( $par, $this );
416 $this->displayRestrictionError();
420 # Returns the name that goes in the <h1> in the special page itself, and also the name that
421 # will be listed in Special:Specialpages
423 # Derived classes can override this, but usually it is easier to keep the default behaviour.
424 # Messages can be added at run-time, see MessageCache.php
425 function getDescription() {
426 return wfMsg( strtolower( $this->mName
) );
430 * Get a self-referential title object
432 function getTitle() {
433 return Title
::makeTitle( NS_SPECIAL
, $this->mName
);
437 * Set whether this page is listed in Special:Specialpages, at run-time
439 function setListed( $listed ) {
440 return wfSetVar( $this->mListed
, $listed );
446 * Shortcut to construct a special page which is unlisted by default
449 class UnlistedSpecialPage
extends SpecialPage
451 function UnlistedSpecialPage( $name, $restriction = '', $function = false, $file = 'default' ) {
452 SpecialPage
::SpecialPage( $name, $restriction, false, $function, $file );
457 * Shortcut to construct an includable special page
460 class IncludableSpecialPage
extends SpecialPage
462 function IncludableSpecialPage( $name, $restriction = '', $listed = true, $function = false, $file = 'default' ) {
463 SpecialPage
::SpecialPage( $name, $restriction, $listed, $function, $file, true );