Extend collections cleanup task to include playlists too

1 files changed, 147 insertions, 0 deletions

diff --git a/Emby.Server.Implementations/ScheduledTasks/Tasks/CleanupCollectionAndPlaylistPathsTask.cs b/Emby.Server.Implementations/ScheduledTasks/Tasks/CleanupCollectionAndPlaylistPathsTask.cs
new file mode 100644
index 000000000..3daa2b6d0
--- /dev/null
+++ b/Emby.Server.Implementations/ScheduledTasks/Tasks/CleanupCollectionAndPlaylistPathsTask.cs
@@ -0,0 +1,147 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+using MediaBrowser.Controller.Collections;
+using MediaBrowser.Controller.Entities;
+using MediaBrowser.Controller.Entities.Movies;
+using MediaBrowser.Controller.Library;
+using MediaBrowser.Controller.Playlists;
+using MediaBrowser.Controller.Providers;
+using MediaBrowser.Model.Globalization;
+using MediaBrowser.Model.IO;
+using MediaBrowser.Model.Tasks;
+using Microsoft.Extensions.Logging;
+
+namespace Emby.Server.Implementations.ScheduledTasks.Tasks;
+
+/// <summary>
+/// Deletes path references from collections and playlists that no longer exists.
+/// </summary>
+public class CleanupCollectionAndPlaylistPathsTask : IScheduledTask
+{
+    private readonly ILocalizationManager _localization;
+    private readonly ICollectionManager _collectionManager;
+    private readonly IPlaylistManager _playlistManager;
+    private readonly ILogger<CleanupCollectionAndPlaylistPathsTask> _logger;
+    private readonly IProviderManager _providerManager;
+    private readonly IFileSystem _fileSystem;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="CleanupCollectionAndPlaylistPathsTask"/> class.
+    /// </summary>
+    /// <param name="localization">Instance of the <see cref="ILocalizationManager"/> interface.</param>
+    /// <param name="collectionManager">Instance of the <see cref="ICollectionManager"/> interface.</param>
+    /// <param name="playlistManager">Instance of the <see cref="IPlaylistManager"/> interface.</param>
+    /// <param name="logger">The logger.</param>
+    /// <param name="providerManager">The provider manager.</param>
+    /// <param name="fileSystem">The filesystem.</param>
+    public CleanupCollectionAndPlaylistPathsTask(
+        ILocalizationManager localization,
+        ICollectionManager collectionManager,
+        IPlaylistManager playlistManager,
+        ILogger<CleanupCollectionAndPlaylistPathsTask> logger,
+        IProviderManager providerManager,
+        IFileSystem fileSystem)
+    {
+        _localization = localization;
+        _collectionManager = collectionManager;
+        _playlistManager = playlistManager;
+        _logger = logger;
+        _providerManager = providerManager;
+        _fileSystem = fileSystem;
+    }
+
+    /// <inheritdoc />
+    public string Name => _localization.GetLocalizedString("TaskCleanCollectionsAndPlaylists");
+
+    /// <inheritdoc />
+    public string Key => "CleanCollectionsAndPlaylists";
+
+    /// <inheritdoc />
+    public string Description => _localization.GetLocalizedString("TaskCleanCollectionsAndPlaylistsDescription");
+
+    /// <inheritdoc />
+    public string Category => _localization.GetLocalizedString("TasksMaintenanceCategory");
+
+    /// <inheritdoc />
+    public async Task ExecuteAsync(IProgress<double> progress, CancellationToken cancellationToken)
+    {
+        var collectionsFolder = await _collectionManager.GetCollectionsFolder(false).ConfigureAwait(false);
+        if (collectionsFolder is null)
+        {
+            _logger.LogDebug("There is no collection folder to be found");
+        }
+        else
+        {
+            var collections = collectionsFolder.Children.OfType<BoxSet>().ToArray();
+            _logger.LogDebug("Found {CollectionLength} boxsets", collections.Length);
+
+            for (var index = 0; index < collections.Length; index++)
+            {
+                var collection = collections[index];
+                _logger.LogDebug("Checking boxset {CollectionName}", collection.Name);
+
+                CleanupLinkedChildren(collection, cancellationToken);
+                progress.Report(50D / collections.Length * (index + 1));
+            }
+        }
+
+        var playlistsFolder = _playlistManager.GetPlaylistsFolder();
+        if (playlistsFolder is null)
+        {
+            _logger.LogDebug("There is no collection folder to be found");
+            return;
+        }
+
+        var playlists = playlistsFolder.Children.OfType<Playlist>().ToArray();
+        _logger.LogDebug("Found {PlaylistLength} boxsets", playlists.Length);
+
+        for (var index = 0; index < playlists.Length; index++)
+        {
+            var playlist = playlists[index];
+            _logger.LogDebug("Checking playlist {PlaylistName}", playlist.Name);
+
+            CleanupLinkedChildren(playlist, cancellationToken);
+            progress.Report(50D / playlists.Length * (index + 1));
+        }
+    }
+
+    private void CleanupLinkedChildren<T>(T folder, CancellationToken cancellationToken) where T : Folder
+    {
+        var itemsToRemove = new List<LinkedChild>();
+        foreach (var linkedChild in folder.LinkedChildren)
+        {
+            if (!File.Exists(folder.Path))
+            {
+                _logger.LogInformation("Item in {FolderName} cannot be found at {ItemPath}", folder.Name, linkedChild.Path);
+                itemsToRemove.Add(linkedChild);
+            }
+        }
+
+        if (itemsToRemove.Count != 0)
+        {
+            _logger.LogDebug("Updating {FolderName}", folder.Name);
+            folder.LinkedChildren = folder.LinkedChildren.Except(itemsToRemove).ToArray();
+            folder.UpdateToRepositoryAsync(ItemUpdateType.MetadataEdit, cancellationToken);
+
+            _providerManager.QueueRefresh(
+                folder.Id,
+                new MetadataRefreshOptions(new DirectoryService(_fileSystem))
+                {
+                    ForceSave = true
+                },
+                RefreshPriority.High);
+
+            itemsToRemove.Clear();
+        }
+    }
+
+    /// <inheritdoc />
+    public IEnumerable<TaskTriggerInfo> GetDefaultTriggers()
+    {
+        return new[] { new TaskTriggerInfo() { Type = TaskTriggerInfo.TriggerStartup } };
+    }
+}