SpecialPageFactory.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Special;
 
use Hooks;
use IContextSource;
use Language;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\Linker\LinkRenderer;
use Profiler;
use RequestContext;
use SpecialPage;
use Title;
use User;
use Wikimedia\ObjectFactory;
 
class SpecialPageFactory {
    private static $coreList = [
        // Maintenance Reports
        'BrokenRedirects' => \SpecialBrokenRedirects::class,
        'Deadendpages' => \SpecialDeadendPages::class,
        'DoubleRedirects' => \SpecialDoubleRedirects::class,
        'Longpages' => \SpecialLongPages::class,
        'Ancientpages' => \SpecialAncientPages::class,
        'Lonelypages' => \SpecialLonelyPages::class,
        'Fewestrevisions' => \SpecialFewestRevisions::class,
        'Withoutinterwiki' => \SpecialWithoutInterwiki::class,
        'Protectedpages' => \SpecialProtectedpages::class,
        'Protectedtitles' => \SpecialProtectedtitles::class,
        'Shortpages' => \SpecialShortPages::class,
        'Uncategorizedcategories' => \SpecialUncategorizedCategories::class,
        'Uncategorizedimages' => \SpecialUncategorizedImages::class,
        'Uncategorizedpages' => \SpecialUncategorizedPages::class,
        'Uncategorizedtemplates' => \SpecialUncategorizedTemplates::class,
        'Unusedcategories' => \SpecialUnusedCategories::class,
        'Unusedimages' => \SpecialUnusedImages::class,
        'Unusedtemplates' => \SpecialUnusedTemplates::class,
        'Unwatchedpages' => \SpecialUnwatchedPages::class,
        'Wantedcategories' => \SpecialWantedCategories::class,
        'Wantedfiles' => \WantedFilesPage::class,
        'Wantedpages' => \WantedPagesPage::class,
        'Wantedtemplates' => \SpecialWantedTemplates::class,
 
        // List of pages
        'Allpages' => \SpecialAllPages::class,
        'Prefixindex' => \SpecialPrefixindex::class,
        'Categories' => \SpecialCategories::class,
        'Listredirects' => \SpecialListRedirects::class,
        'PagesWithProp' => \SpecialPagesWithProp::class,
        'TrackingCategories' => \SpecialTrackingCategories::class,
 
        // Authentication
        'Userlogin' => \SpecialUserLogin::class,
        'Userlogout' => \SpecialUserLogout::class,
        'CreateAccount' => \SpecialCreateAccount::class,
        'LinkAccounts' => \SpecialLinkAccounts::class,
        'UnlinkAccounts' => \SpecialUnlinkAccounts::class,
        'ChangeCredentials' => \SpecialChangeCredentials::class,
        'RemoveCredentials' => \SpecialRemoveCredentials::class,
 
        // Users and rights
        'Activeusers' => \SpecialActiveUsers::class,
        'Block' => \SpecialBlock::class,
        'Unblock' => \SpecialUnblock::class,
        'BlockList' => \SpecialBlockList::class,
        'AutoblockList' => \SpecialAutoblockList::class,
        'ChangePassword' => \SpecialChangePassword::class,
        'BotPasswords' => \SpecialBotPasswords::class,
        'PasswordReset' => \SpecialPasswordReset::class,
        'DeletedContributions' => \SpecialDeletedContributions::class,
        'Preferences' => \SpecialPreferences::class,
        'ResetTokens' => \SpecialResetTokens::class,
        'Contributions' => \SpecialContributions::class,
        'Listgrouprights' => \SpecialListGroupRights::class,
        'Listgrants' => \SpecialListGrants::class,
        'Listusers' => \SpecialListUsers::class,
        'Listadmins' => \SpecialListAdmins::class,
        'Listbots' => \SpecialListBots::class,
        'Userrights' => \UserrightsPage::class,
        'EditWatchlist' => \SpecialEditWatchlist::class,
        'PasswordPolicies' => \SpecialPasswordPolicies::class,
 
        // Recent changes and logs
        'Newimages' => \SpecialNewFiles::class,
        'Log' => \SpecialLog::class,
        'Watchlist' => \SpecialWatchlist::class,
        'Newpages' => \SpecialNewpages::class,
        'Recentchanges' => \SpecialRecentChanges::class,
        'Recentchangeslinked' => \SpecialRecentChangesLinked::class,
        'Tags' => \SpecialTags::class,
 
        // Media reports and uploads
        'Listfiles' => \SpecialListFiles::class,
        'Filepath' => \SpecialFilepath::class,
        'MediaStatistics' => \SpecialMediaStatistics::class,
        'MIMEsearch' => \SpecialMIMESearch::class,
        'FileDuplicateSearch' => \SpecialFileDuplicateSearch::class,
        'Upload' => \SpecialUpload::class,
        'UploadStash' => \SpecialUploadStash::class,
        'ListDuplicatedFiles' => \SpecialListDuplicatedFiles::class,
 
        // Data and tools
        'ApiSandbox' => \SpecialApiSandbox::class,
        'Statistics' => \SpecialStatistics::class,
        'Allmessages' => \SpecialAllMessages::class,
        'Version' => \SpecialVersion::class,
        'Lockdb' => \SpecialLockdb::class,
        'Unlockdb' => \SpecialUnlockdb::class,
 
        // Redirecting special pages
        'LinkSearch' => \SpecialLinkSearch::class,
        'Randompage' => \RandomPage::class,
        'RandomInCategory' => \SpecialRandomInCategory::class,
        'Randomredirect' => \SpecialRandomredirect::class,
        'Randomrootpage' => \SpecialRandomrootpage::class,
        'GoToInterwiki' => \SpecialGoToInterwiki::class,
 
        // High use pages
        'Mostlinkedcategories' => \SpecialMostLinkedCategories::class,
        'Mostimages' => \MostimagesPage::class,
        'Mostinterwikis' => \SpecialMostInterwikis::class,
        'Mostlinked' => \SpecialMostLinked::class,
        'Mostlinkedtemplates' => \SpecialMostLinkedTemplates::class,
        'Mostcategories' => \SpecialMostCategories::class,
        'Mostrevisions' => \SpecialMostRevisions::class,
 
        // Page tools
        'ComparePages' => \SpecialComparePages::class,
        'Export' => \SpecialExport::class,
        'Import' => \SpecialImport::class,
        'Undelete' => \SpecialUndelete::class,
        'Whatlinkshere' => \SpecialWhatLinksHere::class,
        'MergeHistory' => \SpecialMergeHistory::class,
        'ExpandTemplates' => \SpecialExpandTemplates::class,
 
        // Other
        'Booksources' => \SpecialBookSources::class,
 
        // Unlisted / redirects
        'ApiHelp' => \SpecialApiHelp::class,
        'Blankpage' => \SpecialBlankpage::class,
        'Diff' => \SpecialDiff::class,
        'EditTags' => [
            'class' => \SpecialEditTags::class,
            'services' => [
                'PermissionManager',
            ],
        ],
        'Emailuser' => \SpecialEmailUser::class,
        'Movepage' => \MovePageForm::class,
        'Mycontributions' => \SpecialMycontributions::class,
        'MyLanguage' => \SpecialMyLanguage::class,
        'Mypage' => \SpecialMypage::class,
        'Mytalk' => \SpecialMytalk::class,
        'Myuploads' => \SpecialMyuploads::class,
        'AllMyUploads' => \SpecialAllMyUploads::class,
        'NewSection' => \SpecialNewSection::class,
        'PermanentLink' => \SpecialPermanentLink::class,
        'Redirect' => \SpecialRedirect::class,
        'Revisiondelete' => [
            'class' => \SpecialRevisionDelete::class,
            'services' => [
                'PermissionManager',
            ],
        ],
        'RunJobs' => \SpecialRunJobs::class,
        'Specialpages' => \SpecialSpecialpages::class,
        'PageData' => \SpecialPageData::class,
    ];
 
