[PTRun]Add setting to disable thumbnails (#24600)

jaimecbernardo · web-flow · commit 65378200c6c1 · 2023-03-06T22:57:52.000Z
diff --git a/src/modules/launcher/PowerLauncher/SettingsReader.cs b/src/modules/launcher/PowerLauncher/SettingsReader.cs
@@ -166,6 +166,11 @@ public void ReadSettings()
                         _settings.StartupPosition = overloadSettings.Properties.Position;
                     }
 
+                    if (_settings.GenerateThumbnailsFromFiles != overloadSettings.Properties.GenerateThumbnailsFromFiles)
+                    {
+                        _settings.GenerateThumbnailsFromFiles = overloadSettings.Properties.GenerateThumbnailsFromFiles;
+                    }
+
                     retry = false;
                 }
 
diff --git a/src/modules/launcher/PowerLauncher/ViewModel/ResultViewModel.cs b/src/modules/launcher/PowerLauncher/ViewModel/ResultViewModel.cs
@@ -10,6 +10,7 @@
 using PowerLauncher.Helper;
 using PowerLauncher.Plugin;
 using Wox.Infrastructure.Image;
+using Wox.Infrastructure.UserSettings;
 using Wox.Plugin;
 using Wox.Plugin.Logger;
 
@@ -23,6 +24,8 @@ public enum ActivationType
             Hover,
         }
 
+        private readonly PowerToysRunSettings _settings;
+
         public ObservableCollection<ContextMenuItemViewModel> ContextMenuItems { get; } = new ObservableCollection<ContextMenuItemViewModel>();
 
         public ICommand ActivateContextButtonsHoverCommand { get; }
@@ -65,13 +68,15 @@ public int ContextMenuSelectedIndex
 
         public const int NoSelectionIndex = -1;
 
-        public ResultViewModel(Result result, IMainViewModel mainViewModel)
+        public ResultViewModel(Result result, IMainViewModel mainViewModel, PowerToysRunSettings settings)
         {
             if (result != null)
             {
                 Result = result;
             }
 
+            _settings = settings;
+
             ContextMenuSelectedIndex = NoSelectionIndex;
             LoadContextMenu();
 
@@ -201,7 +206,7 @@ public ImageSource Image
                 }
 
                 // will get here either when icoPath has value\icon delegate is null\when had exception in delegate
-                return ImageLoader.Load(imagePath);
+                return ImageLoader.Load(imagePath, _settings.GenerateThumbnailsFromFiles);
             }
         }
 
diff --git a/src/modules/launcher/PowerLauncher/ViewModel/ResultsViewModel.cs b/src/modules/launcher/PowerLauncher/ViewModel/ResultsViewModel.cs
@@ -272,7 +272,7 @@ public void AddResults(List<Result> newRawResults, CancellationToken ct)
             List<ResultViewModel> newResults = new List<ResultViewModel>(newRawResults.Count);
             foreach (Result r in newRawResults)
             {
-                newResults.Add(new ResultViewModel(r, _mainViewModel));
+                newResults.Add(new ResultViewModel(r, _mainViewModel, _settings));
                 ct.ThrowIfCancellationRequested();
             }
 
diff --git a/src/modules/launcher/Wox.Infrastructure/Image/ImageLoader.cs b/src/modules/launcher/Wox.Infrastructure/Image/ImageLoader.cs
@@ -12,6 +12,7 @@
 using System.Windows.Media;
 using System.Windows.Media.Imaging;
 using ManagedCommon;
+using Wox.Infrastructure.UserSettings;
 using Wox.Plugin;
 using Wox.Plugin.Logger;
 
@@ -67,7 +68,7 @@ public static void Initialize(Theme theme)
                 {
                     ImageCache.Usage.AsParallel().ForAll(x =>
                     {
-                        Load(x.Key);
+                        Load(x.Key, true);
                     });
                 });
 
@@ -119,7 +120,7 @@ private enum ImageType
             Cache,
         }
 
