493b7da7c45199e3e08b0feb4eb3772febd3251e
[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;
34 /**
35  * API exposed by tool_mobile, to be used mostly by external functions and the plugin settings.
36  *
37  * @copyright  2016 Juan Leyva
38  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
39  * @since      Moodle 3.1
40  */
41 class api {
43     /** @var int to identify the login via app. */
44     const LOGIN_VIA_APP = 1;
45     /** @var int to identify the login via browser. */
46     const LOGIN_VIA_BROWSER = 2;
47     /** @var int to identify the login via an embedded browser. */
48     const LOGIN_VIA_EMBEDDED_BROWSER = 3;
49     /** @var int seconds an auto-login key will expire. */
50     const LOGIN_KEY_TTL = 60;
52     /**
53      * Returns a list of Moodle plugins supporting the mobile app.
54      *
55      * @return array an array of objects containing the plugin information
56      */
57     public static function get_plugins_supporting_mobile() {
58         global $CFG;
59         require_once($CFG->libdir . '/adminlib.php');
61         $cachekey = 'mobileplugins';
62         if (!isloggedin()) {
63             $cachekey = 'authmobileplugins';    // Use a different cache for not logged users.
64         }
66         // Check if we can return this from cache.
67         $cache = \cache::make('tool_mobile', 'plugininfo');
68         $pluginsinfo = $cache->get($cachekey);
69         if ($pluginsinfo !== false) {
70             return (array)$pluginsinfo;
71         }
73         $pluginsinfo = [];
74         // For not logged users return only auth plugins.
75         // This is to avoid anyone (not being a registered user) to obtain and download all the site remote add-ons.
76         if (!isloggedin()) {
77             $plugintypes = array('auth' => $CFG->dirroot.'/auth');
78         } else {
79             $plugintypes = core_component::get_plugin_types();
80         }
82         foreach ($plugintypes as $plugintype => $unused) {
83             // We need to include files here.
84             $pluginswithfile = core_component::get_plugin_list_with_file($plugintype, 'db' . DIRECTORY_SEPARATOR . 'mobile.php');
85             foreach ($pluginswithfile as $plugin => $notused) {
86                 $path = core_component::get_plugin_directory($plugintype, $plugin);
87                 $component = $plugintype . '_' . $plugin;
88                 $version = get_component_version($component);
90                 require("$path/db/mobile.php");
91                 foreach ($addons as $addonname => $addoninfo) {
92                     $plugininfo = array(
93                         'component' => $component,
94                         'version' => $version,
95                         'addon' => $addonname,
96                         'dependencies' => !empty($addoninfo['dependencies']) ? $addoninfo['dependencies'] : array(),
97                         'fileurl' => '',
98                         'filehash' => '',
99                         'filesize' => 0
100                     );
102                     // All the mobile packages must be under the plugin mobile directory.
103                     $package = $path . '/mobile/' . $addonname . '.zip';
104                     if (file_exists($package)) {
105                         $plugininfo['fileurl'] = $CFG->wwwroot . '' . str_replace($CFG->dirroot, '', $package);
106                         $plugininfo['filehash'] = sha1_file($package);
107                         $plugininfo['filesize'] = filesize($package);
108                     }
109                     $pluginsinfo[] = $plugininfo;
110                 }
111             }
112         }
114         $cache->set($cachekey, $pluginsinfo);
116         return $pluginsinfo;
117     }
119     /**
120      * Returns a list of the site public settings, those not requiring authentication.
121      *
122      * @return array with the settings and warnings
123      */
124     public static function get_public_config() {
125         global $CFG, $SITE, $PAGE, $OUTPUT;
126         require_once($CFG->libdir . '/authlib.php');
128         $context = context_system::instance();
129         // We need this to make work the format text functions.
130         $PAGE->set_context($context);
132         list($authinstructions, $notusedformat) = external_format_text($CFG->auth_instructions, FORMAT_MOODLE, $context->id);
133         list($maintenancemessage, $notusedformat) = external_format_text($CFG->maintenance_message, FORMAT_MOODLE, $context->id);
134         $settings = array(
135             'wwwroot' => $CFG->wwwroot,
136             'httpswwwroot' => $CFG->httpswwwroot,
137             'sitename' => external_format_string($SITE->fullname, $context->id, true),
138             'guestlogin' => $CFG->guestloginbutton,
139             'rememberusername' => $CFG->rememberusername,
140             'authloginviaemail' => $CFG->authloginviaemail,
141             'registerauth' => $CFG->registerauth,
142             'forgottenpasswordurl' => $CFG->forgottenpasswordurl,
143             'authinstructions' => $authinstructions,
144             'authnoneenabled' => (int) is_enabled_auth('none'),
145             'enablewebservices' => $CFG->enablewebservices,
146             'enablemobilewebservice' => $CFG->enablemobilewebservice,
147             'maintenanceenabled' => $CFG->maintenance_enabled,
148             'maintenancemessage' => $maintenancemessage,
149             'mobilecssurl' => !empty($CFG->mobilecssurl) ? $CFG->mobilecssurl : '',
150             'tool_mobile_disabledfeatures' => get_config('tool_mobile', 'disabledfeatures'),
151         );
153         $typeoflogin = get_config('tool_mobile', 'typeoflogin');
154         // Not found, edge case.
155         if ($typeoflogin === false) {
156             $typeoflogin = self::LOGIN_VIA_APP; // Defaults to via app.
157         }
158         $settings['typeoflogin'] = $typeoflogin;
160         // Check if the user can sign-up to return the launch URL in that case.
161         $cansignup = signup_is_enabled();
163         $url = new moodle_url("/$CFG->admin/tool/mobile/launch.php");
164         $settings['launchurl'] = $url->out(false);
166         // Check that we are receiving a moodle_url object, themes can override get_logo_url and may return incorrect values.
167         if (($logourl = $OUTPUT->get_logo_url()) && $logourl instanceof moodle_url) {
168             $settings['logourl'] = $logourl->out(false);
169         }
170         if (($compactlogourl = $OUTPUT->get_compact_logo_url()) && $compactlogourl instanceof moodle_url) {
171             $settings['compactlogourl'] = $compactlogourl->out(false);
172         }
174         // Identity providers.
175         $authsequence = get_enabled_auth_plugins(true);
176         $identityproviders = \auth_plugin_base::get_identity_providers($authsequence);
177         $identityprovidersdata = \auth_plugin_base::prepare_identity_providers_for_output($identityproviders, $OUTPUT);
178         if (!empty($identityprovidersdata)) {
179             $settings['identityproviders'] = $identityprovidersdata;
180         }
182         return $settings;
183     }
185     /**
186      * Returns a list of site configurations, filtering by section.
187      *
188      * @param  string $section section name
189      * @return stdClass object containing the settings
190      */
191     public static function get_config($section) {
192         global $CFG, $SITE;
194         $settings = new \stdClass;
195         $context = context_system::instance();
196         $isadmin = has_capability('moodle/site:config', $context);
198         if (empty($section) or $section == 'frontpagesettings') {
199             require_once($CFG->dirroot . '/course/format/lib.php');
200             // First settings that anyone can deduce.
201             $settings->fullname = external_format_string($SITE->fullname, $context->id);
202             $settings->shortname = external_format_string($SITE->shortname, $context->id);
204             // Return to a var instead of directly to $settings object because of differences between
205             // list() in php5 and php7. {@link http://php.net/manual/en/function.list.php}
206             $formattedsummary = external_format_text($SITE->summary, $SITE->summaryformat,
207                                                                                         $context->id);
208             $settings->summary = $formattedsummary[0];
209             $settings->summaryformat = $formattedsummary[1];
210             $settings->frontpage = $CFG->frontpage;
211             $settings->frontpageloggedin = $CFG->frontpageloggedin;
212             $settings->maxcategorydepth = $CFG->maxcategorydepth;
213             $settings->frontpagecourselimit = $CFG->frontpagecourselimit;
214             $settings->numsections = course_get_format($SITE)->get_last_section_number();
215             $settings->newsitems = $SITE->newsitems;
216             $settings->commentsperpage = $CFG->commentsperpage;
218             // Now, admin settings.
219             if ($isadmin) {
220                 $settings->defaultfrontpageroleid = $CFG->defaultfrontpageroleid;
221             }
222         }
224         if (empty($section) or $section == 'sitepolicies') {
225             $settings->sitepolicy = $CFG->sitepolicy;
226             $settings->disableuserimages = $CFG->disableuserimages;
227         }
229         if (empty($section) or $section == 'gradessettings') {
230             require_once($CFG->dirroot . '/user/lib.php');
231             $settings->mygradesurl = user_mygrades_url();
232             // The previous function may return moodle_url instances or plain string URLs.
233             if ($settings->mygradesurl instanceof moodle_url) {
234                 $settings->mygradesurl = $settings->mygradesurl->out(false);
235             }
236         }
238         if (empty($section) or $section == 'mobileapp') {
239             $settings->tool_mobile_forcelogout = get_config('tool_mobile', 'forcelogout');
240             $settings->tool_mobile_customlangstrings = get_config('tool_mobile', 'customlangstrings');
241             $settings->tool_mobile_disabledfeatures = get_config('tool_mobile', 'disabledfeatures');
242             $settings->tool_mobile_custommenuitems = get_config('tool_mobile', 'custommenuitems');
243         }
245         return $settings;
246     }
248     /*
249      * Check if all the required conditions are met to allow the auto-login process continue.
250      *
251      * @param  int $userid  current user id
252      * @since Moodle 3.2
253      * @throws moodle_exception
254      */
255     public static function check_autologin_prerequisites($userid) {
256         global $CFG;
258         if (!$CFG->enablewebservices or !$CFG->enablemobilewebservice) {
259             throw new moodle_exception('enablewsdescription', 'webservice');
260         }
262         if (!is_https()) {
263             throw new moodle_exception('httpsrequired', 'tool_mobile');
264         }
266         if (has_capability('moodle/site:config', context_system::instance(), $userid) or is_siteadmin($userid)) {
267             throw new moodle_exception('autologinnotallowedtoadmins', 'tool_mobile');
268         }
269     }
271     /**
272      * Creates an auto-login key for the current user, this key is restricted by time and ip address.
273      *
274      * @return string the key
275      * @since Moodle 3.2
276      */
277     public static function get_autologin_key() {
278         global $USER;
279         // Delete previous keys.
280         delete_user_key('tool_mobile', $USER->id);
282         // Create a new key.
283         $iprestriction = getremoteaddr();
284         $validuntil = time() + self::LOGIN_KEY_TTL;
285         return create_user_key('tool_mobile', $USER->id, null, $iprestriction, $validuntil);
286     }
288     /**
289      * Get a list of the Mobile app features.
290      *
291      * @return array array with the features grouped by theirs ubication in the app.
292      * @since Moodle 3.3
293      */
294     public static function get_features_list() {
295         global $CFG;
297         $general = new lang_string('general');
298         $mainmenu = new lang_string('mainmenu', 'tool_mobile');
299         $course = new lang_string('course');
300         $modules = new lang_string('managemodules');
301         $user = new lang_string('user');
302         $files = new lang_string('files');
303         $remoteaddons = new lang_string('remoteaddons', 'tool_mobile');
305         $availablemods = core_plugin_manager::instance()->get_plugins_of_type('mod');
306         $coursemodules = array();
307         $appsupportedmodules = array('assign', 'book', 'chat', 'choice', 'data', 'feedback', 'folder', 'forum', 'glossary', 'imscp',
308                                         'label', 'lesson', 'lti', 'page', 'quiz', 'resource', 'scorm', 'survey', 'url', 'wiki');
309         foreach ($availablemods as $mod) {
310             if (in_array($mod->name, $appsupportedmodules)) {
311                 $coursemodules['$mmCourseDelegate_mmaMod' . ucfirst($mod->name)] = $mod->displayname;
312             }
313         }
315         $remoteaddonslist = array();
316         $mobileplugins = self::get_plugins_supporting_mobile();
317         foreach ($mobileplugins as $plugin) {
318             $displayname = core_plugin_manager::instance()->plugin_name($plugin['component']) . " - " . $plugin['addon'];
319             $remoteaddonslist['remoteAddOn_' . $plugin['component'] . '_' . $plugin['addon']] = $displayname;
321         }
323         $features = array(
324             '$mmLoginEmailSignup' => new lang_string('startsignup'),
325             "$mainmenu" => array(
326                 '$mmSideMenuDelegate_mmCourses' => new lang_string('mycourses'),
327                 '$mmSideMenuDelegate_mmaFrontpage' => new lang_string('sitehome'),
328                 '$mmSideMenuDelegate_mmaGrades' => new lang_string('grades', 'grades'),
329                 '$mmSideMenuDelegate_mmaCompetency' => new lang_string('myplans', 'tool_lp'),
330                 '$mmSideMenuDelegate_mmaNotifications' => new lang_string('notifications', 'message'),
331                 '$mmSideMenuDelegate_mmaMessages' => new lang_string('messages', 'message'),
332                 '$mmSideMenuDelegate_mmaCalendar' => new lang_string('calendar', 'calendar'),
333                 '$mmSideMenuDelegate_mmaFiles' => new lang_string('files'),
334                 '$mmSideMenuDelegate_website' => new lang_string('webpage'),
335                 '$mmSideMenuDelegate_help' => new lang_string('help'),
336             ),
337             "$course" => array(
338                 '$mmCoursesDelegate_search' => new lang_string('search'),
339                 '$mmCoursesDelegate_mmaCompetency' => new lang_string('competencies', 'competency'),
340                 '$mmCoursesDelegate_mmaParticipants' => new lang_string('participants'),
341                 '$mmCoursesDelegate_mmaGrades' => new lang_string('grades', 'grades'),
342                 '$mmCoursesDelegate_mmaCourseCompletion' => new lang_string('coursecompletion', 'completion'),
343                 '$mmCoursesDelegate_mmaNotes' => new lang_string('notes', 'notes'),
344             ),
345             "$user" => array(
346                 '$mmUserDelegate_mmaBadges' => new lang_string('badges', 'badges'),
347                 '$mmUserDelegate_mmaCompetency:learningPlan' => new lang_string('competencies', 'competency'),
348                 '$mmUserDelegate_mmaCourseCompletion:viewCompletion' => new lang_string('coursecompletion', 'completion'),
349                 '$mmUserDelegate_mmaGrades:viewGrades' => new lang_string('grades', 'grades'),
350                 '$mmUserDelegate_mmaMessages:sendMessage' => new lang_string('sendmessage', 'message'),
351                 '$mmUserDelegate_mmaMessages:addContact' => new lang_string('addcontact', 'message'),
352                 '$mmUserDelegate_mmaMessages:blockContact' => new lang_string('blockcontact', 'message'),
353                 '$mmUserDelegate_mmaNotes:addNote' => new lang_string('addnewnote', 'notes'),
354                 '$mmUserDelegate_picture' => new lang_string('userpic'),
355             ),
356             "$files" => array(
357                 'files_privatefiles' => new lang_string('privatefiles'),
358                 'files_sitefiles' => new lang_string('sitefiles'),
359                 'files_upload' => new lang_string('upload'),
360             ),
361             "$modules" => $coursemodules,
362         );
364         if (!empty($remoteaddonslist)) {
365             $features["$remoteaddons"] = $remoteaddonslist;
366         }
368         return $features;
369     }