Moved cache drivers outside core to extensions (plugins)

plugins/cache-redis/Predis/Response/Error.php

@@ -0,0 +1,59 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) Daniele Alessandri <suppakilla@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Response;
+
+/**
+ * Represents an error returned by Redis (-ERR responses) during the execution
+ * of a command on the server.
+ *
+ * @author Daniele Alessandri <suppakilla@gmail.com>
+ */
+class Error implements ErrorInterface
+{
+    private $message;
+
+    /**
+     * @param string $message Error message returned by Redis
+     */
+    public function __construct($message)
+    {
+        $this->message = $message;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getMessage()
+    {
+        return $this->message;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getErrorType()
+    {
+        list($errorType) = explode(' ', $this->getMessage(), 2);
+
+        return $errorType;
+    }
+
+    /**
+     * Converts the object to its string representation.
+     *
+     * @return string
+     */
+    public function __toString()
+    {
+        return $this->getMessage();
+    }
+}

plugins/cache-redis/Predis/Response/ErrorInterface.php

@@ -0,0 +1,35 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) Daniele Alessandri <suppakilla@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Response;
+
+/**
+ * Represents an error returned by Redis (responses identified by "-" in the
+ * Redis protocol) during the execution of an operation on the server.
+ *
+ * @author Daniele Alessandri <suppakilla@gmail.com>
+ */
+interface ErrorInterface extends ResponseInterface
+{
+    /**
+     * Returns the error message.
+     *
+     * @return string
+     */
+    public function getMessage();
+
+    /**
+     * Returns the error type (e.g. ERR, ASK, MOVED).
+     *
+     * @return string
+     */
+    public function getErrorType();
+}

plugins/cache-redis/Predis/Response/Iterator/MultiBulk.php

@@ -0,0 +1,77 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) Daniele Alessandri <suppakilla@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Response\Iterator;
+
+use Predis\Connection\NodeConnectionInterface;
+
+/**
+ * Streamable multibulk response.
+ *
+ * @author Daniele Alessandri <suppakilla@gmail.com>
+ */
+class MultiBulk extends MultiBulkIterator
+{
+    private $connection;
+
+    /**
+     * @param NodeConnectionInterface $connection Connection to Redis.
+     * @param int                     $size       Number of elements of the multibulk response.
+     */
+    public function __construct(NodeConnectionInterface $connection, $size)
+    {
+        $this->connection = $connection;
+        $this->size = $size;
+        $this->position = 0;
+        $this->current = $size > 0 ? $this->getValue() : null;
+    }
+
+    /**
+     * Handles the synchronization of the client with the Redis protocol when
+     * the garbage collector kicks in (e.g. when the iterator goes out of the
+     * scope of a foreach or it is unset).
+     */
+    public function __destruct()
+    {
+        $this->drop(true);
+    }
+
+    /**
+     * Drop queued elements that have not been read from the connection either
+     * by consuming the rest of the multibulk response or quickly by closing the
+     * underlying connection.
+     *
+     * @param bool $disconnect Consume the iterator or drop the connection.
+     */
+    public function drop($disconnect = false)
+    {
+        if ($disconnect) {
+            if ($this->valid()) {
+                $this->position = $this->size;
+                $this->connection->disconnect();
+            }
+        } else {
+            while ($this->valid()) {
+                $this->next();
+            }
+        }
+    }
+
+    /**
+     * Reads the next item of the multibulk response from the connection.
+     *
+     * @return mixed
+     */
+    protected function getValue()
+    {
+        return $this->connection->read();
+    }
+}

plugins/cache-redis/Predis/Response/Iterator/MultiBulkIterator.php

