528 lines
18 KiB
C#
528 lines
18 KiB
C#
using MediaBrowser.Model.IO;
|
|
using MediaBrowser.Common.Net;
|
|
using MediaBrowser.Controller.Configuration;
|
|
using MediaBrowser.Controller.Entities;
|
|
using MediaBrowser.Controller.Providers;
|
|
using MediaBrowser.Model.Entities;
|
|
using MediaBrowser.Model.Serialization;
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.Globalization;
|
|
using System.IO;
|
|
using System.Linq;
|
|
using System.Net;
|
|
using System.Text;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace MediaBrowser.Providers.Omdb
|
|
{
|
|
public class OmdbProvider
|
|
{
|
|
private readonly IJsonSerializer _jsonSerializer;
|
|
private readonly IFileSystem _fileSystem;
|
|
private readonly IServerConfigurationManager _configurationManager;
|
|
private readonly IHttpClient _httpClient;
|
|
private readonly CultureInfo _usCulture = new CultureInfo("en-US");
|
|
|
|
public OmdbProvider(IJsonSerializer jsonSerializer, IHttpClient httpClient, IFileSystem fileSystem, IServerConfigurationManager configurationManager)
|
|
{
|
|
_jsonSerializer = jsonSerializer;
|
|
_httpClient = httpClient;
|
|
_fileSystem = fileSystem;
|
|
_configurationManager = configurationManager;
|
|
}
|
|
|
|
public async Task Fetch<T>(MetadataResult<T> itemResult, string imdbId, string language, string country, CancellationToken cancellationToken)
|
|
where T : BaseItem
|
|
{
|
|
if (string.IsNullOrWhiteSpace(imdbId))
|
|
{
|
|
throw new ArgumentNullException("imdbId");
|
|
}
|
|
|
|
T item = itemResult.Item;
|
|
|
|
var result = await GetRootObject(imdbId, cancellationToken).ConfigureAwait(false);
|
|
|
|
// Only take the name and rating if the user's language is set to english, since Omdb has no localization
|
|
if (string.Equals(language, "en", StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
item.Name = result.Title;
|
|
|
|
if (string.Equals(country, "us", StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
item.OfficialRating = result.Rated;
|
|
}
|
|
}
|
|
|
|
int year;
|
|
|
|
if (!string.IsNullOrEmpty(result.Year) && result.Year.Length >= 4
|
|
&& int.TryParse(result.Year.Substring(0, 4), NumberStyles.Number, _usCulture, out year)
|
|
&& year >= 0)
|
|
{
|
|
item.ProductionYear = year;
|
|
}
|
|
|
|
var tomatoScore = result.GetRottenTomatoScore();
|
|
|
|
if (tomatoScore.HasValue)
|
|
{
|
|
item.CriticRating = tomatoScore;
|
|
}
|
|
|
|
int voteCount;
|
|
|
|
if (!string.IsNullOrEmpty(result.imdbVotes)
|
|
&& int.TryParse(result.imdbVotes, NumberStyles.Number, _usCulture, out voteCount)
|
|
&& voteCount >= 0)
|
|
{
|
|
item.VoteCount = voteCount;
|
|
}
|
|
|
|
float imdbRating;
|
|
|
|
if (!string.IsNullOrEmpty(result.imdbRating)
|
|
&& float.TryParse(result.imdbRating, NumberStyles.Any, _usCulture, out imdbRating)
|
|
&& imdbRating >= 0)
|
|
{
|
|
item.CommunityRating = imdbRating;
|
|
}
|
|
|
|
if (!string.IsNullOrEmpty(result.Website))
|
|
{
|
|
item.HomePageUrl = result.Website;
|
|
}
|
|
|
|
if (!string.IsNullOrWhiteSpace(result.imdbID))
|
|
{
|
|
item.SetProviderId(MetadataProviders.Imdb, result.imdbID);
|
|
}
|
|
|
|
ParseAdditionalMetadata(itemResult, result);
|
|
}
|
|
|
|
public async Task<bool> FetchEpisodeData<T>(MetadataResult<T> itemResult, int episodeNumber, int seasonNumber, string episodeImdbId, string seriesImdbId, string language, string country, CancellationToken cancellationToken)
|
|
where T : BaseItem
|
|
{
|
|
if (string.IsNullOrWhiteSpace(seriesImdbId))
|
|
{
|
|
throw new ArgumentNullException("seriesImdbId");
|
|
}
|
|
|
|
T item = itemResult.Item;
|
|
|
|
var seasonResult = await GetSeasonRootObject(seriesImdbId, seasonNumber, cancellationToken).ConfigureAwait(false);
|
|
|
|
if (seasonResult == null)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
RootObject result = null;
|
|
|
|
if (!string.IsNullOrWhiteSpace(episodeImdbId))
|
|
{
|
|
foreach (var episode in (seasonResult.Episodes ?? new RootObject[] { }))
|
|
{
|
|
if (string.Equals(episodeImdbId, episode.imdbID, StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
result = episode;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
// finally, search by numbers
|
|
if (result == null)
|
|
{
|
|
foreach (var episode in (seasonResult.Episodes ?? new RootObject[] { }))
|
|
{
|
|
if (episode.Episode == episodeNumber)
|
|
{
|
|
result = episode;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (result == null)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
// Only take the name and rating if the user's language is set to english, since Omdb has no localization
|
|
if (string.Equals(language, "en", StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
item.Name = result.Title;
|
|
|
|
if (string.Equals(country, "us", StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
item.OfficialRating = result.Rated;
|
|
}
|
|
}
|
|
|
|
int year;
|
|
|
|
if (!string.IsNullOrEmpty(result.Year) && result.Year.Length >= 4
|
|
&& int.TryParse(result.Year.Substring(0, 4), NumberStyles.Number, _usCulture, out year)
|
|
&& year >= 0)
|
|
{
|
|
item.ProductionYear = year;
|
|
}
|
|
|
|
var tomatoScore = result.GetRottenTomatoScore();
|
|
|
|
if (tomatoScore.HasValue)
|
|
{
|
|
item.CriticRating = tomatoScore;
|
|
}
|
|
|
|
int voteCount;
|
|
|
|
if (!string.IsNullOrEmpty(result.imdbVotes)
|
|
&& int.TryParse(result.imdbVotes, NumberStyles.Number, _usCulture, out voteCount)
|
|
&& voteCount >= 0)
|
|
{
|
|
item.VoteCount = voteCount;
|
|
}
|
|
|
|
float imdbRating;
|
|
|
|
if (!string.IsNullOrEmpty(result.imdbRating)
|
|
&& float.TryParse(result.imdbRating, NumberStyles.Any, _usCulture, out imdbRating)
|
|
&& imdbRating >= 0)
|
|
{
|
|
item.CommunityRating = imdbRating;
|
|
}
|
|
|
|
if (!string.IsNullOrEmpty(result.Website))
|
|
{
|
|
item.HomePageUrl = result.Website;
|
|
}
|
|
|
|
if (!string.IsNullOrWhiteSpace(result.imdbID))
|
|
{
|
|
item.SetProviderId(MetadataProviders.Imdb, result.imdbID);
|
|
}
|
|
|
|
ParseAdditionalMetadata(itemResult, result);
|
|
|
|
return true;
|
|
}
|
|
|
|
internal async Task<RootObject> GetRootObject(string imdbId, CancellationToken cancellationToken)
|
|
{
|
|
var path = await EnsureItemInfo(imdbId, cancellationToken).ConfigureAwait(false);
|
|
|
|
string resultString;
|
|
|
|
using (Stream stream = _fileSystem.GetFileStream(path, FileOpenMode.Open, FileAccessMode.Read, FileShareMode.Read))
|
|
{
|
|
using (var reader = new StreamReader(stream, new UTF8Encoding(false)))
|
|
{
|
|
resultString = reader.ReadToEnd();
|
|
resultString = resultString.Replace("\"N/A\"", "\"\"");
|
|
}
|
|
}
|
|
|
|
var result = _jsonSerializer.DeserializeFromString<RootObject>(resultString);
|
|
return result;
|
|
}
|
|
|
|
internal async Task<SeasonRootObject> GetSeasonRootObject(string imdbId, int seasonId, CancellationToken cancellationToken)
|
|
{
|
|
var path = await EnsureSeasonInfo(imdbId, seasonId, cancellationToken).ConfigureAwait(false);
|
|
|
|
string resultString;
|
|
|
|
using (Stream stream = _fileSystem.GetFileStream(path, FileOpenMode.Open, FileAccessMode.Read, FileShareMode.Read))
|
|
{
|
|
using (var reader = new StreamReader(stream, new UTF8Encoding(false)))
|
|
{
|
|
resultString = reader.ReadToEnd();
|
|
resultString = resultString.Replace("\"N/A\"", "\"\"");
|
|
}
|
|
}
|
|
|
|
var result = _jsonSerializer.DeserializeFromString<SeasonRootObject>(resultString);
|
|
return result;
|
|
}
|
|
|
|
internal static bool IsValidSeries(Dictionary<string, string> seriesProviderIds)
|
|
{
|
|
string id;
|
|
if (seriesProviderIds.TryGetValue(MetadataProviders.Imdb.ToString(), out id) && !string.IsNullOrEmpty(id))
|
|
{
|
|
// This check should ideally never be necessary but we're seeing some cases of this and haven't tracked them down yet.
|
|
if (!string.IsNullOrWhiteSpace(id))
|
|
{
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
public static string GetOmdbUrl(string query, CancellationToken cancellationToken)
|
|
{
|
|
var url = "https://www.omdbapi.com?apikey=fe53f97e";
|
|
|
|
if (!string.IsNullOrWhiteSpace(query))
|
|
{
|
|
url += "&" + query;
|
|
}
|
|
|
|
return url;
|
|
}
|
|
|
|
private async Task<string> EnsureItemInfo(string imdbId, CancellationToken cancellationToken)
|
|
{
|
|
if (string.IsNullOrWhiteSpace(imdbId))
|
|
{
|
|
throw new ArgumentNullException("imdbId");
|
|
}
|
|
|
|
var imdbParam = imdbId.StartsWith("tt", StringComparison.OrdinalIgnoreCase) ? imdbId : "tt" + imdbId;
|
|
|
|
var path = GetDataFilePath(imdbParam);
|
|
|
|
var fileInfo = _fileSystem.GetFileSystemInfo(path);
|
|
|
|
if (fileInfo.Exists)
|
|
{
|
|
// If it's recent or automatic updates are enabled, don't re-download
|
|
if ((DateTime.UtcNow - _fileSystem.GetLastWriteTimeUtc(fileInfo)).TotalDays <= 3)
|
|
{
|
|
return path;
|
|
}
|
|
}
|
|
|
|
var url = GetOmdbUrl(string.Format("i={0}&plot=full&tomatoes=true&r=json", imdbParam), cancellationToken);
|
|
|
|
using (var stream = await GetOmdbResponse(_httpClient, url, cancellationToken).ConfigureAwait(false))
|
|
{
|
|
var rootObject = _jsonSerializer.DeserializeFromStream<RootObject>(stream);
|
|
_fileSystem.CreateDirectory(_fileSystem.GetDirectoryName(path));
|
|
_jsonSerializer.SerializeToFile(rootObject, path);
|
|
}
|
|
|
|
return path;
|
|
}
|
|
|
|
private async Task<string> EnsureSeasonInfo(string seriesImdbId, int seasonId, CancellationToken cancellationToken)
|
|
{
|
|
if (string.IsNullOrWhiteSpace(seriesImdbId))
|
|
{
|
|
throw new ArgumentNullException("imdbId");
|
|
}
|
|
|
|
var imdbParam = seriesImdbId.StartsWith("tt", StringComparison.OrdinalIgnoreCase) ? seriesImdbId : "tt" + seriesImdbId;
|
|
|
|
var path = GetSeasonFilePath(imdbParam, seasonId);
|
|
|
|
var fileInfo = _fileSystem.GetFileSystemInfo(path);
|
|
|
|
if (fileInfo.Exists)
|
|
{
|
|
// If it's recent or automatic updates are enabled, don't re-download
|
|
if ((DateTime.UtcNow - _fileSystem.GetLastWriteTimeUtc(fileInfo)).TotalDays <= 3)
|
|
{
|
|
return path;
|
|
}
|
|
}
|
|
|
|
var url = GetOmdbUrl(string.Format("i={0}&season={1}&detail=full", imdbParam, seasonId), cancellationToken);
|
|
|
|
using (var stream = await GetOmdbResponse(_httpClient, url, cancellationToken).ConfigureAwait(false))
|
|
{
|
|
var rootObject = _jsonSerializer.DeserializeFromStream<SeasonRootObject>(stream);
|
|
_fileSystem.CreateDirectory(_fileSystem.GetDirectoryName(path));
|
|
_jsonSerializer.SerializeToFile(rootObject, path);
|
|
}
|
|
|
|
return path;
|
|
}
|
|
|
|
public static Task<Stream> GetOmdbResponse(IHttpClient httpClient, string url, CancellationToken cancellationToken)
|
|
{
|
|
return httpClient.Get(new HttpRequestOptions
|
|
{
|
|
Url = url,
|
|
CancellationToken = cancellationToken,
|
|
BufferContent = true,
|
|
EnableDefaultUserAgent = true
|
|
});
|
|
}
|
|
|
|
internal string GetDataFilePath(string imdbId)
|
|
{
|
|
if (string.IsNullOrEmpty(imdbId))
|
|
{
|
|
throw new ArgumentNullException("imdbId");
|
|
}
|
|
|
|
var dataPath = Path.Combine(_configurationManager.ApplicationPaths.CachePath, "omdb");
|
|
|
|
var filename = string.Format("{0}.json", imdbId);
|
|
|
|
return Path.Combine(dataPath, filename);
|
|
}
|
|
|
|
internal string GetSeasonFilePath(string imdbId, int seasonId)
|
|
{
|
|
if (string.IsNullOrEmpty(imdbId))
|
|
{
|
|
throw new ArgumentNullException("imdbId");
|
|
}
|
|
|
|
var dataPath = Path.Combine(_configurationManager.ApplicationPaths.CachePath, "omdb");
|
|
|
|
var filename = string.Format("{0}_season_{1}.json", imdbId, seasonId);
|
|
|
|
return Path.Combine(dataPath, filename);
|
|
}
|
|
|
|
private void ParseAdditionalMetadata<T>(MetadataResult<T> itemResult, RootObject result)
|
|
where T : BaseItem
|
|
{
|
|
T item = itemResult.Item;
|
|
|
|
var isConfiguredForEnglish = IsConfiguredForEnglish(item);
|
|
|
|
// Grab series genres because imdb data is better than tvdb. Leave movies alone
|
|
// But only do it if english is the preferred language because this data will not be localized
|
|
if (isConfiguredForEnglish && !string.IsNullOrWhiteSpace(result.Genre))
|
|
{
|
|
item.Genres.Clear();
|
|
|
|
foreach (var genre in result.Genre
|
|
.Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries)
|
|
.Select(i => i.Trim())
|
|
.Where(i => !string.IsNullOrWhiteSpace(i)))
|
|
{
|
|
item.AddGenre(genre);
|
|
}
|
|
}
|
|
|
|
if (isConfiguredForEnglish)
|
|
{
|
|
// Omdb is currently english only, so for other languages skip this and let secondary providers fill it in
|
|
item.Overview = result.Plot;
|
|
}
|
|
|
|
//if (!string.IsNullOrWhiteSpace(result.Director))
|
|
//{
|
|
// var person = new PersonInfo
|
|
// {
|
|
// Name = result.Director.Trim(),
|
|
// Type = PersonType.Director
|
|
// };
|
|
|
|
// itemResult.AddPerson(person);
|
|
//}
|
|
|
|
//if (!string.IsNullOrWhiteSpace(result.Writer))
|
|
//{
|
|
// var person = new PersonInfo
|
|
// {
|
|
// Name = result.Director.Trim(),
|
|
// Type = PersonType.Writer
|
|
// };
|
|
|
|
// itemResult.AddPerson(person);
|
|
//}
|
|
|
|
//if (!string.IsNullOrWhiteSpace(result.Actors))
|
|
//{
|
|
// var actorList = result.Actors.Split(',');
|
|
// foreach (var actor in actorList)
|
|
// {
|
|
// if (!string.IsNullOrWhiteSpace(actor))
|
|
// {
|
|
// var person = new PersonInfo
|
|
// {
|
|
// Name = actor.Trim(),
|
|
// Type = PersonType.Actor
|
|
// };
|
|
|
|
// itemResult.AddPerson(person);
|
|
// }
|
|
// }
|
|
//}
|
|
}
|
|
|
|
private bool IsConfiguredForEnglish(BaseItem item)
|
|
{
|
|
var lang = item.GetPreferredMetadataLanguage();
|
|
|
|
// The data isn't localized and so can only be used for english users
|
|
return string.Equals(lang, "en", StringComparison.OrdinalIgnoreCase);
|
|
}
|
|
|
|
internal class SeasonRootObject
|
|
{
|
|
public string Title { get; set; }
|
|
public string seriesID { get; set; }
|
|
public int Season { get; set; }
|
|
public int? totalSeasons { get; set; }
|
|
public RootObject[] Episodes { get; set; }
|
|
public string Response { get; set; }
|
|
}
|
|
|
|
internal class RootObject
|
|
{
|
|
public string Title { get; set; }
|
|
public string Year { get; set; }
|
|
public string Rated { get; set; }
|
|
public string Released { get; set; }
|
|
public string Runtime { get; set; }
|
|
public string Genre { get; set; }
|
|
public string Director { get; set; }
|
|
public string Writer { get; set; }
|
|
public string Actors { get; set; }
|
|
public string Plot { get; set; }
|
|
public string Language { get; set; }
|
|
public string Country { get; set; }
|
|
public string Awards { get; set; }
|
|
public string Poster { get; set; }
|
|
public List<OmdbRating> Ratings { get; set; }
|
|
public string Metascore { get; set; }
|
|
public string imdbRating { get; set; }
|
|
public string imdbVotes { get; set; }
|
|
public string imdbID { get; set; }
|
|
public string Type { get; set; }
|
|
public string DVD { get; set; }
|
|
public string BoxOffice { get; set; }
|
|
public string Production { get; set; }
|
|
public string Website { get; set; }
|
|
public string Response { get; set; }
|
|
public int Episode { get; set; }
|
|
|
|
public float? GetRottenTomatoScore()
|
|
{
|
|
if (Ratings != null)
|
|
{
|
|
var rating = Ratings.FirstOrDefault(i => string.Equals(i.Source, "Rotten Tomatoes", StringComparison.OrdinalIgnoreCase));
|
|
if (rating != null && rating.Value != null)
|
|
{
|
|
var value = rating.Value.TrimEnd('%');
|
|
float score;
|
|
if (float.TryParse(value, NumberStyles.Any, CultureInfo.InvariantCulture, out score))
|
|
{
|
|
return score;
|
|
}
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
}
|
|
public class OmdbRating
|
|
{
|
|
public string Source { get; set; }
|
|
public string Value { get; set; }
|
|
}
|
|
}
|
|
}
|