3 // PlanetLab Central Slice API (PLCAPI) PHP interface
5 // DO NOT EDIT. This file was automatically generated at
8 // Mark Huang <mlhuang@cs.princeton.edu>
9 // Copyright (C) 2005-2006 The Trustees of Princeton University
12 //ini_set('error_reporting', 1);
15 * May 2017 - Ciro Scognamiglio <c.scognamiglio@cslash.net>
17 * xmlrpc php module is not compatible anymore with the PLCAPI class,
18 * if the package phpxmlrpc is installed in the same dir it will be used instead
20 * https://github.com/gggeek/phpxmlrpc
22 * If the package is not found the php module XML-RPC is used if available
25 if (file_exists(__DIR__ . '/phpxmlrpc/src/Autoloader.php')) {
26 include_once __DIR__ . '/phpxmlrpc/src/Autoloader.php';
27 PhpXmlRpc\Autoloader::register();
30 require_once 'plc_config.php';
43 function PLCAPI($auth = NULL,
44 $server = PLC_API_HOST,
50 $this->server = $server;
53 $this->cainfo = $cainfo;
54 $this->errors = array();
55 $this->trace = array();
56 $this->calls = array();
57 $this->multicall = false;
60 function rec_join ($arg) {
61 if ( is_array($arg) ) {
63 foreach ( $arg as $i ) {
64 $l = $this->rec_join($i);
66 if ( $l[0] != "<" ) { $ret .= $l . ", "; }
70 settype($arg, "string");
75 function backtrace_php () {
76 $backtrace = debug_backtrace();
78 $len = count($backtrace);
80 foreach( array_reverse($backtrace) as $line ) {
81 $msg .= "File '". $line['file'] . "' line " . $line['line'] . "\n";
82 $msg .= " " . $line['function'] . "( " . $this->rec_join($line['args']) . ")\n";
84 if ( $cnt == $len ) { break; }
89 function error_log($error_msg, $backtrace_level = 1)
91 $backtrace = debug_backtrace();
92 $file = $backtrace[$backtrace_level]['file'];
93 $line = $backtrace[$backtrace_level]['line'];
95 $error_line='PLCAPI error: ' . $error_msg ;
96 if ($file) $error_line .= ' in file ' . $file;
97 if ($line) $error_line .= ' on line ' . $line;
98 $this->errors[] = $error_line;
99 # TODO: setup a config variable for more detailed stack traces, for API errors.
101 error_log($error_line);
103 error_log($this->backtrace_php());
109 if (empty($this->trace)) {
112 $last_trace = end($this->trace);
113 return implode("\\n", $last_trace['errors']);
122 function microtime_float()
124 list($usec, $sec) = explode(" ", microtime());
125 return ((float) $usec + (float) $sec);
128 function call($method, $args = NULL)
130 if ($this->multicall) {
131 $this->calls[] = array ('methodName' => $method,
135 return $this->internal_call($method, $args, 3);
140 * Use PhpXmlRpc\Value before encoding the request
142 function xmlrpcValue($value) {
143 switch(gettype($value)) {
146 foreach($value as $vk => $vv) {
147 $members[$vk] = $this->xmlrpcValue($vv);
150 if (array_key_exists(0, $value)) {
151 return new PhpXmlRpc\Value(
156 return new PhpXmlRpc\Value(
164 return new PhpXmlRpc\Value($value, 'double');
167 return new PhpXmlRpc\Value($value, 'boolean');
171 return new PhpXmlRpc\Value(null, 'null');
174 return new PhpXmlRpc\Value($value, 'int');
178 return new PhpXmlRpc\Value(null, 'null');
180 return new PhpXmlRpc\Value($value);
187 function internal_call($method, $args = NULL, $backtrace_level = 2)
189 if (class_exists('PhpXmlRpc\\PhpXmlRpc')) {
190 return $this->internal_call_phpxmlrpc($method, $args, $backtrace_level);
192 return $this->internal_call_xmlrpc($method, $args, $backtrace_level);
197 * the new internal call, will use PhpXmlRpc
199 function internal_call_phpxmlrpc($method, $args = NULL, $backtrace_level = 2)
203 PhpXmlRpc\PhpXmlRpc::$xmlrpc_null_extension = true;
205 if ($this->port == 443) {
211 // Set the URL for the request
212 $url .= $this->server . ':' . $this->port . '/' . $this->path;
214 $client = new PhpXmlRpc\Client($url);
215 $client->setSSLVerifyPeer(false);
218 * 2 -> verify CN (default)
220 $client->setSSLVerifyHost(1);
222 $values = $this->xmlrpcValue($args);
224 $response = $client->send(new PhpXmlRpc\Request($method, $values));
227 if (!$response->faultCode()) {
228 $encoder = new PhpXmlRpc\Encoder();
229 $v = $encoder->decode($response->value());
233 $this->error_log("An error occurred [" . $response->faultCode() . "] ".
234 $response->faultString());
240 * The original internal call that uses php XML-RPC
242 function internal_call_xmlrpc($method, $args = NULL, $backtrace_level = 2)
246 // Verify peer certificate if talking over SSL
247 if ($this->port == 443) {
248 curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 2);
249 if (!empty($this->cainfo)) {
250 curl_setopt($curl, CURLOPT_CAINFO, $this->cainfo);
251 } elseif (defined('PLC_API_CA_SSL_CRT')) {
252 curl_setopt($curl, CURLOPT_CAINFO, PLC_API_CA_SSL_CRT);
259 // Set the URL for the request
260 $url .= $this->server . ':' . $this->port . '/' . $this->path;
261 curl_setopt($curl, CURLOPT_URL, $url);
263 // Marshal the XML-RPC request as a POST variable. <nil/> is an
264 // extension to the XML-RPC spec that is supported in our custom
265 // version of xmlrpc.so via the 'allow_null' output_encoding key.
266 $request = xmlrpc_encode_request($method, $args, array('null_extension'));
267 curl_setopt($curl, CURLOPT_POSTFIELDS, $request);
269 // Construct the HTTP header
270 $header[] = 'Content-type: text/xml';
271 $header[] = 'Content-length: ' . strlen($request);
272 curl_setopt($curl, CURLOPT_HTTPHEADER, $header);
274 // Set some miscellaneous options
275 curl_setopt($curl, CURLOPT_TIMEOUT, 180);
277 // Get the output of the request
278 curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
279 $t0 = $this->microtime_float();
280 $output = curl_exec($curl);
281 $t1 = $this->microtime_float();
283 if (curl_errno($curl)) {
284 $this->error_log('curl: ' . curl_error($curl), true);
287 $ret = xmlrpc_decode($output);
288 if (is_array($ret) && xmlrpc_is_fault($ret)) {
289 $this->error_log('Fault Code ' . $ret['faultCode'] . ': ' .
290 $ret['faultString'], $backtrace_level, true);
297 $this->trace[] = array('method' => $method,
299 'runtime' => $t1 - $t0,
301 'errors' => $this->errors);
302 $this->errors = array();
309 if (!empty($this->calls)) {
310 $this->error_log ('Warning: multicall already in progress');
313 $this->multicall = true;
316 function xmlrpc_is_fault($arr)
318 // check if xmlrpc_is_fault exists
319 return is_array($arr) && array_key_exists('faultCode', $arr) && array_key_exists('faultString', $arr);
323 if (!empty ($this->calls)) {
325 $results = $this->internal_call('system.multicall', array ($this->calls));
326 foreach ($results as $result) {
327 if (is_array($result)) {
328 if ($this->xmlrpc_is_fault($result)) {
329 $this->error_log('Fault Code ' . $result['faultCode'] . ': ' .
330 $result['faultString'], 1, true);
332 // Thierry - march 30 2007
333 // using $adm->error() is broken with begin/commit style
334 // this is because error() uses last item in trace and checks for ['errors']
335 // when using begin/commit we do run internal_call BUT internal_call checks for
336 // multicall's result globally, not individual results, so ['errors'] comes empty
337 // I considered hacking internal_call
338 // to *NOT* maintain this->trace at all when invoked with multicall
339 // but it is too complex to get all values right
340 // so let's go for the hacky way, and just record individual errors at the right place
341 $this->trace[count($this->trace)-1]['errors'][] = end($this->errors);
353 $this->calls = array();
354 $this->multicall = false;
363 function __call($name, $args)
365 array_unshift($args, $this->auth);
366 return $this->call($name, $args);
372 $adm = new PLCAPI(array('AuthMethod' => "capability",
373 'Username' => PLC_API_MAINTENANCE_USER,
374 'AuthString' => PLC_API_MAINTENANCE_PASSWORD));