3 * Base classes for dumps and export
5 * Copyright © 2003, 2005, 2006 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
31 * @ingroup SpecialPage Dump
34 var $list_authors = false ; # Return distinct author list (when not returning full history)
35 var $author_list = "" ;
37 var $dumpUploads = false;
38 var $dumpUploadFileContents = false;
42 const STABLE
= 4; // extension defined
53 * If using WikiExporter::STREAM to stream a large amount of data,
54 * provide a database connection which is not managed by
55 * LoadBalancer to read from: some history blob types will
56 * make additional queries to pull source data while the
57 * main query is still running.
59 * @param $db DatabaseBase
60 * @param $history Mixed: one of WikiExporter::FULL, WikiExporter::CURRENT,
61 * WikiExporter::RANGE or WikiExporter::STABLE,
62 * or an associative array:
63 * offset: non-inclusive offset at which to start the query
64 * limit: maximum number of rows to return
65 * dir: "asc" or "desc" timestamp order
66 * @param $buffer Int: one of WikiExporter::BUFFER or WikiExporter::STREAM
67 * @param $text Int: one of WikiExporter::TEXT or WikiExporter::STUB
69 function __construct( &$db, $history = WikiExporter
::CURRENT
,
70 $buffer = WikiExporter
::BUFFER
, $text = WikiExporter
::TEXT
) {
72 $this->history
= $history;
73 $this->buffer
= $buffer;
74 $this->writer
= new XmlDumpWriter();
75 $this->sink
= new DumpOutput();
80 * Set the DumpOutput or DumpFilter object which will receive
81 * various row objects and XML output for filtering. Filters
82 * can be chained or used as callbacks.
86 public function setOutputSink( &$sink ) {
90 public function openStream() {
91 $output = $this->writer
->openStream();
92 $this->sink
->writeOpenStream( $output );
95 public function closeStream() {
96 $output = $this->writer
->closeStream();
97 $this->sink
->writeCloseStream( $output );
101 * Dumps a series of page and revision records for all pages
102 * in the database, either including complete history or only
103 * the most recent version.
105 public function allPages() {
106 return $this->dumpFrom( '' );
110 * Dumps a series of page and revision records for those pages
111 * in the database falling within the page_id range given.
112 * @param $start Int: inclusive lower limit (this id is included)
113 * @param $end Int: Exclusive upper limit (this id is not included)
114 * If 0, no upper limit.
116 public function pagesByRange( $start, $end ) {
117 $condition = 'page_id >= ' . intval( $start );
119 $condition .= ' AND page_id < ' . intval( $end );
121 return $this->dumpFrom( $condition );
125 * Dumps a series of page and revision records for those pages
126 * in the database with revisions falling within the rev_id range given.
127 * @param $start Int: inclusive lower limit (this id is included)
128 * @param $end Int: Exclusive upper limit (this id is not included)
129 * If 0, no upper limit.
131 public function revsByRange( $start, $end ) {
132 $condition = 'rev_id >= ' . intval( $start );
134 $condition .= ' AND rev_id < ' . intval( $end );
136 return $this->dumpFrom( $condition );
140 * @param $title Title
142 public function pageByTitle( $title ) {
143 return $this->dumpFrom(
144 'page_namespace=' . $title->getNamespace() .
145 ' AND page_title=' . $this->db
->addQuotes( $title->getDBkey() ) );
148 public function pageByName( $name ) {
149 $title = Title
::newFromText( $name );
150 if ( is_null( $title ) ) {
151 throw new MWException( "Can't export invalid title" );
153 return $this->pageByTitle( $title );
157 public function pagesByName( $names ) {
158 foreach ( $names as $name ) {
159 $this->pageByName( $name );
163 public function allLogs() {
164 return $this->dumpFrom( '' );
167 public function logsByRange( $start, $end ) {
168 $condition = 'log_id >= ' . intval( $start );
170 $condition .= ' AND log_id < ' . intval( $end );
172 return $this->dumpFrom( $condition );
175 # Generates the distinct list of authors of an article
176 # Not called by default (depends on $this->list_authors)
177 # Can be set by Special:Export when not exporting whole history
178 protected function do_list_authors( $cond ) {
179 wfProfileIn( __METHOD__
);
180 $this->author_list
= "<contributors>";
183 $res = $this->db
->select(
184 array( 'page', 'revision' ),
185 array( 'DISTINCT rev_user_text', 'rev_user' ),
187 $this->db
->bitAnd( 'rev_deleted', Revision
::DELETED_USER
) . ' = 0',
194 foreach ( $res as $row ) {
195 $this->author_list
.= "<contributor>" .
197 htmlentities( $row->rev_user_text
) .
204 $this->author_list
.= "</contributors>";
205 wfProfileOut( __METHOD__
);
208 protected function dumpFrom( $cond = '' ) {
209 wfProfileIn( __METHOD__
);
210 # For logging dumps...
211 if ( $this->history
& self
::LOGS
) {
212 if ( $this->buffer
== WikiExporter
::STREAM
) {
213 $prev = $this->db
->bufferResults( false );
215 $where = array( 'user_id = log_user' );
217 $hideLogs = LogEventsList
::getExcludeClause( $this->db
);
218 if ( $hideLogs ) $where[] = $hideLogs;
219 # Add on any caller specified conditions
220 if ( $cond ) $where[] = $cond;
221 # Get logging table name for logging.* clause
222 $logging = $this->db
->tableName( 'logging' );
223 $result = $this->db
->select( array( 'logging', 'user' ),
224 array( "{$logging}.*", 'user_name' ), // grab the user name
227 array( 'ORDER BY' => 'log_id', 'USE INDEX' => array( 'logging' => 'PRIMARY' ) )
229 $wrapper = $this->db
->resultObject( $result );
230 $this->outputLogStream( $wrapper );
231 if ( $this->buffer
== WikiExporter
::STREAM
) {
232 $this->db
->bufferResults( $prev );
236 $tables = array( 'page', 'revision' );
237 $opts = array( 'ORDER BY' => 'page_id ASC' );
238 $opts['USE INDEX'] = array();
240 if ( is_array( $this->history
) ) {
241 # Time offset/limit for all pages/history...
242 $revJoin = 'page_id=rev_page';
244 if ( $this->history
['dir'] == 'asc' ) {
246 $opts['ORDER BY'] = 'rev_timestamp ASC';
249 $opts['ORDER BY'] = 'rev_timestamp DESC';
252 if ( !empty( $this->history
['offset'] ) ) {
253 $revJoin .= " AND rev_timestamp $op " .
254 $this->db
->addQuotes( $this->db
->timestamp( $this->history
['offset'] ) );
256 $join['revision'] = array( 'INNER JOIN', $revJoin );
258 if ( !empty( $this->history
['limit'] ) ) {
259 $opts['LIMIT'] = intval( $this->history
['limit'] );
261 } elseif ( $this->history
& WikiExporter
::FULL
) {
262 # Full history dumps...
263 $join['revision'] = array( 'INNER JOIN', 'page_id=rev_page' );
264 } elseif ( $this->history
& WikiExporter
::CURRENT
) {
265 # Latest revision dumps...
266 if ( $this->list_authors
&& $cond != '' ) { // List authors, if so desired
267 $this->do_list_authors( $cond );
269 $join['revision'] = array( 'INNER JOIN', 'page_id=rev_page AND page_latest=rev_id' );
270 } elseif ( $this->history
& WikiExporter
::STABLE
) {
271 # "Stable" revision dumps...
272 # Default JOIN, to be overridden...
273 $join['revision'] = array( 'INNER JOIN', 'page_id=rev_page AND page_latest=rev_id' );
274 # One, and only one hook should set this, and return false
275 if ( wfRunHooks( 'WikiExporter::dumpStableQuery', array( &$tables, &$opts, &$join ) ) ) {
276 wfProfileOut( __METHOD__
);
277 throw new MWException( __METHOD__
. " given invalid history dump type." );
279 } elseif ( $this->history
& WikiExporter
::RANGE
) {
280 # Dump of revisions within a specified range
281 $join['revision'] = array( 'INNER JOIN', 'page_id=rev_page' );
282 $opts['ORDER BY'] = 'rev_page ASC, rev_id ASC';
284 # Uknown history specification parameter?
285 wfProfileOut( __METHOD__
);
286 throw new MWException( __METHOD__
. " given invalid history dump type." );
288 # Query optimization hacks
290 $opts[] = 'STRAIGHT_JOIN';
291 $opts['USE INDEX']['page'] = 'PRIMARY';
293 # Build text join options
294 if ( $this->text
!= WikiExporter
::STUB
) { // 1-pass
296 $join['text'] = array( 'INNER JOIN', 'rev_text_id=old_id' );
299 if ( $this->buffer
== WikiExporter
::STREAM
) {
300 $prev = $this->db
->bufferResults( false );
303 wfRunHooks( 'ModifyExportQuery',
304 array( $this->db
, &$tables, &$cond, &$opts, &$join ) );
307 $result = $this->db
->select( $tables, '*', $cond, __METHOD__
, $opts, $join );
308 $wrapper = $this->db
->resultObject( $result );
309 # Output dump results
310 $this->outputPageStream( $wrapper );
311 if ( $this->list_authors
) {
312 $this->outputPageStream( $wrapper );
315 if ( $this->buffer
== WikiExporter
::STREAM
) {
316 $this->db
->bufferResults( $prev );
319 wfProfileOut( __METHOD__
);
323 * Runs through a query result set dumping page and revision records.
324 * The result set should be sorted/grouped by page to avoid duplicate
325 * page records in the output.
327 * The result set will be freed once complete. Should be safe for
328 * streaming (non-buffered) queries, as long as it was made on a
329 * separate database connection not managed by LoadBalancer; some
330 * blob storage types will make queries to pull source data.
332 * @param $resultset ResultWrapper
334 protected function outputPageStream( $resultset ) {
336 foreach ( $resultset as $row ) {
337 if ( is_null( $last ) ||
338 $last->page_namespace
!= $row->page_namespace ||
339 $last->page_title
!= $row->page_title
) {
340 if ( isset( $last ) ) {
342 if ( $this->dumpUploads
) {
343 $output .= $this->writer
->writeUploads( $last, $this->dumpUploadFileContents
);
345 $output .= $this->writer
->closePage();
346 $this->sink
->writeClosePage( $output );
348 $output = $this->writer
->openPage( $row );
349 $this->sink
->writeOpenPage( $row, $output );
352 $output = $this->writer
->writeRevision( $row );
353 $this->sink
->writeRevision( $row, $output );
355 if ( isset( $last ) ) {
357 if ( $this->dumpUploads
) {
358 $output .= $this->writer
->writeUploads( $last, $this->dumpUploadFileContents
);
360 $output .= $this->author_list
;
361 $output .= $this->writer
->closePage();
362 $this->sink
->writeClosePage( $output );
366 protected function outputLogStream( $resultset ) {
367 foreach ( $resultset as $row ) {
368 $output = $this->writer
->writeLogItem( $row );
369 $this->sink
->writeLogItem( $row, $output );
377 class XmlDumpWriter
{
379 * Returns the export schema version.
382 function schemaVersion() {
387 * Opens the XML output stream's root <mediawiki> element.
388 * This does not include an xml directive, so is safe to include
389 * as a subelement in a larger XML stream. Namespace and XML Schema
390 * references are included.
392 * Output will be encoded in UTF-8.
396 function openStream() {
397 global $wgLanguageCode;
398 $ver = $this->schemaVersion();
399 return Xml
::element( 'mediawiki', array(
400 'xmlns' => "http://www.mediawiki.org/xml/export-$ver/",
401 'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
402 'xsi:schemaLocation' => "http://www.mediawiki.org/xml/export-$ver/ " .
403 "http://www.mediawiki.org/xml/export-$ver.xsd",
405 'xml:lang' => $wgLanguageCode ),
411 function siteInfo() {
416 $this->caseSetting(),
417 $this->namespaces() );
418 return " <siteinfo>\n " .
419 implode( "\n ", $info ) .
423 function sitename() {
425 return Xml
::element( 'sitename', array(), $wgSitename );
428 function generator() {
430 return Xml
::element( 'generator', array(), "MediaWiki $wgVersion" );
433 function homelink() {
434 return Xml
::element( 'base', array(), Title
::newMainPage()->getCanonicalUrl() );
437 function caseSetting() {
438 global $wgCapitalLinks;
439 // "case-insensitive" option is reserved for future
440 $sensitivity = $wgCapitalLinks ?
'first-letter' : 'case-sensitive';
441 return Xml
::element( 'case', array(), $sensitivity );
444 function namespaces() {
446 $spaces = "<namespaces>\n";
447 foreach ( $wgContLang->getFormattedNamespaces() as $ns => $title ) {
449 Xml
::element( 'namespace',
451 'case' => MWNamespace
::isCapitalized( $ns ) ?
'first-letter' : 'case-sensitive',
454 $spaces .= " </namespaces>";
459 * Closes the output stream with the closing root element.
460 * Call when finished dumping things.
464 function closeStream() {
465 return "</mediawiki>\n";
469 * Opens a <page> section on the output stream, with data
470 * from the given database row.
476 function openPage( $row ) {
478 $title = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
479 $out .= ' ' . Xml
::elementClean( 'title', array(), self
::canonicalTitle( $title ) ) . "\n";
480 $out .= ' ' . Xml
::element( 'ns', array(), strval( $row->page_namespace
) ) . "\n";
481 $out .= ' ' . Xml
::element( 'id', array(), strval( $row->page_id
) ) . "\n";
482 if ( $row->page_is_redirect
) {
483 $page = WikiPage
::factory( $title );
484 $redirect = $page->getRedirectTarget();
485 if ( $redirect instanceOf Title
&& $redirect->isValidRedirectTarget() ) {
486 $out .= ' ' . Xml
::element( 'redirect', array( 'title' => self
::canonicalTitle( $redirect ) ) ) . "\n";
490 if ( $row->page_restrictions
!= '' ) {
491 $out .= ' ' . Xml
::element( 'restrictions', array(),
492 strval( $row->page_restrictions
) ) . "\n";
495 wfRunHooks( 'XmlDumpWriterOpenPage', array( $this, &$out, $row, $title ) );
501 * Closes a <page> section on the output stream.
506 function closePage() {
511 * Dumps a <revision> section on the output stream, with
512 * data filled in from the given database row.
518 function writeRevision( $row ) {
519 wfProfileIn( __METHOD__
);
521 $out = " <revision>\n";
522 $out .= " " . Xml
::element( 'id', null, strval( $row->rev_id
) ) . "\n";
524 $out .= $this->writeTimestamp( $row->rev_timestamp
);
526 if ( $row->rev_deleted
& Revision
::DELETED_USER
) {
527 $out .= " " . Xml
::element( 'contributor', array( 'deleted' => 'deleted' ) ) . "\n";
529 $out .= $this->writeContributor( $row->rev_user
, $row->rev_user_text
);
532 if ( $row->rev_minor_edit
) {
533 $out .= " <minor/>\n";
535 if ( $row->rev_deleted
& Revision
::DELETED_COMMENT
) {
536 $out .= " " . Xml
::element( 'comment', array( 'deleted' => 'deleted' ) ) . "\n";
537 } elseif ( $row->rev_comment
!= '' ) {
538 $out .= " " . Xml
::elementClean( 'comment', null, strval( $row->rev_comment
) ) . "\n";
542 if ( $row->rev_deleted
& Revision
::DELETED_TEXT
) {
543 $out .= " " . Xml
::element( 'text', array( 'deleted' => 'deleted' ) ) . "\n";
544 } elseif ( isset( $row->old_text
) ) {
545 // Raw text from the database may have invalid chars
546 $text = strval( Revision
::getRevisionText( $row ) );
547 $out .= " " . Xml
::elementClean( 'text',
548 array( 'xml:space' => 'preserve', 'bytes' => intval( $row->rev_len
) ),
549 strval( $text ) ) . "\n";
552 $out .= " " . Xml
::element( 'text',
553 array( 'id' => $row->rev_text_id
, 'bytes' => intval( $row->rev_len
) ),
557 if ( $row->rev_sha1
&& !( $row->rev_deleted
& Revision
::DELETED_TEXT
) ) {
558 $out .= " " . Xml
::element('sha1', null, strval( $row->rev_sha1
) ) . "\n";
560 $out .= " <sha1/>\n";
563 wfRunHooks( 'XmlDumpWriterWriteRevision', array( &$this, &$out, $row, $text ) );
565 $out .= " </revision>\n";
567 wfProfileOut( __METHOD__
);
572 * Dumps a <logitem> section on the output stream, with
573 * data filled in from the given database row.
579 function writeLogItem( $row ) {
580 wfProfileIn( __METHOD__
);
582 $out = " <logitem>\n";
583 $out .= " " . Xml
::element( 'id', null, strval( $row->log_id
) ) . "\n";
585 $out .= $this->writeTimestamp( $row->log_timestamp
);
587 if ( $row->log_deleted
& LogPage
::DELETED_USER
) {
588 $out .= " " . Xml
::element( 'contributor', array( 'deleted' => 'deleted' ) ) . "\n";
590 $out .= $this->writeContributor( $row->log_user
, $row->user_name
);
593 if ( $row->log_deleted
& LogPage
::DELETED_COMMENT
) {
594 $out .= " " . Xml
::element( 'comment', array( 'deleted' => 'deleted' ) ) . "\n";
595 } elseif ( $row->log_comment
!= '' ) {
596 $out .= " " . Xml
::elementClean( 'comment', null, strval( $row->log_comment
) ) . "\n";
599 $out .= " " . Xml
::element( 'type', null, strval( $row->log_type
) ) . "\n";
600 $out .= " " . Xml
::element( 'action', null, strval( $row->log_action
) ) . "\n";
602 if ( $row->log_deleted
& LogPage
::DELETED_ACTION
) {
603 $out .= " " . Xml
::element( 'text', array( 'deleted' => 'deleted' ) ) . "\n";
605 $title = Title
::makeTitle( $row->log_namespace
, $row->log_title
);
606 $out .= " " . Xml
::elementClean( 'logtitle', null, self
::canonicalTitle( $title ) ) . "\n";
607 $out .= " " . Xml
::elementClean( 'params',
608 array( 'xml:space' => 'preserve' ),
609 strval( $row->log_params
) ) . "\n";
612 $out .= " </logitem>\n";
614 wfProfileOut( __METHOD__
);
618 function writeTimestamp( $timestamp ) {
619 $ts = wfTimestamp( TS_ISO_8601
, $timestamp );
620 return " " . Xml
::element( 'timestamp', null, $ts ) . "\n";
623 function writeContributor( $id, $text ) {
624 $out = " <contributor>\n";
625 if ( $id ||
!IP
::isValid( $text ) ) {
626 $out .= " " . Xml
::elementClean( 'username', null, strval( $text ) ) . "\n";
627 $out .= " " . Xml
::element( 'id', null, strval( $id ) ) . "\n";
629 $out .= " " . Xml
::elementClean( 'ip', null, strval( $text ) ) . "\n";
631 $out .= " </contributor>\n";
636 * Warning! This data is potentially inconsistent. :(
639 function writeUploads( $row, $dumpContents = false ) {
640 if ( $row->page_namespace
== NS_IMAGE
) {
641 $img = wfLocalFile( $row->page_title
);
642 if ( $img && $img->exists() ) {
644 foreach ( array_reverse( $img->getHistory() ) as $ver ) {
645 $out .= $this->writeUpload( $ver, $dumpContents );
647 $out .= $this->writeUpload( $img, $dumpContents );
656 * @param $dumpContents bool
659 function writeUpload( $file, $dumpContents = false ) {
660 if ( $file->isOld() ) {
662 Xml
::element( 'archivename', null, $file->getArchiveName() ) . "\n";
666 if ( $dumpContents ) {
667 # Dump file as base64
668 # Uses only XML-safe characters, so does not need escaping
669 $contents = ' <contents encoding="base64">' .
670 chunk_split( base64_encode( file_get_contents( $file->getPath() ) ) ) .
675 return " <upload>\n" .
676 $this->writeTimestamp( $file->getTimestamp() ) .
677 $this->writeContributor( $file->getUser( 'id' ), $file->getUser( 'text' ) ) .
678 " " . Xml
::elementClean( 'comment', null, $file->getDescription() ) . "\n" .
679 " " . Xml
::element( 'filename', null, $file->getName() ) . "\n" .
681 " " . Xml
::element( 'src', null, $file->getCanonicalUrl() ) . "\n" .
682 " " . Xml
::element( 'size', null, $file->getSize() ) . "\n" .
683 " " . Xml
::element( 'sha1base36', null, $file->getSha1() ) . "\n" .
684 " " . Xml
::element( 'rel', null, $file->getRel() ) . "\n" .
690 * Return prefixed text form of title, but using the content language's
691 * canonical namespace. This skips any special-casing such as gendered
692 * user namespaces -- which while useful, are not yet listed in the
693 * XML <siteinfo> data so are unsafe in export.
695 * @param Title $title
699 public static function canonicalTitle( Title
$title ) {
700 if ( $title->getInterwiki() ) {
701 return $title->getPrefixedText();
705 $prefix = str_replace( '_', ' ', $wgContLang->getNsText( $title->getNamespace() ) );
707 if ( $prefix !== '' ) {
711 return $prefix . $title->getText();
717 * Base class for output stream; prints to stdout or buffer or whereever.
721 function writeOpenStream( $string ) {
722 $this->write( $string );
725 function writeCloseStream( $string ) {
726 $this->write( $string );
729 function writeOpenPage( $page, $string ) {
730 $this->write( $string );
733 function writeClosePage( $string ) {
734 $this->write( $string );
737 function writeRevision( $rev, $string ) {
738 $this->write( $string );
741 function writeLogItem( $rev, $string ) {
742 $this->write( $string );
746 * Override to write to a different stream type.
749 function write( $string ) {
754 * Close the old file, move it to a specified name,
755 * and reopen new file with the old name. Use this
756 * for writing out a file in multiple pieces
757 * at specified checkpoints (e.g. every n hours).
758 * @param $newname mixed File name. May be a string or an array with one element
760 function closeRenameAndReopen( $newname ) {
765 * Close the old file, and move it to a specified name.
766 * Use this for the last piece of a file written out
767 * at specified checkpoints (e.g. every n hours).
768 * @param $newname mixed File name. May be a string or an array with one element
769 * @param $open bool If true, a new file with the old filename will be opened again for writing (default: false)
771 function closeAndRename( $newname, $open = false ) {
776 * Returns the name of the file or files which are
777 * being written to, if there are any.
780 function getFilenames() {
786 * Stream outputter to send data to a file.
789 class DumpFileOutput
extends DumpOutput
{
790 protected $handle, $filename;
792 function __construct( $file ) {
793 $this->handle
= fopen( $file, "wt" );
794 $this->filename
= $file;
797 function writeCloseStream( $string ) {
798 parent
::writeCloseStream( $string );
799 fclose( $this->handle
);
802 function write( $string ) {
803 fputs( $this->handle
, $string );
806 function closeRenameAndReopen( $newname ) {
807 $this->closeAndRename( $newname, true );
810 function renameOrException( $newname ) {
811 if (! rename( $this->filename
, $newname ) ) {
812 throw new MWException( __METHOD__
. ": rename of file {$this->filename} to $newname failed\n" );
816 function checkRenameArgCount( $newname ) {
817 if ( is_array( $newname ) ) {
818 if ( count( $newname ) > 1 ) {
819 throw new MWException( __METHOD__
. ": passed multiple arguments for rename of single file\n" );
821 $newname = $newname[0];
827 function closeAndRename( $newname, $open = false ) {
828 $newname = $this->checkRenameArgCount( $newname );
830 fclose( $this->handle
);
831 $this->renameOrException( $newname );
833 $this->handle
= fopen( $this->filename
, "wt" );
838 function getFilenames() {
839 return $this->filename
;
844 * Stream outputter to send data to a file via some filter program.
845 * Even if compression is available in a library, using a separate
846 * program can allow us to make use of a multi-processor system.
849 class DumpPipeOutput
extends DumpFileOutput
{
850 protected $command, $filename;
852 function __construct( $command, $file = null ) {
853 if ( !is_null( $file ) ) {
854 $command .= " > " . wfEscapeShellArg( $file );
857 $this->startCommand( $command );
858 $this->command
= $command;
859 $this->filename
= $file;
862 function writeCloseStream( $string ) {
863 parent
::writeCloseStream( $string );
864 proc_close( $this->procOpenResource
);
867 function startCommand( $command ) {
869 0 => array( "pipe", "r" ),
872 $this->procOpenResource
= proc_open( $command, $spec, $pipes );
873 $this->handle
= $pipes[0];
876 function closeRenameAndReopen( $newname ) {
877 $this->closeAndRename( $newname, true );
880 function closeAndRename( $newname, $open = false ) {
881 $newname = $this->checkRenameArgCount( $newname );
883 fclose( $this->handle
);
884 proc_close( $this->procOpenResource
);
885 $this->renameOrException( $newname );
887 $command = $this->command
;
888 $command .= " > " . wfEscapeShellArg( $this->filename
);
889 $this->startCommand( $command );
897 * Sends dump output via the gzip compressor.
900 class DumpGZipOutput
extends DumpPipeOutput
{
901 function __construct( $file ) {
902 parent
::__construct( "gzip", $file );
907 * Sends dump output via the bgzip2 compressor.
910 class DumpBZip2Output
extends DumpPipeOutput
{
911 function __construct( $file ) {
912 parent
::__construct( "bzip2", $file );
917 * Sends dump output via the p7zip compressor.
920 class Dump7ZipOutput
extends DumpPipeOutput
{
921 function __construct( $file ) {
922 $command = $this->setup7zCommand( $file );
923 parent
::__construct( $command );
924 $this->filename
= $file;
927 function setup7zCommand( $file ) {
928 $command = "7za a -bd -si " . wfEscapeShellArg( $file );
929 // Suppress annoying useless crap from p7zip
930 // Unfortunately this could suppress real error messages too
931 $command .= ' >' . wfGetNull() . ' 2>&1';
935 function closeAndRename( $newname, $open = false ) {
936 $newname = $this->checkRenameArgCount( $newname );
938 fclose( $this->handle
);
939 proc_close( $this->procOpenResource
);
940 $this->renameOrException( $newname );
942 $command = $this->setup7zCommand( $this->filename
);
943 $this->startCommand( $command );
952 * Dump output filter class.
953 * This just does output filtering and streaming; XML formatting is done
954 * higher up, so be careful in what you do.
958 function __construct( &$sink ) {
959 $this->sink
=& $sink;
962 function writeOpenStream( $string ) {
963 $this->sink
->writeOpenStream( $string );
966 function writeCloseStream( $string ) {
967 $this->sink
->writeCloseStream( $string );
970 function writeOpenPage( $page, $string ) {
971 $this->sendingThisPage
= $this->pass( $page, $string );
972 if ( $this->sendingThisPage
) {
973 $this->sink
->writeOpenPage( $page, $string );
977 function writeClosePage( $string ) {
978 if ( $this->sendingThisPage
) {
979 $this->sink
->writeClosePage( $string );
980 $this->sendingThisPage
= false;
984 function writeRevision( $rev, $string ) {
985 if ( $this->sendingThisPage
) {
986 $this->sink
->writeRevision( $rev, $string );
990 function writeLogItem( $rev, $string ) {
991 $this->sink
->writeRevision( $rev, $string );
994 function closeRenameAndReopen( $newname ) {
995 $this->sink
->closeRenameAndReopen( $newname );
998 function closeAndRename( $newname, $open = false ) {
999 $this->sink
->closeAndRename( $newname, $open );
1002 function getFilenames() {
1003 return $this->sink
->getFilenames();
1007 * Override for page-based filter types.
1010 function pass( $page ) {
1016 * Simple dump output filter to exclude all talk pages.
1019 class DumpNotalkFilter
extends DumpFilter
{
1020 function pass( $page ) {
1021 return !MWNamespace
::isTalk( $page->page_namespace
);
1026 * Dump output filter to include or exclude pages in a given set of namespaces.
1029 class DumpNamespaceFilter
extends DumpFilter
{
1030 var $invert = false;
1031 var $namespaces = array();
1033 function __construct( &$sink, $param ) {
1034 parent
::__construct( $sink );
1037 "NS_MAIN" => NS_MAIN
,
1038 "NS_TALK" => NS_TALK
,
1039 "NS_USER" => NS_USER
,
1040 "NS_USER_TALK" => NS_USER_TALK
,
1041 "NS_PROJECT" => NS_PROJECT
,
1042 "NS_PROJECT_TALK" => NS_PROJECT_TALK
,
1043 "NS_FILE" => NS_FILE
,
1044 "NS_FILE_TALK" => NS_FILE_TALK
,
1045 "NS_IMAGE" => NS_IMAGE
, // NS_IMAGE is an alias for NS_FILE
1046 "NS_IMAGE_TALK" => NS_IMAGE_TALK
,
1047 "NS_MEDIAWIKI" => NS_MEDIAWIKI
,
1048 "NS_MEDIAWIKI_TALK" => NS_MEDIAWIKI_TALK
,
1049 "NS_TEMPLATE" => NS_TEMPLATE
,
1050 "NS_TEMPLATE_TALK" => NS_TEMPLATE_TALK
,
1051 "NS_HELP" => NS_HELP
,
1052 "NS_HELP_TALK" => NS_HELP_TALK
,
1053 "NS_CATEGORY" => NS_CATEGORY
,
1054 "NS_CATEGORY_TALK" => NS_CATEGORY_TALK
);
1056 if ( $param { 0 } == '!' ) {
1057 $this->invert
= true;
1058 $param = substr( $param, 1 );
1061 foreach ( explode( ',', $param ) as $key ) {
1062 $key = trim( $key );
1063 if ( isset( $constants[$key] ) ) {
1064 $ns = $constants[$key];
1065 $this->namespaces
[$ns] = true;
1066 } elseif ( is_numeric( $key ) ) {
1067 $ns = intval( $key );
1068 $this->namespaces
[$ns] = true;
1070 throw new MWException( "Unrecognized namespace key '$key'\n" );
1075 function pass( $page ) {
1076 $match = isset( $this->namespaces
[$page->page_namespace
] );
1077 return $this->invert
xor $match;
1083 * Dump output filter to include only the last revision in each page sequence.
1086 class DumpLatestFilter
extends DumpFilter
{
1087 var $page, $pageString, $rev, $revString;
1089 function writeOpenPage( $page, $string ) {
1090 $this->page
= $page;
1091 $this->pageString
= $string;
1094 function writeClosePage( $string ) {
1096 $this->sink
->writeOpenPage( $this->page
, $this->pageString
);
1097 $this->sink
->writeRevision( $this->rev
, $this->revString
);
1098 $this->sink
->writeClosePage( $string );
1101 $this->revString
= null;
1103 $this->pageString
= null;
1106 function writeRevision( $rev, $string ) {
1107 if ( $rev->rev_id
== $this->page
->page_latest
) {
1109 $this->revString
= $string;
1115 * Base class for output stream; prints to stdout or buffer or whereever.
1118 class DumpMultiWriter
{
1119 function __construct( $sinks ) {
1120 $this->sinks
= $sinks;
1121 $this->count
= count( $sinks );
1124 function writeOpenStream( $string ) {
1125 for ( $i = 0; $i < $this->count
; $i++
) {
1126 $this->sinks
[$i]->writeOpenStream( $string );
1130 function writeCloseStream( $string ) {
1131 for ( $i = 0; $i < $this->count
; $i++
) {
1132 $this->sinks
[$i]->writeCloseStream( $string );
1136 function writeOpenPage( $page, $string ) {
1137 for ( $i = 0; $i < $this->count
; $i++
) {
1138 $this->sinks
[$i]->writeOpenPage( $page, $string );
1142 function writeClosePage( $string ) {
1143 for ( $i = 0; $i < $this->count
; $i++
) {
1144 $this->sinks
[$i]->writeClosePage( $string );
1148 function writeRevision( $rev, $string ) {
1149 for ( $i = 0; $i < $this->count
; $i++
) {
1150 $this->sinks
[$i]->writeRevision( $rev, $string );
1154 function closeRenameAndReopen( $newnames ) {
1155 $this->closeAndRename( $newnames, true );
1158 function closeAndRename( $newnames, $open = false ) {
1159 for ( $i = 0; $i < $this->count
; $i++
) {
1160 $this->sinks
[$i]->closeAndRename( $newnames[$i], $open );
1164 function getFilenames() {
1165 $filenames = array();
1166 for ( $i = 0; $i < $this->count
; $i++
) {
1167 $filenames[] = $this->sinks
[$i]->getFilenames();
1174 function xmlsafe( $string ) {
1175 wfProfileIn( __FUNCTION__
);
1178 * The page may contain old data which has not been properly normalized.
1179 * Invalid UTF-8 sequences or forbidden control characters will make our
1180 * XML output invalid, so be sure to strip them out.
1182 $string = UtfNormal
::cleanUp( $string );
1184 $string = htmlspecialchars( $string );
1185 wfProfileOut( __FUNCTION__
);