Merge pull request #3361 from onesounds/250320BookmarkFavicon

Support Svg File Icon Loading & Local favicon for bookmark plugin

Author: onesounds

Flow.Launcher.Core/Resource/LocalizationConverter.cs

@@ -6,6 +6,7 @@
 
 namespace Flow.Launcher.Core.Resource
 {
+    [Obsolete("LocalizationConverter is obsolete. Use with Flow.Launcher.Localization NuGet package instead.")]
     public class LocalizationConverter : IValueConverter
     {
         public object Convert(object value, Type targetType, object parameter, CultureInfo culture)

Flow.Launcher.Core/Resource/LocalizedDescriptionAttribute.cs

@@ -1,23 +1,27 @@
 using System.ComponentModel;
+using CommunityToolkit.Mvvm.DependencyInjection;
+using Flow.Launcher.Plugin;
 
 namespace Flow.Launcher.Core.Resource
 {
     public class LocalizedDescriptionAttribute : DescriptionAttribute
     {
-        private readonly Internationalization _translator;
+        // We should not initialize API in static constructor because it will create another API instance
+        private static IPublicAPI api = null;
+        private static IPublicAPI API => api ??= Ioc.Default.GetRequiredService<IPublicAPI>();
+
         private readonly string _resourceKey;
 
         public LocalizedDescriptionAttribute(string resourceKey)
         {
-            _translator = InternationalizationManager.Instance;
             _resourceKey = resourceKey;
         }
 
         public override string Description
         {
             get
             {
-                string description = _translator.GetTranslation(_resourceKey);
+                string description = API.GetTranslation(_resourceKey);
                 return string.IsNullOrWhiteSpace(description) ? 
                     string.Format("[[{0}]]", _resourceKey) : description;
             }

Flow.Launcher.Core/Resource/TranslationConverter.cs

@@ -1,19 +1,25 @@
 using System;
 using System.Globalization;
 using System.Windows.Data;
+using CommunityToolkit.Mvvm.DependencyInjection;
+using Flow.Launcher.Plugin;
 
 namespace Flow.Launcher.Core.Resource
 {
     public class TranslationConverter : IValueConverter
     {
+        // We should not initialize API in static constructor because it will create another API instance
+        private static IPublicAPI api = null;
+        private static IPublicAPI API => api ??= Ioc.Default.GetRequiredService<IPublicAPI>();
+
         public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
         {
             var key = value.ToString();
-            if (String.IsNullOrEmpty(key))
-                return key;
-            return InternationalizationManager.Instance.GetTranslation(key);
+            if (string.IsNullOrEmpty(key)) return key;
+            return API.GetTranslation(key);
         }
 
-        public object ConvertBack(object value, System.Type targetType, object parameter, CultureInfo culture) => throw new System.InvalidOperationException();
+        public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture) =>
+            throw new InvalidOperationException();
     }
 }

Flow.Launcher.Infrastructure/Flow.Launcher.Infrastructure.csproj

@@ -67,6 +67,7 @@
     </PackageReference>
     <PackageReference Include="NLog" Version="4.7.10" />
     <PackageReference Include="PropertyChanged.Fody" Version="3.4.0" />
+    <PackageReference Include="SharpVectors.Wpf" Version="1.8.4.2" />
     <PackageReference Include="System.Drawing.Common" Version="7.0.0" />
     <!--ToolGood.Words.Pinyin v3.0.2.6 results in high memory usage when search with pinyin is enabled-->
     <!--Bumping to it or higher needs to test and ensure this is no longer a problem-->

Flow.Launcher.Infrastructure/Image/ImageCache.cs

@@ -1,8 +1,6 @@
 using System;
-using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.Linq;
-using System.Threading;
 using System.Threading.Tasks;
 using System.Windows.Media;
 using BitFaster.Caching.Lfu;
@@ -55,7 +53,6 @@ public bool TryGetValue(string key, bool isFullImage, out ImageSource image)
                 return image != null;
             }
 
-
             image = null;
             return false;
         }

Flow.Launcher.Infrastructure/Image/ImageLoader.cs

@@ -10,6 +10,8 @@
 using CommunityToolkit.Mvvm.DependencyInjection;
 using Flow.Launcher.Infrastructure.Storage;
 using Flow.Launcher.Plugin;
+using SharpVectors.Converters;
+using SharpVectors.Renderers.Wpf;
 
 namespace Flow.Launcher.Infrastructure.Image
 {
@@ -32,8 +34,10 @@ public static class ImageLoader
         public static ImageSource LoadingImage { get; } = new BitmapImage(new Uri(Constant.LoadingImgIcon));
         public const int SmallIconSize = 64;
         public const int FullIconSize = 256;
+        public const int FullImageSize = 320;
 
         private static readonly string[] ImageExtensions = { ".png", ".jpg", ".jpeg", ".gif", ".bmp", ".tiff", ".ico" };
+        private static readonly string SvgExtension = ".svg";
 
         public static async Task InitializeAsync()
         {
@@ -235,10 +239,11 @@ private static ImageResult GetThumbnailResult(ref string path, bool loadFullImag
                             image = LoadFullImage(path);
                             type = ImageType.FullImageFile;
                         }
-                        catch (NotSupportedException)
+                        catch (NotSupportedException ex)
                         {
                             image = Image;
                             type = ImageType.Error;
+                            API.LogException(ClassName, $"Failed to load image file from path {path}: {ex.Message}", ex);
                         }
                     }
                     else
@@ -251,6 +256,20 @@ private static ImageResult GetThumbnailResult(ref string path, bool loadFullImag
                         image = GetThumbnail(path, ThumbnailOptions.ThumbnailOnly);
                     }
                 }
+                else if (extension == SvgExtension)
+                {
+                    try
+                    {
+                        image = LoadSvgImage(path, loadFullImage);
+                        type = ImageType.FullImageFile;
+                    }
+                    catch (System.Exception ex)
+                    {
+                        image = Image;
+                        type = ImageType.Error;
+                        API.LogException(ClassName, $"Failed to load SVG image from path {path}: {ex.Message}", ex);
+                    }
+                }
                 else
                 {
                     type = ImageType.File;
@@ -324,7 +343,7 @@ public static async ValueTask<ImageSource> LoadAsync(string path, bool loadFullI
             return img;
         }
 
-        private static BitmapImage LoadFullImage(string path)
+        private static ImageSource LoadFullImage(string path)
         {
             BitmapImage image = new BitmapImage();
             image.BeginInit();
@@ -333,24 +352,24 @@ private static BitmapImage LoadFullImage(string path)
             image.CreateOptions = BitmapCreateOptions.IgnoreColorProfile;
             image.EndInit();
 
-            if (image.PixelWidth > 320)
+            if (image.PixelWidth > FullImageSize)
             {
                 BitmapImage resizedWidth = new BitmapImage();
                 resizedWidth.BeginInit();
                 resizedWidth.CacheOption = BitmapCacheOption.OnLoad;
                 resizedWidth.UriSource = new Uri(path);
                 resizedWidth.CreateOptions = BitmapCreateOptions.IgnoreColorProfile;
-                resizedWidth.DecodePixelWidth = 320;
+                resizedWidth.DecodePixelWidth = FullImageSize;
                 resizedWidth.EndInit();
 
-                if (resizedWidth.PixelHeight > 320)
+                if (resizedWidth.PixelHeight > FullImageSize)
                 {
                     BitmapImage resizedHeight = new BitmapImage();
                     resizedHeight.BeginInit();
                     resizedHeight.CacheOption = BitmapCacheOption.OnLoad;
                     resizedHeight.UriSource = new Uri(path);
                     resizedHeight.CreateOptions = BitmapCreateOptions.IgnoreColorProfile;
-                    resizedHeight.DecodePixelHeight = 320;
+                    resizedHeight.DecodePixelHeight = FullImageSize;
                     resizedHeight.EndInit();
                     return resizedHeight;
                 }
@@ -360,5 +379,50 @@ private static BitmapImage LoadFullImage(string path)
 
             return image;
         }
+
+        private static ImageSource LoadSvgImage(string path, bool loadFullImage = false)
+        {
+            // Set up drawing settings
+            var desiredHeight = loadFullImage ? FullImageSize : SmallIconSize;
+            var drawingSettings = new WpfDrawingSettings
+            {
+                IncludeRuntime = true,
+                // Set IgnoreRootViewbox to false to respect the SVG's viewBox
+                IgnoreRootViewbox = false
+            };
+
+            // Load and render the SVG
+            var converter = new FileSvgReader(drawingSettings);
+            var drawing = converter.Read(new Uri(path));
+
+            // Calculate scale to achieve desired height
+            var drawingBounds = drawing.Bounds;
+            if (drawingBounds.Height <= 0)
+            {
+                throw new InvalidOperationException($"Invalid SVG dimensions: Height must be greater than zero in {path}");
+            }
+            var scale = desiredHeight / drawingBounds.Height;
+            var scaledWidth = drawingBounds.Width * scale;
+            var scaledHeight = drawingBounds.Height * scale;
+
+            // Convert the Drawing to a Bitmap
+            var drawingVisual = new DrawingVisual();
+            using (DrawingContext drawingContext = drawingVisual.RenderOpen())
+            {
+                drawingContext.PushTransform(new ScaleTransform(scale, scale));
+                drawingContext.DrawDrawing(drawing);
+            }
+
+            // Create a RenderTargetBitmap to hold the rendered image
+            var bitmap = new RenderTargetBitmap(
+                (int)Math.Ceiling(scaledWidth),
+                (int)Math.Ceiling(scaledHeight),
+                96, // DpiX
+                96, // DpiY
+                PixelFormats.Pbgra32);
+            bitmap.Render(drawingVisual);
+
+            return bitmap;
+        }
     }
 }

Flow.Launcher.Infrastructure/NativeMethods.txt

@@ -11,11 +11,6 @@ GetModuleHandle
 GetKeyState
 VIRTUAL_KEY
 
-WM_KEYDOWN
-WM_KEYUP
-WM_SYSKEYDOWN
-WM_SYSKEYUP
-
 EnumWindows
 
 DwmSetWindowAttribute

Flow.Launcher.Infrastructure/UI/EnumBindingSource.cs

@@ -3,6 +3,7 @@
 
 namespace Flow.Launcher.Infrastructure.UI
 {
+    [Obsolete("EnumBindingSourceExtension is obsolete. Use with Flow.Launcher.Localization NuGet package instead.")]
     public class EnumBindingSourceExtension : MarkupExtension
     {
         private Type _enumType;

Flow.Launcher.Plugin/Interfaces/IPublicAPI.cs

@@ -142,15 +142,47 @@ public interface IPublicAPI
         List<PluginPair> GetAllPlugins();
 
         /// <summary>
-        /// Register a callback for Global Keyboard Event
-        /// </summary>
-        /// <param name="callback"></param>
+        /// Registers a callback function for global keyboard events.
+        /// </summary>
+        /// <param name="callback">
+        /// The callback function to invoke when a global keyboard event occurs.
+        /// <para>
+        /// Parameters:
+        /// <list type="number">
+        ///   <item><description>int: The type of <see cref="KeyEvent"/> (key down, key up, etc.)</description></item>
+        ///   <item><description>int: The virtual key code of the pressed/released key</description></item>
+        ///   <item><description><see cref="SpecialKeyState"/>: The state of modifier keys (Ctrl, Alt, Shift, etc.)</description></item>
+        /// </list>
+        /// </para>
+        /// <para>
+        /// Returns: <c>true</c> to allow normal system processing of the key event,
+        /// or <c>false</c> to intercept and prevent default handling.
+        /// </para>
+        /// </param>
+        /// <remarks>
+        /// This callback will be invoked for all keyboard events system-wide.
+        /// Use with caution as intercepting system keys may affect normal system operation.
+        /// </remarks>
         public void RegisterGlobalKeyboardCallback(Func<int, int, SpecialKeyState, bool> callback);
-        
+
         /// <summary>
         /// Remove a callback for Global Keyboard Event
         /// </summary>
-        /// <param name="callback"></param>
+        /// <param name="callback">
+        /// The callback function to invoke when a global keyboard event occurs.
+        /// <para>
+        /// Parameters:
+        /// <list type="number">
+        ///   <item><description>int: The type of <see cref="KeyEvent"/> (key down, key up, etc.)</description></item>
+        ///   <item><description>int: The virtual key code of the pressed/released key</description></item>
+        ///   <item><description><see cref="SpecialKeyState"/>: The state of modifier keys (Ctrl, Alt, Shift, etc.)</description></item>
+        /// </list>
+        /// </para>
+        /// <para>
+        /// Returns: <c>true</c> to allow normal system processing of the key event,
+        /// or <c>false</c> to intercept and prevent default handling.
+        /// </para>
+        /// </param>
         public void RemoveGlobalKeyboardCallback(Func<int, int, SpecialKeyState, bool> callback);
 
         /// <summary>
@@ -372,6 +404,7 @@ public interface IPublicAPI
         /// </returns>
         public bool SetCurrentTheme(ThemeData theme);
 
+        /// <summary>
         /// Save all Flow's plugins caches
         /// </summary>
         void SavePluginCaches();
@@ -404,7 +437,10 @@ public interface IPublicAPI
         /// </remarks>
         Task SaveCacheBinaryStorageAsync<T>(string cacheName, string cacheDirectory) where T : new();
 
-        /// Load image from path. Support local, remote and data:image url.
+        /// <summary>
+        /// Load image from path.
+        /// Support local, remote and data:image url.
+        /// Support png, jpg, jpeg, gif, bmp, tiff, ico, svg image files.
         /// If image path is missing, it will return a missing icon.
         /// </summary>
         /// <param name="path">The path of the image.</param>
@@ -418,6 +454,7 @@ public interface IPublicAPI
         /// <returns></returns>
         ValueTask<ImageSource> LoadImageAsync(string path, bool loadFullImage = false, bool cacheImage = true);
 
+        /// <summary>
         /// Update the plugin manifest
         /// </summary>
         /// <param name="usePrimaryUrlOnly">

Flow.Launcher.Infrastructure/Hotkey/KeyEvent.cs renamed to Flow.Launcher.Plugin/KeyEvent.cs

@@ -1,7 +1,12 @@
 using Windows.Win32;
 
-namespace Flow.Launcher.Infrastructure.Hotkey
+namespace Flow.Launcher.Plugin
 {
+    /// <summary>
+    /// Enumeration of key events for 
+    /// <see cref="IPublicAPI.RegisterGlobalKeyboardCallback(System.Func{int, int, SpecialKeyState, bool})"/>
+    /// and <see cref="IPublicAPI.RemoveGlobalKeyboardCallback(System.Func{int, int, SpecialKeyState, bool})"/>
+    /// </summary>
     public enum KeyEvent
     {
         /// <summary>