Added hooks to qtype import/export
[moodle-linuxchix.git] / calendar / view.php
blob1341b07b3ba3769f25914e290c3ab635beae8f4c
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 // Display the calendar page.
43 require_once('../config.php');
44 require_once($CFG->dirroot.'/course/lib.php');
45 require_once($CFG->dirroot.'/calendar/lib.php');
47 $courseid = optional_param('course', 0, PARAM_INT);
48 $view = optional_param('view', 'upcoming', PARAM_ALPHA);
49 $day = optional_param('cal_d', 0, PARAM_INT);
50 $mon = optional_param('cal_m', 0, PARAM_INT);
51 $yr = optional_param('cal_y', 0, PARAM_INT);
53 if(!$site = get_site()) {
54 redirect($CFG->wwwroot.'/'.$CFG->admin.'/index.php');
57 if ($courseid) {
58 require_login($courseid);
59 } else if ($CFG->forcelogin) {
60 require_login();
63 // Initialize the session variables
64 calendar_session_vars();
66 //add_to_log($course->id, "course", "view", "view.php?id=$course->id", "$course->id");
67 $now = usergetdate(time());
68 $pagetitle = '';
70 $nav = calendar_get_link_tag(get_string('calendar', 'calendar'), CALENDAR_URL.'view.php?view=upcoming&amp;course='.$courseid.'&amp;', $now['mday'], $now['mon'], $now['year']);
73 if(!checkdate($mon, $day, $yr)) {
74 $day = intval($now['mday']);
75 $mon = intval($now['mon']);
76 $yr = intval($now['year']);
78 $time = make_timestamp($yr, $mon, $day);
80 switch($view) {
81 case 'day':
82 $nav .= ' -> '.userdate($time, get_string('strftimedate'));
83 $pagetitle = get_string('dayview', 'calendar');
84 break;
85 case 'month':
86 $nav .= ' -> '.userdate($time, get_string('strftimemonthyear'));
87 $pagetitle = get_string('detailedmonthview', 'calendar');
88 break;
89 case 'upcoming':
90 $pagetitle = get_string('upcomingevents', 'calendar');
91 break;
94 // If a course has been supplied in the URL, change the filters to show that one
95 if (!empty($courseid)) {
96 if ($course = get_record('course', 'id', $courseid)) {
97 if ($course->id == SITEID) {
98 // If coming from the home page, show all courses
99 $SESSION->cal_courses_shown = calendar_get_default_courses(true);
100 calendar_set_referring_course(0);
102 } else {
103 // Otherwise show just this one
104 $SESSION->cal_courses_shown = $course->id;
105 calendar_set_referring_course($SESSION->cal_courses_shown);
108 } else {
109 $course = null;
112 if (empty($USER->id) or isguest()) {
113 $defaultcourses = calendar_get_default_courses();
114 calendar_set_filters($courses, $groups, $users, $defaultcourses, $defaultcourses);
116 } else {
117 calendar_set_filters($courses, $groups, $users);
120 // Let's see if we are supposed to provide a referring course link
121 // but NOT for the "main page" course
122 if ($SESSION->cal_course_referer != SITEID &&
123 ($shortname = get_field('course', 'shortname', 'id', $SESSION->cal_course_referer)) !== false) {
124 // If we know about the referring course, show a return link and ALSO require login!
125 require_login();
126 $nav = '<a href="'.$CFG->wwwroot.'/course/view.php?id='.$SESSION->cal_course_referer.'">'.$shortname.'</a> -> '.$nav;
127 if (empty($course)) {
128 $course = get_record('course', 'id', $SESSION->cal_course_referer); // Useful to have around
132 $strcalendar = get_string('calendar', 'calendar');
133 $prefsbutton = calendar_preferences_button();
135 // Print title and header
136 print_header("$site->shortname: $strcalendar: $pagetitle", $strcalendar, $nav,
137 '', '', true, $prefsbutton, user_login_string($site));
139 echo calendar_overlib_html();
141 // Layout the whole page as three big columns.
142 echo '<table id="calendar" style="height:100%;">';
143 echo '<tr>';
145 // START: Main column
147 echo '<td class="maincalendar">';
148 echo '<div class="heightcontainer">';
150 switch($view) {
151 case 'day':
152 calendar_show_day($day, $mon, $yr, $courses, $groups, $users, $courseid);
153 break;
154 case 'month':
155 calendar_show_month_detailed($mon, $yr, $courses, $groups, $users, $courseid);
156 break;
157 case 'upcoming':
158 calendar_show_upcoming_events($courses, $groups, $users, get_user_preferences('calendar_lookahead', CALENDAR_UPCOMING_DAYS), get_user_preferences('calendar_maxevents', CALENDAR_UPCOMING_MAXEVENTS), $courseid);
159 break;
162 //Link to calendar export page
163 echo '<div class="bottom">';
164 print_single_button('export.php', false, get_string('exportcalendar', 'calendar'));
166 if (!empty($USER->id)) {
167 $authtoken = sha1($USER->username . $USER->password);
168 $usernameencoded = urlencode($USER->username);
170 echo "<a href=\"export_execute.php?preset_what=all&amp;preset_time=recentupcoming&amp;username=$usernameencoded&amp;authtoken=$authtoken\">"
171 .'<img src="'.$CFG->pixpath.'/i/ical.gif" height="14" width="36" '
172 .'alt="'.get_string('ical', 'calendar').'" '
173 .'title="'.get_string('quickdownloadcalendar', 'calendar').'" />'
174 .'</a>';
177 echo '</div>';
178 echo '</div>';
179 echo '</td>';
181 // END: Main column
183 // START: Last column (3-month display)
184 echo '<td class="sidecalendar">';
185 list($prevmon, $prevyr) = calendar_sub_month($mon, $yr);
186 list($nextmon, $nextyr) = calendar_add_month($mon, $yr);
187 $getvars = 'id='.$courseid.'&amp;cal_d='.$day.'&amp;cal_m='.$mon.'&amp;cal_y='.$yr; // For filtering
189 echo '<div class="sideblock">';
190 echo '<div class="header">'.get_string('eventskey', 'calendar').'</div>';
191 echo '<div class="filters">';
192 echo calendar_filter_controls($view, $getvars, NULL, $courses);
193 echo '</div>';
194 echo '</div>';
196 echo '<div class="sideblock">';
197 echo '<div class="header">'.get_string('monthlyview', 'calendar').'</div>';
199 echo '<div class="minicalendarblock minicalendartop">';
200 echo calendar_top_controls('display', array('id' => $courseid, 'm' => $prevmon, 'y' => $prevyr));
201 echo calendar_get_mini($courses, $groups, $users, $prevmon, $prevyr);
202 echo '</div><div class="minicalendarblock">';
203 echo calendar_top_controls('display', array('id' => $courseid, 'm' => $mon, 'y' => $yr));
204 echo calendar_get_mini($courses, $groups, $users, $mon, $yr);
205 echo '</div><div class="minicalendarblock">';
206 echo calendar_top_controls('display', array('id' => $courseid, 'm' => $nextmon, 'y' => $nextyr));
207 echo calendar_get_mini($courses, $groups, $users, $nextmon, $nextyr);
208 echo '</div>';
209 echo '</div>';
211 echo '</td>';
213 echo '</tr></table>';
215 print_footer();
219 function calendar_show_day($d, $m, $y, $courses, $groups, $users, $courseid) {
220 global $CFG, $USER;
222 if (!checkdate($m, $d, $y)) {
223 $now = usergetdate(time());
224 list($d, $m, $y) = array(intval($now['mday']), intval($now['mon']), intval($now['year']));
227 $getvars = 'from=day&amp;cal_d='.$d.'&amp;cal_m='.$m.'&amp;cal_y='.$y; // For filtering
229 $starttime = make_timestamp($y, $m, $d);
230 $endtime = make_timestamp($y, $m, $d + 1) - 1;
232 $events = calendar_get_upcoming($courses, $groups, $users, 1, 100, $starttime);
234 $text = '';
235 if (!isguest() && !empty($USER->id) && calendar_user_can_add_event()) {
236 $text.= '<div class="buttons">';
237 $text.= '<form action="'.CALENDAR_URL.'event.php" method="get">';
238 $text.= '<div>';
239 $text.= '<input type="hidden" name="action" value="new" />';
240 $text.= '<input type="hidden" name="course" value="'.$courseid.'" />';
241 $text.= '<input type="hidden" name="cal_d" value="'.$d.'" />';
242 $text.= '<input type="hidden" name="cal_m" value="'.$m.'" />';
243 $text.= '<input type="hidden" name="cal_y" value="'.$y.'" />';
244 $text.= '<input type="submit" value="'.get_string('newevent', 'calendar').'" />';
245 $text.= '</div></form></div>';
248 $text .= get_string('dayview', 'calendar').': '.calendar_course_filter_selector($getvars);
250 echo '<div class="header">'.$text.'</div>';
252 echo '<div class="controls">'.calendar_top_controls('day', array('id' => $courseid, 'd' => $d, 'm' => $m, 'y' => $y)).'</div>';
254 if (empty($events)) {
255 // There is nothing to display today.
256 echo '<h3>'.get_string('daywithnoevents', 'calendar').'</h3>';
258 } else {
260 echo '<div class="eventlist">';
262 $underway = array();
264 // First, print details about events that start today
265 foreach ($events as $event) {
267 // Set event course class if a course event
268 if($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) {
269 $event->class = 'event_course'.array_search($event->courseid, $courses) % CALENDAR_MAXCOURSES;
271 $event->calendarcourseid = $courseid;
273 if ($event->timestart >= $starttime && $event->timestart <= $endtime) { // Print it now
277 $dayend = calendar_day_representation($event->timestart + $event->timeduration);
278 $timeend = calendar_time_representation($event->timestart + $event->timeduration);
279 $enddate = usergetdate($event->timestart + $event->timeduration);
280 // Set printable representation
281 echo calendar_get_link_tag($dayend, CALENDAR_URL.'view.php?view=day'.$morehref.'&amp;', $enddate['mday'], $enddate['mon'], $enddate['year']).' ('.$timeend.')';
283 //unset($event->time);
285 $event->time = calendar_format_event_time($event, time(), '', false, $starttime);
286 calendar_print_event($event);
288 } else { // Save this for later
289 $underway[] = $event;
293 // Then, show a list of all events that just span this day
294 if (!empty($underway)) {
295 echo '<h3>'.get_string('spanningevents', 'calendar').':</h3>';
296 foreach ($underway as $event) {
297 $event->time = calendar_format_event_time($event, time(), '', false, $starttime);
298 calendar_print_event($event);
302 echo '</div>';
307 function calendar_show_month_detailed($m, $y, $courses, $groups, $users, $courseid) {
308 global $CFG, $SESSION, $USER, $CALENDARDAYS;
309 global $day, $mon, $yr;
311 $getvars = 'from=month&amp;cal_d='.$day.'&amp;cal_m='.$mon.'&amp;cal_y='.$yr; // For filtering
313 $display = &New stdClass;
314 $display->minwday = get_user_preferences('calendar_startwday', CALENDAR_STARTING_WEEKDAY);
315 $display->maxwday = $display->minwday + 6;
317 if(!empty($m) && !empty($y)) {
318 $thisdate = usergetdate(time()); // Time and day at the user's location
319 if($m == $thisdate['mon'] && $y == $thisdate['year']) {
320 // Navigated to this month
321 $date = $thisdate;
322 $display->thismonth = true;
324 else {
325 // Navigated to other month, let's do a nice trick and save us a lot of work...
326 if(!checkdate($m, 1, $y)) {
327 $date = array('mday' => 1, 'mon' => $thisdate['mon'], 'year' => $thisdate['year']);
328 $display->thismonth = true;
330 else {
331 $date = array('mday' => 1, 'mon' => $m, 'year' => $y);
332 $display->thismonth = false;
336 else {
337 $date = usergetdate(time());
338 $display->thismonth = true;
341 // Fill in the variables we 're going to use, nice and tidy
342 list($d, $m, $y) = array($date['mday'], $date['mon'], $date['year']); // This is what we want to display
343 $display->maxdays = calendar_days_in_month($m, $y);
345 $startwday = 0;
346 if (get_user_timezone_offset() < 99) {
347 // We 'll keep these values as GMT here, and offset them when the time comes to query the db
348 $display->tstart = gmmktime(0, 0, 0, $m, 1, $y); // This is GMT
349 $display->tend = gmmktime(23, 59, 59, $m, $display->maxdays, $y); // GMT
350 $startwday = gmdate('w', $display->tstart); // $display->tstart is already GMT, so don't use date(): messes with server's TZ
351 } else {
352 // no timezone info specified
353 $display->tstart = mktime(0, 0, 0, $m, 1, $y);
354 $display->tend = mktime(23, 59, 59, $m, $display->maxdays, $y);
355 $startwday = date('w', $display->tstart); // $display->tstart not necessarily GMT, so use date()
358 // Align the starting weekday to fall in our display range
359 if($startwday < $display->minwday) {
360 $startwday += 7;
363 // Get events from database
364 $whereclause = calendar_sql_where(usertime($display->tstart), usertime($display->tend), $users, $groups, $courses);
365 if($whereclause === false) {
366 $events = array();
368 else {
369 $events = get_records_select('event', $whereclause, 'timestart');
372 // Extract information: events vs. time
373 calendar_events_by_day($events, $m, $y, $eventsbyday, $durationbyday, $typesbyday, $courses);
375 $text = '';
376 if(!isguest() && !empty($USER->id) && calendar_user_can_add_event()) {
377 $text.= '<div class="buttons"><form action="'.CALENDAR_URL.'event.php" method="get">';
378 $text.= '<div>';
379 $text.= '<input type="hidden" name="action" value="new" />';
380 $text.= '<input type="hidden" name="course" value="'.$courseid.'" />';
381 $text.= '<input type="hidden" name="cal_m" value="'.$m.'" />';
382 $text.= '<input type="hidden" name="cal_y" value="'.$y.'" />';
383 $text.= '<input type="submit" value="'.get_string('newevent', 'calendar').'" />';
384 $text.= '</div></form></div>';
387 $text .= get_string('detailedmonthview', 'calendar').': '.calendar_course_filter_selector($getvars);
389 echo '<div class="header">'.$text.'</div>';
391 echo '<div class="controls">';
392 echo calendar_top_controls('month', array('id' => $courseid, 'm' => $m, 'y' => $y));
393 echo '</div>';
395 // Start calendar display
396 echo '<table class="calendarmonth"><tr class="weekdays">'; // Begin table. First row: day names
398 // Print out the names of the weekdays
399 for($i = $display->minwday; $i <= $display->maxwday; ++$i) {
400 // This uses the % operator to get the correct weekday no matter what shift we have
401 // applied to the $display->minwday : $display->maxwday range from the default 0 : 6
402 echo '<th scope="col">'.get_string($CALENDARDAYS[$i % 7], 'calendar').'</th>';
405 echo '</tr><tr>'; // End of day names; prepare for day numbers
407 // For the table display. $week is the row; $dayweek is the column.
408 $week = 1;
409 $dayweek = $startwday;
411 // Paddding (the first week may have blank days in the beginning)
412 for($i = $display->minwday; $i < $startwday; ++$i) {
413 echo '<td class="nottoday">&nbsp;</td>'."\n";
416 // Now display all the calendar
417 for($day = 1; $day <= $display->maxdays; ++$day, ++$dayweek) {
418 if($dayweek > $display->maxwday) {
419 // We need to change week (table row)
420 echo "</tr>\n<tr>";
421 $dayweek = $display->minwday;
422 ++$week;
425 // Reset vars
426 $cell = '';
427 $dayhref = calendar_get_link_href(CALENDAR_URL.'view.php?view=day&amp;course='.$courseid.'&amp;', $day, $m, $y);
429 if(CALENDAR_WEEKEND & (1 << ($dayweek % 7))) {
430 // Weekend. This is true no matter what the exact range is.
431 $class = 'weekend';
433 else {
434 // Normal working day.
435 $class = '';
438 // Special visual fx if an event is defined
439 if(isset($eventsbyday[$day])) {
440 if(count($eventsbyday[$day]) == 1) {
441 $title = get_string('oneevent', 'calendar');
443 else {
444 $title = get_string('manyevents', 'calendar', count($eventsbyday[$day]));
446 $cell = '<div class="day"><a href="'.$dayhref.'" title="'.$title.'">'.$day.'</a></div>';
448 else {
449 $cell = '<div class="day">'.$day.'</div>';
452 // Special visual fx if an event spans many days
453 if(isset($typesbyday[$day]['durationglobal'])) {
454 $class .= ' duration_global';
456 else if(isset($typesbyday[$day]['durationcourse'])) {
457 $class .= ' duration_course';
459 else if(isset($typesbyday[$day]['durationgroup'])) {
460 $class .= ' duration_group';
462 else if(isset($typesbyday[$day]['durationuser'])) {
463 $class .= ' duration_user';
466 // Special visual fx for today
467 if($display->thismonth && $day == $d) {
468 $class .= ' today';
469 } else {
470 $class .= ' nottoday';
473 // Just display it
474 if(!empty($class)) {
475 $class = ' class="'.trim($class).'"';
477 echo '<td'.$class.'>'.$cell;
479 if(isset($eventsbyday[$day])) {
480 echo '<ul class="events-new">';
481 foreach($eventsbyday[$day] as $eventindex) {
483 // If event has a class set then add it to the event <li> tag
484 $eventclass = '';
485 if (!empty($events[$eventindex]->class)) {
486 $eventclass = ' class="'.$events[$eventindex]->class.'"';
489 echo '<li'.$eventclass.'><a href="'.$dayhref.'#event_'.$events[$eventindex]->id.'">'.format_string($events[$eventindex]->name, true).'</a></li>';
491 echo '</ul>';
493 if(isset($durationbyday[$day])) {
494 echo '<ul class="events-underway">';
495 foreach($durationbyday[$day] as $eventindex) {
496 echo '<li>['.format_string($events[$eventindex]->name,true).']</li>';
498 echo '</ul>';
500 echo "</td>\n";
503 // Paddding (the last week may have blank days at the end)
504 for($i = $dayweek; $i <= $display->maxwday; ++$i) {
505 echo '<td class="nottoday">&nbsp;</td>';
507 echo "</tr>\n"; // Last row ends
509 echo "</table>\n"; // Tabular display of days ends
513 function calendar_show_upcoming_events($courses, $groups, $users, $futuredays, $maxevents, $courseid) {
514 global $USER;
516 $events = calendar_get_upcoming($courses, $groups, $users, $futuredays, $maxevents);
518 $text = '';
520 if(!isguest() && !empty($USER->id) && calendar_user_can_add_event()) {
521 $text.= '<div class="buttons">';
522 $text.= '<form action="'.CALENDAR_URL.'event.php" method="get">';
523 $text.= '<div>';
524 $text.= '<input type="hidden" name="action" value="new" />';
525 $text.= '<input type="hidden" name="course" value="'.$courseid.'" />';
527 $text.= '<input type="hidden" name="cal_m" value="'.$m.'" />';
528 $text.= '<input type="hidden" name="cal_y" value="'.$y.'" />';
530 $text.= '<input type="submit" value="'.get_string('newevent', 'calendar').'" />';
531 $text.= '</div></form></div>';
534 $text .= get_string('upcomingevents', 'calendar').': '.calendar_course_filter_selector('from=upcoming');
536 echo '<div class="header">'.$text.'</div>';
538 if ($events) {
540 echo '<div class="eventlist">';
541 foreach ($events as $event) {
543 // Set event course class if a course event
544 if($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) {
545 $event->class = 'event_course'.array_search($event->courseid, $courses) % CALENDAR_MAXCOURSES;
548 calendar_print_event($event);
550 echo '</div>';
551 } else {
552 print_heading(get_string('noupcomingevents', 'calendar'));
556 function calendar_course_filter_selector($getvars = '') {
557 global $USER, $SESSION;
559 if (empty($USER->id) or isguest()) {
560 return '';
563 if (has_capability('moodle/calendar:manageentries', get_context_instance(CONTEXT_SYSTEM, SITEID)) && !empty($CFG->calendar_adminseesall)) {
564 $courses = get_courses('all', 'c.shortname','c.id,c.shortname');
565 } else {
566 $courses = get_my_courses($USER->id, 'shortname');
569 unset($courses[SITEID]);
571 $courseoptions[SITEID] = get_string('fulllistofcourses');
572 foreach ($courses as $course) {
573 $courseoptions[$course->id] = format_string($course->shortname);
576 if (is_numeric($SESSION->cal_courses_shown)) {
577 $selected = $SESSION->cal_courses_shown;
578 } else {
579 $selected = '';
582 return popup_form(CALENDAR_URL.'set.php?var=setcourse&amp;'.$getvars.'&amp;id=',
583 $courseoptions, 'cal_course_flt', $selected, '', '', '', true);