Added hooks to qtype import/export
[moodle-linuxchix.git] / calendar / lib.php
blobcaef701d280ad41b913e7a1a0896b6c99c82012a
1 <?php // $Id$
3 /////////////////////////////////////////////////////////////////////////////
4 // //
5 // NOTICE OF COPYRIGHT //
6 // //
7 // Moodle - Calendar extension //
8 // //
9 // Copyright (C) 2003-2004 Greek School Network www.sch.gr //
10 // //
11 // Designed by: //
12 // Avgoustos Tsinakos (tsinakos@teikav.edu.gr) //
13 // Jon Papaioannou (pj@moodle.org) //
14 // //
15 // Programming and development: //
16 // Jon Papaioannou (pj@moodle.org) //
17 // //
18 // For bugs, suggestions, etc contact: //
19 // Jon Papaioannou (pj@moodle.org) //
20 // //
21 // The current module was developed at the University of Macedonia //
22 // (www.uom.gr) under the funding of the Greek School Network (www.sch.gr) //
23 // The aim of this project is to provide additional and improved //
24 // functionality to the Asynchronous Distance Education service that the //
25 // Greek School Network deploys. //
26 // //
27 // This program is free software; you can redistribute it and/or modify //
28 // it under the terms of the GNU General Public License as published by //
29 // the Free Software Foundation; either version 2 of the License, or //
30 // (at your option) any later version. //
31 // //
32 // This program is distributed in the hope that it will be useful, //
33 // but WITHOUT ANY WARRANTY; without even the implied warranty of //
34 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the //
35 // GNU General Public License for more details: //
36 // //
37 // http://www.gnu.org/copyleft/gpl.html //
38 // //
39 /////////////////////////////////////////////////////////////////////////////
41 // These are read by the administration component to provide default values
42 define('CALENDAR_DEFAULT_UPCOMING_LOOKAHEAD', 21);
43 define('CALENDAR_DEFAULT_UPCOMING_MAXEVENTS', 10);
44 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
47 define('CALENDAR_DEFAULT_WEEKEND', 65);
49 // Fetch the correct values from admin settings/lang pack
50 // If no such settings found, use the above defaults
51 $firstday = isset($CFG->calendar_startwday) ? $CFG->calendar_startwday : get_string('firstdayofweek');
52 if(!is_numeric($firstday)) {
53 define ('CALENDAR_STARTING_WEEKDAY', CALENDAR_DEFAULT_STARTING_WEEKDAY);
55 else {
56 define ('CALENDAR_STARTING_WEEKDAY', intval($firstday) % 7);
58 define ('CALENDAR_UPCOMING_DAYS', isset($CFG->calendar_lookahead) ? intval($CFG->calendar_lookahead) : CALENDAR_DEFAULT_UPCOMING_LOOKAHEAD);
59 define ('CALENDAR_UPCOMING_MAXEVENTS', isset($CFG->calendar_maxevents) ? intval($CFG->calendar_maxevents) : CALENDAR_DEFAULT_UPCOMING_MAXEVENTS);
60 define ('CALENDAR_WEEKEND', isset($CFG->calendar_weekend) ? intval($CFG->calendar_weekend) : CALENDAR_DEFAULT_WEEKEND);
61 define ('CALENDAR_URL', $CFG->wwwroot.'/calendar/');
62 define ('CALENDAR_TF_24', '%H:%M');
63 define ('CALENDAR_TF_12', '%I:%M %p');
65 define ('CALENDAR_MAXCOURSES', 3);
67 $CALENDARDAYS = array('sunday','monday','tuesday','wednesday','thursday','friday','saturday');
71 function calendar_get_mini($courses, $groups, $users, $cal_month = false, $cal_year = false) {
72 global $CFG, $USER;
74 $display = &New stdClass;
75 $display->minwday = get_user_preferences('calendar_startwday', CALENDAR_STARTING_WEEKDAY);
76 $display->maxwday = $display->minwday + 6;
78 $content = '';
80 if(!empty($cal_month) && !empty($cal_year)) {
81 $thisdate = usergetdate(time()); // Date and time the user sees at his location
82 if($cal_month == $thisdate['mon'] && $cal_year == $thisdate['year']) {
83 // Navigated to this month
84 $date = $thisdate;
85 $display->thismonth = true;
87 else {
88 // Navigated to other month, let's do a nice trick and save us a lot of work...
89 if(!checkdate($cal_month, 1, $cal_year)) {
90 $date = array('mday' => 1, 'mon' => $thisdate['mon'], 'year' => $thisdate['year']);
91 $display->thismonth = true;
93 else {
94 $date = array('mday' => 1, 'mon' => $cal_month, 'year' => $cal_year);
95 $display->thismonth = false;
99 else {
100 $date = usergetdate(time()); // Date and time the user sees at his location
101 $display->thismonth = true;
104 // Fill in the variables we 're going to use, nice and tidy
105 list($d, $m, $y) = array($date['mday'], $date['mon'], $date['year']); // This is what we want to display
106 $display->maxdays = calendar_days_in_month($m, $y);
108 if (get_user_timezone_offset() < 99) {
109 // We 'll keep these values as GMT here, and offset them when the time comes to query the db
110 $display->tstart = gmmktime(0, 0, 0, $m, 1, $y); // This is GMT
111 $display->tend = gmmktime(23, 59, 59, $m, $display->maxdays, $y); // GMT
112 } else {
113 // no timezone info specified
114 $display->tstart = mktime(0, 0, 0, $m, 1, $y);
115 $display->tend = mktime(23, 59, 59, $m, $display->maxdays, $y);
118 $startwday = dayofweek(1, $m, $y);
120 // Align the starting weekday to fall in our display range
121 // This is simple, not foolproof.
122 if($startwday < $display->minwday) {
123 $startwday += 7;
126 // TODO: THIS IS TEMPORARY CODE!
127 // [pj] I was just reading through this and realized that I when writing this code I was probably
128 // asking for trouble, as all these time manipulations seem to be unnecessary and a simple
129 // make_timestamp would accomplish the same thing. So here goes a test:
130 //$test_start = make_timestamp($y, $m, 1);
131 //$test_end = make_timestamp($y, $m, $display->maxdays, 23, 59, 59);
132 //if($test_start != usertime($display->tstart) - dst_offset_on($display->tstart)) {
133 //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);
135 //if($test_end != usertime($display->tend) - dst_offset_on($display->tend)) {
136 //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);
140 // Get the events matching our criteria. Don't forget to offset the timestamps for the user's TZ!
141 $whereclause = calendar_sql_where(
142 usertime($display->tstart) - dst_offset_on($display->tstart),
143 usertime($display->tend) - dst_offset_on($display->tend),
144 $users, $groups, $courses);
146 if($whereclause === false) {
147 $events = array();
149 else {
150 $events = get_records_select('event', $whereclause, 'timestart');
153 // Set event course class for course events
154 if (!empty($events)) {
155 foreach ($events as $event) {
156 if($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) {
157 $event->class = 'event_course'.array_search($event->courseid, $courses) % CALENDAR_MAXCOURSES;
162 // This is either a genius idea or an idiot idea: in order to not complicate things, we use this rule: if, after
163 // possibly removing SITEID from $courses, there is only one course left, then clicking on a day in the month
164 // will also set the $SESSION->cal_courses_shown variable to that one course. Otherwise, we 'd need to add extra
165 // arguments to this function.
167 $morehref = '';
168 if(!empty($courses)) {
169 $courses = array_diff($courses, array(SITEID));
170 if(count($courses) == 1) {
171 $morehref = '&amp;course='.reset($courses);
175 // We want to have easy access by day, since the display is on a per-day basis.
176 // Arguments passed by reference.
177 //calendar_events_by_day($events, $display->tstart, $eventsbyday, $durationbyday, $typesbyday);
178 calendar_events_by_day($events, $m, $y, $eventsbyday, $durationbyday, $typesbyday, $courses);
180 //Accessibility: added summary and <abbr> elements.
181 ///global $CALENDARDAYS; appears to be broken.
182 $days_title = array('sunday','monday','tuesday','wednesday','thursday','friday','saturday');
184 $summary = get_string('calendarheading', 'calendar', userdate(make_timestamp($y, $m), get_string('strftimemonthyear')));
185 $summary = get_string('tabledata', 'access', $summary);
186 $content .= '<table class="minicalendar" summary="'.$summary.'">'; // Begin table
187 $content .= '<tr class="weekdays">'; // Header row: day names
189 // Print out the names of the weekdays
190 $days = array('sun', 'mon', 'tue', 'wed', 'thu', 'fri', 'sat');
191 for($i = $display->minwday; $i <= $display->maxwday; ++$i) {
192 // This uses the % operator to get the correct weekday no matter what shift we have
193 // applied to the $display->minwday : $display->maxwday range from the default 0 : 6
194 $content .= '<th scope="col"><abbr title="'. get_string($days_title[$i % 7], 'calendar') .'">'.
195 get_string($days[$i % 7], 'calendar') ."</abbr></th>\n";
198 $content .= '</tr><tr>'; // End of day names; prepare for day numbers
200 // For the table display. $week is the row; $dayweek is the column.
201 $dayweek = $startwday;
203 // Paddding (the first week may have blank days in the beginning)
204 for($i = $display->minwday; $i < $startwday; ++$i) {
205 $content .= '<td class="dayblank">&nbsp;</td>'."\n";
208 // Now display all the calendar
209 for($day = 1; $day <= $display->maxdays; ++$day, ++$dayweek) {
210 if($dayweek > $display->maxwday) {
211 // We need to change week (table row)
212 $content .= '</tr><tr>';
213 $dayweek = $display->minwday;
216 // Reset vars
217 $cell = '';
218 if(CALENDAR_WEEKEND & (1 << ($dayweek % 7))) {
219 // Weekend. This is true no matter what the exact range is.
220 $class = 'weekend day';
222 else {
223 // Normal working day.
224 $class = 'day';
227 // Special visual fx if an event is defined
228 if(isset($eventsbyday[$day])) {
229 $dayhref = calendar_get_link_href(CALENDAR_URL.'view.php?view=day'.$morehref.'&amp;', $day, $m, $y);
231 // OverLib popup
232 $popupcontent = '';
233 foreach($eventsbyday[$day] as $eventid) {
234 if (!isset($events[$eventid])) {
235 continue;
237 $event = $events[$eventid];
238 if(!empty($event->modulename)) {
239 $popupicon = $CFG->modpixpath.'/'.$event->modulename.'/icon.gif';
240 $popupalt = $event->modulename;
242 } else if ($event->courseid == SITEID) { // Site event
243 $popupicon = $CFG->pixpath.'/c/site.gif';
244 $popupalt = '';
245 } else if ($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) { // Course event
246 $popupicon = $CFG->pixpath.'/c/course.gif';
247 $popupalt = '';
248 } else if ($event->groupid) { // Group event
249 $popupicon = $CFG->pixpath.'/c/group.gif';
250 $popupalt = '';
251 } else if ($event->userid) { // User event
252 $popupicon = $CFG->pixpath.'/c/user.gif';
253 $popupalt = '';
255 $popupcontent .= '<div><img class="icon" src="'.$popupicon.'" alt="'.$popupalt.'" /><a href="'.$dayhref.'#event_'.$event->id.'">'.format_string($event->name, true).'</a></div>';
258 //Accessibility: functionality moved to calendar_get_popup.
259 if($display->thismonth && $day == $d) {
260 $popup = calendar_get_popup(true, $events[$eventid]->timestart, $popupcontent);
261 } else {
262 $popup = calendar_get_popup(false, $events[$eventid]->timestart, $popupcontent);
265 // Class and cell content
266 if(isset($typesbyday[$day]['startglobal'])) {
267 $class .= ' event_global';
269 else if(isset($typesbyday[$day]['startcourse'])) {
270 $class .= ' event_course';
272 else if(isset($typesbyday[$day]['startgroup'])) {
273 $class .= ' event_group';
275 else if(isset($typesbyday[$day]['startuser'])) {
276 $class .= ' event_user';
278 $cell = '<a href="'.$dayhref.'" '.$popup.'>'.$day.'</a>';
280 else {
281 $cell = $day;
284 if(isset($typesbyday[$day]['durationglobal'])) {
285 $class .= ' duration_global';
287 else if(isset($typesbyday[$day]['durationcourse'])) {
288 $class .= ' duration_course';
290 else if(isset($typesbyday[$day]['durationgroup'])) {
291 $class .= ' duration_group';
293 else if(isset($typesbyday[$day]['durationuser'])) {
294 $class .= ' duration_user';
297 // If event has a class set then add it to the table day <td> tag
298 // Note: only one colour for minicalendar
299 if(isset($eventsbyday[$day])) {
300 foreach($eventsbyday[$day] as $eventid) {
301 if (!isset($events[$eventid])) {
302 continue;
304 $event = $events[$eventid];
305 if (!empty($event->class)) {
306 $class .= ' '.$event->class;
308 break;
312 // Special visual fx for today
313 //Accessibility: hidden text for today, and popup.
314 if($display->thismonth && $day == $d) {
315 $class .= ' today';
316 $today = get_string('today', 'calendar').' '.userdate(time(), get_string('strftimedayshort'));
318 if(! isset($eventsbyday[$day])) {
319 $class .= ' eventnone';
320 $popup = calendar_get_popup(true, false);
321 $cell = '<a href="#" '.$popup.'>'.$day.'</a>';
323 $cell = '<span class="accesshide">'.$today.' </span>'.$cell;
326 // Just display it
327 if(!empty($class)) {
328 $class = ' class="'.$class.'"';
330 $content .= '<td'.$class.'>'.$cell."</td>\n";
333 // Paddding (the last week may have blank days at the end)
334 for($i = $dayweek; $i <= $display->maxwday; ++$i) {
335 $content .= '<td class="dayblank">&nbsp;</td>';
337 $content .= '</tr>'; // Last row ends
339 $content .= '</table>'; // Tabular display of days ends
341 return $content;
345 * calendar_get_popup, called at multiple points in from calendar_get_mini.
346 * Copied and modified from calendar_get_mini.
347 * @uses OverLib popup.
348 * @param $is_today bool, false except when called on the current day.
349 * @param $event_timestart mixed, $events[$eventid]->timestart, OR false if there are no events.
350 * @param $popupcontent string.
351 * @return $popup string, contains onmousover and onmouseout events.
353 function calendar_get_popup($is_today, $event_timestart, $popupcontent='') {
354 $popupcaption = '';
355 if($is_today) {
356 $popupcaption = get_string('today', 'calendar').' ';
358 if (false === $event_timestart) {
359 $popupcaption .= userdate(time(), get_string('strftimedayshort'));
360 $popupcontent = get_string('eventnone', 'calendar');
362 } else {
363 $popupcaption .= get_string('eventsfor', 'calendar', userdate($event_timestart, get_string('strftimedayshort')));
365 $popupcontent = str_replace("'", "\'", htmlspecialchars($popupcontent));
366 $popupcaption = str_replace("'", "\'", htmlspecialchars($popupcaption));
367 $popup = 'onmouseover="return overlib(\''.$popupcontent.'\', CAPTION, \''.$popupcaption.'\');" onmouseout="return nd();"';
368 return $popup;
371 function calendar_get_upcoming($courses, $groups, $users, $daysinfuture, $maxevents, $fromtime=0) {
372 global $CFG;
374 $display = &new stdClass;
375 $display->range = $daysinfuture; // How many days in the future we 'll look
376 $display->maxevents = $maxevents;
378 $output = array();
380 // Prepare "course caching", since it may save us a lot of queries
381 $coursecache = array();
383 $processed = 0;
384 $now = time(); // We 'll need this later
385 $usermidnighttoday = usergetmidnight($now);
387 if ($fromtime) {
388 $display->tstart = $fromtime;
389 } else {
390 $display->tstart = $usermidnighttoday;
393 // This works correctly with respect to the user's DST, but it is accurate
394 // only because $fromtime is always the exact midnight of some day!
395 $display->tend = usergetmidnight($display->tstart + DAYSECS * $display->range + 3 * HOURSECS) - 1;
397 // Get the events matching our criteria
398 $whereclause = calendar_sql_where($display->tstart, $display->tend, $users, $groups, $courses);
399 if ($whereclause === false) {
400 $events = false;
401 } else {
402 $events = get_records_select('event', $whereclause, 'timestart');
405 // This is either a genius idea or an idiot idea: in order to not complicate things, we use this rule: if, after
406 // possibly removing SITEID from $courses, there is only one course left, then clicking on a day in the month
407 // will also set the $SESSION->cal_courses_shown variable to that one course. Otherwise, we 'd need to add extra
408 // arguments to this function.
410 $morehref = '';
411 if(!empty($courses)) {
412 $courses = array_diff($courses, array(SITEID));
413 if(count($courses) == 1) {
414 $morehref = '&amp;course='.reset($courses);
418 if($events !== false) {
420 foreach($events as $event) {
422 if($processed >= $display->maxevents) {
423 break;
426 $event->time = calendar_format_event_time($event, $now, $morehref);
427 $output[] = $event;
428 ++$processed;
431 return $output;
434 function calendar_add_event_metadata($event) {
435 global $CFG;
437 //Support multilang in event->name
438 $event->name = format_string($event->name,true);
440 if(!empty($event->modulename)) { // Activity event
441 // The module name is set. I will assume that it has to be displayed, and
442 // also that it is an automatically-generated event. And of course that the
443 // fields for get_coursemodule_from_instance are set correctly.
444 $module = calendar_get_module_cached($coursecache, $event->modulename, $event->instance);
446 if ($module === false) {
447 return;
450 $modulename = get_string('modulename', $event->modulename);
451 $eventtype = get_string($event->eventtype, $event->modulename);
452 $icon = $CFG->modpixpath.'/'.$event->modulename.'/icon.gif';
454 $event->icon = '<img height="16" width="16" src="'.$icon.'" alt="'.$eventtype.'" title="'.$modulename.'" style="vertical-align: middle;" />';
455 $event->referer = '<a href="'.$CFG->wwwroot.'/mod/'.$event->modulename.'/view.php?id='.$module->id.'">'.$event->name.'</a>';
456 $event->courselink = '<a href="'.$CFG->wwwroot.'/course/view.php?id='.$module->course.'">'.$coursecache[$module->course]->fullname.'</a>';
457 $event->cmid = $module->id;
460 } else if($event->courseid == SITEID) { // Site event
461 $event->icon = '<img height="16" width="16" src="'.$CFG->pixpath.'/c/site.gif" alt="'.get_string('globalevent', 'calendar').'" style="vertical-align: middle;" />';
462 $event->cssclass = 'event_global';
463 } else if($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) { // Course event
464 calendar_get_course_cached($coursecache, $event->courseid);
465 $event->icon = '<img height="16" width="16" src="'.$CFG->pixpath.'/c/course.gif" alt="'.get_string('courseevent', 'calendar').'" style="vertical-align: middle;" />';
466 $event->courselink = '<a href="'.$CFG->wwwroot.'/course/view.php?id='.$event->courseid.'">'.$coursecache[$event->courseid]->fullname.'</a>';
467 $event->cssclass = 'event_course';
468 } else if ($event->groupid) { // Group event
469 $event->icon = '<img height="16" width="16" src="'.$CFG->pixpath.'/c/group.gif" alt="'.get_string('groupevent', 'calendar').'" style="vertical-align: middle;" />';
470 $event->cssclass = 'event_group';
471 } else if($event->userid) { // User event
472 $event->icon = '<img height="16" width="16" src="'.$CFG->pixpath.'/c/user.gif" alt="'.get_string('userevent', 'calendar').'" style="vertical-align: middle;" />';
473 $event->cssclass = 'event_user';
475 return $event;
478 function calendar_print_event($event) {
479 global $CFG, $USER;
481 static $strftimetime;
483 $event = calendar_add_event_metadata($event);
484 echo '<a name="event_'.$event->id.'"></a><table class="event" cellspacing="0">';
485 echo '<tr><td class="picture">';
486 if (!empty($event->icon)) {
487 echo $event->icon;
488 } else {
489 print_spacer(16,16);
491 echo '</td>';
492 echo '<td class="topic">';
494 if (!empty($event->referer)) {
495 echo '<div class="referer">'.$event->referer.'</div>';
496 } else {
497 echo '<div class="name">'.$event->name."</div>";
499 if (!empty($event->courselink)) {
500 echo '<div class="course">'.$event->courselink.' </div>';
502 if (!empty($event->time)) {
503 echo '<span class="date">'.$event->time.'</span>';
504 } else {
505 echo '<span class="date">'.calendar_time_representation($event->timestart).'</span>';
508 echo '</td></tr>';
509 echo '<tr><td class="side">&nbsp;</td>';
511 // If event has a class set then add it to the event <td> tag
512 $eventclass='';
513 if (!empty($event->class)) {
514 $eventclass = ' '.$event->class;
517 echo '<td class="description '.$event->cssclass.$eventclass.'">';
518 echo format_text($event->description, FORMAT_HTML);
519 if (calendar_edit_event_allowed($event)) {
520 echo '<div class="commands">';
521 $calendarcourseid = '';
522 if (!empty($event->calendarcourseid)) {
523 $calendarcourseid = '&amp;course='.$event->calendarcourseid;
525 if (empty($event->cmid)) {
526 $editlink = CALENDAR_URL.'event.php?action=edit&amp;id='.$event->id.$calendarcourseid;
527 $deletelink = CALENDAR_URL.'event.php?action=delete&amp;id='.$event->id.$calendarcourseid;
528 } else {
529 $editlink = $CFG->wwwroot.'/course/mod.php?update='.$event->cmid.'&amp;return=true&amp;sesskey='.$USER->sesskey;
530 $deletelink = $CFG->wwwroot.'/course/mod.php?delete='.$event->cmid.'&amp;sesskey='.$USER->sesskey;;
532 echo ' <a href="'.$editlink.'"><img
533 src="'.$CFG->pixpath.'/t/edit.gif" alt="'.get_string('tt_editevent', 'calendar').'"
534 title="'.get_string('tt_editevent', 'calendar').'" /></a>';
535 echo ' <a href="'.$deletelink.'"><img
536 src="'.$CFG->pixpath.'/t/delete.gif" alt="'.get_string('tt_deleteevent', 'calendar').'"
537 title="'.get_string('tt_deleteevent', 'calendar').'" /></a>';
538 echo '</div>';
540 echo '</td></tr></table>';
544 function calendar_sql_where($tstart, $tend, $users, $groups, $courses, $withduration=true, $ignorehidden=true) {
545 $whereclause = '';
546 // Quick test
547 if(is_bool($users) && is_bool($groups) && is_bool($courses)) {
548 return false;
551 if(is_array($users) && !empty($users)) {
552 // Events from a number of users
553 if(!empty($whereclause)) $whereclause .= ' OR';
554 $whereclause .= ' (userid IN ('.implode(',', $users).') AND courseid = 0 AND groupid = 0)';
556 else if(is_numeric($users)) {
557 // Events from one user
558 if(!empty($whereclause)) $whereclause .= ' OR';
559 $whereclause .= ' (userid = '.$users.' AND courseid = 0 AND groupid = 0)';
561 else if($users === true) {
562 // Events from ALL users
563 if(!empty($whereclause)) $whereclause .= ' OR';
564 $whereclause .= ' (userid != 0 AND courseid = 0 AND groupid = 0)';
566 else if($users === false) {
567 // No user at all, do nothing
570 if(is_array($groups) && !empty($groups)) {
571 // Events from a number of groups
572 if(!empty($whereclause)) $whereclause .= ' OR';
573 $whereclause .= ' groupid IN ('.implode(',', $groups).')';
575 else if(is_numeric($groups)) {
576 // Events from one group
577 if(!empty($whereclause)) $whereclause .= ' OR ';
578 $whereclause .= ' groupid = '.$groups;
580 else if($groups === true) {
581 // Events from ALL groups
582 if(!empty($whereclause)) $whereclause .= ' OR ';
583 $whereclause .= ' groupid != 0';
585 // boolean false (no groups at all): we don't need to do anything
587 if(is_array($courses)) {
588 // A number of courses (maybe none at all!)
589 if(!empty($courses)) {
590 if(!empty($whereclause)) {
591 $whereclause .= ' OR';
593 $whereclause .= ' (groupid = 0 AND courseid IN ('.implode(',', $courses).'))';
595 else {
596 // This means NO courses, not that we don't care!
597 // No need to do anything
600 else if(is_numeric($courses)) {
601 // One course
602 if(!empty($whereclause)) $whereclause .= ' OR';
603 $whereclause .= ' (groupid = 0 AND courseid = '.$courses.')';
605 else if($courses === true) {
606 // Events from ALL courses
607 if(!empty($whereclause)) $whereclause .= ' OR';
608 $whereclause .= ' (groupid = 0 AND courseid != 0)';
611 // Security check: if, by now, we have NOTHING in $whereclause, then it means
612 // that NO event-selecting clauses were defined. Thus, we won't be returning ANY
613 // events no matter what. Allowing the code to proceed might return a completely
614 // valid query with only time constraints, thus selecting ALL events in that time frame!
615 if(empty($whereclause)) {
616 return false;
619 if($withduration) {
620 $timeclause = '(timestart >= '.$tstart.' OR timestart + timeduration > '.$tstart.') AND timestart <= '.$tend;
622 else {
623 $timeclause = 'timestart >= '.$tstart.' AND timestart <= '.$tend;
625 if(!empty($whereclause)) {
626 // We have additional constraints
627 $whereclause = $timeclause.' AND ('.$whereclause.')';
629 else {
630 // Just basic time filtering
631 $whereclause = $timeclause;
634 if ($ignorehidden) {
635 $whereclause .= ' AND visible = 1';
638 return $whereclause;
641 function calendar_top_controls($type, $data) {
642 global $CFG, $CALENDARDAYS, $THEME;
643 $content = '';
644 if(!isset($data['d'])) {
645 $data['d'] = 1;
648 // Ensure course id passed if relevant
649 // Required due to changes in view/lib.php mainly (calendar_session_vars())
650 $courseid = '';
651 if (!empty($data['id'])) {
652 $courseid = '&amp;course='.$data['id'];
655 if(!checkdate($data['m'], $data['d'], $data['y'])) {
656 $time = time();
658 else {
659 $time = make_timestamp($data['y'], $data['m'], $data['d']);
661 $date = usergetdate($time);
663 $data['m'] = $date['mon'];
664 $data['y'] = $date['year'];
666 //Accessibility: calendar block controls, replaced <table> with <div>.
667 //$nexttext = link_arrow_right(get_string('monthnext', 'access'), $url='', $accesshide=true);
668 //$prevtext = link_arrow_left(get_string('monthprev', 'access'), $url='', $accesshide=true);
670 switch($type) {
671 case 'frontpage':
672 list($prevmonth, $prevyear) = calendar_sub_month($data['m'], $data['y']);
673 list($nextmonth, $nextyear) = calendar_add_month($data['m'], $data['y']);
674 $nextlink = calendar_get_link_next(get_string('monthnext', 'access'), 'index.php?', 0, $nextmonth, $nextyear, $accesshide=true);
675 $prevlink = calendar_get_link_previous(get_string('monthprev', 'access'), 'index.php?', 0, $prevmonth, $prevyear, true);
676 $content .= "\n".'<div class="calendar-controls">'. $prevlink;
677 $content .= '<span class="hide"> | </span><span class="current"><a href="'.calendar_get_link_href(CALENDAR_URL.'view.php?view=month'.$courseid.'&amp;', 1, $data['m'], $data['y']).'">'.userdate($time, get_string('strftimemonthyear')).'</a></span>';
678 $content .= '<span class="hide"> | </span>'. $nextlink ."\n";
679 $content .= "<span class=\"clearer\"><!-- --></span></div>\n";
680 break;
681 case 'course':
682 list($prevmonth, $prevyear) = calendar_sub_month($data['m'], $data['y']);
683 list($nextmonth, $nextyear) = calendar_add_month($data['m'], $data['y']);
684 $nextlink = calendar_get_link_next(get_string('monthnext', 'access'), 'view.php?id='.$data['id'].'&amp;', 0, $nextmonth, $nextyear, $accesshide=true);
685 $prevlink = calendar_get_link_previous(get_string('monthprev', 'access'), 'view.php?id='.$data['id'].'&amp;', 0, $prevmonth, $prevyear, true);
686 $content .= "\n".'<div class="calendar-controls">'. $prevlink;
687 $content .= '<span class="hide"> | </span><span class="current"><a href="'.calendar_get_link_href(CALENDAR_URL.'view.php?view=month'.$courseid.'&amp;', 1, $data['m'], $data['y']).'">'.userdate($time, get_string('strftimemonthyear')).'</a></span>';
688 $content .= '<span class="hide"> | </span>'. $nextlink ."\n";
689 $content .= "<span class=\"clearer\"><!-- --></span></div>\n";
690 break;
691 case 'upcoming':
692 $content .= '<div style="text-align: center;"><a href="'.CALENDAR_URL.'view.php?view=upcoming"'.$courseid.'>'.userdate($time, get_string('strftimemonthyear'))."</a></div>\n";
693 break;
694 case 'display':
695 $content .= '<div style="text-align: center;"><a href="'.calendar_get_link_href(CALENDAR_URL.'view.php?view=month'.$courseid.'&amp;', 1, $data['m'], $data['y']).'">'.userdate($time, get_string('strftimemonthyear'))."</a></div>\n";
696 break;
697 case 'month':
698 list($prevmonth, $prevyear) = calendar_sub_month($data['m'], $data['y']);
699 list($nextmonth, $nextyear) = calendar_add_month($data['m'], $data['y']);
700 $prevdate = make_timestamp($prevyear, $prevmonth, 1);
701 $nextdate = make_timestamp($nextyear, $nextmonth, 1);
702 $content .= "\n".'<div class="calendar-controls">';
703 $content .= calendar_get_link_previous(userdate($prevdate, get_string('strftimemonthyear')), 'view.php?view=month'.$courseid.'&amp;', 1, $prevmonth, $prevyear);
704 $content .= '<span class="hide"> | </span><span class="current">'.userdate($time, get_string('strftimemonthyear'))."</span>\n";
705 $content .= '<span class="hide"> | </span>'.calendar_get_link_next(userdate($nextdate, get_string('strftimemonthyear')), 'view.php?view=month'.$courseid.'&amp;', 1, $nextmonth, $nextyear);
706 $content .= "<span class=\"clearer\"><!-- --></span></div>\n";
707 break;
708 case 'day':
709 $data['d'] = $date['mday']; // Just for convenience
710 $prevdate = usergetdate(make_timestamp($data['y'], $data['m'], $data['d'] - 1));
711 $nextdate = usergetdate(make_timestamp($data['y'], $data['m'], $data['d'] + 1));
712 $prevname = calendar_wday_name($CALENDARDAYS[$prevdate['wday']]);
713 $nextname = calendar_wday_name($CALENDARDAYS[$nextdate['wday']]);
714 $content .= "\n".'<div class="calendar-controls">';
715 $content .= calendar_get_link_previous($prevname, 'view.php?view=day'.$courseid.'&amp;', $prevdate['mday'], $prevdate['mon'], $prevdate['year']);
717 // Get the format string
718 $text = get_string('strftimedaydate');
720 // Regexp hackery to make a link out of the month/year part
721 $text = ereg_replace('(%B.+%Y|%Y.+%B|%Y.+%m[^ ]+)', '<a href="'.calendar_get_link_href('view.php?view=month&amp;', 1, $data['m'], $data['y']).'">\\1</a>', $text);
722 $text = ereg_replace('(F.+Y|Y.+F|Y.+m[^ ]+)', '<a href="'.calendar_get_link_href('view.php?view=month&amp;', 1, $data['m'], $data['y']).'">\\1</a>', $text);
724 // Replace with actual values and lose any day leading zero
725 $text = userdate($time, $text);
726 // Print the actual thing
727 $content .= '<span class="hide"> | </span><span class="current">'.$text.'</span>';
729 $content .= '<span class="hide"> | </span>'. calendar_get_link_next($nextname, 'view.php?view=day'.$courseid.'&amp;', $nextdate['mday'], $nextdate['mon'], $nextdate['year']);
730 $content .= "<span class=\"clearer\"><!-- --></span></div>\n";
731 break;
733 return $content;
736 function calendar_filter_controls($type, $vars = NULL, $course = NULL, $courses = NULL) {
737 global $CFG, $SESSION, $USER;
739 $groupevents = true;
740 $getvars = '';
742 $id = optional_param( 'id',0,PARAM_INT );
744 switch($type) {
745 case 'event':
746 case 'upcoming':
747 case 'day':
748 case 'month':
749 $getvars = '&amp;from='.$type;
750 break;
751 case 'course':
752 if ($id > 0) {
753 $getvars = '&amp;from=course&amp;id='.$id;
754 } else {
755 $getvars = '&amp;from=course';
757 if (isset($course->groupmode) and $course->groupmode == NOGROUPS and $course->groupmodeforce) {
758 $groupevents = false;
760 break;
763 if (!empty($vars)) {
764 $getvars .= '&amp;'.$vars;
767 $content = '<table>';
769 $content .= '<tr>';
770 if($SESSION->cal_show_global) {
771 $content .= '<td class="eventskey event_global" style="width: 11px;"><img src="'.$CFG->pixpath.'/t/hide.gif" class="iconsmall" alt="'.get_string('hide').'" title="'.get_string('tt_hideglobal', 'calendar').'" style="cursor:pointer" onclick="location.href='."'".CALENDAR_URL.'set.php?var=showglobal'.$getvars."'".'" /></td>';
772 $content .= '<td><a href="'.CALENDAR_URL.'set.php?var=showglobal'.$getvars.'" title="'.get_string('tt_hideglobal', 'calendar').'">'.get_string('global', 'calendar').'</a></td>'."\n";
774 else {
775 $content .= '<td style="width: 11px;"><img src="'.$CFG->pixpath.'/t/show.gif" class="iconsmall" alt="'.get_string('show').'" title="'.get_string('tt_showglobal', 'calendar').'" style="cursor:pointer" onclick="location.href='."'".CALENDAR_URL.'set.php?var=showglobal'.$getvars."'".'" /></td>';
776 $content .= '<td><a href="'.CALENDAR_URL.'set.php?var=showglobal'.$getvars.'" title="'.get_string('tt_showglobal', 'calendar').'">'.get_string('global', 'calendar').'</a></td>'."\n";
778 $tr = '';
780 if(!empty($USER->id) && !isguest()) {
782 $content .= $tr;
783 $tr = $tr ? '' : "</tr>\n<tr>";
785 if($groupevents) {
787 // This course MIGHT have group events defined, so show the filter
788 if($SESSION->cal_show_groups) {
789 $content .= '<td class="eventskey event_group" style="width: 11px;"><img src="'.$CFG->pixpath.'/t/hide.gif" class="iconsmall" alt="'.get_string('hide').'" title="'.get_string('tt_hidegroups', 'calendar').'" style="cursor:pointer" onclick="location.href='."'".CALENDAR_URL.'set.php?var=showgroups'.$getvars."'".'" /></td>';
790 $content .= '<td><a href="'.CALENDAR_URL.'set.php?var=showgroups'.$getvars.'" title="'.get_string('tt_hidegroups', 'calendar').'">'.get_string('group', 'calendar').'</a></td>'."\n";
791 } else {
792 $content .= '<td style="width: 11px;"><img src="'.$CFG->pixpath.'/t/show.gif" class="iconsmall" alt="'.get_string('show').'" title="'.get_string('tt_showgroups', 'calendar').'" style="cursor:pointer" onclick="location.href='."'".CALENDAR_URL.'set.php?var=showgroups'.$getvars."'".'" /></td>';
793 $content .= '<td><a href="'.CALENDAR_URL.'set.php?var=showgroups'.$getvars.'" title="'.get_string('tt_showgroups', 'calendar').'">'.get_string('group', 'calendar').'</a></td>'."\n";
795 } else {
797 // This course CANNOT have group events, so lose the filter
798 $content .= '<td style="width: 11px;"></td><td>&nbsp;</td>'."\n";
801 $content .= $tr;
802 $tr = $tr ? '' : "</tr>\n<tr>";
804 if ($SESSION->cal_show_user) {
805 $content .= '<td class="eventskey event_user" style="width: 11px;"><img src="'.$CFG->pixpath.'/t/hide.gif" class="iconsmall" alt="'.get_string('hide').'" title="'.get_string('tt_hideuser', 'calendar').'" style="cursor:pointer" onclick="location.href='."'".CALENDAR_URL.'set.php?var=showuser'.$getvars."'".'" /></td>';
806 $content .= '<td><a href="'.CALENDAR_URL.'set.php?var=showuser'.$getvars.'" title="'.get_string('tt_hideuser', 'calendar').'">'.get_string('user', 'calendar').'</a></td>'."\n";
807 } else {
808 $content .= '<td style="width: 11px;"><img src="'.$CFG->pixpath.'/t/show.gif" class="iconsmall" alt="'.get_string('show').'" title="'.get_string('tt_showuser', 'calendar').'" style="cursor:pointer" onclick="location.href='."'".CALENDAR_URL.'set.php?var=showuser'.$getvars."'".'" /></td>';
809 $content .= '<td><a href="'.CALENDAR_URL.'set.php?var=showuser'.$getvars.'" title="'.get_string('tt_showuser', 'calendar').'">'.get_string('user', 'calendar').'</a></td>'."\n";
813 // Remove global SITE ID from courses array as do not want to display this
814 if (!empty($courses)) {
815 $key = array_search(SITEID, $courses);
816 if ($key !== false) {
817 unset($courses[$key]);
821 if (empty($courses) || count($courses) == 1) {
823 // If not multiple courses then just display default single course colour highlighting
824 $content .= $tr;
825 $tr = $tr ? '' : "</tr>\n<tr>";
827 if($SESSION->cal_show_course) {
828 $content .= '<td class="eventskey event_course" style="width: 11px;"><img src="'.$CFG->pixpath.'/t/hide.gif" class="iconsmall" alt="'.get_string('hide').'" title="'.get_string('tt_hidecourse', 'calendar').'" style="cursor:pointer" onclick="location.href='."'".CALENDAR_URL.'set.php?var=showcourses'.$getvars."'".'" /></td>';
829 $content .= '<td><a href="'.CALENDAR_URL.'set.php?var=showcourses'.$getvars.'" title="'.get_string('tt_hidecourse', 'calendar').'">'.get_string('course', 'calendar').'</a></td>'."\n";
831 else {
832 $content .= '<td style="width: 11px;"><img src="'.$CFG->pixpath.'/t/show.gif" class="iconsmall" alt="'.get_string('hide').'" title="'.get_string('tt_showcourse', 'calendar').'" style="cursor:pointer" onclick="location.href='."'".CALENDAR_URL.'set.php?var=showcourses'.$getvars."'".'" /></td>';
833 $content .= '<td><a href="'.CALENDAR_URL.'set.php?var=showcourses'.$getvars.'" title="'.get_string('tt_showcourse', 'calendar').'">'.get_string('course', 'calendar').'</a></td>'."\n";
835 } else {
837 // Otherwise display list of course shortnames and relevant colours
838 // Get list of course shortnames (Limit to 12 for now - who would have more than that?)
839 $select = 'id in ('.implode(',', $courses).')';
840 $sort = 'id';
841 $fields = 'id, shortname';
842 $courseshortnames = get_records_select('course', $select, $sort, $fields, 0, 12);
844 for ($i = 0; $i < CALENDAR_MAXCOURSES; $i++) {
846 // Concatenate shortnames if there are more than 3 courses
847 $strshortnames = '';
848 $n = 0;
849 for ($j = $i; $j < count($courses); $j += CALENDAR_MAXCOURSES) {
850 $strshortnames .= ', <a title="" href="'.$CFG->wwwroot.'/course/view.php?id='.$courses[$j].'">'.(!empty($courseshortnames[$courses[$j]]->shortname) ? $courseshortnames[$courses[$j]]->shortname : $courses[$j]).'</a>';
851 $n++;
854 if ($n) {
856 $content .= $tr;
857 $tr = $tr ? '' : "</tr>\n<tr>";
859 if ($n < 2) {
860 $strcourse = get_string('course', 'calendar');
861 } else {
862 $strcourse = get_string('courses', 'calendar');
865 if($SESSION->cal_show_course) {
866 $content .= '<td class="eventskey event_course'.$i.'" style="width: 11px;"><img src="'.$CFG->pixpath.'/t/hide.gif" class="iconsmall" alt="'.get_string('hide').'" title="'.get_string('tt_hidecourse', 'calendar').'" style="cursor:pointer" onclick="location.href='."'".CALENDAR_URL.'set.php?var=showcourses'.$getvars."'".'" /></td>';
867 $content .= '<td><a href="'.CALENDAR_URL.'set.php?var=showcourses'.$getvars.'" title="'.get_string('tt_hidecourse', 'calendar').'">'.$strcourse.'</a>: '.substr($strshortnames, 2).'</td>'."\n";
869 else {
870 $content .= '<td style="width: 11px;"><img src="'.$CFG->pixpath.'/t/show.gif" class="iconsmall" alt="'.get_string('hide').'" title="'.get_string('tt_showcourse', 'calendar').'" style="cursor:pointer" onclick="location.href='."'".CALENDAR_URL.'set.php?var=showcourses'.$getvars."'".'" /></td>';
871 $content .= '<td><a href="'.CALENDAR_URL.'set.php?var=showcourses'.$getvars.'" title="'.get_string('tt_showcourse', 'calendar').'">'.$strcourse.'</a>: '.substr($strshortnames, 2).'</td>'."\n";
876 $content .= "</tr>\n</table>\n";
878 return $content;
881 function calendar_day_representation($tstamp, $now = false, $usecommonwords = true) {
883 static $shortformat;
884 if(empty($shortformat)) {
885 $shortformat = get_string('strftimedayshort');
888 if($now === false) {
889 $now = time();
892 // To have it in one place, if a change is needed
893 $formal = userdate($tstamp, $shortformat);
895 $datestamp = usergetdate($tstamp);
896 $datenow = usergetdate($now);
898 if($usecommonwords == false) {
899 // We don't want words, just a date
900 return $formal;
902 else if($datestamp['year'] == $datenow['year'] && $datestamp['yday'] == $datenow['yday']) {
903 // Today
904 return get_string('today', 'calendar');
906 else if(
907 ($datestamp['year'] == $datenow['year'] && $datestamp['yday'] == $datenow['yday'] - 1 ) ||
908 ($datestamp['year'] == $datenow['year'] - 1 && $datestamp['mday'] == 31 && $datestamp['mon'] == 12 && $datenow['yday'] == 1)
910 // Yesterday
911 return get_string('yesterday', 'calendar');
913 else if(
914 ($datestamp['year'] == $datenow['year'] && $datestamp['yday'] == $datenow['yday'] + 1 ) ||
915 ($datestamp['year'] == $datenow['year'] + 1 && $datenow['mday'] == 31 && $datenow['mon'] == 12 && $datestamp['yday'] == 1)
917 // Tomorrow
918 return get_string('tomorrow', 'calendar');
920 else {
921 return $formal;
925 function calendar_time_representation($time) {
926 static $langtimeformat = NULL;
927 if($langtimeformat === NULL) {
928 $langtimeformat = get_string('strftimetime');
930 $timeformat = get_user_preferences('calendar_timeformat');
931 if(empty($timeformat)){
932 $timeformat = get_config(NULL,'calendar_site_timeformat');
934 // The ? is needed because the preference might be present, but empty
935 return userdate($time, empty($timeformat) ? $langtimeformat : $timeformat);
938 function calendar_get_link_href($linkbase, $d, $m, $y) {
939 if(empty($linkbase)) return '';
940 $paramstr = '';
941 if(!empty($d)) $paramstr .= '&amp;cal_d='.$d;
942 if(!empty($m)) $paramstr .= '&amp;cal_m='.$m;
943 if(!empty($y)) $paramstr .= '&amp;cal_y='.$y;
944 if(!empty($paramstr)) $paramstr = substr($paramstr, 5);
945 return $linkbase.$paramstr;
948 function calendar_get_link_tag($text, $linkbase, $d, $m, $y) {
949 $href = calendar_get_link_href($linkbase, $d, $m, $y);
950 if(empty($href)) return $text;
951 return '<a href="'.$href.'">'.$text.'</a>';
955 * Build and return a previous month HTML link, with an arrow.
956 * @param string $text The text label.
957 * @param string $linkbase The URL stub.
958 * @param int $d $m $y Day of month, month and year numbers.
959 * @param bool $accesshide Default visible, or hide from all except screenreaders.
960 * @return string HTML string.
962 function calendar_get_link_previous($text, $linkbase, $d, $m, $y, $accesshide=false) {
963 $href = calendar_get_link_href($linkbase, $d, $m, $y);
964 if(empty($href)) return $text;
965 return link_arrow_left($text, $href, $accesshide, 'previous');
969 * Build and return a next month HTML link, with an arrow.
970 * @param string $text The text label.
971 * @param string $linkbase The URL stub.
972 * @param int $d $m $y Day of month, month and year numbers.
973 * @param bool $accesshide Default visible, or hide from all except screenreaders.
974 * @return string HTML string.
976 function calendar_get_link_next($text, $linkbase, $d, $m, $y, $accesshide=false) {
977 $href = calendar_get_link_href($linkbase, $d, $m, $y);
978 if(empty($href)) return $text;
979 return link_arrow_right($text, $href, $accesshide, 'next');
982 function calendar_wday_name($englishname) {
983 return get_string(strtolower($englishname), 'calendar');
986 function calendar_days_in_month($month, $year) {
987 return intval(date('t', mktime(0, 0, 0, $month, 1, $year)));
990 function calendar_get_sideblock_upcoming($events, $linkhref = NULL) {
991 $content = '';
992 $lines = count($events);
993 if (!$lines) {
994 return $content;
997 for ($i = 0; $i < $lines; ++$i) {
998 if (!isset($events[$i]->time)) { // Just for robustness
999 continue;
1001 $events[$i] = calendar_add_event_metadata($events[$i]);
1002 $content .= '<div class="event"><span class="icon c0">'.$events[$i]->icon.'</span> ';
1003 if (!empty($events[$i]->referer)) {
1004 // That's an activity event, so let's provide the hyperlink
1005 $content .= $events[$i]->referer;
1006 } else {
1007 if(!empty($linkhref)) {
1008 $ed = usergetdate($events[$i]->timestart);
1009 $href = calendar_get_link_href(CALENDAR_URL.$linkhref, $ed['mday'], $ed['mon'], $ed['year']);
1010 $content .= '<a href="'.$href.'#event_'.$events[$i]->id.'">'.$events[$i]->name.'</a>';
1012 else {
1013 $content .= $events[$i]->name;
1016 $events[$i]->time = str_replace('&raquo;', '<br />&raquo;', $events[$i]->time);
1017 $content .= '<div class="date">'.$events[$i]->time.'</div></div>';
1018 if ($i < $lines - 1) $content .= '<hr />';
1021 return $content;
1024 function calendar_add_month($month, $year) {
1025 if($month == 12) {
1026 return array(1, $year + 1);
1028 else {
1029 return array($month + 1, $year);
1033 function calendar_sub_month($month, $year) {
1034 if($month == 1) {
1035 return array(12, $year - 1);
1037 else {
1038 return array($month - 1, $year);
1042 function calendar_events_by_day($events, $month, $year, &$eventsbyday, &$durationbyday, &$typesbyday, &$courses) {
1043 $eventsbyday = array();
1044 $typesbyday = array();
1045 $durationbyday = array();
1047 if($events === false) {
1048 return;
1051 foreach($events as $event) {
1053 $startdate = usergetdate($event->timestart);
1054 // Set end date = start date if no duration
1055 if ($event->timeduration) {
1056 $enddate = usergetdate($event->timestart + $event->timeduration - 1);
1057 } else {
1058 $enddate = $startdate;
1061 // Simple arithmetic: $year * 13 + $month is a distinct integer for each distinct ($year, $month) pair
1062 if(!($startdate['year'] * 13 + $startdate['mon'] <= $year * 13 + $month) && ($enddate['year'] * 13 + $enddate['mon'] >= $year * 13 + $month)) {
1063 // Out of bounds
1064 continue;
1067 $eventdaystart = intval($startdate['mday']);
1069 if($startdate['mon'] == $month && $startdate['year'] == $year) {
1070 // Give the event to its day
1071 $eventsbyday[$eventdaystart][] = $event->id;
1073 // Mark the day as having such an event
1074 if($event->courseid == SITEID && $event->groupid == 0) {
1075 $typesbyday[$eventdaystart]['startglobal'] = true;
1076 // Set event class for global event
1077 $events[$event->id]->class = 'event_global';
1079 else if($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) {
1080 $typesbyday[$eventdaystart]['startcourse'] = true;
1081 // Set event class for course event
1082 $events[$event->id]->class = 'event_course'.array_search($event->courseid, $courses) % CALENDAR_MAXCOURSES;
1084 else if($event->groupid) {
1085 $typesbyday[$eventdaystart]['startgroup'] = true;
1086 // Set event class for group event
1087 $events[$event->id]->class = 'event_group';
1089 else if($event->userid) {
1090 $typesbyday[$eventdaystart]['startuser'] = true;
1091 // Set event class for user event
1092 $events[$event->id]->class = 'event_user';
1096 if($event->timeduration == 0) {
1097 // Proceed with the next
1098 continue;
1101 // The event starts on $month $year or before. So...
1102 $lowerbound = $startdate['mon'] == $month && $startdate['year'] == $year ? intval($startdate['mday']) : 0;
1104 // Also, it ends on $month $year or later...
1105 $upperbound = $enddate['mon'] == $month && $enddate['year'] == $year ? intval($enddate['mday']) : calendar_days_in_month($month, $year);
1107 // Mark all days between $lowerbound and $upperbound (inclusive) as duration
1108 for($i = $lowerbound + 1; $i <= $upperbound; ++$i) {
1109 $durationbyday[$i][] = $event->id;
1110 if($event->courseid == SITEID && $event->groupid == 0) {
1111 $typesbyday[$i]['durationglobal'] = true;
1113 else if($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) {
1114 $typesbyday[$i]['durationcourse'] = true;
1116 else if($event->groupid) {
1117 $typesbyday[$i]['durationgroup'] = true;
1119 else if($event->userid) {
1120 $typesbyday[$i]['durationuser'] = true;
1125 return;
1128 function calendar_get_module_cached(&$coursecache, $modulename, $instance) {
1129 $module = get_coursemodule_from_instance($modulename, $instance);
1131 if($module === false) return false;
1132 if(!calendar_get_course_cached($coursecache, $module->course)) {
1133 return false;
1135 return $module;
1138 function calendar_get_course_cached(&$coursecache, $courseid) {
1139 if(!isset($coursecache[$courseid])) {
1140 $coursecache[$courseid] = get_record('course', 'id', $courseid);
1142 return $coursecache[$courseid];
1145 function calendar_session_vars() {
1146 global $SESSION, $USER;
1148 if(!empty($USER->id) && isset($USER->realuser) && !isset($SESSION->cal_loggedinas)) {
1149 // We just logged in as someone else, update the filtering
1150 unset($SESSION->cal_users_shown);
1151 unset($SESSION->cal_courses_shown);
1152 $SESSION->cal_loggedinas = true;
1153 if(intval(get_user_preferences('calendar_persistflt', 0))) {
1154 calendar_set_filters_status(get_user_preferences('calendar_savedflt', 0xff));
1157 else if(!empty($USER->id) && !isset($USER->realuser) && isset($SESSION->cal_loggedinas)) {
1158 // We just logged back to our real self, update again
1159 unset($SESSION->cal_users_shown);
1160 unset($SESSION->cal_courses_shown);
1161 unset($SESSION->cal_loggedinas);
1162 if(intval(get_user_preferences('calendar_persistflt', 0))) {
1163 calendar_set_filters_status(get_user_preferences('calendar_savedflt', 0xff));
1167 if(!isset($SESSION->cal_course_referer)) {
1168 $SESSION->cal_course_referer = 0;
1170 if(!isset($SESSION->cal_show_global)) {
1171 $SESSION->cal_show_global = true;
1173 if(!isset($SESSION->cal_show_groups)) {
1174 $SESSION->cal_show_groups = true;
1176 if(!isset($SESSION->cal_show_course)) {
1177 $SESSION->cal_show_course = true;
1179 if(!isset($SESSION->cal_show_user)) {
1180 $SESSION->cal_show_user = true;
1182 // if(empty($SESSION->cal_courses_shown)) {
1183 $SESSION->cal_courses_shown = calendar_get_default_courses(true);
1185 if(empty($SESSION->cal_users_shown)) {
1186 // The empty() instead of !isset() here makes a whole world of difference,
1187 // as it will automatically change to the user's id when the user first logs
1188 // in. With !isset(), it would never do that.
1189 $SESSION->cal_users_shown = !empty($USER->id) ? $USER->id : false;
1191 else if(is_numeric($SESSION->cal_users_shown) && !empty($USER->id) && $SESSION->cal_users_shown != $USER->id) {
1192 // Follow the white rabbit, for example if a teacher logs in as a student
1193 $SESSION->cal_users_shown = $USER->id;
1197 function calendar_overlib_html() {
1198 return '<div id="overDiv" style="position: absolute; visibility: hidden; z-index:1000;"></div>'
1199 .'<script type="text/javascript" src="'.CALENDAR_URL.'overlib.cfg.php"></script>';
1202 function calendar_set_referring_course($courseid) {
1203 global $SESSION;
1204 $SESSION->cal_course_referer = intval($courseid);
1207 function calendar_set_filters(&$courses, &$group, &$user, $courseeventsfrom = NULL, $groupeventsfrom = NULL, $ignorefilters = false) {
1208 global $SESSION, $USER, $CFG;
1210 // Insidious bug-wannabe: setting $SESSION->cal_courses_shown to $course->id would cause
1211 // the code to function incorrectly UNLESS we convert it to an integer. One case where
1212 // PHP's loose type system works against us.
1213 if(is_string($SESSION->cal_courses_shown)) {
1214 $SESSION->cal_courses_shown = intval($SESSION->cal_courses_shown);
1217 if($courseeventsfrom === NULL) {
1218 $courseeventsfrom = $SESSION->cal_courses_shown;
1220 if($groupeventsfrom === NULL) {
1221 $groupeventsfrom = $SESSION->cal_courses_shown;
1224 if(($SESSION->cal_show_course && $SESSION->cal_show_global) || $ignorefilters) {
1225 if(is_int($courseeventsfrom)) {
1226 $courses = array(SITEID, $courseeventsfrom);
1228 else if(is_array($courseeventsfrom)) {
1229 $courses = array_keys($courseeventsfrom);
1230 $courses[] = SITEID;
1233 else if($SESSION->cal_show_course) {
1234 if(is_int($courseeventsfrom)) {
1235 $courses = array($courseeventsfrom);
1237 else if(is_array($courseeventsfrom)) {
1238 $courses = array_keys($courseeventsfrom);
1240 $courses = array_diff($courses, array(SITEID));
1242 else if($SESSION->cal_show_global) {
1243 $courses = array(SITEID);
1245 else {
1246 $courses = false;
1248 //BUG 6130 clean $courses array as SESSION has bad entries.
1249 // [pj] TODO: See if this has to do with my new change in get_default_courses and can be taken out
1250 if (is_array($courses)) {
1251 foreach ($courses as $index => $value) {
1252 if (empty($value)) unset($courses[$index]);
1255 // Sort courses for consistent colour highlighting
1256 // Effectively ignoring SITEID as setting as last course id
1257 $key = array_search(SITEID, $courses);
1258 if ($key !== false) {
1259 unset($courses[$key]);
1260 sort($courses);
1261 $courses[] = SITEID;
1262 } else {
1263 sort($courses);
1267 if($SESSION->cal_show_user || $ignorefilters) {
1268 // This doesn't work for arrays yet (maybe someday it will)
1269 $user = $SESSION->cal_users_shown;
1271 else {
1272 $user = false;
1274 if($SESSION->cal_show_groups || $ignorefilters) {
1275 if(is_int($groupeventsfrom)) {
1276 $groupcourses = array($groupeventsfrom);
1278 else if(is_array($groupeventsfrom)) {
1279 $groupcourses = array_keys($groupeventsfrom);
1282 // XXX TODO: not sure how to replace $CFG->calendar_adminseesall
1283 if(has_capability('moodle/calendar:manageentries', get_context_instance(CONTEXT_SYSTEM, SITEID)) && !empty($CFG->calendar_adminseesall)) {
1284 $group = true;
1286 else {
1287 $grouparray = array();
1289 // We already have the courses to examine in $courses
1290 // For each course...
1292 foreach($groupcourses as $courseid) {
1294 // If the user is an editing teacher in there,
1295 if(!empty($USER->id) && has_capability('moodle/calendar:manageentries', get_context_instance(CONTEXT_COURSE, $courseid))) {
1296 // If this course has groups, show events from all of them
1297 if(is_int($groupeventsfrom)) {
1298 $courserecord = get_record('course', 'id', $courseid);
1299 if ($courserecord->groupmode != NOGROUPS || !$courserecord->groupmodeforce) {
1300 $groupids[] = $courseid;
1303 else if(isset($SESSION->cal_courses_shown[$courseid]) && ($SESSION->cal_courses_shown[$courseid]->groupmode != NOGROUPS || !$SESSION->cal_courses_shown[$courseid]->groupmodeforce)) {
1304 $groupids[] = $courseid;
1308 // Otherwise (not editing teacher) show events from the group he is a member of
1309 else if(isset($USER->groupmember[$courseid])) {
1310 //changed to 2D array
1311 foreach ($USER->groupmember[$courseid] as $groupid){
1312 $grouparray[] = $groupid;
1317 if (!empty($groupids)) {
1318 $sql = "SELECT id, groupid
1319 FROM {$CFG->prefix}groups_courses_groups
1320 WHERE courseid IN (".implode(',', $groupids).')';
1322 if ($grouprecords= get_records_sql($sql)) {
1323 $grouparray = array_merge($grouparray, array_keys($grouprecords));
1327 if(empty($grouparray)) {
1328 $group = false;
1330 else {
1331 $group = $grouparray;
1336 else {
1337 $group = false;
1341 function calendar_edit_event_allowed($event) {
1343 global $USER;
1345 // can not be using guest account
1346 if ($USER->username == "guest") {
1347 return false;
1350 $sitecontext = get_context_instance(CONTEXT_SYSTEM, SITEID);
1351 // if user has manageentries at site level, return true
1352 if (has_capability('moodle/calendar:manageentries', $sitecontext)) {
1353 return true;
1356 // if groupid is set, it's definitely a group event
1357 if ($event->groupid) {
1358 //TODO:check.
1359 if (! groups_group_exists($event->groupid)) {
1360 return false;
1363 // this is ok because if you have this capability at course level, you should be able
1364 // to edit group calendar too
1365 // there is no need to check membership, because if you have this capability
1366 // you will have a role in this group context
1367 return has_capability('moodle/calendar:manageentries', get_context_instance(CONTEXT_GROUP, $event->groupid));
1368 } else if ($event->courseid) {
1369 // if groupid is not set, but course is set,
1370 // it's definiely a course event
1371 return has_capability('moodle/calendar:manageentries', get_context_instance(CONTEXT_COURSE, $event->courseid));
1372 } else if ($event->userid && $event->userid == $USER->id) {
1373 // if course is not set, but userid id set, it's a user event
1374 return (has_capability('moodle/calendar:manageownentries', $sitecontext));
1376 return false;
1379 function calendar_get_default_courses($ignoreref = false) {
1380 global $USER, $CFG, $SESSION;
1382 if(!empty($SESSION->cal_course_referer) && !$ignoreref) {
1383 return array($SESSION->cal_course_referer => 1);
1386 if(empty($USER->id)) {
1387 return array();
1390 $courses = array();
1391 if (has_capability('moodle/calendar:manageentries', get_context_instance(CONTEXT_SYSTEM, SITEID))) {
1392 if (!empty($CFG->calendar_adminseesall)) {
1393 $courses = get_records_sql('SELECT id, 1 FROM '.$CFG->prefix.'course');
1394 return $courses;
1398 if (isset($CFG->adminseesall)) {
1399 $courses = get_my_courses($USER->id, null, null, $CFG->adminseesall);
1401 else {
1402 $courses = get_my_courses($USER->id, null, null, false);
1405 return $courses;
1408 function calendar_preferences_button() {
1409 global $CFG, $USER;
1411 // Guests have no preferences
1412 if (empty($USER->id) || isguest()) {
1413 return '';
1416 return "<form $CFG->frametarget method=\"get\" ".
1417 " action=\"$CFG->wwwroot/calendar/preferences.php\">".
1418 "<div><input type=\"submit\" value=\"".get_string("preferences", "calendar")." ...\" /></div></form>";
1421 function calendar_format_event_time($event, $now, $morehref, $usecommonwords = true, $showtime=0) {
1422 $startdate = usergetdate($event->timestart);
1423 $enddate = usergetdate($event->timestart + $event->timeduration);
1424 $usermidnightstart = usergetmidnight($event->timestart);
1426 if($event->timeduration) {
1427 // To avoid doing the math if one IF is enough :)
1428 $usermidnightend = usergetmidnight($event->timestart + $event->timeduration);
1430 else {
1431 $usermidnightend = $usermidnightstart;
1434 // OK, now to get a meaningful display...
1435 // First of all we have to construct a human-readable date/time representation
1437 if($event->timeduration) {
1438 // It has a duration
1439 if($usermidnightstart == $usermidnightend ||
1440 ($event->timestart == $usermidnightstart) && ($event->timeduration == 86400 || $event->timeduration == 86399) ||
1441 ($event->timestart + $event->timeduration <= $usermidnightstart + 86400)) {
1442 // But it's all on the same day
1443 $timestart = calendar_time_representation($event->timestart);
1444 $timeend = calendar_time_representation($event->timestart + $event->timeduration);
1445 $time = $timestart.' <strong>&raquo;</strong> '.$timeend;
1447 if ($event->timestart == $usermidnightstart && ($event->timeduration == 86400 || $event->timeduration == 86399)) {
1448 $time = get_string('allday', 'calendar');
1451 // Set printable representation
1452 if (!$showtime) {
1453 $day = calendar_day_representation($event->timestart, $now, $usecommonwords);
1454 $eventtime = calendar_get_link_tag($day, CALENDAR_URL.'view.php?view=day'.$morehref.'&amp;', $enddate['mday'], $enddate['mon'], $enddate['year']).', '.$time;
1455 } else {
1456 $eventtime = $time;
1458 } else {
1459 // It spans two or more days
1460 $daystart = calendar_day_representation($event->timestart, $now, $usecommonwords).', ';
1461 if ($showtime == $usermidnightstart) {
1462 $daystart = '';
1464 $timestart = calendar_time_representation($event->timestart);
1465 $dayend = calendar_day_representation($event->timestart + $event->timeduration, $now, $usecommonwords).', ';
1466 if ($showtime == $usermidnightend) {
1467 $dayend = '';
1469 $timeend = calendar_time_representation($event->timestart + $event->timeduration);
1471 // Set printable representation
1472 if ($now >= $usermidnightstart && $now < ($usermidnightstart + 86400)) {
1473 $eventtime = $timestart.' <strong>&raquo;</strong> '.calendar_get_link_tag($dayend, CALENDAR_URL.'view.php?view=day'.$morehref.'&amp;', $enddate['mday'], $enddate['mon'], $enddate['year']).
1474 $timeend;
1475 } else {
1476 $eventtime = calendar_get_link_tag($daystart, CALENDAR_URL.'view.php?view=day'.$morehref.'&amp;', $startdate['mday'], $startdate['mon'], $startdate['year']).
1477 $timestart.' <strong>&raquo;</strong> '.calendar_get_link_tag($dayend, CALENDAR_URL.'view.php?view=day'.$morehref.'&amp;', $enddate['mday'], $enddate['mon'], $enddate['year']).
1478 $timeend;
1481 } else {
1482 $time = ' ';
1484 // Set printable representation
1485 if (!$showtime) {
1486 $day = calendar_day_representation($event->timestart, $now, $usecommonwords);
1487 $eventtime = calendar_get_link_tag($day, CALENDAR_URL.'view.php?view=day'.$morehref.'&amp;', $startdate['mday'], $startdate['mon'], $startdate['year']).trim($time);
1488 } else {
1489 $eventtime = $time;
1493 if($event->timestart + $event->timeduration < $now) {
1494 // It has expired
1495 $eventtime = '<span class="dimmed_text">'.str_replace(' href=', ' class="dimmed" href=', $eventtime).'</span>';
1498 return $eventtime;
1501 function calendar_print_month_selector($name, $selected) {
1503 $months = array();
1505 for ($i=1; $i<=12; $i++) {
1506 $months[$i] = userdate(gmmktime(12, 0, 0, $i, 15, 2000), '%B');
1509 choose_from_menu($months, $name, $selected, '');
1512 function calendar_get_filters_status() {
1513 global $SESSION;
1515 $status = 0;
1516 if($SESSION->cal_show_global) {
1517 $status += 1;
1519 if($SESSION->cal_show_course) {
1520 $status += 2;
1522 if($SESSION->cal_show_groups) {
1523 $status += 4;
1525 if($SESSION->cal_show_user) {
1526 $status += 8;
1528 return $status;
1531 function calendar_set_filters_status($packed_bitfield) {
1532 global $SESSION, $USER;
1534 if(!isset($USER) || empty($USER->id)) {
1535 return false;
1538 $SESSION->cal_show_global = ($packed_bitfield & 1);
1539 $SESSION->cal_show_course = ($packed_bitfield & 2);
1540 $SESSION->cal_show_groups = ($packed_bitfield & 4);
1541 $SESSION->cal_show_user = ($packed_bitfield & 8);
1543 return true;
1546 function calendar_get_allowed_types(&$allowed) {
1547 global $USER, $CFG, $SESSION;
1548 $sitecontext = get_context_instance(CONTEXT_SYSTEM);
1549 $allowed->user = has_capability('moodle/calendar:manageownentries', $sitecontext);
1550 $allowed->groups = false; // This may change just below
1551 $allowed->courses = false; // This may change just below
1552 $allowed->site = has_capability('moodle/calendar:manageentries', get_context_instance(CONTEXT_COURSE, SITEID));
1554 if(!empty($SESSION->cal_course_referer) && $SESSION->cal_course_referer != SITEID && has_capability('moodle/calendar:manageentries', get_context_instance(CONTEXT_COURSE, $SESSION->cal_course_referer))) {
1555 $course = get_record('course', 'id', $SESSION->cal_course_referer);
1557 $allowed->courses = array($course->id => 1);
1559 if($course->groupmode != NOGROUPS || !$course->groupmodeforce) {
1560 $allowed->groups = get_groups($SESSION->cal_course_referer);
1566 * see if user can add calendar entries at all
1567 * used to print the "New Event" button
1568 * @return bool
1570 function calendar_user_can_add_event() {
1571 calendar_get_allowed_types($allowed);
1572 return (bool)($allowed->user || $allowed->groups || $allowed->courses || $allowed->site);