use open movie database for critic scores

This commit is contained in:
Luke Pulverenti 2013-05-07 00:34:27 -04:00
parent ba905fecd8
commit 256bda66f2
3 changed files with 147 additions and 102 deletions

View File

@ -116,8 +116,8 @@
<Compile Include="Providers\IProviderManager.cs" /> <Compile Include="Providers\IProviderManager.cs" />
<Compile Include="Providers\MediaInfo\MediaEncoderHelpers.cs" /> <Compile Include="Providers\MediaInfo\MediaEncoderHelpers.cs" />
<Compile Include="Providers\MetadataProviderPriority.cs" /> <Compile Include="Providers\MetadataProviderPriority.cs" />
<Compile Include="Providers\Movies\OpenMovieDatabaseProvider.cs" />
<Compile Include="Providers\Movies\RottenTomatoesMovieProvider.cs" /> <Compile Include="Providers\Movies\RottenTomatoesMovieProvider.cs" />
<Compile Include="Providers\Movies\RottenTomatoesMovieReviewsProvider.cs" />
<Compile Include="Providers\Music\FanArtArtistByNameProvider.cs" /> <Compile Include="Providers\Music\FanArtArtistByNameProvider.cs" />
<Compile Include="Providers\Music\LastfmAlbumProvider.cs" /> <Compile Include="Providers\Music\LastfmAlbumProvider.cs" />
<Compile Include="Providers\Music\FanArtAlbumProvider.cs" /> <Compile Include="Providers\Music\FanArtAlbumProvider.cs" />

View File

