feat: prioritise and blacklist media and overview in setting page of progress in adding info

Jellyfin.Plugin.JRay/Controllers/CoverageController.cs

@@ -0,0 +1,228 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using Jellyfin.Data.Enums;
+using Jellyfin.Plugin.JRay.Models;
+using Jellyfin.Plugin.JRay.Services;
+using Jellyfin.Plugin.JRay.Services.Interfaces;
+using MediaBrowser.Controller.Entities;
+using MediaBrowser.Controller.Entities.TV;
+using MediaBrowser.Controller.Library;
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+
+namespace Jellyfin.Plugin.JRay.Controllers;
+
+/// <summary>
+/// Reports how much of the library has truth data (overall, by media type, and
+/// by genre), and supplies the genre/series option lists the config page's
+/// rule editor needs.
+/// </summary>
+[ApiController]
+[Route("Plugins/JRay/Coverage")]
+[Authorize(Roles = "Administrator")]
+public class CoverageController : ControllerBase
+{
+    private readonly ILibraryManager _libraryManager;
+    private readonly ITruthDataService _truthDataService;
+    private readonly IMediaPolicyStore _policyStore;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="CoverageController"/> class.
+    /// </summary>
+    /// <param name="libraryManager">The Jellyfin library manager.</param>
+    /// <param name="truthDataService">The truth data service.</param>
+    /// <param name="policyStore">The media policy store.</param>
+    public CoverageController(ILibraryManager libraryManager, ITruthDataService truthDataService, IMediaPolicyStore policyStore)
+    {
+        _libraryManager = libraryManager;
+        _truthDataService = truthDataService;
+        _policyStore = policyStore;
+    }
+
+    /// <summary>
+    /// Gets the coverage report: totals plus breakdowns by media type and by genre.
+    /// </summary>
+    /// <returns>The coverage report.</returns>
+    [HttpGet]
+    [ProducesResponseType(StatusCodes.Status200OK)]
+    public ActionResult<CoverageReport> GetCoverage()
+    {
+        var rules = _policyStore.GetRules();
+
+        var items = _libraryManager.GetItemList(new InternalItemsQuery
+        {
+            IncludeItemTypes = new[] { BaseItemKind.Movie, BaseItemKind.Episode },
+            IsVirtualItem = false,
+            Recursive = true,
+        });
+
+        var report = new CoverageReport();
+        var byMediaType = new Dictionary<string, CoverageCounts>(StringComparer.Ordinal);
+        var byGenre = new Dictionary<string, CoverageCounts>(StringComparer.OrdinalIgnoreCase);
+
+        foreach (var item in items)
+        {
+            if (string.IsNullOrEmpty(item.Path))
+            {
+                continue;
+            }
+
+            var covered = _truthDataService.HasTruth(item.Id, item.Path);
+            var action = PolicyResolver.Resolve(rules, item.Id, TasksController.GetSeriesId(item), item.Genres);
+
+            Accumulate(report.Total, covered, action);
+            Accumulate(GetBucket(byMediaType, MediaTypeLabel(item)), covered, action);
+
+            foreach (var genre in item.Genres)
+            {
+                if (!string.IsNullOrWhiteSpace(genre))
+                {
+                    Accumulate(GetBucket(byGenre, genre), covered, action);
+                }
+            }
+        }
+
+        foreach (var kvp in byMediaType.OrderBy(k => k.Key, StringComparer.Ordinal))
+        {
+            report.ByMediaType.Add(new CoverageBreakdownRow { Label = kvp.Key, Counts = kvp.Value });
+        }
+
+        foreach (var kvp in byGenre.OrderBy(k => k.Key, StringComparer.OrdinalIgnoreCase))
+        {
+            report.ByGenre.Add(new CoverageBreakdownRow { Label = kvp.Key, Counts = kvp.Value });
+        }
+
+        return Ok(report);
+    }
+
+    /// <summary>
+    /// Gets the distinct genres present on movies/episodes, for the rule editor.
+    /// </summary>
+    /// <returns>Genre options, sorted by name.</returns>
+    [HttpGet("Genres")]
+    [ProducesResponseType(StatusCodes.Status200OK)]
+    public ActionResult<IEnumerable<PickerOption>> GetGenres()
+    {
+        var items = _libraryManager.GetItemList(new InternalItemsQuery
+        {
+            IncludeItemTypes = new[] { BaseItemKind.Movie, BaseItemKind.Episode },
+            IsVirtualItem = false,
+            Recursive = true,
+        });
+
+        var genres = items
+            .SelectMany(item => item.Genres)
+            .Where(g => !string.IsNullOrWhiteSpace(g))
+            .Distinct(StringComparer.OrdinalIgnoreCase)
+            .OrderBy(g => g, StringComparer.OrdinalIgnoreCase)
+            .Select(g => new PickerOption { Value = g, Label = g });
+
+        return Ok(genres);
+    }
+
+    /// <summary>
+    /// Gets the series in the library, for the rule editor's series picker.
+    /// </summary>
+    /// <returns>Series options (id + title), sorted by title.</returns>
+    [HttpGet("Series")]
+    [ProducesResponseType(StatusCodes.Status200OK)]
+    public ActionResult<IEnumerable<PickerOption>> GetSeries()
+    {
+        var series = _libraryManager.GetItemList(new InternalItemsQuery
+        {
+            IncludeItemTypes = new[] { BaseItemKind.Series },
+            IsVirtualItem = false,
+            Recursive = true,
+        });
+
+        var options = series
+            .OrderBy(s => s.Name, StringComparer.OrdinalIgnoreCase)
+            .Select(s => new PickerOption { Value = s.Id.ToString("D"), Label = s.Name });
+
+        return Ok(options);
+    }
+
+    /// <summary>
+    /// Searches movies/episodes by name, for the rule editor's item picker.
+    /// </summary>
+    /// <param name="search">A name fragment to match (case-insensitive). Required.</param>
+    /// <param name="limit">The maximum number of results (default 25, max 100).</param>
+    /// <returns>Matching item options (id + name), sorted by name.</returns>
+    [HttpGet("Items")]
+    [ProducesResponseType(StatusCodes.Status200OK)]
+    public ActionResult<IEnumerable<PickerOption>> SearchItems([FromQuery] string? search, [FromQuery] int limit = 25)
+    {
+        if (string.IsNullOrWhiteSpace(search))
+        {
+            return Ok(Array.Empty<PickerOption>());
+        }
+
+        var items = _libraryManager.GetItemList(new InternalItemsQuery
+        {
+            IncludeItemTypes = new[] { BaseItemKind.Movie, BaseItemKind.Episode },
+            IsVirtualItem = false,
+            Recursive = true,
+            SearchTerm = search,
+            Limit = Math.Clamp(limit, 1, 100),
+        });
+
+        var options = items
+            .OrderBy(i => i.Name, StringComparer.OrdinalIgnoreCase)
+            .Select(i => new PickerOption { Value = i.Id.ToString("D"), Label = ItemLabel(i) });
+
+        return Ok(options);
+    }
+
+    private static string ItemLabel(BaseItem item)
+    {
+        // Give episodes a series-qualified label so identically-named episodes
+        // (e.g. "Pilot") are distinguishable in the picker.
+        if (item is Episode episode && !string.IsNullOrEmpty(episode.SeriesName))
+        {
+            return episode.SeriesName + " — " + item.Name;
+        }
+
+        return item.Name;
+    }
+
+    private static void Accumulate(CoverageCounts counts, bool covered, PolicyAction? action)
+    {
+        counts.Total++;
+
+        if (action == PolicyAction.Ignore)
+        {
+            counts.Ignored++;
+            return;
+        }
+
+        if (covered)
+        {
+            counts.Covered++;
+            return;
+        }
+
+        counts.Pending++;
+        if (action == PolicyAction.Prioritise)
+        {
+            counts.Prioritised++;
+        }
+    }
+
+    private static CoverageCounts GetBucket(Dictionary<string, CoverageCounts> buckets, string key)
+    {
+        if (!buckets.TryGetValue(key, out var counts))
+        {
+            counts = new CoverageCounts();
+            buckets[key] = counts;
+        }
+
+        return counts;
+    }
+
+    private static string MediaTypeLabel(BaseItem item)
+    {
+        return item.GetBaseItemKind() == BaseItemKind.Episode ? "TV" : "Film";
+    }
+}

