From bf9e24502c26bc130960cebc6b1be16635070bc8 Mon Sep 17 00:00:00 2001 From: LukePulverenti Date: Mon, 4 Mar 2013 23:25:27 -0500 Subject: extracted an installation manager interface --- .../Updates/InstallationManager.cs | 494 --------------------- 1 file changed, 494 deletions(-) delete mode 100644 MediaBrowser.Controller/Updates/InstallationManager.cs (limited to 'MediaBrowser.Controller/Updates/InstallationManager.cs') diff --git a/MediaBrowser.Controller/Updates/InstallationManager.cs b/MediaBrowser.Controller/Updates/InstallationManager.cs deleted file mode 100644 index 9a2733ce0..000000000 --- a/MediaBrowser.Controller/Updates/InstallationManager.cs +++ /dev/null @@ -1,494 +0,0 @@ -using MediaBrowser.Common; -using MediaBrowser.Common.Events; -using MediaBrowser.Common.Kernel; -using MediaBrowser.Common.Net; -using MediaBrowser.Common.Plugins; -using MediaBrowser.Common.Progress; -using MediaBrowser.Common.Updates; -using MediaBrowser.Model.IO; -using MediaBrowser.Model.Logging; -using MediaBrowser.Model.Serialization; -using MediaBrowser.Model.Updates; -using System; -using System.Collections.Concurrent; -using System.Collections.Generic; -using System.IO; -using System.Linq; -using System.Threading; -using System.Threading.Tasks; - -namespace MediaBrowser.Controller.Updates -{ - /// - /// Manages all install, uninstall and update operations (both plugins and system) - /// - public class InstallationManager : BaseManager - { - public event EventHandler> PackageInstalling; - public event EventHandler> PackageInstallationCompleted; - public event EventHandler> PackageInstallationFailed; - public event EventHandler> PackageInstallationCancelled; - - /// - /// The current installations - /// - public List> CurrentInstallations { get; set; } - - /// - /// The completed installations - /// - public ConcurrentBag CompletedInstallations { get; set; } - - #region PluginUninstalled Event - /// - /// Occurs when [plugin uninstalled]. - /// - public event EventHandler> PluginUninstalled; - - /// - /// Called when [plugin uninstalled]. - /// - /// The plugin. - private void OnPluginUninstalled(IPlugin plugin) - { - EventHelper.QueueEventIfNotNull(PluginUninstalled, this, new GenericEventArgs { Argument = plugin }, _logger); - } - #endregion - - #region PluginUpdated Event - /// - /// Occurs when [plugin updated]. - /// - public event EventHandler>> PluginUpdated; - /// - /// Called when [plugin updated]. - /// - /// The plugin. - /// The new version. - public void OnPluginUpdated(IPlugin plugin, PackageVersionInfo newVersion) - { - _logger.Info("Plugin updated: {0} {1} {2}", newVersion.name, newVersion.version, newVersion.classification); - - EventHelper.QueueEventIfNotNull(PluginUpdated, this, new GenericEventArgs> { Argument = new Tuple(plugin, newVersion) }, _logger); - - Kernel.NotifyPendingRestart(); - } - #endregion - - #region PluginInstalled Event - /// - /// Occurs when [plugin updated]. - /// - public event EventHandler> PluginInstalled; - /// - /// Called when [plugin installed]. - /// - /// The package. - public void OnPluginInstalled(PackageVersionInfo package) - { - _logger.Info("New plugin installed: {0} {1} {2}", package.name, package.version, package.classification); - - EventHelper.QueueEventIfNotNull(PluginInstalled, this, new GenericEventArgs { Argument = package }, _logger); - - Kernel.NotifyPendingRestart(); - } - #endregion - - /// - /// The _logger - /// - private readonly ILogger _logger; - - /// - /// The _network manager - /// - private readonly INetworkManager _networkManager; - - /// - /// The package manager - /// - private readonly IPackageManager _packageManager; - - /// - /// Gets the json serializer. - /// - /// The json serializer. - protected IJsonSerializer JsonSerializer { get; private set; } - - /// - /// Gets the HTTP client. - /// - /// The HTTP client. - protected IHttpClient HttpClient { get; private set; } - - /// - /// Gets the application host. - /// - /// The application host. - protected IApplicationHost ApplicationHost { get; private set; } - - /// - /// Initializes a new instance of the class. - /// - /// The kernel. - /// The HTTP client. - /// The network manager. - /// The package manager. - /// The json serializer. - /// The logger. - /// The app host. - /// zipClient - public InstallationManager(Kernel kernel, IHttpClient httpClient, INetworkManager networkManager, IPackageManager packageManager, IJsonSerializer jsonSerializer, ILogger logger, IApplicationHost appHost) - : base(kernel) - { - if (networkManager == null) - { - throw new ArgumentNullException("networkManager"); - } - if (packageManager == null) - { - throw new ArgumentNullException("packageManager"); - } - if (logger == null) - { - throw new ArgumentNullException("logger"); - } - if (jsonSerializer == null) - { - throw new ArgumentNullException("jsonSerializer"); - } - if (httpClient == null) - { - throw new ArgumentNullException("httpClient"); - } - - CurrentInstallations = new List>(); - CompletedInstallations = new ConcurrentBag(); - JsonSerializer = jsonSerializer; - HttpClient = httpClient; - ApplicationHost = appHost; - _networkManager = networkManager; - _packageManager = packageManager; - _logger = logger; - } - - /// - /// Gets all available packages. - /// - /// The cancellation token. - /// Type of the package. - /// The application version. - /// Task{List{PackageInfo}}. - public async Task> GetAvailablePackages(CancellationToken cancellationToken, - PackageType? packageType = null, - Version applicationVersion = null) - { - var packages = (await _packageManager.GetAvailablePackages(cancellationToken).ConfigureAwait(false)).ToList(); - - if (packageType.HasValue) - { - packages = packages.Where(p => p.type == packageType.Value).ToList(); - } - - // If an app version was supplied, filter the versions for each package to only include supported versions - if (applicationVersion != null) - { - foreach (var package in packages) - { - package.versions = package.versions.Where(v => IsPackageVersionUpToDate(v, applicationVersion)).ToList(); - } - } - - // Remove packages with no versions - packages = packages.Where(p => p.versions.Any()).ToList(); - - return packages; - } - - /// - /// Determines whether [is package version up to date] [the specified package version info]. - /// - /// The package version info. - /// The application version. - /// true if [is package version up to date] [the specified package version info]; otherwise, false. - private bool IsPackageVersionUpToDate(PackageVersionInfo packageVersionInfo, Version applicationVersion) - { - if (string.IsNullOrEmpty(packageVersionInfo.requiredVersionStr)) - { - return true; - } - - Version requiredVersion; - - return Version.TryParse(packageVersionInfo.requiredVersionStr, out requiredVersion) && applicationVersion >= requiredVersion; - } - - /// - /// Gets the package. - /// - /// The name. - /// The classification. - /// The version. - /// Task{PackageVersionInfo}. - public async Task GetPackage(string name, PackageVersionClass classification, Version version) - { - var packages = await GetAvailablePackages(CancellationToken.None).ConfigureAwait(false); - - var package = packages.FirstOrDefault(p => p.name.Equals(name, StringComparison.OrdinalIgnoreCase)); - - if (package == null) - { - return null; - } - - return package.versions.FirstOrDefault(v => v.version.Equals(version) && v.classification == classification); - } - - /// - /// Gets the latest compatible version. - /// - /// The name. - /// The classification. - /// Task{PackageVersionInfo}. - public async Task GetLatestCompatibleVersion(string name, PackageVersionClass classification = PackageVersionClass.Release) - { - var packages = await GetAvailablePackages(CancellationToken.None).ConfigureAwait(false); - - return GetLatestCompatibleVersion(packages, name, classification); - } - - /// - /// Gets the latest compatible version. - /// - /// The available packages. - /// The name. - /// The classification. - /// PackageVersionInfo. - public PackageVersionInfo GetLatestCompatibleVersion(IEnumerable availablePackages, string name, PackageVersionClass classification = PackageVersionClass.Release) - { - var package = availablePackages.FirstOrDefault(p => p.name.Equals(name, StringComparison.OrdinalIgnoreCase)); - - if (package == null) - { - return null; - } - - return package.versions - .OrderByDescending(v => v.version) - .FirstOrDefault(v => v.classification <= classification && IsPackageVersionUpToDate(v, ApplicationHost.ApplicationVersion)); - } - - /// - /// Gets the available plugin updates. - /// - /// if set to true [with auto update enabled]. - /// The cancellation token. - /// Task{IEnumerable{PackageVersionInfo}}. - public async Task> GetAvailablePluginUpdates(bool withAutoUpdateEnabled, CancellationToken cancellationToken) - { - var catalog = await GetAvailablePackages(cancellationToken).ConfigureAwait(false); - - var plugins = ApplicationHost.Plugins; - - if (withAutoUpdateEnabled) - { - plugins = plugins.Where(p => p.Configuration.EnableAutoUpdate); - } - - // Figure out what needs to be installed - return plugins.Select(p => - { - var latestPluginInfo = GetLatestCompatibleVersion(catalog, p.Name, p.Configuration.UpdateClass); - - return latestPluginInfo != null && latestPluginInfo.version > p.Version ? latestPluginInfo : null; - - }).Where(p => !CompletedInstallations.Any(i => i.Name.Equals(p.name, StringComparison.OrdinalIgnoreCase))) - .Where(p => p != null && !string.IsNullOrWhiteSpace(p.sourceUrl)); - } - - /// - /// Installs the package. - /// - /// The package. - /// The progress. - /// The cancellation token. - /// Task. - /// package - public async Task InstallPackage(PackageVersionInfo package, IProgress progress, CancellationToken cancellationToken) - { - if (package == null) - { - throw new ArgumentNullException("package"); - } - - if (progress == null) - { - throw new ArgumentNullException("progress"); - } - - if (cancellationToken == null) - { - throw new ArgumentNullException("cancellationToken"); - } - - var installationInfo = new InstallationInfo - { - Id = Guid.NewGuid(), - Name = package.name, - UpdateClass = package.classification, - Version = package.versionStr - }; - - var innerCancellationTokenSource = new CancellationTokenSource(); - - var tuple = new Tuple(installationInfo, innerCancellationTokenSource); - - // Add it to the in-progress list - lock (CurrentInstallations) - { - CurrentInstallations.Add(tuple); - } - - var innerProgress = new ActionableProgress { }; - - // 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; - - EventHelper.QueueEventIfNotNull(PackageInstalling, this, new GenericEventArgs() { Argument = installationInfo }, _logger); - - try - { - await InstallPackageInternal(package, innerProgress, linkedToken).ConfigureAwait(false); - - lock (CurrentInstallations) - { - CurrentInstallations.Remove(tuple); - } - - CompletedInstallations.Add(installationInfo); - - EventHelper.QueueEventIfNotNull(PackageInstallationCompleted, this, new GenericEventArgs() { Argument = installationInfo }, _logger); - } - catch (OperationCanceledException) - { - lock (CurrentInstallations) - { - CurrentInstallations.Remove(tuple); - } - - _logger.Info("Package installation cancelled: {0} {1}", package.name, package.versionStr); - - EventHelper.QueueEventIfNotNull(PackageInstallationCancelled, this, new GenericEventArgs() { Argument = installationInfo }, _logger); - - throw; - } - catch - { - lock (CurrentInstallations) - { - CurrentInstallations.Remove(tuple); - } - - EventHelper.QueueEventIfNotNull(PackageInstallationFailed, this, new GenericEventArgs() { Argument = installationInfo }, _logger); - - throw; - } - finally - { - // Dispose the progress object and remove the installation from the in-progress list - - innerProgress.Dispose(); - tuple.Item2.Dispose(); - } - } - - /// - /// Installs the package internal. - /// - /// The package. - /// The progress. - /// The cancellation token. - /// Task. - private async Task InstallPackageInternal(PackageVersionInfo package, IProgress progress, CancellationToken cancellationToken) - { - // Do the install - await _packageManager.InstallPackage(progress, package, cancellationToken).ConfigureAwait(false); - - // Do plugin-specific processing - if (!(Path.GetExtension(package.targetFilename) ?? "").Equals(".zip", StringComparison.OrdinalIgnoreCase)) - { - // Set last update time if we were installed before - var plugin = ApplicationHost.Plugins.FirstOrDefault(p => p.Name.Equals(package.name, StringComparison.OrdinalIgnoreCase)); - - if (plugin != null) - { - // Synchronize the UpdateClass value - if (plugin.Configuration.UpdateClass != package.classification) - { - plugin.Configuration.UpdateClass = package.classification; - plugin.SaveConfiguration(); - } - - OnPluginUpdated(plugin, package); - } - else - { - OnPluginInstalled(package); - } - - } - } - - /// - /// Uninstalls a plugin - /// - /// The plugin. - /// - public void UninstallPlugin(IPlugin plugin) - { - if (plugin.IsCorePlugin) - { - throw new ArgumentException(string.Format("{0} cannot be uninstalled because it is a core plugin.", plugin.Name)); - } - - plugin.OnUninstalling(); - - // Remove it the quick way for now - ApplicationHost.RemovePlugin(plugin); - - File.Delete(plugin.AssemblyFilePath); - - OnPluginUninstalled(plugin); - - Kernel.NotifyPendingRestart(); - } - - /// - /// Releases unmanaged and - optionally - managed resources. - /// - /// true to release both managed and unmanaged resources; false to release only unmanaged resources. - protected override void Dispose(bool dispose) - { - if (dispose) - { - lock (CurrentInstallations) - { - foreach (var tuple in CurrentInstallations) - { - tuple.Item2.Dispose(); - } - - CurrentInstallations.Clear(); - } - } - base.Dispose(dispose); - } - } -} -- cgit v1.2.3