mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-03-14 12:40:01 +01:00
Code Issues Projects Releases Wiki Activity

Merge branch 'MDL-65191-master' of git://github.com/lameze/moodle

Browse Source
This commit is contained in:
Eloy Lafuente (stronk7) 2019-04-09 00:46:47 +02:00
commit dabc69afe5
7 changed files with 174 additions and 166 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

158
badges/cron.php
View File

@ -1,158 +0,0 @@
<?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/>.
/**
* Cron job for reviewing and aggregating badge award criteria
*
* @package core
* @subpackage badges
* @copyright 2012 onwards Totara Learning Solutions Ltd {@link http://www.totaralms.com/}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @author Yuliya Bozhko <yuliya.bozhko@totaralms.com>
*/
defined('MOODLE_INTERNAL') || die();
require_once($CFG->libdir . '/badgeslib.php');
function badge_cron() {
global $CFG;
if (!empty($CFG->enablebadges)) {
badge_review_cron();
badge_message_cron();
}
}
/**
* Reviews criteria and awards badges
*
* First find all badges that can be earned, then reviews each badge.
* (Not sure how efficient this is timewise).
*/
function badge_review_cron() {
global $DB, $CFG;
$total = 0;
$courseparams = array();
if (empty($CFG->badges_allowcoursebadges)) {
$coursesql = '';
} else {
$coursesql = ' OR EXISTS (SELECT id FROM {course} WHERE visible = :visible AND startdate < :current) ';
$courseparams = array('visible' => true, 'current' => time());
}
$sql = 'SELECT id
FROM {badge}
WHERE (status = :active OR status = :activelocked)
AND (type = :site ' . $coursesql . ')';
$badgeparams = array(
'active' => BADGE_STATUS_ACTIVE,
'activelocked' => BADGE_STATUS_ACTIVE_LOCKED,
'site' => BADGE_TYPE_SITE
);
$params = array_merge($badgeparams, $courseparams);
$badges = $DB->get_fieldset_sql($sql, $params);
mtrace('Started reviewing available badges.');
foreach ($badges as $bid) {
$badge = new badge($bid);
if ($badge->has_criteria()) {
if (debugging()) {
mtrace('Processing badge "' . $badge->name . '"...');
}
$issued = $badge->review_all_criteria();
if (debugging()) {
mtrace('...badge was issued to ' . $issued . ' users.');
}
$total += $issued;
}
}
mtrace('Badges were issued ' . $total . ' time(s).');
}
/**
* Sends out scheduled messages to badge creators
*
*/
function badge_message_cron() {
global $DB;
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));
}
}
/**
* Creates single message for all notification and sends it out
*
* @param object $badge A badge which is notified about.
*/
function badge_assemble_notification(stdClass $badge) {
global $DB;
$userfrom = core_user::get_noreply_user();
$userfrom->maildisplay = true;
if ($msgs = $DB->get_records_select('badge_issued', 'issuernotified IS NULL AND badgeid = ?', array($badge->id))) {
// Get badge creator.
$creator = $DB->get_record('user', array('id' => $badge->creator), '*', MUST_EXIST);
$creatorsubject = get_string('creatorsubject', 'badges', $badge->name);
$creatormessage = '';
// Put all messages in one digest.
foreach ($msgs as $msg) {
$issuedlink = html_writer::link(new moodle_url('/badges/badge.php', array('hash' => $msg->uniquehash)), $badge->name);
$recipient = $DB->get_record('user', array('id' => $msg->userid), '*', MUST_EXIST);
$a = new stdClass();
$a->user = fullname($recipient);
$a->link = $issuedlink;
$creatormessage .= get_string('creatorbody', 'badges', $a);
$DB->set_field('badge_issued', 'issuernotified', time(), array('badgeid' => $msg->badgeid, 'userid' => $msg->userid));
}
// Create a message object.
$eventdata = new \core\message\message();
$eventdata->courseid = SITEID;
$eventdata->component = 'moodle';
$eventdata->name = 'badgecreatornotice';
$eventdata->userfrom = $userfrom;
$eventdata->userto = $creator;
$eventdata->notification = 1;
$eventdata->subject = $creatorsubject;
$eventdata->fullmessage = format_text_email($creatormessage, FORMAT_HTML);
$eventdata->fullmessageformat = FORMAT_PLAIN;
$eventdata->fullmessagehtml = $creatormessage;
$eventdata->smallmessage = $creatorsubject;
message_send($eventdata);
}
}

1
lang/en/admin.php
View 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';

