mirror of
https://github.com/newnius/YAO-portal.git
synced 2025-12-16 17:56:45 +00:00
397 lines
12 KiB
PHP
397 lines
12 KiB
PHP
<?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\Connection;
|
|
|
|
use Predis\Command\CommandInterface;
|
|
use Predis\Response\Error as ErrorResponse;
|
|
use Predis\Response\ErrorInterface as ErrorResponseInterface;
|
|
use Predis\Response\Status as StatusResponse;
|
|
|
|
/**
|
|
* Standard connection to Redis servers implemented on top of PHP's streams.
|
|
* The connection parameters supported by this class are:.
|
|
*
|
|
* - scheme: it can be either 'redis', 'tcp', 'rediss', 'tls' or 'unix'.
|
|
* - host: hostname or IP address of the server.
|
|
* - port: TCP port of the server.
|
|
* - path: path of a UNIX domain socket when scheme is 'unix'.
|
|
* - timeout: timeout to perform the connection (default is 5 seconds).
|
|
* - read_write_timeout: timeout of read / write operations.
|
|
* - async_connect: performs the connection asynchronously.
|
|
* - tcp_nodelay: enables or disables Nagle's algorithm for coalescing.
|
|
* - persistent: the connection is left intact after a GC collection.
|
|
* - ssl: context options array (see http://php.net/manual/en/context.ssl.php)
|
|
*
|
|
* @author Daniele Alessandri <suppakilla@gmail.com>
|
|
*/
|
|
class StreamConnection extends AbstractConnection
|
|
{
|
|
/**
|
|
* Disconnects from the server and destroys the underlying resource when the
|
|
* garbage collector kicks in only if the connection has not been marked as
|
|
* persistent.
|
|
*/
|
|
public function __destruct()
|
|
{
|
|
if (isset($this->parameters->persistent) && $this->parameters->persistent) {
|
|
return;
|
|
}
|
|
|
|
$this->disconnect();
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
protected function assertParameters(ParametersInterface $parameters)
|
|
{
|
|
switch ($parameters->scheme) {
|
|
case 'tcp':
|
|
case 'redis':
|
|
case 'unix':
|
|
break;
|
|
|
|
case 'tls':
|
|
case 'rediss':
|
|
$this->assertSslSupport($parameters);
|
|
break;
|
|
|
|
default:
|
|
throw new \InvalidArgumentException("Invalid scheme: '$parameters->scheme'.");
|
|
}
|
|
|
|
return $parameters;
|
|
}
|
|
|
|
/**
|
|
* Checks needed conditions for SSL-encrypted connections.
|
|
*
|
|
* @param ParametersInterface $parameters Initialization parameters for the connection.
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
*/
|
|
protected function assertSslSupport(ParametersInterface $parameters)
|
|
{
|
|
if (
|
|
filter_var($parameters->persistent, FILTER_VALIDATE_BOOLEAN) &&
|
|
version_compare(PHP_VERSION, '7.0.0beta') < 0
|
|
) {
|
|
throw new \InvalidArgumentException('Persistent SSL connections require PHP >= 7.0.0.');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
protected function createResource()
|
|
{
|
|
switch ($this->parameters->scheme) {
|
|
case 'tcp':
|
|
case 'redis':
|
|
return $this->tcpStreamInitializer($this->parameters);
|
|
|
|
case 'unix':
|
|
return $this->unixStreamInitializer($this->parameters);
|
|
|
|
case 'tls':
|
|
case 'rediss':
|
|
return $this->tlsStreamInitializer($this->parameters);
|
|
|
|
default:
|
|
throw new \InvalidArgumentException("Invalid scheme: '{$this->parameters->scheme}'.");
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Creates a connected stream socket resource.
|
|
*
|
|
* @param ParametersInterface $parameters Connection parameters.
|
|
* @param string $address Address for stream_socket_client().
|
|
* @param int $flags Flags for stream_socket_client().
|
|
*
|
|
* @return resource
|
|
*/
|
|
protected function createStreamSocket(ParametersInterface $parameters, $address, $flags)
|
|
{
|
|
$timeout = (isset($parameters->timeout) ? (float) $parameters->timeout : 5.0);
|
|
|
|
if (!$resource = @stream_socket_client($address, $errno, $errstr, $timeout, $flags)) {
|
|
$this->onConnectionError(trim($errstr), $errno);
|
|
}
|
|
|
|
if (isset($parameters->read_write_timeout)) {
|
|
$rwtimeout = (float) $parameters->read_write_timeout;
|
|
$rwtimeout = $rwtimeout > 0 ? $rwtimeout : -1;
|
|
$timeoutSeconds = floor($rwtimeout);
|
|
$timeoutUSeconds = ($rwtimeout - $timeoutSeconds) * 1000000;
|
|
stream_set_timeout($resource, $timeoutSeconds, $timeoutUSeconds);
|
|
}
|
|
|
|
if (isset($parameters->tcp_nodelay) && function_exists('socket_import_stream')) {
|
|
$socket = socket_import_stream($resource);
|
|
socket_set_option($socket, SOL_TCP, TCP_NODELAY, (int) $parameters->tcp_nodelay);
|
|
}
|
|
|
|
return $resource;
|
|
}
|
|
|
|
/**
|
|
* Initializes a TCP stream resource.
|
|
*
|
|
* @param ParametersInterface $parameters Initialization parameters for the connection.
|
|
*
|
|
* @return resource
|
|
*/
|
|
protected function tcpStreamInitializer(ParametersInterface $parameters)
|
|
{
|
|
if (!filter_var($parameters->host, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6)) {
|
|
$address = "tcp://$parameters->host:$parameters->port";
|
|
} else {
|
|
$address = "tcp://[$parameters->host]:$parameters->port";
|
|
}
|
|
|
|
$flags = STREAM_CLIENT_CONNECT;
|
|
|
|
if (isset($parameters->async_connect) && $parameters->async_connect) {
|
|
$flags |= STREAM_CLIENT_ASYNC_CONNECT;
|
|
}
|
|
|
|
if (isset($parameters->persistent)) {
|
|
if (false !== $persistent = filter_var($parameters->persistent, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE)) {
|
|
$flags |= STREAM_CLIENT_PERSISTENT;
|
|
|
|
if ($persistent === null) {
|
|
$address = "{$address}/{$parameters->persistent}";
|
|
}
|
|
}
|
|
}
|
|
|
|
$resource = $this->createStreamSocket($parameters, $address, $flags);
|
|
|
|
return $resource;
|
|
}
|
|
|
|
/**
|
|
* Initializes a UNIX stream resource.
|
|
*
|
|
* @param ParametersInterface $parameters Initialization parameters for the connection.
|
|
*
|
|
* @return resource
|
|
*/
|
|
protected function unixStreamInitializer(ParametersInterface $parameters)
|
|
{
|
|
if (!isset($parameters->path)) {
|
|
throw new \InvalidArgumentException('Missing UNIX domain socket path.');
|
|
}
|
|
|
|
$flags = STREAM_CLIENT_CONNECT;
|
|
|
|
if (isset($parameters->persistent)) {
|
|
if (false !== $persistent = filter_var($parameters->persistent, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE)) {
|
|
$flags |= STREAM_CLIENT_PERSISTENT;
|
|
|
|
if ($persistent === null) {
|
|
throw new \InvalidArgumentException(
|
|
'Persistent connection IDs are not supported when using UNIX domain sockets.'
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
$resource = $this->createStreamSocket($parameters, "unix://{$parameters->path}", $flags);
|
|
|
|
return $resource;
|
|
}
|
|
|
|
/**
|
|
* Initializes a SSL-encrypted TCP stream resource.
|
|
*
|
|
* @param ParametersInterface $parameters Initialization parameters for the connection.
|
|
*
|
|
* @return resource
|
|
*/
|
|
protected function tlsStreamInitializer(ParametersInterface $parameters)
|
|
{
|
|
$resource = $this->tcpStreamInitializer($parameters);
|
|
$metadata = stream_get_meta_data($resource);
|
|
|
|
// Detect if crypto mode is already enabled for this stream (PHP >= 7.0.0).
|
|
if (isset($metadata['crypto'])) {
|
|
return $resource;
|
|
}
|
|
|
|
if (is_array($parameters->ssl)) {
|
|
$options = $parameters->ssl;
|
|
} else {
|
|
$options = array();
|
|
}
|
|
|
|
if (!isset($options['crypto_type'])) {
|
|
$options['crypto_type'] = STREAM_CRYPTO_METHOD_TLS_CLIENT;
|
|
}
|
|
|
|
if (!stream_context_set_option($resource, array('ssl' => $options))) {
|
|
$this->onConnectionError('Error while setting SSL context options');
|
|
}
|
|
|
|
if (!stream_socket_enable_crypto($resource, true, $options['crypto_type'])) {
|
|
$this->onConnectionError('Error while switching to encrypted communication');
|
|
}
|
|
|
|
return $resource;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function connect()
|
|
{
|
|
if (parent::connect() && $this->initCommands) {
|
|
foreach ($this->initCommands as $command) {
|
|
$response = $this->executeCommand($command);
|
|
|
|
if ($response instanceof ErrorResponseInterface) {
|
|
$this->onConnectionError("`{$command->getId()}` failed: $response", 0);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function disconnect()
|
|
{
|
|
if ($this->isConnected()) {
|
|
fclose($this->getResource());
|
|
parent::disconnect();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Performs a write operation over the stream of the buffer containing a
|
|
* command serialized with the Redis wire protocol.
|
|
*
|
|
* @param string $buffer Representation of a command in the Redis wire protocol.
|
|
*/
|
|
protected function write($buffer)
|
|
{
|
|
$socket = $this->getResource();
|
|
|
|
while (($length = strlen($buffer)) > 0) {
|
|
$written = @fwrite($socket, $buffer);
|
|
|
|
if ($length === $written) {
|
|
return;
|
|
}
|
|
|
|
if ($written === false || $written === 0) {
|
|
$this->onConnectionError('Error while writing bytes to the server.');
|
|
}
|
|
|
|
$buffer = substr($buffer, $written);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function read()
|
|
{
|
|
$socket = $this->getResource();
|
|
$chunk = fgets($socket);
|
|
|
|
if ($chunk === false || $chunk === '') {
|
|
$this->onConnectionError('Error while reading line from the server.');
|
|
}
|
|
|
|
$prefix = $chunk[0];
|
|
$payload = substr($chunk, 1, -2);
|
|
|
|
switch ($prefix) {
|
|
case '+':
|
|
return StatusResponse::get($payload);
|
|
|
|
case '$':
|
|
$size = (int) $payload;
|
|
|
|
if ($size === -1) {
|
|
return;
|
|
}
|
|
|
|
$bulkData = '';
|
|
$bytesLeft = ($size += 2);
|
|
|
|
do {
|
|
$chunk = fread($socket, min($bytesLeft, 4096));
|
|
|
|
if ($chunk === false || $chunk === '') {
|
|
$this->onConnectionError('Error while reading bytes from the server.');
|
|
}
|
|
|
|
$bulkData .= $chunk;
|
|
$bytesLeft = $size - strlen($bulkData);
|
|
} while ($bytesLeft > 0);
|
|
|
|
return substr($bulkData, 0, -2);
|
|
|
|
case '*':
|
|
$count = (int) $payload;
|
|
|
|
if ($count === -1) {
|
|
return;
|
|
}
|
|
|
|
$multibulk = array();
|
|
|
|
for ($i = 0; $i < $count; ++$i) {
|
|
$multibulk[$i] = $this->read();
|
|
}
|
|
|
|
return $multibulk;
|
|
|
|
case ':':
|
|
$integer = (int) $payload;
|
|
return $integer == $payload ? $integer : $payload;
|
|
|
|
case '-':
|
|
return new ErrorResponse($payload);
|
|
|
|
default:
|
|
$this->onProtocolError("Unknown response prefix: '$prefix'.");
|
|
|
|
return;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function writeRequest(CommandInterface $command)
|
|
{
|
|
$commandID = $command->getId();
|
|
$arguments = $command->getArguments();
|
|
|
|
$cmdlen = strlen($commandID);
|
|
$reqlen = count($arguments) + 1;
|
|
|
|
$buffer = "*{$reqlen}\r\n\${$cmdlen}\r\n{$commandID}\r\n";
|
|
|
|
foreach ($arguments as $argument) {
|
|
$arglen = strlen($argument);
|
|
$buffer .= "\${$arglen}\r\n{$argument}\r\n";
|
|
}
|
|
|
|
$this->write($buffer);
|
|
}
|
|
}
|