Merge branch 'main' of https://gitea.silverhat.ca/T-Gander/jellyfin-plugin-mediacleaner

Directory.Build.props

@@ -1,7 +1,5 @@
 <Project>
   <PropertyGroup>
-        <Version>0.0.0.1</Version>
+    <AssemblyVersion>0.0.0.9</AssemblyVersion>
-        <AssemblyVersion>0.0.0.1</AssemblyVersion>
-        <FileVersion>0.0.0.1</FileVersion>
   </PropertyGroup>
 </Project>

Jellyfin.Plugin.MediaCleaner/Configuration/PluginConfiguration.cs

@@ -31,4 +31,9 @@ public class PluginConfiguration : BasePluginConfiguration
     /// Gets or sets the cut off days before deleting unwatched files.
     /// </summary>
     public int StaleMediaCutoff { get; set; } = 90;
+
+    /// <summary>
+    /// Gets or sets debug mode.
+    /// </summary>
+    public bool DebugMode { get; set; }
 }

Jellyfin.Plugin.MediaCleaner/Configuration/settings.html

@@ -24,6 +24,12 @@
                         <input id="StaleMediaCutoff" name="StaleMediaCutoff" type="number" is="emby-input" style="width: 20%;"/>
                         <div class="fieldDescription">How many days to wait before marking files as stale</div>
                     </div>
+                    <div class="checkboxContainer checkboxContainer-withDescription">
+                        <label class="emby-checkbox-label">
+                            <input id="DebugMode" name="DebugMode" type="checkbox" is="emby-checkbox" />
+                            <span>Debug Mode</span>
+                        </label>
+                    </div>
                     <!-- <div class="selectContainer">
                         <label class="selectLabel" for="Options">Several Options</label>
                         <select is="emby-select" id="Options" name="Options" class="emby-select-withcolor emby-select">
@@ -71,6 +77,7 @@
                         document.querySelector('#RadarrAPIKey').value = config.RadarrAPIKey;
                         document.querySelector('#SonarrAPIKey').value = config.SonarrAPIKey;
                         document.querySelector('#StaleMediaCutoff').value = config.StaleMediaCutoff;
+                        document.querySelector('#DebugMode').checked = config.DebugMode;
                         Dashboard.hideLoadingMsg();
                     });
                 });
@@ -86,6 +93,7 @@
                     config.RadarrAPIKey = document.querySelector('#RadarrAPIKey').value;
                     config.SonarrAPIKey = document.querySelector('#SonarrAPIKey').value;
                     config.StaleMediaCutoff = document.querySelector('#StaleMediaCutoff').value;
+                    config.DebugMode = document.querySelector('#DebugMode').checked;
                     ApiClient.updatePluginConfiguration(MediaCleanerConfig.pluginUniqueId, config).then(function (result) {
                         Dashboard.processPluginConfigurationUpdateResult(result);
                     });

Jellyfin.Plugin.MediaCleaner/Helpers/LoggingHelper.cs

