浏览代码

fix a few issues with the plugin manifest

dkanada 5 年之前
父节点
当前提交
7972daaba4

+ 9 - 9
Emby.Server.Implementations/Activity/ActivityLogEntryPoint.cs

@@ -377,50 +377,50 @@ namespace Emby.Server.Implementations.Activity
             }).ConfigureAwait(false);
         }
 
-        private async void OnPluginUpdated(object sender, GenericEventArgs<(IPlugin, VersionInfo)> e)
+        private async void OnPluginUpdated(object sender, InstallationInfo e)
         {
             await CreateLogEntry(new ActivityLog(
                 string.Format(
                     CultureInfo.InvariantCulture,
                     _localization.GetLocalizedString("PluginUpdatedWithName"),
-                    e.Argument.Item1.Name),
+                    e.Name),
                 NotificationType.PluginUpdateInstalled.ToString(),
                 Guid.Empty)
             {
                 ShortOverview = string.Format(
                     CultureInfo.InvariantCulture,
                     _localization.GetLocalizedString("VersionNumber"),
-                    e.Argument.Item2.version),
-                Overview = e.Argument.Item2.changelog
+                    e.Version),
+                Overview = e.Changelog
             }).ConfigureAwait(false);
         }
 
-        private async void OnPluginUninstalled(object sender, GenericEventArgs<IPlugin> e)
+        private async void OnPluginUninstalled(object sender, IPlugin e)
         {
             await CreateLogEntry(new ActivityLog(
                 string.Format(
                     CultureInfo.InvariantCulture,
                     _localization.GetLocalizedString("PluginUninstalledWithName"),
-                    e.Argument.Name),
+                    e.Name),
                 NotificationType.PluginUninstalled.ToString(),
                 Guid.Empty))
                 .ConfigureAwait(false);
         }
 
-        private async void OnPluginInstalled(object sender, GenericEventArgs<VersionInfo> e)
+        private async void OnPluginInstalled(object sender, InstallationInfo e)
         {
             await CreateLogEntry(new ActivityLog(
                 string.Format(
                     CultureInfo.InvariantCulture,
                     _localization.GetLocalizedString("PluginInstalledWithName"),
-                    e.Argument.name),
+                    e.Name),
                 NotificationType.PluginInstalled.ToString(),
                 Guid.Empty)
             {
                 ShortOverview = string.Format(
                     CultureInfo.InvariantCulture,
                     _localization.GetLocalizedString("VersionNumber"),
-                    e.Argument.version)
+                    e.Version)
             }).ConfigureAwait(false);
         }
 

+ 9 - 8
Emby.Server.Implementations/EntryPoints/ServerEventNotifier.cs

@@ -12,6 +12,7 @@ using MediaBrowser.Controller.Plugins;
 using MediaBrowser.Controller.Session;
 using MediaBrowser.Model.Events;
 using MediaBrowser.Model.Tasks;
+using MediaBrowser.Model.Updates;
 
 namespace Emby.Server.Implementations.EntryPoints
 {
@@ -85,19 +86,19 @@ namespace Emby.Server.Implementations.EntryPoints
             return Task.CompletedTask;
         }
 
-        private void OnPackageInstalling(object sender, InstallationEventArgs e)
+        private void OnPackageInstalling(object sender, InstallationInfo e)
         {
-            SendMessageToAdminSessions("PackageInstalling", e.InstallationInfo);
+            SendMessageToAdminSessions("PackageInstalling", e);
         }
 
-        private void OnPackageInstallationCancelled(object sender, InstallationEventArgs e)
+        private void OnPackageInstallationCancelled(object sender, InstallationInfo e)
         {
-            SendMessageToAdminSessions("PackageInstallationCancelled", e.InstallationInfo);
+            SendMessageToAdminSessions("PackageInstallationCancelled", e);
         }
 