    private $list;
 
    private $aliases;
 
    private $options;
 
    private $contLang;
 
    private $objectFactory;
 
    public static $constructorOptions = [
        'ContentHandlerUseDB',
        'DisableInternalSearch',
        'EmailAuthentication',
        'EnableEmail',
        'EnableJavaScriptTest',
        'EnableSpecialMute',
        'PageLanguageUseDB',
        'SpecialPages',
    ];
 
    public function __construct(
        ServiceOptions $options,
        Language $contLang,
        ObjectFactory $objectFactory
    ) {
        $options->assertRequiredOptions( self::$constructorOptions );
        $this->options = $options;
        $this->contLang = $contLang;
        $this->objectFactory = $objectFactory;
    }
 
    public function getNames() : array {
        return array_keys( $this->getPageList() );
    }
 
    private function getPageList() : array {
        if ( !is_array( $this->list ) ) {
            $this->list = self::$coreList;
 
            if ( !$this->options->get( 'DisableInternalSearch' ) ) {
                $this->list['Search'] = \SpecialSearch::class;
            }
 
            if ( $this->options->get( 'EmailAuthentication' ) ) {
                $this->list['Confirmemail'] = \SpecialConfirmEmail::class;
                $this->list['Invalidateemail'] = \SpecialEmailInvalidate::class;
            }
 
            if ( $this->options->get( 'EnableEmail' ) ) {
                $this->list['ChangeEmail'] = \SpecialChangeEmail::class;
            }
 
            if ( $this->options->get( 'EnableJavaScriptTest' ) ) {
                $this->list['JavaScriptTest'] = \SpecialJavaScriptTest::class;
            }
 
            if ( $this->options->get( 'EnableSpecialMute' ) ) {
                $this->list['Mute'] = \SpecialMute::class;
            }
 
            if ( $this->options->get( 'PageLanguageUseDB' ) ) {
                $this->list['PageLanguage'] = \SpecialPageLanguage::class;
            }
 
            if ( $this->options->get( 'ContentHandlerUseDB' ) ) {
                $this->list['ChangeContentModel'] = \SpecialChangeContentModel::class;
            }
 
            // Add extension special pages
            $this->list = array_merge( $this->list, $this->options->get( 'SpecialPages' ) );
 
            // This hook can be used to disable unwanted core special pages
            // or conditionally register special pages.
            Hooks::run( 'SpecialPage_initList', [ &$this->list ] );
 
        }
 
        return $this->list;
    }
 
