RedisConnRef.php

Go to the documentation of this file.

<?php
use Psr\Log\LoggerInterface;
use Psr\Log\LoggerAwareInterface;

class RedisConnRef implements LoggerAwareInterface {
    protected $pool;
    protected $conn;

    protected $server; // string
    protected $lastError; // string

    protected $logger;

    public function __construct(
        RedisConnectionPool $pool, $server, Redis $conn, LoggerInterface $logger
    ) {
        $this->pool = $pool;
        $this->server = $server;
        $this->conn = $conn;
        $this->logger = $logger;
    }

    public function setLogger( LoggerInterface $logger ) {
        $this->logger = $logger;
    }

    public function getServer() {
        return $this->server;
    }

    public function getLastError() {
        return $this->lastError;
    }

    public function clearLastError() {
        $this->lastError = null;
    }

    public function __call( $name, $arguments ) {
        $conn = $this->conn; // convenience

        // Work around https://github.com/nicolasff/phpredis/issues/70
        $lname = strtolower( $name );
        if ( ( $lname === 'blpop' || $lname == 'brpop' )
            && is_array( $arguments[0] ) && isset( $arguments[1] )
        ) {
            $this->pool->resetTimeout( $conn, $arguments[1] + 1 );
        } elseif ( $lname === 'brpoplpush' && isset( $arguments[2] ) ) {
            $this->pool->resetTimeout( $conn, $arguments[2] + 1 );
        }

        $conn->clearLastError();
        try {
            $res = call_user_func_array( [ $conn, $name ], $arguments );
            if ( preg_match( '/^ERR operation not permitted\b/', $conn->getLastError() ) ) {
                $this->pool->reauthenticateConnection( $this->server, $conn );
                $conn->clearLastError();
                $res = call_user_func_array( [ $conn, $name ], $arguments );
                $this->logger->info(
                    "Used automatic re-authentication for method '$name'.",
                    [ 'redis_server' => $this->server ]
                );
            }
        } catch ( RedisException $e ) {
            $this->pool->resetTimeout( $conn ); // restore
            throw $e;
        }

        $this->lastError = $conn->getLastError() ?: $this->lastError;

        $this->pool->resetTimeout( $conn ); // restore

        return $res;
    }

    public function luaEval( $script, array $params, $numKeys ) {
        $sha1 = sha1( $script ); // 40 char hex
        $conn = $this->conn; // convenience
        $server = $this->server; // convenience

        // Try to run the server-side cached copy of the script
        $conn->clearLastError();
        $res = $conn->evalSha( $sha1, $params, $numKeys );
        // If we got a permission error reply that means that (a) we are not in
        // multi()/pipeline() and (b) some connection problem likely occurred. If
        // the password the client gave was just wrong, an exception should have
        // been thrown back in getConnection() previously.
        if ( preg_match( '/^ERR operation not permitted\b/', $conn->getLastError() ) ) {
            $this->pool->reauthenticateConnection( $server, $conn );
            $conn->clearLastError();
            $res = $conn->eval( $script, $params, $numKeys );
            $this->logger->info(
                "Used automatic re-authentication for Lua script '$sha1'.",
                [ 'redis_server' => $server ]
            );
        }
        // If the script is not in cache, use eval() to retry and cache it
        if ( preg_match( '/^NOSCRIPT/', $conn->getLastError() ) ) {
            $conn->clearLastError();
            $res = $conn->eval( $script, $params, $numKeys );
            $this->logger->info(
                "Used eval() for Lua script '$sha1'.",
                [ 'redis_server' => $server ]
            );
        }

        if ( $conn->getLastError() ) { // script bug?
            $this->logger->error(
                'Lua script error on server "{redis_server}": {lua_error}',
                [
                    'redis_server' => $server,
                    'lua_error' => $conn->getLastError()
                ]
            );
        }

        $this->lastError = $conn->getLastError() ?: $this->lastError;

        return $res;
    }

    public function isConnIdentical( Redis $conn ) {
        return $this->conn === $conn;
    }

    function __destruct() {
        $this->pool->freeConnection( $this->server, $this->conn );
    }
}