Merge branch 'master_MDL-28505_Asynchronous_backup_and_restore' of https://github...
[moodle.git] / admin / tool / mobile / classes / external.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/>.
17 /**
18  * This is the external API for this tool.
19  *
20  * @package    tool_mobile
21  * @copyright  2016 Juan Leyva
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace tool_mobile;
26 defined('MOODLE_INTERNAL') || die();
28 require_once("$CFG->libdir/externallib.php");
29 require_once("$CFG->dirroot/webservice/lib.php");
31 use external_api;
32 use external_files;
33 use external_function_parameters;
34 use external_value;
35 use external_single_structure;
36 use external_multiple_structure;
37 use external_warnings;
38 use context_system;
39 use moodle_exception;
40 use moodle_url;
41 use core_text;
42 use coding_exception;
44 /**
45  * This is the external API for this tool.
46  *
47  * @copyright  2016 Juan Leyva
48  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
49  */
50 class external extends external_api {
52     /**
53      * Returns description of get_plugins_supporting_mobile() parameters.
54      *
55      * @return external_function_parameters
56      * @since  Moodle 3.1
57      */
58     public static function get_plugins_supporting_mobile_parameters() {
59         return new external_function_parameters(array());
60     }
62     /**
63      * Returns a list of Moodle plugins supporting the mobile app.
64      *
65      * @return array an array of warnings and objects containing the plugin information
66      * @since  Moodle 3.1
67      */
68     public static function get_plugins_supporting_mobile() {
69         return array(
70             'plugins' => api::get_plugins_supporting_mobile(),
71             'warnings' => array(),
72         );
73     }
75     /**
76      * Returns description of get_plugins_supporting_mobile() result value.
77      *
78      * @return external_description
79      * @since  Moodle 3.1
80      */
81     public static function get_plugins_supporting_mobile_returns() {
82         return new external_single_structure(
83             array(
84                 'plugins' => new external_multiple_structure(
85                     new external_single_structure(
86                         array(
87                             'component' => new external_value(PARAM_COMPONENT, 'The plugin component name.'),
88                             'version' => new external_value(PARAM_NOTAGS, 'The plugin version number.'),
89                             'addon' => new external_value(PARAM_COMPONENT, 'The Mobile addon (package) name.'),
90                             'dependencies' => new external_multiple_structure(
91                                                 new external_value(PARAM_COMPONENT, 'Mobile addon name.'),
92                                                 'The list of Mobile addons this addon depends on.'
93                                                ),
94                             'fileurl' => new external_value(PARAM_URL, 'The addon package url for download
95                                                             or empty if it doesn\'t exist.'),
96                             'filehash' => new external_value(PARAM_RAW, 'The addon package hash or empty if it doesn\'t exist.'),
97                             'filesize' => new external_value(PARAM_INT, 'The addon package size or empty if it doesn\'t exist.'),
98                             'handlers' => new external_value(PARAM_RAW, 'Handlers definition (JSON)', VALUE_OPTIONAL),
99                             'lang' => new external_value(PARAM_RAW, 'Language strings used by the handlers (JSON)', VALUE_OPTIONAL),
100                         )
101                     )
102                 ),
103                 'warnings' => new external_warnings(),
104             )
105         );
106     }
108     /**
109      * Returns description of get_public_config() parameters.
110      *
111      * @return external_function_parameters
112      * @since  Moodle 3.2
113      */
114     public static function get_public_config_parameters() {
115         return new external_function_parameters(array());
116     }
118     /**
119      * Returns a list of the site public settings, those not requiring authentication.
120      *
121      * @return array with the settings and warnings
122      * @since  Moodle 3.2
123      */
124     public static function get_public_config() {
125         $result = api::get_public_config();
126         $result['warnings'] = array();
127         return $result;
128     }
130     /**
131      * Returns description of get_public_config() result value.
132      *
133      * @return external_description
134      * @since  Moodle 3.2
135      */
136     public static function get_public_config_returns() {
137         return new external_single_structure(
138             array(
139                 'wwwroot' => new external_value(PARAM_RAW, 'Site URL.'),
140                 'httpswwwroot' => new external_value(PARAM_RAW, 'Site https URL (if httpslogin is enabled).'),
141                 'sitename' => new external_value(PARAM_TEXT, 'Site name.'),
142                 'guestlogin' => new external_value(PARAM_INT, 'Whether guest login is enabled.'),
143                 'rememberusername' => new external_value(PARAM_INT, 'Values: 0 for No, 1 for Yes, 2 for optional.'),
144                 'authloginviaemail' => new external_value(PARAM_INT, 'Whether log in via email is enabled.'),
145                 'registerauth' => new external_value(PARAM_PLUGIN, 'Authentication method for user registration.'),
146                 'forgottenpasswordurl' => new external_value(PARAM_URL, 'Forgotten password URL.'),
147                 'authinstructions' => new external_value(PARAM_RAW, 'Authentication instructions.'),
148                 'authnoneenabled' => new external_value(PARAM_INT, 'Whether auth none is enabled.'),
149                 'enablewebservices' => new external_value(PARAM_INT, 'Whether Web Services are enabled.'),
150                 'enablemobilewebservice' => new external_value(PARAM_INT, 'Whether the Mobile service is enabled.'),
151                 'maintenanceenabled' => new external_value(PARAM_INT, 'Whether site maintenance is enabled.'),
152                 'maintenancemessage' => new external_value(PARAM_RAW, 'Maintenance message.'),
153                 'logourl' => new external_value(PARAM_URL, 'The site logo URL', VALUE_OPTIONAL),
154                 'compactlogourl' => new external_value(PARAM_URL, 'The site compact logo URL', VALUE_OPTIONAL),
155                 'typeoflogin' => new external_value(PARAM_INT, 'The type of login. 1 for app, 2 for browser, 3 for embedded.'),
156                 'launchurl' => new external_value(PARAM_URL, 'SSO login launch URL.', VALUE_OPTIONAL),
157                 'mobilecssurl' => new external_value(PARAM_URL, 'Mobile custom CSS theme', VALUE_OPTIONAL),
158                 'tool_mobile_disabledfeatures' => new external_value(PARAM_RAW, 'Disabled features in the app', VALUE_OPTIONAL),
159                 'identityproviders' => new external_multiple_structure(
160                     new external_single_structure(
161                         array(
162                             'name' => new external_value(PARAM_TEXT, 'The identity provider name.'),
163                             'iconurl' => new external_value(PARAM_URL, 'The icon URL for the provider.'),
164                             'url' => new external_value(PARAM_URL, 'The URL of the provider.'),
165                         )
166                     ),
167                     'Identity providers', VALUE_OPTIONAL
168                 ),
169                 'country' => new external_value(PARAM_NOTAGS, 'Default site country', VALUE_OPTIONAL),
170                 'agedigitalconsentverification' => new external_value(PARAM_BOOL, 'Whether age digital consent verification
171                     is enabled.', VALUE_OPTIONAL),
172                 'supportname' => new external_value(PARAM_NOTAGS, 'Site support contact name
173                     (only if age verification is enabled).', VALUE_OPTIONAL),
174                 'supportemail' => new external_value(PARAM_EMAIL, 'Site support contact email
175                     (only if age verification is enabled).', VALUE_OPTIONAL),
176                 'autolang' => new external_value(PARAM_INT, 'Whether to detect default language
177                     from browser setting.', VALUE_OPTIONAL),
178                 'lang' => new external_value(PARAM_LANG, 'Default language for the site.', VALUE_OPTIONAL),
179                 'langmenu' => new external_value(PARAM_INT, 'Whether the language menu should be displayed.', VALUE_OPTIONAL),
180                 'langlist' => new external_value(PARAM_RAW, 'Languages on language menu.', VALUE_OPTIONAL),
181                 'locale' => new external_value(PARAM_RAW, 'Sitewide locale.', VALUE_OPTIONAL),
182                 'warnings' => new external_warnings(),
183             )
184         );
185     }
187     /**
188      * Returns description of get_config() parameters.
189      *
190      * @return external_function_parameters
191      * @since  Moodle 3.2
192      */
193     public static function get_config_parameters() {
194         return new external_function_parameters(
195             array(
196                 'section' => new external_value(PARAM_ALPHANUMEXT, 'Settings section name.', VALUE_DEFAULT, ''),
197             )
198         );
199     }
201     /**
202      * Returns a list of site settings, filtering by section.
203      *
204      * @param string $section settings section name
205      * @return array with the settings and warnings
206      * @since  Moodle 3.2
207      */
208     public static function get_config($section = '') {
210         $params = self::validate_parameters(self::get_config_parameters(), array('section' => $section));
212         $settings = api::get_config($params['section']);
213         $result['settings'] = array();
214         foreach ($settings as $name => $value) {
215             $result['settings'][] = array(
216                 'name' => $name,
217                 'value' => $value,
218             );
219         }
221         $result['warnings'] = array();
222         return $result;
223     }
225     /**
226      * Returns description of get_config() result value.
227      *
228      * @return external_description
229      * @since  Moodle 3.2
230      */
231     public static function get_config_returns() {
232         return new external_single_structure(
233             array(
234                 'settings' => new external_multiple_structure(
235                     new external_single_structure(
236                         array(
237                             'name' => new external_value(PARAM_RAW, 'The name of the setting'),
238                             'value' => new external_value(PARAM_RAW, 'The value of the setting'),
239                         )
240                     ),
241                     'Settings'
242                 ),
243                 'warnings' => new external_warnings(),
244             )
245         );
246     }
248     /**
249      * Returns description of get_autologin_key() parameters.
250      *
251      * @return external_function_parameters
252      * @since  Moodle 3.2
253      */
254     public static function get_autologin_key_parameters() {
255         return new external_function_parameters (
256             array(
257                 'privatetoken' => new external_value(PARAM_ALPHANUM, 'Private token, usually generated by login/token.php'),
258             )
259         );
260     }
262     /**
263      * Creates an auto-login key for the current user. Is created only in https sites and is restricted by time and ip address.
264      *
265      * Please note that it only works if the request comes from the Moodle mobile or desktop app.
266      *
267      * @param string $privatetoken the user private token for validating the request
268      * @return array with the settings and warnings
269      * @since  Moodle 3.2
270      */
271     public static function get_autologin_key($privatetoken) {
272         global $CFG, $DB, $USER;
274         $params = self::validate_parameters(self::get_autologin_key_parameters(), array('privatetoken' => $privatetoken));
275         $privatetoken = $params['privatetoken'];
277         $context = context_system::instance();
279         // We must toletare these two exceptions: forcepasswordchangenotice and usernotfullysetup.
280         try {
281             self::validate_context($context);
282         } catch (moodle_exception $e) {
283             if ($e->errorcode != 'usernotfullysetup' && $e->errorcode != 'forcepasswordchangenotice') {
284                 // In case we receive a different exception, throw it.
285                 throw $e;
286             }
287         }
289         api::check_autologin_prerequisites($USER->id);
291         if (isset($_GET['privatetoken']) or empty($privatetoken)) {
292             throw new moodle_exception('invalidprivatetoken', 'tool_mobile');
293         }
295         // Check the request counter, we must limit the number of times the privatetoken is sent.
296         // Between each request 6 minutes are required.
297         $last = get_user_preferences('tool_mobile_autologin_request_last', 0, $USER);
298         // Check if we must reset the count.
299         $timenow = time();
300         if ($timenow - $last < 6 * MINSECS) {
301             throw new moodle_exception('autologinkeygenerationlockout', 'tool_mobile');
302         }
303         set_user_preference('tool_mobile_autologin_request_last', $timenow, $USER);
305         // We are expecting a privatetoken linked to the current token being used.
306         // This WS is only valid when using mobile services via REST (this is intended).
307         $currenttoken = required_param('wstoken', PARAM_ALPHANUM);
308         $conditions = array(
309             'userid' => $USER->id,
310             'token' => $currenttoken,
311             'privatetoken' => $privatetoken,
312         );
313         if (!$token = $DB->get_record('external_tokens', $conditions)) {
314             throw new moodle_exception('invalidprivatetoken', 'tool_mobile');
315         }
317         $result = array();
318         $result['key'] = api::get_autologin_key();
319         $autologinurl = new moodle_url("/$CFG->admin/tool/mobile/autologin.php");
320         $result['autologinurl'] = $autologinurl->out(false);
321         $result['warnings'] = array();
322         return $result;
323     }
325     /**
326      * Returns description of get_autologin_key() result value.
327      *
328      * @return external_description
329      * @since  Moodle 3.2
330      */
331     public static function get_autologin_key_returns() {
332         return new external_single_structure(
333             array(
334                 'key' => new external_value(PARAM_ALPHANUMEXT, 'Auto-login key for a single usage with time expiration.'),
335                 'autologinurl' => new external_value(PARAM_URL, 'Auto-login URL.'),
336                 'warnings' => new external_warnings(),
337             )
338         );
339     }
341     /**
342      * Returns description of get_content() parameters
343      *
344      * @return external_function_parameters
345      * @since Moodle 3.5
346      */
347     public static function get_content_parameters() {
348         return new external_function_parameters(
349             array(
350                 'component' => new external_value(PARAM_COMPONENT, 'Component where the class is e.g. mod_assign.'),
351                 'method' => new external_value(PARAM_ALPHANUMEXT, 'Method to execute in class \$component\output\mobile.'),
352                 'args' => new external_multiple_structure(
353                     new external_single_structure(
354                         array(
355                             'name' => new external_value(PARAM_ALPHANUMEXT, 'Param name.'),
356                             'value' => new external_value(PARAM_RAW, 'Param value.')
357                         )
358                     ), 'Args for the method are optional.', VALUE_OPTIONAL
359                 )
360             )
361         );
362     }
364     /**
365      * Returns a piece of content to be displayed in the Mobile app, it usually returns a template, javascript and
366      * other structured data that will be used to render a view in the Mobile app..
367      *
368      * Callbacks (placed in \$component\output\mobile) that are called by this web service are responsible for doing the
369      * appropriate security checks to access the information to be returned.
370      *
371      * @param string $component fame of the component.
372      * @param string $method function method name in class \$component\output\mobile.
373      * @param array $args optional arguments for the method.
374      * @return array HTML, JavaScript and other required data and information to create a view in the app.
375      * @since Moodle 3.5
376      * @throws coding_exception
377      */
378     public static function get_content($component, $method, $args = array()) {
379         global $OUTPUT, $PAGE, $USER;
381         $params = self::validate_parameters(self::get_content_parameters(),
382             array(
383                 'component' => $component,
384                 'method' => $method,
385                 'args' => $args
386             )
387         );
389         // Reformat arguments into something less unwieldy.
390         $arguments = array();
391         foreach ($params['args'] as $paramargument) {
392             $arguments[$paramargument['name']] = $paramargument['value'];
393         }
395         // The component was validated via the PARAM_COMPONENT parameter type.
396         $classname = '\\' . $params['component'] .'\output\mobile';
397         if (!method_exists($classname, $params['method'])) {
398             throw new coding_exception("Missing method in $classname");
399         }
400         $result = call_user_func_array(array($classname, $params['method']), array($arguments));
402         // Populate otherdata.
403         $otherdata = array();
404         if (!empty($result['otherdata'])) {
405             $result['otherdata'] = (array) $result['otherdata'];
406             foreach ($result['otherdata'] as $name => $value) {
407                 $otherdata[] = array(
408                     'name' => $name,
409                     'value' => $value
410                 );
411             }
412         }
414         return array(
415             'templates'  => !empty($result['templates']) ? $result['templates'] : array(),
416             'javascript' => !empty($result['javascript']) ? $result['javascript'] : '',
417             'otherdata'  => $otherdata,
418             'files'      => !empty($result['files']) ? $result['files'] : array(),
419             'restrict'   => !empty($result['restrict']) ? $result['restrict'] : array(),
420         );
421     }
423     /**
424      * Returns description of get_content() result value
425      *
426      * @return array
427      * @since Moodle 3.5
428      */
429     public static function get_content_returns() {
430         return new external_single_structure(
431             array(
432                 'templates' => new external_multiple_structure(
433                     new external_single_structure(
434                         array(
435                             'id' => new external_value(PARAM_TEXT, 'ID of the template.'),
436                             'html' => new external_value(PARAM_RAW, 'HTML code.'),
437                         )
438                     ),
439                     'Templates required by the generated content.'
440                 ),
441                 'javascript' => new external_value(PARAM_RAW, 'JavaScript code.'),
442                 'otherdata' => new external_multiple_structure(
443                     new external_single_structure(
444                         array(
445                             'name' => new external_value(PARAM_RAW, 'Field name.'),
446                             'value' => new external_value(PARAM_RAW, 'Field value.')
447                         )
448                     ),
449                     'Other data that can be used or manipulated by the template via 2-way data-binding.'
450                 ),
451                 'files' => new external_files('Files in the content.'),
452                 'restrict' => new external_single_structure(
453                     array(
454                         'users' => new external_multiple_structure(
455                             new external_value(PARAM_INT, 'user id'), 'List of allowed users.', VALUE_OPTIONAL
456                         ),
457                         'courses' => new external_multiple_structure(
458                             new external_value(PARAM_INT, 'course id'), 'List of allowed courses.', VALUE_OPTIONAL
459                         ),
460                     ),
461                     'Restrict this content to certain users or courses.'
462                 )
463             )
464         );
465     }
467     /**
468      * Returns description of method parameters
469      *
470      * @return external_function_parameters
471      * @since Moodle 3.7
472      */
473     public static function call_external_functions_parameters() {
474         return new external_function_parameters([
475             'requests' => new external_multiple_structure(
476                 new external_single_structure([
477                     'function' => new external_value(PARAM_ALPHANUMEXT, 'Function name'),
478                     'arguments' => new external_value(PARAM_RAW, 'JSON-encoded object with named arguments', VALUE_DEFAULT, '{}'),
479                     'settingraw' => new external_value(PARAM_BOOL, 'Return raw text', VALUE_DEFAULT, false),
480                     'settingfilter' => new external_value(PARAM_BOOL, 'Filter text', VALUE_DEFAULT, false),
481                     'settingfileurl' => new external_value(PARAM_BOOL, 'Rewrite plugin file URLs', VALUE_DEFAULT, true),
482                     'settinglang' => new external_value(PARAM_LANG, 'Session language', VALUE_DEFAULT, ''),
483                 ])
484             )
485         ]);
486     }
488     /**
489      * Call multiple external functions and return all responses.
490      *
491      * @param array $requests List of requests.
492      * @return array Responses.
493      * @since Moodle 3.7
494      */
495     public static function call_external_functions($requests) {
496         global $SESSION;
498         $params = self::validate_parameters(self::call_external_functions_parameters(), ['requests' => $requests]);
500         // We need to check if the functions being called are included in the service of the current token.
501         // This function only works when using mobile services via REST (this is intended).
502         $webservicemanager = new \webservice;
503         $token = $webservicemanager->get_user_ws_token(required_param('wstoken', PARAM_ALPHANUM));
505         $settings = \external_settings::get_instance();
506         $defaultlang = current_language();
507         $responses = [];
509         foreach ($params['requests'] as $request) {
510             // Some external functions modify _GET or $_POST data, we need to restore the original data after each call.
511             $originalget = fullclone($_GET);
512             $originalpost = fullclone($_POST);
514             // Set external settings and language.
515             $settings->set_raw($request['settingraw']);
516             $settings->set_filter($request['settingfilter']);
517             $settings->set_fileurl($request['settingfileurl']);
518             $settings->set_lang($request['settinglang']);
519             $SESSION->lang = $request['settinglang'] ?: $defaultlang;
521             // Parse arguments to an array, validation is done in external_api::call_external_function.
522             $args = @json_decode($request['arguments'], true);
523             if (!is_array($args)) {
524                 $args = [];
525             }
527             if ($webservicemanager->service_function_exists($request['function'], $token->externalserviceid)) {
528                 $response = external_api::call_external_function($request['function'], $args, false);
529             } else {
530                 // Function not included in the service, return an access exception.
531                 $response = [
532                     'error' => true,
533                     'exception' => [
534                         'errorcode' => 'accessexception',
535                         'module' => 'webservice'
536                     ]
537                 ];
538                 if (debugging('', DEBUG_DEVELOPER)) {
539                     $response['exception']['debuginfo'] = 'Access to the function is not allowed.';
540                 }
541             }
543             if (isset($response['data'])) {
544                 $response['data'] = json_encode($response['data']);
545             }
546             if (isset($response['exception'])) {
547                 $response['exception'] = json_encode($response['exception']);
548             }
549             $responses[] = $response;
551             // Restore original $_GET and $_POST.
552             $_GET = $originalget;
553             $_POST = $originalpost;
555             if ($response['error']) {
556                 // Do not process the remaining requests.
557                 break;
558             }
559         }
561         return ['responses' => $responses];
562     }
564     /**
565      * Returns description of method result value
566      *
567      * @return external_single_structure
568      * @since Moodle 3.7
569      */
570     public static function call_external_functions_returns() {
571         return new external_function_parameters([
572             'responses' => new external_multiple_structure(
573                 new external_single_structure([
574                     'error' => new external_value(PARAM_BOOL, 'Whether an exception was thrown.'),
575                     'data' => new external_value(PARAM_RAW, 'JSON-encoded response data', VALUE_OPTIONAL),
576                     'exception' => new external_value(PARAM_RAW, 'JSON-encoed exception info', VALUE_OPTIONAL),
577                 ])
578              )
579         ]);
580     }