Merge pull request #35 from Flow-Launcher/fix_fastsort_incorrect_error

jjw24 · web-flow · commit 12a930c7c65b · 2021-09-24T00:20:43.000+10:00
Fix incorrect error reporting from Fast Sort check
diff --git a/Everything/EverythingAPI.cs b/Everything/EverythingAPI.cs
@@ -1,4 +1,4 @@
-﻿using System;
+using System;
 using System.Collections.Generic;
 using System.Runtime.InteropServices;
 using System.Text;
@@ -20,6 +20,8 @@ public interface IEverythingApi
         List<SearchResult> Search(string keyWord, CancellationToken token, SortOption sortOption = SortOption.NAME_ASCENDING, int offset = 0, int maxCount = 100);
 
         void Load(string sdkPath);
+
+        bool IsFastSortOption(SortOption sortOption);
     }
 
     public sealed class EverythingApi : IEverythingApi
@@ -93,6 +95,20 @@ private void Reset()
             }
         }
 
+        /// <summary>
+        /// Checks whether the sort option is Fast Sort.
+        /// </summary>
+        public bool IsFastSortOption(SortOption sortOption)
+        {
+            var fastSortOptionEnabled = EverythingApiDllImport.Everything_IsFastSort(sortOption);
+
+            // If the Everything service is not running, then this call will incorrectly report 
+            // the state as false. This checks for errors thrown by the api and up to the caller to handle.
+            CheckAndThrowExceptionOnError();
+
+            return fastSortOptionEnabled;
+        }
+
         /// <summary>
         /// Searches the specified key word and reset the everything API afterwards
         /// </summary>
