xmlrpc.server.inc 11 KB
Newer Older
Dries's avatar
 
Dries committed
1 2
<?php

3 4
/**
 * @file
5
 * Page callback file for the xmlrpc module.
6 7
 */

8 9 10 11 12 13 14 15
/**
 * Process an XML-RPC request.
 */
function xmlrpc_server_page() {
  module_load_include('inc', 'xmlrpc');
  xmlrpc_server(module_invoke_all('xmlrpc'));
}

16
/**
17
 * Invokes XML-RPC methods on this server.
18
 *
19
 * @param array $callbacks
20 21
 *   Array of external XML-RPC method names with the callbacks they map to.
 */
22 23
function xmlrpc_server($callbacks) {
  $xmlrpc_server = new stdClass();
24
  // Define built-in XML-RPC method names
25
  $defaults = array(
26
    'system.multicall' => 'xmlrpc_server_multicall',
27 28 29 30
    array(
      'system.methodSignature',
      'xmlrpc_server_method_signature',
      array('array', 'string'),
31
      'Returns an array describing the return type and required parameters of a method.',
32 33 34 35 36
    ),
    array(
      'system.getCapabilities',
      'xmlrpc_server_get_capabilities',
      array('struct'),
37
      'Returns a struct describing the XML-RPC specifications supported by this server.',
38 39 40 41 42
    ),
    array(
      'system.listMethods',
      'xmlrpc_server_list_methods',
      array('array'),
43 44
      'Returns an array of available methods on this server.',
    ),
45 46 47 48
    array(
      'system.methodHelp',
      'xmlrpc_server_method_help',
      array('string', 'string'),
49 50
      'Returns a documentation string for the specified method.',
    ),
51
  );
52 53 54
  // We build an array of all method names by combining the built-ins
  // with those defined by modules implementing the _xmlrpc hook.
  // Built-in methods are overridable.
55 56 57
  $callbacks = array_merge($defaults, (array) $callbacks);
  drupal_alter('xmlrpc', $callbacks);
  foreach ($callbacks as $key => $callback) {
58 59 60 61 62 63 64 65 66 67 68 69 70
    // we could check for is_array($callback)
    if (is_int($key)) {
      $method = $callback[0];
      $xmlrpc_server->callbacks[$method] = $callback[1];
      $xmlrpc_server->signatures[$method] = $callback[2];
      $xmlrpc_server->help[$method] = $callback[3];
    }
    else {
      $xmlrpc_server->callbacks[$key] = $callback;
      $xmlrpc_server->signatures[$key] = '';
      $xmlrpc_server->help[$key] = '';
    }
  }
Dries's avatar
 
Dries committed
71

72
  $data = file_get_contents('php://input');
73
  if (!$data) {
74 75
    print 'XML-RPC server accepts POST requests only.';
    drupal_exit();
Dries's avatar
 
Dries committed
76
  }
77 78
  $xmlrpc_server->message = xmlrpc_message($data);
  if (!xmlrpc_message_parse($xmlrpc_server->message)) {
79
    xmlrpc_server_error(-32700, t('Parse error. Request not well formed.'));
Dries's avatar
 
Dries committed
80
  }
81
  if ($xmlrpc_server->message->messagetype != 'methodCall') {
82
    xmlrpc_server_error(-32600, t('Server error. Invalid XML-RPC. Request must be a methodCall.'));
Dries's avatar
 
Dries committed
83
  }
84 85 86
  if (!isset($xmlrpc_server->message->params)) {
    $xmlrpc_server->message->params = array();
  }
87
  xmlrpc_server_set($xmlrpc_server);
88
  $result = xmlrpc_server_call($xmlrpc_server, $xmlrpc_server->message->methodname, $xmlrpc_server->message->params);
89

90
  if (is_object($result) && !empty($result->is_error)) {
91
    xmlrpc_server_error($result);
Dries's avatar
 
Dries committed
92
  }
93 94 95 96 97 98 99
  // Encode the result
  $r = xmlrpc_value($result);
  // Create the XML
  $xml = '
<methodResponse>
  <params>
  <param>
100
    <value>' . xmlrpc_value_get_xml($r) . '</value>
101 102 103
  </param>
  </params>
</methodResponse>
Dries's avatar
 
Dries committed
104

105 106 107 108
';
  // Send it
  xmlrpc_server_output($xml);
}
Dries's avatar
 
Dries committed
109

110
/**
111
 * Throws an XML-RPC error.
112 113
 *
 * @param $error
114
 *   An error object or integer error code.
115
 * @param $message
116 117
 *   (optional) The description of the error. Used only if an integer error
 *   code was passed in.
118
 */
119
function xmlrpc_server_error($error, $message = FALSE) {
120 121
  if ($message && !is_object($error)) {
    $error = xmlrpc_error($error, $message);
Dries's avatar
 
Dries committed
122
  }
123
  xmlrpc_server_output(xmlrpc_error_get_xml($error));
Dries's avatar
 
Dries committed
124 125
}