-        private static ImageResult LoadInternal(string path, bool loadFullImage = false)
+        private static ImageResult LoadInternal(string path, bool generateThumbnailsFromFiles, bool loadFullImage = false)
         {
             ImageSource image;
             ImageType type = ImageType.Error;
@@ -172,18 +173,27 @@ private static ImageResult LoadInternal(string path, bool loadFullImage = false)
                         }
                         else
                         {
-                            /* Although the documentation for GetImage on MSDN indicates that
-                             * if a thumbnail is available it will return one, this has proved to not
-                             * be the case in many situations while testing.
-                             * - Solution: explicitly pass the ThumbnailOnly flag
-                             */
-                            image = WindowsThumbnailProvider.GetThumbnail(path, Constant.ThumbnailSize, Constant.ThumbnailSize, ThumbnailOptions.ThumbnailOnly);
+                            // PowerToys Run internal images are png, so we make this exception
+                            if (extension == ".png" || generateThumbnailsFromFiles)
+                            {
+                                /* Although the documentation for GetImage on MSDN indicates that
+                                * if a thumbnail is available it will return one, this has proved to not
+                                * be the case in many situations while testing.
+                                * - Solution: explicitly pass the ThumbnailOnly flag
+                                */
+                                image = WindowsThumbnailProvider.GetThumbnail(path, Constant.ThumbnailSize, Constant.ThumbnailSize, ThumbnailOptions.ThumbnailOnly);
+                            }
+                            else
+                            {
+                                image = WindowsThumbnailProvider.GetThumbnail(path, Constant.ThumbnailSize, Constant.ThumbnailSize, ThumbnailOptions.IconOnly);
+                            }
                         }
                     }
-                    else if (extension == ".pdf" && WindowsThumbnailProvider.DoesPdfUseAcrobatAsProvider())
+                    else if (!generateThumbnailsFromFiles || (extension == ".pdf" && WindowsThumbnailProvider.DoesPdfUseAcrobatAsProvider()))
                     {
                         // The PDF thumbnail provider from Adobe Reader and Acrobat Pro lets crash PT Run with an Dispatcher exception. (https://github.com/microsoft/PowerToys/issues/18166)
                         // To not run into the crash, we only request the icon of PDF files if the PDF thumbnail handler is set to Adobe Reader/Acrobat Pro.
+                        // Also don't get thumbnail if the GenerateThumbnailsFromFiles option is off.
                         type = ImageType.File;
                         image = WindowsThumbnailProvider.GetThumbnail(path, Constant.ThumbnailSize, Constant.ThumbnailSize, ThumbnailOptions.IconOnly);
                     }
@@ -217,9 +227,9 @@ private static ImageResult LoadInternal(string path, bool loadFullImage = false)
 
         private const bool _enableImageHash = true;
 
