Merge pull request #50 from jjw24/enable_manual_reloaddata

Enable manual plugin data reload

Plugins/Wox.Plugin.BrowserBookmark/Commands/Bookmarks.cs

@@ -0,0 +1,35 @@
+using System.Collections.Generic;
+using System.Linq;
+using Wox.Infrastructure;
+
+namespace Wox.Plugin.BrowserBookmark.Commands
+{
+    internal static class Bookmarks
+    {
+        internal static bool MatchProgram(Bookmark bookmark, string queryString)
+        {
+            if (StringMatcher.FuzzySearch(queryString, bookmark.Name, new MatchOption()).IsSearchPrecisionScoreMet()) return true;
+            if (StringMatcher.FuzzySearch(queryString, bookmark.PinyinName, new MatchOption()).IsSearchPrecisionScoreMet()) return true;
+            if (StringMatcher.FuzzySearch(queryString, bookmark.Url, new MatchOption()).IsSearchPrecisionScoreMet()) return true;
+
+            return false;
+        }
+
+        internal static List<Bookmark> LoadAllBookmarks()
+        {
+            var allbookmarks = new List<Bookmark>();
+            
+            var chromeBookmarks = new ChromeBookmarks();
+            var mozBookmarks = new FirefoxBookmarks();
+
+            //TODO: Let the user select which browser's bookmarks are displayed
+            // Add Firefox bookmarks
+            mozBookmarks.GetBookmarks().ForEach(x => allbookmarks.Add(x));
+
+            // Add Chrome bookmarks
+            chromeBookmarks.GetBookmarks().ForEach(x => allbookmarks.Add(x));
+
+            return allbookmarks.Distinct().ToList();
+        }
+    }
+}

Plugins/Wox.Plugin.BrowserBookmark/Main.cs

@@ -1,32 +1,21 @@
 using System.Collections.Generic;
 using System.Linq;
-using Wox.Infrastructure;
+using Wox.Plugin.BrowserBookmark.Commands;
 using Wox.Plugin.SharedCommands;
 
 namespace Wox.Plugin.BrowserBookmark
 {
-    public class Main : IPlugin
+    public class Main : IPlugin, IReloadable
     {
         private PluginInitContext context;
-
+        
-        // TODO: periodically refresh the Cache?
         private List<Bookmark> cachedBookmarks = new List<Bookmark>(); 
 
         public void Init(PluginInitContext context)
         {
             this.context = context;
 
-            // Cache all bookmarks
+            cachedBookmarks = Bookmarks.LoadAllBookmarks();
-            var chromeBookmarks = new ChromeBookmarks();
-            var mozBookmarks = new FirefoxBookmarks();
-
-            //TODO: Let the user select which browser's bookmarks are displayed
-            // Add Firefox bookmarks
-            cachedBookmarks.AddRange(mozBookmarks.GetBookmarks());
-            // Add Chrome bookmarks
-            cachedBookmarks.AddRange(chromeBookmarks.GetBookmarks());
-
-            cachedBookmarks = cachedBookmarks.Distinct().ToList();
         }
 
         public List<Result> Query(Query query)
@@ -41,7 +30,7 @@ namespace Wox.Plugin.BrowserBookmark
             if (!topResults)
             {
                 // Since we mixed chrome and firefox bookmarks, we should order them again                
-                returnList = cachedBookmarks.Where(o => MatchProgram(o, param)).ToList();
+                returnList = cachedBookmarks.Where(o => Bookmarks.MatchProgram(o, param)).ToList();
                 returnList = returnList.OrderByDescending(o => o.Score).ToList();
             }
             
@@ -60,13 +49,11 @@ namespace Wox.Plugin.BrowserBookmark
             }).ToList();
         }
 
-        private bool MatchProgram(Bookmark bookmark, string queryString)
+        public void ReloadData()
         {
-            if (StringMatcher.FuzzySearch(queryString, bookmark.Name, new MatchOption()).IsSearchPrecisionScoreMet()) return true;
+            cachedBookmarks.Clear();
-            if ( StringMatcher.FuzzySearch(queryString, bookmark.PinyinName, new MatchOption()).IsSearchPrecisionScoreMet()) return true;
-            if (StringMatcher.FuzzySearch(queryString, bookmark.Url, new MatchOption()).IsSearchPrecisionScoreMet()) return true;
 
-            return false;
+            cachedBookmarks = Bookmarks.LoadAllBookmarks();
         }
     }
 }

Plugins/Wox.Plugin.BrowserBookmark/Wox.Plugin.BrowserBookmark.csproj

@@ -66,6 +66,7 @@
   <ItemGroup>
     <Compile Include="Bookmark.cs" />
     <Compile Include="ChromeBookmarks.cs" />
+    <Compile Include="Commands\Bookmarks.cs" />
     <Compile Include="FirefoxBookmarks.cs" />
     <Compile Include="Main.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />

Plugins/Wox.Plugin.Program/Main.cs