@@ -0,0 +1,169 @@
+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 PrintDebugEndOfScanningForSeries(BaseItem item)
+    {
+        if (Configuration.DebugMode)
+        {
+            _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 PrintItemsInformation(IReadOnlyCollection<BaseItem> items)
+    {
+        ArgumentNullException.ThrowIfNull(items);
+
+        _logger.LogInformation("Total items: {ItemCount}", items.Count);
+        _logger.LogInformation("Stale items found: {AllItems}", items);
+    }
+
+    public void PrintStaleMoviesInformation(IReadOnlyCollection<BaseItem> 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<IReadOnlyCollection<BaseItem>, List<SeriesInfo>> findSeriesInfoFromEpisodes, IReadOnlyCollection<BaseItem> 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<SeriesInfo> 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 PrintDebugSeasonInfo()
+    {
+        if (Configuration.DebugMode)
+        {
+            _logger.LogInformation("Season debug information:");
+        }
+    }
+
+    public void PrintDebugSeasonCreatedOutsideCutoff()
+    {
+        if(Configuration.DebugMode)
+        {
+            _logger.LogInformation("All episodes were created outside of media cutoff, season is possibly stale.");
+        }
+    }
+
+    public void PrintDebugEpisodesWithUserData(IReadOnlyCollection<BaseItem> episodesWithUserData)
+    {
+        if(Configuration.DebugMode){
+            _logger.LogInformation("Episodes with user data: {EpisodesWithUserData}", episodesWithUserData);
+            _logger.LogInformation("-------------------------------------------------");
+        }
+    }
+
+    public void PrintDebugEpisodeCreationInfo(IReadOnlyCollection<BaseItem> episodes)
+    {
+        ArgumentNullException.ThrowIfNull(episodes);
+
+        if(Configuration.DebugMode){
+            _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("-------------------------------------------------");
+        }
+    }
+
+
+}

Jellyfin.Plugin.MediaCleaner/Helpers/MovieHelper.cs

@@ -0,0 +1,79 @@
+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)
+    {
+        if (Configuration.DebugMode)
+        {
+            _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).First(data => data.LastPlayedDate != null);
+
+            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;
+        }
+
+        if (Configuration.DebugMode)
+        {
+            _logger.LogInformation("-------------------------------------------------");
+            _logger.LogInformation("End of scanning for movie: {Movie}", movie);
+            _logger.LogInformation("-------------------------------------------------");
+        }
+
+        return movieIsStale;
+    }
+
+}

Jellyfin.Plugin.MediaCleaner/Helpers/SeriesHelper.cs

@@ -0,0 +1,83 @@
+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<BaseItem> episodes)
+    {
+        bool seasonIsStale = false;
+
+        List<BaseItem> staleEpisodes = [];
+
+        var episodesWithUserData = episodes.Where(episode => episode.UserData.Where(data => data.LastPlayedDate != null).ToList().Count > 0).ToList();
+
+        _loggingHelper.PrintDebugEpisodesWithUserData(episodesWithUserData);
+
+        foreach (var episode in episodesWithUserData)
+        {
+            bool episodeIsStale = false;
+
+            var mostRecentUserData = episode.UserData.OrderByDescending(data => data.LastPlayedDate).First(data => data.LastPlayedDate != null);
+            var staleLastPlayedDate = mostRecentUserData.LastPlayedDate < DateTime.Now.AddDays(-Configuration.StaleMediaCutoff);
+            var staleCreationDate = episode.DateCreated < DateTime.Now.AddDays(-Configuration.StaleMediaCutoff);
+
+            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 (staleLastPlayedDate && staleCreationDate)
+            {
+                episodeIsStale = true;
+                if(Configuration.DebugMode){
+                    _logger.LogInformation("Most recent user data has a last played date of: {LastPlayedDate}.", [mostRecentUserData.LastPlayedDate]);
+                    _logger.LogInformation("And episode created {DateCreated}.", episode.DateCreated);
+                }
+            }
+
+            if (episodeIsStale)
+            {
+                staleEpisodes.Add(episode);
+                if(Configuration.DebugMode){
+                    _logger.LogInformation("Episode is stale.");
+                }
+            }
+        }
+
+        if(staleEpisodes.Count == episodes.Count)
+        {
+            seasonIsStale = true;
+            _logger.LogInformation("Stale episodes count matches all episode count. Season is stale.");
+            _logger.LogInformation("-------------------------------------------------");
+        }
+
+        return seasonIsStale;
+    }
+}

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

@@ -3,7 +3,7 @@
   <PropertyGroup>
     <TargetFramework>net9.0</TargetFramework>
     <RootNamespace>Jellyfin.Plugin.MediaCleaner</RootNamespace>
-    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <GenerateAssemblyInfo>true</GenerateAssemblyInfo>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <Nullable>enable</Nullable>
     <AnalysisMode>AllEnabledByDefault</AnalysisMode>