Jellyfin.Plugin.JRay/Controllers/PolicyController.cs

@@ -0,0 +1,76 @@
+using System.Collections.Generic;
+using Jellyfin.Plugin.JRay.Models;
+using Jellyfin.Plugin.JRay.Services.Interfaces;
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+
+namespace Jellyfin.Plugin.JRay.Controllers;
+
+/// <summary>
+/// Manages the prioritise/ignore rules that shape the work-discovery API
+/// (<c>GET /Plugins/JRay/Tasks/Pending</c>). Rules can target a genre, a
+/// series, or a single item; setting a rule for a target that already has one
+/// replaces it, so a target can never be both prioritised and ignored.
+/// </summary>
+[ApiController]
+[Route("Plugins/JRay/Policy")]
+[Authorize(Roles = "Administrator")]
+public class PolicyController : ControllerBase
+{
+    private readonly IMediaPolicyStore _policyStore;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PolicyController"/> class.
+    /// </summary>
+    /// <param name="policyStore">The media policy store.</param>
+    public PolicyController(IMediaPolicyStore policyStore)
+    {
+        _policyStore = policyStore;
+    }
+
+    /// <summary>
+    /// Gets all configured prioritise/ignore rules.
+    /// </summary>
+    /// <returns>The current rules.</returns>
+    [HttpGet("Rules")]
+    [ProducesResponseType(StatusCodes.Status200OK)]
+    public ActionResult<IReadOnlyList<MediaPolicyRule>> GetRules()
+    {
+        return Ok(_policyStore.GetRules());
+    }
+
+    /// <summary>
+    /// Adds or replaces a rule. If a rule already exists for the same scope
+    /// and value, its action is updated.
+    /// </summary>
+    /// <param name="rule">The rule to set.</param>
+    /// <returns>204 on success, or 400 if the rule has no value.</returns>
+    [HttpPut("Rules")]
+    [ProducesResponseType(StatusCodes.Status204NoContent)]
+    [ProducesResponseType(StatusCodes.Status400BadRequest)]
+    public IActionResult SetRule([FromBody] MediaPolicyRule rule)
+    {
+        if (rule is null || string.IsNullOrWhiteSpace(rule.Value))
+        {
+            return BadRequest("A rule must have a non-empty value.");
+        }
+
+        _policyStore.SetRule(rule);
+        return NoContent();
+    }
+
+    /// <summary>
+    /// Removes the rule matching the given scope and value.
+    /// </summary>
+    /// <param name="scope">The scope of the rule to remove.</param>
+    /// <param name="value">The value of the rule to remove.</param>
+    /// <returns>204 whether or not a matching rule existed.</returns>
+    [HttpDelete("Rules")]
+    [ProducesResponseType(StatusCodes.Status204NoContent)]
+    public IActionResult RemoveRule([FromQuery] PolicyScope scope, [FromQuery] string value)
+    {
+        _policyStore.RemoveRule(scope, value ?? string.Empty);
+        return NoContent();
+    }
+}

