Merge branch 'MDL-41792_master' of https://github.com/markn86/moodle
[moodle.git] / calendar / lib.php
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/>.
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  */
26 if (!defined('MOODLE_INTERNAL')) {
27     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
28 }
30 /**
31  *  These are read by the administration component to provide default values
32  */
34 /**
35  * CALENDAR_DEFAULT_UPCOMING_LOOKAHEAD - default value of upcoming event preference
36  */
37 define('CALENDAR_DEFAULT_UPCOMING_LOOKAHEAD', 21);
39 /**
40  * CALENDAR_DEFAULT_UPCOMING_MAXEVENTS - default value to display the maximum number of upcoming event
41  */
42 define('CALENDAR_DEFAULT_UPCOMING_MAXEVENTS', 10);
44 /**
45  * CALENDAR_DEFAULT_STARTING_WEEKDAY - default value to display the starting weekday
46  */
47 define('CALENDAR_DEFAULT_STARTING_WEEKDAY', 1);
49 // This is a packed bitfield: day X is "weekend" if $field & (1 << X) is true
50 // Default value = 65 = 64 + 1 = 2^6 + 2^0 = Saturday & Sunday
52 /**
53  * CALENDAR_DEFAULT_WEEKEND - default value for weekend (Saturday & Sunday)
54  */
55 define('CALENDAR_DEFAULT_WEEKEND', 65);
57 /**
58  * CALENDAR_URL - path to calendar's folder
59  */
60 define('CALENDAR_URL', $CFG->wwwroot.'/calendar/');
62 /**
63  * CALENDAR_TF_24 - Calendar time in 24 hours format
64  */
65 define('CALENDAR_TF_24', '%H:%M');
67 /**
68  * CALENDAR_TF_12 - Calendar time in 12 hours format
69  */
70 define('CALENDAR_TF_12', '%I:%M %p');
72 /**
73  * CALENDAR_EVENT_GLOBAL - Global calendar event types
74  */
75 define('CALENDAR_EVENT_GLOBAL', 1);
77 /**
78  * CALENDAR_EVENT_COURSE - Course calendar event types
79  */
80 define('CALENDAR_EVENT_COURSE', 2);
82 /**
83  * CALENDAR_EVENT_GROUP - group calendar event types
84  */
85 define('CALENDAR_EVENT_GROUP', 4);
87 /**
88  * CALENDAR_EVENT_USER - user calendar event types
89  */
90 define('CALENDAR_EVENT_USER', 8);
93 /**
94  * CALENDAR_IMPORT_FROM_FILE - import the calendar from a file
95  */
96 define('CALENDAR_IMPORT_FROM_FILE', 0);
98 /**
99  * CALENDAR_IMPORT_FROM_URL - import the calendar from a URL
100  */
101 define('CALENDAR_IMPORT_FROM_URL',  1);
103 /**
104  * CALENDAR_IMPORT_EVENT_UPDATED - imported event was updated
105  */
106 define('CALENDAR_IMPORT_EVENT_UPDATED',  1);
108 /**
109  * CALENDAR_IMPORT_EVENT_INSERTED - imported event was added by insert
110  */
111 define('CALENDAR_IMPORT_EVENT_INSERTED', 2);
113 /**
114  * CALENDAR_SUBSCRIPTION_UPDATE - Used to represent update action for subscriptions in various forms.
115  */
116 define('CALENDAR_SUBSCRIPTION_UPDATE', 1);
118 /**
119  * CALENDAR_SUBSCRIPTION_REMOVE - Used to represent remove action for subscriptions in various forms.
120  */
121 define('CALENDAR_SUBSCRIPTION_REMOVE', 2);
123 /**
124  * Return the days of the week
125  *
126  * @return array array of days
127  */
128 function calendar_get_days() {
129     $calendartype = \core_calendar\type_factory::get_calendar_instance();
130     return $calendartype->get_weekdays();
133 /**
134  * Get the subscription from a given id
135  *
136  * @since Moodle 2.5
137  * @param int $id id of the subscription
138  * @return stdClass Subscription record from DB
139  * @throws moodle_exception for an invalid id
140  */
141 function calendar_get_subscription($id) {
142     global $DB;
144     $cache = cache::make('core', 'calendar_subscriptions');
145     $subscription = $cache->get($id);
146     if (empty($subscription)) {
147         $subscription = $DB->get_record('event_subscriptions', array('id' => $id), '*', MUST_EXIST);
148         // cache the data.
149         $cache->set($id, $subscription);
150     }
151     return $subscription;
154 /**
155  * Gets the first day of the week
156  *
157  * Used to be define('CALENDAR_STARTING_WEEKDAY', blah);
158  *
159  * @return int
160  */
161 function calendar_get_starting_weekday() {
162     $calendartype = \core_calendar\type_factory::get_calendar_instance();
163     return $calendartype->get_starting_weekday();
166 /**
167  * Generates the HTML for a miniature calendar
168  *
169  * @param array $courses list of course to list events from
170  * @param array $groups list of group
171  * @param array $users user's info
172  * @param int|bool $calmonth calendar month in numeric, default is set to false
173  * @param int|bool $calyear calendar month in numeric, default is set to false
174  * @param string|bool $placement the place/page the calendar is set to appear - passed on the the controls function
175  * @param int|bool $courseid id of the course the calendar is displayed on - passed on the the controls function
176  * @param int $time the unixtimestamp representing the date we want to view, this is used instead of $calmonth
177  *     and $calyear to support multiple calendars
178  * @return string $content return html table for mini calendar
179  */
180 function calendar_get_mini($courses, $groups, $users, $calmonth = false, $calyear = false, $placement = false,
181     $courseid = false, $time = 0) {
182     global $CFG, $OUTPUT;
184     // Get the calendar type we are using.
185     $calendartype = \core_calendar\type_factory::get_calendar_instance();
187     $display = new stdClass;
189     // Assume we are not displaying this month for now.
190     $display->thismonth = false;
192     $content = '';
194     // Do this check for backwards compatibility. The core should be passing a timestamp rather than month and year.
195     // If a month and year are passed they will be in Gregorian.
196     if (!empty($calmonth) && !empty($calyear)) {
197         // Ensure it is a valid date, else we will just set it to the current timestamp.
198         if (checkdate($calmonth, 1, $calyear)) {
199             $time = make_timestamp($calyear, $calmonth, 1);
200         } else {
201             $time = time();
202         }
203         $date = usergetdate($time);
204         if ($calmonth == $date['mon'] && $calyear == $date['year']) {
205             $display->thismonth = true;
206         }
207         // We can overwrite date now with the date used by the calendar type, if it is not Gregorian, otherwise
208         // there is no need as it is already in Gregorian.
209         if ($calendartype->get_name() != 'gregorian') {
210             $date = $calendartype->timestamp_to_date_array($time);
211         }
212     } else if (!empty($time)) {
213         // Get the specified date in the calendar type being used.
214         $date = $calendartype->timestamp_to_date_array($time);
215         $thisdate = $calendartype->timestamp_to_date_array(time());
216         if ($date['month'] == $thisdate['month'] && $date['year'] == $thisdate['year']) {
217             $display->thismonth = true;
218             // If we are the current month we want to set the date to the current date, not the start of the month.
219             $date = $thisdate;
220         }
221     } else {
222         // Get the current date in the calendar type being used.
223         $time = time();
224         $date = $calendartype->timestamp_to_date_array($time);
225         $display->thismonth = true;
226     }
228     list($d, $m, $y) = array($date['mday'], $date['mon'], $date['year']); // This is what we want to display.
230     // Get Gregorian date.
231     $gregoriandate = $calendartype->convert_to_gregorian($date['year'], $date['mon'], 1);
233     // Store the gregorian year and month to be used later.
234     list($gy, $gm, $gd, $gh, $gmin) = array($gregoriandate['year'], $gregoriandate['month'], $gregoriandate['day'],
235         $gregoriandate['hour'], $gregoriandate['minute']);
237     // Get the max number of days in this month for this calendar type.
238     $display->maxdays = calendar_days_in_month($m, $y);
239     // Get the starting week day for this month.
240     $startwday = dayofweek(1, $m, $y);
241     // Get the days in a week.
242     $daynames = calendar_get_days();
243     // Store the number of days in a week.
244     $numberofdaysinweek = $calendartype->get_num_weekdays();
246     // Set the min and max weekday.
247     $display->minwday = calendar_get_starting_weekday();
248     $display->maxwday = $display->minwday + ($numberofdaysinweek - 1);
250     // These are used for DB queries, so we want unixtime, so we need to use Gregorian dates.
251     $display->tstart = make_timestamp($gy, $gm, $gd, $gh, $gmin, 0);
252     $display->tend = make_timestamp($gy, $gm, $display->maxdays, 23, 59, 59);
254     // Align the starting weekday to fall in our display range
255     // This is simple, not foolproof.
256     if ($startwday < $display->minwday) {
257         $startwday += $numberofdaysinweek;
258     }
260     // Get the events matching our criteria. Don't forget to offset the timestamps for the user's TZ!
261     $events = calendar_get_events($display->tstart, $display->tend, $users, $groups, $courses);
263     // Set event course class for course events
264     if (!empty($events)) {
265         foreach ($events as $eventid => $event) {
266             if (!empty($event->modulename)) {
267                 $cm = get_coursemodule_from_instance($event->modulename, $event->instance);
268                 if (!groups_course_module_visible($cm)) {
269                     unset($events[$eventid]);
270                 }
271             }
272         }
273     }
275     // This is either a genius idea or an idiot idea: in order to not complicate things, we use this rule: if, after
276     // possibly removing SITEID from $courses, there is only one course left, then clicking on a day in the month
277     // will also set the $SESSION->cal_courses_shown variable to that one course. Otherwise, we 'd need to add extra
278     // arguments to this function.
279     $hrefparams = array();
280     if(!empty($courses)) {
281         $courses = array_diff($courses, array(SITEID));
282         if(count($courses) == 1) {
283             $hrefparams['course'] = reset($courses);
284         }
285     }
287     // We want to have easy access by day, since the display is on a per-day basis.
288     calendar_events_by_day($events, $m, $y, $eventsbyday, $durationbyday, $typesbyday, $courses);
290     // Accessibility: added summary and <abbr> elements.
291     $summary = get_string('calendarheading', 'calendar', userdate($display->tstart, get_string('strftimemonthyear')));
292     $content .= '<table class="minicalendar calendartable" summary="'.$summary.'">'; // Begin table.
293     if (($placement !== false) && ($courseid !== false)) {
294         $content .= '<caption>'. calendar_top_controls($placement, array('id' => $courseid, 'time' => $time)) .'</caption>';
295     }
296     $content .= '<tr class="weekdays">'; // Header row: day names
298     // Print out the names of the weekdays.
299     for ($i = $display->minwday; $i <= $display->maxwday; ++$i) {
300         $pos = $i % $numberofdaysinweek;
301         $content .= '<th scope="col"><abbr title="'. $daynames[$pos]['fullname'] .'">'.
302             $daynames[$pos]['shortname'] ."</abbr></th>\n";
303     }
305     $content .= '</tr><tr>'; // End of day names; prepare for day numbers
307     // For the table display. $week is the row; $dayweek is the column.
308     $dayweek = $startwday;
310     // Paddding (the first week may have blank days in the beginning)
311     for($i = $display->minwday; $i < $startwday; ++$i) {
312         $content .= '<td class="dayblank">&nbsp;</td>'."\n";
313     }
315     $weekend = CALENDAR_DEFAULT_WEEKEND;
316     if (isset($CFG->calendar_weekend)) {
317         $weekend = intval($CFG->calendar_weekend);
318     }
320     // Now display all the calendar
321     $daytime = $display->tstart - DAYSECS;
322     for($day = 1; $day <= $display->maxdays; ++$day, ++$dayweek) {
323         $daytime += DAYSECS;
324         if($dayweek > $display->maxwday) {
325             // We need to change week (table row)
326             $content .= '</tr><tr>';
327             $dayweek = $display->minwday;
328         }
330         // Reset vars.
331         if ($weekend & (1 << ($dayweek % $numberofdaysinweek))) {
332             // Weekend. This is true no matter what the exact range is.
333             $class = 'weekend day';
334         } else {
335             // Normal working day.
336             $class = 'day';
337         }
339         // Special visual fx if an event is defined
340         if(isset($eventsbyday[$day])) {
342             $class .= ' hasevent';
343             $hrefparams['view'] = 'day';
344             $dayhref = calendar_get_link_href(new moodle_url(CALENDAR_URL . 'view.php', $hrefparams), 0, 0, 0, $daytime);
346             $popupcontent = '';
347             foreach($eventsbyday[$day] as $eventid) {
348                 if (!isset($events[$eventid])) {
349                     continue;
350                 }
351                 $event = new calendar_event($events[$eventid]);
352                 $popupalt  = '';
353                 $component = 'moodle';
354                 if (!empty($event->modulename)) {
355                     $popupicon = 'icon';
356                     $popupalt  = $event->modulename;
357                     $component = $event->modulename;
358                 } else if ($event->courseid == SITEID) { // Site event.
359                     $popupicon = 'i/siteevent';
360                 } else if ($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) { // Course event.
361                     $popupicon = 'i/courseevent';
362                 } else if ($event->groupid) { // Group event.
363                     $popupicon = 'i/groupevent';
364                 } else { // Must be a user event.
365                     $popupicon = 'i/userevent';
366                 }
368                 $dayhref->set_anchor('event_'.$event->id);
370                 $popupcontent .= html_writer::start_tag('div');
371                 $popupcontent .= $OUTPUT->pix_icon($popupicon, $popupalt, $component);
372                 $name = format_string($event->name, true);
373                 // Show ical source if needed.
374                 if (!empty($event->subscription) && $CFG->calendar_showicalsource) {
375                     $a = new stdClass();
376                     $a->name = $name;
377                     $a->source = $event->subscription->name;
378                     $name = get_string('namewithsource', 'calendar', $a);
379                 }
380                 $popupcontent .= html_writer::link($dayhref, $name);
381                 $popupcontent .= html_writer::end_tag('div');
382             }
384             //Accessibility: functionality moved to calendar_get_popup.
385             if($display->thismonth && $day == $d) {
386                 $popupid = calendar_get_popup(true, $events[$eventid]->timestart, $popupcontent);
387             } else {
388                 $popupid = calendar_get_popup(false, $events[$eventid]->timestart, $popupcontent);
389             }
391             // Class and cell content
392             if(isset($typesbyday[$day]['startglobal'])) {
393                 $class .= ' calendar_event_global';
394             } else if(isset($typesbyday[$day]['startcourse'])) {
395                 $class .= ' calendar_event_course';
396             } else if(isset($typesbyday[$day]['startgroup'])) {
397                 $class .= ' calendar_event_group';
398             } else if(isset($typesbyday[$day]['startuser'])) {
399                 $class .= ' calendar_event_user';
400             }
401             $cell = html_writer::link($dayhref, $day, array('aria-controls' => $popupid.'_panel', 'id' => $popupid));
402         } else {
403             $cell = $day;
404         }
406         $durationclass = false;
407         if (isset($typesbyday[$day]['durationglobal'])) {
408             $durationclass = ' duration_global';
409         } else if(isset($typesbyday[$day]['durationcourse'])) {
410             $durationclass = ' duration_course';
411         } else if(isset($typesbyday[$day]['durationgroup'])) {
412             $durationclass = ' duration_group';
413         } else if(isset($typesbyday[$day]['durationuser'])) {
414             $durationclass = ' duration_user';
415         }
416         if ($durationclass) {
417             $class .= ' duration '.$durationclass;
418         }
420         // If event has a class set then add it to the table day <td> tag
421         // Note: only one colour for minicalendar
422         if(isset($eventsbyday[$day])) {
423             foreach($eventsbyday[$day] as $eventid) {
424                 if (!isset($events[$eventid])) {
425                     continue;
426                 }
427                 $event = $events[$eventid];
428                 if (!empty($event->class)) {
429                     $class .= ' '.$event->class;
430                 }
431                 break;
432             }
433         }
435         // Special visual fx for today
436         //Accessibility: hidden text for today, and popup.
437         if($display->thismonth && $day == $d) {
438             $class .= ' today';
439             $today = get_string('today', 'calendar').' '.userdate(time(), get_string('strftimedayshort'));
441             if(! isset($eventsbyday[$day])) {
442                 $class .= ' eventnone';
443                 $popupid = calendar_get_popup(true, false);
444                 $cell = html_writer::link('#', $day, array('aria-controls' => $popupid.'_panel', 'id' => $popupid));
445             }
446             $cell = get_accesshide($today.' ').$cell;
447         }
449         // Just display it
450         if(!empty($class)) {
451             $class = ' class="'.$class.'"';
452         }
453         $content .= '<td'.$class.'>'.$cell."</td>\n";
454     }
456     // Paddding (the last week may have blank days at the end)
457     for($i = $dayweek; $i <= $display->maxwday; ++$i) {
458         $content .= '<td class="dayblank">&nbsp;</td>';
459     }
460     $content .= '</tr>'; // Last row ends
462     $content .= '</table>'; // Tabular display of days ends
464     return $content;
467 /**
468  * Gets the calendar popup
469  *
470  * It called at multiple points in from calendar_get_mini.
471  * Copied and modified from calendar_get_mini.
472  *
473  * @param bool $is_today false except when called on the current day.
474  * @param mixed $event_timestart $events[$eventid]->timestart, OR false if there are no events.
475  * @param string $popupcontent content for the popup window/layout.
476  * @return string eventid for the calendar_tooltip popup window/layout.
477  */
478 function calendar_get_popup($is_today, $event_timestart, $popupcontent='') {
479     global $PAGE;
480     static $popupcount;
481     if ($popupcount === null) {
482         $popupcount = 1;
483     }
484     $popupcaption = '';
485     if($is_today) {
486         $popupcaption = get_string('today', 'calendar').' ';
487     }
488     if (false === $event_timestart) {
489         $popupcaption .= userdate(time(), get_string('strftimedayshort'));
490         $popupcontent = get_string('eventnone', 'calendar');
492     } else {
493         $popupcaption .= get_string('eventsfor', 'calendar', userdate($event_timestart, get_string('strftimedayshort')));
494     }
495     $id = 'calendar_tooltip_'.$popupcount;
496     $PAGE->requires->yui_module('moodle-calendar-eventmanager', 'M.core_calendar.add_event', array(array('eventId'=>$id,'title'=>$popupcaption, 'content'=>$popupcontent)));
498     $popupcount++;
499     return $id;
502 /**
503  * Gets the calendar upcoming event
504  *
505  * @param array $courses array of courses
506  * @param array|int|bool $groups array of groups, group id or boolean for all/no group events
507  * @param array|int|bool $users array of users, user id or boolean for all/no user events
508  * @param int $daysinfuture number of days in the future we 'll look
509  * @param int $maxevents maximum number of events
510  * @param int $fromtime start time
511  * @return array $output array of upcoming events
512  */
513 function calendar_get_upcoming($courses, $groups, $users, $daysinfuture, $maxevents, $fromtime=0) {
514     global $CFG, $COURSE, $DB;
516     $display = new stdClass;
517     $display->range = $daysinfuture; // How many days in the future we 'll look
518     $display->maxevents = $maxevents;
520     $output = array();
522     // Prepare "course caching", since it may save us a lot of queries
523     $coursecache = array();
525     $processed = 0;
526     $now = time(); // We 'll need this later
527     $usermidnighttoday = usergetmidnight($now);
529     if ($fromtime) {
530         $display->tstart = $fromtime;
531     } else {
532         $display->tstart = $usermidnighttoday;
533     }
535     // This works correctly with respect to the user's DST, but it is accurate
536     // only because $fromtime is always the exact midnight of some day!
537     $display->tend = usergetmidnight($display->tstart + DAYSECS * $display->range + 3 * HOURSECS) - 1;
539     // Get the events matching our criteria
540     $events = calendar_get_events($display->tstart, $display->tend, $users, $groups, $courses);
542     // This is either a genius idea or an idiot idea: in order to not complicate things, we use this rule: if, after
543     // possibly removing SITEID from $courses, there is only one course left, then clicking on a day in the month
544     // will also set the $SESSION->cal_courses_shown variable to that one course. Otherwise, we 'd need to add extra
545     // arguments to this function.
547     $hrefparams = array();
548     if(!empty($courses)) {
549         $courses = array_diff($courses, array(SITEID));
550         if(count($courses) == 1) {
551             $hrefparams['course'] = reset($courses);
552         }
553     }
555     if ($events !== false) {
557         $modinfo = get_fast_modinfo($COURSE);
559         foreach($events as $event) {
562             if (!empty($event->modulename)) {
563                 if ($event->courseid == $COURSE->id) {
564                     if (isset($modinfo->instances[$event->modulename][$event->instance])) {
565                         $cm = $modinfo->instances[$event->modulename][$event->instance];
566                         if (!$cm->uservisible) {
567                             continue;
568                         }
569                     }
570                 } else {
571                     if (!$cm = get_coursemodule_from_instance($event->modulename, $event->instance)) {
572                         continue;
573                     }
574                     if (!coursemodule_visible_for_user($cm)) {
575                         continue;
576                     }
577                 }
578                 if ($event->modulename == 'assignment'){
579                     // create calendar_event to test edit_event capability
580                     // this new event will also prevent double creation of calendar_event object
581                     $checkevent = new calendar_event($event);
582                     // TODO: rewrite this hack somehow
583                     if (!calendar_edit_event_allowed($checkevent)){ // cannot manage entries, eg. student
584                         if (!$assignment = $DB->get_record('assignment', array('id'=>$event->instance))) {
585                             // print_error("invalidid", 'assignment');
586                             continue;
587                         }
588                         // assign assignment to assignment object to use hidden_is_hidden method
589                         require_once($CFG->dirroot.'/mod/assignment/lib.php');
591                         if (!file_exists($CFG->dirroot.'/mod/assignment/type/'.$assignment->assignmenttype.'/assignment.class.php')) {
592                             continue;
593                         }
594                         require_once ($CFG->dirroot.'/mod/assignment/type/'.$assignment->assignmenttype.'/assignment.class.php');
596                         $assignmentclass = 'assignment_'.$assignment->assignmenttype;
597                         $assignmentinstance = new $assignmentclass($cm->id, $assignment, $cm);
599                         if ($assignmentinstance->description_is_hidden()){//force not to show description before availability
600                             $event->description = get_string('notavailableyet', 'assignment');
601                         }
602                     }
603                 }
604             }
606             if ($processed >= $display->maxevents) {
607                 break;
608             }
610             $event->time = calendar_format_event_time($event, $now, $hrefparams);
611             $output[] = $event;
612             ++$processed;
613         }
614     }
615     return $output;
619 /**
620  * Get a HTML link to a course.
621  *
622  * @param int $courseid the course id
623  * @return string a link to the course (as HTML); empty if the course id is invalid
624  */
625 function calendar_get_courselink($courseid) {
627     if (!$courseid) {
628         return '';
629     }
631     calendar_get_course_cached($coursecache, $courseid);
632     $context = context_course::instance($courseid);
633     $fullname = format_string($coursecache[$courseid]->fullname, true, array('context' => $context));
634     $url = new moodle_url('/course/view.php', array('id' => $courseid));
635     $link = html_writer::link($url, $fullname);
637     return $link;
641 /**
642  * Add calendar event metadata
643  *
644  * @param stdClass $event event info
645  * @return stdClass $event metadata
646  */
647 function calendar_add_event_metadata($event) {
648     global $CFG, $OUTPUT;
650     //Support multilang in event->name
651     $event->name = format_string($event->name,true);
653     if(!empty($event->modulename)) {                                // Activity event
654         // The module name is set. I will assume that it has to be displayed, and
655         // also that it is an automatically-generated event. And of course that the
656         // fields for get_coursemodule_from_instance are set correctly.
657         $module = calendar_get_module_cached($coursecache, $event->modulename, $event->instance);
659         if ($module === false) {
660             return;
661         }
663         $modulename = get_string('modulename', $event->modulename);
664         if (get_string_manager()->string_exists($event->eventtype, $event->modulename)) {
665             // will be used as alt text if the event icon
666             $eventtype = get_string($event->eventtype, $event->modulename);
667         } else {
668             $eventtype = '';
669         }
670         $icon = $OUTPUT->pix_url('icon', $event->modulename) . '';
672         $event->icon = '<img src="'.$icon.'" alt="'.$eventtype.'" title="'.$modulename.'" class="icon" />';
673         $event->referer = '<a href="'.$CFG->wwwroot.'/mod/'.$event->modulename.'/view.php?id='.$module->id.'">'.$event->name.'</a>';
674         $event->courselink = calendar_get_courselink($module->course);
675         $event->cmid = $module->id;
677     } else if($event->courseid == SITEID) {                              // Site event
678         $event->icon = '<img src="'.$OUTPUT->pix_url('i/siteevent') . '" alt="'.get_string('globalevent', 'calendar').'" class="icon" />';
679         $event->cssclass = 'calendar_event_global';
680     } else if($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) {          // Course event
681         $event->icon = '<img src="'.$OUTPUT->pix_url('i/courseevent') . '" alt="'.get_string('courseevent', 'calendar').'" class="icon" />';
682         $event->courselink = calendar_get_courselink($event->courseid);
683         $event->cssclass = 'calendar_event_course';
684     } else if ($event->groupid) {                                    // Group event
685         $event->icon = '<img src="'.$OUTPUT->pix_url('i/groupevent') . '" alt="'.get_string('groupevent', 'calendar').'" class="icon" />';
686         $event->courselink = calendar_get_courselink($event->courseid);
687         $event->cssclass = 'calendar_event_group';
688     } else if($event->userid) {                                      // User event
689         $event->icon = '<img src="'.$OUTPUT->pix_url('i/userevent') . '" alt="'.get_string('userevent', 'calendar').'" class="icon" />';
690         $event->cssclass = 'calendar_event_user';
691     }
692     return $event;
695 /**
696  * Get calendar events
697  *
698  * @param int $tstart Start time of time range for events
699  * @param int $tend End time of time range for events
700  * @param array|int|boolean $users array of users, user id or boolean for all/no user events
701  * @param array|int|boolean $groups array of groups, group id or boolean for all/no group events
702  * @param array|int|boolean $courses array of courses, course id or boolean for all/no course events
703  * @param boolean $withduration whether only events starting within time range selected
704  *                              or events in progress/already started selected as well
705  * @param boolean $ignorehidden whether to select only visible events or all events
706  * @return array $events of selected events or an empty array if there aren't any (or there was an error)
707  */
708 function calendar_get_events($tstart, $tend, $users, $groups, $courses, $withduration=true, $ignorehidden=true) {
709     global $DB;
711     $whereclause = '';
712     // Quick test
713     if(is_bool($users) && is_bool($groups) && is_bool($courses)) {
714         return array();
715     }
717     if(is_array($users) && !empty($users)) {
718         // Events from a number of users
719         if(!empty($whereclause)) $whereclause .= ' OR';
720         $whereclause .= ' (userid IN ('.implode(',', $users).') AND courseid = 0 AND groupid = 0)';
721     } else if(is_numeric($users)) {
722         // Events from one user
723         if(!empty($whereclause)) $whereclause .= ' OR';
724         $whereclause .= ' (userid = '.$users.' AND courseid = 0 AND groupid = 0)';
725     } else if($users === true) {
726         // Events from ALL users
727         if(!empty($whereclause)) $whereclause .= ' OR';
728         $whereclause .= ' (userid != 0 AND courseid = 0 AND groupid = 0)';
729     } else if($users === false) {
730         // No user at all, do nothing
731     }
733     if(is_array($groups) && !empty($groups)) {
734         // Events from a number of groups
735         if(!empty($whereclause)) $whereclause .= ' OR';
736         $whereclause .= ' groupid IN ('.implode(',', $groups).')';
737     } else if(is_numeric($groups)) {
738         // Events from one group
739         if(!empty($whereclause)) $whereclause .= ' OR ';
740         $whereclause .= ' groupid = '.$groups;
741     } else if($groups === true) {
742         // Events from ALL groups
743         if(!empty($whereclause)) $whereclause .= ' OR ';
744         $whereclause .= ' groupid != 0';
745     }
746     // boolean false (no groups at all): we don't need to do anything
748     if(is_array($courses) && !empty($courses)) {
749         if(!empty($whereclause)) {
750             $whereclause .= ' OR';
751         }
752         $whereclause .= ' (groupid = 0 AND courseid IN ('.implode(',', $courses).'))';
753     } else if(is_numeric($courses)) {
754         // One course
755         if(!empty($whereclause)) $whereclause .= ' OR';
756         $whereclause .= ' (groupid = 0 AND courseid = '.$courses.')';
757     } else if ($courses === true) {
758         // Events from ALL courses
759         if(!empty($whereclause)) $whereclause .= ' OR';
760         $whereclause .= ' (groupid = 0 AND courseid != 0)';
761     }
763     // Security check: if, by now, we have NOTHING in $whereclause, then it means
764     // that NO event-selecting clauses were defined. Thus, we won't be returning ANY
765     // events no matter what. Allowing the code to proceed might return a completely
766     // valid query with only time constraints, thus selecting ALL events in that time frame!
767     if(empty($whereclause)) {
768         return array();
769     }
771     if($withduration) {
772         $timeclause = '(timestart >= '.$tstart.' OR timestart + timeduration > '.$tstart.') AND timestart <= '.$tend;
773     }
774     else {
775         $timeclause = 'timestart >= '.$tstart.' AND timestart <= '.$tend;
776     }
777     if(!empty($whereclause)) {
778         // We have additional constraints
779         $whereclause = $timeclause.' AND ('.$whereclause.')';
780     }
781     else {
782         // Just basic time filtering
783         $whereclause = $timeclause;
784     }
786     if ($ignorehidden) {
787         $whereclause .= ' AND visible = 1';
788     }
790     $events = $DB->get_records_select('event', $whereclause, null, 'timestart');
791     if ($events === false) {
792         $events = array();
793     }
794     return $events;
797 /** Get calendar events by id
798  *
799  * @since Moodle 2.5
800  * @param array $eventids list of event ids
801  * @return array Array of event entries, empty array if nothing found
802  */
804 function calendar_get_events_by_id($eventids) {
805     global $DB;
807     if (!is_array($eventids) || empty($eventids)) {
808         return array();
809     }
810     list($wheresql, $params) = $DB->get_in_or_equal($eventids);
811     $wheresql = "id $wheresql";
813     return $DB->get_records_select('event', $wheresql, $params);
816 /**
817  * Get control options for Calendar
818  *
819  * @param string $type of calendar
820  * @param array $data calendar information
821  * @return string $content return available control for the calender in html
822  */
823 function calendar_top_controls($type, $data) {
824     global $PAGE;
826     // Get the calendar type we are using.
827     $calendartype = \core_calendar\type_factory::get_calendar_instance();
829     $content = '';
831     // Ensure course id passed if relevant.
832     $courseid = '';
833     if (!empty($data['id'])) {
834         $courseid = '&amp;course='.$data['id'];
835     }
837     // If we are passing a month and year then we need to convert this to a timestamp to
838     // support multiple calendars. No where in core should these be passed, this logic
839     // here is for third party plugins that may use this function.
840     if (!empty($data['m']) && !empty($date['y'])) {
841         if (!isset($data['d'])) {
842             $data['d'] = 1;
843         }
844         if (!checkdate($data['m'], $data['d'], $data['y'])) {
845             $time = time();
846         } else {
847             $time = make_timestamp($data['y'], $data['m'], $data['d']);
848         }
849     } else if (!empty($data['time'])) {
850         $time = $data['time'];
851     } else {
852         $time = time();
853     }
855     // Get the date for the calendar type.
856     $date = $calendartype->timestamp_to_date_array($time);
858     $urlbase = $PAGE->url;
860     // We need to get the previous and next months in certain cases.
861     if ($type == 'frontpage' || $type == 'course' || $type == 'month') {
862         $prevmonth = calendar_sub_month($date['mon'], $date['year']);
863         $prevmonthtime = $calendartype->convert_to_gregorian($prevmonth[1], $prevmonth[0], $date['mday']);
864         $prevmonthtime = make_timestamp($prevmonthtime['year'], $prevmonthtime['month'], $prevmonthtime['day']);
866         $nextmonth = calendar_add_month($date['mon'], $date['year']);
867         $nextmonthtime = $calendartype->convert_to_gregorian($nextmonth[1], $nextmonth[0], $date['mday']);
868         $nextmonthtime = make_timestamp($nextmonthtime['year'], $nextmonthtime['month'], $nextmonthtime['day']);
869     }
871     switch ($type) {
872         case 'frontpage':
873             $prevlink = calendar_get_link_previous(get_string('monthprev', 'access'), $urlbase, false, false, false, true, $prevmonthtime);
874             $nextlink = calendar_get_link_next(get_string('monthnext', 'access'), $urlbase, false, false, false, true, $nextmonthtime);
875             $calendarlink = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', array('view' => 'month')), false, false, false, $time);
877             if (!empty($data['id'])) {
878                 $calendarlink->param('course', $data['id']);
879             }
881             if (right_to_left()) {
882                 $left = $nextlink;
883                 $right = $prevlink;
884             } else {
885                 $left = $prevlink;
886                 $right = $nextlink;
887             }
889             $content .= html_writer::start_tag('div', array('class'=>'calendar-controls'));
890             $content .= $left.'<span class="hide"> | </span>';
891             $content .= html_writer::tag('span', html_writer::link($calendarlink, userdate($time, get_string('strftimemonthyear')), array('title'=>get_string('monththis','calendar'))), array('class'=>'current'));
892             $content .= '<span class="hide"> | </span>'. $right;
893             $content .= "<span class=\"clearer\"><!-- --></span>\n";
894             $content .= html_writer::end_tag('div');
896             break;
897         case 'course':
898             $prevlink = calendar_get_link_previous(get_string('monthprev', 'access'), $urlbase, false, false, false, true, $prevmonthtime);
899             $nextlink = calendar_get_link_next(get_string('monthnext', 'access'), $urlbase, false, false, false, true, $nextmonthtime);
900             $calendarlink = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', array('view' => 'month')), false, false, false, $time);
902             if (!empty($data['id'])) {
903                 $calendarlink->param('course', $data['id']);
904             }
906             if (right_to_left()) {
907                 $left = $nextlink;
908                 $right = $prevlink;
909             } else {
910                 $left = $prevlink;
911                 $right = $nextlink;
912             }
914             $content .= html_writer::start_tag('div', array('class'=>'calendar-controls'));
915             $content .= $left.'<span class="hide"> | </span>';
916             $content .= html_writer::tag('span', html_writer::link($calendarlink, userdate($time, get_string('strftimemonthyear')), array('title'=>get_string('monththis','calendar'))), array('class'=>'current'));
917             $content .= '<span class="hide"> | </span>'. $right;
918             $content .= "<span class=\"clearer\"><!-- --></span>";
919             $content .= html_writer::end_tag('div');
920             break;
921         case 'upcoming':
922             $calendarlink = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', array('view' => 'upcoming')), false, false, false, $time);
923             if (!empty($data['id'])) {
924                 $calendarlink->param('course', $data['id']);
925             }
926             $calendarlink = html_writer::link($calendarlink, userdate($time, get_string('strftimemonthyear')));
927             $content .= html_writer::tag('div', $calendarlink, array('class'=>'centered'));
928             break;
929         case 'display':
930             $calendarlink = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', array('view' => 'month')), false, false, false, $time);
931             if (!empty($data['id'])) {
932                 $calendarlink->param('course', $data['id']);
933             }
934             $calendarlink = html_writer::link($calendarlink, userdate($time, get_string('strftimemonthyear')));
935             $content .= html_writer::tag('h3', $calendarlink);
936             break;
937         case 'month':
938             $prevlink = calendar_get_link_previous(userdate($prevmonthtime, get_string('strftimemonthyear')), 'view.php?view=month'.$courseid.'&amp;', false, false, false, false, $prevmonthtime);
939             $nextlink = calendar_get_link_next(userdate($nextmonthtime, get_string('strftimemonthyear')), 'view.php?view=month'.$courseid.'&amp;', false, false, false, false, $nextmonthtime);
941             if (right_to_left()) {
942                 $left = $nextlink;
943                 $right = $prevlink;
944             } else {
945                 $left = $prevlink;
946                 $right = $nextlink;
947             }
949             $content .= html_writer::start_tag('div', array('class'=>'calendar-controls'));
950             $content .= $left . '<span class="hide"> | </span><h1 class="current">'.userdate($time, get_string('strftimemonthyear'))."</h1>";
951             $content .= '<span class="hide"> | </span>' . $right;
952             $content .= '<span class="clearer"><!-- --></span>';
953             $content .= html_writer::end_tag('div')."\n";
954             break;
955         case 'day':
956             $days = calendar_get_days();
958             $prevtimestamp = $time - DAYSECS;
959             $nexttimestamp = $time + DAYSECS;
961             $prevdate = $calendartype->timestamp_to_date_array($prevtimestamp);
962             $nextdate = $calendartype->timestamp_to_date_array($nexttimestamp);
964             $prevname = $days[$prevdate['wday']]['fullname'];
965             $nextname = $days[$nextdate['wday']]['fullname'];
966             $prevlink = calendar_get_link_previous($prevname, 'view.php?view=day'.$courseid.'&amp;', false, false, false, false, $prevtimestamp);
967             $nextlink = calendar_get_link_next($nextname, 'view.php?view=day'.$courseid.'&amp;', false, false, false, false, $nexttimestamp);
969             if (right_to_left()) {
970                 $left = $nextlink;
971                 $right = $prevlink;
972             } else {
973                 $left = $prevlink;
974                 $right = $nextlink;
975             }
977             $content .= html_writer::start_tag('div', array('class'=>'calendar-controls'));
978             $content .= $left;
979             $content .= '<span class="hide"> | </span><span class="current">'.userdate($time, get_string('strftimedaydate')).'</span>';
980             $content .= '<span class="hide"> | </span>'. $right;
981             $content .= "<span class=\"clearer\"><!-- --></span>";
982             $content .= html_writer::end_tag('div')."\n";
984             break;
985     }
986     return $content;
989 /**
990  * Formats a filter control element.
991  *
992  * @param moodle_url $url of the filter
993  * @param int $type constant defining the type filter
994  * @return string html content of the element
995  */
996 function calendar_filter_controls_element(moodle_url $url, $type) {
997     global $OUTPUT;
998     switch ($type) {
999         case CALENDAR_EVENT_GLOBAL:
1000             $typeforhumans = 'global';
1001             $class = 'calendar_event_global';
1002             break;
1003         case CALENDAR_EVENT_COURSE:
1004             $typeforhumans = 'course';
1005             $class = 'calendar_event_course';
1006             break;
1007         case CALENDAR_EVENT_GROUP:
1008             $typeforhumans = 'groups';
1009             $class = 'calendar_event_group';
1010             break;
1011         case CALENDAR_EVENT_USER:
1012             $typeforhumans = 'user';
1013             $class = 'calendar_event_user';
1014             break;
1015     }
1016     if (calendar_show_event_type($type)) {
1017         $icon = $OUTPUT->pix_icon('t/hide', get_string('hide'));
1018         $str = get_string('hide'.$typeforhumans.'events', 'calendar');
1019     } else {
1020         $icon = $OUTPUT->pix_icon('t/show', get_string('show'));
1021         $str = get_string('show'.$typeforhumans.'events', 'calendar');
1022     }
1023     $content = html_writer::start_tag('li', array('class' => 'calendar_event'));
1024     $content .= html_writer::start_tag('a', array('href' => $url));
1025     $content .= html_writer::tag('span', $icon, array('class' => $class));
1026     $content .= html_writer::tag('span', $str, array('class' => 'eventname'));
1027     $content .= html_writer::end_tag('a');
1028     $content .= html_writer::end_tag('li');
1029     return $content;
1032 /**
1033  * Get the controls filter for calendar.
1034  *
1035  * Filter is used to hide calendar info from the display page
1036  *
1037  * @param moodle_url $returnurl return-url for filter controls
1038  * @return string $content return filter controls in html
1039  */
1040 function calendar_filter_controls(moodle_url $returnurl) {
1041     global $CFG, $USER, $OUTPUT;
1043     $groupevents = true;
1044     $id = optional_param( 'id',0,PARAM_INT );
1045     $seturl = new moodle_url('/calendar/set.php', array('return' => base64_encode($returnurl->out(false)), 'sesskey'=>sesskey()));
1046     $content = html_writer::start_tag('ul');
1048     $seturl->param('var', 'showglobal');
1049     $content .= calendar_filter_controls_element($seturl, CALENDAR_EVENT_GLOBAL);
1051     $seturl->param('var', 'showcourses');
1052     $content .= calendar_filter_controls_element($seturl, CALENDAR_EVENT_COURSE);
1054     if (isloggedin() && !isguestuser()) {
1055         if ($groupevents) {
1056             // This course MIGHT have group events defined, so show the filter
1057             $seturl->param('var', 'showgroups');
1058             $content .= calendar_filter_controls_element($seturl, CALENDAR_EVENT_GROUP);
1059         } else {
1060             // This course CANNOT have group events, so lose the filter
1061         }
1062         $seturl->param('var', 'showuser');
1063         $content .= calendar_filter_controls_element($seturl, CALENDAR_EVENT_USER);
1064     }
1065     $content .= html_writer::end_tag('ul');
1067     return $content;
1070 /**
1071  * Return the representation day
1072  *
1073  * @param int $tstamp Timestamp in GMT
1074  * @param int $now current Unix timestamp
1075  * @param bool $usecommonwords
1076  * @return string the formatted date/time
1077  */
1078 function calendar_day_representation($tstamp, $now = false, $usecommonwords = true) {
1080     static $shortformat;
1081     if(empty($shortformat)) {
1082         $shortformat = get_string('strftimedayshort');
1083     }
1085     if($now === false) {
1086         $now = time();
1087     }
1089     // To have it in one place, if a change is needed
1090     $formal = userdate($tstamp, $shortformat);
1092     $datestamp = usergetdate($tstamp);
1093     $datenow   = usergetdate($now);
1095     if($usecommonwords == false) {
1096         // We don't want words, just a date
1097         return $formal;
1098     }
1099     else if($datestamp['year'] == $datenow['year'] && $datestamp['yday'] == $datenow['yday']) {
1100         // Today
1101         return get_string('today', 'calendar');
1102     }
1103     else if(
1104         ($datestamp['year'] == $datenow['year'] && $datestamp['yday'] == $datenow['yday'] - 1 ) ||
1105         ($datestamp['year'] == $datenow['year'] - 1 && $datestamp['mday'] == 31 && $datestamp['mon'] == 12 && $datenow['yday'] == 1)
1106         ) {
1107         // Yesterday
1108         return get_string('yesterday', 'calendar');
1109     }
1110     else if(
1111         ($datestamp['year'] == $datenow['year'] && $datestamp['yday'] == $datenow['yday'] + 1 ) ||
1112         ($datestamp['year'] == $datenow['year'] + 1 && $datenow['mday'] == 31 && $datenow['mon'] == 12 && $datestamp['yday'] == 1)
1113         ) {
1114         // Tomorrow
1115         return get_string('tomorrow', 'calendar');
1116     }
1117     else {
1118         return $formal;
1119     }
1122 /**
1123  * return the formatted representation time
1124  *
1125  * @param int $time the timestamp in UTC, as obtained from the database
1126  * @return string the formatted date/time
1127  */
1128 function calendar_time_representation($time) {
1129     static $langtimeformat = NULL;
1130     if($langtimeformat === NULL) {
1131         $langtimeformat = get_string('strftimetime');
1132     }
1133     $timeformat = get_user_preferences('calendar_timeformat');
1134     if(empty($timeformat)){
1135         $timeformat = get_config(NULL,'calendar_site_timeformat');
1136     }
1137     // The ? is needed because the preference might be present, but empty
1138     return userdate($time, empty($timeformat) ? $langtimeformat : $timeformat);
1141 /**
1142  * Adds day, month, year arguments to a URL and returns a moodle_url object.
1143  *
1144  * @param string|moodle_url $linkbase
1145  * @param int $d The number of the day.
1146  * @param int $m The number of the month.
1147  * @param int $y The number of the year.
1148  * @param int $time the unixtime, used for multiple calendar support. The values $d,
1149  *     $m and $y are kept for backwards compatibility.
1150  * @return moodle_url|null $linkbase
1151  */
1152 function calendar_get_link_href($linkbase, $d, $m, $y, $time = 0) {
1153     if (empty($linkbase)) {
1154         return '';
1155     }
1156     if (!($linkbase instanceof moodle_url)) {
1157         $linkbase = new moodle_url($linkbase);
1158     }
1160     // If a day, month and year were passed then convert it to a timestamp. If these were passed
1161     // then we can assume the day, month and year are passed as Gregorian, as no where in core
1162     // should we be passing these values rather than the time.
1163     if (!empty($d) && !empty($m) && !empty($y)) {
1164         if (checkdate($m, $d, $y)) {
1165             $time = make_timestamp($y, $m, $d);
1166         } else {
1167             $time = time();
1168         }
1169     } else if (empty($time)) {
1170         $time = time();
1171     }
1173     $linkbase->param('time', $time);
1175     return $linkbase;
1178 /**
1179  * Build and return a previous month HTML link, with an arrow.
1180  *
1181  * @param string $text The text label.
1182  * @param string|moodle_url $linkbase The URL stub.
1183  * @param int $d The number of the date.
1184  * @param int $m The number of the month.
1185  * @param int $y year The number of the year.
1186  * @param bool $accesshide Default visible, or hide from all except screenreaders.
1187  * @param int $time the unixtime, used for multiple calendar support. The values $d,
1188  *     $m and $y are kept for backwards compatibility.
1189  * @return string HTML string.
1190  */
1191 function calendar_get_link_previous($text, $linkbase, $d, $m, $y, $accesshide = false, $time = 0) {
1192     $href = calendar_get_link_href(new moodle_url($linkbase), $d, $m, $y, $time);
1193     if (empty($href)) {
1194         return $text;
1195     }
1196     return link_arrow_left($text, (string)$href, $accesshide, 'previous');
1199 /**
1200  * Build and return a next month HTML link, with an arrow.
1201  *
1202  * @param string $text The text label.
1203  * @param string|moodle_url $linkbase The URL stub.
1204  * @param int $d the number of the Day
1205  * @param int $m The number of the month.
1206  * @param int $y The number of the year.
1207  * @param bool $accesshide Default visible, or hide from all except screenreaders.
1208  * @param int $time the unixtime, used for multiple calendar support. The values $d,
1209  *     $m and $y are kept for backwards compatibility.
1210  * @return string HTML string.
1211  */
1212 function calendar_get_link_next($text, $linkbase, $d, $m, $y, $accesshide = false, $time = 0) {
1213     $href = calendar_get_link_href(new moodle_url($linkbase), $d, $m, $y, $time);
1214     if (empty($href)) {
1215         return $text;
1216     }
1217     return link_arrow_right($text, (string)$href, $accesshide, 'next');
1220 /**
1221  * Return the name of the weekday
1222  *
1223  * @param string $englishname
1224  * @return string of the weekeday
1225  */
1226 function calendar_wday_name($englishname) {
1227     return get_string(strtolower($englishname), 'calendar');
1230 /**
1231  * Return the number of days in month
1232  *
1233  * @param int $month the number of the month.
1234  * @param int $year the number of the year
1235  * @return int
1236  */
1237 function calendar_days_in_month($month, $year) {
1238     $calendartype = \core_calendar\type_factory::get_calendar_instance();
1239     return $calendartype->get_num_days_in_month($year, $month);
1242 /**
1243  * Get the upcoming event block
1244  *
1245  * @param array $events list of events
1246  * @param moodle_url|string $linkhref link to event referer
1247  * @param boolean $showcourselink whether links to courses should be shown
1248  * @return string|null $content html block content
1249  */
1250 function calendar_get_block_upcoming($events, $linkhref = NULL, $showcourselink = false) {
1251     $content = '';
1252     $lines = count($events);
1253     if (!$lines) {
1254         return $content;
1255     }
1257     for ($i = 0; $i < $lines; ++$i) {
1258         if (!isset($events[$i]->time)) {   // Just for robustness
1259             continue;
1260         }
1261         $events[$i] = calendar_add_event_metadata($events[$i]);
1262         $content .= '<div class="event"><span class="icon c0">'.$events[$i]->icon.'</span>';
1263         if (!empty($events[$i]->referer)) {
1264             // That's an activity event, so let's provide the hyperlink
1265             $content .= $events[$i]->referer;
1266         } else {
1267             if(!empty($linkhref)) {
1268                 $href = calendar_get_link_href(new moodle_url(CALENDAR_URL . $linkhref), 0, 0, 0, $events[$i]->timestart);
1269                 $href->set_anchor('event_'.$events[$i]->id);
1270                 $content .= html_writer::link($href, $events[$i]->name);
1271             }
1272             else {
1273                 $content .= $events[$i]->name;
1274             }
1275         }
1276         $events[$i]->time = str_replace('&raquo;', '<br />&raquo;', $events[$i]->time);
1277         if ($showcourselink && !empty($events[$i]->courselink)) {
1278             $content .= html_writer::div($events[$i]->courselink, 'course');
1279         }
1280         $content .= '<div class="date">'.$events[$i]->time.'</div></div>';
1281         if ($i < $lines - 1) $content .= '<hr />';
1282     }
1284     return $content;
1287 /**
1288  * Get the next following month
1289  *
1290  * @param int $month the number of the month.
1291  * @param int $year the number of the year.
1292  * @return array the following month
1293  */
1294 function calendar_add_month($month, $year) {
1295     // Get the calendar type we are using.
1296     $calendartype = \core_calendar\type_factory::get_calendar_instance();
1297     return $calendartype->get_next_month($year, $month);
1300 /**
1301  * Get the previous month.
1302  *
1303  * @param int $month the number of the month.
1304  * @param int $year the number of the year.
1305  * @return array previous month
1306  */
1307 function calendar_sub_month($month, $year) {
1308     // Get the calendar type we are using.
1309     $calendartype = \core_calendar\type_factory::get_calendar_instance();
1310     return $calendartype->get_prev_month($year, $month);
1313 /**
1314  * Get per-day basis events
1315  *
1316  * @param array $events list of events
1317  * @param int $month the number of the month
1318  * @param int $year the number of the year
1319  * @param array $eventsbyday event on specific day
1320  * @param array $durationbyday duration of the event in days
1321  * @param array $typesbyday event type (eg: global, course, user, or group)
1322  * @param array $courses list of courses
1323  * @return void
1324  */
1325 function calendar_events_by_day($events, $month, $year, &$eventsbyday, &$durationbyday, &$typesbyday, &$courses) {
1326     // Get the calendar type we are using.
1327     $calendartype = \core_calendar\type_factory::get_calendar_instance();
1329     $eventsbyday = array();
1330     $typesbyday = array();
1331     $durationbyday = array();
1333     if($events === false) {
1334         return;
1335     }
1337     foreach ($events as $event) {
1338         $startdate = $calendartype->timestamp_to_date_array($event->timestart);
1339         // Set end date = start date if no duration
1340         if ($event->timeduration) {
1341             $enddate = $calendartype->timestamp_to_date_array($event->timestart + $event->timeduration - 1);
1342         } else {
1343             $enddate = $startdate;
1344         }
1346         // Simple arithmetic: $year * 13 + $month is a distinct integer for each distinct ($year, $month) pair
1347         if(!($startdate['year'] * 13 + $startdate['mon'] <= $year * 13 + $month) && ($enddate['year'] * 13 + $enddate['mon'] >= $year * 13 + $month)) {
1348             // Out of bounds
1349             continue;
1350         }
1352         $eventdaystart = intval($startdate['mday']);
1354         if($startdate['mon'] == $month && $startdate['year'] == $year) {
1355             // Give the event to its day
1356             $eventsbyday[$eventdaystart][] = $event->id;
1358             // Mark the day as having such an event
1359             if($event->courseid == SITEID && $event->groupid == 0) {
1360                 $typesbyday[$eventdaystart]['startglobal'] = true;
1361                 // Set event class for global event
1362                 $events[$event->id]->class = 'calendar_event_global';
1363             }
1364             else if($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) {
1365                 $typesbyday[$eventdaystart]['startcourse'] = true;
1366                 // Set event class for course event
1367                 $events[$event->id]->class = 'calendar_event_course';
1368             }
1369             else if($event->groupid) {
1370                 $typesbyday[$eventdaystart]['startgroup'] = true;
1371                 // Set event class for group event
1372                 $events[$event->id]->class = 'calendar_event_group';
1373             }
1374             else if($event->userid) {
1375                 $typesbyday[$eventdaystart]['startuser'] = true;
1376                 // Set event class for user event
1377                 $events[$event->id]->class = 'calendar_event_user';
1378             }
1379         }
1381         if($event->timeduration == 0) {
1382             // Proceed with the next
1383             continue;
1384         }
1386         // The event starts on $month $year or before. So...
1387         $lowerbound = $startdate['mon'] == $month && $startdate['year'] == $year ? intval($startdate['mday']) : 0;
1389         // Also, it ends on $month $year or later...
1390         $upperbound = $enddate['mon'] == $month && $enddate['year'] == $year ? intval($enddate['mday']) : calendar_days_in_month($month, $year);
1392         // Mark all days between $lowerbound and $upperbound (inclusive) as duration
1393         for($i = $lowerbound + 1; $i <= $upperbound; ++$i) {
1394             $durationbyday[$i][] = $event->id;
1395             if($event->courseid == SITEID && $event->groupid == 0) {
1396                 $typesbyday[$i]['durationglobal'] = true;
1397             }
1398             else if($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) {
1399                 $typesbyday[$i]['durationcourse'] = true;
1400             }
1401             else if($event->groupid) {
1402                 $typesbyday[$i]['durationgroup'] = true;
1403             }
1404             else if($event->userid) {
1405                 $typesbyday[$i]['durationuser'] = true;
1406             }
1407         }
1409     }
1410     return;
1413 /**
1414  * Get current module cache
1415  *
1416  * @param array $coursecache list of course cache
1417  * @param string $modulename name of the module
1418  * @param int $instance module instance number
1419  * @return stdClass|bool $module information
1420  */
1421 function calendar_get_module_cached(&$coursecache, $modulename, $instance) {
1422     $module = get_coursemodule_from_instance($modulename, $instance);
1424     if($module === false) return false;
1425     if(!calendar_get_course_cached($coursecache, $module->course)) {
1426         return false;
1427     }
1428     return $module;
1431 /**
1432  * Get current course cache
1433  *
1434  * @param array $coursecache list of course cache
1435  * @param int $courseid id of the course
1436  * @return stdClass $coursecache[$courseid] return the specific course cache
1437  */
1438 function calendar_get_course_cached(&$coursecache, $courseid) {
1439     if (!isset($coursecache[$courseid])) {
1440         $coursecache[$courseid] = get_course($courseid);
1441     }
1442     return $coursecache[$courseid];
1445 /**
1446  * Returns the courses to load events for, the
1447  *
1448  * @param array $courseeventsfrom An array of courses to load calendar events for
1449  * @param bool $ignorefilters specify the use of filters, false is set as default
1450  * @return array An array of courses, groups, and user to load calendar events for based upon filters
1451  */
1452 function calendar_set_filters(array $courseeventsfrom, $ignorefilters = false) {
1453     global $USER, $CFG, $DB;
1455     // For backwards compatability we have to check whether the courses array contains
1456     // just id's in which case we need to load course objects.
1457     $coursestoload = array();
1458     foreach ($courseeventsfrom as $id => $something) {
1459         if (!is_object($something)) {
1460             $coursestoload[] = $id;
1461             unset($courseeventsfrom[$id]);
1462         }
1463     }
1464     if (!empty($coursestoload)) {
1465         // TODO remove this in 2.2
1466         debugging('calendar_set_filters now preferes an array of course objects with preloaded contexts', DEBUG_DEVELOPER);
1467         $courseeventsfrom = array_merge($courseeventsfrom, $DB->get_records_list('course', 'id', $coursestoload));
1468     }
1470     $courses = array();
1471     $user = false;
1472     $group = false;
1474     // capabilities that allow seeing group events from all groups
1475     // TODO: rewrite so that moodle/calendar:manageentries is not necessary here
1476     $allgroupscaps = array('moodle/site:accessallgroups', 'moodle/calendar:manageentries');
1478     $isloggedin = isloggedin();
1480     if ($ignorefilters || calendar_show_event_type(CALENDAR_EVENT_COURSE)) {
1481         $courses = array_keys($courseeventsfrom);
1482     }
1483     if ($ignorefilters || calendar_show_event_type(CALENDAR_EVENT_GLOBAL)) {
1484         $courses[] = SITEID;
1485     }
1486     $courses = array_unique($courses);
1487     sort($courses);
1489     if (!empty($courses) && in_array(SITEID, $courses)) {
1490         // Sort courses for consistent colour highlighting
1491         // Effectively ignoring SITEID as setting as last course id
1492         $key = array_search(SITEID, $courses);
1493         unset($courses[$key]);
1494         $courses[] = SITEID;
1495     }
1497     if ($ignorefilters || ($isloggedin && calendar_show_event_type(CALENDAR_EVENT_USER))) {
1498         $user = $USER->id;
1499     }
1501     if (!empty($courseeventsfrom) && (calendar_show_event_type(CALENDAR_EVENT_GROUP) || $ignorefilters)) {
1503         if (count($courseeventsfrom)==1) {
1504             $course = reset($courseeventsfrom);
1505             if (has_any_capability($allgroupscaps, context_course::instance($course->id))) {
1506                 $coursegroups = groups_get_all_groups($course->id, 0, 0, 'g.id');
1507                 $group = array_keys($coursegroups);
1508             }
1509         }
1510         if ($group === false) {
1511             if (!empty($CFG->calendar_adminseesall) && has_any_capability($allgroupscaps, context_system::instance())) {
1512                 $group = true;
1513             } else if ($isloggedin) {
1514                 $groupids = array();
1516                 // We already have the courses to examine in $courses
1517                 // For each course...
1518                 foreach ($courseeventsfrom as $courseid => $course) {
1519                     // If the user is an editing teacher in there,
1520                     if (!empty($USER->groupmember[$course->id])) {
1521                         // We've already cached the users groups for this course so we can just use that
1522                         $groupids = array_merge($groupids, $USER->groupmember[$course->id]);
1523                     } else if ($course->groupmode != NOGROUPS || !$course->groupmodeforce) {
1524                         // If this course has groups, show events from all of those related to the current user
1525                         $coursegroups = groups_get_user_groups($course->id, $USER->id);
1526                         $groupids = array_merge($groupids, $coursegroups['0']);
1527                     }
1528                 }
1529                 if (!empty($groupids)) {
1530                     $group = $groupids;
1531                 }
1532             }
1533         }
1534     }
1535     if (empty($courses)) {
1536         $courses = false;
1537     }
1539     return array($courses, $group, $user);
1542 /**
1543  * Return the capability for editing calendar event
1544  *
1545  * @param calendar_event $event event object
1546  * @return bool capability to edit event
1547  */
1548 function calendar_edit_event_allowed($event) {
1549     global $USER, $DB;
1551     // Must be logged in
1552     if (!isloggedin()) {
1553         return false;
1554     }
1556     // can not be using guest account
1557     if (isguestuser()) {
1558         return false;
1559     }
1561     // You cannot edit calendar subscription events presently.
1562     if (!empty($event->subscriptionid)) {
1563         return false;
1564     }
1566     $sitecontext = context_system::instance();
1567     // if user has manageentries at site level, return true
1568     if (has_capability('moodle/calendar:manageentries', $sitecontext)) {
1569         return true;
1570     }
1572     // if groupid is set, it's definitely a group event
1573     if (!empty($event->groupid)) {
1574         // Allow users to add/edit group events if:
1575         // 1) They have manageentries (= entries for whole course)
1576         // 2) They have managegroupentries AND are in the group
1577         $group = $DB->get_record('groups', array('id'=>$event->groupid));
1578         return $group && (
1579             has_capability('moodle/calendar:manageentries', $event->context) ||
1580             (has_capability('moodle/calendar:managegroupentries', $event->context)
1581                 && groups_is_member($event->groupid)));
1582     } else if (!empty($event->courseid)) {
1583     // if groupid is not set, but course is set,
1584     // it's definiely a course event
1585         return has_capability('moodle/calendar:manageentries', $event->context);
1586     } else if (!empty($event->userid) && $event->userid == $USER->id) {
1587     // if course is not set, but userid id set, it's a user event
1588         return (has_capability('moodle/calendar:manageownentries', $event->context));
1589     } else if (!empty($event->userid)) {
1590         return (has_capability('moodle/calendar:manageentries', $event->context));
1591     }
1592     return false;
1595 /**
1596  * Returns the default courses to display on the calendar when there isn't a specific
1597  * course to display.
1598  *
1599  * @return array $courses Array of courses to display
1600  */
1601 function calendar_get_default_courses() {
1602     global $CFG, $DB;
1604     if (!isloggedin()) {
1605         return array();
1606     }
1608     $courses = array();
1609     if (!empty($CFG->calendar_adminseesall) && has_capability('moodle/calendar:manageentries', context_system::instance())) {
1610         $select = ', ' . context_helper::get_preload_record_columns_sql('ctx');
1611         $join = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1612         $sql = "SELECT c.* $select
1613                   FROM {course} c
1614                   $join
1615                   WHERE EXISTS (SELECT 1 FROM {event} e WHERE e.courseid = c.id)
1616                   ";
1617         $courses = $DB->get_records_sql($sql, array('contextlevel' => CONTEXT_COURSE), 0, 20);
1618         foreach ($courses as $course) {
1619             context_helper::preload_from_record($course);
1620         }
1621         return $courses;
1622     }
1624     $courses = enrol_get_my_courses();
1626     return $courses;
1629 /**
1630  * Display calendar preference button
1631  *
1632  * @param stdClass $course course object
1633  * @return string return preference button in html
1634  */
1635 function calendar_preferences_button(stdClass $course) {
1636     global $OUTPUT;
1638     // Guests have no preferences
1639     if (!isloggedin() || isguestuser()) {
1640         return '';
1641     }
1643     return $OUTPUT->single_button(new moodle_url('/calendar/preferences.php', array('course' => $course->id)), get_string("preferences", "calendar"));
1646 /**
1647  * Get event format time
1648  *
1649  * @param calendar_event $event event object
1650  * @param int $now current time in gmt
1651  * @param array $linkparams list of params for event link
1652  * @param bool $usecommonwords the words as formatted date/time.
1653  * @param int $showtime determine the show time GMT timestamp
1654  * @return string $eventtime link/string for event time
1655  */
1656 function calendar_format_event_time($event, $now, $linkparams = null, $usecommonwords = true, $showtime = 0) {
1657     $starttime = $event->timestart;
1658     $endtime = $event->timestart + $event->timeduration;
1660     if (empty($linkparams) || !is_array($linkparams)) {
1661         $linkparams = array();
1662     }
1664     $linkparams['view'] = 'day';
1666     // OK, now to get a meaningful display...
1667     // Check if there is a duration for this event.
1668     if ($event->timeduration) {
1669         // Get the midnight of the day the event will start.
1670         $usermidnightstart = usergetmidnight($starttime);
1671         // Get the midnight of the day the event will end.
1672         $usermidnightend = usergetmidnight($endtime);
1673         // Check if we will still be on the same day.
1674         if ($usermidnightstart == $usermidnightend) {
1675             // Check if we are running all day.
1676             if ($event->timeduration == DAYSECS) {
1677                 $time = get_string('allday', 'calendar');
1678             } else { // Specify the time we will be running this from.
1679                 $datestart = calendar_time_representation($starttime);
1680                 $dateend = calendar_time_representation($endtime);
1681                 $time = $datestart . ' <strong>&raquo;</strong> ' . $dateend;
1682             }
1684             // Set printable representation.
1685             if (!$showtime) {
1686                 $day = calendar_day_representation($event->timestart, $now, $usecommonwords);
1687                 $url = calendar_get_link_href(new moodle_url(CALENDAR_URL . 'view.php', $linkparams), 0, 0, 0, $endtime);
1688                 $eventtime = html_writer::link($url, $day) . ', ' . $time;
1689             } else {
1690                 $eventtime = $time;
1691             }
1692         } else { // It must spans two or more days.
1693             $daystart = calendar_day_representation($event->timestart, $now, $usecommonwords) . ', ';
1694             if ($showtime == $usermidnightstart) {
1695                 $daystart = '';
1696             }
1697             $timestart = calendar_time_representation($event->timestart);
1698             $dayend = calendar_day_representation($event->timestart + $event->timeduration, $now, $usecommonwords) . ', ';
1699             if ($showtime == $usermidnightend) {
1700                 $dayend = '';
1701             }
1702             $timeend = calendar_time_representation($event->timestart + $event->timeduration);
1704             // Set printable representation.
1705             if ($now >= $usermidnightstart && $now < ($usermidnightstart + DAYSECS)) {
1706                 $url = calendar_get_link_href(new moodle_url(CALENDAR_URL . 'view.php', $linkparams), 0, 0, 0, $endtime);
1707                 $eventtime = $timestart . ' <strong>&raquo;</strong> ' . html_writer::link($url, $dayend) . $timeend;
1708             } else {
1709                 $url = calendar_get_link_href(new moodle_url(CALENDAR_URL . 'view.php', $linkparams), 0, 0, 0, $endtime);
1710                 $eventtime  = html_writer::link($url, $daystart) . $timestart . ' <strong>&raquo;</strong> ';
1712                 $url = calendar_get_link_href(new moodle_url(CALENDAR_URL . 'view.php', $linkparams),  0, 0, 0, $starttime);
1713                 $eventtime .= html_writer::link($url, $dayend) . $timeend;
1714             }
1715         }
1716     } else { // There is no time duration.
1717         $time = calendar_time_representation($event->timestart);
1718         // Set printable representation.
1719         if (!$showtime) {
1720             $day = calendar_day_representation($event->timestart, $now, $usecommonwords);
1721             $url = calendar_get_link_href(new moodle_url(CALENDAR_URL . 'view.php', $linkparams),  0, 0, 0, $starttime);
1722             $eventtime = html_writer::link($url, $day) . ', ' . trim($time);
1723         } else {
1724             $eventtime = $time;
1725         }
1726     }
1728     // Check if It has expired.
1729     if ($event->timestart + $event->timeduration < $now) {
1730         $eventtime = '<span class="dimmed_text">' . str_replace(' href=', ' class="dimmed" href=', $eventtime) . '</span>';
1731     }
1733     return $eventtime;
1736 /**
1737  * Display month selector options
1738  *
1739  * @param string $name for the select element
1740  * @param string|array $selected options for select elements
1741  */
1742 function calendar_print_month_selector($name, $selected) {
1743     $months = array();
1744     for ($i=1; $i<=12; $i++) {
1745         $months[$i] = userdate(gmmktime(12, 0, 0, $i, 15, 2000), '%B');
1746     }
1747     echo html_writer::label(get_string('months'), 'menu'. $name, false, array('class' => 'accesshide'));
1748     echo html_writer::select($months, $name, $selected, false);
1751 /**
1752  * Checks to see if the requested type of event should be shown for the given user.
1753  *
1754  * @param CALENDAR_EVENT_GLOBAL|CALENDAR_EVENT_COURSE|CALENDAR_EVENT_GROUP|CALENDAR_EVENT_USER $type
1755  *          The type to check the display for (default is to display all)
1756  * @param stdClass|int|null $user The user to check for - by default the current user
1757  * @return bool True if the tyep should be displayed false otherwise
1758  */
1759 function calendar_show_event_type($type, $user = null) {
1760     $default = CALENDAR_EVENT_GLOBAL + CALENDAR_EVENT_COURSE + CALENDAR_EVENT_GROUP + CALENDAR_EVENT_USER;
1761     if (get_user_preferences('calendar_persistflt', 0, $user) === 0) {
1762         global $SESSION;
1763         if (!isset($SESSION->calendarshoweventtype)) {
1764             $SESSION->calendarshoweventtype = $default;
1765         }
1766         return $SESSION->calendarshoweventtype & $type;
1767     } else {
1768         return get_user_preferences('calendar_savedflt', $default, $user) & $type;
1769     }
1772 /**
1773  * Sets the display of the event type given $display.
1774  *
1775  * If $display = true the event type will be shown.
1776  * If $display = false the event type will NOT be shown.
1777  * If $display = null the current value will be toggled and saved.
1778  *
1779  * @param CALENDAR_EVENT_GLOBAL|CALENDAR_EVENT_COURSE|CALENDAR_EVENT_GROUP|CALENDAR_EVENT_USER $type object of CALENDAR_EVENT_XXX
1780  * @param bool $display option to display event type
1781  * @param stdClass|int $user moodle user object or id, null means current user
1782  */
1783 function calendar_set_event_type_display($type, $display = null, $user = null) {
1784     $persist = get_user_preferences('calendar_persistflt', 0, $user);
1785     $default = CALENDAR_EVENT_GLOBAL + CALENDAR_EVENT_COURSE + CALENDAR_EVENT_GROUP + CALENDAR_EVENT_USER;
1786     if ($persist === 0) {
1787         global $SESSION;
1788         if (!isset($SESSION->calendarshoweventtype)) {
1789             $SESSION->calendarshoweventtype = $default;
1790         }
1791         $preference = $SESSION->calendarshoweventtype;
1792     } else {
1793         $preference = get_user_preferences('calendar_savedflt', $default, $user);
1794     }
1795     $current = $preference & $type;
1796     if ($display === null) {
1797         $display = !$current;
1798     }
1799     if ($display && !$current) {
1800         $preference += $type;
1801     } else if (!$display && $current) {
1802         $preference -= $type;
1803     }
1804     if ($persist === 0) {
1805         $SESSION->calendarshoweventtype = $preference;
1806     } else {
1807         if ($preference == $default) {
1808             unset_user_preference('calendar_savedflt', $user);
1809         } else {
1810             set_user_preference('calendar_savedflt', $preference, $user);
1811         }
1812     }
1815 /**
1816  * Get calendar's allowed types
1817  *
1818  * @param stdClass $allowed list of allowed edit for event  type
1819  * @param stdClass|int $course object of a course or course id
1820  */
1821 function calendar_get_allowed_types(&$allowed, $course = null) {
1822     global $USER, $CFG, $DB;
1823     $allowed = new stdClass();
1824     $allowed->user = has_capability('moodle/calendar:manageownentries', context_system::instance());
1825     $allowed->groups = false; // This may change just below
1826     $allowed->courses = false; // This may change just below
1827     $allowed->site = has_capability('moodle/calendar:manageentries', context_course::instance(SITEID));
1829     if (!empty($course)) {
1830         if (!is_object($course)) {
1831             $course = $DB->get_record('course', array('id' => $course), '*', MUST_EXIST);
1832         }
1833         if ($course->id != SITEID) {
1834             $coursecontext = context_course::instance($course->id);
1835             $allowed->user = has_capability('moodle/calendar:manageownentries', $coursecontext);
1837             if (has_capability('moodle/calendar:manageentries', $coursecontext)) {
1838                 $allowed->courses = array($course->id => 1);
1840                 if ($course->groupmode != NOGROUPS || !$course->groupmodeforce) {
1841                     if (has_capability('moodle/site:accessallgroups', $coursecontext)) {
1842                         $allowed->groups = groups_get_all_groups($course->id);
1843                     } else {
1844                         $allowed->groups = groups_get_all_groups($course->id, $USER->id);
1845                     }
1846                 }
1847             } else if (has_capability('moodle/calendar:managegroupentries', $coursecontext)) {
1848                 if($course->groupmode != NOGROUPS || !$course->groupmodeforce) {
1849                     if (has_capability('moodle/site:accessallgroups', $coursecontext)) {
1850                         $allowed->groups = groups_get_all_groups($course->id);
1851                     } else {
1852                         $allowed->groups = groups_get_all_groups($course->id, $USER->id);
1853                     }
1854                 }
1855             }
1856         }
1857     }
1860 /**
1861  * See if user can add calendar entries at all
1862  * used to print the "New Event" button
1863  *
1864  * @param stdClass $course object of a course or course id
1865  * @return bool has the capability to add at least one event type
1866  */
1867 function calendar_user_can_add_event($course) {
1868     if (!isloggedin() || isguestuser()) {
1869         return false;
1870     }
1871     calendar_get_allowed_types($allowed, $course);
1872     return (bool)($allowed->user || $allowed->groups || $allowed->courses || $allowed->site);
1875 /**
1876  * Check wether the current user is permitted to add events
1877  *
1878  * @param stdClass $event object of event
1879  * @return bool has the capability to add event
1880  */
1881 function calendar_add_event_allowed($event) {
1882     global $USER, $DB;
1884     // can not be using guest account
1885     if (!isloggedin() or isguestuser()) {
1886         return false;
1887     }
1889     $sitecontext = context_system::instance();
1890     // if user has manageentries at site level, always return true
1891     if (has_capability('moodle/calendar:manageentries', $sitecontext)) {
1892         return true;
1893     }
1895     switch ($event->eventtype) {
1896         case 'course':
1897             return has_capability('moodle/calendar:manageentries', $event->context);
1899         case 'group':
1900             // Allow users to add/edit group events if:
1901             // 1) They have manageentries (= entries for whole course)
1902             // 2) They have managegroupentries AND are in the group
1903             $group = $DB->get_record('groups', array('id'=>$event->groupid));
1904             return $group && (
1905                 has_capability('moodle/calendar:manageentries', $event->context) ||
1906                 (has_capability('moodle/calendar:managegroupentries', $event->context)
1907                     && groups_is_member($event->groupid)));
1909         case 'user':
1910             if ($event->userid == $USER->id) {
1911                 return (has_capability('moodle/calendar:manageownentries', $event->context));
1912             }
1913             //there is no 'break;' intentionally
1915         case 'site':
1916             return has_capability('moodle/calendar:manageentries', $event->context);
1918         default:
1919             return has_capability('moodle/calendar:manageentries', $event->context);
1920     }
1923 /**
1924  * Manage calendar events
1925  *
1926  * This class provides the required functionality in order to manage calendar events.
1927  * It was introduced as part of Moodle 2.0 and was created in order to provide a
1928  * better framework for dealing with calendar events in particular regard to file
1929  * handling through the new file API
1930  *
1931  * @package    core_calendar
1932  * @category   calendar
1933  * @copyright  2009 Sam Hemelryk
1934  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1935  *
1936  * @property int $id The id within the event table
1937  * @property string $name The name of the event
1938  * @property string $description The description of the event
1939  * @property int $format The format of the description FORMAT_?
1940  * @property int $courseid The course the event is associated with (0 if none)
1941  * @property int $groupid The group the event is associated with (0 if none)
1942  * @property int $userid The user the event is associated with (0 if none)
1943  * @property int $repeatid If this is a repeated event this will be set to the
1944  *                          id of the original
1945  * @property string $modulename If added by a module this will be the module name
1946  * @property int $instance If added by a module this will be the module instance
1947  * @property string $eventtype The event type
1948  * @property int $timestart The start time as a timestamp
1949  * @property int $timeduration The duration of the event in seconds
1950  * @property int $visible 1 if the event is visible
1951  * @property int $uuid ?
1952  * @property int $sequence ?
1953  * @property int $timemodified The time last modified as a timestamp
1954  */
1955 class calendar_event {
1957     /** @var array An object containing the event properties can be accessed via the magic __get/set methods */
1958     protected $properties = null;
1960     /**
1961      * @var string The converted event discription with file paths resolved. This gets populated when someone requests description for the first time */
1962     protected $_description = null;
1964     /** @var array The options to use with this description editor */
1965     protected $editoroptions = array(
1966             'subdirs'=>false,
1967             'forcehttps'=>false,
1968             'maxfiles'=>-1,
1969             'maxbytes'=>null,
1970             'trusttext'=>false);
1972     /** @var object The context to use with the description editor */
1973     protected $editorcontext = null;
1975     /**
1976      * Instantiates a new event and optionally populates its properties with the
1977      * data provided
1978      *
1979      * @param stdClass $data Optional. An object containing the properties to for
1980      *                  an event
1981      */
1982     public function __construct($data=null) {
1983         global $CFG, $USER;
1985         // First convert to object if it is not already (should either be object or assoc array)
1986         if (!is_object($data)) {
1987             $data = (object)$data;
1988         }
1990         $this->editoroptions['maxbytes'] = $CFG->maxbytes;
1992         $data->eventrepeats = 0;
1994         if (empty($data->id)) {
1995             $data->id = null;
1996         }
1998         if (!empty($data->subscriptionid)) {
1999             $data->subscription = calendar_get_subscription($data->subscriptionid);
2000         }
2002         // Default to a user event
2003         if (empty($data->eventtype)) {
2004             $data->eventtype = 'user';
2005         }
2007         // Default to the current user
2008         if (empty($data->userid)) {
2009             $data->userid = $USER->id;
2010         }
2012         if (!empty($data->timeduration) && is_array($data->timeduration)) {
2013             $data->timeduration = make_timestamp($data->timeduration['year'], $data->timeduration['month'], $data->timeduration['day'], $data->timeduration['hour'], $data->timeduration['minute']) - $data->timestart;
2014         }
2015         if (!empty($data->description) && is_array($data->description)) {
2016             $data->format = $data->description['format'];
2017             $data->description = $data->description['text'];
2018         } else if (empty($data->description)) {
2019             $data->description = '';
2020             $data->format = editors_get_preferred_format();
2021         }
2022         // Ensure form is defaulted correctly
2023         if (empty($data->format)) {
2024             $data->format = editors_get_preferred_format();
2025         }
2027         if (empty($data->context)) {
2028             $data->context = $this->calculate_context($data);
2029         }
2030         $this->properties = $data;
2031     }
2033     /**
2034      * Magic property method
2035      *
2036      * Attempts to call a set_$key method if one exists otherwise falls back
2037      * to simply set the property
2038      *
2039      * @param string $key property name
2040      * @param mixed $value value of the property
2041      */
2042     public function __set($key, $value) {
2043         if (method_exists($this, 'set_'.$key)) {
2044             $this->{'set_'.$key}($value);
2045         }
2046         $this->properties->{$key} = $value;
2047     }
2049     /**
2050      * Magic get method
2051      *
2052      * Attempts to call a get_$key method to return the property and ralls over
2053      * to return the raw property
2054      *
2055      * @param string $key property name
2056      * @return mixed property value
2057      */
2058     public function __get($key) {
2059         if (method_exists($this, 'get_'.$key)) {
2060             return $this->{'get_'.$key}();
2061         }
2062         if (!isset($this->properties->{$key})) {
2063             throw new coding_exception('Undefined property requested');
2064         }
2065         return $this->properties->{$key};
2066     }
2068     /**
2069      * Stupid PHP needs an isset magic method if you use the get magic method and
2070      * still want empty calls to work.... blah ~!
2071      *
2072      * @param string $key $key property name
2073      * @return bool|mixed property value, false if property is not exist
2074      */
2075     public function __isset($key) {
2076         return !empty($this->properties->{$key});
2077     }
2079     /**
2080      * Calculate the context value needed for calendar_event.
2081      * Event's type can be determine by the available value store in $data
2082      * It is important to check for the existence of course/courseid to determine
2083      * the course event.
2084      * Default value is set to CONTEXT_USER
2085      *
2086      * @param stdClass $data information about event
2087      * @return stdClass The context object.
2088      */
2089     protected function calculate_context(stdClass $data) {
2090         global $USER, $DB;
2092         $context = null;
2093         if (isset($data->courseid) && $data->courseid > 0) {
2094             $context =  context_course::instance($data->courseid);
2095         } else if (isset($data->course) && $data->course > 0) {
2096             $context =  context_course::instance($data->course);
2097         } else if (isset($data->groupid) && $data->groupid > 0) {
2098             $group = $DB->get_record('groups', array('id'=>$data->groupid));
2099             $context = context_course::instance($group->courseid);
2100         } else if (isset($data->userid) && $data->userid > 0 && $data->userid == $USER->id) {
2101             $context =  context_user::instance($data->userid);
2102         } else if (isset($data->userid) && $data->userid > 0 && $data->userid != $USER->id &&
2103                    isset($data->instance) && $data->instance > 0) {
2104             $cm = get_coursemodule_from_instance($data->modulename, $data->instance, 0, false, MUST_EXIST);
2105             $context =  context_course::instance($cm->course);
2106         } else {
2107             $context =  context_user::instance($data->userid);
2108         }
2110         return $context;
2111     }
2113     /**
2114      * Returns an array of editoroptions for this event: Called by __get
2115      * Please use $blah = $event->editoroptions;
2116      *
2117      * @return array event editor options
2118      */
2119     protected function get_editoroptions() {
2120         return $this->editoroptions;
2121     }
2123     /**
2124      * Returns an event description: Called by __get
2125      * Please use $blah = $event->description;
2126      *
2127      * @return string event description
2128      */
2129     protected function get_description() {
2130         global $CFG;
2132         require_once($CFG->libdir . '/filelib.php');
2134         if ($this->_description === null) {
2135             // Check if we have already resolved the context for this event
2136             if ($this->editorcontext === null) {
2137                 // Switch on the event type to decide upon the appropriate context
2138                 // to use for this event
2139                 $this->editorcontext = $this->properties->context;
2140                 if ($this->properties->eventtype != 'user' && $this->properties->eventtype != 'course'
2141                         && $this->properties->eventtype != 'site' && $this->properties->eventtype != 'group') {
2142                     return clean_text($this->properties->description, $this->properties->format);
2143                 }
2144             }
2146             // Work out the item id for the editor, if this is a repeated event then the files will
2147             // be associated with the original
2148             if (!empty($this->properties->repeatid) && $this->properties->repeatid > 0) {
2149                 $itemid = $this->properties->repeatid;
2150             } else {
2151                 $itemid = $this->properties->id;
2152             }
2154             // Convert file paths in the description so that things display correctly
2155             $this->_description = file_rewrite_pluginfile_urls($this->properties->description, 'pluginfile.php', $this->editorcontext->id, 'calendar', 'event_description', $itemid);
2156             // Clean the text so no nasties get through
2157             $this->_description = clean_text($this->_description, $this->properties->format);
2158         }
2159         // Finally return the description
2160         return $this->_description;
2161     }
2163     /**
2164      * Return the number of repeat events there are in this events series
2165      *
2166      * @return int number of event repeated
2167      */
2168     public function count_repeats() {
2169         global $DB;
2170         if (!empty($this->properties->repeatid)) {
2171             $this->properties->eventrepeats = $DB->count_records('event', array('repeatid'=>$this->properties->repeatid));
2172             // We don't want to count ourselves
2173             $this->properties->eventrepeats--;
2174         }
2175         return $this->properties->eventrepeats;
2176     }
2178     /**
2179      * Update or create an event within the database
2180      *
2181      * Pass in a object containing the event properties and this function will
2182      * insert it into the database and deal with any associated files
2183      *
2184      * @see add_event()
2185      * @see update_event()
2186      *
2187      * @param stdClass $data object of event
2188      * @param bool $checkcapability if moodle should check calendar managing capability or not
2189      * @return bool event updated
2190      */
2191     public function update($data, $checkcapability=true) {
2192         global $CFG, $DB, $USER;
2194         foreach ($data as $key=>$value) {
2195             $this->properties->$key = $value;
2196         }
2198         $this->properties->timemodified = time();
2199         $usingeditor = (!empty($this->properties->description) && is_array($this->properties->description));
2201         if (empty($this->properties->id) || $this->properties->id < 1) {
2203             if ($checkcapability) {
2204                 if (!calendar_add_event_allowed($this->properties)) {
2205                     print_error('nopermissiontoupdatecalendar');
2206                 }
2207             }
2209             if ($usingeditor) {
2210                 switch ($this->properties->eventtype) {
2211                     case 'user':
2212                         $this->properties->courseid = 0;
2213                         $this->properties->course = 0;
2214                         $this->properties->groupid = 0;
2215                         $this->properties->userid = $USER->id;
2216                         break;
2217                     case 'site':
2218                         $this->properties->courseid = SITEID;
2219                         $this->properties->course = SITEID;
2220                         $this->properties->groupid = 0;
2221                         $this->properties->userid = $USER->id;
2222                         break;
2223                     case 'course':
2224                         $this->properties->groupid = 0;
2225                         $this->properties->userid = $USER->id;
2226                         break;
2227                     case 'group':
2228                         $this->properties->userid = $USER->id;
2229                         break;
2230                     default:
2231                         // Ewww we should NEVER get here, but just incase we do lets
2232                         // fail gracefully
2233                         $usingeditor = false;
2234                         break;
2235                 }
2237                 // If we are actually using the editor, we recalculate the context because some default values
2238                 // were set when calculate_context() was called from the constructor.
2239                 if ($usingeditor) {
2240                     $this->properties->context = $this->calculate_context($this->properties);
2241                     $this->editorcontext = $this->properties->context;
2242                 }
2244                 $editor = $this->properties->description;
2245                 $this->properties->format = $this->properties->description['format'];
2246                 $this->properties->description = $this->properties->description['text'];
2247             }
2249             // Insert the event into the database
2250             $this->properties->id = $DB->insert_record('event', $this->properties);
2252             if ($usingeditor) {
2253                 $this->properties->description = file_save_draft_area_files(
2254                                                 $editor['itemid'],
2255                                                 $this->editorcontext->id,
2256                                                 'calendar',
2257                                                 'event_description',
2258                                                 $this->properties->id,
2259                                                 $this->editoroptions,
2260                                                 $editor['text'],
2261                                                 $this->editoroptions['forcehttps']);
2262                 $DB->set_field('event', 'description', $this->properties->description, array('id'=>$this->properties->id));
2263             }
2265             // Log the event entry.
2266             add_to_log($this->properties->courseid, 'calendar', 'add', 'event.php?action=edit&amp;id='.$this->properties->id, $this->properties->name);
2268             $repeatedids = array();
2270             if (!empty($this->properties->repeat)) {
2271                 $this->properties->repeatid = $this->properties->id;
2272                 $DB->set_field('event', 'repeatid', $this->properties->repeatid, array('id'=>$this->properties->id));
2274                 $eventcopy = clone($this->properties);
2275                 unset($eventcopy->id);
2277                 for($i = 1; $i < $eventcopy->repeats; $i++) {
2279                     $eventcopy->timestart = ($eventcopy->timestart+WEEKSECS) + dst_offset_on($eventcopy->timestart) - dst_offset_on($eventcopy->timestart+WEEKSECS);
2281                     // Get the event id for the log record.
2282                     $eventcopyid = $DB->insert_record('event', $eventcopy);
2284                     // If the context has been set delete all associated files
2285                     if ($usingeditor) {
2286                         $fs = get_file_storage();
2287                         $files = $fs->get_area_files($this->editorcontext->id, 'calendar', 'event_description', $this->properties->id);
2288                         foreach ($files as $file) {
2289                             $fs->create_file_from_storedfile(array('itemid'=>$eventcopyid), $file);
2290                         }
2291                     }
2293                     $repeatedids[] = $eventcopyid;
2294                     // Log the event entry.
2295                     add_to_log($eventcopy->courseid, 'calendar', 'add', 'event.php?action=edit&amp;id='.$eventcopyid, $eventcopy->name);
2296                 }
2297             }
2299             // Hook for tracking added events
2300             self::calendar_event_hook('add_event', array($this->properties, $repeatedids));
2301             return true;
2302         } else {
2304             if ($checkcapability) {
2305                 if(!calendar_edit_event_allowed($this->properties)) {
2306                     print_error('nopermissiontoupdatecalendar');
2307                 }
2308             }
2310             if ($usingeditor) {
2311                 if ($this->editorcontext !== null) {
2312                     $this->properties->description = file_save_draft_area_files(
2313                                                     $this->properties->description['itemid'],
2314                                                     $this->editorcontext->id,
2315                                                     'calendar',
2316                                                     'event_description',
2317                                                     $this->properties->id,
2318                                                     $this->editoroptions,
2319                                                     $this->properties->description['text'],
2320                                                     $this->editoroptions['forcehttps']);
2321                 } else {
2322                     $this->properties->format = $this->properties->description['format'];
2323                     $this->properties->description = $this->properties->description['text'];
2324                 }
2325             }
2327             $event = $DB->get_record('event', array('id'=>$this->properties->id));
2329             $updaterepeated = (!empty($this->properties->repeatid) && !empty($this->properties->repeateditall));
2331             if ($updaterepeated) {
2332                 // Update all
2333                 if ($this->properties->timestart != $event->timestart) {
2334                     $timestartoffset = $this->properties->timestart - $event->timestart;
2335                     $sql = "UPDATE {event}
2336                                SET name = ?,
2337                                    description = ?,
2338                                    timestart = timestart + ?,
2339                                    timeduration = ?,
2340                                    timemodified = ?
2341                              WHERE repeatid = ?";
2342                     $params = array($this->properties->name, $this->properties->description, $timestartoffset, $this->properties->timeduration, time(), $event->repeatid);
2343                 } else {
2344                     $sql = "UPDATE {event} SET name = ?, description = ?, timeduration = ?, timemodified = ? WHERE repeatid = ?";
2345                     $params = array($this->properties->name, $this->properties->description, $this->properties->timeduration, time(), $event->repeatid);
2346                 }
2347                 $DB->execute($sql, $params);
2349                 // Log the event update.
2350                 add_to_log($this->properties->courseid, 'calendar', 'edit all', 'event.php?action=edit&amp;id='.$this->properties->id, $this->properties->name);
2351             } else {
2352                 $DB->update_record('event', $this->properties);
2353                 $event = calendar_event::load($this->properties->id);
2354                 $this->properties = $event->properties();
2355                 add_to_log($this->properties->courseid, 'calendar', 'edit', 'event.php?action=edit&amp;id='.$this->properties->id, $this->properties->name);
2356             }
2358             // Hook for tracking event updates
2359             self::calendar_event_hook('update_event', array($this->properties, $updaterepeated));
2360             return true;
2361         }
2362     }
2364     /**
2365      * Deletes an event and if selected an repeated events in the same series
2366      *
2367      * This function deletes an event, any associated events if $deleterepeated=true,
2368      * and cleans up any files associated with the events.
2369      *
2370      * @see delete_event()
2371      *
2372      * @param bool $deleterepeated  delete event repeatedly
2373      * @return bool succession of deleting event
2374      */
2375     public function delete($deleterepeated=false) {
2376         global $DB;
2378         // If $this->properties->id is not set then something is wrong
2379         if (empty($this->properties->id)) {
2380             debugging('Attempting to delete an event before it has been loaded', DEBUG_DEVELOPER);
2381             return false;
2382         }
2384         // Delete the event
2385         $DB->delete_records('event', array('id'=>$this->properties->id));
2387         // If we are deleting parent of a repeated event series, promote the next event in the series as parent
2388         if (($this->properties->id == $this->properties->repeatid) && !$deleterepeated) {
2389             $newparent = $DB->get_field_sql("SELECT id from {event} where repeatid = ? order by id ASC", array($this->properties->id), IGNORE_MULTIPLE);
2390             if (!empty($newparent)) {
2391                 $DB->execute("UPDATE {event} SET repeatid = ? WHERE repeatid = ?", array($newparent, $this->properties->id));
2392                 // Get all records where the repeatid is the same as the event being removed
2393                 $events = $DB->get_records('event', array('repeatid' => $newparent));
2394                 // For each of the returned events trigger the event_update hook.
2395                 foreach ($events as $event) {
2396                     self::calendar_event_hook('update_event', array($event, false));
2397                 }
2398             }
2399         }
2401         // If the editor context hasn't already been set then set it now
2402         if ($this->editorcontext === null) {
2403             $this->editorcontext = $this->properties->context;
2404         }
2406         // If the context has been set delete all associated files
2407         if ($this->editorcontext !== null) {
2408             $fs = get_file_storage();
2409             $files = $fs->get_area_files($this->editorcontext->id, 'calendar', 'event_description', $this->properties->id);
2410             foreach ($files as $file) {
2411                 $file->delete();
2412             }
2413         }
2415         // Fire the event deleted hook
2416         self::calendar_event_hook('delete_event', array($this->properties->id, $deleterepeated));
2418         // If we need to delete repeated events then we will fetch them all and delete one by one
2419         if ($deleterepeated && !empty($this->properties->repeatid) && $this->properties->repeatid > 0) {
2420             // Get all records where the repeatid is the same as the event being removed
2421             $events = $DB->get_records('event', array('repeatid'=>$this->properties->repeatid));
2422             // For each of the returned events populate a calendar_event object and call delete
2423             // make sure the arg passed is false as we are already deleting all repeats
2424             foreach ($events as $event) {
2425                 $event = new calendar_event($event);
2426                 $event->delete(false);
2427             }
2428         }
2430         return true;
2431     }
2433     /**
2434      * Fetch all event properties
2435      *
2436      * This function returns all of the events properties as an object and optionally
2437      * can prepare an editor for the description field at the same time. This is
2438      * designed to work when the properties are going to be used to set the default
2439      * values of a moodle forms form.
2440      *
2441      * @param bool $prepareeditor If set to true a editor is prepared for use with
2442      *              the mforms editor element. (for description)
2443      * @return stdClass Object containing event properties
2444      */
2445     public function properties($prepareeditor=false) {
2446         global $USER, $CFG, $DB;
2448         // First take a copy of the properties. We don't want to actually change the
2449         // properties or we'd forever be converting back and forwards between an
2450         // editor formatted description and not
2451         $properties = clone($this->properties);
2452         // Clean the description here
2453         $properties->description = clean_text($properties->description, $properties->format);
2455         // If set to true we need to prepare the properties for use with an editor
2456         // and prepare the file area
2457         if ($prepareeditor) {
2459             // We may or may not have a property id. If we do then we need to work
2460             // out the context so we can copy the existing files to the draft area
2461             if (!empty($properties->id)) {
2463                 if ($properties->eventtype === 'site') {
2464                     // Site context
2465                     $this->editorcontext = $this->properties->context;
2466                 } else if ($properties->eventtype === 'user') {
2467                     // User context
2468                     $this->editorcontext = $this->properties->context;
2469                 } else if ($properties->eventtype === 'group' || $properties->eventtype === 'course') {
2470                     // First check the course is valid
2471                     $course = $DB->get_record('course', array('id'=>$properties->courseid));
2472                     if (!$course) {
2473                         print_error('invalidcourse');
2474                     }
2475                     // Course context
2476                     $this->editorcontext = $this->properties->context;
2477                     // We have a course and are within the course context so we had
2478                     // better use the courses max bytes value
2479                     $this->editoroptions['maxbytes'] = $course->maxbytes;
2480                 } else {
2481                     // If we get here we have a custom event type as used by some
2482                     // modules. In this case the event will have been added by
2483                     // code and we won't need the editor
2484                     $this->editoroptions['maxbytes'] = 0;
2485                     $this->editoroptions['maxfiles'] = 0;
2486                 }
2488                 if (empty($this->editorcontext) || empty($this->editorcontext->id)) {
2489                     $contextid = false;
2490                 } else {
2491                     // Get the context id that is what we really want
2492                     $contextid = $this->editorcontext->id;
2493                 }
2494             } else {
2496                 // If we get here then this is a new event in which case we don't need a
2497                 // context as there is no existing files to copy to the draft area.
2498                 $contextid = null;
2499             }
2501             // If the contextid === false we don't support files so no preparing
2502             // a draft area
2503             if ($contextid !== false) {
2504                 // Just encase it has already been submitted
2505                 $draftiddescription = file_get_submitted_draft_itemid('description');
2506                 // Prepare the draft area, this copies existing files to the draft area as well
2507                 $properties->description = file_prepare_draft_area($draftiddescription, $contextid, 'calendar', 'event_description', $properties->id, $this->editoroptions, $properties->description);
2508             } else {
2509                 $draftiddescription = 0;
2510             }
2512             // Structure the description field as the editor requires
2513             $properties->description = array('text'=>$properties->description, 'format'=>$properties->format, 'itemid'=>$draftiddescription);
2514         }
2516         // Finally return the properties
2517         return $properties;
2518     }
2520     /**
2521      * Toggles the visibility of an event
2522      *
2523      * @param null|bool $force If it is left null the events visibility is flipped,
2524      *                   If it is false the event is made hidden, if it is true it
2525      *                   is made visible.
2526      * @return bool if event is successfully updated, toggle will be visible
2527      */
2528     public function toggle_visibility($force=null) {
2529         global $CFG, $DB;
2531         // Set visible to the default if it is not already set
2532         if (empty($this->properties->visible)) {
2533             $this->properties->visible = 1;
2534         }
2536         if ($force === true || ($force !== false && $this->properties->visible == 0)) {
2537             // Make this event visible
2538             $this->properties->visible = 1;
2539             // Fire the hook
2540             self::calendar_event_hook('show_event', array($this->properties));
2541         } else {
2542             // Make this event hidden
2543             $this->properties->visible = 0;
2544             // Fire the hook
2545             self::calendar_event_hook('hide_event', array($this->properties));
2546         }
2548         // Update the database to reflect this change
2549         return $DB->set_field('event', 'visible', $this->properties->visible, array('id'=>$this->properties->id));
2550     }
2552     /**
2553      * Attempts to call the hook for the specified action should a calendar type
2554      * by set $CFG->calendar, and the appopriate function defined
2555      *
2556      * @param string $action One of `update_event`, `add_event`, `delete_event`, `show_event`, `hide_event`
2557      * @param array $args The args to pass to the hook, usually the event is the first element
2558      * @return bool attempts to call event hook
2559      */
2560     public static function calendar_event_hook($action, array $args) {
2561         global $CFG;
2562         static $extcalendarinc;
2563         if ($extcalendarinc === null) {
2564             if (!empty($CFG->calendar)) {
2565                 if (is_readable($CFG->dirroot .'/calendar/'. $CFG->calendar .'/lib.php')) {
2566                     include_once($CFG->dirroot .'/calendar/'. $CFG->calendar .'/lib.php');
2567                     $extcalendarinc = true;
2568                 } else {
2569                     debugging("Calendar lib file missing or not readable at /calendar/{$CFG->calendar}/lib.php.",
2570                         DEBUG_DEVELOPER);
2571                     $extcalendarinc = false;
2572                 }
2573             } else {
2574                 $extcalendarinc = false;
2575             }
2576         }
2577         if($extcalendarinc === false) {
2578             return false;
2579         }
2580         $hook = $CFG->calendar .'_'.$action;
2581         if (function_exists($hook)) {
2582             call_user_func_array($hook, $args);
2583             return true;
2584         }
2585         return false;
2586     }
2588     /**
2589      * Returns a calendar_event object when provided with an event id
2590      *
2591      * This function makes use of MUST_EXIST, if the event id passed in is invalid
2592      * it will result in an exception being thrown
2593      *
2594      * @param int|object $param event object or event id
2595      * @return calendar_event|false status for loading calendar_event
2596      */
2597     public static function load($param) {
2598         global $DB;
2599         if (is_object($param)) {
2600             $event = new calendar_event($param);
2601         } else {
2602             $event = $DB->get_record('event', array('id'=>(int)$param), '*', MUST_EXIST);
2603             $event = new calendar_event($event);
2604         }
2605         return $event;
2606     }
2608     /**
2609      * Creates a new event and returns a calendar_event object
2610      *
2611      * @param object|array $properties An object containing event properties
2612      * @return calendar_event|false The event object or false if it failed
2613      */
2614     public static function create($properties) {
2615         if (is_array($properties)) {
2616             $properties = (object)$properties;
2617         }
2618         if (!is_object($properties)) {
2619             throw new coding_exception('When creating an event properties should be either an object or an assoc array');
2620         }
2621         $event = new calendar_event($properties);
2622         if ($event->update($properties)) {
2623             return $event;
2624         } else {
2625             return false;
2626         }
2627     }
2630 /**
2631  * Calendar information class
2632  *
2633  * This class is used simply to organise the information pertaining to a calendar
2634  * and is used primarily to make information easily available.
2635  *
2636  * @package core_calendar
2637  * @category calendar
2638  * @copyright 2010 Sam Hemelryk
2639  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2640  */
2641 class calendar_information {
2643     /**
2644      * @var int The timestamp
2645      *
2646      * Rather than setting the day, month and year we will set a timestamp which will be able
2647      * to be used by multiple calendars.
2648      */
2649     public $time;
2651     /** @var int A course id */
2652     public $courseid = null;
2654     /** @var array An array of courses */
2655     public $courses = array();
2657     /** @var array An array of groups */
2658     public $groups = array();
2660     /** @var array An array of users */
2661     public $users = array();
2663     /**
2664      * Creates a new instance
2665      *
2666      * @param int $day the number of the day
2667      * @param int $month the number of the month
2668      * @param int $year the number of the year
2669      * @param int $time the unixtimestamp representing the date we want to view, this is used instead of $calmonth
2670      *     and $calyear to support multiple calendars
2671      */
2672     public function __construct($day = 0, $month = 0, $year = 0, $time = 0) {
2673         // If a day, month and year were passed then convert it to a timestamp. If these were passed
2674         // then we can assume the day, month and year are passed as Gregorian, as no where in core
2675         // should we be passing these values rather than the time. This is done for BC.
2676         if (!empty($day) || !empty($month) || !empty($year)) {
2677             $date = usergetdate(time());
2678             if (empty($day)) {
2679                 $day = $date['mday'];
2680             }
2681             if (empty($month)) {
2682                 $month = $date['mon'];
2683             }
2684             if (empty($year)) {
2685                 $year =  $date['year'];
2686             }
2687             if (checkdate($month, $day, $year)) {
2688                 $this->time = make_timestamp($year, $month, $day);
2689             } else {
2690                 $this->time = time();
2691             }
2692         } else if (!empty($time)) {
2693             $this->time = $time;
2694         } else {
2695             $this->time = time();
2696         }
2697     }
2699     /**
2700      * Initialize calendar information
2701      *
2702      * @param stdClass $course object
2703      * @param array $coursestoload An array of courses [$course->id => $course]
2704      * @param bool $ignorefilters options to use filter
2705      */
2706     public function prepare_for_view(stdClass $course, array $coursestoload, $ignorefilters = false) {
2707         $this->courseid = $course->id;
2708         $this->course = $course;
2709         list($courses, $group, $user) = calendar_set_filters($coursestoload, $ignorefilters);
2710         $this->courses = $courses;
2711         $this->groups = $group;
2712         $this->users = $user;
2713     }
2715     /**
2716      * Ensures the date for the calendar is correct and either sets it to now
2717      * or throws a moodle_exception if not
2718      *
2719      * @param bool $defaultonow use current time
2720      * @throws moodle_exception
2721      * @return bool validation of checkdate
2722      */
2723     public function checkdate($defaultonow = true) {
2724         if (!checkdate($this->month, $this->day, $this->year)) {
2725             if ($defaultonow) {
2726                 $now = usergetdate(time());
2727                 $this->day = intval($now['mday']);
2728                 $this->month = intval($now['mon']);
2729                 $this->year = intval($now['year']);
2730                 return true;
2731             } else {
2732                 throw new moodle_exception('invaliddate');
2733             }
2734         }
2735         return true;
2736     }
2738     /**
2739      * Gets todays timestamp for the calendar
2740      *
2741      * @return int today timestamp
2742      */
2743     public function timestamp_today() {
2744         return $this->time;
2745     }
2746     /**
2747      * Gets tomorrows timestamp for the calendar
2748      *
2749      * @return int tomorrow timestamp
2750      */
2751     public function timestamp_tomorrow() {
2752         return $this->time + DAYSECS;
2753     }
2754     /**
2755      * Adds the pretend blocks for the calendar
2756      *
2757      * @param core_calendar_renderer $renderer
2758      * @param bool $showfilters display filters, false is set as default
2759      * @param string|null $view preference view options (eg: day, month, upcoming)
2760      */
2761     public function add_sidecalendar_blocks(core_calendar_renderer $renderer, $showfilters=false, $view=null) {
2762         if ($showfilters) {
2763             $filters = new block_contents();
2764             $filters->content = $renderer->fake_block_filters($this->courseid, 0, 0, 0, $view, $this->courses);
2765             $filters->footer = '';
2766             $filters->title = get_string('eventskey', 'calendar');
2767             $renderer->add_pretend_calendar_block($filters, BLOCK_POS_RIGHT);
2768         }
2769         $block = new block_contents;
2770         $block->content = $renderer->fake_block_threemonths($this);
2771         $block->footer = '';
2772         $block->title = get_string('monthlyview', 'calendar');
2773         $renderer->add_pretend_calendar_block($block, BLOCK_POS_RIGHT);
2774     }
2777 /**
2778  * Returns option list for the poll interval setting.
2779  *
2780  * @return array An array of poll interval options. Interval => description.
2781  */
2782 function calendar_get_pollinterval_choices() {
2783     return array(
2784         '0' => new lang_string('never', 'calendar'),
2785         '3600' => new lang_string('hourly', 'calendar'),
2786         '86400' => new lang_string('daily', 'calendar'),
2787         '604800' => new lang_string('weekly', 'calendar'),
2788         '2628000' => new lang_string('monthly', 'calendar'),
2789         '31536000' => new lang_string('annually', 'calendar')
2790     );
2793 /**
2794  * Returns option list of available options for the calendar event type, given the current user and course.
2795  *
2796  * @param int $courseid The id of the course
2797  * @return array An array containing the event types the user can create.
2798  */
2799 function calendar_get_eventtype_choices($courseid) {
2800     $choices = array();
2801     $allowed = new stdClass;
2802     calendar_get_allowed_types($allowed, $courseid);
2804     if ($allowed->user) {
2805         $choices['user'] = get_string('userevents', 'calendar');
2806     }
2807     if ($allowed->site) {
2808         $choices['site'] = get_string('siteevents', 'calendar');
2809     }
2810     if (!empty($allowed->courses)) {
2811         $choices['course'] = get_string('courseevents', 'calendar');
2812     }
2813     if (!empty($allowed->groups) and is_array($allowed->groups)) {
2814         $choices['group'] = get_string('group');
2815     }
2817     return array($choices, $allowed->groups);
2820 /**
2821  * Add an iCalendar subscription to the database.
2822  *
2823  * @param stdClass $sub The subscription object (e.g. from the form)
2824  * @return int The insert ID, if any.
2825  */
2826 function calendar_add_subscription($sub) {
2827     global $DB, $USER, $SITE;
2829     if ($sub->eventtype === 'site') {
2830         $sub->courseid = $SITE->id;
2831     } else if ($sub->eventtype === 'group' || $sub->eventtype === 'course') {
2832         $sub->courseid = $sub->course;
2833     } else {
2834         // User events.
2835         $sub->courseid = 0;
2836     }
2837     $sub->userid = $USER->id;
2839     // File subscriptions never update.
2840     if (empty($sub->url)) {
2841         $sub->pollinterval = 0;
2842     }
2844     if (!empty($sub->name)) {
2845         if (empty($sub->id)) {
2846             $id = $DB->insert_record('event_subscriptions', $sub);
2847             // we cannot cache the data here because $sub is not complete.
2848             return $id;
2849         } else {
2850             // Why are we doing an update here?
2851             calendar_update_subscription($sub);
2852             return $sub->id;
2853         }
2854     } else {
2855         print_error('errorbadsubscription', 'importcalendar');
2856     }
2859 /**
2860  * Add an iCalendar event to the Moodle calendar.
2861  *
2862  * @param object $event The RFC-2445 iCalendar event
2863  * @param int $courseid The course ID
2864  * @param int $subscriptionid The iCalendar subscription ID
2865  * @throws dml_exception A DML specific exception is thrown for invalid subscriptionids.
2866  * @return int Code: 1=updated, 2=inserted, 0=error
2867  */
2868 function calendar_add_icalendar_event($event, $courseid, $subscriptionid) {
2869     global $DB, $USER;
2871     // Probably an unsupported X-MICROSOFT-CDO-BUSYSTATUS event.
2872     if (empty($event->properties['SUMMARY'])) {
2873         return 0;
2874     }
2876     $name = $event->properties['SUMMARY'][0]->value;
2877     $name = str_replace('\n', '<br />', $name);
2878     $name = str_replace('\\', '', $name);
2879     $name = preg_replace('/\s+/', ' ', $name);
2881     $eventrecord = new stdClass;
2882     $eventrecord->name = clean_param($name, PARAM_NOTAGS);
2884     if (empty($event->properties['DESCRIPTION'][0]->value)) {
2885         $description = '';
2886     } else {
2887         $description = $event->properties['DESCRIPTION'][0]->value;
2888         $description = str_replace('\n', '<br />', $description);
2889         $description = str_replace('\\', '', $description);
2890         $description = preg_replace('/\s+/', ' ', $description);
2891     }
2892     $eventrecord->description = clean_param($description, PARAM_NOTAGS);
2894     // Probably a repeating event with RRULE etc. TODO: skip for now.
2895     if (empty($event->properties['DTSTART'][0]->value)) {
2896         return 0;
2897     }
2899     $eventrecord->timestart = strtotime($event->properties['DTSTART'][0]->value);
2900     if (empty($event->properties['DTEND'])) {
2901         $eventrecord->timeduration = 3600; // one hour if no end time specified
2902     } else {
2903         $eventrecord->timeduration = strtotime($event->properties['DTEND'][0]->value) - $eventrecord->timestart;
2904     }
2905     $eventrecord->uuid = $event->properties['UID'][0]->value;
2906     $eventrecord->timemodified = time();
2908     // Add the iCal subscription details if required.
2909     // We should never do anything with an event without a subscription reference.
2910     $sub = calendar_get_subscription($subscriptionid);
2911     $eventrecord->subscriptionid = $subscriptionid;
2912     $eventrecord->userid = $sub->userid;
2913     $eventrecord->groupid = $sub->groupid;
2914     $eventrecord->courseid = $sub->courseid;
2915     $eventrecord->eventtype = $sub->eventtype;
2917     if ($updaterecord = $DB->get_record('event', array('uuid' => $eventrecord->uuid))) {
2918         $eventrecord->id = $updaterecord->id;
2919         if ($DB->update_record('event', $eventrecord)) {
2920             return CALENDAR_IMPORT_EVENT_UPDATED;
2921         } else {
2922             return 0;
2923         }
2924     } else {
2925         if ($DB->insert_record('event', $eventrecord)) {
2926             return CALENDAR_IMPORT_EVENT_INSERTED;
2927         } else {
2928             return 0;
2929         }
2930     }
2933 /**
2934  * Update a subscription from the form data in one of the rows in the existing subscriptions table.
2935  *
2936  * @param int $subscriptionid The ID of the subscription we are acting upon.
2937  * @param int $pollinterval The poll interval to use.
2938  * @param int $action The action to be performed. One of update or remove.
2939  * @throws dml_exception if invalid subscriptionid is provided
2940  * @return string A log of the import progress, including errors
2941  */
2942 function calendar_process_subscription_row($subscriptionid, $pollinterval, $action) {
2944     // Fetch the subscription from the database making sure it exists.
2945     $sub = calendar_get_subscription($subscriptionid);
2947     // Update or remove the subscription, based on action.
2948     switch ($action) {
2949         case CALENDAR_SUBSCRIPTION_UPDATE:
2950             // Skip updating file subscriptions.
2951             if (empty($sub->url)) {
2952                 break;
2953             }
2954             $sub->pollinterval = $pollinterval;
2955             calendar_update_subscription($sub);
2957             // Update the events.
2958             return "<p>".get_string('subscriptionupdated', 'calendar', $sub->name)."</p>" . calendar_update_subscription_events($subscriptionid);
2960         case CALENDAR_SUBSCRIPTION_REMOVE:
2961             calendar_delete_subscription($subscriptionid);
2962             return get_string('subscriptionremoved', 'calendar', $sub->name);
2963             break;
2965         default:
2966             break;
2967     }
2968     return '';
2971 /**
2972  * Delete subscription and all related events.
2973  *
2974  * @param int|stdClass $subscription subscription or it's id, which needs to be deleted.
2975  */
2976 function calendar_delete_subscription($subscription) {
2977     global $DB;
2979     if (is_object($subscription)) {
2980         $subscription = $subscription->id;
2981     }
2982     // Delete subscription and related events.
2983     $DB->delete_records('event', array('subscriptionid' => $subscription));
2984     $DB->delete_records('event_subscriptions', array('id' => $subscription));
2985     cache_helper::invalidate_by_definition('core', 'calendar_subscriptions', array(), array($subscription));
2987 /**
2988  * From a URL, fetch the calendar and return an iCalendar object.
2989  *
2990  * @param string $url The iCalendar URL
2991  * @return stdClass The iCalendar object
2992  */
2993 function calendar_get_icalendar($url) {
2994     global $CFG;
2996     require_once($CFG->libdir.'/filelib.php');
2998     $curl = new curl();
2999     $curl->setopt(array('CURLOPT_FOLLOWLOCATION' => 1, 'CURLOPT_MAXREDIRS' => 5));
3000     $calendar = $curl->get($url);
3001     // Http code validation should actually be the job of curl class.
3002     if (!$calendar || $curl->info['http_code'] != 200 || !empty($curl->errorno)) {
3003         throw new moodle_exception('errorinvalidicalurl', 'calendar');
3004     }
3006     $ical = new iCalendar();
3007     $ical->unserialize($calendar);
3008     return $ical;
3011 /**
3012  * Import events from an iCalendar object into a course calendar.
3013  *
3014  * @param stdClass $ical The iCalendar object.
3015  * @param int $courseid The course ID for the calendar.
3016  * @param int $subscriptionid The subscription ID.
3017  * @return string A log of the import progress, including errors.
3018  */
3019 function calendar_import_icalendar_events($ical, $courseid, $subscriptionid = null) {
3020     global $DB;
3021     $return = '';
3022     $eventcount = 0;
3023     $updatecount = 0;
3025     // Large calendars take a while...
3026     set_time_limit(300);
3028     // Mark all events in a subscription with a zero timestamp.
3029     if (!empty($subscriptionid)) {
3030         $sql = "UPDATE {event} SET timemodified = :time WHERE subscriptionid = :id";
3031         $DB->execute($sql, array('time' => 0, 'id' => $subscriptionid));
3032     }
3033     foreach ($ical->components['VEVENT'] as $event) {
3034         $res = calendar_add_icalendar_event($event, $courseid, $subscriptionid);
3035         switch ($res) {
3036           case CALENDAR_IMPORT_EVENT_UPDATED:
3037             $updatecount++;
3038             break;
3039           case CALENDAR_IMPORT_EVENT_INSERTED:
3040             $eventcount++;
3041             break;
3042           case 0:
3043             $return .= '<p>'.get_string('erroraddingevent', 'calendar').': '.(empty($event->properties['SUMMARY'])?'('.get_string('notitle', 'calendar').')':$event->properties['SUMMARY'][0]->value)." </p>\n";
3044             break;
3045         }
3046     }
3047     $return .= "<p> ".get_string('eventsimported', 'calendar', $eventcount)."</p>";
3048     $return .= "<p> ".get_string('eventsupdated', 'calendar', $updatecount)."</p>";
3050     // Delete remaining zero-marked events since they're not in remote calendar.
3051     if (!empty($subscriptionid)) {
3052         $deletecount = $DB->count_records('event', array('timemodified' => 0, 'subscriptionid' => $subscriptionid));
3053         if (!empty($deletecount)) {
3054             $sql = "DELETE FROM {event} WHERE timemodified = :time AND subscriptionid = :id";
3055             $DB->execute($sql, array('time' => 0, 'id' => $subscriptionid));
3056             $return .= "<p> ".get_string('eventsdeleted', 'calendar').": {$deletecount} </p>\n";
3057         }
3058     }
3060     return $return;
3063 /**
3064  * Fetch a calendar subscription and update the events in the calendar.
3065  *
3066  * @param int $subscriptionid The course ID for the calendar.
3067  * @return string A log of the import progress, including errors.
3068  */
3069 function calendar_update_subscription_events($subscriptionid) {
3070     global $DB;
3072     $sub = calendar_get_subscription($subscriptionid);
3073     // Don't update a file subscription. TODO: Update from a new uploaded file.
3074     if (empty($sub->url)) {
3075         return 'File subscription not updated.';
3076     }
3077     $ical = calendar_get_icalendar($sub->url);
3078     $return = calendar_import_icalendar_events($ical, $sub->courseid, $subscriptionid);
3079     $sub->lastupdated = time();
3080     calendar_update_subscription($sub);
3081     return $return;
3084 /**
3085  * Update a calendar subscription. Also updates the associated cache.
3086  *
3087  * @param stdClass|array $subscription Subscription record.
3088  * @throws coding_exception If something goes wrong
3089  * @since Moodle 2.5
3090  */
3091 function calendar_update_subscription($subscription) {
3092     global $DB;
3094     if (is_array($subscription)) {
3095         $subscription = (object)$subscription;
3096     }
3097     if (empty($subscription->id) || !$DB->record_exists('event_subscriptions', array('id' => $subscription->id))) {
3098         throw new coding_exception('Cannot update a subscription without a valid id');
3099     }
3101     $DB->update_record('event_subscriptions', $subscription);
3102     // Update cache.
3103     $cache = cache::make('core', 'calendar_subscriptions');
3104     $cache->set($subscription->id, $subscription);
3107 /**
3108  * Checks to see if the user can edit a given subscription feed.
3109  *
3110  * @param mixed $subscriptionorid Subscription object or id
3111  * @return bool true if current user can edit the subscription else false
3112  */
3113 function calendar_can_edit_subscription($subscriptionorid) {
3114     global $DB;
3116     if (is_array($subscriptionorid)) {
3117         $subscription = (object)$subscriptionorid;
3118     } else if (is_object($subscriptionorid)) {
3119         $subscription = $subscriptionorid;
3120     } else {
3121         $subscription = calendar_get_subscription($subscriptionorid);
3122     }
3123     $allowed = new stdClass;
3124     $courseid = $subscription->courseid;
3125     $groupid = $subscription->groupid;
3126     calendar_get_allowed_types($allowed, $courseid);
3127     switch ($subscription->eventtype) {
3128         case 'user':
3129             return $allowed->user;
3130         case 'course':
3131             if (isset($allowed->courses[$courseid])) {
3132                 return $allowed->courses[$courseid];
3133             } else {
3134                 return false;
3135             }
3136         case 'site':
3137             return $allowed->site;
3138         case 'group':
3139             if (isset($allowed->groups[$groupid])) {
3140                 return $allowed->groups[$groupid];
3141             } else {
3142                 return false;
3143             }
3144         default:
3145             return false;
3146     }
3149 /**
3150  * Update calendar subscriptions.
3151  *
3152  * @return bool
3153  */
3154 function calendar_cron() {
3155     global $CFG, $DB;
3157     // In order to execute this we need bennu.
3158     require_once($CFG->libdir.'/bennu/bennu.inc.php');
3160     mtrace('Updating calendar subscriptions:');
3161     cron_trace_time_and_memory();
3163     $time = time();
3164     $subscriptions = $DB->get_records_sql('SELECT * FROM {event_subscriptions} WHERE pollinterval > 0 AND lastupdated + pollinterval < ?', array($time));
3165     foreach ($subscriptions as $sub) {
3166         mtrace("Updating calendar subscription {$sub->name} in course {$sub->courseid}");
3167         try {
3168             $log = calendar_update_subscription_events($sub->id);
3169         } catch (moodle_exception $ex) {
3171         }
3172         mtrace(trim(strip_tags($log)));
3173     }
3175     mtrace('Finished updating calendar subscriptions.');
3177     return true;