@@ -123,11 +139,7 @@ public List<SearchResult> Search(string keyWord, CancellationToken token, SortOp
                 EverythingApiDllImport.Everything_SetSearchW(keyWord);
                 EverythingApiDllImport.Everything_SetOffset(offset);
                 EverythingApiDllImport.Everything_SetMax(maxCount);
-                
-                if(!EverythingApiDllImport.Everything_IsFastSort(sortOption))
-                {
-                    throw new InvalidOperationException("The Sort Option is not Fast Sort, it may take a long time to finish the query");
-                }
+
                 EverythingApiDllImport.Everything_SetSort(sortOption);
 
                 if (token.IsCancellationRequested)
diff --git a/EverythingSettings.xaml b/EverythingSettings.xaml
@@ -6,7 +6,6 @@
              xmlns:helper="clr-namespace:Flow.Launcher.Plugin.Everything.Helper"
              mc:Ignorable="d" 
              Loaded="View_Loaded"
-             DataContext="{Binding RelativeSource={RelativeSource Self}}"
              d:DesignHeight="300" d:DesignWidth="426.4">
     <Grid Margin="7,50" VerticalAlignment="Top" >
         <Grid.RowDefinitions>
@@ -51,13 +50,15 @@
         <TextBox  Grid.Row="3" Grid.Column="2" HorizontalAlignment="Right"
                   ToolTip="{DynamicResource flowlauncher_plugin_everything_customized_args_textbox}"
                   Margin="0,0,5,0" Width="80" Height="35" x:Name="CustomizeArgsBox" TextChanged="CustomizeExplorerArgs"></TextBox>
-        <TextBlock Margin="10" Text="{DynamicResource flowlauncher_plugin_everything_sort_by}" Grid.Row="4"/>
+        <TextBlock Margin="10 15 10 10" Text="{DynamicResource flowlauncher_plugin_everything_sort_by}" Grid.Row="4"/>
 
         <ComboBox Grid.Row="4" 
                   Grid.Column="1" 
-                  Width="200" 
-                  SelectedItem="{Binding _settings.SortOption}" 
-                  ItemsSource="{Binding _settings.SortOptions, Mode=OneWay}">
+                  Width="200"
+                  Margin="0 10 0 0"
+                  SelectedItem="{Binding SortOption}" 
+                  ItemsSource="{Binding GetSortOptions, Mode=OneWay}"
+                  SelectionChanged="onSelectionChange">
             <ComboBox.ItemTemplate>
                 <DataTemplate>
                     <Grid>
@@ -66,5 +67,10 @@
                 </DataTemplate>
             </ComboBox.ItemTemplate>
         </ComboBox>
+
+        <TextBlock Name ="tbFastSortWarning"  Grid.Row="4" Grid.Column="2" Margin="10 5 10 0" TextAlignment="Left"
+                   Text="{Binding GetSortOptionWarningMessage}"
+                   Visibility ="{Binding FastSortWarningVisibility}"
+                   Foreground="Orange" TextWrapping="Wrap" />
     </Grid>
 </UserControl>
diff --git a/EverythingSettings.xaml.cs b/EverythingSettings.xaml.cs
@@ -1,80 +1,88 @@
 ﻿using System.Windows;
 using System.Windows.Controls;
-using Flow.Launcher.Plugin.Everything.Everything;
+using Flow.Launcher.Plugin.Everything.ViewModels;
 using Microsoft.Win32;
 
 namespace Flow.Launcher.Plugin.Everything
 {
     public partial class EverythingSettings : UserControl
     {
-        public Settings _settings { get; }
+        public Settings settings { get; }
 
-        public SortOption SortOption { get; set; }
-        public SortOption[] SortOptions { get; set; }
+        private SettingsViewModel vm;
 
-        public EverythingSettings(Settings settings)
+        public EverythingSettings(Settings settings, SettingsViewModel vm)
         {
-            _settings = settings;
-            SortOption = settings.SortOption;
-            SortOptions = settings.SortOptions;
-            DataContext = this;
+            this.settings = settings;
+            this.vm = vm;
+            DataContext = vm;
             InitializeComponent();
         }
 
         private void View_Loaded(object sender, RoutedEventArgs re)
         {
-            UseLocationAsWorkingDir.IsChecked = _settings.UseLocationAsWorkingDir;
+            UseLocationAsWorkingDir.IsChecked = settings.UseLocationAsWorkingDir;
 
             UseLocationAsWorkingDir.Checked += (o, e) =>
             {
-                _settings.UseLocationAsWorkingDir = true;
+                settings.UseLocationAsWorkingDir = true;
             };
 
             UseLocationAsWorkingDir.Unchecked += (o, e) =>
             {
-                _settings.UseLocationAsWorkingDir = false;
+                settings.UseLocationAsWorkingDir = false;
             };
 
-            LaunchHidden.IsChecked = _settings.LaunchHidden;
+            LaunchHidden.IsChecked = settings.LaunchHidden;
 
             LaunchHidden.Checked += (o, e) =>
             {
-                _settings.LaunchHidden = true;
+                settings.LaunchHidden = true;
             };
 
             LaunchHidden.Unchecked += (o, e) =>
             {
-                _settings.LaunchHidden = false;
+                settings.LaunchHidden = false;
             };
 
-            EditorPath.Content = _settings.EditorPath;
-            CustomizeExplorerBox.Text = _settings.ExplorerPath;
-            CustomizeArgsBox.Text = _settings.ExplorerArgs;
+            EditorPath.Content = settings.EditorPath;
+            CustomizeExplorerBox.Text = settings.ExplorerPath;
+            CustomizeArgsBox.Text = settings.ExplorerArgs;
         }
 
         private void EditorPath_Clicked(object sender, RoutedEventArgs e)
         {
             OpenFileDialog openFileDialog = new OpenFileDialog();
             openFileDialog.Filter = "Executable File(*.exe)| *.exe";
-            if (!string.IsNullOrEmpty(_settings.EditorPath))
-                openFileDialog.InitialDirectory = System.IO.Path.GetDirectoryName(_settings.EditorPath);
+            if (!string.IsNullOrEmpty(settings.EditorPath))
+                openFileDialog.InitialDirectory = System.IO.Path.GetDirectoryName(settings.EditorPath);
 
             if (openFileDialog.ShowDialog() == true)
             {
-                _settings.EditorPath = openFileDialog.FileName;
+                settings.EditorPath = openFileDialog.FileName;
             }
 
-            EditorPath.Content = _settings.EditorPath;
+            EditorPath.Content = settings.EditorPath;
         }
 
         private void CustomizeExplorer(object sender, TextChangedEventArgs e)
         {
-            _settings.ExplorerPath = CustomizeExplorerBox.Text;
+            settings.ExplorerPath = CustomizeExplorerBox.Text;
         }
 
         private void CustomizeExplorerArgs(object sender, TextChangedEventArgs e)
         {
-            _settings.ExplorerArgs = CustomizeArgsBox.Text;
+            settings.ExplorerArgs = CustomizeArgsBox.Text;
+        }
+
+        private void onSelectionChange(object sender, SelectionChangedEventArgs e)
+        {
+            // on load, tbFastSortWarning control will not have been loaded yet
+            if (tbFastSortWarning is not null)
+            {
+                tbFastSortWarning.Visibility = vm.FastSortWarningVisibility;
+                tbFastSortWarning.Text = vm.GetSortOptionWarningMessage;
+            }
         }
     }
 }
diff --git a/Languages/en.xaml b/Languages/en.xaml
@@ -2,7 +2,7 @@
                     xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
                     xmlns:system="clr-namespace:System;assembly=mscorlib">
 
-    <system:String x:Key="flowlauncher_plugin_everything_is_not_running">Everything Service is not running</system:String>
+    <system:String x:Key="flowlauncher_plugin_everything_is_not_running">Warning: Everything service is not running</system:String>
     <system:String x:Key="flowlauncher_plugin_everything_query_error">Error while querying Everything</system:String>
     <system:String x:Key="flowlauncher_plugin_everything_copied">Copied</system:String>
     <system:String x:Key="flowlauncher_plugin_everything_canot_start">Can’t start {0}</system:String>
@@ -43,7 +43,7 @@
     <system:String x:Key="flowlauncher_plugin_everything_sort_by_date_run">Date Run</system:String>
     <system:String x:Key="flowlauncher_plugin_everything_sort_by_ascending">↑</system:String>
     <system:String x:Key="flowlauncher_plugin_everything_sort_by_descending">↓</system:String>
-
+    <system:String x:Key="flowlauncher_plugin_everything_nonfastsort_warning">Warning: This is not a Fast Sort option, searches may be slow</system:String>
 
     <system:String x:Key="flowlauncher_plugin_everything_installing_title">Everything Installation</system:String>
     <system:String x:Key="flowlauncher_plugin_everything_installing_subtitle">Installing Everything service. Please wait...</system:String>
diff --git a/Main.cs b/Main.cs
@@ -1,6 +1,7 @@
 using Droplex;
 using Flow.Launcher.Plugin.Everything.Everything;
 using Flow.Launcher.Plugin.Everything.Helper;
+using Flow.Launcher.Plugin.Everything.ViewModels;
 using Flow.Launcher.Plugin.SharedCommands;
 using System;
 using System.Collections.Generic;
@@ -19,7 +20,7 @@ public class Main : IPlugin, ISettingProvider, IPluginI18n, IContextMenu
         public const string DLL = "Everything.dll";
         private readonly IEverythingApi _api = new EverythingApi();
 
-        private PluginInitContext _context;
+        internal static PluginInitContext _context;
 
         private Settings _settings;
         private CancellationTokenSource _cancellationTokenSource;
@@ -376,7 +377,7 @@ public List<Result> LoadContextMenus(Result selectedResult)
 
         public Control CreateSettingPanel()
         {
-            return new EverythingSettings(_settings);
+            return new EverythingSettings(_settings, new SettingsViewModel(_api, _settings, _context));
         }
     }
 }
