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