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 /**
  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  * SpecialPageFactory::$list. 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          * List of special page names to the subclass of SpecialPage which handles them.
  49          */
  50         private static $coreList = array(
  51                 // Maintenance Reports
  52                 'BrokenRedirects' => 'BrokenRedirectsPage',
  53                 'Deadendpages' => 'DeadendPagesPage',
  54                 'DoubleRedirects' => 'DoubleRedirectsPage',
  55                 'Longpages' => 'LongPagesPage',
  56                 'Ancientpages' => 'AncientPagesPage',
  57                 'Lonelypages' => 'LonelyPagesPage',
  58                 'Fewestrevisions' => 'FewestrevisionsPage',
  59                 'Withoutinterwiki' => 'WithoutInterwikiPage',
  60                 'Protectedpages' => 'SpecialProtectedpages',
  61                 'Protectedtitles' => 'SpecialProtectedtitles',
  62                 'Shortpages' => 'ShortPagesPage',
  63                 'Uncategorizedcategories' => 'UncategorizedCategoriesPage',
  64                 'Uncategorizedimages' => 'UncategorizedImagesPage',
  65                 'Uncategorizedpages' => 'UncategorizedPagesPage',
  66                 'Uncategorizedtemplates' => 'UncategorizedTemplatesPage',
  67                 'Unusedcategories' => 'UnusedCategoriesPage',
  68                 'Unusedimages' => 'UnusedimagesPage',
  69                 'Unusedtemplates' => 'UnusedtemplatesPage',
  70                 'Unwatchedpages' => 'UnwatchedpagesPage',
  71                 'Wantedcategories' => 'WantedCategoriesPage',
  72                 'Wantedfiles' => 'WantedFilesPage',
  73                 'Wantedpages' => 'WantedPagesPage',
  74                 'Wantedtemplates' => 'WantedTemplatesPage',
  75
  76                 // List of pages
  77                 'Allpages' => 'SpecialAllPages',
  78                 'Prefixindex' => 'SpecialPrefixindex',
  79                 'Categories' => 'SpecialCategories',
  80                 'Listredirects' => 'ListredirectsPage',
  81                 'PagesWithProp' => 'SpecialPagesWithProp',
  82                 'TrackingCategories' => 'SpecialTrackingCategories',
  83
  84                 // Login/create account
  85                 'Userlogin' => 'LoginForm',
  86                 'CreateAccount' => 'SpecialCreateAccount',
  87
  88                 // Users and rights
  89                 'Block' => 'SpecialBlock',
  90                 'Unblock' => 'SpecialUnblock',
  91                 'BlockList' => 'SpecialBlockList',
  92                 'ChangePassword' => 'SpecialChangePassword',
  93                 'PasswordReset' => 'SpecialPasswordReset',
  94                 'DeletedContributions' => 'DeletedContributionsPage',
  95                 'Preferences' => 'SpecialPreferences',
  96                 'ResetTokens' => 'SpecialResetTokens',
  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                 'MediaStatistics' => 'MediaStatisticsPage',
 118                 'MIMEsearch' => 'MIMEsearchPage',
 119                 'FileDuplicateSearch' => 'FileDuplicateSearchPage',
 120                 'Upload' => 'SpecialUpload',
 121                 'UploadStash' => 'SpecialUploadStash',
 122                 'ListDuplicatedFiles' => 'ListDuplicatedFilesPage',
 123
 124                 // Data and tools
 125                 'Statistics' => 'SpecialStatistics',
 126                 'Allmessages' => 'SpecialAllMessages',
 127                 'Version' => 'SpecialVersion',
 128                 'Lockdb' => 'SpecialLockdb',
 129                 'Unlockdb' => 'SpecialUnlockdb',
 130
 131                 // Redirecting special pages
 132                 'LinkSearch' => 'LinkSearchPage',
 133                 'Randompage' => 'RandomPage',
 134                 'RandomInCategory' => 'SpecialRandomInCategory',
 135                 'Randomredirect' => 'SpecialRandomredirect',
 136
 137                 // High use pages
 138                 'Mostlinkedcategories' => 'MostlinkedCategoriesPage',
 139                 'Mostimages' => 'MostimagesPage',
 140                 'Mostinterwikis' => 'MostinterwikisPage',
 141                 'Mostlinked' => 'MostlinkedPage',
 142                 'Mostlinkedtemplates' => 'MostlinkedTemplatesPage',
 143                 'Mostcategories' => 'MostcategoriesPage',
 144                 'Mostrevisions' => 'MostrevisionsPage',
 145
 146                 // Page tools
 147                 'ComparePages' => 'SpecialComparePages',
 148                 'Export' => 'SpecialExport',
 149                 'Import' => 'SpecialImport',
 150                 'Undelete' => 'SpecialUndelete',
 151                 'Whatlinkshere' => 'SpecialWhatLinksHere',
 152                 'MergeHistory' => 'SpecialMergeHistory',
 153                 'ExpandTemplates' => 'SpecialExpandTemplates',
 154
 155                 // Other
 156                 'Booksources' => 'SpecialBookSources',
 157
 158                 // Unlisted / redirects
 159                 'ApiHelp' => 'SpecialApiHelp',
 160                 'Blankpage' => 'SpecialBlankpage',
 161                 'Diff' => 'SpecialDiff',
 162                 'Emailuser' => 'SpecialEmailUser',
 163                 'Movepage' => 'MovePageForm',
 164                 'Mycontributions' => 'SpecialMycontributions',
 165                 'MyLanguage' => 'SpecialMyLanguage',
 166                 'Mypage' => 'SpecialMypage',
 167                 'Mytalk' => 'SpecialMytalk',
 168                 'Myuploads' => 'SpecialMyuploads',
 169                 'AllMyUploads' => 'SpecialAllMyUploads',
 170                 'PermanentLink' => 'SpecialPermanentLink',
 171                 'Redirect' => 'SpecialRedirect',
 172                 'Revisiondelete' => 'SpecialRevisionDelete',
 173                 'RunJobs' => 'SpecialRunJobs',
 174                 'Specialpages' => 'SpecialSpecialpages',
 175                 'Userlogout' => 'SpecialUserlogout',
 176         );
 177
 178         private static $list;
 179         private static $aliases;
 180
 181         /**
 182          * Reset the internal list of special pages. Useful when changing $wgSpecialPages after
 183          * the internal list has already been initialized, e.g. during testing.
 184          */
 185         public static function resetList() {
 186                 self::$list = null;
 187                 self::$aliases = null;
 188         }
 189
 190         /**
 191          * Returns a list of canonical special page names.
 192          * May be used to iterate over all registered special pages.
 193          *
 194          * @return string[]
 195          */
 196         public static function getNames() {
 197                 return array_keys( self::getPageList() );
 198         }
 199
 200         /**
 201          * Get the special page list as an array
 202          *
 203          * @deprecated since 1.24, use getNames() instead.
 204          * @return array
 205          */
 206         public static function getList() {
 207                 wfDeprecated( __FUNCTION__, '1.24' );
 208                 return self::getPageList();
 209         }
 210
 211         /**
 212          * Get the special page list as an array
 213          *
 214          * @return array
 215          */
 216         private static function getPageList() {
 217                 global $wgSpecialPages;
 218                 global $wgDisableInternalSearch, $wgEmailAuthentication;
 219                 global $wgEnableEmail, $wgEnableJavaScriptTest;
 220                 global $wgPageLanguageUseDB;
 221
 222                 if ( !is_array( self::$list ) ) {
 223
 224                         self::$list = self::$coreList;
 225
 226                         if ( !$wgDisableInternalSearch ) {
 227                                 self::$list['Search'] = 'SpecialSearch';
 228                         }
 229
 230                         if ( $wgEmailAuthentication ) {
 231                                 self::$list['Confirmemail'] = 'EmailConfirmation';
 232                                 self::$list['Invalidateemail'] = 'EmailInvalidation';
 233                         }
 234
 235                         if ( $wgEnableEmail ) {
 236                                 self::$list['ChangeEmail'] = 'SpecialChangeEmail';
 237                         }
 238
 239                         if ( $wgEnableJavaScriptTest ) {
 240                                 self::$list['JavaScriptTest'] = 'SpecialJavaScriptTest';
 241                         }
 242
 243                         if ( $wgPageLanguageUseDB ) {
 244                                 self::$list['PageLanguage'] = 'SpecialPageLanguage';
 245                         }
 246
 247                         self::$list['Activeusers'] = 'SpecialActiveUsers';
 248
 249                         // Add extension special pages
 250                         self::$list = array_merge( self::$list, $wgSpecialPages );
 251
 252                         // Run hooks
 253                         // This hook can be used to remove undesired built-in special pages
 254                         Hooks::run( 'SpecialPage_initList', array( &self::$list ) );
 255
 256                 }
 257
 258                 return self::$list;
 259         }
 260
 261         /**
 262          * Initialise and return the list of special page aliases.  Returns an object with
 263          * properties which can be accessed $obj->pagename - each property name is an
 264          * alias, with the value being the canonical name of the special page. All
 265          * registered special pages are guaranteed to map to themselves.
 266          * @return object
 267          */
 268         private static function getAliasListObject() {
 269                 if ( !is_object( self::$aliases ) ) {
 270                         global $wgContLang;
 271                         $aliases = $wgContLang->getSpecialPageAliases();
 272                         $pageList = self::getPageList();
 273
 274                         self::$aliases = array();
 275                         $keepAlias = array();
 276
 277                         // Force every canonical name to be an alias for itself.
 278                         foreach ( $pageList as $name => $stuff ) {
 279                                 $caseFoldedAlias = $wgContLang->caseFold( $name );
 280                                 self::$aliases[$caseFoldedAlias] = $name;
 281                                 $keepAlias[$caseFoldedAlias] = 'canonical';
 282                         }
 283
 284                         // Check for $aliases being an array since Language::getSpecialPageAliases can return null
 285                         if ( is_array( $aliases ) ) {
 286                                 foreach ( $aliases as $realName => $aliasList ) {
 287                                         $aliasList = array_values( $aliasList );
 288                                         foreach ( $aliasList as $i => $alias ) {
 289                                                 $caseFoldedAlias = $wgContLang->caseFold( $alias );
 290
 291                                                 if ( isset( self::$aliases[$caseFoldedAlias] ) &&
 292                                                         $realName === self::$aliases[$caseFoldedAlias]
 293                                                 ) {
 294                                                         // Ignore same-realName conflicts
 295                                                         continue;
 296                                                 }
 297
 298                                                 if ( !isset( $keepAlias[$caseFoldedAlias] ) ) {
 299                                                         self::$aliases[$caseFoldedAlias] = $realName;
 300                                                         if ( !$i ) {
 301                                                                 $keepAlias[$caseFoldedAlias] = 'first';
 302                                                         }
 303                                                 } elseif ( !$i ) {
 304                                                         wfWarn( "First alias '$alias' for $realName conflicts with " .
 305                                                                 "{$keepAlias[$caseFoldedAlias]} alias for " .
 306                                                                 self::$aliases[$caseFoldedAlias]
 307                                                         );
 308                                                 }
 309                                         }
 310                                 }
 311                         }
 312
 313                         // Cast to object: func()[$key] doesn't work, but func()->$key does
 314                         self::$aliases = (object)self::$aliases;
 315                 }
 316
 317                 return self::$aliases;
 318         }
 319
 320         /**
 321          * Given a special page name with a possible subpage, return an array
 322          * where the first element is the special page name and the second is the
 323          * subpage.
 324          *
 325          * @param string $alias
 326          * @return array Array( String, String|null ), or array( null, null ) if the page is invalid
 327          */
 328         public static function resolveAlias( $alias ) {
 329                 global $wgContLang;
 330                 $bits = explode( '/', $alias, 2 );
 331
 332                 $caseFoldedAlias = $wgContLang->caseFold( $bits[0] );
 333                 $caseFoldedAlias = str_replace( ' ', '_', $caseFoldedAlias );
 334                 if ( isset( self::getAliasListObject()->$caseFoldedAlias ) ) {
 335                         $name = self::getAliasListObject()->$caseFoldedAlias;
 336                 } else {
 337                         return array( null, null );
 338                 }
 339
 340                 if ( !isset( $bits[1] ) ) { // bug 2087
 341                         $par = null;
 342                 } else {
 343                         $par = $bits[1];
 344                 }
 345
 346                 return array( $name, $par );
 347         }
 348
 349         /**
 350          * Add a page to a certain display group for Special:SpecialPages
 351          *
 352          * @param SpecialPage|string $page
 353          * @param string $group
 354          * @deprecated since 1.21 Override SpecialPage::getGroupName
 355          */
 356         public static function setGroup( $page, $group ) {
 357                 wfDeprecated( __METHOD__, '1.21' );
 358
 359                 global $wgSpecialPageGroups;
 360                 $name = is_object( $page ) ? $page->getName() : $page;
 361                 $wgSpecialPageGroups[$name] = $group;
 362         }
 363
 364         /**
 365          * Get the group that the special page belongs in on Special:SpecialPage
 366          *
 367          * @param SpecialPage $page
 368          * @return string
 369          * @deprecated since 1.21 Use SpecialPage::getFinalGroupName
 370          */
 371         public static function getGroup( &$page ) {
 372                 wfDeprecated( __METHOD__, '1.21' );
 373
 374                 return $page->getFinalGroupName();
 375         }
 376
 377         /**
 378          * Check if a given name exist as a special page or as a special page alias
 379          *
 380          * @param string $name Name of a special page
 381          * @return bool True if a special page exists with this name
 382          */
 383         public static function exists( $name ) {
 384                 list( $title, /*...*/ ) = self::resolveAlias( $name );
 385
 386                 $specialPageList = self::getPageList();
 387                 return isset( $specialPageList[$title] );
 388         }
 389
 390         /**
 391          * Find the object with a given name and return it (or NULL)
 392          *
 393          * @param string $name Special page name, may be localised and/or an alias
 394          * @return SpecialPage|null SpecialPage object or null if the page doesn't exist
 395          */
 396         public static function getPage( $name ) {
 397                 list( $realName, /*...*/ ) = self::resolveAlias( $name );
 398
 399                 $specialPageList = self::getPageList();
 400
 401                 if ( isset( $specialPageList[$realName] ) ) {
 402                         $rec = $specialPageList[$realName];
 403
 404                         if ( is_callable( $rec ) ) {
 405                                 // Use callback to instantiate the special page
 406                                 $page = call_user_func( $rec );
 407                         } elseif ( is_string( $rec ) ) {
 408                                 $className = $rec;
 409                                 $page = new $className;
 410                         } elseif ( is_array( $rec ) ) {
 411                                 $className = array_shift( $rec );
 412                                 // @deprecated, officially since 1.18, unofficially since forever
 413                                 wfDeprecated( "Array syntax for \$wgSpecialPages is deprecated ($className), " .
 414                                         "define a subclass of SpecialPage instead.", '1.18' );
 415                                 $page = ObjectFactory::getObjectFromSpec( array(
 416                                         'class' => $className,
 417                                         'args' => $rec,
 418                                         'closure_expansion' => false,
 419                                 ) );
 420                         } elseif ( $rec instanceof SpecialPage ) {
 421                                 $page = $rec; //XXX: we should deep clone here
 422                         } else {
 423                                 $page = null;
 424                         }
 425
 426                         if ( $page instanceof SpecialPage ) {
 427                                 return $page;
 428                         } else {
 429                                 // It's not a classname, nor a callback, nor a legacy constructor array,
 430                                 // nor a special page object. Give up.
 431                                 wfLogWarning( "Cannot instantiate special page $realName: bad spec!" );
 432                                 return null;
 433                         }
 434
 435                 } else {
 436                         return null;
 437                 }
 438         }
 439
 440         /**
 441          * Return categorised listable special pages which are available
 442          * for the current user, and everyone.
 443          *
 444          * @param User $user User object to check permissions, $wgUser will be used
 445          *        if not provided
 446          * @return array ( string => Specialpage )
 447          */
 448         public static function getUsablePages( User $user = null ) {
 449                 $pages = array();
 450                 if ( $user === null ) {
 451                         global $wgUser;
 452                         $user = $wgUser;
 453                 }
 454                 foreach ( self::getPageList() as $name => $rec ) {
 455                         $page = self::getPage( $name );
 456                         if ( $page ) { // not null
 457                                 $page->setContext( RequestContext::getMain() );
 458                                 if ( $page->isListed()
 459                                         && ( !$page->isRestricted() || $page->userCanExecute( $user ) )
 460                                 ) {
 461                                         $pages[$name] = $page;
 462                                 }
 463                         }
 464                 }
 465
 466                 return $pages;
 467         }
 468
 469         /**
 470          * Return categorised listable special pages for all users
 471          *
 472          * @return array ( string => Specialpage )
 473          */
 474         public static function getRegularPages() {
 475                 $pages = array();
 476                 foreach ( self::getPageList() as $name => $rec ) {
 477                         $page = self::getPage( $name );
 478                         if ( $page->isListed() && !$page->isRestricted() ) {
 479                                 $pages[$name] = $page;
 480                         }
 481                 }
 482
 483                 return $pages;
 484         }
 485
 486         /**
 487          * Return categorised listable special pages which are available
 488          * for the current user, but not for everyone
 489          *
 490          * @param User|null $user User object to use or null for $wgUser
 491          * @return array ( string => Specialpage )
 492          */
 493         public static function getRestrictedPages( User $user = null ) {
 494                 $pages = array();
 495                 if ( $user === null ) {
 496                         global $wgUser;
 497                         $user = $wgUser;
 498                 }
 499                 foreach ( self::getPageList() as $name => $rec ) {
 500                         $page = self::getPage( $name );
 501                         if (
 502                                 $page->isListed()
 503                                 && $page->isRestricted()
 504                                 && $page->userCanExecute( $user )
 505                         ) {
 506                                 $pages[$name] = $page;
 507                         }
 508                 }
 509
 510                 return $pages;
 511         }
 512
 513         /**
 514          * Execute a special page path.
 515          * The path may contain parameters, e.g. Special:Name/Params
 516          * Extracts the special page name and call the execute method, passing the parameters
 517          *
 518          * Returns a title object if the page is redirected, false if there was no such special
 519          * page, and true if it was successful.
 520          *
 521          * @param Title $title
 522          * @param IContextSource $context
 523          * @param bool $including Bool output is being captured for use in {{special:whatever}}
 524          *
 525          * @return bool
 526          */
 527         public static function executePath( Title &$title, IContextSource &$context, $including = false ) {
 528
 529                 // @todo FIXME: Redirects broken due to this call
 530                 $bits = explode( '/', $title->getDBkey(), 2 );
 531                 $name = $bits[0];
 532                 if ( !isset( $bits[1] ) ) { // bug 2087
 533                         $par = null;
 534                 } else {
 535                         $par = $bits[1];
 536                 }
 537                 $page = self::getPage( $name );
 538                 // Nonexistent?
 539                 if ( !$page ) {
 540                         $context->getOutput()->setArticleRelated( false );
 541                         $context->getOutput()->setRobotPolicy( 'noindex,nofollow' );
 542
 543                         global $wgSend404Code;
 544                         if ( $wgSend404Code ) {
 545                                 $context->getOutput()->setStatusCode( 404 );
 546                         }
 547
 548                         $context->getOutput()->showErrorPage( 'nosuchspecialpage', 'nospecialpagetext' );
 549
 550                         return false;
 551                 }
 552
 553                 // Page exists, set the context
 554                 $page->setContext( $context );
 555
 556                 if ( !$including ) {
 557                         // Redirect to canonical alias for GET commands
 558                         // Not for POST, we'd lose the post data, so it's best to just distribute
 559                         // the request. Such POST requests are possible for old extensions that
 560                         // generate self-links without being aware that their default name has
 561                         // changed.
 562                         if ( $name != $page->getLocalName() && !$context->getRequest()->wasPosted() ) {
 563                                 $query = $context->getRequest()->getQueryValues();
 564                                 unset( $query['title'] );
 565                                 $title = $page->getPageTitle( $par );
 566                                 $url = $title->getFullURL( $query );
 567                                 $context->getOutput()->redirect( $url );
 568
 569                                 return $title;
 570                         } else {
 571                                 $context->setTitle( $page->getPageTitle( $par ) );
 572                         }
 573                 } elseif ( !$page->isIncludable() ) {
 574
 575                         return false;
 576                 }
 577
 578                 $page->including( $including );
 579
 580                 // Execute special page
 581                 $page->run( $par );
 582
 583                 return true;
 584         }
 585
 586         /**
 587          * Just like executePath() but will override global variables and execute
 588          * the page in "inclusion" mode. Returns true if the execution was
 589          * successful or false if there was no such special page, or a title object
 590          * if it was a redirect.
 591          *
 592          * Also saves the current $wgTitle, $wgOut, $wgRequest, $wgUser and $wgLang
 593          * variables so that the special page will get the context it'd expect on a
 594          * normal request, and then restores them to their previous values after.
 595          *
 596          * @param Title $title
 597          * @param IContextSource $context
 598          * @return string HTML fragment
 599          */
 600         public static function capturePath( Title $title, IContextSource $context ) {
 601                 global $wgOut, $wgTitle, $wgRequest, $wgUser, $wgLang;
 602
 603                 // Save current globals
 604                 $oldTitle = $wgTitle;
 605                 $oldOut = $wgOut;
 606                 $oldRequest = $wgRequest;
 607                 $oldUser = $wgUser;
 608                 $oldLang = $wgLang;
 609
 610                 // Set the globals to the current context
 611                 $wgTitle = $title;
 612                 $wgOut = $context->getOutput();
 613                 $wgRequest = $context->getRequest();
 614                 $wgUser = $context->getUser();
 615                 $wgLang = $context->getLanguage();
 616
 617                 // The useful part
 618                 $ret = self::executePath( $title, $context, true );
 619
 620                 // And restore the old globals
 621                 $wgTitle = $oldTitle;
 622                 $wgOut = $oldOut;
 623                 $wgRequest = $oldRequest;
 624                 $wgUser = $oldUser;
 625                 $wgLang = $oldLang;
 626
 627                 return $ret;
 628         }
 629
 630         /**
 631          * Get the local name for a specified canonical name
 632          *
 633          * @param string $name
 634          * @param string|bool $subpage
 635          * @return string
 636          */
 637         public static function getLocalNameFor( $name, $subpage = false ) {
 638                 global $wgContLang;
 639                 $aliases = $wgContLang->getSpecialPageAliases();
 640                 $aliasList = self::getAliasListObject();
 641
 642                 // Find the first alias that maps back to $name
 643                 if ( isset( $aliases[$name] ) ) {
 644                         $found = false;
 645                         foreach ( $aliases[$name] as $alias ) {
 646                                 $caseFoldedAlias = $wgContLang->caseFold( $alias );
 647                                 $caseFoldedAlias = str_replace( ' ', '_', $caseFoldedAlias );
 648                                 if ( isset( $aliasList->$caseFoldedAlias ) &&
 649                                         $aliasList->$caseFoldedAlias === $name
 650                                 ) {
 651                                         $name = $alias;
 652                                         $found = true;
 653                                         break;
 654                                 }
 655                         }
 656                         if ( !$found ) {
 657                                 wfWarn( "Did not find a usable alias for special page '$name'. " .
 658                                         "It seems all defined aliases conflict?" );
 659                         }
 660                 } else {
 661                         // Check if someone misspelled the correct casing
 662                         if ( is_array( $aliases ) ) {
 663                                 foreach ( $aliases as $n => $values ) {
 664                                         if ( strcasecmp( $name, $n ) === 0 ) {
 665                                                 wfWarn( "Found alias defined for $n when searching for " .
 666                                                         "special page aliases for $name. Case mismatch?" );
 667                                                 return self::getLocalNameFor( $n, $subpage );
 668                                         }
 669                                 }
 670                         }
 671
 672                         wfWarn( "Did not find alias for special page '$name'. " .
 673                                 "Perhaps no aliases are defined for it?" );
 674                 }
 675
 676                 if ( $subpage !== false && !is_null( $subpage ) ) {
 677                         $name = "$name/$subpage";
 678                 }
 679
 680                 return $wgContLang->ucfirst( $name );
 681         }
 682
 683         /**
 684          * Get a title for a given alias
 685          *
 686          * @param string $alias
 687          * @return Title|null Title or null if there is no such alias
 688          */
 689         public static function getTitleForAlias( $alias ) {
 690                 list( $name, $subpage ) = self::resolveAlias( $alias );
 691                 if ( $name != null ) {
 692                         return SpecialPage::getTitleFor( $name, $subpage );
 693                 } else {
 694                         return null;
 695                 }
 696         }
 697 }