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
|
<?php
/**
* Elgg XML-RPC library.
* Contains functions and classes to handle XML-RPC services, currently only server only.
*
* @package Elgg.Core
* @subpackage XMLRPC
*/
/**
* parse XMLRPCCall parameters
*
* Convert an XMLRPCCall result array into native data types
*
* @param array $parameters An array of params
*
* @return array
*/
function xmlrpc_parse_params($parameters) {
$result = array();
foreach ($parameters as $parameter) {
$result[] = xmlrpc_scalar_value($parameter);
}
return $result;
}
/**
* Extract the scalar value of an XMLObject type result array
*
* @param XMLObject $object And object
*
* @return mixed
*/
function xmlrpc_scalar_value($object) {
if ($object->name == 'param') {
$object = $object->children[0]->children[0];
}
switch ($object->name) {
case 'string':
return $object->content;
case 'array':
foreach ($object->children[0]->children as $child) {
$value[] = xmlrpc_scalar_value($child);
}
return $value;
case 'struct':
foreach ($object->children as $child) {
if (isset($child->children[1]->children[0])) {
$value[$child->children[0]->content] = xmlrpc_scalar_value($child->children[1]->children[0]);
} else {
$value[$child->children[0]->content] = $child->children[1]->content;
}
}
return $value;
case 'boolean':
return (boolean) $object->content;
case 'i4':
case 'int':
return (int) $object->content;
case 'double':
return (double) $object->content;
case 'dateTime.iso8601':
return (int) strtotime($object->content);
case 'base64':
return base64_decode($object->content);
case 'value':
return xmlrpc_scalar_value($object->children[0]);
default:
// @todo unsupported, throw an error
return false;
}
}
// Functions for adding handlers //////////////////////////////////////////////////////////
/** XML-RPC Handlers */
$XML_RPC_HANDLERS = array();
/**
* Register a method handler for a given XML-RPC method.
*
* @param string $method Method parameter.
* @param string $handler The handler function. This function accepts
* one XMLRPCCall object and must return a XMLRPCResponse object.
*
* @return bool
*/
function register_xmlrpc_handler($method, $handler) {
global $XML_RPC_HANDLERS;
$XML_RPC_HANDLERS[$method] = $handler;
}
/**
* Trigger a method call and pass the relevant parameters to the funciton.
*
* @param XMLRPCCall $parameters The call and parameters.
*
* @return XMLRPCCall
*/
function trigger_xmlrpc_handler(XMLRPCCall $parameters) {
global $XML_RPC_HANDLERS;
// Go through and see if we have a handler
if (isset($XML_RPC_HANDLERS[$parameters->getMethodName()])) {
$handler = $XML_RPC_HANDLERS[$parameters->getMethodName()];
$result = $handler($parameters);
if (!($result instanceof XMLRPCResponse)) {
$msg = sprintf(elgg_echo('InvalidParameterException:UnexpectedReturnFormat'),
$parameters->getMethodName());
throw new InvalidParameterException($msg);
}
// Result in right format, return it.
return $result;
}
// if no handler then throw exception
$msg = sprintf(elgg_echo('NotImplementedException:XMLRPCMethodNotImplemented'),
$parameters->getMethodName());
throw new NotImplementedException($msg);
}
/**
* PHP Error handler function.
* This function acts as a wrapper to catch and report PHP error messages.
*
* @see http://uk3.php.net/set-error-handler
*
* @param int $errno Error number
* @param string $errmsg Human readable message
* @param string $filename Filename
* @param int $linenum Line number
* @param array $vars Vars
*
* @return void
*/
function _php_xmlrpc_error_handler($errno, $errmsg, $filename, $linenum, $vars) {
$error = date("Y-m-d H:i:s (T)") . ": \"" . $errmsg . "\" in file "
. $filename . " (line " . $linenum . ")";
switch ($errno) {
case E_USER_ERROR:
error_log("ERROR: " . $error);
// Since this is a fatal error, we want to stop any further execution but do so gracefully.
throw new Exception("ERROR: " . $error);
break;
case E_WARNING :
case E_USER_WARNING :
error_log("WARNING: " . $error);
break;
default:
error_log("DEBUG: " . $error);
}
}
/**
* PHP Exception handler for XMLRPC.
*
* @param Exception $exception The exception
*
* @return void
*/
function _php_xmlrpc_exception_handler($exception) {
error_log("*** FATAL EXCEPTION (XML-RPC) *** : " . $exception);
$code = $exception->getCode();
if ($code == 0) {
$code = -32400;
}
$result = new XMLRPCErrorResponse($exception->getMessage(), $code);
$vars = array('result' => $result);
$content = elgg_view("xml-rpc/output", $vars);
echo elgg_view_page($exception->getMessage(), $content);
}
|
