Merge pull request 'Media cleaner logging improvements and refactors' (#6) from Media-Cleaner-Homepage-and-Api into main

Reviewed-on: #6

Directory.Build.props

@@ -1,5 +1,5 @@
 <Project>
   <PropertyGroup>
-    <AssemblyVersion>0.0.0.4</AssemblyVersion>
+    <AssemblyVersion>0.0.0.9</AssemblyVersion>
   </PropertyGroup>
 </Project>

Jellyfin.Plugin.MediaCleaner/Controllers/StateController.cs

@@ -0,0 +1,22 @@
+using Jellyfin.Plugin.MediaCleaner.Data;
+using Jellyfin.Plugin.MediaCleaner.Models;
+using Microsoft.AspNetCore.Mvc;
+
+namespace Jellyfin.Plugin.MediaCleaner.Controllers;
+
+[Route("mediacleaner/state")]
+public class StateController : Controller
+{
+    private readonly PluginState _state;
+    public StateController(PluginState state) => _state = state;
+
+    [HttpGet]
+    public IActionResult Get() => Ok(_state.GetSeriesInfo());
+
+    [HttpPost("add")]
+    public IActionResult AddSeriesInfo([FromBody] SeriesInfo seriesInfo)
+    {
+        _state.AddSeriesInfo(seriesInfo);
+        return Ok();
+    }
+}

Jellyfin.Plugin.MediaCleaner/Data/PluginState.cs

@@ -0,0 +1,29 @@
+using System.Collections.Generic;
+using Jellyfin.Plugin.MediaCleaner.Models;
+
+namespace Jellyfin.Plugin.MediaCleaner.Data;
+
+public class PluginState
+{
+    private readonly object _lock = new();
+    private List<SeriesInfo> _seriesInfo = new List<SeriesInfo>
+    {
+        new SeriesInfo { SeriesName = "TestName", Id = System.Guid.NewGuid() }
+    };
+
+    public void AddSeriesInfo(SeriesInfo seriesInfo)
+    {
+        lock (_lock)
+        {
+            _seriesInfo.Add(seriesInfo);
+        }
+    }
+
+    public IEnumerable<SeriesInfo> GetSeriesInfo()
+    {
+        lock (_lock)
+        {
+            return _seriesInfo;
+        }
+    }
+}

Jellyfin.Plugin.MediaCleaner/Helpers/LoggingHelper.cs

@@ -0,0 +1,35 @@
+using System;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using System.Diagnostics.CodeAnalysis;
+using System.Runtime.CompilerServices;
+using Jellyfin.Plugin.MediaCleaner.Configuration;
+using Jellyfin.Plugin.MediaCleaner.Models;
+using Jellyfin.Plugin.MediaCleaner.ScheduledTasks;
+using MediaBrowser.Controller.Entities;
+using Microsoft.Extensions.Logging;
+
+namespace Jellyfin.Plugin.MediaCleaner.Helpers;
+
+public class LoggingHelper(ILogger logger)
+{
+    private readonly ILogger _logger = logger ?? throw new ArgumentNullException(nameof(logger));
+
+    [SuppressMessage("Microsoft.Performance", "CA2254:TemplateShouldBeConstant", Justification = "Message parameter is intentionally variable for flexible debug logging")]
+    public void LogDebugInformation(string message, params object?[] args)
+    {
+        if (Configuration.DebugMode)
+        {
+            _logger.LogInformation(message, args);
+        }
+    }
+
+    [SuppressMessage("Microsoft.Performance", "CA2254:TemplateShouldBeConstant", Justification = "Message parameter is intentionally variable for flexible logging")]
+    public void LogInformation(string message, params object?[] args)
+    {
+        _logger.LogInformation(message, args);
+    }
+
+    private static PluginConfiguration Configuration =>
+        Plugin.Instance!.Configuration;
+}

Jellyfin.Plugin.MediaCleaner/Helpers/MovieHelper.cs

@@ -0,0 +1,63 @@
+using System;
+using System.Linq;
+using System.Threading;
+using Jellyfin.Database.Implementations.Entities;
+using Jellyfin.Plugin.MediaCleaner.Configuration;
+using MediaBrowser.Controller.Entities;
+using Microsoft.Extensions.Logging;
+
+namespace Jellyfin.Plugin.MediaCleaner.Helpers;
+
+public class MovieHelper(ILogger logger)
+{
+    private readonly LoggingHelper _loggingHelper = new(logger);
+
+    private static PluginConfiguration Configuration =>
+        Plugin.Instance!.Configuration;
+
+    public bool IsMovieStale(BaseItem movie)
+    {
+        _loggingHelper.LogDebugInformation("Start of scanning for movie: {Movie}", movie);
+        _loggingHelper.LogDebugInformation("-------------------------------------------------");
+
+        bool movieIsStale = false;
+
+        bool createdOutsideCutoff = movie.DateCreated < DateTime.Now.AddDays(-Configuration.StaleMediaCutoff);
+        bool hasUserData = movie.UserData.Where(data => data.LastPlayedDate != null).ToList().Count > 0;
+
+        if (hasUserData)
+        {
+            var mostRecentUserData = movie.UserData.OrderByDescending(data => data.LastPlayedDate).First(data => data.LastPlayedDate != null);
+
+            _loggingHelper.LogDebugInformation("Most recent user data: {Movie}", movie);
+
+            foreach (var property in typeof(UserData).GetProperties())
+            {
+                _loggingHelper.LogDebugInformation("{PropertyName}: {PropertyValue}", property.Name, property.GetValue(mostRecentUserData));
+            }
+
+            _loggingHelper.LogDebugInformation("-------------------------------------------------");
+
+            if (mostRecentUserData.LastPlayedDate < DateTime.Now.AddDays(-Configuration.StaleMediaCutoff))
+            {
+                _loggingHelper.LogDebugInformation("Most recent user data has last played date that is outside of cutoff.");
+                _loggingHelper.LogDebugInformation("Adding {Movie} to stale movies.", movie);
+                _loggingHelper.LogDebugInformation("With Last Played Date: {LastPlayedDate}", mostRecentUserData.LastPlayedDate);
+
+                movieIsStale = true;
+            }
+        }
+        else if (createdOutsideCutoff)
+        {
+            _loggingHelper.LogDebugInformation("Movie has no user data and was created outside of cutoff: {DateCreated}.", movie.DateCreated);
+            _loggingHelper.LogDebugInformation("Adding {Movie} to stale movies.", movie);
+            movieIsStale = true;
+        }
+
+        _loggingHelper.LogDebugInformation("-------------------------------------------------");
+        _loggingHelper.LogDebugInformation("End of scanning for movie: {Movie}", movie);
+
+        return movieIsStale;
+    }
+
+}

Jellyfin.Plugin.MediaCleaner/Helpers/SeriesHelper.cs

@@ -0,0 +1,92 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading;
+using Jellyfin.Database.Implementations.Entities;
+using Jellyfin.Database.Implementations.Entities.Libraries;
+using Jellyfin.Plugin.MediaCleaner.Configuration;
+using MediaBrowser.Controller.Entities;
+using Microsoft.Extensions.Logging;
+
+
+namespace Jellyfin.Plugin.MediaCleaner.Helpers;
+
+public class SeriesHelper(ILogger logger)
+{
+    private readonly LoggingHelper _loggingHelper = new(logger);
+
+    private static PluginConfiguration Configuration =>
+        Plugin.Instance!.Configuration;
+
+    private List<BaseItem> ProcessEpisodes(IReadOnlyCollection<BaseItem> episodes)
+    {
+        List<BaseItem> staleEpisodes = [.. episodes
+        .Where(episode =>
+        {
+            bool episodeIsStale = false;
+
+            var staleCreationDate = episode.DateCreated < DateTime.Now.AddDays(-Configuration.StaleMediaCutoff);
+            var hasUserDataWithLastPlayedDate = episode.UserData.Any(data => data.LastPlayedDate != null);
+
+            _loggingHelper.LogDebugInformation("-------------------------------------------------");
+            _loggingHelper.LogDebugInformation("Debug data for episode: {Episode}", episode);
+            _loggingHelper.LogDebugInformation("-------------------------------------------------");
+
+            if (staleCreationDate && !hasUserDataWithLastPlayedDate){
+                _loggingHelper.LogDebugInformation("Creation date is stale, and no user data for episode {Episode}.", episode);
+                _loggingHelper.LogDebugInformation("Date created: {DateCreated}", episode.DateCreated);
+                episodeIsStale = true;
+            }
+
+            if (hasUserDataWithLastPlayedDate){
+                UserData mostRecentUserData = episode.UserData
+                .OrderByDescending(data => data.LastPlayedDate)
+                .First();
+
+                foreach (var property in typeof(UserData).GetProperties())
+                {
+                    _loggingHelper.LogDebugInformation("{PropertyName}: {PropertyValue}", property.Name, property.GetValue(mostRecentUserData));
+                }
+
+                _loggingHelper.LogDebugInformation("-------------------------------------------------");
+
+                bool staleLastPlayedDate = mostRecentUserData.LastPlayedDate < DateTime.Now.AddDays(-Configuration.StaleMediaCutoff);
+
+                if (staleLastPlayedDate && staleCreationDate)
+                {
+                    episodeIsStale = true;
+                    _loggingHelper.LogDebugInformation("Most recent user data has a last played date of: {LastPlayedDate}.", [mostRecentUserData.LastPlayedDate]);
+                    _loggingHelper.LogDebugInformation("Episode created {DateCreated}.", episode.DateCreated);
+                    _loggingHelper.LogDebugInformation("Episode is marked as stale.");
+                }
+            }
+
+            return episodeIsStale;
+        })];
+
+        return staleEpisodes;
+    }
+
+    public bool IsSeasonDataStale(IReadOnlyList<BaseItem> episodes)
+    {
+        if(episodes == null)
+        {
+            ArgumentNullException.ThrowIfNull(episodes);
+        }
+
+        bool seasonIsStale = false;
+
+        List<BaseItem> staleEpisodes = ProcessEpisodes(episodes);
+
+        if(staleEpisodes.Count == episodes.Count)
+        {
+            seasonIsStale = true;
+
+            _loggingHelper.LogDebugInformation("-------------------------------------------------");
+            _loggingHelper.LogDebugInformation("Stale episodes count matches season episode count. Season is stale.");
+            _loggingHelper.LogDebugInformation("-------------------------------------------------");
+        }
+
+        return seasonIsStale;
+    }
+}

Jellyfin.Plugin.MediaCleaner/Jellyfin.Plugin.MediaCleaner.csproj

@@ -22,8 +22,8 @@
   <ItemGroup>
     <None Remove="Configuration\settings.html" />
     <EmbeddedResource Include="Configuration\settings.html" />
-    <None Remove="Pages\home.html" />
-    <EmbeddedResource Include="Pages\home.html" />
+    <None Remove="Pages\*" />
+    <EmbeddedResource Include="Pages\*" />
   </ItemGroup>
 
   <PropertyGroup>

Jellyfin.Plugin.MediaCleaner/Models/SeriesInfo.cs

@@ -22,9 +22,5 @@ public class SeriesInfo
     /// <summary>
     /// Gets or sets seasons.
     /// </summary>
-#pragma warning disable CA2227 // Collection properties should be read only
-#pragma warning disable CA1002 // Do not expose generic lists
-    public List<string> Seasons { get; set; } = [];
-#pragma warning restore CA1002 // Do not expose generic lists
-#pragma warning restore CA2227 // Collection properties should be read only
+    public IEnumerable<string> Seasons { get; set; } = [];
 }

