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         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         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         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         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                         'Randompage' => Title::makeTitle( NS_SPECIAL, 'Random' ),
 192                         'Userlist' => Title::makeTitle( NS_SPECIAL, 'Listusers' )
 193                 );
 194                 wfRunHooks( 'SpecialPageGetRedirect', array( &$redirects ) );
 195
 196                 return isset( $redirects[$name] ) ? $redirects[$name] : null;
 197         }
 198
 199         /**
 200          * Return part of the request string for a special redirect page
 201          * This allows passing, e.g. action=history to Special:Mypage, etc.
 202          *
 203          * @param $name Name of the redirect page
 204          * @return string
 205          */
 206         function getRedirectParams( $name ) {
 207                 global $wgRequest;
 208
 209                 $args = array();
 210                 switch( $name ) {
 211                         case 'Mypage':
 212                         case 'Mytalk':
 213                         case 'Randompage':
 214                                 $args = array( 'action' );
 215                 }
 216
 217                 $params = array();
 218                 foreach( $args as $arg ) {
 219                         if( $val = $wgRequest->getVal( $arg, false ) )
 220                                 $params[] = $arg . '=' . $val;
 221                 }
 222
 223                 return count( $params ) ? implode( '&', $params ) : false;
 224         }
 225
 226         /**
 227          * Return categorised listable special pages
 228          * Returns a 2d array where the first index is the restriction name
 229          * @static
 230          */
 231         function getPages() {
 232                 global $wgSpecialPages;
 233                 $pages = array(
 234                   '' => array(),
 235                   'sysop' => array(),
 236                   'developer' => array()
 237                 );
 238
 239                 foreach ( $wgSpecialPages as $name => $page ) {
 240                         if ( $page->isListed() ) {
 241                                 $pages[$page->getRestriction()][$page->getName()] =& $wgSpecialPages[$name];
 242                         }
 243                 }
 244                 return $pages;
 245         }
 246
 247         /**
 248          * Execute a special page path.
 249          * The path     may contain parameters, e.g. Special:Name/Params
 250          * Extracts the special page name and call the execute method, passing the parameters
 251          *
 252          * Returns a title object if the page is redirected, false if there was no such special
 253          * page, and true if it was successful.
 254          *
 255          * @param $title          a title object
 256          * @param $including      output is being captured for use in {{special:whatever}}
 257          */
 258         function executePath( &$title, $including = false ) {
 259                 global $wgOut, $wgTitle;
 260                 $fname = 'SpecialPage::executePath';
 261                 wfProfileIn( $fname );
 262
 263                 $bits = split( "/", $title->getDBkey(), 2 );
 264                 $name = $bits[0];
 265                 if( !isset( $bits[1] ) ) { // bug 2087
 266                         $par = NULL;
 267                 } else {
 268                         $par = $bits[1];
 269                 }
 270
 271                 $page = SpecialPage::getPage( $name );
 272                 if ( is_null( $page ) ) {
 273                         if ( $including ) {
 274                                 wfProfileOut( $fname );
 275                                 return false;
 276                         } else {
 277                                 $redir = SpecialPage::getRedirect( $name );
 278                                 if ( isset( $redir ) ) {
 279                                         $params = SpecialPage::getRedirectParams( $name );
 280                                         if( $params ) {
 281                                                 $url = $redir->getFullUrl( $params );
 282                                         } elseif( $par ) {
 283                                                 $url = $redir->getFullUrl() . '/' . $par;
 284                                         } else {
 285                                                 $url = $redir->getFullUrl();
 286                                         }
 287                                         $wgOut->redirect( $url );
 288                                         $retVal = $redir;
 289                                 } else {
 290                                         $wgOut->setArticleRelated( false );
 291                                         $wgOut->setRobotpolicy( 'noindex,follow' );
 292                                         $wgOut->setStatusCode( 404 );
 293                                         $wgOut->errorpage( 'nosuchspecialpage', 'nospecialpagetext' );
 294                                         $retVal = false;
 295                                 }
 296                         }
 297                 } else {
 298                         if ( $including && !$page->includable() ) {
 299                                 wfProfileOut( $fname );
 300                                 return false;
 301                         } elseif ( !$including ) {
 302                                 if($par !== NULL) {
 303                                         $wgTitle = Title::makeTitle( NS_SPECIAL, $name );
 304                                 } else {
 305                                         $wgTitle = $title;
 306                                 }
 307                         }
 308                         $page->including( $including );
 309
 310                         $profName = 'Special:' . $page->getName();
 311                         wfProfileIn( $profName );
 312                         $page->execute( $par );
 313                         wfProfileOut( $profName );
 314                         $retVal = true;
 315                 }
 316                 wfProfileOut( $fname );
 317                 return $retVal;
 318         }
 319
 320         /**
 321          * Just like executePath() except it returns the HTML instead of outputting it
 322          * Returns false if there was no such special page, or a title object if it was
 323          * a redirect.
 324          * @static
 325          */
 326         function capturePath( &$title ) {
 327                 global $wgOut, $wgTitle;
 328
 329                 $oldTitle = $wgTitle;
 330                 $oldOut = $wgOut;
 331                 $wgOut = new OutputPage;
 332
 333                 $ret = SpecialPage::executePath( $title, true );
 334                 if ( $ret === true ) {
 335                         $ret = $wgOut->getHTML();
 336                 }
 337                 $wgTitle = $oldTitle;
 338                 $wgOut = $oldOut;
 339                 return $ret;
 340         }
 341
 342         /**
 343          * Default constructor for special pages
 344          * Derivative classes should call this from their constructor
 345          *     Note that if the user does not have the required level, an error message will
 346          *     be displayed by the default execute() method, without the global function ever
 347          *     being called.
 348          *
 349          *     If you override execute(), you can recover the default behaviour with userCanExecute()
 350          *     and displayRestrictionError()
 351          *
 352          * @param string $name Name of the special page, as seen in links and URLs
 353          * @param string $restriction Minimum user level required, e.g. "sysop" or "developer".
 354          * @param boolean $listed Whether the page is listed in Special:Specialpages
 355          * @param string $function Function called by execute(). By default it is constructed from $name
 356          * @param string $file File which is included by execute(). It is also constructed from $name by default
 357          */
 358         function SpecialPage( $name = '', $restriction = '', $listed = true, $function = false, $file = 'default', $includable = false ) {
 359                 $this->mName = $name;
 360                 $this->mRestriction = $restriction;
 361                 $this->mListed = $listed;
 362                 $this->mIncludable = $includable;
 363                 if ( $function == false ) {
 364                         $this->mFunction = 'wfSpecial'.$name;
 365                 } else {
 366                         $this->mFunction = $function;
 367                 }
 368                 if ( $file === 'default' ) {
 369                         $this->mFile = "Special{$name}.php";
 370                 } else {
 371                         $this->mFile = $file;
 372                 }
 373         }
 374
 375         /**#@+
 376           * Accessor
 377           *
 378           * @deprecated
 379           */
 380         function getName() { return $this->mName; }
 381         function getRestriction() { return $this->mRestriction; }
 382         function getFile() { return $this->mFile; }
 383         function isListed() { return $this->mListed; }
 384         /**#@-*/
 385
 386         /**#@+
 387           * Accessor and mutator
 388           */
 389         function name( $x = NULL ) { return wfSetVar( $this->mName, $x ); }
 390         function restrictions( $x = NULL) { return wfSetVar( $this->mRestrictions, $x ); }
 391         function listed( $x = NULL) { return wfSetVar( $this->mListed, $x ); }
 392         function func( $x = NULL) { return wfSetVar( $this->mFunction, $x ); }
 393         function file( $x = NULL) { return wfSetVar( $this->mFile, $x ); }
 394         function includable( $x = NULL ) { return wfSetVar( $this->mIncludable, $x ); }
 395         function including( $x = NULL ) { return wfSetVar( $this->mIncluding, $x ); }
 396         /**#@-*/
 397
 398         /**
 399          * Checks if the given user (identified by an object) can execute this
 400          * special page (as defined by $mRestriction)
 401          */
 402         function userCanExecute( &$user ) {
 403                 if ( $this->mRestriction == "" ) {
 404                         return true;
 405                 } else {
 406                         if ( in_array( $this->mRestriction, $user->getRights() ) ) {
 407                                 return true;
 408                         } else {
 409                                 return false;
 410                         }
 411                 }
 412         }
 413
 414         /**
 415          * Output an error message telling the user what access level they have to have
 416          */
 417         function displayRestrictionError() {
 418                 global $wgOut;
 419                 $wgOut->permissionRequired( $this->mRestriction );
 420         }
 421
 422         /**
 423          * Sets headers - this should be called from the execute() method of all derived classes!
 424          */
 425         function setHeaders() {
 426                 global $wgOut;
 427                 $wgOut->setArticleRelated( false );
 428                 $wgOut->setRobotPolicy( "noindex,follow" );
 429                 $wgOut->setPageTitle( $this->getDescription() );
 430         }
 431
 432         /**
 433          * Default execute method
 434          * Checks user permissions, calls the function given in mFunction
 435          */
 436         function execute( $par ) {
 437                 global $wgUser;
 438
 439                 $this->setHeaders();
 440
 441                 if ( $this->userCanExecute( $wgUser ) ) {
 442                         $func = $this->mFunction;
 443                         // only load file if the function does not exist
 444                         if(!function_exists($func) and $this->mFile) {
 445                                 require_once( $this->mFile );
 446                         }
 447                         if ( wfRunHooks( 'SpecialPageExecuteBeforeHeader', array( &$this, &$par, &$func ) ) )
 448                                 $this->outputHeader();
 449                         if ( ! wfRunHooks( 'SpecialPageExecuteBeforePage', array( &$this, &$par, &$func ) ) )
 450                                 return;
 451                         $func( $par, $this );
 452                         if ( ! wfRunHooks( 'SpecialPageExecuteAfterPage', array( &$this, &$par, &$func ) ) )
 453                                 return;
 454                 } else {
 455                         $this->displayRestrictionError();
 456                 }
 457         }
 458
 459         function outputHeader() {
 460                 global $wgOut, $wgContLang;
 461
 462                 $msg = $wgContLang->lc( $this->name() ) . '-summary';
 463                 $out = wfMsg( $msg );
 464                 if ( ! wfEmptyMsg( $msg, $out ) and  $out !== '' and ! $this->including() )
 465                         $wgOut->addWikiText( $out );
 466
 467         }
 468
 469         # Returns the name that goes in the <h1> in the special page itself, and also the name that
 470         # will be listed in Special:Specialpages
 471         #
 472         # Derived classes can override this, but usually it is easier to keep the default behaviour.
 473         # Messages can be added at run-time, see MessageCache.php
 474         function getDescription() {
 475                 return wfMsg( strtolower( $this->mName ) );
 476         }
 477
 478         /**
 479          * Get a self-referential title object
 480          */
 481         function getTitle() {
 482                 return Title::makeTitle( NS_SPECIAL, $this->mName );
 483         }
 484
 485         /**
 486          * Set whether this page is listed in Special:Specialpages, at run-time
 487          */
 488         function setListed( $listed ) {
 489                 return wfSetVar( $this->mListed, $listed );
 490         }
 491
 492 }
 493
 494 /**
 495  * Shortcut to construct a special page which is unlisted by default
 496  * @package MediaWiki
 497  */
 498 class UnlistedSpecialPage extends SpecialPage
 499 {
 500         function UnlistedSpecialPage( $name, $restriction = '', $function = false, $file = 'default' ) {
 501                 SpecialPage::SpecialPage( $name, $restriction, false, $function, $file );
 502         }
 503 }
 504
 505 /**
 506  * Shortcut to construct an includable special  page
 507  * @package MediaWiki
 508  */
 509 class IncludableSpecialPage extends SpecialPage
 510 {
 511         function IncludableSpecialPage( $name, $restriction = '', $listed = true, $function = false, $file = 'default' ) {
 512                 SpecialPage::SpecialPage( $name, $restriction, $listed, $function, $file, true );
 513         }
 514 }
 515 ?>