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 $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',
77 'Allpages' => 'SpecialAllpages',
78 'Prefixindex' => 'SpecialPrefixindex',
79 'Categories' => 'SpecialCategories',
80 'Listredirects' => 'ListredirectsPage',
81 'PagesWithProp' => 'SpecialPagesWithProp',
83 // Login/create account
84 'Userlogin' => 'LoginForm',
85 'CreateAccount' => 'SpecialCreateAccount',
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',
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',
113 // Media reports and uploads
114 'Listfiles' => 'SpecialListFiles',
115 'Filepath' => 'SpecialFilepath',
116 'MIMEsearch' => 'MIMEsearchPage',
117 'FileDuplicateSearch' => 'FileDuplicateSearchPage',
118 'Upload' => 'SpecialUpload',
119 'UploadStash' => 'SpecialUploadStash',
122 'Statistics' => 'SpecialStatistics',
123 'Allmessages' => 'SpecialAllmessages',
124 'Version' => 'SpecialVersion',
125 'Lockdb' => 'SpecialLockdb',
126 'Unlockdb' => 'SpecialUnlockdb',
128 // Redirecting special pages
129 'LinkSearch' => 'LinkSearchPage',
130 'Randompage' => 'Randompage',
131 'RandomInCategory' => 'SpecialRandomInCategory',
132 'Randomredirect' => 'SpecialRandomredirect',
135 'Mostlinkedcategories' => 'MostlinkedCategoriesPage',
136 'Mostimages' => 'MostimagesPage',
137 'Mostinterwikis' => 'MostinterwikisPage',
138 'Mostlinked' => 'MostlinkedPage',
139 'Mostlinkedtemplates' => 'MostlinkedTemplatesPage',
140 'Mostcategories' => 'MostcategoriesPage',
141 'Mostrevisions' => 'MostrevisionsPage',
144 'ComparePages' => 'SpecialComparePages',
145 'Export' => 'SpecialExport',
146 'Import' => 'SpecialImport',
147 'Undelete' => 'SpecialUndelete',
148 'Whatlinkshere' => 'SpecialWhatlinkshere',
149 'MergeHistory' => 'SpecialMergeHistory',
150 'ExpandTemplates' => 'SpecialExpandTemplates',
153 'Booksources' => 'SpecialBookSources',
155 // Unlisted / redirects
156 'Blankpage' => 'SpecialBlankpage',
157 'Diff' => 'SpecialDiff',
158 'Emailuser' => 'SpecialEmailUser',
159 'Movepage' => 'MovePageForm',
160 'Mycontributions' => 'SpecialMycontributions',
161 'Mypage' => 'SpecialMypage',
162 'Mytalk' => 'SpecialMytalk',
163 'Myuploads' => 'SpecialMyuploads',
164 'AllMyUploads' => 'SpecialAllMyUploads',
165 'PermanentLink' => 'SpecialPermanentLink',
166 'Redirect' => 'SpecialRedirect',
167 'Revisiondelete' => 'SpecialRevisionDelete',
168 'Specialpages' => 'SpecialSpecialpages',
169 'Userlogout' => 'SpecialUserlogout',
172 private static $aliases;
175 * Get the special page list
179 static function getList() {
180 global $wgSpecialPages;
181 global $wgDisableCounters, $wgDisableInternalSearch, $wgEmailAuthentication;
182 global $wgEnableEmail, $wgEnableJavaScriptTest;
185 if ( !is_object( self
::$list ) ) {
186 wfProfileIn( __METHOD__
);
188 if ( !$wgDisableCounters ) {
189 self
::$list['Popularpages'] = 'PopularpagesPage';
192 if ( !$wgDisableInternalSearch ) {
193 self
::$list['Search'] = 'SpecialSearch';
196 if ( $wgEmailAuthentication ) {
197 self
::$list['Confirmemail'] = 'EmailConfirmation';
198 self
::$list['Invalidateemail'] = 'EmailInvalidation';
201 if ( $wgEnableEmail ) {
202 self
::$list['ChangeEmail'] = 'SpecialChangeEmail';
205 if ( $wgEnableJavaScriptTest ) {
206 self
::$list['JavaScriptTest'] = 'SpecialJavaScriptTest';
209 if ( !$wgMiserMode ) {
210 self
::$list['Activeusers'] = 'SpecialActiveUsers';
213 // Add extension special pages
214 self
::$list = array_merge( self
::$list, $wgSpecialPages );
217 // This hook can be used to remove undesired built-in special pages
218 wfRunHooks( 'SpecialPage_initList', array( &self
::$list ) );
220 // Cast to object: func()[$key] doesn't work, but func()->$key does
221 settype( self
::$list, 'object' );
223 wfProfileOut( __METHOD__
);
229 * Initialise and return the list of special page aliases. Returns an object with
230 * properties which can be accessed $obj->pagename - each property is an array of
231 * aliases; the first in the array is the canonical alias. All registered special
232 * pages are guaranteed to have a property entry, and for that property array to
233 * contain at least one entry (English fallbacks will be added if necessary).
236 static function getAliasList() {
237 if ( !is_object( self
::$aliases ) ) {
239 $aliases = $wgContLang->getSpecialPageAliases();
241 // Objects are passed by reference by default, need to create a copy
242 $missingPages = clone self
::getList();
244 self
::$aliases = array();
245 foreach ( $aliases as $realName => $aliasList ) {
246 foreach ( $aliasList as $alias ) {
247 self
::$aliases[$wgContLang->caseFold( $alias )] = $realName;
249 unset( $missingPages->$realName );
251 foreach ( $missingPages as $name => $stuff ) {
252 self
::$aliases[$wgContLang->caseFold( $name )] = $name;
255 // Cast to object: func()[$key] doesn't work, but func()->$key does
256 self
::$aliases = (object)self
::$aliases;
258 return self
::$aliases;
262 * Given a special page name with a possible subpage, return an array
263 * where the first element is the special page name and the second is the
266 * @param string $alias
267 * @return array Array( String, String|null ), or array( null, null ) if the page is invalid
269 public static function resolveAlias( $alias ) {
271 $bits = explode( '/', $alias, 2 );
273 $caseFoldedAlias = $wgContLang->caseFold( $bits[0] );
274 $caseFoldedAlias = str_replace( ' ', '_', $caseFoldedAlias );
275 if ( isset( self
::getAliasList()->$caseFoldedAlias ) ) {
276 $name = self
::getAliasList()->$caseFoldedAlias;
278 return array( null, null );
281 if ( !isset( $bits[1] ) ) { // bug 2087
287 return array( $name, $par );
291 * Add a page to a certain display group for Special:SpecialPages
293 * @param SpecialPage|string $page
294 * @param string $group
295 * @deprecated since 1.21 Override SpecialPage::getGroupName
297 public static function setGroup( $page, $group ) {
298 wfDeprecated( __METHOD__
, '1.21' );
300 global $wgSpecialPageGroups;
301 $name = is_object( $page ) ?
$page->getName() : $page;
302 $wgSpecialPageGroups[$name] = $group;
306 * Get the group that the special page belongs in on Special:SpecialPage
308 * @param SpecialPage $page
310 * @deprecated since 1.21 Use SpecialPage::getFinalGroupName
312 public static function getGroup( &$page ) {
313 wfDeprecated( __METHOD__
, '1.21' );
315 return $page->getFinalGroupName();
319 * Check if a given name exist as a special page or as a special page alias
321 * @param string $name Name of a special page
322 * @return bool True if a special page exists with this name
324 public static function exists( $name ) {
325 list( $title, /*...*/ ) = self
::resolveAlias( $name );
326 return property_exists( self
::getList(), $title );
330 * Find the object with a given name and return it (or NULL)
332 * @param string $name Special page name, may be localised and/or an alias
333 * @return SpecialPage|null SpecialPage object or null if the page doesn't exist
335 public static function getPage( $name ) {
336 list( $realName, /*...*/ ) = self
::resolveAlias( $name );
337 if ( property_exists( self
::getList(), $realName ) ) {
338 $rec = self
::getList()->$realName;
339 if ( is_string( $rec ) ) {
341 return new $className;
342 } elseif ( is_array( $rec ) ) {
343 // @deprecated, officially since 1.18, unofficially since forever
344 wfDebug( "Array syntax for \$wgSpecialPages is deprecated, define a subclass of SpecialPage instead." );
345 $className = array_shift( $rec );
346 self
::getList()->$realName = MWFunction
::newObj( $className, $rec );
348 return self
::getList()->$realName;
355 * Return categorised listable special pages which are available
356 * for the current user, and everyone.
358 * @param $user User object to check permissions, $wgUser will be used if
360 * @return array ( string => Specialpage )
362 public static function getUsablePages( User
$user = null ) {
364 if ( $user === null ) {
368 foreach ( self
::getList() as $name => $rec ) {
369 $page = self
::getPage( $name );
370 if ( $page ) { // not null
371 $page->setContext( RequestContext
::getMain() );
372 if ( $page->isListed()
373 && ( !$page->isRestricted() ||
$page->userCanExecute( $user ) )
375 $pages[$name] = $page;
383 * Return categorised listable special pages for all users
385 * @return array ( string => Specialpage )
387 public static function getRegularPages() {
389 foreach ( self
::getList() as $name => $rec ) {
390 $page = self
::getPage( $name );
391 if ( $page->isListed() && !$page->isRestricted() ) {
392 $pages[$name] = $page;
399 * Return categorised listable special pages which are available
400 * for the current user, but not for everyone
402 * @return array ( string => Specialpage )
404 public static function getRestrictedPages() {
407 foreach ( self
::getList() as $name => $rec ) {
408 $page = self
::getPage( $name );
411 && $page->isRestricted()
412 && $page->userCanExecute( $wgUser )
414 $pages[$name] = $page;
421 * Execute a special page path.
422 * The path may contain parameters, e.g. Special:Name/Params
423 * Extracts the special page name and call the execute method, passing the parameters
425 * Returns a title object if the page is redirected, false if there was no such special
426 * page, and true if it was successful.
428 * @param Title $title
429 * @param IContextSource $context
430 * @param bool $including Bool output is being captured for use in {{special:whatever}}
434 public static function executePath( Title
&$title, IContextSource
&$context, $including = false ) {
435 wfProfileIn( __METHOD__
);
437 // @todo FIXME: Redirects broken due to this call
438 $bits = explode( '/', $title->getDBkey(), 2 );
440 if ( !isset( $bits[1] ) ) { // bug 2087
445 $page = self
::getPage( $name );
448 $context->getOutput()->setArticleRelated( false );
449 $context->getOutput()->setRobotPolicy( 'noindex,nofollow' );
451 global $wgSend404Code;
452 if ( $wgSend404Code ) {
453 $context->getOutput()->setStatusCode( 404 );
456 $context->getOutput()->showErrorPage( 'nosuchspecialpage', 'nospecialpagetext' );
457 wfProfileOut( __METHOD__
);
461 // Page exists, set the context
462 $page->setContext( $context );
465 // Redirect to canonical alias for GET commands
466 // Not for POST, we'd lose the post data, so it's best to just distribute
467 // the request. Such POST requests are possible for old extensions that
468 // generate self-links without being aware that their default name has
470 if ( $name != $page->getLocalName() && !$context->getRequest()->wasPosted() ) {
471 $query = $context->getRequest()->getQueryValues();
472 unset( $query['title'] );
473 $title = $page->getPageTitle( $par );
474 $url = $title->getFullURL( $query );
475 $context->getOutput()->redirect( $url );
476 wfProfileOut( __METHOD__
);
479 $context->setTitle( $page->getPageTitle( $par ) );
482 } elseif ( !$page->isIncludable() ) {
483 wfProfileOut( __METHOD__
);
487 $page->including( $including );
489 // Execute special page
490 $profName = 'Special:' . $page->getName();
491 wfProfileIn( $profName );
493 wfProfileOut( $profName );
494 wfProfileOut( __METHOD__
);
499 * Just like executePath() but will override global variables and execute
500 * the page in "inclusion" mode. Returns true if the execution was
501 * successful or false if there was no such special page, or a title object
502 * if it was a redirect.
504 * Also saves the current $wgTitle, $wgOut, $wgRequest, $wgUser and $wgLang
505 * variables so that the special page will get the context it'd expect on a
506 * normal request, and then restores them to their previous values after.
508 * @param Title $title
509 * @param IContextSource $context
510 * @return string HTML fragment
512 static function capturePath( Title
$title, IContextSource
$context ) {
513 global $wgOut, $wgTitle, $wgRequest, $wgUser, $wgLang;
515 // Save current globals
516 $oldTitle = $wgTitle;
518 $oldRequest = $wgRequest;
522 // Set the globals to the current context
524 $wgOut = $context->getOutput();
525 $wgRequest = $context->getRequest();
526 $wgUser = $context->getUser();
527 $wgLang = $context->getLanguage();
530 $ret = self
::executePath( $title, $context, true );
532 // And restore the old globals
533 $wgTitle = $oldTitle;
535 $wgRequest = $oldRequest;
543 * Get the local name for a specified canonical name
545 * @param string $name
546 * @param string|bool $subpage
549 static function getLocalNameFor( $name, $subpage = false ) {
551 $aliases = $wgContLang->getSpecialPageAliases();
553 if ( isset( $aliases[$name][0] ) ) {
554 $name = $aliases[$name][0];
556 // Try harder in case someone misspelled the correct casing
558 foreach ( $aliases as $n => $values ) {
559 if ( strcasecmp( $name, $n ) === 0 ) {
560 wfWarn( "Found alias defined for $n when searching for " .
561 "special page aliases for $name. Case mismatch?" );
568 wfWarn( "Did not find alias for special page '$name'. " .
569 "Perhaps no aliases are defined for it?" );
572 if ( $subpage !== false && !is_null( $subpage ) ) {
573 $name = "$name/$subpage";
575 return $wgContLang->ucfirst( $name );
579 * Get a title for a given alias
581 * @param string $alias
582 * @return Title|null Title or null if there is no such alias
584 static function getTitleForAlias( $alias ) {
585 $name = self
::resolveAlias( $alias );
587 return SpecialPage
::getTitleFor( $name );