@@ -0,0 +1,104 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) Daniele Alessandri <suppakilla@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Response\Iterator;
+
+use Predis\Response\ResponseInterface;
+
+/**
+ * Iterator that abstracts the access to multibulk responses allowing them to be
+ * consumed in a streamable fashion without keeping the whole payload in memory.
+ *
+ * This iterator does not support rewinding which means that the iteration, once
+ * consumed, cannot be restarted.
+ *
+ * Always make sure that the whole iteration is consumed (or dropped) to prevent
+ * protocol desynchronization issues.
+ *
+ * @author Daniele Alessandri <suppakilla@gmail.com>
+ */
+abstract class MultiBulkIterator implements \Iterator, \Countable, ResponseInterface
+{
+    protected $current;
+    protected $position;
+    protected $size;
+
+    /**
+     * {@inheritdoc}
+     */
+    public function rewind()
+    {
+        // NOOP
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function current()
+    {
+        return $this->current;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function key()
+    {
+        return $this->position;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function next()
+    {
+        if (++$this->position < $this->size) {
+            $this->current = $this->getValue();
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function valid()
+    {
+        return $this->position < $this->size;
+    }
+
+    /**
+     * Returns the number of items comprising the whole multibulk response.
+     *
+     * This method should be used instead of iterator_count() to get the size of
+     * the current multibulk response since the former consumes the iteration to
+     * count the number of elements, but our iterators do not support rewinding.
+     *
+     * @return int
+     */
+    public function count()
+    {
+        return $this->size;
+    }
+
+    /**
+     * Returns the current position of the iterator.
+     *
+     * @return int
+     */
+    public function getPosition()
+    {
+        return $this->position;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    abstract protected function getValue();
+}

plugins/cache-redis/Predis/Response/Iterator/MultiBulkTuple.php

@@ -0,0 +1,90 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) Daniele Alessandri <suppakilla@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Response\Iterator;
+
+/**
+ * Outer iterator consuming streamable multibulk responses by yielding tuples of
+ * keys and values.
+ *
+ * This wrapper is useful for responses to commands such as `HGETALL` that can
+ * be iterater as $key => $value pairs.
+ *
+ * @author Daniele Alessandri <suppakilla@gmail.com>
+ */
+class MultiBulkTuple extends MultiBulk implements \OuterIterator
+{
+    private $iterator;
+
+    /**
+     * @param MultiBulk $iterator Inner multibulk response iterator.
+     */
+    public function __construct(MultiBulk $iterator)
+    {
+        $this->checkPreconditions($iterator);
+
+        $this->size = count($iterator) / 2;
+        $this->iterator = $iterator;
+        $this->position = $iterator->getPosition();
+        $this->current = $this->size > 0 ? $this->getValue() : null;
+    }
+
+    /**
+     * Checks for valid preconditions.
+     *
+     * @param MultiBulk $iterator Inner multibulk response iterator.
+     *
+     * @throws \InvalidArgumentException
+     * @throws \UnexpectedValueException
+     */
+    protected function checkPreconditions(MultiBulk $iterator)
+    {
+        if ($iterator->getPosition() !== 0) {
+            throw new \InvalidArgumentException(
+                'Cannot initialize a tuple iterator using an already initiated iterator.'
+            );
+        }
+
+        if (($size = count($iterator)) % 2 !== 0) {
+            throw new \UnexpectedValueException('Invalid response size for a tuple iterator.');
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getInnerIterator()
+    {
+        return $this->iterator;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function __destruct()
+    {
+        $this->iterator->drop(true);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getValue()
+    {
+        $k = $this->iterator->current();
+        $this->iterator->next();
+
+        $v = $this->iterator->current();
+        $this->iterator->next();
+
+        return array($k, $v);
+    }
+}

plugins/cache-redis/Predis/Response/ResponseInterface.php

@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) Daniele Alessandri <suppakilla@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Response;
+
+/**
+ * Represents a complex response object from Redis.
+ *
+ * @author Daniele Alessandri <suppakilla@gmail.com>
+ */
+interface ResponseInterface
+{
+}

plugins/cache-redis/Predis/Response/ServerException.php

@@ -0,0 +1,44 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) Daniele Alessandri <suppakilla@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Response;
+
+use Predis\PredisException;
+
+/**
+ * Exception class that identifies server-side Redis errors.
+ *
+ * @author Daniele Alessandri <suppakilla@gmail.com>
+ */
+class ServerException extends PredisException implements ErrorInterface
+{
+    /**
+     * Gets the type of the error returned by Redis.
+     *
+     * @return string
+     */
+    public function getErrorType()
+    {
+        list($errorType) = explode(' ', $this->getMessage(), 2);
+
+        return $errorType;
+    }
+
+    /**
+     * Converts the exception to an instance of Predis\Response\Error.
+     *
+     * @return Error
+     */
+    public function toErrorResponse()
+    {
+        return new Error($this->getMessage());
+    }
+}

plugins/cache-redis/Predis/Response/Status.php

@@ -0,0 +1,79 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) Daniele Alessandri <suppakilla@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Response;
+
+/**
+ * Represents a status response returned by Redis.
+ *
+ * @author Daniele Alessandri <suppakilla@gmail.com>
+ */
+class Status implements ResponseInterface
+{
+    private static $OK;
+    private static $QUEUED;
+
+    private $payload;
+
+    /**
+     * @param string $payload Payload of the status response as returned by Redis.
+     */
+    public function __construct($payload)
+    {
+        $this->payload = $payload;
+    }
+
+    /**
+     * Converts the response object to its string representation.
+     *
+     * @return string
+     */
+    public function __toString()
+    {
+        return $this->payload;
+    }
+
+    /**
+     * Returns the payload of status response.
+     *
+     * @return string
+     */
+    public function getPayload()
+    {
+        return $this->payload;
+    }
+
+    /**
+     * Returns an instance of a status response object.
+     *
+     * Common status responses such as OK or QUEUED are cached in order to lower
+     * the global memory usage especially when using pipelines.
+     *
+     * @param string $payload Status response payload.
+     *
+     * @return string
+     */
+    public static function get($payload)
+    {
+        switch ($payload) {
+            case 'OK':
+            case 'QUEUED':
+                if (isset(self::$$payload)) {
+                    return self::$$payload;
+                }
+
+                return self::$$payload = new self($payload);
+
+            default:
+                return new self($payload);
+        }
+    }
+}