From 7d4f09b97808f70813ed5fab6fb3a0f5d3b19ced Mon Sep 17 00:00:00 2001
From: Huong Nguyen <huongnv13@gmail.com>
Date: Tue, 19 Dec 2023 10:27:40 +0700
Subject: [PATCH] MDL-75579 Backup: Prevent failed course restore task to be
 retried

---
 .../task/asynchronous_restore_task.php        | 65 ++++++++++++-------
 1 file changed, 40 insertions(+), 25 deletions(-)

diff --git a/lib/classes/task/asynchronous_restore_task.php b/lib/classes/task/asynchronous_restore_task.php
index fcd3b2a5482..97416be813a 100644
--- a/lib/classes/task/asynchronous_restore_task.php
+++ b/lib/classes/task/asynchronous_restore_task.php
@@ -46,7 +46,8 @@ class asynchronous_restore_task extends adhoc_task {
         global $DB;
         $started = time();
 
-        $restoreid = $this->get_custom_data()->backupid;
+        $customdata = $this->get_custom_data();
+        $restoreid = $customdata->backupid;
         $restorerecord = $DB->get_record('backup_controllers', array('backupid' => $restoreid), 'id, controller', IGNORE_MISSING);
         // If the record doesn't exist, the backup controller failed to create. Unable to proceed.
         if (empty($restorerecord)) {
@@ -62,37 +63,51 @@ class asynchronous_restore_task extends adhoc_task {
             return;
         }
         $rc = \restore_controller::load_controller($restoreid);
-        $rc->set_progress(new \core\progress\db_updater($restorerecord->id, 'backup_controllers', 'progress'));
+        try {
+            $rc->set_progress(new \core\progress\db_updater($restorerecord->id, 'backup_controllers', 'progress'));
 
-        // Do some preflight checks on the restore.
-        $status = $rc->get_status();
-        $execution = $rc->get_execution();
+            // Do some preflight checks on the restore.
+            $status = $rc->get_status();
+            $execution = $rc->get_execution();
 
-        // Check that the restore is in the correct status and
-        // that is set for asynchronous execution.
-        if ($status == \backup::STATUS_AWAITING && $execution == \backup::EXECUTION_DELAYED) {
-            // Execute the restore.
-            $rc->execute_plan();
+            // Check that the restore is in the correct status and
+            // that is set for asynchronous execution.
+            if ($status == \backup::STATUS_AWAITING && $execution == \backup::EXECUTION_DELAYED) {
+                // Execute the restore.
+                $rc->execute_plan();
+
+                // Send message to user if enabled.
+                $messageenabled = (bool) get_config('backup', 'backup_async_message_users');
+                if ($messageenabled && $rc->get_status() == \backup::STATUS_FINISHED_OK) {
+                    $asynchelper = new async_helper('restore', $restoreid);
+                    $asynchelper->send_message();
+                }
+
+            } else {
+                // If status isn't 700, it means the process has failed.
+                // Retrying isn't going to fix it, so marked operation as failed.
+                $rc->set_status(\backup::STATUS_FINISHED_ERR);
+                mtrace('Bad backup controller status, is: ' . $status . ' should be 700, marking job as failed.');
 
-            // Send message to user if enabled.
-            $messageenabled = (bool)get_config('backup', 'backup_async_message_users');
-            if ($messageenabled && $rc->get_status() == \backup::STATUS_FINISHED_OK) {
-                $asynchelper = new async_helper('restore', $restoreid);
-                $asynchelper->send_message();
             }
 
-        } else {
-            // If status isn't 700, it means the process has failed.
-            // Retrying isn't going to fix it, so marked operation as failed.
+            $duration = time() - $started;
+            mtrace('Restore completed in: ' . $duration . ' seconds');
+        } catch (\Exception $e) {
+            // If an exception is thrown, mark the restore as failed.
             $rc->set_status(\backup::STATUS_FINISHED_ERR);
-            mtrace('Bad backup controller status, is: ' . $status . ' should be 700, marking job as failed.');
 
+            // Retrying isn't going to fix this, so add a no-retry flag to customdata.
+            // We can cancel the task in the task manager.
+            $customdata->noretry = true;
+            $this->set_custom_data($customdata);
+
+            mtrace('Exception thrown during restore execution, marking job as failed.');
+            mtrace($e->getMessage());
+        } finally {
+            // Cleanup.
+            // Always destroy the controller.
+            $rc->destroy();
         }
-
-        // Cleanup.
-        $rc->destroy();
-
-        $duration = time() - $started;
-        mtrace('Restore completed in: ' . $duration . ' seconds');
     }
 }