Detect if all Drives are indexed and show a warning if they aren't (#5015)

* opens new settings search options

* Catching file not found exception

* removed unnecessary header files

* Added display strings and cleaned up code

* reduced the number of max results to 30

* added log statement for exception

* Added drive detection to settings ui but still doesn't reflect on toggling it

* added getter setter for DriveDetectionWarning

* Got UI and backend to work as expected

* Reading value from registry working as expected

* Added test for settings

* Added tests for drive detection

* rename drive detection

* Localized indexer string

* formatting

* resolving merge conflict

* Added theme aware warning icon

* changed text for the warning

* Added the warning images to the installer

src/modules/launcher/Plugins/Microsoft.Plugin.Indexer/DriveDetection/IndexerDriveDetection.cs

@@ -0,0 +1,35 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using Microsoft.Plugin.Indexer.DriveDetection;
+using Microsoft.Plugin.Indexer.Interface;
+
+namespace Microsoft.Plugin.Indexer.DriveDetection
+{
+    public class IndexerDriveDetection
+    {
+        private bool IsEnhancedModeEnabled { get; set; } = false;
+        private IRegistryWrapper _registryHelper;
+        public bool IsDriveDetectionWarningCheckBoxSelected { get; set; } = false;
+
+        public IndexerDriveDetection(IRegistryWrapper registryHelper)
+        {
+            _registryHelper = registryHelper;
+            GetEnhancedModeStatus();
+        }
+
+        // To display the results if either enhanced mode is on or if the disable drive detection checkbox is checked
+        public bool DisplayResults()
+        {
+            return IsDriveDetectionWarningCheckBoxSelected || IsEnhancedModeEnabled;
+        }
+
+        // To look up the registry entry for 
+        private void GetEnhancedModeStatus()
+        {
+            string registryLocation = @"Software\Microsoft\Windows Search\Gather\Windows\SystemIndex";
+            string valueName = "EnableFindMyFiles";
+            IsEnhancedModeEnabled = _registryHelper.GetHKLMRegistryValue(registryLocation, valueName) == 0 ? false : true;
+        }
+    }
+}

src/modules/launcher/Plugins/Microsoft.Plugin.Indexer/DriveDetection/RegistryWrapper.cs

@@ -0,0 +1,29 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using System.Windows.Input;
+using Microsoft.Plugin.Indexer.Interface;
+using Microsoft.Win32;
+
+namespace Microsoft.Plugin.Indexer.DriveDetection
+{
+    public class RegistryWrapper : IRegistryWrapper
+    {
+        // Given the registrypath and the name of the value, to retrieve the data corresponding to that registry key
+        public int GetHKLMRegistryValue(string registryLocation, string valueName)
+        {
+            using (RegistryKey regKey = Registry.LocalMachine.OpenSubKey(registryLocation))
+            {
+                if(regKey != null)
+                {
+                    Object value = regKey.GetValue(valueName);
+                    if(value != null)
+                    {
+                        return (int)value;
+                    }
+                }
+            }
+            return 0;
+        }
+    }
+}

src/modules/launcher/Plugins/Microsoft.Plugin.Indexer/Interface/IRegistryWrapper.cs

@@ -0,0 +1,11 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace Microsoft.Plugin.Indexer.Interface
+{
+    public interface IRegistryWrapper
+    {
+        int GetHKLMRegistryValue(string registryLocation, string valueName);
+    }
+}

src/modules/launcher/Plugins/Microsoft.Plugin.Indexer/Languages/de.xaml

@@ -8,5 +8,7 @@
     <system:String x:Key="Microsoft_plugin_indexer_open_in_console">Open path in console (Ctrl+Shift+C)</system:String>    
     <system:String x:Key="Microsoft_plugin_indexer_name">Name</system:String>
     <system:String x:Key="Microsoft_plugin_indexer_path">Path</system:String>
-
+    <system:String x:Key="Microsoft_plugin_indexer_drivedetectionwarning">Warning: Detected that not all drives are indexed.</system:String>
+    <system:String x:Key="Microsoft_plugin_indexer_disable_warning_in_settings">Go to Windows Search settings to fix.</system:String>
+    
 </ResourceDictionary>

src/modules/launcher/Plugins/Microsoft.Plugin.Indexer/Languages/en.xaml

@@ -8,5 +8,7 @@
     <system:String x:Key="Microsoft_plugin_indexer_open_in_console">Open path in console (Ctrl+Shift+C)</system:String>
     <system:String x:Key="Microsoft_plugin_indexer_name">Name</system:String>
     <system:String x:Key="Microsoft_plugin_indexer_path">Path</system:String>
