f4b629f204e6add8b39164d48b07711c126a4942
[moodle.git] / calendar / classes / external / calendar_event_exporter.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Contains event class for displaying a calendar event.
19  *
20  * @package   core_calendar
21  * @copyright 2017 Ryan Wyllie <ryan@moodle.com>
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace core_calendar\external;
27 defined('MOODLE_INTERNAL') || die();
29 use \core_calendar\local\event\container;
30 use \core_course\external\course_summary_exporter;
31 use \renderer_base;
32 require_once($CFG->dirroot . '/course/lib.php');
33 /**
34  * Class for displaying a calendar event.
35  *
36  * @package   core_calendar
37  * @copyright 2017 Ryan Wyllie <ryan@moodle.com>
38  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
39  */
40 class calendar_event_exporter extends event_exporter_base {
42     /**
43      * Return the list of additional properties.
44      *
45      * @return array
46      */
47     protected static function define_other_properties() {
49         $values = parent::define_other_properties();
50         $values['url'] = ['type' => PARAM_URL];
51         $values['islastday'] = [
52             'type' => PARAM_BOOL,
53             'default' => false,
54         ];
55         $values['calendareventtype'] = [
56             'type' => PARAM_TEXT,
57         ];
58         $values['popupname'] = [
59             'type' => PARAM_RAW,
60         ];
61         $values['mindaytimestamp'] = [
62             'type' => PARAM_INT,
63             'optional' => true
64         ];
65         $values['mindayerror'] = [
66             'type' => PARAM_TEXT,
67             'optional' => true
68         ];
69         $values['maxdaytimestamp'] = [
70             'type' => PARAM_INT,
71             'optional' => true
72         ];
73         $values['maxdayerror'] = [
74             'type' => PARAM_TEXT,
75             'optional' => true
76         ];
77         $values['draggable'] = [
78             'type' => PARAM_BOOL,
79             'default' => false
80         ];
82         return $values;
83     }
85     /**
86      * Get the additional values to inject while exporting.
87      *
88      * @param renderer_base $output The renderer.
89      * @return array Keys are the property names, values are their values.
90      */
91     protected function get_other_values(renderer_base $output) {
92         global $CFG;
94         $values = parent::get_other_values($output);
95         $event = $this->event;
96         $course = $this->related['course'];
97         $hascourse = !empty($course);
99         // By default all events that can be edited are
100         // draggable.
101         $values['draggable'] = $values['canedit'];
103         if ($moduleproxy = $event->get_course_module()) {
104             $modulename = $moduleproxy->get('modname');
105             $moduleid = $moduleproxy->get('id');
106             $url = new \moodle_url(sprintf('/mod/%s/view.php', $modulename), ['id' => $moduleid]);
108             // Build edit event url for action events.
109             $params = array('update' => $moduleid, 'return' => true, 'sesskey' => sesskey());
110             $editurl = new \moodle_url('/course/mod.php', $params);
111             $values['editurl'] = $editurl->out(false);
112         } else if ($event->get_type() == 'category') {
113             $url = $event->get_category()->get_proxied_instance()->get_view_link();
114         } else {
115             // TODO MDL-58866 We do not have any way to find urls for events outside of course modules.
116             $url = course_get_url($hascourse ? $course : SITEID);
117         }
119         $values['url'] = $url->out(false);
120         $values['islastday'] = false;
121         $today = $this->related['type']->timestamp_to_date_array($this->related['today']);
123         $values['popupname'] = $this->event->get_name();
125         $times = $this->event->get_times();
126         if ($duration = $times->get_duration()) {
127             $enddate = $this->related['type']->timestamp_to_date_array($times->get_end_time()->getTimestamp());
128             $values['islastday'] = true;
129             $values['islastday'] = $values['islastday'] && $enddate['year'] == $today['year'];
130             $values['islastday'] = $values['islastday'] && $enddate['mon'] == $today['mon'];
131             $values['islastday'] = $values['islastday'] && $enddate['mday'] == $today['mday'];
132         }
134         $subscription = $this->event->get_subscription();
135         if ($subscription && !empty($subscription->get('id')) && $CFG->calendar_showicalsource) {
136             $a = (object) [
137                 'name' => $values['popupname'],
138                 'source' => $subscription->get('name'),
139             ];
140             $values['popupname'] = get_string('namewithsource', 'calendar', $a);
141         } else {
142             if ($values['islastday']) {
143                 $startdate = $this->related['type']->timestamp_to_date_array($times->get_start_time()->getTimestamp());
144                 $samedate = true;
145                 $samedate = $samedate && $startdate['mon'] == $enddate['mon'];
146                 $samedate = $samedate && $startdate['year'] == $enddate['year'];
147                 $samedate = $samedate && $startdate['mday'] == $enddate['mday'];
149                 if (!$samedate) {
150                     $values['popupname'] = get_string('eventendtimewrapped', 'calendar', $values['popupname']);
151                 }
152             }
153         }
155         // Include category name into the event name, if applicable.
156         $proxy = $this->event->get_category();
157         if ($proxy && $proxy->get('id')) {
158             $category = $proxy->get_proxied_instance();
159             $eventnameparams = (object) [
160                 'name' => $values['popupname'],
161                 'category' => $category->get_formatted_name(),
162             ];
163             $values['popupname'] = get_string('eventnameandcategory', 'calendar', $eventnameparams);
164         }
166         // Include course's shortname into the event name, if applicable.
167         if ($hascourse && $course->id !== SITEID) {
168             $eventnameparams = (object) [
169                 'name' => $values['popupname'],
170                 'course' => $values['course']->shortname,
171             ];
172             $values['popupname'] = get_string('eventnameandcourse', 'calendar', $eventnameparams);
173         }
175         $values['calendareventtype'] = $this->get_calendar_event_type();
177         if ($event->get_course_module()) {
178             $values = array_merge($values, $this->get_module_timestamp_limits($event));
179         } else if ($hascourse && $course->id != SITEID && empty($event->get_group())) {
180             // This is a course event.
181             $values = array_merge($values, $this->get_course_timestamp_limits($event));
182         }
184         return $values;
185     }
187     /**
188      * Returns a list of objects that are related.
189      *
190      * @return array
191      */
192     protected static function define_related() {
193         $related = parent::define_related();
194         $related['daylink'] = \moodle_url::class;
195         $related['type'] = '\core_calendar\type_base';
196         $related['today'] = 'int';
197         $related['moduleinstance'] = 'stdClass?';
199         return $related;
200     }
202     /**
203      * Return the normalised event type.
204      * Activity events are normalised to be course events.
205      *
206      * @return string
207      */
208     public function get_calendar_event_type() {
209         if ($this->event->get_course_module()) {
210             return 'course';
211         }
213         return $this->event->get_type();
214     }
216     /**
217      * Return the set of minimum and maximum date timestamp values
218      * for the given event.
219      *
220      * @param event_interface $event
221      * @return array
222      */
223     protected function get_course_timestamp_limits($event) {
224         $values = [];
225         $mapper = container::get_event_mapper();
226         $starttime = $event->get_times()->get_start_time();
228         list($min, $max) = component_callback(
229             'core_course',
230             'core_calendar_get_valid_event_timestart_range',
231             [$mapper->from_event_to_legacy_event($event), $event->get_course()->get_proxied_instance()],
232             [false, false]
233         );
235         // The callback will return false for either of the
236         // min or max cutoffs to indicate that there are no
237         // valid timestart values. In which case the event is
238         // not draggable.
239         if ($min === false || $max === false) {
240             return ['draggable' => false];
241         }
243         if ($min) {
244             $values = array_merge($values, $this->get_timestamp_min_limit($starttime, $min));
245         }
247         if ($max) {
248             $values = array_merge($values, $this->get_timestamp_max_limit($starttime, $max));
249         }
251         return $values;
252     }
254     /**
255      * Return the set of minimum and maximum date timestamp values
256      * for the given event.
257      *
258      * @param event_interface $event
259      * @return array
260      */
261     protected function get_module_timestamp_limits($event) {
262         $values = [];
263         $mapper = container::get_event_mapper();
264         $starttime = $event->get_times()->get_start_time();
265         $modname = $event->get_course_module()->get('modname');
266         $moduleinstance = $this->related['moduleinstance'];
268         list($min, $max) = component_callback(
269             'mod_' . $modname,
270             'core_calendar_get_valid_event_timestart_range',
271             [$mapper->from_event_to_legacy_event($event), $moduleinstance],
272             [false, false]
273         );
275         // The callback will return false for either of the
276         // min or max cutoffs to indicate that there are no
277         // valid timestart values. In which case the event is
278         // not draggable.
279         if ($min === false || $max === false) {
280             return ['draggable' => false];
281         }
283         if ($min) {
284             $values = array_merge($values, $this->get_timestamp_min_limit($starttime, $min));
285         }
287         if ($max) {
288             $values = array_merge($values, $this->get_timestamp_max_limit($starttime, $max));
289         }
291         return $values;
292     }
294     /**
295      * Get the correct minimum midnight day limit based on the event start time
296      * and the minimum timestamp limit of what the event belongs to.
297      *
298      * @param DateTimeInterface $starttime The event start time
299      * @param array $min The module's minimum limit for the event
300      * @return array Returns an array with mindaytimestamp and mindayerror keys.
301      */
302     protected function get_timestamp_min_limit(\DateTimeInterface $starttime, $min) {
303         // We need to check that the minimum valid time is earlier in the
304         // day than the current event time so that if the user drags and drops
305         // the event to this day (which changes the date but not the time) it
306         // will result in a valid time start for the event.
307         //
308         // For example:
309         // An event that starts on 2017-01-10 08:00 with a minimum cutoff
310         // of 2017-01-05 09:00 means that 2017-01-05 is not a valid start day
311         // for the drag and drop because it would result in the event start time
312         // being set to 2017-01-05 08:00, which is invalid. Instead the minimum
313         // valid start day would be 2017-01-06.
314         $values = [];
315         $timestamp = $min[0];
316         $errorstring = $min[1];
317         $mindate = (new \DateTimeImmutable())->setTimestamp($timestamp);
318         $minstart = $mindate->setTime(
319             $starttime->format('H'),
320             $starttime->format('i'),
321             $starttime->format('s')
322         );
323         $midnight = usergetmidnight($timestamp);
325         if ($mindate <= $minstart) {
326             $values['mindaytimestamp'] = $midnight;
327         } else {
328             $tomorrow = (new \DateTime())->setTimestamp($midnight)->modify('+1 day');
329             $values['mindaytimestamp'] = $tomorrow->getTimestamp();
330         }
332         // Get the human readable error message to display if the min day
333         // timestamp is violated.
334         $values['mindayerror'] = $errorstring;
335         return $values;
336     }
338     /**
339      * Get the correct maximum midnight day limit based on the event start time
340      * and the maximum timestamp limit of what the event belongs to.
341      *
342      * @param DateTimeInterface $starttime The event start time
343      * @param array $max The module's maximum limit for the event
344      * @return array Returns an array with maxdaytimestamp and maxdayerror keys.
345      */
346     protected function get_timestamp_max_limit(\DateTimeInterface $starttime, $max) {
347         // We're doing a similar calculation here as we are for the minimum
348         // day timestamp. See the explanation above.
349         $values = [];
350         $timestamp = $max[0];
351         $errorstring = $max[1];
352         $maxdate = (new \DateTimeImmutable())->setTimestamp($timestamp);
353         $maxstart = $maxdate->setTime(
354             $starttime->format('H'),
355             $starttime->format('i'),
356             $starttime->format('s')
357         );
358         $midnight = usergetmidnight($timestamp);
360         if ($maxdate >= $maxstart) {
361             $values['maxdaytimestamp'] = $midnight;
362         } else {
363             $yesterday = (new \DateTime())->setTimestamp($midnight)->modify('-1 day');
364             $values['maxdaytimestamp'] = $yesterday->getTimestamp();
365         }
367         // Get the human readable error message to display if the max day
368         // timestamp is violated.
369         $values['maxdayerror'] = $errorstring;
370         return $values;
371     }
373     /**
374      * Get the correct minimum midnight day limit based on the event start time
375      * and the module's minimum timestamp limit.
376      *
377      * @deprecated since Moodle 3.6. Please use get_timestamp_min_limit().
378      * @todo final deprecation. To be removed in Moodle 4.0
379      * @param DateTimeInterface $starttime The event start time
380      * @param array $min The module's minimum limit for the event
381      * @return array Returns an array with mindaytimestamp and mindayerror keys.
382      */
383     protected function get_module_timestamp_min_limit(\DateTimeInterface $starttime, $min) {
384         debugging('get_module_timestamp_min_limit() has been deprecated. Please call get_timestamp_min_limit() instead.',
385                 DEBUG_DEVELOPER);
386         return $this->get_timestamp_min_limit($starttime, $min);
387     }
389     /**
390      * Get the correct maximum midnight day limit based on the event start time
391      * and the module's maximum timestamp limit.
392      *
393      * @deprecated since Moodle 3.6. Please use get_timestamp_max_limit().
394      * @todo final deprecation. To be removed in Moodle 4.0
395      * @param DateTimeInterface $starttime The event start time
396      * @param array $max The module's maximum limit for the event
397      * @return array Returns an array with maxdaytimestamp and maxdayerror keys.
398      */
399     protected function get_module_timestamp_max_limit(\DateTimeInterface $starttime, $max) {
400         debugging('get_module_timestamp_max_limit() has been deprecated. Please call get_timestamp_max_limit() instead.',
401                 DEBUG_DEVELOPER);
402         return $this->get_timestamp_max_limit($starttime, $max);
403     }