    private function getAliasList() : array {
        if ( is_null( $this->aliases ) ) {
            $aliases = $this->contLang->getSpecialPageAliases();
            $pageList = $this->getPageList();
 
            $this->aliases = [];
            $keepAlias = [];
 
            // Force every canonical name to be an alias for itself.
            foreach ( $pageList as $name => $stuff ) {
                $caseFoldedAlias = $this->contLang->caseFold( $name );
                $this->aliases[$caseFoldedAlias] = $name;
                $keepAlias[$caseFoldedAlias] = 'canonical';
            }
 
            // Check for $aliases being an array since Language::getSpecialPageAliases can return null
            if ( is_array( $aliases ) ) {
                foreach ( $aliases as $realName => $aliasList ) {
                    $aliasList = array_values( $aliasList );
                    foreach ( $aliasList as $i => $alias ) {
                        $caseFoldedAlias = $this->contLang->caseFold( $alias );
 
                        if ( isset( $this->aliases[$caseFoldedAlias] ) &&
                            $realName === $this->aliases[$caseFoldedAlias]
                        ) {
                            // Ignore same-realName conflicts
                            continue;
                        }
 
                        if ( !isset( $keepAlias[$caseFoldedAlias] ) ) {
                            $this->aliases[$caseFoldedAlias] = $realName;
                            if ( !$i ) {
                                $keepAlias[$caseFoldedAlias] = 'first';
                            }
                        } elseif ( !$i ) {
                            wfWarn( "First alias '$alias' for $realName conflicts with " .
                                "{$keepAlias[$caseFoldedAlias]} alias for " .
                                $this->aliases[$caseFoldedAlias]
                            );
                        }
                    }
                }
            }
        }
 
        return $this->aliases;
    }
 
    public function resolveAlias( $alias ) {
        $bits = explode( '/', $alias, 2 );
 
        $caseFoldedAlias = $this->contLang->caseFold( $bits[0] );
        $caseFoldedAlias = str_replace( ' ', '_', $caseFoldedAlias );
        $aliases = $this->getAliasList();
        if ( !isset( $aliases[$caseFoldedAlias] ) ) {
            return [ null, null ];
        }
        $name = $aliases[$caseFoldedAlias];
        $par = $bits[1] ?? null; // T4087
 
        return [ $name, $par ];
    }
 
    public function exists( $name ) {
        list( $title, /*...*/ ) = $this->resolveAlias( $name );
 
        $specialPageList = $this->getPageList();
        return isset( $specialPageList[$title] );
    }
 
