jellyfin/Emby.Server.Implementations/Updates/InstallationManager.cs

481 lines
18 KiB
C#
Raw Normal View History

using System;
2016-10-29 05:40:15 +00:00
using System.Collections.Concurrent;
using System.Collections.Generic;
2019-09-28 19:06:58 +00:00
using System.Globalization;
2016-10-29 05:40:15 +00:00
using System.IO;
using System.Linq;
2019-06-14 16:38:14 +00:00
using System.Net.Http;
using System.Security.Cryptography;
2016-10-29 05:40:15 +00:00
using System.Threading;
using System.Threading.Tasks;
using MediaBrowser.Common;
using MediaBrowser.Common.Configuration;
2013-02-21 01:33:05 +00:00
using MediaBrowser.Common.Net;
using MediaBrowser.Common.Plugins;
using MediaBrowser.Common.Updates;
using MediaBrowser.Controller.Configuration;
2014-05-08 20:09:53 +00:00
using MediaBrowser.Model.Events;
2016-10-29 05:40:15 +00:00
using MediaBrowser.Model.IO;
2013-02-24 21:53:54 +00:00
using MediaBrowser.Model.Serialization;
2013-02-21 01:33:05 +00:00
using MediaBrowser.Model.Updates;
using Microsoft.Extensions.Logging;
2013-02-21 01:33:05 +00:00
namespace Emby.Server.Implementations.Updates
2013-02-21 01:33:05 +00:00
{
/// <summary>
/// Manages all install, uninstall and update operations (both plugins and system).
2013-02-21 01:33:05 +00:00
/// </summary>
public class InstallationManager : IInstallationManager
2013-02-21 01:33:05 +00:00
{
/// <summary>
/// The _logger.
2013-02-21 21:39:53 +00:00
/// </summary>
private readonly ILogger _logger;
2013-08-07 19:15:55 +00:00
private readonly IApplicationPaths _appPaths;
private readonly IHttpClient _httpClient;
private readonly IJsonSerializer _jsonSerializer;
2018-09-12 17:26:21 +00:00
private readonly IServerConfigurationManager _config;
private readonly IFileSystem _fileSystem;
2013-02-25 00:13:45 +00:00
/// <summary>
/// Gets the application host.
/// </summary>
/// <value>The application host.</value>
2013-08-07 19:15:55 +00:00
private readonly IApplicationHost _applicationHost;
private readonly IZipClient _zipClient;
private readonly object _currentInstallationsLock = new object();
/// <summary>
/// The current installations.
/// </summary>
2019-11-07 09:55:02 +00:00
private readonly List<(InstallationInfo info, CancellationTokenSource token)> _currentInstallations;
/// <summary>
/// The completed installations.
/// </summary>
2019-11-07 09:55:02 +00:00
private readonly ConcurrentBag<InstallationInfo> _completedInstallationsInternal;
public InstallationManager(
2019-06-14 16:38:14 +00:00
ILogger<InstallationManager> logger,
IApplicationHost appHost,
IApplicationPaths appPaths,
IHttpClient httpClient,
2019-01-12 18:52:59 +00:00
IJsonSerializer jsonSerializer,
IServerConfigurationManager config,
IFileSystem fileSystem,
IZipClient zipClient)
2013-02-21 01:33:05 +00:00
{
2019-06-14 16:38:14 +00:00
if (logger == null)
{
2019-06-14 16:38:14 +00:00
throw new ArgumentNullException(nameof(logger));
}
2013-02-24 21:53:54 +00:00
2019-06-14 16:38:14 +00:00
_currentInstallations = new List<(InstallationInfo, CancellationTokenSource)>();
_completedInstallationsInternal = new ConcurrentBag<InstallationInfo>();
2013-08-07 19:15:55 +00:00
2019-06-14 16:38:14 +00:00
_logger = logger;
2013-08-07 19:15:55 +00:00
_applicationHost = appHost;
_appPaths = appPaths;
_httpClient = httpClient;
_jsonSerializer = jsonSerializer;
2013-08-30 14:05:44 +00:00
_config = config;
_fileSystem = fileSystem;
_zipClient = zipClient;
2013-02-21 01:33:05 +00:00
}
2019-11-07 09:55:02 +00:00
/// <inheritdoc />
public event EventHandler<InstallationEventArgs> PackageInstalling;
2019-11-07 09:55:02 +00:00
/// <inheritdoc />
public event EventHandler<InstallationEventArgs> PackageInstallationCompleted;
2019-11-07 09:55:02 +00:00
/// <inheritdoc />
public event EventHandler<InstallationFailedEventArgs> PackageInstallationFailed;
2019-11-07 09:55:02 +00:00
/// <inheritdoc />
public event EventHandler<InstallationEventArgs> PackageInstallationCancelled;
2019-11-07 09:55:02 +00:00
/// <inheritdoc />
public event EventHandler<GenericEventArgs<IPlugin>> PluginUninstalled;
2019-11-07 09:55:02 +00:00
/// <inheritdoc />
public event EventHandler<GenericEventArgs<(IPlugin, PackageVersionInfo)>> PluginUpdated;
2019-11-07 09:55:02 +00:00
/// <inheritdoc />
public event EventHandler<GenericEventArgs<PackageVersionInfo>> PluginInstalled;
2019-11-07 09:55:02 +00:00
/// <inheritdoc />
public IEnumerable<InstallationInfo> CompletedInstallations => _completedInstallationsInternal;
2019-10-08 18:51:11 +00:00
/// <inheritdoc />
public async Task<IReadOnlyList<PackageInfo>> GetAvailablePackages(CancellationToken cancellationToken = default)
{
using (var response = await _httpClient.SendAsync(
new HttpRequestOptions
{
Url = "https://repo.jellyfin.org/releases/plugin/manifest.json",
CancellationToken = cancellationToken,
CacheMode = CacheMode.Unconditional,
2019-10-08 18:51:11 +00:00
CacheLength = TimeSpan.FromMinutes(3)
},
HttpMethod.Get).ConfigureAwait(false))
using (Stream stream = response.Content)
2016-01-02 21:54:37 +00:00
{
2019-10-08 18:51:11 +00:00
return await _jsonSerializer.DeserializeFromStreamAsync<IReadOnlyList<PackageInfo>>(
stream).ConfigureAwait(false);
2016-01-02 21:54:37 +00:00
}
}
2019-10-08 18:51:11 +00:00
/// <inheritdoc />
public IEnumerable<PackageInfo> FilterPackages(
IEnumerable<PackageInfo> availablePackages,
string name = null,
Guid guid = default)
2013-09-30 01:29:38 +00:00
{
2019-10-08 18:51:11 +00:00
if (name != null)
2013-09-30 01:29:38 +00:00
{
2019-10-08 18:51:11 +00:00
availablePackages = availablePackages.Where(x => x.name.Equals(name, StringComparison.OrdinalIgnoreCase));
2013-09-30 01:29:38 +00:00
}
2019-10-08 18:51:11 +00:00
if (guid != Guid.Empty)
{
2019-10-08 18:51:11 +00:00
var strGuid = guid.ToString("N", CultureInfo.InvariantCulture);
availablePackages = availablePackages.Where(x => x.guid.Equals(strGuid, StringComparison.OrdinalIgnoreCase));
2017-08-24 19:52:19 +00:00
}
2017-08-20 19:10:00 +00:00
2019-10-08 18:51:11 +00:00
return availablePackages;
2013-02-21 01:33:05 +00:00
}
2019-10-11 16:08:41 +00:00
/// <inheritdoc />
2019-10-08 18:51:11 +00:00
public IEnumerable<PackageVersionInfo> GetCompatibleVersions(
IEnumerable<PackageVersionInfo> availableVersions,
Version minVersion = null,
PackageVersionClass classification = PackageVersionClass.Release)
2013-02-21 01:33:05 +00:00
{
2019-10-08 18:51:11 +00:00
var appVer = _applicationHost.ApplicationVersion;
2019-10-11 16:08:41 +00:00
availableVersions = availableVersions
.Where(x => x.classification == classification
&& Version.Parse(x.requiredVersionStr) <= appVer);
2019-10-08 18:51:11 +00:00
if (minVersion != null)
2013-02-21 01:33:05 +00:00
{
2019-10-08 18:51:11 +00:00
availableVersions = availableVersions.Where(x => x.Version >= minVersion);
2013-02-21 01:33:05 +00:00
}
2019-10-11 16:08:41 +00:00
return availableVersions.OrderByDescending(x => x.Version);
2013-02-21 01:33:05 +00:00
}
2019-10-08 18:51:11 +00:00
/// <inheritdoc />
public IEnumerable<PackageVersionInfo> GetCompatibleVersions(
IEnumerable<PackageInfo> availablePackages,
string name = null,
Guid guid = default,
Version minVersion = null,
PackageVersionClass classification = PackageVersionClass.Release)
2013-02-21 01:33:05 +00:00
{
2019-10-08 18:51:11 +00:00
var package = FilterPackages(availablePackages, name, guid).FirstOrDefault();
2013-02-21 01:33:05 +00:00
2019-10-08 18:51:11 +00:00
// Package not found.
2013-02-21 01:33:05 +00:00
if (package == null)
{
return Enumerable.Empty<PackageVersionInfo>();
2013-02-21 01:33:05 +00:00
}
2019-10-08 18:51:11 +00:00
return GetCompatibleVersions(
package.versions,
minVersion,
classification);
2013-02-21 01:33:05 +00:00
}
2019-10-08 18:51:11 +00:00
/// <inheritdoc />
public async IAsyncEnumerable<PackageVersionInfo> GetAvailablePluginUpdates(CancellationToken cancellationToken = default)
{
2019-10-08 18:51:11 +00:00
var catalog = await GetAvailablePackages(cancellationToken).ConfigureAwait(false);
2017-08-19 19:43:35 +00:00
2019-06-14 16:38:14 +00:00
var systemUpdateLevel = _applicationHost.SystemUpdateLevel;
2017-04-10 01:51:36 +00:00
2013-02-21 01:33:05 +00:00
// Figure out what needs to be installed
foreach (var plugin in _applicationHost.Plugins)
2013-02-21 01:33:05 +00:00
{
var compatibleversions = GetCompatibleVersions(catalog, plugin.Name, plugin.Id, plugin.Version, systemUpdateLevel);
var version = compatibleversions.FirstOrDefault(y => y.Version > plugin.Version);
if (version != null
&& !CompletedInstallations.Any(x => string.Equals(x.AssemblyGuid, version.guid, StringComparison.OrdinalIgnoreCase)))
{
yield return version;
}
}
2013-02-21 01:33:05 +00:00
}
/// <inheritdoc />
public async Task InstallPackage(PackageVersionInfo package, CancellationToken cancellationToken)
2013-02-21 01:33:05 +00:00
{
if (package == null)
{
throw new ArgumentNullException(nameof(package));
2013-02-21 01:33:05 +00:00
}
var installationInfo = new InstallationInfo
{
2018-09-12 17:26:21 +00:00
Id = Guid.NewGuid(),
2013-02-21 01:33:05 +00:00
Name = package.name,
AssemblyGuid = package.guid,
2013-02-21 01:33:05 +00:00
UpdateClass = package.classification,
Version = package.versionStr
};
var innerCancellationTokenSource = new CancellationTokenSource();
2019-06-14 16:38:14 +00:00
var tuple = (installationInfo, innerCancellationTokenSource);
2013-02-24 21:53:54 +00:00
2013-02-21 01:33:05 +00:00
// Add it to the in-progress list
lock (_currentInstallationsLock)
2013-02-21 01:33:05 +00:00
{
2019-06-14 16:38:14 +00:00
_currentInstallations.Add(tuple);
2013-02-21 01:33:05 +00:00
}
var linkedToken = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken, innerCancellationTokenSource.Token).Token;
2013-07-06 21:23:32 +00:00
var installationEventArgs = new InstallationEventArgs
{
InstallationInfo = installationInfo,
PackageVersionInfo = package
};
PackageInstalling?.Invoke(this, installationEventArgs);
2013-02-21 01:33:05 +00:00
try
{
await InstallPackageInternal(package, linkedToken).ConfigureAwait(false);
2013-02-21 01:33:05 +00:00
lock (_currentInstallationsLock)
2013-02-21 01:33:05 +00:00
{
2019-06-14 16:38:14 +00:00
_currentInstallations.Remove(tuple);
2013-02-21 01:33:05 +00:00
}
_completedInstallationsInternal.Add(installationInfo);
2013-02-21 01:33:05 +00:00
PackageInstallationCompleted?.Invoke(this, installationEventArgs);
2013-02-21 01:33:05 +00:00
}
catch (OperationCanceledException)
{
lock (_currentInstallationsLock)
2013-02-21 01:33:05 +00:00
{
2019-06-14 16:38:14 +00:00
_currentInstallations.Remove(tuple);
2013-02-21 01:33:05 +00:00
}
_logger.LogInformation("Package installation cancelled: {0} {1}", package.name, package.versionStr);
2013-02-21 01:33:05 +00:00
PackageInstallationCancelled?.Invoke(this, installationEventArgs);
2013-02-24 21:53:54 +00:00
2013-02-21 01:33:05 +00:00
throw;
}
catch (Exception ex)
2013-02-21 01:33:05 +00:00
{
2018-12-20 12:11:26 +00:00
_logger.LogError(ex, "Package installation failed");
lock (_currentInstallationsLock)
2013-02-21 01:33:05 +00:00
{
2019-06-14 16:38:14 +00:00
_currentInstallations.Remove(tuple);
2013-02-21 01:33:05 +00:00
}
2013-02-24 21:53:54 +00:00
PackageInstallationFailed?.Invoke(this, new InstallationFailedEventArgs
2013-07-06 21:23:32 +00:00
{
InstallationInfo = installationInfo,
Exception = ex
});
2013-02-21 01:33:05 +00:00
throw;
}
finally
{
// Dispose the progress object and remove the installation from the in-progress list
2019-10-08 18:51:11 +00:00
tuple.innerCancellationTokenSource.Dispose();
2013-02-21 01:33:05 +00:00
}
}
/// <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(PackageVersionInfo package, CancellationToken cancellationToken)
2013-02-21 01:33:05 +00:00
{
2019-06-14 16:38:14 +00:00
// Set last update time if we were installed before
IPlugin plugin = _applicationHost.Plugins.FirstOrDefault(p => string.Equals(p.Id.ToString(), package.guid, StringComparison.OrdinalIgnoreCase))
2018-09-12 17:26:21 +00:00
?? _applicationHost.Plugins.FirstOrDefault(p => p.Name.Equals(package.name, StringComparison.OrdinalIgnoreCase));
2019-06-14 16:38:14 +00:00
2018-09-12 17:26:21 +00:00
// Do the install
await PerformPackageInstallation(package, cancellationToken).ConfigureAwait(false);
2018-09-12 17:26:21 +00:00
// Do plugin-specific processing
2019-06-14 16:38:14 +00:00
if (plugin == null)
2018-09-12 17:26:21 +00:00
{
2019-06-14 16:38:14 +00:00
_logger.LogInformation("New plugin installed: {0} {1} {2}", package.name, package.versionStr ?? string.Empty, package.classification);
PluginInstalled?.Invoke(this, new GenericEventArgs<PackageVersionInfo>(package));
2013-02-21 01:33:05 +00:00
}
2019-06-14 16:38:14 +00:00
else
{
_logger.LogInformation("Plugin updated: {0} {1} {2}", package.name, package.versionStr ?? string.Empty, package.classification);
PluginUpdated?.Invoke(this, new GenericEventArgs<(IPlugin, PackageVersionInfo)>((plugin, package)));
}
_applicationHost.NotifyPendingRestart();
2013-02-21 01:33:05 +00:00
}
private async Task PerformPackageInstallation(PackageVersionInfo package, CancellationToken cancellationToken)
2013-08-07 19:15:55 +00:00
{
var extension = Path.GetExtension(package.targetFilename);
if (!string.Equals(extension, ".zip", StringComparison.OrdinalIgnoreCase))
{
_logger.LogError("Only zip packages are supported. {Filename} is not a zip archive.", package.targetFilename);
return;
}
2019-02-11 17:53:35 +00:00
// Always override the passed-in target (which is a file) and figure it out again
string targetDir = Path.Combine(_appPaths.PluginsPath, package.name);
2013-08-07 19:15:55 +00:00
// 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())
2013-08-07 19:15:55 +00:00
{
cancellationToken.ThrowIfCancellationRequested();
2013-08-07 19:15:55 +00:00
2019-10-18 22:22:08 +00:00
var hash = Hex.Encode(md5.ComputeHash(stream));
if (!string.Equals(package.checksum, hash, StringComparison.OrdinalIgnoreCase))
{
2019-09-28 19:06:58 +00:00
_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))
{
2019-09-28 19:06:58 +00:00
Directory.Delete(targetDir, true);
2013-08-07 19:15:55 +00:00
}
stream.Position = 0;
_zipClient.ExtractAllFromZip(stream, targetDir, true);
2013-08-07 19:15:55 +00:00
}
#pragma warning restore CA5351
2013-08-07 19:15:55 +00:00
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Uninstalls a plugin
/// </summary>
/// <param name="plugin">The plugin.</param>
public void UninstallPlugin(IPlugin plugin)
{
plugin.OnUninstalling();
// Remove it the quick way for now
2013-08-07 19:15:55 +00:00
_applicationHost.RemovePlugin(plugin);
2013-02-21 01:33:05 +00:00
2017-05-08 18:06:36 +00:00
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;
}
2016-12-17 20:52:05 +00:00
2017-05-08 18:06:36 +00:00
// Make this case-insensitive to account for possible incorrect assembly naming
var file = _fileSystem.GetFilePaths(Path.GetDirectoryName(path))
2017-05-08 18:06:36 +00:00
.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);
}
2013-02-21 01:33:05 +00:00
2018-09-12 17:26:21 +00:00
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();
}
2019-06-14 16:38:14 +00:00
PluginUninstalled?.Invoke(this, new GenericEventArgs<IPlugin> { Argument = plugin });
2013-02-21 01:33:05 +00:00
2013-08-07 19:15:55 +00:00
_applicationHost.NotifyPendingRestart();
2013-02-21 01:33:05 +00:00
}
2019-06-14 16:38:14 +00:00
/// <inheritdoc/>
public bool CancelInstallation(Guid id)
{
lock (_currentInstallationsLock)
2019-06-14 16:38:14 +00:00
{
2019-10-08 18:51:11 +00:00
var install = _currentInstallations.Find(x => x.info.Id == id);
2019-06-14 16:38:14 +00:00
if (install == default((InstallationInfo, CancellationTokenSource)))
{
return false;
}
2019-10-08 18:51:11 +00:00
install.token.Cancel();
2019-06-14 16:38:14 +00:00
_currentInstallations.Remove(install);
return true;
}
}
2019-10-08 18:51:11 +00:00
/// <inheritdoc />
2019-06-14 16:38:14 +00:00
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Releases unmanaged and - optionally - managed resources.
/// </summary>
/// <param name="dispose"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
protected virtual void Dispose(bool dispose)
2013-02-21 01:33:05 +00:00
{
if (dispose)
{
lock (_currentInstallationsLock)
2013-02-21 01:33:05 +00:00
{
2019-06-14 16:38:14 +00:00
foreach (var tuple in _currentInstallations)
2013-02-21 01:33:05 +00:00
{
2019-10-08 18:51:11 +00:00
tuple.token.Dispose();
2013-02-21 01:33:05 +00:00
}
2019-06-14 16:38:14 +00:00
_currentInstallations.Clear();
2013-02-21 01:33:05 +00:00
}
}
}
2013-02-21 01:33:05 +00:00
}
}