(bug 13603) Added siprop=usergroups to meta=siteinfo. Patch by Mormegil
[lhc/web/wiklou.git] / includes / Revision.php
index e8d802d..163614c 100644 (file)
@@ -1,19 +1,17 @@
 <?php
 /**
- * @package MediaWiki
  * @todo document
  */
 
 /**
- * @package MediaWiki
  * @todo document
  */
 class Revision {
-       const DELETED_TEXT      = 1;
-       const DELETED_COMMENT   = 2;
-       const DELETED_USER      = 4;
+       const DELETED_TEXT = 1;
+       const DELETED_COMMENT = 2;
+       const DELETED_USER = 4;
        const DELETED_RESTRICTED = 8;
-       
+
        /**
         * Load a page revision from a given revision ID number.
         * Returns null if no such revision can be found.
@@ -49,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() ) );
        }
 
        /**
@@ -79,7 +77,7 @@ class Revision {
         * @access public
         * @static
         */
-       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 ) {
                        $conds['rev_id']=intval($id);
@@ -112,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() ) );
        }
 
        /**
@@ -133,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() ) );
        }
 
        /**
@@ -145,10 +143,10 @@ class Revision {
         * @static
         */
        private static function newFromConds( $conditions ) {
-               $db =& wfGetDB( DB_SLAVE );
+               $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;
@@ -164,7 +162,7 @@ class Revision {
         * @access private
         * @static
         */
-       private static function loadFromConds( &$db, $conditions ) {
+       private static function loadFromConds( $db, $conditions ) {
                $res = Revision::fetchFromConds( $db, $conditions );
                if( $res ) {
                        $row = $res->fetchObject();
@@ -192,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' ) );
        }
 
@@ -211,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,7 +224,7 @@ class Revision {
         * @access private
         * @static
         */
-       private static function fetchFromConds( &$db, $conditions ) {
+       private static function fetchFromConds( $db, $conditions ) {
                $res = $db->select(
                        array( 'page', 'revision' ),
                        array( 'page_namespace',
@@ -240,7 +238,8 @@ class Revision {
                               'rev_user',
                               'rev_minor_edit',
                               'rev_timestamp',
-                              'rev_deleted' ),
+                              'rev_deleted',
+                              'rev_len' ),
                        $conditions,
                        'Revision::fetchRow',
                        array( 'LIMIT' => 1 ) );
@@ -248,6 +247,25 @@ 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_minor_edit',
+                       'rev_user',
+                       'rev_user_text,'.
+                       'rev_deleted',
+                       'rev_len'
+               );
+       }
+
        /**
         * @param object $row
         * @access private
@@ -263,6 +281,11 @@ 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 ) || is_null( $row->rev_len ) )
+                               $this->mSize = null;
+                       else
+                               $this->mSize = intval( $row->rev_len ); 
 
                        if( isset( $row->page_latest ) ) {
                                $this->mCurrent   = ( $row->rev_id == $row->page_latest );
@@ -293,13 +316,18 @@ 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;
+                       
                        // 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;
+                       # 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.' );
                }
@@ -323,6 +351,13 @@ class Revision {
                return $this->mTextId;
        }
 
+       /**
+        * Returns the length of the text in this revision, or null if unknown.
+        */
+       function getSize() {
+               return $this->mSize;
+       }
+
        /**
         * Returns the title of the page associated with this entry.
         * @return Title
@@ -331,7 +366,7 @@ 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' ),
@@ -458,6 +493,18 @@ class Revision {
                }
                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
@@ -502,14 +549,13 @@ class Revision {
          * 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
          */
-       function getRevisionText( $row, $prefix = 'old_' ) {
-               $fname = 'Revision::getRevisionText';
-               wfProfileIn( $fname );
+       public static function getRevisionText( $row, $prefix = 'old_' ) {
+               wfProfileIn( __METHOD__ );
 
                # Get data
                $textField = $prefix . 'text';
@@ -524,16 +570,16 @@ class Revision {
                if( isset( $row->$textField ) ) {
                        $text = $row->$textField;
                } else {
-                       wfProfileOut( $fname );
+                       wfProfileOut( __METHOD__ );
                        return false;
                }
 
                # 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 );
+                               wfProfileOut( __METHOD__ );
                                return false;
                        }
                        $text=ExternalStore::fetchFromURL($url);
@@ -553,7 +599,7 @@ class Revision {
                                $obj = unserialize( $text );
                                if ( !is_object( $obj ) ) {
                                        // Invalid object
-                                       wfProfileOut( $fname );
+                                       wfProfileOut( __METHOD__ );
                                        return false;
                                }
                                $text = $obj->getText();
@@ -564,10 +610,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;
        }
 
@@ -578,11 +624,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 ) {
+       static function compressRevisionText( &$text ) {
                global $wgCompressRevisions;
                $flags = array();
 
@@ -610,9 +655,8 @@ class Revision {
         */
        function insertOn( &$dbw ) {
                global $wgDefaultExternalStore;
-               
-               $fname = 'Revision::insertOn';
-               wfProfileIn( $fname );
+
+               wfProfileIn( __METHOD__ );
 
                $data = $this->mText;
                $flags = Revision::compressRevisionText( $data );
@@ -645,7 +689,7 @@ class Revision {
                                        'old_id'    => $old_id,
                                        'old_text'  => $data,
                                        'old_flags' => $flags,
-                               ), $fname
+                               ), __METHOD__
                        );
                        $this->mTextId = $dbw->insertId();
                }
@@ -665,11 +709,12 @@ class Revision {
                                'rev_user_text'  => $this->mUserText,
                                'rev_timestamp'  => $dbw->timestamp( $this->mTimestamp ),
                                'rev_deleted'    => $this->mDeleted,
-                       ), $fname
+                               'rev_len'            => $this->mSize,
+                       ), __METHOD__
                );
 
                $this->mId = !is_null($rev_id) ? $rev_id : $dbw->insertId();
-               wfProfileOut( $fname );
+               wfProfileOut( __METHOD__ );
                return $this->mId;
        }
 
@@ -681,16 +726,15 @@ class Revision {
         * @access private
         */
        function loadText() {
-               $fname = 'Revision::loadText';
-               wfProfileIn( $fname );
+               wfProfileIn( __METHOD__ );
                
                // Caching may be beneficial for massive use of external storage
-               global $wgRevisionCacheExpiry, $wgMemc, $wgDBname;
-               $key = "$wgDBname:revisiontext:textid:" . $this->getTextId();
+               global $wgRevisionCacheExpiry, $wgMemc;
+               $key = wfMemcKey( 'revisiontext', 'textid', $this->getTextId() );
                if( $wgRevisionCacheExpiry ) {
                        $text = $wgMemc->get( $key );
                        if( is_string( $text ) ) {
-                               wfProfileOut( $fname );
+                               wfProfileOut( __METHOD__ );
                                return $text;
                        }
                }
@@ -705,29 +749,29 @@ class Revision {
                
                if( !$row ) {
                        // Text data is immutable; check slaves first.
-                       $dbr =& wfGetDB( DB_SLAVE );
+                       $dbr = wfGetDB( DB_SLAVE );
                        $row = $dbr->selectRow( 'text',
                                array( 'old_text', 'old_flags' ),
                                array( 'old_id' => $this->getTextId() ),
-                               $fname);
+                               __METHOD__ );
                }
 
                if( !$row ) {
                        // Possible slave lag!
-                       $dbw =& wfGetDB( DB_MASTER );
+                       $dbw = wfGetDB( DB_MASTER );
                        $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;
        }
@@ -746,9 +790,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' ),
@@ -757,7 +800,7 @@ class Revision {
                                'page_id' => $pageId,
                                'page_latest=rev_id',
                                ),
-                       $fname );
+                       __METHOD__ );
 
                if( $current ) {
                        $revision = new Revision( array(
@@ -770,7 +813,7 @@ class Revision {
                        $revision = null;
                }
 
-               wfProfileOut( $fname );
+               wfProfileOut( __METHOD__ );
                return $revision;
        }
        
@@ -801,11 +844,12 @@ class Revision {
         * @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 );
+                       $dbw = wfGetDB( DB_MASTER );
                        $timestamp = $dbw->selectField( 'revision', 'rev_timestamp', 
                                array( 'rev_id' => $id ), __METHOD__ );
                }
@@ -839,4 +883,4 @@ define( 'MW_REV_DELETED_USER', Revision::DELETED_USER );
 define( 'MW_REV_DELETED_RESTRICTED', Revision::DELETED_RESTRICTED );
 
 
-?>
+