forked from banditsmile/terminal
-
Notifications
You must be signed in to change notification settings - Fork 0
/
json-rpc.php
217 lines (195 loc) · 6.81 KB
/
json-rpc.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
<?php
/*
JSON-RPC Server implemenation
Copyright (C) 2009 Jakub Jankiewicz <http://jcubic.pl>
This program 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 3 of the License, or
(at your option) any later version.
This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
*/
/*
USAGE: create one class with public methods and call handle_json_rpc function
with instance of this class
<?php
require('json_rpc.php');
class Server {
public function test($message) {
retrun "you send " . $message;
}
}
handle_json_rpc(new Server());
?>
you can provide documentations for methods
by adding static field:
class Server {
...
public static $test_documentation = "doc string";
}
It alway create one method 'help' which return string
with list of methods if call with no arguments and
return documentation string for method passed as parameter.
*/
// ----------------------------------------------------------------------------
function json_error() {
switch (json_last_error()) {
case JSON_ERROR_NONE:
return 'No error has occurred';
case JSON_ERROR_DEPTH:
return 'The maximum stack depth has been exceeded';
case JSON_ERROR_CTRL_CHAR:
return 'Control character error, possibly incorrectly encoded';
case JSON_ERROR_SYNTAX:
return 'Syntax error';
case JSON_ERROR_UTF8:
return 'Malformed UTF-8 characters, possibly incorrectly encoded';
}
}
// ----------------------------------------------------------------------------
// check if object has field
function has_field($object, $field) {
//return in_array($field, array_keys(get_object_vars($object)));
return array_key_exists($field, get_object_vars($object));
}
// ----------------------------------------------------------------------------
// return object field if exist otherwise return default value
function get_field($object, $field, $default) {
$array = get_object_vars($object);
if (isset($array[$field])) {
return $array[$field];
} else {
return $default;
}
}
// ----------------------------------------------------------------------------
//create json-rpc response
function response($result, $id, $error) {
return json_encode(array("jsonrpc" => "2.0",
'result' => $result,
'id' => $id,
'error'=> $error));
}
// ----------------------------------------------------------------------------
// try to extract id from broken json
function extract_id() {
$regex = '/[\'"]id[\'"] *: *([0-9]*)/';
if (preg_match($regex, $GLOBALS['HTTP_RAW_POST_DATA'], $m)) {
return $m[1];
} else {
return 0;
}
}
// ----------------------------------------------------------------------------
function handle_json_rpc($object) {
/*
if ($input == '') {
$input = file_get_contents('php://input');
}
*/
$input = $GLOBALS['HTTP_RAW_POST_DATA'];
$encoding = mb_detect_encoding($input, 'auto');
//convert to unicode
if ($encoding != 'UTF-8') {
$input = iconv($encoding, 'UTF-8', $input);
}
$input = json_decode($input);
header('Content-Type: text/plain');
// handle Errors
if (!$input) {
if ($GLOBALS['HTTP_RAW_POST_DATA'] == "") {
echo response(null, 0, array("code"=> -32700,
"message"=>"Parse Error: no data"));
} else {
// json parse error
$error = json_error();
$id = extract_id();
echo response(null, $id, array("code"=> -32700,
"message"=>"Parse Error: $error"));
}
exit;
} else {
$method = get_field($input, 'method', null);
$params = get_field($input, 'params', null);
$id = get_field($input, 'id', null);
// json rpc error
if (!($method && $id)) {
if (!$id) {
$id = extract_id();
}
if (!$method) {
$error = "no method";
} else if (!$id) {
$error = "no id";
} else {
$error = "unknown reason";
}
echo response(null, $id, array("code" => -32600,
"message" => "Invalid Request: $error"));
exit;
}
}
// fix params (if params is null set it to empty array)
if (!$params) {
$params = array();
}
// if params is object change it to array
if (is_object($params)) {
if (count(get_object_vars($params)) == 0) {
$params = array();
} else {
$params = get_object_vars($params);
}
}
// call Service Method
try {
$class = get_class($object);
$methods = get_class_methods($class);
do_debug($methods);
if (strcmp($method, 'help') == 0) {
if (count($params) > 0) {
if (!in_array($params[0], $methods)) {
$no_method = 'There is no ' . $params[0] . ' method';
throw new Exception($no_method);
} else {
$static = get_class_vars($class);
$help_str_name = $params[0] . "_documentation";
//throw new Exception(implode(", ", $static));
if (array_key_exists($help_str_name, $static)) {
echo response($static[$help_str_name], $id, null);
} else {
throw new Exception($method . " method has no documentation");
}
}
} else {
$url = "http://" . $_SERVER["HTTP_HOST"] . $_SERVER["REQUEST_URI"];
$msg = 'PHP JSON-RPC - in "' . $url . "\"\n";
$msg .= "class \"$class\" has methods: " . implode(", ", array_slice($methods, 0, -1)) . " and " . $methods[count($methods)-1] . ".";
echo response($msg, $id, null);
}
} else if (!in_array($method, $methods)) {
$msg = 'There is no ' . $method . ' method';
echo response(null, $id, array("code" =>-32601, "message" => $msg));
} else {
//throw new Exception('x -> ' . json_encode($params));
$result = call_user_func_array(array($object, $method), $params);
echo response($result, $id, null);
}
exit;
} catch (Exception $e) {
//catch all exeption from user code
$msg = "Internal error: " . $e->getMessage();
echo response(null, $id, array("code"=>-32603, "message"=>$msg));
}
}
function do_debug($msg){
$log_path = dirname(__FILE__).'/debug.log';
$msg = is_string($msg) ? $msg : json_encode($msg);
$msg = date('Ymd H:i:s').'|'.$msg;
return file_put_contents($log_path,$msg.PHP_EOL,FILE_APPEND);
}
?>