@@ -11,7 +11,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Jellyfin.Controller" Version="10.11.3" >
+    <PackageReference Include="Jellyfin.Controller" Version="10.11.3">
       <ExcludeAssets>runtime</ExcludeAssets>
     </PackageReference>
     <PackageReference Include="Jellyfin.Model" Version="10.11.3">
@@ -20,14 +20,17 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="SerilogAnalyzer" Version="0.15.0" PrivateAssets="All" />
+    <None Remove="Configuration\settings.html" />
-    <PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.556" PrivateAssets="All" />
+    <EmbeddedResource Include="Configuration\settings.html" />
-    <PackageReference Include="SmartAnalyzers.MultithreadingAnalyzer" Version="1.1.31" PrivateAssets="All" />
+    <None Remove="Pages\home.html" />
+    <EmbeddedResource Include="Pages\home.html" />
   </ItemGroup>
 
-  <ItemGroup>
+  <PropertyGroup>
-    <None Remove="Configuration\configPage.html" />
+    <Timestamp>$([System.DateTime]::UtcNow.ToString("yyyy-MM-ddTHH:mm:ssZ"))</Timestamp>
-    <EmbeddedResource Include="Configuration\configPage.html" />
+  </PropertyGroup>
-  </ItemGroup>
 
+  <Target Name="GeneratePluginJson" BeforeTargets="Publish">
+  <WriteLinesToFile File="$(PublishDir)\meta.json" Lines="{&#xA;      &quot;guid&quot;: &quot;fef007a8-3e8f-4aa8-a22e-486a387f4192&quot;,&#xA;      &quot;name&quot;: &quot;Media Cleaner&quot;,&#xA;      &quot;category&quot;: &quot;Library&quot;,&#xA;      &quot;overview&quot;: &quot;A cleaner for your stale media.&quot;,&#xA;      &quot;description&quot;: &quot;Clean out the stale media from your library using scheduled tasks&quot;,&#xA;      &quot;timestamp&quot;: &quot;$(Timestamp)&quot;,&#xA;      &quot;targetAbi&quot;: &quot;10.11.0&quot;,&#xA;      &quot;owner&quot;: &quot;T-Gander&quot;,&#xA;      &quot;version&quot;: &quot;$(AssemblyVersion)&quot;&#xA;    }" Overwrite="true" Encoding="utf-8" />
+  </Target>
 </Project>

Jellyfin.Plugin.MediaCleaner/Models/SeriesInfo.cs

@@ -0,0 +1,30 @@
+using System;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+
+namespace Jellyfin.Plugin.MediaCleaner.Models;
+
+/// <summary>
+/// Contains series information.
+/// </summary>
+public class SeriesInfo
+{
+    /// <summary>
+    /// Gets or sets series identifier.
+    /// </summary>
+    public Guid Id { get; set; }
+
+    /// <summary>
+    /// Gets or sets series name.
+    /// </summary>
+    public string SeriesName { get; set; } = string.Empty;
+
+    /// <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
+}

Jellyfin.Plugin.MediaCleaner/Pages/home.html

@@ -0,0 +1,11 @@
+<div data-role="page" class="page type-interior pluginConfigurationPage withTabs">
+	<div data-role="content">
+		<div class="content-primary">
+            <div>
+                <a href="#configurationpage?name=Home">Home</a>
+                <a href="#configurationpage?name=Settings">Settings</a>
+            </div>
+			<h2>Media Cleaner</h2>
+		</div>
+	</div>
+</div>

Jellyfin.Plugin.MediaCleaner/Plugin.cs

@@ -44,9 +44,15 @@ public class Plugin : BasePlugin<PluginConfiguration>, IHasWebPages
         [
             new PluginPageInfo
             {
-                Name = Name,
+                Name = "Settings",
-                EmbeddedResourcePath = string.Format(CultureInfo.InvariantCulture, "{0}.Configuration.configPage.html", GetType().Namespace)
+                EmbeddedResourcePath = string.Format(CultureInfo.InvariantCulture, "{0}.Configuration.settings.html", GetType().Namespace),
-            }
+            },
+            new PluginPageInfo
+            {
+                Name = "Home",
+                EmbeddedResourcePath = string.Format(CultureInfo.InvariantCulture, "{0}.Pages.home.html", GetType().Namespace),
+                EnableInMainMenu = true,
+            },
         ];
     }
 }

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

