2 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
19 * Support for external API
21 * @package core_webservice
22 * @copyright 2009 Petr Skodak
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26 defined('MOODLE_INTERNAL') ||
die();
29 * Exception indicating user is not allowed to use external function in the current context.
31 * @package core_webservice
32 * @copyright 2009 Petr Skodak
33 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36 class restricted_context_exception
extends moodle_exception
{
42 function __construct() {
43 parent
::__construct('restrictedcontextexception', 'error');
48 * Base class for external api methods.
50 * @package core_webservice
51 * @copyright 2009 Petr Skodak
52 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
57 /** @var stdClass context where the function calls will be restricted */
58 private static $contextrestriction;
61 * Returns detailed function information
63 * @param string|object $function name of external function or record from external_function
64 * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
65 * MUST_EXIST means throw exception if no record or multiple records found
66 * @return stdClass description or false if not found or exception thrown
69 public static function external_function_info($function, $strictness=MUST_EXIST
) {
72 if (!is_object($function)) {
73 if (!$function = $DB->get_record('external_functions', array('name' => $function), '*', $strictness)) {
78 // First try class autoloading.
79 if (!class_exists($function->classname
)) {
80 // Fallback to explicit include of externallib.php.
81 if (empty($function->classpath
)) {
82 $function->classpath
= core_component
::get_component_directory($function->component
).'/externallib.php';
84 $function->classpath
= $CFG->dirroot
.'/'.$function->classpath
;
86 if (!file_exists($function->classpath
)) {
87 throw new coding_exception('Cannot find file with external function implementation');
89 require_once($function->classpath
);
90 if (!class_exists($function->classname
)) {
91 throw new coding_exception('Cannot find external class');
95 $function->ajax_method
= $function->methodname
.'_is_allowed_from_ajax';
96 $function->parameters_method
= $function->methodname
.'_parameters';
97 $function->returns_method
= $function->methodname
.'_returns';
98 $function->deprecated_method
= $function->methodname
.'_is_deprecated';
100 // Make sure the implementaion class is ok.
101 if (!method_exists($function->classname
, $function->methodname
)) {
102 throw new coding_exception('Missing implementation method of '.$function->classname
.'::'.$function->methodname
);
104 if (!method_exists($function->classname
, $function->parameters_method
)) {
105 throw new coding_exception('Missing parameters description');
107 if (!method_exists($function->classname
, $function->returns_method
)) {
108 throw new coding_exception('Missing returned values description');
110 if (method_exists($function->classname
, $function->deprecated_method
)) {
111 if (call_user_func(array($function->classname
, $function->deprecated_method
)) === true) {
112 $function->deprecated
= true;
115 $function->allowed_from_ajax
= false;
117 // Fetch the parameters description.
118 $function->parameters_desc
= call_user_func(array($function->classname
, $function->parameters_method
));
119 if (!($function->parameters_desc
instanceof external_function_parameters
)) {
120 throw new coding_exception('Invalid parameters description');
123 // Fetch the return values description.
124 $function->returns_desc
= call_user_func(array($function->classname
, $function->returns_method
));
125 // Null means void result or result is ignored.
126 if (!is_null($function->returns_desc
) and !($function->returns_desc
instanceof external_description
)) {
127 throw new coding_exception('Invalid return description');
130 // Now get the function description.
132 // TODO MDL-31115 use localised lang pack descriptions, it would be nice to have
133 // easy to understand descriptions in admin UI,
134 // on the other hand this is still a bit in a flux and we need to find some new naming
135 // conventions for these descriptions in lang packs.
136 $function->description
= null;
137 $servicesfile = core_component
::get_component_directory($function->component
).'/db/services.php';
138 if (file_exists($servicesfile)) {
140 include($servicesfile);
141 if (isset($functions[$function->name
]['description'])) {
142 $function->description
= $functions[$function->name
]['description'];
144 if (isset($functions[$function->name
]['testclientpath'])) {
145 $function->testclientpath
= $functions[$function->name
]['testclientpath'];
147 if (isset($functions[$function->name
]['type'])) {
148 $function->type
= $functions[$function->name
]['type'];
150 if (isset($functions[$function->name
]['ajax'])) {
151 $function->allowed_from_ajax
= $functions[$function->name
]['ajax'];
152 } else if (method_exists($function->classname
, $function->ajax_method
)) {
153 if (call_user_func(array($function->classname
, $function->ajax_method
)) === true) {
154 debugging('External function ' . $function->ajax_method
. '() function is deprecated.' .
155 'Set ajax=>true in db/service.php instead.', DEBUG_DEVELOPER
);
156 $function->allowed_from_ajax
= true;
159 if (isset($functions[$function->name
]['loginrequired'])) {
160 $function->loginrequired
= $functions[$function->name
]['loginrequired'];
162 $function->loginrequired
= true;
170 * Call an external function validating all params/returns correctly.
172 * Note that an external function may modify the state of the current page, so this wrapper
173 * saves and restores tha PAGE and COURSE global variables before/after calling the external function.
175 * @param string $function A webservice function name.
176 * @param array $args Params array (named params)
177 * @param boolean $ajaxonly If true, an extra check will be peformed to see if ajax is required.
178 * @return array containing keys for error (bool), exception and data.
180 public static function call_external_function($function, $args, $ajaxonly=false) {
181 global $PAGE, $COURSE, $CFG, $SITE;
183 require_once($CFG->libdir
. "/pagelib.php");
185 $externalfunctioninfo = self
::external_function_info($function);
187 $currentpage = $PAGE;
188 $currentcourse = $COURSE;
192 // Taken straight from from setup.php.
193 if (!empty($CFG->moodlepageclass
)) {
194 if (!empty($CFG->moodlepageclassfile
)) {
195 require_once($CFG->moodlepageclassfile
);
197 $classname = $CFG->moodlepageclass
;
199 $classname = 'moodle_page';
201 $PAGE = new $classname();
202 $COURSE = clone($SITE);
204 if ($ajaxonly && !$externalfunctioninfo->allowed_from_ajax
) {
205 throw new moodle_exception('servicenotavailable', 'webservice');
208 // Do not allow access to write or delete webservices as a public user.
209 if ($externalfunctioninfo->loginrequired
) {
210 if (defined('NO_MOODLE_COOKIES') && NO_MOODLE_COOKIES
&& !PHPUNIT_TEST
) {
211 throw new moodle_exception('servicenotavailable', 'webservice');
214 throw new moodle_exception('servicenotavailable', 'webservice');
220 // Validate params, this also sorts the params properly, we need the correct order in the next part.
221 $callable = array($externalfunctioninfo->classname
, 'validate_parameters');
222 $params = call_user_func($callable,
223 $externalfunctioninfo->parameters_desc
,
227 $callable = array($externalfunctioninfo->classname
, $externalfunctioninfo->methodname
);
228 $result = call_user_func_array($callable,
229 array_values($params));
231 // Validate the return parameters.
232 if ($externalfunctioninfo->returns_desc
!== null) {
233 $callable = array($externalfunctioninfo->classname
, 'clean_returnvalue');
234 $result = call_user_func($callable, $externalfunctioninfo->returns_desc
, $result);
237 $response['error'] = false;
238 $response['data'] = $result;
239 } catch (Exception
$e) {
240 $exception = get_exception_info($e);
241 unset($exception->a
);
242 $exception->backtrace
= format_backtrace($exception->backtrace
, true);
243 if (!debugging('', DEBUG_DEVELOPER
)) {
244 unset($exception->debuginfo
);
245 unset($exception->backtrace
);
247 $response['error'] = true;
248 $response['exception'] = $exception;
249 // Do not process the remaining requests.
252 $PAGE = $currentpage;
253 $COURSE = $currentcourse;
259 * Set context restriction for all following subsequent function calls.
261 * @param stdClass $context the context restriction
264 public static function set_context_restriction($context) {
265 self
::$contextrestriction = $context;
269 * This method has to be called before every operation
270 * that takes a longer time to finish!
272 * @param int $seconds max expected time the next operation needs
275 public static function set_timeout($seconds=360) {
276 $seconds = ($seconds < 300) ?
300 : $seconds;
277 core_php_time_limit
::raise($seconds);
281 * Validates submitted function parameters, if anything is incorrect
282 * invalid_parameter_exception is thrown.
283 * This is a simple recursive method which is intended to be called from
284 * each implementation method of external API.
286 * @param external_description $description description of parameters
287 * @param mixed $params the actual parameters
288 * @return mixed params with added defaults for optional items, invalid_parameters_exception thrown if any problem found
291 public static function validate_parameters(external_description
$description, $params) {
292 if ($description instanceof external_value
) {
293 if (is_array($params) or is_object($params)) {
294 throw new invalid_parameter_exception('Scalar type expected, array or object received.');
297 if ($description->type
== PARAM_BOOL
) {
298 // special case for PARAM_BOOL - we want true/false instead of the usual 1/0 - we can not be too strict here ;-)
299 if (is_bool($params) or $params === 0 or $params === 1 or $params === '0' or $params === '1') {
300 return (bool)$params;
303 $debuginfo = 'Invalid external api parameter: the value is "' . $params .
304 '", the server was expecting "' . $description->type
. '" type';
305 return validate_param($params, $description->type
, $description->allownull
, $debuginfo);
307 } else if ($description instanceof external_single_structure
) {
308 if (!is_array($params)) {
309 throw new invalid_parameter_exception('Only arrays accepted. The bad value is: \''
310 . print_r($params, true) . '\'');
313 foreach ($description->keys
as $key=>$subdesc) {
314 if (!array_key_exists($key, $params)) {
315 if ($subdesc->required
== VALUE_REQUIRED
) {
316 throw new invalid_parameter_exception('Missing required key in single structure: '. $key);
318 if ($subdesc->required
== VALUE_DEFAULT
) {
320 $result[$key] = static::validate_parameters($subdesc, $subdesc->default);
321 } catch (invalid_parameter_exception
$e) {
322 //we are only interested by exceptions returned by validate_param() and validate_parameters()
323 //(in order to build the path to the faulty attribut)
324 throw new invalid_parameter_exception($key." => ".$e->getMessage() . ': ' .$e->debuginfo
);
329 $result[$key] = static::validate_parameters($subdesc, $params[$key]);
330 } catch (invalid_parameter_exception
$e) {
331 //we are only interested by exceptions returned by validate_param() and validate_parameters()
332 //(in order to build the path to the faulty attribut)
333 throw new invalid_parameter_exception($key." => ".$e->getMessage() . ': ' .$e->debuginfo
);
336 unset($params[$key]);
338 if (!empty($params)) {
339 throw new invalid_parameter_exception('Unexpected keys (' . implode(', ', array_keys($params)) . ') detected in parameter array.');
343 } else if ($description instanceof external_multiple_structure
) {
344 if (!is_array($params)) {
345 throw new invalid_parameter_exception('Only arrays accepted. The bad value is: \''
346 . print_r($params, true) . '\'');
349 foreach ($params as $param) {
350 $result[] = static::validate_parameters($description->content
, $param);
355 throw new invalid_parameter_exception('Invalid external api description');
361 * If a response attribute is unknown from the description, we just ignore the attribute.
362 * If a response attribute is incorrect, invalid_response_exception is thrown.
363 * Note: this function is similar to validate parameters, however it is distinct because
364 * parameters validation must be distinct from cleaning return values.
366 * @param external_description $description description of the return values
367 * @param mixed $response the actual response
368 * @return mixed response with added defaults for optional items, invalid_response_exception thrown if any problem found
369 * @author 2010 Jerome Mouneyrac
372 public static function clean_returnvalue(external_description
$description, $response) {
373 if ($description instanceof external_value
) {
374 if (is_array($response) or is_object($response)) {
375 throw new invalid_response_exception('Scalar type expected, array or object received.');
378 if ($description->type
== PARAM_BOOL
) {
379 // special case for PARAM_BOOL - we want true/false instead of the usual 1/0 - we can not be too strict here ;-)
380 if (is_bool($response) or $response === 0 or $response === 1 or $response === '0' or $response === '1') {
381 return (bool)$response;
384 $debuginfo = 'Invalid external api response: the value is "' . $response .
385 '", the server was expecting "' . $description->type
. '" type';
387 return validate_param($response, $description->type
, $description->allownull
, $debuginfo);
388 } catch (invalid_parameter_exception
$e) {
389 //proper exception name, to be recursively catched to build the path to the faulty attribut
390 throw new invalid_response_exception($e->debuginfo
);
393 } else if ($description instanceof external_single_structure
) {
394 if (!is_array($response) && !is_object($response)) {
395 throw new invalid_response_exception('Only arrays/objects accepted. The bad value is: \'' .
396 print_r($response, true) . '\'');
399 // Cast objects into arrays.
400 if (is_object($response)) {
401 $response = (array) $response;
405 foreach ($description->keys
as $key=>$subdesc) {
406 if (!array_key_exists($key, $response)) {
407 if ($subdesc->required
== VALUE_REQUIRED
) {
408 throw new invalid_response_exception('Error in response - Missing following required key in a single structure: ' . $key);
410 if ($subdesc instanceof external_value
) {
411 if ($subdesc->required
== VALUE_DEFAULT
) {
413 $result[$key] = static::clean_returnvalue($subdesc, $subdesc->default);
414 } catch (invalid_response_exception
$e) {
415 //build the path to the faulty attribut
416 throw new invalid_response_exception($key." => ".$e->getMessage() . ': ' . $e->debuginfo
);
422 $result[$key] = static::clean_returnvalue($subdesc, $response[$key]);
423 } catch (invalid_response_exception
$e) {
424 //build the path to the faulty attribut
425 throw new invalid_response_exception($key." => ".$e->getMessage() . ': ' . $e->debuginfo
);
428 unset($response[$key]);
433 } else if ($description instanceof external_multiple_structure
) {
434 if (!is_array($response)) {
435 throw new invalid_response_exception('Only arrays accepted. The bad value is: \'' .
436 print_r($response, true) . '\'');
439 foreach ($response as $param) {
440 $result[] = static::clean_returnvalue($description->content
, $param);
445 throw new invalid_response_exception('Invalid external api response description');
450 * Makes sure user may execute functions in this context.
452 * @param stdClass $context
455 public static function validate_context($context) {
458 if (empty($context)) {
459 throw new invalid_parameter_exception('Context does not exist');
461 if (empty(self
::$contextrestriction)) {
462 self
::$contextrestriction = context_system
::instance();
464 $rcontext = self
::$contextrestriction;
466 if ($rcontext->contextlevel
== $context->contextlevel
) {
467 if ($rcontext->id
!= $context->id
) {
468 throw new restricted_context_exception();
470 } else if ($rcontext->contextlevel
> $context->contextlevel
) {
471 throw new restricted_context_exception();
473 $parents = $context->get_parent_context_ids();
474 if (!in_array($rcontext->id
, $parents)) {
475 throw new restricted_context_exception();
479 $PAGE->reset_theme_and_output();
480 list($unused, $course, $cm) = get_context_info_array($context->id
);
481 require_login($course, false, $cm, false, true);
482 $PAGE->set_context($context);
486 * Get context from passed parameters.
487 * The passed array must either contain a contextid or a combination of context level and instance id to fetch the context.
488 * For example, the context level can be "course" and instanceid can be courseid.
490 * See context_helper::get_all_levels() for a list of valid context levels.
492 * @param array $param
494 * @throws invalid_parameter_exception
497 protected static function get_context_from_params($param) {
498 $levels = context_helper
::get_all_levels();
499 if (!empty($param['contextid'])) {
500 return context
::instance_by_id($param['contextid'], IGNORE_MISSING
);
501 } else if (!empty($param['contextlevel']) && isset($param['instanceid'])) {
502 $contextlevel = "context_".$param['contextlevel'];
503 if (!array_search($contextlevel, $levels)) {
504 throw new invalid_parameter_exception('Invalid context level = '.$param['contextlevel']);
506 return $contextlevel::instance($param['instanceid'], IGNORE_MISSING
);
508 // No valid context info was found.
509 throw new invalid_parameter_exception('Missing parameters, please provide either context level with instance id or contextid');
515 * Common ancestor of all parameter description classes
517 * @package core_webservice
518 * @copyright 2009 Petr Skodak
519 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
522 abstract class external_description
{
523 /** @var string Description of element */
526 /** @var bool Element value required, null not allowed */
529 /** @var mixed Default value */
535 * @param string $desc
536 * @param bool $required
537 * @param mixed $default
540 public function __construct($desc, $required, $default) {
542 $this->required
= $required;
543 $this->default = $default;
548 * Scalar value description class
550 * @package core_webservice
551 * @copyright 2009 Petr Skodak
552 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
555 class external_value
extends external_description
{
557 /** @var mixed Value type PARAM_XX */
560 /** @var bool Allow null values */
567 * @param string $desc
568 * @param bool $required
569 * @param mixed $default
570 * @param bool $allownull
573 public function __construct($type, $desc='', $required=VALUE_REQUIRED
,
574 $default=null, $allownull=NULL_ALLOWED
) {
575 parent
::__construct($desc, $required, $default);
577 $this->allownull
= $allownull;
582 * Associative array description class
584 * @package core_webservice
585 * @copyright 2009 Petr Skodak
586 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
589 class external_single_structure
extends external_description
{
591 /** @var array Description of array keys key=>external_description */
598 * @param string $desc
599 * @param bool $required
600 * @param array $default
603 public function __construct(array $keys, $desc='',
604 $required=VALUE_REQUIRED
, $default=null) {
605 parent
::__construct($desc, $required, $default);
611 * Bulk array description class.
613 * @package core_webservice
614 * @copyright 2009 Petr Skodak
615 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
618 class external_multiple_structure
extends external_description
{
620 /** @var external_description content */
626 * @param external_description $content
627 * @param string $desc
628 * @param bool $required
629 * @param array $default
632 public function __construct(external_description
$content, $desc='',
633 $required=VALUE_REQUIRED
, $default=null) {
634 parent
::__construct($desc, $required, $default);
635 $this->content
= $content;
640 * Description of top level - PHP function parameters.
642 * @package core_webservice
643 * @copyright 2009 Petr Skodak
644 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
647 class external_function_parameters
extends external_single_structure
{
650 * Constructor - does extra checking to prevent top level optional parameters.
653 * @param string $desc
654 * @param bool $required
655 * @param array $default
657 public function __construct(array $keys, $desc='', $required=VALUE_REQUIRED
, $default=null) {
660 if ($CFG->debugdeveloper
) {
661 foreach ($keys as $key => $value) {
662 if ($value instanceof external_value
) {
663 if ($value->required
== VALUE_OPTIONAL
) {
664 debugging('External function parameters: invalid OPTIONAL value specified.', DEBUG_DEVELOPER
);
670 parent
::__construct($keys, $desc, $required, $default);
677 * @param string $tokentype EXTERNAL_TOKEN_EMBEDDED|EXTERNAL_TOKEN_PERMANENT
678 * @param stdClass|int $serviceorid service linked to the token
679 * @param int $userid user linked to the token
680 * @param stdClass|int $contextorid
681 * @param int $validuntil date when the token expired
682 * @param string $iprestriction allowed ip - if 0 or empty then all ips are allowed
683 * @return string generated token
684 * @author 2010 Jamie Pratt
687 function external_generate_token($tokentype, $serviceorid, $userid, $contextorid, $validuntil=0, $iprestriction=''){
689 // make sure the token doesn't exist (even if it should be almost impossible with the random generation)
693 $generatedtoken = md5(uniqid(rand(),1));
695 throw new moodle_exception('tokengenerationfailed');
697 } while ($DB->record_exists('external_tokens', array('token'=>$generatedtoken)));
698 $newtoken = new stdClass();
699 $newtoken->token
= $generatedtoken;
700 if (!is_object($serviceorid)){
701 $service = $DB->get_record('external_services', array('id' => $serviceorid));
703 $service = $serviceorid;
705 if (!is_object($contextorid)){
706 $context = context
::instance_by_id($contextorid, MUST_EXIST
);
708 $context = $contextorid;
710 if (empty($service->requiredcapability
) ||
has_capability($service->requiredcapability
, $context, $userid)) {
711 $newtoken->externalserviceid
= $service->id
;
713 throw new moodle_exception('nocapabilitytousethisservice');
715 $newtoken->tokentype
= $tokentype;
716 $newtoken->userid
= $userid;
717 if ($tokentype == EXTERNAL_TOKEN_EMBEDDED
){
718 $newtoken->sid
= session_id();
721 $newtoken->contextid
= $context->id
;
722 $newtoken->creatorid
= $USER->id
;
723 $newtoken->timecreated
= time();
724 $newtoken->validuntil
= $validuntil;
725 if (!empty($iprestriction)) {
726 $newtoken->iprestriction
= $iprestriction;
728 $newtoken->privatetoken
= null;
729 $DB->insert_record('external_tokens', $newtoken);
730 return $newtoken->token
;
734 * Create and return a session linked token. Token to be used for html embedded client apps that want to communicate
735 * with the Moodle server through web services. The token is linked to the current session for the current page request.
736 * It is expected this will be called in the script generating the html page that is embedding the client app and that the
737 * returned token will be somehow passed into the client app being embedded in the page.
739 * @param string $servicename name of the web service. Service name as defined in db/services.php
740 * @param int $context context within which the web service can operate.
741 * @return int returns token id.
744 function external_create_service_token($servicename, $context){
746 $service = $DB->get_record('external_services', array('name'=>$servicename), '*', MUST_EXIST
);
747 return external_generate_token(EXTERNAL_TOKEN_EMBEDDED
, $service, $USER->id
, $context, 0);
751 * Delete all pre-built services (+ related tokens) and external functions information defined in the specified component.
753 * @param string $component name of component (moodle, mod_assignment, etc.)
755 function external_delete_descriptions($component) {
758 $params = array($component);
760 $DB->delete_records_select('external_tokens',
761 "externalserviceid IN (SELECT id FROM {external_services} WHERE component = ?)", $params);
762 $DB->delete_records_select('external_services_users',
763 "externalserviceid IN (SELECT id FROM {external_services} WHERE component = ?)", $params);
764 $DB->delete_records_select('external_services_functions',
765 "functionname IN (SELECT name FROM {external_functions} WHERE component = ?)", $params);
766 $DB->delete_records('external_services', array('component'=>$component));
767 $DB->delete_records('external_functions', array('component'=>$component));
771 * Standard Moodle web service warnings
773 * @package core_webservice
774 * @copyright 2012 Jerome Mouneyrac
775 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
778 class external_warnings
extends external_multiple_structure
{
785 public function __construct($itemdesc = 'item', $itemiddesc = 'item id',
786 $warningcodedesc = 'the warning code can be used by the client app to implement specific behaviour') {
789 new external_single_structure(
791 'item' => new external_value(PARAM_TEXT
, $itemdesc, VALUE_OPTIONAL
),
792 'itemid' => new external_value(PARAM_INT
, $itemiddesc, VALUE_OPTIONAL
),
793 'warningcode' => new external_value(PARAM_ALPHANUM
, $warningcodedesc),
794 'message' => new external_value(PARAM_TEXT
,
795 'untranslated english message to explain the warning')
797 'list of warnings', VALUE_OPTIONAL
);
802 * A pre-filled external_value class for text format.
804 * Default is FORMAT_HTML
805 * This should be used all the time in external xxx_params()/xxx_returns functions
806 * as it is the standard way to implement text format param/return values.
808 * @package core_webservice
809 * @copyright 2012 Jerome Mouneyrac
810 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
813 class external_format_value
extends external_value
{
818 * @param string $textfieldname Name of the text field
819 * @param int $required if VALUE_REQUIRED then set standard default FORMAT_HTML
820 * @param int $default Default value.
823 public function __construct($textfieldname, $required = VALUE_REQUIRED
, $default = null) {
825 if ($default == null && $required == VALUE_DEFAULT
) {
826 $default = FORMAT_HTML
;
829 $desc = $textfieldname . ' format (' . FORMAT_HTML
. ' = HTML, '
830 . FORMAT_MOODLE
. ' = MOODLE, '
831 . FORMAT_PLAIN
. ' = PLAIN or '
832 . FORMAT_MARKDOWN
. ' = MARKDOWN)';
834 parent
::__construct(PARAM_INT
, $desc, $required, $default);
839 * Validate text field format against known FORMAT_XXX
841 * @param array $format the format to validate
842 * @return the validated format
843 * @throws coding_exception
846 function external_validate_format($format) {
847 $allowedformats = array(FORMAT_HTML
, FORMAT_MOODLE
, FORMAT_PLAIN
, FORMAT_MARKDOWN
);
848 if (!in_array($format, $allowedformats)) {
849 throw new moodle_exception('formatnotsupported', 'webservice', '' , null,
850 'The format with value=' . $format . ' is not supported by this Moodle site');
856 * Format the string to be returned properly as requested by the either the web service server,
857 * either by an internally call.
858 * The caller can change the format (raw) with the external_settings singleton
859 * All web service servers must set this singleton when parsing the $_GET and $_POST.
862 * Options are the same that in {@link format_string()} with some changes:
863 * filter : Can be set to false to force filters off, else observes {@link external_settings}.
866 * @param string $str The string to be filtered. Should be plain text, expect
867 * possibly for multilang tags.
868 * @param boolean $striplinks To strip any link in the result text. Moodle 1.8 default changed from false to true! MDL-8713
869 * @param int $contextid The id of the context for the string (affects filters).
870 * @param array $options options array/object or courseid
871 * @return string text
874 function external_format_string($str, $contextid, $striplinks = true, $options = array()) {
876 // Get settings (singleton).
877 $settings = external_settings
::get_instance();
878 if (empty($contextid)) {
879 throw new coding_exception('contextid is required');
882 if (!$settings->get_raw()) {
883 $context = context
::instance_by_id($contextid);
884 $options['context'] = $context;
885 $options['filter'] = isset($options['filter']) && !$options['filter'] ?
false : $settings->get_filter();
886 $str = format_string($str, $striplinks, $options);
893 * Format the text to be returned properly as requested by the either the web service server,
894 * either by an internally call.
895 * The caller can change the format (raw, filter, file, fileurl) with the external_settings singleton
896 * All web service servers must set this singleton when parsing the $_GET and $_POST.
899 * Options are the same that in {@link format_text()} with some changes in defaults to provide backwards compatibility:
900 * trusted : If true the string won't be cleaned. Default false.
901 * noclean : If true the string won't be cleaned only if trusted is also true. Default false.
902 * nocache : If true the string will not be cached and will be formatted every call. Default false.
903 * filter : Can be set to false to force filters off, else observes {@link external_settings}.
904 * para : If true then the returned string will be wrapped in div tags. Default (different from format_text) false.
905 * Default changed because div tags are not commonly needed.
906 * newlines : If true then lines newline breaks will be converted to HTML newline breaks. Default true.
907 * context : Not used! Using contextid parameter instead.
908 * overflowdiv : If set to true the formatted text will be encased in a div with the class no-overflow before being
909 * returned. Default false.
910 * allowid : If true then id attributes will not be removed, even when using htmlpurifier. Default (different from
911 * format_text) true. Default changed id attributes are commonly needed.
912 * blanktarget : If true all <a> tags will have target="_blank" added unless target is explicitly specified.
915 * @param string $text The content that may contain ULRs in need of rewriting.
916 * @param int $textformat The text format.
917 * @param int $contextid This parameter and the next two identify the file area to use.
918 * @param string $component
919 * @param string $filearea helps identify the file area.
920 * @param int $itemid helps identify the file area.
921 * @param object/array $options text formatting options
922 * @return array text + textformat
924 * @since Moodle 3.2 component, filearea and itemid are optional parameters
926 function external_format_text($text, $textformat, $contextid, $component = null, $filearea = null, $itemid = null,
930 // Get settings (singleton).
931 $settings = external_settings
::get_instance();
933 if ($component and $filearea and $settings->get_fileurl()) {
934 require_once($CFG->libdir
. "/filelib.php");
935 $text = file_rewrite_pluginfile_urls($text, $settings->get_file(), $contextid, $component, $filearea, $itemid);
938 if (!$settings->get_raw()) {
939 $options = (array)$options;
941 // If context is passed in options, check that is the same to show a debug message.
942 if (isset($options['context'])) {
943 if ((is_object($options['context']) && $options['context']->id
!= $contextid)
944 ||
(!is_object($options['context']) && $options['context'] != $contextid)) {
945 debugging('Different contexts found in external_format_text parameters. $options[\'context\'] not allowed.
946 Using $contextid parameter...', DEBUG_DEVELOPER
);
950 $options['filter'] = isset($options['filter']) && !$options['filter'] ?
false : $settings->get_filter();
951 $options['para'] = isset($options['para']) ?
$options['para'] : false;
952 $options['context'] = context
::instance_by_id($contextid);
953 $options['allowid'] = isset($options['allowid']) ?
$options['allowid'] : true;
955 $text = format_text($text, $textformat, $options);
956 $textformat = FORMAT_HTML
; // Once converted to html (from markdown, plain... lets inform consumer this is already HTML).
959 return array($text, $textformat);
963 * Generate or return an existing token for the current authenticated user.
964 * This function is used for creating a valid token for users authenticathing via login/token.php or admin/tool/mobile/launch.php.
966 * @param stdClass $service external service object
967 * @return stdClass token object
969 * @throws moodle_exception
971 function external_generate_token_for_current_user($service) {
974 core_user
::require_active_user($USER, true, true);
976 // Check if there is any required system capability.
977 if ($service->requiredcapability
and !has_capability($service->requiredcapability
, context_system
::instance())) {
978 throw new moodle_exception('missingrequiredcapability', 'webservice', '', $service->requiredcapability
);
981 // Specific checks related to user restricted service.
982 if ($service->restrictedusers
) {
983 $authoriseduser = $DB->get_record('external_services_users',
984 array('externalserviceid' => $service->id
, 'userid' => $USER->id
));
986 if (empty($authoriseduser)) {
987 throw new moodle_exception('usernotallowed', 'webservice', '', $service->shortname
);
990 if (!empty($authoriseduser->validuntil
) and $authoriseduser->validuntil
< time()) {
991 throw new moodle_exception('invalidtimedtoken', 'webservice');
994 if (!empty($authoriseduser->iprestriction
) and !address_in_subnet(getremoteaddr(), $authoriseduser->iprestriction
)) {
995 throw new moodle_exception('invalidiptoken', 'webservice');
999 // Check if a token has already been created for this user and this service.
1000 $conditions = array(
1001 'userid' => $USER->id
,
1002 'externalserviceid' => $service->id
,
1003 'tokentype' => EXTERNAL_TOKEN_PERMANENT
1005 $tokens = $DB->get_records('external_tokens', $conditions, 'timecreated ASC');
1007 // A bit of sanity checks.
1008 foreach ($tokens as $key => $token) {
1010 // Checks related to a specific token. (script execution continue).
1011 $unsettoken = false;
1012 // If sid is set then there must be a valid associated session no matter the token type.
1013 if (!empty($token->sid
)) {
1014 if (!\core\session\manager
::session_exists($token->sid
)) {
1015 // This token will never be valid anymore, delete it.
1016 $DB->delete_records('external_tokens', array('sid' => $token->sid
));
1021 // Remove token is not valid anymore.
1022 if (!empty($token->validuntil
) and $token->validuntil
< time()) {
1023 $DB->delete_records('external_tokens', array('token' => $token->token
, 'tokentype' => EXTERNAL_TOKEN_PERMANENT
));
1027 // Remove token if its ip not in whitelist.
1028 if (isset($token->iprestriction
) and !address_in_subnet(getremoteaddr(), $token->iprestriction
)) {
1033 unset($tokens[$key]);
1037 // If some valid tokens exist then use the most recent.
1038 if (count($tokens) > 0) {
1039 $token = array_pop($tokens);
1041 $context = context_system
::instance();
1042 $isofficialservice = $service->shortname
== MOODLE_OFFICIAL_MOBILE_SERVICE
;
1044 if (($isofficialservice and has_capability('moodle/webservice:createmobiletoken', $context)) or
1045 (!is_siteadmin($USER) && has_capability('moodle/webservice:createtoken', $context))) {
1047 // Create a new token.
1048 $token = new stdClass
;
1049 $token->token
= md5(uniqid(rand(), 1));
1050 $token->userid
= $USER->id
;
1051 $token->tokentype
= EXTERNAL_TOKEN_PERMANENT
;
1052 $token->contextid
= context_system
::instance()->id
;
1053 $token->creatorid
= $USER->id
;
1054 $token->timecreated
= time();
1055 $token->externalserviceid
= $service->id
;
1056 // MDL-43119 Token valid for 3 months (12 weeks).
1057 $token->validuntil
= $token->timecreated +
12 * WEEKSECS
;
1058 $token->iprestriction
= null;
1060 $token->lastaccess
= null;
1061 // Generate the private token, it must be transmitted only via https.
1062 $token->privatetoken
= random_string(64);
1063 $token->id
= $DB->insert_record('external_tokens', $token);
1065 $eventtoken = clone $token;
1066 $eventtoken->privatetoken
= null;
1068 'objectid' => $eventtoken->id
,
1069 'relateduserid' => $USER->id
,
1074 $event = \core\event\webservice_token_created
::create($params);
1075 $event->add_record_snapshot('external_tokens', $eventtoken);
1078 throw new moodle_exception('cannotcreatetoken', 'webservice', '', $service->shortname
);
1085 * Set the last time a token was sent and trigger the \core\event\webservice_token_sent event.
1087 * This function is used when a token is generated by the user via login/token.php or admin/tool/mobile/launch.php.
1088 * In order to protect the privatetoken, we remove it from the event params.
1090 * @param stdClass $token token object
1093 function external_log_token_request($token) {
1096 $token->privatetoken
= null;
1098 // Log token access.
1099 $DB->set_field('external_tokens', 'lastaccess', time(), array('id' => $token->id
));
1102 'objectid' => $token->id
,
1104 $event = \core\event\webservice_token_sent
::create($params);
1105 $event->add_record_snapshot('external_tokens', $token);
1110 * Singleton to handle the external settings.
1112 * We use singleton to encapsulate the "logic"
1114 * @package core_webservice
1115 * @copyright 2012 Jerome Mouneyrac
1116 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1119 class external_settings
{
1121 /** @var object the singleton instance */
1122 public static $instance = null;
1124 /** @var boolean Should the external function return raw text or formatted */
1125 private $raw = false;
1127 /** @var boolean Should the external function filter the text */
1128 private $filter = false;
1130 /** @var boolean Should the external function rewrite plugin file url */
1131 private $fileurl = true;
1133 /** @var string In which file should the urls be rewritten */
1134 private $file = 'webservice/pluginfile.php';
1137 * Constructor - protected - can not be instanciated
1139 protected function __construct() {
1140 if (!defined('AJAX_SCRIPT') && !defined('CLI_SCRIPT') && !defined('WS_SERVER')) {
1141 // For normal pages, the default should match the default for format_text.
1142 $this->filter
= true;
1147 * Clone - private - can not be cloned
1149 private final function __clone() {
1153 * Return only one instance
1157 public static function get_instance() {
1158 if (self
::$instance === null) {
1159 self
::$instance = new external_settings
;
1162 return self
::$instance;
1168 * @param boolean $raw
1170 public function set_raw($raw) {
1179 public function get_raw() {
1186 * @param boolean $filter
1188 public function set_filter($filter) {
1189 $this->filter
= $filter;
1197 public function get_filter() {
1198 return $this->filter
;
1204 * @param boolean $fileurl
1206 public function set_fileurl($fileurl) {
1207 $this->fileurl
= $fileurl;
1215 public function get_fileurl() {
1216 return $this->fileurl
;
1222 * @param string $file
1224 public function set_file($file) {
1225 $this->file
= $file;
1233 public function get_file() {
1239 * Utility functions for the external API.
1241 * @package core_webservice
1242 * @copyright 2015 Juan Leyva
1243 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1246 class external_util
{
1249 * Validate a list of courses, returning the complete course objects for valid courses.
1251 * @param array $courseids A list of course ids
1252 * @param array $courses An array of courses already pre-fetched, indexed by course id.
1253 * @param bool $addcontext True if the returned course object should include the full context object.
1254 * @return array An array of courses and the validation warnings
1256 public static function validate_courses($courseids, $courses = array(), $addcontext = false) {
1257 // Delete duplicates.
1258 $courseids = array_unique($courseids);
1259 $warnings = array();
1261 // Remove courses which are not even requested.
1262 $courses = array_intersect_key($courses, array_flip($courseids));
1264 foreach ($courseids as $cid) {
1265 // Check the user can function in this context.
1267 $context = context_course
::instance($cid);
1268 external_api
::validate_context($context);
1270 if (!isset($courses[$cid])) {
1271 $courses[$cid] = get_course($cid);
1274 $courses[$cid]->context
= $context;
1276 } catch (Exception
$e) {
1277 unset($courses[$cid]);
1278 $warnings[] = array(
1281 'warningcode' => '1',
1282 'message' => 'No access rights in course context'
1287 return array($courses, $warnings);
1291 * Returns all area files (optionally limited by itemid).
1293 * @param int $contextid context ID
1294 * @param string $component component
1295 * @param string $filearea file area
1296 * @param int $itemid item ID or all files if not specified
1297 * @param bool $useitemidinurl wether to use the item id in the file URL (modules intro don't use it)
1298 * @return array of files, compatible with the external_files structure.
1301 public static function get_area_files($contextid, $component, $filearea, $itemid = false, $useitemidinurl = true) {
1303 $fs = get_file_storage();
1305 if ($areafiles = $fs->get_area_files($contextid, $component, $filearea, $itemid, 'itemid, filepath, filename', false)) {
1306 foreach ($areafiles as $areafile) {
1308 $file['filename'] = $areafile->get_filename();
1309 $file['filepath'] = $areafile->get_filepath();
1310 $file['mimetype'] = $areafile->get_mimetype();
1311 $file['filesize'] = $areafile->get_filesize();
1312 $file['timemodified'] = $areafile->get_timemodified();
1313 $fileitemid = $useitemidinurl ?
$areafile->get_itemid() : null;
1314 $file['fileurl'] = moodle_url
::make_webservice_pluginfile_url($contextid, $component, $filearea,
1315 $fileitemid, $areafile->get_filepath(), $areafile->get_filename())->out(false);
1324 * External structure representing a set of files.
1326 * @package core_webservice
1327 * @copyright 2016 Juan Leyva
1328 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1331 class external_files
extends external_multiple_structure
{
1335 * @param string $desc Description for the multiple structure.
1336 * @param int $required The type of value (VALUE_REQUIRED OR VALUE_OPTIONAL).
1338 public function __construct($desc = 'List of files.', $required = VALUE_REQUIRED
) {
1340 parent
::__construct(
1341 new external_single_structure(
1343 'filename' => new external_value(PARAM_FILE
, 'File name.', VALUE_OPTIONAL
),
1344 'filepath' => new external_value(PARAM_PATH
, 'File path.', VALUE_OPTIONAL
),
1345 'filesize' => new external_value(PARAM_INT
, 'File size.', VALUE_OPTIONAL
),
1346 'fileurl' => new external_value(PARAM_URL
, 'Downloadable file url.', VALUE_OPTIONAL
),
1347 'timemodified' => new external_value(PARAM_INT
, 'Time modified.', VALUE_OPTIONAL
),
1348 'mimetype' => new external_value(PARAM_RAW
, 'File mime type.', VALUE_OPTIONAL
),