Merge branch 'MDL-19171' of https://github.com/bostelm/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  * Return the days of the week
115  *
116  * @return array array of days
117  */
118 function calendar_get_days() {
119     return array('sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday');
122 /**
123  * Get the subscription from a given id
124  *
125  * @since Moodle 2.5
126  * @param int $id id of the subscription
127  * @return stdClass Subscription record from DB
128  * @throws moodle_exception for an invalid id
129  */
130 function calendar_get_subscription($id) {
131     global $DB;
133     $cache = cache::make('core', 'calendar_subscriptions');
134     $subscription = $cache->get($id);
135     if (empty($subscription)) {
136         $subscription = $DB->get_record('event_subscriptions', array('id' => $id), '*', MUST_EXIST);
137         // cache the data.
138         $cache->set($id, $subscription);
139     }
140     return $subscription;
143 /**
144  * Gets the first day of the week
145  *
146  * Used to be define('CALENDAR_STARTING_WEEKDAY', blah);
147  *
148  * @return int
149  */
150 function calendar_get_starting_weekday() {
151     global $CFG;
153     if (isset($CFG->calendar_startwday)) {
154         $firstday = $CFG->calendar_startwday;
155     } else {
156         $firstday = get_string('firstdayofweek', 'langconfig');
157     }
159     if(!is_numeric($firstday)) {
160         return CALENDAR_DEFAULT_STARTING_WEEKDAY;
161     } else {
162         return intval($firstday) % 7;
163     }
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 $cal_month calendar month in numeric, default is set to false
173  * @param int $cal_year calendar month in numeric, default is set to false
174  * @param string $placement the place/page the calendar is set to appear - passed on the the controls function
175  * @param int $courseid id of the course the calendar is displayed on - passed on the the controls function
176  * @return string $content return html table for mini calendar
177  */
178 function calendar_get_mini($courses, $groups, $users, $cal_month = false, $cal_year = false, $placement = false, $courseid = false ) {
179     global $CFG, $USER, $OUTPUT;
181     $display = new stdClass;
182     $display->minwday = get_user_preferences('calendar_startwday', calendar_get_starting_weekday());
183     $display->maxwday = $display->minwday + 6;
185     $content = '';
187     if(!empty($cal_month) && !empty($cal_year)) {
188         $thisdate = usergetdate(time()); // Date and time the user sees at his location
189         if($cal_month == $thisdate['mon'] && $cal_year == $thisdate['year']) {
190             // Navigated to this month
191             $date = $thisdate;
192             $display->thismonth = true;
193         } else {
194             // Navigated to other month, let's do a nice trick and save us a lot of work...
195             if(!checkdate($cal_month, 1, $cal_year)) {
196                 $date = array('mday' => 1, 'mon' => $thisdate['mon'], 'year' => $thisdate['year']);
197                 $display->thismonth = true;
198             } else {
199                 $date = array('mday' => 1, 'mon' => $cal_month, 'year' => $cal_year);
200                 $display->thismonth = false;
201             }
202         }
203     } else {
204         $date = usergetdate(time()); // Date and time the user sees at his location
205         $display->thismonth = true;
206     }
208     // Fill in the variables we 're going to use, nice and tidy
209     list($d, $m, $y) = array($date['mday'], $date['mon'], $date['year']); // This is what we want to display
210     $display->maxdays = calendar_days_in_month($m, $y);
212     if (get_user_timezone_offset() < 99) {
213         // We 'll keep these values as GMT here, and offset them when the time comes to query the db
214         $display->tstart = gmmktime(0, 0, 0, $m, 1, $y); // This is GMT
215         $display->tend = gmmktime(23, 59, 59, $m, $display->maxdays, $y); // GMT
216     } else {
217         // no timezone info specified
218         $display->tstart = mktime(0, 0, 0, $m, 1, $y);
219         $display->tend = mktime(23, 59, 59, $m, $display->maxdays, $y);
220     }
222     $startwday = dayofweek(1, $m, $y);
224     // Align the starting weekday to fall in our display range
225     // This is simple, not foolproof.
226     if($startwday < $display->minwday) {
227         $startwday += 7;
228     }
230     // TODO: THIS IS TEMPORARY CODE!
231     // [pj] I was just reading through this and realized that I when writing this code I was probably
232     // asking for trouble, as all these time manipulations seem to be unnecessary and a simple
233     // make_timestamp would accomplish the same thing. So here goes a test:
234     //$test_start = make_timestamp($y, $m, 1);
235     //$test_end   = make_timestamp($y, $m, $display->maxdays, 23, 59, 59);
236     //if($test_start != usertime($display->tstart) - dst_offset_on($display->tstart)) {
237         //notify('Failed assertion in calendar/lib.php line 126; display->tstart = '.$display->tstart.', dst_offset = '.dst_offset_on($display->tstart).', usertime = '.usertime($display->tstart).', make_t = '.$test_start);
238     //}
239     //if($test_end != usertime($display->tend) - dst_offset_on($display->tend)) {
240         //notify('Failed assertion in calendar/lib.php line 130; display->tend = '.$display->tend.', dst_offset = '.dst_offset_on($display->tend).', usertime = '.usertime($display->tend).', make_t = '.$test_end);
241     //}
244     // Get the events matching our criteria. Don't forget to offset the timestamps for the user's TZ!
245     $events = calendar_get_events(
246         usertime($display->tstart) - dst_offset_on($display->tstart),
247         usertime($display->tend) - dst_offset_on($display->tend),
248         $users, $groups, $courses);
250     // Set event course class for course events
251     if (!empty($events)) {
252         foreach ($events as $eventid => $event) {
253             if (!empty($event->modulename)) {
254                 $cm = get_coursemodule_from_instance($event->modulename, $event->instance);
255                 if (!groups_course_module_visible($cm)) {
256                     unset($events[$eventid]);
257                 }
258             }
259         }
260     }
262     // This is either a genius idea or an idiot idea: in order to not complicate things, we use this rule: if, after
263     // possibly removing SITEID from $courses, there is only one course left, then clicking on a day in the month
264     // will also set the $SESSION->cal_courses_shown variable to that one course. Otherwise, we 'd need to add extra
265     // arguments to this function.
267     $hrefparams = array();
268     if(!empty($courses)) {
269         $courses = array_diff($courses, array(SITEID));
270         if(count($courses) == 1) {
271             $hrefparams['course'] = reset($courses);
272         }
273     }
275     // We want to have easy access by day, since the display is on a per-day basis.
276     // Arguments passed by reference.
277     //calendar_events_by_day($events, $display->tstart, $eventsbyday, $durationbyday, $typesbyday);
278     calendar_events_by_day($events, $m, $y, $eventsbyday, $durationbyday, $typesbyday, $courses);
280     //Accessibility: added summary and <abbr> elements.
281     $days_title = calendar_get_days();
283     $summary = get_string('calendarheading', 'calendar', userdate(make_timestamp($y, $m), get_string('strftimemonthyear')));
284     $content .= '<table class="minicalendar calendartable" summary="'.$summary.'">'; // Begin table
285     if (($placement !== false) && ($courseid  !== false)) {
286         $content .= '<caption>'. calendar_top_controls($placement, array('id' => $courseid, 'm' => $m, 'y' => $y)) .'</caption>';
287     }
288     $content .= '<tr class="weekdays">'; // Header row: day names
290     // Print out the names of the weekdays
291     $days = array('sun', 'mon', 'tue', 'wed', 'thu', 'fri', 'sat');
292     for($i = $display->minwday; $i <= $display->maxwday; ++$i) {
293         // This uses the % operator to get the correct weekday no matter what shift we have
294         // applied to the $display->minwday : $display->maxwday range from the default 0 : 6
295         $content .= '<th scope="col"><abbr title="'. get_string($days_title[$i % 7], 'calendar') .'">'.
296             get_string($days[$i % 7], 'calendar') ."</abbr></th>\n";
297     }
299     $content .= '</tr><tr>'; // End of day names; prepare for day numbers
301     // For the table display. $week is the row; $dayweek is the column.
302     $dayweek = $startwday;
304     // Paddding (the first week may have blank days in the beginning)
305     for($i = $display->minwday; $i < $startwday; ++$i) {
306         $content .= '<td class="dayblank">&nbsp;</td>'."\n";
307     }
309     $weekend = CALENDAR_DEFAULT_WEEKEND;
310     if (isset($CFG->calendar_weekend)) {
311         $weekend = intval($CFG->calendar_weekend);
312     }
314     // Now display all the calendar
315     for($day = 1; $day <= $display->maxdays; ++$day, ++$dayweek) {
316         if($dayweek > $display->maxwday) {
317             // We need to change week (table row)
318             $content .= '</tr><tr>';
319             $dayweek = $display->minwday;
320         }
322         // Reset vars
323         $cell = '';
324         if ($weekend & (1 << ($dayweek % 7))) {
325             // Weekend. This is true no matter what the exact range is.
326             $class = 'weekend day';
327         } else {
328             // Normal working day.
329             $class = 'day';
330         }
332         // Special visual fx if an event is defined
333         if(isset($eventsbyday[$day])) {
334             $class .= ' hasevent';
335             $hrefparams['view'] = 'day';
336             $dayhref = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', $hrefparams), $day, $m, $y);
338             $popupcontent = '';
339             foreach($eventsbyday[$day] as $eventid) {
340                 if (!isset($events[$eventid])) {
341                     continue;
342                 }
343                 $event = new calendar_event($events[$eventid]);
344                 $popupalt  = '';
345                 $component = 'moodle';
346                 if(!empty($event->modulename)) {
347                     $popupicon = 'icon';
348                     $popupalt  = $event->modulename;
349                     $component = $event->modulename;
350                 } else if ($event->courseid == SITEID) {                                // Site event
351                     $popupicon = 'i/siteevent';
352                 } else if ($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) {      // Course event
353                     $popupicon = 'i/courseevent';
354                 } else if ($event->groupid) {                                      // Group event
355                     $popupicon = 'i/groupevent';
356                 } else if ($event->userid) {                                       // User event
357                     $popupicon = 'i/userevent';
358                 }
360                 $dayhref->set_anchor('event_'.$event->id);
362                 $popupcontent .= html_writer::start_tag('div');
363                 $popupcontent .= $OUTPUT->pix_icon($popupicon, $popupalt, $component);
364                 $name = format_string($event->name, true);
365                 // Show ical source if needed.
366                 if (!empty($event->subscription) && $CFG->calendar_showicalsource) {
367                     $a = new stdClass();
368                     $a->name = $name;
369                     $a->source = $event->subscription->name;
370                     $name = get_string('namewithsource', 'calendar', $a);
371                 }
372                 $popupcontent .= html_writer::link($dayhref, $name);
373                 $popupcontent .= html_writer::end_tag('div');
374             }
376             //Accessibility: functionality moved to calendar_get_popup.
377             if($display->thismonth && $day == $d) {
378                 $popupid = calendar_get_popup(true, $events[$eventid]->timestart, $popupcontent);
379             } else {
380                 $popupid = calendar_get_popup(false, $events[$eventid]->timestart, $popupcontent);
381             }
383             // Class and cell content
384             if(isset($typesbyday[$day]['startglobal'])) {
385                 $class .= ' calendar_event_global';
386             } else if(isset($typesbyday[$day]['startcourse'])) {
387                 $class .= ' calendar_event_course';
388             } else if(isset($typesbyday[$day]['startgroup'])) {
389                 $class .= ' calendar_event_group';
390             } else if(isset($typesbyday[$day]['startuser'])) {
391                 $class .= ' calendar_event_user';
392             }
393             $cell = html_writer::link($dayhref, $day, array('aria-controls' => $popupid.'_panel', 'id' => $popupid));
394         } else {
395             $cell = $day;
396         }
398         $durationclass = false;
399         if (isset($typesbyday[$day]['durationglobal'])) {
400             $durationclass = ' duration_global';
401         } else if(isset($typesbyday[$day]['durationcourse'])) {
402             $durationclass = ' duration_course';
403         } else if(isset($typesbyday[$day]['durationgroup'])) {
404             $durationclass = ' duration_group';
405         } else if(isset($typesbyday[$day]['durationuser'])) {
406             $durationclass = ' duration_user';
407         }
408         if ($durationclass) {
409             $class .= ' duration '.$durationclass;
410         }
412         // If event has a class set then add it to the table day <td> tag
413         // Note: only one colour for minicalendar
414         if(isset($eventsbyday[$day])) {
415             foreach($eventsbyday[$day] as $eventid) {
416                 if (!isset($events[$eventid])) {
417                     continue;
418                 }
419                 $event = $events[$eventid];
420                 if (!empty($event->class)) {
421                     $class .= ' '.$event->class;
422                 }
423                 break;
424             }
425         }
427         // Special visual fx for today
428         //Accessibility: hidden text for today, and popup.
429         if($display->thismonth && $day == $d) {
430             $class .= ' today';
431             $today = get_string('today', 'calendar').' '.userdate(time(), get_string('strftimedayshort'));
433             if(! isset($eventsbyday[$day])) {
434                 $class .= ' eventnone';
435                 $popupid = calendar_get_popup(true, false);
436                 $cell = html_writer::link('#', $day, array('aria-controls' => $popupid.'_panel', 'id' => $popupid));
437             }
438             $cell = get_accesshide($today.' ').$cell;
439         }
441         // Just display it
442         if(!empty($class)) {
443             $class = ' class="'.$class.'"';
444         }
445         $content .= '<td'.$class.'>'.$cell."</td>\n";
446     }
448     // Paddding (the last week may have blank days at the end)
449     for($i = $dayweek; $i <= $display->maxwday; ++$i) {
450         $content .= '<td class="dayblank">&nbsp;</td>';
451     }
452     $content .= '</tr>'; // Last row ends
454     $content .= '</table>'; // Tabular display of days ends
456     return $content;
459 /**
460  * Gets the calendar popup
461  *
462  * It called at multiple points in from calendar_get_mini.
463  * Copied and modified from calendar_get_mini.
464  *
465  * @param bool $is_today false except when called on the current day.
466  * @param mixed $event_timestart $events[$eventid]->timestart, OR false if there are no events.
467  * @param string $popupcontent content for the popup window/layout.
468  * @return string eventid for the calendar_tooltip popup window/layout.
469  */
470 function calendar_get_popup($is_today, $event_timestart, $popupcontent='') {
471     global $PAGE;
472     static $popupcount;
473     if ($popupcount === null) {
474         $popupcount = 1;
475     }
476     $popupcaption = '';
477     if($is_today) {
478         $popupcaption = get_string('today', 'calendar').' ';
479     }
480     if (false === $event_timestart) {
481         $popupcaption .= userdate(time(), get_string('strftimedayshort'));
482         $popupcontent = get_string('eventnone', 'calendar');
484     } else {
485         $popupcaption .= get_string('eventsfor', 'calendar', userdate($event_timestart, get_string('strftimedayshort')));
486     }
487     $id = 'calendar_tooltip_'.$popupcount;
488     $PAGE->requires->yui_module('moodle-calendar-eventmanager', 'M.core_calendar.add_event', array(array('eventId'=>$id,'title'=>$popupcaption, 'content'=>$popupcontent)));
490     $popupcount++;
491     return $id;
494 /**
495  * Gets the calendar upcoming event
496  *
497  * @param array $courses array of courses
498  * @param array|int|bool $groups array of groups, group id or boolean for all/no group events
499  * @param array|int|bool $users array of users, user id or boolean for all/no user events
500  * @param int $daysinfuture number of days in the future we 'll look
501  * @param int $maxevents maximum number of events
502  * @param int $fromtime start time
503  * @return array $output array of upcoming events
504  */
505 function calendar_get_upcoming($courses, $groups, $users, $daysinfuture, $maxevents, $fromtime=0) {
506     global $CFG, $COURSE, $DB;
508     $display = new stdClass;
509     $display->range = $daysinfuture; // How many days in the future we 'll look
510     $display->maxevents = $maxevents;
512     $output = array();
514     // Prepare "course caching", since it may save us a lot of queries
515     $coursecache = array();
517     $processed = 0;
518     $now = time(); // We 'll need this later
519     $usermidnighttoday = usergetmidnight($now);
521     if ($fromtime) {
522         $display->tstart = $fromtime;
523     } else {
524         $display->tstart = $usermidnighttoday;
525     }
527     // This works correctly with respect to the user's DST, but it is accurate
528     // only because $fromtime is always the exact midnight of some day!
529     $display->tend = usergetmidnight($display->tstart + DAYSECS * $display->range + 3 * HOURSECS) - 1;
531     // Get the events matching our criteria
532     $events = calendar_get_events($display->tstart, $display->tend, $users, $groups, $courses);
534     // This is either a genius idea or an idiot idea: in order to not complicate things, we use this rule: if, after
535     // possibly removing SITEID from $courses, there is only one course left, then clicking on a day in the month
536     // will also set the $SESSION->cal_courses_shown variable to that one course. Otherwise, we 'd need to add extra
537     // arguments to this function.
539     $hrefparams = array();
540     if(!empty($courses)) {
541         $courses = array_diff($courses, array(SITEID));
542         if(count($courses) == 1) {
543             $hrefparams['course'] = reset($courses);
544         }
545     }
547     if ($events !== false) {
549         $modinfo = get_fast_modinfo($COURSE);
551         foreach($events as $event) {
554             if (!empty($event->modulename)) {
555                 if ($event->courseid == $COURSE->id) {
556                     if (isset($modinfo->instances[$event->modulename][$event->instance])) {
557                         $cm = $modinfo->instances[$event->modulename][$event->instance];
558                         if (!$cm->uservisible) {
559                             continue;
560                         }
561                     }
562                 } else {
563                     if (!$cm = get_coursemodule_from_instance($event->modulename, $event->instance)) {
564                         continue;
565                     }
566                     if (!coursemodule_visible_for_user($cm)) {
567                         continue;
568                     }
569                 }
570                 if ($event->modulename == 'assignment'){
571                     // create calendar_event to test edit_event capability
572                     // this new event will also prevent double creation of calendar_event object
573                     $checkevent = new calendar_event($event);
574                     // TODO: rewrite this hack somehow
575                     if (!calendar_edit_event_allowed($checkevent)){ // cannot manage entries, eg. student
576                         if (!$assignment = $DB->get_record('assignment', array('id'=>$event->instance))) {
577                             // print_error("invalidid", 'assignment');
578                             continue;
579                         }
580                         // assign assignment to assignment object to use hidden_is_hidden method
581                         require_once($CFG->dirroot.'/mod/assignment/lib.php');
583                         if (!file_exists($CFG->dirroot.'/mod/assignment/type/'.$assignment->assignmenttype.'/assignment.class.php')) {
584                             continue;
585                         }
586                         require_once ($CFG->dirroot.'/mod/assignment/type/'.$assignment->assignmenttype.'/assignment.class.php');
588                         $assignmentclass = 'assignment_'.$assignment->assignmenttype;
589                         $assignmentinstance = new $assignmentclass($cm->id, $assignment, $cm);
591                         if ($assignmentinstance->description_is_hidden()){//force not to show description before availability
592                             $event->description = get_string('notavailableyet', 'assignment');
593                         }
594                     }
595                 }
596             }
598             if ($processed >= $display->maxevents) {
599                 break;
600             }
602             $event->time = calendar_format_event_time($event, $now, $hrefparams);
603             $output[] = $event;
604             ++$processed;
605         }
606     }
607     return $output;
611 /**
612  * Get a HTML link to a course 
613  *
614  * @param int $courseid the course id
615  * @return string a link to the course (as HTML); empty if the course id is invalid
616  */
617 function calendar_get_courselink($courseid) {
619     if (!$courseid) {
620         return '';
621     }
623     calendar_get_course_cached($coursecache, $courseid);    
624     $context = context_course::instance($courseid);
625     $fullname = format_string($coursecache[$courseid]->fullname, true, array('context' => $context));
626     $url = new moodle_url('/course/view.php', array('id' => $courseid));
627     $link = html_writer::link($url, $fullname);
629     return $link;
633 /**
634  * Add calendar event metadata
635  *
636  * @param stdClass $event event info
637  * @return stdClass $event metadata
638  */
639 function calendar_add_event_metadata($event) {
640     global $CFG, $OUTPUT;
642     //Support multilang in event->name
643     $event->name = format_string($event->name,true);
645     if(!empty($event->modulename)) {                                // Activity event
646         // The module name is set. I will assume that it has to be displayed, and
647         // also that it is an automatically-generated event. And of course that the
648         // fields for get_coursemodule_from_instance are set correctly.
649         $module = calendar_get_module_cached($coursecache, $event->modulename, $event->instance);
651         if ($module === false) {
652             return;
653         }
655         $modulename = get_string('modulename', $event->modulename);
656         if (get_string_manager()->string_exists($event->eventtype, $event->modulename)) {
657             // will be used as alt text if the event icon
658             $eventtype = get_string($event->eventtype, $event->modulename);
659         } else {
660             $eventtype = '';
661         }
662         $icon = $OUTPUT->pix_url('icon', $event->modulename) . '';
664         $event->icon = '<img src="'.$icon.'" alt="'.$eventtype.'" title="'.$modulename.'" class="icon" />';
665         $event->referer = '<a href="'.$CFG->wwwroot.'/mod/'.$event->modulename.'/view.php?id='.$module->id.'">'.$event->name.'</a>';
666         $event->courselink = calendar_get_courselink($module->course);
667         $event->cmid = $module->id;
669     } else if($event->courseid == SITEID) {                              // Site event
670         $event->icon = '<img src="'.$OUTPUT->pix_url('i/siteevent') . '" alt="'.get_string('globalevent', 'calendar').'" class="icon" />';
671         $event->cssclass = 'calendar_event_global';
672     } else if($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) {          // Course event
673         $event->icon = '<img src="'.$OUTPUT->pix_url('i/courseevent') . '" alt="'.get_string('courseevent', 'calendar').'" class="icon" />';
674         $event->courselink = calendar_get_courselink($event->courseid);
675         $event->cssclass = 'calendar_event_course';
676     } else if ($event->groupid) {                                    // Group event
677         $event->icon = '<img src="'.$OUTPUT->pix_url('i/groupevent') . '" alt="'.get_string('groupevent', 'calendar').'" class="icon" />';
678         $event->courselink = calendar_get_courselink($event->courseid);
679         $event->cssclass = 'calendar_event_group';
680     } else if($event->userid) {                                      // User event
681         $event->icon = '<img src="'.$OUTPUT->pix_url('i/userevent') . '" alt="'.get_string('userevent', 'calendar').'" class="icon" />';
682         $event->cssclass = 'calendar_event_user';
683     }
684     return $event;
687 /**
688  * Get calendar events
689  *
690  * @param int $tstart Start time of time range for events
691  * @param int $tend End time of time range for events
692  * @param array|int|boolean $users array of users, user id or boolean for all/no user events
693  * @param array|int|boolean $groups array of groups, group id or boolean for all/no group events
694  * @param array|int|boolean $courses array of courses, course id or boolean for all/no course events
695  * @param boolean $withduration whether only events starting within time range selected
696  *                              or events in progress/already started selected as well
697  * @param boolean $ignorehidden whether to select only visible events or all events
698  * @return array $events of selected events or an empty array if there aren't any (or there was an error)
699  */
700 function calendar_get_events($tstart, $tend, $users, $groups, $courses, $withduration=true, $ignorehidden=true) {
701     global $DB;
703     $whereclause = '';
704     // Quick test
705     if(is_bool($users) && is_bool($groups) && is_bool($courses)) {
706         return array();
707     }
709     if(is_array($users) && !empty($users)) {
710         // Events from a number of users
711         if(!empty($whereclause)) $whereclause .= ' OR';
712         $whereclause .= ' (userid IN ('.implode(',', $users).') AND courseid = 0 AND groupid = 0)';
713     } else if(is_numeric($users)) {
714         // Events from one user
715         if(!empty($whereclause)) $whereclause .= ' OR';
716         $whereclause .= ' (userid = '.$users.' AND courseid = 0 AND groupid = 0)';
717     } else if($users === true) {
718         // Events from ALL users
719         if(!empty($whereclause)) $whereclause .= ' OR';
720         $whereclause .= ' (userid != 0 AND courseid = 0 AND groupid = 0)';
721     } else if($users === false) {
722         // No user at all, do nothing
723     }
725     if(is_array($groups) && !empty($groups)) {
726         // Events from a number of groups
727         if(!empty($whereclause)) $whereclause .= ' OR';
728         $whereclause .= ' groupid IN ('.implode(',', $groups).')';
729     } else if(is_numeric($groups)) {
730         // Events from one group
731         if(!empty($whereclause)) $whereclause .= ' OR ';
732         $whereclause .= ' groupid = '.$groups;
733     } else if($groups === true) {
734         // Events from ALL groups
735         if(!empty($whereclause)) $whereclause .= ' OR ';
736         $whereclause .= ' groupid != 0';
737     }
738     // boolean false (no groups at all): we don't need to do anything
740     if(is_array($courses) && !empty($courses)) {
741         if(!empty($whereclause)) {
742             $whereclause .= ' OR';
743         }
744         $whereclause .= ' (groupid = 0 AND courseid IN ('.implode(',', $courses).'))';
745     } else if(is_numeric($courses)) {
746         // One course
747         if(!empty($whereclause)) $whereclause .= ' OR';
748         $whereclause .= ' (groupid = 0 AND courseid = '.$courses.')';
749     } else if ($courses === true) {
750         // Events from ALL courses
751         if(!empty($whereclause)) $whereclause .= ' OR';
752         $whereclause .= ' (groupid = 0 AND courseid != 0)';
753     }
755     // Security check: if, by now, we have NOTHING in $whereclause, then it means
756     // that NO event-selecting clauses were defined. Thus, we won't be returning ANY
757     // events no matter what. Allowing the code to proceed might return a completely
758     // valid query with only time constraints, thus selecting ALL events in that time frame!
759     if(empty($whereclause)) {
760         return array();
761     }
763     if($withduration) {
764         $timeclause = '(timestart >= '.$tstart.' OR timestart + timeduration > '.$tstart.') AND timestart <= '.$tend;
765     }
766     else {
767         $timeclause = 'timestart >= '.$tstart.' AND timestart <= '.$tend;
768     }
769     if(!empty($whereclause)) {
770         // We have additional constraints
771         $whereclause = $timeclause.' AND ('.$whereclause.')';
772     }
773     else {
774         // Just basic time filtering
775         $whereclause = $timeclause;
776     }
778     if ($ignorehidden) {
779         $whereclause .= ' AND visible = 1';
780     }
782     $events = $DB->get_records_select('event', $whereclause, null, 'timestart');
783     if ($events === false) {
784         $events = array();
785     }
786     return $events;
789 /** Get calendar events by id
790  *
791  * @since Moodle 2.5
792  * @param array $eventids list of event ids
793  * @return array Array of event entries, empty array if nothing found
794  */
796 function calendar_get_events_by_id($eventids) {
797     global $DB;
799     if (!is_array($eventids) || empty($eventids)) {
800         return array();
801     }
802     list($wheresql, $params) = $DB->get_in_or_equal($eventids);
803     $wheresql = "id $wheresql";
805     return $DB->get_records_select('event', $wheresql, $params);
808 /**
809  * Get control options for Calendar
810  *
811  * @param string $type of calendar
812  * @param array $data calendar information
813  * @return string $content return available control for the calender in html
814  */
815 function calendar_top_controls($type, $data) {
816     global $CFG, $PAGE;
817     $content = '';
818     if(!isset($data['d'])) {
819         $data['d'] = 1;
820     }
822     // Ensure course id passed if relevant
823     // Required due to changes in view/lib.php mainly (calendar_session_vars())
824     $courseid = '';
825     if (!empty($data['id'])) {
826         $courseid = '&amp;course='.$data['id'];
827     }
829     if(!checkdate($data['m'], $data['d'], $data['y'])) {
830         $time = time();
831     }
832     else {
833         $time = make_timestamp($data['y'], $data['m'], $data['d']);
834     }
835     $date = usergetdate($time);
837     $data['m'] = $date['mon'];
838     $data['y'] = $date['year'];
839     $urlbase = $PAGE->url;
841     //Accessibility: calendar block controls, replaced <table> with <div>.
842     //$nexttext = link_arrow_right(get_string('monthnext', 'access'), $url='', $accesshide=true);
843     //$prevtext = link_arrow_left(get_string('monthprev', 'access'), $url='', $accesshide=true);
845     switch($type) {
846         case 'frontpage':
847             list($prevmonth, $prevyear) = calendar_sub_month($data['m'], $data['y']);
848             list($nextmonth, $nextyear) = calendar_add_month($data['m'], $data['y']);
849             $nextlink = calendar_get_link_next(get_string('monthnext', 'access'), $urlbase, 0, $nextmonth, $nextyear, true);
850             $prevlink = calendar_get_link_previous(get_string('monthprev', 'access'), $urlbase, 0, $prevmonth, $prevyear, true);
852             $calendarlink = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', array('view'=>'month')), 1, $data['m'], $data['y']);
853             if (!empty($data['id'])) {
854                 $calendarlink->param('course', $data['id']);
855             }
857             if (right_to_left()) {
858                 $left = $nextlink;
859                 $right = $prevlink;
860             } else {
861                 $left = $prevlink;
862                 $right = $nextlink;
863             }
865             $content .= html_writer::start_tag('div', array('class'=>'calendar-controls'));
866             $content .= $left.'<span class="hide"> | </span>';
867             $content .= html_writer::tag('span', html_writer::link($calendarlink, userdate($time, get_string('strftimemonthyear')), array('title'=>get_string('monththis','calendar'))), array('class'=>'current'));
868             $content .= '<span class="hide"> | </span>'. $right;
869             $content .= "<span class=\"clearer\"><!-- --></span>\n";
870             $content .= html_writer::end_tag('div');
872             break;
873         case 'course':
874             list($prevmonth, $prevyear) = calendar_sub_month($data['m'], $data['y']);
875             list($nextmonth, $nextyear) = calendar_add_month($data['m'], $data['y']);
876             $nextlink = calendar_get_link_next(get_string('monthnext', 'access'), $urlbase, 0, $nextmonth, $nextyear, true);
877             $prevlink = calendar_get_link_previous(get_string('monthprev', 'access'), $urlbase, 0, $prevmonth, $prevyear, true);
879             $calendarlink = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', array('view'=>'month')), 1, $data['m'], $data['y']);
880             if (!empty($data['id'])) {
881                 $calendarlink->param('course', $data['id']);
882             }
884             if (right_to_left()) {
885                 $left = $nextlink;
886                 $right = $prevlink;
887             } else {
888                 $left = $prevlink;
889                 $right = $nextlink;
890             }
892             $content .= html_writer::start_tag('div', array('class'=>'calendar-controls'));
893             $content .= $left.'<span class="hide"> | </span>';
894             $content .= html_writer::tag('span', html_writer::link($calendarlink, userdate($time, get_string('strftimemonthyear')), array('title'=>get_string('monththis','calendar'))), array('class'=>'current'));
895             $content .= '<span class="hide"> | </span>'. $right;
896             $content .= "<span class=\"clearer\"><!-- --></span>";
897             $content .= html_writer::end_tag('div');
898             break;
899         case 'upcoming':
900             $calendarlink = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', array('view'=>'upcoming')), 1, $data['m'], $data['y']);
901             if (!empty($data['id'])) {
902                 $calendarlink->param('course', $data['id']);
903             }
904             $calendarlink = html_writer::link($calendarlink, userdate($time, get_string('strftimemonthyear')));
905             $content .= html_writer::tag('div', $calendarlink, array('class'=>'centered'));
906             break;
907         case 'display':
908             $calendarlink = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', array('view'=>'month')), 1, $data['m'], $data['y']);
909             if (!empty($data['id'])) {
910                 $calendarlink->param('course', $data['id']);
911             }
912             $calendarlink = html_writer::link($calendarlink, userdate($time, get_string('strftimemonthyear')));
913             $content .= html_writer::tag('h3', $calendarlink);
914             break;
915         case 'month':
916             list($prevmonth, $prevyear) = calendar_sub_month($data['m'], $data['y']);
917             list($nextmonth, $nextyear) = calendar_add_month($data['m'], $data['y']);
918             $prevdate = make_timestamp($prevyear, $prevmonth, 1);
919             $nextdate = make_timestamp($nextyear, $nextmonth, 1);
920             $prevlink = calendar_get_link_previous(userdate($prevdate, get_string('strftimemonthyear')), 'view.php?view=month'.$courseid.'&amp;', 1, $prevmonth, $prevyear);
921             $nextlink = calendar_get_link_next(userdate($nextdate, get_string('strftimemonthyear')), 'view.php?view=month'.$courseid.'&amp;', 1, $nextmonth, $nextyear);
923             if (right_to_left()) {
924                 $left = $nextlink;
925                 $right = $prevlink;
926             } else {
927                 $left = $prevlink;
928                 $right = $nextlink;
929             }
931             $content .= html_writer::start_tag('div', array('class'=>'calendar-controls'));
932             $content .= $left . '<span class="hide"> | </span><h1 class="current">'.userdate($time, get_string('strftimemonthyear'))."</h1>";
933             $content .= '<span class="hide"> | </span>' . $right;
934             $content .= '<span class="clearer"><!-- --></span>';
935             $content .= html_writer::end_tag('div')."\n";
936             break;
937         case 'day':
938             $days = calendar_get_days();
939             $data['d'] = $date['mday']; // Just for convenience
940             $prevdate = usergetdate(make_timestamp($data['y'], $data['m'], $data['d'] - 1));
941             $nextdate = usergetdate(make_timestamp($data['y'], $data['m'], $data['d'] + 1));
942             $prevname = calendar_wday_name($days[$prevdate['wday']]);
943             $nextname = calendar_wday_name($days[$nextdate['wday']]);
944             $prevlink = calendar_get_link_previous($prevname, 'view.php?view=day'.$courseid.'&amp;', $prevdate['mday'], $prevdate['mon'], $prevdate['year']);
945             $nextlink = calendar_get_link_next($nextname, 'view.php?view=day'.$courseid.'&amp;', $nextdate['mday'], $nextdate['mon'], $nextdate['year']);
947             if (right_to_left()) {
948                 $left = $nextlink;
949                 $right = $prevlink;
950             } else {
951                 $left = $prevlink;
952                 $right = $nextlink;
953             }
955             $content .= html_writer::start_tag('div', array('class'=>'calendar-controls'));
956             $content .= $left;
957             $content .= '<span class="hide"> | </span><span class="current">'.userdate($time, get_string('strftimedaydate')).'</span>';
958             $content .= '<span class="hide"> | </span>'. $right;
959             $content .= "<span class=\"clearer\"><!-- --></span>";
960             $content .= html_writer::end_tag('div')."\n";
962             break;
963     }
964     return $content;
967 /**
968  * Formats a filter control element.
969  *
970  * @param moodle_url $url of the filter
971  * @param int $type constant defining the type filter
972  * @return string html content of the element
973  */
974 function calendar_filter_controls_element(moodle_url $url, $type) {
975     global $OUTPUT;
976     switch ($type) {
977         case CALENDAR_EVENT_GLOBAL:
978             $typeforhumans = 'global';
979             $class = 'calendar_event_global';
980             break;
981         case CALENDAR_EVENT_COURSE:
982             $typeforhumans = 'course';
983             $class = 'calendar_event_course';
984             break;
985         case CALENDAR_EVENT_GROUP:
986             $typeforhumans = 'groups';
987             $class = 'calendar_event_group';
988             break;
989         case CALENDAR_EVENT_USER:
990             $typeforhumans = 'user';
991             $class = 'calendar_event_user';
992             break;
993     }
994     if (calendar_show_event_type($type)) {
995         $icon = $OUTPUT->pix_icon('t/hide', get_string('hide'));
996         $str = get_string('hide'.$typeforhumans.'events', 'calendar');
997     } else {
998         $icon = $OUTPUT->pix_icon('t/show', get_string('show'));
999         $str = get_string('show'.$typeforhumans.'events', 'calendar');
1000     }
1001     $content = html_writer::start_tag('li', array('class' => 'calendar_event'));
1002     $content .= html_writer::start_tag('a', array('href' => $url));
1003     $content .= html_writer::tag('span', $icon, array('class' => $class));
1004     $content .= html_writer::tag('span', $str, array('class' => 'eventname'));
1005     $content .= html_writer::end_tag('a');
1006     $content .= html_writer::end_tag('li');
1007     return $content;
1010 /**
1011  * Get the controls filter for calendar.
1012  *
1013  * Filter is used to hide calendar info from the display page
1014  *
1015  * @param moodle_url $returnurl return-url for filter controls
1016  * @return string $content return filter controls in html
1017  */
1018 function calendar_filter_controls(moodle_url $returnurl) {
1019     global $CFG, $USER, $OUTPUT;
1021     $groupevents = true;
1022     $id = optional_param( 'id',0,PARAM_INT );
1023     $seturl = new moodle_url('/calendar/set.php', array('return' => base64_encode($returnurl->out(false)), 'sesskey'=>sesskey()));
1024     $content = html_writer::start_tag('ul');
1026     $seturl->param('var', 'showglobal');
1027     $content .= calendar_filter_controls_element($seturl, CALENDAR_EVENT_GLOBAL);
1029     $seturl->param('var', 'showcourses');
1030     $content .= calendar_filter_controls_element($seturl, CALENDAR_EVENT_COURSE);
1032     if (isloggedin() && !isguestuser()) {
1033         if ($groupevents) {
1034             // This course MIGHT have group events defined, so show the filter
1035             $seturl->param('var', 'showgroups');
1036             $content .= calendar_filter_controls_element($seturl, CALENDAR_EVENT_GROUP);
1037         } else {
1038             // This course CANNOT have group events, so lose the filter
1039         }
1040         $seturl->param('var', 'showuser');
1041         $content .= calendar_filter_controls_element($seturl, CALENDAR_EVENT_USER);
1042     }
1043     $content .= html_writer::end_tag('ul');
1045     return $content;
1048 /**
1049  * Return the representation day
1050  *
1051  * @param int $tstamp Timestamp in GMT
1052  * @param int $now current Unix timestamp
1053  * @param bool $usecommonwords
1054  * @return string the formatted date/time
1055  */
1056 function calendar_day_representation($tstamp, $now = false, $usecommonwords = true) {
1058     static $shortformat;
1059     if(empty($shortformat)) {
1060         $shortformat = get_string('strftimedayshort');
1061     }
1063     if($now === false) {
1064         $now = time();
1065     }
1067     // To have it in one place, if a change is needed
1068     $formal = userdate($tstamp, $shortformat);
1070     $datestamp = usergetdate($tstamp);
1071     $datenow   = usergetdate($now);
1073     if($usecommonwords == false) {
1074         // We don't want words, just a date
1075         return $formal;
1076     }
1077     else if($datestamp['year'] == $datenow['year'] && $datestamp['yday'] == $datenow['yday']) {
1078         // Today
1079         return get_string('today', 'calendar');
1080     }
1081     else if(
1082         ($datestamp['year'] == $datenow['year'] && $datestamp['yday'] == $datenow['yday'] - 1 ) ||
1083         ($datestamp['year'] == $datenow['year'] - 1 && $datestamp['mday'] == 31 && $datestamp['mon'] == 12 && $datenow['yday'] == 1)
1084         ) {
1085         // Yesterday
1086         return get_string('yesterday', 'calendar');
1087     }
1088     else if(
1089         ($datestamp['year'] == $datenow['year'] && $datestamp['yday'] == $datenow['yday'] + 1 ) ||
1090         ($datestamp['year'] == $datenow['year'] + 1 && $datenow['mday'] == 31 && $datenow['mon'] == 12 && $datestamp['yday'] == 1)
1091         ) {
1092         // Tomorrow
1093         return get_string('tomorrow', 'calendar');
1094     }
1095     else {
1096         return $formal;
1097     }
1100 /**
1101  * return the formatted representation time
1102  *
1103  * @param int $time the timestamp in UTC, as obtained from the database
1104  * @return string the formatted date/time
1105  */
1106 function calendar_time_representation($time) {
1107     static $langtimeformat = NULL;
1108     if($langtimeformat === NULL) {
1109         $langtimeformat = get_string('strftimetime');
1110     }
1111     $timeformat = get_user_preferences('calendar_timeformat');
1112     if(empty($timeformat)){
1113         $timeformat = get_config(NULL,'calendar_site_timeformat');
1114     }
1115     // The ? is needed because the preference might be present, but empty
1116     return userdate($time, empty($timeformat) ? $langtimeformat : $timeformat);
1119 /**
1120  * Adds day, month, year arguments to a URL and returns a moodle_url object.
1121  *
1122  * @param string|moodle_url $linkbase
1123  * @param int $d The number of the day.
1124  * @param int $m The number of the month.
1125  * @param int $y The number of the year.
1126  * @return moodle_url|null $linkbase
1127  */
1128 function calendar_get_link_href($linkbase, $d, $m, $y) {
1129     if (empty($linkbase)) {
1130         return '';
1131     }
1132     if (!($linkbase instanceof moodle_url)) {
1133         $linkbase = new moodle_url($linkbase);
1134     }
1135     if (!empty($d)) {
1136         $linkbase->param('cal_d', $d);
1137     }
1138     if (!empty($m)) {
1139         $linkbase->param('cal_m', $m);
1140     }
1141     if (!empty($y)) {
1142         $linkbase->param('cal_y', $y);
1143     }
1144     return $linkbase;
1147 /**
1148  * Build and return a previous month HTML link, with an arrow.
1149  *
1150  * @param string $text The text label.
1151  * @param string|moodle_url $linkbase The URL stub.
1152  * @param int $d The number of the date.
1153  * @param int $m The number of the month.
1154  * @param int $y year The number of the year.
1155  * @param bool $accesshide Default visible, or hide from all except screenreaders.
1156  * @return string HTML string.
1157  */
1158 function calendar_get_link_previous($text, $linkbase, $d, $m, $y, $accesshide=false) {
1159     $href = calendar_get_link_href(new moodle_url($linkbase), $d, $m, $y);
1160     if (empty($href)) {
1161         return $text;
1162     }
1163     return link_arrow_left($text, (string)$href, $accesshide, 'previous');
1166 /**
1167  * Build and return a next month HTML link, with an arrow.
1168  *
1169  * @param string $text The text label.
1170  * @param string|moodle_url $linkbase The URL stub.
1171  * @param int $d the number of the Day
1172  * @param int $m The number of the month.
1173  * @param int $y The number of the year.
1174  * @param bool $accesshide Default visible, or hide from all except screenreaders.
1175  * @return string HTML string.
1176  */
1177 function calendar_get_link_next($text, $linkbase, $d, $m, $y, $accesshide=false) {
1178     $href = calendar_get_link_href(new moodle_url($linkbase), $d, $m, $y);
1179     if (empty($href)) {
1180         return $text;
1181     }
1182     return link_arrow_right($text, (string)$href, $accesshide, 'next');
1185 /**
1186  * Return the name of the weekday
1187  *
1188  * @param string $englishname
1189  * @return string of the weekeday
1190  */
1191 function calendar_wday_name($englishname) {
1192     return get_string(strtolower($englishname), 'calendar');
1195 /**
1196  * Return the number of days in month
1197  *
1198  * @param int $month the number of the month.
1199  * @param int $year the number of the year
1200  * @return int
1201  */
1202 function calendar_days_in_month($month, $year) {
1203    return intval(date('t', mktime(0, 0, 0, $month, 1, $year)));
1206 /**
1207  * Get the upcoming event block
1208  *
1209  * @param array $events list of events
1210  * @param moodle_url|string $linkhref link to event referer
1211  * @param boolean $showcourselink whether links to courses should be shown
1212  * @return string|null $content html block content
1213  */
1214 function calendar_get_block_upcoming($events, $linkhref = NULL, $showcourselink = false) {
1215     $content = '';
1216     $lines = count($events);
1217     if (!$lines) {
1218         return $content;
1219     }
1221     for ($i = 0; $i < $lines; ++$i) {
1222         if (!isset($events[$i]->time)) {   // Just for robustness
1223             continue;
1224         }
1225         $events[$i] = calendar_add_event_metadata($events[$i]);
1226         $content .= '<div class="event"><span class="icon c0">'.$events[$i]->icon.'</span>';
1227         if (!empty($events[$i]->referer)) {
1228             // That's an activity event, so let's provide the hyperlink
1229             $content .= $events[$i]->referer;
1230         } else {
1231             if(!empty($linkhref)) {
1232                 $ed = usergetdate($events[$i]->timestart);
1233                 $href = calendar_get_link_href(new moodle_url(CALENDAR_URL.$linkhref), $ed['mday'], $ed['mon'], $ed['year']);
1234                 $href->set_anchor('event_'.$events[$i]->id);
1235                 $content .= html_writer::link($href, $events[$i]->name);
1236             }
1237             else {
1238                 $content .= $events[$i]->name;
1239             }
1240         }
1241         $events[$i]->time = str_replace('&raquo;', '<br />&raquo;', $events[$i]->time);
1242         if ($showcourselink && !empty($events[$i]->courselink)) {
1243             $content .= html_writer::div($events[$i]->courselink, 'course');
1244         }
1245         $content .= '<div class="date">'.$events[$i]->time.'</div></div>';
1246         if ($i < $lines - 1) $content .= '<hr />';
1247     }
1249     return $content;
1252 /**
1253  * Get the next following month
1254  *
1255  * If the current month is December, it will get the first month of the following year.
1256  *
1257  *
1258  * @param int $month the number of the month.
1259  * @param int $year the number of the year.
1260  * @return array the following month
1261  */
1262 function calendar_add_month($month, $year) {
1263     if($month == 12) {
1264         return array(1, $year + 1);
1265     }
1266     else {
1267         return array($month + 1, $year);
1268     }
1271 /**
1272  * Get the previous month
1273  *
1274  * If the current month is January, it will get the last month of the previous year.
1275  *
1276  * @param int $month the number of the month.
1277  * @param int $year the number of the year.
1278  * @return array previous month
1279  */
1280 function calendar_sub_month($month, $year) {
1281     if($month == 1) {
1282         return array(12, $year - 1);
1283     }
1284     else {
1285         return array($month - 1, $year);
1286     }
1289 /**
1290  * Get per-day basis events
1291  *
1292  * @param array $events list of events
1293  * @param int $month the number of the month
1294  * @param int $year the number of the year
1295  * @param array $eventsbyday event on specific day
1296  * @param array $durationbyday duration of the event in days
1297  * @param array $typesbyday event type (eg: global, course, user, or group)
1298  * @param array $courses list of courses
1299  * @return void
1300  */
1301 function calendar_events_by_day($events, $month, $year, &$eventsbyday, &$durationbyday, &$typesbyday, &$courses) {
1302     $eventsbyday = array();
1303     $typesbyday = array();
1304     $durationbyday = array();
1306     if($events === false) {
1307         return;
1308     }
1310     foreach($events as $event) {
1312         $startdate = usergetdate($event->timestart);
1313         // Set end date = start date if no duration
1314         if ($event->timeduration) {
1315             $enddate   = usergetdate($event->timestart + $event->timeduration - 1);
1316         } else {
1317             $enddate = $startdate;
1318         }
1320         // Simple arithmetic: $year * 13 + $month is a distinct integer for each distinct ($year, $month) pair
1321         if(!($startdate['year'] * 13 + $startdate['mon'] <= $year * 13 + $month) && ($enddate['year'] * 13 + $enddate['mon'] >= $year * 13 + $month)) {
1322             // Out of bounds
1323             continue;
1324         }
1326         $eventdaystart = intval($startdate['mday']);
1328         if($startdate['mon'] == $month && $startdate['year'] == $year) {
1329             // Give the event to its day
1330             $eventsbyday[$eventdaystart][] = $event->id;
1332             // Mark the day as having such an event
1333             if($event->courseid == SITEID && $event->groupid == 0) {
1334                 $typesbyday[$eventdaystart]['startglobal'] = true;
1335                 // Set event class for global event
1336                 $events[$event->id]->class = 'calendar_event_global';
1337             }
1338             else if($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) {
1339                 $typesbyday[$eventdaystart]['startcourse'] = true;
1340                 // Set event class for course event
1341                 $events[$event->id]->class = 'calendar_event_course';
1342             }
1343             else if($event->groupid) {
1344                 $typesbyday[$eventdaystart]['startgroup'] = true;
1345                 // Set event class for group event
1346                 $events[$event->id]->class = 'calendar_event_group';
1347             }
1348             else if($event->userid) {
1349                 $typesbyday[$eventdaystart]['startuser'] = true;
1350                 // Set event class for user event
1351                 $events[$event->id]->class = 'calendar_event_user';
1352             }
1353         }
1355         if($event->timeduration == 0) {
1356             // Proceed with the next
1357             continue;
1358         }
1360         // The event starts on $month $year or before. So...
1361         $lowerbound = $startdate['mon'] == $month && $startdate['year'] == $year ? intval($startdate['mday']) : 0;
1363         // Also, it ends on $month $year or later...
1364         $upperbound = $enddate['mon'] == $month && $enddate['year'] == $year ? intval($enddate['mday']) : calendar_days_in_month($month, $year);
1366         // Mark all days between $lowerbound and $upperbound (inclusive) as duration
1367         for($i = $lowerbound + 1; $i <= $upperbound; ++$i) {
1368             $durationbyday[$i][] = $event->id;
1369             if($event->courseid == SITEID && $event->groupid == 0) {
1370                 $typesbyday[$i]['durationglobal'] = true;
1371             }
1372             else if($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) {
1373                 $typesbyday[$i]['durationcourse'] = true;
1374             }
1375             else if($event->groupid) {
1376                 $typesbyday[$i]['durationgroup'] = true;
1377             }
1378             else if($event->userid) {
1379                 $typesbyday[$i]['durationuser'] = true;
1380             }
1381         }
1383     }
1384     return;
1387 /**
1388  * Get current module cache
1389  *
1390  * @param array $coursecache list of course cache
1391  * @param string $modulename name of the module
1392  * @param int $instance module instance number
1393  * @return stdClass|bool $module information
1394  */
1395 function calendar_get_module_cached(&$coursecache, $modulename, $instance) {
1396     $module = get_coursemodule_from_instance($modulename, $instance);
1398     if($module === false) return false;
1399     if(!calendar_get_course_cached($coursecache, $module->course)) {
1400         return false;
1401     }
1402     return $module;
1405 /**
1406  * Get current course cache
1407  *
1408  * @param array $coursecache list of course cache
1409  * @param int $courseid id of the course
1410  * @return stdClass $coursecache[$courseid] return the specific course cache
1411  */
1412 function calendar_get_course_cached(&$coursecache, $courseid) {
1413     global $COURSE, $DB;
1415     if (!isset($coursecache[$courseid])) {
1416         if ($courseid == $COURSE->id) {
1417             $coursecache[$courseid] = $COURSE;
1418         } else {
1419             $coursecache[$courseid] = $DB->get_record('course', array('id'=>$courseid));
1420         }
1421     }
1422     return $coursecache[$courseid];
1425 /**
1426  * Returns the courses to load events for, the
1427  *
1428  * @param array $courseeventsfrom An array of courses to load calendar events for
1429  * @param bool $ignorefilters specify the use of filters, false is set as default
1430  * @return array An array of courses, groups, and user to load calendar events for based upon filters
1431  */
1432 function calendar_set_filters(array $courseeventsfrom, $ignorefilters = false) {
1433     global $USER, $CFG, $DB;
1435     // For backwards compatability we have to check whether the courses array contains
1436     // just id's in which case we need to load course objects.
1437     $coursestoload = array();
1438     foreach ($courseeventsfrom as $id => $something) {
1439         if (!is_object($something)) {
1440             $coursestoload[] = $id;
1441             unset($courseeventsfrom[$id]);
1442         }
1443     }
1444     if (!empty($coursestoload)) {
1445         // TODO remove this in 2.2
1446         debugging('calendar_set_filters now preferes an array of course objects with preloaded contexts', DEBUG_DEVELOPER);
1447         $courseeventsfrom = array_merge($courseeventsfrom, $DB->get_records_list('course', 'id', $coursestoload));
1448     }
1450     $courses = array();
1451     $user = false;
1452     $group = false;
1454     // capabilities that allow seeing group events from all groups
1455     // TODO: rewrite so that moodle/calendar:manageentries is not necessary here
1456     $allgroupscaps = array('moodle/site:accessallgroups', 'moodle/calendar:manageentries');
1458     $isloggedin = isloggedin();
1460     if ($ignorefilters || calendar_show_event_type(CALENDAR_EVENT_COURSE)) {
1461         $courses = array_keys($courseeventsfrom);
1462     }
1463     if ($ignorefilters || calendar_show_event_type(CALENDAR_EVENT_GLOBAL)) {
1464         $courses[] = SITEID;
1465     }
1466     $courses = array_unique($courses);
1467     sort($courses);
1469     if (!empty($courses) && in_array(SITEID, $courses)) {
1470         // Sort courses for consistent colour highlighting
1471         // Effectively ignoring SITEID as setting as last course id
1472         $key = array_search(SITEID, $courses);
1473         unset($courses[$key]);
1474         $courses[] = SITEID;
1475     }
1477     if ($ignorefilters || ($isloggedin && calendar_show_event_type(CALENDAR_EVENT_USER))) {
1478         $user = $USER->id;
1479     }
1481     if (!empty($courseeventsfrom) && (calendar_show_event_type(CALENDAR_EVENT_GROUP) || $ignorefilters)) {
1483         if (count($courseeventsfrom)==1) {
1484             $course = reset($courseeventsfrom);
1485             if (has_any_capability($allgroupscaps, context_course::instance($course->id))) {
1486                 $coursegroups = groups_get_all_groups($course->id, 0, 0, 'g.id');
1487                 $group = array_keys($coursegroups);
1488             }
1489         }
1490         if ($group === false) {
1491             if (!empty($CFG->calendar_adminseesall) && has_any_capability($allgroupscaps, context_system::instance())) {
1492                 $group = true;
1493             } else if ($isloggedin) {
1494                 $groupids = array();
1496                 // We already have the courses to examine in $courses
1497                 // For each course...
1498                 foreach ($courseeventsfrom as $courseid => $course) {
1499                     // If the user is an editing teacher in there,
1500                     if (!empty($USER->groupmember[$course->id])) {
1501                         // We've already cached the users groups for this course so we can just use that
1502                         $groupids = array_merge($groupids, $USER->groupmember[$course->id]);
1503                     } else if ($course->groupmode != NOGROUPS || !$course->groupmodeforce) {
1504                         // If this course has groups, show events from all of those related to the current user
1505                         $coursegroups = groups_get_user_groups($course->id, $USER->id);
1506                         $groupids = array_merge($groupids, $coursegroups['0']);
1507                     }
1508                 }
1509                 if (!empty($groupids)) {
1510                     $group = $groupids;
1511                 }
1512             }
1513         }
1514     }
1515     if (empty($courses)) {
1516         $courses = false;
1517     }
1519     return array($courses, $group, $user);
1522 /**
1523  * Return the capability for editing calendar event
1524  *
1525  * @param calendar_event $event event object
1526  * @return bool capability to edit event
1527  */
1528 function calendar_edit_event_allowed($event) {
1529     global $USER, $DB;
1531     // Must be logged in
1532     if (!isloggedin()) {
1533         return false;
1534     }
1536     // can not be using guest account
1537     if (isguestuser()) {
1538         return false;
1539     }
1541     // You cannot edit calendar subscription events presently.
1542     if (!empty($event->subscriptionid)) {
1543         return false;
1544     }
1546     $sitecontext = context_system::instance();
1547     // if user has manageentries at site level, return true
1548     if (has_capability('moodle/calendar:manageentries', $sitecontext)) {
1549         return true;
1550     }
1552     // if groupid is set, it's definitely a group event
1553     if (!empty($event->groupid)) {
1554         // Allow users to add/edit group events if:
1555         // 1) They have manageentries (= entries for whole course)
1556         // 2) They have managegroupentries AND are in the group
1557         $group = $DB->get_record('groups', array('id'=>$event->groupid));
1558         return $group && (
1559             has_capability('moodle/calendar:manageentries', $event->context) ||
1560             (has_capability('moodle/calendar:managegroupentries', $event->context)
1561                 && groups_is_member($event->groupid)));
1562     } else if (!empty($event->courseid)) {
1563     // if groupid is not set, but course is set,
1564     // it's definiely a course event
1565         return has_capability('moodle/calendar:manageentries', $event->context);
1566     } else if (!empty($event->userid) && $event->userid == $USER->id) {
1567     // if course is not set, but userid id set, it's a user event
1568         return (has_capability('moodle/calendar:manageownentries', $event->context));
1569     } else if (!empty($event->userid)) {
1570         return (has_capability('moodle/calendar:manageentries', $event->context));
1571     }
1572     return false;
1575 /**
1576  * Returns the default courses to display on the calendar when there isn't a specific
1577  * course to display.
1578  *
1579  * @return array $courses Array of courses to display
1580  */
1581 function calendar_get_default_courses() {
1582     global $CFG, $DB;
1584     if (!isloggedin()) {
1585         return array();
1586     }
1588     $courses = array();
1589     if (!empty($CFG->calendar_adminseesall) && has_capability('moodle/calendar:manageentries', context_system::instance())) {
1590         $select = ', ' . context_helper::get_preload_record_columns_sql('ctx');
1591         $join = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1592         $sql = "SELECT c.* $select
1593                   FROM {course} c
1594                   $join
1595                   WHERE EXISTS (SELECT 1 FROM {event} e WHERE e.courseid = c.id)
1596                   ";
1597         $courses = $DB->get_records_sql($sql, array('contextlevel' => CONTEXT_COURSE), 0, 20);
1598         foreach ($courses as $course) {
1599             context_helper::preload_from_record($course);
1600         }
1601         return $courses;
1602     }
1604     $courses = enrol_get_my_courses();
1606     return $courses;
1609 /**
1610  * Display calendar preference button
1611  *
1612  * @param stdClass $course course object
1613  * @return string return preference button in html
1614  */
1615 function calendar_preferences_button(stdClass $course) {
1616     global $OUTPUT;
1618     // Guests have no preferences
1619     if (!isloggedin() || isguestuser()) {
1620         return '';
1621     }
1623     return $OUTPUT->single_button(new moodle_url('/calendar/preferences.php', array('course' => $course->id)), get_string("preferences", "calendar"));
1626 /**
1627  * Get event format time
1628  *
1629  * @param calendar_event $event event object
1630  * @param int $now current time in gmt
1631  * @param array $linkparams list of params for event link
1632  * @param bool $usecommonwords the words as formatted date/time.
1633  * @param int $showtime determine the show time GMT timestamp
1634  * @return string $eventtime link/string for event time
1635  */
1636 function calendar_format_event_time($event, $now, $linkparams = null, $usecommonwords = true, $showtime=0) {
1637     $startdate = usergetdate($event->timestart);
1638     $enddate = usergetdate($event->timestart + $event->timeduration);
1639     $usermidnightstart = usergetmidnight($event->timestart);
1641     if($event->timeduration) {
1642         // To avoid doing the math if one IF is enough :)
1643         $usermidnightend = usergetmidnight($event->timestart + $event->timeduration);
1644     }
1645     else {
1646         $usermidnightend = $usermidnightstart;
1647     }
1649     if (empty($linkparams) || !is_array($linkparams)) {
1650         $linkparams = array();
1651     }
1652     $linkparams['view'] = 'day';
1654     // OK, now to get a meaningful display...
1655     // First of all we have to construct a human-readable date/time representation
1657     if($event->timeduration) {
1658         // It has a duration
1659         if($usermidnightstart == $usermidnightend ||
1660            ($event->timestart == $usermidnightstart) && ($event->timeduration == 86400 || $event->timeduration == 86399) ||
1661            ($event->timestart + $event->timeduration <= $usermidnightstart + 86400)) {
1662             // But it's all on the same day
1663             $timestart = calendar_time_representation($event->timestart);
1664             $timeend = calendar_time_representation($event->timestart + $event->timeduration);
1665             $time = $timestart.' <strong>&raquo;</strong> '.$timeend;
1667             if ($event->timestart == $usermidnightstart && ($event->timeduration == 86400 || $event->timeduration == 86399)) {
1668                 $time = get_string('allday', 'calendar');
1669             }
1671             // Set printable representation
1672             if (!$showtime) {
1673                 $day = calendar_day_representation($event->timestart, $now, $usecommonwords);
1674                 $url = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', $linkparams), $enddate['mday'], $enddate['mon'], $enddate['year']);
1675                 $eventtime = html_writer::link($url, $day).', '.$time;
1676             } else {
1677                 $eventtime = $time;
1678             }
1679         } else {
1680             // It spans two or more days
1681             $daystart = calendar_day_representation($event->timestart, $now, $usecommonwords).', ';
1682             if ($showtime == $usermidnightstart) {
1683                 $daystart = '';
1684             }
1685             $timestart = calendar_time_representation($event->timestart);
1686             $dayend = calendar_day_representation($event->timestart + $event->timeduration, $now, $usecommonwords).', ';
1687             if ($showtime == $usermidnightend) {
1688                 $dayend = '';
1689             }
1690             $timeend = calendar_time_representation($event->timestart + $event->timeduration);
1692             // Set printable representation
1693             if ($now >= $usermidnightstart && $now < ($usermidnightstart + 86400)) {
1694                 $url = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', $linkparams), $enddate['mday'], $enddate['mon'], $enddate['year']);
1695                 $eventtime = $timestart.' <strong>&raquo;</strong> '.html_writer::link($url, $dayend).$timeend;
1696             } else {
1697                 $url = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', $linkparams), $enddate['mday'], $enddate['mon'], $enddate['year']);
1698                 $eventtime  = html_writer::link($url, $daystart).$timestart.' <strong>&raquo;</strong> ';
1700                 $url = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', $linkparams), $startdate['mday'], $startdate['mon'], $startdate['year']);
1701                 $eventtime .= html_writer::link($url, $dayend).$timeend;
1702             }
1703         }
1704     } else {
1705         $time = calendar_time_representation($event->timestart);
1707         // Set printable representation
1708         if (!$showtime) {
1709             $day = calendar_day_representation($event->timestart, $now, $usecommonwords);
1710             $url = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', $linkparams), $startdate['mday'], $startdate['mon'], $startdate['year']);
1711             $eventtime = html_writer::link($url, $day).', '.trim($time);
1712         } else {
1713             $eventtime = $time;
1714         }
1715     }
1717     if($event->timestart + $event->timeduration < $now) {
1718         // It has expired
1719         $eventtime = '<span class="dimmed_text">'.str_replace(' href=', ' class="dimmed" href=', $eventtime).'</span>';
1720     }
1722     return $eventtime;
1725 /**
1726  * Display month selector options
1727  *
1728  * @param string $name for the select element
1729  * @param string|array $selected options for select elements
1730  */
1731 function calendar_print_month_selector($name, $selected) {
1732     $months = array();
1733     for ($i=1; $i<=12; $i++) {
1734         $months[$i] = userdate(gmmktime(12, 0, 0, $i, 15, 2000), '%B');
1735     }
1736     echo html_writer::label(get_string('months'), 'menu'. $name, false, array('class' => 'accesshide'));
1737     echo html_writer::select($months, $name, $selected, false);
1740 /**
1741  * Checks to see if the requested type of event should be shown for the given user.
1742  *
1743  * @param CALENDAR_EVENT_GLOBAL|CALENDAR_EVENT_COURSE|CALENDAR_EVENT_GROUP|CALENDAR_EVENT_USER $type
1744  *          The type to check the display for (default is to display all)
1745  * @param stdClass|int|null $user The user to check for - by default the current user
1746  * @return bool True if the tyep should be displayed false otherwise
1747  */
1748 function calendar_show_event_type($type, $user = null) {
1749     $default = CALENDAR_EVENT_GLOBAL + CALENDAR_EVENT_COURSE + CALENDAR_EVENT_GROUP + CALENDAR_EVENT_USER;
1750     if (get_user_preferences('calendar_persistflt', 0, $user) === 0) {
1751         global $SESSION;
1752         if (!isset($SESSION->calendarshoweventtype)) {
1753             $SESSION->calendarshoweventtype = $default;
1754         }
1755         return $SESSION->calendarshoweventtype & $type;
1756     } else {
1757         return get_user_preferences('calendar_savedflt', $default, $user) & $type;
1758     }
1761 /**
1762  * Sets the display of the event type given $display.
1763  *
1764  * If $display = true the event type will be shown.
1765  * If $display = false the event type will NOT be shown.
1766  * If $display = null the current value will be toggled and saved.
1767  *
1768  * @param CALENDAR_EVENT_GLOBAL|CALENDAR_EVENT_COURSE|CALENDAR_EVENT_GROUP|CALENDAR_EVENT_USER $type object of CALENDAR_EVENT_XXX
1769  * @param bool $display option to display event type
1770  * @param stdClass|int $user moodle user object or id, null means current user
1771  */
1772 function calendar_set_event_type_display($type, $display = null, $user = null) {
1773     $persist = get_user_preferences('calendar_persistflt', 0, $user);
1774     $default = CALENDAR_EVENT_GLOBAL + CALENDAR_EVENT_COURSE + CALENDAR_EVENT_GROUP + CALENDAR_EVENT_USER;
1775     if ($persist === 0) {
1776         global $SESSION;
1777         if (!isset($SESSION->calendarshoweventtype)) {
1778             $SESSION->calendarshoweventtype = $default;
1779         }
1780         $preference = $SESSION->calendarshoweventtype;
1781     } else {
1782         $preference = get_user_preferences('calendar_savedflt', $default, $user);
1783     }
1784     $current = $preference & $type;
1785     if ($display === null) {
1786         $display = !$current;
1787     }
1788     if ($display && !$current) {
1789         $preference += $type;
1790     } else if (!$display && $current) {
1791         $preference -= $type;
1792     }
1793     if ($persist === 0) {
1794         $SESSION->calendarshoweventtype = $preference;
1795     } else {
1796         if ($preference == $default) {
1797             unset_user_preference('calendar_savedflt', $user);
1798         } else {
1799             set_user_preference('calendar_savedflt', $preference, $user);
1800         }
1801     }
1804 /**
1805  * Get calendar's allowed types
1806  *
1807  * @param stdClass $allowed list of allowed edit for event  type
1808  * @param stdClass|int $course object of a course or course id
1809  */
1810 function calendar_get_allowed_types(&$allowed, $course = null) {
1811     global $USER, $CFG, $DB;
1812     $allowed = new stdClass();
1813     $allowed->user = has_capability('moodle/calendar:manageownentries', context_system::instance());
1814     $allowed->groups = false; // This may change just below
1815     $allowed->courses = false; // This may change just below
1816     $allowed->site = has_capability('moodle/calendar:manageentries', context_course::instance(SITEID));
1818     if (!empty($course)) {
1819         if (!is_object($course)) {
1820             $course = $DB->get_record('course', array('id' => $course), '*', MUST_EXIST);
1821         }
1822         if ($course->id != SITEID) {
1823             $coursecontext = context_course::instance($course->id);
1824             $allowed->user = has_capability('moodle/calendar:manageownentries', $coursecontext);
1826             if (has_capability('moodle/calendar:manageentries', $coursecontext)) {
1827                 $allowed->courses = array($course->id => 1);
1829                 if ($course->groupmode != NOGROUPS || !$course->groupmodeforce) {
1830                     if (has_capability('moodle/site:accessallgroups', $coursecontext)) {
1831                         $allowed->groups = groups_get_all_groups($course->id);
1832                     } else {
1833                         $allowed->groups = groups_get_all_groups($course->id, $USER->id);
1834                     }
1835                 }
1836             } else if (has_capability('moodle/calendar:managegroupentries', $coursecontext)) {
1837                 if($course->groupmode != NOGROUPS || !$course->groupmodeforce) {
1838                     if (has_capability('moodle/site:accessallgroups', $coursecontext)) {
1839                         $allowed->groups = groups_get_all_groups($course->id);
1840                     } else {
1841                         $allowed->groups = groups_get_all_groups($course->id, $USER->id);
1842                     }
1843                 }
1844             }
1845         }
1846     }
1849 /**
1850  * See if user can add calendar entries at all
1851  * used to print the "New Event" button
1852  *
1853  * @param stdClass $course object of a course or course id
1854  * @return bool has the capability to add at least one event type
1855  */
1856 function calendar_user_can_add_event($course) {
1857     if (!isloggedin() || isguestuser()) {
1858         return false;
1859     }
1860     calendar_get_allowed_types($allowed, $course);
1861     return (bool)($allowed->user || $allowed->groups || $allowed->courses || $allowed->site);
1864 /**
1865  * Check wether the current user is permitted to add events
1866  *
1867  * @param stdClass $event object of event
1868  * @return bool has the capability to add event
1869  */
1870 function calendar_add_event_allowed($event) {
1871     global $USER, $DB;
1873     // can not be using guest account
1874     if (!isloggedin() or isguestuser()) {
1875         return false;
1876     }
1878     $sitecontext = context_system::instance();
1879     // if user has manageentries at site level, always return true
1880     if (has_capability('moodle/calendar:manageentries', $sitecontext)) {
1881         return true;
1882     }
1884     switch ($event->eventtype) {
1885         case 'course':
1886             return has_capability('moodle/calendar:manageentries', $event->context);
1888         case 'group':
1889             // Allow users to add/edit group events if:
1890             // 1) They have manageentries (= entries for whole course)
1891             // 2) They have managegroupentries AND are in the group
1892             $group = $DB->get_record('groups', array('id'=>$event->groupid));
1893             return $group && (
1894                 has_capability('moodle/calendar:manageentries', $event->context) ||
1895                 (has_capability('moodle/calendar:managegroupentries', $event->context)
1896                     && groups_is_member($event->groupid)));
1898         case 'user':
1899             if ($event->userid == $USER->id) {
1900                 return (has_capability('moodle/calendar:manageownentries', $event->context));
1901             }
1902             //there is no 'break;' intentionally
1904         case 'site':
1905             return has_capability('moodle/calendar:manageentries', $event->context);
1907         default:
1908             return has_capability('moodle/calendar:manageentries', $event->context);
1909     }
1912 /**
1913  * Manage calendar events
1914  *
1915  * This class provides the required functionality in order to manage calendar events.
1916  * It was introduced as part of Moodle 2.0 and was created in order to provide a
1917  * better framework for dealing with calendar events in particular regard to file
1918  * handling through the new file API
1919  *
1920  * @package    core_calendar
1921  * @category   calendar
1922  * @copyright  2009 Sam Hemelryk
1923  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1924  *
1925  * @property int $id The id within the event table
1926  * @property string $name The name of the event
1927  * @property string $description The description of the event
1928  * @property int $format The format of the description FORMAT_?
1929  * @property int $courseid The course the event is associated with (0 if none)
1930  * @property int $groupid The group the event is associated with (0 if none)
1931  * @property int $userid The user the event is associated with (0 if none)
1932  * @property int $repeatid If this is a repeated event this will be set to the
1933  *                          id of the original
1934  * @property string $modulename If added by a module this will be the module name
1935  * @property int $instance If added by a module this will be the module instance
1936  * @property string $eventtype The event type
1937  * @property int $timestart The start time as a timestamp
1938  * @property int $timeduration The duration of the event in seconds
1939  * @property int $visible 1 if the event is visible
1940  * @property int $uuid ?
1941  * @property int $sequence ?
1942  * @property int $timemodified The time last modified as a timestamp
1943  */
1944 class calendar_event {
1946     /** @var array An object containing the event properties can be accessed via the magic __get/set methods */
1947     protected $properties = null;
1949     /**
1950      * @var string The converted event discription with file paths resolved. This gets populated when someone requests description for the first time */
1951     protected $_description = null;
1953     /** @var array The options to use with this description editor */
1954     protected $editoroptions = array(
1955             'subdirs'=>false,
1956             'forcehttps'=>false,
1957             'maxfiles'=>-1,
1958             'maxbytes'=>null,
1959             'trusttext'=>false);
1961     /** @var object The context to use with the description editor */
1962     protected $editorcontext = null;
1964     /**
1965      * Instantiates a new event and optionally populates its properties with the
1966      * data provided
1967      *
1968      * @param stdClass $data Optional. An object containing the properties to for
1969      *                  an event
1970      */
1971     public function __construct($data=null) {
1972         global $CFG, $USER;
1974         // First convert to object if it is not already (should either be object or assoc array)
1975         if (!is_object($data)) {
1976             $data = (object)$data;
1977         }
1979         $this->editoroptions['maxbytes'] = $CFG->maxbytes;
1981         $data->eventrepeats = 0;
1983         if (empty($data->id)) {
1984             $data->id = null;
1985         }
1987         if (!empty($data->subscriptionid)) {
1988             $data->subscription = calendar_get_subscription($data->subscriptionid);
1989         }
1991         // Default to a user event
1992         if (empty($data->eventtype)) {
1993             $data->eventtype = 'user';
1994         }
1996         // Default to the current user
1997         if (empty($data->userid)) {
1998             $data->userid = $USER->id;
1999         }
2001         if (!empty($data->timeduration) && is_array($data->timeduration)) {
2002             $data->timeduration = make_timestamp($data->timeduration['year'], $data->timeduration['month'], $data->timeduration['day'], $data->timeduration['hour'], $data->timeduration['minute']) - $data->timestart;
2003         }
2004         if (!empty($data->description) && is_array($data->description)) {
2005             $data->format = $data->description['format'];
2006             $data->description = $data->description['text'];
2007         } else if (empty($data->description)) {
2008             $data->description = '';
2009             $data->format = editors_get_preferred_format();
2010         }
2011         // Ensure form is defaulted correctly
2012         if (empty($data->format)) {
2013             $data->format = editors_get_preferred_format();
2014         }
2016         if (empty($data->context)) {
2017             $data->context = $this->calculate_context($data);
2018         }
2019         $this->properties = $data;
2020     }
2022     /**
2023      * Magic property method
2024      *
2025      * Attempts to call a set_$key method if one exists otherwise falls back
2026      * to simply set the property
2027      *
2028      * @param string $key property name
2029      * @param mixed $value value of the property
2030      */
2031     public function __set($key, $value) {
2032         if (method_exists($this, 'set_'.$key)) {
2033             $this->{'set_'.$key}($value);
2034         }
2035         $this->properties->{$key} = $value;
2036     }
2038     /**
2039      * Magic get method
2040      *
2041      * Attempts to call a get_$key method to return the property and ralls over
2042      * to return the raw property
2043      *
2044      * @param string $key property name
2045      * @return mixed property value
2046      */
2047     public function __get($key) {
2048         if (method_exists($this, 'get_'.$key)) {
2049             return $this->{'get_'.$key}();
2050         }
2051         if (!isset($this->properties->{$key})) {
2052             throw new coding_exception('Undefined property requested');
2053         }
2054         return $this->properties->{$key};
2055     }
2057     /**
2058      * Stupid PHP needs an isset magic method if you use the get magic method and
2059      * still want empty calls to work.... blah ~!
2060      *
2061      * @param string $key $key property name
2062      * @return bool|mixed property value, false if property is not exist
2063      */
2064     public function __isset($key) {
2065         return !empty($this->properties->{$key});
2066     }
2068     /**
2069      * Calculate the context value needed for calendar_event.
2070      * Event's type can be determine by the available value store in $data
2071      * It is important to check for the existence of course/courseid to determine
2072      * the course event.
2073      * Default value is set to CONTEXT_USER
2074      *
2075      * @param stdClass $data information about event
2076      * @return stdClass The context object.
2077      */
2078     protected function calculate_context(stdClass $data) {
2079         global $USER, $DB;
2081         $context = null;
2082         if (isset($data->courseid) && $data->courseid > 0) {
2083             $context =  context_course::instance($data->courseid);
2084         } else if (isset($data->course) && $data->course > 0) {
2085             $context =  context_course::instance($data->course);
2086         } else if (isset($data->groupid) && $data->groupid > 0) {
2087             $group = $DB->get_record('groups', array('id'=>$data->groupid));
2088             $context = context_course::instance($group->courseid);
2089         } else if (isset($data->userid) && $data->userid > 0 && $data->userid == $USER->id) {
2090             $context =  context_user::instance($data->userid);
2091         } else if (isset($data->userid) && $data->userid > 0 && $data->userid != $USER->id &&
2092                    isset($data->instance) && $data->instance > 0) {
2093             $cm = get_coursemodule_from_instance($data->modulename, $data->instance, 0, false, MUST_EXIST);
2094             $context =  context_course::instance($cm->course);
2095         } else {
2096             $context =  context_user::instance($data->userid);
2097         }
2099         return $context;
2100     }
2102     /**
2103      * Returns an array of editoroptions for this event: Called by __get
2104      * Please use $blah = $event->editoroptions;
2105      *
2106      * @return array event editor options
2107      */
2108     protected function get_editoroptions() {
2109         return $this->editoroptions;
2110     }
2112     /**
2113      * Returns an event description: Called by __get
2114      * Please use $blah = $event->description;
2115      *
2116      * @return string event description
2117      */
2118     protected function get_description() {
2119         global $CFG;
2121         require_once($CFG->libdir . '/filelib.php');
2123         if ($this->_description === null) {
2124             // Check if we have already resolved the context for this event
2125             if ($this->editorcontext === null) {
2126                 // Switch on the event type to decide upon the appropriate context
2127                 // to use for this event
2128                 $this->editorcontext = $this->properties->context;
2129                 if ($this->properties->eventtype != 'user' && $this->properties->eventtype != 'course'
2130                         && $this->properties->eventtype != 'site' && $this->properties->eventtype != 'group') {
2131                     return clean_text($this->properties->description, $this->properties->format);
2132                 }
2133             }
2135             // Work out the item id for the editor, if this is a repeated event then the files will
2136             // be associated with the original
2137             if (!empty($this->properties->repeatid) && $this->properties->repeatid > 0) {
2138                 $itemid = $this->properties->repeatid;
2139             } else {
2140                 $itemid = $this->properties->id;
2141             }
2143             // Convert file paths in the description so that things display correctly
2144             $this->_description = file_rewrite_pluginfile_urls($this->properties->description, 'pluginfile.php', $this->editorcontext->id, 'calendar', 'event_description', $itemid);
2145             // Clean the text so no nasties get through
2146             $this->_description = clean_text($this->_description, $this->properties->format);
2147         }
2148         // Finally return the description
2149         return $this->_description;
2150     }
2152     /**
2153      * Return the number of repeat events there are in this events series
2154      *
2155      * @return int number of event repeated
2156      */
2157     public function count_repeats() {
2158         global $DB;
2159         if (!empty($this->properties->repeatid)) {
2160             $this->properties->eventrepeats = $DB->count_records('event', array('repeatid'=>$this->properties->repeatid));
2161             // We don't want to count ourselves
2162             $this->properties->eventrepeats--;
2163         }
2164         return $this->properties->eventrepeats;
2165     }
2167     /**
2168      * Update or create an event within the database
2169      *
2170      * Pass in a object containing the event properties and this function will
2171      * insert it into the database and deal with any associated files
2172      *
2173      * @see add_event()
2174      * @see update_event()
2175      *
2176      * @param stdClass $data object of event
2177      * @param bool $checkcapability if moodle should check calendar managing capability or not
2178      * @return bool event updated
2179      */
2180     public function update($data, $checkcapability=true) {
2181         global $CFG, $DB, $USER;
2183         foreach ($data as $key=>$value) {
2184             $this->properties->$key = $value;
2185         }
2187         $this->properties->timemodified = time();
2188         $usingeditor = (!empty($this->properties->description) && is_array($this->properties->description));
2190         if (empty($this->properties->id) || $this->properties->id < 1) {
2192             if ($checkcapability) {
2193                 if (!calendar_add_event_allowed($this->properties)) {
2194                     print_error('nopermissiontoupdatecalendar');
2195                 }
2196             }
2198             if ($usingeditor) {
2199                 switch ($this->properties->eventtype) {
2200                     case 'user':
2201                         $this->properties->courseid = 0;
2202                         $this->properties->course = 0;
2203                         $this->properties->groupid = 0;
2204                         $this->properties->userid = $USER->id;
2205                         break;
2206                     case 'site':
2207                         $this->properties->courseid = SITEID;
2208                         $this->properties->course = SITEID;
2209                         $this->properties->groupid = 0;
2210                         $this->properties->userid = $USER->id;
2211                         break;
2212                     case 'course':
2213                         $this->properties->groupid = 0;
2214                         $this->properties->userid = $USER->id;
2215                         break;
2216                     case 'group':
2217                         $this->properties->userid = $USER->id;
2218                         break;
2219                     default:
2220                         // Ewww we should NEVER get here, but just incase we do lets
2221                         // fail gracefully
2222                         $usingeditor = false;
2223                         break;
2224                 }
2226                 // If we are actually using the editor, we recalculate the context because some default values
2227                 // were set when calculate_context() was called from the constructor.
2228                 if ($usingeditor) {
2229                     $this->properties->context = $this->calculate_context($this->properties);
2230                     $this->editorcontext = $this->properties->context;
2231                 }
2233                 $editor = $this->properties->description;
2234                 $this->properties->format = $this->properties->description['format'];
2235                 $this->properties->description = $this->properties->description['text'];
2236             }
2238             // Insert the event into the database
2239             $this->properties->id = $DB->insert_record('event', $this->properties);
2241             if ($usingeditor) {
2242                 $this->properties->description = file_save_draft_area_files(
2243                                                 $editor['itemid'],
2244                                                 $this->editorcontext->id,
2245                                                 'calendar',
2246                                                 'event_description',
2247                                                 $this->properties->id,
2248                                                 $this->editoroptions,
2249                                                 $editor['text'],
2250                                                 $this->editoroptions['forcehttps']);
2251                 $DB->set_field('event', 'description', $this->properties->description, array('id'=>$this->properties->id));
2252             }
2254             // Log the event entry.
2255             add_to_log($this->properties->courseid, 'calendar', 'add', 'event.php?action=edit&amp;id='.$this->properties->id, $this->properties->name);
2257             $repeatedids = array();
2259             if (!empty($this->properties->repeat)) {
2260                 $this->properties->repeatid = $this->properties->id;
2261                 $DB->set_field('event', 'repeatid', $this->properties->repeatid, array('id'=>$this->properties->id));
2263                 $eventcopy = clone($this->properties);
2264                 unset($eventcopy->id);
2266                 for($i = 1; $i < $eventcopy->repeats; $i++) {
2268                     $eventcopy->timestart = ($eventcopy->timestart+WEEKSECS) + dst_offset_on($eventcopy->timestart) - dst_offset_on($eventcopy->timestart+WEEKSECS);
2270                     // Get the event id for the log record.
2271                     $eventcopyid = $DB->insert_record('event', $eventcopy);
2273                     // If the context has been set delete all associated files
2274                     if ($usingeditor) {
2275                         $fs = get_file_storage();
2276                         $files = $fs->get_area_files($this->editorcontext->id, 'calendar', 'event_description', $this->properties->id);
2277                         foreach ($files as $file) {
2278                             $fs->create_file_from_storedfile(array('itemid'=>$eventcopyid), $file);
2279                         }
2280                     }
2282                     $repeatedids[] = $eventcopyid;
2283                     // Log the event entry.
2284                     add_to_log($eventcopy->courseid, 'calendar', 'add', 'event.php?action=edit&amp;id='.$eventcopyid, $eventcopy->name);
2285                 }
2286             }
2288             // Hook for tracking added events
2289             self::calendar_event_hook('add_event', array($this->properties, $repeatedids));
2290             return true;
2291         } else {
2293             if ($checkcapability) {
2294                 if(!calendar_edit_event_allowed($this->properties)) {
2295                     print_error('nopermissiontoupdatecalendar');
2296                 }
2297             }
2299             if ($usingeditor) {
2300                 if ($this->editorcontext !== null) {
2301                     $this->properties->description = file_save_draft_area_files(
2302                                                     $this->properties->description['itemid'],
2303                                                     $this->editorcontext->id,
2304                                                     'calendar',
2305                                                     'event_description',
2306                                                     $this->properties->id,
2307                                                     $this->editoroptions,
2308                                                     $this->properties->description['text'],
2309                                                     $this->editoroptions['forcehttps']);
2310                 } else {
2311                     $this->properties->format = $this->properties->description['format'];
2312                     $this->properties->description = $this->properties->description['text'];
2313                 }
2314             }
2316             $event = $DB->get_record('event', array('id'=>$this->properties->id));
2318             $updaterepeated = (!empty($this->properties->repeatid) && !empty($this->properties->repeateditall));
2320             if ($updaterepeated) {
2321                 // Update all
2322                 if ($this->properties->timestart != $event->timestart) {
2323                     $timestartoffset = $this->properties->timestart - $event->timestart;
2324                     $sql = "UPDATE {event}
2325                                SET name = ?,
2326                                    description = ?,
2327                                    timestart = timestart + ?,
2328                                    timeduration = ?,
2329                                    timemodified = ?
2330                              WHERE repeatid = ?";
2331                     $params = array($this->properties->name, $this->properties->description, $timestartoffset, $this->properties->timeduration, time(), $event->repeatid);
2332                 } else {
2333                     $sql = "UPDATE {event} SET name = ?, description = ?, timeduration = ?, timemodified = ? WHERE repeatid = ?";
2334                     $params = array($this->properties->name, $this->properties->description, $this->properties->timeduration, time(), $event->repeatid);
2335                 }
2336                 $DB->execute($sql, $params);
2338                 // Log the event update.
2339                 add_to_log($this->properties->courseid, 'calendar', 'edit all', 'event.php?action=edit&amp;id='.$this->properties->id, $this->properties->name);
2340             } else {
2341                 $DB->update_record('event', $this->properties);
2342                 $event = calendar_event::load($this->properties->id);
2343                 $this->properties = $event->properties();
2344                 add_to_log($this->properties->courseid, 'calendar', 'edit', 'event.php?action=edit&amp;id='.$this->properties->id, $this->properties->name);
2345             }
2347             // Hook for tracking event updates
2348             self::calendar_event_hook('update_event', array($this->properties, $updaterepeated));
2349             return true;
2350         }
2351     }
2353     /**
2354      * Deletes an event and if selected an repeated events in the same series
2355      *
2356      * This function deletes an event, any associated events if $deleterepeated=true,
2357      * and cleans up any files associated with the events.
2358      *
2359      * @see delete_event()
2360      *
2361      * @param bool $deleterepeated  delete event repeatedly
2362      * @return bool succession of deleting event
2363      */
2364     public function delete($deleterepeated=false) {
2365         global $DB;
2367         // If $this->properties->id is not set then something is wrong
2368         if (empty($this->properties->id)) {
2369             debugging('Attempting to delete an event before it has been loaded', DEBUG_DEVELOPER);
2370             return false;
2371         }
2373         // Delete the event
2374         $DB->delete_records('event', array('id'=>$this->properties->id));
2376         // If we are deleting parent of a repeated event series, promote the next event in the series as parent
2377         if (($this->properties->id == $this->properties->repeatid) && !$deleterepeated) {
2378             $newparent = $DB->get_field_sql("SELECT id from {event} where repeatid = ? order by id ASC", array($this->properties->id), IGNORE_MULTIPLE);
2379             if (!empty($newparent)) {
2380                 $DB->execute("UPDATE {event} SET repeatid = ? WHERE repeatid = ?", array($newparent, $this->properties->id));
2381                 // Get all records where the repeatid is the same as the event being removed
2382                 $events = $DB->get_records('event', array('repeatid' => $newparent));
2383                 // For each of the returned events trigger the event_update hook.
2384                 foreach ($events as $event) {
2385                     self::calendar_event_hook('update_event', array($event, false));
2386                 }
2387             }
2388         }
2390         // If the editor context hasn't already been set then set it now
2391         if ($this->editorcontext === null) {
2392             $this->editorcontext = $this->properties->context;
2393         }
2395         // If the context has been set delete all associated files
2396         if ($this->editorcontext !== null) {
2397             $fs = get_file_storage();
2398             $files = $fs->get_area_files($this->editorcontext->id, 'calendar', 'event_description', $this->properties->id);
2399             foreach ($files as $file) {
2400                 $file->delete();
2401             }
2402         }
2404         // Fire the event deleted hook
2405         self::calendar_event_hook('delete_event', array($this->properties->id, $deleterepeated));
2407         // If we need to delete repeated events then we will fetch them all and delete one by one
2408         if ($deleterepeated && !empty($this->properties->repeatid) && $this->properties->repeatid > 0) {
2409             // Get all records where the repeatid is the same as the event being removed
2410             $events = $DB->get_records('event', array('repeatid'=>$this->properties->repeatid));
2411             // For each of the returned events populate a calendar_event object and call delete
2412             // make sure the arg passed is false as we are already deleting all repeats
2413             foreach ($events as $event) {
2414                 $event = new calendar_event($event);
2415                 $event->delete(false);
2416             }
2417         }
2419         return true;
2420     }
2422     /**
2423      * Fetch all event properties
2424      *
2425      * This function returns all of the events properties as an object and optionally
2426      * can prepare an editor for the description field at the same time. This is
2427      * designed to work when the properties are going to be used to set the default
2428      * values of a moodle forms form.
2429      *
2430      * @param bool $prepareeditor If set to true a editor is prepared for use with
2431      *              the mforms editor element. (for description)
2432      * @return stdClass Object containing event properties
2433      */
2434     public function properties($prepareeditor=false) {
2435         global $USER, $CFG, $DB;
2437         // First take a copy of the properties. We don't want to actually change the
2438         // properties or we'd forever be converting back and forwards between an
2439         // editor formatted description and not
2440         $properties = clone($this->properties);
2441         // Clean the description here
2442         $properties->description = clean_text($properties->description, $properties->format);
2444         // If set to true we need to prepare the properties for use with an editor
2445         // and prepare the file area
2446         if ($prepareeditor) {
2448             // We may or may not have a property id. If we do then we need to work
2449             // out the context so we can copy the existing files to the draft area
2450             if (!empty($properties->id)) {
2452                 if ($properties->eventtype === 'site') {
2453                     // Site context
2454                     $this->editorcontext = $this->properties->context;
2455                 } else if ($properties->eventtype === 'user') {
2456                     // User context
2457                     $this->editorcontext = $this->properties->context;
2458                 } else if ($properties->eventtype === 'group' || $properties->eventtype === 'course') {
2459                     // First check the course is valid
2460                     $course = $DB->get_record('course', array('id'=>$properties->courseid));
2461                     if (!$course) {
2462                         print_error('invalidcourse');
2463                     }
2464                     // Course context
2465                     $this->editorcontext = $this->properties->context;
2466                     // We have a course and are within the course context so we had
2467                     // better use the courses max bytes value
2468                     $this->editoroptions['maxbytes'] = $course->maxbytes;
2469                 } else {
2470                     // If we get here we have a custom event type as used by some
2471                     // modules. In this case the event will have been added by
2472                     // code and we won't need the editor
2473                     $this->editoroptions['maxbytes'] = 0;
2474                     $this->editoroptions['maxfiles'] = 0;
2475                 }
2477                 if (empty($this->editorcontext) || empty($this->editorcontext->id)) {
2478                     $contextid = false;
2479                 } else {
2480                     // Get the context id that is what we really want
2481                     $contextid = $this->editorcontext->id;
2482                 }
2483             } else {
2485                 // If we get here then this is a new event in which case we don't need a
2486                 // context as there is no existing files to copy to the draft area.
2487                 $contextid = null;
2488             }
2490             // If the contextid === false we don't support files so no preparing
2491             // a draft area
2492             if ($contextid !== false) {
2493                 // Just encase it has already been submitted
2494                 $draftiddescription = file_get_submitted_draft_itemid('description');
2495                 // Prepare the draft area, this copies existing files to the draft area as well
2496                 $properties->description = file_prepare_draft_area($draftiddescription, $contextid, 'calendar', 'event_description', $properties->id, $this->editoroptions, $properties->description);
2497             } else {
2498                 $draftiddescription = 0;
2499             }
2501             // Structure the description field as the editor requires
2502             $properties->description = array('text'=>$properties->description, 'format'=>$properties->format, 'itemid'=>$draftiddescription);
2503         }
2505         // Finally return the properties
2506         return $properties;
2507     }
2509     /**
2510      * Toggles the visibility of an event
2511      *
2512      * @param null|bool $force If it is left null the events visibility is flipped,
2513      *                   If it is false the event is made hidden, if it is true it
2514      *                   is made visible.
2515      * @return bool if event is successfully updated, toggle will be visible
2516      */
2517     public function toggle_visibility($force=null) {
2518         global $CFG, $DB;
2520         // Set visible to the default if it is not already set
2521         if (empty($this->properties->visible)) {
2522             $this->properties->visible = 1;
2523         }
2525         if ($force === true || ($force !== false && $this->properties->visible == 0)) {
2526             // Make this event visible
2527             $this->properties->visible = 1;
2528             // Fire the hook
2529             self::calendar_event_hook('show_event', array($this->properties));
2530         } else {
2531             // Make this event hidden
2532             $this->properties->visible = 0;
2533             // Fire the hook
2534             self::calendar_event_hook('hide_event', array($this->properties));
2535         }
2537         // Update the database to reflect this change
2538         return $DB->set_field('event', 'visible', $this->properties->visible, array('id'=>$this->properties->id));
2539     }
2541     /**
2542      * Attempts to call the hook for the specified action should a calendar type
2543      * by set $CFG->calendar, and the appopriate function defined
2544      *
2545      * @param string $action One of `update_event`, `add_event`, `delete_event`, `show_event`, `hide_event`
2546      * @param array $args The args to pass to the hook, usually the event is the first element
2547      * @return bool attempts to call event hook
2548      */
2549     public static function calendar_event_hook($action, array $args) {
2550         global $CFG;
2551         static $extcalendarinc;
2552         if ($extcalendarinc === null) {
2553             if (!empty($CFG->calendar)) {
2554                 if (is_readable($CFG->dirroot .'/calendar/'. $CFG->calendar .'/lib.php')) {
2555                     include_once($CFG->dirroot .'/calendar/'. $CFG->calendar .'/lib.php');
2556                     $extcalendarinc = true;
2557                 } else {
2558                     debugging("Calendar lib file missing or not readable at /calendar/{$CFG->calendar}/lib.php.",
2559                         DEBUG_DEVELOPER);
2560                     $extcalendarinc = false;
2561                 }
2562             } else {
2563                 $extcalendarinc = false;
2564             }
2565         }
2566         if($extcalendarinc === false) {
2567             return false;
2568         }
2569         $hook = $CFG->calendar .'_'.$action;
2570         if (function_exists($hook)) {
2571             call_user_func_array($hook, $args);
2572             return true;
2573         }
2574         return false;
2575     }
2577     /**
2578      * Returns a calendar_event object when provided with an event id
2579      *
2580      * This function makes use of MUST_EXIST, if the event id passed in is invalid
2581      * it will result in an exception being thrown
2582      *
2583      * @param int|object $param event object or event id
2584      * @return calendar_event|false status for loading calendar_event
2585      */
2586     public static function load($param) {
2587         global $DB;
2588         if (is_object($param)) {
2589             $event = new calendar_event($param);
2590         } else {
2591             $event = $DB->get_record('event', array('id'=>(int)$param), '*', MUST_EXIST);
2592             $event = new calendar_event($event);
2593         }
2594         return $event;
2595     }
2597     /**
2598      * Creates a new event and returns a calendar_event object
2599      *
2600      * @param object|array $properties An object containing event properties
2601      * @return calendar_event|false The event object or false if it failed
2602      */
2603     public static function create($properties) {
2604         if (is_array($properties)) {
2605             $properties = (object)$properties;
2606         }
2607         if (!is_object($properties)) {
2608             throw new coding_exception('When creating an event properties should be either an object or an assoc array');
2609         }
2610         $event = new calendar_event($properties);
2611         if ($event->update($properties)) {
2612             return $event;
2613         } else {
2614             return false;
2615         }
2616     }
2619 /**
2620  * Calendar information class
2621  *
2622  * This class is used simply to organise the information pertaining to a calendar
2623  * and is used primarily to make information easily available.
2624  *
2625  * @package core_calendar
2626  * @category calendar
2627  * @copyright 2010 Sam Hemelryk
2628  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2629  */
2630 class calendar_information {
2631     /** @var int The day */
2632     public $day;
2634     /** @var int The month */
2635     public $month;
2637     /** @var int The year */
2638     public $year;
2640     /** @var int A course id */
2641     public $courseid = null;
2643     /** @var array An array of courses */
2644     public $courses = array();
2646     /** @var array An array of groups */
2647     public $groups = array();
2649     /** @var array An array of users */
2650     public $users = array();
2652     /**
2653      * Creates a new instance
2654      *
2655      * @param int $day the number of the day
2656      * @param int $month the number of the month
2657      * @param int $year the number of the year
2658      */
2659     public function __construct($day=0, $month=0, $year=0) {
2661         $date = usergetdate(time());
2663         if (empty($day)) {
2664             $day = $date['mday'];
2665         }
2667         if (empty($month)) {
2668             $month = $date['mon'];
2669         }
2671         if (empty($year)) {
2672             $year =  $date['year'];
2673         }
2675         $this->day = $day;
2676         $this->month = $month;
2677         $this->year = $year;
2678     }
2680     /**
2681      * Initialize calendar information
2682      *
2683      * @param stdClass $course object
2684      * @param array $coursestoload An array of courses [$course->id => $course]
2685      * @param bool $ignorefilters options to use filter
2686      */
2687     public function prepare_for_view(stdClass $course, array $coursestoload, $ignorefilters = false) {
2688         $this->courseid = $course->id;
2689         $this->course = $course;
2690         list($courses, $group, $user) = calendar_set_filters($coursestoload, $ignorefilters);
2691         $this->courses = $courses;
2692         $this->groups = $group;
2693         $this->users = $user;
2694     }
2696     /**
2697      * Ensures the date for the calendar is correct and either sets it to now
2698      * or throws a moodle_exception if not
2699      *
2700      * @param bool $defaultonow use current time
2701      * @throws moodle_exception
2702      * @return bool validation of checkdate
2703      */
2704     public function checkdate($defaultonow = true) {
2705         if (!checkdate($this->month, $this->day, $this->year)) {
2706             if ($defaultonow) {
2707                 $now = usergetdate(time());
2708                 $this->day = intval($now['mday']);
2709                 $this->month = intval($now['mon']);
2710                 $this->year = intval($now['year']);
2711                 return true;
2712             } else {
2713                 throw new moodle_exception('invaliddate');
2714             }
2715         }
2716         return true;
2717     }
2718     /**
2719      * Gets todays timestamp for the calendar
2720      *
2721      * @return int today timestamp
2722      */
2723     public function timestamp_today() {
2724         return make_timestamp($this->year, $this->month, $this->day);
2725     }
2726     /**
2727      * Gets tomorrows timestamp for the calendar
2728      *
2729      * @return int tomorrow timestamp
2730      */
2731     public function timestamp_tomorrow() {
2732         return make_timestamp($this->year, $this->month, $this->day+1);
2733     }
2734     /**
2735      * Adds the pretend blocks for the calendar
2736      *
2737      * @param core_calendar_renderer $renderer
2738      * @param bool $showfilters display filters, false is set as default
2739      * @param string|null $view preference view options (eg: day, month, upcoming)
2740      */
2741     public function add_sidecalendar_blocks(core_calendar_renderer $renderer, $showfilters=false, $view=null) {
2742         if ($showfilters) {
2743             $filters = new block_contents();
2744             $filters->content = $renderer->fake_block_filters($this->courseid, $this->day, $this->month, $this->year, $view, $this->courses);
2745             $filters->footer = '';
2746             $filters->title = get_string('eventskey', 'calendar');
2747             $renderer->add_pretend_calendar_block($filters, BLOCK_POS_RIGHT);
2748         }
2749         $block = new block_contents;
2750         $block->content = $renderer->fake_block_threemonths($this);
2751         $block->footer = '';
2752         $block->title = get_string('monthlyview', 'calendar');
2753         $renderer->add_pretend_calendar_block($block, BLOCK_POS_RIGHT);
2754     }
2757 /**
2758  * Returns option list for the poll interval setting.
2759  *
2760  * @return array An array of poll interval options. Interval => description.
2761  */
2762 function calendar_get_pollinterval_choices() {
2763     return array(
2764         '0' => new lang_string('never', 'calendar'),
2765         '3600' => new lang_string('hourly', 'calendar'),
2766         '86400' => new lang_string('daily', 'calendar'),
2767         '604800' => new lang_string('weekly', 'calendar'),
2768         '2628000' => new lang_string('monthly', 'calendar'),
2769         '31536000' => new lang_string('annually', 'calendar')
2770     );
2773 /**
2774  * Returns option list of available options for the calendar event type, given the current user and course.
2775  *
2776  * @param int $courseid The id of the course
2777  * @return array An array containing the event types the user can create.
2778  */
2779 function calendar_get_eventtype_choices($courseid) {
2780     $choices = array();
2781     $allowed = new stdClass;
2782     calendar_get_allowed_types($allowed, $courseid);
2784     if ($allowed->user) {
2785         $choices['user'] = get_string('userevents', 'calendar');
2786     }
2787     if ($allowed->site) {
2788         $choices['site'] = get_string('siteevents', 'calendar');
2789     }
2790     if (!empty($allowed->courses)) {
2791         $choices['course'] = get_string('courseevents', 'calendar');
2792     }
2793     if (!empty($allowed->groups) and is_array($allowed->groups)) {
2794         $choices['group'] = get_string('group');
2795     }
2797     return array($choices, $allowed->groups);
2800 /**
2801  * Add an iCalendar subscription to the database.
2802  *
2803  * @param stdClass $sub The subscription object (e.g. from the form)
2804  * @return int The insert ID, if any.
2805  */
2806 function calendar_add_subscription($sub) {
2807     global $DB, $USER, $SITE;
2809     if ($sub->eventtype === 'site') {
2810         $sub->courseid = $SITE->id;
2811     } else if ($sub->eventtype === 'group' || $sub->eventtype === 'course') {
2812         $sub->courseid = $sub->course;
2813     } else {
2814         // User events.
2815         $sub->courseid = 0;
2816     }
2817     $sub->userid = $USER->id;
2819     // File subscriptions never update.
2820     if (empty($sub->url)) {
2821         $sub->pollinterval = 0;
2822     }
2824     if (!empty($sub->name)) {
2825         if (empty($sub->id)) {
2826             $id = $DB->insert_record('event_subscriptions', $sub);
2827             // we cannot cache the data here because $sub is not complete.
2828             return $id;
2829         } else {
2830             // Why are we doing an update here?
2831             calendar_update_subscription($sub);
2832             return $sub->id;
2833         }
2834     } else {
2835         print_error('errorbadsubscription', 'importcalendar');
2836     }
2839 /**
2840  * Add an iCalendar event to the Moodle calendar.
2841  *
2842  * @param object $event The RFC-2445 iCalendar event
2843  * @param int $courseid The course ID
2844  * @param int $subscriptionid The iCalendar subscription ID
2845  * @throws dml_exception A DML specific exception is thrown for invalid subscriptionids.
2846  * @return int Code: 1=updated, 2=inserted, 0=error
2847  */
2848 function calendar_add_icalendar_event($event, $courseid, $subscriptionid) {
2849     global $DB, $USER;
2851     // Probably an unsupported X-MICROSOFT-CDO-BUSYSTATUS event.
2852     if (empty($event->properties['SUMMARY'])) {
2853         return 0;
2854     }
2856     $name = $event->properties['SUMMARY'][0]->value;
2857     $name = str_replace('\n', '<br />', $name);
2858     $name = str_replace('\\', '', $name);
2859     $name = preg_replace('/\s+/', ' ', $name);
2861     $eventrecord = new stdClass;
2862     $eventrecord->name = clean_param($name, PARAM_NOTAGS);
2864     if (empty($event->properties['DESCRIPTION'][0]->value)) {
2865         $description = '';
2866     } else {
2867         $description = $event->properties['DESCRIPTION'][0]->value;
2868         $description = str_replace('\n', '<br />', $description);
2869         $description = str_replace('\\', '', $description);
2870         $description = preg_replace('/\s+/', ' ', $description);
2871     }
2872     $eventrecord->description = clean_param($description, PARAM_NOTAGS);
2874     // Probably a repeating event with RRULE etc. TODO: skip for now.
2875     if (empty($event->properties['DTSTART'][0]->value)) {
2876         return 0;
2877     }
2879     $eventrecord->timestart = strtotime($event->properties['DTSTART'][0]->value);
2880     if (empty($event->properties['DTEND'])) {
2881         $eventrecord->timeduration = 3600; // one hour if no end time specified
2882     } else {
2883         $eventrecord->timeduration = strtotime($event->properties['DTEND'][0]->value) - $eventrecord->timestart;
2884     }
2885     $eventrecord->uuid = $event->properties['UID'][0]->value;
2886     $eventrecord->timemodified = time();
2888     // Add the iCal subscription details if required.
2889     // We should never do anything with an event without a subscription reference.
2890     $sub = calendar_get_subscription($subscriptionid);
2891     $eventrecord->subscriptionid = $subscriptionid;
2892     $eventrecord->userid = $sub->userid;
2893     $eventrecord->groupid = $sub->groupid;
2894     $eventrecord->courseid = $sub->courseid;
2895     $eventrecord->eventtype = $sub->eventtype;
2897     if ($updaterecord = $DB->get_record('event', array('uuid' => $eventrecord->uuid))) {
2898         $eventrecord->id = $updaterecord->id;
2899         if ($DB->update_record('event', $eventrecord)) {
2900             return CALENDAR_IMPORT_EVENT_UPDATED;
2901         } else {
2902             return 0;
2903         }
2904     } else {
2905         if ($DB->insert_record('event', $eventrecord)) {
2906             return CALENDAR_IMPORT_EVENT_INSERTED;
2907         } else {
2908             return 0;
2909         }
2910     }
2913 /**
2914  * Update a subscription from the form data in one of the rows in the existing subscriptions table.
2915  *
2916  * @param int $subscriptionid The ID of the subscription we are acting upon.
2917  * @param int $pollinterval The poll interval to use.
2918  * @param int $action The action to be performed. One of update or remove.
2919  * @throws dml_exception if invalid subscriptionid is provided
2920  * @return string A log of the import progress, including errors
2921  */
2922 function calendar_process_subscription_row($subscriptionid, $pollinterval, $action) {
2923     global $DB;
2925     // Fetch the subscription from the database making sure it exists.
2926     $sub = calendar_get_subscription($subscriptionid);
2928     $strupdate = get_string('update');
2929     $strremove = get_string('remove');
2931     // Update or remove the subscription, based on action.
2932     switch ($action) {
2933         case $strupdate:
2934             // Skip updating file subscriptions.
2935             if (empty($sub->url)) {
2936                 break;
2937             }
2938             $sub->pollinterval = $pollinterval;
2939             calendar_update_subscription($sub);
2941             // Update the events.
2942             return "<p>".get_string('subscriptionupdated', 'calendar', $sub->name)."</p>" . calendar_update_subscription_events($subscriptionid);
2944         case $strremove:
2945             calendar_delete_subscription($subscriptionid);
2946             return get_string('subscriptionremoved', 'calendar', $sub->name);
2947             break;
2949         default:
2950             break;
2951     }
2952     return '';
2955 /**
2956  * Delete subscription and all related events.
2957  *
2958  * @param int|stdClass $subscription subscription or it's id, which needs to be deleted.
2959  */
2960 function calendar_delete_subscription($subscription) {
2961     global $DB;
2963     if (is_object($subscription)) {
2964         $subscription = $subscription->id;
2965     }
2966     // Delete subscription and related events.
2967     $DB->delete_records('event', array('subscriptionid' => $subscription));
2968     $DB->delete_records('event_subscriptions', array('id' => $subscription));
2969     cache_helper::invalidate_by_definition('core', 'calendar_subscriptions', array(), array($subscription));
2971 /**
2972  * From a URL, fetch the calendar and return an iCalendar object.
2973  *
2974  * @param string $url The iCalendar URL
2975  * @return stdClass The iCalendar object
2976  */
2977 function calendar_get_icalendar($url) {
2978     global $CFG;
2980     require_once($CFG->libdir.'/filelib.php');
2982     $curl = new curl();
2983     $curl->setopt(array('CURLOPT_FOLLOWLOCATION' => 1, 'CURLOPT_MAXREDIRS' => 5));
2984     $calendar = $curl->get($url);
2985     // Http code validation should actually be the job of curl class.
2986     if (!$calendar || $curl->info['http_code'] != 200 || !empty($curl->errorno)) {
2987         throw new moodle_exception('errorinvalidicalurl', 'calendar');
2988     }
2990     $ical = new iCalendar();
2991     $ical->unserialize($calendar);
2992     return $ical;
2995 /**
2996  * Import events from an iCalendar object into a course calendar.
2997  *
2998  * @param stdClass $ical The iCalendar object.
2999  * @param int $courseid The course ID for the calendar.
3000  * @param int $subscriptionid The subscription ID.
3001  * @return string A log of the import progress, including errors.
3002  */
3003 function calendar_import_icalendar_events($ical, $courseid, $subscriptionid = null) {
3004     global $DB;
3005     $return = '';
3006     $eventcount = 0;
3007     $updatecount = 0;
3009     // Large calendars take a while...
3010     set_time_limit(300);
3012     // Mark all events in a subscription with a zero timestamp.
3013     if (!empty($subscriptionid)) {
3014         $sql = "UPDATE {event} SET timemodified = :time WHERE subscriptionid = :id";
3015         $DB->execute($sql, array('time' => 0, 'id' => $subscriptionid));
3016     }
3017     foreach ($ical->components['VEVENT'] as $event) {
3018         $res = calendar_add_icalendar_event($event, $courseid, $subscriptionid);
3019         switch ($res) {
3020           case CALENDAR_IMPORT_EVENT_UPDATED:
3021             $updatecount++;
3022             break;
3023           case CALENDAR_IMPORT_EVENT_INSERTED:
3024             $eventcount++;
3025             break;
3026           case 0:
3027             $return .= '<p>'.get_string('erroraddingevent', 'calendar').': '.(empty($event->properties['SUMMARY'])?'('.get_string('notitle', 'calendar').')':$event->properties['SUMMARY'][0]->value)." </p>\n";
3028             break;
3029         }
3030     }
3031     $return .= "<p> ".get_string('eventsimported', 'calendar', $eventcount)."</p>";
3032     $return .= "<p> ".get_string('eventsupdated', 'calendar', $updatecount)."</p>";
3034     // Delete remaining zero-marked events since they're not in remote calendar.
3035     if (!empty($subscriptionid)) {
3036         $deletecount = $DB->count_records('event', array('timemodified' => 0, 'subscriptionid' => $subscriptionid));
3037         if (!empty($deletecount)) {
3038             $sql = "DELETE FROM {event} WHERE timemodified = :time AND subscriptionid = :id";
3039             $DB->execute($sql, array('time' => 0, 'id' => $subscriptionid));
3040             $return .= "<p> ".get_string('eventsdeleted', 'calendar').": {$deletecount} </p>\n";
3041         }
3042     }
3044     return $return;
3047 /**
3048  * Fetch a calendar subscription and update the events in the calendar.
3049  *
3050  * @param int $subscriptionid The course ID for the calendar.
3051  * @return string A log of the import progress, including errors.
3052  */
3053 function calendar_update_subscription_events($subscriptionid) {
3054     global $DB;
3056     $sub = calendar_get_subscription($subscriptionid);
3057     // Don't update a file subscription. TODO: Update from a new uploaded file.
3058     if (empty($sub->url)) {
3059         return 'File subscription not updated.';
3060     }
3061     $ical = calendar_get_icalendar($sub->url);
3062     $return = calendar_import_icalendar_events($ical, $sub->courseid, $subscriptionid);
3063     $sub->lastupdated = time();
3064     calendar_update_subscription($sub);
3065     return $return;
3068 /**
3069  * Update a calendar subscription. Also updates the associated cache.
3070  *
3071  * @param stdClass|array $subscription Subscription record.
3072  * @throws coding_exception If something goes wrong
3073  * @since Moodle 2.5
3074  */
3075 function calendar_update_subscription($subscription) {
3076     global $DB;
3078     if (is_array($subscription)) {
3079         $subscription = (object)$subscription;
3080     }
3081     if (empty($subscription->id) || !$DB->record_exists('event_subscriptions', array('id' => $subscription->id))) {
3082         throw new coding_exception('Cannot update a subscription without a valid id');
3083     }
3085     $DB->update_record('event_subscriptions', $subscription);
3086     // Update cache.
3087     $cache = cache::make('core', 'calendar_subscriptions');
3088     $cache->set($subscription->id, $subscription);
3091 /**
3092  * Checks to see if the user can edit a given subscription feed.
3093  *
3094  * @param mixed $subscriptionorid Subscription object or id
3095  * @return bool true if current user can edit the subscription else false
3096  */
3097 function calendar_can_edit_subscription($subscriptionorid) {
3098     global $DB;
3100     if (is_array($subscriptionorid)) {
3101         $subscription = (object)$subscriptionorid;
3102     } else if (is_object($subscriptionorid)) {
3103         $subscription = $subscriptionorid;
3104     } else {
3105         $subscription = calendar_get_subscription($subscriptionorid);
3106     }
3107     $allowed = new stdClass;
3108     $courseid = $subscription->courseid;
3109     $groupid = $subscription->groupid;
3110     calendar_get_allowed_types($allowed, $courseid);
3111     switch ($subscription->eventtype) {
3112         case 'user':
3113             return $allowed->user;
3114         case 'course':
3115             if (isset($allowed->courses[$courseid])) {
3116                 return $allowed->courses[$courseid];
3117             } else {
3118                 return false;
3119             }
3120         case 'site':
3121             return $allowed->site;
3122         case 'group':
3123             if (isset($allowed->groups[$groupid])) {
3124                 return $allowed->groups[$groupid];
3125             } else {
3126                 return false;
3127             }
3128         default:
3129             return false;
3130     }
3133 /**
3134  * Update calendar subscriptions.
3135  *
3136  * @return bool
3137  */
3138 function calendar_cron() {
3139     global $CFG, $DB;
3141     // In order to execute this we need bennu.
3142     require_once($CFG->libdir.'/bennu/bennu.inc.php');
3144     mtrace('Updating calendar subscriptions:');
3145     cron_trace_time_and_memory();
3147     $time = time();
3148     $subscriptions = $DB->get_records_sql('SELECT * FROM {event_subscriptions} WHERE pollinterval > 0 AND lastupdated + pollinterval < ?', array($time));
3149     foreach ($subscriptions as $sub) {
3150         mtrace("Updating calendar subscription {$sub->name} in course {$sub->courseid}");
3151         try {
3152             $log = calendar_update_subscription_events($sub->id);
3153         } catch (moodle_exception $ex) {
3155         }
3156         mtrace(trim(strip_tags($log)));
3157     }
3159     mtrace('Finished updating calendar subscriptions.');
3161     return true;