Merge branch 'MDL-65318-master' of git://github.com/lameze/moodle
[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['popupname'] = [
56             'type' => PARAM_RAW,
57         ];
58         $values['mindaytimestamp'] = [
59             'type' => PARAM_INT,
60             'optional' => true
61         ];
62         $values['mindayerror'] = [
63             'type' => PARAM_TEXT,
64             'optional' => true
65         ];
66         $values['maxdaytimestamp'] = [
67             'type' => PARAM_INT,
68             'optional' => true
69         ];
70         $values['maxdayerror'] = [
71             'type' => PARAM_TEXT,
72             'optional' => true
73         ];
74         $values['draggable'] = [
75             'type' => PARAM_BOOL,
76             'default' => false
77         ];
79         return $values;
80     }
82     /**
83      * Get the additional values to inject while exporting.
84      *
85      * @param renderer_base $output The renderer.
86      * @return array Keys are the property names, values are their values.
87      */
88     protected function get_other_values(renderer_base $output) {
89         global $CFG;
91         $values = parent::get_other_values($output);
92         $event = $this->event;
93         $course = $this->related['course'];
94         $hascourse = !empty($course);
96         // By default all events that can be edited are
97         // draggable.
98         $values['draggable'] = $values['canedit'];
100         if ($moduleproxy = $event->get_course_module()) {
101             $modulename = $moduleproxy->get('modname');
102             $moduleid = $moduleproxy->get('id');
103             $url = new \moodle_url(sprintf('/mod/%s/view.php', $modulename), ['id' => $moduleid]);
105             // Build edit event url for action events.
106             $params = array('update' => $moduleid, 'return' => true, 'sesskey' => sesskey());
107             $editurl = new \moodle_url('/course/mod.php', $params);
108             $values['editurl'] = $editurl->out(false);
109         } else if ($event->get_type() == 'category') {
110             $url = $event->get_category()->get_proxied_instance()->get_view_link();
111         } else {
112             // TODO MDL-58866 We do not have any way to find urls for events outside of course modules.
113             $url = course_get_url($hascourse ? $course : SITEID);
114         }
116         $values['url'] = $url->out(false);
117         $values['islastday'] = false;
118         $today = $this->related['type']->timestamp_to_date_array($this->related['today']);
120         $values['popupname'] = $this->event->get_name();
122         $times = $this->event->get_times();
123         if ($duration = $times->get_duration()) {
124             $enddate = $this->related['type']->timestamp_to_date_array($times->get_end_time()->getTimestamp());
125             $values['islastday'] = true;
126             $values['islastday'] = $values['islastday'] && $enddate['year'] == $today['year'];
127             $values['islastday'] = $values['islastday'] && $enddate['mon'] == $today['mon'];
128             $values['islastday'] = $values['islastday'] && $enddate['mday'] == $today['mday'];
129         }
131         $subscription = $this->event->get_subscription();
132         if ($subscription && !empty($subscription->get('id')) && $CFG->calendar_showicalsource) {
133             $a = (object) [
134                 'name' => $values['popupname'],
135                 'source' => $subscription->get('name'),
136             ];
137             $values['popupname'] = get_string('namewithsource', 'calendar', $a);
138         } else {
139             if ($values['islastday']) {
140                 $startdate = $this->related['type']->timestamp_to_date_array($times->get_start_time()->getTimestamp());
141                 $samedate = true;
142                 $samedate = $samedate && $startdate['mon'] == $enddate['mon'];
143                 $samedate = $samedate && $startdate['year'] == $enddate['year'];
144                 $samedate = $samedate && $startdate['mday'] == $enddate['mday'];
146                 if (!$samedate) {
147                     $values['popupname'] = get_string('eventendtimewrapped', 'calendar', $values['popupname']);
148                 }
149             }
150         }
152         // Include category name into the event name, if applicable.
153         $proxy = $this->event->get_category();
154         if ($proxy && $proxy->get('id')) {
155             $category = $proxy->get_proxied_instance();
156             $eventnameparams = (object) [
157                 'name' => $values['popupname'],
158                 'category' => $category->get_formatted_name(),
159             ];
160             $values['popupname'] = get_string('eventnameandcategory', 'calendar', $eventnameparams);
161         }
163         // Include course's shortname into the event name, if applicable.
164         if ($hascourse && $course->id !== SITEID) {
165             $eventnameparams = (object) [
166                 'name' => $values['popupname'],
167                 'course' => $values['course']->shortname,
168             ];
169             $values['popupname'] = get_string('eventnameandcourse', 'calendar', $eventnameparams);
170         }
172         if ($event->get_course_module()) {
173             $values = array_merge($values, $this->get_module_timestamp_limits($event));
174         } else if ($hascourse && $course->id != SITEID && empty($event->get_group())) {
175             // This is a course event.
176             $values = array_merge($values, $this->get_course_timestamp_limits($event));
177         }
179         return $values;
180     }
182     /**
183      * Returns a list of objects that are related.
184      *
185      * @return array
186      */
187     protected static function define_related() {
188         $related = parent::define_related();
189         $related['daylink'] = \moodle_url::class;
190         $related['type'] = '\core_calendar\type_base';
191         $related['today'] = 'int';
192         $related['moduleinstance'] = 'stdClass?';
194         return $related;
195     }
197     /**
198      * Return the normalised event type.
199      * Activity events are normalised to be course events.
200      *
201      * @return string
202      */
203     public function get_calendar_event_type() {
204         if ($this->event->get_course_module()) {
205             return 'course';
206         }
208         return $this->event->get_type();
209     }
211     /**
212      * Return the set of minimum and maximum date timestamp values
213      * for the given event.
214      *
215      * @param event_interface $event
216      * @return array
217      */
218     protected function get_course_timestamp_limits($event) {
219         $values = [];
220         $mapper = container::get_event_mapper();
221         $starttime = $event->get_times()->get_start_time();
223         list($min, $max) = component_callback(
224             'core_course',
225             'core_calendar_get_valid_event_timestart_range',
226             [$mapper->from_event_to_legacy_event($event), $event->get_course()->get_proxied_instance()],
227             [false, false]
228         );
230         // The callback will return false for either of the
231         // min or max cutoffs to indicate that there are no
232         // valid timestart values. In which case the event is
233         // not draggable.
234         if ($min === false || $max === false) {
235             return ['draggable' => false];
236         }
238         if ($min) {
239             $values = array_merge($values, $this->get_timestamp_min_limit($starttime, $min));
240         }
242         if ($max) {
243             $values = array_merge($values, $this->get_timestamp_max_limit($starttime, $max));
244         }
246         return $values;
247     }
249     /**
250      * Return the set of minimum and maximum date timestamp values
251      * for the given event.
252      *
253      * @param event_interface $event
254      * @return array
255      */
256     protected function get_module_timestamp_limits($event) {
257         $values = [];
258         $mapper = container::get_event_mapper();
259         $starttime = $event->get_times()->get_start_time();
260         $modname = $event->get_course_module()->get('modname');
261         $moduleinstance = $this->related['moduleinstance'];
263         list($min, $max) = component_callback(
264             'mod_' . $modname,
265             'core_calendar_get_valid_event_timestart_range',
266             [$mapper->from_event_to_legacy_event($event), $moduleinstance],
267             [false, false]
268         );
270         // The callback will return false for either of the
271         // min or max cutoffs to indicate that there are no
272         // valid timestart values. In which case the event is
273         // not draggable.
274         if ($min === false || $max === false) {
275             return ['draggable' => false];
276         }
278         if ($min) {
279             $values = array_merge($values, $this->get_timestamp_min_limit($starttime, $min));
280         }
282         if ($max) {
283             $values = array_merge($values, $this->get_timestamp_max_limit($starttime, $max));
284         }
286         return $values;
287     }
289     /**
290      * Get the correct minimum midnight day limit based on the event start time
291      * and the minimum timestamp limit of what the event belongs to.
292      *
293      * @param DateTimeInterface $starttime The event start time
294      * @param array $min The module's minimum limit for the event
295      * @return array Returns an array with mindaytimestamp and mindayerror keys.
296      */
297     protected function get_timestamp_min_limit(\DateTimeInterface $starttime, $min) {
298         // We need to check that the minimum valid time is earlier in the
299         // day than the current event time so that if the user drags and drops
300         // the event to this day (which changes the date but not the time) it
301         // will result in a valid time start for the event.
302         //
303         // For example:
304         // An event that starts on 2017-01-10 08:00 with a minimum cutoff
305         // of 2017-01-05 09:00 means that 2017-01-05 is not a valid start day
306         // for the drag and drop because it would result in the event start time
307         // being set to 2017-01-05 08:00, which is invalid. Instead the minimum
308         // valid start day would be 2017-01-06.
309         $values = [];
310         $timestamp = $min[0];
311         $errorstring = $min[1];
312         $mindate = (new \DateTimeImmutable())->setTimestamp($timestamp);
313         $minstart = $mindate->setTime(
314             $starttime->format('H'),
315             $starttime->format('i'),
316             $starttime->format('s')
317         );
318         $midnight = usergetmidnight($timestamp);
320         if ($mindate <= $minstart) {
321             $values['mindaytimestamp'] = $midnight;
322         } else {
323             $tomorrow = (new \DateTime())->setTimestamp($midnight)->modify('+1 day');
324             $values['mindaytimestamp'] = $tomorrow->getTimestamp();
325         }
327         // Get the human readable error message to display if the min day
328         // timestamp is violated.
329         $values['mindayerror'] = $errorstring;
330         return $values;
331     }
333     /**
334      * Get the correct maximum midnight day limit based on the event start time
335      * and the maximum timestamp limit of what the event belongs to.
336      *
337      * @param DateTimeInterface $starttime The event start time
338      * @param array $max The module's maximum limit for the event
339      * @return array Returns an array with maxdaytimestamp and maxdayerror keys.
340      */
341     protected function get_timestamp_max_limit(\DateTimeInterface $starttime, $max) {
342         // We're doing a similar calculation here as we are for the minimum
343         // day timestamp. See the explanation above.
344         $values = [];
345         $timestamp = $max[0];
346         $errorstring = $max[1];
347         $maxdate = (new \DateTimeImmutable())->setTimestamp($timestamp);
348         $maxstart = $maxdate->setTime(
349             $starttime->format('H'),
350             $starttime->format('i'),
351             $starttime->format('s')
352         );
353         $midnight = usergetmidnight($timestamp);
355         if ($maxdate >= $maxstart) {
356             $values['maxdaytimestamp'] = $midnight;
357         } else {
358             $yesterday = (new \DateTime())->setTimestamp($midnight)->modify('-1 day');
359             $values['maxdaytimestamp'] = $yesterday->getTimestamp();
360         }
362         // Get the human readable error message to display if the max day
363         // timestamp is violated.
364         $values['maxdayerror'] = $errorstring;
365         return $values;
366     }
368     /**
369      * Get the correct minimum midnight day limit based on the event start time
370      * and the module's minimum timestamp limit.
371      *
372      * @deprecated since Moodle 3.6. Please use get_timestamp_min_limit().
373      * @todo final deprecation. To be removed in Moodle 4.0
374      * @param DateTimeInterface $starttime The event start time
375      * @param array $min The module's minimum limit for the event
376      * @return array Returns an array with mindaytimestamp and mindayerror keys.
377      */
378     protected function get_module_timestamp_min_limit(\DateTimeInterface $starttime, $min) {
379         debugging('get_module_timestamp_min_limit() has been deprecated. Please call get_timestamp_min_limit() instead.',
380                 DEBUG_DEVELOPER);
381         return $this->get_timestamp_min_limit($starttime, $min);
382     }
384     /**
385      * Get the correct maximum midnight day limit based on the event start time
386      * and the module's maximum timestamp limit.
387      *
388      * @deprecated since Moodle 3.6. Please use get_timestamp_max_limit().
389      * @todo final deprecation. To be removed in Moodle 4.0
390      * @param DateTimeInterface $starttime The event start time
391      * @param array $max The module's maximum limit for the event
392      * @return array Returns an array with maxdaytimestamp and maxdayerror keys.
393      */
394     protected function get_module_timestamp_max_limit(\DateTimeInterface $starttime, $max) {
395         debugging('get_module_timestamp_max_limit() has been deprecated. Please call get_timestamp_max_limit() instead.',
396                 DEBUG_DEVELOPER);
397         return $this->get_timestamp_max_limit($starttime, $max);
398     }