weekly release 3.2dev
[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;
b2478ed0
JL
32
33/**
34 * API exposed by tool_mobile
35 *
36 * @copyright 2016 Juan Leyva
37 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38 * @since Moodle 3.1
39 */
40class api {
41
c951f1fe
JL
42 /** @var int to identify the login via app. */
43 const LOGIN_VIA_APP = 1;
44 /** @var int to identify the login via browser. */
45 const LOGIN_VIA_BROWSER = 2;
46 /** @var int to identify the login via an embedded browser. */
47 const LOGIN_VIA_EMBEDDED_BROWSER = 3;
961c9549
JL
48 /** @var int seconds an auto-login key will expire. */
49 const LOGIN_KEY_TTL = 60;
c951f1fe 50
b2478ed0
JL
51 /**
52 * Returns a list of Moodle plugins supporting the mobile app.
53 *
54 * @return array an array of objects containing the plugin information
55 */
56 public static function get_plugins_supporting_mobile() {
57 global $CFG;
58 require_once($CFG->libdir . '/adminlib.php');
59
60 $pluginsinfo = [];
61 $plugintypes = core_component::get_plugin_types();
62
63 foreach ($plugintypes as $plugintype => $unused) {
64 // We need to include files here.
65 $pluginswithfile = core_component::get_plugin_list_with_file($plugintype, 'db' . DIRECTORY_SEPARATOR . 'mobile.php');
66 foreach ($pluginswithfile as $plugin => $notused) {
67 $path = core_component::get_plugin_directory($plugintype, $plugin);
68 $component = $plugintype . '_' . $plugin;
69 $version = get_component_version($component);
70
71 require_once("$path/db/mobile.php");
72 foreach ($addons as $addonname => $addoninfo) {
73 $plugininfo = array(
74 'component' => $component,
75 'version' => $version,
76 'addon' => $addonname,
b4baee42 77 'dependencies' => !empty($addoninfo['dependencies']) ? $addoninfo['dependencies'] : array(),
b2478ed0
JL
78 'fileurl' => '',
79 'filehash' => '',
80 'filesize' => 0
81 );
82
83 // All the mobile packages must be under the plugin mobile directory.
84 $package = $path . DIRECTORY_SEPARATOR . 'mobile' . DIRECTORY_SEPARATOR . $addonname . '.zip';
85 if (file_exists($package)) {
86 $plugininfo['fileurl'] = $CFG->wwwroot . '' . str_replace($CFG->dirroot, '', $package);
87 $plugininfo['filehash'] = sha1_file($package);
88 $plugininfo['filesize'] = filesize($package);
89 }
90 $pluginsinfo[] = $plugininfo;
91 }
92 }
93 }
94 return $pluginsinfo;
95 }
96
0002056f
JL
97 /**
98 * Returns a list of the site public settings, those not requiring authentication.
99 *
100 * @return array with the settings and warnings
101 */
7c1cb3bf 102 public static function get_public_config() {
0002056f
JL
103 global $CFG, $SITE, $PAGE;
104
105 $context = context_system::instance();
106 // We need this to make work the format text functions.
107 $PAGE->set_context($context);
108
109 $settings = array(
110 'wwwroot' => $CFG->wwwroot,
111 'httpswwwroot' => $CFG->httpswwwroot,
112 'sitename' => external_format_string($SITE->fullname, $context->id, true),
113 'guestlogin' => $CFG->guestloginbutton,
114 'rememberusername' => $CFG->rememberusername,
115 'authloginviaemail' => $CFG->authloginviaemail,
116 'registerauth' => $CFG->registerauth,
117 'forgottenpasswordurl' => $CFG->forgottenpasswordurl,
118 'authinstructions' => format_text($CFG->auth_instructions),
119 'authnoneenabled' => (int) is_enabled_auth('none'),
120 'enablewebservices' => $CFG->enablewebservices,
121 'enablemobilewebservice' => $CFG->enablemobilewebservice,
122 'maintenanceenabled' => $CFG->maintenance_enabled,
123 'maintenancemessage' => format_text($CFG->maintenance_message),
124 );
c951f1fe
JL
125
126 $typeoflogin = get_config('tool_mobile', 'typeoflogin');
127 // Not found, edge case.
128 if ($typeoflogin === false) {
129 $typeoflogin = self::LOGIN_VIA_APP; // Defaults to via app.
130 }
131 $settings['typeoflogin'] = $typeoflogin;
132
133 if ($typeoflogin == self::LOGIN_VIA_BROWSER or
134 $typeoflogin == self::LOGIN_VIA_EMBEDDED_BROWSER) {
135 $url = new moodle_url("/$CFG->admin/tool/mobile/launch.php");
136 $settings['launchurl'] = $url->out(false);
137 }
0002056f
JL
138 return $settings;
139 }
140
6b492628
JL
141 /**
142 * Returns a list of site configurations, filtering by section.
143 *
144 * @param string $section section name
145 * @return stdClass object containing the settings
146 */
147 public static function get_config($section) {
148 global $CFG, $SITE;
149
150 $settings = new \stdClass;
151 $context = context_system::instance();
152 $isadmin = has_capability('moodle/site:config', $context);
153
154 if (empty($section) or $section == 'frontpagesettings') {
155 require_once($CFG->dirroot . '/course/format/lib.php');
156 // First settings that anyone can deduce.
157 $settings->fullname = $SITE->fullname;
158 $settings->shortname = $SITE->shortname;
159 $settings->summary = $SITE->summary;
160 $settings->frontpage = $CFG->frontpage;
161 $settings->frontpageloggedin = $CFG->frontpageloggedin;
162 $settings->maxcategorydepth = $CFG->maxcategorydepth;
163 $settings->frontpagecourselimit = $CFG->frontpagecourselimit;
164 $settings->numsections = course_get_format($SITE)->get_course()->numsections;
165 $settings->newsitems = $SITE->newsitems;
166 $settings->commentsperpage = $CFG->commentsperpage;
167
168 // Now, admin settings.
169 if ($isadmin) {
170 $settings->defaultfrontpageroleid = $CFG->defaultfrontpageroleid;
171 }
172 }
173
174 if (empty($section) or $section == 'sitepolicies') {
175 $settings->disableuserimages = $CFG->disableuserimages;
176 }
177
178 if (empty($section) or $section == 'gradessettings') {
179 require_once($CFG->dirroot . '/user/lib.php');
180 $settings->mygradesurl = user_mygrades_url()->out(false);
181 }
182
183 return $settings;
184 }
185
961c9549
JL
186 /*
187 * Check if all the required conditions are met to allow the auto-login process continue.
188 *
189 * @param int $userid current user id
190 * @since Moodle 3.2
191 * @throws moodle_exception
192 */
193 public static function check_autologin_prerequisites($userid) {
194 global $CFG;
195
196 if (!$CFG->enablewebservices or !$CFG->enablemobilewebservice) {
197 throw new moodle_exception('enablewsdescription', 'webservice');
198 }
199
200 if (!is_https()) {
201 throw new moodle_exception('httpsrequired', 'tool_mobile');
202 }
203
204 if (has_capability('moodle/site:config', context_system::instance(), $userid) or is_siteadmin($userid)) {
205 throw new moodle_exception('autologinnotallowedtoadmins', 'tool_mobile');
206 }
207 }
208
209 /**
210 * Creates an auto-login key for the current user, this key is restricted by time and ip address.
211 *
212 * @return string the key
213 * @since Moodle 3.2
214 */
215 public static function get_autologin_key() {
216 global $USER;
217 // Delete previous keys.
218 delete_user_key('tool_mobile', $USER->id);
219
220 // Create a new key.
221 $iprestriction = getremoteaddr();
222 $validuntil = time() + self::LOGIN_KEY_TTL;
223 return create_user_key('tool_mobile', $USER->id, null, $iprestriction, $validuntil);
224 }
b2478ed0 225}