Merge pull request #1454 from Bond-009/webresource

Simplify file serving code
This commit is contained in:
dkanada 2019-06-21 23:33:37 -07:00 committed by GitHub
commit 1b2621cd30
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 74 additions and 156 deletions

View File

@ -232,11 +232,6 @@ namespace Emby.Server.Implementations
/// <value>The server configuration manager.</value>
public IServerConfigurationManager ServerConfigurationManager => (IServerConfigurationManager)ConfigurationManager;
protected virtual IResourceFileManager CreateResourceFileManager()
{
return new ResourceFileManager(HttpResultFactory, LoggerFactory, FileSystemManager);
}
/// <summary>
/// Gets or sets the user manager.
/// </summary>
@ -887,7 +882,7 @@ namespace Emby.Server.Implementations
SubtitleEncoder = new MediaBrowser.MediaEncoding.Subtitles.SubtitleEncoder(LibraryManager, LoggerFactory, ApplicationPaths, FileSystemManager, MediaEncoder, JsonSerializer, HttpClient, MediaSourceManager, ProcessFactory);
serviceCollection.AddSingleton(SubtitleEncoder);
serviceCollection.AddSingleton(CreateResourceFileManager());
serviceCollection.AddSingleton(typeof(IResourceFileManager), typeof(ResourceFileManager));
displayPreferencesRepo.Initialize();

View File

