OpenSubtitleDownloader.cs 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340
  1. using MediaBrowser.Common.Configuration;
  2. using MediaBrowser.Common.Extensions;
  3. using MediaBrowser.Common.Net;
  4. using MediaBrowser.Controller.Configuration;
  5. using MediaBrowser.Controller.Providers;
  6. using MediaBrowser.Controller.Security;
  7. using MediaBrowser.Controller.Subtitles;
  8. using MediaBrowser.Model.Dto;
  9. using MediaBrowser.Model.Entities;
  10. using MediaBrowser.Model.Logging;
  11. using MediaBrowser.Model.Providers;
  12. using MediaBrowser.Model.Serialization;
  13. using OpenSubtitlesHandler;
  14. using System;
  15. using System.Collections.Generic;
  16. using System.Globalization;
  17. using System.IO;
  18. using System.Linq;
  19. using System.Threading;
  20. using System.Threading.Tasks;
  21. namespace MediaBrowser.Providers.Subtitles
  22. {
  23. public class OpenSubtitleDownloader : ISubtitleProvider, IDisposable
  24. {
  25. private readonly ILogger _logger;
  26. private readonly IHttpClient _httpClient;
  27. private readonly CultureInfo _usCulture = new CultureInfo("en-US");
  28. private readonly IServerConfigurationManager _config;
  29. private readonly IEncryptionManager _encryption;
  30. private readonly IJsonSerializer _json;
  31. public OpenSubtitleDownloader(ILogManager logManager, IHttpClient httpClient, IServerConfigurationManager config, IEncryptionManager encryption, IJsonSerializer json)
  32. {
  33. _logger = logManager.GetLogger(GetType().Name);
  34. _httpClient = httpClient;
  35. _config = config;
  36. _encryption = encryption;
  37. _json = json;
  38. _config.NamedConfigurationUpdating += _config_NamedConfigurationUpdating;
  39. Utilities.HttpClient = httpClient;
  40. OpenSubtitles.SetUserAgent("mediabrowser.tv");
  41. }
  42. private const string PasswordHashPrefix = "h:";
  43. void _config_NamedConfigurationUpdating(object sender, ConfigurationUpdateEventArgs e)
  44. {
  45. if (!string.Equals(e.Key, "subtitles", StringComparison.OrdinalIgnoreCase))
  46. {
  47. return;
  48. }
  49. var options = (SubtitleOptions)e.NewConfiguration;
  50. if (options != null &&
  51. !string.IsNullOrWhiteSpace(options.OpenSubtitlesPasswordHash) &&
  52. !options.OpenSubtitlesPasswordHash.StartsWith(PasswordHashPrefix, StringComparison.OrdinalIgnoreCase))
  53. {
  54. options.OpenSubtitlesPasswordHash = EncryptPassword(options.OpenSubtitlesPasswordHash);
  55. }
  56. }
  57. private string EncryptPassword(string password)
  58. {
  59. return PasswordHashPrefix + _encryption.EncryptString(password);
  60. }
  61. private string DecryptPassword(string password)
  62. {
  63. if (password == null ||
  64. !password.StartsWith(PasswordHashPrefix, StringComparison.OrdinalIgnoreCase))
  65. {
  66. return string.Empty;
  67. }
  68. return _encryption.DecryptString(password.Substring(2));
  69. }
  70. public string Name
  71. {
  72. get { return "Open Subtitles"; }
  73. }
  74. private SubtitleOptions GetOptions()
  75. {
  76. return _config.GetSubtitleConfiguration();
  77. }
  78. public IEnumerable<VideoContentType> SupportedMediaTypes
  79. {
  80. get
  81. {
  82. var options = GetOptions();
  83. if (string.IsNullOrWhiteSpace(options.OpenSubtitlesUsername) ||
  84. string.IsNullOrWhiteSpace(options.OpenSubtitlesPasswordHash))
  85. {
  86. return new VideoContentType[] { };
  87. }
  88. return new[] { VideoContentType.Episode, VideoContentType.Movie };
  89. }
  90. }
  91. public Task<SubtitleResponse> GetSubtitles(string id, CancellationToken cancellationToken)
  92. {
  93. return GetSubtitlesInternal(id, GetOptions(), cancellationToken);
  94. }
  95. private DateTime _lastRateLimitException;
  96. private async Task<SubtitleResponse> GetSubtitlesInternal(string id,
  97. SubtitleOptions options,
  98. CancellationToken cancellationToken)
  99. {
  100. if (string.IsNullOrWhiteSpace(id))
  101. {
  102. throw new ArgumentNullException("id");
  103. }
  104. var idParts = id.Split(new[] { '-' }, 3);
  105. var format = idParts[0];
  106. var language = idParts[1];
  107. var ossId = idParts[2];
  108. var downloadsList = new[] { int.Parse(ossId, _usCulture) };
  109. await Login(cancellationToken).ConfigureAwait(false);
  110. if ((DateTime.UtcNow - _lastRateLimitException).TotalHours < 1)
  111. {
  112. throw new ApplicationException("OpenSubtitles rate limit reached");
  113. }
  114. var resultDownLoad = await OpenSubtitles.DownloadSubtitlesAsync(downloadsList, cancellationToken).ConfigureAwait(false);
  115. if ((resultDownLoad.Status ?? string.Empty).IndexOf("407", StringComparison.OrdinalIgnoreCase) != -1)
  116. {
  117. _lastRateLimitException = DateTime.UtcNow;
  118. throw new ApplicationException("OpenSubtitles rate limit reached");
  119. }
  120. if (!(resultDownLoad is MethodResponseSubtitleDownload))
  121. {
  122. throw new ApplicationException("Invalid response type");
  123. }
  124. var results = ((MethodResponseSubtitleDownload)resultDownLoad).Results;
  125. _lastRateLimitException = DateTime.MinValue;
  126. if (results.Count == 0)
  127. {
  128. var msg = string.Format("Subtitle with Id {0} was not found. Name: {1}. Status: {2}. Message: {3}",
  129. ossId,
  130. resultDownLoad.Name ?? string.Empty,
  131. resultDownLoad.Status ?? string.Empty,
  132. resultDownLoad.Message ?? string.Empty);
  133. throw new ResourceNotFoundException(msg);
  134. }
  135. var data = Convert.FromBase64String(results.First().Data);
  136. return new SubtitleResponse
  137. {
  138. Format = format,
  139. Language = language,
  140. Stream = new MemoryStream(Utilities.Decompress(new MemoryStream(data)))
  141. };
  142. }
  143. private DateTime _lastLogin;
  144. private async Task Login(CancellationToken cancellationToken)
  145. {
  146. if ((DateTime.UtcNow - _lastLogin).TotalSeconds < 60)
  147. {
  148. return;
  149. }
  150. var options = GetOptions();
  151. var user = options.OpenSubtitlesUsername ?? string.Empty;
  152. var password = DecryptPassword(options.OpenSubtitlesPasswordHash);
  153. var loginResponse = await OpenSubtitles.LogInAsync(user, password, "en", cancellationToken).ConfigureAwait(false);
  154. if (!(loginResponse is MethodResponseLogIn))
  155. {
  156. throw new Exception("Authentication to OpenSubtitles failed.");
  157. }
  158. _lastLogin = DateTime.UtcNow;
  159. }
  160. public async Task<IEnumerable<NameIdPair>> GetSupportedLanguages(CancellationToken cancellationToken)
  161. {
  162. await Login(cancellationToken).ConfigureAwait(false);
  163. var result = OpenSubtitles.GetSubLanguages("en");
  164. if (!(result is MethodResponseGetSubLanguages))
  165. {
  166. _logger.Error("Invalid response type");
  167. return new List<NameIdPair>();
  168. }
  169. var results = ((MethodResponseGetSubLanguages)result).Languages;
  170. return results.Select(i => new NameIdPair
  171. {
  172. Name = i.LanguageName,
  173. Id = i.SubLanguageID
  174. });
  175. }
  176. private string NormalizeLanguage(string language)
  177. {
  178. // Problem with Greek subtitle download #1349
  179. if (string.Equals (language, "gre", StringComparison.OrdinalIgnoreCase)) {
  180. return "ell";
  181. }
  182. return language;
  183. }
  184. public async Task<IEnumerable<RemoteSubtitleInfo>> Search(SubtitleSearchRequest request, CancellationToken cancellationToken)
  185. {
  186. var imdbIdText = request.GetProviderId(MetadataProviders.Imdb);
  187. long imdbId = 0;
  188. switch (request.ContentType)
  189. {
  190. case VideoContentType.Episode:
  191. if (!request.IndexNumber.HasValue || !request.ParentIndexNumber.HasValue || string.IsNullOrEmpty(request.SeriesName))
  192. {
  193. _logger.Debug("Episode information missing");
  194. return new List<RemoteSubtitleInfo>();
  195. }
  196. break;
  197. case VideoContentType.Movie:
  198. if (string.IsNullOrEmpty(request.Name))
  199. {
  200. _logger.Debug("Movie name missing");
  201. return new List<RemoteSubtitleInfo>();
  202. }
  203. if (string.IsNullOrWhiteSpace(imdbIdText) || !long.TryParse(imdbIdText.TrimStart('t'), NumberStyles.Any, _usCulture, out imdbId))
  204. {
  205. _logger.Debug("Imdb id missing");
  206. return new List<RemoteSubtitleInfo>();
  207. }
  208. break;
  209. }
  210. if (string.IsNullOrEmpty(request.MediaPath))
  211. {
  212. _logger.Debug("Path Missing");
  213. return new List<RemoteSubtitleInfo>();
  214. }
  215. await Login(cancellationToken).ConfigureAwait(false);
  216. var subLanguageId = NormalizeLanguage(request.Language);
  217. var hash = Utilities.ComputeHash(request.MediaPath);
  218. var fileInfo = new FileInfo(request.MediaPath);
  219. var movieByteSize = fileInfo.Length;
  220. var searchImdbId = request.ContentType == VideoContentType.Movie ? imdbId.ToString(_usCulture) : "";
  221. var subtitleSearchParameters = request.ContentType == VideoContentType.Episode
  222. ? new List<SubtitleSearchParameters> {
  223. new SubtitleSearchParameters(subLanguageId,
  224. query: request.SeriesName,
  225. season: request.ParentIndexNumber.Value.ToString(_usCulture),
  226. episode: request.IndexNumber.Value.ToString(_usCulture))
  227. }
  228. : new List<SubtitleSearchParameters> {
  229. new SubtitleSearchParameters(subLanguageId, imdbid: searchImdbId),
  230. new SubtitleSearchParameters(subLanguageId, query: request.Name, imdbid: searchImdbId)
  231. };
  232. var parms = new List<SubtitleSearchParameters> {
  233. new SubtitleSearchParameters( subLanguageId,
  234. movieHash: hash,
  235. movieByteSize: movieByteSize,
  236. imdbid: searchImdbId ),
  237. };
  238. parms.AddRange(subtitleSearchParameters);
  239. var result = await OpenSubtitles.SearchSubtitlesAsync(parms.ToArray(), cancellationToken).ConfigureAwait(false);
  240. if (!(result is MethodResponseSubtitleSearch))
  241. {
  242. _logger.Error("Invalid response type");
  243. return new List<RemoteSubtitleInfo>();
  244. }
  245. Predicate<SubtitleSearchResult> mediaFilter =
  246. x =>
  247. request.ContentType == VideoContentType.Episode
  248. ? !string.IsNullOrEmpty(x.SeriesSeason) && !string.IsNullOrEmpty(x.SeriesEpisode) &&
  249. int.Parse(x.SeriesSeason, _usCulture) == request.ParentIndexNumber &&
  250. int.Parse(x.SeriesEpisode, _usCulture) == request.IndexNumber
  251. : !string.IsNullOrEmpty(x.IDMovieImdb) && long.Parse(x.IDMovieImdb, _usCulture) == imdbId;
  252. var results = ((MethodResponseSubtitleSearch)result).Results;
  253. // Avoid implicitly captured closure
  254. var hasCopy = hash;
  255. return results.Where(x => x.SubBad == "0" && mediaFilter(x) && (!request.IsPerfectMatch || string.Equals(x.MovieHash, hash, StringComparison.OrdinalIgnoreCase)))
  256. .OrderBy(x => (string.Equals(x.MovieHash, hash, StringComparison.OrdinalIgnoreCase) ? 0 : 1))
  257. .ThenBy(x => Math.Abs(long.Parse(x.MovieByteSize, _usCulture) - movieByteSize))
  258. .ThenByDescending(x => int.Parse(x.SubDownloadsCnt, _usCulture))
  259. .ThenByDescending(x => double.Parse(x.SubRating, _usCulture))
  260. .Select(i => new RemoteSubtitleInfo
  261. {
  262. Author = i.UserNickName,
  263. Comment = i.SubAuthorComment,
  264. CommunityRating = float.Parse(i.SubRating, _usCulture),
  265. DownloadCount = int.Parse(i.SubDownloadsCnt, _usCulture),
  266. Format = i.SubFormat,
  267. ProviderName = Name,
  268. ThreeLetterISOLanguageName = i.SubLanguageID,
  269. Id = i.SubFormat + "-" + i.SubLanguageID + "-" + i.IDSubtitleFile,
  270. Name = i.SubFileName,
  271. DateCreated = DateTime.Parse(i.SubAddDate, _usCulture),
  272. IsHashMatch = i.MovieHash == hasCopy
  273. }).Where(i => !string.Equals(i.Format, "sub", StringComparison.OrdinalIgnoreCase) && !string.Equals(i.Format, "idx", StringComparison.OrdinalIgnoreCase));
  274. }
  275. public void Dispose()
  276. {
  277. _config.NamedConfigurationUpdating -= _config_NamedConfigurationUpdating;
  278. }
  279. }
  280. }