Files
duplicati/Duplicati/Library/Main/Operation/ListChangesHandler.cs
T
Kenneth Skovhede 179d1ceb47 Make controller Async
This PR has a large blast radius because it takes the final step and bumps up the Controller to be fully async.

We have historically done a piece-by-piece update, so all operations were already async but the controller interface was kept synchronous.

With this update, the controller is now fully async and all tests are updated.

Most places where the new C# compiler warns about function names not ending in `Async` were also adressed, giving a massive refactor change.

Functionally, no changes are done.
2026-05-13 15:04:13 +02:00

200 lines
10 KiB
C#

// Copyright (C) 2026, 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.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Duplicati.Library.Interface;
using Duplicati.Library.Utility;
namespace Duplicati.Library.Main.Operation
{
internal class ListChangesHandler
{
/// <summary>
/// The tag used for logging
/// </summary>
private static readonly string LOGTAG = Logging.Log.LogTagFromType(typeof(ListChangesHandler));
private readonly Options m_options;
private readonly ListChangesResults m_result;
public ListChangesHandler(Options options, ListChangesResults result)
{
m_options = options;
m_result = result;
}
private static Tuple<long, DateTime, T> SelectTime<T>(string value, IEnumerable<Tuple<long, DateTime, T>> list, out long index, out DateTime time, out T el)
{
long indexValue;
Tuple<long, DateTime, T> res;
if (!long.TryParse(value, out indexValue))
{
var t = Timeparser.ParseTimeInterval(value, DateTime.Now, true);
res = list.OrderBy(x => Math.Abs((x.Item2 - t).Ticks)).First();
}
else
{
res = list.OrderBy(x => Math.Abs(x.Item1 - indexValue)).First();
}
index = res.Item1;
time = res.Item2;
el = res.Item3;
return res;
}
public async Task RunAsync(string baseVersion, string compareVersion, IBackendManager backendManager, IEnumerable<string> filterstrings, IFilter compositefilter, Action<IListChangesResults, IEnumerable<Tuple<ListChangesChangeType, ListChangesElementType, string>>> callback)
{
var filter = JoinedFilterExpression.Join(new FilterExpression(filterstrings), compositefilter);
var useLocalDb = !m_options.NoLocalDb && System.IO.File.Exists(m_options.Dbpath);
baseVersion = string.IsNullOrEmpty(baseVersion) ? "1" : baseVersion;
compareVersion = string.IsNullOrEmpty(compareVersion) ? "0" : compareVersion;
long baseVersionIndex;
long compareVersionIndex;
DateTime baseVersionTime;
DateTime compareVersionTime;
using var tmpdb = useLocalDb ? null : new TempFile();
await using var db = await Database.LocalListChangesDatabase.CreateAsync(useLocalDb ? m_options.Dbpath : (string)tmpdb, null, m_result.TaskControl.ProgressToken).ConfigureAwait(false);
await using var storageKeeper = await db.CreateStorageHelperAsync(m_result.TaskControl.ProgressToken).ConfigureAwait(false);
if (useLocalDb)
{
var dbtimes = await db
.FilesetTimesAsync(m_result.TaskControl.ProgressToken)
.ToListAsync(cancellationToken: m_result.TaskControl.ProgressToken)
.ConfigureAwait(false);
if (dbtimes.Count < 2)
throw new UserInformationException(string.Format("Need at least two backups to show differences, database contains {0} backups", dbtimes.Count), "NeedTwoBackupsToStartDiff");
long baseVersionId;
long compareVersionId;
var times = dbtimes.Zip(Enumerable.Range(0, dbtimes.Count), (a, b) => new Tuple<long, DateTime, long>(b, a.Value, a.Key)).ToList();
var bt = SelectTime(baseVersion, times, out baseVersionIndex, out baseVersionTime, out baseVersionId);
times.Remove(bt);
SelectTime(compareVersion, times, out compareVersionIndex, out compareVersionTime, out compareVersionId);
await storageKeeper
.AddFromDbAsync(baseVersionId, false, filter, m_result.TaskControl.ProgressToken)
.ConfigureAwait(false);
await storageKeeper
.AddFromDbAsync(compareVersionId, true, filter, m_result.TaskControl.ProgressToken)
.ConfigureAwait(false);
}
else
{
Logging.Log.WriteInformationMessage(LOGTAG, "NoLocalDatabase", "No local database, accessing remote store");
var parsedlist = (await backendManager.ListAsync(m_result.TaskControl.ProgressToken).ConfigureAwait(false))
.Select(n => Volumes.VolumeBase.ParseFilename(n))
.Where(p => p != null && p.FileType == RemoteVolumeType.Files)
.OrderByDescending(p => p.Time)
.ToArray();
var numberedList = parsedlist.Zip(Enumerable.Range(0, parsedlist.Length), (a, b) => new Tuple<long, DateTime, Volumes.IParsedVolume>(b, a.Time, a)).ToList();
if (numberedList.Count < 2)
throw new UserInformationException(string.Format("Need at least two backups to show differences, database contains {0} backups", numberedList.Count), "NeedTwoBackupsToStartDiff");
Volumes.IParsedVolume baseFile;
Volumes.IParsedVolume compareFile;
var bt = SelectTime(baseVersion, numberedList, out baseVersionIndex, out baseVersionTime, out baseFile);
numberedList.Remove(bt);
SelectTime(compareVersion, numberedList, out compareVersionIndex, out compareVersionTime, out compareFile);
Func<FilelistEntryType, ListChangesElementType> conv = (x) =>
{
switch (x)
{
case FilelistEntryType.File:
return ListChangesElementType.File;
case FilelistEntryType.Folder:
return ListChangesElementType.Folder;
case FilelistEntryType.Symlink:
return ListChangesElementType.Symlink;
default:
return (ListChangesElementType)(-1);
}
};
if (!await m_result.TaskControl.ProgressRendevouzAsync().ConfigureAwait(false))
return;
using (new Logging.Timer(LOGTAG, "InsertBaseFiles", "Inserting base files into database"))
using (var tmpfile = await backendManager.GetAsync(baseFile.File.Name, null, baseFile.File.Size, m_result.TaskControl.ProgressToken).ConfigureAwait(false))
using (var rd = new Volumes.FilesetVolumeReader(RestoreHandler.GetCompressionModule(baseFile.File.Name), tmpfile, m_options))
foreach (var f in rd.Files)
if (FilterExpression.Matches(filter, f.Path))
await storageKeeper
.AddElementAsync(f.Path, f.Hash, f.Metahash, f.Size, conv(f.Type), false, false, m_result.TaskControl.ProgressToken)
.ConfigureAwait(false);
if (!await m_result.TaskControl.ProgressRendevouzAsync().ConfigureAwait(false))
return;
using (new Logging.Timer(LOGTAG, "InsertCompareFiles", "Inserting compare files into database"))
using (var tmpfile = await backendManager.GetAsync(compareFile.File.Name, null, compareFile.File.Size, m_result.TaskControl.ProgressToken).ConfigureAwait(false))
using (var rd = new Volumes.FilesetVolumeReader(RestoreHandler.GetCompressionModule(compareFile.File.Name), tmpfile, m_options))
foreach (var f in rd.Files)
if (FilterExpression.Matches(filter, f.Path))
await storageKeeper
.AddElementAsync(f.Path, f.Hash, f.Metahash, f.Size, conv(f.Type), true, false, m_result.TaskControl.ProgressToken)
.ConfigureAwait(false);
}
var changes = await storageKeeper
.CreateChangeCountReportAsync(m_result.TaskControl.ProgressToken)
.ConfigureAwait(false);
var sizes = await storageKeeper
.CreateChangeSizeReportAsync(m_result.TaskControl.ProgressToken)
.ConfigureAwait(false);
var lst = (m_options.FullResult || callback != null) ?
(from n in storageKeeper.CreateChangedFileReportAsync(m_result.TaskControl.ProgressToken)
select n) : null;
m_result.SetResult(
baseVersionTime, baseVersionIndex, compareVersionTime, compareVersionIndex,
changes.AddedFolders, changes.AddedSymlinks, changes.AddedFiles,
changes.DeletedFolders, changes.DeletedSymlinks, changes.DeletedFiles,
changes.ModifiedFolders, changes.ModifiedSymlinks, changes.ModifiedFiles,
sizes.AddedSize, sizes.DeletedSize, sizes.PreviousSize, sizes.CurrentSize,
(lst == null || callback == null) ? null : await lst.ToArrayAsync(cancellationToken: m_result.TaskControl.ProgressToken).ConfigureAwait(false)
);
if (callback != null)
callback(m_result, lst.ToBlockingEnumerable());
return;
}
}
}