Cleanup Search UI, Newznab Caps API

2026-04-19 22:04:56 -04:00 · 2020-10-20 13:46:58 -04:00
parent f290afa68c
commit 84cbfe870f
105 changed files with 562 additions and 791 deletions
@@ -0,0 +1,164 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using FluentValidation.Results;
+using NLog;
+using NzbDrone.Common.Extensions;
+using NzbDrone.Common.Http;
+using NzbDrone.Core.Configuration;
+using NzbDrone.Core.ThingiProvider;
+using NzbDrone.Core.Validation;
+
+namespace NzbDrone.Core.Indexers.Newznab
+{
+    public class Newznab : HttpIndexerBase<NewznabSettings>
+    {
+        private readonly INewznabCapabilitiesProvider _capabilitiesProvider;
+
+        public override string Name => "Newznab";
+
+        public override DownloadProtocol Protocol => DownloadProtocol.Usenet;
+        public override IndexerPrivacy Privacy => IndexerPrivacy.Private;
+
+        public override int PageSize => _capabilitiesProvider.GetCapabilities(Settings).DefaultPageSize;
+
+        public override IIndexerRequestGenerator GetRequestGenerator()
+        {
+            return new NewznabRequestGenerator(_capabilitiesProvider)
+            {
+                PageSize = PageSize,
+                Settings = Settings
+            };
+        }
+
+        public override IParseIndexerResponse GetParser()
+        {
+            return new NewznabRssParser(Settings);
+        }
+
+        public override IEnumerable<ProviderDefinition> DefaultDefinitions
+        {
+            get
+            {
+                yield return GetDefinition("DOGnzb", GetSettings("https://api.dognzb.cr"));
+                yield return GetDefinition("DrunkenSlug", GetSettings("https://api.drunkenslug.com"));
+                yield return GetDefinition("Nzb-Tortuga", GetSettings("https://www.nzb-tortuga.com"));
+                yield return GetDefinition("Nzb.su", GetSettings("https://api.nzb.su"));
+                yield return GetDefinition("NZBCat", GetSettings("https://nzb.cat"));
+                yield return GetDefinition("NZBFinder.ws", GetSettings("https://nzbfinder.ws", categories: new[] { 2030, 2040, 2045, 2050, 2060, 2070, 2080, 2090 }));
+                yield return GetDefinition("NZBgeek", GetSettings("https://api.nzbgeek.info"));
+                yield return GetDefinition("nzbplanet.net", GetSettings("https://api.nzbplanet.net"));
+                yield return GetDefinition("omgwtfnzbs", GetSettings("https://api.omgwtfnzbs.me", categories: new[] { 2000, 2020, 2030, 2040, 2045, 2050, 2070 }));
+                yield return GetDefinition("OZnzb.com", GetSettings("https://api.oznzb.com"));
+                yield return GetDefinition("SimplyNZBs", GetSettings("https://simplynzbs.com"));
+                yield return GetDefinition("Tabula Rasa", GetSettings("https://www.tabula-rasa.pw", apiPath: @"/api/v1/api"));
+                yield return GetDefinition("Usenet Crawler", GetSettings("https://www.usenet-crawler.com"));
+            }
+        }
+
+        public Newznab(INewznabCapabilitiesProvider capabilitiesProvider, IHttpClient httpClient, IIndexerStatusService indexerStatusService, IConfigService configService, Logger logger)
+            : base(httpClient, indexerStatusService, configService, logger)
+        {
+            _capabilitiesProvider = capabilitiesProvider;
+        }
+
+        private IndexerDefinition GetDefinition(string name, NewznabSettings settings)
+        {
+            return new IndexerDefinition
+            {
+                EnableRss = false,
+                EnableAutomaticSearch = false,
+                EnableInteractiveSearch = false,
+                Name = name,
+                Implementation = GetType().Name,
+                Settings = settings,
+                Protocol = DownloadProtocol.Usenet,
+                Privacy = IndexerPrivacy.Private,
+                SupportsRss = SupportsRss,
+                SupportsSearch = SupportsSearch
+            };
+        }
+
+        private NewznabSettings GetSettings(string url, string apiPath = null, int[] categories = null)
+        {
+            var settings = new NewznabSettings { BaseUrl = url };
+
+            if (categories != null)
+            {
+                settings.Categories = categories;
+            }
+
+            if (apiPath.IsNotNullOrWhiteSpace())
+            {
+                settings.ApiPath = apiPath;
+            }
+
+            return settings;
+        }
+
+        protected override void Test(List<ValidationFailure> failures)
+        {
+            base.Test(failures);
+            if (failures.HasErrors())
+            {
+                return;
+            }
+
+            failures.AddIfNotNull(TestCapabilities());
+        }
+
+        protected static List<int> CategoryIds(List<NewznabCategory> categories)
+        {
+            var l = categories.Select(c => c.Id).ToList();
+
+            foreach (var category in categories)
+            {
+                if (category.Subcategories != null)
+                {
+                    l.AddRange(CategoryIds(category.Subcategories));
+                }
+            }
+
+            return l;
+        }
+
+        protected virtual ValidationFailure TestCapabilities()
+        {
+            try
+            {
+                var capabilities = _capabilitiesProvider.GetCapabilities(Settings);
+
+                var notSupported = Settings.Categories.Except(CategoryIds(capabilities.Categories));
+
+                if (notSupported.Any())
+                {
+                    _logger.Warn($"{Definition.Name} does not support the following categories: {string.Join(", ", notSupported)}. You should probably remove them.");
+                    if (notSupported.Count() == Settings.Categories.Count())
+                    {
+                        return new ValidationFailure(string.Empty, $"This indexer does not support any of the selected categories! (You may need to turn on advanced settings to see them)");
+                    }
+                }
+
+                if (capabilities.SupportedSearchParameters != null && capabilities.SupportedSearchParameters.Contains("q"))
+                {
+                    return null;
+                }
+
+                if (capabilities.SupportedMovieSearchParameters != null &&
+                    new[] { "q", "imdbid" }.Any(v => capabilities.SupportedMovieSearchParameters.Contains(v)) &&
+                    new[] { "imdbtitle", "imdbyear" }.All(v => capabilities.SupportedMovieSearchParameters.Contains(v)))
+                {
+                    return null;
+                }
+
+                return new ValidationFailure(string.Empty, "This indexer does not support searching for movies :(. Tell your indexer staff to enable this or force add the indexer by disabling search, adding the indexer and then enabling it again.");
+            }
+            catch (Exception ex)
+            {
+                _logger.Warn(ex, "Unable to connect to indexer: " + ex.Message);
+
+                return new ValidationFailure(string.Empty, "Unable to connect to indexer, check the log for more details");
+            }
+        }
+    }
+}