// 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. #nullable enable using System; using System.Collections; using System.Collections.Generic; using System.IO; using System.Linq; using System.Threading.Tasks; using Duplicati.Library.Interface; using Duplicati.Library.Utility; namespace Duplicati.Library.Main.Operation { internal class ListBrokenFilesHandler { /// /// The tag used for logging /// private static readonly string LOGTAG = Logging.Log.LogTagFromType(typeof(ListBrokenFilesHandler)); protected readonly Options m_options; protected readonly ListBrokenFilesResults m_result; public ListBrokenFilesHandler(Options options, ListBrokenFilesResults result) { m_options = options; m_result = result; } public async Task RunAsync(IBackendManager backendManager, IFilter filter, Func? callbackhandler = null) { if (!File.Exists(m_options.Dbpath)) throw new UserInformationException(string.Format("Database file does not exist: {0}", m_options.Dbpath), "DatabaseDoesNotExist"); await using var db = await Database.LocalListBrokenFilesDatabase.CreateAsync(m_options.Dbpath, null, m_result.TaskControl.ProgressToken).ConfigureAwait(false); await Utility.UpdateOptionsFromDb(db, m_options, m_result.TaskControl.ProgressToken) .ConfigureAwait(false); await Utility.VerifyOptionsAndUpdateDatabase(db, m_options, m_result.TaskControl.ProgressToken) .ConfigureAwait(false); await DoRunAsync(backendManager, db, filter, callbackhandler).ConfigureAwait(false); await db.Transaction.RollBackAsync().ConfigureAwait(false); } public static async Task<((DateTime FilesetTime, long FilesetID, long RemoveCount)[]?, List? Missing)> GetBrokenFilesetsFromRemote(IBackendManager backendManager, BasicResults result, Database.LocalListBrokenFilesDatabase db, Options options) { List? missing = null; var brokensets = await db .GetBrokenFilesets(options.Time, options.Version, result.TaskControl.ProgressToken) .ToArrayAsync(cancellationToken: result.TaskControl.ProgressToken) .ConfigureAwait(false); if (brokensets.Length == 0) { if (await db.RepairInProgress(result.TaskControl.ProgressToken).ConfigureAwait(false)) throw new UserInformationException("Cannot continue because the database is marked as being under repair, but does not have broken files.", "CannotListOnDatabaseInRepair"); Logging.Log.WriteInformationMessage(LOGTAG, "NoBrokenFilesetsInDatabase", "No broken filesets found in database, checking for missing remote files"); var remotestate = await FilelistProcessor.RemoteListAnalysis(backendManager, options, db, result.BackendWriter, null, null, FilelistProcessor.VerifyMode.VerifyOnly, result.TaskControl.ProgressToken).ConfigureAwait(false); if (!remotestate.ParsedVolumes.Any()) throw new UserInformationException("No remote volumes were found, refusing purge", "CannotPurgeWithNoRemoteVolumes"); missing = remotestate.MissingVolumes.ToList(); if (missing.Count == 0) { Logging.Log.WriteInformationMessage(LOGTAG, "NoMissingFilesFound", "Skipping operation because no files were found to be missing, and no filesets were recorded as broken."); return (null, missing); } // Mark all volumes as disposable foreach (var f in missing) await db .UpdateRemoteVolume(f.Name, RemoteVolumeState.Deleting, f.Size, f.Hash, result.TaskControl.ProgressToken) .ConfigureAwait(false); Logging.Log.WriteInformationMessage(LOGTAG, "MarkedRemoteFilesForDeletion", "Marked {0} remote files for deletion", missing.Count); // Drop all content from tables await db .RemoveMissingBlocks(missing.Select(x => x.Name), result.TaskControl.ProgressToken) .ConfigureAwait(false); // Mark all orphaned index files as disposable after removing the missing block files await foreach (var f in db.GetOrphanedIndexFiles(result.TaskControl.ProgressToken).ConfigureAwait(false)) await db .UpdateRemoteVolume(f.Name, RemoteVolumeState.Deleting, f.Size, f.Hash, result.TaskControl.ProgressToken) .ConfigureAwait(false); brokensets = await db .GetBrokenFilesets(options.Time, options.Version, result.TaskControl.ProgressToken) .ToArrayAsync() .ConfigureAwait(false); } return (brokensets, missing); } private async Task DoRunAsync(IBackendManager backendManager, Database.LocalListBrokenFilesDatabase db, IFilter filter, Func? callbackhandler) { if (filter != null && !filter.Empty) throw new UserInformationException("Filters are not supported for this operation", "FiltersAreNotSupportedForListBrokenFiles"); if (await db.PartiallyRecreated(m_result.TaskControl.ProgressToken).ConfigureAwait(false)) throw new UserInformationException("The command does not work on partially recreated databases", "ListBrokenFilesDoesNotWorkOnPartialDatabase"); (var brokensets, var missing) = await GetBrokenFilesetsFromRemote(backendManager, m_result, db, m_options).ConfigureAwait(false); if (brokensets == null) return; if (brokensets.Length == 0) { m_result.BrokenFiles = []; if (missing == null) Logging.Log.WriteInformationMessage(LOGTAG, "NoBrokenFilesets", "Found no broken filesets"); else if (missing.Count == 0) Logging.Log.WriteInformationMessage(LOGTAG, "NoBrokenFilesetsOrMissingFiles", "Found no broken filesets and no missing remote files"); else Logging.Log.WriteInformationMessage(LOGTAG, "NoBrokenSetsButMissingRemoteFiles", string.Format("Found no broken filesets, but {0} missing remote files. Run purge-broken-files.", missing.Count)); return; } var fstimes = await db .FilesetTimes(m_result.TaskControl.ProgressToken) .ToListAsync(cancellationToken: m_result.TaskControl.ProgressToken) .ConfigureAwait(false); var brokenfilesets = brokensets.Select(x => new { Version = fstimes.FindIndex(y => y.Key == x.FilesetID), Timestamp = x.FilesetTime, FilesetID = x.FilesetID, BrokenCount = x.RemoveCount } ) .ToArray(); m_result.BrokenFiles = await Task.WhenAll(brokenfilesets.Select( async x => new Tuple>>( x.Version, x.Timestamp, callbackhandler == null && !m_options.ListSetsOnly ? await db .GetBrokenFilenames(x.FilesetID, m_result.TaskControl.ProgressToken) .ToArrayAsync(cancellationToken: m_result.TaskControl.ProgressToken) .ConfigureAwait(false) : new MockList>((int)x.BrokenCount) ))) .ConfigureAwait(false); if (callbackhandler != null) foreach (var bs in brokenfilesets) await foreach (var fe in db.GetBrokenFilenames(bs.FilesetID, m_result.TaskControl.ProgressToken).ConfigureAwait(false)) if (!callbackhandler(bs.Version, bs.Timestamp, bs.BrokenCount, fe.Item1, fe.Item2)) break; } private class MockList : IList { private readonly List _dummy = new List(); public MockList(int count) { Count = count; } public T this[int index] { get { throw new NotImplementedException(); } set { throw new NotImplementedException(); } } public int Count { get; private set; } public bool IsReadOnly => true; public void Add(T item) => throw new NotImplementedException(); public void Clear() => throw new NotImplementedException(); public bool Contains(T item) => throw new NotImplementedException(); public void CopyTo(T[] array, int arrayIndex) => throw new NotImplementedException(); public IEnumerator GetEnumerator() => _dummy.GetEnumerator(); public int IndexOf(T item) => throw new NotImplementedException(); public void Insert(int index, T item) => throw new NotImplementedException(); public bool Remove(T item) => throw new NotImplementedException(); public void RemoveAt(int index) => throw new NotImplementedException(); IEnumerator IEnumerable.GetEnumerator() => _dummy.GetEnumerator(); } } }