Fix UI issues when using web search plugin with suggestions

Plugins/Wox.Plugin.WebSearch/EasyTimer.cs

@@ -0,0 +1,43 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+
+namespace Wox.Plugin.WebSearch
+{
+    public static class EasyTimer
+    {
+        public static IDisposable SetInterval(Action method, int delayInMilliseconds)
+        {
+            System.Timers.Timer timer = new System.Timers.Timer(delayInMilliseconds);
+            timer.Elapsed += (source, e) =>
+            {
+                method();
+            };
+
+            timer.Enabled = true;
+            timer.Start();
+
+            // Returns a stop handle which can be used for stopping
+            // the timer, if required
+            return timer as IDisposable;
+        }
+
+        public static IDisposable SetTimeout(Action method, int delayInMilliseconds)
+        {
+            System.Timers.Timer timer = new System.Timers.Timer(delayInMilliseconds);
+            timer.Elapsed += (source, e) =>
+            {
+                method();
+            };
+
+            timer.AutoReset = false;
+            timer.Enabled = true;
+            timer.Start();
+
+            // Returns a stop handle which can be used for stopping
+            // the timer, if required
+            return timer as IDisposable;
+        }
+    }
+}

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

@@ -7,6 +7,7 @@
     <system:String x:Key="wox_plugin_websearch_add">Add</system:String>
     <system:String x:Key="wox_plugin_websearch_action_keyword">Action Keyword</system:String>
     <system:String x:Key="wox_plugin_websearch_url">URL</system:String>
+    <system:String x:Key="wox_plugin_websearch_search">Search</system:String>
     <system:String x:Key="wox_plugin_websearch_enable_suggestion">Enable search suggestions</system:String>
     <system:String x:Key="wox_plugin_websearch_pls_select_web_search">Please select a web search</system:String>
     <system:String x:Key="wox_plugin_websearch_delete_warning">Are your sure to delete {0}?</system:String>

Plugins/Wox.Plugin.WebSearch/Languages/zh-cn.xaml

@@ -7,6 +7,7 @@
     <system:String x:Key="wox_plugin_websearch_add">添加</system:String>
     <system:String x:Key="wox_plugin_websearch_action_keyword">触发关键字</system:String>
     <system:String x:Key="wox_plugin_websearch_url">URL</system:String>
+    <system:String x:Key="wox_plugin_websearch_search">搜索</system:String>
     <system:String x:Key="wox_plugin_websearch_enable_suggestion">启用搜索建议</system:String>
     <system:String x:Key="wox_plugin_websearch_pls_select_web_search">请选择一项</system:String>
     <system:String x:Key="wox_plugin_websearch_delete_warning">你确定要删除 {0} 吗？</system:String>

Plugins/Wox.Plugin.WebSearch/Languages/zh-tw.xaml

@@ -7,6 +7,7 @@
     <system:String x:Key="wox_plugin_websearch_add">添加</system:String>
     <system:String x:Key="wox_plugin_websearch_action_keyword">觸發關鍵字</system:String>
     <system:String x:Key="wox_plugin_websearch_url">URL</system:String>
+    <system:String x:Key="wox_plugin_websearch_search">搜索</system:String>
     <system:String x:Key="wox_plugin_websearch_enable_suggestion">啟用搜索建議</system:String>
     <system:String x:Key="wox_plugin_websearch_pls_select_web_search">請選擇一項</system:String>
     <system:String x:Key="wox_plugin_websearch_delete_warning">你確定要刪除 {0} 嗎？</system:String>

Plugins/Wox.Plugin.WebSearch/WebQueryPlugin.cs

@@ -4,6 +4,8 @@ using System.Diagnostics;
 using System.IO;
 using System.Linq;
 using System.Reflection;
+using System.Timers;
+using System.Windows.Threading;
 using Wox.Plugin.Features;
 using Wox.Plugin.WebSearch.SuggestionSources;
 