-        private void OnPackageInstallationCompleted(object sender, InstallationEventArgs e)
+        private void OnPackageInstallationCompleted(object sender, InstallationInfo e)
         {
-            SendMessageToAdminSessions("PackageInstallationCompleted", e.InstallationInfo);
+            SendMessageToAdminSessions("PackageInstallationCompleted", e);
         }
 
         private void OnPackageInstallationFailed(object sender, InstallationFailedEventArgs e)
@@ -115,9 +116,9 @@ namespace Emby.Server.Implementations.EntryPoints
         /// </summary>
         /// <param name="sender">The sender.</param>
         /// <param name="e">The e.</param>
-        private void OnPluginUninstalled(object sender, GenericEventArgs<IPlugin> e)
+        private void OnPluginUninstalled(object sender, IPlugin e)
         {
-            SendMessageToAdminSessions("PluginUninstalled", e.Argument.GetPluginInfo());
+            SendMessageToAdminSessions("PluginUninstalled", e);
         }
 
         /// <summary>

+ 2 - 2
Emby.Server.Implementations/ScheduledTasks/Tasks/PluginUpdateTask.cs

@@ -80,11 +80,11 @@ namespace Emby.Server.Implementations.ScheduledTasks
                 }
                 catch (HttpException ex)
                 {
-                    _logger.LogError(ex, "Error downloading {0}", package.name);
+                    _logger.LogError(ex, "Error downloading {0}", package.Name);
                 }
                 catch (IOException ex)
                 {
-                    _logger.LogError(ex, "Error updating {0}", package.name);
+                    _logger.LogError(ex, "Error updating {0}", package.Name);
                 }
 
                 // Update progress

+ 61 - 72
Emby.Server.Implementations/Updates/InstallationManager.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections;
 using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.IO;
@@ -97,25 +98,25 @@ namespace Emby.Server.Implementations.Updates
         }
 
         /// <inheritdoc />
-        public event EventHandler<InstallationEventArgs> PackageInstalling;
+        public event EventHandler<InstallationInfo> PackageInstalling;
 
         /// <inheritdoc />
-        public event EventHandler<InstallationEventArgs> PackageInstallationCompleted;
+        public event EventHandler<InstallationInfo> PackageInstallationCompleted;
 
         /// <inheritdoc />
         public event EventHandler<InstallationFailedEventArgs> PackageInstallationFailed;
 
         /// <inheritdoc />
-        public event EventHandler<InstallationEventArgs> PackageInstallationCancelled;
+        public event EventHandler<InstallationInfo> PackageInstallationCancelled;
 
         /// <inheritdoc />
-        public event EventHandler<GenericEventArgs<IPlugin>> PluginUninstalled;
+        public event EventHandler<IPlugin> PluginUninstalled;
 
         /// <inheritdoc />
-        public event EventHandler<GenericEventArgs<(IPlugin, VersionInfo)>> PluginUpdated;
+        public event EventHandler<InstallationInfo> PluginUpdated;
 
         /// <inheritdoc />
-        public event EventHandler<GenericEventArgs<VersionInfo>> PluginInstalled;
+        public event EventHandler<InstallationInfo> PluginInstalled;
 
         /// <inheritdoc />
         public IEnumerable<InstallationInfo> CompletedInstallations => _completedInstallationsInternal;
@@ -183,24 +184,7 @@ namespace Emby.Server.Implementations.Updates
         }
 
         /// <inheritdoc />
