From 2ccdcca92817976f9e83b63fb399b99d9dcfc3e7 Mon Sep 17 00:00:00 2001
From: Paul Holden <paulh@moodle.com>
Date: Wed, 22 May 2024 20:56:47 +0100
Subject: [PATCH] MDL-81870 core: re-factor duplicate plugin savepoint
 implementations.

---
 lang/en/debug.php      |  6 ++--
 lang/en/deprecated.txt |  2 ++
 lib/upgradelib.php     | 70 +++---------------------------------------
 3 files changed, 10 insertions(+), 68 deletions(-)

diff --git a/lang/en/debug.php b/lang/en/debug.php
index 3e0ac39f5bf..41116b3a322 100644
--- a/lang/en/debug.php
+++ b/lang/en/debug.php
@@ -23,7 +23,6 @@
  */
 
 $string['authpluginnotfound'] = 'Authentication plugin {$a} not found.';
-$string['blocknotexist'] = '{$a} block doesn\'t exist';
 $string['cannotbenull'] = '{$a} cannot be null!';
 $string['cannotdowngrade'] = 'Cannot downgrade {$a->plugin} from {$a->oldversion} to {$a->newversion}.';
 $string['cannotfindadmin'] = 'Could not find an admin user!';
@@ -39,7 +38,6 @@ $string['invalidparameter'] = 'Invalid parameter value detected';
 $string['invalidresponse'] = 'Invalid response value detected';
 $string['line'] = 'Line';
 $string['missingconfigversion'] = 'Config table does not contain the version. You cannot continue.';
-$string['modulenotexist'] = '{$a} module doesn\'t exist';
 $string['morethanonerecordinfetch'] = 'Found more than one record in fetch() !';
 $string['mustbeoveride'] = 'Abstract {$a} method must be overridden.';
 $string['noadminrole'] = 'No admin role could be found';
@@ -68,3 +66,7 @@ $string['sqlrelyonobsoletetable'] = 'This SQL relies on obsolete table(s): {$a}!
 $string['stacktrace'] = 'Stack trace';
 $string['withoutversion'] = 'Main version.php file is missing, not readable or broken.';
 $string['xmlizeunavailable'] = 'xmlize functions are not available';
+
+// Deprecated since Moodle 4.5.
+$string['blocknotexist'] = '{$a} block doesn\'t exist';
+$string['modulenotexist'] = '{$a} module doesn\'t exist';
diff --git a/lang/en/deprecated.txt b/lang/en/deprecated.txt
index 6c5809b817e..314d0f61106 100644
--- a/lang/en/deprecated.txt
+++ b/lang/en/deprecated.txt
@@ -127,4 +127,6 @@ aria:dropdowngrades,core_grades
 viewresults,core
 coursesearch,core
 coursesearch_help,core
+blocknotexist,core_debug
+modulenotexist,core_debug
 coursecalendar,core_calendar
diff --git a/lib/upgradelib.php b/lib/upgradelib.php
index 598395e21d7..955559e6cbd 100644
--- a/lib/upgradelib.php
+++ b/lib/upgradelib.php
@@ -373,43 +373,12 @@ function upgrade_main_savepoint($result, $version, $allowabort=true) {
  *
  * @category upgrade
  * @param bool $result false if upgrade step failed, true if completed
- * @param string or float $version main version
+ * @param string|float $version main version
  * @param string $modname name of module
  * @param bool $allowabort allow user to abort script execution here
- * @return void
  */
 function upgrade_mod_savepoint($result, $version, $modname, $allowabort=true) {
-    global $DB;
-
-    $component = 'mod_'.$modname;
-
-    if (!$result) {
-        throw new upgrade_exception($component, $version);
-    }
-
-    $dbversion = $DB->get_field('config_plugins', 'value', array('plugin'=>$component, 'name'=>'version'));
-
-    if (!$module = $DB->get_record('modules', array('name'=>$modname))) {
-        throw new \moodle_exception('modulenotexist', 'debug', '', $modname);
-    }
-
-    if ($dbversion >= $version) {
-        // something really wrong is going on in upgrade script
-        throw new downgrade_exception($component, $dbversion, $version);
-    }
-    set_config('version', $version, $component);
-
-    upgrade_log(UPGRADE_LOG_NORMAL, $component, 'Upgrade savepoint reached');
-
-    // reset upgrade timeout to default
-    upgrade_set_timeout();
-
-    core_upgrade_time::record_savepoint($version);
-
-    // this is a safe place to stop upgrades if user aborts page loading
-    if ($allowabort and connection_aborted()) {
-        die;
-    }
+    upgrade_plugin_savepoint($result, $version, 'mod', $modname, $allowabort);
 }
 
 /**
@@ -419,43 +388,12 @@ function upgrade_mod_savepoint($result, $version, $modname, $allowabort=true) {
  *
  * @category upgrade
  * @param bool $result false if upgrade step failed, true if completed
- * @param string or float $version main version
+ * @param string|float $version main version
  * @param string $blockname name of block
  * @param bool $allowabort allow user to abort script execution here
- * @return void
  */
 function upgrade_block_savepoint($result, $version, $blockname, $allowabort=true) {
-    global $DB;
-
-    $component = 'block_'.$blockname;
-
-    if (!$result) {
-        throw new upgrade_exception($component, $version);
-    }
-
-    $dbversion = $DB->get_field('config_plugins', 'value', array('plugin'=>$component, 'name'=>'version'));
-
-    if (!$block = $DB->get_record('block', array('name'=>$blockname))) {
-        throw new \moodle_exception('blocknotexist', 'debug', '', $blockname);
-    }
-
-    if ($dbversion >= $version) {
-        // something really wrong is going on in upgrade script
-        throw new downgrade_exception($component, $dbversion, $version);
-    }
-    set_config('version', $version, $component);
-
-    upgrade_log(UPGRADE_LOG_NORMAL, $component, 'Upgrade savepoint reached');
-
-    // reset upgrade timeout to default
-    upgrade_set_timeout();
-
-    core_upgrade_time::record_savepoint($version);
-
-    // this is a safe place to stop upgrades if user aborts page loading
-    if ($allowabort and connection_aborted()) {
-        die;
-    }
+    upgrade_plugin_savepoint($result, $version, 'block', $blockname, $allowabort);
 }
 
 /**