1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 

<?php

namespace bandwidthThrottle\tokenBucket\storage;

use bandwidthThrottle\tokenBucket\storage\scope\GlobalScope;
use malkusch\lock\mutex\MemcacheMutex;

/**
 * Memcache based storage which can be shared among processes.
 *
 * This storage is in the global scope.
 *
 * @author Markus Malkusch <markus@malkusch.de>
 * @link bitcoin:1335STSwu9hST4vcMRppEPgENMHD2r1REK Donations
 * @license WTFPL
 * @deprecated 1.0.0 There's no support for the memcache extension under PHP-7.
 *             Consider using ext-mecached and {@link MemcachedStorage}.
 *             This storage will not be removed, however there's no guarantee
 *             that it will work. As soon as ext-memcache is available for PHP-7
 *             the deprecation will be reverted.
 */
final class MemcacheStorage implements Storage, GlobalScope
{

    /**
     * @var \Memcache The connected memcache API.
     */
    private $memcache;
    
    /**
     * @var string The key for the token bucket.
     */
    private $key;
    
    /**
     * @var MemcacheMutex The mutex for this storage.
     */
    private $mutex;

    /**
     * @internal
     */
    const PREFIX = "TokenBucket_";
    
    /**
     * Sets the connected memcache API and the token bucket name.
     *
     * The api needs to be connected already. I.e. Memcache::connect() was
     * already called.
     *
     * @param string    $name     The name of the shared token bucket.
     * @param \Memcache $memcache The connected memcache API.
     */
    public function __construct($name, \Memcache $memcache)
    {
        trigger_error("MemcacheStorage has been deprecated in favour of MemcachedStorage.", E_USER_DEPRECATED);
        
        $this->memcache = $memcache;
        $this->key      = self::PREFIX . $name;
        $this->mutex    = new MemcacheMutex($name, $memcache);
    }

    public function bootstrap($microtime)
    {
        $this->setMicrotime($microtime);
    }
    
    public function isBootstrapped()
    {
        return $this->memcache->get($this->key) !== false;
    }
    
    public function remove()
    {
        if (!$this->memcache->delete($this->key)) {
            throw new StorageException("Could not remove microtime.");
        }
    }
    
    public function setMicrotime($microtime)
    {
        if (!$this->memcache->set($this->key, $microtime, 0, 0)) {
            throw new StorageException("Could not set microtime.");
        }
    }

    public function getMicrotime()
    {
        $microtime = $this->memcache->get($this->key);
        if ($microtime === false) {
            throw new StorageException("The key '$this->key' was not found.");
        }
        return (double) $microtime;
    }

    public function getMutex()
    {
        return $this->mutex;
    }

    public function letMicrotimeUnchanged()
    {
    }
}