Jellyfin.Plugin.MediaCleaner/Pages/home.html

@@ -1,4 +1,5 @@
-<div data-role="page" class="page type-interior pluginConfigurationPage withTabs">
+<div data-role="page" class="page type-interior pluginConfigurationPage withTabs"
+     data-controller="__plugin/media_cleaner_table.js">
 	<div data-role="content">
 		<div class="content-primary">
             <div>
@@ -6,6 +7,15 @@
                 <a href="#configurationpage?name=Settings">Settings</a>
             </div>
 			<h2>Media Cleaner</h2>
+            <table id="seriesTable">
+            <thead>
+                <tr>
+                    <th>ID</th>
+                    <th>Series Name</th>
+                </tr>
+            </thead>
+            <tbody></tbody>
+            </table>
 		</div>
 	</div>
 </div>

Jellyfin.Plugin.MediaCleaner/Pages/media_cleaner_table.js

@@ -0,0 +1,27 @@
+var table = document.getElementById("seriesTable");
+
+
+
+const getMediaCleanerState = async () => {
+    const response = await fetch('/mediacleaner/state');
+
+    if(!response.ok){
+        throw new Error(`Response status: ${response.status}`)
+    }
+
+    return response.json();
+}
+
+var state = await getMediaCleanerState();
+
+console.log("State: ", state);
+
+for(let i = 0; i < state.length; i++){
+    var row = table.insertRow(-1);
+    var cell1 = row.insertCell(0);
+    var cell2 = row.insertCell(1);
+    var cell3 = row.insertCell(2);
+    cell1.innerHTML = state[i].Id;
+    cell2.innerHTML = state[i].SeriesName;
+    cell3.innerHTML = state[i].Seasons.length;
+}

