includes/actions/SpecialPageAction.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program; if not, write to the Free Software
  15  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  16  *
  17  * @file
  18  * @ingroup Actions
  19  */
  20
  21 use MediaWiki\MediaWikiServices;
  22
  23 /**
  24  * An action that just passes the request to the relevant special page
  25  *
  26  * @ingroup Actions
  27  * @since 1.25
  28  */
  29 class SpecialPageAction extends FormlessAction {
  30         /**
  31          * @var array A mapping of action names to special page names.
  32          */
  33         public static $actionToSpecialPageMapping = [
  34                 'revisiondelete' => 'Revisiondelete',
  35                 'editchangetags' => 'EditTags',
  36         ];
  37
  38         /**
  39          * @inheritDoc
  40          */
  41         public function getName() {
  42                 $request = $this->getRequest();
  43                 $actionName = $request->getVal( 'action', 'view' );
  44                 // TODO: Shouldn't need to copy-paste this code from Action::getActionName!
  45                 if ( $actionName === 'historysubmit' ) {
  46                         if ( $request->getBool( 'revisiondelete' ) ) {
  47                                 $actionName = 'revisiondelete';
  48                         } elseif ( $request->getBool( 'editchangetags' ) ) {
  49                                 $actionName = 'editchangetags';
  50                         }
  51                 }
  52
  53                 if ( isset( self::$actionToSpecialPageMapping[$actionName] ) ) {
  54                         return $actionName;
  55                 }
  56
  57                 return 'nosuchaction';
  58         }
  59
  60         public function requiresUnblock() {
  61                 return false;
  62         }
  63
  64         public function getDescription() {
  65                 return '';
  66         }
  67
  68         public function onView() {
  69                 return '';
  70         }
  71
  72         public function show() {
  73                 $special = $this->getSpecialPage();
  74                 if ( !$special ) {
  75                         throw new ErrorPageError(
  76                                 $this->msg( 'nosuchaction' ), $this->msg( 'nosuchactiontext' ) );
  77                 }
  78
  79                 $special->setContext( $this->getContext() );
  80                 $special->getContext()->setTitle( $special->getPageTitle() );
  81                 $special->run( '' );
  82         }
  83
  84         public function doesWrites() {
  85                 $special = $this->getSpecialPage();
  86
  87                 return $special ? $special->doesWrites() : false;
  88         }
  89
  90         /**
  91          * @return SpecialPage|null
  92          */
  93         protected function getSpecialPage() {
  94                 $action = $this->getName();
  95                 if ( $action === 'nosuchaction' ) {
  96                         return null;
  97                 }
  98
  99                 // map actions to (whitelisted) special pages
 100                 return MediaWikiServices::getInstance()->getSpecialPageFactory()->
 101                         getPage( self::$actionToSpecialPageMapping[$action] );
 102         }
 103 }