L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MDL-55188 events: Final deprecation of part of events 1 API.

Browse Source
This commit is contained in:
Adrian Greeve
2018-07-30 09:25:06 +08:00
parent 5454e72c21
commit b41e1d7c55
7 changed files with 37 additions and 816 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/deprecatedlib.php
+24 -451
View File
@@ -60,9 +60,8 @@ function add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user
/**
* @deprecated since 2.6
*/
function events_trigger($eventname, $eventdata) {
throw new coding_exception('events_trigger() can not be used any more.'.
' Please use new events instead.');
function events_trigger() {
throw new coding_exception('events_trigger() has been deprecated along with all Events 1 API in favour of Events 2 API.');
}
/**
@@ -3478,497 +3477,71 @@ function tag_cloud_sort($a, $b) {
}
/**
* Loads the events definitions for the component (from file). If no
* events are defined for the component, we simply return an empty array.
*
* @access protected To be used from eventslib only
* @deprecated since Moodle 3.1
* @param string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
* @return array Array of capabilities or empty array if not exists
*/
function events_load_def($component) {
global $CFG;
if ($component === 'unittest') {
$defpath = $CFG->dirroot.'/lib/tests/fixtures/events.php';
} else {
$defpath = core_component::get_component_directory($component).'/db/events.php';
}
function events_load_def() {
throw new coding_exception('events_load_def() has been deprecated along with all Events 1 API in favour of Events 2 API.');
$handlers = array();
if (file_exists($defpath)) {
require($defpath);
}
// make sure the definitions are valid and complete; tell devs what is wrong
foreach ($handlers as $eventname => $handler) {
if ($eventname === 'reset') {
debugging("'reset' can not be used as event name.");
unset($handlers['reset']);
continue;
}
if (!is_array($handler)) {
debugging("Handler of '$eventname' must be specified as array'");
unset($handlers[$eventname]);
continue;
}
if (!isset($handler['handlerfile'])) {
debugging("Handler of '$eventname' must include 'handlerfile' key'");
unset($handlers[$eventname]);
continue;
}
if (!isset($handler['handlerfunction'])) {
debugging("Handler of '$eventname' must include 'handlerfunction' key'");
unset($handlers[$eventname]);
continue;
}
if (!isset($handler['schedule'])) {
$handler['schedule'] = 'instant';
}
if ($handler['schedule'] !== 'instant' and $handler['schedule'] !== 'cron') {
debugging("Handler of '$eventname' must include valid 'schedule' type (instant or cron)'");
unset($handlers[$eventname]);
continue;
}
if (!isset($handler['internal'])) {
$handler['internal'] = 1;
}
$handlers[$eventname] = $handler;
}
return $handlers;
}
/**
* Puts a handler on queue
*
* @access protected To be used from eventslib only
* @deprecated since Moodle 3.1
* @param stdClass $handler event handler object from db
* @param stdClass $event event data object
* @param string $errormessage The error message indicating the problem
* @return int id number of new queue handler
*/
function events_queue_handler($handler, $event, $errormessage) {
global $DB;
if ($qhandler = $DB->get_record('events_queue_handlers', array('queuedeventid'=>$event->id, 'handlerid'=>$handler->id))) {
debugging("Please check code: Event id $event->id is already queued in handler id $qhandler->id");
return $qhandler->id;
}
// make a new queue handler
$qhandler = new stdClass();
$qhandler->queuedeventid = $event->id;
$qhandler->handlerid = $handler->id;
$qhandler->errormessage = $errormessage;
$qhandler->timemodified = time();
if ($handler->schedule === 'instant' and $handler->status == 1) {
$qhandler->status = 1; //already one failed attempt to dispatch this event
} else {
$qhandler->status = 0;
}
return $DB->insert_record('events_queue_handlers', $qhandler);
function events_queue_handler() {
throw new coding_exception('events_queue_handler() has been deprecated along with all Events 1 API in favour of Events 2 API.');
}
/**
* trigger a single event with a specified handler
*
* @access protected To be used from eventslib only
* @deprecated since Moodle 3.1
* @param stdClass $handler This shoudl be a row from the events_handlers table.
* @param stdClass $eventdata An object containing information about the event
* @param string $errormessage error message indicating problem
* @return bool|null True means event processed, false means retry event later; may throw exception, NULL means internal error
*/
function events_dispatch($handler, $eventdata, &$errormessage) {
global $CFG;
debugging('Events API using $handlers array has been deprecated in favour of Events 2 API, please use it instead.', DEBUG_DEVELOPER);
$function = unserialize($handler->handlerfunction);
if (is_callable($function)) {
// oki, no need for includes
} else if (file_exists($CFG->dirroot.$handler->handlerfile)) {
include_once($CFG->dirroot.$handler->handlerfile);
} else {
$errormessage = "Handler file of component $handler->component: $handler->handlerfile can not be found!";
return null;
}
// checks for handler validity
if (is_callable($function)) {
$result = call_user_func($function, $eventdata);
if ($result === false) {
$errormessage = "Handler function of component $handler->component: $handler->handlerfunction requested resending of event!";
return false;
}
return true;
} else {
$errormessage = "Handler function of component $handler->component: $handler->handlerfunction not callable function or class method!";
return null;
}
function events_dispatch() {
throw new coding_exception('events_dispatch() has been deprecated along with all Events 1 API in favour of Events 2 API.');
}
/**
* given a queued handler, call the respective event handler to process the event
*
* @access protected To be used from eventslib only
* @deprecated since Moodle 3.1
* @param stdClass $qhandler events_queued_handler row from db
* @return boolean true means event processed, false means retry later, NULL means fatal failure
*/
function events_process_queued_handler($qhandler) {
global $DB;
// get handler
if (!$handler = $DB->get_record('events_handlers', array('id'=>$qhandler->handlerid))) {
debugging("Error processing queue handler $qhandler->id, missing handler id: $qhandler->handlerid");
//irrecoverable error, remove broken queue handler
events_dequeue($qhandler);
return NULL;
}
// get event object
if (!$event = $DB->get_record('events_queue', array('id'=>$qhandler->queuedeventid))) {
// can't proceed with no event object - might happen when two crons running at the same time
debugging("Error processing queue handler $qhandler->id, missing event id: $qhandler->queuedeventid");
//irrecoverable error, remove broken queue handler
events_dequeue($qhandler);
return NULL;
}
// call the function specified by the handler
try {
$errormessage = 'Unknown error';
if (events_dispatch($handler, unserialize(base64_decode($event->eventdata)), $errormessage)) {
//everything ok
events_dequeue($qhandler);
return true;
}
} catch (Exception $e) {
// the problem here is that we do not want one broken handler to stop all others,
// cron handlers are very tricky because the needed data might have been deleted before the cron execution
$errormessage = "Handler function of component $handler->component: $handler->handlerfunction threw exception :" .
$e->getMessage() . "\n" . format_backtrace($e->getTrace(), true);
if (!empty($e->debuginfo)) {
$errormessage .= $e->debuginfo;
}
}
//dispatching failed
$qh = new stdClass();
$qh->id = $qhandler->id;
$qh->errormessage = $errormessage;
$qh->timemodified = time();
$qh->status = $qhandler->status + 1;
$DB->update_record('events_queue_handlers', $qh);
debugging($errormessage);
return false;
function events_process_queued_handler() {
throw new coding_exception(
'events_process_queued_handler() has been deprecated along with all Events 1 API in favour of Events 2 API.'
);
}
/**
* Updates all of the event definitions within the database.
*
* Unfortunately this isn't as simple as removing them all and then readding
* the updated event definitions. Chances are queued items are referencing the
* existing definitions.
*
* Note that the absence of the db/events.php event definition file
* will cause any queued events for the component to be removed from
* the database.
*
* @category event
* @deprecated since Moodle 3.1
* @param string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
* @return boolean always returns true
*/
function events_update_definition($component='moodle') {
global $DB;
// load event definition from events.php
$filehandlers = events_load_def($component);
if ($filehandlers) {
debugging('Events API using $handlers array has been deprecated in favour of Events 2 API, please use it instead.', DEBUG_DEVELOPER);
}
// load event definitions from db tables
// if we detect an event being already stored, we discard from this array later
// the remaining needs to be removed
$cachedhandlers = events_get_cached($component);
foreach ($filehandlers as $eventname => $filehandler) {
if (!empty($cachedhandlers[$eventname])) {
if ($cachedhandlers[$eventname]['handlerfile'] === $filehandler['handlerfile'] &&
$cachedhandlers[$eventname]['handlerfunction'] === serialize($filehandler['handlerfunction']) &&
$cachedhandlers[$eventname]['schedule'] === $filehandler['schedule'] &&
$cachedhandlers[$eventname]['internal'] == $filehandler['internal']) {
// exact same event handler already present in db, ignore this entry
unset($cachedhandlers[$eventname]);
continue;
} else {
// same event name matches, this event has been updated, update the datebase
$handler = new stdClass();
$handler->id = $cachedhandlers[$eventname]['id'];
$handler->handlerfile = $filehandler['handlerfile'];
$handler->handlerfunction = serialize($filehandler['handlerfunction']); // static class methods stored as array
$handler->schedule = $filehandler['schedule'];
$handler->internal = $filehandler['internal'];
$DB->update_record('events_handlers', $handler);
unset($cachedhandlers[$eventname]);
continue;
}
} else {
// if we are here, this event handler is not present in db (new)
// add it
$handler = new stdClass();
$handler->eventname = $eventname;
$handler->component = $component;
$handler->handlerfile = $filehandler['handlerfile'];
$handler->handlerfunction = serialize($filehandler['handlerfunction']); // static class methods stored as array
$handler->schedule = $filehandler['schedule'];
$handler->status = 0;
$handler->internal = $filehandler['internal'];
$DB->insert_record('events_handlers', $handler);
}
}
// clean up the left overs, the entries in cached events array at this points are deprecated event handlers
// and should be removed, delete from db
events_cleanup($component, $cachedhandlers);
events_get_handlers('reset');
return true;
function events_update_definition() {
throw new coding_exception(
'events_update_definition has been deprecated along with all Events 1 API in favour of Events 2 API.'
);
}
/**
* Events cron will try to empty the events queue by processing all the queued events handlers
*
* @access public Part of the public API
* @deprecated since Moodle 3.1
* @category event
* @param string $eventname empty means all
* @return int number of dispatched events
*/
function events_cron($eventname='') {
global $DB;
$failed = array();
$processed = 0;
if ($eventname) {
$sql = "SELECT qh.*
FROM {events_queue_handlers} qh, {events_handlers} h
WHERE qh.handlerid = h.id AND h.eventname=?
ORDER BY qh.id";
$params = array($eventname);
} else {
$sql = "SELECT *
FROM {events_queue_handlers}
ORDER BY id";
$params = array();
}
$rs = $DB->get_recordset_sql($sql, $params);
if ($rs->valid()) {
debugging('Events API using $handlers array has been deprecated in favour of Events 2 API, please use it instead.', DEBUG_DEVELOPER);
}
foreach ($rs as $qhandler) {
if (isset($failed[$qhandler->handlerid])) {
// do not try to dispatch any later events when one already asked for retry or ended with exception
continue;
}
$status = events_process_queued_handler($qhandler);
if ($status === false) {
// handler is asking for retry, do not send other events to this handler now
$failed[$qhandler->handlerid] = $qhandler->handlerid;
} else if ($status === NULL) {
// means completely broken handler, event data was purged
$failed[$qhandler->handlerid] = $qhandler->handlerid;
} else {
$processed++;
}
}
$rs->close();
// remove events that do not have any handlers waiting
$sql = "SELECT eq.id
FROM {events_queue} eq
LEFT JOIN {events_queue_handlers} qh ON qh.queuedeventid = eq.id
WHERE qh.id IS NULL";
$rs = $DB->get_recordset_sql($sql);
foreach ($rs as $event) {
//debugging('Purging stale event '.$event->id);
$DB->delete_records('events_queue', array('id'=>$event->id));
}
$rs->close();
return $processed;
function events_cron() {
throw new coding_exception('events_cron() has been deprecated along with all Events 1 API in favour of Events 2 API.');
}
/**
* Do not call directly, this is intended to be used from new event base only.
*
* @private
* @deprecated since Moodle 3.1
* @param string $eventname name of the event
* @param mixed $eventdata event data object
* @return int number of failed events
*/
function events_trigger_legacy($eventname, $eventdata) {
global $CFG, $USER, $DB;
$failedcount = 0; // number of failed events.
// pull out all registered event handlers
if ($handlers = events_get_handlers($eventname)) {
foreach ($handlers as $handler) {
$errormessage = '';
if ($handler->schedule === 'instant') {
if ($handler->status) {
//check if previous pending events processed
if (!$DB->record_exists('events_queue_handlers', array('handlerid'=>$handler->id))) {
// ok, queue is empty, lets reset the status back to 0 == ok
$handler->status = 0;
$DB->set_field('events_handlers', 'status', 0, array('id'=>$handler->id));
// reset static handler cache
events_get_handlers('reset');
}
}
// dispatch the event only if instant schedule and status ok
if ($handler->status or (!$handler->internal and $DB->is_transaction_started())) {
// increment the error status counter
$handler->status++;
$DB->set_field('events_handlers', 'status', $handler->status, array('id'=>$handler->id));
// reset static handler cache
events_get_handlers('reset');
} else {
$errormessage = 'Unknown error';
$result = events_dispatch($handler, $eventdata, $errormessage);
if ($result === true) {
// everything is fine - event dispatched
continue;
} else if ($result === false) {
// retry later - set error count to 1 == send next instant into cron queue
$DB->set_field('events_handlers', 'status', 1, array('id'=>$handler->id));
// reset static handler cache
events_get_handlers('reset');
} else {
// internal problem - ignore the event completely
$failedcount ++;
continue;
}
}
// update the failed counter
$failedcount ++;
} else if ($handler->schedule === 'cron') {
//ok - use queueing of events only
} else {
// unknown schedule - ignore event completely
debugging("Unknown handler schedule type: $handler->schedule");
$failedcount ++;
continue;
}
// if even type is not instant, or dispatch asked for retry, queue it
$event = new stdClass();
$event->userid = $USER->id;
$event->eventdata = base64_encode(serialize($eventdata));
$event->timecreated = time();
if (debugging()) {
$dump = '';
$callers = debug_backtrace();
foreach ($callers as $caller) {
if (!isset($caller['line'])) {
$caller['line'] = '?';
}
if (!isset($caller['file'])) {
$caller['file'] = '?';
}
$dump .= 'line ' . $caller['line'] . ' of ' . substr($caller['file'], strlen($CFG->dirroot) + 1);
if (isset($caller['function'])) {
$dump .= ': call to ';
if (isset($caller['class'])) {
$dump .= $caller['class'] . $caller['type'];
}
$dump .= $caller['function'] . '()';
}
$dump .= "\n";
}
$event->stackdump = $dump;
} else {
$event->stackdump = '';
}
$event->id = $DB->insert_record('events_queue', $event);
events_queue_handler($handler, $event, $errormessage);
}
} else {
// No handler found for this event name - this is ok!
}
return $failedcount;
function events_trigger_legacy() {
throw new coding_exception('events_trigger_legacy() has been deprecated along with all Events 1 API in favour of Events 2 API.');
}
/**
* checks if an event is registered for this component
*
* @access public Part of the public API
* @deprecated since Moodle 3.1
* @param string $eventname name of the event
* @param string $component component name, can be mod/data or moodle
* @return bool
*/
function events_is_registered($eventname, $component) {
global $DB;
debugging('events_is_registered() has been deprecated along with all Events 1 API in favour of Events 2 API,' .
' please use it instead.', DEBUG_DEVELOPER);
return $DB->record_exists('events_handlers', array('component'=>$component, 'eventname'=>$eventname));
function events_is_registered() {
throw new coding_exception('events_is_registered() has been deprecated along with all Events 1 API in favour of Events 2 API.');
}
/**
* checks if an event is queued for processing - either cron handlers attached or failed instant handlers
*
* @access public Part of the public API
* @deprecated since Moodle 3.1
* @param string $eventname name of the event
* @return int number of queued events
*/
function events_pending_count($eventname) {
global $DB;
debugging('events_pending_count() has been deprecated along with all Events 1 API in favour of Events 2 API,' .
' please use it instead.', DEBUG_DEVELOPER);
$sql = "SELECT COUNT('x')
FROM {events_queue_handlers} qh
JOIN {events_handlers} h ON h.id = qh.handlerid
WHERE h.eventname = ?";
return $DB->count_records_sql($sql, array($eventname));
function events_pending_count() {
throw new coding_exception('events_pending_count() has been deprecated along with all Events 1 API in favour of Events 2 API.');
}
/**