Merge pull request #695 from Flow-Launcher/BrowserBookmarkRefactor

Refactor Bookmark plugin

Author: jjw24

Plugins/Flow.Launcher.Plugin.BrowserBookmark/Bookmark.cs

@@ -0,0 +1,27 @@
+using Flow.Launcher.Plugin.BrowserBookmark.Models;
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Text.RegularExpressions;
+
+namespace Flow.Launcher.Plugin.BrowserBookmark
+{
+    public class ChromeBookmarkLoader : ChromiumBookmarkLoader
+    {
+        public override List<Bookmark> GetBookmarks()
+        {
+            return LoadChromeBookmarks();
+        }
+
+        private List<Bookmark> LoadChromeBookmarks()
+        {
+            var bookmarks = new List<Bookmark>();
+            String platformPath = Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData);
+            bookmarks.AddRange(LoadBookmarks(Path.Combine(platformPath, @"Google\Chrome\User Data"), "Google Chrome"));
+            bookmarks.AddRange(LoadBookmarks(Path.Combine(platformPath, @"Google\Chrome SxS\User Data"), "Google Chrome Canary"));
+            bookmarks.AddRange(LoadBookmarks(Path.Combine(platformPath, @"Chromium\User Data"), "Chromium"));
+            return bookmarks;
+        }
+    }
+}

Plugins/Flow.Launcher.Plugin.BrowserBookmark/ChromeBookmarkLoader.cs

@@ -0,0 +1,65 @@
+using Flow.Launcher.Plugin.BrowserBookmark.Models;
+using Microsoft.AspNetCore.Authentication;
+using System.Collections.Generic;
+using System.IO;
+using System.Text.Json;
+
+namespace Flow.Launcher.Plugin.BrowserBookmark
+{
+    public abstract class ChromiumBookmarkLoader : IBookmarkLoader
+    {
+        public abstract List<Bookmark> GetBookmarks();
+        protected List<Bookmark> LoadBookmarks(string browserDataPath, string name)
+        {
+            var bookmarks = new List<Bookmark>();
+            if (!Directory.Exists(browserDataPath)) return bookmarks;
+            var paths = Directory.GetDirectories(browserDataPath);
+
+            foreach (var profile in paths)
+            {
+                var bookmarkPath = Path.Combine(profile, "Bookmarks");
+                if (!File.Exists(bookmarkPath))
+                    continue;
+
+                var source = name + (Path.GetFileName(profile) == "Default" ? "" : $" ({Path.GetFileName(profile)})");
+                bookmarks.AddRange(LoadBookmarksFromFile(bookmarkPath, source));
+            }
+            return bookmarks;
+        }
+        
+        protected List<Bookmark> LoadBookmarksFromFile(string path, string source)
+        {
+            if (!File.Exists(path))
+                return new();
+            var bookmarks = new List<Bookmark>();
+            using var jsonDocument = JsonDocument.Parse(File.ReadAllText(path));
+            if (!jsonDocument.RootElement.TryGetProperty("roots", out var rootElement))
+                return new();
+            foreach (var folder in rootElement.EnumerateObject())
+            {
+                EnumerateFolderBookmark(folder.Value, bookmarks, source);
+            }
+            return bookmarks;
+        }
+
+        private void EnumerateFolderBookmark(JsonElement folderElement, List<Bookmark> bookmarks, string source)
+        {
+            foreach (var subElement in folderElement.GetProperty("children").EnumerateArray())
+            {
+                switch (subElement.GetProperty("type").GetString())
+                {
+                    case "folder":
+                        EnumerateFolderBookmark(subElement, bookmarks, source);
+                        break;
+                    default:
+                        bookmarks.Add(new Bookmark(
+                            subElement.GetProperty("name").GetString(),
+                            subElement.GetProperty("url").GetString(),
+                            source));
+                        break;
+                }
+            }
+
+        }
+    }
+}

Plugins/Flow.Launcher.Plugin.BrowserBookmark/ChromeBookmarks.cs

