diff options
Diffstat (limited to 'MediaBrowser.ApiInteraction/BaseHttpApiClient.cs')
| -rw-r--r-- | MediaBrowser.ApiInteraction/BaseHttpApiClient.cs | 611 |
1 files changed, 611 insertions, 0 deletions
diff --git a/MediaBrowser.ApiInteraction/BaseHttpApiClient.cs b/MediaBrowser.ApiInteraction/BaseHttpApiClient.cs new file mode 100644 index 000000000..8c6c1c297 --- /dev/null +++ b/MediaBrowser.ApiInteraction/BaseHttpApiClient.cs @@ -0,0 +1,611 @@ +using MediaBrowser.Model.Authentication;
+using MediaBrowser.Model.Configuration;
+using MediaBrowser.Model.DTO;
+using MediaBrowser.Model.Weather;
+using System;
+using System.IO;
+using System.Net;
+using System.Text;
+using System.Threading.Tasks;
+#if WINDOWS_PHONE
+using SharpGIS;
+#else
+using System.Net.Http;
+#endif
+
+namespace MediaBrowser.ApiInteraction
+{
+ /// <summary>
+ /// Provides api methods centered around an HttpClient
+ /// </summary>
+ public abstract class BaseHttpApiClient : BaseApiClient
+ {
+#if WINDOWS_PHONE
+ public BaseHttpApiClient()
+ {
+ HttpClient = new GZipWebClient();
+ }
+
+ private WebClient HttpClient { get; set; }
+#else
+ protected BaseHttpApiClient(HttpClientHandler handler)
+ : base()
+ {
+ handler.AutomaticDecompression = DecompressionMethods.Deflate;
+
+ HttpClient = new HttpClient(handler);
+ }
+
+ private HttpClient HttpClient { get; set; }
+#endif
+
+ /// <summary>
+ /// Gets an image stream based on a url
+ /// </summary>
+ public Task<Stream> GetImageStreamAsync(string url)
+ {
+ return GetStreamAsync(url);
+ }
+
+ /// <summary>
+ /// Gets a BaseItem
+ /// </summary>
+ public async Task<DtoBaseItem> GetItemAsync(Guid id, Guid userId)
+ {
+ string url = ApiUrl + "/item?userId=" + userId.ToString();
+
+ if (id != Guid.Empty)
+ {
+ url += "&id=" + id.ToString();
+ }
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<DtoBaseItem>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Gets all Users
+ /// </summary>
+ public async Task<DtoUser[]> GetAllUsersAsync()
+ {
+ string url = ApiUrl + "/users";
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<DtoUser[]>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Gets all Genres
+ /// </summary>
+ public async Task<IbnItem[]> GetAllGenresAsync(Guid userId)
+ {
+ string url = ApiUrl + "/genres?userId=" + userId.ToString();
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<IbnItem[]>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Gets in-progress items
+ /// </summary>
+ /// <param name="userId">The user id.</param>
+ /// <param name="folderId">(Optional) Specify a folder Id to localize the search to a specific folder.</param>
+ public async Task<DtoBaseItem[]> GetInProgressItemsItemsAsync(Guid userId, Guid? folderId = null)
+ {
+ string url = ApiUrl + "/itemlist?listtype=inprogressitems&userId=" + userId.ToString();
+
+ if (folderId.HasValue)
+ {
+ url += "&id=" + folderId.ToString();
+ }
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<DtoBaseItem[]>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Gets recently added items
+ /// </summary>
+ /// <param name="userId">The user id.</param>
+ /// <param name="folderId">(Optional) Specify a folder Id to localize the search to a specific folder.</param>
+ public async Task<DtoBaseItem[]> GetRecentlyAddedItemsAsync(Guid userId, Guid? folderId = null)
+ {
+ string url = ApiUrl + "/itemlist?listtype=recentlyaddeditems&userId=" + userId.ToString();
+
+ if (folderId.HasValue)
+ {
+ url += "&id=" + folderId.ToString();
+ }
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<DtoBaseItem[]>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Gets favorite items
+ /// </summary>
+ /// <param name="userId">The user id.</param>
+ /// <param name="folderId">(Optional) Specify a folder Id to localize the search to a specific folder.</param>
+ public async Task<DtoBaseItem[]> GetFavoriteItemsAsync(Guid userId, Guid? folderId = null)
+ {
+ string url = ApiUrl + "/itemlist?listtype=favorites&userId=" + userId.ToString();
+
+ if (folderId.HasValue)
+ {
+ url += "&id=" + folderId.ToString();
+ }
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<DtoBaseItem[]>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Gets recently added items that are unplayed.
+ /// </summary>
+ /// <param name="userId">The user id.</param>
+ /// <param name="folderId">(Optional) Specify a folder Id to localize the search to a specific folder.</param>
+ public async Task<DtoBaseItem[]> GetRecentlyAddedUnplayedItemsAsync(Guid userId, Guid? folderId = null)
+ {
+ string url = ApiUrl + "/itemlist?listtype=recentlyaddedunplayeditems&userId=" + userId.ToString();
+
+ if (folderId.HasValue)
+ {
+ url += "&id=" + folderId.ToString();
+ }
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<DtoBaseItem[]>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Gets all Years
+ /// </summary>
+ public async Task<IbnItem[]> GetAllYearsAsync(Guid userId)
+ {
+ string url = ApiUrl + "/years?userId=" + userId.ToString();
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<IbnItem[]>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Gets all items that contain a given Year
+ /// </summary>
+ /// <param name="folderId">(Optional) Specify a folder Id to localize the search to a specific folder.</param>
+ public async Task<DtoBaseItem[]> GetItemsWithYearAsync(string name, Guid userId, Guid? folderId = null)
+ {
+ string url = ApiUrl + "/itemlist?listtype=itemswithyear&userId=" + userId.ToString() + "&name=" + name;
+
+ if (folderId.HasValue)
+ {
+ url += "&id=" + folderId.ToString();
+ }
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<DtoBaseItem[]>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Gets all items that contain a given Genre
+ /// </summary>
+ /// <param name="folderId">(Optional) Specify a folder Id to localize the search to a specific folder.</param>
+ public async Task<DtoBaseItem[]> GetItemsWithGenreAsync(string name, Guid userId, Guid? folderId = null)
+ {
+ string url = ApiUrl + "/itemlist?listtype=itemswithgenre&userId=" + userId.ToString() + "&name=" + name;
+
+ if (folderId.HasValue)
+ {
+ url += "&id=" + folderId.ToString();
+ }
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<DtoBaseItem[]>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Gets all items that contain a given Person
+ /// </summary>
+ /// <param name="folderId">(Optional) Specify a folder Id to localize the search to a specific folder.</param>
+ public async Task<DtoBaseItem[]> GetItemsWithPersonAsync(string name, Guid userId, Guid? folderId = null)
+ {
+ string url = ApiUrl + "/itemlist?listtype=itemswithperson&userId=" + userId.ToString() + "&name=" + name;
+
+ if (folderId.HasValue)
+ {
+ url += "&id=" + folderId.ToString();
+ }
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<DtoBaseItem[]>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Gets all items that contain a given Person
+ /// </summary>
+ /// <param name="folderId">(Optional) Specify a folder Id to localize the search to a specific folder.</param>
+ public async Task<DtoBaseItem[]> GetItemsWithPersonAsync(string name, string personType, Guid userId, Guid? folderId = null)
+ {
+ string url = ApiUrl + "/itemlist?listtype=itemswithperson&userId=" + userId.ToString() + "&name=" + name;
+
+ url += "&persontype=" + personType;
+
+ if (folderId.HasValue)
+ {
+ url += "&id=" + folderId.ToString();
+ }
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<DtoBaseItem[]>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Gets all studious
+ /// </summary>
+ public async Task<IbnItem[]> GetAllStudiosAsync(Guid userId)
+ {
+ string url = ApiUrl + "/studios?userId=" + userId.ToString();
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<IbnItem[]>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Gets all items that contain a given Studio
+ /// </summary>
+ /// <param name="folderId">(Optional) Specify a folder Id to localize the search to a specific folder.</param>
+ public async Task<DtoBaseItem[]> GetItemsWithStudioAsync(string name, Guid userId, Guid? folderId = null)
+ {
+ string url = ApiUrl + "/itemlist?listtype=itemswithstudio&userId=" + userId.ToString() + "&name=" + name;
+
+ if (folderId.HasValue)
+ {
+ url += "&id=" + folderId.ToString();
+ }
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<DtoBaseItem[]>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Gets a studio
+ /// </summary>
+ public async Task<IbnItem> GetStudioAsync(Guid userId, string name)
+ {
+ string url = ApiUrl + "/studio?userId=" + userId.ToString() + "&name=" + name;
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<IbnItem>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Gets a genre
+ /// </summary>
+ public async Task<IbnItem> GetGenreAsync(Guid userId, string name)
+ {
+ string url = ApiUrl + "/genre?userId=" + userId.ToString() + "&name=" + name;
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<IbnItem>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Gets a person
+ /// </summary>
+ public async Task<IbnItem> GetPersonAsync(Guid userId, string name)
+ {
+ string url = ApiUrl + "/person?userId=" + userId.ToString() + "&name=" + name;
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<IbnItem>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Gets a year
+ /// </summary>
+ public async Task<IbnItem> GetYearAsync(Guid userId, int year)
+ {
+ string url = ApiUrl + "/year?userId=" + userId.ToString() + "&year=" + year;
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<IbnItem>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Gets a list of plugins installed on the server
+ /// </summary>
+ public async Task<PluginInfo[]> GetInstalledPluginsAsync()
+ {
+ string url = ApiUrl + "/plugins";
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<PluginInfo[]>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Gets a list of plugins installed on the server
+ /// </summary>
+ public Task<Stream> GetPluginAssemblyAsync(PluginInfo plugin)
+ {
+ string url = ApiUrl + "/pluginassembly?assemblyfilename=" + plugin.AssemblyFileName;
+
+ return GetStreamAsync(url);
+ }
+
+ /// <summary>
+ /// Gets the current server configuration
+ /// </summary>
+ public async Task<ServerConfiguration> GetServerConfigurationAsync()
+ {
+ string url = ApiUrl + "/ServerConfiguration";
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<ServerConfiguration>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Gets weather information for the default location as set in configuration
+ /// </summary>
+ public async Task<object> GetPluginConfigurationAsync(PluginInfo plugin, Type configurationType)
+ {
+ string url = ApiUrl + "/PluginConfiguration?assemblyfilename=" + plugin.AssemblyFileName;
+
+ // At the moment this can't be retrieved in protobuf format
+ SerializationFormats format = DataSerializer.CanDeSerializeJsv ? SerializationFormats.Jsv : SerializationFormats.Json;
+
+ using (Stream stream = await GetSerializedStreamAsync(url, format).ConfigureAwait(false))
+ {
+ return DataSerializer.DeserializeFromStream(stream, format, configurationType);
+ }
+ }
+
+ /// <summary>
+ /// Gets the default user
+ /// </summary>
+ public async Task<DtoUser> GetDefaultUserAsync()
+ {
+ string url = ApiUrl + "/user";
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<DtoUser>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Gets a user by id
+ /// </summary>
+ public async Task<DtoUser> GetUserAsync(Guid id)
+ {
+ string url = ApiUrl + "/user?id=" + id.ToString();
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<DtoUser>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Gets weather information for the default location as set in configuration
+ /// </summary>
+ public async Task<WeatherInfo> GetWeatherInfoAsync()
+ {
+ string url = ApiUrl + "/weather";
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<WeatherInfo>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Gets weather information for a specific zip code
+ /// </summary>
+ public async Task<WeatherInfo> GetWeatherInfoAsync(string zipCode)
+ {
+ string url = ApiUrl + "/weather?zipcode=" + zipCode;
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<WeatherInfo>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Gets special features for a Movie
+ /// </summary>
+ public async Task<DtoBaseItem[]> GetMovieSpecialFeaturesAsync(Guid itemId, Guid userId)
+ {
+ string url = ApiUrl + "/MovieSpecialFeatures?id=" + itemId;
+ url += "&userid=" + userId;
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<DtoBaseItem[]>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Updates played status for an item
+ /// </summary>
+ public async Task<DtoUserItemData> UpdatePlayedStatusAsync(Guid itemId, Guid userId, bool wasPlayed)
+ {
+ string url = ApiUrl + "/PlayedStatus?id=" + itemId;
+
+ url += "&userid=" + userId;
+ url += "&played=" + (wasPlayed ? "1" : "0");
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<DtoUserItemData>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Updates a user's favorite status for an item and returns the updated UserItemData object.
+ /// </summary>
+ public async Task<DtoUserItemData> UpdateFavoriteStatusAsync(Guid itemId, Guid userId, bool isFavorite)
+ {
+ string url = ApiUrl + "/favoritestatus?id=" + itemId;
+
+ url += "&userid=" + userId;
+ url += "&isfavorite=" + (isFavorite ? "1" : "0");
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<DtoUserItemData>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Clears a user's rating for an item
+ /// </summary>
+ public async Task<DtoUserItemData> ClearUserItemRatingAsync(Guid itemId, Guid userId)
+ {
+ string url = ApiUrl + "/UserItemRating?id=" + itemId;
+
+ url += "&userid=" + userId;
+ url += "&clear=1";
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<DtoUserItemData>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Updates a user's rating for an item, based on likes or dislikes
+ /// </summary>
+ public async Task<DtoUserItemData> UpdateUserItemRatingAsync(Guid itemId, Guid userId, bool likes)
+ {
+ string url = ApiUrl + "/UserItemRating?id=" + itemId;
+
+ url += "&userid=" + userId;
+ url += "&likes=" + (likes ? "1" : "0");
+
+ using (Stream stream = await GetSerializedStreamAsync(url).ConfigureAwait(false))
+ {
+ return DeserializeFromStream<DtoUserItemData>(stream);
+ }
+ }
+
+ /// <summary>
+ /// Authenticates a user and returns the result
+ /// </summary>
+ public async Task<AuthenticationResult> AuthenticateUserAsync(Guid userId, string password)
+ {
+ string url = ApiUrl + "/UserAuthentication?dataformat=" + SerializationFormat.ToString();
+
+ // Create the post body
+ string postContent = string.Format("userid={0}", userId);
+
+ if (!string.IsNullOrEmpty(password))
+ {
+ postContent += "&password=" + password;
+ }
+
+#if WINDOWS_PHONE
+ HttpClient.Headers["Content-Type"] = "application/x-www-form-urlencoded";
+ var result = await HttpClient.UploadStringTaskAsync(url, "POST", postContent);
+
+ var byteArray = Encoding.UTF8.GetBytes(result);
+ using (MemoryStream stream = new MemoryStream(byteArray))
+ {
+ return DeserializeFromStream<AuthenticationResult>(stream);
+ }
+#else
+ HttpContent content = new StringContent(postContent, Encoding.UTF8, "application/x-www-form-urlencoded");
+
+ HttpResponseMessage msg = await HttpClient.PostAsync(url, content).ConfigureAwait(false);
+
+ using (Stream stream = await msg.Content.ReadAsStreamAsync().ConfigureAwait(false))
+ {
+ return DeserializeFromStream<AuthenticationResult>(stream);
+ }
+#endif
+ }
+
+ /// <summary>
+ /// This is a helper around getting a stream from the server that contains serialized data
+ /// </summary>
+ private Task<Stream> GetSerializedStreamAsync(string url)
+ {
+ return GetSerializedStreamAsync(url, SerializationFormat);
+ }
+
+ /// <summary>
+ /// This is a helper around getting a stream from the server that contains serialized data
+ /// </summary>
+ private Task<Stream> GetSerializedStreamAsync(string url, SerializationFormats serializationFormat)
+ {
+ if (url.IndexOf('?') == -1)
+ {
+ url += "?dataformat=" + serializationFormat.ToString();
+ }
+ else
+ {
+ url += "&dataformat=" + serializationFormat.ToString();
+ }
+
+ return GetStreamAsync(url);
+ }
+
+ /// <summary>
+ /// This is just a helper around HttpClient
+ /// </summary>
+ private Task<Stream> GetStreamAsync(string url)
+ {
+#if WINDOWS_PHONE
+ return HttpClient.OpenReadTaskAsync(url);
+#else
+ return HttpClient.GetStreamAsync(url);
+#endif
+ }
+
+ public override void Dispose()
+ {
+#if !WINDOWS_PHONE
+ HttpClient.Dispose();
+#endif
+ }
+ }
+}
|