Skip to content

Commit

Permalink
MDL-75751 upgradelib: Refactor out duplicated component update code
Browse files Browse the repository at this point in the history 
There are many places (install/upgrade for core, modules, blocks,
and plugins) where we need to call the same, or very similar,
sequence of Moodle functions to ensure the item is updated properly.

This change moves that sequence into a function so that it can be
held consistently in one place.
  • Loading branch information
@sammarshallou
sammarshallou committed Oct 10, 2022
1 parent cc4fec2 commit 2280ea1
Showing 1 changed file with 41 additions and 106 deletions.
147 changes: 41 additions & 106 deletions lib/upgradelib.php
View file
Expand Up @@ -569,6 +569,36 @@ function upgrade_stale_php_files_present(): bool {
return false;
}

/**
* After upgrading a module, block, or generic plugin, various parts of the system need to be
* informed.
*
* @param string $component Frankenstyle component or 'moodle' for core
* @param string $messageplug Set to the name of a message plugin if this is one
* @param bool $coreinstall Set to true if this is the core install
*/
function upgrade_component_updated(string $component, string $messageplug = '',
bool $coreinstall = false): void {
if (!$coreinstall) {
update_capabilities($component);
}
log_update_descriptions($component);
external_update_descriptions($component);
\core\task\manager::reset_scheduled_tasks_for_component($component);
\core_analytics\manager::update_default_models_for_component($component);
message_update_providers($component);
\core\message\inbound\manager::update_handlers_for_component($component);
if ($messageplug !== '') {
// Ugly hack!
message_update_processors($messageplug);
}
if ($component !== 'moodle') {
// This one is not run for core upgrades.
upgrade_plugin_mnet_functions($component);
}
core_tag_area::reset_definitions_for_component($component);
}

