New: (Indexers) (Redacted) Add API support

src/NzbDrone.Core/Datastore/Migration/008_redacted_api.cs

@@ -0,0 +1,63 @@
+using System.Data;
+using FluentMigrator;
+using Newtonsoft.Json.Linq;
+using NzbDrone.Common.Serializer;
+using NzbDrone.Core.Datastore.Migration.Framework;
+
+namespace NzbDrone.Core.Datastore.Migration
+{
+    [Migration(8)]
+    public class redacted_api : NzbDroneMigrationBase
+    {
+        protected override void MainDbUpgrade()
+        {
+            Execute.WithConnection(MigrateToRedactedApi);
+        }
+
+        private void MigrateToRedactedApi(IDbConnection conn, IDbTransaction tran)
+        {
+            using (var cmd = conn.CreateCommand())
+            {
+                cmd.Transaction = tran;
+                cmd.CommandText = "SELECT Id, Settings FROM Indexers WHERE Implementation = 'Redacted'";
+
+                using (var reader = cmd.ExecuteReader())
+                {
+                    while (reader.Read())
+                    {
+                        var id = reader.GetInt32(0);
+                        var settings = reader.GetString(1);
+                        if (!string.IsNullOrWhiteSpace(settings))
+                        {
+                            var jsonObject = Json.Deserialize<JObject>(settings);
+
+                            // Remove username
+                            if (jsonObject.ContainsKey("username"))
+                            {
+                                jsonObject.Remove("username");
+                            }
+
+                            // Remove password
+                            if (jsonObject.ContainsKey("password"))
+                            {
+                                jsonObject.Remove("password");
+                            }
+
+                            // write new json back to db, switch to new ConfigContract, and disable the indexer
+                            settings = jsonObject.ToJson();
+                            using (var updateCmd = conn.CreateCommand())
+                            {
+                                updateCmd.Transaction = tran;
+                                updateCmd.CommandText = "UPDATE Indexers SET Settings = ?, ConfigContract = ?, Enable = 0 WHERE Id = ?";
+                                updateCmd.AddParameter(settings);
+                                updateCmd.AddParameter("RedactedSettings");
+                                updateCmd.AddParameter(id);
+                                updateCmd.ExecuteNonQuery();
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

src/NzbDrone.Core/Indexers/Definitions/Redacted.cs

@@ -1,24 +1,53 @@
+using System;
 using System.Collections.Generic;
+using System.Linq;
+using System.Net;
+using System.Text;
+using System.Threading.Tasks;
+using FluentValidation;
+using FluentValidation.Results;
 using NLog;
 using NzbDrone.Common.Http;
+using NzbDrone.Common.Serializer;
+using NzbDrone.Core.Annotations;
 using NzbDrone.Core.Configuration;
+using NzbDrone.Core.Indexers.Exceptions;
+using NzbDrone.Core.Indexers.Gazelle;
+using NzbDrone.Core.IndexerSearch.Definitions;
 using NzbDrone.Core.Messaging.Events;
+using NzbDrone.Core.Parser.Model;
+using NzbDrone.Core.Validation;
 
 namespace NzbDrone.Core.Indexers.Definitions
 {
-    public class Redacted : Gazelle.Gazelle
+    public class Redacted : TorrentIndexerBase<RedactedSettings>
     {
         public override string Name => "Redacted";
         public override string[] IndexerUrls => new string[] { "https://redacted.ch/" };
         public override string Description => "REDActed (Aka.PassTheHeadPhones) is one of the most well-known music trackers.";
+        public override string Language => "en-us";
+        public override Encoding Encoding => Encoding.UTF8;
+        public override DownloadProtocol Protocol => DownloadProtocol.Torrent;
         public override IndexerPrivacy Privacy => IndexerPrivacy.Private;
+        public override IndexerCapabilities Capabilities => SetCapabilities();
+        public override bool SupportsRedirect => true;
 
         public Redacted(IHttpClient httpClient, IEventAggregator eventAggregator, IIndexerStatusService indexerStatusService, IConfigService configService, Logger logger)
             : base(httpClient, eventAggregator, indexerStatusService, configService, logger)
         {
         }
 
-        protected override IndexerCapabilities SetCapabilities()
+        public override IIndexerRequestGenerator GetRequestGenerator()
+        {
+            return new RedactedRequestGenerator() { Settings = Settings, Capabilities = Capabilities, HttpClient = _httpClient };
+        }
+
+        public override IParseIndexerResponse GetParser()
+        {
+            return new RedactedParser(Settings, Capabilities.Categories);
+        }
+
+        private IndexerCapabilities SetCapabilities()
         {
             var caps = new IndexerCapabilities
             {
@@ -42,13 +71,293 @@ namespace NzbDrone.Core.Indexers.Definitions
 
             caps.Categories.AddCategoryMapping(1, NewznabStandardCategory.Audio, "Music");
             caps.Categories.AddCategoryMapping(2, NewznabStandardCategory.PC, "Applications");
-            caps.Categories.AddCategoryMapping(3, NewznabStandardCategory.Books, "E-Books");
+            caps.Categories.AddCategoryMapping(3, NewznabStandardCategory.BooksEBook, "E-Books");
             caps.Categories.AddCategoryMapping(4, NewznabStandardCategory.AudioAudiobook, "Audiobooks");
-            caps.Categories.AddCategoryMapping(5, NewznabStandardCategory.Movies, "E-Learning Videos");
+            caps.Categories.AddCategoryMapping(5, NewznabStandardCategory.MoviesOther, "E-Learning Videos");
-            caps.Categories.AddCategoryMapping(6, NewznabStandardCategory.TV, "Comedy");
+            caps.Categories.AddCategoryMapping(6, NewznabStandardCategory.TVOther, "Comedy");
-            caps.Categories.AddCategoryMapping(7, NewznabStandardCategory.Books, "Comics");
+            caps.Categories.AddCategoryMapping(7, NewznabStandardCategory.BooksComics, "Comics");
 
             return caps;
         }
+
+        protected override async Task Test(List<ValidationFailure> failures)
+        {
+            ((RedactedRequestGenerator)GetRequestGenerator()).FetchPasskey();
+            await base.Test(failures);
+        }
+    }
+
+    public class RedactedRequestGenerator : IIndexerRequestGenerator
+    {
+        public RedactedSettings Settings { get; set; }
+        public IndexerCapabilities Capabilities { get; set; }
+        public Func<IDictionary<string, string>> GetCookies { get; set; }
+        public Action<IDictionary<string, string>, DateTime?> CookiesUpdater { get; set; }
+        public IHttpClient HttpClient { get; set; }
+
+        public RedactedRequestGenerator()
+        {
+        }
+
+        public IndexerPageableRequestChain GetSearchRequests(MusicSearchCriteria searchCriteria)
+        {
+            var pageableRequests = new IndexerPageableRequestChain();
+
+            pageableRequests.Add(GetRequest(string.Format("&artistname={0}&groupname={1}", searchCriteria.Artist, searchCriteria.Album)));
+
+            return pageableRequests;
+        }
+
+        public IndexerPageableRequestChain GetSearchRequests(BookSearchCriteria searchCriteria)
+        {
+            var pageableRequests = new IndexerPageableRequestChain();
+
+            pageableRequests.Add(GetRequest(searchCriteria.SanitizedSearchTerm));
+
+            return pageableRequests;
+        }
+
+        public IndexerPageableRequestChain GetSearchRequests(MovieSearchCriteria searchCriteria)
+        {
+            return new IndexerPageableRequestChain();
+        }
+
+        public IndexerPageableRequestChain GetSearchRequests(TvSearchCriteria searchCriteria)
+        {
+            return new IndexerPageableRequestChain();
+        }
+
+        public IndexerPageableRequestChain GetSearchRequests(BasicSearchCriteria searchCriteria)
+        {
+            var pageableRequests = new IndexerPageableRequestChain();
+
+            pageableRequests.Add(GetRequest(searchCriteria.SanitizedSearchTerm));
+
+            return pageableRequests;
+        }
+
+        public void FetchPasskey()
+        {
+            // GET on index for the passkey
+            var request = RequestBuilder().Resource("ajax.php?action=index").Build();
+            var indexResponse = HttpClient.Execute(request);
+            var index = Json.Deserialize<GazelleAuthResponse>(indexResponse.Content);
+            if (index == null ||
+                string.IsNullOrWhiteSpace(index.Status) ||
+                index.Status != "success" ||
+                string.IsNullOrWhiteSpace(index.Response.Passkey))
+            {
+                throw new Exception("Failed to authenticate with Redacted.");
+            }
+
+            // Set passkey on settings so it can be used to generate the download URL
+            Settings.Passkey = index.Response.Passkey;
+        }
+
+        private IEnumerable<IndexerRequest> GetRequest(string searchParameters)
+        {
+            var req = RequestBuilder()
+                .Resource($"ajax.php?action=browse&searchstr={searchParameters}")
+                .Build();
+
+            yield return new IndexerRequest(req);
+        }
+
+        private HttpRequestBuilder RequestBuilder()
+        {
+            return new HttpRequestBuilder($"{Settings.BaseUrl.Trim().TrimEnd('/')}")
+                .Accept(HttpAccept.Json)
+                .SetHeader("Authorization", Settings.Apikey);
+        }
+    }
+
+    public class RedactedParser : IParseIndexerResponse
+    {
+        private readonly RedactedSettings _settings;
+        private readonly IndexerCapabilitiesCategories _categories;
+        public Action<IDictionary<string, string>, DateTime?> CookiesUpdater { get; set; }
+
+        public RedactedParser(RedactedSettings settings, IndexerCapabilitiesCategories categories)
+        {
+            _settings = settings;
+            _categories = categories;
+        }
+
+        public IList<ReleaseInfo> ParseResponse(IndexerResponse indexerResponse)
+        {
+            var torrentInfos = new List<ReleaseInfo>();
+
+            if (indexerResponse.HttpResponse.StatusCode != HttpStatusCode.OK)
+            {
+                throw new IndexerException(indexerResponse, $"Unexpected response status {indexerResponse.HttpResponse.StatusCode} code from API request");
+            }
+
+            if (!indexerResponse.HttpResponse.Headers.ContentType.Contains(HttpAccept.Json.Value))
+            {
+                throw new IndexerException(indexerResponse, $"Unexpected response header {indexerResponse.HttpResponse.Headers.ContentType} from API request, expected {HttpAccept.Json.Value}");
+            }
+
+            var jsonResponse = new HttpResponse<GazelleResponse>(indexerResponse.HttpResponse);
+            if (jsonResponse.Resource.Status != "success" ||
+                string.IsNullOrWhiteSpace(jsonResponse.Resource.Status) ||
+                jsonResponse.Resource.Response == null)
+            {
+                return torrentInfos;
+            }
+
+            foreach (var result in jsonResponse.Resource.Response.Results)
+            {
+                if (result.Torrents != null)
+                {
+                    foreach (var torrent in result.Torrents)
+                    {
+                        var id = torrent.TorrentId;
+                        var artist = WebUtility.HtmlDecode(result.Artist);
+                        var album = WebUtility.HtmlDecode(result.GroupName);
+
+                        var title = $"{result.Artist} - {result.GroupName} ({result.GroupYear}) [{torrent.Format} {torrent.Encoding}] [{torrent.Media}]";
+                        if (torrent.HasCue)
+                        {
+                            title += " [Cue]";
+                        }
+
+                        GazelleInfo release = new GazelleInfo()
+                        {
+                            Guid = string.Format("Redacted-{0}", id),
+
+                            // Splice Title from info to avoid calling API again for every torrent.
+                            Title = WebUtility.HtmlDecode(title),
+
+                            Container = torrent.Encoding,
+                            Codec = torrent.Format,
+                            Size = long.Parse(torrent.Size),
+                            DownloadUrl = GetDownloadUrl(id, torrent.CanUseToken),
+                            InfoUrl = GetInfoUrl(result.GroupId, id),
+                            Seeders = int.Parse(torrent.Seeders),
+                            Peers = int.Parse(torrent.Leechers) + int.Parse(torrent.Seeders),
+                            PublishDate = torrent.Time.ToUniversalTime(),
+                            Scene = torrent.Scene,
+                            Freeleech = torrent.IsFreeLeech || torrent.IsPersonalFreeLeech,
+                            Files = torrent.FileCount,
+                            Grabs = torrent.Snatches,
+                        };
+
+                        var category = torrent.Category;
+                        if (category == null || category.Contains("Select Category"))
+                        {
+                            release.Categories = _categories.MapTrackerCatToNewznab("1");
+                        }
+                        else
+                        {
+                            release.Categories = _categories.MapTrackerCatDescToNewznab(category);
+                        }
+
+                        torrentInfos.Add(release);
+                    }
+                }
+
+                // Non-Audio files are formatted a little differently (1:1 for group and torrents)
+                else
+                {
+                    var id = result.TorrentId;
+                    GazelleInfo release = new GazelleInfo()
+                    {
+                        Guid = string.Format("Redacted-{0}", id),
+                        Title = WebUtility.HtmlDecode(result.GroupName),
+                        Size = long.Parse(result.Size),
+                        DownloadUrl = GetDownloadUrl(id, result.CanUseToken),
+                        InfoUrl = GetInfoUrl(result.GroupId, id),
+                        Seeders = int.Parse(result.Seeders),
+                        Peers = int.Parse(result.Leechers) + int.Parse(result.Seeders),
+                        PublishDate = DateTimeOffset.FromUnixTimeSeconds(result.GroupTime).UtcDateTime,
+                        Freeleech = result.IsFreeLeech || result.IsPersonalFreeLeech,
+                        Files = result.FileCount,
+                        Grabs = result.Snatches,
+                    };
+
+                    var category = result.Category;
+                    if (category == null || category.Contains("Select Category"))
+                    {
+                        release.Categories = _categories.MapTrackerCatToNewznab("1");
+                    }
+                    else
+                    {
+                        release.Categories = _categories.MapTrackerCatDescToNewznab(category);
+                    }
+
+                    torrentInfos.Add(release);
+                }
+            }
+
+            // order by date
+            return
+                torrentInfos
+                    .OrderByDescending(o => o.PublishDate)
+                    .ToArray();
+        }
+
+        private string GetDownloadUrl(int torrentId, bool canUseToken)
+        {
+            // AuthKey is required but not checked, just pass in a dummy variable
+            // to avoid having to track authkey, which is randomly cycled
+            var url = new HttpUri(_settings.BaseUrl)
+                .CombinePath("/torrents.php")
+                .AddQueryParam("action", "download")
+                .AddQueryParam("id", torrentId)
+                .AddQueryParam("authkey", "prowlarr")
+                .AddQueryParam("torrent_pass", _settings.Passkey)
+                .AddQueryParam("usetoken", (_settings.UseFreeleechToken && canUseToken) ? 1 : 0);
+
+            return url.FullUri;
+        }
+
+        private string GetInfoUrl(string groupId, int torrentId)
+        {
+            var url = new HttpUri(_settings.BaseUrl)
+                .CombinePath("/torrents.php")
+                .AddQueryParam("id", groupId)
+                .AddQueryParam("torrentid", torrentId);
+
+            return url.FullUri;
+        }
+    }
+
+    public class RedactedSettingsValidator : AbstractValidator<RedactedSettings>
+    {
+        public RedactedSettingsValidator()
+        {
+            RuleFor(c => c.Apikey).NotEmpty();
+        }
+    }
+
+    public class RedactedSettings : IIndexerSettings
+    {
+        private static readonly RedactedSettingsValidator Validator = new RedactedSettingsValidator();
+
+        public RedactedSettings()
+        {
+            Apikey = "";
+            Passkey = "";
+            UseFreeleechToken = false;
+        }
+
+        [FieldDefinition(1, Label = "Base Url", Type = FieldType.Select, SelectOptionsProviderAction = "getUrls", HelpText = "Select which baseurl Prowlarr will use for requests to the site")]
+        public string BaseUrl { get; set; }
+
+        [FieldDefinition(2, Label = "API Key", HelpText = "API Key from the Site (Found in Settings => Access Settings)", Privacy = PrivacyLevel.ApiKey)]
+        public string Apikey { get; set; }
+
+        [FieldDefinition(3, Label = "Use Freeleech Tokens", HelpText = "Use freeleech tokens when available", Type = FieldType.Checkbox)]
+        public bool UseFreeleechToken { get; set; }
+
+        [FieldDefinition(4)]
+        public IndexerBaseSettings BaseSettings { get; set; } = new IndexerBaseSettings();
+
+        public string Passkey { get; set; }
+
+        public NzbDroneValidationResult Validate()
+        {
+            return new NzbDroneValidationResult(Validator.Validate(this));
+        }
     }
 }