Jellyfin.Plugin.JRay/Controllers/TasksController.cs

@@ -3,8 +3,10 @@ using System.Collections.Generic;
 using System.Linq;
 using Jellyfin.Data.Enums;
 using Jellyfin.Plugin.JRay.Models;
+using Jellyfin.Plugin.JRay.Services;
 using Jellyfin.Plugin.JRay.Services.Interfaces;
 using MediaBrowser.Controller.Entities;
+using MediaBrowser.Controller.Entities.TV;
 using MediaBrowser.Controller.Library;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Http;
@@ -26,16 +28,19 @@ public class TasksController : ControllerBase
 
     private readonly ILibraryManager _libraryManager;
     private readonly ITruthDataService _truthDataService;
+    private readonly IMediaPolicyStore _policyStore;
 
     /// <summary>
     /// Initializes a new instance of the <see cref="TasksController"/> class.
     /// </summary>
     /// <param name="libraryManager">The Jellyfin library manager.</param>
     /// <param name="truthDataService">The truth data service.</param>
-    public TasksController(ILibraryManager libraryManager, ITruthDataService truthDataService)
+    /// <param name="policyStore">The prioritise/ignore policy store.</param>
+    public TasksController(ILibraryManager libraryManager, ITruthDataService truthDataService, IMediaPolicyStore policyStore)
     {
         _libraryManager = libraryManager;
         _truthDataService = truthDataService;
+        _policyStore = policyStore;
     }
 
     /// <summary>
@@ -48,6 +53,7 @@ public class TasksController : ControllerBase
     public ActionResult<IEnumerable<PendingExtractionItem>> GetPending([FromQuery] int limit = DefaultLimit)
     {
         var effectiveLimit = Math.Clamp(limit, 1, MaxLimit);
+        var rules = _policyStore.GetRules();
 
         var items = _libraryManager.GetItemList(new InternalItemsQuery
         {
@@ -56,17 +62,38 @@ public class TasksController : ControllerBase
             Recursive = true,
         });
 
+        // Keep only items that still need truth data, then apply the policy:
+        // drop anything ignored, and order prioritised items ahead of the rest.
+        // Randomise within each tier so the backlog still spreads across workers.
         var pending = items
             .Where(item => !string.IsNullOrEmpty(item.Path) && !_truthDataService.HasTruth(item.Id, item.Path))
-            .OrderBy(_ => Random.Shared.Next())
-            .Take(effectiveLimit)
-            .Select(item => new PendingExtractionItem
+            .Select(item => new
             {
-                ItemId = item.Id,
-                Path = item.Path,
-                Name = item.Name
+                Item = item,
+                Action = PolicyResolver.Resolve(rules, item.Id, GetSeriesId(item), item.Genres)
+            })
+            .Where(x => x.Action != PolicyAction.Ignore)
+            .OrderByDescending(x => x.Action == PolicyAction.Prioritise)
+            .ThenBy(_ => Random.Shared.Next())
+            .Take(effectiveLimit)
+            .Select(x => new PendingExtractionItem
+            {
+                ItemId = x.Item.Id,
+                Path = x.Item.Path,
+                Name = x.Item.Name
             });
 
         return Ok(pending);
     }
+
+    /// <summary>
+    /// Gets the series id for an episode, or <see cref="Guid.Empty"/> for any
+    /// other item type (so series rules only ever match episodes).
+    /// </summary>
+    /// <param name="item">The library item.</param>
+    /// <returns>The owning series id, or empty.</returns>
+    internal static Guid GetSeriesId(BaseItem item)
+    {
+        return item is Episode episode ? episode.SeriesId : Guid.Empty;
+    }
 }