jellyfin/MediaBrowser.WebDashboard/Api/DashboardService.cs

467 lines
19 KiB
C#
Raw Normal View History

2015-07-13 21:26:11 +00:00
using MediaBrowser.Common.Extensions;
using MediaBrowser.Common.IO;
2013-02-21 01:33:05 +00:00
using MediaBrowser.Controller;
using MediaBrowser.Controller.Configuration;
2014-03-31 01:00:47 +00:00
using MediaBrowser.Controller.Localization;
2013-12-07 15:52:38 +00:00
using MediaBrowser.Controller.Net;
2013-02-21 01:33:05 +00:00
using MediaBrowser.Controller.Plugins;
2015-01-17 20:12:02 +00:00
using MediaBrowser.Model.Extensions;
using MediaBrowser.Model.Logging;
2014-12-26 17:45:06 +00:00
using MediaBrowser.Model.Net;
2014-03-31 02:33:10 +00:00
using MediaBrowser.Model.Serialization;
2013-12-07 15:52:38 +00:00
using ServiceStack;
2014-03-25 21:13:55 +00:00
using ServiceStack.Web;
2013-02-21 01:33:05 +00:00
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
2015-07-13 21:26:11 +00:00
using System.Text;
2013-02-21 01:33:05 +00:00
using System.Threading.Tasks;
2015-10-04 04:23:11 +00:00
using CommonIO;
2015-06-13 04:14:48 +00:00
using WebMarkupMin.Core.Minifiers;
2013-02-21 01:33:05 +00:00
namespace MediaBrowser.WebDashboard.Api
{
/// <summary>
/// Class GetDashboardConfigurationPages
/// </summary>
[Route("/dashboard/ConfigurationPages", "GET")]
[Route("/web/ConfigurationPages", "GET")]
public class GetDashboardConfigurationPages : IReturn<List<ConfigurationPageInfo>>
2013-02-21 01:33:05 +00:00
{
/// <summary>
/// Gets or sets the type of the page.
/// </summary>
/// <value>The type of the page.</value>
public ConfigurationPageType? PageType { get; set; }
}
/// <summary>
/// Class GetDashboardConfigurationPage
/// </summary>
[Route("/dashboard/ConfigurationPage", "GET")]
[Route("/web/ConfigurationPage", "GET")]
public class GetDashboardConfigurationPage
2013-02-21 01:33:05 +00:00
{
/// <summary>
/// Gets or sets the name.
/// </summary>
/// <value>The name.</value>
public string Name { get; set; }
}
2014-10-20 20:23:40 +00:00
[Route("/web/Package", "GET")]
[Route("/dashboard/Package", "GET")]
public class GetDashboardPackage
{
2015-05-02 16:34:27 +00:00
public string Mode { get; set; }
2014-10-20 20:23:40 +00:00
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Class GetDashboardResource
/// </summary>
[Route("/web/{ResourceName*}", "GET")]
2013-02-27 16:46:48 +00:00
[Route("/dashboard/{ResourceName*}", "GET")]
2013-02-21 01:33:05 +00:00
public class GetDashboardResource
{
/// <summary>
/// Gets or sets the name.
/// </summary>
/// <value>The name.</value>
2013-02-27 16:46:48 +00:00
public string ResourceName { get; set; }
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the V.
/// </summary>
/// <value>The V.</value>
public string V { get; set; }
}
/// <summary>
/// Class DashboardService
/// </summary>
public class DashboardService : IRestfulService, IHasResultFactory
2013-02-21 01:33:05 +00:00
{
/// <summary>
/// Gets or sets the logger.
/// </summary>
/// <value>The logger.</value>
public ILogger Logger { get; set; }
/// <summary>
/// Gets or sets the HTTP result factory.
/// </summary>
/// <value>The HTTP result factory.</value>
public IHttpResultFactory ResultFactory { get; set; }
/// <summary>
/// Gets or sets the request context.
/// </summary>
/// <value>The request context.</value>
2013-12-07 15:52:38 +00:00
public IRequest Request { get; set; }
2013-05-01 03:28:26 +00:00
/// <summary>
/// The _app host
/// </summary>
2013-03-07 05:34:00 +00:00
private readonly IServerApplicationHost _appHost;
2013-05-01 03:28:26 +00:00
/// <summary>
/// The _server configuration manager
/// </summary>
private readonly IServerConfigurationManager _serverConfigurationManager;
private readonly IFileSystem _fileSystem;
2014-03-31 01:00:47 +00:00
private readonly ILocalizationManager _localization;
2014-03-31 02:33:10 +00:00
private readonly IJsonSerializer _jsonSerializer;
2013-02-23 07:57:11 +00:00
/// <summary>
/// Initializes a new instance of the <see cref="DashboardService" /> class.
/// </summary>
/// <param name="appHost">The app host.</param>
2013-04-10 17:11:23 +00:00
/// <param name="serverConfigurationManager">The server configuration manager.</param>
2014-03-25 21:13:55 +00:00
/// <param name="fileSystem">The file system.</param>
2014-03-31 02:33:10 +00:00
public DashboardService(IServerApplicationHost appHost, IServerConfigurationManager serverConfigurationManager, IFileSystem fileSystem, ILocalizationManager localization, IJsonSerializer jsonSerializer)
2013-02-23 07:57:11 +00:00
{
2013-03-07 05:34:00 +00:00
_appHost = appHost;
_serverConfigurationManager = serverConfigurationManager;
_fileSystem = fileSystem;
2014-03-31 01:00:47 +00:00
_localization = localization;
2014-03-31 02:33:10 +00:00
_jsonSerializer = jsonSerializer;
2013-02-23 07:57:11 +00:00
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets the specified request.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>System.Object.</returns>
public object Get(GetDashboardConfigurationPage request)
{
var page = ServerEntryPoint.Instance.PluginConfigurationPages.First(p => p.Name.Equals(request.Name, StringComparison.OrdinalIgnoreCase));
2013-02-21 01:33:05 +00:00
2015-07-17 22:32:00 +00:00
return ResultFactory.GetStaticResult(Request, page.Plugin.Version.ToString().GetMD5(), null, null, MimeTypes.GetMimeType("page.html"), () => GetPackageCreator().ModifyHtml(page.GetHtmlStream(), null, _appHost.ApplicationVersion.ToString(), null, false));
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Gets the specified request.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>System.Object.</returns>
public object Get(GetDashboardConfigurationPages request)
{
2013-07-08 16:13:21 +00:00
const string unavilableMessage = "The server is still loading. Please try again momentarily.";
var instance = ServerEntryPoint.Instance;
if (instance == null)
{
throw new InvalidOperationException(unavilableMessage);
}
var pages = instance.PluginConfigurationPages;
if (pages == null)
{
throw new InvalidOperationException(unavilableMessage);
}
2013-02-21 01:33:05 +00:00
if (request.PageType.HasValue)
{
pages = pages.Where(p => p.ConfigurationPageType == request.PageType.Value);
}
2013-12-15 01:17:57 +00:00
// Don't allow a failing plugin to fail them all
var configPages = pages.Select(p =>
{
try
{
return new ConfigurationPageInfo(p);
}
catch (Exception ex)
{
Logger.ErrorException("Error getting plugin information from {0}", ex, p.GetType().Name);
return null;
}
})
.Where(i => i != null)
.ToList();
return ResultFactory.GetOptimizedResult(Request, configPages);
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Gets the specified request.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>System.Object.</returns>
public object Get(GetDashboardResource request)
{
2013-02-27 16:46:48 +00:00
var path = request.ResourceName;
2013-02-21 01:33:05 +00:00
var contentType = MimeTypes.GetMimeType(path);
2015-07-12 16:06:23 +00:00
// Bounce them to the startup wizard if it hasn't been completed yet
2015-08-22 18:09:02 +00:00
if (!_serverConfigurationManager.Configuration.IsStartupWizardCompleted && path.IndexOf("wizard", StringComparison.OrdinalIgnoreCase) == -1 && GetPackageCreator().IsCoreHtml(path))
2014-08-07 02:51:09 +00:00
{
2015-07-12 16:06:23 +00:00
// But don't redirect if an html import is being requested.
if (path.IndexOf("vulcanize", StringComparison.OrdinalIgnoreCase) == -1 && path.IndexOf("bower_components", StringComparison.OrdinalIgnoreCase) == -1)
2014-08-07 02:51:09 +00:00
{
Request.Response.Redirect("wizardstart.html");
return null;
2014-10-20 20:23:40 +00:00
}
2014-08-07 02:51:09 +00:00
}
2014-11-03 03:38:43 +00:00
path = path.Replace("scripts/jquery.mobile-1.4.5.min.map", "thirdparty/jquerymobile-1.4.5/jquery.mobile-1.4.5.min.map", StringComparison.OrdinalIgnoreCase);
2014-08-17 05:38:13 +00:00
2014-03-31 21:04:22 +00:00
var localizationCulture = GetLocalizationCulture();
2014-03-31 01:00:47 +00:00
// Don't cache if not configured to do so
// But always cache images to simulate production
2014-03-31 01:00:47 +00:00
if (!_serverConfigurationManager.Configuration.EnableDashboardResponseCaching &&
!contentType.StartsWith("image/", StringComparison.OrdinalIgnoreCase) &&
2013-12-16 18:44:03 +00:00
!contentType.StartsWith("font/", StringComparison.OrdinalIgnoreCase))
{
2014-10-20 20:23:40 +00:00
return ResultFactory.GetResult(GetResourceStream(path, localizationCulture).Result, contentType);
}
2013-02-21 01:33:05 +00:00
TimeSpan? cacheDuration = null;
// Cache images unconditionally - updates to image files will require new filename
// If there's a version number in the query string we can cache this unconditionally
2013-12-16 18:44:03 +00:00
if (contentType.StartsWith("image/", StringComparison.OrdinalIgnoreCase) || contentType.StartsWith("font/", StringComparison.OrdinalIgnoreCase) || !string.IsNullOrEmpty(request.V))
2013-02-21 01:33:05 +00:00
{
cacheDuration = TimeSpan.FromDays(365);
}
var assembly = GetType().Assembly.GetName();
2014-03-31 01:00:47 +00:00
var cacheKey = (assembly.Version + (localizationCulture ?? string.Empty) + path).GetMD5();
2014-10-20 20:23:40 +00:00
return ResultFactory.GetStaticResult(Request, cacheKey, null, cacheDuration, contentType, () => GetResourceStream(path, localizationCulture));
2014-03-31 01:00:47 +00:00
}
private string GetLocalizationCulture()
{
return _serverConfigurationManager.Configuration.UICulture;
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Gets the resource stream.
/// </summary>
/// <param name="path">The path.</param>
2014-03-31 01:00:47 +00:00
/// <param name="localizationCulture">The localization culture.</param>
2013-02-21 01:33:05 +00:00
/// <returns>Task{Stream}.</returns>
2014-10-20 20:23:40 +00:00
private Task<Stream> GetResourceStream(string path, string localizationCulture)
2013-02-21 01:33:05 +00:00
{
2015-01-18 05:45:10 +00:00
var minify = _serverConfigurationManager.Configuration.EnableDashboardResourceMinification;
2014-10-20 20:23:40 +00:00
return GetPackageCreator()
2015-05-02 16:34:27 +00:00
.GetResource(path, null, localizationCulture, _appHost.ApplicationVersion.ToString(), minify);
2013-02-21 01:33:05 +00:00
}
2014-10-20 20:23:40 +00:00
private PackageCreator GetPackageCreator()
2013-02-21 01:33:05 +00:00
{
2014-10-20 20:23:40 +00:00
return new PackageCreator(_fileSystem, _localization, Logger, _serverConfigurationManager, _jsonSerializer);
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Determines whether the specified path is HTML.
/// </summary>
/// <param name="path">The path.</param>
/// <returns><c>true</c> if the specified path is HTML; otherwise, <c>false</c>.</returns>
private bool IsHtml(string path)
{
return Path.GetExtension(path).EndsWith("html", StringComparison.OrdinalIgnoreCase);
}
2015-06-20 04:48:45 +00:00
private void CopyFile(string src, string dst)
{
2015-09-13 21:32:02 +00:00
_fileSystem.CreateDirectory(Path.GetDirectoryName(dst));
_fileSystem.CopyFile(src, dst, true);
2015-06-20 04:48:45 +00:00
}
2014-10-20 20:23:40 +00:00
public async Task<object> Get(GetDashboardPackage request)
2013-02-21 01:33:05 +00:00
{
2014-10-20 20:23:40 +00:00
var path = Path.Combine(_serverConfigurationManager.ApplicationPaths.ProgramDataPath,
"webclient-dump");
2013-02-21 01:33:05 +00:00
2014-10-20 20:23:40 +00:00
try
2014-10-16 03:26:39 +00:00
{
_fileSystem.DeleteDirectory(path, true);
2014-03-31 01:00:47 +00:00
}
2014-10-20 20:23:40 +00:00
catch (IOException)
2014-03-31 01:00:47 +00:00
{
2015-06-09 05:56:46 +00:00
2014-03-31 01:00:47 +00:00
}
2014-10-20 20:23:40 +00:00
var creator = GetPackageCreator();
2014-03-31 01:00:47 +00:00
2014-10-20 20:23:40 +00:00
CopyDirectory(creator.DashboardUIPath, path);
2015-07-27 18:18:10 +00:00
string culture = null;
2013-02-21 01:33:05 +00:00
2015-05-13 04:31:22 +00:00
var appVersion = _appHost.ApplicationVersion.ToString();
2013-02-21 01:33:05 +00:00
2015-05-02 16:34:27 +00:00
var mode = request.Mode;
2014-10-21 00:54:01 +00:00
2015-05-16 19:09:02 +00:00
if (string.Equals(mode, "cordova", StringComparison.OrdinalIgnoreCase))
{
// Overwrite certain files with cordova specific versions
2015-06-20 04:48:45 +00:00
var cordovaVersion = Path.Combine(path, "cordova", "registrationservices.js");
2015-09-13 21:32:02 +00:00
_fileSystem.CopyFile(cordovaVersion, Path.Combine(path, "scripts", "registrationservices.js"), true);
_fileSystem.DeleteFile(cordovaVersion);
2015-06-09 05:56:46 +00:00
2015-06-11 06:27:05 +00:00
// Delete things that are unneeded in an attempt to keep the output as trim as possible
2015-09-13 21:32:02 +00:00
_fileSystem.DeleteDirectory(Path.Combine(path, "css", "images", "tour"), true);
_fileSystem.DeleteDirectory(Path.Combine(path, "apiclient", "alt"), true);
2015-06-11 06:27:05 +00:00
2015-09-13 21:32:02 +00:00
_fileSystem.DeleteFile(Path.Combine(path, "thirdparty", "jquerymobile-1.4.5", "jquery.mobile-1.4.5.min.map"));
2015-06-20 04:48:45 +00:00
2015-09-13 21:32:02 +00:00
_fileSystem.DeleteDirectory(Path.Combine(path, "bower_components"), true);
_fileSystem.DeleteDirectory(Path.Combine(path, "thirdparty", "viblast"), true);
2015-07-12 16:06:23 +00:00
2015-06-20 04:48:45 +00:00
// But we do need this
2015-07-12 16:06:23 +00:00
CopyFile(Path.Combine(creator.DashboardUIPath, "bower_components", "webcomponentsjs", "webcomponents-lite.js"), Path.Combine(path, "bower_components", "webcomponentsjs", "webcomponents-lite.js"));
2015-06-20 04:48:45 +00:00
CopyFile(Path.Combine(creator.DashboardUIPath, "bower_components", "webcomponentsjs", "webcomponents-lite.min.js"), Path.Combine(path, "bower_components", "webcomponentsjs", "webcomponents-lite.min.js"));
2015-06-26 18:32:21 +00:00
CopyFile(Path.Combine(creator.DashboardUIPath, "bower_components", "velocity", "velocity.min.js"), Path.Combine(path, "bower_components", "velocity", "velocity.min.js"));
2015-07-13 21:26:11 +00:00
CopyFile(Path.Combine(creator.DashboardUIPath, "bower_components", "requirejs", "require.js"), Path.Combine(path, "bower_components", "requirejs", "require.js"));
CopyFile(Path.Combine(creator.DashboardUIPath, "bower_components", "fastclick", "lib", "fastclick.js"), Path.Combine(path, "bower_components", "fastclick", "lib", "fastclick.js"));
CopyFile(Path.Combine(creator.DashboardUIPath, "bower_components", "jquery", "dist", "jquery.min.js"), Path.Combine(path, "bower_components", "jquery", "dist", "jquery.min.js"));
2015-07-28 20:00:15 +00:00
CopyFile(Path.Combine(creator.DashboardUIPath, "bower_components", "jstree", "dist", "jstree.min.js"), Path.Combine(path, "bower_components", "jstree", "dist", "jstree.min.js"));
2015-06-30 17:21:20 +00:00
CopyDirectory(Path.Combine(creator.DashboardUIPath, "bower_components", "swipebox", "src", "css"), Path.Combine(path, "bower_components", "swipebox", "src", "css"));
CopyDirectory(Path.Combine(creator.DashboardUIPath, "bower_components", "swipebox", "src", "js"), Path.Combine(path, "bower_components", "swipebox", "src", "js"));
CopyDirectory(Path.Combine(creator.DashboardUIPath, "bower_components", "swipebox", "src", "img"), Path.Combine(path, "bower_components", "swipebox", "src", "img"));
2015-09-01 19:18:25 +00:00
CopyFile(Path.Combine(creator.DashboardUIPath, "bower_components", "hammerjs", "hammer.min.js"), Path.Combine(path, "bower_components", "hammerjs", "hammer.min.js"));
2015-05-16 19:09:02 +00:00
}
2015-07-15 11:26:47 +00:00
2015-06-13 04:14:48 +00:00
MinifyCssDirectory(Path.Combine(path, "css"));
MinifyJsDirectory(Path.Combine(path, "scripts"));
2015-06-20 04:48:45 +00:00
MinifyJsDirectory(Path.Combine(path, "apiclient"));
2015-06-13 04:14:48 +00:00
MinifyJsDirectory(Path.Combine(path, "voice"));
2015-05-02 16:34:27 +00:00
await DumpHtml(creator.DashboardUIPath, path, mode, culture, appVersion);
await DumpJs(creator.DashboardUIPath, path, mode, culture, appVersion);
await DumpFile("scripts/all.js", Path.Combine(path, "scripts", "all.js"), mode, culture, appVersion).ConfigureAwait(false);
await DumpFile("css/all.css", Path.Combine(path, "css", "all.css"), mode, culture, appVersion).ConfigureAwait(false);
2015-06-09 05:56:46 +00:00
2014-10-20 20:23:40 +00:00
return "";
2013-02-21 01:33:05 +00:00
}
2015-06-13 04:14:48 +00:00
private void MinifyCssDirectory(string path)
{
foreach (var file in Directory.GetFiles(path, "*.css", SearchOption.AllDirectories))
{
try
{
2015-09-13 21:32:02 +00:00
var text = _fileSystem.ReadAllText(file, Encoding.UTF8);
2015-06-13 04:14:48 +00:00
var result = new KristensenCssMinifier().Minify(text, false, Encoding.UTF8);
if (result.Errors.Count > 0)
{
Logger.Error("Error minifying css: " + result.Errors[0].Message);
}
else
{
text = result.MinifiedContent;
2015-09-13 21:32:02 +00:00
_fileSystem.WriteAllText(file, text, Encoding.UTF8);
2015-06-13 04:14:48 +00:00
}
}
catch (Exception ex)
{
Logger.ErrorException("Error minifying css", ex);
}
}
}
private void MinifyJsDirectory(string path)
{
foreach (var file in Directory.GetFiles(path, "*.js", SearchOption.AllDirectories))
{
try
{
2015-09-13 21:32:02 +00:00
var text = _fileSystem.ReadAllText(file, Encoding.UTF8);
2015-06-13 04:14:48 +00:00
var result = new CrockfordJsMinifier().Minify(text, false, Encoding.UTF8);
if (result.Errors.Count > 0)
{
Logger.Error("Error minifying javascript: " + result.Errors[0].Message);
}
else
{
text = result.MinifiedContent;
2015-09-13 21:32:02 +00:00
_fileSystem.WriteAllText(file, text, Encoding.UTF8);
2015-06-13 04:14:48 +00:00
}
}
catch (Exception ex)
{
Logger.ErrorException("Error minifying css", ex);
}
}
}
2015-05-02 16:34:27 +00:00
private async Task DumpHtml(string source, string destination, string mode, string culture, string appVersion)
2014-03-31 01:00:47 +00:00
{
2014-10-20 20:23:40 +00:00
foreach (var file in Directory.GetFiles(source, "*.html", SearchOption.TopDirectoryOnly))
{
2014-10-21 00:54:01 +00:00
var filename = Path.GetFileName(file);
2015-05-02 16:34:27 +00:00
await DumpFile(filename, Path.Combine(destination, filename), mode, culture, appVersion).ConfigureAwait(false);
2014-10-20 20:23:40 +00:00
}
2015-05-21 20:53:14 +00:00
var excludeFiles = new List<string>();
if (string.Equals(mode, "cordova", StringComparison.OrdinalIgnoreCase))
{
excludeFiles.Add("supporterkey.html");
}
foreach (var file in excludeFiles)
{
2015-09-13 21:32:02 +00:00
_fileSystem.DeleteFile(Path.Combine(destination, file));
2015-05-21 20:53:14 +00:00
}
2014-03-31 01:00:47 +00:00
}
2015-05-02 16:34:27 +00:00
private async Task DumpJs(string source, string mode, string destination, string culture, string appVersion)
2014-03-31 01:00:47 +00:00
{
2014-10-21 00:54:01 +00:00
foreach (var file in Directory.GetFiles(source, "*.js", SearchOption.TopDirectoryOnly))
{
var filename = Path.GetFileName(file);
2014-03-31 01:00:47 +00:00
2015-05-02 16:34:27 +00:00
await DumpFile("scripts/" + filename, Path.Combine(destination, "scripts", filename), mode, culture, appVersion).ConfigureAwait(false);
2014-10-21 00:54:01 +00:00
}
}
2014-03-31 01:00:47 +00:00
2015-05-02 16:34:27 +00:00
private async Task DumpFile(string resourceVirtualPath, string destinationFilePath, string mode, string culture, string appVersion)
2014-10-21 00:54:01 +00:00
{
2015-05-02 16:34:27 +00:00
using (var stream = await GetPackageCreator().GetResource(resourceVirtualPath, mode, culture, appVersion, true).ConfigureAwait(false))
2013-04-01 00:22:38 +00:00
{
2014-10-21 00:54:01 +00:00
using (var fs = _fileSystem.GetFileStream(destinationFilePath, FileMode.Create, FileAccess.Write, FileShare.Read))
2014-03-31 01:00:47 +00:00
{
2014-10-20 20:23:40 +00:00
stream.CopyTo(fs);
2014-03-31 01:00:47 +00:00
}
2013-04-01 00:22:38 +00:00
}
}
2014-10-20 20:23:40 +00:00
private void CopyDirectory(string source, string destination)
{
2015-09-13 21:32:02 +00:00
_fileSystem.CreateDirectory(destination);
2013-04-01 00:22:38 +00:00
2014-10-20 20:23:40 +00:00
//Now Create all of the directories
foreach (string dirPath in Directory.GetDirectories(source, "*",
SearchOption.AllDirectories))
2015-09-13 21:32:02 +00:00
_fileSystem.CreateDirectory(dirPath.Replace(source, destination));
2013-04-01 00:22:38 +00:00
2014-10-20 20:23:40 +00:00
//Copy all the files & Replaces any files with the same name
foreach (string newPath in Directory.GetFiles(source, "*.*",
SearchOption.AllDirectories))
2015-09-13 21:32:02 +00:00
_fileSystem.CopyFile(newPath, newPath.Replace(source, destination), true);
}
2013-02-21 01:33:05 +00:00
}
}