includes/actions/RevertAction.php

   1 <?php
   2 /**
   3  * File reversion user interface
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  18  *
  19  * @file
  20  * @ingroup Actions
  21  * @ingroup Media
  22  * @author Alexandre Emsenhuber
  23  * @author Rob Church <robchur@gmail.com>
  24  */
  25
  26 use MediaWiki\MediaWikiServices;
  27
  28 /**
  29  * File reversion user interface
  30  *
  31  * @ingroup Actions
  32  */
  33 class RevertAction extends FormAction {
  34         /**
  35          * @var OldLocalFile
  36          */
  37         protected $oldFile;
  38
  39         public function getName() {
  40                 return 'revert';
  41         }
  42
  43         public function getRestriction() {
  44                 return 'upload';
  45         }
  46
  47         protected function checkCanExecute( User $user ) {
  48                 if ( $this->getTitle()->getNamespace() !== NS_FILE ) {
  49                         throw new ErrorPageError( $this->msg( 'nosuchaction' ), $this->msg( 'nosuchactiontext' ) );
  50                 }
  51                 parent::checkCanExecute( $user );
  52
  53                 $oldimage = $this->getRequest()->getText( 'oldimage' );
  54                 if ( strlen( $oldimage ) < 16
  55                         || strpos( $oldimage, '/' ) !== false
  56                         || strpos( $oldimage, '\\' ) !== false
  57                 ) {
  58                         throw new ErrorPageError( 'internalerror', 'unexpected', [ 'oldimage', $oldimage ] );
  59                 }
  60
  61                 $this->oldFile = RepoGroup::singleton()->getLocalRepo()->newFromArchiveName(
  62                         $this->getTitle(),
  63                         $oldimage
  64                 );
  65
  66                 if ( !$this->oldFile->exists() ) {
  67                         throw new ErrorPageError( '', 'filerevert-badversion' );
  68                 }
  69         }
  70
  71         protected function usesOOUI() {
  72                 return true;
  73         }
  74
  75         protected function alterForm( HTMLForm $form ) {
  76                 $form->setWrapperLegendMsg( 'filerevert-legend' );
  77                 $form->setSubmitTextMsg( 'filerevert-submit' );
  78                 $form->addHiddenField( 'oldimage', $this->getRequest()->getText( 'oldimage' ) );
  79                 $form->setTokenSalt( [ 'revert', $this->getTitle()->getPrefixedDBkey() ] );
  80         }
  81
  82         protected function getFormFields() {
  83                 $timestamp = $this->oldFile->getTimestamp();
  84
  85                 $user = $this->getUser();
  86                 $lang = $this->getLanguage();
  87                 $userDate = $lang->userDate( $timestamp, $user );
  88                 $userTime = $lang->userTime( $timestamp, $user );
  89                 $siteTs = MWTimestamp::getLocalInstance( $timestamp );
  90                 $ts = $siteTs->format( 'YmdHis' );
  91                 $contLang = MediaWikiServices::getInstance()->getContentLanguage();
  92                 $siteDate = $contLang->date( $ts, false, false );
  93                 $siteTime = $contLang->time( $ts, false, false );
  94                 $tzMsg = $siteTs->getTimezoneMessage()->inContentLanguage()->text();
  95
  96                 return [
  97                         'intro' => [
  98                                 'type' => 'info',
  99                                 'vertical-label' => true,
 100                                 'raw' => true,
 101                                 'default' => $this->msg( 'filerevert-intro',
 102                                         $this->getTitle()->getText(), $userDate, $userTime,
 103                                         wfExpandUrl(
 104                                                 $this->page->getFile()->getArchiveUrl( $this->getRequest()->getText( 'oldimage' ) ),
 105                                                 PROTO_CURRENT
 106                                         ) )->parseAsBlock()
 107                         ],
 108                         'comment' => [
 109                                 'type' => 'text',
 110                                 'label-message' => 'filerevert-comment',
 111                                 'default' => $this->msg( 'filerevert-defaultcomment', $siteDate, $siteTime,
 112                                         $tzMsg )->inContentLanguage()->text()
 113                         ]
 114                 ];
 115         }
 116
 117         public function onSubmit( $data ) {
 118                 $this->useTransactionalTimeLimit();
 119
 120                 $old = $this->getRequest()->getText( 'oldimage' );
 121                 $localFile = $this->page->getFile();
 122                 $oldFile = OldLocalFile::newFromArchiveName( $this->getTitle(), $localFile->getRepo(), $old );
 123
 124                 $source = $localFile->getArchiveVirtualUrl( $old );
 125                 $comment = $data['comment'];
 126
 127                 if ( $localFile->getSha1() === $oldFile->getSha1() ) {
 128                         return Status::newFatal( 'filerevert-identical' );
 129                 }
 130
 131                 // TODO: Preserve file properties from database instead of reloading from file
 132                 return $localFile->upload(
 133                         $source,
 134                         $comment,
 135                         $comment,
 136                         0,
 137                         false,
 138                         false,
 139                         $this->getUser(),
 140                         [],
 141                         true,
 142                         true
 143                 );
 144         }
 145
 146         public function onSuccess() {
 147                 $timestamp = $this->oldFile->getTimestamp();
 148                 $user = $this->getUser();
 149                 $lang = $this->getLanguage();
 150                 $userDate = $lang->userDate( $timestamp, $user );
 151                 $userTime = $lang->userTime( $timestamp, $user );
 152
 153                 $this->getOutput()->addWikiMsg( 'filerevert-success', $this->getTitle()->getText(),
 154                         $userDate, $userTime,
 155                         wfExpandUrl( $this->page->getFile()->getArchiveUrl( $this->getRequest()->getText( 'oldimage' ) ),
 156                                 PROTO_CURRENT
 157                 ) );
 158                 $this->getOutput()->returnToMain( false, $this->getTitle() );
 159         }
 160
 161         protected function getPageTitle() {
 162                 return $this->msg( 'filerevert', $this->getTitle()->getText() );
 163         }
 164
 165         protected function getDescription() {
 166                 return OutputPage::buildBacklinkSubtitle( $this->getTitle() );
 167         }
 168
 169         public function doesWrites() {
 170                 return true;
 171         }
 172 }