    public function getPage( $name ) {
        list( $realName, /*...*/ ) = $this->resolveAlias( $name );
 
        $specialPageList = $this->getPageList();
 
        if ( isset( $specialPageList[$realName] ) ) {
            $rec = $specialPageList[$realName];
 
            if ( $rec instanceof SpecialPage ) {
                wfDeprecated(
                    "a SpecialPage instance (for $realName) in " .
                    '$wgSpecialPages or from the SpecialPage_initList hook',
                    '1.34'
                );
 
                $page = $rec; // XXX: we should deep clone here
            } elseif ( is_array( $rec ) || is_string( $rec ) || is_callable( $rec ) ) {
                $page = $this->objectFactory->createObject(
                    $rec,
                    [
                        'allowClassName' => true,
                        'allowCallable' => true
                    ]
                );
            } else {
                $page = null;
            }
 
            if ( $page instanceof SpecialPage ) {
                return $page;
            }
 
            // It's not a classname, nor a callback, nor a legacy constructor array,
            // nor a special page object. Give up.
            wfLogWarning( "Cannot instantiate special page $realName: bad spec!" );
        }
 
        return null;
    }
 
    public function getUsablePages( User $user ) : array {
        $pages = [];
        foreach ( $this->getPageList() as $name => $rec ) {
            $page = $this->getPage( $name );
            if ( $page ) { // not null
                $page->setContext( RequestContext::getMain() );
                if ( $page->isListed()
                    && ( !$page->isRestricted() || $page->userCanExecute( $user ) )
                ) {
                    $pages[$name] = $page;
                }
            }
        }
 
        return $pages;
    }
 
    public function getRegularPages() : array {
        $pages = [];
        foreach ( $this->getPageList() as $name => $rec ) {
            $page = $this->getPage( $name );
            if ( $page && $page->isListed() && !$page->isRestricted() ) {
                $pages[$name] = $page;
            }
        }
 
        return $pages;
    }
 
    public function getRestrictedPages( User $user ) : array {
        $pages = [];
        foreach ( $this->getPageList() as $name => $rec ) {
            $page = $this->getPage( $name );
            if ( $page
                && $page->isListed()
                && $page->isRestricted()
                && $page->userCanExecute( $user )
            ) {
                $pages[$name] = $page;
            }
        }
 
        return $pages;
    }
 
    public function executePath( Title &$title, IContextSource &$context, $including = false,
        LinkRenderer $linkRenderer = null
    ) {
        // @todo FIXME: Redirects broken due to this call
        $bits = explode( '/', $title->getDBkey(), 2 );
        $name = $bits[0];
        $par = $bits[1] ?? null; // T4087
 
        $page = $this->getPage( $name );
        if ( !$page ) {
            $context->getOutput()->setArticleRelated( false );
            $context->getOutput()->setRobotPolicy( 'noindex,nofollow' );
 
            global $wgSend404Code;
            if ( $wgSend404Code ) {
                $context->getOutput()->setStatusCode( 404 );
            }
 
            $context->getOutput()->showErrorPage( 'nosuchspecialpage', 'nospecialpagetext' );
 
            return false;
        }
 
        if ( !$including ) {
            // Narrow DB query expectations for this HTTP request
            $trxLimits = $context->getConfig()->get( 'TrxProfilerLimits' );
            $trxProfiler = Profiler::instance()->getTransactionProfiler();
            if ( $context->getRequest()->wasPosted() && !$page->doesWrites() ) {
                $trxProfiler->setExpectations( $trxLimits['POST-nonwrite'], __METHOD__ );
                $context->getRequest()->markAsSafeRequest();
            }
        }
 
        // Page exists, set the context
        $page->setContext( $context );
 
        if ( !$including ) {
            // Redirect to canonical alias for GET commands
            // Not for POST, we'd lose the post data, so it's best to just distribute
            // the request. Such POST requests are possible for old extensions that
            // generate self-links without being aware that their default name has
            // changed.
            if ( $name != $page->getLocalName() && !$context->getRequest()->wasPosted() ) {
                $query = $context->getRequest()->getQueryValues();
                unset( $query['title'] );
                $title = $page->getPageTitle( $par );
                $url = $title->getFullURL( $query );
                $context->getOutput()->redirect( $url );
 
                return $title;
            }
 
            // @phan-suppress-next-line PhanUndeclaredMethod
            $context->setTitle( $page->getPageTitle( $par ) );
        } elseif ( !$page->isIncludable() ) {
            return false;
        }
 
        $page->including( $including );
        if ( $linkRenderer ) {
            $page->setLinkRenderer( $linkRenderer );
        }
 
        // Execute special page
        $page->run( $par );
 
        return true;
    }
 
