jellyfin/MediaBrowser.WebDashboard/Api/PackageCreator.cs

using MediaBrowser.Controller.Configuration;
using Microsoft.Extensions.Logging;
using MediaBrowser.Model.Serialization;
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using MediaBrowser.Controller.Net;
using MediaBrowser.Model.Globalization;
using MediaBrowser.Model.IO;
using MediaBrowser.Model.Extensions;
using MediaBrowser.Controller;

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;

        public PackageCreator(string basePath, IFileSystem fileSystem, ILogger logger, IServerConfigurationManager config, IResourceFileManager resourceFileManager)
        {
            _fileSystem = fileSystem;
            _logger = logger;
            _config = config;
            _basePath = basePath;
            _resourceFileManager = resourceFileManager;
        }

        public async Task<Stream> GetResource(string virtualPath,
            string mode,
            string localizationCulture,
            string appVersion)
        {
            var resourceStream = GetRawResourceStream(virtualPath);

            if (resourceStream != null)
            {
                if (IsFormat(virtualPath, "html"))
                {
                    if (IsCoreHtml(virtualPath))
                    {
                        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)
        {
            if (path.IndexOf(".template.html", StringComparison.OrdinalIgnoreCase) != -1)
            {
                return false;
            }

            return IsFormat(path, "html");
        }

        /// <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)
        {
            var isMainIndexPage = string.Equals(path, "index.html", StringComparison.OrdinalIgnoreCase);

            using (sourceStream)
            {
                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);
            }
        }

        /// <summary>
        /// Gets the meta tags.
        /// </summary>
        /// <returns>System.String.</returns>
        private string GetMetaTags(string mode)
        {
            var sb = new StringBuilder();

            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:;\">");
            }

            return sb.ToString();
        }

        /// <summary>
        /// Gets the common javascript.
        /// </summary>
        /// <param name="mode">The mode.</param>
        /// <param name="version">The version.</param>
        /// <returns>System.String.</returns>
        private string GetCommonJavascript(string mode, string version)
        {
            var builder = new StringBuilder();

            builder.Append("<script>");
            if (!string.IsNullOrWhiteSpace(mode))
            {
                builder.AppendFormat("window.appMode='{0}';", mode);
            }

            else
            {
                builder.AppendFormat("window.dashboardVersion='{0}';", version);
            }

            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");
            }

            var tags = files.Select(s => string.Format("<script src=\"{0}\" defer></script>", s)).ToArray();

            builder.Append(string.Join(string.Empty, tags));

            return builder.ToString();
        }

        /// <summary>
        /// Gets the raw resource stream.
        /// </summary>
        private Stream GetRawResourceStream(string virtualPath)
        {
            return _resourceFileManager.GetResourceFileStream(_basePath, virtualPath);
        }

    }
}
Mayor code cleanup Add ArgumentExceptions now use proper nameof operators. Added exception messages to quite a few ArgumentExceptions. Fixed rethorwing to be proper syntax. Added a ton of null checkes. (This is only a start, there are about 500 places that need proper null handling) Added some TODOs to log certain exceptions. Fix sln again. Fixed all AssemblyInfo's and added proper copyright (where I could find them) We live in current year. Fixed the use of braces. Fixed a ton of properties, and made a fair amount of functions static that should be and can be static. Made more Methods that should be static static. You can now use static to find bad functions! Removed unused variable. And added one more proper XML comment. 2019-01-06 20:50:43 +00:00			`using MediaBrowser.Controller.Configuration;`
Use Microsoft.Extensions.Logging abstraction 2018-12-13 13:18:25 +00:00			`using Microsoft.Extensions.Logging;`
add reel 2014-10-20 20:23:40 +00:00			`using MediaBrowser.Model.Serialization;`
			`using System;`
			`using System.Collections.Generic;`
			`using System.IO;`
			`using System.Linq;`
			`using System.Text;`
			`using System.Threading.Tasks;`
