0fd5f72cd552b25542c038efc8ea77767188c540
[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;
34 use core_qrcode;
35 use stdClass;
37 /**
38  * API exposed by tool_mobile, to be used mostly by external functions and the plugin settings.
39  *
40  * @copyright  2016 Juan Leyva
41  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
42  * @since      Moodle 3.1
43  */
44 class api {
46     /** @var int to identify the login via app. */
47     const LOGIN_VIA_APP = 1;
48     /** @var int to identify the login via browser. */
49     const LOGIN_VIA_BROWSER = 2;
50     /** @var int to identify the login via an embedded browser. */
51     const LOGIN_VIA_EMBEDDED_BROWSER = 3;
52     /** @var int seconds an auto-login key will expire. */
53     const LOGIN_KEY_TTL = 60;
54     /** @var string URL of the Moodle Apps Portal */
55     const MOODLE_APPS_PORTAL_URL = 'https://apps.moodle.com';
56     /** @var int seconds a QR login key will expire. */
57     const LOGIN_QR_KEY_TTL = 600;
58     /** @var int QR code disabled value */
59     const QR_CODE_DISABLED = 0;
60     /** @var int QR code type URL value */
61     const QR_CODE_URL = 1;
62     /** @var int QR code type login value */
63     const QR_CODE_LOGIN = 2;
64     /** @var string Default Android app id */
65     const DEFAULT_ANDROID_APP_ID = 'com.moodle.moodlemobile';
66     /** @var string Default iOS app id */
67     const DEFAULT_IOS_APP_ID = '633359593';
69     /**
70      * Returns a list of Moodle plugins supporting the mobile app.
71      *
72      * @return array an array of objects containing the plugin information
73      */
74     public static function get_plugins_supporting_mobile() {
75         global $CFG;
76         require_once($CFG->libdir . '/adminlib.php');
78         $cachekey = 'mobileplugins';
79         if (!isloggedin()) {
80             $cachekey = 'authmobileplugins';    // Use a different cache for not logged users.
81         }
83         // Check if we can return this from cache.
84         $cache = \cache::make('tool_mobile', 'plugininfo');
85         $pluginsinfo = $cache->get($cachekey);
86         if ($pluginsinfo !== false) {
87             return (array)$pluginsinfo;
88         }
90         $pluginsinfo = [];
91         // For not logged users return only auth plugins.
92         // This is to avoid anyone (not being a registered user) to obtain and download all the site remote add-ons.
93         if (!isloggedin()) {
94             $plugintypes = array('auth' => $CFG->dirroot.'/auth');
95         } else {
96             $plugintypes = core_component::get_plugin_types();
97         }
99         foreach ($plugintypes as $plugintype => $unused) {
100             // We need to include files here.
101             $pluginswithfile = core_component::get_plugin_list_with_file($plugintype, 'db' . DIRECTORY_SEPARATOR . 'mobile.php');
102             foreach ($pluginswithfile as $plugin => $notused) {
103                 $path = core_component::get_plugin_directory($plugintype, $plugin);
104                 $component = $plugintype . '_' . $plugin;
105                 $version = get_component_version($component);
107                 require("$path/db/mobile.php");
108                 foreach ($addons as $addonname => $addoninfo) {
110                     // Add handlers (for site add-ons).
111                     $handlers = !empty($addoninfo['handlers']) ? $addoninfo['handlers'] : array();
112                     $handlers = json_encode($handlers); // JSON formatted, since it is a complex structure that may vary over time.
114                     // Now language strings used by the app.
115                     $lang = array();
116                     if (!empty($addoninfo['lang'])) {
117                         $stringmanager = get_string_manager();
118                         $langs = $stringmanager->get_list_of_translations(true);
119                         foreach ($langs as $langid => $langname) {
120                             foreach ($addoninfo['lang'] as $stringinfo) {
121                                 $lang[$langid][$stringinfo[0]] =
122                                     $stringmanager->get_string($stringinfo[0], $stringinfo[1], null, $langid);
123                             }
124                         }
125                     }
126                     $lang = json_encode($lang);
128                     $plugininfo = array(
129                         'component' => $component,
130                         'version' => $version,
131                         'addon' => $addonname,
132                         'dependencies' => !empty($addoninfo['dependencies']) ? $addoninfo['dependencies'] : array(),
133                         'fileurl' => '',
134                         'filehash' => '',
135                         'filesize' => 0,
136                         'handlers' => $handlers,
137                         'lang' => $lang,
138                     );
140                     // All the mobile packages must be under the plugin mobile directory.
141                     $package = $path . '/mobile/' . $addonname . '.zip';
142                     if (file_exists($package)) {
143                         $plugininfo['fileurl'] = $CFG->wwwroot . '' . str_replace($CFG->dirroot, '', $package);
144                         $plugininfo['filehash'] = sha1_file($package);
145                         $plugininfo['filesize'] = filesize($package);
146                     }
147                     $pluginsinfo[] = $plugininfo;
148                 }
149             }
150         }
152         $cache->set($cachekey, $pluginsinfo);
154         return $pluginsinfo;
155     }
157     /**
158      * Returns a list of the site public settings, those not requiring authentication.
159      *
160      * @return array with the settings and warnings
161      */
162     public static function get_public_config() {
163         global $CFG, $SITE, $PAGE, $OUTPUT;
164         require_once($CFG->libdir . '/authlib.php');
166         $context = context_system::instance();
167         // We need this to make work the format text functions.
168         $PAGE->set_context($context);
170         list($authinstructions, $notusedformat) = external_format_text($CFG->auth_instructions, FORMAT_MOODLE, $context->id);
171         list($maintenancemessage, $notusedformat) = external_format_text($CFG->maintenance_message, FORMAT_MOODLE, $context->id);
172         $settings = array(
173             'wwwroot' => $CFG->wwwroot,
174             'httpswwwroot' => $CFG->wwwroot,
175             'sitename' => external_format_string($SITE->fullname, $context->id, true),
176             'guestlogin' => $CFG->guestloginbutton,
177             'rememberusername' => $CFG->rememberusername,
178             'authloginviaemail' => $CFG->authloginviaemail,
179             'registerauth' => $CFG->registerauth,
180             'forgottenpasswordurl' => clean_param($CFG->forgottenpasswordurl, PARAM_URL), // We may expect a mailto: here.
181             'authinstructions' => $authinstructions,
182             'authnoneenabled' => (int) is_enabled_auth('none'),
183             'enablewebservices' => $CFG->enablewebservices,
184             'enablemobilewebservice' => $CFG->enablemobilewebservice,
185             'maintenanceenabled' => $CFG->maintenance_enabled,
186             'maintenancemessage' => $maintenancemessage,
187             'mobilecssurl' => !empty($CFG->mobilecssurl) ? $CFG->mobilecssurl : '',
188             'tool_mobile_disabledfeatures' => get_config('tool_mobile', 'disabledfeatures'),
189             'country' => clean_param($CFG->country, PARAM_NOTAGS),
190             'agedigitalconsentverification' => \core_auth\digital_consent::is_age_digital_consent_verification_enabled(),
191             'autolang' => $CFG->autolang,
192             'lang' => clean_param($CFG->lang, PARAM_LANG),  // Avoid breaking WS because of incorrect package langs.
193             'langmenu' => $CFG->langmenu,
194             'langlist' => $CFG->langlist,
195             'locale' => $CFG->locale,
196             'tool_mobile_minimumversion' => get_config('tool_mobile', 'minimumversion'),
197             'tool_mobile_iosappid' => get_config('tool_mobile', 'iosappid'),
198             'tool_mobile_androidappid' => get_config('tool_mobile', 'androidappid'),
199             'tool_mobile_setuplink' => clean_param(get_config('tool_mobile', 'setuplink'), PARAM_URL),
200         );
202         $typeoflogin = get_config('tool_mobile', 'typeoflogin');
203         // Not found, edge case.
204         if ($typeoflogin === false) {
205             $typeoflogin = self::LOGIN_VIA_APP; // Defaults to via app.
206         }
207         $settings['typeoflogin'] = $typeoflogin;
209         // Check if the user can sign-up to return the launch URL in that case.
210         $cansignup = signup_is_enabled();
212         $url = new moodle_url("/$CFG->admin/tool/mobile/launch.php");
213         $settings['launchurl'] = $url->out(false);
215         // Check that we are receiving a moodle_url object, themes can override get_logo_url and may return incorrect values.
216         if (($logourl = $OUTPUT->get_logo_url()) && $logourl instanceof moodle_url) {
217             $settings['logourl'] = clean_param($logourl->out(false), PARAM_URL);
218         }
219         if (($compactlogourl = $OUTPUT->get_compact_logo_url()) && $compactlogourl instanceof moodle_url) {
220             $settings['compactlogourl'] = clean_param($compactlogourl->out(false), PARAM_URL);
221         }
223         // Identity providers.
224         $authsequence = get_enabled_auth_plugins(true);
225         $identityproviders = \auth_plugin_base::get_identity_providers($authsequence);
226         $identityprovidersdata = \auth_plugin_base::prepare_identity_providers_for_output($identityproviders, $OUTPUT);
227         if (!empty($identityprovidersdata)) {
228             $settings['identityproviders'] = $identityprovidersdata;
229             // Clean URLs to avoid breaking Web Services.
230             // We can't do it in prepare_identity_providers_for_output() because it may break the web output.
231             foreach ($settings['identityproviders'] as &$ip) {
232                 $ip['url'] = (!empty($ip['url'])) ? clean_param($ip['url'], PARAM_URL) : '';
233                 $ip['iconurl'] = (!empty($ip['iconurl'])) ? clean_param($ip['iconurl'], PARAM_URL) : '';
234             }
235         }
237         // If age is verified, return also the admin contact details.
238         if ($settings['agedigitalconsentverification']) {
239             $settings['supportname'] = clean_param($CFG->supportname, PARAM_NOTAGS);
240             $settings['supportemail'] = clean_param($CFG->supportemail, PARAM_EMAIL);
241         }
243         return $settings;
244     }
246     /**
247      * Returns a list of site configurations, filtering by section.
248      *
249      * @param  string $section section name
250      * @return stdClass object containing the settings
251      */
252     public static function get_config($section) {
253         global $CFG, $SITE;
255         $settings = new \stdClass;
256         $context = context_system::instance();
257         $isadmin = has_capability('moodle/site:config', $context);
259         if (empty($section) or $section == 'frontpagesettings') {
260             require_once($CFG->dirroot . '/course/format/lib.php');
261             // First settings that anyone can deduce.
262             $settings->fullname = external_format_string($SITE->fullname, $context->id);
263             $settings->shortname = external_format_string($SITE->shortname, $context->id);
265             // Return to a var instead of directly to $settings object because of differences between
266             // list() in php5 and php7. {@link http://php.net/manual/en/function.list.php}
267             $formattedsummary = external_format_text($SITE->summary, $SITE->summaryformat,
268                                                                                         $context->id);
269             $settings->summary = $formattedsummary[0];
270             $settings->summaryformat = $formattedsummary[1];
271             $settings->frontpage = $CFG->frontpage;
272             $settings->frontpageloggedin = $CFG->frontpageloggedin;
273             $settings->maxcategorydepth = $CFG->maxcategorydepth;
274             $settings->frontpagecourselimit = $CFG->frontpagecourselimit;
275             $settings->numsections = course_get_format($SITE)->get_last_section_number();
276             $settings->newsitems = $SITE->newsitems;
277             $settings->commentsperpage = $CFG->commentsperpage;
279             // Now, admin settings.
280             if ($isadmin) {
281                 $settings->defaultfrontpageroleid = $CFG->defaultfrontpageroleid;
282             }
283         }
285         if (empty($section) or $section == 'sitepolicies') {
286             $manager = new \core_privacy\local\sitepolicy\manager();
287             $settings->sitepolicy = ($sitepolicy = $manager->get_embed_url()) ? $sitepolicy->out(false) : '';
288             $settings->sitepolicyhandler = $CFG->sitepolicyhandler;
289             $settings->disableuserimages = $CFG->disableuserimages;
290         }
292         if (empty($section) or $section == 'gradessettings') {
293             require_once($CFG->dirroot . '/user/lib.php');
294             $settings->mygradesurl = user_mygrades_url();
295             // The previous function may return moodle_url instances or plain string URLs.
296             if ($settings->mygradesurl instanceof moodle_url) {
297                 $settings->mygradesurl = $settings->mygradesurl->out(false);
298             }
299         }
301         if (empty($section) or $section == 'mobileapp') {
302             $settings->tool_mobile_forcelogout = get_config('tool_mobile', 'forcelogout');
303             $settings->tool_mobile_customlangstrings = get_config('tool_mobile', 'customlangstrings');
304             $settings->tool_mobile_disabledfeatures = get_config('tool_mobile', 'disabledfeatures');
305             $settings->tool_mobile_filetypeexclusionlist = get_config('tool_mobile', 'filetypeexclusionlist');
306             $settings->tool_mobile_custommenuitems = get_config('tool_mobile', 'custommenuitems');
307             $settings->tool_mobile_apppolicy = get_config('tool_mobile', 'apppolicy');
308         }
310         if (empty($section) or $section == 'calendar') {
311             $settings->calendartype = $CFG->calendartype;
312             $settings->calendar_site_timeformat = $CFG->calendar_site_timeformat;
313             $settings->calendar_startwday = $CFG->calendar_startwday;
314             $settings->calendar_adminseesall = $CFG->calendar_adminseesall;
315             $settings->calendar_lookahead = $CFG->calendar_lookahead;
316             $settings->calendar_maxevents = $CFG->calendar_maxevents;
317         }
319         if (empty($section) or $section == 'coursecolors') {
320             $colornumbers = range(1, 10);
321             foreach ($colornumbers as $number) {
322                 $settings->{'core_admin_coursecolor' . $number} = get_config('core_admin', 'coursecolor' . $number);
323             }
324         }
326         return $settings;
327     }
329     /*
330      * Check if all the required conditions are met to allow the auto-login process continue.
331      *
332      * @param  int $userid  current user id
333      * @since Moodle 3.2
334      * @throws moodle_exception
335      */
336     public static function check_autologin_prerequisites($userid) {
337         global $CFG;
339         if (!$CFG->enablewebservices or !$CFG->enablemobilewebservice) {
340             throw new moodle_exception('enablewsdescription', 'webservice');
341         }
343         if (!is_https()) {
344             throw new moodle_exception('httpsrequired', 'tool_mobile');
345         }
347         if (has_capability('moodle/site:config', context_system::instance(), $userid) or is_siteadmin($userid)) {
348             throw new moodle_exception('autologinnotallowedtoadmins', 'tool_mobile');
349         }
350     }
352     /**
353      * Creates an auto-login key for the current user, this key is restricted by time and ip address.
354      * This key is used for automatically login the user in the site when the Moodle app opens the site in a mobile browser.
355      *
356      * @return string the key
357      * @since Moodle 3.2
358      */
359     public static function get_autologin_key() {
360         global $USER;
361         // Delete previous keys.
362         delete_user_key('tool_mobile', $USER->id);
364         // Create a new key.
365         $iprestriction = getremoteaddr();
366         $validuntil = time() + self::LOGIN_KEY_TTL;
367         return create_user_key('tool_mobile', $USER->id, null, $iprestriction, $validuntil);
368     }
370     /**
371      * Creates a QR login key for the current user, this key is restricted by time and ip address.
372      * This key is used for automatically login the user in the site when the user scans a QR code in the Moodle app.
373      *
374      * @return string the key
375      * @since Moodle 3.9
376      */
377     public static function get_qrlogin_key() {
378         global $USER;
379         // Delete previous keys.
380         delete_user_key('tool_mobile', $USER->id);
382         // Create a new key.
383         $iprestriction = getremoteaddr(null);
384         $validuntil = time() + self::LOGIN_QR_KEY_TTL;
385         return create_user_key('tool_mobile', $USER->id, null, $iprestriction, $validuntil);
386     }
388     /**
389      * Get a list of the Mobile app features.
390      *
391      * @return array array with the features grouped by theirs ubication in the app.
392      * @since Moodle 3.3
393      */
394     public static function get_features_list() {
395         global $CFG;
396         require_once($CFG->libdir . '/authlib.php');
398         $general = new lang_string('general');
399         $mainmenu = new lang_string('mainmenu', 'tool_mobile');
400         $course = new lang_string('course');
401         $modules = new lang_string('managemodules');
402         $blocks = new lang_string('blocks');
403         $user = new lang_string('user');
404         $files = new lang_string('files');
405         $remoteaddons = new lang_string('remoteaddons', 'tool_mobile');
406         $identityproviders = new lang_string('oauth2identityproviders', 'tool_mobile');
408         $availablemods = core_plugin_manager::instance()->get_plugins_of_type('mod');
409         $coursemodules = array();
410         $appsupportedmodules = array(
411             'assign', 'book', 'chat', 'choice', 'data', 'feedback', 'folder', 'forum', 'glossary', 'h5pactivity', 'imscp',
412             'label', 'lesson', 'lti', 'page', 'quiz', 'resource', 'scorm', 'survey', 'url', 'wiki', 'workshop');
414         foreach ($availablemods as $mod) {
415             if (in_array($mod->name, $appsupportedmodules)) {
416                 $coursemodules['$mmCourseDelegate_mmaMod' . ucfirst($mod->name)] = $mod->displayname;
417             }
418         }
419         asort($coursemodules);
421         $remoteaddonslist = array();
422         $mobileplugins = self::get_plugins_supporting_mobile();
423         foreach ($mobileplugins as $plugin) {
424             $displayname = core_plugin_manager::instance()->plugin_name($plugin['component']) . " - " . $plugin['addon'];
425             $remoteaddonslist['sitePlugin_' . $plugin['component'] . '_' . $plugin['addon']] = $displayname;
427         }
429         // Display blocks.
430         $availableblocks = core_plugin_manager::instance()->get_plugins_of_type('block');
431         $courseblocks = array();
432         $appsupportedblocks = array(
433             'activity_modules' => 'CoreBlockDelegate_AddonBlockActivityModules',
434             'activity_results' => 'CoreBlockDelegate_AddonBlockActivityResults',
435             'site_main_menu' => 'CoreBlockDelegate_AddonBlockSiteMainMenu',
436             'myoverview' => 'CoreBlockDelegate_AddonBlockMyOverview',
437             'timeline' => 'CoreBlockDelegate_AddonBlockTimeline',
438             'recentlyaccessedcourses' => 'CoreBlockDelegate_AddonBlockRecentlyAccessedCourses',
439             'starredcourses' => 'CoreBlockDelegate_AddonBlockStarredCourses',
440             'recentlyaccesseditems' => 'CoreBlockDelegate_AddonBlockRecentlyAccessedItems',
441             'badges' => 'CoreBlockDelegate_AddonBlockBadges',
442             'blog_menu' => 'CoreBlockDelegate_AddonBlockBlogMenu',
443             'blog_recent' => 'CoreBlockDelegate_AddonBlockBlogRecent',
444             'blog_tags' => 'CoreBlockDelegate_AddonBlockBlogTags',
445             'calendar_month' => 'CoreBlockDelegate_AddonBlockCalendarMonth',
446             'calendar_upcoming' => 'CoreBlockDelegate_AddonBlockCalendarUpcoming',
447             'comments' => 'CoreBlockDelegate_AddonBlockComments',
448             'completionstatus' => 'CoreBlockDelegate_AddonBlockCompletionStatus',
449             'feedback' => 'CoreBlockDelegate_AddonBlockFeedback',
450             'glossary_random' => 'CoreBlockDelegate_AddonBlockGlossaryRandom',
451             'html' => 'CoreBlockDelegate_AddonBlockHtml',
452             'lp' => 'CoreBlockDelegate_AddonBlockLp',
453             'news_items' => 'CoreBlockDelegate_AddonBlockNewsItems',
454             'online_users' => 'CoreBlockDelegate_AddonBlockOnlineUsers',
455             'selfcompletion' => 'CoreBlockDelegate_AddonBlockSelfCompletion',
456             'tags' => 'CoreBlockDelegate_AddonBlockTags',
457         );
459         foreach ($availableblocks as $block) {
460             if (isset($appsupportedblocks[$block->name])) {
461                 $courseblocks[$appsupportedblocks[$block->name]] = $block->displayname;
462             }
463         }
464         asort($courseblocks);
466         $features = array(
467             "$general" => array(
468                 'NoDelegate_CoreOffline' => new lang_string('offlineuse', 'tool_mobile'),
469                 'NoDelegate_SiteBlocks' => new lang_string('blocks'),
470                 'NoDelegate_CoreComments' => new lang_string('comments'),
471                 'NoDelegate_CoreRating' => new lang_string('ratings', 'rating'),
472                 'NoDelegate_CoreTag' => new lang_string('tags'),
473                 '$mmLoginEmailSignup' => new lang_string('startsignup'),
474                 'NoDelegate_ForgottenPassword' => new lang_string('forgotten'),
475                 'NoDelegate_ResponsiveMainMenuItems' => new lang_string('responsivemainmenuitems', 'tool_mobile'),
476                 'NoDelegate_H5POffline' => new lang_string('h5poffline', 'tool_mobile'),
477                 'NoDelegate_DarkMode' => new lang_string('darkmode', 'tool_mobile'),
478                 'CoreFilterDelegate' => new lang_string('type_filter_plural', 'plugin'),
479             ),
480             "$mainmenu" => array(
481                 '$mmSideMenuDelegate_mmaFrontpage' => new lang_string('sitehome'),
482                 '$mmSideMenuDelegate_mmCourses' => new lang_string('mycourses'),
483                 'CoreMainMenuDelegate_CoreCoursesDashboard' => new lang_string('myhome'),
484                 '$mmSideMenuDelegate_mmaCalendar' => new lang_string('calendar', 'calendar'),
485                 '$mmSideMenuDelegate_mmaNotifications' => new lang_string('notifications', 'message'),
486                 '$mmSideMenuDelegate_mmaMessages' => new lang_string('messages', 'message'),
487                 '$mmSideMenuDelegate_mmaGrades' => new lang_string('grades', 'grades'),
488                 '$mmSideMenuDelegate_mmaCompetency' => new lang_string('myplans', 'tool_lp'),
489                 'CoreMainMenuDelegate_AddonBlog' => new lang_string('blog', 'blog'),
490                 '$mmSideMenuDelegate_mmaFiles' => new lang_string('files'),
491                 'CoreMainMenuDelegate_CoreTag' => new lang_string('tags'),
492                 '$mmSideMenuDelegate_website' => new lang_string('webpage'),
493                 '$mmSideMenuDelegate_help' => new lang_string('help'),
494                 'CoreMainMenuDelegate_QrReader' => new lang_string('scanqrcode', 'tool_mobile'),
495             ),
496             "$course" => array(
497                 'NoDelegate_CourseBlocks' => new lang_string('blocks'),
498                 'CoreCourseOptionsDelegate_AddonBlog' => new lang_string('blog', 'blog'),
499                 '$mmCoursesDelegate_search' => new lang_string('search'),
500                 '$mmCoursesDelegate_mmaCompetency' => new lang_string('competencies', 'competency'),
501                 '$mmCoursesDelegate_mmaParticipants' => new lang_string('participants'),
502                 '$mmCoursesDelegate_mmaGrades' => new lang_string('grades', 'grades'),
503                 '$mmCoursesDelegate_mmaCourseCompletion' => new lang_string('coursecompletion', 'completion'),
504                 '$mmCoursesDelegate_mmaNotes' => new lang_string('notes', 'notes'),
505                 'NoDelegate_CoreCourseDownload' => new lang_string('downloadcourse', 'tool_mobile'),
506                 'NoDelegate_CoreCoursesDownload' => new lang_string('downloadcourses', 'tool_mobile'),
507             ),
508             "$user" => array(
509                 'CoreUserDelegate_AddonBlog:blogs' => new lang_string('blog', 'blog'),
510                 '$mmUserDelegate_mmaBadges' => new lang_string('badges', 'badges'),
511                 '$mmUserDelegate_mmaCompetency:learningPlan' => new lang_string('competencies', 'competency'),
512                 '$mmUserDelegate_mmaCourseCompletion:viewCompletion' => new lang_string('coursecompletion', 'completion'),
513                 '$mmUserDelegate_mmaGrades:viewGrades' => new lang_string('grades', 'grades'),
514                 '$mmUserDelegate_mmaMessages:sendMessage' => new lang_string('sendmessage', 'message'),
515                 '$mmUserDelegate_mmaMessages:addContact' => new lang_string('addcontact', 'message'),
516                 '$mmUserDelegate_mmaMessages:blockContact' => new lang_string('blockcontact', 'message'),
517                 '$mmUserDelegate_mmaNotes:addNote' => new lang_string('addnewnote', 'notes'),
518                 '$mmUserDelegate_picture' => new lang_string('userpic'),
519             ),
520             "$files" => array(
521                 'files_privatefiles' => new lang_string('privatefiles'),
522                 'files_sitefiles' => new lang_string('sitefiles'),
523                 'files_upload' => new lang_string('upload'),
524             ),
525             "$modules" => $coursemodules,
526             "$blocks" => $courseblocks,
527         );
529         if (!empty($remoteaddonslist)) {
530             $features["$remoteaddons"] = $remoteaddonslist;
531         }
533         if (!empty($availablemods['lti'])) {
534             $ltidisplayname = $availablemods['lti']->displayname;
535             $features["$ltidisplayname"]['CoreCourseModuleDelegate_AddonModLti:openInAppBrowser'] =
536                 new lang_string('openusingembeddedbrowser', 'tool_mobile');
537         }
539         // Display OAuth 2 identity providers.
540         if (is_enabled_auth('oauth2')) {
541             $identityproviderslist = array();
542             $idps = \auth_plugin_base::get_identity_providers(['oauth2']);
544             foreach ($idps as $idp) {
545                 // Only add identity providers that have an ID.
546                 $id = isset($idp['url']) ? $idp['url']->get_param('id') : null;
547                 if ($id != null) {
548                     $identityproviderslist['NoDelegate_IdentityProvider_' . $id] = $idp['name'];
549                 }
550             }
552             if (!empty($identityproviderslist)) {
553                 $features["$identityproviders"] = array();
555                 if (count($identityproviderslist) > 1) {
556                     // Include an option to disable them all.
557                     $features["$identityproviders"]['NoDelegate_IdentityProviders'] = new lang_string('all');
558                 }
560                 $features["$identityproviders"] = array_merge($features["$identityproviders"], $identityproviderslist);
561             }
562         }
564         return $features;
565     }
567     /**
568      * This function check the current site for potential configuration issues that may prevent the mobile app to work.
569      *
570      * @return array list of potential issues
571      * @since  Moodle 3.4
572      */
573     public static function get_potential_config_issues() {
574         global $CFG;
575         require_once($CFG->dirroot . "/lib/filelib.php");
576         require_once($CFG->dirroot . '/message/lib.php');
578         $warnings = array();
580         $curl = new curl();
581         // Return certificate information and verify the certificate.
582         $curl->setopt(array('CURLOPT_CERTINFO' => 1, 'CURLOPT_SSL_VERIFYPEER' => true));
583         $httpswwwroot = str_replace('http:', 'https:', $CFG->wwwroot); // Force https url.
584         // Check https using a page not redirecting or returning exceptions.
585         $curl->head($httpswwwroot . "/$CFG->admin/tool/mobile/mobile.webmanifest.php");
586         $info = $curl->get_info();
588         // First of all, check the server certificate (if any).
589         if (empty($info['http_code']) or ($info['http_code'] >= 400)) {
590             $warnings[] = ['nohttpsformobilewarning', 'admin'];
591         } else {
592             // Check the certificate is not self-signed or has an untrusted-root.
593             // This may be weak in some scenarios (when the curl SSL verifier is outdated).
594             if (empty($info['certinfo'])) {
595                 $warnings[] = ['selfsignedoruntrustedcertificatewarning', 'tool_mobile'];
596             } else {
597                 $timenow = time();
598                 $expectedissuer = null;
599                 foreach ($info['certinfo'] as $cert) {
600                     // Check if the signature algorithm is weak (Android won't work with SHA-1).
601                     if ($cert['Signature Algorithm'] == 'sha1WithRSAEncryption' || $cert['Signature Algorithm'] == 'sha1WithRSA') {
602                         $warnings[] = ['insecurealgorithmwarning', 'tool_mobile'];
603                     }
604                     // Check certificate start date.
605                     if (strtotime($cert['Start date']) > $timenow) {
606                         $warnings[] = ['invalidcertificatestartdatewarning', 'tool_mobile'];
607                     }
608                     // Check certificate end date.
609                     if (strtotime($cert['Expire date']) < $timenow) {
610                         $warnings[] = ['invalidcertificateexpiredatewarning', 'tool_mobile'];
611                     }
612                     // Check the chain.
613                     if ($expectedissuer !== null) {
614                         if ($expectedissuer !== $cert['Subject'] || $cert['Subject'] === $cert['Issuer']) {
615                             $warnings[] = ['invalidcertificatechainwarning', 'tool_mobile'];
616                         }
617                     }
618                     $expectedissuer = $cert['Issuer'];
619                 }
620             }
621         }
622         // Now check typical configuration problems.
623         if ((int) $CFG->userquota === PHP_INT_MAX) {
624             // In old Moodle version was a text so was possible to have numeric values > PHP_INT_MAX.
625             $warnings[] = ['invaliduserquotawarning', 'tool_mobile'];
626         }
627         // Check ADOdb debug enabled.
628         if (get_config('auth_db', 'debugauthdb') || get_config('enrol_database', 'debugdb')) {
629             $warnings[] = ['adodbdebugwarning', 'tool_mobile'];
630         }
631         // Check display errors on.
632         if (!empty($CFG->debugdisplay)) {
633             $warnings[] = ['displayerrorswarning', 'tool_mobile'];
634         }
635         // Check mobile notifications.
636         $processors = get_message_processors();
637         $enabled = false;
638         foreach ($processors as $processor => $status) {
639             if ($processor == 'airnotifier' && $status->enabled) {
640                 $enabled = true;
641             }
642         }
643         if (!$enabled) {
644             $warnings[] = ['mobilenotificationsdisabledwarning', 'tool_mobile'];
645         }
647         return $warnings;
648     }
650     /**
651      * Generates a QR code with the site URL or for automatic login from the mobile app.
652      *
653      * @param  stdClass $mobilesettings tool_mobile settings
654      * @return string base64 data image contents, null if qr disabled
655      */
656     public static function generate_login_qrcode(stdClass $mobilesettings) {
657         global $CFG, $USER;
659         if ($mobilesettings->qrcodetype == static::QR_CODE_DISABLED) {
660             return null;
661         }
663         $urlscheme = !empty($mobilesettings->forcedurlscheme) ? $mobilesettings->forcedurlscheme : 'moodlemobile';
664         $data = $urlscheme . '://' . $CFG->wwwroot;
666         if ($mobilesettings->qrcodetype == static::QR_CODE_LOGIN) {
667             $qrloginkey = static::get_qrlogin_key();
668             $data .= '?qrlogin=' . $qrloginkey . '&userid=' . $USER->id;
669         }
671         $qrcode = new core_qrcode($data);
672         $imagedata = 'data:image/png;base64,' . base64_encode($qrcode->getBarcodePngData(5, 5));
674         return $imagedata;
675     }
677     /**
678      * Gets Moodle app plan subscription information for the current site as it is returned by the Apps Portal.
679      *
680      * @return array Subscription information
681      */
682     public static function get_subscription_information() : ?array {
683         global $CFG;
685         // Use session cache to prevent multiple requests.
686         $cache = \cache::make('tool_mobile', 'subscriptiondata');
687         $subscriptiondata = $cache->get(0);
688         if ($subscriptiondata !== false) {
689             return $subscriptiondata;
690         }
692         $mobilesettings = get_config('tool_mobile');
694         // To validate that the requests come from this site we need to send some private information that only is known by the
695         // Moodle Apps portal or the Sites registration database.
696         $credentials = [];
698         if (!empty($CFG->airnotifieraccesskey)) {
699             $credentials[] = ['type' => 'airnotifieraccesskey', 'value' => $CFG->airnotifieraccesskey];
700         }
701         if (\core\hub\registration::is_registered()) {
702             $credentials[] = ['type' => 'siteid', 'value' => $CFG->siteidentifier];
703         }
704         // Generate a hash key for validating that the request is coming from this site via WS.
705         $key = complex_random_string(32);
706         $sitesubscriptionkey = json_encode(['validuntil' => time() + 10 * MINSECS, 'key' => $key]);
707         set_config('sitesubscriptionkey', $sitesubscriptionkey, 'tool_mobile');
708         $credentials[] = ['type' => 'sitesubscriptionkey', 'value' => $key];
710         // Parameters for the WebService returning site information.
711         $androidappid = empty($mobilesettings->androidappid) ? static::DEFAULT_ANDROID_APP_ID : $mobilesettings->androidappid;
712         $iosappid = empty($mobilesettings->iosappid) ? static::DEFAULT_IOS_APP_ID : $mobilesettings->iosappid;
713         $fnparams = (object) [
714             'siteurl' => $CFG->wwwroot,
715             'appids' => [$androidappid, $iosappid],
716             'credentials' => $credentials,
717         ];
718         // Prepare the arguments for a request to the AJAX nologin endpoint.
719         $args = [
720             (object) [
721                 'index' => 0,
722                 'methodname' => 'local_apps_get_site_info',
723                 'args' => $fnparams,
724             ]
725         ];
727         // Ask the Moodle Apps Portal for the subscription information.
728         $curl = new curl();
729         $curl->setopt(array('CURLOPT_TIMEOUT' => 10, 'CURLOPT_CONNECTTIMEOUT' => 10));
731         $serverurl = static::MOODLE_APPS_PORTAL_URL . "/lib/ajax/service-nologin.php";
732         $query = 'args=' . urlencode(json_encode($args));
733         $wsresponse = @json_decode($curl->post($serverurl, $query), true);
735         $info = $curl->get_info();
736         if ($curlerrno = $curl->get_errno()) {
737             // CURL connection error.
738             debugging("Unexpected response from the Moodle Apps Portal server, CURL error number: $curlerrno");
739             return null;
740         } else if ($info['http_code'] != 200) {
741             // Unexpected error from server.
742             debugging('Unexpected response from the Moodle Apps Portal server, HTTP code:' . $info['httpcode']);
743             return null;
744         } else if (!empty($wsresponse[0]['error'])) {
745             // Unexpected error from Moodle Apps Portal.
746             debugging('Unexpected response from the Moodle Apps Portal server:' . json_encode($wsresponse[0]));
747             return null;
748         } else if (empty($wsresponse[0]['data'])) {
749             debugging('Unexpected response from the Moodle Apps Portal server:' . json_encode($wsresponse));
750             return null;
751         }
753         $cache->set(0, $wsresponse[0]['data']);
755         return $wsresponse[0]['data'];
756     }