// 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.Collections.Generic; using Duplicati.Library.Interface; using System.Linq; using System.Runtime.ExceptionServices; using Duplicati.Library.SourceProviders; using Duplicati.Library.SourceProvider; using System.Threading.Tasks; using System.Threading; namespace Duplicati.Library.DynamicLoader { /// /// Loads all SourceProviders dynamically and exposes a list of those /// public class SourceProviderLoader { /// /// Implementation overrides specific to SourceProviders /// private class SourceProviderLoaderSub : DynamicLoader { /// /// Returns the protocol key /// /// The item to load the key for /// The protocol key protected override string GetInterfaceKey(ISourceProviderModule item) { return item.Key; } /// /// Returns the subfolders searched for SourceProviders /// protected override string[] Subfolders => ["SourceProviders"]; /// /// The built-in modules /// protected override IEnumerable BuiltInModules => SourceProviderModules.BuiltInSourceProviderModules; /// /// Instanciates a specific SourceProvider, given the url and options /// /// The url to create the instance for /// The options to pass to the instance constructor /// The instanciated SourceProvider or null if the url is not supported public ISourceProviderModule GetSourceProvider(string url, string mountPoint, Dictionary options) { var uri = new Utility.Uri(url); LoadInterfaces(); var newOpts = new Dictionary(options); foreach (var key in uri.QueryParameters.AllKeys) newOpts[key] = uri.QueryParameters[key]; lock (m_lock) { try { if (m_interfaces.ContainsKey(uri.Scheme)) return (ISourceProviderModule)Activator.CreateInstance(m_interfaces[uri.Scheme].GetType(), url, mountPoint, newOpts); } catch (System.Reflection.TargetInvocationException tex) { if (tex.InnerException != null) { // Unwrap exceptions for nicer display. The ExceptionDispatchInfo class allows us to // rethrow an exception without changing the stack trace. ExceptionDispatchInfo.Capture(tex.InnerException).Throw(); } throw; } return null; } } /// /// Gets the supported commands for a certain url /// /// The url to find commands for /// The supported commands or null if the url scheme was not supported public IReadOnlyList GetSupportedCommands(string url) { var uri = new Utility.Uri(url); LoadInterfaces(); // TODO: The loading logic is replicated in the "GetSourceProvider" method, should be refactored lock (m_lock) { ISourceProviderModule b; if (m_interfaces.TryGetValue(uri.Scheme, out b) && b != null) return GetSupportedCommandsCached(b).ToList(); else if (uri.Scheme.EndsWith("s", StringComparison.Ordinal)) { var tmpscheme = uri.Scheme.Substring(0, uri.Scheme.Length - 1); if (m_interfaces.TryGetValue(tmpscheme, out b) && b != null) return GetSupportedCommandsCached(b).ToList(); } return null; } } } /// /// The static instance used to access SourceProvider information /// private static readonly SourceProviderLoaderSub _SourceProviderLoader = new SourceProviderLoaderSub(); #region Public static API /// /// Gets a list of loaded SourceProviders, the instances can be used to extract interface information, not used to interact with the SourceProvider. /// public static ISourceProviderModule[] SourceProviders { get { return _SourceProviderLoader.Interfaces; } } /// /// Gets a list of keys supported /// public static string[] Keys { get { return _SourceProviderLoader.Keys; } } /// /// Gets the supported commands for a given SourceProvider /// /// The url to find the commands for /// The supported commands or null if the url is not supported public static IReadOnlyList GetSupportedCommands(string url) { if (string.IsNullOrEmpty(url)) throw new ArgumentNullException(nameof(url)); var commands = _SourceProviderLoader.GetSupportedCommands(url); if (commands != null) return commands; var backend = BackendLoader.GetBackend(url, []); if (backend is IFolderEnabledBackend folderBackend) commands = folderBackend.SupportedCommands.AsReadOnly(); backend?.Dispose(); return commands; } /// /// Instanciates a specific SourceProvider, given the url and options /// /// The url to create the instance for /// The mount point to use /// The options to pass to the instance constructor /// The cancellation token /// The instanciated SourceProvider or null if the url is not supported public static async Task GetSourceProvider(string url, string mountPoint, Dictionary options, CancellationToken cancellationToken) { // Source providers are preferred over backends var provider = _SourceProviderLoader.GetSourceProvider(url, mountPoint, options); if (provider == null) { // See if there is a backend that can also be a source var backend = BackendLoader.GetBackend(url, options); if (backend is IFolderEnabledBackend folderBackend) provider = new BackendSourceProvider(folderBackend, mountPoint); else backend?.Dispose(); } if (provider == null) return null; try { await provider.Initialize(cancellationToken).ConfigureAwait(false); return provider; } catch { provider.Dispose(); throw; } } #endregion /// /// Adds a SourceProvider to the loader /// /// The SourceProvider to add public static void AddSourceProvider(ISourceProviderModule SourceProvider) { _SourceProviderLoader.AddModule(SourceProvider); } } }