Moodle release 3.8beta
[moodle.git] / admin / tool / mobile / classes / api.php
CommitLineData
b2478ed0
JL
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/>.
16
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 */
25namespace tool_mobile;
26
27use core_component;
28use core_plugin_manager;
0002056f 29use context_system;
c951f1fe 30use moodle_url;
961c9549 31use moodle_exception;
b2551b4c 32use lang_string;
66a159f8 33use curl;
b2478ed0
JL
34
35/**
b2551b4c 36 * API exposed by tool_mobile, to be used mostly by external functions and the plugin settings.
b2478ed0
JL
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 */
42class api {
43
c951f1fe
JL
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;
961c9549
JL
50 /** @var int seconds an auto-login key will expire. */
51 const LOGIN_KEY_TTL = 60;
c951f1fe 52
b2478ed0
JL
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');
61
7b1c55ea
JL
62 $cachekey = 'mobileplugins';
63 if (!isloggedin()) {
64 $cachekey = 'authmobileplugins'; // Use a different cache for not logged users.
65 }
66
30fccfcd
SK
67 // Check if we can return this from cache.
68 $cache = \cache::make('tool_mobile', 'plugininfo');
7b1c55ea 69 $pluginsinfo = $cache->get($cachekey);
30fccfcd
SK
70 if ($pluginsinfo !== false) {
71 return (array)$pluginsinfo;
72 }
73
b2478ed0 74 $pluginsinfo = [];
7b1c55ea
JL
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 }
b2478ed0
JL
82
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);
90
30fccfcd 91 require("$path/db/mobile.php");
b2478ed0 92 foreach ($addons as $addonname => $addoninfo) {
73d85fee
JL
93
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.
97
98 // Now language strings used by the app.
99 $lang = array();
100 if (!empty($addoninfo['lang'])) {
101 $stringmanager = get_string_manager();
8c5850a5 102 $langs = $stringmanager->get_list_of_translations(true);
73d85fee
JL
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);
111
b2478ed0
JL
112 $plugininfo = array(
113 'component' => $component,
114 'version' => $version,
115 'addon' => $addonname,
b4baee42 116 'dependencies' => !empty($addoninfo['dependencies']) ? $addoninfo['dependencies'] : array(),
b2478ed0
JL
117 'fileurl' => '',
118 'filehash' => '',
73d85fee
JL
119 'filesize' => 0,
120 'handlers' => $handlers,
121 'lang' => $lang,
b2478ed0
JL
122 );
123
124 // All the mobile packages must be under the plugin mobile directory.
1c668c3c 125 $package = $path . '/mobile/' . $addonname . '.zip';
b2478ed0
JL
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 }
30fccfcd 135
7b1c55ea 136 $cache->set($cachekey, $pluginsinfo);
30fccfcd 137
b2478ed0
JL
138 return $pluginsinfo;
139 }
140
0002056f
JL
141 /**
142 * Returns a list of the site public settings, those not requiring authentication.
143 *
144 * @return array with the settings and warnings
145 */
7c1cb3bf 146 public static function get_public_config() {
5d5e30c6 147 global $CFG, $SITE, $PAGE, $OUTPUT;
851b2919 148 require_once($CFG->libdir . '/authlib.php');
0002056f
JL
149
150 $context = context_system::instance();
151 // We need this to make work the format text functions.
152 $PAGE->set_context($context);
153
e2fe3bc0
JL
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);
0002056f
JL
156 $settings = array(
157 'wwwroot' => $CFG->wwwroot,
672f4836 158 'httpswwwroot' => $CFG->wwwroot,
0002056f
JL
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,
2479a7c4 164 'forgottenpasswordurl' => clean_param($CFG->forgottenpasswordurl, PARAM_URL), // We may expect a mailto: here.
e2fe3bc0 165 'authinstructions' => $authinstructions,
0002056f
JL
166 'authnoneenabled' => (int) is_enabled_auth('none'),
167 'enablewebservices' => $CFG->enablewebservices,
168 'enablemobilewebservice' => $CFG->enablemobilewebservice,
169 'maintenanceenabled' => $CFG->maintenance_enabled,
e2fe3bc0 170 'maintenancemessage' => $maintenancemessage,
91fff391 171 'mobilecssurl' => !empty($CFG->mobilecssurl) ? $CFG->mobilecssurl : '',
b2551b4c 172 'tool_mobile_disabledfeatures' => get_config('tool_mobile', 'disabledfeatures'),
8d9dc60b
JL
173 'country' => clean_param($CFG->country, PARAM_NOTAGS),
174 'agedigitalconsentverification' => \core_auth\digital_consent::is_age_digital_consent_verification_enabled(),
e236259d
JL
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,
4bf08f5b 180 'tool_mobile_minimumversion' => get_config('tool_mobile', 'minimumversion'),
12a289c7
JL
181 'tool_mobile_iosappid' => get_config('tool_mobile', 'iosappid'),
182 'tool_mobile_androidappid' => get_config('tool_mobile', 'androidappid'),
183 'tool_mobile_setuplink' => clean_param(get_config('tool_mobile', 'setuplink'), PARAM_URL),
0002056f 184 );
c951f1fe
JL
185
186 $typeoflogin = get_config('tool_mobile', 'typeoflogin');
187 // Not found, edge case.
188 if ($typeoflogin === false) {
189 $typeoflogin = self::LOGIN_VIA_APP; // Defaults to via app.
190 }
191 $settings['typeoflogin'] = $typeoflogin;
192
851b2919
JL
193 // Check if the user can sign-up to return the launch URL in that case.
194 $cansignup = signup_is_enabled();
195
b1037978
JL
196 $url = new moodle_url("/$CFG->admin/tool/mobile/launch.php");
197 $settings['launchurl'] = $url->out(false);
5d5e30c6 198
6703e031
JL
199 // Check that we are receiving a moodle_url object, themes can override get_logo_url and may return incorrect values.
200 if (($logourl = $OUTPUT->get_logo_url()) && $logourl instanceof moodle_url) {
818d40a9 201 $settings['logourl'] = clean_param($logourl->out(false), PARAM_URL);
5d5e30c6 202 }
6703e031 203 if (($compactlogourl = $OUTPUT->get_compact_logo_url()) && $compactlogourl instanceof moodle_url) {
818d40a9 204 $settings['compactlogourl'] = clean_param($compactlogourl->out(false), PARAM_URL);
5d5e30c6
JL
205 }
206
a67e3bda
JL
207 // Identity providers.
208 $authsequence = get_enabled_auth_plugins(true);
209 $identityproviders = \auth_plugin_base::get_identity_providers($authsequence);
210 $identityprovidersdata = \auth_plugin_base::prepare_identity_providers_for_output($identityproviders, $OUTPUT);
211 if (!empty($identityprovidersdata)) {
212 $settings['identityproviders'] = $identityprovidersdata;
62a08b1d
JL
213 // Clean URLs to avoid breaking Web Services.
214 // We can't do it in prepare_identity_providers_for_output() because it may break the web output.
215 foreach ($settings['identityproviders'] as &$ip) {
216 $ip['url'] = (!empty($ip['url'])) ? clean_param($ip['url'], PARAM_URL) : '';
217 $ip['iconurl'] = (!empty($ip['iconurl'])) ? clean_param($ip['iconurl'], PARAM_URL) : '';
218 }
a67e3bda
JL
219 }
220
8d9dc60b
JL
221 // If age is verified, return also the admin contact details.
222 if ($settings['agedigitalconsentverification']) {
223 $settings['supportname'] = clean_param($CFG->supportname, PARAM_NOTAGS);
224 $settings['supportemail'] = clean_param($CFG->supportemail, PARAM_EMAIL);
225 }
226
0002056f
JL
227 return $settings;
228 }
229
6b492628
JL
230 /**
231 * Returns a list of site configurations, filtering by section.
232 *
233 * @param string $section section name
234 * @return stdClass object containing the settings
235 */
236 public static function get_config($section) {
237 global $CFG, $SITE;
238
239 $settings = new \stdClass;
240 $context = context_system::instance();
241 $isadmin = has_capability('moodle/site:config', $context);
242
243 if (empty($section) or $section == 'frontpagesettings') {
244 require_once($CFG->dirroot . '/course/format/lib.php');
245 // First settings that anyone can deduce.
e2fe3bc0
JL
246 $settings->fullname = external_format_string($SITE->fullname, $context->id);
247 $settings->shortname = external_format_string($SITE->shortname, $context->id);
b14a04e0
DM
248
249 // Return to a var instead of directly to $settings object because of differences between
250 // list() in php5 and php7. {@link http://php.net/manual/en/function.list.php}
251 $formattedsummary = external_format_text($SITE->summary, $SITE->summaryformat,
e2fe3bc0 252 $context->id);
b14a04e0
DM
253 $settings->summary = $formattedsummary[0];
254 $settings->summaryformat = $formattedsummary[1];
6b492628
JL
255 $settings->frontpage = $CFG->frontpage;
256 $settings->frontpageloggedin = $CFG->frontpageloggedin;
257 $settings->maxcategorydepth = $CFG->maxcategorydepth;
258 $settings->frontpagecourselimit = $CFG->frontpagecourselimit;
89b909f6 259 $settings->numsections = course_get_format($SITE)->get_last_section_number();
6b492628
JL
260 $settings->newsitems = $SITE->newsitems;
261 $settings->commentsperpage = $CFG->commentsperpage;
262
263 // Now, admin settings.
264 if ($isadmin) {
265 $settings->defaultfrontpageroleid = $CFG->defaultfrontpageroleid;
266 }
267 }
268
269 if (empty($section) or $section == 'sitepolicies') {
1727c939
MG
270 $manager = new \core_privacy\local\sitepolicy\manager();
271 $settings->sitepolicy = ($sitepolicy = $manager->get_embed_url()) ? $sitepolicy->out(false) : '';
272 $settings->sitepolicyhandler = $CFG->sitepolicyhandler;
6b492628
JL
273 $settings->disableuserimages = $CFG->disableuserimages;
274 }
275
276 if (empty($section) or $section == 'gradessettings') {
277 require_once($CFG->dirroot . '/user/lib.php');
6703e031
JL
278 $settings->mygradesurl = user_mygrades_url();
279 // The previous function may return moodle_url instances or plain string URLs.
280 if ($settings->mygradesurl instanceof moodle_url) {
281 $settings->mygradesurl = $settings->mygradesurl->out(false);
282 }
6b492628
JL
283 }
284
7bdcf970
JL
285 if (empty($section) or $section == 'mobileapp') {
286 $settings->tool_mobile_forcelogout = get_config('tool_mobile', 'forcelogout');
af1b6043 287 $settings->tool_mobile_customlangstrings = get_config('tool_mobile', 'customlangstrings');
b2551b4c 288 $settings->tool_mobile_disabledfeatures = get_config('tool_mobile', 'disabledfeatures');
63d142e2 289 $settings->tool_mobile_custommenuitems = get_config('tool_mobile', 'custommenuitems');
04df75ce 290 $settings->tool_mobile_apppolicy = get_config('tool_mobile', 'apppolicy');
7bdcf970
JL
291 }
292
ab1b8238
JL
293 if (empty($section) or $section == 'calendar') {
294 $settings->calendartype = $CFG->calendartype;
295 $settings->calendar_site_timeformat = $CFG->calendar_site_timeformat;
296 $settings->calendar_startwday = $CFG->calendar_startwday;
297 $settings->calendar_adminseesall = $CFG->calendar_adminseesall;
298 $settings->calendar_lookahead = $CFG->calendar_lookahead;
299 $settings->calendar_maxevents = $CFG->calendar_maxevents;
300 }
301
6b492628
JL
302 return $settings;
303 }
304
961c9549
JL
305 /*
306 * Check if all the required conditions are met to allow the auto-login process continue.
307 *
308 * @param int $userid current user id
309 * @since Moodle 3.2
310 * @throws moodle_exception
311 */
312 public static function check_autologin_prerequisites($userid) {
313 global $CFG;
314
315 if (!$CFG->enablewebservices or !$CFG->enablemobilewebservice) {
316 throw new moodle_exception('enablewsdescription', 'webservice');
317 }
318
319 if (!is_https()) {
320 throw new moodle_exception('httpsrequired', 'tool_mobile');
321 }
322
323 if (has_capability('moodle/site:config', context_system::instance(), $userid) or is_siteadmin($userid)) {
324 throw new moodle_exception('autologinnotallowedtoadmins', 'tool_mobile');
325 }
326 }
327
328 /**
329 * Creates an auto-login key for the current user, this key is restricted by time and ip address.
330 *
331 * @return string the key
332 * @since Moodle 3.2
333 */
334 public static function get_autologin_key() {
335 global $USER;
336 // Delete previous keys.
337 delete_user_key('tool_mobile', $USER->id);
338
339 // Create a new key.
340 $iprestriction = getremoteaddr();
341 $validuntil = time() + self::LOGIN_KEY_TTL;
342 return create_user_key('tool_mobile', $USER->id, null, $iprestriction, $validuntil);
343 }
b2551b4c
JL
344
345 /**
346 * Get a list of the Mobile app features.
347 *
348 * @return array array with the features grouped by theirs ubication in the app.
349 * @since Moodle 3.3
350 */
351 public static function get_features_list() {
352 global $CFG;
353
354 $general = new lang_string('general');
355 $mainmenu = new lang_string('mainmenu', 'tool_mobile');
356 $course = new lang_string('course');
357 $modules = new lang_string('managemodules');
c1720141 358 $blocks = new lang_string('blocks');
b2551b4c
JL
359 $user = new lang_string('user');
360 $files = new lang_string('files');
361 $remoteaddons = new lang_string('remoteaddons', 'tool_mobile');
362
363 $availablemods = core_plugin_manager::instance()->get_plugins_of_type('mod');
364 $coursemodules = array();
c3e745b7 365 $appsupportedmodules = array('assign', 'book', 'chat', 'choice', 'data', 'feedback', 'folder', 'forum', 'glossary', 'imscp',
d808c220
JL
366 'label', 'lesson', 'lti', 'page', 'quiz', 'resource', 'scorm', 'survey', 'url', 'wiki', 'workshop');
367
b2551b4c
JL
368 foreach ($availablemods as $mod) {
369 if (in_array($mod->name, $appsupportedmodules)) {
370 $coursemodules['$mmCourseDelegate_mmaMod' . ucfirst($mod->name)] = $mod->displayname;
371 }
372 }
bf258846 373 asort($coursemodules);
b2551b4c
JL
374
375 $remoteaddonslist = array();
376 $mobileplugins = self::get_plugins_supporting_mobile();
377 foreach ($mobileplugins as $plugin) {
378 $displayname = core_plugin_manager::instance()->plugin_name($plugin['component']) . " - " . $plugin['addon'];
d6c06935 379 $remoteaddonslist['sitePlugin_' . $plugin['component'] . '_' . $plugin['addon']] = $displayname;
b2551b4c
JL
380
381 }
382
c1720141
JL
383 // Display blocks.
384 $availableblocks = core_plugin_manager::instance()->get_plugins_of_type('block');
385 $courseblocks = array();
386 $appsupportedblocks = array(
387 'activity_modules' => 'CoreBlockDelegate_AddonBlockActivityModules',
388 'site_main_menu' => 'CoreBlockDelegate_AddonBlockSiteMainMenu',
389 'myoverview' => 'CoreBlockDelegate_AddonBlockMyOverview',
390 'timeline' => 'CoreBlockDelegate_AddonBlockTimeline',
391 'recentlyaccessedcourses' => 'CoreBlockDelegate_AddonBlockRecentlyAccessedCourses',
392 'starredcourses' => 'CoreBlockDelegate_AddonBlockStarredCourses',
393 'recentlyaccesseditems' => 'CoreBlockDelegate_AddonBlockRecentlyAccessedItems',
bf258846
JL
394 'badges' => 'CoreBlockDelegate_AddonBlockBadges',
395 'blog_menu' => 'CoreBlockDelegate_AddonBlockBlogMenu',
396 'blog_recent' => 'CoreBlockDelegate_AddonBlockBlogRecent',
397 'blog_tags' => 'CoreBlockDelegate_AddonBlockBlogTags',
398 'calendar_month' => 'CoreBlockDelegate_AddonBlockCalendarMonth',
399 'calendar_upcoming' => 'CoreBlockDelegate_AddonBlockCalendarUpcoming',
400 'comments' => 'CoreBlockDelegate_AddonBlockComments',
401 'completionstatus' => 'CoreBlockDelegate_AddonBlockCompletionStatus',
402 'feedback' => 'CoreBlockDelegate_AddonBlockFeedback',
403 'glossary_random' => 'CoreBlockDelegate_AddonBlockGlossaryRandom',
404 'html' => 'CoreBlockDelegate_AddonBlockHtml',
405 'lp' => 'CoreBlockDelegate_AddonBlockLp',
406 'news_items' => 'CoreBlockDelegate_AddonBlockNewsItems',
407 'online_users' => 'CoreBlockDelegate_AddonBlockOnlineUsers',
408 'selfcompletion' => 'CoreBlockDelegate_AddonBlockSelfCompletion',
409 'tags' => 'CoreBlockDelegate_AddonBlockTags',
c1720141
JL
410 );
411
412 foreach ($availableblocks as $block) {
413 if (isset($appsupportedblocks[$block->name])) {
414 $courseblocks[$appsupportedblocks[$block->name]] = $block->displayname;
415 }
416 }
bf258846 417 asort($courseblocks);
c1720141 418
b2551b4c 419 $features = array(
bf258846
JL
420 "$general" => array(
421 'NoDelegate_CoreOffline' => new lang_string('offlineuse', 'tool_mobile'),
422 'NoDelegate_SiteBlocks' => new lang_string('blocks'),
423 'NoDelegate_CoreComments' => new lang_string('comments'),
424 'NoDelegate_CoreRating' => new lang_string('ratings', 'rating'),
425 'NoDelegate_CoreTag' => new lang_string('tags'),
426 '$mmLoginEmailSignup' => new lang_string('startsignup'),
88932e49 427 'NoDelegate_ForgottenPassword' => new lang_string('forgotten'),
bf258846
JL
428 'NoDelegate_ResponsiveMainMenuItems' => new lang_string('responsivemainmenuitems', 'tool_mobile'),
429 ),
b2551b4c 430 "$mainmenu" => array(
b2551b4c 431 '$mmSideMenuDelegate_mmaFrontpage' => new lang_string('sitehome'),
bf258846
JL
432 '$mmSideMenuDelegate_mmCourses' => new lang_string('mycourses'),
433 'CoreMainMenuDelegate_CoreCoursesDashboard' => new lang_string('myhome'),
434 '$mmSideMenuDelegate_mmaCalendar' => new lang_string('calendar', 'calendar'),
b2551b4c
JL
435 '$mmSideMenuDelegate_mmaNotifications' => new lang_string('notifications', 'message'),
436 '$mmSideMenuDelegate_mmaMessages' => new lang_string('messages', 'message'),
bf258846
JL
437 '$mmSideMenuDelegate_mmaGrades' => new lang_string('grades', 'grades'),
438 '$mmSideMenuDelegate_mmaCompetency' => new lang_string('myplans', 'tool_lp'),
439 'CoreMainMenuDelegate_AddonBlog' => new lang_string('blog', 'blog'),
b2551b4c
JL
440 '$mmSideMenuDelegate_mmaFiles' => new lang_string('files'),
441 '$mmSideMenuDelegate_website' => new lang_string('webpage'),
442 '$mmSideMenuDelegate_help' => new lang_string('help'),
443 ),
444 "$course" => array(
bf258846
JL
445 'NoDelegate_CourseBlocks' => new lang_string('blocks'),
446 'CoreCourseOptionsDelegate_AddonBlog' => new lang_string('blog', 'blog'),
b2551b4c
JL
447 '$mmCoursesDelegate_search' => new lang_string('search'),
448 '$mmCoursesDelegate_mmaCompetency' => new lang_string('competencies', 'competency'),
449 '$mmCoursesDelegate_mmaParticipants' => new lang_string('participants'),
450 '$mmCoursesDelegate_mmaGrades' => new lang_string('grades', 'grades'),
451 '$mmCoursesDelegate_mmaCourseCompletion' => new lang_string('coursecompletion', 'completion'),
452 '$mmCoursesDelegate_mmaNotes' => new lang_string('notes', 'notes'),
3c8de97d
JL
453 'NoDelegate_CoreCourseDownload' => new lang_string('downloadcourse', 'tool_mobile'),
454 'NoDelegate_CoreCoursesDownload' => new lang_string('downloadcourses', 'tool_mobile'),
b2551b4c
JL
455 ),
456 "$user" => array(
f72a4828 457 'CoreUserDelegate_AddonBlog:blogs' => new lang_string('blog', 'blog'),
b2551b4c
JL
458 '$mmUserDelegate_mmaBadges' => new lang_string('badges', 'badges'),
459 '$mmUserDelegate_mmaCompetency:learningPlan' => new lang_string('competencies', 'competency'),
460 '$mmUserDelegate_mmaCourseCompletion:viewCompletion' => new lang_string('coursecompletion', 'completion'),
461 '$mmUserDelegate_mmaGrades:viewGrades' => new lang_string('grades', 'grades'),
462 '$mmUserDelegate_mmaMessages:sendMessage' => new lang_string('sendmessage', 'message'),
463 '$mmUserDelegate_mmaMessages:addContact' => new lang_string('addcontact', 'message'),
464 '$mmUserDelegate_mmaMessages:blockContact' => new lang_string('blockcontact', 'message'),
465 '$mmUserDelegate_mmaNotes:addNote' => new lang_string('addnewnote', 'notes'),
466 '$mmUserDelegate_picture' => new lang_string('userpic'),
467 ),
468 "$files" => array(
469 'files_privatefiles' => new lang_string('privatefiles'),
470 'files_sitefiles' => new lang_string('sitefiles'),
471 'files_upload' => new lang_string('upload'),
472 ),
473 "$modules" => $coursemodules,
c1720141 474 "$blocks" => $courseblocks,
b2551b4c
JL
475 );
476
477 if (!empty($remoteaddonslist)) {
478 $features["$remoteaddons"] = $remoteaddonslist;
479 }
480
481 return $features;
482 }
66a159f8
JL
483
484 /**
485 * This function check the current site for potential configuration issues that may prevent the mobile app to work.
486 *
487 * @return array list of potential issues
488 * @since Moodle 3.4
489 */
490 public static function get_potential_config_issues() {
491 global $CFG;
492 require_once($CFG->dirroot . "/lib/filelib.php");
493 require_once($CFG->dirroot . '/message/lib.php');
494
495 $warnings = array();
496
497 $curl = new curl();
498 // Return certificate information and verify the certificate.
499 $curl->setopt(array('CURLOPT_CERTINFO' => 1, 'CURLOPT_SSL_VERIFYPEER' => true));
500 $httpswwwroot = str_replace('http:', 'https:', $CFG->wwwroot); // Force https url.
098b16fb
JL
501 // Check https using a page not redirecting or returning exceptions.
502 $curl->head($httpswwwroot . "/$CFG->admin/tool/mobile/mobile.webmanifest.php");
66a159f8
JL
503 $info = $curl->get_info();
504
505 // First of all, check the server certificate (if any).
506 if (empty($info['http_code']) or ($info['http_code'] >= 400)) {
507 $warnings[] = ['nohttpsformobilewarning', 'admin'];
508 } else {
509 // Check the certificate is not self-signed or has an untrusted-root.
510 // This may be weak in some scenarios (when the curl SSL verifier is outdated).
511 if (empty($info['certinfo'])) {
512 $warnings[] = ['selfsignedoruntrustedcertificatewarning', 'tool_mobile'];
513 } else {
514 $timenow = time();
515 $expectedissuer = null;
516 foreach ($info['certinfo'] as $cert) {
517 // Check if the signature algorithm is weak (Android won't work with SHA-1).
518 if ($cert['Signature Algorithm'] == 'sha1WithRSAEncryption' || $cert['Signature Algorithm'] == 'sha1WithRSA') {
519 $warnings[] = ['insecurealgorithmwarning', 'tool_mobile'];
520 }
521 // Check certificate start date.
522 if (strtotime($cert['Start date']) > $timenow) {
523 $warnings[] = ['invalidcertificatestartdatewarning', 'tool_mobile'];
524 }
525 // Check certificate end date.
526 if (strtotime($cert['Expire date']) < $timenow) {
527 $warnings[] = ['invalidcertificateexpiredatewarning', 'tool_mobile'];
528 }
529 // Check the chain.
530 if ($expectedissuer !== null) {
531 if ($expectedissuer !== $cert['Subject'] || $cert['Subject'] === $cert['Issuer']) {
532 $warnings[] = ['invalidcertificatechainwarning', 'tool_mobile'];
533 }
534 }
535 $expectedissuer = $cert['Issuer'];
536 }
537 }
538 }
539 // Now check typical configuration problems.
540 if ((int) $CFG->userquota === PHP_INT_MAX) {
541 // In old Moodle version was a text so was possible to have numeric values > PHP_INT_MAX.
542 $warnings[] = ['invaliduserquotawarning', 'tool_mobile'];
543 }
544 // Check ADOdb debug enabled.
545 if (get_config('auth_db', 'debugauthdb') || get_config('enrol_database', 'debugdb')) {
546 $warnings[] = ['adodbdebugwarning', 'tool_mobile'];
547 }
548 // Check display errors on.
549 if (!empty($CFG->debugdisplay)) {
550 $warnings[] = ['displayerrorswarning', 'tool_mobile'];
551 }
552 // Check mobile notifications.
553 $processors = get_message_processors();
554 $enabled = false;
555 foreach ($processors as $processor => $status) {
556 if ($processor == 'airnotifier' && $status->enabled) {
557 $enabled = true;
558 }
559 }
560 if (!$enabled) {
561 $warnings[] = ['mobilenotificationsdisabledwarning', 'tool_mobile'];
562 }
563
564 return $warnings;
565 }
b2478ed0 566}