using MediaBrowser.Common.Extensions;
using MediaBrowser.Common.Net;
using MediaBrowser.Controller.Configuration;
using MediaBrowser.Controller.Entities;
using MediaBrowser.Controller.Entities.Movies;
using MediaBrowser.Model.Entities;
using MediaBrowser.Model.Logging;
using MediaBrowser.Model.Serialization;
using System;
using System.Threading;
using System.Threading.Tasks;
using System.IO;
using System.Collections.Generic;
using System.Linq;
namespace MediaBrowser.Controller.Providers.Movies
{
///
/// Class RottenTomatoesMovieProvider
///
public class RottenTomatoesMovieProvider : BaseMetadataProvider
{
// http://developer.rottentomatoes.com/iodocs
///
/// The API key
///
private const string ApiKey = "x9wjnvv39ntjmt9zs95nm7bg";
private const string BasicUrl = @"http://api.rottentomatoes.com/api/public/v1.0/";
private const string Movie = @"movies/{1}.json?apikey={0}";
private const string MovieImdb = @"movie_alias.json?id={1}&type=imdb&apikey={0}";
private const string MovieSearch = @"movies.json?q={1}&apikey={0}&page_limit=20&page={2}";
private const string MoviesReviews = @"movies/{1}/reviews.json?review_type=top_critic&page_limit=10&page=1&country=us&apikey={0}";
///
/// The _rotten tomatoes resource pool
///
private readonly SemaphoreSlim _rottenTomatoesResourcePool = new SemaphoreSlim(3, 3);
///
/// Gets the json serializer.
///
/// The json serializer.
protected IJsonSerializer JsonSerializer { get; private set; }
///
/// Gets the HTTP client.
///
/// The HTTP client.
protected IHttpClient HttpClient { get; private set; }
///
/// Initializes a new instance of the class.
///
/// The log manager.
/// The configuration manager.
/// The json serializer.
/// The HTTP client.
public RottenTomatoesMovieProvider(ILogManager logManager, IServerConfigurationManager configurationManager, IJsonSerializer jsonSerializer, IHttpClient httpClient)
: base(logManager, configurationManager)
{
JsonSerializer = jsonSerializer;
HttpClient = httpClient;
}
///
/// Gets the provider version.
///
/// The provider version.
protected override string ProviderVersion
{
get
{
return "2";
}
}
///
/// Gets a value indicating whether [requires internet].
///
/// true if [requires internet]; otherwise, false.
public override bool RequiresInternet
{
get
{
return true;
}
}
///
/// Gets a value indicating whether [refresh on version change].
///
/// true if [refresh on version change]; otherwise, false.
protected override bool RefreshOnVersionChange
{
get
{
return true;
}
}
///
/// Supports the specified item.
///
/// The item.
/// true if XXXX, false otherwise
public override bool Supports(BaseItem item)
{
return item is Movie;
}
///
/// Gets the comparison data.
///
/// The imdb id.
/// Guid.
private Guid GetComparisonData(string imdbId)
{
return string.IsNullOrEmpty(imdbId) ? Guid.Empty : imdbId.GetMD5();
}
///
/// Gets the priority.
///
/// The priority.
public override MetadataProviderPriority Priority
{
get
{
// Run after moviedb and xml providers
return MetadataProviderPriority.Last;
}
}
///
/// Needses the refresh internal.
///
/// The item.
/// The provider info.
/// true if XXXX, false otherwise
protected override bool NeedsRefreshInternal(BaseItem item, BaseProviderInfo providerInfo)
{
// Refresh if imdb id has changed
if (providerInfo.Data != GetComparisonData(item.GetProviderId(MetadataProviders.Imdb)))
{
return true;
}
return base.NeedsRefreshInternal(item, providerInfo);
}
///
/// Fetches metadata and returns true or false indicating if any work that requires persistence was done
///
/// The item.
/// if set to true [force].
/// The cancellation token.
/// Task{System.Boolean}.
public override Task FetchAsync(BaseItem item, bool force, CancellationToken cancellationToken)
{
BaseProviderInfo data;
// See whether there's an IMDB Id available
string imdbId = null;
if (item.ProviderData.TryGetValue(Id, out data))
{
imdbId = item.GetProviderId(MetadataProviders.Imdb);
}
RTMovieSearchResult hit = null;
if (string.IsNullOrEmpty(imdbId))
{
// No IMDB Id, search RT for an ID
var page = 1;
using (var stream = HttpClient.Get(MovieSearchUrl(item.Name, page), _rottenTomatoesResourcePool, cancellationToken).Result)
{
var result = JsonSerializer.DeserializeFromStream(stream);
if (result.total == 1)
{
// With only one result we'll have to assume that this is the movie we're searching for
hit = result.movies[0];
}
else if (result.total > 1)
{
// If there are more results than one
// Step 1: Loop through all current results, see if there's an exact match (not case sensitive) somewhere, if so, accept that as the searched item, else go to step 2
// Step 2: Retrieve the next page and go to step 1 if there are results, else, stop checking
while (hit == null)
{
foreach (var searchHit in result.movies)
{
if (string.Equals(searchHit.title, item.Name, StringComparison.InvariantCultureIgnoreCase))
{
hit = searchHit;
break;
}
}
if (hit == null)
{
using (var newPageStream = HttpClient.Get(MovieSearchUrl(item.Name, page++), _rottenTomatoesResourcePool, cancellationToken).Result)
{
result = JsonSerializer.DeserializeFromStream(newPageStream);
if (result.total == 0)
{
// No results found on RottenTomatoes
break;
}
}
}
// while end
}
}
}
// if null end
}
else
{
// Have IMDB Id
using (var stream = HttpClient.Get(MovieImdbUrl(imdbId), _rottenTomatoesResourcePool, cancellationToken).Result)
{
var result = JsonSerializer.DeserializeFromStream(stream);
if (!string.IsNullOrEmpty(result.id))
{
// Got a result
hit = result;
}
}
}
// If we found any results, that's great!
if (hit != null)
{
item.CriticRatingSummary = hit.critics_concensus;
item.CriticRating = float.Parse(hit.ratings.critics_score);
using (var stream = HttpClient.Get(MovieReviewsUrl(hit.id), _rottenTomatoesResourcePool, cancellationToken).Result)
{
var result = JsonSerializer.DeserializeFromStream(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
}).ToList();
if (data == null)
{
data = new BaseProviderInfo();
}
data.Data = GetComparisonData(hit.alternate_ids.imdb);
item.SetProviderId(MetadataProviders.Imdb, hit.alternate_ids.imdb);
item.SetProviderId(MetadataProviders.RottenTomatoes, hit.id);
}
}
else
{
// Nothing found on RT
Logger.Info("Nothing found on RottenTomatoes for Movie \"{0}\"", item.Name);
// TODO: When alternative names are implemented search for those instead
}
if (data != null)
{
data.Data = GetComparisonData(imdbId);
data.LastRefreshStatus = ProviderRefreshStatus.Success;
}
SetLastRefreshed(item, DateTime.UtcNow);
return Task.FromResult(true);
}
// Utility functions to get the URL of the API calls
private string MovieUrl(string rtId)
{
return BasicUrl + string.Format(Movie, ApiKey, rtId);
}
private string MovieImdbUrl(string imdbId)
{
return BasicUrl + string.Format(MovieImdb, ApiKey, imdbId.TrimStart('t'));
}
private string MovieSearchUrl(string query, int page = 1)
{
return BasicUrl + string.Format(MovieSearch, ApiKey, Uri.EscapeDataString(query), page);
}
private string MovieReviewsUrl(string rtId)
{
return BasicUrl + string.Format(MoviesReviews, ApiKey, rtId);
}
// Data contract classes for use with the Rotten Tomatoes API
protected class RTSearchResults
{
public int total { get; set; }
public List movies { get; set; }
public RTSearchLinks links { get; set; }
public string link_template { get; set; }
}
protected class RTSearchLinks
{
public string self { get; set; }
public string next { get; set; }
public string previous { get; set; }
}
protected class RTMovieSearchResult
{
public string title { get; set; }
public int year { get; set; }
public string runtime { get; set; }
public string synopsis { get; set; }
public string critics_concensus { get; set; }
public string mpaa_rating { get; set; }
public string id { get; set; }
public RTRatings ratings { get; set; }
public RTAlternateIds alternate_ids { get; set; }
}
protected class RTRatings
{
public string critics_rating { get; set; }
public string critics_score { get; set; }
}
protected class RTAlternateIds
{
public string imdb { get; set; }
}
protected class RTReviewList
{
public int total { get; set; }
public List 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; }
}
protected class RTReviewLink
{
public string review { get; set; }
}
}
}