.
/**
* REST web service implementation classes and methods.
*
* @package webservice
* @copyright 2009 Moodle Pty Ltd (http://moodle.com)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
require_once("$CFG->dirroot/webservice/lib.php");
/**
* REST service server implementation.
* @author Petr Skoda (skodak)
*/
class webservice_rest_server extends webservice_base_server {
/**
* Contructor
*/
public function __construct($authmethod) {
parent::__construct($authmethod);
$this->wsname = 'rest';
}
/**
* This method parses the $_REQUEST superglobal and looks for
* the following information:
* 1/ user authentication - username+password or token (wsusername, wspassword and wstoken parameters)
* 2/ function name (wsfunction parameter)
* 3/ function parameters (all other parameters except those above)
*
* @return void
*/
protected function parse_request() {
if ($this->authmethod == WEBSERVICE_AUTHMETHOD_USERNAME) {
$this->username = isset($_REQUEST['wsusername']) ? $_REQUEST['wsusername'] : null;
unset($_REQUEST['wsusername']);
$this->password = isset($_REQUEST['wspassword']) ? $_REQUEST['wspassword'] : null;
unset($_REQUEST['wspassword']);
$this->functionname = isset($_REQUEST['wsfunction']) ? $_REQUEST['wsfunction'] : null;
unset($_REQUEST['wsfunction']);
$this->parameters = $_REQUEST;
} else {
$this->token = isset($_REQUEST['wstoken']) ? $_REQUEST['wstoken'] : null;
unset($_REQUEST['wstoken']);
$this->functionname = isset($_REQUEST['wsfunction']) ? $_REQUEST['wsfunction'] : null;
unset($_REQUEST['wsfunction']);
$this->parameters = $_REQUEST;
}
}
/**
* Send the result of function call to the WS client
* formatted as XML document.
* @return void
*/
protected function send_response() {
$this->send_headers();
$xml = ''."\n";
$xml .= ''."\n";
$xml .= self::xmlize_result($this->returns, $this->function->returns_desc);
$xml .= ''."\n";
echo $xml;
}
/**
* Send the error information to the WS client
* formatted as XML document.
* @param exception $ex
* @return void
*/
protected function send_error($ex=null) {
$this->send_headers();
$xml = ''."\n";
$xml .= ''."\n";
$xml .= ''.htmlspecialchars($ex->getMessage(), ENT_COMPAT, 'UTF-8').''."\n";
if (debugging() and isset($ex->debuginfo)) {
$xml .= ''.htmlspecialchars($ex->debuginfo, ENT_COMPAT, 'UTF-8').''."\n";
}
$xml .= ''."\n";
echo $xml;
}
/**
* Internal implementation - sending of page headers.
* @return void
*/
protected function send_headers() {
header('Content-Type: application/xml; charset=utf-8');
header('Content-Disposition: inline; filename="response.xml"');
header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
header('Pragma: no-cache');
header('Accept-Ranges: none');
}
/**
* Internal implementation - recursive function producing XML markup.
* @param mixed $returns
* @param $desc
* @return unknown_type
*/
protected static function xmlize_result($returns, $desc) {
if ($desc === null) {
return '';
} else if ($desc instanceof external_value) {
if (is_bool($returns)) {
// we want 1/0 instead of true/false here
$returns = (int)$returns;
}
if (is_null($returns)) {
return ''."\n";
} else {
return ''.htmlspecialchars($returns, ENT_COMPAT, 'UTF-8').''."\n";
}
} else if ($desc instanceof external_multiple_structure) {
$mult = ''."\n";
if (!empty($returns)) {
foreach ($returns as $val) {
$mult .= self::xmlize_result($val, $desc->content);
}
}
$mult .= ''."\n";
return $mult;
} else if ($desc instanceof external_single_structure) {
$single = ''."\n";
foreach ($desc->keys as $key=>$subdesc) {
if (!array_key_exists($key, $returns)) {
if ($subdesc->required == VALUE_REQUIRED) {
$single .= 'Missing required key "'.$key.'"';
continue;
} else {
//optional field
continue;
}
}
$single .= ''.self::xmlize_result($returns[$key], $subdesc).''."\n";
}
$single .= ''."\n";
return $single;
}
}
}
/**
* REST test client class
*/
class webservice_rest_test_client implements webservice_test_client_interface {
/**
* Execute test client WS request
* @param string $serverurl
* @param string $function
* @param array $params
* @return mixed
*/
public function simpletest($serverurl, $function, $params) {
return download_file_content($serverurl.'&wsfunction='.$function, null, $params);
}
}