// Copyright (C) 2025, The Duplicati Team // https://duplicati.com, hello@duplicati.com // // Permission is hereby granted, free of charge, to any person obtaining a // copy of this software and associated documentation files (the "Software"), // to deal in the Software without restriction, including without limitation // the rights to use, copy, modify, merge, publish, distribute, sublicense, // and/or sell copies of the Software, and to permit persons to whom the // Software is furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in // all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER // DEALINGS IN THE SOFTWARE. using System; using System.Linq; using System.Net.Http; using System.Threading; using System.Threading.Tasks; using Duplicati.Library.Interface; using Duplicati.Library.Localization.Short; namespace Duplicati.Library.Main.Backend; #nullable enable partial class BackendManager { /// /// Represents a pending DELETE operation /// private class DeleteOperation : PendingOperation { /// /// The log tag for this class /// private static readonly string LOGTAG = Logging.Log.LogTagFromType(); /// /// The remote filename that is to be deleted /// public override string RemoteFilename { get; } /// /// The size of the remote file, or -1 if unknown /// public override long Size { get; } /// /// The operation type /// public override BackendActionType Operation => BackendActionType.Delete; /// /// Creates a new DeleteOperation /// /// The remote filename to delete /// The size of the remote file, or -1 if unknown /// The execution context /// Whether to wait for the operation to complete public DeleteOperation(string remoteName, long size, ExecuteContext context, bool waitForComplete, CancellationToken cancelToken) : base(context, waitForComplete, cancelToken) { RemoteFilename = remoteName; Size = size; } /// /// Generates a unique filename by adding a random suffix if the target already exists. /// /// The base filename /// A unique filename private static string GenerateUniqueFilename(string baseName) { return baseName + $".{Guid.NewGuid().ToString("N")[..6]}"; } /// /// Performs the soft-delete operation by renaming the file with the soft-delete prefix. /// Handles creating target directories and resolving filename conflicts. /// /// The backend to use /// The cancellation token /// True if the operation succeeded private async Task PerformSoftDeleteAsync(IBackend backend, CancellationToken cancelToken) { var softDeletePrefix = Context.Options.SoftDeletePrefix!; var newName = softDeletePrefix + RemoteFilename; var newNameWithSuffix = newName; const int maxAttempts = 3; // Try to rename the file for (int attempt = 0; attempt < maxAttempts; attempt++) { try { if (backend is IRenameEnabledBackend renameBackend && !Context.Options.PreventBackendRename) { await renameBackend.RenameAsync(RemoteFilename, newNameWithSuffix, cancelToken).ConfigureAwait(false); } else { // Soft-delete fallback: download, upload with new name, and delete old file using (var tempFile = new Library.Utility.TempFile()) { await backend.GetAsync(RemoteFilename, tempFile, cancelToken).ConfigureAwait(false); await backend.PutAsync(newName, tempFile, cancelToken).ConfigureAwait(false); } await backend.DeleteAsync(RemoteFilename, cancelToken).ConfigureAwait(false); } return true; } catch (Exception ex) { Logging.Log.WriteWarningMessage(LOGTAG, "RemoteFileRenameFailed", ex, $"Failed to rename file {RemoteFilename} to {newName}, attempt {attempt + 1}/{maxAttempts}"); if (attempt == maxAttempts - 1) throw; // Try with a unique suffix in case the target file already exists newNameWithSuffix = GenerateUniqueFilename(newName); } } throw new Exception("Failed to perform soft-delete on file"); } /// public override async Task ExecuteAsync(IBackend backend, CancellationToken cancelToken) { Context.Statwriter.SendEvent(BackendActionType.Delete, BackendEventType.Started, RemoteFilename, Size); string? result = null; bool deleteSucceeded = false; try { if (!string.IsNullOrWhiteSpace(Context.Options.SoftDeletePrefix)) { await PerformSoftDeleteAsync(backend, cancelToken).ConfigureAwait(false); } else { await backend.DeleteAsync(RemoteFilename, cancelToken).ConfigureAwait(false); } deleteSucceeded = true; } catch (Exception ex) { // Check if the file was not found, and if so, check if it was actually deleted var isFileMissingException = ex is Library.Interface.FileMissingException || ex is System.IO.FileNotFoundException; var wr = (ex as System.Net.WebException)?.Response as System.Net.HttpWebResponse; var isWrFileMissingException = wr != null && (wr.StatusCode == System.Net.HttpStatusCode.NotFound || wr.StatusCode == System.Net.HttpStatusCode.Gone); var isHttpFileMissingException = ex is HttpRequestException && (ex as HttpRequestException)?.StatusCode == System.Net.HttpStatusCode.NotFound; bool recovered = false; if (isFileMissingException || isWrFileMissingException || isHttpFileMissingException) { Logging.Log.WriteInformationMessage(LOGTAG, "DeleteRemoteFileFailed", LC.L($"Delete operation failed for {RemoteFilename} with FileNotFound, listing contents")); try { recovered = !await backend.ListAsync(cancelToken).Select(x => x.Name).ContainsAsync(RemoteFilename).ConfigureAwait(false); } catch { } if (recovered) { Logging.Log.WriteInformationMessage(LOGTAG, "DeleteRemoteFileSuccess", LC.L($"Listing indicates file {RemoteFilename} was deleted correctly")); deleteSucceeded = true; } else Logging.Log.WriteWarningMessage(LOGTAG, "DeleteRemoteFileFailed", ex, LC.L($"Listing confirms file {RemoteFilename} was not deleted")); } if (!recovered) { result = ex.ToString(); throw; } } finally { // Here, we do not know if the file was actually deleted or not // We log that the operation was performed, and the result Context.Database.LogRemoteOperation("delete", RemoteFilename, result); if (deleteSucceeded) { // We also log the new state of the file, so it will be attempted to be re-deleted on later listings Context.Database.LogRemoteVolumeUpdated(RemoteFilename, RemoteVolumeState.Deleted, -1, null); } } Context.Statwriter.SendEvent(BackendActionType.Delete, BackendEventType.Completed, RemoteFilename, Size); return true; } } }