    public function capturePath(
        Title $title, IContextSource $context, LinkRenderer $linkRenderer = null
    ) {
        global $wgTitle, $wgOut, $wgRequest, $wgUser, $wgLang;
        $main = RequestContext::getMain();
 
        // Save current globals and main context
        $glob = [
            'title' => $wgTitle,
            'output' => $wgOut,
            'request' => $wgRequest,
            'user' => $wgUser,
            'language' => $wgLang,
        ];
        $ctx = [
            'title' => $main->getTitle(),
            'output' => $main->getOutput(),
            'request' => $main->getRequest(),
            'user' => $main->getUser(),
            'language' => $main->getLanguage(),
        ];
        if ( $main->canUseWikiPage() ) {
            $ctx['wikipage'] = $main->getWikiPage();
        }
 
        // Override
        $wgTitle = $title;
        $wgOut = $context->getOutput();
        $wgRequest = $context->getRequest();
        $wgUser = $context->getUser();
        $wgLang = $context->getLanguage();
        $main->setTitle( $title );
        $main->setOutput( $context->getOutput() );
        $main->setRequest( $context->getRequest() );
        $main->setUser( $context->getUser() );
        $main->setLanguage( $context->getLanguage() );
 
        // The useful part
        $ret = $this->executePath( $title, $context, true, $linkRenderer );
 
        // Restore old globals and context
        $wgTitle = $glob['title'];
        $wgOut = $glob['output'];
        $wgRequest = $glob['request'];
        $wgUser = $glob['user'];
        $wgLang = $glob['language'];
        $main->setTitle( $ctx['title'] );
        $main->setOutput( $ctx['output'] );
        $main->setRequest( $ctx['request'] );
        $main->setUser( $ctx['user'] );
        $main->setLanguage( $ctx['language'] );
        if ( isset( $ctx['wikipage'] ) ) {
            $main->setWikiPage( $ctx['wikipage'] );
        }
 
        return $ret;
    }
 
    public function getLocalNameFor( $name, $subpage = false ) {
        $aliases = $this->contLang->getSpecialPageAliases();
        $aliasList = $this->getAliasList();
 
        // Find the first alias that maps back to $name
        if ( isset( $aliases[$name] ) ) {
            $found = false;
            foreach ( $aliases[$name] as $alias ) {
                $caseFoldedAlias = $this->contLang->caseFold( $alias );
                $caseFoldedAlias = str_replace( ' ', '_', $caseFoldedAlias );
                if ( isset( $aliasList[$caseFoldedAlias] ) &&
                    $aliasList[$caseFoldedAlias] === $name
                ) {
                    $name = $alias;
                    $found = true;
                    break;
                }
            }
            if ( !$found ) {
                wfWarn( "Did not find a usable alias for special page '$name'. " .
                    "It seems all defined aliases conflict?" );
            }
        } else {
            // Check if someone misspelled the correct casing
            if ( is_array( $aliases ) ) {
                foreach ( $aliases as $n => $values ) {
                    if ( strcasecmp( $name, $n ) === 0 ) {
                        wfWarn( "Found alias defined for $n when searching for " .
                            "special page aliases for $name. Case mismatch?" );
                        return $this->getLocalNameFor( $n, $subpage );
                    }
                }
            }
 
            wfWarn( "Did not find alias for special page '$name'. " .
                "Perhaps no aliases are defined for it?" );
        }
 
        if ( $subpage !== false && !is_null( $subpage ) ) {
            // Make sure it's in dbkey form
            $subpage = str_replace( ' ', '_', $subpage );
            $name = "$name/$subpage";
        }
 
        return $this->contLang->ucfirst( $name );
    }
 
    public function getTitleForAlias( $alias ) {
        list( $name, $subpage ) = $this->resolveAlias( $alias );
        if ( $name != null ) {
            return SpecialPage::getTitleFor( $name, $subpage );
        }
 
        return null;
    }
}