@@ -12,6 +14,7 @@ namespace Wox.Plugin.WebSearch
     public class WebSearchPlugin : IPlugin, ISettingProvider, IPluginI18n, IInstantQuery, IExclusiveQuery
     {
         private PluginInitContext context;
+        private IDisposable suggestionTimer;
 
         public List<Result> Query(Query query)
         {
@@ -28,7 +31,7 @@ namespace Wox.Plugin.WebSearch
             {
                 string keyword = query.SecondToEndSearch;
                 string title = keyword;
-                string subtitle = "Search " + webSearch.Title;
+                string subtitle = context.API.GetTranslation("wox_plugin_websearch_search") + " " + webSearch.Title;
                 if (string.IsNullOrEmpty(keyword))
                 {
                     title = subtitle;
@@ -52,34 +55,42 @@ namespace Wox.Plugin.WebSearch
 
                 if (WebSearchStorage.Instance.EnableWebSearchSuggestion && !string.IsNullOrEmpty(keyword))
                 {
-                    ISuggestionSource sugg = SuggestionSourceFactory.GetSuggestionSource(
+                    if (suggestionTimer != null)
-                            WebSearchStorage.Instance.WebSearchSuggestionSource,context);
-                    if (sugg != null)
                     {
-                        var result = sugg.GetSuggestions(keyword);
+                        suggestionTimer.Dispose();
-                        if (result != null)
-                        {
-                            context.API.PushResults(query, context.CurrentPluginMetadata,
-                                result.Select(o => new Result()
-                                {
-                                    Title = o,
-                                    SubTitle = subtitle,
-                                    Score = 5,
-                                    IcoPath = webSearch.IconPath,
-                                    Action = (c) =>
-                                    {
-                                        Process.Start(webSearch.Url.Replace("{q}", Uri.EscapeDataString(o)));
-                                        return true;
-                                    }
-                                }).ToList());
-                        }
                     }
+                    suggestionTimer = EasyTimer.SetTimeout(() => { QuerySuggestions(keyword, query, subtitle, webSearch); }, 350);
                 }
             }
 
             return results;
         }
 
+        private void QuerySuggestions(string keyword, Query query, string subtitle, WebSearch webSearch)
+        {
+            ISuggestionSource sugg = SuggestionSourceFactory.GetSuggestionSource(WebSearchStorage.Instance.WebSearchSuggestionSource, context);
+            if (sugg != null)
+            {
+                var result = sugg.GetSuggestions(keyword);
+                if (result != null)
+                {
+                    context.API.PushResults(query, context.CurrentPluginMetadata,
+                        result.Select(o => new Result()
+                        {
+                            Title = o,
+                            SubTitle = subtitle,
+                            Score = 5,
+                            IcoPath = webSearch.IconPath,
+                            Action = (c) =>
+                            {
+                                Process.Start(webSearch.Url.Replace("{q}", Uri.EscapeDataString(o)));
+                                return true;
+                            }
+                        }).ToList());
+                }
+            }
+        }
+
         public void Init(PluginInitContext context)
         {
             this.context = context;

Plugins/Wox.Plugin.WebSearch/Wox.Plugin.WebSearch.csproj

@@ -51,6 +51,7 @@
     <Reference Include="WindowsBase" />
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="EasyTimer.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="SuggestionSources\Baidu.cs" />
     <Compile Include="SuggestionSources\Google.cs" />

Wox.Plugin/Features/IInstantQuery.cs

@@ -1,5 +1,9 @@
 namespace Wox.Plugin.Features
 {
+    /// <summary>
+    /// Represent plugin query will be executed in UI thread directly. Don't do long-running operation in Query method if you implement this interface
+    /// <remarks>This will improve the performance of instant search like websearch or cmd plugin</remarks>
+    /// </summary>
     public interface IInstantQuery
     {
         bool IsInstantQuery(string query);