2 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
19 * external API for mobile web services
21 * @package core_webservice
23 * @copyright 2011 Jerome Mouneyrac <jerome@moodle.com>
24 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27 defined('MOODLE_INTERNAL') ||
die;
29 require_once("$CFG->libdir/externallib.php");
32 * Web service related functions
34 * @package core_webservice
36 * @copyright 2011 Jerome Mouneyrac <jerome@moodle.com>
37 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40 class core_webservice_external
extends external_api
{
43 * Returns description of method parameters
45 * @return external_function_parameters
48 public static function get_site_info_parameters() {
49 return new external_function_parameters(
50 array('serviceshortnames' => new external_multiple_structure (
54 'DEPRECATED PARAMETER - it was a design error in the original implementation. \
55 It is ignored now. (parameter kept for backward compatibility)',
64 * Return user information including profile picture + basic site information
66 * - no capability checking because we return only known information about logged user
68 * @param array $serviceshortnames - DEPRECATED PARAMETER - values will be ignored -
69 * it was an original design error, we keep for backward compatibility.
70 * @return array site info
73 public static function get_site_info($serviceshortnames = array()) {
74 global $USER, $SITE, $CFG, $DB;
76 $params = self
::validate_parameters(self
::get_site_info_parameters(),
77 array('serviceshortnames'=>$serviceshortnames));
79 $context = context_user
::instance($USER->id
);
80 $profileimageurl = moodle_url
::make_pluginfile_url(
81 $context->id
, 'user', 'icon', null, '/', 'f1');
85 'sitename' => $SITE->fullname
,
86 'siteurl' => $CFG->wwwroot
,
87 'username' => $USER->username
,
88 'firstname' => $USER->firstname
,
89 'lastname' => $USER->lastname
,
90 'fullname' => fullname($USER),
91 'lang' => current_language(),
92 'userid' => $USER->id
,
93 'userpictureurl' => $profileimageurl->out(false)
96 // Retrieve the service and functions from the web service linked to the token
97 // If you call this function directly from external (not a web service call),
98 // then it will still return site info without information about a service
99 // Note: wsusername/wspassword ws authentication is not supported.
100 $functions = array();
101 if ($CFG->enablewebservices
) { // No need to check token if web service are disabled and not a ws call.
102 $token = optional_param('wstoken', '', PARAM_ALPHANUM
);
104 if (!empty($token)) { // No need to run if not a ws call.
105 // Retrieve service shortname.
106 $servicesql = 'SELECT s.*
107 FROM {external_services} s, {external_tokens} t
108 WHERE t.externalserviceid = s.id AND token = ? AND t.userid = ? AND s.enabled = 1';
109 $service = $DB->get_record_sql($servicesql, array($token, $USER->id
));
111 $siteinfo['downloadfiles'] = $service->downloadfiles
;
112 $siteinfo['uploadfiles'] = $service->uploadfiles
;
114 if (!empty($service)) {
115 // Return the release and version number for web service users only.
116 $siteinfo['release'] = $CFG->release
;
117 $siteinfo['version'] = $CFG->version
;
118 // Retrieve the functions.
119 $functionssql = "SELECT f.*
120 FROM {external_functions} f, {external_services_functions} sf
121 WHERE f.name = sf.functionname AND sf.externalserviceid = ?";
122 $functions = $DB->get_records_sql($functionssql, array($service->id
));
124 throw new coding_exception('No service found in get_site_info: something is buggy, \
125 it should have fail at the ws server authentication layer.');
130 // Build up the returned values of the list of functions.
131 $componentversions = array();
132 $availablefunctions = array();
133 foreach ($functions as $function) {
134 $functioninfo = array();
135 $functioninfo['name'] = $function->name
;
136 if ($function->component
== 'moodle' ||
$function->component
== 'core') {
137 $version = $CFG->version
; // Moodle version.
139 $versionpath = core_component
::get_component_directory($function->component
).'/version.php';
140 if (is_readable($versionpath)) {
141 // We store the component version once retrieved (so we don't load twice the version.php).
142 if (!isset($componentversions[$function->component
])) {
143 include($versionpath);
144 $componentversions[$function->component
] = $plugin->version
;
145 $version = $plugin->version
;
147 $version = $componentversions[$function->component
];
150 // Function component should always have a version.php,
151 // otherwise the function should have been described with component => 'moodle'.
152 throw new moodle_exception('missingversionfile', 'webservice', '', $function->component
);
155 $functioninfo['version'] = $version;
156 $availablefunctions[] = $functioninfo;
159 $siteinfo['functions'] = $availablefunctions;
161 // Mobile CSS theme and alternative login url.
162 $siteinfo['mobilecssurl'] = $CFG->mobilecssurl
;
164 // Retrieve some advanced features. Only enable/disable ones (bool).
165 $advancedfeatures = array("usecomments", "usetags", "enablenotes", "messaging", "enableblogs",
166 "enablecompletion", "enablebadges");
167 foreach ($advancedfeatures as $feature) {
168 if (isset($CFG->{$feature})) {
169 $siteinfo['advancedfeatures'][] = array(
171 'value' => (int) $CFG->{$feature}
175 // Special case mnet_dispatcher_mode.
176 $siteinfo['advancedfeatures'][] = array(
177 'name' => 'mnet_dispatcher_mode',
178 'value' => ($CFG->mnet_dispatcher_mode
== 'strict') ?
1 : 0
181 // User can manage own files.
182 $siteinfo['usercanmanageownfiles'] = has_capability('moodle/user:manageownfiles', $context);
184 // User quota. 0 means user can ignore the quota.
185 $siteinfo['userquota'] = 0;
186 if (!has_capability('moodle/user:ignoreuserquota', $context)) {
187 $siteinfo['userquota'] = $CFG->userquota
;
190 // User max upload file size. -1 means the user can ignore the upload file size.
191 $siteinfo['usermaxuploadfilesize'] = get_user_max_upload_file_size($context, $CFG->maxbytes
);
197 * Returns description of method result value
199 * @return external_single_structure
202 public static function get_site_info_returns() {
203 return new external_single_structure(
205 'sitename' => new external_value(PARAM_RAW
, 'site name'),
206 'username' => new external_value(PARAM_RAW
, 'username'),
207 'firstname' => new external_value(PARAM_TEXT
, 'first name'),
208 'lastname' => new external_value(PARAM_TEXT
, 'last name'),
209 'fullname' => new external_value(PARAM_TEXT
, 'user full name'),
210 'lang' => new external_value(PARAM_LANG
, 'user language'),
211 'userid' => new external_value(PARAM_INT
, 'user id'),
212 'siteurl' => new external_value(PARAM_RAW
, 'site url'),
213 'userpictureurl' => new external_value(PARAM_URL
, 'the user profile picture.
214 Warning: this url is the public URL that only works when forcelogin is set to NO and guestaccess is set to YES.
215 In order to retrieve user profile pictures independently of the Moodle config, replace "pluginfile.php" by
216 "webservice/pluginfile.php?token=WSTOKEN&file="
217 Of course the user can only see profile picture depending
218 on his/her permissions. Moreover it is recommended to use HTTPS too.'),
219 'functions' => new external_multiple_structure(
220 new external_single_structure(
222 'name' => new external_value(PARAM_RAW
, 'function name'),
223 'version' => new external_value(PARAM_TEXT
,
224 'The version number of the component to which the function belongs')
225 ), 'functions that are available')
227 'downloadfiles' => new external_value(PARAM_INT
, '1 if users are allowed to download files, 0 if not',
229 'uploadfiles' => new external_value(PARAM_INT
, '1 if users are allowed to upload files, 0 if not',
231 'release' => new external_value(PARAM_TEXT
, 'Moodle release number', VALUE_OPTIONAL
),
232 'version' => new external_value(PARAM_TEXT
, 'Moodle version number', VALUE_OPTIONAL
),
233 'mobilecssurl' => new external_value(PARAM_URL
, 'Mobile custom CSS theme', VALUE_OPTIONAL
),
234 'advancedfeatures' => new external_multiple_structure(
235 new external_single_structure(
237 'name' => new external_value(PARAM_ALPHANUMEXT
, 'feature name'),
238 'value' => new external_value(PARAM_INT
, 'feature value. Usually 1 means enabled.')
240 'Advanced features availability'
242 'Advanced features availability',
245 'usercanmanageownfiles' => new external_value(PARAM_BOOL
,
246 'true if the user can manage his own files', VALUE_OPTIONAL
),
247 'userquota' => new external_value(PARAM_INT
,
248 'user quota (bytes). 0 means user can ignore the quota', VALUE_OPTIONAL
),
249 'usermaxuploadfilesize' => new external_value(PARAM_INT
,
250 'user max upload file size (bytes). -1 means the user can ignore the upload file size',
258 * Deprecated web service related functions
260 * @package core_webservice
262 * @copyright 2011 Jerome Mouneyrac <jerome@moodle.com>
263 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
264 * @deprecated Moodle 2.2 MDL-29106 - please do not use this class any more.
265 * @see core_webservice_external
268 class moodle_webservice_external
extends external_api
{
271 * Returns description of method parameters
273 * @return external_function_parameters
274 * @deprecated Moodle 2.2 - please do not use this function any more.
275 * @see core_webservice_external::get_site_info_parameters
278 public static function get_siteinfo_parameters() {
279 return core_webservice_external
::get_site_info_parameters();
283 * Return user information including profile picture + basic site information
285 * - no capability checking because we return just known information by logged user
287 * @param array $serviceshortnames of service shortnames - the functions of these services will be returned
289 * @deprecated Moodle 2.2 - please do not use this function any more.
290 * @see core_webservice_external::get_site_info
293 public function get_siteinfo($serviceshortnames = array()) {
294 return core_webservice_external
::get_site_info($serviceshortnames);
298 * Returns description of method result value
300 * @return external_single_structure
301 * @deprecated Moodle 2.2 - please do not use this function any more.
302 * @see core_webservice_external::get_site_info_returns
305 public static function get_siteinfo_returns() {
306 return core_webservice_external
::get_site_info_returns();
310 * Marking the method as deprecated.
314 public static function get_siteinfo_is_deprecated() {