diff --git a/ViewModels/SettingsViewModel.cs b/ViewModels/SettingsViewModel.cs
@@ -0,0 +1,67 @@
+﻿using Flow.Launcher.Plugin.Everything.Everything;
+using System.Windows;
+
+namespace Flow.Launcher.Plugin.Everything.ViewModels
+{
+    public class SettingsViewModel
+    {
+        private readonly IEverythingApi api;
+
+        private readonly PluginInitContext context;
+
+        private Settings settings;
+
+        public SettingsViewModel(IEverythingApi api, Settings settings, PluginInitContext context)
+        {
+            this.api = api;
+            this.settings = settings;
+            this.context = context;
+        }
+
+        public Visibility FastSortWarningVisibility
+        {
+            get 
+            {
+                try
+                {
+                    return api.IsFastSortOption(settings.SortOption) ? Visibility.Hidden : Visibility.Visible;
+                }
+                catch (IPCErrorException)
+                {
+                    // this error occurs if the Everything service is not running, in this instance show the warning and
+                    // update the message to let user know in the settings panel.
+                    return Visibility.Visible;
+                }
+            }
+        }
+
+        public string GetSortOptionWarningMessage
+        {
+            get
+            {
+                try
+                {
+                    // this method is used to determine if Everything service is running because as at Everything v1.4.1
+                    // the sdk does not provide a dedicated interface to determine if it is running.
+                    return api.IsFastSortOption(settings.SortOption) ? string.Empty
+                        : context.API.GetTranslation("flowlauncher_plugin_everything_nonfastsort_warning");
+                }
+                catch (IPCErrorException)
+                {
+                    return context.API.GetTranslation("flowlauncher_plugin_everything_is_not_running");
+                }
+            }
+        }
+
+        public SortOption[] GetSortOptions
+        {
+            get => settings.SortOptions;
+        }
+
+        public SortOption SortOption
+        {
+            get => settings.SortOption;
+            set => settings.SortOption = value;
+        }
+    }
+}
diff --git a/plugin.json b/plugin.json
@@ -4,7 +4,7 @@
   "Name": "Everything",
   "Description": "Search Everything",
   "Author": "qianlifeng,orzfly",
