using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; using AutoMapper; using Jackett.Common.Models; using Jackett.Common.Models.IndexerConfig; using Jackett.Common.Services.Interfaces; using Jackett.Common.Utils; using Jackett.Common.Utils.Clients; using Newtonsoft.Json; using Newtonsoft.Json.Linq; using NLog; namespace Jackett.Common.Indexers { public abstract class BaseIndexer : IIndexer { public static string GetIndexerID(Type type) { return type.Name.ToLowerInvariant().StripNonAlphaNumeric(); } public string SiteLink { get; protected set; } public virtual string[] LegacySiteLinks { get; protected set; } public string DefaultSiteLink { get; protected set; } public virtual string[] AlternativeSiteLinks { get; protected set; } = new string[] { }; public string DisplayDescription { get; protected set; } public string DisplayName { get; protected set; } public string Language { get; protected set; } public string Type { get; protected set; } public virtual string ID { get { return GetIndexerID(GetType()); } } public virtual bool IsConfigured { get; protected set; } protected Logger logger; protected IIndexerConfigurationService configurationService; protected IProtectionService protectionService; protected ConfigurationData configData; protected string CookieHeader { get { return configData.CookieHeader.Value; } set { configData.CookieHeader.Value = value; } } public string LastError { get { return configData.LastError.Value; } set { bool SaveNeeded = configData.LastError.Value != value && IsConfigured; configData.LastError.Value = value; if (SaveNeeded) SaveConfig(); } } public abstract TorznabCapabilities TorznabCaps { get; protected set; } // standard constructor used by most indexers public BaseIndexer(string name, string link, string description, IIndexerConfigurationService configService, Logger logger, ConfigurationData configData, IProtectionService p) { this.logger = logger; configurationService = configService; protectionService = p; if (!link.EndsWith("/", StringComparison.Ordinal)) throw new Exception("Site link must end with a slash."); DisplayName = name; DisplayDescription = description; SiteLink = link; DefaultSiteLink = link; this.configData = configData; if (configData != null) LoadValuesFromJson(null); } public virtual Task GetConfigurationForSetup() { return Task.FromResult(configData); } public virtual void ResetBaseConfig() { CookieHeader = string.Empty; IsConfigured = false; } public virtual void SaveConfig() { configurationService.Save(this as IIndexer, configData.ToJson(protectionService, forDisplay: false)); } protected void LoadLegacyCookieConfig(JToken jsonConfig) { string legacyCookieHeader = (string)jsonConfig["cookie_header"]; if (!string.IsNullOrEmpty(legacyCookieHeader)) { CookieHeader = legacyCookieHeader; } else { // Legacy cookie key var jcookies = jsonConfig["cookies"]; if (jcookies is JArray) { var array = (JArray)jcookies; legacyCookieHeader = string.Empty; for (int i = 0; i < array.Count; i++) { if (i != 0) legacyCookieHeader += "; "; legacyCookieHeader += array[i]; } CookieHeader = legacyCookieHeader; } else if (jcookies != null) { CookieHeader = (string)jcookies; } } } virtual public void LoadValuesFromJson(JToken jsonConfig, bool useProtectionService = false) { IProtectionService ps = null; if (useProtectionService) ps = protectionService; configData.LoadValuesFromJson(jsonConfig, ps); if (string.IsNullOrWhiteSpace(configData.SiteLink.Value)) { configData.SiteLink.Value = DefaultSiteLink; } if (!configData.SiteLink.Value.EndsWith("/", StringComparison.Ordinal)) configData.SiteLink.Value += "/"; // reset site link to default if it's a legacy (defunc link) if (LegacySiteLinks != null && LegacySiteLinks.Contains(configData.SiteLink.Value)) { logger.Debug(string.Format("changing legacy site link from {0} to {1}", configData.SiteLink.Value, DefaultSiteLink)); configData.SiteLink.Value = DefaultSiteLink; } // check whether the site link is well-formatted var siteUri = new Uri(configData.SiteLink.Value); SiteLink = configData.SiteLink.Value; } public void LoadFromSavedConfiguration(JToken jsonConfig) { if (jsonConfig is JArray) { LoadValuesFromJson(jsonConfig, true); IsConfigured = true; } // read and upgrade old settings file format else if (jsonConfig is Object) { LoadLegacyCookieConfig(jsonConfig); SaveConfig(); IsConfigured = true; } } protected async Task ConfigureIfOK(string cookies, bool isLoggedin, Func onError) { if (isLoggedin) { CookieHeader = cookies; IsConfigured = true; SaveConfig(); } else { await onError(); } } protected virtual IEnumerable FilterResults(TorznabQuery query, IEnumerable results) { if (query.Categories.Length == 0) return results; var filteredResults = results.Where(result => { return result.Category.IsEmptyOrNull() || query.Categories.Intersect(result.Category).Any() || TorznabCatType.QueryContainsParentCategory(query.Categories, result.Category); }); return filteredResults; } public virtual bool CanHandleQuery(TorznabQuery query) { if (query == null) return false; if (query.QueryType == "caps") return true; var caps = TorznabCaps; if (query.HasSpecifiedCategories) if (!caps.SupportsCategories(query.Categories)) return false; if (caps.SearchAvailable && query.IsSearch) return true; if (caps.TVSearchAvailable && query.IsTVSearch) return true; if (caps.MovieSearchAvailable && query.IsMovieSearch) return true; if (caps.MusicSearchAvailable && query.IsMusicSearch) return true; if (caps.SupportsTVRageSearch && query.IsTVRageSearch) return true; if (caps.SupportsImdbSearch && query.IsImdbQuery) return true; return false; } public void Unconfigure() { IsConfigured = false; SiteLink = DefaultSiteLink; CookieHeader = ""; // clear cookies } public abstract Task ApplyConfiguration(JToken configJson); public virtual async Task ResultsForQuery(TorznabQuery query) { try { if (!CanHandleQuery(query)) return new IndexerResult(this, new ReleaseInfo[0]); var results = await PerformQuery(query); results = FilterResults(query, results); results = results.Select(r => { r.Origin = this; // Some trackers do not keep their clocks up to date and can be ~20 minutes out! if (r.PublishDate > DateTime.Now) r.PublishDate = DateTime.Now; return r; }); return new IndexerResult(this, results); } catch (Exception ex) { throw new IndexerException(this, ex); } } protected abstract Task> PerformQuery(TorznabQuery query); } public abstract class BaseWebIndexer : BaseIndexer, IWebIndexer { protected BaseWebIndexer(string name, string link, string description, IIndexerConfigurationService configService, WebClient client, Logger logger, ConfigurationData configData, IProtectionService p, TorznabCapabilities caps = null, string downloadBase = null) : base(name, link, description, configService, logger, configData, p) { this.webclient = client; this.downloadUrlBase = downloadBase; if (caps == null) caps = TorznabUtil.CreateDefaultTorznabTVCaps(); TorznabCaps = caps; } // minimal constructor used by e.g. cardigann generic indexer protected BaseWebIndexer(IIndexerConfigurationService configService, WebClient client, Logger logger, IProtectionService p) : base("", "/", "", configService, logger, null, p) { this.webclient = client; } public async virtual Task Download(Uri link) { var uncleanLink = UncleanLink(link); return await Download(uncleanLink, RequestType.GET); } protected async Task Download(Uri link, RequestType method) { // return magnet link if (link.Scheme == "magnet") return Encoding.UTF8.GetBytes(link.OriginalString); // do some extra escaping, needed for HD-Torrents var requestLink = link.ToString() .Replace("(", "%28") .Replace(")", "%29") .Replace("'", "%27"); var response = await RequestBytesWithCookiesAndRetry(requestLink, null, method, requestLink); if (response.IsRedirect) { await FollowIfRedirect(response); } if (response.Status != System.Net.HttpStatusCode.OK && response.Status != System.Net.HttpStatusCode.Continue && response.Status != System.Net.HttpStatusCode.PartialContent) { logger.Error("Failed download cookies: " + this.CookieHeader); if (response.Content != null) logger.Error("Failed download response:\n" + Encoding.UTF8.GetString(response.Content)); throw new Exception($"Remote server returned {response.Status.ToString()}" + (response.IsRedirect ? " => " + response.RedirectingTo : "")); } return response.Content; } protected async Task RequestBytesWithCookiesAndRetry(string url, string cookieOverride = null, RequestType method = RequestType.GET, string referer = null, IEnumerable> data = null) { Exception lastException = null; for (int i = 0; i < 3; i++) { try { return await RequestBytesWithCookies(url, cookieOverride, method, referer, data); } catch (Exception e) { logger.Error(e, string.Format("On attempt {0} downloading from {1}: {2}", (i + 1), DisplayName, e.Message)); lastException = e; } await Task.Delay(500); } throw lastException; } protected async Task RequestStringWithCookies(string url, string cookieOverride = null, string referer = null, Dictionary headers = null) { var request = new Utils.Clients.WebRequest() { Url = url, Type = RequestType.GET, Cookies = CookieHeader, Referer = referer, Headers = headers, Encoding = Encoding }; if (cookieOverride != null) request.Cookies = cookieOverride; WebClientStringResult result = await webclient.GetString(request); CheckTrackerDown(result); UpdateCookieHeader(result.Cookies, cookieOverride); return result; } protected async Task RequestStringWithCookiesAndRetry(string url, string cookieOverride = null, string referer = null, Dictionary headers = null) { Exception lastException = null; for (int i = 0; i < 3; i++) { try { return await RequestStringWithCookies(url, cookieOverride, referer, headers); } catch (Exception e) { logger.Error(string.Format("On attempt {0} checking for results from {1}: {2}", (i + 1), DisplayName, e.Message)); lastException = e; } await Task.Delay(500); } throw lastException; } protected virtual async Task RequestBytesWithCookies(string url, string cookieOverride = null, RequestType method = RequestType.GET, string referer = null, IEnumerable> data = null, Dictionary headers = null) { var request = new Utils.Clients.WebRequest() { Url = url, Type = method, Cookies = cookieOverride ?? CookieHeader, PostData = data, Referer = referer, Headers = headers, Encoding = Encoding }; if (cookieOverride != null) request.Cookies = cookieOverride; var result = await webclient.GetBytes(request); UpdateCookieHeader(result.Cookies, cookieOverride); return result; } protected async Task PostDataWithCookies(string url, IEnumerable> data, string cookieOverride = null, string referer = null, Dictionary headers = null, string rawbody = null, bool? emulateBrowser = null) { var request = new Utils.Clients.WebRequest() { Url = url, Type = RequestType.POST, Cookies = cookieOverride ?? CookieHeader, PostData = data, Referer = referer, Headers = headers, RawBody = rawbody, Encoding = Encoding }; if (emulateBrowser.HasValue) request.EmulateBrowser = emulateBrowser.Value; WebClientStringResult result = await webclient.GetString(request); CheckTrackerDown(result); UpdateCookieHeader(result.Cookies, cookieOverride); return result; } protected async Task PostDataWithCookiesAndRetry(string url, IEnumerable> data, string cookieOverride = null, string referer = null, Dictionary headers = null, string rawbody = null, bool? emulateBrowser = null) { Exception lastException = null; for (int i = 0; i < 3; i++) { try { return await PostDataWithCookies(url, data, cookieOverride, referer, headers, rawbody, emulateBrowser); } catch (Exception e) { logger.Error(string.Format("On attempt {0} checking for results from {1}: {2}", (i + 1), DisplayName, e.Message)); lastException = e; } await Task.Delay(500); } throw lastException; } protected async Task RequestLoginAndFollowRedirect(string url, IEnumerable> data, string cookies, bool returnCookiesFromFirstCall, string redirectUrlOverride = null, string referer = null, bool accumulateCookies = false) { var request = new Utils.Clients.WebRequest() { Url = url, Type = RequestType.POST, Cookies = cookies, Referer = referer, PostData = data, Encoding = Encoding }; var response = await webclient.GetString(request); CheckTrackerDown(response); if (accumulateCookies) { response.Cookies = ResolveCookies((request.Cookies == null ? "" : request.Cookies + " ") + response.Cookies); } var firstCallCookies = response.Cookies; if (response.IsRedirect) { await FollowIfRedirect(response, request.Url, redirectUrlOverride, response.Cookies, accumulateCookies); } if (returnCookiesFromFirstCall) { response.Cookies = ResolveCookies(firstCallCookies + (accumulateCookies ? " " + response.Cookies : "")); } return response; } protected void CheckTrackerDown(WebClientStringResult response) { if (response.Status == System.Net.HttpStatusCode.BadGateway || response.Status == System.Net.HttpStatusCode.GatewayTimeout || (int)response.Status == 521 // used by cloudflare to signal the original webserver is refusing the connection || (int)response.Status == 522 // used by cloudflare to signal the original webserver is not reachable at all (timeout) || (int)response.Status == 523 // used by cloudflare to signal the original webserver is not reachable at all (Origin is unreachable) ) { throw new Exception("Request to " + response.Request.Url + " failed (Error " + response.Status + ") - The tracker seems to be down."); } } protected async Task FollowIfRedirect(WebClientStringResult response, string referrer = null, string overrideRedirectUrl = null, string overrideCookies = null, bool accumulateCookies = false) { var byteResult = new WebClientByteResult(); // Map to byte Mapper.Map(response, byteResult); await FollowIfRedirect(byteResult, referrer, overrideRedirectUrl, overrideCookies, accumulateCookies); // Map to string Mapper.Map(byteResult, response); } protected async Task FollowIfRedirect(WebClientByteResult response, string referrer = null, string overrideRedirectUrl = null, string overrideCookies = null, bool accumulateCookies = false) { // Follow up to 5 redirects for (int i = 0; i < 5; i++) { if (!response.IsRedirect) break; await DoFollowIfRedirect(response, referrer, overrideRedirectUrl, overrideCookies, accumulateCookies); if (accumulateCookies) { CookieHeader = ResolveCookies((CookieHeader != null && CookieHeader != "" ? CookieHeader + " " : "") + (overrideCookies != null && overrideCookies != "" ? overrideCookies + " " : "") + response.Cookies); overrideCookies = response.Cookies = CookieHeader; } if (overrideCookies != null && response.Cookies == null) { response.Cookies = overrideCookies; } } } private String ResolveCookies(String incomingCookies = "") { var redirRequestCookies = (CookieHeader != null && CookieHeader != "" ? CookieHeader + " " : "") + incomingCookies; System.Text.RegularExpressions.Regex expression = new System.Text.RegularExpressions.Regex(@"([^\\,;\s]+)=([^=\\,;\s]*)"); Dictionary cookieDIctionary = new Dictionary(); var matches = expression.Match(redirRequestCookies); while (matches.Success) { if (matches.Groups.Count > 2) cookieDIctionary[matches.Groups[1].Value] = matches.Groups[2].Value; matches = matches.NextMatch(); } return string.Join("; ", cookieDIctionary .Where(kv => kv.Key != "cf_use_ob" && kv.Key != "cf_ob_info") // These cookies are causing BadGateway errors, so we drop them, see issue #2306 .Select(kv => kv.Key.ToString() + "=" + kv.Value.ToString()).ToArray()); } // Update CookieHeader with new cookies and save the config if something changed (e.g. a new CloudFlare clearance cookie was issued) protected virtual void UpdateCookieHeader(string newCookies, string cookieOverride = null) { string newCookieHeader = ResolveCookies((cookieOverride != null && cookieOverride != "" ? cookieOverride + " " : "") + newCookies); if (CookieHeader != newCookieHeader) { logger.Debug(string.Format("updating Cookies {0} => {1}", CookieHeader, newCookieHeader)); CookieHeader = newCookieHeader; if (IsConfigured) SaveConfig(); } } private async Task DoFollowIfRedirect(WebClientByteResult incomingResponse, string referrer = null, string overrideRedirectUrl = null, string overrideCookies = null, bool accumulateCookies = false) { if (incomingResponse.IsRedirect) { var redirRequestCookies = ""; if (accumulateCookies) { redirRequestCookies = ResolveCookies((CookieHeader != "" ? CookieHeader + " " : "") + (overrideCookies != null ? overrideCookies : "")); } else { redirRequestCookies = (overrideCookies != null ? overrideCookies : ""); } // Do redirect var redirectedResponse = await webclient.GetBytes(new WebRequest() { Url = overrideRedirectUrl ?? incomingResponse.RedirectingTo, Referer = referrer, Cookies = redirRequestCookies, Encoding = Encoding }); Mapper.Map(redirectedResponse, incomingResponse); } } protected List GetAllTrackerCategories() { return categoryMapping.Select(x => x.TrackerCategory).ToList(); } protected void AddCategoryMapping(string trackerCategory, TorznabCategory newznabCategory, string trackerCategoryDesc = null) { categoryMapping.Add(new CategoryMapping(trackerCategory, trackerCategoryDesc, newznabCategory.ID)); if (!TorznabCaps.Categories.Contains(newznabCategory)) { TorznabCaps.Categories.Add(newznabCategory); if (TorznabCatType.Movies.Contains(newznabCategory)) TorznabCaps.MovieSearchAvailable = true; } // add 1:1 categories if (trackerCategoryDesc != null && trackerCategory != null) { try { var trackerCategoryInt = int.Parse(trackerCategory); var CustomCat = new TorznabCategory(trackerCategoryInt + 100000, trackerCategoryDesc); if (!TorznabCaps.Categories.Contains(CustomCat)) TorznabCaps.Categories.Add(CustomCat); } catch (FormatException) { // trackerCategory is not an integer, continue } } } protected void AddCategoryMapping(int trackerCategory, TorznabCategory newznabCategory, string trackerCategoryDesc = null) { AddCategoryMapping(trackerCategory.ToString(), newznabCategory, trackerCategoryDesc); } protected void AddMultiCategoryMapping(TorznabCategory newznabCategory, params int[] trackerCategories) { foreach (var trackerCat in trackerCategories) { AddCategoryMapping(trackerCat, newznabCategory); } } protected virtual List MapTorznabCapsToTrackers(TorznabQuery query, bool mapChildrenCatsToParent = false) { var result = new List(); foreach (var cat in query.Categories) { // use 1:1 mapping to tracker categories for newznab categories >= 100000 if (cat >= 100000) { result.Add((cat - 100000).ToString()); continue; } var queryCats = new List { cat }; var newznabCat = TorznabCatType.AllCats.FirstOrDefault(c => c.ID == cat); if (newznabCat != null) { queryCats.AddRange(newznabCat.SubCategories.Select(c => c.ID)); } if (mapChildrenCatsToParent) { var parentNewznabCat = TorznabCatType.AllCats.FirstOrDefault(c => c.SubCategories.Contains(newznabCat)); if (parentNewznabCat != null) { queryCats.Add(parentNewznabCat.ID); } } foreach (var mapping in categoryMapping.Where(c => queryCats.Contains(c.NewzNabCategory))) { result.Add(mapping.TrackerCategory); } } return result.Distinct().ToList(); } protected ICollection MapTrackerCatToNewznab(string input) { var cats = new List(); if (null != input) { var mapping = categoryMapping.Where(m => m.TrackerCategory != null && m.TrackerCategory.ToLowerInvariant() == input.ToLowerInvariant()).FirstOrDefault(); if (mapping != null) { cats.Add(mapping.NewzNabCategory); } // 1:1 category mapping try { var trackerCategoryInt = int.Parse(input); cats.Add(trackerCategoryInt + 100000); } catch (FormatException) { // input is not an integer, continue } } return cats; } protected ICollection MapTrackerCatDescToNewznab(string input) { var cats = new List(); if (null != input) { var mapping = categoryMapping.Where(m => m.TrackerCategoryDesc != null && m.TrackerCategoryDesc.ToLowerInvariant() == input.ToLowerInvariant()).FirstOrDefault(); if (mapping != null) { cats.Add(mapping.NewzNabCategory); if (mapping.TrackerCategory != null) { // 1:1 category mapping try { var trackerCategoryInt = int.Parse(mapping.TrackerCategory); cats.Add(trackerCategoryInt + 100000); } catch (FormatException) { // mapping.TrackerCategory is not an integer, continue } } } } return cats; } private IEnumerable CleanLinks(IEnumerable releases) { if (string.IsNullOrEmpty(downloadUrlBase)) return releases; foreach (var release in releases) { if (release.Link.ToString().StartsWith(downloadUrlBase, StringComparison.Ordinal)) { release.Link = new Uri(release.Link.ToString().Substring(downloadUrlBase.Length), UriKind.Relative); } } return releases; } public override async Task ResultsForQuery(TorznabQuery query) { var result = await base.ResultsForQuery(query); result.Releases = CleanLinks(result.Releases); return result; } protected virtual Uri UncleanLink(Uri link) { if (string.IsNullOrWhiteSpace(downloadUrlBase)) { return link; } if (link.ToString().StartsWith(downloadUrlBase, StringComparison.Ordinal)) { return link; } return new Uri(downloadUrlBase + link.ToString(), UriKind.RelativeOrAbsolute); } protected void OnParseError(string results, Exception ex) { var fileName = string.Format("Error on {0} for {1}.txt", DateTime.Now.ToString("yyyyMMddHHmmss"), DisplayName); var spacing = string.Join("", Enumerable.Repeat(Environment.NewLine, 5)); var fileContents = string.Format("{0}{1}{2}", ex, spacing, results); logger.Error(fileName + fileContents); throw new Exception("Parse error", ex); } public override TorznabCapabilities TorznabCaps { get; protected set; } [JsonConverter(typeof(EncodingJsonConverter))] public Encoding Encoding { get; protected set; } private List categoryMapping = new List(); protected WebClient webclient; protected readonly string downloadUrlBase = ""; } public abstract class BaseCachingWebIndexer : BaseWebIndexer { protected BaseCachingWebIndexer(string name, string link, string description, IIndexerConfigurationService configService, WebClient client, Logger logger, ConfigurationData configData, IProtectionService p, TorznabCapabilities caps = null, string downloadBase = null) : base(name, link, description, configService, client, logger, configData, p, caps, downloadBase) { } protected void CleanCache() { foreach (var expired in cache.Where(i => DateTime.Now - i.Created > cacheTime).ToList()) { cache.Remove(expired); } } protected static List cache = new List(); protected static readonly TimeSpan cacheTime = new TimeSpan(0, 9, 0); } }