(bug 18821) Delete unused fetchAllRevisions(), which doesn't do what it says anyway.
[lhc/web/wiklou.git] / includes / Revision.php
index 3eaf50b..f53dbac 100644 (file)
@@ -1,6 +1,7 @@
 <?php
 /**
  * @todo document
+ * @file
  */
 
 /**
@@ -12,6 +13,11 @@ class Revision {
        const DELETED_USER = 4;
        const DELETED_RESTRICTED = 8;
 
+       // Audience options for Revision::getText()
+       const FOR_PUBLIC = 1;
+       const FOR_THIS_USER = 2;
+       const RAW = 3;
+
        /**
         * Load a page revision from a given revision ID number.
         * Returns null if no such revision can be found.
@@ -34,20 +40,54 @@ class Revision {
         * @param Title $title
         * @param int $id
         * @return Revision
-        * @access public
-        * @static
         */
-       public static function newFromTitle( &$title, $id = 0 ) {
-               if( $id ) {
-                       $matchId = intval( $id );
+       public static function newFromTitle( $title, $id = 0 ) {
+               $conds = array( 
+                       'page_namespace' => $title->getNamespace(), 
+                       'page_title' => $title->getDBkey()
+               );
+               if ( $id ) {
+                       // Use the specified ID
+                       $conds['rev_id'] = $id;
+               } elseif ( wfGetLB()->getServerCount() > 1 ) {
+                       // Get the latest revision ID from the master
+                       $dbw = wfGetDB( DB_MASTER );
+                       $latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__ );
+                       if ( $latest === false ) {
+                               // Page does not exist
+                               return null;
+                       }
+                       $conds['rev_id'] = $latest;
                } else {
-                       $matchId = 'page_latest';
+                       // Use a join to get the latest revision
+                       $conds[] = 'rev_id=page_latest';
                }
-               return Revision::newFromConds(
-                       array( "rev_id=$matchId",
-                              'page_id=rev_page',
-                              'page_namespace' => $title->getNamespace(),
-                              'page_title'     => $title->getDBkey() ) );
+               $conds[] = 'page_id=rev_page';
+               return Revision::newFromConds( $conds );
+       }
+
+       /**
+        * Make a fake revision object from an archive table row. This is queried
+        * for permissions or even inserted (as in Special:Undelete)
+        * @fixme: should be a subclass for RevisionDelete. [TS]
+        */
+       public static function newFromArchiveRow( $row, $overrides = array() ) {
+               $attribs = $overrides + array(
+                       'page'       => isset( $row->page_id ) ? $row->page_id : null,
+                       'id'         => isset( $row->ar_rev_id ) ? $row->ar_rev_id : null,
+                       'comment'    => $row->ar_comment,
+                       'user'       => $row->ar_user,
+                       'user_text'  => $row->ar_user_text,
+                       'timestamp'  => $row->ar_timestamp,
+                       'minor_edit' => $row->ar_minor_edit,
+                       'text_id'    => isset( $row->ar_text_id ) ? $row->ar_text_id : null,
+                       'deleted'    => $row->ar_deleted,
+                       'len'        => $row->ar_len);
+               if ( isset( $row->ar_text ) && !$row->ar_text_id ) {
+                       // Pre-1.5 ar_text row
+                       $attribs['text'] = $row->ar_text;
+               }
+               return new self( $attribs );
        }
 
        /**
@@ -59,7 +99,7 @@ class Revision {
         * @access public
         * @static
         */
-       public static function loadFromId( &$db, $id ) {
+       public static function loadFromId( $db, $id ) {
                return Revision::loadFromConds( $db,
                        array( 'page_id=rev_page',
                               'rev_id' => intval( $id ) ) );
@@ -99,7 +139,7 @@ class Revision {
         * @access public
         * @static
         */
-       public static function loadFromTitle( &$db, $title, $id = 0 ) {
+       public static function loadFromTitle( $db, $title, $id = 0 ) {
                if( $id ) {
                        $matchId = intval( $id );
                } else {
@@ -125,7 +165,7 @@ class Revision {
         * @access public
         * @static
         */
-       public static function loadFromTimestamp( &$db, &$title, $timestamp ) {
+       public static function loadFromTimestamp( $db, $title, $timestamp ) {
                return Revision::loadFromConds(
                        $db,
                        array( 'rev_timestamp'  => $db->timestamp( $timestamp ),
@@ -145,7 +185,7 @@ class Revision {
        private static function newFromConds( $conditions ) {
                $db = wfGetDB( DB_SLAVE );
                $row = Revision::loadFromConds( $db, $conditions );
-               if( is_null( $row ) ) {
+               if( is_null( $row ) && wfGetLB()->getServerCount() > 1 ) {
                        $dbw = wfGetDB( DB_MASTER );
                        $row = Revision::loadFromConds( $dbw, $conditions );
                }
@@ -186,25 +226,7 @@ class Revision {
         * @access public
         * @static
         */
-       public static function fetchAllRevisions( &$title ) {
-               return Revision::fetchFromConds(
-                       wfGetDB( DB_SLAVE ),
-                       array( 'page_namespace' => $title->getNamespace(),
-                              'page_title'     => $title->getDBkey(),
-                              'page_id=rev_page' ) );
-       }
-
-       /**
-        * Return a wrapper for a series of database rows to
-        * fetch all of a given page's revisions in turn.
-        * Each row can be fed to the constructor to get objects.
-        *
-        * @param Title $title
-        * @return ResultWrapper
-        * @access public
-        * @static
-        */
-       public static function fetchRevision( &$title ) {
+       public static function fetchRevision( $title ) {
                return Revision::fetchFromConds(
                        wfGetDB( DB_SLAVE ),
                        array( 'rev_id=page_latest',
@@ -233,7 +255,7 @@ class Revision {
                        array( 'page', 'revision' ),
                        $fields,
                        $conditions,
-                       'Revision::fetchRow',
+                       __METHOD__,
                        array( 'LIMIT' => 1 ) );
                $ret = $db->resultObject( $res );
                return $ret;
@@ -258,6 +280,27 @@ class Revision {
                        'rev_parent_id'
                );
        }
+       
+       /**
+        * Return the list of text fields that should be selected to read the 
+        * revision text
+        */
+       static function selectTextFields() {
+               return array(
+                       'old_text',
+                       'old_flags'
+               );
+       }
+       /**
+        * Return the list of page fields that should be selected from page table
+        */
+       static function selectPageFields() {
+               return array(
+                       'page_namespace',
+                       'page_title',
+                       'page_latest'
+               );
+       }
 
        /**
         * @param object $row
@@ -286,9 +329,9 @@ class Revision {
                                $this->mSize = intval( $row->rev_len );
 
                        if( isset( $row->page_latest ) ) {
-                               $this->mCurrent   = ( $row->rev_id == $row->page_latest );
-                               $this->mTitle     = Title::makeTitle( $row->page_namespace,
-                                                                     $row->page_title );
+                               $this->mCurrent = ( $row->rev_id == $row->page_latest );
+                               $this->mTitle = Title::makeTitle( $row->page_namespace, $row->page_title );
+                               $this->mTitle->resetArticleID( $this->mPage );
                        } else {
                                $this->mCurrent = false;
                                $this->mTitle = null;
@@ -330,6 +373,7 @@ class Revision {
                } else {
                        throw new MWException( 'Revision constructor passed invalid row format.' );
                }
+               $this->mUnpatrolled = NULL;
        }
 
        /**#@+
@@ -385,7 +429,7 @@ class Revision {
                        'Revision::getTitle' );
                if( $row ) {
                        $this->mTitle = Title::makeTitle( $row->page_namespace,
-                                                          $row->page_title );
+                                                         $row->page_title );
                }
                return $this->mTitle;
        }
@@ -407,11 +451,22 @@ class Revision {
        }
 
        /**
-        * Fetch revision's user id if it's available to all users
+        * Fetch revision's user id if it's available to the specified audience.
+        * If the specified audience does not have access to it, zero will be 
+        * returned.
+        *
+        * @param integer $audience One of:
+        *      Revision::FOR_PUBLIC       to be displayed to all users
+        *      Revision::FOR_THIS_USER    to be displayed to $wgUser
+        *      Revision::RAW              get the ID regardless of permissions
+        *
+        *
         * @return int
         */
-       public function getUser() {
-               if( $this->isDeleted( self::DELETED_USER ) ) {
+       public function getUser( $audience = self::FOR_PUBLIC ) {
+               if( $audience == self::FOR_PUBLIC && $this->isDeleted( self::DELETED_USER ) ) {
+                       return 0;
+               } elseif( $audience == self::FOR_THIS_USER && !$this->userCan( self::DELETED_USER ) ) {
                        return 0;
                } else {
                        return $this->mUser;
@@ -427,11 +482,21 @@ class Revision {
        }
 
        /**
-        * Fetch revision's username if it's available to all users
+        * Fetch revision's username if it's available to the specified audience.
+        * If the specified audience does not have access to the username, an 
+        * empty string will be returned.
+        *
+        * @param integer $audience One of:
+        *      Revision::FOR_PUBLIC       to be displayed to all users
+        *      Revision::FOR_THIS_USER    to be displayed to $wgUser
+        *      Revision::RAW              get the text regardless of permissions
+        *
         * @return string
         */
-       public function getUserText() {
-               if( $this->isDeleted( self::DELETED_USER ) ) {
+       public function getUserText( $audience = self::FOR_PUBLIC ) {
+               if( $audience == self::FOR_PUBLIC && $this->isDeleted( self::DELETED_USER ) ) {
+                       return "";
+               } elseif( $audience == self::FOR_THIS_USER && !$this->userCan( self::DELETED_USER ) ) {
                        return "";
                } else {
                        return $this->mUserText;
@@ -447,11 +512,21 @@ class Revision {
        }
 
        /**
-        * Fetch revision comment if it's available to all users
+        * Fetch revision comment if it's available to the specified audience.
+        * If the specified audience does not have access to the comment, an 
+        * empty string will be returned.
+        *
+        * @param integer $audience One of:
+        *      Revision::FOR_PUBLIC       to be displayed to all users
+        *      Revision::FOR_THIS_USER    to be displayed to $wgUser
+        *      Revision::RAW              get the text regardless of permissions
+        *
         * @return string
         */
-       function getComment() {
-               if( $this->isDeleted( self::DELETED_COMMENT ) ) {
+       function getComment( $audience = self::FOR_PUBLIC ) {
+               if( $audience == self::FOR_PUBLIC && $this->isDeleted( self::DELETED_COMMENT ) ) {
+                       return "";
+               } elseif( $audience == self::FOR_THIS_USER && !$this->userCan( self::DELETED_COMMENT ) ) {
                        return "";
                } else {
                        return $this->mComment;
@@ -472,6 +547,27 @@ class Revision {
        public function isMinor() {
                return (bool)$this->mMinorEdit;
        }
+       
+       /**
+        * @return int rcid of the unpatrolled row, zero if there isn't one
+        */
+       public function isUnpatrolled() {
+               if( $this->mUnpatrolled !== NULL ) {
+                       return $this->mUnpatrolled;
+               }
+               $dbr = wfGetDB( DB_SLAVE );
+               $this->mUnpatrolled = $dbr->selectField( 'recentchanges',
+                       'rc_id',
+                       array( // Add redundant user,timestamp condition so we can use the existing index
+                               'rc_user_text'  => $this->getRawUserText(),
+                               'rc_timestamp'  => $dbr->timestamp( $this->getTimestamp() ),
+                               'rc_this_oldid' => $this->getId(),
+                               'rc_patrolled'  => 0
+                       ),
+                       __METHOD__
+               );
+               return (int)$this->mUnpatrolled;
+       }
 
        /**
         * int $field one of DELETED_* bitfield constants
@@ -480,19 +576,44 @@ class Revision {
        public function isDeleted( $field ) {
                return ($this->mDeleted & $field) == $field;
        }
+       
+       /**
+        * Get the deletion bitfield of the revision
+        */     
+       public function getVisibility() {
+               return (int)$this->mDeleted;
+       }
 
        /**
-        * Fetch revision text if it's available to all users
+        * Fetch revision text if it's available to the specified audience.
+        * If the specified audience does not have the ability to view this 
+        * revision, an empty string will be returned.
+        *
+        * @param integer $audience One of:
+        *      Revision::FOR_PUBLIC       to be displayed to all users
+        *      Revision::FOR_THIS_USER    to be displayed to $wgUser
+        *      Revision::RAW              get the text regardless of permissions
+        *
+        *
         * @return string
         */
-       public function getText() {
-               if( $this->isDeleted( self::DELETED_TEXT ) ) {
+       public function getText( $audience = self::FOR_PUBLIC ) {
+               if( $audience == self::FOR_PUBLIC && $this->isDeleted( self::DELETED_TEXT ) ) {
+                       return "";
+               } elseif( $audience == self::FOR_THIS_USER && !$this->userCan( self::DELETED_TEXT ) ) {
                        return "";
                } else {
                        return $this->getRawText();
                }
        }
 
+       /**
+        * Alias for getText(Revision::FOR_THIS_USER)
+        */
+       public function revText() {
+               return $this->getText( self::FOR_THIS_USER );
+       }
+
        /**
         * Fetch revision text without regard for view restrictions
         * @return string
@@ -505,18 +626,6 @@ class Revision {
                return $this->mText;
        }
 
-       /**
-        * Fetch revision text if it's available to THIS user
-        * @return string
-        */
-       public function revText() {
-               if( !$this->userCan( self::DELETED_TEXT ) ) {
-                       return "";
-               } else {
-                       return $this->getRawText();
-               }
-       }
-
        /**
         * @return string
         */
@@ -536,24 +645,26 @@ class Revision {
         * @return Revision
         */
        public function getPrevious() {
-               $prev = $this->mTitle->getPreviousRevisionID( $this->mId );
-               if( $prev ) {
-                       return Revision::newFromTitle( $this->mTitle, $prev );
-               } else {
-                       return null;
+               if( $this->getTitle() ) {
+                       $prev = $this->getTitle()->getPreviousRevisionID( $this->getId() );
+                       if( $prev ) {
+                               return Revision::newFromTitle( $this->getTitle(), $prev );
+                       }
                }
+               return null;
        }
 
        /**
         * @return Revision
         */
        public function getNext() {
-               $next = $this->mTitle->getNextRevisionID( $this->mId );
-               if ( $next ) {
-                       return Revision::newFromTitle( $this->mTitle, $next );
-               } else {
-                       return null;
+               if( $this->getTitle() ) {
+                       $next = $this->getTitle()->getNextRevisionID( $this->getId() );
+                       if ( $next ) {
+                               return Revision::newFromTitle( $this->getTitle(), $next );
+                       }
                }
+               return null;
        }
 
        /**
@@ -585,7 +696,7 @@ class Revision {
          * $row is usually an object from wfFetchRow(), both the flags and the text
          * field must be included
          *
-         * @param integer $row Id of a row
+         * @param object $row The text data
          * @param string $prefix table prefix (default 'old_')
          * @return string $text|false the text requested
          */
@@ -641,9 +752,11 @@ class Revision {
                        }
 
                        global $wgLegacyEncoding;
-                       if( $wgLegacyEncoding && !in_array( 'utf-8', $flags ) ) {
+                       if( $wgLegacyEncoding && !in_array( 'utf-8', $flags ) && !in_array( 'utf8', $flags ) ) {
                                # Old revisions kept around in a legacy encoding?
                                # Upconvert on demand.
+                               # ("utf8" checked for compatibility with some broken
+                               #  conversion scripts 2008-12-30)
                                global $wgInputEncoding, $wgContLang;
                                $text = $wgContLang->iconv( $wgLegacyEncoding, $wgInputEncoding, $text );
                        }
@@ -688,7 +801,7 @@ class Revision {
         * @param Database $dbw
         * @return int
         */
-       public function insertOn( &$dbw ) {
+       public function insertOn( $dbw ) {
                global $wgDefaultExternalStore;
 
                wfProfileIn( __METHOD__ );
@@ -697,20 +810,13 @@ class Revision {
                $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;
-                       }
+               if( $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" );
+                       $data = ExternalStore::insertToDefault( $data );
+                       if( !$data ) {
+                               throw new MWException( "Unable to store text to external storage" );
                        }
-                       if ( $flags ) {
+                       if( $flags ) {
                                $flags .= ',';
                        }
                        $flags .= 'external';
@@ -745,11 +851,15 @@ class Revision {
                                'rev_timestamp'  => $dbw->timestamp( $this->mTimestamp ),
                                'rev_deleted'    => $this->mDeleted,
                                'rev_len'            => $this->mSize,
-                               'rev_parent_id'  => $this->mParentId ? $this->mParentId : $this->getPreviousRevisionId( $dbw )
+                               'rev_parent_id'  => is_null($this->mParentId) ?
+                                       $this->getPreviousRevisionId( $dbw ) : $this->mParentId
                        ), __METHOD__
                );
 
                $this->mId = !is_null($rev_id) ? $rev_id : $dbw->insertId();
+               
+               wfRunHooks( 'RevisionInsertComplete', array( &$this, $data, $flags ) );
+               
                wfProfileOut( __METHOD__ );
                return $this->mId;
        }
@@ -760,15 +870,17 @@ class Revision {
         *
         * @return string
         */
-       private function loadText() {
+       protected function loadText() {
                wfProfileIn( __METHOD__ );
 
                // Caching may be beneficial for massive use of external storage
                global $wgRevisionCacheExpiry, $wgMemc;
-               $key = wfMemcKey( 'revisiontext', 'textid', $this->getTextId() );
+               $textId = $this->getTextId();
+               $key = wfMemcKey( 'revisiontext', 'textid', $textId );
                if( $wgRevisionCacheExpiry ) {
                        $text = $wgMemc->get( $key );
                        if( is_string( $text ) ) {
+                               wfDebug( __METHOD__. ": got id $textId from cache\n" );
                                wfProfileOut( __METHOD__ );
                                return $text;
                        }
@@ -791,7 +903,7 @@ class Revision {
                                __METHOD__ );
                }
 
-               if( !$row ) {
+               if( !$row && wfGetLB()->getServerCount() > 1 ) {
                        // Possible slave lag!
                        $dbw = wfGetDB( DB_MASTER );
                        $row = $dbw->selectRow( 'text',
@@ -802,7 +914,8 @@ class Revision {
 
                $text = self::getRevisionText( $row );
 
-               if( $wgRevisionCacheExpiry ) {
+               # No negative caching -- negative hits on text rows may be due to corrupted slave servers
+               if( $wgRevisionCacheExpiry && $text !== false ) {
                        $wgMemc->set( $key, $text, $wgRevisionCacheExpiry );
                }
 
@@ -825,12 +938,12 @@ class Revision {
         * @param bool     $minor
         * @return Revision
         */
-       public static function newNullRevision( &$dbw, $pageId, $summary, $minor ) {
+       public static function newNullRevision( $dbw, $pageId, $summary, $minor ) {
                wfProfileIn( __METHOD__ );
 
                $current = $dbw->selectRow(
                        array( 'page', 'revision' ),
-                       array( 'page_latest', 'rev_text_id' ),
+                       array( 'page_latest', 'rev_text_id', 'rev_len' ),
                        array(
                                'page_id' => $pageId,
                                'page_latest=rev_id',
@@ -843,7 +956,8 @@ class Revision {
                                'comment'    => $summary,
                                'minor_edit' => $minor,
                                'text_id'    => $current->rev_text_id,
-                               'parent_id'  => $current->page_latest
+                               'parent_id'  => $current->page_latest,
+                               'len'        => $current->rev_len
                                ) );
                } else {
                        $revision = null;
@@ -865,7 +979,7 @@ class Revision {
                if( ( $this->mDeleted & $field ) == $field ) {
                        global $wgUser;
                        $permission = ( $this->mDeleted & self::DELETED_RESTRICTED ) == self::DELETED_RESTRICTED
-                               ? 'hiderevision'
+                               ? 'suppressrevision'
                                : 'deleterevision';
                        wfDebug( "Checking for $permission due to $field match on $this->mDeleted\n" );
                        return $wgUser->isAllowed( $permission );
@@ -877,19 +991,24 @@ class Revision {
 
        /**
         * Get rev_timestamp from rev_id, without loading the rest of the row
+        * @param Title $title
         * @param integer $id
         */
-       static function getTimestampFromID( $id ) {
+       static function getTimestampFromId( $title, $id ) {
                $dbr = wfGetDB( DB_SLAVE );
-               $timestamp = $dbr->selectField( 'revision', 'rev_timestamp',
-                       array( 'rev_id' => $id ), __METHOD__ );
-               if ( $timestamp === false ) {
+               // Casting fix for DB2
+               if ($id == '') {
+                       $id = 0;
+               }
+               $conds = array( 'rev_id' => $id );
+               $conds['rev_page'] = $title->getArticleId();
+               $timestamp = $dbr->selectField( 'revision', 'rev_timestamp', $conds, __METHOD__ );
+               if ( $timestamp === false && wfGetLB()->getServerCount() > 1 ) {
                        # Not in slave, try master
                        $dbw = wfGetDB( DB_MASTER );
-                       $timestamp = $dbw->selectField( 'revision', 'rev_timestamp',
-                               array( 'rev_id' => $id ), __METHOD__ );
+                       $timestamp = $dbw->selectField( 'revision', 'rev_timestamp', $conds, __METHOD__ );
                }
-               return $timestamp;
+               return wfTimestamp( TS_MW, $timestamp );
        }
 
        /**