mirror of
https://github.com/moodle/moodle.git
synced 2025-01-17 21:49:15 +01:00
MDL-52846 tasks: complete docs and move functions to deprecatedlib
- Add MDL codes to @deprecated. - Add @todo tag for future 4.3 phase 2 deprecation. - Deprecate global scope functions: - cron_execute_plugin_type(). - cron_bc_hack_plugin_functions(). (moving them to deprecatelib). - Document it in main upgrade.txt
This commit is contained in:
Eloy Lafuente (stronk7)
parent
3bdb8f4584
commit
d2ecc75e2f
@ -27,7 +27,8 @@ namespace core\task;
|
||||
* Simple task to run cron for all plugins.
|
||||
* Note - this is only for plugins using the legacy cron method,
|
||||
* plugins can also now just add their own scheduled tasks which is the preferred method.
|
||||
* @deprecated since Moodle 3.5 - Please use new task API.
|
||||
* @deprecated since Moodle 3.9 MDL-52846. Please use new task API.
|
||||
* @todo MDL-61165 This will be deleted in Moodle 4.3
|
||||
*/
|
||||
class legacy_plugin_cron_task extends scheduled_task {
|
||||
|
||||
|
||||
128
lib/cronlib.php
128
lib/cronlib.php
@ -375,134 +375,6 @@ function cron_trace_time_and_memory() {
|
||||
mtrace('... started ' . date('H:i:s') . '. Current memory use ' . display_size(memory_get_usage()) . '.');
|
||||
}
|
||||
|
||||
/**
|
||||
* Executes cron functions for a specific type of plugin.
|
||||
*
|
||||
* @param string $plugintype Plugin type (e.g. 'report')
|
||||
* @param string $description If specified, will display 'Starting (whatever)'
|
||||
* and 'Finished (whatever)' lines, otherwise does not display
|
||||
*/
|
||||
function cron_execute_plugin_type($plugintype, $description = null) {
|
||||
global $DB;
|
||||
|
||||
// Get list from plugin => function for all plugins
|
||||
$plugins = get_plugin_list_with_function($plugintype, 'cron');
|
||||
|
||||
// Modify list for backward compatibility (different files/names)
|
||||
$plugins = cron_bc_hack_plugin_functions($plugintype, $plugins);
|
||||
|
||||
// Return if no plugins with cron function to process
|
||||
if (!$plugins) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ($description) {
|
||||
mtrace('Starting '.$description);
|
||||
}
|
||||
|
||||
foreach ($plugins as $component=>$cronfunction) {
|
||||
$dir = core_component::get_component_directory($component);
|
||||
|
||||
// Get cron period if specified in version.php, otherwise assume every cron
|
||||
$cronperiod = 0;
|
||||
if (file_exists("$dir/version.php")) {
|
||||
$plugin = new stdClass();
|
||||
include("$dir/version.php");
|
||||
if (isset($plugin->cron)) {
|
||||
$cronperiod = $plugin->cron;
|
||||
}
|
||||
}
|
||||
|
||||
// Using last cron and cron period, don't run if it already ran recently
|
||||
$lastcron = get_config($component, 'lastcron');
|
||||
if ($cronperiod && $lastcron) {
|
||||
if ($lastcron + $cronperiod > time()) {
|
||||
// do not execute cron yet
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
mtrace('Processing cron function for ' . $component . '...');
|
||||
debugging("Use of legacy cron is deprecated ($cronfunction). Please use scheduled tasks.", DEBUG_DEVELOPER);
|
||||
cron_trace_time_and_memory();
|
||||
$pre_dbqueries = $DB->perf_get_queries();
|
||||
$pre_time = microtime(true);
|
||||
|
||||
$cronfunction();
|
||||
|
||||
mtrace("done. (" . ($DB->perf_get_queries() - $pre_dbqueries) . " dbqueries, " .
|
||||
round(microtime(true) - $pre_time, 2) . " seconds)");
|
||||
|
||||
set_config('lastcron', time(), $component);
|
||||
core_php_time_limit::raise();
|
||||
}
|
||||
|
||||
if ($description) {
|
||||
mtrace('Finished ' . $description);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Used to add in old-style cron functions within plugins that have not been converted to the
|
||||
* new standard API. (The standard API is frankenstyle_name_cron() in lib.php; some types used
|
||||
* cron.php and some used a different name.)
|
||||
*
|
||||
* @param string $plugintype Plugin type e.g. 'report'
|
||||
* @param array $plugins Array from plugin name (e.g. 'report_frog') to function name (e.g.
|
||||
* 'report_frog_cron') for plugin cron functions that were already found using the new API
|
||||
* @return array Revised version of $plugins that adds in any extra plugin functions found by
|
||||
* looking in the older location
|
||||
*/
|
||||
function cron_bc_hack_plugin_functions($plugintype, $plugins) {
|
||||
global $CFG; // mandatory in case it is referenced by include()d PHP script
|
||||
|
||||
if ($plugintype === 'report') {
|
||||
// Admin reports only - not course report because course report was
|
||||
// never implemented before, so doesn't need BC
|
||||
foreach (core_component::get_plugin_list($plugintype) as $pluginname=>$dir) {
|
||||
$component = $plugintype . '_' . $pluginname;
|
||||
if (isset($plugins[$component])) {
|
||||
// We already have detected the function using the new API
|
||||
continue;
|
||||
}
|
||||
if (!file_exists("$dir/cron.php")) {
|
||||
// No old style cron file present
|
||||
continue;
|
||||
}
|
||||
include_once("$dir/cron.php");
|
||||
$cronfunction = $component . '_cron';
|
||||
if (function_exists($cronfunction)) {
|
||||
$plugins[$component] = $cronfunction;
|
||||
} else {
|
||||
debugging("Invalid legacy cron.php detected in $component, " .
|
||||
"please use lib.php instead");
|
||||
}
|
||||
}
|
||||
} else if (strpos($plugintype, 'grade') === 0) {
|
||||
// Detect old style cron function names
|
||||
// Plugin gradeexport_frog used to use grade_export_frog_cron() instead of
|
||||
// new standard API gradeexport_frog_cron(). Also applies to gradeimport, gradereport
|
||||
foreach(core_component::get_plugin_list($plugintype) as $pluginname=>$dir) {
|
||||
$component = $plugintype.'_'.$pluginname;
|
||||
if (isset($plugins[$component])) {
|
||||
// We already have detected the function using the new API
|
||||
continue;
|
||||
}
|
||||
if (!file_exists("$dir/lib.php")) {
|
||||
continue;
|
||||
}
|
||||
include_once("$dir/lib.php");
|
||||
$cronfunction = str_replace('grade', 'grade_', $plugintype) . '_' .
|
||||
$pluginname . '_cron';
|
||||
if (function_exists($cronfunction)) {
|
||||
$plugins[$component] = $cronfunction;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $plugins;
|
||||
}
|
||||
|
||||
/**
|
||||
* Prepare the output renderer for the cron run.
|
||||
*
|
||||
|
||||
@ -3425,3 +3425,137 @@ function cron_run_single_task(\core\task\scheduled_task $task) {
|
||||
DEBUG_DEVELOPER);
|
||||
return \core\task\manager::run_from_cli($task);
|
||||
}
|
||||
|
||||
/**
|
||||
* Executes cron functions for a specific type of plugin.
|
||||
*
|
||||
* @param string $plugintype Plugin type (e.g. 'report')
|
||||
* @param string $description If specified, will display 'Starting (whatever)'
|
||||
* and 'Finished (whatever)' lines, otherwise does not display
|
||||
*
|
||||
* @deprecated since Moodle 3.9 MDL-52846. Please use new task API.
|
||||
* @todo MDL-61165 This will be deleted in Moodle 4.3.
|
||||
*/
|
||||
function cron_execute_plugin_type($plugintype, $description = null) {
|
||||
global $DB;
|
||||
|
||||
// Get list from plugin => function for all plugins.
|
||||
$plugins = get_plugin_list_with_function($plugintype, 'cron');
|
||||
|
||||
// Modify list for backward compatibility (different files/names).
|
||||
$plugins = cron_bc_hack_plugin_functions($plugintype, $plugins);
|
||||
|
||||
// Return if no plugins with cron function to process.
|
||||
if (!$plugins) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ($description) {
|
||||
mtrace('Starting '.$description);
|
||||
}
|
||||
|
||||
foreach ($plugins as $component => $cronfunction) {
|
||||
$dir = core_component::get_component_directory($component);
|
||||
|
||||
// Get cron period if specified in version.php, otherwise assume every cron.
|
||||
$cronperiod = 0;
|
||||
if (file_exists("$dir/version.php")) {
|
||||
$plugin = new stdClass();
|
||||
include("$dir/version.php");
|
||||
if (isset($plugin->cron)) {
|
||||
$cronperiod = $plugin->cron;
|
||||
}
|
||||
}
|
||||
|
||||
// Using last cron and cron period, don't run if it already ran recently.
|
||||
$lastcron = get_config($component, 'lastcron');
|
||||
if ($cronperiod && $lastcron) {
|
||||
if ($lastcron + $cronperiod > time()) {
|
||||
// Do not execute cron yet.
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
mtrace('Processing cron function for ' . $component . '...');
|
||||
debugging("Use of legacy cron is deprecated ($cronfunction). Please use scheduled tasks.", DEBUG_DEVELOPER);
|
||||
cron_trace_time_and_memory();
|
||||
$pre_dbqueries = $DB->perf_get_queries();
|
||||
$pre_time = microtime(true);
|
||||
|
||||
$cronfunction();
|
||||
|
||||
mtrace("done. (" . ($DB->perf_get_queries() - $pre_dbqueries) . " dbqueries, " .
|
||||
round(microtime(true) - $pre_time, 2) . " seconds)");
|
||||
|
||||
set_config('lastcron', time(), $component);
|
||||
core_php_time_limit::raise();
|
||||
}
|
||||
|
||||
if ($description) {
|
||||
mtrace('Finished ' . $description);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Used to add in old-style cron functions within plugins that have not been converted to the
|
||||
* new standard API. (The standard API is frankenstyle_name_cron() in lib.php; some types used
|
||||
* cron.php and some used a different name.)
|
||||
*
|
||||
* @param string $plugintype Plugin type e.g. 'report'
|
||||
* @param array $plugins Array from plugin name (e.g. 'report_frog') to function name (e.g.
|
||||
* 'report_frog_cron') for plugin cron functions that were already found using the new API
|
||||
* @return array Revised version of $plugins that adds in any extra plugin functions found by
|
||||
* looking in the older location
|
||||
*
|
||||
* @deprecated since Moodle 3.9 MDL-52846. Please use new task API.
|
||||
* @todo MDL-61165 This will be deleted in Moodle 4.3.
|
||||
*/
|
||||
function cron_bc_hack_plugin_functions($plugintype, $plugins) {
|
||||
global $CFG; // Mandatory in case it is referenced by include()d PHP script.
|
||||
|
||||
if ($plugintype === 'report') {
|
||||
// Admin reports only - not course report because course report was
|
||||
// never implemented before, so doesn't need BC.
|
||||
foreach (core_component::get_plugin_list($plugintype) as $pluginname => $dir) {
|
||||
$component = $plugintype . '_' . $pluginname;
|
||||
if (isset($plugins[$component])) {
|
||||
// We already have detected the function using the new API.
|
||||
continue;
|
||||
}
|
||||
if (!file_exists("$dir/cron.php")) {
|
||||
// No old style cron file present.
|
||||
continue;
|
||||
}
|
||||
include_once("$dir/cron.php");
|
||||
$cronfunction = $component . '_cron';
|
||||
if (function_exists($cronfunction)) {
|
||||
$plugins[$component] = $cronfunction;
|
||||
} else {
|
||||
debugging("Invalid legacy cron.php detected in $component, " .
|
||||
"please use lib.php instead");
|
||||
}
|
||||
}
|
||||
} else if (strpos($plugintype, 'grade') === 0) {
|
||||
// Detect old style cron function names.
|
||||
// Plugin gradeexport_frog used to use grade_export_frog_cron() instead of
|
||||
// new standard API gradeexport_frog_cron(). Also applies to gradeimport, gradereport.
|
||||
foreach (core_component::get_plugin_list($plugintype) as $pluginname => $dir) {
|
||||
$component = $plugintype.'_'.$pluginname;
|
||||
if (isset($plugins[$component])) {
|
||||
// We already have detected the function using the new API.
|
||||
continue;
|
||||
}
|
||||
if (!file_exists("$dir/lib.php")) {
|
||||
continue;
|
||||
}
|
||||
include_once("$dir/lib.php");
|
||||
$cronfunction = str_replace('grade', 'grade_', $plugintype) . '_' .
|
||||
$pluginname . '_cron';
|
||||
if (function_exists($cronfunction)) {
|
||||
$plugins[$component] = $cronfunction;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $plugins;
|
||||
}
|
||||
|
||||
@ -60,6 +60,10 @@ information provided here is intended especially for developers.
|
||||
The confirmation dialogue no longer has a configurable "No" button as per similar changes in MDL-59759.
|
||||
This set of confirmation modals was unintentionally missed from that deprecation process.
|
||||
* The download_as_dataformat() method has been deprecated. Please use \core\dataformat::download_data() instead
|
||||
* Legacy cron has been deprecated and will be removed in Moodle 4.3. This includes the functions:
|
||||
- cron_execute_plugin_type()
|
||||
- cron_bc_hack_plugin_functions()
|
||||
Please, use the Task API instead: https://docs.moodle.org/dev/Task_API
|
||||
|
||||
=== 3.8 ===
|
||||
* Add CLI option to notify all cron tasks to stop: admin/cli/cron.php --stop
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user