47
lib/badgeslib.php
View File

@ -1611,3 +1611,50 @@ function badge_award_criteria_competency_has_records_for_competencies($competenc
return $DB->record_exists_sql($sql, $params);
}
/**
* Creates single message for all notification and sends it out
*
* @param object $badge A badge which is notified about.
*/
function badge_assemble_notification(stdClass $badge) {
global $DB;
$userfrom = core_user::get_noreply_user();
$userfrom->maildisplay = true;
if ($msgs = $DB->get_records_select('badge_issued', 'issuernotified IS NULL AND badgeid = ?', array($badge->id))) {
// Get badge creator.
$creator = $DB->get_record('user', array('id' => $badge->creator), '*', MUST_EXIST);
$creatorsubject = get_string('creatorsubject', 'badges', $badge->name);
$creatormessage = '';
// Put all messages in one digest.
foreach ($msgs as $msg) {
$issuedlink = html_writer::link(new moodle_url('/badges/badge.php', array('hash' => $msg->uniquehash)), $badge->name);
$recipient = $DB->get_record('user', array('id' => $msg->userid), '*', MUST_EXIST);
$a = new stdClass();
$a->user = fullname($recipient);
$a->link = $issuedlink;
$creatormessage .= get_string('creatorbody', 'badges', $a);
$DB->set_field('badge_issued', 'issuernotified', time(), array('badgeid' => $msg->badgeid, 'userid' => $msg->userid));
}
// Create a message object.
$eventdata = new \core\message\message();
$eventdata->courseid = SITEID;
$eventdata->component = 'moodle';
$eventdata->name = 'badgecreatornotice';
$eventdata->userfrom = $userfrom;
$eventdata->userto = $creator;
$eventdata->notification = 1;
$eventdata->subject = $creatorsubject;
$eventdata->fullmessage = format_text_email($creatormessage, FORMAT_HTML);
$eventdata->fullmessageformat = FORMAT_PLAIN;
$eventdata->fullmessagehtml = $creatormessage;
$eventdata->smallmessage = $creatorsubject;
message_send($eventdata);
}
}

56
lib/classes/task/badges_cron_task.php
View File

@ -38,14 +38,56 @@ class badges_cron_task extends scheduled_task {
}
/**
* Do the job.
* Throw exceptions on errors (the job will be retried).
* Reviews criteria and awards badges
*
* First find all badges that can be earned, then reviews each badge.
* (Not sure how efficient this is timewise).
*/
public function execute() {
global $CFG;
// Run badges review cron.
require_once($CFG->dirroot . '/badges/cron.php');
badge_cron();
}
global $DB, $CFG;
if (!empty($CFG->enablebadges)) {
require_once($CFG->libdir . '/badgeslib.php');
$total = 0;
$courseparams = array();
if (empty($CFG->badges_allowcoursebadges)) {
$coursesql = '';
} else {
$coursesql = ' OR EXISTS (SELECT id FROM {course} WHERE visible = :visible AND startdate < :current) ';
$courseparams = array('visible' => true, 'current' => time());
}
$sql = 'SELECT id
FROM {badge}
WHERE (status = :active OR status = :activelocked)
AND (type = :site ' . $coursesql . ')';
$badgeparams = [
'active' => BADGE_STATUS_ACTIVE,
'activelocked' => BADGE_STATUS_ACTIVE_LOCKED,
'site' => BADGE_TYPE_SITE
];
$params = array_merge($badgeparams, $courseparams);
$badges = $DB->get_fieldset_sql($sql, $params);
mtrace('Started reviewing available badges.');
foreach ($badges as $bid) {
$badge = new \badge($bid);
if ($badge->has_criteria()) {
if (debugging()) {
mtrace('Processing badge "' . $badge->name . '"...');
}
$issued = $badge->review_all_criteria();
if (debugging()) {
mtrace('...badge was issued to ' . $issued . ' users.');
}
$total += $issued;
}
}
mtrace('Badges were issued ' . $total . ' time(s).');
}
}
}

67
lib/classes/task/badges_message_task.php Normal file
View File

@ -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));
}
}
}
}

9
lib/db/tasks.php
View File

@ -275,6 +275,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,

2
version.php
View File

@ -29,7 +29,7 @@
defined('MOODLE_INTERNAL') || die();
$version = 2019040600.02; // YYYYMMDD = weekly release date of this DEV branch.
$version = 2019040600.03; // YYYYMMDD = weekly release date of this DEV branch.
// RR = release increments - 00 in DEV branches.
// .XX = incremental changes.