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