update access denied exceptions 2015-09-26 02:31:13 +00:00			`using MediaBrowser.Controller.Net;`
move interface to model 2016-10-24 02:45:23 +00:00			`using MediaBrowser.Model.Globalization;`
make controller project portable 2016-10-25 19:02:04 +00:00			`using MediaBrowser.Model.IO;`
consolidate emby.server.core into emby.server.implementations 2017-08-09 19:56:38 +00:00			`using MediaBrowser.Model.Extensions;`
Update to 3.5.2 and .net core 2.1 2018-09-12 17:26:21 +00:00			`using MediaBrowser.Controller;`
add reel 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;`
reduce device discovery traffic 2017-02-07 07:33:24 +00:00			`private readonly string _basePath;`
Update to 3.5.2 and .net core 2.1 2018-09-12 17:26:21 +00:00			`private IResourceFileManager _resourceFileManager;`
add reel 2014-10-20 20:23:40 +00:00
Update to 3.5.2 and .net core 2.1 2018-09-12 17:26:21 +00:00			`public PackageCreator(string basePath, IFileSystem fileSystem, ILogger logger, IServerConfigurationManager config, IResourceFileManager resourceFileManager)`
add reel 2014-10-20 20:23:40 +00:00			`{`
			`_fileSystem = fileSystem;`
			`_logger = logger;`
			`_config = config;`
reduce device discovery traffic 2017-02-07 07:33:24 +00:00			`_basePath = basePath;`
Update to 3.5.2 and .net core 2.1 2018-09-12 17:26:21 +00:00			`_resourceFileManager = resourceFileManager;`
add reel 2014-10-20 20:23:40 +00:00			`}`

reduce device discovery traffic 2017-02-07 07:33:24 +00:00			`public async Task<Stream> GetResource(string virtualPath,`
update image sizes 2015-05-12 13:58:03 +00:00			`string mode,`
add reel 2014-10-20 20:23:40 +00:00			`string localizationCulture,`
filter duplicate recordings based on showId 2016-11-24 16:29:23 +00:00			`string appVersion)`
add reel 2014-10-20 20:23:40 +00:00			`{`
reduce device discovery traffic 2017-02-07 07:33:24 +00:00			`var resourceStream = GetRawResourceStream(virtualPath);`
add reel 2014-10-20 20:23:40 +00:00
			`if (resourceStream != null)`
			`{`
reduce device discovery traffic 2017-02-07 07:33:24 +00:00			`if (IsFormat(virtualPath, "html"))`
fix up project 2015-05-29 02:53:05 +00:00			`{`
reduce device discovery traffic 2017-02-07 07:33:24 +00:00			`if (IsCoreHtml(virtualPath))`
vulcanize 2015-06-20 04:48:45 +00:00			`{`
reduce device discovery traffic 2017-02-07 07:33:24 +00:00			`resourceStream = await ModifyHtml(virtualPath, resourceStream, mode, appVersion, localizationCulture).ConfigureAwait(false);`
vulcanize 2015-06-20 04:48:45 +00:00			`}`
fix up project 2015-05-29 02:53:05 +00:00			`}`
add reel 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>`
updated translations 2015-05-17 03:17:23 +00:00			`/// <param name="format">The format.</param>`
add reel 2014-10-20 20:23:40 +00:00			`/// <returns><c>true</c> if the specified path is HTML; otherwise, <c>false</c>.</returns>`
Mayor code cleanup Add ArgumentExceptions now use proper nameof operators. Added exception messages to quite a few ArgumentExceptions. Fixed rethorwing to be proper syntax. Added a ton of null checkes. (This is only a start, there are about 500 places that need proper null handling) Added some TODOs to log certain exceptions. Fix sln again. Fixed all AssemblyInfo's and added proper copyright (where I could find them) We live in current year. Fixed the use of braces. Fixed a ton of properties, and made a fair amount of functions static that should be and can be static. Made more Methods that should be static static. You can now use static to find bad functions! Removed unused variable. And added one more proper XML comment. 2019-01-06 20:50:43 +00:00			`private static bool IsFormat(string path, string format)`
add reel 2014-10-20 20:23:40 +00:00			`{`
updated translations 2015-05-17 03:17:23 +00:00			`return Path.GetExtension(path).EndsWith(format, StringComparison.OrdinalIgnoreCase);`
add reel 2014-10-20 20:23:40 +00:00			`}`

update startup wizard 2015-08-22 18:09:02 +00:00			`public bool IsCoreHtml(string path)`
vulcanize 2015-06-20 04:48:45 +00:00			`{`
update startup wizard 2015-08-22 18:09:02 +00:00			`if (path.IndexOf(".template.html", StringComparison.OrdinalIgnoreCase) != -1)`
			`{`
			`return false;`
			`}`

Update to 3.5.2 and .net core 2.1 2018-09-12 17:26:21 +00:00			`return IsFormat(path, "html");`
vulcanize 2015-06-20 04:48:45 +00:00			`}`

add reel 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>`
filter duplicate recordings based on showId 2016-11-24 16:29:23 +00:00			`public async Task<Stream> ModifyHtml(string path, Stream sourceStream, string mode, string appVersion, string localizationCulture)`
add reel 2014-10-20 20:23:40 +00:00			`{`
Update to 3.5.2 and .net core 2.1 2018-09-12 17:26:21 +00:00			`var isMainIndexPage = string.Equals(path, "index.html", StringComparison.OrdinalIgnoreCase);`

add reel 2014-10-20 20:23:40 +00:00			`using (sourceStream)`
			`{`
			`string html;`

Update to 3.5.2 and .net core 2.1 2018-09-12 17:26:21 +00:00			`using (var memoryStream = new MemoryStream())`
add reel 2014-10-20 20:23:40 +00:00			`{`
			`await sourceStream.CopyToAsync(memoryStream).ConfigureAwait(false);`

retarget dashboard project 2016-10-26 02:04:49 +00:00			`var originalBytes = memoryStream.ToArray();`

			`html = Encoding.UTF8.GetString(originalBytes, 0, originalBytes.Length);`
add reel 2014-10-20 20:23:40 +00:00
Update to 3.5.2 and .net core 2.1 2018-09-12 17:26:21 +00:00			`if (isMainIndexPage)`
update components 2016-03-16 18:09:58 +00:00			`{`
Update to 3.5.2 and .net core 2.1 2018-09-12 17:26:21 +00:00			`if (!string.IsNullOrWhiteSpace(localizationCulture))`
update plugin pages 2016-03-18 06:36:58 +00:00			`{`
Update to 3.5.2 and .net core 2.1 2018-09-12 17:26:21 +00:00			`var lang = localizationCulture.Split('-').FirstOrDefault();`
update html preparation 2017-01-31 21:25:14 +00:00
Update to 3.5.2 and .net core 2.1 2018-09-12 17:26:21 +00:00			`html = html.Replace("<html", "<html data-culture=\"" + localizationCulture + "\" lang=\"" + lang + "\"");`
update plugin pages 2016-03-18 06:36:58 +00:00			`}`
add reel 2014-10-20 20:23:40 +00:00			`}`
			`}`

Update to 3.5.2 and .net core 2.1 2018-09-12 17:26:21 +00:00			`if (isMainIndexPage)`
			`{`
			`html = html.Replace("<head>", "<head>" + GetMetaTags(mode));`
			`}`
update reports 2015-07-27 19:16:30 +00:00
fix reloading plugin pages 2016-03-18 06:52:47 +00:00			`// Disable embedded scripts from plugins. We'll run them later once resources have loaded`
update plugin pages 2016-03-18 06:36:58 +00:00			`if (html.IndexOf("<script", StringComparison.OrdinalIgnoreCase) != -1)`
			`{`
fix reloading plugin pages 2016-03-18 06:52:47 +00:00			`html = html.Replace("<script", "<!--<script");`
			`html = html.Replace("</script>", "</script>-->");`
update plugin pages 2016-03-18 06:36:58 +00:00			`}`
add reel 2014-10-20 20:23:40 +00:00
Update to 3.5.2 and .net core 2.1 2018-09-12 17:26:21 +00:00			`if (isMainIndexPage)`
			`{`
			`html = html.Replace("</body>", GetCommonJavascript(mode, appVersion) + "</body>");`
			`}`
fix reloading plugin pages 2016-03-18 06:52:47 +00:00
add reel 2014-10-20 20:23:40 +00:00			`var bytes = Encoding.UTF8.GetBytes(html);`

Update to 3.5.2 and .net core 2.1 2018-09-12 17:26:21 +00:00			`return new MemoryStream(bytes);`
add reel 2014-10-20 20:23:40 +00:00			`}`
			`}`

			`/// <summary>`
			`/// Gets the meta tags.`
			`/// </summary>`
			`/// <returns>System.String.</returns>`
Update to 3.5.2 and .net core 2.1 2018-09-12 17:26:21 +00:00			`private string GetMetaTags(string mode)`
add reel 2014-10-20 20:23:40 +00:00			`{`
			`var sb = new StringBuilder();`

add cancellation to socket methods 2017-02-05 20:44:08 +00:00			`if (string.Equals(mode, "cordova", StringComparison.OrdinalIgnoreCase) \|\|`
			`string.Equals(mode, "android", StringComparison.OrdinalIgnoreCase))`
adjust startup sequences 2015-05-02 16:34:27 +00:00			`{`
check against repeat programs 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:;\">");`
update tabs 2016-09-02 01:54:30 +00:00			`}`
add reel 2014-10-20 20:23:40 +00:00
			`return sb.ToString();`
			`}`

resolve script error 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>`
fix reloading plugin pages 2016-03-18 06:52:47 +00:00			`private string GetCommonJavascript(string mode, string version)`
resolve script error 2015-07-12 16:06:23 +00:00			`{`
			`var builder = new StringBuilder();`

merge from dev 2015-12-14 15:43:03 +00:00			`builder.Append("<script>");`
			`if (!string.IsNullOrWhiteSpace(mode))`
resolve script error 2015-07-12 16:06:23 +00:00			`{`
merge from dev 2015-12-14 15:43:03 +00:00			`builder.AppendFormat("window.appMode='{0}';", mode);`
			`}`
resolve script error 2015-07-12 16:06:23 +00:00
reduce socket activity 2017-10-04 18:51:26 +00:00			`else`
merge from dev 2015-12-14 15:43:03 +00:00			`{`
			`builder.AppendFormat("window.dashboardVersion='{0}';", version);`
			`}`
resolve script error 2015-07-12 16:06:23 +00:00
merge from dev 2015-12-14 15:43:03 +00:00			`builder.Append("</script>");`
add reel 2014-10-20 20:23:40 +00:00
add cancellation to socket methods 2017-02-05 20:44:08 +00:00			`var versionString = string.IsNullOrWhiteSpace(mode) ? "?v=" + version : string.Empty;`
add reel 2014-10-20 20:23:40 +00:00
fix require path 2015-12-21 17:48:14 +00:00			`var files = new List<string>();`

use alameda 2017-04-13 18:57:24 +00:00			`files.Add("scripts/apploader.js" + versionString);`
add reel 2014-10-20 20:23:40 +00:00
adjust startup sequences 2015-05-02 16:34:27 +00:00			`if (string.Equals(mode, "cordova", StringComparison.OrdinalIgnoreCase))`
			`{`
			`files.Insert(0, "cordova.js");`
			`}`

Update to 3.5.2 and .net core 2.1 2018-09-12 17:26:21 +00:00			`var tags = files.Select(s => string.Format("<script src=\"{0}\" defer></script>", s)).ToArray();`
add reel 2014-10-20 20:23:40 +00:00
merge from dev 2015-12-14 15:43:03 +00:00			`builder.Append(string.Join(string.Empty, tags));`
add reel 2014-10-20 20:23:40 +00:00
merge from dev 2015-12-14 15:43:03 +00:00			`return builder.ToString();`
add reel 2014-10-20 20:23:40 +00:00			`}`

			`/// <summary>`
			`/// Gets the raw resource stream.`
			`/// </summary>`
reduce device discovery traffic 2017-02-07 07:33:24 +00:00			`private Stream GetRawResourceStream(string virtualPath)`
add reel 2014-10-20 20:23:40 +00:00			`{`
Update to 3.5.2 and .net core 2.1 2018-09-12 17:26:21 +00:00			`return _resourceFileManager.GetResourceFileStream(_basePath, virtualPath);`
add reel 2014-10-20 20:23:40 +00:00			`}`

			`}`
			`}`