2019-01-06 15:50:43 -05:00
|
|
|
using System;
|
2016-10-29 01:40:15 -04:00
|
|
|
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-02-20 20:33:05 -05:00
|
|
|
using MediaBrowser.Common.Net;
|
|
|
|
using MediaBrowser.Common.Plugins;
|
|
|
|
using MediaBrowser.Common.Progress;
|
2013-02-26 15:21:43 -05:00
|
|
|
using MediaBrowser.Common.Updates;
|
2019-01-13 14:23:38 -05:00
|
|
|
using MediaBrowser.Controller.Configuration;
|
2014-05-08 16:09:53 -04:00
|
|
|
using MediaBrowser.Model.Events;
|
2016-10-29 01:40:15 -04:00
|
|
|
using MediaBrowser.Model.IO;
|
2013-02-24 16:53:54 -05:00
|
|
|
using MediaBrowser.Model.Serialization;
|
2013-02-20 20:33:05 -05:00
|
|
|
using MediaBrowser.Model.Updates;
|
2019-01-13 14:23:38 -05:00
|
|
|
using Microsoft.Extensions.Logging;
|
2013-02-20 20:33:05 -05:00
|
|
|
|
2016-11-02 16:53:50 -04:00
|
|
|
namespace Emby.Server.Implementations.Updates
|
2013-02-20 20:33:05 -05:00
|
|
|
{
|
|
|
|
/// <summary>
|
|
|
|
/// Manages all install, uninstall and update operations (both plugins and system)
|
|
|
|
/// </summary>
|
2013-03-04 23:25:27 -05:00
|
|
|
public class InstallationManager : IInstallationManager
|
2013-02-20 20:33:05 -05:00
|
|
|
{
|
2013-07-06 17:23:32 -04:00
|
|
|
public event EventHandler<InstallationEventArgs> PackageInstalling;
|
|
|
|
public event EventHandler<InstallationEventArgs> PackageInstallationCompleted;
|
|
|
|
public event EventHandler<InstallationFailedEventArgs> PackageInstallationFailed;
|
|
|
|
public event EventHandler<InstallationEventArgs> PackageInstallationCancelled;
|
2013-03-01 16:22:34 -05:00
|
|
|
|
2013-02-20 20:33:05 -05:00
|
|
|
/// <summary>
|
|
|
|
/// The current installations
|
|
|
|
/// </summary>
|
2013-02-26 15:21:43 -05:00
|
|
|
public List<Tuple<InstallationInfo, CancellationTokenSource>> CurrentInstallations { get; set; }
|
2013-08-07 15:15:55 -04:00
|
|
|
|
2013-02-20 20:33:05 -05:00
|
|
|
/// <summary>
|
|
|
|
/// The completed installations
|
|
|
|
/// </summary>
|
2019-03-25 17:25:32 -04:00
|
|
|
private ConcurrentBag<InstallationInfo> _completedInstallationsInternal;
|
2016-11-03 15:07:48 -04:00
|
|
|
|
2019-03-25 17:25:32 -04:00
|
|
|
public IEnumerable<InstallationInfo> CompletedInstallations => _completedInstallationsInternal;
|
2013-02-24 16:53:54 -05:00
|
|
|
|
2013-02-20 20:33:05 -05:00
|
|
|
/// <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)
|
|
|
|
{
|
2018-12-28 09:21:02 -05:00
|
|
|
PluginUninstalled?.Invoke(this, new GenericEventArgs<IPlugin> { Argument = plugin });
|
2013-02-20 20:33:05 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
/// <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>
|
2013-03-04 23:25:27 -05:00
|
|
|
private void OnPluginUpdated(IPlugin plugin, PackageVersionInfo newVersion)
|
2013-02-20 20:33:05 -05:00
|
|
|
{
|
2018-12-13 08:18:25 -05:00
|
|
|
_logger.LogInformation("Plugin updated: {0} {1} {2}", newVersion.name, newVersion.versionStr ?? string.Empty, newVersion.classification);
|
2013-02-20 20:33:05 -05:00
|
|
|
|
2018-12-28 09:21:02 -05:00
|
|
|
PluginUpdated?.Invoke(this, new GenericEventArgs<Tuple<IPlugin, PackageVersionInfo>> { Argument = new Tuple<IPlugin, PackageVersionInfo>(plugin, newVersion) });
|
2013-02-24 16:53:54 -05:00
|
|
|
|
2013-08-07 15:15:55 -04:00
|
|
|
_applicationHost.NotifyPendingRestart();
|
2013-02-20 20:33:05 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Occurs when [plugin updated].
|
|
|
|
/// </summary>
|
|
|
|
public event EventHandler<GenericEventArgs<PackageVersionInfo>> PluginInstalled;
|
|
|
|
/// <summary>
|
|
|
|
/// Called when [plugin installed].
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="package">The package.</param>
|
2013-03-04 23:25:27 -05:00
|
|
|
private void OnPluginInstalled(PackageVersionInfo package)
|
2013-02-20 20:33:05 -05:00
|
|
|
{
|
2018-12-13 08:18:25 -05:00
|
|
|
_logger.LogInformation("New plugin installed: {0} {1} {2}", package.name, package.versionStr ?? string.Empty, package.classification);
|
2013-02-20 20:33:05 -05:00
|
|
|
|
2018-12-28 09:21:02 -05:00
|
|
|
PluginInstalled?.Invoke(this, new GenericEventArgs<PackageVersionInfo> { Argument = package });
|
2013-02-20 20:33:05 -05:00
|
|
|
|
2013-08-07 15:15:55 -04:00
|
|
|
_applicationHost.NotifyPendingRestart();
|
2013-02-20 20:33:05 -05:00
|
|
|
}
|
|
|
|
|
2013-02-21 16:39:53 -05:00
|
|
|
/// <summary>
|
|
|
|
/// The _logger
|
|
|
|
/// </summary>
|
|
|
|
private readonly ILogger _logger;
|
|
|
|
|
2013-08-07 15:15:55 -04:00
|
|
|
private readonly IApplicationPaths _appPaths;
|
|
|
|
private readonly IHttpClient _httpClient;
|
|
|
|
private readonly IJsonSerializer _jsonSerializer;
|
2018-09-12 13:26:21 -04:00
|
|
|
private readonly IServerConfigurationManager _config;
|
2015-01-12 22:46:44 -05:00
|
|
|
private readonly IFileSystem _fileSystem;
|
2013-02-24 19:13:45 -05:00
|
|
|
|
2013-02-25 22:43:04 -05:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the application host.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The application host.</value>
|
2013-08-07 15:15:55 -04:00
|
|
|
private readonly IApplicationHost _applicationHost;
|
2013-02-25 22:43:04 -05:00
|
|
|
|
2019-02-10 17:29:55 -05:00
|
|
|
private readonly IZipClient _zipClient;
|
2016-11-02 16:53:50 -04:00
|
|
|
|
2019-01-04 16:42:56 -05:00
|
|
|
public InstallationManager(
|
2019-01-17 17:55:05 -05:00
|
|
|
ILoggerFactory loggerFactory,
|
2019-01-04 16:42:56 -05:00
|
|
|
IApplicationHost appHost,
|
|
|
|
IApplicationPaths appPaths,
|
|
|
|
IHttpClient httpClient,
|
2019-01-12 13:52:59 -05:00
|
|
|
IJsonSerializer jsonSerializer,
|
2019-01-04 16:42:56 -05:00
|
|
|
IServerConfigurationManager config,
|
|
|
|
IFileSystem fileSystem,
|
2019-03-25 17:25:32 -04:00
|
|
|
IZipClient zipClient)
|
2013-02-20 20:33:05 -05:00
|
|
|
{
|
2019-01-17 17:55:05 -05:00
|
|
|
if (loggerFactory == null)
|
2013-02-23 12:54:51 -05:00
|
|
|
{
|
2019-01-17 17:55:05 -05:00
|
|
|
throw new ArgumentNullException(nameof(loggerFactory));
|
2013-02-23 12:54:51 -05:00
|
|
|
}
|
2013-02-24 16:53:54 -05:00
|
|
|
|
2013-02-26 15:21:43 -05:00
|
|
|
CurrentInstallations = new List<Tuple<InstallationInfo, CancellationTokenSource>>();
|
2019-03-25 17:25:32 -04:00
|
|
|
_completedInstallationsInternal = new ConcurrentBag<InstallationInfo>();
|
2013-08-07 15:15:55 -04:00
|
|
|
|
2019-03-25 17:25:32 -04:00
|
|
|
_logger = loggerFactory.CreateLogger(nameof(InstallationManager));
|
2013-08-07 15:15:55 -04:00
|
|
|
_applicationHost = appHost;
|
|
|
|
_appPaths = appPaths;
|
|
|
|
_httpClient = httpClient;
|
|
|
|
_jsonSerializer = jsonSerializer;
|
2013-08-30 10:05:44 -04:00
|
|
|
_config = config;
|
2015-01-12 22:46:44 -05:00
|
|
|
_fileSystem = fileSystem;
|
2019-02-10 17:29:55 -05:00
|
|
|
_zipClient = zipClient;
|
2013-02-20 20:33:05 -05:00
|
|
|
}
|
|
|
|
|
2019-01-06 15:50:43 -05:00
|
|
|
private static Version GetPackageVersion(PackageVersionInfo version)
|
2014-06-29 15:59:52 -04:00
|
|
|
{
|
|
|
|
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-20 20:33:05 -05:00
|
|
|
/// <summary>
|
|
|
|
/// Gets all available packages.
|
|
|
|
/// </summary>
|
|
|
|
/// <returns>Task{List{PackageInfo}}.</returns>
|
2019-02-03 15:57:49 -05:00
|
|
|
public async Task<List<PackageInfo>> GetAvailablePackages(CancellationToken cancellationToken,
|
2015-08-24 16:37:34 -04:00
|
|
|
bool withRegistration = true,
|
2016-10-08 01:57:38 -04:00
|
|
|
string packageType = null,
|
2013-02-20 20:33:05 -05:00
|
|
|
Version applicationVersion = null)
|
|
|
|
{
|
2019-01-30 13:16:31 -05:00
|
|
|
var packages = await GetAvailablePackagesWithoutRegistrationInfo(cancellationToken).ConfigureAwait(false);
|
|
|
|
return FilterPackages(packages, packageType, applicationVersion);
|
2013-06-27 15:08:57 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Gets all available packages.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
|
|
/// <returns>Task{List{PackageInfo}}.</returns>
|
2017-08-24 15:52:19 -04:00
|
|
|
public async Task<List<PackageInfo>> GetAvailablePackagesWithoutRegistrationInfo(CancellationToken cancellationToken)
|
2013-06-27 15:08:57 -04:00
|
|
|
{
|
2018-09-12 13:26:21 -04:00
|
|
|
using (var response = await _httpClient.SendAsync(new HttpRequestOptions
|
2016-01-02 16:54:37 -05:00
|
|
|
{
|
2019-01-30 13:16:31 -05:00
|
|
|
Url = "https://repo.jellyfin.org/releases/plugin/manifest.json",
|
2018-09-12 13:26:21 -04:00
|
|
|
CancellationToken = cancellationToken,
|
2019-01-06 15:50:43 -05:00
|
|
|
Progress = new SimpleProgress<double>(),
|
2019-01-30 13:16:31 -05:00
|
|
|
CacheLength = GetCacheLength()
|
2018-09-12 13:26:21 -04:00
|
|
|
}, "GET").ConfigureAwait(false))
|
2016-01-02 16:54:37 -05:00
|
|
|
{
|
2018-09-12 13:26:21 -04:00
|
|
|
using (var stream = response.Content)
|
2016-01-02 16:54:37 -05:00
|
|
|
{
|
2018-09-12 13:26:21 -04:00
|
|
|
return FilterPackages(await _jsonSerializer.DeserializeFromStreamAsync<PackageInfo[]>(stream).ConfigureAwait(false));
|
2016-01-02 16:54:37 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-04-09 21:51:36 -04:00
|
|
|
private PackageVersionClass GetSystemUpdateLevel()
|
|
|
|
{
|
|
|
|
return _applicationHost.SystemUpdateLevel;
|
|
|
|
}
|
|
|
|
|
2019-01-06 15:50:43 -05:00
|
|
|
private static TimeSpan GetCacheLength()
|
2016-01-02 16:54:37 -05:00
|
|
|
{
|
2017-08-23 12:48:51 -04:00
|
|
|
return TimeSpan.FromMinutes(3);
|
2013-06-27 15:08:57 -04:00
|
|
|
}
|
|
|
|
|
2017-08-24 15:52:19 -04:00
|
|
|
protected List<PackageInfo> FilterPackages(IEnumerable<PackageInfo> packages)
|
2013-09-29 21:29:38 -04:00
|
|
|
{
|
2017-08-24 15:52:19 -04:00
|
|
|
var list = new List<PackageInfo>();
|
2017-08-20 17:07:47 -04:00
|
|
|
|
2013-09-29 21:29:38 -04:00
|
|
|
foreach (var package in packages)
|
|
|
|
{
|
2017-08-24 15:52:19 -04:00
|
|
|
var versions = new List<PackageVersionInfo>();
|
|
|
|
foreach (var version in package.versions)
|
|
|
|
{
|
2018-09-12 13:26:21 -04:00
|
|
|
if (string.IsNullOrEmpty(version.sourceUrl))
|
2017-08-24 15:52:19 -04:00
|
|
|
{
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
versions.Add(version);
|
|
|
|
}
|
|
|
|
|
|
|
|
package.versions = versions
|
|
|
|
.OrderByDescending(GetPackageVersion)
|
|
|
|
.ToArray();
|
|
|
|
|
|
|
|
if (package.versions.Length == 0)
|
|
|
|
{
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
list.Add(package);
|
2013-09-29 21:29:38 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
// Remove packages with no versions
|
2017-08-24 15:52:19 -04:00
|
|
|
return list;
|
2013-09-29 21:29:38 -04:00
|
|
|
}
|
|
|
|
|
2017-08-24 15:52:19 -04:00
|
|
|
protected List<PackageInfo> FilterPackages(IEnumerable<PackageInfo> packages, string packageType, Version applicationVersion)
|
2013-06-27 15:08:57 -04:00
|
|
|
{
|
2017-08-24 15:52:19 -04:00
|
|
|
var packagesList = FilterPackages(packages);
|
2013-08-07 15:15:55 -04:00
|
|
|
|
2017-08-24 15:52:19 -04:00
|
|
|
var returnList = new List<PackageInfo>();
|
2017-08-20 15:10:00 -04:00
|
|
|
|
2018-09-12 13:26:21 -04:00
|
|
|
var filterOnPackageType = !string.IsNullOrEmpty(packageType);
|
2013-02-20 20:33:05 -05:00
|
|
|
|
2017-08-24 15:52:19 -04:00
|
|
|
foreach (var p in packagesList)
|
2013-02-27 07:49:55 -05:00
|
|
|
{
|
2017-08-24 15:52:19 -04:00
|
|
|
if (filterOnPackageType && !string.Equals(p.type, packageType, StringComparison.OrdinalIgnoreCase))
|
2013-02-20 20:33:05 -05:00
|
|
|
{
|
2017-08-24 15:52:19 -04:00
|
|
|
continue;
|
2013-02-20 20:33:05 -05:00
|
|
|
}
|
|
|
|
|
2017-08-24 15:52:19 -04: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 15:10:00 -04:00
|
|
|
|
2017-08-24 15:52:19 -04:00
|
|
|
return returnList;
|
2013-02-20 20:33:05 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Determines whether [is package version up to date] [the specified package version info].
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="packageVersionInfo">The package version info.</param>
|
2013-09-22 14:21:55 -04:00
|
|
|
/// <param name="currentServerVersion">The current server version.</param>
|
2013-02-20 20:33:05 -05:00
|
|
|
/// <returns><c>true</c> if [is package version up to date] [the specified package version info]; otherwise, <c>false</c>.</returns>
|
2019-01-06 15:50:43 -05:00
|
|
|
private static bool IsPackageVersionUpToDate(PackageVersionInfo packageVersionInfo, Version currentServerVersion)
|
2013-02-20 20:33:05 -05:00
|
|
|
{
|
|
|
|
if (string.IsNullOrEmpty(packageVersionInfo.requiredVersionStr))
|
|
|
|
{
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2019-01-13 15:46:33 -05:00
|
|
|
return Version.TryParse(packageVersionInfo.requiredVersionStr, out var requiredVersion) && currentServerVersion >= requiredVersion;
|
2013-02-20 20:33:05 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Gets the package.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="name">The name.</param>
|
2013-11-04 13:16:47 -05:00
|
|
|
/// <param name="guid">The assembly guid</param>
|
2013-02-20 20:33:05 -05:00
|
|
|
/// <param name="classification">The classification.</param>
|
|
|
|
/// <param name="version">The version.</param>
|
|
|
|
/// <returns>Task{PackageVersionInfo}.</returns>
|
2013-11-04 13:16:47 -05:00
|
|
|
public async Task<PackageVersionInfo> GetPackage(string name, string guid, PackageVersionClass classification, Version version)
|
2013-02-20 20:33:05 -05:00
|
|
|
{
|
2017-02-26 16:47:52 -05:00
|
|
|
var packages = await GetAvailablePackages(CancellationToken.None, false).ConfigureAwait(false);
|
2013-02-20 20:33:05 -05:00
|
|
|
|
2014-07-13 00:55:56 -04:00
|
|
|
var package = packages.FirstOrDefault(p => string.Equals(p.guid, guid ?? "none", StringComparison.OrdinalIgnoreCase))
|
2013-11-04 13:16:47 -05:00
|
|
|
?? packages.FirstOrDefault(p => p.name.Equals(name, StringComparison.OrdinalIgnoreCase));
|
2013-02-20 20:33:05 -05:00
|
|
|
|
|
|
|
if (package == null)
|
|
|
|
{
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
2014-06-29 15:59:52 -04:00
|
|
|
return package.versions.FirstOrDefault(v => GetPackageVersion(v).Equals(version) && v.classification == classification);
|
2013-02-20 20:33:05 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Gets the latest compatible version.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="name">The name.</param>
|
2013-11-04 13:16:47 -05:00
|
|
|
/// <param name="guid">The assembly guid if this is a plug-in</param>
|
2013-09-22 14:21:55 -04:00
|
|
|
/// <param name="currentServerVersion">The current server version.</param>
|
2013-02-20 20:33:05 -05:00
|
|
|
/// <param name="classification">The classification.</param>
|
|
|
|
/// <returns>Task{PackageVersionInfo}.</returns>
|
2013-11-04 13:16:47 -05:00
|
|
|
public async Task<PackageVersionInfo> GetLatestCompatibleVersion(string name, string guid, Version currentServerVersion, PackageVersionClass classification = PackageVersionClass.Release)
|
2013-02-20 20:33:05 -05:00
|
|
|
{
|
2017-02-26 16:47:52 -05:00
|
|
|
var packages = await GetAvailablePackages(CancellationToken.None, false).ConfigureAwait(false);
|
2013-02-20 20:33:05 -05:00
|
|
|
|
2013-11-04 13:16:47 -05:00
|
|
|
return GetLatestCompatibleVersion(packages, name, guid, currentServerVersion, classification);
|
2013-02-20 20:33:05 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Gets the latest compatible version.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="availablePackages">The available packages.</param>
|
|
|
|
/// <param name="name">The name.</param>
|
2013-09-22 14:21:55 -04:00
|
|
|
/// <param name="currentServerVersion">The current server version.</param>
|
2013-02-20 20:33:05 -05:00
|
|
|
/// <param name="classification">The classification.</param>
|
|
|
|
/// <returns>PackageVersionInfo.</returns>
|
2013-11-04 13:16:47 -05:00
|
|
|
public PackageVersionInfo GetLatestCompatibleVersion(IEnumerable<PackageInfo> availablePackages, string name, string guid, Version currentServerVersion, PackageVersionClass classification = PackageVersionClass.Release)
|
2013-02-20 20:33:05 -05:00
|
|
|
{
|
2014-07-13 00:55:56 -04:00
|
|
|
var package = availablePackages.FirstOrDefault(p => string.Equals(p.guid, guid ?? "none", StringComparison.OrdinalIgnoreCase))
|
2013-11-04 13:16:47 -05:00
|
|
|
?? availablePackages.FirstOrDefault(p => p.name.Equals(name, StringComparison.OrdinalIgnoreCase));
|
2013-02-20 20:33:05 -05:00
|
|
|
|
|
|
|
if (package == null)
|
|
|
|
{
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
|
|
|
return package.versions
|
2014-06-29 15:59:52 -04:00
|
|
|
.OrderByDescending(GetPackageVersion)
|
2013-09-22 14:21:55 -04:00
|
|
|
.FirstOrDefault(v => v.classification <= classification && IsPackageVersionUpToDate(v, currentServerVersion));
|
2013-02-20 20:33:05 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
/// <summary>
|
2013-08-16 14:59:37 -04:00
|
|
|
/// Gets the available plugin updates.
|
2013-02-20 20:33:05 -05:00
|
|
|
/// </summary>
|
2013-09-30 11:04:38 -04:00
|
|
|
/// <param name="applicationVersion">The current server version.</param>
|
2013-02-20 20:33:05 -05: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 11:04:38 -04:00
|
|
|
public async Task<IEnumerable<PackageVersionInfo>> GetAvailablePluginUpdates(Version applicationVersion, bool withAutoUpdateEnabled, CancellationToken cancellationToken)
|
2013-06-27 15:08:57 -04:00
|
|
|
{
|
2017-08-19 15:43:35 -04:00
|
|
|
var catalog = await GetAvailablePackagesWithoutRegistrationInfo(cancellationToken).ConfigureAwait(false);
|
|
|
|
|
2017-04-09 21:51:36 -04:00
|
|
|
var systemUpdateLevel = GetSystemUpdateLevel();
|
|
|
|
|
2013-02-20 20:33:05 -05:00
|
|
|
// Figure out what needs to be installed
|
2017-08-19 15:43:35 -04:00
|
|
|
return _applicationHost.Plugins.Select(p =>
|
2013-02-20 20:33:05 -05:00
|
|
|
{
|
2017-04-09 21:51:36 -04:00
|
|
|
var latestPluginInfo = GetLatestCompatibleVersion(catalog, p.Name, p.Id.ToString(), applicationVersion, systemUpdateLevel);
|
2013-02-20 20:33:05 -05:00
|
|
|
|
2014-06-29 15:59:52 -04:00
|
|
|
return latestPluginInfo != null && GetPackageVersion(latestPluginInfo) > p.Version ? latestPluginInfo : null;
|
2013-02-20 20:33:05 -05:00
|
|
|
|
2017-08-19 15:43:35 -04:00
|
|
|
}).Where(i => i != null)
|
2018-09-12 13:26:21 -04:00
|
|
|
.Where(p => !string.IsNullOrEmpty(p.sourceUrl) && !CompletedInstallations.Any(i => string.Equals(i.AssemblyGuid, p.guid, StringComparison.OrdinalIgnoreCase)));
|
2013-02-20 20:33:05 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Installs the package.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="package">The package.</param>
|
2016-01-02 20:23:09 -05:00
|
|
|
/// <param name="isPlugin">if set to <c>true</c> [is plugin].</param>
|
2013-02-20 20:33:05 -05:00
|
|
|
/// <param name="progress">The progress.</param>
|
|
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
|
|
/// <returns>Task.</returns>
|
2019-01-13 15:37:13 -05:00
|
|
|
/// <exception cref="ArgumentNullException">package</exception>
|
2016-01-02 20:23:09 -05:00
|
|
|
public async Task InstallPackage(PackageVersionInfo package, bool isPlugin, IProgress<double> progress, CancellationToken cancellationToken)
|
2013-02-20 20:33:05 -05:00
|
|
|
{
|
|
|
|
if (package == null)
|
|
|
|
{
|
2019-01-06 15:50:43 -05:00
|
|
|
throw new ArgumentNullException(nameof(package));
|
2013-02-20 20:33:05 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
if (progress == null)
|
|
|
|
{
|
2019-01-06 15:50:43 -05:00
|
|
|
throw new ArgumentNullException(nameof(progress));
|
2013-02-20 20:33:05 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
var installationInfo = new InstallationInfo
|
|
|
|
{
|
2018-09-12 13:26:21 -04:00
|
|
|
Id = Guid.NewGuid(),
|
2013-02-20 20:33:05 -05:00
|
|
|
Name = package.name,
|
2013-11-04 13:16:47 -05:00
|
|
|
AssemblyGuid = package.guid,
|
2013-02-20 20:33:05 -05:00
|
|
|
UpdateClass = package.classification,
|
|
|
|
Version = package.versionStr
|
|
|
|
};
|
|
|
|
|
|
|
|
var innerCancellationTokenSource = new CancellationTokenSource();
|
|
|
|
|
|
|
|
var tuple = new Tuple<InstallationInfo, CancellationTokenSource>(installationInfo, innerCancellationTokenSource);
|
2013-02-24 16:53:54 -05:00
|
|
|
|
2013-02-20 20:33:05 -05:00
|
|
|
// Add it to the in-progress list
|
|
|
|
lock (CurrentInstallations)
|
|
|
|
{
|
|
|
|
CurrentInstallations.Add(tuple);
|
|
|
|
}
|
|
|
|
|
2013-04-10 12:04:13 -04:00
|
|
|
var innerProgress = new ActionableProgress<double>();
|
2013-02-20 20:33:05 -05: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 17:23:32 -04:00
|
|
|
var installationEventArgs = new InstallationEventArgs
|
|
|
|
{
|
|
|
|
InstallationInfo = installationInfo,
|
|
|
|
PackageVersionInfo = package
|
|
|
|
};
|
|
|
|
|
2018-12-28 09:21:02 -05:00
|
|
|
PackageInstalling?.Invoke(this, installationEventArgs);
|
2013-02-20 20:33:05 -05:00
|
|
|
|
|
|
|
try
|
|
|
|
{
|
2016-01-02 20:23:09 -05:00
|
|
|
await InstallPackageInternal(package, isPlugin, innerProgress, linkedToken).ConfigureAwait(false);
|
2013-02-20 20:33:05 -05:00
|
|
|
|
|
|
|
lock (CurrentInstallations)
|
|
|
|
{
|
|
|
|
CurrentInstallations.Remove(tuple);
|
|
|
|
}
|
|
|
|
|
2019-03-25 17:25:32 -04:00
|
|
|
_completedInstallationsInternal.Add(installationInfo);
|
2013-02-20 20:33:05 -05:00
|
|
|
|
2018-12-28 09:21:02 -05:00
|
|
|
PackageInstallationCompleted?.Invoke(this, installationEventArgs);
|
2013-02-20 20:33:05 -05:00
|
|
|
}
|
|
|
|
catch (OperationCanceledException)
|
|
|
|
{
|
|
|
|
lock (CurrentInstallations)
|
|
|
|
{
|
|
|
|
CurrentInstallations.Remove(tuple);
|
|
|
|
}
|
|
|
|
|
2018-12-13 08:18:25 -05:00
|
|
|
_logger.LogInformation("Package installation cancelled: {0} {1}", package.name, package.versionStr);
|
2013-02-20 20:33:05 -05:00
|
|
|
|
2018-12-28 09:21:02 -05:00
|
|
|
PackageInstallationCancelled?.Invoke(this, installationEventArgs);
|
2013-02-24 16:53:54 -05:00
|
|
|
|
2013-02-20 20:33:05 -05:00
|
|
|
throw;
|
|
|
|
}
|
2013-03-16 12:41:49 -04:00
|
|
|
catch (Exception ex)
|
2013-02-20 20:33:05 -05:00
|
|
|
{
|
2018-12-20 07:11:26 -05:00
|
|
|
_logger.LogError(ex, "Package installation failed");
|
2013-03-16 12:41:49 -04:00
|
|
|
|
2013-02-20 20:33:05 -05:00
|
|
|
lock (CurrentInstallations)
|
|
|
|
{
|
|
|
|
CurrentInstallations.Remove(tuple);
|
|
|
|
}
|
2013-02-24 16:53:54 -05:00
|
|
|
|
2018-12-28 09:21:02 -05:00
|
|
|
PackageInstallationFailed?.Invoke(this, new InstallationFailedEventArgs
|
2013-07-06 17:23:32 -04:00
|
|
|
{
|
|
|
|
InstallationInfo = installationInfo,
|
|
|
|
Exception = ex
|
2018-12-28 09:21:02 -05:00
|
|
|
});
|
2013-02-20 20:33:05 -05: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>
|
2016-01-02 20:23:09 -05:00
|
|
|
/// <param name="isPlugin">if set to <c>true</c> [is plugin].</param>
|
2013-02-20 20:33:05 -05:00
|
|
|
/// <param name="progress">The progress.</param>
|
|
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
|
|
/// <returns>Task.</returns>
|
2016-01-02 20:23:09 -05:00
|
|
|
private async Task InstallPackageInternal(PackageVersionInfo package, bool isPlugin, IProgress<double> progress, CancellationToken cancellationToken)
|
2013-02-20 20:33:05 -05:00
|
|
|
{
|
2018-09-12 13:26:21 -04:00
|
|
|
IPlugin plugin = null;
|
2013-02-20 20:33:05 -05:00
|
|
|
|
2016-01-02 20:23:09 -05:00
|
|
|
if (isPlugin)
|
2013-02-20 20:33:05 -05:00
|
|
|
{
|
2013-02-27 08:34:24 -05:00
|
|
|
// Set last update time if we were installed before
|
2018-09-12 13:26:21 -04: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);
|
2013-02-27 08:34:24 -05:00
|
|
|
|
2018-09-12 13:26:21 -04:00
|
|
|
// Do plugin-specific processing
|
|
|
|
if (isPlugin)
|
|
|
|
{
|
2018-12-25 19:16:02 -05:00
|
|
|
if (plugin == null)
|
2013-02-20 20:33:05 -05:00
|
|
|
{
|
2018-12-25 19:16:02 -05:00
|
|
|
OnPluginInstalled(package);
|
2013-02-20 20:33:05 -05:00
|
|
|
}
|
2013-02-27 08:34:24 -05:00
|
|
|
else
|
2013-02-20 20:33:05 -05:00
|
|
|
{
|
2018-12-25 19:16:02 -05:00
|
|
|
OnPluginUpdated(plugin, package);
|
2013-02-20 20:33:05 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-09-12 13:26:21 -04:00
|
|
|
private async Task PerformPackageInstallation(IProgress<double> progress, string target, PackageVersionInfo package, CancellationToken cancellationToken)
|
2013-08-07 15:15:55 -04:00
|
|
|
{
|
2013-09-29 20:51:04 -04:00
|
|
|
var extension = Path.GetExtension(package.targetFilename);
|
2019-02-10 17:29:55 -05:00
|
|
|
var isArchive = string.Equals(extension, ".zip", StringComparison.OrdinalIgnoreCase);
|
2018-09-12 13:26:21 -04:00
|
|
|
|
2019-02-11 12:52:09 -05:00
|
|
|
if (!isArchive)
|
|
|
|
{
|
|
|
|
_logger.LogError("Only zip packages are supported. {Filename} is not a zip archive.", package.targetFilename);
|
|
|
|
return;
|
|
|
|
}
|
2019-02-11 12:53:35 -05:00
|
|
|
|
2018-09-12 13:26:21 -04:00
|
|
|
if (target == null)
|
|
|
|
{
|
2019-02-11 12:52:09 -05:00
|
|
|
target = Path.Combine(_appPaths.PluginsPath, Path.GetFileNameWithoutExtension(package.targetFilename));
|
2018-09-12 13:26:21 -04:00
|
|
|
}
|
2013-08-07 15:15:55 -04: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();
|
|
|
|
|
2019-02-10 17:29:55 -05:00
|
|
|
// TODO: Validate with a checksum, *properly*
|
2013-08-07 15:15:55 -04:00
|
|
|
|
2019-01-07 18:27:46 -05:00
|
|
|
// Success - move it to the real target
|
2013-08-07 15:15:55 -04:00
|
|
|
try
|
|
|
|
{
|
2019-02-11 12:52:09 -05:00
|
|
|
using (var stream = File.OpenRead(tempFile))
|
2019-02-10 17:29:55 -05:00
|
|
|
{
|
2019-02-11 12:52:09 -05:00
|
|
|
_zipClient.ExtractAllFromZip(stream, target, true);
|
2013-08-07 15:15:55 -04:00
|
|
|
}
|
|
|
|
}
|
2018-12-20 07:11:26 -05:00
|
|
|
catch (IOException ex)
|
2013-08-07 15:15:55 -04:00
|
|
|
{
|
2019-02-11 12:54:10 -05:00
|
|
|
_logger.LogError(ex, "Error attempting to extract {TempFile} to {TargetFile}", tempFile, target);
|
2013-08-07 15:15:55 -04:00
|
|
|
throw;
|
|
|
|
}
|
|
|
|
|
|
|
|
try
|
|
|
|
{
|
2015-01-12 22:46:44 -05:00
|
|
|
_fileSystem.DeleteFile(tempFile);
|
2013-08-07 15:15:55 -04:00
|
|
|
}
|
2018-12-20 07:11:26 -05:00
|
|
|
catch (IOException ex)
|
2013-08-07 15:15:55 -04:00
|
|
|
{
|
|
|
|
// Don't fail because of this
|
2018-12-20 07:11:26 -05:00
|
|
|
_logger.LogError(ex, "Error deleting temp file {TempFile}", tempFile);
|
2013-08-07 15:15:55 -04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2013-02-20 20:33:05 -05:00
|
|
|
/// <summary>
|
|
|
|
/// Uninstalls a plugin
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="plugin">The plugin.</param>
|
2019-01-13 15:37:13 -05:00
|
|
|
/// <exception cref="ArgumentException"></exception>
|
2013-02-20 20:33:05 -05:00
|
|
|
public void UninstallPlugin(IPlugin plugin)
|
|
|
|
{
|
|
|
|
plugin.OnUninstalling();
|
|
|
|
|
|
|
|
// Remove it the quick way for now
|
2013-08-07 15:15:55 -04:00
|
|
|
_applicationHost.RemovePlugin(plugin);
|
2013-02-20 20:33:05 -05:00
|
|
|
|
2017-05-08 14:06:36 -04:00
|
|
|
var path = plugin.AssemblyFilePath;
|
2018-12-13 08:18:25 -05:00
|
|
|
_logger.LogInformation("Deleting plugin file {0}", path);
|
2016-12-17 15:52:05 -05:00
|
|
|
|
2017-05-08 14:06:36 -04:00
|
|
|
// Make this case-insensitive to account for possible incorrect assembly naming
|
2019-01-26 15:47:11 -05:00
|
|
|
var file = _fileSystem.GetFilePaths(Path.GetDirectoryName(path))
|
2017-05-08 14:06:36 -04:00
|
|
|
.FirstOrDefault(i => string.Equals(i, path, StringComparison.OrdinalIgnoreCase));
|
|
|
|
|
|
|
|
if (!string.IsNullOrWhiteSpace(file))
|
|
|
|
{
|
|
|
|
path = file;
|
|
|
|
}
|
|
|
|
|
|
|
|
_fileSystem.DeleteFile(path);
|
2013-02-20 20:33:05 -05:00
|
|
|
|
2018-09-12 13:26:21 -04: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-20 20:33:05 -05:00
|
|
|
OnPluginUninstalled(plugin);
|
|
|
|
|
2013-08-07 15:15:55 -04:00
|
|
|
_applicationHost.NotifyPendingRestart();
|
2013-02-20 20:33:05 -05: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>
|
2013-03-04 23:25:27 -05:00
|
|
|
protected virtual void Dispose(bool dispose)
|
2013-02-20 20:33:05 -05:00
|
|
|
{
|
|
|
|
if (dispose)
|
|
|
|
{
|
|
|
|
lock (CurrentInstallations)
|
|
|
|
{
|
|
|
|
foreach (var tuple in CurrentInstallations)
|
|
|
|
{
|
|
|
|
tuple.Item2.Dispose();
|
|
|
|
}
|
|
|
|
|
|
|
|
CurrentInstallations.Clear();
|
|
|
|
}
|
|
|
|
}
|
2013-03-04 23:25:27 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
public void Dispose()
|
|
|
|
{
|
|
|
|
Dispose(true);
|
2013-02-20 20:33:05 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|