using System; using System.Collections.Concurrent; using System.Collections.Generic; using System.Globalization; using System.IO; using System.Linq; using System.Net.Http; using System.Security.Cryptography; using System.Threading; using System.Threading.Tasks; using MediaBrowser.Common; using MediaBrowser.Common.Configuration; using MediaBrowser.Common.Net; using MediaBrowser.Common.Plugins; using MediaBrowser.Common.Updates; using MediaBrowser.Controller.Configuration; using MediaBrowser.Model.Events; using MediaBrowser.Model.IO; using MediaBrowser.Model.Serialization; using MediaBrowser.Model.Updates; using Microsoft.Extensions.Logging; namespace Emby.Server.Implementations.Updates { /// /// Manages all install, uninstall and update operations (both plugins and system). /// public class InstallationManager : IInstallationManager { /// /// The _logger. /// private readonly ILogger _logger; private readonly IApplicationPaths _appPaths; private readonly IHttpClient _httpClient; private readonly IJsonSerializer _jsonSerializer; private readonly IServerConfigurationManager _config; private readonly IFileSystem _fileSystem; /// /// Gets the application host. /// /// The application host. private readonly IApplicationHost _applicationHost; private readonly IZipClient _zipClient; private readonly object _currentInstallationsLock = new object(); /// /// The current installations. /// private readonly List<(InstallationInfo info, CancellationTokenSource token)> _currentInstallations; /// /// The completed installations. /// private readonly ConcurrentBag _completedInstallationsInternal; public InstallationManager( ILogger logger, IApplicationHost appHost, IApplicationPaths appPaths, IHttpClient httpClient, IJsonSerializer jsonSerializer, IServerConfigurationManager config, IFileSystem fileSystem, IZipClient zipClient) { if (logger == null) { throw new ArgumentNullException(nameof(logger)); } _currentInstallations = new List<(InstallationInfo, CancellationTokenSource)>(); _completedInstallationsInternal = new ConcurrentBag(); _logger = logger; _applicationHost = appHost; _appPaths = appPaths; _httpClient = httpClient; _jsonSerializer = jsonSerializer; _config = config; _fileSystem = fileSystem; _zipClient = zipClient; } /// public event EventHandler PackageInstalling; /// public event EventHandler PackageInstallationCompleted; /// public event EventHandler PackageInstallationFailed; /// public event EventHandler PackageInstallationCancelled; /// public event EventHandler> PluginUninstalled; /// public event EventHandler> PluginUpdated; /// public event EventHandler> PluginInstalled; /// public IEnumerable CompletedInstallations => _completedInstallationsInternal; /// public async Task> GetAvailablePackages(CancellationToken cancellationToken = default) { using (var response = await _httpClient.SendAsync( new HttpRequestOptions { Url = "https://repo.jellyfin.org/releases/plugin/manifest.json", CancellationToken = cancellationToken, CacheMode = CacheMode.Unconditional, CacheLength = TimeSpan.FromMinutes(3) }, HttpMethod.Get).ConfigureAwait(false)) using (Stream stream = response.Content) { return await _jsonSerializer.DeserializeFromStreamAsync>( stream).ConfigureAwait(false); } } /// public IEnumerable FilterPackages( IEnumerable availablePackages, string name = null, Guid guid = default) { if (name != null) { availablePackages = availablePackages.Where(x => x.name.Equals(name, StringComparison.OrdinalIgnoreCase)); } if (guid != Guid.Empty) { var strGuid = guid.ToString("N", CultureInfo.InvariantCulture); availablePackages = availablePackages.Where(x => x.guid.Equals(strGuid, StringComparison.OrdinalIgnoreCase)); } return availablePackages; } /// public IEnumerable GetCompatibleVersions( IEnumerable availableVersions, Version minVersion = null, PackageVersionClass classification = PackageVersionClass.Release) { var appVer = _applicationHost.ApplicationVersion; availableVersions = availableVersions .Where(x => x.classification == classification && Version.Parse(x.requiredVersionStr) <= appVer); if (minVersion != null) { availableVersions = availableVersions.Where(x => x.Version >= minVersion); } return availableVersions.OrderByDescending(x => x.Version); } /// public IEnumerable GetCompatibleVersions( IEnumerable availablePackages, string name = null, Guid guid = default, Version minVersion = null, PackageVersionClass classification = PackageVersionClass.Release) { var package = FilterPackages(availablePackages, name, guid).FirstOrDefault(); // Package not found. if (package == null) { return Enumerable.Empty(); } return GetCompatibleVersions( package.versions, minVersion, classification); } /// public async IAsyncEnumerable GetAvailablePluginUpdates(CancellationToken cancellationToken = default) { var catalog = await GetAvailablePackages(cancellationToken).ConfigureAwait(false); var systemUpdateLevel = _applicationHost.SystemUpdateLevel; // Figure out what needs to be installed foreach (var plugin in _applicationHost.Plugins) { var compatibleversions = GetCompatibleVersions(catalog, plugin.Name, plugin.Id, plugin.Version, systemUpdateLevel); var version = compatibleversions.FirstOrDefault(y => y.Version > plugin.Version); if (version != null && !CompletedInstallations.Any(x => string.Equals(x.AssemblyGuid, version.guid, StringComparison.OrdinalIgnoreCase))) { yield return version; } } } /// public async Task InstallPackage(PackageVersionInfo package, CancellationToken cancellationToken) { if (package == null) { throw new ArgumentNullException(nameof(package)); } var installationInfo = new InstallationInfo { Id = Guid.NewGuid(), Name = package.name, AssemblyGuid = package.guid, UpdateClass = package.classification, Version = package.versionStr }; var innerCancellationTokenSource = new CancellationTokenSource(); var tuple = (installationInfo, innerCancellationTokenSource); // Add it to the in-progress list lock (_currentInstallationsLock) { _currentInstallations.Add(tuple); } var linkedToken = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken, innerCancellationTokenSource.Token).Token; var installationEventArgs = new InstallationEventArgs { InstallationInfo = installationInfo, PackageVersionInfo = package }; PackageInstalling?.Invoke(this, installationEventArgs); try { await InstallPackageInternal(package, linkedToken).ConfigureAwait(false); lock (_currentInstallationsLock) { _currentInstallations.Remove(tuple); } _completedInstallationsInternal.Add(installationInfo); PackageInstallationCompleted?.Invoke(this, installationEventArgs); } catch (OperationCanceledException) { lock (_currentInstallationsLock) { _currentInstallations.Remove(tuple); } _logger.LogInformation("Package installation cancelled: {0} {1}", package.name, package.versionStr); PackageInstallationCancelled?.Invoke(this, installationEventArgs); throw; } catch (Exception ex) { _logger.LogError(ex, "Package installation failed"); lock (_currentInstallationsLock) { _currentInstallations.Remove(tuple); } PackageInstallationFailed?.Invoke(this, new InstallationFailedEventArgs { InstallationInfo = installationInfo, Exception = ex }); throw; } finally { // Dispose the progress object and remove the installation from the in-progress list tuple.innerCancellationTokenSource.Dispose(); } } /// /// Installs the package internal. /// /// The package. /// The cancellation token. /// . private async Task InstallPackageInternal(PackageVersionInfo 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)); // Do the install await PerformPackageInstallation(package, cancellationToken).ConfigureAwait(false); // Do plugin-specific processing if (plugin == null) { _logger.LogInformation("New plugin installed: {0} {1} {2}", package.name, package.versionStr ?? string.Empty, package.classification); PluginInstalled?.Invoke(this, new GenericEventArgs(package)); } else { _logger.LogInformation("Plugin updated: {0} {1} {2}", package.name, package.versionStr ?? string.Empty, package.classification); PluginUpdated?.Invoke(this, new GenericEventArgs<(IPlugin, PackageVersionInfo)>((plugin, package))); } _applicationHost.NotifyPendingRestart(); } private async Task PerformPackageInstallation(PackageVersionInfo package, CancellationToken cancellationToken) { var extension = Path.GetExtension(package.targetFilename); if (!string.Equals(extension, ".zip", StringComparison.OrdinalIgnoreCase)) { _logger.LogError("Only zip packages are supported. {Filename} is not a zip archive.", package.targetFilename); return; } // Always override the passed-in target (which is a file) and figure it out again 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, CancellationToken = cancellationToken, // We need it to be buffered for setting the position BufferContent = true }, HttpMethod.Get).ConfigureAwait(false)) using (var stream = res.Content) using (var md5 = MD5.Create()) { cancellationToken.ThrowIfCancellationRequested(); var hash = Hex.Encode(md5.ComputeHash(stream)); 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, hash); throw new InvalidDataException("The checksum of the received data doesn't match."); } if (Directory.Exists(targetDir)) { Directory.Delete(targetDir, true); } stream.Position = 0; _zipClient.ExtractAllFromZip(stream, targetDir, true); } #pragma warning restore CA5351 } /// /// Uninstalls a plugin /// /// The plugin. public void UninstallPlugin(IPlugin plugin) { plugin.OnUninstalling(); // Remove it the quick way for now _applicationHost.RemovePlugin(plugin); var path = plugin.AssemblyFilePath; bool isDirectory = false; // Check if we have a plugin directory we should remove too if (Path.GetDirectoryName(plugin.AssemblyFilePath) != _appPaths.PluginsPath) { path = Path.GetDirectoryName(plugin.AssemblyFilePath); isDirectory = true; } // Make this case-insensitive to account for possible incorrect assembly naming var file = _fileSystem.GetFilePaths(Path.GetDirectoryName(path)) .FirstOrDefault(i => string.Equals(i, path, StringComparison.OrdinalIgnoreCase)); if (!string.IsNullOrWhiteSpace(file)) { path = file; } if (isDirectory) { _logger.LogInformation("Deleting plugin directory {0}", path); Directory.Delete(path, true); } else { _logger.LogInformation("Deleting plugin file {0}", path); _fileSystem.DeleteFile(path); } 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(); } PluginUninstalled?.Invoke(this, new GenericEventArgs { Argument = plugin }); _applicationHost.NotifyPendingRestart(); } /// public bool CancelInstallation(Guid id) { lock (_currentInstallationsLock) { var install = _currentInstallations.Find(x => x.info.Id == id); if (install == default((InstallationInfo, CancellationTokenSource))) { return false; } install.token.Cancel(); _currentInstallations.Remove(install); return true; } } /// public void Dispose() { Dispose(true); GC.SuppressFinalize(this); } /// /// Releases unmanaged and - optionally - managed resources. /// /// true to release both managed and unmanaged resources; false to release only unmanaged resources. protected virtual void Dispose(bool dispose) { if (dispose) { lock (_currentInstallationsLock) { foreach (var tuple in _currentInstallations) { tuple.token.Dispose(); } _currentInstallations.Clear(); } } } } }