Jellyfin.Plugin.MediaCleaner/Plugin.cs

@@ -2,11 +2,13 @@ using System;
 using System.Collections.Generic;
 using System.Globalization;
 using Jellyfin.Plugin.MediaCleaner.Configuration;
+using Jellyfin.Plugin.MediaCleaner.Data;
 using MediaBrowser.Common.Configuration;
 using MediaBrowser.Common.Plugins;
 using MediaBrowser.Controller.Entities;
 using MediaBrowser.Model.Plugins;
 using MediaBrowser.Model.Serialization;
+using Microsoft.Extensions.DependencyInjection;
 
 namespace Jellyfin.Plugin.MediaCleaner;
 
@@ -53,6 +55,11 @@ public class Plugin : BasePlugin<PluginConfiguration>, IHasWebPages
                 EmbeddedResourcePath = string.Format(CultureInfo.InvariantCulture, "{0}.Pages.home.html", GetType().Namespace),
                 EnableInMainMenu = true,
             },
+            new PluginPageInfo
+            {
+                Name = "media_cleaner_table.js",
+                EmbeddedResourcePath = string.Format(CultureInfo.InvariantCulture, "{0}.Pages.media_cleaner_table.js", GetType().Namespace),
+            }
         ];
     }
 }

Jellyfin.Plugin.MediaCleaner/PluginServiceRegistrator.cs

