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  * @addtogroup SpecialPage
  21  */
  22
  23 /**
  24  * @access private
  25  */
  26
  27 /**
  28  * Parent special page class, also static functions for handling the special
  29  * page list.
  30  * @addtogroup SpecialPage
  31  */
  32 class SpecialPage
  33 {
  34         /**#@+
  35          * @access private
  36          */
  37         /**
  38          * The canonical name of this special page
  39          * Also used for the default <h1> heading, @see getDescription()
  40          */
  41         var $mName;
  42         /**
  43          * The local name of this special page
  44          */
  45         var $mLocalName;
  46         /**
  47          * Minimum user level required to access this page, or "" for anyone.
  48          * Also used to categorise the pages in Special:Specialpages
  49          */
  50         var $mRestriction;
  51         /**
  52          * Listed in Special:Specialpages?
  53          */
  54         var $mListed;
  55         /**
  56          * Function name called by the default execute()
  57          */
  58         var $mFunction;
  59         /**
  60          * File which needs to be included before the function above can be called
  61          */
  62         var $mFile;
  63         /**
  64          * Whether or not this special page is being included from an article
  65          */
  66         var $mIncluding;
  67         /**
  68          * Whether the special page can be included in an article
  69          */
  70         var $mIncludable;
  71         /**
  72          * Query parameters that can be passed through redirects
  73          */
  74         var $mAllowedRedirectParams = array();
  75
  76         static public $mList = array(
  77                 'DoubleRedirects'           => array( 'SpecialPage', 'DoubleRedirects' ),
  78                 'BrokenRedirects'           => array( 'SpecialPage', 'BrokenRedirects' ),
  79                 'Disambiguations'           => array( 'SpecialPage', 'Disambiguations' ),
  80
  81                 'Userlogin'                 => array( 'SpecialPage', 'Userlogin' ),
  82                 'Userlogout'                => array( 'UnlistedSpecialPage', 'Userlogout' ),
  83                 'Preferences'               => array( 'SpecialPage', 'Preferences' ),
  84                 'Watchlist'                 => array( 'SpecialPage', 'Watchlist' ),
  85
  86                 'Recentchanges'             => array( 'IncludableSpecialPage', 'Recentchanges' ),
  87                 'Upload'                    => array( 'SpecialPage', 'Upload' ),
  88                 'Imagelist'                 => array( 'SpecialPage', 'Imagelist' ),
  89                 'Newimages'                 => array( 'IncludableSpecialPage', 'Newimages' ),
  90                 'Listusers'                 => array( 'SpecialPage', 'Listusers' ),
  91                 'Statistics'                => array( 'SpecialPage', 'Statistics' ),
  92                 'Randompage'                => array( 'SpecialPage', 'Randompage' ),
  93                 'Lonelypages'               => array( 'SpecialPage', 'Lonelypages' ),
  94                 'Uncategorizedpages'        => array( 'SpecialPage', 'Uncategorizedpages' ),
  95                 'Uncategorizedcategories'   => array( 'SpecialPage', 'Uncategorizedcategories' ),
  96                 'Uncategorizedimages'       => array( 'SpecialPage', 'Uncategorizedimages' ),
  97                 'Uncategorizedtemplates'    => array( 'SpecialPage', 'Uncategorizedtemplates' ),
  98                 'Unusedcategories'          => array( 'SpecialPage', 'Unusedcategories' ),
  99                 'Unusedimages'              => array( 'SpecialPage', 'Unusedimages' ),
 100                 'Wantedpages'               => array( 'IncludableSpecialPage', 'Wantedpages' ),
 101                 'Wantedcategories'          => array( 'SpecialPage', 'Wantedcategories' ),
 102                 'Mostlinked'                => array( 'SpecialPage', 'Mostlinked' ),
 103                 'Mostlinkedcategories'      => array( 'SpecialPage', 'Mostlinkedcategories' ),
 104                 'Mostlinkedtemplates'       => array( 'SpecialPage', 'Mostlinkedtemplates' ),
 105                 'Mostcategories'            => array( 'SpecialPage', 'Mostcategories' ),
 106                 'Mostimages'                => array( 'SpecialPage', 'Mostimages' ),
 107                 'Mostrevisions'             => array( 'SpecialPage', 'Mostrevisions' ),
 108                 'Fewestrevisions'           => array( 'SpecialPage', 'Fewestrevisions' ),
 109                 'Shortpages'                => array( 'SpecialPage', 'Shortpages' ),
 110                 'Longpages'                 => array( 'SpecialPage', 'Longpages' ),
 111                 'Newpages'                  => array( 'IncludableSpecialPage', 'Newpages' ),
 112                 'Ancientpages'              => array( 'SpecialPage', 'Ancientpages' ),
 113                 'Deadendpages'              => array( 'SpecialPage', 'Deadendpages' ),
 114                 'Protectedpages'            => array( 'SpecialPage', 'Protectedpages' ),
 115                 'Protectedtitles'           => array( 'SpecialPage', 'Protectedtitles' ),
 116                 'Allpages'                  => array( 'IncludableSpecialPage', 'Allpages' ),
 117                 'Prefixindex'               => array( 'IncludableSpecialPage', 'Prefixindex' ) ,
 118                 'Ipblocklist'               => array( 'SpecialPage', 'Ipblocklist' ),
 119                 'Specialpages'              => array( 'UnlistedSpecialPage', 'Specialpages' ),
 120                 'Contributions'             => array( 'SpecialPage', 'Contributions' ),
 121                 'Emailuser'                 => array( 'UnlistedSpecialPage', 'Emailuser' ),
 122                 'Whatlinkshere'             => array( 'SpecialPage', 'Whatlinkshere' ),
 123                 'Recentchangeslinked'       => array( 'UnlistedSpecialPage', 'Recentchangeslinked' ),
 124                 'Movepage'                  => array( 'UnlistedSpecialPage', 'Movepage' ),
 125                 'Blockme'                   => array( 'UnlistedSpecialPage', 'Blockme' ),
 126                 'Resetpass'                 => array( 'UnlistedSpecialPage', 'Resetpass' ),
 127                 'Booksources'               => 'SpecialBookSources',
 128                 'Categories'                => array( 'SpecialPage', 'Categories' ),
 129                 'Export'                    => array( 'SpecialPage', 'Export' ),
 130                 'Version'                   => array( 'SpecialPage', 'Version' ),
 131                 'Allmessages'               => array( 'SpecialPage', 'Allmessages' ),
 132                 'Log'                       => array( 'SpecialPage', 'Log' ),
 133                 'Blockip'                   => array( 'SpecialPage', 'Blockip', 'block' ),
 134                 'Undelete'                  => array( 'SpecialPage', 'Undelete', 'deletedhistory' ),
 135                 'Import'                    => array( 'SpecialPage', 'Import', 'import' ),
 136                 'Lockdb'                    => array( 'SpecialPage', 'Lockdb', 'siteadmin' ),
 137                 'Unlockdb'                  => array( 'SpecialPage', 'Unlockdb', 'siteadmin' ),
 138                 'Userrights'                => 'UserrightsPage',
 139                 'MIMEsearch'                => array( 'SpecialPage', 'MIMEsearch' ),
 140                 'Unwatchedpages'            => array( 'SpecialPage', 'Unwatchedpages', 'unwatchedpages' ),
 141                 'Listredirects'             => array( 'SpecialPage', 'Listredirects' ),
 142                 'Revisiondelete'            => array( 'UnlistedSpecialPage', 'Revisiondelete', 'deleterevision' ),
 143                 'Unusedtemplates'           => array( 'SpecialPage', 'Unusedtemplates' ),
 144                 'Randomredirect'            => array( 'SpecialPage', 'Randomredirect' ),
 145                 'Withoutinterwiki'          => array( 'SpecialPage', 'Withoutinterwiki' ),
 146
 147                 'Mypage'                    => array( 'SpecialMypage' ),
 148                 'Mytalk'                    => array( 'SpecialMytalk' ),
 149                 'Mycontributions'           => array( 'SpecialMycontributions' ),
 150                 'Listadmins'                => array( 'SpecialRedirectToSpecial', 'Listadmins', 'Listusers', 'sysop' ),
 151                 'MergeHistory'              => array( 'SpecialPage', 'MergeHistory', 'mergehistory' ),
 152                 'Listbots'                  => array( 'SpecialRedirectToSpecial', 'Listbots', 'Listusers', 'bot' ),
 153                 );
 154
 155         static public $mAliases;
 156         static public $mListInitialised = false;
 157
 158         /**#@-*/
 159
 160         /**
 161          * Initialise the special page list
 162          * This must be called before accessing SpecialPage::$mList
 163          */
 164         static function initList() {
 165                 global $wgSpecialPages;
 166                 global $wgDisableCounters, $wgDisableInternalSearch, $wgEmailAuthentication;
 167
 168                 if ( self::$mListInitialised ) {
 169                         return;
 170                 }
 171                 wfProfileIn( __METHOD__ );
 172
 173                 # Better to set this now, to avoid infinite recursion in carelessly written hooks
 174                 self::$mListInitialised = true;
 175
 176                 if( !$wgDisableCounters ) {
 177                         self::$mList['Popularpages'] = array( 'SpecialPage', 'Popularpages' );
 178                 }
 179
 180                 if( !$wgDisableInternalSearch ) {
 181                         self::$mList['Search'] = array( 'SpecialPage', 'Search' );
 182                 }
 183
 184                 if( $wgEmailAuthentication ) {
 185                         self::$mList['Confirmemail'] = 'EmailConfirmation';
 186                 }
 187
 188                 # Add extension special pages
 189                 self::$mList = array_merge( self::$mList, $wgSpecialPages );
 190
 191                 # Run hooks
 192                 # This hook can be used to remove undesired built-in special pages
 193                 wfRunHooks( 'SpecialPage_initList', array( &self::$mList ) );
 194                 wfProfileOut( __METHOD__ );
 195         }
 196
 197         static function initAliasList() {
 198                 if ( !is_null( self::$mAliases ) ) {
 199                         return;
 200                 }
 201
 202                 global $wgContLang;
 203                 $aliases = $wgContLang->getSpecialPageAliases();
 204                 $missingPages = self::$mList;
 205                 self::$mAliases = array();
 206                 foreach ( $aliases as $realName => $aliasList ) {
 207                         foreach ( $aliasList as $alias ) {
 208                                 self::$mAliases[$wgContLang->caseFold( $alias )] = $realName;
 209                         }
 210                         unset( $missingPages[$realName] );
 211                 }
 212                 foreach ( $missingPages as $name => $stuff ) {
 213                         self::$mAliases[$wgContLang->caseFold( $name )] = $name;
 214                 }
 215         }
 216
 217         /**
 218          * Given a special page alias, return the special page name.
 219          * Returns false if there is no such alias.
 220          */
 221         static function resolveAlias( $alias ) {
 222                 global $wgContLang;
 223
 224                 if ( !self::$mListInitialised ) self::initList();
 225                 if ( is_null( self::$mAliases ) ) self::initAliasList();
 226                 $caseFoldedAlias = $wgContLang->caseFold( $alias );
 227                 if ( isset( self::$mAliases[$caseFoldedAlias] ) ) {
 228                         return self::$mAliases[$caseFoldedAlias];
 229                 } else {
 230                         return false;
 231                 }
 232         }
 233
 234         /**
 235          * Given a special page name with a possible subpage, return an array
 236          * where the first element is the special page name and the second is the
 237          * subpage.
 238          */
 239         static function resolveAliasWithSubpage( $alias ) {
 240                 $bits = explode( '/', $alias, 2 );
 241                 $name = self::resolveAlias( $bits[0] );
 242                 if( !isset( $bits[1] ) ) { // bug 2087
 243                         $par = NULL;
 244                 } else {
 245                         $par = $bits[1];
 246                 }
 247                 return array( $name, $par );
 248         }
 249
 250         /**
 251          * Add a page to the list of valid special pages. This used to be the preferred
 252          * method for adding special pages in extensions. It's now suggested that you add
 253          * an associative record to $wgSpecialPages. This avoids autoloading SpecialPage.
 254          *
 255          * @param mixed $page Must either be an array specifying a class name and
 256          *                    constructor parameters, or an object. The object,
 257          *                    when constructed, must have an execute() method which
 258          *                    sends HTML to $wgOut.
 259          * @static
 260          */
 261         static function addPage( &$page ) {
 262                 if ( !self::$mListInitialised ) {
 263                         self::initList();
 264                 }
 265                 self::$mList[$page->mName] = $page;
 266         }
 267
 268         /**
 269          * Remove a special page from the list
 270          * Formerly used to disable expensive or dangerous special pages. The
 271          * preferred method is now to add a SpecialPage_initList hook.
 272          *
 273          * @static
 274          */
 275         static function removePage( $name ) {
 276                 if ( !self::$mListInitialised ) {
 277                         self::initList();
 278                 }
 279                 unset( self::$mList[$name] );
 280         }
 281
 282         /**
 283          * Check if a given name exist as a special page or as a special page alias
 284          * @param $name string: name of a special page
 285          * @return boolean: true if a special page exists with this name
 286          */
 287         static function exists( $name ) {
 288                 global $wgContLang;
 289                 if ( !self::$mListInitialised ) {
 290                         self::initList();
 291                 }
 292                 if( !self::$mAliases ) {
 293                         self::initAliasList();
 294                 }
 295
 296                 # Remove special pages inline parameters:
 297                 $bits = explode( '/', $name );
 298                 $name = $wgContLang->caseFold($bits[0]);
 299
 300                 return
 301                         array_key_exists( $name, self::$mList )
 302                         or array_key_exists( $name, self::$mAliases )
 303                 ;
 304         }
 305
 306         /**
 307          * Find the object with a given name and return it (or NULL)
 308          * @static
 309          * @param string $name
 310          */
 311         static function getPage( $name ) {
 312                 if ( !self::$mListInitialised ) {
 313                         self::initList();
 314                 }
 315                 if ( array_key_exists( $name, self::$mList ) ) {
 316                         $rec = self::$mList[$name];
 317                         if ( is_string( $rec ) ) {
 318                                 $className = $rec;
 319                                 self::$mList[$name] = new $className;
 320                         } elseif ( is_array( $rec ) ) {
 321                                 $className = array_shift( $rec );
 322                                 self::$mList[$name] = wfCreateObject( $className, $rec );
 323                         }
 324                         return self::$mList[$name];
 325                 } else {
 326                         return NULL;
 327                 }
 328         }
 329
 330         /**
 331          * Get a special page with a given localised name, or NULL if there
 332          * is no such special page.
 333          */
 334         static function getPageByAlias( $alias ) {
 335                 $realName = self::resolveAlias( $alias );
 336                 if ( $realName ) {
 337                         return self::getPage( $realName );
 338                 } else {
 339                         return NULL;
 340                 }
 341         }
 342
 343         /**
 344          * Return categorised listable special pages for all users
 345          * @static
 346          */
 347         static function getRegularPages() {
 348                 if ( !self::$mListInitialised ) {
 349                         self::initList();
 350                 }
 351                 $pages = array();
 352
 353                 foreach ( self::$mList as $name => $rec ) {
 354                         $page = self::getPage( $name );
 355                         if ( $page->isListed() && !$page->isRestricted() ) {
 356                                 $pages[$name] = $page;
 357                         }
 358                 }
 359                 return $pages;
 360         }
 361
 362         /**
 363          * Return categorised listable special pages which are available
 364          * for the current user, but not for everyone
 365          * @static
 366          */
 367         static function getRestrictedPages() {
 368                 global $wgUser;
 369                 if ( !self::$mListInitialised ) {
 370                         self::initList();
 371                 }
 372                 $pages = array();
 373
 374                 foreach ( self::$mList as $name => $rec ) {
 375                         $page = self::getPage( $name );
 376                         if (
 377                                 $page->isListed()
 378                                 and $page->isRestricted()
 379                                 and $page->userCanExecute( $wgUser )
 380                         ) {
 381                                 $pages[$name] = $page;
 382                         }
 383                 }
 384                 return $pages;
 385         }
 386
 387         /**
 388          * Execute a special page path.
 389          * The path     may contain parameters, e.g. Special:Name/Params
 390          * Extracts the special page name and call the execute method, passing the parameters
 391          *
 392          * Returns a title object if the page is redirected, false if there was no such special
 393          * page, and true if it was successful.
 394          *
 395          * @param $title          a title object
 396          * @param $including      output is being captured for use in {{special:whatever}}
 397          */
 398         static function executePath( &$title, $including = false ) {
 399                 global $wgOut, $wgTitle, $wgRequest;
 400                 wfProfileIn( __METHOD__ );
 401
 402                 # FIXME: redirects broken due to this call
 403                 $bits = explode( '/', $title->getDBkey(), 2 );
 404                 $name = $bits[0];
 405                 if( !isset( $bits[1] ) ) { // bug 2087
 406                         $par = NULL;
 407                 } else {
 408                         $par = $bits[1];
 409                 }
 410                 $page = SpecialPage::getPageByAlias( $name );
 411
 412                 # Nonexistent?
 413                 if ( !$page ) {
 414                         if ( !$including ) {
 415                                 $wgOut->setArticleRelated( false );
 416                                 $wgOut->setRobotpolicy( 'noindex,nofollow' );
 417                                 $wgOut->setStatusCode( 404 );
 418                                 $wgOut->showErrorPage( 'nosuchspecialpage', 'nospecialpagetext' );
 419                         }
 420                         wfProfileOut( __METHOD__ );
 421                         return false;
 422                 }
 423
 424                 # Check for redirect
 425                 if ( !$including ) {
 426                         $redirect = $page->getRedirect( $par );
 427                         if ( $redirect ) {
 428                                 $query = $page->getRedirectQuery();
 429                                 $url = $redirect->getFullUrl( $query );
 430                                 $wgOut->redirect( $url );
 431                                 wfProfileOut( __METHOD__ );
 432                                 return $redirect;
 433                         }
 434                 }
 435
 436                 # Redirect to canonical alias for GET commands
 437                 # Not for POST, we'd lose the post data, so it's best to just distribute
 438                 # the request. Such POST requests are possible for old extensions that
 439                 # generate self-links without being aware that their default name has
 440                 # changed.
 441                 if ( !$including && $name != $page->getLocalName() && !$wgRequest->wasPosted() ) {
 442                         $query = $_GET;
 443                         unset( $query['title'] );
 444                         $query = wfArrayToCGI( $query );
 445                         $title = $page->getTitle( $par );
 446                         $url = $title->getFullUrl( $query );
 447                         $wgOut->redirect( $url );
 448                         wfProfileOut( __METHOD__ );
 449                         return $redirect;
 450                 }
 451
 452                 if ( $including && !$page->includable() ) {
 453                         wfProfileOut( __METHOD__ );
 454                         return false;
 455                 } elseif ( !$including ) {
 456                         $wgTitle = $page->getTitle();
 457                 }
 458                 $page->including( $including );
 459
 460                 // Execute special page
 461                 $profName = 'Special:' . $page->getName();
 462                 wfProfileIn( $profName );
 463                 $page->execute( $par );
 464                 wfProfileOut( $profName );
 465                 wfProfileOut( __METHOD__ );
 466                 return true;
 467         }
 468
 469         /**
 470          * Just like executePath() except it returns the HTML instead of outputting it
 471          * Returns false if there was no such special page, or a title object if it was
 472          * a redirect.
 473          * @static
 474          */
 475         static function capturePath( &$title ) {
 476                 global $wgOut, $wgTitle;
 477
 478                 $oldTitle = $wgTitle;
 479                 $oldOut = $wgOut;
 480                 $wgOut = new OutputPage;
 481
 482                 $ret = SpecialPage::executePath( $title, true );
 483                 if ( $ret === true ) {
 484                         $ret = $wgOut->getHTML();
 485                 }
 486                 $wgTitle = $oldTitle;
 487                 $wgOut = $oldOut;
 488                 return $ret;
 489         }
 490
 491         /**
 492          * Get the local name for a specified canonical name
 493          *
 494          * @param $name
 495          * @param mixed $subpage Boolean false, or string
 496          *
 497          * @return string
 498          */
 499         static function getLocalNameFor( $name, $subpage = false ) {
 500                 global $wgContLang;
 501                 $aliases = $wgContLang->getSpecialPageAliases();
 502                 if ( isset( $aliases[$name][0] ) ) {
 503                         $name = $aliases[$name][0];
 504                 }
 505                 if ( $subpage !== false && !is_null( $subpage ) ) {
 506                         $name = "$name/$subpage";
 507                 }
 508                 return $name;
 509         }
 510
 511         /**
 512          * Get a localised Title object for a specified special page name
 513          */
 514         static function getTitleFor( $name, $subpage = false ) {
 515                 $name = self::getLocalNameFor( $name, $subpage );
 516                 if ( $name ) {
 517                         return Title::makeTitle( NS_SPECIAL, $name );
 518                 } else {
 519                         throw new MWException( "Invalid special page name \"$name\"" );
 520                 }
 521         }
 522
 523         /**
 524          * Get a localised Title object for a page name with a possibly unvalidated subpage
 525          */
 526         static function getSafeTitleFor( $name, $subpage = false ) {
 527                 $name = self::getLocalNameFor( $name, $subpage );
 528                 if ( $name ) {
 529                         return Title::makeTitleSafe( NS_SPECIAL, $name );
 530                 } else {
 531                         return null;
 532                 }
 533         }
 534
 535         /**
 536          * Get a title for a given alias
 537          * @return Title or null if there is no such alias
 538          */
 539         static function getTitleForAlias( $alias ) {
 540                 $name = self::resolveAlias( $alias );
 541                 if ( $name ) {
 542                         return self::getTitleFor( $name );
 543                 } else {
 544                         return null;
 545                 }
 546         }
 547
 548         /**
 549          * Default constructor for special pages
 550          * Derivative classes should call this from their constructor
 551          *     Note that if the user does not have the required level, an error message will
 552          *     be displayed by the default execute() method, without the global function ever
 553          *     being called.
 554          *
 555          *     If you override execute(), you can recover the default behaviour with userCanExecute()
 556          *     and displayRestrictionError()
 557          *
 558          * @param string $name Name of the special page, as seen in links and URLs
 559          * @param string $restriction User right required, e.g. "block" or "delete"
 560          * @param boolean $listed Whether the page is listed in Special:Specialpages
 561          * @param string $function Function called by execute(). By default it is constructed from $name
 562          * @param string $file File which is included by execute(). It is also constructed from $name by default
 563          */
 564         function SpecialPage( $name = '', $restriction = '', $listed = true, $function = false, $file = 'default', $includable = false ) {
 565                 $this->mName = $name;
 566                 $this->mRestriction = $restriction;
 567                 $this->mListed = $listed;
 568                 $this->mIncludable = $includable;
 569                 if ( $function == false ) {
 570                         $this->mFunction = 'wfSpecial'.$name;
 571                 } else {
 572                         $this->mFunction = $function;
 573                 }
 574                 if ( $file === 'default' ) {
 575                         $this->mFile = dirname(__FILE__) . "/Special{$name}.php";
 576                 } else {
 577                         $this->mFile = $file;
 578                 }
 579         }
 580
 581         /**#@+
 582           * Accessor
 583           *
 584           * @deprecated
 585           */
 586         function getName() { return $this->mName; }
 587         function getRestriction() { return $this->mRestriction; }
 588         function getFile() { return $this->mFile; }
 589         function isListed() { return $this->mListed; }
 590         /**#@-*/
 591
 592         /**#@+
 593           * Accessor and mutator
 594           */
 595         function name( $x = NULL ) { return wfSetVar( $this->mName, $x ); }
 596         function restrictions( $x = NULL) { return wfSetVar( $this->mRestrictions, $x ); }
 597         function listed( $x = NULL) { return wfSetVar( $this->mListed, $x ); }
 598         function func( $x = NULL) { return wfSetVar( $this->mFunction, $x ); }
 599         function file( $x = NULL) { return wfSetVar( $this->mFile, $x ); }
 600         function includable( $x = NULL ) { return wfSetVar( $this->mIncludable, $x ); }
 601         function including( $x = NULL ) { return wfSetVar( $this->mIncluding, $x ); }
 602         /**#@-*/
 603
 604         /**
 605          * Get the localised name of the special page
 606          */
 607         function getLocalName() {
 608                 if ( !isset( $this->mLocalName ) ) {
 609                         $this->mLocalName = self::getLocalNameFor( $this->mName );
 610                 }
 611                 return $this->mLocalName;
 612         }
 613
 614         /**
 615          * Can be overridden by subclasses with more complicated permissions
 616          * schemes.
 617          *
 618          * @return bool Should the page be displayed with the restricted-access
 619          *   pages?
 620          */
 621         public function isRestricted() {
 622                 return $this->mRestriction != '';
 623         }
 624
 625         /**
 626          * Checks if the given user (identified by an object) can execute this
 627          * special page (as defined by $mRestriction).  Can be overridden by sub-
 628          * classes with more complicated permissions schemes.
 629          *
 630          * @param User $user The user to check
 631          * @return bool Does the user have permission to view the page?
 632          */
 633         public function userCanExecute( &$user ) {
 634                 return $user->isAllowed( $this->mRestriction );
 635         }
 636
 637         /**
 638          * Output an error message telling the user what access level they have to have
 639          */
 640         function displayRestrictionError() {
 641                 global $wgOut;
 642                 $wgOut->permissionRequired( $this->mRestriction );
 643         }
 644
 645         /**
 646          * Sets headers - this should be called from the execute() method of all derived classes!
 647          */
 648         function setHeaders() {
 649                 global $wgOut;
 650                 $wgOut->setArticleRelated( false );
 651                 $wgOut->setRobotPolicy( "noindex,nofollow" );
 652                 $wgOut->setPageTitle( $this->getDescription() );
 653         }
 654
 655         /**
 656          * Default execute method
 657          * Checks user permissions, calls the function given in mFunction
 658          *
 659          * This may be overridden by subclasses.
 660          */
 661         function execute( $par ) {
 662                 global $wgUser;
 663
 664                 $this->setHeaders();
 665
 666                 if ( $this->userCanExecute( $wgUser ) ) {
 667                         $func = $this->mFunction;
 668                         // only load file if the function does not exist
 669                         if(!is_callable($func) and $this->mFile) {
 670                                 require_once( $this->mFile );
 671                         }
 672                         # FIXME: these hooks are broken for extensions and anything else that subclasses SpecialPage.
 673                         if ( wfRunHooks( 'SpecialPageExecuteBeforeHeader', array( &$this, &$par, &$func ) ) )
 674                                 $this->outputHeader();
 675                         if ( ! wfRunHooks( 'SpecialPageExecuteBeforePage', array( &$this, &$par, &$func ) ) )
 676                                 return;
 677                         call_user_func( $func, $par, $this );
 678                         if ( ! wfRunHooks( 'SpecialPageExecuteAfterPage', array( &$this, &$par, &$func ) ) )
 679                                 return;
 680                 } else {
 681                         $this->displayRestrictionError();
 682                 }
 683         }
 684
 685         function outputHeader() {
 686                 global $wgOut, $wgContLang;
 687
 688                 $msg = $wgContLang->lc( $this->name() ) . '-summary';
 689                 $out = wfMsg( $msg );
 690                 if ( ! wfEmptyMsg( $msg, $out ) and  $out !== '' and ! $this->including() )
 691                         $wgOut->addWikiText( $out );
 692
 693         }
 694
 695         # Returns the name that goes in the <h1> in the special page itself, and also the name that
 696         # will be listed in Special:Specialpages
 697         #
 698         # Derived classes can override this, but usually it is easier to keep the default behaviour.
 699         # Messages can be added at run-time, see MessageCache.php
 700         function getDescription() {
 701                 return wfMsg( strtolower( $this->mName ) );
 702         }
 703
 704         /**
 705          * Get a self-referential title object
 706          */
 707         function getTitle( $subpage = false) {
 708                 return self::getTitleFor( $this->mName, $subpage );
 709         }
 710
 711         /**
 712          * Set whether this page is listed in Special:Specialpages, at run-time
 713          */
 714         function setListed( $listed ) {
 715                 return wfSetVar( $this->mListed, $listed );
 716         }
 717
 718         /**
 719          * If the special page is a redirect, then get the Title object it redirects to.
 720          * False otherwise.
 721          */
 722         function getRedirect( $subpage ) {
 723                 return false;
 724         }
 725
 726         /**
 727          * Return part of the request string for a special redirect page
 728          * This allows passing, e.g. action=history to Special:Mypage, etc.
 729          *
 730          * @return string
 731          */
 732         function getRedirectQuery() {
 733                 global $wgRequest;
 734                 $params = array();
 735                 foreach( $this->mAllowedRedirectParams as $arg ) {
 736                         if( $val = $wgRequest->getVal( $arg, false ) )
 737                                 $params[] = $arg . '=' . $val;
 738                 }
 739
 740                 return count( $params ) ? implode( '&', $params ) : false;
 741         }
 742 }
 743
 744 /**
 745  * Shortcut to construct a special page which is unlisted by default
 746  * @addtogroup SpecialPage
 747  */
 748 class UnlistedSpecialPage extends SpecialPage
 749 {
 750         function UnlistedSpecialPage( $name, $restriction = '', $function = false, $file = 'default' ) {
 751                 SpecialPage::SpecialPage( $name, $restriction, false, $function, $file );
 752         }
 753 }
 754
 755 /**
 756  * Shortcut to construct an includable special  page
 757  * @addtogroup SpecialPage
 758  */
 759 class IncludableSpecialPage extends SpecialPage
 760 {
 761         function IncludableSpecialPage( $name, $restriction = '', $listed = true, $function = false, $file = 'default' ) {
 762                 SpecialPage::SpecialPage( $name, $restriction, $listed, $function, $file, true );
 763         }
 764 }
 765
 766 /**
 767  * Shortcut to construct a special page alias.
 768  * @addtogroup SpecialPage
 769  */
 770 class SpecialRedirectToSpecial extends UnlistedSpecialPage {
 771         var $redirName, $redirSubpage;
 772
 773         function __construct( $name, $redirName, $redirSubpage = false, $redirectParams = array() ) {
 774                 parent::__construct( $name );
 775                 $this->redirName = $redirName;
 776                 $this->redirSubpage = $redirSubpage;
 777                 $this->mAllowedRedirectParams = $redirectParams;
 778         }
 779
 780         function getRedirect( $subpage ) {
 781                 if ( $this->redirSubpage === false ) {
 782                         return SpecialPage::getTitleFor( $this->redirName, $subpage );
 783                 } else {
 784                         return SpecialPage::getTitleFor( $this->redirName, $this->redirSubpage );
 785                 }
 786         }
 787 }
 788
 789 /** SpecialMypage, SpecialMytalk and SpecialMycontributions special pages
 790  * are used to get user independant links pointing to the user page, talk
 791  * page and list of contributions.
 792  * This can let us cache a single copy of any generated content for all
 793  * users.
 794  */
 795
 796 /**
 797  * Shortcut to construct a special page pointing to current user user's page.
 798  * @addtogroup SpecialPage
 799  */
 800 class SpecialMypage extends UnlistedSpecialPage {
 801         function __construct() {
 802                 parent::__construct( 'Mypage' );
 803                 $this->mAllowedRedirectParams = array( 'action' , 'preload' , 'editintro' );
 804         }
 805
 806         function getRedirect( $subpage ) {
 807                 global $wgUser;
 808                 if ( strval( $subpage ) !== '' ) {
 809                         return Title::makeTitle( NS_USER, $wgUser->getName() . '/' . $subpage );
 810                 } else {
 811                         return Title::makeTitle( NS_USER, $wgUser->getName() );
 812                 }
 813         }
 814 }
 815
 816 /**
 817  * Shortcut to construct a special page pointing to current user talk page.
 818  * @addtogroup SpecialPage
 819  */
 820 class SpecialMytalk extends UnlistedSpecialPage {
 821         function __construct() {
 822                 parent::__construct( 'Mytalk' );
 823                 $this->mAllowedRedirectParams = array( 'action' , 'preload' , 'editintro' );
 824         }
 825
 826         function getRedirect( $subpage ) {
 827                 global $wgUser;
 828                 if ( strval( $subpage ) !== '' ) {
 829                         return Title::makeTitle( NS_USER_TALK, $wgUser->getName() . '/' . $subpage );
 830                 } else {
 831                         return Title::makeTitle( NS_USER_TALK, $wgUser->getName() );
 832                 }
 833         }
 834 }
 835
 836 /**
 837  * Shortcut to construct a special page pointing to current user contributions.
 838  * @addtogroup SpecialPage
 839  */
 840 class SpecialMycontributions extends UnlistedSpecialPage {
 841         function __construct() {
 842                 parent::__construct(  'Mycontributions' );
 843         }
 844
 845         function getRedirect( $subpage ) {
 846                 global $wgUser;
 847                 return SpecialPage::getTitleFor( 'Contributions', $wgUser->getName() );
 848         }
 849 }