MDL-65191 core_badges: add badges_message_task task
authorSimey Lameze <simey@moodle.com>
Thu, 4 Apr 2019 01:14:45 +0000 (09:14 +0800)
committerSimey Lameze <simey@moodle.com>
Thu, 4 Apr 2019 01:36:20 +0000 (09:36 +0800)
lang/en/admin.php
lib/classes/task/badges_message_task.php [new file with mode: 0644]
lib/db/tasks.php
version.php

index 5e21e57..c41bad3 100644 (file)
@@ -1216,6 +1216,7 @@ $string['taskanalyticscleanup'] = 'Analytics cleanup';
 $string['taskautomatedbackup'] = 'Automated backups';
 $string['taskbackupcleanup'] = 'Clean backup tables and logs';
 $string['taskbadgescron'] = 'Award badges';
+$string['taskbadgesmessagecron'] = 'Background processing for sending badges notifications';
 $string['taskblogcron'] = 'Sync external blogs';
 $string['taskcachecleanup'] = 'Remove expired cache entries';
 $string['taskcachecron'] = 'Background processing for caches';
diff --git a/lib/classes/task/badges_message_task.php b/lib/classes/task/badges_message_task.php
new file mode 100644 (file)
index 0000000..5c7f838
--- /dev/null
@@ -0,0 +1,67 @@
+<?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 scheduled task.
+ *
+ * @package    core
+ * @copyright  2019 Simey Lameze <simey@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace core\task;
+
+/**
+ * Simple task to run the badges cron.
+ */
+class badges_message_task extends scheduled_task {
+
+    /**
+     * Get a descriptive name for this task (shown to admins).
+     *
+     * @return string
+     */
+    public function get_name() {
+        return get_string('taskbadgesmessagecron', 'admin');
+    }
+
+    /**
+     * Reviews criteria and awards badges
+     *
+     * First find all badges that can be earned, then reviews each badge.
+     */
+    public function execute() {
+        global $CFG, $DB;
+
+        if (!empty($CFG->enablebadges)) {
+            require_once($CFG->libdir . '/badgeslib.php');
+            mtrace('Sending scheduled badge notifications.');
+
+            $scheduled = $DB->get_records_select('badge', 'notification > ? AND (status != ?) AND nextcron < ?',
+                array(BADGE_MESSAGE_ALWAYS, BADGE_STATUS_ARCHIVED, time()),
+                'notification ASC', 'id, name, notification, usercreated as creator, timecreated');
+
+            foreach ($scheduled as $sch) {
+                // Send messages.
+                badge_assemble_notification($sch);
+
+                // Update next cron value.
+                $nextcron = badges_calculate_message_schedule($sch->notification);
+                $DB->set_field('badge', 'nextcron', $nextcron, array('id' => $sch->id));
+            }
+        }
+    }
+
+}
index 93ffff0..0c63d2f 100644 (file)
@@ -257,6 +257,15 @@ $tasks = array(
         'dayofweek' => '*',
         'month' => '*'
     ),
+    array(
+        'classname' => 'core\task\badges_message_task',
+        'blocking' => 0,
+        'minute' => '*/5',
+        'hour' => '*',
+        'day' => '*',
+        'dayofweek' => '*',
+        'month' => '*'
+    ),
     array(
         'classname' => 'core\task\file_temp_cleanup_task',
         'blocking' => 0,
index 6db1785..d9a50fe 100644 (file)
@@ -29,7 +29,7 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$version  = 2019032200.00;              // YYYYMMDD      = weekly release date of this DEV branch.
+$version  = 2019032200.01;              // YYYYMMDD      = weekly release date of this DEV branch.
                                         //         RR    = release increments - 00 in DEV branches.
                                         //           .XX = incremental changes.