@@ -0,0 +1,13 @@
+using Jellyfin.Plugin.MediaCleaner.Data;
+using MediaBrowser.Controller;
+using MediaBrowser.Controller.Plugins;
+using Microsoft.Extensions.DependencyInjection;
+
+namespace Jellyfin.Plugin.MediaCleaner;
+public class PluginServiceRegistrator : IPluginServiceRegistrator
+{
+    public void RegisterServices(IServiceCollection serviceCollection, IServerApplicationHost applicationHost)
+    {
+        serviceCollection.AddSingleton<PluginState>();
+    }
+}

Jellyfin.Plugin.MediaCleaner/ScheduledTasks/DeadUserDataTask.cs

@@ -0,0 +1,70 @@
+#pragma warning disable RS0030 // Do not use banned APIs
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+using Jellyfin.Database.Implementations;
+using MediaBrowser.Model.Globalization;
+using MediaBrowser.Model.Tasks;
+using Microsoft.EntityFrameworkCore;
+using Microsoft.Extensions.Logging;
+
+namespace Jellyfin.Plugin.MediaCleaner.ScheduledTasks;
+
+/// <summary>
+/// Task to clean up any detached userdata from the database.
+/// </summary>
+public class CleanupUserDataTask : IScheduledTask
+{
+    private readonly ILocalizationManager _localization;
+    private readonly IDbContextFactory<JellyfinDbContext> _dbProvider;
+    private readonly ILogger<CleanupUserDataTask> _logger;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="CleanupUserDataTask"/> class.
+    /// </summary>
+    /// <param name="localization">The localisation Provider.</param>
+    /// <param name="dbProvider">The DB context factory.</param>
+    /// <param name="logger">A logger.</param>
+    public CleanupUserDataTask(ILocalizationManager localization, IDbContextFactory<JellyfinDbContext> dbProvider, ILogger<CleanupUserDataTask> logger)
+    {
+        _localization = localization;
+        _dbProvider = dbProvider;
+        _logger = logger;
+    }
+
+    /// <inheritdoc />
+    public string Name => _localization.GetLocalizedString("CleanupUserDataTask");
+
+    public Guid PlaceholderId => new("00000000-0000-0000-0000-000000000001");
+
+    /// <inheritdoc />
+    public string Description => _localization.GetLocalizedString("CleanupUserDataTaskDescription");
+
+    /// <inheritdoc />
+    public string Category => _localization.GetLocalizedString("Media");
+
+    /// <inheritdoc />
+    public string Key => nameof(CleanupUserDataTask);
+
+    /// <inheritdoc/>
+    public async Task ExecuteAsync(IProgress<double> progress, CancellationToken cancellationToken)
+    {
+        var dbContext = await _dbProvider.CreateDbContextAsync(cancellationToken).ConfigureAwait(false);
+        await using (dbContext.ConfigureAwait(false))
+        {
+            var detachedUserData = dbContext.UserData.Where(e => e.ItemId == PlaceholderId);
+            _logger.LogInformation("Deleting {DetachedUserDataCount} detached UserData entries.", detachedUserData.Count());
+
+            await detachedUserData.ExecuteDeleteAsync(cancellationToken).ConfigureAwait(false);
+        }
+    }
+
+    /// <inheritdoc/>
+    public IEnumerable<TaskTriggerInfo> GetDefaultTriggers()
+    {
+        yield break;
+    }
+}

