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