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 global $wgSpecialPages, $wgSpecialPageRedirects, $wgUser;
27 $wgSpecialPages = array(
28 'DoubleRedirects' => new SpecialPage ( 'DoubleRedirects' ),
29 'BrokenRedirects' => new SpecialPage ( 'BrokenRedirects' ),
30 'Disambiguations' => new SpecialPage ( 'Disambiguations' ),
32 'Userlogin' => new SpecialPage( 'Userlogin' ),
33 'Userlogout' => new UnlistedSpecialPage( 'Userlogout' ),
34 'Preferences' => new SpecialPage( 'Preferences' ),
35 'Watchlist' => new SpecialPage( 'Watchlist' ),
37 'Recentchanges' => new IncludableSpecialPage( 'Recentchanges' ),
38 'Upload' => new SpecialPage( 'Upload' ),
39 'Imagelist' => new SpecialPage( 'Imagelist' ),
40 'Newimages' => new SpecialPage( 'Newimages' ),
41 'Listusers' => new SpecialPage( 'Listusers' ),
42 'Statistics' => new SpecialPage( 'Statistics' ),
43 'Random' => new SpecialPage( 'Randompage' ),
44 'Lonelypages' => new SpecialPage( 'Lonelypages' ),
45 'Uncategorizedpages'=> new SpecialPage( 'Uncategorizedpages' ),
46 'Uncategorizedcategories'=> new SpecialPage( 'Uncategorizedcategories' ),
47 'Unusedimages' => new SpecialPage( 'Unusedimages' ),
48 'Wantedpages' => new SpecialPage( 'Wantedpages' ),
49 'Shortpages' => new SpecialPage( 'Shortpages' ),
50 'Longpages' => new SpecialPage( 'Longpages' ),
51 'Newpages' => new SpecialPage( 'Newpages' ),
52 'Ancientpages' => new SpecialPage( 'Ancientpages' ),
53 'Deadendpages' => new SpecialPage( 'Deadendpages' ),
54 'Allpages' => new IncludableSpecialPage( 'Allpages' ),
55 'Ipblocklist' => new SpecialPage( 'Ipblocklist' ),
56 'Specialpages' => new UnlistedSpecialPage( 'Specialpages' ),
57 'Contributions' => new UnlistedSpecialPage( 'Contributions' ),
58 'Emailuser' => new UnlistedSpecialPage( 'Emailuser' ),
59 'Whatlinkshere' => new UnlistedSpecialPage( 'Whatlinkshere' ),
60 'Recentchangeslinked' => new UnlistedSpecialPage( 'Recentchangeslinked' ),
61 'Movepage' => new UnlistedSpecialPage( 'Movepage' ),
62 'Blockme' => new UnlistedSpecialPage( 'Blockme' ),
63 'Booksources' => new SpecialPage( 'Booksources' ),
64 'Categories' => new SpecialPage( 'Categories' ),
65 'Export' => new SpecialPage( 'Export' ),
66 'Version' => new SpecialPage( 'Version' ),
67 'Allmessages' => new SpecialPage( 'Allmessages' ),
68 'Log' => new SpecialPage( 'Log' ),
69 'Blockip' => new SpecialPage( 'Blockip', 'block' ),
70 'Undelete' => new SpecialPage( 'Undelete', 'delete' ),
71 "Import" => new SpecialPage( "Import", 'import' ),
72 'Lockdb' => new SpecialPage( 'Lockdb', 'siteadmin' ),
73 'Unlockdb' => new SpecialPage( 'Unlockdb', 'siteadmin' ),
74 'Userrights' => new SpecialPage( 'Userrights', 'userrights' ),
75 'Groups' => new SpecialPage( 'Groups' ),
79 * Redirect Special:$key to somewhere else.
83 $wgSpecialPageRedirects = array(
85 'Mypage' => Title
::makeTitle( NS_USER
, $wgUser->getName() ),
86 'Mytalk' => Title
::makeTitle( NS_USER_TALK
, $wgUser->getName() ),
87 'Mycontributions' => Title
::makeTitle( NS_SPECIAL
, 'Contributions/' . $wgUser->getName() ),
89 # Deprecated specialpages
90 'Listadmins' => Title
::makeTitle( NS_SPECIAL
, 'Listusers' ),
93 'Randompage' => Title
::makeTitle( NS_SPECIAL
, 'Random' ),
96 global $wgUseValidation ;
97 if ( $wgUseValidation )
98 $wgSpecialPages['Validate'] = new SpecialPage( 'Validate' );
100 global $wgDisableCounters;
101 if( !$wgDisableCounters ) {
102 $wgSpecialPages['Popularpages'] = new SpecialPage( 'Popularpages' );
105 global $wgDisableInternalSearch;
106 if( !$wgDisableInternalSearch ) {
107 $wgSpecialPages['Search'] = new UnlistedSpecialPage( 'Search' );
110 global $wgEmailAuthentication;
111 if( $wgEmailAuthentication ) {
112 $wgSpecialPages['Confirmemail'] = new UnlistedSpecialPage( 'Confirmemail' );
116 * Parent special page class, also static functions for handling the special
126 * The name of the class, used in the URL.
127 * Also used for the default <h1> heading, @see getDescription()
131 * Minimum user level required to access this page, or "" for anyone.
132 * Also used to categorise the pages in Special:Specialpages
136 * Listed in Special:Specialpages?
140 * Function name called by the default execute()
144 * File which needs to be included before the function above can be called
148 * Whether or not this special page is being included from an article
152 * Whether the special page can be included in an article
161 * Add a page to the list of valid special pages
162 * $obj->execute() must send HTML to $wgOut then return
163 * Use this for a special page extension
166 function addPage( &$obj ) {
167 global $wgSpecialPages;
168 $wgSpecialPages[$obj->mName
] = $obj;
172 * Remove a special page from the list
173 * Occasionally used to disable expensive or dangerous special pages
176 function removePage( $name ) {
177 global $wgSpecialPages;
178 unset( $wgSpecialPages[$name] );
182 * Find the object with a given name and return it (or NULL)
184 * @param string $name
186 function &getPage( $name ) {
187 global $wgSpecialPages;
188 if ( array_key_exists( $name, $wgSpecialPages ) ) {
189 return $wgSpecialPages[$name];
197 * @param string $name
198 * @return mixed Title object if the redirect exists, otherwise NULL
200 function &getRedirect( $name ) {
201 global $wgSpecialPageRedirects;
202 if ( array_key_exists( $name, $wgSpecialPageRedirects ) ) {
203 return $wgSpecialPageRedirects[$name];
210 * Return categorised listable special pages
211 * Returns a 2d array where the first index is the restriction name
214 function getPages() {
215 global $wgSpecialPages;
219 'developer' => array()
222 foreach ( $wgSpecialPages as $name => $page ) {
223 if ( $page->isListed() ) {
224 $pages[$page->getRestriction()][$page->getName()] =& $wgSpecialPages[$name];
231 * Execute a special page path.
232 * The path may contain parameters, e.g. Special:Name/Params
233 * Extracts the special page name and call the execute method, passing the parameters
235 * Returns a title object if the page is redirected, false if there was no such special
236 * page, and true if it was successful.
238 * @param $title a title object
239 * @param $including output is being captured for use in {{special:whatever}}
241 function executePath( &$title, $including = false ) {
242 global $wgSpecialPages, $wgOut, $wgTitle;
244 $bits = split( "/", $title->getDBkey(), 2 );
246 if( !isset( $bits[1] ) ) { // bug 2087
252 $page =& SpecialPage
::getPage( $name );
253 if ( is_null( $page ) ) {
254 $redir =& SpecialPage
::getRedirect( $name );
255 if ( isset( $redir ) ) {
257 $wgOut->redirect( $redir->getFullURL() . '/' . $par );
259 $wgOut->redirect( $redir->getFullURL() );
262 $wgOut->setArticleRelated( false );
263 $wgOut->setRobotpolicy( "noindex,follow" );
264 $wgOut->errorpage( "nosuchspecialpage", "nospecialpagetext" );
268 if ( $including && !$page->includable() ) {
272 $wgTitle = Title
::makeTitle( NS_SPECIAL
, $name );
276 $page->including( $including );
278 $page->execute( $par );
285 * Just like executePath() except it returns the HTML instead of outputting it
286 * Returns false if there was no such special page, or a title object if it was
290 function capturePath( &$title ) {
291 global $wgOut, $wgTitle;
293 $oldTitle = $wgTitle;
295 $wgOut = new OutputPage
;
297 $ret = SpecialPage
::executePath( $title, true );
298 if ( $ret === true ) {
299 $ret = $wgOut->getHTML();
301 $wgTitle = $oldTitle;
307 * Default constructor for special pages
308 * Derivative classes should call this from their constructor
309 * Note that if the user does not have the required level, an error message will
310 * be displayed by the default execute() method, without the global function ever
313 * If you override execute(), you can recover the default behaviour with userCanExecute()
314 * and displayRestrictionError()
316 * @param string $name Name of the special page, as seen in links and URLs
317 * @param string $restriction Minimum user level required, e.g. "sysop" or "developer".
318 * @param boolean $listed Whether the page is listed in Special:Specialpages
319 * @param string $function Function called by execute(). By default it is constructed from $name
320 * @param string $file File which is included by execute(). It is also constructed from $name by default
322 function SpecialPage( $name = '', $restriction = '', $listed = true, $function = false, $file = 'default', $includable = false ) {
323 $this->mName
= $name;
324 $this->mRestriction
= $restriction;
325 $this->mListed
= $listed;
326 $this->mIncludable
= $includable;
327 if ( $function == false ) {
328 $this->mFunction
= 'wfSpecial'.$name;
330 $this->mFunction
= $function;
332 if ( $file === 'default' ) {
333 $this->mFile
= "Special{$name}.php";
335 $this->mFile
= $file;
339 # Accessor functions, see the descriptions of the associated variables above
340 function getName() { return $this->mName
; }
341 function getRestriction() { return $this->mRestriction
; }
342 function isListed() { return $this->mListed
; }
343 function getFile() { return $this->mFile
; }
344 function including( $x = NULL ) { return wfSetVar( $this->mIncluding
, $x ); }
345 function includable( $x = NULL ) { return wfSetVar( $this->mIncludable
, $x ); }
348 * Checks if the given user (identified by an object) can execute this
349 * special page (as defined by $mRestriction)
351 function userCanExecute( &$user ) {
352 if ( $this->mRestriction
== "" ) {
355 if ( in_array( $this->mRestriction
, $user->getRights() ) ) {
364 * Output an error message telling the user what access level they have to have
366 function displayRestrictionError() {
368 if ( $this->mRestriction
== "developer" ) {
369 $wgOut->developerRequired();
371 $wgOut->sysopRequired();
376 * Sets headers - this should be called from the execute() method of all derived classes!
378 function setHeaders() {
380 $wgOut->setArticleRelated( false );
381 $wgOut->setRobotPolicy( "noindex,follow" );
382 $wgOut->setPageTitle( $this->getDescription() );
386 * Default execute method
387 * Checks user permissions, calls the function given in mFunction
389 function execute( $par ) {
390 global $wgUser, $wgOut, $wgTitle;
394 if ( $this->userCanExecute( $wgUser ) ) {
395 if ( $this->mFile
) {
396 require_once( $this->mFile
);
398 $func = $this->mFunction
;
399 $func( $par, $this );
401 $this->displayRestrictionError();
405 # Returns the name that goes in the <h1> in the special page itself, and also the name that
406 # will be listed in Special:Specialpages
408 # Derived classes can override this, but usually it is easier to keep the default behaviour.
409 # Messages can be added at run-time, see MessageCache.php
410 function getDescription() {
411 return wfMsg( strtolower( $this->mName
) );
415 * Get a self-referential title object
417 function getTitle() {
418 return Title
::makeTitle( NS_SPECIAL
, $this->mName
);
422 * Set whether this page is listed in Special:Specialpages, at run-time
424 function setListed( $listed ) {
425 return wfSetVar( $this->mListed
, $listed );
431 * Shortcut to construct a special page which is unlisted by default
434 class UnlistedSpecialPage
extends SpecialPage
436 function UnlistedSpecialPage( $name, $restriction = '', $function = false, $file = 'default' ) {
437 SpecialPage
::SpecialPage( $name, $restriction, false, $function, $file );
442 * Shortcut to construct an includable special page
444 class IncludableSpecialPage
extends SpecialPage
446 function IncludableSpecialPage( $name, $restriction = '', $listed = true, $function = false, $file = 'default' ) {
447 SpecialPage
::SpecialPage( $name, $restriction, $listed, $function, $file, true );