-        public IEnumerable<VersionInfo> GetCompatibleVersions(
-            IEnumerable<VersionInfo> availableVersions,
-            Version minVersion = null)
-        {
-            var appVer = _applicationHost.ApplicationVersion;
-            availableVersions = availableVersions
-                .Where(x => Version.Parse(x.targetAbi) <= appVer);
-
-            if (minVersion != null)
-            {
-                availableVersions = availableVersions.Where(x => x.version >= minVersion);
-            }
-
-            return availableVersions.OrderByDescending(x => x.version);
-        }
-
-        /// <inheritdoc />
-        public IEnumerable<VersionInfo> GetCompatibleVersions(
+        public IEnumerable<InstallationInfo> GetCompatibleVersions(
             IEnumerable<PackageInfo> availablePackages,
             string name = null,
             Guid guid = default,
@@ -211,28 +195,46 @@ namespace Emby.Server.Implementations.Updates
             // Package not found in repository
             if (package == null)
             {
-                return Enumerable.Empty<VersionInfo>();
+                yield break;
+            }
+
+            var appVer = _applicationHost.ApplicationVersion;
+            var availableVersions = package.versions
+                .Where(x => Version.Parse(x.targetAbi) <= appVer);
+
+            if (minVersion != null)
+            {
+                availableVersions = availableVersions
+                    .Where(x => new Version(x.version) >= minVersion)
+                    .OrderByDescending(x => x.version);
             }
 
-            return GetCompatibleVersions(
-                package.versions,
-                minVersion);
+            foreach (var v in availableVersions)
+            {
+                yield return new InstallationInfo
+                {
+                    Changelog = v.changelog,
+                    Guid = new Guid(package.guid),
+                    Name = package.name,
+                    Version = new Version(v.version)
+                };
+            }
         }
 
         /// <inheritdoc />
-        public async Task<IEnumerable<VersionInfo>> GetAvailablePluginUpdates(CancellationToken cancellationToken = default)
+        public async Task<IEnumerable<InstallationInfo>> GetAvailablePluginUpdates(CancellationToken cancellationToken = default)
         {
             var catalog = await GetAvailablePackages(cancellationToken).ConfigureAwait(false);
             return GetAvailablePluginUpdates(catalog);
         }
 
-        private IEnumerable<VersionInfo> GetAvailablePluginUpdates(IReadOnlyList<PackageInfo> pluginCatalog)
+        private IEnumerable<InstallationInfo> GetAvailablePluginUpdates(IReadOnlyList<PackageInfo> pluginCatalog)
         {
             foreach (var plugin in _applicationHost.Plugins)
             {
                 var compatibleversions = GetCompatibleVersions(pluginCatalog, plugin.Name, plugin.Id, plugin.Version);
-                var version = compatibleversions.FirstOrDefault(y => y.version > plugin.Version);
-                if (version != null && !CompletedInstallations.Any(x => string.Equals(x.Guid, version.guid, StringComparison.OrdinalIgnoreCase)))
+                var version = compatibleversions.FirstOrDefault(y => y.Version > plugin.Version);
+                if (version != null && CompletedInstallations.All(x => x.Guid != version.Guid))
                 {
                     yield return version;
                 }
@@ -240,23 +242,16 @@ namespace Emby.Server.Implementations.Updates
         }
 
         /// <inheritdoc />
-        public async Task InstallPackage(VersionInfo package, CancellationToken cancellationToken)
+        public async Task InstallPackage(InstallationInfo package, CancellationToken cancellationToken)
         {
             if (package == null)
             {
                 throw new ArgumentNullException(nameof(package));
             }
 
-            var installationInfo = new InstallationInfo
-            {
-                Guid = package.guid,
-                Name = package.name,
-                Version = package.version.ToString()
-            };
-
             var innerCancellationTokenSource = new CancellationTokenSource();
 
-            var tuple = (installationInfo, innerCancellationTokenSource);
+            var tuple = (package, innerCancellationTokenSource);
 
             // Add it to the in-progress list
             lock (_currentInstallationsLock)
@@ -266,13 +261,7 @@ namespace Emby.Server.Implementations.Updates
 
             var linkedToken = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken, innerCancellationTokenSource.Token).Token;
 
-            var installationEventArgs = new InstallationEventArgs
-            {
-                InstallationInfo = installationInfo,
-                VersionInfo = package
-            };
-
-            PackageInstalling?.Invoke(this, installationEventArgs);
+            PackageInstalling?.Invoke(this, package);
 
             try
             {
@@ -283,9 +272,9 @@ namespace Emby.Server.Implementations.Updates
                     _currentInstallations.Remove(tuple);
                 }
 
-                _completedInstallationsInternal.Add(installationInfo);
+                _completedInstallationsInternal.Add(package);
 
-                PackageInstallationCompleted?.Invoke(this, installationEventArgs);
+                PackageInstallationCompleted?.Invoke(this, package);
             }
             catch (OperationCanceledException)
             {
@@ -294,9 +283,9 @@ namespace Emby.Server.Implementations.Updates
                     _currentInstallations.Remove(tuple);
                 }
 
-                _logger.LogInformation("Package installation cancelled: {0} {1}", package.name, package.version);
+                _logger.LogInformation("Package installation cancelled: {0} {1}", package.Name, package.Version);
 
-                PackageInstallationCancelled?.Invoke(this, installationEventArgs);
+                PackageInstallationCancelled?.Invoke(this, package);
 
                 throw;
             }