-        public static ImageSource Load(string path, bool loadFullImage = false)
+        public static ImageSource Load(string path, bool generateThumbnailsFromFiles, bool loadFullImage = false)
         {
-            var imageResult = LoadInternal(path, loadFullImage);
+            var imageResult = LoadInternal(path, generateThumbnailsFromFiles, loadFullImage);
 
             var img = imageResult.ImageSource;
             if (imageResult.ImageType != ImageType.Error && imageResult.ImageType != ImageType.Cache)
diff --git a/src/modules/launcher/Wox.Infrastructure/UserSettings/PowerToysRunSettings.cs b/src/modules/launcher/Wox.Infrastructure/UserSettings/PowerToysRunSettings.cs
@@ -323,6 +323,8 @@ public bool HideNotifyIcon
 
         public bool StartedFromPowerToysRunner { get; set; }
 
+        public bool GenerateThumbnailsFromFiles { get; set; } = true;
+
         public HttpProxy Proxy { get; set; } = new HttpProxy();
 
         [JsonConverter(typeof(JsonStringEnumConverter))]
diff --git a/src/modules/launcher/Wox.Test/ResultViewModelTest.cs b/src/modules/launcher/Wox.Test/ResultViewModelTest.cs
@@ -26,7 +26,7 @@ public void Setup()
             var result = new Result();
             contextMenuResult = new ContextMenuResult();
             mainViewModelMock = new Mock<IMainViewModel>();
-            resultViewModel = new ResultViewModel(result, mainViewModelMock.Object);
+            resultViewModel = new ResultViewModel(result, mainViewModelMock.Object, null);
 
             var pluginMock = new Mock<IPlugin>();
             pluginMock.As<IContextMenu>().Setup(x => x.LoadContextMenus(result)).Returns(new List<ContextMenuResult> { contextMenuResult });
diff --git a/src/modules/launcher/Wox.Test/ResultsViewModelTest.cs b/src/modules/launcher/Wox.Test/ResultsViewModelTest.cs
@@ -18,7 +18,7 @@ public void ContextMenuSelectedIndexShouldEqualNoSelectionIndexWhenInitialized()
             // Arrange
             ResultsViewModel rvm = new ResultsViewModel();
             Result result = new Result();
-            ResultViewModel selectedItem = new ResultViewModel(result, null);
+            ResultViewModel selectedItem = new ResultViewModel(result, null, null);
             selectedItem.ContextMenuItems.Add(new ContextMenuItemViewModel(null, null, null, null, Key.None, ModifierKeys.None, null));
             rvm.SelectedItem = selectedItem;
 
@@ -32,7 +32,7 @@ public void SelectNextContextMenuItemIncrementsContextMenuSelectedIndexWhenCalle
             // Arrange
             ResultsViewModel rvm = new ResultsViewModel();
             Result result = new Result();
-            ResultViewModel selectedItem = new ResultViewModel(result, null);
+            ResultViewModel selectedItem = new ResultViewModel(result, null, null);
             selectedItem.ContextMenuItems.Add(new ContextMenuItemViewModel(null, null, null, null, Key.None, ModifierKeys.None, null));
             rvm.SelectedItem = selectedItem;
 
@@ -49,7 +49,7 @@ public void SelectNextContextMenuItemDoesnNotIncrementContextMenuSelectedIndexWh
             // Arrange
             ResultsViewModel rvm = new ResultsViewModel();
             Result result = new Result();
-            ResultViewModel selectedItem = new ResultViewModel(result, null);
+            ResultViewModel selectedItem = new ResultViewModel(result, null, null);
             selectedItem.ContextMenuItems.Add(new ContextMenuItemViewModel(null, null, null, null, Key.None, ModifierKeys.None, null));
             rvm.SelectedItem = selectedItem;
 
@@ -66,7 +66,7 @@ public void SelectPreviousContextMenuItemDecrementsContextMenuSelectedIndexWhenC
             // Arrange
             ResultsViewModel rvm = new ResultsViewModel();
             Result result = new Result();
-            ResultViewModel selectedItem = new ResultViewModel(result, null);
+            ResultViewModel selectedItem = new ResultViewModel(result, null, null);
             selectedItem.ContextMenuItems.Add(new ContextMenuItemViewModel(null, null, null, null, Key.None, ModifierKeys.None, null));
             selectedItem.ContextMenuItems.Add(new ContextMenuItemViewModel(null, null, null, null, Key.None, ModifierKeys.None, null));
             selectedItem.ContextMenuItems.Add(new ContextMenuItemViewModel(null, null, null, null, Key.None, ModifierKeys.None, null));
@@ -88,7 +88,7 @@ public void SelectPreviousContextMenuItemResetsContextMenuSelectedIndexWhenCalle
             // Arrange
             ResultsViewModel rvm = new ResultsViewModel();
             Result result = new Result();
-            ResultViewModel selectedItem = new ResultViewModel(result, null);
+            ResultViewModel selectedItem = new ResultViewModel(result, null, null);
             selectedItem.ContextMenuItems.Add(new ContextMenuItemViewModel(null, null, null, null, Key.None, ModifierKeys.None, null));
             rvm.SelectedItem = selectedItem;
 
@@ -106,7 +106,7 @@ public void IsContextMenuItemSelectedReturnsTrueWhenContextMenuItemIsSelected()
             // Arrange
             ResultsViewModel rvm = new ResultsViewModel();
             Result result = new Result();
-            ResultViewModel selectedItem = new ResultViewModel(result, null);
+            ResultViewModel selectedItem = new ResultViewModel(result, null, null);
             selectedItem.ContextMenuItems.Add(new ContextMenuItemViewModel(null, null, null, null, Key.None, ModifierKeys.None, null));
             rvm.SelectedItem = selectedItem;
 
@@ -124,7 +124,7 @@ public void IsContextMenuItemSelectedReturnsFalseWhenContextMenuItemIsNotSelecte
             // Arrange
             ResultsViewModel rvm = new ResultsViewModel();
             Result result = new Result();
-            ResultViewModel selectedItem = new ResultViewModel(result, null);
+            ResultViewModel selectedItem = new ResultViewModel(result, null, null);
             selectedItem.ContextMenuItems.Add(new ContextMenuItemViewModel(null, null, null, null, Key.None, ModifierKeys.None, null));
             rvm.SelectedItem = selectedItem;
 
diff --git a/src/settings-ui/Settings.UI.Library/PowerLauncherProperties.cs b/src/settings-ui/Settings.UI.Library/PowerLauncherProperties.cs
@@ -72,6 +72,9 @@ public class PowerLauncherProperties
         [JsonPropertyName("search_wait_for_slow_results")]
         public bool SearchWaitForSlowResults { get; set; }
 
+        [JsonPropertyName("generate_thumbnails_from_files")]
+        public bool GenerateThumbnailsFromFiles { get; set; }
+
         public PowerLauncherProperties()
         {
             OpenPowerLauncher = new HotkeySettings(false, false, true, false, 32);
@@ -92,6 +95,7 @@ public PowerLauncherProperties()
             SearchClickedItemWeight = 5;
             SearchQueryTuningEnabled = false;
             SearchWaitForSlowResults = false;
+            GenerateThumbnailsFromFiles = true;
         }
     }
 }
