502 lines
18 KiB
C#
502 lines
18 KiB
C#
#pragma warning disable CS1591
|
|
|
|
using System;
|
|
using System.Collections.Concurrent;
|
|
using System.Collections.Generic;
|
|
using System.IO;
|
|
using System.Linq;
|
|
using System.Net.Http;
|
|
using System.Runtime.Serialization;
|
|
using System.Security.Cryptography;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
using MediaBrowser.Common;
|
|
using MediaBrowser.Common.Configuration;
|
|
using MediaBrowser.Common.Net;
|
|
using MediaBrowser.Common.Plugins;
|
|
using MediaBrowser.Common.Updates;
|
|
using MediaBrowser.Controller.Configuration;
|
|
using MediaBrowser.Model.IO;
|
|
using MediaBrowser.Model.Net;
|
|
using MediaBrowser.Model.Serialization;
|
|
using MediaBrowser.Model.Updates;
|
|
using Microsoft.Extensions.Logging;
|
|
|
|
namespace Emby.Server.Implementations.Updates
|
|
{
|
|
/// <summary>
|
|
/// Manages all install, uninstall, and update operations for the system and individual plugins.
|
|
/// </summary>
|
|
public class InstallationManager : IInstallationManager
|
|
{
|
|
/// <summary>
|
|
/// The logger.
|
|
/// </summary>
|
|
private readonly ILogger<InstallationManager> _logger;
|
|
private readonly IApplicationPaths _appPaths;
|
|
private readonly IHttpClient _httpClient;
|
|
private readonly IJsonSerializer _jsonSerializer;
|
|
private readonly IServerConfigurationManager _config;
|
|
private readonly IFileSystem _fileSystem;
|
|
|
|
/// <summary>
|
|
/// Gets the application host.
|
|
/// </summary>
|
|
/// <value>The application host.</value>
|
|
private readonly IApplicationHost _applicationHost;
|
|
|
|
private readonly IZipClient _zipClient;
|
|
|
|
private readonly object _currentInstallationsLock = new object();
|
|
|
|
/// <summary>
|
|
/// The current installations.
|
|
/// </summary>
|
|
private readonly List<(InstallationInfo info, CancellationTokenSource token)> _currentInstallations;
|
|
|
|
/// <summary>
|
|
/// The completed installations.
|
|
/// </summary>
|
|
private readonly ConcurrentBag<InstallationInfo> _completedInstallationsInternal;
|
|
|
|
public InstallationManager(
|
|
ILogger<InstallationManager> logger,
|
|
IApplicationHost appHost,
|
|
IApplicationPaths appPaths,
|
|
IHttpClient httpClient,
|
|
IJsonSerializer jsonSerializer,
|
|
IServerConfigurationManager config,
|
|
IFileSystem fileSystem,
|
|
IZipClient zipClient)
|
|
{
|
|
if (logger == null)
|
|
{
|
|
throw new ArgumentNullException(nameof(logger));
|
|
}
|
|
|
|
_currentInstallations = new List<(InstallationInfo, CancellationTokenSource)>();
|
|
_completedInstallationsInternal = new ConcurrentBag<InstallationInfo>();
|
|
|
|
_logger = logger;
|
|
_applicationHost = appHost;
|
|
_appPaths = appPaths;
|
|
_httpClient = httpClient;
|
|
_jsonSerializer = jsonSerializer;
|
|
_config = config;
|
|
_fileSystem = fileSystem;
|
|
_zipClient = zipClient;
|
|
}
|
|
|
|
/// <inheritdoc />
|
|
public event EventHandler<InstallationInfo> PackageInstalling;
|
|
|
|
/// <inheritdoc />
|
|
public event EventHandler<InstallationInfo> PackageInstallationCompleted;
|
|
|
|
/// <inheritdoc />
|
|
public event EventHandler<InstallationFailedEventArgs> PackageInstallationFailed;
|
|
|
|
/// <inheritdoc />
|
|
public event EventHandler<InstallationInfo> PackageInstallationCancelled;
|
|
|
|
/// <inheritdoc />
|
|
public event EventHandler<IPlugin> PluginUninstalled;
|
|
|
|
/// <inheritdoc />
|
|
public event EventHandler<InstallationInfo> PluginUpdated;
|
|
|
|
/// <inheritdoc />
|
|
public event EventHandler<InstallationInfo> PluginInstalled;
|
|
|
|
/// <inheritdoc />
|
|
public IEnumerable<InstallationInfo> CompletedInstallations => _completedInstallationsInternal;
|
|
|
|
/// <inheritdoc />
|
|
public async Task<IReadOnlyList<PackageInfo>> GetPackages(string manifest, CancellationToken cancellationToken = default)
|
|
{
|
|
try
|
|
{
|
|
using (var response = await _httpClient.SendAsync(
|
|
new HttpRequestOptions
|
|
{
|
|
Url = manifest,
|
|
CancellationToken = cancellationToken,
|
|
CacheMode = CacheMode.Unconditional,
|
|
CacheLength = TimeSpan.FromMinutes(3)
|
|
},
|
|
HttpMethod.Get).ConfigureAwait(false))
|
|
using (Stream stream = response.Content)
|
|
{
|
|
try
|
|
{
|
|
return await _jsonSerializer.DeserializeFromStreamAsync<IReadOnlyList<PackageInfo>>(stream).ConfigureAwait(false);
|
|
}
|
|
catch (SerializationException ex)
|
|
{
|
|
_logger.LogError(ex, "Failed to deserialize the plugin manifest retrieved from {Manifest}", manifest);
|
|
return Array.Empty<PackageInfo>();
|
|
}
|
|
}
|
|
}
|
|
catch (UriFormatException ex)
|
|
{
|
|
_logger.LogError(ex, "The URL configured for the plugin repository manifest URL is not valid: {Manifest}", manifest);
|
|
return Array.Empty<PackageInfo>();
|
|
}
|
|
catch (HttpException ex)
|
|
{
|
|
_logger.LogError(ex, "An error occurred while accessing the plugin manifest: {Manifest}", manifest);
|
|
return Array.Empty<PackageInfo>();
|
|
}
|
|
}
|
|
|
|
/// <inheritdoc />
|
|
public async Task<IReadOnlyList<PackageInfo>> GetAvailablePackages(CancellationToken cancellationToken = default)
|
|
{
|
|
var result = new List<PackageInfo>();
|
|
foreach (RepositoryInfo repository in _config.Configuration.PluginRepositories)
|
|
{
|
|
result.AddRange(await GetPackages(repository.Url, cancellationToken).ConfigureAwait(true));
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
/// <inheritdoc />
|
|
public IEnumerable<PackageInfo> FilterPackages(
|
|
IEnumerable<PackageInfo> availablePackages,
|
|
string name = null,
|
|
Guid guid = default)
|
|
{
|
|
if (name != null)
|
|
{
|
|
availablePackages = availablePackages.Where(x => x.name.Equals(name, StringComparison.OrdinalIgnoreCase));
|
|
}
|
|
|
|
if (guid != Guid.Empty)
|
|
{
|
|
availablePackages = availablePackages.Where(x => Guid.Parse(x.guid) == guid);
|
|
}
|
|
|
|
return availablePackages;
|
|
}
|
|
|
|
/// <inheritdoc />
|
|
public IEnumerable<InstallationInfo> GetCompatibleVersions(
|
|
IEnumerable<PackageInfo> availablePackages,
|
|
string name = null,
|
|
Guid guid = default,
|
|
Version minVersion = null)
|
|
{
|
|
var package = FilterPackages(availablePackages, name, guid).FirstOrDefault();
|
|
|
|
// Package not found in repository
|
|
if (package == null)
|
|
{
|
|
yield break;
|
|
}
|
|
|
|
var appVer = _applicationHost.ApplicationVersion;
|
|
var availableVersions = package.versions
|
|
.Where(x => Version.Parse(x.targetAbi) <= appVer);
|
|
|
|
if (minVersion != null)
|
|
{
|
|
availableVersions = availableVersions.Where(x => new Version(x.version) >= minVersion);
|
|
}
|
|
|
|
foreach (var v in availableVersions.OrderByDescending(x => x.version))
|
|
{
|
|
yield return new InstallationInfo
|
|
{
|
|
Changelog = v.changelog,
|
|
Guid = new Guid(package.guid),
|
|
Name = package.name,
|
|
Version = new Version(v.version),
|
|
SourceUrl = v.sourceUrl,
|
|
Checksum = v.checksum
|
|
};
|
|
}
|
|
}
|
|
|
|
/// <inheritdoc />
|
|
public async Task<IEnumerable<InstallationInfo>> GetAvailablePluginUpdates(CancellationToken cancellationToken = default)
|
|
{
|
|
var catalog = await GetAvailablePackages(cancellationToken).ConfigureAwait(false);
|
|
return GetAvailablePluginUpdates(catalog);
|
|
}
|
|
|
|
private IEnumerable<InstallationInfo> GetAvailablePluginUpdates(IReadOnlyList<PackageInfo> pluginCatalog)
|
|
{
|
|
foreach (var plugin in _applicationHost.Plugins)
|
|
{
|
|
var compatibleversions = GetCompatibleVersions(pluginCatalog, plugin.Name, plugin.Id, plugin.Version);
|
|
var version = compatibleversions.FirstOrDefault(y => y.Version > plugin.Version);
|
|
if (version != null && CompletedInstallations.All(x => x.Guid != version.Guid))
|
|
{
|
|
yield return version;
|
|
}
|
|
}
|
|
}
|
|
|
|
/// <inheritdoc />
|
|
public async Task InstallPackage(InstallationInfo package, CancellationToken cancellationToken)
|
|
{
|
|
if (package == null)
|
|
{
|
|
throw new ArgumentNullException(nameof(package));
|
|
}
|
|
|
|
var innerCancellationTokenSource = new CancellationTokenSource();
|
|
|
|
var tuple = (package, innerCancellationTokenSource);
|
|
|
|
// Add it to the in-progress list
|
|
lock (_currentInstallationsLock)
|
|
{
|
|
_currentInstallations.Add(tuple);
|
|
}
|
|
|
|
var linkedToken = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken, innerCancellationTokenSource.Token).Token;
|
|
|
|
PackageInstalling?.Invoke(this, package);
|
|
|
|
try
|
|
{
|
|
await InstallPackageInternal(package, linkedToken).ConfigureAwait(false);
|
|
|
|
lock (_currentInstallationsLock)
|
|
{
|
|
_currentInstallations.Remove(tuple);
|
|
}
|
|
|
|
_completedInstallationsInternal.Add(package);
|
|
|
|
PackageInstallationCompleted?.Invoke(this, package);
|
|
}
|
|
catch (OperationCanceledException)
|
|
{
|
|
lock (_currentInstallationsLock)
|
|
{
|
|
_currentInstallations.Remove(tuple);
|
|
}
|
|
|
|
_logger.LogInformation("Package installation cancelled: {0} {1}", package.Name, package.Version);
|
|
|
|
PackageInstallationCancelled?.Invoke(this, package);
|
|
|
|
throw;
|
|
}
|
|
catch (Exception ex)
|
|
{
|
|
_logger.LogError(ex, "Package installation failed");
|
|
|
|
lock (_currentInstallationsLock)
|
|
{
|
|
_currentInstallations.Remove(tuple);
|
|
}
|
|
|
|
PackageInstallationFailed?.Invoke(this, new InstallationFailedEventArgs
|
|
{
|
|
InstallationInfo = package,
|
|
Exception = ex
|
|
});
|
|
|
|
throw;
|
|
}
|
|
finally
|
|
{
|
|
// Dispose the progress object and remove the installation from the in-progress list
|
|
tuple.innerCancellationTokenSource.Dispose();
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Installs the package internal.
|
|
/// </summary>
|
|
/// <param name="package">The package.</param>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <returns><see cref="Task" />.</returns>
|
|
private async Task InstallPackageInternal(InstallationInfo package, CancellationToken cancellationToken)
|
|
{
|
|
// Set last update time if we were installed before
|
|
IPlugin plugin = _applicationHost.Plugins.FirstOrDefault(p => p.Id == package.Guid)
|
|
?? _applicationHost.Plugins.FirstOrDefault(p => p.Name.Equals(package.Name, StringComparison.OrdinalIgnoreCase));
|
|
|
|
// Do the install
|
|
await PerformPackageInstallation(package, cancellationToken).ConfigureAwait(false);
|
|
|
|
// Do plugin-specific processing
|
|
if (plugin == null)
|
|
{
|
|
_logger.LogInformation("New plugin installed: {0} {1}", package.Name, package.Version);
|
|
|
|
PluginInstalled?.Invoke(this, package);
|
|
}
|
|
else
|
|
{
|
|
_logger.LogInformation("Plugin updated: {0} {1}", package.Name, package.Version);
|
|
|
|
PluginUpdated?.Invoke(this, package);
|
|
}
|
|
|
|
_applicationHost.NotifyPendingRestart();
|
|
}
|
|
|
|
private async Task PerformPackageInstallation(InstallationInfo package, CancellationToken cancellationToken)
|
|
{
|
|
var extension = Path.GetExtension(package.SourceUrl);
|
|
if (!string.Equals(extension, ".zip", StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
_logger.LogError("Only zip packages are supported. {SourceUrl} is not a zip archive.", package.SourceUrl);
|
|
return;
|
|
}
|
|
|
|
// Always override the passed-in target (which is a file) and figure it out again
|
|
string targetDir = Path.Combine(_appPaths.PluginsPath, package.Name);
|
|
|
|
// CA5351: Do Not Use Broken Cryptographic Algorithms
|
|
#pragma warning disable CA5351
|
|
using (var res = await _httpClient.SendAsync(
|
|
new HttpRequestOptions
|
|
{
|
|
Url = package.SourceUrl,
|
|
CancellationToken = cancellationToken,
|
|
// We need it to be buffered for setting the position
|
|
BufferContent = true
|
|
},
|
|
HttpMethod.Get).ConfigureAwait(false))
|
|
using (var stream = res.Content)
|
|
using (var md5 = MD5.Create())
|
|
{
|
|
cancellationToken.ThrowIfCancellationRequested();
|
|
|
|
var hash = Hex.Encode(md5.ComputeHash(stream));
|
|
if (!string.Equals(package.Checksum, hash, StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
_logger.LogError(
|
|
"The checksums didn't match while installing {Package}, expected: {Expected}, got: {Received}",
|
|
package.Name,
|
|
package.Checksum,
|
|
hash);
|
|
throw new InvalidDataException("The checksum of the received data doesn't match.");
|
|
}
|
|
|
|
if (Directory.Exists(targetDir))
|
|
{
|
|
Directory.Delete(targetDir, true);
|
|
}
|
|
|
|
stream.Position = 0;
|
|
_zipClient.ExtractAllFromZip(stream, targetDir, true);
|
|
}
|
|
|
|
#pragma warning restore CA5351
|
|
}
|
|
|
|
/// <summary>
|
|
/// Uninstalls a plugin.
|
|
/// </summary>
|
|
/// <param name="plugin">The plugin.</param>
|
|
public void UninstallPlugin(IPlugin plugin)
|
|
{
|
|
if (!plugin.CanUninstall)
|
|
{
|
|
_logger.LogWarning("Attempt to delete non removable plugin {0}, ignoring request", plugin.Name);
|
|
return;
|
|
}
|
|
|
|
plugin.OnUninstalling();
|
|
|
|
// Remove it the quick way for now
|
|
_applicationHost.RemovePlugin(plugin);
|
|
|
|
var path = plugin.AssemblyFilePath;
|
|
bool isDirectory = false;
|
|
// Check if we have a plugin directory we should remove too
|
|
if (Path.GetDirectoryName(plugin.AssemblyFilePath) != _appPaths.PluginsPath)
|
|
{
|
|
path = Path.GetDirectoryName(plugin.AssemblyFilePath);
|
|
isDirectory = true;
|
|
}
|
|
|
|
// Make this case-insensitive to account for possible incorrect assembly naming
|
|
var file = _fileSystem.GetFilePaths(Path.GetDirectoryName(path))
|
|
.FirstOrDefault(i => string.Equals(i, path, StringComparison.OrdinalIgnoreCase));
|
|
|
|
if (!string.IsNullOrWhiteSpace(file))
|
|
{
|
|
path = file;
|
|
}
|
|
|
|
if (isDirectory)
|
|
{
|
|
_logger.LogInformation("Deleting plugin directory {0}", path);
|
|
Directory.Delete(path, true);
|
|
}
|
|
else
|
|
{
|
|
_logger.LogInformation("Deleting plugin file {0}", path);
|
|
_fileSystem.DeleteFile(path);
|
|
}
|
|
|
|
var list = _config.Configuration.UninstalledPlugins.ToList();
|
|
var filename = Path.GetFileName(path);
|
|
if (!list.Contains(filename, StringComparer.OrdinalIgnoreCase))
|
|
{
|
|
list.Add(filename);
|
|
_config.Configuration.UninstalledPlugins = list.ToArray();
|
|
_config.SaveConfiguration();
|
|
}
|
|
|
|
PluginUninstalled?.Invoke(this, plugin);
|
|
|
|
_applicationHost.NotifyPendingRestart();
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
public bool CancelInstallation(Guid id)
|
|
{
|
|
lock (_currentInstallationsLock)
|
|
{
|
|
var install = _currentInstallations.Find(x => x.info.Guid == id);
|
|
if (install == default((InstallationInfo, CancellationTokenSource)))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
install.token.Cancel();
|
|
_currentInstallations.Remove(install);
|
|
return true;
|
|
}
|
|
}
|
|
|
|
/// <inheritdoc />
|
|
public void Dispose()
|
|
{
|
|
Dispose(true);
|
|
GC.SuppressFinalize(this);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Releases unmanaged and optionally managed resources.
|
|
/// </summary>
|
|
/// <param name="dispose"><c>true</c> to release both managed and unmanaged resources or <c>false</c> to release only unmanaged resources.</param>
|
|
protected virtual void Dispose(bool dispose)
|
|
{
|
|
if (dispose)
|
|
{
|
|
lock (_currentInstallationsLock)
|
|
{
|
|
foreach (var tuple in _currentInstallations)
|
|
{
|
|
tuple.token.Dispose();
|
|
}
|
|
|
|
_currentInstallations.Clear();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|