Merge branch 'MDL-55956-master-5' of git://github.com/junpataleta/moodle

lib/classes/task/refresh_mod_calendar_events_task.php

@@ -0,0 +1,69 @@
+<?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/>.
+
+/**
+ * Adhoc task that updates all of the existing calendar events for modules that implement the *_refresh_events() hook.
+ *
+ * @package    core
+ * @copyright  2017 Jun Pataleta
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core\task;
+
+use core_plugin_manager;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Class that updates all of the existing calendar events for modules that implement the *_refresh_events() hook.
+ *
+ * Custom data accepted:
+ * - plugins -> Array of plugin names that need to be refreshed. Optional.
+ *
+ * @package     core
+ * @copyright   2017 Jun Pataleta
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class refresh_mod_calendar_events_task extends adhoc_task {
+
+    /**
+     * Run the task to refresh calendar events.
+     */
+    public function execute() {
+        // Specific list of plugins that need to be refreshed. If not set, then all mod plugins will be refreshed.
+        $pluginstorefresh = null;
+        if (isset($this->get_custom_data()->plugins)) {
+            $pluginstorefresh = $this->get_custom_data()->plugins;
+        }
+
+        $pluginmanager = core_plugin_manager::instance();
+        $modplugins = $pluginmanager->get_plugins_of_type('mod');
+        foreach ($modplugins as $plugin) {
+            // Check if a specific list of plugins is defined and check if it contains the plugin that is currently being evaluated.
+            if (!empty($pluginstorefresh) && !in_array($plugin->name, $pluginstorefresh)) {
+                // This plugin is not in the list, move on to the next one.
+                continue;
+            }
+            // Check if the plugin implements *_refresh_events() and call it when it does.
+            $refresheventsfunction = $plugin->name . '_refresh_events';
+            if (function_exists($refresheventsfunction)) {
+                mtrace('Calling ' . $refresheventsfunction);
+                call_user_func($refresheventsfunction);
+            }
+        }
+    }
+}

lib/db/install.xml

@@ -439,6 +439,7 @@
         <FIELD NAME="sequence" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="1" SEQUENCE="false"/>
         <FIELD NAME="timemodified" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
         <FIELD NAME="subscriptionid" TYPE="int" LENGTH="10" NOTNULL="false" SEQUENCE="false" COMMENT="The event_subscription id this event is associated with."/>
+        <FIELD NAME="priority" TYPE="int" LENGTH="10" NOTNULL="false" SEQUENCE="false" COMMENT="The event's display priority. For multiple events with the same module name, instance and eventtype (e.g. for group overrides), the one with the higher priority will be displayed."/>
       </FIELDS>
       <KEYS>
         <KEY NAME="primary" TYPE="primary" FIELDS="id"/>

lib/db/upgrade.php

@@ -2555,5 +2555,29 @@ function xmldb_main_upgrade($oldversion) {
         upgrade_main_savepoint(true, 2017021400.00);
     }
 
+    if ($oldversion < 2017030700.00) {
+
+        // Define field priority to be added to event.
+        $table = new xmldb_table('event');
+        $field = new xmldb_field('priority', XMLDB_TYPE_INTEGER, '10', null, null, null, null, 'subscriptionid');
+
+        // Conditionally launch add field priority.
+        if (!$dbman->field_exists($table, $field)) {
+            $dbman->add_field($table, $field);
+        }
+
+        // Create adhoc task for upgrading of existing calendar events.
+        $record = new \stdClass();
+        $record->classname = "\\core\\task\\refresh_mod_calendar_events_task";
+        $record->component = 'core';
+        // Next run time based from nextruntime computation in \core\task\manager::queue_adhoc_task().
+        $nextruntime = time() - 1;
+        $record->nextruntime = $nextruntime;
+        $DB->insert_record('task_adhoc', $record);
+
+        // Main savepoint reached.
+        upgrade_main_savepoint(true, 2017030700.00);
+    }
+
     return true;
 }

lib/upgrade.txt

@@ -53,6 +53,8 @@ information provided here is intended especially for developers.
 * get_user_capability_course() now has an additional parameter 'limit'. This can be used to return a set number of records with
   the submitted capability. The parameter 'fieldsexceptid' will now accept context fields which can be used for preloading.
 * The caching option 'immutable' has been added to send_stored_file() and send_file().
+* New adhoc task refresh_mod_calendar_events_task that updates existing calendar events of modules.
+* New 'priority' column for the event table to determine which event to show in case of events with user and group overrides.
 
 === 3.2 ===