@ -7,21 +7,15 @@ using MediaBrowser.Model.Entities;
using MediaBrowser.Model.Logging; using MediaBrowser.Model.Logging;
using MediaBrowser.Model.Serialization; using MediaBrowser.Model.Serialization;
using System; using System;
using System.Collections.Generic; using System.Globalization;
using System.Linq;
using System.Threading; using System.Threading;
using System.Threading.Tasks; using System.Threading.Tasks;
namespace MediaBrowser.Controller.Providers.Movies namespace MediaBrowser.Controller.Providers.Movies
{ {
/// <summary> public class OpenMovieDatabaseProvider : BaseMetadataProvider
/// Class RottenTomatoesMovieProvider
/// </summary>
public class RottenTomatoesMovieReviewsProvider : BaseMetadataProvider
{ {
// http://developer.rottentomatoes.com/iodocs private readonly SemaphoreSlim _resourcePool = new SemaphoreSlim(1, 1);
private const string MoviesReviews = @"movies/{1}/reviews.json?review_type=top_critic&page_limit=10&page=1&country=us&apikey={0}";
/// <summary> /// <summary>
/// Gets the json serializer. /// Gets the json serializer.
@ -35,14 +29,7 @@ namespace MediaBrowser.Controller.Providers.Movies
/// <value>The HTTP client.</value> /// <value>The HTTP client.</value>
protected IHttpClient HttpClient { get; private set; } protected IHttpClient HttpClient { get; private set; }
/// <summary> public OpenMovieDatabaseProvider(ILogManager logManager, IServerConfigurationManager configurationManager, IJsonSerializer jsonSerializer, IHttpClient httpClient)
/// Initializes a new instance of the <see cref="RottenTomatoesMovieProvider"/> class.
/// </summary>
/// <param name="logManager">The log manager.</param>
/// <param name="configurationManager">The configuration manager.</param>
/// <param name="jsonSerializer">The json serializer.</param>
/// <param name="httpClient">The HTTP client.</param>
public RottenTomatoesMovieReviewsProvider(ILogManager logManager, IServerConfigurationManager configurationManager, IJsonSerializer jsonSerializer, IHttpClient httpClient)
: base(logManager, configurationManager) : base(logManager, configurationManager)
{ {
JsonSerializer = jsonSerializer; JsonSerializer = jsonSerializer;
@ -57,7 +44,7 @@ namespace MediaBrowser.Controller.Providers.Movies
{ {
get get
{ {
return "5"; return "6";
} }
} }
@ -92,15 +79,14 @@ namespace MediaBrowser.Controller.Providers.Movies
/// <returns><c>true</c> if XXXX, <c>false</c> otherwise</returns> /// <returns><c>true</c> if XXXX, <c>false</c> otherwise</returns>
public override bool Supports(BaseItem item) public override bool Supports(BaseItem item)
{ {
return false;
var trailer = item as Trailer; var trailer = item as Trailer;
// Don't support local trailers
if (trailer != null) if (trailer != null)
{ {
return !trailer.IsLocalTrailer; return !trailer.IsLocalTrailer;
} }
// Don't support local trailers
return item is Movie; return item is Movie;
} }
@ -136,7 +122,7 @@ namespace MediaBrowser.Controller.Providers.Movies
protected override bool NeedsRefreshInternal(BaseItem item, BaseProviderInfo providerInfo) protected override bool NeedsRefreshInternal(BaseItem item, BaseProviderInfo providerInfo)
{ {
// Refresh if rt id has changed // Refresh if rt id has changed
if (providerInfo.Data != GetComparisonData(item.GetProviderId(MetadataProviders.RottenTomatoes))) if (providerInfo.Data != GetComparisonData(item.GetProviderId(MetadataProviders.Imdb)))
{ {
return true; return true;
} }
@ -144,13 +130,8 @@ namespace MediaBrowser.Controller.Providers.Movies
return base.NeedsRefreshInternal(item, providerInfo); return base.NeedsRefreshInternal(item, providerInfo);
} }
/// <summary> protected readonly CultureInfo UsCulture = new CultureInfo("en-US");
/// Fetches metadata and returns true or false indicating if any work that requires persistence was done
/// </summary>
/// <param name="item">The item.</param>
/// <param name="force">if set to <c>true</c> [force].</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{System.Boolean}.</returns>
public override async Task<bool> FetchAsync(BaseItem item, bool force, CancellationToken cancellationToken) public override async Task<bool> FetchAsync(BaseItem item, bool force, CancellationToken cancellationToken)
{ {
BaseProviderInfo data; BaseProviderInfo data;
@ -161,76 +142,85 @@ namespace MediaBrowser.Controller.Providers.Movies
item.ProviderData[Id] = data; item.ProviderData[Id] = data;
} }
var rottenTomatoesId = item.GetProviderId(MetadataProviders.RottenTomatoes); var imdbId = item.GetProviderId(MetadataProviders.Imdb);
if (string.IsNullOrEmpty(imdbId))
if (string.IsNullOrEmpty(rottenTomatoesId))
{ {
data.Data = GetComparisonData(rottenTomatoesId); data.Data = GetComparisonData(imdbId);
data.LastRefreshStatus = ProviderRefreshStatus.Success; data.LastRefreshStatus = ProviderRefreshStatus.Success;
return true; return true;
} }
var imdbParam = imdbId.StartsWith("tt", StringComparison.OrdinalIgnoreCase) ? imdbId : "tt" + imdbId;
var url = string.Format("http://www.omdbapi.com/?i={0}&tomatoes=true", imdbParam);
using (var stream = await HttpClient.Get(new HttpRequestOptions using (var stream = await HttpClient.Get(new HttpRequestOptions
{ {
Url = GetMovieReviewsUrl(rottenTomatoesId), Url = url,
ResourcePool = RottenTomatoesMovieProvider.Current.RottenTomatoesResourcePool, ResourcePool = _resourcePool,
CancellationToken = cancellationToken, CancellationToken = cancellationToken,
EnableResponseCache = true EnableResponseCache = true
}).ConfigureAwait(false)) }).ConfigureAwait(false))
{ {
var result = JsonSerializer.DeserializeFromStream<RootObject>(stream);
var result = JsonSerializer.DeserializeFromStream<RTReviewList>(stream); int tomatoMeter;
item.CriticReviews = result.reviews.Select(rtReview => new ItemReview if (!string.IsNullOrEmpty(result.tomatoMeter) && int.TryParse(result.tomatoMeter, NumberStyles.Integer, UsCulture, out tomatoMeter))
{ {
ReviewerName = rtReview.critic, item.CriticRating = tomatoMeter;
Publisher = rtReview.publication, }
Date = DateTime.Parse(rtReview.date).ToUniversalTime(),
Caption = rtReview.quote,
Url = rtReview.links.review,
Likes = string.Equals(rtReview.freshness, "fresh", StringComparison.OrdinalIgnoreCase)
}).ToList(); if (!string.IsNullOrEmpty(result.tomatoConsensus)
&& !string.Equals(result.tomatoConsensus, "n/a", StringComparison.OrdinalIgnoreCase)
&& !string.Equals(result.tomatoConsensus, "No consensus yet.", StringComparison.OrdinalIgnoreCase))
{
item.CriticRatingSummary = result.tomatoConsensus;
}
} }
data.Data = GetComparisonData(rottenTomatoesId); data.Data = GetComparisonData(item.GetProviderId(MetadataProviders.Imdb));
data.LastRefreshStatus = ProviderRefreshStatus.Success; data.LastRefreshStatus = ProviderRefreshStatus.Success;
SetLastRefreshed(item, DateTime.UtcNow); SetLastRefreshed(item, DateTime.UtcNow);
return true; return true;
} }
// Utility functions to get the URL of the API calls
private string GetMovieReviewsUrl(string rtId) protected class RootObject
{ {
return RottenTomatoesMovieProvider.BasicUrl + string.Format(MoviesReviews, RottenTomatoesMovieProvider.ApiKey, rtId); public string Title { get; set; }
} public string Year { get; set; }
public string Rated { get; set; }
// Data contract classes for use with the Rotten Tomatoes API public string Released { get; set; }
public string Runtime { get; set; }
protected class RTReviewList public string Genre { get; set; }
{ public string Director { get; set; }
public int total { get; set; } public string Writer { get; set; }
public List<RTReview> reviews { get; set; } public string Actors { get; set; }
} public string Plot { get; set; }
public string Poster { get; set; }
protected class RTReview public string imdbRating { get; set; }
{ public string imdbVotes { get; set; }
public string critic { get; set; } public string imdbID { get; set; }
public string date { get; set; } public string Type { get; set; }
public string freshness { get; set; } public string tomatoMeter { get; set; }
public string publication { get; set; } public string tomatoImage { get; set; }
public string quote { get; set; } public string tomatoRating { get; set; }
public RTReviewLink links { get; set; } public string tomatoReviews { get; set; }
public string original_score { get; set; } public string tomatoFresh { get; set; }
} public string tomatoRotten { get; set; }
public string tomatoConsensus { get; set; }
protected class RTReviewLink public string tomatoUserMeter { get; set; }
{ public string tomatoUserRating { get; set; }
public string review { get; set; } public string tomatoUserReviews { 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; }
} }
} }
} }

