miniflux-legacy/vendor/fguillot/json-rpc/src/JsonRPC/Client.php

390 lines
9.2 KiB
PHP
Raw Normal View History

2013-07-28 21:44:51 +02:00
<?php
namespace JsonRPC;
2015-08-15 03:33:39 +02:00
use Exception;
use RuntimeException;
use BadFunctionCallException;
use InvalidArgumentException;
2015-08-15 03:33:39 +02:00
class ConnectionFailureException extends Exception {};
class ServerErrorException extends Exception {};
/**
* JsonRPC client class
*
* @package JsonRPC
2015-08-15 03:33:39 +02:00
* @author Frederic Guillot
*/
2013-07-28 21:44:51 +02:00
class Client
{
/**
* URL of the server
*
* @access private
* @var string
*/
2013-07-28 21:44:51 +02:00
private $url;
2015-06-21 15:56:36 +02:00
/**
* If the only argument passed to a function is an array
* assume it contains named arguments
*
* @access public
* @var boolean
*/
public $named_arguments = true;
/**
* HTTP client timeout
*
* @access private
* @var integer
*/
2013-07-28 21:44:51 +02:00
private $timeout;
/**
* Username for authentication
*
* @access private
* @var string
*/
2013-07-28 21:44:51 +02:00
private $username;
/**
* Password for authentication
*
* @access private
* @var string
*/
2013-07-28 21:44:51 +02:00
private $password;
/**
* True for a batch request
*
* @access public
* @var boolean
*/
public $is_batch = false;
/**
* Batch payload
*
* @access public
* @var array
*/
public $batch = array();
/**
* Enable debug output to the php error log
*
* @access public
* @var boolean
*/
public $debug = false;
/**
* Default HTTP headers to send to the server
*
* @access private
* @var array
*/
2013-07-28 21:44:51 +02:00
private $headers = array(
2015-08-15 03:33:39 +02:00
'User-Agent: JSON-RPC PHP Client <https://github.com/fguillot/JsonRPC>',
2013-07-28 21:44:51 +02:00
'Content-Type: application/json',
2015-08-15 03:33:39 +02:00
'Accept: application/json',
'Connection: close',
2013-07-28 21:44:51 +02:00
);
2015-08-15 03:33:39 +02:00
/**
* SSL certificates verification
2015-08-15 03:33:39 +02:00
*
* @access public
* @var boolean
*/
public $ssl_verify_peer = true;
2013-07-28 21:44:51 +02:00
/**
* Constructor
*
* @access public
* @param string $url Server URL
2015-08-15 03:33:39 +02:00
* @param integer $timeout HTTP timeout
* @param array $headers Custom HTTP headers
*/
2015-08-15 03:33:39 +02:00
public function __construct($url, $timeout = 3, $headers = array())
2013-07-28 21:44:51 +02:00
{
$this->url = $url;
$this->timeout = $timeout;
$this->headers = array_merge($this->headers, $headers);
}
/**
* Automatic mapping of procedures
*
* @access public
* @param string $method Procedure name
* @param array $params Procedure arguments
* @return mixed
*/
public function __call($method, array $params)
2014-02-08 20:13:14 +01:00
{
// Allow to pass an array and use named arguments
2015-06-21 15:56:36 +02:00
if ($this->named_arguments && count($params) === 1 && is_array($params[0])) {
$params = $params[0];
}
2014-02-08 20:13:14 +01:00
return $this->execute($method, $params);
}
/**
* Set authentication parameters
*
* @access public
* @param string $username Username
* @param string $password Password
2015-08-15 03:33:39 +02:00
* @return Client
*/
2013-07-28 21:44:51 +02:00
public function authentication($username, $password)
{
$this->username = $username;
$this->password = $password;
2015-08-15 03:33:39 +02:00
return $this;
2013-07-28 21:44:51 +02:00
}
/**
* Start a batch request
*
* @access public
* @return Client
*/
public function batch()
{
$this->is_batch = true;
$this->batch = array();
return $this;
}
/**
* Send a batch request
*
* @access public
* @return array
*/
public function send()
{
$this->is_batch = false;
return $this->parseResponse(
$this->doRequest($this->batch)
);
}
/**
* Execute a procedure
*
* @access public
* @param string $procedure Procedure name
* @param array $params Procedure arguments
* @return mixed
*/
2013-07-28 21:44:51 +02:00
public function execute($procedure, array $params = array())
{
if ($this->is_batch) {
$this->batch[] = $this->prepareRequest($procedure, $params);
return $this;
}
return $this->parseResponse(
$this->doRequest($this->prepareRequest($procedure, $params))
);
}
2013-07-28 21:44:51 +02:00
/**
* Prepare the payload
*
* @access public
* @param string $procedure Procedure name
* @param array $params Procedure arguments
* @return array
*/
public function prepareRequest($procedure, array $params = array())
{
2013-07-28 21:44:51 +02:00
$payload = array(
'jsonrpc' => '2.0',
'method' => $procedure,
'id' => mt_rand()
2013-07-28 21:44:51 +02:00
);
if (! empty($params)) {
$payload['params'] = $params;
}
return $payload;
}
/**
* Parse the response and return the procedure result
*
* @access public
* @param array $payload
* @return mixed
*/
public function parseResponse(array $payload)
{
if ($this->isBatchResponse($payload)) {
$results = array();
foreach ($payload as $response) {
$results[] = $this->getResult($response);
}
return $results;
}
return $this->getResult($payload);
}
/**
* Throw an exception according the RPC error
*
* @access public
2015-08-15 03:33:39 +02:00
* @param array $error
* @throws BadFunctionCallException
* @throws InvalidArgumentException
* @throws RuntimeException
*/
2015-08-15 03:33:39 +02:00
public function handleRpcErrors(array $error)
{
2015-03-01 19:56:11 +01:00
switch ($error['code']) {
case -32601:
2015-03-01 19:56:11 +01:00
throw new BadFunctionCallException('Procedure not found: '. $error['message']);
case -32602:
2015-09-12 19:34:36 +02:00
throw new ResponseException(
'Invalid arguments: '. $error['message'],
$error['code'],
null,
isset($error['data']) ? $error['data'] : null
);
default:
2015-03-01 19:56:11 +01:00
throw new RuntimeException('Invalid request/response: '. $error['message'], $error['code']);
}
2013-07-28 21:44:51 +02:00
}
/**
2015-08-15 03:33:39 +02:00
* Throw an exception according the HTTP response
*
* @access public
2015-08-15 03:33:39 +02:00
* @param array $headers
* @throws AccessDeniedException
* @throws ServerErrorException
*/
2015-08-15 03:33:39 +02:00
public function handleHttpErrors(array $headers)
2013-07-28 21:44:51 +02:00
{
2015-08-15 03:33:39 +02:00
$exceptions = array(
'401' => 'JsonRPC\AccessDeniedException',
'403' => 'JsonRPC\AccessDeniedException',
'404' => 'JsonRPC\ConnectionFailureException',
'500' => 'JsonRPC\ServerErrorException',
);
2013-07-28 21:44:51 +02:00
2015-08-15 03:33:39 +02:00
foreach ($headers as $header) {
foreach ($exceptions as $code => $exception) {
if (strpos($header, 'HTTP/1.0 '.$code) !== false || strpos($header, 'HTTP/1.1 '.$code) !== false) {
throw new $exception('Response: '.$header);
}
}
2013-07-28 21:44:51 +02:00
}
2015-08-15 03:33:39 +02:00
}
2013-07-28 21:44:51 +02:00
2015-08-15 03:33:39 +02:00
/**
* Do the HTTP request
*
* @access private
* @param array $payload
* @return array
*/
private function doRequest(array $payload)
{
$stream = @fopen(trim($this->url), 'r', false, $this->getContext($payload));
2015-06-21 15:56:36 +02:00
2015-08-15 03:33:39 +02:00
if (! is_resource($stream)) {
throw new ConnectionFailureException('Unable to establish a connection');
2015-06-21 15:56:36 +02:00
}
2015-08-15 03:33:39 +02:00
$metadata = stream_get_meta_data($stream);
$this->handleHttpErrors($metadata['wrapper_data']);
2015-08-15 03:33:39 +02:00
$response = json_decode(stream_get_contents($stream), true);
2013-07-28 21:44:51 +02:00
if ($this->debug) {
error_log('==> Request: '.PHP_EOL.json_encode($payload, JSON_PRETTY_PRINT));
error_log('==> Response: '.PHP_EOL.json_encode($response, JSON_PRETTY_PRINT));
}
2013-07-28 21:44:51 +02:00
return is_array($response) ? $response : array();
}
2015-08-15 03:33:39 +02:00
/**
* Prepare stream context
*
* @access private
* @param array $payload
* @return resource
*/
private function getContext(array $payload)
{
$headers = $this->headers;
if (! empty($this->username) && ! empty($this->password)) {
$headers[] = 'Authorization: Basic '.base64_encode($this->username.':'.$this->password);
}
return stream_context_create(array(
'http' => array(
'method' => 'POST',
'protocol_version' => 1.1,
'timeout' => $this->timeout,
'max_redirects' => 2,
'header' => implode("\r\n", $headers),
'content' => json_encode($payload),
'ignore_errors' => true,
),
"ssl" => array(
"verify_peer" => $this->ssl_verify_peer,
"verify_peer_name" => $this->ssl_verify_peer,
)
));
}
/**
* Return true if we have a batch response
*
* @access public
* @param array $payload
* @return boolean
*/
private function isBatchResponse(array $payload)
{
return array_keys($payload) === range(0, count($payload) - 1);
}
/**
* Get a RPC call result
*
* @access private
* @param array $payload
* @return mixed
*/
private function getResult(array $payload)
{
if (isset($payload['error']['code'])) {
$this->handleRpcErrors($payload['error']);
}
return isset($payload['result']) ? $payload['result'] : null;
}
2013-07-28 21:44:51 +02:00
}