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  * @file
  21  * @ingroup SpecialPage
  22  * @defgroup SpecialPage SpecialPage
  23  */
  24
  25 /**
  26  * Parent special page class, also static functions for handling the special
  27  * page list.
  28  * @ingroup SpecialPage
  29  */
  30 class SpecialPage {
  31         /**#@+
  32          * @access private
  33          */
  34         /**
  35          * The canonical name of this special page
  36          * Also used for the default <h1> heading, @see getDescription()
  37          */
  38         var $mName;
  39         /**
  40          * The local name of this special page
  41          */
  42         var $mLocalName;
  43         /**
  44          * Minimum user level required to access this page, or "" for anyone.
  45          * Also used to categorise the pages in Special:Specialpages
  46          */
  47         var $mRestriction;
  48         /**
  49          * Listed in Special:Specialpages?
  50          */
  51         var $mListed;
  52         /**
  53          * Function name called by the default execute()
  54          */
  55         var $mFunction;
  56         /**
  57          * File which needs to be included before the function above can be called
  58          */
  59         var $mFile;
  60         /**
  61          * Whether or not this special page is being included from an article
  62          */
  63         var $mIncluding;
  64         /**
  65          * Whether the special page can be included in an article
  66          */
  67         var $mIncludable;
  68         /**
  69          * Query parameters that can be passed through redirects
  70          */
  71         var $mAllowedRedirectParams = array();
  72         /**
  73          * Query parameteres added by redirects
  74          */
  75         var $mAddedRedirectParams = array();
  76         /**
  77          * Current request context
  78          * @var RequestContext
  79          */
  80         protected $mContext;
  81
  82         /**
  83          * List of special pages, followed by parameters.
  84          * If the only parameter is a string, that is the page name.
  85          * Otherwise, it is an array. The format is one of:
  86          ** array( 'SpecialPage', name, right )
  87          ** array( 'IncludableSpecialPage', name, right, listed? )
  88          ** array( 'UnlistedSpecialPage', name, right )
  89          ** array( 'SpecialRedirectToSpecial', name, page to redirect to, special page param, ... )
  90          */
  91         static public $mList = array(
  92                 # Maintenance Reports
  93                 'BrokenRedirects'           => 'BrokenRedirectsPage',
  94                 'Deadendpages'              => 'DeadendpagesPage',
  95                 'DoubleRedirects'           => 'DoubleRedirectsPage',
  96                 'Longpages'                 => 'LongpagesPage',
  97                 'Ancientpages'              => 'AncientpagesPage',
  98                 'Lonelypages'               => 'LonelypagesPage',
  99                 'Fewestrevisions'           => 'FewestrevisionsPage',
 100                 'Withoutinterwiki'          => 'WithoutinterwikiPage',
 101                 'Protectedpages'            => 'SpecialProtectedpages',
 102                 'Protectedtitles'           => 'SpecialProtectedtitles',
 103                 'Shortpages'                => 'ShortpagesPage',
 104                 'Uncategorizedcategories'   => 'UncategorizedcategoriesPage',
 105                 'Uncategorizedimages'       => 'UncategorizedimagesPage',
 106                 'Uncategorizedpages'        => 'UncategorizedpagesPage',
 107                 'Uncategorizedtemplates'    => 'UncategorizedtemplatesPage',
 108                 'Unusedcategories'          => 'UnusedcategoriesPage',
 109                 'Unusedimages'              => 'UnusedimagesPage',
 110                 'Unusedtemplates'           => 'UnusedtemplatesPage',
 111                 'Unwatchedpages'            => 'UnwatchedpagesPage',
 112                 'Wantedcategories'          => 'WantedcategoriesPage',
 113                 'Wantedfiles'               => 'WantedfilesPage',
 114                 'Wantedpages'               => 'WantedpagesPage',
 115                 'Wantedtemplates'           => 'WantedtemplatesPage',
 116
 117                 # List of pages
 118                 'Allpages'                  => 'SpecialAllpages',
 119                 'Prefixindex'               => 'SpecialPrefixindex',
 120                 'Categories'                => 'SpecialCategories',
 121                 'Disambiguations'           => 'DisambiguationsPage',
 122                 'Listredirects'             => 'ListredirectsPage',
 123
 124                 # Login/create account
 125                 'Userlogin'                 => 'LoginForm',
 126                 'CreateAccount'             => array( 'SpecialRedirectToSpecial', 'CreateAccount', 'Userlogin', 'signup', array( 'uselang' ) ),
 127
 128                 # Users and rights
 129                 'Block'                     => 'SpecialBlock',
 130                 'Unblock'                   => 'SpecialUnblock',
 131                 'BlockList'                 => 'SpecialBlockList',
 132                 'Resetpass'                 => 'SpecialResetpass',
 133                 'DeletedContributions'      => 'DeletedContributionsPage',
 134                 'Preferences'               => 'SpecialPreferences',
 135                 'Contributions'             => 'SpecialContributions',
 136                 'Listgrouprights'           => 'SpecialListGroupRights',
 137                 'Listusers'                 => 'SpecialListusers',
 138                 'Listadmins'                => array( 'SpecialRedirectToSpecial', 'Listadmins', 'Listusers', 'sysop' ),
 139                 'Listbots'                  => array( 'SpecialRedirectToSpecial', 'Listbots', 'Listusers', 'bot' ),
 140                 'Activeusers'               => 'SpecialActiveUsers',
 141                 'Userrights'                => 'UserrightsPage',
 142                 'DisableAccount'            => 'SpecialDisableAccount',
 143                 'EditWatchlist'             => 'SpecialEditWatchlist',
 144
 145                 # Recent changes and logs
 146                 'Newimages'                 => 'SpecialNewFiles',
 147                 'Log'                       => 'SpecialLog',
 148                 'Watchlist'                 => 'SpecialWatchlist',
 149                 'Newpages'                  => 'SpecialNewpages',
 150                 'Recentchanges'             => 'SpecialRecentchanges',
 151                 'Recentchangeslinked'       => 'SpecialRecentchangeslinked',
 152                 'Tags'                      => 'SpecialTags',
 153
 154                 # Media reports and uploads
 155                 'Listfiles'                 => 'SpecialListFiles',
 156                 'Filepath'                  => 'SpecialFilepath',
 157                 'MIMEsearch'                => 'MIMEsearchPage',
 158                 'FileDuplicateSearch'       => 'FileDuplicateSearchPage',
 159                 'Upload'                    => 'SpecialUpload',
 160                 'UploadStash'               => 'SpecialUploadStash',
 161
 162                 # Wiki data and tools
 163                 'Statistics'                => 'SpecialStatistics',
 164                 'Allmessages'               => 'SpecialAllmessages',
 165                 'Version'                   => 'SpecialVersion',
 166                 'Lockdb'                    => 'SpecialLockdb',
 167                 'Unlockdb'                  => 'SpecialUnlockdb',
 168
 169                 # Redirecting special pages
 170                 'LinkSearch'                => 'LinkSearchPage',
 171                 'Randompage'                => 'Randompage',
 172                 'Randomredirect'            => 'SpecialRandomredirect',
 173
 174                 # High use pages
 175                 'Mostlinkedcategories'      => 'MostlinkedCategoriesPage',
 176                 'Mostimages'                => 'MostimagesPage',
 177                 'Mostlinked'                => 'MostlinkedPage',
 178                 'Mostlinkedtemplates'       => 'MostlinkedTemplatesPage',
 179                 'Mostcategories'            => 'MostcategoriesPage',
 180                 'Mostrevisions'             => 'MostrevisionsPage',
 181
 182                 # Page tools
 183                 'ComparePages'              => 'SpecialComparePages',
 184                 'Export'                    => 'SpecialExport',
 185                 'Import'                    => 'SpecialImport',
 186                 'Undelete'                  => 'SpecialUndelete',
 187                 'Whatlinkshere'             => 'SpecialWhatlinkshere',
 188                 'MergeHistory'              => 'SpecialMergeHistory',
 189
 190                 # Other
 191                 'Booksources'               => 'SpecialBookSources',
 192
 193                 # Unlisted / redirects
 194                 'Blankpage'                 => 'SpecialBlankpage',
 195                 'Blockme'                   => 'SpecialBlockme',
 196                 'Emailuser'                 => 'SpecialEmailUser',
 197                 'Movepage'                  => 'MovePageForm',
 198                 'Mycontributions'           => 'SpecialMycontributions',
 199                 'Mypage'                    => 'SpecialMypage',
 200                 'Mytalk'                    => 'SpecialMytalk',
 201                 'Myuploads'                 => 'SpecialMyuploads',
 202                 'PermanentLink'             => 'SpecialPermanentLink',
 203                 'Revisiondelete'            => 'SpecialRevisionDelete',
 204                 'RevisionMove'              => 'SpecialRevisionMove',
 205                 'Specialpages'              => 'SpecialSpecialpages',
 206                 'Userlogout'                => 'SpecialUserlogout',
 207         );
 208
 209         static public $mAliases;
 210         static public $mListInitialised = false;
 211
 212         /**#@-*/
 213
 214         /**
 215          * Initialise the special page list
 216          * This must be called before accessing SpecialPage::$mList
 217          */
 218         static function initList() {
 219                 global $wgSpecialPages;
 220                 global $wgDisableCounters, $wgDisableInternalSearch, $wgEmailAuthentication;
 221
 222                 if ( self::$mListInitialised ) {
 223                         return;
 224                 }
 225                 wfProfileIn( __METHOD__ );
 226
 227                 # Better to set this now, to avoid infinite recursion in carelessly written hooks
 228                 self::$mListInitialised = true;
 229
 230                 if( !$wgDisableCounters ) {
 231                         self::$mList['Popularpages'] = 'PopularpagesPage';
 232                 }
 233
 234                 if( !$wgDisableInternalSearch ) {
 235                         self::$mList['Search'] = 'SpecialSearch';
 236                 }
 237
 238                 if( $wgEmailAuthentication ) {
 239                         self::$mList['Confirmemail'] = 'EmailConfirmation';
 240                         self::$mList['Invalidateemail'] = 'EmailInvalidation';
 241                 }
 242
 243                 # Add extension special pages
 244                 self::$mList = array_merge( self::$mList, $wgSpecialPages );
 245
 246                 # Run hooks
 247                 # This hook can be used to remove undesired built-in special pages
 248                 wfRunHooks( 'SpecialPage_initList', array( &self::$mList ) );
 249                 wfProfileOut( __METHOD__ );
 250         }
 251
 252         static function initAliasList() {
 253                 if ( !is_null( self::$mAliases ) ) {
 254                         return;
 255                 }
 256
 257                 global $wgContLang;
 258                 $aliases = $wgContLang->getSpecialPageAliases();
 259                 $missingPages = self::$mList;
 260                 self::$mAliases = array();
 261                 foreach ( $aliases as $realName => $aliasList ) {
 262                         foreach ( $aliasList as $alias ) {
 263                                 self::$mAliases[$wgContLang->caseFold( $alias )] = $realName;
 264                         }
 265                         unset( $missingPages[$realName] );
 266                 }
 267                 foreach ( $missingPages as $name => $stuff ) {
 268                         self::$mAliases[$wgContLang->caseFold( $name )] = $name;
 269                 }
 270         }
 271
 272         /**
 273          * Given a special page alias, return the special page name.
 274          * Returns false if there is no such alias.
 275          *
 276          * @param $alias String
 277          * @return String or false
 278          */
 279         static function resolveAlias( $alias ) {
 280                 global $wgContLang;
 281
 282                 if ( !self::$mListInitialised ) self::initList();
 283                 if ( is_null( self::$mAliases ) ) self::initAliasList();
 284                 $caseFoldedAlias = $wgContLang->caseFold( $alias );
 285                 $caseFoldedAlias = str_replace( ' ', '_', $caseFoldedAlias );
 286                 if ( isset( self::$mAliases[$caseFoldedAlias] ) ) {
 287                         return self::$mAliases[$caseFoldedAlias];
 288                 } else {
 289                         return false;
 290                 }
 291         }
 292
 293         /**
 294          * Given a special page name with a possible subpage, return an array
 295          * where the first element is the special page name and the second is the
 296          * subpage.
 297          *
 298          * @param $alias String
 299          * @return Array
 300          */
 301         static function resolveAliasWithSubpage( $alias ) {
 302                 $bits = explode( '/', $alias, 2 );
 303                 $name = self::resolveAlias( $bits[0] );
 304                 if( !isset( $bits[1] ) ) { // bug 2087
 305                         $par = null;
 306                 } else {
 307                         $par = $bits[1];
 308                 }
 309                 return array( $name, $par );
 310         }
 311
 312         /**
 313          * Add a page to the list of valid special pages. This used to be the preferred
 314          * method for adding special pages in extensions. It's now suggested that you add
 315          * an associative record to $wgSpecialPages. This avoids autoloading SpecialPage.
 316          *
 317          * @param $page SpecialPage
 318          * Deprecated in 1.7, warnings in 1.17, might be removed in 1.20
 319          */
 320         static function addPage( &$page ) {
 321                 wfDeprecated( __METHOD__ );
 322                 if ( !self::$mListInitialised ) {
 323                         self::initList();
 324                 }
 325                 self::$mList[$page->mName] = $page;
 326         }
 327
 328         /**
 329          * Add a page to a certain display group for Special:SpecialPages
 330          *
 331          * @param $page Mixed: SpecialPage or string
 332          * @param $group String
 333          */
 334         static function setGroup( $page, $group ) {
 335                 global $wgSpecialPageGroups;
 336                 $name = is_object($page) ? $page->mName : $page;
 337                 $wgSpecialPageGroups[$name] = $group;
 338         }
 339
 340         /**
 341          * Add a page to a certain display group for Special:SpecialPages
 342          *
 343          * @param $page SpecialPage
 344          */
 345         static function getGroup( &$page ) {
 346                 global $wgSpecialPageGroups;
 347                 static $specialPageGroupsCache = array();
 348                 if( isset($specialPageGroupsCache[$page->mName]) ) {
 349                         return $specialPageGroupsCache[$page->mName];
 350                 }
 351                 $msg = wfMessage('specialpages-specialpagegroup-'.strtolower($page->mName));
 352                 if ( !$msg->isBlank() ) {
 353                         $group = $msg->text();
 354                 } else {
 355                         $group = isset($wgSpecialPageGroups[$page->mName])
 356                                 ? $wgSpecialPageGroups[$page->mName]
 357                                 : '-';
 358                 }
 359                 if( $group == '-' ) $group = 'other';
 360                 $specialPageGroupsCache[$page->mName] = $group;
 361                 return $group;
 362         }
 363
 364         /**
 365          * Remove a special page from the list
 366          * Formerly used to disable expensive or dangerous special pages. The
 367          * preferred method is now to add a SpecialPage_initList hook.
 368          */
 369         static function removePage( $name ) {
 370                 if ( !self::$mListInitialised ) {
 371                         self::initList();
 372                 }
 373                 unset( self::$mList[$name] );
 374         }
 375
 376         /**
 377          * Check if a given name exist as a special page or as a special page alias
 378          *
 379          * @param $name String: name of a special page
 380          * @return Boolean: true if a special page exists with this name
 381          */
 382         static function exists( $name ) {
 383                 global $wgContLang;
 384                 if ( !self::$mListInitialised ) {
 385                         self::initList();
 386                 }
 387                 if( !self::$mAliases ) {
 388                         self::initAliasList();
 389                 }
 390
 391                 # Remove special pages inline parameters:
 392                 $bits = explode( '/', $name );
 393                 $name = $wgContLang->caseFold($bits[0]);
 394
 395                 return
 396                         array_key_exists( $name, self::$mList )
 397                         or array_key_exists( $name, self::$mAliases )
 398                 ;
 399         }
 400
 401         /**
 402          * Find the object with a given name and return it (or NULL)
 403          *
 404          * @param $name String
 405          * @return SpecialPage object or null if the page doesn't exist
 406          */
 407         static function getPage( $name ) {
 408                 if ( !self::$mListInitialised ) {
 409                         self::initList();
 410                 }
 411                 if ( array_key_exists( $name, self::$mList ) ) {
 412                         $rec = self::$mList[$name];
 413                         if ( is_string( $rec ) ) {
 414                                 $className = $rec;
 415                                 self::$mList[$name] = new $className;
 416                         } elseif ( is_array( $rec ) ) {
 417                                 $className = array_shift( $rec );
 418                                 self::$mList[$name] = MWFunction::newObj( $className, $rec );
 419                         }
 420                         return self::$mList[$name];
 421                 } else {
 422                         return null;
 423                 }
 424         }
 425
 426         /**
 427          * Get a special page with a given localised name, or NULL if there
 428          * is no such special page.
 429          *
 430          * @return SpecialPage object or null if the page doesn't exist
 431          */
 432         static function getPageByAlias( $alias ) {
 433                 $realName = self::resolveAlias( $alias );
 434                 if ( $realName ) {
 435                         return self::getPage( $realName );
 436                 } else {
 437                         return null;
 438                 }
 439         }
 440
 441         /**
 442          * Return categorised listable special pages which are available
 443          * for the current user, and everyone.
 444          *
 445          * @return Associative array mapping page's name to its SpecialPage object
 446          */
 447         static function getUsablePages() {
 448                 global $wgUser;
 449                 if ( !self::$mListInitialised ) {
 450                         self::initList();
 451                 }
 452                 $pages = array();
 453
 454                 foreach ( self::$mList as $name => $rec ) {
 455                         $page = self::getPage( $name );
 456                         if ( $page->isListed()
 457                                 && (
 458                                         !$page->isRestricted()
 459                                         || $page->userCanExecute( $wgUser )
 460                                 )
 461                         ) {
 462                                 $pages[$name] = $page;
 463                         }
 464                 }
 465                 return $pages;
 466         }
 467
 468         /**
 469          * Return categorised listable special pages for all users
 470          *
 471          * @return Associative array mapping page's name to its SpecialPage object
 472          */
 473         static function getRegularPages() {
 474                 if ( !self::$mListInitialised ) {
 475                         self::initList();
 476                 }
 477                 $pages = array();
 478
 479                 foreach ( self::$mList as $name => $rec ) {
 480                         $page = self::getPage( $name );
 481                         if ( $page->isListed() && !$page->isRestricted() ) {
 482                                 $pages[$name] = $page;
 483                         }
 484                 }
 485                 return $pages;
 486         }
 487
 488         /**
 489          * Return categorised listable special pages which are available
 490          * for the current user, but not for everyone
 491          *
 492          * @return Associative array mapping page's name to its SpecialPage object
 493          */
 494         static function getRestrictedPages() {
 495                 global $wgUser;
 496                 if( !self::$mListInitialised ) {
 497                         self::initList();
 498                 }
 499                 $pages = array();
 500
 501                 foreach( self::$mList as $name => $rec ) {
 502                         $page = self::getPage( $name );
 503                         if(
 504                                 $page->isListed()
 505                                 && $page->isRestricted()
 506                                 && $page->userCanExecute( $wgUser )
 507                         ) {
 508                                 $pages[$name] = $page;
 509                         }
 510                 }
 511                 return $pages;
 512         }
 513
 514         /**
 515          * Execute a special page path.
 516          * The path may contain parameters, e.g. Special:Name/Params
 517          * Extracts the special page name and call the execute method, passing the parameters
 518          *
 519          * Returns a title object if the page is redirected, false if there was no such special
 520          * page, and true if it was successful.
 521          *
 522          * @param $title          Title object
 523          * @param $context        RequestContext
 524          * @param $including      Bool output is being captured for use in {{special:whatever}}
 525          */
 526         public static function executePath( &$title, RequestContext &$context, $including = false ) {
 527                 wfProfileIn( __METHOD__ );
 528
 529                 # FIXME: redirects broken due to this call
 530                 $bits = explode( '/', $title->getDBkey(), 2 );
 531                 $name = $bits[0];
 532                 if( !isset( $bits[1] ) ) { // bug 2087
 533                         $par = null;
 534                 } else {
 535                         $par = $bits[1];
 536                 }
 537                 $page = SpecialPage::getPageByAlias( $name );
 538                 # Nonexistent?
 539                 if ( !$page ) {
 540                         $context->output->setArticleRelated( false );
 541                         $context->output->setRobotPolicy( 'noindex,nofollow' );
 542                         $context->output->setStatusCode( 404 );
 543                         $context->output->showErrorPage( 'nosuchspecialpage', 'nospecialpagetext' );
 544                         wfProfileOut( __METHOD__ );
 545                         return false;
 546                 }
 547
 548                 # Page exists, set the context
 549                 $page->setContext( $context );
 550
 551                 # Check for redirect
 552                 if ( !$including ) {
 553                         $redirect = $page->getRedirect( $par );
 554                         $query = $page->getRedirectQuery();
 555                         if ( $redirect instanceof Title ) {
 556                                 $url = $redirect->getFullUrl( $query );
 557                                 $context->output->redirect( $url );
 558                                 wfProfileOut( __METHOD__ );
 559                                 return $redirect;
 560                         } elseif( $redirect === true ) {
 561                                 global $wgScript;
 562                                 $url = $wgScript . '?' . wfArrayToCGI( $query );
 563                                 $context->output->redirect( $url );
 564                                 wfProfileOut( __METHOD__ );
 565                                 return $redirect;
 566                         }
 567                 }
 568
 569                 # Redirect to canonical alias for GET commands
 570                 # Not for POST, we'd lose the post data, so it's best to just distribute
 571                 # the request. Such POST requests are possible for old extensions that
 572                 # generate self-links without being aware that their default name has
 573                 # changed.
 574                 if ( !$including && $name != $page->getLocalName() && !$context->request->wasPosted() ) {
 575                         $query = $_GET;
 576                         unset( $query['title'] );
 577                         $query = wfArrayToCGI( $query );
 578                         $title = $page->getTitle( $par );
 579                         $url = $title->getFullUrl( $query );
 580                         $context->output->redirect( $url );
 581                         wfProfileOut( __METHOD__ );
 582                         return $redirect;
 583                 }
 584
 585                 if ( $including && !$page->includable() ) {
 586                         wfProfileOut( __METHOD__ );
 587                         return false;
 588                 } elseif ( !$including ) {
 589                         $context->title = $page->getTitle();
 590                 }
 591                 $page->including( $including );
 592
 593                 // Execute special page
 594                 $profName = 'Special:' . $page->name();
 595                 wfProfileIn( $profName );
 596                 $page->execute( $par );
 597                 wfProfileOut( $profName );
 598                 wfProfileOut( __METHOD__ );
 599                 return true;
 600         }
 601
 602         /**
 603          * Just like executePath() except it returns the HTML instead of outputting it
 604          * Returns false if there was no such special page, or a title object if it was
 605          * a redirect.
 606          *
 607          * @return String: HTML fragment
 608          */
 609         static function capturePath( &$title ) {
 610                 global $wgOut, $wgTitle;
 611
 612                 $oldTitle = $wgTitle;
 613                 $oldOut = $wgOut;
 614
 615                 $context = new RequestContext;
 616                 $context->setTitle( $title );
 617                 $wgOut = $context->getOutput();
 618
 619                 $ret = SpecialPage::executePath( $title, $context, true );
 620                 if ( $ret === true ) {
 621                         $ret = $wgOut->getHTML();
 622                 }
 623                 $wgTitle = $oldTitle;
 624                 $wgOut = $oldOut;
 625                 return $ret;
 626         }
 627
 628         /**
 629          * Get the local name for a specified canonical name
 630          *
 631          * @param $name String
 632          * @param $subpage Mixed: boolean false, or string
 633          *
 634          * @return String
 635          */
 636         static function getLocalNameFor( $name, $subpage = false ) {
 637                 global $wgContLang;
 638                 $aliases = $wgContLang->getSpecialPageAliases();
 639                 if ( isset( $aliases[$name][0] ) ) {
 640                         $name = $aliases[$name][0];
 641                 } else {
 642                         // Try harder in case someone misspelled the correct casing
 643                         $found = false;
 644                         foreach ( $aliases as $n => $values ) {
 645                                 if ( strcasecmp( $name, $n ) === 0 ) {
 646                                         wfWarn( "Found alias defined for $n when searching for " .
 647                                                 "special page aliases for $name. Case mismatch?" );
 648                                         $name = $values[0];
 649                                         $found = true;
 650                                         break;
 651                                 }
 652                         }
 653                         if ( !$found ) {
 654                                 wfWarn( "Did not find alias for special page '$name'. " .
 655                                         "Perhaps no aliases are defined for it?" );
 656                         }
 657                 }
 658                 if ( $subpage !== false && !is_null( $subpage ) ) {
 659                         $name = "$name/$subpage";
 660                 }
 661                 return $wgContLang->ucfirst( $name );
 662         }
 663
 664         /**
 665          * Get a localised Title object for a specified special page name
 666          *
 667          * @return Title object
 668          */
 669         static function getTitleFor( $name, $subpage = false ) {
 670                 $name = self::getLocalNameFor( $name, $subpage );
 671                 if ( $name ) {
 672                         return Title::makeTitle( NS_SPECIAL, $name );
 673                 } else {
 674                         throw new MWException( "Invalid special page name \"$name\"" );
 675                 }
 676         }
 677
 678         /**
 679          * Get a localised Title object for a page name with a possibly unvalidated subpage
 680          *
 681          * @return Title object or null if the page doesn't exist
 682          */
 683         static function getSafeTitleFor( $name, $subpage = false ) {
 684                 $name = self::getLocalNameFor( $name, $subpage );
 685                 if ( $name ) {
 686                         return Title::makeTitleSafe( NS_SPECIAL, $name );
 687                 } else {
 688                         return null;
 689                 }
 690         }
 691
 692         /**
 693          * Get a title for a given alias
 694          *
 695          * @return Title or null if there is no such alias
 696          */
 697         static function getTitleForAlias( $alias ) {
 698                 $name = self::resolveAlias( $alias );
 699                 if ( $name ) {
 700                         return self::getTitleFor( $name );
 701                 } else {
 702                         return null;
 703                 }
 704         }
 705
 706         /**
 707          * Default constructor for special pages
 708          * Derivative classes should call this from their constructor
 709          *     Note that if the user does not have the required level, an error message will
 710          *     be displayed by the default execute() method, without the global function ever
 711          *     being called.
 712          *
 713          *     If you override execute(), you can recover the default behaviour with userCanExecute()
 714          *     and displayRestrictionError()
 715          *
 716          * @param $name String: name of the special page, as seen in links and URLs
 717          * @param $restriction String: user right required, e.g. "block" or "delete"
 718          * @param $listed Boolean: whether the page is listed in Special:Specialpages
 719          * @param $function Callback: function called by execute(). By default it is constructed from $name
 720          * @param $file String: file which is included by execute(). It is also constructed from $name by default
 721          * @param $includable Boolean: whether the page can be included in normal pages
 722          */
 723         public function __construct( $name = '', $restriction = '', $listed = true, $function = false, $file = 'default', $includable = false ) {
 724                 $this->init( $name, $restriction, $listed, $function, $file, $includable );
 725         }
 726
 727         /**
 728          * Do the real work for the constructor, mainly so __call() can intercept
 729          * calls to SpecialPage()
 730          * @see __construct() for param docs
 731          */
 732         private function init( $name, $restriction, $listed, $function, $file, $includable ) {
 733                 $this->mName = $name;
 734                 $this->mRestriction = $restriction;
 735                 $this->mListed = $listed;
 736                 $this->mIncludable = $includable;
 737                 if ( !$function ) {
 738                         $this->mFunction = 'wfSpecial'.$name;
 739                 } else {
 740                         $this->mFunction = $function;
 741                 }
 742                 if ( $file === 'default' ) {
 743                         $this->mFile = dirname(__FILE__) . "/specials/Special$name.php";
 744                 } else {
 745                         $this->mFile = $file;
 746                 }
 747         }
 748
 749         /**
 750          * Use PHP's magic __call handler to get calls to the old PHP4 constructor
 751          * because PHP E_STRICT yells at you for having __construct() and SpecialPage()
 752          *
 753          * @param $fName String Name of called method
 754          * @param $a Array Arguments to the method
 755          * @deprecated Call isn't deprecated, but SpecialPage::SpecialPage() is
 756          */
 757         public function __call( $fName, $a ) {
 758                 // Sometimes $fName is SpecialPage, sometimes it's specialpage. <3 PHP
 759                 if( strtolower( $fName ) == 'specialpage' ) {
 760                         // Debug messages now, warnings in 1.19 or 1.20?
 761                         wfDebug( "Deprecated SpecialPage::SpecialPage() called, use __construct();\n" );
 762                         $name = isset( $a[0] ) ? $a[0] : '';
 763                         $restriction = isset( $a[1] ) ? $a[1] : '';
 764                         $listed = isset( $a[2] ) ? $a[2] : true;
 765                         $function = isset( $a[3] ) ? $a[3] : false;
 766                         $file = isset( $a[4] ) ? $a[4] : 'default';
 767                         $includable = isset( $a[5] ) ? $a[5] : false;
 768                         $this->init( $name, $restriction, $listed, $function, $file, $includable );
 769                 } else {
 770                         $className = get_class( $this );
 771                         throw new MWException( "Call to undefined method $className::$fName" );
 772                 }
 773         }
 774
 775         /**#@+
 776           * Accessor
 777           *
 778           * @deprecated
 779           */
 780         function getName() { return $this->mName; }
 781         function getRestriction() { return $this->mRestriction; }
 782         function getFile() { return $this->mFile; }
 783         function isListed() { return $this->mListed; }
 784         /**#@-*/
 785
 786         /**#@+
 787           * Accessor and mutator
 788           */
 789         function name( $x = null ) { return wfSetVar( $this->mName, $x ); }
 790         function restrictions( $x = null) {
 791                 # Use the one below this
 792                 wfDeprecated( __METHOD__ );
 793                 return wfSetVar( $this->mRestriction, $x );
 794         }
 795         function restriction( $x = null) { return wfSetVar( $this->mRestriction, $x ); }
 796         function listed( $x = null) { return wfSetVar( $this->mListed, $x ); }
 797         function func( $x = null) { return wfSetVar( $this->mFunction, $x ); }
 798         function file( $x = null) { return wfSetVar( $this->mFile, $x ); }
 799         function includable( $x = null ) { return wfSetVar( $this->mIncludable, $x ); }
 800         function including( $x = null ) { return wfSetVar( $this->mIncluding, $x ); }
 801         /**#@-*/
 802
 803         /**
 804          * Get the localised name of the special page
 805          */
 806         function getLocalName() {
 807                 if ( !isset( $this->mLocalName ) ) {
 808                         $this->mLocalName = self::getLocalNameFor( $this->mName );
 809                 }
 810                 return $this->mLocalName;
 811         }
 812
 813         /**
 814          * Is this page expensive (for some definition of expensive)?
 815          * Expensive pages are disabled or cached in miser mode.  Originally used
 816          * (and still overridden) by QueryPage and subclasses, moved here so that
 817          * Special:SpecialPages can safely call it for all special pages.
 818          *
 819          * @return Boolean
 820          */
 821         public function isExpensive() {
 822                 return false;
 823         }
 824
 825         /**
 826          * Can be overridden by subclasses with more complicated permissions
 827          * schemes.
 828          *
 829          * @return Boolean: should the page be displayed with the restricted-access
 830          *   pages?
 831          */
 832         public function isRestricted() {
 833                 global $wgGroupPermissions;
 834                 // DWIM: If all anons can do something, then it is not restricted
 835                 return $this->mRestriction != '' && empty($wgGroupPermissions['*'][$this->mRestriction]);
 836         }
 837
 838         /**
 839          * Checks if the given user (identified by an object) can execute this
 840          * special page (as defined by $mRestriction).  Can be overridden by sub-
 841          * classes with more complicated permissions schemes.
 842          *
 843          * @param $user User: the user to check
 844          * @return Boolean: does the user have permission to view the page?
 845          */
 846         public function userCanExecute( $user ) {
 847                 return $user->isAllowed( $this->mRestriction );
 848         }
 849
 850         /**
 851          * Output an error message telling the user what access level they have to have
 852          */
 853         function displayRestrictionError() {
 854                 $this->getOutput()->permissionRequired( $this->mRestriction );
 855         }
 856
 857         /**
 858          * Sets headers - this should be called from the execute() method of all derived classes!
 859          */
 860         function setHeaders() {
 861                 $out = $this->getOutput();
 862                 $out->setArticleRelated( false );
 863                 $out->setRobotPolicy( "noindex,nofollow" );
 864                 $out->setPageTitle( $this->getDescription() );
 865         }
 866
 867         /**
 868          * Default execute method
 869          * Checks user permissions, calls the function given in mFunction
 870          *
 871          * This may be overridden by subclasses.
 872          */
 873         function execute( $par ) {
 874                 $this->setHeaders();
 875
 876                 if ( $this->userCanExecute( $this->getUser() ) ) {
 877                         $func = $this->mFunction;
 878                         // only load file if the function does not exist
 879                         if(!is_callable($func) and $this->mFile) {
 880                                 require_once( $this->mFile );
 881                         }
 882                         $this->outputHeader();
 883                         call_user_func( $func, $par, $this );
 884                 } else {
 885                         $this->displayRestrictionError();
 886                 }
 887         }
 888
 889         /**
 890          * Outputs a summary message on top of special pages
 891          * Per default the message key is the canonical name of the special page
 892          * May be overriden, i.e. by extensions to stick with the naming conventions
 893          * for message keys: 'extensionname-xxx'
 894          *
 895          * @param $summaryMessageKey String: message key of the summary
 896          */
 897         function outputHeader( $summaryMessageKey = '' ) {
 898                 global $wgContLang;
 899
 900                 if( $summaryMessageKey == '' ) {
 901                         $msg = $wgContLang->lc( $this->name() ) . '-summary';
 902                 } else {
 903                         $msg = $summaryMessageKey;
 904                 }
 905                 if ( !wfMessage( $msg )->isBlank() and ! $this->including() ) {
 906                         $this->getOutput()->wrapWikiMsg( "<div class='mw-specialpage-summary'>\n$1\n</div>", $msg );
 907                 }
 908
 909         }
 910
 911         /**
 912          * Returns the name that goes in the \<h1\> in the special page itself, and
 913          * also the name that will be listed in Special:Specialpages
 914          *
 915          * Derived classes can override this, but usually it is easier to keep the
 916          * default behaviour. Messages can be added at run-time, see
 917          * MessageCache.php.
 918          *
 919          * @return String
 920          */
 921         function getDescription() {
 922                 return wfMsg( strtolower( $this->mName ) );
 923         }
 924
 925         /**
 926          * Get a self-referential title object
 927          *
 928          * @return Title object
 929          */
 930         function getTitle( $subpage = false ) {
 931                 return self::getTitleFor( $this->mName, $subpage );
 932         }
 933
 934         /**
 935          * Set whether this page is listed in Special:Specialpages, at run-time
 936          */
 937         function setListed( $listed ) {
 938                 return wfSetVar( $this->mListed, $listed );
 939         }
 940
 941         /**
 942          * If the special page is a redirect, then get the Title object it redirects to.
 943          * False otherwise.
 944          */
 945         function getRedirect( $subpage ) {
 946                 return false;
 947         }
 948
 949         /**
 950          * Return part of the request string for a special redirect page
 951          * This allows passing, e.g. action=history to Special:Mypage, etc.
 952          *
 953          * @return String
 954          */
 955         function getRedirectQuery() {
 956                 $params = array();
 957
 958                 foreach( $this->mAllowedRedirectParams as $arg ) {
 959                         if( $this->getContext()->request->getVal( $arg, null ) !== null ){
 960                                 $params[$arg] = $this->getContext()->request->getVal( $arg );
 961                         }
 962                 }
 963
 964                 foreach( $this->mAddedRedirectParams as $arg => $val ) {
 965                         $params[$arg] = $val;
 966                 }
 967
 968                 return count( $params )
 969                         ? $params
 970                         : false;
 971         }
 972
 973         /**
 974          * Sets the context this SpecialPage is executed in
 975          *
 976          * @param $context RequestContext
 977          * @since 1.18
 978          */
 979         protected function setContext( $context ) {
 980                 $this->mContext = $context;
 981         }
 982
 983         /**
 984          * Gets the context this SpecialPage is executed in
 985          *
 986          * @return RequestContext
 987          * @since 1.18
 988          */
 989         public function getContext() {
 990                 if ( $this->mContext instanceof RequestContext ) {
 991                         return $this->mContext;
 992                 } else {
 993                         wfDebug( __METHOD__ . " called and \$mContext is null. Return RequestContext::getMain(); for sanity\n" );
 994                         return RequestContext::getMain();
 995                 }
 996         }
 997
 998         /**
 999          * Get the WebRequest being used for this instance
1000          *
1001          * @return WebRequest
1002          * @since 1.18
1003          */
1004         public function getRequest() {
1005                 return $this->getContext()->getRequest();
1006         }
1007
1008         /**
1009          * Get the OutputPage being used for this instance
1010          *
1011          * @return OutputPage
1012          * @since 1.18
1013          */
1014         public function getOutput() {
1015                 return $this->getContext()->getOutput();
1016         }
1017
1018         /**
1019          * Shortcut to get the skin being used for this instance
1020          *
1021          * @return User
1022          * @since 1.18
1023          */
1024         public function getUser() {
1025                 return $this->getContext()->getUser();
1026         }
1027
1028         /**
1029          * Shortcut to get the skin being used for this instance
1030          *
1031          * @return Skin
1032          * @since 1.18
1033          */
1034         public function getSkin() {
1035                 return $this->getContext()->getSkin();
1036         }
1037
1038         /**
1039          * Return the full title, including $par
1040          *
1041          * @return Title
1042          * @since 1.18
1043          */
1044         public function getFullTitle() {
1045                 return $this->getContext()->getTitle();
1046         }
1047
1048         /**
1049          * Wrapper around wfMessage that sets the current context. Currently this
1050          * is only the title.
1051          *
1052          * @see wfMessage
1053          */
1054         public function msg( /* $args */ ) {
1055                 return call_user_func_array( 'wfMessage', func_get_args() )->title( $this->getFullTitle() );
1056         }
1057 }
1058
1059 /**
1060  * Shortcut to construct a special page which is unlisted by default
1061  * @ingroup SpecialPage
1062  */
1063 class UnlistedSpecialPage extends SpecialPage
1064 {
1065         function __construct( $name, $restriction = '', $function = false, $file = 'default' ) {
1066                 parent::__construct( $name, $restriction, false, $function, $file );
1067         }
1068 }
1069
1070 /**
1071  * Shortcut to construct an includable special  page
1072  * @ingroup SpecialPage
1073  */
1074 class IncludableSpecialPage extends SpecialPage
1075 {
1076         function __construct( $name, $restriction = '', $listed = true, $function = false, $file = 'default' ) {
1077                 parent::__construct( $name, $restriction, $listed, $function, $file, true );
1078         }
1079 }
1080
1081 /**
1082  * Shortcut to construct a special page alias.
1083  * @ingroup SpecialPage
1084  */
1085 class SpecialRedirectToSpecial extends UnlistedSpecialPage {
1086         var $redirName, $redirSubpage;
1087
1088         function __construct( $name, $redirName, $redirSubpage = false, $allowedRedirectParams = array(), $addedRedirectParams = array() ) {
1089                 parent::__construct( $name );
1090                 $this->redirName = $redirName;
1091                 $this->redirSubpage = $redirSubpage;
1092                 $this->mAllowedRedirectParams = $allowedRedirectParams;
1093                 $this->mAddedRedirectParams = $addedRedirectParams;
1094         }
1095
1096         function getRedirect( $subpage ) {
1097                 if ( $this->redirSubpage === false ) {
1098                         return SpecialPage::getTitleFor( $this->redirName, $subpage );
1099                 } else {
1100                         return SpecialPage::getTitleFor( $this->redirName, $this->redirSubpage );
1101                 }
1102         }
1103 }
1104
1105 /**
1106  * SpecialMypage, SpecialMytalk and SpecialMycontributions special pages
1107  * are used to get user independant links pointing to the user page, talk
1108  * page and list of contributions.
1109  * This can let us cache a single copy of any generated content for all
1110  * users.
1111  */
1112
1113 /**
1114  * Shortcut to construct a special page pointing to current user user's page.
1115  * @ingroup SpecialPage
1116  */
1117 class SpecialMypage extends UnlistedSpecialPage {
1118         function __construct() {
1119                 parent::__construct( 'Mypage' );
1120                 $this->mAllowedRedirectParams = array( 'action' , 'preload' , 'editintro',
1121                         'section', 'oldid', 'diff', 'dir' );
1122         }
1123
1124         function getRedirect( $subpage ) {
1125                 global $wgUser;
1126                 if ( strval( $subpage ) !== '' ) {
1127                         return Title::makeTitle( NS_USER, $wgUser->getName() . '/' . $subpage );
1128                 } else {
1129                         return Title::makeTitle( NS_USER, $wgUser->getName() );
1130                 }
1131         }
1132 }
1133
1134 /**
1135  * Shortcut to construct a special page pointing to current user talk page.
1136  * @ingroup SpecialPage
1137  */
1138 class SpecialMytalk extends UnlistedSpecialPage {
1139         function __construct() {
1140                 parent::__construct( 'Mytalk' );
1141                 $this->mAllowedRedirectParams = array( 'action' , 'preload' , 'editintro',
1142                         'section', 'oldid', 'diff', 'dir' );
1143         }
1144
1145         function getRedirect( $subpage ) {
1146                 global $wgUser;
1147                 if ( strval( $subpage ) !== '' ) {
1148                         return Title::makeTitle( NS_USER_TALK, $wgUser->getName() . '/' . $subpage );
1149                 } else {
1150                         return Title::makeTitle( NS_USER_TALK, $wgUser->getName() );
1151                 }
1152         }
1153 }
1154
1155 /**
1156  * Shortcut to construct a special page pointing to current user contributions.
1157  * @ingroup SpecialPage
1158  */
1159 class SpecialMycontributions extends UnlistedSpecialPage {
1160         function __construct() {
1161                 parent::__construct(  'Mycontributions' );
1162                 $this->mAllowedRedirectParams = array( 'limit', 'namespace', 'tagfilter',
1163                         'offset', 'dir', 'year', 'month', 'feed' );
1164         }
1165
1166         function getRedirect( $subpage ) {
1167                 global $wgUser;
1168                 return SpecialPage::getTitleFor( 'Contributions', $wgUser->getName() );
1169         }
1170 }
1171
1172 /**
1173  * Redirect to Special:Listfiles?user=$wgUser
1174  */
1175 class SpecialMyuploads extends UnlistedSpecialPage {
1176         function __construct() {
1177                 parent::__construct( 'Myuploads' );
1178                 $this->mAllowedRedirectParams = array( 'limit' );
1179         }
1180
1181         function getRedirect( $subpage ) {
1182                 global $wgUser;
1183                 return SpecialPage::getTitleFor( 'Listfiles', $wgUser->getName() );
1184         }
1185 }
1186
1187 /**
1188  * Redirect from Special:PermanentLink/### to index.php?oldid=###
1189  */
1190 class SpecialPermanentLink extends UnlistedSpecialPage {
1191         function __construct() {
1192                 parent::__construct( 'PermanentLink' );
1193                 $this->mAllowedRedirectParams = array();
1194         }
1195
1196         function getRedirect( $subpage ) {
1197                 $subpage = intval( $subpage );
1198                 $this->mAddedRedirectParams['oldid'] = $subpage;
1199                 return true;
1200         }
1201 }