Refactored searching to use tasks and async operations

Author: Decimation

SmartImage/Core/Interface.cs

@@ -356,7 +356,7 @@ private static string GetContextMenuString(bool added) =>
 				string? img = Path.Combine(cd2, testImg);
 
 				SearchConfig.Config.Image = img;
-				SearchConfig.Config.PriorityEngines = SearchEngineOptions.None;
+				//SearchConfig.Config.PriorityEngines = SearchEngineOptions.None;
 
 				return true;
 			}

SmartImage/Engines/Other/YandexEngine.cs

@@ -25,12 +25,13 @@ public YandexEngine() : base("https://yandex.com/images/search?rpt=imageview&url
 
 		private const int TOTAL_RES_MIN = 500_000;
 
-		private static BasicSearchResult[] FilterAndSelectBestImages(List<BasicSearchResult> rg)
+		private static ISearchResult[] FilterAndSelectBestImages(List<BasicSearchResult> rg)
 		{
 			const int TAKE_N = 5;
 
 			var best = rg.OrderByDescending(i => i.FullResolution)
 				.Take(TAKE_N)
+				.Cast<ISearchResult>()
 				.ToArray();
 
 			return best;
@@ -98,7 +99,7 @@ public override FullSearchResult GetResult(string url)
 
 				// Get more info from Yandex
 
-				string? html = Network.GetString(sr.RawUrl);
+				string? html = Network.GetString(sr.RawUrl!);
 				var     doc  = new HtmlDocument();
 				doc.LoadHtml(html);
 
@@ -115,7 +116,7 @@ public override FullSearchResult GetResult(string url)
 
 				var images = GetYandexImages(doc);
 
-				BasicSearchResult[] bestImages = FilterAndSelectBestImages(images);
+				ISearchResult[] bestImages = FilterAndSelectBestImages(images);
 
 				//
 				var best = images[0];

SmartImage/Engines/SauceNao/SauceNaoEngine.cs

@@ -55,9 +55,9 @@ public SauceNaoEngine() : this(SearchConfig.Config.SauceNaoAuth) { }
 
 		public override float? FilterThreshold => 70.00F;
 
-		private BasicSearchResult[] ConvertResults(SauceNaoDataResult[] results)
+		private ISearchResult[] ConvertResults(SauceNaoDataResult[] results)
 		{
-			var rg = new List<BasicSearchResult>();
+			var rg = new List<ISearchResult>();
 
 			foreach (var sn in results) {
 				if (sn.Urls != null) {

SmartImage/Engines/SauceNao/SauceNaoSiteIndex.cs

@@ -37,7 +37,7 @@ public enum SauceNaoSiteIndex
 		MangaUpdates          = 36,
 
 		//
-
+		ArtStation  = 39,
 		FurAffinity = 40,
 		Twitter     = 41,
 	}

SmartImage/Searching/BasicSearchResult.cs

@@ -7,7 +7,7 @@
 #nullable enable
 namespace SmartImage.Searching
 {
-	public class BasicSearchResult : ISearchResult
+	public struct BasicSearchResult : ISearchResult
 	{
 		public string Url { get; set; }
 

SmartImage/Searching/FullSearchResult.cs

@@ -4,35 +4,50 @@
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.Drawing;
+using System.IO;
 using System.Linq;
 using System.Text;
+using Novus.Utilities;
 using Novus.Win32;
 using SimpleCore.Console.CommandLine;
 using SimpleCore.Net;
 using SimpleCore.Utilities;
+using SmartImage.Core;
 using SmartImage.Engines;
+using SmartImage.Utilities;
 
 namespace SmartImage.Searching
 {
 	/// <summary>
-	///     Contains search result and information
+	///     Represents a complete search result
 	/// </summary>
 	public sealed class FullSearchResult : NConsoleOption, ISearchResult
 	{
 		public FullSearchResult(ISearchEngine engine, string url, float? similarity = null)
-			: this(engine.Color, engine.Name, url, similarity) { }
+			: this(engine.Engine, engine.Color, engine.Name, url, similarity) { }
 
-		public FullSearchResult(Color color, string name, string url, float? similarity = null)
+		public FullSearchResult(SearchEngineOptions src, Color color, string name, string url, float? similarity = null)
 		{
-			Url   = url;
-			Name  = name;
-			Color = color;
+			Engine = src;
+			Url    = url;
+			Name   = name;
+			Color  = color;
 
 			Similarity      = similarity;
 			ExtendedInfo    = new List<string>();
 			ExtendedResults = new List<FullSearchResult>();
 		}
 
+		/// <summary>
+		/// Engine
+		/// </summary>
+		public SearchEngineOptions Engine { get; }
+
+		/// <summary>
+		/// Whether this result is a result from a priority engine
+		/// </summary>
+		public bool IsPriority => SearchConfig.Config.PriorityEngines.HasFlag(Engine);
+
 		/// <summary>
 		///     Displays <see cref="ExtendedResults" />, if any, in a new menu
 		/// </summary>
@@ -200,6 +215,10 @@ public override string ToString()
 				sb.Append("-").Append(Formatting.SPACE);
 			}
 
+			if (IsPriority) {
+				sb.Append("*").Append(Formatting.SPACE);
+			}
+
 			sb.AppendLine();
 
 			/*
@@ -259,7 +278,7 @@ public void UpdateFrom(ISearchResult result)
 
 		private FullSearchResult CreateExtendedResult(ISearchResult result)
 		{
-			var sr = new FullSearchResult(Color, Name, result.Url, result.Similarity)
+			var sr = new FullSearchResult(Engine, Color, Name, result.Url, result.Similarity)
 			{
 				Width       = result.Width,
 				Height      = result.Height,
@@ -316,5 +335,36 @@ public static int CompareResults(FullSearchResult x, FullSearchResult y)
 
 			return 0;
 		}
+
+		private const string ORIGINAL_IMAGE_NAME = "(Original image)";
+
+		/// <summary>
+		/// Creates a <see cref="FullSearchResult"/> for the original image
+		/// </summary>
+		public static FullSearchResult GetOriginalImageResult(string imageUrl, FileInfo imageFile)
+		{
+			var result = new FullSearchResult(SearchEngineOptions.None, Color.White, ORIGINAL_IMAGE_NAME, imageUrl)
+			{
+				Similarity = 100.0f,
+			};
+
+			var fileFormat = FileSystem.ResolveFileType(imageFile.FullName);
+
+			double fileSizeMegabytes =
+				MathHelper.ConvertToUnit(FileSystem.GetFileSize(imageFile.FullName), MetricUnit.Mega);
+
+			(int width, int height) = Images.GetDimensions(imageFile.FullName);
+
+			result.Width  = width;
+			result.Height = height;
+
+			double mpx = MathHelper.ConvertToUnit(width * height, MetricUnit.Mega);
+
+			string infoStr = $"Info: {imageFile.Name} ({fileSizeMegabytes:F} MB) ({mpx:F} MP) ({fileFormat.Name})";
+
+			result.ExtendedInfo.Add(infoStr);
+
+			return result;
+		}
 	}
 }

SmartImage/Searching/SearchClient.cs

@@ -30,13 +30,6 @@ namespace SmartImage.Searching
 	/// </summary>
 	public sealed class SearchClient
 	{
-		/*
-		 * todo: use async/tasks
-		 * todo: timeout handling
-		 */
-
-		private const string ORIGINAL_IMAGE_NAME = "(Original image)";
-
 		private static readonly string InterfacePrompt =
 			$"Enter the option number to open or {NConsole.NC_GLOBAL_EXIT_KEY} to exit.\n" +
 			$"Hold down {NC_ALT_FUNC_MODIFIER} to show more info.\n"                       +
@@ -58,17 +51,13 @@ public sealed class SearchClient
 		/// </summary>
 		private string ImageUrl { get; }
 
-		/// <summary>
-		/// Thread that monitors the search (<see cref="RunSearchMonitor"/>)
-		/// </summary>
-		private Thread SearchMonitor { get; }
 
 		/// <summary>
 		/// Search tasks (<seealso cref="CreateSearchTasks"/>)
 		/// </summary>
-		private Task[] SearchTasks { get; }
+		private List<Task<FullSearchResult>> SearchTasks { get; }
+
 
-		
 		/// <summary>
 		/// Whether the search is complete
 		/// </summary>
@@ -115,15 +104,6 @@ private SearchClient(string img)
 
 			SearchTasks = CreateSearchTasks();
 
-			// Joining each thread isn't necessary as this object is disposed upon program exit
-			// Background threads won't prevent program termination
-
-			SearchMonitor = new Thread(RunSearchMonitor)
-			{
-				Priority     = ThreadPriority.Highest,
-				IsBackground = true
-			};
-
 			Complete = false;
 
 			Interface = new NConsoleInterface(Results)
@@ -133,16 +113,34 @@ private SearchClient(string img)
 			};
 		}
 
+
 		/// <summary>
-		/// Monitors the search process
+		///     Starts search and handles results
 		/// </summary>
-		private void RunSearchMonitor()
+		public async void Start()
 		{
-			while (SearchTasks.Any(t => !t.IsCompleted)) {
-				int inProgress = SearchTasks.Count(t => t.IsCompleted);
-				int len        = SearchTasks.Length;
+			int len = SearchTasks.Count;
+
+			while (SearchTasks.Any()) {
+				Task<FullSearchResult> finished = await Task.WhenAny(SearchTasks);
+				SearchTasks.Remove(finished);
+
+				var result = finished.Result;
+
+				Results.Add(result);
+				Results.Sort(FullSearchResult.CompareResults);
+
+				// If the engine is priority, open its result in the browser
+				if (result.IsPriority) {
+					HandleResultOpen(result);
+				}
+
+				int inProgress = len - SearchTasks.Count;
 
 				Interface.Status = $"Searching: {inProgress}/{len}";
+
+				// Reload console UI
+				NConsole.Refresh();
 			}
 
 			/*
@@ -177,76 +175,17 @@ private void RunSearchMonitor()
 			}
 		}
 
-		/// <summary>
-		///     Starts search
-		/// </summary>
-		public void Start()
-		{
-			SearchMonitor.Start();
-
-			foreach (var task in SearchTasks) {
-				task.Start();
-			}
-		}
-
-		/// <summary>
-		/// Creates a <see cref="FullSearchResult"/> for the original image
-		/// </summary>
-		private FullSearchResult GetOriginalImageResult()
-		{
-			var result = new FullSearchResult(Color.White, ORIGINAL_IMAGE_NAME, ImageUrl)
-			{
-				Similarity = 100.0f,
-			};
-
-			var fileFormat = FileSystem.ResolveFileType(ImageFile.FullName);
-
-			double fileSizeMegabytes =
-				MathHelper.ConvertToUnit(FileSystem.GetFileSize(ImageFile.FullName), MetricUnit.Mega);
-
-			(int width, int height) = Images.GetDimensions(ImageFile.FullName);
 
-			result.Width  = width;
-			result.Height = height;
-
-			double mpx = MathHelper.ConvertToUnit(width * height, MetricUnit.Mega);
-
-			string infoStr = $"Info: {ImageFile.Name} ({fileSizeMegabytes:F} MB) ({mpx:F} MP) ({fileFormat.Name})";
-
-			result.ExtendedInfo.Add(infoStr);
-
-			return result;
-		}
-
-		private Task[] CreateSearchTasks()
+		private List<Task<FullSearchResult>> CreateSearchTasks()
 		{
-			// todo: improve, hacky :(
-
 			var availableEngines = GetAllEngines()
 				.Where(e => Engines.HasFlag(e.Engine))
 				.ToArray();
 
-			
-			Results.Add(GetOriginalImageResult());
+			// Add original image to results
+			Results.Add(FullSearchResult.GetOriginalImageResult(ImageUrl, ImageFile));
 
-
-			return availableEngines.Select(currentEngine => new Task(() =>
-			{
-				var result = currentEngine.GetResult(ImageUrl);
-
-				Results.Add(result);
-
-				// If the engine is priority, open its result in the browser
-				if (SearchConfig.Config.PriorityEngines.HasFlag(currentEngine.Engine)) {
-					HandleResultOpen(result);
-				}
-
-				// Sort results
-				Results.Sort(FullSearchResult.CompareResults);
-
-				// Reload console UI
-				NConsole.Refresh();
-			})).ToArray();
+			return availableEngines.Select(currentEngine => Task.Run(() => currentEngine.GetResult(ImageUrl))).ToList();
 		}
 
 		/// <summary>
@@ -276,8 +215,6 @@ private static void HandleResultOpen(FullSearchResult result)
 			else {
 				Debug.WriteLine($"Filtering result {result.Name}");
 			}
-
-
 		}
 
 

SmartImage/Utilities/NativeImports.cs

@@ -17,12 +17,10 @@ internal static class NativeImports
 		private static extern bool FlashWindowEx(ref FLASHWINFO pwfi);
 
 
-		[DllImport(USER32_DLL, EntryPoint = "FindWindow", SetLastError = true, CharSet = CharSet.Unicode)]
-		private static extern IntPtr FindWindowByCaption(IntPtr zeroOnly, string lpWindowName);
+		
 
 
-		[DllImport(KERNEL32_DLL, ExactSpelling = true)]
-		private static extern IntPtr GetConsoleWindow();
+		
 
 		[DllImport(USER32_DLL)]
 		[return: MarshalAs(UnmanagedType.Bool)]
@@ -86,10 +84,7 @@ internal static void FlashWindow(IntPtr hWnd)
 		}
 
 
-		/// <summary>
-		/// Gets console application's window handle. <see cref="Process.MainWindowHandle"/> does not work in some cases.
-		/// </summary>
-		internal static IntPtr GetConsoleWindowHandle() => FindWindowByCaption(IntPtr.Zero, Console.Title);
+		
 
 		internal static void FlashConsoleWindow() => FlashWindow(GetConsoleWindowHandle());