diff --git a/src/settings-ui/Settings.UI.UnitTests/ViewModelTests/PowerLauncherViewModelTest.cs b/src/settings-ui/Settings.UI.UnitTests/ViewModelTests/PowerLauncherViewModelTest.cs
@@ -80,6 +80,7 @@ public void OriginalFilesModificationTest(string version, string fileName)
             Assert.AreEqual(originalSettings.Properties.OverrideWinkeyS, viewModel.OverrideWinSKey);
             Assert.AreEqual(originalSettings.Properties.SearchResultPreference, viewModel.SearchResultPreference);
             Assert.AreEqual(originalSettings.Properties.SearchTypePreference, viewModel.SearchTypePreference);
+            Assert.AreEqual(originalSettings.Properties.GenerateThumbnailsFromFiles, viewModel.GenerateThumbnailsFromFiles);
 
             // Verify that the stub file was used
             var expectedCallCount = 2;  // once via the view model, and once by the test (GetSettings<T>)
diff --git a/src/settings-ui/Settings.UI/Strings/en-us/Resources.resw b/src/settings-ui/Settings.UI/Strings/en-us/Resources.resw
@@ -499,6 +499,12 @@
   <data name="PowerLauncher_TabSelectsContextButtons.Description" xml:space="preserve">
     <value>Pressing tab will first select through the available context buttons of the current selection before moving onto the next result</value>
   </data>
+  <data name="PowerLauncher_GenerateThumbnailsFromFiles.Header" xml:space="preserve">
+    <value>Generate thumbnails from files</value>
+  </data>
+  <data name="PowerLauncher_GenerateThumbnailsFromFiles.Description" xml:space="preserve">
+    <value>Results will try to generate thumbnails for files. Disabling this setting may increase stability and speed</value>
+  </data>
   <data name="PowerLauncher_SearchQueryResultsWithDelay.Header" xml:space="preserve">
     <value>Input Smoothing</value>
     <comment>This is about adding a delay to wait for more input before executing a search</comment>
diff --git a/src/settings-ui/Settings.UI/ViewModels/PowerLauncherViewModel.cs b/src/settings-ui/Settings.UI/ViewModels/PowerLauncherViewModel.cs
@@ -563,6 +563,23 @@ public bool TabSelectsContextButtons
             }
         }
 
+        public bool GenerateThumbnailsFromFiles
+        {
+            get
+            {
+                return settings.Properties.GenerateThumbnailsFromFiles;
+            }
+
+            set
+            {
+                if (settings.Properties.GenerateThumbnailsFromFiles != value)
+                {
+                    settings.Properties.GenerateThumbnailsFromFiles = value;
+                    UpdateSettings();
+                }
+            }
+        }
+
         private ObservableCollection<PowerLauncherPluginViewModel> _plugins;
 
         public ObservableCollection<PowerLauncherPluginViewModel> Plugins
diff --git a/src/settings-ui/Settings.UI/Views/PowerLauncherPage.xaml b/src/settings-ui/Settings.UI/Views/PowerLauncherPage.xaml
@@ -185,6 +185,14 @@
                             IsOn="{x:Bind ViewModel.TabSelectsContextButtons, Mode=TwoWay}" />
                     </labs:SettingsCard>
 
+                    <labs:SettingsCard
+                        x:Uid="PowerLauncher_GenerateThumbnailsFromFiles"
+                        >
+                        <ToggleSwitch
+                            x:Uid="ToggleSwitch"
+                            IsOn="{x:Bind ViewModel.GenerateThumbnailsFromFiles, Mode=TwoWay}" />
+                    </labs:SettingsCard>
+
                 </controls:SettingsGroup>
 
                 <!--<ComboBox x:Uid="PowerLauncher_SearchResultPreference"

