// 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.Linq; using System.Threading.Tasks; using Duplicati.Library.Interface; namespace Duplicati.Library.Main.Operation; /// /// Handler for listing folder contents /// internal static class ListFolderHandler { /// /// Lists the contents of a folder in a backup fileset /// /// The options to use /// The result class /// The folders to list /// The offset to start listing from /// The maximum number of entries to list /// Whether to include extended data /// A task representing the asynchronous operation public static async Task RunAsync(Options options, ListFolderResults result, string[] folders, long offset, long limit, bool extendedData) { if (!System.IO.File.Exists(options.Dbpath) || options.NoLocalDb) throw new UserInformationException("No local database found, this operation requires a local database", "NoLocalDatabase"); await using var db = await Database.LocalListDatabase.CreateAsync(options.Dbpath, null, result.TaskControl.ProgressToken) .ConfigureAwait(false); var filesetIds = await db .GetFilesetIDs(options.Time, options.Version, singleTimeMatch: true, result.TaskControl.ProgressToken) .ToArrayAsync(cancellationToken: result.TaskControl.ProgressToken) .ConfigureAwait(false); if (filesetIds.Length == 0) throw new UserInformationException("No filesets found", "NoFilesetsFound"); if (filesetIds.Length > 1) throw new UserInformationException("Multiple filesets found, please specify a single version or time", "MultipleFilesetsFound"); if (folders == null || folders.Length == 0 || folders[0] == "") { if (folders != null && folders.Length > 1) throw new UserInformationException("When no folder is specified, only one folder can be listed", "MultipleFoldersFound"); var rootFolders = await db .GetMinimalUniquePrefixEntries(filesetIds[0], result.TaskControl.ProgressToken) .ToListAsync(cancellationToken: result.TaskControl.ProgressToken) .ConfigureAwait(false); result.Entries = new PaginatedResults(0, rootFolders.Count, 1, rootFolders.Count, rootFolders); } else { var entries = await db .ListFolder( db.GetPrefixIds(folders, result.TaskControl.ProgressToken).ToBlockingEnumerable(), filesetIds[0], offset, limit, result.TaskControl.ProgressToken ) .ConfigureAwait(false); result.Entries = entries; } if (extendedData) { var coreentries = result.Entries.Items.Cast().ToArray(); var metadata = await db.GetMetadataForFilesetIds(coreentries.Select(e => e.FileId), result.TaskControl.ProgressToken).ConfigureAwait(false); for (int i = 0; i < coreentries.Length; i++) { if (metadata.TryGetValue(coreentries[i].FileId, out var dict)) coreentries[i] = coreentries[i] with { Metadata = dict }; } result.Entries = new PaginatedResults(result.Entries.Page, result.Entries.PageSize, result.Entries.TotalPages, result.Entries.TotalCount, coreentries); } } }