/**
* Upgrade plugins
* @param string $type The type of plugins that should be updated (e.g. 'enrol', 'qtype')
Expand Down Expand Up @@ -645,18 +675,7 @@ function upgrade_plugins($type, $startcallback, $endcallback, $verbose) {
$startcallback($component, true, $verbose);
$recover_install_function();
unset_config('installrunning', $plugin->fullname);
update_capabilities($component);
log_update_descriptions($component);
external_update_descriptions($component);
\core\task\manager::reset_scheduled_tasks_for_component($component);
\core_analytics\manager::update_default_models_for_component($component);
message_update_providers($component);
\core\message\inbound\manager::update_handlers_for_component($component);
if ($type === 'message') {
message_update_processors($plug);
}
upgrade_plugin_mnet_functions($component);
core_tag_area::reset_definitions_for_component($component);
upgrade_component_updated($component, $type === 'message' ? $plug : '');
$endcallback($component, true, $verbose);
}
}
Expand Down Expand Up @@ -684,18 +703,7 @@ function upgrade_plugins($type, $startcallback, $endcallback, $verbose) {
}

/// Install various components
update_capabilities($component);
log_update_descriptions($component);
external_update_descriptions($component);
\core\task\manager::reset_scheduled_tasks_for_component($component);
\core_analytics\manager::update_default_models_for_component($component);
message_update_providers($component);
\core\message\inbound\manager::update_handlers_for_component($component);
if ($type === 'message') {
message_update_processors($plug);
}
upgrade_plugin_mnet_functions($component);
core_tag_area::reset_definitions_for_component($component);
upgrade_component_updated($component, $type === 'message' ? $plug : '');
$endcallback($component, true, $verbose);

} else if ($installedversion < $plugin->version) { // upgrade
Expand All @@ -718,19 +726,7 @@ function upgrade_plugins($type, $startcallback, $endcallback, $verbose) {
}

/// Upgrade various components
update_capabilities($component);
log_update_descriptions($component);
external_update_descriptions($component);
\core\task\manager::reset_scheduled_tasks_for_component($component);
\core_analytics\manager::update_default_models_for_component($component);
message_update_providers($component);
\core\message\inbound\manager::update_handlers_for_component($component);
if ($type === 'message') {
// Ugly hack!
message_update_processors($plug);
}
upgrade_plugin_mnet_functions($component);
core_tag_area::reset_definitions_for_component($component);
upgrade_component_updated($component, $type === 'message' ? $plug : '');
$endcallback($component, false, $verbose);

} else if ($installedversion > $plugin->version) {
Expand Down Expand Up @@ -826,15 +822,7 @@ function upgrade_plugins_modules($startcallback, $endcallback, $verbose) {
$recover_install_function();
unset_config('installrunning', $module->name);
// Install various components too
update_capabilities($component);
log_update_descriptions($component);
external_update_descriptions($component);
\core\task\manager::reset_scheduled_tasks_for_component($component);
\core_analytics\manager::update_default_models_for_component($component);
message_update_providers($component);
\core\message\inbound\manager::update_handlers_for_component($component);
upgrade_plugin_mnet_functions($component);
core_tag_area::reset_definitions_for_component($component);
upgrade_component_updated($component);
$endcallback($component, true, $verbose);
}
}
Expand All @@ -861,15 +849,7 @@ function upgrade_plugins_modules($startcallback, $endcallback, $verbose) {
}

/// Install various components
update_capabilities($component);
log_update_descriptions($component);
external_update_descriptions($component);
\core\task\manager::reset_scheduled_tasks_for_component($component);
\core_analytics\manager::update_default_models_for_component($component);
message_update_providers($component);
\core\message\inbound\manager::update_handlers_for_component($component);
upgrade_plugin_mnet_functions($component);
core_tag_area::reset_definitions_for_component($component);
upgrade_component_updated($component);

$endcallback($component, true, $verbose);

Expand Down Expand Up @@ -898,15 +878,7 @@ function upgrade_plugins_modules($startcallback, $endcallback, $verbose) {
}

// Upgrade various components
update_capabilities($component);
log_update_descriptions($component);
external_update_descriptions($component);
\core\task\manager::reset_scheduled_tasks_for_component($component);
\core_analytics\manager::update_default_models_for_component($component);
message_update_providers($component);
\core\message\inbound\manager::update_handlers_for_component($component);
upgrade_plugin_mnet_functions($component);
core_tag_area::reset_definitions_for_component($component);
upgrade_component_updated($component);

$endcallback($component, false, $verbose);

Expand Down Expand Up @@ -1020,15 +992,7 @@ function upgrade_plugins_blocks($startcallback, $endcallback, $verbose) {
$recover_install_function();
unset_config('installrunning', 'block_'.$blockname);
// Install various components
update_capabilities($component);
log_update_descriptions($component);
external_update_descriptions($component);
\core\task\manager::reset_scheduled_tasks_for_component($component);
\core_analytics\manager::update_default_models_for_component($component);
message_update_providers($component);
\core\message\inbound\manager::update_handlers_for_component($component);
upgrade_plugin_mnet_functions($component);
core_tag_area::reset_definitions_for_component($component);
upgrade_component_updated($component);
$endcallback($component, true, $verbose);
}
}
Expand Down Expand Up @@ -1061,15 +1025,7 @@ function upgrade_plugins_blocks($startcallback, $endcallback, $verbose) {
$blocktitles[$block->name] = $blocktitle;

// Install various components
update_capabilities($component);
log_update_descriptions($component);
external_update_descriptions($component);
\core\task\manager::reset_scheduled_tasks_for_component($component);
\core_analytics\manager::update_default_models_for_component($component);
message_update_providers($component);
\core\message\inbound\manager::update_handlers_for_component($component);
core_tag_area::reset_definitions_for_component($component);
upgrade_plugin_mnet_functions($component);
upgrade_component_updated($component);

$endcallback($component, true, $verbose);

Expand Down Expand Up @@ -1097,15 +1053,7 @@ function upgrade_plugins_blocks($startcallback, $endcallback, $verbose) {
}

// Upgrade various components
update_capabilities($component);
log_update_descriptions($component);
external_update_descriptions($component);
\core\task\manager::reset_scheduled_tasks_for_component($component);
\core_analytics\manager::update_default_models_for_component($component);
message_update_providers($component);
\core\message\inbound\manager::update_handlers_for_component($component);
upgrade_plugin_mnet_functions($component);
core_tag_area::reset_definitions_for_component($component);
upgrade_component_updated($component);

$endcallback($component, false, $verbose);

Expand Down Expand Up @@ -1816,13 +1764,7 @@ function install_core($version, $verbose) {
upgrade_main_savepoint(true, $version, false);

// Continue with the installation
log_update_descriptions('moodle');
external_update_descriptions('moodle');
\core\task\manager::reset_scheduled_tasks_for_component('moodle');
\core_analytics\manager::update_default_models_for_component('moodle');
message_update_providers('moodle');
\core\message\inbound\manager::update_handlers_for_component('moodle');
core_tag_area::reset_definitions_for_component('moodle');
upgrade_component_updated('moodle', '', true);

// Write default settings unconditionally
admin_apply_default_settings(NULL, true);
Expand Down Expand Up @@ -1883,14 +1825,7 @@ function upgrade_core($version, $verbose) {
$COURSE = clone($SITE);

// perform all other component upgrade routines
update_capabilities('moodle');
log_update_descriptions('moodle');
external_update_descriptions('moodle');
\core\task\manager::reset_scheduled_tasks_for_component('moodle');
\core_analytics\manager::update_default_models_for_component('moodle');
message_update_providers('moodle');
\core\message\inbound\manager::update_handlers_for_component('moodle');
core_tag_area::reset_definitions_for_component('moodle');
upgrade_component_updated('moodle');
// Update core definitions.
cache_helper::update_definitions(true);

Expand Down

0 comments on commit 2280ea1

Please sign in to comment.