Original file line number	Diff line number	Diff line change
`@@ -166,6 +166,11 @@ public void ReadSettings()`
`166`	`166`	`_settings.StartupPosition = overloadSettings.Properties.Position;`
`167`	`167`	`}`
`168`	`168`
	`169`	`+ if (_settings.GenerateThumbnailsFromFiles != overloadSettings.Properties.GenerateThumbnailsFromFiles)`
	`170`	`+ {`
	`171`	`+ _settings.GenerateThumbnailsFromFiles = overloadSettings.Properties.GenerateThumbnailsFromFiles;`
	`172`	`+ }`
	`173`	`+`
`169`	`174`	`retry = false;`
`170`	`175`	`}`
`171`	`176`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@`
`10`	`10`	`using PowerLauncher.Helper;`
`11`	`11`	`using PowerLauncher.Plugin;`
`12`	`12`	`using Wox.Infrastructure.Image;`
	`13`	`+using Wox.Infrastructure.UserSettings;`
`13`	`14`	`using Wox.Plugin;`
`14`	`15`	`using Wox.Plugin.Logger;`
`15`	`16`
`@@ -23,6 +24,8 @@ public enum ActivationType`
`23`	`24`	`Hover,`
`24`	`25`	`}`
`25`	`26`
	`27`	`+ private readonly PowerToysRunSettings _settings;`
	`28`	`+`
`26`	`29`	`public ObservableCollection<ContextMenuItemViewModel> ContextMenuItems { get; } = new ObservableCollection<ContextMenuItemViewModel>();`
`27`	`30`
`28`	`31`	`public ICommand ActivateContextButtonsHoverCommand { get; }`
`@@ -65,13 +68,15 @@ public int ContextMenuSelectedIndex`
`65`	`68`
`66`	`69`	`public const int NoSelectionIndex = -1;`
`67`	`70`
`68`		`- public ResultViewModel(Result result, IMainViewModel mainViewModel)`
	`71`	`+ public ResultViewModel(Result result, IMainViewModel mainViewModel, PowerToysRunSettings settings)`
`69`	`72`	`{`
`70`	`73`	`if (result != null)`
`71`	`74`	`{`
`72`	`75`	`Result = result;`
`73`	`76`	`}`
`74`	`77`
	`78`	`+ _settings = settings;`
	`79`	`+`
`75`	`80`	`ContextMenuSelectedIndex = NoSelectionIndex;`
`76`	`81`	`LoadContextMenu();`
`77`	`82`
`@@ -201,7 +206,7 @@ public ImageSource Image`
`201`	`206`	`}`
`202`	`207`
`203`	`208`	`// will get here either when icoPath has value\icon delegate is null\when had exception in delegate`
`204`		`- return ImageLoader.Load(imagePath);`
	`209`	`+ return ImageLoader.Load(imagePath, _settings.GenerateThumbnailsFromFiles);`
`205`	`210`	`}`
`206`	`211`	`}`
`207`	`212`
Original file line number	Diff line number	Diff line change
`@@ -272,7 +272,7 @@ public void AddResults(List<Result> newRawResults, CancellationToken ct)`
`272`	`272`	`List<ResultViewModel> newResults = new List<ResultViewModel>(newRawResults.Count);`
`273`	`273`	`foreach (Result r in newRawResults)`
`274`	`274`	`{`
`275`		`- newResults.Add(new ResultViewModel(r, _mainViewModel));`
	`275`	`+ newResults.Add(new ResultViewModel(r, _mainViewModel, _settings));`
`276`	`276`	`ct.ThrowIfCancellationRequested();`
`277`	`277`	`}`
`278`	`278`
Original file line number	Diff line number	Diff line change
`@@ -72,6 +72,9 @@ public class PowerLauncherProperties`
`72`	`72`	`[JsonPropertyName("search_wait_for_slow_results")]`
`73`	`73`	`public bool SearchWaitForSlowResults { get; set; }`
`74`	`74`
	`75`	`+ [JsonPropertyName("generate_thumbnails_from_files")]`
	`76`	`+ public bool GenerateThumbnailsFromFiles { get; set; }`
	`77`	`+`
`75`	`78`	`public PowerLauncherProperties()`
`76`	`79`	`{`
`77`	`80`	`OpenPowerLauncher = new HotkeySettings(false, false, true, false, 32);`
`@@ -92,6 +95,7 @@ public PowerLauncherProperties()`
`92`	`95`	`SearchClickedItemWeight = 5;`
`93`	`96`	`SearchQueryTuningEnabled = false;`
`94`	`97`	`SearchWaitForSlowResults = false;`
	`98`	`+ GenerateThumbnailsFromFiles = true;`
`95`	`99`	`}`
`96`	`100`	`}`
`97`	`101`	`}`