126 127 128 129 130 131
/**
 * Sends XML-RPC output to the browser.
 *
 * @param string $xml
 *   XML to send to the browser.
 */
132
function xmlrpc_server_output($xml) {
133
  $xml = '<?xml version="1.0"?>' . "\n" . $xml;
134 135
  drupal_add_http_header('Content-Length', strlen($xml));
  drupal_add_http_header('Content-Type', 'text/xml');
136
  echo $xml;
137
  drupal_exit();
Dries's avatar
 
Dries committed
138 139
}

140
/**
141 142 143 144 145
 * Stores a copy of an XML-RPC request temporarily.
 *
 * @param object $xmlrpc_server
 *   (optional) Request object created by xmlrpc_server(). Omit to leave the
 *   previous server object saved.
146
 *
147 148 149 150
 * @return
 *   The latest stored request.
 *
 * @see xmlrpc_server_get()
151
 */
152 153 154 155
function xmlrpc_server_set($xmlrpc_server = NULL) {
  static $server;
  if (!isset($server)) {
    $server = $xmlrpc_server;
Dries's avatar
 
Dries committed
156
  }
157 158
  return $server;
}
Dries's avatar
 
Dries committed
159

160 161 162 163 164 165 166 167
/**
 * Retrieves the latest stored XML-RPC request.
 *
 * @return object
 *   The stored request.
 *
 * @see xmlrpc_server_set()
 */
168 169 170
function xmlrpc_server_get() {
  return xmlrpc_server_set();
}
Dries's avatar
 
Dries committed
171

172
/**
173 174 175 176 177 178 179 180 181
 * Dispatches an XML-RPC request and any parameters to the appropriate handler.
 *
 * @param object $xmlrpc_server
 *   Object containing information about this XML-RPC server, the methods it
 *   provides, their signatures, etc.
 * @param string $methodname
 *   The external XML-RPC method name; e.g., 'system.methodHelp'.
 * @param array $args
 *   Array containing any parameters that are to be sent along with the request.
182
 *
183 184
 * @return
 *   The results of the call.
185
 */
186
function xmlrpc_server_call($xmlrpc_server, $methodname, $args) {
187
  // Make sure parameters are in an array
188 189
  if ($args && !is_array($args)) {
    $args = array($args);
Dries's avatar
 
Dries committed
190
  }
191
  // Has this method been mapped to a Drupal function by us or by modules?
192
  if (!isset($xmlrpc_server->callbacks[$methodname])) {
193
    return xmlrpc_error(-32601, t('Server error. Requested method @methodname not specified.', array("@methodname" => $xmlrpc_server->message->methodname)));
194 195 196
  }
  $method = $xmlrpc_server->callbacks[$methodname];
  $signature = $xmlrpc_server->signatures[$methodname];
Dries's avatar
 
Dries committed
197

198
  // If the method has a signature, validate the request against the signature
199
  if (is_array($signature)) {
200
    $ok = TRUE;
201 202 203
    $return_type = array_shift($signature);
    // Check the number of arguments
    if (count($args) != count($signature)) {
204
      return xmlrpc_error(-32602, t('Server error. Wrong number of method parameters.'));
Dries's avatar
 
Dries committed
205
    }
206 207 208 209 210 211 212
    // Check the argument types
    foreach ($signature as $key => $type) {
      $arg = $args[$key];
      switch ($type) {
        case 'int':
        case 'i4':
          if (is_array($arg) || !is_int($arg)) {
213
            $ok = FALSE;
214 215
          }
          break;
216

217 218 219
        case 'base64':
        case 'string':
          if (!is_string($arg)) {
220
            $ok = FALSE;
221 222
          }
          break;
223

224
        case 'boolean':
225 226
          if ($arg !== FALSE && $arg !== TRUE) {
            $ok = FALSE;
227 228
          }
          break;
229

230 231 232
        case 'float':
        case 'double':
          if (!is_float($arg)) {
233
            $ok = FALSE;
234 235
          }
          break;
236

237 238 239
        case 'date':
        case 'dateTime.iso8601':
          if (!$arg->is_date) {
240
            $ok = FALSE;
241 242
          }
          break;
Dries's avatar
 
Dries committed
243
      }
244
      if (!$ok) {
245
        return xmlrpc_error(-32602, t('Server error. Invalid method parameters.'));
Dries's avatar
 
Dries committed
246 247 248
      }
    }
  }
249

250
  if (!function_exists($method)) {
251
    return xmlrpc_error(-32601, t('Server error. Requested function @method does not exist.', array("@method" => $method)));
252
  }
253
  // Call the mapped function
254 255
  return call_user_func_array($method, $args);
}
Dries's avatar
 
Dries committed
256

