-
Notifications
You must be signed in to change notification settings - Fork 10
/
Client.php
327 lines (280 loc) · 8.43 KB
/
Client.php
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
<?php
/**
* This file is part of The Lightbulb Project
*
* Copyright 2011 Pavel Ptacek and Animal Group
*
* @author Pavel Ptacek <birdie at animalgroup dot cz>
* @copyright Pavel Ptacek and Animal Group <www dot animalgroup dot cz>
* @license New BSD License
*/
namespace Lightbulb\Json\Rpc2;
/**
* This is JSON-RPC version 2 client
*
* Conforms http://groups.google.com/group/json-rpc/web/json-rpc-2-0?pli=1
*
* Usage:
* <code>
* $client = new Lightbulb\Json\Rpc2\Client('http://endpoint');
* $return = $client->method(arg1, arg2, ...);
*
* // optionally add custom curl headers (for example: timeout)
* $client->setOption(CURLOPT_TIMEOUT, 400);
*
* // Results in method "math.sum"
* $return = $client->math->sum(arg1, arg2, arg3, ...);
*
* // Any level of nesting is possible, hence following is valid:
* $return = $client->strings->hash->encode("string");
*
* // You can also use
* $return = $client->__call('strings.hash.encode', 'string');
* </code>
*
* Currently, the implementation does not support batch calls from the client side
* -> the server however, does.
*
* @author Pavel Ptacek
*/
class Client {
/**
* Determines indentation for debugging (self::formatJsonString)
*/
const DEBUG_INDENT = 4;
/** @var string */
protected $_endpoint;
/** @var bool */
protected $_debug;
/** @var array */
private $_callstack;
/** @var int */
private $_id;
/** @var string */
protected $_debugRequest;
// curl additonal options
/** @var array */
private $options = array();
/** @var string */
protected $_debugResponse;
/**
* Creates json-conforming request
*
* @param type $method
* @param type $args
* @return string
*/
protected function _requestFactory($method, $args) {
$request = new \stdClass;
$request->jsonrpc = '2.0';
$request->method = $method;
$request->params = $args;
$request->id = $this->_id++;
return json_encode($request);
}
/**
* add CURL option - see https://www.php.net/manual/en/function.curl-setopt.php
*
* @param int $option
* @param mixed $value
* @return void
*/
public function setOption($option, $value) {
$this->options[$option] = $value;
}
/**
* Creates new cURL handle
*/
protected function &_curlFactory($data) {
$options = array(
CURLOPT_FRESH_CONNECT => false,
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POSTFIELDS => $data,
);
foreach ($this->options as $option => $value) {
$options[$option] = $value;
}
$curl = curl_init($this->_endpoint);
curl_setopt_array($curl, $options);
return $curl;
}
/**
* The magic getter in order to make class.method calls possible
*/
public function __get($name) {
$this->_callstack[] = $name;
return $this;
}
/**
* The RPC actual caller
*/
public function __call($method, $args) {
// use callstack or not?
if(strpos($method, '.') === false && count($this->_callstack) > 0) {
$method = implode('.', $this->_callstack) . '.' . $method;
}
// Empty callstack, construct cURL object, call and return
$this->_callstack = array();
$request = $this->_requestFactory($method, $args);
$curl = $this->_curlFactory(json_encode($request));
$raw = curl_exec($curl);
$return = json_decode($raw);
curl_close($curl);
// Debugging?
if($this->_debug === true) {
$this->_debugRequest = $request;
$this->_debugResponse = $raw;
}
return $return;
}
/**
* Create new client to an endpoint
*
* @param string $endpointUrl
*/
public function __construct($endpointUrl) {
$this->_endpoint = $endpointUrl;
$this->_callstack = array();
$this->_id = 0;
$this->_debug = false;
}
/**
* Send batch of requests into the server and return the response
*
* @param array $batch
* @return array|null
*/
public function _batchRequest($method, array $batch = array()) {
$data = array();
foreach($batch as $one) {
$data[] = $this->_requestFactory($method, $one);
}
// Build the curl, execute and return
$curl = $this->_curlFactory($data);
$raw = curl_exec($curl);
$return = json_decode($raw);
curl_close($curl);
// Debug!
if($this->_debug === true) {
$this->_debugRequest = $data;
$this->_debugResponse = $raw;
}
return $return;
}
/**
* Enable or disable debug
*/
public function _debug($enable = true) {
$this->_debug = (bool)$enable;
}
/**
* Get raw request string
*
* @return string|array (array if batch request)
*/
public function _getRequest() {
return $this->_debugRequest;
}
/**
* Get raw response output
*
* @return string
*/
public function _getResponse() {
return $this->_debugResponse;
}
/**
* Format the json string from debugging functions & return it
*
* @param string|array $jsonData
* @return string|array
*/
public static function formatJson($jsonData) {
if(is_array($jsonData)) {
$out = array();
foreach($jsonData as $one) {
$out[] = self::_formatJsonActual($one);
}
return $out;
}
// Or return the formatted string
return self::_formatJsonActual($jsonData);
}
/**
* Actually formats the data
*
* @param string $jsonData
* @return string
*/
private static function _formatJsonActual($jsonData) {
$len = strlen($jsonData);
$out = '';
$level = 0;
// Char-by-char
$actionChars = array('{', '}', ':', ',', '"');
$inQuotes = false;
for($i = 0; $i < $len; ++$i) {
$c = $jsonData[$i];
if(!in_array($c, $actionChars)) {
$out .= $c;
continue;
}
// If we have ":", then we just add space before & after
if($c == ':' && $inQuotes == false) {
$out .= ' : ';
continue;
}
elseif($c == ':') {
$out .= ':';
continue;
}
// If we have {, increment the nesting
if($c == '{') {
$level++;
$out .= $c;
$out .= "\n";
if($level > 0) {
$out .= str_repeat(' ', $level * self::DEBUG_INDENT);
}
continue;
}
// If we have , -> newline
if($c == ',') {
$out .= ',';
$out .= "\n";
if($level > 0) {
$out .= str_repeat(' ', $level * self::DEBUG_INDENT);
}
continue;
}
// If we have }, then decrement nesting
if($c == '}') {
$appendIndent = false;
// Check if next character is comma
if($c == '}' && ($i+1) < $len && $jsonData[$i+1] == ',') {
$c .= ',';
$i++;
$appendIndent = true;
}
$level--;
$indentLevel = $level * self::DEBUG_INDENT;
$out .= "\n";
if($indentLevel > 0) {
$out .= str_repeat(' ', $level * self::DEBUG_INDENT);
}
$out .= $c;
$out .= "\n";
if($appendIndent === true && $indentLevel > 0) {
$out .= str_repeat(' ', $level * self::DEBUG_INDENT);;
}
continue;
}
// If we have quote, mark it
if($c == '"') {
$inQuotes = !$inQuotes;
}
}
return $out;
}
}