Update readme; update examples; change auto result algorithm

Author: Decimation

Examples/Rdx help.png

@@ -46,6 +46,8 @@
   <p align="center"><b>SmartImage</b> features context menu integration, which allows you to right click on an image to immediately run a search!</p>
   </p>
 
+  <p align="center"><b>SmartImage</b> has two forms: GUI (Windows) and Rdx (cross-platform).</p>
+
 </p>
 
 <!-- ... -->
@@ -71,11 +73,11 @@ Supported search engines:
 
 <!-- ... -->
 
-## Getting Started 1️⃣
+## Getting Started (GUI) 1️⃣
 
 **SmartImage** is designed to be intuitive and agile. There are multiple ways of running the program, and you can use 2 different forms of input: direct image links or files.
 
-See [Usage »](https://github.com/Decimation/SmartImage/wiki#usage)
+See [Usage »](https://github.com/Decimation/SmartImage/wiki/(GUI)-Usage)
 
 ### 1. Input Field
 
@@ -111,9 +113,4 @@ applications.
 
 ## Wiki 📕
 
-**See the _[Wiki »](https://github.com/Decimation/SmartImage/wiki)_ for documentation.**
-
-Wiki pages useful for getting started:
-
-- Usage: _[Usage »](https://github.com/Decimation/SmartImage/wiki/Usage)_
-- Search engines and config: _[Engines »](https://github.com/Decimation/SmartImage/wiki/Engines)_
+**See the _[Wiki »](https://github.com/Decimation/SmartImage/wiki)_ for documentation.**

README.md

@@ -86,10 +86,14 @@ public static void Init()
 
 	public delegate void SearchCompleteCallback(object sender, SearchResult[] e);
 
+	public delegate void ResultOpenCallback(object sender, SearchResultItem e);
+
 	public event ResultCompleteCallback OnResult;
 
 	public event SearchCompleteCallback OnComplete;
 
+	public event ResultOpenCallback OnOpen;
+
 	public Channel<SearchResult> ResultChannel { get; private set; }
 
 	public void OpenChannel()
@@ -145,14 +149,15 @@ public async Task<SearchResult[]> RunSearchAsync(SearchQuery query, bool reload
 
 				Debugger.Break();
 				Logger.LogWarning("Cancellation requested");
-				ResultChannel.Writer.Complete();
+				ResultChannel?.Writer.Complete();
 				IsComplete = true;
 				IsRunning  = false;
 				return results;
 			}
 
 			Task<SearchResult> task = await Task.WhenAny(tasks);
 			tasks.Remove(task);
+
 			// Debug.WriteLine($"{task.Id} {task.Status}");
 			SearchResult result = await task;
 
@@ -164,7 +169,7 @@ public async Task<SearchResult[]> RunSearchAsync(SearchQuery query, bool reload
 			// results.Add(result);
 		}
 
-		ResultChannel.Writer.Complete();
+		ResultChannel?.Writer.Complete();
 		OnComplete?.Invoke(this, results);
 		IsRunning  = false;
 		IsComplete = true;
@@ -174,7 +179,31 @@ public async Task<SearchResult[]> RunSearchAsync(SearchQuery query, bool reload
 			// var sri    = results.SelectMany(r => r.Results).ToArray();
 			// var result = Optimize(sri).FirstOrDefault() ?? sri.FirstOrDefault();
 			//todo
+
 			try {
+				
+				var ordered = results.Select(x => x.GetBestResult())
+					.Where(x => x != null)
+					.OrderByDescending(x => x.Similarity);
+
+				var item = ordered.First();
+
+				if (Config.OpenRaw) {
+					OpenResult(item.Root.AsRawResultItem());
+				}
+
+				OpenResult(item);
+			}
+			catch (Exception e) {
+				Debug.WriteLine($"{e.Message}");
+
+				SearchResult result = results.FirstOrDefault(f => f.Status.IsSuccessful()) ?? results.First();
+				var          item   = result.GetBestResult();
+
+				OpenResult(item);
+			}
+
+			/*try {
 				IOrderedEnumerable<SearchResultItem> rr = results.SelectMany(rr => rr.Results)
 					.OrderByDescending(rr => rr.Score);
 
@@ -191,7 +220,7 @@ public async Task<SearchResult[]> RunSearchAsync(SearchQuery query, bool reload
 
 				SearchResult result = results.FirstOrDefault(f => f.Status.IsSuccessful()) ?? results.First();
 				OpenResult(result);
-			}
+			}*/
 		}
 
 		IsRunning = false;
@@ -202,24 +231,29 @@ public async Task<SearchResult[]> RunSearchAsync(SearchQuery query, bool reload
 	private void ProcessResult(SearchResult result)
 	{
 		OnResult?.Invoke(this, result);
-		ResultChannel.Writer.TryWrite(result);
+
+		if (!ResultChannel.Writer.TryWrite(result)) {
+			Debug.WriteLine($"Could not write {result}");
+		}
 
 		if (Config.PriorityEngines.HasFlag(result.Engine.EngineOption)) {
-			OpenResult(result);
+			OpenResult(result.GetBestResult());
 		}
 	}
 
 	private static void OpenResult(Url url1)
 	{
-#if DEBUG && !TEST
+// #if DEBUG && !TEST
+/*
 #pragma warning disable CA1822
 
 		// ReSharper disable once MemberCanBeMadeStatic.Local        
 		Logger.LogDebug("Not opening {url}", url1);
 		return;
 
 #pragma warning restore CA1822
-#else
+*/
+// #else
 		Logger.LogInformation("Opening {Url}", url1);
 
 		var b = FileSystem.Open(url1, out var proc);
@@ -237,38 +271,32 @@ private static void OpenResult(Url url1)
 
 		// Process.Start(url1);
 		// HttpUtilities.TryOpenUrl(url1);
-#endif
+// #endif
 
 	}
 
-	private void OpenResult(SearchResult result)
+	private void OpenResult(SearchResultItem result)
 	{
-#if DEBUG && !TEST
-#pragma warning disable CA1822
+// #if DEBUG && !TEST
+/*#pragma warning disable CA1822
 
 		// ReSharper disable once MemberCanBeMadeStatic.Local        
 		Logger.LogDebug("Not opening result {result}", result);
 		return;
 
-#pragma warning restore CA1822
-#else
-		Url url1;
-
-		if (Config.OpenRaw) {
-			url1 = result.RawUrl;
-		}
-		else {
-			url1 = result.GetBestResult()?.Url ?? result.RawUrl;
-		}
+#pragma warning restore CA1822*/
+// #else
+		
+		OnOpen?.Invoke(this, result);
 
-		OpenResult(url1);
-#endif
+		OpenResult(result.Url);
+// #endif
 
 	}
 
 	public List<Task<SearchResult>> GetSearchTasks(SearchQuery query, TaskScheduler scheduler, CancellationToken token)
 	{
-		
+
 		List<Task<SearchResult>> tasks = Engines.Select(e =>
 		{
 			try {
@@ -290,6 +318,7 @@ public List<Task<SearchResult>> GetSearchTasks(SearchQuery query, TaskScheduler
 			catch (Exception exception) {
 				Debugger.Break();
 				Trace.WriteLine($"{exception}");
+
 				// return  Task.FromException(exception);
 			}
 

SmartImage.Lib 3/SearchClient.cs

@@ -8,22 +8,22 @@ namespace SmartImage.Lib.Utilities;
 
 internal class HttpLoggingHandler : DelegatingHandler
 {
+
 	public HttpLoggingHandler(ILogger l)
 	{
 		m_logger = l;
 	}
 
-	public HttpLoggingHandler([NotNull] HttpMessageHandler innerHandler) : base(innerHandler)
-	{
-	}
+	public HttpLoggingHandler([NotNull] HttpMessageHandler innerHandler) : base(innerHandler) { }
 
 	private readonly ILogger m_logger;
 
 	protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request,
-														   CancellationToken cancellationToken)
+	                                                       CancellationToken cancellationToken)
 	{
 		m_logger.LogDebug("Request {Request}", request.RequestUri);
 
 		return base.SendAsync(request, cancellationToken);
 	}
-}
+
+}

SmartImage.Lib 3/Utilities/HttpLoggingHandler.cs

@@ -40,7 +40,6 @@ public static async Task<int> Main(string[] args)
 		Debug.WriteLine(Console.BufferHeight);
 
 #if DEBUG
-
 		Debugger.Launch();
 #endif
 

SmartImage.Rdx/Program.cs

@@ -73,11 +73,17 @@ public SearchCommand()
 		// Client.OnComplete += OnComplete;
 
 		// Client.OnResult   += OnResult;
-		m_cts     = new CancellationTokenSource();
-		m_results = new ConcurrentBag<SearchResult>();
-		m_scs     = null;
-		m_table   = CreateResultTable();
-		Query     = SearchQuery.Null;
+		m_cts         =  new CancellationTokenSource();
+		m_results     =  new ConcurrentBag<SearchResult>();
+		m_scs         =  null;
+		m_table       =  CreateResultTable();
+		
+		Client.OnOpen += (sender, item) =>
+		{
+			Debug.WriteLine($"Opening {item}");
+		};
+
+		Query         =  SearchQuery.Null;
 	}
 
 	#region
@@ -89,6 +95,10 @@ private async Task SetupSearchAsync(ProgressContext ctx)
 
 		Query = await SearchQuery.TryCreateAsync(m_scs.Query);
 
+		if (Query == SearchQuery.Null) {
+			throw new SmartImageException($"Could not create query"); //todo
+
+		}
 		p.Increment(COMPLETE / 2);
 
 		// ctx.Refresh();
@@ -97,7 +107,7 @@ private async Task SetupSearchAsync(ProgressContext ctx)
 		var url = await Query.UploadAsync();
 
 		if (url == null) {
-			throw new SmartImageException(); //todo
+			throw new SmartImageException("Could not upload query"); //todo
 		}
 
 		p.Increment(COMPLETE / 2);
@@ -158,7 +168,7 @@ private async Task RunSearchWithProgressAsync(ProgressContext c)
 
 			m_results.Add(result);
 
-			pt.Description = $"{result.Engine.Name} {m_results.Count} / {cnt}";
+			pt.Description = $"{Strings.Constants.CHECK_MARK} {result.Engine.Name} - {result.Results.Count} ({m_results.Count} / {cnt})";
 			pt.Increment(1);
 			c.Refresh();
 
@@ -176,7 +186,13 @@ public override async Task<int> ExecuteAsync(CommandContext context, SearchComma
 			.StartAsync(SetupSearchAsync)
 			.ContinueWith(InitConfigAsync);
 
-		await task;
+		try {
+			await task;
+		}
+		catch (Exception e) {
+			AConsole.WriteException(e);
+			return EC_ERROR;
+		}
 
 		var gr = CreateInfoGrid();
 		AConsole.Write(gr);
@@ -302,14 +318,6 @@ private async Task RunCompletionCommandAsync([CBN] object o)
 		var stdOutBuffer = new StringBuilder();
 		var stdErrBuffer = new StringBuilder();
 
-		/*var buf1         = new StringBuilder();
-
-			foreach (ResultModel model in m_results) {
-				foreach (SearchResultItem item in model.Result.Results) {
-					buf1.AppendLine(item.Url);
-				}
-			}*/
-
 		if (!String.IsNullOrWhiteSpace(cmdArgs)) {
 
 			// cmdArgs = cmdArgs.Replace(SearchCommandSettings.PROP_ARG_RESULTS, buf1.ToString());
@@ -323,11 +331,11 @@ private async Task RunCompletionCommandAsync([CBN] object o)
 
 		var commandTask = command.ExecuteAsync(m_cts.Token);
 
-		AConsole.WriteLine($"Process: {commandTask.ProcessId}");
+		AConsole.WriteLine($"Process id: {commandTask.ProcessId}");
 
 		var result = await commandTask;
 
-		AConsole.WriteLine($"Process: {result.IsSuccess}");
+		AConsole.WriteLine($"Process successful: {result.IsSuccess}");
 	}
 
 	[ContractAnnotation("=> halt")]

SmartImage.Rdx/SearchCommand.cs

@@ -16,7 +16,7 @@
   </PropertyGroup>
   <PropertyGroup>
     <SatelliteResourceLanguages>en-US;en</SatelliteResourceLanguages>
-    <Version>1.0.4</Version>
+    <Version>1.0.5</Version>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
     <DefineConstants>DEBUG;TRACE;JETBRAINS_ANNOTATIONS</DefineConstants>