8e40193659
* Add relevant `@ingroup` to special pages that belong to a specific component and for which a doc group is already defined (defgroup), e.g. "Upload" for SpecialUpload, "JobQueue" for SpecialRunJobs. * Remove duplicate descriptions from file blocks in favour of class doc blocks. This reduces needless duplication and was often incorrect or outdated, and helps make file headers more consistently (visually) ignorable. Add missing `ingroup` to class blocks (and remove any from file blocks) as otherwise the file is indexed twice (e.g. in Doxygen) which makes navigation on doc.wikimedia.org rather messy. Ref https://gerrit.wikimedia.org/r/q/message:ingroup+is:merged Bug: T364652 Change-Id: I795c43b6d72782d457c963e352d7e1b022c2b641
124 lines
3.5 KiB
PHP
124 lines
3.5 KiB
PHP
<?php
|
|
/**
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
namespace MediaWiki\SpecialPage;
|
|
|
|
use LogicException;
|
|
use MediaWiki\Title\Title;
|
|
|
|
/**
|
|
* Shortcut to construct a special page alias.
|
|
*
|
|
* @stable to extend
|
|
*
|
|
* @ingroup SpecialPage
|
|
*/
|
|
abstract class RedirectSpecialPage extends UnlistedSpecialPage {
|
|
/** @var array Query parameters that can be passed through redirects */
|
|
protected $mAllowedRedirectParams = [];
|
|
|
|
/** @var array Query parameters added by redirects */
|
|
protected $mAddedRedirectParams = [];
|
|
|
|
/**
|
|
* @stable to override
|
|
* @param string|null $subpage
|
|
*/
|
|
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();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* If the special page is a redirect, then get the Title object it redirects to.
|
|
* False otherwise.
|
|
*
|
|
* @param string|null $subpage
|
|
* @return Title|bool
|
|
*/
|
|
abstract public function getRedirect( $subpage );
|
|
|
|
/**
|
|
* Return part of the request string for a special redirect page
|
|
* This allows passing, e.g. action=history to Special:Mypage, etc.
|
|
*
|
|
* @stable to override
|
|
* @param string|null $subpage
|
|
* @return array|false
|
|
*/
|
|
public function getRedirectQuery( $subpage ) {
|
|
$params = [];
|
|
$request = $this->getRequest();
|
|
|
|
foreach ( array_merge( $this->mAllowedRedirectParams,
|
|
[ 'uselang', 'useskin', 'variant', 'debug', 'safemode' ] // 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;
|
|
}
|
|
|
|
/**
|
|
* Indicate if the target of this redirect can be used to identify
|
|
* a particular user of this wiki (e.g., if the redirect is to the
|
|
* user page of a User). See T109724.
|
|
*
|
|
* @stable to override
|
|
* @since 1.27
|
|
* @return bool
|
|
*/
|
|
public function personallyIdentifiableTarget() {
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @stable to override
|
|
*/
|
|
protected function showNoRedirectPage() {
|
|
$class = static::class;
|
|
throw new LogicException( "RedirectSpecialPage $class doesn't redirect!" );
|
|
}
|
|
}
|
|
|
|
/** @deprecated class alias since 1.41 */
|
|
class_alias( RedirectSpecialPage::class, 'RedirectSpecialPage' );
|