using MediaBrowser.Common.Extensions; using MediaBrowser.Common.IO; using MediaBrowser.Common.Net; using MediaBrowser.Common.ScheduledTasks; using MediaBrowser.Controller; using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Library; using MediaBrowser.Controller.Plugins; using MediaBrowser.Model.Logging; using MediaBrowser.Model.Tasks; using ServiceStack.ServiceHost; using System; using System.Collections.Generic; using System.ComponentModel.Composition; using System.Diagnostics; using System.IO; using System.Linq; using System.Reflection; using System.Text; using System.Text.RegularExpressions; using System.Threading.Tasks; namespace MediaBrowser.WebDashboard.Api { /// /// Class GetDashboardConfigurationPages /// [Route("/dashboard/ConfigurationPages", "GET")] [Restrict(VisibilityTo = EndpointAttributes.None)] public class GetDashboardConfigurationPages : IReturn> { /// /// Gets or sets the type of the page. /// /// The type of the page. public ConfigurationPageType? PageType { get; set; } } /// /// Class GetDashboardConfigurationPage /// [Route("/dashboard/ConfigurationPage", "GET")] [Restrict(VisibilityTo = EndpointAttributes.None)] public class GetDashboardConfigurationPage { /// /// Gets or sets the name. /// /// The name. public string Name { get; set; } } /// /// Class GetDashboardResource /// [Route("/dashboard/{ResourceName*}", "GET")] [Restrict(VisibilityTo = EndpointAttributes.None)] public class GetDashboardResource { /// /// Gets or sets the name. /// /// The name. public string ResourceName { get; set; } /// /// Gets or sets the V. /// /// The V. public string V { get; set; } } /// /// Class GetDashboardInfo /// [Route("/dashboard/dashboardInfo", "GET")] [Restrict(VisibilityTo = EndpointAttributes.None)] public class GetDashboardInfo : IReturn { } /// /// Class DashboardService /// [Export(typeof(IRestfulService))] public class DashboardService : IRestfulService, IHasResultFactory { /// /// Gets or sets the logger. /// /// The logger. public ILogger Logger { get; set; } /// /// Gets or sets the HTTP result factory. /// /// The HTTP result factory. public IHttpResultFactory ResultFactory { get; set; } /// /// Gets or sets the request context. /// /// The request context. public IRequestContext RequestContext { get; set; } /// /// Gets or sets the task manager. /// /// The task manager. private readonly ITaskManager _taskManager; /// /// The _user manager /// private readonly IUserManager _userManager; /// /// The _app host /// private readonly IServerApplicationHost _appHost; /// /// The _library manager /// private readonly ILibraryManager _libraryManager; private readonly IServerConfigurationManager _serverConfigurationManager; /// /// Initializes a new instance of the class. /// /// The task manager. /// The user manager. /// The app host. /// The library manager. public DashboardService(ITaskManager taskManager, IUserManager userManager, IServerApplicationHost appHost, ILibraryManager libraryManager, IServerConfigurationManager serverConfigurationManager) { _taskManager = taskManager; _userManager = userManager; _appHost = appHost; _libraryManager = libraryManager; _serverConfigurationManager = serverConfigurationManager; } /// /// Gets the specified request. /// /// The request. /// System.Object. public object Get(GetDashboardInfo request) { return GetDashboardInfo(_appHost, Logger, _taskManager, _userManager, _libraryManager).Result; } /// /// Gets the dashboard info. /// /// The app host. /// The logger. /// The task manager. /// The user manager. /// The library manager. /// DashboardInfo. public static async Task GetDashboardInfo(IServerApplicationHost appHost, ILogger logger, ITaskManager taskManager, IUserManager userManager, ILibraryManager libraryManager) { var connections = userManager.RecentConnections.ToArray(); var dtoBuilder = new DtoBuilder(logger, libraryManager); var tasks = userManager.Users.Where(u => connections.Any(c => c.UserId == u.Id)).Select(dtoBuilder.GetUserDto); var users = await Task.WhenAll(tasks).ConfigureAwait(false); return new DashboardInfo { SystemInfo = appHost.GetSystemInfo(), RunningTasks = taskManager.ScheduledTasks.Where(i => i.State == TaskState.Running || i.State == TaskState.Cancelling) .Select(ScheduledTaskHelpers.GetTaskInfo) .ToArray(), ApplicationUpdateTaskId = taskManager.ScheduledTasks.First(t => t.ScheduledTask.GetType().Name.Equals("SystemUpdateTask", StringComparison.OrdinalIgnoreCase)).Id, ActiveConnections = connections, Users = users }; } /// /// Gets the specified request. /// /// The request. /// System.Object. public object Get(GetDashboardConfigurationPage request) { var page = ServerEntryPoint.Instance.PluginConfigurationPages.First(p => p.Name.Equals(request.Name, StringComparison.OrdinalIgnoreCase)); return ResultFactory.GetStaticResult(RequestContext, page.Plugin.Version.ToString().GetMD5(), page.Plugin.AssemblyDateLastModified, null, MimeTypes.GetMimeType("page.html"), () => ModifyHtml(page.GetHtmlStream())); } /// /// Gets the specified request. /// /// The request. /// System.Object. public object Get(GetDashboardConfigurationPages request) { var pages = ServerEntryPoint.Instance.PluginConfigurationPages; if (request.PageType.HasValue) { pages = pages.Where(p => p.ConfigurationPageType == request.PageType.Value); } return ResultFactory.GetOptimizedResult(RequestContext, pages.Select(p => new ConfigurationPageInfo(p)).ToList()); } /// /// Gets the specified request. /// /// The request. /// System.Object. public object Get(GetDashboardResource request) { var path = request.ResourceName; var contentType = MimeTypes.GetMimeType(path); // Don't cache if not configured to do so // But always cache images to simulate production if (!_serverConfigurationManager.Configuration.EnableDashboardResponseCaching && !contentType.StartsWith("image/", StringComparison.OrdinalIgnoreCase)) { return ResultFactory.GetResult(GetResourceStream(path).Result, contentType); } 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 if (contentType.StartsWith("image/", StringComparison.OrdinalIgnoreCase) || !string.IsNullOrEmpty(request.V)) { cacheDuration = TimeSpan.FromDays(365); } var assembly = GetType().Assembly.GetName(); var cacheKey = (assembly.Version + path).GetMD5(); return ResultFactory.GetStaticResult(RequestContext, cacheKey, null, cacheDuration, contentType, () => GetResourceStream(path)); } /// /// Gets the resource stream. /// /// The path. /// Task{Stream}. private async Task GetResourceStream(string path) { Stream resourceStream; if (path.Equals("scripts/all.js", StringComparison.OrdinalIgnoreCase)) { resourceStream = await GetAllJavascript().ConfigureAwait(false); } else { resourceStream = GetRawResourceStream(path); } if (resourceStream != null) { var isHtml = IsHtml(path); // Don't apply any caching for html pages // jQuery ajax doesn't seem to handle if-modified-since correctly if (isHtml) { resourceStream = await ModifyHtml(resourceStream).ConfigureAwait(false); } } return resourceStream; } /// /// Gets the raw resource stream. /// /// The path. /// Task{Stream}. private Stream GetRawResourceStream(string path) { var runningDirectory = Path.GetDirectoryName(Process.GetCurrentProcess().MainModule.FileName); path = Path.Combine(runningDirectory, "dashboard-ui", path.Replace('/', '\\')); return new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.ReadWrite, StreamDefaults.DefaultFileStreamBufferSize, true); // This code is used when the files are embedded resources //return GetType().Assembly.GetManifestResourceStream("MediaBrowser.WebDashboard.Html." + ConvertUrlToResourcePath(path)); } /// /// Converts the URL to a manifest resource path. /// /// The URL. /// System.String. private string ConvertUrlToResourcePath(string url) { var parts = url.Split('/'); var normalizedParts = new string[parts.Length]; for (var i = 0; i < parts.Length; i++) { // We have to do some tricky string replacements for all parts of the path except the last if (i < parts.Length - 1) { // Find the index of the first period as well as the first dash var periodIndex = parts[i].IndexOf('.'); var slashIndex = parts[i].IndexOf('-'); // Replace all periods with "._" and dashes with "_" normalizedParts[i] = parts[i].Replace(".", "._").Replace("-", "_"); // If the first period occurred before the first slash, change it back from "._" to just "." if (periodIndex < slashIndex) { var regex = new Regex("\\._"); normalizedParts[i] = regex.Replace(normalizedParts[i], ".", 1); } } else { normalizedParts[i] = parts[i]; } } return string.Join(".", normalizedParts); } /// /// Determines whether the specified path is HTML. /// /// The path. /// true if the specified path is HTML; otherwise, false. private bool IsHtml(string path) { return Path.GetExtension(path).EndsWith("html", StringComparison.OrdinalIgnoreCase); } /// /// Modifies the HTML by adding common meta tags, css and js. /// /// The source stream. /// Task{Stream}. internal async Task ModifyHtml(Stream sourceStream) { string html; using (var memoryStream = new MemoryStream()) { await sourceStream.CopyToAsync(memoryStream).ConfigureAwait(false); html = Encoding.UTF8.GetString(memoryStream.ToArray()); } var version = GetType().Assembly.GetName().Version; html = html.Replace("", "" + GetMetaTags() + GetCommonCss(version) + GetCommonJavascript(version)); var bytes = Encoding.UTF8.GetBytes(html); sourceStream.Dispose(); return new MemoryStream(bytes); } /// /// Gets the meta tags. /// /// System.String. private static string GetMetaTags() { var sb = new StringBuilder(); sb.Append(""); sb.Append(""); sb.Append(""); // http://developer.apple.com/library/ios/#DOCUMENTATION/AppleApplications/Reference/SafariWebContent/ConfiguringWebApplications/ConfiguringWebApplications.html sb.Append(""); sb.Append(""); sb.Append(""); sb.Append(""); sb.Append(""); return sb.ToString(); } /// /// Gets the common CSS. /// /// The version. /// System.String. private static string GetCommonCss(Version version) { var versionString = "?v=" + version; var files = new[] { "http://code.jquery.com/mobile/1.3.0/jquery.mobile-1.3.0.min.css", "thirdparty/jqm-icon-pack-3.0/font-awesome/jqm-icon-pack-3.0.0-fa.css", "css/jplayer.css" + versionString, "css/site.css" + versionString }; var tags = files.Select(s => string.Format("", s)).ToArray(); return string.Join(string.Empty, tags); } /// /// Gets the common javascript. /// /// The version. /// System.String. private static string GetCommonJavascript(Version version) { var versionString = "?v=" + version; var files = new[] { "http://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js", "http://code.jquery.com/mobile/1.3.0/jquery.mobile-1.3.0.min.js", "thirdparty/jplayer/jquery.jplayer.min.js" + versionString, "thirdparty/jplayer/jplayer.playlist.min.js" + versionString, "scripts/all.js" + versionString }; var tags = files.Select(s => string.Format("", s)).ToArray(); return string.Join(string.Empty, tags); } /// /// Gets a stream containing all concatenated javascript /// /// Task{Stream}. private async Task GetAllJavascript() { var assembly = GetType().Assembly; var scriptFiles = new[] { "extensions.js", "site.js", "aboutpage.js", "addpluginpage.js", "advancedconfigurationpage.js", "advancedmetadataconfigurationpage.js", "plugincatalogpage.js", "dashboardpage.js", "displaysettingspage.js", "edituserpage.js", "indexpage.js", "itembynamedetailpage.js", "itemdetailpage.js", "itemlistpage.js", "loginpage.js", "logpage.js", "medialibrarypage.js", "mediaplayer.js", "metadataconfigurationpage.js", "metadataimagespage.js", "pluginspage.js", "pluginupdatespage.js", "scheduledtaskpage.js", "scheduledtaskspage.js", "updatepasswordpage.js", "userimagepage.js", "userprofilespage.js", "wizardfinishpage.js", "wizardstartpage.js", "wizarduserpage.js", "supporterkeypage.js", "supporterpage.js" }; var memoryStream = new MemoryStream(); var newLineBytes = Encoding.UTF8.GetBytes(Environment.NewLine); await AppendResource(assembly, memoryStream, "MediaBrowser.WebDashboard.ApiClient.js", newLineBytes).ConfigureAwait(false); foreach (var file in scriptFiles) { await AppendResource(memoryStream, "scripts/" + file, newLineBytes).ConfigureAwait(false); } memoryStream.Position = 0; return memoryStream; } /// /// Appends the resource. /// /// The assembly. /// The output stream. /// The path. /// The new line bytes. /// Task. private async Task AppendResource(Assembly assembly, Stream outputStream, string path, byte[] newLineBytes) { using (var stream = assembly.GetManifestResourceStream(path)) { await stream.CopyToAsync(outputStream).ConfigureAwait(false); await outputStream.WriteAsync(newLineBytes, 0, newLineBytes.Length).ConfigureAwait(false); } } /// /// Appends the resource. /// /// The output stream. /// The path. /// The new line bytes. /// Task. private async Task AppendResource(Stream outputStream, string path, byte[] newLineBytes) { using (var stream = GetRawResourceStream(path)) { await stream.CopyToAsync(outputStream).ConfigureAwait(false); await outputStream.WriteAsync(newLineBytes, 0, newLineBytes.Length).ConfigureAwait(false); } } } }