RedirectSpecialPage.php

Go to the documentation of this file.

<?php
namespace MediaWiki\SpecialPage;
 
use LogicException;
use MediaWiki\Title\Title;
 
abstract class RedirectSpecialPage extends UnlistedSpecialPage {
    protected $mAllowedRedirectParams = [];
 
    protected $mAddedRedirectParams = [];
 
    public function execute( $subpage ) {
        $redirect = $this->getRedirect( $subpage );
        $query = $this->getRedirectQuery( $subpage );
 
        if ( $redirect instanceof Title ) {
            // Redirect to a page title with possible query parameters
            $url = $redirect->getFullUrlForRedirect( $query );
            $this->getOutput()->redirect( $url );
        } elseif ( $redirect === true ) {
            // Redirect to index.php with query parameters
            $url = wfAppendQuery( wfScript( 'index' ), $query );
            $this->getOutput()->redirect( $url );
        } else {
            $this->showNoRedirectPage();
        }
    }
 
    abstract public function getRedirect( $subpage );
 
    public function getRedirectQuery( $subpage ) {
        $queryParams = $this->getRequest()->getQueryValues();
        $keepParams = array_merge(
            $this->mAllowedRedirectParams,
            // parameters which can be passed to all pages
            [ 'uselang', 'useskin', 'useformat', 'variant', 'debug', 'safemode' ]
        );
 
        $params = array_intersect_key( $queryParams, array_fill_keys( $keepParams, true ) );
 
        foreach ( $this->mAddedRedirectParams as $arg => $val ) {
            $params[$arg] = $val;
        }
 
        return count( $params )
            ? $params
            : false;
    }
 
    public function personallyIdentifiableTarget() {
        return false;
    }
 
    protected function showNoRedirectPage() {
        $class = static::class;
        throw new LogicException( "RedirectSpecialPage $class doesn't redirect!" );
    }
}
 
class_alias( RedirectSpecialPage::class, 'RedirectSpecialPage' );