-
+    <system:String x:Key="Microsoft_plugin_indexer_drivedetectionwarning">Warning: Detected that not all drives are indexed.</system:String>
+    <system:String x:Key="Microsoft_plugin_indexer_disable_warning_in_settings">Go to Windows Search settings to fix.</system:String>
+    
 </ResourceDictionary>

src/modules/launcher/Plugins/Microsoft.Plugin.Indexer/Languages/ja.xaml

@@ -8,5 +8,7 @@
     <system:String x:Key="Microsoft_plugin_indexer_open_in_console">Open path in console (Ctrl+Shift+C)</system:String>
     <system:String x:Key="Microsoft_plugin_indexer_name">Name</system:String>
     <system:String x:Key="Microsoft_plugin_indexer_path">Path</system:String>
+    <system:String x:Key="Microsoft_plugin_indexer_drivedetectionwarning">Warning: Detected that not all drives are indexed.</system:String>
+    <system:String x:Key="Microsoft_plugin_indexer_disable_warning_in_settings">Go to Windows Search settings to fix.</system:String>
 
 </ResourceDictionary>

src/modules/launcher/Plugins/Microsoft.Plugin.Indexer/Languages/pl.xaml

@@ -8,5 +8,7 @@
     <system:String x:Key="Microsoft_plugin_indexer_open_in_console">Open path in console (Ctrl+Shift+C)</system:String>
     <system:String x:Key="Microsoft_plugin_indexer_name">Name</system:String>
     <system:String x:Key="Microsoft_plugin_indexer_path">Path</system:String>
-
+    <system:String x:Key="Microsoft_plugin_indexer_drivedetectionwarning">Warning: Detected that not all drives are indexed.</system:String>
+    <system:String x:Key="Microsoft_plugin_indexer_disable_warning_in_settings">Go to Windows Search settings to fix.</system:String>
+    
 </ResourceDictionary>

src/modules/launcher/Plugins/Microsoft.Plugin.Indexer/Languages/tr.xaml

@@ -8,5 +8,7 @@
     <system:String x:Key="Microsoft_plugin_indexer_open_in_console">Open path in console (Ctrl+Shift+C)</system:String>
     <system:String x:Key="Microsoft_plugin_indexer_name">Name</system:String>
     <system:String x:Key="Microsoft_plugin_indexer_path">Path</system:String>
-
+    <system:String x:Key="Microsoft_plugin_indexer_drivedetectionwarning">Warning: Detected that not all drives are indexed.</system:String>
+    <system:String x:Key="Microsoft_plugin_indexer_disable_warning_in_settings">Go to Windows Search settings to fix.</system:String>
+    
 </ResourceDictionary>

src/modules/launcher/Plugins/Microsoft.Plugin.Indexer/Languages/zh-cn.xaml

@@ -8,5 +8,7 @@
     <system:String x:Key="Microsoft_plugin_indexer_open_in_console">Open path in console (Ctrl+Shift+C)</system:String>
     <system:String x:Key="Microsoft_plugin_indexer_name">Name</system:String>
     <system:String x:Key="Microsoft_plugin_indexer_path">Path</system:String>
-
+    <system:String x:Key="Microsoft_plugin_indexer_drivedetectionwarning">Warning: Detected that not all drives are indexed.</system:String>
+    <system:String x:Key="Microsoft_plugin_indexer_disable_warning_in_settings">Go to Windows Search settings to fix.</system:String>
+    
 </ResourceDictionary>

src/modules/launcher/Plugins/Microsoft.Plugin.Indexer/Languages/zh-tw.xaml

@@ -8,5 +8,7 @@
     <system:String x:Key="Microsoft_plugin_indexer_open_in_console">Open path in console (Ctrl+Shift+C)</system:String>
     <system:String x:Key="Microsoft_plugin_indexer_name">Name</system:String>
     <system:String x:Key="Microsoft_plugin_indexer_path">Path</system:String>
-
+    <system:String x:Key="Microsoft_plugin_indexer_drivedetectionwarning">Warning: Detected that not all drives are indexed.</system:String>
+    <system:String x:Key="Microsoft_plugin_indexer_disable_warning_in_settings">Go to Windows Search settings to fix.</system:String>
+    
 </ResourceDictionary>

src/modules/launcher/Plugins/Microsoft.Plugin.Indexer/Main.cs

@@ -14,6 +14,7 @@ using Microsoft.PowerToys.Settings.UI.Lib;
 using System.Windows.Controls;
 using Wox.Infrastructure.Logger;
 using System.Text.RegularExpressions;