257 258 259 260 261 262 263 264 265 266 267 268 269 270
/**
 * Dispatches multiple XML-RPC requests.
 *
 * @param array $methodcalls
 *   An array of XML-RPC requests to make. Each request is an array with the
 *   following elements:
 *   - methodName: Name of the method to invoke.
 *   - params: Parameters to pass to the method.
 *
 * @return
 *   An array of the results of each request.
 *
 * @see xmlrpc_server_call()
 */
271 272 273 274 275
function xmlrpc_server_multicall($methodcalls) {
  // See http://www.xmlrpc.com/discuss/msgReader$1208
  $return = array();
  $xmlrpc_server = xmlrpc_server_get();
  foreach ($methodcalls as $call) {
276
    $ok = TRUE;
277 278
    if (!isset($call['methodName']) || !isset($call['params'])) {
      $result = xmlrpc_error(3, t('Invalid syntax for system.multicall.'));
279
      $ok = FALSE;
280 281 282 283 284 285 286 287 288
    }
    $method = $call['methodName'];
    $params = $call['params'];
    if ($method == 'system.multicall') {
      $result = xmlrpc_error(-32600, t('Recursive calls to system.multicall are forbidden.'));
    }
    elseif ($ok) {
      $result = xmlrpc_server_call($xmlrpc_server, $method, $params);
    }
289
    if (is_object($result) && !empty($result->is_error)) {
290 291
      $return[] = array(
        'faultCode' => $result->code,
292
        'faultString' => $result->message,
293 294 295
      );
    }
    else {
296
      $return[] = array($result);
297 298 299 300 301 302
    }
  }
  return $return;
}

/**
303 304
 * Lists the methods available on this XML-RPC server.
 *
305
 * XML-RPC method system.listMethods maps to this function.
306 307 308
 *
 * @return array
 *   Array of the names of methods available on this server.
309 310 311 312 313 314 315
 */
function xmlrpc_server_list_methods() {
  $xmlrpc_server = xmlrpc_server_get();
  return array_keys($xmlrpc_server->callbacks);
}

/**
316 317
 * Returns a list of the capabilities of this server.
 *
318
 * XML-RPC method system.getCapabilities maps to this function.
319
 *
320 321 322
 * @return array
 *   Array of server capabilities.
 *
323
 * @see http://groups.yahoo.com/group/xml-rpc/message/2897
324 325 326 327 328
 */
function xmlrpc_server_get_capabilities() {
  return array(
    'xmlrpc' => array(
      'specUrl' => 'http://www.xmlrpc.com/spec',
329
      'specVersion' => 1,
330 331 332
    ),
    'faults_interop' => array(
      'specUrl' => 'http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php',
333
      'specVersion' => 20010516,
334 335 336
    ),
    'system.multicall' => array(
      'specUrl' => 'http://www.xmlrpc.com/discuss/msgReader$1208',
337
      'specVersion' => 1,
338 339
    ),
    'introspection' => array(
340 341 342
      'specUrl' => 'http://scripts.incutio.com/xmlrpc/introspection.html',
      'specVersion' => 1,
    ),
343 344 345 346
  );
}

/**
347
 * Returns one method signature for a function.
348
 *
349
 * This is the function mapped to the XML-RPC method system.methodSignature.
350
 *
351 352 353 354 355 356 357 358
 * A method signature is an array of the input and output types of a method. For
 * instance, the method signature of this function is array('array', 'string'),
 * because it takes an array and returns a string.
 *
 * @param string $methodname
 *   Name of method to return a method signature for.
 *
 * @return array
359 360
 *   An array of arrays of types, each of the arrays representing one method
 *   signature of the function that $methodname maps to.
361 362 363
 */
function xmlrpc_server_method_signature($methodname) {
  $xmlrpc_server = xmlrpc_server_get();
364
  if (!isset($xmlrpc_server->callbacks[$methodname])) {
365
    return xmlrpc_error(-32601, t('Server error. Requested method @methodname not specified.', array("@methodname" => $methodname)));
366
  }
367
  if (!is_array($xmlrpc_server->signatures[$methodname])) {
368
    return xmlrpc_error(-32601, t('Server error. Requested method @methodname signature not specified.', array("@methodname" => $methodname)));
369
  }
370
  // We array of types
371 372
  $return = array();
  foreach ($xmlrpc_server->signatures[$methodname] as $type) {
373
    $return[] = $type;
Dries's avatar
 
Dries committed
374
  }
375
  return array($return);
376 377
}

378
/**
379 380
 * Returns the help for an XML-RPC method.
 *
381 382
 * XML-RPC method system.methodHelp maps to this function.
 *
383
 * @param string $method
384
 *   Name of method for which we return a help string.
385 386 387
 *
 * @return string
 *   Help text for $method.
388
 */
389 390
function xmlrpc_server_method_help($method) {
  $xmlrpc_server = xmlrpc_server_get();
391
  return $xmlrpc_server->help[$method];
392
}