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'                => array( 'SpecialPage', 'Userrights', 'userrights' ),
 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->getRestriction() == '' ) {
 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 ( $page->isListed() ) {
 377                                 $restriction = $page->getRestriction();
 378                                 if ( $restriction != '' && $wgUser->isAllowed( $restriction ) ) {
 379                                         $pages[$name] = $page;
 380                                 }
 381                         }
 382                 }
 383                 return $pages;
 384         }
 385
 386         /**
 387          * Execute a special page path.
 388          * The path     may contain parameters, e.g. Special:Name/Params
 389          * Extracts the special page name and call the execute method, passing the parameters
 390          *
 391          * Returns a title object if the page is redirected, false if there was no such special
 392          * page, and true if it was successful.
 393          *
 394          * @param $title          a title object
 395          * @param $including      output is being captured for use in {{special:whatever}}
 396          */
 397         static function executePath( &$title, $including = false ) {
 398                 global $wgOut, $wgTitle, $wgRequest;
 399                 wfProfileIn( __METHOD__ );
 400
 401                 # FIXME: redirects broken due to this call
 402                 $bits = explode( '/', $title->getDBkey(), 2 );
 403                 $name = $bits[0];
 404                 if( !isset( $bits[1] ) ) { // bug 2087
 405                         $par = NULL;
 406                 } else {
 407                         $par = $bits[1];
 408                 }
 409                 $page = SpecialPage::getPageByAlias( $name );
 410
 411                 # Nonexistent?
 412                 if ( !$page ) {
 413                         if ( !$including ) {
 414                                 $wgOut->setArticleRelated( false );
 415                                 $wgOut->setRobotpolicy( 'noindex,nofollow' );
 416                                 $wgOut->setStatusCode( 404 );
 417                                 $wgOut->showErrorPage( 'nosuchspecialpage', 'nospecialpagetext' );
 418                         }
 419                         wfProfileOut( __METHOD__ );
 420                         return false;
 421                 }
 422
 423                 # Check for redirect
 424                 if ( !$including ) {
 425                         $redirect = $page->getRedirect( $par );
 426                         if ( $redirect ) {
 427                                 $query = $page->getRedirectQuery();
 428                                 $url = $redirect->getFullUrl( $query );
 429                                 $wgOut->redirect( $url );
 430                                 wfProfileOut( __METHOD__ );
 431                                 return $redirect;
 432                         }
 433                 }
 434
 435                 # Redirect to canonical alias for GET commands
 436                 # Not for POST, we'd lose the post data, so it's best to just distribute
 437                 # the request. Such POST requests are possible for old extensions that
 438                 # generate self-links without being aware that their default name has
 439                 # changed.
 440                 if ( !$including && $name != $page->getLocalName() && !$wgRequest->wasPosted() ) {
 441                         $query = $_GET;
 442                         unset( $query['title'] );
 443                         $query = wfArrayToCGI( $query );
 444                         $title = $page->getTitle( $par );
 445                         $url = $title->getFullUrl( $query );
 446                         $wgOut->redirect( $url );
 447                         wfProfileOut( __METHOD__ );
 448                         return $redirect;
 449                 }
 450
 451                 if ( $including && !$page->includable() ) {
 452                         wfProfileOut( __METHOD__ );
 453                         return false;
 454                 } elseif ( !$including ) {
 455                         $wgTitle = $page->getTitle();
 456                 }
 457                 $page->including( $including );
 458
 459                 // Execute special page
 460                 $profName = 'Special:' . $page->getName();
 461                 wfProfileIn( $profName );
 462                 $page->execute( $par );
 463                 wfProfileOut( $profName );
 464                 wfProfileOut( __METHOD__ );
 465                 return true;
 466         }
 467
 468         /**
 469          * Just like executePath() except it returns the HTML instead of outputting it
 470          * Returns false if there was no such special page, or a title object if it was
 471          * a redirect.
 472          * @static
 473          */
 474         static function capturePath( &$title ) {
 475                 global $wgOut, $wgTitle;
 476
 477                 $oldTitle = $wgTitle;
 478                 $oldOut = $wgOut;
 479                 $wgOut = new OutputPage;
 480
 481                 $ret = SpecialPage::executePath( $title, true );
 482                 if ( $ret === true ) {
 483                         $ret = $wgOut->getHTML();
 484                 }
 485                 $wgTitle = $oldTitle;
 486                 $wgOut = $oldOut;
 487                 return $ret;
 488         }
 489
 490         /**
 491          * Get the local name for a specified canonical name
 492          *
 493          * @param $name
 494          * @param mixed $subpage Boolean false, or string
 495          *
 496          * @return string
 497          */
 498         static function getLocalNameFor( $name, $subpage = false ) {
 499                 global $wgContLang;
 500                 $aliases = $wgContLang->getSpecialPageAliases();
 501                 if ( isset( $aliases[$name][0] ) ) {
 502                         $name = $aliases[$name][0];
 503                 }
 504                 if ( $subpage !== false && !is_null( $subpage ) ) {
 505                         $name = "$name/$subpage";
 506                 }
 507                 return $name;
 508         }
 509
 510         /**
 511          * Get a localised Title object for a specified special page name
 512          */
 513         static function getTitleFor( $name, $subpage = false ) {
 514                 $name = self::getLocalNameFor( $name, $subpage );
 515                 if ( $name ) {
 516                         return Title::makeTitle( NS_SPECIAL, $name );
 517                 } else {
 518                         throw new MWException( "Invalid special page name \"$name\"" );
 519                 }
 520         }
 521
 522         /**
 523          * Get a localised Title object for a page name with a possibly unvalidated subpage
 524          */
 525         static function getSafeTitleFor( $name, $subpage = false ) {
 526                 $name = self::getLocalNameFor( $name, $subpage );
 527                 if ( $name ) {
 528                         return Title::makeTitleSafe( NS_SPECIAL, $name );
 529                 } else {
 530                         return null;
 531                 }
 532         }
 533
 534         /**
 535          * Get a title for a given alias
 536          * @return Title or null if there is no such alias
 537          */
 538         static function getTitleForAlias( $alias ) {
 539                 $name = self::resolveAlias( $alias );
 540                 if ( $name ) {
 541                         return self::getTitleFor( $name );
 542                 } else {
 543                         return null;
 544                 }
 545         }
 546
 547         /**
 548          * Default constructor for special pages
 549          * Derivative classes should call this from their constructor
 550          *     Note that if the user does not have the required level, an error message will
 551          *     be displayed by the default execute() method, without the global function ever
 552          *     being called.
 553          *
 554          *     If you override execute(), you can recover the default behaviour with userCanExecute()
 555          *     and displayRestrictionError()
 556          *
 557          * @param string $name Name of the special page, as seen in links and URLs
 558          * @param string $restriction User right required, e.g. "block" or "delete"
 559          * @param boolean $listed Whether the page is listed in Special:Specialpages
 560          * @param string $function Function called by execute(). By default it is constructed from $name
 561          * @param string $file File which is included by execute(). It is also constructed from $name by default
 562          */
 563         function SpecialPage( $name = '', $restriction = '', $listed = true, $function = false, $file = 'default', $includable = false ) {
 564                 $this->mName = $name;
 565                 $this->mRestriction = $restriction;
 566                 $this->mListed = $listed;
 567                 $this->mIncludable = $includable;
 568                 if ( $function == false ) {
 569                         $this->mFunction = 'wfSpecial'.$name;
 570                 } else {
 571                         $this->mFunction = $function;
 572                 }
 573                 if ( $file === 'default' ) {
 574                         $this->mFile = dirname(__FILE__) . "/Special{$name}.php";
 575                 } else {
 576                         $this->mFile = $file;
 577                 }
 578         }
 579
 580         /**#@+
 581           * Accessor
 582           *
 583           * @deprecated
 584           */
 585         function getName() { return $this->mName; }
 586         function getRestriction() { return $this->mRestriction; }
 587         function getFile() { return $this->mFile; }
 588         function isListed() { return $this->mListed; }
 589         /**#@-*/
 590
 591         /**#@+
 592           * Accessor and mutator
 593           */
 594         function name( $x = NULL ) { return wfSetVar( $this->mName, $x ); }
 595         function restrictions( $x = NULL) { return wfSetVar( $this->mRestrictions, $x ); }
 596         function listed( $x = NULL) { return wfSetVar( $this->mListed, $x ); }
 597         function func( $x = NULL) { return wfSetVar( $this->mFunction, $x ); }
 598         function file( $x = NULL) { return wfSetVar( $this->mFile, $x ); }
 599         function includable( $x = NULL ) { return wfSetVar( $this->mIncludable, $x ); }
 600         function including( $x = NULL ) { return wfSetVar( $this->mIncluding, $x ); }
 601         /**#@-*/
 602
 603         /**
 604          * Get the localised name of the special page
 605          */
 606         function getLocalName() {
 607                 if ( !isset( $this->mLocalName ) ) {
 608                         $this->mLocalName = self::getLocalNameFor( $this->mName );
 609                 }
 610                 return $this->mLocalName;
 611         }
 612
 613         /**
 614          * Checks if the given user (identified by an object) can execute this
 615          * special page (as defined by $mRestriction)
 616          */
 617         function userCanExecute( &$user ) {
 618                 return $user->isAllowed( $this->mRestriction );
 619         }
 620
 621         /**
 622          * Output an error message telling the user what access level they have to have
 623          */
 624         function displayRestrictionError() {
 625                 global $wgOut;
 626                 $wgOut->permissionRequired( $this->mRestriction );
 627         }
 628
 629         /**
 630          * Sets headers - this should be called from the execute() method of all derived classes!
 631          */
 632         function setHeaders() {
 633                 global $wgOut;
 634                 $wgOut->setArticleRelated( false );
 635                 $wgOut->setRobotPolicy( "noindex,nofollow" );
 636                 $wgOut->setPageTitle( $this->getDescription() );
 637         }
 638
 639         /**
 640          * Default execute method
 641          * Checks user permissions, calls the function given in mFunction
 642          *
 643          * This may be overridden by subclasses.
 644          */
 645         function execute( $par ) {
 646                 global $wgUser;
 647
 648                 $this->setHeaders();
 649
 650                 if ( $this->userCanExecute( $wgUser ) ) {
 651                         $func = $this->mFunction;
 652                         // only load file if the function does not exist
 653                         if(!is_callable($func) and $this->mFile) {
 654                                 require_once( $this->mFile );
 655                         }
 656                         # FIXME: these hooks are broken for extensions and anything else that subclasses SpecialPage.
 657                         if ( wfRunHooks( 'SpecialPageExecuteBeforeHeader', array( &$this, &$par, &$func ) ) )
 658                                 $this->outputHeader();
 659                         if ( ! wfRunHooks( 'SpecialPageExecuteBeforePage', array( &$this, &$par, &$func ) ) )
 660                                 return;
 661                         call_user_func( $func, $par, $this );
 662                         if ( ! wfRunHooks( 'SpecialPageExecuteAfterPage', array( &$this, &$par, &$func ) ) )
 663                                 return;
 664                 } else {
 665                         $this->displayRestrictionError();
 666                 }
 667         }
 668
 669         function outputHeader() {
 670                 global $wgOut, $wgContLang;
 671
 672                 $msg = $wgContLang->lc( $this->name() ) . '-summary';
 673                 $out = wfMsg( $msg );
 674                 if ( ! wfEmptyMsg( $msg, $out ) and  $out !== '' and ! $this->including() )
 675                         $wgOut->addWikiText( $out );
 676
 677         }
 678
 679         # Returns the name that goes in the <h1> in the special page itself, and also the name that
 680         # will be listed in Special:Specialpages
 681         #
 682         # Derived classes can override this, but usually it is easier to keep the default behaviour.
 683         # Messages can be added at run-time, see MessageCache.php
 684         function getDescription() {
 685                 return wfMsg( strtolower( $this->mName ) );
 686         }
 687
 688         /**
 689          * Get a self-referential title object
 690          */
 691         function getTitle( $subpage = false) {
 692                 return self::getTitleFor( $this->mName, $subpage );
 693         }
 694
 695         /**
 696          * Set whether this page is listed in Special:Specialpages, at run-time
 697          */
 698         function setListed( $listed ) {
 699                 return wfSetVar( $this->mListed, $listed );
 700         }
 701
 702         /**
 703          * If the special page is a redirect, then get the Title object it redirects to.
 704          * False otherwise.
 705          */
 706         function getRedirect( $subpage ) {
 707                 return false;
 708         }
 709
 710         /**
 711          * Return part of the request string for a special redirect page
 712          * This allows passing, e.g. action=history to Special:Mypage, etc.
 713          *
 714          * @return string
 715          */
 716         function getRedirectQuery() {
 717                 global $wgRequest;
 718                 $params = array();
 719                 foreach( $this->mAllowedRedirectParams as $arg ) {
 720                         if( $val = $wgRequest->getVal( $arg, false ) )
 721                                 $params[] = $arg . '=' . $val;
 722                 }
 723
 724                 return count( $params ) ? implode( '&', $params ) : false;
 725         }
 726 }
 727
 728 /**
 729  * Shortcut to construct a special page which is unlisted by default
 730  * @addtogroup SpecialPage
 731  */
 732 class UnlistedSpecialPage extends SpecialPage
 733 {
 734         function UnlistedSpecialPage( $name, $restriction = '', $function = false, $file = 'default' ) {
 735                 SpecialPage::SpecialPage( $name, $restriction, false, $function, $file );
 736         }
 737 }
 738
 739 /**
 740  * Shortcut to construct an includable special  page
 741  * @addtogroup SpecialPage
 742  */
 743 class IncludableSpecialPage extends SpecialPage
 744 {
 745         function IncludableSpecialPage( $name, $restriction = '', $listed = true, $function = false, $file = 'default' ) {
 746                 SpecialPage::SpecialPage( $name, $restriction, $listed, $function, $file, true );
 747         }
 748 }
 749
 750 /**
 751  * Shortcut to construct a special page alias.
 752  * @addtogroup SpecialPage
 753  */
 754 class SpecialRedirectToSpecial extends UnlistedSpecialPage {
 755         var $redirName, $redirSubpage;
 756
 757         function __construct( $name, $redirName, $redirSubpage = false, $redirectParams = array() ) {
 758                 parent::__construct( $name );
 759                 $this->redirName = $redirName;
 760                 $this->redirSubpage = $redirSubpage;
 761                 $this->mAllowedRedirectParams = $redirectParams;
 762         }
 763
 764         function getRedirect( $subpage ) {
 765                 if ( $this->redirSubpage === false ) {
 766                         return SpecialPage::getTitleFor( $this->redirName, $subpage );
 767                 } else {
 768                         return SpecialPage::getTitleFor( $this->redirName, $this->redirSubpage );
 769                 }
 770         }
 771 }
 772
 773 /** SpecialMypage, SpecialMytalk and SpecialMycontributions special pages
 774  * are used to get user independant links pointing to the user page, talk
 775  * page and list of contributions.
 776  * This can let us cache a single copy of any generated content for all
 777  * users.
 778  */
 779
 780 /**
 781  * Shortcut to construct a special page pointing to current user user's page.
 782  * @addtogroup SpecialPage
 783  */
 784 class SpecialMypage extends UnlistedSpecialPage {
 785         function __construct() {
 786                 parent::__construct( 'Mypage' );
 787                 $this->mAllowedRedirectParams = array( 'action' , 'preload' , 'editintro' );
 788         }
 789
 790         function getRedirect( $subpage ) {
 791                 global $wgUser;
 792                 if ( strval( $subpage ) !== '' ) {
 793                         return Title::makeTitle( NS_USER, $wgUser->getName() . '/' . $subpage );
 794                 } else {
 795                         return Title::makeTitle( NS_USER, $wgUser->getName() );
 796                 }
 797         }
 798 }
 799
 800 /**
 801  * Shortcut to construct a special page pointing to current user talk page.
 802  * @addtogroup SpecialPage
 803  */
 804 class SpecialMytalk extends UnlistedSpecialPage {
 805         function __construct() {
 806                 parent::__construct( 'Mytalk' );
 807                 $this->mAllowedRedirectParams = array( 'action' , 'preload' , 'editintro' );
 808         }
 809
 810         function getRedirect( $subpage ) {
 811                 global $wgUser;
 812                 if ( strval( $subpage ) !== '' ) {
 813                         return Title::makeTitle( NS_USER_TALK, $wgUser->getName() . '/' . $subpage );
 814                 } else {
 815                         return Title::makeTitle( NS_USER_TALK, $wgUser->getName() );
 816                 }
 817         }
 818 }
 819
 820 /**
 821  * Shortcut to construct a special page pointing to current user contributions.
 822  * @addtogroup SpecialPage
 823  */
 824 class SpecialMycontributions extends UnlistedSpecialPage {
 825         function __construct() {
 826                 parent::__construct(  'Mycontributions' );
 827         }
 828
 829         function getRedirect( $subpage ) {
 830                 global $wgUser;
 831                 return SpecialPage::getTitleFor( 'Contributions', $wgUser->getName() );
 832         }
 833 }