includes/HistoryBlob.php

   1 <?php
   2 /**
   3  * Efficient concatenated text storage.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 /**
  24  * Base class for general text storage via the "object" flag in old_flags, or
  25  * two-part external storage URLs. Used for represent efficient concatenated
  26  * storage, and migration-related pointer objects.
  27  */
  28 interface HistoryBlob
  29 {
  30         /**
  31          * Adds an item of text, returns a stub object which points to the item.
  32          * You must call setLocation() on the stub object before storing it to the
  33          * database
  34          *
  35          * @param $text string
  36          *
  37          * @return String: the key for getItem()
  38          */
  39         function addItem( $text );
  40
  41         /**
  42          * Get item by key, or false if the key is not present
  43          *
  44          * @param $key string
  45          *
  46          * @return String or false
  47          */
  48         function getItem( $key );
  49
  50         /**
  51          * Set the "default text"
  52          * This concept is an odd property of the current DB schema, whereby each text item has a revision
  53          * associated with it. The default text is the text of the associated revision. There may, however,
  54          * be other revisions in the same object.
  55          *
  56          * Default text is not required for two-part external storage URLs.
  57          *
  58          * @param $text string
  59          */
  60         function setText( $text );
  61
  62         /**
  63          * Get default text. This is called from Revision::getRevisionText()
  64          *
  65          * @return String
  66          */
  67         function getText();
  68 }
  69
  70 /**
  71  * Concatenated gzip (CGZ) storage
  72  * Improves compression ratio by concatenating like objects before gzipping
  73  */
  74 class ConcatenatedGzipHistoryBlob implements HistoryBlob
  75 {
  76         public $mVersion = 0, $mCompressed = false, $mItems = array(), $mDefaultHash = '';
  77         public $mSize = 0;
  78         public $mMaxSize = 10000000;
  79         public $mMaxCount = 100;
  80
  81         /**
  82          * Constructor
  83          */
  84         public function __construct() {
  85                 if ( !function_exists( 'gzdeflate' ) ) {
  86                         throw new MWException( "Need zlib support to read or write this kind of history object (ConcatenatedGzipHistoryBlob)\n" );
  87                 }
  88         }
  89
  90         /**
  91          * @param $text string
  92          * @return string
  93          */
  94         public function addItem( $text ) {
  95                 $this->uncompress();
  96                 $hash = md5( $text );
  97                 if ( !isset( $this->mItems[$hash] ) ) {
  98                         $this->mItems[$hash] = $text;
  99                         $this->mSize += strlen( $text );
 100                 }
 101                 return $hash;
 102         }
 103
 104         /**
 105          * @param $hash string
 106          * @return array|bool
 107          */
 108         public function getItem( $hash ) {
 109                 $this->uncompress();
 110                 if ( array_key_exists( $hash, $this->mItems ) ) {
 111                         return $this->mItems[$hash];
 112                 } else {
 113                         return false;
 114                 }
 115         }
 116
 117         /**
 118          * @param $text string
 119          * @return void
 120          */
 121         public function setText( $text ) {
 122                 $this->uncompress();
 123                 $this->mDefaultHash = $this->addItem( $text );
 124         }
 125
 126         /**
 127          * @return array|bool
 128          */
 129         public function getText() {
 130                 $this->uncompress();
 131                 return $this->getItem( $this->mDefaultHash );
 132         }
 133
 134         /**
 135          * Remove an item
 136          *
 137          * @param $hash string
 138          */
 139         public function removeItem( $hash ) {
 140                 $this->mSize -= strlen( $this->mItems[$hash] );
 141                 unset( $this->mItems[$hash] );
 142         }
 143
 144         /**
 145          * Compress the bulk data in the object
 146          */
 147         public function compress() {
 148                 if ( !$this->mCompressed ) {
 149                         $this->mItems = gzdeflate( serialize( $this->mItems ) );
 150                         $this->mCompressed = true;
 151                 }
 152         }
 153
 154         /**
 155          * Uncompress bulk data
 156          */
 157         public function uncompress() {
 158                 if ( $this->mCompressed ) {
 159                         $this->mItems = unserialize( gzinflate( $this->mItems ) );
 160                         $this->mCompressed = false;
 161                 }
 162         }
 163
 164         /**
 165          * @return array
 166          */
 167         function __sleep() {
 168                 $this->compress();
 169                 return array( 'mVersion', 'mCompressed', 'mItems', 'mDefaultHash' );
 170         }
 171
 172         function __wakeup() {
 173                 $this->uncompress();
 174         }
 175
 176         /**
 177          * Helper function for compression jobs
 178          * Returns true until the object is "full" and ready to be committed
 179          *
 180          * @return bool
 181          */
 182         public function isHappy() {
 183                 return $this->mSize < $this->mMaxSize
 184                         && count( $this->mItems ) < $this->mMaxCount;
 185         }
 186 }
 187
 188 /**
 189  * Pointer object for an item within a CGZ blob stored in the text table.
 190  */
 191 class HistoryBlobStub {
 192         /**
 193          * One-step cache variable to hold base blobs; operations that
 194          * pull multiple revisions may often pull multiple times from
 195          * the same blob. By keeping the last-used one open, we avoid
 196          * redundant unserialization and decompression overhead.
 197          */
 198         protected static $blobCache = array();
 199
 200         var $mOldId, $mHash, $mRef;
 201
 202         /**
 203          * @param string $hash the content hash of the text
 204          * @param $oldid Integer the old_id for the CGZ object
 205          */
 206         function __construct( $hash = '', $oldid = 0 ) {
 207                 $this->mHash = $hash;
 208         }
 209
 210         /**
 211          * Sets the location (old_id) of the main object to which this object
 212          * points
 213          */
 214         function setLocation( $id ) {
 215                 $this->mOldId = $id;
 216         }
 217
 218         /**
 219          * Sets the location (old_id) of the referring object
 220          */
 221         function setReferrer( $id ) {
 222                 $this->mRef = $id;
 223         }
 224
 225         /**
 226          * Gets the location of the referring object
 227          */
 228         function getReferrer() {
 229                 return $this->mRef;
 230         }
 231
 232         /**
 233          * @return string
 234          */
 235         function getText() {
 236                 if ( isset( self::$blobCache[$this->mOldId] ) ) {
 237                         $obj = self::$blobCache[$this->mOldId];
 238                 } else {
 239                         $dbr = wfGetDB( DB_SLAVE );
 240                         $row = $dbr->selectRow( 'text', array( 'old_flags', 'old_text' ), array( 'old_id' => $this->mOldId ) );
 241                         if ( !$row ) {
 242                                 return false;
 243                         }
 244                         $flags = explode( ',', $row->old_flags );
 245                         if ( in_array( 'external', $flags ) ) {
 246                                 $url = $row->old_text;
 247                                 $parts = explode( '://', $url, 2 );
 248                                 if ( !isset( $parts[1] ) || $parts[1] == '' ) {
 249                                         return false;
 250                                 }
 251                                 $row->old_text = ExternalStore::fetchFromUrl( $url );
 252
 253                         }
 254                         if ( !in_array( 'object', $flags ) ) {
 255                                 return false;
 256                         }
 257
 258                         if ( in_array( 'gzip', $flags ) ) {
 259                                 // This shouldn't happen, but a bug in the compress script
 260                                 // may at times gzip-compress a HistoryBlob object row.
 261                                 $obj = unserialize( gzinflate( $row->old_text ) );
 262                         } else {
 263                                 $obj = unserialize( $row->old_text );
 264                         }
 265
 266                         if ( !is_object( $obj ) ) {
 267                                 // Correct for old double-serialization bug.
 268                                 $obj = unserialize( $obj );
 269                         }
 270
 271                         // Save this item for reference; if pulling many
 272                         // items in a row we'll likely use it again.
 273                         $obj->uncompress();
 274                         self::$blobCache = array( $this->mOldId => $obj );
 275                 }
 276                 return $obj->getItem( $this->mHash );
 277         }
 278
 279         /**
 280          * Get the content hash
 281          *
 282          * @return string
 283          */
 284         function getHash() {
 285                 return $this->mHash;
 286         }
 287 }
 288
 289 /**
 290  * To speed up conversion from 1.4 to 1.5 schema, text rows can refer to the
 291  * leftover cur table as the backend. This avoids expensively copying hundreds
 292  * of megabytes of data during the conversion downtime.
 293  *
 294  * Serialized HistoryBlobCurStub objects will be inserted into the text table
 295  * on conversion if $wgLegacySchemaConversion is set to true.
 296  */
 297 class HistoryBlobCurStub {
 298         var $mCurId;
 299
 300         /**
 301          * @param $curid Integer: the cur_id pointed to
 302          */
 303         function __construct( $curid = 0 ) {
 304                 $this->mCurId = $curid;
 305         }
 306
 307         /**
 308          * Sets the location (cur_id) of the main object to which this object
 309          * points
 310          *
 311          * @param $id int
 312          */
 313         function setLocation( $id ) {
 314                 $this->mCurId = $id;
 315         }
 316
 317         /**
 318          * @return string|bool
 319          */
 320         function getText() {
 321                 $dbr = wfGetDB( DB_SLAVE );
 322                 $row = $dbr->selectRow( 'cur', array( 'cur_text' ), array( 'cur_id' => $this->mCurId ) );
 323                 if ( !$row ) {
 324                         return false;
 325                 }
 326                 return $row->cur_text;
 327         }
 328 }
 329
 330 /**
 331  * Diff-based history compression
 332  * Requires xdiff 1.5+ and zlib
 333  */
 334 class DiffHistoryBlob implements HistoryBlob {
 335         /** Uncompressed item cache */
 336         var $mItems = array();
 337
 338         /** Total uncompressed size */
 339         var $mSize = 0;
 340
 341         /**
 342          * Array of diffs. If a diff D from A to B is notated D = B - A, and Z is
 343          * an empty string:
 344          *
 345          *              { item[map[i]] - item[map[i-1]]   where i > 0
 346          *    diff[i] = {
 347          *              { item[map[i]] - Z                where i = 0
 348          */
 349         var $mDiffs;
 350
 351         /** The diff map, see above */
 352         var $mDiffMap;
 353
 354         /**
 355          * The key for getText()
 356          */
 357         var $mDefaultKey;
 358
 359         /**
 360          * Compressed storage
 361          */
 362         var $mCompressed;
 363
 364         /**
 365          * True if the object is locked against further writes
 366          */
 367         var $mFrozen = false;
 368
 369         /**
 370          * The maximum uncompressed size before the object becomes sad
 371          * Should be less than max_allowed_packet
 372          */
 373         var $mMaxSize = 10000000;
 374
 375         /**
 376          * The maximum number of text items before the object becomes sad
 377          */
 378         var $mMaxCount = 100;
 379
 380         /** Constants from xdiff.h */
 381         const XDL_BDOP_INS = 1;
 382         const XDL_BDOP_CPY = 2;
 383         const XDL_BDOP_INSB = 3;
 384
 385         function __construct() {
 386                 if ( !function_exists( 'gzdeflate' ) ) {
 387                         throw new MWException( "Need zlib support to read or write DiffHistoryBlob\n" );
 388                 }
 389         }
 390
 391         /**
 392          * @throws MWException
 393          * @param $text string
 394          * @return int
 395          */
 396         function addItem( $text ) {
 397                 if ( $this->mFrozen ) {
 398                         throw new MWException( __METHOD__ . ": Cannot add more items after sleep/wakeup" );
 399                 }
 400
 401                 $this->mItems[] = $text;
 402                 $this->mSize += strlen( $text );
 403                 $this->mDiffs = null; // later
 404                 return count( $this->mItems ) - 1;
 405         }
 406
 407         /**
 408          * @param $key string
 409          * @return string
 410          */
 411         function getItem( $key ) {
 412                 return $this->mItems[$key];
 413         }
 414
 415         /**
 416          * @param $text string
 417          */
 418         function setText( $text ) {
 419                 $this->mDefaultKey = $this->addItem( $text );
 420         }
 421
 422         /**
 423          * @return string
 424          */
 425         function getText() {
 426                 return $this->getItem( $this->mDefaultKey );
 427         }
 428
 429         /**
 430          * @throws MWException
 431          */
 432         function compress() {
 433                 if ( !function_exists( 'xdiff_string_rabdiff' ) ) {
 434                         throw new MWException( "Need xdiff 1.5+ support to write DiffHistoryBlob\n" );
 435                 }
 436                 if ( isset( $this->mDiffs ) ) {
 437                         // Already compressed
 438                         return;
 439                 }
 440                 if ( !count( $this->mItems ) ) {
 441                         // Empty
 442                         return;
 443                 }
 444
 445                 // Create two diff sequences: one for main text and one for small text
 446                 $sequences = array(
 447                         'small' => array(
 448                                 'tail' => '',
 449                                 'diffs' => array(),
 450                                 'map' => array(),
 451                         ),
 452                         'main' => array(
 453                                 'tail' => '',
 454                                 'diffs' => array(),
 455                                 'map' => array(),
 456                         ),
 457                 );
 458                 $smallFactor = 0.5;
 459
 460                 for ( $i = 0; $i < count( $this->mItems ); $i++ ) {
 461                         $text = $this->mItems[$i];
 462                         if ( $i == 0 ) {
 463                                 $seqName = 'main';
 464                         } else {
 465                                 $mainTail = $sequences['main']['tail'];
 466                                 if ( strlen( $text ) < strlen( $mainTail ) * $smallFactor ) {
 467                                         $seqName = 'small';
 468                                 } else {
 469                                         $seqName = 'main';
 470                                 }
 471                         }
 472                         $seq =& $sequences[$seqName];
 473                         $tail = $seq['tail'];
 474                         $diff = $this->diff( $tail, $text );
 475                         $seq['diffs'][] = $diff;
 476                         $seq['map'][] = $i;
 477                         $seq['tail'] = $text;
 478                 }
 479                 unset( $seq ); // unlink dangerous alias
 480
 481                 // Knit the sequences together
 482                 $tail = '';
 483                 $this->mDiffs = array();
 484                 $this->mDiffMap = array();
 485                 foreach ( $sequences as $seq ) {
 486                         if ( !count( $seq['diffs'] ) ) {
 487                                 continue;
 488                         }
 489                         if ( $tail === '' ) {
 490                                 $this->mDiffs[] = $seq['diffs'][0];
 491                         } else {
 492                                 $head = $this->patch( '', $seq['diffs'][0] );
 493                                 $this->mDiffs[] = $this->diff( $tail, $head );
 494                         }
 495                         $this->mDiffMap[] = $seq['map'][0];
 496                         for ( $i = 1; $i < count( $seq['diffs'] ); $i++ ) {
 497                                 $this->mDiffs[] = $seq['diffs'][$i];
 498                                 $this->mDiffMap[] = $seq['map'][$i];
 499                         }
 500                         $tail = $seq['tail'];
 501                 }
 502         }
 503
 504         /**
 505          * @param $t1
 506          * @param $t2
 507          * @return string
 508          */
 509         function diff( $t1, $t2 ) {
 510                 # Need to do a null concatenation with warnings off, due to bugs in the current version of xdiff
 511                 # "String is not zero-terminated"
 512                 wfSuppressWarnings();
 513                 $diff = xdiff_string_rabdiff( $t1, $t2 ) . '';
 514                 wfRestoreWarnings();
 515                 return $diff;
 516         }
 517
 518         /**
 519          * @param $base
 520          * @param $diff
 521          * @return bool|string
 522          */
 523         function patch( $base, $diff ) {
 524                 if ( function_exists( 'xdiff_string_bpatch' ) ) {
 525                         wfSuppressWarnings();
 526                         $text = xdiff_string_bpatch( $base, $diff ) . '';
 527                         wfRestoreWarnings();
 528                         return $text;
 529                 }
 530
 531                 # Pure PHP implementation
 532
 533                 $header = unpack( 'Vofp/Vcsize', substr( $diff, 0, 8 ) );
 534
 535                 # Check the checksum if hash extension is available
 536                 $ofp = $this->xdiffAdler32( $base );
 537                 if ( $ofp !== false && $ofp !== substr( $diff, 0, 4 ) ) {
 538                         wfDebug( __METHOD__ . ": incorrect base checksum\n" );
 539                         return false;
 540                 }
 541                 if ( $header['csize'] != strlen( $base ) ) {
 542                         wfDebug( __METHOD__ . ": incorrect base length\n" );
 543                         return false;
 544                 }
 545
 546                 $p = 8;
 547                 $out = '';
 548                 while ( $p < strlen( $diff ) ) {
 549                         $x = unpack( 'Cop', substr( $diff, $p, 1 ) );
 550                         $op = $x['op'];
 551                         ++$p;
 552                         switch ( $op ) {
 553                         case self::XDL_BDOP_INS:
 554                                 $x = unpack( 'Csize', substr( $diff, $p, 1 ) );
 555                                 $p++;
 556                                 $out .= substr( $diff, $p, $x['size'] );
 557                                 $p += $x['size'];
 558                                 break;
 559                         case self::XDL_BDOP_INSB:
 560                                 $x = unpack( 'Vcsize', substr( $diff, $p, 4 ) );
 561                                 $p += 4;
 562                                 $out .= substr( $diff, $p, $x['csize'] );
 563                                 $p += $x['csize'];
 564                                 break;
 565                         case self::XDL_BDOP_CPY:
 566                                 $x = unpack( 'Voff/Vcsize', substr( $diff, $p, 8 ) );
 567                                 $p += 8;
 568                                 $out .= substr( $base, $x['off'], $x['csize'] );
 569                                 break;
 570                         default:
 571                                 wfDebug( __METHOD__ . ": invalid op\n" );
 572                                 return false;
 573                         }
 574                 }
 575                 return $out;
 576         }
 577
 578         /**
 579          * Compute a binary "Adler-32" checksum as defined by LibXDiff, i.e. with
 580          * the bytes backwards and initialised with 0 instead of 1. See bug 34428.
 581          *
 582          * @param string $s
 583          * @return string|bool: false if the hash extension is not available
 584          */
 585         function xdiffAdler32( $s ) {
 586                 if ( !function_exists( 'hash' ) ) {
 587                         return false;
 588                 }
 589
 590                 static $init;
 591                 if ( $init === null ) {
 592                         $init = str_repeat( "\xf0", 205 ) . "\xee" . str_repeat( "\xf0", 67 ) . "\x02";
 593                 }
 594
 595                 // The real Adler-32 checksum of $init is zero, so it initialises the
 596                 // state to zero, as it is at the start of LibXDiff's checksum
 597                 // algorithm. Appending the subject string then simulates LibXDiff.
 598                 return strrev( hash( 'adler32', $init . $s, true ) );
 599         }
 600
 601         function uncompress() {
 602                 if ( !$this->mDiffs ) {
 603                         return;
 604                 }
 605                 $tail = '';
 606                 for ( $diffKey = 0; $diffKey < count( $this->mDiffs ); $diffKey++ ) {
 607                         $textKey = $this->mDiffMap[$diffKey];
 608                         $text = $this->patch( $tail, $this->mDiffs[$diffKey] );
 609                         $this->mItems[$textKey] = $text;
 610                         $tail = $text;
 611                 }
 612         }
 613
 614         /**
 615          * @return array
 616          */
 617         function __sleep() {
 618                 $this->compress();
 619                 if ( !count( $this->mItems ) ) {
 620                         // Empty object
 621                         $info = false;
 622                 } else {
 623                         // Take forward differences to improve the compression ratio for sequences
 624                         $map = '';
 625                         $prev = 0;
 626                         foreach ( $this->mDiffMap as $i ) {
 627                                 if ( $map !== '' ) {
 628                                         $map .= ',';
 629                                 }
 630                                 $map .= $i - $prev;
 631                                 $prev = $i;
 632                         }
 633                         $info = array(
 634                                 'diffs' => $this->mDiffs,
 635                                 'map' => $map
 636                         );
 637                 }
 638                 if ( isset( $this->mDefaultKey ) ) {
 639                         $info['default'] = $this->mDefaultKey;
 640                 }
 641                 $this->mCompressed = gzdeflate( serialize( $info ) );
 642                 return array( 'mCompressed' );
 643         }
 644
 645         function __wakeup() {
 646                 // addItem() doesn't work if mItems is partially filled from mDiffs
 647                 $this->mFrozen = true;
 648                 $info = unserialize( gzinflate( $this->mCompressed ) );
 649                 unset( $this->mCompressed );
 650
 651                 if ( !$info ) {
 652                         // Empty object
 653                         return;
 654                 }
 655
 656                 if ( isset( $info['default'] ) ) {
 657                         $this->mDefaultKey = $info['default'];
 658                 }
 659                 $this->mDiffs = $info['diffs'];
 660                 if ( isset( $info['base'] ) ) {
 661                         // Old format
 662                         $this->mDiffMap = range( 0, count( $this->mDiffs ) - 1 );
 663                         array_unshift( $this->mDiffs,
 664                                 pack( 'VVCV', 0, 0, self::XDL_BDOP_INSB, strlen( $info['base'] ) ) .
 665                                 $info['base'] );
 666                 } else {
 667                         // New format
 668                         $map = explode( ',', $info['map'] );
 669                         $cur = 0;
 670                         $this->mDiffMap = array();
 671                         foreach ( $map as $i ) {
 672                                 $cur += $i;
 673                                 $this->mDiffMap[] = $cur;
 674                         }
 675                 }
 676                 $this->uncompress();
 677         }
 678
 679         /**
 680          * Helper function for compression jobs
 681          * Returns true until the object is "full" and ready to be committed
 682          *
 683          * @return bool
 684          */
 685         function isHappy() {
 686                 return $this->mSize < $this->mMaxSize
 687                         && count( $this->mItems ) < $this->mMaxCount;
 688         }
 689
 690 }