includes/api/ApiImport.php

   1 <?php
   2 /**
   3  * API for MediaWiki 1.8+
   4  *
   5  * Created on Feb 4, 2009
   6  *
   7  * Copyright © 2009 Roan Kattouw <Firstname>.<Lastname>@home.nl
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  */
  26
  27 if ( !defined( 'MEDIAWIKI' ) ) {
  28         // Eclipse helper - will be ignored in production
  29         require_once( 'ApiBase.php' );
  30 }
  31
  32 /**
  33  * API module that imports an XML file like Special:Import does
  34  *
  35  * @ingroup API
  36  */
  37 class ApiImport extends ApiBase {
  38
  39         public function __construct( $main, $action ) {
  40                 parent::__construct( $main, $action );
  41         }
  42
  43         public function execute() {
  44                 global $wgUser;
  45                 if ( !$wgUser->isAllowed( 'import' ) ) {
  46                         $this->dieUsageMsg( array( 'cantimport' ) );
  47                 }
  48                 $params = $this->extractRequestParams();
  49
  50                 $isUpload = false;
  51                 if ( isset( $params['interwikisource'] ) ) {
  52                         if ( !isset( $params['interwikipage'] ) ) {
  53                                 $this->dieUsageMsg( array( 'missingparam', 'interwikipage' ) );
  54                         }
  55                         $source = ImportStreamSource::newFromInterwiki(
  56                                 $params['interwikisource'],
  57                                 $params['interwikipage'],
  58                                 $params['fullhistory'],
  59                                 $params['templates']
  60                         );
  61                 } else {
  62                         $isUpload = true;
  63                         if ( !$wgUser->isAllowed( 'importupload' ) ) {
  64                                 $this->dieUsageMsg( array( 'cantimport-upload' ) );
  65                         }
  66                         $source = ImportStreamSource::newFromUpload( 'xml' );
  67                 }
  68                 if ( $source instanceof WikiErrorMsg ) {
  69                         $this->dieUsageMsg( array_merge(
  70                                 array( $source->getMessageKey() ),
  71                                 $source->getMessageArgs() ) );
  72                 } elseif ( WikiError::isError( $source ) ) {
  73                         // This shouldn't happen
  74                         $this->dieUsageMsg( array( 'import-unknownerror', $source->getMessage() ) );
  75                 }
  76
  77                 $importer = new WikiImporter( $source );
  78                 if ( isset( $params['namespace'] ) ) {
  79                         $importer->setTargetNamespace( $params['namespace'] );
  80                 }
  81                 $reporter = new ApiImportReporter(
  82                         $importer,
  83                         $isUpload,
  84                         $params['interwikisource'],
  85                         $params['summary']
  86                 );
  87
  88                 $result = $importer->doImport();
  89                 if ( $result instanceof WikiXmlError ) {
  90                         $this->dieUsageMsg( array( 'import-xml-error',
  91                                 $result->mLine,
  92                                 $result->mColumn,
  93                                 $result->mByte . $result->mContext,
  94                                 xml_error_string( $result->mXmlError ) ) );
  95                 } elseif ( WikiError::isError( $result ) ) {
  96                         $this->dieUsageMsg( array( 'import-unknownerror', $result->getMessage() ) ); // This shouldn't happen
  97                 }
  98
  99                 $resultData = $reporter->getData();
 100                 $this->getResult()->setIndexedTagName( $resultData, 'page' );
 101                 $this->getResult()->addValue( null, $this->getModuleName(), $resultData );
 102         }
 103
 104         public function mustBePosted() {
 105                 return true;
 106         }
 107
 108         public function isWriteMode() {
 109                 return true;
 110         }
 111
 112         public function getAllowedParams() {
 113                 global $wgImportSources;
 114                 return array(
 115                         'token' => null,
 116                         'summary' => null,
 117                         'xml' => null,
 118                         'interwikisource' => array(
 119                                 ApiBase::PARAM_TYPE => $wgImportSources
 120                         ),
 121                         'interwikipage' => null,
 122                         'fullhistory' => false,
 123                         'templates' => false,
 124                         'namespace' => array(
 125                                 ApiBase::PARAM_TYPE => 'namespace'
 126                         )
 127                 );
 128         }
 129
 130         public function getParamDescription() {
 131                 return array(
 132                         'token' => 'Import token obtained through prop=info',
 133                         'summary' => 'Import summary',
 134                         'xml' => 'Uploaded XML file',
 135                         'interwikisource' => 'For interwiki imports: wiki to import from',
 136                         'interwikipage' => 'For interwiki imports: page to import',
 137                         'fullhistory' => 'For interwiki imports: import the full history, not just the current version',
 138                         'templates' => 'For interwiki imports: import all included templates as well',
 139                         'namespace' => 'For interwiki imports: import to this namespace',
 140                 );
 141         }
 142
 143         public function getDescription() {
 144                 return 'Import a page from another wiki, or an XML file';
 145         }
 146
 147         public function getPossibleErrors() {
 148                 return array_merge( parent::getPossibleErrors(), array(
 149                         array( 'cantimport' ),
 150                         array( 'missingparam', 'interwikipage' ),
 151                         array( 'cantimport-upload' ),
 152                         array( 'import-unknownerror', 'source' ),
 153                         array( 'import-unknownerror', 'result' ),
 154                 ) );
 155         }
 156
 157         public function needsToken() {
 158                 return true;
 159         }
 160
 161         public function getTokenSalt() {
 162                 return '';
 163         }
 164
 165         protected function getExamples() {
 166                 return array(
 167                         'Import [[meta:Help:Parserfunctions]] to namespace 100 with full history:',
 168                         '  api.php?action=import&interwikisource=meta&interwikipage=Help:ParserFunctions&namespace=100&fullhistory=&token=123ABC',
 169                 );
 170         }
 171
 172         public function getVersion() {
 173                 return __CLASS__ . ': $Id$';
 174         }
 175 }
 176
 177 /**
 178  * Import reporter for the API
 179  * @ingroup API
 180  */
 181 class ApiImportReporter extends ImportReporter {
 182         private $mResultArr = array();
 183
 184         function reportPage( $title, $origTitle, $revisionCount, $successCount, $pageInfo ) {
 185                 // Add a result entry
 186                 $r = array();
 187                 ApiQueryBase::addTitleInfo( $r, $title );
 188                 $r['revisions'] = intval( $successCount );
 189                 $this->mResultArr[] = $r;
 190
 191                 // Piggyback on the parent to do the logging
 192                 parent::reportPage( $title, $origTitle, $revisionCount, $successCount, $pageInfo );
 193         }
 194
 195         function getData() {
 196                 return $this->mResultArr;
 197         }
 198 }