@@ -0,0 +1,47 @@
+using System.Collections.Generic;
+using System.Linq;
+using Flow.Launcher.Infrastructure;
+using Flow.Launcher.Plugin.BrowserBookmark.Models;
+using Flow.Launcher.Plugin.SharedModels;
+
+namespace Flow.Launcher.Plugin.BrowserBookmark.Commands
+{
+    internal static class BookmarkLoader
+    {
+        internal static MatchResult MatchProgram(Bookmark bookmark, string queryString)
+        {
+            var match = StringMatcher.FuzzySearch(queryString, bookmark.Name);
+            if (match.IsSearchPrecisionScoreMet())
+                return match;
+
+            return StringMatcher.FuzzySearch(queryString, bookmark.Url);
+        }
+
+        internal static List<Bookmark> LoadAllBookmarks(Settings setting)
+        {
+
+            var chromeBookmarks = new ChromeBookmarkLoader();
+            var mozBookmarks = new FirefoxBookmarkLoader();
+            var edgeBookmarks = new EdgeBookmarkLoader();
+
+            var allBookmarks = new List<Bookmark>();
+
+            // Add Firefox bookmarks
+            allBookmarks.AddRange(mozBookmarks.GetBookmarks());
+
+            // Add Chrome bookmarks
+            allBookmarks.AddRange(chromeBookmarks.GetBookmarks());
+
+            // Add Edge (Chromium) bookmarks
+            allBookmarks.AddRange(edgeBookmarks.GetBookmarks());
+
+            foreach (var browser in setting.CustomChromiumBrowsers)
+            {
+                var loader = new CustomChromiumBookmarkLoader(browser);
+                allBookmarks.AddRange(loader.GetBookmarks());
+            }
+
+            return allBookmarks.Distinct().ToList();
+        }
+    }
+}

Plugins/Flow.Launcher.Plugin.BrowserBookmark/ChromiumBookmarkLoader.cs

@@ -0,0 +1,19 @@
+using Flow.Launcher.Plugin.BrowserBookmark.Models;
+using System.Collections.Generic;
+
+namespace Flow.Launcher.Plugin.BrowserBookmark
+{
+    public class CustomChromiumBookmarkLoader : ChromiumBookmarkLoader
+    {
+        public CustomChromiumBookmarkLoader(CustomBrowser browser)
+        {
+            BrowserName = browser.Name;
+            BrowserDataPath = browser.DataDirectoryPath;
+        }
+        public string BrowserDataPath { get; init; }
+        public string BookmarkFilePath { get; init; }
+        public string BrowserName { get; init; }
+
+        public override List<Bookmark> GetBookmarks() => BrowserDataPath != null ? LoadBookmarks(BrowserDataPath, BrowserName) : LoadBookmarksFromFile(BookmarkFilePath, BrowserName);
+    }
+}

Plugins/Flow.Launcher.Plugin.BrowserBookmark/Commands/BookmarkLoader.cs

@@ -0,0 +1,31 @@
+using Flow.Launcher.Plugin.BrowserBookmark.Models;
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Text.Json;
+using System.Text.RegularExpressions;
+
+namespace Flow.Launcher.Plugin.BrowserBookmark
+{
+    public class EdgeBookmarkLoader : ChromiumBookmarkLoader
+    {
+
+        private readonly List<Bookmark> _bookmarks = new();
+
+        private void LoadEdgeBookmarks()
+        {
+            var platformPath = Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData);
+            LoadBookmarks(Path.Combine(platformPath, @"Microsoft\Edge\User Data"), "Microsoft Edge");
+            LoadBookmarks(Path.Combine(platformPath, @"Microsoft\Edge Dev\User Data"), "Microsoft Edge Dev");
+            LoadBookmarks(Path.Combine(platformPath, @"Microsoft\Edge SxS\User Data"), "Microsoft Edge Canary");
+        }
+        
+        public override List<Bookmark> GetBookmarks()
+        {
+            _bookmarks.Clear();
+            LoadEdgeBookmarks();
+            return _bookmarks;
+        }
+    }
+}