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

433 lines
16 KiB
C#
Raw Normal View History

2015-07-13 21:26:11 +00:00
using MediaBrowser.Common.Extensions;
2013-02-21 01:33:05 +00:00
using MediaBrowser.Controller;
using MediaBrowser.Controller.Configuration;
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-02-21 01:33:05 +00:00
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Threading.Tasks;
2016-10-26 06:01:42 +00:00
using MediaBrowser.Common.Plugins;
2016-10-25 19:02:04 +00:00
using MediaBrowser.Model.IO;
2016-10-24 02:45:23 +00:00
using MediaBrowser.Model.Globalization;
2016-10-26 06:01:42 +00:00
using MediaBrowser.Model.Plugins;
using MediaBrowser.Model.Reflection;
2016-10-25 19:02:04 +00:00
using MediaBrowser.Model.Services;
2013-02-21 01:33:05 +00:00
namespace MediaBrowser.WebDashboard.Api
{
/// <summary>
/// Class GetDashboardConfigurationPages
/// </summary>
[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("/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")]
public class GetDashboardPackage
{
2015-05-02 16:34:27 +00:00
public string Mode { get; set; }
2014-10-20 20:23:40 +00:00
}
2016-01-07 03:54:38 +00:00
[Route("/robots.txt", "GET")]
public class GetRobotsTxt
{
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Class GetDashboardResource
/// </summary>
[Route("/web/{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; }
}
2017-01-28 03:16:59 +00:00
[Route("/favicon.ico", "GET")]
public class GetFavIcon
{
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Class DashboardService
/// </summary>
2016-11-10 14:41:24 +00:00
public class DashboardService : IService, IRequiresRequest
2013-02-21 01:33:05 +00:00
{
/// <summary>
/// Gets or sets the logger.
/// </summary>
/// <value>The logger.</value>
2016-11-10 14:41:24 +00:00
private readonly ILogger _logger;
/// <summary>
/// Gets or sets the HTTP result factory.
/// </summary>
/// <value>The HTTP result factory.</value>
2016-11-10 14:41:24 +00:00
private readonly IHttpResultFactory _resultFactory;
/// <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;
2016-10-26 06:01:42 +00:00
private readonly IAssemblyInfo _assemblyInfo;
private readonly IMemoryStreamFactory _memoryStreamFactory;
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>
public DashboardService(IServerApplicationHost appHost, IServerConfigurationManager serverConfigurationManager, IFileSystem fileSystem, ILocalizationManager localization, IJsonSerializer jsonSerializer, IAssemblyInfo assemblyInfo, ILogger logger, IHttpResultFactory resultFactory, IMemoryStreamFactory memoryStreamFactory)
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;
2016-10-26 06:01:42 +00:00
_assemblyInfo = assemblyInfo;
2016-11-10 14:41:24 +00:00
_logger = logger;
_resultFactory = resultFactory;
_memoryStreamFactory = memoryStreamFactory;
2013-02-23 07:57:11 +00:00
}
2013-02-21 01:33:05 +00:00
2017-02-07 07:33:24 +00:00
/// <summary>
/// Gets the dashboard UI path.
/// </summary>
/// <value>The dashboard UI path.</value>
public string DashboardUIPath
{
get
{
if (!string.IsNullOrEmpty(_serverConfigurationManager.Configuration.DashboardSourcePath))
{
return _serverConfigurationManager.Configuration.DashboardSourcePath;
}
return Path.Combine(_serverConfigurationManager.ApplicationPaths.ApplicationResourcesPath, "dashboard-ui");
}
}
2017-01-28 03:16:59 +00:00
public object Get(GetFavIcon request)
{
return Get(new GetDashboardResource
{
ResourceName = "favicon.ico"
});
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets the specified request.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>System.Object.</returns>
2016-06-19 06:18:29 +00:00
public Task<object> Get(GetDashboardConfigurationPage request)
2013-02-21 01:33:05 +00:00
{
2016-10-26 06:01:42 +00:00
IPlugin plugin = null;
Stream stream = null;
2013-02-21 01:33:05 +00:00
2016-10-26 06:01:42 +00:00
var page = ServerEntryPoint.Instance.PluginConfigurationPages.FirstOrDefault(p => string.Equals(p.Name, request.Name, StringComparison.OrdinalIgnoreCase));
if (page != null)
{
plugin = page.Plugin;
stream = page.GetHtmlStream();
}
if (plugin == null)
{
var altPage = GetPluginPages().FirstOrDefault(p => string.Equals(p.Item1.Name, request.Name, StringComparison.OrdinalIgnoreCase));
if (altPage != null)
{
plugin = altPage.Item2;
stream = _assemblyInfo.GetManifestResourceStream(plugin.GetType(), altPage.Item1.EmbeddedResourcePath);
}
}
if (plugin != null && stream != null)
{
2017-02-07 07:33:24 +00:00
return _resultFactory.GetStaticResult(Request, plugin.Version.ToString().GetMD5(), null, null, MimeTypes.GetMimeType("page.html"), () => GetPackageCreator(DashboardUIPath).ModifyHtml("dummy.html", stream, null, _appHost.ApplicationVersion.ToString(), null));
2016-10-26 06:01:42 +00:00
}
throw new ResourceNotFoundException();
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)
{
2016-10-26 06:01:42 +00:00
pages = pages.Where(p => p.ConfigurationPageType == request.PageType.Value).ToList();
2013-02-21 01:33:05 +00:00
}
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)
{
2016-11-10 14:41:24 +00:00
_logger.ErrorException("Error getting plugin information from {0}", ex, p.GetType().Name);
2013-12-15 01:17:57 +00:00
return null;
}
})
.Where(i => i != null)
.ToList();
2016-10-26 06:01:42 +00:00
configPages.AddRange(_appHost.Plugins.SelectMany(GetConfigPages));
2016-11-10 14:41:24 +00:00
return _resultFactory.GetOptimizedResult(Request, configPages);
2013-02-21 01:33:05 +00:00
}
2016-10-26 06:01:42 +00:00
private IEnumerable<Tuple<PluginPageInfo, IPlugin>> GetPluginPages()
{
return _appHost.Plugins.SelectMany(GetPluginPages);
}
private IEnumerable<Tuple<PluginPageInfo, IPlugin>> GetPluginPages(IPlugin plugin)
{
var hasConfig = plugin as IHasWebPages;
if (hasConfig == null)
{
return new List<Tuple<PluginPageInfo, IPlugin>>();
}
return hasConfig.GetPages().Select(i => new Tuple<PluginPageInfo, IPlugin>(i, plugin));
}
private IEnumerable<ConfigurationPageInfo> GetConfigPages(IPlugin plugin)
{
return GetPluginPages(plugin).Select(i => new ConfigurationPageInfo(plugin, i.Item1));
}
2016-01-07 03:54:38 +00:00
public object Get(GetRobotsTxt request)
{
return Get(new GetDashboardResource
{
ResourceName = "robots.txt"
});
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets the specified request.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>System.Object.</returns>
2016-06-19 06:18:29 +00:00
public async Task<object> Get(GetDashboardResource request)
2013-02-21 01:33:05 +00:00
{
2013-02-27 16:46:48 +00:00
var path = request.ResourceName;
2013-02-21 01:33:05 +00:00
2015-12-13 04:53:56 +00:00
path = path.Replace("bower_components" + _appHost.ApplicationVersion, "bower_components", StringComparison.OrdinalIgnoreCase);
2013-02-21 01:33:05 +00:00
var contentType = MimeTypes.GetMimeType(path);
2017-02-07 07:33:24 +00:00
var basePath = DashboardUIPath;
2013-02-21 01:33:05 +00:00
2015-07-12 16:06:23 +00:00
// Bounce them to the startup wizard if it hasn't been completed yet
2017-02-07 07:33:24 +00:00
if (!_serverConfigurationManager.Configuration.IsStartupWizardCompleted &&
path.IndexOf("wizard", StringComparison.OrdinalIgnoreCase) == -1 && GetPackageCreator(basePath).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.
2015-12-04 19:58:30 +00:00
if (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))
{
2017-02-07 07:33:24 +00:00
var stream = await GetResourceStream(basePath, path, localizationCulture).ConfigureAwait(false);
2016-11-10 14:41:24 +00:00
return _resultFactory.GetResult(stream, 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 cacheKey = (_appHost.ApplicationVersion + (localizationCulture ?? string.Empty) + path).GetMD5();
2017-02-07 07:33:24 +00:00
return await _resultFactory.GetStaticResult(Request, cacheKey, null, cacheDuration, contentType, () => GetResourceStream(basePath, path, localizationCulture)).ConfigureAwait(false);
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>
2017-02-07 07:33:24 +00:00
private Task<Stream> GetResourceStream(string basePath, string virtualPath, string localizationCulture)
2013-02-21 01:33:05 +00:00
{
2017-02-07 07:33:24 +00:00
return GetPackageCreator(basePath)
.GetResource(virtualPath, null, localizationCulture, _appHost.ApplicationVersion.ToString());
2013-02-21 01:33:05 +00:00
}
2017-02-07 07:33:24 +00:00
private PackageCreator GetPackageCreator(string basePath)
2013-02-21 01:33:05 +00:00
{
2017-02-07 07:33:24 +00:00
return new PackageCreator(basePath, _fileSystem, _logger, _serverConfigurationManager, _memoryStreamFactory);
2013-02-21 01:33:05 +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
{
2016-09-29 12:55:49 +00:00
var mode = request.Mode;
2017-02-07 07:33:24 +00:00
var inputPath = string.IsNullOrWhiteSpace(mode) ?
DashboardUIPath
: "C:\\dev\\emby-web-mobile-master\\dist";
var targetPath = !string.IsNullOrWhiteSpace(mode) ?
inputPath
2016-09-29 12:55:49 +00:00
: "C:\\dev\\emby-web-mobile\\src";
2013-02-21 01:33:05 +00:00
2017-02-07 07:33:24 +00:00
var packageCreator = GetPackageCreator(inputPath);
2015-06-09 05:56:46 +00:00
2017-02-07 07:33:24 +00:00
if (!string.Equals(inputPath, targetPath, StringComparison.OrdinalIgnoreCase))
{
try
{
_fileSystem.DeleteDirectory(targetPath, true);
}
catch (IOException)
{
2014-03-31 01:00:47 +00:00
2017-02-07 07:33:24 +00:00
}
2014-03-31 01:00:47 +00:00
2017-02-07 07:33:24 +00:00
CopyDirectory(inputPath, targetPath);
}
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
2017-02-07 07:33:24 +00:00
await DumpHtml(packageCreator, inputPath, targetPath, mode, culture, appVersion);
2015-05-02 16:34:27 +00:00
2014-10-20 20:23:40 +00:00
return "";
2013-02-21 01:33:05 +00:00
}
2017-02-07 07:33:24 +00:00
private async Task DumpHtml(PackageCreator packageCreator, string source, string destination, string mode, string culture, string appVersion)
2014-03-31 01:00:47 +00:00
{
2016-10-25 19:11:27 +00:00
foreach (var file in _fileSystem.GetFiles(source))
2014-10-20 20:23:40 +00:00
{
2016-10-25 19:11:27 +00:00
var filename = file.Name;
2014-10-21 00:54:01 +00:00
2017-02-07 07:33:24 +00:00
if (!string.Equals(file.Extension, ".html", StringComparison.OrdinalIgnoreCase))
{
continue;
}
await DumpFile(packageCreator, filename, Path.Combine(destination, filename), mode, culture, appVersion).ConfigureAwait(false);
2014-10-20 20:23:40 +00:00
}
2014-03-31 01:00:47 +00:00
}
2017-02-07 07:33:24 +00:00
private async Task DumpFile(PackageCreator packageCreator, string resourceVirtualPath, string destinationFilePath, string mode, string culture, string appVersion)
2014-10-21 00:54:01 +00:00
{
2017-02-07 07:33:24 +00:00
using (var stream = await packageCreator.GetResource(resourceVirtualPath, mode, culture, appVersion).ConfigureAwait(false))
2013-04-01 00:22:38 +00:00
{
2016-10-25 19:02:04 +00:00
using (var fs = _fileSystem.GetFileStream(destinationFilePath, FileOpenMode.Create, FileAccessMode.Write, FileShareMode.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-12-13 04:53:56 +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
2016-10-25 19:11:27 +00:00
foreach (var dirPath in _fileSystem.GetDirectories(source, true))
_fileSystem.CreateDirectory(dirPath.FullName.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
2016-10-25 19:11:27 +00:00
foreach (var newPath in _fileSystem.GetFiles(source, true))
_fileSystem.CopyFile(newPath.FullName, newPath.FullName.Replace(source, destination), true);
}
2013-02-21 01:33:05 +00:00
}
}