+using Microsoft.Plugin.Indexer.DriveDetection;
 
 namespace Microsoft.Plugin.Indexer
 {
@@ -32,9 +33,12 @@ namespace Microsoft.Plugin.Indexer
         // To access Windows Search functionalities
         private readonly WindowsSearchAPI _api = new WindowsSearchAPI(new OleDBSearch());
 
+        // To obtain information regarding the drives that are indexed
+        private readonly IndexerDriveDetection _driveDetection = new IndexerDriveDetection(new RegistryWrapper());
+
         // Reserved keywords in oleDB
         private string ReservedStringPattern = @"^[\/\\\$\%]+$";
-
+        private string WarningIconPath { get; set; }
         private IContextMenu _contextMenuLoader;
 
         // To save the configurations of plugins
@@ -47,78 +51,103 @@ namespace Microsoft.Plugin.Indexer
         public List<Result> Query(Query query)
         {
             var results = new List<Result>();
-            if (!string.IsNullOrEmpty(query.Search))
-            {
-                var searchQuery = query.Search;
-                if (_settings.MaxSearchCount <= 0)
-                {
-                    _settings.MaxSearchCount = 50;
-                }
 
-                var regexMatch = Regex.Match(searchQuery, ReservedStringPattern);
-
-                if (!regexMatch.Success)
+            if (_driveDetection.DisplayResults())
+            {
+                if (!string.IsNullOrEmpty(query.Search))
                 {
-                    try
+                    var searchQuery = query.Search;
+                    if (_settings.MaxSearchCount <= 0)
                     {
-                        var searchResultsList = _api.Search(searchQuery, maxCount: _settings.MaxSearchCount).ToList();
-                        foreach (var searchResult in searchResultsList)
+                        _settings.MaxSearchCount = 50;
+                    }
+
+                    var regexMatch = Regex.Match(searchQuery, ReservedStringPattern);
+
+                    if (!regexMatch.Success)
+                    {
+                        try
                         {
-                            var path = searchResult.Path;
-                            var toolTipTitle = string.Format("{0} : {1}", _context.API.GetTranslation("Microsoft_plugin_indexer_name"), searchResult.Title);
-                            var toolTipText = string.Format("{0} : {1}", _context.API.GetTranslation("Microsoft_plugin_indexer_path"), path);
-                            string workingDir = null;
-                            if (_settings.UseLocationAsWorkingDir)
-                                workingDir = Path.GetDirectoryName(path);
-
-                            Result r = new Result();
-                            r.Title = searchResult.Title;
-                            r.SubTitle = "Search: " + path;
-                            r.IcoPath = path;
-                            r.ToolTipData = new ToolTipData(toolTipTitle, toolTipText);
-                            r.Action = c =>
+                            var searchResultsList = _api.Search(searchQuery, maxCount: _settings.MaxSearchCount).ToList();
+                            foreach (var searchResult in searchResultsList)
                             {
-                                bool hide;
-                                try
+                                var path = searchResult.Path;
+                                var toolTipTitle = string.Format("{0} : {1}", _context.API.GetTranslation("Microsoft_plugin_indexer_name"), searchResult.Title);
+                                var toolTipText = string.Format("{0} : {1}", _context.API.GetTranslation("Microsoft_plugin_indexer_path"), path);
+                                string workingDir = null;
+                                if (_settings.UseLocationAsWorkingDir)
+                                    workingDir = Path.GetDirectoryName(path);
+
+                                Result r = new Result();
+                                r.Title = searchResult.Title;
+                                r.SubTitle = "Search: " + path;
+                                r.IcoPath = path;
+                                r.ToolTipData = new ToolTipData(toolTipTitle, toolTipText);
+                                r.Action = c =>
                                 {
-                                    Process.Start(new ProcessStartInfo
+                                    bool hide;
+                                    try
                                     {
-                                        FileName = path,
-                                        UseShellExecute = true,
-                                        WorkingDirectory = workingDir
-                                    });
-                                    hide = true;
-                                }
-                                catch (Win32Exception)
+                                        Process.Start(new ProcessStartInfo
+                                        {
+                                            FileName = path,
+                                            UseShellExecute = true,
+                                            WorkingDirectory = workingDir
+                                        });
+                                        hide = true;
+                                    }
+                                    catch (Win32Exception)
+                                    {
+                                        var name = $"Plugin: {_context.CurrentPluginMetadata.Name}";
+                                        var msg = "Can't Open this file";
+                                        _context.API.ShowMsg(name, msg, string.Empty);
+                                        hide = false;
+                                    }
+                                    return hide;
+                                };
+                                r.ContextData = searchResult;
+
+                                //If the result is a directory, then it's display should show a directory.
+                                if (Directory.Exists(path))
                                 {
-                                    var name = $"Plugin: {_context.CurrentPluginMetadata.Name}";
-                                    var msg = "Can't Open this file";
-                                    _context.API.ShowMsg(name, msg, string.Empty);
-                                    hide = false;
+                                    r.QueryTextDisplay = path;
                                 }
-                                return hide;
-                            };
-                            r.ContextData = searchResult;
 
-                            //If the result is a directory, then it's display should show a directory.
-                            if (Directory.Exists(path))
-                            {
-                                r.QueryTextDisplay = path;
+                                results.Add(r);
                             }
-
-                            results.Add(r);
+                        }
+                        catch (InvalidOperationException)
+                        {
+                            //The connection has closed, internal error of ExecuteReader()
+                            //Not showing this exception to the users
+                        }
+                        catch (Exception ex)
+                        {
+                            Log.Info(ex.ToString());
                         }
                     }
-                    catch (InvalidOperationException)
+                }
+            }
+            else
+            {
+                results.Add(new Result
+                {
+                    Title = _context.API.GetTranslation("Microsoft_plugin_indexer_drivedetectionwarning"),
+                    SubTitle = _context.API.GetTranslation("Microsoft_plugin_indexer_disable_warning_in_settings"),
+                    IcoPath = WarningIconPath,
+                    Action = e =>
                     {
-                        //The connection has closed, internal error of ExecuteReader()
-                        //Not showing this exception to the users
+                        try
+                        {
+                            Process.Start(GetWindowsSearchSettingsProcessInfo());
+                        }
+                        catch (Exception ex)
+                        {
+                            Log.Exception("Microsoft.Plugin.Indexer", $"Unable to launch Windows Search Settings: {ex.Message}", ex, "Query");
+                        }
+                        return true;
                     }
-                    catch (Exception ex)
-                    {
-                        Log.Info(ex.ToString());
-                    }
-                }               
+                });
             }
 
             return results;
