Adds Custom Download Provider option.

Co-authored-by: Henri J. Norden <55378880+Henri-J-Norden@users.noreply.github.com>

Author: navossoc

YAFD/Configuration.cs

@@ -35,6 +35,12 @@ public sealed class Configuration
         private const string maximumIconSize = pluginName + "MaximumIconSize";
         private int? m_maximumIconSize = null;
 
+        /// <summary>
+        /// Custom download provider
+        /// </summary>
+        private const string customDownloadProvider = pluginName + "CustomDownloadProvider";
+        private string m_customDownloadProvider = null;
+
         public Configuration(AceCustomConfig aceCustomConfig)
         {
             config = aceCustomConfig;
@@ -104,5 +110,21 @@ public void SetMaximumIconSize(int value)
             m_maximumIconSize = value;
             config.SetLong(maximumIconSize, value);
         }
+
+        public string GetCustomDownloadProvider()
+        {
+            if (string.IsNullOrEmpty(m_customDownloadProvider))
+            {
+                m_customDownloadProvider = config.GetString(customDownloadProvider, "");
+            }
+
+            return m_customDownloadProvider;
+        }
+
+        public void SetCustomDownloadProvider(string value)
+        {
+            m_customDownloadProvider = value;
+            config.SetString(customDownloadProvider, value);
+        }
     }
 }

YAFD/FaviconDialog.cs

@@ -60,14 +60,17 @@ public FaviconDialog(IPluginHost host)
             pluginHost.MainWindow.UIBlockInteraction(true);
         }
 
-        public void Run(PwEntry[] entries)
+        public void Run(PwEntry[] entries, bool customProvider)
         {
             this.entries = entries;
-            bgWorker.RunWorkerAsync();
+            bgWorker.RunWorkerAsync(customProvider);
         }
 
         private void BgWorker_DoWork(object sender, DoWorkEventArgs e)
         {
+            // Custom provider download (argument)
+            bool customProvider = (bool)e.Argument;
+
             // Progress information
             ProgressInfo progress = new ProgressInfo(entries.Length);
 
@@ -119,8 +122,16 @@ private void BgWorker_DoWork(object sender, DoWorkEventArgs e)
                                 {
                                     try
                                     {
+                                        byte[] data = null;
                                         // Download favicon
-                                        byte[] data = fd.GetIcon(url);
+                                        if (customProvider)
+                                        {
+                                            data = fd.GetIconCustomProvider(url);
+                                        }
+                                        else
+                                        {
+                                            data = fd.GetIcon(url);
+                                        }
                                         Util.Log("Icon downloaded with success");
 
                                         // Hash icon data (avoid duplicates)

YAFD/FaviconDownloader.cs

@@ -204,6 +204,55 @@ public byte[] GetIcon(string url)
             // If there is no file available
             throw new FaviconDownloaderException(FaviconDownloaderExceptionStatus.NotFound);
         }
+
+        public byte[] GetIconCustomProvider(string url)
+        {
+            // Get the hostname from the requested URL
+            var hostname = GetValidHost(url);
+
+            // Custom provider settings
+            var providerURL = YetAnotherFaviconDownloaderExt.Config.GetCustomDownloadProvider();
+            var iconSize = YetAnotherFaviconDownloaderExt.Config.GetMaximumIconSize().ToString();
+
+            // Follows KeePass placeholders convention
+            // https://keepass.info/help/base/placeholders.html
+
+            // Maybe in the future we can give full/proper support, well, not today, for now it's enough
+            providerURL = Regex.Replace(providerURL, "{URL:HOST}", hostname, RegexOptions.IgnoreCase);
+            providerURL = Regex.Replace(providerURL, "{YAFD:ICON_SIZE}", iconSize, RegexOptions.IgnoreCase);
+
+            Uri address = new Uri(providerURL);
+
+            Util.Log("CustomProvider: {0} => {1}", url, providerURL);
+
+            try
+            {
+                // Download file
+                byte[] data = DownloadData(address);
+
+                // Check if the data is a valid image and then try to resize it
+                if (ResizeImage(ref data))
+                {
+                    return data;
+                }
+            }
+            catch (WebException ex)
+            {
+                HttpWebResponse response = ex.Response as HttpWebResponse;
+                if (response != null && response.StatusCode == HttpStatusCode.NotFound)
+                {
+                    throw new FaviconDownloaderException(FaviconDownloaderExceptionStatus.NotFound);
+                }
+                else
+                {
+                    throw new FaviconDownloaderException(ex);
+               }
+            }
+
+            // If there is no file available
+            throw new FaviconDownloaderException(FaviconDownloaderExceptionStatus.NotFound);
+        }
+
         public string GetValidHost(string url)
         {
             if (!httpSchema.IsMatch(url))

YAFD/Provider.cs

@@ -0,0 +1,33 @@
+using System.Collections.Generic;
+
+namespace YetAnotherFaviconDownloader
+{
+    public class Provider
+    {
+        public string Name { get; set; }
+        public string URL { get; set; }
+
+        public Provider(string name, string url)
+        {
+            Name = name;
+            URL = url;
+        }
+
+        public override bool Equals(object obj)
+        {
+            Provider provider = obj as Provider;
+            return provider != null &&
+                   URL == provider.URL;
+        }
+
+        public override int GetHashCode()
+        {
+            return -1251312914 + EqualityComparer<string>.Default.GetHashCode(URL);
+        }
+
+        public override string ToString()
+        {
+            return Name;
+        }
+    }
+}

YAFD/ProviderList.cs

@@ -0,0 +1,53 @@
+using System;
+using System.Collections.Generic;
+using System.Text.RegularExpressions;
+
+namespace YetAnotherFaviconDownloader
+{
+    static class ProviderList
+    {
+        public static readonly string CustomURLName = "Custom URL";
+
+        private static readonly List<Provider> providers = new List<Provider>();
+        private static readonly Provider customProvider = new Provider(CustomURLName, null);
+
+        static ProviderList()
+        {
+            providers.Add(new Provider("None (Default)", null));
+            providers.Add(new Provider("DuckDuckGo", "https://icons.duckduckgo.com/ip3/{URL:HOST}.ico"));
+            providers.Add(new Provider("Favicon Kit", "https://api.faviconkit.com/{URL:HOST}/{YAFD:ICON_SIZE}"));
+            providers.Add(new Provider("Google", "https://www.google.com/s2/favicons?domain={URL:HOST}&sz={YAFD:ICON_SIZE}"));
+            providers.Add(new Provider("Yandex", "https://favicon.yandex.net/favicon/{URL:HOST}"));
+            providers.Add(customProvider);
+        }
+
+        public static Provider[] GetDefaultList()
+        {
+            return providers.ToArray();
+        }
+
+        public static Provider FindByURL(string url)
+        {
+            return providers.Find(x => x.URL == url);
+        }
+
+        public static void SetCustomProviderURL(string url)
+        {
+            customProvider.URL = url;
+        }
+
+        public static bool IsValidURL(string url)
+        {
+            // HTTP URI schema
+            var httpSchema = new Regex(@"^http(s)?://.+", RegexOptions.IgnoreCase | RegexOptions.Compiled);
+
+            if (!httpSchema.IsMatch(url))
+            {
+                return false;
+            }
+
+            Uri result;
+            return Uri.TryCreate(url, UriKind.Absolute, out result);
+        }
+    }
+}