MDL-30888 Accessibility: small calendars summary does not display 'Data table'
[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 /**
27  *  These are read by the administration component to provide default values
28  */
30 /**
31  * CALENDAR_DEFAULT_UPCOMING_LOOKAHEAD - default value of upcoming event preference
32  */
33 define('CALENDAR_DEFAULT_UPCOMING_LOOKAHEAD', 21);
35 /**
36  * CALENDAR_DEFAULT_UPCOMING_MAXEVENTS - default value to display the maximum number of upcoming event
37  */
38 define('CALENDAR_DEFAULT_UPCOMING_MAXEVENTS', 10);
40 /**
41  * CALENDAR_DEFAULT_STARTING_WEEKDAY - default value to display the starting weekday
42  */
43 define('CALENDAR_DEFAULT_STARTING_WEEKDAY', 1);
45 // This is a packed bitfield: day X is "weekend" if $field & (1 << X) is true
46 // Default value = 65 = 64 + 1 = 2^6 + 2^0 = Saturday & Sunday
48 /**
49  * CALENDAR_DEFAULT_WEEKEND - default value for weekend (Saturday & Sunday)
50  */
51 define('CALENDAR_DEFAULT_WEEKEND', 65);
53 /**
54  * CALENDAR_URL - path to calendar's folder
55  */
56 define('CALENDAR_URL', $CFG->wwwroot.'/calendar/');
58 /**
59  * CALENDAR_TF_24 - Calendar time in 24 hours format
60  */
61 define('CALENDAR_TF_24', '%H:%M');
63 /**
64  * CALENDAR_TF_12 - Calendar time in 12 hours format
65  */
66 define('CALENDAR_TF_12', '%I:%M %p');
68 /**
69  * CALENDAR_EVENT_GLOBAL - Global calendar event types
70  */
71 define('CALENDAR_EVENT_GLOBAL', 1);
73 /**
74  * CALENDAR_EVENT_COURSE - Course calendar event types
75  */
76 define('CALENDAR_EVENT_COURSE', 2);
78 /**
79  * CALENDAR_EVENT_GROUP - group calendar event types
80  */
81 define('CALENDAR_EVENT_GROUP', 4);
83 /**
84  * CALENDAR_EVENT_USER - user calendar event types
85  */
86 define('CALENDAR_EVENT_USER', 8);
88 /**
89  * CALENDAR_STARTING_WEEKDAY - has since been deprecated please call calendar_get_starting_weekday() instead
90  *
91  * @deprecated Moodle 2.0 MDL-24284- please do not use this function any more.
92  * @todo MDL-31132 This will be deleted in Moodle 2.3.
93  * @see calendar_get_starting_weekday()
94  */
95 define('CALENDAR_STARTING_WEEKDAY', CALENDAR_DEFAULT_STARTING_WEEKDAY);
97 /**
98  * Return the days of the week
99  *
100  * @return array array of days
101  */
102 function calendar_get_days() {
103     return array('sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday');
106 /**
107  * Gets the first day of the week
108  *
109  * Used to be define('CALENDAR_STARTING_WEEKDAY', blah);
110  *
111  * @return int
112  */
113 function calendar_get_starting_weekday() {
114     global $CFG;
116     if (isset($CFG->calendar_startwday)) {
117         $firstday = $CFG->calendar_startwday;
118     } else {
119         $firstday = get_string('firstdayofweek', 'langconfig');
120     }
122     if(!is_numeric($firstday)) {
123         return CALENDAR_DEFAULT_STARTING_WEEKDAY;
124     } else {
125         return intval($firstday) % 7;
126     }
129 /**
130  * Generates the HTML for a miniature calendar
131  *
132  * @param array $courses list of course
133  * @param array $groups list of group
134  * @param array $users user's info
135  * @param int $cal_month calendar month in numeric, default is set to false
136  * @param int $cal_year calendar month in numeric, default is set to false
137  * @return string $content return html table for mini calendar
138  */
139 function calendar_get_mini($courses, $groups, $users, $cal_month = false, $cal_year = false) {
140     global $CFG, $USER, $OUTPUT;
142     $display = new stdClass;
143     $display->minwday = get_user_preferences('calendar_startwday', calendar_get_starting_weekday());
144     $display->maxwday = $display->minwday + 6;
146     $content = '';
148     if(!empty($cal_month) && !empty($cal_year)) {
149         $thisdate = usergetdate(time()); // Date and time the user sees at his location
150         if($cal_month == $thisdate['mon'] && $cal_year == $thisdate['year']) {
151             // Navigated to this month
152             $date = $thisdate;
153             $display->thismonth = true;
154         } else {
155             // Navigated to other month, let's do a nice trick and save us a lot of work...
156             if(!checkdate($cal_month, 1, $cal_year)) {
157                 $date = array('mday' => 1, 'mon' => $thisdate['mon'], 'year' => $thisdate['year']);
158                 $display->thismonth = true;
159             } else {
160                 $date = array('mday' => 1, 'mon' => $cal_month, 'year' => $cal_year);
161                 $display->thismonth = false;
162             }
163         }
164     } else {
165         $date = usergetdate(time()); // Date and time the user sees at his location
166         $display->thismonth = true;
167     }
169     // Fill in the variables we 're going to use, nice and tidy
170     list($d, $m, $y) = array($date['mday'], $date['mon'], $date['year']); // This is what we want to display
171     $display->maxdays = calendar_days_in_month($m, $y);
173     if (get_user_timezone_offset() < 99) {
174         // We 'll keep these values as GMT here, and offset them when the time comes to query the db
175         $display->tstart = gmmktime(0, 0, 0, $m, 1, $y); // This is GMT
176         $display->tend = gmmktime(23, 59, 59, $m, $display->maxdays, $y); // GMT
177     } else {
178         // no timezone info specified
179         $display->tstart = mktime(0, 0, 0, $m, 1, $y);
180         $display->tend = mktime(23, 59, 59, $m, $display->maxdays, $y);
181     }
183     $startwday = dayofweek(1, $m, $y);
185     // Align the starting weekday to fall in our display range
186     // This is simple, not foolproof.
187     if($startwday < $display->minwday) {
188         $startwday += 7;
189     }
191     // TODO: THIS IS TEMPORARY CODE!
192     // [pj] I was just reading through this and realized that I when writing this code I was probably
193     // asking for trouble, as all these time manipulations seem to be unnecessary and a simple
194     // make_timestamp would accomplish the same thing. So here goes a test:
195     //$test_start = make_timestamp($y, $m, 1);
196     //$test_end   = make_timestamp($y, $m, $display->maxdays, 23, 59, 59);
197     //if($test_start != usertime($display->tstart) - dst_offset_on($display->tstart)) {
198         //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);
199     //}
200     //if($test_end != usertime($display->tend) - dst_offset_on($display->tend)) {
201         //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);
202     //}
205     // Get the events matching our criteria. Don't forget to offset the timestamps for the user's TZ!
206     $events = calendar_get_events(
207         usertime($display->tstart) - dst_offset_on($display->tstart),
208         usertime($display->tend) - dst_offset_on($display->tend),
209         $users, $groups, $courses);
211     // Set event course class for course events
212     if (!empty($events)) {
213         foreach ($events as $eventid => $event) {
214             if (!empty($event->modulename)) {
215                 $cm = get_coursemodule_from_instance($event->modulename, $event->instance);
216                 if (!groups_course_module_visible($cm)) {
217                     unset($events[$eventid]);
218                 }
219             }
220         }
221     }
223     // This is either a genius idea or an idiot idea: in order to not complicate things, we use this rule: if, after
224     // possibly removing SITEID from $courses, there is only one course left, then clicking on a day in the month
225     // will also set the $SESSION->cal_courses_shown variable to that one course. Otherwise, we 'd need to add extra
226     // arguments to this function.
228     $hrefparams = array();
229     if(!empty($courses)) {
230         $courses = array_diff($courses, array(SITEID));
231         if(count($courses) == 1) {
232             $hrefparams['course'] = reset($courses);
233         }
234     }
236     // We want to have easy access by day, since the display is on a per-day basis.
237     // Arguments passed by reference.
238     //calendar_events_by_day($events, $display->tstart, $eventsbyday, $durationbyday, $typesbyday);
239     calendar_events_by_day($events, $m, $y, $eventsbyday, $durationbyday, $typesbyday, $courses);
241     //Accessibility: added summary and <abbr> elements.
242     $days_title = calendar_get_days();
244     $summary = get_string('calendarheading', 'calendar', userdate(make_timestamp($y, $m), get_string('strftimemonthyear')));
245     $content .= '<table class="minicalendar calendartable" summary="'.$summary.'">'; // Begin table
246     $content .= '<tr class="weekdays">'; // Header row: day names
248     // Print out the names of the weekdays
249     $days = array('sun', 'mon', 'tue', 'wed', 'thu', 'fri', 'sat');
250     for($i = $display->minwday; $i <= $display->maxwday; ++$i) {
251         // This uses the % operator to get the correct weekday no matter what shift we have
252         // applied to the $display->minwday : $display->maxwday range from the default 0 : 6
253         $content .= '<th scope="col"><abbr title="'. get_string($days_title[$i % 7], 'calendar') .'">'.
254             get_string($days[$i % 7], 'calendar') ."</abbr></th>\n";
255     }
257     $content .= '</tr><tr>'; // End of day names; prepare for day numbers
259     // For the table display. $week is the row; $dayweek is the column.
260     $dayweek = $startwday;
262     // Paddding (the first week may have blank days in the beginning)
263     for($i = $display->minwday; $i < $startwday; ++$i) {
264         $content .= '<td class="dayblank">&nbsp;</td>'."\n";
265     }
267     $weekend = CALENDAR_DEFAULT_WEEKEND;
268     if (isset($CFG->calendar_weekend)) {
269         $weekend = intval($CFG->calendar_weekend);
270     }
272     // Now display all the calendar
273     for($day = 1; $day <= $display->maxdays; ++$day, ++$dayweek) {
274         if($dayweek > $display->maxwday) {
275             // We need to change week (table row)
276             $content .= '</tr><tr>';
277             $dayweek = $display->minwday;
278         }
280         // Reset vars
281         $cell = '';
282         if ($weekend & (1 << ($dayweek % 7))) {
283             // Weekend. This is true no matter what the exact range is.
284             $class = 'weekend day';
285         } else {
286             // Normal working day.
287             $class = 'day';
288         }
290         // Special visual fx if an event is defined
291         if(isset($eventsbyday[$day])) {
292             $class .= ' hasevent';
293             $hrefparams['view'] = 'day';
294             $dayhref = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', $hrefparams), $day, $m, $y);
296             $popupcontent = '';
297             foreach($eventsbyday[$day] as $eventid) {
298                 if (!isset($events[$eventid])) {
299                     continue;
300                 }
301                 $event = $events[$eventid];
302                 $popupalt  = '';
303                 $component = 'moodle';
304                 if(!empty($event->modulename)) {
305                     $popupicon = 'icon';
306                     $popupalt  = $event->modulename;
307                     $component = $event->modulename;
308                 } else if ($event->courseid == SITEID) {                                // Site event
309                     $popupicon = 'c/site';
310                 } else if ($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) {      // Course event
311                     $popupicon = 'c/course';
312                 } else if ($event->groupid) {                                      // Group event
313                     $popupicon = 'c/group';
314                 } else if ($event->userid) {                                       // User event
315                     $popupicon = 'c/user';
316                 }
318                 $dayhref->set_anchor('event_'.$event->id);
320                 $popupcontent .= html_writer::start_tag('div');
321                 $popupcontent .= $OUTPUT->pix_icon($popupicon, $popupalt, $component);
322                 $popupcontent .= html_writer::link($dayhref, format_string($event->name, true));
323                 $popupcontent .= html_writer::end_tag('div');
324             }
326             //Accessibility: functionality moved to calendar_get_popup.
327             if($display->thismonth && $day == $d) {
328                 $popup = calendar_get_popup(true, $events[$eventid]->timestart, $popupcontent);
329             } else {
330                 $popup = calendar_get_popup(false, $events[$eventid]->timestart, $popupcontent);
331             }
333             // Class and cell content
334             if(isset($typesbyday[$day]['startglobal'])) {
335                 $class .= ' calendar_event_global';
336             } else if(isset($typesbyday[$day]['startcourse'])) {
337                 $class .= ' calendar_event_course';
338             } else if(isset($typesbyday[$day]['startgroup'])) {
339                 $class .= ' calendar_event_group';
340             } else if(isset($typesbyday[$day]['startuser'])) {
341                 $class .= ' calendar_event_user';
342             }
343             $cell = '<a href="'.(string)$dayhref.'" '.$popup.'>'.$day.'</a>';
344         } else {
345             $cell = $day;
346         }
348         $durationclass = false;
349         if (isset($typesbyday[$day]['durationglobal'])) {
350             $durationclass = ' duration_global';
351         } else if(isset($typesbyday[$day]['durationcourse'])) {
352             $durationclass = ' duration_course';
353         } else if(isset($typesbyday[$day]['durationgroup'])) {
354             $durationclass = ' duration_group';
355         } else if(isset($typesbyday[$day]['durationuser'])) {
356             $durationclass = ' duration_user';
357         }
358         if ($durationclass) {
359             $class .= ' duration '.$durationclass;
360         }
362         // If event has a class set then add it to the table day <td> tag
363         // Note: only one colour for minicalendar
364         if(isset($eventsbyday[$day])) {
365             foreach($eventsbyday[$day] as $eventid) {
366                 if (!isset($events[$eventid])) {
367                     continue;
368                 }
369                 $event = $events[$eventid];
370                 if (!empty($event->class)) {
371                     $class .= ' '.$event->class;
372                 }
373                 break;
374             }
375         }
377         // Special visual fx for today
378         //Accessibility: hidden text for today, and popup.
379         if($display->thismonth && $day == $d) {
380             $class .= ' today';
381             $today = get_string('today', 'calendar').' '.userdate(time(), get_string('strftimedayshort'));
383             if(! isset($eventsbyday[$day])) {
384                 $class .= ' eventnone';
385                 $popup = calendar_get_popup(true, false);
386                 $cell = '<a href="#" '.$popup.'>'.$day.'</a>';
387             }
388             $cell = get_accesshide($today.' ').$cell;
389         }
391         // Just display it
392         if(!empty($class)) {
393             $class = ' class="'.$class.'"';
394         }
395         $content .= '<td'.$class.'>'.$cell."</td>\n";
396     }
398     // Paddding (the last week may have blank days at the end)
399     for($i = $dayweek; $i <= $display->maxwday; ++$i) {
400         $content .= '<td class="dayblank">&nbsp;</td>';
401     }
402     $content .= '</tr>'; // Last row ends
404     $content .= '</table>'; // Tabular display of days ends
406     return $content;
409 /**
410  * Gets the calendar popup
411  *
412  * It called at multiple points in from calendar_get_mini.
413  * Copied and modified from calendar_get_mini.
414  *
415  * @param bool $is_today false except when called on the current day.
416  * @param mixed $event_timestart $events[$eventid]->timestart, OR false if there are no events.
417  * @param string $popupcontent content for the popup window/layout
418  * @return string of eventid for the calendar_tooltip popup window/layout
419  */
420 function calendar_get_popup($is_today, $event_timestart, $popupcontent='') {
421     global $PAGE;
422     static $popupcount;
423     if ($popupcount === null) {
424         $popupcount = 1;
425     }
426     $popupcaption = '';
427     if($is_today) {
428         $popupcaption = get_string('today', 'calendar').' ';
429     }
430     if (false === $event_timestart) {
431         $popupcaption .= userdate(time(), get_string('strftimedayshort'));
432         $popupcontent = get_string('eventnone', 'calendar');
434     } else {
435         $popupcaption .= get_string('eventsfor', 'calendar', userdate($event_timestart, get_string('strftimedayshort')));
436     }
437     $id = 'calendar_tooltip_'.$popupcount;
438     $PAGE->requires->yui_module('moodle-calendar-eventmanager', 'M.core_calendar.add_event', array(array('eventId'=>$id,'title'=>$popupcaption, 'content'=>$popupcontent)));
440     $popupcount++;
441     return 'id="'.$id.'"';
444 /**
445  * Gets the calendar upcoming event
446  *
447  * @param array $courses array of courses
448  * @param array|int|bool $groups array of groups, group id or boolean for all/no group events
449  * @param array|int|bool $users array of users, user id or boolean for all/no user events
450  * @param int $daysinfuture number of days in the future we 'll look
451  * @param int $maxevents maximum number of events
452  * @param int $fromtime start time
453  * @return array $output array of upcoming events
454  */
455 function calendar_get_upcoming($courses, $groups, $users, $daysinfuture, $maxevents, $fromtime=0) {
456     global $CFG, $COURSE, $DB;
458     $display = new stdClass;
459     $display->range = $daysinfuture; // How many days in the future we 'll look
460     $display->maxevents = $maxevents;
462     $output = array();
464     // Prepare "course caching", since it may save us a lot of queries
465     $coursecache = array();
467     $processed = 0;
468     $now = time(); // We 'll need this later
469     $usermidnighttoday = usergetmidnight($now);
471     if ($fromtime) {
472         $display->tstart = $fromtime;
473     } else {
474         $display->tstart = $usermidnighttoday;
475     }
477     // This works correctly with respect to the user's DST, but it is accurate
478     // only because $fromtime is always the exact midnight of some day!
479     $display->tend = usergetmidnight($display->tstart + DAYSECS * $display->range + 3 * HOURSECS) - 1;
481     // Get the events matching our criteria
482     $events = calendar_get_events($display->tstart, $display->tend, $users, $groups, $courses);
484     // This is either a genius idea or an idiot idea: in order to not complicate things, we use this rule: if, after
485     // possibly removing SITEID from $courses, there is only one course left, then clicking on a day in the month
486     // will also set the $SESSION->cal_courses_shown variable to that one course. Otherwise, we 'd need to add extra
487     // arguments to this function.
489     $hrefparams = array();
490     if(!empty($courses)) {
491         $courses = array_diff($courses, array(SITEID));
492         if(count($courses) == 1) {
493             $hrefparams['course'] = reset($courses);
494         }
495     }
497     if ($events !== false) {
499         $modinfo = get_fast_modinfo($COURSE);
501         foreach($events as $event) {
504             if (!empty($event->modulename)) {
505                 if ($event->courseid == $COURSE->id) {
506                     if (isset($modinfo->instances[$event->modulename][$event->instance])) {
507                         $cm = $modinfo->instances[$event->modulename][$event->instance];
508                         if (!$cm->uservisible) {
509                             continue;
510                         }
511                     }
512                 } else {
513                     if (!$cm = get_coursemodule_from_instance($event->modulename, $event->instance)) {
514                         continue;
515                     }
516                     if (!coursemodule_visible_for_user($cm)) {
517                         continue;
518                     }
519                 }
520                 if ($event->modulename == 'assignment'){
521                     // create calendar_event to test edit_event capability
522                     // this new event will also prevent double creation of calendar_event object
523                     $checkevent = new calendar_event($event);
524                     // TODO: rewrite this hack somehow
525                     if (!calendar_edit_event_allowed($checkevent)){ // cannot manage entries, eg. student
526                         if (!$assignment = $DB->get_record('assignment', array('id'=>$event->instance))) {
527                             // print_error("invalidid", 'assignment');
528                             continue;
529                         }
530                         // assign assignment to assignment object to use hidden_is_hidden method
531                         require_once($CFG->dirroot.'/mod/assignment/lib.php');
533                         if (!file_exists($CFG->dirroot.'/mod/assignment/type/'.$assignment->assignmenttype.'/assignment.class.php')) {
534                             continue;
535                         }
536                         require_once ($CFG->dirroot.'/mod/assignment/type/'.$assignment->assignmenttype.'/assignment.class.php');
538                         $assignmentclass = 'assignment_'.$assignment->assignmenttype;
539                         $assignmentinstance = new $assignmentclass($cm->id, $assignment, $cm);
541                         if ($assignmentinstance->description_is_hidden()){//force not to show description before availability
542                             $event->description = get_string('notavailableyet', 'assignment');
543                         }
544                     }
545                 }
546             }
548             if ($processed >= $display->maxevents) {
549                 break;
550             }
552             $event->time = calendar_format_event_time($event, $now, $hrefparams);
553             $output[] = $event;
554             ++$processed;
555         }
556     }
557     return $output;
560 /**
561  * Add calendar event metadata
562  *
563  * @param stdClass $event event info
564  * @return stdClass $event metadata
565  */
566 function calendar_add_event_metadata($event) {
567     global $CFG, $OUTPUT;
569     //Support multilang in event->name
570     $event->name = format_string($event->name,true);
572     if(!empty($event->modulename)) {                                // Activity event
573         // The module name is set. I will assume that it has to be displayed, and
574         // also that it is an automatically-generated event. And of course that the
575         // fields for get_coursemodule_from_instance are set correctly.
576         $module = calendar_get_module_cached($coursecache, $event->modulename, $event->instance);
578         if ($module === false) {
579             return;
580         }
582         $modulename = get_string('modulename', $event->modulename);
583         if (get_string_manager()->string_exists($event->eventtype, $event->modulename)) {
584             // will be used as alt text if the event icon
585             $eventtype = get_string($event->eventtype, $event->modulename);
586         } else {
587             $eventtype = '';
588         }
589         $icon = $OUTPUT->pix_url('icon', $event->modulename) . '';
591         $context = get_context_instance(CONTEXT_COURSE, $module->course);
592         $fullname = format_string($coursecache[$module->course]->fullname, true, array('context' => $context));
594         $event->icon = '<img height="16" width="16" src="'.$icon.'" alt="'.$eventtype.'" title="'.$modulename.'" style="vertical-align: middle;" />';
595         $event->referer = '<a href="'.$CFG->wwwroot.'/mod/'.$event->modulename.'/view.php?id='.$module->id.'">'.$event->name.'</a>';
596         $event->courselink = '<a href="'.$CFG->wwwroot.'/course/view.php?id='.$module->course.'">'.$fullname.'</a>';
597         $event->cmid = $module->id;
600     } else if($event->courseid == SITEID) {                              // Site event
601         $event->icon = '<img height="16" width="16" src="'.$OUTPUT->pix_url('c/site') . '" alt="'.get_string('globalevent', 'calendar').'" style="vertical-align: middle;" />';
602         $event->cssclass = 'calendar_event_global';
603     } else if($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) {          // Course event
604         calendar_get_course_cached($coursecache, $event->courseid);
606         $context = get_context_instance(CONTEXT_COURSE, $event->courseid);
607         $fullname = format_string($coursecache[$event->courseid]->fullname, true, array('context' => $context));
609         $event->icon = '<img height="16" width="16" src="'.$OUTPUT->pix_url('c/course') . '" alt="'.get_string('courseevent', 'calendar').'" style="vertical-align: middle;" />';
610         $event->courselink = '<a href="'.$CFG->wwwroot.'/course/view.php?id='.$event->courseid.'">'.$fullname.'</a>';
611         $event->cssclass = 'calendar_event_course';
612     } else if ($event->groupid) {                                    // Group event
613         $event->icon = '<img height="16" width="16" src="'.$OUTPUT->pix_url('c/group') . '" alt="'.get_string('groupevent', 'calendar').'" style="vertical-align: middle;" />';
614         $event->cssclass = 'calendar_event_group';
615     } else if($event->userid) {                                      // User event
616         $event->icon = '<img height="16" width="16" src="'.$OUTPUT->pix_url('c/user') . '" alt="'.get_string('userevent', 'calendar').'" style="vertical-align: middle;" />';
617         $event->cssclass = 'calendar_event_user';
618     }
619     return $event;
622 /**
623  * Get calendar events
624  *
625  * @param int $tstart Start time of time range for events
626  * @param int $tend End time of time range for events
627  * @param array|int|boolean $users array of users, user id or boolean for all/no user events
628  * @param array|int|boolean $groups array of groups, group id or boolean for all/no group events
629  * @param array|int|boolean $courses array of courses, course id or boolean for all/no course events
630  * @param boolean $withduration whether only events starting within time range selected
631  *                              or events in progress/already started selected as well
632  * @param boolean $ignorehidden whether to select only visible events or all events
633  * @return array $events of selected events or an empty array if there aren't any (or there was an error)
634  */
635 function calendar_get_events($tstart, $tend, $users, $groups, $courses, $withduration=true, $ignorehidden=true) {
636     global $DB;
638     $whereclause = '';
639     // Quick test
640     if(is_bool($users) && is_bool($groups) && is_bool($courses)) {
641         return array();
642     }
644     if(is_array($users) && !empty($users)) {
645         // Events from a number of users
646         if(!empty($whereclause)) $whereclause .= ' OR';
647         $whereclause .= ' (userid IN ('.implode(',', $users).') AND courseid = 0 AND groupid = 0)';
648     } else if(is_numeric($users)) {
649         // Events from one user
650         if(!empty($whereclause)) $whereclause .= ' OR';
651         $whereclause .= ' (userid = '.$users.' AND courseid = 0 AND groupid = 0)';
652     } else if($users === true) {
653         // Events from ALL users
654         if(!empty($whereclause)) $whereclause .= ' OR';
655         $whereclause .= ' (userid != 0 AND courseid = 0 AND groupid = 0)';
656     } else if($users === false) {
657         // No user at all, do nothing
658     }
660     if(is_array($groups) && !empty($groups)) {
661         // Events from a number of groups
662         if(!empty($whereclause)) $whereclause .= ' OR';
663         $whereclause .= ' groupid IN ('.implode(',', $groups).')';
664     } else if(is_numeric($groups)) {
665         // Events from one group
666         if(!empty($whereclause)) $whereclause .= ' OR ';
667         $whereclause .= ' groupid = '.$groups;
668     } else if($groups === true) {
669         // Events from ALL groups
670         if(!empty($whereclause)) $whereclause .= ' OR ';
671         $whereclause .= ' groupid != 0';
672     }
673     // boolean false (no groups at all): we don't need to do anything
675     if(is_array($courses) && !empty($courses)) {
676         if(!empty($whereclause)) {
677             $whereclause .= ' OR';
678         }
679         $whereclause .= ' (groupid = 0 AND courseid IN ('.implode(',', $courses).'))';
680     } else if(is_numeric($courses)) {
681         // One course
682         if(!empty($whereclause)) $whereclause .= ' OR';
683         $whereclause .= ' (groupid = 0 AND courseid = '.$courses.')';
684     } else if ($courses === true) {
685         // Events from ALL courses
686         if(!empty($whereclause)) $whereclause .= ' OR';
687         $whereclause .= ' (groupid = 0 AND courseid != 0)';
688     }
690     // Security check: if, by now, we have NOTHING in $whereclause, then it means
691     // that NO event-selecting clauses were defined. Thus, we won't be returning ANY
692     // events no matter what. Allowing the code to proceed might return a completely
693     // valid query with only time constraints, thus selecting ALL events in that time frame!
694     if(empty($whereclause)) {
695         return array();
696     }
698     if($withduration) {
699         $timeclause = '(timestart >= '.$tstart.' OR timestart + timeduration > '.$tstart.') AND timestart <= '.$tend;
700     }
701     else {
702         $timeclause = 'timestart >= '.$tstart.' AND timestart <= '.$tend;
703     }
704     if(!empty($whereclause)) {
705         // We have additional constraints
706         $whereclause = $timeclause.' AND ('.$whereclause.')';
707     }
708     else {
709         // Just basic time filtering
710         $whereclause = $timeclause;
711     }
713     if ($ignorehidden) {
714         $whereclause .= ' AND visible = 1';
715     }
717     $events = $DB->get_records_select('event', $whereclause, null, 'timestart');
718     if ($events === false) {
719         $events = array();
720     }
721     return $events;
724 /**
725  * Get control options for Calendar
726  *
727  * @param string $type of calendar
728  * @param array $data calendar information
729  * @return string $content return available control for the calender in html
730  */
731 function calendar_top_controls($type, $data) {
732     global $CFG;
733     $content = '';
734     if(!isset($data['d'])) {
735         $data['d'] = 1;
736     }
738     // Ensure course id passed if relevant
739     // Required due to changes in view/lib.php mainly (calendar_session_vars())
740     $courseid = '';
741     if (!empty($data['id'])) {
742         $courseid = '&amp;course='.$data['id'];
743     }
745     if(!checkdate($data['m'], $data['d'], $data['y'])) {
746         $time = time();
747     }
748     else {
749         $time = make_timestamp($data['y'], $data['m'], $data['d']);
750     }
751     $date = usergetdate($time);
753     $data['m'] = $date['mon'];
754     $data['y'] = $date['year'];
756     //Accessibility: calendar block controls, replaced <table> with <div>.
757     //$nexttext = link_arrow_right(get_string('monthnext', 'access'), $url='', $accesshide=true);
758     //$prevtext = link_arrow_left(get_string('monthprev', 'access'), $url='', $accesshide=true);
760     switch($type) {
761         case 'frontpage':
762             list($prevmonth, $prevyear) = calendar_sub_month($data['m'], $data['y']);
763             list($nextmonth, $nextyear) = calendar_add_month($data['m'], $data['y']);
764             $nextlink = calendar_get_link_next(get_string('monthnext', 'access'), 'index.php?', 0, $nextmonth, $nextyear, $accesshide=true);
765             $prevlink = calendar_get_link_previous(get_string('monthprev', 'access'), 'index.php?', 0, $prevmonth, $prevyear, true);
767             $calendarlink = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', array('view'=>'month')), 1, $data['m'], $data['y']);
768             if (!empty($data['id'])) {
769                 $calendarlink->param('course', $data['id']);
770             }
772             if (right_to_left()) {
773                 $left = $nextlink;
774                 $right = $prevlink;
775             } else {
776                 $left = $prevlink;
777                 $right = $nextlink;
778             }
780             $content .= html_writer::start_tag('div', array('class'=>'calendar-controls'));
781             $content .= $left.'<span class="hide"> | </span>';
782             $content .= html_writer::tag('span', html_writer::link($calendarlink, userdate($time, get_string('strftimemonthyear')), array('title'=>get_string('monththis','calendar'))), array('class'=>'current'));
783             $content .= '<span class="hide"> | </span>'. $right;
784             $content .= "<span class=\"clearer\"><!-- --></span>\n";
785             $content .= html_writer::end_tag('div');
787             break;
788         case 'course':
789             list($prevmonth, $prevyear) = calendar_sub_month($data['m'], $data['y']);
790             list($nextmonth, $nextyear) = calendar_add_month($data['m'], $data['y']);
791             $nextlink = calendar_get_link_next(get_string('monthnext', 'access'), 'view.php?id='.$data['id'].'&amp;', 0, $nextmonth, $nextyear, $accesshide=true);
792             $prevlink = calendar_get_link_previous(get_string('monthprev', 'access'), 'view.php?id='.$data['id'].'&amp;', 0, $prevmonth, $prevyear, true);
794             $calendarlink = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', array('view'=>'month')), 1, $data['m'], $data['y']);
795             if (!empty($data['id'])) {
796                 $calendarlink->param('course', $data['id']);
797             }
799             if (right_to_left()) {
800                 $left = $nextlink;
801                 $right = $prevlink;
802             } else {
803                 $left = $prevlink;
804                 $right = $nextlink;
805             }
807             $content .= html_writer::start_tag('div', array('class'=>'calendar-controls'));
808             $content .= $left.'<span class="hide"> | </span>';
809             $content .= html_writer::tag('span', html_writer::link($calendarlink, userdate($time, get_string('strftimemonthyear')), array('title'=>get_string('monththis','calendar'))), array('class'=>'current'));
810             $content .= '<span class="hide"> | </span>'. $right;
811             $content .= "<span class=\"clearer\"><!-- --></span>";
812             $content .= html_writer::end_tag('div');
813             break;
814         case 'upcoming':
815             $calendarlink = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', array('view'=>'upcoming')), 1, $data['m'], $data['y']);
816             if (!empty($data['id'])) {
817                 $calendarlink->param('course', $data['id']);
818             }
819             $calendarlink = html_writer::link($calendarlink, userdate($time, get_string('strftimemonthyear')));
820             $content .= html_writer::tag('div', $calendarlink, array('class'=>'centered'));
821             break;
822         case 'display':
823             $calendarlink = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', array('view'=>'month')), 1, $data['m'], $data['y']);
824             if (!empty($data['id'])) {
825                 $calendarlink->param('course', $data['id']);
826             }
827             $calendarlink = html_writer::link($calendarlink, userdate($time, get_string('strftimemonthyear')));
828             $content .= html_writer::tag('h3', $calendarlink);
829             break;
830         case 'month':
831             list($prevmonth, $prevyear) = calendar_sub_month($data['m'], $data['y']);
832             list($nextmonth, $nextyear) = calendar_add_month($data['m'], $data['y']);
833             $prevdate = make_timestamp($prevyear, $prevmonth, 1);
834             $nextdate = make_timestamp($nextyear, $nextmonth, 1);
835             $prevlink = calendar_get_link_previous(userdate($prevdate, get_string('strftimemonthyear')), 'view.php?view=month'.$courseid.'&amp;', 1, $prevmonth, $prevyear);
836             $nextlink = calendar_get_link_next(userdate($nextdate, get_string('strftimemonthyear')), 'view.php?view=month'.$courseid.'&amp;', 1, $nextmonth, $nextyear);
838             if (right_to_left()) {
839                 $left = $nextlink;
840                 $right = $prevlink;
841             } else {
842                 $left = $prevlink;
843                 $right = $nextlink;
844             }
846             $content .= html_writer::start_tag('div', array('class'=>'calendar-controls'));
847             $content .= $left . '<span class="hide"> | </span><h1 class="current">'.userdate($time, get_string('strftimemonthyear'))."</h1>";
848             $content .= '<span class="hide"> | </span>' . $right;
849             $content .= '<span class="clearer"><!-- --></span>';
850             $content .= html_writer::end_tag('div')."\n";
851             break;
852         case 'day':
853             $days = calendar_get_days();
854             $data['d'] = $date['mday']; // Just for convenience
855             $prevdate = usergetdate(make_timestamp($data['y'], $data['m'], $data['d'] - 1));
856             $nextdate = usergetdate(make_timestamp($data['y'], $data['m'], $data['d'] + 1));
857             $prevname = calendar_wday_name($days[$prevdate['wday']]);
858             $nextname = calendar_wday_name($days[$nextdate['wday']]);
859             $prevlink = calendar_get_link_previous($prevname, 'view.php?view=day'.$courseid.'&amp;', $prevdate['mday'], $prevdate['mon'], $prevdate['year']);
860             $nextlink = calendar_get_link_next($nextname, 'view.php?view=day'.$courseid.'&amp;', $nextdate['mday'], $nextdate['mon'], $nextdate['year']);
862             if (right_to_left()) {
863                 $left = $nextlink;
864                 $right = $prevlink;
865             } else {
866                 $left = $prevlink;
867                 $right = $nextlink;
868             }
870             $content .= html_writer::start_tag('div', array('class'=>'calendar-controls'));
871             $content .= $left;
872             $content .= '<span class="hide"> | </span><span class="current">'.userdate($time, get_string('strftimedaydate')).'</span>';
873             $content .= '<span class="hide"> | </span>'. $right;
874             $content .= "<span class=\"clearer\"><!-- --></span>";
875             $content .= html_writer::end_tag('div')."\n";
877             break;
878     }
879     return $content;
882 /**
883  * Get the controls filter for calendar.
884  *
885  * Filter is used to hide calendar info from the display page
886  *
887  * @param moodle_url $returnurl return-url for filter controls
888  * @return string $content return filter controls in html
889  */
890 function calendar_filter_controls(moodle_url $returnurl) {
891     global $CFG, $USER, $OUTPUT;
893     $groupevents = true;
895     $id = optional_param( 'id',0,PARAM_INT );
897     $seturl = new moodle_url('/calendar/set.php', array('return' => base64_encode($returnurl->out(false)), 'sesskey'=>sesskey()));
899     $content = '<table>';
900     $content .= '<tr>';
902     $seturl->param('var', 'showglobal');
903     if (calendar_show_event_type(CALENDAR_EVENT_GLOBAL)) {
904         $content .= '<td class="eventskey calendar_event_global" style="width: 11px;"><img src="'.$OUTPUT->pix_url('t/hide') . '" class="iconsmall" alt="'.get_string('hide').'" title="'.get_string('tt_hideglobal', 'calendar').'" style="cursor:pointer" onclick="location.href='."'".$seturl."'".'" /></td>';
905         $content .= '<td><a href="'.$seturl.'" title="'.get_string('tt_hideglobal', 'calendar').'">'.get_string('global', 'calendar').'</a></td>'."\n";
906     } else {
907         $content .= '<td style="width: 11px;"><img src="'.$OUTPUT->pix_url('t/show') . '" class="iconsmall" alt="'.get_string('show').'" title="'.get_string('tt_showglobal', 'calendar').'" style="cursor:pointer" onclick="location.href='."'".$seturl."'".'" /></td>';
908         $content .= '<td><a href="'.$seturl.'" title="'.get_string('tt_showglobal', 'calendar').'">'.get_string('global', 'calendar').'</a></td>'."\n";
909     }
911     $seturl->param('var', 'showcourses');
912     if (calendar_show_event_type(CALENDAR_EVENT_COURSE)) {
913         $content .= '<td class="eventskey calendar_event_course" style="width: 11px;"><img src="'.$OUTPUT->pix_url('t/hide') . '" class="iconsmall" alt="'.get_string('hide').'" title="'.get_string('tt_hidecourse', 'calendar').'" style="cursor:pointer" onclick="location.href='."'".$seturl."'".'" /></td>';
914         $content .= '<td><a href="'.$seturl.'" title="'.get_string('tt_hidecourse', 'calendar').'">'.get_string('course', 'calendar').'</a></td>'."\n";
915     } else {
916         $content .= '<td style="width: 11px;"><img src="'.$OUTPUT->pix_url('t/show') . '" class="iconsmall" alt="'.get_string('hide').'" title="'.get_string('tt_showcourse', 'calendar').'" style="cursor:pointer" onclick="location.href='."'".$seturl."'".'" /></td>';
917         $content .= '<td><a href="'.$seturl.'" title="'.get_string('tt_showcourse', 'calendar').'">'.get_string('course', 'calendar').'</a></td>'."\n";
918     }
920     if (isloggedin() && !isguestuser()) {
921         $content .= "</tr>\n<tr>";
923         if ($groupevents) {
924             // This course MIGHT have group events defined, so show the filter
925             $seturl->param('var', 'showgroups');
926             if (calendar_show_event_type(CALENDAR_EVENT_GROUP)) {
927                 $content .= '<td class="eventskey calendar_event_group" style="width: 11px;"><img src="'.$OUTPUT->pix_url('t/hide') . '" class="iconsmall" alt="'.get_string('hide').'" title="'.get_string('tt_hidegroups', 'calendar').'" style="cursor:pointer" onclick="location.href='."'".$seturl."'".'" /></td>';
928                 $content .= '<td><a href="'.$seturl.'" title="'.get_string('tt_hidegroups', 'calendar').'">'.get_string('group', 'calendar').'</a></td>'."\n";
929             } else {
930                 $content .= '<td style="width: 11px;"><img src="'.$OUTPUT->pix_url('t/show') . '" class="iconsmall" alt="'.get_string('show').'" title="'.get_string('tt_showgroups', 'calendar').'" style="cursor:pointer" onclick="location.href='."'".$seturl."'".'" /></td>';
931                 $content .= '<td><a href="'.$seturl.'" title="'.get_string('tt_showgroups', 'calendar').'">'.get_string('group', 'calendar').'</a></td>'."\n";
932             }
933         } else {
934             // This course CANNOT have group events, so lose the filter
935             $content .= '<td style="width: 11px;"></td><td>&nbsp;</td>'."\n";
936         }
938         $seturl->param('var', 'showuser');
939         if (calendar_show_event_type(CALENDAR_EVENT_USER)) {
940             $content .= '<td class="eventskey calendar_event_user" style="width: 11px;"><img src="'.$OUTPUT->pix_url('t/hide') . '" class="iconsmall" alt="'.get_string('hide').'" title="'.get_string('tt_hideuser', 'calendar').'" style="cursor:pointer" onclick="location.href='."'".$seturl."'".'" /></td>';
941             $content .= '<td><a href="'.$seturl.'" title="'.get_string('tt_hideuser', 'calendar').'">'.get_string('user', 'calendar').'</a></td>'."\n";
942         } else {
943             $content .= '<td style="width: 11px;"><img src="'.$OUTPUT->pix_url('t/show') . '" class="iconsmall" alt="'.get_string('show').'" title="'.get_string('tt_showuser', 'calendar').'" style="cursor:pointer" onclick="location.href='."'".$seturl."'".'" /></td>';
944             $content .= '<td><a href="'.$seturl.'" title="'.get_string('tt_showuser', 'calendar').'">'.get_string('user', 'calendar').'</a></td>'."\n";
945         }
946     }
947     $content .= "</tr>\n</table>\n";
949     return $content;
952 /**
953  * Return the representation day
954  *
955  * @param int $tstamp Timestamp in GMT
956  * @param int $now current Unix timestamp
957  * @param bool $usecommonwords
958  * @return string the formatted date/time
959  */
960 function calendar_day_representation($tstamp, $now = false, $usecommonwords = true) {
962     static $shortformat;
963     if(empty($shortformat)) {
964         $shortformat = get_string('strftimedayshort');
965     }
967     if($now === false) {
968         $now = time();
969     }
971     // To have it in one place, if a change is needed
972     $formal = userdate($tstamp, $shortformat);
974     $datestamp = usergetdate($tstamp);
975     $datenow   = usergetdate($now);
977     if($usecommonwords == false) {
978         // We don't want words, just a date
979         return $formal;
980     }
981     else if($datestamp['year'] == $datenow['year'] && $datestamp['yday'] == $datenow['yday']) {
982         // Today
983         return get_string('today', 'calendar');
984     }
985     else if(
986         ($datestamp['year'] == $datenow['year'] && $datestamp['yday'] == $datenow['yday'] - 1 ) ||
987         ($datestamp['year'] == $datenow['year'] - 1 && $datestamp['mday'] == 31 && $datestamp['mon'] == 12 && $datenow['yday'] == 1)
988         ) {
989         // Yesterday
990         return get_string('yesterday', 'calendar');
991     }
992     else if(
993         ($datestamp['year'] == $datenow['year'] && $datestamp['yday'] == $datenow['yday'] + 1 ) ||
994         ($datestamp['year'] == $datenow['year'] + 1 && $datenow['mday'] == 31 && $datenow['mon'] == 12 && $datestamp['yday'] == 1)
995         ) {
996         // Tomorrow
997         return get_string('tomorrow', 'calendar');
998     }
999     else {
1000         return $formal;
1001     }
1004 /**
1005  * return the formatted representation time
1006  *
1007  * @param int $time the timestamp in UTC, as obtained from the database
1008  * @return string the formatted date/time
1009  */
1010 function calendar_time_representation($time) {
1011     static $langtimeformat = NULL;
1012     if($langtimeformat === NULL) {
1013         $langtimeformat = get_string('strftimetime');
1014     }
1015     $timeformat = get_user_preferences('calendar_timeformat');
1016     if(empty($timeformat)){
1017         $timeformat = get_config(NULL,'calendar_site_timeformat');
1018     }
1019     // The ? is needed because the preference might be present, but empty
1020     return userdate($time, empty($timeformat) ? $langtimeformat : $timeformat);
1023 /**
1024  * Adds day, month, year arguments to a URL and returns a moodle_url object.
1025  *
1026  * @param string|moodle_url $linkbase
1027  * @param int $d The number of the day.
1028  * @param int $m The number of the month.
1029  * @param int $y The number of the year.
1030  * @return moodle_url|null $linkbase
1031  */
1032 function calendar_get_link_href($linkbase, $d, $m, $y) {
1033     if (empty($linkbase)) {
1034         return '';
1035     }
1036     if (!($linkbase instanceof moodle_url)) {
1037         $linkbase = new moodle_url();
1038     }
1039     if (!empty($d)) {
1040         $linkbase->param('cal_d', $d);
1041     }
1042     if (!empty($m)) {
1043         $linkbase->param('cal_m', $m);
1044     }
1045     if (!empty($y)) {
1046         $linkbase->param('cal_y', $y);
1047     }
1048     return $linkbase;
1051 /**
1052  * Build and return a previous month HTML link, with an arrow.
1053  *
1054  * @param string $text The text label.
1055  * @param string|moodle_url $linkbase The URL stub.
1056  * @param int $d The number of the date.
1057  * @param int $m The number of the month.
1058  * @param int $y year The number of the year.
1059  * @param bool $accesshide Default visible, or hide from all except screenreaders.
1060  * @return string HTML string.
1061  */
1062 function calendar_get_link_previous($text, $linkbase, $d, $m, $y, $accesshide=false) {
1063     $href = calendar_get_link_href(new moodle_url($linkbase), $d, $m, $y);
1064     if (empty($href)) {
1065         return $text;
1066     }
1067     return link_arrow_left($text, (string)$href, $accesshide, 'previous');
1070 /**
1071  * Build and return a next month HTML link, with an arrow.
1072  *
1073  * @param string $text The text label.
1074  * @param string|moodle_url $linkbase The URL stub.
1075  * @param int $d the number of the Day
1076  * @param int $m The number of the month.
1077  * @param int $y The number of the year.
1078  * @param bool $accesshide Default visible, or hide from all except screenreaders.
1079  * @return string HTML string.
1080  */
1081 function calendar_get_link_next($text, $linkbase, $d, $m, $y, $accesshide=false) {
1082     $href = calendar_get_link_href(new moodle_url($linkbase), $d, $m, $y);
1083     if (empty($href)) {
1084         return $text;
1085     }
1086     return link_arrow_right($text, (string)$href, $accesshide, 'next');
1089 /**
1090  * Return the name of the weekday
1091  *
1092  * @param string $englishname
1093  * @return string of the weekeday
1094  */
1095 function calendar_wday_name($englishname) {
1096     return get_string(strtolower($englishname), 'calendar');
1099 /**
1100  * Return the number of days in month
1101  *
1102  * @param int $month the number of the month.
1103  * @param int $year the number of the year
1104  * @return int
1105  */
1106 function calendar_days_in_month($month, $year) {
1107    return intval(date('t', mktime(0, 0, 0, $month, 1, $year)));
1110 /**
1111  * Get the upcoming event block
1112  *
1113  * @param array $events list of events
1114  * @param moodle_url|string $linkhref link to event referer
1115  * @return string|null $content html block content
1116  */
1117 function calendar_get_block_upcoming($events, $linkhref = NULL) {
1118     $content = '';
1119     $lines = count($events);
1120     if (!$lines) {
1121         return $content;
1122     }
1124     for ($i = 0; $i < $lines; ++$i) {
1125         if (!isset($events[$i]->time)) {   // Just for robustness
1126             continue;
1127         }
1128         $events[$i] = calendar_add_event_metadata($events[$i]);
1129         $content .= '<div class="event"><span class="icon c0">'.$events[$i]->icon.'</span> ';
1130         if (!empty($events[$i]->referer)) {
1131             // That's an activity event, so let's provide the hyperlink
1132             $content .= $events[$i]->referer;
1133         } else {
1134             if(!empty($linkhref)) {
1135                 $ed = usergetdate($events[$i]->timestart);
1136                 $href = calendar_get_link_href(new moodle_url(CALENDAR_URL.$linkhref), $ed['mday'], $ed['mon'], $ed['year']);
1137                 $href->set_anchor('event_'.$events[$i]->id);
1138                 $content .= html_writer::link($href, $events[$i]->name);
1139             }
1140             else {
1141                 $content .= $events[$i]->name;
1142             }
1143         }
1144         $events[$i]->time = str_replace('&raquo;', '<br />&raquo;', $events[$i]->time);
1145         $content .= '<div class="date">'.$events[$i]->time.'</div></div>';
1146         if ($i < $lines - 1) $content .= '<hr />';
1147     }
1149     return $content;
1152 /**
1153  * Get the next following month
1154  *
1155  * If the current month is December, it will get the first month of the following year.
1156  *
1157  *
1158  * @param int $month the number of the month.
1159  * @param int $year the number of the year.
1160  * @return array the following month
1161  */
1162 function calendar_add_month($month, $year) {
1163     if($month == 12) {
1164         return array(1, $year + 1);
1165     }
1166     else {
1167         return array($month + 1, $year);
1168     }
1171 /**
1172  * Get the previous month
1173  *
1174  * If the current month is January, it will get the last month of the previous year.
1175  *
1176  * @param int $month the number of the month.
1177  * @param int $year the number of the year.
1178  * @return array previous month
1179  */
1180 function calendar_sub_month($month, $year) {
1181     if($month == 1) {
1182         return array(12, $year - 1);
1183     }
1184     else {
1185         return array($month - 1, $year);
1186     }
1189 /**
1190  * Get per-day basis events
1191  *
1192  * @param array $events list of events
1193  * @param int $month the number of the month
1194  * @param int $year the number of the year
1195  * @param array $eventsbyday event on specific day
1196  * @param array $durationbyday duration of the event in days
1197  * @param array $typesbyday event type (eg: global, course, user, or group)
1198  * @param array $courses list of courses
1199  * @return void
1200  */
1201 function calendar_events_by_day($events, $month, $year, &$eventsbyday, &$durationbyday, &$typesbyday, &$courses) {
1202     $eventsbyday = array();
1203     $typesbyday = array();
1204     $durationbyday = array();
1206     if($events === false) {
1207         return;
1208     }
1210     foreach($events as $event) {
1212         $startdate = usergetdate($event->timestart);
1213         // Set end date = start date if no duration
1214         if ($event->timeduration) {
1215             $enddate   = usergetdate($event->timestart + $event->timeduration - 1);
1216         } else {
1217             $enddate = $startdate;
1218         }
1220         // Simple arithmetic: $year * 13 + $month is a distinct integer for each distinct ($year, $month) pair
1221         if(!($startdate['year'] * 13 + $startdate['mon'] <= $year * 13 + $month) && ($enddate['year'] * 13 + $enddate['mon'] >= $year * 13 + $month)) {
1222             // Out of bounds
1223             continue;
1224         }
1226         $eventdaystart = intval($startdate['mday']);
1228         if($startdate['mon'] == $month && $startdate['year'] == $year) {
1229             // Give the event to its day
1230             $eventsbyday[$eventdaystart][] = $event->id;
1232             // Mark the day as having such an event
1233             if($event->courseid == SITEID && $event->groupid == 0) {
1234                 $typesbyday[$eventdaystart]['startglobal'] = true;
1235                 // Set event class for global event
1236                 $events[$event->id]->class = 'calendar_event_global';
1237             }
1238             else if($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) {
1239                 $typesbyday[$eventdaystart]['startcourse'] = true;
1240                 // Set event class for course event
1241                 $events[$event->id]->class = 'calendar_event_course';
1242             }
1243             else if($event->groupid) {
1244                 $typesbyday[$eventdaystart]['startgroup'] = true;
1245                 // Set event class for group event
1246                 $events[$event->id]->class = 'calendar_event_group';
1247             }
1248             else if($event->userid) {
1249                 $typesbyday[$eventdaystart]['startuser'] = true;
1250                 // Set event class for user event
1251                 $events[$event->id]->class = 'calendar_event_user';
1252             }
1253         }
1255         if($event->timeduration == 0) {
1256             // Proceed with the next
1257             continue;
1258         }
1260         // The event starts on $month $year or before. So...
1261         $lowerbound = $startdate['mon'] == $month && $startdate['year'] == $year ? intval($startdate['mday']) : 0;
1263         // Also, it ends on $month $year or later...
1264         $upperbound = $enddate['mon'] == $month && $enddate['year'] == $year ? intval($enddate['mday']) : calendar_days_in_month($month, $year);
1266         // Mark all days between $lowerbound and $upperbound (inclusive) as duration
1267         for($i = $lowerbound + 1; $i <= $upperbound; ++$i) {
1268             $durationbyday[$i][] = $event->id;
1269             if($event->courseid == SITEID && $event->groupid == 0) {
1270                 $typesbyday[$i]['durationglobal'] = true;
1271             }
1272             else if($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) {
1273                 $typesbyday[$i]['durationcourse'] = true;
1274             }
1275             else if($event->groupid) {
1276                 $typesbyday[$i]['durationgroup'] = true;
1277             }
1278             else if($event->userid) {
1279                 $typesbyday[$i]['durationuser'] = true;
1280             }
1281         }
1283     }
1284     return;
1287 /**
1288  * Get current module cache
1289  *
1290  * @param array $coursecache list of course cache
1291  * @param string $modulename name of the module
1292  * @param int $instance module instance number
1293  * @return stdClass|bool $module information
1294  */
1295 function calendar_get_module_cached(&$coursecache, $modulename, $instance) {
1296     $module = get_coursemodule_from_instance($modulename, $instance);
1298     if($module === false) return false;
1299     if(!calendar_get_course_cached($coursecache, $module->course)) {
1300         return false;
1301     }
1302     return $module;
1305 /**
1306  * Get current course cache
1307  *
1308  * @param array $coursecache list of course cache
1309  * @param int $courseid id of the course
1310  * @return stdClass $coursecache[$courseid] return the specific course cache
1311  */
1312 function calendar_get_course_cached(&$coursecache, $courseid) {
1313     global $COURSE, $DB;
1315     if (!isset($coursecache[$courseid])) {
1316         if ($courseid == $COURSE->id) {
1317             $coursecache[$courseid] = $COURSE;
1318         } else {
1319             $coursecache[$courseid] = $DB->get_record('course', array('id'=>$courseid));
1320         }
1321     }
1322     return $coursecache[$courseid];
1325 /**
1326  * Returns the courses to load events for, the
1327  *
1328  * @param array $courseeventsfrom An array of courses to load calendar events for
1329  * @param bool $ignorefilters specify the use of filters, false is set as default
1330  * @return array An array of courses, groups, and user to load calendar events for based upon filters
1331  */
1332 function calendar_set_filters(array $courseeventsfrom, $ignorefilters = false) {
1333     global $USER, $CFG, $DB;
1335     // For backwards compatability we have to check whether the courses array contains
1336     // just id's in which case we need to load course objects.
1337     $coursestoload = array();
1338     foreach ($courseeventsfrom as $id => $something) {
1339         if (!is_object($something)) {
1340             $coursestoload[] = $id;
1341             unset($courseeventsfrom[$id]);
1342         }
1343     }
1344     if (!empty($coursestoload)) {
1345         // TODO remove this in 2.2
1346         debugging('calendar_set_filters now preferes an array of course objects with preloaded contexts', DEBUG_DEVELOPER);
1347         $courseeventsfrom = array_merge($courseeventsfrom, $DB->get_records_list('course', 'id', $coursestoload));
1348     }
1350     $courses = array();
1351     $user = false;
1352     $group = false;
1354     $isloggedin = isloggedin();
1356     if ($ignorefilters || calendar_show_event_type(CALENDAR_EVENT_COURSE)) {
1357         $courses = array_keys($courseeventsfrom);
1358     }
1359     if ($ignorefilters || calendar_show_event_type(CALENDAR_EVENT_GLOBAL)) {
1360         $courses[] = SITEID;
1361     }
1362     $courses = array_unique($courses);
1363     sort($courses);
1365     if (!empty($courses) && in_array(SITEID, $courses)) {
1366         // Sort courses for consistent colour highlighting
1367         // Effectively ignoring SITEID as setting as last course id
1368         $key = array_search(SITEID, $courses);
1369         unset($courses[$key]);
1370         $courses[] = SITEID;
1371     }
1373     if ($ignorefilters || ($isloggedin && calendar_show_event_type(CALENDAR_EVENT_USER))) {
1374         $user = $USER->id;
1375     }
1377     if (!empty($courseeventsfrom) && (calendar_show_event_type(CALENDAR_EVENT_GROUP) || $ignorefilters)) {
1379         if (!empty($CFG->calendar_adminseesall) && has_capability('moodle/calendar:manageentries', get_system_context())) {
1380             $group = true;
1381         } else if ($isloggedin) {
1382             $groupids = array();
1384             // We already have the courses to examine in $courses
1385             // For each course...
1386             foreach ($courseeventsfrom as $courseid => $course) {
1387                 // If the user is an editing teacher in there,
1388                 if (!empty($USER->groupmember[$course->id])) {
1389                     // We've already cached the users groups for this course so we can just use that
1390                     $groupids = array_merge($groupids, $USER->groupmember[$course->id]);
1391                 } else if (($course->groupmode != NOGROUPS || !$course->groupmodeforce) && has_capability('moodle/calendar:manageentries', get_context_instance(CONTEXT_COURSE, $course->id))) {
1392                     // If this course has groups, show events from all of them
1393                     $coursegroups = groups_get_user_groups($course->id, $USER->id);
1394                     $groupids = array_merge($groupids, $coursegroups['0']);
1395                 }
1396             }
1397             if (!empty($groupids)) {
1398                 $group = $groupids;
1399             }
1400         }
1401     }
1402     if (empty($courses)) {
1403         $courses = false;
1404     }
1406     return array($courses, $group, $user);
1409 /**
1410  * Return the capability for editing calendar event
1411  *
1412  * @param calendar_event $event event object
1413  * @return bool capability to edit event
1414  */
1415 function calendar_edit_event_allowed($event) {
1416     global $USER, $DB;
1418     // Must be logged in
1419     if (!isloggedin()) {
1420         return false;
1421     }
1423     // can not be using guest account
1424     if (isguestuser()) {
1425         return false;
1426     }
1428     $sitecontext = get_context_instance(CONTEXT_SYSTEM);
1429     // if user has manageentries at site level, return true
1430     if (has_capability('moodle/calendar:manageentries', $sitecontext)) {
1431         return true;
1432     }
1434     // if groupid is set, it's definitely a group event
1435     if (!empty($event->groupid)) {
1436         // Allow users to add/edit group events if:
1437         // 1) They have manageentries (= entries for whole course)
1438         // 2) They have managegroupentries AND are in the group
1439         $group = $DB->get_record('groups', array('id'=>$event->groupid));
1440         return $group && (
1441             has_capability('moodle/calendar:manageentries', $event->context) ||
1442             (has_capability('moodle/calendar:managegroupentries', $event->context)
1443                 && groups_is_member($event->groupid)));
1444     } else if (!empty($event->courseid)) {
1445     // if groupid is not set, but course is set,
1446     // it's definiely a course event
1447         return has_capability('moodle/calendar:manageentries', $event->context);
1448     } else if (!empty($event->userid) && $event->userid == $USER->id) {
1449     // if course is not set, but userid id set, it's a user event
1450         return (has_capability('moodle/calendar:manageownentries', $event->context));
1451     } else if (!empty($event->userid)) {
1452         return (has_capability('moodle/calendar:manageentries', $event->context));
1453     }
1454     return false;
1457 /**
1458  * Returns the default courses to display on the calendar when there isn't a specific
1459  * course to display.
1460  *
1461  * @return array $courses Array of courses to display
1462  */
1463 function calendar_get_default_courses() {
1464     global $CFG, $DB;
1466     if (!isloggedin()) {
1467         return array();
1468     }
1470     $courses = array();
1471     if (!empty($CFG->calendar_adminseesall) && has_capability('moodle/calendar:manageentries', context_system::instance())) {
1472         list ($select, $join) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1473         $sql = "SELECT c.* $select
1474                   FROM {course} c
1475                   $join
1476                   WHERE EXISTS (SELECT 1 FROM {event} e WHERE e.courseid = c.id)
1477                   ";
1478         $courses = $DB->get_records_sql($sql, null, 0, 20);
1479         foreach ($courses as $course) {
1480             context_helper::preload_from_record($course);
1481         }
1482         return $courses;
1483     }
1485     $courses = enrol_get_my_courses();
1487     return $courses;
1490 /**
1491  * Display calendar preference button
1492  *
1493  * @param stdClass $course course object
1494  * @return string return preference button in html
1495  */
1496 function calendar_preferences_button(stdClass $course) {
1497     global $OUTPUT;
1499     // Guests have no preferences
1500     if (!isloggedin() || isguestuser()) {
1501         return '';
1502     }
1504     return $OUTPUT->single_button(new moodle_url('/calendar/preferences.php', array('course' => $course->id)), get_string("preferences", "calendar"));
1507 /**
1508  * Get event format time
1509  *
1510  * @param calendar_event $event event object
1511  * @param int $now current time in gmt
1512  * @param array $linkparams list of params for event link
1513  * @param bool $usecommonwords the words as formatted date/time.
1514  * @param int $showtime determine the show time GMT timestamp
1515  * @return string $eventtime link/string for event time
1516  */
1517 function calendar_format_event_time($event, $now, $linkparams = null, $usecommonwords = true, $showtime=0) {
1518     $startdate = usergetdate($event->timestart);
1519     $enddate = usergetdate($event->timestart + $event->timeduration);
1520     $usermidnightstart = usergetmidnight($event->timestart);
1522     if($event->timeduration) {
1523         // To avoid doing the math if one IF is enough :)
1524         $usermidnightend = usergetmidnight($event->timestart + $event->timeduration);
1525     }
1526     else {
1527         $usermidnightend = $usermidnightstart;
1528     }
1530     if (empty($linkparams) || !is_array($linkparams)) {
1531         $linkparams = array();
1532     }
1533     $linkparams['view'] = 'day';
1535     // OK, now to get a meaningful display...
1536     // First of all we have to construct a human-readable date/time representation
1538     if($event->timeduration) {
1539         // It has a duration
1540         if($usermidnightstart == $usermidnightend ||
1541            ($event->timestart == $usermidnightstart) && ($event->timeduration == 86400 || $event->timeduration == 86399) ||
1542            ($event->timestart + $event->timeduration <= $usermidnightstart + 86400)) {
1543             // But it's all on the same day
1544             $timestart = calendar_time_representation($event->timestart);
1545             $timeend = calendar_time_representation($event->timestart + $event->timeduration);
1546             $time = $timestart.' <strong>&raquo;</strong> '.$timeend;
1548             if ($event->timestart == $usermidnightstart && ($event->timeduration == 86400 || $event->timeduration == 86399)) {
1549                 $time = get_string('allday', 'calendar');
1550             }
1552             // Set printable representation
1553             if (!$showtime) {
1554                 $day = calendar_day_representation($event->timestart, $now, $usecommonwords);
1555                 $url = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', $linkparams), $enddate['mday'], $enddate['mon'], $enddate['year']);
1556                 $eventtime = html_writer::link($url, $day).', '.$time;
1557             } else {
1558                 $eventtime = $time;
1559             }
1560         } else {
1561             // It spans two or more days
1562             $daystart = calendar_day_representation($event->timestart, $now, $usecommonwords).', ';
1563             if ($showtime == $usermidnightstart) {
1564                 $daystart = '';
1565             }
1566             $timestart = calendar_time_representation($event->timestart);
1567             $dayend = calendar_day_representation($event->timestart + $event->timeduration, $now, $usecommonwords).', ';
1568             if ($showtime == $usermidnightend) {
1569                 $dayend = '';
1570             }
1571             $timeend = calendar_time_representation($event->timestart + $event->timeduration);
1573             // Set printable representation
1574             if ($now >= $usermidnightstart && $now < ($usermidnightstart + 86400)) {
1575                 $url = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', $linkparams), $enddate['mday'], $enddate['mon'], $enddate['year']);
1576                 $eventtime = $timestart.' <strong>&raquo;</strong> '.html_writer::link($url, $dayend).$timeend;
1577             } else {
1578                 $url = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', $linkparams), $enddate['mday'], $enddate['mon'], $enddate['year']);
1579                 $eventtime  = html_writer::link($url, $daystart).$timestart.' <strong>&raquo;</strong> ';
1581                 $url = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', $linkparams), $startdate['mday'], $startdate['mon'], $startdate['year']);
1582                 $eventtime .= html_writer::link($url, $dayend).$timeend;
1583             }
1584         }
1585     } else {
1586         $time = calendar_time_representation($event->timestart);
1588         // Set printable representation
1589         if (!$showtime) {
1590             $day = calendar_day_representation($event->timestart, $now, $usecommonwords);
1591             $url = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', $linkparams), $startdate['mday'], $startdate['mon'], $startdate['year']);
1592             $eventtime = html_writer::link($url, $day).', '.trim($time);
1593         } else {
1594             $eventtime = $time;
1595         }
1596     }
1598     if($event->timestart + $event->timeduration < $now) {
1599         // It has expired
1600         $eventtime = '<span class="dimmed_text">'.str_replace(' href=', ' class="dimmed" href=', $eventtime).'</span>';
1601     }
1603     return $eventtime;
1606 /**
1607  * Display month selector options
1608  *
1609  * @param string $name for the select element
1610  * @param string|array $selected options for select elements
1611  */
1612 function calendar_print_month_selector($name, $selected) {
1613     $months = array();
1614     for ($i=1; $i<=12; $i++) {
1615         $months[$i] = userdate(gmmktime(12, 0, 0, $i, 15, 2000), '%B');
1616     }
1617     echo html_writer::select($months, $name, $selected, false);
1620 /**
1621  * Checks to see if the requested type of event should be shown for the given user.
1622  *
1623  * @param CALENDAR_EVENT_GLOBAL|CALENDAR_EVENT_COURSE|CALENDAR_EVENT_GROUP|CALENDAR_EVENT_USER $type
1624  *          The type to check the display for (default is to display all)
1625  * @param stdClass|int|null $user The user to check for - by default the current user
1626  * @return bool True if the tyep should be displayed false otherwise
1627  */
1628 function calendar_show_event_type($type, $user = null) {
1629     $default = CALENDAR_EVENT_GLOBAL + CALENDAR_EVENT_COURSE + CALENDAR_EVENT_GROUP + CALENDAR_EVENT_USER;
1630     if (get_user_preferences('calendar_persistflt', 0, $user) === 0) {
1631         global $SESSION;
1632         if (!isset($SESSION->calendarshoweventtype)) {
1633             $SESSION->calendarshoweventtype = $default;
1634         }
1635         return $SESSION->calendarshoweventtype & $type;
1636     } else {
1637         return get_user_preferences('calendar_savedflt', $default, $user) & $type;
1638     }
1641 /**
1642  * Sets the display of the event type given $display.
1643  *
1644  * If $display = true the event type will be shown.
1645  * If $display = false the event type will NOT be shown.
1646  * If $display = null the current value will be toggled and saved.
1647  *
1648  * @param CALENDAR_EVENT_GLOBAL|CALENDAR_EVENT_COURSE|CALENDAR_EVENT_GROUP|CALENDAR_EVENT_USER $type object of CALENDAR_EVENT_XXX
1649  * @param bool $display option to display event type
1650  * @param stdClass|int $user moodle user object or id, null means current user
1651  */
1652 function calendar_set_event_type_display($type, $display = null, $user = null) {
1653     $persist = get_user_preferences('calendar_persistflt', 0, $user);
1654     $default = CALENDAR_EVENT_GLOBAL + CALENDAR_EVENT_COURSE + CALENDAR_EVENT_GROUP + CALENDAR_EVENT_USER;
1655     if ($persist === 0) {
1656         global $SESSION;
1657         if (!isset($SESSION->calendarshoweventtype)) {
1658             $SESSION->calendarshoweventtype = $default;
1659         }
1660         $preference = $SESSION->calendarshoweventtype;
1661     } else {
1662         $preference = get_user_preferences('calendar_savedflt', $default, $user);
1663     }
1664     $current = $preference & $type;
1665     if ($display === null) {
1666         $display = !$current;
1667     }
1668     if ($display && !$current) {
1669         $preference += $type;
1670     } else if (!$display && $current) {
1671         $preference -= $type;
1672     }
1673     if ($persist === 0) {
1674         $SESSION->calendarshoweventtype = $preference;
1675     } else {
1676         if ($preference == $default) {
1677             unset_user_preference('calendar_savedflt', $user);
1678         } else {
1679             set_user_preference('calendar_savedflt', $preference, $user);
1680         }
1681     }
1684 /**
1685  * Get calendar's allowed types
1686  *
1687  * @param stdClass $allowed list of allowed edit for event  type
1688  * @param stdClass|int $course object of a course or course id
1689  */
1690 function calendar_get_allowed_types(&$allowed, $course = null) {
1691     global $USER, $CFG, $DB;
1692     $allowed = new stdClass();
1693     $allowed->user = has_capability('moodle/calendar:manageownentries', get_system_context());
1694     $allowed->groups = false; // This may change just below
1695     $allowed->courses = false; // This may change just below
1696     $allowed->site = has_capability('moodle/calendar:manageentries', get_context_instance(CONTEXT_COURSE, SITEID));
1698     if (!empty($course)) {
1699         if (!is_object($course)) {
1700             $course = $DB->get_record('course', array('id' => $course), '*', MUST_EXIST);
1701         }
1702         if ($course->id != SITEID) {
1703             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1704             $allowed->user = has_capability('moodle/calendar:manageownentries', $coursecontext);
1706             if (has_capability('moodle/calendar:manageentries', $coursecontext)) {
1707                 $allowed->courses = array($course->id => 1);
1709                 if ($course->groupmode != NOGROUPS || !$course->groupmodeforce) {
1710                     $allowed->groups = groups_get_all_groups($course->id);
1711                 }
1712             } else if (has_capability('moodle/calendar:managegroupentries', $coursecontext)) {
1713                 if($course->groupmode != NOGROUPS || !$course->groupmodeforce) {
1714                     $allowed->groups = groups_get_all_groups($course->id);
1715                 }
1716             }
1717         }
1718     }
1721 /**
1722  * See if user can add calendar entries at all
1723  * used to print the "New Event" button
1724  *
1725  * @param stdClass $course object of a course or course id
1726  * @return bool has the capability to add at least one event type
1727  */
1728 function calendar_user_can_add_event($course) {
1729     if (!isloggedin() || isguestuser()) {
1730         return false;
1731     }
1732     calendar_get_allowed_types($allowed, $course);
1733     return (bool)($allowed->user || $allowed->groups || $allowed->courses || $allowed->site);
1736 /**
1737  * Check wether the current user is permitted to add events
1738  *
1739  * @param stdClass $event object of event
1740  * @return bool has the capability to add event
1741  */
1742 function calendar_add_event_allowed($event) {
1743     global $USER, $DB;
1745     // can not be using guest account
1746     if (!isloggedin() or isguestuser()) {
1747         return false;
1748     }
1750     $sitecontext = get_context_instance(CONTEXT_SYSTEM);
1751     // if user has manageentries at site level, always return true
1752     if (has_capability('moodle/calendar:manageentries', $sitecontext)) {
1753         return true;
1754     }
1756     switch ($event->eventtype) {
1757         case 'course':
1758             return has_capability('moodle/calendar:manageentries', $event->context);
1760         case 'group':
1761             // Allow users to add/edit group events if:
1762             // 1) They have manageentries (= entries for whole course)
1763             // 2) They have managegroupentries AND are in the group
1764             $group = $DB->get_record('groups', array('id'=>$event->groupid));
1765             return $group && (
1766                 has_capability('moodle/calendar:manageentries', $event->context) ||
1767                 (has_capability('moodle/calendar:managegroupentries', $event->context)
1768                     && groups_is_member($event->groupid)));
1770         case 'user':
1771             if ($event->userid == $USER->id) {
1772                 return (has_capability('moodle/calendar:manageownentries', $event->context));
1773             }
1774             //there is no 'break;' intentionally
1776         case 'site':
1777             return has_capability('moodle/calendar:manageentries', $event->context);
1779         default:
1780             return has_capability('moodle/calendar:manageentries', $event->context);
1781     }
1784 /**
1785  * Manage calendar events
1786  *
1787  * This class provides the required functionality in order to manage calendar events.
1788  * It was introduced as part of Moodle 2.0 and was created in order to provide a
1789  * better framework for dealing with calendar events in particular regard to file
1790  * handling through the new file API
1791  *
1792  * @package    core_calendar
1793  * @category   calendar
1794  * @copyright  2009 Sam Hemelryk
1795  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1796  *
1797  * @property int $id The id within the event table
1798  * @property string $name The name of the event
1799  * @property string $description The description of the event
1800  * @property int $format The format of the description FORMAT_?
1801  * @property int $courseid The course the event is associated with (0 if none)
1802  * @property int $groupid The group the event is associated with (0 if none)
1803  * @property int $userid The user the event is associated with (0 if none)
1804  * @property int $repeatid If this is a repeated event this will be set to the
1805  *                          id of the original
1806  * @property string $modulename If added by a module this will be the module name
1807  * @property int $instance If added by a module this will be the module instance
1808  * @property string $eventtype The event type
1809  * @property int $timestart The start time as a timestamp
1810  * @property int $timeduration The duration of the event in seconds
1811  * @property int $visible 1 if the event is visible
1812  * @property int $uuid ?
1813  * @property int $sequence ?
1814  * @property int $timemodified The time last modified as a timestamp
1815  */
1816 class calendar_event {
1818     /** @var array An object containing the event properties can be accessed via the magic __get/set methods */
1819     protected $properties = null;
1821     /**
1822      * @var string The converted event discription with file paths resolved. This gets populated when someone requests description for the first time */
1823     protected $_description = null;
1825     /** @var array The options to use with this description editor */
1826     protected $editoroptions = array(
1827             'subdirs'=>false,
1828             'forcehttps'=>false,
1829             'maxfiles'=>-1,
1830             'maxbytes'=>null,
1831             'trusttext'=>false);
1833     /** @var object The context to use with the description editor */
1834     protected $editorcontext = null;
1836     /**
1837      * Instantiates a new event and optionally populates its properties with the
1838      * data provided
1839      *
1840      * @param stdClass $data Optional. An object containing the properties to for
1841      *                  an event
1842      */
1843     public function __construct($data=null) {
1844         global $CFG, $USER;
1846         // First convert to object if it is not already (should either be object or assoc array)
1847         if (!is_object($data)) {
1848             $data = (object)$data;
1849         }
1851         $this->editoroptions['maxbytes'] = $CFG->maxbytes;
1853         $data->eventrepeats = 0;
1855         if (empty($data->id)) {
1856             $data->id = null;
1857         }
1859         // Default to a user event
1860         if (empty($data->eventtype)) {
1861             $data->eventtype = 'user';
1862         }
1864         // Default to the current user
1865         if (empty($data->userid)) {
1866             $data->userid = $USER->id;
1867         }
1869         if (!empty($data->timeduration) && is_array($data->timeduration)) {
1870             $data->timeduration = make_timestamp($data->timeduration['year'], $data->timeduration['month'], $data->timeduration['day'], $data->timeduration['hour'], $data->timeduration['minute']) - $data->timestart;
1871         }
1872         if (!empty($data->description) && is_array($data->description)) {
1873             $data->format = $data->description['format'];
1874             $data->description = $data->description['text'];
1875         } else if (empty($data->description)) {
1876             $data->description = '';
1877             $data->format = editors_get_preferred_format();
1878         }
1879         // Ensure form is defaulted correctly
1880         if (empty($data->format)) {
1881             $data->format = editors_get_preferred_format();
1882         }
1884         if (empty($data->context)) {
1885             $data->context = $this->calculate_context($data);
1886         }
1887         $this->properties = $data;
1888     }
1890     /**
1891      * Magic property method
1892      *
1893      * Attempts to call a set_$key method if one exists otherwise falls back
1894      * to simply set the property
1895      *
1896      * @param string $key property name
1897      * @param mixed $value value of the property
1898      */
1899     public function __set($key, $value) {
1900         if (method_exists($this, 'set_'.$key)) {
1901             $this->{'set_'.$key}($value);
1902         }
1903         $this->properties->{$key} = $value;
1904     }
1906     /**
1907      * Magic get method
1908      *
1909      * Attempts to call a get_$key method to return the property and ralls over
1910      * to return the raw property
1911      *
1912      * @param string $key property name
1913      * @return mixed property value
1914      */
1915     public function __get($key) {
1916         if (method_exists($this, 'get_'.$key)) {
1917             return $this->{'get_'.$key}();
1918         }
1919         if (!isset($this->properties->{$key})) {
1920             throw new coding_exception('Undefined property requested');
1921         }
1922         return $this->properties->{$key};
1923     }
1925     /**
1926      * Stupid PHP needs an isset magic method if you use the get magic method and
1927      * still want empty calls to work.... blah ~!
1928      *
1929      * @param string $key $key property name
1930      * @return bool|mixed property value, false if property is not exist
1931      */
1932     public function __isset($key) {
1933         return !empty($this->properties->{$key});
1934     }
1936     /**
1937      * Calculate the context value needed for calendar_event.
1938      * Event's type can be determine by the available value store in $data
1939      * It is important to check for the existence of course/courseid to determine
1940      * the course event.
1941      * Default value is set to CONTEXT_USER
1942      *
1943      * @param stdClass $data information about event
1944      * @return stdClass The context object.
1945      */
1946     protected function calculate_context(stdClass $data) {
1947         global $USER, $DB;
1949         $context = null;
1950         if (isset($data->courseid) && $data->courseid > 0) {
1951             $context =  get_context_instance(CONTEXT_COURSE, $data->courseid);
1952         } else if (isset($data->course) && $data->course > 0) {
1953             $context =  get_context_instance(CONTEXT_COURSE, $data->course);
1954         } else if (isset($data->groupid) && $data->groupid > 0) {
1955             $group = $DB->get_record('groups', array('id'=>$data->groupid));
1956             $context = get_context_instance(CONTEXT_COURSE, $group->courseid);
1957         } else if (isset($data->userid) && $data->userid > 0 && $data->userid == $USER->id) {
1958             $context =  get_context_instance(CONTEXT_USER, $data->userid);
1959         } else if (isset($data->userid) && $data->userid > 0 && $data->userid != $USER->id &&
1960                    isset($data->instance) && $data->instance > 0) {
1961             $cm = get_coursemodule_from_instance($data->modulename, $data->instance, 0, false, MUST_EXIST);
1962             $context =  get_context_instance(CONTEXT_COURSE, $cm->course);
1963         } else {
1964             $context =  get_context_instance(CONTEXT_USER);
1965         }
1967         return $context;
1968     }
1970     /**
1971      * Returns an array of editoroptions for this event: Called by __get
1972      * Please use $blah = $event->editoroptions;
1973      *
1974      * @return array event editor options
1975      */
1976     protected function get_editoroptions() {
1977         return $this->editoroptions;
1978     }
1980     /**
1981      * Returns an event description: Called by __get
1982      * Please use $blah = $event->description;
1983      *
1984      * @return string event description
1985      */
1986     protected function get_description() {
1987         global $CFG;
1989         require_once($CFG->libdir . '/filelib.php');
1991         if ($this->_description === null) {
1992             // Check if we have already resolved the context for this event
1993             if ($this->editorcontext === null) {
1994                 // Switch on the event type to decide upon the appropriate context
1995                 // to use for this event
1996                 $this->editorcontext = $this->properties->context;
1997                 if ($this->properties->eventtype != 'user' && $this->properties->eventtype != 'course'
1998                         && $this->properties->eventtype != 'site' && $this->properties->eventtype != 'group') {
1999                     return clean_text($this->properties->description, $this->properties->format);
2000                 }
2001             }
2003             // Work out the item id for the editor, if this is a repeated event then the files will
2004             // be associated with the original
2005             if (!empty($this->properties->repeatid) && $this->properties->repeatid > 0) {
2006                 $itemid = $this->properties->repeatid;
2007             } else {
2008                 $itemid = $this->properties->id;
2009             }
2011             // Convert file paths in the description so that things display correctly
2012             $this->_description = file_rewrite_pluginfile_urls($this->properties->description, 'pluginfile.php', $this->editorcontext->id, 'calendar', 'event_description', $itemid);
2013             // Clean the text so no nasties get through
2014             $this->_description = clean_text($this->_description, $this->properties->format);
2015         }
2016         // Finally return the description
2017         return $this->_description;
2018     }
2020     /**
2021      * Return the number of repeat events there are in this events series
2022      *
2023      * @return int number of event repeated
2024      */
2025     public function count_repeats() {
2026         global $DB;
2027         if (!empty($this->properties->repeatid)) {
2028             $this->properties->eventrepeats = $DB->count_records('event', array('repeatid'=>$this->properties->repeatid));
2029             // We don't want to count ourselves
2030             $this->properties->eventrepeats--;
2031         }
2032         return $this->properties->eventrepeats;
2033     }
2035     /**
2036      * Update or create an event within the database
2037      *
2038      * Pass in a object containing the event properties and this function will
2039      * insert it into the database and deal with any associated files
2040      *
2041      * @see add_event()
2042      * @see update_event()
2043      *
2044      * @param stdClass $data object of event
2045      * @param bool $checkcapability if moodle should check calendar managing capability or not
2046      * @return bool event updated
2047      */
2048     public function update($data, $checkcapability=true) {
2049         global $CFG, $DB, $USER;
2051         foreach ($data as $key=>$value) {
2052             $this->properties->$key = $value;
2053         }
2055         $this->properties->timemodified = time();
2056         $usingeditor = (!empty($this->properties->description) && is_array($this->properties->description));
2058         if (empty($this->properties->id) || $this->properties->id < 1) {
2060             if ($checkcapability) {
2061                 if (!calendar_add_event_allowed($this->properties)) {
2062                     print_error('nopermissiontoupdatecalendar');
2063                 }
2064             }
2066             if ($usingeditor) {
2067                 switch ($this->properties->eventtype) {
2068                     case 'user':
2069                         $this->editorcontext = $this->properties->context;
2070                         $this->properties->courseid = 0;
2071                         $this->properties->groupid = 0;
2072                         $this->properties->userid = $USER->id;
2073                         break;
2074                     case 'site':
2075                         $this->editorcontext = $this->properties->context;
2076                         $this->properties->courseid = SITEID;
2077                         $this->properties->groupid = 0;
2078                         $this->properties->userid = $USER->id;
2079                         break;
2080                     case 'course':
2081                         $this->editorcontext = $this->properties->context;
2082                         $this->properties->groupid = 0;
2083                         $this->properties->userid = $USER->id;
2084                         break;
2085                     case 'group':
2086                         $this->editorcontext = $this->properties->context;
2087                         $this->properties->userid = $USER->id;
2088                         break;
2089                     default:
2090                         // Ewww we should NEVER get here, but just incase we do lets
2091                         // fail gracefully
2092                         $usingeditor = false;
2093                         break;
2094                 }
2096                 $editor = $this->properties->description;
2097                 $this->properties->format = $this->properties->description['format'];
2098                 $this->properties->description = $this->properties->description['text'];
2099             }
2101             // Insert the event into the database
2102             $this->properties->id = $DB->insert_record('event', $this->properties);
2104             if ($usingeditor) {
2105                 $this->properties->description = file_save_draft_area_files(
2106                                                 $editor['itemid'],
2107                                                 $this->editorcontext->id,
2108                                                 'calendar',
2109                                                 'event_description',
2110                                                 $this->properties->id,
2111                                                 $this->editoroptions,
2112                                                 $editor['text'],
2113                                                 $this->editoroptions['forcehttps']);
2115                 $DB->set_field('event', 'description', $this->properties->description, array('id'=>$this->properties->id));
2116             }
2118             // Log the event entry.
2119             add_to_log($this->properties->courseid, 'calendar', 'add', 'event.php?action=edit&amp;id='.$this->properties->id, $this->properties->name);
2121             $repeatedids = array();
2123             if (!empty($this->properties->repeat)) {
2124                 $this->properties->repeatid = $this->properties->id;
2125                 $DB->set_field('event', 'repeatid', $this->properties->repeatid, array('id'=>$this->properties->id));
2127                 $eventcopy = clone($this->properties);
2128                 unset($eventcopy->id);
2130                 for($i = 1; $i < $eventcopy->repeats; $i++) {
2132                     $eventcopy->timestart = ($eventcopy->timestart+WEEKSECS) + dst_offset_on($eventcopy->timestart) - dst_offset_on($eventcopy->timestart+WEEKSECS);
2134                     // Get the event id for the log record.
2135                     $eventcopyid = $DB->insert_record('event', $eventcopy);
2137                     // If the context has been set delete all associated files
2138                     if ($usingeditor) {
2139                         $fs = get_file_storage();
2140                         $files = $fs->get_area_files($this->editorcontext->id, 'calendar', 'event_description', $this->properties->id);
2141                         foreach ($files as $file) {
2142                             $fs->create_file_from_storedfile(array('itemid'=>$eventcopyid), $file);
2143                         }
2144                     }
2146                     $repeatedids[] = $eventcopyid;
2147                     // Log the event entry.
2148                     add_to_log($eventcopy->courseid, 'calendar', 'add', 'event.php?action=edit&amp;id='.$eventcopyid, $eventcopy->name);
2149                 }
2150             }
2152             // Hook for tracking added events
2153             self::calendar_event_hook('add_event', array($this->properties, $repeatedids));
2154             return true;
2155         } else {
2157             if ($checkcapability) {
2158                 if(!calendar_edit_event_allowed($this->properties)) {
2159                     print_error('nopermissiontoupdatecalendar');
2160                 }
2161             }
2163             if ($usingeditor) {
2164                 if ($this->editorcontext !== null) {
2165                     $this->properties->description = file_save_draft_area_files(
2166                                                     $this->properties->description['itemid'],
2167                                                     $this->editorcontext->id,
2168                                                     'calendar',
2169                                                     'event_description',
2170                                                     $this->properties->id,
2171                                                     $this->editoroptions,
2172                                                     $this->properties->description['text'],
2173                                                     $this->editoroptions['forcehttps']);
2174                 } else {
2175                     $this->properties->format = $this->properties->description['format'];
2176                     $this->properties->description = $this->properties->description['text'];
2177                 }
2178             }
2180             $event = $DB->get_record('event', array('id'=>$this->properties->id));
2182             $updaterepeated = (!empty($this->properties->repeatid) && !empty($this->properties->repeateditall));
2184             if ($updaterepeated) {
2185                 // Update all
2186                 if ($this->properties->timestart != $event->timestart) {
2187                     $timestartoffset = $this->properties->timestart - $event->timestart;
2188                     $sql = "UPDATE {event}
2189                                SET name = ?,
2190                                    description = ?,
2191                                    timestart = timestart + ?,
2192                                    timeduration = ?,
2193                                    timemodified = ?
2194                              WHERE repeatid = ?";
2195                     $params = array($this->properties->name, $this->properties->description, $timestartoffset, $this->properties->timeduration, time(), $event->repeatid);
2196                 } else {
2197                     $sql = "UPDATE {event} SET name = ?, description = ?, timeduration = ?, timemodified = ? WHERE repeatid = ?";
2198                     $params = array($this->properties->name, $this->properties->description, $this->properties->timeduration, time(), $event->repeatid);
2199                 }
2200                 $DB->execute($sql, $params);
2202                 // Log the event update.
2203                 add_to_log($this->properties->courseid, 'calendar', 'edit all', 'event.php?action=edit&amp;id='.$this->properties->id, $this->properties->name);
2204             } else {
2205                 $DB->update_record('event', $this->properties);
2206                 $event = calendar_event::load($this->properties->id);
2207                 $this->properties = $event->properties();
2208                 add_to_log($this->properties->courseid, 'calendar', 'edit', 'event.php?action=edit&amp;id='.$this->properties->id, $this->properties->name);
2209             }
2211             // Hook for tracking event updates
2212             self::calendar_event_hook('update_event', array($this->properties, $updaterepeated));
2213             return true;
2214         }
2215     }
2217     /**
2218      * Deletes an event and if selected an repeated events in the same series
2219      *
2220      * This function deletes an event, any associated events if $deleterepeated=true,
2221      * and cleans up any files associated with the events.
2222      *
2223      * @see delete_event()
2224      *
2225      * @param bool $deleterepeated  delete event repeatedly
2226      * @return bool succession of deleting event
2227      */
2228     public function delete($deleterepeated=false) {
2229         global $DB;
2231         // If $this->properties->id is not set then something is wrong
2232         if (empty($this->properties->id)) {
2233             debugging('Attempting to delete an event before it has been loaded', DEBUG_DEVELOPER);
2234             return false;
2235         }
2237         // Delete the event
2238         $DB->delete_records('event', array('id'=>$this->properties->id));
2240         // If we are deleting parent of a repeated event series, promote the next event in the series as parent
2241         if (($this->properties->id == $this->properties->repeatid) && !$deleterepeated) {
2242             $newparent = $DB->get_field_sql("SELECT id from {event} where repeatid = ? order by id ASC", array($this->properties->id), IGNORE_MULTIPLE);
2243             if (!empty($newparent)) {
2244                 $DB->execute("UPDATE {event} SET repeatid = ? WHERE repeatid = ?", array($newparent, $this->properties->id));
2245                 // Get all records where the repeatid is the same as the event being removed
2246                 $events = $DB->get_records('event', array('repeatid' => $newparent));
2247                 // For each of the returned events trigger the event_update hook.
2248                 foreach ($events as $event) {
2249                     self::calendar_event_hook('update_event', array($event, false));
2250                 }
2251             }
2252         }
2254         // If the editor context hasn't already been set then set it now
2255         if ($this->editorcontext === null) {
2256             $this->editorcontext = $this->properties->context;
2257         }
2259         // If the context has been set delete all associated files
2260         if ($this->editorcontext !== null) {
2261             $fs = get_file_storage();
2262             $files = $fs->get_area_files($this->editorcontext->id, 'calendar', 'event_description', $this->properties->id);
2263             foreach ($files as $file) {
2264                 $file->delete();
2265             }
2266         }
2268         // Fire the event deleted hook
2269         self::calendar_event_hook('delete_event', array($this->properties->id, $deleterepeated));
2271         // If we need to delete repeated events then we will fetch them all and delete one by one
2272         if ($deleterepeated && !empty($this->properties->repeatid) && $this->properties->repeatid > 0) {
2273             // Get all records where the repeatid is the same as the event being removed
2274             $events = $DB->get_records('event', array('repeatid'=>$this->properties->repeatid));
2275             // For each of the returned events populate a calendar_event object and call delete
2276             // make sure the arg passed is false as we are already deleting all repeats
2277             foreach ($events as $event) {
2278                 $event = new calendar_event($event);
2279                 $event->delete(false);
2280             }
2281         }
2283         return true;
2284     }
2286     /**
2287      * Fetch all event properties
2288      *
2289      * This function returns all of the events properties as an object and optionally
2290      * can prepare an editor for the description field at the same time. This is
2291      * designed to work when the properties are going to be used to set the default
2292      * values of a moodle forms form.
2293      *
2294      * @param bool $prepareeditor If set to true a editor is prepared for use with
2295      *              the mforms editor element. (for description)
2296      * @return stdClass Object containing event properties
2297      */
2298     public function properties($prepareeditor=false) {
2299         global $USER, $CFG, $DB;
2301         // First take a copy of the properties. We don't want to actually change the
2302         // properties or we'd forever be converting back and forwards between an
2303         // editor formatted description and not
2304         $properties = clone($this->properties);
2305         // Clean the description here
2306         $properties->description = clean_text($properties->description, $properties->format);
2308         // If set to true we need to prepare the properties for use with an editor
2309         // and prepare the file area
2310         if ($prepareeditor) {
2312             // We may or may not have a property id. If we do then we need to work
2313             // out the context so we can copy the existing files to the draft area
2314             if (!empty($properties->id)) {
2316                 if ($properties->eventtype === 'site') {
2317                     // Site context
2318                     $this->editorcontext = $this->properties->context;
2319                 } else if ($properties->eventtype === 'user') {
2320                     // User context
2321                     $this->editorcontext = $this->properties->context;
2322                 } else if ($properties->eventtype === 'group' || $properties->eventtype === 'course') {
2323                     // First check the course is valid
2324                     $course = $DB->get_record('course', array('id'=>$properties->courseid));
2325                     if (!$course) {
2326                         print_error('invalidcourse');
2327                     }
2328                     // Course context
2329                     $this->editorcontext = $this->properties->context;
2330                     // We have a course and are within the course context so we had
2331                     // better use the courses max bytes value
2332                     $this->editoroptions['maxbytes'] = $course->maxbytes;
2333                 } else {
2334                     // If we get here we have a custom event type as used by some
2335                     // modules. In this case the event will have been added by
2336                     // code and we won't need the editor
2337                     $this->editoroptions['maxbytes'] = 0;
2338                     $this->editoroptions['maxfiles'] = 0;
2339                 }
2341                 if (empty($this->editorcontext) || empty($this->editorcontext->id)) {
2342                     $contextid = false;
2343                 } else {
2344                     // Get the context id that is what we really want
2345                     $contextid = $this->editorcontext->id;
2346                 }
2347             } else {
2349                 // If we get here then this is a new event in which case we don't need a
2350                 // context as there is no existing files to copy to the draft area.
2351                 $contextid = null;
2352             }
2354             // If the contextid === false we don't support files so no preparing
2355             // a draft area
2356             if ($contextid !== false) {
2357                 // Just encase it has already been submitted
2358                 $draftiddescription = file_get_submitted_draft_itemid('description');
2359                 // Prepare the draft area, this copies existing files to the draft area as well
2360                 $properties->description = file_prepare_draft_area($draftiddescription, $contextid, 'calendar', 'event_description', $properties->id, $this->editoroptions, $properties->description);
2361             } else {
2362                 $draftiddescription = 0;
2363             }
2365             // Structure the description field as the editor requires
2366             $properties->description = array('text'=>$properties->description, 'format'=>$properties->format, 'itemid'=>$draftiddescription);
2367         }
2369         // Finally return the properties
2370         return $properties;
2371     }
2373     /**
2374      * Toggles the visibility of an event
2375      *
2376      * @param null|bool $force If it is left null the events visibility is flipped,
2377      *                   If it is false the event is made hidden, if it is true it
2378      *                   is made visible.
2379      * @return bool if event is successfully updated, toggle will be visible
2380      */
2381     public function toggle_visibility($force=null) {
2382         global $CFG, $DB;
2384         // Set visible to the default if it is not already set
2385         if (empty($this->properties->visible)) {
2386             $this->properties->visible = 1;
2387         }
2389         if ($force === true || ($force !== false && $this->properties->visible == 0)) {
2390             // Make this event visible
2391             $this->properties->visible = 1;
2392             // Fire the hook
2393             self::calendar_event_hook('show_event', array($this->properties));
2394         } else {
2395             // Make this event hidden
2396             $this->properties->visible = 0;
2397             // Fire the hook
2398             self::calendar_event_hook('hide_event', array($this->properties));
2399         }
2401         // Update the database to reflect this change
2402         return $DB->set_field('event', 'visible', $this->properties->visible, array('id'=>$this->properties->id));
2403     }
2405     /**
2406      * Attempts to call the hook for the specified action should a calendar type
2407      * by set $CFG->calendar, and the appopriate function defined
2408      *
2409      * @param string $action One of `update_event`, `add_event`, `delete_event`, `show_event`, `hide_event`
2410      * @param array $args The args to pass to the hook, usually the event is the first element
2411      * @return bool attempts to call event hook
2412      */
2413     public static function calendar_event_hook($action, array $args) {
2414         global $CFG;
2415         static $extcalendarinc;
2416         if ($extcalendarinc === null) {
2417             if (!empty($CFG->calendar) && file_exists($CFG->dirroot .'/calendar/'. $CFG->calendar .'/lib.php')) {
2418                 include_once($CFG->dirroot .'/calendar/'. $CFG->calendar .'/lib.php');
2419                 $extcalendarinc = true;
2420             } else {
2421                 $extcalendarinc = false;
2422             }
2423         }
2424         if($extcalendarinc === false) {
2425             return false;
2426         }
2427         $hook = $CFG->calendar .'_'.$action;
2428         if (function_exists($hook)) {
2429             call_user_func_array($hook, $args);
2430             return true;
2431         }
2432         return false;
2433     }
2435     /**
2436      * Returns a calendar_event object when provided with an event id
2437      *
2438      * This function makes use of MUST_EXIST, if the event id passed in is invalid
2439      * it will result in an exception being thrown
2440      *
2441      * @param int|object $param event object or event id
2442      * @return calendar_event|false status for loading calendar_event
2443      */
2444     public static function load($param) {
2445         global $DB;
2446         if (is_object($param)) {
2447             $event = new calendar_event($param);
2448         } else {
2449             $event = $DB->get_record('event', array('id'=>(int)$param), '*', MUST_EXIST);
2450             $event = new calendar_event($event);
2451         }
2452         return $event;
2453     }
2455     /**
2456      * Creates a new event and returns a calendar_event object
2457      *
2458      * @param object|array $properties An object containing event properties
2459      * @return calendar_event|false The event object or false if it failed
2460      */
2461     public static function create($properties) {
2462         if (is_array($properties)) {
2463             $properties = (object)$properties;
2464         }
2465         if (!is_object($properties)) {
2466             throw new coding_exception('When creating an event properties should be either an object or an assoc array');
2467         }
2468         $event = new calendar_event($properties);
2469         if ($event->update($properties)) {
2470             return $event;
2471         } else {
2472             return false;
2473         }
2474     }
2477 /**
2478  * Calendar information class
2479  *
2480  * This class is used simply to organise the information pertaining to a calendar
2481  * and is used primarily to make information easily available.
2482  *
2483  * @package core_calendar
2484  * @category calendar
2485  * @copyright 2010 Sam Hemelryk
2486  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2487  */
2488 class calendar_information {
2489     /** @var int The day */
2490     public $day;
2492     /** @var int The month */
2493     public $month;
2495     /** @var int The year */
2496     public $year;
2498     /** @var int A course id */
2499     public $courseid = null;
2501     /** @var array An array of courses */
2502     public $courses = array();
2504     /** @var array An array of groups */
2505     public $groups = array();
2507     /** @var array An array of users */
2508     public $users = array();
2510     /**
2511      * Creates a new instance
2512      *
2513      * @param int $day the number of the day
2514      * @param int $month the number of the month
2515      * @param int $year the number of the year
2516      */
2517     public function __construct($day=0, $month=0, $year=0) {
2519         $date = usergetdate(time());
2521         if (empty($day)) {
2522             $day = $date['mday'];
2523         }
2525         if (empty($month)) {
2526             $month = $date['mon'];
2527         }
2529         if (empty($year)) {
2530             $year =  $date['year'];
2531         }
2533         $this->day = $day;
2534         $this->month = $month;
2535         $this->year = $year;
2536     }
2538     /**
2539      * Initialize calendar information
2540      *
2541      * @param stdClass $course object
2542      * @param array $coursestoload An array of courses [$course->id => $course]
2543      * @param bool $ignorefilters options to use filter
2544      */
2545     public function prepare_for_view(stdClass $course, array $coursestoload, $ignorefilters = false) {
2546         $this->courseid = $course->id;
2547         $this->course = $course;
2548         list($courses, $group, $user) = calendar_set_filters($coursestoload, $ignorefilters);
2549         $this->courses = $courses;
2550         $this->groups = $group;
2551         $this->users = $user;
2552     }
2554     /**
2555      * Ensures the date for the calendar is correct and either sets it to now
2556      * or throws a moodle_exception if not
2557      *
2558      * @param bool $defaultonow use current time
2559      * @throws moodle_exception
2560      * @return bool validation of checkdate
2561      */
2562     public function checkdate($defaultonow = true) {
2563         if (!checkdate($this->month, $this->day, $this->year)) {
2564             if ($defaultonow) {
2565                 $now = usergetdate(time());
2566                 $this->day = intval($now['mday']);
2567                 $this->month = intval($now['mon']);
2568                 $this->year = intval($now['year']);
2569                 return true;
2570             } else {
2571                 throw new moodle_exception('invaliddate');
2572             }
2573         }
2574         return true;
2575     }
2576     /**
2577      * Gets todays timestamp for the calendar
2578      *
2579      * @return int today timestamp
2580      */
2581     public function timestamp_today() {
2582         return make_timestamp($this->year, $this->month, $this->day);
2583     }
2584     /**
2585      * Gets tomorrows timestamp for the calendar
2586      *
2587      * @return int tomorrow timestamp
2588      */
2589     public function timestamp_tomorrow() {
2590         return make_timestamp($this->year, $this->month, $this->day+1);
2591     }
2592     /**
2593      * Adds the pretend blocks for teh calendar
2594      *
2595      * @param core_calendar_renderer $renderer
2596      * @param bool $showfilters display filters, false is set as default
2597      * @param string|null $view preference view options (eg: day, month, upcoming)
2598      */
2599     public function add_sidecalendar_blocks(core_calendar_renderer $renderer, $showfilters=false, $view=null) {
2600         if ($showfilters) {
2601             $filters = new block_contents();
2602             $filters->content = $renderer->fake_block_filters($this->courseid, $this->day, $this->month, $this->year, $view, $this->courses);
2603             $filters->footer = '';
2604             $filters->title = get_string('eventskey', 'calendar');
2605             $renderer->add_pretend_calendar_block($filters, BLOCK_POS_RIGHT);
2606         }
2607         $block = new block_contents;
2608         $block->content = $renderer->fake_block_threemonths($this);
2609         $block->footer = '';
2610         $block->title = get_string('monthlyview', 'calendar');
2611         $renderer->add_pretend_calendar_block($block, BLOCK_POS_RIGHT);
2612     }