@@ -131,6 +160,26 @@ namespace Microsoft.Plugin.Indexer
             _contextMenuLoader = new ContextMenuLoader(context);
             _storage = new PluginJsonStorage<Settings>();
             _settings = _storage.Load();
+            _context.API.ThemeChanged += OnThemeChanged;
+            UpdateIconPath(_context.API.GetCurrentTheme());
+        }
+
+        // Todo : Update with theme based IconPath
+        private void UpdateIconPath(Theme theme)
+        {
+            if (theme == Theme.Light || theme == Theme.HighContrastWhite)
+            {
+                WarningIconPath = "Images/Warning.light.png";
+            }
+            else
+            {
+                WarningIconPath = "Images/Warning.dark.png";
+            }
+        }
+
+        private void OnThemeChanged(Theme _, Theme newTheme)
+        {
+            UpdateIconPath(newTheme);
         }
 
         // TODO: Localize the strings
@@ -154,10 +203,23 @@ namespace Microsoft.Plugin.Indexer
         public void UpdateSettings(PowerLauncherSettings settings)
         {
             _settings.MaxSearchCount = settings.properties.maximum_number_of_results;
+            _driveDetection.IsDriveDetectionWarningCheckBoxSelected = settings.properties.disable_drive_detection_warning;
         }
         public Control CreateSettingPanel()
         {
             throw new NotImplementedException();
+        }
+
+        // Returns the Process Start Information for the new Windows Search Settings
+        public ProcessStartInfo GetWindowsSearchSettingsProcessInfo()
+        {
+            var ps = new ProcessStartInfo("ms-settings:cortana-windowssearch")
+            {
+                UseShellExecute = true,
+                Verb = "open"
+            };
+
+            return ps;
         }
 
     }

src/modules/launcher/Plugins/Microsoft.Plugin.Indexer/Microsoft.Plugin.Indexer.csproj

@@ -56,6 +56,12 @@
     <None Update="Images\indexer.light.png">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
+    <None Update="Images\Warning.dark.png">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+    <None Update="Images\Warning.light.png">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
     <None Update="plugin.json">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>

src/modules/launcher/Plugins/Microsoft.Plugin.Indexer/SearchHelper/WindowsSearchAPI.cs

@@ -103,7 +103,7 @@ namespace Microsoft.Plugin.Indexer.SearchHelper
             queryHelper.QuerySorting = "System.DateModified DESC";
         }
 
-        public IEnumerable<SearchResult> Search(string keyword, string pattern = "*", int maxCount = 100)
+        public IEnumerable<SearchResult> Search(string keyword, string pattern = "*", int maxCount = 30)
         {
             lock(_lock){
                 ISearchQueryHelper queryHelper;