includes/specials/SpecialImport.php

   1 <?php
   2 /**
   3  * Implements Special:Import
   4  *
   5  * Copyright © 2003,2005 Brion Vibber <brion@pobox.com>
   6  * https://www.mediawiki.org/
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21  * http://www.gnu.org/copyleft/gpl.html
  22  *
  23  * @file
  24  * @ingroup SpecialPage
  25  */
  26
  27 /**
  28  * MediaWiki page data importer
  29  *
  30  * @ingroup SpecialPage
  31  */
  32 class SpecialImport extends SpecialPage {
  33         private $sourceName = false;
  34         private $interwiki = false;
  35         private $subproject;
  36         private $fullInterwikiPrefix;
  37         private $mapping = 'default';
  38         private $namespace;
  39         private $rootpage = '';
  40         private $frompage = '';
  41         private $logcomment = false;
  42         private $history = true;
  43         private $includeTemplates = false;
  44         private $pageLinkDepth;
  45         private $importSources;
  46         private $assignKnownUsers;
  47         private $usernamePrefix;
  48
  49         public function __construct() {
  50                 parent::__construct( 'Import', 'import' );
  51         }
  52
  53         public function doesWrites() {
  54                 return true;
  55         }
  56
  57         /**
  58          * Execute
  59          * @param string|null $par
  60          * @throws PermissionsError
  61          * @throws ReadOnlyError
  62          */
  63         function execute( $par ) {
  64                 $this->useTransactionalTimeLimit();
  65
  66                 $this->setHeaders();
  67                 $this->outputHeader();
  68
  69                 $this->namespace = $this->getConfig()->get( 'ImportTargetNamespace' );
  70
  71                 $this->getOutput()->addModules( 'mediawiki.special.import' );
  72
  73                 $this->importSources = $this->getConfig()->get( 'ImportSources' );
  74                 Hooks::run( 'ImportSources', [ &$this->importSources ] );
  75
  76                 $user = $this->getUser();
  77                 if ( !$user->isAllowedAny( 'import', 'importupload' ) ) {
  78                         throw new PermissionsError( 'import' );
  79                 }
  80
  81                 # @todo Allow Title::getUserPermissionsErrors() to take an array
  82                 # @todo FIXME: Title::checkSpecialsAndNSPermissions() has a very weird expectation of what
  83                 # getUserPermissionsErrors() might actually be used for, hence the 'ns-specialprotected'
  84                 $errors = wfMergeErrorArrays(
  85                         $this->getPageTitle()->getUserPermissionsErrors(
  86                                 'import', $user, true,
  87                                 [ 'ns-specialprotected', 'badaccess-group0', 'badaccess-groups' ]
  88                         ),
  89                         $this->getPageTitle()->getUserPermissionsErrors(
  90                                 'importupload', $user, true,
  91                                 [ 'ns-specialprotected', 'badaccess-group0', 'badaccess-groups' ]
  92                         )
  93                 );
  94
  95                 if ( $errors ) {
  96                         throw new PermissionsError( 'import', $errors );
  97                 }
  98
  99                 $this->checkReadOnly();
 100
 101                 $request = $this->getRequest();
 102                 if ( $request->wasPosted() && $request->getVal( 'action' ) == 'submit' ) {
 103                         $this->doImport();
 104                 }
 105                 $this->showForm();
 106         }
 107
 108         /**
 109          * Do the actual import
 110          */
 111         private function doImport() {
 112                 $isUpload = false;
 113                 $request = $this->getRequest();
 114                 $this->sourceName = $request->getVal( "source" );
 115                 $this->assignKnownUsers = $request->getCheck( 'assignKnownUsers' );
 116
 117                 $this->logcomment = $request->getText( 'log-comment' );
 118                 $this->pageLinkDepth = $this->getConfig()->get( 'ExportMaxLinkDepth' ) == 0
 119                         ? 0
 120                         : $request->getIntOrNull( 'pagelink-depth' );
 121
 122                 $this->mapping = $request->getVal( 'mapping' );
 123                 if ( $this->mapping === 'namespace' ) {
 124                         $this->namespace = $request->getIntOrNull( 'namespace' );
 125                 } elseif ( $this->mapping === 'subpage' ) {
 126                         $this->rootpage = $request->getText( 'rootpage' );
 127                 } else {
 128                         $this->mapping = 'default';
 129                 }
 130
 131                 $user = $this->getUser();
 132                 if ( !$user->matchEditToken( $request->getVal( 'editToken' ) ) ) {
 133                         $source = Status::newFatal( 'import-token-mismatch' );
 134                 } elseif ( $this->sourceName === 'upload' ) {
 135                         $isUpload = true;
 136                         $this->usernamePrefix = $this->fullInterwikiPrefix = $request->getVal( 'usernamePrefix' );
 137                         if ( $user->isAllowed( 'importupload' ) ) {
 138                                 $source = ImportStreamSource::newFromUpload( "xmlimport" );
 139                         } else {
 140                                 throw new PermissionsError( 'importupload' );
 141                         }
 142                 } elseif ( $this->sourceName === 'interwiki' ) {
 143                         if ( !$user->isAllowed( 'import' ) ) {
 144                                 throw new PermissionsError( 'import' );
 145                         }
 146                         $this->interwiki = $this->fullInterwikiPrefix = $request->getVal( 'interwiki' );
 147                         // does this interwiki have subprojects?
 148                         $hasSubprojects = array_key_exists( $this->interwiki, $this->importSources );
 149                         if ( !$hasSubprojects && !in_array( $this->interwiki, $this->importSources ) ) {
 150                                 $source = Status::newFatal( "import-invalid-interwiki" );
 151                         } else {
 152                                 if ( $hasSubprojects ) {
 153                                         $this->subproject = $request->getVal( 'subproject' );
 154                                         $this->fullInterwikiPrefix .= ':' . $request->getVal( 'subproject' );
 155                                 }
 156                                 if ( $hasSubprojects &&
 157                                         !in_array( $this->subproject, $this->importSources[$this->interwiki] )
 158                                 ) {
 159                                         $source = Status::newFatal( "import-invalid-interwiki" );
 160                                 } else {
 161                                         $this->history = $request->getCheck( 'interwikiHistory' );
 162                                         $this->frompage = $request->getText( "frompage" );
 163                                         $this->includeTemplates = $request->getCheck( 'interwikiTemplates' );
 164                                         $source = ImportStreamSource::newFromInterwiki(
 165                                                 $this->fullInterwikiPrefix,
 166                                                 $this->frompage,
 167                                                 $this->history,
 168                                                 $this->includeTemplates,
 169                                                 $this->pageLinkDepth );
 170                                 }
 171                         }
 172                 } else {
 173                         $source = Status::newFatal( "importunknownsource" );
 174                 }
 175
 176                 if ( (string)$this->fullInterwikiPrefix === '' ) {
 177                         $source->fatal( 'importnoprefix' );
 178                 }
 179
 180                 $out = $this->getOutput();
 181                 if ( !$source->isGood() ) {
 182                         $out->wrapWikiTextAsInterface( 'error',
 183                                 $this->msg( 'importfailed', $source->getWikiText() )->plain()
 184                         );
 185                 } else {
 186                         $importer = new WikiImporter( $source->value, $this->getConfig() );
 187                         if ( !is_null( $this->namespace ) ) {
 188                                 $importer->setTargetNamespace( $this->namespace );
 189                         } elseif ( !is_null( $this->rootpage ) ) {
 190                                 $statusRootPage = $importer->setTargetRootPage( $this->rootpage );
 191                                 if ( !$statusRootPage->isGood() ) {
 192                                         $out->wrapWikiMsg(
 193                                                 "<div class=\"error\">\n$1\n</div>",
 194                                                 [
 195                                                         'import-options-wrong',
 196                                                         $statusRootPage->getWikiText(),
 197                                                         count( $statusRootPage->getErrorsArray() )
 198                                                 ]
 199                                         );
 200
 201                                         return;
 202                                 }
 203                         }
 204                         $importer->setUsernamePrefix( $this->fullInterwikiPrefix, $this->assignKnownUsers );
 205
 206                         $out->addWikiMsg( "importstart" );
 207
 208                         $reporter = new ImportReporter(
 209                                 $importer,
 210                                 $isUpload,
 211                                 $this->fullInterwikiPrefix,
 212                                 $this->logcomment
 213                         );
 214                         $reporter->setContext( $this->getContext() );
 215                         $exception = false;
 216
 217                         $reporter->open();
 218                         try {
 219                                 $importer->doImport();
 220                         } catch ( Exception $e ) {
 221                                 $exception = $e;
 222                         }
 223                         $result = $reporter->close();
 224
 225                         if ( $exception ) {
 226                                 # No source or XML parse error
 227                                 $out->wrapWikiMsg(
 228                                         "<div class=\"error\">\n$1\n</div>",
 229                                         [ 'importfailed', $exception->getMessage() ]
 230                                 );
 231                         } elseif ( !$result->isGood() ) {
 232                                 # Zero revisions
 233                                 $out->wrapWikiMsg(
 234                                         "<div class=\"error\">\n$1\n</div>",
 235                                         [ 'importfailed', $result->getWikiText() ]
 236                                 );
 237                         } else {
 238                                 # Success!
 239                                 $out->addWikiMsg( 'importsuccess' );
 240                         }
 241                         $out->addHTML( '<hr />' );
 242                 }
 243         }
 244
 245         private function getMappingFormPart( $sourceName ) {
 246                 $isSameSourceAsBefore = ( $this->sourceName === $sourceName );
 247                 $defaultNamespace = $this->getConfig()->get( 'ImportTargetNamespace' );
 248                 return "<tr>
 249                                         <td>
 250                                         </td>
 251                                         <td class='mw-input'>" .
 252                                         Xml::radioLabel(
 253                                                 $this->msg( 'import-mapping-default' )->text(),
 254                                                 'mapping',
 255                                                 'default',
 256                                                 // mw-import-mapping-interwiki-default, mw-import-mapping-upload-default
 257                                                 "mw-import-mapping-$sourceName-default",
 258                                                 ( $isSameSourceAsBefore ?
 259                                                         ( $this->mapping === 'default' ) :
 260                                                         is_null( $defaultNamespace ) )
 261                                         ) .
 262                                         "</td>
 263                                 </tr>
 264                                 <tr>
 265                                         <td>
 266                                         </td>
 267                                         <td class='mw-input'>" .
 268                                         Xml::radioLabel(
 269                                                 $this->msg( 'import-mapping-namespace' )->text(),
 270                                                 'mapping',
 271                                                 'namespace',
 272                                                 // mw-import-mapping-interwiki-namespace, mw-import-mapping-upload-namespace
 273                                                 "mw-import-mapping-$sourceName-namespace",
 274                                                 ( $isSameSourceAsBefore ?
 275                                                         ( $this->mapping === 'namespace' ) :
 276                                                         !is_null( $defaultNamespace ) )
 277                                         ) . ' ' .
 278                                         Html::namespaceSelector(
 279                                                 [
 280                                                         'selected' => ( $isSameSourceAsBefore ?
 281                                                                 $this->namespace :
 282                                                                 ( $defaultNamespace || '' ) ),
 283                                                         'in-user-lang' => true,
 284                                                 ], [
 285                                                         'name' => "namespace",
 286                                                         // mw-import-namespace-interwiki, mw-import-namespace-upload
 287                                                         'id' => "mw-import-namespace-$sourceName",
 288                                                         'class' => 'namespaceselector',
 289                                                 ]
 290                                         ) .
 291                                         "</td>
 292                                 </tr>
 293                                 <tr>
 294                                         <td>
 295                                         </td>
 296                                         <td class='mw-input'>" .
 297                                         Xml::radioLabel(
 298                                                 $this->msg( 'import-mapping-subpage' )->text(),
 299                                                 'mapping',
 300                                                 'subpage',
 301                                                 // mw-import-mapping-interwiki-subpage, mw-import-mapping-upload-subpage
 302                                                 "mw-import-mapping-$sourceName-subpage",
 303                                                 ( $isSameSourceAsBefore ? ( $this->mapping === 'subpage' ) : '' )
 304                                         ) . ' ' .
 305                                         Xml::input( 'rootpage', 50,
 306                                                 ( $isSameSourceAsBefore ? $this->rootpage : '' ),
 307                                                 [
 308                                                         // Should be "mw-import-rootpage-...", but we keep this inaccurate
 309                                                         // ID for legacy reasons
 310                                                         // mw-interwiki-rootpage-interwiki, mw-interwiki-rootpage-upload
 311                                                         'id' => "mw-interwiki-rootpage-$sourceName",
 312                                                         'type' => 'text'
 313                                                 ]
 314                                         ) . ' ' .
 315                                         "</td>
 316                                 </tr>";
 317         }
 318
 319         private function showForm() {
 320                 $action = $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] );
 321                 $user = $this->getUser();
 322                 $out = $this->getOutput();
 323                 $this->addHelpLink( '//meta.wikimedia.org/wiki/Special:MyLanguage/Help:Import', true );
 324
 325                 if ( $user->isAllowed( 'importupload' ) ) {
 326                         $mappingSelection = $this->getMappingFormPart( 'upload' );
 327                         $out->addHTML(
 328                                 Xml::fieldset( $this->msg( 'import-upload' )->text() ) .
 329                                         Xml::openElement(
 330                                                 'form',
 331                                                 [
 332                                                         'enctype' => 'multipart/form-data',
 333                                                         'method' => 'post',
 334                                                         'action' => $action,
 335                                                         'id' => 'mw-import-upload-form'
 336                                                 ]
 337                                         ) .
 338                                         $this->msg( 'importtext' )->parseAsBlock() .
 339                                         Html::hidden( 'action', 'submit' ) .
 340                                         Html::hidden( 'source', 'upload' ) .
 341                                         Xml::openElement( 'table', [ 'id' => 'mw-import-table-upload' ] ) .
 342                                         "<tr>
 343                                         <td class='mw-label'>" .
 344                                         Xml::label( $this->msg( 'import-upload-filename' )->text(), 'xmlimport' ) .
 345                                         "</td>
 346                                         <td class='mw-input'>" .
 347                                         Html::input( 'xmlimport', '', 'file', [ 'id' => 'xmlimport' ] ) . ' ' .
 348                                         "</td>
 349                                 </tr>
 350                                 <tr>
 351                                         <td class='mw-label'>" .
 352                                         Xml::label( $this->msg( 'import-upload-username-prefix' )->text(),
 353                                                 'mw-import-usernamePrefix' ) .
 354                                         "</td>
 355                                         <td class='mw-input'>" .
 356                                         Xml::input( 'usernamePrefix', 50,
 357                                                 $this->usernamePrefix,
 358                                                 [ 'id' => 'usernamePrefix', 'type' => 'text' ] ) . ' ' .
 359                                         "</td>
 360                                 </tr>
 361                                 <tr>
 362                                         <td></td>
 363                                         <td class='mw-input'>" .
 364                                         Xml::checkLabel(
 365                                                 $this->msg( 'import-assign-known-users' )->text(),
 366                                                 'assignKnownUsers',
 367                                                 'assignKnownUsers',
 368                                                 $this->assignKnownUsers
 369                                         ) .
 370                                         "</td>
 371                                 </tr>
 372                                 <tr>
 373                                         <td class='mw-label'>" .
 374                                         Xml::label( $this->msg( 'import-comment' )->text(), 'mw-import-comment' ) .
 375                                         "</td>
 376                                         <td class='mw-input'>" .
 377                                         Xml::input( 'log-comment', 50,
 378                                                 ( $this->sourceName === 'upload' ? $this->logcomment : '' ),
 379                                                 [ 'id' => 'mw-import-comment', 'type' => 'text' ] ) . ' ' .
 380                                         "</td>
 381                                 </tr>
 382                                 $mappingSelection
 383                                 <tr>
 384                                         <td></td>
 385                                         <td class='mw-submit'>" .
 386                                         Xml::submitButton( $this->msg( 'uploadbtn' )->text() ) .
 387                                         "</td>
 388                                 </tr>" .
 389                                         Xml::closeElement( 'table' ) .
 390                                         Html::hidden( 'editToken', $user->getEditToken() ) .
 391                                         Xml::closeElement( 'form' ) .
 392                                         Xml::closeElement( 'fieldset' )
 393                         );
 394                 } elseif ( empty( $this->importSources ) ) {
 395                         $out->addWikiMsg( 'importnosources' );
 396                 }
 397
 398                 if ( $user->isAllowed( 'import' ) && !empty( $this->importSources ) ) {
 399                         # Show input field for import depth only if $wgExportMaxLinkDepth > 0
 400                         $importDepth = '';
 401                         if ( $this->getConfig()->get( 'ExportMaxLinkDepth' ) > 0 ) {
 402                                 $importDepth = "<tr>
 403                                                         <td class='mw-label'>" .
 404                                         $this->msg( 'export-pagelinks' )->parse() .
 405                                         "</td>
 406                                                         <td class='mw-input'>" .
 407                                         Xml::input( 'pagelink-depth', 3, 0 ) .
 408                                         "</td>
 409                                 </tr>";
 410                         }
 411                         $mappingSelection = $this->getMappingFormPart( 'interwiki' );
 412
 413                         $out->addHTML(
 414                                 Xml::fieldset( $this->msg( 'importinterwiki' )->text() ) .
 415                                         Xml::openElement(
 416                                                 'form',
 417                                                 [
 418                                                         'method' => 'post',
 419                                                         'action' => $action,
 420                                                         'id' => 'mw-import-interwiki-form'
 421                                                 ]
 422                                         ) .
 423                                         $this->msg( 'import-interwiki-text' )->parseAsBlock() .
 424                                         Html::hidden( 'action', 'submit' ) .
 425                                         Html::hidden( 'source', 'interwiki' ) .
 426                                         Html::hidden( 'editToken', $user->getEditToken() ) .
 427                                         Xml::openElement( 'table', [ 'id' => 'mw-import-table-interwiki' ] ) .
 428                                         "<tr>
 429                                         <td class='mw-label'>" .
 430                                         Xml::label( $this->msg( 'import-interwiki-sourcewiki' )->text(), 'interwiki' ) .
 431                                         "</td>
 432                                         <td class='mw-input'>" .
 433                                         Xml::openElement(
 434                                                 'select',
 435                                                 [ 'name' => 'interwiki', 'id' => 'interwiki' ]
 436                                         )
 437                         );
 438
 439                         $needSubprojectField = false;
 440                         foreach ( $this->importSources as $key => $value ) {
 441                                 if ( is_int( $key ) ) {
 442                                         $key = $value;
 443                                 } elseif ( $value !== $key ) {
 444                                         $needSubprojectField = true;
 445                                 }
 446
 447                                 $attribs = [
 448                                         'value' => $key,
 449                                 ];
 450                                 if ( is_array( $value ) ) {
 451                                         $attribs['data-subprojects'] = implode( ' ', $value );
 452                                 }
 453                                 if ( $this->interwiki === $key ) {
 454                                         $attribs['selected'] = 'selected';
 455                                 }
 456                                 $out->addHTML( Html::element( 'option', $attribs, $key ) );
 457                         }
 458
 459                         $out->addHTML(
 460                                 Xml::closeElement( 'select' )
 461                         );
 462
 463                         if ( $needSubprojectField ) {
 464                                 $out->addHTML(
 465                                         Xml::openElement(
 466                                                 'select',
 467                                                 [ 'name' => 'subproject', 'id' => 'subproject' ]
 468                                         )
 469                                 );
 470
 471                                 $subprojectsToAdd = [];
 472                                 foreach ( $this->importSources as $key => $value ) {
 473                                         if ( is_array( $value ) ) {
 474                                                 $subprojectsToAdd = array_merge( $subprojectsToAdd, $value );
 475                                         }
 476                                 }
 477                                 $subprojectsToAdd = array_unique( $subprojectsToAdd );
 478                                 sort( $subprojectsToAdd );
 479                                 foreach ( $subprojectsToAdd as $subproject ) {
 480                                         $out->addHTML( Xml::option( $subproject, $subproject, $this->subproject === $subproject ) );
 481                                 }
 482
 483                                 $out->addHTML(
 484                                         Xml::closeElement( 'select' )
 485                                 );
 486                         }
 487
 488                         $out->addHTML(
 489                                         "</td>
 490                                 </tr>
 491                                 <tr>
 492                                         <td class='mw-label'>" .
 493                                         Xml::label( $this->msg( 'import-interwiki-sourcepage' )->text(), 'frompage' ) .
 494                                         "</td>
 495                                         <td class='mw-input'>" .
 496                                         Xml::input( 'frompage', 50, $this->frompage, [ 'id' => 'frompage' ] ) .
 497                                         "</td>
 498                                 </tr>
 499                                 <tr>
 500                                         <td>
 501                                         </td>
 502                                         <td class='mw-input'>" .
 503                                         Xml::checkLabel(
 504                                                 $this->msg( 'import-interwiki-history' )->text(),
 505                                                 'interwikiHistory',
 506                                                 'interwikiHistory',
 507                                                 $this->history
 508                                         ) .
 509                                         "</td>
 510                                 </tr>
 511                                 <tr>
 512                                         <td>
 513                                         </td>
 514                                         <td class='mw-input'>" .
 515                                         Xml::checkLabel(
 516                                                 $this->msg( 'import-interwiki-templates' )->text(),
 517                                                 'interwikiTemplates',
 518                                                 'interwikiTemplates',
 519                                                 $this->includeTemplates
 520                                         ) .
 521                                         "</td>
 522                                 </tr>
 523                                 <tr>
 524                                         <td></td>
 525                                         <td class='mw-input'>" .
 526                                         Xml::checkLabel(
 527                                                 $this->msg( 'import-assign-known-users' )->text(),
 528                                                 'assignKnownUsers',
 529                                                 'interwikiAssignKnownUsers',
 530                                                 $this->assignKnownUsers
 531                                         ) .
 532                                         "</td>
 533                                 </tr>
 534                                 $importDepth
 535                                 <tr>
 536                                         <td class='mw-label'>" .
 537                                         Xml::label( $this->msg( 'import-comment' )->text(), 'mw-interwiki-comment' ) .
 538                                         "</td>
 539                                         <td class='mw-input'>" .
 540                                         Xml::input( 'log-comment', 50,
 541                                                 ( $this->sourceName === 'interwiki' ? $this->logcomment : '' ),
 542                                                 [ 'id' => 'mw-interwiki-comment', 'type' => 'text' ] ) . ' ' .
 543                                         "</td>
 544                                 </tr>
 545                                 $mappingSelection
 546                                 <tr>
 547                                         <td>
 548                                         </td>
 549                                         <td class='mw-submit'>" .
 550                                         Xml::submitButton(
 551                                                 $this->msg( 'import-interwiki-submit' )->text(),
 552                                                 Linker::tooltipAndAccesskeyAttribs( 'import' )
 553                                         ) .
 554                                         "</td>
 555                                 </tr>" .
 556                                         Xml::closeElement( 'table' ) .
 557                                         Xml::closeElement( 'form' ) .
 558                                         Xml::closeElement( 'fieldset' )
 559                         );
 560                 }
 561         }
 562
 563         protected function getGroupName() {
 564                 return 'pagetools';
 565         }
 566 }