MDL-70237 payment: Allow html tags in gateway description
[moodle.git] / calendar / lib.php
CommitLineData
93c91ee4 1<?php
08b4a4e1
RW
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/>.
7423f116 16
08b4a4e1
RW
17/**
18 * Calendar extension
19 *
20 * @package core_calendar
21 * @copyright 2004 Greek School Network (http://www.sch.gr), Jon Papaioannou,
22 * Avgoustos Tsinakos
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24 */
25
e30390a0
SH
26if (!defined('MOODLE_INTERNAL')) {
27 die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page
28}
b5a52acd 29
08b4a4e1
RW
30/**
31 * These are read by the administration component to provide default values
32 */
33
34/**
35 * CALENDAR_DEFAULT_UPCOMING_LOOKAHEAD - default value of upcoming event preference
36 */
bb4a2e85 37define('CALENDAR_DEFAULT_UPCOMING_LOOKAHEAD', 21);
08b4a4e1
RW
38
39/**
40 * CALENDAR_DEFAULT_UPCOMING_MAXEVENTS - default value to display the maximum number of upcoming event
41 */
bb4a2e85 42define('CALENDAR_DEFAULT_UPCOMING_MAXEVENTS', 10);
08b4a4e1
RW
43
44/**
45 * CALENDAR_DEFAULT_STARTING_WEEKDAY - default value to display the starting weekday
46 */
47define('CALENDAR_DEFAULT_STARTING_WEEKDAY', 1);
48
bb4a2e85 49// This is a packed bitfield: day X is "weekend" if $field & (1 << X) is true
50// Default value = 65 = 64 + 1 = 2^6 + 2^0 = Saturday & Sunday
08b4a4e1
RW
51
52/**
53 * CALENDAR_DEFAULT_WEEKEND - default value for weekend (Saturday & Sunday)
54 */
55define('CALENDAR_DEFAULT_WEEKEND', 65);
56
57/**
58 * CALENDAR_URL - path to calendar's folder
59 */
76d9df3f 60define('CALENDAR_URL', $CFG->wwwroot.'/calendar/');
08b4a4e1
RW
61
62/**
63 * CALENDAR_TF_24 - Calendar time in 24 hours format
64 */
76d9df3f 65define('CALENDAR_TF_24', '%H:%M');
08b4a4e1
RW
66
67/**
68 * CALENDAR_TF_12 - Calendar time in 12 hours format
69 */
76d9df3f 70define('CALENDAR_TF_12', '%I:%M %p');
bb4a2e85 71
08b4a4e1 72/**
375d82ca
PFO
73 * CALENDAR_EVENT_GLOBAL - Site calendar event types
74 * @deprecated since 3.8
08b4a4e1 75 */
797cedc7 76define('CALENDAR_EVENT_GLOBAL', 1);
08b4a4e1 77
375d82ca
PFO
78/**
79 * CALENDAR_EVENT_SITE - Site calendar event types
80 */
81define('CALENDAR_EVENT_SITE', 1);
82
08b4a4e1
RW
83/**
84 * CALENDAR_EVENT_COURSE - Course calendar event types
85 */
797cedc7 86define('CALENDAR_EVENT_COURSE', 2);
08b4a4e1
RW
87
88/**
89 * CALENDAR_EVENT_GROUP - group calendar event types
90 */
797cedc7 91define('CALENDAR_EVENT_GROUP', 4);
08b4a4e1
RW
92
93/**
94 * CALENDAR_EVENT_USER - user calendar event types
95 */
797cedc7
SH
96define('CALENDAR_EVENT_USER', 8);
97
05f184bb
AN
98/**
99 * CALENDAR_EVENT_COURSECAT - Course category calendar event types
100 */
101define('CALENDAR_EVENT_COURSECAT', 16);
7423f116 102
b5a52acd
JH
103/**
104 * CALENDAR_IMPORT_FROM_FILE - import the calendar from a file
105 */
106define('CALENDAR_IMPORT_FROM_FILE', 0);
107
108/**
109 * CALENDAR_IMPORT_FROM_URL - import the calendar from a URL
110 */
111define('CALENDAR_IMPORT_FROM_URL', 1);
112
d5727ed3
SL
113/**
114 * CALENDAR_IMPORT_EVENT_UPDATED_SKIPPED - imported event was skipped
115 */
116define('CALENDAR_IMPORT_EVENT_SKIPPED', -1);
117
b5a52acd
JH
118/**
119 * CALENDAR_IMPORT_EVENT_UPDATED - imported event was updated
120 */
121define('CALENDAR_IMPORT_EVENT_UPDATED', 1);
122
123/**
124 * CALENDAR_IMPORT_EVENT_INSERTED - imported event was added by insert
125 */
126define('CALENDAR_IMPORT_EVENT_INSERTED', 2);
127
ee74a2a1
AA
128/**
129 * CALENDAR_SUBSCRIPTION_UPDATE - Used to represent update action for subscriptions in various forms.
130 */
131define('CALENDAR_SUBSCRIPTION_UPDATE', 1);
132
133/**
134 * CALENDAR_SUBSCRIPTION_REMOVE - Used to represent remove action for subscriptions in various forms.
135 */
136define('CALENDAR_SUBSCRIPTION_REMOVE', 2);
137
ca75ec4f
JP
138/**
139 * CALENDAR_EVENT_USER_OVERRIDE_PRIORITY - Constant for the user override priority.
140 */
a776415d 141define('CALENDAR_EVENT_USER_OVERRIDE_PRIORITY', 0);
ca75ec4f 142
5ca71c2d
CB
143/**
144 * CALENDAR_EVENT_TYPE_STANDARD - Standard events.
145 */
146define('CALENDAR_EVENT_TYPE_STANDARD', 0);
147
148/**
149 * CALENDAR_EVENT_TYPE_ACTION - Action events.
150 */
151define('CALENDAR_EVENT_TYPE_ACTION', 1);
152
e1cd93ce
MN
153/**
154 * Manage calendar events.
155 *
156 * This class provides the required functionality in order to manage calendar events.
157 * It was introduced as part of Moodle 2.0 and was created in order to provide a
158 * better framework for dealing with calendar events in particular regard to file
159 * handling through the new file API.
160 *
161 * @package core_calendar
162 * @category calendar
163 * @copyright 2009 Sam Hemelryk
164 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
165 *
166 * @property int $id The id within the event table
167 * @property string $name The name of the event
168 * @property string $description The description of the event
169 * @property int $format The format of the description FORMAT_?
170 * @property int $courseid The course the event is associated with (0 if none)
171 * @property int $groupid The group the event is associated with (0 if none)
172 * @property int $userid The user the event is associated with (0 if none)
173 * @property int $repeatid If this is a repeated event this will be set to the
174 * id of the original
1a972b06 175 * @property string $component If created by a plugin/component (other than module), the full frankenstyle name of a component
e1cd93ce
MN
176 * @property string $modulename If added by a module this will be the module name
177 * @property int $instance If added by a module this will be the module instance
178 * @property string $eventtype The event type
179 * @property int $timestart The start time as a timestamp
180 * @property int $timeduration The duration of the event in seconds
364d4cae 181 * @property int $timeusermidnight User midnight for the event
e1cd93ce
MN
182 * @property int $visible 1 if the event is visible
183 * @property int $uuid ?
184 * @property int $sequence ?
185 * @property int $timemodified The time last modified as a timestamp
186 */
187class calendar_event {
188
189 /** @var array An object containing the event properties can be accessed via the magic __get/set methods */
190 protected $properties = null;
191
192 /** @var string The converted event discription with file paths resolved.
193 * This gets populated when someone requests description for the first time */
194 protected $_description = null;
195
196 /** @var array The options to use with this description editor */
197 protected $editoroptions = array(
198 'subdirs' => false,
199 'forcehttps' => false,
200 'maxfiles' => -1,
201 'maxbytes' => null,
202 'trusttext' => false);
203
204 /** @var object The context to use with the description editor */
205 protected $editorcontext = null;
206
207 /**
208 * Instantiates a new event and optionally populates its properties with the data provided.
209 *
210 * @param \stdClass $data Optional. An object containing the properties to for
211 * an event
212 */
213 public function __construct($data = null) {
214 global $CFG, $USER;
215
216 // First convert to object if it is not already (should either be object or assoc array).
217 if (!is_object($data)) {
218 $data = (object) $data;
219 }
220
221 $this->editoroptions['maxbytes'] = $CFG->maxbytes;
222
223 $data->eventrepeats = 0;
224
225 if (empty($data->id)) {
226 $data->id = null;
227 }
228
229 if (!empty($data->subscriptionid)) {
23a29de7 230 $data->subscription = calendar_get_subscription($data->subscriptionid);
e1cd93ce
MN
231 }
232
233 // Default to a user event.
234 if (empty($data->eventtype)) {
235 $data->eventtype = 'user';
236 }
237
238 // Default to the current user.
239 if (empty($data->userid)) {
240 $data->userid = $USER->id;
241 }
242
243 if (!empty($data->timeduration) && is_array($data->timeduration)) {
244 $data->timeduration = make_timestamp(
245 $data->timeduration['year'], $data->timeduration['month'], $data->timeduration['day'],
246 $data->timeduration['hour'], $data->timeduration['minute']) - $data->timestart;
247 }
248
249 if (!empty($data->description) && is_array($data->description)) {
250 $data->format = $data->description['format'];
251 $data->description = $data->description['text'];
252 } else if (empty($data->description)) {
253 $data->description = '';
254 $data->format = editors_get_preferred_format();
255 }
256
257 // Ensure form is defaulted correctly.
258 if (empty($data->format)) {
259 $data->format = editors_get_preferred_format();
260 }
261
1a972b06
MG
262 if (empty($data->component)) {
263 $data->component = null;
264 }
265
e1cd93ce 266 $this->properties = $data;
e1cd93ce
MN
267 }
268
269 /**
270 * Magic set method.
271 *
272 * Attempts to call a set_$key method if one exists otherwise falls back
273 * to simply set the property.
274 *
275 * @param string $key property name
276 * @param mixed $value value of the property
277 */
278 public function __set($key, $value) {
279 if (method_exists($this, 'set_'.$key)) {
280 $this->{'set_'.$key}($value);
281 }
282 $this->properties->{$key} = $value;
283 }
284
285 /**
286 * Magic get method.
287 *
288 * Attempts to call a get_$key method to return the property and ralls over
289 * to return the raw property.
290 *
291 * @param string $key property name
292 * @return mixed property value
293 * @throws \coding_exception
294 */
295 public function __get($key) {
296 if (method_exists($this, 'get_'.$key)) {
297 return $this->{'get_'.$key}();
298 }
2a8e41b9 299 if (!property_exists($this->properties, $key)) {
e1cd93ce
MN
300 throw new \coding_exception('Undefined property requested');
301 }
302 return $this->properties->{$key};
303 }
304
305 /**
306 * Magic isset method.
307 *
308 * PHP needs an isset magic method if you use the get magic method and
309 * still want empty calls to work.
310 *
311 * @param string $key $key property name
312 * @return bool|mixed property value, false if property is not exist
313 */
314 public function __isset($key) {
315 return !empty($this->properties->{$key});
316 }
317
318 /**
319 * Calculate the context value needed for an event.
320 *
321 * Event's type can be determine by the available value store in $data
322 * It is important to check for the existence of course/courseid to determine
323 * the course event.
324 * Default value is set to CONTEXT_USER
325 *
326 * @return \stdClass The context object.
327 */
328 protected function calculate_context() {
329 global $USER, $DB;
330
331 $context = null;
303d649a
AN
332 if (isset($this->properties->categoryid) && $this->properties->categoryid > 0) {
333 $context = \context_coursecat::instance($this->properties->categoryid);
334 } else if (isset($this->properties->courseid) && $this->properties->courseid > 0) {
e1cd93ce
MN
335 $context = \context_course::instance($this->properties->courseid);
336 } else if (isset($this->properties->course) && $this->properties->course > 0) {
337 $context = \context_course::instance($this->properties->course);
338 } else if (isset($this->properties->groupid) && $this->properties->groupid > 0) {
339 $group = $DB->get_record('groups', array('id' => $this->properties->groupid));
340 $context = \context_course::instance($group->courseid);
341 } else if (isset($this->properties->userid) && $this->properties->userid > 0
342 && $this->properties->userid == $USER->id) {
343 $context = \context_user::instance($this->properties->userid);
344 } else if (isset($this->properties->userid) && $this->properties->userid > 0
345 && $this->properties->userid != $USER->id &&
1a972b06 346 !empty($this->properties->modulename) &&
e1cd93ce
MN
347 isset($this->properties->instance) && $this->properties->instance > 0) {
348 $cm = get_coursemodule_from_instance($this->properties->modulename, $this->properties->instance, 0,
349 false, MUST_EXIST);
350 $context = \context_course::instance($cm->course);
351 } else {
352 $context = \context_user::instance($this->properties->userid);
353 }
354
355 return $context;
356 }
357
08a79155
RW
358 /**
359 * Returns the context for this event. The context is calculated
360 * the first time is is requested and then stored in a member
361 * variable to be returned each subsequent time.
362 *
363 * This is a magical getter function that will be called when
364 * ever the context property is accessed, e.g. $event->context.
365 *
366 * @return context
367 */
368 protected function get_context() {
369 if (!isset($this->properties->context)) {
370 $this->properties->context = $this->calculate_context();
371 }
372
373 return $this->properties->context;
374 }
375
e1cd93ce
MN
376 /**
377 * Returns an array of editoroptions for this event.
378 *
379 * @return array event editor options
380 */
381 protected function get_editoroptions() {
382 return $this->editoroptions;
383 }
384
385 /**
386 * Returns an event description: Called by __get
387 * Please use $blah = $event->description;
388 *
389 * @return string event description
390 */
391 protected function get_description() {
392 global $CFG;
393
394 require_once($CFG->libdir . '/filelib.php');
395
396 if ($this->_description === null) {
397 // Check if we have already resolved the context for this event.
398 if ($this->editorcontext === null) {
399 // Switch on the event type to decide upon the appropriate context to use for this event.
08a79155 400 $this->editorcontext = $this->get_context();
05f184bb 401 if (!calendar_is_valid_eventtype($this->properties->eventtype)) {
e1cd93ce
MN
402 return clean_text($this->properties->description, $this->properties->format);
403 }
404 }
405
406 // Work out the item id for the editor, if this is a repeated event
407 // then the files will be associated with the original.
408 if (!empty($this->properties->repeatid) && $this->properties->repeatid > 0) {
409 $itemid = $this->properties->repeatid;
410 } else {
411 $itemid = $this->properties->id;
412 }
413
414 // Convert file paths in the description so that things display correctly.
415 $this->_description = file_rewrite_pluginfile_urls($this->properties->description, 'pluginfile.php',
416 $this->editorcontext->id, 'calendar', 'event_description', $itemid);
417 // Clean the text so no nasties get through.
418 $this->_description = clean_text($this->_description, $this->properties->format);
419 }
420
421 // Finally return the description.
422 return $this->_description;
423 }
424
425 /**
426 * Return the number of repeat events there are in this events series.
427 *
428 * @return int number of event repeated
429 */
430 public function count_repeats() {
431 global $DB;
432 if (!empty($this->properties->repeatid)) {
433 $this->properties->eventrepeats = $DB->count_records('event',
434 array('repeatid' => $this->properties->repeatid));
435 // We don't want to count ourselves.
436 $this->properties->eventrepeats--;
437 }
438 return $this->properties->eventrepeats;
439 }
440
441 /**
442 * Update or create an event within the database
443 *
444 * Pass in a object containing the event properties and this function will
445 * insert it into the database and deal with any associated files
446 *
656837d6
NM
447 * Capability checking should be performed if the user is directly manipulating the event
448 * and no other capability has been tested. However if the event is not being manipulated
449 * directly by the user and another capability has been checked for them to do this then
450 * capabilites should not be checked.
451 *
452 * For example if a user is editing an event in the calendar the check should be true,
453 * but if you are updating an event in an activities settings are changed then the calendar
454 * capabilites should not be checked.
455 *
e1cd93ce
MN
456 * @see self::create()
457 * @see self::update()
458 *
459 * @param \stdClass $data object of event
656837d6 460 * @param bool $checkcapability If Moodle should check the user can manage the calendar events for this call or not.
e1cd93ce
MN
461 * @return bool event updated
462 */
463 public function update($data, $checkcapability=true) {
464 global $DB, $USER;
465
466 foreach ($data as $key => $value) {
467 $this->properties->$key = $value;
468 }
469
470 $this->properties->timemodified = time();
471 $usingeditor = (!empty($this->properties->description) && is_array($this->properties->description));
472
473 // Prepare event data.
474 $eventargs = array(
08a79155 475 'context' => $this->get_context(),
e1cd93ce
MN
476 'objectid' => $this->properties->id,
477 'other' => array(
478 'repeatid' => empty($this->properties->repeatid) ? 0 : $this->properties->repeatid,
479 'timestart' => $this->properties->timestart,
480 'name' => $this->properties->name
481 )
482 );
483
484 if (empty($this->properties->id) || $this->properties->id < 1) {
e1cd93ce 485 if ($checkcapability) {
23a29de7 486 if (!calendar_add_event_allowed($this->properties)) {
e1cd93ce
MN
487 print_error('nopermissiontoupdatecalendar');
488 }
489 }
490
491 if ($usingeditor) {
492 switch ($this->properties->eventtype) {
493 case 'user':
494 $this->properties->courseid = 0;
495 $this->properties->course = 0;
496 $this->properties->groupid = 0;
497 $this->properties->userid = $USER->id;
498 break;
499 case 'site':
500 $this->properties->courseid = SITEID;
501 $this->properties->course = SITEID;
502 $this->properties->groupid = 0;
503 $this->properties->userid = $USER->id;
504 break;
505 case 'course':
506 $this->properties->groupid = 0;
507 $this->properties->userid = $USER->id;
508 break;
05f184bb
AN
509 case 'category':
510 $this->properties->groupid = 0;
511 $this->properties->category = 0;
512 $this->properties->userid = $USER->id;
513 break;
e1cd93ce
MN
514 case 'group':
515 $this->properties->userid = $USER->id;
516 break;
517 default:
518 // We should NEVER get here, but just incase we do lets fail gracefully.
519 $usingeditor = false;
520 break;
521 }
522
523 // If we are actually using the editor, we recalculate the context because some default values
524 // were set when calculate_context() was called from the constructor.
525 if ($usingeditor) {
526 $this->properties->context = $this->calculate_context();
08a79155 527 $this->editorcontext = $this->get_context();
e1cd93ce
MN
528 }
529
530 $editor = $this->properties->description;
531 $this->properties->format = $this->properties->description['format'];
532 $this->properties->description = $this->properties->description['text'];
533 }
534
535 // Insert the event into the database.
536 $this->properties->id = $DB->insert_record('event', $this->properties);
537
538 if ($usingeditor) {
539 $this->properties->description = file_save_draft_area_files(
540 $editor['itemid'],
541 $this->editorcontext->id,
542 'calendar',
543 'event_description',
544 $this->properties->id,
545 $this->editoroptions,
546 $editor['text'],
547 $this->editoroptions['forcehttps']);
548 $DB->set_field('event', 'description', $this->properties->description,
549 array('id' => $this->properties->id));
550 }
551
552 // Log the event entry.
553 $eventargs['objectid'] = $this->properties->id;
08a79155 554 $eventargs['context'] = $this->get_context();
e1cd93ce
MN
555 $event = \core\event\calendar_event_created::create($eventargs);
556 $event->trigger();
557
558 $repeatedids = array();
559
560 if (!empty($this->properties->repeat)) {
561 $this->properties->repeatid = $this->properties->id;
562 $DB->set_field('event', 'repeatid', $this->properties->repeatid, array('id' => $this->properties->id));
563
564 $eventcopy = clone($this->properties);
565 unset($eventcopy->id);
566
567 $timestart = new \DateTime('@' . $eventcopy->timestart);
568 $timestart->setTimezone(\core_date::get_user_timezone_object());
569
570 for ($i = 1; $i < $eventcopy->repeats; $i++) {
571
572 $timestart->add(new \DateInterval('P7D'));
573 $eventcopy->timestart = $timestart->getTimestamp();
574
575 // Get the event id for the log record.
576 $eventcopyid = $DB->insert_record('event', $eventcopy);
577
578 // If the context has been set delete all associated files.
579 if ($usingeditor) {
580 $fs = get_file_storage();
581 $files = $fs->get_area_files($this->editorcontext->id, 'calendar', 'event_description',
582 $this->properties->id);
583 foreach ($files as $file) {
584 $fs->create_file_from_storedfile(array('itemid' => $eventcopyid), $file);
585 }
586 }
587
588 $repeatedids[] = $eventcopyid;
589
590 // Trigger an event.
591 $eventargs['objectid'] = $eventcopyid;
592 $eventargs['other']['timestart'] = $eventcopy->timestart;
593 $event = \core\event\calendar_event_created::create($eventargs);
594 $event->trigger();
595 }
596 }
597
598 return true;
599 } else {
600
601 if ($checkcapability) {
23a29de7 602 if (!calendar_edit_event_allowed($this->properties)) {
e1cd93ce
MN
603 print_error('nopermissiontoupdatecalendar');
604 }
605 }
606
607 if ($usingeditor) {
608 if ($this->editorcontext !== null) {
609 $this->properties->description = file_save_draft_area_files(
610 $this->properties->description['itemid'],
611 $this->editorcontext->id,
612 'calendar',
613 'event_description',
614 $this->properties->id,
615 $this->editoroptions,
616 $this->properties->description['text'],
617 $this->editoroptions['forcehttps']);
618 } else {
619 $this->properties->format = $this->properties->description['format'];
620 $this->properties->description = $this->properties->description['text'];
621 }
622 }
623
624 $event = $DB->get_record('event', array('id' => $this->properties->id));
625
626 $updaterepeated = (!empty($this->properties->repeatid) && !empty($this->properties->repeateditall));
627
628 if ($updaterepeated) {
90e331bc
TR
629
630 $sqlset = 'name = ?,
631 description = ?,
632 timeduration = ?,
633 timemodified = ?,
634 groupid = ?,
635 courseid = ?';
636
637 // Note: Group and course id may not be set. If not, keep their current values.
638 $params = [
639 $this->properties->name,
640 $this->properties->description,
641 $this->properties->timeduration,
642 time(),
643 isset($this->properties->groupid) ? $this->properties->groupid : $event->groupid,
644 isset($this->properties->courseid) ? $this->properties->courseid : $event->courseid,
645 ];
646
647 // Note: Only update start date, if it was changed by the user.
e1cd93ce
MN
648 if ($this->properties->timestart != $event->timestart) {
649 $timestartoffset = $this->properties->timestart - $event->timestart;
90e331bc
TR
650 $sqlset .= ', timestart = timestart + ?';
651 $params[] = $timestartoffset;
652 }
653
654 // Note: Only update location, if it was changed by the user.
655 $updatelocation = (!empty($this->properties->location) && $this->properties->location !== $event->location);
656 if ($updatelocation) {
657 $sqlset .= ', location = ?';
658 $params[] = $this->properties->location;
e1cd93ce 659 }
90e331bc
TR
660
661 // Update all.
662 $sql = "UPDATE {event}
663 SET $sqlset
664 WHERE repeatid = ?";
665
666 $params[] = $event->repeatid;
e1cd93ce
MN
667 $DB->execute($sql, $params);
668
669 // Trigger an update event for each of the calendar event.
670 $events = $DB->get_records('event', array('repeatid' => $event->repeatid), '', '*');
671 foreach ($events as $calendarevent) {
672 $eventargs['objectid'] = $calendarevent->id;
673 $eventargs['other']['timestart'] = $calendarevent->timestart;
674 $event = \core\event\calendar_event_updated::create($eventargs);
675 $event->add_record_snapshot('event', $calendarevent);
676 $event->trigger();
677 }
678 } else {
679 $DB->update_record('event', $this->properties);
680 $event = self::load($this->properties->id);
681 $this->properties = $event->properties();
682
683 // Trigger an update event.
684 $event = \core\event\calendar_event_updated::create($eventargs);
685 $event->add_record_snapshot('event', $this->properties);
686 $event->trigger();
687 }
688
689 return true;
690 }
691 }
692
693 /**
694 * Deletes an event and if selected an repeated events in the same series
695 *
696 * This function deletes an event, any associated events if $deleterepeated=true,
697 * and cleans up any files associated with the events.
698 *
699 * @see self::delete()
700 *
701 * @param bool $deleterepeated delete event repeatedly
702 * @return bool succession of deleting event
703 */
704 public function delete($deleterepeated = false) {
705 global $DB;
706
707 // If $this->properties->id is not set then something is wrong.
708 if (empty($this->properties->id)) {
709 debugging('Attempting to delete an event before it has been loaded', DEBUG_DEVELOPER);
710 return false;
711 }
712 $calevent = $DB->get_record('event', array('id' => $this->properties->id), '*', MUST_EXIST);
713 // Delete the event.
714 $DB->delete_records('event', array('id' => $this->properties->id));
715
716 // Trigger an event for the delete action.
717 $eventargs = array(
08a79155 718 'context' => $this->get_context(),
e1cd93ce
MN
719 'objectid' => $this->properties->id,
720 'other' => array(
721 'repeatid' => empty($this->properties->repeatid) ? 0 : $this->properties->repeatid,
722 'timestart' => $this->properties->timestart,
723 'name' => $this->properties->name
724 ));
725 $event = \core\event\calendar_event_deleted::create($eventargs);
726 $event->add_record_snapshot('event', $calevent);
727 $event->trigger();
728
729 // If we are deleting parent of a repeated event series, promote the next event in the series as parent.
730 if (($this->properties->id == $this->properties->repeatid) && !$deleterepeated) {
731 $newparent = $DB->get_field_sql("SELECT id from {event} where repeatid = ? order by id ASC",
732 array($this->properties->id), IGNORE_MULTIPLE);
733 if (!empty($newparent)) {
734 $DB->execute("UPDATE {event} SET repeatid = ? WHERE repeatid = ?",
735 array($newparent, $this->properties->id));
736 // Get all records where the repeatid is the same as the event being removed.
737 $events = $DB->get_records('event', array('repeatid' => $newparent));
738 // For each of the returned events trigger an update event.
739 foreach ($events as $calendarevent) {
740 // Trigger an event for the update.
741 $eventargs['objectid'] = $calendarevent->id;
742 $eventargs['other']['timestart'] = $calendarevent->timestart;
743 $event = \core\event\calendar_event_updated::create($eventargs);
744 $event->add_record_snapshot('event', $calendarevent);
745 $event->trigger();
746 }
747 }
748 }
749
750 // If the editor context hasn't already been set then set it now.
751 if ($this->editorcontext === null) {
08a79155 752 $this->editorcontext = $this->get_context();
e1cd93ce
MN
753 }
754
755 // If the context has been set delete all associated files.
756 if ($this->editorcontext !== null) {
757 $fs = get_file_storage();
758 $files = $fs->get_area_files($this->editorcontext->id, 'calendar', 'event_description', $this->properties->id);
759 foreach ($files as $file) {
760 $file->delete();
761 }
762 }
763
764 // If we need to delete repeated events then we will fetch them all and delete one by one.
765 if ($deleterepeated && !empty($this->properties->repeatid) && $this->properties->repeatid > 0) {
766 // Get all records where the repeatid is the same as the event being removed.
767 $events = $DB->get_records('event', array('repeatid' => $this->properties->repeatid));
768 // For each of the returned events populate an event object and call delete.
769 // make sure the arg passed is false as we are already deleting all repeats.
770 foreach ($events as $event) {
771 $event = new calendar_event($event);
772 $event->delete(false);
773 }
774 }
775
776 return true;
777 }
778
779 /**
780 * Fetch all event properties.
781 *
782 * This function returns all of the events properties as an object and optionally
783 * can prepare an editor for the description field at the same time. This is
784 * designed to work when the properties are going to be used to set the default
785 * values of a moodle forms form.
786 *
787 * @param bool $prepareeditor If set to true a editor is prepared for use with
788 * the mforms editor element. (for description)
789 * @return \stdClass Object containing event properties
790 */
791 public function properties($prepareeditor = false) {
792 global $DB;
793
794 // First take a copy of the properties. We don't want to actually change the
795 // properties or we'd forever be converting back and forwards between an
796 // editor formatted description and not.
797 $properties = clone($this->properties);
798 // Clean the description here.
799 $properties->description = clean_text($properties->description, $properties->format);
800
801 // If set to true we need to prepare the properties for use with an editor
802 // and prepare the file area.
803 if ($prepareeditor) {
804
805 // We may or may not have a property id. If we do then we need to work
806 // out the context so we can copy the existing files to the draft area.
807 if (!empty($properties->id)) {
808
809 if ($properties->eventtype === 'site') {
810 // Site context.
08a79155 811 $this->editorcontext = $this->get_context();
e1cd93ce
MN
812 } else if ($properties->eventtype === 'user') {
813 // User context.
08a79155 814 $this->editorcontext = $this->get_context();
e1cd93ce
MN
815 } else if ($properties->eventtype === 'group' || $properties->eventtype === 'course') {
816 // First check the course is valid.
817 $course = $DB->get_record('course', array('id' => $properties->courseid));
818 if (!$course) {
819 print_error('invalidcourse');
820 }
821 // Course context.
08a79155 822 $this->editorcontext = $this->get_context();
e1cd93ce
MN
823 // We have a course and are within the course context so we had
824 // better use the courses max bytes value.
825 $this->editoroptions['maxbytes'] = $course->maxbytes;
05f184bb
AN
826 } else if ($properties->eventtype === 'category') {
827 // First check the course is valid.
442f12f8 828 \core_course_category::get($properties->categoryid, MUST_EXIST, true);
05f184bb 829 // Course context.
08a79155 830 $this->editorcontext = $this->get_context();
e1cd93ce
MN
831 } else {
832 // If we get here we have a custom event type as used by some
833 // modules. In this case the event will have been added by
834 // code and we won't need the editor.
835 $this->editoroptions['maxbytes'] = 0;
836 $this->editoroptions['maxfiles'] = 0;
837 }
838
839 if (empty($this->editorcontext) || empty($this->editorcontext->id)) {
840 $contextid = false;
841 } else {
842 // Get the context id that is what we really want.
843 $contextid = $this->editorcontext->id;
844 }
845 } else {
846
847 // If we get here then this is a new event in which case we don't need a
848 // context as there is no existing files to copy to the draft area.
849 $contextid = null;
850 }
851
852 // If the contextid === false we don't support files so no preparing
853 // a draft area.
854 if ($contextid !== false) {
855 // Just encase it has already been submitted.
856 $draftiddescription = file_get_submitted_draft_itemid('description');
857 // Prepare the draft area, this copies existing files to the draft area as well.
858 $properties->description = file_prepare_draft_area($draftiddescription, $contextid, 'calendar',
859 'event_description', $properties->id, $this->editoroptions, $properties->description);
860 } else {
861 $draftiddescription = 0;
862 }
863
864 // Structure the description field as the editor requires.
865 $properties->description = array('text' => $properties->description, 'format' => $properties->format,
866 'itemid' => $draftiddescription);
867 }
868
869 // Finally return the properties.
870 return $properties;
871 }
872
873 /**
874 * Toggles the visibility of an event
875 *
876 * @param null|bool $force If it is left null the events visibility is flipped,
877 * If it is false the event is made hidden, if it is true it
878 * is made visible.
879 * @return bool if event is successfully updated, toggle will be visible
880 */
881 public function toggle_visibility($force = null) {
882 global $DB;
883
884 // Set visible to the default if it is not already set.
885 if (empty($this->properties->visible)) {
886 $this->properties->visible = 1;
887 }
888
889 if ($force === true || ($force !== false && $this->properties->visible == 0)) {
890 // Make this event visible.
891 $this->properties->visible = 1;
892 } else {
893 // Make this event hidden.
894 $this->properties->visible = 0;
895 }
896
897 // Update the database to reflect this change.
898 $success = $DB->set_field('event', 'visible', $this->properties->visible, array('id' => $this->properties->id));
899 $calendarevent = $DB->get_record('event', array('id' => $this->properties->id), '*', MUST_EXIST);
900
901 // Prepare event data.
902 $eventargs = array(
08a79155 903 'context' => $this->get_context(),
e1cd93ce
MN
904 'objectid' => $this->properties->id,
905 'other' => array(
906 'repeatid' => empty($this->properties->repeatid) ? 0 : $this->properties->repeatid,
907 'timestart' => $this->properties->timestart,
908 'name' => $this->properties->name
909 )
910 );
911 $event = \core\event\calendar_event_updated::create($eventargs);
912 $event->add_record_snapshot('event', $calendarevent);
913 $event->trigger();
914
915 return $success;
916 }
917
918 /**
919 * Returns an event object when provided with an event id.
920 *
921 * This function makes use of MUST_EXIST, if the event id passed in is invalid
922 * it will result in an exception being thrown.
923 *
924 * @param int|object $param event object or event id
925 * @return calendar_event
926 */
927 public static function load($param) {
928 global $DB;
929 if (is_object($param)) {
930 $event = new calendar_event($param);
931 } else {
932 $event = $DB->get_record('event', array('id' => (int)$param), '*', MUST_EXIST);
933 $event = new calendar_event($event);
934 }
935 return $event;
936 }
937
938 /**
656837d6
NM
939 * Creates a new event and returns an event object.
940 *
941 * Capability checking should be performed if the user is directly creating the event
942 * and no other capability has been tested. However if the event is not being created
943 * directly by the user and another capability has been checked for them to do this then
944 * capabilites should not be checked.
945 *
946 * For example if a user is creating an event in the calendar the check should be true,
947 * but if you are creating an event in an activity when it is created then the calendar
948 * capabilites should not be checked.
e1cd93ce
MN
949 *
950 * @param \stdClass|array $properties An object containing event properties
656837d6 951 * @param bool $checkcapability If Moodle should check the user can manage the calendar events for this call or not.
e1cd93ce
MN
952 * @throws \coding_exception
953 *
954 * @return calendar_event|bool The event object or false if it failed
955 */
956 public static function create($properties, $checkcapability = true) {
957 if (is_array($properties)) {
958 $properties = (object)$properties;
959 }
960 if (!is_object($properties)) {
961 throw new \coding_exception('When creating an event properties should be either an object or an assoc array');
962 }
963 $event = new calendar_event($properties);
964 if ($event->update($properties, $checkcapability)) {
965 return $event;
966 } else {
967 return false;
968 }
969 }
970
8c84eeee
DP
971 /**
972 * Format the event name using the external API.
973 *
974 * This function should we used when text formatting is required in external functions.
975 *
976 * @return string Formatted name.
977 */
978 public function format_external_name() {
979 if ($this->editorcontext === null) {
980 // Switch on the event type to decide upon the appropriate context to use for this event.
981 $this->editorcontext = $this->get_context();
982 }
983
984 return external_format_string($this->properties->name, $this->editorcontext->id);
985 }
986
e1cd93ce
MN
987 /**
988 * Format the text using the external API.
989 *
990 * This function should we used when text formatting is required in external functions.
991 *
992 * @return array an array containing the text formatted and the text format
993 */
994 public function format_external_text() {
995
996 if ($this->editorcontext === null) {
997 // Switch on the event type to decide upon the appropriate context to use for this event.
08a79155 998 $this->editorcontext = $this->get_context();
e1cd93ce 999
05f184bb 1000 if (!calendar_is_valid_eventtype($this->properties->eventtype)) {
e1cd93ce
MN
1001 // We don't have a context here, do a normal format_text.
1002 return external_format_text($this->properties->description, $this->properties->format, $this->editorcontext->id);
1003 }
1004 }
1005
1006 // Work out the item id for the editor, if this is a repeated event then the files will be associated with the original.
1007 if (!empty($this->properties->repeatid) && $this->properties->repeatid > 0) {
1008 $itemid = $this->properties->repeatid;
1009 } else {
1010 $itemid = $this->properties->id;
1011 }
1012
1013 return external_format_text($this->properties->description, $this->properties->format, $this->editorcontext->id,
1014 'calendar', 'event_description', $itemid);
1015 }
1016}
1017
36dc3b71
SH
1018/**
1019 * Calendar information class
1020 *
1021 * This class is used simply to organise the information pertaining to a calendar
1022 * and is used primarily to make information easily available.
08b4a4e1
RW
1023 *
1024 * @package core_calendar
1025 * @category calendar
1026 * @copyright 2010 Sam Hemelryk
1027 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36dc3b71
SH
1028 */
1029class calendar_information {
08b4a4e1 1030
da304137
MN
1031 /**
1032 * @var int The timestamp
1033 *
1034 * Rather than setting the day, month and year we will set a timestamp which will be able
1035 * to be used by multiple calendars.
1036 */
1037 public $time;
36dc3b71 1038
08b4a4e1 1039 /** @var int A course id */
36dc3b71 1040 public $courseid = null;
08b4a4e1 1041
7d0a866c
AN
1042 /** @var array An array of categories */
1043 public $categories = array();
1044
1045 /** @var int The current category */
1046 public $categoryid = null;
1047
08b4a4e1 1048 /** @var array An array of courses */
36dc3b71 1049 public $courses = array();
08b4a4e1
RW
1050
1051 /** @var array An array of groups */
36dc3b71 1052 public $groups = array();
08b4a4e1
RW
1053
1054 /** @var array An array of users */
36dc3b71
SH
1055 public $users = array();
1056
7b7bf31d
AN
1057 /** @var context The anticipated context that the calendar is viewed in */
1058 public $context = null;
1059
36dc3b71
SH
1060 /**
1061 * Creates a new instance
1062 *
08b4a4e1
RW
1063 * @param int $day the number of the day
1064 * @param int $month the number of the month
1065 * @param int $year the number of the year
da304137
MN
1066 * @param int $time the unixtimestamp representing the date we want to view, this is used instead of $calmonth
1067 * and $calyear to support multiple calendars
36dc3b71 1068 */
da304137
MN
1069 public function __construct($day = 0, $month = 0, $year = 0, $time = 0) {
1070 // If a day, month and year were passed then convert it to a timestamp. If these were passed
1071 // then we can assume the day, month and year are passed as Gregorian, as no where in core
1072 // should we be passing these values rather than the time. This is done for BC.
1073 if (!empty($day) || !empty($month) || !empty($year)) {
1074 $date = usergetdate(time());
1075 if (empty($day)) {
1076 $day = $date['mday'];
1077 }
1078 if (empty($month)) {
1079 $month = $date['mon'];
1080 }
1081 if (empty($year)) {
1082 $year = $date['year'];
1083 }
1084 if (checkdate($month, $day, $year)) {
6038d626 1085 $time = make_timestamp($year, $month, $day);
da304137 1086 } else {
6038d626 1087 $time = time();
da304137 1088 }
6038d626
AN
1089 }
1090
1091 $this->set_time($time);
1092 }
1093
7b7bf31d
AN
1094 /**
1095 * Creates and set up a instance.
1096 *
1097 * @param int $time the unixtimestamp representing the date we want to view.
1098 * @param int $courseid The ID of the course the user wishes to view.
1099 * @param int $categoryid The ID of the category the user wishes to view
1100 * If a courseid is specified, this value is ignored.
1101 * @return calendar_information
1102 */
1103 public static function create($time, int $courseid, int $categoryid = null) : calendar_information {
1104 $calendar = new static(0, 0, 0, $time);
1105 if ($courseid != SITEID && !empty($courseid)) {
1106 // Course ID must be valid and existing.
1107 $course = get_course($courseid);
1108 $calendar->context = context_course::instance($course->id);
1109
0188d5b5 1110 if (!$course->visible && !is_role_switched($course->id)) {
7b7bf31d
AN
1111 require_capability('moodle/course:viewhiddencourses', $calendar->context);
1112 }
1113
1114 $courses = [$course->id => $course];
442f12f8 1115 $category = (\core_course_category::get($course->category, MUST_EXIST, true))->get_db_record();
7b7bf31d
AN
1116 } else if (!empty($categoryid)) {
1117 $course = get_site();
0f1e7ec9 1118 $courses = calendar_get_default_courses(null, 'id, category, groupmode, groupmodeforce');
7b7bf31d
AN
1119
1120 // Filter available courses to those within this category or it's children.
1121 $ids = [$categoryid];
442f12f8 1122 $category = \core_course_category::get($categoryid);
7b7bf31d
AN
1123 $ids = array_merge($ids, array_keys($category->get_children()));
1124 $courses = array_filter($courses, function($course) use ($ids) {
1125 return array_search($course->category, $ids) !== false;
1126 });
1127 $category = $category->get_db_record();
1128
1129 $calendar->context = context_coursecat::instance($categoryid);
1130 } else {
1131 $course = get_site();
0f1e7ec9 1132 $courses = calendar_get_default_courses(null, 'id, category, groupmode, groupmodeforce');
7b7bf31d
AN
1133 $category = null;
1134
1135 $calendar->context = context_system::instance();
1136 }
1137
1138 $calendar->set_sources($course, $courses, $category);
1139
1140 return $calendar;
1141 }
1142
6038d626
AN
1143 /**
1144 * Set the time period of this instance.
1145 *
1146 * @param int $time the unixtimestamp representing the date we want to view.
1147 * @return $this
1148 */
1149 public function set_time($time = null) {
02d0c435 1150 if (empty($time)) {
da304137 1151 $this->time = time();
6038d626
AN
1152 } else {
1153 $this->time = $time;
d8d8bdd9 1154 }
6038d626
AN
1155
1156 return $this;
36dc3b71
SH
1157 }
1158
797cedc7 1159 /**
08b4a4e1 1160 * Initialize calendar information
797cedc7 1161 *
7d0a866c 1162 * @deprecated 3.4
08b4a4e1 1163 * @param stdClass $course object
797cedc7 1164 * @param array $coursestoload An array of courses [$course->id => $course]
08b4a4e1 1165 * @param bool $ignorefilters options to use filter
797cedc7
SH
1166 */
1167 public function prepare_for_view(stdClass $course, array $coursestoload, $ignorefilters = false) {
7d0a866c
AN
1168 debugging('The prepare_for_view() function has been deprecated. Please update your code to use set_sources()',
1169 DEBUG_DEVELOPER);
1170 $this->set_sources($course, $coursestoload);
1171 }
1172
1173 /**
1174 * Set the sources for events within the calendar.
1175 *
1176 * If no category is provided, then the category path for the current
1177 * course will be used.
1178 *
1179 * @param stdClass $course The current course being viewed.
c4172077 1180 * @param stdClass[] $courses The list of all courses currently accessible.
7d0a866c
AN
1181 * @param stdClass $category The current category to show.
1182 */
1183 public function set_sources(stdClass $course, array $courses, stdClass $category = null) {
57e8c9f7
AN
1184 global $USER;
1185
7d0a866c 1186 // A cousre must always be specified.
797cedc7 1187 $this->course = $course;
7d0a866c
AN
1188 $this->courseid = $course->id;
1189
1190 list($courseids, $group, $user) = calendar_set_filters($courses);
1191 $this->courses = $courseids;
797cedc7
SH
1192 $this->groups = $group;
1193 $this->users = $user;
7d0a866c
AN
1194
1195 // Do not show category events by default.
1196 $this->categoryid = null;
1197 $this->categories = null;
1198
57e8c9f7
AN
1199 // Determine the correct category information to show.
1200 // When called with a course, the category of that course is usually included too.
1201 // When a category was specifically requested, it should be requested with the site id.
1202 if (SITEID !== $this->courseid) {
1203 // A specific course was requested.
1204 // Fetch the category that this course is in, along with all parents.
1205 // Do not include child categories of this category, as the user many not have enrolments in those siblings or children.
442f12f8 1206 $category = \core_course_category::get($course->category, MUST_EXIST, true);
7d0a866c
AN
1207 $this->categoryid = $category->id;
1208
1209 $this->categories = $category->get_parents();
1210 $this->categories[] = $category->id;
57e8c9f7
AN
1211 } else if (null !== $category && $category->id > 0) {
1212 // A specific category was requested.
1213 // Fetch all parents of this category, along with all children too.
442f12f8 1214 $category = \core_course_category::get($category->id);
57e8c9f7
AN
1215 $this->categoryid = $category->id;
1216
1217 // Build the category list.
1218 // This includes the current category.
c4172077
MG
1219 $this->categories = $category->get_parents();
1220 $this->categories[] = $category->id;
1221 $this->categories = array_merge($this->categories, $category->get_all_children_ids());
57e8c9f7
AN
1222 } else if (SITEID === $this->courseid) {
1223 // The site was requested.
1224 // Fetch all categories where this user has any enrolment, and all categories that this user can manage.
1225
1226 // Grab the list of categories that this user has courses in.
1227 $coursecategories = array_flip(array_map(function($course) {
1228 return $course->category;
1229 }, $courses));
1230
c4172077
MG
1231 $calcatcache = cache::make('core', 'calendar_categories');
1232 $this->categories = $calcatcache->get('site');
1233 if ($this->categories === false) {
1234 // Use the category id as the key in the following array. That way we do not have to remove duplicates.
1235 $categories = [];
442f12f8 1236 foreach (\core_course_category::get_all() as $category) {
c4172077
MG
1237 if (isset($coursecategories[$category->id]) ||
1238 has_capability('moodle/category:manage', $category->get_context(), $USER, false)) {
1239 // If the user has access to a course in this category or can manage the category,
1240 // then they can see all parent categories too.
1241 $categories[$category->id] = true;
1242 foreach ($category->get_parents() as $catid) {
1243 $categories[$catid] = true;
57e8c9f7
AN
1244 }
1245 }
7d0a866c 1246 }
c4172077
MG
1247 $this->categories = array_keys($categories);
1248 $calcatcache->set('site', $this->categories);
7d0a866c 1249 }
7d0a866c 1250 }
797cedc7
SH
1251 }
1252
36dc3b71
SH
1253 /**
1254 * Ensures the date for the calendar is correct and either sets it to now
1255 * or throws a moodle_exception if not
1256 *
08b4a4e1
RW
1257 * @param bool $defaultonow use current time
1258 * @throws moodle_exception
1259 * @return bool validation of checkdate
36dc3b71
SH
1260 */
1261 public function checkdate($defaultonow = true) {
1262 if (!checkdate($this->month, $this->day, $this->year)) {
1263 if ($defaultonow) {
1264 $now = usergetdate(time());
1265 $this->day = intval($now['mday']);
1266 $this->month = intval($now['mon']);
1267 $this->year = intval($now['year']);
1268 return true;
1269 } else {
1270 throw new moodle_exception('invaliddate');
1271 }
1272 }
1273 return true;
1274 }
da304137 1275
36dc3b71
SH
1276 /**
1277 * Gets todays timestamp for the calendar
08b4a4e1
RW
1278 *
1279 * @return int today timestamp
36dc3b71
SH
1280 */
1281 public function timestamp_today() {
da304137 1282 return $this->time;
36dc3b71
SH
1283 }
1284 /**
1285 * Gets tomorrows timestamp for the calendar
08b4a4e1
RW
1286 *
1287 * @return int tomorrow timestamp
36dc3b71
SH
1288 */
1289 public function timestamp_tomorrow() {
a0ef87de 1290 return strtotime('+1 day', $this->time);
36dc3b71
SH
1291 }
1292 /**
e30390a0 1293 * Adds the pretend blocks for the calendar
36dc3b71
SH
1294 *
1295 * @param core_calendar_renderer $renderer
08b4a4e1
RW
1296 * @param bool $showfilters display filters, false is set as default
1297 * @param string|null $view preference view options (eg: day, month, upcoming)
36dc3b71
SH
1298 */
1299 public function add_sidecalendar_blocks(core_calendar_renderer $renderer, $showfilters=false, $view=null) {
a35b0464
AN
1300 global $PAGE;
1301
1302 if (!has_capability('moodle/block:view', $PAGE->context) ) {
5c91f31d
AN
1303 return;
1304 }
a35b0464 1305
36dc3b71
SH
1306 if ($showfilters) {
1307 $filters = new block_contents();
fc60d319 1308 $filters->content = $renderer->event_filter();
36dc3b71
SH
1309 $filters->footer = '';
1310 $filters->title = get_string('eventskey', 'calendar');
1311 $renderer->add_pretend_calendar_block($filters, BLOCK_POS_RIGHT);
1312 }
1313 $block = new block_contents;
1314 $block->content = $renderer->fake_block_threemonths($this);
1315 $block->footer = '';
1316 $block->title = get_string('monthlyview', 'calendar');
1317 $renderer->add_pretend_calendar_block($block, BLOCK_POS_RIGHT);
1318 }
1d5bd3d2 1319}
b5a52acd 1320
10515e15
MN
1321/**
1322 * Get calendar events.
1323 *
1324 * @param int $tstart Start time of time range for events
1325 * @param int $tend End time of time range for events
1326 * @param array|int|boolean $users array of users, user id or boolean for all/no user events
1327 * @param array|int|boolean $groups array of groups, group id or boolean for all/no group events
1328 * @param array|int|boolean $courses array of courses, course id or boolean for all/no course events
1329 * @param boolean $withduration whether only events starting within time range selected
1330 * or events in progress/already started selected as well
1331 * @param boolean $ignorehidden whether to select only visible events or all events
93623513 1332 * @param array|int|boolean $categories array of categories, category id or boolean for all/no course events
10515e15
MN
1333 * @return array $events of selected events or an empty array if there aren't any (or there was an error)
1334 */
93623513
AN
1335function calendar_get_events($tstart, $tend, $users, $groups, $courses,
1336 $withduration = true, $ignorehidden = true, $categories = []) {
10515e15 1337 global $DB;
10515e15 1338
eeb27f03
CB
1339 $whereclause = '';
1340 $params = array();
10515e15 1341 // Quick test.
93623513 1342 if (empty($users) && empty($groups) && empty($courses) && empty($categories)) {
10515e15
MN
1343 return array();
1344 }
1345
10515e15 1346 if ((is_array($users) && !empty($users)) or is_numeric($users)) {
eeb27f03
CB
1347 // Events from a number of users
1348 if(!empty($whereclause)) $whereclause .= ' OR';
10515e15 1349 list($insqlusers, $inparamsusers) = $DB->get_in_or_equal($users, SQL_PARAMS_NAMED);
93623513 1350 $whereclause .= " (e.userid $insqlusers AND e.courseid = 0 AND e.groupid = 0 AND e.categoryid = 0)";
10515e15 1351 $params = array_merge($params, $inparamsusers);
eeb27f03
CB
1352 } else if($users === true) {
1353 // Events from ALL users
1354 if(!empty($whereclause)) $whereclause .= ' OR';
93623513 1355 $whereclause .= ' (e.userid != 0 AND e.courseid = 0 AND e.groupid = 0 AND e.categoryid = 0)';
eeb27f03
CB
1356 } else if($users === false) {
1357 // No user at all, do nothing
10515e15
MN
1358 }
1359
10515e15 1360 if ((is_array($groups) && !empty($groups)) or is_numeric($groups)) {
eeb27f03
CB
1361 // Events from a number of groups
1362 if(!empty($whereclause)) $whereclause .= ' OR';
10515e15 1363 list($insqlgroups, $inparamsgroups) = $DB->get_in_or_equal($groups, SQL_PARAMS_NAMED);
eeb27f03 1364 $whereclause .= " e.groupid $insqlgroups ";
10515e15 1365 $params = array_merge($params, $inparamsgroups);
eeb27f03
CB
1366 } else if($groups === true) {
1367 // Events from ALL groups
1368 if(!empty($whereclause)) $whereclause .= ' OR ';
1369 $whereclause .= ' e.groupid != 0';
10515e15 1370 }
eeb27f03 1371 // boolean false (no groups at all): we don't need to do anything
10515e15 1372
10515e15 1373 if ((is_array($courses) && !empty($courses)) or is_numeric($courses)) {
eeb27f03 1374 if(!empty($whereclause)) $whereclause .= ' OR';
10515e15 1375 list($insqlcourses, $inparamscourses) = $DB->get_in_or_equal($courses, SQL_PARAMS_NAMED);
eeb27f03 1376 $whereclause .= " (e.groupid = 0 AND e.courseid $insqlcourses)";
10515e15
MN
1377 $params = array_merge($params, $inparamscourses);
1378 } else if ($courses === true) {
eeb27f03
CB
1379 // Events from ALL courses
1380 if(!empty($whereclause)) $whereclause .= ' OR';
1381 $whereclause .= ' (e.groupid = 0 AND e.courseid != 0)';
10515e15
MN
1382 }
1383
93623513 1384 if ((is_array($categories) && !empty($categories)) || is_numeric($categories)) {
d097bfdd
AN
1385 if (!empty($whereclause)) {
1386 $whereclause .= ' OR';
1387 }
93623513
AN
1388 list($insqlcategories, $inparamscategories) = $DB->get_in_or_equal($categories, SQL_PARAMS_NAMED);
1389 $whereclause .= " (e.groupid = 0 AND e.courseid = 0 AND e.categoryid $insqlcategories)";
1390 $params = array_merge($params, $inparamscategories);
1391 } else if ($categories === true) {
1392 // Events from ALL categories.
d097bfdd
AN
1393 if (!empty($whereclause)) {
1394 $whereclause .= ' OR';
1395 }
93623513
AN
1396 $whereclause .= ' (e.groupid = 0 AND e.courseid = 0 AND e.categoryid != 0)';
1397 }
1398
10515e15
MN
1399 // Security check: if, by now, we have NOTHING in $whereclause, then it means
1400 // that NO event-selecting clauses were defined. Thus, we won't be returning ANY
1401 // events no matter what. Allowing the code to proceed might return a completely
1402 // valid query with only time constraints, thus selecting ALL events in that time frame!
eeb27f03 1403 if(empty($whereclause)) {
10515e15
MN
1404 return array();
1405 }
1406
eeb27f03
CB
1407 if($withduration) {
1408 $timeclause = '(e.timestart >= '.$tstart.' OR e.timestart + e.timeduration > '.$tstart.') AND e.timestart <= '.$tend;
10515e15 1409 }
eeb27f03
CB
1410 else {
1411 $timeclause = 'e.timestart >= '.$tstart.' AND e.timestart <= '.$tend;
10515e15 1412 }
eeb27f03
CB
1413 if(!empty($whereclause)) {
1414 // We have additional constraints
1415 $whereclause = $timeclause.' AND ('.$whereclause.')';
10515e15 1416 }
eeb27f03
CB
1417 else {
1418 // Just basic time filtering
1419 $whereclause = $timeclause;
10515e15
MN
1420 }
1421
eeb27f03
CB
1422 if ($ignorehidden) {
1423 $whereclause .= ' AND e.visible = 1';
10515e15
MN
1424 }
1425
10515e15 1426 $sql = "SELECT e.*
eeb27f03
CB
1427 FROM {event} e
1428 LEFT JOIN {modules} m ON e.modulename = m.name
1429 -- Non visible modules will have a value of 0.
1430 WHERE (m.visible = 1 OR m.visible IS NULL) AND $whereclause
1431 ORDER BY e.timestart";
10515e15
MN
1432 $events = $DB->get_records_sql($sql, $params);
1433
1434 if ($events === false) {
1435 $events = array();
1436 }
10515e15
MN
1437 return $events;
1438}
1439
1440/**
1441 * Return the days of the week.
1442 *
1443 * @return array array of days
1444 */
1445function calendar_get_days() {
23a29de7
MN
1446 $calendartype = \core_calendar\type_factory::get_calendar_instance();
1447 return $calendartype->get_weekdays();
10515e15
MN
1448}
1449
1450/**
1451 * Get the subscription from a given id.
1452 *
1453 * @since Moodle 2.5
1454 * @param int $id id of the subscription
1455 * @return stdClass Subscription record from DB
1456 * @throws moodle_exception for an invalid id
1457 */
1458function calendar_get_subscription($id) {
23a29de7
MN
1459 global $DB;
1460
1461 $cache = \cache::make('core', 'calendar_subscriptions');
1462 $subscription = $cache->get($id);
1463 if (empty($subscription)) {
1464 $subscription = $DB->get_record('event_subscriptions', array('id' => $id), '*', MUST_EXIST);
1465 $cache->set($id, $subscription);
1466 }
1467
1468 return $subscription;
10515e15
MN
1469}
1470
1471/**
1472 * Gets the first day of the week.
1473 *
1474 * Used to be define('CALENDAR_STARTING_WEEKDAY', blah);
1475 *
1476 * @return int
1477 */
1478function calendar_get_starting_weekday() {
23a29de7
MN
1479 $calendartype = \core_calendar\type_factory::get_calendar_instance();
1480 return $calendartype->get_starting_weekday();
10515e15
MN
1481}
1482
10515e15
MN
1483/**
1484 * Get a HTML link to a course.
1485 *
5900513f 1486 * @param int|stdClass $course the course id or course object
10515e15
MN
1487 * @return string a link to the course (as HTML); empty if the course id is invalid
1488 */
5900513f
MG
1489function calendar_get_courselink($course) {
1490 if (!$course) {
23a29de7
MN
1491 return '';
1492 }
1493
5900513f
MG
1494 if (!is_object($course)) {
1495 $course = calendar_get_course_cached($coursecache, $course);
1496 }
1497 $context = \context_course::instance($course->id);
1498 $fullname = format_string($course->fullname, true, array('context' => $context));
1499 $url = new \moodle_url('/course/view.php', array('id' => $course->id));
23a29de7
MN
1500 $link = \html_writer::link($url, $fullname);
1501
1502 return $link;
10515e15
MN
1503}
1504
1505/**
1506 * Get current module cache.
1507 *
47a71017 1508 * Only use this method if you do not know courseid. Otherwise use:
5900513f
MG
1509 * get_fast_modinfo($courseid)->instances[$modulename][$instance]
1510 *
23a29de7 1511 * @param array $modulecache in memory module cache
10515e15
MN
1512 * @param string $modulename name of the module
1513 * @param int $instance module instance number
1514 * @return stdClass|bool $module information
1515 */
23a29de7
MN
1516function calendar_get_module_cached(&$modulecache, $modulename, $instance) {
1517 if (!isset($modulecache[$modulename . '_' . $instance])) {
1518 $modulecache[$modulename . '_' . $instance] = get_coursemodule_from_instance($modulename, $instance);
10515e15 1519 }
23a29de7
MN
1520
1521 return $modulecache[$modulename . '_' . $instance];
10515e15
MN
1522}
1523
1524/**
1525 * Get current course cache.
1526 *
1527 * @param array $coursecache list of course cache
1528 * @param int $courseid id of the course
1529 * @return stdClass $coursecache[$courseid] return the specific course cache
1530 */
1531function calendar_get_course_cached(&$coursecache, $courseid) {
23a29de7
MN
1532 if (!isset($coursecache[$courseid])) {
1533 $coursecache[$courseid] = get_course($courseid);
1534 }
1535 return $coursecache[$courseid];
10515e15
MN
1536}
1537
1538/**
1539 * Get group from groupid for calendar display
1540 *
1541 * @param int $groupid
1542 * @return stdClass group object with fields 'id', 'name' and 'courseid'
1543 */
1544function calendar_get_group_cached($groupid) {
23a29de7
MN
1545 static $groupscache = array();
1546 if (!isset($groupscache[$groupid])) {
1547 $groupscache[$groupid] = groups_get_group($groupid, 'id,name,courseid');
1548 }
1549 return $groupscache[$groupid];
10515e15
MN
1550}
1551
1552/**
1553 * Add calendar event metadata
1554 *
1a972b06
MG
1555 * @deprecated since 3.9
1556 *
10515e15
MN
1557 * @param stdClass $event event info
1558 * @return stdClass $event metadata
1559 */
1560function calendar_add_event_metadata($event) {
1a972b06 1561 debugging('This function is no longer used', DEBUG_DEVELOPER);
23a29de7
MN
1562 global $CFG, $OUTPUT;
1563
1564 // Support multilang in event->name.
1565 $event->name = format_string($event->name, true);
1566
1567 if (!empty($event->modulename)) { // Activity event.
1568 // The module name is set. I will assume that it has to be displayed, and
1569 // also that it is an automatically-generated event. And of course that the
5900513f
MG
1570 // instace id and modulename are set correctly.
1571 $instances = get_fast_modinfo($event->courseid)->get_instances_of($event->modulename);
1572 if (!array_key_exists($event->instance, $instances)) {
23a29de7
MN
1573 return;
1574 }
5900513f 1575 $module = $instances[$event->instance];
23a29de7 1576
5900513f 1577 $modulename = $module->get_module_type_name(false);
23a29de7
MN
1578 if (get_string_manager()->string_exists($event->eventtype, $event->modulename)) {
1579 // Will be used as alt text if the event icon.
1580 $eventtype = get_string($event->eventtype, $event->modulename);
1581 } else {
1582 $eventtype = '';
1583 }
23a29de7 1584
5900513f
MG
1585 $event->icon = '<img src="' . s($module->get_icon_url()) . '" alt="' . s($eventtype) .
1586 '" title="' . s($modulename) . '" class="icon" />';
1587 $event->referer = html_writer::link($module->url, $event->name);
1588 $event->courselink = calendar_get_courselink($module->get_course());
23a29de7
MN
1589 $event->cmid = $module->id;
1590 } else if ($event->courseid == SITEID) { // Site event.
1591 $event->icon = '<img src="' . $OUTPUT->image_url('i/siteevent') . '" alt="' .
375d82ca
PFO
1592 get_string('siteevent', 'calendar') . '" class="icon" />';
1593 $event->cssclass = 'calendar_event_site';
23a29de7
MN
1594 } else if ($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) { // Course event.
1595 $event->icon = '<img src="' . $OUTPUT->image_url('i/courseevent') . '" alt="' .
1596 get_string('courseevent', 'calendar') . '" class="icon" />';
1597 $event->courselink = calendar_get_courselink($event->courseid);
1598 $event->cssclass = 'calendar_event_course';
1599 } else if ($event->groupid) { // Group event.
1600 if ($group = calendar_get_group_cached($event->groupid)) {
1601 $groupname = format_string($group->name, true, \context_course::instance($group->courseid));
1602 } else {
1603 $groupname = '';
1604 }
1605 $event->icon = \html_writer::empty_tag('image', array('src' => $OUTPUT->image_url('i/groupevent'),
1606 'alt' => get_string('groupevent', 'calendar'), 'title' => $groupname, 'class' => 'icon'));
1607 $event->courselink = calendar_get_courselink($event->courseid) . ', ' . $groupname;
1608 $event->cssclass = 'calendar_event_group';
1609 } else if ($event->userid) { // User event.
1610 $event->icon = '<img src="' . $OUTPUT->image_url('i/userevent') . '" alt="' .
1611 get_string('userevent', 'calendar') . '" class="icon" />';
1612 $event->cssclass = 'calendar_event_user';
1613 }
1614
1615 return $event;
10515e15
MN
1616}
1617
1618/**
1619 * Get calendar events by id.
1620 *
1621 * @since Moodle 2.5
1622 * @param array $eventids list of event ids
1623 * @return array Array of event entries, empty array if nothing found
1624 */
1625function calendar_get_events_by_id($eventids) {
23a29de7
MN
1626 global $DB;
1627
1628 if (!is_array($eventids) || empty($eventids)) {
1629 return array();
1630 }
1631
1632 list($wheresql, $params) = $DB->get_in_or_equal($eventids);
1633 $wheresql = "id $wheresql";
1634
1635 return $DB->get_records_select('event', $wheresql, $params);
10515e15
MN
1636}
1637
1638/**
1639 * Get control options for calendar.
1640 *
1641 * @param string $type of calendar
1642 * @param array $data calendar information
1643 * @return string $content return available control for the calender in html
1644 */
1645function calendar_top_controls($type, $data) {
23a29de7
MN
1646 global $PAGE, $OUTPUT;
1647
1648 // Get the calendar type we are using.
1649 $calendartype = \core_calendar\type_factory::get_calendar_instance();
1650
1651 $content = '';
1652
1653 // Ensure course id passed if relevant.
1654 $courseid = '';
1655 if (!empty($data['id'])) {
1656 $courseid = '&amp;course=' . $data['id'];
1657 }
1658
1659 // If we are passing a month and year then we need to convert this to a timestamp to
1660 // support multiple calendars. No where in core should these be passed, this logic
1661 // here is for third party plugins that may use this function.
1662 if (!empty($data['m']) && !empty($date['y'])) {
1663 if (!isset($data['d'])) {
1664 $data['d'] = 1;
1665 }
1666 if (!checkdate($data['m'], $data['d'], $data['y'])) {
1667 $time = time();
1668 } else {
1669 $time = make_timestamp($data['y'], $data['m'], $data['d']);
1670 }
1671 } else if (!empty($data['time'])) {
1672 $time = $data['time'];
1673 } else {
1674 $time = time();
1675 }
1676
1677 // Get the date for the calendar type.
1678 $date = $calendartype->timestamp_to_date_array($time);
1679
1680 $urlbase = $PAGE->url;
1681
1682 // We need to get the previous and next months in certain cases.
1683 if ($type == 'frontpage' || $type == 'course' || $type == 'month') {
1684 $prevmonth = calendar_sub_month($date['mon'], $date['year']);
1685 $prevmonthtime = $calendartype->convert_to_gregorian($prevmonth[1], $prevmonth[0], 1);
1686 $prevmonthtime = make_timestamp($prevmonthtime['year'], $prevmonthtime['month'], $prevmonthtime['day'],
1687 $prevmonthtime['hour'], $prevmonthtime['minute']);
1688
1689 $nextmonth = calendar_add_month($date['mon'], $date['year']);
1690 $nextmonthtime = $calendartype->convert_to_gregorian($nextmonth[1], $nextmonth[0], 1);
1691 $nextmonthtime = make_timestamp($nextmonthtime['year'], $nextmonthtime['month'], $nextmonthtime['day'],
1692 $nextmonthtime['hour'], $nextmonthtime['minute']);
1693 }
1694
1695 switch ($type) {
1696 case 'frontpage':
0504254f 1697 $prevlink = calendar_get_link_previous(get_string('monthprev', 'calendar'), $urlbase, false, false, false,
23a29de7 1698 true, $prevmonthtime);
0504254f 1699 $nextlink = calendar_get_link_next(get_string('monthnext', 'calendar'), $urlbase, false, false, false, true,
23a29de7
MN
1700 $nextmonthtime);
1701 $calendarlink = calendar_get_link_href(new \moodle_url(CALENDAR_URL . 'view.php', array('view' => 'month')),
1702 false, false, false, $time);
1703
1704 if (!empty($data['id'])) {
1705 $calendarlink->param('course', $data['id']);
1706 }
1707
1708 $right = $nextlink;
1709
1710 $content .= \html_writer::start_tag('div', array('class' => 'calendar-controls'));
1711 $content .= $prevlink . '<span class="hide"> | </span>';
1712 $content .= \html_writer::tag('span', \html_writer::link($calendarlink,
1713 userdate($time, get_string('strftimemonthyear')), array('title' => get_string('monththis', 'calendar'))
1714 ), array('class' => 'current'));
1715 $content .= '<span class="hide"> | </span>' . $right;
1716 $content .= "<span class=\"clearer\"><!-- --></span>\n";
1717 $content .= \html_writer::end_tag('div');
1718
1719 break;
1720 case 'course':
0504254f 1721 $prevlink = calendar_get_link_previous(get_string('monthprev', 'calendar'), $urlbase, false, false, false,
23a29de7 1722 true, $prevmonthtime);
0504254f 1723 $nextlink = calendar_get_link_next(get_string('monthnext', 'calendar'), $urlbase, false, false, false,
23a29de7
MN
1724 true, $nextmonthtime);
1725 $calendarlink = calendar_get_link_href(new \moodle_url(CALENDAR_URL . 'view.php', array('view' => 'month')),
1726 false, false, false, $time);
1727
1728 if (!empty($data['id'])) {
1729 $calendarlink->param('course', $data['id']);
1730 }
1731
1732 $content .= \html_writer::start_tag('div', array('class' => 'calendar-controls'));
1733 $content .= $prevlink . '<span class="hide"> | </span>';
1734 $content .= \html_writer::tag('span', \html_writer::link($calendarlink,
1735 userdate($time, get_string('strftimemonthyear')), array('title' => get_string('monththis', 'calendar'))
1736 ), array('class' => 'current'));
1737 $content .= '<span class="hide"> | </span>' . $nextlink;
1738 $content .= "<span class=\"clearer\"><!-- --></span>";
1739 $content .= \html_writer::end_tag('div');
1740 break;
1741 case 'upcoming':
1742 $calendarlink = calendar_get_link_href(new \moodle_url(CALENDAR_URL . 'view.php', array('view' => 'upcoming')),
1743 false, false, false, $time);
1744 if (!empty($data['id'])) {
1745 $calendarlink->param('course', $data['id']);
1746 }
1747 $calendarlink = \html_writer::link($calendarlink, userdate($time, get_string('strftimemonthyear')));
1748 $content .= \html_writer::tag('div', $calendarlink, array('class' => 'centered'));
1749 break;
1750 case 'display':
1751 $calendarlink = calendar_get_link_href(new \moodle_url(CALENDAR_URL . 'view.php', array('view' => 'month')),
1752 false, false, false, $time);
1753 if (!empty($data['id'])) {
1754 $calendarlink->param('course', $data['id']);
1755 }
1756 $calendarlink = \html_writer::link($calendarlink, userdate($time, get_string('strftimemonthyear')));
1757 $content .= \html_writer::tag('h3', $calendarlink);
1758 break;
1759 case 'month':
1760 $prevlink = calendar_get_link_previous(userdate($prevmonthtime, get_string('strftimemonthyear')),
1761 'view.php?view=month' . $courseid . '&amp;', false, false, false, false, $prevmonthtime);
1762 $nextlink = calendar_get_link_next(userdate($nextmonthtime, get_string('strftimemonthyear')),
1763 'view.php?view=month' . $courseid . '&amp;', false, false, false, false, $nextmonthtime);
1764
1765 $content .= \html_writer::start_tag('div', array('class' => 'calendar-controls'));
1766 $content .= $prevlink . '<span class="hide"> | </span>';
1767 $content .= $OUTPUT->heading(userdate($time, get_string('strftimemonthyear')), 2, 'current');
1768 $content .= '<span class="hide"> | </span>' . $nextlink;
1769 $content .= '<span class="clearer"><!-- --></span>';
1770 $content .= \html_writer::end_tag('div')."\n";
1771 break;
1772 case 'day':
1773 $days = calendar_get_days();
1774
1775 $prevtimestamp = strtotime('-1 day', $time);
1776 $nexttimestamp = strtotime('+1 day', $time);
1777
1778 $prevdate = $calendartype->timestamp_to_date_array($prevtimestamp);
1779 $nextdate = $calendartype->timestamp_to_date_array($nexttimestamp);
1780
1781 $prevname = $days[$prevdate['wday']]['fullname'];
1782 $nextname = $days[$nextdate['wday']]['fullname'];
1783 $prevlink = calendar_get_link_previous($prevname, 'view.php?view=day' . $courseid . '&amp;', false, false,
1784 false, false, $prevtimestamp);
1785 $nextlink = calendar_get_link_next($nextname, 'view.php?view=day' . $courseid . '&amp;', false, false, false,
1786 false, $nexttimestamp);
1787
1788 $content .= \html_writer::start_tag('div', array('class' => 'calendar-controls'));
1789 $content .= $prevlink;
1790 $content .= '<span class="hide"> | </span><span class="current">' .userdate($time,
1791 get_string('strftimedaydate')) . '</span>';
1792 $content .= '<span class="hide"> | </span>' . $nextlink;
1793 $content .= "<span class=\"clearer\"><!-- --></span>";
1794 $content .= \html_writer::end_tag('div') . "\n";
1795
1796 break;
1797 }
1798
1799 return $content;
10515e15
MN
1800}
1801
10515e15
MN
1802/**
1803 * Return the representation day.
1804 *
1805 * @param int $tstamp Timestamp in GMT
1806 * @param int|bool $now current Unix timestamp
1807 * @param bool $usecommonwords
1808 * @return string the formatted date/time
1809 */
1810function calendar_day_representation($tstamp, $now = false, $usecommonwords = true) {
23a29de7
MN
1811 static $shortformat;
1812
1813 if (empty($shortformat)) {
1814 $shortformat = get_string('strftimedayshort');
1815 }
1816
1817 if ($now === false) {
1818 $now = time();
1819 }
1820
1821 // To have it in one place, if a change is needed.
1822 $formal = userdate($tstamp, $shortformat);
1823
1824 $datestamp = usergetdate($tstamp);
1825 $datenow = usergetdate($now);
1826
1827 if ($usecommonwords == false) {
1828 // We don't want words, just a date.
1829 return $formal;
1830 } else if ($datestamp['year'] == $datenow['year'] && $datestamp['yday'] == $datenow['yday']) {
1831 return get_string('today', 'calendar');
1832 } else if (($datestamp['year'] == $datenow['year'] && $datestamp['yday'] == $datenow['yday'] - 1 ) ||
1833 ($datestamp['year'] == $datenow['year'] - 1 && $datestamp['mday'] == 31 && $datestamp['mon'] == 12
1834 && $datenow['yday'] == 1)) {
1835 return get_string('yesterday', 'calendar');
1836 } else if (($datestamp['year'] == $datenow['year'] && $datestamp['yday'] == $datenow['yday'] + 1 ) ||
1837 ($datestamp['year'] == $datenow['year'] + 1 && $datenow['mday'] == 31 && $datenow['mon'] == 12
1838 && $datestamp['yday'] == 1)) {
1839 return get_string('tomorrow', 'calendar');
1840 } else {
1841 return $formal;
1842 }
10515e15
MN
1843}
1844
1845/**
1846 * return the formatted representation time.
1847 *
1848
1849 * @param int $time the timestamp in UTC, as obtained from the database
1850 * @return string the formatted date/time
1851 */
1852function calendar_time_representation($time) {
23a29de7
MN
1853 static $langtimeformat = null;
1854
1855 if ($langtimeformat === null) {
1856 $langtimeformat = get_string('strftimetime');
1857 }
1858
1859 $timeformat = get_user_preferences('calendar_timeformat');
1860 if (empty($timeformat)) {
1861 $timeformat = get_config(null, 'calendar_site_timeformat');
1862 }
1863
099bca6d
MG
1864 // Allow language customization of selected time format.
1865 if ($timeformat === CALENDAR_TF_12) {
1866 $timeformat = get_string('strftimetime12', 'langconfig');
1867 } else if ($timeformat === CALENDAR_TF_24) {
1868 $timeformat = get_string('strftimetime24', 'langconfig');
1869 }
1870
23a29de7 1871 return userdate($time, empty($timeformat) ? $langtimeformat : $timeformat);
10515e15
MN
1872}
1873
1874/**
1875 * Adds day, month, year arguments to a URL and returns a moodle_url object.
1876 *
1877 * @param string|moodle_url $linkbase
1878 * @param int $d The number of the day.
1879 * @param int $m The number of the month.
1880 * @param int $y The number of the year.
1881 * @param int $time the unixtime, used for multiple calendar support. The values $d,
1882 * $m and $y are kept for backwards compatibility.
1883 * @return moodle_url|null $linkbase
1884 */
1885function calendar_get_link_href($linkbase, $d, $m, $y, $time = 0) {
23a29de7
MN
1886 if (empty($linkbase)) {
1887 return null;
1888 }
1889
1890 if (!($linkbase instanceof \moodle_url)) {
1891 $linkbase = new \moodle_url($linkbase);
1892 }
1893
def443a0 1894 $linkbase->param('time', calendar_get_timestamp($d, $m, $y, $time));
23a29de7
MN
1895
1896 return $linkbase;
10515e15
MN
1897}
1898
1899/**
1900 * Build and return a previous month HTML link, with an arrow.
1901 *
1902 * @param string $text The text label.
1903 * @param string|moodle_url $linkbase The URL stub.
1904 * @param int $d The number of the date.
1905 * @param int $m The number of the month.
1906 * @param int $y year The number of the year.
1907 * @param bool $accesshide Default visible, or hide from all except screenreaders.
1908 * @param int $time the unixtime, used for multiple calendar support. The values $d,
1909 * $m and $y are kept for backwards compatibility.
1910 * @return string HTML string.
1911 */
1912function calendar_get_link_previous($text, $linkbase, $d, $m, $y, $accesshide = false, $time = 0) {
23a29de7
MN
1913 $href = calendar_get_link_href(new \moodle_url($linkbase), $d, $m, $y, $time);
1914
1915 if (empty($href)) {
1916 return $text;
1917 }
1918
b16dca43
AN
1919 $attrs = [
1920 'data-time' => calendar_get_timestamp($d, $m, $y, $time),
aefb2950 1921 'data-drop-zone' => 'nav-link',
b16dca43
AN
1922 ];
1923
1924 return link_arrow_left($text, $href->out(false), $accesshide, 'previous', $attrs);
10515e15
MN
1925}
1926
1927/**
1928 * Build and return a next month HTML link, with an arrow.
1929 *
1930 * @param string $text The text label.
1931 * @param string|moodle_url $linkbase The URL stub.
1932 * @param int $d the number of the Day
1933 * @param int $m The number of the month.
1934 * @param int $y The number of the year.
1935 * @param bool $accesshide Default visible, or hide from all except screenreaders.
1936 * @param int $time the unixtime, used for multiple calendar support. The values $d,
1937 * $m and $y are kept for backwards compatibility.
1938 * @return string HTML string.
1939 */
1940function calendar_get_link_next($text, $linkbase, $d, $m, $y, $accesshide = false, $time = 0) {
23a29de7
MN
1941 $href = calendar_get_link_href(new \moodle_url($linkbase), $d, $m, $y, $time);
1942
1943 if (empty($href)) {
1944 return $text;
1945 }
1946
b16dca43
AN
1947 $attrs = [
1948 'data-time' => calendar_get_timestamp($d, $m, $y, $time),
aefb2950 1949 'data-drop-zone' => 'nav-link',
b16dca43
AN
1950 ];
1951
1952 return link_arrow_right($text, $href->out(false), $accesshide, 'next', $attrs);
10515e15
MN
1953}
1954
1955/**
1956 * Return the number of days in month.
1957 *
1958 * @param int $month the number of the month.
1959 * @param int $year the number of the year
1960 * @return int
1961 */
1962function calendar_days_in_month($month, $year) {
23a29de7
MN
1963 $calendartype = \core_calendar\type_factory::get_calendar_instance();
1964 return $calendartype->get_num_days_in_month($year, $month);
10515e15
MN
1965}
1966
1967/**
1968 * Get the next following month.
1969 *
1970 * @param int $month the number of the month.
1971 * @param int $year the number of the year.
1972 * @return array the following month
1973 */
1974function calendar_add_month($month, $year) {
23a29de7
MN
1975 $calendartype = \core_calendar\type_factory::get_calendar_instance();
1976 return $calendartype->get_next_month($year, $month);
10515e15
MN
1977}
1978
1979/**
1980 * Get the previous month.
1981 *
1982 * @param int $month the number of the month.
1983 * @param int $year the number of the year.
1984 * @return array previous month
1985 */
1986function calendar_sub_month($month, $year) {
23a29de7
MN
1987 $calendartype = \core_calendar\type_factory::get_calendar_instance();
1988 return $calendartype->get_prev_month($year, $month);
10515e15
MN
1989}
1990
1991/**
1992 * Get per-day basis events
1993 *
1994 * @param array $events list of events
1995 * @param int $month the number of the month
1996 * @param int $year the number of the year
1997 * @param array $eventsbyday event on specific day
1998 * @param array $durationbyday duration of the event in days
375d82ca 1999 * @param array $typesbyday event type (eg: site, course, user, or group)
10515e15
MN
2000 * @param array $courses list of courses
2001 * @return void
2002 */
2003function calendar_events_by_day($events, $month, $year, &$eventsbyday, &$durationbyday, &$typesbyday, &$courses) {
23a29de7
MN
2004 $calendartype = \core_calendar\type_factory::get_calendar_instance();
2005
2006 $eventsbyday = array();
2007 $typesbyday = array();
2008 $durationbyday = array();
2009
2010 if ($events === false) {
2011 return;
2012 }
2013
2014 foreach ($events as $event) {
2015 $startdate = $calendartype->timestamp_to_date_array($event->timestart);
2016 if ($event->timeduration) {
2017 $enddate = $calendartype->timestamp_to_date_array($event->timestart + $event->timeduration - 1);
2018 } else {
2019 $enddate = $startdate;
2020 }
2021
2022 // Simple arithmetic: $year * 13 + $month is a distinct integer for each distinct ($year, $month) pair.
2023 if (!($startdate['year'] * 13 + $startdate['mon'] <= $year * 13 + $month) &&
2024 ($enddate['year'] * 13 + $enddate['mon'] >= $year * 13 + $month)) {
2025 continue;
2026 }
2027
2028 $eventdaystart = intval($startdate['mday']);
2029
2030 if ($startdate['mon'] == $month && $startdate['year'] == $year) {
2031 // Give the event to its day.
2032 $eventsbyday[$eventdaystart][] = $event->id;
2033
2034 // Mark the day as having such an event.
2035 if ($event->courseid == SITEID && $event->groupid == 0) {
375d82ca
PFO
2036 $typesbyday[$eventdaystart]['startsite'] = true;
2037 // Set event class for site event.
2038 $events[$event->id]->class = 'calendar_event_site';
23a29de7
MN
2039 } else if ($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) {
2040 $typesbyday[$eventdaystart]['startcourse'] = true;
2041 // Set event class for course event.
2042 $events[$event->id]->class = 'calendar_event_course';
2043 } else if ($event->groupid) {
2044 $typesbyday[$eventdaystart]['startgroup'] = true;
2045 // Set event class for group event.
2046 $events[$event->id]->class = 'calendar_event_group';
2047 } else if ($event->userid) {
2048 $typesbyday[$eventdaystart]['startuser'] = true;
2049 // Set event class for user event.
2050 $events[$event->id]->class = 'calendar_event_user';
2051 }
2052 }
2053
2054 if ($event->timeduration == 0) {
2055 // Proceed with the next.
2056 continue;
2057 }
2058
2059 // The event starts on $month $year or before.
2060 if ($startdate['mon'] == $month && $startdate['year'] == $year) {
2061 $lowerbound = intval($startdate['mday']);
2062 } else {
2063 $lowerbound = 0;
2064 }
2065
2066 // Also, it ends on $month $year or later.
2067 if ($enddate['mon'] == $month && $enddate['year'] == $year) {
2068 $upperbound = intval($enddate['mday']);
2069 } else {
2070 $upperbound = calendar_days_in_month($month, $year);
2071 }
2072
2073 // Mark all days between $lowerbound and $upperbound (inclusive) as duration.
2074 for ($i = $lowerbound + 1; $i <= $upperbound; ++$i) {
2075 $durationbyday[$i][] = $event->id;
2076 if ($event->courseid == SITEID && $event->groupid == 0) {
375d82ca 2077 $typesbyday[$i]['durationsite'] = true;
23a29de7
MN
2078 } else if ($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) {
2079 $typesbyday[$i]['durationcourse'] = true;
2080 } else if ($event->groupid) {
2081 $typesbyday[$i]['durationgroup'] = true;
2082 } else if ($event->userid) {
2083 $typesbyday[$i]['durationuser'] = true;
2084 }
2085 }
2086
2087 }
2088 return;
10515e15
MN
2089}
2090
2091/**
2092 * Returns the courses to load events for.
2093 *
2094 * @param array $courseeventsfrom An array of courses to load calendar events for
2095 * @param bool $ignorefilters specify the use of filters, false is set as default
d8c6c21c 2096 * @param stdClass $user The user object. This defaults to the global $USER object.
10515e15
MN
2097 * @return array An array of courses, groups, and user to load calendar events for based upon filters
2098 */
d8c6c21c
SR
2099function calendar_set_filters(array $courseeventsfrom, $ignorefilters = false, stdClass $user = null) {
2100 global $CFG, $USER;
2101
2102 if (is_null($user)) {
2103 $user = $USER;
23a29de7
MN
2104 }
2105
2106 $courses = array();
d8c6c21c 2107 $userid = false;
23a29de7
MN
2108 $group = false;
2109
2110 // Get the capabilities that allow seeing group events from all groups.
2111 $allgroupscaps = array('moodle/site:accessallgroups', 'moodle/calendar:manageentries');
2112
d8c6c21c 2113 $isvaliduser = !empty($user->id);
23a29de7 2114
d8c6c21c 2115 if ($ignorefilters || calendar_show_event_type(CALENDAR_EVENT_COURSE, $user)) {
23a29de7
MN
2116 $courses = array_keys($courseeventsfrom);
2117 }
375d82ca 2118 if ($ignorefilters || calendar_show_event_type(CALENDAR_EVENT_SITE, $user)) {
23a29de7
MN
2119 $courses[] = SITEID;
2120 }
2121 $courses = array_unique($courses);
2122 sort($courses);
2123
2124 if (!empty($courses) && in_array(SITEID, $courses)) {
2125 // Sort courses for consistent colour highlighting.
2126 // Effectively ignoring SITEID as setting as last course id.
2127 $key = array_search(SITEID, $courses);
2128 unset($courses[$key]);
2129 $courses[] = SITEID;
2130 }
2131
d8c6c21c
SR
2132 if ($ignorefilters || ($isvaliduser && calendar_show_event_type(CALENDAR_EVENT_USER, $user))) {
2133 $userid = $user->id;
23a29de7
MN
2134 }
2135
d8c6c21c 2136 if (!empty($courseeventsfrom) && (calendar_show_event_type(CALENDAR_EVENT_GROUP, $user) || $ignorefilters)) {
23a29de7
MN
2137
2138 if (count($courseeventsfrom) == 1) {
2139 $course = reset($courseeventsfrom);
2140 if (has_any_capability($allgroupscaps, \context_course::instance($course->id))) {
2141 $coursegroups = groups_get_all_groups($course->id, 0, 0, 'g.id');
2142 $group = array_keys($coursegroups);
2143 }
2144 }
2145 if ($group === false) {
2146 if (!empty($CFG->calendar_adminseesall) && has_any_capability($allgroupscaps, \context_system::instance())) {
2147 $group = true;
d8c6c21c 2148 } else if ($isvaliduser) {
23a29de7
MN
2149 $groupids = array();
2150 foreach ($courseeventsfrom as $courseid => $course) {
2151 // If the user is an editing teacher in there.
d8c6c21c 2152 if (!empty($user->groupmember[$course->id])) {
23a29de7 2153 // We've already cached the users groups for this course so we can just use that.
d8c6c21c 2154 $groupids = array_merge($groupids, $user->groupmember[$course->id]);
23a29de7
MN
2155 } else if ($course->groupmode != NOGROUPS || !$course->groupmodeforce) {
2156 // If this course has groups, show events from all of those related to the current user.
d8c6c21c 2157 $coursegroups = groups_get_user_groups($course->id, $user->id);
23a29de7
MN
2158 $groupids = array_merge($groupids, $coursegroups['0']);
2159 }
2160 }
2161 if (!empty($groupids)) {
2162 $group = $groupids;
2163 }
2164 }
2165 }
2166 }
2167 if (empty($courses)) {
2168 $courses = false;
2169 }
2170
d8c6c21c 2171 return array($courses, $group, $userid);
10515e15
MN
2172}
2173
af25b8fc
DW
2174/**
2175 * Return the capability for viewing a calendar event.
2176 *
2177 * @param calendar_event $event event object
2178 * @return boolean
2179 */
2180function calendar_view_event_allowed(calendar_event $event) {
2181 global $USER;
2182
2183 // Anyone can see site events.
2184 if ($event->courseid && $event->courseid == SITEID) {
2185 return true;
2186 }
2187
2188 // If a user can manage events at the site level they can see any event.
2189 $sitecontext = \context_system::instance();
2190 // If user has manageentries at site level, return true.
2191 if (has_capability('moodle/calendar:manageentries', $sitecontext)) {
2192 return true;
2193 }
2194
2195 if (!empty($event->groupid)) {
2196 // If it is a group event we need to be able to manage events in the course, or be in the group.
30890c29
DW
2197 if (has_capability('moodle/calendar:manageentries', $event->context) ||
2198 has_capability('moodle/calendar:managegroupentries', $event->context)) {
af25b8fc
DW
2199 return true;
2200 }
2201
2202 $mycourses = enrol_get_my_courses('id');
2203 return isset($mycourses[$event->courseid]) && groups_is_member($event->groupid);
2204 } else if ($event->modulename) {
2205 // If this is a module event we need to be able to see the module.
30890c29
DW
2206 $coursemodules = [];
2207 $courseid = 0;
2208 // Override events do not have the courseid set.
2209 if ($event->courseid) {
2210 $courseid = $event->courseid;
2211 $coursemodules = get_fast_modinfo($event->courseid)->instances;
2212 } else {
2213 $cmraw = get_coursemodule_from_instance($event->modulename, $event->instance, 0, false, MUST_EXIST);
2214 $courseid = $cmraw->course;
2215 $coursemodules = get_fast_modinfo($cmraw->course)->instances;
2216 }
af25b8fc
DW
2217 $hasmodule = isset($coursemodules[$event->modulename]);
2218 $hasinstance = isset($coursemodules[$event->modulename][$event->instance]);
2219
2220 // If modinfo doesn't know about the module, return false to be safe.
2221 if (!$hasmodule || !$hasinstance) {
2222 return false;
2223 }
2224
2225 // Must be able to see the course and the module - MDL-59304.
2226 $cm = $coursemodules[$event->modulename][$event->instance];
2227 if (!$cm->uservisible) {
2228 return false;
2229 }
2230 $mycourses = enrol_get_my_courses('id');
30890c29 2231 return isset($mycourses[$courseid]);
af25b8fc
DW
2232 } else if ($event->categoryid) {
2233 // If this is a category we need to be able to see the category.
442f12f8 2234 $cat = \core_course_category::get($event->categoryid, IGNORE_MISSING);
af25b8fc
DW
2235 if (!$cat) {
2236 return false;
2237 }
2238 return true;
2239 } else if (!empty($event->courseid)) {
2240 // If it is a course event we need to be able to manage events in the course, or be in the course.
2241 if (has_capability('moodle/calendar:manageentries', $event->context)) {
2242 return true;
2243 }
ec482557
SL
2244
2245 return can_access_course(get_course($event->courseid));
af25b8fc
DW
2246 } else if ($event->userid) {
2247 if ($event->userid != $USER->id) {
2248 // No-one can ever see another users events.
2249 return false;
2250 }
2251 return true;
2252 } else {
2253 throw new moodle_exception('unknown event type');
2254 }
2255
2256 return false;
2257}
10515e15
MN
2258
2259/**
2260 * Return the capability for editing calendar event.
2261 *
2262 * @param calendar_event $event event object
909d0858 2263 * @param bool $manualedit is the event being edited manually by the user
10515e15
MN
2264 * @return bool capability to edit event
2265 */
909d0858 2266function calendar_edit_event_allowed($event, $manualedit = false) {
23a29de7
MN
2267 global $USER, $DB;
2268
2269 // Must be logged in.
2270 if (!isloggedin()) {
2271 return false;
2272 }
2273
2274 // Can not be using guest account.
2275 if (isguestuser()) {
2276 return false;
2277 }
2278
909d0858 2279 if ($manualedit && !empty($event->modulename)) {
39fe5929
RW
2280 $hascallback = component_callback_exists(
2281 'mod_' . $event->modulename,
2282 'core_calendar_event_timestart_updated'
2283 );
2284
2285 if (!$hascallback) {
2286 // If the activity hasn't implemented the correct callback
2287 // to handle changes to it's events then don't allow any
2288 // manual changes to them.
2289 return false;
2290 }
2291
2292 $coursemodules = get_fast_modinfo($event->courseid)->instances;
2293 $hasmodule = isset($coursemodules[$event->modulename]);
2294 $hasinstance = isset($coursemodules[$event->modulename][$event->instance]);
2295
2296 // If modinfo doesn't know about the module, return false to be safe.
2297 if (!$hasmodule || !$hasinstance) {
2298 return false;
2299 }
2300
2301 $coursemodule = $coursemodules[$event->modulename][$event->instance];
2302 $context = context_module::instance($coursemodule->id);
2303 // This is the capability that allows a user to modify the activity
2304 // settings. Since the activity generated this event we need to check
2305 // that the current user has the same capability before allowing them
2306 // to update the event because the changes to the event will be
2307 // reflected within the activity.
2308 return has_capability('moodle/course:manageactivities', $context);
909d0858
RW
2309 }
2310
1a972b06 2311 if ($manualedit && !empty($event->component)) {
d268c5ba 2312 // TODO possibly we can later add a callback similar to core_calendar_event_timestart_updated in the modules.
1a972b06
MG
2313 return false;
2314 }
2315
23a29de7
MN
2316 // You cannot edit URL based calendar subscription events presently.
2317 if (!empty($event->subscriptionid)) {
2318 if (!empty($event->subscription->url)) {
2319 // This event can be updated externally, so it cannot be edited.
2320 return false;
2321 }
2322 }
2323
2324 $sitecontext = \context_system::instance();
2325
2326 // If user has manageentries at site level, return true.
2327 if (has_capability('moodle/calendar:manageentries', $sitecontext)) {
2328 return true;
2329 }
2330
2331 // If groupid is set, it's definitely a group event.
2332 if (!empty($event->groupid)) {
2333 // Allow users to add/edit group events if -
2334 // 1) They have manageentries for the course OR
2335 // 2) They have managegroupentries AND are in the group.
2336 $group = $DB->get_record('groups', array('id' => $event->groupid));
2337 return $group && (
86679cb1
AN
2338 has_capability('moodle/calendar:manageentries', $event->context) ||
2339 (has_capability('moodle/calendar:managegroupentries', $event->context)
23a29de7
MN
2340 && groups_is_member($event->groupid)));
2341 } else if (!empty($event->courseid)) {
303d649a 2342 // If groupid is not set, but course is set, it's definitely a course event.
86679cb1 2343 return has_capability('moodle/calendar:manageentries', $event->context);
303d649a
AN
2344 } else if (!empty($event->categoryid)) {
2345 // If groupid is not set, but category is set, it's definitely a category event.
86679cb1 2346 return has_capability('moodle/calendar:manageentries', $event->context);
23a29de7
MN
2347 } else if (!empty($event->userid) && $event->userid == $USER->id) {
2348 // If course is not set, but userid id set, it's a user event.
86679cb1 2349 return (has_capability('moodle/calendar:manageownentries', $event->context));
23a29de7 2350 } else if (!empty($event->userid)) {
86679cb1 2351 return (has_capability('moodle/calendar:manageentries', $event->context));
23a29de7
MN
2352 }
2353
2354 return false;
10515e15
MN
2355}
2356
dadd6f9f
SL
2357/**
2358 * Return the capability for deleting a calendar event.
2359 *
2360 * @param calendar_event $event The event object
2361 * @return bool Whether the user has permission to delete the event or not.
2362 */
2363function calendar_delete_event_allowed($event) {
1a972b06
MG
2364 // Only allow delete if you have capabilities and it is not an module or component event.
2365 return (calendar_edit_event_allowed($event) && empty($event->modulename) && empty($event->component));
dadd6f9f
SL
2366}
2367
10515e15
MN
2368/**
2369 * Returns the default courses to display on the calendar when there isn't a specific
2370 * course to display.
2371 *
a5327e44 2372 * @param int $courseid (optional) If passed, an additional course can be returned for admins (the current course).
01ed53df 2373 * @param string $fields Comma separated list of course fields to return.
bd870573 2374 * @param bool $canmanage If true, this will return the list of courses the user can create events in, rather
ed6d81c9
DW
2375 * than the list of courses they see events from (an admin can always add events in a course
2376 * calendar, even if they are not enrolled in the course).
bd870573
SR
2377 * @param int $userid (optional) The user which this function returns the default courses for.
2378 * By default the current user.
10515e15
MN
2379 * @return array $courses Array of courses to display
2380 */
bd870573
SR
2381function calendar_get_default_courses($courseid = null, $fields = '*', $canmanage = false, int $userid = null) {
2382 global $CFG, $USER;
23a29de7 2383
bd870573
SR
2384 if (!$userid) {
2385 if (!isloggedin()) {
2386 return array();
2387 }
2388 $userid = $USER->id;
23a29de7
MN
2389 }
2390
bd870573
SR
2391 if ((!empty($CFG->calendar_adminseesall) || $canmanage) &&
2392 has_capability('moodle/calendar:manageentries', context_system::instance(), $userid)) {
ed6d81c9 2393
01ed53df
DW
2394 // Add a c. prefix to every field as expected by get_courses function.
2395 $fieldlist = explode(',', $fields);
2396
2397 $prefixedfields = array_map(function($value) {
beff3806 2398 return 'c.' . trim(strtolower($value));
01ed53df 2399 }, $fieldlist);
beff3806
MG
2400 if (!in_array('c.visible', $prefixedfields) && !in_array('c.*', $prefixedfields)) {
2401 $prefixedfields[] = 'c.visible';
2402 }
01ed53df 2403 $courses = get_courses('all', 'c.shortname', implode(',', $prefixedfields));
a5327e44 2404 } else {
bd870573 2405 $courses = enrol_get_users_courses($userid, true, $fields);
23a29de7
MN
2406 }
2407
a5327e44 2408 if ($courseid && $courseid != SITEID) {
bd870573 2409 if (empty($courses[$courseid]) && has_capability('moodle/calendar:manageentries', context_system::instance(), $userid)) {
a5327e44
DW
2410 // Allow a site admin to see calendars from courses he is not enrolled in.
2411 // This will come from $COURSE.
2412 $courses[$courseid] = get_course($courseid);
2413 }
2414 }
23a29de7
MN
2415
2416 return $courses;
10515e15
MN
2417}
2418
2419/**
2420 * Get event format time.
2421 *
2422 * @param calendar_event $event event object
2423 * @param int $now current time in gmt
2424 * @param array $linkparams list of params for event link
2425 * @param bool $usecommonwords the words as formatted date/time.
2426 * @param int $showtime determine the show time GMT timestamp
2427 * @return string $eventtime link/string for event time
2428 */
2429function calendar_format_event_time($event, $now, $linkparams = null, $usecommonwords = true, $showtime = 0) {
23a29de7
MN
2430 $starttime = $event->timestart;
2431 $endtime = $event->timestart + $event->timeduration;
2432
2433 if (empty($linkparams) || !is_array($linkparams)) {
2434 $linkparams = array();
2435 }
2436
2437 $linkparams['view'] = 'day';
2438
2439 // OK, now to get a meaningful display.
2440 // Check if there is a duration for this event.
2441 if ($event->timeduration) {
2442 // Get the midnight of the day the event will start.
2443 $usermidnightstart = usergetmidnight($starttime);
2444 // Get the midnight of the day the event will end.
2445 $usermidnightend = usergetmidnight($endtime);
2446 // Check if we will still be on the same day.
2447 if ($usermidnightstart == $usermidnightend) {
2448 // Check if we are running all day.
2449 if ($event->timeduration == DAYSECS) {
2450 $time = get_string('allday', 'calendar');
2451 } else { // Specify the time we will be running this from.
2452 $datestart = calendar_time_representation($starttime);
2453 $dateend = calendar_time_representation($endtime);
2454 $time = $datestart . ' <strong>&raquo;</strong> ' . $dateend;
2455 }
2456
2457 // Set printable representation.
2458 if (!$showtime) {
2459 $day = calendar_day_representation($event->timestart, $now, $usecommonwords);
2460 $url = calendar_get_link_href(new \moodle_url(CALENDAR_URL . 'view.php', $linkparams), 0, 0, 0, $endtime);
2461 $eventtime = \html_writer::link($url, $day) . ', ' . $time;
2462 } else {
2463 $eventtime = $time;
2464 }
2465 } else { // It must spans two or more days.
2466 $daystart = calendar_day_representation($event->timestart, $now, $usecommonwords) . ', ';
2467 if ($showtime == $usermidnightstart) {
2468 $daystart = '';
2469 }
2470 $timestart = calendar_time_representation($event->timestart);
2471 $dayend = calendar_day_representation($event->timestart + $event->timeduration, $now, $usecommonwords) . ', ';
2472 if ($showtime == $usermidnightend) {
2473 $dayend = '';
2474 }
2475 $timeend = calendar_time_representation($event->timestart + $event->timeduration);
2476
2477 // Set printable representation.
2478 if ($now >= $usermidnightstart && $now < strtotime('+1 day', $usermidnightstart)) {
2479 $url = calendar_get_link_href(new \moodle_url(CALENDAR_URL . 'view.php', $linkparams), 0, 0, 0, $endtime);
2480 $eventtime = $timestart . ' <strong>&raquo;</strong> ' . \html_writer::link($url, $dayend) . $timeend;
2481 } else {
2482 // The event is in the future, print start and end links.
2483 $url = calendar_get_link_href(new \moodle_url(CALENDAR_URL . 'view.php', $linkparams), 0, 0, 0, $starttime);
2484 $eventtime = \html_writer::link($url, $daystart) . $timestart . ' <strong>&raquo;</strong> ';
2485
2486 $url = calendar_get_link_href(new \moodle_url(CALENDAR_URL . 'view.php', $linkparams), 0, 0, 0, $endtime);
2487 $eventtime .= \html_writer::link($url, $dayend) . $timeend;
2488 }
2489 }
2490 } else { // There is no time duration.
2491 $time = calendar_time_representation($event->timestart);
2492 // Set printable representation.
2493 if (!$showtime) {
2494 $day = calendar_day_representation($event->timestart, $now, $usecommonwords);
2495 $url = calendar_get_link_href(new \moodle_url(CALENDAR_URL . 'view.php', $linkparams), 0, 0, 0, $starttime);
2496 $eventtime = \html_writer::link($url, $day) . ', ' . trim($time);
2497 } else {
2498 $eventtime = $time;
2499 }
2500 }
2501
2502 // Check if It has expired.
2503 if ($event->timestart + $event->timeduration < $now) {
2504 $eventtime = '<span class="dimmed_text">' . str_replace(' href=', ' class="dimmed" href=', $eventtime) . '</span>';
2505 }
2506
2507 return $eventtime;
10515e15
MN
2508}
2509
2510/**
2511 * Checks to see if the requested type of event should be shown for the given user.
2512 *
2513 * @param int $type The type to check the display for (default is to display all)
2514 * @param stdClass|int|null $user The user to check for - by default the current user
2515 * @return bool True if the tyep should be displayed false otherwise
2516 */
2517function calendar_show_event_type($type, $user = null) {
375d82ca 2518 $default = CALENDAR_EVENT_SITE + CALENDAR_EVENT_COURSE + CALENDAR_EVENT_GROUP + CALENDAR_EVENT_USER;
23a29de7
MN
2519
2520 if (get_user_preferences('calendar_persistflt', 0, $user) === 0) {
2521 global $SESSION;
2522 if (!isset($SESSION->calendarshoweventtype)) {
2523 $SESSION->calendarshoweventtype = $default;
2524 }
2525 return $SESSION->calendarshoweventtype & $type;
2526 } else {
2527 return get_user_preferences('calendar_savedflt', $default, $user) & $type;
2528 }
10515e15
MN
2529}
2530
2531/**
2532 * Sets the display of the event type given $display.
2533 *
2534 * If $display = true the event type will be shown.
2535 * If $display = false the event type will NOT be shown.
2536 * If $display = null the current value will be toggled and saved.
2537 *
2538 * @param int $type object of CALENDAR_EVENT_XXX
2539 * @param bool $display option to display event type
2540 * @param stdClass|int $user moodle user object or id, null means current user
2541 */
2542function calendar_set_event_type_display($type, $display = null, $user = null) {
23a29de7 2543 $persist = get_user_preferences('calendar_persistflt', 0, $user);
375d82ca 2544 $default = CALENDAR_EVENT_SITE + CALENDAR_EVENT_COURSE + CALENDAR_EVENT_GROUP
05f184bb 2545 + CALENDAR_EVENT_USER + CALENDAR_EVENT_COURSECAT;
23a29de7
MN
2546 if ($persist === 0) {
2547 global $SESSION;
2548 if (!isset($SESSION->calendarshoweventtype)) {
2549 $SESSION->calendarshoweventtype = $default;
2550 }
2551 $preference = $SESSION->calendarshoweventtype;
2552 } else {
2553 $preference = get_user_preferences('calendar_savedflt', $default, $user);
2554 }
2555 $current = $preference & $type;
2556 if ($display === null) {
2557 $display = !$current;
2558 }
2559 if ($display && !$current) {
2560 $preference += $type;
2561 } else if (!$display && $current) {
2562 $preference -= $type;
2563 }
2564 if ($persist === 0) {
2565 $SESSION->calendarshoweventtype = $preference;
2566 } else {
2567 if ($preference == $default) {
2568 unset_user_preference('calendar_savedflt', $user);
2569 } else {
2570 set_user_preference('calendar_savedflt', $preference, $user);
2571 }
2572 }
10515e15
MN
2573}
2574
2575/**
2576 * Get calendar's allowed types.
2577 *
2578 * @param stdClass $allowed list of allowed edit for event type
2579 * @param stdClass|int $course object of a course or course id
aa091225 2580 * @param array $groups array of groups for the given course
05f184bb 2581 * @param stdClass|int $category object of a category
10515e15 2582 */
05f184bb 2583function calendar_get_allowed_types(&$allowed, $course = null, $groups = null, $category = null) {
23a29de7
MN
2584 global $USER, $DB;
2585
2586 $allowed = new \stdClass();
2587 $allowed->user = has_capability('moodle/calendar:manageownentries', \context_system::instance());
2588 $allowed->groups = false;
2589 $allowed->courses = false;
05f184bb 2590 $allowed->categories = false;
23a29de7 2591 $allowed->site = has_capability('moodle/calendar:manageentries', \context_course::instance(SITEID));
aa091225
RW
2592 $getgroupsfunc = function($course, $context, $user) use ($groups) {
2593 if ($course->groupmode != NOGROUPS || !$course->groupmodeforce) {
2594 if (has_capability('moodle/site:accessallgroups', $context)) {
2595 return is_null($groups) ? groups_get_all_groups($course->id) : $groups;
2596 } else {
2597 if (is_null($groups)) {
2598 return groups_get_all_groups($course->id, $user->id);
2599 } else {
2600 return array_filter($groups, function($group) use ($user) {
2601 return isset($group->members[$user->id]);
2602 });
2603 }
2604 }
2605 }
2606
2607 return false;
2608 };
23a29de7
MN
2609
2610 if (!empty($course)) {
2611 if (!is_object($course)) {
2dc93a37 2612 $course = $DB->get_record('course', array('id' => $course), 'id, groupmode, groupmodeforce', MUST_EXIST);
23a29de7
MN
2613 }
2614 if ($course->id != SITEID) {
2615 $coursecontext = \context_course::instance($course->id);
2616 $allowed->user = has_capability('moodle/calendar:manageownentries', $coursecontext);
2617
2618 if (has_capability('moodle/calendar:manageentries', $coursecontext)) {
2619 $allowed->courses = array($course->id => 1);
aa091225 2620 $allowed->groups = $getgroupsfunc($course, $coursecontext, $USER);
23a29de7 2621 } else if (has_capability('moodle/calendar:managegroupentries', $coursecontext)) {
aa091225
RW
2622 $allowed->groups = $getgroupsfunc($course, $coursecontext, $USER);
2623 }
2624 }
2625 }
05f184bb
AN
2626
2627 if (!empty($category)) {
2628 $catcontext = \context_coursecat::instance($category->id);
2629 if (has_capability('moodle/category:manage', $catcontext)) {
2630 $allowed->categories = [$category->id => 1];
2631 }
2632 }
aa091225
RW
2633}
2634
10515e15
MN
2635/**
2636 * See if user can add calendar entries at all used to print the "New Event" button.
2637 *
2638 * @param stdClass $course object of a course or course id
2639 * @return bool has the capability to add at least one event type
2640 */
2641function calendar_user_can_add_event($course) {
23a29de7
MN
2642 if (!isloggedin() || isguestuser()) {
2643 return false;
2644 }
2645
2646 calendar_get_allowed_types($allowed, $course);
2647
4e84059e 2648 return (bool)($allowed->user || $allowed->groups || $allowed->courses || $allowed->categories || $allowed->site);
10515e15
MN
2649}
2650
2651/**
2652 * Check wether the current user is permitted to add events.
2653 *
2654 * @param stdClass $event object of event
2655 * @return bool has the capability to add event
2656 */
2657function calendar_add_event_allowed($event) {
23a29de7
MN
2658 global $USER, $DB;
2659
2660 // Can not be using guest account.
2661 if (!isloggedin() or isguestuser()) {
2662 return false;
2663 }
2664
2665 $sitecontext = \context_system::instance();
2666
2667 // If user has manageentries at site level, always return true.
2668 if (has_capability('moodle/calendar:manageentries', $sitecontext)) {
2669 return true;
2670 }
2671
2672 switch ($event->eventtype) {
05f184bb
AN
2673 case 'category':
2674 return has_capability('moodle/category:manage', $event->context);
23a29de7
MN
2675 case 'course':
2676 return has_capability('moodle/calendar:manageentries', $event->context);
2677 case 'group':
2678 // Allow users to add/edit group events if -
2679 // 1) They have manageentries (= entries for whole course).
2680 // 2) They have managegroupentries AND are in the group.
2681 $group = $DB->get_record('groups', array('id' => $event->groupid));
2682 return $group && (
2683 has_capability('moodle/calendar:manageentries', $event->context) ||
2684 (has_capability('moodle/calendar:managegroupentries', $event->context)
2685 && groups_is_member($event->groupid)));
2686 case 'user':
2687 if ($event->userid == $USER->id) {
2688 return (has_capability('moodle/calendar:manageownentries', $event->context));
2689 }
2690 // There is intentionally no 'break'.
2691 case 'site':
2692 return has_capability('moodle/calendar:manageentries', $event->context);
2693 default:
2694 return has_capability('moodle/calendar:manageentries', $event->context);
2695 }
10515e15
MN
2696}
2697
2698/**
2699 * Returns option list for the poll interval setting.
2700 *
2701 * @return array An array of poll interval options. Interval => description.
2702 */
2703function calendar_get_pollinterval_choices() {
23a29de7
MN
2704 return array(
2705 '0' => new \lang_string('never', 'calendar'),
2706 HOURSECS => new \lang_string('hourly', 'calendar'),
2707 DAYSECS => new \lang_string('daily', 'calendar'),
2708 WEEKSECS => new \lang_string('weekly', 'calendar'),
2709 '2628000' => new \lang_string('monthly', 'calendar'),
2710 YEARSECS => new \lang_string('annually', 'calendar')
2711 );
10515e15
MN
2712}
2713
2714/**
2715 * Returns option list of available options for the calendar event type, given the current user and course.
2716 *
2717 * @param int $courseid The id of the course
2718 * @return array An array containing the event types the user can create.
2719 */
2720function calendar_get_eventtype_choices($courseid) {
23a29de7
MN
2721 $choices = array();
2722 $allowed = new \stdClass;
2723 calendar_get_allowed_types($allowed, $courseid);
2724
2725 if ($allowed->user) {
2726 $choices['user'] = get_string('userevents', 'calendar');
2727 }
2728 if ($allowed->site) {
2729 $choices['site'] = get_string('siteevents', 'calendar');
2730 }
2731 if (!empty($allowed->courses)) {
2732 $choices['course'] = get_string('courseevents', 'calendar');
2733 }
05f184bb
AN
2734 if (!empty($allowed->categories)) {
2735 $choices['category'] = get_string('categoryevents', 'calendar');
2736 }
23a29de7
MN
2737 if (!empty($allowed->groups) and is_array($allowed->groups)) {
2738 $choices['group'] = get_string('group');
2739 }
2740
2741 return array($choices, $allowed->groups);
10515e15
MN
2742}
2743
2744/**
2745 * Add an iCalendar subscription to the database.
2746 *
2747 * @param stdClass $sub The subscription object (e.g. from the form)
2748 * @return int The insert ID, if any.
2749 */
2750function calendar_add_subscription($sub) {
23a29de7
MN
2751 global $DB, $USER, $SITE;
2752
b9fd5164
AN
2753 // Undo the form definition work around to allow us to have two different
2754 // course selectors present depending on which event type the user selects.
2755 if (!empty($sub->groupcourseid)) {
2756 $sub->courseid = $sub->groupcourseid;
2757 unset($sub->groupcourseid);
2758 }
2759
b9fd5164
AN
2760 // Default course id if none is set.
2761 if (empty($sub->courseid)) {
2762 if ($sub->eventtype === 'site') {
2763 $sub->courseid = SITEID;
2764 } else {
2765 $sub->courseid = 0;
2766 }
2767 }
2768
23a29de7
MN
2769 if ($sub->eventtype === 'site') {
2770 $sub->courseid = $SITE->id;
2771 } else if ($sub->eventtype === 'group' || $sub->eventtype === 'course') {
b9fd5164 2772 $sub->courseid = $sub->courseid;
05f184bb 2773 } else if ($sub->eventtype === 'category') {
b9fd5164 2774 $sub->categoryid = $sub->categoryid;
23a29de7
MN
2775 } else {
2776 // User events.
2777 $sub->courseid = 0;
2778 }
2779 $sub->userid = $USER->id;
2780
2781 // File subscriptions never update.
2782 if (empty($sub->url)) {
2783 $sub->pollinterval = 0;
2784 }
2785
2786 if (!empty($sub->name)) {
2787 if (empty($sub->id)) {
2788 $id = $DB->insert_record('event_subscriptions', $sub);
2789 // We cannot cache the data here because $sub is not complete.
2790 $sub->id = $id;
2791 // Trigger event, calendar subscription added.
2792 $eventparams = array('objectid' => $sub->id,
2793 'context' => calendar_get_calendar_context($sub),
b9fd5164
AN
2794 'other' => array(
2795 'eventtype' => $sub->eventtype,
2796 )
23a29de7 2797 );
b9fd5164
AN
2798 switch ($sub->eventtype) {
2799 case 'category':
2800 $eventparams['other']['categoryid'] = $sub->categoryid;
2801 break;
2802 case 'course':
2803 $eventparams['other']['courseid'] = $sub->courseid;
2804 break;
2805 case 'group':
2806 $eventparams['other']['courseid'] = $sub->courseid;
2807 $eventparams['other']['groupid'] = $sub->groupid;
2808 break;
2809 default:
2810 $eventparams['other']['courseid'] = $sub->courseid;
2811 }
2812
23a29de7
MN
2813 $event = \core\event\calendar_subscription_created::create($eventparams);
2814 $event->trigger();
2815 return $id;
2816 } else {
2817 // Why are we doing an update here?
2818 calendar_update_subscription($sub);
2819 return $sub->id;
2820 }
2821 } else {
2822 print_error('errorbadsubscription', 'importcalendar');
2823 }
10515e15
MN
2824}
2825
2826/**
2827 * Add an iCalendar event to the Moodle calendar.
2828 *
2829 * @param stdClass $event The RFC-2445 iCalendar event
b9fd5164 2830 * @param int $unused Deprecated
10515e15
MN
2831 * @param int $subscriptionid The iCalendar subscription ID
2832 * @param string $timezone The X-WR-TIMEZONE iCalendar property if provided
2833 * @throws dml_exception A DML specific exception is thrown for invalid subscriptionids.
2834 * @return int Code: CALENDAR_IMPORT_EVENT_UPDATED = updated, CALENDAR_IMPORT_EVENT_INSERTED = inserted, 0 = error
2835 */
b9fd5164 2836function calendar_add_icalendar_event($event, $unused = null, $subscriptionid, $timezone='UTC') {
23a29de7
MN
2837 global $DB;
2838
2839 // Probably an unsupported X-MICROSOFT-CDO-BUSYSTATUS event.
2840 if (empty($event->properties['SUMMARY'])) {
2841 return 0;
2842 }
2843
2844 $name = $event->properties['SUMMARY'][0]->value;
2845 $name = str_replace('\n', '<br />', $name);
2846 $name = str_replace('\\', '', $name);
2847 $name = preg_replace('/\s+/u', ' ', $name);
2848
2849 $eventrecord = new \stdClass;
2850 $eventrecord->name = clean_param($name, PARAM_NOTAGS);
2851
2852 if (empty($event->properties['DESCRIPTION'][0]->value)) {
2853 $description = '';
2854 } else {
2855 $description = $event->properties['DESCRIPTION'][0]->value;
2856 $description = clean_param($description, PARAM_NOTAGS);
2857 $description = str_replace('\n', '<br />', $description);
2858 $description = str_replace('\\', '', $description);
2859 $description = preg_replace('/\s+/u', ' ', $description);
2860 }
2861 $eventrecord->description = $description;
2862
2863 // Probably a repeating event with RRULE etc. TODO: skip for now.
2864 if (empty($event->properties['DTSTART'][0]->value)) {
2865 return 0;
2866 }
2867
2868 if (isset($event->properties['DTSTART'][0]->parameters['TZID'])) {
2869 $tz = $event->properties['DTSTART'][0]->parameters['TZID'];
2870 } else {
2871 $tz = $timezone;
2872 }
2873 $tz = \core_date::normalise_timezone($tz);
2874 $eventrecord->timestart = strtotime($event->properties['DTSTART'][0]->value . ' ' . $tz);
2875 if (empty($event->properties['DTEND'])) {
2876 $eventrecord->timeduration = 0; // No duration if no end time specified.
2877 } else {
2878 if (isset($event->properties['DTEND'][0]->parameters['TZID'])) {
2879 $endtz = $event->properties['DTEND'][0]->parameters['TZID'];
2880 } else {
2881 $endtz = $timezone;
2882 }
2883 $endtz = \core_date::normalise_timezone($endtz);
2884 $eventrecord->timeduration = strtotime($event->properties['DTEND'][0]->value . ' ' . $endtz) - $eventrecord->timestart;
2885 }
2886
2887 // Check to see if it should be treated as an all day event.
2888 if ($eventrecord->timeduration == DAYSECS) {
2889 // Check to see if the event started at Midnight on the imported calendar.
2890 date_default_timezone_set($timezone);
2891 if (date('H:i:s', $eventrecord->timestart) === "00:00:00") {
8aaba9e4
AA
2892 // This event should be an all day event. This is not correct, we don't do anything differently for all day events.
2893 // See MDL-56227.
23a29de7
MN
2894 $eventrecord->timeduration = 0;
2895 }
2896 \core_date::set_default_server_timezone();
2897 }
2898
ef4e04ee 2899 $eventrecord->location = empty($event->properties['LOCATION'][0]->value) ? '' :
a8dcc212 2900 trim(str_replace('\\', '', $event->properties['LOCATION'][0]->value));
23a29de7
MN
2901 $eventrecord->uuid = $event->properties['UID'][0]->value;
2902 $eventrecord->timemodified = time();
2903
2904 // Add the iCal subscription details if required.
2905 // We should never do anything with an event without a subscription reference.
2906 $sub = calendar_get_subscription($subscriptionid);
2907 $eventrecord->subscriptionid = $subscriptionid;
2908 $eventrecord->userid = $sub->userid;
2909 $eventrecord->groupid = $sub->groupid;
2910 $eventrecord->courseid = $sub->courseid;
b9fd5164 2911 $eventrecord->categoryid = $sub->categoryid;
23a29de7
MN
2912 $eventrecord->eventtype = $sub->eventtype;
2913
2914 if ($updaterecord = $DB->get_record('event', array('uuid' => $eventrecord->uuid,
2915 'subscriptionid' => $eventrecord->subscriptionid))) {
d5727ed3
SL
2916
2917 // Compare iCal event data against the moodle event to see if something has changed.
2918 $result = array_diff((array) $eventrecord, (array) $updaterecord);
2919
2920 // Unset timemodified field because it's always going to be different.
2921 unset($result['timemodified']);
2922
2923 if (count($result)) {
2924 $eventrecord->id = $updaterecord->id;
2925 $return = CALENDAR_IMPORT_EVENT_UPDATED; // Update.
2926 } else {
2927 return CALENDAR_IMPORT_EVENT_SKIPPED;
2928 }
23a29de7
MN
2929 } else {
2930 $return = CALENDAR_IMPORT_EVENT_INSERTED; // Insert.
2931 }
d5727ed3 2932
23a29de7
MN
2933 if ($createdevent = \calendar_event::create($eventrecord, false)) {
2934 if (!empty($event->properties['RRULE'])) {
2935 // Repeating events.
2936 date_default_timezone_set($tz); // Change time zone to parse all events.
c9d775fc 2937 $rrule = new \core_calendar\rrule_manager($event->properties['RRULE'][0]->value);
23a29de7
MN
2938 $rrule->parse_rrule();
2939 $rrule->create_events($createdevent);
2940 \core_date::set_default_server_timezone(); // Change time zone back to what it was.
2941 }
2942 return $return;
2943 } else {
2944 return 0;
2945 }
10515e15
MN
2946}
2947
2948/**
2949 * Update a subscription from the form data in one of the rows in the existing subscriptions table.
2950 *
2951 * @param int $subscriptionid The ID of the subscription we are acting upon.
2952 * @param int $pollinterval The poll interval to use.
2953 * @param int $action The action to be performed. One of update or remove.
2954 * @throws dml_exception if invalid subscriptionid is provided
2955 * @return string A log of the import progress, including errors
2956 */
2957function calendar_process_subscription_row($subscriptionid, $pollinterval, $action) {
23a29de7
MN
2958 // Fetch the subscription from the database making sure it exists.
2959 $sub = calendar_get_subscription($subscriptionid);
2960
2961 // Update or remove the subscription, based on action.
2962 switch ($action) {
2963 case CALENDAR_SUBSCRIPTION_UPDATE:
2964 // Skip updating file subscriptions.
2965 if (empty($sub->url)) {
2966 break;
2967 }
2968 $sub->pollinterval = $pollinterval;
2969 calendar_update_subscription($sub);
2970
2971 // Update the events.
2972 return "<p>" . get_string('subscriptionupdated', 'calendar', $sub->name) . "</p>" .
2973 calendar_update_subscription_events($subscriptionid);
2974 case CALENDAR_SUBSCRIPTION_REMOVE:
2975 calendar_delete_subscription($subscriptionid);
2976 return get_string('subscriptionremoved', 'calendar', $sub->name);
2977 break;
2978 default:
2979 break;
2980 }
2981 return '';
10515e15
MN
2982}
2983
2984/**
2985 * Delete subscription and all related events.
2986 *
2987 * @param int|stdClass $subscription subscription or it's id, which needs to be deleted.
2988 */
2989function calendar_delete_subscription($subscription) {
23a29de7
MN
2990 global $DB;
2991
2992 if (!is_object($subscription)) {
2993 $subscription = $DB->get_record('event_subscriptions', array('id' => $subscription), '*', MUST_EXIST);
2994 }
2995
2996 // Delete subscription and related events.
2997 $DB->delete_records('event', array('subscriptionid' => $subscription->id));
2998 $DB->delete_records('event_subscriptions', array('id' => $subscription->id));
2999 \cache_helper::invalidate_by_definition('core', 'calendar_subscriptions', array(), array($subscription->id));
3000
3001 // Trigger event, calendar subscription deleted.
3002 $eventparams = array('objectid' => $subscription->id,
3003 'context' => calendar_get_calendar_context($subscription),
b9fd5164
AN
3004 'other' => array(
3005 'eventtype' => $subscription->eventtype,
3006 )
23a29de7 3007 );
b9fd5164
AN
3008 switch ($subscription->eventtype) {
3009 case 'category':
3010 $eventparams['other']['categoryid'] = $subscription->categoryid;
3011 break;
3012 case 'course':
3013 $eventparams['other']['courseid'] = $subscription->courseid;
3014 break;
3015 case 'group':
3016 $eventparams['other']['courseid'] = $subscription->courseid;
3017 $eventparams['other']['groupid'] = $subscription->groupid;
3018 break;
3019 default:
3020 $eventparams['other']['courseid'] = $subscription->courseid;
3021 }
23a29de7
MN
3022 $event = \core\event\calendar_subscription_deleted::create($eventparams);
3023 $event->trigger();
10515e15
MN
3024}
3025
3026/**
3027 * From a URL, fetch the calendar and return an iCalendar object.
3028 *
3029 * @param string $url The iCalendar URL
3030 * @return iCalendar The iCalendar object
3031 */
3032function calendar_get_icalendar($url) {
23a29de7
MN
3033 global $CFG;
3034
3035 require_once($CFG->libdir . '/filelib.php');
3036
3037 $curl = new \curl();
3038 $curl->setopt(array('CURLOPT_FOLLOWLOCATION' => 1, 'CURLOPT_MAXREDIRS' => 5));
3039 $calendar = $curl->get($url);
3040
3041 // Http code validation should actually be the job of curl class.
3042 if (!$calendar || $curl->info['http_code'] != 200 || !empty($curl->errorno)) {
3043 throw new \moodle_exception('errorinvalidicalurl', 'calendar');
3044 }
3045
3046 $ical = new \iCalendar();
3047 $ical->unserialize($calendar);
3048
3049 return $ical;
10515e15
MN
3050}
3051
3052/**
3053 * Import events from an iCalendar object into a course calendar.
3054 *
3055 * @param iCalendar $ical The iCalendar object.
26b683e7 3056 * @param int $unused Deprecated
10515e15
MN
3057 * @param int $subscriptionid The subscription ID.
3058 * @return string A log of the import progress, including errors.
3059 */
b9fd5164 3060function calendar_import_icalendar_events($ical, $unused = null, $subscriptionid = null) {
23a29de7
MN
3061 global $DB;
3062
3063 $return = '';
3064 $eventcount = 0;
3065 $updatecount = 0;
d5727ed3 3066 $skippedcount = 0;
23a29de7
MN
3067
3068 // Large calendars take a while...
3069 if (!CLI_SCRIPT) {
3070 \core_php_time_limit::raise(300);
3071 }
3072
23a29de7
MN
3073 // Grab the timezone from the iCalendar file to be used later.
3074 if (isset($ical->properties['X-WR-TIMEZONE'][0]->value)) {
3075 $timezone = $ical->properties['X-WR-TIMEZONE'][0]->value;
3076 } else {
3077 $timezone = 'UTC';
3078 }
3079
d5727ed3 3080 $icaluuids = [];
23a29de7 3081 foreach ($ical->components['VEVENT'] as $event) {
d5727ed3 3082 $icaluuids[] = $event->properties['UID'][0]->value;
b9fd5164 3083 $res = calendar_add_icalendar_event($event, null, $subscriptionid, $timezone);
23a29de7
MN
3084 switch ($res) {
3085 case CALENDAR_IMPORT_EVENT_UPDATED:
3086 $updatecount++;
3087 break;
3088 case CALENDAR_IMPORT_EVENT_INSERTED:
3089 $eventcount++;
3090 break;
d5727ed3
SL
3091 case CALENDAR_IMPORT_EVENT_SKIPPED:
3092 $skippedcount++;
3093 break;
23a29de7
MN
3094 case 0:
3095 $return .= '<p>' . get_string('erroraddingevent', 'calendar') . ': ';
3096 if (empty($event->properties['SUMMARY'])) {
3097 $return .= '(' . get_string('notitle', 'calendar') . ')';
3098 } else {
3099 $return .= $event->properties['SUMMARY'][0]->value;
3100 }
3101 $return .= "</p>\n";
3102 break;
3103 }
3104 }
3105
5b3b975e
SL
3106 $existing = $DB->get_field('event_subscriptions', 'lastupdated', ['id' => $subscriptionid]);
3107 if (!empty($existing)) {
d5727ed3
SL
3108 $eventsuuids = $DB->get_records_menu('event', ['subscriptionid' => $subscriptionid], '', 'id, uuid');
3109
3110 $icaleventscount = count($icaluuids);
3111 $tobedeleted = [];
3112 if (count($eventsuuids) > $icaleventscount) {
3113 foreach ($eventsuuids as $eventid => $eventuuid) {
3114 if (!in_array($eventuuid, $icaluuids)) {
3115 $tobedeleted[] = $eventid;
3116 }
3117 }
3118 if (!empty($tobedeleted)) {
3119 $DB->delete_records_list('event', 'id', $tobedeleted);
2d132fda 3120 $return .= "<p> " . get_string('eventsdeleted', 'calendar') . ": " . count($tobedeleted) . "</p> ";
d5727ed3 3121 }
23a29de7
MN
3122 }
3123 }
3124
d5727ed3
SL
3125 $return .= "<p>" . get_string('eventsimported', 'calendar', $eventcount) . "</p> ";
3126 $return .= "<p>" . get_string('eventsskipped', 'calendar', $skippedcount) . "</p> ";
3127 $return .= "<p>" . get_string('eventsupdated', 'calendar', $updatecount) . "</p>";
23a29de7 3128 return $return;
10515e15
MN
3129}
3130
3131/**
3132 * Fetch a calendar subscription and update the events in the calendar.
3133 *
3134 * @param int $subscriptionid The course ID for the calendar.
3135 * @return string A log of the import progress, including errors.
3136 */
3137function calendar_update_subscription_events($subscriptionid) {
23a29de7
MN
3138 $sub = calendar_get_subscription($subscriptionid);
3139
3140 // Don't update a file subscription.
3141 if (empty($sub->url)) {
3142 return 'File subscription not updated.';
3143 }
3144
3145 $ical = calendar_get_icalendar($sub->url);
b9fd5164 3146 $return = calendar_import_icalendar_events($ical, null, $subscriptionid);
23a29de7
MN
3147 $sub->lastupdated = time();
3148
3149 calendar_update_subscription($sub);
3150
3151 return $return;
10515e15
MN
3152}
3153
3154/**
3155 * Update a calendar subscription. Also updates the associated cache.
3156 *
3157 * @param stdClass|array $subscription Subscription record.
3158 * @throws coding_exception If something goes wrong
3159 * @since Moodle 2.5
3160 */
3161function calendar_update_subscription($subscription) {
23a29de7
MN
3162 global $DB;
3163
3164 if (is_array($subscription)) {
3165 $subscription = (object)$subscription;
3166 }
3167 if (empty($subscription->id) || !$DB->record_exists('event_subscriptions', array('id' => $subscription->id))) {
3168 throw new \coding_exception('Cannot update a subscription without a valid id');
3169 }
3170
3171 $DB->update_record('event_subscriptions', $subscription);
3172
3173 // Update cache.
3174 $cache = \cache::make('core', 'calendar_subscriptions');
3175 $cache->set($subscription->id, $subscription);
3176
3177 // Trigger event, calendar subscription updated.
3178 $eventparams = array('userid' => $subscription->userid,
3179 'objectid' => $subscription->id,
3180 'context' => calendar_get_calendar_context($subscription),
b9fd5164
AN
3181 'other' => array(
3182 'eventtype' => $subscription->eventtype,
3183 )
23a29de7 3184 );
b9fd5164
AN
3185 switch ($subscription->eventtype) {
3186 case 'category':
3187 $eventparams['other']['categoryid'] = $subscription->categoryid;
3188 break;
3189 case 'course':
3190 $eventparams['other']['courseid'] = $subscription->courseid;
3191 break;
3192 case 'group':
3193 $eventparams['other']['courseid'] = $subscription->courseid;
3194 $eventparams['other']['groupid'] = $subscription->groupid;
3195 break;
3196 default:
3197 $eventparams['other']['courseid'] = $subscription->courseid;
3198 }
23a29de7
MN
3199 $event = \core\event\calendar_subscription_updated::create($eventparams);
3200 $event->trigger();
10515e15
MN
3201}
3202
3203/**
3204 * Checks to see if the user can edit a given subscription feed.
3205 *
3206 * @param mixed $subscriptionorid Subscription object or id
3207 * @return bool true if current user can edit the subscription else false
3208 */
3209function calendar_can_edit_subscription($subscriptionorid) {
23a29de7
MN
3210 if (is_array($subscriptionorid)) {
3211 $subscription = (object)$subscriptionorid;
3212 } else if (is_object($subscriptionorid)) {
3213 $subscription = $subscriptionorid;
3214 } else {
3215 $subscription = calendar_get_subscription($subscriptionorid);
3216 }
3217
3218 $allowed = new \stdClass;
3219 $courseid = $subscription->courseid;
b9fd5164 3220 $categoryid = $subscription->categoryid;
23a29de7 3221 $groupid = $subscription->groupid;
b9fd5164 3222 $category = null;
23a29de7 3223
b9fd5164 3224 if (!empty($categoryid)) {
442f12f8 3225 $category = \core_course_category::get($categoryid);
b9fd5164
AN
3226 }
3227 calendar_get_allowed_types($allowed, $courseid, null, $category);
23a29de7
MN
3228 switch ($subscription->eventtype) {
3229 case 'user':
3230 return $allowed->user;
3231 case 'course':
3232 if (isset($allowed->courses[$courseid])) {
3233 return $allowed->courses[$courseid];
3234 } else {
3235 return false;
3236 }
b9fd5164
AN
3237 case 'category':
3238 if (isset($allowed->categories[$categoryid])) {
3239 return $allowed->categories[$categoryid];
3240 } else {
3241 return false;
3242 }
23a29de7
MN
3243 case 'site':
3244 return $allowed->site;
3245 case 'group':
3246 if (isset($allowed->groups[$groupid])) {
3247 return $allowed->groups[$groupid];
3248 } else {
3249 return false;
3250 }
3251 default:
3252 return false;
3253 }
10515e15
MN
3254}
3255
3256/**
3257 * Helper function to determine the context of a calendar subscription.
3258 * Subscriptions can be created in two contexts COURSE, or USER.
3259 *
3260 * @param stdClass $subscription
3261 * @return context instance
3262 */
3263function calendar_get_calendar_context($subscription) {
23a29de7
MN
3264 // Determine context based on calendar type.
3265 if ($subscription->eventtype === 'site') {
3266 $context = \context_course::instance(SITEID);
3267 } else if ($subscription->eventtype === 'group' || $subscription->eventtype === 'course') {
3268 $context = \context_course::instance($subscription->courseid);
3269 } else {
3270 $context = \context_user::instance($subscription->userid);
3271 }
3272 return $context;
10515e15
MN
3273}
3274
6e65554e 3275/**
801ee234 3276 * Implements callback user_preferences, lists preferences that users are allowed to update directly
6e65554e
MG
3277 *
3278 * Used in {@see core_user::fill_preferences_cache()}, see also {@see useredit_update_user_preference()}
3279 *
3280 * @return array
3281 */
3282function core_calendar_user_preferences() {
3283 $preferences = [];
3284 $preferences['calendar_timeformat'] = array('type' => PARAM_NOTAGS, 'null' => NULL_NOT_ALLOWED, 'default' => '0',
3285 'choices' => array('0', CALENDAR_TF_12, CALENDAR_TF_24)
3286 );
3287 $preferences['calendar_startwday'] = array('type' => PARAM_INT, 'null' => NULL_NOT_ALLOWED, 'default' => 0,
3288 'choices' => array(0, 1, 2, 3, 4, 5, 6));
3289 $preferences['calendar_maxevents'] = array('type' => PARAM_INT, 'choices' => range(1, 20));
3290 $preferences['calendar_lookahead'] = array('type' => PARAM_INT, 'null' => NULL_NOT_ALLOWED, 'default' => 365,
3291 'choices' => array(365, 270, 180, 150, 120, 90, 60, 30, 21, 14, 7, 6, 5, 4, 3, 2, 1));
3292 $preferences['calendar_persistflt'] = array('type' => PARAM_INT, 'null' => NULL_NOT_ALLOWED, 'default' => 0,
3293 'choices' => array(0, 1));
3294 return $preferences;
663640f5 3295}
22753c8c
JP
3296
3297/**
3298 * Get legacy calendar events
3299 *
3300 * @param int $tstart Start time of time range for events
3301 * @param int $tend End time of time range for events
3302 * @param array|int|boolean $users array of users, user id or boolean for all/no user events
3303 * @param array|int|boolean $groups array of groups, group id or boolean for all/no group events
3304 * @param array|int|boolean $courses array of courses, course id or boolean for all/no course events
3305 * @param boolean $withduration whether only events starting within time range selected
3306 * or events in progress/already started selected as well
3307 * @param boolean $ignorehidden whether to select only visible events or all events
10c17dcc 3308 * @param array $categories array of category ids and/or objects.
e099259a
SL
3309 * @param int $limitnum Number of events to fetch or zero to fetch all.
3310 *
22753c8c
JP
3311 * @return array $events of selected events or an empty array if there aren't any (or there was an error)
3312 */
0085b0ea 3313function calendar_get_legacy_events($tstart, $tend, $users, $groups, $courses,
e099259a 3314 $withduration = true, $ignorehidden = true, $categories = [], $limitnum = 0) {
22753c8c
JP
3315 // Normalise the users, groups and courses parameters so that they are compliant with \core_calendar\local\api::get_events().
3316 // Existing functions that were using the old calendar_get_events() were passing a mixture of array, int, boolean for these
3317 // parameters, but with the new API method, only null and arrays are accepted.
0085b0ea 3318 list($userparam, $groupparam, $courseparam, $categoryparam) = array_map(function($param) {
22753c8c
JP
3319 // If parameter is true, return null.
3320 if ($param === true) {
3321 return null;
3322 }
3323
3324 // If parameter is false, return an empty array.
3325 if ($param === false) {
3326 return [];
3327 }
3328
3329 // If the parameter is a scalar value, enclose it in an array.
3330 if (!is_array($param)) {
3331 return [$param];
3332 }
3333
3334 // No normalisation required.
3335 return $param;
0085b0ea 3336 }, [$users, $groups, $courses, $categories]);
22753c8c 3337
95ae74a7
SR
3338 // If a single user is provided, we can use that for capability checks.
3339 // Otherwise current logged in user is used - See MDL-58768.
3340 if (is_array($userparam) && count($userparam) == 1) {
3341 \core_calendar\local\event\container::set_requesting_user($userparam[0]);
3342 }
22753c8c
JP
3343 $mapper = \core_calendar\local\event\container::get_event_mapper();
3344 $events = \core_calendar\local\api::get_events(
3345 $tstart,
3346 $tend,
3347 null,
3348 null,
3349 null,
3350 null,
e099259a 3351 $limitnum,
22753c8c
JP
3352 null,
3353 $userparam,
3354 $groupparam,
3355 $courseparam,
0085b0ea 3356 $categoryparam,
22753c8c
JP
3357 $withduration,
3358 $ignorehidden
3359 );
3360
3361 return array_reduce($events, function($carry, $event) use ($mapper) {
3362 return $carry + [$event->get_id() => $mapper->from_event_to_stdclass($event)];
3363 }, []);
3364}
aa091225 3365
64ff737a
AN
3366
3367/**
836aa3f6 3368 * Get the calendar view output.
64ff737a
AN
3369 *
3370 * @param \calendar_information $calendar The calendar being represented
fee025ec
AN
3371 * @param string $view The type of calendar to have displayed
3372 * @param bool $includenavigation Whether to include navigation
7884ecf2 3373 * @param bool $skipevents Whether to load the events or not
982fef46 3374 * @param int $lookahead Overwrites site and users's lookahead setting.
64ff737a
AN
3375 * @return array[array, string]
3376 */
982fef46
DM
3377function calendar_get_view(\calendar_information $calendar, $view, $includenavigation = true, bool $skipevents = false,
3378 ?int $lookahead = null) {
a4af4c96 3379 global $PAGE, $CFG;
64ff737a
AN
3380
3381 $renderer = $PAGE->get_renderer('core_calendar');
3382 $type = \core_calendar\type_factory::get_calendar_instance();
3383
3384 // Calculate the bounds of the month.
5a11e7f5
SL
3385 $calendardate = $type->timestamp_to_date_array($calendar->time);
3386
3387 $date = new \DateTime('now', core_date::get_user_timezone_object(99));
2b815157 3388 $eventlimit = 0;
64ff737a
AN
3389
3390 if ($view === 'day') {
5a11e7f5
SL
3391 $tstart = $type->convert_to_timestamp($calendardate['year'], $calendardate['mon'], $calendardate['mday']);
3392 $date->setTimestamp($tstart);
3393 $date->modify('+1 day');
522b84be 3394 } else if ($view === 'upcoming' || $view === 'upcoming_mini') {
5a11e7f5 3395 // Number of days in the future that will be used to fetch events.
982fef46
DM
3396 if (!$lookahead) {
3397 if (isset($CFG->calendar_lookahead)) {
3398 $defaultlookahead = intval($CFG->calendar_lookahead);
3399 } else {
3400 $defaultlookahead = CALENDAR_DEFAULT_UPCOMING_LOOKAHEAD;
3401 }
3402 $lookahead = get_user_preferences('calendar_lookahead', $defaultlookahead);
a4af4c96 3403 }
5a11e7f5
SL
3404
3405 // Maximum number of events to be displayed on upcoming view.
ca14f182
SL
3406 $defaultmaxevents = CALENDAR_DEFAULT_UPCOMING_MAXEVENTS;
3407 if (isset($CFG->calendar_maxevents)) {
3408 $defaultmaxevents = intval($CFG->calendar_maxevents);
3409 }
349d3796 3410 $eventlimit = get_user_preferences('calendar_maxevents', $defaultmaxevents);
5a11e7f5
SL
3411
3412 $tstart = $type->convert_to_timestamp($calendardate['year'], $calendardate['mon'], $calendardate['mday'],
3413 $calendardate['hours']);
3414 $date->setTimestamp($tstart);
3415 $date->modify('+' . $lookahead . ' days');
64ff737a 3416 } else {
5a11e7f5
SL
3417 $tstart = $type->convert_to_timestamp($calendardate['year'], $calendardate['mon'], 1);
3418 $monthdays = $type->get_num_days_in_month($calendardate['year'], $calendardate['mon']);
3419 $date->setTimestamp($tstart);
3420 $date->modify('+' . $monthdays . ' days');
3421
6038d626 3422 if ($view === 'mini' || $view === 'minithree') {
c8b6e9ab
AN
3423 $template = 'core_calendar/calendar_mini';
3424 } else {
3425 $template = 'core_calendar/calendar_month';
3426 }
64ff737a
AN
3427 }
3428
5a11e7f5
SL
3429 // We need to extract 1 second to ensure that we don't get into the next day.
3430 $date->modify('-1 second');
3431 $tend = $date->getTimestamp();
3432
0085b0ea 3433 list($userparam, $groupparam, $courseparam, $categoryparam) = array_map(function($param) {
64ff737a
AN
3434 // If parameter is true, return null.
3435 if ($param === true) {
3436 return null;
3437 }
3438
3439 // If parameter is false, return an empty array.
3440 if ($param === false) {
3441 return [];
3442 }
3443
3444 // If the parameter is a scalar value, enclose it in an array.
3445 if (!is_array($param)) {
3446 return [$param];
3447 }
3448
3449 // No normalisation required.
3450 return $param;
0085b0ea 3451 }, [$calendar->users, $calendar->groups, $calendar->courses, $calendar->categories]);
64ff737a 3452
7884ecf2
RW
3453 if ($skipevents) {
3454 $events = [];
3455 } else {
3456 $events = \core_calendar\local\api::get_events(
3457 $tstart,
3458 $tend,
3459 null,
3460 null,
3461 null,
3462 null,
3463 $eventlimit,
3464 null,
3465 $userparam,
3466 $groupparam,
3467 $courseparam,
3468 $categoryparam,
3469 true,
3470 true,
3471 function ($event) {
3472 if ($proxy = $event->get_course_module()) {
3473 $cminfo = $proxy->get_proxied_instance();
3474 return $cminfo->uservisible;
3475 }
93623513 3476
7884ecf2
RW
3477 if ($proxy = $event->get_category()) {
3478 $category = $proxy->get_proxied_instance();
64ff737a 3479
7884ecf2
RW
3480 return $category->is_uservisible();
3481 }
64ff737a 3482
7884ecf2
RW
3483 return true;
3484 }
3485 );
3486 }
64ff737a
AN
3487
3488 $related = [
3489 'events' => $events,
3490 'cache' => new \core_calendar\external\events_related_objects_cache($events),
146d3713 3491 'type' => $type,
64ff737a
AN
3492 ];
3493
146d3713 3494 $data = [];
c6022207 3495 if ($view == "month" || $view == "mini" || $view == "minithree") {
146d3713 3496 $month = new \core_calendar\external\month_exporter($calendar, $type, $related);
c6022207 3497 $month->set_includenavigation($includenavigation);
7884ecf2 3498 $month->set_initialeventsloaded(!$skipevents);
60908b21 3499 $month->set_showcoursefilter($view == "month");
146d3713 3500 $data = $month->export($renderer);
dbccdae8 3501 $data->viewingmonth = true;
146d3713 3502 } else if ($view == "day") {
3ea4f446 3503 $day = new \core_calendar\external\calendar_day_exporter($calendar, $related);
146d3713 3504 $data = $day->export($renderer);
dbccdae8 3505 $data->viewingday = true;
3ea4f446 3506 $template = 'core_calendar/calendar_day';
522b84be 3507 } else if ($view == "upcoming" || $view == "upcoming_mini") {
2ca4dc8a
SL
3508 $upcoming = new \core_calendar\external\calendar_upcoming_exporter($calendar, $related);
3509 $data = $upcoming->export($renderer);
522b84be
SL
3510
3511 if ($view == "upcoming") {
3512 $template = 'core_calendar/calendar_upcoming';
dbccdae8 3513 $data->viewingupcoming = true;
522b84be 3514 } else if ($view == "upcoming_mini") {
e3491a09 3515 $template = 'core_calendar/calendar_upcoming_mini';
522b84be 3516 }
146d3713 3517 }
64ff737a
AN
3518
3519 return [$data, $template];
3520}
3521
705eea84
SL
3522/**
3523 * Request and render event form fragment.
3524 *
3525 * @param array $args The fragment arguments.
3526 * @return string The rendered mform fragment.
3527 */
aa091225 3528function calendar_output_fragment_event_form($args) {
ea5f7707 3529 global $CFG, $OUTPUT, $USER;
dfc609e5 3530 require_once($CFG->libdir . '/grouplib.php');
aa091225 3531 $html = '';
ea5f7707 3532 $data = [];
aa091225 3533 $eventid = isset($args['eventid']) ? clean_param($args['eventid'], PARAM_INT) : null;
f6e8cc83 3534 $starttime = isset($args['starttime']) ? clean_param($args['starttime'], PARAM_INT) : null;
dfc609e5 3535 $courseid = (isset($args['courseid']) && $args['courseid'] != SITEID) ? clean_param($args['courseid'], PARAM_INT) : null;
d097bfdd 3536 $categoryid = isset($args['categoryid']) ? clean_param($args['categoryid'], PARAM_INT) : null;
aa091225
RW
3537 $event = null;
3538 $hasformdata = isset($args['formdata']) && !empty($args['formdata']);
ea5f7707
RW
3539 $context = \context_user::instance($USER->id);
3540 $editoroptions = \core_calendar\local\event\forms\create::build_editor_options($context);
dfc609e5 3541 $formoptions = ['editoroptions' => $editoroptions, 'courseid' => $courseid];
ea5f7707 3542 $draftitemid = 0;
aa091225
RW
3543
3544 if ($hasformdata) {
3545 parse_str(clean_param($args['formdata'], PARAM_TEXT), $data);
ea5f7707
RW
3546 if (isset($data['description']['itemid'])) {
3547 $draftitemid = $data['description']['itemid'];
3548 }
aa091225
RW
3549 }
3550
f6e8cc83
RW
3551 if ($starttime) {
3552 $formoptions['starttime'] = $starttime;
3553 }
4d985669
SL
3554 // Let's check first which event types user can add.
3555 $eventtypes = calendar_get_allowed_event_types($courseid);
3556 $formoptions['eventtypes'] = $eventtypes;
f6e8cc83 3557
aa091225 3558 if (is_null($eventid)) {
dfc609e5
SL
3559 if (!empty($courseid)) {
3560 $groupcoursedata = groups_get_course_data($courseid);
3561 $formoptions['groups'] = [];
3562 foreach ($groupcoursedata->groups as $groupid => $groupdata) {
3563 $formoptions['groups'][$groupid] = $groupdata->name;
3564 }
3565 }
bcd0583e 3566
aa091225
RW
3567 $mform = new \core_calendar\local\event\forms\create(
3568 null,
3569 $formoptions,
3570 'post',
3571 '',
3572 null,
3573 true,
3574 $data
3575 );
05187c58 3576
05187c58 3577 // If the user is on course context and is allowed to add course events set the event type default to course.
419b868a 3578 if (!empty($courseid) && !empty($eventtypes['course'])) {
29158c8b
SL
3579 $data['eventtype'] = 'course';
3580 $data['courseid'] = $courseid;
3581 $data['groupcourseid'] = $courseid;
dfc609e5 3582 } else if (!empty($categoryid) && !empty($eventtypes['category'])) {
d097bfdd
AN
3583 $data['eventtype'] = 'category';
3584 $data['categoryid'] = $categoryid;
dfc609e5
SL
3585 } else if (!empty($groupcoursedata) && !empty($eventtypes['group'])) {
3586 $data['groupcourseid'] = $courseid;
3587 $data['groups'] = $groupcoursedata->groups;
29158c8b
SL
3588 }
3589 $mform->set_data($data);
aa091225
RW
3590 } else {
3591 $event = calendar_event::load($eventid);
c51a1577
SR
3592
3593 if (!calendar_edit_event_allowed($event)) {
3594 print_error('nopermissiontoupdatecalendar');
3595 }
3596
ea5f7707
RW
3597 $mapper = new \core_calendar\local\event\mappers\create_update_form_mapper();
3598 $eventdata = $mapper->from_legacy_event_to_data($event);
3599 $data = array_merge((array) $eventdata, $data);
aa091225
RW
3600 $event->count_repeats();
3601 $formoptions['event'] = $event;
dfc609e5
SL
3602
3603 if (!empty($event->courseid)) {
3604 $groupcoursedata = groups_get_course_data($event->courseid);
3605 $formoptions['groups'] = [];
3606 foreach ($groupcoursedata->groups as $groupid => $groupdata) {
3607 $formoptions['groups'][$groupid] = $groupdata->name;
3608 }
3609 }
3610
ea5f7707
RW
3611 $data['description']['text'] = file_prepare_draft_area(
3612 $draftitemid,
3613 $event->context->id,
3614 'calendar',
3615 'event_description',
3616 $event->id,
3617 null,
3618 $data['description']['text']
3619 );
3620 $data['description']['itemid'] = $draftitemid;
3621
aa091225
RW
3622 $mform = new \core_calendar\local\event\forms\update(
3623 null,
3624 $formoptions,
3625 'post',
3626 '',
3627 null,
3628 true,
3629 $data
3630 );
aa091225
RW
3631 $mform->set_data($data);
3632