includes/api/ApiImport.php

   1 <?php
   2 /**
   3  * Copyright © 2009 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
   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 along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 /**
  24  * API module that imports an XML file like Special:Import does
  25  *
  26  * @ingroup API
  27  */
  28 class ApiImport extends ApiBase {
  29
  30         public function execute() {
  31                 $this->useTransactionalTimeLimit();
  32
  33                 $user = $this->getUser();
  34                 $params = $this->extractRequestParams();
  35
  36                 $this->requireMaxOneParameter( $params, 'namespace', 'rootpage' );
  37
  38                 $isUpload = false;
  39                 if ( isset( $params['interwikisource'] ) ) {
  40                         if ( !$user->isAllowed( 'import' ) ) {
  41                                 $this->dieWithError( 'apierror-cantimport' );
  42                         }
  43                         if ( !isset( $params['interwikipage'] ) ) {
  44                                 $this->dieWithError( [ 'apierror-missingparam', 'interwikipage' ] );
  45                         }
  46                         $source = ImportStreamSource::newFromInterwiki(
  47                                 $params['interwikisource'],
  48                                 $params['interwikipage'],
  49                                 $params['fullhistory'],
  50                                 $params['templates']
  51                         );
  52                         $usernamePrefix = $params['interwikisource'];
  53                 } else {
  54                         $isUpload = true;
  55                         if ( !$user->isAllowed( 'importupload' ) ) {
  56                                 $this->dieWithError( 'apierror-cantimport-upload' );
  57                         }
  58                         $source = ImportStreamSource::newFromUpload( 'xml' );
  59                         $usernamePrefix = (string)$params['interwikiprefix'];
  60                         if ( $usernamePrefix === '' ) {
  61                                 $encParamName = $this->encodeParamName( 'interwikiprefix' );
  62                                 $this->dieWithError( [ 'apierror-missingparam', $encParamName ] );
  63                         }
  64                 }
  65                 if ( !$source->isOK() ) {
  66                         $this->dieStatus( $source );
  67                 }
  68
  69                 // Check if user can add the log entry tags which were requested
  70                 if ( $params['tags'] ) {
  71                         $ableToTag = ChangeTags::canAddTagsAccompanyingChange( $params['tags'], $user );
  72                         if ( !$ableToTag->isOK() ) {
  73                                 $this->dieStatus( $ableToTag );
  74                         }
  75                 }
  76
  77                 $importer = new WikiImporter( $source->value, $this->getConfig() );
  78                 if ( isset( $params['namespace'] ) ) {
  79                         $importer->setTargetNamespace( $params['namespace'] );
  80                 } elseif ( isset( $params['rootpage'] ) ) {
  81                         $statusRootPage = $importer->setTargetRootPage( $params['rootpage'] );
  82                         if ( !$statusRootPage->isGood() ) {
  83                                 $this->dieStatus( $statusRootPage );
  84                         }
  85                 }
  86                 $importer->setUsernamePrefix( $usernamePrefix, $params['assignknownusers'] );
  87                 $reporter = new ApiImportReporter(
  88                         $importer,
  89                         $isUpload,
  90                         $params['interwikisource'],
  91                         $params['summary']
  92                 );
  93                 if ( $params['tags'] ) {
  94                         $reporter->setChangeTags( $params['tags'] );
  95                 }
  96
  97                 try {
  98                         $importer->doImport();
  99                 } catch ( Exception $e ) {
 100                         $this->dieWithException( $e, [ 'wrap' => 'apierror-import-unknownerror' ] );
 101                 }
 102
 103                 $resultData = $reporter->getData();
 104                 $result = $this->getResult();
 105                 ApiResult::setIndexedTagName( $resultData, 'page' );
 106                 $result->addValue( null, $this->getModuleName(), $resultData );
 107         }
 108
 109         /**
 110          * Returns a list of interwiki prefixes corresponding to each defined import
 111          * source.
 112          *
 113          * @return array
 114          * @since 1.27
 115          */
 116         public function getAllowedImportSources() {
 117                 $importSources = $this->getConfig()->get( 'ImportSources' );
 118                 Hooks::run( 'ImportSources', [ &$importSources ] );
 119
 120                 $result = [];
 121                 foreach ( $importSources as $key => $value ) {
 122                         if ( is_int( $key ) ) {
 123                                 $result[] = $value;
 124                         } else {
 125                                 foreach ( $value as $subproject ) {
 126                                         $result[] = "$key:$subproject";
 127                                 }
 128                         }
 129                 }
 130                 return $result;
 131         }
 132
 133         public function mustBePosted() {
 134                 return true;
 135         }
 136
 137         public function isWriteMode() {
 138                 return true;
 139         }
 140
 141         public function getAllowedParams() {
 142                 return [
 143                         'summary' => null,
 144                         'xml' => [
 145                                 ApiBase::PARAM_TYPE => 'upload',
 146                         ],
 147                         'interwikiprefix' => [
 148                                 ApiBase::PARAM_TYPE => 'string',
 149                         ],
 150                         'interwikisource' => [
 151                                 ApiBase::PARAM_TYPE => $this->getAllowedImportSources(),
 152                         ],
 153                         'interwikipage' => null,
 154                         'fullhistory' => false,
 155                         'templates' => false,
 156                         'namespace' => [
 157                                 ApiBase::PARAM_TYPE => 'namespace'
 158                         ],
 159                         'assignknownusers' => false,
 160                         'rootpage' => null,
 161                         'tags' => [
 162                                 ApiBase::PARAM_TYPE => 'tags',
 163                                 ApiBase::PARAM_ISMULTI => true,
 164                         ],
 165                 ];
 166         }
 167
 168         public function needsToken() {
 169                 return 'csrf';
 170         }
 171
 172         protected function getExamplesMessages() {
 173                 return [
 174                         'action=import&interwikisource=meta&interwikipage=Help:ParserFunctions&' .
 175                                 'namespace=100&fullhistory=&token=123ABC'
 176                                 => 'apihelp-import-example-import',
 177                 ];
 178         }
 179
 180         public function getHelpUrls() {
 181                 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Import';
 182         }
 183 }
 184
 185 /**
 186  * Import reporter for the API
 187  * @ingroup API
 188  */
 189 class ApiImportReporter extends ImportReporter {
 190         private $mResultArr = [];
 191
 192         /**
 193          * @param Title $title
 194          * @param Title $origTitle
 195          * @param int $revisionCount
 196          * @param int $successCount
 197          * @param array $pageInfo
 198          * @return void
 199          */
 200         public function reportPage( $title, $origTitle, $revisionCount, $successCount, $pageInfo ) {
 201                 // Add a result entry
 202                 $r = [];
 203
 204                 if ( $title === null ) {
 205                         # Invalid or non-importable title
 206                         $r['title'] = $pageInfo['title'];
 207                         $r['invalid'] = true;
 208                 } else {
 209                         ApiQueryBase::addTitleInfo( $r, $title );
 210                         $r['revisions'] = intval( $successCount );
 211                 }
 212
 213                 $this->mResultArr[] = $r;
 214
 215                 // Piggyback on the parent to do the logging
 216                 parent::reportPage( $title, $origTitle, $revisionCount, $successCount, $pageInfo );
 217         }
 218
 219         public function getData() {
 220                 return $this->mResultArr;
 221         }
 222 }