* Some enhancements to live preview
[lhc/web/wiklou.git] / includes / Revision.php
index 1a367f0..f5a84ca 100644 (file)
@@ -1,27 +1,27 @@
 <?php
 /**
- * @package MediaWiki
  * @todo document
  */
 
-/** */
-require_once( 'Database.php' );
-require_once( 'Article.php' );
-
 /**
- * @package MediaWiki
  * @todo document
  */
 class Revision {
+       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 ) ) );
@@ -38,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 {
@@ -51,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
@@ -61,19 +76,16 @@ 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 ) {
-                       $matchId = intval( $id );
+                       $conds['rev_id']=intval($id);
                } else {
-                       $matchId = 'page_latest';
+                       $conds[]='rev_id=page_latest';
                }
-               $ret = Revision::loadFromConds(
-                       $db,
-                       array( "rev_id=$matchId",
-                              'rev_page' => intval( $pageid ),
-                              'page_id=rev_page' ) );
-               return $ret;
+               return Revision::loadFromConds( $db, $conds );
        }
 
        /**
@@ -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',
@@ -250,14 +263,22 @@ class Revision {
                        $this->mTimestamp =         $row->rev_timestamp;
                        $this->mDeleted   = intval( $row->rev_deleted );
 
-                       $this->mCurrent   = ( $row->rev_id == $row->page_latest );
-                       $this->mTitle     = Title::makeTitle( $row->page_namespace,
-                                                             $row->page_title );
+                       if( isset( $row->page_latest ) ) {
+                               $this->mCurrent   = ( $row->rev_id == $row->page_latest );
+                               $this->mTitle     = Title::makeTitle( $row->page_namespace,
+                                                                     $row->page_title );
+                       } else {
+                               $this->mCurrent = false;
+                               $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...
@@ -275,11 +296,12 @@ 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;
                } else {
-                       wfDebugDieBacktrace( 'Revision constructor passed invalid row format.' );
+                       throw new MWException( 'Revision constructor passed invalid row format.' );
                }
        }
 
@@ -309,13 +331,13 @@ 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' ),
                        array( 'page_id=rev_page',
                               'rev_id' => $this->mId ),
-                       'Revision::getTItle' );
+                       'Revision::getTitle' );
                if( $row ) {
                        $this->mTitle = Title::makeTitle( $row->page_namespace,
                                                           $row->page_title );
@@ -323,6 +345,14 @@ class Revision {
                return $this->mTitle;
        }
 
+       /**
+        * Set the title of the revision
+        * @param Title $title
+        */
+       function setTitle( $title ) {
+               $this->mTitle = $title;
+       }
+
        /**
         * @return int
         */
@@ -331,23 +361,62 @@ class Revision {
        }
 
        /**
+        * Fetch revision's user id if it's available to all users
         * @return int
         */
        function getUser() {
+               if( $this->isDeleted( self::DELETED_USER ) ) {
+                       return 0;
+               } else {
+                       return $this->mUser;
+               }
+       }
+
+       /**
+        * Fetch revision's user id without regard for the current user's permissions
+        * @return string
+        */
+       function getRawUser() {
                return $this->mUser;
        }
 
        /**
+        * Fetch revision's username if it's available to all users
         * @return string
         */
        function getUserText() {
-               return $this->mUserText;
+               if( $this->isDeleted( self::DELETED_USER ) ) {
+                       return "";
+               } else {
+                       return $this->mUserText;
+               }
        }
 
        /**
+        * Fetch revision's username without regard for view restrictions
+        * @return string
+        */
+       function getRawUserText() {
+               return $this->mUserText;
+       }
+       
+       /**
+        * Fetch revision comment if it's available to all users
         * @return string
         */
        function getComment() {
+               if( $this->isDeleted( self::DELETED_COMMENT ) ) {
+                       return "";
+               } else {
+                       return $this->mComment;
+               }
+       }
+
+       /**
+        * Fetch revision comment without regard for the current user's permissions
+        * @return string
+        */
+       function getRawComment() {
                return $this->mComment;
        }
 
@@ -359,22 +428,48 @@ class Revision {
        }
 
        /**
+        * int $field one of DELETED_* bitfield constants
         * @return bool
         */
-       function isDeleted() {
-               return (bool)$this->mDeleted;
+       function isDeleted( $field ) {
+               return ($this->mDeleted & $field) == $field;
        }
 
        /**
+        * Fetch revision text if it's available to all users
         * @return string
         */
        function getText() {
+               if( $this->isDeleted( self::DELETED_TEXT ) ) {
+                       return "";
+               } else {
+                       return $this->getRawText();
+               }
+       }
+       
+       /**
+        * Fetch revision text without regard for view restrictions
+        * @return string
+        */
+       function getRawText() {
                if( is_null( $this->mText ) ) {
                        // Revision text is immutable. Load on demand:
                        $this->mText = $this->loadText();
                }
                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
@@ -395,7 +490,11 @@ class Revision {
         */
        function getPrevious() {
                $prev = $this->mTitle->getPreviousRevisionID( $this->mId );
-               return Revision::newFromTitle( $this->mTitle, $prev );
+               if ( $prev ) {
+                       return Revision::newFromTitle( $this->mTitle, $prev );
+               } else {
+                       return null;
+               }
        }
 
        /**
@@ -403,7 +502,11 @@ class Revision {
         */
        function getNext() {
                $next = $this->mTitle->getNextRevisionID( $this->mId );
-               return Revision::newFromTitle( $this->mTitle, $next );
+               if ( $next ) {
+                       return Revision::newFromTitle( $this->mTitle, $next );
+               } else {
+                       return null;
+               }
        }
        /**#@-*/
 
@@ -416,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 );
 
@@ -440,40 +543,41 @@ 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);
                }
 