Jellyfin.Plugin.MediaCleaner/ScheduledTasks/StaleMediaTask.cs

@@ -5,6 +5,7 @@ using System.ComponentModel;
 using System.Data.Common;
 using System.Diagnostics;
 using System.Linq;
+using System.Net;
 using System.Reflection.Metadata.Ecma335;
 using System.Threading;
 using System.Threading.Tasks;
@@ -12,6 +13,7 @@ using Jellyfin.Data.Enums;
 using Jellyfin.Database.Implementations.Entities;
 using Jellyfin.Database.Implementations.Entities.Libraries;
 using Jellyfin.Plugin.MediaCleaner.Configuration;
+using Jellyfin.Plugin.MediaCleaner.Helpers;
 using Jellyfin.Plugin.MediaCleaner.Models;
 using MediaBrowser.Controller.Entities;
 using MediaBrowser.Controller.Library;
@@ -26,20 +28,23 @@ namespace Jellyfin.Plugin.MediaCleaner.ScheduledTasks;
 public sealed class StaleMediaTask : IScheduledTask
 {
     private readonly ILogger _logger;
-    private readonly IUserManager _userManager;
     private readonly ILibraryManager _libraryManager;
+    private readonly LoggingHelper _loggingHelper;
+    private readonly MovieHelper _movieHelper;
+    private readonly SeriesHelper _seriesHelper;
 
     /// <summary>
     /// Initializes a new instance of the <see cref="StaleMediaTask"/> class.
     /// </summary>
-    /// <param name="logger">Logger.</param>
-    /// <param name="userManager">User manager.</param>
-    /// <param name="libraryManager">.</param>
-    public StaleMediaTask(ILogger<StaleMediaTask> logger, IUserManager userManager, ILibraryManager libraryManager)
+    /// <param name="logger">Logger for StaleMediaTask.</param>
+    /// <param name="libraryManager">Accesses jellyfin's library manager for media.</param>
+    public StaleMediaTask(ILogger<StaleMediaTask> logger, ILibraryManager libraryManager)
     {
         _logger = logger;
-        _userManager = userManager;
         _libraryManager = libraryManager;
+        _loggingHelper = new LoggingHelper(_logger);
+        _movieHelper = new MovieHelper(_logger);
+        _seriesHelper = new SeriesHelper(_logger);
     }
 
     private static PluginConfiguration Configuration =>
@@ -55,45 +60,64 @@ public sealed class StaleMediaTask : IScheduledTask
 
     Task IScheduledTask.ExecuteAsync(IProgress<double> progress, CancellationToken cancellationToken)
     {
+        _loggingHelper.LogDebugInformation("--DEBUG MODE ACTIVE--");
+        _loggingHelper.LogInformation("-------------------------------------------------");
+        _loggingHelper.LogInformation("Starting stale media scan...");
+        _loggingHelper.LogInformation("-------------------------------------------------");
+
         var query = new InternalItemsQuery
         {
             IncludeItemTypes = [BaseItemKind.Movie, BaseItemKind.Series],
             Recursive = true
         };
+
         List<BaseItem> allItems = [.. _libraryManager.GetItemsResult(query).Items];
 
-        if (Configuration.DebugMode)
-        {
-            _logger.LogInformation("Total items found: {AllItems}", allItems);
-        }
+        _loggingHelper.LogInformation("Total items: {ItemCount}", allItems.Count);
+        _loggingHelper.LogInformation("Stale items found: {AllItems}", allItems);
 
         List<BaseItem> series = [.. allItems.Where(item => item.GetBaseItemKind() == BaseItemKind.Series)];
         List<BaseItem> movies = [.. allItems.Where(item => item.GetBaseItemKind() == BaseItemKind.Movie)];
 
-        List<BaseItem> staleEpisodes = [.. series.SelectMany(GetStaleEpisodes)];
+        _loggingHelper.LogInformation("-------------------------------------------------");
+        _loggingHelper.LogInformation("Starting scan of series items.");
+        _loggingHelper.LogInformation("-------------------------------------------------");
+
+        List<BaseItem> staleSeasons = [.. series.SelectMany(GetStaleSeasons)];
+
+        _loggingHelper.LogInformation("Starting scan of movies items.");
+        _loggingHelper.LogInformation("-------------------------------------------------");
+
         List<BaseItem> staleMovies = [.. GetStaleMovies(movies)];
 
-        _logger.LogInformation("Stale Movies found: {StaleMovies}", staleMovies.Count);
-        if (staleMovies.Count > 0)
-        {
-            _logger.LogInformation("Movies: {Names}", string.Join(", ", staleMovies.Select(movie => movie.Name)));
-        }
+        _loggingHelper.LogInformation("-------------------------------------------------");
+        _loggingHelper.LogInformation("Stale Movies found: {StaleMovies}", staleMovies.Count);
 
-        _logger.LogInformation("Stale Episodes found: {StaleEpisodes}", staleEpisodes.Count);
-        if (staleEpisodes.Count > 0)
+        if (staleMovies.Count > 0 && Configuration.DebugMode)
         {
-            // Firstly figure out the seasons, and then the Series to find the name.
-            List<SeriesInfo> seriesInfoList = FindSeriesInfoFromEpisodes(staleEpisodes);
-
-            foreach (var seriesInfo in seriesInfoList)
+            foreach (var movieInfo in staleMovies)
             {
-                if (Configuration.DebugMode)
-                {
-                    _logger.LogInformation("Series Info: ID: {Id} | Series Name: {SeriesName} | Stale Seasons: {Seasons}", [seriesInfo.Id, seriesInfo.SeriesName, string.Join(", ", seriesInfo.Seasons)]);
-                }
+                _loggingHelper.LogDebugInformation("Movie Info: ID: {Id} | Movie Name: {MovieName}", [movieInfo.Id, movieInfo.Name]);
             }
         }
 
+        _loggingHelper.LogInformation("-------------------------------------------------");
+        _loggingHelper.LogInformation("Stale seasons found: {StaleSeasons}", staleSeasons.Count);
+
+        if (staleSeasons.Count > 0 && Configuration.DebugMode)
+        {
+            IEnumerable<SeriesInfo> staleSeriesInfo = FindSeriesInfo(staleSeasons);
+
+            foreach (var seriesInfo in staleSeriesInfo)
+            {
+                _loggingHelper.LogDebugInformation("Series Info: ID: {Id} | Series Name: {SeriesName} | Stale Seasons: {Seasons}", [seriesInfo.Id, seriesInfo.SeriesName, string.Join(", ", seriesInfo.Seasons)]);
+            }
+        }
+
+        _loggingHelper.LogInformation("-------------------------------------------------");
+        _loggingHelper.LogInformation("Ending stale media scan...");
+        _loggingHelper.LogInformation("-------------------------------------------------");
+
         return Task.CompletedTask;
     }
 
@@ -101,82 +125,16 @@ public sealed class StaleMediaTask : IScheduledTask
     {
         List<BaseItem> staleMovies = [];
 
-        foreach (var movie in movies)
-        {
-            bool movieIsStale = movie.DateCreated < DateTime.Now.AddDays(-Configuration.StaleMediaCutoff);
-            bool movieHasUserData = movie.UserData.Count > 0;
-            if (movieHasUserData)
-            {
-                if (Configuration.DebugMode){
-                    _logger.LogInformation("Movie has user data: {Movie}", movie);
-                    _logger.LogInformation("-------------------------------------------------");
-                }
-
-                var mostRecentUserData = movie.UserData.OrderByDescending(data => data.LastPlayedDate).First();
-
-                if (Configuration.DebugMode){
-                    _logger.LogInformation("Most recent user data: {Movie}", movie);
-
-                    foreach (var property in typeof(UserData).GetProperties())
-                    {
-                        _logger.LogInformation("{PropertyName}: {PropertyValue}", property.Name, property.GetValue(mostRecentUserData));
-                    }
-                    _logger.LogInformation("-------------------------------------------------");
-                }
-
-                if (mostRecentUserData.LastPlayedDate < DateTime.Now.AddDays(-Configuration.StaleMediaCutoff))
-                {
-                    _logger.LogInformation("Most recent user data last played date is outside of cutoff. Adding to stale movies.");
-                    staleMovies.Add(movie);
-                }
-            }
-            else if (movieIsStale)
-            {
-                _logger.LogInformation("Movie has no user data and was created outside of cutoff: {DateCreated}", movie.DateCreated);
-                staleMovies.Add(movie);
-            }
-        }
+        staleMovies.AddRange(movies.Where(_movieHelper.IsMovieStale));
 
         return staleMovies;
     }
 
-    private List<SeriesInfo> FindSeriesInfoFromEpisodes(List<BaseItem> episodes)
+
+    private List<BaseItem> GetStaleSeasons(BaseItem item)
     {
-        Guid[] seasonIds = [.. episodes.Select(episode => episode.ParentId).Distinct()];
-
-        var seasons = _libraryManager.GetItemList(new InternalItemsQuery
-        {
-            ItemIds = seasonIds
-        });
-
-        Guid[] seriesIds = [.. seasons.Select(season => season.ParentId).Distinct()];
-
-        var series = _libraryManager.GetItemList(new InternalItemsQuery
-        {
-            ItemIds = seriesIds
-        }).ToList();
-
-        // Series Id, Series Name and Stale Seasons
-        List<string> seriesNames = [.. series.Select(series => series.Name).Distinct()];
-
-        List<SeriesInfo> seriesInfoList = [];
-
-        series.ForEach(series =>
-        {
-            seriesInfoList.Add(new SeriesInfo
-            {
-                Id = series.Id,
-                SeriesName = series.Name,
-                Seasons = [.. seasons.Where(season => season.ParentId == series.Id).Select(season => season.Name)]
-            });
-        });
-
-        return seriesInfoList;
-    }
-
-    private List<BaseItem> GetStaleEpisodes(BaseItem item)
-    {
-        List<BaseItem> staleEpisodes = [];
+        _loggingHelper.LogDebugInformation("Debug data for series: {SeriesName}", item.Name);
+        _loggingHelper.LogDebugInformation("-------------------------------------------------");
 
         // Gets each season in a show
         var seasons = _libraryManager.GetItemList(new InternalItemsQuery
@@ -185,70 +143,51 @@ public sealed class StaleMediaTask : IScheduledTask
             Recursive = false
         });
 
-        foreach (var season in seasons)
-        {
-            // Gets each episode, to access user data.
+        List<BaseItem> staleSeasons = [ ..seasons
+        .Where(season => {
             var episodes = _libraryManager.GetItemList(new InternalItemsQuery
             {
                 ParentId = season.Id,
                 Recursive = false
             });
-            bool seasonHasUserData = episodes.Any(episode => episode.UserData.Count > 0);
-            if (seasonHasUserData && Configuration.DebugMode)
+
+            _loggingHelper.LogDebugInformation("Season debug information for {SeasonNumber}:", season);
+
+            bool isSeasonDataStale = _seriesHelper.IsSeasonDataStale(episodes);
+
+            _loggingHelper.LogDebugInformation("End of season debug information for {SeasonNumber}.", season);
+
+            return isSeasonDataStale;
+        })];
+
+
+        _loggingHelper.LogDebugInformation("-------------------------------------------------");
+        _loggingHelper.LogDebugInformation("End of scanning for series: {Series}", item);
+        _loggingHelper.LogDebugInformation("-------------------------------------------------");
+
+        return staleSeasons;
+    }
+
+    private IEnumerable<SeriesInfo> FindSeriesInfo(IReadOnlyCollection<BaseItem> seasons)
+    {
+        Guid[] seriesIds = [.. seasons.Select(season => season.ParentId).Distinct()];
+
+        IReadOnlyCollection<BaseItem> series = _libraryManager.GetItemList(new InternalItemsQuery
+        {
+            ItemIds = seriesIds
+        });
+
+        IEnumerable<SeriesInfo> seriesInfoList = series.Select(series =>
+        {
+            return new SeriesInfo
             {
-                _logger.LogInformation("Season has user data for episodes: {Episodes}", episodes);
-                _logger.LogInformation("-------------------------------------------------");
-            }
-            bool seasonIsStale = episodes.All(episode => episode.DateCreated < DateTime.Now.AddDays(-Configuration.StaleMediaCutoff));
-            if (seasonIsStale && Configuration.DebugMode)
-            {
-                _logger.LogInformation("All episodes are outside media cutoff.");
-                _logger.LogInformation("-------------------------------------------------");
-            }
+                Id = series.Id,
+                SeriesName = series.Name,
+                Seasons = [.. seasons.Where(season => season.ParentId == series.Id).Select(season => season.Name)]
+            };
+        });
 
-            if (seasonHasUserData)
-            {
-                var episodesWithUserData = episodes.Where(episode => episode.UserData.Count > 0).ToList();
-
-                if(Configuration.DebugMode){
-                    _logger.LogInformation("Episodes with user data: {EpisodesWithUserData}", episodesWithUserData);
-                    _logger.LogInformation("-------------------------------------------------");
-                }
-
-                foreach (var episode in episodesWithUserData)
-                {
-                    var mostRecentUserData = episode.UserData.OrderByDescending(data => data.LastPlayedDate).First();
-                    if(Configuration.DebugMode){
-                        foreach (var property in typeof(UserData).GetProperties())
-                        {
-                            _logger.LogInformation("{PropertyName}: {PropertyValue}", property.Name, property.GetValue(mostRecentUserData));
-                        }
-                        _logger.LogInformation("-------------------------------------------------");
-                    }
-                    if (mostRecentUserData.LastPlayedDate < DateTime.Now.AddDays(-Configuration.StaleMediaCutoff))
-                    {
-                        if(Configuration.DebugMode){
-                            _logger.LogInformation("Most Recent User Data Last Played Date is: {LastPlayedDate}. All Episodes are stale.", mostRecentUserData.LastPlayedDate);
-                            _logger.LogInformation("-------------------------------------------------");
-                        }
-
-                        staleEpisodes.AddRange(episodes);
-                        break;
-                    }
-                }
-            }
-            // Check for episodes that have gone unwatched for stale media cutoff
-            else if (seasonIsStale)
-            {
-                if(Configuration.DebugMode){
-                    _logger.LogInformation("No user data, adding all episodes as it is outside of cutoff.");
-                    _logger.LogInformation("-------------------------------------------------");
-                }
-                staleEpisodes.AddRange(episodes);
-            }
-        }
-
-        return staleEpisodes;
+        return seriesInfoList;
     }
 
     IEnumerable<TaskTriggerInfo> IScheduledTask.GetDefaultTriggers()

README.md

@@ -1,9 +1,9 @@
 The idea behind this plugin is to have an easy way to run a task to find all movies and shows in your media collection that users haven't viewed in a number of cutoff days.
 
-At the time of writing, the plugin is only capable of logging movies and shows that are stale (Unwatched for 90 days) by running a scheduled task. You will need to view your logs to know the number of stale files.
+At the time of writing, the plugin is only capable of logging movies and shows that are stale (Unwatched for a user set number of days) by running a scheduled task. You will need to view your logs to know the number of stale files and the names of said files.
 
 Planned features:
-- Better logging to show more than just the count.
+- Better logging to show more than just the count. ✅
 - A page that shows what media is currently flagged for removal. And a button to confirm removal.
 - Integration with sonarr and radarr apis to delete your media.
 - Whitelist for shows to ignore. (Seasonal shows)