HistoryBlobUtils.php

Go to the documentation of this file.

<?php
 
// NO_NAMESPACE Compatibility with serialized objects in permanent storage
 
use MediaWiki\Storage\BlobAccessException;
 
class HistoryBlobUtils {
 
    public static function getAllowedClasses() {
        return [
            ConcatenatedGzipHistoryBlob::class,
            DiffHistoryBlob::class,
            HistoryBlobCurStub::class,
            HistoryBlobStub::class
        ];
    }
 
    public static function unserialize( string $str, bool $allowDouble = false ) {
        $obj = unserialize( $str, [ 'allowed_classes' => self::getAllowedClasses() ] );
        if ( is_string( $obj ) && $allowDouble ) {
            // Correct for old double-serialization bug (needed by HistoryBlobStub only)
            $obj = unserialize( $obj, [ 'allowed_classes' => self::getAllowedClasses() ] );
        }
        foreach ( self::getAllowedClasses() as $class ) {
            if ( $obj instanceof $class ) {
                return $obj;
            }
        }
        return null;
    }
 
    public static function unserializeArray( string $str ): array {
        $array = unserialize( $str, [ 'allowed_classes' => false ] );
        if ( !is_array( $array ) ) {
            throw new BlobAccessException( "Expected array in serialized string" );
        }
        return $array;
    }
}