MDL-64881 workshopallocation_scheduled: create a scheduled task
authorSimey Lameze <simey@moodle.com>
Fri, 1 Mar 2019 07:01:10 +0000 (15:01 +0800)
committerSimey Lameze <simey@moodle.com>
Mon, 4 Mar 2019 22:51:40 +0000 (06:51 +0800)
mod/workshop/allocation/scheduled/classes/task/cron_task.php [new file with mode: 0644]
mod/workshop/allocation/scheduled/db/tasks.php [new file with mode: 0644]
mod/workshop/allocation/scheduled/lang/en/workshopallocation_scheduled.php
mod/workshop/allocation/scheduled/version.php

diff --git a/mod/workshop/allocation/scheduled/classes/task/cron_task.php b/mod/workshop/allocation/scheduled/classes/task/cron_task.php
new file mode 100644 (file)
index 0000000..139d694
--- /dev/null
@@ -0,0 +1,78 @@
+<?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/>.
+
+/**
+ * A schedule task for scheduled allocation cron.
+ *
+ * @package   workshopallocation_scheduled
+ * @copyright 2019 Simey Lameze <simey@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace workshopallocation_scheduled\task;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * The main schedule task for scheduled allocation cron.
+ *
+ * @package   workshopallocation_scheduled
+ * @copyright 2019 Simey Lameze <simey@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class cron_task extends \core\task\scheduled_task {
+    /**
+     * Get a descriptive name for this task (shown to admins).
+     *
+     * @return string
+     */
+    public function get_name() {
+        return get_string('crontask', 'workshopallocation_scheduled');
+    }
+
+    /**
+     * Run scheduled allocation cron.
+     */
+    public function execute() {
+        global $CFG, $DB;
+
+        $sql = "SELECT w.*
+                  FROM {workshopallocation_scheduled} a
+                  JOIN {workshop} w ON a.workshopid = w.id
+                 WHERE a.enabled = 1
+                   AND w.phase = 20
+                   AND w.submissionend > 0
+                   AND w.submissionend < ?
+                   AND (a.timeallocated IS NULL OR a.timeallocated < w.submissionend)";
+        $workshops = $DB->get_records_sql($sql, array(time()));
+
+        if (empty($workshops)) {
+            mtrace('... no workshops awaiting scheduled allocation. ', '');
+            return;
+        }
+
+        mtrace('... executing scheduled allocation in ' . count($workshops) . ' workshop(s) ... ', '');
+
+        require_once($CFG->dirroot . '/mod/workshop/locallib.php');
+
+        foreach ($workshops as $workshop) {
+            $cm = get_coursemodule_from_instance('workshop', $workshop->id, $workshop->course, false, MUST_EXIST);
+            $course = $DB->get_record('course', ['id' => $cm->course], '*', MUST_EXIST);
+            $workshop = new \workshop($workshop, $cm, $course);
+            $allocator = $workshop->allocator_instance('scheduled');
+            $allocator->execute();
+        }
+    }
+}
diff --git a/mod/workshop/allocation/scheduled/db/tasks.php b/mod/workshop/allocation/scheduled/db/tasks.php
new file mode 100644 (file)
index 0000000..fb64d39
--- /dev/null
@@ -0,0 +1,37 @@
+<?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/>.
+
+/**
+ * Definition of scheduled allocation tasks.
+ *
+ * @package   workshopallocation_scheduled
+ * @copyright 2019 Simey Lameze <simey@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$tasks = [
+    [
+        'classname' => '\workshopallocation_scheduled\task\cron_task',
+        'blocking' => 0,
+        'minute' => '*',
+        'hour' => '*',
+        'day' => '*',
+        'month' => '*',
+        'dayofweek' => '*'
+    ]
+];
index 27d7a74..6bc8b2e 100644 (file)
@@ -26,6 +26,7 @@
 
 defined('MOODLE_INTERNAL') || die();
 
+$string['crontask'] = 'Background processing for scheduled allocation';
 $string['currentstatus'] = 'Current status';
 $string['currentstatusexecution'] = 'Status';
 $string['currentstatusexecution1'] = 'Executed on {$a->datetime}';
index 555a2ae..1553d51 100644 (file)
@@ -27,7 +27,7 @@
 defined('MOODLE_INTERNAL') || die();
 
 $plugin->component  = 'workshopallocation_scheduled';
-$plugin->version    = 2018120300;
+$plugin->version    = 2018120301;
 $plugin->requires   = 2018112800;
 $plugin->dependencies = array(
     'workshopallocation_random'  => 2018112800,