MDL-60963 calendar: use related cache for module instances in export
[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;
97         // By default all events that can be edited are
98         // draggable.
99         $values['draggable'] = $values['canedit'];
101         if ($moduleproxy = $event->get_course_module()) {
102             $modulename = $moduleproxy->get('modname');
103             $moduleid = $moduleproxy->get('id');
104             $url = new \moodle_url(sprintf('/mod/%s/view.php', $modulename), ['id' => $moduleid]);
106             // Build edit event url for action events.
107             $params = array('update' => $moduleid, 'return' => true, 'sesskey' => sesskey());
108             $editurl = new \moodle_url('/course/mod.php', $params);
109             $values['editurl'] = $editurl->out(false);
110         } else if ($event->get_type() == 'category') {
111             $url = $event->get_category()->get_proxied_instance()->get_view_link();
112         } else if ($event->get_type() == 'course') {
113             $url = course_get_url($event->get_course()->get('id') ?: SITEID);
114         } else {
115             // TODO MDL-58866 We do not have any way to find urls for events outside of course modules.
116             $course = $event->get_course()->get('id') ?: SITEID;
117             $url = course_get_url($course);
118         }
120         $values['url'] = $url->out(false);
121         $values['islastday'] = false;
122         $today = $this->related['type']->timestamp_to_date_array($this->related['today']);
124         $values['popupname'] = $this->event->get_name();
126         $times = $this->event->get_times();
127         if ($duration = $times->get_duration()) {
128             $enddate = $this->related['type']->timestamp_to_date_array($times->get_end_time()->getTimestamp());
129             $values['islastday'] = true;
130             $values['islastday'] = $values['islastday'] && $enddate['year'] == $today['year'];
131             $values['islastday'] = $values['islastday'] && $enddate['mon'] == $today['mon'];
132             $values['islastday'] = $values['islastday'] && $enddate['mday'] == $today['mday'];
133         }
135         $subscription = $this->event->get_subscription();
136         if ($subscription && !empty($subscription->get('id')) && $CFG->calendar_showicalsource) {
137             $a = (object) [
138                 'name' => $values['popupname'],
139                 'source' => $subscription->get('name'),
140             ];
141             $values['popupname'] = get_string('namewithsource', 'calendar', $a);
142         } else {
143             if ($values['islastday']) {
144                 $startdate = $this->related['type']->timestamp_to_date_array($times->get_start_time()->getTimestamp());
145                 $samedate = true;
146                 $samedate = $samedate && $startdate['mon'] == $enddate['mon'];
147                 $samedate = $samedate && $startdate['year'] == $enddate['year'];
148                 $samedate = $samedate && $startdate['mday'] == $enddate['mday'];
150                 if (!$samedate) {
151                     $values['popupname'] = get_string('eventendtimewrapped', 'calendar', $values['popupname']);
152                 }
153             }
154         }
156         // Include category name into the event name, if applicable.
157         $proxy = $this->event->get_category();
158         if ($proxy && $proxy->get('id')) {
159             $category = $proxy->get_proxied_instance();
160             $eventnameparams = (object) [
161                 'name' => $values['popupname'],
162                 'category' => $category->get_formatted_name(),
163             ];
164             $values['popupname'] = get_string('eventnameandcategory', 'calendar', $eventnameparams);
165         }
167         // Include course's shortname into the event name, if applicable.
168         $course = $this->event->get_course();
169         if ($course && $course->get('id') && $course->get('id') !== SITEID) {
170             $eventnameparams = (object) [
171                 'name' => $values['popupname'],
172                 'course' => format_string($course->get('shortname'), true, [
173                         'context' => $this->related['context'],
174                     ])
175             ];
176             $values['popupname'] = get_string('eventnameandcourse', 'calendar', $eventnameparams);
177         }
179         $values['calendareventtype'] = $this->get_calendar_event_type();
181         if ($event->get_course_module()) {
182             $values = array_merge($values, $this->get_module_timestamp_limits($event));
183         }
185         return $values;
186     }
188     /**
189      * Returns a list of objects that are related.
190      *
191      * @return array
192      */
193     protected static function define_related() {
194         $related = parent::define_related();
195         $related['daylink'] = \moodle_url::class;
196         $related['type'] = '\core_calendar\type_base';
197         $related['today'] = 'int';
198         $related['moduleinstance'] = 'stdClass?';
200         return $related;
201     }
203     /**
204      * Return the normalised event type.
205      * Activity events are normalised to be course events.
206      *
207      * @return string
208      */
209     public function get_calendar_event_type() {
210         if ($this->event->get_course_module()) {
211             return 'course';
212         }
214         return $this->event->get_type();
215     }
217     /**
218      * Return the set of minimum and maximum date timestamp values
219      * for the given event.
220      *
221      * @param event_interface $event
222      * @return array
223      */
224     protected function get_module_timestamp_limits($event) {
225         $values = [];
226         $mapper = container::get_event_mapper();
227         $starttime = $event->get_times()->get_start_time();
228         $modname = $event->get_course_module()->get('modname');
229         $moduleinstance = $this->related['moduleinstance'];
231         list($min, $max) = component_callback(
232             'mod_' . $modname,
233             'core_calendar_get_valid_event_timestart_range',
234             [$mapper->from_event_to_legacy_event($event), $moduleinstance],
235             [false, false]
236         );
238         // The callback will return false for either of the
239         // min or max cutoffs to indicate that there are no
240         // valid timestart values. In which case the event is
241         // not draggable.
242         if ($min === false || $max === false) {
243             return ['draggable' => false];
244         }
246         if ($min) {
247             $values = array_merge($values, $this->get_module_timestamp_min_limit($starttime, $min));
248         }
250         if ($max) {
251             $values = array_merge($values, $this->get_module_timestamp_max_limit($starttime, $max));
252         }
254         return $values;
255     }
257     /**
258      * Get the correct minimum midnight day limit based on the event start time
259      * and the module's minimum timestamp limit.
260      *
261      * @param DateTimeInterface $starttime The event start time
262      * @param array $min The module's minimum limit for the event
263      */
264     protected function get_module_timestamp_min_limit(\DateTimeInterface $starttime, $min) {
265         // We need to check that the minimum valid time is earlier in the
266         // day than the current event time so that if the user drags and drops
267         // the event to this day (which changes the date but not the time) it
268         // will result in a valid time start for the event.
269         //
270         // For example:
271         // An event that starts on 2017-01-10 08:00 with a minimum cutoff
272         // of 2017-01-05 09:00 means that 2017-01-05 is not a valid start day
273         // for the drag and drop because it would result in the event start time
274         // being set to 2017-01-05 08:00, which is invalid. Instead the minimum
275         // valid start day would be 2017-01-06.
276         $values = [];
277         $timestamp = $min[0];
278         $errorstring = $min[1];
279         $mindate = (new \DateTimeImmutable())->setTimestamp($timestamp);
280         $minstart = $mindate->setTime(
281             $starttime->format('H'),
282             $starttime->format('i'),
283             $starttime->format('s')
284         );
285         $midnight = usergetmidnight($timestamp);
287         if ($mindate <= $minstart) {
288             $values['mindaytimestamp'] = $midnight;
289         } else {
290             $tomorrow = (new \DateTime())->setTimestamp($midnight)->modify('+1 day');
291             $values['mindaytimestamp'] = $tomorrow->getTimestamp();
292         }
294         // Get the human readable error message to display if the min day
295         // timestamp is violated.
296         $values['mindayerror'] = $errorstring;
297         return $values;
298     }
300     /**
301      * Get the correct maximum midnight day limit based on the event start time
302      * and the module's maximum timestamp limit.
303      *
304      * @param DateTimeInterface $starttime The event start time
305      * @param array $max The module's maximum limit for the event
306      */
307     protected function get_module_timestamp_max_limit(\DateTimeInterface $starttime, $max) {
308         // We're doing a similar calculation here as we are for the minimum
309         // day timestamp. See the explanation above.
310         $values;
311         $timestamp = $max[0];
312         $errorstring = $max[1];
313         $maxdate = (new \DateTimeImmutable())->setTimestamp($timestamp);
314         $maxstart = $maxdate->setTime(
315             $starttime->format('H'),
316             $starttime->format('i'),
317             $starttime->format('s')
318         );
319         $midnight = usergetmidnight($timestamp);
321         if ($maxdate >= $maxstart) {
322             $values['maxdaytimestamp'] = $midnight;
323         } else {
324             $yesterday = (new \DateTime())->setTimestamp($midnight)->modify('-1 day');
325             $values['maxdaytimestamp'] = $yesterday->getTimestamp();
326         }
328         // Get the human readable error message to display if the max day
329         // timestamp is violated.
330         $values['maxdayerror'] = $errorstring;
331         return $values;
332     }