includes/Revision.php

   1 <?php
   2 /**
   3  * @package MediaWiki
   4  * @todo document
   5  */
   6
   7 /** */
   8 require_once( 'Database.php' );
   9 require_once( 'Article.php' );
  10
  11 /**
  12  * @package MediaWiki
  13  * @todo document
  14  */
  15 class Revision {
  16         /**
  17          * Load a page revision from a given revision ID number.
  18          * Returns null if no such revision can be found.
  19          *
  20          * @param int $id
  21          * @static
  22          * @access public
  23          */
  24         function &newFromId( $id ) {
  25                 return Revision::newFromConds(
  26                         array( 'page_id=rev_page',
  27                                'rev_id' => IntVal( $id ),
  28                                'rev_id=old_id' ) );
  29         }
  30
  31         /**
  32          * Load either the current, or a specified, revision
  33          * that's attached to a given title. If not attached
  34          * to that title, will return null.
  35          *
  36          * @param Title $title
  37          * @param int $id
  38          * @return Revision
  39          * @access public
  40          */
  41         function &newFromTitle( &$title, $id = 0 ) {
  42                 if( $id ) {
  43                         $matchId = IntVal( $id );
  44                 } else {
  45                         $matchId = 'page_latest';
  46                 }
  47                 return Revision::newFromConds(
  48                         array( "rev_id=$matchId",
  49                                'page_id=rev_page',
  50                                'page_namespace' => $title->getNamespace(),
  51                                'page_title'     => $title->getDbkey(),
  52                                'rev_id=old_id' ) );
  53         }
  54
  55         /**
  56          * Given a set of conditions, fetch a revision.
  57          *
  58          * @param array $conditions
  59          * @return Revision
  60          * @static
  61          * @access private
  62          */
  63         function &newFromConds( $conditions ) {
  64                 $res =& Revision::fetchFromConds( $conditions );
  65                 if( $res ) {
  66                         $row = $res->fetchObject();
  67                         $res->free();
  68                         if( $row ) {
  69                                 return new Revision( $row );
  70                         }
  71                 }
  72                 return null;
  73         }
  74
  75         /**
  76          * Return a wrapper for a series of database rows to
  77          * fetch all of a given page's revisions in turn.
  78          * Each row can be fed to the constructor to get objects.
  79          *
  80          * @param Title $title
  81          * @return ResultWrapper
  82          * @static
  83          * @access public
  84          */
  85         function &fetchAllRevisions( &$title ) {
  86                 return Revision::fetchFromConds(
  87                         array( 'page_namespace' => $title->getNamespace(),
  88                                'page_title'     => $title->getDbkey(),
  89                                'page_id=rev_page',
  90                                'rev_id=old_id' ) );
  91         }
  92
  93         /**
  94          * Return a wrapper for a series of database rows to
  95          * fetch all of a given page's revisions in turn.
  96          * Each row can be fed to the constructor to get objects.
  97          *
  98          * @param Title $title
  99          * @return ResultWrapper
 100          * @static
 101          * @access public
 102          */
 103         function &fetchRevision( &$title ) {
 104                 return Revision::fetchFromConds(
 105                         array( 'rev_id=page_latest',
 106                                'page_namespace' => $title->getNamespace(),
 107                                'page_title'     => $title->getDbkey(),
 108                                'page_id=rev_page',
 109                                'rev_id=old_id' ) );
 110         }
 111                 /**
 112          * Given a set of conditions, return a ResultWrapper
 113          * which will return matching database rows with the
 114          * fields necessary to build Revision objects.
 115          *
 116          * @param array $conditions
 117          * @return ResultWrapper
 118          * @static
 119          * @access private
 120          */
 121         function &fetchFromConds( $conditions ) {
 122                 $dbr =& wfGetDB( DB_SLAVE );
 123                 $res = $dbr->select(
 124                         array( 'page', 'revision', 'text' ),
 125                         array( 'page_namespace',
 126                                'page_title',
 127                                'page_latest',
 128                                'rev_id',
 129                                'rev_page',
 130                                'rev_comment',
 131                                'rev_user_text',
 132                                'rev_user',
 133                                'rev_minor_edit',
 134                                'rev_timestamp',
 135                                'old_flags',
 136                                'old_text' ),
 137                         $conditions,
 138                         'Revision::fetchRow' );
 139                 return $dbr->resultObject( $res );
 140         }
 141
 142         /**
 143          * @param object $row
 144          * @access private
 145          */
 146         function Revision( $row ) {
 147                 if( is_object( $row ) ) {
 148                         $this->mId        = IntVal( $row->rev_id );
 149                         $this->mPage      = IntVal( $row->rev_page );
 150                         $this->mComment   =         $row->rev_comment;
 151                         $this->mUserText  =         $row->rev_user_text;
 152                         $this->mUser      = IntVal( $row->rev_user );
 153                         $this->mMinorEdit = IntVal( $row->rev_minor_edit );
 154                         $this->mTimestamp =         $row->rev_timestamp;
 155
 156                         $this->mCurrent   = ( $row->rev_id == $row->page_latest );
 157                         $this->mTitle     = Title::makeTitle( $row->page_namespace,
 158                                                               $row->page_title );
 159                         $this->mText      = $this->getRevisionText( $row );
 160                 } elseif( is_array( $row ) ) {
 161                         // Build a new revision to be saved...
 162                         global $wgUser;
 163
 164                         $this->mId        = isset( $row['id']         ) ? IntVal( $row['id']         ) : null;
 165                         $this->mPage      = isset( $row['page']       ) ? IntVal( $row['page']       ) : null;
 166                         $this->mComment   = isset( $row['comment']    ) ? StrVal( $row['comment']    ) : null;
 167                         $this->mUserText  = isset( $row['user_text']  ) ? StrVal( $row['user_text']  ) : $wgUser->getName();
 168                         $this->mUser      = isset( $row['user']       ) ? IntVal( $row['user']       ) : $wgUser->getId();
 169                         $this->mMinorEdit = isset( $row['minor_edit'] ) ? IntVal( $row['minor_edit'] ) : 0;
 170                         $this->mTimestamp = isset( $row['timestamp']  ) ? StrVal( $row['timestamp']  ) : wfTimestamp( TS_MW );
 171                         $this->mText      = isset( $row['text']       ) ? StrVal( $row['text']       ) : '';
 172
 173                         $this->mTitle     = null; # Load on demand if needed
 174                         $this->mCurrent   = false;
 175                 } else {
 176                         wfDebugDieBacktrace( 'Revision constructor passed invalid row format.' );
 177                 }
 178         }
 179
 180         /**#@+
 181          * @access public
 182          */
 183
 184         /**
 185          * @return int
 186          */
 187         function getId() {
 188                 return $this->mId;
 189         }
 190
 191         /**
 192          * Returns the title of the page associated with this entry.
 193          * @return Title
 194          */
 195         function &getTitle() {
 196                 if( isset( $this->mTitle ) ) {
 197                         return $this->mTitle;
 198                 }
 199                 $dbr =& wfGetDB( DB_SLAVE );
 200                 $row = $dbr->selectRow(
 201                         array( 'page', 'revision' ),
 202                         array( 'page_namespace', 'page_title' ),
 203                         array( 'page_id=rev_page',
 204                                'rev_id' => $this->mId ),
 205                         'Revision::getTItle' );
 206                 if( $row ) {
 207                         $this->mTitle =& Title::makeTitle( $row->page_namespace,
 208                                                            $row->page_title );
 209                 }
 210                 return $this->mTitle;
 211         }
 212
 213         /**
 214          * @return int
 215          */
 216         function getPage() {
 217                 return $this->mPage;
 218         }
 219
 220         /**
 221          * @return int
 222          */
 223         function getUser() {
 224                 return $this->mUser;
 225         }
 226
 227         /**
 228          * @return string
 229          */
 230         function getUserText() {
 231                 return $this->mUserText;
 232         }
 233
 234         /**
 235          * @return string
 236          */
 237         function getComment() {
 238                 return $this->mComment;
 239         }
 240
 241         /**
 242          * @return bool
 243          */
 244         function isMinor() {
 245                 return (bool)$this->mMinorEdit;
 246         }
 247
 248         /**
 249          * @return string
 250          */
 251         function getText() {
 252                 return $this->mText;
 253         }
 254
 255         /**
 256          * @return string
 257          */
 258         function getTimestamp() {
 259                 return $this->mTimestamp;
 260         }
 261
 262         /**
 263          * @return bool
 264          */
 265         function isCurrent() {
 266                 return $this->mCurrent;
 267         }
 268
 269         /**
 270          * @return Revision
 271          */
 272         function &getPrevious() {
 273                 $prev = $this->mTitle->getPreviousRevisionID( $this->mId );
 274                 return Revision::newFromTitle( $this->mTitle, $prev );
 275         }
 276
 277         /**
 278          * @return Revision
 279          */
 280         function &getNext() {
 281                 $next = $this->mTitle->getNextRevisionID( $this->mId );
 282                 return Revision::newFromTitle( $this->mTitle, $next );
 283         }
 284         /**#@-*/
 285
 286         /**
 287           * Get revision text associated with an old or archive row
 288           * $row is usually an object from wfFetchRow(), both the flags and the text
 289           * field must be included
 290           * @static
 291           * @param integer $row Id of a row
 292           * @param string $prefix table prefix (default 'old_')
 293           * @return string $text|false the text requested
 294           */
 295         function getRevisionText( $row, $prefix = 'old_' ) {
 296                 $fname = 'Revision::getRevisionText';
 297                 wfProfileIn( $fname );
 298
 299                 # Get data
 300                 $textField = $prefix . 'text';
 301                 $flagsField = $prefix . 'flags';
 302
 303                 if( isset( $row->$flagsField ) ) {
 304                         $flags = explode( ',', $row->$flagsField );
 305                 } else {
 306                         $flags = array();
 307                 }
 308
 309                 if( isset( $row->$textField ) ) {
 310                         $text = $row->$textField;
 311                 } else {
 312                         wfProfileOut( $fname );
 313                         return false;
 314                 }
 315
 316                 if( in_array( 'gzip', $flags ) ) {
 317                         # Deal with optional compression of archived pages.
 318                         # This can be done periodically via maintenance/compressOld.php, and
 319                         # as pages are saved if $wgCompressRevisions is set.
 320                         $text = gzinflate( $text );
 321                 }
 322
 323                 if( in_array( 'object', $flags ) ) {
 324                         # Generic compressed storage
 325                         $obj = unserialize( $text );
 326
 327                         # Bugger, corrupted my test database by double-serializing
 328                         if ( !is_object( $obj ) ) {
 329                                 $obj = unserialize( $obj );
 330                         }
 331
 332                         $text = $obj->getText();
 333                 }
 334
 335                 global $wgLegacyEncoding;
 336                 if( $wgLegacyEncoding && !in_array( 'utf-8', $flags ) ) {
 337                         # Old revisions kept around in a legacy encoding?
 338                         # Upconvert on demand.
 339                         global $wgInputEncoding, $wgContLang;
 340                         $text = $wgContLang->iconv( $wgLegacyEncoding, $wgInputEncoding, $text );
 341                 }
 342                 wfProfileOut( $fname );
 343                 return $text;
 344         }
 345
 346         /**
 347          * If $wgCompressRevisions is enabled, we will compress data.
 348          * The input string is modified in place.
 349          * Return value is the flags field: contains 'gzip' if the
 350          * data is compressed, and 'utf-8' if we're saving in UTF-8
 351          * mode.
 352          *
 353          * @static
 354          * @param mixed $text reference to a text
 355          * @return string
 356          */
 357         function compressRevisionText( &$text ) {
 358                 global $wgCompressRevisions, $wgUseLatin1;
 359                 $flags = array();
 360                 if( !$wgUseLatin1 ) {
 361                         # Revisions not marked this way will be converted
 362                         # on load if $wgLegacyCharset is set in the future.
 363                         $flags[] = 'utf-8';
 364                 }
 365                 if( $wgCompressRevisions ) {
 366                         if( function_exists( 'gzdeflate' ) ) {
 367                                 $text = gzdeflate( $text );
 368                                 $flags[] = 'gzip';
 369                         } else {
 370                                 wfDebug( "Revision::compressRevisionText() -- no zlib support, not compressing\n" );
 371                         }
 372                 }
 373                 return implode( ',', $flags );
 374         }
 375
 376         /**
 377          * Insert a new revision into the database, returning the new revision ID
 378          * number on success and dies horribly on failure.
 379          *
 380          * @param Database $dbw
 381          * @return int
 382          */
 383         function insertOn( &$dbw ) {
 384                 $fname = 'Revision::insertOn';
 385                 wfProfileIn( $fname );
 386
 387                 $mungedText = $this->mText;
 388                 $flags = Revision::compressRevisionText( $mungedText );
 389
 390                 # Record the text to the text table
 391                 $old_id = isset( $this->mId )
 392                         ? $this->mId
 393                         : $dbw->nextSequenceValue( 'text_old_id_val' );
 394                 $dbw->insert( 'text',
 395                         array(
 396                                 'old_id' => $old_id,
 397                                 'old_text' => $mungedText,
 398                                 'old_flags' => $flags,
 399                         ), $fname
 400                 );
 401                 $revisionId = $dbw->insertId();
 402
 403                 # Record the edit in revisions
 404                 $dbw->insert( 'revision',
 405                         array(
 406                                 'rev_id'         => $revisionId,
 407                                 'rev_page'       => $this->mPage,
 408                                 'rev_comment'    => $this->mComment,
 409                                 'rev_minor_edit' => $this->mMinorEdit ? 1 : 0,
 410                                 'rev_user'       => $this->mUser,
 411                                 'rev_user_text'  => $this->mUserText,
 412                                 'rev_timestamp'  => $dbw->timestamp( $this->mTimestamp ),
 413                         ), $fname
 414                 );
 415
 416                 $this->mId = $revisionId;
 417
 418                 wfProfileOut( $fname );
 419                 return $revisionId;
 420         }
 421 }
 422 ?>