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 calendar API
21 * @package core_calendar
23 * @copyright 2012 Ankit Agarwal
24 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
28 defined('MOODLE_INTERNAL') ||
die;
30 require_once("$CFG->libdir/externallib.php");
33 * Calendar external functions
35 * @package core_calendar
37 * @copyright 2012 Ankit Agarwal
38 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
41 class core_calendar_external
extends external_api
{
45 * Returns description of method parameters
47 * @return external_function_parameters
50 public static function delete_calendar_events_parameters() {
51 return new external_function_parameters(
52 array('events' => new external_multiple_structure(
53 new external_single_structure(
55 'eventid' => new external_value(PARAM_INT
, 'Event ID', VALUE_REQUIRED
, '', NULL_NOT_ALLOWED
),
56 'repeat' => new external_value(PARAM_BOOL
, 'Delete comeplete series if repeated event')
57 ), 'List of events to delete'
65 * Delete Calendar events
67 * @param array $eventids A list of event ids with repeat flag to delete
71 public static function delete_calendar_events($events) {
73 require_once($CFG->dirroot
."/calendar/lib.php");
75 // Parameter validation.
76 $params = self
::validate_parameters(self
:: delete_calendar_events_parameters(), array('events' => $events));
78 $transaction = $DB->start_delegated_transaction();
80 foreach ($params['events'] as $event) {
81 $eventobj = calendar_event
::load($event['eventid']);
83 // Let's check if the user is allowed to delete an event.
84 if (!calendar_edit_event_allowed($eventobj)) {
85 throw new moodle_exception("nopermissions");
87 // Time to do the magic.
88 $eventobj->delete($event['repeat']);
91 // Everything done smoothly, let's commit.
92 $transaction->allow_commit();
98 * Returns description of method result value
100 * @return external_description
103 public static function delete_calendar_events_returns() {
108 * Returns description of method parameters
110 * @return external_function_parameters
113 public static function get_calendar_events_parameters() {
114 return new external_function_parameters(
115 array('events' => new external_single_structure(
117 'eventids' => new external_multiple_structure(
118 new external_value(PARAM_INT
, 'event ids')
119 , 'List of event ids',
120 VALUE_DEFAULT
, array(), NULL_ALLOWED
122 'courseids' => new external_multiple_structure(
123 new external_value(PARAM_INT
, 'course ids')
124 , 'List of course ids for which events will be returned',
125 VALUE_DEFAULT
, array(), NULL_ALLOWED
127 'groupids' => new external_multiple_structure(
128 new external_value(PARAM_INT
, 'group ids')
129 , 'List of group ids for which events should be returned',
130 VALUE_DEFAULT
, array(), NULL_ALLOWED
132 ), 'Event details', VALUE_DEFAULT
, array()),
133 'options' => new external_single_structure(
135 'userevents' => new external_value(PARAM_BOOL
,
136 "Set to true to return current user's user events",
137 VALUE_DEFAULT
, true, NULL_ALLOWED
),
138 'siteevents' => new external_value(PARAM_BOOL
,
139 "Set to true to return global events",
140 VALUE_DEFAULT
, true, NULL_ALLOWED
),
141 'timestart' => new external_value(PARAM_INT
,
142 "Time from which events should be returned",
143 VALUE_DEFAULT
, 0, NULL_ALLOWED
),
144 'timeend' => new external_value(PARAM_INT
,
145 "Time to which the events should be returned. We treat 0 and null as no end",
146 VALUE_DEFAULT
, 0, NULL_ALLOWED
),
147 'ignorehidden' => new external_value(PARAM_BOOL
,
148 "Ignore hidden events or not",
149 VALUE_DEFAULT
, true, NULL_ALLOWED
),
151 ), 'Options', VALUE_DEFAULT
, array())
157 * Get Calendar events
159 * @param array $events A list of events
160 * @param array $options various options
161 * @return array Array of event details
164 public static function get_calendar_events($events = array(), $options = array()) {
165 global $SITE, $DB, $USER, $CFG;
166 require_once($CFG->dirroot
."/calendar/lib.php");
168 // Parameter validation.
169 $params = self
::validate_parameters(self
::get_calendar_events_parameters(), array('events' => $events, 'options' => $options));
170 $funcparam = array('courses' => array(), 'groups' => array());
171 $hassystemcap = has_capability('moodle/calendar:manageentries', context_system
::instance());
174 // Let us findout courses that we can return events from.
175 if (!$hassystemcap) {
176 $courses = enrol_get_my_courses('id');
177 $courses = array_keys($courses);
178 foreach ($params['events']['courseids'] as $id) {
180 $context = context_course
::instance($id);
181 self
::validate_context($context);
182 $funcparam['courses'][] = $id;
183 } catch (Exception
$e) {
187 'warningcode' => 'nopermissions',
188 'message' => 'No access rights in course context '.$e->getMessage().$e->getTraceAsString()
193 $courses = $params['events']['courseids'];
194 $funcparam['courses'] = $courses;
197 // Let us findout groups that we can return events from.
198 if (!$hassystemcap) {
199 $groups = groups_get_my_groups();
200 $groups = array_keys($groups);
201 foreach ($params['events']['groupids'] as $id) {
202 if (in_array($id, $groups)) {
203 $funcparam['groups'][] = $id;
205 $warnings[] = array('item' => $id, 'warningcode' => 'nopermissions', 'message' => 'you do not have permissions to access this group');
209 $groups = $params['events']['groupids'];
210 $funcparam['groups'] = $groups;
213 // Do we need user events?
214 if (!empty($params['options']['userevents'])) {
215 $funcparam['users'] = array($USER->id
);
217 $funcparam['users'] = false;
220 // Do we need site events?
221 if (!empty($params['options']['siteevents'])) {
222 $funcparam['courses'][] = $SITE->id
;
225 // We treat 0 and null as no end.
226 if (empty($params['options']['timeend'])) {
227 $params['options']['timeend'] = PHP_INT_MAX
;
230 // Event list does not check visibility and permissions, we'll check that later.
231 $eventlist = calendar_get_events($params['options']['timestart'], $params['options']['timeend'], $funcparam['users'], $funcparam['groups'],
232 $funcparam['courses'], true, $params['options']['ignorehidden']);
234 // WS expects arrays.
237 // We need to get events asked for eventids.
238 if ($eventsbyid = calendar_get_events_by_id($params['events']['eventids'])) {
239 $eventlist +
= $eventsbyid;
242 foreach ($eventlist as $eventid => $eventobj) {
243 $event = (array) $eventobj;
244 // Description formatting.
245 $calendareventobj = new calendar_event($event);
246 list($event['description'], $event['format']) = $calendareventobj->format_external_text();
249 // User can see everything, no further check is needed.
250 $events[$eventid] = $event;
251 } else if (!empty($eventobj->modulename
)) {
252 $cm = get_coursemodule_from_instance($eventobj->modulename
, $eventobj->instance
);
253 if (\core_availability\info_module
::is_user_visible($cm, 0, false)) {
254 $events[$eventid] = $event;
257 // Can the user actually see this event?
258 $eventobj = calendar_event
::load($eventobj);
259 if (($eventobj->courseid
== $SITE->id
) ||
260 (!empty($eventobj->groupid
) && in_array($eventobj->groupid
, $groups)) ||
261 (!empty($eventobj->courseid
) && in_array($eventobj->courseid
, $courses)) ||
262 ($USER->id
== $eventobj->userid
) ||
263 (calendar_edit_event_allowed($eventid))) {
264 $events[$eventid] = $event;
266 $warnings[] = array('item' => $eventid, 'warningcode' => 'nopermissions', 'message' => 'you do not have permissions to view this event');
270 return array('events' => $events, 'warnings' => $warnings);
274 * Returns description of method result value
276 * @return external_description
279 public static function get_calendar_events_returns() {
280 return new external_single_structure(array(
281 'events' => new external_multiple_structure( new external_single_structure(
283 'id' => new external_value(PARAM_INT
, 'event id'),
284 'name' => new external_value(PARAM_TEXT
, 'event name'),
285 'description' => new external_value(PARAM_RAW
, 'Description', VALUE_OPTIONAL
, null, NULL_ALLOWED
),
286 'format' => new external_format_value('description'),
287 'courseid' => new external_value(PARAM_INT
, 'course id'),
288 'groupid' => new external_value(PARAM_INT
, 'group id'),
289 'userid' => new external_value(PARAM_INT
, 'user id'),
290 'repeatid' => new external_value(PARAM_INT
, 'repeat id'),
291 'modulename' => new external_value(PARAM_TEXT
, 'module name', VALUE_OPTIONAL
, null, NULL_ALLOWED
),
292 'instance' => new external_value(PARAM_INT
, 'instance id'),
293 'eventtype' => new external_value(PARAM_TEXT
, 'Event type'),
294 'timestart' => new external_value(PARAM_INT
, 'timestart'),
295 'timeduration' => new external_value(PARAM_INT
, 'time duration'),
296 'visible' => new external_value(PARAM_INT
, 'visible'),
297 'uuid' => new external_value(PARAM_TEXT
, 'unique id of ical events', VALUE_OPTIONAL
, null, NULL_NOT_ALLOWED
),
298 'sequence' => new external_value(PARAM_INT
, 'sequence'),
299 'timemodified' => new external_value(PARAM_INT
, 'time modified'),
300 'subscriptionid' => new external_value(PARAM_INT
, 'Subscription id', VALUE_OPTIONAL
, null, NULL_ALLOWED
),
303 'warnings' => new external_warnings()
309 * Returns description of method parameters.
311 * @return external_function_parameters.
314 public static function create_calendar_events_parameters() {
315 // Userid is always current user, so no need to get it from client.
316 // Module based calendar events are not allowed here. Hence no need of instance and modulename.
317 // subscription id and uuid is not allowed as this is not an ical api.
318 return new external_function_parameters(
319 array('events' => new external_multiple_structure(
320 new external_single_structure(
322 'name' => new external_value(PARAM_TEXT
, 'event name', VALUE_REQUIRED
, '', NULL_NOT_ALLOWED
),
323 'description' => new external_value(PARAM_RAW
, 'Description', VALUE_DEFAULT
, null, NULL_ALLOWED
),
324 'format' => new external_format_value('description', VALUE_DEFAULT
),
325 'courseid' => new external_value(PARAM_INT
, 'course id', VALUE_DEFAULT
, 0, NULL_NOT_ALLOWED
),
326 'groupid' => new external_value(PARAM_INT
, 'group id', VALUE_DEFAULT
, 0, NULL_NOT_ALLOWED
),
327 'repeats' => new external_value(PARAM_INT
, 'number of repeats', VALUE_DEFAULT
, 0, NULL_NOT_ALLOWED
),
328 'eventtype' => new external_value(PARAM_TEXT
, 'Event type', VALUE_DEFAULT
, 'user', NULL_NOT_ALLOWED
),
329 'timestart' => new external_value(PARAM_INT
, 'timestart', VALUE_DEFAULT
, time(), NULL_NOT_ALLOWED
),
330 'timeduration' => new external_value(PARAM_INT
, 'time duration', VALUE_DEFAULT
, 0, NULL_NOT_ALLOWED
),
331 'visible' => new external_value(PARAM_INT
, 'visible', VALUE_DEFAULT
, 1, NULL_NOT_ALLOWED
),
332 'sequence' => new external_value(PARAM_INT
, 'sequence', VALUE_DEFAULT
, 1, NULL_NOT_ALLOWED
),
340 * Delete Calendar events.
342 * @param array $events A list of events to create.
343 * @return array array of events created.
345 * @throws moodle_exception if user doesnt have the permission to create events.
347 public static function create_calendar_events($events) {
348 global $CFG, $DB, $USER;
349 require_once($CFG->dirroot
."/calendar/lib.php");
351 // Parameter validation.
352 $params = self
::validate_parameters(self
::create_calendar_events_parameters(), array('events' => $events));
354 $transaction = $DB->start_delegated_transaction();
358 foreach ($params['events'] as $event) {
360 // Let us set some defaults.
361 $event['userid'] = $USER->id
;
362 $event['modulename'] = '';
363 $event['instance'] = 0;
364 $event['subscriptionid'] = null;
366 $event['format'] = external_validate_format($event['format']);
367 if ($event['repeats'] > 0) {
368 $event['repeat'] = 1;
370 $event['repeat'] = 0;
373 $eventobj = new calendar_event($event);
375 // Let's check if the user is allowed to delete an event.
376 if (!calendar_add_event_allowed($eventobj)) {
377 $warnings [] = array('item' => $event['name'], 'warningcode' => 'nopermissions', 'message' => 'you do not have permissions to create this event');
380 // Let's create the event.
381 $var = $eventobj->create($event);
382 $var = (array)$var->properties();
383 if ($event['repeat']) {
384 $children = $DB->get_records('event', array('repeatid' => $var['id']));
385 foreach ($children as $child) {
386 $return[] = (array) $child;
393 // Everything done smoothly, let's commit.
394 $transaction->allow_commit();
395 return array('events' => $return, 'warnings' => $warnings);
399 * Returns description of method result value.
401 * @return external_description.
404 public static function create_calendar_events_returns() {
405 return new external_single_structure(
407 'events' => new external_multiple_structure( new external_single_structure(
409 'id' => new external_value(PARAM_INT
, 'event id'),
410 'name' => new external_value(PARAM_TEXT
, 'event name'),
411 'description' => new external_value(PARAM_RAW
, 'Description', VALUE_OPTIONAL
),
412 'format' => new external_format_value('description'),
413 'courseid' => new external_value(PARAM_INT
, 'course id'),
414 'groupid' => new external_value(PARAM_INT
, 'group id'),
415 'userid' => new external_value(PARAM_INT
, 'user id'),
416 'repeatid' => new external_value(PARAM_INT
, 'repeat id', VALUE_OPTIONAL
),
417 'modulename' => new external_value(PARAM_TEXT
, 'module name', VALUE_OPTIONAL
),
418 'instance' => new external_value(PARAM_INT
, 'instance id'),
419 'eventtype' => new external_value(PARAM_TEXT
, 'Event type'),
420 'timestart' => new external_value(PARAM_INT
, 'timestart'),
421 'timeduration' => new external_value(PARAM_INT
, 'time duration'),
422 'visible' => new external_value(PARAM_INT
, 'visible'),
423 'uuid' => new external_value(PARAM_TEXT
, 'unique id of ical events', VALUE_OPTIONAL
, '', NULL_NOT_ALLOWED
),
424 'sequence' => new external_value(PARAM_INT
, 'sequence'),
425 'timemodified' => new external_value(PARAM_INT
, 'time modified'),
426 'subscriptionid' => new external_value(PARAM_INT
, 'Subscription id', VALUE_OPTIONAL
),
429 'warnings' => new external_warnings()