jellyfin-server/MediaBrowser.WebDashboard/Api/PackageCreator.cs

307 lines
12 KiB
C#
Raw Normal View History

2016-03-27 21:11:27 +00:00
using MediaBrowser.Controller.Configuration;
2014-10-20 20:23:40 +00:00
using MediaBrowser.Model.Logging;
using MediaBrowser.Model.Serialization;
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
2015-09-26 02:31:13 +00:00
using MediaBrowser.Controller.Net;
2016-10-24 02:45:23 +00:00
using MediaBrowser.Model.Globalization;
2016-10-25 19:02:04 +00:00
using MediaBrowser.Model.IO;
2014-10-20 20:23:40 +00:00
namespace MediaBrowser.WebDashboard.Api
{
public class PackageCreator
{
private readonly IFileSystem _fileSystem;
private readonly ILogger _logger;
private readonly IServerConfigurationManager _config;
private readonly IMemoryStreamFactory _memoryStreamFactory;
2017-02-07 07:33:24 +00:00
private readonly string _basePath;
2014-10-20 20:23:40 +00:00
2017-02-07 07:33:24 +00:00
public PackageCreator(string basePath, IFileSystem fileSystem, ILogger logger, IServerConfigurationManager config, IMemoryStreamFactory memoryStreamFactory)
2014-10-20 20:23:40 +00:00
{
_fileSystem = fileSystem;
_logger = logger;
_config = config;
_memoryStreamFactory = memoryStreamFactory;
2017-02-07 07:33:24 +00:00
_basePath = basePath;
2014-10-20 20:23:40 +00:00
}
2017-02-07 07:33:24 +00:00
public async Task<Stream> GetResource(string virtualPath,
2015-05-12 13:58:03 +00:00
string mode,
2014-10-20 20:23:40 +00:00
string localizationCulture,
string appVersion)
2014-10-20 20:23:40 +00:00
{
2017-02-07 07:33:24 +00:00
var resourceStream = GetRawResourceStream(virtualPath);
2014-10-20 20:23:40 +00:00
if (resourceStream != null)
{
// Don't apply any caching for html pages
// jQuery ajax doesn't seem to handle if-modified-since correctly
2017-02-07 07:33:24 +00:00
if (IsFormat(virtualPath, "html"))
2015-05-29 02:53:05 +00:00
{
2017-02-07 07:33:24 +00:00
if (IsCoreHtml(virtualPath))
2015-06-20 04:48:45 +00:00
{
2017-02-07 07:33:24 +00:00
resourceStream = await ModifyHtml(virtualPath, resourceStream, mode, appVersion, localizationCulture).ConfigureAwait(false);
2015-06-20 04:48:45 +00:00
}
2015-05-29 02:53:05 +00:00
}
2014-10-20 20:23:40 +00:00
}
return resourceStream;
}
/// <summary>
/// Determines whether the specified path is HTML.
/// </summary>
/// <param name="path">The path.</param>
2015-05-17 03:17:23 +00:00
/// <param name="format">The format.</param>
2014-10-20 20:23:40 +00:00
/// <returns><c>true</c> if the specified path is HTML; otherwise, <c>false</c>.</returns>
2015-05-17 03:17:23 +00:00
private bool IsFormat(string path, string format)
2014-10-20 20:23:40 +00:00
{
2015-05-17 03:17:23 +00:00
return Path.GetExtension(path).EndsWith(format, StringComparison.OrdinalIgnoreCase);
2014-10-20 20:23:40 +00:00
}
/// <summary>
/// Gets the dashboard resource path.
/// </summary>
/// <returns>System.String.</returns>
2017-05-22 04:54:02 +00:00
public string GetResourcePath(string virtualPath)
2014-10-20 20:23:40 +00:00
{
2017-02-07 07:33:24 +00:00
var fullPath = Path.Combine(_basePath, virtualPath.Replace('/', _fileSystem.DirectorySeparatorChar));
2015-05-13 04:16:55 +00:00
2015-07-08 16:10:34 +00:00
try
{
2016-10-26 02:04:49 +00:00
fullPath = _fileSystem.GetFullPath(fullPath);
2015-07-08 16:10:34 +00:00
}
catch (Exception ex)
{
_logger.ErrorException("Error in Path.GetFullPath", ex);
}
2015-05-13 04:16:55 +00:00
// Don't allow file system access outside of the source folder
2017-02-07 07:33:24 +00:00
if (!_fileSystem.ContainsSubPath(_basePath, fullPath))
2015-05-13 04:16:55 +00:00
{
2015-09-26 02:31:13 +00:00
throw new SecurityException("Access denied");
2015-05-13 04:16:55 +00:00
}
return fullPath;
2014-10-20 20:23:40 +00:00
}
2015-08-22 18:09:02 +00:00
public bool IsCoreHtml(string path)
2015-06-20 04:48:45 +00:00
{
2015-08-22 18:09:02 +00:00
if (path.IndexOf(".template.html", StringComparison.OrdinalIgnoreCase) != -1)
{
return false;
}
2017-05-22 04:54:02 +00:00
path = GetResourcePath(path);
2017-05-04 18:14:45 +00:00
var parent = _fileSystem.GetDirectoryName(path);
2017-02-07 07:33:24 +00:00
return string.Equals(_basePath, parent, StringComparison.OrdinalIgnoreCase) ||
string.Equals(Path.Combine(_basePath, "voice"), parent, StringComparison.OrdinalIgnoreCase);
2015-06-20 04:48:45 +00:00
}
2014-10-20 20:23:40 +00:00
/// <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)
2014-10-20 20:23:40 +00:00
{
using (sourceStream)
{
string html;
using (var memoryStream = _memoryStreamFactory.CreateNew())
2014-10-20 20:23:40 +00:00
{
await sourceStream.CopyToAsync(memoryStream).ConfigureAwait(false);
2016-10-26 02:04:49 +00:00
var originalBytes = memoryStream.ToArray();
html = Encoding.UTF8.GetString(originalBytes, 0, originalBytes.Length);
2014-10-20 20:23:40 +00:00
2017-02-05 20:44:08 +00:00
if (!string.IsNullOrWhiteSpace(mode))
2015-05-16 19:09:02 +00:00
{
}
2016-03-18 06:36:58 +00:00
else if (!string.IsNullOrWhiteSpace(path) && !string.Equals(path, "index.html", StringComparison.OrdinalIgnoreCase))
2016-03-16 18:09:58 +00:00
{
2016-03-18 06:36:58 +00:00
var index = html.IndexOf("<body", StringComparison.OrdinalIgnoreCase);
if (index != -1)
{
html = html.Substring(index);
2017-01-31 21:25:14 +00:00
html = html.Substring(html.IndexOf('>') + 1);
2016-03-18 06:36:58 +00:00
index = html.IndexOf("</body>", StringComparison.OrdinalIgnoreCase);
if (index != -1)
{
2017-01-31 21:25:14 +00:00
html = html.Substring(0, index);
2016-03-18 06:36:58 +00:00
}
}
2017-05-22 04:54:02 +00:00
var mainFile = _fileSystem.ReadAllText(GetResourcePath("index.html"));
2016-03-16 18:09:58 +00:00
2016-05-24 03:06:51 +00:00
html = ReplaceFirst(mainFile, "<div class=\"mainAnimatedPages skinBody\"></div>", "<div class=\"mainAnimatedPages skinBody hide\">" + html + "</div>");
2016-03-16 18:09:58 +00:00
}
2015-05-16 19:09:02 +00:00
2014-10-20 20:23:40 +00:00
if (!string.IsNullOrWhiteSpace(localizationCulture))
{
var lang = localizationCulture.Split('-').FirstOrDefault();
2016-03-20 17:56:03 +00:00
html = html.Replace("<html", "<html data-culture=\"" + localizationCulture + "\" lang=\"" + lang + "\"");
2014-10-20 20:23:40 +00:00
}
}
2015-07-27 19:16:30 +00:00
html = html.Replace("<head>", "<head>" + GetMetaTags(mode) + GetCommonCss(mode, appVersion));
2016-03-18 06:52:47 +00:00
// Disable embedded scripts from plugins. We'll run them later once resources have loaded
2016-03-18 06:36:58 +00:00
if (html.IndexOf("<script", StringComparison.OrdinalIgnoreCase) != -1)
{
2016-03-18 06:52:47 +00:00
html = html.Replace("<script", "<!--<script");
html = html.Replace("</script>", "</script>-->");
2016-03-18 06:36:58 +00:00
}
2014-10-20 20:23:40 +00:00
2016-03-18 06:52:47 +00:00
html = html.Replace("</body>", GetCommonJavascript(mode, appVersion) + "</body>");
2014-10-20 20:23:40 +00:00
var bytes = Encoding.UTF8.GetBytes(html);
return _memoryStreamFactory.CreateNew(bytes);
2014-10-20 20:23:40 +00:00
}
}
2016-03-16 18:09:58 +00:00
public string ReplaceFirst(string text, string search, string replace)
{
int pos = text.IndexOf(search, StringComparison.OrdinalIgnoreCase);
if (pos < 0)
{
return text;
}
return text.Substring(0, pos) + replace + text.Substring(pos + search.Length);
}
2014-10-20 20:23:40 +00:00
/// <summary>
/// Gets the meta tags.
/// </summary>
/// <returns>System.String.</returns>
2015-05-02 16:34:27 +00:00
private static string GetMetaTags(string mode)
2014-10-20 20:23:40 +00:00
{
var sb = new StringBuilder();
2017-02-05 20:44:08 +00:00
if (string.Equals(mode, "cordova", StringComparison.OrdinalIgnoreCase) ||
string.Equals(mode, "android", StringComparison.OrdinalIgnoreCase))
2015-05-02 16:34:27 +00:00
{
2016-09-23 06:20:56 +00:00
sb.Append("<meta http-equiv=\"Content-Security-Policy\" content=\"default-src * 'self' 'unsafe-inline' 'unsafe-eval' data: gap: file: filesystem: ws: wss:;\">");
2016-09-02 01:54:30 +00:00
}
else
{
sb.Append("<meta http-equiv=\"X-UA-Compatibility\" content=\"IE=Edge\">");
2015-05-02 16:34:27 +00:00
}
2015-12-14 15:43:03 +00:00
sb.Append("<link rel=\"manifest\" href=\"manifest.json\">");
2015-05-02 16:34:27 +00:00
sb.Append("<meta name=\"format-detection\" content=\"telephone=no\">");
sb.Append("<meta name=\"msapplication-tap-highlight\" content=\"no\">");
2015-06-19 04:23:55 +00:00
sb.Append("<meta name=\"viewport\" content=\"user-scalable=no, initial-scale=1, maximum-scale=1, minimum-scale=1, width=device-width\">");
2015-04-26 03:25:07 +00:00
sb.Append("<meta name=\"apple-mobile-web-app-capable\" content=\"yes\">");
2014-10-20 20:23:40 +00:00
sb.Append("<meta name=\"mobile-web-app-capable\" content=\"yes\">");
2015-03-21 16:10:02 +00:00
sb.Append("<meta name=\"application-name\" content=\"Emby\">");
2014-10-20 20:23:40 +00:00
//sb.Append("<meta name=\"apple-mobile-web-app-status-bar-style\" content=\"black-translucent\">");
2016-01-05 16:45:36 +00:00
sb.Append("<meta name=\"robots\" content=\"noindex, nofollow, noarchive\">");
2014-10-20 20:23:40 +00:00
2015-07-02 05:08:05 +00:00
// Open graph tags
2016-01-05 16:45:36 +00:00
sb.Append("<meta property=\"og:title\" content=\"Emby\">");
sb.Append("<meta property=\"og:site_name\" content=\"Emby\">");
sb.Append("<meta property=\"og:url\" content=\"http://emby.media\">");
sb.Append("<meta property=\"og:description\" content=\"Energize your media.\">");
sb.Append("<meta property=\"og:type\" content=\"article\">");
sb.Append("<meta property=\"fb:app_id\" content=\"1618309211750238\">");
2015-07-02 05:08:05 +00:00
2014-10-20 20:23:40 +00:00
// http://developer.apple.com/library/ios/#DOCUMENTATION/AppleApplications/Reference/SafariWebContent/ConfiguringWebApplications/ConfiguringWebApplications.html
2016-08-11 05:38:40 +00:00
sb.Append("<link rel=\"apple-touch-icon\" href=\"touchicon.png\">");
sb.Append("<link rel=\"apple-touch-icon\" sizes=\"72x72\" href=\"touchicon72.png\">");
sb.Append("<link rel=\"apple-touch-icon\" sizes=\"114x114\" href=\"touchicon114.png\">");
2016-01-05 16:45:36 +00:00
sb.Append("<link rel=\"apple-touch-startup-image\" href=\"css/images/iossplash.png\">");
sb.Append("<link rel=\"shortcut icon\" href=\"css/images/favicon.ico\">");
2016-08-11 05:38:40 +00:00
sb.Append("<meta name=\"msapplication-TileImage\" content=\"touchicon144.png\">");
sb.Append("<meta name=\"msapplication-TileColor\" content=\"#333333\">");
2016-04-09 19:04:14 +00:00
sb.Append("<meta name=\"theme-color\" content=\"#43A047\">");
2014-10-20 20:23:40 +00:00
return sb.ToString();
}
/// <summary>
/// Gets the common CSS.
/// </summary>
2015-05-02 16:34:27 +00:00
/// <param name="mode">The mode.</param>
2014-10-20 20:23:40 +00:00
/// <param name="version">The version.</param>
/// <returns>System.String.</returns>
2015-07-20 03:43:13 +00:00
private string GetCommonCss(string mode, string version)
2014-10-20 20:23:40 +00:00
{
2017-02-05 20:44:08 +00:00
var versionString = string.IsNullOrWhiteSpace(mode) ? "?v=" + version : string.Empty;
2014-10-20 20:23:40 +00:00
var files = new[]
{
2017-01-27 23:05:04 +00:00
"css/site.css" + versionString,
"css/librarymenu.css" + versionString,
"css/librarybrowser.css" + versionString,
"thirdparty/paper-button-style.css" + versionString
2014-10-20 20:23:40 +00:00
};
2015-12-14 15:43:03 +00:00
var tags = files.Select(s => string.Format("<link rel=\"stylesheet\" href=\"{0}\" async />", s)).ToArray();
2014-10-20 20:23:40 +00:00
return string.Join(string.Empty, tags);
}
2015-07-12 16:06:23 +00:00
/// <summary>
/// Gets the common javascript.
/// </summary>
/// <param name="mode">The mode.</param>
/// <param name="version">The version.</param>
/// <returns>System.String.</returns>
2016-03-18 06:52:47 +00:00
private string GetCommonJavascript(string mode, string version)
2015-07-12 16:06:23 +00:00
{
var builder = new StringBuilder();
2015-12-14 15:43:03 +00:00
builder.Append("<script>");
if (!string.IsNullOrWhiteSpace(mode))
2015-07-12 16:06:23 +00:00
{
2015-12-14 15:43:03 +00:00
builder.AppendFormat("window.appMode='{0}';", mode);
}
2015-07-12 16:06:23 +00:00
2017-02-05 20:44:08 +00:00
if (string.IsNullOrWhiteSpace(mode))
2015-12-14 15:43:03 +00:00
{
builder.AppendFormat("window.dashboardVersion='{0}';", version);
}
2015-07-12 16:06:23 +00:00
2015-12-14 15:43:03 +00:00
builder.Append("</script>");
2014-10-20 20:23:40 +00:00
2017-02-05 20:44:08 +00:00
var versionString = string.IsNullOrWhiteSpace(mode) ? "?v=" + version : string.Empty;
2014-10-20 20:23:40 +00:00
2015-12-21 17:48:14 +00:00
var files = new List<string>();
2017-04-13 18:57:24 +00:00
files.Add("scripts/apploader.js" + versionString);
2014-10-20 20:23:40 +00:00
2015-05-02 16:34:27 +00:00
if (string.Equals(mode, "cordova", StringComparison.OrdinalIgnoreCase))
{
files.Insert(0, "cordova.js");
}
var tags = files.Select(s => string.Format("<script src=\"{0}\" defer></script>", s)).ToArray();
2014-10-20 20:23:40 +00:00
2015-12-14 15:43:03 +00:00
builder.Append(string.Join(string.Empty, tags));
2014-10-20 20:23:40 +00:00
2015-12-14 15:43:03 +00:00
return builder.ToString();
2014-10-20 20:23:40 +00:00
}
/// <summary>
/// Gets the raw resource stream.
/// </summary>
2017-02-07 07:33:24 +00:00
private Stream GetRawResourceStream(string virtualPath)
2014-10-20 20:23:40 +00:00
{
2017-05-22 04:54:02 +00:00
return _fileSystem.GetFileStream(GetResourcePath(virtualPath), FileOpenMode.Open, FileAccessMode.Read, FileShareMode.ReadWrite, true);
2014-10-20 20:23:40 +00:00
}
}
}