merged master

[lhc/web/wiklou.git] / includes / api / ApiImport.php

diff --git a/includes/api/ApiImport.php b/includes/api/ApiImport.php
index 8c03106..5093b6b 100644 (file)
--- a/includes/api/ApiImport.php
+++ b/includes/api/ApiImport.php
@@ -1,10 +1,10 @@
 <?php
 /**
- * API for MediaWiki 1.8+
+ *
  *
  * Created on Feb 4, 2009
  *
- * Copyright © 2009 Roan Kattouw <Firstname>.<Lastname>@home.nl
+ * Copyright © 2009 Roan Kattouw <Firstname>.<Lastname>@gmail.com
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -24,11 +24,6 @@
  * @file
  */
 
-if ( !defined( 'MEDIAWIKI' ) ) {
-       // Eclipse helper - will be ignored in production
-       require_once( 'ApiBase.php' );
-}
-
 /**
  * API module that imports an XML file like Special:Import does
  *
@@ -41,14 +36,14 @@ class ApiImport extends ApiBase {
        }
 
        public function execute() {
-               global $wgUser;
-               if ( !$wgUser->isAllowed( 'import' ) ) {
-                       $this->dieUsageMsg( array( 'cantimport' ) );
-               }
+               $user = $this->getUser();
                $params = $this->extractRequestParams();
 
                $isUpload = false;
                if ( isset( $params['interwikisource'] ) ) {
+                       if ( !$user->isAllowed( 'import' ) ) {
+                               $this->dieUsageMsg( 'cantimport' );
+                       }
                        if ( !isset( $params['interwikipage'] ) ) {
                                $this->dieUsageMsg( array( 'missingparam', 'interwikipage' ) );
                        }
@@ -60,21 +55,16 @@ class ApiImport extends ApiBase {
                        );
                } else {
                        $isUpload = true;
-                       if ( !$wgUser->isAllowed( 'importupload' ) ) {
-                               $this->dieUsageMsg( array( 'cantimport-upload' ) );
+                       if ( !$user->isAllowed( 'importupload' ) ) {
+                               $this->dieUsageMsg( 'cantimport-upload' );
                        }
                        $source = ImportStreamSource::newFromUpload( 'xml' );
                }
-               if ( $source instanceof WikiErrorMsg ) {
-                       $this->dieUsageMsg( array_merge(
-                               array( $source->getMessageKey() ),
-                               $source->getMessageArgs() ) );
-               } elseif ( WikiError::isError( $source ) ) {
-                       // This shouldn't happen
-                       $this->dieUsageMsg( array( 'import-unknownerror', $source->getMessage() ) );
+               if ( !$source->isOK() ) {
+                       $this->dieUsageMsg( $source->getErrorsArray() );
                }
 
-               $importer = new WikiImporter( $source );
+               $importer = new WikiImporter( $source->value );
                if ( isset( $params['namespace'] ) ) {
                        $importer->setTargetNamespace( $params['namespace'] );
                }
@@ -85,20 +75,16 @@ class ApiImport extends ApiBase {
                        $params['summary']
                );
 
-               $result = $importer->doImport();
-               if ( $result instanceof WikiXmlError ) {
-                       $this->dieUsageMsg( array( 'import-xml-error',
-                               $result->mLine,
-                               $result->mColumn,
-                               $result->mByte . $result->mContext,
-                               xml_error_string( $result->mXmlError ) ) );
-               } elseif ( WikiError::isError( $result ) ) {
-                       $this->dieUsageMsg( array( 'import-unknownerror', $result->getMessage() ) ); // This shouldn't happen
+               try {
+                       $importer->doImport();
+               } catch ( MWException $e ) {
+                       $this->dieUsageMsg( array( 'import-unknownerror', $e->getMessage() ) );
                }
 
                $resultData = $reporter->getData();
-               $this->getResult()->setIndexedTagName( $resultData, 'page' );
-               $this->getResult()->addValue( null, $this->getModuleName(), $resultData );
+               $result = $this->getResult();
+               $result->setIndexedTagName( $resultData, 'page' );
+               $result->addValue( null, $this->getModuleName(), $resultData );
        }
 
        public function mustBePosted() {
@@ -141,7 +127,11 @@ class ApiImport extends ApiBase {
        }
 
        public function getDescription() {
-               return 'Import a page from another wiki, or an XML file';
+               return array(
+                       'Import a page from another wiki, or an XML file.' ,
+                       'Note that the HTTP POST must be done as a file upload (i.e. using multipart/form-data) when',
+                       'sending a file for the "xml" parameter.'
+               );
        }
 
        public function getPossibleErrors() {
@@ -162,13 +152,17 @@ class ApiImport extends ApiBase {
                return '';
        }
 
-       protected function getExamples() {
+       public function getExamples() {
                return array(
-                       'Import [[meta:Help:Parserfunctions]] to namespace 100 with full history:',
-                       '  api.php?action=import&interwikisource=meta&interwikipage=Help:ParserFunctions&namespace=100&fullhistory&token=123ABC',
+                       'api.php?action=import&interwikisource=meta&interwikipage=Help:ParserFunctions&namespace=100&fullhistory=&token=123ABC'
+                               => 'Import [[meta:Help:Parserfunctions]] to namespace 100 with full history',
                );
        }
 
+       public function getHelpUrls() {
+               return 'https://www.mediawiki.org/wiki/API:Import';
+       }
+
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }
@@ -181,11 +175,27 @@ class ApiImport extends ApiBase {
 class ApiImportReporter extends ImportReporter {
        private $mResultArr = array();
 
+       /**
+        * @param $title Title
+        * @param $origTitle Title
+        * @param $revisionCount int
+        * @param $successCount int
+        * @param $pageInfo
+        * @return void
+        */
        function reportPage( $title, $origTitle, $revisionCount, $successCount, $pageInfo ) {
                // Add a result entry
                $r = array();
-               ApiQueryBase::addTitleInfo( $r, $title );
-               $r['revisions'] = intval( $successCount );
+
+               if ( $title === null ) {\r
+                       # Invalid or non-importable title
+                       $r['title'] = $pageInfo['title'];
+                       $r['invalid'] = '';\r
+               } else {\r
+                       ApiQueryBase::addTitleInfo( $r, $title );
+                       $r['revisions'] = intval( $successCount );
+               }
+
                $this->mResultArr[] = $r;
 
                // Piggyback on the parent to do the logging