* Some enhancements to live preview
[lhc/web/wiklou.git] / includes / Export.php
index d0253eb..f15c778 100644 (file)
 # with this program; if not, write to the Free Software Foundation, Inc.,
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 # http://www.gnu.org/copyleft/gpl.html
+
 /**
  *
- * @package MediaWiki
- * @subpackage SpecialPage
+ * @addtogroup SpecialPage
  */
 
-/** */
-require_once( 'Revision.php' );
-
-define( 'MW_EXPORT_FULL',     0 );
-define( 'MW_EXPORT_CURRENT',  1 );
+class WikiExporter {
+       var $list_authors = false ; # Return distinct author list (when not returning full history)
+       var $author_list = "" ;
 
-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 {
-       
-       var $list_authors = false ; # Return distinct author list (when not returning full history)
-       var $author_list = "" ;
-       
        /**
-        * 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;
@@ -168,21 +163,43 @@ 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 == '' ) {
@@ -194,29 +211,29 @@ class WikiExporter {
                        $revindex = '';
                        $straight = '';
                }
-               if( $this->text == MW_EXPORT_STUB ) {
+               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 $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 );
                }
 
@@ -319,8 +336,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() {
@@ -396,7 +412,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";
@@ -412,13 +428,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
@@ -579,7 +595,7 @@ class DumpFilter {
         * Override for page-based filter types.
         * @return bool
         */
-       function pass( $page, $string ) {
+       function pass( $page ) {
                return true;
        }
 }
@@ -635,7 +651,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" );
                        }
                }
        }