339 lines
14 KiB
C#
339 lines
14 KiB
C#
using MediaBrowser.Common.Configuration;
|
|
using MediaBrowser.Common.Extensions;
|
|
using MediaBrowser.Common.Net;
|
|
using MediaBrowser.Controller.Configuration;
|
|
using MediaBrowser.Controller.Providers;
|
|
using MediaBrowser.Controller.Security;
|
|
using MediaBrowser.Controller.Subtitles;
|
|
using MediaBrowser.Model.Dto;
|
|
using MediaBrowser.Model.Entities;
|
|
using MediaBrowser.Model.Logging;
|
|
using MediaBrowser.Model.Providers;
|
|
using MediaBrowser.Model.Serialization;
|
|
using OpenSubtitlesHandler;
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.Globalization;
|
|
using System.IO;
|
|
using System.Linq;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace MediaBrowser.Providers.Subtitles
|
|
{
|
|
public class OpenSubtitleDownloader : ISubtitleProvider, IDisposable
|
|
{
|
|
private readonly ILogger _logger;
|
|
private readonly IHttpClient _httpClient;
|
|
private readonly CultureInfo _usCulture = new CultureInfo("en-US");
|
|
|
|
private readonly IServerConfigurationManager _config;
|
|
private readonly IEncryptionManager _encryption;
|
|
|
|
private Timer _dailyTimer;
|
|
|
|
// This is limited to 200 per day
|
|
private int _dailyDownloadCount;
|
|
|
|
// It's 200 but this will be in-exact so buffer a little
|
|
// And the user may restart the server
|
|
private const int MaxDownloadsPerDay = 150;
|
|
|
|
private readonly IJsonSerializer _json;
|
|
|
|
public OpenSubtitleDownloader(ILogManager logManager, IHttpClient httpClient, IServerConfigurationManager config, IEncryptionManager encryption, IJsonSerializer json)
|
|
{
|
|
_logger = logManager.GetLogger(GetType().Name);
|
|
_httpClient = httpClient;
|
|
_config = config;
|
|
_encryption = encryption;
|
|
_json = json;
|
|
|
|
_config.NamedConfigurationUpdating += _config_NamedConfigurationUpdating;
|
|
|
|
// Reset the count every 24 hours
|
|
_dailyTimer = new Timer(state => _dailyDownloadCount = 0, null, TimeSpan.FromHours(24), TimeSpan.FromHours(24));
|
|
|
|
Utilities.HttpClient = httpClient;
|
|
OpenSubtitles.SetUserAgent("mediabrowser.tv");
|
|
}
|
|
|
|
private const string PasswordHashPrefix = "h:";
|
|
void _config_NamedConfigurationUpdating(object sender, ConfigurationUpdateEventArgs e)
|
|
{
|
|
if (!string.Equals(e.Key, "subtitles", StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
return;
|
|
}
|
|
|
|
var options = (SubtitleOptions)e.NewConfiguration;
|
|
|
|
if (options != null &&
|
|
!string.IsNullOrWhiteSpace(options.OpenSubtitlesPasswordHash) &&
|
|
!options.OpenSubtitlesPasswordHash.StartsWith(PasswordHashPrefix, StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
options.OpenSubtitlesPasswordHash = EncryptPassword(options.OpenSubtitlesPasswordHash);
|
|
}
|
|
}
|
|
|
|
private string EncryptPassword(string password)
|
|
{
|
|
return PasswordHashPrefix + _encryption.EncryptString(password);
|
|
}
|
|
|
|
private string DecryptPassword(string password)
|
|
{
|
|
if (password == null ||
|
|
!password.StartsWith(PasswordHashPrefix, StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
return string.Empty;
|
|
}
|
|
|
|
return _encryption.DecryptString(password.Substring(2));
|
|
}
|
|
|
|
public string Name
|
|
{
|
|
get { return "Open Subtitles"; }
|
|
}
|
|
|
|
private SubtitleOptions GetOptions()
|
|
{
|
|
return _config.GetSubtitleConfiguration();
|
|
}
|
|
|
|
public IEnumerable<VideoContentType> SupportedMediaTypes
|
|
{
|
|
get
|
|
{
|
|
var options = GetOptions();
|
|
|
|
if (string.IsNullOrWhiteSpace(options.OpenSubtitlesUsername) ||
|
|
string.IsNullOrWhiteSpace(options.OpenSubtitlesPasswordHash))
|
|
{
|
|
return new VideoContentType[] { };
|
|
}
|
|
|
|
return new[] { VideoContentType.Episode, VideoContentType.Movie };
|
|
}
|
|
}
|
|
|
|
public Task<SubtitleResponse> GetSubtitles(string id, CancellationToken cancellationToken)
|
|
{
|
|
return GetSubtitlesInternal(id, GetOptions(), cancellationToken);
|
|
}
|
|
|
|
private async Task<SubtitleResponse> GetSubtitlesInternal(string id,
|
|
SubtitleOptions options,
|
|
CancellationToken cancellationToken)
|
|
{
|
|
if (string.IsNullOrWhiteSpace(id))
|
|
{
|
|
throw new ArgumentNullException("id");
|
|
}
|
|
|
|
if (_dailyDownloadCount >= MaxDownloadsPerDay &&
|
|
!options.IsOpenSubtitleVipAccount)
|
|
{
|
|
throw new InvalidOperationException("Open Subtitle's daily download limit has been exceeded. Please try again tomorrow.");
|
|
}
|
|
|
|
var idParts = id.Split(new[] { '-' }, 3);
|
|
|
|
var format = idParts[0];
|
|
var language = idParts[1];
|
|
var ossId = idParts[2];
|
|
|
|
var downloadsList = new[] { int.Parse(ossId, _usCulture) };
|
|
|
|
await Login(cancellationToken).ConfigureAwait(false);
|
|
|
|
var resultDownLoad = await OpenSubtitles.DownloadSubtitlesAsync(downloadsList, cancellationToken).ConfigureAwait(false);
|
|
|
|
if (!(resultDownLoad is MethodResponseSubtitleDownload))
|
|
{
|
|
throw new ApplicationException("Invalid response type");
|
|
}
|
|
|
|
var results = ((MethodResponseSubtitleDownload)resultDownLoad).Results;
|
|
|
|
if (results.Count == 0)
|
|
{
|
|
var msg = string.Format("Subtitle with Id {0} was not found. Name: {1}. Status: {2}. Message: {3}",
|
|
ossId,
|
|
resultDownLoad.Name ?? string.Empty,
|
|
resultDownLoad.Message ?? string.Empty,
|
|
resultDownLoad.Status ?? string.Empty);
|
|
|
|
throw new ResourceNotFoundException(msg);
|
|
}
|
|
|
|
var data = Convert.FromBase64String(results.First().Data);
|
|
|
|
return new SubtitleResponse
|
|
{
|
|
Format = format,
|
|
Language = language,
|
|
|
|
Stream = new MemoryStream(Utilities.Decompress(new MemoryStream(data)))
|
|
};
|
|
}
|
|
|
|
private DateTime _lastLogin;
|
|
private async Task Login(CancellationToken cancellationToken)
|
|
{
|
|
if ((DateTime.UtcNow - _lastLogin).TotalSeconds < 60)
|
|
{
|
|
return;
|
|
}
|
|
|
|
var options = GetOptions();
|
|
|
|
var user = options.OpenSubtitlesUsername ?? string.Empty;
|
|
var password = DecryptPassword(options.OpenSubtitlesPasswordHash);
|
|
|
|
var loginResponse = await OpenSubtitles.LogInAsync(user, password, "en", cancellationToken).ConfigureAwait(false);
|
|
|
|
if (!(loginResponse is MethodResponseLogIn))
|
|
{
|
|
throw new UnauthorizedAccessException("Authentication to OpenSubtitles failed.");
|
|
}
|
|
|
|
_lastLogin = DateTime.UtcNow;
|
|
}
|
|
|
|
public async Task<IEnumerable<NameIdPair>> GetSupportedLanguages(CancellationToken cancellationToken)
|
|
{
|
|
await Login(cancellationToken).ConfigureAwait(false);
|
|
|
|
var result = OpenSubtitles.GetSubLanguages("en");
|
|
if (!(result is MethodResponseGetSubLanguages))
|
|
{
|
|
_logger.Error("Invalid response type");
|
|
return new List<NameIdPair>();
|
|
}
|
|
|
|
var results = ((MethodResponseGetSubLanguages)result).Languages;
|
|
|
|
return results.Select(i => new NameIdPair
|
|
{
|
|
Name = i.LanguageName,
|
|
Id = i.SubLanguageID
|
|
});
|
|
}
|
|
|
|
public async Task<IEnumerable<RemoteSubtitleInfo>> Search(SubtitleSearchRequest request, CancellationToken cancellationToken)
|
|
{
|
|
var imdbIdText = request.GetProviderId(MetadataProviders.Imdb);
|
|
long imdbId = 0;
|
|
|
|
switch (request.ContentType)
|
|
{
|
|
case VideoContentType.Episode:
|
|
if (!request.IndexNumber.HasValue || !request.ParentIndexNumber.HasValue || string.IsNullOrEmpty(request.SeriesName))
|
|
{
|
|
_logger.Debug("Episode information missing");
|
|
return new List<RemoteSubtitleInfo>();
|
|
}
|
|
break;
|
|
case VideoContentType.Movie:
|
|
if (string.IsNullOrEmpty(request.Name))
|
|
{
|
|
_logger.Debug("Movie name missing");
|
|
return new List<RemoteSubtitleInfo>();
|
|
}
|
|
if (string.IsNullOrWhiteSpace(imdbIdText) || !long.TryParse(imdbIdText.TrimStart('t'), NumberStyles.Any, _usCulture, out imdbId))
|
|
{
|
|
_logger.Debug("Imdb id missing");
|
|
return new List<RemoteSubtitleInfo>();
|
|
}
|
|
break;
|
|
}
|
|
|
|
if (string.IsNullOrEmpty(request.MediaPath))
|
|
{
|
|
_logger.Debug("Path Missing");
|
|
return new List<RemoteSubtitleInfo>();
|
|
}
|
|
|
|
await Login(cancellationToken).ConfigureAwait(false);
|
|
|
|
var subLanguageId = request.Language;
|
|
var hash = Utilities.ComputeHash(request.MediaPath);
|
|
var fileInfo = new FileInfo(request.MediaPath);
|
|
var movieByteSize = fileInfo.Length;
|
|
var searchImdbId = request.ContentType == VideoContentType.Movie ? imdbId.ToString(_usCulture) : "";
|
|
var subtitleSearchParameters = request.ContentType == VideoContentType.Episode
|
|
? new List<SubtitleSearchParameters> {
|
|
new SubtitleSearchParameters(subLanguageId,
|
|
query: request.SeriesName,
|
|
season: request.ParentIndexNumber.Value.ToString(_usCulture),
|
|
episode: request.IndexNumber.Value.ToString(_usCulture))
|
|
}
|
|
: new List<SubtitleSearchParameters> {
|
|
new SubtitleSearchParameters(subLanguageId, imdbid: searchImdbId),
|
|
new SubtitleSearchParameters(subLanguageId, query: request.Name, imdbid: searchImdbId)
|
|
};
|
|
var parms = new List<SubtitleSearchParameters> {
|
|
new SubtitleSearchParameters( subLanguageId,
|
|
movieHash: hash,
|
|
movieByteSize: movieByteSize,
|
|
imdbid: searchImdbId ),
|
|
};
|
|
parms.AddRange(subtitleSearchParameters);
|
|
var result = await OpenSubtitles.SearchSubtitlesAsync(parms.ToArray(), cancellationToken).ConfigureAwait(false);
|
|
if (!(result is MethodResponseSubtitleSearch))
|
|
{
|
|
_logger.Error("Invalid response type");
|
|
return new List<RemoteSubtitleInfo>();
|
|
}
|
|
|
|
Predicate<SubtitleSearchResult> mediaFilter =
|
|
x =>
|
|
request.ContentType == VideoContentType.Episode
|
|
? !string.IsNullOrEmpty(x.SeriesSeason) && !string.IsNullOrEmpty(x.SeriesEpisode) &&
|
|
int.Parse(x.SeriesSeason, _usCulture) == request.ParentIndexNumber &&
|
|
int.Parse(x.SeriesEpisode, _usCulture) == request.IndexNumber
|
|
: !string.IsNullOrEmpty(x.IDMovieImdb) && long.Parse(x.IDMovieImdb, _usCulture) == imdbId;
|
|
|
|
var results = ((MethodResponseSubtitleSearch)result).Results;
|
|
|
|
// Avoid implicitly captured closure
|
|
var hasCopy = hash;
|
|
|
|
return results.Where(x => x.SubBad == "0" && mediaFilter(x))
|
|
.OrderBy(x => (x.MovieHash == hash ? 0 : 1))
|
|
.ThenBy(x => Math.Abs(long.Parse(x.MovieByteSize, _usCulture) - movieByteSize))
|
|
.ThenByDescending(x => int.Parse(x.SubDownloadsCnt, _usCulture))
|
|
.ThenByDescending(x => double.Parse(x.SubRating, _usCulture))
|
|
.Select(i => new RemoteSubtitleInfo
|
|
{
|
|
Author = i.UserNickName,
|
|
Comment = i.SubAuthorComment,
|
|
CommunityRating = float.Parse(i.SubRating, _usCulture),
|
|
DownloadCount = int.Parse(i.SubDownloadsCnt, _usCulture),
|
|
Format = i.SubFormat,
|
|
ProviderName = Name,
|
|
ThreeLetterISOLanguageName = i.SubLanguageID,
|
|
|
|
Id = i.SubFormat + "-" + i.SubLanguageID + "-" + i.IDSubtitleFile,
|
|
|
|
Name = i.SubFileName,
|
|
DateCreated = DateTime.Parse(i.SubAddDate, _usCulture),
|
|
IsHashMatch = i.MovieHash == hasCopy
|
|
});
|
|
}
|
|
|
|
public void Dispose()
|
|
{
|
|
_config.NamedConfigurationUpdating -= _config_NamedConfigurationUpdating;
|
|
|
|
if (_dailyTimer != null)
|
|
{
|
|
_dailyTimer.Dispose();
|
|
_dailyTimer = null;
|
|
}
|
|
}
|
|
}
|
|
}
|