includes/SpecialPage.php

   1 <?php
   2 /**
   3  * SpecialPage: handling special pages and lists thereof.
   4  *
   5  * To add a special page in an extension, add to $wgSpecialPages either
   6  * an object instance or an array containing the name and constructor
   7  * parameters. The latter is preferred for performance reasons.
   8  *
   9  * The object instantiated must be either an instance of SpecialPage or a
  10  * sub-class thereof. It must have an execute() method, which sends the HTML
  11  * for the special page to $wgOut. The parent class has an execute() method
  12  * which distributes the call to the historical global functions. Additionally,
  13  * execute() also checks if the user has the necessary access privileges
  14  * and bails out if not.
  15  *
  16  * To add a core special page, use the similar static list in
  17  * SpecialPage::$mList. To remove a core static special page at runtime, use
  18  * a SpecialPage_initList hook.
  19  *
  20  * @package MediaWiki
  21  * @subpackage SpecialPage
  22  */
  23
  24 /**
  25  * @access private
  26  */
  27
  28 /**
  29  * Parent special page class, also static functions for handling the special
  30  * page list
  31  * @package MediaWiki
  32  */
  33 class SpecialPage
  34 {
  35         /**#@+
  36          * @access private
  37          */
  38         /**
  39          * The name of the class, used in the URL.
  40          * Also used for the default <h1> heading, @see getDescription()
  41          */
  42         var $mName;
  43         /**
  44          * Minimum user level required to access this page, or "" for anyone.
  45          * Also used to categorise the pages in Special:Specialpages
  46          */
  47         var $mRestriction;
  48         /**
  49          * Listed in Special:Specialpages?
  50          */
  51         var $mListed;
  52         /**
  53          * Function name called by the default execute()
  54          */
  55         var $mFunction;
  56         /**
  57          * File which needs to be included before the function above can be called
  58          */
  59         var $mFile;
  60         /**
  61          * Whether or not this special page is being included from an article
  62          */
  63         var $mIncluding;
  64         /**
  65          * Whether the special page can be included in an article
  66          */
  67         var $mIncludable;
  68
  69         static public $mList = array(
  70                 'DoubleRedirects'       => array( 'SpecialPage', 'DoubleRedirects' ),
  71                 'BrokenRedirects'       => array( 'SpecialPage', 'BrokenRedirects' ),
  72                 'Disambiguations'       => array( 'SpecialPage', 'Disambiguations' ),
  73
  74                 'Userlogin'         => array( 'SpecialPage', 'Userlogin' ),
  75                 'Userlogout'        => array( 'UnlistedSpecialPage', 'Userlogout' ),
  76                 'Preferences'       => array( 'SpecialPage', 'Preferences' ),
  77                 'Watchlist'         => array( 'SpecialPage', 'Watchlist' ),
  78
  79                 'Recentchanges'     => array( 'IncludableSpecialPage', 'Recentchanges' ),
  80                 'Upload'            => array( 'SpecialPage', 'Upload' ),
  81                 'Imagelist'         => array( 'SpecialPage', 'Imagelist' ),
  82                 'Newimages'         => array( 'IncludableSpecialPage', 'Newimages' ),
  83                 'Listusers'         => array( 'SpecialPage', 'Listusers' ),
  84                 'Statistics'        => array( 'SpecialPage', 'Statistics' ),
  85                 'Random'            => array( 'SpecialPage', 'Randompage' ),
  86                 'Lonelypages'       => array( 'SpecialPage', 'Lonelypages' ),
  87                 'Uncategorizedpages'=> array( 'SpecialPage', 'Uncategorizedpages' ),
  88                 'Uncategorizedcategories'=> array( 'SpecialPage', 'Uncategorizedcategories' ),
  89                 'Uncategorizedimages' => array( 'SpecialPage', 'Uncategorizedimages' ),
  90                 'Unusedcategories'      => array( 'SpecialPage', 'Unusedcategories' ),
  91                 'Unusedimages'      => array( 'SpecialPage', 'Unusedimages' ),
  92                 'Wantedpages'       => array( 'IncludableSpecialPage', 'Wantedpages' ),
  93                 'Wantedcategories'  => array( 'SpecialPage', 'Wantedcategories' ),
  94                 'Mostlinked'        => array( 'SpecialPage', 'Mostlinked' ),
  95                 'Mostlinkedcategories' => array( 'SpecialPage', 'Mostlinkedcategories' ),
  96                 'Mostcategories'    => array( 'SpecialPage', 'Mostcategories' ),
  97                 'Mostimages'        => array( 'SpecialPage', 'Mostimages' ),
  98                 'Mostrevisions'     => array( 'SpecialPage', 'Mostrevisions' ),
  99                 'Shortpages'        => array( 'SpecialPage', 'Shortpages' ),
 100                 'Longpages'                 => array( 'SpecialPage', 'Longpages' ),
 101                 'Newpages'                  => array( 'IncludableSpecialPage', 'Newpages' ),
 102                 'Ancientpages'      => array( 'SpecialPage', 'Ancientpages' ),
 103                 'Deadendpages'      => array( 'SpecialPage', 'Deadendpages' ),
 104                 'Allpages'                  => array( 'IncludableSpecialPage', 'Allpages' ),
 105                 'Prefixindex'       => array( 'IncludableSpecialPage', 'Prefixindex' ) ,
 106                 'Ipblocklist'       => array( 'SpecialPage', 'Ipblocklist' ),
 107                 'Specialpages'      => array( 'UnlistedSpecialPage', 'Specialpages' ),
 108                 'Contributions'     => array( 'UnlistedSpecialPage', 'Contributions' ),
 109                 'Emailuser'                 => array( 'UnlistedSpecialPage', 'Emailuser' ),
 110                 'Whatlinkshere'     => array( 'UnlistedSpecialPage', 'Whatlinkshere' ),
 111                 'Recentchangeslinked' => array( 'UnlistedSpecialPage', 'Recentchangeslinked' ),
 112                 'Movepage'                  => array( 'UnlistedSpecialPage', 'Movepage' ),
 113                 'Blockme'           => array( 'UnlistedSpecialPage', 'Blockme' ),
 114                 'Booksources'       => array( 'SpecialPage', 'Booksources' ),
 115                 'Categories'        => array( 'SpecialPage', 'Categories' ),
 116                 'Export'                    => array( 'SpecialPage', 'Export' ),
 117                 'Version'                   => array( 'SpecialPage', 'Version' ),
 118                 'Allmessages'       => array( 'SpecialPage', 'Allmessages' ),
 119                 'Log'               => array( 'SpecialPage', 'Log' ),
 120                 'Blockip'                   => array( 'SpecialPage', 'Blockip', 'block' ),
 121                 'Undelete'                  => array( 'SpecialPage', 'Undelete', 'deletedhistory' ),
 122                 "Import"                    => array( 'SpecialPage', "Import", 'import' ),
 123                 'Lockdb'                    => array( 'SpecialPage', 'Lockdb', 'siteadmin' ),
 124                 'Unlockdb'                  => array( 'SpecialPage', 'Unlockdb', 'siteadmin' ),
 125                 'Userrights'        => array( 'SpecialPage', 'Userrights', 'userrights' ),
 126                 'MIMEsearch'        => array( 'SpecialPage', 'MIMEsearch' ),
 127                 'Unwatchedpages'    => array( 'SpecialPage', 'Unwatchedpages', 'unwatchedpages' ),
 128                 'Listredirects'     => array( 'SpecialPage', 'Listredirects' ),
 129                 'Revisiondelete'    => array( 'SpecialPage', 'Revisiondelete', 'deleterevision' ),
 130                 'Unusedtemplates'   => array( 'SpecialPage', 'Unusedtemplates' ),
 131                 'Randomredirect'    => array( 'SpecialPage', 'Randomredirect' ),
 132         );
 133
 134         static public $mListInitialised = false;
 135
 136         /**#@-*/
 137
 138         /**
 139          * Initialise the special page list
 140          * This must be called before accessing SpecialPage::$mList
 141          */
 142         static function initList() {
 143                 global $wgSpecialPages;
 144                 global $wgDisableCounters, $wgDisableInternalSearch, $wgEmailAuthentication;
 145
 146                 if ( self::$mListInitialised ) {
 147                         return;
 148                 }
 149                 wfProfileIn( __METHOD__ );
 150
 151                 if( !$wgDisableCounters ) {
 152                         self::$mList['Popularpages'] = array( 'SpecialPage', 'Popularpages' );
 153                 }
 154
 155                 if( !$wgDisableInternalSearch ) {
 156                         self::$mList['Search'] = array( 'SpecialPage', 'Search' );
 157                 }
 158
 159                 if( $wgEmailAuthentication ) {
 160                         self::$mList['Confirmemail'] = array( 'UnlistedSpecialPage', 'Confirmemail' );
 161                 }
 162
 163                 # Add extension special pages
 164                 self::$mList = array_merge( self::$mList, $wgSpecialPages );
 165
 166                 # Better to set this now, to avoid infinite recursion in carelessly written hooks
 167                 self::$mListInitialised = true;
 168
 169                 # Run hooks
 170                 # This hook can be used to remove undesired built-in special pages
 171                 wfRunHooks( 'SpecialPage_initList', array( &self::$mList ) );
 172                 wfProfileOut( __METHOD__ );
 173         }
 174
 175         /**
 176          * Add a page to the list of valid special pages. This used to be the preferred
 177          * method for adding special pages in extensions. It's now suggested that you add
 178          * an associative record to $wgSpecialPages. This avoids autoloading SpecialPage.
 179          *
 180          * @param mixed $page Must either be an array specifying a class name and
 181          *                    constructor parameters, or an object. The object,
 182          *                    when constructed, must have an execute() method which
 183          *                    sends HTML to $wgOut.
 184          * @static
 185          */
 186         static function addPage( &$page ) {
 187                 if ( !self::$mListInitialised ) {
 188                         self::initList();
 189                 }
 190                 self::$mList[$page->mName] = $page;
 191         }
 192
 193         /**
 194          * Remove a special page from the list
 195          * Formerly used to disable expensive or dangerous special pages. The
 196          * preferred method is now to add a SpecialPage_initList hook.
 197          *
 198          * @static
 199          */
 200         static function removePage( $name ) {
 201                 if ( !self::$mListInitialised ) {
 202                         self::initList();
 203                 }
 204                 unset( self::$mList[$name] );
 205         }
 206
 207         /**
 208          * Find the object with a given name and return it (or NULL)
 209          * @static
 210          * @param string $name
 211          */
 212         static function getPage( $name ) {
 213                 if ( !self::$mListInitialised ) {
 214                         self::initList();
 215                 }
 216                 if ( array_key_exists( $name, self::$mList ) ) {
 217                         $rec = self::$mList[$name];
 218                         if ( is_string( $rec ) ) {
 219                                 $className = $rec;
 220                                 self::$mList[$name] = new $className;
 221                         } elseif ( is_array( $rec ) ) {
 222                                 $className = array_shift( $rec );
 223                                 self::$mList[$name] = wfCreateObject( $className, $rec );
 224                         }
 225                         return self::$mList[$name];
 226                 } else {
 227                         return NULL;
 228                 }
 229         }
 230
 231
 232         /**
 233          * @static
 234          * @param string $name
 235          * @return mixed Title object if the redirect exists, otherwise NULL
 236          */
 237         static function getRedirect( $name ) {
 238                 global $wgUser;
 239
 240                 $redirects = array(
 241                         'Mypage' => Title::makeTitle( NS_USER, $wgUser->getName() ),
 242                         'Mytalk' => Title::makeTitle( NS_USER_TALK, $wgUser->getName() ),
 243                         'Mycontributions' => Title::makeTitle( NS_SPECIAL, 'Contributions/' . $wgUser->getName() ),
 244                         'Listadmins' => Title::makeTitle( NS_SPECIAL, 'Listusers/sysop' ), # @bug 2832
 245                         'Logs' => Title::makeTitle( NS_SPECIAL, 'Log' ),
 246                         'Randompage' => Title::makeTitle( NS_SPECIAL, 'Random' ),
 247                         'Userlist' => Title::makeTitle( NS_SPECIAL, 'Listusers' )
 248                 );
 249                 wfRunHooks( 'SpecialPageGetRedirect', array( &$redirects ) );
 250
 251                 return isset( $redirects[$name] ) ? $redirects[$name] : null;
 252         }
 253
 254         /**
 255          * Return part of the request string for a special redirect page
 256          * This allows passing, e.g. action=history to Special:Mypage, etc.
 257          *
 258          * @param $name Name of the redirect page
 259          * @return string
 260          */
 261         function getRedirectParams( $name ) {
 262                 global $wgRequest;
 263
 264                 $args = array();
 265                 switch( $name ) {
 266                         case 'Mypage':
 267                         case 'Mytalk':
 268                         case 'Randompage':
 269                                 $args = array( 'action' );
 270                 }
 271
 272                 $params = array();
 273                 foreach( $args as $arg ) {
 274                         if( $val = $wgRequest->getVal( $arg, false ) )
 275                                 $params[] = $arg . '=' . $val;
 276                 }
 277
 278                 return count( $params ) ? implode( '&', $params ) : false;
 279         }
 280
 281         /**
 282          * Return categorised listable special pages
 283          * Returns a 2d array where the first index is the restriction name
 284          * @static
 285          */
 286         static function getPages() {
 287                 if ( !self::$mListInitialised ) {
 288                         self::initList();
 289                 }
 290                 $pages = array(
 291                   '' => array(),
 292                   'sysop' => array(),
 293                   'developer' => array()
 294                 );
 295
 296                 foreach ( self::$mList as $name => $rec ) {
 297                         $page = self::getPage( $name );
 298                         if ( $page->isListed() ) {
 299                                 $pages[$page->getRestriction()][$page->getName()] = $page;
 300                         }
 301                 }
 302                 return $pages;
 303         }
 304
 305         /**
 306          * Execute a special page path.
 307          * The path     may contain parameters, e.g. Special:Name/Params
 308          * Extracts the special page name and call the execute method, passing the parameters
 309          *
 310          * Returns a title object if the page is redirected, false if there was no such special
 311          * page, and true if it was successful.
 312          *
 313          * @param $title          a title object
 314          * @param $including      output is being captured for use in {{special:whatever}}
 315          */
 316         function executePath( &$title, $including = false ) {
 317                 global $wgOut, $wgTitle;
 318                 $fname = 'SpecialPage::executePath';
 319                 wfProfileIn( $fname );
 320
 321                 $bits = split( "/", $title->getDBkey(), 2 );
 322                 $name = $bits[0];
 323                 if( !isset( $bits[1] ) ) { // bug 2087
 324                         $par = NULL;
 325                 } else {
 326                         $par = $bits[1];
 327                 }
 328
 329                 $page = SpecialPage::getPage( $name );
 330                 if ( is_null( $page ) ) {
 331                         if ( $including ) {
 332                                 wfProfileOut( $fname );
 333                                 return false;
 334                         } else {
 335                                 $redir = SpecialPage::getRedirect( $name );
 336                                 if ( isset( $redir ) ) {
 337                                         if( $par )
 338                                                 $redir = Title::makeTitle( $redir->getNamespace(), $redir->getText() . '/' . $par );
 339                                         $params = SpecialPage::getRedirectParams( $name );
 340                                         if( $params ) {
 341                                                 $url = $redir->getFullUrl( $params );
 342                                         } else {
 343                                                 $url = $redir->getFullUrl();
 344                                         }
 345                                         $wgOut->redirect( $url );
 346                                         $retVal = $redir;
 347                                         $wgOut->redirect( $url );
 348                                         $retVal = $redir;
 349                                 } else {
 350                                         $wgOut->setArticleRelated( false );
 351                                         $wgOut->setRobotpolicy( 'noindex,nofollow' );
 352                                         $wgOut->setStatusCode( 404 );
 353                                         $wgOut->showErrorPage( 'nosuchspecialpage', 'nospecialpagetext' );
 354                                         $retVal = false;
 355                                 }
 356                         }
 357                 } else {
 358                         if ( $including && !$page->includable() ) {
 359                                 wfProfileOut( $fname );
 360                                 return false;
 361                         } elseif ( !$including ) {
 362                                 if($par !== NULL) {
 363                                         $wgTitle = Title::makeTitle( NS_SPECIAL, $name );
 364                                 } else {
 365                                         $wgTitle = $title;
 366                                 }
 367                         }
 368                         $page->including( $including );
 369
 370                         $profName = 'Special:' . $page->getName();
 371                         wfProfileIn( $profName );
 372                         $page->execute( $par );
 373                         wfProfileOut( $profName );
 374                         $retVal = true;
 375                 }
 376                 wfProfileOut( $fname );
 377                 return $retVal;
 378         }
 379
 380         /**
 381          * Just like executePath() except it returns the HTML instead of outputting it
 382          * Returns false if there was no such special page, or a title object if it was
 383          * a redirect.
 384          * @static
 385          */
 386         static function capturePath( &$title ) {
 387                 global $wgOut, $wgTitle;
 388
 389                 $oldTitle = $wgTitle;
 390                 $oldOut = $wgOut;
 391                 $wgOut = new OutputPage;
 392
 393                 $ret = SpecialPage::executePath( $title, true );
 394                 if ( $ret === true ) {
 395                         $ret = $wgOut->getHTML();
 396                 }
 397                 $wgTitle = $oldTitle;
 398                 $wgOut = $oldOut;
 399                 return $ret;
 400         }
 401
 402         /**
 403          * Default constructor for special pages
 404          * Derivative classes should call this from their constructor
 405          *     Note that if the user does not have the required level, an error message will
 406          *     be displayed by the default execute() method, without the global function ever
 407          *     being called.
 408          *
 409          *     If you override execute(), you can recover the default behaviour with userCanExecute()
 410          *     and displayRestrictionError()
 411          *
 412          * @param string $name Name of the special page, as seen in links and URLs
 413          * @param string $restriction Minimum user level required, e.g. "sysop" or "developer".
 414          * @param boolean $listed Whether the page is listed in Special:Specialpages
 415          * @param string $function Function called by execute(). By default it is constructed from $name
 416          * @param string $file File which is included by execute(). It is also constructed from $name by default
 417          */
 418         function SpecialPage( $name = '', $restriction = '', $listed = true, $function = false, $file = 'default', $includable = false ) {
 419                 $this->mName = $name;
 420                 $this->mRestriction = $restriction;
 421                 $this->mListed = $listed;
 422                 $this->mIncludable = $includable;
 423                 if ( $function == false ) {
 424                         $this->mFunction = 'wfSpecial'.$name;
 425                 } else {
 426                         $this->mFunction = $function;
 427                 }
 428                 if ( $file === 'default' ) {
 429                         $this->mFile = "Special{$name}.php";
 430                 } else {
 431                         $this->mFile = $file;
 432                 }
 433         }
 434
 435         /**#@+
 436           * Accessor
 437           *
 438           * @deprecated
 439           */
 440         function getName() { return $this->mName; }
 441         function getRestriction() { return $this->mRestriction; }
 442         function getFile() { return $this->mFile; }
 443         function isListed() { return $this->mListed; }
 444         /**#@-*/
 445
 446         /**#@+
 447           * Accessor and mutator
 448           */
 449         function name( $x = NULL ) { return wfSetVar( $this->mName, $x ); }
 450         function restrictions( $x = NULL) { return wfSetVar( $this->mRestrictions, $x ); }
 451         function listed( $x = NULL) { return wfSetVar( $this->mListed, $x ); }
 452         function func( $x = NULL) { return wfSetVar( $this->mFunction, $x ); }
 453         function file( $x = NULL) { return wfSetVar( $this->mFile, $x ); }
 454         function includable( $x = NULL ) { return wfSetVar( $this->mIncludable, $x ); }
 455         function including( $x = NULL ) { return wfSetVar( $this->mIncluding, $x ); }
 456         /**#@-*/
 457
 458         /**
 459          * Checks if the given user (identified by an object) can execute this
 460          * special page (as defined by $mRestriction)
 461          */
 462         function userCanExecute( &$user ) {
 463                 if ( $this->mRestriction == "" ) {
 464                         return true;
 465                 } else {
 466                         if ( in_array( $this->mRestriction, $user->getRights() ) ) {
 467                                 return true;
 468                         } else {
 469                                 return false;
 470                         }
 471                 }
 472         }
 473
 474         /**
 475          * Output an error message telling the user what access level they have to have
 476          */
 477         function displayRestrictionError() {
 478                 global $wgOut;
 479                 $wgOut->permissionRequired( $this->mRestriction );
 480         }
 481
 482         /**
 483          * Sets headers - this should be called from the execute() method of all derived classes!
 484          */
 485         function setHeaders() {
 486                 global $wgOut;
 487                 $wgOut->setArticleRelated( false );
 488                 $wgOut->setRobotPolicy( "noindex,nofollow" );
 489                 $wgOut->setPageTitle( $this->getDescription() );
 490         }
 491
 492         /**
 493          * Default execute method
 494          * Checks user permissions, calls the function given in mFunction
 495          */
 496         function execute( $par ) {
 497                 global $wgUser;
 498
 499                 $this->setHeaders();
 500
 501                 if ( $this->userCanExecute( $wgUser ) ) {
 502                         $func = $this->mFunction;
 503                         // only load file if the function does not exist
 504                         if(!function_exists($func) and $this->mFile) {
 505                                 require_once( $this->mFile );
 506                         }
 507                         if ( wfRunHooks( 'SpecialPageExecuteBeforeHeader', array( &$this, &$par, &$func ) ) )
 508                                 $this->outputHeader();
 509                         if ( ! wfRunHooks( 'SpecialPageExecuteBeforePage', array( &$this, &$par, &$func ) ) )
 510                                 return;
 511                         $func( $par, $this );
 512                         if ( ! wfRunHooks( 'SpecialPageExecuteAfterPage', array( &$this, &$par, &$func ) ) )
 513                                 return;
 514                 } else {
 515                         $this->displayRestrictionError();
 516                 }
 517         }
 518
 519         function outputHeader() {
 520                 global $wgOut, $wgContLang;
 521
 522                 $msg = $wgContLang->lc( $this->name() ) . '-summary';
 523                 $out = wfMsg( $msg );
 524                 if ( ! wfEmptyMsg( $msg, $out ) and  $out !== '' and ! $this->including() )
 525                         $wgOut->addWikiText( $out );
 526
 527         }
 528
 529         # Returns the name that goes in the <h1> in the special page itself, and also the name that
 530         # will be listed in Special:Specialpages
 531         #
 532         # Derived classes can override this, but usually it is easier to keep the default behaviour.
 533         # Messages can be added at run-time, see MessageCache.php
 534         function getDescription() {
 535                 return wfMsg( strtolower( $this->mName ) );
 536         }
 537
 538         /**
 539          * Get a self-referential title object
 540          */
 541         function getTitle() {
 542                 return Title::makeTitle( NS_SPECIAL, $this->mName );
 543         }
 544
 545         /**
 546          * Set whether this page is listed in Special:Specialpages, at run-time
 547          */
 548         function setListed( $listed ) {
 549                 return wfSetVar( $this->mListed, $listed );
 550         }
 551
 552 }
 553
 554 /**
 555  * Shortcut to construct a special page which is unlisted by default
 556  * @package MediaWiki
 557  */
 558 class UnlistedSpecialPage extends SpecialPage
 559 {
 560         function UnlistedSpecialPage( $name, $restriction = '', $function = false, $file = 'default' ) {
 561                 SpecialPage::SpecialPage( $name, $restriction, false, $function, $file );
 562         }
 563 }
 564
 565 /**
 566  * Shortcut to construct an includable special  page
 567  * @package MediaWiki
 568  */
 569 class IncludableSpecialPage extends SpecialPage
 570 {
 571         function IncludableSpecialPage( $name, $restriction = '', $listed = true, $function = false, $file = 'default' ) {
 572                 SpecialPage::SpecialPage( $name, $restriction, $listed, $function, $file, true );
 573         }
 574 }
 575 ?>