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  * @subpackage SpecialPage
  16  */
  17
  18
  19 /**
  20  * @access private
  21  */
  22 $wgSpecialPages = array(
  23         'DoubleRedirects'       => new SpecialPage ( 'DoubleRedirects' ),
  24         'BrokenRedirects'       => new SpecialPage ( 'BrokenRedirects' ),
  25         'Disambiguations'       => new SpecialPage ( 'Disambiguations' ),
  26
  27         'Userlogin'         => new SpecialPage( 'Userlogin' ),
  28         'Userlogout'        => new UnlistedSpecialPage( 'Userlogout' ),
  29         'Preferences'       => new SpecialPage( 'Preferences' ),
  30         'Watchlist'         => new SpecialPage( 'Watchlist' ),
  31
  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' ),
  84 );
  85
  86 if( !$wgDisableCounters ) {
  87         $wgSpecialPages['Popularpages'] = new SpecialPage( 'Popularpages' );
  88 }
  89
  90 if( !$wgDisableInternalSearch ) {
  91         $wgSpecialPages['Search'] = new SpecialPage( 'Search' );
  92 }
  93
  94 if( $wgEmailAuthentication ) {
  95         $wgSpecialPages['Confirmemail'] = new UnlistedSpecialPage( 'Confirmemail' );
  96 }
  97
  98 /**
  99  * Parent special page class, also static functions for handling the special
 100  * page list
 101  * @package MediaWiki
 102  */
 103 class SpecialPage
 104 {
 105         /**#@+
 106          * @access private
 107          */
 108         /**
 109          * The name of the class, used in the URL.
 110          * Also used for the default <h1> heading, @see getDescription()
 111          */
 112         var $mName;
 113         /**
 114          * Minimum user level required to access this page, or "" for anyone.
 115          * Also used to categorise the pages in Special:Specialpages
 116          */
 117         var $mRestriction;
 118         /**
 119          * Listed in Special:Specialpages?
 120          */
 121         var $mListed;
 122         /**
 123          * Function name called by the default execute()
 124          */
 125         var $mFunction;
 126         /**
 127          * File which needs to be included before the function above can be called
 128          */
 129         var $mFile;
 130         /**
 131          * Whether or not this special page is being included from an article
 132          */
 133         var $mIncluding;
 134         /**
 135          * Whether the special page can be included in an article
 136          */
 137         var $mIncludable;
 138
 139
 140         /**#@-*/
 141
 142
 143         /**
 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
 147          * @static
 148          */
 149         static function addPage( &$obj ) {
 150                 global $wgSpecialPages;
 151                 $wgSpecialPages[$obj->mName] = $obj;
 152         }
 153
 154         /**
 155          * Remove a special page from the list
 156          * Occasionally used to disable expensive or dangerous special pages
 157          * @static
 158          */
 159         static function removePage( $name ) {
 160                 global $wgSpecialPages;
 161                 unset( $wgSpecialPages[$name] );
 162         }
 163
 164         /**
 165          * Find the object with a given name and return it (or NULL)
 166          * @static
 167          * @param string $name
 168          */
 169         static function getPage( $name ) {
 170                 global $wgSpecialPages;
 171                 if ( array_key_exists( $name, $wgSpecialPages ) ) {
 172                         return $wgSpecialPages[$name];
 173                 } else {
 174                         return NULL;
 175                 }
 176         }
 177
 178         /**
 179          * @static
 180          * @param string $name
 181          * @return mixed Title object if the redirect exists, otherwise NULL
 182          */
 183         static function getRedirect( $name ) {
 184                 global $wgUser;
 185
 186                 $redirects = array(
 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                         'Logs' => Title::makeTitle( NS_SPECIAL, 'Log' ),
 192                         'Randompage' => Title::makeTitle( NS_SPECIAL, 'Random' ),
 193                         'Userlist' => Title::makeTitle( NS_SPECIAL, 'Listusers' )
 194                 );
 195                 wfRunHooks( 'SpecialPageGetRedirect', array( &$redirects ) );
 196
 197                 return isset( $redirects[$name] ) ? $redirects[$name] : null;
 198         }
 199
 200         /**
 201          * Return part of the request string for a special redirect page
 202          * This allows passing, e.g. action=history to Special:Mypage, etc.
 203          *
 204          * @param $name Name of the redirect page
 205          * @return string
 206          */
 207         function getRedirectParams( $name ) {
 208                 global $wgRequest;
 209
 210                 $args = array();
 211                 switch( $name ) {
 212                         case 'Mypage':
 213                         case 'Mytalk':
 214                         case 'Randompage':
 215                                 $args = array( 'action' );
 216                 }
 217
 218                 $params = array();
 219                 foreach( $args as $arg ) {
 220                         if( $val = $wgRequest->getVal( $arg, false ) )
 221                                 $params[] = $arg . '=' . $val;
 222                 }
 223
 224                 return count( $params ) ? implode( '&', $params ) : false;
 225         }
 226
 227         /**
 228          * Return categorised listable special pages
 229          * Returns a 2d array where the first index is the restriction name
 230          * @static
 231          */
 232         static function getPages() {
 233                 global $wgSpecialPages;
 234                 $pages = array(
 235                   '' => array(),
 236                   'sysop' => array(),
 237                   'developer' => array()
 238                 );
 239
 240                 foreach ( $wgSpecialPages as $name => $page ) {
 241                         if ( $page->isListed() ) {
 242                                 $pages[$page->getRestriction()][$page->getName()] =& $wgSpecialPages[$name];
 243                         }
 244                 }
 245                 return $pages;
 246         }
 247
 248         /**
 249          * Execute a special page path.
 250          * The path     may contain parameters, e.g. Special:Name/Params
 251          * Extracts the special page name and call the execute method, passing the parameters
 252          *
 253          * Returns a title object if the page is redirected, false if there was no such special
 254          * page, and true if it was successful.
 255          *
 256          * @param $title          a title object
 257          * @param $including      output is being captured for use in {{special:whatever}}
 258          */
 259         function executePath( &$title, $including = false ) {
 260                 global $wgOut, $wgTitle;
 261                 $fname = 'SpecialPage::executePath';
 262                 wfProfileIn( $fname );
 263
 264                 $bits = split( "/", $title->getDBkey(), 2 );
 265                 $name = $bits[0];
 266                 if( !isset( $bits[1] ) ) { // bug 2087
 267                         $par = NULL;
 268                 } else {
 269                         $par = $bits[1];
 270                 }
 271
 272                 $page = SpecialPage::getPage( $name );
 273                 if ( is_null( $page ) ) {
 274                         if ( $including ) {
 275                                 wfProfileOut( $fname );
 276                                 return false;
 277                         } else {
 278                                 $redir = SpecialPage::getRedirect( $name );
 279                                 if ( isset( $redir ) ) {
 280                                         if( $par )
 281                                                 $redir = Title::makeTitle( $redir->getNamespace(), $redir->getText() . '/' . $par );
 282                                         $params = SpecialPage::getRedirectParams( $name );
 283                                         if( $params ) {
 284                                                 $url = $redir->getFullUrl( $params );
 285                                         } else {
 286                                                 $url = $redir->getFullUrl();
 287                                         }
 288                                         $wgOut->redirect( $url );
 289                                         $retVal = $redir;
 290                                         $wgOut->redirect( $url );
 291                                         $retVal = $redir;
 292                                 } else {
 293                                         $wgOut->setArticleRelated( false );
 294                                         $wgOut->setRobotpolicy( 'noindex,nofollow' );
 295                                         $wgOut->setStatusCode( 404 );
 296                                         $wgOut->showErrorPage( 'nosuchspecialpage', 'nospecialpagetext' );
 297                                         $retVal = false;
 298                                 }
 299                         }
 300                 } else {
 301                         if ( $including && !$page->includable() ) {
 302                                 wfProfileOut( $fname );
 303                                 return false;
 304                         } elseif ( !$including ) {
 305                                 if($par !== NULL) {
 306                                         $wgTitle = Title::makeTitle( NS_SPECIAL, $name );
 307                                 } else {
 308                                         $wgTitle = $title;
 309                                 }
 310                         }
 311                         $page->including( $including );
 312
 313                         $profName = 'Special:' . $page->getName();
 314                         wfProfileIn( $profName );
 315                         $page->execute( $par );
 316                         wfProfileOut( $profName );
 317                         $retVal = true;
 318                 }
 319                 wfProfileOut( $fname );
 320                 return $retVal;
 321         }
 322
 323         /**
 324          * Just like executePath() except it returns the HTML instead of outputting it
 325          * Returns false if there was no such special page, or a title object if it was
 326          * a redirect.
 327          * @static
 328          */
 329         static function capturePath( &$title ) {
 330                 global $wgOut, $wgTitle;
 331
 332                 $oldTitle = $wgTitle;
 333                 $oldOut = $wgOut;
 334                 $wgOut = new OutputPage;
 335
 336                 $ret = SpecialPage::executePath( $title, true );
 337                 if ( $ret === true ) {
 338                         $ret = $wgOut->getHTML();
 339                 }
 340                 $wgTitle = $oldTitle;
 341                 $wgOut = $oldOut;
 342                 return $ret;
 343         }
 344
 345         /**
 346          * Default constructor for special pages
 347          * Derivative classes should call this from their constructor
 348          *     Note that if the user does not have the required level, an error message will
 349          *     be displayed by the default execute() method, without the global function ever
 350          *     being called.
 351          *
 352          *     If you override execute(), you can recover the default behaviour with userCanExecute()
 353          *     and displayRestrictionError()
 354          *
 355          * @param string $name Name of the special page, as seen in links and URLs
 356          * @param string $restriction Minimum user level required, e.g. "sysop" or "developer".
 357          * @param boolean $listed Whether the page is listed in Special:Specialpages
 358          * @param string $function Function called by execute(). By default it is constructed from $name
 359          * @param string $file File which is included by execute(). It is also constructed from $name by default
 360          */
 361         function SpecialPage( $name = '', $restriction = '', $listed = true, $function = false, $file = 'default', $includable = false ) {
 362                 $this->mName = $name;
 363                 $this->mRestriction = $restriction;
 364                 $this->mListed = $listed;
 365                 $this->mIncludable = $includable;
 366                 if ( $function == false ) {
 367                         $this->mFunction = 'wfSpecial'.$name;
 368                 } else {
 369                         $this->mFunction = $function;
 370                 }
 371                 if ( $file === 'default' ) {
 372                         $this->mFile = "Special{$name}.php";
 373                 } else {
 374                         $this->mFile = $file;
 375                 }
 376         }
 377
 378         /**#@+
 379           * Accessor
 380           *
 381           * @deprecated
 382           */
 383         function getName() { return $this->mName; }
 384         function getRestriction() { return $this->mRestriction; }
 385         function getFile() { return $this->mFile; }
 386         function isListed() { return $this->mListed; }
 387         /**#@-*/
 388
 389         /**#@+
 390           * Accessor and mutator
 391           */
 392         function name( $x = NULL ) { return wfSetVar( $this->mName, $x ); }
 393         function restrictions( $x = NULL) { return wfSetVar( $this->mRestrictions, $x ); }
 394         function listed( $x = NULL) { return wfSetVar( $this->mListed, $x ); }
 395         function func( $x = NULL) { return wfSetVar( $this->mFunction, $x ); }
 396         function file( $x = NULL) { return wfSetVar( $this->mFile, $x ); }
 397         function includable( $x = NULL ) { return wfSetVar( $this->mIncludable, $x ); }
 398         function including( $x = NULL ) { return wfSetVar( $this->mIncluding, $x ); }
 399         /**#@-*/
 400
 401         /**
 402          * Checks if the given user (identified by an object) can execute this
 403          * special page (as defined by $mRestriction)
 404          */
 405         function userCanExecute( &$user ) {
 406                 if ( $this->mRestriction == "" ) {
 407                         return true;
 408                 } else {
 409                         if ( in_array( $this->mRestriction, $user->getRights() ) ) {
 410                                 return true;
 411                         } else {
 412                                 return false;
 413                         }
 414                 }
 415         }
 416
 417         /**
 418          * Output an error message telling the user what access level they have to have
 419          */
 420         function displayRestrictionError() {
 421                 global $wgOut;
 422                 $wgOut->permissionRequired( $this->mRestriction );
 423         }
 424
 425         /**
 426          * Sets headers - this should be called from the execute() method of all derived classes!
 427          */
 428         function setHeaders() {
 429                 global $wgOut;
 430                 $wgOut->setArticleRelated( false );
 431                 $wgOut->setRobotPolicy( "noindex,nofollow" );
 432                 $wgOut->setPageTitle( $this->getDescription() );
 433         }
 434
 435         /**
 436          * Default execute method
 437          * Checks user permissions, calls the function given in mFunction
 438          */
 439         function execute( $par ) {
 440                 global $wgUser;
 441
 442                 $this->setHeaders();
 443
 444                 if ( $this->userCanExecute( $wgUser ) ) {
 445                         $func = $this->mFunction;
 446                         // only load file if the function does not exist
 447                         if(!function_exists($func) and $this->mFile) {
 448                                 require_once( $this->mFile );
 449                         }
 450                         if ( wfRunHooks( 'SpecialPageExecuteBeforeHeader', array( &$this, &$par, &$func ) ) )
 451                                 $this->outputHeader();
 452                         if ( ! wfRunHooks( 'SpecialPageExecuteBeforePage', array( &$this, &$par, &$func ) ) )
 453                                 return;
 454                         $func( $par, $this );
 455                         if ( ! wfRunHooks( 'SpecialPageExecuteAfterPage', array( &$this, &$par, &$func ) ) )
 456                                 return;
 457                 } else {
 458                         $this->displayRestrictionError();
 459                 }
 460         }
 461
 462         function outputHeader() {
 463                 global $wgOut, $wgContLang;
 464
 465                 $msg = $wgContLang->lc( $this->name() ) . '-summary';
 466                 $out = wfMsg( $msg );
 467                 if ( ! wfEmptyMsg( $msg, $out ) and  $out !== '' and ! $this->including() )
 468                         $wgOut->addWikiText( $out );
 469
 470         }
 471
 472         # Returns the name that goes in the <h1> in the special page itself, and also the name that
 473         # will be listed in Special:Specialpages
 474         #
 475         # Derived classes can override this, but usually it is easier to keep the default behaviour.
 476         # Messages can be added at run-time, see MessageCache.php
 477         function getDescription() {
 478                 return wfMsg( strtolower( $this->mName ) );
 479         }
 480
 481         /**
 482          * Get a self-referential title object
 483          */
 484         function getTitle() {
 485                 return Title::makeTitle( NS_SPECIAL, $this->mName );
 486         }
 487
 488         /**
 489          * Set whether this page is listed in Special:Specialpages, at run-time
 490          */
 491         function setListed( $listed ) {
 492                 return wfSetVar( $this->mListed, $listed );
 493         }
 494
 495 }
 496
 497 /**
 498  * Shortcut to construct a special page which is unlisted by default
 499  * @package MediaWiki
 500  */
 501 class UnlistedSpecialPage extends SpecialPage
 502 {
 503         function UnlistedSpecialPage( $name, $restriction = '', $function = false, $file = 'default' ) {
 504                 SpecialPage::SpecialPage( $name, $restriction, false, $function, $file );
 505         }
 506 }
 507
 508 /**
 509  * Shortcut to construct an includable special  page
 510  * @package MediaWiki
 511  */
 512 class IncludableSpecialPage extends SpecialPage
 513 {
 514         function IncludableSpecialPage( $name, $restriction = '', $listed = true, $function = false, $file = 'default' ) {
 515                 SpecialPage::SpecialPage( $name, $restriction, $listed, $function, $file, true );
 516         }
 517 }
 518 ?>