PackageCreator.cs 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301
  1. using MediaBrowser.Controller.Configuration;
  2. using MediaBrowser.Model.Logging;
  3. using MediaBrowser.Model.Serialization;
  4. using System;
  5. using System.Collections.Generic;
  6. using System.IO;
  7. using System.Linq;
  8. using System.Text;
  9. using System.Threading.Tasks;
  10. using MediaBrowser.Controller.Net;
  11. using MediaBrowser.Model.Globalization;
  12. using MediaBrowser.Model.IO;
  13. namespace MediaBrowser.WebDashboard.Api
  14. {
  15. public class PackageCreator
  16. {
  17. private readonly IFileSystem _fileSystem;
  18. private readonly ILogger _logger;
  19. private readonly IServerConfigurationManager _config;
  20. private readonly IMemoryStreamFactory _memoryStreamFactory;
  21. private readonly string _basePath;
  22. public PackageCreator(string basePath, IFileSystem fileSystem, ILogger logger, IServerConfigurationManager config, IMemoryStreamFactory memoryStreamFactory)
  23. {
  24. _fileSystem = fileSystem;
  25. _logger = logger;
  26. _config = config;
  27. _memoryStreamFactory = memoryStreamFactory;
  28. _basePath = basePath;
  29. }
  30. public async Task<Stream> GetResource(string virtualPath,
  31. string mode,
  32. string localizationCulture,
  33. string appVersion)
  34. {
  35. var resourceStream = GetRawResourceStream(virtualPath);
  36. if (resourceStream != null)
  37. {
  38. if (IsFormat(virtualPath, "html"))
  39. {
  40. if (IsCoreHtml(virtualPath))
  41. {
  42. resourceStream = await ModifyHtml(virtualPath, resourceStream, mode, appVersion, localizationCulture).ConfigureAwait(false);
  43. }
  44. }
  45. }
  46. return resourceStream;
  47. }
  48. /// <summary>
  49. /// Determines whether the specified path is HTML.
  50. /// </summary>
  51. /// <param name="path">The path.</param>
  52. /// <param name="format">The format.</param>
  53. /// <returns><c>true</c> if the specified path is HTML; otherwise, <c>false</c>.</returns>
  54. private bool IsFormat(string path, string format)
  55. {
  56. return Path.GetExtension(path).EndsWith(format, StringComparison.OrdinalIgnoreCase);
  57. }
  58. /// <summary>
  59. /// Gets the dashboard resource path.
  60. /// </summary>
  61. /// <returns>System.String.</returns>
  62. public string GetResourcePath(string virtualPath)
  63. {
  64. var fullPath = Path.Combine(_basePath, virtualPath.Replace('/', _fileSystem.DirectorySeparatorChar));
  65. try
  66. {
  67. fullPath = _fileSystem.GetFullPath(fullPath);
  68. }
  69. catch (Exception ex)
  70. {
  71. _logger.ErrorException("Error in Path.GetFullPath", ex);
  72. }
  73. // Don't allow file system access outside of the source folder
  74. if (!_fileSystem.ContainsSubPath(_basePath, fullPath))
  75. {
  76. throw new SecurityException("Access denied");
  77. }
  78. return fullPath;
  79. }
  80. public bool IsCoreHtml(string path)
  81. {
  82. if (path.IndexOf(".template.html", StringComparison.OrdinalIgnoreCase) != -1)
  83. {
  84. return false;
  85. }
  86. path = GetResourcePath(path);
  87. var parent = _fileSystem.GetDirectoryName(path);
  88. return string.Equals(_basePath, parent, StringComparison.OrdinalIgnoreCase) ||
  89. string.Equals(Path.Combine(_basePath, "offline"), parent, StringComparison.OrdinalIgnoreCase);
  90. }
  91. /// <summary>
  92. /// Modifies the HTML by adding common meta tags, css and js.
  93. /// </summary>
  94. /// <returns>Task{Stream}.</returns>
  95. public async Task<Stream> ModifyHtml(string path, Stream sourceStream, string mode, string appVersion, string localizationCulture)
  96. {
  97. using (sourceStream)
  98. {
  99. string html;
  100. using (var memoryStream = _memoryStreamFactory.CreateNew())
  101. {
  102. await sourceStream.CopyToAsync(memoryStream).ConfigureAwait(false);
  103. var originalBytes = memoryStream.ToArray();
  104. html = Encoding.UTF8.GetString(originalBytes, 0, originalBytes.Length);
  105. if (!string.IsNullOrWhiteSpace(mode))
  106. {
  107. }
  108. else if (!string.IsNullOrWhiteSpace(path) && !string.Equals(path, "index.html", StringComparison.OrdinalIgnoreCase))
  109. {
  110. var index = html.IndexOf("<body", StringComparison.OrdinalIgnoreCase);
  111. if (index != -1)
  112. {
  113. html = html.Substring(index);
  114. html = html.Substring(html.IndexOf('>') + 1);
  115. index = html.IndexOf("</body>", StringComparison.OrdinalIgnoreCase);
  116. if (index != -1)
  117. {
  118. html = html.Substring(0, index);
  119. }
  120. }
  121. var mainFile = _fileSystem.ReadAllText(GetResourcePath("index.html"));
  122. html = ReplaceFirst(mainFile, "<div class=\"mainAnimatedPages skinBody\"></div>", "<div class=\"mainAnimatedPages skinBody hide\">" + html + "</div>");
  123. }
  124. if (!string.IsNullOrWhiteSpace(localizationCulture))
  125. {
  126. var lang = localizationCulture.Split('-').FirstOrDefault();
  127. html = html.Replace("<html", "<html data-culture=\"" + localizationCulture + "\" lang=\"" + lang + "\"");
  128. }
  129. }
  130. html = html.Replace("<head>", "<head>" + GetMetaTags(mode) + GetCommonCss(mode, appVersion));
  131. // Disable embedded scripts from plugins. We'll run them later once resources have loaded
  132. if (html.IndexOf("<script", StringComparison.OrdinalIgnoreCase) != -1)
  133. {
  134. html = html.Replace("<script", "<!--<script");
  135. html = html.Replace("</script>", "</script>-->");
  136. }
  137. html = html.Replace("</body>", GetCommonJavascript(mode, appVersion) + "</body>");
  138. var bytes = Encoding.UTF8.GetBytes(html);
  139. return _memoryStreamFactory.CreateNew(bytes);
  140. }
  141. }
  142. public string ReplaceFirst(string text, string search, string replace)
  143. {
  144. int pos = text.IndexOf(search, StringComparison.OrdinalIgnoreCase);
  145. if (pos < 0)
  146. {
  147. return text;
  148. }
  149. return text.Substring(0, pos) + replace + text.Substring(pos + search.Length);
  150. }
  151. /// <summary>
  152. /// Gets the meta tags.
  153. /// </summary>
  154. /// <returns>System.String.</returns>
  155. private static string GetMetaTags(string mode)
  156. {
  157. var sb = new StringBuilder();
  158. if (string.Equals(mode, "cordova", StringComparison.OrdinalIgnoreCase) ||
  159. string.Equals(mode, "android", StringComparison.OrdinalIgnoreCase))
  160. {
  161. sb.Append("<meta http-equiv=\"Content-Security-Policy\" content=\"default-src * 'self' 'unsafe-inline' 'unsafe-eval' data: gap: file: filesystem: ws: wss:;\">");
  162. }
  163. else
  164. {
  165. sb.Append("<meta http-equiv=\"X-UA-Compatibility\" content=\"IE=Edge\">");
  166. }
  167. sb.Append("<link rel=\"manifest\" href=\"manifest.json\">");
  168. sb.Append("<meta name=\"format-detection\" content=\"telephone=no\">");
  169. sb.Append("<meta name=\"msapplication-tap-highlight\" content=\"no\">");
  170. sb.Append("<meta name=\"viewport\" content=\"user-scalable=no, initial-scale=1, maximum-scale=1, minimum-scale=1, width=device-width\">");
  171. sb.Append("<meta name=\"apple-mobile-web-app-capable\" content=\"yes\">");
  172. sb.Append("<meta name=\"mobile-web-app-capable\" content=\"yes\">");
  173. sb.Append("<meta name=\"application-name\" content=\"Emby\">");
  174. //sb.Append("<meta name=\"apple-mobile-web-app-status-bar-style\" content=\"black-translucent\">");
  175. sb.Append("<meta name=\"robots\" content=\"noindex, nofollow, noarchive\">");
  176. // Open graph tags
  177. sb.Append("<meta property=\"og:title\" content=\"Emby\">");
  178. sb.Append("<meta property=\"og:site_name\" content=\"Emby\">");
  179. sb.Append("<meta property=\"og:url\" content=\"http://emby.media\">");
  180. sb.Append("<meta property=\"og:description\" content=\"Energize your media.\">");
  181. sb.Append("<meta property=\"og:type\" content=\"article\">");
  182. sb.Append("<meta property=\"fb:app_id\" content=\"1618309211750238\">");
  183. // http://developer.apple.com/library/ios/#DOCUMENTATION/AppleApplications/Reference/SafariWebContent/ConfiguringWebApplications/ConfiguringWebApplications.html
  184. sb.Append("<link rel=\"apple-touch-icon\" href=\"touchicon.png\">");
  185. sb.Append("<link rel=\"apple-touch-icon\" sizes=\"72x72\" href=\"touchicon72.png\">");
  186. sb.Append("<link rel=\"apple-touch-icon\" sizes=\"114x114\" href=\"touchicon114.png\">");
  187. sb.Append("<link rel=\"apple-touch-startup-image\" href=\"css/images/iossplash.png\">");
  188. sb.Append("<link rel=\"shortcut icon\" href=\"css/images/favicon.ico\">");
  189. sb.Append("<meta name=\"msapplication-TileImage\" content=\"touchicon144.png\">");
  190. sb.Append("<meta name=\"msapplication-TileColor\" content=\"#333333\">");
  191. sb.Append("<meta name=\"theme-color\" content=\"#43A047\">");
  192. return sb.ToString();
  193. }
  194. /// <summary>
  195. /// Gets the common CSS.
  196. /// </summary>
  197. /// <param name="mode">The mode.</param>
  198. /// <param name="version">The version.</param>
  199. /// <returns>System.String.</returns>
  200. private string GetCommonCss(string mode, string version)
  201. {
  202. var versionString = string.IsNullOrWhiteSpace(mode) ? "?v=" + version : string.Empty;
  203. var files = new[]
  204. {
  205. "css/site.css" + versionString
  206. };
  207. var tags = files.Select(s => string.Format("<link rel=\"stylesheet\" href=\"{0}\" async />", s)).ToArray();
  208. return string.Join(string.Empty, tags);
  209. }
  210. /// <summary>
  211. /// Gets the common javascript.
  212. /// </summary>
  213. /// <param name="mode">The mode.</param>
  214. /// <param name="version">The version.</param>
  215. /// <returns>System.String.</returns>
  216. private string GetCommonJavascript(string mode, string version)
  217. {
  218. var builder = new StringBuilder();
  219. builder.Append("<script>");
  220. if (!string.IsNullOrWhiteSpace(mode))
  221. {
  222. builder.AppendFormat("window.appMode='{0}';", mode);
  223. }
  224. if (string.IsNullOrWhiteSpace(mode))
  225. {
  226. builder.AppendFormat("window.dashboardVersion='{0}';", version);
  227. }
  228. builder.Append("</script>");
  229. var versionString = string.IsNullOrWhiteSpace(mode) ? "?v=" + version : string.Empty;
  230. var files = new List<string>();
  231. files.Add("scripts/apploader.js" + versionString);
  232. if (string.Equals(mode, "cordova", StringComparison.OrdinalIgnoreCase))
  233. {
  234. files.Insert(0, "cordova.js");
  235. }
  236. var tags = files.Select(s => string.Format("<script src=\"{0}\" defer></script>", s)).ToArray();
  237. builder.Append(string.Join(string.Empty, tags));
  238. return builder.ToString();
  239. }
  240. /// <summary>
  241. /// Gets the raw resource stream.
  242. /// </summary>
  243. private Stream GetRawResourceStream(string virtualPath)
  244. {
  245. return _fileSystem.GetFileStream(GetResourcePath(virtualPath), FileOpenMode.Open, FileAccessMode.Read, FileShareMode.ReadWrite, true);
  246. }
  247. }
  248. }