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 $list = 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
  83                 // Login/create account
  84                 'Userlogin'                 => 'LoginForm',
  85                 'CreateAccount'             => 'SpecialCreateAccount',
  86
  87                 // Users and rights
  88                 'Block'                     => 'SpecialBlock',
  89                 'Unblock'                   => 'SpecialUnblock',
  90                 'BlockList'                 => 'SpecialBlockList',
  91                 'ChangePassword'            => 'SpecialChangePassword',
  92                 'PasswordReset'             => 'SpecialPasswordReset',
  93                 'DeletedContributions'      => 'DeletedContributionsPage',
  94                 'Preferences'               => 'SpecialPreferences',
  95                 'ResetTokens'               => 'SpecialResetTokens',
  96                 'Contributions'             => 'SpecialContributions',
  97                 'Listgrouprights'           => 'SpecialListGroupRights',
  98                 'Listusers'                 => 'SpecialListUsers',
  99                 'Listadmins'                => 'SpecialListAdmins',
 100                 'Listbots'                  => 'SpecialListBots',
 101                 'Userrights'                => 'UserrightsPage',
 102                 'EditWatchlist'             => 'SpecialEditWatchlist',
 103
 104                 // Recent changes and logs
 105                 'Newimages'                 => 'SpecialNewFiles',
 106                 'Log'                       => 'SpecialLog',
 107                 'Watchlist'                 => 'SpecialWatchlist',
 108                 'Newpages'                  => 'SpecialNewpages',
 109                 'Recentchanges'             => 'SpecialRecentChanges',
 110                 'Recentchangeslinked'       => 'SpecialRecentChangesLinked',
 111                 'Tags'                      => 'SpecialTags',
 112
 113                 // Media reports and uploads
 114                 'Listfiles'                 => 'SpecialListFiles',
 115                 'Filepath'                  => 'SpecialFilepath',
 116                 'MIMEsearch'                => 'MIMEsearchPage',
 117                 'FileDuplicateSearch'       => 'FileDuplicateSearchPage',
 118                 'Upload'                    => 'SpecialUpload',
 119                 'UploadStash'               => 'SpecialUploadStash',
 120                 'ListDuplicatedFiles'       => 'ListDuplicatedFilesPage',
 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                 'RandomInCategory'          => 'SpecialRandomInCategory',
 133                 'Randomredirect'            => 'SpecialRandomredirect',
 134
 135                 // High use pages
 136                 'Mostlinkedcategories'      => 'MostlinkedCategoriesPage',
 137                 'Mostimages'                => 'MostimagesPage',
 138                 'Mostinterwikis'            => 'MostinterwikisPage',
 139                 'Mostlinked'                => 'MostlinkedPage',
 140                 'Mostlinkedtemplates'       => 'MostlinkedTemplatesPage',
 141                 'Mostcategories'            => 'MostcategoriesPage',
 142                 'Mostrevisions'             => 'MostrevisionsPage',
 143
 144                 // Page tools
 145                 'ComparePages'              => 'SpecialComparePages',
 146                 'Export'                    => 'SpecialExport',
 147                 'Import'                    => 'SpecialImport',
 148                 'Undelete'                  => 'SpecialUndelete',
 149                 'Whatlinkshere'             => 'SpecialWhatLinksHere',
 150                 'MergeHistory'              => 'SpecialMergeHistory',
 151                 'ExpandTemplates'           => 'SpecialExpandTemplates',
 152
 153                 // Other
 154                 'Booksources'               => 'SpecialBookSources',
 155
 156                 // Unlisted / redirects
 157                 'Blankpage'                 => 'SpecialBlankpage',
 158                 'Diff'                      => 'SpecialDiff',
 159                 'Emailuser'                 => 'SpecialEmailUser',
 160                 'Movepage'                  => 'MovePageForm',
 161                 'Mycontributions'           => 'SpecialMycontributions',
 162                 'Mypage'                    => 'SpecialMypage',
 163                 'Mytalk'                    => 'SpecialMytalk',
 164                 'Myuploads'                 => 'SpecialMyuploads',
 165                 'AllMyUploads'              => 'SpecialAllMyUploads',
 166                 'PermanentLink'             => 'SpecialPermanentLink',
 167                 'Redirect'                  => 'SpecialRedirect',
 168                 'Revisiondelete'            => 'SpecialRevisionDelete',
 169                 'RunJobs'                   => 'SpecialRunJobs',
 170                 'Specialpages'              => 'SpecialSpecialpages',
 171                 'Userlogout'                => 'SpecialUserlogout',
 172         );
 173
 174         private static $aliases;
 175
 176         /**
 177          * Get the special page list
 178          *
 179          * @return array
 180          */
 181         static function getList() {
 182                 global $wgSpecialPages;
 183                 global $wgDisableCounters, $wgDisableInternalSearch, $wgEmailAuthentication;
 184                 global $wgEnableEmail, $wgEnableJavaScriptTest;
 185
 186                 if ( !is_object( self::$list ) ) {
 187                         wfProfileIn( __METHOD__ );
 188
 189                         if ( !$wgDisableCounters ) {
 190                                 self::$list['Popularpages'] = 'PopularPagesPage';
 191                         }
 192
 193                         if ( !$wgDisableInternalSearch ) {
 194                                 self::$list['Search'] = 'SpecialSearch';
 195                         }
 196
 197                         if ( $wgEmailAuthentication ) {
 198                                 self::$list['Confirmemail'] = 'EmailConfirmation';
 199                                 self::$list['Invalidateemail'] = 'EmailInvalidation';
 200                         }
 201
 202                         if ( $wgEnableEmail ) {
 203                                 self::$list['ChangeEmail'] = 'SpecialChangeEmail';
 204                         }
 205
 206                         if ( $wgEnableJavaScriptTest ) {
 207                                 self::$list['JavaScriptTest'] = 'SpecialJavaScriptTest';
 208                         }
 209
 210                         self::$list['Activeusers'] = 'SpecialActiveUsers';
 211
 212                         // Add extension special pages
 213                         self::$list = array_merge( self::$list, $wgSpecialPages );
 214
 215                         // Run hooks
 216                         // This hook can be used to remove undesired built-in special pages
 217                         wfRunHooks( 'SpecialPage_initList', array( &self::$list ) );
 218
 219                         // Cast to object: func()[$key] doesn't work, but func()->$key does
 220                         settype( self::$list, 'object' );
 221
 222                         wfProfileOut( __METHOD__ );
 223                 }
 224                 return self::$list;
 225         }
 226
 227         /**
 228          * Initialise and return the list of special page aliases.  Returns an object with
 229          * properties which can be accessed $obj->pagename - each property is an array of
 230          * aliases; the first in the array is the canonical alias.  All registered special
 231          * pages are guaranteed to have a property entry, and for that property array to
 232          * contain at least one entry (English fallbacks will be added if necessary).
 233          * @return Object
 234          */
 235         static function getAliasList() {
 236                 if ( !is_object( self::$aliases ) ) {
 237                         global $wgContLang;
 238                         $aliases = $wgContLang->getSpecialPageAliases();
 239
 240                         // Objects are passed by reference by default, need to create a copy
 241                         $missingPages = clone self::getList();
 242
 243                         self::$aliases = array();
 244                         foreach ( $aliases as $realName => $aliasList ) {
 245                                 foreach ( $aliasList as $alias ) {
 246                                         self::$aliases[$wgContLang->caseFold( $alias )] = $realName;
 247                                 }
 248                                 unset( $missingPages->$realName );
 249                         }
 250                         foreach ( $missingPages as $name => $stuff ) {
 251                                 self::$aliases[$wgContLang->caseFold( $name )] = $name;
 252                         }
 253
 254                         // Cast to object: func()[$key] doesn't work, but func()->$key does
 255                         self::$aliases = (object)self::$aliases;
 256                 }
 257                 return self::$aliases;
 258         }
 259
 260         /**
 261          * Given a special page name with a possible subpage, return an array
 262          * where the first element is the special page name and the second is the
 263          * subpage.
 264          *
 265          * @param string $alias
 266          * @return array Array( String, String|null ), or array( null, null ) if the page is invalid
 267          */
 268         public static function resolveAlias( $alias ) {
 269                 global $wgContLang;
 270                 $bits = explode( '/', $alias, 2 );
 271
 272                 $caseFoldedAlias = $wgContLang->caseFold( $bits[0] );
 273                 $caseFoldedAlias = str_replace( ' ', '_', $caseFoldedAlias );
 274                 if ( isset( self::getAliasList()->$caseFoldedAlias ) ) {
 275                         $name = self::getAliasList()->$caseFoldedAlias;
 276                 } else {
 277                         return array( null, null );
 278                 }
 279
 280                 if ( !isset( $bits[1] ) ) { // bug 2087
 281                         $par = null;
 282                 } else {
 283                         $par = $bits[1];
 284                 }
 285
 286                 return array( $name, $par );
 287         }
 288
 289         /**
 290          * Add a page to a certain display group for Special:SpecialPages
 291          *
 292          * @param SpecialPage|string $page
 293          * @param string $group
 294          * @deprecated since 1.21 Override SpecialPage::getGroupName
 295          */
 296         public static function setGroup( $page, $group ) {
 297                 wfDeprecated( __METHOD__, '1.21' );
 298
 299                 global $wgSpecialPageGroups;
 300                 $name = is_object( $page ) ? $page->getName() : $page;
 301                 $wgSpecialPageGroups[$name] = $group;
 302         }
 303
 304         /**
 305          * Get the group that the special page belongs in on Special:SpecialPage
 306          *
 307          * @param SpecialPage $page
 308          * @return string
 309          * @deprecated since 1.21 Use SpecialPage::getFinalGroupName
 310          */
 311         public static function getGroup( &$page ) {
 312                 wfDeprecated( __METHOD__, '1.21' );
 313
 314                 return $page->getFinalGroupName();
 315         }
 316
 317         /**
 318          * Check if a given name exist as a special page or as a special page alias
 319          *
 320          * @param string $name Name of a special page
 321          * @return bool True if a special page exists with this name
 322          */
 323         public static function exists( $name ) {
 324                 list( $title, /*...*/ ) = self::resolveAlias( $name );
 325                 return property_exists( self::getList(), $title );
 326         }
 327
 328         /**
 329          * Find the object with a given name and return it (or NULL)
 330          *
 331          * @param string $name Special page name, may be localised and/or an alias
 332          * @return SpecialPage|null SpecialPage object or null if the page doesn't exist
 333          */
 334         public static function getPage( $name ) {
 335                 list( $realName, /*...*/ ) = self::resolveAlias( $name );
 336                 if ( property_exists( self::getList(), $realName ) ) {
 337                         $rec = self::getList()->$realName;
 338                         if ( is_string( $rec ) ) {
 339                                 $className = $rec;
 340                                 return new $className;
 341                         } elseif ( is_array( $rec ) ) {
 342                                 // @deprecated, officially since 1.18, unofficially since forever
 343                                 wfDebug( "Array syntax for \$wgSpecialPages is deprecated, define a subclass of SpecialPage instead." );
 344                                 $className = array_shift( $rec );
 345                                 self::getList()->$realName = MWFunction::newObj( $className, $rec );
 346                         }
 347                         return self::getList()->$realName;
 348                 } else {
 349                         return null;
 350                 }
 351         }
 352
 353         /**
 354          * Return categorised listable special pages which are available
 355          * for the current user, and everyone.
 356          *
 357          * @param $user User object to check permissions, $wgUser will be used if
 358          *   if not provided
 359          * @return array ( string => Specialpage )
 360          */
 361         public static function getUsablePages( User $user = null ) {
 362                 $pages = array();
 363                 if ( $user === null ) {
 364                         global $wgUser;
 365                         $user = $wgUser;
 366                 }
 367                 foreach ( self::getList() as $name => $rec ) {
 368                         $page = self::getPage( $name );
 369                         if ( $page ) { // not null
 370                                 $page->setContext( RequestContext::getMain() );
 371                                 if ( $page->isListed()
 372                                         && ( !$page->isRestricted() || $page->userCanExecute( $user ) )
 373                                 ) {
 374                                         $pages[$name] = $page;
 375                                 }
 376                         }
 377                 }
 378                 return $pages;
 379         }
 380
 381         /**
 382          * Return categorised listable special pages for all users
 383          *
 384          * @return array ( string => Specialpage )
 385          */
 386         public static function getRegularPages() {
 387                 $pages = array();
 388                 foreach ( self::getList() as $name => $rec ) {
 389                         $page = self::getPage( $name );
 390                         if ( $page->isListed() && !$page->isRestricted() ) {
 391                                 $pages[$name] = $page;
 392                         }
 393                 }
 394                 return $pages;
 395         }
 396
 397         /**
 398          * Return categorised listable special pages which are available
 399          * for the current user, but not for everyone
 400          *
 401          * @return array ( string => Specialpage )
 402          */
 403         public static function getRestrictedPages() {
 404                 global $wgUser;
 405                 $pages = array();
 406                 foreach ( self::getList() as $name => $rec ) {
 407                         $page = self::getPage( $name );
 408                         if (
 409                                 $page->isListed()
 410                                 && $page->isRestricted()
 411                                 && $page->userCanExecute( $wgUser )
 412                         ) {
 413                                 $pages[$name] = $page;
 414                         }
 415                 }
 416                 return $pages;
 417         }
 418
 419         /**
 420          * Execute a special page path.
 421          * The path may contain parameters, e.g. Special:Name/Params
 422          * Extracts the special page name and call the execute method, passing the parameters
 423          *
 424          * Returns a title object if the page is redirected, false if there was no such special
 425          * page, and true if it was successful.
 426          *
 427          * @param Title $title
 428          * @param IContextSource $context
 429          * @param bool $including Bool output is being captured for use in {{special:whatever}}
 430          *
 431          * @return bool
 432          */
 433         public static function executePath( Title &$title, IContextSource &$context, $including = false ) {
 434                 wfProfileIn( __METHOD__ );
 435
 436                 // @todo FIXME: Redirects broken due to this call
 437                 $bits = explode( '/', $title->getDBkey(), 2 );
 438                 $name = $bits[0];
 439                 if ( !isset( $bits[1] ) ) { // bug 2087
 440                         $par = null;
 441                 } else {
 442                         $par = $bits[1];
 443                 }
 444                 $page = self::getPage( $name );
 445                 // Nonexistent?
 446                 if ( !$page ) {
 447                         $context->getOutput()->setArticleRelated( false );
 448                         $context->getOutput()->setRobotPolicy( 'noindex,nofollow' );
 449
 450                         global $wgSend404Code;
 451                         if ( $wgSend404Code ) {
 452                                 $context->getOutput()->setStatusCode( 404 );
 453                         }
 454
 455                         $context->getOutput()->showErrorPage( 'nosuchspecialpage', 'nospecialpagetext' );
 456                         wfProfileOut( __METHOD__ );
 457                         return false;
 458                 }
 459
 460                 // Page exists, set the context
 461                 $page->setContext( $context );
 462
 463                 if ( !$including ) {
 464                         // Redirect to canonical alias for GET commands
 465                         // Not for POST, we'd lose the post data, so it's best to just distribute
 466                         // the request. Such POST requests are possible for old extensions that
 467                         // generate self-links without being aware that their default name has
 468                         // changed.
 469                         if ( $name != $page->getLocalName() && !$context->getRequest()->wasPosted() ) {
 470                                 $query = $context->getRequest()->getQueryValues();
 471                                 unset( $query['title'] );
 472                                 $title = $page->getPageTitle( $par );
 473                                 $url = $title->getFullURL( $query );
 474                                 $context->getOutput()->redirect( $url );
 475                                 wfProfileOut( __METHOD__ );
 476                                 return $title;
 477                         } else {
 478                                 $context->setTitle( $page->getPageTitle( $par ) );
 479                         }
 480
 481                 } elseif ( !$page->isIncludable() ) {
 482                         wfProfileOut( __METHOD__ );
 483                         return false;
 484                 }
 485
 486                 $page->including( $including );
 487
 488                 // Execute special page
 489                 $profName = 'Special:' . $page->getName();
 490                 wfProfileIn( $profName );
 491                 $page->run( $par );
 492                 wfProfileOut( $profName );
 493                 wfProfileOut( __METHOD__ );
 494                 return true;
 495         }
 496
 497         /**
 498          * Just like executePath() but will override global variables and execute
 499          * the page in "inclusion" mode. Returns true if the execution was
 500          * successful or false if there was no such special page, or a title object
 501          * if it was a redirect.
 502          *
 503          * Also saves the current $wgTitle, $wgOut, $wgRequest, $wgUser and $wgLang
 504          * variables so that the special page will get the context it'd expect on a
 505          * normal request, and then restores them to their previous values after.
 506          *
 507          * @param Title $title
 508          * @param IContextSource $context
 509          * @return string HTML fragment
 510          */
 511         static function capturePath( Title $title, IContextSource $context ) {
 512                 global $wgOut, $wgTitle, $wgRequest, $wgUser, $wgLang;
 513
 514                 // Save current globals
 515                 $oldTitle = $wgTitle;
 516                 $oldOut = $wgOut;
 517                 $oldRequest = $wgRequest;
 518                 $oldUser = $wgUser;
 519                 $oldLang = $wgLang;
 520
 521                 // Set the globals to the current context
 522                 $wgTitle = $title;
 523                 $wgOut = $context->getOutput();
 524                 $wgRequest = $context->getRequest();
 525                 $wgUser = $context->getUser();
 526                 $wgLang = $context->getLanguage();
 527
 528                 // The useful part
 529                 $ret = self::executePath( $title, $context, true );
 530
 531                 // And restore the old globals
 532                 $wgTitle = $oldTitle;
 533                 $wgOut = $oldOut;
 534                 $wgRequest = $oldRequest;
 535                 $wgUser = $oldUser;
 536                 $wgLang = $oldLang;
 537
 538                 return $ret;
 539         }
 540
 541         /**
 542          * Get the local name for a specified canonical name
 543          *
 544          * @param string $name
 545          * @param string|bool $subpage
 546          * @return string
 547          */
 548         static function getLocalNameFor( $name, $subpage = false ) {
 549                 global $wgContLang;
 550                 $aliases = $wgContLang->getSpecialPageAliases();
 551
 552                 if ( isset( $aliases[$name][0] ) ) {
 553                         $name = $aliases[$name][0];
 554                 } else {
 555                         // Try harder in case someone misspelled the correct casing
 556                         $found = false;
 557                         foreach ( $aliases as $n => $values ) {
 558                                 if ( strcasecmp( $name, $n ) === 0 ) {
 559                                         wfWarn( "Found alias defined for $n when searching for " .
 560                                                 "special page aliases for $name. Case mismatch?" );
 561                                         $name = $values[0];
 562                                         $found = true;
 563                                         break;
 564                                 }
 565                         }
 566                         if ( !$found ) {
 567                                 wfWarn( "Did not find alias for special page '$name'. " .
 568                                         "Perhaps no aliases are defined for it?" );
 569                         }
 570                 }
 571                 if ( $subpage !== false && !is_null( $subpage ) ) {
 572                         $name = "$name/$subpage";
 573                 }
 574                 return $wgContLang->ucfirst( $name );
 575         }
 576
 577         /**
 578          * Get a title for a given alias
 579          *
 580          * @param string $alias
 581          * @return Title|null Title or null if there is no such alias
 582          */
 583         static function getTitleForAlias( $alias ) {
 584                 $name = self::resolveAlias( $alias );
 585                 if ( $name ) {
 586                         return SpecialPage::getTitleFor( $name );
 587                 } else {
 588                         return null;
 589                 }
 590         }
 591 }