RESTBagOStuff.php

Go to the documentation of this file.

<?php
 
use Psr\Log\LoggerInterface;
 
class RESTBagOStuff extends BagOStuff {
    const DEFAULT_CONN_TIMEOUT = 1.2;
 
    const DEFAULT_REQ_TIMEOUT = 3.0;
 
    private $client;
 
    private $url;
 
    public function __construct( $params ) {
        if ( empty( $params['url'] ) ) {
            throw new InvalidArgumentException( 'URL parameter is required' );
        }
        if ( empty( $params['client'] ) ) {
            // Pass through some params to the HTTP client.
            $clientParams = [
                'connTimeout' => $params['connTimeout'] ?? self::DEFAULT_CONN_TIMEOUT,
                'reqTimeout' => $params['reqTimeout'] ?? self::DEFAULT_REQ_TIMEOUT,
            ];
            foreach ( [ 'caBundlePath', 'proxy' ] as $key ) {
                if ( isset( $params[$key] ) ) {
                    $clientParams[$key] = $params[$key];
                }
            }
            $this->client = new MultiHttpClient( $clientParams );
        } else {
            $this->client = $params['client'];
        }
        // The parent constructor calls setLogger() which sets the logger in $this->client
        parent::__construct( $params );
        // Make sure URL ends with /
        $this->url = rtrim( $params['url'], '/' ) . '/';
        // Default config, R+W > N; no locks on reads though; writes go straight to state-machine
        $this->attrMap[self::ATTR_SYNCWRITES] = self::QOS_SYNCWRITES_QC;
    }
 
    public function setLogger( LoggerInterface $logger ) {
        parent::setLogger( $logger );
        $this->client->setLogger( $logger );
    }
 
    protected function doGet( $key, $flags = 0, &$casToken = null ) {
        $casToken = null;
 
        $req = [
            'method' => 'GET',
            'url' => $this->url . rawurlencode( $key ),
        ];
 
        list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $this->client->run( $req );
        if ( $rcode === 200 ) {
            if ( is_string( $rbody ) ) {
                $value = unserialize( $rbody );
                $casToken = ( $value !== false ) ? $rbody : null;
 
                return $value;
            }
            return false;
        }
        if ( $rcode === 0 || ( $rcode >= 400 && $rcode != 404 ) ) {
            return $this->handleError( "Failed to fetch $key", $rcode, $rerr );
        }
        return false;
    }
 
    public function set( $key, $value, $exptime = 0, $flags = 0 ) {
        // @TODO: respect WRITE_SYNC (e.g. EACH_QUORUM)
        // @TODO: respect $exptime
        $req = [
            'method' => 'PUT',
            'url' => $this->url . rawurlencode( $key ),
            'body' => serialize( $value )
        ];
        list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $this->client->run( $req );
        if ( $rcode === 200 || $rcode === 201 || $rcode === 204 ) {
            return true;
        }
        return $this->handleError( "Failed to store $key", $rcode, $rerr );
    }
 
    public function add( $key, $value, $exptime = 0, $flags = 0 ) {
        // @TODO: make this atomic
        if ( $this->get( $key ) === false ) {
            return $this->set( $key, $value, $exptime, $flags );
        }
 
        return false; // key already set
    }
 
    public function delete( $key, $flags = 0 ) {
        // @TODO: respect WRITE_SYNC (e.g. EACH_QUORUM)
        $req = [
            'method' => 'DELETE',
            'url' => $this->url . rawurlencode( $key ),
        ];
        list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $this->client->run( $req );
        if ( in_array( $rcode, [ 200, 204, 205, 404, 410 ] ) ) {
            return true;
        }
        return $this->handleError( "Failed to delete $key", $rcode, $rerr );
    }
 
    public function incr( $key, $value = 1 ) {
        // @TODO: make this atomic
        $n = $this->get( $key, self::READ_LATEST );
        if ( $this->isInteger( $n ) ) { // key exists?
            $n = max( $n + intval( $value ), 0 );
            // @TODO: respect $exptime
            return $this->set( $key, $n ) ? $n : false;
        }
 
        return false;
    }
 
    protected function handleError( $msg, $rcode, $rerr ) {
        $this->logger->error( "$msg : ({code}) {error}", [
            'code' => $rcode,
            'error' => $rerr
        ] );
        $this->setLastError( $rcode === 0 ? self::ERR_UNREACHABLE : self::ERR_UNEXPECTED );
        return false;
    }
}