@@ -311,7 +300,7 @@ namespace Emby.Server.Implementations.Updates
 
                 PackageInstallationFailed?.Invoke(this, new InstallationFailedEventArgs
                 {
-                    InstallationInfo = installationInfo,
+                    InstallationInfo = package,
                     Exception = ex
                 });
 
@@ -330,11 +319,11 @@ namespace Emby.Server.Implementations.Updates
         /// <param name="package">The package.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
         /// <returns><see cref="Task" />.</returns>
-        private async Task InstallPackageInternal(VersionInfo package, CancellationToken cancellationToken)
+        private async Task InstallPackageInternal(InstallationInfo package, CancellationToken cancellationToken)
         {
             // Set last update time if we were installed before
-            IPlugin 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));
+            IPlugin plugin = _applicationHost.Plugins.FirstOrDefault(p => p.Id == package.Guid)
+                           ?? _applicationHost.Plugins.FirstOrDefault(p => p.Name.Equals(package.Name, StringComparison.OrdinalIgnoreCase));
 
             // Do the install
             await PerformPackageInstallation(package, cancellationToken).ConfigureAwait(false);
@@ -342,38 +331,38 @@ namespace Emby.Server.Implementations.Updates
             // Do plugin-specific processing
             if (plugin == null)
             {
-                _logger.LogInformation("New plugin installed: {0} {1} {2}", package.name, package.version);
+                _logger.LogInformation("New plugin installed: {0} {1} {2}", package.Name, package.Version);
 
-                PluginInstalled?.Invoke(this, new GenericEventArgs<VersionInfo>(package));
+                PluginInstalled?.Invoke(this, package);
             }
             else
             {
-                _logger.LogInformation("Plugin updated: {0} {1} {2}", package.name, package.version);
+                _logger.LogInformation("Plugin updated: {0} {1} {2}", package.Name, package.Version);
 
-                PluginUpdated?.Invoke(this, new GenericEventArgs<(IPlugin, VersionInfo)>((plugin, package)));
+                PluginUpdated?.Invoke(this, package);
             }
 
             _applicationHost.NotifyPendingRestart();
         }
 