@ -1,10 +1,8 @@
using System;
using System.IO;
using System.Threading.Tasks;
using MediaBrowser.Controller;
using MediaBrowser.Controller.Net;
using MediaBrowser.Model.IO;
using MediaBrowser.Model.Services;
using Microsoft.Extensions.Logging;
namespace Emby.Server.Implementations
@ -13,34 +11,14 @@ namespace Emby.Server.Implementations
{
private readonly IFileSystem _fileSystem;
private readonly ILogger _logger;
private readonly IHttpResultFactory _resultFactory;
public ResourceFileManager(
IHttpResultFactory resultFactory,
ILoggerFactory loggerFactory,
IFileSystem fileSystem)
public ResourceFileManager(ILogger<ResourceFileManager> logger, IFileSystem fileSystem)
{
_resultFactory = resultFactory;
_logger = loggerFactory.CreateLogger("ResourceManager");
_logger = logger;
_fileSystem = fileSystem;
}
public Stream GetResourceFileStream(string basePath, string virtualPath)
{
return _fileSystem.GetFileStream(GetResourcePath(basePath, virtualPath), FileOpenMode.Open, FileAccessMode.Read, FileShareMode.ReadWrite, true);
}
public Task<object> GetStaticFileResult(IRequest request, string basePath, string virtualPath, string contentType, TimeSpan? cacheDuration)
{
return _resultFactory.GetStaticFileResult(request, GetResourcePath(basePath, virtualPath));
}
public string ReadAllText(string basePath, string virtualPath)
{
return File.ReadAllText(GetResourcePath(basePath, virtualPath));
}
private string GetResourcePath(string basePath, string virtualPath)
public string GetResourcePath(string basePath, string virtualPath)
{
var fullPath = Path.Combine(basePath, virtualPath.Replace('/', Path.DirectorySeparatorChar));
@ -50,7 +28,7 @@ namespace Emby.Server.Implementations
}
catch (Exception ex)
{
_logger.LogError(ex, "Error in Path.GetFullPath");
_logger.LogError(ex, "Error retrieving full path");
}
// Don't allow file system access outside of the source folder

View File

@ -1,7 +1,8 @@
using System.Collections.Generic;
using System.Reflection;
using Emby.Server.Implementations;
using Emby.Server.Implementations.HttpServer;
using MediaBrowser.Common.Net;
using MediaBrowser.Controller.Drawing;
using MediaBrowser.Model.IO;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Logging;
@ -15,8 +16,8 @@ namespace Jellyfin.Server
ILoggerFactory loggerFactory,
StartupOptions options,
IFileSystem fileSystem,
MediaBrowser.Controller.Drawing.IImageEncoder imageEncoder,
MediaBrowser.Common.Net.INetworkManager networkManager,
IImageEncoder imageEncoder,
INetworkManager networkManager,
IConfiguration configuration)
: base(
applicationPaths,

View File

@ -1,16 +1,7 @@
using System;
using System.IO;
using System.Threading.Tasks;
using MediaBrowser.Model.Services;
namespace MediaBrowser.Controller
{
public interface IResourceFileManager
{
Task<object> GetStaticFileResult(IRequest request, string basePath, string virtualPath, string contentType, TimeSpan? cacheDuration);
Stream GetResourceFileStream(string basePath, string virtualPath);
string ReadAllText(string basePath, string virtualPath);
string GetResourcePath(string basePath, string virtualPath);
}
}

View File

@ -114,8 +114,6 @@ namespace MediaBrowser.WebDashboard.Api
private readonly IServerConfigurationManager _serverConfigurationManager;
private readonly IFileSystem _fileSystem;
private readonly ILocalizationManager _localization;
private readonly IJsonSerializer _jsonSerializer;
private IResourceFileManager _resourceFileManager;
/// <summary>
@ -126,16 +124,12 @@ namespace MediaBrowser.WebDashboard.Api
IResourceFileManager resourceFileManager,
IServerConfigurationManager serverConfigurationManager,
IFileSystem fileSystem,
ILocalizationManager localization,
IJsonSerializer jsonSerializer,
ILogger logger,
IHttpResultFactory resultFactory)
{
_appHost = appHost;
_serverConfigurationManager = serverConfigurationManager;
_fileSystem = fileSystem;
_localization = localization;
_jsonSerializer = jsonSerializer;
_logger = logger;
_resultFactory = resultFactory;
_resourceFileManager = resourceFileManager;
@ -205,6 +199,7 @@ namespace MediaBrowser.WebDashboard.Api
{
return _resultFactory.GetStaticResult(Request, plugin.Version.ToString().GetMD5(), null, null, MimeTypes.GetMimeType("page.js"), () => Task.FromResult(stream));
}
if (isTemplate)
{
return _resultFactory.GetStaticResult(Request, plugin.Version.ToString().GetMD5(), null, null, MimeTypes.GetMimeType("page.html"), () => Task.FromResult(stream));
@ -316,7 +311,7 @@ namespace MediaBrowser.WebDashboard.Api
// Bounce them to the startup wizard if it hasn't been completed yet
if (!_serverConfigurationManager.Configuration.IsStartupWizardCompleted &&
Request.RawUrl.IndexOf("wizard", StringComparison.OrdinalIgnoreCase) == -1 &&
GetPackageCreator(basePath).IsCoreHtml(path))
PackageCreator.IsCoreHtml(path))
{
// But don't redirect if an html import is being requested.
if (path.IndexOf("bower_components", StringComparison.OrdinalIgnoreCase) == -1)
@ -355,7 +350,7 @@ namespace MediaBrowser.WebDashboard.Api
return await _resultFactory.GetStaticResult(Request, cacheKey, null, cacheDuration, contentType, () => GetResourceStream(basePath, path, localizationCulture)).ConfigureAwait(false);
}
return await _resourceFileManager.GetStaticFileResult(Request, basePath, path, contentType, cacheDuration);
return await _resultFactory.GetStaticFileResult(Request, _resourceFileManager.GetResourcePath(basePath, path));
}
private string GetLocalizationCulture()
@ -374,7 +369,7 @@ namespace MediaBrowser.WebDashboard.Api
private PackageCreator GetPackageCreator(string basePath)
{
return new PackageCreator(basePath, _fileSystem, _logger, _serverConfigurationManager, _resourceFileManager);
return new PackageCreator(basePath, _resourceFileManager);
}
public async Task<object> Get(GetDashboardPackage request)

View File

