c6c7c689c0176dc2d3738948ad0770de33401602
[moodle.git] / calendar / classes / local / event / data_access / event_vault.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  * Event vault class
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\local\event\data_access;
27 defined('MOODLE_INTERNAL') || die();
29 use core_calendar\local\event\entities\action_event_interface;
30 use core_calendar\local\event\entities\event_interface;
31 use core_calendar\local\event\exceptions\limit_invalid_parameter_exception;
32 use core_calendar\local\event\factories\action_factory_interface;
33 use core_calendar\local\event\factories\event_factory_interface;
34 use core_calendar\local\event\strategies\raw_event_retrieval_strategy_interface;
36 /**
37  * Event vault class.
38  *
39  * This class will handle interacting with the database layer to retrieve
40  * the records. This is required to house the complex logic required for
41  * pagination because it's not a one-to-one mapping between database records
42  * and users.
43  *
44  * This is a repository. It's called a vault to reduce confusion because
45  * Moodle has already taken the name repository. Vault is cooler anyway.
46  *
47  * @copyright 2017 Ryan Wyllie <ryan@moodle.com>
48  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
49  */
50 class event_vault implements event_vault_interface {
52     /**
53      * @var event_factory_interface $factory Factory for creating events.
54      */
55     protected $factory;
57     /**
58      * @var raw_event_retrieval_strategy_interface $retrievalstrategy Strategy for getting events from the DB.
59      */
60     protected $retrievalstrategy;
62     /**
63      * Create an event vault.
64      *
65      * @param event_factory_interface $factory An event factory
66      * @param raw_event_retrieval_strategy_interface $retrievalstrategy
67      */
68     public function __construct(
69         event_factory_interface $factory,
70         raw_event_retrieval_strategy_interface $retrievalstrategy
71     ) {
72         $this->factory = $factory;
73         $this->retrievalstrategy = $retrievalstrategy;
74     }
76     public function get_event_by_id($id) {
77         global $DB;
79         if ($record = $DB->get_record('event', ['id' => $id])) {
80             return $this->transform_from_database_record($record);
81         } else {
82             return false;
83         }
84     }
86     public function get_events(
87         $timestartfrom = null,
88         $timestartto = null,
89         $timesortfrom = null,
90         $timesortto = null,
91         event_interface $timestartafterevent = null,
92         event_interface $timesortafterevent = null,
93         $limitnum = 20,
94         $type = null,
95         array $usersfilter = null,
96         array $groupsfilter = null,
97         array $coursesfilter = null,
98         $withduration = true,
99         $ignorehidden = true,
100         callable $filter = null
101     ) {
102         if ($limitnum < 1 || $limitnum > 50) {
103             throw new limit_invalid_parameter_exception("Limit must be between 1 and 50 (inclusive)");
104         }
106         $fromquery = function($field, $timefrom, $lastseenmethod, $afterevent, $withduration) {
107             if (!$timefrom) {
108                 return false;
109             }
111             return $this->timefield_pagination_from(
112                 $field,
113                 $timefrom,
114                 $afterevent ? $afterevent->get_times()->{$lastseenmethod}()->getTimestamp() : null,
115                 $afterevent ? $afterevent->get_id() : null,
116                 $withduration
117             );
118         };
120         $toquery = function($field, $timeto, $lastseenmethod, $afterevent) {
121             if (!$timeto) {
122                 return false;
123             }
125             return $this->timefield_pagination_to(
126                 $field,
127                 $timeto,
128                 $afterevent ? $afterevent->get_times()->{$lastseenmethod}()->getTimestamp() : null,
129                 $afterevent ? $afterevent->get_id() : null
130             );
131         };
133         $timesortfromquery = $fromquery('timesort', $timesortfrom, 'get_sort_time', $timesortafterevent, $withduration);
134         $timesorttoquery = $toquery('timesort', $timesortto, 'get_sort_time', $timesortafterevent);
135         $timestartfromquery = $fromquery('timestart', $timestartfrom, 'get_start_time', $timestartafterevent, $withduration);
136         $timestarttoquery = $toquery('timestart', $timestartto, 'get_start_time', $timestartafterevent);
138         if (($timesortto && !$timesorttoquery) || ($timestartto && !$timestarttoquery)) {
139             return [];
140         }
142         $params = array_merge(
143             $type ? ['type' => $type] : [],
144             $timesortfromquery ? $timesortfromquery['params'] : [],
145             $timesorttoquery ? $timesorttoquery['params'] : [],
146             $timestartfromquery ? $timestartfromquery['params'] : [],
147             $timestarttoquery ? $timestarttoquery['params'] : []
148         );
150         $where = array_merge(
151             $type ? ['type = :type'] : [],
152             $timesortfromquery ? $timesortfromquery['where'] : [],
153             $timesorttoquery ? $timesorttoquery['where'] : [],
154             $timestartfromquery ? $timestartfromquery['where'] : [],
155             $timestarttoquery ? $timestarttoquery['where'] : []
156         );
158         $offset = 0;
159         $events = [];
161         while ($records = array_values($this->retrievalstrategy->get_raw_events(
162             $usersfilter,
163             $groupsfilter,
164             $coursesfilter,
165             $where,
166             $params,
167             "COALESCE(e.timesort, e.timestart) ASC, e.id ASC",
168             $offset,
169             $limitnum,
170             $ignorehidden
171         ))) {
172             foreach ($records as $record) {
173                 if ($event = $this->transform_from_database_record($record)) {
174                     $filtertest = $filter ? $filter($event) : true;
176                     if ($event && $filtertest) {
177                         $events[] = $event;
178                     }
180                     if (count($events) == $limitnum) {
181                         // We've got all of the events so break both loops.
182                         break 2;
183                     }
184                 }
185             }
187             $offset += $limitnum;
188         }
190         return $events;
191     }
193     public function get_action_events_by_timesort(
194         \stdClass $user,
195         $timesortfrom = null,
196         $timesortto = null,
197         event_interface $afterevent = null,
198         $limitnum = 20
199     ) {
200         $courseids = array_map(function($course) {
201             return $course->id;
202         }, enrol_get_all_users_courses($user->id));
204         $groupids = array_reduce($courseids, function($carry, $courseid) use ($user) {
205             $groupings = groups_get_user_groups($courseid, $user->id);
206             // Grouping 0 is all groups.
207             return array_merge($carry, $groupings[0]);
208         }, []);
210         return $this->get_events(
211             null,
212             null,
213             $timesortfrom,
214             $timesortto,
215             null,
216             $afterevent,
217             $limitnum,
218             CALENDAR_EVENT_TYPE_ACTION,
219             [$user->id],
220             $groupids ? $groupids : null,
221             $courseids ? $courseids : null,
222             true,
223             true,
224             function ($event) {
225                 return $event instanceof action_event_interface;
226             }
227         );
228     }
230     public function get_action_events_by_course(
231         \stdClass $user,
232         \stdClass $course,
233         $timesortfrom = null,
234         $timesortto = null,
235         event_interface $afterevent = null,
236         $limitnum = 20
237     ) {
238         $groupings = groups_get_user_groups($course->id, $user->id);
239         return array_values(
240             $this->get_events(
241                 null,
242                 null,
243                 $timesortfrom,
244                 $timesortto,
245                 null,
246                 $afterevent,
247                 $limitnum,
248                 CALENDAR_EVENT_TYPE_ACTION,
249                 [$user->id],
250                 $groupings[0] ? $groupings[0] : null,
251                 [$course->id],
252                 true,
253                 true,
254                 function ($event) use ($course) {
255                     return $event instanceof action_event_interface && $event->get_course()->get('id') == $course->id;
256                 }
257             )
258         );
259     }
261     /**
262      * Generates SQL subquery and parameters for 'from' pagination.
263      *
264      * @param string    $field
265      * @param int       $timefrom
266      * @param int|null  $lastseentime
267      * @param int|null  $lastseenid
268      * @param bool      $withduration
269      * @return array
270      */
271     protected function timefield_pagination_from(
272         $field,
273         $timefrom,
274         $lastseentime = null,
275         $lastseenid = null,
276         $withduration = true
277     ) {
278         $where = '';
279         $params = [];
281         if ($lastseentime && $lastseentime >= $timefrom) {
282             $where = '((timesort = :timefrom1 AND e.id > :timefromid) OR timesort > :timefrom2)';
283             if ($field === 'timestart') {
284                 $where = '((timestart = :timefrom1 AND e.id > :timefromid) OR timestart > :timefrom2' .
285                        ($withduration ? ' OR timestart + timeduration > :timefrom3' : '') . ')';
286             }
287             $params['timefromid'] = $lastseenid;
288             $params['timefrom1'] = $lastseentime;
289             $params['timefrom2'] = $lastseentime;
290             $params['timefrom3'] = $lastseentime;
291         } else {
292             $where = 'timesort >= :timefrom';
293             if ($field === 'timestart') {
294                 $where = '(timestart >= :timefrom' .
295                        ($withduration ? ' OR timestart + timeduration > :timefrom2' : '') . ')';
296             }
298             $params['timefrom'] = $timefrom;
299             $params['timefrom2'] = $timefrom;
300         }
302         return ['where' => [$where], 'params' => $params];
303     }
305     /**
306      * Generates SQL subquery and parameters for 'to' pagination.
307      *
308      * @param string   $field
309      * @param int      $timeto
310      * @param int|null $lastseentime
311      * @param int|null $lastseenid
312      * @return array|bool
313      */
314     protected function timefield_pagination_to(
315         $field,
316         $timeto,
317         $lastseentime = null,
318         $lastseenid = null
319     ) {
320         $where = [];
321         $params = [];
323         if ($lastseentime && $lastseentime > $timeto) {
324             // The last seen event from this set is after the time sort range which
325             // means all events in this range have been seen, so we can just return
326             // early here.
327             return false;
328         } else if ($lastseentime && $lastseentime == $timeto) {
329             $where[] = '((timesort = :timeto1 AND e.id > :timetoid) OR timesort < :timeto2)';
330             if ($field === 'timestart') {
331                 $where[] = '((timestart = :timeto1 AND e.id > :timetoid) OR timestart < :timeto2)';
332             }
333             $params['timetoid'] = $lastseenid;
334             $params['timeto1'] = $timeto;
335             $params['timeto2'] = $timeto;
336         } else {
337             $where[] = ($field === 'timestart' ? 'timestart' : 'timesort') . ' <= :timeto';
338             $params['timeto'] = $timeto;
339         }
341         return ['where' => $where, 'params' => $params];
342     }
344     /**
345      * Create an event from a database record.
346      *
347      * @param \stdClass $record The database record
348      * @return event_interface|null
349      */
350     protected function transform_from_database_record(\stdClass $record) {
351         return $this->factory->create_instance($record);
352     }
354     /**
355      * Fetches records from DB.
356      *
357      * @param int    $userid
358      * @param string $whereconditions
359      * @param array  $whereparams
360      * @param string $ordersql
361      * @param int    $offset
362      * @param int    $limitnum
363      * @return array
364      */
365     protected function get_from_db(
366         $userid,
367         $whereconditions,
368         $whereparams,
369         $ordersql,
370         $offset,
371         $limitnum
372     ) {
373         return array_values(
374             $this->retrievalstrategy->get_raw_events(
375                 [$userid],
376                 null,
377                 null,
378                 $whereconditions,
379                 $whereparams,
380                 $ordersql,
381                 $offset,
382                 $limitnum
383             )
384         );
385     }