-
Notifications
You must be signed in to change notification settings - Fork 131
/
jsonRPCClient.class.php
193 lines (169 loc) · 4.34 KB
/
jsonRPCClient.class.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
<?php
/*
COPYRIGHT
Copyright 2007 Sergio Vaccaro <[email protected]>
This file is part of JSON-RPC PHP.
JSON-RPC PHP is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
JSON-RPC PHP is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with JSON-RPC PHP; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Modified by m0Ray.
Modified by derjanb
*/
/**
* The object of this class are generic jsonRPC 1.0 clients
* http://json-rpc.org/wiki/specification
*
* @author sergio <[email protected]>
* @author m0Ray <[email protected]>
*/
error_reporting('E_NONE');
class jsonRPCClient {
/**
* Debug state
*
* @var boolean
*/
private $debug = false;
/**
* Debug text buffer
*
* @var boolean
*/
private $debug_out;
/**
* The server URL
*
* @var string
*/
private $url;
/**
* The request id
*
* @var integer
*/
private $id;
/**
* If true, notifications are performed instead of requests
*
* @var boolean
*/
private $notification = false;
/**
* Takes the connection parameters
*
* @param string $url
* @param boolean $debug
*/
public function __construct($url, $proxy = NULL) {
global $debug;
// server URL
$this->url = $url;
// proxy
is_null($proxy) ? $this->proxy = '' : $this->proxy = $proxy;
// debug state
$this->debug = $debug;
// message id
$this->id = 1;
}
/**
* Sets the notification state of the object. In this state, notifications are performed, instead of requests.
*
* @param boolean $notification
*/
public function setRPCNotification($notification) {
empty($notification) ?
$this->notification = false
:
$this->notification = true;
}
/**
* Enable or disable debugging.
*
* @param boolean $debug
*/
public function setDebug($debug) {
$this->debug = $debug;
}
/**
* Performs a jsonRCP request and gets the results as an array
*
* @param string $method
* @param array $params
* @return array
*/
public function __call($method,$params) {
// check
if (!is_scalar($method)) {
throw new Exception('Method name has no scalar value');
}
// check
if (is_array($params)) {
// no keys
$params = array_values($params);
} else {
throw new Exception('Params must be given as array');
}
// sets notification or request task
if ($this->notification) {
$currentId = NULL;
} else {
$currentId = $this->id;
}
// prepares the request
$request = json_encode( array(
'method' => $method,
'params' => $params,
'id' => $currentId
)
);
$this->debug && $this->debug_out.='***** Request *****'."\n".$request."\n".'***** End Of request *****'."\n\n";
// performs the HTTP POST
$context = stream_context_create( array ('http' => array (
'method' => 'POST',
'header' => 'Content-type: application/json',
'content' => $request,
'proxy' => $this->proxy,
'ignore_errors' => true // PHP>=5.2.10
))
);
if ( $fp = fopen($this->url, 'r', false, $context) ) {
$response = '';
while($row = fgets($fp)) {
$response.= trim($row)."\n";
}
fclose($fp);
$this->debug && $this->debug_out.='***** Server response *****'."\n".$response.'***** End of server response *****'."\n";
$response = json_decode($response,true);
} else {
throw new Exception('Unable to connect to '.$this->url.': '.$request);
}
// debug output
if ($this->debug) {
echo nl2br($this->debug_out);
$this->debug_out='';
}
// final checks and return
if (!$this->notification) {
// check
if ($response['id'] != $currentId) {
throw new Exception('Incorrect response id (request id: '.$currentId.', response id: '.$response['id'].')');
}
if (!is_null($response['error'])) {
throw new Exception('Request error: '.print_r($response['error'],1));
}
$this->id++;
return $response['result'];
} else {
return true;
}
}
}
?>