MDL-50782 Ajax: No require_login for all ajax webservice calls
[moodle.git] / lib / externallib.php
1 <?php
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/>.
18 /**
19  * Support for external API
20  *
21  * @package    core_webservice
22  * @copyright  2009 Petr Skodak
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
28 /**
29  * Returns detailed function information
30  *
31  * @param string|object $function name of external function or record from external_function
32  * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
33  *                        MUST_EXIST means throw exception if no record or multiple records found
34  * @return stdClass description or false if not found or exception thrown
35  * @since Moodle 2.0
36  */
37 function external_function_info($function, $strictness=MUST_EXIST) {
38     global $DB, $CFG;
40     if (!is_object($function)) {
41         if (!$function = $DB->get_record('external_functions', array('name'=>$function), '*', $strictness)) {
42             return false;
43         }
44     }
46     // First try class autoloading.
47     if (!class_exists($function->classname)) {
48         // Fallback to explicit include of externallib.php.
49         $function->classpath = empty($function->classpath) ? core_component::get_component_directory($function->component).'/externallib.php' : $CFG->dirroot.'/'.$function->classpath;
50         if (!file_exists($function->classpath)) {
51             throw new coding_exception('Cannot find file with external function implementation');
52         }
53         require_once($function->classpath);
54         if (!class_exists($function->classname)) {
55             throw new coding_exception('Cannot find external class');
56         }
57     }
59     $function->ajax_method = $function->methodname.'_is_allowed_from_ajax';
60     $function->parameters_method = $function->methodname.'_parameters';
61     $function->returns_method    = $function->methodname.'_returns';
62     $function->deprecated_method = $function->methodname.'_is_deprecated';
64     // make sure the implementaion class is ok
65     if (!method_exists($function->classname, $function->methodname)) {
66         throw new coding_exception('Missing implementation method of '.$function->classname.'::'.$function->methodname);
67     }
68     if (!method_exists($function->classname, $function->parameters_method)) {
69         throw new coding_exception('Missing parameters description');
70     }
71     if (!method_exists($function->classname, $function->returns_method)) {
72         throw new coding_exception('Missing returned values description');
73     }
74     if (method_exists($function->classname, $function->deprecated_method)) {
75         if (call_user_func(array($function->classname, $function->deprecated_method)) === true) {
76             $function->deprecated = true;
77         }
78     }
79     $function->allowed_from_ajax = false;
80     if (method_exists($function->classname, $function->ajax_method)) {
81         if (call_user_func(array($function->classname, $function->ajax_method)) === true) {
82             $function->allowed_from_ajax = true;
83         }
84     }
86     // fetch the parameters description
87     $function->parameters_desc = call_user_func(array($function->classname, $function->parameters_method));
88     if (!($function->parameters_desc instanceof external_function_parameters)) {
89         throw new coding_exception('Invalid parameters description');
90     }
92     // fetch the return values description
93     $function->returns_desc = call_user_func(array($function->classname, $function->returns_method));
94     // null means void result or result is ignored
95     if (!is_null($function->returns_desc) and !($function->returns_desc instanceof external_description)) {
96         throw new coding_exception('Invalid return description');
97     }
99     //now get the function description
100     //TODO MDL-31115 use localised lang pack descriptions, it would be nice to have
101     //      easy to understand descriptions in admin UI,
102     //      on the other hand this is still a bit in a flux and we need to find some new naming
103     //      conventions for these descriptions in lang packs
104     $function->description = null;
105     $servicesfile = core_component::get_component_directory($function->component).'/db/services.php';
106     if (file_exists($servicesfile)) {
107         $functions = null;
108         include($servicesfile);
109         if (isset($functions[$function->name]['description'])) {
110             $function->description = $functions[$function->name]['description'];
111         }
112         if (isset($functions[$function->name]['testclientpath'])) {
113             $function->testclientpath = $functions[$function->name]['testclientpath'];
114         }
115         if (isset($functions[$function->name]['type'])) {
116             $function->type = $functions[$function->name]['type'];
117         }
118         if (isset($functions[$function->name]['loginrequired'])) {
119             $function->loginrequired = $functions[$function->name]['loginrequired'];
120         } else {
121             $function->loginrequired = true;
122         }
123     }
125     return $function;
128 /**
129  * Exception indicating user is not allowed to use external function in the current context.
130  *
131  * @package    core_webservice
132  * @copyright  2009 Petr Skodak
133  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
134  * @since Moodle 2.0
135  */
136 class restricted_context_exception extends moodle_exception {
137     /**
138      * Constructor
139      *
140      * @since Moodle 2.0
141      */
142     function __construct() {
143         parent::__construct('restrictedcontextexception', 'error');
144     }
147 /**
148  * Base class for external api methods.
149  *
150  * @package    core_webservice
151  * @copyright  2009 Petr Skodak
152  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
153  * @since Moodle 2.0
154  */
155 class external_api {
157     /** @var stdClass context where the function calls will be restricted */
158     private static $contextrestriction;
160     /**
161      * Set context restriction for all following subsequent function calls.
162      *
163      * @param stdClass $context the context restriction
164      * @since Moodle 2.0
165      */
166     public static function set_context_restriction($context) {
167         self::$contextrestriction = $context;
168     }
170     /**
171      * This method has to be called before every operation
172      * that takes a longer time to finish!
173      *
174      * @param int $seconds max expected time the next operation needs
175      * @since Moodle 2.0
176      */
177     public static function set_timeout($seconds=360) {
178         $seconds = ($seconds < 300) ? 300 : $seconds;
179         core_php_time_limit::raise($seconds);
180     }
182     /**
183      * Validates submitted function parameters, if anything is incorrect
184      * invalid_parameter_exception is thrown.
185      * This is a simple recursive method which is intended to be called from
186      * each implementation method of external API.
187      *
188      * @param external_description $description description of parameters
189      * @param mixed $params the actual parameters
190      * @return mixed params with added defaults for optional items, invalid_parameters_exception thrown if any problem found
191      * @since Moodle 2.0
192      */
193     public static function validate_parameters(external_description $description, $params) {
194         if ($description instanceof external_value) {
195             if (is_array($params) or is_object($params)) {
196                 throw new invalid_parameter_exception('Scalar type expected, array or object received.');
197             }
199             if ($description->type == PARAM_BOOL) {
200                 // special case for PARAM_BOOL - we want true/false instead of the usual 1/0 - we can not be too strict here ;-)
201                 if (is_bool($params) or $params === 0 or $params === 1 or $params === '0' or $params === '1') {
202                     return (bool)$params;
203                 }
204             }
205             $debuginfo = 'Invalid external api parameter: the value is "' . $params .
206                     '", the server was expecting "' . $description->type . '" type';
207             return validate_param($params, $description->type, $description->allownull, $debuginfo);
209         } else if ($description instanceof external_single_structure) {
210             if (!is_array($params)) {
211                 throw new invalid_parameter_exception('Only arrays accepted. The bad value is: \''
212                         . print_r($params, true) . '\'');
213             }
214             $result = array();
215             foreach ($description->keys as $key=>$subdesc) {
216                 if (!array_key_exists($key, $params)) {
217                     if ($subdesc->required == VALUE_REQUIRED) {
218                         throw new invalid_parameter_exception('Missing required key in single structure: '. $key);
219                     }
220                     if ($subdesc->required == VALUE_DEFAULT) {
221                         try {
222                             $result[$key] = self::validate_parameters($subdesc, $subdesc->default);
223                         } catch (invalid_parameter_exception $e) {
224                             //we are only interested by exceptions returned by validate_param() and validate_parameters()
225                             //(in order to build the path to the faulty attribut)
226                             throw new invalid_parameter_exception($key." => ".$e->getMessage() . ': ' .$e->debuginfo);
227                         }
228                     }
229                 } else {
230                     try {
231                         $result[$key] = self::validate_parameters($subdesc, $params[$key]);
232                     } catch (invalid_parameter_exception $e) {
233                         //we are only interested by exceptions returned by validate_param() and validate_parameters()
234                         //(in order to build the path to the faulty attribut)
235                         throw new invalid_parameter_exception($key." => ".$e->getMessage() . ': ' .$e->debuginfo);
236                     }
237                 }
238                 unset($params[$key]);
239             }
240             if (!empty($params)) {
241                 throw new invalid_parameter_exception('Unexpected keys (' . implode(', ', array_keys($params)) . ') detected in parameter array.');
242             }
243             return $result;
245         } else if ($description instanceof external_multiple_structure) {
246             if (!is_array($params)) {
247                 throw new invalid_parameter_exception('Only arrays accepted. The bad value is: \''
248                         . print_r($params, true) . '\'');
249             }
250             $result = array();
251             foreach ($params as $param) {
252                 $result[] = self::validate_parameters($description->content, $param);
253             }
254             return $result;
256         } else {
257             throw new invalid_parameter_exception('Invalid external api description');
258         }
259     }
261     /**
262      * Clean response
263      * If a response attribute is unknown from the description, we just ignore the attribute.
264      * If a response attribute is incorrect, invalid_response_exception is thrown.
265      * Note: this function is similar to validate parameters, however it is distinct because
266      * parameters validation must be distinct from cleaning return values.
267      *
268      * @param external_description $description description of the return values
269      * @param mixed $response the actual response
270      * @return mixed response with added defaults for optional items, invalid_response_exception thrown if any problem found
271      * @author 2010 Jerome Mouneyrac
272      * @since Moodle 2.0
273      */
274     public static function clean_returnvalue(external_description $description, $response) {
275         if ($description instanceof external_value) {
276             if (is_array($response) or is_object($response)) {
277                 throw new invalid_response_exception('Scalar type expected, array or object received.');
278             }
280             if ($description->type == PARAM_BOOL) {
281                 // special case for PARAM_BOOL - we want true/false instead of the usual 1/0 - we can not be too strict here ;-)
282                 if (is_bool($response) or $response === 0 or $response === 1 or $response === '0' or $response === '1') {
283                     return (bool)$response;
284                 }
285             }
286             $debuginfo = 'Invalid external api response: the value is "' . $response .
287                     '", the server was expecting "' . $description->type . '" type';
288             try {
289                 return validate_param($response, $description->type, $description->allownull, $debuginfo);
290             } catch (invalid_parameter_exception $e) {
291                 //proper exception name, to be recursively catched to build the path to the faulty attribut
292                 throw new invalid_response_exception($e->debuginfo);
293             }
295         } else if ($description instanceof external_single_structure) {
296             if (!is_array($response) && !is_object($response)) {
297                 throw new invalid_response_exception('Only arrays/objects accepted. The bad value is: \'' .
298                         print_r($response, true) . '\'');
299             }
301             // Cast objects into arrays.
302             if (is_object($response)) {
303                 $response = (array) $response;
304             }
306             $result = array();
307             foreach ($description->keys as $key=>$subdesc) {
308                 if (!array_key_exists($key, $response)) {
309                     if ($subdesc->required == VALUE_REQUIRED) {
310                         throw new invalid_response_exception('Error in response - Missing following required key in a single structure: ' . $key);
311                     }
312                     if ($subdesc instanceof external_value) {
313                         if ($subdesc->required == VALUE_DEFAULT) {
314                             try {
315                                     $result[$key] = self::clean_returnvalue($subdesc, $subdesc->default);
316                             } catch (invalid_response_exception $e) {
317                                 //build the path to the faulty attribut
318                                 throw new invalid_response_exception($key." => ".$e->getMessage() . ': ' . $e->debuginfo);
319                             }
320                         }
321                     }
322                 } else {
323                     try {
324                         $result[$key] = self::clean_returnvalue($subdesc, $response[$key]);
325                     } catch (invalid_response_exception $e) {
326                         //build the path to the faulty attribut
327                         throw new invalid_response_exception($key." => ".$e->getMessage() . ': ' . $e->debuginfo);
328                     }
329                 }
330                 unset($response[$key]);
331             }
333             return $result;
335         } else if ($description instanceof external_multiple_structure) {
336             if (!is_array($response)) {
337                 throw new invalid_response_exception('Only arrays accepted. The bad value is: \'' .
338                         print_r($response, true) . '\'');
339             }
340             $result = array();
341             foreach ($response as $param) {
342                 $result[] = self::clean_returnvalue($description->content, $param);
343             }
344             return $result;
346         } else {
347             throw new invalid_response_exception('Invalid external api response description');
348         }
349     }
351     /**
352      * Makes sure user may execute functions in this context.
353      *
354      * @param stdClass $context
355      * @since Moodle 2.0
356      */
357     protected static function validate_context($context) {
358         global $CFG;
360         if (empty($context)) {
361             throw new invalid_parameter_exception('Context does not exist');
362         }
363         if (empty(self::$contextrestriction)) {
364             self::$contextrestriction = context_system::instance();
365         }
366         $rcontext = self::$contextrestriction;
368         if ($rcontext->contextlevel == $context->contextlevel) {
369             if ($rcontext->id != $context->id) {
370                 throw new restricted_context_exception();
371             }
372         } else if ($rcontext->contextlevel > $context->contextlevel) {
373             throw new restricted_context_exception();
374         } else {
375             $parents = $context->get_parent_context_ids();
376             if (!in_array($rcontext->id, $parents)) {
377                 throw new restricted_context_exception();
378             }
379         }
381         if ($context->contextlevel >= CONTEXT_COURSE) {
382             list($context, $course, $cm) = get_context_info_array($context->id);
383             require_login($course, false, $cm, false, true);
384         }
385     }
387     /**
388      * Get context from passed parameters.
389      * The passed array must either contain a contextid or a combination of context level and instance id to fetch the context.
390      * For example, the context level can be "course" and instanceid can be courseid.
391      *
392      * See context_helper::get_all_levels() for a list of valid context levels.
393      *
394      * @param array $param
395      * @since Moodle 2.6
396      * @throws invalid_parameter_exception
397      * @return context
398      */
399     protected static function get_context_from_params($param) {
400         $levels = context_helper::get_all_levels();
401         if (!empty($param['contextid'])) {
402             return context::instance_by_id($param['contextid'], IGNORE_MISSING);
403         } else if (!empty($param['contextlevel']) && isset($param['instanceid'])) {
404             $contextlevel = "context_".$param['contextlevel'];
405             if (!array_search($contextlevel, $levels)) {
406                 throw new invalid_parameter_exception('Invalid context level = '.$param['contextlevel']);
407             }
408            return $contextlevel::instance($param['instanceid'], IGNORE_MISSING);
409         } else {
410             // No valid context info was found.
411             throw new invalid_parameter_exception('Missing parameters, please provide either context level with instance id or contextid');
412         }
413     }
416 /**
417  * Common ancestor of all parameter description classes
418  *
419  * @package    core_webservice
420  * @copyright  2009 Petr Skodak
421  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
422  * @since Moodle 2.0
423  */
424 abstract class external_description {
425     /** @var string Description of element */
426     public $desc;
428     /** @var bool Element value required, null not allowed */
429     public $required;
431     /** @var mixed Default value */
432     public $default;
434     /**
435      * Contructor
436      *
437      * @param string $desc
438      * @param bool $required
439      * @param mixed $default
440      * @since Moodle 2.0
441      */
442     public function __construct($desc, $required, $default) {
443         $this->desc = $desc;
444         $this->required = $required;
445         $this->default = $default;
446     }
449 /**
450  * Scalar value description class
451  *
452  * @package    core_webservice
453  * @copyright  2009 Petr Skodak
454  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
455  * @since Moodle 2.0
456  */
457 class external_value extends external_description {
459     /** @var mixed Value type PARAM_XX */
460     public $type;
462     /** @var bool Allow null values */
463     public $allownull;
465     /**
466      * Constructor
467      *
468      * @param mixed $type
469      * @param string $desc
470      * @param bool $required
471      * @param mixed $default
472      * @param bool $allownull
473      * @since Moodle 2.0
474      */
475     public function __construct($type, $desc='', $required=VALUE_REQUIRED,
476             $default=null, $allownull=NULL_ALLOWED) {
477         parent::__construct($desc, $required, $default);
478         $this->type      = $type;
479         $this->allownull = $allownull;
480     }
483 /**
484  * Associative array description class
485  *
486  * @package    core_webservice
487  * @copyright  2009 Petr Skodak
488  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
489  * @since Moodle 2.0
490  */
491 class external_single_structure extends external_description {
493      /** @var array Description of array keys key=>external_description */
494     public $keys;
496     /**
497      * Constructor
498      *
499      * @param array $keys
500      * @param string $desc
501      * @param bool $required
502      * @param array $default
503      * @since Moodle 2.0
504      */
505     public function __construct(array $keys, $desc='',
506             $required=VALUE_REQUIRED, $default=null) {
507         parent::__construct($desc, $required, $default);
508         $this->keys = $keys;
509     }
512 /**
513  * Bulk array description class.
514  *
515  * @package    core_webservice
516  * @copyright  2009 Petr Skodak
517  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
518  * @since Moodle 2.0
519  */
520 class external_multiple_structure extends external_description {
522      /** @var external_description content */
523     public $content;
525     /**
526      * Constructor
527      *
528      * @param external_description $content
529      * @param string $desc
530      * @param bool $required
531      * @param array $default
532      * @since Moodle 2.0
533      */
534     public function __construct(external_description $content, $desc='',
535             $required=VALUE_REQUIRED, $default=null) {
536         parent::__construct($desc, $required, $default);
537         $this->content = $content;
538     }
541 /**
542  * Description of top level - PHP function parameters.
543  *
544  * @package    core_webservice
545  * @copyright  2009 Petr Skodak
546  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
547  * @since Moodle 2.0
548  */
549 class external_function_parameters extends external_single_structure {
552 /**
553  * Generate a token
554  *
555  * @param string $tokentype EXTERNAL_TOKEN_EMBEDDED|EXTERNAL_TOKEN_PERMANENT
556  * @param stdClass|int $serviceorid service linked to the token
557  * @param int $userid user linked to the token
558  * @param stdClass|int $contextorid
559  * @param int $validuntil date when the token expired
560  * @param string $iprestriction allowed ip - if 0 or empty then all ips are allowed
561  * @return string generated token
562  * @author  2010 Jamie Pratt
563  * @since Moodle 2.0
564  */
565 function external_generate_token($tokentype, $serviceorid, $userid, $contextorid, $validuntil=0, $iprestriction=''){
566     global $DB, $USER;
567     // make sure the token doesn't exist (even if it should be almost impossible with the random generation)
568     $numtries = 0;
569     do {
570         $numtries ++;
571         $generatedtoken = md5(uniqid(rand(),1));
572         if ($numtries > 5){
573             throw new moodle_exception('tokengenerationfailed');
574         }
575     } while ($DB->record_exists('external_tokens', array('token'=>$generatedtoken)));
576     $newtoken = new stdClass();
577     $newtoken->token = $generatedtoken;
578     if (!is_object($serviceorid)){
579         $service = $DB->get_record('external_services', array('id' => $serviceorid));
580     } else {
581         $service = $serviceorid;
582     }
583     if (!is_object($contextorid)){
584         $context = context::instance_by_id($contextorid, MUST_EXIST);
585     } else {
586         $context = $contextorid;
587     }
588     if (empty($service->requiredcapability) || has_capability($service->requiredcapability, $context, $userid)) {
589         $newtoken->externalserviceid = $service->id;
590     } else {
591         throw new moodle_exception('nocapabilitytousethisservice');
592     }
593     $newtoken->tokentype = $tokentype;
594     $newtoken->userid = $userid;
595     if ($tokentype == EXTERNAL_TOKEN_EMBEDDED){
596         $newtoken->sid = session_id();
597     }
599     $newtoken->contextid = $context->id;
600     $newtoken->creatorid = $USER->id;
601     $newtoken->timecreated = time();
602     $newtoken->validuntil = $validuntil;
603     if (!empty($iprestriction)) {
604         $newtoken->iprestriction = $iprestriction;
605     }
606     $DB->insert_record('external_tokens', $newtoken);
607     return $newtoken->token;
610 /**
611  * Create and return a session linked token. Token to be used for html embedded client apps that want to communicate
612  * with the Moodle server through web services. The token is linked to the current session for the current page request.
613  * It is expected this will be called in the script generating the html page that is embedding the client app and that the
614  * returned token will be somehow passed into the client app being embedded in the page.
615  *
616  * @param string $servicename name of the web service. Service name as defined in db/services.php
617  * @param int $context context within which the web service can operate.
618  * @return int returns token id.
619  * @since Moodle 2.0
620  */
621 function external_create_service_token($servicename, $context){
622     global $USER, $DB;
623     $service = $DB->get_record('external_services', array('name'=>$servicename), '*', MUST_EXIST);
624     return external_generate_token(EXTERNAL_TOKEN_EMBEDDED, $service, $USER->id, $context, 0);
627 /**
628  * Delete all pre-built services (+ related tokens) and external functions information defined in the specified component.
629  *
630  * @param string $component name of component (moodle, mod_assignment, etc.)
631  */
632 function external_delete_descriptions($component) {
633     global $DB;
635     $params = array($component);
637     $DB->delete_records_select('external_tokens',
638             "externalserviceid IN (SELECT id FROM {external_services} WHERE component = ?)", $params);
639     $DB->delete_records_select('external_services_users',
640             "externalserviceid IN (SELECT id FROM {external_services} WHERE component = ?)", $params);
641     $DB->delete_records_select('external_services_functions',
642             "functionname IN (SELECT name FROM {external_functions} WHERE component = ?)", $params);
643     $DB->delete_records('external_services', array('component'=>$component));
644     $DB->delete_records('external_functions', array('component'=>$component));
647 /**
648  * Standard Moodle web service warnings
649  *
650  * @package    core_webservice
651  * @copyright  2012 Jerome Mouneyrac
652  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
653  * @since Moodle 2.3
654  */
655 class external_warnings extends external_multiple_structure {
657     /**
658      * Constructor
659      *
660      * @since Moodle 2.3
661      */
662     public function __construct($itemdesc = 'item', $itemiddesc = 'item id',
663         $warningcodedesc = 'the warning code can be used by the client app to implement specific behaviour') {
665         parent::__construct(
666             new external_single_structure(
667                 array(
668                     'item' => new external_value(PARAM_TEXT, $itemdesc, VALUE_OPTIONAL),
669                     'itemid' => new external_value(PARAM_INT, $itemiddesc, VALUE_OPTIONAL),
670                     'warningcode' => new external_value(PARAM_ALPHANUM, $warningcodedesc),
671                     'message' => new external_value(PARAM_TEXT,
672                             'untranslated english message to explain the warning')
673                 ), 'warning'),
674             'list of warnings', VALUE_OPTIONAL);
675     }
678 /**
679  * A pre-filled external_value class for text format.
680  *
681  * Default is FORMAT_HTML
682  * This should be used all the time in external xxx_params()/xxx_returns functions
683  * as it is the standard way to implement text format param/return values.
684  *
685  * @package    core_webservice
686  * @copyright  2012 Jerome Mouneyrac
687  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
688  * @since Moodle 2.3
689  */
690 class external_format_value extends external_value {
692     /**
693      * Constructor
694      *
695      * @param string $textfieldname Name of the text field
696      * @param int $required if VALUE_REQUIRED then set standard default FORMAT_HTML
697      * @since Moodle 2.3
698      */
699     public function __construct($textfieldname, $required = VALUE_REQUIRED) {
701         $default = ($required == VALUE_DEFAULT) ? FORMAT_HTML : null;
703         $desc = $textfieldname . ' format (' . FORMAT_HTML . ' = HTML, '
704                 . FORMAT_MOODLE . ' = MOODLE, '
705                 . FORMAT_PLAIN . ' = PLAIN or '
706                 . FORMAT_MARKDOWN . ' = MARKDOWN)';
708         parent::__construct(PARAM_INT, $desc, $required, $default);
709     }
712 /**
713  * Validate text field format against known FORMAT_XXX
714  *
715  * @param array $format the format to validate
716  * @return the validated format
717  * @throws coding_exception
718  * @since Moodle 2.3
719  */
720 function external_validate_format($format) {
721     $allowedformats = array(FORMAT_HTML, FORMAT_MOODLE, FORMAT_PLAIN, FORMAT_MARKDOWN);
722     if (!in_array($format, $allowedformats)) {
723         throw new moodle_exception('formatnotsupported', 'webservice', '' , null,
724                 'The format with value=' . $format . ' is not supported by this Moodle site');
725     }
726     return $format;
729 /**
730  * Format the text to be returned properly as requested by the either the web service server,
731  * either by an internally call.
732  * The caller can change the format (raw, filter, file, fileurl) with the external_settings singleton
733  * All web service servers must set this singleton when parsing the $_GET and $_POST.
734  *
735  * @param string $text The content that may contain ULRs in need of rewriting.
736  * @param int $textformat The text format.
737  * @param int $contextid This parameter and the next two identify the file area to use.
738  * @param string $component
739  * @param string $filearea helps identify the file area.
740  * @param int $itemid helps identify the file area.
741  * @return array text + textformat
742  * @since Moodle 2.3
743  */
744 function external_format_text($text, $textformat, $contextid, $component, $filearea, $itemid) {
745     global $CFG;
747     // Get settings (singleton).
748     $settings = external_settings::get_instance();
750     if ($settings->get_fileurl()) {
751         require_once($CFG->libdir . "/filelib.php");
752         $text = file_rewrite_pluginfile_urls($text, $settings->get_file(), $contextid, $component, $filearea, $itemid);
753     }
755     if (!$settings->get_raw()) {
756         $text = format_text($text, $textformat, array('para' => false, 'filter' => $settings->get_filter()));
757         $textformat = FORMAT_HTML; // Once converted to html (from markdown, plain... lets inform consumer this is already HTML).
758     }
760     return array($text, $textformat);
763 /**
764  * Singleton to handle the external settings.
765  *
766  * We use singleton to encapsulate the "logic"
767  *
768  * @package    core_webservice
769  * @copyright  2012 Jerome Mouneyrac
770  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
771  * @since Moodle 2.3
772  */
773 class external_settings {
775     /** @var object the singleton instance */
776     public static $instance = null;
778     /** @var boolean Should the external function return raw text or formatted */
779     private $raw = false;
781     /** @var boolean Should the external function filter the text */
782     private $filter = false;
784     /** @var boolean Should the external function rewrite plugin file url */
785     private $fileurl = true;
787     /** @var string In which file should the urls be rewritten */
788     private $file = 'webservice/pluginfile.php';
790     /**
791      * Constructor - protected - can not be instanciated
792      */
793     protected function __construct() {
794     }
796     /**
797      * Clone - private - can not be cloned
798      */
799     private final function __clone() {
800     }
802     /**
803      * Return only one instance
804      *
805      * @return object
806      */
807     public static function get_instance() {
808         if (self::$instance === null) {
809             self::$instance = new external_settings;
810         }
812         return self::$instance;
813     }
815     /**
816      * Set raw
817      *
818      * @param boolean $raw
819      */
820     public function set_raw($raw) {
821         $this->raw = $raw;
822     }
824     /**
825      * Get raw
826      *
827      * @return boolean
828      */
829     public function get_raw() {
830         return $this->raw;
831     }
833     /**
834      * Set filter
835      *
836      * @param boolean $filter
837      */
838     public function set_filter($filter) {
839         $this->filter = $filter;
840     }
842     /**
843      * Get filter
844      *
845      * @return boolean
846      */
847     public function get_filter() {
848         return $this->filter;
849     }
851     /**
852      * Set fileurl
853      *
854      * @param boolean $fileurl
855      */
856     public function set_fileurl($fileurl) {
857         $this->fileurl = $fileurl;
858     }
860     /**
861      * Get fileurl
862      *
863      * @return boolean
864      */
865     public function get_fileurl() {
866         return $this->fileurl;
867     }
869     /**
870      * Set file
871      *
872      * @param string $file
873      */
874     public function set_file($file) {
875         $this->file = $file;
876     }
878     /**
879      * Get file
880      *
881      * @return string
882      */
883     public function get_file() {
884         return $this->file;
885     }