@@ -13,7 +13,7 @@ using Stopwatch = Wox.Infrastructure.Stopwatch;
 
 namespace Wox.Plugin.Program
 {
-    public class Main : ISettingProvider, IPlugin, IPluginI18n, IContextMenu, ISavable
+    public class Main : ISettingProvider, IPlugin, IPluginI18n, IContextMenu, ISavable, IReloadable
     {
         private static readonly object IndexLock = new object();
         private static Win32[] _win32s;
@@ -145,5 +145,10 @@ namespace Wox.Plugin.Program
             }
             return hide;
         }
+
+        public void ReloadData()
+        {
+            IndexPrograms();
+        }
     }
 }

Plugins/Wox.Plugin.Sys/Languages/en.xaml

@@ -15,6 +15,10 @@
     <system:String x:Key="wox_plugin_sys_sleep">Put computer to sleep</system:String>
     <system:String x:Key="wox_plugin_sys_emptyrecyclebin">Empty recycle bin</system:String>
 
+    <!--Dialogs-->
+    <system:String x:Key="wox_plugin_sys_dlgtitle_success">Success</system:String>
+    <system:String x:Key="wox_plugin_sys_dlgtext_all_applicableplugins_reloaded">Reloaded all applicable plugin data</system:String>
+
     <system:String x:Key="wox_plugin_sys_plugin_name">System Commands</system:String>
     <system:String x:Key="wox_plugin_sys_plugin_description">Provides System related commands. e.g. shutdown, lock, settings etc.</system:String>
 

Plugins/Wox.Plugin.Sys/Main.cs

@@ -207,6 +207,21 @@ namespace Wox.Plugin.Sys
                         context.API.OpenSettingDialog();
                         return true;
                     }
+                },
+                new Result
+                {
+                    Title = "Reload Plugin Data",
+                    SubTitle = "Reloads plugin data with new content added after Wox started. Plugins need to have this feature already added.",
+                    IcoPath = "Images\\app.png",
+                    Action = c =>
+                    {
+                        // Hide the window first then show msg after done because sometimes the reload could take a while, so not to make user think it's frozen. 
+                        Application.Current.MainWindow.Hide();
+                        context.API.ReloadAllPluginData();
+                        context.API.ShowMsg(context.API.GetTranslation("wox_plugin_sys_dlgtitle_success"),
+                            context.API.GetTranslation("wox_plugin_sys_dlgtext_all_applicableplugins_reloaded"));
+                        return true;
+                    }
                 }
             });
             return results;

Wox.Core/Plugin/PluginManager.cs

@@ -3,9 +3,7 @@ using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using System.Threading.Tasks;
-using Wox.Core.Resource;
 using Wox.Infrastructure;
-using Wox.Infrastructure.Exception;
 using Wox.Infrastructure.Logger;
 using Wox.Infrastructure.Storage;
 using Wox.Infrastructure.UserSettings;
@@ -66,6 +64,15 @@ namespace Wox.Core.Plugin
             }
         }
 
+        public static void ReloadData()
+        {
+            foreach(var plugin in AllPlugins)
+            {
+                var reloadablePlugin = plugin.Plugin as IReloadable;
+                reloadablePlugin?.ReloadData();
+            }
+        }
+
         static PluginManager()
         {
             ValidateUserDirectory();

Wox.Plugin/IPublicAPI.cs

@@ -62,6 +62,14 @@ namespace Wox.Plugin
         /// </summary>
         void SaveAppAllSettings();
 
+        /// <summary>
+        /// Reloads any Plugins that have the 
+        /// IReloadable implemented. It refeshes
+        /// Plugin's in memory data with new content
+        /// added by user.
+        /// </summary>
+        void ReloadAllPluginData();
+
         /// <summary>
         /// Show message box
         /// </summary>

Wox.Plugin/Interfaces/IReloadable.cs

@@ -0,0 +1,18 @@
+namespace Wox.Plugin
+{
+    /// <summary>
+    /// This interface is to indicate and allow plugins to reload their
+    /// in memory data cache or other mediums when user makes a new change
+    /// that is not immediately captured. For example, for BrowserBookmark and Program
+    /// plugin does not automatically detect when a user added a new bookmark or program,
+    /// so this interface's function is exposed to allow user manually do the reloading after 
+    /// those new additions.
+    /// 
+    /// The command that allows user to manual reload is exposed via Plugin.Sys, and
+    /// it will call the plugins that have implemented this interface.
+    /// </summary>
+    public interface IReloadable
+    {
+        void ReloadData();
+    }
+}

Wox.Plugin/Wox.Plugin.csproj

@@ -66,6 +66,7 @@
     <Compile Include="Features\IContextMenu.cs" />
     <Compile Include="Features\IExclusiveQuery.cs" />
     <Compile Include="Features\IInstantQuery.cs" />
+    <Compile Include="Interfaces\IReloadable.cs" />
     <Compile Include="IPlugin.cs" />
     <Compile Include="IPublicAPI.cs" />
     <Compile Include="ISettingProvider.cs" />

Wox/PublicAPIInstance.cs

@@ -73,6 +73,11 @@ namespace Wox
             Alphabet.Save();
         }
 
+        public void ReloadAllPluginData()
+        {
+            PluginManager.ReloadData();
+        }
+
         [Obsolete]
         public void HideApp()
         {