Merge pull request #104 from theClueless/queryPluginsUpdates

Querypluginsupdates

Author: jjw24

Wox/MainWindow.xaml

@@ -87,4 +87,4 @@
             </ContentControl>
         </StackPanel>
     </Border>
-</Window>
+</Window>

Wox/ViewModel/MainViewModel.cs

@@ -13,7 +13,6 @@
 using Wox.Helper;
 using Wox.Infrastructure;
 using Wox.Infrastructure.Hotkey;
-using Wox.Infrastructure.Image;
 using Wox.Infrastructure.Storage;
 using Wox.Infrastructure.UserSettings;
 using Wox.Plugin;
@@ -25,7 +24,7 @@ public class MainViewModel : BaseModel, ISavable
     {
         #region Private Fields
 
-        private bool _queryHasReturn;
+        private bool _isQueryRunning;
         private Query _lastQuery;
         private string _queryTextBeforeLeaveResults;
 
@@ -41,7 +40,7 @@ public class MainViewModel : BaseModel, ISavable
         private CancellationToken _updateToken;
         private bool _saved;
 
-        private Internationalization _translator = InternationalizationManager.Instance;
+        private readonly Internationalization _translator = InternationalizationManager.Instance;
 
         #endregion
 
@@ -312,7 +311,7 @@ private void QueryContextMenu()
                 {
                     var filtered = results.Where
                     (
-                        r => StringMatcher.FuzzySearch(query, r.Title).IsSearchPrecisionScoreMet() 
+                        r => StringMatcher.FuzzySearch(query, r.Title).IsSearchPrecisionScoreMet()
                             || StringMatcher.FuzzySearch(query, r.SubTitle).IsSearchPrecisionScoreMet()
                     ).ToList();
                     ContextMenu.AddResults(filtered, id);
@@ -371,63 +370,59 @@ private void QueryResults()
             if (!string.IsNullOrEmpty(QueryText))
             {
                 _updateSource?.Cancel();
-                _updateSource = new CancellationTokenSource();
-                _updateToken = _updateSource.Token;
+                var currentUpdateSource = new CancellationTokenSource();
+                _updateSource = currentUpdateSource;
+                var currentCancellationToken = _updateSource.Token;
+                _updateToken = currentCancellationToken;
 
                 ProgressBarVisibility = Visibility.Hidden;
-                _queryHasReturn = false;
+                _isQueryRunning = true;
                 var query = PluginManager.QueryInit(QueryText.Trim());
                 if (query != null)
                 {
                     // handle the exclusiveness of plugin using action keyword
-                    string lastKeyword = _lastQuery.ActionKeyword;
-                    string keyword = query.ActionKeyword;
-                    if (string.IsNullOrEmpty(lastKeyword))
-                    {
-                        if (!string.IsNullOrEmpty(keyword))
-                        {
-                            Results.RemoveResultsExcept(PluginManager.NonGlobalPlugins[keyword].Metadata);
-                        }
-                    }
-                    else
-                    {
-                        if (string.IsNullOrEmpty(keyword))
-                        {
-                            Results.RemoveResultsFor(PluginManager.NonGlobalPlugins[lastKeyword].Metadata);
-                        }
-                        else if (lastKeyword != keyword)
-                        {
-                            Results.RemoveResultsExcept(PluginManager.NonGlobalPlugins[keyword].Metadata);
-                        }
-                    }
+                    RemoveOldQueryResults(query);
 
                     _lastQuery = query;
-                    Task.Delay(200, _updateToken).ContinueWith(_ =>
-                    {
-                        if (query.RawQuery == _lastQuery.RawQuery && !_queryHasReturn)
+                    Task.Delay(200, currentCancellationToken).ContinueWith(_ =>
+                    { // start the progress bar if query takes more than 200 ms and this is the current running query and it didn't finish yet
+                        if (currentUpdateSource == _updateSource && _isQueryRunning)
                         {
                             ProgressBarVisibility = Visibility.Visible;
                         }
-                    }, _updateToken);
+                    }, currentCancellationToken);
 
                     var plugins = PluginManager.ValidPluginsForQuery(query);
                     Task.Run(() =>
                     {
-                        Parallel.ForEach(plugins, plugin =>
+                        // so looping will stop once it was cancelled
+                        var parallelOptions = new ParallelOptions { CancellationToken = currentCancellationToken };
+                        try
                         {
-                            var config = _settings.PluginSettings.Plugins[plugin.Metadata.ID];
-                            if (!config.Disabled)
+                            Parallel.ForEach(plugins, parallelOptions, plugin =>
                             {
-                                var results = PluginManager.QueryForPlugin(plugin, query);
-                                UpdateResultView(results, plugin.Metadata, query);
-                            }
-                        });
+                                var config = _settings.PluginSettings.Plugins[plugin.Metadata.ID];
+                                if (!config.Disabled)
+                                {
+                                    var results = PluginManager.QueryForPlugin(plugin, query);
+                                    UpdateResultView(results, plugin.Metadata, query);
+                                }
+                            });
+                        }
+                        catch (OperationCanceledException)
+                        {
+                            // nothing to do here
+                        }
+                        
 
                         // this should happen once after all queries are done so progress bar should continue
                         // until the end of all querying
-                        _queryHasReturn = true;
-                        ProgressBarVisibility = Visibility.Hidden;
-                    }, _updateToken);
+                        _isQueryRunning = false;
+                        if (currentUpdateSource == _updateSource)
+                        { // update to hidden if this is still the current query
+                            ProgressBarVisibility = Visibility.Hidden;
+                        }
+                    }, currentCancellationToken);
                 }
             }
             else
