3 * MediaWiki page data importer.
5 * Copyright © 2003,2005 Brion Vibber <brion@pobox.com>
6 * http://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 * XML file reader for the page data importer
30 * implements Special:Import
31 * @ingroup SpecialPage
34 private $reader = null;
35 private $mLogItemCallback, $mUploadCallback, $mRevisionCallback, $mPageCallback;
36 private $mSiteInfoCallback, $mTargetNamespace, $mTargetRootPage, $mPageOutCallback;
37 private $mNoticeCallback, $mDebug;
38 private $mImportUploads, $mImageBasePath;
39 private $mNoUpdates = false;
42 * Creates an ImportXMLReader drawing from the source provided
45 function __construct( $source ) {
46 $this->reader
= new XMLReader();
48 stream_wrapper_register( 'uploadsource', 'UploadSourceAdapter' );
49 $id = UploadSourceAdapter
::registerSource( $source );
50 if ( defined( 'LIBXML_PARSEHUGE' ) ) {
51 $this->reader
->open( "uploadsource://$id", null, LIBXML_PARSEHUGE
);
53 $this->reader
->open( "uploadsource://$id" );
57 $this->setRevisionCallback( array( $this, "importRevision" ) );
58 $this->setUploadCallback( array( $this, 'importUpload' ) );
59 $this->setLogItemCallback( array( $this, 'importLogItem' ) );
60 $this->setPageOutCallback( array( $this, 'finishImportPage' ) );
63 private function throwXmlError( $err ) {
64 $this->debug( "FAILURE: $err" );
65 wfDebug( "WikiImporter XML error: $err\n" );
68 private function debug( $data ) {
69 if ( $this->mDebug
) {
70 wfDebug( "IMPORT: $data\n" );
74 private function warn( $data ) {
75 wfDebug( "IMPORT: $data\n" );
78 private function notice( $msg /*, $param, ...*/ ) {
79 $params = func_get_args();
80 array_shift( $params );
82 if ( is_callable( $this->mNoticeCallback
) ) {
83 call_user_func( $this->mNoticeCallback
, $msg, $params );
84 } else { # No ImportReporter -> CLI
85 echo wfMessage( $msg, $params )->text() . "\n";
93 function setDebug( $debug ) {
94 $this->mDebug
= $debug;
98 * Set 'no updates' mode. In this mode, the link tables will not be updated by the importer
99 * @param $noupdates bool
101 function setNoUpdates( $noupdates ) {
102 $this->mNoUpdates
= $noupdates;
106 * Set a callback that displays notice messages
108 * @param $callback callback
111 public function setNoticeCallback( $callback ) {
112 return wfSetVar( $this->mNoticeCallback
, $callback );
116 * Sets the action to perform as each new page in the stream is reached.
117 * @param $callback callback
120 public function setPageCallback( $callback ) {
121 $previous = $this->mPageCallback
;
122 $this->mPageCallback
= $callback;
127 * Sets the action to perform as each page in the stream is completed.
128 * Callback accepts the page title (as a Title object), a second object
129 * with the original title form (in case it's been overridden into a
130 * local namespace), and a count of revisions.
132 * @param $callback callback
135 public function setPageOutCallback( $callback ) {
136 $previous = $this->mPageOutCallback
;
137 $this->mPageOutCallback
= $callback;
142 * Sets the action to perform as each page revision is reached.
143 * @param $callback callback
146 public function setRevisionCallback( $callback ) {
147 $previous = $this->mRevisionCallback
;
148 $this->mRevisionCallback
= $callback;
153 * Sets the action to perform as each file upload version is reached.
154 * @param $callback callback
157 public function setUploadCallback( $callback ) {
158 $previous = $this->mUploadCallback
;
159 $this->mUploadCallback
= $callback;
164 * Sets the action to perform as each log item reached.
165 * @param $callback callback
168 public function setLogItemCallback( $callback ) {
169 $previous = $this->mLogItemCallback
;
170 $this->mLogItemCallback
= $callback;
175 * Sets the action to perform when site info is encountered
176 * @param $callback callback
179 public function setSiteInfoCallback( $callback ) {
180 $previous = $this->mSiteInfoCallback
;
181 $this->mSiteInfoCallback
= $callback;
186 * Set a target namespace to override the defaults
190 public function setTargetNamespace( $namespace ) {
191 if ( is_null( $namespace ) ) {
192 // Don't override namespaces
193 $this->mTargetNamespace
= null;
194 } elseif ( $namespace >= 0 ) {
195 // @todo FIXME: Check for validity
196 $this->mTargetNamespace
= intval( $namespace );
203 * Set a target root page under which all pages are imported
205 * @return status object
207 public function setTargetRootPage( $rootpage ) {
208 $status = Status
::newGood();
209 if ( is_null( $rootpage ) ) {
211 $this->mTargetRootPage
= null;
212 } elseif ( $rootpage !== '' ) {
213 $rootpage = rtrim( $rootpage, '/' ); //avoid double slashes
214 $title = Title
::newFromText( $rootpage, !is_null( $this->mTargetNamespace
) ?
$this->mTargetNamespace
: NS_MAIN
);
215 if ( !$title ||
$title->isExternal() ) {
216 $status->fatal( 'import-rootpage-invalid' );
218 if ( !MWNamespace
::hasSubpages( $title->getNamespace() ) ) {
221 $displayNSText = $title->getNamespace() == NS_MAIN
222 ?
wfMessage( 'blanknamespace' )->text()
223 : $wgContLang->getNsText( $title->getNamespace() );
224 $status->fatal( 'import-rootpage-nosubpage', $displayNSText );
226 // set namespace to 'all', so the namespace check in processTitle() can passed
227 $this->setTargetNamespace( null );
228 $this->mTargetRootPage
= $title->getPrefixedDBkey();
238 public function setImageBasePath( $dir ) {
239 $this->mImageBasePath
= $dir;
245 public function setImportUploads( $import ) {
246 $this->mImportUploads
= $import;
250 * Default per-revision callback, performs the import.
251 * @param $revision WikiRevision
254 public function importRevision( $revision ) {
256 $dbw = wfGetDB( DB_MASTER
);
257 return $dbw->deadlockLoop( array( $revision, 'importOldRevision' ) );
258 } catch ( MWContentSerializationException
$ex ) {
259 $this->notice( 'import-error-unserialize',
260 $revision->getTitle()->getPrefixedText(),
262 $revision->getModel(),
263 $revision->getFormat() );
268 * Default per-revision callback, performs the import.
269 * @param $rev WikiRevision
272 public function importLogItem( $rev ) {
273 $dbw = wfGetDB( DB_MASTER
);
274 return $dbw->deadlockLoop( array( $rev, 'importLogItem' ) );
282 public function importUpload( $revision ) {
283 $dbw = wfGetDB( DB_MASTER
);
284 return $dbw->deadlockLoop( array( $revision, 'importUpload' ) );
288 * Mostly for hook use
296 public function finishImportPage( $title, $origTitle, $revCount, $sRevCount, $pageInfo ) {
297 $args = func_get_args();
298 return wfRunHooks( 'AfterImportPage', $args );
302 * Alternate per-revision callback, for debugging.
303 * @param $revision WikiRevision
305 public function debugRevisionHandler( &$revision ) {
306 $this->debug( "Got revision:" );
307 if ( is_object( $revision->title
) ) {
308 $this->debug( "-- Title: " . $revision->title
->getPrefixedText() );
310 $this->debug( "-- Title: <invalid>" );
312 $this->debug( "-- User: " . $revision->user_text
);
313 $this->debug( "-- Timestamp: " . $revision->timestamp
);
314 $this->debug( "-- Comment: " . $revision->comment
);
315 $this->debug( "-- Text: " . $revision->text
);
319 * Notify the callback function when a new "<page>" is reached.
320 * @param $title Title
322 function pageCallback( $title ) {
323 if ( isset( $this->mPageCallback
) ) {
324 call_user_func( $this->mPageCallback
, $title );
329 * Notify the callback function when a "</page>" is closed.
330 * @param $title Title
331 * @param $origTitle Title
332 * @param $revCount Integer
333 * @param int $sucCount number of revisions for which callback returned true
334 * @param array $pageInfo associative array of page information
336 private function pageOutCallback( $title, $origTitle, $revCount, $sucCount, $pageInfo ) {
337 if ( isset( $this->mPageOutCallback
) ) {
338 $args = func_get_args();
339 call_user_func_array( $this->mPageOutCallback
, $args );
344 * Notify the callback function of a revision
345 * @param $revision WikiRevision object
348 private function revisionCallback( $revision ) {
349 if ( isset( $this->mRevisionCallback
) ) {
350 return call_user_func_array( $this->mRevisionCallback
,
351 array( $revision, $this ) );
358 * Notify the callback function of a new log item
359 * @param $revision WikiRevision object
362 private function logItemCallback( $revision ) {
363 if ( isset( $this->mLogItemCallback
) ) {
364 return call_user_func_array( $this->mLogItemCallback
,
365 array( $revision, $this ) );
372 * Shouldn't something like this be built-in to XMLReader?
373 * Fetches text contents of the current element, assuming
374 * no sub-elements or such scary things.
378 private function nodeContents() {
379 if ( $this->reader
->isEmptyElement
) {
383 while ( $this->reader
->read() ) {
384 switch ( $this->reader
->nodeType
) {
385 case XmlReader
::TEXT
:
386 case XmlReader
::SIGNIFICANT_WHITESPACE
:
387 $buffer .= $this->reader
->value
;
389 case XmlReader
::END_ELEMENT
:
394 $this->reader
->close();
400 /** Left in for debugging */
401 private function dumpElement() {
402 static $lookup = null;
404 $xmlReaderConstants = array(
419 "SIGNIFICANT_WHITESPACE",
426 foreach ( $xmlReaderConstants as $name ) {
427 $lookup[constant( "XmlReader::$name" )] = $name;
432 $lookup[$this->reader
->nodeType
],
439 * Primary entry point
440 * @throws MWException
443 public function doImport() {
445 // Calls to reader->read need to be wrapped in calls to
446 // libxml_disable_entity_loader() to avoid local file
447 // inclusion attacks (bug 46932).
448 $oldDisable = libxml_disable_entity_loader( true );
449 $this->reader
->read();
451 if ( $this->reader
->name
!= 'mediawiki' ) {
452 libxml_disable_entity_loader( $oldDisable );
453 throw new MWException( "Expected <mediawiki> tag, got " .
454 $this->reader
->name
);
456 $this->debug( "<mediawiki> tag is correct." );
458 $this->debug( "Starting primary dump processing loop." );
460 $keepReading = $this->reader
->read();
462 while ( $keepReading ) {
463 $tag = $this->reader
->name
;
464 $type = $this->reader
->nodeType
;
466 if ( !wfRunHooks( 'ImportHandleToplevelXMLTag', array( $this ) ) ) {
468 } elseif ( $tag == 'mediawiki' && $type == XmlReader
::END_ELEMENT
) {
470 } elseif ( $tag == 'siteinfo' ) {
471 $this->handleSiteInfo();
472 } elseif ( $tag == 'page' ) {
474 } elseif ( $tag == 'logitem' ) {
475 $this->handleLogItem();
476 } elseif ( $tag != '#text' ) {
477 $this->warn( "Unhandled top-level XML tag $tag" );
483 $keepReading = $this->reader
->next();
485 $this->debug( "Skip" );
487 $keepReading = $this->reader
->read();
491 libxml_disable_entity_loader( $oldDisable );
497 * @throws MWException
499 private function handleSiteInfo() {
500 // Site info is useful, but not actually used for dump imports.
501 // Includes a quick short-circuit to save performance.
502 if ( ! $this->mSiteInfoCallback
) {
503 $this->reader
->next();
506 throw new MWException( "SiteInfo tag is not yet handled, do not set mSiteInfoCallback" );
509 private function handleLogItem() {
510 $this->debug( "Enter log item handler." );
513 // Fields that can just be stuffed in the pageInfo object
514 $normalFields = array( 'id', 'comment', 'type', 'action', 'timestamp',
515 'logtitle', 'params' );
517 while ( $this->reader
->read() ) {
518 if ( $this->reader
->nodeType
== XmlReader
::END_ELEMENT
&&
519 $this->reader
->name
== 'logitem' ) {
523 $tag = $this->reader
->name
;
525 if ( !wfRunHooks( 'ImportHandleLogItemXMLTag', array(
529 } elseif ( in_array( $tag, $normalFields ) ) {
530 $logInfo[$tag] = $this->nodeContents();
531 } elseif ( $tag == 'contributor' ) {
532 $logInfo['contributor'] = $this->handleContributor();
533 } elseif ( $tag != '#text' ) {
534 $this->warn( "Unhandled log-item XML tag $tag" );
538 $this->processLogItem( $logInfo );
545 private function processLogItem( $logInfo ) {
546 $revision = new WikiRevision
;
548 $revision->setID( $logInfo['id'] );
549 $revision->setType( $logInfo['type'] );
550 $revision->setAction( $logInfo['action'] );
551 $revision->setTimestamp( $logInfo['timestamp'] );
552 $revision->setParams( $logInfo['params'] );
553 $revision->setTitle( Title
::newFromText( $logInfo['logtitle'] ) );
554 $revision->setNoUpdates( $this->mNoUpdates
);
556 if ( isset( $logInfo['comment'] ) ) {
557 $revision->setComment( $logInfo['comment'] );
560 if ( isset( $logInfo['contributor']['ip'] ) ) {
561 $revision->setUserIP( $logInfo['contributor']['ip'] );
563 if ( isset( $logInfo['contributor']['username'] ) ) {
564 $revision->setUserName( $logInfo['contributor']['username'] );
567 return $this->logItemCallback( $revision );
570 private function handlePage() {
572 $this->debug( "Enter page handler." );
573 $pageInfo = array( 'revisionCount' => 0, 'successfulRevisionCount' => 0 );
575 // Fields that can just be stuffed in the pageInfo object
576 $normalFields = array( 'title', 'id', 'redirect', 'restrictions' );
581 while ( $skip ?
$this->reader
->next() : $this->reader
->read() ) {
582 if ( $this->reader
->nodeType
== XmlReader
::END_ELEMENT
&&
583 $this->reader
->name
== 'page' ) {
587 $tag = $this->reader
->name
;
590 // The title is invalid, bail out of this page
592 } elseif ( !wfRunHooks( 'ImportHandlePageXMLTag', array( $this,
595 } elseif ( in_array( $tag, $normalFields ) ) {
596 $pageInfo[$tag] = $this->nodeContents();
597 if ( $tag == 'title' ) {
598 $title = $this->processTitle( $pageInfo['title'] );
605 $this->pageCallback( $title );
606 list( $pageInfo['_title'], $origTitle ) = $title;
608 } elseif ( $tag == 'revision' ) {
609 $this->handleRevision( $pageInfo );
610 } elseif ( $tag == 'upload' ) {
611 $this->handleUpload( $pageInfo );
612 } elseif ( $tag != '#text' ) {
613 $this->warn( "Unhandled page XML tag $tag" );
618 $this->pageOutCallback( $pageInfo['_title'], $origTitle,
619 $pageInfo['revisionCount'],
620 $pageInfo['successfulRevisionCount'],
625 * @param $pageInfo array
627 private function handleRevision( &$pageInfo ) {
628 $this->debug( "Enter revision handler" );
629 $revisionInfo = array();
631 $normalFields = array( 'id', 'timestamp', 'comment', 'minor', 'model', 'format', 'text' );
635 while ( $skip ?
$this->reader
->next() : $this->reader
->read() ) {
636 if ( $this->reader
->nodeType
== XmlReader
::END_ELEMENT
&&
637 $this->reader
->name
== 'revision' ) {
641 $tag = $this->reader
->name
;
643 if ( !wfRunHooks( 'ImportHandleRevisionXMLTag', array(
644 $this, $pageInfo, $revisionInfo
647 } elseif ( in_array( $tag, $normalFields ) ) {
648 $revisionInfo[$tag] = $this->nodeContents();
649 } elseif ( $tag == 'contributor' ) {
650 $revisionInfo['contributor'] = $this->handleContributor();
651 } elseif ( $tag != '#text' ) {
652 $this->warn( "Unhandled revision XML tag $tag" );
657 $pageInfo['revisionCount']++
;
658 if ( $this->processRevision( $pageInfo, $revisionInfo ) ) {
659 $pageInfo['successfulRevisionCount']++
;
665 * @param $revisionInfo
668 private function processRevision( $pageInfo, $revisionInfo ) {
669 $revision = new WikiRevision
;
671 if ( isset( $revisionInfo['id'] ) ) {
672 $revision->setID( $revisionInfo['id'] );
674 if ( isset( $revisionInfo['text'] ) ) {
675 $revision->setText( $revisionInfo['text'] );
677 if ( isset( $revisionInfo['model'] ) ) {
678 $revision->setModel( $revisionInfo['model'] );
680 if ( isset( $revisionInfo['format'] ) ) {
681 $revision->setFormat( $revisionInfo['format'] );
683 $revision->setTitle( $pageInfo['_title'] );
685 if ( isset( $revisionInfo['timestamp'] ) ) {
686 $revision->setTimestamp( $revisionInfo['timestamp'] );
688 $revision->setTimestamp( wfTimestampNow() );
691 if ( isset( $revisionInfo['comment'] ) ) {
692 $revision->setComment( $revisionInfo['comment'] );
695 if ( isset( $revisionInfo['minor'] ) ) {
696 $revision->setMinor( true );
698 if ( isset( $revisionInfo['contributor']['ip'] ) ) {
699 $revision->setUserIP( $revisionInfo['contributor']['ip'] );
701 if ( isset( $revisionInfo['contributor']['username'] ) ) {
702 $revision->setUserName( $revisionInfo['contributor']['username'] );
704 $revision->setNoUpdates( $this->mNoUpdates
);
706 return $this->revisionCallback( $revision );
713 private function handleUpload( &$pageInfo ) {
714 $this->debug( "Enter upload handler" );
715 $uploadInfo = array();
717 $normalFields = array( 'timestamp', 'comment', 'filename', 'text',
718 'src', 'size', 'sha1base36', 'archivename', 'rel' );
722 while ( $skip ?
$this->reader
->next() : $this->reader
->read() ) {
723 if ( $this->reader
->nodeType
== XmlReader
::END_ELEMENT
&&
724 $this->reader
->name
== 'upload' ) {
728 $tag = $this->reader
->name
;
730 if ( !wfRunHooks( 'ImportHandleUploadXMLTag', array(
734 } elseif ( in_array( $tag, $normalFields ) ) {
735 $uploadInfo[$tag] = $this->nodeContents();
736 } elseif ( $tag == 'contributor' ) {
737 $uploadInfo['contributor'] = $this->handleContributor();
738 } elseif ( $tag == 'contents' ) {
739 $contents = $this->nodeContents();
740 $encoding = $this->reader
->getAttribute( 'encoding' );
741 if ( $encoding === 'base64' ) {
742 $uploadInfo['fileSrc'] = $this->dumpTemp( base64_decode( $contents ) );
743 $uploadInfo['isTempSrc'] = true;
745 } elseif ( $tag != '#text' ) {
746 $this->warn( "Unhandled upload XML tag $tag" );
751 if ( $this->mImageBasePath
&& isset( $uploadInfo['rel'] ) ) {
752 $path = "{$this->mImageBasePath}/{$uploadInfo['rel']}";
753 if ( file_exists( $path ) ) {
754 $uploadInfo['fileSrc'] = $path;
755 $uploadInfo['isTempSrc'] = false;
759 if ( $this->mImportUploads
) {
760 return $this->processUpload( $pageInfo, $uploadInfo );
768 private function dumpTemp( $contents ) {
769 $filename = tempnam( wfTempDir(), 'importupload' );
770 file_put_contents( $filename, $contents );
779 private function processUpload( $pageInfo, $uploadInfo ) {
780 $revision = new WikiRevision
;
781 $text = isset( $uploadInfo['text'] ) ?
$uploadInfo['text'] : '';
783 $revision->setTitle( $pageInfo['_title'] );
784 $revision->setID( $pageInfo['id'] );
785 $revision->setTimestamp( $uploadInfo['timestamp'] );
786 $revision->setText( $text );
787 $revision->setFilename( $uploadInfo['filename'] );
788 if ( isset( $uploadInfo['archivename'] ) ) {
789 $revision->setArchiveName( $uploadInfo['archivename'] );
791 $revision->setSrc( $uploadInfo['src'] );
792 if ( isset( $uploadInfo['fileSrc'] ) ) {
793 $revision->setFileSrc( $uploadInfo['fileSrc'],
794 !empty( $uploadInfo['isTempSrc'] ) );
796 if ( isset( $uploadInfo['sha1base36'] ) ) {
797 $revision->setSha1Base36( $uploadInfo['sha1base36'] );
799 $revision->setSize( intval( $uploadInfo['size'] ) );
800 $revision->setComment( $uploadInfo['comment'] );
802 if ( isset( $uploadInfo['contributor']['ip'] ) ) {
803 $revision->setUserIP( $uploadInfo['contributor']['ip'] );
805 if ( isset( $uploadInfo['contributor']['username'] ) ) {
806 $revision->setUserName( $uploadInfo['contributor']['username'] );
808 $revision->setNoUpdates( $this->mNoUpdates
);
810 return call_user_func( $this->mUploadCallback
, $revision );
816 private function handleContributor() {
817 $fields = array( 'id', 'ip', 'username' );
820 while ( $this->reader
->read() ) {
821 if ( $this->reader
->nodeType
== XmlReader
::END_ELEMENT
&&
822 $this->reader
->name
== 'contributor' ) {
826 $tag = $this->reader
->name
;
828 if ( in_array( $tag, $fields ) ) {
829 $info[$tag] = $this->nodeContents();
837 * @param $text string
838 * @return Array or false
840 private function processTitle( $text ) {
841 global $wgCommandLineMode;
844 $origTitle = Title
::newFromText( $workTitle );
846 if ( !is_null( $this->mTargetNamespace
) && !is_null( $origTitle ) ) {
847 # makeTitleSafe, because $origTitle can have a interwiki (different setting of interwiki map)
848 # and than dbKey can begin with a lowercase char
849 $title = Title
::makeTitleSafe( $this->mTargetNamespace
,
850 $origTitle->getDBkey() );
852 if ( !is_null( $this->mTargetRootPage
) ) {
853 $workTitle = $this->mTargetRootPage
. '/' . $workTitle;
855 $title = Title
::newFromText( $workTitle );
858 if ( is_null( $title ) ) {
859 # Invalid page title? Ignore the page
860 $this->notice( 'import-error-invalid', $workTitle );
862 } elseif ( $title->isExternal() ) {
863 $this->notice( 'import-error-interwiki', $title->getPrefixedText() );
865 } elseif ( !$title->canExist() ) {
866 $this->notice( 'import-error-special', $title->getPrefixedText() );
868 } elseif ( !$title->userCan( 'edit' ) && !$wgCommandLineMode ) {
869 # Do not import if the importing wiki user cannot edit this page
870 $this->notice( 'import-error-edit', $title->getPrefixedText() );
872 } elseif ( !$title->exists() && !$title->userCan( 'create' ) && !$wgCommandLineMode ) {
873 # Do not import if the importing wiki user cannot create this page
874 $this->notice( 'import-error-create', $title->getPrefixedText() );
878 return array( $title, $origTitle );
882 /** This is a horrible hack used to keep source compatibility */
883 class UploadSourceAdapter
{
884 static $sourceRegistrations = array();
894 static function registerSource( $source ) {
895 $id = wfRandomString();
897 self
::$sourceRegistrations[$id] = $source;
906 * @param $opened_path
909 function stream_open( $path, $mode, $options, &$opened_path ) {
910 $url = parse_url( $path );
913 if ( !isset( self
::$sourceRegistrations[$id] ) ) {
917 $this->mSource
= self
::$sourceRegistrations[$id];
926 function stream_read( $count ) {
930 while ( !$leave && !$this->mSource
->atEnd() &&
931 strlen( $this->mBuffer
) < $count ) {
932 $read = $this->mSource
->readChunk();
934 if ( !strlen( $read ) ) {
938 $this->mBuffer
.= $read;
941 if ( strlen( $this->mBuffer
) ) {
942 $return = substr( $this->mBuffer
, 0, $count );
943 $this->mBuffer
= substr( $this->mBuffer
, $count );
946 $this->mPosition +
= strlen( $return );
955 function stream_write( $data ) {
962 function stream_tell() {
963 return $this->mPosition
;
969 function stream_eof() {
970 return $this->mSource
->atEnd();
976 function url_stat() {
979 $result['dev'] = $result[0] = 0;
980 $result['ino'] = $result[1] = 0;
981 $result['mode'] = $result[2] = 0;
982 $result['nlink'] = $result[3] = 0;
983 $result['uid'] = $result[4] = 0;
984 $result['gid'] = $result[5] = 0;
985 $result['rdev'] = $result[6] = 0;
986 $result['size'] = $result[7] = 0;
987 $result['atime'] = $result[8] = 0;
988 $result['mtime'] = $result[9] = 0;
989 $result['ctime'] = $result[10] = 0;
990 $result['blksize'] = $result[11] = 0;
991 $result['blocks'] = $result[12] = 0;
997 class XMLReader2
extends XMLReader
{
1000 * @return bool|string
1002 function nodeContents() {
1003 if ( $this->isEmptyElement
) {
1007 while ( $this->read() ) {
1008 switch ( $this->nodeType
) {
1009 case XmlReader
::TEXT
:
1010 case XmlReader
::SIGNIFICANT_WHITESPACE
:
1011 $buffer .= $this->value
;
1013 case XmlReader
::END_ELEMENT
:
1017 return $this->close();
1022 * @todo document (e.g. one-sentence class description).
1023 * @ingroup SpecialPage
1025 class WikiRevision
{
1026 var $importer = null;
1033 var $timestamp = "20010115000000";
1035 var $user_text = "";
1039 var $content = null;
1046 var $sha1base36 = false;
1047 var $isTemp = false;
1048 var $archiveName = '';
1050 private $mNoUpdates = false;
1054 * @throws MWException
1056 function setTitle( $title ) {
1057 if ( is_object( $title ) ) {
1058 $this->title
= $title;
1059 } elseif ( is_null( $title ) ) {
1060 throw new MWException( "WikiRevision given a null title in import. You may need to adjust \$wgLegalTitleChars." );
1062 throw new MWException( "WikiRevision given non-object title in import." );
1069 function setID( $id ) {
1076 function setTimestamp( $ts ) {
1077 # 2003-08-05T18:30:02Z
1078 $this->timestamp
= wfTimestamp( TS_MW
, $ts );
1084 function setUsername( $user ) {
1085 $this->user_text
= $user;
1091 function setUserIP( $ip ) {
1092 $this->user_text
= $ip;
1098 function setModel( $model ) {
1099 $this->model
= $model;
1105 function setFormat( $format ) {
1106 $this->format
= $format;
1112 function setText( $text ) {
1113 $this->text
= $text;
1119 function setComment( $text ) {
1120 $this->comment
= $text;
1126 function setMinor( $minor ) {
1127 $this->minor
= (bool)$minor;
1133 function setSrc( $src ) {
1141 function setFileSrc( $src, $isTemp ) {
1142 $this->fileSrc
= $src;
1143 $this->fileIsTemp
= $isTemp;
1147 * @param $sha1base36
1149 function setSha1Base36( $sha1base36 ) {
1150 $this->sha1base36
= $sha1base36;
1156 function setFilename( $filename ) {
1157 $this->filename
= $filename;
1161 * @param $archiveName
1163 function setArchiveName( $archiveName ) {
1164 $this->archiveName
= $archiveName;
1170 function setSize( $size ) {
1171 $this->size
= intval( $size );
1177 function setType( $type ) {
1178 $this->type
= $type;
1184 function setAction( $action ) {
1185 $this->action
= $action;
1191 function setParams( $params ) {
1192 $this->params
= $params;
1198 public function setNoUpdates( $noupdates ) {
1199 $this->mNoUpdates
= $noupdates;
1205 function getTitle() {
1206 return $this->title
;
1219 function getTimestamp() {
1220 return $this->timestamp
;
1226 function getUser() {
1227 return $this->user_text
;
1233 * @deprecated Since 1.21, use getContent() instead.
1235 function getText() {
1236 ContentHandler
::deprecated( __METHOD__
, '1.21' );
1244 function getContent() {
1245 if ( is_null( $this->content
) ) {
1247 ContentHandler
::makeContent(
1255 return $this->content
;
1261 function getModel() {
1262 if ( is_null( $this->model
) ) {
1263 $this->model
= $this->getTitle()->getContentModel();
1266 return $this->model
;
1272 function getFormat() {
1273 if ( is_null( $this->model
) ) {
1274 $this->format
= ContentHandler
::getForTitle( $this->getTitle() )->getDefaultFormat();
1277 return $this->format
;
1283 function getComment() {
1284 return $this->comment
;
1290 function getMinor() {
1291 return $this->minor
;
1302 * @return bool|String
1304 function getSha1() {
1305 if ( $this->sha1base36
) {
1306 return wfBaseConvert( $this->sha1base36
, 36, 16 );
1314 function getFileSrc() {
1315 return $this->fileSrc
;
1321 function isTempSrc() {
1322 return $this->isTemp
;
1328 function getFilename() {
1329 return $this->filename
;
1335 function getArchiveName() {
1336 return $this->archiveName
;
1342 function getSize() {
1349 function getType() {
1356 function getAction() {
1357 return $this->action
;
1363 function getParams() {
1364 return $this->params
;
1370 function importOldRevision() {
1371 $dbw = wfGetDB( DB_MASTER
);
1373 # Sneak a single revision into place
1374 $user = User
::newFromName( $this->getUser() );
1376 $userId = intval( $user->getId() );
1377 $userText = $user->getName();
1381 $userText = $this->getUser();
1382 $userObj = new User
;
1385 // avoid memory leak...?
1386 $linkCache = LinkCache
::singleton();
1387 $linkCache->clear();
1389 $page = WikiPage
::factory( $this->title
);
1390 if ( !$page->exists() ) {
1391 # must create the page...
1392 $pageId = $page->insertOn( $dbw );
1394 $oldcountable = null;
1396 $pageId = $page->getId();
1399 $prior = $dbw->selectField( 'revision', '1',
1400 array( 'rev_page' => $pageId,
1401 'rev_timestamp' => $dbw->timestamp( $this->timestamp
),
1402 'rev_user_text' => $userText,
1403 'rev_comment' => $this->getComment() ),
1407 // @todo FIXME: This could fail slightly for multiple matches :P
1408 wfDebug( __METHOD__
. ": skipping existing revision for [[" .
1409 $this->title
->getPrefixedText() . "]], timestamp " . $this->timestamp
. "\n" );
1412 $oldcountable = $page->isCountable();
1415 # @todo FIXME: Use original rev_id optionally (better for backups)
1417 $revision = new Revision( array(
1418 'title' => $this->title
,
1420 'content_model' => $this->getModel(),
1421 'content_format' => $this->getFormat(),
1422 'text' => $this->getContent()->serialize( $this->getFormat() ), //XXX: just set 'content' => $this->getContent()?
1423 'comment' => $this->getComment(),
1425 'user_text' => $userText,
1426 'timestamp' => $this->timestamp
,
1427 'minor_edit' => $this->minor
,
1429 $revision->insertOn( $dbw );
1430 $changed = $page->updateIfNewerOn( $dbw, $revision );
1432 if ( $changed !== false && !$this->mNoUpdates
) {
1433 wfDebug( __METHOD__
. ": running updates\n" );
1434 $page->doEditUpdates( $revision, $userObj, array( 'created' => $created, 'oldcountable' => $oldcountable ) );
1443 function importLogItem() {
1444 $dbw = wfGetDB( DB_MASTER
);
1445 # @todo FIXME: This will not record autoblocks
1446 if ( !$this->getTitle() ) {
1447 wfDebug( __METHOD__
. ": skipping invalid {$this->type}/{$this->action} log time, timestamp " .
1448 $this->timestamp
. "\n" );
1451 # Check if it exists already
1452 // @todo FIXME: Use original log ID (better for backups)
1453 $prior = $dbw->selectField( 'logging', '1',
1454 array( 'log_type' => $this->getType(),
1455 'log_action' => $this->getAction(),
1456 'log_timestamp' => $dbw->timestamp( $this->timestamp
),
1457 'log_namespace' => $this->getTitle()->getNamespace(),
1458 'log_title' => $this->getTitle()->getDBkey(),
1459 'log_comment' => $this->getComment(),
1460 #'log_user_text' => $this->user_text,
1461 'log_params' => $this->params
),
1464 // @todo FIXME: This could fail slightly for multiple matches :P
1466 wfDebug( __METHOD__
. ": skipping existing item for Log:{$this->type}/{$this->action}, timestamp " .
1467 $this->timestamp
. "\n" );
1470 $log_id = $dbw->nextSequenceValue( 'logging_log_id_seq' );
1472 'log_id' => $log_id,
1473 'log_type' => $this->type
,
1474 'log_action' => $this->action
,
1475 'log_timestamp' => $dbw->timestamp( $this->timestamp
),
1476 'log_user' => User
::idFromName( $this->user_text
),
1477 #'log_user_text' => $this->user_text,
1478 'log_namespace' => $this->getTitle()->getNamespace(),
1479 'log_title' => $this->getTitle()->getDBkey(),
1480 'log_comment' => $this->getComment(),
1481 'log_params' => $this->params
1483 $dbw->insert( 'logging', $data, __METHOD__
);
1489 function importUpload() {
1491 $archiveName = $this->getArchiveName();
1492 if ( $archiveName ) {
1493 wfDebug( __METHOD__
. "Importing archived file as $archiveName\n" );
1494 $file = OldLocalFile
::newFromArchiveName( $this->getTitle(),
1495 RepoGroup
::singleton()->getLocalRepo(), $archiveName );
1497 $file = wfLocalFile( $this->getTitle() );
1498 wfDebug( __METHOD__
. 'Importing new file as ' . $file->getName() . "\n" );
1499 if ( $file->exists() && $file->getTimestamp() > $this->getTimestamp() ) {
1500 $archiveName = $file->getTimestamp() . '!' . $file->getName();
1501 $file = OldLocalFile
::newFromArchiveName( $this->getTitle(),
1502 RepoGroup
::singleton()->getLocalRepo(), $archiveName );
1503 wfDebug( __METHOD__
. "File already exists; importing as $archiveName\n" );
1507 wfDebug( __METHOD__
. ': Bad file for ' . $this->getTitle() . "\n" );
1511 # Get the file source or download if necessary
1512 $source = $this->getFileSrc();
1513 $flags = $this->isTempSrc() ? File
::DELETE_SOURCE
: 0;
1515 $source = $this->downloadSource();
1516 $flags |
= File
::DELETE_SOURCE
;
1519 wfDebug( __METHOD__
. ": Could not fetch remote file.\n" );
1522 $sha1 = $this->getSha1();
1523 if ( $sha1 && ( $sha1 !== sha1_file( $source ) ) ) {
1524 if ( $flags & File
::DELETE_SOURCE
) {
1525 # Broken file; delete it if it is a temporary file
1528 wfDebug( __METHOD__
. ": Corrupt file $source.\n" );
1532 $user = User
::newFromName( $this->user_text
);
1534 # Do the actual upload
1535 if ( $archiveName ) {
1536 $status = $file->uploadOld( $source, $archiveName,
1537 $this->getTimestamp(), $this->getComment(), $user, $flags );
1539 $status = $file->upload( $source, $this->getComment(), $this->getComment(),
1540 $flags, false, $this->getTimestamp(), $user );
1543 if ( $status->isGood() ) {
1544 wfDebug( __METHOD__
. ": Successful\n" );
1547 wfDebug( __METHOD__
. ': failed: ' . $status->getXml() . "\n" );
1553 * @return bool|string
1555 function downloadSource() {
1556 global $wgEnableUploads;
1557 if ( !$wgEnableUploads ) {
1561 $tempo = tempnam( wfTempDir(), 'download' );
1562 $f = fopen( $tempo, 'wb' );
1564 wfDebug( "IMPORT: couldn't write to temp file $tempo\n" );
1569 $src = $this->getSrc();
1570 $data = Http
::get( $src );
1572 wfDebug( "IMPORT: couldn't fetch source $src\n" );
1578 fwrite( $f, $data );
1587 * @todo document (e.g. one-sentence class description).
1588 * @ingroup SpecialPage
1590 class ImportStringSource
{
1591 function __construct( $string ) {
1592 $this->mString
= $string;
1593 $this->mRead
= false;
1600 return $this->mRead
;
1604 * @return bool|string
1606 function readChunk() {
1607 if ( $this->atEnd() ) {
1610 $this->mRead
= true;
1611 return $this->mString
;
1616 * @todo document (e.g. one-sentence class description).
1617 * @ingroup SpecialPage
1619 class ImportStreamSource
{
1620 function __construct( $handle ) {
1621 $this->mHandle
= $handle;
1628 return feof( $this->mHandle
);
1634 function readChunk() {
1635 return fread( $this->mHandle
, 32768 );
1639 * @param $filename string
1642 static function newFromFile( $filename ) {
1643 wfSuppressWarnings();
1644 $file = fopen( $filename, 'rt' );
1645 wfRestoreWarnings();
1647 return Status
::newFatal( "importcantopen" );
1649 return Status
::newGood( new ImportStreamSource( $file ) );
1653 * @param $fieldname string
1656 static function newFromUpload( $fieldname = "xmlimport" ) {
1657 $upload =& $_FILES[$fieldname];
1659 if ( $upload === null ||
!$upload['name'] ) {
1660 return Status
::newFatal( 'importnofile' );
1662 if ( !empty( $upload['error'] ) ) {
1663 switch ( $upload['error'] ) {
1664 case 1: # The uploaded file exceeds the upload_max_filesize directive in php.ini.
1665 return Status
::newFatal( 'importuploaderrorsize' );
1666 case 2: # The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form.
1667 return Status
::newFatal( 'importuploaderrorsize' );
1668 case 3: # The uploaded file was only partially uploaded
1669 return Status
::newFatal( 'importuploaderrorpartial' );
1670 case 6: #Missing a temporary folder.
1671 return Status
::newFatal( 'importuploaderrortemp' );
1672 # case else: # Currently impossible
1676 $fname = $upload['tmp_name'];
1677 if ( is_uploaded_file( $fname ) ) {
1678 return ImportStreamSource
::newFromFile( $fname );
1680 return Status
::newFatal( 'importnofile' );
1686 * @param $method string
1689 static function newFromURL( $url, $method = 'GET' ) {
1690 wfDebug( __METHOD__
. ": opening $url\n" );
1691 # Use the standard HTTP fetch function; it times out
1692 # quicker and sorts out user-agent problems which might
1693 # otherwise prevent importing from large sites, such
1694 # as the Wikimedia cluster, etc.
1695 $data = Http
::request( $method, $url, array( 'followRedirects' => true ) );
1696 if ( $data !== false ) {
1698 fwrite( $file, $data );
1701 return Status
::newGood( new ImportStreamSource( $file ) );
1703 return Status
::newFatal( 'importcantopen' );
1710 * @param $history bool
1711 * @param $templates bool
1712 * @param $pageLinkDepth int
1715 public static function newFromInterwiki( $interwiki, $page, $history = false, $templates = false, $pageLinkDepth = 0 ) {
1716 if ( $page == '' ) {
1717 return Status
::newFatal( 'import-noarticle' );
1719 $link = Title
::newFromText( "$interwiki:Special:Export/$page" );
1720 if ( is_null( $link ) ||
$link->getInterwiki() == '' ) {
1721 return Status
::newFatal( 'importbadinterwiki' );
1725 $params['history'] = 1;
1728 $params['templates'] = 1;
1730 if ( $pageLinkDepth ) {
1731 $params['pagelink-depth'] = $pageLinkDepth;
1733 $url = $link->getFullURL( $params );
1734 # For interwikis, use POST to avoid redirects.
1735 return ImportStreamSource
::newFromURL( $url, "POST" );