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