Polymorphism refactor

Author: Decimation

SmartImage.Lib/Engines/Impl/Ascii2DEngine.cs

@@ -21,6 +21,7 @@ namespace SmartImage.Lib.Engines.Impl
 {
 	public sealed class Ascii2DEngine : WebSearchEngine
 	{
+		
 		public Ascii2DEngine() : base("https://ascii2d.net/search/url/")
 		{
 			FollowRedirects = true;
@@ -33,22 +34,6 @@ public Ascii2DEngine() : base("https://ascii2d.net/search/url/")
 
 		public override string Name => EngineOption.ToString();
 
-
-		/*protected override bool GetRawResultUri(ImageQuery query, out Uri uri, out IRestResponse res)
-		{
-			uri = new Uri(BaseUrl + query.UploadUri);
-
-			res = Network.GetResponse(uri.ToString(), (int) Timeout.TotalMilliseconds, Method.GET, false);
-
-			if (!res.IsSuccessful && res.StatusCode != HttpStatusCode.Redirect) {
-				Debug.WriteLine($"{Name} is unavailable or timed out after {Timeout:g} | {uri} {res.StatusCode}",
-				                LogCategories.C_WARN);
-				return false;
-			}
-
-			return true;
-		}*/
-
 		private Uri ConvertToDetailUri(Uri url)
 		{
 			/*
@@ -59,6 +44,11 @@ private Uri ConvertToDetailUri(Uri url)
 			 *
 			 */
 
+			/*
+			 * With Ascii2D, two requests need to be made in order to get the detail results
+			 * as the color results are returned by default
+			 *
+			 */
 
 			var res = Network.GetResponse(url.ToString(), (int) Timeout.TotalMilliseconds, Method.GET, false);
 
@@ -70,7 +60,6 @@ private Uri ConvertToDetailUri(Uri url)
 
 			string detailUrl = newUrl.Replace("/color/", "/bovw/");
 
-
 			return new Uri(detailUrl);
 		}
 
@@ -81,7 +70,7 @@ protected override Uri GetRaw(ImageQuery query)
 
 		}
 
-		protected override IDocument GetContent(IRestResponse response)
+		protected internal override IDocument GetContent(IRestResponse response)
 		{
 			var url = response.ResponseUri;
 
@@ -96,41 +85,19 @@ protected override IDocument GetContent(IRestResponse response)
 		protected override bool GetInitialResult(ImageQuery query, out Uri rawUri, out IRestResponse res)
 		{
 			rawUri = GetRaw(query);
-
-			/*if (!Network.IsAlive(uri, (int) Timeout.TotalMilliseconds)) {
-				Debug.WriteLine($"{Name} is unavailable or timed out after {Timeout:g} | {uri}", C_WARN);
-				return null;
-			}*/
-
-
+			
 			// NOTE: wtf?
 
 			res = Network.GetResponse(rawUri.ToString(), (int) Timeout.TotalMilliseconds, Method.GET, FollowRedirects);
-
-			//res         = new RestClient(rawUri).Execute(new RestRequest());
-
+			
 			res.Content = WebUtilities.GetString(rawUri.ToString());
 
-
-			/*if (!res.IsSuccessful)
-			{
-				if ((FollowRedirects && res.StatusCode == HttpStatusCode.Redirect))
-				{
-					return true;
-				}
-
-				Debug.WriteLine($"{Name} is unavailable or timed out after " +
-				                $"{Timeout:g} | {rawUri} {res.StatusCode}", LogCategories.C_WARN);
-				return false;
-			}*/
-
 			return true;
-
 		}
 
-		protected override SearchResult Process(object content, SearchResult sr)
+		protected override SearchResult Process(object obj, SearchResult sr)
 		{
-			var doc   = (IDocument) content;
+			var doc   = (IDocument) obj;
 			var nodes = doc.Body.SelectNodes("//*[contains(@class, 'info-box')]");
 
 			var rg = new List<ImageResult>();

SmartImage.Lib/Engines/Impl/IqdbEngine.cs

@@ -148,11 +148,14 @@ private IDocument GetDocument(ImageQuery query)
 		}
 
 
-		protected override SearchResult Process(ImageQuery query, SearchResult sr)
+		protected override SearchResult Process(object obj, SearchResult sr)
 		{
 			// Don't select other results
-
-			var doc = GetDocument(query);
+			var query = (ImageQuery) obj;
+			var now   = Stopwatch.GetTimestamp();
+			var doc   = GetDocument(query);
+			var diff  = TimeSpan.FromTicks(Stopwatch.GetTimestamp() - now);
+			sr.RetrievalTime = diff;
 
 			var pages  = doc.Body.SelectSingleNode("//div[@id='pages']");
 			var tables = ((IHtmlElement) pages).SelectNodes("div/table");

SmartImage.Lib/Engines/Impl/SauceNaoEngine.cs

@@ -66,21 +66,22 @@ public SauceNaoEngine() : this(null) { }
 
 		private delegate IEnumerable<SauceNaoDataResult> ParseResultFunction(ImageQuery q);
 
-		private ParseResultFunction Get() => !UsingAPI ? GetHTMLResults : GetAPIResults;
+		private ParseResultFunction GetParseFunction() => !UsingAPI ? GetHTMLResults : GetAPIResults;
 
 		public override SearchResult GetResult(ImageQuery query)
 		{
-			var sresult       = base.GetResult(query);
+			var result       = base.GetResult(query);
 			var primaryResult = new ImageResult();
 
-			var f = Get();
+			var f = GetParseFunction();
 
+			var now           = Stopwatch.GetTimestamp();
 			var dataResults = f(query);
-
+			result.RetrievalTime = TimeSpan.FromTicks(Stopwatch.GetTimestamp() - now);
 
 			if (dataResults == null) {
-				sresult.ErrorMessage = "Daily search limit (100) exceeded";
-				sresult.Status       = ResultStatus.Cooldown;
+				result.ErrorMessage = "Daily search limit (100) exceeded";
+				result.Status       = ResultStatus.Cooldown;
 				//return sresult;
 				goto ret;
 			}
@@ -102,18 +103,18 @@ public override SearchResult GetResult(ImageQuery query)
 
 			primaryResult.UpdateFrom(imageResults.First());
 
-			sresult.OtherResults.AddRange(imageResults);
+			result.OtherResults.AddRange(imageResults);
 
 
 			if (UsingAPI) {
 				Debug.WriteLine($"{Name} API key: {Authentication}");
 			}
 
-			sresult.PrimaryResult = primaryResult;
-			sresult.Consolidate();
+			result.PrimaryResult = primaryResult;
+			result.Consolidate();
 
 			ret:
-			return sresult;
+			return result;
 		}
 
 		private IEnumerable<SauceNaoDataResult> GetHTMLResults(ImageQuery query)

SmartImage.Lib/Engines/Impl/TidderEngine.cs

@@ -24,9 +24,9 @@ public TidderEngine() : base("http://tidder.xyz/?imagelink=") { }
 		public override string Name => EngineOption.ToString();
 
 
-		protected override SearchResult Process(object content, SearchResult sr)
+		protected override SearchResult Process(object obj, SearchResult sr)
 		{
-			var doc = (IDocument) content;
+			var doc = (IDocument) obj;
 
 			var documentNode = doc.Body;
 

SmartImage.Lib/Engines/Impl/TraceMoeEngine.cs

@@ -35,11 +35,11 @@ public TraceMoeEngine() : base("https://trace.moe/?url=", "https://api.trace.moe
 
 		public override SearchEngineOptions EngineOption => SearchEngineOptions.TraceMoe;
 
-		protected override SearchResult Process(ImageQuery query, SearchResult r)
+		protected override SearchResult Process(object obj, SearchResult r)
 		{
 
 			//var r = base.GetResult(url);
-
+			var query = (ImageQuery) obj;
 			// https://soruly.github.io/trace.moe/#/
 
 			var rq = new RestRequest("search");
@@ -49,8 +49,11 @@ protected override SearchResult Process(ImageQuery query, SearchResult r)
 			rq.Timeout                 = Timeout.Milliseconds;
 			rq.RequestFormat           = DataFormat.Json;
 
+			var now  = Stopwatch.GetTimestamp();
 			var re = Client.Execute<TraceMoeRootObject>(rq, Method.GET);
 			var tm = re.Data;
+			var diff  = TimeSpan.FromTicks(Stopwatch.GetTimestamp() - now);
+			r.RetrievalTime = diff;
 
 			//var tm=JsonConvert.DeserializeObject<TraceMoeRootObject>(re.Content);
 

SmartImage.Lib/Engines/Impl/YandexEngine.cs

@@ -172,9 +172,9 @@ static ImageResult Parse(INode siz)
 
 
 
-		protected override SearchResult Process(object content, SearchResult sr)
+		protected override SearchResult Process(object obj, SearchResult sr)
 		{
-			var doc = (IDocument) content;
+			var doc = (IDocument) obj;
 
 			// Automation detected
 			const string AUTOMATION_ERROR_MSG = "Please confirm that you and not a robot are sending requests";

SmartImage.Lib/Engines/Model/ClientSearchEngine.cs

@@ -8,7 +8,7 @@ namespace SmartImage.Lib.Engines.Model
 	/// <summary>
 	/// Represents a search engine whose results are returned from an API.
 	/// </summary>
-	public abstract class ClientSearchEngine : BaseSearchEngine
+	public abstract class ClientSearchEngine : ProcessedSearchEngine
 	{
 		protected ClientSearchEngine(string baseUrl, string endpointUrl) : base(baseUrl)
 		{
@@ -23,21 +23,6 @@ protected ClientSearchEngine(string baseUrl, string endpointUrl) : base(baseUrl)
 		protected string EndpointUrl { get; }
 
 		protected RestClient Client { get; }
-
-
-		// todo: refactor this to inherit from ProcessedSearchEngine
-
-		[DebuggerHidden]
-		public override SearchResult GetResult(ImageQuery query)
-		{
-			return TryProcess(base.GetResult(query), sr =>
-			{
-				var process = Process(query, sr);
-
-				return process;
-			});
-		}
-
-		protected abstract SearchResult Process(ImageQuery query, SearchResult r);
+		
 	}
 }

SmartImage.Lib/Engines/Model/ProcessedSearchEngine.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Diagnostics;
+using AngleSharp.Dom;
 using RestSharp;
 using SmartImage.Lib.Searching;
 
@@ -13,16 +14,58 @@ protected ProcessedSearchEngine(string baseUrl) : base(baseUrl) { }
 
 		public abstract override string Name { get; }
 
-		protected abstract SearchResult Process(object content, SearchResult sr);
+		/// <summary>
+		/// Processes engine results
+		/// </summary>
+		/// <param name="obj">Content upon which to operate</param>
+		/// <param name="sr"><see cref="SearchResult"/> to build</param>
+		/// <returns>Final <see cref="SearchResult"/></returns>
+		protected abstract SearchResult Process(object obj, SearchResult sr);
 
 
 		[DebuggerHidden]
 		public override SearchResult GetResult(ImageQuery query)
 		{
-			return TryProcess(GetResult(query, out var response), sr =>
+			// HACK: this is questionable, but it resolves the edge case with polymorphism
+
+			SearchResult result;
+
+			ClientSearchEngine c;
+			WebSearchEngine    w;
+
+			IRestResponse response = null;
+
+			switch (this) {
+				case ClientSearchEngine:
+					result = base.GetResult(query);
+					c      = this as ClientSearchEngine;
+					w      = null;
+					break;
+				case WebSearchEngine:
+					result = GetResult(query, out response);
+					w      = this as WebSearchEngine;
+					c      = null;
+					break;
+				default:
+					throw new InvalidOperationException();
+			}
+
+			return TryProcess(result, sr =>
 			{
-				sr = Process(response, sr);
+				object o;
+
+				if (c != null) {
+					o = query;
+				}
+				else if (w != null) {
+					o = w.GetContent(response);
+				}
+				else {
+					throw new InvalidOperationException();
+				}
+
 
+				sr = Process(o, sr);
 				return sr;
 			});
 		}

SmartImage.Lib/Engines/Model/WebSearchEngine.cs

@@ -18,24 +18,13 @@ protected WebSearchEngine(string baseUrl) : base(baseUrl) { }
 
 		public abstract override string Name { get; }
 
-		protected abstract override SearchResult Process(object content, SearchResult sr);
 
-		protected virtual IDocument GetContent(IRestResponse response)
+		protected internal virtual IDocument GetContent(IRestResponse response)
 		{
 			var parser = new HtmlParser();
 			return parser.ParseDocument(response.Content);
 		}
 
-		[DebuggerHidden]
-		public override SearchResult GetResult(ImageQuery query)
-		{
-			return TryProcess(GetResult(query, out var response), sr =>
-			{
-				var doc = GetContent(response);
-				sr = Process(doc, sr);
-
-				return sr;
-			});
-		}
+		
 	}
 }