8741016dbe0006deef8e0f917bc9e4862459b94a
[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) {
93                     $plugininfo = array(
94                         'component' => $component,
95                         'version' => $version,
96                         'addon' => $addonname,
97                         'dependencies' => !empty($addoninfo['dependencies']) ? $addoninfo['dependencies'] : array(),
98                         'fileurl' => '',
99                         'filehash' => '',
100                         'filesize' => 0
101                     );
103                     // All the mobile packages must be under the plugin mobile directory.
104                     $package = $path . '/mobile/' . $addonname . '.zip';
105                     if (file_exists($package)) {
106                         $plugininfo['fileurl'] = $CFG->wwwroot . '' . str_replace($CFG->dirroot, '', $package);
107                         $plugininfo['filehash'] = sha1_file($package);
108                         $plugininfo['filesize'] = filesize($package);
109                     }
110                     $pluginsinfo[] = $plugininfo;
111                 }
112             }
113         }
115         $cache->set($cachekey, $pluginsinfo);
117         return $pluginsinfo;
118     }
120     /**
121      * Returns a list of the site public settings, those not requiring authentication.
122      *
123      * @return array with the settings and warnings
124      */
125     public static function get_public_config() {
126         global $CFG, $SITE, $PAGE, $OUTPUT;
127         require_once($CFG->libdir . '/authlib.php');
129         $context = context_system::instance();
130         // We need this to make work the format text functions.
131         $PAGE->set_context($context);
133         list($authinstructions, $notusedformat) = external_format_text($CFG->auth_instructions, FORMAT_MOODLE, $context->id);
134         list($maintenancemessage, $notusedformat) = external_format_text($CFG->maintenance_message, FORMAT_MOODLE, $context->id);
135         $settings = array(
136             'wwwroot' => $CFG->wwwroot,
137             'httpswwwroot' => $CFG->httpswwwroot,
138             'sitename' => external_format_string($SITE->fullname, $context->id, true),
139             'guestlogin' => $CFG->guestloginbutton,
140             'rememberusername' => $CFG->rememberusername,
141             'authloginviaemail' => $CFG->authloginviaemail,
142             'registerauth' => $CFG->registerauth,
143             'forgottenpasswordurl' => $CFG->forgottenpasswordurl,
144             'authinstructions' => $authinstructions,
145             'authnoneenabled' => (int) is_enabled_auth('none'),
146             'enablewebservices' => $CFG->enablewebservices,
147             'enablemobilewebservice' => $CFG->enablemobilewebservice,
148             'maintenanceenabled' => $CFG->maintenance_enabled,
149             'maintenancemessage' => $maintenancemessage,
150             'mobilecssurl' => !empty($CFG->mobilecssurl) ? $CFG->mobilecssurl : '',
151             'tool_mobile_disabledfeatures' => get_config('tool_mobile', 'disabledfeatures'),
152         );
154         $typeoflogin = get_config('tool_mobile', 'typeoflogin');
155         // Not found, edge case.
156         if ($typeoflogin === false) {
157             $typeoflogin = self::LOGIN_VIA_APP; // Defaults to via app.
158         }
159         $settings['typeoflogin'] = $typeoflogin;
161         // Check if the user can sign-up to return the launch URL in that case.
162         $cansignup = signup_is_enabled();
164         $url = new moodle_url("/$CFG->admin/tool/mobile/launch.php");
165         $settings['launchurl'] = $url->out(false);
167         // Check that we are receiving a moodle_url object, themes can override get_logo_url and may return incorrect values.
168         if (($logourl = $OUTPUT->get_logo_url()) && $logourl instanceof moodle_url) {
169             $settings['logourl'] = $logourl->out(false);
170         }
171         if (($compactlogourl = $OUTPUT->get_compact_logo_url()) && $compactlogourl instanceof moodle_url) {
172             $settings['compactlogourl'] = $compactlogourl->out(false);
173         }
175         // Identity providers.
176         $authsequence = get_enabled_auth_plugins(true);
177         $identityproviders = \auth_plugin_base::get_identity_providers($authsequence);
178         $identityprovidersdata = \auth_plugin_base::prepare_identity_providers_for_output($identityproviders, $OUTPUT);
179         if (!empty($identityprovidersdata)) {
180             $settings['identityproviders'] = $identityprovidersdata;
181         }
183         return $settings;
184     }
186     /**
187      * Returns a list of site configurations, filtering by section.
188      *
189      * @param  string $section section name
190      * @return stdClass object containing the settings
191      */
192     public static function get_config($section) {
193         global $CFG, $SITE;
195         $settings = new \stdClass;
196         $context = context_system::instance();
197         $isadmin = has_capability('moodle/site:config', $context);
199         if (empty($section) or $section == 'frontpagesettings') {
200             require_once($CFG->dirroot . '/course/format/lib.php');
201             // First settings that anyone can deduce.
202             $settings->fullname = external_format_string($SITE->fullname, $context->id);
203             $settings->shortname = external_format_string($SITE->shortname, $context->id);
205             // Return to a var instead of directly to $settings object because of differences between
206             // list() in php5 and php7. {@link http://php.net/manual/en/function.list.php}
207             $formattedsummary = external_format_text($SITE->summary, $SITE->summaryformat,
208                                                                                         $context->id);
209             $settings->summary = $formattedsummary[0];
210             $settings->summaryformat = $formattedsummary[1];
211             $settings->frontpage = $CFG->frontpage;
212             $settings->frontpageloggedin = $CFG->frontpageloggedin;
213             $settings->maxcategorydepth = $CFG->maxcategorydepth;
214             $settings->frontpagecourselimit = $CFG->frontpagecourselimit;
215             $settings->numsections = course_get_format($SITE)->get_last_section_number();
216             $settings->newsitems = $SITE->newsitems;
217             $settings->commentsperpage = $CFG->commentsperpage;
219             // Now, admin settings.
220             if ($isadmin) {
221                 $settings->defaultfrontpageroleid = $CFG->defaultfrontpageroleid;
222             }
223         }
225         if (empty($section) or $section == 'sitepolicies') {
226             $settings->sitepolicy = $CFG->sitepolicy;
227             $settings->disableuserimages = $CFG->disableuserimages;
228         }
230         if (empty($section) or $section == 'gradessettings') {
231             require_once($CFG->dirroot . '/user/lib.php');
232             $settings->mygradesurl = user_mygrades_url();
233             // The previous function may return moodle_url instances or plain string URLs.
234             if ($settings->mygradesurl instanceof moodle_url) {
235                 $settings->mygradesurl = $settings->mygradesurl->out(false);
236             }
237         }
239         if (empty($section) or $section == 'mobileapp') {
240             $settings->tool_mobile_forcelogout = get_config('tool_mobile', 'forcelogout');
241             $settings->tool_mobile_customlangstrings = get_config('tool_mobile', 'customlangstrings');
242             $settings->tool_mobile_disabledfeatures = get_config('tool_mobile', 'disabledfeatures');
243             $settings->tool_mobile_custommenuitems = get_config('tool_mobile', 'custommenuitems');
244         }
246         return $settings;
247     }
249     /*
250      * Check if all the required conditions are met to allow the auto-login process continue.
251      *
252      * @param  int $userid  current user id
253      * @since Moodle 3.2
254      * @throws moodle_exception
255      */
256     public static function check_autologin_prerequisites($userid) {
257         global $CFG;
259         if (!$CFG->enablewebservices or !$CFG->enablemobilewebservice) {
260             throw new moodle_exception('enablewsdescription', 'webservice');
261         }
263         if (!is_https()) {
264             throw new moodle_exception('httpsrequired', 'tool_mobile');
265         }
267         if (has_capability('moodle/site:config', context_system::instance(), $userid) or is_siteadmin($userid)) {
268             throw new moodle_exception('autologinnotallowedtoadmins', 'tool_mobile');
269         }
270     }
272     /**
273      * Creates an auto-login key for the current user, this key is restricted by time and ip address.
274      *
275      * @return string the key
276      * @since Moodle 3.2
277      */
278     public static function get_autologin_key() {
279         global $USER;
280         // Delete previous keys.
281         delete_user_key('tool_mobile', $USER->id);
283         // Create a new key.
284         $iprestriction = getremoteaddr();
285         $validuntil = time() + self::LOGIN_KEY_TTL;
286         return create_user_key('tool_mobile', $USER->id, null, $iprestriction, $validuntil);
287     }
289     /**
290      * Get a list of the Mobile app features.
291      *
292      * @return array array with the features grouped by theirs ubication in the app.
293      * @since Moodle 3.3
294      */
295     public static function get_features_list() {
296         global $CFG;
298         $general = new lang_string('general');
299         $mainmenu = new lang_string('mainmenu', 'tool_mobile');
300         $course = new lang_string('course');
301         $modules = new lang_string('managemodules');
302         $user = new lang_string('user');
303         $files = new lang_string('files');
304         $remoteaddons = new lang_string('remoteaddons', 'tool_mobile');
306         $availablemods = core_plugin_manager::instance()->get_plugins_of_type('mod');
307         $coursemodules = array();
308         $appsupportedmodules = array('assign', 'book', 'chat', 'choice', 'data', 'feedback', 'folder', 'forum', 'glossary', 'imscp',
309                                         'label', 'lesson', 'lti', 'page', 'quiz', 'resource', 'scorm', 'survey', 'url', 'wiki');
310         foreach ($availablemods as $mod) {
311             if (in_array($mod->name, $appsupportedmodules)) {
312                 $coursemodules['$mmCourseDelegate_mmaMod' . ucfirst($mod->name)] = $mod->displayname;
313             }
314         }
316         $remoteaddonslist = array();
317         $mobileplugins = self::get_plugins_supporting_mobile();
318         foreach ($mobileplugins as $plugin) {
319             $displayname = core_plugin_manager::instance()->plugin_name($plugin['component']) . " - " . $plugin['addon'];
320             $remoteaddonslist['remoteAddOn_' . $plugin['component'] . '_' . $plugin['addon']] = $displayname;
322         }
324         $features = array(
325             '$mmLoginEmailSignup' => new lang_string('startsignup'),
326             "$mainmenu" => array(
327                 '$mmSideMenuDelegate_mmCourses' => new lang_string('mycourses'),
328                 '$mmSideMenuDelegate_mmaFrontpage' => new lang_string('sitehome'),
329                 '$mmSideMenuDelegate_mmaGrades' => new lang_string('grades', 'grades'),
330                 '$mmSideMenuDelegate_mmaCompetency' => new lang_string('myplans', 'tool_lp'),
331                 '$mmSideMenuDelegate_mmaNotifications' => new lang_string('notifications', 'message'),
332                 '$mmSideMenuDelegate_mmaMessages' => new lang_string('messages', 'message'),
333                 '$mmSideMenuDelegate_mmaCalendar' => new lang_string('calendar', 'calendar'),
334                 '$mmSideMenuDelegate_mmaFiles' => new lang_string('files'),
335                 '$mmSideMenuDelegate_website' => new lang_string('webpage'),
336                 '$mmSideMenuDelegate_help' => new lang_string('help'),
337             ),
338             "$course" => array(
339                 '$mmCoursesDelegate_search' => new lang_string('search'),
340                 '$mmCoursesDelegate_mmaCompetency' => new lang_string('competencies', 'competency'),
341                 '$mmCoursesDelegate_mmaParticipants' => new lang_string('participants'),
342                 '$mmCoursesDelegate_mmaGrades' => new lang_string('grades', 'grades'),
343                 '$mmCoursesDelegate_mmaCourseCompletion' => new lang_string('coursecompletion', 'completion'),
344                 '$mmCoursesDelegate_mmaNotes' => new lang_string('notes', 'notes'),
345             ),
346             "$user" => array(
347                 '$mmUserDelegate_mmaBadges' => new lang_string('badges', 'badges'),
348                 '$mmUserDelegate_mmaCompetency:learningPlan' => new lang_string('competencies', 'competency'),
349                 '$mmUserDelegate_mmaCourseCompletion:viewCompletion' => new lang_string('coursecompletion', 'completion'),
350                 '$mmUserDelegate_mmaGrades:viewGrades' => new lang_string('grades', 'grades'),
351                 '$mmUserDelegate_mmaMessages:sendMessage' => new lang_string('sendmessage', 'message'),
352                 '$mmUserDelegate_mmaMessages:addContact' => new lang_string('addcontact', 'message'),
353                 '$mmUserDelegate_mmaMessages:blockContact' => new lang_string('blockcontact', 'message'),
354                 '$mmUserDelegate_mmaNotes:addNote' => new lang_string('addnewnote', 'notes'),
355                 '$mmUserDelegate_picture' => new lang_string('userpic'),
356             ),
357             "$files" => array(
358                 'files_privatefiles' => new lang_string('privatefiles'),
359                 'files_sitefiles' => new lang_string('sitefiles'),
360                 'files_upload' => new lang_string('upload'),
361             ),
362             "$modules" => $coursemodules,
363         );
365         if (!empty($remoteaddonslist)) {
366             $features["$remoteaddons"] = $remoteaddonslist;
367         }
369         return $features;
370     }
372     /**
373      * This function check the current site for potential configuration issues that may prevent the mobile app to work.
374      *
375      * @return array list of potential issues
376      * @since  Moodle 3.4
377      */
378     public static function get_potential_config_issues() {
379         global $CFG;
380         require_once($CFG->dirroot . "/lib/filelib.php");
381         require_once($CFG->dirroot . '/message/lib.php');
383         $warnings = array();
385         $curl = new curl();
386         // Return certificate information and verify the certificate.
387         $curl->setopt(array('CURLOPT_CERTINFO' => 1, 'CURLOPT_SSL_VERIFYPEER' => true));
388         $httpswwwroot = str_replace('http:', 'https:', $CFG->wwwroot); // Force https url.
389         $curl->head($httpswwwroot . "/login/index.php");
390         $info = $curl->get_info();
392         // First of all, check the server certificate (if any).
393         if (empty($info['http_code']) or ($info['http_code'] >= 400)) {
394             $warnings[] = ['nohttpsformobilewarning', 'admin'];
395         } else {
396             // Check the certificate is not self-signed or has an untrusted-root.
397             // This may be weak in some scenarios (when the curl SSL verifier is outdated).
398             if (empty($info['certinfo'])) {
399                 $warnings[] = ['selfsignedoruntrustedcertificatewarning', 'tool_mobile'];
400             } else {
401                 $timenow = time();
402                 $expectedissuer = null;
403                 foreach ($info['certinfo'] as $cert) {
404                     // Check if the signature algorithm is weak (Android won't work with SHA-1).
405                     if ($cert['Signature Algorithm'] == 'sha1WithRSAEncryption' || $cert['Signature Algorithm'] == 'sha1WithRSA') {
406                         $warnings[] = ['insecurealgorithmwarning', 'tool_mobile'];
407                     }
408                     // Check certificate start date.
409                     if (strtotime($cert['Start date']) > $timenow) {
410                         $warnings[] = ['invalidcertificatestartdatewarning', 'tool_mobile'];
411                     }
412                     // Check certificate end date.
413                     if (strtotime($cert['Expire date']) < $timenow) {
414                         $warnings[] = ['invalidcertificateexpiredatewarning', 'tool_mobile'];
415                     }
416                     // Check the chain.
417                     if ($expectedissuer !== null) {
418                         if ($expectedissuer !== $cert['Subject'] || $cert['Subject'] === $cert['Issuer']) {
419                             $warnings[] = ['invalidcertificatechainwarning', 'tool_mobile'];
420                         }
421                     }
422                     $expectedissuer = $cert['Issuer'];
423                 }
424             }
425         }
426         // Now check typical configuration problems.
427         if ((int) $CFG->userquota === PHP_INT_MAX) {
428             // In old Moodle version was a text so was possible to have numeric values > PHP_INT_MAX.
429             $warnings[] = ['invaliduserquotawarning', 'tool_mobile'];
430         }
431         // Check ADOdb debug enabled.
432         if (get_config('auth_db', 'debugauthdb') || get_config('enrol_database', 'debugdb')) {
433             $warnings[] = ['adodbdebugwarning', 'tool_mobile'];
434         }
435         // Check display errors on.
436         if (!empty($CFG->debugdisplay)) {
437             $warnings[] = ['displayerrorswarning', 'tool_mobile'];
438         }
439         // Check mobile notifications.
440         $processors = get_message_processors();
441         $enabled = false;
442         foreach ($processors as $processor => $status) {
443             if ($processor == 'airnotifier' && $status->enabled) {
444                 $enabled = true;
445             }
446         }
447         if (!$enabled) {
448             $warnings[] = ['mobilenotificationsdisabledwarning', 'tool_mobile'];
449         }
451         return $warnings;
452     }