Merge branch 'MDL-44367_master' of git://github.com/dmonllao/moodle

filter/data/filter.php

@@ -32,26 +32,36 @@ defined('MOODLE_INTERNAL') || die();
 class filter_data extends moodle_text_filter {
 
     public function filter($text, array $options = array()) {
-        global $CFG, $DB;
+        global $CFG, $DB, $USER;
 
-        // Trivial-cache - keyed on $cachedcontextid
-        static $cachedcontextid;
-        static $contentlist;
+        // Trivial-cache - keyed on $cachedcourseid + $cacheduserid.
+        static $cachedcourseid = null;
+        static $cacheduserid = null;
+        static $coursecontentlist = array();
+        static $sitecontentlist = array();
 
         static $nothingtodo;
 
         // Try to get current course.
         $coursectx = $this->context->get_course_context(false);
         if (!$coursectx) {
+            // We could be in a course category so no entries for courseid == 0 will be found.
             $courseid = 0;
         } else {
             $courseid = $coursectx->instanceid;
         }
 
-        // Initialise/invalidate our trivial cache if dealing with a different context
-        if (!isset($cachedcontextid) || $cachedcontextid !== $this->context->id) {
-            $cachedcontextid = $this->context->id;
-            $contentlist = array();
+        if ($cacheduserid !== $USER->id) {
+            // Invalidate all caches if the user changed.
+            $coursecontentlist = array();
+            $sitecontentlist = array();
+            $cacheduserid = $USER->id;
+            $cachedcourseid = $courseid;
+            $nothingtodo = false;
+        } else if ($courseid != get_site()->id && $courseid != 0 && $cachedcourseid != $courseid) {
+            // Invalidate course-level caches if the course id changed.
+            $coursecontentlist = array();
+            $cachedcourseid = $courseid;
             $nothingtodo = false;
         }
 
@@ -59,6 +69,13 @@ class filter_data extends moodle_text_filter {
             return $text;
         }
 
+        // If courseid == 0 only site entries will be returned.
+        if ($courseid == get_site()->id || $courseid == 0) {
+            $contentlist = & $sitecontentlist;
+        } else {
+            $contentlist = & $coursecontentlist;
+        }
+
         // Create a list of all the resources to search for. It may be cached already.
         if (empty($contentlist)) {
             $coursestosearch = $courseid ? array($courseid) : array(); // Add courseid if found

filter/data/tests/filter_test.php

@@ -0,0 +1,119 @@
+<?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/>.
+
+/**
+ * Unit tests.
+ *
+ * @package filter_data
+ * @category test
+ * @copyright 2015 David Monllao
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+require_once($CFG->dirroot . '/filter/data/filter.php');
+
+/**
+ * Tests for filter_data.
+ *
+ * @package filter_data
+ * @copyright 2015 David Monllao
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class filter_data_filter_testcase extends advanced_testcase {
+
+    /**
+     * Tests that the filter applies the required changes.
+     *
+     * @return void
+     */
+    public function test_filter() {
+
+        $this->resetAfterTest(true);
+        $this->setAdminUser();
+        filter_manager::reset_caches();
+
+        filter_set_global_state('data', TEXTFILTER_ON);
+
+        $course1 = $this->getDataGenerator()->create_course();
+        $coursecontext1 = context_course::instance($course1->id);
+
+        $course2 = $this->getDataGenerator()->create_course();
+        $coursecontext2 = context_course::instance($course2->id);
+
+        $sitecontext = context_course::instance(SITEID);
+
+        $site = get_site();
+        $this->add_simple_database_instance($site, array('SiteEntry'));
+        $this->add_simple_database_instance($course1, array('CourseEntry'));
+
+        $html = '<p>I like CourseEntry and SiteEntry</p>';
+
+        // Testing at course level (both site and course).
+        $filtered = format_text($html, FORMAT_HTML, array('context' => $coursecontext1));
+        $this->assertRegExp('/title=(\'|")CourseEntry(\'|")/', $filtered);
+        $this->assertRegExp('/title=(\'|")SiteEntry(\'|")/', $filtered);
+
+        // Testing at site level (only site).
+        $filtered = format_text($html, FORMAT_HTML, array('context' => $sitecontext));
+        $this->assertNotRegExp('/title=(\'|")CourseEntry(\'|")/', $filtered);
+        $this->assertRegExp('/title=(\'|")SiteEntry(\'|")/', $filtered);
+
+        // Changing to another course to test the caches invalidation (only site).
+        $filtered = format_text($html, FORMAT_HTML, array('context' => $coursecontext2));
+        $this->assertNotRegExp('/title=(\'|")CourseEntry(\'|")/', $filtered);
+        $this->assertRegExp('/title=(\'|")SiteEntry(\'|")/', $filtered);
+    }
+
+    /**
+     * Adds a database instance to the provided course + a text field + adds all attached entries.
+     *
+     * @param stdClass $course
+     * @param array $entries A list of entry names.
+     * @return void
+     */
+    protected function add_simple_database_instance($course, $entries = false) {
+        global $DB;
+
+        $database = $this->getDataGenerator()->create_module('data',
+                array('course' => $course->id));
+
+        // A database field.
+        $field = data_get_field_new('text', $database);
+        $fielddetail = new stdClass();
+        $fielddetail->d = $database->id;
+        $fielddetail->mode = 'add';
+        $fielddetail->type = 'text';
+        $fielddetail->sesskey = sesskey();
+        $fielddetail->name = 'Name';
+        $fielddetail->description = 'Some name';
+        $fielddetail->param1 = '1';
+        $field->define_field($fielddetail);
+        $field->insert_field();
+        $recordid = data_add_record($database);
+
+        // Database entries.
+        foreach ($entries as $entrytext) {
+            $datacontent = array();
+            $datacontent['fieldid'] = $field->field->id;
+            $datacontent['recordid'] = $recordid;
+            $datacontent['content'] = $entrytext;
+            $contentid = $DB->insert_record('data_content', $datacontent);
+        }
+    }
+}