CachedBagOStuff.php

Go to the documentation of this file.

<?php
namespace Wikimedia\ObjectCache;
 
use LogicException;
 
class CachedBagOStuff extends BagOStuff {
    protected $store;
    protected $procCache;
 
    protected ?bool $wasLastGetCached = null;
 
    public function __construct( BagOStuff $backend, $params = [] ) {
        $params['keyspace'] = $backend->keyspace;
        parent::__construct( $params );
 
        $this->store = $backend;
        $this->procCache = new HashBagOStuff( $params );
 
        $this->attrMap = $backend->attrMap;
    }
 
    public function get( $key, $flags = 0 ) {
        $value = $this->procCache->get( $key, $flags );
        if ( $value !== false || $this->procCache->hasKey( $key ) ) {
            $this->wasLastGetCached = true;
            return $value;
        }
 
        $value = $this->store->proxyCall(
            __FUNCTION__,
            self::ARG0_KEY,
            self::RES_NONKEY,
            func_get_args(),
            $this
        );
        $this->set( $key, $value, self::TTL_INDEFINITE, self::WRITE_CACHE_ONLY );
 
        $this->wasLastGetCached = false;
        return $value;
    }
 
    public function getMulti( array $keys, $flags = 0 ) {
        $this->wasLastGetCached = null;
        $valueByKeyCached = [];
 
        $keysFetch = [];
        foreach ( $keys as $key ) {
            $value = $this->procCache->get( $key, $flags );
            if ( $value === false && !$this->procCache->hasKey( $key ) ) {
                $keysFetch[] = $key;
            } else {
                $valueByKeyCached[$key] = $value;
            }
        }
 
        $valueByKeyFetched = $this->store->proxyCall(
            __FUNCTION__,
            self::ARG0_KEYARR,
            self::RES_KEYMAP,
            [ $keysFetch, $flags ],
            $this
        );
        $this->setMulti( $valueByKeyFetched, self::TTL_INDEFINITE, self::WRITE_CACHE_ONLY );
 
        return $valueByKeyCached + $valueByKeyFetched;
    }
 
    public function set( $key, $value, $exptime = 0, $flags = 0 ) {
        $this->procCache->set( $key, $value, $exptime, $flags );
 
        if ( $this->fieldHasFlags( $flags, self::WRITE_CACHE_ONLY ) ) {
            return true;
        }
 
        return $this->store->proxyCall(
            __FUNCTION__,
            self::ARG0_KEY,
            self::RES_NONKEY,
            func_get_args(),
            $this
        );
    }
 
    public function delete( $key, $flags = 0 ) {
        $this->procCache->delete( $key, $flags );
 
        if ( $this->fieldHasFlags( $flags, self::WRITE_CACHE_ONLY ) ) {
            return true;
        }
 
        return $this->store->proxyCall(
            __FUNCTION__,
            self::ARG0_KEY,
            self::RES_NONKEY,
            func_get_args(),
            $this
        );
    }
 
    public function add( $key, $value, $exptime = 0, $flags = 0 ) {
        if ( $this->get( $key ) === false ) {
            return $this->set( $key, $value, $exptime, $flags );
        }
 
        // key already set
        return false;
    }
 
    // These just call the backend (tested elsewhere)
    // @codeCoverageIgnoreStart
 
    public function merge( $key, callable $callback, $exptime = 0, $attempts = 10, $flags = 0 ) {
        $this->procCache->delete( $key );
 
        return $this->store->proxyCall(
            __FUNCTION__,
            self::ARG0_KEY,
            self::RES_NONKEY,
            func_get_args(),
            $this
        );
    }
 
    public function changeTTL( $key, $exptime = 0, $flags = 0 ) {
        $this->procCache->delete( $key );
 
        return $this->store->proxyCall(
            __FUNCTION__,
            self::ARG0_KEY,
            self::RES_NONKEY,
            func_get_args(),
            $this
        );
    }
 
    public function lock( $key, $timeout = 6, $exptime = 6, $rclass = '' ) {
        return $this->store->proxyCall(
            __FUNCTION__,
            self::ARG0_KEY,
            self::RES_NONKEY,
            func_get_args(),
            $this
        );
    }
 
    public function unlock( $key ) {
        return $this->store->proxyCall(
            __FUNCTION__,
            self::ARG0_KEY,
            self::RES_NONKEY,
            func_get_args(),
            $this
        );
    }
 
    public function deleteObjectsExpiringBefore(
        $timestamp,
        ?callable $progress = null,
        $limit = INF,
        ?string $tag = null
    ) {
        $this->procCache->deleteObjectsExpiringBefore( $timestamp, $progress, $limit, $tag );
 
        return $this->store->proxyCall(
            __FUNCTION__,
            self::ARG0_NONKEY,
            self::RES_NONKEY,
            func_get_args(),
            $this
        );
    }
 
    public function setMulti( array $valueByKey, $exptime = 0, $flags = 0 ) {
        $this->procCache->setMulti( $valueByKey, $exptime, $flags );
 
        if ( $this->fieldHasFlags( $flags, self::WRITE_CACHE_ONLY ) ) {
            return true;
        }
 
        return $this->store->proxyCall(
            __FUNCTION__,
            self::ARG0_KEYMAP,
            self::RES_NONKEY,
            func_get_args(),
            $this
        );
    }
 
    public function deleteMulti( array $keys, $flags = 0 ) {
        $this->procCache->deleteMulti( $keys, $flags );
 
        if ( $this->fieldHasFlags( $flags, self::WRITE_CACHE_ONLY ) ) {
            return true;
        }
 
        return $this->store->proxyCall(
            __FUNCTION__,
            self::ARG0_KEYARR,
            self::RES_NONKEY,
            func_get_args(),
            $this
        );
    }
 
    public function changeTTLMulti( array $keys, $exptime, $flags = 0 ) {
        $this->procCache->changeTTLMulti( $keys, $exptime, $flags );
 
        if ( $this->fieldHasFlags( $flags, self::WRITE_CACHE_ONLY ) ) {
            return true;
        }
 
        return $this->store->proxyCall(
            __FUNCTION__,
            self::ARG0_KEYARR,
            self::RES_NONKEY,
            func_get_args(),
            $this
        );
    }
 
    public function incrWithInit( $key, $exptime, $step = 1, $init = null, $flags = 0 ) {
        $this->procCache->delete( $key );
 
        return $this->store->proxyCall(
            __FUNCTION__,
            self::ARG0_KEY,
            self::RES_NONKEY,
            func_get_args(),
            $this
        );
    }
 
    public function setMockTime( &$time ) {
        parent::setMockTime( $time );
        $this->procCache->setMockTime( $time );
        $this->store->setMockTime( $time );
    }
 
    public function wasLastGetCached(): bool {
        if ( $this->wasLastGetCached === null ) {
            throw new LogicException( __METHOD__ . ' must be called immediately after get()' );
        }
 
        $status = $this->wasLastGetCached;
        // Disallow multiple calls without a get() in between as we expect this method to
        // be used right after a get().
        $this->wasLastGetCached = null;
 
        return $status;
    }
 
    // @codeCoverageIgnoreEnd
}
 
class_alias( CachedBagOStuff::class, 'CachedBagOStuff' );