Clarification for $wgRestrictionLevels
[lhc/web/wiklou.git] / includes / Export.php
index 88ef6e3..9307795 100644 (file)
@@ -1,5 +1,5 @@
 <?php
-# Copyright (C) 2003, 2005 Brion Vibber <brion@pobox.com>
+# Copyright (C) 2003, 2005, 2006 Brion Vibber <brion@pobox.com>
 # http://www.mediawiki.org/
 #
 # This program is free software; you can redistribute it and/or modify
 #
 # You should have received a copy of the GNU General Public License along
 # with this program; if not, write to the Free Software Foundation, Inc.,
-# 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 # http://www.gnu.org/copyleft/gpl.html
+
+
 /**
  *
- * @package MediaWiki
- * @subpackage SpecialPage
+ * @addtogroup SpecialPage
  */
+class WikiExporter {
+       var $list_authors = false ; # Return distinct author list (when not returning full history)
+       var $author_list = "" ;
 
-/** */
-require_once( 'Revision.php' );
-
-define( 'MW_EXPORT_FULL',     0 );
-define( 'MW_EXPORT_CURRENT',  1 );
-
-define( 'MW_EXPORT_BUFFER',   0 );
-define( 'MW_EXPORT_STREAM',   1 );
+       const FULL = 0;
+       const CURRENT = 1;
 
-define( 'MW_EXPORT_TEXT',     0 );
-define( 'MW_EXPORT_STUB',     1 );
+       const BUFFER = 0;
+       const STREAM = 1;
 
+       const TEXT = 0;
+       const STUB = 1;
 
-/**
- * @package MediaWiki
- * @subpackage SpecialPage
- */
-class WikiExporter {
        /**
-        * If using MW_EXPORT_STREAM to stream a large amount of data,
+        * If using WikiExporter::STREAM to stream a large amount of data,
         * provide a database connection which is not managed by
         * LoadBalancer to read from: some history blob types will
         * make additional queries to pull source data while the
         * main query is still running.
         *
         * @param Database $db
-        * @param int $history one of MW_EXPORT_FULL or MW_EXPORT_CURRENT
-        * @param int $buffer one of MW_EXPORT_BUFFER or MW_EXPORT_STREAM
+        * @param mixed $history one of WikiExporter::FULL or WikiExporter::CURRENT, or an
+        *                       associative array:
+        *                         offset: non-inclusive offset at which to start the query
+        *                         limit: maximum number of rows to return
+        *                         dir: "asc" or "desc" timestamp order
+        * @param int $buffer one of WikiExporter::BUFFER or WikiExporter::STREAM
         */
-       function WikiExporter( &$db, $history = MW_EXPORT_CURRENT,
-                       $buffer = MW_EXPORT_BUFFER, $text = MW_EXPORT_TEXT ) {
+       function __construct( &$db, $history = WikiExporter::CURRENT,
+                       $buffer = WikiExporter::BUFFER, $text = WikiExporter::TEXT ) {
                $this->db =& $db;
                $this->history = $history;
                $this->buffer  = $buffer;
@@ -133,6 +132,33 @@ class WikiExporter {
 
        // -------------------- private implementation below --------------------
 
+       # Generates the distinct list of authors of an article
+       # Not called by default (depends on $this->list_authors)
+       # Can be set by Special:Export when not exporting whole history
+       function do_list_authors ( $page , $revision , $cond ) {
+               $fname = "do_list_authors" ;
+               wfProfileIn( $fname );
+               $this->author_list = "<contributors>";
+               //rev_deleted
+               $nothidden = '(rev_deleted & '.Revision::DELETED_USER.') = 0';
+               
+               $sql = "SELECT DISTINCT rev_user_text,rev_user FROM {$page},{$revision} WHERE page_id=rev_page AND $nothidden AND " . $cond ;
+               $result = $this->db->query( $sql, $fname );
+               $resultset = $this->db->resultObject( $result );
+               while( $row = $resultset->fetchObject() ) {
+                       $this->author_list .= "<contributor>" . 
+                               "<username>" . 
+                               htmlentities( $row->rev_user_text )  . 
+                               "</username>" . 
+                               "<id>" . 
+                               $row->rev_user .
+                               "</id>" . 
+                               "</contributor>";
+               }
+               wfProfileOut( $fname );
+               $this->author_list .= "</contributors>";
+       }
+
        function dumpFrom( $cond = '' ) {
                $fname = 'WikiExporter::dumpFrom';
                wfProfileIn( $fname );
@@ -141,46 +167,76 @@ class WikiExporter {
                $revision = $this->db->tableName( 'revision' );
                $text     = $this->db->tableName( 'text' );
 
-               if( $this->history == MW_EXPORT_FULL ) {
+               $order = 'ORDER BY page_id';
+               $limit = '';
+
+               if( $this->history == WikiExporter::FULL ) {
                        $join = 'page_id=rev_page';
-               } elseif( $this->history == MW_EXPORT_CURRENT ) {
+               } elseif( $this->history == WikiExporter::CURRENT ) {
+                       if ( $this->list_authors && $cond != '' )  { // List authors, if so desired
+                               $this->do_list_authors ( $page , $revision , $cond );
+                       }
                        $join = 'page_id=rev_page AND page_latest=rev_id';
+               } elseif ( is_array( $this->history ) ) {
+                       $join = 'page_id=rev_page';
+                       if ( $this->history['dir'] == 'asc' ) {
+                               $op = '>';
+                               $order .= ', rev_timestamp';
+                       } else {
+                               $op = '<';
+                               $order .= ', rev_timestamp DESC';
+                       }
+                       if ( !empty( $this->history['offset'] ) ) {
+                               $join .= " AND rev_timestamp $op " . $this->db->addQuotes(
+                                       $this->db->timestamp( $this->history['offset'] ) );
+                       }
+                       if ( !empty( $this->history['limit'] ) ) {
+                               $limitNum = intval( $this->history['limit'] );
+                               if ( $limitNum > 0 ) {
+                                       $limit = "LIMIT $limitNum";
+                               }
+                       }
                } else {
                        wfProfileOut( $fname );
                        return new WikiError( "$fname given invalid history dump type." );
                }
                $where = ( $cond == '' ) ? '' : "$cond AND";
 
-               if( $this->buffer == MW_EXPORT_STREAM ) {
+               if( $this->buffer == WikiExporter::STREAM ) {
                        $prev = $this->db->bufferResults( false );
                }
                if( $cond == '' ) {
                        // Optimization hack for full-database dump
-                       $pageindex = 'FORCE INDEX (PRIMARY)';
-                       $revindex = 'FORCE INDEX(page_timestamp)';
+                       $revindex = $pageindex = $this->db->useIndexClause("PRIMARY");
+                       $straight = ' /*! STRAIGHT_JOIN */ ';
                } else {
                        $pageindex = '';
                        $revindex = '';
+                       $straight = '';
                }
-               if( $this->text == MW_EXPORT_STUB ) {
-                       $sql = "SELECT * FROM
+               if( $this->text == WikiExporter::STUB ) {
+                       $sql = "SELECT $straight * FROM
                                        $page $pageindex,
                                        $revision $revindex
                                        WHERE $where $join
-                                       ORDER BY page_id";
+                                       $order $limit";
                } else {
-                       $sql = "SELECT * FROM
+                       $sql = "SELECT $straight * FROM
                                        $page $pageindex,
                                        $revision $revindex,
                                        $text
                                        WHERE $where $join AND rev_text_id=old_id
-                                       ORDER BY page_id";
+                                       $order $limit";
                }
                $result = $this->db->query( $sql, $fname );
                $wrapper = $this->db->resultObject( $result );
                $this->outputStream( $wrapper );
 
-               if( $this->buffer == MW_EXPORT_STREAM ) {
+               if ( $this->list_authors ) {
+                       $this->outputStream( $wrapper );
+               }
+
+               if( $this->buffer == WikiExporter::STREAM ) {
                        $this->db->bufferResults( $prev );
                }
 
@@ -218,13 +274,16 @@ class WikiExporter {
                        $this->sink->writeRevision( $row, $output );
                }
                if( isset( $last ) ) {
-                       $output = $this->writer->closePage();
+                       $output = $this->author_list . $this->writer->closePage();
                        $this->sink->writeClosePage( $output );
                }
                $resultset->free();
        }
 }
 
+/**
+ * @addtogroup Dump
+ */
 class XmlDumpWriter {
 
        /**
@@ -232,7 +291,7 @@ class XmlDumpWriter {
         * @return string
         */
        function schemaVersion() {
-               return "0.3";
+               return "0.3"; // FIXME: upgrade to 0.4 when updated XSD is ready, for the revision deletion bits
        }
 
        /**
@@ -283,8 +342,7 @@ class XmlDumpWriter {
        }
 
        function homelink() {
-               $page = Title::newFromText( wfMsgForContent( 'mainpage' ) );
-               return wfElement( 'base', array(), $page->getFullUrl() );
+               return wfElement( 'base', array(), Title::newMainPage()->getFullUrl() );
        }
 
        function caseSetting() {
@@ -360,23 +418,31 @@ class XmlDumpWriter {
                $ts = wfTimestamp( TS_ISO_8601, $row->rev_timestamp );
                $out .= "      " . wfElement( 'timestamp', null, $ts ) . "\n";
 
-               $out .= "      <contributor>\n";
-               if( $row->rev_user ) {
-                       $out .= "        " . wfElementClean( 'username', null, strval( $row->rev_user_text ) ) . "\n";
-                       $out .= "        " . wfElement( 'id', null, strval( $row->rev_user ) ) . "\n";
+               if( $row->rev_deleted & Revision::DELETED_USER ) {
+                       $out .= "      " . wfElement( 'contributor', array( 'deleted' => 'deleted' ) ) . "\n";
                } else {
-                       $out .= "        " . wfElementClean( 'ip', null, strval( $row->rev_user_text ) ) . "\n";
+                       $out .= "      <contributor>\n";
+                       if( $row->rev_user ) {
+                               $out .= "        " . wfElementClean( 'username', null, strval( $row->rev_user_text ) ) . "\n";
+                               $out .= "        " . wfElement( 'id', null, strval( $row->rev_user ) ) . "\n";
+                       } else {
+                               $out .= "        " . wfElementClean( 'ip', null, strval( $row->rev_user_text ) ) . "\n";
+                       }
+                       $out .= "      </contributor>\n";
                }
-               $out .= "      </contributor>\n";
 
                if( $row->rev_minor_edit ) {
                        $out .=  "      <minor/>\n";
                }
-               if( $row->rev_comment != '' ) {
+               if( $row->rev_deleted & Revision::DELETED_COMMENT ) {
+                       $out .= "      " . wfElement( 'comment', array( 'deleted' => 'deleted' ) ) . "\n";
+               } elseif( $row->rev_comment != '' ) {
                        $out .= "      " . wfElementClean( 'comment', null, strval( $row->rev_comment ) ) . "\n";
                }
 
-               if( isset( $row->old_text ) ) {
+               if( $row->rev_deleted & Revision::DELETED_TEXT ) {
+                       $out .= "      " . wfElement( 'text', array( 'deleted' => 'deleted' ) ) . "\n";
+               } elseif( isset( $row->old_text ) ) {
                        // Raw text from the database may have invalid chars
                        $text = strval( Revision::getRevisionText( $row ) );
                        $out .= "      " . wfElementClean( 'text',
@@ -400,6 +466,7 @@ class XmlDumpWriter {
 
 /**
  * Base class for output stream; prints to stdout or buffer or whereever.
+ * @addtogroup Dump
  */
 class DumpOutput {
        function writeOpenStream( $string ) {
@@ -433,6 +500,7 @@ class DumpOutput {
 
 /**
  * Stream outputter to send data to a file.
+ * @addtogroup Dump
  */
 class DumpFileOutput extends DumpOutput {
        var $handle;
@@ -450,6 +518,7 @@ class DumpFileOutput extends DumpOutput {
  * Stream outputter to send data to a file via some filter program.
  * Even if compression is available in a library, using a separate
  * program can allow us to make use of a multi-processor system.
+ * @addtogroup Dump
  */
 class DumpPipeOutput extends DumpFileOutput {
        function DumpPipeOutput( $command, $file = null ) {
@@ -462,6 +531,7 @@ class DumpPipeOutput extends DumpFileOutput {
 
 /**
  * Sends dump output via the gzip compressor.
+ * @addtogroup Dump
  */
 class DumpGZipOutput extends DumpPipeOutput {
        function DumpGZipOutput( $file ) {
@@ -471,6 +541,7 @@ class DumpGZipOutput extends DumpPipeOutput {
 
 /**
  * Sends dump output via the bgzip2 compressor.
+ * @addtogroup Dump
  */
 class DumpBZip2Output extends DumpPipeOutput {
        function DumpBZip2Output( $file ) {
@@ -480,10 +551,14 @@ class DumpBZip2Output extends DumpPipeOutput {
 
 /**
  * Sends dump output via the p7zip compressor.
+ * @addtogroup Dump
  */
 class Dump7ZipOutput extends DumpPipeOutput {
        function Dump7ZipOutput( $file ) {
                $command = "7za a -bd -si " . wfEscapeShellArg( $file );
+               // Suppress annoying useless crap from p7zip
+               // Unfortunately this could suppress real error messages too
+               $command .= " >/dev/null 2>&1";
                parent::DumpPipeOutput( $command );
        }
 }
@@ -494,6 +569,7 @@ class Dump7ZipOutput extends DumpPipeOutput {
  * Dump output filter class.
  * This just does output filtering and streaming; XML formatting is done
  * higher up, so be careful in what you do.
+ * @addtogroup Dump
  */
 class DumpFilter {
        function DumpFilter( &$sink ) {
@@ -532,13 +608,14 @@ class DumpFilter {
         * Override for page-based filter types.
         * @return bool
         */
-       function pass( $page, $string ) {
+       function pass( $page ) {
                return true;
        }
 }
 
 /**
  * Simple dump output filter to exclude all talk pages.
+ * @addtogroup Dump
  */
 class DumpNotalkFilter extends DumpFilter {
        function pass( $page ) {
@@ -548,6 +625,7 @@ class DumpNotalkFilter extends DumpFilter {
 
 /**
  * Dump output filter to include or exclude pages in a given set of namespaces.
+ * @addtogroup Dump
  */
 class DumpNamespaceFilter extends DumpFilter {
        var $invert = false;
@@ -588,7 +666,7 @@ class DumpNamespaceFilter extends DumpFilter {
                                $ns = intval( $key );
                                $this->namespaces[$ns] = true;
                        } else {
-                               wfDie( "Unrecognized namespace key '$key'\n" );
+                               throw new MWException( "Unrecognized namespace key '$key'\n" );
                        }
                }
        }
@@ -602,6 +680,7 @@ class DumpNamespaceFilter extends DumpFilter {
 
 /**
  * Dump output filter to include only the last revision in each page sequence.
+ * @addtogroup Dump
  */
 class DumpLatestFilter extends DumpFilter {
        var $page, $pageString, $rev, $revString;
@@ -633,6 +712,7 @@ class DumpLatestFilter extends DumpFilter {
 
 /**
  * Base class for output stream; prints to stdout or buffer or whereever.
+ * @addtogroup Dump
  */
 class DumpMultiWriter {
        function DumpMultiWriter( $sinks ) {