2c75799ab3cfebcf562fc3a0557cd357749edacc
[moodle.git] / webservice / rest / locallib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * REST web service implementation classes and methods.
20  *
21  * @package   webservice
22  * @copyright 2009 Moodle Pty Ltd (http://moodle.com)
23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 require_once("$CFG->dirroot/webservice/lib.php");
28 /**
29  * REST service server implementation.
30  * @author Petr Skoda (skodak)
31  */
32 class webservice_rest_server extends webservice_base_server {
34     /** @property string $alt return method (XML / JSON) */
35     protected $restformat;
37     /**
38      * Contructor
39      */
40     public function __construct($authmethod, $restformat = 'xml') {
41         parent::__construct($authmethod);
42         $this->wsname = 'rest';
43         $this->restformat = ($restformat != 'xml' && $restformat != 'json')?'xml':$restformat; //sanity check, we accept only xml or json
44     }
46     /**
47      * This method parses the $_REQUEST superglobal and looks for
48      * the following information:
49      *  1/ user authentication - username+password or token (wsusername, wspassword and wstoken parameters)
50      *  2/ function name (wsfunction parameter)
51      *  3/ function parameters (all other parameters except those above)
52      *
53      * @return void
54      */
55     protected function parse_request() {
56         if ($this->authmethod == WEBSERVICE_AUTHMETHOD_USERNAME) {
57             $this->username = isset($_REQUEST['wsusername']) ? $_REQUEST['wsusername'] : null;
58             unset($_REQUEST['wsusername']);
60             $this->password = isset($_REQUEST['wspassword']) ? $_REQUEST['wspassword'] : null;
61             unset($_REQUEST['wspassword']);
63             $this->functionname = isset($_REQUEST['wsfunction']) ? $_REQUEST['wsfunction'] : null;
64             unset($_REQUEST['wsfunction']);
66             $this->parameters = $_REQUEST;
68         } else {
69             $this->token = isset($_REQUEST['wstoken']) ? $_REQUEST['wstoken'] : null;
70             unset($_REQUEST['wstoken']);
72             $this->functionname = isset($_REQUEST['wsfunction']) ? $_REQUEST['wsfunction'] : null;
73             unset($_REQUEST['wsfunction']);
75             $this->parameters = $_REQUEST;
76         }
77     }
79     /**
80      * Send the result of function call to the WS client
81      * formatted as XML document.
82      * @return void
83      */
84     protected function send_response() {
86         //Check that the returned values are valid
87         try {
88             if ($this->function->returns_desc != null) {
89                 $validatedvalues = external_api::clean_returnvalue($this->function->returns_desc, $this->returns);
90             } else {
91                 $validatedvalues = null;
92             }
93         } catch (Exception $ex) {
94             $exception = $ex;
95         }
97         if (!empty($exception)) {
98             $response =  $this->generate_error($exception);
99         } else {
100             //We can now convert the response to the requested REST format
101             if ($this->restformat == 'json') {
102                 $response = json_encode($validatedvalues);
103             } else {
104                 $response = '<?xml version="1.0" encoding="UTF-8" ?>'."\n";
105                 $response .= '<RESPONSE>'."\n";
106                 $response .= self::xmlize_result($this->returns, $this->function->returns_desc);
107                 $response .= '</RESPONSE>'."\n";
108             }
109         }
111         $this->send_headers();
112         echo $response;
113     }
115     /**
116      * Send the error information to the WS client
117      * formatted as XML document.
118      * Note: the exception is never passed as null,
119      *       it only matches the abstract function declaration.
120      * @param exception $ex
121      * @return void
122      */
123     protected function send_error($ex=null) {
124         $this->send_headers();
125         echo $this->generate_error($ex);
126     }
128     /**
129      * Build the error information matching the REST returned value format (JSON or XML)
130      * @param exception $ex
131      * @return string the error in the requested REST format
132      */
133     protected function generate_error($ex) {
134         if ($this->restformat == 'json') {
135             $errorobject = new stdClass;
136             $errorobject->exception = get_class($ex);
137             $errorobject->message = $ex->getMessage();
138             if (debugging() and isset($ex->debuginfo)) {
139                 $errorobject->debuginfo = $ex->debuginfo;
140             }
141             $error = json_encode($errorobject);
142         } else {
143             $error = '<?xml version="1.0" encoding="UTF-8" ?>'."\n";
144             $error .= '<EXCEPTION class="'.get_class($ex).'">'."\n";
145             $error .= '<MESSAGE>'.htmlspecialchars($ex->getMessage(), ENT_COMPAT, 'UTF-8').'</MESSAGE>'."\n";
146             if (debugging() and isset($ex->debuginfo)) {
147                 $error .= '<DEBUGINFO>'.htmlspecialchars($ex->debuginfo, ENT_COMPAT, 'UTF-8').'</DEBUGINFO>'."\n";
148             }
149             $error .= '</EXCEPTION>'."\n";
150         }
151         return $error;
152     }
154     /**
155      * Internal implementation - sending of page headers.
156      * @return void
157      */
158     protected function send_headers() {
159         if ($this->restformat == 'json') {
160             header('Content-type: application/json');
161         } else {
162             header('Content-Type: application/xml; charset=utf-8');
163             header('Content-Disposition: inline; filename="response.xml"');
164         }
165         header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
166         header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
167         header('Pragma: no-cache');
168         header('Accept-Ranges: none');
169     }
171     /**
172      * Internal implementation - recursive function producing XML markup.
173      * @param mixed $returns
174      * @param $desc
175      * @return unknown_type
176      */
177     protected static function xmlize_result($returns, $desc) {
178         if ($desc === null) {
179             return '';
181         } else if ($desc instanceof external_value) {
182             if (is_bool($returns)) {
183                 // we want 1/0 instead of true/false here
184                 $returns = (int)$returns;
185             }
186             if (is_null($returns)) {
187                 return '<VALUE null="null"/>'."\n";
188             } else {
189                 return '<VALUE>'.htmlspecialchars($returns, ENT_COMPAT, 'UTF-8').'</VALUE>'."\n";
190             }
192         } else if ($desc instanceof external_multiple_structure) {
193             $mult = '<MULTIPLE>'."\n";
194             if (!empty($returns)) {
195                 foreach ($returns as $val) {
196                     $mult .= self::xmlize_result($val, $desc->content);
197                 }
198             }
199             $mult .= '</MULTIPLE>'."\n";
200             return $mult;
202         } else if ($desc instanceof external_single_structure) {
203             $single = '<SINGLE>'."\n";
204             foreach ($desc->keys as $key=>$subdesc) {
205                 $single .= '<KEY name="'.$key.'">'.self::xmlize_result($returns[$key], $subdesc).'</KEY>'."\n";
206             }
207             $single .= '</SINGLE>'."\n";
208             return $single;
209         }
210     }
214 /**
215  * REST test client class
216  */
217 class webservice_rest_test_client implements webservice_test_client_interface {
218     /**
219      * Execute test client WS request
220      * @param string $serverurl
221      * @param string $function
222      * @param array $params
223      * @return mixed
224      */
225     public function simpletest($serverurl, $function, $params) {
226         return download_file_content($serverurl.'&wsfunction='.$function, null, $params);
227     }