-  "Version": "1.5.3",
+  "Version": "1.5.4",
   "Language": "csharp",
   "Website": "https://github.com/Flow-Launcher/Flow.Launcher.Plugin.Everything",
   "IcoPath": "Images\\find.png",

Original file line number	Diff line number	Diff line change
`@@ -1,80 +1,88 @@`
`1`	`1`	`using System.Windows;`
`2`	`2`	`using System.Windows.Controls;`
`3`		`-using Flow.Launcher.Plugin.Everything.Everything;`
	`3`	`+using Flow.Launcher.Plugin.Everything.ViewModels;`
`4`	`4`	`using Microsoft.Win32;`
`5`	`5`
`6`	`6`	`namespace Flow.Launcher.Plugin.Everything`
`7`	`7`	`{`
`8`	`8`	`public partial class EverythingSettings : UserControl`
`9`	`9`	`{`
`10`		`- public Settings _settings { get; }`
	`10`	`+ public Settings settings { get; }`
`11`	`11`
`12`		`- public SortOption SortOption { get; set; }`
`13`		`- public SortOption[] SortOptions { get; set; }`
	`12`	`+ private SettingsViewModel vm;`
`14`	`13`
`15`		`- public EverythingSettings(Settings settings)`
	`14`	`+ public EverythingSettings(Settings settings, SettingsViewModel vm)`
`16`	`15`	`{`
`17`		`- _settings = settings;`
`18`		`- SortOption = settings.SortOption;`
`19`		`- SortOptions = settings.SortOptions;`
`20`		`- DataContext = this;`
	`16`	`+ this.settings = settings;`
	`17`	`+ this.vm = vm;`
	`18`	`+ DataContext = vm;`
`21`	`19`	`InitializeComponent();`
`22`	`20`	`}`
`23`	`21`
`24`	`22`	`private void View_Loaded(object sender, RoutedEventArgs re)`
`25`	`23`	`{`
`26`		`- UseLocationAsWorkingDir.IsChecked = _settings.UseLocationAsWorkingDir;`
	`24`	`+ UseLocationAsWorkingDir.IsChecked = settings.UseLocationAsWorkingDir;`
`27`	`25`
`28`	`26`	`UseLocationAsWorkingDir.Checked += (o, e) =>`
`29`	`27`	`{`
`30`		`- _settings.UseLocationAsWorkingDir = true;`
	`28`	`+ settings.UseLocationAsWorkingDir = true;`
`31`	`29`	`};`
`32`	`30`
`33`	`31`	`UseLocationAsWorkingDir.Unchecked += (o, e) =>`
`34`	`32`	`{`
`35`		`- _settings.UseLocationAsWorkingDir = false;`
	`33`	`+ settings.UseLocationAsWorkingDir = false;`
`36`	`34`	`};`
`37`	`35`
`38`		`- LaunchHidden.IsChecked = _settings.LaunchHidden;`
	`36`	`+ LaunchHidden.IsChecked = settings.LaunchHidden;`
`39`	`37`
`40`	`38`	`LaunchHidden.Checked += (o, e) =>`
`41`	`39`	`{`
`42`		`- _settings.LaunchHidden = true;`
	`40`	`+ settings.LaunchHidden = true;`
`43`	`41`	`};`
`44`	`42`
`45`	`43`	`LaunchHidden.Unchecked += (o, e) =>`
`46`	`44`	`{`
`47`		`- _settings.LaunchHidden = false;`
	`45`	`+ settings.LaunchHidden = false;`
