Merge branch 'MDL-62229-master' of git://github.com/jleyva/moodle
[moodle.git] / admin / tool / mobile / classes / api.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  * Class for Moodle Mobile tools.
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  * @since      Moodle 3.1
24  */
25 namespace tool_mobile;
27 use core_component;
28 use core_plugin_manager;
29 use context_system;
30 use moodle_url;
31 use moodle_exception;
32 use lang_string;
33 use curl;
35 /**
36  * API exposed by tool_mobile, to be used mostly by external functions and the plugin settings.
37  *
38  * @copyright  2016 Juan Leyva
39  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40  * @since      Moodle 3.1
41  */
42 class api {
44     /** @var int to identify the login via app. */
45     const LOGIN_VIA_APP = 1;
46     /** @var int to identify the login via browser. */
47     const LOGIN_VIA_BROWSER = 2;
48     /** @var int to identify the login via an embedded browser. */
49     const LOGIN_VIA_EMBEDDED_BROWSER = 3;
50     /** @var int seconds an auto-login key will expire. */
51     const LOGIN_KEY_TTL = 60;
53     /**
54      * Returns a list of Moodle plugins supporting the mobile app.
55      *
56      * @return array an array of objects containing the plugin information
57      */
58     public static function get_plugins_supporting_mobile() {
59         global $CFG;
60         require_once($CFG->libdir . '/adminlib.php');
62         $cachekey = 'mobileplugins';
63         if (!isloggedin()) {
64             $cachekey = 'authmobileplugins';    // Use a different cache for not logged users.
65         }
67         // Check if we can return this from cache.
68         $cache = \cache::make('tool_mobile', 'plugininfo');
69         $pluginsinfo = $cache->get($cachekey);
70         if ($pluginsinfo !== false) {
71             return (array)$pluginsinfo;
72         }
74         $pluginsinfo = [];
75         // For not logged users return only auth plugins.
76         // This is to avoid anyone (not being a registered user) to obtain and download all the site remote add-ons.
77         if (!isloggedin()) {
78             $plugintypes = array('auth' => $CFG->dirroot.'/auth');
79         } else {
80             $plugintypes = core_component::get_plugin_types();
81         }
83         foreach ($plugintypes as $plugintype => $unused) {
84             // We need to include files here.
85             $pluginswithfile = core_component::get_plugin_list_with_file($plugintype, 'db' . DIRECTORY_SEPARATOR . 'mobile.php');
86             foreach ($pluginswithfile as $plugin => $notused) {
87                 $path = core_component::get_plugin_directory($plugintype, $plugin);
88                 $component = $plugintype . '_' . $plugin;
89                 $version = get_component_version($component);
91                 require("$path/db/mobile.php");
92                 foreach ($addons as $addonname => $addoninfo) {
94                     // Add handlers (for site add-ons).
95                     $handlers = !empty($addoninfo['handlers']) ? $addoninfo['handlers'] : array();
96                     $handlers = json_encode($handlers); // JSON formatted, since it is a complex structure that may vary over time.
98                     // Now language strings used by the app.
99                     $lang = array();
100                     if (!empty($addoninfo['lang'])) {
101                         $stringmanager = get_string_manager();
102                         $langs = $stringmanager->get_list_of_translations();
103                         foreach ($langs as $langid => $langname) {
104                             foreach ($addoninfo['lang'] as $stringinfo) {
105                                 $lang[$langid][$stringinfo[0]] =
106                                     $stringmanager->get_string($stringinfo[0], $stringinfo[1], null, $langid);
107                             }
108                         }
109                     }
110                     $lang = json_encode($lang);
112                     $plugininfo = array(
113                         'component' => $component,
114                         'version' => $version,
115                         'addon' => $addonname,
116                         'dependencies' => !empty($addoninfo['dependencies']) ? $addoninfo['dependencies'] : array(),
117                         'fileurl' => '',
118                         'filehash' => '',
119                         'filesize' => 0,
120                         'handlers' => $handlers,
121                         'lang' => $lang,
122                     );
124                     // All the mobile packages must be under the plugin mobile directory.
125                     $package = $path . '/mobile/' . $addonname . '.zip';
126                     if (file_exists($package)) {
127                         $plugininfo['fileurl'] = $CFG->wwwroot . '' . str_replace($CFG->dirroot, '', $package);
128                         $plugininfo['filehash'] = sha1_file($package);
129                         $plugininfo['filesize'] = filesize($package);
130                     }
131                     $pluginsinfo[] = $plugininfo;
132                 }
133             }
134         }
136         $cache->set($cachekey, $pluginsinfo);
138         return $pluginsinfo;
139     }
141     /**
142      * Returns a list of the site public settings, those not requiring authentication.
143      *
144      * @return array with the settings and warnings
145      */
146     public static function get_public_config() {
147         global $CFG, $SITE, $PAGE, $OUTPUT;
148         require_once($CFG->libdir . '/authlib.php');
150         $context = context_system::instance();
151         // We need this to make work the format text functions.
152         $PAGE->set_context($context);
154         list($authinstructions, $notusedformat) = external_format_text($CFG->auth_instructions, FORMAT_MOODLE, $context->id);
155         list($maintenancemessage, $notusedformat) = external_format_text($CFG->maintenance_message, FORMAT_MOODLE, $context->id);
156         $settings = array(
157             'wwwroot' => $CFG->wwwroot,
158             'httpswwwroot' => $CFG->wwwroot,
159             'sitename' => external_format_string($SITE->fullname, $context->id, true),
160             'guestlogin' => $CFG->guestloginbutton,
161             'rememberusername' => $CFG->rememberusername,
162             'authloginviaemail' => $CFG->authloginviaemail,
163             'registerauth' => $CFG->registerauth,
164             'forgottenpasswordurl' => clean_param($CFG->forgottenpasswordurl, PARAM_URL), // We may expect a mailto: here.
165             'authinstructions' => $authinstructions,
166             'authnoneenabled' => (int) is_enabled_auth('none'),
167             'enablewebservices' => $CFG->enablewebservices,
168             'enablemobilewebservice' => $CFG->enablemobilewebservice,
169             'maintenanceenabled' => $CFG->maintenance_enabled,
170             'maintenancemessage' => $maintenancemessage,
171             'mobilecssurl' => !empty($CFG->mobilecssurl) ? $CFG->mobilecssurl : '',
172             'tool_mobile_disabledfeatures' => get_config('tool_mobile', 'disabledfeatures'),
173             'country' => clean_param($CFG->country, PARAM_NOTAGS),
174             'agedigitalconsentverification' => \core_auth\digital_consent::is_age_digital_consent_verification_enabled(),
175             'autolang' => $CFG->autolang,
176             'lang' => clean_param($CFG->lang, PARAM_LANG),  // Avoid breaking WS because of incorrect package langs.
177             'langmenu' => $CFG->langmenu,
178             'langlist' => $CFG->langlist,
179             'locale' => $CFG->locale,
180         );
182         $typeoflogin = get_config('tool_mobile', 'typeoflogin');
183         // Not found, edge case.
184         if ($typeoflogin === false) {
185             $typeoflogin = self::LOGIN_VIA_APP; // Defaults to via app.
186         }
187         $settings['typeoflogin'] = $typeoflogin;
189         // Check if the user can sign-up to return the launch URL in that case.
190         $cansignup = signup_is_enabled();
192         $url = new moodle_url("/$CFG->admin/tool/mobile/launch.php");
193         $settings['launchurl'] = $url->out(false);
195         // Check that we are receiving a moodle_url object, themes can override get_logo_url and may return incorrect values.
196         if (($logourl = $OUTPUT->get_logo_url()) && $logourl instanceof moodle_url) {
197             $settings['logourl'] = $logourl->out(false);
198         }
199         if (($compactlogourl = $OUTPUT->get_compact_logo_url()) && $compactlogourl instanceof moodle_url) {
200             $settings['compactlogourl'] = $compactlogourl->out(false);
201         }
203         // Identity providers.
204         $authsequence = get_enabled_auth_plugins(true);
205         $identityproviders = \auth_plugin_base::get_identity_providers($authsequence);
206         $identityprovidersdata = \auth_plugin_base::prepare_identity_providers_for_output($identityproviders, $OUTPUT);
207         if (!empty($identityprovidersdata)) {
208             $settings['identityproviders'] = $identityprovidersdata;
209         }
211         // If age is verified, return also the admin contact details.
212         if ($settings['agedigitalconsentverification']) {
213             $settings['supportname'] = clean_param($CFG->supportname, PARAM_NOTAGS);
214             $settings['supportemail'] = clean_param($CFG->supportemail, PARAM_EMAIL);
215         }
217         return $settings;
218     }
220     /**
221      * Returns a list of site configurations, filtering by section.
222      *
223      * @param  string $section section name
224      * @return stdClass object containing the settings
225      */
226     public static function get_config($section) {
227         global $CFG, $SITE;
229         $settings = new \stdClass;
230         $context = context_system::instance();
231         $isadmin = has_capability('moodle/site:config', $context);
233         if (empty($section) or $section == 'frontpagesettings') {
234             require_once($CFG->dirroot . '/course/format/lib.php');
235             // First settings that anyone can deduce.
236             $settings->fullname = external_format_string($SITE->fullname, $context->id);
237             $settings->shortname = external_format_string($SITE->shortname, $context->id);
239             // Return to a var instead of directly to $settings object because of differences between
240             // list() in php5 and php7. {@link http://php.net/manual/en/function.list.php}
241             $formattedsummary = external_format_text($SITE->summary, $SITE->summaryformat,
242                                                                                         $context->id);
243             $settings->summary = $formattedsummary[0];
244             $settings->summaryformat = $formattedsummary[1];
245             $settings->frontpage = $CFG->frontpage;
246             $settings->frontpageloggedin = $CFG->frontpageloggedin;
247             $settings->maxcategorydepth = $CFG->maxcategorydepth;
248             $settings->frontpagecourselimit = $CFG->frontpagecourselimit;
249             $settings->numsections = course_get_format($SITE)->get_last_section_number();
250             $settings->newsitems = $SITE->newsitems;
251             $settings->commentsperpage = $CFG->commentsperpage;
253             // Now, admin settings.
254             if ($isadmin) {
255                 $settings->defaultfrontpageroleid = $CFG->defaultfrontpageroleid;
256             }
257         }
259         if (empty($section) or $section == 'sitepolicies') {
260             $manager = new \core_privacy\local\sitepolicy\manager();
261             $settings->sitepolicy = ($sitepolicy = $manager->get_embed_url()) ? $sitepolicy->out(false) : '';
262             $settings->sitepolicyhandler = $CFG->sitepolicyhandler;
263             $settings->disableuserimages = $CFG->disableuserimages;
264         }
266         if (empty($section) or $section == 'gradessettings') {
267             require_once($CFG->dirroot . '/user/lib.php');
268             $settings->mygradesurl = user_mygrades_url();
269             // The previous function may return moodle_url instances or plain string URLs.
270             if ($settings->mygradesurl instanceof moodle_url) {
271                 $settings->mygradesurl = $settings->mygradesurl->out(false);
272             }
273         }
275         if (empty($section) or $section == 'mobileapp') {
276             $settings->tool_mobile_forcelogout = get_config('tool_mobile', 'forcelogout');
277             $settings->tool_mobile_customlangstrings = get_config('tool_mobile', 'customlangstrings');
278             $settings->tool_mobile_disabledfeatures = get_config('tool_mobile', 'disabledfeatures');
279             $settings->tool_mobile_custommenuitems = get_config('tool_mobile', 'custommenuitems');
280             $settings->tool_mobile_apppolicy = get_config('tool_mobile', 'apppolicy');
281         }
283         return $settings;
284     }
286     /*
287      * Check if all the required conditions are met to allow the auto-login process continue.
288      *
289      * @param  int $userid  current user id
290      * @since Moodle 3.2
291      * @throws moodle_exception
292      */
293     public static function check_autologin_prerequisites($userid) {
294         global $CFG;
296         if (!$CFG->enablewebservices or !$CFG->enablemobilewebservice) {
297             throw new moodle_exception('enablewsdescription', 'webservice');
298         }
300         if (!is_https()) {
301             throw new moodle_exception('httpsrequired', 'tool_mobile');
302         }
304         if (has_capability('moodle/site:config', context_system::instance(), $userid) or is_siteadmin($userid)) {
305             throw new moodle_exception('autologinnotallowedtoadmins', 'tool_mobile');
306         }
307     }
309     /**
310      * Creates an auto-login key for the current user, this key is restricted by time and ip address.
311      *
312      * @return string the key
313      * @since Moodle 3.2
314      */
315     public static function get_autologin_key() {
316         global $USER;
317         // Delete previous keys.
318         delete_user_key('tool_mobile', $USER->id);
320         // Create a new key.
321         $iprestriction = getremoteaddr();
322         $validuntil = time() + self::LOGIN_KEY_TTL;
323         return create_user_key('tool_mobile', $USER->id, null, $iprestriction, $validuntil);
324     }
326     /**
327      * Get a list of the Mobile app features.
328      *
329      * @return array array with the features grouped by theirs ubication in the app.
330      * @since Moodle 3.3
331      */
332     public static function get_features_list() {
333         global $CFG;
335         $general = new lang_string('general');
336         $mainmenu = new lang_string('mainmenu', 'tool_mobile');
337         $course = new lang_string('course');
338         $modules = new lang_string('managemodules');
339         $user = new lang_string('user');
340         $files = new lang_string('files');
341         $remoteaddons = new lang_string('remoteaddons', 'tool_mobile');
343         $availablemods = core_plugin_manager::instance()->get_plugins_of_type('mod');
344         $coursemodules = array();
345         $appsupportedmodules = array('assign', 'book', 'chat', 'choice', 'data', 'feedback', 'folder', 'forum', 'glossary', 'imscp',
346             'label', 'lesson', 'lti', 'page', 'quiz', 'resource', 'scorm', 'survey', 'url', 'wiki', 'workshop');
348         foreach ($availablemods as $mod) {
349             if (in_array($mod->name, $appsupportedmodules)) {
350                 $coursemodules['$mmCourseDelegate_mmaMod' . ucfirst($mod->name)] = $mod->displayname;
351             }
352         }
354         $remoteaddonslist = array();
355         $mobileplugins = self::get_plugins_supporting_mobile();
356         foreach ($mobileplugins as $plugin) {
357             $displayname = core_plugin_manager::instance()->plugin_name($plugin['component']) . " - " . $plugin['addon'];
358             $remoteaddonslist['remoteAddOn_' . $plugin['component'] . '_' . $plugin['addon']] = $displayname;
360         }
362         $features = array(
363             'NoDelegate_CoreOffline' => new lang_string('offlineuse', 'tool_mobile'),
364             '$mmLoginEmailSignup' => new lang_string('startsignup'),
365             "$mainmenu" => array(
366                 '$mmSideMenuDelegate_mmCourses' => new lang_string('mycourses'),
367                 '$mmSideMenuDelegate_mmaFrontpage' => new lang_string('sitehome'),
368                 '$mmSideMenuDelegate_mmaGrades' => new lang_string('grades', 'grades'),
369                 '$mmSideMenuDelegate_mmaCompetency' => new lang_string('myplans', 'tool_lp'),
370                 '$mmSideMenuDelegate_mmaNotifications' => new lang_string('notifications', 'message'),
371                 '$mmSideMenuDelegate_mmaMessages' => new lang_string('messages', 'message'),
372                 '$mmSideMenuDelegate_mmaCalendar' => new lang_string('calendar', 'calendar'),
373                 '$mmSideMenuDelegate_mmaFiles' => new lang_string('files'),
374                 '$mmSideMenuDelegate_website' => new lang_string('webpage'),
375                 '$mmSideMenuDelegate_help' => new lang_string('help'),
376             ),
377             "$course" => array(
378                 '$mmCoursesDelegate_search' => new lang_string('search'),
379                 '$mmCoursesDelegate_mmaCompetency' => new lang_string('competencies', 'competency'),
380                 '$mmCoursesDelegate_mmaParticipants' => new lang_string('participants'),
381                 '$mmCoursesDelegate_mmaGrades' => new lang_string('grades', 'grades'),
382                 '$mmCoursesDelegate_mmaCourseCompletion' => new lang_string('coursecompletion', 'completion'),
383                 '$mmCoursesDelegate_mmaNotes' => new lang_string('notes', 'notes'),
384                 'NoDelegate_CoreCourseDownload' => new lang_string('downloadcourse', 'tool_mobile'),
385                 'NoDelegate_CoreCoursesDownload' => new lang_string('downloadcourses', 'tool_mobile'),
386             ),
387             "$user" => array(
388                 '$mmUserDelegate_mmaBadges' => new lang_string('badges', 'badges'),
389                 '$mmUserDelegate_mmaCompetency:learningPlan' => new lang_string('competencies', 'competency'),
390                 '$mmUserDelegate_mmaCourseCompletion:viewCompletion' => new lang_string('coursecompletion', 'completion'),
391                 '$mmUserDelegate_mmaGrades:viewGrades' => new lang_string('grades', 'grades'),
392                 '$mmUserDelegate_mmaMessages:sendMessage' => new lang_string('sendmessage', 'message'),
393                 '$mmUserDelegate_mmaMessages:addContact' => new lang_string('addcontact', 'message'),
394                 '$mmUserDelegate_mmaMessages:blockContact' => new lang_string('blockcontact', 'message'),
395                 '$mmUserDelegate_mmaNotes:addNote' => new lang_string('addnewnote', 'notes'),
396                 '$mmUserDelegate_picture' => new lang_string('userpic'),
397             ),
398             "$files" => array(
399                 'files_privatefiles' => new lang_string('privatefiles'),
400                 'files_sitefiles' => new lang_string('sitefiles'),
401                 'files_upload' => new lang_string('upload'),
402             ),
403             "$modules" => $coursemodules,
404         );
406         if (!empty($remoteaddonslist)) {
407             $features["$remoteaddons"] = $remoteaddonslist;
408         }
410         return $features;
411     }
413     /**
414      * This function check the current site for potential configuration issues that may prevent the mobile app to work.
415      *
416      * @return array list of potential issues
417      * @since  Moodle 3.4
418      */
419     public static function get_potential_config_issues() {
420         global $CFG;
421         require_once($CFG->dirroot . "/lib/filelib.php");
422         require_once($CFG->dirroot . '/message/lib.php');
424         $warnings = array();
426         $curl = new curl();
427         // Return certificate information and verify the certificate.
428         $curl->setopt(array('CURLOPT_CERTINFO' => 1, 'CURLOPT_SSL_VERIFYPEER' => true));
429         $httpswwwroot = str_replace('http:', 'https:', $CFG->wwwroot); // Force https url.
430         // Check https using a page not redirecting or returning exceptions.
431         $curl->head($httpswwwroot . "/$CFG->admin/tool/mobile/mobile.webmanifest.php");
432         $info = $curl->get_info();
434         // First of all, check the server certificate (if any).
435         if (empty($info['http_code']) or ($info['http_code'] >= 400)) {
436             $warnings[] = ['nohttpsformobilewarning', 'admin'];
437         } else {
438             // Check the certificate is not self-signed or has an untrusted-root.
439             // This may be weak in some scenarios (when the curl SSL verifier is outdated).
440             if (empty($info['certinfo'])) {
441                 $warnings[] = ['selfsignedoruntrustedcertificatewarning', 'tool_mobile'];
442             } else {
443                 $timenow = time();
444                 $expectedissuer = null;
445                 foreach ($info['certinfo'] as $cert) {
446                     // Check if the signature algorithm is weak (Android won't work with SHA-1).
447                     if ($cert['Signature Algorithm'] == 'sha1WithRSAEncryption' || $cert['Signature Algorithm'] == 'sha1WithRSA') {
448                         $warnings[] = ['insecurealgorithmwarning', 'tool_mobile'];
449                     }
450                     // Check certificate start date.
451                     if (strtotime($cert['Start date']) > $timenow) {
452                         $warnings[] = ['invalidcertificatestartdatewarning', 'tool_mobile'];
453                     }
454                     // Check certificate end date.
455                     if (strtotime($cert['Expire date']) < $timenow) {
456                         $warnings[] = ['invalidcertificateexpiredatewarning', 'tool_mobile'];
457                     }
458                     // Check the chain.
459                     if ($expectedissuer !== null) {
460                         if ($expectedissuer !== $cert['Subject'] || $cert['Subject'] === $cert['Issuer']) {
461                             $warnings[] = ['invalidcertificatechainwarning', 'tool_mobile'];
462                         }
463                     }
464                     $expectedissuer = $cert['Issuer'];
465                 }
466             }
467         }
468         // Now check typical configuration problems.
469         if ((int) $CFG->userquota === PHP_INT_MAX) {
470             // In old Moodle version was a text so was possible to have numeric values > PHP_INT_MAX.
471             $warnings[] = ['invaliduserquotawarning', 'tool_mobile'];
472         }
473         // Check ADOdb debug enabled.
474         if (get_config('auth_db', 'debugauthdb') || get_config('enrol_database', 'debugdb')) {
475             $warnings[] = ['adodbdebugwarning', 'tool_mobile'];
476         }
477         // Check display errors on.
478         if (!empty($CFG->debugdisplay)) {
479             $warnings[] = ['displayerrorswarning', 'tool_mobile'];
480         }
481         // Check mobile notifications.
482         $processors = get_message_processors();
483         $enabled = false;
484         foreach ($processors as $processor => $status) {
485             if ($processor == 'airnotifier' && $status->enabled) {
486                 $enabled = true;
487             }
488         }
489         if (!$enabled) {
490             $warnings[] = ['mobilenotificationsdisabledwarning', 'tool_mobile'];
491         }
493         return $warnings;
494     }