* Some enhancements to live preview
[lhc/web/wiklou.git] / includes / Revision.php
index 7ee0ffa..f5a84ca 100644 (file)
@@ -1,31 +1,27 @@
 <?php
 /**
- * @package MediaWiki
  * @todo document
  */
 
-/** */
-require_once( 'Database.php' );
-
 /**
- * @package MediaWiki
  * @todo document
  */
 class Revision {
-       const MW_REV_DELETED_TEXT       = 1;
-       const MW_REV_DELETED_COMMENT    = 2;
-       const MW_REV_DELETED_USER       = 4;
-       const MW_REV_DELETED_RESTRICTED = 8;
+       const DELETED_TEXT = 1;
+       const DELETED_COMMENT = 2;
+       const DELETED_USER = 4;
+    const DELETED_RESTRICTED = 8;
+    const DELETED_NAME = 16;
        
        /**
         * Load a page revision from a given revision ID number.
         * Returns null if no such revision can be found.
         *
         * @param int $id
-        * @static
         * @access public
+        * @static
         */
-       function newFromId( $id ) {
+       public static function newFromId( $id ) {
                return Revision::newFromConds(
                        array( 'page_id=rev_page',
                               'rev_id' => intval( $id ) ) );
@@ -42,7 +38,7 @@ class Revision {
         * @access public
         * @static
         */
-       function newFromTitle( &$title, $id = 0 ) {
+       public static function newFromTitle( &$title, $id = 0 ) {
                if( $id ) {
                        $matchId = intval( $id );
                } else {
@@ -55,6 +51,21 @@ class Revision {
                               'page_title'     => $title->getDbkey() ) );
        }
 
+       /**
+        * Load a page revision from a given revision ID number.
+        * Returns null if no such revision can be found.
+        *
+        * @param Database $db
+        * @param int $id
+        * @access public
+        * @static
+        */
+       public static function loadFromId( &$db, $id ) {
+               return Revision::loadFromConds( $db,
+                       array( 'page_id=rev_page',
+                              'rev_id' => intval( $id ) ) );
+       }
+
        /**
         * Load either the current, or a specified, revision
         * that's attached to a given page. If not attached
@@ -65,8 +76,9 @@ class Revision {
         * @param int $id
         * @return Revision
         * @access public
+        * @static
         */
-       function loadFromPageId( &$db, $pageid, $id = 0 ) {
+       public static function loadFromPageId( $db, $pageid, $id = 0 ) {
                $conds=array('page_id=rev_page','rev_page'=>intval( $pageid ), 'page_id'=>intval( $pageid ));
                if( $id ) {
                        $conds['rev_id']=intval($id);
@@ -86,8 +98,9 @@ class Revision {
         * @param int $id
         * @return Revision
         * @access public
+        * @static
         */
-       function loadFromTitle( &$db, $title, $id = 0 ) {
+       public static function loadFromTitle( &$db, $title, $id = 0 ) {
                if( $id ) {
                        $matchId = intval( $id );
                } else {
@@ -113,7 +126,7 @@ class Revision {
         * @access public
         * @static
         */
-       function loadFromTimestamp( &$db, &$title, $timestamp ) {
+       public static function loadFromTimestamp( &$db, &$title, $timestamp ) {
                return Revision::loadFromConds(
                        $db,
                        array( 'rev_timestamp'  => $db->timestamp( $timestamp ),
@@ -127,14 +140,14 @@ class Revision {
         *
         * @param array $conditions
         * @return Revision
-        * @static
         * @access private
+        * @static
         */
-       function newFromConds( $conditions ) {
-               $db =& wfGetDB( DB_SLAVE );
+       private static function newFromConds( $conditions ) {
+               $db = wfGetDB( DB_SLAVE );
                $row = Revision::loadFromConds( $db, $conditions );
                if( is_null( $row ) ) {
-                       $dbw =& wfGetDB( DB_MASTER );
+                       $dbw = wfGetDB( DB_MASTER );
                        $row = Revision::loadFromConds( $dbw, $conditions );
                }
                return $row;
@@ -147,10 +160,10 @@ class Revision {
         * @param Database $db
         * @param array $conditions
         * @return Revision
-        * @static
         * @access private
+        * @static
         */
-       function loadFromConds( &$db, $conditions ) {
+       private static function loadFromConds( $db, $conditions ) {
                $res = Revision::fetchFromConds( $db, $conditions );
                if( $res ) {
                        $row = $res->fetchObject();
@@ -171,10 +184,10 @@ class Revision {
         *
         * @param Title $title
         * @return ResultWrapper
-        * @static
         * @access public
+        * @static
         */
-       function fetchAllRevisions( &$title ) {
+       public static function fetchAllRevisions( &$title ) {
                return Revision::fetchFromConds(
                        wfGetDB( DB_SLAVE ),
                        array( 'page_namespace' => $title->getNamespace(),
@@ -189,10 +202,10 @@ class Revision {
         *
         * @param Title $title
         * @return ResultWrapper
-        * @static
         * @access public
+        * @static
         */
-       function fetchRevision( &$title ) {
+       public static function fetchRevision( &$title ) {
                return Revision::fetchFromConds(
                        wfGetDB( DB_SLAVE ),
                        array( 'rev_id=page_latest',
@@ -209,10 +222,10 @@ class Revision {
         * @param Database $db
         * @param array $conditions
         * @return ResultWrapper
-        * @static
         * @access private
+        * @static
         */
-       function fetchFromConds( &$db, $conditions ) {
+       private static function fetchFromConds( $db, $conditions ) {
                $res = $db->select(
                        array( 'page', 'revision' ),
                        array( 'page_namespace',
@@ -259,10 +272,13 @@ class Revision {
                                $this->mTitle = null;
                        }
 
+                       // Lazy extraction...
+                       $this->mText      = null;
                        if( isset( $row->old_text ) ) {
-                               $this->mText  = $this->getRevisionText( $row );
+                               $this->mTextRow = $row;
                        } else {
-                               $this->mText  = null;
+                               // 'text' table row entry will be lazy-loaded
+                               $this->mTextRow = null;
                        }
                } elseif( is_array( $row ) ) {
                        // Build a new revision to be saved...
@@ -280,6 +296,7 @@ class Revision {
                        // Enforce spacing trimming on supplied text
                        $this->mComment   = isset( $row['comment']    ) ?  trim( strval( $row['comment'] ) ) : null;
                        $this->mText      = isset( $row['text']       ) ? rtrim( strval( $row['text']    ) ) : null;
+                       $this->mTextRow   = null;
 
                        $this->mTitle     = null; # Load on demand if needed
                        $this->mCurrent   = false;
@@ -314,7 +331,7 @@ class Revision {
                if( isset( $this->mTitle ) ) {
                        return $this->mTitle;
                }
-               $dbr =& wfGetDB( DB_SLAVE );
+               $dbr = wfGetDB( DB_SLAVE );
                $row = $dbr->selectRow(
                        array( 'page', 'revision' ),
                        array( 'page_namespace', 'page_title' ),
@@ -348,7 +365,7 @@ class Revision {
         * @return int
         */
        function getUser() {
-               if( $this->isDeleted( self::MW_REV_DELETED_USER ) ) {
+               if( $this->isDeleted( self::DELETED_USER ) ) {
                        return 0;
                } else {
                        return $this->mUser;
@@ -368,7 +385,7 @@ class Revision {
         * @return string
         */
        function getUserText() {
-               if( $this->isDeleted( self::MW_REV_DELETED_USER ) ) {
+               if( $this->isDeleted( self::DELETED_USER ) ) {
                        return "";
                } else {
                        return $this->mUserText;
@@ -388,7 +405,7 @@ class Revision {
         * @return string
         */
        function getComment() {
-               if( $this->isDeleted( self::MW_REV_DELETED_COMMENT ) ) {
+               if( $this->isDeleted( self::DELETED_COMMENT ) ) {
                        return "";
                } else {
                        return $this->mComment;
@@ -411,7 +428,7 @@ class Revision {
        }
 
        /**
-        * int $field one of MW_REV_DELETED_* bitfield constants
+        * int $field one of DELETED_* bitfield constants
         * @return bool
         */
        function isDeleted( $field ) {
@@ -423,7 +440,7 @@ class Revision {
         * @return string
         */
        function getText() {
-               if( $this->isDeleted( self::MW_REV_DELETED_TEXT ) ) {
+               if( $this->isDeleted( self::DELETED_TEXT ) ) {
                        return "";
                } else {
                        return $this->getRawText();
@@ -441,6 +458,18 @@ class Revision {
                }
                return $this->mText;
        }
+       
+       /**
+        * Fetch revision text if it's available to THIS user
+        * @return string
+        */
+       function revText() {
+               if( !$this->userCan( self::DELETED_TEXT ) ) {
+                       return "";
+               } else {
+                       return $this->getRawText();
+               }
+       }
 
        /**
         * @return string
@@ -490,7 +519,7 @@ class Revision {
          * @param string $prefix table prefix (default 'old_')
          * @return string $text|false the text requested
          */
-       function getRevisionText( $row, $prefix = 'old_' ) {
+       public static function getRevisionText( $row, $prefix = 'old_' ) {
                $fname = 'Revision::getRevisionText';
                wfProfileIn( $fname );
 
@@ -514,12 +543,11 @@ class Revision {
                # Use external methods for external objects, text in table is URL-only then
                if ( in_array( 'external', $flags ) ) {
                        $url=$text;
-                       @list($proto,$path)=explode('://',$url,2);
+                       @list(/* $proto */,$path)=explode('://',$url,2);
                        if ($path=="") {
                                wfProfileOut( $fname );
                                return false;
                        }
-                       require_once('ExternalStore.php');
                        $text=ExternalStore::fetchFromURL($url);
                }
 
@@ -609,7 +637,6 @@ class Revision {
                        } else {
                                $store = $wgDefaultExternalStore;
                        }
-                       require_once('ExternalStore.php');
                        // Store and get the URL
                        $data = ExternalStore::insert( $store, $data );
                        if ( !$data ) {
@@ -668,15 +695,38 @@ class Revision {
        function loadText() {
                $fname = 'Revision::loadText';
                wfProfileIn( $fname );
-
-               $dbr =& wfGetDB( DB_SLAVE );
-               $row = $dbr->selectRow( 'text',
-                       array( 'old_text', 'old_flags' ),
-                       array( 'old_id' => $this->getTextId() ),
-                       $fname);
+               
+               // Caching may be beneficial for massive use of external storage
+               global $wgRevisionCacheExpiry, $wgMemc;
+               $key = wfMemcKey( 'revisiontext', 'textid', $this->getTextId() );
+               if( $wgRevisionCacheExpiry ) {
+                       $text = $wgMemc->get( $key );
+                       if( is_string( $text ) ) {
+                               wfProfileOut( $fname );
+                               return $text;
+                       }
+               }
+               
+               // If we kept data for lazy extraction, use it now...
+               if ( isset( $this->mTextRow ) ) {
+                       $row = $this->mTextRow;
+                       $this->mTextRow = null;
+               } else {
+                       $row = null;
+               }
+               
+               if( !$row ) {
+                       // Text data is immutable; check slaves first.
+                       $dbr = wfGetDB( DB_SLAVE );
+                       $row = $dbr->selectRow( 'text',
+                               array( 'old_text', 'old_flags' ),
+                               array( 'old_id' => $this->getTextId() ),
+                               $fname);
+               }
 
                if( !$row ) {
-                       $dbw =& wfGetDB( DB_MASTER );
+                       // Possible slave lag!
+                       $dbw = wfGetDB( DB_MASTER );
                        $row = $dbw->selectRow( 'text',
                                array( 'old_text', 'old_flags' ),
                                array( 'old_id' => $this->getTextId() ),
@@ -684,6 +734,11 @@ class Revision {
                }
 
                $text = Revision::getRevisionText( $row );
+               
+               if( $wgRevisionCacheExpiry ) {
+                       $wgMemc->set( $key, $text, $wgRevisionCacheExpiry );
+               }
+               
                wfProfileOut( $fname );
 
                return $text;
@@ -734,15 +789,15 @@ class Revision {
        /**
         * Determine if the current user is allowed to view a particular
         * field of this revision, if it's marked as deleted.
-        * @param int $field one of self::MW_REV_DELETED_TEXT,
-        *                          self::MW_REV_DELETED_COMMENT,
-        *                          self::MW_REV_DELETED_USER
+        * @param int $field one of self::DELETED_TEXT,
+        *                          self::DELETED_COMMENT,
+        *                          self::DELETED_USER
         * @return bool
         */
        function userCan( $field ) {
                if( ( $this->mDeleted & $field ) == $field ) {
                        global $wgUser;
-                       $permission = ( $this->mDeleted & self::MW_REV_DELETED_RESTRICTED ) == self::MW_REV_DELETED_RESTRICTED
+                       $permission = ( $this->mDeleted & self::DELETED_RESTRICTED ) == self::DELETED_RESTRICTED
                                ? 'hiderevision'
                                : 'deleterevision';
                        wfDebug( "Checking for $permission due to $field match on $this->mDeleted\n" );
@@ -752,6 +807,49 @@ class Revision {
                }
        }
 
+
+       /**
+        * Get rev_timestamp from rev_id, without loading the rest of the row
+        * @param integer $id
+        */
+       static function getTimestampFromID( $id ) {
+               $dbr = wfGetDB( DB_SLAVE );
+               $timestamp = $dbr->selectField( 'revision', 'rev_timestamp', 
+                       array( 'rev_id' => $id ), __METHOD__ );
+               if ( $timestamp === false ) {
+                       # Not in slave, try master
+                       $dbw = wfGetDB( DB_MASTER );
+                       $timestamp = $dbw->selectField( 'revision', 'rev_timestamp', 
+                               array( 'rev_id' => $id ), __METHOD__ );
+               }
+               return $timestamp;
+       }
+       
+       static function countByPageId( $db, $id ) {
+               $row = $db->selectRow( 'revision', 'COUNT(*) AS revCount',
+                       array( 'rev_page' => $id ), __METHOD__ );
+               if( $row ) {
+                       return $row->revCount;
+               }
+               return 0;
+       }
+       
+       static function countByTitle( $db, $title ) {
+               $id = $title->getArticleId();
+               if( $id ) {
+                       return Revision::countByPageId( $db, $id );
+               }
+               return 0;
+       }
 }
 
+/**
+ * Aliases for backwards compatibility with 1.6
+ */
+define( 'MW_REV_DELETED_TEXT', Revision::DELETED_TEXT );
+define( 'MW_REV_DELETED_COMMENT', Revision::DELETED_COMMENT );
+define( 'MW_REV_DELETED_USER', Revision::DELETED_USER );
+define( 'MW_REV_DELETED_RESTRICTED', Revision::DELETED_RESTRICTED );
+
+
 ?>