@@ -437,6 +432,30 @@ private void QueryResults()
             }
         }
 
+        private void RemoveOldQueryResults(Query query)
+        {
+            string lastKeyword = _lastQuery.ActionKeyword;
+            string keyword = query.ActionKeyword;
+            if (string.IsNullOrEmpty(lastKeyword))
+            {
+                if (!string.IsNullOrEmpty(keyword))
+                {
+                    Results.RemoveResultsExcept(PluginManager.NonGlobalPlugins[keyword].Metadata);
+                }
+            }
+            else
+            {
+                if (string.IsNullOrEmpty(keyword))
+                {
+                    Results.RemoveResultsFor(PluginManager.NonGlobalPlugins[lastKeyword].Metadata);
+                }
+                else if (lastKeyword != keyword)
+                {
+                    Results.RemoveResultsExcept(PluginManager.NonGlobalPlugins[keyword].Metadata);
+                }
+            }
+        }
+
 
         private Result ContextMenuTopMost(Result result)
         {
@@ -660,4 +679,4 @@ public void UpdateResultView(List<Result> list, PluginMetadata metadata, Query o
 
         #endregion
     }
-}
+}

Wox/ViewModel/ResultsViewModel.cs

@@ -156,14 +156,14 @@ public void AddResults(List<Result> newRawResults, string resultId)
         private List<ResultViewModel> NewResults(List<Result> newRawResults, string resultId)
         {
             var results = Results.ToList();
-            var newResults = newRawResults.Select(r => new ResultViewModel(r)).ToList();            
+            var newResults = newRawResults.Select(r => new ResultViewModel(r)).ToList();
             var oldResults = results.Where(r => r.Result.PluginID == resultId).ToList();
 
             // Find the same results in A (old results) and B (new newResults)          
             var sameResults = oldResults
                                 .Where(t1 => newResults.Any(x => x.Result.Equals(t1.Result)))
                                 .ToList();
-            
+
             // remove result of relative complement of B in A
             foreach (var result in oldResults.Except(sameResults))
             {
@@ -248,6 +248,10 @@ public void RemoveAll(Predicate<ResultViewModel> predicate)
                 }
             }
 
+            /// <summary>
+            /// Update the results collection with new results, try to keep identical results
+            /// </summary>
+            /// <param name="newItems"></param>
             public void Update(List<ResultViewModel> newItems)
             {
                 int newCount = newItems.Count;
@@ -259,7 +263,7 @@ public void Update(List<ResultViewModel> newItems)
                     ResultViewModel oldResult = this[i];
                     ResultViewModel newResult = newItems[i];
                     if (!oldResult.Equals(newResult))
-                    {
+                    { // result is not the same update it in the current index
                         this[i] = newResult;
                     }
                     else if (oldResult.Result.Score != newResult.Result.Score)
@@ -286,4 +290,4 @@ public void Update(List<ResultViewModel> newItems)
             }
         }
     }
-}
+}