@@ -1,8 +1,11 @@
 using System;
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
+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;
@@ -10,6 +13,8 @@ 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;
 using MediaBrowser.Model.Tasks;
@@ -23,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="logger">Logger for StaleMediaTask.</param>
-    /// <param name="userManager">User manager.</param>
+    /// <param name="libraryManager">Accesses jellyfin's library manager for media.</param>
-    /// <param name="libraryManager">.</param>
+    public StaleMediaTask(ILogger<StaleMediaTask> logger, ILibraryManager libraryManager)
-    public StaleMediaTask(ILogger<StaleMediaTask> logger, IUserManager userManager, ILibraryManager libraryManager)
     {
         _logger = logger;
-        _userManager = userManager;
         _libraryManager = libraryManager;
+        _loggingHelper = new LoggingHelper(_logger);
+        _movieHelper = new MovieHelper(_logger);
+        _seriesHelper = new SeriesHelper(_logger);
     }
 
     private static PluginConfiguration Configuration =>
@@ -52,34 +60,31 @@ public sealed class StaleMediaTask : IScheduledTask
 
     Task IScheduledTask.ExecuteAsync(IProgress<double> progress, CancellationToken cancellationToken)
     {
+        _loggingHelper.StartLogging();
+
         var query = new InternalItemsQuery
         {
             IncludeItemTypes = [BaseItemKind.Movie, BaseItemKind.Series],
             Recursive = true
         };
+
         List<BaseItem> allItems = [.. _libraryManager.GetItemsResult(query).Items];
 
-        _logger.LogInformation("Total items found: {AllItems}", allItems);
+        _loggingHelper.PrintItemsInformation(allItems);
 
         List<BaseItem> series = [.. allItems.Where(item => item.GetBaseItemKind() == BaseItemKind.Series)];
-        List<BaseItem> movies = [.. allItems.Where(item => item.GetBaseItemKind() == BaseItemKind.Movie && item.UserData.Count > 0)];
+        List<BaseItem> movies = [.. allItems.Where(item => item.GetBaseItemKind() == BaseItemKind.Movie)];
 
+        _loggingHelper.StartScanningSeriesItems();
         List<BaseItem> staleEpisodes = [.. series.SelectMany(GetStaleEpisodes)];
+
+        _loggingHelper.StartScanningMoviesItems();
         List<BaseItem> staleMovies = [.. GetStaleMovies(movies)];
 
-        _logger.LogInformation("Stale Movies found: {StaleMovies}", staleMovies.Count);
+        _loggingHelper.PrintStaleMoviesInformation(staleMovies);
-        if (staleMovies.Count > 0)
+        _loggingHelper.PrintStaleEpisodesInformation(FindSeriesInfoFromEpisodes, staleEpisodes);
-        {
-            _logger.LogInformation("Movies: {Names}", string.Join(", ", staleMovies.Select(movie => movie.Name)));
-        }
 
-        _logger.LogInformation("Stale Episodes found: {StaleEpisodes}", staleEpisodes.Count);
+        _loggingHelper.EndLogging();
-        if (staleEpisodes.Count > 0)
-        {
-            // Firstly figure out the seasons, and then the Series to find the name.
-            List<string> seriesNames = FindDistinctSeriesNamesFromEpisodes(staleEpisodes);
-            _logger.LogInformation("Series: {Names}", string.Join(", ", seriesNames));
-        }
 
         return Task.CompletedTask;
     }
