plugin: ship JFVR as a real Jellyfin plugin (self-hosted catalog)
Replaces the deploy.py approach (which sed-patched index.html inside the
container, and was therefore lost on every jellyfin/jellyfin upgrade) with a
proper plugin installable from a Jellyfin plugin repository.
The web bundle is unchanged: the same src/*.js -> dist/jfvr.js is now embedded
in Jellyfin.Plugin.JFVR.dll and served from /JFVR/jfvr.js with a content-hash
cache key. index.html is rewritten at request time by an IStartupFilter
middleware, so nothing on disk is touched.
Verified before this commit:
- dotnet build: 0 warnings, 0 errors (net10.0, Jellyfin.Controller 12.1.0)
- the DLL embeds dist/jfvr.js byte for byte
- 19/19 checks on the rewrite logic (injection, idempotency, legacy-tag
takeover, no </body> safety, other scripts preserved, URL override)
- manifest.json passes Jellyfin's PackageInfo/VersionInfo expectations
- the packaged zip's MD5 matches the checksum the manifest advertises
Details that were checked against the Jellyfin source rather than assumed:
- a catalog version survives when targetAbi <= serverVersion, so a single
targetAbi 12.0.0.0 package covers all of 12.x (server is 12.1.0)
- Jellyfin writes meta.json itself at install time, so the zip needs only
the DLL
- Jellyfin verifies the MD5 at install time
Also adds pack.py (build -> package -> manifest -> Gitea release) and documents
the plugin route in README/HANDOFF, keeping deploy.py as a fallback.
This commit is contained in:
@@ -0,0 +1,129 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Jellyfin Web VR</title>
|
||||
</head>
|
||||
<body>
|
||||
<div id="JfvrConfigPage" data-role="page" class="page type-interior pluginConfigurationPage">
|
||||
<div data-role="content">
|
||||
<div class="content-primary">
|
||||
<form id="JfvrConfigForm">
|
||||
<div class="verticalSection">
|
||||
<div class="sectionTitleContainer flex align-items-center">
|
||||
<h2 class="sectionTitle">Jellyfin Web VR</h2>
|
||||
<a is="emby-linkbutton" class="raised raised-mini emby-button" style="margin-left:2em"
|
||||
target="_blank" rel="noopener"
|
||||
href="https://git.cat-shark.xyz/cat-shark/jellyfin_vr_web_plugin">
|
||||
<i class="md-icon button-icon button-icon-left secondaryText"></i>
|
||||
<span>Help</span>
|
||||
</a>
|
||||
</div>
|
||||
<p class="fieldDescription">
|
||||
在 jellyfin-web 的 <code>index.html</code> 里注入 VR 播放脚本,让 Quest 3
|
||||
浏览器直接进入 VR180 / VR360 沉浸播放。改写发生在请求时,磁盘上的文件不会被改动,
|
||||
所以 Jellyfin 升级不会丢掉注入。
|
||||
</p>
|
||||
<p class="fieldDescription">
|
||||
<strong>改完设置后需要刷新浏览器</strong>(<code>index.html</code> 本身没有强缓存,
|
||||
普通刷新即可)。
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div class="checkboxContainer checkboxContainer-withDescription">
|
||||
<label>
|
||||
<input is="emby-checkbox" type="checkbox" id="chkEnabled" />
|
||||
<span>启用注入</span>
|
||||
</label>
|
||||
<div class="fieldDescription checkboxFieldDescription">
|
||||
关闭后 <code>index.html</code> 原样返回,不再注入;脚本端点仍然可以访问。
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="inputContainer">
|
||||
<input is="emby-input" type="text" id="txtScriptUrl" label="脚本 URL 覆盖(可选)" />
|
||||
<div class="fieldDescription">
|
||||
留空则使用插件内置的 bundle:<code id="builtinUrl">/JFVR/jfvr.js</code>。
|
||||
填了就注入这个 URL(例如自建 CDN 上的副本),内置 bundle 不再使用。
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<button is="emby-button" type="submit" class="raised button-submit block">
|
||||
<span>保存</span>
|
||||
</button>
|
||||
</div>
|
||||
|
||||
<div class="verticalSection" style="margin-top:1.5em">
|
||||
<h3 class="sectionTitle" style="font-size:1.1em">状态</h3>
|
||||
<div id="statusBox" class="fieldDescription">读取中…</div>
|
||||
</div>
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<script>
|
||||
(function () {
|
||||
'use strict';
|
||||
|
||||
var PLUGIN_ID = '7d33ef59-f9b0-412b-93bd-5cd5353018de';
|
||||
|
||||
function statusLine(label, value) {
|
||||
return '<div><strong>' + label + ':</strong> ' + value + '</div>';
|
||||
}
|
||||
|
||||
function renderStatus() {
|
||||
var box = document.querySelector('#statusBox');
|
||||
var url;
|
||||
try {
|
||||
url = ApiClient.getUrl('JFVR/status');
|
||||
} catch (err) {
|
||||
url = '/JFVR/status';
|
||||
}
|
||||
|
||||
ApiClient.ajax({ type: 'GET', url: url, dataType: 'json' }).then(function (s) {
|
||||
box.innerHTML =
|
||||
statusLine('插件版本', s.version) +
|
||||
statusLine('bundle 版本', s.bundleHash + '(' + s.bundleBytes + ' bytes)') +
|
||||
statusLine('注入', s.enabled ? '已启用' : '已关闭') +
|
||||
statusLine('注入的 URL', '<code>' + s.injectedTag + '</code>');
|
||||
}).catch(function () {
|
||||
box.textContent = '无法读取 /JFVR/status(插件可能尚未加载完成)。';
|
||||
});
|
||||
}
|
||||
|
||||
function loadConfiguration() {
|
||||
Dashboard.showLoadingMsg();
|
||||
ApiClient.getPluginConfiguration(PLUGIN_ID).then(function (config) {
|
||||
document.querySelector('#chkEnabled').checked = config.Enabled !== false;
|
||||
document.querySelector('#txtScriptUrl').value = config.ScriptUrlOverride || '';
|
||||
Dashboard.hideLoadingMsg();
|
||||
renderStatus();
|
||||
});
|
||||
}
|
||||
|
||||
function saveConfiguration(e) {
|
||||
e.preventDefault();
|
||||
Dashboard.showLoadingMsg();
|
||||
ApiClient.getPluginConfiguration(PLUGIN_ID).then(function (config) {
|
||||
config.Enabled = document.querySelector('#chkEnabled').checked;
|
||||
config.ScriptUrlOverride = document.querySelector('#txtScriptUrl').value || '';
|
||||
ApiClient.updatePluginConfiguration(PLUGIN_ID, config).then(function (result) {
|
||||
Dashboard.processPluginConfigurationUpdateResult(result);
|
||||
renderStatus();
|
||||
});
|
||||
});
|
||||
return false;
|
||||
}
|
||||
|
||||
document.querySelector('#JfvrConfigForm').addEventListener('submit', saveConfiguration);
|
||||
|
||||
document.addEventListener('pageshow', function (e) {
|
||||
if (e.target.id === 'JfvrConfigPage') {
|
||||
loadConfiguration();
|
||||
}
|
||||
});
|
||||
})();
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,82 @@
|
||||
using System;
|
||||
using System.Threading.Tasks;
|
||||
using Jellyfin.Plugin.JFVR.Services;
|
||||
using Microsoft.AspNetCore.Authorization;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using Microsoft.Net.Http.Headers;
|
||||
|
||||
namespace Jellyfin.Plugin.JFVR.Controllers;
|
||||
|
||||
/// <summary>
|
||||
/// Serves the JFVR web bundle and a small status endpoint.
|
||||
///
|
||||
/// The bundle is anonymous on purpose: the injected tag lives in
|
||||
/// <c>index.html</c>, which the browser fetches before the user has
|
||||
/// authenticated, and the payload is the same JavaScript that is already public
|
||||
/// in the project repository.
|
||||
/// </summary>
|
||||
[ApiController]
|
||||
[Route("JFVR")]
|
||||
public class JfvrController : ControllerBase
|
||||
{
|
||||
private readonly BundleProvider _bundle;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="JfvrController"/> class.
|
||||
/// </summary>
|
||||
/// <param name="bundle">Embedded web bundle.</param>
|
||||
public JfvrController(BundleProvider bundle)
|
||||
{
|
||||
_bundle = bundle;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns the JFVR web bundle.
|
||||
/// </summary>
|
||||
/// <returns>The bundle as JavaScript.</returns>
|
||||
[HttpGet("jfvr.js")]
|
||||
[AllowAnonymous]
|
||||
[Produces("application/javascript")]
|
||||
public ActionResult GetBundle()
|
||||
{
|
||||
var etag = "\"" + _bundle.Hash + "\"";
|
||||
|
||||
// The URL is versioned with ?v=<hash>, so the body for a given URL never
|
||||
// changes: it is safe to cache forever, and an update always produces a
|
||||
// new URL.
|
||||
Response.Headers[HeaderNames.CacheControl] = "public, max-age=31536000, immutable";
|
||||
Response.Headers[HeaderNames.ETag] = etag;
|
||||
|
||||
if (Request.Headers[HeaderNames.IfNoneMatch].ToString().Contains(_bundle.Hash, StringComparison.Ordinal))
|
||||
{
|
||||
return StatusCode(304);
|
||||
}
|
||||
|
||||
return File(_bundle.Bytes, "application/javascript; charset=utf-8");
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Reports which bundle the server is serving and whether injection is on.
|
||||
/// Handy for verifying a deployment without opening DevTools on the Quest.
|
||||
/// </summary>
|
||||
/// <returns>A small JSON status object.</returns>
|
||||
[HttpGet("status")]
|
||||
[AllowAnonymous]
|
||||
public ActionResult<object> GetStatus()
|
||||
{
|
||||
var config = Plugin.Instance?.Configuration;
|
||||
|
||||
return new
|
||||
{
|
||||
plugin = "Jellyfin.Plugin.JFVR",
|
||||
version = typeof(Plugin).Assembly.GetName().Version?.ToString() ?? "unknown",
|
||||
bundleHash = _bundle.Hash,
|
||||
bundleBytes = _bundle.Bytes.Length,
|
||||
enabled = config?.Enabled ?? false,
|
||||
scriptUrlOverride = config?.ScriptUrlOverride ?? string.Empty,
|
||||
injectedTag = string.IsNullOrWhiteSpace(config?.ScriptUrlOverride)
|
||||
? "../JFVR/jfvr.js?v=" + _bundle.Hash
|
||||
: config!.ScriptUrlOverride.Trim()
|
||||
};
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,48 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
|
||||
<PropertyGroup>
|
||||
<TargetFramework>net10.0</TargetFramework>
|
||||
<RootNamespace>Jellyfin.Plugin.JFVR</RootNamespace>
|
||||
<AssemblyName>Jellyfin.Plugin.JFVR</AssemblyName>
|
||||
<Nullable>enable</Nullable>
|
||||
<ImplicitUsings>disable</ImplicitUsings>
|
||||
<LangVersion>latest</LangVersion>
|
||||
<GenerateDocumentationFile>false</GenerateDocumentationFile>
|
||||
<EnableDefaultEmbeddedResourceItems>false</EnableDefaultEmbeddedResourceItems>
|
||||
|
||||
<!-- Overridden by pack.py from plugin/build.yaml (dotnet build -p:Version=...). -->
|
||||
<Version>0.1.0.0</Version>
|
||||
|
||||
<!--
|
||||
Single source of truth for the injected bundle. dist/jfvr.js is produced by
|
||||
build.py from src/*.js; embedding it straight from there (instead of copying
|
||||
it into the project) means the DLL can never ship a stale bundle.
|
||||
-->
|
||||
<JfvrBundlePath>$(MSBuildThisFileDirectory)..\..\dist\jfvr.js</JfvrBundlePath>
|
||||
</PropertyGroup>
|
||||
|
||||
<Target Name="JfvrCheckBundle" BeforeTargets="PrepareForBuild">
|
||||
<Error
|
||||
Condition="!Exists('$(JfvrBundlePath)')"
|
||||
Text="dist/jfvr.js is missing. Run 'python3 build.py' first (pack.py does this for you)." />
|
||||
</Target>
|
||||
|
||||
<ItemGroup>
|
||||
<!--
|
||||
ExcludeAssets=runtime is required: Jellyfin provides these at runtime, and
|
||||
copying them into the plugin folder prevents the plugin from registering.
|
||||
-->
|
||||
<PackageReference Include="Jellyfin.Controller" Version="12.1.0">
|
||||
<ExcludeAssets>runtime</ExcludeAssets>
|
||||
</PackageReference>
|
||||
<PackageReference Include="Jellyfin.Model" Version="12.1.0">
|
||||
<ExcludeAssets>runtime</ExcludeAssets>
|
||||
</PackageReference>
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<EmbeddedResource Include="$(JfvrBundlePath)" LogicalName="Jellyfin.Plugin.JFVR.Web.jfvr.js" />
|
||||
<EmbeddedResource Include="Configuration\configPage.html" LogicalName="Jellyfin.Plugin.JFVR.Configuration.configPage.html" />
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
@@ -0,0 +1,66 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using Jellyfin.Plugin.JFVR.Services;
|
||||
using MediaBrowser.Common.Configuration;
|
||||
using MediaBrowser.Common.Plugins;
|
||||
using MediaBrowser.Model.Plugins;
|
||||
using MediaBrowser.Model.Serialization;
|
||||
|
||||
namespace Jellyfin.Plugin.JFVR;
|
||||
|
||||
/// <summary>
|
||||
/// The JFVR plugin. Owns the identity (GUID + version) that the Jellyfin plugin
|
||||
/// catalog matches on, and serves the embedded web bundle.
|
||||
/// </summary>
|
||||
public class Plugin : BasePlugin<PluginConfiguration>, IHasWebPages
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="Plugin"/> class.
|
||||
/// </summary>
|
||||
/// <param name="applicationPaths">Jellyfin application paths.</param>
|
||||
/// <param name="xmlSerializer">XML serializer for the configuration.</param>
|
||||
/// <param name="bundle">Embedded web bundle.</param>
|
||||
public Plugin(IApplicationPaths applicationPaths, IXmlSerializer xmlSerializer, BundleProvider bundle)
|
||||
: base(applicationPaths, xmlSerializer)
|
||||
{
|
||||
Instance = this;
|
||||
Bundle = bundle;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the current plugin instance. Set by the DI container at startup;
|
||||
/// the injection middleware reads the configuration through it.
|
||||
/// </summary>
|
||||
public static Plugin? Instance { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the embedded web bundle.
|
||||
/// </summary>
|
||||
public BundleProvider Bundle { get; }
|
||||
|
||||
/// <inheritdoc />
|
||||
public override string Name => "Jellyfin Web VR";
|
||||
|
||||
/// <inheritdoc />
|
||||
public override Guid Id => Guid.Parse("7d33ef59-f9b0-412b-93bd-5cd5353018de");
|
||||
|
||||
/// <inheritdoc />
|
||||
public override string Description =>
|
||||
"Injects a VR play button into Jellyfin Web so Meta Quest 3 can play VR180/VR360 in WebXR.";
|
||||
|
||||
/// <inheritdoc />
|
||||
public IEnumerable<PluginPageInfo> GetPages()
|
||||
{
|
||||
return new[]
|
||||
{
|
||||
new PluginPageInfo
|
||||
{
|
||||
Name = "JFVR",
|
||||
DisplayName = "Jellyfin Web VR",
|
||||
EmbeddedResourcePath = GetType().Namespace + ".Configuration.configPage.html",
|
||||
EnableInMainMenu = true,
|
||||
MenuIcon = "view_in_ar"
|
||||
}
|
||||
};
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,25 @@
|
||||
using MediaBrowser.Model.Plugins;
|
||||
|
||||
namespace Jellyfin.Plugin.JFVR;
|
||||
|
||||
/// <summary>
|
||||
/// JFVR plugin configuration. Persisted by Jellyfin as XML under
|
||||
/// <c><config>/plugins/configurations/Jellyfin.Plugin.JFVR.xml</c>, so it
|
||||
/// survives container recreation and Jellyfin upgrades.
|
||||
/// </summary>
|
||||
public class PluginConfiguration : BasePluginConfiguration
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets a value indicating whether the plugin rewrites the served
|
||||
/// <c>index.html</c>. When disabled the response is passed through untouched
|
||||
/// (the legacy injection, if any, is left alone too) but the bundle endpoint
|
||||
/// stays reachable.
|
||||
/// </summary>
|
||||
public bool Enabled { get; set; } = true;
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets an optional URL used instead of the embedded bundle. Leave
|
||||
/// empty to serve <c>../JFVR/jfvr.js?v=<hash></c> from this plugin.
|
||||
/// </summary>
|
||||
public string ScriptUrlOverride { get; set; } = string.Empty;
|
||||
}
|
||||
@@ -0,0 +1,23 @@
|
||||
using Jellyfin.Plugin.JFVR.Services;
|
||||
using MediaBrowser.Controller;
|
||||
using MediaBrowser.Controller.Plugins;
|
||||
using Microsoft.AspNetCore.Hosting;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
|
||||
namespace Jellyfin.Plugin.JFVR;
|
||||
|
||||
/// <summary>
|
||||
/// Registers the plugin's services with the Jellyfin host container.
|
||||
/// </summary>
|
||||
public class PluginServiceRegistrator : IPluginServiceRegistrator
|
||||
{
|
||||
/// <inheritdoc />
|
||||
public void RegisterServices(IServiceCollection serviceCollection, IServerApplicationHost applicationHost)
|
||||
{
|
||||
serviceCollection.AddSingleton<BundleProvider>();
|
||||
|
||||
// The request-time injection path: rewrites jellyfin-web's index.html on
|
||||
// the way out. Nothing is written to disk.
|
||||
serviceCollection.AddSingleton<IStartupFilter, ScriptInjectionStartupFilter>();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,55 @@
|
||||
using System;
|
||||
using System.IO;
|
||||
using System.Security.Cryptography;
|
||||
|
||||
namespace Jellyfin.Plugin.JFVR.Services;
|
||||
|
||||
/// <summary>
|
||||
/// Loads the JFVR web bundle that is embedded in this assembly and exposes it
|
||||
/// together with a short content hash.
|
||||
///
|
||||
/// The hash is the cache-busting token in the injected
|
||||
/// <c><script src="../JFVR/jfvr.js?v=HASH"></c> tag, so a new plugin build
|
||||
/// always forces browsers to refetch the bundle. It is also the same
|
||||
/// <c>md5[:6]</c> version string the in-page HUD reports, which makes "which JS
|
||||
/// is the Quest actually running?" answerable from both sides.
|
||||
/// </summary>
|
||||
public sealed class BundleProvider
|
||||
{
|
||||
/// <summary>
|
||||
/// Logical name of the embedded resource, set explicitly in the .csproj so it
|
||||
/// does not depend on the project's folder layout.
|
||||
/// </summary>
|
||||
internal const string ResourceName = "Jellyfin.Plugin.JFVR.Web.jfvr.js";
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="BundleProvider"/> class.
|
||||
/// </summary>
|
||||
/// <exception cref="InvalidOperationException">
|
||||
/// Thrown when the bundle was not embedded, which means the build is broken.
|
||||
/// </exception>
|
||||
public BundleProvider()
|
||||
{
|
||||
using var stream = typeof(BundleProvider).Assembly.GetManifestResourceStream(ResourceName);
|
||||
if (stream is null)
|
||||
{
|
||||
throw new InvalidOperationException(
|
||||
$"Embedded resource '{ResourceName}' is missing from {typeof(BundleProvider).Assembly.FullName}.");
|
||||
}
|
||||
|
||||
using var buffer = new MemoryStream();
|
||||
stream.CopyTo(buffer);
|
||||
Bytes = buffer.ToArray();
|
||||
Hash = Convert.ToHexString(MD5.HashData(Bytes)).ToLowerInvariant()[..8];
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the raw bundle bytes.
|
||||
/// </summary>
|
||||
public byte[] Bytes { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the short (8 hex chars) MD5 of <see cref="Bytes"/>.
|
||||
/// </summary>
|
||||
public string Hash { get; }
|
||||
}
|
||||
@@ -0,0 +1,97 @@
|
||||
using System;
|
||||
using System.Text.RegularExpressions;
|
||||
|
||||
namespace Jellyfin.Plugin.JFVR.Services;
|
||||
|
||||
/// <summary>
|
||||
/// The pure text transformation behind <see cref="ScriptInjectionStartupFilter"/>:
|
||||
/// given jellyfin-web's <c>index.html</c>, return the version with the JFVR
|
||||
/// script tag in it.
|
||||
///
|
||||
/// Deliberately free of ASP.NET and Jellyfin types so it can be exercised
|
||||
/// directly against captured HTML.
|
||||
/// </summary>
|
||||
public static class IndexHtmlRewriter
|
||||
{
|
||||
/// <summary>
|
||||
/// Marker that identifies an index.html this plugin already rewrote.
|
||||
/// </summary>
|
||||
public const string StartComment = "<!-- BEGIN JFVR (Jellyfin Web VR) -->";
|
||||
|
||||
/// <summary>
|
||||
/// Closing half of the injected block.
|
||||
/// </summary>
|
||||
public const string EndComment = "<!-- END JFVR (Jellyfin Web VR) -->";
|
||||
|
||||
/// <summary>
|
||||
/// Matches the tag written by the old <c>deploy.py</c>
|
||||
/// (<c><script plugin="JellyfinVR" ... src="jfvr-mvp.js?v=..."></script></c>).
|
||||
///
|
||||
/// The plugin's own tag deliberately uses <c>plugin="JFVR"</c>, so the two can
|
||||
/// never be confused: installing the plugin takes over from the legacy
|
||||
/// injection automatically instead of loading the bundle twice.
|
||||
/// </summary>
|
||||
private static readonly Regex LegacyTag = new(
|
||||
"<script[^>]*plugin=\"JellyfinVR\"[^>]*>\\s*</script>\\s*",
|
||||
RegexOptions.IgnoreCase | RegexOptions.Compiled);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a value indicating whether <paramref name="html"/> already carries our block.
|
||||
/// </summary>
|
||||
/// <param name="html">The served HTML.</param>
|
||||
/// <returns>True when the block is already present.</returns>
|
||||
public static bool IsInjected(string html)
|
||||
{
|
||||
return html.Contains(StartComment, StringComparison.Ordinal);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Builds the block that gets inserted immediately before <c></body></c>.
|
||||
/// </summary>
|
||||
/// <param name="scriptUrl">URL of the bundle to load.</param>
|
||||
/// <returns>The HTML block, newline terminated.</returns>
|
||||
public static string BuildBlock(string scriptUrl)
|
||||
{
|
||||
return StartComment
|
||||
+ "\n<script plugin=\"JFVR\" data-jfvr=\"1\" src=\"" + scriptUrl + "\" defer></script>\n"
|
||||
+ EndComment
|
||||
+ "\n";
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Injects the JFVR block into <paramref name="html"/>.
|
||||
///
|
||||
/// Idempotent: an already-injected document is returned unchanged. A legacy
|
||||
/// <c>deploy.py</c> tag is removed on the way so the bundle is never loaded twice.
|
||||
/// If there is no <c></body></c> to anchor to, the (possibly
|
||||
/// legacy-cleaned) input is returned unchanged.
|
||||
/// </summary>
|
||||
/// <param name="html">The served HTML.</param>
|
||||
/// <param name="scriptUrl">URL of the bundle to load.</param>
|
||||
/// <param name="removedLegacy">True when a legacy tag was stripped.</param>
|
||||
/// <returns>The HTML to serve.</returns>
|
||||
public static string Rewrite(string html, string scriptUrl, out bool removedLegacy)
|
||||
{
|
||||
removedLegacy = false;
|
||||
|
||||
if (IsInjected(html))
|
||||
{
|
||||
return html;
|
||||
}
|
||||
|
||||
var cleaned = html;
|
||||
if (LegacyTag.IsMatch(html))
|
||||
{
|
||||
cleaned = LegacyTag.Replace(html, string.Empty);
|
||||
removedLegacy = true;
|
||||
}
|
||||
|
||||
var bodyClose = cleaned.LastIndexOf("</body>", StringComparison.OrdinalIgnoreCase);
|
||||
if (bodyClose < 0)
|
||||
{
|
||||
return cleaned;
|
||||
}
|
||||
|
||||
return cleaned[..bodyClose] + BuildBlock(scriptUrl) + "\n" + cleaned[bodyClose..];
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,203 @@
|
||||
using System;
|
||||
using System.IO;
|
||||
using System.Text;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using Jellyfin.Plugin.JFVR.Services;
|
||||
using Microsoft.AspNetCore.Builder;
|
||||
using Microsoft.AspNetCore.Hosting;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using Microsoft.Extensions.Primitives;
|
||||
using Microsoft.Net.Http.Headers;
|
||||
|
||||
namespace Jellyfin.Plugin.JFVR.Services;
|
||||
|
||||
/// <summary>
|
||||
/// Injects the JFVR <c><script></c> tag into jellyfin-web's index.html at
|
||||
/// request time, through ASP.NET Core middleware registered via
|
||||
/// <see cref="IStartupFilter"/>.
|
||||
///
|
||||
/// Why request-time rewriting instead of the old deploy.py approach (which
|
||||
/// <c>sed</c>-patched <c>/jellyfin/jellyfin-web/index.html</c> inside the
|
||||
/// container):
|
||||
/// - nothing on disk is modified, so a <c>jellyfin/jellyfin:latest</c> upgrade
|
||||
/// cannot silently drop the injection;
|
||||
/// - it is idempotent and additive;
|
||||
/// - on any error the original response is served unchanged -- the middleware
|
||||
/// never throws into the pipeline;
|
||||
/// - it can be switched off from the dashboard.
|
||||
///
|
||||
/// The technique (strip Accept-Encoding so the static handler returns plain
|
||||
/// text, buffer the body, rewrite, fix up the validators) is the same one the
|
||||
/// community JavaScript Injector plugin uses; that plugin's own history is why
|
||||
/// the details below look paranoid.
|
||||
/// </summary>
|
||||
public sealed class ScriptInjectionStartupFilter : IStartupFilter
|
||||
{
|
||||
private readonly BundleProvider _bundle;
|
||||
private readonly ILogger<ScriptInjectionStartupFilter> _logger;
|
||||
private int _loggedOnce;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="ScriptInjectionStartupFilter"/> class.
|
||||
/// </summary>
|
||||
/// <param name="bundle">Embedded web bundle.</param>
|
||||
/// <param name="logger">Logger.</param>
|
||||
public ScriptInjectionStartupFilter(BundleProvider bundle, ILogger<ScriptInjectionStartupFilter> logger)
|
||||
{
|
||||
_bundle = bundle;
|
||||
_logger = logger;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public Action<IApplicationBuilder> Configure(Action<IApplicationBuilder> next)
|
||||
{
|
||||
return app =>
|
||||
{
|
||||
// Registered before next(app) so this runs outermost. That ordering
|
||||
// matters: stripping Accept-Encoding here means the response
|
||||
// compression middleware downstream never compresses the body, so
|
||||
// what we buffer is always complete, plain-text HTML.
|
||||
app.Use(InvokeAsync);
|
||||
next(app);
|
||||
};
|
||||
}
|
||||
|
||||
private async Task InvokeAsync(HttpContext context, Func<Task> nextMw)
|
||||
{
|
||||
var config = Plugin.Instance?.Configuration;
|
||||
if (config is null || !config.Enabled || !IsIndexRequest(context.Request))
|
||||
{
|
||||
await nextMw().ConfigureAwait(false);
|
||||
return;
|
||||
}
|
||||
|
||||
// Normalize the request so the static handler returns a complete 200:
|
||||
// - no Accept-Encoding -> no compression, plain text body;
|
||||
// - no Range/If-Range -> no 206 partial response, which would otherwise
|
||||
// pass through un-injected with a total length that no longer matches.
|
||||
var hadAcceptEncoding = context.Request.Headers.TryGetValue(HeaderNames.AcceptEncoding, out StringValues acceptEncoding);
|
||||
context.Request.Headers.Remove(HeaderNames.AcceptEncoding);
|
||||
context.Request.Headers.Remove(HeaderNames.Range);
|
||||
context.Request.Headers.Remove(HeaderNames.IfRange);
|
||||
|
||||
var originalBody = context.Response.Body;
|
||||
using var buffer = new MemoryStream();
|
||||
context.Response.Body = buffer;
|
||||
try
|
||||
{
|
||||
await nextMw().ConfigureAwait(false);
|
||||
}
|
||||
catch
|
||||
{
|
||||
// Not ours to swallow. Discard the partially buffered body (it never
|
||||
// reached the real stream, so the response has not started) and let
|
||||
// the host render a clean error page.
|
||||
context.Response.Body = originalBody;
|
||||
throw;
|
||||
}
|
||||
finally
|
||||
{
|
||||
if (hadAcceptEncoding)
|
||||
{
|
||||
context.Request.Headers[HeaderNames.AcceptEncoding] = acceptEncoding;
|
||||
}
|
||||
}
|
||||
|
||||
context.Response.Body = originalBody;
|
||||
buffer.Seek(0, SeekOrigin.Begin);
|
||||
|
||||
var isHtml = context.Response.StatusCode == 200
|
||||
&& context.Response.ContentType is not null
|
||||
&& context.Response.ContentType.Contains("text/html", StringComparison.OrdinalIgnoreCase);
|
||||
|
||||
if (!isHtml)
|
||||
{
|
||||
// 304, redirects, non-HTML: pass straight through, byte for byte.
|
||||
await buffer.CopyToAsync(originalBody).ConfigureAwait(false);
|
||||
return;
|
||||
}
|
||||
|
||||
string html;
|
||||
using (var reader = new StreamReader(buffer, Encoding.UTF8, detectEncodingFromByteOrderMarks: true, leaveOpen: true))
|
||||
{
|
||||
html = await reader.ReadToEndAsync().ConfigureAwait(false);
|
||||
}
|
||||
|
||||
try
|
||||
{
|
||||
html = Rewrite(html, config);
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
// Never break index.html: serve whatever we have.
|
||||
_logger.LogWarning(ex, "JFVR: index.html rewrite failed, serving the original response.");
|
||||
}
|
||||
|
||||
var bytes = Encoding.UTF8.GetBytes(html);
|
||||
context.Response.ContentType = "text/html; charset=utf-8";
|
||||
context.Response.ContentLength = bytes.Length;
|
||||
|
||||
// The body changed, so validators computed for the original bytes are
|
||||
// invalid, and range requests on the rewritten document are not supported
|
||||
// (they are already stripped on the way in).
|
||||
context.Response.Headers.Remove(HeaderNames.ETag);
|
||||
context.Response.Headers.Remove(HeaderNames.LastModified);
|
||||
context.Response.Headers.Remove(HeaderNames.AcceptRanges);
|
||||
context.Response.Headers.Remove(HeaderNames.ContentEncoding);
|
||||
|
||||
await originalBody.WriteAsync(bytes).ConfigureAwait(false);
|
||||
}
|
||||
|
||||
private string Rewrite(string html, PluginConfiguration config)
|
||||
{
|
||||
var scriptUrl = string.IsNullOrWhiteSpace(config.ScriptUrlOverride)
|
||||
? "../JFVR/jfvr.js?v=" + _bundle.Hash
|
||||
: config.ScriptUrlOverride.Trim();
|
||||
|
||||
var rewritten = IndexHtmlRewriter.Rewrite(html, scriptUrl, out var removedLegacy);
|
||||
|
||||
if (removedLegacy)
|
||||
{
|
||||
_logger.LogInformation("JFVR: removed the legacy deploy.py <script> tag from index.html.");
|
||||
}
|
||||
|
||||
if (IndexHtmlRewriter.IsInjected(html) || rewritten == html)
|
||||
{
|
||||
// Already ours (the common case on every reload), or nothing to anchor to.
|
||||
return rewritten;
|
||||
}
|
||||
|
||||
if (Interlocked.Exchange(ref _loggedOnce, 1) == 0)
|
||||
{
|
||||
_logger.LogInformation("JFVR: injecting {Block}", IndexHtmlRewriter.BuildBlock(scriptUrl).Trim());
|
||||
}
|
||||
|
||||
return rewritten;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Matches the web app shell however it is requested: bare <c>/web</c>,
|
||||
/// <c>/web/</c> (SPA serve) and an explicit <c>/web/index.html</c>. The
|
||||
/// EndsWith form stays correct when Jellyfin is hosted under a base-url
|
||||
/// prefix (e.g. <c>/jellyfin/web/</c>).
|
||||
/// </summary>
|
||||
private static bool IsIndexRequest(HttpRequest request)
|
||||
{
|
||||
if (!HttpMethods.IsGet(request.Method))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
var path = request.Path.Value;
|
||||
if (string.IsNullOrEmpty(path) || path == "/")
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
return path.EndsWith("/web/index.html", StringComparison.OrdinalIgnoreCase)
|
||||
|| path.EndsWith("/web/", StringComparison.OrdinalIgnoreCase)
|
||||
|| path.Equals("/web", StringComparison.OrdinalIgnoreCase);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,27 @@
|
||||
---
|
||||
# Metadata for the Jellyfin plugin catalog entry. pack.py reads this file to
|
||||
# build manifest.json, and passes `version` to dotnet as -p:Version.
|
||||
#
|
||||
# targetAbi is deliberately 12.0.0.0 rather than the exact server version:
|
||||
# Jellyfin keeps a catalog version only when `targetAbi <= serverVersion`
|
||||
# (InstallationManager.GetAvailablePackages), so one package covers all of 12.x.
|
||||
name: "Jellyfin Web VR"
|
||||
guid: "7d33ef59-f9b0-412b-93bd-5cd5353018de"
|
||||
version: "0.1.0.0"
|
||||
targetAbi: "12.0.0.0"
|
||||
framework: "net10.0"
|
||||
overview: "VR180/VR360 playback inside Jellyfin Web for Meta Quest 3."
|
||||
description: >
|
||||
Injects a "VR 播放" button into the Jellyfin Web video player page and drives
|
||||
an immersive WebXR session on Meta Quest 3, preferring
|
||||
XRMediaBinding.createEquirectLayer and falling back to XRWebGLBinding.
|
||||
Ships equirectangular 180/360 plus SBS/OU layouts, in-headset subtitles,
|
||||
a wrist controller, and hand tracking.
|
||||
category: "General"
|
||||
owner: "cat-shark"
|
||||
artifacts:
|
||||
- "Jellyfin.Plugin.JFVR.dll"
|
||||
changelog: >
|
||||
First plugin build. The web bundle is embedded in the DLL and served from
|
||||
/JFVR/jfvr.js; index.html is rewritten at request time, so nothing is written
|
||||
to the jellyfin-web folder on disk.
|
||||
Reference in New Issue
Block a user