Mirrors/PowerToys
1
0
Fork 0
mirror of https://github.com/microsoft/PowerToys.git synced 2026-04-03 09:46:54 +02:00
Code Issues Packages Projects Releases Wiki Activity

[PTRun]Asynchronously load image and thumbnails (#24736)

Browse Source 
* [PTRun]Asynchronously load image and thumbnails

* Bring back check for Adobe PDF generated thumbnails

---------

Co-authored-by: Stefan Markovic <stefan@janeasystems.com>
This commit is contained in:
Jaime Bernardo
2023-03-20 13:22:51 +00:00
committed by GitHub
parent 7d4e804cec
commit 35e8d04f66
2 changed files with 132 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
src/modules/launcher/PowerLauncher/ViewModel/ResultViewModel.cs
View File

@@ -5,6 +5,7 @@
using System; using System;
using System.Collections.ObjectModel; using System.Collections.ObjectModel;
using System.Globalization; using System.Globalization;
using System.Threading.Tasks;
using System.Windows.Input; using System.Windows.Input;
using System.Windows.Media; using System.Windows.Media;
using PowerLauncher.Helper; using PowerLauncher.Helper;
@@ -38,6 +39,9 @@ namespace PowerLauncher.ViewModel
private bool _areContextButtonsActive; private bool _areContextButtonsActive;
private ImageSource _image;
private volatile bool _imageLoaded;
public bool AreContextButtonsActive public bool AreContextButtonsActive
{ {
get => _areContextButtonsActive; get => _areContextButtonsActive;
@@ -191,23 +195,49 @@ namespace PowerLauncher.ViewModel
{ {
get get
{ {
var imagePath = Result.IcoPath; if (!_imageLoaded)
if (string.IsNullOrEmpty(imagePath) && Result.Icon != null)
{ {
try _imageLoaded = true;
{ _ = LoadImageAsync();
return Result.Icon();
}
catch (Exception e)
{
Log.Exception($"IcoPath is empty and exception when calling Icon() for result <{Result.Title}> of plugin <{Result.PluginDirectory}>", e, GetType());
imagePath = ImageLoader.ErrorIconPath;
}
} }
// will get here either when icoPath has value\icon delegate is null\when had exception in delegate return _image;
return ImageLoader.Load(imagePath, _settings.GenerateThumbnailsFromFiles);
} }
private set
{
_image = value;
OnPropertyChanged(nameof(Image));
}
}
private async Task<ImageSource> LoadImageInternalAsync(string imagePath, Result.IconDelegate icon, bool loadFullImage)
{
if (string.IsNullOrEmpty(imagePath) && icon != null)
{
try
{
var image = icon();
return image;
}
catch (Exception e)
{
Log.Exception(
$"IcoPath is empty and exception when calling Icon() for result <{Result.Title}> of plugin <{Result.PluginDirectory}>",
e,
System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);
imagePath = ImageLoader.ErrorIconPath;
}
}
return await ImageLoader.LoadAsync(imagePath, _settings.GenerateThumbnailsFromFiles, loadFullImage).ConfigureAwait(false);
}
private async Task LoadImageAsync()
{
var imagePath = Result.IcoPath;
var iconDelegate = Result.Icon;
Image = await LoadImageInternalAsync(imagePath, iconDelegate, false).ConfigureAwait(false);
} }
// Returns false if we've already reached the last item. // Returns false if we've already reached the last item.

169
src/modules/launcher/Wox.Infrastructure/Image/ImageLoader.cs
View File

@@ -64,12 +64,12 @@ namespace Wox.Infrastructure.Image
UpdateIconPath(theme); UpdateIconPath(theme);
Task.Run(() => Task.Run(() =>
{ {
Stopwatch.Normal("ImageLoader.Initialize - Preload images cost", () => Stopwatch.Normal("ImageLoader.Initialize - Preload images cost", async () =>
{ {
ImageCache.Usage.AsParallel().ForAll(x => foreach (var (path, _) in ImageCache.Usage)
{ {
Load(x.Key, true); await LoadAsync(path, true);
}); }
}); });
Log.Info($"Number of preload images is <{ImageCache.Usage.Count}>, Images Number: {ImageCache.CacheSize()}, Unique Items {ImageCache.UniqueImagesInCache()}", MethodBase.GetCurrentMethod().DeclaringType); Log.Info($"Number of preload images is <{ImageCache.Usage.Count}>, Images Number: {ImageCache.CacheSize()}, Unique Items {ImageCache.UniqueImagesInCache()}", MethodBase.GetCurrentMethod().DeclaringType);
@@ -120,10 +120,9 @@ namespace Wox.Infrastructure.Image
Cache, Cache,
} }
private static ImageResult LoadInternal(string path, bool generateThumbnailsFromFiles, bool loadFullImage = false) private static async ValueTask<ImageResult> LoadInternalAsync(string path, bool generateThumbnailsFromFiles, bool loadFullImage = false)
{ {
ImageSource image; ImageResult imageResult;
ImageType type = ImageType.Error;
try try
{ {
if (string.IsNullOrEmpty(path)) if (string.IsNullOrEmpty(path))
@@ -144,82 +143,92 @@ namespace Wox.Infrastructure.Image
return new ImageResult(imageSource, ImageType.Data); return new ImageResult(imageSource, ImageType.Data);
} }
if (!Path.IsPathRooted(path)) imageResult = await Task.Run(() => GetThumbnailResult(ref path, generateThumbnailsFromFiles, loadFullImage));
{
path = Path.Combine(Constant.ProgramDirectory, "Images", Path.GetFileName(path));
}
if (Directory.Exists(path))
{
/* Directories can also have thumbnails instead of shell icons.
* Generating thumbnails for a bunch of folders while scrolling through
* results from Everything makes a big impact on performance and
* Wox responsibility.
* - Solution: just load the icon
*/
type = ImageType.Folder;
image = WindowsThumbnailProvider.GetThumbnail(path, Constant.ThumbnailSize, Constant.ThumbnailSize, ThumbnailOptions.IconOnly);
}
else if (File.Exists(path))
{
// Using InvariantCulture since this is internal
var extension = Path.GetExtension(path).ToLower(CultureInfo.InvariantCulture);
if (ImageExtensions.Contains(extension))
{
type = ImageType.ImageFile;
if (loadFullImage)
{
image = LoadFullImage(path);
}
else
{
// 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 (!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);
}
else
{
type = ImageType.File;
image = WindowsThumbnailProvider.GetThumbnail(path, Constant.ThumbnailSize, Constant.ThumbnailSize, ThumbnailOptions.RESIZETOFIT);
}
}
else
{
image = ImageCache[ErrorIconPath];
path = ErrorIconPath;
}
if (type != ImageType.Error)
{
image.Freeze();
}
} }
catch (System.Exception e) catch (System.Exception e)
{ {
Log.Exception($"Failed to get thumbnail for {path}", e, MethodBase.GetCurrentMethod().DeclaringType); Log.Exception($"Failed to get thumbnail for {path}", e, MethodBase.GetCurrentMethod().DeclaringType);
type = ImageType.Error; ImageSource image = ImageCache[ErrorIconPath];
image = ImageCache[ErrorIconPath];
ImageCache[path] = image; ImageCache[path] = image;
imageResult = new ImageResult(image, ImageType.Error);
}
return imageResult;
}
private static ImageResult GetThumbnailResult(ref string path, bool generateThumbnailsFromFiles, bool loadFullImage = false)
{
ImageSource image;
ImageType type = ImageType.Error;
if (!Path.IsPathRooted(path))
{
path = Path.Combine(Constant.ProgramDirectory, "Images", Path.GetFileName(path));
}
if (Directory.Exists(path))
{
/* Directories can also have thumbnails instead of shell icons.
* Generating thumbnails for a bunch of folders while scrolling through
* results from Everything makes a big impact on performance and
* Wox responsibility.
* - Solution: just load the icon
*/
type = ImageType.Folder;
image = WindowsThumbnailProvider.GetThumbnail(path, Constant.ThumbnailSize, Constant.ThumbnailSize, ThumbnailOptions.IconOnly);
}
else if (File.Exists(path))
{
// Using InvariantCulture since this is internal
var extension = Path.GetExtension(path).ToLower(CultureInfo.InvariantCulture);
if (ImageExtensions.Contains(extension))
{
type = ImageType.ImageFile;
if (loadFullImage)
{
image = LoadFullImage(path);
}
else
{
// 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 (!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);
}
else
{
type = ImageType.File;
image = WindowsThumbnailProvider.GetThumbnail(path, Constant.ThumbnailSize, Constant.ThumbnailSize, ThumbnailOptions.RESIZETOFIT);
}
}
else
{
image = ImageCache[ErrorIconPath];
path = ErrorIconPath;
}
if (type != ImageType.Error)
{
image.Freeze();
} }
return new ImageResult(image, type); return new ImageResult(image, type);
@@ -227,9 +236,9 @@ namespace Wox.Infrastructure.Image
private const bool _enableImageHash = true; private const bool _enableImageHash = true;
public static ImageSource Load(string path, bool generateThumbnailsFromFiles, bool loadFullImage = false) public static async ValueTask<ImageSource> LoadAsync(string path, bool generateThumbnailsFromFiles, bool loadFullImage = false)
{ {
var imageResult = LoadInternal(path, generateThumbnailsFromFiles, loadFullImage); var imageResult = await LoadInternalAsync(path, generateThumbnailsFromFiles, loadFullImage);
var img = imageResult.ImageSource; var img = imageResult.ImageSource;
if (imageResult.ImageType != ImageType.Error && imageResult.ImageType != ImageType.Cache) if (imageResult.ImageType != ImageType.Error && imageResult.ImageType != ImageType.Cache)