-        private async Task PerformPackageInstallation(VersionInfo package, CancellationToken cancellationToken)
+        private async Task PerformPackageInstallation(InstallationInfo package, CancellationToken cancellationToken)
         {
-            var extension = Path.GetExtension(package.filename);
+            var extension = Path.GetExtension(package.SourceUrl);
             if (!string.Equals(extension, ".zip", StringComparison.OrdinalIgnoreCase))
             {
-                _logger.LogError("Only zip packages are supported. {Filename} is not a zip archive.", package.filename);
+                _logger.LogError("Only zip packages are supported. {Filename} is not a zip archive.", package.SourceUrl);
                 return;
             }
 
             // Always override the passed-in target (which is a file) and figure it out again
-            string targetDir = Path.Combine(_appPaths.PluginsPath, package.name);
+            string targetDir = Path.Combine(_appPaths.PluginsPath, package.Name);
 
             // CA5351: Do Not Use Broken Cryptographic Algorithms
 #pragma warning disable CA5351
             using (var res = await _httpClient.SendAsync(
                 new HttpRequestOptions
                 {
-                    Url = package.sourceUrl,
+                    Url = package.SourceUrl,
                     CancellationToken = cancellationToken,
                     // We need it to be buffered for setting the position
                     BufferContent = true
@@ -385,12 +374,12 @@ namespace Emby.Server.Implementations.Updates
                 cancellationToken.ThrowIfCancellationRequested();
 
                 var hash = Hex.Encode(md5.ComputeHash(stream));
-                if (!string.Equals(package.checksum, hash, StringComparison.OrdinalIgnoreCase))
+                if (!string.Equals(package.Checksum, hash, StringComparison.OrdinalIgnoreCase))
                 {
                     _logger.LogError(
                         "The checksums didn't match while installing {Package}, expected: {Expected}, got: {Received}",
-                        package.name,
-                        package.checksum,
+                        package.Name,
+                        package.Checksum,
                         hash);
                     throw new InvalidDataException("The checksum of the received data doesn't match.");
                 }
@@ -456,7 +445,7 @@ namespace Emby.Server.Implementations.Updates
                 _config.SaveConfiguration();
             }
 
-            PluginUninstalled?.Invoke(this, new GenericEventArgs<IPlugin> { Argument = plugin });
+            PluginUninstalled?.Invoke(this, plugin);
 
             _applicationHost.NotifyPendingRestart();
         }
@@ -466,7 +455,7 @@ namespace Emby.Server.Implementations.Updates
         {
             lock (_currentInstallationsLock)
             {
-                var install = _currentInstallations.Find(x => x.info.Guid == id.ToString());
+                var install = _currentInstallations.Find(x => x.info.Guid == id);
                 if (install == default((InstallationInfo, CancellationTokenSource)))
                 {
                     return false;
@@ -486,9 +475,9 @@ namespace Emby.Server.Implementations.Updates
         }
 
         /// <summary>
-        /// Releases unmanaged and - optionally - managed resources.
+        /// 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>
+        /// <param name="dispose"><c>true</c> to release both managed and unmanaged resources or <c>false</c> to release only unmanaged resources.</param>
         protected virtual void Dispose(bool dispose)
         {
             if (dispose)

+ 9 - 19
MediaBrowser.Common/Updates/IInstallationManager.cs

@@ -12,28 +12,28 @@ namespace MediaBrowser.Common.Updates
 {
     public interface IInstallationManager : IDisposable
     {
-        event EventHandler<InstallationEventArgs> PackageInstalling;
+        event EventHandler<InstallationInfo> PackageInstalling;
 
-        event EventHandler<InstallationEventArgs> PackageInstallationCompleted;
+        event EventHandler<InstallationInfo> PackageInstallationCompleted;
 
         event EventHandler<InstallationFailedEventArgs> PackageInstallationFailed;
 
-        event EventHandler<InstallationEventArgs> PackageInstallationCancelled;
+        event EventHandler<InstallationInfo> PackageInstallationCancelled;
 
         /// <summary>
         /// Occurs when a plugin is uninstalled.
         /// </summary>
-        event EventHandler<GenericEventArgs<IPlugin>> PluginUninstalled;
+        event EventHandler<IPlugin> PluginUninstalled;
 
         /// <summary>
         /// Occurs when a plugin is updated.
         /// </summary>
-        event EventHandler<GenericEventArgs<(IPlugin, VersionInfo)>> PluginUpdated;
+        event EventHandler<InstallationInfo> PluginUpdated;
 
         /// <summary>
         /// Occurs when a plugin is installed.
         /// </summary>
-        event EventHandler<GenericEventArgs<VersionInfo>> PluginInstalled;
+        event EventHandler<InstallationInfo> PluginInstalled;
 
         /// <summary>
         /// Gets the completed installations.
@@ -59,16 +59,6 @@ namespace MediaBrowser.Common.Updates
             string name = null,
             Guid guid = default);
 
-        /// <summary>
-        /// Returns all compatible versions ordered from newest to oldest.
-        /// </summary>
-        /// <param name="availableVersions">The available version of the plugin.</param>
-        /// <param name="minVersion">The minimum required version of the plugin.</param>
-        /// <returns>All compatible versions ordered from newest to oldest.</returns>
-        IEnumerable<VersionInfo> GetCompatibleVersions(
-            IEnumerable<VersionInfo> availableVersions,
-            Version minVersion = null);
-
         /// <summary>
         /// Returns all compatible versions ordered from newest to oldest.
         /// </summary>
@@ -77,7 +67,7 @@ namespace MediaBrowser.Common.Updates
         /// <param name="guid">The guid of the plugin.</param>
         /// <param name="minVersion">The minimum required version of the plugin.</param>
         /// <returns>All compatible versions ordered from newest to oldest.</returns>
-        IEnumerable<VersionInfo> GetCompatibleVersions(
+        IEnumerable<InstallationInfo> GetCompatibleVersions(
             IEnumerable<PackageInfo> availablePackages,
             string name = null,
             Guid guid = default,
@@ -88,7 +78,7 @@ namespace MediaBrowser.Common.Updates
         /// </summary>
         /// <param name="cancellationToken">The cancellation token.</param>
         /// <returns>The available plugin updates.</returns>
-        Task<IEnumerable<VersionInfo>> GetAvailablePluginUpdates(CancellationToken cancellationToken = default);
+        Task<IEnumerable<InstallationInfo>> GetAvailablePluginUpdates(CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Installs the package.
@@ -96,7 +86,7 @@ namespace MediaBrowser.Common.Updates
         /// <param name="package">The package.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
         /// <returns><see cref="Task" />.</returns>
-        Task InstallPackage(VersionInfo package, CancellationToken cancellationToken = default);
+        Task InstallPackage(InstallationInfo package, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Uninstalls a plugin.

+ 20 - 2
MediaBrowser.Model/Updates/InstallationInfo.cs

@@ -11,7 +11,7 @@ namespace MediaBrowser.Model.Updates
         /// Gets or sets the guid.
         /// </summary>
         /// <value>The guid.</value>
-        public string Guid { get; set; }
+        public Guid Guid { get; set; }
 
         /// <summary>
         /// Gets or sets the name.
@@ -23,6 +23,24 @@ namespace MediaBrowser.Model.Updates
         /// Gets or sets the version.
         /// </summary>
         /// <value>The version.</value>
-        public string Version { get; set; }
+        public Version Version { get; set; }
+
+        /// <summary>
+        /// Gets or sets the changelog for this version.
+        /// </summary>
+        /// <value>The changelog.</value>
+        public string Changelog { get; set; }
+
+        /// <summary>
+        /// Gets or sets the source URL.
+        /// </summary>
+        /// <value>The source URL.</value>
+        public string SourceUrl { get; set; }
+
+        /// <summary>
+        /// Gets or sets a checksum for the binary.
+        /// </summary>
+        /// <value>The checksum.</value>
+        public string Checksum { get; set; }
     }
 }

+ 1 - 19
MediaBrowser.Model/Updates/VersionInfo.cs

@@ -7,23 +7,11 @@ namespace MediaBrowser.Model.Updates
     /// </summary>
     public class VersionInfo
     {
-        /// <summary>
-        /// Gets or sets the name.
-        /// </summary>
-        /// <value>The name.</value>
-        public string name { get; set; }
-
-        /// <summary>
-        /// Gets or sets the guid.
-        /// </summary>
-        /// <value>The guid.</value>
-        public string guid { get; set; }
-
         /// <summary>
         /// Gets or sets the version.
         /// </summary>
         /// <value>The version.</value>
-        public Version version { get; set; }
+        public string version { get; set; }
 
         /// <summary>
         /// Gets or sets the changelog for this version.
@@ -48,11 +36,5 @@ namespace MediaBrowser.Model.Updates
         /// </summary>
         /// <value>The checksum.</value>
         public string checksum { get; set; }
-
-        /// <summary>
-        /// Gets or sets the target filename for the downloaded binary.
-        /// </summary>
-        /// <value>The target filename.</value>
-        public string filename { get; set; }
     }
 }