MDL-30731 calendar: Fixed display of images in event descriptions
[moodle.git] / calendar / lib.php
CommitLineData
93c91ee4 1<?php
08b4a4e1
RW
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/>.
7423f116 16
08b4a4e1
RW
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 */
25
26/**
27 * These are read by the administration component to provide default values
28 */
29
30/**
31 * CALENDAR_DEFAULT_UPCOMING_LOOKAHEAD - default value of upcoming event preference
32 */
bb4a2e85 33define('CALENDAR_DEFAULT_UPCOMING_LOOKAHEAD', 21);
08b4a4e1
RW
34
35/**
36 * CALENDAR_DEFAULT_UPCOMING_MAXEVENTS - default value to display the maximum number of upcoming event
37 */
bb4a2e85 38define('CALENDAR_DEFAULT_UPCOMING_MAXEVENTS', 10);
08b4a4e1
RW
39
40/**
41 * CALENDAR_DEFAULT_STARTING_WEEKDAY - default value to display the starting weekday
42 */
43define('CALENDAR_DEFAULT_STARTING_WEEKDAY', 1);
44
bb4a2e85 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
08b4a4e1
RW
47
48/**
49 * CALENDAR_DEFAULT_WEEKEND - default value for weekend (Saturday & Sunday)
50 */
51define('CALENDAR_DEFAULT_WEEKEND', 65);
52
53/**
54 * CALENDAR_URL - path to calendar's folder
55 */
76d9df3f 56define('CALENDAR_URL', $CFG->wwwroot.'/calendar/');
08b4a4e1
RW
57
58/**
59 * CALENDAR_TF_24 - Calendar time in 24 hours format
60 */
76d9df3f 61define('CALENDAR_TF_24', '%H:%M');
08b4a4e1
RW
62
63/**
64 * CALENDAR_TF_12 - Calendar time in 12 hours format
65 */
76d9df3f 66define('CALENDAR_TF_12', '%I:%M %p');
bb4a2e85 67
08b4a4e1
RW
68/**
69 * CALENDAR_EVENT_GLOBAL - Global calendar event types
70 */
797cedc7 71define('CALENDAR_EVENT_GLOBAL', 1);
08b4a4e1
RW
72
73/**
74 * CALENDAR_EVENT_COURSE - Course calendar event types
75 */
797cedc7 76define('CALENDAR_EVENT_COURSE', 2);
08b4a4e1
RW
77
78/**
79 * CALENDAR_EVENT_GROUP - group calendar event types
80 */
797cedc7 81define('CALENDAR_EVENT_GROUP', 4);
08b4a4e1
RW
82
83/**
84 * CALENDAR_EVENT_USER - user calendar event types
85 */
797cedc7
SH
86define('CALENDAR_EVENT_USER', 8);
87
76d9df3f 88/**
08b4a4e1
RW
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()
76d9df3f
SH
94 */
95define('CALENDAR_STARTING_WEEKDAY', CALENDAR_DEFAULT_STARTING_WEEKDAY);
7423f116 96
797cedc7
SH
97/**
98 * Return the days of the week
99 *
08b4a4e1 100 * @return array array of days
797cedc7
SH
101 */
102function calendar_get_days() {
103 return array('sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday');
104}
f2bffd9e 105
76d9df3f
SH
106/**
107 * Gets the first day of the week
108 *
109 * Used to be define('CALENDAR_STARTING_WEEKDAY', blah);
110 *
111 * @return int
112 */
113function calendar_get_starting_weekday() {
114 global $CFG;
37d87d11 115
76d9df3f
SH
116 if (isset($CFG->calendar_startwday)) {
117 $firstday = $CFG->calendar_startwday;
118 } else {
0a933ae6 119 $firstday = get_string('firstdayofweek', 'langconfig');
76d9df3f
SH
120 }
121
122 if(!is_numeric($firstday)) {
123 return CALENDAR_DEFAULT_STARTING_WEEKDAY;
124 } else {
125 return intval($firstday) % 7;
126 }
127}
bd119567 128
0f927f1e 129/**
14236cbd 130 * Generates the HTML for a miniature calendar
0f927f1e 131 *
08b4a4e1
RW
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
0f927f1e 138 */
7423f116 139function calendar_get_mini($courses, $groups, $users, $cal_month = false, $cal_year = false) {
6b608f8f 140 global $CFG, $USER, $OUTPUT;
7423f116 141
dd97c328 142 $display = new stdClass;
76d9df3f 143 $display->minwday = get_user_preferences('calendar_startwday', calendar_get_starting_weekday());
7423f116 144 $display->maxwday = $display->minwday + 6;
145
146 $content = '';
147
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;
36dc3b71 154 } else {
7423f116 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;
36dc3b71 159 } else {
7423f116 160 $date = array('mday' => 1, 'mon' => $cal_month, 'year' => $cal_year);
161 $display->thismonth = false;
162 }
163 }
36dc3b71 164 } else {
7423f116 165 $date = usergetdate(time()); // Date and time the user sees at his location
166 $display->thismonth = true;
167 }
168
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);
172
d6198903 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
61240489 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
d6198903 177 } else {
178 // no timezone info specified
61240489 179 $display->tstart = mktime(0, 0, 0, $m, 1, $y);
180 $display->tend = mktime(23, 59, 59, $m, $display->maxdays, $y);
d6198903 181 }
7423f116 182
69244b91 183 $startwday = dayofweek(1, $m, $y);
7423f116 184
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 }
190
c0b507d1 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:
1747ee05 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 //}
c0b507d1 203
204
7423f116 205 // Get the events matching our criteria. Don't forget to offset the timestamps for the user's TZ!
8263f802 206 $events = calendar_get_events(
d3555a2f 207 usertime($display->tstart) - dst_offset_on($display->tstart),
208 usertime($display->tend) - dst_offset_on($display->tend),
209 $users, $groups, $courses);
7423f116 210
b4892fa2 211 // Set event course class for course events
212 if (!empty($events)) {
13534ef7 213 foreach ($events as $eventid => $event) {
13534ef7
ML
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 }
b4892fa2 220 }
221 }
6619eba4 222
c635dcda 223 // This is either a genius idea or an idiot idea: in order to not complicate things, we use this rule: if, after
9064751b 224 // possibly removing SITEID from $courses, there is only one course left, then clicking on a day in the month
c635dcda 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.
227
0f927f1e 228 $hrefparams = array();
7bd1677c 229 if(!empty($courses)) {
e749554e 230 $courses = array_diff($courses, array(SITEID));
7bd1677c 231 if(count($courses) == 1) {
0f927f1e 232 $hrefparams['course'] = reset($courses);
7bd1677c 233 }
c635dcda 234 }
235
7423f116 236 // We want to have easy access by day, since the display is on a per-day basis.
237 // Arguments passed by reference.
7b38bfa6 238 //calendar_events_by_day($events, $display->tstart, $eventsbyday, $durationbyday, $typesbyday);
7c50db30 239 calendar_events_by_day($events, $m, $y, $eventsbyday, $durationbyday, $typesbyday, $courses);
7423f116 240
f20c4d02 241 //Accessibility: added summary and <abbr> elements.
797cedc7 242 $days_title = calendar_get_days();
f20c4d02 243
2a06efcc 244 $summary = get_string('calendarheading', 'calendar', userdate(make_timestamp($y, $m), get_string('strftimemonthyear')));
90723839 245 $content .= '<table class="minicalendar calendartable" summary="'.$summary.'">'; // Begin table
f136e4c5 246 $content .= '<tr class="weekdays">'; // Header row: day names
7423f116 247
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
f20c4d02 253 $content .= '<th scope="col"><abbr title="'. get_string($days_title[$i % 7], 'calendar') .'">'.
254 get_string($days[$i % 7], 'calendar') ."</abbr></th>\n";
7423f116 255 }
256
f136e4c5 257 $content .= '</tr><tr>'; // End of day names; prepare for day numbers
7423f116 258
259 // For the table display. $week is the row; $dayweek is the column.
7423f116 260 $dayweek = $startwday;
261
262 // Paddding (the first week may have blank days in the beginning)
263 for($i = $display->minwday; $i < $startwday; ++$i) {
3bfd8bc8 264 $content .= '<td class="dayblank">&nbsp;</td>'."\n";
7423f116 265 }
266
797cedc7
SH
267 $weekend = CALENDAR_DEFAULT_WEEKEND;
268 if (isset($CFG->calendar_weekend)) {
269 $weekend = intval($CFG->calendar_weekend);
270 }
271
7423f116 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)
d56d4e23 276 $content .= '</tr><tr>';
7423f116 277 $dayweek = $display->minwday;
7423f116 278 }
92668ad2 279
7423f116 280 // Reset vars
7423f116 281 $cell = '';
797cedc7 282 if ($weekend & (1 << ($dayweek % 7))) {
7423f116 283 // Weekend. This is true no matter what the exact range is.
e2aa618b 284 $class = 'weekend day';
90723839 285 } else {
7423f116 286 // Normal working day.
e2aa618b 287 $class = 'day';
7423f116 288 }
289
290 // Special visual fx if an event is defined
291 if(isset($eventsbyday[$day])) {
90723839 292 $class .= ' hasevent';
0f927f1e
SH
293 $hrefparams['view'] = 'day';
294 $dayhref = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', $hrefparams), $day, $m, $y);
f434283f 295
7423f116 296 $popupcontent = '';
297 foreach($eventsbyday[$day] as $eventid) {
41d30a8e 298 if (!isset($events[$eventid])) {
299 continue;
4e17c6f3 300 }
41d30a8e 301 $event = $events[$eventid];
0f927f1e
SH
302 $popupalt = '';
303 $component = 'moodle';
41d30a8e 304 if(!empty($event->modulename)) {
0f927f1e 305 $popupicon = 'icon';
41d30a8e 306 $popupalt = $event->modulename;
0f927f1e 307 $component = $event->modulename;
9064751b 308 } else if ($event->courseid == SITEID) { // Site event
0f927f1e 309 $popupicon = 'c/site';
c3d3b6d4 310 } else if ($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) { // Course event
0f927f1e 311 $popupicon = 'c/course';
41d30a8e 312 } else if ($event->groupid) { // Group event
0f927f1e 313 $popupicon = 'c/group';
41d30a8e 314 } else if ($event->userid) { // User event
0f927f1e 315 $popupicon = 'c/user';
4e17c6f3 316 }
1d5bd3d2 317
0f927f1e 318 $dayhref->set_anchor('event_'.$event->id);
1d5bd3d2 319
0f927f1e 320 $popupcontent .= html_writer::start_tag('div');
adc3cfc7 321 $popupcontent .= $OUTPUT->pix_icon($popupicon, $popupalt, $component);
0f927f1e
SH
322 $popupcontent .= html_writer::link($dayhref, format_string($event->name, true));
323 $popupcontent .= html_writer::end_tag('div');
7423f116 324 }
e295df44 325
b5c42e70 326 //Accessibility: functionality moved to calendar_get_popup.
327 if($display->thismonth && $day == $d) {
450a0a7d 328 $popup = calendar_get_popup(true, $events[$eventid]->timestart, $popupcontent);
b5c42e70 329 } else {
450a0a7d 330 $popup = calendar_get_popup(false, $events[$eventid]->timestart, $popupcontent);
e295df44 331 }
f20c4d02 332
7423f116 333 // Class and cell content
334 if(isset($typesbyday[$day]['startglobal'])) {
90723839
SH
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';
7423f116 342 }
0f927f1e 343 $cell = '<a href="'.(string)$dayhref.'" '.$popup.'>'.$day.'</a>';
90723839 344 } else {
05fcc5fd 345 $cell = $day;
7423f116 346 }
347
90723839
SH
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';
7423f116 357 }
90723839
SH
358 if ($durationclass) {
359 $class .= ' duration '.$durationclass;
7423f116 360 }
361
b4892fa2 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 }
376
7423f116 377 // Special visual fx for today
450a0a7d 378 //Accessibility: hidden text for today, and popup.
7423f116 379 if($display->thismonth && $day == $d) {
edbe6c1b 380 $class .= ' today';
b5c42e70 381 $today = get_string('today', 'calendar').' '.userdate(time(), get_string('strftimedayshort'));
e295df44 382
b5c42e70 383 if(! isset($eventsbyday[$day])) {
450a0a7d 384 $class .= ' eventnone';
385 $popup = calendar_get_popup(true, false);
386 $cell = '<a href="#" '.$popup.'>'.$day.'</a>';
b5c42e70 387 }
f79f2494 388 $cell = get_accesshide($today.' ').$cell;
7423f116 389 }
390
391 // Just display it
92668ad2 392 if(!empty($class)) {
d56d4e23 393 $class = ' class="'.$class.'"';
92668ad2 394 }
395 $content .= '<td'.$class.'>'.$cell."</td>\n";
7423f116 396 }
397
398 // Paddding (the last week may have blank days at the end)
399 for($i = $dayweek; $i <= $display->maxwday; ++$i) {
3bfd8bc8 400 $content .= '<td class="dayblank">&nbsp;</td>';
7423f116 401 }
402 $content .= '</tr>'; // Last row ends
403
f136e4c5 404 $content .= '</table>'; // Tabular display of days ends
7423f116 405
406 return $content;
407}
408
b5c42e70 409/**
08b4a4e1
RW
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
b5c42e70 419 */
420function calendar_get_popup($is_today, $event_timestart, $popupcontent='') {
458eb0d1 421 global $PAGE;
422 static $popupcount;
423 if ($popupcount === null) {
424 $popupcount = 1;
425 }
b5c42e70 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');
450a0a7d 433
b5c42e70 434 } else {
435 $popupcaption .= get_string('eventsfor', 'calendar', userdate($event_timestart, get_string('strftimedayshort')));
436 }
458eb0d1 437 $id = 'calendar_tooltip_'.$popupcount;
33e48a1a 438 $PAGE->requires->yui_module('moodle-calendar-eventmanager', 'M.core_calendar.add_event', array(array('eventId'=>$id,'title'=>$popupcaption, 'content'=>$popupcontent)));
bdbae764 439
458eb0d1 440 $popupcount++;
441 return 'id="'.$id.'"';
b5c42e70 442}
443
08b4a4e1
RW
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 */
9958a08c 455function calendar_get_upcoming($courses, $groups, $users, $daysinfuture, $maxevents, $fromtime=0) {
62d11d77 456 global $CFG, $COURSE, $DB;
7423f116 457
dd97c328 458 $display = new stdClass;
7423f116 459 $display->range = $daysinfuture; // How many days in the future we 'll look
460 $display->maxevents = $maxevents;
461
462 $output = array();
463
464 // Prepare "course caching", since it may save us a lot of queries
465 $coursecache = array();
466
467 $processed = 0;
468 $now = time(); // We 'll need this later
9d567178 469 $usermidnighttoday = usergetmidnight($now);
7423f116 470
9958a08c 471 if ($fromtime) {
472 $display->tstart = $fromtime;
473 } else {
9d567178 474 $display->tstart = $usermidnighttoday;
9958a08c 475 }
7423f116 476
1f473774 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;
7423f116 480
481 // Get the events matching our criteria
8263f802 482 $events = calendar_get_events($display->tstart, $display->tend, $users, $groups, $courses);
7423f116 483
c635dcda 484 // This is either a genius idea or an idiot idea: in order to not complicate things, we use this rule: if, after
9064751b 485 // possibly removing SITEID from $courses, there is only one course left, then clicking on a day in the month
c635dcda 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.
488
0f927f1e 489 $hrefparams = array();
7bd1677c 490 if(!empty($courses)) {
e749554e 491 $courses = array_diff($courses, array(SITEID));
7bd1677c 492 if(count($courses) == 1) {
0f927f1e 493 $hrefparams['course'] = reset($courses);
7bd1677c 494 }
c635dcda 495 }
496
dd97c328 497 if ($events !== false) {
498
f20edd52 499 $modinfo = get_fast_modinfo($COURSE);
fa22fd5f 500
7423f116 501 foreach($events as $event) {
dc6cb74e 502
dd97c328 503
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)) {
dc6cb74e 514 continue;
515 }
dd97c328 516 if (!coursemodule_visible_for_user($cm)) {
dc6cb74e 517 continue;
518 }
dd97c328 519 }
520 if ($event->modulename == 'assignment'){
f4700b91
RW
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);
dd97c328 524 // TODO: rewrite this hack somehow
f4700b91 525 if (!calendar_edit_event_allowed($checkevent)){ // cannot manage entries, eg. student
62d11d77 526 if (!$assignment = $DB->get_record('assignment', array('id'=>$event->instance))) {
f581f8d6 527 // print_error("invalidid", 'assignment');
dd97c328 528 continue;
529 }
530 // assign assignment to assignment object to use hidden_is_hidden method
531 require_once($CFG->dirroot.'/mod/assignment/lib.php');
532
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');
537
538 $assignmentclass = 'assignment_'.$assignment->assignmenttype;
539 $assignmentinstance = new $assignmentclass($cm->id, $assignment, $cm);
540
541 if ($assignmentinstance->description_is_hidden()){//force not to show description before availability
542 $event->description = get_string('notavailableyet', 'assignment');
543 }
dc6cb74e 544 }
545 }
546 }
9d567178 547
dd97c328 548 if ($processed >= $display->maxevents) {
9d567178 549 break;
550 }
7423f116 551
0f927f1e 552 $event->time = calendar_format_event_time($event, $now, $hrefparams);
3c134875 553 $output[] = $event;
554 ++$processed;
555 }
556 }
557 return $output;
558}
7423f116 559
08b4a4e1
RW
560/**
561 * Add calendar event metadata
562 *
563 * @param stdClass $event event info
564 * @return stdClass $event metadata
565 */
9df8ff44 566function calendar_add_event_metadata($event) {
6b608f8f 567 global $CFG, $OUTPUT;
fb73f3b3 568
e295df44 569 //Support multilang in event->name
fb73f3b3 570 $event->name = format_string($event->name,true);
e295df44 571
3c134875 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);
7423f116 577
3c134875 578 if ($module === false) {
579 return;
580 }
9958a08c 581
3c134875 582 $modulename = get_string('modulename', $event->modulename);
a48bf079
DM
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 }
b5d0cafc 589 $icon = $OUTPUT->pix_url('icon', $event->modulename) . '';
9958a08c 590
91d284c1
SH
591 $context = get_context_instance(CONTEXT_COURSE, $module->course);
592 $fullname = format_string($coursecache[$module->course]->fullname, true, array('context' => $context));
593
10daca92 594 $event->icon = '<img height="16" width="16" src="'.$icon.'" alt="'.$eventtype.'" title="'.$modulename.'" style="vertical-align: middle;" />';
fb73f3b3 595 $event->referer = '<a href="'.$CFG->wwwroot.'/mod/'.$event->modulename.'/view.php?id='.$module->id.'">'.$event->name.'</a>';
91d284c1 596 $event->courselink = '<a href="'.$CFG->wwwroot.'/course/view.php?id='.$module->course.'">'.$fullname.'</a>';
3c134875 597 $event->cmid = $module->id;
9958a08c 598
9958a08c 599
3c134875 600 } else if($event->courseid == SITEID) { // Site event
b5d0cafc 601 $event->icon = '<img height="16" width="16" src="'.$OUTPUT->pix_url('c/site') . '" alt="'.get_string('globalevent', 'calendar').'" style="vertical-align: middle;" />';
90723839 602 $event->cssclass = 'calendar_event_global';
3c134875 603 } else if($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) { // Course event
604 calendar_get_course_cached($coursecache, $event->courseid);
91d284c1
SH
605
606 $context = get_context_instance(CONTEXT_COURSE, $event->courseid);
607 $fullname = format_string($coursecache[$event->courseid]->fullname, true, array('context' => $context));
608
b5d0cafc 609 $event->icon = '<img height="16" width="16" src="'.$OUTPUT->pix_url('c/course') . '" alt="'.get_string('courseevent', 'calendar').'" style="vertical-align: middle;" />';
91d284c1 610 $event->courselink = '<a href="'.$CFG->wwwroot.'/course/view.php?id='.$event->courseid.'">'.$fullname.'</a>';
90723839 611 $event->cssclass = 'calendar_event_course';
3c134875 612 } else if ($event->groupid) { // Group event
b5d0cafc 613 $event->icon = '<img height="16" width="16" src="'.$OUTPUT->pix_url('c/group') . '" alt="'.get_string('groupevent', 'calendar').'" style="vertical-align: middle;" />';
90723839 614 $event->cssclass = 'calendar_event_group';
3c134875 615 } else if($event->userid) { // User event
b5d0cafc 616 $event->icon = '<img height="16" width="16" src="'.$OUTPUT->pix_url('c/user') . '" alt="'.get_string('userevent', 'calendar').'" style="vertical-align: middle;" />';
90723839 617 $event->cssclass = 'calendar_event_user';
3c134875 618 }
9df8ff44 619 return $event;
e295df44 620}
9df8ff44 621
8263f802 622/**
623 * Get calendar events
08b4a4e1 624 *
8263f802 625 * @param int $tstart Start time of time range for events
08b4a4e1
RW
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
8263f802 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
08b4a4e1 633 * @return array $events of selected events or an empty array if there aren't any (or there was an error)
8263f802 634 */
635function calendar_get_events($tstart, $tend, $users, $groups, $courses, $withduration=true, $ignorehidden=true) {
62d11d77 636 global $DB;
637
7423f116 638 $whereclause = '';
639 // Quick test
640 if(is_bool($users) && is_bool($groups) && is_bool($courses)) {
8263f802 641 return array();
7423f116 642 }
482dbe0c 643
7423f116 644 if(is_array($users) && !empty($users)) {
645 // Events from a number of users
646 if(!empty($whereclause)) $whereclause .= ' OR';
6e957c41 647 $whereclause .= ' (userid IN ('.implode(',', $users).') AND courseid = 0 AND groupid = 0)';
36dc3b71 648 } else if(is_numeric($users)) {
7423f116 649 // Events from one user
650 if(!empty($whereclause)) $whereclause .= ' OR';
6e957c41 651 $whereclause .= ' (userid = '.$users.' AND courseid = 0 AND groupid = 0)';
36dc3b71 652 } else if($users === true) {
7423f116 653 // Events from ALL users
654 if(!empty($whereclause)) $whereclause .= ' OR';
6e957c41 655 $whereclause .= ' (userid != 0 AND courseid = 0 AND groupid = 0)';
36dc3b71 656 } else if($users === false) {
6e957c41 657 // No user at all, do nothing
f52f7413 658 }
482dbe0c 659
7423f116 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).')';
36dc3b71 664 } else if(is_numeric($groups)) {
7423f116 665 // Events from one group
666 if(!empty($whereclause)) $whereclause .= ' OR ';
667 $whereclause .= ' groupid = '.$groups;
36dc3b71 668 } else if($groups === true) {
7423f116 669 // Events from ALL groups
670 if(!empty($whereclause)) $whereclause .= ' OR ';
671 $whereclause .= ' groupid != 0';
672 }
482dbe0c 673 // boolean false (no groups at all): we don't need to do anything
674
36dc3b71
SH
675 if(is_array($courses) && !empty($courses)) {
676 if(!empty($whereclause)) {
677 $whereclause .= ' OR';
f52f7413 678 }
36dc3b71
SH
679 $whereclause .= ' (groupid = 0 AND courseid IN ('.implode(',', $courses).'))';
680 } else if(is_numeric($courses)) {
7423f116 681 // One course
682 if(!empty($whereclause)) $whereclause .= ' OR';
6e957c41 683 $whereclause .= ' (groupid = 0 AND courseid = '.$courses.')';
36dc3b71 684 } else if ($courses === true) {
7423f116 685 // Events from ALL courses
686 if(!empty($whereclause)) $whereclause .= ' OR';
6e957c41 687 $whereclause .= ' (groupid = 0 AND courseid != 0)';
7423f116 688 }
8c165fe9 689
482dbe0c 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)) {
8263f802 695 return array();
482dbe0c 696 }
697
7423f116 698 if($withduration) {
b4892fa2 699 $timeclause = '(timestart >= '.$tstart.' OR timestart + timeduration > '.$tstart.') AND timestart <= '.$tend;
7423f116 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 }
f52f7413 712
0ad072de 713 if ($ignorehidden) {
714 $whereclause .= ' AND visible = 1';
715 }
716
62d11d77 717 $events = $DB->get_records_select('event', $whereclause, null, 'timestart');
8263f802 718 if ($events === false) {
719 $events = array();
720 }
721 return $events;
7423f116 722}
723
08b4a4e1
RW
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 */
7423f116 731function calendar_top_controls($type, $data) {
797cedc7 732 global $CFG;
7423f116 733 $content = '';
734 if(!isset($data['d'])) {
735 $data['d'] = 1;
736 }
5147ad48 737
f21ed0f3 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 }
744
5147ad48 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);
e295df44 752
7423f116 753 $data['m'] = $date['mon'];
754 $data['y'] = $date['year'];
7423f116 755
2a06efcc 756 //Accessibility: calendar block controls, replaced <table> with <div>.
a84dea2c 757 //$nexttext = link_arrow_right(get_string('monthnext', 'access'), $url='', $accesshide=true);
758 //$prevtext = link_arrow_left(get_string('monthprev', 'access'), $url='', $accesshide=true);
2a06efcc 759
7423f116 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']);
a84dea2c 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);
ae53bd1d 766
0f927f1e
SH
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 }
771
43c90b9b 772 if (right_to_left()) {
0f927f1e
SH
773 $left = $nextlink;
774 $right = $prevlink;
43c90b9b 775 } else {
0f927f1e
SH
776 $left = $prevlink;
777 $right = $nextlink;
43c90b9b 778 }
ae53bd1d 779
0f927f1e
SH
780 $content .= html_writer::start_tag('div', array('class'=>'calendar-controls'));
781 $content .= $left.'<span class="hide"> | </span>';
e71e340d 782 $content .= html_writer::tag('span', html_writer::link($calendarlink, userdate($time, get_string('strftimemonthyear')), array('title'=>get_string('monththis','calendar'))), array('class'=>'current'));
0f927f1e 783 $content .= '<span class="hide"> | </span>'. $right;
6694ff84 784 $content .= "<span class=\"clearer\"><!-- --></span>\n";
0f927f1e
SH
785 $content .= html_writer::end_tag('div');
786
787 break;
7423f116 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']);
a84dea2c 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);
0f927f1e
SH
793
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 }
798
799 if (right_to_left()) {
800 $left = $nextlink;
801 $right = $prevlink;
802 } else {
803 $left = $prevlink;
804 $right = $nextlink;
805 }
806
807 $content .= html_writer::start_tag('div', array('class'=>'calendar-controls'));
808 $content .= $left.'<span class="hide"> | </span>';
e71e340d 809 $content .= html_writer::tag('span', html_writer::link($calendarlink, userdate($time, get_string('strftimemonthyear')), array('title'=>get_string('monththis','calendar'))), array('class'=>'current'));
0f927f1e
SH
810 $content .= '<span class="hide"> | </span>'. $right;
811 $content .= "<span class=\"clearer\"><!-- --></span>";
812 $content .= html_writer::end_tag('div');
813 break;
7423f116 814 case 'upcoming':
0f927f1e
SH
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;
7423f116 822 case 'display':
0f927f1e
SH
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;
7423f116 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']);
5147ad48 833 $prevdate = make_timestamp($prevyear, $prevmonth, 1);
834 $nextdate = make_timestamp($nextyear, $nextmonth, 1);
0f927f1e
SH
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);
837
838 if (right_to_left()) {
839 $left = $nextlink;
840 $right = $prevlink;
841 } else {
842 $left = $prevlink;
843 $right = $nextlink;
844 }
845
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;
7423f116 852 case 'day':
797cedc7 853 $days = calendar_get_days();
7423f116 854 $data['d'] = $date['mday']; // Just for convenience
5147ad48 855 $prevdate = usergetdate(make_timestamp($data['y'], $data['m'], $data['d'] - 1));
856 $nextdate = usergetdate(make_timestamp($data['y'], $data['m'], $data['d'] + 1));
797cedc7
SH
857 $prevname = calendar_wday_name($days[$prevdate['wday']]);
858 $nextname = calendar_wday_name($days[$nextdate['wday']]);
0f927f1e
SH
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']);
861
862 if (right_to_left()) {
863 $left = $nextlink;
864 $right = $prevlink;
865 } else {
866 $left = $prevlink;
867 $right = $nextlink;
868 }
869
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";
876
877 break;
7423f116 878 }
879 return $content;
880}
881
08b4a4e1
RW
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 */
797cedc7
SH
890function calendar_filter_controls(moodle_url $returnurl) {
891 global $CFG, $USER, $OUTPUT;
7423f116 892
48f508ab 893 $groupevents = true;
e295df44 894
7f4d18fc 895 $id = optional_param( 'id',0,PARAM_INT );
d715f7c4 896
eb59a448 897 $seturl = new moodle_url('/calendar/set.php', array('return' => base64_encode($returnurl->out(false)), 'sesskey'=>sesskey()));
7423f116 898
2ad2cbc3 899 $content = '<table>';
48f508ab 900 $content .= '<tr>';
797cedc7
SH
901
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";
fdbffa54 906 } else {
797cedc7
SH
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";
48f508ab 909 }
aa6c1ced 910
797cedc7
SH
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";
e3bb6401 918 }
48f508ab 919
4f0c2d00 920 if (isloggedin() && !isguestuser()) {
e3bb6401 921 $content .= "</tr>\n<tr>";
10b1d598 922
797cedc7 923 if ($groupevents) {
43c3ffbe 924 // This course MIGHT have group events defined, so show the filter
797cedc7
SH
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";
e3bb6401 929 } else {
797cedc7
SH
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";
43c3ffbe 932 }
e3bb6401 933 } else {
43c3ffbe 934 // This course CANNOT have group events, so lose the filter
5c53988f 935 $content .= '<td style="width: 11px;"></td><td>&nbsp;</td>'."\n";
fdbffa54 936 }
797cedc7
SH
937
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";
fdbffa54 942 } else {
797cedc7
SH
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";
48f508ab 945 }
946 }
947 $content .= "</tr>\n</table>\n";
948
7423f116 949 return $content;
950}
951
08b4a4e1
RW
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 */
7423f116 960function calendar_day_representation($tstamp, $now = false, $usecommonwords = true) {
961
0ef7c973 962 static $shortformat;
963 if(empty($shortformat)) {
e70fdac0 964 $shortformat = get_string('strftimedayshort');
0ef7c973 965 }
966
7423f116 967 if($now === false) {
968 $now = time();
969 }
970
971 // To have it in one place, if a change is needed
e70fdac0 972 $formal = userdate($tstamp, $shortformat);
7423f116 973
7b38bfa6 974 $datestamp = usergetdate($tstamp);
975 $datenow = usergetdate($now);
7423f116 976
977 if($usecommonwords == false) {
978 // We don't want words, just a date
979 return $formal;
980 }
7b38bfa6 981 else if($datestamp['year'] == $datenow['year'] && $datestamp['yday'] == $datenow['yday']) {
7423f116 982 // Today
983 return get_string('today', 'calendar');
984 }
7b38bfa6 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 ) {
7423f116 989 // Yesterday
990 return get_string('yesterday', 'calendar');
991 }
7b38bfa6 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 ) {
7423f116 996 // Tomorrow
997 return get_string('tomorrow', 'calendar');
998 }
999 else {
1000 return $formal;
1001 }
1002}
1003
08b4a4e1
RW
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 */
7423f116 1010function calendar_time_representation($time) {
1b0ebe79 1011 static $langtimeformat = NULL;
1012 if($langtimeformat === NULL) {
1013 $langtimeformat = get_string('strftimetime');
1014 }
1015 $timeformat = get_user_preferences('calendar_timeformat');
c7dd2550 1016 if(empty($timeformat)){
1017 $timeformat = get_config(NULL,'calendar_site_timeformat');
1018 }
1b0ebe79 1019 // The ? is needed because the preference might be present, but empty
1020 return userdate($time, empty($timeformat) ? $langtimeformat : $timeformat);
7423f116 1021}
1022
e295df44 1023/**
14236cbd
SH
1024 * Adds day, month, year arguments to a URL and returns a moodle_url object.
1025 *
1026 * @param string|moodle_url $linkbase
08b4a4e1
RW
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
e295df44 1031 */
7423f116 1032function calendar_get_link_href($linkbase, $d, $m, $y) {
0f927f1e
SH
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;
7423f116 1049}
1050
a84dea2c 1051/**
1052 * Build and return a previous month HTML link, with an arrow.
14236cbd 1053 *
a84dea2c 1054 * @param string $text The text label.
14236cbd 1055 * @param string|moodle_url $linkbase The URL stub.
08b4a4e1
RW
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.
a84dea2c 1059 * @param bool $accesshide Default visible, or hide from all except screenreaders.
1060 * @return string HTML string.
1061 */
1062function calendar_get_link_previous($text, $linkbase, $d, $m, $y, $accesshide=false) {
0f927f1e
SH
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');
a84dea2c 1068}
1069
1070/**
1071 * Build and return a next month HTML link, with an arrow.
1d5bd3d2 1072 *
a84dea2c 1073 * @param string $text The text label.
14236cbd 1074 * @param string|moodle_url $linkbase The URL stub.
08b4a4e1
RW
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.
a84dea2c 1078 * @param bool $accesshide Default visible, or hide from all except screenreaders.
1079 * @return string HTML string.
1080 */
1081function calendar_get_link_next($text, $linkbase, $d, $m, $y, $accesshide=false) {
0f927f1e
SH
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');
a84dea2c 1087}
1088
08b4a4e1
RW
1089/**
1090 * Return the name of the weekday
1091 *
1092 * @param string $englishname
1093 * @return string of the weekeday
1094 */
7423f116 1095function calendar_wday_name($englishname) {
1096 return get_string(strtolower($englishname), 'calendar');
1097}
1098
08b4a4e1
RW
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 */
7423f116 1106function calendar_days_in_month($month, $year) {
7b38bfa6 1107 return intval(date('t', mktime(0, 0, 0, $month, 1, $year)));
7423f116 1108}
1109
08b4a4e1
RW
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 */
6605ff8c 1117function calendar_get_block_upcoming($events, $linkhref = NULL) {
7423f116 1118 $content = '';
1119 $lines = count($events);
396b61f0 1120 if (!$lines) {
1121 return $content;
1122 }
7423f116 1123
396b61f0 1124 for ($i = 0; $i < $lines; ++$i) {
b0ac9180 1125 if (!isset($events[$i]->time)) { // Just for robustness
1126 continue;
1127 }
9df8ff44 1128 $events[$i] = calendar_add_event_metadata($events[$i]);
ea21c1f4 1129 $content .= '<div class="event"><span class="icon c0">'.$events[$i]->icon.'</span> ';
43c3ffbe 1130 if (!empty($events[$i]->referer)) {
7423f116 1131 // That's an activity event, so let's provide the hyperlink
396b61f0 1132 $content .= $events[$i]->referer;
1133 } else {
e749554e 1134 if(!empty($linkhref)) {
1135 $ed = usergetdate($events[$i]->timestart);
0f927f1e
SH
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);
e749554e 1139 }
1140 else {
1141 $content .= $events[$i]->name;
1142 }
7423f116 1143 }
9ecf051d 1144 $events[$i]->time = str_replace('&raquo;', '<br />&raquo;', $events[$i]->time);
1145 $content .= '<div class="date">'.$events[$i]->time.'</div></div>';
396b61f0 1146 if ($i < $lines - 1) $content .= '<hr />';
7423f116 1147 }
1148
1149 return $content;
7423f116 1150}
1151
08b4a4e1
RW
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 */
7423f116 1162function 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 }
1169}
1170
08b4a4e1
RW
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 */
7423f116 1180function 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 }
1187}
1188
08b4a4e1
RW
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 */
7c50db30 1201function calendar_events_by_day($events, $month, $year, &$eventsbyday, &$durationbyday, &$typesbyday, &$courses) {
7423f116 1202 $eventsbyday = array();
1203 $typesbyday = array();
1204 $durationbyday = array();
1205
1206 if($events === false) {
1207 return;
1208 }
1209
7423f116 1210 foreach($events as $event) {
7423f116 1211
7b38bfa6 1212 $startdate = usergetdate($event->timestart);
b4892fa2 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 }
7423f116 1219
7b38bfa6 1220 // Simple arithmetic: $year * 13 + $month is a distinct integer for each distinct ($year, $month) pair
ef618501 1221 if(!($startdate['year'] * 13 + $startdate['mon'] <= $year * 13 + $month) && ($enddate['year'] * 13 + $enddate['mon'] >= $year * 13 + $month)) {
7b38bfa6 1222 // Out of bounds
1223 continue;
7423f116 1224 }
1225
7b38bfa6 1226 $eventdaystart = intval($startdate['mday']);
7423f116 1227
7b38bfa6 1228 if($startdate['mon'] == $month && $startdate['year'] == $year) {
1229 // Give the event to its day
1230 $eventsbyday[$eventdaystart][] = $event->id;
7423f116 1231
7b38bfa6 1232 // Mark the day as having such an event
9064751b 1233 if($event->courseid == SITEID && $event->groupid == 0) {
7b38bfa6 1234 $typesbyday[$eventdaystart]['startglobal'] = true;
b4892fa2 1235 // Set event class for global event
90723839 1236 $events[$event->id]->class = 'calendar_event_global';
7b38bfa6 1237 }
c3d3b6d4 1238 else if($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) {
7b38bfa6 1239 $typesbyday[$eventdaystart]['startcourse'] = true;
b4892fa2 1240 // Set event class for course event
90723839 1241 $events[$event->id]->class = 'calendar_event_course';
7b38bfa6 1242 }
1243 else if($event->groupid) {
1244 $typesbyday[$eventdaystart]['startgroup'] = true;
b4892fa2 1245 // Set event class for group event
90723839 1246 $events[$event->id]->class = 'calendar_event_group';
7b38bfa6 1247 }
1248 else if($event->userid) {
1249 $typesbyday[$eventdaystart]['startuser'] = true;
b4892fa2 1250 // Set event class for user event
90723839 1251 $events[$event->id]->class = 'calendar_event_user';
7b38bfa6 1252 }
1253 }
7423f116 1254
7b38bfa6 1255 if($event->timeduration == 0) {
1256 // Proceed with the next
1257 continue;
1258 }
7423f116 1259
7b38bfa6 1260 // The event starts on $month $year or before. So...
ef618501 1261 $lowerbound = $startdate['mon'] == $month && $startdate['year'] == $year ? intval($startdate['mday']) : 0;
7b38bfa6 1262
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);
1265
1266 // Mark all days between $lowerbound and $upperbound (inclusive) as duration
1267 for($i = $lowerbound + 1; $i <= $upperbound; ++$i) {
1268 $durationbyday[$i][] = $event->id;
9064751b 1269 if($event->courseid == SITEID && $event->groupid == 0) {
7b38bfa6 1270 $typesbyday[$i]['durationglobal'] = true;
1271 }
c3d3b6d4 1272 else if($event->courseid != 0 && $event->courseid != SITEID && $event->groupid == 0) {
7b38bfa6 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;
7423f116 1280 }
1281 }
7b38bfa6 1282
7423f116 1283 }
1284 return;
1285}
1286
08b4a4e1
RW
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 */
b63c0ee5 1295function calendar_get_module_cached(&$coursecache, $modulename, $instance) {
1296 $module = get_coursemodule_from_instance($modulename, $instance);
7423f116 1297
1298 if($module === false) return false;
b63c0ee5 1299 if(!calendar_get_course_cached($coursecache, $module->course)) {
7423f116 1300 return false;
1301 }
1302 return $module;
1303}
1304
08b4a4e1
RW
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 */
7423f116 1312function calendar_get_course_cached(&$coursecache, $courseid) {
62d11d77 1313 global $COURSE, $DB;
1314
b571c6b3 1315 if (!isset($coursecache[$courseid])) {
1316 if ($courseid == $COURSE->id) {
1317 $coursecache[$courseid] = $COURSE;
1318 } else {
62d11d77 1319 $coursecache[$courseid] = $DB->get_record('course', array('id'=>$courseid));
b571c6b3 1320 }
7423f116 1321 }
1322 return $coursecache[$courseid];
1323}
1324
797cedc7
SH
1325/**
1326 * Returns the courses to load events for, the
1327 *
797cedc7 1328 * @param array $courseeventsfrom An array of courses to load calendar events for
08b4a4e1 1329 * @param bool $ignorefilters specify the use of filters, false is set as default
797cedc7
SH
1330 * @return array An array of courses, groups, and user to load calendar events for based upon filters
1331 */
1332function calendar_set_filters(array $courseeventsfrom, $ignorefilters = false) {
1333 global $USER, $CFG, $DB;
7423f116 1334
797cedc7
SH
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]);
753b799d 1342 }
dd97c328 1343 }
797cedc7
SH
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));
89adb174 1348 }
7423f116 1349
797cedc7
SH
1350 $courses = array();
1351 $user = false;
1352 $group = false;
7423f116 1353
7fd5786e
HB
1354 // capabilities that allow seeing group events from all groups
1355 // TODO: rewrite so that moodle/calendar:manageentries is not necessary here
1356 $allgroupscaps = array('moodle/site:accessallgroups', 'moodle/calendar:manageentries');
1357
797cedc7 1358 $isloggedin = isloggedin();
d12e3ff2 1359
797cedc7
SH
1360 if ($ignorefilters || calendar_show_event_type(CALENDAR_EVENT_COURSE)) {
1361 $courses = array_keys($courseeventsfrom);
7423f116 1362 }
797cedc7
SH
1363 if ($ignorefilters || calendar_show_event_type(CALENDAR_EVENT_GLOBAL)) {
1364 $courses[] = SITEID;
7423f116 1365 }
797cedc7
SH
1366 $courses = array_unique($courses);
1367 sort($courses);
7c50db30 1368
797cedc7 1369 if (!empty($courses) && in_array(SITEID, $courses)) {
7c50db30 1370 // Sort courses for consistent colour highlighting
1371 // Effectively ignoring SITEID as setting as last course id
1372 $key = array_search(SITEID, $courses);
797cedc7
SH
1373 unset($courses[$key]);
1374 $courses[] = SITEID;
0e6a8f4b 1375 }
7423f116 1376
797cedc7
SH
1377 if ($ignorefilters || ($isloggedin && calendar_show_event_type(CALENDAR_EVENT_USER))) {
1378 $user = $USER->id;
7423f116 1379 }
257e3f4c 1380
797cedc7
SH
1381 if (!empty($courseeventsfrom) && (calendar_show_event_type(CALENDAR_EVENT_GROUP) || $ignorefilters)) {
1382
7fd5786e
HB
1383 if (count($courseeventsfrom)==1) {
1384 $course = reset($courseeventsfrom);
1385 if (has_any_capability($allgroupscaps, get_context_instance(CONTEXT_COURSE, $course->id))) {
1386 $coursegroups = groups_get_all_groups($course->id, 0, 0, 'g.id');
1387 $group = array_keys($coursegroups);
7423f116 1388 }
7fd5786e
HB
1389 }
1390 if ($group === false) {
1391 if (!empty($CFG->calendar_adminseesall) && has_any_capability($allgroupscaps, get_system_context())) {
1392 $group = true;
1393 } else if ($isloggedin) {
1394 $groupids = array();
c46da759 1395
7fd5786e
HB
1396 // We already have the courses to examine in $courses
1397 // For each course...
1398 foreach ($courseeventsfrom as $courseid => $course) {
1399 // If the user is an editing teacher in there,
1400 if (!empty($USER->groupmember[$course->id])) {
1401 // We've already cached the users groups for this course so we can just use that
1402 $groupids = array_merge($groupids, $USER->groupmember[$course->id]);
1403 } else if ($course->groupmode != NOGROUPS || !$course->groupmodeforce) {
1404 // If this course has groups, show events from all of those related to the current user
1405 $coursegroups = groups_get_user_groups($course->id, $USER->id);
1406 $groupids = array_merge($groupids, $coursegroups['0']);
1407 }
1408 }
1409 if (!empty($groupids)) {
1410 $group = $groupids;
1411 }
6c9584d1 1412 }
7423f116 1413 }
7423f116 1414 }
797cedc7
SH
1415 if (empty($courses)) {
1416 $courses = false;
7423f116 1417 }
797cedc7
SH
1418
1419 return array($courses, $group, $user);
7423f116 1420}
1421
08b4a4e1
RW
1422/**
1423 * Return the capability for editing calendar event
1424 *
1425 * @param calendar_event $event event object
1426 * @return bool capability to edit event
1427 */
7423f116 1428function calendar_edit_event_allowed($event) {
62d11d77 1429 global $USER, $DB;
7423f116 1430
2ac8da76 1431 // Must be logged in
1432 if (!isloggedin()) {
1433 return false;
1434 }
1435
89491dbd 1436 // can not be using guest account
2396a414 1437 if (isguestuser()) {
e295df44 1438 return false;
89491dbd 1439 }
e295df44 1440
ef35441d 1441 $sitecontext = get_context_instance(CONTEXT_SYSTEM);
89491dbd 1442 // if user has manageentries at site level, return true
28ee98c5 1443 if (has_capability('moodle/calendar:manageentries', $sitecontext)) {
89491dbd 1444 return true;
f52f7413 1445 }
e295df44 1446
c0a2c361 1447 // if groupid is set, it's definitely a group event
438e4add 1448 if (!empty($event->groupid)) {
f63d2922 1449 // Allow users to add/edit group events if:
1450 // 1) They have manageentries (= entries for whole course)
1451 // 2) They have managegroupentries AND are in the group
62d11d77 1452 $group = $DB->get_record('groups', array('id'=>$event->groupid));
f63d2922 1453 return $group && (
f4700b91
RW
1454 has_capability('moodle/calendar:manageentries', $event->context) ||
1455 (has_capability('moodle/calendar:managegroupentries', $event->context)
f63d2922 1456 && groups_is_member($event->groupid)));
438e4add 1457 } else if (!empty($event->courseid)) {
c0a2c361 1458 // if groupid is not set, but course is set,
1459 // it's definiely a course event
f4700b91 1460 return has_capability('moodle/calendar:manageentries', $event->context);
438e4add 1461 } else if (!empty($event->userid) && $event->userid == $USER->id) {
c0a2c361 1462 // if course is not set, but userid id set, it's a user event
f4700b91
RW
1463 return (has_capability('moodle/calendar:manageownentries', $event->context));
1464 } else if (!empty($event->userid)) {
1465 return (has_capability('moodle/calendar:manageentries', $event->context));
e295df44 1466 }
7423f116 1467 return false;
1468}
1469
797cedc7
SH
1470/**
1471 * Returns the default courses to display on the calendar when there isn't a specific
1472 * course to display.
1473 *
08b4a4e1 1474 * @return array $courses Array of courses to display
797cedc7
SH
1475 */
1476function calendar_get_default_courses() {
1477 global $CFG, $DB;
7423f116 1478
4f0c2d00 1479 if (!isloggedin()) {
2ef75eee 1480 return array();
1481 }
1482
7423f116 1483 $courses = array();
d083084a 1484 if (!empty($CFG->calendar_adminseesall) && has_capability('moodle/calendar:manageentries', context_system::instance())) {
797cedc7 1485 list ($select, $join) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
d083084a 1486 $sql = "SELECT c.* $select
797cedc7 1487 FROM {course} c
d083084a
ARN
1488 $join
1489 WHERE EXISTS (SELECT 1 FROM {event} e WHERE e.courseid = c.id)
1490 ";
797cedc7
SH
1491 $courses = $DB->get_records_sql($sql, null, 0, 20);
1492 foreach ($courses as $course) {
d083084a 1493 context_helper::preload_from_record($course);
86f092d2 1494 }
797cedc7 1495 return $courses;
95a89225 1496 }
e295df44 1497
df997f84 1498 $courses = enrol_get_my_courses();
37d87d11 1499
1500 return $courses;
7423f116 1501}
1502
08b4a4e1
RW
1503/**
1504 * Display calendar preference button
1505 *
1506 * @param stdClass $course course object
1507 * @return string return preference button in html
1508 */
797cedc7
SH
1509function calendar_preferences_button(stdClass $course) {
1510 global $OUTPUT;
7423f116 1511
1512 // Guests have no preferences
4f0c2d00 1513 if (!isloggedin() || isguestuser()) {
7423f116 1514 return '';
1515 }
1516
797cedc7 1517 return $OUTPUT->single_button(new moodle_url('/calendar/preferences.php', array('course' => $course->id)), get_string("preferences", "calendar"));
7423f116 1518}
1519
08b4a4e1
RW
1520/**
1521 * Get event format time
1522 *
1523 * @param calendar_event $event event object
1524 * @param int $now current time in gmt
1525 * @param array $linkparams list of params for event link
1526 * @param bool $usecommonwords the words as formatted date/time.
1527 * @param int $showtime determine the show time GMT timestamp
1528 * @return string $eventtime link/string for event time
1529 */
0f927f1e 1530function calendar_format_event_time($event, $now, $linkparams = null, $usecommonwords = true, $showtime=0) {
8f896582 1531 $startdate = usergetdate($event->timestart);
1532 $enddate = usergetdate($event->timestart + $event->timeduration);
1533 $usermidnightstart = usergetmidnight($event->timestart);
1534
1535 if($event->timeduration) {
1536 // To avoid doing the math if one IF is enough :)
1537 $usermidnightend = usergetmidnight($event->timestart + $event->timeduration);
1538 }
1539 else {
1540 $usermidnightend = $usermidnightstart;
1541 }
1542
0f927f1e
SH
1543 if (empty($linkparams) || !is_array($linkparams)) {
1544 $linkparams = array();
1545 }
1546 $linkparams['view'] = 'day';
1547
8f896582 1548 // OK, now to get a meaningful display...
1549 // First of all we have to construct a human-readable date/time representation
1550
b4892fa2 1551 if($event->timeduration) {
8f896582 1552 // It has a duration
b4892fa2 1553 if($usermidnightstart == $usermidnightend ||
1554 ($event->timestart == $usermidnightstart) && ($event->timeduration == 86400 || $event->timeduration == 86399) ||
1555 ($event->timestart + $event->timeduration <= $usermidnightstart + 86400)) {
8f896582 1556 // But it's all on the same day
8f896582 1557 $timestart = calendar_time_representation($event->timestart);
1558 $timeend = calendar_time_representation($event->timestart + $event->timeduration);
b4892fa2 1559 $time = $timestart.' <strong>&raquo;</strong> '.$timeend;
1560
1561 if ($event->timestart == $usermidnightstart && ($event->timeduration == 86400 || $event->timeduration == 86399)) {
1562 $time = get_string('allday', 'calendar');
1563 }
8f896582 1564
1565 // Set printable representation
b4892fa2 1566 if (!$showtime) {
1567 $day = calendar_day_representation($event->timestart, $now, $usecommonwords);
0f927f1e
SH
1568 $url = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', $linkparams), $enddate['mday'], $enddate['mon'], $enddate['year']);
1569 $eventtime = html_writer::link($url, $day).', '.$time;
b4892fa2 1570 } else {
1571 $eventtime = $time;
1572 }
1573 } else {
8f896582 1574 // It spans two or more days
b4892fa2 1575 $daystart = calendar_day_representation($event->timestart, $now, $usecommonwords).', ';
1576 if ($showtime == $usermidnightstart) {
1577 $daystart = '';
1578 }
8f896582 1579 $timestart = calendar_time_representation($event->timestart);
b4892fa2 1580 $dayend = calendar_day_representation($event->timestart + $event->timeduration, $now, $usecommonwords).', ';
1581 if ($showtime == $usermidnightend) {
1582 $dayend = '';
1583 }
8f896582 1584 $timeend = calendar_time_representation($event->timestart + $event->timeduration);
1585
1586 // Set printable representation
b4892fa2 1587 if ($now >= $usermidnightstart && $now < ($usermidnightstart + 86400)) {
0f927f1e
SH
1588 $url = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', $linkparams), $enddate['mday'], $enddate['mon'], $enddate['year']);
1589 $eventtime = $timestart.' <strong>&raquo;</strong> '.html_writer::link($url, $dayend).$timeend;
b4892fa2 1590 } else {
0f927f1e
SH
1591 $url = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', $linkparams), $enddate['mday'], $enddate['mon'], $enddate['year']);
1592 $eventtime = html_writer::link($url, $daystart).$timestart.' <strong>&raquo;</strong> ';
1d5bd3d2 1593
0f927f1e
SH
1594 $url = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', $linkparams), $startdate['mday'], $startdate['mon'], $startdate['year']);
1595 $eventtime .= html_writer::link($url, $dayend).$timeend;
b4892fa2 1596 }
8f896582 1597 }
b4892fa2 1598 } else {
2af268a1 1599 $time = calendar_time_representation($event->timestart);
8f896582 1600
1601 // Set printable representation
b4892fa2 1602 if (!$showtime) {
1603 $day = calendar_day_representation($event->timestart, $now, $usecommonwords);
0f927f1e 1604 $url = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', $linkparams), $startdate['mday'], $startdate['mon'], $startdate['year']);
2af268a1 1605 $eventtime = html_writer::link($url, $day).', '.trim($time);
b4892fa2 1606 } else {
1607 $eventtime = $time;
1608 }
1609 }
1610
1611 if($event->timestart + $event->timeduration < $now) {
1612 // It has expired
1613 $eventtime = '<span class="dimmed_text">'.str_replace(' href=', ' class="dimmed" href=', $eventtime).'</span>';
8f896582 1614 }
09d36284 1615
8f896582 1616 return $eventtime;
1617}
054193be 1618
08b4a4e1
RW
1619/**
1620 * Display month selector options
1621 *
1622 * @param string $name for the select element
1623 * @param string|array $selected options for select elements
1624 */
86f092d2 1625function calendar_print_month_selector($name, $selected) {
86f092d2 1626 $months = array();
86f092d2 1627 for ($i=1; $i<=12; $i++) {
76ab1c33 1628 $months[$i] = userdate(gmmktime(12, 0, 0, $i, 15, 2000), '%B');
86f092d2 1629 }
81ff28e7 1630 echo html_writer::label(get_string('months'), 'menu'. $name, false, array('class' => 'accesshide'));
d776d59e 1631 echo html_writer::select($months, $name, $selected, false);
86f092d2 1632}
1633
797cedc7
SH
1634/**
1635 * Checks to see if the requested type of event should be shown for the given user.
1636 *
1637 * @param CALENDAR_EVENT_GLOBAL|CALENDAR_EVENT_COURSE|CALENDAR_EVENT_GROUP|CALENDAR_EVENT_USER $type
1638 * The type to check the display for (default is to display all)
1639 * @param stdClass|int|null $user The user to check for - by default the current user
1640 * @return bool True if the tyep should be displayed false otherwise
1641 */
1642function calendar_show_event_type($type, $user = null) {
1643 $default = CALENDAR_EVENT_GLOBAL + CALENDAR_EVENT_COURSE + CALENDAR_EVENT_GROUP + CALENDAR_EVENT_USER;
1644 if (get_user_preferences('calendar_persistflt', 0, $user) === 0) {
1645 global $SESSION;
1646 if (!isset($SESSION->calendarshoweventtype)) {
1647 $SESSION->calendarshoweventtype = $default;
1648 }
1649 return $SESSION->calendarshoweventtype & $type;
1650 } else {
1651 return get_user_preferences('calendar_savedflt', $default, $user) & $type;
054193be 1652 }
797cedc7
SH
1653}
1654
1655/**
1656 * Sets the display of the event type given $display.
08b4a4e1 1657 *
797cedc7
SH
1658 * If $display = true the event type will be shown.
1659 * If $display = false the event type will NOT be shown.
1660 * If $display = null the current value will be toggled and saved.
1661 *
08b4a4e1
RW
1662 * @param CALENDAR_EVENT_GLOBAL|CALENDAR_EVENT_COURSE|CALENDAR_EVENT_GROUP|CALENDAR_EVENT_USER $type object of CALENDAR_EVENT_XXX
1663 * @param bool $display option to display event type
1664 * @param stdClass|int $user moodle user object or id, null means current user
797cedc7
SH
1665 */
1666function calendar_set_event_type_display($type, $display = null, $user = null) {
1667 $persist = get_user_preferences('calendar_persistflt', 0, $user);
1668 $default = CALENDAR_EVENT_GLOBAL + CALENDAR_EVENT_COURSE + CALENDAR_EVENT_GROUP + CALENDAR_EVENT_USER;
1669 if ($persist === 0) {
1670 global $SESSION;
1671 if (!isset($SESSION->calendarshoweventtype)) {
1672 $SESSION->calendarshoweventtype = $default;
1673 }
1674 $preference = $SESSION->calendarshoweventtype;
1675 } else {
1676 $preference = get_user_preferences('calendar_savedflt', $default, $user);
054193be 1677 }
797cedc7
SH
1678 $current = $preference & $type;
1679 if ($display === null) {
1680 $display = !$current;
054193be 1681 }
797cedc7
SH
1682 if ($display && !$current) {
1683 $preference += $type;
1684 } else if (!$display && $current) {
1685 $preference -= $type;
054193be 1686 }
797cedc7
SH
1687 if ($persist === 0) {
1688 $SESSION->calendarshoweventtype = $preference;
1689 } else {
1690 if ($preference == $default) {
1691 unset_user_preference('calendar_savedflt', $user);
1692 } else {
1693 set_user_preference('calendar_savedflt', $preference, $user);
1694 }
054193be 1695 }
054193be 1696}
1697
08b4a4e1
RW
1698/**
1699 * Get calendar's allowed types
1700 *
1701 * @param stdClass $allowed list of allowed edit for event type
1702 * @param stdClass|int $course object of a course or course id
1703 */
797cedc7
SH
1704function calendar_get_allowed_types(&$allowed, $course = null) {
1705 global $USER, $CFG, $DB;
b85b25eb 1706 $allowed = new stdClass();
797cedc7 1707 $allowed->user = has_capability('moodle/calendar:manageownentries', get_system_context());
86ac8b24 1708 $allowed->groups = false; // This may change just below
1709 $allowed->courses = false; // This may change just below
1710 $allowed->site = has_capability('moodle/calendar:manageentries', get_context_instance(CONTEXT_COURSE, SITEID));
1711
797cedc7
SH
1712 if (!empty($course)) {
1713 if (!is_object($course)) {
1714 $course = $DB->get_record('course', array('id' => $course), '*', MUST_EXIST);
1715 }
1716 if ($course->id != SITEID) {
1717 $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
3c0ea9b2 1718 $allowed->user = has_capability('moodle/calendar:manageownentries', $coursecontext);
86ac8b24 1719
797cedc7
SH
1720 if (has_capability('moodle/calendar:manageentries', $coursecontext)) {
1721 $allowed->courses = array($course->id => 1);
aa6c1ced 1722
797cedc7
SH
1723 if ($course->groupmode != NOGROUPS || !$course->groupmodeforce) {
1724 $allowed->groups = groups_get_all_groups($course->id);
1725 }
1726 } else if (has_capability('moodle/calendar:managegroupentries', $coursecontext)) {
1727 if($course->groupmode != NOGROUPS || !$course->groupmodeforce) {
1728 $allowed->groups = groups_get_all_groups($course->id);
1729 }
f63d2922 1730 }
86ac8b24 1731 }
1732 }
1733}
1734
1735/**
08b4a4e1 1736 * See if user can add calendar entries at all
86ac8b24 1737 * used to print the "New Event" button
08b4a4e1
RW
1738 *
1739 * @param stdClass $course object of a course or course id
1740 * @return bool has the capability to add at least one event type
86ac8b24 1741 */
797cedc7
SH
1742function calendar_user_can_add_event($course) {
1743 if (!isloggedin() || isguestuser()) {
1744 return false;
1745 }
1746 calendar_get_allowed_types($allowed, $course);
e295df44 1747 return (bool)($allowed->user || $allowed->groups || $allowed->courses || $allowed->site);
86ac8b24 1748}
76d9df3f
SH
1749
1750/**
1751 * Check wether the current user is permitted to add events
1752 *
08b4a4e1
RW
1753 * @param stdClass $event object of event
1754 * @return bool has the capability to add event
76d9df3f
SH
1755 */
1756function calendar_add_event_allowed($event) {
1757 global $USER, $DB;
1758
1759 // can not be using guest account
4f0c2d00 1760 if (!isloggedin() or isguestuser()) {
76d9df3f
SH
1761 return false;
1762 }
1763
1764 $sitecontext = get_context_instance(CONTEXT_SYSTEM);
1765 // if user has manageentries at site level, always return true
1766 if (has_capability('moodle/calendar:manageentries', $sitecontext)) {
1767 return true;
1768 }
1769
1770 switch ($event->eventtype) {
1771 case 'course':
f4700b91 1772 return has_capability('moodle/calendar:manageentries', $event->context);
76d9df3f
SH
1773
1774 case 'group':
1775 // Allow users to add/edit group events if:
1776 // 1) They have manageentries (= entries for whole course)
1777 // 2) They have managegroupentries AND are in the group
1778 $group = $DB->get_record('groups', array('id'=>$event->groupid));
1779 return $group && (
f4700b91
RW
1780 has_capability('moodle/calendar:manageentries', $event->context) ||
1781 (has_capability('moodle/calendar:managegroupentries', $event->context)
76d9df3f
SH
1782 && groups_is_member($event->groupid)));
1783
1784 case 'user':
1785 if ($event->userid == $USER->id) {
f4700b91 1786 return (has_capability('moodle/calendar:manageownentries', $event->context));
76d9df3f
SH
1787 }
1788 //there is no 'break;' intentionally
1789
1790 case 'site':
f4700b91 1791 return has_capability('moodle/calendar:manageentries', $event->context);
76d9df3f
SH
1792
1793 default:
f4700b91 1794 return has_capability('moodle/calendar:manageentries', $event->context);
76d9df3f
SH
1795 }
1796}
1797
1798/**
08b4a4e1 1799 * Manage calendar events
76d9df3f
SH
1800 *
1801 * This class provides the required functionality in order to manage calendar events.
1802 * It was introduced as part of Moodle 2.0 and was created in order to provide a
1803 * better framework for dealing with calendar events in particular regard to file
1804 * handling through the new file API
1805 *
08b4a4e1
RW
1806 * @package core_calendar
1807 * @category calendar
1808 * @copyright 2009 Sam Hemelryk
1809 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1810 *
76d9df3f
SH
1811 * @property int $id The id within the event table
1812 * @property string $name The name of the event
1813 * @property string $description The description of the event
1814 * @property int $format The format of the description FORMAT_?
1815 * @property int $courseid The course the event is associated with (0 if none)
1816 * @property int $groupid The group the event is associated with (0 if none)
1817 * @property int $userid The user the event is associated with (0 if none)
1818 * @property int $repeatid If this is a repeated event this will be set to the
1819 * id of the original
1820 * @property string $modulename If added by a module this will be the module name
1821 * @property int $instance If added by a module this will be the module instance
1822 * @property string $eventtype The event type
1823 * @property int $timestart The start time as a timestamp
1824 * @property int $timeduration The duration of the event in seconds
1825 * @property int $visible 1 if the event is visible
1826 * @property int $uuid ?
1827 * @property int $sequence ?
1828 * @property int $timemodified The time last modified as a timestamp
1829 */
1830class calendar_event {
1831
08b4a4e1 1832 /** @var array An object containing the event properties can be accessed via the magic __get/set methods */
76d9df3f 1833 protected $properties = null;
08b4a4e1 1834
76d9df3f 1835 /**
08b4a4e1 1836 * @var string The converted event discription with file paths resolved. This gets populated when someone requests description for the first time */
76d9df3f 1837 protected $_description = null;
08b4a4e1
RW
1838
1839 /** @var array The options to use with this description editor */
76d9df3f
SH
1840 protected $editoroptions = array(
1841 'subdirs'=>false,
1842 'forcehttps'=>false,
2b35ed1a 1843 'maxfiles'=>-1,
76d9df3f
SH
1844 'maxbytes'=>null,
1845 'trusttext'=>false);
08b4a4e1
RW
1846
1847 /** @var object The context to use with the description editor */
76d9df3f
SH
1848 protected $editorcontext = null;
1849
1850 /**
1851 * Instantiates a new event and optionally populates its properties with the
1852 * data provided
1853 *
1854 * @param stdClass $data Optional. An object containing the properties to for
1855 * an event
1856 */
1857 public function __construct($data=null) {
c203a277 1858 global $CFG, $USER;
76d9df3f
SH
1859
1860 // First convert to object if it is not already (should either be object or assoc array)
1861 if (!is_object($data)) {
1862 $data = (object)$data;
1863 }
1864
1865 $this->editoroptions['maxbytes'] = $CFG->maxbytes;
1866
1867 $data->eventrepeats = 0;
1868
1869 if (empty($data->id)) {
1870 $data->id = null;
1871 }
1872
c203a277
SH
1873 // Default to a user event
1874 if (empty($data->eventtype)) {
1875 $data->eventtype = 'user';
1876 }
1877
1878 // Default to the current user
1879 if (empty($data->userid)) {
1880 $data->userid = $USER->id;
1881 }
1882
76d9df3f
SH
1883 if (!empty($data->timeduration) && is_array($data->timeduration)) {
1884 $data->timeduration = make_timestamp($data->timeduration['year'], $data->timeduration['month'], $data->timeduration['day'], $data->timeduration['hour'], $data->timeduration['minute']) - $data->timestart;
1885 }
1886 if (!empty($data->description) && is_array($data->description)) {
1887 $data->format = $data->description['format'];
1888 $data->description = $data->description['text'];
1889 } else if (empty($data->description)) {
1890 $data->description = '';
20e5da7d 1891 $data->format = editors_get_preferred_format();
76d9df3f 1892 }
c203a277
SH
1893 // Ensure form is defaulted correctly
1894 if (empty($data->format)) {
1895 $data->format = editors_get_preferred_format();
1896 }
76d9df3f 1897
f4700b91
RW
1898 if (empty($data->context)) {
1899 $data->context = $this->calculate_context($data);
1900 }
76d9df3f
SH
1901 $this->properties = $data;
1902 }
1903
1904 /**
1905 * Magic property method
1906 *
1907 * Attempts to call a set_$key method if one exists otherwise falls back
1908 * to simply set the property
1909 *
08b4a4e1
RW
1910 * @param string $key property name
1911 * @param mixed $value value of the property
76d9df3f
SH
1912 */
1913 public function __set($key, $value) {
1914 if (method_exists($this, 'set_'.$key)) {
1915 $this->{'set_'.$key}($value);
1916 }
1917 $this->properties->{$key} = $value;
1918 }
1919
1920 /**
1921 * Magic get method
1922 *
1923 * Attempts to call a get_$key method to return the property and ralls over
1924 * to return the raw property
1925 *
08b4a4e1
RW
1926 * @param string $key property name
1927 * @return mixed property value
76d9df3f
SH
1928 */
1929 public function __get($key) {
1930 if (method_exists($this, 'get_'.$key)) {
1931 return $this->{'get_'.$key}();
1932 }
c203a277
SH
1933 if (!isset($this->properties->{$key})) {
1934 throw new coding_exception('Undefined property requested');
1935 }
76d9df3f
SH
1936 return $this->properties->{$key};
1937 }
1938
1939 /**
1940 * Stupid PHP needs an isset magic method if you use the get magic method and
1941 * still want empty calls to work.... blah ~!
1942 *
08b4a4e1
RW
1943 * @param string $key $key property name
1944 * @return bool|mixed property value, false if property is not exist
76d9df3f
SH
1945 */
1946 public function __isset($key) {
1947 return !empty($this->properties->{$key});
1948 }
1949
f4700b91
RW
1950 /**
1951 * Calculate the context value needed for calendar_event.
1952 * Event's type can be determine by the available value store in $data
1953 * It is important to check for the existence of course/courseid to determine
1954 * the course event.
1955 * Default value is set to CONTEXT_USER
1956 *
08b4a4e1
RW
1957 * @param stdClass $data information about event
1958 * @return stdClass The context object.
f4700b91
RW
1959 */
1960 protected function calculate_context(stdClass $data) {
025d82e0 1961 global $USER, $DB;
f4700b91 1962
f4700b91
RW
1963 $context = null;
1964 if (isset($data->courseid) && $data->courseid > 0) {
1965 $context = get_context_instance(CONTEXT_COURSE, $data->courseid);
1966 } else if (isset($data->course) && $data->course > 0) {
1967 $context = get_context_instance(CONTEXT_COURSE, $data->course);
1968 } else if (isset($data->groupid) && $data->groupid > 0) {
1969 $group = $DB->get_record('groups', array('id'=>$data->groupid));
1970 $context = get_context_instance(CONTEXT_COURSE, $group->courseid);
1971 } else if (isset($data->userid) && $data->userid > 0 && $data->userid == $USER->id) {
d52777b4 1972 $context = get_context_instance(CONTEXT_USER, $data->userid);
f4700b91
RW
1973 } else if (isset($data->userid) && $data->userid > 0 && $data->userid != $USER->id &&
1974 isset($data->instance) && $data->instance > 0) {
18d63ffb 1975 $cm = get_coursemodule_from_instance($data->modulename, $data->instance, 0, false, MUST_EXIST);
f4700b91
RW
1976 $context = get_context_instance(CONTEXT_COURSE, $cm->course);
1977 } else {
1978 $context = get_context_instance(CONTEXT_USER);
1979 }
1980
1981 return $context;
1982 }
1983
76d9df3f
SH
1984 /**
1985 * Returns an array of editoroptions for this event: Called by __get
1986 * Please use $blah = $event->editoroptions;
08b4a4e1
RW
1987 *
1988 * @return array event editor options
76d9df3f
SH
1989 */
1990 protected function get_editoroptions() {
1991 return $this->editoroptions;
1992 }
1993
1994 /**
1995 * Returns an event description: Called by __get
1996 * Please use $blah = $event->description;
1997 *
08b4a4e1 1998 * @return string event description
76d9df3f
SH
1999 */
2000 protected function get_description() {
f4700b91 2001 global $CFG;
99d19c13
PS
2002
2003 require_once($CFG->libdir . '/filelib.php');
2004
76d9df3f
SH
2005 if ($this->_description === null) {
2006 // Check if we have already resolved the context for this event
2007 if ($this->editorcontext === null) {
2008 // Switch on the event type to decide upon the appropriate context
2009 // to use for this event
f4700b91
RW
2010 $this->editorcontext = $this->properties->context;
2011 if ($this->properties->eventtype != 'user' && $this->properties->eventtype != 'course'
2012 && $this->properties->eventtype != 'site' && $this->properties->eventtype != 'group') {
2013 return clean_text($this->properties->description, $this->properties->format);
76d9df3f
SH
2014 }
2015 }
2016
2017 // Work out the item id for the editor, if this is a repeated event then the files will
2018 // be associated with the original
2019 if (!empty($this->properties->repeatid) && $this->properties->repeatid > 0) {
2020 $itemid = $this->properties->repeatid;
2021 } else {
2022 $itemid = $this->properties->id;
2023 }
2024
2025 // Convert file paths in the description so that things display correctly
64f93798 2026 $this->_description = file_rewrite_pluginfile_urls($this->properties->description, 'pluginfile.php', $this->editorcontext->id, 'calendar', 'event_description', $itemid);
76d9df3f
SH
2027 // Clean the text so no nasties get through
2028 $this->_description = clean_text($this->_description, $this->properties->format);
2029 }
2030 // Finally return the description
2031 return $this->_description;
2032 }
2033
2034 /**
2035 * Return the number of repeat events there are in this events series
aa6c1ced 2036 *
08b4a4e1 2037 * @return int number of event repeated
76d9df3f
SH
2038 */
2039 public function count_repeats() {
2040 global $DB;
2041 if (!empty($this->properties->repeatid)) {
2042 $this->properties->eventrepeats = $DB->count_records('event', array('repeatid'=>$this->properties->repeatid));
2043 // We don't want to count ourselves
2044 $this->properties->eventrepeats--;
2045 }
2046 return $this->properties->eventrepeats;
2047 }
2048
2049 /**
2050 * Update or create an event within the database
2051 *
2052 * Pass in a object containing the event properties and this function will
2053 * insert it into the database and deal with any associated files
2054 *
2055 * @see add_event()
2056 * @see update_event()
2057 *
08b4a4e1
RW
2058 * @param stdClass $data object of event
2059 * @param bool $checkcapability if moodle should check calendar managing capability or not
2060 * @return bool event updated
76d9df3f 2061 */
1d5bd3d2 2062 public function update($data, $checkcapability=true) {
76d9df3f
SH
2063 global $CFG, $DB, $USER;
2064
438e4add
SH
2065 foreach ($data as $key=>$value) {
2066 $this->properties->$key = $value;
2067 }
2068
76d9df3f
SH
2069 $this->properties->timemodified = time();
2070 $usingeditor = (!empty($this->properties->description) && is_array($this->properties->description));
2071
2072 if (empty($this->properties->id) || $this->properties->id < 1) {
2073
1d5bd3d2
DC
2074 if ($checkcapability) {
2075 if (!calendar_add_event_allowed($this->properties)) {
2076 print_error('nopermissiontoupdatecalendar');
2077 }
76d9df3f
SH
2078 }
2079
2080 if ($usingeditor) {
2081 switch ($this->properties->eventtype) {
2082 case 'user':
76d9df3f 2083 $this->properties->courseid = 0;
ac247b4e 2084 $this->properties->course = 0;
76d9df3f
SH
2085 $this->properties->groupid = 0;
2086 $this->properties->userid = $USER->id;
2087 break;
2088 case 'site':
76d9df3f 2089 $this->properties->courseid = SITEID;
ac247b4e 2090 $this->properties->course = SITEID;
76d9df3f
SH
2091 $this->properties->groupid = 0;
2092 $this->properties->userid = $USER->id;
2093 break;
2094 case 'course':
76d9df3f
SH
2095 $this->properties->groupid = 0;
2096 $this->properties->userid = $USER->id;
2097 break;
2098 case 'group':
76d9df3f
SH
2099 $this->properties->userid = $USER->id;
2100 break;
2101 default:
2102 // Ewww we should NEVER get here, but just incase we do lets
2103 // fail gracefully
2104 $usingeditor = false;
2105 break;
2106 }
2107
ac247b4e
FM
2108 // If we are actually using the editor, we recalculate the context because some default values
2109 // were set when calculate_context() was called from the constructor.
2110 if ($usingeditor) {
2111 $this->properties->context = $this->calculate_context($this->properties);
2112 $this->editorcontext = $this->properties->context;
2113 }
2114
76d9df3f
SH
2115 $editor = $this->properties->description;
2116 $this->properties->format = $this->properties->description['format'];
2117 $this->properties->description = $this->properties->description['text'];
2118 }
2119
2120 // Insert the event into the database
2121 $this->properties->id = $DB->insert_record('event', $this->properties);
2122
2123 if ($usingeditor) {
2124 $this->properties->description = file_save_draft_area_files(
2125 $editor['itemid'],
2126 $this->editorcontext->id,
64f93798
PS
2127 'calendar',
2128 'event_description',
76d9df3f
SH
2129 $this->properties->id,
2130 $this->editoroptions,
2131 $editor['text'],
2132 $this->editoroptions['forcehttps']);
76d9df3f
SH
2133 $DB->set_field('event', 'description', $this->properties->description, array('id'=>$this->properties->id));
2134 }
aa6c1ced 2135
76d9df3f
SH
2136 // Log the event entry.
2137 add_to_log($this->properties->courseid, 'calendar', 'add', 'event.php?action=edit&amp;id='.$this->properties->id, $this->properties->name);
2138
2139 $repeatedids = array();
2140
2141 if (!empty($this->properties->repeat)) {
2142 $this->properties->repeatid = $this->properties->id;
2143 $DB->set_field('event', 'repeatid', $this->properties->repeatid, array('id'=>$this->properties->id));
2144
2145 $eventcopy = clone($this->properties);
2146 unset($eventcopy->id);
2147
2148 for($i = 1; $i < $eventcopy->repeats; $i++) {
2149
2150 $eventcopy->timestart = ($eventcopy->timestart+WEEKSECS) + dst_offset_on($eventcopy->timestart) - dst_offset_on($eventcopy->timestart+WEEKSECS);
2151
2152 // Get the event id for the log record.
2153 $eventcopyid = $DB->insert_record('event', $eventcopy);
2154
2155 // If the context has been set delete all associated files
2156 if ($usingeditor) {
2157 $fs = get_file_storage();
64f93798 2158 $files = $fs->get_area_files($this->editorcontext->id, 'calendar', 'event_description', $this->properties->id);
76d9df3f
SH
2159 foreach ($files as $file) {
2160 $fs->create_file_from_storedfile(array('itemid'=>$eventcopyid), $file);
2161 }
2162 }
2163
2164 $repeatedids[] = $eventcopyid;
2165 // Log the event entry.
2166 add_to_log($eventcopy->courseid, 'calendar', 'add', 'event.php?action=edit&amp;id='.$eventcopyid, $eventcopy->name);
2167 }
2168 }
2169
2170 // Hook for tracking added events
2171 self::calendar_event_hook('add_event', array($this->properties, $repeatedids));
2172 return true;
2173 } else {
2174
1d5bd3d2
DC
2175 if ($checkcapability) {
2176 if(!calendar_edit_event_allowed($this->properties)) {
2177 print_error('nopermissiontoupdatecalendar');
2178 }
76d9df3f
SH
2179 }
2180
2181 if ($usingeditor) {
2182 if ($this->editorcontext !== null) {
2183 $this->properties->description = file_save_draft_area_files(
2184 $this->properties->description['itemid'],
2185 $this->editorcontext->id,
64f93798
PS
2186 'calendar',
2187 'event_description',
76d9df3f
SH
2188 $this->properties->id,
2189 $this->editoroptions,
2190 $this->properties->description['text'],
2191 $this->editoroptions['forcehttps']);
2192 } else {
2193 $this->properties->format = $this->properties->description['format'];
2194 $this->properties->description = $this->properties->description['text'];
2195 }
2196 }
2197
2198 $event = $DB->get_record('event', array('id'=>$this->properties->id));
2199
2200 $updaterepeated = (!empty($this->properties->repeatid) && !empty($this->properties->repeateditall));
2201
2202 if ($updaterepeated) {
2203 // Update all
2204 if ($this->properties->timestart != $event->timestart) {
2205 $timestartoffset = $this->properties->timestart - $event->timestart;
2206 $sql = "UPDATE {event}
2207 SET name = ?,
2208 description = ?,
2209 timestart = timestart + ?,
2210 timeduration = ?,
2211 timemodified = ?
2212 WHERE repeatid = ?";
2213 $params = array($this->properties->name, $this->properties->description, $timestartoffset, $this->properties->timeduration, time(), $event->repeatid);
2214 } else {
2215 $sql = "UPDATE {event} SET name = ?, description = ?, timeduration = ?, timemodified = ? WHERE repeatid = ?";
2216 $params = array($this->properties->name, $this->properties->description, $this->properties->timeduration, time(), $event->repeatid);
2217 }
2218 $DB->execute($sql, $params);
2219
2220 // Log the event update.
2221 add_to_log($this->properties->courseid, 'calendar', 'edit all', 'event.php?action=edit&amp;id='.$this->properties->id, $this->properties->name);
2222 } else {
2223 $DB->update_record('event', $this->properties);
ddaff608
SH
2224 $event = calendar_event::load($this->properties->id);
2225 $this->properties = $event->properties();
76d9df3f
SH
2226 add_to_log($this->properties->courseid, 'calendar', 'edit', 'event.php?action=edit&amp;id='.$this->properties->id, $this->properties->name);
2227 }
2228
2229 // Hook for tracking event updates
2230 self::calendar_event_hook('update_event', array($this->properties, $updaterepeated));
2231 return true;
2232 }
2233 }
2234
2235 /**
2236 * Deletes an event and if selected an repeated events in the same series
2237 *
2238 * This function deletes an event, any associated events if $deleterepeated=true,
2239 * and cleans up any files associated with the events.
2240 *
2241 * @see delete_event()
2242 *
08b4a4e1
RW
2243 * @param bool $deleterepeated delete event repeatedly
2244 * @return bool succession of deleting event
76d9df3f
SH
2245 */
2246 public function delete($deleterepeated=false) {
f4700b91 2247 global $DB;
76d9df3f
SH
2248
2249 // If $this->properties->id is not set then something is wrong
2250 if (empty($this->properties->id)) {
2251 debugging('Attempting to delete an event before it has been loaded', DEBUG_DEVELOPER);
2252 return false;
2253 }
2254
2255 // Delete the event
2256 $DB->delete_records('event', array('id'=>$this->properties->id));
2257
ff284fac
AA
2258 // If we are deleting parent of a repeated event series, promote the next event in the series as parent
2259 if (($this->properties->id == $this->properties->repeatid) && !$deleterepeated) {
2260 $newparent = $DB->get_field_sql("SELECT id from {event} where repeatid = ? order by id ASC", array($this->properties->id), IGNORE_MULTIPLE);
2261 if (!empty($newparent)) {
2262 $DB->execute("UPDATE {event} SET repeatid = ? WHERE repeatid = ?", array($newparent, $this->properties->id));
5ff114ad
AA
2263 // Get all records where the repeatid is the same as the event being removed
2264 $events = $DB->get_records('event', array('repeatid' => $newparent));
2265 // For each of the returned events trigger the event_update hook.
2266 foreach ($events as $event) {
2267 self::calendar_event_hook('update_event', array($event, false));
2268 }
ff284fac
AA
2269 }
2270 }
2271
76d9df3f
SH
2272 // If the editor context hasn't already been set then set it now
2273 if ($this->editorcontext === null) {
f4700b91 2274 $this->editorcontext = $this->properties->context;
76d9df3f
SH
2275 }
2276
2277 // If the context has been set delete all associated files
2278 if ($this->editorcontext !== null) {
2279 $fs = get_file_storage();
64f93798 2280 $files = $fs->get_area_files($this->editorcontext->id, 'calendar', 'event_description', $this->properties->id);
76d9df3f
SH
2281 foreach ($files as $file) {
2282 $file->delete();
2283 }
2284 }
2285
2286 // Fire the event deleted hook
2287 self::calendar_event_hook('delete_event', array($this->properties->id, $deleterepeated));
2288
2289 // If we need to delete repeated events then we will fetch them all and delete one by one
2290 if ($deleterepeated && !empty($this->properties->repeatid) && $this->properties->repeatid > 0) {
2291 // Get all records where the repeatid is the same as the event being removed
2292 $events = $DB->get_records('event', array('repeatid'=>$this->properties->repeatid));
2293 // For each of the returned events populate a calendar_event object and call delete
2294 // make sure the arg passed is false as we are already deleting all repeats
2295 foreach ($events as $event) {
2296 $event = new calendar_event($event);
2297 $event->delete(false);
2298 }
2299 }
2300
2301 return true;
2302 }
2303
2304 /**
2305 * Fetch all event properties
2306 *
2307 * This function returns all of the events properties as an object and optionally
2308 * can prepare an editor for the description field at the same time. This is
2309 * designed to work when the properties are going to be used to set the default
2310 * values of a moodle forms form.
2311 *
2312 * @param bool $prepareeditor If set to true a editor is prepared for use with
2313 * the mforms editor element. (for description)
2314 * @return stdClass Object containing event properties
2315 */
2316 public function properties($prepareeditor=false) {
2317 global $USER, $CFG, $DB;
2318
2319 // First take a copy of the properties. We don't want to actually change the
2320 // properties or we'd forever be converting back and forwards between an
2321 // editor formatted description and not
2322 $properties = clone($this->properties);
2323 // Clean the description here
2324 $properties->description = clean_text($properties->description, $properties->format);
2325
2326 // If set to true we need to prepare the properties for use with an editor
2327 // and prepare the file area
2328 if ($prepareeditor) {
2329
2330 // We may or may not have a property id. If we do then we need to work
2331 // out the context so we can copy the existing files to the draft area
2332 if (!empty($properties->id)) {
2333
2334 if ($properties->eventtype === 'site') {
2335 // Site context
f4700b91 2336 $this->editorcontext = $this->properties->context;
76d9df3f
SH
2337 } else if ($properties->eventtype === 'user') {
2338 // User context
f4700b91 2339 $this->editorcontext = $this->properties->context;
76d9df3f
SH
2340 } else if ($properties->eventtype === 'group' || $properties->eventtype === 'course') {
2341 // First check the course is valid
2342 $course = $DB->get_record('course', array('id'=>$properties->courseid));
2343 if (!$course) {
2344 print_error('invalidcourse');
2345 }
2346 // Course context
f4700b91 2347 $this->editorcontext = $this->properties->context;
76d9df3f
SH
2348 // We have a course and are within the course context so we had
2349 // better use the courses max bytes value
2350 $this->editoroptions['maxbytes'] = $course->maxbytes;
2351 } else {
2352 // If we get here we have a custom event type as used by some
2353 // modules. In this case the event will have been added by
2354 // code and we won't need the editor
2355 $this->editoroptions['maxbytes'] = 0;
2356 $this->editoroptions['maxfiles'] = 0;
2357 }
2358
2359 if (empty($this->editorcontext) || empty($this->editorcontext->id)) {
2360 $contextid = false;
2361 } else {
2362 // Get the context id that is what we really want
2363 $contextid = $this->editorcontext->id;
2364 }
2365 } else {
2366
2367 // If we get here then this is a new event in which case we don't need a
2368 // context as there is no existing files to copy to the draft area.
2369 $contextid = null;
2370 }
2371
2372 // If the contextid === false we don't support files so no preparing
2373 // a draft area
2374 if ($contextid !== false) {
2375 // Just encase it has already been submitted
2376 $draftiddescription = file_get_submitted_draft_itemid('description');
2377 // Prepare the draft area, this copies existing files to the draft area as well
64f93798 2378 $properties->description = file_prepare_draft_area($draftiddescription, $contextid, 'calendar', 'event_description', $properties->id, $this->editoroptions, $properties->description);
76d9df3f
SH
2379 } else {
2380 $draftiddescription = 0;
2381 }
aa6c1ced 2382
76d9df3f
SH
2383 // Structure the description field as the editor requires
2384 $properties->description = array('text'=>$properties->description, 'format'=>$properties->format, 'itemid'=>$draftiddescription);
2385 }
2386
2387 // Finally return the properties
2388 return $properties;
2389 }
2390
2391 /**
2392 * Toggles the visibility of an event
2393 *
2394 * @param null|bool $force If it is left null the events visibility is flipped,
2395 * If it is false the event is made hidden, if it is true it
2396 * is made visible.
08b4a4e1 2397 * @return bool if event is successfully updated, toggle will be visible
76d9df3f
SH
2398 */
2399 public function toggle_visibility($force=null) {
2400 global $CFG, $DB;
2401
2402 // Set visible to the default if it is not already set
2403 if (empty($this->properties->visible)) {
2404 $this->properties->visible = 1;
2405 }
2406
2407 if ($force === true || ($force !== false && $this->properties->visible == 0)) {
2408 // Make this event visible
2409 $this->properties->visible = 1;
2410 // Fire the hook
2411 self::calendar_event_hook('show_event', array($this->properties));
2412 } else {
2413 // Make this event hidden
2414 $this->properties->visible = 0;
2415 // Fire the hook
2416 self::calendar_event_hook('hide_event', array($this->properties));
2417 }
2418
2419 // Update the database to reflect this change
2420 return $DB->set_field('event', 'visible', $this->properties->visible, array('id'=>$this->properties->id));
2421 }
2422
2423 /**
2424 * Attempts to call the hook for the specified action should a calendar type
2425 * by set $CFG->calendar, and the appopriate function defined
2426 *
76d9df3f
SH
2427 * @param string $action One of `update_event`, `add_event`, `delete_event`, `show_event`, `hide_event`
2428 * @param array $args The args to pass to the hook, usually the event is the first element
08b4a4e1 2429 * @return bool attempts to call event hook
76d9df3f
SH
2430 */
2431 public static function calendar_event_hook($action, array $args) {
2432 global $CFG;
2433 static $extcalendarinc;
2434 if ($extcalendarinc === null) {
2435 if (!empty($CFG->calendar) && file_exists($CFG->dirroot .'/calendar/'. $CFG->calendar .'/lib.php')) {
2436 include_once($CFG->dirroot .'/calendar/'. $CFG->calendar .'/lib.php');
2437 $extcalendarinc = true;
2438 } else {
2439 $extcalendarinc = false;
2440 }
2441 }
2442 if($extcalendarinc === false) {
2443 return false;
2444 }
438e4add 2445 $hook = $CFG->calendar .'_'.$action;
76d9df3f
SH
2446 if (function_exists($hook)) {
2447 call_user_func_array($hook, $args);
2448 return true;
2449 }
2450 return false;
2451 }
2452
2453 /**
2454 * Returns a calendar_event object when provided with an event id
2455 *
2456 * This function makes use of MUST_EXIST, if the event id passed in is invalid
2457 * it will result in an exception being thrown
2458 *
08b4a4e1
RW
2459 * @param int|object $param event object or event id
2460 * @return calendar_event|false status for loading calendar_event
76d9df3f 2461 */
fd699564 2462 public static function load($param) {
76d9df3f 2463 global $DB;
fd699564
SH
2464 if (is_object($param)) {
2465 $event = new calendar_event($param);
2466 } else {
2467 $event = $DB->get_record('event', array('id'=>(int)$param), '*', MUST_EXIST);
2468 $event = new calendar_event($event);
2469 }
76d9df3f
SH
2470 return $event;
2471 }
2472
2473 /**
2474 * Creates a new event and returns a calendar_event object
2475 *
2476 * @param object|array $properties An object containing event properties
2477 * @return calendar_event|false The event object or false if it failed
2478 */
2479 public static function create($properties) {
2480 if (is_array($properties)) {
2481 $properties = (object)$properties;
2482 }
2483 if (!is_object($properties)) {
2484 throw new coding_exception('When creating an event properties should be either an object or an assoc array');
2485 }
f4700b91 2486 $event = new calendar_event($properties);
76d9df3f
SH
2487 if ($event->update($properties)) {
2488 return $event;
2489 } else {
2490 return false;
2491 }
2492 }
2493}
36dc3b71
SH
2494
2495/**
2496 * Calendar information class
2497 *
2498 * This class is used simply to organise the information pertaining to a calendar
2499 * and is used primarily to make information easily available.
08b4a4e1
RW
2500 *
2501 * @package core_calendar
2502 * @category calendar
2503 * @copyright 2010 Sam Hemelryk
2504 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36dc3b71
SH
2505 */
2506class calendar_information {
08b4a4e1 2507 /** @var int The day */
36dc3b71 2508 public $day;
08b4a4e1
RW
2509
2510 /** @var int The month */
36dc3b71 2511 public $month;
08b4a4e1
RW
2512
2513 /** @var int The year */
36dc3b71
SH
2514 public $year;
2515
08b4a4e1 2516 /** @var int A course id */
36dc3b71 2517 public $courseid = null;
08b4a4e1
RW
2518
2519 /** @var array An array of courses */
36dc3b71 2520 public $courses = array();
08b4a4e1
RW
2521
2522 /** @var array An array of groups */
36dc3b71 2523 public $groups = array();
08b4a4e1
RW
2524
2525 /** @var array An array of users */
36dc3b71
SH
2526 public $users = array();
2527
2528 /**
2529 * Creates a new instance
2530 *
08b4a4e1
RW
2531 * @param int $day the number of the day
2532 * @param int $month the number of the month
2533 * @param int $year the number of the year
36dc3b71 2534 */
d8d8bdd9
SH
2535 public function __construct($day=0, $month=0, $year=0) {
2536
2537 $date = usergetdate(time());
2538
2539 if (empty($day)) {
2540 $day = $date['mday'];
2541 }
2542
2543 if (empty($month)) {
2544 $month = $date['mon'];
2545 }
2546
2547 if (empty($year)) {
2548 $year = $date['year'];
2549 }
2550
36dc3b71
SH
2551 $this->day = $day;
2552 $this->month = $month;
2553 $this->year = $year;
2554 }
2555
797cedc7 2556 /**
08b4a4e1 2557 * Initialize calendar information
797cedc7 2558 *
08b4a4e1 2559 * @param stdClass $course object
797cedc7 2560 * @param array $coursestoload An array of courses [$course->id => $course]
08b4a4e1 2561 * @param bool $ignorefilters options to use filter
797cedc7
SH
2562 */
2563 public function prepare_for_view(stdClass $course, array $coursestoload, $ignorefilters = false) {
2564 $this->courseid = $course->id;
2565 $this->course = $course;
2566 list($courses, $group, $user) = calendar_set_filters($coursestoload, $ignorefilters);
2567 $this->courses = $courses;
2568 $this->groups = $group;
2569 $this->users = $user;
2570 }
2571
36dc3b71
SH
2572 /**
2573 * Ensures the date for the calendar is correct and either sets it to now
2574 * or throws a moodle_exception if not
2575 *
08b4a4e1
RW
2576 * @param bool $defaultonow use current time
2577 * @throws moodle_exception
2578 * @return bool validation of checkdate
36dc3b71
SH
2579 */
2580 public function checkdate($defaultonow = true) {
2581 if (!checkdate($this->month, $this->day, $this->year)) {
2582 if ($defaultonow) {
2583 $now = usergetdate(time());
2584 $this->day = intval($now['mday']);
2585 $this->month = intval($now['mon']);
2586 $this->year = intval($now['year']);
2587 return true;
2588 } else {
2589 throw new moodle_exception('invaliddate');
2590 }
2591 }
2592 return true;
2593 }
2594 /**
2595 * Gets todays timestamp for the calendar
08b4a4e1
RW
2596 *
2597 * @return int today timestamp
36dc3b71
SH
2598 */
2599 public function timestamp_today() {
2600 return make_timestamp($this->year, $this->month, $this->day);
2601 }
2602 /**
2603 * Gets tomorrows timestamp for the calendar
08b4a4e1
RW
2604 *
2605 * @return int tomorrow timestamp
36dc3b71
SH
2606 */
2607 public function timestamp_tomorrow() {
2608 return make_timestamp($this->year, $this->month, $this->day+1);
2609 }
2610 /**
2611 * Adds the pretend blocks for teh calendar
2612 *
2613 * @param core_calendar_renderer $renderer
08b4a4e1
RW
2614 * @param bool $showfilters display filters, false is set as default
2615 * @param string|null $view preference view options (eg: day, month, upcoming)
36dc3b71
SH
2616 */
2617 public function add_sidecalendar_blocks(core_calendar_renderer $renderer, $showfilters=false, $view=null) {
2618 if ($showfilters) {
2619 $filters = new block_contents();
2620 $filters->content = $renderer->fake_block_filters($this->courseid, $this->day, $this->month, $this->year, $view, $this->courses);
2621 $filters->footer = '';
2622 $filters->title = get_string('eventskey', 'calendar');
2623 $renderer->add_pretend_calendar_block($filters, BLOCK_POS_RIGHT);
2624 }
2625 $block = new block_contents;
2626 $block->content = $renderer->fake_block_threemonths($this);
2627 $block->footer = '';
2628 $block->title = get_string('monthlyview', 'calendar');
2629 $renderer->add_pretend_calendar_block($block, BLOCK_POS_RIGHT);
2630 }
1d5bd3d2 2631}