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         /**
  53          * If using WikiExporter::STREAM to stream a large amount of data,
  54          * provide a database connection which is not managed by
  55          * LoadBalancer to read from: some history blob types will
  56          * make additional queries to pull source data while the
  57          * main query is still running.
  58          *
  59          * @param $db Database
  60          * @param $history Mixed: one of WikiExporter::FULL, WikiExporter::CURRENT,
  61          *                 WikiExporter::RANGE or WikiExporter::STABLE,
  62          *                 or an associative array:
  63          *                   offset: non-inclusive offset at which to start the query
  64          *                   limit: maximum number of rows to return
  65          *                   dir: "asc" or "desc" timestamp order
  66          * @param $buffer Int: one of WikiExporter::BUFFER or WikiExporter::STREAM
  67          * @param $text Int: one of WikiExporter::TEXT or WikiExporter::STUB
  68          */
  69         function __construct( &$db, $history = WikiExporter::CURRENT,
  70                         $buffer = WikiExporter::BUFFER, $text = WikiExporter::TEXT ) {
  71                 $this->db =& $db;
  72                 $this->history = $history;
  73                 $this->buffer  = $buffer;
  74                 $this->writer  = new XmlDumpWriter();
  75                 $this->sink    = new DumpOutput();
  76                 $this->text    = $text;
  77         }
  78
  79         /**
  80          * Set the DumpOutput or DumpFilter object which will receive
  81          * various row objects and XML output for filtering. Filters
  82          * can be chained or used as callbacks.
  83          *
  84          * @param $sink mixed
  85          */
  86         public function setOutputSink( &$sink ) {
  87                 $this->sink =& $sink;
  88         }
  89
  90         public function openStream() {
  91                 $output = $this->writer->openStream();
  92                 $this->sink->writeOpenStream( $output );
  93         }
  94
  95         public function closeStream() {
  96                 $output = $this->writer->closeStream();
  97                 $this->sink->writeCloseStream( $output );
  98         }
  99
 100         /**
 101          * Dumps a series of page and revision records for all pages
 102          * in the database, either including complete history or only
 103          * the most recent version.
 104          */
 105         public function allPages() {
 106                 return $this->dumpFrom( '' );
 107         }
 108
 109         /**
 110          * Dumps a series of page and revision records for those pages
 111          * in the database falling within the page_id range given.
 112          * @param $start Int: inclusive lower limit (this id is included)
 113          * @param $end   Int: Exclusive upper limit (this id is not included)
 114          *                   If 0, no upper limit.
 115          */
 116         public function pagesByRange( $start, $end ) {
 117                 $condition = 'page_id >= ' . intval( $start );
 118                 if ( $end ) {
 119                         $condition .= ' AND page_id < ' . intval( $end );
 120                 }
 121                 return $this->dumpFrom( $condition );
 122         }
 123
 124         /**
 125          * Dumps a series of page and revision records for those pages
 126          * in the database with revisions falling within the rev_id range given.
 127          * @param $start Int: inclusive lower limit (this id is included)
 128          * @param $end   Int: Exclusive upper limit (this id is not included)
 129          *                   If 0, no upper limit.
 130          */
 131         public function revsByRange( $start, $end ) {
 132                 $condition = 'rev_id >= ' . intval( $start );
 133                 if ( $end ) {
 134                         $condition .= ' AND rev_id < ' . intval( $end );
 135                 }
 136                 return $this->dumpFrom( $condition );
 137         }
 138
 139         /**
 140          * @param $title Title
 141          */
 142         public function pageByTitle( $title ) {
 143                 return $this->dumpFrom(
 144                         'page_namespace=' . $title->getNamespace() .
 145                         ' AND page_title=' . $this->db->addQuotes( $title->getDBkey() ) );
 146         }
 147
 148         public function pageByName( $name ) {
 149                 $title = Title::newFromText( $name );
 150                 if ( is_null( $title ) ) {
 151                         throw new MWException( "Can't export invalid title" );
 152                 } else {
 153                         return $this->pageByTitle( $title );
 154                 }
 155         }
 156
 157         public function pagesByName( $names ) {
 158                 foreach ( $names as $name ) {
 159                         $this->pageByName( $name );
 160                 }
 161         }
 162
 163         public function allLogs() {
 164                 return $this->dumpFrom( '' );
 165         }
 166
 167         public function logsByRange( $start, $end ) {
 168                 $condition = 'log_id >= ' . intval( $start );
 169                 if ( $end ) {
 170                         $condition .= ' AND log_id < ' . intval( $end );
 171                 }
 172                 return $this->dumpFrom( $condition );
 173         }
 174
 175         # Generates the distinct list of authors of an article
 176         # Not called by default (depends on $this->list_authors)
 177         # Can be set by Special:Export when not exporting whole history
 178         protected function do_list_authors( $cond ) {
 179                 wfProfileIn( __METHOD__ );
 180                 $this->author_list = "<contributors>";
 181                 // rev_deleted
 182
 183                 $res = $this->db->select(
 184                         array( 'page', 'revision' ),
 185                         array( 'DISTINCT rev_user_text', 'rev_user' ),
 186                         array(
 187                                 $this->db->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0',
 188                                 $cond,
 189                                 'page_id = rev_id',
 190                         ),
 191                         __METHOD__
 192                 );
 193
 194                 foreach ( $res as $row ) {
 195                         $this->author_list .= "<contributor>" .
 196                                 "<username>" .
 197                                 htmlentities( $row->rev_user_text )  .
 198                                 "</username>" .
 199                                 "<id>" .
 200                                 $row->rev_user .
 201                                 "</id>" .
 202                                 "</contributor>";
 203                 }
 204                 $this->author_list .= "</contributors>";
 205                 wfProfileOut( __METHOD__ );
 206         }
 207
 208         protected function dumpFrom( $cond = '' ) {
 209                 wfProfileIn( __METHOD__ );
 210                 # For logging dumps...
 211                 if ( $this->history & self::LOGS ) {
 212                         if ( $this->buffer == WikiExporter::STREAM ) {
 213                                 $prev = $this->db->bufferResults( false );
 214                         }
 215                         $where = array( 'user_id = log_user' );
 216                         # Hide private logs
 217                         $hideLogs = LogEventsList::getExcludeClause( $this->db );
 218                         if ( $hideLogs ) $where[] = $hideLogs;
 219                         # Add on any caller specified conditions
 220                         if ( $cond ) $where[] = $cond;
 221                         # Get logging table name for logging.* clause
 222                         $logging = $this->db->tableName( 'logging' );
 223                         $result = $this->db->select( array( 'logging', 'user' ),
 224                                 array( "{$logging}.*", 'user_name' ), // grab the user name
 225                                 $where,
 226                                 __METHOD__,
 227                                 array( 'ORDER BY' => 'log_id', 'USE INDEX' => array( 'logging' => 'PRIMARY' ) )
 228                         );
 229                         $wrapper = $this->db->resultObject( $result );
 230                         $this->outputLogStream( $wrapper );
 231                         if ( $this->buffer == WikiExporter::STREAM ) {
 232                                 $this->db->bufferResults( $prev );
 233                         }
 234                 # For page dumps...
 235                 } else {
 236                         $tables = array( 'page', 'revision' );
 237                         $opts = array( 'ORDER BY' => 'page_id ASC' );
 238                         $opts['USE INDEX'] = array();
 239                         $join = array();
 240                         if ( is_array( $this->history ) ) {
 241                                 # Time offset/limit for all pages/history...
 242                                 $revJoin = 'page_id=rev_page';
 243                                 # Set time order
 244                                 if ( $this->history['dir'] == 'asc' ) {
 245                                         $op = '>';
 246                                         $opts['ORDER BY'] = 'rev_timestamp ASC';
 247                                 } else {
 248                                         $op = '<';
 249                                         $opts['ORDER BY'] = 'rev_timestamp DESC';
 250                                 }
 251                                 # Set offset
 252                                 if ( !empty( $this->history['offset'] ) ) {
 253                                         $revJoin .= " AND rev_timestamp $op " .
 254                                                 $this->db->addQuotes( $this->db->timestamp( $this->history['offset'] ) );
 255                                 }
 256                                 $join['revision'] = array( 'INNER JOIN', $revJoin );
 257                                 # Set query limit
 258                                 if ( !empty( $this->history['limit'] ) ) {
 259                                         $opts['LIMIT'] = intval( $this->history['limit'] );
 260                                 }
 261                         } elseif ( $this->history & WikiExporter::FULL ) {
 262                                 # Full history dumps...
 263                                 $join['revision'] = array( 'INNER JOIN', 'page_id=rev_page' );
 264                         } elseif ( $this->history & WikiExporter::CURRENT ) {
 265                                 # Latest revision dumps...
 266                                 if ( $this->list_authors && $cond != '' )  { // List authors, if so desired
 267                                         $this->do_list_authors( $cond );
 268                                 }
 269                                 $join['revision'] = array( 'INNER JOIN', 'page_id=rev_page AND page_latest=rev_id' );
 270                         } elseif ( $this->history & WikiExporter::STABLE ) {
 271                                 # "Stable" revision dumps...
 272                                 # Default JOIN, to be overridden...
 273                                 $join['revision'] = array( 'INNER JOIN', 'page_id=rev_page AND page_latest=rev_id' );
 274                                 # One, and only one hook should set this, and return false
 275                                 if ( wfRunHooks( 'WikiExporter::dumpStableQuery', array( &$tables, &$opts, &$join ) ) ) {
 276                                         wfProfileOut( __METHOD__ );
 277                                         throw new MWException( __METHOD__ . " given invalid history dump type." );
 278                                 }
 279                         } elseif ( $this->history & WikiExporter::RANGE ) {
 280                                 # Dump of revisions within a specified range
 281                                 $join['revision'] = array( 'INNER JOIN', 'page_id=rev_page' );
 282                                 $opts['ORDER BY'] = 'rev_page ASC, rev_id ASC';
 283                         } else {
 284                                 # Uknown history specification parameter?
 285                                 wfProfileOut( __METHOD__ );
 286                                 throw new MWException( __METHOD__ . " given invalid history dump type." );
 287                         }
 288                         # Query optimization hacks
 289                         if ( $cond == '' ) {
 290                                 $opts[] = 'STRAIGHT_JOIN';
 291                                 $opts['USE INDEX']['page'] = 'PRIMARY';
 292                         }
 293                         # Build text join options
 294                         if ( $this->text != WikiExporter::STUB ) { // 1-pass
 295                                 $tables[] = 'text';
 296                                 $join['text'] = array( 'INNER JOIN', 'rev_text_id=old_id' );
 297                         }
 298
 299                         if ( $this->buffer == WikiExporter::STREAM ) {
 300                                 $prev = $this->db->bufferResults( false );
 301                         }
 302
 303                         wfRunHooks( 'ModifyExportQuery',
 304                                                 array( $this->db, &$tables, &$cond, &$opts, &$join ) );
 305
 306                         # Do the query!
 307                         $result = $this->db->select( $tables, '*', $cond, __METHOD__, $opts, $join );
 308                         $wrapper = $this->db->resultObject( $result );
 309                         # Output dump results
 310                         $this->outputPageStream( $wrapper );
 311                         if ( $this->list_authors ) {
 312                                 $this->outputPageStream( $wrapper );
 313                         }
 314
 315                         if ( $this->buffer == WikiExporter::STREAM ) {
 316                                 $this->db->bufferResults( $prev );
 317                         }
 318                 }
 319                 wfProfileOut( __METHOD__ );
 320         }
 321
 322         /**
 323          * Runs through a query result set dumping page and revision records.
 324          * The result set should be sorted/grouped by page to avoid duplicate
 325          * page records in the output.
 326          *
 327          * The result set will be freed once complete. Should be safe for
 328          * streaming (non-buffered) queries, as long as it was made on a
 329          * separate database connection not managed by LoadBalancer; some
 330          * blob storage types will make queries to pull source data.
 331          *
 332          * @param $resultset ResultWrapper
 333          */
 334         protected function outputPageStream( $resultset ) {
 335                 $last = null;
 336                 foreach ( $resultset as $row ) {
 337                         if ( is_null( $last ) ||
 338                                 $last->page_namespace != $row->page_namespace ||
 339                                 $last->page_title     != $row->page_title ) {
 340                                 if ( isset( $last ) ) {
 341                                         $output = '';
 342                                         if ( $this->dumpUploads ) {
 343                                                 $output .= $this->writer->writeUploads( $last, $this->dumpUploadFileContents );
 344                                         }
 345                                         $output .= $this->writer->closePage();
 346                                         $this->sink->writeClosePage( $output );
 347                                 }
 348                                 $output = $this->writer->openPage( $row );
 349                                 $this->sink->writeOpenPage( $row, $output );
 350                                 $last = $row;
 351                         }
 352                         $output = $this->writer->writeRevision( $row );
 353                         $this->sink->writeRevision( $row, $output );
 354                 }
 355                 if ( isset( $last ) ) {
 356                         $output = '';
 357                         if ( $this->dumpUploads ) {
 358                                 $output .= $this->writer->writeUploads( $last, $this->dumpUploadFileContents );
 359                         }
 360                         $output .= $this->author_list;
 361                         $output .= $this->writer->closePage();
 362                         $this->sink->writeClosePage( $output );
 363                 }
 364         }
 365
 366         protected function outputLogStream( $resultset ) {
 367                 foreach ( $resultset as $row ) {
 368                         $output = $this->writer->writeLogItem( $row );
 369                         $this->sink->writeLogItem( $row, $output );
 370                 }
 371         }
 372 }
 373
 374 /**
 375  * @ingroup Dump
 376  */
 377 class XmlDumpWriter {
 378         /**
 379          * Returns the export schema version.
 380          * @return string
 381          */
 382         function schemaVersion() {
 383                 return "0.6";
 384         }
 385
 386         /**
 387          * Opens the XML output stream's root <mediawiki> element.
 388          * This does not include an xml directive, so is safe to include
 389          * as a subelement in a larger XML stream. Namespace and XML Schema
 390          * references are included.
 391          *
 392          * Output will be encoded in UTF-8.
 393          *
 394          * @return string
 395          */
 396         function openStream() {
 397                 global $wgLanguageCode;
 398                 $ver = $this->schemaVersion();
 399                 return Xml::element( 'mediawiki', array(
 400                         'xmlns'              => "http://www.mediawiki.org/xml/export-$ver/",
 401                         'xmlns:xsi'          => "http://www.w3.org/2001/XMLSchema-instance",
 402                         'xsi:schemaLocation' => "http://www.mediawiki.org/xml/export-$ver/ " .
 403                                                 "http://www.mediawiki.org/xml/export-$ver.xsd",
 404                         'version'            => $ver,
 405                         'xml:lang'           => $wgLanguageCode ),
 406                         null ) .
 407                         "\n" .
 408                         $this->siteInfo();
 409         }
 410
 411         function siteInfo() {
 412                 $info = array(
 413                         $this->sitename(),
 414                         $this->homelink(),
 415                         $this->generator(),
 416                         $this->caseSetting(),
 417                         $this->namespaces() );
 418                 return "  <siteinfo>\n    " .
 419                         implode( "\n    ", $info ) .
 420                         "\n  </siteinfo>\n";
 421         }
 422
 423         function sitename() {
 424                 global $wgSitename;
 425                 return Xml::element( 'sitename', array(), $wgSitename );
 426         }
 427
 428         function generator() {
 429                 global $wgVersion;
 430                 return Xml::element( 'generator', array(), "MediaWiki $wgVersion" );
 431         }
 432
 433         function homelink() {
 434                 return Xml::element( 'base', array(), Title::newMainPage()->getCanonicalUrl() );
 435         }
 436
 437         function caseSetting() {
 438                 global $wgCapitalLinks;
 439                 // "case-insensitive" option is reserved for future
 440                 $sensitivity = $wgCapitalLinks ? 'first-letter' : 'case-sensitive';
 441                 return Xml::element( 'case', array(), $sensitivity );
 442         }
 443
 444         function namespaces() {
 445                 global $wgContLang;
 446                 $spaces = "<namespaces>\n";
 447                 foreach ( $wgContLang->getFormattedNamespaces() as $ns => $title ) {
 448                         $spaces .= '      ' .
 449                                 Xml::element( 'namespace',
 450                                         array(  'key' => $ns,
 451                                                         'case' => MWNamespace::isCapitalized( $ns ) ? 'first-letter' : 'case-sensitive',
 452                                         ), $title ) . "\n";
 453                 }
 454                 $spaces .= "    </namespaces>";
 455                 return $spaces;
 456         }
 457
 458         /**
 459          * Closes the output stream with the closing root element.
 460          * Call when finished dumping things.
 461          *
 462          * @return string
 463          */
 464         function closeStream() {
 465                 return "</mediawiki>\n";
 466         }
 467
 468         /**
 469          * Opens a <page> section on the output stream, with data
 470          * from the given database row.
 471          *
 472          * @param $row object
 473          * @return string
 474          * @access private
 475          */
 476         function openPage( $row ) {
 477                 $out = "  <page>\n";
 478                 $title = Title::makeTitle( $row->page_namespace, $row->page_title );
 479                 $out .= '    ' . Xml::elementClean( 'title', array(), $title->getPrefixedText() ) . "\n";
 480                 $out .= '    ' . Xml::element( 'ns', array(), strval( $row->page_namespace) ) . "\n";
 481                 $out .= '    ' . Xml::element( 'id', array(), strval( $row->page_id ) ) . "\n";
 482                 if ( $row->page_is_redirect ) {
 483                         $page = WikiPage::factory( $title );
 484                         $redirect = $page->getRedirectTarget();
 485                         $redirect instanceOf Title && $redirect->isValidRedirectTarget() {
 486                                 $out .= '    ' . Xml::element( 'redirect', array( 'title' => $redirect->getPrefixedText() ) ) . "\n";
 487                         }
 488                 }
 489                 if ( $row->page_restrictions != '' ) {
 490                         $out .= '    ' . Xml::element( 'restrictions', array(),
 491                                 strval( $row->page_restrictions ) ) . "\n";
 492                 }
 493
 494                 wfRunHooks( 'XmlDumpWriterOpenPage', array( $this, &$out, $row, $title ) );
 495
 496                 return $out;
 497         }
 498
 499         /**
 500          * Closes a <page> section on the output stream.
 501          *
 502          * @access private
 503          */
 504         function closePage() {
 505                 return "  </page>\n";
 506         }
 507
 508         /**
 509          * Dumps a <revision> section on the output stream, with
 510          * data filled in from the given database row.
 511          *
 512          * @param $row object
 513          * @return string
 514          * @access private
 515          */
 516         function writeRevision( $row ) {
 517                 wfProfileIn( __METHOD__ );
 518
 519                 $out  = "    <revision>\n";
 520                 $out .= "      " . Xml::element( 'id', null, strval( $row->rev_id ) ) . "\n";
 521
 522                 $out .= $this->writeTimestamp( $row->rev_timestamp );
 523
 524                 if ( $row->rev_deleted & Revision::DELETED_USER ) {
 525                         $out .= "      " . Xml::element( 'contributor', array( 'deleted' => 'deleted' ) ) . "\n";
 526                 } else {
 527                         $out .= $this->writeContributor( $row->rev_user, $row->rev_user_text );
 528                 }
 529
 530                 if ( $row->rev_minor_edit ) {
 531                         $out .=  "      <minor/>\n";
 532                 }
 533                 if ( $row->rev_deleted & Revision::DELETED_COMMENT ) {
 534                         $out .= "      " . Xml::element( 'comment', array( 'deleted' => 'deleted' ) ) . "\n";
 535                 } elseif ( $row->rev_comment != '' ) {
 536                         $out .= "      " . Xml::elementClean( 'comment', null, strval( $row->rev_comment ) ) . "\n";
 537                 }
 538
 539                 $text = '';
 540                 if ( $row->rev_deleted & Revision::DELETED_TEXT ) {
 541                         $out .= "      " . Xml::element( 'text', array( 'deleted' => 'deleted' ) ) . "\n";
 542                 } elseif ( isset( $row->old_text ) ) {
 543                         // Raw text from the database may have invalid chars
 544                         $text = strval( Revision::getRevisionText( $row ) );
 545                         $out .= "      " . Xml::elementClean( 'text',
 546                                 array( 'xml:space' => 'preserve', 'bytes' => $row->rev_len ),
 547                                 strval( $text ) ) . "\n";
 548                 } else {
 549                         // Stub output
 550                         $out .= "      " . Xml::element( 'text',
 551                                 array( 'id' => $row->rev_text_id, 'bytes' => $row->rev_len ),
 552                                 "" ) . "\n";
 553                 }
 554
 555                 wfRunHooks( 'XmlDumpWriterWriteRevision', array( &$this, &$out, $row, $text ) );
 556
 557                 $out .= "    </revision>\n";
 558
 559                 wfProfileOut( __METHOD__ );
 560                 return $out;
 561         }
 562
 563         /**
 564          * Dumps a <logitem> section on the output stream, with
 565          * data filled in from the given database row.
 566          *
 567          * @param $row object
 568          * @return string
 569          * @access private
 570          */
 571         function writeLogItem( $row ) {
 572                 wfProfileIn( __METHOD__ );
 573
 574                 $out  = "    <logitem>\n";
 575                 $out .= "      " . Xml::element( 'id', null, strval( $row->log_id ) ) . "\n";
 576
 577                 $out .= $this->writeTimestamp( $row->log_timestamp );
 578
 579                 if ( $row->log_deleted & LogPage::DELETED_USER ) {
 580                         $out .= "      " . Xml::element( 'contributor', array( 'deleted' => 'deleted' ) ) . "\n";
 581                 } else {
 582                         $out .= $this->writeContributor( $row->log_user, $row->user_name );
 583                 }
 584
 585                 if ( $row->log_deleted & LogPage::DELETED_COMMENT ) {
 586                         $out .= "      " . Xml::element( 'comment', array( 'deleted' => 'deleted' ) ) . "\n";
 587                 } elseif ( $row->log_comment != '' ) {
 588                         $out .= "      " . Xml::elementClean( 'comment', null, strval( $row->log_comment ) ) . "\n";
 589                 }
 590
 591                 $out .= "      " . Xml::element( 'type', null, strval( $row->log_type ) ) . "\n";
 592                 $out .= "      " . Xml::element( 'action', null, strval( $row->log_action ) ) . "\n";
 593
 594                 if ( $row->log_deleted & LogPage::DELETED_ACTION ) {
 595                         $out .= "      " . Xml::element( 'text', array( 'deleted' => 'deleted' ) ) . "\n";
 596                 } else {
 597                         $title = Title::makeTitle( $row->log_namespace, $row->log_title );
 598                         $out .= "      " . Xml::elementClean( 'logtitle', null, $title->getPrefixedText() ) . "\n";
 599                         $out .= "      " . Xml::elementClean( 'params',
 600                                 array( 'xml:space' => 'preserve' ),
 601                                 strval( $row->log_params ) ) . "\n";
 602                 }
 603
 604                 $out .= "    </logitem>\n";
 605
 606                 wfProfileOut( __METHOD__ );
 607                 return $out;
 608         }
 609
 610         function writeTimestamp( $timestamp ) {
 611                 $ts = wfTimestamp( TS_ISO_8601, $timestamp );
 612                 return "      " . Xml::element( 'timestamp', null, $ts ) . "\n";
 613         }
 614
 615         function writeContributor( $id, $text ) {
 616                 $out = "      <contributor>\n";
 617                 if ( $id ) {
 618                         $out .= "        " . Xml::elementClean( 'username', null, strval( $text ) ) . "\n";
 619                         $out .= "        " . Xml::element( 'id', null, strval( $id ) ) . "\n";
 620                 } else {
 621                         $out .= "        " . Xml::elementClean( 'ip', null, strval( $text ) ) . "\n";
 622                 }
 623                 $out .= "      </contributor>\n";
 624                 return $out;
 625         }
 626
 627         /**
 628          * Warning! This data is potentially inconsistent. :(
 629          */
 630         function writeUploads( $row, $dumpContents = false ) {
 631                 if ( $row->page_namespace == NS_IMAGE ) {
 632                         $img = wfLocalFile( $row->page_title );
 633                         if ( $img && $img->exists() ) {
 634                                 $out = '';
 635                                 foreach ( array_reverse( $img->getHistory() ) as $ver ) {
 636                                         $out .= $this->writeUpload( $ver, $dumpContents );
 637                                 }
 638                                 $out .= $this->writeUpload( $img, $dumpContents );
 639                                 return $out;
 640                         }
 641                 }
 642                 return '';
 643         }
 644
 645         /**
 646          * @param $file File
 647          * @param $dumpContents bool
 648          * @return string
 649          */
 650         function writeUpload( $file, $dumpContents = false ) {
 651                 if ( $file->isOld() ) {
 652                         $archiveName = "      " .
 653                                 Xml::element( 'archivename', null, $file->getArchiveName() ) . "\n";
 654                 } else {
 655                         $archiveName = '';
 656                 }
 657                 if ( $dumpContents ) {
 658                         # Dump file as base64
 659                         # Uses only XML-safe characters, so does not need escaping
 660                         $contents = '      <contents encoding="base64">' .
 661                                 chunk_split( base64_encode( file_get_contents( $file->getPath() ) ) ) .
 662                                 "      </contents>\n";
 663                 } else {
 664                         $contents = '';
 665                 }
 666                 return "    <upload>\n" .
 667                         $this->writeTimestamp( $file->getTimestamp() ) .
 668                         $this->writeContributor( $file->getUser( 'id' ), $file->getUser( 'text' ) ) .
 669                         "      " . Xml::elementClean( 'comment', null, $file->getDescription() ) . "\n" .
 670                         "      " . Xml::element( 'filename', null, $file->getName() ) . "\n" .
 671                         $archiveName .
 672                         "      " . Xml::element( 'src', null, $file->getCanonicalUrl() ) . "\n" .
 673                         "      " . Xml::element( 'size', null, $file->getSize() ) . "\n" .
 674                         "      " . Xml::element( 'sha1base36', null, $file->getSha1() ) . "\n" .
 675                         "      " . Xml::element( 'rel', null, $file->getRel() ) . "\n" .
 676                         $contents .
 677                         "    </upload>\n";
 678         }
 679
 680 }
 681
 682
 683 /**
 684  * Base class for output stream; prints to stdout or buffer or whereever.
 685  * @ingroup Dump
 686  */
 687 class DumpOutput {
 688         function writeOpenStream( $string ) {
 689                 $this->write( $string );
 690         }
 691
 692         function writeCloseStream( $string ) {
 693                 $this->write( $string );
 694         }
 695
 696         function writeOpenPage( $page, $string ) {
 697                 $this->write( $string );
 698         }
 699
 700         function writeClosePage( $string ) {
 701                 $this->write( $string );
 702         }
 703
 704         function writeRevision( $rev, $string ) {
 705                 $this->write( $string );
 706         }
 707
 708         function writeLogItem( $rev, $string ) {
 709                 $this->write( $string );
 710         }
 711
 712         /**
 713          * Override to write to a different stream type.
 714          * @return bool
 715          */
 716         function write( $string ) {
 717                 print $string;
 718         }
 719
 720         /**
 721          * Close the old file, move it to a specified name,
 722          * and reopen new file with the old name. Use this
 723          * for writing out a file in multiple pieces
 724          * at specified checkpoints (e.g. every n hours).
 725          * @param $newname mixed File name. May be a string or an array with one element
 726          */
 727         function closeRenameAndReopen( $newname ) {
 728                 return;
 729         }
 730
 731         /**
 732          * Close the old file, and move it to a specified name.
 733          * Use this for the last piece of a file written out
 734          * at specified checkpoints (e.g. every n hours).
 735          * @param $newname mixed File name. May be a string or an array with one element
 736          * @param $open bool If true, a new file with the old filename will be opened again for writing (default: false)
 737          */
 738         function closeAndRename( $newname, $open = false ) {
 739                 return;
 740         }
 741
 742         /**
 743          * Returns the name of the file or files which are
 744          * being written to, if there are any.
 745          */
 746         function getFilenames() {
 747                 return NULL;
 748         }
 749 }
 750
 751 /**
 752  * Stream outputter to send data to a file.
 753  * @ingroup Dump
 754  */
 755 class DumpFileOutput extends DumpOutput {
 756         protected $handle, $filename;
 757
 758         function __construct( $file ) {
 759                 $this->handle = fopen( $file, "wt" );
 760                 $this->filename = $file;
 761         }
 762
 763         function write( $string ) {
 764                 fputs( $this->handle, $string );
 765         }
 766
 767         function closeRenameAndReopen( $newname ) {
 768                 $this->closeAndRename( $newname, true );
 769         }
 770
 771         function renameOrException( $newname ) {
 772                         if (! rename( $this->filename, $newname ) ) {
 773                                 throw new MWException( __METHOD__ . ": rename of file {$this->filename} to $newname failed\n" );
 774                         }
 775         }
 776
 777         function checkRenameArgCount( $newname ) {
 778                 if ( is_array( $newname ) ) {
 779                         if ( count( $newname ) > 1 ) {
 780                                 throw new MWException( __METHOD__ . ": passed multiple arguments for rename of single file\n" );
 781                         } else {
 782                                 $newname = $newname[0];
 783                         }
 784                 }
 785                 return $newname;
 786         }
 787
 788         function closeAndRename( $newname, $open = false ) {
 789                 $newname = $this->checkRenameArgCount( $newname );
 790                 if ( $newname ) {
 791                         fclose( $this->handle );
 792                         $this->renameOrException( $newname );
 793                         if ( $open ) {
 794                                 $this->handle = fopen( $this->filename, "wt" );
 795                         }
 796                 }
 797         }
 798
 799         function getFilenames() {
 800                 return $this->filename;
 801         }
 802 }
 803
 804 /**
 805  * Stream outputter to send data to a file via some filter program.
 806  * Even if compression is available in a library, using a separate
 807  * program can allow us to make use of a multi-processor system.
 808  * @ingroup Dump
 809  */
 810 class DumpPipeOutput extends DumpFileOutput {
 811         protected $command, $filename;
 812
 813         function __construct( $command, $file = null ) {
 814                 if ( !is_null( $file ) ) {
 815                         $command .=  " > " . wfEscapeShellArg( $file );
 816                 }
 817
 818                 $this->startCommand( $command );
 819                 $this->command = $command;
 820                 $this->filename = $file;
 821         }
 822
 823         function startCommand( $command ) {
 824                 $spec = array(
 825                         0 => array( "pipe", "r" ),
 826                 );
 827                 $pipes = array();
 828                 $this->procOpenResource = proc_open( $command, $spec, $pipes );
 829                 $this->handle = $pipes[0];
 830         }
 831
 832         function closeRenameAndReopen( $newname ) {
 833                 $this->closeAndRename( $newname, true );
 834         }
 835
 836         function closeAndRename( $newname, $open = false ) {
 837                 $newname = $this->checkRenameArgCount( $newname );
 838                 if ( $newname ) {
 839                         fclose( $this->handle );
 840                         proc_close( $this->procOpenResource );
 841                         $this->renameOrException( $newname );
 842                         if ( $open ) {
 843                                 $command = $this->command;
 844                                 $command .=  " > " . wfEscapeShellArg( $this->filename );
 845                                 $this->startCommand( $command );
 846                         }
 847                 }
 848         }
 849
 850 }
 851
 852 /**
 853  * Sends dump output via the gzip compressor.
 854  * @ingroup Dump
 855  */
 856 class DumpGZipOutput extends DumpPipeOutput {
 857         function __construct( $file ) {
 858                 parent::__construct( "gzip", $file );
 859         }
 860 }
 861
 862 /**
 863  * Sends dump output via the bgzip2 compressor.
 864  * @ingroup Dump
 865  */
 866 class DumpBZip2Output extends DumpPipeOutput {
 867         function __construct( $file ) {
 868                 parent::__construct( "bzip2", $file );
 869         }
 870 }
 871
 872 /**
 873  * Sends dump output via the p7zip compressor.
 874  * @ingroup Dump
 875  */
 876 class Dump7ZipOutput extends DumpPipeOutput {
 877         protected $filename;
 878
 879         function __construct( $file ) {
 880                 $command = $this->setup7zCommand( $file );
 881                 parent::__construct( $command );
 882                 $this->filename = $file;
 883         }
 884
 885         function setup7zCommand( $file ) {
 886                 $command = "7za a -bd -si " . wfEscapeShellArg( $file );
 887                 // Suppress annoying useless crap from p7zip
 888                 // Unfortunately this could suppress real error messages too
 889                 $command .= ' >' . wfGetNull() . ' 2>&1';
 890                 return( $command );
 891         }
 892
 893         function closeRenameAndReopen( $newname ) {
 894                 $this->closeAndRename( $newname, true );
 895         }
 896
 897         function closeAndRename( $newname, $open = false ) {
 898                 $newname = $this->checkRenameArgCount( $newname );
 899                 if ( $newname ) {
 900                         fclose( $this->handle );
 901                         proc_close( $this->procOpenResource );
 902                         $this->renameOrException( $newname );
 903                         if ( $open ) {
 904                                 $command = $this->setup7zCommand( $file );
 905                                 $this->startCommand( $command );
 906                         }
 907                 }
 908         }
 909 }
 910
 911
 912
 913 /**
 914  * Dump output filter class.
 915  * This just does output filtering and streaming; XML formatting is done
 916  * higher up, so be careful in what you do.
 917  * @ingroup Dump
 918  */
 919 class DumpFilter {
 920         function __construct( &$sink ) {
 921                 $this->sink =& $sink;
 922         }
 923
 924         function writeOpenStream( $string ) {
 925                 $this->sink->writeOpenStream( $string );
 926         }
 927
 928         function writeCloseStream( $string ) {
 929                 $this->sink->writeCloseStream( $string );
 930         }
 931
 932         function writeOpenPage( $page, $string ) {
 933                 $this->sendingThisPage = $this->pass( $page, $string );
 934                 if ( $this->sendingThisPage ) {
 935                         $this->sink->writeOpenPage( $page, $string );
 936                 }
 937         }
 938
 939         function writeClosePage( $string ) {
 940                 if ( $this->sendingThisPage ) {
 941                         $this->sink->writeClosePage( $string );
 942                         $this->sendingThisPage = false;
 943                 }
 944         }
 945
 946         function writeRevision( $rev, $string ) {
 947                 if ( $this->sendingThisPage ) {
 948                         $this->sink->writeRevision( $rev, $string );
 949                 }
 950         }
 951
 952         function writeLogItem( $rev, $string ) {
 953                 $this->sink->writeRevision( $rev, $string );
 954         }
 955
 956         function closeRenameAndReopen( $newname ) {
 957                 $this->sink->closeRenameAndReopen( $newname );
 958         }
 959
 960         function closeAndRename( $newname, $open = false ) {
 961                 $this->sink->closeAndRename( $newname, $open );
 962         }
 963
 964         function getFilenames() {
 965                 return $this->sink->getFilenames();
 966         }
 967
 968         /**
 969          * Override for page-based filter types.
 970          * @return bool
 971          */
 972         function pass( $page ) {
 973                 return true;
 974         }
 975 }
 976
 977 /**
 978  * Simple dump output filter to exclude all talk pages.
 979  * @ingroup Dump
 980  */
 981 class DumpNotalkFilter extends DumpFilter {
 982         function pass( $page ) {
 983                 return !MWNamespace::isTalk( $page->page_namespace );
 984         }
 985 }
 986
 987 /**
 988  * Dump output filter to include or exclude pages in a given set of namespaces.
 989  * @ingroup Dump
 990  */
 991 class DumpNamespaceFilter extends DumpFilter {
 992         var $invert = false;
 993         var $namespaces = array();
 994
 995         function __construct( &$sink, $param ) {
 996                 parent::__construct( $sink );
 997
 998                 $constants = array(
 999                         "NS_MAIN"           => NS_MAIN,
1000                         "NS_TALK"           => NS_TALK,
1001                         "NS_USER"           => NS_USER,
1002                         "NS_USER_TALK"      => NS_USER_TALK,
1003                         "NS_PROJECT"        => NS_PROJECT,
1004                         "NS_PROJECT_TALK"   => NS_PROJECT_TALK,
1005                         "NS_FILE"           => NS_FILE,
1006                         "NS_FILE_TALK"      => NS_FILE_TALK,
1007                         "NS_IMAGE"          => NS_IMAGE,  // NS_IMAGE is an alias for NS_FILE
1008                         "NS_IMAGE_TALK"     => NS_IMAGE_TALK,
1009                         "NS_MEDIAWIKI"      => NS_MEDIAWIKI,
1010                         "NS_MEDIAWIKI_TALK" => NS_MEDIAWIKI_TALK,
1011                         "NS_TEMPLATE"       => NS_TEMPLATE,
1012                         "NS_TEMPLATE_TALK"  => NS_TEMPLATE_TALK,
1013                         "NS_HELP"           => NS_HELP,
1014                         "NS_HELP_TALK"      => NS_HELP_TALK,
1015                         "NS_CATEGORY"       => NS_CATEGORY,
1016                         "NS_CATEGORY_TALK"  => NS_CATEGORY_TALK );
1017
1018                 if ( $param { 0 } == '!' ) {
1019                         $this->invert = true;
1020                         $param = substr( $param, 1 );
1021                 }
1022
1023                 foreach ( explode( ',', $param ) as $key ) {
1024                         $key = trim( $key );
1025                         if ( isset( $constants[$key] ) ) {
1026                                 $ns = $constants[$key];
1027                                 $this->namespaces[$ns] = true;
1028                         } elseif ( is_numeric( $key ) ) {
1029                                 $ns = intval( $key );
1030                                 $this->namespaces[$ns] = true;
1031                         } else {
1032                                 throw new MWException( "Unrecognized namespace key '$key'\n" );
1033                         }
1034                 }
1035         }
1036
1037         function pass( $page ) {
1038                 $match = isset( $this->namespaces[$page->page_namespace] );
1039                 return $this->invert xor $match;
1040         }
1041 }
1042
1043
1044 /**
1045  * Dump output filter to include only the last revision in each page sequence.
1046  * @ingroup Dump
1047  */
1048 class DumpLatestFilter extends DumpFilter {
1049         var $page, $pageString, $rev, $revString;
1050
1051         function writeOpenPage( $page, $string ) {
1052                 $this->page = $page;
1053                 $this->pageString = $string;
1054         }
1055
1056         function writeClosePage( $string ) {
1057                 if ( $this->rev ) {
1058                         $this->sink->writeOpenPage( $this->page, $this->pageString );
1059                         $this->sink->writeRevision( $this->rev, $this->revString );
1060                         $this->sink->writeClosePage( $string );
1061                 }
1062                 $this->rev = null;
1063                 $this->revString = null;
1064                 $this->page = null;
1065                 $this->pageString = null;
1066         }
1067
1068         function writeRevision( $rev, $string ) {
1069                 if ( $rev->rev_id == $this->page->page_latest ) {
1070                         $this->rev = $rev;
1071                         $this->revString = $string;
1072                 }
1073         }
1074 }
1075
1076 /**
1077  * Base class for output stream; prints to stdout or buffer or whereever.
1078  * @ingroup Dump
1079  */
1080 class DumpMultiWriter {
1081         function __construct( $sinks ) {
1082                 $this->sinks = $sinks;
1083                 $this->count = count( $sinks );
1084         }
1085
1086         function writeOpenStream( $string ) {
1087                 for ( $i = 0; $i < $this->count; $i++ ) {
1088                         $this->sinks[$i]->writeOpenStream( $string );
1089                 }
1090         }
1091
1092         function writeCloseStream( $string ) {
1093                 for ( $i = 0; $i < $this->count; $i++ ) {
1094                         $this->sinks[$i]->writeCloseStream( $string );
1095                 }
1096         }
1097
1098         function writeOpenPage( $page, $string ) {
1099                 for ( $i = 0; $i < $this->count; $i++ ) {
1100                         $this->sinks[$i]->writeOpenPage( $page, $string );
1101                 }
1102         }
1103
1104         function writeClosePage( $string ) {
1105                 for ( $i = 0; $i < $this->count; $i++ ) {
1106                         $this->sinks[$i]->writeClosePage( $string );
1107                 }
1108         }
1109
1110         function writeRevision( $rev, $string ) {
1111                 for ( $i = 0; $i < $this->count; $i++ ) {
1112                         $this->sinks[$i]->writeRevision( $rev, $string );
1113                 }
1114         }
1115
1116         function closeRenameAndReopen( $newnames ) {
1117                 $this->closeAndRename( $newnames, true );
1118         }
1119
1120         function closeAndRename( $newnames, $open = false ) {
1121                 for ( $i = 0; $i < $this->count; $i++ ) {
1122                         $this->sinks[$i]->closeAndRename( $newnames[$i], $open );
1123                 }
1124         }
1125
1126         function getFilenames() {
1127                 $filenames = array();
1128                 for ( $i = 0; $i < $this->count; $i++ ) {
1129                         $filenames[] =  $this->sinks[$i]->getFilenames();
1130                 }
1131                 return $filenames;
1132         }
1133
1134 }
1135
1136 function xmlsafe( $string ) {
1137         wfProfileIn( __FUNCTION__ );
1138
1139         /**
1140          * The page may contain old data which has not been properly normalized.
1141          * Invalid UTF-8 sequences or forbidden control characters will make our
1142          * XML output invalid, so be sure to strip them out.
1143          */
1144         $string = UtfNormal::cleanUp( $string );
1145
1146         $string = htmlspecialchars( $string );
1147         wfProfileOut( __FUNCTION__ );
1148         return $string;
1149 }