View File

@ -17,23 +17,18 @@ namespace MediaBrowser.Controller.Providers.Movies
/// <summary> /// <summary>
/// Class RottenTomatoesMovieProvider /// Class RottenTomatoesMovieProvider
/// </summary> /// </summary>
public class RottenTomatoesMovieProvider : BaseMetadataProvider public class RottenTomatoesProvider : BaseMetadataProvider
{ {
// http://developer.rottentomatoes.com/iodocs // http://developer.rottentomatoes.com/iodocs
/// <summary>
/// The API key
/// </summary>
internal const string ApiKey = "x9wjnvv39ntjmt9zs95nm7bg";
internal const string BasicUrl = @"http://api.rottentomatoes.com/api/public/v1.0/"; private const string MoviesReviews = @"movies/{1}/reviews.json?review_type=top_critic&page_limit=10&page=1&country=us&apikey={0}";
private const string ApiKey = "x9wjnvv39ntjmt9zs95nm7bg";
private const string BasicUrl = @"http://api.rottentomatoes.com/api/public/v1.0/";
private const string MovieImdb = @"movie_alias.json?id={1}&type=imdb&apikey={0}"; private const string MovieImdb = @"movie_alias.json?id={1}&type=imdb&apikey={0}";
internal static RottenTomatoesMovieProvider Current { get; private set; } private readonly SemaphoreSlim _rottenTomatoesResourcePool = new SemaphoreSlim(1, 1);
/// <summary>
/// The _rotten tomatoes resource pool
/// </summary>
internal readonly SemaphoreSlim RottenTomatoesResourcePool = new SemaphoreSlim(1, 1);
/// <summary> /// <summary>
/// Gets the json serializer. /// Gets the json serializer.
@ -54,12 +49,11 @@ namespace MediaBrowser.Controller.Providers.Movies
/// <param name="configurationManager">The configuration manager.</param> /// <param name="configurationManager">The configuration manager.</param>
/// <param name="jsonSerializer">The json serializer.</param> /// <param name="jsonSerializer">The json serializer.</param>
/// <param name="httpClient">The HTTP client.</param> /// <param name="httpClient">The HTTP client.</param>
public RottenTomatoesMovieProvider(ILogManager logManager, IServerConfigurationManager configurationManager, IJsonSerializer jsonSerializer, IHttpClient httpClient) public RottenTomatoesProvider(ILogManager logManager, IServerConfigurationManager configurationManager, IJsonSerializer jsonSerializer, IHttpClient httpClient)
: base(logManager, configurationManager) : base(logManager, configurationManager)
{ {
JsonSerializer = jsonSerializer; JsonSerializer = jsonSerializer;
HttpClient = httpClient; HttpClient = httpClient;
Current = this;
} }
/// <summary> /// <summary>
@ -136,7 +130,7 @@ namespace MediaBrowser.Controller.Providers.Movies
get get
{ {
// Run after moviedb and xml providers // Run after moviedb and xml providers
return MetadataProviderPriority.Third; return MetadataProviderPriority.Last;
} }
} }
@ -148,7 +142,7 @@ namespace MediaBrowser.Controller.Providers.Movies
/// <returns><c>true</c> if XXXX, <c>false</c> otherwise</returns> /// <returns><c>true</c> if XXXX, <c>false</c> otherwise</returns>
protected override bool NeedsRefreshInternal(BaseItem item, BaseProviderInfo providerInfo) protected override bool NeedsRefreshInternal(BaseItem item, BaseProviderInfo providerInfo)
{ {
// Refresh if imdb id has changed // Refresh if rt id has changed
if (providerInfo.Data != GetComparisonData(item.GetProviderId(MetadataProviders.Imdb))) if (providerInfo.Data != GetComparisonData(item.GetProviderId(MetadataProviders.Imdb)))
{ {
return true; return true;
@ -183,11 +177,54 @@ namespace MediaBrowser.Controller.Providers.Movies
return true; return true;
} }
await FetchRottenTomatoesId(item, cancellationToken).ConfigureAwait(false);
using (var stream = await HttpClient.Get(new HttpRequestOptions
{
Url = GetMovieReviewsUrl(item.GetProviderId(MetadataProviders.RottenTomatoes)),
ResourcePool = _rottenTomatoesResourcePool,
CancellationToken = cancellationToken,
EnableResponseCache = true
}).ConfigureAwait(false))
{
var result = JsonSerializer.DeserializeFromStream<RTReviewList>(stream);
item.CriticReviews = result.reviews.Select(rtReview => new ItemReview
{
ReviewerName = rtReview.critic,
Publisher = rtReview.publication,
Date = DateTime.Parse(rtReview.date).ToUniversalTime(),
Caption = rtReview.quote,
Url = rtReview.links.review,
Likes = string.Equals(rtReview.freshness, "fresh", StringComparison.OrdinalIgnoreCase)
}).ToList();
}
data.Data = GetComparisonData(item.GetProviderId(MetadataProviders.Imdb));
data.LastRefreshStatus = ProviderRefreshStatus.Success;
SetLastRefreshed(item, DateTime.UtcNow);
return true;
}
/// <summary>
/// Fetches the rotten tomatoes id.
/// </summary>
/// <param name="item">The item.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
private async Task FetchRottenTomatoesId(BaseItem item, CancellationToken cancellationToken)
{
var imdbId = item.GetProviderId(MetadataProviders.Imdb);
// Have IMDB Id // Have IMDB Id
using (var stream = await HttpClient.Get(new HttpRequestOptions using (var stream = await HttpClient.Get(new HttpRequestOptions
{ {
Url = GetMovieImdbUrl(imdbId), Url = GetMovieImdbUrl(imdbId),
ResourcePool = RottenTomatoesResourcePool, ResourcePool = _rottenTomatoesResourcePool,
CancellationToken = cancellationToken, CancellationToken = cancellationToken,
EnableResponseCache = true EnableResponseCache = true
@ -201,23 +238,18 @@ namespace MediaBrowser.Controller.Providers.Movies
item.CriticRatingSummary = hit.critics_consensus; item.CriticRatingSummary = hit.critics_consensus;
item.CriticRating = float.Parse(hit.ratings.critics_score); item.CriticRating = float.Parse(hit.ratings.critics_score);
data.Data = GetComparisonData(hit.alternate_ids.imdb);
item.SetProviderId(MetadataProviders.Imdb, hit.alternate_ids.imdb);
item.SetProviderId(MetadataProviders.RottenTomatoes, hit.id); item.SetProviderId(MetadataProviders.RottenTomatoes, hit.id);
} }
} }
data.Data = GetComparisonData(imdbId);
data.LastRefreshStatus = ProviderRefreshStatus.Success;
SetLastRefreshed(item, DateTime.UtcNow);
return true;
} }
// Utility functions to get the URL of the API calls // Utility functions to get the URL of the API calls
private string GetMovieReviewsUrl(string rtId)
{
return BasicUrl + string.Format(MoviesReviews, ApiKey, rtId);
}
private string GetMovieImdbUrl(string imdbId) private string GetMovieImdbUrl(string imdbId)
{ {
return BasicUrl + string.Format(MovieImdb, ApiKey, imdbId.TrimStart('t')); return BasicUrl + string.Format(MovieImdb, ApiKey, imdbId.TrimStart('t'));
@ -225,6 +257,28 @@ namespace MediaBrowser.Controller.Providers.Movies
// Data contract classes for use with the Rotten Tomatoes API // Data contract classes for use with the Rotten Tomatoes API
protected class RTReviewList
{
public int total { get; set; }
public List<RTReview> reviews { get; set; }
}
protected class RTReview
{
public string critic { get; set; }
public string date { get; set; }
public string freshness { get; set; }
public string publication { get; set; }
public string quote { get; set; }
public RTReviewLink links { get; set; }
public string original_score { get; set; }
}
protected class RTReviewLink
{
public string review { get; set; }
}
protected class RTSearchResults protected class RTSearchResults
{ {
public int total { get; set; } public int total { get; set; }
@ -263,5 +317,6 @@ namespace MediaBrowser.Controller.Providers.Movies
{ {
public string imdb { get; set; } public string imdb { get; set; }
} }
} }
} }