@@ -87,19 +92,57 @@ public sealed class StaleMediaTask : IScheduledTask
     private List<BaseItem> GetStaleMovies(List<BaseItem> movies)
     {
         List<BaseItem> staleMovies = [];
-        foreach (var movie in movies)
+
-        {
+        staleMovies.AddRange(movies.Where(_movieHelper.IsMovieStale));
-            var mostRecentUserData = movie.UserData.OrderByDescending(data => data.LastPlayedDate).First();
-            if (mostRecentUserData.LastPlayedDate < DateTime.Now.AddDays(-Configuration.StaleMediaCutoff))
-            {
-                staleMovies.Add(movie);
-            }
-        }
 
         return staleMovies;
     }
 
-    private List<string> FindDistinctSeriesNamesFromEpisodes(List<BaseItem> episodes)
+
+    private List<BaseItem> GetStaleEpisodes(BaseItem item)
+    {
+        List<BaseItem> staleEpisodes = [];
+
+        // Gets each season in a show
+        var seasons = _libraryManager.GetItemList(new InternalItemsQuery
+        {
+            ParentId = item.Id,
+            Recursive = false
+        });
+
+        _loggingHelper.PrintDebugDataForSeries(item);
+
+        foreach (var season in seasons)
+        {
+            // Gets each episode, to access user data.
+            var episodes = _libraryManager.GetItemList(new InternalItemsQuery
+            {
+                ParentId = season.Id,
+                Recursive = false
+            });
+
+            _loggingHelper.PrintDebugSeasonInfo();
+
+            bool seasonHasUserData = episodes.Any(episode => episode.UserData.Count > 0);
+            bool seasonIsStale = seasonHasUserData && _seriesHelper.IsSeasonUserDataStale(episodes);
+
+            if (seasonIsStale)
+            {
+                if (!seasonHasUserData)
+                {
+                    _loggingHelper.PrintDebugEpisodeCreationInfo(episodes);
+                }
+
+                staleEpisodes.AddRange(episodes);
+            }
+        }
+
+        _loggingHelper.PrintDebugEndOfScanningForSeries(item);
+
+        return staleEpisodes;
+    }
+
+    private List<SeriesInfo> FindSeriesInfoFromEpisodes(IReadOnlyCollection<BaseItem> episodes)
     {
         Guid[] seasonIds = [.. episodes.Select(episode => episode.ParentId).Distinct()];
 
@@ -113,51 +156,23 @@ public sealed class StaleMediaTask : IScheduledTask
         var series = _libraryManager.GetItemList(new InternalItemsQuery
         {
             ItemIds = seriesIds
-        });
+        }).ToList();
 
         List<string> seriesNames = [.. series.Select(series => series.Name).Distinct()];
 
-        return seriesNames;
+        List<SeriesInfo> seriesInfoList = [];
-    }
 
-    private List<BaseItem> GetStaleEpisodes(BaseItem item)
+        series.ForEach(series =>
         {
-        List<BaseItem> staleEpisodes = [];
+            seriesInfoList.Add(new SeriesInfo
-
-        // Gets each season in a show
-        var seasons = _libraryManager.GetItemList(new InternalItemsQuery
             {
-            ParentId = item.Id,
+                Id = series.Id,
-            Recursive = false
+                SeriesName = series.Name,
+                Seasons = [.. seasons.Where(season => season.ParentId == series.Id).Select(season => season.Name)]
+            });
         });
 
-        foreach (var season in seasons)
+        return seriesInfoList;
-        {
-            // 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)
-            {
-                var episodesWithUserData = episodes.Where(episode => episode.UserData.Count > 0).ToList();
-                foreach (var episode in episodesWithUserData)
-                {
-                    var mostRecentUserData = episode.UserData.OrderByDescending(data => data.LastPlayedDate).First();
-                    if (mostRecentUserData.LastPlayedDate < DateTime.Now.AddDays(-Configuration.StaleMediaCutoff))
-                    {
-                        staleEpisodes.AddRange(episodes);
-                        break;
-                    }
-                }
-            }
-        }
-
-        return staleEpisodes;
     }
 
     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)