From 9caf3119257544d6fb8fd3e1f1cb2b50eba7bd39 Mon Sep 17 00:00:00 2001 From: dkanada Date: Fri, 12 Feb 2021 22:33:10 +0900 Subject: [PATCH] handle plugin manifests automatically --- .../Plugins/PluginManager.cs | 56 +++++++++++++------ .../Updates/InstallationManager.cs | 22 ++------ MediaBrowser.Common/Plugins/IPluginManager.cs | 10 ++++ .../Updates/InstallationInfo.cs | 7 +++ 4 files changed, 61 insertions(+), 34 deletions(-) diff --git a/Emby.Server.Implementations/Plugins/PluginManager.cs b/Emby.Server.Implementations/Plugins/PluginManager.cs index c26ccfd88..696133c9f 100644 --- a/Emby.Server.Implementations/Plugins/PluginManager.cs +++ b/Emby.Server.Implementations/Plugins/PluginManager.cs @@ -1,12 +1,13 @@ #nullable enable + using System; using System.Collections.Generic; using System.IO; using System.Linq; +using System.Net; using System.Reflection; using System.Text; using System.Text.Json; -using System.Threading.Tasks; using MediaBrowser.Common; using MediaBrowser.Common.Extensions; using MediaBrowser.Common.Json; @@ -14,6 +15,7 @@ using MediaBrowser.Common.Json.Converters; using MediaBrowser.Common.Plugins; using MediaBrowser.Model.Configuration; using MediaBrowser.Model.Plugins; +using MediaBrowser.Model.Updates; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Logging; @@ -332,34 +334,54 @@ namespace Emby.Server.Implementations.Plugins ChangePluginState(plugin, PluginStatus.Malfunctioned); } - /// - /// Saves the manifest back to disk. - /// - /// The to save. - /// The path where to save the manifest. - /// True if successful. + /// public bool SaveManifest(PluginManifest manifest, string path) { - if (manifest == null) - { - return false; - } - try { var data = JsonSerializer.Serialize(manifest, _jsonOptions); File.WriteAllText(Path.Combine(path, "meta.json"), data); return true; } -#pragma warning disable CA1031 // Do not catch general exception types - catch (Exception e) -#pragma warning restore CA1031 // Do not catch general exception types + catch (ArgumentException e) { - _logger.LogWarning(e, "Unable to save plugin manifest. {Path}", path); + _logger.LogWarning(e, "Unable to save plugin manifest due to invalid value. {Path}", path); return false; } } + /// + public bool GenerateManifest(PackageInfo packageInfo, Version version, string path) + { + var versionInfo = packageInfo.Versions.First(v => v.Version == version.ToString()); + var url = packageInfo.ImageUrl ?? string.Empty; + var imageFilename = url.Substring(url.LastIndexOf('/') + 1, url.Length); + + using (var client = new WebClient()) + { + client.DownloadFile(url, Path.Join(path, imageFilename)); + } + + var manifest = new PluginManifest + { + Category = packageInfo.Category, + Changelog = versionInfo.Changelog ?? string.Empty, + Description = packageInfo.Description, + Id = new Guid(packageInfo.Id), + Name = packageInfo.Name, + Overview = packageInfo.Overview, + Owner = packageInfo.Owner, + TargetAbi = versionInfo.TargetAbi ?? string.Empty, + Timestamp = DateTime.Parse(versionInfo.Timestamp ?? string.Empty), + Version = versionInfo.Version, + Status = PluginStatus.Active, + AutoUpdate = true, + ImagePath = Path.Join(path, imageFilename) + }; + + return SaveManifest(manifest, path); + } + /// /// Changes a plugin's load status. /// @@ -410,7 +432,7 @@ namespace Emby.Server.Implementations.Plugins if (plugin == null) { // Create a dummy record for the providers. - // TODO: remove this code, if all provided have been released as separate plugins. + // TODO: remove this code once all provided have been released as separate plugins. plugin = new LocalPlugin( instance.AssemblyFilePath, true, diff --git a/Emby.Server.Implementations/Updates/InstallationManager.cs b/Emby.Server.Implementations/Updates/InstallationManager.cs index abcb4313f..534c0aa4b 100644 --- a/Emby.Server.Implementations/Updates/InstallationManager.cs +++ b/Emby.Server.Implementations/Updates/InstallationManager.cs @@ -192,17 +192,12 @@ namespace Emby.Server.Implementations.Updates var version = package.Versions[i]; var plugin = _pluginManager.GetPlugin(packageGuid, version.VersionNumber); - // Update the manifests, if anything changes. if (plugin != null) { - if (!string.Equals(plugin.Manifest.TargetAbi, version.TargetAbi, StringComparison.Ordinal)) - { - plugin.Manifest.TargetAbi = version.TargetAbi ?? string.Empty; - _pluginManager.SaveManifest(plugin.Manifest, plugin.Path); - } + _pluginManager.GenerateManifest(package, version.VersionNumber, plugin.Path); } - // Remove versions with a target abi that is greater then the current application version. + // Remove versions with a target ABI greater then the current application version. if (Version.TryParse(version.TargetAbi, out var targetAbi) && _applicationHost.ApplicationVersion < targetAbi) { package.Versions.RemoveAt(i); @@ -294,7 +289,8 @@ namespace Emby.Server.Implementations.Updates Name = package.Name, Version = v.VersionNumber, SourceUrl = v.SourceUrl, - Checksum = v.Checksum + Checksum = v.Checksum, + PackageInfo = package }; } } @@ -571,24 +567,16 @@ namespace Emby.Server.Implementations.Updates stream.Position = 0; _zipClient.ExtractAllFromZip(stream, targetDir, true); + _pluginManager.GenerateManifest(package.PackageInfo, package.Version, targetDir); _pluginManager.ImportPluginFrom(targetDir); } private async Task InstallPackageInternal(InstallationInfo package, CancellationToken cancellationToken) { - // Set last update time if we were installed before LocalPlugin? plugin = _pluginManager.Plugins.FirstOrDefault(p => p.Id.Equals(package.Id) && p.Version.Equals(package.Version)) ?? _pluginManager.Plugins.FirstOrDefault(p => p.Name.Equals(package.Name, StringComparison.OrdinalIgnoreCase) && p.Version.Equals(package.Version)); - if (plugin != null) - { - plugin.Manifest.Timestamp = DateTime.UtcNow; - _pluginManager.SaveManifest(plugin.Manifest, plugin.Path); - } - // Do the install await PerformPackageInstallation(package, cancellationToken).ConfigureAwait(false); - - // Do plugin-specific processing _logger.LogInformation(plugin == null ? "New plugin installed: {PluginName} {PluginVersion}" : "Plugin updated: {PluginName} {PluginVersion}", package.Name, package.Version); return plugin != null; diff --git a/MediaBrowser.Common/Plugins/IPluginManager.cs b/MediaBrowser.Common/Plugins/IPluginManager.cs index 3da34d8bb..6f0a0fbfc 100644 --- a/MediaBrowser.Common/Plugins/IPluginManager.cs +++ b/MediaBrowser.Common/Plugins/IPluginManager.cs @@ -4,6 +4,7 @@ using System; using System.Collections.Generic; using System.Reflection; using System.Threading.Tasks; +using MediaBrowser.Model.Updates; using Microsoft.Extensions.DependencyInjection; namespace MediaBrowser.Common.Plugins @@ -44,6 +45,15 @@ namespace MediaBrowser.Common.Plugins /// True if successful. bool SaveManifest(PluginManifest manifest, string path); + /// + /// Generates a manifest from repository data. + /// + /// The used to generate a manifest. + /// Version to be installed. + /// The path where to save the manifest. + /// True if successful. + bool GenerateManifest(PackageInfo packageInfo, Version version, string path); + /// /// Imports plugin details from a folder. /// diff --git a/MediaBrowser.Model/Updates/InstallationInfo.cs b/MediaBrowser.Model/Updates/InstallationInfo.cs index eebe1a903..cc600de9d 100644 --- a/MediaBrowser.Model/Updates/InstallationInfo.cs +++ b/MediaBrowser.Model/Updates/InstallationInfo.cs @@ -1,4 +1,5 @@ #nullable disable + using System; using System.Text.Json.Serialization; @@ -45,5 +46,11 @@ namespace MediaBrowser.Model.Updates /// /// The checksum. public string Checksum { get; set; } + + /// + /// Gets or sets package information for the installation. + /// + /// The package information. + public PackageInfo PackageInfo { get; set; } } }