3 * Factory for handling the special page list and generating SpecialPage objects.
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.
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.
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
21 * @ingroup SpecialPage
22 * @defgroup SpecialPage SpecialPage
26 * Factory for handling the special page list and generating SpecialPage objects.
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.
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.
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.
43 * @ingroup SpecialPage
46 class SpecialPageFactory
{
48 * List of special page names to the subclass of SpecialPage which handles them.
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',
77 'Allpages' => 'SpecialAllPages',
78 'Prefixindex' => 'SpecialPrefixindex',
79 'Categories' => 'SpecialCategories',
80 'Listredirects' => 'ListredirectsPage',
81 'PagesWithProp' => 'SpecialPagesWithProp',
82 'TrackingCategories' => 'SpecialTrackingCategories',
84 // Login/create account
85 'Userlogin' => 'LoginForm',
86 'CreateAccount' => 'SpecialCreateAccount',
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',
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',
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',
125 'Statistics' => 'SpecialStatistics',
126 'Allmessages' => 'SpecialAllMessages',
127 'Version' => 'SpecialVersion',
128 'Lockdb' => 'SpecialLockdb',
129 'Unlockdb' => 'SpecialUnlockdb',
131 // Redirecting special pages
132 'LinkSearch' => 'LinkSearchPage',
133 'Randompage' => 'RandomPage',
134 'RandomInCategory' => 'SpecialRandomInCategory',
135 'Randomredirect' => 'SpecialRandomredirect',
138 'Mostlinkedcategories' => 'MostlinkedCategoriesPage',
139 'Mostimages' => 'MostimagesPage',
140 'Mostinterwikis' => 'MostinterwikisPage',
141 'Mostlinked' => 'MostlinkedPage',
142 'Mostlinkedtemplates' => 'MostlinkedTemplatesPage',
143 'Mostcategories' => 'MostcategoriesPage',
144 'Mostrevisions' => 'MostrevisionsPage',
147 'ComparePages' => 'SpecialComparePages',
148 'Export' => 'SpecialExport',
149 'Import' => 'SpecialImport',
150 'Undelete' => 'SpecialUndelete',
151 'Whatlinkshere' => 'SpecialWhatLinksHere',
152 'MergeHistory' => 'SpecialMergeHistory',
153 'ExpandTemplates' => 'SpecialExpandTemplates',
156 'Booksources' => 'SpecialBookSources',
158 // Unlisted / redirects
159 'ApiHelp' => 'SpecialApiHelp',
160 'Blankpage' => 'SpecialBlankpage',
161 'Diff' => 'SpecialDiff',
162 'EditTags' => 'SpecialEditTags',
163 'Emailuser' => 'SpecialEmailUser',
164 'Movepage' => 'MovePageForm',
165 'Mycontributions' => 'SpecialMycontributions',
166 'MyLanguage' => 'SpecialMyLanguage',
167 'Mypage' => 'SpecialMypage',
168 'Mytalk' => 'SpecialMytalk',
169 'Myuploads' => 'SpecialMyuploads',
170 'AllMyUploads' => 'SpecialAllMyUploads',
171 'PermanentLink' => 'SpecialPermanentLink',
172 'Redirect' => 'SpecialRedirect',
173 'Revisiondelete' => 'SpecialRevisionDelete',
174 'RunJobs' => 'SpecialRunJobs',
175 'Specialpages' => 'SpecialSpecialpages',
176 'Userlogout' => 'SpecialUserlogout',
179 private static $list;
180 private static $aliases;
183 * Reset the internal list of special pages. Useful when changing $wgSpecialPages after
184 * the internal list has already been initialized, e.g. during testing.
186 public static function resetList() {
188 self
::$aliases = null;
192 * Returns a list of canonical special page names.
193 * May be used to iterate over all registered special pages.
197 public static function getNames() {
198 return array_keys( self
::getPageList() );
202 * Get the special page list as an array
204 * @deprecated since 1.24, use getNames() instead.
207 public static function getList() {
208 wfDeprecated( __FUNCTION__
, '1.24' );
209 return self
::getPageList();
213 * Get the special page list as an array
217 private static function getPageList() {
218 global $wgSpecialPages;
219 global $wgDisableInternalSearch, $wgEmailAuthentication;
220 global $wgEnableEmail, $wgEnableJavaScriptTest;
221 global $wgPageLanguageUseDB;
223 if ( !is_array( self
::$list ) ) {
225 self
::$list = self
::$coreList;
227 if ( !$wgDisableInternalSearch ) {
228 self
::$list['Search'] = 'SpecialSearch';
231 if ( $wgEmailAuthentication ) {
232 self
::$list['Confirmemail'] = 'EmailConfirmation';
233 self
::$list['Invalidateemail'] = 'EmailInvalidation';
236 if ( $wgEnableEmail ) {
237 self
::$list['ChangeEmail'] = 'SpecialChangeEmail';
240 if ( $wgEnableJavaScriptTest ) {
241 self
::$list['JavaScriptTest'] = 'SpecialJavaScriptTest';
244 if ( $wgPageLanguageUseDB ) {
245 self
::$list['PageLanguage'] = 'SpecialPageLanguage';
248 self
::$list['Activeusers'] = 'SpecialActiveUsers';
250 // Add extension special pages
251 self
::$list = array_merge( self
::$list, $wgSpecialPages );
253 // This hook can be used to disable unwanted core special pages
254 // or conditionally register special pages.
255 Hooks
::run( 'SpecialPage_initList', array( &self
::$list ) );
263 * Initialise and return the list of special page aliases. Returns an object with
264 * properties which can be accessed $obj->pagename - each property name is an
265 * alias, with the value being the canonical name of the special page. All
266 * registered special pages are guaranteed to map to themselves.
269 private static function getAliasListObject() {
270 if ( !is_object( self
::$aliases ) ) {
272 $aliases = $wgContLang->getSpecialPageAliases();
273 $pageList = self
::getPageList();
275 self
::$aliases = array();
276 $keepAlias = array();
278 // Force every canonical name to be an alias for itself.
279 foreach ( $pageList as $name => $stuff ) {
280 $caseFoldedAlias = $wgContLang->caseFold( $name );
281 self
::$aliases[$caseFoldedAlias] = $name;
282 $keepAlias[$caseFoldedAlias] = 'canonical';
285 // Check for $aliases being an array since Language::getSpecialPageAliases can return null
286 if ( is_array( $aliases ) ) {
287 foreach ( $aliases as $realName => $aliasList ) {
288 $aliasList = array_values( $aliasList );
289 foreach ( $aliasList as $i => $alias ) {
290 $caseFoldedAlias = $wgContLang->caseFold( $alias );
292 if ( isset( self
::$aliases[$caseFoldedAlias] ) &&
293 $realName === self
::$aliases[$caseFoldedAlias]
295 // Ignore same-realName conflicts
299 if ( !isset( $keepAlias[$caseFoldedAlias] ) ) {
300 self
::$aliases[$caseFoldedAlias] = $realName;
302 $keepAlias[$caseFoldedAlias] = 'first';
305 wfWarn( "First alias '$alias' for $realName conflicts with " .
306 "{$keepAlias[$caseFoldedAlias]} alias for " .
307 self
::$aliases[$caseFoldedAlias]
314 // Cast to object: func()[$key] doesn't work, but func()->$key does
315 self
::$aliases = (object)self
::$aliases;
318 return self
::$aliases;
322 * Given a special page name with a possible subpage, return an array
323 * where the first element is the special page name and the second is the
326 * @param string $alias
327 * @return array Array( String, String|null ), or array( null, null ) if the page is invalid
329 public static function resolveAlias( $alias ) {
331 $bits = explode( '/', $alias, 2 );
333 $caseFoldedAlias = $wgContLang->caseFold( $bits[0] );
334 $caseFoldedAlias = str_replace( ' ', '_', $caseFoldedAlias );
335 if ( isset( self
::getAliasListObject()->$caseFoldedAlias ) ) {
336 $name = self
::getAliasListObject()->$caseFoldedAlias;
338 return array( null, null );
341 if ( !isset( $bits[1] ) ) { // bug 2087
347 return array( $name, $par );
351 * Add a page to a certain display group for Special:SpecialPages
353 * @param SpecialPage|string $page
354 * @param string $group
355 * @deprecated since 1.21 Override SpecialPage::getGroupName
357 public static function setGroup( $page, $group ) {
358 wfDeprecated( __METHOD__
, '1.21' );
360 global $wgSpecialPageGroups;
361 $name = is_object( $page ) ?
$page->getName() : $page;
362 $wgSpecialPageGroups[$name] = $group;
366 * Get the group that the special page belongs in on Special:SpecialPage
368 * @param SpecialPage $page
370 * @deprecated since 1.21 Use SpecialPage::getFinalGroupName
372 public static function getGroup( &$page ) {
373 wfDeprecated( __METHOD__
, '1.21' );
375 return $page->getFinalGroupName();
379 * Check if a given name exist as a special page or as a special page alias
381 * @param string $name Name of a special page
382 * @return bool True if a special page exists with this name
384 public static function exists( $name ) {
385 list( $title, /*...*/ ) = self
::resolveAlias( $name );
387 $specialPageList = self
::getPageList();
388 return isset( $specialPageList[$title] );
392 * Find the object with a given name and return it (or NULL)
394 * @param string $name Special page name, may be localised and/or an alias
395 * @return SpecialPage|null SpecialPage object or null if the page doesn't exist
397 public static function getPage( $name ) {
398 list( $realName, /*...*/ ) = self
::resolveAlias( $name );
400 $specialPageList = self
::getPageList();
402 if ( isset( $specialPageList[$realName] ) ) {
403 $rec = $specialPageList[$realName];
405 if ( is_callable( $rec ) ) {
406 // Use callback to instantiate the special page
407 $page = call_user_func( $rec );
408 } elseif ( is_string( $rec ) ) {
410 $page = new $className;
411 } elseif ( is_array( $rec ) ) {
412 $className = array_shift( $rec );
413 // @deprecated, officially since 1.18, unofficially since forever
414 wfDeprecated( "Array syntax for \$wgSpecialPages is deprecated ($className), " .
415 "define a subclass of SpecialPage instead.", '1.18' );
416 $page = ObjectFactory
::getObjectFromSpec( array(
417 'class' => $className,
419 'closure_expansion' => false,
421 } elseif ( $rec instanceof SpecialPage
) {
422 $page = $rec; //XXX: we should deep clone here
427 if ( $page instanceof SpecialPage
) {
430 // It's not a classname, nor a callback, nor a legacy constructor array,
431 // nor a special page object. Give up.
432 wfLogWarning( "Cannot instantiate special page $realName: bad spec!" );
442 * Return categorised listable special pages which are available
443 * for the current user, and everyone.
445 * @param User $user User object to check permissions, $wgUser will be used
447 * @return array ( string => Specialpage )
449 public static function getUsablePages( User
$user = null ) {
451 if ( $user === null ) {
455 foreach ( self
::getPageList() as $name => $rec ) {
456 $page = self
::getPage( $name );
457 if ( $page ) { // not null
458 $page->setContext( RequestContext
::getMain() );
459 if ( $page->isListed()
460 && ( !$page->isRestricted() ||
$page->userCanExecute( $user ) )
462 $pages[$name] = $page;
471 * Return categorised listable special pages for all users
473 * @return array ( string => Specialpage )
475 public static function getRegularPages() {
477 foreach ( self
::getPageList() as $name => $rec ) {
478 $page = self
::getPage( $name );
479 if ( $page->isListed() && !$page->isRestricted() ) {
480 $pages[$name] = $page;
488 * Return categorised listable special pages which are available
489 * for the current user, but not for everyone
491 * @param User|null $user User object to use or null for $wgUser
492 * @return array ( string => Specialpage )
494 public static function getRestrictedPages( User
$user = null ) {
496 if ( $user === null ) {
500 foreach ( self
::getPageList() as $name => $rec ) {
501 $page = self
::getPage( $name );
504 && $page->isRestricted()
505 && $page->userCanExecute( $user )
507 $pages[$name] = $page;
515 * Execute a special page path.
516 * The path may contain parameters, e.g. Special:Name/Params
517 * Extracts the special page name and call the execute method, passing the parameters
519 * Returns a title object if the page is redirected, false if there was no such special
520 * page, and true if it was successful.
522 * @param Title $title
523 * @param IContextSource $context
524 * @param bool $including Bool output is being captured for use in {{special:whatever}}
528 public static function executePath( Title
&$title, IContextSource
&$context, $including = false ) {
530 // @todo FIXME: Redirects broken due to this call
531 $bits = explode( '/', $title->getDBkey(), 2 );
533 if ( !isset( $bits[1] ) ) { // bug 2087
538 $page = self
::getPage( $name );
541 $context->getOutput()->setArticleRelated( false );
542 $context->getOutput()->setRobotPolicy( 'noindex,nofollow' );
544 global $wgSend404Code;
545 if ( $wgSend404Code ) {
546 $context->getOutput()->setStatusCode( 404 );
549 $context->getOutput()->showErrorPage( 'nosuchspecialpage', 'nospecialpagetext' );
554 // Page exists, set the context
555 $page->setContext( $context );
558 // Redirect to canonical alias for GET commands
559 // Not for POST, we'd lose the post data, so it's best to just distribute
560 // the request. Such POST requests are possible for old extensions that
561 // generate self-links without being aware that their default name has
563 if ( $name != $page->getLocalName() && !$context->getRequest()->wasPosted() ) {
564 $query = $context->getRequest()->getQueryValues();
565 unset( $query['title'] );
566 $title = $page->getPageTitle( $par );
567 $url = $title->getFullURL( $query );
568 $context->getOutput()->redirect( $url );
572 $context->setTitle( $page->getPageTitle( $par ) );
574 } elseif ( !$page->isIncludable() ) {
578 $page->including( $including );
580 // Execute special page
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.
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.
596 * @param Title $title
597 * @param IContextSource $context
598 * @return string HTML fragment
600 public static function capturePath( Title
$title, IContextSource
$context ) {
601 global $wgOut, $wgTitle, $wgRequest, $wgUser, $wgLang;
603 // Save current globals
604 $oldTitle = $wgTitle;
606 $oldRequest = $wgRequest;
610 // Set the globals to the current context
612 $wgOut = $context->getOutput();
613 $wgRequest = $context->getRequest();
614 $wgUser = $context->getUser();
615 $wgLang = $context->getLanguage();
618 $ret = self
::executePath( $title, $context, true );
620 // And restore the old globals
621 $wgTitle = $oldTitle;
623 $wgRequest = $oldRequest;
631 * Get the local name for a specified canonical name
633 * @param string $name
634 * @param string|bool $subpage
637 public static function getLocalNameFor( $name, $subpage = false ) {
639 $aliases = $wgContLang->getSpecialPageAliases();
640 $aliasList = self
::getAliasListObject();
642 // Find the first alias that maps back to $name
643 if ( isset( $aliases[$name] ) ) {
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
657 wfWarn( "Did not find a usable alias for special page '$name'. " .
658 "It seems all defined aliases conflict?" );
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 );
672 wfWarn( "Did not find alias for special page '$name'. " .
673 "Perhaps no aliases are defined for it?" );
676 if ( $subpage !== false && !is_null( $subpage ) ) {
677 $name = "$name/$subpage";
680 return $wgContLang->ucfirst( $name );
684 * Get a title for a given alias
686 * @param string $alias
687 * @return Title|null Title or null if there is no such alias
689 public static function getTitleForAlias( $alias ) {
690 list( $name, $subpage ) = self
::resolveAlias( $alias );
691 if ( $name != null ) {
692 return SpecialPage
::getTitleFor( $name, $subpage );