-               if( in_array( 'gzip', $flags ) ) {
-                       # Deal with optional compression of archived pages.
-                       # This can be done periodically via maintenance/compressOld.php, and
-                       # as pages are saved if $wgCompressRevisions is set.
-                       $text = gzinflate( $text );
-               }
-
-               if( in_array( 'object', $flags ) ) {
-                       # Generic compressed storage
-                       $obj = unserialize( $text );
-
-                       # Bugger, corrupted my test database by double-serializing
-                       if ( !is_object( $obj ) ) {
-                               $obj = unserialize( $obj );
+               // If the text was fetched without an error, convert it
+               if ( $text !== false ) {
+                       if( in_array( 'gzip', $flags ) ) {
+                               # Deal with optional compression of archived pages.
+                               # This can be done periodically via maintenance/compressOld.php, and
+                               # as pages are saved if $wgCompressRevisions is set.
+                               $text = gzinflate( $text );
                        }
 
-                       $text = $obj->getText();
-               }
+                       if( in_array( 'object', $flags ) ) {
+                               # Generic compressed storage
+                               $obj = unserialize( $text );
+                               if ( !is_object( $obj ) ) {
+                                       // Invalid object
+                                       wfProfileOut( $fname );
+                                       return false;
+                               }
+                               $text = $obj->getText();
+                       }
 
-               global $wgLegacyEncoding;
-               if( $wgLegacyEncoding && !in_array( 'utf-8', $flags ) ) {
-                       # Old revisions kept around in a legacy encoding?
-                       # Upconvert on demand.
-                       global $wgInputEncoding, $wgContLang;
-                       $text = $wgContLang->iconv( $wgLegacyEncoding, $wgInputEncoding . '//IGNORE', $text );
+                       global $wgLegacyEncoding;
+                       if( $wgLegacyEncoding && !in_array( 'utf-8', $flags ) ) {
+                               # Old revisions kept around in a legacy encoding?
+                               # Upconvert on demand.
+                               global $wgInputEncoding, $wgContLang;
+                               $text = $wgContLang->iconv( $wgLegacyEncoding, $wgInputEncoding . '//IGNORE', $text );
+                       }
                }
                wfProfileOut( $fname );
                return $text;
@@ -517,19 +621,41 @@ class Revision {
         * @return int
         */
        function insertOn( &$dbw ) {
+               global $wgDefaultExternalStore;
+               
                $fname = 'Revision::insertOn';
                wfProfileIn( $fname );
 
-               $mungedText = $this->mText;
-               $flags = Revision::compressRevisionText( $mungedText );
+               $data = $this->mText;
+               $flags = Revision::compressRevisionText( $data );
+
+               # Write to external storage if required
+               if ( $wgDefaultExternalStore ) {
+                       if ( is_array( $wgDefaultExternalStore ) ) {
+                               // Distribute storage across multiple clusters
+                               $store = $wgDefaultExternalStore[mt_rand(0, count( $wgDefaultExternalStore ) - 1)];
+                       } else {
+                               $store = $wgDefaultExternalStore;
+                       }
+                       // Store and get the URL
+                       $data = ExternalStore::insert( $store, $data );
+                       if ( !$data ) {
+                               # This should only happen in the case of a configuration error, where the external store is not valid
+                               throw new MWException( "Unable to store text to external storage $store" );
+                       }
+                       if ( $flags ) {
+                               $flags .= ',';
+                       }
+                       $flags .= 'external';
+               }
 
-               # Record the text to the text table
+               # Record the text (or external storage URL) to the text table
                if( !isset( $this->mTextId ) ) {
                        $old_id = $dbw->nextSequenceValue( 'text_old_id_val' );
                        $dbw->insert( 'text',
                                array(
                                        'old_id'    => $old_id,
-                                       'old_text'  => $mungedText,
+                                       'old_text'  => $data,
                                        'old_flags' => $flags,
                                ), $fname
                        );
@@ -555,7 +681,6 @@ class Revision {
                );
 
                $this->mId = !is_null($rev_id) ? $rev_id : $dbw->insertId();
-
                wfProfileOut( $fname );
                return $this->mId;
        }
@@ -570,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() ),
@@ -586,6 +734,11 @@ class Revision {
                }
 
                $text = Revision::getRevisionText( $row );
+               
+               if( $wgRevisionCacheExpiry ) {
+                       $wgMemc->set( $key, $text, $wgRevisionCacheExpiry );
+               }
+               
                wfProfileOut( $fname );
 
                return $text;
@@ -632,6 +785,71 @@ class Revision {
                wfProfileOut( $fname );
                return $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::DELETED_TEXT,
+        *                          self::DELETED_COMMENT,
+        *                          self::DELETED_USER
+        * @return bool
+        */
+       function userCan( $field ) {
+               if( ( $this->mDeleted & $field ) == $field ) {
+                       global $wgUser;
+                       $permission = ( $this->mDeleted & self::DELETED_RESTRICTED ) == self::DELETED_RESTRICTED
+                               ? 'hiderevision'
+                               : 'deleterevision';
+                       wfDebug( "Checking for $permission due to $field match on $this->mDeleted\n" );
+                       return $wgUser->isAllowed( $permission );
+               } else {
+                       return true;
+               }
+       }
+
 
+       /**
+        * 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 );
+
+
 ?>