includes/Export.php

   1 <?php
   2 /**
   3  * Base classes for dumps and export
   4  *
   5  * Copyright © 2003, 2005, 2006 Brion Vibber <brion@pobox.com>
   6  * http://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  */
  25
  26 /**
  27  * @defgroup Dump Dump
  28  */
  29
  30 /**
  31  * @ingroup SpecialPage Dump
  32  */
  33 class WikiExporter {
  34         var $list_authors = false ; # Return distinct author list (when not returning full history)
  35         var $author_list = "" ;
  36
  37         var $dumpUploads = false;
  38         var $dumpUploadFileContents = false;
  39
  40         const FULL = 1;
  41         const CURRENT = 2;
  42         const STABLE = 4; // extension defined
  43         const LOGS = 8;
  44         const RANGE = 16;
  45
  46         const BUFFER = 0;
  47         const STREAM = 1;
  48
  49         const TEXT = 0;
  50         const STUB = 1;
  51
  52         var $buffer;
  53
  54         var $text;
  55
  56         /**
  57          * @var DumpOutput
  58          */
  59         var $sink;
  60
  61         /**
  62          * If using WikiExporter::STREAM to stream a large amount of data,
  63          * provide a database connection which is not managed by
  64          * LoadBalancer to read from: some history blob types will
  65          * make additional queries to pull source data while the
  66          * main query is still running.
  67          *
  68          * @param $db DatabaseBase
  69          * @param $history Mixed: one of WikiExporter::FULL, WikiExporter::CURRENT,
  70          *                 WikiExporter::RANGE or WikiExporter::STABLE,
  71          *                 or an associative array:
  72          *                   offset: non-inclusive offset at which to start the query
  73          *                   limit: maximum number of rows to return
  74          *                   dir: "asc" or "desc" timestamp order
  75          * @param $buffer Int: one of WikiExporter::BUFFER or WikiExporter::STREAM
  76          * @param $text Int: one of WikiExporter::TEXT or WikiExporter::STUB
  77          */
  78         function __construct( &$db, $history = WikiExporter::CURRENT,
  79                         $buffer = WikiExporter::BUFFER, $text = WikiExporter::TEXT ) {
  80                 $this->db =& $db;
  81                 $this->history = $history;
  82                 $this->buffer  = $buffer;
  83                 $this->writer  = new XmlDumpWriter();
  84                 $this->sink    = new DumpOutput();
  85                 $this->text    = $text;
  86         }
  87
  88         /**
  89          * Set the DumpOutput or DumpFilter object which will receive
  90          * various row objects and XML output for filtering. Filters
  91          * can be chained or used as callbacks.
  92          *
  93          * @param $sink mixed
  94          */
  95         public function setOutputSink( &$sink ) {
  96                 $this->sink =& $sink;
  97         }
  98
  99         public function openStream() {
 100                 $output = $this->writer->openStream();
 101                 $this->sink->writeOpenStream( $output );
 102         }
 103
 104         public function closeStream() {
 105                 $output = $this->writer->closeStream();
 106                 $this->sink->writeCloseStream( $output );
 107         }
 108
 109         /**
 110          * Dumps a series of page and revision records for all pages
 111          * in the database, either including complete history or only
 112          * the most recent version.
 113          */
 114         public function allPages() {
 115                 $this->dumpFrom( '' );
 116         }
 117
 118         /**
 119          * Dumps a series of page and revision records for those pages
 120          * in the database falling within the page_id range given.
 121          * @param $start Int: inclusive lower limit (this id is included)
 122          * @param $end   Int: Exclusive upper limit (this id is not included)
 123          *                   If 0, no upper limit.
 124          */
 125         public function pagesByRange( $start, $end ) {
 126                 $condition = 'page_id >= ' . intval( $start );
 127                 if ( $end ) {
 128                         $condition .= ' AND page_id < ' . intval( $end );
 129                 }
 130                 $this->dumpFrom( $condition );
 131         }
 132
 133         /**
 134          * Dumps a series of page and revision records for those pages
 135          * in the database with revisions falling within the rev_id range given.
 136          * @param $start Int: inclusive lower limit (this id is included)
 137          * @param $end   Int: Exclusive upper limit (this id is not included)
 138          *                   If 0, no upper limit.
 139          */
 140         public function revsByRange( $start, $end ) {
 141                 $condition = 'rev_id >= ' . intval( $start );
 142                 if ( $end ) {
 143                         $condition .= ' AND rev_id < ' . intval( $end );
 144                 }
 145                 $this->dumpFrom( $condition );
 146         }
 147
 148         /**
 149          * @param $title Title
 150          */
 151         public function pageByTitle( $title ) {
 152                 $this->dumpFrom(
 153                         'page_namespace=' . $title->getNamespace() .
 154                         ' AND page_title=' . $this->db->addQuotes( $title->getDBkey() ) );
 155         }
 156
 157         /**
 158          * @param $name string
 159          * @throws MWException
 160          */
 161         public function pageByName( $name ) {
 162                 $title = Title::newFromText( $name );
 163                 if ( is_null( $title ) ) {
 164                         throw new MWException( "Can't export invalid title" );
 165                 } else {
 166                         $this->pageByTitle( $title );
 167                 }
 168         }
 169
 170         /**
 171          * @param $names array
 172          */
 173         public function pagesByName( $names ) {
 174                 foreach ( $names as $name ) {
 175                         $this->pageByName( $name );
 176                 }
 177         }
 178
 179         public function allLogs() {
 180                 $this->dumpFrom( '' );
 181         }
 182
 183         /**
 184          * @param $start int
 185          * @param $end int
 186          */
 187         public function logsByRange( $start, $end ) {
 188                 $condition = 'log_id >= ' . intval( $start );
 189                 if ( $end ) {
 190                         $condition .= ' AND log_id < ' . intval( $end );
 191                 }
 192                 $this->dumpFrom( $condition );
 193         }
 194
 195         /**
 196          * Generates the distinct list of authors of an article
 197          * Not called by default (depends on $this->list_authors)
 198          * Can be set by Special:Export when not exporting whole history
 199          *
 200          * @param $cond
 201          */
 202         protected function do_list_authors( $cond ) {
 203                 wfProfileIn( __METHOD__ );
 204                 $this->author_list = "<contributors>";
 205                 // rev_deleted
 206
 207                 $res = $this->db->select(
 208                         array( 'page', 'revision' ),
 209                         array( 'DISTINCT rev_user_text', 'rev_user' ),
 210                         array(
 211                                 $this->db->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0',
 212                                 $cond,
 213                                 'page_id = rev_id',
 214                         ),
 215                         __METHOD__
 216                 );
 217
 218                 foreach ( $res as $row ) {
 219                         $this->author_list .= "<contributor>" .
 220                                 "<username>" .
 221                                 htmlentities( $row->rev_user_text )  .
 222                                 "</username>" .
 223                                 "<id>" .
 224                                 $row->rev_user .
 225                                 "</id>" .
 226                                 "</contributor>";
 227                 }
 228                 $this->author_list .= "</contributors>";
 229                 wfProfileOut( __METHOD__ );
 230         }
 231
 232         /**
 233          * @param $cond string
 234          * @throws MWException
 235          * @throws Exception
 236          */
 237         protected function dumpFrom( $cond = '' ) {
 238                 wfProfileIn( __METHOD__ );
 239                 # For logging dumps...
 240                 if ( $this->history & self::LOGS ) {
 241                         $where = array( 'user_id = log_user' );
 242                         # Hide private logs
 243                         $hideLogs = LogEventsList::getExcludeClause( $this->db );
 244                         if ( $hideLogs ) $where[] = $hideLogs;
 245                         # Add on any caller specified conditions
 246                         if ( $cond ) $where[] = $cond;
 247                         # Get logging table name for logging.* clause
 248                         $logging = $this->db->tableName( 'logging' );
 249
 250                         if ( $this->buffer == WikiExporter::STREAM ) {
 251                                 $prev = $this->db->bufferResults( false );
 252                         }
 253                         $wrapper = null; // Assuring $wrapper is not undefined, if exception occurs early
 254                         try {
 255                                 $result = $this->db->select( array( 'logging', 'user' ),
 256                                         array( "{$logging}.*", 'user_name' ), // grab the user name
 257                                         $where,
 258                                         __METHOD__,
 259                                         array( 'ORDER BY' => 'log_id', 'USE INDEX' => array( 'logging' => 'PRIMARY' ) )
 260                                 );
 261                                 $wrapper = $this->db->resultObject( $result );
 262                                 $this->outputLogStream( $wrapper );
 263                                 if ( $this->buffer == WikiExporter::STREAM ) {
 264                                         $this->db->bufferResults( $prev );
 265                                 }
 266                         } catch ( Exception $e ) {
 267                                 // Throwing the exception does not reliably free the resultset, and
 268                                 // would also leave the connection in unbuffered mode.
 269
 270                                 // Freeing result
 271                                 try {
 272                                         if ( $wrapper ) {
 273                                                 $wrapper->free();
 274                                         }
 275                                 } catch ( Exception $e2 ) {
 276                                         // Already in panic mode -> ignoring $e2 as $e has
 277                                         // higher priority
 278                                 }
 279
 280                                 // Putting database back in previous buffer mode
 281                                 try {
 282                                         if ( $this->buffer == WikiExporter::STREAM ) {
 283                                                 $this->db->bufferResults( $prev );
 284                                         }
 285                                 } catch ( Exception $e2 ) {
 286                                         // Already in panic mode -> ignoring $e2 as $e has
 287                                         // higher priority
 288                                 }
 289
 290                                 // Inform caller about problem
 291                                 throw $e;
 292                         }
 293                 # For page dumps...
 294                 } else {
 295                         $tables = array( 'page', 'revision' );
 296                         $opts = array( 'ORDER BY' => 'page_id ASC' );
 297                         $opts['USE INDEX'] = array();
 298                         $join = array();
 299                         if ( is_array( $this->history ) ) {
 300                                 # Time offset/limit for all pages/history...
 301                                 $revJoin = 'page_id=rev_page';
 302                                 # Set time order
 303                                 if ( $this->history['dir'] == 'asc' ) {
 304                                         $op = '>';
 305                                         $opts['ORDER BY'] = 'rev_timestamp ASC';
 306                                 } else {
 307                                         $op = '<';
 308                                         $opts['ORDER BY'] = 'rev_timestamp DESC';
 309                                 }
 310                                 # Set offset
 311                                 if ( !empty( $this->history['offset'] ) ) {
 312                                         $revJoin .= " AND rev_timestamp $op " .
 313                                                 $this->db->addQuotes( $this->db->timestamp( $this->history['offset'] ) );
 314                                 }
 315                                 $join['revision'] = array( 'INNER JOIN', $revJoin );
 316                                 # Set query limit
 317                                 if ( !empty( $this->history['limit'] ) ) {
 318                                         $opts['LIMIT'] = intval( $this->history['limit'] );
 319                                 }
 320                         } elseif ( $this->history & WikiExporter::FULL ) {
 321                                 # Full history dumps...
 322                                 $join['revision'] = array( 'INNER JOIN', 'page_id=rev_page' );
 323                         } elseif ( $this->history & WikiExporter::CURRENT ) {
 324                                 # Latest revision dumps...
 325                                 if ( $this->list_authors && $cond != '' )  { // List authors, if so desired
 326                                         $this->do_list_authors( $cond );
 327                                 }
 328                                 $join['revision'] = array( 'INNER JOIN', 'page_id=rev_page AND page_latest=rev_id' );
 329                         } elseif ( $this->history & WikiExporter::STABLE ) {
 330                                 # "Stable" revision dumps...
 331                                 # Default JOIN, to be overridden...
 332                                 $join['revision'] = array( 'INNER JOIN', 'page_id=rev_page AND page_latest=rev_id' );
 333                                 # One, and only one hook should set this, and return false
 334                                 if ( wfRunHooks( 'WikiExporter::dumpStableQuery', array( &$tables, &$opts, &$join ) ) ) {
 335                                         wfProfileOut( __METHOD__ );
 336                                         throw new MWException( __METHOD__ . " given invalid history dump type." );
 337                                 }
 338                         } elseif ( $this->history & WikiExporter::RANGE ) {
 339                                 # Dump of revisions within a specified range
 340                                 $join['revision'] = array( 'INNER JOIN', 'page_id=rev_page' );
 341                                 $opts['ORDER BY'] = array( 'rev_page ASC', 'rev_id ASC' );
 342                         } else {
 343                                 # Uknown history specification parameter?
 344                                 wfProfileOut( __METHOD__ );
 345                                 throw new MWException( __METHOD__ . " given invalid history dump type." );
 346                         }
 347                         # Query optimization hacks
 348                         if ( $cond == '' ) {
 349                                 $opts[] = 'STRAIGHT_JOIN';
 350                                 $opts['USE INDEX']['page'] = 'PRIMARY';
 351                         }
 352                         # Build text join options
 353                         if ( $this->text != WikiExporter::STUB ) { // 1-pass
 354                                 $tables[] = 'text';
 355                                 $join['text'] = array( 'INNER JOIN', 'rev_text_id=old_id' );
 356                         }
 357
 358                         if ( $this->buffer == WikiExporter::STREAM ) {
 359                                 $prev = $this->db->bufferResults( false );
 360                         }
 361
 362                         $wrapper = null; // Assuring $wrapper is not undefined, if exception occurs early
 363                         try {
 364                                 wfRunHooks( 'ModifyExportQuery',
 365                                                 array( $this->db, &$tables, &$cond, &$opts, &$join ) );
 366
 367                                 # Do the query!
 368                                 $result = $this->db->select( $tables, '*', $cond, __METHOD__, $opts, $join );
 369                                 $wrapper = $this->db->resultObject( $result );
 370                                 # Output dump results
 371                                 $this->outputPageStream( $wrapper );
 372
 373                                 if ( $this->buffer == WikiExporter::STREAM ) {
 374                                         $this->db->bufferResults( $prev );
 375                                 }
 376                         } catch ( Exception $e ) {
 377                                 // Throwing the exception does not reliably free the resultset, and
 378                                 // would also leave the connection in unbuffered mode.
 379
 380                                 // Freeing result
 381                                 try {
 382                                         if ( $wrapper ) {
 383                                                 $wrapper->free();
 384                                         }
 385                                 } catch ( Exception $e2 ) {
 386                                         // Already in panic mode -> ignoring $e2 as $e has
 387                                         // higher priority
 388                                 }
 389
 390                                 // Putting database back in previous buffer mode
 391                                 try {
 392                                         if ( $this->buffer == WikiExporter::STREAM ) {
 393                                                 $this->db->bufferResults( $prev );
 394                                         }
 395                                 } catch ( Exception $e2 ) {
 396                                         // Already in panic mode -> ignoring $e2 as $e has
 397                                         // higher priority
 398                                 }
 399
 400                                 // Inform caller about problem
 401                                 throw $e;
 402                         }
 403                 }
 404                 wfProfileOut( __METHOD__ );
 405         }
 406
 407         /**
 408          * Runs through a query result set dumping page and revision records.
 409          * The result set should be sorted/grouped by page to avoid duplicate
 410          * page records in the output.
 411          *
 412          * Should be safe for
 413          * streaming (non-buffered) queries, as long as it was made on a
 414          * separate database connection not managed by LoadBalancer; some
 415          * blob storage types will make queries to pull source data.
 416          *
 417          * @param $resultset ResultWrapper
 418          */
 419         protected function outputPageStream( $resultset ) {
 420                 $last = null;
 421                 foreach ( $resultset as $row ) {
 422                         if ( is_null( $last ) ||
 423                                 $last->page_namespace != $row->page_namespace ||
 424                                 $last->page_title     != $row->page_title ) {
 425                                 if ( isset( $last ) ) {
 426                                         $output = '';
 427                                         if ( $this->dumpUploads ) {
 428                                                 $output .= $this->writer->writeUploads( $last, $this->dumpUploadFileContents );
 429                                         }
 430                                         $output .= $this->writer->closePage();
 431                                         $this->sink->writeClosePage( $output );
 432                                 }
 433                                 $output = $this->writer->openPage( $row );
 434                                 $this->sink->writeOpenPage( $row, $output );
 435                                 $last = $row;
 436                         }
 437                         $output = $this->writer->writeRevision( $row );
 438                         $this->sink->writeRevision( $row, $output );
 439                 }
 440                 if ( isset( $last ) ) {
 441                         $output = '';
 442                         if ( $this->dumpUploads ) {
 443                                 $output .= $this->writer->writeUploads( $last, $this->dumpUploadFileContents );
 444                         }
 445                         $output .= $this->author_list;
 446                         $output .= $this->writer->closePage();
 447                         $this->sink->writeClosePage( $output );
 448                 }
 449         }
 450
 451         /**
 452          * @param $resultset array
 453          */
 454         protected function outputLogStream( $resultset ) {
 455                 foreach ( $resultset as $row ) {
 456                         $output = $this->writer->writeLogItem( $row );
 457                         $this->sink->writeLogItem( $row, $output );
 458                 }
 459         }
 460 }
 461
 462 /**
 463  * @ingroup Dump
 464  */
 465 class XmlDumpWriter {
 466         /**
 467          * Returns the export schema version.
 468          * @return string
 469          */
 470         function schemaVersion() {
 471                 return "0.7";
 472         }
 473
 474         /**
 475          * Opens the XML output stream's root <mediawiki> element.
 476          * This does not include an xml directive, so is safe to include
 477          * as a subelement in a larger XML stream. Namespace and XML Schema
 478          * references are included.
 479          *
 480          * Output will be encoded in UTF-8.
 481          *
 482          * @return string
 483          */
 484         function openStream() {
 485                 global $wgLanguageCode;
 486                 $ver = $this->schemaVersion();
 487                 return Xml::element( 'mediawiki', array(
 488                         'xmlns'              => "http://www.mediawiki.org/xml/export-$ver/",
 489                         'xmlns:xsi'          => "http://www.w3.org/2001/XMLSchema-instance",
 490                         'xsi:schemaLocation' => "http://www.mediawiki.org/xml/export-$ver/ " .
 491                                                 "http://www.mediawiki.org/xml/export-$ver.xsd",
 492                         'version'            => $ver,
 493                         'xml:lang'           => $wgLanguageCode ),
 494                         null ) .
 495                         "\n" .
 496                         $this->siteInfo();
 497         }
 498
 499         /**
 500          * @return string
 501          */
 502         function siteInfo() {
 503                 $info = array(
 504                         $this->sitename(),
 505                         $this->homelink(),
 506                         $this->generator(),
 507                         $this->caseSetting(),
 508                         $this->namespaces() );
 509                 return "  <siteinfo>\n    " .
 510                         implode( "\n    ", $info ) .
 511                         "\n  </siteinfo>\n";
 512         }
 513
 514         /**
 515          * @return string
 516          */
 517         function sitename() {
 518                 global $wgSitename;
 519                 return Xml::element( 'sitename', array(), $wgSitename );
 520         }
 521
 522         /**
 523          * @return string
 524          */
 525         function generator() {
 526                 global $wgVersion;
 527                 return Xml::element( 'generator', array(), "MediaWiki $wgVersion" );
 528         }
 529
 530         /**
 531          * @return string
 532          */
 533         function homelink() {
 534                 return Xml::element( 'base', array(), Title::newMainPage()->getCanonicalUrl() );
 535         }
 536
 537         /**
 538          * @return string
 539          */
 540         function caseSetting() {
 541                 global $wgCapitalLinks;
 542                 // "case-insensitive" option is reserved for future
 543                 $sensitivity = $wgCapitalLinks ? 'first-letter' : 'case-sensitive';
 544                 return Xml::element( 'case', array(), $sensitivity );
 545         }
 546
 547         /**
 548          * @return string
 549          */
 550         function namespaces() {
 551                 global $wgContLang;
 552                 $spaces = "<namespaces>\n";
 553                 foreach ( $wgContLang->getFormattedNamespaces() as $ns => $title ) {
 554                         $spaces .= '      ' .
 555                                 Xml::element( 'namespace',
 556                                         array(  'key' => $ns,
 557                                                         'case' => MWNamespace::isCapitalized( $ns ) ? 'first-letter' : 'case-sensitive',
 558                                         ), $title ) . "\n";
 559                 }
 560                 $spaces .= "    </namespaces>";
 561                 return $spaces;
 562         }
 563
 564         /**
 565          * Closes the output stream with the closing root element.
 566          * Call when finished dumping things.
 567          *
 568          * @return string
 569          */
 570         function closeStream() {
 571                 return "</mediawiki>\n";
 572         }
 573
 574         /**
 575          * Opens a <page> section on the output stream, with data
 576          * from the given database row.
 577          *
 578          * @param $row object
 579          * @return string
 580          * @access private
 581          */
 582         function openPage( $row ) {
 583                 $out = "  <page>\n";
 584                 $title = Title::makeTitle( $row->page_namespace, $row->page_title );
 585                 $out .= '    ' . Xml::elementClean( 'title', array(), self::canonicalTitle( $title ) ) . "\n";
 586                 $out .= '    ' . Xml::element( 'ns', array(), strval( $row->page_namespace) ) . "\n";
 587                 $out .= '    ' . Xml::element( 'id', array(), strval( $row->page_id ) ) . "\n";
 588                 if ( $row->page_is_redirect ) {
 589                         $page = WikiPage::factory( $title );
 590                         $redirect = $page->getRedirectTarget();
 591                         if ( $redirect instanceOf Title && $redirect->isValidRedirectTarget() ) {
 592                                 $out .= '    ' . Xml::element( 'redirect', array( 'title' => self::canonicalTitle( $redirect ) ) ) . "\n";
 593                         }
 594                 }
 595
 596                 if ( $row->page_restrictions != '' ) {
 597                         $out .= '    ' . Xml::element( 'restrictions', array(),
 598                                 strval( $row->page_restrictions ) ) . "\n";
 599                 }
 600
 601                 wfRunHooks( 'XmlDumpWriterOpenPage', array( $this, &$out, $row, $title ) );
 602
 603                 return $out;
 604         }
 605
 606         /**
 607          * Closes a <page> section on the output stream.
 608          *
 609          * @access private
 610          * @return string
 611          */
 612         function closePage() {
 613                 return "  </page>\n";
 614         }
 615
 616         /**
 617          * Dumps a <revision> section on the output stream, with
 618          * data filled in from the given database row.
 619          *
 620          * @param $row object
 621          * @return string
 622          * @access private
 623          */
 624         function writeRevision( $row ) {
 625                 wfProfileIn( __METHOD__ );
 626
 627                 $out  = "    <revision>\n";
 628                 $out .= "      " . Xml::element( 'id', null, strval( $row->rev_id ) ) . "\n";
 629                 if( $row->rev_parent_id ) {
 630                         $out .= "      " . Xml::element( 'parentid', null, strval( $row->rev_parent_id ) ) . "\n";
 631                 }
 632
 633                 $out .= $this->writeTimestamp( $row->rev_timestamp );
 634
 635                 if ( $row->rev_deleted & Revision::DELETED_USER ) {
 636                         $out .= "      " . Xml::element( 'contributor', array( 'deleted' => 'deleted' ) ) . "\n";
 637                 } else {
 638                         $out .= $this->writeContributor( $row->rev_user, $row->rev_user_text );
 639                 }
 640
 641                 if ( $row->rev_minor_edit ) {
 642                         $out .=  "      <minor/>\n";
 643                 }
 644                 if ( $row->rev_deleted & Revision::DELETED_COMMENT ) {
 645                         $out .= "      " . Xml::element( 'comment', array( 'deleted' => 'deleted' ) ) . "\n";
 646                 } elseif ( $row->rev_comment != '' ) {
 647                         $out .= "      " . Xml::elementClean( 'comment', array(), strval( $row->rev_comment ) ) . "\n";
 648                 }
 649
 650                 $text = '';
 651                 if ( $row->rev_deleted & Revision::DELETED_TEXT ) {
 652                         $out .= "      " . Xml::element( 'text', array( 'deleted' => 'deleted' ) ) . "\n";
 653                 } elseif ( isset( $row->old_text ) ) {
 654                         // Raw text from the database may have invalid chars
 655                         $text = strval( Revision::getRevisionText( $row ) );
 656                         $out .= "      " . Xml::elementClean( 'text',
 657                                 array( 'xml:space' => 'preserve', 'bytes' => intval( $row->rev_len ) ),
 658                                 strval( $text ) ) . "\n";
 659                 } else {
 660                         // Stub output
 661                         $out .= "      " . Xml::element( 'text',
 662                                 array( 'id' => $row->rev_text_id, 'bytes' => intval( $row->rev_len ) ),
 663                                 "" ) . "\n";
 664                 }
 665
 666                 if ( $row->rev_sha1 && !( $row->rev_deleted & Revision::DELETED_TEXT ) ) {
 667                         $out .= "      " . Xml::element('sha1', null, strval( $row->rev_sha1 ) ) . "\n";
 668                 } else {
 669                         $out .= "      <sha1/>\n";
 670                 }
 671
 672                 if ( isset( $row->rev_content_model ) && !is_null( $row->rev_content_model )  ) {
 673                         $content_model = intval( $row->rev_content_model );
 674                 } else {
 675                         // probably using $wgContentHandlerUseDB = false;
 676                         // @todo: test!
 677                         $title = Title::makeTitle( $row->page_namespace, $row->page_title );
 678                         $content_model = ContentHandler::getDefaultModelFor( $title );
 679                 }
 680
 681                 $name = ContentHandler::getContentModelName( $content_model );
 682                 $out .= "      " . Xml::element('model', array( 'name' => $name ), strval( $content_model ) ) . "\n";
 683
 684                 if ( isset( $row->rev_content_format ) && !is_null( $row->rev_content_format ) ) {
 685                         $content_format = intval( $row->rev_content_format );
 686                 } else {
 687                         // probably using $wgContentHandlerUseDB = false;
 688                         // @todo: test!
 689                         $content_handler = ContentHandler::getForModelID( $content_model );
 690                         $content_format = $content_handler->getDefaultFormat();
 691                 }
 692
 693                 $mime = ContentHandler::getContentFormatMimeType( $content_format );
 694                 $out .= "      " . Xml::element('format', array( 'mime' => $mime ), strval( $content_format ) ) . "\n";
 695
 696                 wfRunHooks( 'XmlDumpWriterWriteRevision', array( &$this, &$out, $row, $text ) );
 697
 698                 $out .= "    </revision>\n";
 699
 700                 wfProfileOut( __METHOD__ );
 701                 return $out;
 702         }
 703
 704         /**
 705          * Dumps a <logitem> section on the output stream, with
 706          * data filled in from the given database row.
 707          *
 708          * @param $row object
 709          * @return string
 710          * @access private
 711          */
 712         function writeLogItem( $row ) {
 713                 wfProfileIn( __METHOD__ );
 714
 715                 $out  = "  <logitem>\n";
 716                 $out .= "    " . Xml::element( 'id', null, strval( $row->log_id ) ) . "\n";
 717
 718                 $out .= $this->writeTimestamp( $row->log_timestamp, "    " );
 719
 720                 if ( $row->log_deleted & LogPage::DELETED_USER ) {
 721                         $out .= "    " . Xml::element( 'contributor', array( 'deleted' => 'deleted' ) ) . "\n";
 722                 } else {
 723                         $out .= $this->writeContributor( $row->log_user, $row->user_name, "    " );
 724                 }
 725
 726                 if ( $row->log_deleted & LogPage::DELETED_COMMENT ) {
 727                         $out .= "    " . Xml::element( 'comment', array( 'deleted' => 'deleted' ) ) . "\n";
 728                 } elseif ( $row->log_comment != '' ) {
 729                         $out .= "    " . Xml::elementClean( 'comment', null, strval( $row->log_comment ) ) . "\n";
 730                 }
 731
 732                 $out .= "    " . Xml::element( 'type', null, strval( $row->log_type ) ) . "\n";
 733                 $out .= "    " . Xml::element( 'action', null, strval( $row->log_action ) ) . "\n";
 734
 735                 if ( $row->log_deleted & LogPage::DELETED_ACTION ) {
 736                         $out .= "    " . Xml::element( 'text', array( 'deleted' => 'deleted' ) ) . "\n";
 737                 } else {
 738                         $title = Title::makeTitle( $row->log_namespace, $row->log_title );
 739                         $out .= "    " . Xml::elementClean( 'logtitle', null, self::canonicalTitle( $title ) ) . "\n";
 740                         $out .= "    " . Xml::elementClean( 'params',
 741                                 array( 'xml:space' => 'preserve' ),
 742                                 strval( $row->log_params ) ) . "\n";
 743                 }
 744
 745                 $out .= "  </logitem>\n";
 746
 747                 wfProfileOut( __METHOD__ );
 748                 return $out;
 749         }
 750
 751         /**
 752          * @param $timestamp string
 753          * @return string
 754          */
 755         function writeTimestamp( $timestamp, $indent = "      " ) {
 756                 $ts = wfTimestamp( TS_ISO_8601, $timestamp );
 757                 return $indent . Xml::element( 'timestamp', null, $ts ) . "\n";
 758         }
 759
 760         /**
 761          * @param $id
 762          * @param $text string
 763          * @return string
 764          */
 765         function writeContributor( $id, $text, $indent = "      " ) {
 766                 $out = $indent . "<contributor>\n";
 767                 if ( $id || !IP::isValid( $text ) ) {
 768                         $out .= $indent . "  " . Xml::elementClean( 'username', null, strval( $text ) ) . "\n";
 769                         $out .= $indent . "  " . Xml::element( 'id', null, strval( $id ) ) . "\n";
 770                 } else {
 771                         $out .= $indent . "  " . Xml::elementClean( 'ip', null, strval( $text ) ) . "\n";
 772                 }
 773                 $out .= $indent . "</contributor>\n";
 774                 return $out;
 775         }
 776
 777         /**
 778          * Warning! This data is potentially inconsistent. :(
 779          * @param $row
 780          * @param $dumpContents bool
 781          * @return string
 782          */
 783         function writeUploads( $row, $dumpContents = false ) {
 784                 if ( $row->page_namespace == NS_IMAGE ) {
 785                         $img = wfLocalFile( $row->page_title );
 786                         if ( $img && $img->exists() ) {
 787                                 $out = '';
 788                                 foreach ( array_reverse( $img->getHistory() ) as $ver ) {
 789                                         $out .= $this->writeUpload( $ver, $dumpContents );
 790                                 }
 791                                 $out .= $this->writeUpload( $img, $dumpContents );
 792                                 return $out;
 793                         }
 794                 }
 795                 return '';
 796         }
 797
 798         /**
 799          * @param $file File
 800          * @param $dumpContents bool
 801          * @return string
 802          */
 803         function writeUpload( $file, $dumpContents = false ) {
 804                 if ( $file->isOld() ) {
 805                         $archiveName = "      " .
 806                                 Xml::element( 'archivename', null, $file->getArchiveName() ) . "\n";
 807                 } else {
 808                         $archiveName = '';
 809                 }
 810                 if ( $dumpContents ) {
 811                         # Dump file as base64
 812                         # Uses only XML-safe characters, so does not need escaping
 813                         $contents = '      <contents encoding="base64">' .
 814                                 chunk_split( base64_encode( file_get_contents( $file->getPath() ) ) ) .
 815                                 "      </contents>\n";
 816                 } else {
 817                         $contents = '';
 818                 }
 819                 if ( $file->isDeleted( File::DELETED_COMMENT ) ) {
 820                         $comment = Xml::element( 'comment', array( 'deleted' => 'deleted' ) );
 821                 } else {
 822                         $comment = Xml::elementClean( 'comment', null, $file->getDescription() );
 823                 }
 824                 return "    <upload>\n" .
 825                         $this->writeTimestamp( $file->getTimestamp() ) .
 826                         $this->writeContributor( $file->getUser( 'id' ), $file->getUser( 'text' ) ) .
 827                         "      " . $comment . "\n" .
 828                         "      " . Xml::element( 'filename', null, $file->getName() ) . "\n" .
 829                         $archiveName .
 830                         "      " . Xml::element( 'src', null, $file->getCanonicalUrl() ) . "\n" .
 831                         "      " . Xml::element( 'size', null, $file->getSize() ) . "\n" .
 832                         "      " . Xml::element( 'sha1base36', null, $file->getSha1() ) . "\n" .
 833                         "      " . Xml::element( 'rel', null, $file->getRel() ) . "\n" .
 834                         $contents .
 835                         "    </upload>\n";
 836         }
 837
 838         /**
 839          * Return prefixed text form of title, but using the content language's
 840          * canonical namespace. This skips any special-casing such as gendered
 841          * user namespaces -- which while useful, are not yet listed in the
 842          * XML <siteinfo> data so are unsafe in export.
 843          *
 844          * @param Title $title
 845          * @return string
 846          * @since 1.18
 847          */
 848         public static function canonicalTitle( Title $title ) {
 849                 if ( $title->getInterwiki() ) {
 850                         return $title->getPrefixedText();
 851                 }
 852
 853                 global $wgContLang;
 854                 $prefix = str_replace( '_', ' ', $wgContLang->getNsText( $title->getNamespace() ) );
 855
 856                 if ( $prefix !== '' ) {
 857                         $prefix .= ':';
 858                 }
 859
 860                 return $prefix . $title->getText();
 861         }
 862 }
 863
 864
 865 /**
 866  * Base class for output stream; prints to stdout or buffer or whereever.
 867  * @ingroup Dump
 868  */
 869 class DumpOutput {
 870
 871         /**
 872          * @param $string string
 873          */
 874         function writeOpenStream( $string ) {
 875                 $this->write( $string );
 876         }
 877
 878         /**
 879          * @param $string string
 880          */
 881         function writeCloseStream( $string ) {
 882                 $this->write( $string );
 883         }
 884
 885         /**
 886          * @param $page
 887          * @param $string string
 888          */
 889         function writeOpenPage( $page, $string ) {
 890                 $this->write( $string );
 891         }
 892
 893         /**
 894          * @param $string string
 895          */
 896         function writeClosePage( $string ) {
 897                 $this->write( $string );
 898         }
 899
 900         /**
 901          * @param $rev
 902          * @param $string string
 903          */
 904         function writeRevision( $rev, $string ) {
 905                 $this->write( $string );
 906         }
 907
 908         /**
 909          * @param $rev
 910          * @param $string string
 911          */
 912         function writeLogItem( $rev, $string ) {
 913                 $this->write( $string );
 914         }
 915
 916         /**
 917          * Override to write to a different stream type.
 918          * @param $string string
 919          * @return bool
 920          */
 921         function write( $string ) {
 922                 print $string;
 923         }
 924
 925         /**
 926          * Close the old file, move it to a specified name,
 927          * and reopen new file with the old name. Use this
 928          * for writing out a file in multiple pieces
 929          * at specified checkpoints (e.g. every n hours).
 930          * @param $newname mixed File name. May be a string or an array with one element
 931          */
 932         function closeRenameAndReopen( $newname ) {
 933                 return;
 934         }
 935
 936         /**
 937          * Close the old file, and move it to a specified name.
 938          * Use this for the last piece of a file written out
 939          * at specified checkpoints (e.g. every n hours).
 940          * @param $newname mixed File name. May be a string or an array with one element
 941          * @param $open bool If true, a new file with the old filename will be opened again for writing (default: false)
 942          */
 943         function closeAndRename( $newname, $open = false ) {
 944                 return;
 945         }
 946
 947         /**
 948          * Returns the name of the file or files which are
 949          * being written to, if there are any.
 950          * @return null
 951          */
 952         function getFilenames() {
 953                 return NULL;
 954         }
 955 }
 956
 957 /**
 958  * Stream outputter to send data to a file.
 959  * @ingroup Dump
 960  */
 961 class DumpFileOutput extends DumpOutput {
 962         protected $handle = false, $filename;
 963
 964         /**
 965          * @param $file
 966          */
 967         function __construct( $file ) {
 968                 $this->handle = fopen( $file, "wt" );
 969                 $this->filename = $file;
 970         }
 971
 972         /**
 973          * @param $string string
 974          */
 975         function writeCloseStream( $string ) {
 976                 parent::writeCloseStream( $string );
 977                 if ( $this->handle ) {
 978                         fclose( $this->handle );
 979                         $this->handle = false;
 980                 }
 981         }
 982
 983         /**
 984          * @param $string string
 985          */
 986         function write( $string ) {
 987                 fputs( $this->handle, $string );
 988         }
 989
 990         /**
 991          * @param $newname
 992          */
 993         function closeRenameAndReopen( $newname ) {
 994                 $this->closeAndRename( $newname, true );
 995         }
 996
 997         /**
 998          * @param $newname
 999          * @throws MWException
1000          */
1001         function renameOrException( $newname ) {
1002                         if (! rename( $this->filename, $newname ) ) {
1003                                 throw new MWException( __METHOD__ . ": rename of file {$this->filename} to $newname failed\n" );
1004                         }
1005         }
1006
1007         /**
1008          * @param $newname array
1009          * @return mixed
1010          * @throws MWException
1011          */
1012         function checkRenameArgCount( $newname ) {
1013                 if ( is_array( $newname ) ) {
1014                         if ( count( $newname ) > 1 ) {
1015                                 throw new MWException( __METHOD__ . ": passed multiple arguments for rename of single file\n" );
1016                         } else {
1017                                 $newname = $newname[0];
1018                         }
1019                 }
1020                 return $newname;
1021         }
1022
1023         /**
1024          * @param $newname mixed
1025          * @param $open bool
1026          */
1027         function closeAndRename( $newname, $open = false ) {
1028                 $newname = $this->checkRenameArgCount( $newname );
1029                 if ( $newname ) {
1030                         if ( $this->handle ) {
1031                                 fclose( $this->handle );
1032                                 $this->handle = false;
1033                         }
1034                         $this->renameOrException( $newname );
1035                         if ( $open ) {
1036                                 $this->handle = fopen( $this->filename, "wt" );
1037                         }
1038                 }
1039         }
1040
1041         /**
1042          * @return string|null
1043          */
1044         function getFilenames() {
1045                 return $this->filename;
1046         }
1047 }
1048
1049 /**
1050  * Stream outputter to send data to a file via some filter program.
1051  * Even if compression is available in a library, using a separate
1052  * program can allow us to make use of a multi-processor system.
1053  * @ingroup Dump
1054  */
1055 class DumpPipeOutput extends DumpFileOutput {
1056         protected $command, $filename;
1057         protected $procOpenResource = false;
1058
1059         /**
1060          * @param $command
1061          * @param $file null
1062          */
1063         function __construct( $command, $file = null ) {
1064                 if ( !is_null( $file ) ) {
1065                         $command .=  " > " . wfEscapeShellArg( $file );
1066                 }
1067
1068                 $this->startCommand( $command );
1069                 $this->command = $command;
1070                 $this->filename = $file;
1071         }
1072
1073         /**
1074          * @param $string string
1075          */
1076         function writeCloseStream( $string ) {
1077                 parent::writeCloseStream( $string );
1078                 if ( $this->procOpenResource ) {
1079                         proc_close( $this->procOpenResource );
1080                         $this->procOpenResource = false;
1081                 }
1082         }
1083
1084         /**
1085          * @param $command
1086          */
1087         function startCommand( $command ) {
1088                 $spec = array(
1089                         0 => array( "pipe", "r" ),
1090                 );
1091                 $pipes = array();
1092                 $this->procOpenResource = proc_open( $command, $spec, $pipes );
1093                 $this->handle = $pipes[0];
1094         }
1095
1096         /**
1097          * @param mixed $newname
1098          */
1099         function closeRenameAndReopen( $newname ) {
1100                 $this->closeAndRename( $newname, true );
1101         }
1102
1103         /**
1104          * @param $newname mixed
1105          * @param $open bool
1106          */
1107         function closeAndRename( $newname, $open = false ) {
1108                 $newname = $this->checkRenameArgCount( $newname );
1109                 if ( $newname ) {
1110                         if ( $this->handle ) {
1111                                 fclose( $this->handle );
1112                                 $this->handle = false;
1113                         }
1114                         if ( $this->procOpenResource ) {
1115                                 proc_close( $this->procOpenResource );
1116                                 $this->procOpenResource = false;
1117                         }
1118                         $this->renameOrException( $newname );
1119                         if ( $open ) {
1120                                 $command = $this->command;
1121                                 $command .=  " > " . wfEscapeShellArg( $this->filename );
1122                                 $this->startCommand( $command );
1123                         }
1124                 }
1125         }
1126
1127 }
1128
1129 /**
1130  * Sends dump output via the gzip compressor.
1131  * @ingroup Dump
1132  */
1133 class DumpGZipOutput extends DumpPipeOutput {
1134
1135         /**
1136          * @param $file string
1137          */
1138         function __construct( $file ) {
1139                 parent::__construct( "gzip", $file );
1140         }
1141 }
1142
1143 /**
1144  * Sends dump output via the bgzip2 compressor.
1145  * @ingroup Dump
1146  */
1147 class DumpBZip2Output extends DumpPipeOutput {
1148
1149         /**
1150          * @param $file string
1151          */
1152         function __construct( $file ) {
1153                 parent::__construct( "bzip2", $file );
1154         }
1155 }
1156
1157 /**
1158  * Sends dump output via the p7zip compressor.
1159  * @ingroup Dump
1160  */
1161 class Dump7ZipOutput extends DumpPipeOutput {
1162
1163         /**
1164          * @param $file string
1165          */
1166         function __construct( $file ) {
1167                 $command = $this->setup7zCommand( $file );
1168                 parent::__construct( $command );
1169                 $this->filename = $file;
1170         }
1171
1172         /**
1173          * @param $file string
1174          * @return string
1175          */
1176         function setup7zCommand( $file ) {
1177                 $command = "7za a -bd -si " . wfEscapeShellArg( $file );
1178                 // Suppress annoying useless crap from p7zip
1179                 // Unfortunately this could suppress real error messages too
1180                 $command .= ' >' . wfGetNull() . ' 2>&1';
1181                 return( $command );
1182         }
1183
1184         /**
1185          * @param $newname string
1186          * @param $open bool
1187          */
1188         function closeAndRename( $newname, $open = false ) {
1189                 $newname = $this->checkRenameArgCount( $newname );
1190                 if ( $newname ) {
1191                         fclose( $this->handle );
1192                         proc_close( $this->procOpenResource );
1193                         $this->renameOrException( $newname );
1194                         if ( $open ) {
1195                                 $command = $this->setup7zCommand( $this->filename );
1196                                 $this->startCommand( $command );
1197                         }
1198                 }
1199         }
1200 }
1201
1202 /**
1203  * Dump output filter class.
1204  * This just does output filtering and streaming; XML formatting is done
1205  * higher up, so be careful in what you do.
1206  * @ingroup Dump
1207  */
1208 class DumpFilter {
1209
1210         /**
1211          * @var DumpOutput
1212          * FIXME will need to be made protected whenever legacy code
1213          * is updated.
1214          */
1215         public $sink;
1216
1217         /**
1218          * @var bool
1219          */
1220         protected $sendingThisPage;
1221
1222         /**
1223          * @param $sink DumpOutput
1224          */
1225         function __construct( &$sink ) {
1226                 $this->sink =& $sink;
1227         }
1228
1229         /**
1230          * @param $string string
1231          */
1232         function writeOpenStream( $string ) {
1233                 $this->sink->writeOpenStream( $string );
1234         }
1235
1236         /**
1237          * @param $string string
1238          */
1239         function writeCloseStream( $string ) {
1240                 $this->sink->writeCloseStream( $string );
1241         }
1242
1243         /**
1244          * @param $page
1245          * @param $string string
1246          */
1247         function writeOpenPage( $page, $string ) {
1248                 $this->sendingThisPage = $this->pass( $page, $string );
1249                 if ( $this->sendingThisPage ) {
1250                         $this->sink->writeOpenPage( $page, $string );
1251                 }
1252         }
1253
1254         /**
1255          * @param $string string
1256          */
1257         function writeClosePage( $string ) {
1258                 if ( $this->sendingThisPage ) {
1259                         $this->sink->writeClosePage( $string );
1260                         $this->sendingThisPage = false;
1261                 }
1262         }
1263
1264         /**
1265          * @param $rev
1266          * @param $string string
1267          */
1268         function writeRevision( $rev, $string ) {
1269                 if ( $this->sendingThisPage ) {
1270                         $this->sink->writeRevision( $rev, $string );
1271                 }
1272         }
1273
1274         /**
1275          * @param $rev
1276          * @param $string string
1277          */
1278         function writeLogItem( $rev, $string ) {
1279                 $this->sink->writeRevision( $rev, $string );
1280         }
1281
1282         /**
1283          * @param $newname string
1284          */
1285         function closeRenameAndReopen( $newname ) {
1286                 $this->sink->closeRenameAndReopen( $newname );
1287         }
1288
1289         /**
1290          * @param $newname string
1291          * @param $open bool
1292          */
1293         function closeAndRename( $newname, $open = false ) {
1294                 $this->sink->closeAndRename( $newname, $open );
1295         }
1296
1297         /**
1298          * @return array
1299          */
1300         function getFilenames() {
1301                 return $this->sink->getFilenames();
1302         }
1303
1304         /**
1305          * Override for page-based filter types.
1306          * @param $page
1307          * @return bool
1308          */
1309         function pass( $page ) {
1310                 return true;
1311         }
1312 }
1313
1314 /**
1315  * Simple dump output filter to exclude all talk pages.
1316  * @ingroup Dump
1317  */
1318 class DumpNotalkFilter extends DumpFilter {
1319
1320         /**
1321          * @param $page
1322          * @return bool
1323          */
1324         function pass( $page ) {
1325                 return !MWNamespace::isTalk( $page->page_namespace );
1326         }
1327 }
1328
1329 /**
1330  * Dump output filter to include or exclude pages in a given set of namespaces.
1331  * @ingroup Dump
1332  */
1333 class DumpNamespaceFilter extends DumpFilter {
1334         var $invert = false;
1335         var $namespaces = array();
1336
1337         /**
1338          * @param $sink DumpOutput
1339          * @param $param
1340          */
1341         function __construct( &$sink, $param ) {
1342                 parent::__construct( $sink );
1343
1344                 $constants = array(
1345                         "NS_MAIN"           => NS_MAIN,
1346                         "NS_TALK"           => NS_TALK,
1347                         "NS_USER"           => NS_USER,
1348                         "NS_USER_TALK"      => NS_USER_TALK,
1349                         "NS_PROJECT"        => NS_PROJECT,
1350                         "NS_PROJECT_TALK"   => NS_PROJECT_TALK,
1351                         "NS_FILE"           => NS_FILE,
1352                         "NS_FILE_TALK"      => NS_FILE_TALK,
1353                         "NS_IMAGE"          => NS_IMAGE,  // NS_IMAGE is an alias for NS_FILE
1354                         "NS_IMAGE_TALK"     => NS_IMAGE_TALK,
1355                         "NS_MEDIAWIKI"      => NS_MEDIAWIKI,
1356                         "NS_MEDIAWIKI_TALK" => NS_MEDIAWIKI_TALK,
1357                         "NS_TEMPLATE"       => NS_TEMPLATE,
1358                         "NS_TEMPLATE_TALK"  => NS_TEMPLATE_TALK,
1359                         "NS_HELP"           => NS_HELP,
1360                         "NS_HELP_TALK"      => NS_HELP_TALK,
1361                         "NS_CATEGORY"       => NS_CATEGORY,
1362                         "NS_CATEGORY_TALK"  => NS_CATEGORY_TALK );
1363
1364                 if ( $param { 0 } == '!' ) {
1365                         $this->invert = true;
1366                         $param = substr( $param, 1 );
1367                 }
1368
1369                 foreach ( explode( ',', $param ) as $key ) {
1370                         $key = trim( $key );
1371                         if ( isset( $constants[$key] ) ) {
1372                                 $ns = $constants[$key];
1373                                 $this->namespaces[$ns] = true;
1374                         } elseif ( is_numeric( $key ) ) {
1375                                 $ns = intval( $key );
1376                                 $this->namespaces[$ns] = true;
1377                         } else {
1378                                 throw new MWException( "Unrecognized namespace key '$key'\n" );
1379                         }
1380                 }
1381         }
1382
1383         /**
1384          * @param $page
1385          * @return bool
1386          */
1387         function pass( $page ) {
1388                 $match = isset( $this->namespaces[$page->page_namespace] );
1389                 return $this->invert xor $match;
1390         }
1391 }
1392
1393
1394 /**
1395  * Dump output filter to include only the last revision in each page sequence.
1396  * @ingroup Dump
1397  */
1398 class DumpLatestFilter extends DumpFilter {
1399         var $page, $pageString, $rev, $revString;
1400
1401         /**
1402          * @param $page
1403          * @param $string string
1404          */
1405         function writeOpenPage( $page, $string ) {
1406                 $this->page = $page;
1407                 $this->pageString = $string;
1408         }
1409
1410         /**
1411          * @param $string string
1412          */
1413         function writeClosePage( $string ) {
1414                 if ( $this->rev ) {
1415                         $this->sink->writeOpenPage( $this->page, $this->pageString );
1416                         $this->sink->writeRevision( $this->rev, $this->revString );
1417                         $this->sink->writeClosePage( $string );
1418                 }
1419                 $this->rev = null;
1420                 $this->revString = null;
1421                 $this->page = null;
1422                 $this->pageString = null;
1423         }
1424
1425         /**
1426          * @param $rev
1427          * @param $string string
1428          */
1429         function writeRevision( $rev, $string ) {
1430                 if ( $rev->rev_id == $this->page->page_latest ) {
1431                         $this->rev = $rev;
1432                         $this->revString = $string;
1433                 }
1434         }
1435 }
1436
1437 /**
1438  * Base class for output stream; prints to stdout or buffer or whereever.
1439  * @ingroup Dump
1440  */
1441 class DumpMultiWriter {
1442
1443         /**
1444          * @param $sinks
1445          */
1446         function __construct( $sinks ) {
1447                 $this->sinks = $sinks;
1448                 $this->count = count( $sinks );
1449         }
1450
1451         /**
1452          * @param $string string
1453          */
1454         function writeOpenStream( $string ) {
1455                 for ( $i = 0; $i < $this->count; $i++ ) {
1456                         $this->sinks[$i]->writeOpenStream( $string );
1457                 }
1458         }
1459
1460         /**
1461          * @param $string string
1462          */
1463         function writeCloseStream( $string ) {
1464                 for ( $i = 0; $i < $this->count; $i++ ) {
1465                         $this->sinks[$i]->writeCloseStream( $string );
1466                 }
1467         }
1468
1469         /**
1470          * @param $page
1471          * @param $string string
1472          */
1473         function writeOpenPage( $page, $string ) {
1474                 for ( $i = 0; $i < $this->count; $i++ ) {
1475                         $this->sinks[$i]->writeOpenPage( $page, $string );
1476                 }
1477         }
1478
1479         /**
1480          * @param $string
1481          */
1482         function writeClosePage( $string ) {
1483                 for ( $i = 0; $i < $this->count; $i++ ) {
1484                         $this->sinks[$i]->writeClosePage( $string );
1485                 }
1486         }
1487
1488         /**
1489          * @param $rev
1490          * @param $string
1491          */
1492         function writeRevision( $rev, $string ) {
1493                 for ( $i = 0; $i < $this->count; $i++ ) {
1494                         $this->sinks[$i]->writeRevision( $rev, $string );
1495                 }
1496         }
1497
1498         /**
1499          * @param $newnames
1500          */
1501         function closeRenameAndReopen( $newnames ) {
1502                 $this->closeAndRename( $newnames, true );
1503         }
1504
1505         /**
1506          * @param $newnames array
1507          * @param bool $open
1508          */
1509         function closeAndRename( $newnames, $open = false ) {
1510                 for ( $i = 0; $i < $this->count; $i++ ) {
1511                         $this->sinks[$i]->closeAndRename( $newnames[$i], $open );
1512                 }
1513         }
1514
1515         /**
1516          * @return array
1517          */
1518         function getFilenames() {
1519                 $filenames = array();
1520                 for ( $i = 0; $i < $this->count; $i++ ) {
1521                         $filenames[] =  $this->sinks[$i]->getFilenames();
1522                 }
1523                 return $filenames;
1524         }
1525
1526 }
1527
1528 /**
1529  * @param $string string
1530  * @return string
1531  */
1532 function xmlsafe( $string ) {
1533         wfProfileIn( __FUNCTION__ );
1534
1535         /**
1536          * The page may contain old data which has not been properly normalized.
1537          * Invalid UTF-8 sequences or forbidden control characters will make our
1538          * XML output invalid, so be sure to strip them out.
1539          */
1540         $string = UtfNormal::cleanUp( $string );
1541
1542         $string = htmlspecialchars( $string );
1543         wfProfileOut( __FUNCTION__ );
1544         return $string;
1545 }