merged master
[lhc/web/wiklou.git] / includes / Revision.php
index bc827b7..5fd1f5a 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
@@ -20,7 +40,7 @@ class Revision {
        protected $mTextRow;
        protected $mTitle;
        protected $mCurrent;
-       protected $mContentModelName;
+       protected $mContentModel;
        protected $mContentFormat;
        protected $mContent;
        protected $mContentHandler;
@@ -117,6 +137,8 @@ class Revision {
         * @return Revision
         */
        public static function newFromArchiveRow( $row, $overrides = array() ) {
+               global $wgContentHandlerUseDB;
+
                $attribs = $overrides + array(
                        'page'       => isset( $row->ar_page_id ) ? $row->ar_page_id : null,
                        'id'         => isset( $row->ar_rev_id ) ? $row->ar_rev_id : null,
@@ -132,6 +154,12 @@ class Revision {
                        'content_model' => isset( $row->ar_content_model ) ? $row->ar_content_model : null,
                        'content_format'  => isset( $row->ar_content_format ) ? $row->ar_content_format : null,
                );
+
+               if ( !$wgContentHandlerUseDB ) {
+                       unset( $attribs['content_model'] );
+                       unset( $attribs['content_format'] );
+               }
+
                if ( isset( $row->ar_text ) && !$row->ar_text_id ) {
                        // Pre-1.5 ar_text row
                        $attribs['text'] = self::getRevisionText( $row, 'ar_' );
@@ -330,7 +358,9 @@ class Revision {
         * @return array
         */
        public static function selectFields() {
-               return array(
+               global $wgContentHandlerUseDB;
+
+               $fields = array(
                        'rev_id',
                        'rev_page',
                        'rev_text_id',
@@ -343,9 +373,14 @@ class Revision {
                        'rev_len',
                        'rev_parent_id',
                        'rev_sha1',
-                       'rev_content_format',
-                       'rev_content_model'
                );
+
+               if ( $wgContentHandlerUseDB ) {
+                       $fields[] = 'rev_content_format';
+                       $fields[] = 'rev_content_model';
+               }
+
+               return $fields;
        }
 
        /**
@@ -425,15 +460,15 @@ class Revision {
                        }
 
                        if( !isset( $row->rev_content_model ) || is_null( $row->rev_content_model ) ) {
-                               $this->mContentModelName = null; # determine on demand if needed
+                               $this->mContentModel = null; # determine on demand if needed
                        } else {
-                               $this->mContentModelName = strval( $row->rev_content_model );
+                               $this->mContentModel = intval( $row->rev_content_model );
                        }
 
                        if( !isset( $row->rev_content_format ) || is_null( $row->rev_content_format ) ) {
                                $this->mContentFormat = null; # determine on demand if needed
                        } else {
-                               $this->mContentFormat = strval( $row->rev_content_format );
+                               $this->mContentFormat = intval( $row->rev_content_format );
                        }
 
                        // Lazy extraction...
@@ -464,7 +499,7 @@ class Revision {
                                        throw new MWException( "Text already stored in external store (id {$row['text_id']}), can't serialize content object" );
                                }
 
-                               $row['content_model'] = $row['content']->getModelName();
+                               $row['content_model'] = $row['content']->getModel();
                                # note: mContentFormat is initializes later accordingly
                                # note: content is serialized later in this method!
                                # also set text to null?
@@ -482,39 +517,49 @@ class Revision {
                        $this->mParentId  = isset( $row['parent_id']  ) ? intval( $row['parent_id']  ) : null;
                        $this->mSha1      = isset( $row['sha1']  )      ? strval( $row['sha1']  )      : null;
 
-                       $this->mContentModelName = isset( $row['content_model']  )  ? strval( $row['content_model'] )  : null;
-                       $this->mContentFormat    = isset( $row['content_format']  ) ? strval( $row['content_format'] ) : null;
+                       $this->mContentModel = isset( $row['content_model']  )  ? intval( $row['content_model'] )  : null;
+                       $this->mContentFormat    = isset( $row['content_format']  ) ? intval( $row['content_format'] ) : 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;
                        $this->mTextRow   = null;
 
-                       # if we have a content object, override mText and mContentModelName
+                       # if we have a content object, override mText and mContentModel
                        if ( !empty( $row['content'] ) ) {
                                $handler = $this->getContentHandler();
                                $this->mContent = $row['content'];
 
-                               $this->mContentModelName = $this->mContent->getModelName();
+                               $this->mContentModel = $this->mContent->getModel();
                                $this->mContentHandler = null;
 
                                $this->mText = $handler->serializeContent( $row['content'], $this->getContentFormat() );
+                       } elseif ( !is_null( $this->mText ) ) {
+                               $handler = $this->getContentHandler();
+                               $this->mContent = $handler->unserializeContent( $this->mText );
                        }
 
                        $this->mTitle     = null; # Load on demand if needed
-                       $this->mCurrent   = false;
+                       $this->mCurrent   = false; #XXX: really? we are about to create a revision. it will usually then be the current one.
+
                        # If we still have no length, see it we have the text to figure it out
                        if ( !$this->mSize ) {
-                               #XXX: my be inconsistent with the notion of "size" use for the present content model
-                               $this->mSize = is_null( $this->mText ) ? null : strlen( $this->mText );
+                               if ( !is_null( $this->mContent ) ) {
+                                       $this->mSize = $this->mContent->getSize();
+                               } else {
+                                       #XXX: my be inconsistent with the notion of "size" use for the present content model
+                                       #NOTE: should never happen if we have either text or content object!
+                                       $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 );
                        }
 
-                       $this->getContentModelName(); # force lazy init
-                       $this->getContentFormat();      # force lazy init
+                       $this->getContentModel(); # force lazy init
+                       $this->getContentFormat();    # force lazy init
                } else {
                        throw new MWException( 'Revision constructor passed invalid row format.' );
                }
@@ -781,7 +826,7 @@ class Revision {
         * @param $user User object to check for, only if FOR_THIS_USER is passed
         *              to the $audience parameter
         * @return String
-        * @deprectaed in 1.WD, use getContent() instead
+        * @deprecated in 1.WD, use getContent() instead
         */
        public function getText( $audience = self::FOR_PUBLIC, User $user = null ) { #FIXME: deprecated, replace usage! #FIXME: used a LOT!
                wfDeprecated( __METHOD__, '1.WD' );
@@ -854,31 +899,54 @@ class Revision {
                return $this->mContent;
        }
 
-       public function getContentModelName() {
-               if ( !$this->mContentModelName ) {
+       /**
+        * Returns the content model for this revision.
+        *
+        * If no content model was stored in the database, $this->getTitle()->getContentModel() is
+        * used to determine the content model to use. If no title is know, CONTENT_MODEL_WIKITEXT
+        * is used as a last resort.
+        *
+        * @return int the content model id associated with this revision, see the CONTENT_MODEL_XXX constants.
+        **/
+       public function getContentModel() {
+               if ( !$this->mContentModel ) {
                        $title = $this->getTitle();
-                       $this->mContentModelName = ( $title ? $title->getContentModelName() : CONTENT_MODEL_WIKITEXT );
+                       $this->mContentModel = ( $title ? $title->getContentModel() : CONTENT_MODEL_WIKITEXT );
+
+                       assert( !empty( $this->mContentModel ) );
                }
 
-               return $this->mContentModelName;
+               return $this->mContentModel;
        }
 
+       /**
+        * Returns the content format for this revision.
+        *
+        * If no content format was stored in the database, the default format for this
+        * revision's content model is returned.
+        *
+        * @return int the content format id associated with this revision, see the CONTENT_FORMAT_XXX constants.
+        **/
        public function getContentFormat() {
                if ( !$this->mContentFormat ) {
                        $handler = $this->getContentHandler();
                        $this->mContentFormat = $handler->getDefaultFormat();
+
+                       assert( !empty( $this->mContentFormat ) );
                }
 
                return $this->mContentFormat;
        }
 
        /**
-        * @return ContentHandlert
+        * Returns the content handler appropriate for this revision's content model.
+        *
+        * @return ContentHandler
         */
        public function getContentHandler() {
                if ( !$this->mContentHandler ) {
-                       $model = $this->getContentModelName();
-                       $this->mContentHandler = ContentHandler::getForModelName( $model );
+                       $model = $this->getContentModel();
+                       $this->mContentHandler = ContentHandler::getForModelID( $model );
 
                        assert( $this->mContentHandler->isSupportedFormat( $this->getContentFormat() ) );
                }
@@ -1068,7 +1136,7 @@ class Revision {
         * @return Integer
         */
        public function insertOn( $dbw ) {
-               global $wgDefaultExternalStore;
+               global $wgDefaultExternalStore, $wgContentHandlerUseDB;
 
                wfProfileIn( __METHOD__ );
 
@@ -1125,10 +1193,13 @@ class Revision {
                        'rev_sha1'       => is_null( $this->mSha1 )
                                ? Revision::base36Sha1( $this->mText )
                                : $this->mSha1,
-                       'rev_content_model'       => $this->getContentModelName(),
-                       'rev_content_format'        => $this->getContentFormat(),
                );
 
+               if ( $wgContentHandlerUseDB ) {
+                       $row[ 'rev_content_model' ] = $this->getContentModel();
+                       $row[ 'rev_content_format' ] = $this->getContentFormat();
+               }
+
                $dbw->insert( 'revision', $row, __METHOD__ );
 
                $this->mId = !is_null( $rev_id ) ? $rev_id : $dbw->insertId();
@@ -1223,12 +1294,21 @@ class Revision {
         * @return Revision|null on error
         */
        public static function newNullRevision( $dbw, $pageId, $summary, $minor ) {
+               global $wgContentHandlerUseDB;
+
                wfProfileIn( __METHOD__ );
 
+               $fields = array( 'page_latest', 'page_namespace', 'page_title',
+                                               'rev_text_id', 'rev_len', 'rev_sha1' );
+
+               if ( $wgContentHandlerUseDB ) {
+                       $fields[] = 'rev_content_model';
+                       $fields[] = 'rev_content_format';
+               }
+
                $current = $dbw->selectRow(
                        array( 'page', 'revision' ),
-                       array( 'page_latest', 'rev_text_id', 'rev_len', 'rev_sha1',
-                                       'rev_content_model', 'rev_content_format' ),
+                       $fields,
                        array(
                                'page_id' => $pageId,
                                'page_latest=rev_id',
@@ -1236,17 +1316,23 @@ class Revision {
                        __METHOD__ );
 
                if( $current ) {
-                       $revision = new Revision( array(
+                       $row = array(
                                'page'       => $pageId,
                                'comment'    => $summary,
                                'minor_edit' => $minor,
                                'text_id'    => $current->rev_text_id,
                                'parent_id'  => $current->page_latest,
                                'len'        => $current->rev_len,
-                               'sha1'       => $current->rev_sha1,
-                               'content_model'  => $current->rev_content_model,
-                               'content_format'   => $current->rev_content_format
-                               ) );
+                               'sha1'       => $current->rev_sha1
+                       );
+
+                       if ( $wgContentHandlerUseDB ) {
+                               $row[ 'content_model' ] = $current->rev_content_model;
+                               $row[ 'content_format' ] = $current->rev_content_format;
+                       }
+
+                       $revision = new Revision( $row );
+                       $revision->setTitle( Title::makeTitle( $current->page_namespace, $current->page_title ) );
                } else {
                        $revision = null;
                }