includes/SpecialPage.php

   1 <?php
   2 /**
   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.
  10  *
  11  * To add a special page at run-time, use SpecialPage::addPage().
  12  * DO NOT manipulate this array at run-time.
  13  *
  14  * @package MediaWiki
  15  */
  16
  17 /**
  18  *
  19  */
  20 global $wgSpecialPages;
  21
  22 /**
  23  * @access private
  24  */
  25 $wgSpecialPages = array(
  26         'DoubleRedirects'       => new UnlistedSpecialPage ( 'DoubleRedirects' ),
  27         'BrokenRedirects'       => new UnlistedSpecialPage ( 'BrokenRedirects' ),
  28         'Disambiguations'       => new UnlistedSpecialPage ( 'Disambiguations' ),
  29
  30         'Userlogin'         => new SpecialPage( 'Userlogin' ),
  31         'Userlogout'        => new UnlistedSpecialPage( 'Userlogout' ),
  32         'Preferences'       => new SpecialPage( 'Preferences' ),
  33         'Watchlist'         => new SpecialPage( 'Watchlist' ),
  34         'Recentchanges'     => new SpecialPage( 'Recentchanges' ),
  35         'Upload'            => new SpecialPage( 'Upload' ),
  36         'Imagelist'         => new SpecialPage( 'Imagelist' ),
  37         'Newimages'         => new SpecialPage( 'Newimages' ),
  38         'Listusers'         => new SpecialPage( 'Listusers' ),
  39         'Listadmins'        => new SpecialPage( 'Listadmins' ),
  40         'Statistics'        => new SpecialPage( 'Statistics' ),
  41         'Randompage'        => new SpecialPage( 'Randompage' ),
  42         'Lonelypages'       => new SpecialPage( 'Lonelypages' ),
  43         'Uncategorizedpages'=> new SpecialPage( 'Uncategorizedpages' ),
  44         'Unusedimages'      => new SpecialPage( 'Unusedimages' )
  45 );
  46
  47 global $wgDisableCounters;
  48 if( !$wgDisableCounters ) {
  49         $wgSpecialPages['Popularpages'] = new SpecialPage( 'Popularpages' );
  50 }
  51
  52 global $wgUseData ;
  53 if ( $wgUseData ) {
  54         $wgSpecialPages['Data'] = new SpecialPage( 'Data' );
  55 }
  56
  57 $wgSpecialPages = array_merge($wgSpecialPages, array (
  58         'Wantedpages'   => new SpecialPage( 'Wantedpages' ),
  59         'Shortpages'    => new SpecialPage( 'Shortpages' ),
  60         'Longpages'             => new SpecialPage( 'Longpages' ),
  61         'Newpages'              => new SpecialPage( 'Newpages' ),
  62         'Ancientpages'  => new SpecialPage( 'Ancientpages' ),
  63         'Deadendpages'  => new SpecialPage( 'Deadendpages' ),
  64         'Allpages'              => new SpecialPage( 'Allpages' ),
  65         'Ipblocklist'   => new SpecialPage( 'Ipblocklist' ),
  66         'Maintenance'   => new SpecialPage( 'Maintenance' ),
  67         'Specialpages'  => new UnlistedSpecialPage( 'Specialpages' ),
  68         'Contributions' => new UnlistedSpecialPage( 'Contributions' ),
  69         'Emailuser'             => new UnlistedSpecialPage( 'Emailuser' ),
  70         'Whatlinkshere' => new UnlistedSpecialPage( 'Whatlinkshere' ),
  71         'Recentchangeslinked' => new UnlistedSpecialPage( 'Recentchangeslinked' ),
  72         'Movepage'              => new UnlistedSpecialPage( 'Movepage' ),
  73         'Blockme'       => new UnlistedSpecialPage( 'Blockme' ),
  74         'Geo'           => new UnlistedSpecialPage( 'Geo' ),
  75         'Validate'      => new UnlistedSpecialPage( 'Validate' ),
  76         'Booksources'   => new SpecialPage( 'Booksources' ),
  77         'Categories'    => new SpecialPage( 'Categories' ),
  78         'Export'                => new SpecialPage( 'Export' ),
  79         'Version'               => new SpecialPage( 'Version' ),
  80         'Allmessages'   => new SpecialPage( 'Allmessages' ),
  81         'Search'                => new UnlistedSpecialPage( 'Search' ),
  82         'Log'           => new SpecialPage( 'Log' ),
  83         'Blockip'               => new SpecialPage( 'Blockip', 'sysop' ),
  84         'Asksql'                => new SpecialPage( 'Asksql', 'sysop' ),
  85         'Undelete'              => new SpecialPage( 'Undelete', 'sysop' ),
  86         'Makesysop'             => new SpecialPage( 'Makesysop', 'sysop' ),
  87
  88 # Special:Import is half-written
  89 #       "Import"                => new SpecialPage( "Import", "sysop" ),
  90         'Lockdb'                => new SpecialPage( 'Lockdb', 'developer' ),
  91         'Unlockdb'              => new SpecialPage( 'Unlockdb', 'developer' ),
  92         'Sitesettings'  => new SpecialPage( 'Sitesettings', 'sysop' ),
  93         'Userlevels'    => new SpecialPage( 'Userlevels', 'sysop' ),
  94 ));
  95
  96 /**
  97  * Parent special page class, also static functions for handling the special
  98  * page list
  99  * @package MediaWiki
 100  */
 101 class SpecialPage
 102 {
 103         /**#@+
 104          * @access private
 105          */
 106         /**
 107          * The name of the class, used in the URL.
 108          * Also used for the default <h1> heading, @see getDescription()
 109          */
 110         var $mName;
 111         /**
 112          * Minimum user level required to access this page, or "" for anyone.
 113          * Also used to categorise the pages in Special:Specialpages
 114          */
 115         var $mRestriction;
 116         /**
 117          * Listed in Special:Specialpages?
 118          */
 119         var $mListed;
 120         /**
 121          * Function name called by the default execute()
 122          */
 123         var $mFunction;
 124         /**
 125          * File which needs to be included before the function above can be called
 126          */
 127         var $mFile;
 128         /**#@- */
 129
 130         /**
 131          * Add a page to the list of valid special pages
 132          * $obj->execute() must send HTML to $wgOut then return
 133          * Use this for a special page extension
 134          * @static
 135          */
 136         function addPage( &$obj ) {
 137                 global $wgSpecialPages;
 138                 $wgSpecialPages[$obj->mName] = $obj;
 139         }
 140
 141         /**
 142          * Remove a special page from the list
 143          * Occasionally used to disable expensive or dangerous special pages
 144          * @static
 145          */
 146         function removePage( $name ) {
 147                 global $wgSpecialPages;
 148                 unset( $wgSpecialPages[$name] );
 149         }
 150
 151         /**
 152          * Find the object with a given name and return it (or NULL)
 153          * @static
 154          * @param string $name
 155          */
 156         function &getPage( $name ) {
 157                 global $wgSpecialPages;
 158                 if ( array_key_exists( $name, $wgSpecialPages ) ) {
 159                         return $wgSpecialPages[$name];
 160                 } else {
 161                         return NULL;
 162                 }
 163         }
 164
 165         /**
 166          * Return categorised listable special pages
 167          * Returns a 2d array where the first index is the restriction name
 168          * @static
 169          */
 170         function getPages() {
 171                 global $wgSpecialPages;
 172                 $pages = array(
 173                   '' => array(),
 174                   'sysop' => array(),
 175                   'developer' => array()
 176                 );
 177
 178                 foreach ( $wgSpecialPages as $name => $page ) {
 179                         if ( $page->isListed() ) {
 180                                 $pages[$page->getRestriction()][$page->getName()] =& $wgSpecialPages[$name];
 181                         }
 182                 }
 183                 return $pages;
 184         }
 185
 186         /**
 187          * Execute a special page path.
 188          * The path     may contain parameters, e.g. Special:Name/Params
 189          * Extracts the special page name and call the execute method, passing the parameters
 190          *
 191          * @param $title should be a title object
 192          */
 193         function executePath( &$title ) {
 194                 global $wgSpecialPages, $wgOut, $wgTitle;
 195
 196                 $bits = split( "/", $title->getDBkey(), 2 );
 197                 $name = $bits[0];
 198                 if( empty( $bits[1] ) ) {
 199                         $par = NULL;
 200                 } else {
 201                         $par = $bits[1];
 202                 }
 203
 204                 $page =& SpecialPage::getPage( $name );
 205                 if ( is_null( $page ) ) {
 206                         $wgOut->setArticleRelated( false );
 207                         $wgOut->setRobotpolicy( "noindex,follow" );
 208                         $wgOut->errorpage( "nosuchspecialpage", "nospecialpagetext" );
 209                 } else {
 210                         if($par !== NULL) {
 211                                 $wgTitle = Title::makeTitle( NS_SPECIAL, $name );
 212                         } else {
 213                                 $wgTitle = $title;
 214                         }
 215
 216                         $page->execute( $par );
 217                 }
 218         }
 219
 220         /**
 221          * Default constructor for special pages
 222          * Derivative classes should call this from their constructor
 223          *     Note that if the user does not have the required level, an error message will
 224          *     be displayed by the default execute() method, without the global function ever
 225          *     being called.
 226          *
 227          *     If you override execute(), you can recover the default behaviour with userCanExecute()
 228          *     and displayRestrictionError()
 229          *
 230          * @param string $name Name of the special page, as seen in links and URLs
 231          * @param string $restriction Minimum user level required, e.g. "sysop" or "developer".
 232          * @param boolean $listed Whether the page is listed in Special:Specialpages
 233          * @param string $function Function called by execute(). By default it is constructed from $name
 234          * @param string $file File which is included by execute(). It is also constructed from $name by default
 235          */
 236         function SpecialPage( $name = '', $restriction = '', $listed = true, $function = false, $file = 'default' ) {
 237                 $this->mName = $name;
 238                 $this->mRestriction = $restriction;
 239                 $this->mListed = $listed;
 240                 if ( $function == false ) {
 241                         $this->mFunction = 'wfSpecial'.$name;
 242                 } else {
 243                         $this->mFunction = $function;
 244                 }
 245                 if ( $file === 'default' ) {
 246                         $this->mFile = "Special{$name}.php";
 247                 } else {
 248                         $this->mFile = $file;
 249                 }
 250         }
 251
 252         # Accessor functions, see the descriptions of the associated variables above
 253         function getName() { return $this->mName; }
 254         function getRestriction() { return $this->mRestriction; }
 255         function isListed() { return $this->mListed; }
 256
 257         /**
 258          * Checks if the given user (identified by an object) can execute this
 259          * special page (as defined by $mRestriction)
 260          */
 261         function userCanExecute( &$user ) {
 262                 if ( $this->mRestriction == "" ) {
 263                         return true;
 264                 } else {
 265                         if ( in_array( $this->mRestriction, $user->getRights() ) ) {
 266                                 return true;
 267                         } else {
 268                                 return false;
 269                         }
 270                 }
 271         }
 272
 273         /**
 274          * Output an error message telling the user what access level they have to have
 275          */
 276         function displayRestrictionError() {
 277                 global $wgOut;
 278                 if ( $this->mRestriction == "developer" ) {
 279                         $wgOut->developerRequired();
 280                 } else {
 281                         $wgOut->sysopRequired();
 282                 }
 283         }
 284
 285         /**
 286          * Sets headers - this should be called from the execute() method of all derived classes!
 287          */
 288         function setHeaders() {
 289                 global $wgOut;
 290                 $wgOut->setArticleRelated( false );
 291                 $wgOut->setRobotPolicy( "noindex,follow" );
 292                 $wgOut->setPageTitle( $this->getDescription() );
 293         }
 294
 295         /**
 296          * Default execute method
 297          * Checks user permissions, calls the function given in mFunction
 298          */
 299         function execute( $par ) {
 300                 global $wgUser, $wgOut, $wgTitle;
 301
 302                 $this->setHeaders();
 303
 304                 if ( $this->userCanExecute( $wgUser ) ) {
 305                         if ( $this->mFile ) {
 306                                 require_once( $this->mFile );
 307                         }
 308                         $func = $this->mFunction;
 309                         $func( $par );
 310                 } else {
 311                         $this->displayRestrictionError();
 312                 }
 313         }
 314
 315         # Returns the name that goes in the <h1> in the special page itself, and also the name that
 316         # will be listed in Special:Specialpages
 317         #
 318         # Derived classes can override this, but usually it is easier to keep the default behaviour.
 319         # Messages can be added at run-time, see MessageCache.php
 320         function getDescription() {
 321                 return wfMsg( strtolower( $this->mName ) );
 322         }
 323
 324         /**
 325          * Get a self-referential title object
 326          */
 327         function getTitle() {
 328                 return Title::makeTitle( NS_SPECIAL, $this->mName );
 329         }
 330
 331         /**
 332          * Set whether this page is listed in Special:Specialpages, at run-time
 333          */
 334         function setListed( $listed ) {
 335                 return wfSetVar( $this->mListed, $listed );
 336         }
 337 }
 338
 339 /**
 340  * Shortcut to construct a special page which is unlisted by default
 341  * @package MediaWiki
 342  */
 343 class UnlistedSpecialPage extends SpecialPage
 344 {
 345         function UnlistedSpecialPage( $name, $restriction = '', $function = false, $file = 'default' ) {
 346                 SpecialPage::SpecialPage( $name, $restriction, false, $function, $file );
 347         }
 348 }