includes/specialpage/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 namespace MediaWiki\Special;
  26
  27 use Hooks;
  28 use IContextSource;
  29 use Language;
  30 use MediaWiki\Config\ServiceOptions;
  31 use MediaWiki\Linker\LinkRenderer;
  32 use Profiler;
  33 use RequestContext;
  34 use SpecialPage;
  35 use Title;
  36 use User;
  37 use Wikimedia\ObjectFactory;
  38
  39 /**
  40  * Factory for handling the special page list and generating SpecialPage objects.
  41  *
  42  * To add a special page in an extension, add to $wgSpecialPages either
  43  * an object instance or an array containing the name and constructor
  44  * parameters. The latter is preferred for performance reasons.
  45  *
  46  * The object instantiated must be either an instance of SpecialPage or a
  47  * sub-class thereof. It must have an execute() method, which sends the HTML
  48  * for the special page to $wgOut. The parent class has an execute() method
  49  * which distributes the call to the historical global functions. Additionally,
  50  * execute() also checks if the user has the necessary access privileges
  51  * and bails out if not.
  52  *
  53  * To add a core special page, use the similar static list in
  54  * SpecialPageFactory::$list. To remove a core static special page at runtime, use
  55  * a SpecialPage_initList hook.
  56  *
  57  * @note There are two classes called SpecialPageFactory.  You should use this first one, in
  58  * namespace MediaWiki\Special, which is a service.  \SpecialPageFactory is a deprecated collection
  59  * of static methods that forwards to the global service.
  60  *
  61  * @ingroup SpecialPage
  62  * @since 1.17
  63  */
  64 class SpecialPageFactory {
  65         /**
  66          * List of special page names to the subclass of SpecialPage which handles them.
  67          * @todo Make this a const when we drop HHVM support (T192166).  It can still be private in PHP
  68          * 7.1.
  69          */
  70         private static $coreList = [
  71                 // Maintenance Reports
  72                 'BrokenRedirects' => \SpecialBrokenRedirects::class,
  73                 'Deadendpages' => \SpecialDeadendPages::class,
  74                 'DoubleRedirects' => \SpecialDoubleRedirects::class,
  75                 'Longpages' => \SpecialLongPages::class,
  76                 'Ancientpages' => \SpecialAncientPages::class,
  77                 'Lonelypages' => \SpecialLonelyPages::class,
  78                 'Fewestrevisions' => \SpecialFewestRevisions::class,
  79                 'Withoutinterwiki' => \SpecialWithoutInterwiki::class,
  80                 'Protectedpages' => \SpecialProtectedpages::class,
  81                 'Protectedtitles' => \SpecialProtectedtitles::class,
  82                 'Shortpages' => \SpecialShortPages::class,
  83                 'Uncategorizedcategories' => \SpecialUncategorizedCategories::class,
  84                 'Uncategorizedimages' => \SpecialUncategorizedImages::class,
  85                 'Uncategorizedpages' => \SpecialUncategorizedPages::class,
  86                 'Uncategorizedtemplates' => \SpecialUncategorizedTemplates::class,
  87                 'Unusedcategories' => \SpecialUnusedCategories::class,
  88                 'Unusedimages' => \SpecialUnusedImages::class,
  89                 'Unusedtemplates' => \SpecialUnusedTemplates::class,
  90                 'Unwatchedpages' => \SpecialUnwatchedPages::class,
  91                 'Wantedcategories' => \SpecialWantedCategories::class,
  92                 'Wantedfiles' => \WantedFilesPage::class,
  93                 'Wantedpages' => \WantedPagesPage::class,
  94                 'Wantedtemplates' => \SpecialWantedTemplates::class,
  95
  96                 // List of pages
  97                 'Allpages' => \SpecialAllPages::class,
  98                 'Prefixindex' => \SpecialPrefixindex::class,
  99                 'Categories' => \SpecialCategories::class,
 100                 'Listredirects' => \SpecialListRedirects::class,
 101                 'PagesWithProp' => \SpecialPagesWithProp::class,
 102                 'TrackingCategories' => \SpecialTrackingCategories::class,
 103
 104                 // Authentication
 105                 'Userlogin' => \SpecialUserLogin::class,
 106                 'Userlogout' => \SpecialUserLogout::class,
 107                 'CreateAccount' => \SpecialCreateAccount::class,
 108                 'LinkAccounts' => \SpecialLinkAccounts::class,
 109                 'UnlinkAccounts' => \SpecialUnlinkAccounts::class,
 110                 'ChangeCredentials' => \SpecialChangeCredentials::class,
 111                 'RemoveCredentials' => \SpecialRemoveCredentials::class,
 112
 113                 // Users and rights
 114                 'Activeusers' => \SpecialActiveUsers::class,
 115                 'Block' => \SpecialBlock::class,
 116                 'Unblock' => \SpecialUnblock::class,
 117                 'BlockList' => \SpecialBlockList::class,
 118                 'AutoblockList' => \SpecialAutoblockList::class,
 119                 'ChangePassword' => \SpecialChangePassword::class,
 120                 'BotPasswords' => \SpecialBotPasswords::class,
 121                 'PasswordReset' => \SpecialPasswordReset::class,
 122                 'DeletedContributions' => \SpecialDeletedContributions::class,
 123                 'Preferences' => \SpecialPreferences::class,
 124                 'ResetTokens' => \SpecialResetTokens::class,
 125                 'Contributions' => \SpecialContributions::class,
 126                 'Listgrouprights' => \SpecialListGroupRights::class,
 127                 'Listgrants' => \SpecialListGrants::class,
 128                 'Listusers' => \SpecialListUsers::class,
 129                 'Listadmins' => \SpecialListAdmins::class,
 130                 'Listbots' => \SpecialListBots::class,
 131                 'Userrights' => \UserrightsPage::class,
 132                 'EditWatchlist' => \SpecialEditWatchlist::class,
 133                 'PasswordPolicies' => \SpecialPasswordPolicies::class,
 134
 135                 // Recent changes and logs
 136                 'Newimages' => \SpecialNewFiles::class,
 137                 'Log' => \SpecialLog::class,
 138                 'Watchlist' => \SpecialWatchlist::class,
 139                 'Newpages' => \SpecialNewpages::class,
 140                 'Recentchanges' => \SpecialRecentChanges::class,
 141                 'Recentchangeslinked' => \SpecialRecentChangesLinked::class,
 142                 'Tags' => \SpecialTags::class,
 143
 144                 // Media reports and uploads
 145                 'Listfiles' => \SpecialListFiles::class,
 146                 'Filepath' => \SpecialFilepath::class,
 147                 'MediaStatistics' => \SpecialMediaStatistics::class,
 148                 'MIMEsearch' => \SpecialMIMESearch::class,
 149                 'FileDuplicateSearch' => \SpecialFileDuplicateSearch::class,
 150                 'Upload' => \SpecialUpload::class,
 151                 'UploadStash' => \SpecialUploadStash::class,
 152                 'ListDuplicatedFiles' => \SpecialListDuplicatedFiles::class,
 153
 154                 // Data and tools
 155                 'ApiSandbox' => \SpecialApiSandbox::class,
 156                 'Statistics' => \SpecialStatistics::class,
 157                 'Allmessages' => \SpecialAllMessages::class,
 158                 'Version' => \SpecialVersion::class,
 159                 'Lockdb' => \SpecialLockdb::class,
 160                 'Unlockdb' => \SpecialUnlockdb::class,
 161
 162                 // Redirecting special pages
 163                 'LinkSearch' => \SpecialLinkSearch::class,
 164                 'Randompage' => \RandomPage::class,
 165                 'RandomInCategory' => \SpecialRandomInCategory::class,
 166                 'Randomredirect' => \SpecialRandomredirect::class,
 167                 'Randomrootpage' => \SpecialRandomrootpage::class,
 168                 'GoToInterwiki' => \SpecialGoToInterwiki::class,
 169
 170                 // High use pages
 171                 'Mostlinkedcategories' => \SpecialMostLinkedCategories::class,
 172                 'Mostimages' => \MostimagesPage::class,
 173                 'Mostinterwikis' => \SpecialMostInterwikis::class,
 174                 'Mostlinked' => \SpecialMostLinked::class,
 175                 'Mostlinkedtemplates' => \SpecialMostLinkedTemplates::class,
 176                 'Mostcategories' => \SpecialMostCategories::class,
 177                 'Mostrevisions' => \SpecialMostRevisions::class,
 178
 179                 // Page tools
 180                 'ComparePages' => \SpecialComparePages::class,
 181                 'Export' => \SpecialExport::class,
 182                 'Import' => \SpecialImport::class,
 183                 'Undelete' => \SpecialUndelete::class,
 184                 'Whatlinkshere' => \SpecialWhatLinksHere::class,
 185                 'MergeHistory' => \SpecialMergeHistory::class,
 186                 'ExpandTemplates' => \SpecialExpandTemplates::class,
 187
 188                 // Other
 189                 'Booksources' => \SpecialBookSources::class,
 190
 191                 // Unlisted / redirects
 192                 'ApiHelp' => \SpecialApiHelp::class,
 193                 'Blankpage' => \SpecialBlankpage::class,
 194                 'Diff' => \SpecialDiff::class,
 195                 'EditTags' => [
 196                         'class' => \SpecialEditTags::class,
 197                         'services' => [
 198                                 'PermissionManager',
 199                         ],
 200                 ],
 201                 'Emailuser' => \SpecialEmailUser::class,
 202                 'Movepage' => \MovePageForm::class,
 203                 'Mycontributions' => \SpecialMycontributions::class,
 204                 'MyLanguage' => \SpecialMyLanguage::class,
 205                 'Mypage' => \SpecialMypage::class,
 206                 'Mytalk' => \SpecialMytalk::class,
 207                 'Myuploads' => \SpecialMyuploads::class,
 208                 'AllMyUploads' => \SpecialAllMyUploads::class,
 209                 'NewSection' => \SpecialNewSection::class,
 210                 'PermanentLink' => \SpecialPermanentLink::class,
 211                 'Redirect' => \SpecialRedirect::class,
 212                 'Revisiondelete' => [
 213                         'class' => \SpecialRevisionDelete::class,
 214                         'services' => [
 215                                 'PermissionManager',
 216                         ],
 217                 ],
 218                 'RunJobs' => \SpecialRunJobs::class,
 219                 'Specialpages' => \SpecialSpecialpages::class,
 220                 'PageData' => \SpecialPageData::class,
 221         ];
 222
 223         /** @var array Special page name => class name */
 224         private $list;
 225
 226         /** @var array */
 227         private $aliases;
 228
 229         /** @var ServiceOptions */
 230         private $options;
 231
 232         /** @var Language */
 233         private $contLang;
 234
 235         /** @var ObjectFactory */
 236         private $objectFactory;
 237
 238         /**
 239          * TODO Make this a const when HHVM support is dropped (T192166)
 240          *
 241          * @var array
 242          * @since 1.33
 243          */
 244         public static $constructorOptions = [
 245                 'ContentHandlerUseDB',
 246                 'DisableInternalSearch',
 247                 'EmailAuthentication',
 248                 'EnableEmail',
 249                 'EnableJavaScriptTest',
 250                 'EnableSpecialMute',
 251                 'PageLanguageUseDB',
 252                 'SpecialPages',
 253         ];
 254
 255         /**
 256          * @param ServiceOptions $options
 257          * @param Language $contLang
 258          * @param ObjectFactory $objectFactory
 259          */
 260         public function __construct(
 261                 ServiceOptions $options,
 262                 Language $contLang,
 263                 ObjectFactory $objectFactory
 264         ) {
 265                 $options->assertRequiredOptions( self::$constructorOptions );
 266                 $this->options = $options;
 267                 $this->contLang = $contLang;
 268                 $this->objectFactory = $objectFactory;
 269         }
 270
 271         /**
 272          * Returns a list of canonical special page names.
 273          * May be used to iterate over all registered special pages.
 274          *
 275          * @return string[]
 276          */
 277         public function getNames() : array {
 278                 return array_keys( $this->getPageList() );
 279         }
 280
 281         /**
 282          * Get the special page list as an array
 283          *
 284          * @return array
 285          */
 286         private function getPageList() : array {
 287                 if ( !is_array( $this->list ) ) {
 288                         $this->list = self::$coreList;
 289
 290                         if ( !$this->options->get( 'DisableInternalSearch' ) ) {
 291                                 $this->list['Search'] = \SpecialSearch::class;
 292                         }
 293
 294                         if ( $this->options->get( 'EmailAuthentication' ) ) {
 295                                 $this->list['Confirmemail'] = \SpecialConfirmEmail::class;
 296                                 $this->list['Invalidateemail'] = \SpecialEmailInvalidate::class;
 297                         }
 298
 299                         if ( $this->options->get( 'EnableEmail' ) ) {
 300                                 $this->list['ChangeEmail'] = \SpecialChangeEmail::class;
 301                         }
 302
 303                         if ( $this->options->get( 'EnableJavaScriptTest' ) ) {
 304                                 $this->list['JavaScriptTest'] = \SpecialJavaScriptTest::class;
 305                         }
 306
 307                         if ( $this->options->get( 'EnableSpecialMute' ) ) {
 308                                 $this->list['Mute'] = \SpecialMute::class;
 309                         }
 310
 311                         if ( $this->options->get( 'PageLanguageUseDB' ) ) {
 312                                 $this->list['PageLanguage'] = \SpecialPageLanguage::class;
 313                         }
 314
 315                         if ( $this->options->get( 'ContentHandlerUseDB' ) ) {
 316                                 $this->list['ChangeContentModel'] = \SpecialChangeContentModel::class;
 317                         }
 318
 319                         // Add extension special pages
 320                         $this->list = array_merge( $this->list, $this->options->get( 'SpecialPages' ) );
 321
 322                         // This hook can be used to disable unwanted core special pages
 323                         // or conditionally register special pages.
 324                         Hooks::run( 'SpecialPage_initList', [ &$this->list ] );
 325
 326                 }
 327
 328                 return $this->list;
 329         }
 330
 331         /**
 332          * Initialise and return the list of special page aliases. Returns an array where
 333          * the key is an alias, and the value is the canonical name of the special page.
 334          * All registered special pages are guaranteed to map to themselves.
 335          * @return array
 336          */
 337         private function getAliasList() : array {
 338                 if ( is_null( $this->aliases ) ) {
 339                         $aliases = $this->contLang->getSpecialPageAliases();
 340                         $pageList = $this->getPageList();
 341
 342                         $this->aliases = [];
 343                         $keepAlias = [];
 344
 345                         // Force every canonical name to be an alias for itself.
 346                         foreach ( $pageList as $name => $stuff ) {
 347                                 $caseFoldedAlias = $this->contLang->caseFold( $name );
 348                                 $this->aliases[$caseFoldedAlias] = $name;
 349                                 $keepAlias[$caseFoldedAlias] = 'canonical';
 350                         }
 351
 352                         // Check for $aliases being an array since Language::getSpecialPageAliases can return null
 353                         if ( is_array( $aliases ) ) {
 354                                 foreach ( $aliases as $realName => $aliasList ) {
 355                                         $aliasList = array_values( $aliasList );
 356                                         foreach ( $aliasList as $i => $alias ) {
 357                                                 $caseFoldedAlias = $this->contLang->caseFold( $alias );
 358
 359                                                 if ( isset( $this->aliases[$caseFoldedAlias] ) &&
 360                                                         $realName === $this->aliases[$caseFoldedAlias]
 361                                                 ) {
 362                                                         // Ignore same-realName conflicts
 363                                                         continue;
 364                                                 }
 365
 366                                                 if ( !isset( $keepAlias[$caseFoldedAlias] ) ) {
 367                                                         $this->aliases[$caseFoldedAlias] = $realName;
 368                                                         if ( !$i ) {
 369                                                                 $keepAlias[$caseFoldedAlias] = 'first';
 370                                                         }
 371                                                 } elseif ( !$i ) {
 372                                                         wfWarn( "First alias '$alias' for $realName conflicts with " .
 373                                                                 "{$keepAlias[$caseFoldedAlias]} alias for " .
 374                                                                 $this->aliases[$caseFoldedAlias]
 375                                                         );
 376                                                 }
 377                                         }
 378                                 }
 379                         }
 380                 }
 381
 382                 return $this->aliases;
 383         }
 384
 385         /**
 386          * Given a special page name with a possible subpage, return an array
 387          * where the first element is the special page name and the second is the
 388          * subpage.
 389          *
 390          * @param string $alias
 391          * @return array [ String, String|null ], or [ null, null ] if the page is invalid
 392          */
 393         public function resolveAlias( $alias ) {
 394                 $bits = explode( '/', $alias, 2 );
 395
 396                 $caseFoldedAlias = $this->contLang->caseFold( $bits[0] );
 397                 $caseFoldedAlias = str_replace( ' ', '_', $caseFoldedAlias );
 398                 $aliases = $this->getAliasList();
 399                 if ( !isset( $aliases[$caseFoldedAlias] ) ) {
 400                         return [ null, null ];
 401                 }
 402                 $name = $aliases[$caseFoldedAlias];
 403                 $par = $bits[1] ?? null; // T4087
 404
 405                 return [ $name, $par ];
 406         }
 407
 408         /**
 409          * Check if a given name exist as a special page or as a special page alias
 410          *
 411          * @param string $name Name of a special page
 412          * @return bool True if a special page exists with this name
 413          */
 414         public function exists( $name ) {
 415                 list( $title, /*...*/ ) = $this->resolveAlias( $name );
 416
 417                 $specialPageList = $this->getPageList();
 418                 return isset( $specialPageList[$title] );
 419         }
 420
 421         /**
 422          * Find the object with a given name and return it (or NULL)
 423          *
 424          * @param string $name Special page name, may be localised and/or an alias
 425          * @return SpecialPage|null SpecialPage object or null if the page doesn't exist
 426          */
 427         public function getPage( $name ) {
 428                 list( $realName, /*...*/ ) = $this->resolveAlias( $name );
 429
 430                 $specialPageList = $this->getPageList();
 431
 432                 if ( isset( $specialPageList[$realName] ) ) {
 433                         $rec = $specialPageList[$realName];
 434
 435                         if ( $rec instanceof SpecialPage ) {
 436                                 wfDeprecated(
 437                                         "a SpecialPage instance (for $realName) in " .
 438                                         '$wgSpecialPages or from the SpecialPage_initList hook',
 439                                         '1.34'
 440                                 );
 441
 442                                 $page = $rec; // XXX: we should deep clone here
 443                         } elseif ( is_array( $rec ) || is_string( $rec ) || is_callable( $rec ) ) {
 444                                 $page = $this->objectFactory->createObject(
 445                                         $rec,
 446                                         [
 447                                                 'allowClassName' => true,
 448                                                 'allowCallable' => true
 449                                         ]
 450                                 );
 451                         } else {
 452                                 $page = null;
 453                         }
 454
 455                         if ( $page instanceof SpecialPage ) {
 456                                 return $page;
 457                         }
 458
 459                         // It's not a classname, nor a callback, nor a legacy constructor array,
 460                         // nor a special page object. Give up.
 461                         wfLogWarning( "Cannot instantiate special page $realName: bad spec!" );
 462                 }
 463
 464                 return null;
 465         }
 466
 467         /**
 468          * Return categorised listable special pages which are available
 469          * for the current user, and everyone.
 470          *
 471          * @param User $user User object to check permissions
 472          *  provided
 473          * @return array ( string => Specialpage )
 474          */
 475         public function getUsablePages( User $user ) : array {
 476                 $pages = [];
 477                 foreach ( $this->getPageList() as $name => $rec ) {
 478                         $page = $this->getPage( $name );
 479                         if ( $page ) { // not null
 480                                 $page->setContext( RequestContext::getMain() );
 481                                 if ( $page->isListed()
 482                                         && ( !$page->isRestricted() || $page->userCanExecute( $user ) )
 483                                 ) {
 484                                         $pages[$name] = $page;
 485                                 }
 486                         }
 487                 }
 488
 489                 return $pages;
 490         }
 491
 492         /**
 493          * Return categorised listable special pages for all users
 494          *
 495          * @return array ( string => Specialpage )
 496          */
 497         public function getRegularPages() : array {
 498                 $pages = [];
 499                 foreach ( $this->getPageList() as $name => $rec ) {
 500                         $page = $this->getPage( $name );
 501                         if ( $page && $page->isListed() && !$page->isRestricted() ) {
 502                                 $pages[$name] = $page;
 503                         }
 504                 }
 505
 506                 return $pages;
 507         }
 508
 509         /**
 510          * Return categorised listable special pages which are available
 511          * for the current user, but not for everyone
 512          *
 513          * @param User $user User object to use
 514          * @return array ( string => Specialpage )
 515          */
 516         public function getRestrictedPages( User $user ) : array {
 517                 $pages = [];
 518                 foreach ( $this->getPageList() as $name => $rec ) {
 519                         $page = $this->getPage( $name );
 520                         if ( $page
 521                                 && $page->isListed()
 522                                 && $page->isRestricted()
 523                                 && $page->userCanExecute( $user )
 524                         ) {
 525                                 $pages[$name] = $page;
 526                         }
 527                 }
 528
 529                 return $pages;
 530         }
 531
 532         /**
 533          * Execute a special page path.
 534          * The path may contain parameters, e.g. Special:Name/Params
 535          * Extracts the special page name and call the execute method, passing the parameters
 536          *
 537          * Returns a title object if the page is redirected, false if there was no such special
 538          * page, and true if it was successful.
 539          *
 540          * @param Title &$title
 541          * @param IContextSource &$context
 542          * @param bool $including Bool output is being captured for use in {{special:whatever}}
 543          * @param LinkRenderer|null $linkRenderer (since 1.28)
 544          *
 545          * @return bool|Title
 546          */
 547         public function executePath( Title &$title, IContextSource &$context, $including = false,
 548                 LinkRenderer $linkRenderer = null
 549         ) {
 550                 // @todo FIXME: Redirects broken due to this call
 551                 $bits = explode( '/', $title->getDBkey(), 2 );
 552                 $name = $bits[0];
 553                 $par = $bits[1] ?? null; // T4087
 554
 555                 $page = $this->getPage( $name );
 556                 if ( !$page ) {
 557                         $context->getOutput()->setArticleRelated( false );
 558                         $context->getOutput()->setRobotPolicy( 'noindex,nofollow' );
 559
 560                         global $wgSend404Code;
 561                         if ( $wgSend404Code ) {
 562                                 $context->getOutput()->setStatusCode( 404 );
 563                         }
 564
 565                         $context->getOutput()->showErrorPage( 'nosuchspecialpage', 'nospecialpagetext' );
 566
 567                         return false;
 568                 }
 569
 570                 if ( !$including ) {
 571                         // Narrow DB query expectations for this HTTP request
 572                         $trxLimits = $context->getConfig()->get( 'TrxProfilerLimits' );
 573                         $trxProfiler = Profiler::instance()->getTransactionProfiler();
 574                         if ( $context->getRequest()->wasPosted() && !$page->doesWrites() ) {
 575                                 $trxProfiler->setExpectations( $trxLimits['POST-nonwrite'], __METHOD__ );
 576                                 $context->getRequest()->markAsSafeRequest();
 577                         }
 578                 }
 579
 580                 // Page exists, set the context
 581                 $page->setContext( $context );
 582
 583                 if ( !$including ) {
 584                         // Redirect to canonical alias for GET commands
 585                         // Not for POST, we'd lose the post data, so it's best to just distribute
 586                         // the request. Such POST requests are possible for old extensions that
 587                         // generate self-links without being aware that their default name has
 588                         // changed.
 589                         if ( $name != $page->getLocalName() && !$context->getRequest()->wasPosted() ) {
 590                                 $query = $context->getRequest()->getQueryValues();
 591                                 unset( $query['title'] );
 592                                 $title = $page->getPageTitle( $par );
 593                                 $url = $title->getFullURL( $query );
 594                                 $context->getOutput()->redirect( $url );
 595
 596                                 return $title;
 597                         }
 598
 599                         // @phan-suppress-next-line PhanUndeclaredMethod
 600                         $context->setTitle( $page->getPageTitle( $par ) );
 601                 } elseif ( !$page->isIncludable() ) {
 602                         return false;
 603                 }
 604
 605                 $page->including( $including );
 606                 if ( $linkRenderer ) {
 607                         $page->setLinkRenderer( $linkRenderer );
 608                 }
 609
 610                 // Execute special page
 611                 $page->run( $par );
 612
 613                 return true;
 614         }
 615
 616         /**
 617          * Just like executePath() but will override global variables and execute
 618          * the page in "inclusion" mode. Returns true if the execution was
 619          * successful or false if there was no such special page, or a title object
 620          * if it was a redirect.
 621          *
 622          * Also saves the current $wgTitle, $wgOut, $wgRequest, $wgUser and $wgLang
 623          * variables so that the special page will get the context it'd expect on a
 624          * normal request, and then restores them to their previous values after.
 625          *
 626          * @param Title $title
 627          * @param IContextSource $context
 628          * @param LinkRenderer|null $linkRenderer (since 1.28)
 629          * @return string HTML fragment
 630          */
 631         public function capturePath(
 632                 Title $title, IContextSource $context, LinkRenderer $linkRenderer = null
 633         ) {
 634                 global $wgTitle, $wgOut, $wgRequest, $wgUser, $wgLang;
 635                 $main = RequestContext::getMain();
 636
 637                 // Save current globals and main context
 638                 $glob = [
 639                         'title' => $wgTitle,
 640                         'output' => $wgOut,
 641                         'request' => $wgRequest,
 642                         'user' => $wgUser,
 643                         'language' => $wgLang,
 644                 ];
 645                 $ctx = [
 646                         'title' => $main->getTitle(),
 647                         'output' => $main->getOutput(),
 648                         'request' => $main->getRequest(),
 649                         'user' => $main->getUser(),
 650                         'language' => $main->getLanguage(),
 651                 ];
 652                 if ( $main->canUseWikiPage() ) {
 653                         $ctx['wikipage'] = $main->getWikiPage();
 654                 }
 655
 656                 // Override
 657                 $wgTitle = $title;
 658                 $wgOut = $context->getOutput();
 659                 $wgRequest = $context->getRequest();
 660                 $wgUser = $context->getUser();
 661                 $wgLang = $context->getLanguage();
 662                 $main->setTitle( $title );
 663                 $main->setOutput( $context->getOutput() );
 664                 $main->setRequest( $context->getRequest() );
 665                 $main->setUser( $context->getUser() );
 666                 $main->setLanguage( $context->getLanguage() );
 667
 668                 // The useful part
 669                 $ret = $this->executePath( $title, $context, true, $linkRenderer );
 670
 671                 // Restore old globals and context
 672                 $wgTitle = $glob['title'];
 673                 $wgOut = $glob['output'];
 674                 $wgRequest = $glob['request'];
 675                 $wgUser = $glob['user'];
 676                 $wgLang = $glob['language'];
 677                 $main->setTitle( $ctx['title'] );
 678                 $main->setOutput( $ctx['output'] );
 679                 $main->setRequest( $ctx['request'] );
 680                 $main->setUser( $ctx['user'] );
 681                 $main->setLanguage( $ctx['language'] );
 682                 if ( isset( $ctx['wikipage'] ) ) {
 683                         $main->setWikiPage( $ctx['wikipage'] );
 684                 }
 685
 686                 return $ret;
 687         }
 688
 689         /**
 690          * Get the local name for a specified canonical name
 691          *
 692          * @param string $name
 693          * @param string|bool $subpage
 694          * @return string
 695          */
 696         public function getLocalNameFor( $name, $subpage = false ) {
 697                 $aliases = $this->contLang->getSpecialPageAliases();
 698                 $aliasList = $this->getAliasList();
 699
 700                 // Find the first alias that maps back to $name
 701                 if ( isset( $aliases[$name] ) ) {
 702                         $found = false;
 703                         foreach ( $aliases[$name] as $alias ) {
 704                                 $caseFoldedAlias = $this->contLang->caseFold( $alias );
 705                                 $caseFoldedAlias = str_replace( ' ', '_', $caseFoldedAlias );
 706                                 if ( isset( $aliasList[$caseFoldedAlias] ) &&
 707                                         $aliasList[$caseFoldedAlias] === $name
 708                                 ) {
 709                                         $name = $alias;
 710                                         $found = true;
 711                                         break;
 712                                 }
 713                         }
 714                         if ( !$found ) {
 715                                 wfWarn( "Did not find a usable alias for special page '$name'. " .
 716                                         "It seems all defined aliases conflict?" );
 717                         }
 718                 } else {
 719                         // Check if someone misspelled the correct casing
 720                         if ( is_array( $aliases ) ) {
 721                                 foreach ( $aliases as $n => $values ) {
 722                                         if ( strcasecmp( $name, $n ) === 0 ) {
 723                                                 wfWarn( "Found alias defined for $n when searching for " .
 724                                                         "special page aliases for $name. Case mismatch?" );
 725                                                 return $this->getLocalNameFor( $n, $subpage );
 726                                         }
 727                                 }
 728                         }
 729
 730                         wfWarn( "Did not find alias for special page '$name'. " .
 731                                 "Perhaps no aliases are defined for it?" );
 732                 }
 733
 734                 if ( $subpage !== false && !is_null( $subpage ) ) {
 735                         // Make sure it's in dbkey form
 736                         $subpage = str_replace( ' ', '_', $subpage );
 737                         $name = "$name/$subpage";
 738                 }
 739
 740                 return $this->contLang->ucfirst( $name );
 741         }
 742
 743         /**
 744          * Get a title for a given alias
 745          *
 746          * @param string $alias
 747          * @return Title|null Title or null if there is no such alias
 748          */
 749         public function getTitleForAlias( $alias ) {
 750                 list( $name, $subpage ) = $this->resolveAlias( $alias );
 751                 if ( $name != null ) {
 752                         return SpecialPage::getTitleFor( $name, $subpage );
 753                 }
 754
 755                 return null;
 756         }
 757 }