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 /**
  22  * An action that just passes the request to the relevant special page
  23  *
  24  * @ingroup Actions
  25  * @since 1.25
  26  */
  27 class SpecialPageAction extends FormlessAction {
  28         /**
  29          * @var array A mapping of action names to special page names.
  30          */
  31         public static $actionToSpecialPageMapping = [
  32                 'revisiondelete' => 'Revisiondelete',
  33                 'editchangetags' => 'EditTags',
  34         ];
  35
  36         public function getName() {
  37                 $request = $this->getRequest();
  38                 $actionName = $request->getVal( 'action', 'view' );
  39                 // TODO: Shouldn't need to copy-paste this code from Action::getActionName!
  40                 if ( $actionName === 'historysubmit' ) {
  41                         if ( $request->getBool( 'revisiondelete' ) ) {
  42                                 $actionName = 'revisiondelete';
  43                         } elseif ( $request->getBool( 'editchangetags' ) ) {
  44                                 $actionName = 'editchangetags';
  45                         }
  46                 }
  47
  48                 if ( isset( self::$actionToSpecialPageMapping[$actionName] ) ) {
  49                         return $actionName;
  50                 }
  51
  52                 return 'nosuchaction';
  53         }
  54
  55         public function requiresUnblock() {
  56                 return false;
  57         }
  58
  59         public function getDescription() {
  60                 return '';
  61         }
  62
  63         public function onView() {
  64                 return '';
  65         }
  66
  67         public function show() {
  68                 $special = $this->getSpecialPage();
  69                 if ( !$special ) {
  70                         throw new ErrorPageError(
  71                                 $this->msg( 'nosuchaction' ), $this->msg( 'nosuchactiontext' ) );
  72                 }
  73
  74                 $special->setContext( $this->getContext() );
  75                 $special->getContext()->setTitle( $special->getPageTitle() );
  76                 $special->run( '' );
  77         }
  78
  79         public function doesWrites() {
  80                 $special = $this->getSpecialPage();
  81
  82                 return $special ? $special->doesWrites() : false;
  83         }
  84
  85         /**
  86          * @return SpecialPage|null
  87          */
  88         protected function getSpecialPage() {
  89                 $action = $this->getName();
  90                 if ( $action === 'nosuchaction' ) {
  91                         return null;
  92                 }
  93
  94                 // map actions to (whitelisted) special pages
  95                 return SpecialPageFactory::getPage( self::$actionToSpecialPageMapping[$action] );
  96         }
  97 }