`48`	`46`	`};`
`49`	`47`
`50`		`- EditorPath.Content = _settings.EditorPath;`
`51`		`- CustomizeExplorerBox.Text = _settings.ExplorerPath;`
`52`		`- CustomizeArgsBox.Text = _settings.ExplorerArgs;`
	`48`	`+ EditorPath.Content = settings.EditorPath;`
	`49`	`+ CustomizeExplorerBox.Text = settings.ExplorerPath;`
	`50`	`+ CustomizeArgsBox.Text = settings.ExplorerArgs;`
`53`	`51`	`}`
`54`	`52`
`55`	`53`	`private void EditorPath_Clicked(object sender, RoutedEventArgs e)`
`56`	`54`	`{`
`57`	`55`	`OpenFileDialog openFileDialog = new OpenFileDialog();`
`58`	`56`	`openFileDialog.Filter = "Executable File(.exe)\| .exe";`
`59`		`- if (!string.IsNullOrEmpty(_settings.EditorPath))`
`60`		`- openFileDialog.InitialDirectory = System.IO.Path.GetDirectoryName(_settings.EditorPath);`
	`57`	`+ if (!string.IsNullOrEmpty(settings.EditorPath))`
	`58`	`+ openFileDialog.InitialDirectory = System.IO.Path.GetDirectoryName(settings.EditorPath);`
`61`	`59`
`62`	`60`	`if (openFileDialog.ShowDialog() == true)`
`63`	`61`	`{`
`64`		`- _settings.EditorPath = openFileDialog.FileName;`
	`62`	`+ settings.EditorPath = openFileDialog.FileName;`
`65`	`63`	`}`
`66`	`64`
`67`		`- EditorPath.Content = _settings.EditorPath;`
	`65`	`+ EditorPath.Content = settings.EditorPath;`
`68`	`66`	`}`
`69`	`67`
`70`	`68`	`private void CustomizeExplorer(object sender, TextChangedEventArgs e)`
`71`	`69`	`{`
`72`		`- _settings.ExplorerPath = CustomizeExplorerBox.Text;`
	`70`	`+ settings.ExplorerPath = CustomizeExplorerBox.Text;`
`73`	`71`	`}`
`74`	`72`
`75`	`73`	`private void CustomizeExplorerArgs(object sender, TextChangedEventArgs e)`
`76`	`74`	`{`
`77`		`- _settings.ExplorerArgs = CustomizeArgsBox.Text;`
	`75`	`+ settings.ExplorerArgs = CustomizeArgsBox.Text;`
	`76`	`+ }`
	`77`	`+`
	`78`	`+ private void onSelectionChange(object sender, SelectionChangedEventArgs e)`
	`79`	`+ {`
	`80`	`+ // on load, tbFastSortWarning control will not have been loaded yet`
	`81`	`+ if (tbFastSortWarning is not null)`
	`82`	`+ {`
	`83`	`+ tbFastSortWarning.Visibility = vm.FastSortWarningVisibility;`
	`84`	`+ tbFastSortWarning.Text = vm.GetSortOptionWarningMessage;`
	`85`	`+ }`
`78`	`86`	`}`
`79`	`87`	`}`
`80`	`88`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`using Droplex;`
`2`	`2`	`using Flow.Launcher.Plugin.Everything.Everything;`
`3`	`3`	`using Flow.Launcher.Plugin.Everything.Helper;`
	`4`	`+using Flow.Launcher.Plugin.Everything.ViewModels;`
`4`	`5`	`using Flow.Launcher.Plugin.SharedCommands;`
`5`	`6`	`using System;`
`6`	`7`	`using System.Collections.Generic;`
`@@ -19,7 +20,7 @@ public class Main : IPlugin, ISettingProvider, IPluginI18n, IContextMenu`
`19`	`20`	`public const string DLL = "Everything.dll";`
`20`	`21`	`private readonly IEverythingApi _api = new EverythingApi();`
`21`	`22`
`22`		`- private PluginInitContext _context;`
	`23`	`+ internal static PluginInitContext _context;`
`23`	`24`
`24`	`25`	`private Settings _settings;`
`25`	`26`	`private CancellationTokenSource _cancellationTokenSource;`
`@@ -376,7 +377,7 @@ public List<Result> LoadContextMenus(Result selectedResult)`
`376`	`377`
`377`	`378`	`public Control CreateSettingPanel()`
`378`	`379`	`{`
`379`		`- return new EverythingSettings(_settings);`
	`380`	`+ return new EverythingSettings(_settings, new SettingsViewModel(_api, _settings, _context));`
`380`	`381`	`}`
`381`	`382`	`}`
`382`	`383`	`}`