- unsignificant correction
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 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 |
<?php
/** internal exception thrown by jsonRPC */
class jsonRpcException extends Exception{
protected $code = 32098;
}
/** exception to throw in your methods to be treated as jsonRPC error response */
class jsonRpcMethodException extends jsonRpcException{
protected $code = 32099;
}
/**
* class to ease creation of jsonRPC services
* @author jgotti at modedemploi dot fr
* @licence LGPL
* @since 2011-02-25
* @changelog
* - 2011-07-22 - make use of curl in syncRequest when enable else default to fsockopen
* - 2011-05-30 - add htmDiscovery method and some more information on discovery
* - add a $noCache and $allowDiscovery static properties
* - if $allowDiscovery is true and no request is passed then will return the result of htmlDiscovery
* - bug correction in init() that avoided to bind static class at init time
* - 2011-04-27 - add $autoCleanMagicQuotes property
*/
class jsonRPC{
static public $falseIsError=false;
static public $autoCleanMagicQuotes = true;
static public $noCache = false;
static public $allowDiscovery=true;
private $callback = null;
private $methods = array();
private $processingRequest = null;
static public $errors= array(
'PARSE_ERROR' => array('code'=>-32700,'message'=>'Parse error.','data'=>'Invalid JSON. An error occurred on the server while parsing the JSON text.'),
'REQUEST_ERROR' => array('code'=>-32600,'message'=>'Invalid Request.','data'=>'The received JSON is not a valid JSON-RPC Request.'),
'METHOD_ERROR' => array('code'=>-32601,'message'=>'Method not found.','data'=>'The requested remote-procedure does not exist / is not available.'),
'PARAMS_ERROR' => array('code'=>-32602,'message'=>'Invalid params.','data'=>'Invalid method parameters.'),
'INTERNAL_ERROR'=> array('code'=>-32603,'message'=>'Internal error.','data'=>'Internal JSON-RPC error.'),
'SERVER_ERROR' => array('code'=>-32099,'message'=>'Server error.')//,'data'=>'Reserved for implementation-defined server-errors.'),
//array(-32099<->-32000','Server error.','Reserved for implementation-defined server-errors.');//
);
function __construct(){
if( !empty($_GET['callback'])){
$this->callback = $_GET['callback'];
}
if( self::$allowDiscovery ){
$this->bindMethod('discovery',array($this,'discovery'))
->bindMethod('htmlDiscovery',array($this,'htmlDiscovery'));
}
$this->bindMethod('jqueryProxy',array($this,'jqueryProxy'));
set_error_handler(array($this,'phpErrorHandler'));
}
static function init($serviceDefinition,$classMapping=null,$bindParentMethodsToo=false){
$i = new self;
if( is_object($serviceDefinition) || (is_string($serviceDefinition) && class_exists($serviceDefinition,false)) ){
$i->bindClass($serviceDefinition,$classMapping,$bindParentMethodsToo);
}else{
$i->bindMethod($serviceDefinition);
}
return $i->response($i->processRequest());
}
function bindClass($class,$mapping=null,$bindParentMethodsToo=false){
$static = is_string($class)?true:false;
$rclass = new ReflectionClass($class);
$className = $rclass->name;
$methods = $rclass->getMethods(ReflectionMethod::IS_PUBLIC);
if(! $methods ){
return $this;
}
foreach($methods as $m){
$name = $m->name;
if( (! $bindParentMethodsToo) && $m->getDeclaringClass()->name !== $className ){
continue;
}
if( $mapping ){
if(!( $k = array_search($name,$mapping,true)) ){
continue;
}
$name = is_numeric($k)?$name:$k;
}
if( $static === $m->isStatic()){
$this->bindMethod($name,array($class,$m->name));
}
}
return $this;
}
/**
* register a new service method
* @param string $methodName name of the public exposed method
* @param callable $callback the function or object method to call to bind to this methodName
*/
function bindMethod($methodName,$callback=null){
if( null===$callback){
if(! is_array($methodName) ){
return $this->bindMethod($methodName,$methodName);
}
foreach($methodName as $m=>$cb){
if( is_numeric($m) && $cb){ $m = $cb;}
$this->bindMethod($m,$cb);
}
return $this;
}
if( ! is_callable($callback)){
return $this->response($this->error('METHOD_ERROR'));
}
$this->methods[$methodName] = $callback;
return $this;
}
function getRequest(){
$request = $_REQUEST;
if( self::$autoCleanMagicQuotes && get_magic_quotes_gpc() ){
static $cleanMQ;
if( !isset($cleanMQ)){
$cleanMQ = create_function('&$v,$k','$v=stripslashes($v);');
}
array_walk_recursive($request,$cleanMQ);
}
if( isset($request['jsonrpc']) ){
$request = (object) array_merge(array('id'=>null,'method'=>null,'params'=>null),(array) json_decode($request['jsonrpc']));
}elseif(isset($_REQUEST['method'])){
$params = isset($request['params'])?(is_array($request['params'])?$request['params']:(array)json_decode($request['params'])):null;
$request = (object) array(
'id' => empty($request['id'])?null:$request['id'],
'method'=>$request['method'],
'params'=>(isset($request['params']) && null===$params)?(array)$request['params']:$params,
);
}elseif( strlen($rawDatas = file_get_contents('php://input')) ){
$request = json_decode(get_magic_quotes_gpc()?stripslashes($rawDatas):$rawDatas);
if( null === $request)
return $this->response($this->error('PARSE_ERROR'));
}else{
$request= null;
}
return null!==$request?$request:(self::$allowDiscovery?$this->htmlDiscovery():$this->response($this->error('REQUEST_ERROR')));
}
function processRequest($request=null){
$request = $this->getRequest();
if( is_array($request) ){
$responses = array();
foreach( $request as $r){
$r = $this->processRequest($r);
if( is_object($r) )
$responses[] = $r;
}
return $responses;
}
$this->processingRequest = $request;
# -check method validity
if(! isset($request->method,$this->methods[$request->method]) ){
$e = $this->error('METHOD_ERROR');
$this->processingRequest =null;
return $e;
}
#- preparing parameters
if(! ( isset($request->params) && ! in_array($request->params,array('',null,false),true)) ){
$request->params = array();
}elseif(is_object($request->params) ){
$request->params = (array) $request->params;
}elseif( ! is_array($request->params) ){
$request->params = array($request->params);
}
#- preparing response object
$response = new stdClass;
if( isset($request->id) )
$response->id = $request->id;
#- if( isset($request->jsonrpc) && $request->jsonrpc == "2.0")
#- $response->jsonrpc = "2.0";
#- call request method
try{
$response->result = call_user_func_array($this->methods[$request->method],$request->params);
}catch(jsonRpcException $e){
$e = $this->error($e->getCode(),$e instanceof jsonRpcMethodException ?"method result error":"Server method error",$e->getMessage());
$this->processingRequest =null;
return $e;
}catch(Exception $e){
$e = $this->error(-32098,"Server method error",$e->getMessage());
$this->processingRequest =null;
return $e;
}
if( $response->result === null && ! $request->id ){
$this->processingRequest =null;
return null;
}else if( self::$falseIsError && $response->result === false){
$e = $this->error("SERVER_ERROR");
$this->processingRequest =null;
return $e;
}
$this->processingRequest =null;
return $response;
}
function phpErrorHandler($no,$str,$file,$line,$context=null){
if (!(error_reporting() & $no)) { //-- only trigger codes included in error_reporting
return;
}
$errorsNo = array(
E_USER_ERROR => 'Fatal error',
E_ERROR => 'Fatal error',
E_COMPILE_ERROR => 'Fatal error',
E_RECOVERABLE_ERROR => 'Fatal Recoverable error',
E_USER_WARNING => 'Warning',
E_WARNING => 'Warning',
E_USER_NOTICE => 'Notice',
E_NOTICE => 'Notice',
E_PARSE => 'Parse error',
E_STRICT => 'Strict standards',
);
$errorType = isset($errorsNo[$no])?$errorsNo[$no]:"Unknown error($no)";
throw new jsonRpcException("$errorType: $str in $file on line $line");
return true;
}
function error($error,$msg=null,$data=null){
if( is_array($error) || is_object($error)){
if( null !== $msg )
$error['message'] = $msg;
}else{
if(isset(self::$errors[$error]) ){
$error = self::$errors[$error];
}else{
$error = array_merge(self::$errors['SERVER_ERROR'],array(is_numeric($error)?'code':'message'=>$error));
}
}
if( null!==$msg)
$error['message'] = $msg;
if( null!==$data)
$error['data'] = $data;
$error = array("error"=>$error);
if( $this->processingRequest && $this->processingRequest->id)
$error['id'] = $this->processingRequest->id;
return (object) $error;
}
function response($response){
static $notNull;
if( ! isset($notNull) ){
$notNull = create_function('$v','return $v!==null?true:false;');
}
if( jsonRPC::$noCache ){
header("Cache-Control: no-cache, must-revalidate"); // HTTP/1.1
header("Expires: Sat, 26 Jul 1997 05:00:00 GMT"); // set a past date
}
header('Content-type: application/'.($this->callback?'javascript':'json'));
$response = json_encode(array_filter((array) $response,$notNull));
echo $this->callback?"$this->callback($response);":$response;
exit;
}
/**
* return the jsonRPC server method descriptions in a json format.
* @return stdclass
*/
function discovery(){
$doc = array();
foreach($this->methods as $m=>$cb){
if( is_string($cb) && strpos($cb,':')){
$cb = explode('::',$cb);
}
$ref = is_array($cb)?new ReflectionMethod($cb[0],$cb[1]):new ReflectionFunction($cb);
$doc[$m]['params'] = $ref->getParameters();
if( $comment = $ref->getDocComment()){
$doc[$m]['comment'] = preg_replace(array('!^(\s*/\*|\s*\*|\s*\*+/)!m','!^\*\s*|\s*/?$!'),'',$comment);
if( preg_match('!@return\s+\b(\S+)\b!i',$comment,$returnDoc)){
$doc[$m]['return'] = $returnDoc[1];
}
}
foreach($doc[$m]["params"] as $k=>$v){
$doc[$m]['params'][$k] = array_filter(array(
'name'=>$v->name,
'optional'=>$v->isOptional()?true:null,
));
if( $v->isDefaultValueAvailable()){
$doc[$m]['params'][$k]['default'] = $v->getDefaultValue();
}
if( $v->getClass()){
$doc[$m]['params'][$k]['type'] = $v->getClass()->name;
}else if($v->isArray()){
$doc[$m]['params'][$k]['type'] = 'Array';
}else if(preg_match('!@param\s+(int(eg[ea]r)?|array|mixed|str(ing)?|float|double|stdobject|object|bool)\s+\$?'.$v->name.'\b!i',$comment,$paramDoc)){
$doc[$m]['params'][$k]['type'] = $paramDoc[1];
}else{
$doc[$m]['params'][$k]['type'] = 'scalar';
}
}
}
return $doc;
}
/**
* return the page you're probably looking at
* @return text/html
*/
function htmlDiscovery(){
$docs = $this->discovery() ;
if( empty($docs) ){
echo "No public API";exit;
}
ksort($docs);
echo "<!DOCTYPE HTML><head><style type=\"text/css\">dt{ font-weight:bold; background:#e0e0e0;color:#333;margin:1em 0 0 0;padding:.4em .8em;}dd{background:#d0d0d0;margin:0 1em;padding:.4em .8em;}</style></head><body><dl>";
foreach($docs as $m=>$doc){
$params = array();
if( isset($doc['params'])){
foreach($doc['params'] as $p){
$p['name'] = "$p[type] $p[name]".(isset($p['default'])?" = ".var_export($p['default'],1):'');
$params[] = (!isset($p['optional'])?$p['name']:"[$p[name]]");
//$params[] = $p['toString'];
}
}
$comment = empty($doc['comment'])?'':'<dd>'.nl2br($doc['comment']).'<dd>';
echo "<dt>".(isset($doc['return'])?"( $doc[return] ) ":'')."$m( ".implode(', ',$params)." )$comment";
}
echo "</dl></body></html>";
exit;
}
/**
* return a javascript proxy class to call directly this jsonRPC server. It require jquery to make calls
* In your html page add a <script src="http://exemple.com/myjsonrpcserver.php/?method=jqueryProxy"></script>
* then call jsonrpc.request('method',[param1,param2...],function(result){ success code },function(result){error code});
* @param string $proxyName name of the javascript variable containing the proxy
* @param string $endPoint optionnal endpoint will default to this server page
* @return text/javascript
*/
function jqueryProxy($proxyName='jsonrpc',$endPoint=null){
if( null === $endPoint ){
$endPoint = (stripos($_SERVER['SERVER_PROTOCOL'],'HTTPS')!==false?'https':'http').'://'.$_SERVER['HTTP_HOST'].$_SERVER['PHP_SELF'];
}
header('Content-type: application/javascript');
echo "(function($){var RID = '".$proxyName."0';function generateId(){return (RID = RID.replace(/\d+$/,function(m){return parseInt(m,10)+1;}));}"
,"window.$proxyName={\n\tendpoint:'".$endPoint."'\n\t,"
,"callbacks:{},"
,"
request: function(method,params,success,error){
var id=generateId();
if(success||error){this.callbacks[id]=[success,error];}
\$.ajax({url:this.endpoint,dataType:'jsonp',data:{id:id,method:method,params:params,callback:'$proxyName.callback'}});
},"
,"
callback:function(r){
if( ! (r && r.id && this.callbacks[r.id])){
return false;
}
var cbs=this.callbacks[r.id],cb = r.error?(cbs[1]?cbs[1]:false):(cbs[0]?cbs[0]:false),res=(typeof r.result !== 'undefined')? r.result : (r.error?r.error:null);
delete this.callbacks[r.id];
if($.isFunction(cb)){
return cb(res);
}else if( cb) {
return (new Function('r','return '+cb+'(r);'))(res);
}
return false;
}};
})(jQuery);";
exit(0);
}
static function syncRequest($uri,$request,array $params=null,$timeOut=15){
if( is_string($request) ){
$request = array('method'=>$request,'params'=>$params,'id'=>uniqid());
}else{
$request = (object) $request;
if($params)
$request->params = array_merge((isset($request->params)?(array) $request->params:array()),$params);
if( !isset($request->id) )
$request->id = uniqid();
}
if( function_exists('curl_setopt_array') ){
$curl = curl_init();
curl_setopt_array($curl,array(
CURLOPT_RETURNTRANSFER=>true # get result as string instead of stdout printing
,CURLOPT_HEADER => false # no header in the results
,CURLOPT_URL => $uri # url d'appel
,CURLOPT_POST => true # this is a post request
,CURLOPT_POSTFIELDS => urlencode(json_encode($request)) # here's the jsonrpc request
,CURLOPT_FOLLOWLOCATION => true # allow redirect
,CURLOPT_MAXREDIRS => 5 # max redirect
,CURLOPT_CONNECTTIMEOUT => $timeOut # max connection time
,CURLOPT_TIMEOUT => $timeOut # max get time
,CURLOPT_FAILONERROR => true
,CURLOPT_SSL_VERIFYPEER => false
));
$response = curl_exec($curl);
if( false===$response ){
throw new RuntimeException(__class__.':'.__function__.
"Error while requesting $uri : ".curl_error($curl));
}
curl_close($curl);
}else{
preg_match('!^http(s?)://([^/]+)(.*)$!',$uri,$m);
$fp = fsockopen(($m[1]?'ssl://':'').$m[2],$m[1]?443:80,$errno,$errstr,$timeOut);
if(! $fp ){
throw new RuntimeException("$errno - $errstr");
}
$request=json_encode($request);
$requestContent = array(
"POST $m[3] HTTP/1.1",
"Host: $m[2]",
"User-Agent: authentificationApi",
"Content-Type: application/x-www-form-urlencoded",
"Content-Length:".strlen($request),
"\r\n$request",
);
fwrite($fp,implode("\n",$requestContent));
$response='';
while(!feof($fp))$response.= fread($fp,1024);
fclose($fp);
$reponse = preg_replace('!^.*(?:\r?\n){2}(.*)$!s','\\1',$response);
}
return json_decode($response);
}
} |
|---|