#region Disclaimer / License // Copyright (C) 2011, Kenneth Skovhede // http://www.hexad.dk, opensource@hexad.dk // // This library is free software; you can redistribute it and/or // modify it under the terms of the GNU Lesser General Public // License as published by the Free Software Foundation; either // version 2.1 of the License, or (at your option) any later version. // // This library is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU // Lesser General Public License for more details. // // You should have received a copy of the GNU Lesser General Public // License along with this library; if not, write to the Free Software // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA // #endregion using System; using System.Collections.Generic; using System.Text; using Duplicati.Library.Interface; using System.Collections.Specialized; using System.Web; using System.Linq; namespace Duplicati.Library.DynamicLoader { /// /// Loads all backends dynamically and exposes a list of those /// public class BackendLoader { /// /// Implementation overrides specific to backends /// private class BackendLoaderSub : DynamicLoader { /// /// Returns the protocol key /// /// The item to load the key for /// The protocol key protected override string GetInterfaceKey(IBackend item) { return item.ProtocolKey; } /// /// Returns the subfolders searched for backends /// protected override string[] Subfolders { get { return new string[] {"backends"}; } } /// /// Parses the URL into components /// /// The url to parse, the parser will remove the querystring /// The url scheme /// Extra options from the query string public static void ParseUrl(ref string url, out string scheme, out NameValueCollection extraOptions) { extraOptions = new NameValueCollection(); //If possible, we avoid parsing the string as a URL to allow flexible string handling if (false && url.IndexOf("://") > 0) { scheme = url.Substring(0, url.IndexOf("://")); var ix = url.IndexOf('?'); if (ix > 0) { extraOptions = HttpUtility.ParseQueryString(url.Substring(ix)); url = url.Substring(0, ix); } } else { var uri = new Uri(url); scheme = uri.Scheme.ToLower(); if (!string.IsNullOrEmpty(uri.Query)) { extraOptions = HttpUtility.ParseQueryString(uri.Query); url = url.Substring(0, url.Length - uri.Query.Length); } } } /// /// Instanciates a specific backend, given the url and options /// /// The url to create the instance for /// The options to pass to the instance constructor /// The instanciated backend or null if the url is not supported public IBackend GetBackend(string url, Dictionary options) { if (string.IsNullOrEmpty(url)) throw new ArgumentNullException("url"); string scheme; NameValueCollection extraOptions; ParseUrl(ref url, out scheme, out extraOptions); LoadInterfaces(); var newOpts = new Dictionary(options); foreach(var key in extraOptions.AllKeys) newOpts[key] = extraOptions[key]; lock (m_lock) { if (m_interfaces.ContainsKey(scheme)) return (IBackend)Activator.CreateInstance(m_interfaces[scheme].GetType(), url, newOpts); else if (scheme.EndsWith("s")) { var tmpscheme = scheme.Substring(0, scheme.Length - 1); if (m_interfaces.ContainsKey(tmpscheme)) { var commands = m_interfaces[tmpscheme].SupportedCommands; if (commands != null && (commands.Where(x => x.Name.Equals("use-ssl", StringComparison.InvariantCultureIgnoreCase) || (x.Aliases != null && x.Aliases.Where(y => y.Equals("use-ssl", StringComparison.InvariantCultureIgnoreCase)).Any()) ).Any())) { newOpts["use-ssl"] = "true"; return (IBackend)Activator.CreateInstance(m_interfaces[tmpscheme].GetType(), url, newOpts); } } } 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 IList GetSupportedCommands(string url) { if (string.IsNullOrEmpty(url)) throw new ArgumentNullException("url"); string scheme; NameValueCollection extraOptions; ParseUrl(ref url, out scheme, out extraOptions); LoadInterfaces(); lock (m_lock) { IBackend b; if (m_interfaces.TryGetValue(scheme, out b) && b != null) return b.SupportedCommands; else if (scheme.EndsWith("s")) { var tmpscheme = scheme.Substring(0, scheme.Length - 1); if (m_interfaces.ContainsKey(tmpscheme)) return m_interfaces[tmpscheme].SupportedCommands; } return null; } } /// /// Gets the extra url commands encoded in the query string /// /// The url to extract commands from /// The extra commands public NameValueCollection GetExtraCommands(string url) { if (string.IsNullOrEmpty(url)) throw new ArgumentNullException("url"); string scheme; NameValueCollection extraOptions; ParseUrl(ref url, out scheme, out extraOptions); return extraOptions; } } /// /// The static instance used to access backend information /// private static BackendLoaderSub _backendLoader = new BackendLoaderSub(); #region Public static API /// /// Gets a list of loaded backends, the instances can be used to extract interface information, not used to interact with the backend. /// public static IBackend[] Backends { get { return _backendLoader.Interfaces; } } /// /// Gets a list of keys supported /// public static string[] Keys { get { return _backendLoader.Keys; } } /// /// Gets the supported commands for a given backend /// /// The url to find the commands for /// The supported commands or null if the url is not supported public static IList GetSupportedCommands(string url) { if (string.IsNullOrEmpty(url)) throw new ArgumentNullException("url"); return _backendLoader.GetSupportedCommands(url); } /// /// Gets the extra url-encoded commands for a given backend /// /// The backend to find the commands for /// The extra supported commands public static IDictionary GetExtraCommands(string url) { if (string.IsNullOrEmpty(url)) throw new ArgumentNullException("url"); var tmp = _backendLoader.GetExtraCommands(url); var dict = new Dictionary(); foreach(var k in tmp.AllKeys) dict[k] = tmp[k]; return dict; } /// /// Instanciates a specific backend, given the url and options /// /// The url to create the instance for /// The options to pass to the instance constructor /// The instanciated backend or null if the url is not supported public static IBackend GetBackend(string url, Dictionary options) { return _backendLoader.GetBackend(url, options); } #endregion } }