Merge branch 'MDL-60963-master' of git://github.com/ryanwyllie/moodle
authorDavid Monllao <davidm@moodle.com>
Wed, 17 Jan 2018 09:49:58 +0000 (10:49 +0100)
committerDavid Monllao <davidm@moodle.com>
Wed, 17 Jan 2018 09:49:58 +0000 (10:49 +0100)
calendar/classes/external/calendar_day_exporter.php
calendar/classes/external/calendar_event_exporter.php
calendar/classes/external/calendar_upcoming_exporter.php
calendar/classes/external/day_exporter.php
calendar/classes/external/events_related_objects_cache.php
calendar/tests/events_related_objects_cache_test.php [new file with mode: 0644]

index 5869c10..5e0b0cd 100644 (file)
@@ -154,9 +154,11 @@ class calendar_day_exporter extends exporter {
         $return['events'] = array_map(function($event) use ($cache, $output, $url) {
             $context = $cache->get_context($event);
             $course = $cache->get_course($event);
+            $moduleinstance = $cache->get_module_instance($event);
             $exporter = new calendar_event_exporter($event, [
                 'context' => $context,
                 'course' => $course,
+                'moduleinstance' => $moduleinstance,
                 'daylink' => $url,
                 'type' => $this->related['type'],
                 'today' => $this->calendar->time,
index fa8be8d..bd1d751 100644 (file)
@@ -191,6 +191,7 @@ class calendar_event_exporter extends event_exporter_base {
         $related['daylink'] = \moodle_url::class;
         $related['type'] = '\core_calendar\type_base';
         $related['today'] = 'int';
+        $related['moduleinstance'] = 'stdClass?';
 
         return $related;
     }
@@ -217,14 +218,11 @@ class calendar_event_exporter extends event_exporter_base {
      * @return array
      */
     protected function get_module_timestamp_limits($event) {
-        global $DB;
-
         $values = [];
         $mapper = container::get_event_mapper();
         $starttime = $event->get_times()->get_start_time();
         $modname = $event->get_course_module()->get('modname');
-        $modid = $event->get_course_module()->get('instance');
-        $moduleinstance = $DB->get_record($modname, ['id' => $modid]);
+        $moduleinstance = $this->related['moduleinstance'];
 
         list($min, $max) = component_callback(
             'mod_' . $modname,
index aead6d1..ab05aef 100644 (file)
@@ -113,9 +113,11 @@ class calendar_upcoming_exporter extends exporter {
         $return['events'] = array_map(function($event) use ($cache, $output, $url) {
             $context = $cache->get_context($event);
             $course = $cache->get_course($event);
+            $moduleinstance = $cache->get_module_instance($event);
             $exporter = new calendar_event_exporter($event, [
                 'context' => $context,
                 'course' => $course,
+                'moduleinstance' => $moduleinstance,
                 'daylink' => $url,
                 'type' => $this->related['type'],
                 'today' => $this->calendar->time,
index 3920107..7e888b8 100644 (file)
@@ -188,9 +188,11 @@ class day_exporter extends exporter {
         $eventexporters = array_map(function($event) use ($cache, $output) {
             $context = $cache->get_context($event);
             $course = $cache->get_course($event);
+            $moduleinstance = $cache->get_module_instance($event);
             $exporter = new calendar_event_exporter($event, [
                 'context' => $context,
                 'course' => $course,
+                'moduleinstance' => $moduleinstance,
                 'daylink' => $this->url,
                 'type' => $this->related['type'],
                 'today' => $this->data[0],
index b19fd60..e845b64 100644 (file)
@@ -54,15 +54,20 @@ class events_related_objects_cache {
     protected $courses = null;
 
     /**
-     * @var array $events The related groups.
+     * @var array $groups The related groups.
      */
     protected $groups = null;
 
     /**
-     * @var array $events The related course modules.
+     * @var array $coursemodules The related course modules.
      */
     protected $coursemodules = [];
 
+    /**
+     * @var array $moduleinstances The related module instances.
+     */
+    protected $moduleinstances = null;
+
     /**
      * Constructor.
      *
@@ -170,6 +175,33 @@ class events_related_objects_cache {
         return $this->coursemodules[$key];
     }
 
+    /**
+     * Get the related module instance for a given event.
+     *
+     * @param event_interface $event The event object.
+     * @return stdClass|null
+     */
+    public function get_module_instance(event_interface $event) {
+        if (!$event->get_course_module()) {
+            return null;
+        }
+
+        if (is_null($this->moduleinstances)) {
+            $this->load_module_instances();
+        }
+
+        $id = $event->get_course_module()->get('instance');
+        $name = $event->get_course_module()->get('modname');
+
+        if (isset($this->moduleinstances[$name])) {
+            if (isset($this->moduleinstances[$name][$id])) {
+                return $this->moduleinstances[$name][$id];
+            }
+        }
+
+        return null;
+    }
+
     /**
      * Load the list of all of the distinct courses required for the
      * list of provided events and save the result in memory.
@@ -221,4 +253,35 @@ class events_related_objects_cache {
 
         $this->groups = $DB->get_records_sql($sql, $params);
     }
+
+    /**
+     * Load the list of all of the distinct module instances required for the
+     * list of provided events and save the result in memory.
+     */
+    protected function load_module_instances() {
+        global $DB;
+
+        $this->moduleinstances = [];
+        $modulestoload = [];
+        foreach ($this->events as $event) {
+            if ($module = $event->get_course_module()) {
+                $id = $module->get('instance');
+                $name = $module->get('modname');
+
+                $ids = isset($modulestoload[$name]) ? $modulestoload[$name] : [];
+                $ids[$id] = true;
+                $modulestoload[$name] = $ids;
+            }
+        }
+
+        if (empty($modulestoload)) {
+            return;
+        }
+
+        foreach ($modulestoload as $modulename => $ids) {
+            list($idsql, $params) = $DB->get_in_or_equal(array_keys($ids));
+            $sql = "SELECT * FROM {" . $modulename . "} WHERE id {$idsql}";
+            $this->moduleinstances[$modulename] = $DB->get_records_sql($sql, $params);
+        }
+    }
 }
diff --git a/calendar/tests/events_related_objects_cache_test.php b/calendar/tests/events_related_objects_cache_test.php
new file mode 100644 (file)
index 0000000..f0799db
--- /dev/null
@@ -0,0 +1,140 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Tests for the events_related_objects_cache.
+ *
+ * @package    core_calendar
+ * @copyright  2017 Ryan Wyllie <ryan@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once(__DIR__ . '/helpers.php');
+
+use \core_calendar\external\events_related_objects_cache;
+use \core_calendar\local\event\container;
+
+/**
+ * Tests for the events_related_objects_cache.
+ *
+ * @package    core_calendar
+ * @copyright  2017 Ryan Wyllie <ryan@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_calendar_events_related_objects_cache_testcase extends advanced_testcase {
+
+    /**
+     * Tests set up
+     */
+    protected function setUp() {
+        $this->resetAfterTest();
+    }
+
+    /**
+     * An event with no module should return null when trying to retrieve
+     * the module instance.
+     */
+    public function test_get_module_instance_no_module() {
+        $this->setAdminUser();
+        $mapper = container::get_event_mapper();
+        $legacyevent = create_event([
+            'modulename' => '',
+            'instance' => 0
+        ]);
+        $event = $mapper->from_legacy_event_to_event($legacyevent);
+        $cache = new events_related_objects_cache([$event]);
+
+        $this->assertNull($cache->get_module_instance($event));
+    }
+
+    /**
+     * The get_module_instance should return the correct module instances
+     * for the given set of events in the cache.
+     */
+    public function test_get_module_instance_with_modules() {
+        $this->setAdminUser();
+        $mapper = container::get_event_mapper();
+        $generator = $this->getDataGenerator();
+        $course = $generator->create_course();
+        $plugingenerator = $generator->get_plugin_generator('mod_assign');
+        $instance1 = $plugingenerator->create_instance(['course' => $course->id]);
+        $instance2 = $plugingenerator->create_instance(['course' => $course->id]);
+        unset($instance1->cmid);
+        unset($instance2->cmid);
+
+        $params = [
+            'type' => CALENDAR_EVENT_TYPE_ACTION,
+            'courseid' => $course->id,
+            'modulename' => 'assign',
+            'userid' => 0,
+            'eventtype' => 'due',
+            'repeats' => 0,
+            'timestart' => 1,
+        ];
+
+        $legacyevent1 = create_event(array_merge($params, ['name' => 'Event 1', 'instance' => $instance1->id]));
+        $legacyevent2 = create_event(array_merge($params, ['name' => 'Event 2', 'instance' => $instance1->id]));
+        $legacyevent3 = create_event(array_merge($params, ['name' => 'Event 3', 'instance' => $instance2->id]));
+        $event1 = $mapper->from_legacy_event_to_event($legacyevent1);
+        $event2 = $mapper->from_legacy_event_to_event($legacyevent2);
+        $event3 = $mapper->from_legacy_event_to_event($legacyevent3);
+        $cache = new events_related_objects_cache([$event1, $event2, $event3]);
+
+        $eventinstance1 = $cache->get_module_instance($event1);
+        $eventinstance2 = $cache->get_module_instance($event2);
+        $eventinstance3 = $cache->get_module_instance($event3);
+
+        $this->assertEquals($instance1, $eventinstance1);
+        $this->assertEquals($instance1, $eventinstance2);
+        $this->assertEquals($instance2, $eventinstance3);
+    }
+
+    /**
+     * Trying to load the course module of an event that isn't in
+     * the cache should return null.
+     */
+    public function test_module_instance_unknown_event() {
+        $this->setAdminUser();
+        $mapper = container::get_event_mapper();
+        $generator = $this->getDataGenerator();
+        $course = $generator->create_course();
+        $plugingenerator = $generator->get_plugin_generator('mod_assign');
+        $instance1 = $plugingenerator->create_instance(['course' => $course->id]);
+        $instance2 = $plugingenerator->create_instance(['course' => $course->id]);
+        unset($instance1->cmid);
+        unset($instance2->cmid);
+
+        $params = [
+            'type' => CALENDAR_EVENT_TYPE_ACTION,
+            'courseid' => $course->id,
+            'modulename' => 'assign',
+            'userid' => 0,
+            'eventtype' => 'due',
+            'repeats' => 0,
+            'timestart' => 1,
+        ];
+
+        $legacyevent1 = create_event(array_merge($params, ['name' => 'Event 1', 'instance' => $instance1->id]));
+        $legacyevent2 = create_event(array_merge($params, ['name' => 'Event 2', 'instance' => $instance2->id]));
+        $event1 = $mapper->from_legacy_event_to_event($legacyevent1);
+        $event2 = $mapper->from_legacy_event_to_event($legacyevent2);
+        $cache = new events_related_objects_cache([$event1]);
+
+        $this->assertNull($cache->get_module_instance($event2));
+    }
+}