From ee44dd9ee6b5871759a436caf93e2de7912a92ea Mon Sep 17 00:00:00 2001 From: Thomas Gander Date: Tue, 6 Jan 2026 23:06:29 -0700 Subject: [PATCH] Further enhanced logging and refactored StaleMediaTask to aid in maintainability --- .../Helpers/LoggingHelper.cs | 168 ++++++++++++ .../Helpers/MovieHelper.cs | 74 ++++++ .../Helpers/SeriesHelper.cs | 61 +++++ .../ScheduledTasks/StaleMediaTask.cs | 246 ++++++------------ 4 files changed, 379 insertions(+), 170 deletions(-) create mode 100644 Jellyfin.Plugin.MediaCleaner/Helpers/LoggingHelper.cs create mode 100644 Jellyfin.Plugin.MediaCleaner/Helpers/MovieHelper.cs create mode 100644 Jellyfin.Plugin.MediaCleaner/Helpers/SeriesHelper.cs diff --git a/Jellyfin.Plugin.MediaCleaner/Helpers/LoggingHelper.cs b/Jellyfin.Plugin.MediaCleaner/Helpers/LoggingHelper.cs new file mode 100644 index 0000000..6fe517f --- /dev/null +++ b/Jellyfin.Plugin.MediaCleaner/Helpers/LoggingHelper.cs @@ -0,0 +1,168 @@ +using System; +using System.Collections.Generic; +using System.Collections.ObjectModel; +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 +{ + private readonly ILogger _logger; + + public LoggingHelper(ILogger logger) + { + _logger = logger ?? throw new ArgumentNullException(nameof(logger)); + } + + private static PluginConfiguration Configuration => + Plugin.Instance!.Configuration; + + public void StartLogging() + { + if (Configuration.DebugMode) + { + _logger.LogInformation("--DEBUG MODE ACTIVE--"); + } + + _logger.LogInformation("-------------------------------------------------"); + _logger.LogInformation("Starting stale media scan..."); + } + + public void EndLogging() + { + _logger.LogInformation("Ending stale media scan..."); + _logger.LogInformation("-------------------------------------------------"); + } + + public void EndOfScanningForSeries(BaseItem item) + { + _logger.LogInformation("End of scanning for series: {Series}", item); + _logger.LogInformation("-------------------------------------------------"); + } + + + public void StartScanningSeriesItems() + { + _logger.LogInformation("-------------------------------------------------"); + _logger.LogInformation("Starting scan of series items."); + _logger.LogInformation("-------------------------------------------------"); + } + + public void StartScanningMoviesItems() + { + _logger.LogInformation("-------------------------------------------------"); + _logger.LogInformation("Starting scan of movies items."); + _logger.LogInformation("-------------------------------------------------"); + } + + public void PrintStaleItemsInformation(IReadOnlyCollection staleItems) + { + ArgumentNullException.ThrowIfNull(staleItems); + + _logger.LogInformation("Total stale items: {ItemCount}", staleItems.Count); + _logger.LogInformation("Stale items found: {AllItems}", staleItems); + } + + public void PrintStaleMoviesInformation(IReadOnlyCollection staleMovies) + { + ArgumentNullException.ThrowIfNull(staleMovies); + + _logger.LogInformation("-------------------------------------------------"); + _logger.LogInformation("Stale Movies found: {StaleMovies}", staleMovies.Count); + + if (staleMovies.Count > 0 && Configuration.DebugMode) + { + foreach (var movieInfo in staleMovies) + { + _logger.LogInformation("Movie Info: ID: {Id} | Movie Name: {MovieName}", [movieInfo.Id, movieInfo.Name]); + } + } + } + + public void PrintStaleEpisodesInformation(Func, List> findSeriesInfoFromEpisodes, IReadOnlyCollection staleEpisodes) + { + ArgumentNullException.ThrowIfNull(staleEpisodes); + ArgumentNullException.ThrowIfNull(findSeriesInfoFromEpisodes); + + _logger.LogInformation("-------------------------------------------------"); + _logger.LogInformation("Stale Episodes found: {StaleEpisodes}", staleEpisodes.Count); + + if (staleEpisodes.Count > 0 && Configuration.DebugMode) + { + if (findSeriesInfoFromEpisodes == null) + { + throw new ArgumentNullException(nameof(findSeriesInfoFromEpisodes), "The method to find series information cannot be null."); + } + + List seriesInfoList = findSeriesInfoFromEpisodes(staleEpisodes); + + foreach (var seriesInfo in seriesInfoList) + { + _logger.LogInformation("Series Info: ID: {Id} | Series Name: {SeriesName} | Stale Seasons: {Seasons}", [seriesInfo.Id, seriesInfo.SeriesName, string.Join(", ", seriesInfo.Seasons)]); + } + } + + _logger.LogInformation("-------------------------------------------------"); + } + + public void PrintDebugDataForSeries(BaseItem item) + { + ArgumentNullException.ThrowIfNull(item); + + if (Configuration.DebugMode) + { + _logger.LogInformation("-------------------------------------------------"); + _logger.LogInformation("Debug data for series: {SeriesName}", item.Name); + _logger.LogInformation("-------------------------------------------------"); + } + } + + public void PrintDebugSeasonNumber(int seasonNumber) + { + if (Configuration.DebugMode) + { + _logger.LogInformation("Season {SeasonNumber} debug information:", [seasonNumber]); + } + } + + public void PrintDebugSeasonCreatedOutsideCutoff() + { + if(Configuration.DebugMode) + { + _logger.LogInformation("All episodes were created outside of media cutoff, season is possibly stale."); + } + } + + public void PrintDebugEpisodesWithUserData(IReadOnlyCollection episodesWithUserData) + { + if(Configuration.DebugMode){ + _logger.LogInformation("Episodes with user data: {EpisodesWithUserData}", episodesWithUserData); + _logger.LogInformation("-------------------------------------------------"); + } + } + + public void PrintDebugNoUserDataAndOutsideCutoffEpisodeInfo(IReadOnlyCollection episodes, int seasonNumber) + { + ArgumentNullException.ThrowIfNull(episodes); + + if(Configuration.DebugMode){ + _logger.LogInformation("No user data, and creation date is outside of media cutoff, Season {SeasonNumber} is stale.", seasonNumber); + + _logger.LogInformation("-------------------------------------------------"); + _logger.LogInformation("Episode creation dates:"); + _logger.LogInformation("-------------------------------------------------"); + foreach(BaseItem episode in episodes) + { + _logger.LogInformation("Episode: {EpisodeName} | Date Created: {EpisodeDateCreated}", [episode.Name, episode.DateCreated]); + } + _logger.LogInformation("-------------------------------------------------"); + } + } + + +} diff --git a/Jellyfin.Plugin.MediaCleaner/Helpers/MovieHelper.cs b/Jellyfin.Plugin.MediaCleaner/Helpers/MovieHelper.cs new file mode 100644 index 0000000..80fa38b --- /dev/null +++ b/Jellyfin.Plugin.MediaCleaner/Helpers/MovieHelper.cs @@ -0,0 +1,74 @@ +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 +{ + private readonly ILogger _logger; + + public MovieHelper(ILogger logger) + { + _logger = logger ?? throw new ArgumentNullException(nameof(logger)); + } + + private static PluginConfiguration Configuration => + Plugin.Instance!.Configuration; + + public bool IsMovieStale(BaseItem movie) + { + _logger.LogInformation("-------------------------------------------------"); + _logger.LogInformation("Start of scanning for movie: {Movie}", movie); + _logger.LogInformation("-------------------------------------------------"); + + 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).Where(data => data.LastPlayedDate != null).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)) + { + if (Configuration.DebugMode) + { + _logger.LogInformation("Most recent user data last played date is outside of cutoff. Adding {Movie} to stale movies.", movie); + } + movieIsStale = true; + } + } + else if (createdOutsideCutoff) + { + if (Configuration.DebugMode) + { + _logger.LogInformation("Movie has no user data and was created outside of cutoff: {DateCreated}. Adding {Movie} to stale movies.", [movie.DateCreated, movie]); + } + movieIsStale = true; + } + + + _logger.LogInformation("-------------------------------------------------"); + _logger.LogInformation("End of scanning for movie: {Movie}", movie); + _logger.LogInformation("-------------------------------------------------"); + + return movieIsStale; + } + +} diff --git a/Jellyfin.Plugin.MediaCleaner/Helpers/SeriesHelper.cs b/Jellyfin.Plugin.MediaCleaner/Helpers/SeriesHelper.cs new file mode 100644 index 0000000..b5c3f84 --- /dev/null +++ b/Jellyfin.Plugin.MediaCleaner/Helpers/SeriesHelper.cs @@ -0,0 +1,61 @@ +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 +{ + private readonly ILogger _logger; + private readonly LoggingHelper _loggingHelper; + + public SeriesHelper(ILogger logger) + { + _logger = logger ?? throw new ArgumentNullException(nameof(logger)); + _loggingHelper = new LoggingHelper(logger); + } + + private static PluginConfiguration Configuration => + Plugin.Instance!.Configuration; + + public bool IsSeasonUserDataStale(IReadOnlyList episodes, int seasonNumber) + { + bool seasonIsStale = false; + + var episodesWithUserData = episodes.Where(episode => episode.UserData.Where(data => data.LastPlayedDate != null).ToList().Count > 0).ToList(); + + _loggingHelper.PrintDebugEpisodesWithUserData(episodesWithUserData); + + foreach (var episode in episodesWithUserData) + { + var mostRecentUserData = episode.UserData.OrderByDescending(data => data.LastPlayedDate).Where(data => data.LastPlayedDate != null).First(); + if(Configuration.DebugMode){ + _logger.LogInformation("User data for episode: {Episode}", episode); + _logger.LogInformation("-------------------------------------------------"); + 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 has a last played date of: {LastPlayedDate}. Therefore all episodes are stale. Adding Season {SeasonNumber} to stale list.", [mostRecentUserData.LastPlayedDate, seasonNumber]); + _logger.LogInformation("-------------------------------------------------"); + } + + seasonIsStale = true; + } + } + + return seasonIsStale; + } +} diff --git a/Jellyfin.Plugin.MediaCleaner/ScheduledTasks/StaleMediaTask.cs b/Jellyfin.Plugin.MediaCleaner/ScheduledTasks/StaleMediaTask.cs index 9aeb85f..b221fb0 100644 --- a/Jellyfin.Plugin.MediaCleaner/ScheduledTasks/StaleMediaTask.cs +++ b/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; /// /// Initializes a new instance of the class. /// - /// Logger. - /// User manager. - /// . - public StaleMediaTask(ILogger logger, IUserManager userManager, ILibraryManager libraryManager) + /// Logger for StaleMediaTask. + /// Accesses jellyfin's library manager for media. + public StaleMediaTask(ILogger 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,13 +60,7 @@ public sealed class StaleMediaTask : IScheduledTask Task IScheduledTask.ExecuteAsync(IProgress progress, CancellationToken cancellationToken) { - if (Configuration.DebugMode) - { - _logger.LogInformation("--DEBUG MODE ACTIVE--"); - } - - _logger.LogInformation("-------------------------------------------------"); - _logger.LogInformation("Starting stale media scan..."); + _loggingHelper.StartLogging(); var query = new InternalItemsQuery { @@ -71,41 +70,21 @@ public sealed class StaleMediaTask : IScheduledTask List allItems = [.. _libraryManager.GetItemsResult(query).Items]; - _logger.LogInformation("Total stale items: {ItemCount}", allItems.Count); - _logger.LogInformation("Stale items found: {AllItems}", allItems); + _loggingHelper.PrintStaleItemsInformation(allItems); List series = [.. allItems.Where(item => item.GetBaseItemKind() == BaseItemKind.Series)]; List movies = [.. allItems.Where(item => item.GetBaseItemKind() == BaseItemKind.Movie)]; + _loggingHelper.StartScanningSeriesItems(); List staleEpisodes = [.. series.SelectMany(GetStaleEpisodes)]; + + _loggingHelper.StartScanningMoviesItems(); List staleMovies = [.. GetStaleMovies(movies)]; - _logger.LogInformation("-------------------------------------------------"); - _logger.LogInformation("Stale Movies found: {StaleMovies}", staleMovies.Count); + _loggingHelper.PrintStaleMoviesInformation(staleMovies); + _loggingHelper.PrintStaleEpisodesInformation(FindSeriesInfoFromEpisodes, staleEpisodes); - if (staleMovies.Count > 0 && Configuration.DebugMode) - { - foreach (var movieInfo in staleMovies) - { - _logger.LogInformation("Movie Info: ID: {Id} | Movie Name: {MovieName}", [movieInfo.Id, movieInfo.Name]); - } - } - - _logger.LogInformation("-------------------------------------------------"); - _logger.LogInformation("Stale Episodes found: {StaleEpisodes}", staleEpisodes.Count); - - if (staleEpisodes.Count > 0 && Configuration.DebugMode) - { - // Firstly figure out the seasons, and then the Series to find the name. - List seriesInfoList = FindSeriesInfoFromEpisodes(staleEpisodes); - - foreach (var seriesInfo in seriesInfoList) - { - _logger.LogInformation("Series Info: ID: {Id} | Series Name: {SeriesName} | Stale Seasons: {Seasons}", [seriesInfo.Id, seriesInfo.SeriesName, string.Join(", ", seriesInfo.Seasons)]); - } - } - - _logger.LogInformation("-------------------------------------------------"); + _loggingHelper.EndLogging(); return Task.CompletedTask; } @@ -114,52 +93,67 @@ public sealed class StaleMediaTask : IScheduledTask { List staleMovies = []; - foreach (var movie in movies) - { - bool movieIsStale = movie.DateCreated < DateTime.Now.AddDays(-Configuration.StaleMediaCutoff); - bool movieHasUserData = movie.UserData.Where(data => data.LastPlayedDate != null).ToList().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).Where(data => data.LastPlayedDate != null).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)) - { - if (Configuration.DebugMode) - { - _logger.LogInformation("Most recent user data last played date is outside of cutoff. Adding {Movie} to stale movies.", movie); - } - staleMovies.Add(movie); - } - } - else if (movieIsStale) - { - if (Configuration.DebugMode) - { - _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 FindSeriesInfoFromEpisodes(List episodes) + + private List GetStaleEpisodes(BaseItem item) + { + List staleEpisodes = []; + + // Gets each season in a show + var seasons = _libraryManager.GetItemList(new InternalItemsQuery + { + ParentId = item.Id, + Recursive = false + }); + + _loggingHelper.PrintDebugDataForSeries(item); + + int seasonNumber = 1; + + foreach (var season in seasons) + { + // Gets each episode, to access user data. + var episodes = _libraryManager.GetItemList(new InternalItemsQuery + { + ParentId = season.Id, + Recursive = false + }); + + bool seasonCreatedOutsideCutoff = episodes.All(episode => episode.DateCreated < DateTime.Now.AddDays(-Configuration.StaleMediaCutoff)); + + _loggingHelper.PrintDebugSeasonNumber(seasonNumber); + + if (seasonCreatedOutsideCutoff) + { + _loggingHelper.PrintDebugSeasonCreatedOutsideCutoff(); + } + + bool seasonHasUserData = episodes.Any(episode => episode.UserData.Count > 0); + bool seasonIsStale = (seasonHasUserData && _seriesHelper.IsSeasonUserDataStale(episodes, seasonNumber)) || seasonCreatedOutsideCutoff; + bool noUserDataAndOutsideCutoff = !seasonHasUserData && seasonCreatedOutsideCutoff; + + if (seasonIsStale) + { + if (noUserDataAndOutsideCutoff) + { + _loggingHelper.PrintDebugNoUserDataAndOutsideCutoffEpisodeInfo(episodes, seasonNumber); + } + + staleEpisodes.AddRange(episodes); + } + seasonNumber++; + } + + _loggingHelper.EndOfScanningForSeries(item); + + return staleEpisodes; + } + + private List FindSeriesInfoFromEpisodes(IReadOnlyCollection episodes) { Guid[] seasonIds = [.. episodes.Select(episode => episode.ParentId).Distinct()]; @@ -175,7 +169,6 @@ public sealed class StaleMediaTask : IScheduledTask ItemIds = seriesIds }).ToList(); - // Series Id, Series Name and Stale Seasons List seriesNames = [.. series.Select(series => series.Name).Distinct()]; List seriesInfoList = []; @@ -193,93 +186,6 @@ public sealed class StaleMediaTask : IScheduledTask return seriesInfoList; } - private List GetStaleEpisodes(BaseItem item) - { - List staleEpisodes = []; - - // Gets each season in a show - var seasons = _libraryManager.GetItemList(new InternalItemsQuery - { - ParentId = item.Id, - Recursive = false - }); - if (Configuration.DebugMode) - { - _logger.LogInformation("-------------------------------------------------"); - _logger.LogInformation("Debug data for {SeriesName}", item.Name); - _logger.LogInformation("-------------------------------------------------"); - } - - int seasonNumber = 1; - - foreach (var season in seasons) - { - // Gets each episode, to access user data. - var episodes = _libraryManager.GetItemList(new InternalItemsQuery - { - ParentId = season.Id, - Recursive = false - }); - - bool seasonHasUserData = episodes.Any(episode => episode.UserData.Count > 0); - if (seasonHasUserData && Configuration.DebugMode) - { - _logger.LogInformation("Season {SeasonNumber} has user data.", [seasonNumber]); - _logger.LogInformation("-------------------------------------------------"); - } - - bool seasonCanBeStale = episodes.All(episode => episode.DateCreated < DateTime.Now.AddDays(-Configuration.StaleMediaCutoff)); - if (seasonCanBeStale && Configuration.DebugMode) - { - _logger.LogInformation("All episodes were created outside of media cutoff, all episodes are eligible to be stale."); - } - - if (seasonHasUserData) - { - var episodesWithUserData = episodes.Where(episode => episode.UserData.Where(data => data.LastPlayedDate != null).ToList().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).Where(data => data.LastPlayedDate != null).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 has a last played date of: {LastPlayedDate}. Therefore all episodes are stale. Adding season to stale list.", mostRecentUserData.LastPlayedDate); - _logger.LogInformation("-------------------------------------------------"); - } - - staleEpisodes.AddRange(episodes); - break; - } - } - } - // Check for episodes that have gone unwatched for stale media cutoff - else if (seasonCanBeStale) - { - if(Configuration.DebugMode){ - _logger.LogInformation("No user data, and creation date is outside of media cutoff, season is stale."); - _logger.LogInformation("-------------------------------------------------"); - } - staleEpisodes.AddRange(episodes); - } - seasonNumber++; - } - - return staleEpisodes; - } - IEnumerable IScheduledTask.GetDefaultTriggers() { // Run this task every 24 hours