Be consistent with filearchive system and use whole key. This is a modified version...
[lhc/web/wiklou.git] / includes / Revision.php
index 93b92a9..20f2d0d 100644 (file)
@@ -10,9 +10,8 @@ class Revision {
        const DELETED_TEXT = 1;
        const DELETED_COMMENT = 2;
        const DELETED_USER = 4;
-    const DELETED_RESTRICTED = 8;
-    const DELETED_NAME = 16;
-       
+       const DELETED_RESTRICTED = 8;
+
        /**
         * Load a page revision from a given revision ID number.
         * Returns null if no such revision can be found.
@@ -48,7 +47,7 @@ class Revision {
                        array( "rev_id=$matchId",
                               'page_id=rev_page',
                               'page_namespace' => $title->getNamespace(),
-                              'page_title'     => $title->getDbkey() ) );
+                              'page_title'     => $title->getDBkey() ) );
        }
 
        /**
@@ -111,7 +110,7 @@ class Revision {
                        array( "rev_id=$matchId",
                               'page_id=rev_page',
                               'page_namespace' => $title->getNamespace(),
-                              'page_title'     => $title->getDbkey() ) );
+                              'page_title'     => $title->getDBkey() ) );
        }
 
        /**
@@ -132,7 +131,7 @@ class Revision {
                        array( 'rev_timestamp'  => $db->timestamp( $timestamp ),
                               'page_id=rev_page',
                               'page_namespace' => $title->getNamespace(),
-                              'page_title'     => $title->getDbkey() ) );
+                              'page_title'     => $title->getDBkey() ) );
        }
 
        /**
@@ -191,7 +190,7 @@ class Revision {
                return Revision::fetchFromConds(
                        wfGetDB( DB_SLAVE ),
                        array( 'page_namespace' => $title->getNamespace(),
-                              'page_title'     => $title->getDbkey(),
+                              'page_title'     => $title->getDBkey(),
                               'page_id=rev_page' ) );
        }
 
@@ -210,7 +209,7 @@ class Revision {
                        wfGetDB( DB_SLAVE ),
                        array( 'rev_id=page_latest',
                               'page_namespace' => $title->getNamespace(),
-                              'page_title'     => $title->getDbkey(),
+                              'page_title'     => $title->getDBkey(),
                               'page_id=rev_page' ) );
        }
 
@@ -226,21 +225,13 @@ class Revision {
         * @static
         */
        private static function fetchFromConds( $db, $conditions ) {
+               $fields = self::selectFields();
+               $fields[] = 'page_namespace';
+               $fields[] = 'page_title';
+               $fields[] = 'page_latest';
                $res = $db->select(
                        array( 'page', 'revision' ),
-                       array( 'page_namespace',
-                              'page_title',
-                              'page_latest',
-                              'rev_id',
-                              'rev_page',
-                              'rev_text_id',
-                              'rev_comment',
-                              'rev_user_text',
-                              'rev_user',
-                              'rev_minor_edit',
-                              'rev_timestamp',
-                              'rev_deleted',
-                              'rev_len' ),
+                       $fields,
                        $conditions,
                        'Revision::fetchRow',
                        array( 'LIMIT' => 1 ) );
@@ -248,6 +239,26 @@ class Revision {
                return $ret;
        }
 
+       /**
+        * Return the list of revision fields that should be selected to create 
+        * a new revision.
+        */
+       static function selectFields() {
+               return array( 
+                       'rev_id',
+                       'rev_page',
+                       'rev_text_id',
+                       'rev_timestamp',
+                       'rev_comment',
+                       'rev_user_text,'.
+                       'rev_user',
+                       'rev_minor_edit',
+                       'rev_deleted',
+                       'rev_len',
+                       'rev_parent_id'
+               );
+       }
+
        /**
         * @param object $row
         * @access private
@@ -263,8 +274,13 @@ class Revision {
                        $this->mMinorEdit = intval( $row->rev_minor_edit );
                        $this->mTimestamp =         $row->rev_timestamp;
                        $this->mDeleted   = intval( $row->rev_deleted );
-
-                       if( !isset( $row->rev_len ) )
+                       
+                       if( !isset( $row->rev_parent_id ) )
+                               $this->mParentId = is_null($row->rev_parent_id) ? null : 0;
+                       else
+                               $this->mParentId  = intval( $row->rev_parent_id );
+                       
+                       if( !isset( $row->rev_len ) || is_null( $row->rev_len ) )
                                $this->mSize = null;
                        else
                                $this->mSize = intval( $row->rev_len ); 
@@ -298,7 +314,9 @@ class Revision {
                        $this->mMinorEdit = isset( $row['minor_edit'] ) ? intval( $row['minor_edit'] ) : 0;
                        $this->mTimestamp = isset( $row['timestamp']  ) ? strval( $row['timestamp']  ) : wfTimestamp( TS_MW );
                        $this->mDeleted   = isset( $row['deleted']    ) ? intval( $row['deleted']    ) : 0;
-
+                       $this->mSize      = isset( $row['len']        ) ? intval( $row['len']        ) : null;
+                       $this->mParentId  = isset( $row['parent_id']  ) ? intval( $row['parent_id']  ) : null;
+                       
                        // 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;
@@ -306,8 +324,9 @@ class Revision {
 
                        $this->mTitle     = null; # Load on demand if needed
                        $this->mCurrent   = false;
-
-                       $this->mSize      = is_null($this->mText) ? null : mb_strlen($this->mText);
+                       # If we still have no len_size, see it we have the text to figure it out
+                       if ( !$this->mSize )
+                               $this->mSize      = is_null($this->mText) ? null : strlen($this->mText);
                } else {
                        throw new MWException( 'Revision constructor passed invalid row format.' );
                }
@@ -318,23 +337,34 @@ class Revision {
         */
 
        /**
+        * Get revision ID
         * @return int
         */
-       function getId() {
+       public function getId() {
                return $this->mId;
        }
 
        /**
+        * Get text row ID
         * @return int
         */
-       function getTextId() {
+       public function getTextId() {
                return $this->mTextId;
        }
+       
+       /**
+        * Get parent revision ID (the original previous page revision)
+        * @return int
+        */
+       public function getParentId() {
+               return $this->mParentId;
+       }
 
        /**
         * Returns the length of the text in this revision, or null if unknown.
+        * @return int
         */
-       function getSize() {
+       public function getSize() {
                return $this->mSize;
        }
 
@@ -342,7 +372,7 @@ class Revision {
         * Returns the title of the page associated with this entry.
         * @return Title
         */
-       function getTitle() {
+       public function getTitle() {
                if( isset( $this->mTitle ) ) {
                        return $this->mTitle;
                }
@@ -364,14 +394,15 @@ class Revision {
         * Set the title of the revision
         * @param Title $title
         */
-       function setTitle( $title ) {
+       public function setTitle( $title ) {
                $this->mTitle = $title;
        }
 
        /**
+        * Get the page ID
         * @return int
         */
-       function getPage() {
+       public function getPage() {
                return $this->mPage;
        }
 
@@ -379,7 +410,7 @@ class Revision {
         * Fetch revision's user id if it's available to all users
         * @return int
         */
-       function getUser() {
+       public function getUser() {
                if( $this->isDeleted( self::DELETED_USER ) ) {
                        return 0;
                } else {
@@ -391,7 +422,7 @@ class Revision {
         * Fetch revision's user id without regard for the current user's permissions
         * @return string
         */
-       function getRawUser() {
+       public function getRawUser() {
                return $this->mUser;
        }
 
@@ -399,7 +430,7 @@ class Revision {
         * Fetch revision's username if it's available to all users
         * @return string
         */
-       function getUserText() {
+       public function getUserText() {
                if( $this->isDeleted( self::DELETED_USER ) ) {
                        return "";
                } else {
@@ -411,7 +442,7 @@ class Revision {
         * Fetch revision's username without regard for view restrictions
         * @return string
         */
-       function getRawUserText() {
+       public function getRawUserText() {
                return $this->mUserText;
        }
        
@@ -431,14 +462,14 @@ class Revision {
         * Fetch revision comment without regard for the current user's permissions
         * @return string
         */
-       function getRawComment() {
+       public function getRawComment() {
                return $this->mComment;
        }
 
        /**
         * @return bool
         */
-       function isMinor() {
+       public function isMinor() {
                return (bool)$this->mMinorEdit;
        }
 
@@ -446,7 +477,7 @@ class Revision {
         * int $field one of DELETED_* bitfield constants
         * @return bool
         */
-       function isDeleted( $field ) {
+       public function isDeleted( $field ) {
                return ($this->mDeleted & $field) == $field;
        }
 
@@ -454,7 +485,7 @@ class Revision {
         * Fetch revision text if it's available to all users
         * @return string
         */
-       function getText() {
+       public function getText() {
                if( $this->isDeleted( self::DELETED_TEXT ) ) {
                        return "";
                } else {
@@ -466,7 +497,7 @@ class Revision {
         * Fetch revision text without regard for view restrictions
         * @return string
         */
-       function getRawText() {
+       public function getRawText() {
                if( is_null( $this->mText ) ) {
                        // Revision text is immutable. Load on demand:
                        $this->mText = $this->loadText();
@@ -478,7 +509,7 @@ class Revision {
         * Fetch revision text if it's available to THIS user
         * @return string
         */
-       function revText() {
+       public function revText() {
                if( !$this->userCan( self::DELETED_TEXT ) ) {
                        return "";
                } else {
@@ -489,23 +520,24 @@ class Revision {
        /**
         * @return string
         */
-       function getTimestamp() {
+       public function getTimestamp() {
                return wfTimestamp(TS_MW, $this->mTimestamp);
        }
 
        /**
         * @return bool
         */
-       function isCurrent() {
+       public function isCurrent() {
                return $this->mCurrent;
        }
 
        /**
+        * Get previous revision for this title
         * @return Revision
         */
-       function getPrevious() {
+       public function getPrevious() {
                $prev = $this->mTitle->getPreviousRevisionID( $this->mId );
-               if ( $prev ) {
+               if( $prev ) {
                        return Revision::newFromTitle( $this->mTitle, $prev );
                } else {
                        return null;
@@ -515,7 +547,7 @@ class Revision {
        /**
         * @return Revision
         */
-       function getNext() {
+       public function getNext() {
                $next = $this->mTitle->getNextRevisionID( $this->mId );
                if ( $next ) {
                        return Revision::newFromTitle( $this->mTitle, $next );
@@ -523,20 +555,42 @@ class Revision {
                        return null;
                }
        }
-       /**#@-*/
+       
+       /**
+        * Get previous revision Id for this page_id
+        * This is used to populate rev_parent_id on save
+        * @param Database $db
+        * @return int
+        */
+       private function getPreviousRevisionId( $db ) {
+               if( is_null($this->mPage) ) {
+                       return 0;
+               }
+               # Use page_latest if ID is not given
+               if( !$this->mId ) {
+                       $prevId = $db->selectField( 'page', 'page_latest',
+                               array( 'page_id' => $this->mPage ),
+                               __METHOD__ );
+               } else {
+                       $prevId = $db->selectField( 'revision', 'rev_id',
+                               array( 'rev_page' => $this->mPage, 'rev_id < ' . $this->mId ),
+                               __METHOD__,
+                               array( 'ORDER BY' => 'rev_id DESC' ) );
+               }
+               return intval($prevId);
+       }
 
        /**
          * Get revision text associated with an old or archive row
          * $row is usually an object from wfFetchRow(), both the flags and the text
          * field must be included
-         * @static
+         *
          * @param integer $row Id of a row
          * @param string $prefix table prefix (default 'old_')
          * @return string $text|false the text requested
          */
        public static function getRevisionText( $row, $prefix = 'old_' ) {
-               $fname = 'Revision::getRevisionText';
-               wfProfileIn( $fname );
+               wfProfileIn( __METHOD__ );
 
                # Get data
                $textField = $prefix . 'text';
@@ -551,7 +605,7 @@ class Revision {
                if( isset( $row->$textField ) ) {
                        $text = $row->$textField;
                } else {
-                       wfProfileOut( $fname );
+                       wfProfileOut( __METHOD__ );
                        return false;
                }
 
@@ -560,7 +614,7 @@ class Revision {
                        $url=$text;
                        @list(/* $proto */,$path)=explode('://',$url,2);
                        if ($path=="") {
-                               wfProfileOut( $fname );
+                               wfProfileOut( __METHOD__ );
                                return false;
                        }
                        $text=ExternalStore::fetchFromURL($url);
@@ -580,7 +634,7 @@ class Revision {
                                $obj = unserialize( $text );
                                if ( !is_object( $obj ) ) {
                                        // Invalid object
-                                       wfProfileOut( $fname );
+                                       wfProfileOut( __METHOD__ );
                                        return false;
                                }
                                $text = $obj->getText();
@@ -591,10 +645,10 @@ class Revision {
                                # Old revisions kept around in a legacy encoding?
                                # Upconvert on demand.
                                global $wgInputEncoding, $wgContLang;
-                               $text = $wgContLang->iconv( $wgLegacyEncoding, $wgInputEncoding . '//IGNORE', $text );
+                               $text = $wgContLang->iconv( $wgLegacyEncoding, $wgInputEncoding, $text );
                        }
                }
-               wfProfileOut( $fname );
+               wfProfileOut( __METHOD__ );
                return $text;
        }
 
@@ -605,11 +659,10 @@ class Revision {
         * data is compressed, and 'utf-8' if we're saving in UTF-8
         * mode.
         *
-        * @static
         * @param mixed $text reference to a text
         * @return string
         */
-       function compressRevisionText( &$text ) {
+       public static function compressRevisionText( &$text ) {
                global $wgCompressRevisions;
                $flags = array();
 
@@ -635,11 +688,10 @@ class Revision {
         * @param Database $dbw
         * @return int
         */
-       function insertOn( &$dbw ) {
+       public function insertOn( &$dbw ) {
                global $wgDefaultExternalStore;
-               
-               $fname = 'Revision::insertOn';
-               wfProfileIn( $fname );
+
+               wfProfileIn( __METHOD__ );
 
                $data = $this->mText;
                $flags = Revision::compressRevisionText( $data );
@@ -672,7 +724,7 @@ class Revision {
                                        'old_id'    => $old_id,
                                        'old_text'  => $data,
                                        'old_flags' => $flags,
-                               ), $fname
+                               ), __METHOD__
                        );
                        $this->mTextId = $dbw->insertId();
                }
@@ -692,12 +744,13 @@ class Revision {
                                'rev_user_text'  => $this->mUserText,
                                'rev_timestamp'  => $dbw->timestamp( $this->mTimestamp ),
                                'rev_deleted'    => $this->mDeleted,
-                               'rev_len'        => mb_strlen($this->mText),
-                       ), $fname
+                               'rev_len'            => $this->mSize,
+                               'rev_parent_id'  => $this->mParentId ? $this->mParentId : $this->getPreviousRevisionId( $dbw )
+                       ), __METHOD__
                );
 
                $this->mId = !is_null($rev_id) ? $rev_id : $dbw->insertId();
-               wfProfileOut( $fname );
+               wfProfileOut( __METHOD__ );
                return $this->mId;
        }
 
@@ -706,11 +759,9 @@ class Revision {
         * Currently hardcoded to the 'text' table storage engine.
         *
         * @return string
-        * @access private
         */
-       function loadText() {
-               $fname = 'Revision::loadText';
-               wfProfileIn( $fname );
+       private function loadText() {
+               wfProfileIn( __METHOD__ );
                
                // Caching may be beneficial for massive use of external storage
                global $wgRevisionCacheExpiry, $wgMemc;
@@ -718,7 +769,7 @@ class Revision {
                if( $wgRevisionCacheExpiry ) {
                        $text = $wgMemc->get( $key );
                        if( is_string( $text ) ) {
-                               wfProfileOut( $fname );
+                               wfProfileOut( __METHOD__ );
                                return $text;
                        }
                }
@@ -737,7 +788,7 @@ class Revision {
                        $row = $dbr->selectRow( 'text',
                                array( 'old_text', 'old_flags' ),
                                array( 'old_id' => $this->getTextId() ),
-                               $fname);
+                               __METHOD__ );
                }
 
                if( !$row ) {
@@ -746,16 +797,16 @@ class Revision {
                        $row = $dbw->selectRow( 'text',
                                array( 'old_text', 'old_flags' ),
                                array( 'old_id' => $this->getTextId() ),
-                               $fname);
+                               __METHOD__ );
                }
 
-               $text = Revision::getRevisionText( $row );
+               $text = self::getRevisionText( $row );
                
                if( $wgRevisionCacheExpiry ) {
                        $wgMemc->set( $key, $text, $wgRevisionCacheExpiry );
                }
                
-               wfProfileOut( $fname );
+               wfProfileOut( __METHOD__ );
 
                return $text;
        }
@@ -774,9 +825,8 @@ class Revision {
         * @param bool     $minor
         * @return Revision
         */
-       function newNullRevision( &$dbw, $pageId, $summary, $minor ) {
-               $fname = 'Revision::newNullRevision';
-               wfProfileIn( $fname );
+       public static function newNullRevision( &$dbw, $pageId, $summary, $minor ) {
+               wfProfileIn( __METHOD__ );
 
                $current = $dbw->selectRow(
                        array( 'page', 'revision' ),
@@ -785,7 +835,7 @@ class Revision {
                                'page_id' => $pageId,
                                'page_latest=rev_id',
                                ),
-                       $fname );
+                       __METHOD__ );
 
                if( $current ) {
                        $revision = new Revision( array(
@@ -793,12 +843,13 @@ class Revision {
                                'comment'    => $summary,
                                'minor_edit' => $minor,
                                'text_id'    => $current->rev_text_id,
+                               'parent_id'  => $current->page_latest
                                ) );
                } else {
                        $revision = null;
                }
 
-               wfProfileOut( $fname );
+               wfProfileOut( __METHOD__ );
                return $revision;
        }
        
@@ -810,7 +861,7 @@ class Revision {
         *                          self::DELETED_USER
         * @return bool
         */
-       function userCan( $field ) {
+       public function userCan( $field ) {
                if( ( $this->mDeleted & $field ) == $field ) {
                        global $wgUser;
                        $permission = ( $this->mDeleted & self::DELETED_RESTRICTED ) == self::DELETED_RESTRICTED
@@ -841,6 +892,11 @@ class Revision {
                return $timestamp;
        }
        
+       /**
+        * Get count of revisions per page...not very efficient
+        * @param Database $db
+        * @param int $id, page id
+        */
        static function countByPageId( $db, $id ) {
                $row = $db->selectRow( 'revision', 'COUNT(*) AS revCount',
                        array( 'rev_page' => $id ), __METHOD__ );
@@ -850,6 +906,11 @@ class Revision {
                return 0;
        }
        
+       /**
+        * Get count of revisions per page...not very efficient
+        * @param Database $db
+        * @param Title $title
+        */
        static function countByTitle( $db, $title ) {
                $id = $title->getArticleId();
                if( $id ) {
@@ -868,4 +929,4 @@ define( 'MW_REV_DELETED_USER', Revision::DELETED_USER );
 define( 'MW_REV_DELETED_RESTRICTED', Revision::DELETED_RESTRICTED );
 
 
-?>
+