Merge "(bug 37180) Removed hard coded parentheses in SpecialVersion.php"
[lhc/web/wiklou.git] / includes / Revision.php
index ec0508c..6b8aabc 100644 (file)
@@ -1,4 +1,24 @@
 <?php
+/**
+ * Representation of a page version.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
 
 /**
  * @todo document
@@ -13,6 +33,7 @@ class Revision {
        protected $mTimestamp;
        protected $mDeleted;
        protected $mSize;
+       protected $mSha1;
        protected $mParentId;
        protected $mComment;
        protected $mText;
@@ -122,7 +143,8 @@ class Revision {
                        '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
+                       'len'        => $row->ar_len,
+                       'sha1'       => isset( $row->ar_sha1 ) ? $row->ar_sha1 : null,
                );
                if ( isset( $row->ar_text ) && !$row->ar_text_id ) {
                        // Pre-1.5 ar_text row
@@ -292,14 +314,34 @@ class Revision {
                        $conditions,
                        __METHOD__,
                        array( 'LIMIT' => 1 ),
-                       array( 'page' => array( 'INNER JOIN', 'page_id = rev_page' ),
-                               'user' => array( 'LEFT JOIN', 'rev_user != 0 AND user_id = rev_user' ) )
+                       array( 'page' => self::pageJoinCond(), 'user' => self::userJoinCond() )
                );
        }
 
+       /**
+        * Return the value of a select() JOIN conds array for the user table.
+        * This will get user table rows for logged-in users.
+        * @since 1.19
+        * @return Array
+        */
+       public static function userJoinCond() {
+               return array( 'LEFT JOIN', array( 'rev_user != 0', 'user_id = rev_user' ) );
+       }
+
+       /**
+        * Return the value of a select() page conds array for the paeg table.
+        * This will assure that the revision(s) are not orphaned from live pages.
+        * @since 1.19
+        * @return Array
+        */
+       public static function pageJoinCond() {
+               return array( 'INNER JOIN', array( 'page_id = rev_page' ) );
+       }
+
        /**
         * Return the list of revision fields that should be selected to create
         * a new revision.
+        * @return array
         */
        public static function selectFields() {
                return array(
@@ -313,13 +355,15 @@ class Revision {
                        'rev_minor_edit',
                        'rev_deleted',
                        'rev_len',
-                       'rev_parent_id'
+                       'rev_parent_id',
+                       'rev_sha1'
                );
        }
 
        /**
         * Return the list of text fields that should be selected to read the
         * revision text
+        * @return array
         */
        public static function selectTextFields() {
                return array(
@@ -330,17 +374,22 @@ class Revision {
 
        /**
         * Return the list of page fields that should be selected from page table
+        * @return array
         */
        public static function selectPageFields() {
                return array(
                        'page_namespace',
                        'page_title',
-                       'page_latest'
+                       'page_id',
+                       'page_latest',
+                       'page_is_redirect',
+                       'page_len',
                );
        }
 
        /**
         * Return the list of user fields that should be selected from user table
+        * @return array
         */
        public static function selectUserFields() {
                return array( 'user_name' );
@@ -375,6 +424,12 @@ class Revision {
                                $this->mSize = intval( $row->rev_len );
                        }
 
+                       if ( !isset( $row->rev_sha1 ) ) {
+                               $this->mSha1 = null;
+                       } else {
+                               $this->mSha1 = $row->rev_sha1;
+                       }
+
                        if( isset( $row->page_latest ) ) {
                                $this->mCurrent = ( $row->rev_id == $row->page_latest );
                                $this->mTitle = Title::newFromRow( $row );
@@ -402,7 +457,7 @@ class Revision {
                        $this->mOrigUserText = $row->rev_user_text;
                } elseif( is_array( $row ) ) {
                        // Build a new revision to be saved...
-                       global $wgUser;
+                       global $wgUser; // ugh
 
                        $this->mId        = isset( $row['id']         ) ? intval( $row['id']         ) : null;
                        $this->mPage      = isset( $row['page']       ) ? intval( $row['page']       ) : null;
@@ -410,10 +465,11 @@ class Revision {
                        $this->mUserText  = isset( $row['user_text']  ) ? strval( $row['user_text']  ) : $wgUser->getName();
                        $this->mUser      = isset( $row['user']       ) ? intval( $row['user']       ) : $wgUser->getId();
                        $this->mMinorEdit = isset( $row['minor_edit'] ) ? intval( $row['minor_edit'] ) : 0;
-                       $this->mTimestamp = isset( $row['timestamp']  ) ? strval( $row['timestamp']  ) : wfTimestamp( TS_MW );
+                       $this->mTimestamp = isset( $row['timestamp']  ) ? strval( $row['timestamp']  ) : wfTimestampNow();
                        $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;
+                       $this->mSha1      = isset( $row['sha1']  )      ? strval( $row['sha1']  )      : null;
 
                        // Enforce spacing trimming on supplied text
                        $this->mComment   = isset( $row['comment']    ) ?  trim( strval( $row['comment'] ) ) : null;
@@ -422,9 +478,13 @@ class Revision {
 
                        $this->mTitle     = null; # Load on demand if needed
                        $this->mCurrent   = false;
-                       # If we still have no len_size, see it we have the text to figure it out
+                       # If we still have no length, see it we have the text to figure it out
                        if ( !$this->mSize ) {
-                               $this->mSize      = is_null( $this->mText ) ? null : strlen( $this->mText );
+                               $this->mSize = is_null( $this->mText ) ? null : strlen( $this->mText );
+                       }
+                       # Same for sha1
+                       if ( $this->mSha1 === null ) {
+                               $this->mSha1 = is_null( $this->mText ) ? null : self::base36Sha1( $this->mText );
                        }
                } else {
                        throw new MWException( 'Revision constructor passed invalid row format.' );
@@ -435,16 +495,26 @@ class Revision {
        /**
         * Get revision ID
         *
-        * @return Integer
+        * @return Integer|null
         */
        public function getId() {
                return $this->mId;
        }
 
+       /**
+        * Set the revision ID
+        *
+        * @since 1.19
+        * @param $id Integer
+        */
+       public function setId( $id ) {
+               $this->mId = $id;
+       }
+
        /**
         * Get text row ID
         *
-        * @return Integer
+        * @return Integer|null
         */
        public function getTextId() {
                return $this->mTextId;
@@ -453,7 +523,7 @@ class Revision {
        /**
         * Get parent revision ID (the original previous page revision)
         *
-        * @return Integer
+        * @return Integer|null
         */
        public function getParentId() {
                return $this->mParentId;
@@ -462,30 +532,43 @@ class Revision {
        /**
         * Returns the length of the text in this revision, or null if unknown.
         *
-        * @return Integer
+        * @return Integer|null
         */
        public function getSize() {
                return $this->mSize;
        }
 
        /**
-        * Returns the title of the page associated with this entry.
+        * Returns the base36 sha1 of the text in this revision, or null if unknown.
+        *
+        * @return String|null
+        */
+       public function getSha1() {
+               return $this->mSha1;
+       }
+
+       /**
+        * Returns the title of the page associated with this entry or null.
         *
-        * @return Title
+        * Will do a query, when title is not set and id is given.
+        *
+        * @return Title|null
         */
        public function getTitle() {
                if( isset( $this->mTitle ) ) {
                        return $this->mTitle;
                }
-               $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' );
-               if( $row ) {
-                       $this->mTitle = Title::makeTitle( $row->page_namespace, $row->page_title );
+               if( !is_null( $this->mId ) ) { //rev_id is defined as NOT NULL
+                       $dbr = wfGetDB( DB_SLAVE );
+                       $row = $dbr->selectRow(
+                               array( 'page', 'revision' ),
+                               self::selectPageFields(),
+                               array( 'page_id=rev_page',
+                                          'rev_id' => $this->mId ),
+                               __METHOD__ );
+                       if ( $row ) {
+                               $this->mTitle = Title::newFromRow( $row );
+                       }
                }
                return $this->mTitle;
        }
@@ -502,7 +585,7 @@ class Revision {
        /**
         * Get the page ID
         *
-        * @return Integer
+        * @return Integer|null
         */
        public function getPage() {
                return $this->mPage;
@@ -515,7 +598,7 @@ class Revision {
         *
         * @param $audience Integer: one of:
         *      Revision::FOR_PUBLIC       to be displayed to all users
-        *      Revision::FOR_THIS_USER    to be displayed to $wgUser
+        *      Revision::FOR_THIS_USER    to be displayed to the given user
         *      Revision::RAW              get the ID regardless of permissions
         * @param $user User object to check for, only if FOR_THIS_USER is passed
         *              to the $audience parameter
@@ -547,7 +630,7 @@ class Revision {
         *
         * @param $audience Integer: one of:
         *      Revision::FOR_PUBLIC       to be displayed to all users
-        *      Revision::FOR_THIS_USER    to be displayed to $wgUser
+        *      Revision::FOR_THIS_USER    to be displayed to the given user
         *      Revision::RAW              get the text regardless of permissions
         * @param $user User object to check for, only if FOR_THIS_USER is passed
         *              to the $audience parameter
@@ -587,7 +670,7 @@ class Revision {
         *
         * @param $audience Integer: one of:
         *      Revision::FOR_PUBLIC       to be displayed to all users
-        *      Revision::FOR_THIS_USER    to be displayed to $wgUser
+        *      Revision::FOR_THIS_USER    to be displayed to the given user
         *      Revision::RAW              get the text regardless of permissions
         * @param $user User object to check for, only if FOR_THIS_USER is passed
         *              to the $audience parameter
@@ -665,7 +748,7 @@ class Revision {
         *
         * @param $audience Integer: one of:
         *      Revision::FOR_PUBLIC       to be displayed to all users
-        *      Revision::FOR_THIS_USER    to be displayed to $wgUser
+        *      Revision::FOR_THIS_USER    to be displayed to the given user
         *      Revision::RAW              get the text regardless of permissions
         * @param $user User object to check for, only if FOR_THIS_USER is passed
         *              to the $audience parameter
@@ -688,7 +771,7 @@ class Revision {
         * @return String
         */
        public function revText() {
-               wfDeprecated( __METHOD__ );
+               wfDeprecated( __METHOD__, '1.17' );
                return $this->getText( self::FOR_THIS_USER );
        }
 
@@ -938,8 +1021,12 @@ class Revision {
                                'rev_timestamp'  => $dbw->timestamp( $this->mTimestamp ),
                                'rev_deleted'    => $this->mDeleted,
                                'rev_len'        => $this->mSize,
-                               'rev_parent_id'  => is_null($this->mParentId) ?
-                                       $this->getPreviousRevisionId( $dbw ) : $this->mParentId
+                               'rev_parent_id'  => is_null( $this->mParentId )
+                                       ? $this->getPreviousRevisionId( $dbw )
+                                       : $this->mParentId,
+                               'rev_sha1'       => is_null( $this->mSha1 )
+                                       ? Revision::base36Sha1( $this->mText )
+                                       : $this->mSha1
                        ), __METHOD__
                );
 
@@ -951,6 +1038,15 @@ class Revision {
                return $this->mId;
        }
 
+       /**
+        * Get the base 36 SHA-1 value for a string of text
+        * @param $text String
+        * @return String
+        */
+       public static function base36Sha1( $text ) {
+               return wfBaseConvert( sha1( $text ), 16, 36, 31 );
+       }
+
        /**
         * Lazy-load the revision's text.
         * Currently hardcoded to the 'text' table storage engine.
@@ -1030,7 +1126,8 @@ class Revision {
 
                $current = $dbw->selectRow(
                        array( 'page', 'revision' ),
-                       array( 'page_latest', 'rev_text_id', 'rev_len' ),
+                       array( 'page_latest', 'page_namespace', 'page_title',
+                               'rev_text_id', 'rev_len', 'rev_sha1' ),
                        array(
                                'page_id' => $pageId,
                                'page_latest=rev_id',
@@ -1044,8 +1141,10 @@ class Revision {
                                'minor_edit' => $minor,
                                'text_id'    => $current->rev_text_id,
                                'parent_id'  => $current->page_latest,
-                               'len'        => $current->rev_len
+                               'len'        => $current->rev_len,
+                               'sha1'       => $current->rev_sha1
                                ) );
+                       $revision->setTitle( Title::makeTitle( $current->page_namespace, $current->page_title ) );
                } else {
                        $revision = null;
                }
@@ -1114,7 +1213,7 @@ class Revision {
                        $id = 0;
                }
                $conds = array( 'rev_id' => $id );
-               $conds['rev_page'] = $title->getArticleId();
+               $conds['rev_page'] = $title->getArticleID();
                $timestamp = $dbr->selectField( 'revision', 'rev_timestamp', $conds, __METHOD__ );
                if ( $timestamp === false && wfGetLB()->getServerCount() > 1 ) {
                        # Not in slave, try master
@@ -1148,7 +1247,7 @@ class Revision {
         * @return Integer
         */
        static function countByTitle( $db, $title ) {
-               $id = $title->getArticleId();
+               $id = $title->getArticleID();
                if( $id ) {
                        return Revision::countByPageId( $db, $id );
                }