Compare commits
22
Commits
v0.0.3
...
596566813c
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
596566813c | ||
|
|
5152f6f129 | ||
|
|
c04d5a3dcc | ||
|
|
305b898b15 | ||
|
|
12f076cf85 | ||
|
|
3d210b5bd3 | ||
|
|
64f549ab35 | ||
|
|
2926740d03 | ||
|
|
0fafa84158 | ||
|
|
cc973fd7c5 | ||
|
|
e16f903469 | ||
|
|
f4e8fb5dea | ||
|
|
2d043aeee3 | ||
|
|
5159692364 | ||
|
|
d786d56368 | ||
|
|
d9a38bb7fb | ||
|
|
3b24fe1b3c | ||
|
|
32f976e79f | ||
|
|
8e1679faed | ||
|
|
13471e21fb | ||
|
|
2ffbd2f50e | ||
|
|
edb93e1028 |
@@ -0,0 +1,3 @@
|
||||
[submodule "scripts/vendor/jray-project"]
|
||||
path = scripts/vendor/jray-project
|
||||
url = git@gitea.tourolle.paris:dtourolle/jray-project.git
|
||||
@@ -0,0 +1,96 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using Jellyfin.Plugin.JRay.Models;
|
||||
using Jellyfin.Plugin.JRay.Services;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using Xunit;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// JR-023 — absent the File Transformation plugin, disable *only* the overlay
|
||||
/// and say so. There is no on-disk fallback (JR-021), so the failure path is
|
||||
/// the one an admin will actually meet, and it has to be legible: silently
|
||||
/// serving no overlay is indistinguishable from a broken install.
|
||||
///
|
||||
/// The File Transformation assembly is not loaded in the test host, so
|
||||
/// TryRegister exercises its not-found branch for real rather than through a
|
||||
/// seam invented for the test.
|
||||
///
|
||||
/// TRACES: UT-012, UT-013, UT-014, UT-015 | JR-023
|
||||
/// </summary>
|
||||
public class FileTransformationRegistrationTests
|
||||
{
|
||||
// UT-012
|
||||
[Fact]
|
||||
public void TryRegister_WithPluginAbsent_ReturnsFalse()
|
||||
{
|
||||
Assert.False(FileTransformationRegistration.TryRegister(new CapturingLogger()));
|
||||
}
|
||||
|
||||
// UT-013
|
||||
[Fact]
|
||||
public void TryRegister_WithPluginAbsent_WarnsNamingThePluginAndHowToInstallIt()
|
||||
{
|
||||
var logger = new CapturingLogger();
|
||||
|
||||
FileTransformationRegistration.TryRegister(logger);
|
||||
|
||||
var entry = Assert.Single(logger.Entries);
|
||||
|
||||
// Warning, not Information: the overlay is a headline feature and it is
|
||||
// off. Logging this at Information buries it among startup chatter.
|
||||
Assert.Equal(LogLevel.Warning, entry.Level);
|
||||
|
||||
// The message has to carry the install URL, and must not promise the
|
||||
// on-disk fallback that JR-021 removed.
|
||||
Assert.Contains(FileTransformationRegistration.ManifestUrl, entry.Message, StringComparison.Ordinal);
|
||||
Assert.DoesNotContain("falling back", entry.Message, StringComparison.OrdinalIgnoreCase);
|
||||
}
|
||||
|
||||
// UT-014
|
||||
[Fact]
|
||||
public void TransformIndexHtml_WithOverlayDisabled_ReturnsContentsUnchanged()
|
||||
{
|
||||
// No Plugin instance exists in the test host, so OverlayEnabled is
|
||||
// false — the same branch taken when an admin switches the overlay off.
|
||||
var html = "<html><body><div>x</div>\n</body></html>";
|
||||
|
||||
var result = FileTransformationRegistration.TransformIndexHtml(
|
||||
new TransformationPayload { Contents = html });
|
||||
|
||||
Assert.Equal(html, result);
|
||||
}
|
||||
|
||||
// UT-015
|
||||
[Fact]
|
||||
public void TransformIndexHtml_WithNullContents_ReturnsEmptyRatherThanThrowing()
|
||||
{
|
||||
// This callback is invoked by another plugin's code on every page
|
||||
// served. Throwing here would break the web client itself, not just
|
||||
// JRay's overlay.
|
||||
var result = FileTransformationRegistration.TransformIndexHtml(new TransformationPayload());
|
||||
|
||||
Assert.Equal(string.Empty, result);
|
||||
}
|
||||
|
||||
private sealed class CapturingLogger : ILogger
|
||||
{
|
||||
public List<(LogLevel Level, string Message)> Entries { get; } = new();
|
||||
|
||||
public IDisposable? BeginScope<TState>(TState state)
|
||||
where TState : notnull => null;
|
||||
|
||||
public bool IsEnabled(LogLevel logLevel) => true;
|
||||
|
||||
public void Log<TState>(
|
||||
LogLevel logLevel,
|
||||
EventId eventId,
|
||||
TState state,
|
||||
Exception? exception,
|
||||
Func<TState, Exception?, string> formatter)
|
||||
{
|
||||
Entries.Add((logLevel, formatter(state, exception)));
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,56 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
|
||||
<PropertyGroup>
|
||||
<TargetFramework>net9.0</TargetFramework>
|
||||
<Nullable>enable</Nullable>
|
||||
<IsPackable>false</IsPackable>
|
||||
<!--
|
||||
The plugin project treats warnings as errors and runs StyleCop. Tests do
|
||||
not inherit that: their naming conventions differ deliberately (Method_
|
||||
Condition_Expectation reads as documentation, and trips SA1300-family
|
||||
rules), and a style failure in a test is not a defect in the thing under
|
||||
test.
|
||||
-->
|
||||
<TreatWarningsAsErrors>false</TreatWarningsAsErrors>
|
||||
<GenerateDocumentationFile>false</GenerateDocumentationFile>
|
||||
<!--
|
||||
The plugin targets net9.0 to match Jellyfin's ABI, but a machine that can
|
||||
build it need not have the 9.0 *runtime* installed. Roll the test host
|
||||
forward to whatever major is present so the suite runs on a developer box
|
||||
and on CI without pinning either to a runtime that is not the plugin's.
|
||||
-->
|
||||
<RollForward>LatestMajor</RollForward>
|
||||
<!--
|
||||
The plugin framework-references Microsoft.AspNetCore.App through
|
||||
Jellyfin.Controller, and that reference flows into anything referencing
|
||||
the plugin. The T1 tier tests pure logic that touches no web type, so
|
||||
inheriting the web framework would make the suite unrunnable on any box
|
||||
without the ASP.NET Core runtime for no benefit. .NET resolves assemblies
|
||||
lazily, so types that never touch ASP.NET load fine without it.
|
||||
|
||||
T2 (controllers, authorisation) genuinely needs that runtime. When those
|
||||
tests arrive they belong in a second project that keeps this reference.
|
||||
-->
|
||||
<DisableTransitiveFrameworkReferences>true</DisableTransitiveFrameworkReferences>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<!--
|
||||
The plugin sets ExcludeAssets=runtime on these: at run time the Jellyfin
|
||||
server supplies them, so shipping copies in the plugin would risk loading
|
||||
a second, different MediaBrowser.Common. The test host is not the server,
|
||||
so it has to bring its own — hence the same packages without that
|
||||
exclusion, and only here.
|
||||
-->
|
||||
<PackageReference Include="Jellyfin.Controller" Version="10.11.5" />
|
||||
<PackageReference Include="Jellyfin.Model" Version="10.11.5" />
|
||||
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
|
||||
<PackageReference Include="xunit" Version="2.9.2" />
|
||||
<PackageReference Include="xunit.runner.visualstudio" Version="2.8.2" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<ProjectReference Include="..\Jellyfin.Plugin.JRay\Jellyfin.Plugin.JRay.csproj" />
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
@@ -0,0 +1,194 @@
|
||||
using System;
|
||||
using System.IO;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using Jellyfin.Plugin.JRay.Configuration;
|
||||
using Jellyfin.Plugin.JRay.Models;
|
||||
using Jellyfin.Plugin.JRay.Services;
|
||||
using MediaBrowser.Common.Configuration;
|
||||
using Microsoft.Extensions.Logging.Abstractions;
|
||||
using Xunit;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// JR-010 — three sources now deliver truth data (sidecar, pushed, fetched) and
|
||||
/// they are not interchangeable. A locally computed sidecar and a
|
||||
/// <c>loose</c>-tier manifest from a third-party server make claims of very
|
||||
/// different strength about the same item, and the truth file itself records
|
||||
/// nothing about how it arrived.
|
||||
///
|
||||
/// TRACES: UT-024, UT-025, UT-026, UT-027, UT-028 | JR-010
|
||||
/// </summary>
|
||||
public class ManagedTruthStoreTests : IDisposable
|
||||
{
|
||||
private readonly string _root;
|
||||
private readonly ManagedTruthStore _store;
|
||||
|
||||
public ManagedTruthStoreTests()
|
||||
{
|
||||
_root = Path.Combine(Path.GetTempPath(), "jray-tests-" + Guid.NewGuid().ToString("N"));
|
||||
Directory.CreateDirectory(_root);
|
||||
_store = new ManagedTruthStore(new FakePaths(_root), NullLogger<ManagedTruthStore>.Instance);
|
||||
}
|
||||
|
||||
public void Dispose()
|
||||
{
|
||||
GC.SuppressFinalize(this);
|
||||
if (Directory.Exists(_root))
|
||||
{
|
||||
Directory.Delete(_root, recursive: true);
|
||||
}
|
||||
}
|
||||
|
||||
private static TruthFile Truth()
|
||||
{
|
||||
var truth = new TruthFile { SchemaVersion = 1, Movie = "/m.mkv" };
|
||||
var actor = new TruthActor { Name = "A", TmdbId = "884" };
|
||||
actor.Scenes.Add([1.0, 2.0]);
|
||||
truth.Actors.Add(actor);
|
||||
return truth;
|
||||
}
|
||||
|
||||
// UT-024
|
||||
[Fact]
|
||||
public async Task SaveAsync_ThenLoadProvenance_RoundTripsAFetchedClaim()
|
||||
{
|
||||
var id = Guid.NewGuid();
|
||||
var recorded = new DateTime(2026, 7, 31, 12, 0, 0, DateTimeKind.Utc);
|
||||
|
||||
await _store.SaveAsync(
|
||||
id,
|
||||
Truth(),
|
||||
new TruthProvenance
|
||||
{
|
||||
Source = TruthSource.Fetched,
|
||||
ServerUrl = "https://jray.example",
|
||||
MatchTier = MatchTier.Loose,
|
||||
OffsetSec = -12.5,
|
||||
Caveat = "loose match",
|
||||
RecordedAt = recorded,
|
||||
},
|
||||
CancellationToken.None);
|
||||
|
||||
var loaded = _store.LoadProvenance(id);
|
||||
|
||||
Assert.NotNull(loaded);
|
||||
Assert.Equal(TruthSource.Fetched, loaded!.Source);
|
||||
Assert.Equal("https://jray.example", loaded.ServerUrl);
|
||||
Assert.Equal(MatchTier.Loose, loaded.MatchTier);
|
||||
|
||||
// The offset is unrecoverable once applied: the stored windows look
|
||||
// native, and nothing else would say they had been shifted.
|
||||
Assert.Equal(-12.5, loaded.OffsetSec);
|
||||
Assert.Equal("loose match", loaded.Caveat);
|
||||
Assert.Equal(recorded, loaded.RecordedAt);
|
||||
}
|
||||
|
||||
// UT-025
|
||||
[Fact]
|
||||
public async Task SaveAsync_LocalPush_RecordsNoServerOrTier()
|
||||
{
|
||||
var id = Guid.NewGuid();
|
||||
|
||||
await _store.SaveAsync(
|
||||
id,
|
||||
Truth(),
|
||||
TruthProvenance.Local(TruthSource.Pushed, DateTime.UtcNow),
|
||||
CancellationToken.None);
|
||||
|
||||
var loaded = _store.LoadProvenance(id)!;
|
||||
|
||||
Assert.Equal(TruthSource.Pushed, loaded.Source);
|
||||
Assert.Equal(string.Empty, loaded.ServerUrl);
|
||||
|
||||
// A push is about *this* file, so there is no cut to match. A tier here
|
||||
// would be a fabricated claim.
|
||||
Assert.Null(loaded.MatchTier);
|
||||
}
|
||||
|
||||
// UT-026
|
||||
[Fact]
|
||||
public async Task SaveAsync_DoesNotWriteProvenanceIntoTheTruthFile()
|
||||
{
|
||||
var id = Guid.NewGuid();
|
||||
await _store.SaveAsync(id, Truth(), TruthProvenance.Local(TruthSource.Pushed, DateTime.UtcNow), CancellationToken.None);
|
||||
|
||||
var truthJson = await File.ReadAllTextAsync(
|
||||
Path.Combine(_root, "plugins", "configurations", "JRay", "truth", id.ToString("D") + ".json"));
|
||||
|
||||
// JR-004: the bytes served back are the bytes the producer wrote.
|
||||
Assert.DoesNotContain("source", truthJson, StringComparison.OrdinalIgnoreCase);
|
||||
Assert.DoesNotContain("match_tier", truthJson, StringComparison.OrdinalIgnoreCase);
|
||||
}
|
||||
|
||||
// UT-027
|
||||
[Fact]
|
||||
public async Task Delete_RemovesProvenanceToo()
|
||||
{
|
||||
var id = Guid.NewGuid();
|
||||
await _store.SaveAsync(id, Truth(), TruthProvenance.Local(TruthSource.Pushed, DateTime.UtcNow), CancellationToken.None);
|
||||
|
||||
Assert.True(_store.Delete(id));
|
||||
|
||||
// A stale provenance record outliving its truth file would describe data
|
||||
// the next fetch has already replaced.
|
||||
Assert.Null(_store.LoadProvenance(id));
|
||||
Assert.False(_store.Exists(id));
|
||||
}
|
||||
|
||||
// UT-028
|
||||
[Fact]
|
||||
public void LoadProvenance_ForUnknownItem_ReturnsNull()
|
||||
{
|
||||
Assert.Null(_store.LoadProvenance(Guid.NewGuid()));
|
||||
}
|
||||
|
||||
private sealed class FakePaths : IApplicationPaths
|
||||
{
|
||||
public FakePaths(string root)
|
||||
{
|
||||
ProgramDataPath = root;
|
||||
PluginsPath = Path.Combine(root, "plugins");
|
||||
PluginConfigurationsPath = Path.Combine(root, "plugins", "configurations");
|
||||
}
|
||||
|
||||
public string ProgramDataPath { get; }
|
||||
|
||||
public string WebPath => Path.Combine(ProgramDataPath, "web");
|
||||
|
||||
public string ProgramSystemPath => ProgramDataPath;
|
||||
|
||||
public string DataPath => ProgramDataPath;
|
||||
|
||||
public string ImageCachePath => ProgramDataPath;
|
||||
|
||||
public string PluginsPath { get; }
|
||||
|
||||
public string PluginConfigurationsPath { get; }
|
||||
|
||||
public string LogDirectoryPath => ProgramDataPath;
|
||||
|
||||
public string ConfigurationDirectoryPath => ProgramDataPath;
|
||||
|
||||
public string SystemConfigurationFilePath => Path.Combine(ProgramDataPath, "system.xml");
|
||||
|
||||
public string CachePath { get; set; } = string.Empty;
|
||||
|
||||
public string TempDirectory => Path.Combine(ProgramDataPath, "temp");
|
||||
|
||||
public string TrickplayPath => Path.Combine(ProgramDataPath, "trickplay");
|
||||
|
||||
public string VirtualDataPath => ProgramDataPath;
|
||||
|
||||
public string BackupPath => Path.Combine(ProgramDataPath, "backup");
|
||||
|
||||
public void MakeSanityCheckOrThrow()
|
||||
{
|
||||
}
|
||||
|
||||
public void CreateAndCheckMarker(string path, string markerName, bool recursive = false)
|
||||
{
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,319 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using Jellyfin.Plugin.JRay.Configuration;
|
||||
using Jellyfin.Plugin.JRay.Models;
|
||||
using Jellyfin.Plugin.JRay.Services;
|
||||
using Xunit;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// Tests for the manifest exchange: tier policy, transport rules, validation on
|
||||
/// receipt, and offset application.
|
||||
/// </summary>
|
||||
public class ManifestExchangeTests
|
||||
{
|
||||
private static ManifestServer Server(string url) =>
|
||||
new() { Url = url, Name = "test", Enabled = true };
|
||||
|
||||
private static TitleQuery Query() =>
|
||||
new() { TmdbId = "504172", RuntimeSec = 6420.5 };
|
||||
|
||||
// -----------------------------------------------------------------------
|
||||
// The withdrawn file-hash tier
|
||||
// -----------------------------------------------------------------------
|
||||
|
||||
[Fact]
|
||||
public void MatchTierHasNoExactMember()
|
||||
{
|
||||
// The `exact` tier keyed on an OpenSubtitles file hash and was withdrawn
|
||||
// on legal grounds: a file hash identifies the exact release a user
|
||||
// holds, not the cut the timings describe, so sending one turns a
|
||||
// catalogue lookup into a release-identification service.
|
||||
//
|
||||
// Asserted on the enum rather than trusted, because "we removed it" is
|
||||
// exactly the kind of decision a later reader re-adds as an oversight.
|
||||
var names = Enum.GetNames<MatchTier>();
|
||||
Assert.DoesNotContain("Exact", names);
|
||||
Assert.Equal(new[] { "Loose", "Runtime", "Audio" }, names);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AudioIsTheTopTier()
|
||||
{
|
||||
// Content-derived, so it identifies the cut rather than the copy — which
|
||||
// is what makes it an acceptable replacement for the file hash.
|
||||
Assert.True(MatchTier.Audio > MatchTier.Runtime);
|
||||
Assert.True(MatchTier.Runtime > MatchTier.Loose);
|
||||
Assert.Equal(MatchTier.Audio, Enum.GetValues<MatchTier>().Max());
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void NoVideoHashIsEverSent()
|
||||
{
|
||||
// Structural, not merely policy: `TitleQuery` has no VideoHash property,
|
||||
// so there is nothing a future caller could populate.
|
||||
Assert.Null(typeof(TitleQuery).GetProperty("VideoHash"));
|
||||
|
||||
var query = new TitleQuery { TmdbId = "504172", RuntimeSec = 6420.5 };
|
||||
Assert.DoesNotContain("video_hash", query.ToQueryString(), StringComparison.Ordinal);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AServerReportingTheWithdrawnTierIsDeclined()
|
||||
{
|
||||
// A server may still hold hashes from other clients. If one somehow
|
||||
// reports `exact`, it is unrecognised rather than silently accepted
|
||||
// under a tier this plugin has no policy for.
|
||||
Assert.Null(ManifestExchangeClient.ParseTier("exact"));
|
||||
Assert.Equal(MatchTier.Audio, ManifestExchangeClient.ParseTier("audio"));
|
||||
Assert.Equal(MatchTier.Runtime, ManifestExchangeClient.ParseTier("runtime"));
|
||||
Assert.Equal(MatchTier.Loose, ManifestExchangeClient.ParseTier("loose"));
|
||||
Assert.Null(ManifestExchangeClient.ParseTier("nonsense"));
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------
|
||||
// Transport
|
||||
// -----------------------------------------------------------------------
|
||||
|
||||
[Theory]
|
||||
[InlineData("https://jray.tourolle.paris", true)]
|
||||
[InlineData("https://third.party.example", true)]
|
||||
[InlineData("http://127.0.0.1:8080", true)]
|
||||
[InlineData("http://localhost:8080", true)]
|
||||
[InlineData("http://jray.tourolle.paris", false)]
|
||||
[InlineData("http://192.168.1.10:8080", false)]
|
||||
[InlineData("ftp://example.com", false)]
|
||||
public void HttpsIsRequiredAwayFromLoopback(string url, bool acceptable)
|
||||
{
|
||||
// A plaintext server would let any network intermediary rewrite actor
|
||||
// overlays, and the overlay is shown to the user as fact. Loopback is
|
||||
// exempt because there is no network path to intercept.
|
||||
Assert.Equal(acceptable, ManifestExchangeClient.IsTransportAcceptable(new Uri(url)));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AnUnusableServerUrlYieldsNoRequest()
|
||||
{
|
||||
Assert.Null(ManifestExchangeClient.BuildUrl(Server("http://example.com"), "manifests/movie", Query()));
|
||||
Assert.Null(ManifestExchangeClient.BuildUrl(Server("not a url"), "manifests/movie", Query()));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void QueryParametersAreEscaped()
|
||||
{
|
||||
var url = ManifestExchangeClient.BuildUrl(
|
||||
Server("https://s.example/"),
|
||||
"manifests/movie",
|
||||
new TitleQuery { TmdbId = "504172", RuntimeSec = 6420.5 });
|
||||
|
||||
Assert.NotNull(url);
|
||||
Assert.StartsWith("https://s.example/api/v1/manifests/movie?", url!.AbsoluteUri, StringComparison.Ordinal);
|
||||
Assert.Contains("tmdb_id=504172", url.AbsoluteUri, StringComparison.Ordinal);
|
||||
// Invariant formatting, so a comma-decimal locale cannot corrupt the runtime.
|
||||
Assert.Contains("runtime_sec=6420.5", url.AbsoluteUri, StringComparison.Ordinal);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void EpisodeCoordinatesAreSent()
|
||||
{
|
||||
var url = ManifestExchangeClient.BuildUrl(
|
||||
Server("https://s.example"),
|
||||
"manifests/episode",
|
||||
new TitleQuery { SeriesTmdbId = "1396", Season = 2, Episode = 5, RuntimeSec = 2820 });
|
||||
|
||||
Assert.NotNull(url);
|
||||
Assert.Contains("series_tmdb_id=1396", url!.AbsoluteUri, StringComparison.Ordinal);
|
||||
Assert.Contains("season=2", url.AbsoluteUri, StringComparison.Ordinal);
|
||||
Assert.Contains("episode=5", url.AbsoluteUri, StringComparison.Ordinal);
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------
|
||||
// Validation on receipt — every server is untrusted
|
||||
// -----------------------------------------------------------------------
|
||||
|
||||
private static Jmanifest ValidManifest()
|
||||
{
|
||||
var m = new Jmanifest { JmanifestVersion = 2 };
|
||||
m.Identity = new JmanifestIdentity { Type = "movie", TmdbId = "504172" };
|
||||
m.Cut = new JmanifestCut { RuntimeSec = 6420.5 };
|
||||
var actor = new JmanifestActor { Name = "Steve Buscemi", TmdbId = "884" };
|
||||
actor.Scenes.Add(new JmanifestScene { Start = 191.6, End = 209.2, Belief = 0.98, Route = "live" });
|
||||
m.Actors.Add(actor);
|
||||
return m;
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AWellFormedManifestValidates()
|
||||
{
|
||||
Assert.True(ManifestValidator.TryValidate(ValidManifest(), 6420.5, out var error), error);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AnUnknownEnvelopeVersionIsRefused()
|
||||
{
|
||||
// Never guessed at: a server one version ahead may have changed the
|
||||
// meaning of a field this plugin thinks it understands.
|
||||
foreach (var version in new[] { 0, 1, 3, 99 })
|
||||
{
|
||||
var m = ValidManifest();
|
||||
m.JmanifestVersion = version;
|
||||
Assert.False(ManifestValidator.TryValidate(m, 6420.5, out var error));
|
||||
Assert.Contains("jmanifest_version", error, StringComparison.Ordinal);
|
||||
}
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void WindowsBeyondTheLocalRuntimeAreRejected()
|
||||
{
|
||||
// Bounds are checked against the *local* file, because that is what the
|
||||
// overlay indexes into. A window past the end is evidence the manifest
|
||||
// describes another cut.
|
||||
var m = ValidManifest();
|
||||
m.Actors[0].Scenes.Clear();
|
||||
m.Actors[0].Scenes.Add(new JmanifestScene { Start = 10, End = 9000 });
|
||||
Assert.False(ManifestValidator.TryValidate(m, 6420.5, out var error));
|
||||
Assert.Contains("runtime", error, StringComparison.Ordinal);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void InvertedNegativeAndNonFiniteWindowsAreRejected()
|
||||
{
|
||||
foreach (var scene in new[]
|
||||
{
|
||||
new JmanifestScene { Start = 50, End = 10 },
|
||||
new JmanifestScene { Start = -1, End = 10 },
|
||||
new JmanifestScene { Start = double.NaN, End = 10 },
|
||||
new JmanifestScene { Start = 0, End = double.PositiveInfinity },
|
||||
})
|
||||
{
|
||||
var m = ValidManifest();
|
||||
m.Actors[0].Scenes.Clear();
|
||||
m.Actors[0].Scenes.Add(scene);
|
||||
Assert.False(ManifestValidator.TryValidate(m, 6420.5, out _));
|
||||
}
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void BeliefOutsideZeroToOneIsRejected()
|
||||
{
|
||||
foreach (var belief in new[] { -0.1, 1.5, double.NaN })
|
||||
{
|
||||
var m = ValidManifest();
|
||||
m.Actors[0].Scenes[0].Belief = belief;
|
||||
Assert.False(ManifestValidator.TryValidate(m, 6420.5, out var error));
|
||||
Assert.Contains("belief", error, StringComparison.Ordinal);
|
||||
}
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void MalformedIdentifiersAreRejected()
|
||||
{
|
||||
var m = ValidManifest();
|
||||
m.Actors[0].TmdbId = "884'; DROP TABLE--";
|
||||
Assert.False(ManifestValidator.TryValidate(m, 6420.5, out _));
|
||||
|
||||
m = ValidManifest();
|
||||
m.Actors[0].ImdbId = "tt0000114"; // a title id in a person field
|
||||
Assert.False(ManifestValidator.TryValidate(m, 6420.5, out _));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ControlCharactersInANameAreRejected()
|
||||
{
|
||||
// The overlay renders names as text nodes, so markup is already inert —
|
||||
// but a bidi override still makes a name display as something other than
|
||||
// what was stored.
|
||||
foreach (var name in new[] { "SteveBuscemi", "SteveimecsuB", "SteveBuscemi" })
|
||||
{
|
||||
var m = ValidManifest();
|
||||
m.Actors[0].Name = name;
|
||||
Assert.False(ManifestValidator.TryValidate(m, 6420.5, out _));
|
||||
}
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void RealNamesAreAccepted()
|
||||
{
|
||||
foreach (var name in new[] { "Steve Buscemi", "Renée Zellweger", "宮崎 駿", "O'Brien" })
|
||||
{
|
||||
var m = ValidManifest();
|
||||
m.Actors[0].Name = name;
|
||||
Assert.True(ManifestValidator.TryValidate(m, 6420.5, out var error), $"{name}: {error}");
|
||||
}
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void DuplicateActorsAreRejected()
|
||||
{
|
||||
var m = ValidManifest();
|
||||
var dup = new JmanifestActor { Name = "Steve Buscemi", TmdbId = "884" };
|
||||
dup.Scenes.Add(new JmanifestScene { Start = 1, End = 2 });
|
||||
m.Actors.Add(dup);
|
||||
Assert.False(ManifestValidator.TryValidate(m, 6420.5, out _));
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------
|
||||
// Offset application
|
||||
// -----------------------------------------------------------------------
|
||||
|
||||
[Fact]
|
||||
public void TheOffsetIsAppliedToEveryWindow()
|
||||
{
|
||||
// Applied once, at store time, so the stored truth is always in the
|
||||
// local file's timebase and no reader needs offset awareness.
|
||||
var m = ValidManifest();
|
||||
m.Actors[0].Scenes.Clear();
|
||||
m.Actors[0].Scenes.Add(new JmanifestScene { Start = 100, End = 120 });
|
||||
m.Actors[0].Scenes.Add(new JmanifestScene { Start = 200, End = 220 });
|
||||
|
||||
var truth = ManifestConverter.ToTruthFile(m, 40, "/media/film.mkv");
|
||||
|
||||
Assert.Equal(new[] { 140.0, 160.0 }, truth.Actors[0].Scenes[0]);
|
||||
Assert.Equal(new[] { 240.0, 260.0 }, truth.Actors[0].Scenes[1]);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ANegativeOffsetCannotPushAWindowBelowZero()
|
||||
{
|
||||
// A start before the file begins is not indexable by any reader.
|
||||
var m = ValidManifest();
|
||||
m.Actors[0].Scenes.Clear();
|
||||
m.Actors[0].Scenes.Add(new JmanifestScene { Start = 5, End = 20 });
|
||||
|
||||
var truth = ManifestConverter.ToTruthFile(m, -40, "/media/film.mkv");
|
||||
|
||||
Assert.Equal(0.0, truth.Actors[0].Scenes[0][0]);
|
||||
Assert.True(truth.Actors[0].Scenes[0][1] >= truth.Actors[0].Scenes[0][0]);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void WindowsAreShiftedNeverReshaped()
|
||||
{
|
||||
// A window is a claim about scene membership (SR-002), so merging
|
||||
// adjacent windows would answer a different question than the pipeline
|
||||
// answered — "was a face visible" rather than "was the actor present".
|
||||
var m = ValidManifest();
|
||||
m.Actors[0].Scenes.Clear();
|
||||
m.Actors[0].Scenes.Add(new JmanifestScene { Start = 10, End = 20 });
|
||||
m.Actors[0].Scenes.Add(new JmanifestScene { Start = 20, End = 30 });
|
||||
|
||||
var truth = ManifestConverter.ToTruthFile(m, 0, "/media/film.mkv");
|
||||
|
||||
Assert.Equal(2, truth.Actors[0].Scenes.Count);
|
||||
Assert.Equal(new[] { 10.0, 20.0 }, truth.Actors[0].Scenes[0]);
|
||||
Assert.Equal(new[] { 20.0, 30.0 }, truth.Actors[0].Scenes[1]);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ALooseMatchSurfacesACaveat()
|
||||
{
|
||||
// Applied as a caveat rather than silently: the runtimes differ by up to
|
||||
// 30 seconds, which is usually a different trim of the same cut but is
|
||||
// not guaranteed to be.
|
||||
Assert.NotNull(ManifestConverter.DescribeCaveat(MatchTier.Loose, 0));
|
||||
Assert.NotNull(ManifestConverter.DescribeCaveat(MatchTier.Audio, 40));
|
||||
Assert.Null(ManifestConverter.DescribeCaveat(MatchTier.Runtime, 0));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,85 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using Jellyfin.Plugin.JRay.Models;
|
||||
using Jellyfin.Plugin.JRay.Services;
|
||||
using Xunit;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// JR-016 — prioritise/ignore rules resolve by specificity: Item beats Series
|
||||
/// beats Genre. A scope+value holds only one action, so the only conflicts
|
||||
/// possible are across scopes, and that is exactly what these cover.
|
||||
///
|
||||
/// TRACES: UT-007, UT-008, UT-009, UT-010, UT-011 | JR-016
|
||||
/// </summary>
|
||||
public class PolicyResolverTests
|
||||
{
|
||||
private static readonly Guid ItemId = Guid.Parse("11111111-1111-1111-1111-111111111111");
|
||||
private static readonly Guid SeriesId = Guid.Parse("22222222-2222-2222-2222-222222222222");
|
||||
|
||||
private static MediaPolicyRule Rule(PolicyScope scope, string value, PolicyAction action)
|
||||
=> new() { Scope = scope, Value = value, Action = action };
|
||||
|
||||
// UT-007
|
||||
[Fact]
|
||||
public void Resolve_WithNoMatchingRule_ReturnsNull()
|
||||
{
|
||||
var rules = new List<MediaPolicyRule> { Rule(PolicyScope.Genre, "Anime", PolicyAction.Ignore) };
|
||||
|
||||
Assert.Null(PolicyResolver.Resolve(rules, ItemId, SeriesId, new[] { "Drama" }));
|
||||
}
|
||||
|
||||
// UT-008
|
||||
[Fact]
|
||||
public void Resolve_ItemRuleBeatsSeriesRule()
|
||||
{
|
||||
var rules = new List<MediaPolicyRule>
|
||||
{
|
||||
Rule(PolicyScope.Series, SeriesId.ToString("D"), PolicyAction.Ignore),
|
||||
Rule(PolicyScope.Item, ItemId.ToString("D"), PolicyAction.Prioritise),
|
||||
};
|
||||
|
||||
Assert.Equal(PolicyAction.Prioritise, PolicyResolver.Resolve(rules, ItemId, SeriesId, Array.Empty<string>()));
|
||||
}
|
||||
|
||||
// UT-009
|
||||
[Fact]
|
||||
public void Resolve_PrioritisedSeriesInsideIgnoredGenre_SeriesWins()
|
||||
{
|
||||
// The case that motivated specificity resolution: an admin ignores a
|
||||
// whole genre but wants one series out of it anyway. If genre won, the
|
||||
// more specific instruction would be silently discarded.
|
||||
var rules = new List<MediaPolicyRule>
|
||||
{
|
||||
Rule(PolicyScope.Genre, "Anime", PolicyAction.Ignore),
|
||||
Rule(PolicyScope.Series, SeriesId.ToString("D"), PolicyAction.Prioritise),
|
||||
};
|
||||
|
||||
Assert.Equal(PolicyAction.Prioritise, PolicyResolver.Resolve(rules, ItemId, SeriesId, new[] { "Anime" }));
|
||||
}
|
||||
|
||||
// UT-010
|
||||
[Fact]
|
||||
public void Resolve_GenreMatchIsCaseInsensitive()
|
||||
{
|
||||
var rules = new List<MediaPolicyRule> { Rule(PolicyScope.Genre, "anime", PolicyAction.Ignore) };
|
||||
|
||||
Assert.Equal(PolicyAction.Ignore, PolicyResolver.Resolve(rules, ItemId, SeriesId, new[] { "AnImE" }));
|
||||
}
|
||||
|
||||
// UT-011
|
||||
[Fact]
|
||||
public void Resolve_SeriesRuleDoesNotMatchNonEpisode()
|
||||
{
|
||||
// A movie carries Guid.Empty as its series id. A series rule whose value
|
||||
// happened to be an empty GUID must not swallow every movie in the
|
||||
// library.
|
||||
var rules = new List<MediaPolicyRule>
|
||||
{
|
||||
Rule(PolicyScope.Series, Guid.Empty.ToString("D"), PolicyAction.Ignore),
|
||||
};
|
||||
|
||||
Assert.Null(PolicyResolver.Resolve(rules, ItemId, Guid.Empty, Array.Empty<string>()));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,150 @@
|
||||
using System.Diagnostics;
|
||||
using System.Linq;
|
||||
using System.Text.Json;
|
||||
using Jellyfin.Plugin.JRay.Models;
|
||||
using Jellyfin.Plugin.JRay.Services;
|
||||
using Xunit;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// JR-004 (windows are scene-membership claims, served verbatim), JR-005 (query
|
||||
/// semantics and inclusive bounds) and JR-006 (numerous windows).
|
||||
///
|
||||
/// These pin the semantics SR-002 sets. The failure they exist to prevent is a
|
||||
/// well-meaning "tidy-up" — merging adjacent windows, trimming a zero-length
|
||||
/// one, or collapsing overlaps — each of which silently answers a different
|
||||
/// question from the one the truth file asked.
|
||||
///
|
||||
/// TRACES: UT-016, UT-017, UT-018, UT-019, UT-020, UT-021, UT-022, UT-023 | JR-004, JR-005, JR-006
|
||||
/// </summary>
|
||||
public class PresenceLookupTests
|
||||
{
|
||||
private static TruthActor Actor(params double[][] windows)
|
||||
{
|
||||
var actor = new TruthActor { Name = "Steve Buscemi", TmdbId = "884" };
|
||||
foreach (var w in windows)
|
||||
{
|
||||
actor.Scenes.Add(w);
|
||||
}
|
||||
|
||||
return actor;
|
||||
}
|
||||
|
||||
// UT-016
|
||||
[Theory]
|
||||
[InlineData(12.0)] // exactly the start
|
||||
[InlineData(30.0)] // inside
|
||||
[InlineData(45.0)] // exactly the end
|
||||
public void IsPresentAt_WithinInclusiveBounds_IsPresent(double t)
|
||||
{
|
||||
// Both ends inclusive: a window is [start, end], not [start, end).
|
||||
Assert.True(PresenceLookup.IsPresentAt(Actor([12.0, 45.0]), t));
|
||||
}
|
||||
|
||||
// UT-017
|
||||
[Theory]
|
||||
[InlineData(11.999)]
|
||||
[InlineData(45.001)]
|
||||
public void IsPresentAt_OutsideBounds_IsAbsent(double t)
|
||||
{
|
||||
Assert.False(PresenceLookup.IsPresentAt(Actor([12.0, 45.0]), t));
|
||||
}
|
||||
|
||||
// UT-018
|
||||
[Fact]
|
||||
public void IsPresentAt_ZeroLengthWindow_IsPresentAtThatInstant()
|
||||
{
|
||||
// A single sighting is a legitimate window. Discarding it as degenerate
|
||||
// would drop the actor from a scene they are demonstrably in.
|
||||
Assert.True(PresenceLookup.IsPresentAt(Actor([30.0, 30.0]), 30.0));
|
||||
}
|
||||
|
||||
// UT-019
|
||||
[Fact]
|
||||
public void IsPresentAt_OverlappingWindows_IsPresentInsideTheEnclosingOne()
|
||||
{
|
||||
// [0,100] encloses [50,60]. A lookup that assumed non-overlapping,
|
||||
// sorted windows and stopped at the first start > t would miss t = 80.
|
||||
Assert.True(PresenceLookup.IsPresentAt(Actor([0.0, 100.0], [50.0, 60.0]), 80.0));
|
||||
}
|
||||
|
||||
// UT-020
|
||||
[Fact]
|
||||
public void IsPresentAt_UnsortedWindows_StillFindsPresence()
|
||||
{
|
||||
// Sortedness is a producer guarantee, not something correctness may
|
||||
// depend on. A file that violates it must still be read correctly.
|
||||
var actor = Actor([100.0, 110.0], [10.0, 20.0]);
|
||||
|
||||
Assert.True(PresenceLookup.IsPresentAt(actor, 15.0));
|
||||
Assert.False(PresenceLookup.WindowsAreSorted(actor));
|
||||
}
|
||||
|
||||
// UT-021
|
||||
[Fact]
|
||||
public void ActorsPresentAt_AdjacentWindowsAreNeverMerged()
|
||||
{
|
||||
// [0,10] and [10,20] look mergeable. They must not be merged: two
|
||||
// windows mean a genuine departure and return, and the plugin does not
|
||||
// reinterpret that claim. The actor is reported once, from two windows.
|
||||
var truth = new TruthFile();
|
||||
truth.Actors.Add(Actor([0.0, 10.0], [10.0, 20.0]));
|
||||
|
||||
Assert.Single(PresenceLookup.ActorsPresentAt(truth, 10.0));
|
||||
Assert.Equal(2, truth.Actors[0].Scenes.Count);
|
||||
}
|
||||
|
||||
// UT-022
|
||||
[Fact]
|
||||
public void TruthFile_RoundTrips_WithWindowsByteIdentical()
|
||||
{
|
||||
// JR-004: served exactly as given. A round trip through the serializer
|
||||
// is where a silent normalisation would show up.
|
||||
const string Json = """
|
||||
{"schema_version":1,"movie":"/m.mkv","sample_fps":1,"anneal_sec":2,
|
||||
"actors":[{"name":"A","imdb_id":"","tmdb_id":"884","jellyfin_id":"",
|
||||
"scenes":[[0.0,10.0],[10.0,20.0],[30.0,30.0]]}]}
|
||||
""";
|
||||
|
||||
var parsed = JsonSerializer.Deserialize<TruthFile>(Json, new JsonSerializerOptions(JsonSerializerDefaults.Web))!;
|
||||
var windows = parsed.Actors[0].Scenes;
|
||||
|
||||
Assert.Equal(3, windows.Count);
|
||||
Assert.Equal([0.0, 10.0], windows[0]);
|
||||
Assert.Equal([10.0, 20.0], windows[1]);
|
||||
Assert.Equal([30.0, 30.0], windows[2]);
|
||||
}
|
||||
|
||||
// UT-023
|
||||
[Fact]
|
||||
public void ActorsPresentAt_WithManyWindows_StaysCheapAndBoundsTheResponse()
|
||||
{
|
||||
// SR-002: windows may be numerous; consumers must not assume a handful
|
||||
// of long ones. Track-extent presence with a short re-acquisition
|
||||
// timeout produces many short windows per actor.
|
||||
var truth = new TruthFile();
|
||||
for (var a = 0; a < 50; a++)
|
||||
{
|
||||
var actor = Actor();
|
||||
for (var w = 0; w < 1000; w++)
|
||||
{
|
||||
actor.Scenes.Add([w * 10.0, (w * 10.0) + 4.0]);
|
||||
}
|
||||
|
||||
truth.Actors.Add(actor);
|
||||
}
|
||||
|
||||
var sw = Stopwatch.StartNew();
|
||||
var present = PresenceLookup.ActorsPresentAt(truth, 5002.0).ToList();
|
||||
sw.Stop();
|
||||
|
||||
// The response is bounded by actor count, never by window count — which
|
||||
// is what keeps `jray?t=` small however finely presence is sliced.
|
||||
Assert.Equal(50, present.Count);
|
||||
|
||||
// 50 000 windows scanned. Generous bound: this asserts the read path is
|
||||
// not accidentally quadratic, not a precise budget on a shared runner.
|
||||
Assert.True(sw.ElapsedMilliseconds < 250, $"lookup took {sw.ElapsedMilliseconds} ms");
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,92 @@
|
||||
using Jellyfin.Plugin.JRay.Services;
|
||||
using Xunit;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// JR-022 — an earlier JRay injected its overlay script into index.html on
|
||||
/// disk. Those users must not be left with a stale injection pointing at
|
||||
/// endpoints that have since changed, so removal survives even though JR-021
|
||||
/// deleted the injection that created it.
|
||||
///
|
||||
/// Removal keys on JRay's own marker. The cases that matter are the ones where
|
||||
/// it could reach too far: another plugin's injection, or a script tag that
|
||||
/// looks like JRay's but carries no marker.
|
||||
///
|
||||
/// TRACES: UT-001, UT-002, UT-003, UT-004, UT-005 | JR-022
|
||||
/// </summary>
|
||||
public class WebClientPatchServiceTests
|
||||
{
|
||||
private const string Marker = "<!-- jray-overlay -->";
|
||||
private const string ScriptTag = "<script defer src=\"/Plugins/JRay/ClientScript\"></script>";
|
||||
|
||||
// UT-001
|
||||
[Fact]
|
||||
public void RemoveInjection_WithMarkedTagAndNewline_RestoresOriginalBytes()
|
||||
{
|
||||
var original = "<html><body><div>x</div>\n</body></html>";
|
||||
var patched = "<html><body><div>x</div>\n" + ScriptTag + Marker + "\n</body></html>";
|
||||
|
||||
// The trailing newline goes with the tag. If it did not, every
|
||||
// install/uninstall cycle would leave another blank line behind.
|
||||
Assert.Equal(original, WebClientPatchService.RemoveInjection(patched));
|
||||
}
|
||||
|
||||
// UT-002
|
||||
[Fact]
|
||||
public void RemoveInjection_WithMarkedTagAndNoNewline_RemovesTag()
|
||||
{
|
||||
var patched = "<html><body>" + ScriptTag + Marker + "</body></html>";
|
||||
|
||||
Assert.Equal("<html><body></body></html>", WebClientPatchService.RemoveInjection(patched));
|
||||
}
|
||||
|
||||
// UT-003
|
||||
[Fact]
|
||||
public void RemoveInjection_WithNoMarker_LeavesDocumentUnchanged()
|
||||
{
|
||||
var clean = "<html><body><div>x</div>\n</body></html>";
|
||||
|
||||
Assert.Equal(clean, WebClientPatchService.RemoveInjection(clean));
|
||||
}
|
||||
|
||||
// UT-004
|
||||
[Fact]
|
||||
public void RemoveInjection_IsIdempotent()
|
||||
{
|
||||
var patched = "<html><body>" + ScriptTag + Marker + "\n</body></html>";
|
||||
|
||||
var once = WebClientPatchService.RemoveInjection(patched);
|
||||
var twice = WebClientPatchService.RemoveInjection(once);
|
||||
|
||||
// Startup calls this unconditionally, so it runs on every boot forever
|
||||
// after the patch is gone.
|
||||
Assert.Equal(once, twice);
|
||||
}
|
||||
|
||||
// UT-005
|
||||
[Fact]
|
||||
public void RemoveInjection_LeavesAnotherPluginsInjectionIntact()
|
||||
{
|
||||
var foreign = "<script defer src=\"/Plugins/Other/Script\"></script><!-- other-overlay -->";
|
||||
var patched = "<html><body>" + foreign + ScriptTag + Marker + "\n</body></html>";
|
||||
|
||||
var cleaned = WebClientPatchService.RemoveInjection(patched);
|
||||
|
||||
// The marker is what makes removal unambiguous. Removing anything we did
|
||||
// not add is the failure this guards: it is another plugin's file too.
|
||||
Assert.Contains(foreign, cleaned, System.StringComparison.Ordinal);
|
||||
Assert.DoesNotContain(Marker, cleaned, System.StringComparison.Ordinal);
|
||||
}
|
||||
|
||||
// UT-006
|
||||
[Fact]
|
||||
public void RemoveInjection_WithUnmarkedLookalikeTag_LeavesItAlone()
|
||||
{
|
||||
// Same script tag, no marker: JRay did not write this, so JRay does not
|
||||
// remove it.
|
||||
var patched = "<html><body>" + ScriptTag + "\n</body></html>";
|
||||
|
||||
Assert.Equal(patched, WebClientPatchService.RemoveInjection(patched));
|
||||
}
|
||||
}
|
||||
@@ -1,7 +1,9 @@
|
||||
|
||||
Microsoft Visual Studio Solution File, Format Version 12.00
|
||||
#
|
||||
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Jellyfin.Plugin.JRay", "Jellyfin.Plugin.JRay\Jellyfin.Plugin.JRay.csproj", "{D921B930-CF91-406F-ACBC-08914DCD0D34}"
|
||||
EndProject
|
||||
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Jellyfin.Plugin.JRay.Tests", "Jellyfin.Plugin.JRay.Tests\Jellyfin.Plugin.JRay.Tests.csproj", "{104C1021-3155-4404-9CA0-8ED8F310A152}"
|
||||
EndProject
|
||||
Global
|
||||
GlobalSection(SolutionConfigurationPlatforms) = preSolution
|
||||
Debug|Any CPU = Debug|Any CPU
|
||||
@@ -12,7 +14,7 @@ Global
|
||||
Release|x86 = Release|x86
|
||||
EndGlobalSection
|
||||
GlobalSection(ProjectConfigurationPlatforms) = postSolution
|
||||
{D921B930-CF91-406F-ACBC-08914DCD0D34}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
|
||||
{D921B930-CF91-406F-ACBC-08914DCD0D34}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
|
||||
{D921B930-CF91-406F-ACBC-08914DCD0D34}.Debug|Any CPU.Build.0 = Debug|Any CPU
|
||||
{D921B930-CF91-406F-ACBC-08914DCD0D34}.Debug|x64.ActiveCfg = Debug|Any CPU
|
||||
{D921B930-CF91-406F-ACBC-08914DCD0D34}.Debug|x64.Build.0 = Debug|Any CPU
|
||||
@@ -24,5 +26,20 @@ Global
|
||||
{D921B930-CF91-406F-ACBC-08914DCD0D34}.Release|x64.Build.0 = Release|Any CPU
|
||||
{D921B930-CF91-406F-ACBC-08914DCD0D34}.Release|x86.ActiveCfg = Release|Any CPU
|
||||
{D921B930-CF91-406F-ACBC-08914DCD0D34}.Release|x86.Build.0 = Release|Any CPU
|
||||
{104C1021-3155-4404-9CA0-8ED8F310A152}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
|
||||
{104C1021-3155-4404-9CA0-8ED8F310A152}.Debug|Any CPU.Build.0 = Debug|Any CPU
|
||||
{104C1021-3155-4404-9CA0-8ED8F310A152}.Debug|x64.ActiveCfg = Debug|Any CPU
|
||||
{104C1021-3155-4404-9CA0-8ED8F310A152}.Debug|x64.Build.0 = Debug|Any CPU
|
||||
{104C1021-3155-4404-9CA0-8ED8F310A152}.Debug|x86.ActiveCfg = Debug|Any CPU
|
||||
{104C1021-3155-4404-9CA0-8ED8F310A152}.Debug|x86.Build.0 = Debug|Any CPU
|
||||
{104C1021-3155-4404-9CA0-8ED8F310A152}.Release|Any CPU.ActiveCfg = Release|Any CPU
|
||||
{104C1021-3155-4404-9CA0-8ED8F310A152}.Release|Any CPU.Build.0 = Release|Any CPU
|
||||
{104C1021-3155-4404-9CA0-8ED8F310A152}.Release|x64.ActiveCfg = Release|Any CPU
|
||||
{104C1021-3155-4404-9CA0-8ED8F310A152}.Release|x64.Build.0 = Release|Any CPU
|
||||
{104C1021-3155-4404-9CA0-8ED8F310A152}.Release|x86.ActiveCfg = Release|Any CPU
|
||||
{104C1021-3155-4404-9CA0-8ED8F310A152}.Release|x86.Build.0 = Release|Any CPU
|
||||
EndGlobalSection
|
||||
GlobalSection(SolutionProperties) = preSolution
|
||||
HideSolutionNode = FALSE
|
||||
EndGlobalSection
|
||||
EndGlobal
|
||||
|
||||
@@ -0,0 +1,129 @@
|
||||
namespace Jellyfin.Plugin.JRay.Configuration;
|
||||
|
||||
/// <summary>
|
||||
/// How far a configured manifest server is trusted. See the JRay public server
|
||||
/// specification, §9 "Trusting third-party servers".
|
||||
/// </summary>
|
||||
public enum ServerTrustLevel
|
||||
{
|
||||
/// <summary>
|
||||
/// Accept manifests, but never contribute to this server and never send
|
||||
/// library inventory beyond the single item being queried. The default for
|
||||
/// user-added servers.
|
||||
/// </summary>
|
||||
FetchOnly = 0,
|
||||
|
||||
/// <summary>
|
||||
/// Eligible to contribute to, subject to <see cref="ManifestServer.AllowContribute"/>.
|
||||
/// </summary>
|
||||
Full = 1,
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The minimum cut-match tier a fetched manifest must reach before it is stored.
|
||||
/// See the public server specification, §3 "Cut matching".
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Every tier is a claim about a <em>cut</em>, never about a copy. There is no
|
||||
/// file-level tier, and the plugin sends no <c>video_hash</c>.
|
||||
/// <para>
|
||||
/// <b>The <c>Exact</c> tier was withdrawn for legal reasons; do not re-add it
|
||||
/// without an explicit, recorded agreement.</b> It keyed on the OpenSubtitles
|
||||
/// file hash, which identifies the individual encode a user holds rather than
|
||||
/// the edit the timings describe. A TMDB id discloses "some copy of this film";
|
||||
/// a file hash discloses "<em>this exact release</em>", which turns a catalogue
|
||||
/// lookup into a release-identification service and turns the server's database
|
||||
/// into a mapping from file fingerprints to the instances holding them. That is
|
||||
/// a far more specific disclosure than PR-005 permits, and a dataset no
|
||||
/// volunteer operator should be holding.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// The audio signature is the deliberate replacement: derived from content, it
|
||||
/// identifies the <em>cut</em>, so two different encodes of the same edit agree.
|
||||
/// It answers the question the exchange needs — "do these timings apply to this
|
||||
/// media?" — without answering the one it must not. <c>Audio</c> is therefore
|
||||
/// the top tier here.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public enum MatchTier
|
||||
{
|
||||
/// <summary>Audio 0.60–0.85, or runtimes within ±30s. Surfaced as a caveat in the UI.</summary>
|
||||
Loose = 0,
|
||||
|
||||
/// <summary>Runtimes within ±2s.</summary>
|
||||
Runtime = 1,
|
||||
|
||||
/// <summary>Audio signature score ≥ 0.85; may carry a non-zero offset. The top tier.</summary>
|
||||
Audio = 2,
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// One entry in the ordered list of manifest servers the plugin queries
|
||||
/// (public server specification, §9 "Multiple servers").
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// The list is ordered because order *is* the user's trust ranking, made
|
||||
/// explicit: for a fetch, servers are tried in order and the first acceptable
|
||||
/// result wins. Querying every server for every item would multiply egress and
|
||||
/// leak the library to more parties.
|
||||
///
|
||||
/// <c>FetchOnly</c> is the default for user-added servers. Adding a third-party
|
||||
/// server means trusting its operator not to serve deliberately wrong actor
|
||||
/// data — the client-side controls bound the damage to bad overlay content,
|
||||
/// they cannot make wrong data right.
|
||||
/// </remarks>
|
||||
// TRACES: JR-025 | PR-005, PR-006
|
||||
public class ManifestServer
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="ManifestServer"/> class.
|
||||
/// </summary>
|
||||
public ManifestServer()
|
||||
{
|
||||
Url = string.Empty;
|
||||
Name = string.Empty;
|
||||
Token = string.Empty;
|
||||
Enabled = false;
|
||||
AllowContribute = false;
|
||||
TrustLevel = ServerTrustLevel.FetchOnly;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the base URL of the server, e.g. "https://jray.tourolle.paris".
|
||||
/// HTTPS is required for non-loopback servers: a plaintext server would let
|
||||
/// any network intermediary rewrite actor overlays.
|
||||
/// </summary>
|
||||
public string Url { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the display label shown in the configuration page.
|
||||
/// </summary>
|
||||
public string Name { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the API token used to contribute manifests. Optional —
|
||||
/// required only to contribute, never to fetch. This is an anonymous bearer
|
||||
/// capability rather than an account (public server specification, §5a).
|
||||
/// </summary>
|
||||
public string Token { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets a value indicating whether this server is queried at all.
|
||||
/// Lets an admin disable an entry without deleting it and losing its token.
|
||||
/// </summary>
|
||||
public bool Enabled { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets a value indicating whether locally generated manifests may be
|
||||
/// contributed to this server. Independent of fetching, and off by default:
|
||||
/// contribution is never fanned out, because broadcasting uploads to every
|
||||
/// configured server would multiply privacy exposure without the user
|
||||
/// intending it.
|
||||
/// </summary>
|
||||
public bool AllowContribute { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets how far this server is trusted.
|
||||
/// </summary>
|
||||
public ServerTrustLevel TrustLevel { get; set; }
|
||||
}
|
||||
@@ -1,3 +1,4 @@
|
||||
using System.Collections.ObjectModel;
|
||||
using MediaBrowser.Model.Plugins;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Configuration;
|
||||
@@ -5,8 +6,28 @@ namespace Jellyfin.Plugin.JRay.Configuration;
|
||||
/// <summary>
|
||||
/// Plugin configuration.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Every manifest-exchange switch here defaults to <b>off</b>, including the
|
||||
/// pre-configured community server, so no traffic leaves an installation until
|
||||
/// an admin acts. Fetching and contributing each reveal to a server operator
|
||||
/// that some instance holds a given title; that is inherent to the exchange, so
|
||||
/// the defaults bound the exposure rather than pretending to remove it.
|
||||
/// </remarks>
|
||||
// TRACES: JR-036, JR-038 | PR-005
|
||||
public class PluginConfiguration : BasePluginConfiguration
|
||||
{
|
||||
/// <summary>
|
||||
/// The community manifest exchange. Shipped pre-configured but
|
||||
/// <b>disabled</b>, so no traffic leaves an installation until an admin opts
|
||||
/// in (public server specification, §9).
|
||||
/// </summary>
|
||||
public const string CommunityServerUrl = "https://jray.tourolle.paris";
|
||||
|
||||
/// <summary>
|
||||
/// Display name for <see cref="CommunityServerUrl"/>.
|
||||
/// </summary>
|
||||
public const string CommunityServerName = "JRay Community";
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="PluginConfiguration"/> class.
|
||||
/// </summary>
|
||||
@@ -15,6 +36,24 @@ public class PluginConfiguration : BasePluginConfiguration
|
||||
TruthFileSuffix = ".jray.json";
|
||||
CacheDurationMinutes = 60;
|
||||
EnableOverlay = true;
|
||||
|
||||
// Manifest sharing is a network egress feature, so every part of it is
|
||||
// off by default (public server specification, §9 "Configuration").
|
||||
EnableManifestSharing = false;
|
||||
ContributeManifests = false;
|
||||
ComputeAudioSignatures = false;
|
||||
MinimumMatchTier = MatchTier.Runtime;
|
||||
|
||||
// Pre-configured but disabled: the admin opts in by enabling it, rather
|
||||
// than by having to discover and type a URL.
|
||||
Servers.Add(new ManifestServer
|
||||
{
|
||||
Url = CommunityServerUrl,
|
||||
Name = CommunityServerName,
|
||||
Enabled = false,
|
||||
AllowContribute = false,
|
||||
TrustLevel = ServerTrustLevel.FetchOnly,
|
||||
});
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -37,4 +76,62 @@ public class PluginConfiguration : BasePluginConfiguration
|
||||
/// any previously injected script is removed.
|
||||
/// </summary>
|
||||
public bool EnableOverlay { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets a value indicating whether JRay may fetch actor-timeline
|
||||
/// manifests from the configured servers. Off by default — this is a network
|
||||
/// egress feature and must be opt-in.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Fetching reveals to a server operator that some instance holds a given
|
||||
/// title. That is inherent to the exchange, and each configured server
|
||||
/// multiplies the exposure, which the configuration page states plainly.
|
||||
/// </remarks>
|
||||
public bool EnableManifestSharing { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets a value indicating whether locally generated manifests may be
|
||||
/// contributed back. A separate opt-in from downloading, and off by default.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Contribution additionally requires <see cref="ManifestServer.AllowContribute"/>
|
||||
/// on the specific server and a token for it. Uploads are never fanned out to
|
||||
/// every configured server.
|
||||
/// </remarks>
|
||||
public bool ContributeManifests { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the minimum cut-match tier a fetched manifest must reach
|
||||
/// before it is stored.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Defaults to <see cref="MatchTier.Runtime"/>. <see cref="MatchTier.Loose"/>
|
||||
/// admits manifests whose runtime differs by up to 30s, which may be a
|
||||
/// different trim of the same cut — usable, but it should be surfaced as a
|
||||
/// caveat rather than applied silently.
|
||||
/// </remarks>
|
||||
public MatchTier MinimumMatchTier { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets a value indicating whether the plugin computes audio
|
||||
/// signatures for library items, enabling content-based cut matching and
|
||||
/// identification of files whose providence is unknown.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Off by default. Uses the FFmpeg binary Jellyfin already ships (via
|
||||
/// <c>IMediaEncoder.EncoderPath</c>), so there is no extra dependency, but it
|
||||
/// costs roughly a second or two of I/O per item and is therefore opt-in.
|
||||
/// </remarks>
|
||||
public bool ComputeAudioSignatures { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the ordered list of manifest servers.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Order is the user's trust ranking: for a fetch, servers are tried in order
|
||||
/// and the first result clearing <see cref="MinimumMatchTier"/> wins. For a
|
||||
/// series, first-match applies per <i>episode</i>, so a later server is
|
||||
/// queried only for the episodes earlier ones lacked.
|
||||
/// </remarks>
|
||||
public Collection<ManifestServer> Servers { get; } = new();
|
||||
}
|
||||
|
||||
@@ -29,10 +29,16 @@
|
||||
<span>Enable pause overlay</span>
|
||||
</label>
|
||||
<div class="fieldDescription">
|
||||
Injects a small script into the web client that shows on-screen actors
|
||||
when playback is paused. Disabling this removes the injected script.
|
||||
Shows the cast of the current scene when playback is paused. This
|
||||
requires the
|
||||
<a is="emby-linkbutton" class="button-link" href="https://github.com/IAmParadox27/jellyfin-plugin-file-transformation" target="_blank" rel="noopener">File Transformation</a>
|
||||
plugin, which rewrites the web client's index.html as it is served.
|
||||
JRay never modifies index.html on disk, so there is no fallback if
|
||||
that plugin is absent — only the overlay is affected, and every
|
||||
other JRay feature keeps working.
|
||||
</div>
|
||||
</div>
|
||||
<div id="JRayDependencyStatus" class="fieldDescription" style="margin:0 0 1.5em;padding:0.75em 1em;border-radius:0.25em;display:none;"></div>
|
||||
<div>
|
||||
<button is="emby-button" type="submit" class="raised button-submit block emby-button">
|
||||
<span>Save</span>
|
||||
@@ -131,6 +137,32 @@
|
||||
.replace(/>/g, '>').replace(/"/g, '"');
|
||||
}
|
||||
|
||||
// ---- Dependency status ----
|
||||
// Jellyfin cannot install a plugin's dependency, so the only thing
|
||||
// that closes the gap is saying so where an admin can act on it.
|
||||
function loadDependencyStatus() {
|
||||
var el = document.querySelector('#JRayDependencyStatus');
|
||||
return jrayApi('Status/Dependencies').then(function (status) {
|
||||
el.style.display = '';
|
||||
if (status.file_transformation_available) {
|
||||
el.style.background = 'rgba(82,168,82,0.15)';
|
||||
el.innerHTML = '<strong>File Transformation detected.</strong> '
|
||||
+ 'The pause overlay is served by rewriting index.html as it is '
|
||||
+ 'sent, leaving the file on disk untouched.';
|
||||
return;
|
||||
}
|
||||
|
||||
el.style.background = 'rgba(220,160,60,0.18)';
|
||||
el.innerHTML = '<strong>File Transformation is not installed — the pause '
|
||||
+ 'overlay is disabled.</strong> Every other JRay feature is unaffected. '
|
||||
+ 'To enable it, add this repository in Dashboard → Plugins → '
|
||||
+ 'Repositories, then install "File Transformation" and restart:<br />'
|
||||
+ '<code>' + escapeHtml(status.file_transformation_manifest_url) + '</code>';
|
||||
}).catch(function () {
|
||||
el.style.display = 'none';
|
||||
});
|
||||
}
|
||||
|
||||
// ---- Coverage ----
|
||||
|
||||
var JRayCoverColors = {
|
||||
@@ -340,6 +372,7 @@
|
||||
Dashboard.hideLoadingMsg();
|
||||
});
|
||||
|
||||
loadDependencyStatus();
|
||||
populateValueSelect();
|
||||
loadRules();
|
||||
loadCoverage();
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
using System;
|
||||
using System.Linq;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using Jellyfin.Plugin.JRay.Models;
|
||||
using Jellyfin.Plugin.JRay.Services;
|
||||
using Jellyfin.Plugin.JRay.Services.Interfaces;
|
||||
using Microsoft.AspNetCore.Authorization;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
@@ -11,12 +11,19 @@ using Microsoft.AspNetCore.Mvc;
|
||||
namespace Jellyfin.Plugin.JRay.Controllers;
|
||||
|
||||
/// <summary>
|
||||
/// Exposes scene-actor-extraction "truth" data: which actors are on screen
|
||||
/// at a given timestamp in a movie.
|
||||
/// Exposes scene-actor-extraction "truth" data: which actors are present in
|
||||
/// the scene at a given timestamp.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Presence is <b>scene-scoped</b>, not instantaneous: a window is a claim about
|
||||
/// scene membership, not a recognition event, so an actor who is off-camera
|
||||
/// during a reverse shot is still present. Windows are served exactly as stored
|
||||
/// — never merged, split or trimmed.
|
||||
/// </remarks>
|
||||
[ApiController]
|
||||
[Route("Plugins/JRay/Items/{itemId}")]
|
||||
[Authorize]
|
||||
// TRACES: JR-004, JR-005, JR-010, JR-012, JR-013, JR-014 | SR-002
|
||||
public class ActorsController : ControllerBase
|
||||
{
|
||||
private readonly ITruthDataService _truthDataService;
|
||||
@@ -31,7 +38,7 @@ public class ActorsController : ControllerBase
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the full actor timeline (every actor with their on-screen scene windows) for a movie.
|
||||
/// Gets the full actor timeline (every actor with their scene-presence windows) for a movie.
|
||||
/// </summary>
|
||||
/// <param name="itemId">The Jellyfin item id.</param>
|
||||
/// <param name="cancellationToken">Cancellation token.</param>
|
||||
@@ -51,7 +58,26 @@ public class ActorsController : ControllerBase
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the JRay context (currently: on-screen actors) at a given timestamp.
|
||||
/// Gets how this item's truth data was obtained.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Separate from <c>Timeline</c> on purpose: provenance is metadata *about*
|
||||
/// the claim, and folding it into the truth file would mean the bytes served
|
||||
/// back are not the bytes the producer wrote (JR-004).
|
||||
/// </remarks>
|
||||
/// <param name="itemId">The Jellyfin item id.</param>
|
||||
/// <returns>The provenance, or 404 if no truth data exists for this item.</returns>
|
||||
[HttpGet("Provenance")]
|
||||
[ProducesResponseType(StatusCodes.Status200OK)]
|
||||
[ProducesResponseType(StatusCodes.Status404NotFound)]
|
||||
public ActionResult<TruthProvenance> GetProvenance(Guid itemId)
|
||||
{
|
||||
var provenance = _truthDataService.GetProvenance(itemId);
|
||||
return provenance is null ? NotFound() : Ok(provenance);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the JRay context (currently: the actors in the scene) at a given timestamp.
|
||||
/// This is an extensible envelope — future fields (locations, trivia, etc.)
|
||||
/// will be added here without changing the route.
|
||||
/// </summary>
|
||||
@@ -71,9 +97,9 @@ public class ActorsController : ControllerBase
|
||||
}
|
||||
|
||||
var context = new JRayContext();
|
||||
foreach (var actor in truth.Actors.Where(actor => actor.Scenes.Any(scene => scene.Length == 2 && scene[0] <= t && t <= scene[1])))
|
||||
foreach (var actor in PresenceLookup.ActorsPresentAt(truth, t))
|
||||
{
|
||||
context.Actors.Add(new ActorAtTime
|
||||
context.Actors.Add(new ActorInScene
|
||||
{
|
||||
Name = actor.Name,
|
||||
ImdbId = actor.ImdbId,
|
||||
|
||||
@@ -19,9 +19,15 @@ namespace Jellyfin.Plugin.JRay.Controllers;
|
||||
/// by genre), and supplies the genre/series option lists the config page's
|
||||
/// rule editor needs.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Percent done is <c>covered / (total - ignored)</c>: ignored items are
|
||||
/// intentionally out of scope, so excluding a genre must not drag the figure
|
||||
/// down as though it were outstanding work.
|
||||
/// </remarks>
|
||||
[ApiController]
|
||||
[Route("Plugins/JRay/Coverage")]
|
||||
[Authorize(Roles = "Administrator")]
|
||||
// TRACES: JR-018, JR-019 | PR-003
|
||||
public class CoverageController : ControllerBase
|
||||
{
|
||||
private readonly ILibraryManager _libraryManager;
|
||||
@@ -64,7 +70,7 @@ public class CoverageController : ControllerBase
|
||||
|
||||
foreach (var item in items)
|
||||
{
|
||||
if (string.IsNullOrEmpty(item.Path))
|
||||
if (!TasksController.MediaFileExists(item))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,200 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using Jellyfin.Plugin.JRay.Configuration;
|
||||
using Jellyfin.Plugin.JRay.Models;
|
||||
using Jellyfin.Plugin.JRay.Services;
|
||||
using Jellyfin.Plugin.JRay.Services.Interfaces;
|
||||
using MediaBrowser.Common.Api;
|
||||
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;
|
||||
using Microsoft.Extensions.Logging;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Controllers;
|
||||
|
||||
/// <summary>
|
||||
/// Fetches actor-timeline manifests from the configured public servers.
|
||||
/// </summary>
|
||||
// TRACES: JR-025, JR-031 | PR-006
|
||||
[ApiController]
|
||||
[Authorize(Policy = Policies.RequiresElevation)]
|
||||
[Route("Plugins/JRay")]
|
||||
[Produces("application/json")]
|
||||
public class ManifestController : ControllerBase
|
||||
{
|
||||
private readonly ILibraryManager _libraryManager;
|
||||
private readonly IManifestExchangeClient _exchange;
|
||||
private readonly IManagedTruthStore _truthStore;
|
||||
private readonly ILogger<ManifestController> _logger;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="ManifestController"/> class.
|
||||
/// </summary>
|
||||
/// <param name="libraryManager">Library manager.</param>
|
||||
/// <param name="exchange">Manifest exchange client.</param>
|
||||
/// <param name="truthStore">Managed truth store.</param>
|
||||
/// <param name="logger">Logger.</param>
|
||||
public ManifestController(
|
||||
ILibraryManager libraryManager,
|
||||
IManifestExchangeClient exchange,
|
||||
IManagedTruthStore truthStore,
|
||||
ILogger<ManifestController> logger)
|
||||
{
|
||||
_libraryManager = libraryManager;
|
||||
_exchange = exchange;
|
||||
_truthStore = truthStore;
|
||||
_logger = logger;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Resolves an item across the configured servers and stores the first
|
||||
/// acceptable manifest.
|
||||
/// </summary>
|
||||
/// <param name="itemId">The library item id.</param>
|
||||
/// <param name="cancellationToken">Cancellation token.</param>
|
||||
/// <returns>What was fetched, and from where.</returns>
|
||||
/// <response code="200">A manifest was stored.</response>
|
||||
/// <response code="404">The item does not exist, or no server had a manifest for it.</response>
|
||||
/// <response code="409">Manifest sharing is disabled in the plugin configuration.</response>
|
||||
[HttpPost("Items/{itemId}/Fetch")]
|
||||
[ProducesResponseType(StatusCodes.Status200OK)]
|
||||
[ProducesResponseType(StatusCodes.Status404NotFound)]
|
||||
[ProducesResponseType(StatusCodes.Status409Conflict)]
|
||||
public async Task<ActionResult<ManifestFetchResult>> FetchItem(
|
||||
[FromRoute] Guid itemId,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
var config = Plugin.Instance?.Configuration;
|
||||
if (config is null || !config.EnableManifestSharing)
|
||||
{
|
||||
// Off by default and opt-in: this is a network egress feature, so it
|
||||
// never runs merely because an endpoint was called.
|
||||
return Conflict(new { error = "manifest sharing is disabled" });
|
||||
}
|
||||
|
||||
var item = _libraryManager.GetItemById(itemId);
|
||||
if (item is null)
|
||||
{
|
||||
return NotFound();
|
||||
}
|
||||
|
||||
var query = BuildQuery(item);
|
||||
if (query is null)
|
||||
{
|
||||
return NotFound(new { error = "item has no TMDB or IMDB id to look up" });
|
||||
}
|
||||
|
||||
var servers = config.Servers.ToList();
|
||||
var outcome = item is Episode
|
||||
? await _exchange.FetchEpisodeAsync(servers, config.MinimumMatchTier, query, cancellationToken)
|
||||
.ConfigureAwait(false)
|
||||
: await _exchange.FetchMovieAsync(servers, config.MinimumMatchTier, query, cancellationToken)
|
||||
.ConfigureAwait(false);
|
||||
|
||||
if (outcome?.Manifest is null)
|
||||
{
|
||||
return NotFound(new { error = "no configured server had an acceptable manifest" });
|
||||
}
|
||||
|
||||
// The offset is applied here, once, so the stored truth is always in the
|
||||
// local file's own timebase and no reader needs offset awareness.
|
||||
var truth = ManifestConverter.ToTruthFile(outcome.Manifest, outcome.OffsetSec, item.Path ?? string.Empty);
|
||||
var provenance = new TruthProvenance
|
||||
{
|
||||
Source = TruthSource.Fetched,
|
||||
ServerUrl = outcome.ServerUrl,
|
||||
MatchTier = outcome.Tier,
|
||||
OffsetSec = outcome.OffsetSec,
|
||||
Caveat = ManifestConverter.DescribeCaveat(outcome.Tier, outcome.OffsetSec),
|
||||
RecordedAt = DateTime.UtcNow,
|
||||
};
|
||||
|
||||
await _truthStore.SaveAsync(itemId, truth, provenance, cancellationToken).ConfigureAwait(false);
|
||||
|
||||
_logger.LogInformation(
|
||||
"Stored manifest for {ItemId} from {Server} at tier {Tier} (offset {Offset}s)",
|
||||
itemId,
|
||||
outcome.ServerUrl,
|
||||
outcome.Tier,
|
||||
outcome.OffsetSec);
|
||||
|
||||
return Ok(new ManifestFetchResult
|
||||
{
|
||||
ServerUrl = outcome.ServerUrl,
|
||||
Match = outcome.Tier.ToString().ToLowerInvariant(),
|
||||
OffsetSec = outcome.OffsetSec,
|
||||
ActorCount = truth.Actors.Count,
|
||||
Caveat = ManifestConverter.DescribeCaveat(outcome.Tier, outcome.OffsetSec),
|
||||
});
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Per-server reachability and last error, for the configuration page.
|
||||
/// </summary>
|
||||
/// <returns>One entry per configured server, in configured order.</returns>
|
||||
/// <response code="200">Status for each configured server.</response>
|
||||
[HttpGet("Servers/Status")]
|
||||
[ProducesResponseType(StatusCodes.Status200OK)]
|
||||
public ActionResult<IReadOnlyList<ServerStatus>> GetServerStatus()
|
||||
{
|
||||
var config = Plugin.Instance?.Configuration;
|
||||
if (config is null)
|
||||
{
|
||||
return Ok(Array.Empty<ServerStatus>());
|
||||
}
|
||||
|
||||
return Ok(_exchange.GetStatus(config.Servers.ToList()));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Reads a provider id from an item, or null when it is absent.
|
||||
/// </summary>
|
||||
private static string? ProviderId(BaseItem? item, string provider) =>
|
||||
item?.ProviderIds is { } ids && ids.TryGetValue(provider, out var value)
|
||||
&& !string.IsNullOrWhiteSpace(value)
|
||||
? value
|
||||
: null;
|
||||
|
||||
/// <summary>
|
||||
/// Builds the lookup query from an item's provider ids and measured runtime.
|
||||
/// </summary>
|
||||
private static TitleQuery? BuildQuery(BaseItem item)
|
||||
{
|
||||
var runtimeSec = item.RunTimeTicks.HasValue
|
||||
? TimeSpan.FromTicks(item.RunTimeTicks.Value).TotalSeconds
|
||||
: (double?)null;
|
||||
|
||||
if (item is Episode episode)
|
||||
{
|
||||
var series = episode.Series;
|
||||
var seriesTmdb = ProviderId(series, "Tmdb");
|
||||
if (string.IsNullOrEmpty(seriesTmdb))
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
return new TitleQuery
|
||||
{
|
||||
SeriesTmdbId = seriesTmdb,
|
||||
Season = episode.ParentIndexNumber,
|
||||
Episode = episode.IndexNumber,
|
||||
RuntimeSec = runtimeSec,
|
||||
};
|
||||
}
|
||||
|
||||
var tmdb = ProviderId(item, "Tmdb");
|
||||
var imdb = ProviderId(item, "Imdb");
|
||||
if (string.IsNullOrEmpty(tmdb) && string.IsNullOrEmpty(imdb))
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
return new TitleQuery { TmdbId = tmdb, ImdbId = imdb, RuntimeSec = runtimeSec };
|
||||
}
|
||||
}
|
||||
@@ -13,9 +13,15 @@ namespace Jellyfin.Plugin.JRay.Controllers;
|
||||
/// 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>
|
||||
/// <remarks>
|
||||
/// Rules steer work discovery only. They never reach the read endpoints or the
|
||||
/// overlay, because a rule says "don't spend compute here", not "pretend this
|
||||
/// item does not exist".
|
||||
/// </remarks>
|
||||
[ApiController]
|
||||
[Route("Plugins/JRay/Policy")]
|
||||
[Authorize(Roles = "Administrator")]
|
||||
// TRACES: JR-016, JR-014 | PR-003
|
||||
public class PolicyController : ControllerBase
|
||||
{
|
||||
private readonly IMediaPolicyStore _policyStore;
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
using Jellyfin.Plugin.JRay.Models;
|
||||
using Jellyfin.Plugin.JRay.Services;
|
||||
using Microsoft.AspNetCore.Authorization;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Controllers;
|
||||
|
||||
/// <summary>
|
||||
/// Reports whether JRay's hard dependency on the File Transformation plugin is
|
||||
/// satisfied, for the configuration page to surface.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Absent that plugin the pause overlay is disabled and every other JRay feature
|
||||
/// continues to work — so this is a status to display, not an error to raise.
|
||||
/// </remarks>
|
||||
[ApiController]
|
||||
[Route("Plugins/JRay/Status")]
|
||||
[Authorize(Roles = "Administrator")]
|
||||
// TRACES: JR-023 | PR-004
|
||||
public class StatusController : ControllerBase
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the dependency status.
|
||||
/// </summary>
|
||||
/// <returns>The dependency status.</returns>
|
||||
[HttpGet("Dependencies")]
|
||||
[ProducesResponseType(StatusCodes.Status200OK)]
|
||||
public ActionResult<DependencyStatus> GetDependencies()
|
||||
{
|
||||
return Ok(new DependencyStatus
|
||||
{
|
||||
FileTransformationAvailable = Plugin.FileTransformationAvailable,
|
||||
OverlayEnabled = Plugin.OverlayEnabled,
|
||||
FileTransformationManifestUrl = FileTransformationRegistration.ManifestUrl,
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -1,5 +1,6 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using Jellyfin.Data.Enums;
|
||||
using Jellyfin.Plugin.JRay.Models;
|
||||
@@ -18,9 +19,19 @@ namespace Jellyfin.Plugin.JRay.Controllers;
|
||||
/// Lets a remote extraction worker discover which library items still need
|
||||
/// to be processed.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// The sample is random so that repeated polling spreads work across the
|
||||
/// backlog without the server tracking who holds what, and so two workers
|
||||
/// polling concurrently mostly do not collide.
|
||||
///
|
||||
/// Prioritise/ignore rules are applied <b>here and only here</b> (JR-017):
|
||||
/// they express "don't spend compute on this", not "pretend this does not
|
||||
/// exist", so they never reach the read endpoints or the overlay.
|
||||
/// </remarks>
|
||||
[ApiController]
|
||||
[Route("Plugins/JRay/Tasks")]
|
||||
[Authorize(Roles = "Administrator")]
|
||||
// TRACES: JR-015, JR-017 | PR-003
|
||||
public class TasksController : ControllerBase
|
||||
{
|
||||
private const int DefaultLimit = 10;
|
||||
@@ -66,7 +77,7 @@ public class TasksController : ControllerBase
|
||||
// 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))
|
||||
.Where(item => MediaFileExists(item) && !_truthDataService.HasTruth(item.Id, item.Path))
|
||||
.Select(item => new
|
||||
{
|
||||
Item = item,
|
||||
@@ -96,4 +107,35 @@ public class TasksController : ControllerBase
|
||||
{
|
||||
return item is Episode episode ? episode.SeriesId : Guid.Empty;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Determines whether an item's backing media still exists on disk.
|
||||
/// <para>
|
||||
/// A library item can outlive its file: deleting media from disk does not
|
||||
/// always purge the Jellyfin database entry, and such ghosts keep
|
||||
/// <c>IsVirtualItem == false</c>, so filtering on that flag alone is not
|
||||
/// enough. Without this check the pending endpoint hands stale paths/URLs to
|
||||
/// extraction workers, and — because a missing file can never gain truth
|
||||
/// data — those items stay pending forever.
|
||||
/// </para>
|
||||
/// Only local (file-protocol) items are stat-checked; remote/streamed items
|
||||
/// are assumed present so we never stat something off-box.
|
||||
/// </summary>
|
||||
/// <param name="item">The library item.</param>
|
||||
/// <returns><c>true</c> if the item has usable backing media; otherwise <c>false</c>.</returns>
|
||||
internal static bool MediaFileExists(BaseItem item)
|
||||
{
|
||||
if (string.IsNullOrEmpty(item.Path))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!item.IsFileProtocol)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
// Path may point at a file or, for folder-based media, a directory.
|
||||
return System.IO.File.Exists(item.Path) || Directory.Exists(item.Path);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -12,11 +12,18 @@ namespace Jellyfin.Plugin.JRay.Controllers;
|
||||
/// <summary>
|
||||
/// Accepts scene-actor-extraction "truth" data pushed directly by a remote
|
||||
/// extraction worker, for servers that cannot run the extraction pipeline
|
||||
/// locally. See SPEC.md.
|
||||
/// locally. See SPEC.md §2.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// The <c>schema_version</c> check here refuses an unrecognised version rather
|
||||
/// than guessing at its shape. It is currently the only source that checks —
|
||||
/// sidecar reads do not — which JR-003 requires be fixed by moving the check
|
||||
/// into the shared read path.
|
||||
/// </remarks>
|
||||
[ApiController]
|
||||
[Route("Plugins/JRay/Items/{itemId}/Truth")]
|
||||
[Authorize(Roles = "Administrator")]
|
||||
// TRACES: JR-003, JR-009, JR-014 | SR-003
|
||||
public class TruthController : ControllerBase
|
||||
{
|
||||
private const int SupportedSchemaVersion = 1;
|
||||
@@ -52,7 +59,8 @@ public class TruthController : ControllerBase
|
||||
return BadRequest($"Unsupported schema_version {truth.SchemaVersion}; expected {SupportedSchemaVersion}.");
|
||||
}
|
||||
|
||||
await _managedTruthStore.SaveAsync(itemId, truth, cancellationToken).ConfigureAwait(false);
|
||||
var provenance = TruthProvenance.Local(TruthSource.Pushed, DateTime.UtcNow);
|
||||
await _managedTruthStore.SaveAsync(itemId, truth, provenance, cancellationToken).ConfigureAwait(false);
|
||||
_truthDataService.Invalidate(itemId);
|
||||
|
||||
return NoContent();
|
||||
|
||||
@@ -11,9 +11,14 @@ namespace Jellyfin.Plugin.JRay.Controllers;
|
||||
/// Serves static client-side assets for JRay, e.g. the pause-overlay script
|
||||
/// injected into the web client.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Anonymous by necessity, not by oversight: the script tag is injected into
|
||||
/// <c>index.html</c>, which is served before a user has logged in.
|
||||
/// </remarks>
|
||||
[ApiController]
|
||||
[Route("Plugins/JRay")]
|
||||
[AllowAnonymous]
|
||||
// TRACES: JR-014, JR-020 | PR-001
|
||||
public class WebController : ControllerBase
|
||||
{
|
||||
private const string OverlayScriptResource = "Jellyfin.Plugin.JRay.Web.jray-overlay.js";
|
||||
|
||||
@@ -25,6 +25,15 @@
|
||||
<PackageReference Include="SmartAnalyzers.MultithreadingAnalyzer" Version="1.1.31" PrivateAssets="All" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<!-- Lets the test project reach internals such as
|
||||
WebClientPatchService.RemoveInjection, which is factored out precisely
|
||||
so the removal logic is testable without touching a filesystem. -->
|
||||
<AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleToAttribute">
|
||||
<_Parameter1>Jellyfin.Plugin.JRay.Tests</_Parameter1>
|
||||
</AssemblyAttribute>
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<None Remove="Configuration\configPage.html" />
|
||||
<EmbeddedResource Include="Configuration\configPage.html" />
|
||||
|
||||
+10
-2
@@ -3,9 +3,17 @@ using System.Text.Json.Serialization;
|
||||
namespace Jellyfin.Plugin.JRay.Models;
|
||||
|
||||
/// <summary>
|
||||
/// An actor visible on screen at a queried timestamp.
|
||||
/// An actor present in the scene at a queried timestamp.
|
||||
/// </summary>
|
||||
public class ActorAtTime
|
||||
/// <remarks>
|
||||
/// "Present in the scene", not "visible on screen". The truth file makes a claim
|
||||
/// about scene membership, so an actor who has turned away or is off-camera
|
||||
/// during a reverse shot is still present. The type was named
|
||||
/// <c>ActorAtTime</c>, which invited exactly the instantaneous reading SR-002
|
||||
/// forbids.
|
||||
/// </remarks>
|
||||
// TRACES: JR-005 | SR-002
|
||||
public class ActorInScene
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets the actor's display name.
|
||||
@@ -0,0 +1,37 @@
|
||||
using System.Text.Json.Serialization;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Models;
|
||||
|
||||
/// <summary>
|
||||
/// Whether JRay's one hard dependency is satisfied, and what to do if it is not.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Jellyfin has no plugin dependency mechanism — a manifest cannot declare that
|
||||
/// another plugin is required, and nothing will install one. The gap is closed by
|
||||
/// telling the admin, on the page where they can act on it. A warning that exists
|
||||
/// only in the server log is one nobody reads.
|
||||
/// </remarks>
|
||||
public class DependencyStatus
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets a value indicating whether the File Transformation plugin was
|
||||
/// found and JRay's overlay transformation registered with it.
|
||||
/// </summary>
|
||||
[JsonPropertyName("file_transformation_available")]
|
||||
public bool FileTransformationAvailable { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets a value indicating whether the overlay is switched on in
|
||||
/// configuration. It is served only when this <i>and</i>
|
||||
/// <see cref="FileTransformationAvailable"/> hold.
|
||||
/// </summary>
|
||||
[JsonPropertyName("overlay_enabled")]
|
||||
public bool OverlayEnabled { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the repository manifest URL an admin adds to install the
|
||||
/// missing dependency.
|
||||
/// </summary>
|
||||
[JsonPropertyName("file_transformation_manifest_url")]
|
||||
public string FileTransformationManifestUrl { get; set; } = string.Empty;
|
||||
}
|
||||
@@ -11,8 +11,8 @@ namespace Jellyfin.Plugin.JRay.Models;
|
||||
public class JRayContext
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the list of actors visible on screen at the queried timestamp.
|
||||
/// Gets the list of actors visible in the scene at the queried timestamp.
|
||||
/// </summary>
|
||||
[JsonPropertyName("actors")]
|
||||
public Collection<ActorAtTime> Actors { get; } = new();
|
||||
public Collection<ActorInScene> Actors { get; } = new();
|
||||
}
|
||||
|
||||
@@ -0,0 +1,44 @@
|
||||
using System.Collections.ObjectModel;
|
||||
using System.Text.Json.Serialization;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Models;
|
||||
|
||||
/// <summary>
|
||||
/// One shareable actor timeline for one cut of one title, as the public server
|
||||
/// serves it. See the server specification §2.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This is the <b>exchange envelope</b>, versioned by <c>jmanifest_version</c>
|
||||
/// and deliberately separate from the truth file's <c>schema_version</c>: a
|
||||
/// change to how manifests are transported need not force a truth-file bump.
|
||||
/// They currently coincide at 2 only because the SR-003 bump touched both.
|
||||
/// <para>
|
||||
/// A manifest is never trusted merely because a server served it (JR-027). Every
|
||||
/// field below is re-validated on receipt against the same rules the server
|
||||
/// applies on upload.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
// TRACES: JR-025, JR-027 | SR-003
|
||||
public class Jmanifest
|
||||
{
|
||||
/// <summary>Gets or sets the exchange envelope version this manifest speaks.</summary>
|
||||
[JsonPropertyName("jmanifest_version")]
|
||||
public int JmanifestVersion { get; set; }
|
||||
|
||||
/// <summary>Gets or sets what the work is — TMDB/IMDB ids and episode coordinates.</summary>
|
||||
[JsonPropertyName("identity")]
|
||||
public JmanifestIdentity? Identity { get; set; }
|
||||
|
||||
/// <summary>Gets or sets which encode the timings apply to.</summary>
|
||||
[JsonPropertyName("cut")]
|
||||
public JmanifestCut? Cut { get; set; }
|
||||
|
||||
/// <summary>Gets or sets extraction provenance.</summary>
|
||||
[JsonPropertyName("extraction")]
|
||||
public JmanifestExtraction? Extraction { get; set; }
|
||||
|
||||
/// <summary>Gets the actors and their presence windows.</summary>
|
||||
[JsonPropertyName("actors")]
|
||||
[JsonObjectCreationHandling(JsonObjectCreationHandling.Populate)]
|
||||
public Collection<JmanifestActor> Actors { get; } = new();
|
||||
}
|
||||
@@ -0,0 +1,29 @@
|
||||
using System.Collections.ObjectModel;
|
||||
using System.Text.Json.Serialization;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Models;
|
||||
|
||||
/// <summary>One actor's timeline within a manifest.</summary>
|
||||
public class JmanifestActor
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets the display name. Server-authoritative on download: the
|
||||
/// server resolves each actor to a TMDB person and serves names from its own
|
||||
/// table, so a name a contributor invented never round-trips.
|
||||
/// </summary>
|
||||
[JsonPropertyName("name")]
|
||||
public string? Name { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the IMDB person id.</summary>
|
||||
[JsonPropertyName("imdb_id")]
|
||||
public string? ImdbId { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the TMDB person id — the primary join key.</summary>
|
||||
[JsonPropertyName("tmdb_id")]
|
||||
public string? TmdbId { get; set; }
|
||||
|
||||
/// <summary>Gets the presence windows.</summary>
|
||||
[JsonPropertyName("scenes")]
|
||||
[JsonObjectCreationHandling(JsonObjectCreationHandling.Populate)]
|
||||
public Collection<JmanifestScene> Scenes { get; } = new();
|
||||
}
|
||||
@@ -0,0 +1,32 @@
|
||||
using System.Collections.ObjectModel;
|
||||
using System.Text.Json.Serialization;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Models;
|
||||
|
||||
/// <summary>Cut fingerprint (server spec §2, §3).</summary>
|
||||
public class JmanifestCut
|
||||
{
|
||||
/// <summary>Gets or sets the decoded duration the timings came from.</summary>
|
||||
[JsonPropertyName("runtime_sec")]
|
||||
public double RuntimeSec { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the container duration, if it differs.</summary>
|
||||
[JsonPropertyName("container_duration_sec")]
|
||||
public double? ContainerDurationSec { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the OpenSubtitles file hash, as a server may report it.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Read-only in practice: the plugin never <em>sends</em> one. The file-hash
|
||||
/// match tier is withdrawn on legal grounds — see
|
||||
/// <see cref="Configuration.MatchTier"/> — because a file hash identifies the
|
||||
/// exact release a user holds rather than the cut the timings describe.
|
||||
/// </remarks>
|
||||
[JsonPropertyName("video_hash")]
|
||||
public string? VideoHash { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the version-prefixed spectral-peak signature.</summary>
|
||||
[JsonPropertyName("audio_signature")]
|
||||
public string? AudioSignature { get; set; }
|
||||
}
|
||||
@@ -0,0 +1,31 @@
|
||||
using System.Collections.ObjectModel;
|
||||
using System.Text.Json.Serialization;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Models;
|
||||
|
||||
/// <summary>Extraction provenance (server spec §2).</summary>
|
||||
public class JmanifestExtraction
|
||||
{
|
||||
/// <summary>Gets or sets the sampling rate used during extraction.</summary>
|
||||
[JsonPropertyName("sample_fps")]
|
||||
public double? SampleFps { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the re-acquisition timeout that shapes window extent.
|
||||
/// Successor to the withdrawn <c>anneal_sec</c>.
|
||||
/// </summary>
|
||||
[JsonPropertyName("extinction_sec")]
|
||||
public double? ExtinctionSec { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the producing pipeline's version string.</summary>
|
||||
[JsonPropertyName("pipeline_version")]
|
||||
public string? PipelineVersion { get; set; }
|
||||
|
||||
/// <summary>Gets or sets how many references the gallery held.</summary>
|
||||
[JsonPropertyName("gallery_size")]
|
||||
public int? GallerySize { get; set; }
|
||||
|
||||
/// <summary>Gets or sets <c>global</c> or <c>limited</c>.</summary>
|
||||
[JsonPropertyName("gallery_scope")]
|
||||
public string? GalleryScope { get; set; }
|
||||
}
|
||||
@@ -0,0 +1,44 @@
|
||||
using System.Collections.ObjectModel;
|
||||
using System.Text.Json.Serialization;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Models;
|
||||
|
||||
/// <summary>Title identity (server spec §2).</summary>
|
||||
public class JmanifestIdentity
|
||||
{
|
||||
/// <summary>Gets or sets <c>movie</c> or <c>episode</c>.</summary>
|
||||
[JsonPropertyName("type")]
|
||||
public string Type { get; set; } = string.Empty;
|
||||
|
||||
/// <summary>Gets or sets the TMDB id, for a movie.</summary>
|
||||
[JsonPropertyName("tmdb_id")]
|
||||
public string? TmdbId { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the IMDB id, for a movie.</summary>
|
||||
[JsonPropertyName("imdb_id")]
|
||||
public string? ImdbId { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the series TMDB id, for an episode.</summary>
|
||||
[JsonPropertyName("series_tmdb_id")]
|
||||
public string? SeriesTmdbId { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the series IMDB id, for an episode.</summary>
|
||||
[JsonPropertyName("series_imdb_id")]
|
||||
public string? SeriesImdbId { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the season number, for an episode.</summary>
|
||||
[JsonPropertyName("season")]
|
||||
public int? Season { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the episode number, for an episode.</summary>
|
||||
[JsonPropertyName("episode")]
|
||||
public int? Episode { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the display title.</summary>
|
||||
[JsonPropertyName("title")]
|
||||
public string? Title { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the release year.</summary>
|
||||
[JsonPropertyName("year")]
|
||||
public int? Year { get; set; }
|
||||
}
|
||||
@@ -0,0 +1,38 @@
|
||||
using System.Collections.ObjectModel;
|
||||
using System.Text.Json.Serialization;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Models;
|
||||
|
||||
/// <summary>
|
||||
/// One presence window.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <b>A window is a claim about scene membership, not a recognition event</b>
|
||||
/// (SR-002). An actor who turns away, is occluded, or is off-camera while the
|
||||
/// shot cuts to whoever they are speaking to is still present — so a consumer
|
||||
/// must never read a window boundary as "the face was detected here", and must
|
||||
/// not merge, split or trim windows.
|
||||
/// </remarks>
|
||||
public class JmanifestScene
|
||||
{
|
||||
/// <summary>Gets or sets the window start, in seconds.</summary>
|
||||
[JsonPropertyName("start")]
|
||||
public double Start { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the window end, in seconds, inclusive.</summary>
|
||||
[JsonPropertyName("end")]
|
||||
public double End { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the accumulated posterior that justified this claim, in [0, 1].
|
||||
/// </summary>
|
||||
[JsonPropertyName("belief")]
|
||||
public double? Belief { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets how the actor was identified: <c>live</c>, <c>deferred</c>
|
||||
/// or <c>pooled</c>.
|
||||
/// </summary>
|
||||
[JsonPropertyName("route")]
|
||||
public string? Route { get; set; }
|
||||
}
|
||||
@@ -0,0 +1,31 @@
|
||||
using System.Collections.ObjectModel;
|
||||
using System.Text.Json.Serialization;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Models;
|
||||
|
||||
/// <summary>The server's reply to a manifest fetch (server spec §4).</summary>
|
||||
public class ManifestFetchResponse
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets the cut-match tier that was achieved: <c>exact</c>,
|
||||
/// <c>audio</c>, <c>runtime</c> or <c>loose</c>.
|
||||
/// </summary>
|
||||
[JsonPropertyName("match")]
|
||||
public string Match { get; set; } = string.Empty;
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the offset, in seconds, the client must add to every window.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Non-zero only for an <c>audio</c>-tier match, where the same cut was
|
||||
/// found at a different trim. <b>The server returns the offset; the client
|
||||
/// applies it</b> — manifests are never rewritten, so one stored manifest
|
||||
/// serves every trim of the same cut.
|
||||
/// </remarks>
|
||||
[JsonPropertyName("offset_sec")]
|
||||
public double OffsetSec { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the manifest itself.</summary>
|
||||
[JsonPropertyName("manifest")]
|
||||
public Jmanifest? Manifest { get; set; }
|
||||
}
|
||||
@@ -0,0 +1,30 @@
|
||||
namespace Jellyfin.Plugin.JRay.Models;
|
||||
|
||||
/// <summary>
|
||||
/// What a fetch stored, and from where.
|
||||
/// </summary>
|
||||
public class ManifestFetchResult
|
||||
{
|
||||
/// <summary>Gets or sets the server that supplied the manifest.</summary>
|
||||
public string ServerUrl { get; set; } = string.Empty;
|
||||
|
||||
/// <summary>Gets or sets the cut-match tier achieved.</summary>
|
||||
public string Match { get; set; } = string.Empty;
|
||||
|
||||
/// <summary>Gets or sets the offset applied to every window, in seconds.</summary>
|
||||
public double OffsetSec { get; set; }
|
||||
|
||||
/// <summary>Gets or sets how many actors the stored truth file holds.</summary>
|
||||
public int ActorCount { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets a caveat to surface in the UI, or null when the match needs
|
||||
/// no explanation.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// A <c>loose</c> match must surface as a caveat rather than being applied
|
||||
/// silently — the runtimes differ by up to 30 seconds, which is usually a
|
||||
/// different trim of the same cut but is not guaranteed to be.
|
||||
/// </remarks>
|
||||
public string? Caveat { get; set; }
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
using System.Collections.ObjectModel;
|
||||
using System.Text.Json.Serialization;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Models;
|
||||
|
||||
/// <summary>A series bundle (server spec §2).</summary>
|
||||
public class SeriesBundle
|
||||
{
|
||||
/// <summary>Gets or sets the envelope version.</summary>
|
||||
[JsonPropertyName("jmanifest_version")]
|
||||
public int JmanifestVersion { get; set; }
|
||||
|
||||
/// <summary>Gets the episode manifests the server holds.</summary>
|
||||
[JsonPropertyName("episodes")]
|
||||
[JsonObjectCreationHandling(JsonObjectCreationHandling.Populate)]
|
||||
public Collection<Jmanifest> Episodes { get; } = new();
|
||||
}
|
||||
@@ -0,0 +1,23 @@
|
||||
using System.Collections.ObjectModel;
|
||||
using System.Text.Json.Serialization;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Models;
|
||||
|
||||
/// <summary>What a server says it supports (server spec §9a).</summary>
|
||||
public class ServerCapabilities
|
||||
{
|
||||
/// <summary>Gets or sets the server's own identity.</summary>
|
||||
[JsonPropertyName("server_id")]
|
||||
public string? ServerId { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the exchange envelope versions the server accepts.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Checked once rather than discovered as a rejection per manifest across a
|
||||
/// whole library sweep.
|
||||
/// </remarks>
|
||||
[JsonPropertyName("jmanifest_versions")]
|
||||
[JsonObjectCreationHandling(JsonObjectCreationHandling.Populate)]
|
||||
public Collection<int> JmanifestVersions { get; } = new();
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
namespace Jellyfin.Plugin.JRay.Models;
|
||||
|
||||
/// <summary>
|
||||
/// The object handed to JRay's transformation callback by the File
|
||||
/// Transformation plugin.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// That plugin builds a Newtonsoft <c>JObject</c> with a single <c>contents</c>
|
||||
/// key and calls <c>JObject.ToObject(parameterType)</c> against this type.
|
||||
/// Newtonsoft binds member names case-insensitively, so <see cref="Contents"/>
|
||||
/// binds to <c>contents</c> without an attribute — and a System.Text.Json
|
||||
/// attribute would have no effect here.
|
||||
/// </remarks>
|
||||
public class TransformationPayload
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets the current contents of the file being served, including
|
||||
/// any transformations applied by other plugins ahead of JRay in the
|
||||
/// chain.
|
||||
/// </summary>
|
||||
public string? Contents { get; set; }
|
||||
}
|
||||
@@ -5,8 +5,19 @@ namespace Jellyfin.Plugin.JRay.Models;
|
||||
|
||||
/// <summary>
|
||||
/// One actor entry in a <see cref="TruthFile"/>, with the time windows during
|
||||
/// which they are visible on screen.
|
||||
/// which they are present in the scene.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// "Present in the scene", not "visible on screen": a window is a claim about
|
||||
/// scene membership, so an actor who turns away or is off-camera during a
|
||||
/// reverse shot is still present. Two windows mean a genuine departure and
|
||||
/// return, not a break in detection.
|
||||
///
|
||||
/// Identity is public identifiers — never a name alone, which is ambiguous and
|
||||
/// unstable. <c>jellyfin_id</c> is preferred locally and stripped on
|
||||
/// contribution, being meaningless outside the instance that produced it.
|
||||
/// </remarks>
|
||||
// TRACES: JR-004, JR-007 | SR-001, SR-002
|
||||
public class TruthActor
|
||||
{
|
||||
/// <summary>
|
||||
@@ -34,7 +45,7 @@ public class TruthActor
|
||||
public string JellyfinId { get; set; } = string.Empty;
|
||||
|
||||
/// <summary>
|
||||
/// Gets the list of [start_sec, end_sec] windows during which the actor is on screen.
|
||||
/// Gets the list of [start_sec, end_sec] windows during which the actor is in the scene.
|
||||
/// </summary>
|
||||
[JsonPropertyName("scenes")]
|
||||
[JsonObjectCreationHandling(JsonObjectCreationHandling.Populate)]
|
||||
|
||||
@@ -5,8 +5,19 @@ namespace Jellyfin.Plugin.JRay.Models;
|
||||
|
||||
/// <summary>
|
||||
/// Root object of a scene-actor-extraction "truth" file
|
||||
/// (schema_version 1, minimal verbosity). See SPEC.md.
|
||||
/// (schema_version 1, minimal verbosity). See SPEC.md §1.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// JRay <b>owns</b> this format; the extraction pipeline is its producer and the
|
||||
/// public server carries a derived envelope. Because three repos ship
|
||||
/// independently, breaking changes are batched into one coordinated
|
||||
/// <c>schema_version</c> bump rather than made piecemeal.
|
||||
///
|
||||
/// This type is still the v1 shape. JR-002 replaces it: <c>anneal_sec</c> out,
|
||||
/// an <c>extraction</c> provenance block and a <c>cut</c> block in, and
|
||||
/// <c>scenes</c> becoming objects that carry belief and identification route.
|
||||
/// </remarks>
|
||||
// TRACES: JR-001, JR-002 | SR-003
|
||||
public class TruthFile
|
||||
{
|
||||
/// <summary>
|
||||
@@ -34,7 +45,7 @@ public class TruthFile
|
||||
public double AnnealSec { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the list of actors detected in the film, each with their on-screen scene windows.
|
||||
/// Gets the list of actors in the film, each with their scene-presence windows.
|
||||
/// </summary>
|
||||
[JsonPropertyName("actors")]
|
||||
[JsonObjectCreationHandling(JsonObjectCreationHandling.Populate)]
|
||||
|
||||
@@ -0,0 +1,98 @@
|
||||
using System;
|
||||
using System.Text.Json.Serialization;
|
||||
using Jellyfin.Plugin.JRay.Configuration;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Models;
|
||||
|
||||
/// <summary>
|
||||
/// Where an item's truth data came from.
|
||||
/// </summary>
|
||||
public enum TruthSource
|
||||
{
|
||||
/// <summary>A <c>.jray.json</c> file beside the media, written locally.</summary>
|
||||
Sidecar = 0,
|
||||
|
||||
/// <summary>Pushed over HTTP by a worker that cannot write beside the media.</summary>
|
||||
Pushed = 1,
|
||||
|
||||
/// <summary>Fetched from a manifest server and converted to a truth file.</summary>
|
||||
Fetched = 2,
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// How an item's truth data was obtained, recorded alongside it.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// The three sources are not interchangeable. A locally computed sidecar and a
|
||||
/// <c>loose</c>-tier manifest from a third-party server make claims of very
|
||||
/// different strength about the same item, and once stored they are otherwise
|
||||
/// indistinguishable — the truth file itself records nothing about how it
|
||||
/// arrived.
|
||||
///
|
||||
/// <para>
|
||||
/// This is stored <b>beside</b> the truth file rather than inside it. Injecting
|
||||
/// fields would mean the bytes served back are not the bytes the producer wrote,
|
||||
/// which is the property JR-004 turns on.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
// TRACES: JR-010, JR-036 | PR-001
|
||||
public class TruthProvenance
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets which of the three routes delivered this truth data.
|
||||
/// </summary>
|
||||
[JsonPropertyName("source")]
|
||||
public TruthSource Source { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the server a fetched manifest came from. Empty for the
|
||||
/// local sources, whose origin is this instance.
|
||||
/// </summary>
|
||||
[JsonPropertyName("server_url")]
|
||||
public string ServerUrl { get; set; } = string.Empty;
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the cut-match tier a fetched manifest reached.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Null for local sources: a sidecar or a push is about *this* file, so
|
||||
/// there is no cut to match. The tier is what makes a fetched claim
|
||||
/// interpretable — <c>loose</c> means "probably the same cut", which the UI
|
||||
/// must surface rather than apply silently (JR-036).
|
||||
/// </remarks>
|
||||
[JsonPropertyName("match_tier")]
|
||||
public MatchTier? MatchTier { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the offset, in seconds, applied to every window before
|
||||
/// storage so the stored timings are in this file's own timebase (JR-030).
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Recorded because it is otherwise unrecoverable: once applied, the stored
|
||||
/// windows look native, and nothing would say they had been shifted.
|
||||
/// </remarks>
|
||||
[JsonPropertyName("offset_sec")]
|
||||
public double OffsetSec { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets a human-readable caveat to surface with the overlay, or
|
||||
/// null when the claim needs none.
|
||||
/// </summary>
|
||||
[JsonPropertyName("caveat")]
|
||||
public string? Caveat { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets when this truth data was recorded, UTC.
|
||||
/// </summary>
|
||||
[JsonPropertyName("recorded_at")]
|
||||
public DateTime RecordedAt { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Creates provenance for truth data produced on this instance.
|
||||
/// </summary>
|
||||
/// <param name="source">Either <see cref="TruthSource.Sidecar"/> or <see cref="TruthSource.Pushed"/>.</param>
|
||||
/// <param name="recordedAt">When it was recorded, UTC.</param>
|
||||
/// <returns>The provenance record.</returns>
|
||||
public static TruthProvenance Local(TruthSource source, DateTime recordedAt)
|
||||
=> new() { Source = source, RecordedAt = recordedAt };
|
||||
}
|
||||
@@ -17,6 +17,7 @@ namespace Jellyfin.Plugin.JRay;
|
||||
public class Plugin : BasePlugin<PluginConfiguration>, IHasWebPages
|
||||
{
|
||||
private readonly ILogger<Plugin> _logger;
|
||||
private readonly bool _usingFileTransformation;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="Plugin"/> class.
|
||||
@@ -30,8 +31,25 @@ public class Plugin : BasePlugin<PluginConfiguration>, IHasWebPages
|
||||
Instance = this;
|
||||
_logger = logger;
|
||||
|
||||
WebClientPatchService.Apply(ApplicationPaths, Configuration.EnableOverlay, _logger);
|
||||
ConfigurationChanged += (_, _) => WebClientPatchService.Apply(ApplicationPaths, Configuration.EnableOverlay, _logger);
|
||||
// The File Transformation plugin rewrites index.html as it is served.
|
||||
// Registration is unconditional: the transformation itself checks
|
||||
// EnableOverlay at request time, so toggling the setting takes effect
|
||||
// without re-registering.
|
||||
_usingFileTransformation = FileTransformationRegistration.TryRegister(_logger);
|
||||
|
||||
if (!_usingFileTransformation)
|
||||
{
|
||||
_logger.LogWarning(
|
||||
"JRay: the pause overlay is disabled because the File Transformation plugin " +
|
||||
"is not available. Install it from " +
|
||||
"https://github.com/IAmParadox27/jellyfin-plugin-file-transformation. " +
|
||||
"All other JRay features are unaffected.");
|
||||
}
|
||||
|
||||
// JRay never injects into index.html. This only ever *removes* a patch
|
||||
// left by an earlier version of JRay, identified by its own marker —
|
||||
// see SPEC.md JR-021/JR-022.
|
||||
WebClientPatchService.RemoveLegacyPatch(ApplicationPaths, _logger);
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
@@ -45,6 +63,20 @@ public class Plugin : BasePlugin<PluginConfiguration>, IHasWebPages
|
||||
/// </summary>
|
||||
public static Plugin? Instance { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets a value indicating whether the pause overlay should currently be
|
||||
/// served. Read by the File Transformation callback at request time, so
|
||||
/// toggling the setting takes effect without re-registering.
|
||||
/// </summary>
|
||||
internal static bool OverlayEnabled => Instance?.Configuration.EnableOverlay ?? false;
|
||||
|
||||
/// <summary>
|
||||
/// Gets a value indicating whether the File Transformation plugin was found
|
||||
/// at startup. When it was not, the overlay is disabled and every other JRay
|
||||
/// feature continues to work.
|
||||
/// </summary>
|
||||
internal static bool FileTransformationAvailable => Instance?._usingFileTransformation ?? false;
|
||||
|
||||
/// <inheritdoc />
|
||||
public IEnumerable<PluginPageInfo> GetPages()
|
||||
{
|
||||
|
||||
@@ -17,5 +17,10 @@ public class ServiceRegistrator : IPluginServiceRegistrator
|
||||
serviceCollection.AddSingleton<IManagedTruthStore, ManagedTruthStore>();
|
||||
serviceCollection.AddSingleton<ITruthDataService, TruthDataService>();
|
||||
serviceCollection.AddSingleton<IMediaPolicyStore, MediaPolicyStore>();
|
||||
|
||||
// Singleton so per-server backoff state survives across requests: a
|
||||
// server that is down should be skipped for the whole sweep, not
|
||||
// retried once per item (JR-037).
|
||||
serviceCollection.AddSingleton<IManifestExchangeClient, ManifestExchangeClient>();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,175 @@
|
||||
using System;
|
||||
using System.Globalization;
|
||||
using System.Linq;
|
||||
using System.Reflection;
|
||||
using System.Runtime.Loader;
|
||||
using System.Text.Json;
|
||||
using Jellyfin.Plugin.JRay.Models;
|
||||
using Microsoft.Extensions.Logging;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Services;
|
||||
|
||||
/// <summary>
|
||||
/// Registers JRay's overlay script with the
|
||||
/// <see href="https://github.com/IAmParadox27/jellyfin-plugin-file-transformation">File Transformation</see>
|
||||
/// plugin, which rewrites <c>index.html</c> as it is served instead of
|
||||
/// modifying the file on disk. This is non-destructive and composes with
|
||||
/// other plugins that patch the same file.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// File Transformation is referenced by reflection (rather than a NuGet
|
||||
/// package reference) so JRay still loads when it isn't installed. JRay must
|
||||
/// never bundle the assembly: a bundled copy would sit in a different
|
||||
/// <c>AssemblyLoadContext</c> from the real one, which is precisely the failure
|
||||
/// the reflection integration exists to avoid.
|
||||
///
|
||||
/// This is the only route by which JRay reaches the web client. There is no
|
||||
/// on-disk fallback (JR-021), so when registration fails the overlay is simply
|
||||
/// disabled — which is why both failure paths log a warning naming the missing
|
||||
/// plugin rather than quietly degrading.
|
||||
/// </remarks>
|
||||
// TRACES: JR-020, JR-023 | PR-004
|
||||
public static class FileTransformationRegistration
|
||||
{
|
||||
/// <summary>
|
||||
/// The marker comment written alongside the injected script tag, used to
|
||||
/// keep the transformation idempotent.
|
||||
/// </summary>
|
||||
internal const string Marker = "<!-- jray-overlay -->";
|
||||
|
||||
/// <summary>
|
||||
/// Repository manifest an admin adds to install the dependency. Surfaced on
|
||||
/// the configuration page rather than only in the log, since that is where
|
||||
/// it can be acted on.
|
||||
/// </summary>
|
||||
public const string ManifestUrl = "https://www.iamparadox.dev/jellyfin/plugins/manifest.json";
|
||||
|
||||
private const string PluginInterfaceTypeName = "Jellyfin.Plugin.FileTransformation.PluginInterface";
|
||||
private const string RegisterMethodName = "RegisterTransformation";
|
||||
private const string ScriptTag = "<script defer src=\"/Plugins/JRay/ClientScript\"></script>";
|
||||
private const string BodyClose = "</body>";
|
||||
|
||||
/// <summary>
|
||||
/// Stable id for JRay's index.html transformation. File Transformation
|
||||
/// keys registrations on this, so re-registering replaces rather than
|
||||
/// duplicates.
|
||||
/// </summary>
|
||||
private static readonly Guid TransformationId = Guid.Parse("2c9b5a41-6ad0-4c1e-9f7d-1d1e6b0d5a90");
|
||||
|
||||
/// <summary>
|
||||
/// Attempts to register JRay's index.html transformation with the File
|
||||
/// Transformation plugin.
|
||||
/// </summary>
|
||||
/// <param name="logger">The logger.</param>
|
||||
/// <returns><see langword="true"/> if the transformation was registered;
|
||||
/// <see langword="false"/> if the File Transformation plugin is not
|
||||
/// installed or its interface could not be invoked.</returns>
|
||||
public static bool TryRegister(ILogger logger)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(logger);
|
||||
|
||||
try
|
||||
{
|
||||
var registerMethod = ResolveRegisterMethod();
|
||||
if (registerMethod is null)
|
||||
{
|
||||
logger.LogWarning(
|
||||
"JRay: the File Transformation plugin was not found, so the pause overlay is "
|
||||
+ "disabled. JRay does not modify index.html on disk and has no fallback. "
|
||||
+ "Install it from {ManifestUrl} to enable the overlay; every other JRay "
|
||||
+ "feature is unaffected.",
|
||||
ManifestUrl);
|
||||
return false;
|
||||
}
|
||||
|
||||
var payload = BuildPayload(registerMethod);
|
||||
registerMethod.Invoke(null, [payload]);
|
||||
|
||||
logger.LogInformation("JRay: registered index.html transformation with the File Transformation plugin.");
|
||||
return true;
|
||||
}
|
||||
catch (Exception ex) when (ex is TargetInvocationException or InvalidOperationException or JsonException or MissingMethodException)
|
||||
{
|
||||
logger.LogWarning(
|
||||
ex,
|
||||
"JRay: the File Transformation plugin is present but registration failed, so the "
|
||||
+ "pause overlay is disabled. JRay does not modify index.html on disk and has no "
|
||||
+ "fallback. Every other JRay feature is unaffected.");
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The transformation callback invoked by the File Transformation plugin.
|
||||
/// It is resolved by name via reflection, so the signature (public,
|
||||
/// static, single payload parameter, returns <see cref="string"/>) must
|
||||
/// not change.
|
||||
/// </summary>
|
||||
/// <param name="payload">The current state of the file being served.</param>
|
||||
/// <returns>The transformed file contents.</returns>
|
||||
public static string TransformIndexHtml(TransformationPayload payload)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(payload);
|
||||
|
||||
var contents = payload.Contents ?? string.Empty;
|
||||
if (!Plugin.OverlayEnabled || contents.Contains(Marker, StringComparison.Ordinal))
|
||||
{
|
||||
return contents;
|
||||
}
|
||||
|
||||
var index = contents.LastIndexOf(BodyClose, StringComparison.OrdinalIgnoreCase);
|
||||
if (index < 0)
|
||||
{
|
||||
return contents;
|
||||
}
|
||||
|
||||
return contents[..index]
|
||||
+ ScriptTag
|
||||
+ Marker
|
||||
+ "\n"
|
||||
+ contents[index..];
|
||||
}
|
||||
|
||||
private static MethodInfo? ResolveRegisterMethod()
|
||||
{
|
||||
var assembly = AssemblyLoadContext.All
|
||||
.SelectMany(context => context.Assemblies)
|
||||
.FirstOrDefault(candidate => candidate.FullName?.Contains(".FileTransformation", StringComparison.Ordinal) ?? false);
|
||||
|
||||
return assembly?
|
||||
.GetType(PluginInterfaceTypeName)?
|
||||
.GetMethod(RegisterMethodName, BindingFlags.Public | BindingFlags.Static);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Builds the registration payload. File Transformation expects a
|
||||
/// Newtonsoft <c>JObject</c>, which JRay does not reference, so the
|
||||
/// payload is serialized to JSON and parsed back through the type the
|
||||
/// target method actually declares.
|
||||
/// </summary>
|
||||
private static object BuildPayload(MethodInfo registerMethod)
|
||||
{
|
||||
// File Transformation matches this against Assembly.FullName exactly,
|
||||
// so it must be the full display name, not the short name.
|
||||
var assemblyName = typeof(FileTransformationRegistration).Assembly.FullName
|
||||
?? throw new InvalidOperationException("JRay assembly has no name.");
|
||||
|
||||
var json = JsonSerializer.Serialize(new
|
||||
{
|
||||
id = TransformationId.ToString("D", CultureInfo.InvariantCulture),
|
||||
fileNamePattern = "index.html",
|
||||
callbackAssembly = assemblyName,
|
||||
callbackClass = typeof(FileTransformationRegistration).FullName,
|
||||
callbackMethod = nameof(TransformIndexHtml)
|
||||
});
|
||||
|
||||
var payloadType = registerMethod.GetParameters().FirstOrDefault()?.ParameterType
|
||||
?? throw new InvalidOperationException("RegisterTransformation has no parameters.");
|
||||
|
||||
var parseMethod = payloadType.GetMethod("Parse", BindingFlags.Public | BindingFlags.Static, [typeof(string)])
|
||||
?? throw new InvalidOperationException($"Cannot construct File Transformation payload of type '{payloadType.FullName}'.");
|
||||
|
||||
return parseMethod.Invoke(null, [json])
|
||||
?? throw new InvalidOperationException("File Transformation payload parsed to null.");
|
||||
}
|
||||
}
|
||||
@@ -25,9 +25,21 @@ public interface IManagedTruthStore
|
||||
/// </summary>
|
||||
/// <param name="itemId">The Jellyfin library item id.</param>
|
||||
/// <param name="truth">The truth file contents to persist.</param>
|
||||
/// <param name="provenance">How this truth data was obtained.</param>
|
||||
/// <param name="cancellationToken">Cancellation token.</param>
|
||||
/// <returns>A task that completes when the file has been written.</returns>
|
||||
Task SaveAsync(Guid itemId, TruthFile truth, CancellationToken cancellationToken);
|
||||
/// <remarks>
|
||||
/// Provenance is written beside the truth file, never into it: the bytes
|
||||
/// served back must be the bytes the producer wrote (JR-004).
|
||||
/// </remarks>
|
||||
Task SaveAsync(Guid itemId, TruthFile truth, TruthProvenance provenance, CancellationToken cancellationToken);
|
||||
|
||||
/// <summary>
|
||||
/// Loads the provenance recorded alongside an item's managed truth data.
|
||||
/// </summary>
|
||||
/// <param name="itemId">The Jellyfin library item id.</param>
|
||||
/// <returns>The provenance, or null if this item has no managed truth data.</returns>
|
||||
TruthProvenance? LoadProvenance(Guid itemId);
|
||||
|
||||
/// <summary>
|
||||
/// Deletes the managed truth file for the given item, if one exists.
|
||||
|
||||
@@ -0,0 +1,53 @@
|
||||
using System.Collections.Generic;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using Jellyfin.Plugin.JRay.Configuration;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Services.Interfaces;
|
||||
|
||||
/// <summary>
|
||||
/// Fetches actor-timeline manifests from the configured public servers.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Satisfies <c>JRay-public-server</c> UR-007: the plugin queries a configurable,
|
||||
/// <b>ordered</b> list of servers, and the first result clearing the configured
|
||||
/// match tier wins.
|
||||
/// </remarks>
|
||||
// TRACES: JR-025 | PR-006
|
||||
public interface IManifestExchangeClient
|
||||
{
|
||||
/// <summary>
|
||||
/// Fetches a movie manifest from the first server that has an acceptable one.
|
||||
/// </summary>
|
||||
/// <param name="servers">The configured servers, in trust order.</param>
|
||||
/// <param name="minimumTier">The lowest cut-match tier that may be stored.</param>
|
||||
/// <param name="query">Identity and cut parameters for the local item.</param>
|
||||
/// <param name="cancellationToken">Cancellation token.</param>
|
||||
/// <returns>The accepted manifest, or null when no server had one.</returns>
|
||||
Task<ManifestFetchOutcome?> FetchMovieAsync(
|
||||
IReadOnlyList<ManifestServer> servers,
|
||||
MatchTier minimumTier,
|
||||
TitleQuery query,
|
||||
CancellationToken cancellationToken);
|
||||
|
||||
/// <summary>
|
||||
/// Fetches a single episode manifest.
|
||||
/// </summary>
|
||||
/// <param name="servers">The configured servers, in trust order.</param>
|
||||
/// <param name="minimumTier">The lowest cut-match tier that may be stored.</param>
|
||||
/// <param name="query">Identity and cut parameters for the local item.</param>
|
||||
/// <param name="cancellationToken">Cancellation token.</param>
|
||||
/// <returns>The accepted manifest, or null when no server had one.</returns>
|
||||
Task<ManifestFetchOutcome?> FetchEpisodeAsync(
|
||||
IReadOnlyList<ManifestServer> servers,
|
||||
MatchTier minimumTier,
|
||||
TitleQuery query,
|
||||
CancellationToken cancellationToken);
|
||||
|
||||
/// <summary>
|
||||
/// Per-server reachability and last error, for the configuration page.
|
||||
/// </summary>
|
||||
/// <param name="servers">The configured servers.</param>
|
||||
/// <returns>One status entry per configured server.</returns>
|
||||
IReadOnlyList<ServerStatus> GetStatus(IReadOnlyList<ManifestServer> servers);
|
||||
}
|
||||
@@ -18,6 +18,17 @@ public interface ITruthDataService
|
||||
/// <returns>The parsed truth file, or null if no truth file exists for this item.</returns>
|
||||
Task<TruthFile?> GetTruthAsync(Guid itemId, CancellationToken cancellationToken);
|
||||
|
||||
/// <summary>
|
||||
/// Gets how the item's truth data was obtained, or null if it has none.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Resolves the same precedence as <see cref="GetTruthAsync"/>: managed
|
||||
/// truth (pushed or fetched) wins, and a sidecar is reported as such.
|
||||
/// </remarks>
|
||||
/// <param name="itemId">The Jellyfin library item id.</param>
|
||||
/// <returns>The provenance of the truth data that would be served.</returns>
|
||||
TruthProvenance? GetProvenance(Guid itemId);
|
||||
|
||||
/// <summary>
|
||||
/// Removes any cached truth file for the given item, so the next
|
||||
/// <see cref="GetTruthAsync"/> call re-reads from the managed store or sidecar file.
|
||||
|
||||
@@ -14,6 +14,11 @@ namespace Jellyfin.Plugin.JRay.Services;
|
||||
/// Stores truth files pushed directly to JRay (e.g. by a remote extraction
|
||||
/// worker) under the plugin's configuration directory, keyed by item id.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Deliberately outside the media library filesystem, so a worker that cannot
|
||||
/// write beside the media file is not a second-class producer.
|
||||
/// </remarks>
|
||||
// TRACES: JR-009, JR-010 | PR-004
|
||||
public sealed class ManagedTruthStore : IManagedTruthStore
|
||||
{
|
||||
private static readonly JsonSerializerOptions JsonOptions = new(JsonSerializerDefaults.Web);
|
||||
@@ -55,7 +60,7 @@ public sealed class ManagedTruthStore : IManagedTruthStore
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public async Task SaveAsync(Guid itemId, TruthFile truth, CancellationToken cancellationToken)
|
||||
public async Task SaveAsync(Guid itemId, TruthFile truth, TruthProvenance provenance, CancellationToken cancellationToken)
|
||||
{
|
||||
var path = GetPath(itemId);
|
||||
var directory = Path.GetDirectoryName(path) ?? throw new InvalidOperationException("Managed truth path has no directory.");
|
||||
@@ -68,11 +73,52 @@ public sealed class ManagedTruthStore : IManagedTruthStore
|
||||
}
|
||||
|
||||
File.Move(tempPath, path, overwrite: true);
|
||||
|
||||
// Written after the truth file, so a crash between the two leaves truth
|
||||
// with no provenance (readable, source unknown) rather than provenance
|
||||
// describing a file that is not there.
|
||||
var provenancePath = GetProvenancePath(itemId);
|
||||
var provenanceTemp = provenancePath + ".tmp";
|
||||
using (var stream = File.Create(provenanceTemp))
|
||||
{
|
||||
await JsonSerializer.SerializeAsync(stream, provenance, JsonOptions, cancellationToken).ConfigureAwait(false);
|
||||
}
|
||||
|
||||
File.Move(provenanceTemp, provenancePath, overwrite: true);
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public TruthProvenance? LoadProvenance(Guid itemId)
|
||||
{
|
||||
var path = GetProvenancePath(itemId);
|
||||
if (!File.Exists(path))
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
try
|
||||
{
|
||||
using var stream = File.OpenRead(path);
|
||||
return JsonSerializer.Deserialize<TruthProvenance>(stream, JsonOptions);
|
||||
}
|
||||
catch (Exception ex) when (ex is IOException or JsonException)
|
||||
{
|
||||
// Provenance is metadata about the claim, not the claim. Losing it
|
||||
// must never make readable truth data unreadable.
|
||||
_logger.LogWarning(ex, "JRay: failed to read truth provenance at {Path}", path);
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public bool Delete(Guid itemId)
|
||||
{
|
||||
var provenancePath = GetProvenancePath(itemId);
|
||||
if (File.Exists(provenancePath))
|
||||
{
|
||||
File.Delete(provenancePath);
|
||||
}
|
||||
|
||||
var path = GetPath(itemId);
|
||||
if (!File.Exists(path))
|
||||
{
|
||||
@@ -93,4 +139,9 @@ public sealed class ManagedTruthStore : IManagedTruthStore
|
||||
{
|
||||
return Path.Combine(_applicationPaths.PluginConfigurationsPath, "JRay", "truth", itemId.ToString("D") + ".json");
|
||||
}
|
||||
|
||||
private string GetProvenancePath(Guid itemId)
|
||||
{
|
||||
return Path.Combine(_applicationPaths.PluginConfigurationsPath, "JRay", "truth", itemId.ToString("D") + ".provenance.json");
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,100 @@
|
||||
using System;
|
||||
using System.Globalization;
|
||||
using Jellyfin.Plugin.JRay.Configuration;
|
||||
using Jellyfin.Plugin.JRay.Models;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Services;
|
||||
|
||||
/// <summary>
|
||||
/// Converts a fetched manifest into the truth file the plugin stores.
|
||||
/// </summary>
|
||||
// TRACES: JR-030 | SR-002, SR-003
|
||||
public static class ManifestConverter
|
||||
{
|
||||
/// <summary>
|
||||
/// Builds a truth file from a manifest, shifting every window by
|
||||
/// <paramref name="offsetSec"/>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <b>The offset is applied here, once, at store time.</b> The server returns
|
||||
/// it and the client applies it, so a single stored manifest serves every
|
||||
/// trim of the same cut without ever being rewritten upstream. Applying it on
|
||||
/// the way in means the stored truth is always in the local file's own
|
||||
/// timebase, so the overlay and the <c>jray?t=</c> query need no offset
|
||||
/// awareness at read time — the alternative would put the same correction in
|
||||
/// every reader, forever, and one of them would eventually forget.
|
||||
/// <para>
|
||||
/// Windows are shifted, never reshaped: a window is a claim about scene
|
||||
/// membership (SR-002), so merging or trimming would answer a different
|
||||
/// question than the one the extraction pipeline answered.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
/// <param name="manifest">The validated manifest.</param>
|
||||
/// <param name="offsetSec">Seconds to add to every window.</param>
|
||||
/// <param name="mediaPath">Local media path, recorded informationally.</param>
|
||||
/// <returns>The truth file to store.</returns>
|
||||
public static TruthFile ToTruthFile(Jmanifest manifest, double offsetSec, string mediaPath)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(manifest);
|
||||
|
||||
var truth = new TruthFile
|
||||
{
|
||||
SchemaVersion = 1,
|
||||
Movie = mediaPath ?? string.Empty,
|
||||
SampleFps = manifest.Extraction?.SampleFps ?? 0,
|
||||
};
|
||||
|
||||
foreach (var actor in manifest.Actors)
|
||||
{
|
||||
var converted = new TruthActor
|
||||
{
|
||||
Name = actor.Name ?? string.Empty,
|
||||
ImdbId = actor.ImdbId ?? string.Empty,
|
||||
TmdbId = actor.TmdbId ?? string.Empty,
|
||||
};
|
||||
|
||||
foreach (var scene in actor.Scenes)
|
||||
{
|
||||
// Clamped at zero: a negative offset on an early window would
|
||||
// otherwise produce a start before the file begins, which no
|
||||
// reader can index.
|
||||
var start = Math.Max(0, scene.Start + offsetSec);
|
||||
var end = Math.Max(start, scene.End + offsetSec);
|
||||
converted.Scenes.Add(new[] { start, end });
|
||||
}
|
||||
|
||||
truth.Actors.Add(converted);
|
||||
}
|
||||
|
||||
return truth;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// A short, human-readable description of how a manifest matched, for the
|
||||
/// UI to show as a caveat.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// A <c>loose</c> match should surface as a caveat rather than being applied
|
||||
/// silently: it means the runtimes differ by up to 30 seconds, which is
|
||||
/// usually a different trim of the same cut but is not guaranteed to be.
|
||||
/// </remarks>
|
||||
/// <param name="tier">The tier achieved.</param>
|
||||
/// <param name="offsetSec">The offset applied.</param>
|
||||
/// <returns>A caveat string, or null when the match needs no explanation.</returns>
|
||||
public static string? DescribeCaveat(MatchTier tier, double offsetSec)
|
||||
{
|
||||
if (tier == MatchTier.Loose)
|
||||
{
|
||||
return "Matched loosely — the runtime differs from this server's copy, so timings may drift.";
|
||||
}
|
||||
|
||||
if (Math.Abs(offsetSec) > 0.001)
|
||||
{
|
||||
return string.Create(
|
||||
CultureInfo.InvariantCulture,
|
||||
$"Matched by audio content and shifted by {offsetSec:0.##}s to align with this file.");
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,447 @@
|
||||
using System;
|
||||
using System.Collections.Concurrent;
|
||||
using System.Collections.Generic;
|
||||
using System.Globalization;
|
||||
using System.Linq;
|
||||
using System.Net.Http;
|
||||
using System.Text.Json;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using Jellyfin.Plugin.JRay.Configuration;
|
||||
using Jellyfin.Plugin.JRay.Models;
|
||||
using Jellyfin.Plugin.JRay.Services.Interfaces;
|
||||
using Microsoft.Extensions.Logging;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Services;
|
||||
|
||||
/// <summary>
|
||||
/// Fetches actor-timeline manifests from the configured servers.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Servers are an <b>ordered list</b>, and order is the user's trust ranking made
|
||||
/// explicit: for a fetch, servers are tried in order and the <i>first acceptable</i>
|
||||
/// result wins — acceptable meaning it clears the configured match tier.
|
||||
/// <para>
|
||||
/// First-match rather than best-match is deliberate. Querying every server for
|
||||
/// every item multiplies egress, leaks the library to more parties, and the
|
||||
/// ordering already encodes which source the admin prefers. Each configured
|
||||
/// server multiplies the privacy exposure described in the server spec §9, so
|
||||
/// later servers are queried only for what earlier ones lacked.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
// TRACES: JR-025, JR-029, JR-030, JR-037 | PR-005, PR-006
|
||||
public class ManifestExchangeClient : IManifestExchangeClient, IDisposable
|
||||
{
|
||||
/// <summary>Server spec §9: a single manifest response is capped at 2 MiB.</summary>
|
||||
public const long MaxManifestBytes = 2 * 1024 * 1024;
|
||||
|
||||
/// <summary>Server spec §9: a bundle response is capped at 25 MiB.</summary>
|
||||
public const long MaxBundleBytes = 25L * 1024 * 1024;
|
||||
|
||||
private static readonly TimeSpan ConnectTimeout = TimeSpan.FromSeconds(5);
|
||||
private static readonly TimeSpan ReadTimeout = TimeSpan.FromSeconds(30);
|
||||
|
||||
/// <summary>
|
||||
/// How long a server that failed is skipped for, doubling each consecutive
|
||||
/// failure. One dead server must never stall a library sweep.
|
||||
/// </summary>
|
||||
private static readonly TimeSpan BaseBackoff = TimeSpan.FromMinutes(1);
|
||||
private static readonly TimeSpan MaxBackoff = TimeSpan.FromHours(1);
|
||||
|
||||
private readonly HttpClient _http;
|
||||
private readonly ILogger<ManifestExchangeClient> _logger;
|
||||
private readonly ConcurrentDictionary<string, ServerHealth> _health = new(StringComparer.Ordinal);
|
||||
private readonly bool _ownsClient;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="ManifestExchangeClient"/> class.
|
||||
/// </summary>
|
||||
/// <param name="logger">Logger.</param>
|
||||
public ManifestExchangeClient(ILogger<ManifestExchangeClient> logger)
|
||||
: this(logger, null)
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="ManifestExchangeClient"/> class
|
||||
/// with an injected transport, for testing.
|
||||
/// </summary>
|
||||
/// <param name="logger">Logger.</param>
|
||||
/// <param name="httpClient">Transport to use, or null to build the default.</param>
|
||||
public ManifestExchangeClient(ILogger<ManifestExchangeClient> logger, HttpClient? httpClient)
|
||||
{
|
||||
_logger = logger;
|
||||
_ownsClient = httpClient is null;
|
||||
_http = httpClient ?? new HttpClient(new SocketsHttpHandler
|
||||
{
|
||||
ConnectTimeout = ConnectTimeout,
|
||||
// Certificate validation is never disabled: a plaintext or
|
||||
// unverified server would let any network intermediary rewrite
|
||||
// actor overlays.
|
||||
AutomaticDecompression = System.Net.DecompressionMethods.All,
|
||||
})
|
||||
{
|
||||
Timeout = ReadTimeout,
|
||||
};
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public async Task<ManifestFetchOutcome?> FetchMovieAsync(
|
||||
IReadOnlyList<ManifestServer> servers,
|
||||
MatchTier minimumTier,
|
||||
TitleQuery query,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(servers);
|
||||
ArgumentNullException.ThrowIfNull(query);
|
||||
|
||||
foreach (var server in Eligible(servers))
|
||||
{
|
||||
var url = BuildUrl(server, "manifests/movie", query);
|
||||
if (url is null)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
var outcome = await TryFetchOneAsync(server, url, query, minimumTier, cancellationToken)
|
||||
.ConfigureAwait(false);
|
||||
if (outcome is not null)
|
||||
{
|
||||
// First acceptable result wins — no further servers are queried,
|
||||
// which is what bounds the privacy exposure.
|
||||
return outcome;
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public async Task<ManifestFetchOutcome?> FetchEpisodeAsync(
|
||||
IReadOnlyList<ManifestServer> servers,
|
||||
MatchTier minimumTier,
|
||||
TitleQuery query,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(servers);
|
||||
ArgumentNullException.ThrowIfNull(query);
|
||||
|
||||
foreach (var server in Eligible(servers))
|
||||
{
|
||||
var url = BuildUrl(server, "manifests/episode", query);
|
||||
if (url is null)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
var outcome = await TryFetchOneAsync(server, url, query, minimumTier, cancellationToken)
|
||||
.ConfigureAwait(false);
|
||||
if (outcome is not null)
|
||||
{
|
||||
return outcome;
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public IReadOnlyList<ServerStatus> GetStatus(IReadOnlyList<ManifestServer> servers)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(servers);
|
||||
|
||||
return servers.Select(s =>
|
||||
{
|
||||
_health.TryGetValue(s.Url, out var h);
|
||||
return new ServerStatus
|
||||
{
|
||||
Url = s.Url,
|
||||
Name = s.Name,
|
||||
Enabled = s.Enabled,
|
||||
Reachable = h is null || h.ConsecutiveFailures == 0,
|
||||
LastError = h?.LastError,
|
||||
SkippedUntil = h?.SkipUntil,
|
||||
};
|
||||
}).ToList();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Servers that are enabled and not currently in backoff, in configured order.
|
||||
/// </summary>
|
||||
private IEnumerable<ManifestServer> Eligible(IReadOnlyList<ManifestServer> servers)
|
||||
{
|
||||
var now = DateTimeOffset.UtcNow;
|
||||
foreach (var s in servers)
|
||||
{
|
||||
if (!s.Enabled || string.IsNullOrWhiteSpace(s.Url))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
if (_health.TryGetValue(s.Url, out var h) && h.SkipUntil > now)
|
||||
{
|
||||
_logger.LogDebug("Skipping {Url} until {Until} after {Failures} failures", s.Url, h.SkipUntil, h.ConsecutiveFailures);
|
||||
continue;
|
||||
}
|
||||
|
||||
yield return s;
|
||||
}
|
||||
}
|
||||
|
||||
private async Task<ManifestFetchOutcome?> TryFetchOneAsync(
|
||||
ManifestServer server,
|
||||
Uri url,
|
||||
TitleQuery query,
|
||||
MatchTier minimumTier,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
try
|
||||
{
|
||||
using var response = await _http
|
||||
.GetAsync(url, HttpCompletionOption.ResponseHeadersRead, cancellationToken)
|
||||
.ConfigureAwait(false);
|
||||
|
||||
if (response.StatusCode == System.Net.HttpStatusCode.NotFound)
|
||||
{
|
||||
// Not an error: this server simply does not hold it. The next
|
||||
// server in the list gets a turn.
|
||||
RecordSuccess(server.Url);
|
||||
return null;
|
||||
}
|
||||
|
||||
if (!response.IsSuccessStatusCode)
|
||||
{
|
||||
RecordFailure(server.Url, $"HTTP {(int)response.StatusCode}");
|
||||
return null;
|
||||
}
|
||||
|
||||
var json = await ReadCappedAsync(response, MaxManifestBytes, cancellationToken)
|
||||
.ConfigureAwait(false);
|
||||
if (json is null)
|
||||
{
|
||||
RecordFailure(server.Url, "response exceeded the size cap");
|
||||
return null;
|
||||
}
|
||||
|
||||
var body = JsonSerializer.Deserialize<ManifestFetchResponse>(json);
|
||||
RecordSuccess(server.Url);
|
||||
|
||||
if (body?.Manifest is null)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
var tier = ParseTier(body.Match);
|
||||
if (tier is null || tier < minimumTier)
|
||||
{
|
||||
_logger.LogDebug(
|
||||
"{Url} matched at {Tier}, below the configured minimum {Minimum}",
|
||||
server.Url,
|
||||
body.Match,
|
||||
minimumTier);
|
||||
return null;
|
||||
}
|
||||
|
||||
if (!ManifestValidator.TryValidate(body.Manifest, query.RuntimeSec, out var error))
|
||||
{
|
||||
// A manifest is never trusted merely because a server served it.
|
||||
_logger.LogWarning("Rejected manifest from {Url}: {Error}", server.Url, error);
|
||||
return null;
|
||||
}
|
||||
|
||||
return new ManifestFetchOutcome
|
||||
{
|
||||
ServerUrl = server.Url,
|
||||
Tier = tier.Value,
|
||||
OffsetSec = body.OffsetSec,
|
||||
Manifest = body.Manifest,
|
||||
};
|
||||
}
|
||||
catch (OperationCanceledException) when (cancellationToken.IsCancellationRequested)
|
||||
{
|
||||
throw;
|
||||
}
|
||||
catch (Exception ex) when (ex is HttpRequestException or TaskCanceledException or JsonException)
|
||||
{
|
||||
// A slow, unreachable or nonsense-returning server is skipped and
|
||||
// backed off; it must never stall the sweep or fail the whole fetch.
|
||||
RecordFailure(server.Url, ex.Message);
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Reads a response body, aborting once it exceeds <paramref name="cap"/>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Capped <b>while streaming</b> rather than after buffering: a hostile
|
||||
/// server can declare any <c>Content-Length</c> it likes, so reading to
|
||||
/// completion and then measuring is exactly the denial-of-service primitive
|
||||
/// the cap exists to prevent.
|
||||
/// </remarks>
|
||||
private static async Task<string?> ReadCappedAsync(
|
||||
HttpResponseMessage response,
|
||||
long cap,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
// The declared length is a cheap early rejection, never the enforcement.
|
||||
if (response.Content.Headers.ContentLength is { } declared && declared > cap)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
using var stream = await response.Content.ReadAsStreamAsync(cancellationToken).ConfigureAwait(false);
|
||||
var buffer = new byte[8192];
|
||||
using var accumulated = new System.IO.MemoryStream();
|
||||
|
||||
while (true)
|
||||
{
|
||||
var read = await stream.ReadAsync(buffer, cancellationToken).ConfigureAwait(false);
|
||||
if (read == 0)
|
||||
{
|
||||
break;
|
||||
}
|
||||
|
||||
if (accumulated.Length + read > cap)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
await accumulated.WriteAsync(buffer.AsMemory(0, read), cancellationToken).ConfigureAwait(false);
|
||||
}
|
||||
|
||||
return System.Text.Encoding.UTF8.GetString(accumulated.ToArray());
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Builds a fetch URL, or null when the server's URL is unusable.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <b>HTTPS is required for anything that is not loopback.</b> A plaintext
|
||||
/// community server would let any network intermediary rewrite actor
|
||||
/// overlays, and the overlay is displayed to the user as fact.
|
||||
/// </remarks>
|
||||
/// <param name="server">The configured server.</param>
|
||||
/// <param name="path">API path below <c>/api/v1/</c>.</param>
|
||||
/// <param name="query">Identity and cut parameters.</param>
|
||||
/// <returns>The URL to request, or null when the server URL is unusable.</returns>
|
||||
internal static Uri? BuildUrl(ManifestServer server, string path, TitleQuery query)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(server);
|
||||
ArgumentNullException.ThrowIfNull(query);
|
||||
|
||||
if (!Uri.TryCreate(server.Url, UriKind.Absolute, out var baseUri))
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
if (!IsTransportAcceptable(baseUri))
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
var q = query.ToQueryString();
|
||||
var trimmed = baseUri.AbsoluteUri.TrimEnd('/');
|
||||
return Uri.TryCreate($"{trimmed}/api/v1/{path}?{q}", UriKind.Absolute, out var built)
|
||||
? built
|
||||
: null;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// True when the URL may be used: HTTPS anywhere, or HTTP on loopback only.
|
||||
/// </summary>
|
||||
/// <param name="uri">The server base URL.</param>
|
||||
/// <returns><c>true</c> when the transport is acceptable.</returns>
|
||||
internal static bool IsTransportAcceptable(Uri uri)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(uri);
|
||||
|
||||
if (uri.Scheme == Uri.UriSchemeHttps)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
if (uri.Scheme != Uri.UriSchemeHttp)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
// Loopback is exempt because there is no network path to intercept.
|
||||
return uri.IsLoopback;
|
||||
}
|
||||
|
||||
/// <summary>Parses a tier name the server reported.</summary>
|
||||
/// <param name="tier">The tier string.</param>
|
||||
/// <returns>The tier, or null when unrecognised.</returns>
|
||||
internal static MatchTier? ParseTier(string? tier) => tier switch
|
||||
{
|
||||
// `exact` is deliberately absent: the file-hash tier is withdrawn on
|
||||
// legal grounds (see MatchTier). A server cannot report it to us anyway,
|
||||
// since we send no `video_hash` — and if one did, treating it as
|
||||
// unrecognised means the manifest is declined rather than silently
|
||||
// accepted under a tier this plugin has no policy for.
|
||||
"audio" => MatchTier.Audio,
|
||||
"runtime" => MatchTier.Runtime,
|
||||
"loose" => MatchTier.Loose,
|
||||
_ => null,
|
||||
};
|
||||
|
||||
private void RecordSuccess(string url) => _health.TryRemove(url, out _);
|
||||
|
||||
private void RecordFailure(string url, string error)
|
||||
{
|
||||
var updated = _health.AddOrUpdate(
|
||||
url,
|
||||
_ => new ServerHealth { ConsecutiveFailures = 1, LastError = error, SkipUntil = DateTimeOffset.UtcNow + BaseBackoff },
|
||||
(_, existing) =>
|
||||
{
|
||||
var failures = existing.ConsecutiveFailures + 1;
|
||||
// Exponential, capped: a server that is down for a day should
|
||||
// not be retried every minute for that whole day.
|
||||
var delayTicks = Math.Min(
|
||||
BaseBackoff.Ticks * (long)Math.Pow(2, Math.Min(failures - 1, 6)),
|
||||
MaxBackoff.Ticks);
|
||||
return new ServerHealth
|
||||
{
|
||||
ConsecutiveFailures = failures,
|
||||
LastError = error,
|
||||
SkipUntil = DateTimeOffset.UtcNow + TimeSpan.FromTicks(delayTicks),
|
||||
};
|
||||
});
|
||||
|
||||
_logger.LogWarning(
|
||||
"Server {Url} failed ({Failures} consecutive): {Error}. Skipping until {Until}",
|
||||
url,
|
||||
updated.ConsecutiveFailures,
|
||||
error,
|
||||
updated.SkipUntil);
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public void Dispose()
|
||||
{
|
||||
Dispose(true);
|
||||
GC.SuppressFinalize(this);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Releases the transport when this instance created it.
|
||||
/// </summary>
|
||||
/// <param name="disposing">Whether managed resources should be released.</param>
|
||||
protected virtual void Dispose(bool disposing)
|
||||
{
|
||||
if (disposing && _ownsClient)
|
||||
{
|
||||
_http.Dispose();
|
||||
}
|
||||
}
|
||||
|
||||
private sealed class ServerHealth
|
||||
{
|
||||
public int ConsecutiveFailures { get; init; }
|
||||
|
||||
public string? LastError { get; init; }
|
||||
|
||||
public DateTimeOffset SkipUntil { get; init; }
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,23 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Globalization;
|
||||
using Jellyfin.Plugin.JRay.Configuration;
|
||||
using Jellyfin.Plugin.JRay.Models;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Services;
|
||||
|
||||
/// <summary>A manifest accepted from a server.</summary>
|
||||
public class ManifestFetchOutcome
|
||||
{
|
||||
/// <summary>Gets or sets which server supplied it.</summary>
|
||||
public string ServerUrl { get; set; } = string.Empty;
|
||||
|
||||
/// <summary>Gets or sets the cut-match tier achieved.</summary>
|
||||
public MatchTier Tier { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the offset the client must apply to every window.</summary>
|
||||
public double OffsetSec { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the manifest.</summary>
|
||||
public Jmanifest? Manifest { get; set; }
|
||||
}
|
||||
@@ -0,0 +1,256 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Globalization;
|
||||
using System.Linq;
|
||||
using Jellyfin.Plugin.JRay.Models;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Services;
|
||||
|
||||
/// <summary>
|
||||
/// Re-validates a manifest received from a server.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <b>Every server is untrusted, including the pre-configured community one.</b>
|
||||
/// Everything the server specification guarantees is a property of a *correctly
|
||||
/// operated* server; pointing the plugin at an arbitrary URL inherits none of
|
||||
/// it. So the plugin re-applies client-side what the server applies on upload:
|
||||
/// unknown-shaped data rejected, identifiers format-checked, windows
|
||||
/// bounds-checked against the item's real runtime.
|
||||
/// <para>
|
||||
/// The honest framing for the configuration page is that adding a third-party
|
||||
/// server means trusting its operator not to serve you deliberately wrong actor
|
||||
/// data. These checks bound the damage to bad overlay content; they cannot make
|
||||
/// wrong data right.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
// TRACES: JR-027 | SR-004
|
||||
public static class ManifestValidator
|
||||
{
|
||||
/// <summary>The exchange envelope version this plugin speaks (SR-003).</summary>
|
||||
public const int SupportedJmanifestVersion = 2;
|
||||
|
||||
/// <summary>Server spec §6: no more than 500 actors in one manifest.</summary>
|
||||
public const int MaxActors = 500;
|
||||
|
||||
/// <summary>Server spec §6: no more than 2000 windows for one actor.</summary>
|
||||
public const int MaxScenesPerActor = 2000;
|
||||
|
||||
/// <summary>Server spec §6: no more than 20000 windows in total.</summary>
|
||||
public const int MaxTotalScenes = 20000;
|
||||
|
||||
/// <summary>Server spec §6: names are capped at 200 characters.</summary>
|
||||
public const int MaxNameLength = 200;
|
||||
|
||||
/// <summary>
|
||||
/// Windows may exceed the measured runtime by this much before being
|
||||
/// rejected, covering rounding and container-duration disagreement.
|
||||
/// </summary>
|
||||
public const double RuntimeToleranceSec = 5.0;
|
||||
|
||||
/// <summary>
|
||||
/// Validates a manifest against the local item's measured runtime.
|
||||
/// </summary>
|
||||
/// <param name="manifest">The manifest as received.</param>
|
||||
/// <param name="localRuntimeSec">
|
||||
/// The runtime of the local file, or null when it is not known. Windows are
|
||||
/// bounds-checked against it when it is available.
|
||||
/// </param>
|
||||
/// <param name="error">The first problem found, naming the offending field.</param>
|
||||
/// <returns><c>true</c> when the manifest is safe to store.</returns>
|
||||
public static bool TryValidate(Jmanifest? manifest, double? localRuntimeSec, out string error)
|
||||
{
|
||||
if (manifest is null)
|
||||
{
|
||||
error = "manifest: absent";
|
||||
return false;
|
||||
}
|
||||
|
||||
// An unknown envelope version is refused, never guessed at (JR-003).
|
||||
// A server one version ahead may have changed the meaning of a field
|
||||
// this plugin thinks it understands.
|
||||
if (manifest.JmanifestVersion != SupportedJmanifestVersion)
|
||||
{
|
||||
error = string.Create(
|
||||
CultureInfo.InvariantCulture,
|
||||
$"jmanifest_version: unsupported version {manifest.JmanifestVersion}, expected {SupportedJmanifestVersion}");
|
||||
return false;
|
||||
}
|
||||
|
||||
if (manifest.Identity is null)
|
||||
{
|
||||
error = "identity: absent";
|
||||
return false;
|
||||
}
|
||||
|
||||
if (manifest.Cut is null || !IsSaneRuntime(manifest.Cut.RuntimeSec))
|
||||
{
|
||||
error = "cut.runtime_sec: absent or not a plausible duration";
|
||||
return false;
|
||||
}
|
||||
|
||||
if (manifest.Actors.Count == 0)
|
||||
{
|
||||
error = "actors: empty";
|
||||
return false;
|
||||
}
|
||||
|
||||
if (manifest.Actors.Count > MaxActors)
|
||||
{
|
||||
error = string.Create(
|
||||
CultureInfo.InvariantCulture,
|
||||
$"actors: more than {MaxActors} entries");
|
||||
return false;
|
||||
}
|
||||
|
||||
// Bounds are checked against the *local* file where known, because that
|
||||
// is what the overlay will index into. A window past the end of the file
|
||||
// is not merely useless, it is evidence the manifest is for another cut.
|
||||
var limit = (localRuntimeSec ?? manifest.Cut.RuntimeSec) + RuntimeToleranceSec;
|
||||
|
||||
var total = 0;
|
||||
var seenTmdb = new HashSet<string>(StringComparer.Ordinal);
|
||||
|
||||
for (var i = 0; i < manifest.Actors.Count; i++)
|
||||
{
|
||||
var actor = manifest.Actors[i];
|
||||
|
||||
if (actor.Name is { Length: > MaxNameLength })
|
||||
{
|
||||
error = string.Create(CultureInfo.InvariantCulture, $"actors[{i}].name: too long");
|
||||
return false;
|
||||
}
|
||||
|
||||
if (actor.Name is not null && ContainsControlCharacters(actor.Name))
|
||||
{
|
||||
error = string.Create(
|
||||
CultureInfo.InvariantCulture,
|
||||
$"actors[{i}].name: contains control characters");
|
||||
return false;
|
||||
}
|
||||
|
||||
if (actor.TmdbId is { Length: > 0 } tmdb)
|
||||
{
|
||||
if (!IsDigits(tmdb, 9))
|
||||
{
|
||||
error = string.Create(
|
||||
CultureInfo.InvariantCulture,
|
||||
$"actors[{i}].tmdb_id: not a TMDB id");
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!seenTmdb.Add(tmdb))
|
||||
{
|
||||
error = string.Create(
|
||||
CultureInfo.InvariantCulture,
|
||||
$"actors[{i}].tmdb_id: duplicate actor");
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
if (actor.ImdbId is { Length: > 0 } imdb && !IsPersonImdbId(imdb))
|
||||
{
|
||||
error = string.Create(
|
||||
CultureInfo.InvariantCulture,
|
||||
$"actors[{i}].imdb_id: not an IMDB person id");
|
||||
return false;
|
||||
}
|
||||
|
||||
if (actor.Scenes.Count > MaxScenesPerActor)
|
||||
{
|
||||
error = string.Create(
|
||||
CultureInfo.InvariantCulture,
|
||||
$"actors[{i}].scenes: more than {MaxScenesPerActor} entries");
|
||||
return false;
|
||||
}
|
||||
|
||||
total += actor.Scenes.Count;
|
||||
if (total > MaxTotalScenes)
|
||||
{
|
||||
error = string.Create(
|
||||
CultureInfo.InvariantCulture,
|
||||
$"actors: more than {MaxTotalScenes} windows in total");
|
||||
return false;
|
||||
}
|
||||
|
||||
for (var j = 0; j < actor.Scenes.Count; j++)
|
||||
{
|
||||
var scene = actor.Scenes[j];
|
||||
if (!IsFinite(scene.Start) || !IsFinite(scene.End))
|
||||
{
|
||||
error = string.Create(
|
||||
CultureInfo.InvariantCulture,
|
||||
$"actors[{i}].scenes[{j}]: non-finite value");
|
||||
return false;
|
||||
}
|
||||
|
||||
if (scene.Start < 0 || scene.End < scene.Start)
|
||||
{
|
||||
error = string.Create(
|
||||
CultureInfo.InvariantCulture,
|
||||
$"actors[{i}].scenes[{j}]: negative or inverted window");
|
||||
return false;
|
||||
}
|
||||
|
||||
if (scene.End > limit)
|
||||
{
|
||||
error = string.Create(
|
||||
CultureInfo.InvariantCulture,
|
||||
$"actors[{i}].scenes[{j}]: ends beyond the item's runtime");
|
||||
return false;
|
||||
}
|
||||
|
||||
// A posterior outside [0, 1] is not a probability.
|
||||
if (scene.Belief is { } b && (!IsFinite(b) || b < 0 || b > 1))
|
||||
{
|
||||
error = string.Create(
|
||||
CultureInfo.InvariantCulture,
|
||||
$"actors[{i}].scenes[{j}].belief: outside [0, 1]");
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
error = string.Empty;
|
||||
return true;
|
||||
}
|
||||
|
||||
private static bool IsSaneRuntime(double v) => IsFinite(v) && v > 0 && v < 200_000;
|
||||
|
||||
private static bool IsFinite(double v) => !double.IsNaN(v) && !double.IsInfinity(v);
|
||||
|
||||
private static bool IsDigits(string s, int maxLength) =>
|
||||
s.Length > 0 && s.Length <= maxLength && s.All(char.IsAsciiDigit);
|
||||
|
||||
private static bool IsPersonImdbId(string s) =>
|
||||
s.StartsWith("nm", StringComparison.Ordinal)
|
||||
&& (s.Length == 9 || s.Length == 10)
|
||||
&& s.AsSpan(2).ToString().All(char.IsAsciiDigit);
|
||||
|
||||
/// <summary>
|
||||
/// Control characters are refused outright. The overlay renders names as
|
||||
/// text nodes (JR-024), so markup is already inert, but a bidi override or a
|
||||
/// zero-width joiner can still make a name display as something other than
|
||||
/// what was stored.
|
||||
/// </summary>
|
||||
private static bool ContainsControlCharacters(string s)
|
||||
{
|
||||
foreach (var c in s)
|
||||
{
|
||||
if (char.IsControl(c))
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
// Zero-width and bidi-control codepoints.
|
||||
if (c is >= '' and <= ''
|
||||
or >= '' and <= ''
|
||||
or >= '' and <= ''
|
||||
or '')
|
||||
{
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
||||
@@ -17,6 +17,7 @@ namespace Jellyfin.Plugin.JRay.Services;
|
||||
/// reads. All access is synchronised so the work-discovery API and the
|
||||
/// config page can touch it concurrently.
|
||||
/// </summary>
|
||||
// TRACES: JR-016 | PR-003
|
||||
public sealed class MediaPolicyStore : IMediaPolicyStore
|
||||
{
|
||||
private static readonly JsonSerializerOptions JsonOptions = new(JsonSerializerDefaults.Web)
|
||||
|
||||
@@ -11,6 +11,7 @@ namespace Jellyfin.Plugin.JRay.Services;
|
||||
/// hold only one action, the only conflicts possible are across scopes, and
|
||||
/// specificity resolves those.
|
||||
/// </summary>
|
||||
// TRACES: JR-016 | PR-003
|
||||
public static class PolicyResolver
|
||||
{
|
||||
/// <summary>
|
||||
|
||||
@@ -0,0 +1,119 @@
|
||||
using System.Collections.Generic;
|
||||
using Jellyfin.Plugin.JRay.Models;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Services;
|
||||
|
||||
/// <summary>
|
||||
/// Answers "which actors are in the scene at time <c>t</c>" from a truth file.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This is the unit that decides presence, so the scene-scoped semantics live
|
||||
/// here rather than being spread through the controller.
|
||||
///
|
||||
/// <para>
|
||||
/// <b>A window is a claim about scene membership, not a recognition event.</b>
|
||||
/// An actor who turns away, is occluded, or is off-camera while the shot cuts to
|
||||
/// whoever they are speaking to is still present. Two windows mean a genuine
|
||||
/// departure and return, not a break in detection — so this code reads windows
|
||||
/// exactly as given and never merges, splits, trims, or reorders them.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Bounds are inclusive at both ends, matching the format's definition. That
|
||||
/// makes adjacent windows such as <c>[0,10]</c> and <c>[10,20]</c> both contain
|
||||
/// <c>t = 10</c>; reporting the actor present once is correct, and is not a
|
||||
/// reason to merge the windows.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
// TRACES: JR-004, JR-005, JR-006 | SR-002
|
||||
public static class PresenceLookup
|
||||
{
|
||||
/// <summary>
|
||||
/// Determines whether an actor is present in the scene at <paramref name="t"/>.
|
||||
/// </summary>
|
||||
/// <param name="actor">The actor entry from a truth file.</param>
|
||||
/// <param name="t">The timestamp, in seconds.</param>
|
||||
/// <returns><c>true</c> when any window contains <paramref name="t"/>.</returns>
|
||||
public static bool IsPresentAt(TruthActor actor, double t)
|
||||
{
|
||||
if (actor is null)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
// A full scan, deliberately: windows may be numerous, but correctness
|
||||
// must not depend on the producer having honoured the sortedness
|
||||
// guarantee. An early exit on `start > t` would be faster and would
|
||||
// silently under-report the moment one file arrived out of order —
|
||||
// trading a correctness risk for a saving that does not matter at this
|
||||
// scale (see JR-006).
|
||||
foreach (var window in actor.Scenes)
|
||||
{
|
||||
if (window.Length == 2 && window[0] <= t && t <= window[1])
|
||||
{
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Lists the actors present in the scene at <paramref name="t"/>, in the
|
||||
/// order the truth file lists them.
|
||||
/// </summary>
|
||||
/// <param name="truth">The truth file.</param>
|
||||
/// <param name="t">The timestamp, in seconds.</param>
|
||||
/// <returns>The actors whose windows contain <paramref name="t"/>.</returns>
|
||||
public static IEnumerable<TruthActor> ActorsPresentAt(TruthFile truth, double t)
|
||||
{
|
||||
if (truth is null)
|
||||
{
|
||||
yield break;
|
||||
}
|
||||
|
||||
foreach (var actor in truth.Actors)
|
||||
{
|
||||
if (IsPresentAt(actor, t))
|
||||
{
|
||||
yield return actor;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Determines whether an actor's windows are sorted by start time, as the
|
||||
/// truth-file format requires of producers.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Presence lookup does not depend on this — it is a diagnostic. A file that
|
||||
/// fails it is still read correctly, but it signals a producer bug worth
|
||||
/// surfacing rather than absorbing silently.
|
||||
/// </remarks>
|
||||
/// <param name="actor">The actor entry from a truth file.</param>
|
||||
/// <returns><c>true</c> when every window starts at or after its predecessor.</returns>
|
||||
public static bool WindowsAreSorted(TruthActor actor)
|
||||
{
|
||||
if (actor is null)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
double previousStart = double.NegativeInfinity;
|
||||
foreach (var window in actor.Scenes)
|
||||
{
|
||||
if (window.Length != 2)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
if (window[0] < previousStart)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
previousStart = window[0];
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,29 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Globalization;
|
||||
using Jellyfin.Plugin.JRay.Configuration;
|
||||
using Jellyfin.Plugin.JRay.Models;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Services;
|
||||
|
||||
/// <summary>Per-server reachability, for the configuration page.</summary>
|
||||
public class ServerStatus
|
||||
{
|
||||
/// <summary>Gets or sets the server's base URL.</summary>
|
||||
public string Url { get; set; } = string.Empty;
|
||||
|
||||
/// <summary>Gets or sets the display name.</summary>
|
||||
public string Name { get; set; } = string.Empty;
|
||||
|
||||
/// <summary>Gets or sets a value indicating whether the server is enabled.</summary>
|
||||
public bool Enabled { get; set; }
|
||||
|
||||
/// <summary>Gets or sets a value indicating whether the last attempt succeeded.</summary>
|
||||
public bool Reachable { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the last error seen, if any.</summary>
|
||||
public string? LastError { get; set; }
|
||||
|
||||
/// <summary>Gets or sets when this server will next be tried.</summary>
|
||||
public DateTimeOffset? SkippedUntil { get; set; }
|
||||
}
|
||||
@@ -0,0 +1,57 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Globalization;
|
||||
using Jellyfin.Plugin.JRay.Configuration;
|
||||
using Jellyfin.Plugin.JRay.Models;
|
||||
|
||||
namespace Jellyfin.Plugin.JRay.Services;
|
||||
|
||||
/// <summary>Identity and cut parameters for a fetch.</summary>
|
||||
public class TitleQuery
|
||||
{
|
||||
/// <summary>Gets or sets the movie's TMDB id.</summary>
|
||||
public string? TmdbId { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the movie's IMDB id.</summary>
|
||||
public string? ImdbId { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the series TMDB id, for an episode.</summary>
|
||||
public string? SeriesTmdbId { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the season number, for an episode.</summary>
|
||||
public int? Season { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the episode number, for an episode.</summary>
|
||||
public int? Episode { get; set; }
|
||||
|
||||
/// <summary>Gets or sets the local file's measured runtime, in seconds.</summary>
|
||||
public double? RuntimeSec { get; set; }
|
||||
|
||||
/// <summary>Renders the query parameters the server expects.</summary>
|
||||
/// <remarks>
|
||||
/// There is deliberately no <c>video_hash</c> parameter. The file-hash tier
|
||||
/// is withdrawn on legal grounds (see <see cref="MatchTier"/>), and omitting
|
||||
/// the field here is what makes that structural: there is nothing to send,
|
||||
/// so no future caller can start sending one by setting a property.
|
||||
/// </remarks>
|
||||
/// <returns>An escaped query string, without the leading '?'.</returns>
|
||||
public string ToQueryString()
|
||||
{
|
||||
var parts = new List<string>();
|
||||
void Add(string key, string? value)
|
||||
{
|
||||
if (!string.IsNullOrEmpty(value))
|
||||
{
|
||||
parts.Add($"{key}={Uri.EscapeDataString(value)}");
|
||||
}
|
||||
}
|
||||
|
||||
Add("tmdb_id", TmdbId);
|
||||
Add("imdb_id", ImdbId);
|
||||
Add("series_tmdb_id", SeriesTmdbId);
|
||||
Add("season", Season?.ToString(CultureInfo.InvariantCulture));
|
||||
Add("episode", Episode?.ToString(CultureInfo.InvariantCulture));
|
||||
Add("runtime_sec", RuntimeSec?.ToString("0.###", CultureInfo.InvariantCulture));
|
||||
return string.Join('&', parts);
|
||||
}
|
||||
}
|
||||
@@ -16,6 +16,13 @@ namespace Jellyfin.Plugin.JRay.Services;
|
||||
/// item's source file, and caches the parsed result for a configurable
|
||||
/// duration.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Managed truth — pushed by a worker, or fetched from a manifest server —
|
||||
/// takes precedence over a sidecar file. Storing fetched manifests through the
|
||||
/// managed store is what keeps this a two-way rule rather than a three-way one,
|
||||
/// so the read path never learns that the exchange exists.
|
||||
/// </remarks>
|
||||
// TRACES: JR-008, JR-010, JR-011 | PR-001
|
||||
public sealed class TruthDataService : ITruthDataService
|
||||
{
|
||||
private static readonly JsonSerializerOptions JsonOptions = new(JsonSerializerDefaults.Web);
|
||||
@@ -86,6 +93,34 @@ public sealed class TruthDataService : ITruthDataService
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public TruthProvenance? GetProvenance(Guid itemId)
|
||||
{
|
||||
// Managed truth wins, exactly as in GetTruthAsync -- resolving
|
||||
// precedence twice by different rules is how the two would drift.
|
||||
var managed = _managedTruthStore.LoadProvenance(itemId);
|
||||
if (managed is not null)
|
||||
{
|
||||
return managed;
|
||||
}
|
||||
|
||||
var item = _libraryManager.GetItemById(itemId);
|
||||
if (item is null || string.IsNullOrEmpty(item.Path))
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
var sidecarPath = GetSidecarPath(item.Path);
|
||||
if (!File.Exists(sidecarPath))
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
// A sidecar records nothing about itself, so its provenance is derived:
|
||||
// it is local, and its timestamp is the file's own.
|
||||
return TruthProvenance.Local(TruthSource.Sidecar, File.GetLastWriteTimeUtc(sidecarPath));
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public void Invalidate(Guid itemId)
|
||||
{
|
||||
|
||||
@@ -6,26 +6,40 @@ using Microsoft.Extensions.Logging;
|
||||
namespace Jellyfin.Plugin.JRay.Services;
|
||||
|
||||
/// <summary>
|
||||
/// Injects (or removes) a script tag in the web client's <c>index.html</c>
|
||||
/// that loads JRay's pause-overlay script. This follows the pattern used by
|
||||
/// other Jellyfin plugins (e.g. Intro Skipper) since there is no official
|
||||
/// plugin hook for player-overlay UI.
|
||||
/// Removes the pause-overlay script tag that an earlier version of JRay
|
||||
/// injected into the web client's <c>index.html</c> on disk.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <b>This class cannot inject.</b> JRay reaches the web client only through
|
||||
/// <see cref="FileTransformationRegistration"/>, which rewrites
|
||||
/// <c>index.html</c> as it is served. Patching the file on disk was removed
|
||||
/// rather than left switched off: the patch outlives an uninstall, a web-client
|
||||
/// upgrade discards it silently, and it races any other plugin patching the same
|
||||
/// file. An unreachable write path is also the one nobody runs, which is the one
|
||||
/// a later refactor re-enables by accident.
|
||||
///
|
||||
/// Removal remains because users upgrading from a version that did patch the
|
||||
/// file must not be left with a stale injection pointing at endpoints that have
|
||||
/// since changed. It keys on JRay's own <c><!-- jray-overlay --></c>
|
||||
/// marker, so it is unambiguous and touches nothing another plugin added.
|
||||
/// </remarks>
|
||||
// TRACES: JR-021, JR-022 | PR-004
|
||||
public static class WebClientPatchService
|
||||
{
|
||||
private const string Marker = "<!-- jray-overlay -->";
|
||||
private const string ScriptTag = "<script defer src=\"/Plugins/JRay/ClientScript\"></script>";
|
||||
private const string Injected = ScriptTag + Marker + "\n</body>";
|
||||
|
||||
/// <summary>
|
||||
/// Ensures the web client's index.html either has or does not have the
|
||||
/// JRay overlay script injected, matching <paramref name="enableOverlay"/>.
|
||||
/// Removes a legacy on-disk overlay injection, if one is present. Safe to
|
||||
/// call on every startup: it is a no-op once the marker is gone.
|
||||
/// </summary>
|
||||
/// <param name="applicationPaths">The Jellyfin application paths.</param>
|
||||
/// <param name="enableOverlay">Whether the overlay script should be present.</param>
|
||||
/// <param name="logger">The logger.</param>
|
||||
public static void Apply(IApplicationPaths applicationPaths, bool enableOverlay, ILogger logger)
|
||||
public static void RemoveLegacyPatch(IApplicationPaths applicationPaths, ILogger logger)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(applicationPaths);
|
||||
ArgumentNullException.ThrowIfNull(logger);
|
||||
|
||||
var indexPath = Path.Combine(applicationPaths.WebPath, "index.html");
|
||||
|
||||
try
|
||||
@@ -37,36 +51,38 @@ public static class WebClientPatchService
|
||||
}
|
||||
|
||||
var html = File.ReadAllText(indexPath);
|
||||
var hasMarker = html.Contains(Marker, StringComparison.Ordinal);
|
||||
if (!html.Contains(Marker, StringComparison.Ordinal))
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
if (enableOverlay && !hasMarker)
|
||||
{
|
||||
var patched = ReplaceLast(html, "</body>", Injected);
|
||||
File.WriteAllText(indexPath, patched);
|
||||
logger.LogInformation("JRay: injected pause-overlay script into {Path}", indexPath);
|
||||
}
|
||||
else if (!enableOverlay && hasMarker)
|
||||
{
|
||||
var patched = html.Replace(ScriptTag + Marker + "\n", string.Empty, StringComparison.Ordinal)
|
||||
.Replace(ScriptTag + Marker, string.Empty, StringComparison.Ordinal);
|
||||
File.WriteAllText(indexPath, patched);
|
||||
logger.LogInformation("JRay: removed pause-overlay script from {Path}", indexPath);
|
||||
}
|
||||
var cleaned = RemoveInjection(html);
|
||||
File.WriteAllText(indexPath, cleaned);
|
||||
logger.LogInformation(
|
||||
"JRay: removed a pause-overlay script left in {Path} by an earlier version. "
|
||||
+ "JRay no longer modifies this file; the overlay is served through File Transformation.",
|
||||
indexPath);
|
||||
}
|
||||
catch (Exception ex) when (ex is IOException or UnauthorizedAccessException)
|
||||
{
|
||||
logger.LogWarning(ex, "JRay: failed to patch web client index.html at {Path}", indexPath);
|
||||
logger.LogWarning(ex, "JRay: failed to remove the legacy overlay patch from {Path}", indexPath);
|
||||
}
|
||||
}
|
||||
|
||||
private static string ReplaceLast(string source, string find, string replace)
|
||||
/// <summary>
|
||||
/// Strips the marked script tag from the document.
|
||||
/// </summary>
|
||||
/// <param name="html">The document contents.</param>
|
||||
/// <returns>The contents with JRay's injection removed.</returns>
|
||||
internal static string RemoveInjection(string html)
|
||||
{
|
||||
var index = source.LastIndexOf(find, StringComparison.Ordinal);
|
||||
if (index < 0)
|
||||
{
|
||||
return source;
|
||||
}
|
||||
ArgumentNullException.ThrowIfNull(html);
|
||||
|
||||
return source[..index] + replace + source[(index + find.Length)..];
|
||||
// The trailing newline is stripped with the tag when present, so removing
|
||||
// a patch restores the document byte-for-byte rather than leaving a blank
|
||||
// line that accumulates across upgrades.
|
||||
return html
|
||||
.Replace(ScriptTag + Marker + "\n", string.Empty, StringComparison.Ordinal)
|
||||
.Replace(ScriptTag + Marker, string.Empty, StringComparison.Ordinal);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,3 +1,18 @@
|
||||
/*
|
||||
* JRay pause overlay: lists the cast of the scene the viewer paused in.
|
||||
*
|
||||
* Presence is scene-scoped. An actor who has turned away, is occluded, or is
|
||||
* off-camera during a reverse shot is still in the scene, so this must not be
|
||||
* presented as "who is visible right now" — that is a different, and weaker,
|
||||
* claim than the data makes.
|
||||
*
|
||||
* Every server-supplied string is written with textContent, never innerHTML.
|
||||
* With the manifest exchange these strings may originate from a third-party
|
||||
* server, and this is the one control that holds even if every other check is
|
||||
* bypassed.
|
||||
*
|
||||
* TRACES: JR-005, JR-020, JR-024 | SR-002, SR-004
|
||||
*/
|
||||
(function () {
|
||||
'use strict';
|
||||
|
||||
@@ -203,6 +218,22 @@
|
||||
overlayEl.style.gap = '12px';
|
||||
overlayEl.style.pointerEvents = 'none';
|
||||
|
||||
// "In this scene", not "on screen now". Presence is scene-scoped, so
|
||||
// this list includes people the camera is not currently pointing at —
|
||||
// without the heading a viewer reads a paused frame and concludes the
|
||||
// overlay is wrong whenever someone is off-camera mid-conversation.
|
||||
var heading = document.createElement('div');
|
||||
heading.className = 'jrayOverlayHeading';
|
||||
heading.textContent = 'In this scene';
|
||||
heading.style.width = '100%';
|
||||
heading.style.color = '#fff';
|
||||
heading.style.opacity = '0.75';
|
||||
heading.style.fontSize = '13px';
|
||||
heading.style.textTransform = 'uppercase';
|
||||
heading.style.letterSpacing = '0.08em';
|
||||
heading.style.textShadow = '0 1px 3px rgba(0,0,0,0.9)';
|
||||
overlayEl.appendChild(heading);
|
||||
|
||||
actors.forEach(function (actor) {
|
||||
var card = document.createElement('div');
|
||||
card.className = 'jrayActorCard';
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
# JRay
|
||||
|
||||
A Jellyfin plugin that brings an actor-overlay (think Amazon "X-Ray") feature to your media: pause a movie and JRay shows you which actors are on screen at that exact moment.
|
||||
A Jellyfin plugin that brings an actor-overlay (think Amazon "X-Ray") feature to your media: pause a movie and JRay shows you which actors are in the scene you paused in.
|
||||
|
||||
JRay reads "truth" files produced offline by the
|
||||
[scene-actor-extraction](https://github.com/dtourolle/scene-actor-extraction)
|
||||
pipeline (face detection + recognition) and exposes an API to query which actors
|
||||
are visible at a given timestamp. A small overlay, injected into the Jellyfin web
|
||||
are present in the scene at a given timestamp. A small overlay, injected into the Jellyfin web
|
||||
client, displays the result when you pause playback.
|
||||
|
||||
## Status
|
||||
@@ -25,10 +25,29 @@ https://gitea.tourolle.paris/dtourolle/jRay/raw/branch/master/manifest.json
|
||||
|
||||
Then install "JRay" from the plugin catalog and restart Jellyfin.
|
||||
|
||||
### Required for the overlay: File Transformation
|
||||
|
||||
JRay's pause overlay needs a script tag in the web client's `index.html`.
|
||||
Install [File Transformation](https://github.com/IAmParadox27/jellyfin-plugin-file-transformation)
|
||||
(repository `https://www.iamparadox.dev/jellyfin/plugins/manifest.json`) **before**
|
||||
installing JRay. It rewrites the page as it is served, so the file on disk is
|
||||
never touched — that survives server upgrades and coexists with other plugins
|
||||
patching the same file.
|
||||
|
||||
**There is no fallback.** JRay never edits `index.html` on disk: a patch there
|
||||
outlives an uninstall, is silently discarded by a web-client upgrade, and races
|
||||
any other plugin touching the file. Without File Transformation the pause
|
||||
overlay is simply disabled — every other JRay feature works normally, and the
|
||||
plugin's configuration page tells you what is missing and how to install it.
|
||||
|
||||
Upgrading from an older JRay that did patch `index.html`? It removes its own
|
||||
patch on startup, so there is nothing to clean up by hand. See
|
||||
[SPEC.md](SPEC.md) JR-021/JR-022.
|
||||
|
||||
## Features
|
||||
|
||||
- **Pause overlay** — pause a movie or episode in the web client and see the
|
||||
actors currently on screen, without leaving the player.
|
||||
actors in the current scene, without leaving the player.
|
||||
- **Sidecar truth files** — drop a `Movie.jray.json` next to `Movie.mkv` and JRay
|
||||
picks it up automatically (suffix configurable).
|
||||
- **Remote truth push** — for servers that can't run the extraction pipeline
|
||||
@@ -63,12 +82,12 @@ Then install "JRay" from the plugin catalog and restart Jellyfin.
|
||||
```
|
||||
|
||||
1. The extraction pipeline analyses a film offline and emits a **truth file**
|
||||
listing each detected actor and the time windows they're on screen.
|
||||
listing each actor and the time windows they are present in the film.
|
||||
2. JRay loads that truth file either from a **sidecar** next to the media
|
||||
(`Movie.jray.json`) or from a **managed store** populated via the push API.
|
||||
3. On startup JRay injects a small `<script>` into the web client's `index.html`.
|
||||
When you pause, the script calls JRay for the current item and timestamp and
|
||||
renders the on-screen actors as an overlay.
|
||||
renders the scene's cast as an overlay.
|
||||
|
||||
## Truth File Format
|
||||
|
||||
@@ -93,8 +112,11 @@ configurable). Schema (`schema_version: 1`, minimal verbosity):
|
||||
}
|
||||
```
|
||||
|
||||
An actor is considered visible at timestamp `t` (seconds) if any of their
|
||||
`scenes` windows satisfies `start <= t <= end`. JRay prefers `jellyfin_id` (a
|
||||
An actor is present at timestamp `t` (seconds) if any of their `scenes` windows
|
||||
satisfies `start <= t <= end`. **A window is a claim about scene membership, not
|
||||
a recognition event** — an actor who has turned away or is off-camera during a
|
||||
reverse shot is still present, and two windows mean a genuine departure and
|
||||
return rather than a break in detection. JRay prefers `jellyfin_id` (a
|
||||
Jellyfin Person GUID) when present, otherwise resolves `imdb_id`/`tmdb_id`
|
||||
against the item's People `ProviderIds`.
|
||||
|
||||
@@ -108,7 +130,7 @@ the `X-Emby-Token: <token>` header or `Authorization: MediaBrowser Token="<token
|
||||
|
||||
| Method & Route | Auth | Description |
|
||||
| --- | --- | --- |
|
||||
| `GET /Items/{itemId}/jray?t={seconds}` | user | "Context at time t" envelope (on-screen actors), or `404`. |
|
||||
| `GET /Items/{itemId}/jray?t={seconds}` | user | "Context at time t" envelope (the scene's cast), or `404`. |
|
||||
| `GET /Items/{itemId}/Timeline` | user | Full truth file for an item, or `404` if none. |
|
||||
| `PUT /Items/{itemId}/Truth` | admin | Push managed truth data (schema v1). `204` on success, `400` on bad schema. |
|
||||
| `DELETE /Items/{itemId}/Truth` | admin | Remove managed truth data (idempotent, `204`). Falls back to sidecar. |
|
||||
@@ -129,12 +151,12 @@ the `X-Emby-Token: <token>` header or `Authorization: MediaBrowser Token="<token
|
||||
|
||||
JRay is designed so that *any* Jellyfin client (not just the bundled web overlay)
|
||||
can build an actor-overlay feature. The integration is two calls: figure out
|
||||
**what is playing and where**, then ask JRay **who is on screen**.
|
||||
**what is playing and where**, then ask JRay **who is in the scene**.
|
||||
|
||||
### 1. Query on-screen actors: `GET /Items/{itemId}/jray?t={seconds}`
|
||||
### 1. Query the scene's cast: `GET /Items/{itemId}/jray?t={seconds}`
|
||||
|
||||
Given a Jellyfin item id and a playback position in **seconds**, returns the
|
||||
actors visible at that timestamp. This is the only call most clients need.
|
||||
the actors in that scene. This is the only call most clients need.
|
||||
|
||||
**Request**
|
||||
|
||||
@@ -158,7 +180,7 @@ X-Emby-Token: <user-or-api-token>
|
||||
}
|
||||
```
|
||||
|
||||
- `actors` may be an **empty array** when no one is on screen at `t` — that's a
|
||||
- `actors` may be an **empty array** when no one is in the scene at `t` — that's a
|
||||
`200`, not a `404`.
|
||||
- `404 Not Found` means the item has **no truth data at all** (no managed upload
|
||||
and no sidecar file). Treat this as "JRay isn't available for this item" and
|
||||
@@ -174,7 +196,7 @@ X-Emby-Token: <user-or-api-token>
|
||||
|
||||
Returns the complete truth file (the [schema above](#truth-file-format)) — every
|
||||
actor with all their scene windows. Use this if you'd rather fetch once and
|
||||
compute "who's on screen" client-side (e.g. to drive a scrubber-bar heatmap)
|
||||
compute "who is in the scene" client-side (e.g. to drive a scrubber-bar heatmap)
|
||||
instead of polling `jray?t=` on each pause. `404` if no truth data exists.
|
||||
|
||||
### Reference implementation (web client)
|
||||
@@ -193,7 +215,7 @@ var s = sessions[0];
|
||||
var itemId = s.NowPlayingItem.Id;
|
||||
var t = (s.PlayState.PositionTicks || 0) / 10000000; // ticks → seconds
|
||||
|
||||
// 2. Ask JRay who is on screen. ApiClient adds the auth token for you.
|
||||
// 2. Ask JRay who is in the scene. ApiClient adds the auth token for you.
|
||||
var ctx = await ApiClient.ajax({
|
||||
url: ApiClient.getUrl('Plugins/JRay/Items/' + itemId + '/jray', { t: t }),
|
||||
type: 'GET', dataType: 'json'
|
||||
@@ -336,7 +358,7 @@ Jellyfin.Plugin.JRay/
|
||||
`<script>` tag in the web client's `index.html`, marked with `<!-- jray-overlay -->`
|
||||
so it's idempotent. Re-applied whenever configuration changes.
|
||||
5. **Overlay Script** (`jray-overlay.js`): listens for the player's pause event,
|
||||
calls `jray?t=`, and renders the on-screen actors.
|
||||
calls `jray?t=`, and renders the scene's cast.
|
||||
|
||||
## Important Notes
|
||||
|
||||
|
||||
+6
-1
@@ -19,4 +19,9 @@ dotnet_configuration: "Release"
|
||||
dotnet_framework: "net9.0"
|
||||
project: "Jellyfin.Plugin.JRay/Jellyfin.Plugin.JRay.csproj"
|
||||
changelog: >
|
||||
Initial scaffold
|
||||
The pause overlay is now served through the File Transformation plugin, which
|
||||
rewrites the web client's index.html as it is sent. JRay no longer edits that
|
||||
file on disk and there is no fallback: without File Transformation the overlay
|
||||
is disabled and every other feature works normally. Any stale on-disk patch
|
||||
left by an earlier JRay is removed on startup, and the plugin's configuration
|
||||
page now reports whether the dependency is satisfied.
|
||||
|
||||
@@ -0,0 +1,350 @@
|
||||
# jRay — requirements register
|
||||
|
||||
Stable IDs for every requirement in [`../SPEC.md`](../SPEC.md), which holds the
|
||||
prose. This file is the **authoritative list**; the CI gate reads its
|
||||
denominators from here (see [`../scripts/vendor/jray-project/SPEC.md`](../scripts/vendor/jray-project/SPEC.md) §6).
|
||||
|
||||
**IDs are permanent.** A withdrawn requirement is marked `Withdrawn` and its
|
||||
number is never reused — renumbering is what produces orphan TRACES tags. This
|
||||
register replaces the earlier section-numbering of `SPEC.md`, which gave the
|
||||
plugin no way to be traced to and left it outside the chain entirely.
|
||||
|
||||
Tag code with `// TRACES: JR-012 | SR-002`.
|
||||
|
||||
| Type | Scope |
|
||||
|---|---|
|
||||
| `JR` | Everything this plugin does — truth format, API, overlay, exchange client |
|
||||
| `UT` / `IT` | Unit / integration tests |
|
||||
|
||||
## Tests (UT)
|
||||
|
||||
| ID | Asserts | Covers | Status |
|
||||
|---|---|---|---|
|
||||
| UT-001 | Marked tag **and its trailing newline** removed — no blank line accumulates per upgrade cycle | JR-022 | **Passing** |
|
||||
| UT-002 | Marked tag with no trailing newline removed | JR-022 | **Passing** |
|
||||
| UT-003 | Document without the marker left byte-identical | JR-022 | **Passing** |
|
||||
| UT-004 | Removal is idempotent — startup runs it on every boot forever after | JR-022 | **Passing** |
|
||||
| UT-005 | **Another plugin's injection left intact** — it is their file too | JR-022 | **Passing** |
|
||||
| UT-006 | An unmarked look-alike script tag is left alone — JRay did not write it | JR-022 | **Passing** |
|
||||
| UT-007 | No matching rule resolves to `null` | JR-016 | **Passing** |
|
||||
| UT-008 | Item rule beats Series rule | JR-016 | **Passing** |
|
||||
| UT-009 | **Prioritised series inside an ignored genre — series wins** | JR-016 | **Passing** |
|
||||
| UT-010 | Genre matching is case-insensitive | JR-016 | **Passing** |
|
||||
| UT-011 | A Series rule valued `Guid.Empty` does not swallow every movie | JR-016 | **Passing** |
|
||||
| UT-012 | `TryRegister` returns `false` when File Transformation is absent | JR-023 | **Passing** |
|
||||
| UT-013 | …and **warns** naming the install URL, with no "falling back" claim | JR-023 | **Passing** |
|
||||
| UT-014 | Overlay disabled ⇒ `index.html` returned unchanged | JR-023 | **Passing** |
|
||||
| UT-015 | Null contents return empty rather than throwing — this callback runs on every page another plugin serves | JR-023 | **Passing** |
|
||||
| UT-016 | Both bounds **inclusive** — start, interior and end all present | JR-005 | **Passing** |
|
||||
| UT-017 | Just outside either bound is absent | JR-005 | **Passing** |
|
||||
| UT-018 | A zero-length window is a real sighting, not a degenerate one to discard | JR-005 | **Passing** |
|
||||
| UT-019 | **Overlapping windows** — present inside an enclosing window | JR-005 | **Passing** |
|
||||
| UT-020 | **Unsorted windows still resolve**; sortedness is a producer guarantee, not a correctness dependency | JR-006 | **Passing** |
|
||||
| UT-021 | **Adjacent windows are never merged** — reported once, from two windows | JR-004 | **Passing** |
|
||||
| UT-022 | Truth file round-trips with windows byte-identical | JR-004 | **Passing** |
|
||||
| UT-023 | 50 actors × 1000 windows: response bounded by actor count, lookup not quadratic | JR-006 | **Passing** |
|
||||
| UT-024 | A fetched claim round-trips: server, tier, **offset**, caveat, timestamp | JR-010 | **Passing** |
|
||||
| UT-025 | A local push records no server and **no tier** — there is no cut to match | JR-010 | **Passing** |
|
||||
| UT-026 | Provenance is **not** written into the truth file | JR-010, JR-004 | **Passing** |
|
||||
| UT-027 | `Delete` removes provenance too — no record outliving its claim | JR-010 | **Passing** |
|
||||
| UT-028 | Unknown item yields null rather than a fabricated record | JR-010 | **Passing** |
|
||||
|
||||
All execute and pass. The suite is also checked to **fail** on deliberate
|
||||
mutations, because a suite that has only ever passed is not evidence that it
|
||||
tests anything. Three so far, each restored and re-verified afterwards:
|
||||
|
||||
| Mutation | Fails | Blast radius |
|
||||
|---|---|---|
|
||||
| Drop the newline-stripping in `RemoveInjection` | UT-001 | 1 test |
|
||||
| Downgrade the missing-dependency warning to `Information` | UT-013 | 1 test |
|
||||
| Make the window end bound exclusive (`t < end`) | UT-016, UT-018 | 2 tests |
|
||||
| Stop `Delete` removing provenance | UT-027 | 1 test |
|
||||
|
||||
The third is the one worth keeping: a single character turns an inclusive window
|
||||
into a half-open one, which would drop an actor at exactly the moment a scene
|
||||
ends — and nothing else in the suite would have noticed.
|
||||
|
||||
`JR` is flat rather than split by theme. The plugin is one deployable with one
|
||||
audience, and the thematic grouping lives in the section headings below, where it
|
||||
costs nothing and cannot go stale against a prefix.
|
||||
|
||||
Status: `Done` · `In Progress` · `Planned` · `TBD` · `Withdrawn`
|
||||
|
||||
---
|
||||
|
||||
## Truth-file format (JR-001 … JR-007)
|
||||
|
||||
jRay **owns** this format ([system spec](../scripts/vendor/jray-project/SPEC.md) §1); extraction is the
|
||||
producer and the public server carries a derived envelope. Changes are
|
||||
coordinated `schema_version` bumps (SR-003).
|
||||
|
||||
| ID | Requirement | Traces to | Priority | Status |
|
||||
|---|---|---|---|---|
|
||||
| JR-001 | The truth-file format is normatively defined here; other repos reference it rather than restating it | SR-003 | High | In Progress |
|
||||
| JR-002 | `schema_version: 2` shape — `extraction.*` provenance block, `cut.*` block, `scenes` as objects carrying belief and route | SR-003 | High | Planned |
|
||||
| JR-003 | Reject an unknown `schema_version`, never guess. **Flag day: v2 only**, no dual-accept | SR-003 | High | Planned |
|
||||
| JR-004 | A window is a **scene-membership claim**, not a recognition event — never reinterpreted, merged, split or trimmed | **SR-002** | High | **Done** (UT-021, UT-022) |
|
||||
| JR-005 | Query semantics: actor present at `t` if any window contains `t`; presentation must not assert instantaneous visibility | **SR-002** | High | **Done** (UT-016…019) |
|
||||
| JR-006 | Read path holds up under **numerous** windows — no assumption of a handful of long ones | SR-002 | Medium | **Done** (UT-020, UT-023) |
|
||||
| JR-007 | Identity is public identifiers: prefer `jellyfin_id` locally, else resolve `imdb_id`/`tmdb_id` against the item's People `ProviderIds` | SR-001 | High | Done |
|
||||
|
||||
## Truth-data sources and precedence (JR-008 … JR-011)
|
||||
|
||||
| ID | Requirement | Traces to | Priority | Status |
|
||||
|---|---|---|---|---|
|
||||
| JR-008 | Discover a sidecar truth file beside the media, by configurable suffix | PR-001 | High | Done |
|
||||
| JR-009 | Accept truth data pushed by a remote worker (`PUT`/`DELETE`), admin key | PR-004 | High | Done |
|
||||
| JR-010 | Precedence: managed truth (pushed **or** fetched) overrides a sidecar; provenance is recorded so the UI can distinguish the three sources | PR-001 | High | **Done** (UT-024…028) |
|
||||
| JR-011 | Loaded truth is cached; any write invalidates the item's cache entry immediately | PR-001 | Medium | Done |
|
||||
|
||||
## Read API (JR-012 … JR-014)
|
||||
|
||||
| ID | Requirement | Traces to | Priority | Status |
|
||||
|---|---|---|---|---|
|
||||
| JR-012 | `GET .../Timeline` returns the full truth file for an item | PR-001 | High | Done |
|
||||
| JR-013 | `GET .../jray?t=` returns an **extensible** context envelope; consumers ignore unknown keys | PR-001 | High | Done |
|
||||
| JR-014 | Authorisation: reads need an authenticated user, admin routes need the Administrator role, only `ClientScript` is anonymous | PR-004 | High | Done |
|
||||
|
||||
## Work discovery, policy and coverage (JR-015 … JR-019)
|
||||
|
||||
| ID | Requirement | Traces to | Priority | Status |
|
||||
|---|---|---|---|---|
|
||||
| JR-015 | `Tasks/Pending` serves a random sample of items with no truth data, so pollers spread across the backlog without server-side task state | PR-003 | High | Done |
|
||||
| JR-016 | Prioritise/ignore rules scoped `Genre` / `Series` / `Item`; **most specific wins**; scope+value is the unique key | PR-003 | Medium | **Done** (UT-007…011) |
|
||||
| JR-017 | Rules steer **work discovery only** — never the overlay or the read endpoints | PR-003 | Medium | Done |
|
||||
| JR-018 | Coverage report by media type and genre; ignored items leave the percent-done denominator rather than dragging it down | PR-003 | Medium | Done |
|
||||
| JR-019 | Picker endpoints (genres, series, item search) populate the rule editor | PR-003 | Low | Done |
|
||||
|
||||
## Player overlay (JR-020 … JR-024)
|
||||
|
||||
| ID | Requirement | Traces to | Priority | Status |
|
||||
|---|---|---|---|---|
|
||||
| JR-020 | Pause overlay: injected client script queries `jray?t=` and renders the scene's cast | **PR-001** | High | Done |
|
||||
| JR-021 | **jRay never injects into `index.html` on disk.** File Transformation is a hard dependency; there is no on-disk fallback. The only permitted write is JR-022's removal | PR-004 | High | **Done** |
|
||||
| JR-022 | Migration: remove any on-disk patch left by an earlier jRay, identified by the `<!-- jray-overlay -->` marker | PR-004 | High | **Done** (UT-001…006) |
|
||||
| JR-023 | Absent the dependency, disable **only** the overlay and say so in the log and the config page; never bundle the assembly | PR-004 | Medium | **Done** (UT-012…015; config page is T4) |
|
||||
| JR-024 | Actor names and all server-supplied strings render as **text, never markup** | SR-004 | High | Done |
|
||||
|
||||
## Manifest exchange client (JR-025 … JR-037)
|
||||
|
||||
Plugin-side requirements for the exchange specified in
|
||||
[`../../JRay-public-server/SPEC.md`](../../JRay-public-server/SPEC.md) §9. The
|
||||
wire format is the server's; **the client's obligations are jRay's**, and belong
|
||||
in this register rather than in the server's spec.
|
||||
|
||||
The server's register already anticipates this: its `UR-007` is recorded as
|
||||
having "no server-side test and cannot have one — it is a requirement on the
|
||||
plugin", to be cross-referenced from the plugin's register once one exists. This
|
||||
is that register, and `JR-025` is that row. `UR-007` should now point here and
|
||||
stay `In Progress` until `JR-025` is `Done`.
|
||||
|
||||
| ID | Requirement | Traces to | Priority | Status |
|
||||
|---|---|---|---|---|
|
||||
| JR-025 | Query an **ordered list** of servers; first result clearing the configured tier wins — **satisfies `JRay-public-server` UR-007** | PR-006 | High | Done |
|
||||
| JR-026 | For a series, first-match applies per **episode** — later servers are queried only for the episodes earlier ones lacked | PR-006 | Medium | Planned |
|
||||
| JR-027 | Treat **every** server as untrusted, including the default: re-validate on receipt against the strict upload schema, bounds-check windows against the item's real runtime | SR-004 | High | Done |
|
||||
| JR-028 | Enforce response size caps **while streaming** — 2 MiB single, 25 MiB bundle — aborting rather than buffering | SR-004 | High | Done |
|
||||
| JR-029 | HTTPS required for non-loopback servers; certificate validation must not be disabled | SR-004 | High | Done |
|
||||
| JR-030 | Apply an `audio`-tier `offset` to **every** window before storing — stored truth is always in the local file's timebase, so read paths need no offset awareness | SR-003 | High | Done |
|
||||
| JR-031 | Fetch endpoints: item fetch, series bundle fetch, per-server status, content identify | PR-006 | High | Planned |
|
||||
| JR-032 | Identify is **never automatic** — storing a candidate is a separate confirmation step | PR-006 | Medium | Planned |
|
||||
| JR-033 | Scheduled sweep over items lacking truth data, using the **batch** `exists` endpoint | PR-006 | Medium | Planned |
|
||||
| JR-034 | Contribution strips `movie` and `jellyfin_id`, attaches identity from `ProviderIds` plus measured runtime, and posts **only** to contribute-enabled servers — never fanned out | PR-005 | High | Planned |
|
||||
| JR-035 | Uploads set `Expect: 100-continue`, so a rejection lands before a bundle body is transmitted | PR-006 | Low | Planned |
|
||||
| JR-036 | Minimum accepted match tier is configurable; a `loose` match surfaces as a caveat rather than being applied silently | PR-006 | Medium | In Progress |
|
||||
| JR-037 | A server that is unreachable or failing is skipped on a short timeout with backoff; one dead server never stalls a sweep | PR-006 | Medium | Done |
|
||||
|
||||
## Egress and privacy (JR-038 … JR-041)
|
||||
|
||||
`PR-005` had **no software row in any repo** — it was held structurally, by
|
||||
SR-004 and GR-005 both being prohibitions. jRay is the component that actually
|
||||
performs egress, so these are the rows that make it verifiable rather than merely
|
||||
preserved.
|
||||
|
||||
| ID | Requirement | Traces to | Priority | Status |
|
||||
|---|---|---|---|---|
|
||||
| JR-038 | Every exchange feature is **opt-in and off by default**, including the pre-configured community server | **PR-005** | High | Done |
|
||||
| JR-039 | No library-wide inventory in one request: batch `exists` capped at 100 items, sweeps paced | **PR-005** | High | Planned |
|
||||
| JR-040 | The config page states plainly that **each configured server multiplies the exposure** | **PR-005** | Medium | Planned |
|
||||
| JR-041 | The plugin never fetches, stores, or transmits gallery data — reference faces or embeddings. It has no gallery code path at all | **SR-005** | High | Done |
|
||||
|
||||
## Audio signature (JR-042 … JR-045)
|
||||
|
||||
Mirror-image of extraction `IR-004`/`IR-005`/`IR-007`/`IR-008`. Both producers
|
||||
must agree **bit-for-bit**, so each obligation is stated on both sides rather
|
||||
than assumed to be inherited.
|
||||
|
||||
| ID | Requirement | Traces to | Priority | Status |
|
||||
|---|---|---|---|---|
|
||||
| JR-042 | Compute the signature **exactly** per server spec §3, using the FFmpeg binary Jellyfin already ships via `IMediaEncoder.EncoderPath` — no new dependency | SR-003 | Medium | Planned |
|
||||
| JR-043 | Golden-vector fixture **shared with the extraction repo**, proving the two implementations are bit-exact | SR-003 | High | Planned |
|
||||
| JR-044 | Media shorter than 120 s: emit no signature and apply no sync offset — identical rule in both producers | SR-003 | Low | Planned |
|
||||
| JR-045 | Emit and honour the signature's own `v1:` prefix, so a DSP change is detectable rather than silently non-matching | SR-003 | Low | Planned |
|
||||
|
||||
## Human-in-the-loop association (JR-046)
|
||||
|
||||
| ID | Requirement | Traces to | Priority | Status |
|
||||
|---|---|---|---|---|
|
||||
| JR-046 | Review UI for unidentified track clusters: show context crops, pick from the title's cast or search TMDB, record the association | [system §4](../scripts/vendor/jray-project/SPEC.md) | Medium | **TBD** |
|
||||
|
||||
Deliberately a single placeholder row rather than a decomposed set. It depends on
|
||||
extraction `AR-021`/`AR-022` landing, and on system open question 2 (whether
|
||||
unidentified presence is published at all) — decomposing it now would fix an
|
||||
interface against an undecided upstream.
|
||||
|
||||
**It carries tiers (T2 + T4) despite being undesigned, and stays in the coverage
|
||||
denominator.** Tiers say *how* it will be verified, which is knowable — an
|
||||
association endpoint is CI-testable, the UI is not — without asserting *what*
|
||||
the assertions are, which is not. Recording it as T4-only would have been the
|
||||
tempting move, because that drops it out of CI scope and lifts the CI
|
||||
percentage; it would also have been the 158%-coverage error in miniature, a
|
||||
number improved by reclassifying work rather than by doing it. An unbuilt
|
||||
requirement should count against coverage until it is built.
|
||||
|
||||
---
|
||||
|
||||
## Verification strategy
|
||||
|
||||
**CI is an Intel N100** ([system spec](../scripts/vendor/jray-project/SPEC.md) §6). Unlike the extraction
|
||||
pipeline this costs jRay almost nothing: the plugin is CPU-only managed code, and
|
||||
every requirement above except the live-integration ones is executable in CI.
|
||||
|
||||
| Tier | Runs in CI | What it covers |
|
||||
|---|---|---|
|
||||
| **T1 — Unit** | Yes | Parsing, precedence, policy resolution, coverage arithmetic, offset application, audio DSP, schema rejection |
|
||||
| **T2 — Host integration** | Yes | Controllers and authorisation against a test host with a faked `ILibraryManager` |
|
||||
| **T4 — Live** | **No** | Real Jellyfin + File Transformation + web client; real manifest server round-trip |
|
||||
| **static** | Yes | Grep/analyzer checks — e.g. no injection path into `index.html` (JR-021) |
|
||||
|
||||
**T3 is deliberately unused.** Executable tiers are declared per repo in
|
||||
[`../traceability.toml`](../traceability.toml), so the numbering is a local
|
||||
choice — but jRay keeps **T4** for "no CI host can run this" because that is
|
||||
what T4 means in `scene-actor-extraction`. A tier number should mean the same
|
||||
thing when read across repos; reusing T3 for a live tier here would make a
|
||||
cross-repo reader count live-only requirements as covered.
|
||||
|
||||
`Jellyfin.Plugin.JRay.Tests` (xUnit, in the solution) carries the T1 tier. It
|
||||
builds clean alongside the plugin and all 15 tests pass.
|
||||
|
||||
### Running the suite on a box without the web runtime
|
||||
|
||||
`dotnet test` from the repo root. Two properties on the test project make that
|
||||
work anywhere, and both are load-bearing rather than incidental:
|
||||
|
||||
- **`RollForward=LatestMajor`.** The plugin targets `net9.0` to match Jellyfin's
|
||||
ABI, but a machine that can *build* it need not have the 9.0 runtime. Rolling
|
||||
the test host forward keeps the suite runnable without pinning developers to a
|
||||
runtime the plugin does not otherwise need.
|
||||
- **`DisableTransitiveFrameworkReferences=true`.** The plugin
|
||||
framework-references `Microsoft.AspNetCore.App` through `Jellyfin.Controller`,
|
||||
and that flows into anything referencing it — so the test host would otherwise
|
||||
demand a web runtime that no version of exists in the Arch repositories for
|
||||
.NET 9 (8 and 10 only).
|
||||
- **Explicit `Jellyfin.Controller` / `Jellyfin.Model` references.** The plugin
|
||||
sets `ExcludeAssets=runtime` on both, because at run time the *server* supplies
|
||||
them and shipping copies would risk loading a second, different
|
||||
`MediaBrowser.Common`. The test host is not the server, so it must bring its
|
||||
own — hence the same packages without that exclusion, and only in the test
|
||||
project.
|
||||
|
||||
Those two together are what make it work: the first drops the demand for the web
|
||||
*framework*, the second supplies the Jellyfin *assemblies*. Cutting the framework
|
||||
reference alone is not enough — `ILogger` and `MediaBrowser.Common` live in the
|
||||
excluded assets, so anything beyond genuinely dependency-free logic fails to load
|
||||
with `FileNotFoundException` at run time rather than at build.
|
||||
|
||||
**T2 — controllers and authorisation — is still a separate matter**, since
|
||||
instantiating MVC types needs the ASP.NET Core runtime itself, not just its
|
||||
reference assemblies. Those tests belong in a second project that keeps the
|
||||
framework reference and leans on `RollForward` to reach the 10.0 runtime.
|
||||
|
||||
### Per-requirement verification plan
|
||||
|
||||
| ID | Tier | Test asserts | Edge cases to cover |
|
||||
|---|---|---|---|
|
||||
| JR-001 | static | Other repos' specs link here rather than restating the schema | A second copy of the schema anywhere is the failure |
|
||||
| JR-002 | T1 | A v2 file round-trips; `scenes` objects retain belief and route | Window with belief exactly at the ownership threshold; all three route values |
|
||||
| JR-003 | **T1** | `schema_version` 1 and 3 are both **rejected**, not coerced | Missing field entirely; non-integer value |
|
||||
| JR-004 | T1 | Windows are stored and served byte-identical to input | Adjacent windows that "look" mergeable must **not** merge |
|
||||
| JR-005 | T1 | `t` exactly on `start` and on `end` are both present | Zero-length window; overlapping windows for one actor |
|
||||
| JR-006 | T1 | Response bounded by actor count, not window count; lookup not quadratic | 50 × 1000 windows; **unsorted input still resolves** — sortedness is a producer guarantee, never a correctness dependency |
|
||||
| JR-007 | T1 | `jellyfin_id` preferred; falls back to provider ids | All three ids empty → actor still displayable by name |
|
||||
| JR-008 | T1 | Sidecar path derived from the item path plus the configured suffix | Item with no path; suffix changed at runtime |
|
||||
| JR-009 | T2 | `PUT` stores, `DELETE` removes, both admin-only | `DELETE` on an item with no managed truth is still `204` |
|
||||
| JR-010 | T1 | Managed overrides sidecar; provenance survives a round trip and is deleted with its truth | Fetched vs pushed for the same item; **provenance never inside the truth file**; unknown item yields null |
|
||||
| JR-011 | T1 | A write invalidates the cached entry immediately | Read, push, read again within the cache window |
|
||||
| JR-012 | T2 | Returns the file, or `404` when no source has data | Sidecar present but unparseable |
|
||||
| JR-013 | T2 | Envelope shape is stable; extra keys are additive | Item with truth data but no actor present at `t` |
|
||||
| JR-014 | T2 | Anonymous request to each admin route is refused | Authenticated non-admin on an admin route |
|
||||
| JR-015 | T2 | Sample excludes covered items and clamps `limit` | `limit` of 0 and of 1000; library of missing-path ghosts |
|
||||
| JR-019 | T2 | Pickers return `{value,label}`; empty search returns `[]` | Two episodes named "Pilot" — labels must disambiguate |
|
||||
| JR-020 | **T4** | Overlay appears on pause and lists the scene cast | Live web client only |
|
||||
| JR-016 | T1 | Item beats Series beats Genre | Prioritised series inside an ignored genre — the case that motivated the rule |
|
||||
| JR-017 | **T1** | An ignored item still serves its overlay | Rule added after truth data exists |
|
||||
| JR-018 | T1 | `covered / (total - ignored)` | Item carrying two genres counts in both rows |
|
||||
| JR-021 | **static** | No code path *adds* the script tag to `index.html` | `scripts/checks/no-index-injection.sh`. Removal (JR-022) is the one permitted write, so the check is on injection, not on writing. Verified to **fail** on a reintroduced `Apply()` and on reintroduced `ReplaceLast` injection, not merely to pass today |
|
||||
| JR-022 | T1 | A marked legacy patch is removed; unmarked content untouched | Foreign plugin's injection left intact |
|
||||
| JR-023 | T1 + **T4** | Absent dependency disables only the overlay, and the log says so | Detection and log content covered by UT-012…015; the config-page banner is T4, verifiable only against a live server |
|
||||
| JR-024 | T1 | A name containing markup renders escaped | `<script>` in an actor name from a hostile server |
|
||||
| JR-025 | T1 | First result clearing the tier wins; disabled servers skipped | All servers fail; first server returns a below-tier match |
|
||||
| JR-026 | T1 | Server 2 queried only for episodes server 1 lacked | Bundle with a gap in the middle of a season |
|
||||
| JR-027 | T1 | Unknown field, oversized body, and out-of-range window each rejected | Window ending beyond the item's runtime |
|
||||
| JR-028 | T1 | Stream aborts past the cap rather than buffering | Server declaring a small length and sending more |
|
||||
| JR-029 | T1 | Plain `http` to a non-loopback host is refused | `http://localhost` allowed; `http://192.168.x` refused |
|
||||
| JR-030 | **T1** | Offset added to every window before storage | Negative offset; offset that would push a window below zero |
|
||||
| JR-031 | T2 | All four routes exist and are admin-only | — |
|
||||
| JR-032 | T1 | `Identify` returns candidates and stores nothing | A single high-confidence candidate still does not auto-store |
|
||||
| JR-033 | T1 | Sweep batches through `exists` and paces | Backlog smaller than one batch |
|
||||
| JR-034 | **T1** | `movie` and `jellyfin_id` absent from the upload body | Contribution attempted to a `FetchOnly` server must not send |
|
||||
| JR-035 | T1 | `Expect: 100-continue` set on uploads | — |
|
||||
| JR-036 | T1 | Below-tier match is not stored; `loose` is flagged | Tier configured to `audio` with only a `runtime` match available; **`MatchTier` has no `Exact` member** — the file-hash tier is withdrawn on legal grounds, so a test naming it would not compile |
|
||||
| JR-037 | T1 | Failing server skipped, backoff grows | Every server failing must not hang the sweep |
|
||||
| JR-038 | **T1** | Every exchange switch defaults off; community server disabled | Fresh config object, no user input |
|
||||
| JR-039 | T1 | Batch never exceeds 100 items | Library of 10⁴ items produces a paced sweep |
|
||||
| JR-040 | **T4** | Config page states the per-server exposure | Manual review of copy |
|
||||
| JR-041 | **static** | No embedding or image field is parsed or stored | Grep-based, mirroring the server's UR-012 |
|
||||
| JR-042 | T1 | DSP chain matches the specified parameters exactly | Window, hop, band, bin count each asserted individually |
|
||||
| JR-043 | **T1** | Signature matches the shared golden vector **bit-for-bit** | Media < 120 s → no signature; identical result in both repos |
|
||||
| JR-044 | T1 | Media < 120 s yields no signature and no offset | Exactly 120 s — the boundary both repos must agree on |
|
||||
| JR-045 | T1 | `v1:` emitted; an unknown prefix is refused, not parsed | `v2:` signature from a future producer |
|
||||
| JR-046 | T2 + **T4** | *Assertions deferred* — recording an association and persisting it is T2; the review UI itself is T4 | Cannot be written until the truth-file interface for unidentified presence is settled (system open question 2) and AR-021/AR-022 land |
|
||||
|
||||
Three are worth singling out. **JR-021** and **JR-041** are static checks because
|
||||
both are requirements to *not do something*, and a prohibition is verified by
|
||||
absence, not by a passing test. **JR-043** is the cross-repo check: it is the only
|
||||
test in this repo whose fixture is shared with another, and it is CPU-only DSP,
|
||||
which is exactly why it can be the binding check rather than an aspiration.
|
||||
|
||||
---
|
||||
|
||||
## Running the gate
|
||||
|
||||
The extractor is shared and vendored, never forked — there must only ever be one
|
||||
implementation. Everything that varies per repo lives in
|
||||
[`../traceability.toml`](../traceability.toml), so the invocation carries no
|
||||
flags to drift out of sync between a developer's shell and CI:
|
||||
|
||||
```sh
|
||||
python3 scripts/vendor/jray-project/scripts/traceability/extract_traces.py \
|
||||
--root . --format coverage
|
||||
```
|
||||
|
||||
That config declares the `JR` prefix, the languages, the source roots, the
|
||||
CI-executable tiers, and the path to the vendored system spec.
|
||||
|
||||
Refresh the pinned tooling with
|
||||
`git submodule update --remote scripts/vendor/jray-project`.
|
||||
|
||||
Two choices in it are worth knowing about. `scripts/checks` is scanned so the
|
||||
**static checks carry their own TRACES tags** — an enforcement script is
|
||||
evidence for a requirement exactly as a unit test is. And the source roots are
|
||||
listed individually rather than as `scripts`, because the latter would walk
|
||||
`scripts/vendor/jray-project` and harvest the `AR-nnn` examples in the
|
||||
extractor's own docstrings as orphan tags.
|
||||
|
||||
`JR` is now what the shared tooling expects too — its example config names
|
||||
`jRay: ["JR"]` — so the prefix is settled across all three repos. It was chosen
|
||||
because `JRay-public-server` already ships `UR-001…018` and `DR-001…014`, and a
|
||||
second repo reusing those prefixes would make `UR-007` ambiguous across
|
||||
registers, which is precisely the ID the server's own register asks this one to
|
||||
cross-reference (see JR-025).
|
||||
@@ -7,6 +7,46 @@
|
||||
"owner": "dtourolle",
|
||||
"category": "General",
|
||||
"versions": [
|
||||
{
|
||||
"version": "0.0.0.0",
|
||||
"changelog": "Latest Build",
|
||||
"targetAbi": "10.9.0.0",
|
||||
"sourceUrl": "https://gitea.tourolle.paris/dtourolle/jRay/releases/download/latest/jray_0.0.0.0.zip",
|
||||
"checksum": "d3419f1867499fbc63fb485fb7c6c143",
|
||||
"timestamp": "2026-07-31T09:37:36Z"
|
||||
},
|
||||
{
|
||||
"version": "0.0.4",
|
||||
"changelog": "Release 0.0.4",
|
||||
"targetAbi": "10.9.0.0",
|
||||
"sourceUrl": "https://gitea.tourolle.paris/dtourolle/jRay/releases/download/v0.0.4/jray_0.0.4.0.zip",
|
||||
"checksum": "cb9613660b3fe3b730f46c9c7f257333",
|
||||
"timestamp": "2026-07-04T19:47:05Z"
|
||||
},
|
||||
{
|
||||
"version": "0.0.0.0",
|
||||
"changelog": "Latest Build",
|
||||
"targetAbi": "10.9.0.0",
|
||||
"sourceUrl": "https://gitea.tourolle.paris/dtourolle/jRay/releases/download/latest/jray_0.0.0.0.zip",
|
||||
"checksum": "a76316397228c9d8b8e38fbccad50390",
|
||||
"timestamp": "2026-07-04T19:44:35Z"
|
||||
},
|
||||
{
|
||||
"version": "0.0.3",
|
||||
"changelog": "Release 0.0.3",
|
||||
"targetAbi": "10.9.0.0",
|
||||
"sourceUrl": "https://gitea.tourolle.paris/dtourolle/jRay/releases/download/v0.0.3/jray_0.0.3.0.zip",
|
||||
"checksum": "da5ded2ee720f7a7f7e15ac092871a91",
|
||||
"timestamp": "2026-07-04T19:11:39Z"
|
||||
},
|
||||
{
|
||||
"version": "0.0.0.0",
|
||||
"changelog": "Latest Build",
|
||||
"targetAbi": "10.9.0.0",
|
||||
"sourceUrl": "https://gitea.tourolle.paris/dtourolle/jRay/releases/download/latest/jray_0.0.0.0.zip",
|
||||
"checksum": "0d1cc8954a1b0557eb5ec6c368bce486",
|
||||
"timestamp": "2026-07-04T19:10:48Z"
|
||||
},
|
||||
{
|
||||
"version": "0.0.2",
|
||||
"changelog": "Release 0.0.2",
|
||||
|
||||
Executable
+44
@@ -0,0 +1,44 @@
|
||||
#!/usr/bin/env bash
|
||||
# JR-021 — jRay never injects into index.html on disk.
|
||||
#
|
||||
# This is a requirement to *not do* something, so it is verified by absence.
|
||||
# A unit test cannot show that no code path writes the tag; a grep can.
|
||||
#
|
||||
# The prohibition is on injection, not on writing: JR-022's migration must write
|
||||
# to index.html in order to remove a legacy patch. So the check is for code that
|
||||
# *adds* the script tag, not for File.Write* generally.
|
||||
#
|
||||
# TRACES: JR-021 | PR-004
|
||||
set -euo pipefail
|
||||
|
||||
cd "$(dirname "$0")/../.."
|
||||
src="Jellyfin.Plugin.JRay"
|
||||
status=0
|
||||
|
||||
# The injection is "script tag + marker" written back to the file. The removal
|
||||
# path also names both, so match on the concatenation that builds a patched
|
||||
# document rather than on the constants themselves.
|
||||
if grep -rn --include='*.cs' -E '(ScriptTag|Injected)[[:space:]]*\+.*BodyClose|ReplaceLast|"</body>"[[:space:]]*,' "$src" \
|
||||
| grep -v 'FileTransformationRegistration.cs'; then
|
||||
echo "FAIL (JR-021): index.html injection logic found outside the File Transformation callback." >&2
|
||||
status=1
|
||||
fi
|
||||
|
||||
# WebClientPatchService is removal-only. Any write there must be the cleaned
|
||||
# document; a write of a *patched* one is the regression this guards.
|
||||
if grep -n -E 'WriteAllText\((?!.*cleaned)' -P "$src/Services/WebClientPatchService.cs" >/dev/null 2>&1; then
|
||||
echo "FAIL (JR-021): WebClientPatchService writes something other than the cleaned document." >&2
|
||||
status=1
|
||||
fi
|
||||
|
||||
# The disk-patching entry point must not come back.
|
||||
if grep -rn --include='*.cs' -E '\bWebClientPatchService\.Apply\b' "$src"; then
|
||||
echo "FAIL (JR-021): the injecting Apply() entry point has been reintroduced." >&2
|
||||
status=1
|
||||
fi
|
||||
|
||||
if [ "$status" -eq 0 ]; then
|
||||
echo "OK (JR-021): no on-disk injection path."
|
||||
fi
|
||||
|
||||
exit "$status"
|
||||
+1
Submodule scripts/vendor/jray-project added at 17106f3370
@@ -0,0 +1,31 @@
|
||||
# traceability.toml — per-repo configuration for the shared trace extractor.
|
||||
# The extractor itself is vendored at scripts/vendor/jray-project.
|
||||
|
||||
# Flat, rather than split by theme as scene-actor-extraction is. The plugin is
|
||||
# one deployable with one audience, and JRay-public-server already ships UR/DR
|
||||
# — a second repo using those prefixes would make UR-007 ambiguous across
|
||||
# registers, and UR-007 is precisely the ID the server asks this register to
|
||||
# cross-reference (see JR-025).
|
||||
requirement_types = ["JR"]
|
||||
|
||||
languages = ["csharp", "javascript"]
|
||||
|
||||
# The static checks carry TRACES tags of their own. An enforcement script is
|
||||
# evidence for a requirement exactly as a unit test is — JR-021 is a
|
||||
# prohibition, and a prohibition can only be verified by absence.
|
||||
source_suffixes = [".sh"]
|
||||
|
||||
# Explicit roots rather than "scripts", which would walk scripts/vendor and
|
||||
# harvest the AR-nnn examples in the extractor's own docstrings as orphan tags.
|
||||
source_roots = [
|
||||
"Jellyfin.Plugin.JRay",
|
||||
"Jellyfin.Plugin.JRay.Tests",
|
||||
"scripts/checks",
|
||||
]
|
||||
|
||||
# jRay has two CI tiers and one live tier. T3 is deliberately unused: T4 keeps
|
||||
# the meaning it has in scene-actor-extraction — "no CI host can run this" —
|
||||
# so a tier number means the same thing when read across repos.
|
||||
ci_executable_tiers = ["T1", "T2", "static"]
|
||||
|
||||
system_spec = "scripts/vendor/jray-project/SPEC.md"
|
||||
Reference in New Issue
Block a user