maintenance/storage/testCompression.php

   1 <?php
   2 /**
   3  * Test revision text compression and decompression.
   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  * @ingroup Maintenance ExternalStorage
  22  */
  23
  24 $optionsWithArgs = [ 'start', 'limit', 'type' ];
  25 require __DIR__ . '/../commandLine.inc';
  26
  27 if ( !isset( $args[0] ) ) {
  28         echo "Usage: php testCompression.php [--type=<type>] [--start=<start-date>] " .
  29                 "[--limit=<num-revs>] <page-title>\n";
  30         exit( 1 );
  31 }
  32
  33 $lang = Language::factory( 'en' );
  34 $title = Title::newFromText( $args[0] );
  35 if ( isset( $options['start'] ) ) {
  36         $start = wfTimestamp( TS_MW, strtotime( $options['start'] ) );
  37         echo "Starting from " . $lang->timeanddate( $start ) . "\n";
  38 } else {
  39         $start = '19700101000000';
  40 }
  41 if ( isset( $options['limit'] ) ) {
  42         $limit = $options['limit'];
  43         $untilHappy = false;
  44 } else {
  45         $limit = 1000;
  46         $untilHappy = true;
  47 }
  48 $type = isset( $options['type'] ) ? $options['type'] : ConcatenatedGzipHistoryBlob::class;
  49
  50 $dbr = $this->getDB( DB_REPLICA );
  51 $revQuery = Revision::getQueryInfo( [ 'page', 'text' ] );
  52 $res = $dbr->select(
  53         $revQuery['tables'],
  54         $revQuery['fields'],
  55         [
  56                 'page_namespace' => $title->getNamespace(),
  57                 'page_title' => $title->getDBkey(),
  58                 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $start ) ),
  59         ],
  60         __FILE__,
  61         [ 'LIMIT' => $limit ],
  62         $revQuery['joins']
  63 );
  64
  65 $blob = new $type;
  66 $hashes = [];
  67 $keys = [];
  68 $uncompressedSize = 0;
  69 $t = -microtime( true );
  70 foreach ( $res as $row ) {
  71         $revision = new Revision( $row );
  72         $text = $revision->getSerializedData();
  73         $uncompressedSize += strlen( $text );
  74         $hashes[$row->rev_id] = md5( $text );
  75         $keys[$row->rev_id] = $blob->addItem( $text );
  76         if ( $untilHappy && !$blob->isHappy() ) {
  77                 break;
  78         }
  79 }
  80
  81 $serialized = serialize( $blob );
  82 $t += microtime( true );
  83 # print_r( $blob->mDiffMap );
  84
  85 printf( "%s\nCompression ratio for %d revisions: %5.2f, %s -> %d\n",
  86         $type,
  87         count( $hashes ),
  88         $uncompressedSize / strlen( $serialized ),
  89         $lang->formatSize( $uncompressedSize ),
  90         strlen( $serialized )
  91 );
  92 printf( "Compression time: %5.2f ms\n", $t * 1000 );
  93
  94 $t = -microtime( true );
  95 $blob = unserialize( $serialized );
  96 foreach ( $keys as $id => $key ) {
  97         $text = $blob->getItem( $key );
  98         if ( md5( $text ) != $hashes[$id] ) {
  99                 echo "Content hash mismatch for rev_id $id\n";
 100                 # var_dump( $text );
 101         }
 102 }
 103 $t += microtime( true );
 104 printf( "Decompression time: %5.2f ms\n", $t * 1000 );