jellyfin/MediaBrowser.Api/PackageService.cs

172 lines
6.3 KiB
C#
Raw Normal View History

using System;
2013-02-20 18:33:05 -07:00
using System.Collections.Generic;
2019-10-08 11:51:11 -07:00
using System.Globalization;
2013-02-20 18:33:05 -07:00
using System.Linq;
using System.Threading.Tasks;
using MediaBrowser.Common.Extensions;
using MediaBrowser.Common.Updates;
using MediaBrowser.Controller.Configuration;
using MediaBrowser.Controller.Net;
2016-10-25 12:02:04 -07:00
using MediaBrowser.Model.Services;
using MediaBrowser.Model.Updates;
using Microsoft.Extensions.Logging;
2013-02-20 18:33:05 -07:00
namespace MediaBrowser.Api
{
/// <summary>
/// Class GetPackage
/// </summary>
2014-03-23 13:07:02 -07:00
[Route("/Packages/{Name}", "GET", Summary = "Gets a package, by name or assembly guid")]
2014-11-30 12:01:33 -07:00
[Authenticated]
2013-02-20 18:33:05 -07:00
public class GetPackage : IReturn<PackageInfo>
{
/// <summary>
/// Gets or sets the name.
/// </summary>
/// <value>The name.</value>
2013-03-08 12:14:09 -07:00
[ApiMember(Name = "Name", Description = "The name of the package", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
2013-02-20 18:33:05 -07:00
public string Name { get; set; }
/// <summary>
/// Gets or sets the name.
/// </summary>
/// <value>The name.</value>
[ApiMember(Name = "AssemblyGuid", Description = "The guid of the associated assembly", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string AssemblyGuid { get; set; }
2013-02-20 18:33:05 -07:00
}
/// <summary>
/// Class GetPackages
/// </summary>
2014-03-23 13:07:02 -07:00
[Route("/Packages", "GET", Summary = "Gets available packages")]
2014-11-30 12:01:33 -07:00
[Authenticated]
2017-08-19 12:43:35 -07:00
public class GetPackages : IReturn<PackageInfo[]>
2013-02-20 18:33:05 -07:00
{
}
/// <summary>
/// Class InstallPackage
/// </summary>
2014-03-23 13:07:02 -07:00
[Route("/Packages/Installed/{Name}", "POST", Summary = "Installs a package")]
2014-11-30 12:01:33 -07:00
[Authenticated(Roles = "Admin")]
2013-02-20 18:33:05 -07:00
public class InstallPackage : IReturnVoid
{
/// <summary>
/// Gets or sets the name.
/// </summary>
/// <value>The name.</value>
2013-03-08 12:14:09 -07:00
[ApiMember(Name = "Name", Description = "Package name", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
2013-02-20 18:33:05 -07:00
public string Name { get; set; }
/// <summary>
/// Gets or sets the name.
/// </summary>
/// <value>The name.</value>
[ApiMember(Name = "AssemblyGuid", Description = "Guid of the associated assembly", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
public string AssemblyGuid { get; set; }
2013-02-20 18:33:05 -07:00
/// <summary>
/// Gets or sets the version.
/// </summary>
/// <value>The version.</value>
2013-03-08 12:14:09 -07:00
[ApiMember(Name = "Version", Description = "Optional version. Defaults to latest version.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
2013-02-20 18:33:05 -07:00
public string Version { get; set; }
}
/// <summary>
/// Class CancelPackageInstallation
/// </summary>
2014-03-23 13:07:02 -07:00
[Route("/Packages/Installing/{Id}", "DELETE", Summary = "Cancels a package installation")]
2014-11-30 12:01:33 -07:00
[Authenticated(Roles = "Admin")]
2013-02-20 18:33:05 -07:00
public class CancelPackageInstallation : IReturnVoid
{
/// <summary>
/// Gets or sets the id.
/// </summary>
/// <value>The id.</value>
2013-03-08 12:14:09 -07:00
[ApiMember(Name = "Id", Description = "Installation Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")]
2014-05-08 13:09:53 -07:00
public string Id { get; set; }
2013-02-20 18:33:05 -07:00
}
/// <summary>
/// Class PackageService
/// </summary>
2013-03-15 22:52:33 -07:00
public class PackageService : BaseApiService
2013-02-20 18:33:05 -07:00
{
private readonly IInstallationManager _installationManager;
public PackageService(
ILogger<PackageService> logger,
IServerConfigurationManager serverConfigurationManager,
IHttpResultFactory httpResultFactory,
IInstallationManager installationManager)
: base(logger, serverConfigurationManager, httpResultFactory)
{
_installationManager = installationManager;
}
2013-02-21 21:23:06 -07:00
2013-02-20 18:33:05 -07:00
/// <summary>
/// Gets the specified request.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>System.Object.</returns>
public object Get(GetPackage request)
{
var packages = _installationManager.GetAvailablePackages().GetAwaiter().GetResult();
var result = _installationManager.FilterPackages(
packages,
request.Name,
string.IsNullOrEmpty(request.AssemblyGuid) ? default : Guid.Parse(request.AssemblyGuid)).FirstOrDefault();
2013-02-20 18:33:05 -07:00
return ToOptimizedResult(result);
}
/// <summary>
/// Gets the specified request.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>System.Object.</returns>
2015-01-09 22:53:35 -07:00
public async Task<object> Get(GetPackages request)
2013-02-20 18:33:05 -07:00
{
2019-10-08 11:51:11 -07:00
IEnumerable<PackageInfo> packages = await _installationManager.GetAvailablePackages().ConfigureAwait(false);
2013-02-20 18:33:05 -07:00
2017-08-19 12:43:35 -07:00
return ToOptimizedResult(packages.ToArray());
2013-02-20 18:33:05 -07:00
}
/// <summary>
/// Posts the specified request.
/// </summary>
/// <param name="request">The request.</param>
/// <exception cref="ResourceNotFoundException"></exception>
2018-09-12 10:26:21 -07:00
public async Task Post(InstallPackage request)
2013-02-20 18:33:05 -07:00
{
2019-10-08 11:51:11 -07:00
var packages = await _installationManager.GetAvailablePackages().ConfigureAwait(false);
var package = _installationManager.GetCompatibleVersions(
packages,
request.Name,
string.IsNullOrEmpty(request.AssemblyGuid) ? Guid.Empty : Guid.Parse(request.AssemblyGuid),
string.IsNullOrEmpty(request.Version) ? null : Version.Parse(request.Version)).FirstOrDefault();
2013-02-20 18:33:05 -07:00
if (package == null)
{
2019-10-08 11:51:11 -07:00
throw new ResourceNotFoundException(
string.Format(
CultureInfo.InvariantCulture,
"Package not found: {0}",
request.Name));
2013-02-20 18:33:05 -07:00
}
2019-08-11 06:57:36 -07:00
await _installationManager.InstallPackage(package);
2013-02-20 18:33:05 -07:00
}
/// <summary>
/// Deletes the specified request.
/// </summary>
/// <param name="request">The request.</param>
public void Delete(CancelPackageInstallation request)
{
2019-06-14 09:38:14 -07:00
_installationManager.CancelInstallation(new Guid(request.Id));
2013-02-20 18:33:05 -07:00
}
}
}