RedirectSpecialPage.php

Go to the documentation of this file.

<?php
abstract class RedirectSpecialPage extends UnlistedSpecialPage {
    // Query parameters that can be passed through redirects
    protected $mAllowedRedirectParams = [];

    // Query parameters added by redirects
    protected $mAddedRedirectParams = [];

    public function execute( $subpage ) {
        $redirect = $this->getRedirect( $subpage );
        $query = $this->getRedirectQuery();
        // Redirect to a page title with possible query parameters
        if ( $redirect instanceof Title ) {
            $url = $redirect->getFullURL( $query );
            $this->getOutput()->redirect( $url );

            return $redirect;
        } elseif ( $redirect === true ) {
            // Redirect to index.php with query parameters
            $url = wfAppendQuery( wfScript( 'index' ), $query );
            $this->getOutput()->redirect( $url );

            return $redirect;
        } else {
            $class = get_class( $this );
            throw new MWException( "RedirectSpecialPage $class doesn't redirect!" );
        }
    }

    abstract public function getRedirect( $subpage );

    public function getRedirectQuery() {
        $params = [];
        $request = $this->getRequest();

        foreach ( array_merge( $this->mAllowedRedirectParams,
                [ 'uselang', 'useskin', 'debug' ] // parameters which can be passed to all pages
            ) as $arg ) {
            if ( $request->getVal( $arg, null ) !== null ) {
                $params[$arg] = $request->getVal( $arg );
            } elseif ( $request->getArray( $arg, null ) !== null ) {
                $params[$arg] = $request->getArray( $arg );
            }
        }

        foreach ( $this->mAddedRedirectParams as $arg => $val ) {
            $params[$arg] = $val;
        }

        return count( $params )
            ? $params
            : false;
    }

    public function personallyIdentifiableTarget() {
        return false;
    }
}

abstract class SpecialRedirectToSpecial extends RedirectSpecialPage {
    protected $redirName;

    protected $redirSubpage;

    function __construct(
        $name, $redirName, $redirSubpage = false,
        $allowedRedirectParams = [], $addedRedirectParams = []
    ) {
        parent::__construct( $name );
        $this->redirName = $redirName;
        $this->redirSubpage = $redirSubpage;
        $this->mAllowedRedirectParams = $allowedRedirectParams;
        $this->mAddedRedirectParams = $addedRedirectParams;
    }

    public function getRedirect( $subpage ) {
        if ( $this->redirSubpage === false ) {
            return SpecialPage::getTitleFor( $this->redirName, $subpage );
        }

        return SpecialPage::getTitleFor( $this->redirName, $this->redirSubpage );
    }
}

abstract class RedirectSpecialArticle extends RedirectSpecialPage {
    function __construct( $name ) {
        parent::__construct( $name );
        $redirectParams = [
            'action',
            'redirect', 'rdfrom',
            # Options for preloaded edits
            'preload', 'preloadparams', 'editintro', 'preloadtitle', 'summary', 'nosummary',
            # Options for overriding user settings
            'preview', 'minor', 'watchthis',
            # Options for history/diffs
            'section', 'oldid', 'diff', 'dir',
            'limit', 'offset', 'feed',
            # Misc options
            'redlink',
            # Options for action=raw; missing ctype can break JS or CSS in some browsers
            'ctype', 'maxage', 'smaxage',
        ];

        Hooks::run( "RedirectSpecialArticleRedirectParams", [ &$redirectParams ] );
        $this->mAllowedRedirectParams = $redirectParams;
    }
}