ConcatenatedGzipHistoryBlob.php

Go to the documentation of this file.

<?php
class ConcatenatedGzipHistoryBlob implements HistoryBlob {
    public $mVersion = 0;
    public $mCompressed = false;
    public $mItems = [];
    public $mDefaultHash = '';
    public $mSize = 0;
    public $mMaxSize = 10000000;
    public $mMaxCount = 100;
 
    public function __construct() {
        if ( !function_exists( 'gzdeflate' ) ) {
            throw new MWException( "Need zlib support to read or write this "
                . "kind of history object (ConcatenatedGzipHistoryBlob)\n" );
        }
    }
 
    public function addItem( $text ) {
        $this->uncompress();
        $hash = md5( $text );
        if ( !isset( $this->mItems[$hash] ) ) {
            $this->mItems[$hash] = $text;
            $this->mSize += strlen( $text );
        }
        return $hash;
    }
 
    public function getItem( $hash ) {
        $this->uncompress();
        if ( array_key_exists( $hash, $this->mItems ) ) {
            return $this->mItems[$hash];
        } else {
            return false;
        }
    }
 
    public function setText( $text ) {
        $this->uncompress();
        $this->mDefaultHash = $this->addItem( $text );
    }
 
    public function getText() {
        $this->uncompress();
        return $this->getItem( $this->mDefaultHash );
    }
 
    public function removeItem( $hash ) {
        $this->mSize -= strlen( $this->mItems[$hash] );
        unset( $this->mItems[$hash] );
    }
 
    public function compress() {
        if ( !$this->mCompressed ) {
            $this->mItems = gzdeflate( serialize( $this->mItems ) );
            $this->mCompressed = true;
        }
    }
 
    public function uncompress() {
        if ( $this->mCompressed ) {
            $this->mItems = unserialize( gzinflate( $this->mItems ) );
            $this->mCompressed = false;
        }
    }
 
    public function __sleep() {
        $this->compress();
        return [ 'mVersion', 'mCompressed', 'mItems', 'mDefaultHash' ];
    }
 
    public function __wakeup() {
        $this->uncompress();
    }
 
    public function isHappy() {
        return $this->mSize < $this->mMaxSize
            && count( $this->mItems ) < $this->mMaxCount;
    }
}
 
// @phan-suppress-next-next-line PhanImpossibleCondition
// phpcs:ignore Generic.CodeAnalysis.UnconditionalIfStatement.Found
if ( false ) {
    // Blobs generated by MediaWiki < 1.5 on PHP 4 were serialized with the
    // class name coerced to lowercase. We can improve efficiency by adding
    // autoload entries for the lowercase variants of these classes (T166759).
    // The code below is never executed, but it is picked up by the AutoloadGenerator
    // parser, which scans for class_alias() calls.
    class_alias( ConcatenatedGzipHistoryBlob::class, 'concatenatedgziphistoryblob' );
}