3 * Implements Special:Import
5 * Copyright © 2003,2005 Brion Vibber <brion@pobox.com>
6 * https://www.mediawiki.org/
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.
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.
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
24 * @ingroup SpecialPage
28 * MediaWiki page data importer
30 * @ingroup SpecialPage
32 class SpecialImport
extends SpecialPage
{
33 private $sourceName = false;
34 private $interwiki = false;
36 private $fullInterwikiPrefix;
37 private $mapping = 'default';
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;
49 public function __construct() {
50 parent
::__construct( 'Import', 'import' );
53 public function doesWrites() {
59 * @param string|null $par
60 * @throws PermissionsError
61 * @throws ReadOnlyError
63 function execute( $par ) {
64 $this->useTransactionalTimeLimit();
67 $this->outputHeader();
69 $this->namespace = $this->getConfig()->get( 'ImportTargetNamespace' );
71 $this->getOutput()->addModules( 'mediawiki.special.import' );
73 $this->importSources
= $this->getConfig()->get( 'ImportSources' );
74 Hooks
::run( 'ImportSources', [ &$this->importSources
] );
76 $user = $this->getUser();
77 if ( !$user->isAllowedAny( 'import', 'importupload' ) ) {
78 throw new PermissionsError( 'import' );
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' ]
89 $this->getPageTitle()->getUserPermissionsErrors(
90 'importupload', $user, true,
91 [ 'ns-specialprotected', 'badaccess-group0', 'badaccess-groups' ]
96 throw new PermissionsError( 'import', $errors );
99 $this->checkReadOnly();
101 $request = $this->getRequest();
102 if ( $request->wasPosted() && $request->getVal( 'action' ) == 'submit' ) {
109 * Do the actual import
111 private function doImport() {
113 $request = $this->getRequest();
114 $this->sourceName
= $request->getVal( "source" );
115 $this->assignKnownUsers
= $request->getCheck( 'assignKnownUsers' );
117 $this->logcomment
= $request->getText( 'log-comment' );
118 $this->pageLinkDepth
= $this->getConfig()->get( 'ExportMaxLinkDepth' ) == 0
120 : $request->getIntOrNull( 'pagelink-depth' );
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' );
128 $this->mapping
= 'default';
131 $user = $this->getUser();
132 if ( !$user->matchEditToken( $request->getVal( 'editToken' ) ) ) {
133 $source = Status
::newFatal( 'import-token-mismatch' );
134 } elseif ( $this->sourceName
=== 'upload' ) {
136 $this->usernamePrefix
= $this->fullInterwikiPrefix
= $request->getVal( 'usernamePrefix' );
137 if ( $user->isAllowed( 'importupload' ) ) {
138 $source = ImportStreamSource
::newFromUpload( "xmlimport" );
140 throw new PermissionsError( 'importupload' );
142 } elseif ( $this->sourceName
=== 'interwiki' ) {
143 if ( !$user->isAllowed( 'import' ) ) {
144 throw new PermissionsError( 'import' );
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" );
152 if ( $hasSubprojects ) {
153 $this->subproject
= $request->getVal( 'subproject' );
154 $this->fullInterwikiPrefix
.= ':' . $request->getVal( 'subproject' );
156 if ( $hasSubprojects &&
157 !in_array( $this->subproject
, $this->importSources
[$this->interwiki
] )
159 $source = Status
::newFatal( "import-invalid-interwiki" );
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
,
168 $this->includeTemplates
,
169 $this->pageLinkDepth
);
173 $source = Status
::newFatal( "importunknownsource" );
176 if ( (string)$this->fullInterwikiPrefix
=== '' ) {
177 $source->fatal( 'importnoprefix' );
180 $out = $this->getOutput();
181 if ( !$source->isGood() ) {
182 $out->addWikiText( "<div class=\"error\">\n" .
183 $this->msg( 'importfailed', $source->getWikiText() )->parse() . "\n</div>" );
185 $importer = new WikiImporter( $source->value
, $this->getConfig() );
186 if ( !is_null( $this->namespace ) ) {
187 $importer->setTargetNamespace( $this->namespace );
188 } elseif ( !is_null( $this->rootpage
) ) {
189 $statusRootPage = $importer->setTargetRootPage( $this->rootpage
);
190 if ( !$statusRootPage->isGood() ) {
192 "<div class=\"error\">\n$1\n</div>",
194 'import-options-wrong',
195 $statusRootPage->getWikiText(),
196 count( $statusRootPage->getErrorsArray() )
203 $importer->setUsernamePrefix( $this->fullInterwikiPrefix
, $this->assignKnownUsers
);
205 $out->addWikiMsg( "importstart" );
207 $reporter = new ImportReporter(
210 $this->fullInterwikiPrefix
,
213 $reporter->setContext( $this->getContext() );
218 $importer->doImport();
219 } catch ( Exception
$e ) {
222 $result = $reporter->close();
225 # No source or XML parse error
227 "<div class=\"error\">\n$1\n</div>",
228 [ 'importfailed', $exception->getMessage() ]
230 } elseif ( !$result->isGood() ) {
233 "<div class=\"error\">\n$1\n</div>",
234 [ 'importfailed', $result->getWikiText() ]
238 $out->addWikiMsg( 'importsuccess' );
240 $out->addHTML( '<hr />' );
244 private function getMappingFormPart( $sourceName ) {
245 $isSameSourceAsBefore = ( $this->sourceName
=== $sourceName );
246 $defaultNamespace = $this->getConfig()->get( 'ImportTargetNamespace' );
250 <td class='mw-input'>" .
252 $this->msg( 'import-mapping-default' )->text(),
255 // mw-import-mapping-interwiki-default, mw-import-mapping-upload-default
256 "mw-import-mapping-$sourceName-default",
257 ( $isSameSourceAsBefore ?
258 ( $this->mapping
=== 'default' ) :
259 is_null( $defaultNamespace ) )
266 <td class='mw-input'>" .
268 $this->msg( 'import-mapping-namespace' )->text(),
271 // mw-import-mapping-interwiki-namespace, mw-import-mapping-upload-namespace
272 "mw-import-mapping-$sourceName-namespace",
273 ( $isSameSourceAsBefore ?
274 ( $this->mapping
=== 'namespace' ) :
275 !is_null( $defaultNamespace ) )
277 Html
::namespaceSelector(
279 'selected' => ( $isSameSourceAsBefore ?
281 ( $defaultNamespace ||
'' ) ),
283 'name' => "namespace",
284 // mw-import-namespace-interwiki, mw-import-namespace-upload
285 'id' => "mw-import-namespace-$sourceName",
286 'class' => 'namespaceselector',
294 <td class='mw-input'>" .
296 $this->msg( 'import-mapping-subpage' )->text(),
299 // mw-import-mapping-interwiki-subpage, mw-import-mapping-upload-subpage
300 "mw-import-mapping-$sourceName-subpage",
301 ( $isSameSourceAsBefore ?
( $this->mapping
=== 'subpage' ) : '' )
303 Xml
::input( 'rootpage', 50,
304 ( $isSameSourceAsBefore ?
$this->rootpage
: '' ),
306 // Should be "mw-import-rootpage-...", but we keep this inaccurate
307 // ID for legacy reasons
308 // mw-interwiki-rootpage-interwiki, mw-interwiki-rootpage-upload
309 'id' => "mw-interwiki-rootpage-$sourceName",
317 private function showForm() {
318 $action = $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] );
319 $user = $this->getUser();
320 $out = $this->getOutput();
321 $this->addHelpLink( '//meta.wikimedia.org/wiki/Special:MyLanguage/Help:Import', true );
323 if ( $user->isAllowed( 'importupload' ) ) {
324 $mappingSelection = $this->getMappingFormPart( 'upload' );
326 Xml
::fieldset( $this->msg( 'import-upload' )->text() ) .
330 'enctype' => 'multipart/form-data',
333 'id' => 'mw-import-upload-form'
336 $this->msg( 'importtext' )->parseAsBlock() .
337 Html
::hidden( 'action', 'submit' ) .
338 Html
::hidden( 'source', 'upload' ) .
339 Xml
::openElement( 'table', [ 'id' => 'mw-import-table-upload' ] ) .
341 <td class='mw-label'>" .
342 Xml
::label( $this->msg( 'import-upload-filename' )->text(), 'xmlimport' ) .
344 <td class='mw-input'>" .
345 Html
::input( 'xmlimport', '', 'file', [ 'id' => 'xmlimport' ] ) . ' ' .
349 <td class='mw-label'>" .
350 Xml
::label( $this->msg( 'import-upload-username-prefix' )->text(),
351 'mw-import-usernamePrefix' ) .
353 <td class='mw-input'>" .
354 Xml
::input( 'usernamePrefix', 50,
355 $this->usernamePrefix
,
356 [ 'id' => 'usernamePrefix', 'type' => 'text' ] ) . ' ' .
361 <td class='mw-input'>" .
363 $this->msg( 'import-assign-known-users' )->text(),
366 $this->assignKnownUsers
371 <td class='mw-label'>" .
372 Xml
::label( $this->msg( 'import-comment' )->text(), 'mw-import-comment' ) .
374 <td class='mw-input'>" .
375 Xml
::input( 'log-comment', 50,
376 ( $this->sourceName
=== 'upload' ?
$this->logcomment
: '' ),
377 [ 'id' => 'mw-import-comment', 'type' => 'text' ] ) . ' ' .
383 <td class='mw-submit'>" .
384 Xml
::submitButton( $this->msg( 'uploadbtn' )->text() ) .
387 Xml
::closeElement( 'table' ) .
388 Html
::hidden( 'editToken', $user->getEditToken() ) .
389 Xml
::closeElement( 'form' ) .
390 Xml
::closeElement( 'fieldset' )
393 if ( empty( $this->importSources
) ) {
394 $out->addWikiMsg( 'importnosources' );
398 if ( $user->isAllowed( 'import' ) && !empty( $this->importSources
) ) {
399 # Show input field for import depth only if $wgExportMaxLinkDepth > 0
401 if ( $this->getConfig()->get( 'ExportMaxLinkDepth' ) > 0 ) {
403 <td class='mw-label'>" .
404 $this->msg( 'export-pagelinks' )->parse() .
406 <td class='mw-input'>" .
407 Xml
::input( 'pagelink-depth', 3, 0 ) .
411 $mappingSelection = $this->getMappingFormPart( 'interwiki' );
414 Xml
::fieldset( $this->msg( 'importinterwiki' )->text() ) .
420 'id' => 'mw-import-interwiki-form'
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' ] ) .
429 <td class='mw-label'>" .
430 Xml
::label( $this->msg( 'import-interwiki-sourcewiki' )->text(), 'interwiki' ) .
432 <td class='mw-input'>" .
435 [ 'name' => 'interwiki', 'id' => 'interwiki' ]
439 $needSubprojectField = false;
440 foreach ( $this->importSources
as $key => $value ) {
441 if ( is_int( $key ) ) {
443 } elseif ( $value !== $key ) {
444 $needSubprojectField = true;
450 if ( is_array( $value ) ) {
451 $attribs['data-subprojects'] = implode( ' ', $value );
453 if ( $this->interwiki
=== $key ) {
454 $attribs['selected'] = 'selected';
456 $out->addHTML( Html
::element( 'option', $attribs, $key ) );
460 Xml
::closeElement( 'select' )
463 if ( $needSubprojectField ) {
467 [ 'name' => 'subproject', 'id' => 'subproject' ]
471 $subprojectsToAdd = [];
472 foreach ( $this->importSources
as $key => $value ) {
473 if ( is_array( $value ) ) {
474 $subprojectsToAdd = array_merge( $subprojectsToAdd, $value );
477 $subprojectsToAdd = array_unique( $subprojectsToAdd );
478 sort( $subprojectsToAdd );
479 foreach ( $subprojectsToAdd as $subproject ) {
480 $out->addHTML( Xml
::option( $subproject, $subproject, $this->subproject
=== $subproject ) );
484 Xml
::closeElement( 'select' )
492 <td class='mw-label'>" .
493 Xml
::label( $this->msg( 'import-interwiki-sourcepage' )->text(), 'frompage' ) .
495 <td class='mw-input'>" .
496 Xml
::input( 'frompage', 50, $this->frompage
, [ 'id' => 'frompage' ] ) .
502 <td class='mw-input'>" .
504 $this->msg( 'import-interwiki-history' )->text(),
514 <td class='mw-input'>" .
516 $this->msg( 'import-interwiki-templates' )->text(),
517 'interwikiTemplates',
518 'interwikiTemplates',
519 $this->includeTemplates
525 <td class='mw-input'>" .
527 $this->msg( 'import-assign-known-users' )->text(),
529 'interwikiAssignKnownUsers',
530 $this->assignKnownUsers
536 <td class='mw-label'>" .
537 Xml
::label( $this->msg( 'import-comment' )->text(), 'mw-interwiki-comment' ) .
539 <td class='mw-input'>" .
540 Xml
::input( 'log-comment', 50,
541 ( $this->sourceName
=== 'interwiki' ?
$this->logcomment
: '' ),
542 [ 'id' => 'mw-interwiki-comment', 'type' => 'text' ] ) . ' ' .
549 <td class='mw-submit'>" .
551 $this->msg( 'import-interwiki-submit' )->text(),
552 Linker
::tooltipAndAccesskeyAttribs( 'import' )
556 Xml
::closeElement( 'table' ) .
557 Xml
::closeElement( 'form' ) .
558 Xml
::closeElement( 'fieldset' )
563 protected function getGroupName() {