@ -1,139 +1,108 @@
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using MediaBrowser.Controller;
using MediaBrowser.Controller.Configuration;
using MediaBrowser.Model.IO;
using Microsoft.Extensions.Logging;
namespace MediaBrowser.WebDashboard.Api
{
public class PackageCreator
{
private readonly IFileSystem _fileSystem;
private readonly ILogger _logger;
private readonly IServerConfigurationManager _config;
private readonly string _basePath;
private IResourceFileManager _resourceFileManager;
private readonly IResourceFileManager _resourceFileManager;
public PackageCreator(string basePath, IFileSystem fileSystem, ILogger logger, IServerConfigurationManager config, IResourceFileManager resourceFileManager)
public PackageCreator(string basePath, IResourceFileManager resourceFileManager)
{
_fileSystem = fileSystem;
_logger = logger;
_config = config;
_basePath = basePath;
_resourceFileManager = resourceFileManager;
}
public async Task<Stream> GetResource(string virtualPath,
public async Task<Stream> GetResource(
string virtualPath,
string mode,
string localizationCulture,
string appVersion)
{
var resourceStream = GetRawResourceStream(virtualPath);
var resourcePath = _resourceFileManager.GetResourcePath(_basePath, virtualPath);
Stream resourceStream = File.OpenRead(resourcePath);
if (resourceStream != null)
if (resourceStream != null && IsCoreHtml(virtualPath))
{
if (IsFormat(virtualPath, "html"))
{
if (IsCoreHtml(virtualPath))
{
resourceStream = await ModifyHtml(virtualPath, resourceStream, mode, appVersion, localizationCulture).ConfigureAwait(false);
}
}
resourceStream = await ModifyHtml(virtualPath, resourceStream, mode, appVersion, localizationCulture).ConfigureAwait(false);
}
return resourceStream;
}
/// <summary>
/// Determines whether the specified path is HTML.
/// </summary>
/// <param name="path">The path.</param>
/// <param name="format">The format.</param>
/// <returns><c>true</c> if the specified path is HTML; otherwise, <c>false</c>.</returns>
private static bool IsFormat(string path, string format)
{
return Path.GetExtension(path).EndsWith(format, StringComparison.OrdinalIgnoreCase);
}
public bool IsCoreHtml(string path)
public static bool IsCoreHtml(string path)
{
if (path.IndexOf(".template.html", StringComparison.OrdinalIgnoreCase) != -1)
{
return false;
}
return IsFormat(path, "html");
return string.Equals(Path.GetExtension(path), ".html", StringComparison.OrdinalIgnoreCase);
}
/// <summary>
/// Modifies the HTML by adding common meta tags, css and js.
/// </summary>
/// <returns>Task{Stream}.</returns>
public async Task<Stream> ModifyHtml(string path, Stream sourceStream, string mode, string appVersion, string localizationCulture)
public async Task<Stream> ModifyHtml(
string path,
Stream sourceStream,
string mode,
string appVersion,
string localizationCulture)
{
var isMainIndexPage = string.Equals(path, "index.html", StringComparison.OrdinalIgnoreCase);
using (sourceStream)
string html;
using (var reader = new StreamReader(sourceStream, Encoding.UTF8))
{
string html;
using (var memoryStream = new MemoryStream())
{
await sourceStream.CopyToAsync(memoryStream).ConfigureAwait(false);
var originalBytes = memoryStream.ToArray();
html = Encoding.UTF8.GetString(originalBytes, 0, originalBytes.Length);
if (isMainIndexPage)
{
if (!string.IsNullOrWhiteSpace(localizationCulture))
{
var lang = localizationCulture.Split('-').FirstOrDefault();
html = html.Replace("<html", "<html data-culture=\"" + localizationCulture + "\" lang=\"" + lang + "\"");
}
}
}
if (isMainIndexPage)
{
html = html.Replace("<head>", "<head>" + GetMetaTags(mode));
}
// Disable embedded scripts from plugins. We'll run them later once resources have loaded
if (html.IndexOf("<script", StringComparison.OrdinalIgnoreCase) != -1)
{
html = html.Replace("<script", "<!--<script");
html = html.Replace("</script>", "</script>-->");
}
if (isMainIndexPage)
{
html = html.Replace("</body>", GetCommonJavascript(mode, appVersion) + "</body>");
}
var bytes = Encoding.UTF8.GetBytes(html);
return new MemoryStream(bytes);
html = await reader.ReadToEndAsync().ConfigureAwait(false);
}
if (isMainIndexPage && !string.IsNullOrWhiteSpace(localizationCulture))
{
var lang = localizationCulture.Split('-')[0];
html = html.Replace("<html", "<html data-culture=\"" + localizationCulture + "\" lang=\"" + lang + "\"");
}
if (isMainIndexPage)
{
html = html.Replace("<head>", "<head>" + GetMetaTags(mode));
}
// Disable embedded scripts from plugins. We'll run them later once resources have loaded
if (html.IndexOf("<script", StringComparison.OrdinalIgnoreCase) != -1)
{
html = html.Replace("<script", "<!--<script");
html = html.Replace("</script>", "</script>-->");
}
if (isMainIndexPage)
{
html = html.Replace("</body>", GetCommonJavascript(mode, appVersion) + "</body>");
}
var bytes = Encoding.UTF8.GetBytes(html);
return new MemoryStream(bytes);
}
/// <summary>
/// Gets the meta tags.
/// </summary>
/// <returns>System.String.</returns>
private string GetMetaTags(string mode)
private static string GetMetaTags(string mode)
{
var sb = new StringBuilder();
if (string.Equals(mode, "cordova", StringComparison.OrdinalIgnoreCase) ||
string.Equals(mode, "android", StringComparison.OrdinalIgnoreCase))
if (string.Equals(mode, "cordova", StringComparison.OrdinalIgnoreCase)
|| string.Equals(mode, "android", StringComparison.OrdinalIgnoreCase))
{
sb.Append("<meta http-equiv=\"Content-Security-Policy\" content=\"default-src * 'self' 'unsafe-inline' 'unsafe-eval' data: gap: file: filesystem: ws: wss:;\">");
}
@ -147,7 +116,7 @@ namespace MediaBrowser.WebDashboard.Api
/// <param name="mode">The mode.</param>
/// <param name="version">The version.</param>
/// <returns>System.String.</returns>
private string GetCommonJavascript(string mode, string version)
private static string GetCommonJavascript(string mode, string version)
{
var builder = new StringBuilder();
@ -156,7 +125,6 @@ namespace MediaBrowser.WebDashboard.Api
{
builder.AppendFormat("window.appMode='{0}';", mode);
}
else
{
builder.AppendFormat("window.dashboardVersion='{0}';", version);
@ -164,31 +132,21 @@ namespace MediaBrowser.WebDashboard.Api
builder.Append("</script>");
var versionString = string.IsNullOrWhiteSpace(mode) ? "?v=" + version : string.Empty;
var files = new List<string>();
files.Add("scripts/apploader.js" + versionString);
if (string.Equals(mode, "cordova", StringComparison.OrdinalIgnoreCase))
{
files.Insert(0, "cordova.js");
builder.Append("<script src=\"cordova.js\" defer></script>");
}
var tags = files.Select(s => string.Format("<script src=\"{0}\" defer></script>", s)).ToArray();
builder.Append("<script src=\"scripts/apploader.js");
if (!string.IsNullOrWhiteSpace(version))
{
builder.Append("?v=");
builder.Append(version);
}
builder.Append(string.Join(string.Empty, tags));
builder.Append("\" defer></script>");
return builder.ToString();
}
/// <summary>
/// Gets the raw resource stream.
/// </summary>
private Stream GetRawResourceStream(string virtualPath)
{
return _resourceFileManager.GetResourceFileStream(_basePath, virtualPath);
}
}
}