Client improvements; misc

Author: Decimation

SmartImage.Lib/Engines/Model/BaseSearchEngine.cs

@@ -57,7 +57,7 @@ public async Task<SearchResult> GetResultAsync(ImageQuery query)
 
 			var task = Task.Run(delegate
 			{
-				Debug.WriteLine($"{Name}: getting result async", C_INFO);
+				Debug.WriteLine($"{Name}: getting result async", C_VERBOSE);
 
 				var res = GetResult(query);
 
@@ -72,7 +72,7 @@ public async Task<SearchResult> GetResultAsync(ImageQuery query)
 		protected virtual Uri GetRaw(ImageQuery query)
 		{
 			//
-			return new Uri(BaseUrl + query.UploadUri);
+			return new(BaseUrl + query.UploadUri);
 
 		}
 

SmartImage.Lib/SearchClient.cs

@@ -156,7 +156,7 @@ public async Task RunSearchAsync()
 				}
 
 				// Call event
-				ResultCompleted?.Invoke(null, new SearchResultEventArgs(value)
+				ResultCompleted?.Invoke(null, new ResultCompletedEventArgs(value)
 				{
 					IsFiltered = isFiltered,
 					IsPriority = isPriority,
@@ -172,35 +172,30 @@ public async Task RunSearchAsync()
 
 			Trace.WriteLine($"{nameof(SearchClient)}: {d.TotalSeconds}");
 
-			SearchCompleted?.Invoke(null, Results);
-
-			if (Config.Notification) {
-
-
-				var args = new ExtraResultEventArgs()
+			var args2 = new SearchCompletedEventArgs()
+			{
+				Results = Results,
+				Best    = new Lazy<ImageResult>(FindBestResult),
+				Direct = new Lazy<ImageResult>(() =>
 				{
-					Results = this.Results,
-					Best    = FindBestResult(),
-				};
-
-				if (Config.NotificationImage) {
+					if (Config.Notification && Config.NotificationImage) {
 
-					Debug.WriteLine($"Finding direct result");
+						Debug.WriteLine($"Finding direct result");
+						var direct = FindDirectResult();
 
-					var direct = FindDirectResult();
-
-					if (direct?.Direct != null) {
-						Debug.WriteLine(direct);
-						Debug.WriteLine(direct.Direct.ToString());
-						args.Direct = direct;
+						if (direct?.Direct != null) {
+							Debug.WriteLine(direct);
+							Debug.WriteLine(direct.Direct.ToString());
+						}
 
+						return direct;
 					}
-				}
-
-				ExtraResults?.Invoke(null, args);
 
-			}
+					return null;
+				})
+			};
 
+			SearchCompleted?.Invoke(null, args2);
 		}
 
 		#endregion
@@ -337,36 +332,33 @@ public static BaseSearchEngine[] GetAllSearchEngines()
 		/// <summary>
 		/// An event that fires whenever a result is returned (<see cref="RunSearchAsync"/>).
 		/// </summary>
-		public event EventHandler<SearchResultEventArgs> ResultCompleted;
+		public event EventHandler<ResultCompletedEventArgs> ResultCompleted;
 
 		/// <summary>
 		/// An event that fires when a search is complete (<see cref="RunSearchAsync"/>).
 		/// </summary>
-		public event EventHandler<List<SearchResult>> SearchCompleted;
-
-		/// <summary>
-		/// An event that fires when a search is complete, with extra information
-		/// (<see cref="SearchConfig.Notification"/>; <see cref="SearchConfig.NotificationImage"/>)
-		/// </summary>
-		public event EventHandler<ExtraResultEventArgs> ExtraResults;
+		public event EventHandler<SearchCompletedEventArgs> SearchCompleted;
 
 
 		private const string ERR_SEARCH_NOT_COMPLETE = "Search must be completed";
 
 		private const string ERR_NO_BEST_RESULT = "Could not find best result";
 	}
 
-	public sealed class ExtraResultEventArgs : EventArgs
+
+	public sealed class SearchCompletedEventArgs : EventArgs
 	{
 		public List<SearchResult> Results { get; init; }
 
 		[CanBeNull]
-		public ImageResult Direct { get; internal set; }
+		public Lazy<ImageResult> Direct { get; internal set; }
+
 
-		public ImageResult Best { get; internal set; }
+		[CanBeNull]
+		public Lazy<ImageResult> Best { get; internal set; }
 	}
 
-	public sealed class SearchResultEventArgs : EventArgs
+	public sealed class ResultCompletedEventArgs : EventArgs
 	{
 		/// <summary>
 		/// Search result
@@ -389,7 +381,7 @@ public sealed class SearchResultEventArgs : EventArgs
 		public bool IsPriority { get; init; }
 
 
-		public SearchResultEventArgs(SearchResult result)
+		public ResultCompletedEventArgs(SearchResult result)
 		{
 			Result = result;
 		}

SmartImage.Lib/SearchConfig.cs

@@ -40,12 +40,12 @@ public sealed class SearchConfig
 		public bool Filtering { get; set; } = true;
 
 		/// <summary>
-		/// <see cref="SearchClient.ExtraResults"/>
+		/// <see cref="SearchClient.SearchCompleted"/>
 		/// </summary>
 		public bool Notification { get; set; } = true;
 
 		/// <summary>
-		/// <see cref="SearchClient.ExtraResults"/>
+		/// <see cref="SearchClient.SearchCompleted"/>
 		/// </summary>
 		public bool NotificationImage { get; set; } = false;
 

SmartImage.Lib/Searching/ImageQuery.cs

@@ -43,8 +43,9 @@ public sealed class ImageQuery
 		/// </summary>
 		public BaseUploadEngine UploadEngine { get; }
 
-		public Stream Stream { get; }
+		public Stream   Stream     { get; }
 
+		public TimeSpan UploadTime { get; }
 
 
 		public ImageQuery([NotNull] string value, [CanBeNull] BaseUploadEngine engine = null)
@@ -69,15 +70,14 @@ public ImageQuery([NotNull] string value, [CanBeNull] BaseUploadEngine engine =
 
 
 			UploadEngine = engine ?? new LitterboxEngine(); //note: default upload engine
-			
-			
+
 
 			UploadUri = IsUri ? new Uri(Value) : UploadEngine.Upload(Value);
 
 
-			Stream   = IsFile ? File.OpenRead(value) : WebUtilities.GetStream(value);
+			Stream = IsFile ? File.OpenRead(value) : WebUtilities.GetStream(value);
 
-			m_upload = TimeSpan.FromTicks(Stopwatch.GetTimestamp() - now);
+			UploadTime = TimeSpan.FromTicks(Stopwatch.GetTimestamp() - now);
 
 			Trace.WriteLine($"{nameof(ImageQuery)}: {UploadUri}", C_SUCCESS);
 		}
@@ -87,8 +87,6 @@ public ImageQuery([NotNull] string value, [CanBeNull] BaseUploadEngine engine =
 
 		public static implicit operator ImageQuery(string value) => new(value);
 
-		private TimeSpan  m_upload;
-
 		public static (bool IsUri, bool IsFile) IsUriOrFile(string x)
 		{
 			return (ImageHelper.IsDirect(x, DirectImageType.Binary), File.Exists(x));
@@ -107,14 +105,12 @@ public ImageResult GetImageResult()
 			result.OtherMetadata.Add("Upload engine", UploadEngine.Name);
 			result.OtherMetadata.Add("Input type", IsUri ? "URI" : "File");
 			result.OtherMetadata.Add("Input value", Value);
-			result.OtherMetadata.Add("Time", $"{m_upload.TotalSeconds:F3} uploading");
+			result.OtherMetadata.Add("Time", $"{UploadTime.TotalSeconds:F3} uploading");
 
 
 			result.UpdateImageData();
 
 			return result;
-
-
 		}
 
 

SmartImage.Lib/Searching/ImageResult.cs

@@ -150,14 +150,14 @@ private static List<FieldInfo> GetDetailFields()
 
 		private static readonly List<FieldInfo> DetailFields = GetDetailFields();
 
+		/// <summary>
+		/// Score representing the number of fields that are populated (i.e., non-<c>null</c> or <c>default</c>);
+		/// used as a heuristic for determining image result quality
+		/// </summary>
 		public int DetailScore
 		{
 			get
 			{
-				/*
-				 * The number of non-null fields
-				 */
-
 				int s = DetailFields.Select(f => f.GetValue(this))
 				                    .Count(v => v != null);
 

SmartImage.UI/Form.cs

@@ -73,7 +73,7 @@ private void Init()
 			m_cl.ResultCompleted += HandleResult;
 		}
 
-		private void HandleResult(object o, SearchResultEventArgs args)
+		private void HandleResult(object o, ResultCompletedEventArgs args)
 		{
 			var searchResult = args.Result;
 

SmartImage/Program.cs

@@ -58,10 +58,19 @@ public static class Program
 	{
 		#region Core fields
 
+		/// <summary>
+		/// User search config
+		/// </summary>
 		public static readonly SearchConfig Config = new();
 
+		/// <summary>
+		/// Search client
+		/// </summary>
 		public static readonly SearchClient Client = new(Config);
 
+		/// <summary>
+		/// Console UI for search results
+		/// </summary>
 		public static readonly NConsoleDialog ResultDialog = new()
 		{
 			Options     = new List<NConsoleOption>(),
@@ -83,6 +92,7 @@ private static async Task Main(string[] args)
 
 			ToastNotificationManagerCompat.OnActivated += AppInterface.OnToastActivated;
 
+			//...
 			Native.SetConsoleOutputCP(Native.CP_IBM437);
 
 			Console.Title = $"{AppInfo.NAME}";
@@ -126,12 +136,17 @@ private static async Task Main(string[] args)
 
 				CancellationTokenSource cts = new();
 
-
 				// Run search
 
 				Client.ResultCompleted += OnResultCompleted;
-				Client.SearchCompleted += (obj, eventArgs) => OnSearchCompleted(obj, eventArgs, cts);
-				Client.ExtraResults    += AppInterface.ShowToast;
+				Client.SearchCompleted += (obj, eventArgs) =>
+				{
+					OnSearchCompleted(obj, eventArgs, cts);
+
+					if (Config.Notification) {
+						AppInterface.ShowToast(obj, eventArgs);
+					}
+				};
 
 				NConsoleProgress.Queue(cts);
 
@@ -232,7 +247,6 @@ private static bool HandleArguments()
 						}
 					};
 
-
 					handler.Run(args);
 
 					Client.Reload();
@@ -249,7 +263,7 @@ private static bool HandleArguments()
 
 		#region Event handlers
 
-		private static void OnSearchCompleted(object? sender, List<SearchResult> eventArgs, CancellationTokenSource cts)
+		private static void OnSearchCompleted(object? sender, SearchCompletedEventArgs eventArgs, CancellationTokenSource cts)
 		{
 			Native.FlashConsoleWindow();
 
@@ -260,7 +274,7 @@ private static void OnSearchCompleted(object? sender, List<SearchResult> eventAr
 
 		}
 
-		private static void OnResultCompleted(object? sender, SearchResultEventArgs eventArgs)
+		private static void OnResultCompleted(object? sender, ResultCompletedEventArgs eventArgs)
 		{
 			var result = eventArgs.Result;
 

SmartImage/UI/AppInterface.cs

@@ -182,7 +182,7 @@ internal static bool ApplicationIsActivated()
 		private const string ARG_KEY_ACTION    = "action";
 		private const string ARG_VALUE_DISMISS = "dismiss";
 
-		public static void ShowToast(object sender, ExtraResultEventArgs args)
+		public static void ShowToast(object sender, SearchCompletedEventArgs args)
 		{
 			var bestResult = args.Best;
 
@@ -199,7 +199,7 @@ public static void ShowToast(object sender, ExtraResultEventArgs args)
 
 
 			button.SetContent("Open")
-			      .AddArgument(ARG_KEY_ACTION, $"{bestResult.Url}");
+			      .AddArgument(ARG_KEY_ACTION, $"{bestResult.Value.Url}");
 
 
 			builder.AddButton(button)
@@ -209,7 +209,7 @@ public static void ShowToast(object sender, ExtraResultEventArgs args)
 			       .AddText($"Results: {Program.Client.Results.Count}");
 
 
-			var direct = args.Direct?.Direct;
+			var direct = args.Direct?.Value.Direct;
 
 			if (direct != null) {
 				var path = Path.GetTempPath();

Test/Program.cs

@@ -32,7 +32,7 @@ namespace Test
 
 	public static class Program
 	{
-		public static void OnResult(object _, SearchResultEventArgs e)
+		public static void OnResult(object _, ResultCompletedEventArgs e)
 		{
 
 			if (e.Result.IsSuccessful) {