includes/SpecialPageFactory.php

   1 <?php
   2 /**
   3  * Factory for handling the special page list and generating SpecialPage objects.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup SpecialPage
  22  * @defgroup SpecialPage SpecialPage
  23  */
  24
  25 /**
  26  * Factory for handling the special page list and generating SpecialPage objects.
  27  *
  28  * To add a special page in an extension, add to $wgSpecialPages either
  29  * an object instance or an array containing the name and constructor
  30  * parameters. The latter is preferred for performance reasons.
  31  *
  32  * The object instantiated must be either an instance of SpecialPage or a
  33  * sub-class thereof. It must have an execute() method, which sends the HTML
  34  * for the special page to $wgOut. The parent class has an execute() method
  35  * which distributes the call to the historical global functions. Additionally,
  36  * execute() also checks if the user has the necessary access privileges
  37  * and bails out if not.
  38  *
  39  * To add a core special page, use the similar static list in
  40  * SpecialPage::$mList. To remove a core static special page at runtime, use
  41  * a SpecialPage_initList hook.
  42  *
  43  * @ingroup SpecialPage
  44  * @since 1.17
  45  */
  46 class SpecialPageFactory {
  47
  48         /**
  49          * List of special page names to the subclass of SpecialPage which handles them.
  50          */
  51         private static $mList = array(
  52                 // Maintenance Reports
  53                 'BrokenRedirects'           => 'BrokenRedirectsPage',
  54                 'Deadendpages'              => 'DeadendpagesPage',
  55                 'DoubleRedirects'           => 'DoubleRedirectsPage',
  56                 'Longpages'                 => 'LongpagesPage',
  57                 'Ancientpages'              => 'AncientpagesPage',
  58                 'Lonelypages'               => 'LonelypagesPage',
  59                 'Fewestrevisions'           => 'FewestrevisionsPage',
  60                 'Withoutinterwiki'          => 'WithoutinterwikiPage',
  61                 'Protectedpages'            => 'SpecialProtectedpages',
  62                 'Protectedtitles'           => 'SpecialProtectedtitles',
  63                 'Shortpages'                => 'ShortpagesPage',
  64                 'Uncategorizedcategories'   => 'UncategorizedcategoriesPage',
  65                 'Uncategorizedimages'       => 'UncategorizedimagesPage',
  66                 'Uncategorizedpages'        => 'UncategorizedpagesPage',
  67                 'Uncategorizedtemplates'    => 'UncategorizedtemplatesPage',
  68                 'Unusedcategories'          => 'UnusedcategoriesPage',
  69                 'Unusedimages'              => 'UnusedimagesPage',
  70                 'Unusedtemplates'           => 'UnusedtemplatesPage',
  71                 'Unwatchedpages'            => 'UnwatchedpagesPage',
  72                 'Wantedcategories'          => 'WantedcategoriesPage',
  73                 'Wantedfiles'               => 'WantedfilesPage',
  74                 'Wantedpages'               => 'WantedpagesPage',
  75                 'Wantedtemplates'           => 'WantedtemplatesPage',
  76
  77                 // List of pages
  78                 'Allpages'                  => 'SpecialAllpages',
  79                 'Prefixindex'               => 'SpecialPrefixindex',
  80                 'Categories'                => 'SpecialCategories',
  81                 'Disambiguations'           => 'DisambiguationsPage',
  82                 'Listredirects'             => 'ListredirectsPage',
  83                 'PagesWithProp'             => 'SpecialPagesWithProp',
  84
  85                 // Login/create account
  86                 'Userlogin'                 => 'LoginForm',
  87                 'CreateAccount'             => 'SpecialCreateAccount',
  88
  89                 // Users and rights
  90                 'Block'                     => 'SpecialBlock',
  91                 'Unblock'                   => 'SpecialUnblock',
  92                 'BlockList'                 => 'SpecialBlockList',
  93                 'ChangePassword'            => 'SpecialChangePassword',
  94                 'PasswordReset'             => 'SpecialPasswordReset',
  95                 'DeletedContributions'      => 'DeletedContributionsPage',
  96                 'Preferences'               => 'SpecialPreferences',
  97                 'Contributions'             => 'SpecialContributions',
  98                 'Listgrouprights'           => 'SpecialListGroupRights',
  99                 'Listusers'                 => 'SpecialListUsers',
 100                 'Listadmins'                => 'SpecialListAdmins',
 101                 'Listbots'                  => 'SpecialListBots',
 102                 'Userrights'                => 'UserrightsPage',
 103                 'EditWatchlist'             => 'SpecialEditWatchlist',
 104
 105                 // Recent changes and logs
 106                 'Newimages'                 => 'SpecialNewFiles',
 107                 'Log'                       => 'SpecialLog',
 108                 'Watchlist'                 => 'SpecialWatchlist',
 109                 'Newpages'                  => 'SpecialNewpages',
 110                 'Recentchanges'             => 'SpecialRecentchanges',
 111                 'Recentchangeslinked'       => 'SpecialRecentchangeslinked',
 112                 'Tags'                      => 'SpecialTags',
 113
 114                 // Media reports and uploads
 115                 'Listfiles'                 => 'SpecialListFiles',
 116                 'Filepath'                  => 'SpecialFilepath',
 117                 'MIMEsearch'                => 'MIMEsearchPage',
 118                 'FileDuplicateSearch'       => 'FileDuplicateSearchPage',
 119                 'Upload'                    => 'SpecialUpload',
 120                 'UploadStash'               => 'SpecialUploadStash',
 121
 122                 // Data and tools
 123                 'Statistics'                => 'SpecialStatistics',
 124                 'Allmessages'               => 'SpecialAllmessages',
 125                 'Version'                   => 'SpecialVersion',
 126                 'Lockdb'                    => 'SpecialLockdb',
 127                 'Unlockdb'                  => 'SpecialUnlockdb',
 128
 129                 // Redirecting special pages
 130                 'LinkSearch'                => 'LinkSearchPage',
 131                 'Randompage'                => 'Randompage',
 132                 'Randomredirect'            => 'SpecialRandomredirect',
 133
 134                 // High use pages
 135                 'Mostlinkedcategories'      => 'MostlinkedCategoriesPage',
 136                 'Mostimages'                => 'MostimagesPage',
 137                 'Mostinterwikis'            => 'MostinterwikisPage',
 138                 'Mostlinked'                => 'MostlinkedPage',
 139                 'Mostlinkedtemplates'       => 'MostlinkedTemplatesPage',
 140                 'Mostcategories'            => 'MostcategoriesPage',
 141                 'Mostrevisions'             => 'MostrevisionsPage',
 142
 143                 // Page tools
 144                 'ComparePages'              => 'SpecialComparePages',
 145                 'Export'                    => 'SpecialExport',
 146                 'Import'                    => 'SpecialImport',
 147                 'Undelete'                  => 'SpecialUndelete',
 148                 'Whatlinkshere'             => 'SpecialWhatlinkshere',
 149                 'MergeHistory'              => 'SpecialMergeHistory',
 150
 151                 // Other
 152                 'Booksources'               => 'SpecialBookSources',
 153
 154                 // Unlisted / redirects
 155                 'Blankpage'                 => 'SpecialBlankpage',
 156                 'Blockme'                   => 'SpecialBlockme',
 157                 'Emailuser'                 => 'SpecialEmailUser',
 158                 'Movepage'                  => 'MovePageForm',
 159                 'Mycontributions'           => 'SpecialMycontributions',
 160                 'Mypage'                    => 'SpecialMypage',
 161                 'Mytalk'                    => 'SpecialMytalk',
 162                 'Myuploads'                 => 'SpecialMyuploads',
 163                 'PermanentLink'             => 'SpecialPermanentLink',
 164                 'Redirect'                  => 'SpecialRedirect',
 165                 'Revisiondelete'            => 'SpecialRevisionDelete',
 166                 'Specialpages'              => 'SpecialSpecialpages',
 167                 'Userlogout'                => 'SpecialUserlogout',
 168         );
 169
 170         private static $mAliases;
 171
 172         /**
 173          * Initialise the special page list
 174          * This must be called before accessing SpecialPage::$mList
 175          *
 176          * @return array
 177          */
 178         static function getList() {
 179                 global $wgSpecialPages;
 180                 global $wgDisableCounters, $wgDisableInternalSearch, $wgEmailAuthentication;
 181                 global $wgEnableEmail, $wgEnableJavaScriptTest;
 182
 183                 if ( !is_object( self::$mList ) ) {
 184                         wfProfileIn( __METHOD__ );
 185
 186                         if ( !$wgDisableCounters ) {
 187                                 self::$mList['Popularpages'] = 'PopularpagesPage';
 188                         }
 189
 190                         if ( !$wgDisableInternalSearch ) {
 191                                 self::$mList['Search'] = 'SpecialSearch';
 192                         }
 193
 194                         if ( $wgEmailAuthentication ) {
 195                                 self::$mList['Confirmemail'] = 'EmailConfirmation';
 196                                 self::$mList['Invalidateemail'] = 'EmailInvalidation';
 197                         }
 198
 199                         if ( $wgEnableEmail ) {
 200                                 self::$mList['ChangeEmail'] = 'SpecialChangeEmail';
 201                         }
 202
 203                         if ( $wgEnableJavaScriptTest ) {
 204                                 self::$mList['JavaScriptTest'] = 'SpecialJavaScriptTest';
 205                         }
 206
 207                         // Add extension special pages
 208                         self::$mList = array_merge( self::$mList, $wgSpecialPages );
 209
 210                         // Run hooks
 211                         // This hook can be used to remove undesired built-in special pages
 212                         wfRunHooks( 'SpecialPage_initList', array( &self::$mList ) );
 213
 214                         // Cast to object: func()[$key] doesn't work, but func()->$key does
 215                         settype( self::$mList, 'object' );
 216
 217                         wfProfileOut( __METHOD__ );
 218                 }
 219                 return self::$mList;
 220         }
 221
 222         /**
 223          * Initialise and return the list of special page aliases.  Returns an object with
 224          * properties which can be accessed $obj->pagename - each property is an array of
 225          * aliases; the first in the array is the canonical alias.  All registered special
 226          * pages are guaranteed to have a property entry, and for that property array to
 227          * contain at least one entry (English fallbacks will be added if necessary).
 228          * @return Object
 229          */
 230         static function getAliasList() {
 231                 if ( !is_object( self::$mAliases ) ) {
 232                         global $wgContLang;
 233                         $aliases = $wgContLang->getSpecialPageAliases();
 234
 235                         // Objects are passed by reference by default, need to create a copy
 236                         $missingPages = clone self::getList();
 237
 238                         self::$mAliases = array();
 239                         foreach ( $aliases as $realName => $aliasList ) {
 240                                 foreach ( $aliasList as $alias ) {
 241                                         self::$mAliases[$wgContLang->caseFold( $alias )] = $realName;
 242                                 }
 243                                 unset( $missingPages->$realName );
 244                         }
 245                         foreach ( $missingPages as $name => $stuff ) {
 246                                 self::$mAliases[$wgContLang->caseFold( $name )] = $name;
 247                         }
 248
 249                         // Cast to object: func()[$key] doesn't work, but func()->$key does
 250                         self::$mAliases = (object)self::$mAliases;
 251                 }
 252                 return self::$mAliases;
 253         }
 254
 255         /**
 256          * Given a special page name with a possible subpage, return an array
 257          * where the first element is the special page name and the second is the
 258          * subpage.
 259          *
 260          * @param $alias String
 261          * @return Array( String, String|null ), or array( null, null ) if the page is invalid
 262          */
 263         public static function resolveAlias( $alias ) {
 264                 global $wgContLang;
 265                 $bits = explode( '/', $alias, 2 );
 266
 267                 $caseFoldedAlias = $wgContLang->caseFold( $bits[0] );
 268                 $caseFoldedAlias = str_replace( ' ', '_', $caseFoldedAlias );
 269                 if ( isset( self::getAliasList()->$caseFoldedAlias ) ) {
 270                         $name = self::getAliasList()->$caseFoldedAlias;
 271                 } else {
 272                         return array( null, null );
 273                 }
 274
 275                 if ( !isset( $bits[1] ) ) { // bug 2087
 276                         $par = null;
 277                 } else {
 278                         $par = $bits[1];
 279                 }
 280
 281                 return array( $name, $par );
 282         }
 283
 284         /**
 285          * Add a page to a certain display group for Special:SpecialPages
 286          *
 287          * @param $page Mixed: SpecialPage or string
 288          * @param $group String
 289          * @deprecated 1.21 Override SpecialPage::getGroupName
 290          */
 291         public static function setGroup( $page, $group ) {
 292                 wfDeprecated( __METHOD__, '1.21' );
 293
 294                 global $wgSpecialPageGroups;
 295                 $name = is_object( $page ) ? $page->getName() : $page;
 296                 $wgSpecialPageGroups[$name] = $group;
 297         }
 298
 299         /**
 300          * Get the group that the special page belongs in on Special:SpecialPage
 301          *
 302          * @param $page SpecialPage
 303          * @return String
 304          * @deprecated 1.21 Use SpecialPage::getFinalGroupName
 305          */
 306         public static function getGroup( &$page ) {
 307                 wfDeprecated( __METHOD__, '1.21' );
 308
 309                 return $page->getFinalGroupName();
 310         }
 311
 312         /**
 313          * Check if a given name exist as a special page or as a special page alias
 314          *
 315          * @param string $name name of a special page
 316          * @return Boolean: true if a special page exists with this name
 317          */
 318         public static function exists( $name ) {
 319                 list( $title, /*...*/ ) = self::resolveAlias( $name );
 320                 return property_exists( self::getList(), $title );
 321         }
 322
 323         /**
 324          * Find the object with a given name and return it (or NULL)
 325          *
 326          * @param string $name Special page name, may be localised and/or an alias
 327          * @return SpecialPage|null SpecialPage object or null if the page doesn't exist
 328          */
 329         public static function getPage( $name ) {
 330                 list( $realName, /*...*/ ) = self::resolveAlias( $name );
 331                 if ( property_exists( self::getList(), $realName ) ) {
 332                         $rec = self::getList()->$realName;
 333                         if ( is_string( $rec ) ) {
 334                                 $className = $rec;
 335                                 return new $className;
 336                         } elseif ( is_array( $rec ) ) {
 337                                 // @deprecated, officially since 1.18, unofficially since forever
 338                                 wfDebug( "Array syntax for \$wgSpecialPages is deprecated, define a subclass of SpecialPage instead." );
 339                                 $className = array_shift( $rec );
 340                                 self::getList()->$realName = MWFunction::newObj( $className, $rec );
 341                         }
 342                         return self::getList()->$realName;
 343                 } else {
 344                         return null;
 345                 }
 346         }
 347
 348         /**
 349          * Return categorised listable special pages which are available
 350          * for the current user, and everyone.
 351          *
 352          * @param $user User object to check permissions, $wgUser will be used
 353          *              if not provided
 354          * @return Array( String => Specialpage )
 355          */
 356         public static function getUsablePages( User $user = null ) {
 357                 $pages = array();
 358                 if ( $user === null ) {
 359                         global $wgUser;
 360                         $user = $wgUser;
 361                 }
 362                 foreach ( self::getList() as $name => $rec ) {
 363                         $page = self::getPage( $name );
 364                         if ( $page ) { // not null
 365                                 $page->setContext( RequestContext::getMain() );
 366                                 if ( $page->isListed()
 367                                         && ( !$page->isRestricted() || $page->userCanExecute( $user ) )
 368                                 ) {
 369                                         $pages[$name] = $page;
 370                                 }
 371                         }
 372                 }
 373                 return $pages;
 374         }
 375
 376         /**
 377          * Return categorised listable special pages for all users
 378          *
 379          * @return Array( String => Specialpage )
 380          */
 381         public static function getRegularPages() {
 382                 $pages = array();
 383                 foreach ( self::getList() as $name => $rec ) {
 384                         $page = self::getPage( $name );
 385                         if ( $page->isListed() && !$page->isRestricted() ) {
 386                                 $pages[$name] = $page;
 387                         }
 388                 }
 389                 return $pages;
 390         }
 391
 392         /**
 393          * Return categorised listable special pages which are available
 394          * for the current user, but not for everyone
 395          *
 396          * @return Array( String => Specialpage )
 397          */
 398         public static function getRestrictedPages() {
 399                 global $wgUser;
 400                 $pages = array();
 401                 foreach ( self::getList() as $name => $rec ) {
 402                         $page = self::getPage( $name );
 403                         if (
 404                                 $page->isListed()
 405                                 && $page->isRestricted()
 406                                 && $page->userCanExecute( $wgUser )
 407                         ) {
 408                                 $pages[$name] = $page;
 409                         }
 410                 }
 411                 return $pages;
 412         }
 413
 414         /**
 415          * Execute a special page path.
 416          * The path may contain parameters, e.g. Special:Name/Params
 417          * Extracts the special page name and call the execute method, passing the parameters
 418          *
 419          * Returns a title object if the page is redirected, false if there was no such special
 420          * page, and true if it was successful.
 421          *
 422          * @param $title          Title object
 423          * @param $context        IContextSource
 424          * @param $including      Bool output is being captured for use in {{special:whatever}}
 425          *
 426          * @return bool
 427          */
 428         public static function executePath( Title &$title, IContextSource &$context, $including = false ) {
 429                 wfProfileIn( __METHOD__ );
 430
 431                 // @todo FIXME: Redirects broken due to this call
 432                 $bits = explode( '/', $title->getDBkey(), 2 );
 433                 $name = $bits[0];
 434                 if ( !isset( $bits[1] ) ) { // bug 2087
 435                         $par = null;
 436                 } else {
 437                         $par = $bits[1];
 438                 }
 439                 $page = self::getPage( $name );
 440                 // Nonexistent?
 441                 if ( !$page ) {
 442                         $context->getOutput()->setArticleRelated( false );
 443                         $context->getOutput()->setRobotPolicy( 'noindex,nofollow' );
 444
 445                         global $wgSend404Code;
 446                         if ( $wgSend404Code ) {
 447                                 $context->getOutput()->setStatusCode( 404 );
 448                         }
 449
 450                         $context->getOutput()->showErrorPage( 'nosuchspecialpage', 'nospecialpagetext' );
 451                         wfProfileOut( __METHOD__ );
 452                         return false;
 453                 }
 454
 455                 // Page exists, set the context
 456                 $page->setContext( $context );
 457
 458                 if ( !$including ) {
 459                         // Redirect to canonical alias for GET commands
 460                         // Not for POST, we'd lose the post data, so it's best to just distribute
 461                         // the request. Such POST requests are possible for old extensions that
 462                         // generate self-links without being aware that their default name has
 463                         // changed.
 464                         if ( $name != $page->getLocalName() && !$context->getRequest()->wasPosted() ) {
 465                                 $query = $context->getRequest()->getQueryValues();
 466                                 unset( $query['title'] );
 467                                 $title = $page->getTitle( $par );
 468                                 $url = $title->getFullURL( $query );
 469                                 $context->getOutput()->redirect( $url );
 470                                 wfProfileOut( __METHOD__ );
 471                                 return $title;
 472                         } else {
 473                                 $context->setTitle( $page->getTitle( $par ) );
 474                         }
 475
 476                 } elseif ( !$page->isIncludable() ) {
 477                         wfProfileOut( __METHOD__ );
 478                         return false;
 479                 }
 480
 481                 $page->including( $including );
 482
 483                 // Execute special page
 484                 $profName = 'Special:' . $page->getName();
 485                 wfProfileIn( $profName );
 486                 $page->run( $par );
 487                 wfProfileOut( $profName );
 488                 wfProfileOut( __METHOD__ );
 489                 return true;
 490         }
 491
 492         /**
 493          * Just like executePath() but will override global variables and execute
 494          * the page in "inclusion" mode. Returns true if the execution was
 495          * successful or false if there was no such special page, or a title object
 496          * if it was a redirect.
 497          *
 498          * Also saves the current $wgTitle, $wgOut, $wgRequest, $wgUser and $wgLang
 499          * variables so that the special page will get the context it'd expect on a
 500          * normal request, and then restores them to their previous values after.
 501          *
 502          * @param $title Title
 503          * @param $context IContextSource
 504          *
 505          * @return String: HTML fragment
 506          */
 507         static function capturePath( Title $title, IContextSource $context ) {
 508                 global $wgOut, $wgTitle, $wgRequest, $wgUser, $wgLang;
 509
 510                 // Save current globals
 511                 $oldTitle = $wgTitle;
 512                 $oldOut = $wgOut;
 513                 $oldRequest = $wgRequest;
 514                 $oldUser = $wgUser;
 515                 $oldLang = $wgLang;
 516
 517                 // Set the globals to the current context
 518                 $wgTitle = $title;
 519                 $wgOut = $context->getOutput();
 520                 $wgRequest = $context->getRequest();
 521                 $wgUser = $context->getUser();
 522                 $wgLang = $context->getLanguage();
 523
 524                 // The useful part
 525                 $ret = self::executePath( $title, $context, true );
 526
 527                 // And restore the old globals
 528                 $wgTitle = $oldTitle;
 529                 $wgOut = $oldOut;
 530                 $wgRequest = $oldRequest;
 531                 $wgUser = $oldUser;
 532                 $wgLang = $oldLang;
 533
 534                 return $ret;
 535         }
 536
 537         /**
 538          * Get the local name for a specified canonical name
 539          *
 540          * @param $name String
 541          * @param $subpage String|Bool
 542          *
 543          * @return String
 544          */
 545         static function getLocalNameFor( $name, $subpage = false ) {
 546                 global $wgContLang;
 547                 $aliases = $wgContLang->getSpecialPageAliases();
 548
 549                 if ( isset( $aliases[$name][0] ) ) {
 550                         $name = $aliases[$name][0];
 551                 } else {
 552                         // Try harder in case someone misspelled the correct casing
 553                         $found = false;
 554                         foreach ( $aliases as $n => $values ) {
 555                                 if ( strcasecmp( $name, $n ) === 0 ) {
 556                                         wfWarn( "Found alias defined for $n when searching for " .
 557                                                 "special page aliases for $name. Case mismatch?" );
 558                                         $name = $values[0];
 559                                         $found = true;
 560                                         break;
 561                                 }
 562                         }
 563                         if ( !$found ) {
 564                                 wfWarn( "Did not find alias for special page '$name'. " .
 565                                         "Perhaps no aliases are defined for it?" );
 566                         }
 567                 }
 568                 if ( $subpage !== false && !is_null( $subpage ) ) {
 569                         $name = "$name/$subpage";
 570                 }
 571                 return $wgContLang->ucfirst( $name );
 572         }
 573
 574         /**
 575          * Get a title for a given alias
 576          *
 577          * @param $alias String
 578          *
 579          * @return Title or null if there is no such alias
 580          */
 581         static function getTitleForAlias( $alias ) {
 582                 $name = self::resolveAlias( $alias );
 583                 if ( $name ) {
 584                         return SpecialPage::getTitleFor( $name );
 585                 } else {
 586                         return null;
 587                 }
 588         }
 589 }