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

696 lines
27 KiB
C#
Raw Normal View History

2016-10-29 05:40:15 +00:00
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using MediaBrowser.Common;
using MediaBrowser.Common.Configuration;
2013-08-07 19:15:55 +00:00
using MediaBrowser.Common.Events;
2013-02-21 01:33:05 +00:00
using MediaBrowser.Common.Net;
using MediaBrowser.Common.Plugins;
using MediaBrowser.Common.Progress;
2013-08-07 19:15:55 +00:00
using MediaBrowser.Common.Security;
using MediaBrowser.Common.Updates;
using MediaBrowser.Model.Cryptography;
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-21 21:39:53 +00:00
using MediaBrowser.Model.Logging;
2013-02-24 21:53:54 +00:00
using MediaBrowser.Model.Serialization;
2013-02-21 01:33:05 +00:00
using MediaBrowser.Model.Updates;
2018-09-12 17:26:21 +00:00
using MediaBrowser.Controller.Configuration;
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)
/// </summary>
public class InstallationManager : IInstallationManager
2013-02-21 01:33:05 +00:00
{
2013-07-06 21:23:32 +00:00
public event EventHandler<InstallationEventArgs> PackageInstalling;
public event EventHandler<InstallationEventArgs> PackageInstallationCompleted;
public event EventHandler<InstallationFailedEventArgs> PackageInstallationFailed;
public event EventHandler<InstallationEventArgs> PackageInstallationCancelled;
2013-02-21 01:33:05 +00:00
/// <summary>
/// The current installations
/// </summary>
public List<Tuple<InstallationInfo, CancellationTokenSource>> CurrentInstallations { get; set; }
2013-08-07 19:15:55 +00:00
2013-02-21 01:33:05 +00:00
/// <summary>
/// The completed installations
/// </summary>
2016-11-03 19:07:48 +00:00
private ConcurrentBag<InstallationInfo> CompletedInstallationsInternal { get; set; }
2016-12-17 20:52:05 +00:00
public IEnumerable<InstallationInfo> CompletedInstallations
{
2016-11-03 19:07:48 +00:00
get { return CompletedInstallationsInternal; }
}
2013-02-24 21:53:54 +00:00
2013-02-21 01:33:05 +00:00
#region PluginUninstalled Event
/// <summary>
/// Occurs when [plugin uninstalled].
/// </summary>
public event EventHandler<GenericEventArgs<IPlugin>> PluginUninstalled;
/// <summary>
/// Called when [plugin uninstalled].
/// </summary>
/// <param name="plugin">The plugin.</param>
private void OnPluginUninstalled(IPlugin plugin)
{
2014-05-14 00:46:45 +00:00
EventHelper.FireEventIfNotNull(PluginUninstalled, this, new GenericEventArgs<IPlugin> { Argument = plugin }, _logger);
2013-02-21 01:33:05 +00:00
}
#endregion
#region PluginUpdated Event
/// <summary>
/// Occurs when [plugin updated].
/// </summary>
public event EventHandler<GenericEventArgs<Tuple<IPlugin, PackageVersionInfo>>> PluginUpdated;
/// <summary>
/// Called when [plugin updated].
/// </summary>
/// <param name="plugin">The plugin.</param>
/// <param name="newVersion">The new version.</param>
private void OnPluginUpdated(IPlugin plugin, PackageVersionInfo newVersion)
2013-02-21 01:33:05 +00:00
{
2014-06-29 19:59:52 +00:00
_logger.Info("Plugin updated: {0} {1} {2}", newVersion.name, newVersion.versionStr ?? string.Empty, newVersion.classification);
2013-02-21 01:33:05 +00:00
2014-05-14 00:46:45 +00:00
EventHelper.FireEventIfNotNull(PluginUpdated, this, new GenericEventArgs<Tuple<IPlugin, PackageVersionInfo>> { Argument = new Tuple<IPlugin, PackageVersionInfo>(plugin, newVersion) }, _logger);
2013-02-24 21:53:54 +00:00
2013-08-07 19:15:55 +00:00
_applicationHost.NotifyPendingRestart();
2013-02-21 01:33:05 +00:00
}
#endregion
#region PluginInstalled Event
/// <summary>
/// Occurs when [plugin updated].
/// </summary>
public event EventHandler<GenericEventArgs<PackageVersionInfo>> PluginInstalled;
/// <summary>
/// Called when [plugin installed].
/// </summary>
/// <param name="package">The package.</param>
private void OnPluginInstalled(PackageVersionInfo package)
2013-02-21 01:33:05 +00:00
{
2014-06-29 19:59:52 +00:00
_logger.Info("New plugin installed: {0} {1} {2}", package.name, package.versionStr ?? string.Empty, package.classification);
2013-02-21 01:33:05 +00:00
2014-05-14 00:46:45 +00:00
EventHelper.FireEventIfNotNull(PluginInstalled, this, new GenericEventArgs<PackageVersionInfo> { Argument = package }, _logger);
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
}
#endregion
2013-02-21 21:39:53 +00:00
/// <summary>
/// The _logger
/// </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;
private readonly ISecurityManager _securityManager;
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;
2016-11-08 18:44:23 +00:00
private readonly ICryptoProvider _cryptographyProvider;
2017-08-24 19:52:19 +00:00
// netframework or netcore
private readonly string _packageRuntime;
2018-09-12 17:26:21 +00:00
public InstallationManager(ILogger logger, IApplicationHost appHost, IApplicationPaths appPaths, IHttpClient httpClient, IJsonSerializer jsonSerializer, ISecurityManager securityManager, IServerConfigurationManager config, IFileSystem fileSystem, ICryptoProvider cryptographyProvider, string packageRuntime)
2013-02-21 01:33:05 +00:00
{
if (logger == null)
{
throw new ArgumentNullException("logger");
}
2013-02-24 21:53:54 +00:00
CurrentInstallations = new List<Tuple<InstallationInfo, CancellationTokenSource>>();
2016-11-03 19:07:48 +00:00
CompletedInstallationsInternal = new ConcurrentBag<InstallationInfo>();
2013-08-07 19:15:55 +00:00
_applicationHost = appHost;
_appPaths = appPaths;
_httpClient = httpClient;
_jsonSerializer = jsonSerializer;
_securityManager = securityManager;
2013-08-30 14:05:44 +00:00
_config = config;
_fileSystem = fileSystem;
_cryptographyProvider = cryptographyProvider;
2017-08-24 19:52:19 +00:00
_packageRuntime = packageRuntime;
2013-02-21 21:39:53 +00:00
_logger = logger;
2013-02-21 01:33:05 +00:00
}
2014-06-29 19:59:52 +00:00
private Version GetPackageVersion(PackageVersionInfo version)
{
return new Version(ValueOrDefault(version.versionStr, "0.0.0.1"));
}
private static string ValueOrDefault(string str, string def)
{
return string.IsNullOrEmpty(str) ? def : str;
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets all available packages.
/// </summary>
/// <returns>Task{List{PackageInfo}}.</returns>
2017-08-24 19:52:19 +00:00
public async Task<List<PackageInfo>> GetAvailablePackages(CancellationToken cancellationToken,
2015-08-24 20:37:34 +00:00
bool withRegistration = true,
2016-10-08 05:57:38 +00:00
string packageType = null,
2013-02-21 01:33:05 +00:00
Version applicationVersion = null)
{
2015-08-24 20:37:34 +00:00
if (withRegistration)
2013-08-07 19:15:55 +00:00
{
2017-02-26 21:47:52 +00:00
var data = new Dictionary<string, string>
{
{ "key", _securityManager.SupporterKey },
{ "mac", _applicationHost.SystemId },
{ "systemid", _applicationHost.SystemId }
};
2017-10-20 16:16:56 +00:00
var options = new HttpRequestOptions
2015-08-24 20:37:34 +00:00
{
Url = "https://www.mb3admin.local/admin/service/package/retrieveall?includeAllRuntimes=true",
2017-10-20 16:16:56 +00:00
CancellationToken = cancellationToken
};
options.SetPostData(data);
using (var response = await _httpClient.SendAsync(options, "POST").ConfigureAwait(false))
{
using (var json = response.Content)
{
cancellationToken.ThrowIfCancellationRequested();
2015-08-24 20:37:34 +00:00
2018-09-12 17:26:21 +00:00
var packages = await _jsonSerializer.DeserializeFromStreamAsync<PackageInfo[]>(json).ConfigureAwait(false);
2013-02-21 01:33:05 +00:00
2017-10-20 16:16:56 +00:00
return FilterPackages(packages, packageType, applicationVersion);
}
2015-08-24 20:37:34 +00:00
}
}
else
{
var packages = await GetAvailablePackagesWithoutRegistrationInfo(cancellationToken).ConfigureAwait(false);
2013-08-07 19:15:55 +00:00
2017-08-19 19:43:35 +00:00
return FilterPackages(packages, packageType, applicationVersion);
2013-08-07 19:15:55 +00:00
}
}
/// <summary>
/// Gets all available packages.
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{List{PackageInfo}}.</returns>
2017-08-24 19:52:19 +00:00
public async Task<List<PackageInfo>> GetAvailablePackagesWithoutRegistrationInfo(CancellationToken cancellationToken)
{
2018-09-12 17:26:21 +00:00
using (var response = await _httpClient.SendAsync(new HttpRequestOptions
2016-01-02 21:54:37 +00:00
{
Url = "https://www.mb3admin.local/admin/service/EmbyPackages.json",
2018-09-12 17:26:21 +00:00
CancellationToken = cancellationToken,
Progress = new SimpleProgress<Double>(),
CacheLength = GetCacheLength(),
CacheMode = CacheMode.Unconditional
2016-01-02 21:54:37 +00:00
2018-09-12 17:26:21 +00:00
}, "GET").ConfigureAwait(false))
2016-01-02 21:54:37 +00:00
{
2018-09-12 17:26:21 +00:00
using (var stream = response.Content)
2016-01-02 21:54:37 +00:00
{
2018-09-12 17:26:21 +00:00
return FilterPackages(await _jsonSerializer.DeserializeFromStreamAsync<PackageInfo[]>(stream).ConfigureAwait(false));
2016-01-02 21:54:37 +00:00
}
}
}
2017-04-10 01:51:36 +00:00
private PackageVersionClass GetSystemUpdateLevel()
{
return _applicationHost.SystemUpdateLevel;
}
2016-01-02 21:54:37 +00:00
private TimeSpan GetCacheLength()
{
2017-08-23 16:48:51 +00:00
return TimeSpan.FromMinutes(3);
}
2017-08-24 19:52:19 +00:00
protected List<PackageInfo> FilterPackages(IEnumerable<PackageInfo> packages)
2013-09-30 01:29:38 +00:00
{
2017-08-24 19:52:19 +00:00
var list = new List<PackageInfo>();
2017-08-20 21:07:47 +00:00
2013-09-30 01:29:38 +00:00
foreach (var package in packages)
{
2017-08-24 19:52:19 +00:00
var versions = new List<PackageVersionInfo>();
foreach (var version in package.versions)
{
2018-09-12 17:26:21 +00:00
if (string.IsNullOrEmpty(version.sourceUrl))
2017-08-24 19:52:19 +00:00
{
continue;
}
2018-09-12 17:26:21 +00:00
if (string.IsNullOrEmpty(version.runtimes) || version.runtimes.IndexOf(_packageRuntime, StringComparison.OrdinalIgnoreCase) == -1)
2017-08-24 19:52:19 +00:00
{
continue;
}
versions.Add(version);
}
package.versions = versions
.OrderByDescending(GetPackageVersion)
.ToArray();
if (package.versions.Length == 0)
{
continue;
}
list.Add(package);
2013-09-30 01:29:38 +00:00
}
// Remove packages with no versions
2017-08-24 19:52:19 +00:00
return list;
2013-09-30 01:29:38 +00:00
}
2017-08-24 19:52:19 +00:00
protected List<PackageInfo> FilterPackages(IEnumerable<PackageInfo> packages, string packageType, Version applicationVersion)
{
2017-08-24 19:52:19 +00:00
var packagesList = FilterPackages(packages);
2013-08-07 19:15:55 +00:00
2017-08-24 19:52:19 +00:00
var returnList = new List<PackageInfo>();
2017-08-20 19:10:00 +00:00
2018-09-12 17:26:21 +00:00
var filterOnPackageType = !string.IsNullOrEmpty(packageType);
2013-02-21 01:33:05 +00:00
2017-08-24 19:52:19 +00:00
foreach (var p in packagesList)
{
2017-08-24 19:52:19 +00:00
if (filterOnPackageType && !string.Equals(p.type, packageType, StringComparison.OrdinalIgnoreCase))
2013-02-21 01:33:05 +00:00
{
2017-08-24 19:52:19 +00:00
continue;
2013-02-21 01:33:05 +00:00
}
2017-08-24 19:52:19 +00:00
// If an app version was supplied, filter the versions for each package to only include supported versions
if (applicationVersion != null)
{
p.versions = p.versions.Where(v => IsPackageVersionUpToDate(v, applicationVersion)).ToArray();
}
if (p.versions.Length == 0)
{
continue;
}
returnList.Add(p);
}
2017-08-20 19:10:00 +00:00
2017-08-24 19:52:19 +00:00
return returnList;
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Determines whether [is package version up to date] [the specified package version info].
/// </summary>
/// <param name="packageVersionInfo">The package version info.</param>
/// <param name="currentServerVersion">The current server version.</param>
2013-02-21 01:33:05 +00:00
/// <returns><c>true</c> if [is package version up to date] [the specified package version info]; otherwise, <c>false</c>.</returns>
private bool IsPackageVersionUpToDate(PackageVersionInfo packageVersionInfo, Version currentServerVersion)
2013-02-21 01:33:05 +00:00
{
if (string.IsNullOrEmpty(packageVersionInfo.requiredVersionStr))
{
return true;
}
Version requiredVersion;
return Version.TryParse(packageVersionInfo.requiredVersionStr, out requiredVersion) && currentServerVersion >= requiredVersion;
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Gets the package.
/// </summary>
/// <param name="name">The name.</param>
/// <param name="guid">The assembly guid</param>
2013-02-21 01:33:05 +00:00
/// <param name="classification">The classification.</param>
/// <param name="version">The version.</param>
/// <returns>Task{PackageVersionInfo}.</returns>
public async Task<PackageVersionInfo> GetPackage(string name, string guid, PackageVersionClass classification, Version version)
2013-02-21 01:33:05 +00:00
{
2017-02-26 21:47:52 +00:00
var packages = await GetAvailablePackages(CancellationToken.None, false).ConfigureAwait(false);
2013-02-21 01:33:05 +00:00
2014-07-13 04:55:56 +00:00
var package = packages.FirstOrDefault(p => string.Equals(p.guid, guid ?? "none", StringComparison.OrdinalIgnoreCase))
?? packages.FirstOrDefault(p => p.name.Equals(name, StringComparison.OrdinalIgnoreCase));
2013-02-21 01:33:05 +00:00
if (package == null)
{
return null;
}
2014-06-29 19:59:52 +00:00
return package.versions.FirstOrDefault(v => GetPackageVersion(v).Equals(version) && v.classification == classification);
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Gets the latest compatible version.
/// </summary>
/// <param name="name">The name.</param>
/// <param name="guid">The assembly guid if this is a plug-in</param>
/// <param name="currentServerVersion">The current server version.</param>
2013-02-21 01:33:05 +00:00
/// <param name="classification">The classification.</param>
/// <returns>Task{PackageVersionInfo}.</returns>
public async Task<PackageVersionInfo> GetLatestCompatibleVersion(string name, string guid, Version currentServerVersion, PackageVersionClass classification = PackageVersionClass.Release)
2013-02-21 01:33:05 +00:00
{
2017-02-26 21:47:52 +00:00
var packages = await GetAvailablePackages(CancellationToken.None, false).ConfigureAwait(false);
2013-02-21 01:33:05 +00:00
return GetLatestCompatibleVersion(packages, name, guid, currentServerVersion, classification);
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Gets the latest compatible version.
/// </summary>
/// <param name="availablePackages">The available packages.</param>
/// <param name="name">The name.</param>
/// <param name="currentServerVersion">The current server version.</param>
2013-02-21 01:33:05 +00:00
/// <param name="classification">The classification.</param>
/// <returns>PackageVersionInfo.</returns>
public PackageVersionInfo GetLatestCompatibleVersion(IEnumerable<PackageInfo> availablePackages, string name, string guid, Version currentServerVersion, PackageVersionClass classification = PackageVersionClass.Release)
2013-02-21 01:33:05 +00:00
{
2014-07-13 04:55:56 +00:00
var package = availablePackages.FirstOrDefault(p => string.Equals(p.guid, guid ?? "none", StringComparison.OrdinalIgnoreCase))
?? availablePackages.FirstOrDefault(p => p.name.Equals(name, StringComparison.OrdinalIgnoreCase));
2013-02-21 01:33:05 +00:00
if (package == null)
{
return null;
}
return package.versions
2014-06-29 19:59:52 +00:00
.OrderByDescending(GetPackageVersion)
.FirstOrDefault(v => v.classification <= classification && IsPackageVersionUpToDate(v, currentServerVersion));
2013-02-21 01:33:05 +00:00
}
/// <summary>
2013-08-16 18:59:37 +00:00
/// Gets the available plugin updates.
2013-02-21 01:33:05 +00:00
/// </summary>
2013-09-30 15:04:38 +00:00
/// <param name="applicationVersion">The current server version.</param>
2013-02-21 01:33:05 +00:00
/// <param name="withAutoUpdateEnabled">if set to <c>true</c> [with auto update enabled].</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{IEnumerable{PackageVersionInfo}}.</returns>
2013-09-30 15:04:38 +00:00
public async Task<IEnumerable<PackageVersionInfo>> GetAvailablePluginUpdates(Version applicationVersion, bool withAutoUpdateEnabled, CancellationToken cancellationToken)
{
2017-08-19 19:43:35 +00:00
var catalog = await GetAvailablePackagesWithoutRegistrationInfo(cancellationToken).ConfigureAwait(false);
2017-04-10 01:51:36 +00:00
var systemUpdateLevel = GetSystemUpdateLevel();
2013-02-21 01:33:05 +00:00
// Figure out what needs to be installed
2017-08-19 19:43:35 +00:00
return _applicationHost.Plugins.Select(p =>
2013-02-21 01:33:05 +00:00
{
2017-04-10 01:51:36 +00:00
var latestPluginInfo = GetLatestCompatibleVersion(catalog, p.Name, p.Id.ToString(), applicationVersion, systemUpdateLevel);
2013-02-21 01:33:05 +00:00
2014-06-29 19:59:52 +00:00
return latestPluginInfo != null && GetPackageVersion(latestPluginInfo) > p.Version ? latestPluginInfo : null;
2013-02-21 01:33:05 +00:00
2017-08-19 19:43:35 +00:00
}).Where(i => i != null)
2018-09-12 17:26:21 +00:00
.Where(p => !string.IsNullOrEmpty(p.sourceUrl) && !CompletedInstallations.Any(i => string.Equals(i.AssemblyGuid, p.guid, StringComparison.OrdinalIgnoreCase)));
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Installs the package.
/// </summary>
/// <param name="package">The package.</param>
/// <param name="isPlugin">if set to <c>true</c> [is plugin].</param>
2013-02-21 01:33:05 +00:00
/// <param name="progress">The progress.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
/// <exception cref="System.ArgumentNullException">package</exception>
public async Task InstallPackage(PackageVersionInfo package, bool isPlugin, IProgress<double> progress, CancellationToken cancellationToken)
2013-02-21 01:33:05 +00:00
{
if (package == null)
{
throw new ArgumentNullException("package");
}
if (progress == null)
{
throw new ArgumentNullException("progress");
}
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();
var tuple = new Tuple<InstallationInfo, CancellationTokenSource>(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 (CurrentInstallations)
{
CurrentInstallations.Add(tuple);
}
var innerProgress = new ActionableProgress<double>();
2013-02-21 01:33:05 +00:00
// Whenever the progress updates, update the outer progress object and InstallationInfo
innerProgress.RegisterAction(percent =>
{
progress.Report(percent);
installationInfo.PercentComplete = percent;
});
var linkedToken = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken, innerCancellationTokenSource.Token).Token;
2013-07-06 21:23:32 +00:00
var installationEventArgs = new InstallationEventArgs
{
InstallationInfo = installationInfo,
PackageVersionInfo = package
};
2014-05-14 00:46:45 +00:00
EventHelper.FireEventIfNotNull(PackageInstalling, this, installationEventArgs, _logger);
2013-02-21 01:33:05 +00:00
try
{
await InstallPackageInternal(package, isPlugin, innerProgress, linkedToken).ConfigureAwait(false);
2013-02-21 01:33:05 +00:00
lock (CurrentInstallations)
{
CurrentInstallations.Remove(tuple);
}
2016-11-03 19:07:48 +00:00
CompletedInstallationsInternal.Add(installationInfo);
2013-02-21 01:33:05 +00:00
2014-05-14 00:46:45 +00:00
EventHelper.FireEventIfNotNull(PackageInstallationCompleted, this, installationEventArgs, _logger);
2013-02-21 01:33:05 +00:00
}
catch (OperationCanceledException)
{
lock (CurrentInstallations)
{
CurrentInstallations.Remove(tuple);
}
2013-02-21 21:39:53 +00:00
_logger.Info("Package installation cancelled: {0} {1}", package.name, package.versionStr);
2013-02-21 01:33:05 +00:00
2014-05-14 00:46:45 +00:00
EventHelper.FireEventIfNotNull(PackageInstallationCancelled, this, installationEventArgs, _logger);
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
{
_logger.ErrorException("Package installation failed", ex);
2013-02-21 01:33:05 +00:00
lock (CurrentInstallations)
{
CurrentInstallations.Remove(tuple);
}
2013-02-24 21:53:54 +00:00
2014-05-14 00:46:45 +00:00
EventHelper.FireEventIfNotNull(PackageInstallationFailed, this, new InstallationFailedEventArgs
2013-07-06 21:23:32 +00:00
{
InstallationInfo = installationInfo,
Exception = ex
}, _logger);
2013-02-21 01:33:05 +00:00
throw;
}
finally
{
// Dispose the progress object and remove the installation from the in-progress list
tuple.Item2.Dispose();
}
}
/// <summary>
/// Installs the package internal.
/// </summary>
/// <param name="package">The package.</param>
/// <param name="isPlugin">if set to <c>true</c> [is plugin].</param>
2013-02-21 01:33:05 +00:00
/// <param name="progress">The progress.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
private async Task InstallPackageInternal(PackageVersionInfo package, bool isPlugin, IProgress<double> progress, CancellationToken cancellationToken)
2013-02-21 01:33:05 +00:00
{
2018-09-12 17:26:21 +00:00
IPlugin plugin = null;
2013-02-21 01:33:05 +00:00
if (isPlugin)
2013-02-21 01:33:05 +00:00
{
// Set last update time if we were installed before
2018-09-12 17:26:21 +00:00
plugin = _applicationHost.Plugins.FirstOrDefault(p => string.Equals(p.Id.ToString(), package.guid, StringComparison.OrdinalIgnoreCase))
?? _applicationHost.Plugins.FirstOrDefault(p => p.Name.Equals(package.name, StringComparison.OrdinalIgnoreCase));
}
string targetPath = plugin == null ? null : plugin.AssemblyFilePath;
// Do the install
await PerformPackageInstallation(progress, targetPath, package, cancellationToken).ConfigureAwait(false);
2018-09-12 17:26:21 +00:00
// Do plugin-specific processing
if (isPlugin)
{
if (plugin != null)
2013-02-21 01:33:05 +00:00
{
OnPluginUpdated(plugin, package);
2013-02-21 01:33:05 +00:00
}
else
2013-02-21 01:33:05 +00:00
{
OnPluginInstalled(package);
2013-02-21 01:33:05 +00:00
}
}
}
2018-09-12 17:26:21 +00:00
private async Task PerformPackageInstallation(IProgress<double> progress, string target, PackageVersionInfo package, CancellationToken cancellationToken)
2013-08-07 19:15:55 +00:00
{
// Target based on if it is an archive or single assembly
// zip archives are assumed to contain directory structures relative to our ProgramDataPath
var extension = Path.GetExtension(package.targetFilename);
var isArchive = string.Equals(extension, ".zip", StringComparison.OrdinalIgnoreCase) || string.Equals(extension, ".rar", StringComparison.OrdinalIgnoreCase) || string.Equals(extension, ".7z", StringComparison.OrdinalIgnoreCase);
2018-09-12 17:26:21 +00:00
if (target == null)
{
target = Path.Combine(isArchive ? _appPaths.TempUpdatePath : _appPaths.PluginsPath, package.targetFilename);
}
2013-08-07 19:15:55 +00:00
// Download to temporary file so that, if interrupted, it won't destroy the existing installation
var tempFile = await _httpClient.GetTempFile(new HttpRequestOptions
{
Url = package.sourceUrl,
CancellationToken = cancellationToken,
Progress = progress
}).ConfigureAwait(false);
cancellationToken.ThrowIfCancellationRequested();
// Validate with a checksum
2014-05-08 20:09:53 +00:00
var packageChecksum = string.IsNullOrWhiteSpace(package.checksum) ? Guid.Empty : new Guid(package.checksum);
2018-09-12 17:26:21 +00:00
if (!packageChecksum.Equals(Guid.Empty)) // support for legacy uploads for now
2013-08-07 19:15:55 +00:00
{
using (var stream = _fileSystem.OpenRead(tempFile))
2013-08-07 19:15:55 +00:00
{
2016-11-08 18:44:23 +00:00
var check = Guid.Parse(BitConverter.ToString(_cryptographyProvider.ComputeMD5(stream)).Replace("-", String.Empty));
2014-05-08 20:09:53 +00:00
if (check != packageChecksum)
2013-08-07 19:15:55 +00:00
{
throw new Exception(string.Format("Download validation failed for {0}. Probably corrupted during transfer.", package.name));
2013-08-07 19:15:55 +00:00
}
}
}
cancellationToken.ThrowIfCancellationRequested();
// Success - move it to the real target
try
{
2017-05-04 18:14:45 +00:00
_fileSystem.CreateDirectory(_fileSystem.GetDirectoryName(target));
2016-01-02 21:54:37 +00:00
_fileSystem.CopyFile(tempFile, target, true);
2013-08-07 19:15:55 +00:00
//If it is an archive - write out a version file so we know what it is
if (isArchive)
{
2016-10-29 05:40:15 +00:00
_fileSystem.WriteAllText(target + ".ver", package.versionStr);
2013-08-07 19:15:55 +00:00
}
}
catch (IOException e)
{
_logger.ErrorException("Error attempting to move file from {0} to {1}", e, tempFile, target);
throw;
}
try
{
_fileSystem.DeleteFile(tempFile);
2013-08-07 19:15:55 +00:00
}
catch (IOException e)
{
// Don't fail because of this
_logger.ErrorException("Error deleting temp file {0]", e, tempFile);
}
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Uninstalls a plugin
/// </summary>
/// <param name="plugin">The plugin.</param>
/// <exception cref="System.ArgumentException"></exception>
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;
_logger.Info("Deleting plugin file {0}", path);
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
2017-05-14 18:54:44 +00:00
var file = _fileSystem.GetFilePaths(_fileSystem.GetDirectoryName(path))
2017-05-08 18:06:36 +00:00
.FirstOrDefault(i => string.Equals(i, path, StringComparison.OrdinalIgnoreCase));
if (!string.IsNullOrWhiteSpace(file))
{
path = file;
}
_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();
}
2013-02-21 01:33:05 +00:00
OnPluginUninstalled(plugin);
2013-08-07 19:15:55 +00:00
_applicationHost.NotifyPendingRestart();
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 (CurrentInstallations)
{
foreach (var tuple in CurrentInstallations)
{
tuple.Item2.Dispose();
}
CurrentInstallations.Clear();
}
}
}
public void Dispose()
{
Dispose(true);
2013-02-21 01:33:05 +00:00
}
}
}