* (bug 12506) Allow URL parameter 'section' in Special:Mypage/Mytalk. Patch by Eneas.
[lhc/web/wiklou.git] / includes / Export.php
index 1e2ad7f..69d88fc 100644 (file)
 #
 # 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
- */
-
-/** */
-require_once( 'Revision.php' );
-
-define( 'MW_EXPORT_FULL',     0 );
-define( 'MW_EXPORT_CURRENT',  1 );
-
-define( 'MW_EXPORT_BUFFER',   0 );
-define( 'MW_EXPORT_STREAM',   1 );
-
-define( 'MW_EXPORT_TEXT',     0 );
-define( 'MW_EXPORT_STUB',     1 );
 
 
 /**
- * @package MediaWiki
- * @subpackage SpecialPage
+ *
+ * @addtogroup SpecialPage
  */
 class WikiExporter {
-       
        var $list_authors = false ; # Return distinct author list (when not returning full history)
        var $author_list = "" ;
-       
+
+       const FULL = 0;
+       const CURRENT = 1;
+
+       const BUFFER = 0;
+       const STREAM = 1;
+
+       const TEXT = 0;
+       const STUB = 1;
+
        /**
-        * 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;
@@ -116,7 +111,7 @@ class WikiExporter {
        function pageByTitle( $title ) {
                return $this->dumpFrom(
                        'page_namespace=' . $title->getNamespace() .
-                       ' AND page_title=' . $this->db->addQuotes( $title->getDbKey() ) );
+                       ' AND page_title=' . $this->db->addQuotes( $title->getDBkey() ) );
        }
 
        function pageByName( $name ) {
@@ -144,7 +139,10 @@ class WikiExporter {
                $fname = "do_list_authors" ;
                wfProfileIn( $fname );
                $this->author_list = "<contributors>";
-               $sql = "SELECT DISTINCT rev_user_text,rev_user FROM {$page},{$revision} WHERE page_id=rev_page AND " . $cond ;
+               //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() ) {
@@ -168,54 +166,77 @@ class WikiExporter {
                $page     = $this->db->tableName( 'page' );
                $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->list_authors ) {
                        $this->outputStream( $wrapper );
                }
 
-               if( $this->buffer == MW_EXPORT_STREAM ) {
+               if( $this->buffer == WikiExporter::STREAM ) {
                        $this->db->bufferResults( $prev );
                }
 
@@ -260,6 +281,9 @@ class WikiExporter {
        }
 }
 
+/**
+ * @addtogroup Dump
+ */
 class XmlDumpWriter {
 
        /**
@@ -318,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() {
@@ -395,7 +418,7 @@ class XmlDumpWriter {
                $ts = wfTimestamp( TS_ISO_8601, $row->rev_timestamp );
                $out .= "      " . wfElement( 'timestamp', null, $ts ) . "\n";
 
-               if( $row->rev_deleted & MW_REV_DELETED_USER ) {
+               if( $row->rev_deleted & Revision::DELETED_USER ) {
                        $out .= "      " . wfElement( 'contributor', array( 'deleted' => 'deleted' ) ) . "\n";
                } else {
                        $out .= "      <contributor>\n";
@@ -411,13 +434,13 @@ class XmlDumpWriter {
                if( $row->rev_minor_edit ) {
                        $out .=  "      <minor/>\n";
                }
-               if( $row->rev_deleted & MW_REV_DELETED_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( $row->rev_deleted & MW_REV_DELETED_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
@@ -443,6 +466,7 @@ class XmlDumpWriter {
 
 /**
  * Base class for output stream; prints to stdout or buffer or whereever.
+ * @addtogroup Dump
  */
 class DumpOutput {
        function writeOpenStream( $string ) {
@@ -476,6 +500,7 @@ class DumpOutput {
 
 /**
  * Stream outputter to send data to a file.
+ * @addtogroup Dump
  */
 class DumpFileOutput extends DumpOutput {
        var $handle;
@@ -493,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 ) {
@@ -505,6 +531,7 @@ class DumpPipeOutput extends DumpFileOutput {
 
 /**
  * Sends dump output via the gzip compressor.
+ * @addtogroup Dump
  */
 class DumpGZipOutput extends DumpPipeOutput {
        function DumpGZipOutput( $file ) {
@@ -514,6 +541,7 @@ class DumpGZipOutput extends DumpPipeOutput {
 
 /**
  * Sends dump output via the bgzip2 compressor.
+ * @addtogroup Dump
  */
 class DumpBZip2Output extends DumpPipeOutput {
        function DumpBZip2Output( $file ) {
@@ -523,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 .= ' >' . wfGetNull() . ' 2>&1';
                parent::DumpPipeOutput( $command );
        }
 }
@@ -537,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 ) {
@@ -575,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 ) {
@@ -591,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;
@@ -631,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" );
                        }
                }
        }
@@ -645,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;
@@ -676,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 ) {
@@ -730,4 +767,4 @@ function xmlsafe( $string ) {
        return $string;
 }
 
-?>
+