392 lines
20 KiB
C#
392 lines
20 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using System.Globalization;
|
|
using System.Linq;
|
|
using System.Net;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
using TMDbLib.Objects.Authentication;
|
|
using TMDbLib.Objects.General;
|
|
using TMDbLib.Objects.Movies;
|
|
using TMDbLib.Objects.Reviews;
|
|
using TMDbLib.Objects.Search;
|
|
using TMDbLib.Rest;
|
|
using TMDbLib.Utilities;
|
|
using Credits = TMDbLib.Objects.Movies.Credits;
|
|
|
|
namespace TMDbLib.Client
|
|
{
|
|
public partial class TMDbClient
|
|
{
|
|
private async Task<T> GetMovieMethodInternal<T>(int movieId, MovieMethods movieMethod, string dateFormat = null,
|
|
string country = null,
|
|
string language = null, string includeImageLanguage = null, int page = 0, DateTime? startDate = null, DateTime? endDate = null, CancellationToken cancellationToken = default) where T : new()
|
|
{
|
|
RestRequest req = _client.Create("movie/{movieId}/{method}");
|
|
req.AddUrlSegment("movieId", movieId.ToString(CultureInfo.InvariantCulture));
|
|
req.AddUrlSegment("method", movieMethod.GetDescription());
|
|
|
|
if (country != null)
|
|
req.AddParameter("country", country);
|
|
|
|
language ??= DefaultLanguage;
|
|
if (!string.IsNullOrWhiteSpace(language))
|
|
req.AddParameter("language", language);
|
|
|
|
if (!string.IsNullOrWhiteSpace(includeImageLanguage))
|
|
req.AddParameter("include_image_language", includeImageLanguage);
|
|
|
|
if (page >= 1)
|
|
req.AddParameter("page", page.ToString());
|
|
if (startDate.HasValue)
|
|
req.AddParameter("start_date", startDate.Value.ToString("yyyy-MM-dd"));
|
|
if (endDate != null)
|
|
req.AddParameter("end_date", endDate.Value.ToString("yyyy-MM-dd"));
|
|
|
|
T response = await req.GetOfT<T>(cancellationToken).ConfigureAwait(false);
|
|
|
|
return response;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Retrieves all information for a specific movie in relation to the current user account
|
|
/// </summary>
|
|
/// <param name="movieId">The id of the movie to get the account states for</param>
|
|
/// <param name="cancellationToken">A cancellation token</param>
|
|
/// <remarks>Requires a valid user session</remarks>
|
|
/// <exception cref="UserSessionRequiredException">Thrown when the current client object doens't have a user session assigned.</exception>
|
|
public async Task<AccountState> GetMovieAccountStateAsync(int movieId, CancellationToken cancellationToken = default)
|
|
{
|
|
RequireSessionId(SessionType.UserSession);
|
|
|
|
RestRequest req = _client.Create("movie/{movieId}/{method}");
|
|
req.AddUrlSegment("movieId", movieId.ToString(CultureInfo.InvariantCulture));
|
|
req.AddUrlSegment("method", MovieMethods.AccountStates.GetDescription());
|
|
AddSessionId(req, SessionType.UserSession);
|
|
|
|
using RestResponse<AccountState> response = await req.Get<AccountState>(cancellationToken).ConfigureAwait(false);
|
|
|
|
return await response.GetDataObject().ConfigureAwait(false);
|
|
}
|
|
|
|
public async Task<AlternativeTitles> GetMovieAlternativeTitlesAsync(int movieId, CancellationToken cancellationToken = default)
|
|
{
|
|
return await GetMovieAlternativeTitlesAsync(movieId, DefaultCountry, cancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
public async Task<AlternativeTitles> GetMovieAlternativeTitlesAsync(int movieId, string country, CancellationToken cancellationToken = default)
|
|
{
|
|
return await GetMovieMethodInternal<AlternativeTitles>(movieId, MovieMethods.AlternativeTitles, country: country, cancellationToken: cancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
public async Task<Movie> GetMovieAsync(int movieId, MovieMethods extraMethods = MovieMethods.Undefined, CancellationToken cancellationToken = default)
|
|
{
|
|
return await GetMovieAsync(movieId, DefaultLanguage, null, extraMethods, cancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
public async Task<Movie> GetMovieAsync(string imdbId, MovieMethods extraMethods = MovieMethods.Undefined, CancellationToken cancellationToken = default)
|
|
{
|
|
return await GetMovieAsync(imdbId, DefaultLanguage, null, extraMethods, cancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
public async Task<Movie> GetMovieAsync(int movieId, string language, string includeImageLanguage = null, MovieMethods extraMethods = MovieMethods.Undefined, CancellationToken cancellationToken = default)
|
|
{
|
|
return await GetMovieAsync(movieId.ToString(CultureInfo.InvariantCulture), language, includeImageLanguage, extraMethods, cancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Retrieves a movie by its IMDb Id
|
|
/// </summary>
|
|
/// <param name="imdbId">The IMDb id of the movie OR the TMDb id as string</param>
|
|
/// <param name="language">Language to localize the results in.</param>
|
|
/// <param name="includeImageLanguage">If specified the api will attempt to return localized image results eg. en,it,es.</param>
|
|
/// <param name="extraMethods">A list of additional methods to execute for this req as enum flags</param>
|
|
/// <param name="cancellationToken">A cancellation token</param>
|
|
/// <returns>The reqed movie or null if it could not be found</returns>
|
|
/// <remarks>Requires a valid user session when specifying the extra method 'AccountStates' flag</remarks>
|
|
/// <exception cref="UserSessionRequiredException">Thrown when the current client object doens't have a user session assigned, see remarks.</exception>
|
|
public async Task<Movie> GetMovieAsync(string imdbId, string language, string includeImageLanguage = null, MovieMethods extraMethods = MovieMethods.Undefined, CancellationToken cancellationToken = default)
|
|
{
|
|
if (extraMethods.HasFlag(MovieMethods.AccountStates))
|
|
RequireSessionId(SessionType.UserSession);
|
|
|
|
RestRequest req = _client.Create("movie/{movieId}");
|
|
req.AddUrlSegment("movieId", imdbId);
|
|
if (extraMethods.HasFlag(MovieMethods.AccountStates))
|
|
AddSessionId(req, SessionType.UserSession);
|
|
|
|
if (language != null)
|
|
req.AddParameter("language", language);
|
|
|
|
includeImageLanguage ??= DefaultImageLanguage;
|
|
if (includeImageLanguage != null)
|
|
req.AddParameter("include_image_language", includeImageLanguage);
|
|
|
|
string appends = string.Join(",",
|
|
Enum.GetValues(typeof(MovieMethods))
|
|
.OfType<MovieMethods>()
|
|
.Except(new[] { MovieMethods.Undefined })
|
|
.Where(s => extraMethods.HasFlag(s))
|
|
.Select(s => s.GetDescription()));
|
|
|
|
if (appends != string.Empty)
|
|
req.AddParameter("append_to_response", appends);
|
|
|
|
using RestResponse<Movie> response = await req.Get<Movie>(cancellationToken).ConfigureAwait(false);
|
|
|
|
if (!response.IsValid)
|
|
return null;
|
|
|
|
Movie item = await response.GetDataObject().ConfigureAwait(false);
|
|
|
|
// Patch up data, so that the end user won't notice that we share objects between req-types.
|
|
if (item.Videos != null)
|
|
item.Videos.Id = item.Id;
|
|
|
|
if (item.AlternativeTitles != null)
|
|
item.AlternativeTitles.Id = item.Id;
|
|
|
|
if (item.Credits != null)
|
|
item.Credits.Id = item.Id;
|
|
|
|
if (item.Releases != null)
|
|
item.Releases.Id = item.Id;
|
|
|
|
if (item.Keywords != null)
|
|
item.Keywords.Id = item.Id;
|
|
|
|
if (item.Translations != null)
|
|
item.Translations.Id = item.Id;
|
|
|
|
if (item.AccountStates != null)
|
|
item.AccountStates.Id = item.Id;
|
|
|
|
if (item.ExternalIds != null)
|
|
item.ExternalIds.Id = item.Id;
|
|
|
|
// Overview is the only field that is HTML encoded from the source.
|
|
item.Overview = WebUtility.HtmlDecode(item.Overview);
|
|
|
|
return item;
|
|
}
|
|
|
|
public async Task<Credits> GetMovieCreditsAsync(int movieId, CancellationToken cancellationToken = default)
|
|
{
|
|
return await GetMovieMethodInternal<Credits>(movieId, MovieMethods.Credits, cancellationToken: cancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Returns an object that contains all known exteral id's for the movie related to the specified TMDB id.
|
|
/// </summary>
|
|
/// <param name="id">The TMDb id of the target movie.</param>
|
|
/// <param name="cancellationToken">A cancellation token</param>
|
|
public async Task<ExternalIdsMovie> GetMovieExternalIdsAsync(int id, CancellationToken cancellationToken = default)
|
|
{
|
|
return await GetMovieMethodInternal<ExternalIdsMovie>(id, MovieMethods.ExternalIds, cancellationToken: cancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
public async Task<ImagesWithId> GetMovieImagesAsync(int movieId, CancellationToken cancellationToken = default)
|
|
{
|
|
return await GetMovieImagesAsync(movieId, DefaultLanguage, null, cancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
public async Task<ImagesWithId> GetMovieImagesAsync(int movieId, string language, string includeImageLanguage = null, CancellationToken cancellationToken = default)
|
|
{
|
|
return await GetMovieMethodInternal<ImagesWithId>(movieId, MovieMethods.Images, language: language, includeImageLanguage: includeImageLanguage, cancellationToken: cancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
public async Task<KeywordsContainer> GetMovieKeywordsAsync(int movieId, CancellationToken cancellationToken = default)
|
|
{
|
|
return await GetMovieMethodInternal<KeywordsContainer>(movieId, MovieMethods.Keywords, cancellationToken: cancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
public async Task<Movie> GetMovieLatestAsync(CancellationToken cancellationToken = default)
|
|
{
|
|
RestRequest req = _client.Create("movie/latest");
|
|
using RestResponse<Movie> resp = await req.Get<Movie>(cancellationToken).ConfigureAwait(false);
|
|
|
|
Movie item = await resp.GetDataObject().ConfigureAwait(false);
|
|
|
|
// Overview is the only field that is HTML encoded from the source.
|
|
if (item != null)
|
|
item.Overview = WebUtility.HtmlDecode(item.Overview);
|
|
|
|
return item;
|
|
}
|
|
|
|
public async Task<SearchContainerWithId<ListResult>> GetMovieListsAsync(int movieId, int page = 0, CancellationToken cancellationToken = default)
|
|
{
|
|
return await GetMovieListsAsync(movieId, DefaultLanguage, page, cancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
public async Task<SearchContainerWithId<ListResult>> GetMovieListsAsync(int movieId, string language, int page = 0, CancellationToken cancellationToken = default)
|
|
{
|
|
return await GetMovieMethodInternal<SearchContainerWithId<ListResult>>(movieId, MovieMethods.Lists, page: page, language: language, cancellationToken: cancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
public async Task<SearchContainer<SearchMovie>> GetMovieRecommendationsAsync(int id, int page = 0, CancellationToken cancellationToken = default)
|
|
{
|
|
return await GetMovieRecommendationsAsync(id, DefaultLanguage, page, cancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
public async Task<SearchContainer<SearchMovie>> GetMovieRecommendationsAsync(int id, string language, int page = 0, CancellationToken cancellationToken = default)
|
|
{
|
|
return await GetMovieMethodInternal<SearchContainer<SearchMovie>>(id, MovieMethods.Recommendations, language: language, page: page, cancellationToken: cancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
public async Task<SearchContainerWithDates<SearchMovie>> GetMovieNowPlayingListAsync(string language = null, int page = 0, string region = null, CancellationToken cancellationToken = default)
|
|
{
|
|
RestRequest req = _client.Create("movie/now_playing");
|
|
|
|
if (page >= 1)
|
|
req.AddParameter("page", page.ToString());
|
|
if (language != null)
|
|
req.AddParameter("language", language);
|
|
if (region != null)
|
|
req.AddParameter("region", region);
|
|
|
|
SearchContainerWithDates<SearchMovie> resp = await req.GetOfT<SearchContainerWithDates<SearchMovie>>(cancellationToken).ConfigureAwait(false);
|
|
|
|
return resp;
|
|
}
|
|
|
|
public async Task<SearchContainer<SearchMovie>> GetMoviePopularListAsync(string language = null, int page = 0, string region = null, CancellationToken cancellationToken = default)
|
|
{
|
|
RestRequest req = _client.Create("movie/popular");
|
|
|
|
if (page >= 1)
|
|
req.AddParameter("page", page.ToString());
|
|
if (language != null)
|
|
req.AddParameter("language", language);
|
|
if (region != null)
|
|
req.AddParameter("region", region);
|
|
|
|
SearchContainer<SearchMovie> resp = await req.GetOfT<SearchContainer<SearchMovie>>(cancellationToken).ConfigureAwait(false);
|
|
|
|
return resp;
|
|
}
|
|
|
|
public async Task<ResultContainer<ReleaseDatesContainer>> GetMovieReleaseDatesAsync(int movieId, CancellationToken cancellationToken = default)
|
|
{
|
|
return await GetMovieMethodInternal<ResultContainer<ReleaseDatesContainer>>(movieId, MovieMethods.ReleaseDates, cancellationToken: cancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
public async Task<Releases> GetMovieReleasesAsync(int movieId, CancellationToken cancellationToken = default)
|
|
{
|
|
return await GetMovieMethodInternal<Releases>(movieId, MovieMethods.Releases, dateFormat: "yyyy-MM-dd", cancellationToken: cancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
public async Task<SearchContainerWithId<ReviewBase>> GetMovieReviewsAsync(int movieId, int page = 0, CancellationToken cancellationToken = default)
|
|
{
|
|
return await GetMovieReviewsAsync(movieId, DefaultLanguage, page, cancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
public async Task<SearchContainerWithId<ReviewBase>> GetMovieReviewsAsync(int movieId, string language, int page = 0, CancellationToken cancellationToken = default)
|
|
{
|
|
return await GetMovieMethodInternal<SearchContainerWithId<ReviewBase>>(movieId, MovieMethods.Reviews, page: page, language: language, cancellationToken: cancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
public async Task<SearchContainer<SearchMovie>> GetMovieSimilarAsync(int movieId, int page = 0, CancellationToken cancellationToken = default)
|
|
{
|
|
return await GetMovieSimilarAsync(movieId, DefaultLanguage, page, cancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
public async Task<SearchContainer<SearchMovie>> GetMovieSimilarAsync(int movieId, string language, int page = 0, CancellationToken cancellationToken = default)
|
|
{
|
|
return await GetMovieMethodInternal<SearchContainer<SearchMovie>>(movieId, MovieMethods.Similar, page: page, language: language, dateFormat: "yyyy-MM-dd", cancellationToken: cancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
public async Task<SearchContainer<SearchMovie>> GetMovieTopRatedListAsync(string language = null, int page = 0, string region = null, CancellationToken cancellationToken = default)
|
|
{
|
|
RestRequest req = _client.Create("movie/top_rated");
|
|
|
|
if (page >= 1)
|
|
req.AddParameter("page", page.ToString());
|
|
if (language != null)
|
|
req.AddParameter("language", language);
|
|
if (region != null)
|
|
req.AddParameter("region", region);
|
|
|
|
SearchContainer<SearchMovie> resp = await req.GetOfT<SearchContainer<SearchMovie>>(cancellationToken).ConfigureAwait(false);
|
|
|
|
return resp;
|
|
}
|
|
|
|
public async Task<TranslationsContainer> GetMovieTranslationsAsync(int movieId, CancellationToken cancellationToken = default)
|
|
{
|
|
return await GetMovieMethodInternal<TranslationsContainer>(movieId, MovieMethods.Translations, cancellationToken: cancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
public async Task<SearchContainerWithDates<SearchMovie>> GetMovieUpcomingListAsync(string language = null, int page = 0, string region = null, CancellationToken cancellationToken = default)
|
|
{
|
|
RestRequest req = _client.Create("movie/upcoming");
|
|
|
|
if (page >= 1)
|
|
req.AddParameter("page", page.ToString());
|
|
if (language != null)
|
|
req.AddParameter("language", language);
|
|
if (region != null)
|
|
req.AddParameter("region", region);
|
|
|
|
SearchContainerWithDates<SearchMovie> resp = await req.GetOfT<SearchContainerWithDates<SearchMovie>>(cancellationToken).ConfigureAwait(false);
|
|
|
|
return resp;
|
|
}
|
|
|
|
public async Task<ResultContainer<Video>> GetMovieVideosAsync(int movieId, CancellationToken cancellationToken = default)
|
|
{
|
|
return await GetMovieMethodInternal<ResultContainer<Video>>(movieId, MovieMethods.Videos, cancellationToken: cancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
public async Task<SingleResultContainer<Dictionary<string, WatchProviders>>> GetMovieWatchProvidersAsync(int movieId, CancellationToken cancellationToken = default)
|
|
{
|
|
return await GetMovieMethodInternal<SingleResultContainer<Dictionary<string, WatchProviders>>>(movieId, MovieMethods.WatchProviders, cancellationToken: cancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
public async Task<bool> MovieRemoveRatingAsync(int movieId, CancellationToken cancellationToken = default)
|
|
{
|
|
RequireSessionId(SessionType.GuestSession);
|
|
|
|
RestRequest req = _client.Create("movie/{movieId}/rating");
|
|
req.AddUrlSegment("movieId", movieId.ToString(CultureInfo.InvariantCulture));
|
|
AddSessionId(req);
|
|
|
|
using RestResponse<PostReply> response = await req.Delete<PostReply>(cancellationToken).ConfigureAwait(false);
|
|
|
|
// status code 13 = "The item/record was deleted successfully."
|
|
PostReply item = await response.GetDataObject().ConfigureAwait(false);
|
|
|
|
// TODO: Previous code checked for item=null
|
|
return item != null && item.StatusCode == 13;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Change the rating of a specified movie.
|
|
/// </summary>
|
|
/// <param name="movieId">The id of the movie to rate</param>
|
|
/// <param name="rating">The rating you wish to assign to the specified movie. Value needs to be between 0.5 and 10 and must use increments of 0.5. Ex. using 7.1 will not work and return false.</param>
|
|
/// <param name="cancellationToken">A cancellation token</param>
|
|
/// <returns>True if the the movie's rating was successfully updated, false if not</returns>
|
|
/// <remarks>Requires a valid guest or user session</remarks>
|
|
/// <exception cref="GuestSessionRequiredException">Thrown when the current client object doens't have a guest or user session assigned.</exception>
|
|
public async Task<bool> MovieSetRatingAsync(int movieId, double rating, CancellationToken cancellationToken = default)
|
|
{
|
|
RequireSessionId(SessionType.GuestSession);
|
|
|
|
RestRequest req = _client.Create("movie/{movieId}/rating");
|
|
req.AddUrlSegment("movieId", movieId.ToString(CultureInfo.InvariantCulture));
|
|
AddSessionId(req);
|
|
|
|
req.SetBody(new { value = rating });
|
|
|
|
using RestResponse<PostReply> response = await req.Post<PostReply>(cancellationToken).ConfigureAwait(false);
|
|
|
|
// status code 1 = "Success"
|
|
// status code 12 = "The item/record was updated successfully" - Used when an item was previously rated by the user
|
|
PostReply item = await response.GetDataObject().ConfigureAwait(false);
|
|
|
|
// TODO: Previous code checked for item=null
|
|
return item.StatusCode == 1 || item.StatusCode == 12;
|
|
}
|
|
}
|
|
} |