MDL-50782 Ajax: No require_login for all ajax webservice calls
[moodle.git] / webservice / renderer.php
CommitLineData
d4c6ef70 1<?php
a0a07014
JM
2// This file is part of Moodle - http://moodle.org/
3//
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
86dcc6f0 16
d4c6ef70 17
18/**
19 * Web service documentation renderer.
a0a07014
JM
20 *
21 * @package core_webservice
22 * @category output
23 * @copyright 2009 Jerome Mouneyrac <jerome@moodle.com>
24 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
d4c6ef70 25 */
c927e35c 26class core_webservice_renderer extends plugin_renderer_base {
229a7099 27
86dcc6f0 28 /**
29 * Display the authorised user selector
a0a07014
JM
30 *
31 * @param stdClass $options It contains alloweduserselector, potentialuserselector and serviceid
86dcc6f0 32 * @return string html
33 */
34 public function admin_authorised_user_selector(&$options) {
de55d469 35 global $CFG;
86dcc6f0 36 $formcontent = html_writer::empty_tag('input',
72f68b51 37 array('name' => 'sesskey', 'value' => sesskey(), 'type' => 'hidden'));
86dcc6f0 38
39 $table = new html_table();
40 $table->size = array('45%', '10%', '45%');
41 $table->attributes['class'] = 'roleassigntable generaltable generalbox boxaligncenter';
42 $table->summary = '';
43 $table->cellspacing = 0;
44 $table->cellpadding = 0;
45
7a25d398
NK
46 // LTR/RTL support, for drawing button arrows in the right direction
47 if (right_to_left()) {
48 $addarrow = '▶';
49 $removearrow = '◀';
50 } else {
51 $addarrow = '◀';
52 $removearrow = '▶';
53 }
54
86dcc6f0 55 //create the add and remove button
56 $addinput = html_writer::empty_tag('input',
57 array('name' => 'add', 'id' => 'add', 'type' => 'submit',
7a25d398 58 'value' => $addarrow . ' ' . get_string('add'),
86dcc6f0 59 'title' => get_string('add')));
60 $addbutton = html_writer::tag('div', $addinput, array('id' => 'addcontrols'));
61 $removeinput = html_writer::empty_tag('input',
62 array('name' => 'remove', 'id' => 'remove', 'type' => 'submit',
7a25d398 63 'value' => $removearrow . ' ' . get_string('remove'),
86dcc6f0 64 'title' => get_string('remove')));
65 $removebutton = html_writer::tag('div', $removeinput, array('id' => 'removecontrols'));
66
67
68 //create the three cells
69 $label = html_writer::tag('label', get_string('serviceusers', 'webservice'),
72f68b51 70 array('for' => 'removeselect'));
86dcc6f0 71 $label = html_writer::tag('p', $label);
72f68b51 72 $authoriseduserscell = new html_table_cell($label .
73 $options->alloweduserselector->display(true));
86dcc6f0 74 $authoriseduserscell->id = 'existingcell';
75 $buttonscell = new html_table_cell($addbutton . html_writer::empty_tag('br') . $removebutton);
76 $buttonscell->id = 'buttonscell';
77 $label = html_writer::tag('label', get_string('potusers', 'webservice'),
72f68b51 78 array('for' => 'addselect'));
86dcc6f0 79 $label = html_writer::tag('p', $label);
72f68b51 80 $otheruserscell = new html_table_cell($label .
81 $options->potentialuserselector->display(true));
86dcc6f0 82 $otheruserscell->id = 'potentialcell';
83
84 $cells = array($authoriseduserscell, $buttonscell, $otheruserscell);
85 $row = new html_table_row($cells);
86 $table->data[] = $row;
87 $formcontent .= html_writer::table($table);
88
89 $formcontent = html_writer::tag('div', $formcontent);
90
de55d469 91 $actionurl = new moodle_url('/' . $CFG->admin . '/webservice/service_users.php',
86dcc6f0 92 array('id' => $options->serviceid));
93 $html = html_writer::tag('form', $formcontent,
72f68b51 94 array('id' => 'assignform', 'action' => $actionurl, 'method' => 'post'));
86dcc6f0 95 return $html;
96 }
97
98 /**
a0a07014
JM
99 * Display list of authorised users
100 *
101 * @param array $users authorised users
102 * @param int $serviceid service id
86dcc6f0 103 * @return string $html
104 */
105 public function admin_authorised_user_list($users, $serviceid) {
de55d469 106 global $CFG;
72f68b51 107 $html = $this->output->box_start('generalbox', 'alloweduserlist');
86dcc6f0 108 foreach ($users as $user) {
de55d469 109 $modifiedauthoriseduserurl = new moodle_url('/' . $CFG->admin . '/webservice/service_user_settings.php',
86dcc6f0 110 array('userid' => $user->id, 'serviceid' => $serviceid));
72f68b51 111 $html .= html_writer::tag('a', $user->firstname . " "
112 . $user->lastname . ", " . $user->email,
86dcc6f0 113 array('href' => $modifiedauthoriseduserurl));
72f68b51 114 //add missing capabilities
115 if (!empty($user->missingcapabilities)) {
116 $html .= html_writer::tag('div',
117 get_string('usermissingcaps', 'webservice', $user->missingcapabilities)
118 . '&nbsp;' . $this->output->help_icon('missingcaps', 'webservice'),
119 array('class' => 'missingcaps', 'id' => 'usermissingcaps'));
120 $html .= html_writer::empty_tag('br');
121 } else {
122 $html .= html_writer::empty_tag('br') . html_writer::empty_tag('br');
123 }
124 }
125 $html .= $this->output->box_end();
126 return $html;
127 }
128
129 /**
130 * Display a confirmation page to remove a function from a service
a0a07014
JM
131 *
132 * @param stdClass $function It needs function id + function name properties.
133 * @param stdClass $service It needs service id + service name properties.
72f68b51 134 * @return string html
135 */
136 public function admin_remove_service_function_confirmation($function, $service) {
137 $optionsyes = array('id' => $service->id, 'action' => 'delete',
138 'confirm' => 1, 'sesskey' => sesskey(), 'fid' => $function->id);
139 $optionsno = array('id' => $service->id);
140 $formcontinue = new single_button(new moodle_url('service_functions.php',
141 $optionsyes), get_string('remove'));
142 $formcancel = new single_button(new moodle_url('service_functions.php',
143 $optionsno), get_string('cancel'), 'get');
144 return $this->output->confirm(get_string('removefunctionconfirm', 'webservice',
145 (object) array('service' => $service->name, 'function' => $function->name)),
146 $formcontinue, $formcancel);
147 }
148
c25662b0 149 /**
150 * Display a confirmation page to remove a service
a0a07014
JM
151 *
152 * @param stdClass $service It needs service id + service name properties.
c25662b0 153 * @return string html
154 */
155 public function admin_remove_service_confirmation($service) {
156 global $CFG;
157 $optionsyes = array('id' => $service->id, 'action' => 'delete',
158 'confirm' => 1, 'sesskey' => sesskey());
159 $optionsno = array('section' => 'externalservices');
160 $formcontinue = new single_button(new moodle_url('service.php', $optionsyes),
161 get_string('delete'), 'post');
162 $formcancel = new single_button(
163 new moodle_url($CFG->wwwroot . "/" . $CFG->admin . "/settings.php", $optionsno),
164 get_string('cancel'), 'get');
165 return $this->output->confirm(get_string('deleteserviceconfirm', 'webservice', $service->name),
166 $formcontinue, $formcancel);
167 }
168
9c954e88 169 /**
170 * Display a confirmation page to delete a token
a0a07014
JM
171 *
172 * @param stdClass $token Required properties: id (token id), firstname (user firstname), lastname (user lastname), name (service name)
9c954e88 173 * @return string html
174 */
175 public function admin_delete_token_confirmation($token) {
de55d469 176 global $CFG;
9c954e88 177 $optionsyes = array('tokenid' => $token->id, 'action' => 'delete',
178 'confirm' => 1, 'sesskey' => sesskey());
179 $optionsno = array('section' => 'webservicetokens', 'sesskey' => sesskey());
180 $formcontinue = new single_button(
de55d469 181 new moodle_url('/' . $CFG->admin . '/webservice/tokens.php', $optionsyes),
9c954e88 182 get_string('delete'));
183 $formcancel = new single_button(
de55d469 184 new moodle_url('/' . $CFG->admin . '/settings.php', $optionsno),
9c954e88 185 get_string('cancel'), 'get');
186 return $this->output->confirm(get_string('deletetokenconfirm', 'webservice',
187 (object) array('user' => $token->firstname . " "
9ef728d6 188 . $token->lastname, 'service' => $token->name)),
9c954e88 189 $formcontinue, $formcancel);
190 }
191
72f68b51 192 /**
a0a07014
JM
193 * Display a list of functions for a given service
194 * If the service is built-in, do not display remove/add operation (read-only)
195 *
196 * @param array $functions list of functions
197 * @param stdClass $service the given service
72f68b51 198 * @return string the table html + add operation html
199 */
200 public function admin_service_function_list($functions, $service) {
de55d469 201 global $CFG;
1d2a1936 202 if (!empty($functions)) {
203 $table = new html_table();
204 $table->head = array(get_string('function', 'webservice'),
205 get_string('description'), get_string('requiredcaps', 'webservice'));
206 $table->align = array('left', 'left', 'left');
207 $table->size = array('15%', '40%', '40%');
208 $table->width = '100%';
209 $table->align[] = 'left';
72f68b51 210
72f68b51 211 //display remove function operation (except for build-in service)
212 if (empty($service->component)) {
1d2a1936 213 $table->head[] = get_string('edit');
214 $table->align[] = 'center';
215 }
216
3c1aa6fd 217 $anydeprecated = false;
1d2a1936 218 foreach ($functions as $function) {
219 $function = external_function_info($function);
3c1aa6fd
DM
220
221 if (!empty($function->deprecated)) {
222 $anydeprecated = true;
223 }
1d2a1936 224 $requiredcaps = html_writer::tag('div',
225 empty($function->capabilities) ? '' : $function->capabilities,
226 array('class' => 'functiondesc'));
227 ;
228 $description = html_writer::tag('div', $function->description,
229 array('class' => 'functiondesc'));
230 //display remove function operation (except for build-in service)
231 if (empty($service->component)) {
de55d469 232 $removeurl = new moodle_url('/' . $CFG->admin . '/webservice/service_functions.php',
1d2a1936 233 array('sesskey' => sesskey(), 'fid' => $function->id,
234 'id' => $service->id,
235 'action' => 'delete'));
236 $removelink = html_writer::tag('a',
237 get_string('removefunction', 'webservice'),
238 array('href' => $removeurl));
239 $table->data[] = array($function->name, $description, $requiredcaps, $removelink);
240 } else {
241 $table->data[] = array($function->name, $description, $requiredcaps);
242 }
72f68b51 243 }
72f68b51 244
1d2a1936 245 $html = html_writer::table($table);
246 } else {
247 $html = get_string('nofunctions', 'webservice') . html_writer::empty_tag('br');
248 }
72f68b51 249
250 //display add function operation (except for build-in service)
251 if (empty($service->component)) {
3c1aa6fd
DM
252
253 if (!empty($anydeprecated)) {
254 debugging('This service uses deprecated functions, replace them by the proposed ones and update your client/s.', DEBUG_DEVELOPER);
255 }
de55d469 256 $addurl = new moodle_url('/' . $CFG->admin . '/webservice/service_functions.php',
72f68b51 257 array('sesskey' => sesskey(), 'id' => $service->id, 'action' => 'add'));
1d2a1936 258 $html .= html_writer::tag('a', get_string('addfunctions', 'webservice'), array('href' => $addurl));
72f68b51 259 }
260
86dcc6f0 261 return $html;
262 }
263
229a7099 264 /**
72f68b51 265 * Display Reset token confirmation box
a0a07014
JM
266 *
267 * @param stdClass $token token to reset
229a7099 268 * @return string html
269 */
270 public function user_reset_token_confirmation($token) {
72f68b51 271 global $CFG;
86dcc6f0 272 $managetokenurl = $CFG->wwwroot . "/user/managetoken.php?sesskey=" . sesskey();
72f68b51 273 $optionsyes = array('tokenid' => $token->id, 'action' => 'resetwstoken', 'confirm' => 1,
274 'sesskey' => sesskey());
86dcc6f0 275 $optionsno = array('section' => 'webservicetokens', 'sesskey' => sesskey());
72f68b51 276 $formcontinue = new single_button(new moodle_url($managetokenurl, $optionsyes),
277 get_string('reset'));
278 $formcancel = new single_button(new moodle_url($managetokenurl, $optionsno),
279 get_string('cancel'), 'get');
280 $html = $this->output->confirm(get_string('resettokenconfirm', 'webservice',
281 (object) array('user' => $token->firstname . " " .
9ef728d6 282 $token->lastname, 'service' => $token->name)),
86dcc6f0 283 $formcontinue, $formcancel);
229a7099 284 return $html;
285 }
286
229a7099 287 /**
288 * Display user tokens with buttons to reset them
a0a07014
JM
289 *
290 * @param stdClass $tokens user tokens
291 * @param int $userid user id
292 * @param bool $documentation if true display a link to the API documentation
229a7099 293 * @return string html code
294 */
9ef728d6 295 public function user_webservice_tokens_box($tokens, $userid, $documentation = false) {
252708c6 296 global $CFG, $DB;
229a7099 297
298 // display strings
299 $stroperation = get_string('operation', 'webservice');
300 $strtoken = get_string('key', 'webservice');
301 $strservice = get_string('service', 'webservice');
302 $strcreator = get_string('tokencreator', 'webservice');
303 $strcontext = get_string('context', 'webservice');
304 $strvaliduntil = get_string('validuntil', 'webservice');
305
72f68b51 306 $return = $this->output->heading(get_string('securitykeys', 'webservice'), 3, 'main', true);
307 $return .= $this->output->box_start('generalbox webservicestokenui');
229a7099 308
309 $return .= get_string('keyshelp', 'webservice');
310
311 $table = new html_table();
86dcc6f0 312 $table->head = array($strtoken, $strservice, $strvaliduntil, $strcreator, $stroperation);
229a7099 313 $table->align = array('left', 'left', 'left', 'center', 'left', 'center');
314 $table->width = '100%';
86dcc6f0 315 $table->data = array();
229a7099 316
9ef728d6 317 if ($documentation) {
318 $table->head[] = get_string('doc', 'webservice');
319 $table->align[] = 'center';
320 }
321
229a7099 322 if (!empty($tokens)) {
323 foreach ($tokens as $token) {
229a7099 324
325 if ($token->creatorid == $userid) {
72f68b51 326 $reset = "<a href=\"" . $CFG->wwwroot . "/user/managetoken.php?sesskey="
327 . sesskey() . "&amp;action=resetwstoken&amp;tokenid=" . $token->id . "\">";
86dcc6f0 328 $reset .= get_string('reset') . "</a>";
329 $creator = $token->firstname . " " . $token->lastname;
229a7099 330 } else {
9ef728d6 331 //retrieve administrator name
252708c6 332 $admincreator = $DB->get_record('user', array('id'=>$token->creatorid));
86dcc6f0 333 $creator = $admincreator->firstname . " " . $admincreator->lastname;
229a7099 334 $reset = '';
335 }
336
86dcc6f0 337 $userprofilurl = new moodle_url('/user/view.php?id=' . $token->creatorid);
229a7099 338 $creatoratag = html_writer::start_tag('a', array('href' => $userprofilurl));
339 $creatoratag .= $creator;
340 $creatoratag .= html_writer::end_tag('a');
341
342 $validuntil = '';
343 if (!empty($token->validuntil)) {
2af34ab0 344 $validuntil = userdate($token->validuntil, get_string('strftimedatetime', 'langconfig'));
229a7099 345 }
346
88876011 347 $tokenname = $token->name;
e88c193f 348 if (!$token->enabled) { //that is the (1 token-1ws) related ws is not enabled.
88876011 349 $tokenname = '<span class="dimmed_text">'.$token->name.'</span>';
e88c193f 350 }
88876011 351 $row = array($token->token, $tokenname, $validuntil, $creatoratag, $reset);
9ef728d6 352
353 if ($documentation) {
252708c6 354 $doclink = new moodle_url('/webservice/wsdoc.php',
9ef728d6 355 array('id' => $token->id, 'sesskey' => sesskey()));
356 $row[] = html_writer::tag('a', get_string('doc', 'webservice'),
357 array('href' => $doclink));
358 }
359
252708c6 360 $table->data[] = $row;
229a7099 361 }
362 $return .= html_writer::table($table);
229a7099 363 } else {
364 $return .= get_string('notoken', 'webservice');
365 }
366
72f68b51 367 $return .= $this->output->box_end();
229a7099 368 return $return;
369 }
370
86dcc6f0 371 /**
334f9dbb 372 * Return documentation for a ws description object
72f68b51 373 * ws description object can be 'external_multiple_structure', 'external_single_structure'
374 * or 'external_value'
a0a07014 375 *
334f9dbb 376 * Example of documentation for moodle_group_create_groups function:
a0a07014
JM
377 * list of (
378 * object {
379 * courseid int //id of course
380 * name string //multilang compatible name, course unique
381 * description string //group description text
382 * enrolmentkey string //group enrol secret phrase
383 * }
384 * )
385 *
386 * @param stdClass $params a part of parameter/return description
d4c6ef70 387 * @return string the html to display
388 */
360e9415 389 public function detailed_description_html($params) {
a0a07014 390 // retrieve the description of the description object
d4c6ef70 391 $paramdesc = "";
392 if (!empty($params->desc)) {
5d0c95a5 393 $paramdesc .= html_writer::start_tag('span', array('style' => "color:#2A33A6"));
382b9cea 394 if ($params->required == VALUE_REQUIRED) {
395 $required = '';
396 }
397 if ($params->required == VALUE_DEFAULT) {
4b2023df 398 if ($params->default === null) {
382b9cea 399 $params->default = "null";
400 }
72f68b51 401 $required = html_writer::start_tag('b', array()) .
8abfe383 402 get_string('default', 'webservice', print_r($params->default, true))
72f68b51 403 . html_writer::end_tag('b');
382b9cea 404 }
405 if ($params->required == VALUE_OPTIONAL) {
72f68b51 406 $required = html_writer::start_tag('b', array()) .
407 get_string('optional', 'webservice') . html_writer::end_tag('b');
382b9cea 408 }
86dcc6f0 409 $paramdesc .= " " . $required . " ";
5d0c95a5 410 $paramdesc .= html_writer::start_tag('i', array());
382b9cea 411 $paramdesc .= "//";
412
413 $paramdesc .= $params->desc;
414
5d0c95a5 415 $paramdesc .= html_writer::end_tag('i');
86dcc6f0 416
5d0c95a5
PS
417 $paramdesc .= html_writer::end_tag('span');
418 $paramdesc .= html_writer::empty_tag('br', array());
d4c6ef70 419 }
d4c6ef70 420
a0a07014 421 // description object is a list
334f9dbb 422 if ($params instanceof external_multiple_structure) {
72f68b51 423 return $paramdesc . "list of ( " . html_writer::empty_tag('br', array())
424 . $this->detailed_description_html($params->content) . ")";
d4c6ef70 425 } else if ($params instanceof external_single_structure) {
a0a07014 426 // description object is an object
86dcc6f0 427 $singlestructuredesc = $paramdesc . "object {" . html_writer::empty_tag('br', array());
d4c6ef70 428 foreach ($params->keys as $attributname => $attribut) {
5d0c95a5 429 $singlestructuredesc .= html_writer::start_tag('b', array());
4597fd4d 430 $singlestructuredesc .= $attributname;
5d0c95a5 431 $singlestructuredesc .= html_writer::end_tag('b');
72f68b51 432 $singlestructuredesc .= " " .
433 $this->detailed_description_html($params->keys[$attributname]);
d4c6ef70 434 }
4597fd4d 435 $singlestructuredesc .= "} ";
5d0c95a5 436 $singlestructuredesc .= html_writer::empty_tag('br', array());
d4c6ef70 437 return $singlestructuredesc;
438 } else {
a0a07014 439 // description object is a primary type (string, integer)
86dcc6f0 440 switch ($params->type) {
d4c6ef70 441 case PARAM_BOOL: // 0 or 1 only for now
442 case PARAM_INT:
443 $type = 'int';
444 break;
445 case PARAM_FLOAT;
446 $type = 'double';
447 break;
448 default:
449 $type = 'string';
450 }
86dcc6f0 451 return $type . " " . $paramdesc;
d4c6ef70 452 }
d4c6ef70 453 }
454
455 /**
334f9dbb 456 * Return a description object in indented xml format (for REST response)
a0a07014
JM
457 * It is indented to be output within <pre> tags
458 *
459 * @param external_description $returndescription the description structure of the web service function returned value
460 * @param string $indentation Indentation in the generated HTML code; should contain only spaces.
d4c6ef70 461 * @return string the html to diplay
462 */
463 public function description_in_indented_xml_format($returndescription, $indentation = "") {
464 $indentation = $indentation . " ";
465 $brakeline = <<<EOF
466
467
468EOF;
a0a07014 469 // description object is a list
d4c6ef70 470 if ($returndescription instanceof external_multiple_structure) {
86dcc6f0 471 $return = $indentation . "<MULTIPLE>" . $brakeline;
72f68b51 472 $return .= $this->description_in_indented_xml_format($returndescription->content,
473 $indentation);
86dcc6f0 474 $return .= $indentation . "</MULTIPLE>" . $brakeline;
d4c6ef70 475 return $return;
476 } else if ($returndescription instanceof external_single_structure) {
a0a07014 477 // description object is an object
86dcc6f0 478 $singlestructuredesc = $indentation . "<SINGLE>" . $brakeline;
479 $keyindentation = $indentation . " ";
d4c6ef70 480 foreach ($returndescription->keys as $attributname => $attribut) {
72f68b51 481 $singlestructuredesc .= $keyindentation . "<KEY name=\"" . $attributname . "\">"
482 . $brakeline .
483 $this->description_in_indented_xml_format(
484 $returndescription->keys[$attributname], $keyindentation) .
86dcc6f0 485 $keyindentation . "</KEY>" . $brakeline;
d4c6ef70 486 }
86dcc6f0 487 $singlestructuredesc .= $indentation . "</SINGLE>" . $brakeline;
d4c6ef70 488 return $singlestructuredesc;
489 } else {
a0a07014 490 // description object is a primary type (string, integer)
86dcc6f0 491 switch ($returndescription->type) {
d4c6ef70 492 case PARAM_BOOL: // 0 or 1 only for now
493 case PARAM_INT:
494 $type = 'int';
495 break;
496 case PARAM_FLOAT;
497 $type = 'double';
498 break;
499 default:
500 $type = 'string';
501 }
86dcc6f0 502 return $indentation . "<VALUE>" . $type . "</VALUE>" . $brakeline;
d4c6ef70 503 }
504 }
505
86dcc6f0 506 /**
360e9415 507 * Create indented XML-RPC param description
a0a07014
JM
508 *
509 * @param external_description $paramdescription the description structure of the web service function parameters
510 * @param string $indentation Indentation in the generated HTML code; should contain only spaces.
360e9415 511 * @return string the html to diplay
512 */
513 public function xmlrpc_param_description_html($paramdescription, $indentation = "") {
514 $indentation = $indentation . " ";
515 $brakeline = <<<EOF
516
517
518EOF;
a0a07014 519 // description object is a list
360e9415 520 if ($paramdescription instanceof external_multiple_structure) {
86dcc6f0 521 $return = $brakeline . $indentation . "Array ";
360e9415 522 $indentation = $indentation . " ";
86dcc6f0 523 $return .= $brakeline . $indentation . "(";
524 $return .= $brakeline . $indentation . "[0] =>";
360e9415 525 $return .= $this->xmlrpc_param_description_html($paramdescription->content, $indentation);
86dcc6f0 526 $return .= $brakeline . $indentation . ")";
360e9415 527 return $return;
528 } else if ($paramdescription instanceof external_single_structure) {
a0a07014 529 // description object is an object
86dcc6f0 530 $singlestructuredesc = $brakeline . $indentation . "Array ";
531 $keyindentation = $indentation . " ";
532 $singlestructuredesc .= $brakeline . $keyindentation . "(";
360e9415 533 foreach ($paramdescription->keys as $attributname => $attribut) {
86dcc6f0 534 $singlestructuredesc .= $brakeline . $keyindentation . "[" . $attributname . "] =>" .
72f68b51 535 $this->xmlrpc_param_description_html(
536 $paramdescription->keys[$attributname], $keyindentation) .
360e9415 537 $keyindentation;
538 }
86dcc6f0 539 $singlestructuredesc .= $brakeline . $keyindentation . ")";
360e9415 540 return $singlestructuredesc;
541 } else {
a0a07014 542 // description object is a primary type (string, integer)
86dcc6f0 543 switch ($paramdescription->type) {
360e9415 544 case PARAM_BOOL: // 0 or 1 only for now
545 case PARAM_INT:
546 $type = 'int';
547 break;
548 case PARAM_FLOAT;
549 $type = 'double';
550 break;
551 default:
552 $type = 'string';
553 }
86dcc6f0 554 return " " . $type;
360e9415 555 }
556 }
557
334f9dbb 558 /**
a0a07014
JM
559 * Return the html of a coloured box with content
560 *
334f9dbb 561 * @param string $title - the title of the box
562 * @param string $content - the content to displayed
563 * @param string $rgb - the background color of the box
a0a07014 564 * @return string HTML code
334f9dbb 565 */
4597fd4d 566 public function colored_box_with_pre_tag($title, $content, $rgb = 'FEEBE5') {
a0a07014 567 //TODO MDL-31192 this tag removes xhtml strict error but cause warning
8abfe383 568 $coloredbox = html_writer::start_tag('div', array());
72f68b51 569 $coloredbox .= html_writer::start_tag('div',
570 array('style' => "border:solid 1px #DEDEDE;background:#" . $rgb
571 . ";color:#222222;padding:4px;"));
5d0c95a5
PS
572 $coloredbox .= html_writer::start_tag('pre', array());
573 $coloredbox .= html_writer::start_tag('b', array());
4597fd4d 574 $coloredbox .= $title;
5d0c95a5
PS
575 $coloredbox .= html_writer::end_tag('b', array());
576 $coloredbox .= html_writer::empty_tag('br', array());
86dcc6f0 577 $coloredbox .= "\n" . $content . "\n";
5d0c95a5
PS
578 $coloredbox .= html_writer::end_tag('pre', array());
579 $coloredbox .= html_writer::end_tag('div', array());
8abfe383 580 $coloredbox .= html_writer::end_tag('div', array());
4597fd4d 581 return $coloredbox;
d4c6ef70 582 }
583
86dcc6f0 584 /**
334f9dbb 585 * Return indented REST param description
a0a07014
JM
586 *
587 * @param external_description $paramdescription the description structure of the web service function parameters
588 * @param string $paramstring parameter
886e3bfb 589 * @return string the html to diplay
590 */
591 public function rest_param_description_html($paramdescription, $paramstring) {
592 $brakeline = <<<EOF
593
594
595EOF;
a0a07014 596 // description object is a list
886e3bfb 597 if ($paramdescription instanceof external_multiple_structure) {
86dcc6f0 598 $paramstring = $paramstring . '[0]';
886e3bfb 599 $return = $this->rest_param_description_html($paramdescription->content, $paramstring);
600 return $return;
601 } else if ($paramdescription instanceof external_single_structure) {
a0a07014 602 // description object is an object
886e3bfb 603 $singlestructuredesc = "";
7ef73632 604 $initialparamstring = $paramstring;
886e3bfb 605 foreach ($paramdescription->keys as $attributname => $attribut) {
86dcc6f0 606 $paramstring = $initialparamstring . '[' . $attributname . ']';
72f68b51 607 $singlestructuredesc .= $this->rest_param_description_html(
608 $paramdescription->keys[$attributname], $paramstring);
886e3bfb 609 }
610 return $singlestructuredesc;
611 } else {
a0a07014 612 // description object is a primary type (string, integer)
86dcc6f0 613 $paramstring = $paramstring . '=';
614 switch ($paramdescription->type) {
886e3bfb 615 case PARAM_BOOL: // 0 or 1 only for now
616 case PARAM_INT:
617 $type = 'int';
618 break;
619 case PARAM_FLOAT;
620 $type = 'double';
621 break;
622 default:
623 $type = 'string';
624 }
86dcc6f0 625 return $paramstring . " " . $type . $brakeline;
886e3bfb 626 }
627 }
628
d4c6ef70 629 /**
a0a07014
JM
630 * Displays all the documentation
631 *
632 * @param array $functions external_description of all the web service functions
cdb0bd6a 633 * @param boolean $printableformat true if we want to display the documentation in a printable format
a0a07014
JM
634 * @param array $activatedprotocol the currently enabled protocol
635 * @param array $authparams url parameters (it contains 'tokenid' and sometimes 'print')
cde291ed
JM
636 * @param string $parenturl url of the calling page - needed for the print button url:
637 * '/admin/documentation.php' or '/webservice/wsdoc.php' (default)
d4c6ef70 638 * @return string the html to diplay
639 */
cde291ed
JM
640 public function documentation_html($functions, $printableformat, $activatedprotocol,
641 $authparams, $parenturl = '/webservice/wsdoc.php') {
9ef728d6 642
cde291ed 643 $documentationhtml = $this->output->heading(get_string('wsdocapi', 'webservice'));
9ef728d6 644
85b4c447 645 $br = html_writer::empty_tag('br', array());
360e9415 646 $brakeline = <<<EOF
647
648
649EOF;
a0a07014 650 // Some general information
390cc887 651 $docinfo = new stdClass();
728ebac7 652 $docurl = new moodle_url('http://docs.moodle.org/dev/Creating_a_web_service_client');
390cc887 653 $docinfo->doclink = html_writer::tag('a',
72f68b51 654 get_string('wsclientdoc', 'webservice'), array('href' => $docurl));
390cc887 655 $documentationhtml .= get_string('wsdocumentationintro', 'webservice', $docinfo);
86dcc6f0 656 $documentationhtml .= $br . $br;
657
cdb0bd6a 658
a0a07014 659 // Print button
85b4c447 660 $authparams['print'] = true;
cde291ed 661 $url = new moodle_url($parenturl, $authparams); // Required
72f68b51 662 $documentationhtml .= $this->output->single_button($url, get_string('print', 'webservice'));
85b4c447 663 $documentationhtml .= $br;
86dcc6f0 664
665
a0a07014 666 // each functions will be displayed into a collapsible region
72f68b51 667 //(opened if printableformat = true)
d4c6ef70 668 foreach ($functions as $functionname => $description) {
f03bff3e 669
670 if (empty($printableformat)) {
671 $documentationhtml .= print_collapsible_region_start('',
86dcc6f0 672 'aera_' . $functionname,
72f68b51 673 html_writer::start_tag('strong', array())
674 . $functionname . html_writer::end_tag('strong'),
86dcc6f0 675 false,
676 !$printableformat,
677 true);
f03bff3e 678 } else {
26acc814 679 $documentationhtml .= html_writer::tag('strong', $functionname);
85b4c447 680 $documentationhtml .= $br;
f03bff3e 681 }
d4c6ef70 682
a0a07014 683 // function global description
85b4c447 684 $documentationhtml .= $br;
72f68b51 685 $documentationhtml .= html_writer::start_tag('div',
686 array('style' => 'border:solid 1px #DEDEDE;background:#E2E0E0;
687 color:#222222;padding:4px;'));
d4c6ef70 688 $documentationhtml .= $description->description;
5d0c95a5 689 $documentationhtml .= html_writer::end_tag('div');
86dcc6f0 690 $documentationhtml .= $br . $br;
4597fd4d 691
a0a07014 692 // function arguments documentation
5d0c95a5 693 $documentationhtml .= html_writer::start_tag('span', array('style' => 'color:#EA33A6'));
4597fd4d 694 $documentationhtml .= get_string('arguments', 'webservice');
5d0c95a5 695 $documentationhtml .= html_writer::end_tag('span');
85b4c447 696 $documentationhtml .= $br;
d4c6ef70 697 foreach ($description->parameters_desc->keys as $paramname => $paramdesc) {
a0a07014 698 // a argument documentation
5d0c95a5 699 $documentationhtml .= html_writer::start_tag('span', array('style' => 'font-size:80%'));
86dcc6f0 700
382b9cea 701 if ($paramdesc->required == VALUE_REQUIRED) {
86dcc6f0 702 $required = get_string('required', 'webservice');
382b9cea 703 }
704 if ($paramdesc->required == VALUE_DEFAULT) {
4b2023df 705 if ($paramdesc->default === null) {
382b9cea 706 $default = "null";
707 } else {
8abfe383 708 $default = print_r($paramdesc->default, true);
382b9cea 709 }
710 $required = get_string('default', 'webservice', $default);
711 }
712 if ($paramdesc->required == VALUE_OPTIONAL) {
86dcc6f0 713 $required = get_string('optional', 'webservice');
382b9cea 714 }
86dcc6f0 715
5d0c95a5 716 $documentationhtml .= html_writer::start_tag('b', array());
4597fd4d 717 $documentationhtml .= $paramname;
5d0c95a5 718 $documentationhtml .= html_writer::end_tag('b');
86dcc6f0 719 $documentationhtml .= " (" . $required . ")"; // argument is required or optional ?
85b4c447 720 $documentationhtml .= $br;
72f68b51 721 $documentationhtml .= "&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"
722 . $paramdesc->desc; // argument description
86dcc6f0 723 $documentationhtml .= $br . $br;
a0a07014 724 // general structure of the argument
72f68b51 725 $documentationhtml .= $this->colored_box_with_pre_tag(
726 get_string('generalstructure', 'webservice'),
86dcc6f0 727 $this->detailed_description_html($paramdesc),
728 'FFF1BC');
a0a07014 729 // xml-rpc structure of the argument in PHP format
abf7dc44 730 if (!empty($activatedprotocol['xmlrpc'])) {
72f68b51 731 $documentationhtml .= $this->colored_box_with_pre_tag(
732 get_string('phpparam', 'webservice'),
733 htmlentities('[' . $paramname . '] =>'
734 . $this->xmlrpc_param_description_html($paramdesc)),
86dcc6f0 735 'DFEEE7');
abf7dc44 736 }
a0a07014 737 // POST format for the REST protocol for the argument
abf7dc44 738 if (!empty($activatedprotocol['rest'])) {
72f68b51 739 $documentationhtml .= $this->colored_box_with_pre_tag(
740 get_string('restparam', 'webservice'),
741 htmlentities($this->rest_param_description_html(
742 $paramdesc, $paramname)),
86dcc6f0 743 'FEEBE5');
abf7dc44 744 }
5d0c95a5 745 $documentationhtml .= html_writer::end_tag('span');
d4c6ef70 746 }
86dcc6f0 747 $documentationhtml .= $br . $br;
4597fd4d 748
334f9dbb 749
a0a07014 750 // function response documentation
5d0c95a5 751 $documentationhtml .= html_writer::start_tag('span', array('style' => 'color:#EA33A6'));
4597fd4d 752 $documentationhtml .= get_string('response', 'webservice');
5d0c95a5 753 $documentationhtml .= html_writer::end_tag('span');
85b4c447 754 $documentationhtml .= $br;
a0a07014 755 // function response description
5d0c95a5 756 $documentationhtml .= html_writer::start_tag('span', array('style' => 'font-size:80%'));
d4c6ef70 757 if (!empty($description->returns_desc->desc)) {
4597fd4d 758 $documentationhtml .= $description->returns_desc->desc;
86dcc6f0 759 $documentationhtml .= $br . $br;
d4c6ef70 760 }
d4c6ef70 761 if (!empty($description->returns_desc)) {
a0a07014 762 // general structure of the response
72f68b51 763 $documentationhtml .= $this->colored_box_with_pre_tag(
764 get_string('generalstructure', 'webservice'),
86dcc6f0 765 $this->detailed_description_html($description->returns_desc),
766 'FFF1BC');
a0a07014 767 // xml-rpc structure of the response in PHP format
abf7dc44 768 if (!empty($activatedprotocol['xmlrpc'])) {
72f68b51 769 $documentationhtml .= $this->colored_box_with_pre_tag(
770 get_string('phpresponse', 'webservice'),
771 htmlentities($this->xmlrpc_param_description_html(
772 $description->returns_desc)),
86dcc6f0 773 'DFEEE7');
abf7dc44 774 }
a0a07014 775 // XML response for the REST protocol
abf7dc44 776 if (!empty($activatedprotocol['rest'])) {
72f68b51 777 $restresponse = "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>"
778 . $brakeline . "<RESPONSE>" . $brakeline;
779 $restresponse .= $this->description_in_indented_xml_format(
780 $description->returns_desc);
86dcc6f0 781 $restresponse .="</RESPONSE>" . $brakeline;
72f68b51 782 $documentationhtml .= $this->colored_box_with_pre_tag(
783 get_string('restcode', 'webservice'),
86dcc6f0 784 htmlentities($restresponse),
785 'FEEBE5');
abf7dc44 786 }
d4c6ef70 787 }
5d0c95a5 788 $documentationhtml .= html_writer::end_tag('span');
86dcc6f0 789 $documentationhtml .= $br . $br;
d4c6ef70 790
a0a07014 791 // function errors documentation for REST protocol
abf7dc44 792 if (!empty($activatedprotocol['rest'])) {
5d0c95a5 793 $documentationhtml .= html_writer::start_tag('span', array('style' => 'color:#EA33A6'));
4597fd4d 794 $documentationhtml .= get_string('errorcodes', 'webservice');
5d0c95a5 795 $documentationhtml .= html_writer::end_tag('span');
86dcc6f0 796 $documentationhtml .= $br . $br;
5d0c95a5 797 $documentationhtml .= html_writer::start_tag('span', array('style' => 'font-size:80%'));
abf7dc44 798 $errormessage = get_string('invalidparameter', 'debug');
86dcc6f0 799 $restexceptiontext = <<<EOF
abf7dc44 800<?xml version="1.0" encoding="UTF-8"?>
801<EXCEPTION class="invalid_parameter_exception">
802 <MESSAGE>{$errormessage}</MESSAGE>
803 <DEBUGINFO></DEBUGINFO>
804</EXCEPTION>
805EOF;
72f68b51 806 $documentationhtml .= $this->colored_box_with_pre_tag(
807 get_string('restexception', 'webservice'),
86dcc6f0 808 htmlentities($restexceptiontext),
809 'FEEBE5');
4597fd4d 810
86dcc6f0 811 $documentationhtml .= html_writer::end_tag('span');
abf7dc44 812 }
86dcc6f0 813 $documentationhtml .= $br . $br;
72f8324e 814
5d8c1987
DW
815 // Login required info.
816 $documentationhtml .= html_writer::start_tag('span', array('style' => 'color:#EA33A6'));
817 $documentationhtml .= get_string('loginrequired', 'webservice') . $br;
818 $documentationhtml .= html_writer::end_tag('span');
819 $documentationhtml .= $description->loginrequired ? get_string('yes') : get_string('no');
820 $documentationhtml .= $br . $br;
821
72f8324e
DW
822 // Ajax info.
823 $documentationhtml .= html_writer::start_tag('span', array('style' => 'color:#EA33A6'));
824 $documentationhtml .= get_string('callablefromajax', 'webservice') . $br;
825 $documentationhtml .= html_writer::end_tag('span');
826 $documentationhtml .= $description->allowed_from_ajax ? get_string('yes') : get_string('no');
827 $documentationhtml .= $br . $br;
828
f03bff3e 829 if (empty($printableformat)) {
830 $documentationhtml .= print_collapsible_region_end(true);
831 }
d4c6ef70 832 }
833
d4c6ef70 834 return $documentationhtml;
d4c6ef70 835 }
836
d4c6ef70 837}