| | | 1 | | using System; |
| | | 2 | | using System.Buffers; |
| | | 3 | | using System.Collections.Concurrent; |
| | | 4 | | using System.Collections.Generic; |
| | | 5 | | using System.IO; |
| | | 6 | | using System.IO.Compression; |
| | | 7 | | using System.Linq; |
| | | 8 | | using System.Net.Http; |
| | | 9 | | using System.Net.Http.Json; |
| | | 10 | | using System.Security.Cryptography; |
| | | 11 | | using System.Text.Json; |
| | | 12 | | using System.Threading; |
| | | 13 | | using System.Threading.Tasks; |
| | | 14 | | using Jellyfin.Extensions; |
| | | 15 | | using Jellyfin.Extensions.Json; |
| | | 16 | | using MediaBrowser.Common.Configuration; |
| | | 17 | | using MediaBrowser.Common.Net; |
| | | 18 | | using MediaBrowser.Common.Plugins; |
| | | 19 | | using MediaBrowser.Common.Updates; |
| | | 20 | | using MediaBrowser.Controller; |
| | | 21 | | using MediaBrowser.Controller.Configuration; |
| | | 22 | | using MediaBrowser.Controller.Events; |
| | | 23 | | using MediaBrowser.Controller.Events.Updates; |
| | | 24 | | using MediaBrowser.Model.Plugins; |
| | | 25 | | using MediaBrowser.Model.Updates; |
| | | 26 | | using Microsoft.Extensions.Logging; |
| | | 27 | | |
| | | 28 | | namespace Emby.Server.Implementations.Updates |
| | | 29 | | { |
| | | 30 | | /// <summary> |
| | | 31 | | /// Manages all install, uninstall, and update operations for the system and individual plugins. |
| | | 32 | | /// </summary> |
| | | 33 | | public class InstallationManager : IInstallationManager |
| | | 34 | | { |
| | 1 | 35 | | private static readonly SearchValues<char> InvalidPackageNameChars = SearchValues.Create([.. Path.GetInvalidFile |
| | | 36 | | // Budget for the whole package download. The response headers are already bounded by the |
| | | 37 | | // HttpClient timeout; this covers reading the package body, which can be large and slow. |
| | 1 | 38 | | private static readonly TimeSpan PackageDownloadTimeout = TimeSpan.FromMinutes(10); |
| | | 39 | | |
| | | 40 | | /// <summary> |
| | | 41 | | /// The logger. |
| | | 42 | | /// </summary> |
| | | 43 | | private readonly ILogger<InstallationManager> _logger; |
| | | 44 | | private readonly IApplicationPaths _appPaths; |
| | | 45 | | private readonly IEventManager _eventManager; |
| | | 46 | | private readonly IHttpClientFactory _httpClientFactory; |
| | | 47 | | private readonly IServerConfigurationManager _config; |
| | | 48 | | private readonly JsonSerializerOptions _jsonSerializerOptions; |
| | | 49 | | private readonly IPluginManager _pluginManager; |
| | | 50 | | |
| | | 51 | | /// <summary> |
| | | 52 | | /// Gets the application host. |
| | | 53 | | /// </summary> |
| | | 54 | | /// <value>The application host.</value> |
| | | 55 | | private readonly IServerApplicationHost _applicationHost; |
| | 43 | 56 | | private readonly Lock _currentInstallationsLock = new(); |
| | | 57 | | |
| | | 58 | | /// <summary> |
| | | 59 | | /// The current installations. |
| | | 60 | | /// </summary> |
| | | 61 | | private readonly List<(InstallationInfo Info, CancellationTokenSource Token)> _currentInstallations; |
| | | 62 | | |
| | | 63 | | /// <summary> |
| | | 64 | | /// The completed installations. |
| | | 65 | | /// </summary> |
| | | 66 | | private readonly ConcurrentBag<InstallationInfo> _completedInstallationsInternal; |
| | | 67 | | |
| | | 68 | | /// <summary> |
| | | 69 | | /// Initializes a new instance of the <see cref="InstallationManager"/> class. |
| | | 70 | | /// </summary> |
| | | 71 | | /// <param name="logger">The <see cref="ILogger{InstallationManager}"/>.</param> |
| | | 72 | | /// <param name="appHost">The <see cref="IServerApplicationHost"/>.</param> |
| | | 73 | | /// <param name="appPaths">The <see cref="IApplicationPaths"/>.</param> |
| | | 74 | | /// <param name="eventManager">The <see cref="IEventManager"/>.</param> |
| | | 75 | | /// <param name="httpClientFactory">The <see cref="IHttpClientFactory"/>.</param> |
| | | 76 | | /// <param name="config">The <see cref="IServerConfigurationManager"/>.</param> |
| | | 77 | | /// <param name="pluginManager">The <see cref="IPluginManager"/>.</param> |
| | | 78 | | public InstallationManager( |
| | | 79 | | ILogger<InstallationManager> logger, |
| | | 80 | | IServerApplicationHost appHost, |
| | | 81 | | IApplicationPaths appPaths, |
| | | 82 | | IEventManager eventManager, |
| | | 83 | | IHttpClientFactory httpClientFactory, |
| | | 84 | | IServerConfigurationManager config, |
| | | 85 | | IPluginManager pluginManager) |
| | | 86 | | { |
| | 43 | 87 | | _currentInstallations = []; |
| | 43 | 88 | | _completedInstallationsInternal = []; |
| | | 89 | | |
| | 43 | 90 | | _logger = logger; |
| | 43 | 91 | | _applicationHost = appHost; |
| | 43 | 92 | | _appPaths = appPaths; |
| | 43 | 93 | | _eventManager = eventManager; |
| | 43 | 94 | | _httpClientFactory = httpClientFactory; |
| | 43 | 95 | | _config = config; |
| | 43 | 96 | | _jsonSerializerOptions = JsonDefaults.Options; |
| | 43 | 97 | | _pluginManager = pluginManager; |
| | 43 | 98 | | } |
| | | 99 | | |
| | | 100 | | /// <inheritdoc /> |
| | 0 | 101 | | public IEnumerable<InstallationInfo> CompletedInstallations => _completedInstallationsInternal; |
| | | 102 | | |
| | | 103 | | /// <inheritdoc /> |
| | | 104 | | public async Task<PackageInfo[]> GetPackages(string manifestName, string manifest, bool filterIncompatible, Canc |
| | | 105 | | { |
| | | 106 | | try |
| | | 107 | | { |
| | 6 | 108 | | PackageInfo[]? packages = await _httpClientFactory.CreateClient(NamedClient.Default) |
| | 6 | 109 | | .GetFromJsonAsync<PackageInfo[]>(new Uri(manifest), _jsonSerializerOptions, cancellationToken).C |
| | | 110 | | |
| | 6 | 111 | | if (packages is null) |
| | | 112 | | { |
| | 0 | 113 | | return Array.Empty<PackageInfo>(); |
| | | 114 | | } |
| | | 115 | | |
| | 6 | 116 | | var minimumVersion = new Version(0, 0, 0, 1); |
| | | 117 | | // Store the repository and repository url with each version, as they may be spread apart. |
| | 378 | 118 | | foreach (var entry in packages) |
| | | 119 | | { |
| | 2646 | 120 | | for (int a = entry.Versions.Count - 1; a >= 0; a--) |
| | | 121 | | { |
| | 1140 | 122 | | var ver = entry.Versions[a]; |
| | 1140 | 123 | | ver.RepositoryName = manifestName; |
| | 1140 | 124 | | ver.RepositoryUrl = manifest; |
| | | 125 | | |
| | 1140 | 126 | | if (!filterIncompatible) |
| | | 127 | | { |
| | | 128 | | continue; |
| | | 129 | | } |
| | | 130 | | |
| | 978 | 131 | | if (!Version.TryParse(ver.TargetAbi, out var targetAbi)) |
| | | 132 | | { |
| | 0 | 133 | | targetAbi = minimumVersion; |
| | | 134 | | } |
| | | 135 | | |
| | | 136 | | // Only show plugins that are greater than or equal to targetAbi. |
| | 978 | 137 | | if (_applicationHost.ApplicationVersion >= targetAbi) |
| | | 138 | | { |
| | | 139 | | continue; |
| | | 140 | | } |
| | | 141 | | |
| | | 142 | | // Not compatible with this version so remove it. |
| | 0 | 143 | | entry.Versions.Remove(ver); |
| | | 144 | | } |
| | | 145 | | } |
| | | 146 | | |
| | 6 | 147 | | return packages; |
| | | 148 | | } |
| | 0 | 149 | | catch (IOException ex) |
| | | 150 | | { |
| | 0 | 151 | | _logger.LogError(ex, "Cannot locate the plugin manifest {Manifest}", manifest); |
| | 0 | 152 | | return Array.Empty<PackageInfo>(); |
| | | 153 | | } |
| | 0 | 154 | | catch (JsonException ex) |
| | | 155 | | { |
| | 0 | 156 | | _logger.LogError(ex, "Failed to deserialize the plugin manifest retrieved from {Manifest}", manifest); |
| | 0 | 157 | | return Array.Empty<PackageInfo>(); |
| | | 158 | | } |
| | 0 | 159 | | catch (UriFormatException ex) |
| | | 160 | | { |
| | 0 | 161 | | _logger.LogError(ex, "The URL configured for the plugin repository manifest URL is not valid: {Manifest} |
| | 0 | 162 | | return Array.Empty<PackageInfo>(); |
| | | 163 | | } |
| | 0 | 164 | | catch (NotSupportedException ex) |
| | | 165 | | { |
| | 0 | 166 | | _logger.LogError(ex, "The URL scheme configured for the plugin repository is not supported: {Manifest}", |
| | 0 | 167 | | return Array.Empty<PackageInfo>(); |
| | | 168 | | } |
| | 0 | 169 | | catch (HttpRequestException ex) |
| | | 170 | | { |
| | 0 | 171 | | _logger.LogError(ex, "An error occurred while accessing the plugin manifest: {Manifest}", manifest); |
| | 0 | 172 | | return Array.Empty<PackageInfo>(); |
| | | 173 | | } |
| | 6 | 174 | | } |
| | | 175 | | |
| | | 176 | | /// <inheritdoc /> |
| | | 177 | | public async Task<IReadOnlyList<PackageInfo>> GetAvailablePackages(CancellationToken cancellationToken = default |
| | | 178 | | { |
| | 3 | 179 | | var result = new List<PackageInfo>(); |
| | 12 | 180 | | foreach (RepositoryInfo repository in _config.Configuration.PluginRepositories) |
| | | 181 | | { |
| | 3 | 182 | | if (repository.Enabled && repository.Url is not null) |
| | | 183 | | { |
| | | 184 | | // Where repositories have the same content, the details from the first is taken. |
| | 222 | 185 | | foreach (var package in await GetPackages(repository.Name ?? "Unnamed Repo", repository.Url, true, c |
| | | 186 | | { |
| | 108 | 187 | | var existing = FilterPackages(result, package.Name, package.Id).FirstOrDefault(); |
| | | 188 | | |
| | | 189 | | // Remove invalid versions from the valid package. |
| | 2172 | 190 | | for (var i = package.Versions.Count - 1; i >= 0; i--) |
| | | 191 | | { |
| | 978 | 192 | | var version = package.Versions[i]; |
| | | 193 | | |
| | 978 | 194 | | var plugin = _pluginManager.GetPlugin(package.Id, version.VersionNumber); |
| | 978 | 195 | | if (plugin is not null) |
| | | 196 | | { |
| | 0 | 197 | | await _pluginManager.PopulateManifest(package, version.VersionNumber, plugin.Path, plugi |
| | | 198 | | } |
| | | 199 | | |
| | | 200 | | // Remove versions with a target ABI greater than the current application version. |
| | 978 | 201 | | if (Version.TryParse(version.TargetAbi, out var targetAbi) && _applicationHost.ApplicationVe |
| | | 202 | | { |
| | 0 | 203 | | package.Versions.RemoveAt(i); |
| | | 204 | | } |
| | 978 | 205 | | } |
| | | 206 | | |
| | | 207 | | // Don't add a package that doesn't have any compatible versions. |
| | 108 | 208 | | if (package.Versions.Count == 0) |
| | | 209 | | { |
| | | 210 | | continue; |
| | | 211 | | } |
| | | 212 | | |
| | 108 | 213 | | if (existing is not null) |
| | | 214 | | { |
| | | 215 | | // Assumption is both lists are ordered, so slot these into the correct place. |
| | 0 | 216 | | MergeSortedList(existing.Versions, package.Versions); |
| | | 217 | | } |
| | | 218 | | else |
| | | 219 | | { |
| | 108 | 220 | | result.Add(package); |
| | | 221 | | } |
| | 108 | 222 | | } |
| | | 223 | | } |
| | | 224 | | } |
| | | 225 | | |
| | 3 | 226 | | return result; |
| | 3 | 227 | | } |
| | | 228 | | |
| | | 229 | | /// <inheritdoc /> |
| | | 230 | | public IEnumerable<PackageInfo> FilterPackages( |
| | | 231 | | IEnumerable<PackageInfo> availablePackages, |
| | | 232 | | string? name = null, |
| | | 233 | | Guid id = default, |
| | | 234 | | Version? specificVersion = null) |
| | | 235 | | { |
| | 134 | 236 | | if (!id.IsEmpty()) |
| | | 237 | | { |
| | 133 | 238 | | availablePackages = availablePackages.Where(x => x.Id.Equals(id)); |
| | | 239 | | } |
| | 1 | 240 | | else if (name is not null) |
| | | 241 | | { |
| | 1 | 242 | | availablePackages = availablePackages.Where(x => x.Name.Equals(name, StringComparison.OrdinalIgnoreCase) |
| | | 243 | | } |
| | | 244 | | |
| | 134 | 245 | | if (specificVersion is not null) |
| | | 246 | | { |
| | 0 | 247 | | availablePackages = availablePackages.Where(x => x.Versions.Any(y => y.VersionNumber.Equals(specificVers |
| | | 248 | | } |
| | | 249 | | |
| | 134 | 250 | | return availablePackages; |
| | | 251 | | } |
| | | 252 | | |
| | | 253 | | /// <inheritdoc /> |
| | | 254 | | public IEnumerable<InstallationInfo> GetCompatibleVersions( |
| | | 255 | | IEnumerable<PackageInfo> availablePackages, |
| | | 256 | | string? name = null, |
| | | 257 | | Guid id = default, |
| | | 258 | | Version? minVersion = null, |
| | | 259 | | Version? specificVersion = null) |
| | | 260 | | { |
| | 24 | 261 | | var package = FilterPackages(availablePackages, name, id, specificVersion).FirstOrDefault(); |
| | | 262 | | |
| | | 263 | | // Package not found in repository |
| | 24 | 264 | | if (package is null) |
| | | 265 | | { |
| | 24 | 266 | | yield break; |
| | | 267 | | } |
| | | 268 | | |
| | 0 | 269 | | var appVer = _applicationHost.ApplicationVersion; |
| | 0 | 270 | | var availableVersions = package.Versions |
| | 0 | 271 | | .Where(x => string.IsNullOrEmpty(x.TargetAbi) || Version.Parse(x.TargetAbi) <= appVer); |
| | | 272 | | |
| | 0 | 273 | | if (specificVersion is not null) |
| | | 274 | | { |
| | 0 | 275 | | availableVersions = availableVersions.Where(x => x.VersionNumber.Equals(specificVersion)); |
| | | 276 | | } |
| | 0 | 277 | | else if (minVersion is not null) |
| | | 278 | | { |
| | 0 | 279 | | availableVersions = availableVersions.Where(x => x.VersionNumber >= minVersion); |
| | | 280 | | } |
| | | 281 | | |
| | 0 | 282 | | foreach (var v in availableVersions.OrderByDescending(x => x.VersionNumber)) |
| | | 283 | | { |
| | 0 | 284 | | yield return new InstallationInfo |
| | 0 | 285 | | { |
| | 0 | 286 | | Changelog = v.Changelog, |
| | 0 | 287 | | Id = package.Id, |
| | 0 | 288 | | Name = package.Name, |
| | 0 | 289 | | Version = v.VersionNumber, |
| | 0 | 290 | | SourceUrl = v.SourceUrl, |
| | 0 | 291 | | Checksum = v.Checksum, |
| | 0 | 292 | | PackageInfo = package |
| | 0 | 293 | | }; |
| | | 294 | | } |
| | 0 | 295 | | } |
| | | 296 | | |
| | | 297 | | /// <inheritdoc /> |
| | | 298 | | public async Task<IEnumerable<InstallationInfo>> GetAvailablePluginUpdates(CancellationToken cancellationToken = |
| | | 299 | | { |
| | 3 | 300 | | var catalog = await GetAvailablePackages(cancellationToken).ConfigureAwait(false); |
| | 3 | 301 | | return GetAvailablePluginUpdates(catalog); |
| | 3 | 302 | | } |
| | | 303 | | |
| | | 304 | | /// <inheritdoc /> |
| | | 305 | | public async Task InstallPackage(InstallationInfo package, CancellationToken cancellationToken) |
| | | 306 | | { |
| | 13 | 307 | | ArgumentNullException.ThrowIfNull(package); |
| | | 308 | | |
| | 13 | 309 | | var innerCancellationTokenSource = new CancellationTokenSource(); |
| | | 310 | | |
| | 13 | 311 | | var tuple = (package, innerCancellationTokenSource); |
| | | 312 | | |
| | | 313 | | // Add it to the in-progress list |
| | | 314 | | lock (_currentInstallationsLock) |
| | | 315 | | { |
| | 13 | 316 | | _currentInstallations.Add(tuple); |
| | 13 | 317 | | } |
| | | 318 | | |
| | 13 | 319 | | using var linkedTokenSource = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken, innerCancel |
| | 13 | 320 | | var linkedToken = linkedTokenSource.Token; |
| | | 321 | | |
| | 13 | 322 | | await _eventManager.PublishAsync(new PluginInstallingEventArgs(package)).ConfigureAwait(false); |
| | | 323 | | |
| | | 324 | | try |
| | | 325 | | { |
| | 13 | 326 | | var isUpdate = await InstallPackageInternal(package, linkedToken).ConfigureAwait(false); |
| | | 327 | | |
| | | 328 | | lock (_currentInstallationsLock) |
| | | 329 | | { |
| | 1 | 330 | | _currentInstallations.Remove(tuple); |
| | 1 | 331 | | } |
| | | 332 | | |
| | 1 | 333 | | _completedInstallationsInternal.Add(package); |
| | | 334 | | |
| | 1 | 335 | | if (isUpdate) |
| | | 336 | | { |
| | 0 | 337 | | await _eventManager.PublishAsync(new PluginUpdatedEventArgs(package)).ConfigureAwait(false); |
| | | 338 | | } |
| | | 339 | | else |
| | | 340 | | { |
| | 1 | 341 | | await _eventManager.PublishAsync(new PluginInstalledEventArgs(package)).ConfigureAwait(false); |
| | | 342 | | } |
| | | 343 | | |
| | 1 | 344 | | _applicationHost.NotifyPendingRestart(); |
| | 1 | 345 | | } |
| | 0 | 346 | | catch (OperationCanceledException) when (linkedToken.IsCancellationRequested) |
| | 0 | 347 | | { |
| | | 348 | | // Only an actually cancelled token is a cancellation. |
| | | 349 | | lock (_currentInstallationsLock) |
| | | 350 | | { |
| | 0 | 351 | | _currentInstallations.Remove(tuple); |
| | 0 | 352 | | } |
| | | 353 | | |
| | 0 | 354 | | _logger.LogInformation("Package installation cancelled: {0} {1}", package.Name, package.Version); |
| | | 355 | | |
| | 0 | 356 | | await _eventManager.PublishAsync(new PluginInstallationCancelledEventArgs(package)).ConfigureAwait(false |
| | | 357 | | |
| | 0 | 358 | | throw; |
| | 0 | 359 | | } |
| | 12 | 360 | | catch (Exception ex) |
| | | 361 | | { |
| | 12 | 362 | | _logger.LogError(ex, "Package installation failed: {Name} {Version}", package.Name, package.Version); |
| | | 363 | | |
| | | 364 | | lock (_currentInstallationsLock) |
| | | 365 | | { |
| | 12 | 366 | | _currentInstallations.Remove(tuple); |
| | 12 | 367 | | } |
| | | 368 | | |
| | 12 | 369 | | await _eventManager.PublishAsync(new InstallationFailedEventArgs |
| | 12 | 370 | | { |
| | 12 | 371 | | InstallationInfo = package, |
| | 12 | 372 | | Exception = ex |
| | 12 | 373 | | }).ConfigureAwait(false); |
| | | 374 | | |
| | 12 | 375 | | throw; |
| | | 376 | | } |
| | | 377 | | finally |
| | | 378 | | { |
| | | 379 | | // Dispose the progress object and remove the installation from the in-progress list |
| | 13 | 380 | | tuple.innerCancellationTokenSource.Dispose(); |
| | | 381 | | } |
| | 1 | 382 | | } |
| | | 383 | | |
| | | 384 | | /// <summary> |
| | | 385 | | /// Uninstalls a plugin. |
| | | 386 | | /// </summary> |
| | | 387 | | /// <param name="plugin">The <see cref="LocalPlugin"/> to uninstall.</param> |
| | | 388 | | public void UninstallPlugin(LocalPlugin plugin) |
| | | 389 | | { |
| | 0 | 390 | | if (plugin is null) |
| | | 391 | | { |
| | 0 | 392 | | return; |
| | | 393 | | } |
| | | 394 | | |
| | 0 | 395 | | if (plugin.Instance?.CanUninstall == false) |
| | | 396 | | { |
| | 0 | 397 | | _logger.LogWarning("Attempt to delete non removable plugin {PluginName}, ignoring request", plugin.Name) |
| | 0 | 398 | | return; |
| | | 399 | | } |
| | | 400 | | |
| | 0 | 401 | | plugin.Instance?.OnUninstalling(); |
| | | 402 | | |
| | | 403 | | // Remove it the quick way for now |
| | 0 | 404 | | _pluginManager.RemovePlugin(plugin); |
| | | 405 | | |
| | 0 | 406 | | _eventManager.Publish(new PluginUninstalledEventArgs(plugin.GetPluginInfo())); |
| | | 407 | | |
| | 0 | 408 | | _applicationHost.NotifyPendingRestart(); |
| | 0 | 409 | | } |
| | | 410 | | |
| | | 411 | | /// <inheritdoc/> |
| | | 412 | | public bool CancelInstallation(Guid id) |
| | 0 | 413 | | { |
| | | 414 | | lock (_currentInstallationsLock) |
| | | 415 | | { |
| | 0 | 416 | | var install = _currentInstallations.Find(x => x.Info.Id.Equals(id)); |
| | 0 | 417 | | if (install == default((InstallationInfo, CancellationTokenSource))) |
| | | 418 | | { |
| | 0 | 419 | | return false; |
| | | 420 | | } |
| | | 421 | | |
| | 0 | 422 | | install.Token.Cancel(); |
| | 0 | 423 | | _currentInstallations.Remove(install); |
| | 0 | 424 | | return true; |
| | | 425 | | } |
| | 0 | 426 | | } |
| | | 427 | | |
| | | 428 | | /// <inheritdoc /> |
| | | 429 | | public void Dispose() |
| | | 430 | | { |
| | 27 | 431 | | Dispose(true); |
| | 27 | 432 | | GC.SuppressFinalize(this); |
| | 27 | 433 | | } |
| | | 434 | | |
| | | 435 | | /// <summary> |
| | | 436 | | /// Releases unmanaged and optionally managed resources. |
| | | 437 | | /// </summary> |
| | | 438 | | /// <param name="dispose"><c>true</c> to release both managed and unmanaged resources or <c>false</c> to release |
| | | 439 | | protected virtual void Dispose(bool dispose) |
| | | 440 | | { |
| | 27 | 441 | | if (dispose) |
| | 27 | 442 | | { |
| | | 443 | | lock (_currentInstallationsLock) |
| | | 444 | | { |
| | 54 | 445 | | foreach (var (info, token) in _currentInstallations) |
| | | 446 | | { |
| | 0 | 447 | | token.Dispose(); |
| | | 448 | | } |
| | | 449 | | |
| | 27 | 450 | | _currentInstallations.Clear(); |
| | 27 | 451 | | } |
| | | 452 | | } |
| | 27 | 453 | | } |
| | | 454 | | |
| | | 455 | | /// <summary> |
| | | 456 | | /// Merges two sorted lists. |
| | | 457 | | /// </summary> |
| | | 458 | | /// <param name="source">The source <see cref="IList{VersionInfo}"/> instance to merge.</param> |
| | | 459 | | /// <param name="dest">The destination <see cref="IList{VersionInfo}"/> instance to merge with.</param> |
| | | 460 | | private static void MergeSortedList(IList<VersionInfo> source, IList<VersionInfo> dest) |
| | | 461 | | { |
| | 0 | 462 | | int sLength = source.Count - 1; |
| | 0 | 463 | | int dLength = dest.Count; |
| | 0 | 464 | | int s = 0, d = 0; |
| | 0 | 465 | | var sourceVersion = source[0].VersionNumber; |
| | 0 | 466 | | var destVersion = dest[0].VersionNumber; |
| | | 467 | | |
| | 0 | 468 | | while (d < dLength) |
| | | 469 | | { |
| | 0 | 470 | | if (sourceVersion.CompareTo(destVersion) >= 0) |
| | | 471 | | { |
| | 0 | 472 | | if (s < sLength) |
| | | 473 | | { |
| | 0 | 474 | | sourceVersion = source[++s].VersionNumber; |
| | | 475 | | } |
| | | 476 | | else |
| | | 477 | | { |
| | | 478 | | // Append all of destination to the end of source. |
| | 0 | 479 | | while (d < dLength) |
| | | 480 | | { |
| | 0 | 481 | | source.Add(dest[d++]); |
| | | 482 | | } |
| | | 483 | | |
| | 0 | 484 | | break; |
| | | 485 | | } |
| | | 486 | | } |
| | | 487 | | else |
| | | 488 | | { |
| | 0 | 489 | | source.Insert(s++, dest[d++]); |
| | 0 | 490 | | if (d >= dLength) |
| | | 491 | | { |
| | | 492 | | break; |
| | | 493 | | } |
| | | 494 | | |
| | 0 | 495 | | sLength++; |
| | 0 | 496 | | destVersion = dest[d].VersionNumber; |
| | | 497 | | } |
| | | 498 | | } |
| | 0 | 499 | | } |
| | | 500 | | |
| | | 501 | | private IEnumerable<InstallationInfo> GetAvailablePluginUpdates(IReadOnlyList<PackageInfo> pluginCatalog) |
| | | 502 | | { |
| | 3 | 503 | | var plugins = _pluginManager.Plugins; |
| | 54 | 504 | | foreach (var plugin in plugins) |
| | | 505 | | { |
| | | 506 | | // Don't auto update when plugin marked not to, or when it's disabled or pending removal. |
| | 24 | 507 | | if (plugin.Manifest?.AutoUpdate == false |
| | 24 | 508 | | || plugin.Manifest?.Status is PluginStatus.Disabled or PluginStatus.Deleted) |
| | | 509 | | { |
| | | 510 | | continue; |
| | | 511 | | } |
| | | 512 | | |
| | 24 | 513 | | var compatibleVersions = GetCompatibleVersions(pluginCatalog, plugin.Name, plugin.Id, minVersion: plugin |
| | 24 | 514 | | var version = compatibleVersions.FirstOrDefault(y => y.Version > plugin.Version); |
| | | 515 | | |
| | 24 | 516 | | if (version is not null && CompletedInstallations.All(x => !x.Id.Equals(version.Id))) |
| | | 517 | | { |
| | 0 | 518 | | yield return version; |
| | | 519 | | } |
| | | 520 | | } |
| | 3 | 521 | | } |
| | | 522 | | |
| | | 523 | | private async Task PerformPackageInstallation(InstallationInfo package, PluginStatus status, CancellationToken c |
| | | 524 | | { |
| | 13 | 525 | | if (!Path.GetExtension(package.SourceUrl.AsSpan()).Equals(".zip", StringComparison.OrdinalIgnoreCase)) |
| | | 526 | | { |
| | 0 | 527 | | _logger.LogError("Only zip packages are supported. {SourceUrl} is not a zip archive.", package.SourceUrl |
| | 0 | 528 | | return; |
| | | 529 | | } |
| | | 530 | | |
| | 13 | 531 | | if (!IsValidPackageDirectoryName(package.Name)) |
| | | 532 | | { |
| | 11 | 533 | | _logger.LogError("Refusing to install package with invalid name {PackageName}.", package.Name); |
| | 11 | 534 | | throw new InvalidDataException($"Plugin package name '{package.Name}' is not a valid directory name."); |
| | | 535 | | } |
| | | 536 | | |
| | | 537 | | // Always override the passed-in target (which is a file) and figure it out again |
| | 2 | 538 | | string targetDir = Path.Combine(_appPaths.PluginsPath, package.Name); |
| | | 539 | | |
| | 2 | 540 | | var pluginsRoot = Path.TrimEndingDirectorySeparator(Path.GetFullPath(_appPaths.PluginsPath)); |
| | 2 | 541 | | var resolvedTarget = Path.GetFullPath(targetDir); |
| | 2 | 542 | | if (!resolvedTarget.StartsWith(pluginsRoot + Path.DirectorySeparatorChar, StringComparison.OrdinalIgnoreCase |
| | | 543 | | { |
| | 0 | 544 | | _logger.LogError( |
| | 0 | 545 | | "Refusing to install package {PackageName}: resolved target {Resolved} is outside plugins directory |
| | 0 | 546 | | package.Name, |
| | 0 | 547 | | resolvedTarget, |
| | 0 | 548 | | pluginsRoot); |
| | 0 | 549 | | throw new InvalidDataException($"Plugin package name '{package.Name}' resolves outside the plugins direc |
| | | 550 | | } |
| | | 551 | | |
| | | 552 | | // ResponseHeadersRead keeps the body out of the HttpClient timeout, which otherwise covers |
| | | 553 | | // the whole download; the package gets the longer budget below instead. |
| | 2 | 554 | | using var downloadTokenSource = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken); |
| | 2 | 555 | | downloadTokenSource.CancelAfter(PackageDownloadTimeout); |
| | 2 | 556 | | var downloadToken = downloadTokenSource.Token; |
| | | 557 | | |
| | 2 | 558 | | var buffer = new MemoryStream(); |
| | 2 | 559 | | await using (buffer.ConfigureAwait(false)) |
| | | 560 | | { |
| | | 561 | | try |
| | | 562 | | { |
| | 2 | 563 | | using var response = await _httpClientFactory.CreateClient(NamedClient.Default) |
| | 2 | 564 | | .GetAsync(new Uri(package.SourceUrl), HttpCompletionOption.ResponseHeadersRead, downloadToken).C |
| | 2 | 565 | | response.EnsureSuccessStatusCode(); |
| | | 566 | | |
| | | 567 | | // The package is read twice, for the checksum and for the extraction, so it has |
| | | 568 | | // to be buffered: the response stream is not seekable. |
| | 2 | 569 | | await response.Content.CopyToAsync(buffer, downloadToken).ConfigureAwait(false); |
| | 2 | 570 | | } |
| | 0 | 571 | | catch (OperationCanceledException ex) when (!cancellationToken.IsCancellationRequested) |
| | | 572 | | { |
| | | 573 | | // Either our budget above or the HttpClient timeout ran out. |
| | 0 | 574 | | throw new TimeoutException( |
| | 0 | 575 | | $"Downloading the package {package.Name} {package.Version} from {package.SourceUrl} timed out.", |
| | 0 | 576 | | ex); |
| | | 577 | | } |
| | | 578 | | |
| | 2 | 579 | | buffer.Position = 0; |
| | 2 | 580 | | Stream stream = buffer; |
| | | 581 | | |
| | | 582 | | // CA5351: Do Not Use Broken Cryptographic Algorithms |
| | | 583 | | #pragma warning disable CA5351 |
| | 2 | 584 | | cancellationToken.ThrowIfCancellationRequested(); |
| | | 585 | | |
| | 2 | 586 | | var hash = Convert.ToHexString(await MD5.HashDataAsync(stream, cancellationToken).ConfigureAwait(false)) |
| | 2 | 587 | | if (!string.Equals(package.Checksum, hash, StringComparison.OrdinalIgnoreCase)) |
| | | 588 | | { |
| | 1 | 589 | | _logger.LogError( |
| | 1 | 590 | | "The checksums didn't match while installing {Package}, expected: {Expected}, got: {Received}", |
| | 1 | 591 | | package.Name, |
| | 1 | 592 | | package.Checksum, |
| | 1 | 593 | | hash); |
| | 1 | 594 | | throw new InvalidDataException("The checksum of the received data doesn't match."); |
| | | 595 | | } |
| | | 596 | | |
| | | 597 | | // Version folder as they cannot be overwritten in Windows. |
| | 1 | 598 | | targetDir += "_" + package.Version; |
| | | 599 | | |
| | 1 | 600 | | if (Directory.Exists(targetDir)) |
| | | 601 | | { |
| | | 602 | | try |
| | | 603 | | { |
| | 0 | 604 | | Directory.Delete(targetDir, true); |
| | 0 | 605 | | } |
| | | 606 | | #pragma warning disable CA1031 // Do not catch general exception types |
| | 0 | 607 | | catch |
| | | 608 | | #pragma warning restore CA1031 // Do not catch general exception types |
| | | 609 | | { |
| | | 610 | | // Ignore any exceptions. |
| | 0 | 611 | | } |
| | | 612 | | } |
| | | 613 | | |
| | 1 | 614 | | stream.Position = 0; |
| | 1 | 615 | | await ZipFile.ExtractToDirectoryAsync(stream, targetDir, true, cancellationToken).ConfigureAwait(false); |
| | 1 | 616 | | } |
| | | 617 | | |
| | | 618 | | // Ensure we create one or populate existing ones with missing data. |
| | 1 | 619 | | await _pluginManager.PopulateManifest(package.PackageInfo, package.Version, targetDir, status).ConfigureAwai |
| | | 620 | | |
| | 1 | 621 | | _pluginManager.ImportPluginFrom(targetDir); |
| | 1 | 622 | | } |
| | | 623 | | |
| | | 624 | | private static bool IsValidPackageDirectoryName(string? name) |
| | | 625 | | { |
| | 13 | 626 | | if (string.IsNullOrWhiteSpace(name)) |
| | | 627 | | { |
| | 2 | 628 | | return false; |
| | | 629 | | } |
| | | 630 | | |
| | 11 | 631 | | if (name.Equals(".", StringComparison.Ordinal) || name.Equals("..", StringComparison.Ordinal)) |
| | | 632 | | { |
| | 2 | 633 | | return false; |
| | | 634 | | } |
| | | 635 | | |
| | 9 | 636 | | if (name.IndexOfAny(InvalidPackageNameChars) >= 0) |
| | | 637 | | { |
| | 7 | 638 | | return false; |
| | | 639 | | } |
| | | 640 | | |
| | 2 | 641 | | return true; |
| | | 642 | | } |
| | | 643 | | |
| | | 644 | | private async Task<bool> InstallPackageInternal(InstallationInfo package, CancellationToken cancellationToken) |
| | | 645 | | { |
| | 13 | 646 | | LocalPlugin? plugin = _pluginManager.Plugins.FirstOrDefault(p => p.Id.Equals(package.Id) && p.Version.Equals |
| | 13 | 647 | | ?? _pluginManager.Plugins.FirstOrDefault(p => p.Name.Equals(package.Name, StringComparison.OrdinalIgno |
| | | 648 | | |
| | 13 | 649 | | await PerformPackageInstallation(package, plugin?.Manifest.Status ?? PluginStatus.Active, cancellationToken) |
| | 1 | 650 | | _logger.LogInformation("Plugin {Action}: {PluginName} {PluginVersion}", plugin is null ? "installed" : "upda |
| | | 651 | | |
| | 1 | 652 | | return plugin is not null; |
| | 1 | 653 | | } |
| | | 654 | | } |
| | | 655 | | } |