HttpListenerHost.cs 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688
  1. using Funq;
  2. using MediaBrowser.Common;
  3. using MediaBrowser.Common.Extensions;
  4. using MediaBrowser.Controller.Configuration;
  5. using MediaBrowser.Controller.Net;
  6. using MediaBrowser.Model.Logging;
  7. using MediaBrowser.Server.Implementations.HttpServer.SocketSharp;
  8. using ServiceStack;
  9. using ServiceStack.Host;
  10. using ServiceStack.Host.Handlers;
  11. using ServiceStack.Logging;
  12. using ServiceStack.Web;
  13. using System;
  14. using System.Collections.Generic;
  15. using System.IO;
  16. using System.Linq;
  17. using System.Reflection;
  18. using System.Threading;
  19. using System.Threading.Tasks;
  20. using MediaBrowser.Common.IO;
  21. using MediaBrowser.Common.Net;
  22. using MediaBrowser.Common.Security;
  23. using MediaBrowser.Model.Extensions;
  24. using MediaBrowser.Model.IO;
  25. using MediaBrowser.Model.Services;
  26. using ServiceStack.Api.Swagger;
  27. namespace MediaBrowser.Server.Implementations.HttpServer
  28. {
  29. public class HttpListenerHost : ServiceStackHost, IHttpServer
  30. {
  31. private string DefaultRedirectPath { get; set; }
  32. private readonly ILogger _logger;
  33. public IEnumerable<string> UrlPrefixes { get; private set; }
  34. private readonly List<IRestfulService> _restServices = new List<IRestfulService>();
  35. private IHttpListener _listener;
  36. private readonly ContainerAdapter _containerAdapter;
  37. public event EventHandler<WebSocketConnectEventArgs> WebSocketConnected;
  38. public event EventHandler<WebSocketConnectingEventArgs> WebSocketConnecting;
  39. public string CertificatePath { get; private set; }
  40. private readonly IServerConfigurationManager _config;
  41. private readonly INetworkManager _networkManager;
  42. private readonly IMemoryStreamProvider _memoryStreamProvider;
  43. public HttpListenerHost(IApplicationHost applicationHost,
  44. ILogManager logManager,
  45. IServerConfigurationManager config,
  46. string serviceName,
  47. string defaultRedirectPath, INetworkManager networkManager, IMemoryStreamProvider memoryStreamProvider, params Assembly[] assembliesWithServices)
  48. : base(serviceName, assembliesWithServices)
  49. {
  50. DefaultRedirectPath = defaultRedirectPath;
  51. _networkManager = networkManager;
  52. _memoryStreamProvider = memoryStreamProvider;
  53. _config = config;
  54. _logger = logManager.GetLogger("HttpServer");
  55. _containerAdapter = new ContainerAdapter(applicationHost);
  56. }
  57. public string GlobalResponse { get; set; }
  58. public override void Configure(Container container)
  59. {
  60. HostConfig.Instance.DefaultRedirectPath = DefaultRedirectPath;
  61. HostConfig.Instance.LogUnobservedTaskExceptions = false;
  62. HostConfig.Instance.MapExceptionToStatusCode = new Dictionary<Type, int>
  63. {
  64. {typeof (InvalidOperationException), 500},
  65. {typeof (NotImplementedException), 500},
  66. {typeof (ResourceNotFoundException), 404},
  67. {typeof (FileNotFoundException), 404},
  68. {typeof (DirectoryNotFoundException), 404},
  69. {typeof (SecurityException), 401},
  70. {typeof (PaymentRequiredException), 402},
  71. {typeof (UnauthorizedAccessException), 500},
  72. {typeof (ApplicationException), 500},
  73. {typeof (PlatformNotSupportedException), 500},
  74. {typeof (NotSupportedException), 500}
  75. };
  76. HostConfig.Instance.GlobalResponseHeaders = new Dictionary<string, string>();
  77. HostConfig.Instance.DebugMode = false;
  78. HostConfig.Instance.LogFactory = LogManager.LogFactory;
  79. HostConfig.Instance.AllowJsonpRequests = false;
  80. // The Markdown feature causes slow startup times (5 mins+) on cold boots for some users
  81. // Custom format allows images
  82. HostConfig.Instance.EnableFeatures = Feature.Html | Feature.Json | Feature.Xml | Feature.CustomFormat;
  83. container.Adapter = _containerAdapter;
  84. Plugins.Add(new SwaggerFeature());
  85. Plugins.Add(new CorsFeature(allowedHeaders: "Content-Type, Authorization, Range, X-MediaBrowser-Token, X-Emby-Authorization"));
  86. //Plugins.Add(new AuthFeature(() => new AuthUserSession(), new IAuthProvider[] {
  87. // new SessionAuthProvider(_containerAdapter.Resolve<ISessionContext>()),
  88. //}));
  89. //PreRequestFilters.Add((httpReq, httpRes) =>
  90. //{
  91. // //Handles Request and closes Responses after emitting global HTTP Headers
  92. // if (string.Equals(httpReq.Verb, "OPTIONS", StringComparison.OrdinalIgnoreCase))
  93. // {
  94. // httpRes.EndRequest(); //add a 'using ServiceStack;'
  95. // }
  96. //});
  97. HostContext.GlobalResponseFilters.Add(new ResponseFilter(_logger).FilterResponse);
  98. }
  99. public override void OnAfterInit()
  100. {
  101. SetAppDomainData();
  102. base.OnAfterInit();
  103. }
  104. public override void OnConfigLoad()
  105. {
  106. base.OnConfigLoad();
  107. Config.HandlerFactoryPath = null;
  108. Config.MetadataRedirectPath = "metadata";
  109. }
  110. protected override ServiceController CreateServiceController(params Assembly[] assembliesWithServices)
  111. {
  112. var types = _restServices.Select(r => r.GetType()).ToArray();
  113. return new ServiceController(this, () => types);
  114. }
  115. public virtual void SetAppDomainData()
  116. {
  117. //Required for Mono to resolve VirtualPathUtility and Url.Content urls
  118. var domain = Thread.GetDomain(); // or AppDomain.Current
  119. domain.SetData(".appDomain", "1");
  120. domain.SetData(".appVPath", "/");
  121. domain.SetData(".appPath", domain.BaseDirectory);
  122. if (string.IsNullOrEmpty(domain.GetData(".appId") as string))
  123. {
  124. domain.SetData(".appId", "1");
  125. }
  126. if (string.IsNullOrEmpty(domain.GetData(".domainId") as string))
  127. {
  128. domain.SetData(".domainId", "1");
  129. }
  130. }
  131. public override ServiceStackHost Start(string listeningAtUrlBase)
  132. {
  133. StartListener();
  134. return this;
  135. }
  136. /// <summary>
  137. /// Starts the Web Service
  138. /// </summary>
  139. private void StartListener()
  140. {
  141. HostContext.Config.HandlerFactoryPath = GetHandlerPathIfAny(UrlPrefixes.First());
  142. _listener = GetListener();
  143. _listener.WebSocketConnected = OnWebSocketConnected;
  144. _listener.WebSocketConnecting = OnWebSocketConnecting;
  145. _listener.ErrorHandler = ErrorHandler;
  146. _listener.RequestHandler = RequestHandler;
  147. _listener.Start(UrlPrefixes);
  148. }
  149. public static string GetHandlerPathIfAny(string listenerUrl)
  150. {
  151. if (listenerUrl == null) return null;
  152. var pos = listenerUrl.IndexOf("://", StringComparison.OrdinalIgnoreCase);
  153. if (pos == -1) return null;
  154. var startHostUrl = listenerUrl.Substring(pos + "://".Length);
  155. var endPos = startHostUrl.IndexOf('/');
  156. if (endPos == -1) return null;
  157. var endHostUrl = startHostUrl.Substring(endPos + 1);
  158. return string.IsNullOrEmpty(endHostUrl) ? null : endHostUrl.TrimEnd('/');
  159. }
  160. private IHttpListener GetListener()
  161. {
  162. return new WebSocketSharpListener(_logger, CertificatePath, _memoryStreamProvider);
  163. }
  164. private void OnWebSocketConnecting(WebSocketConnectingEventArgs args)
  165. {
  166. if (_disposed)
  167. {
  168. return;
  169. }
  170. if (WebSocketConnecting != null)
  171. {
  172. WebSocketConnecting(this, args);
  173. }
  174. }
  175. private void OnWebSocketConnected(WebSocketConnectEventArgs args)
  176. {
  177. if (_disposed)
  178. {
  179. return;
  180. }
  181. if (WebSocketConnected != null)
  182. {
  183. WebSocketConnected(this, args);
  184. }
  185. }
  186. private void ErrorHandler(Exception ex, IRequest httpReq)
  187. {
  188. try
  189. {
  190. var httpRes = httpReq.Response;
  191. if (httpRes.IsClosed)
  192. {
  193. return;
  194. }
  195. var errorResponse = new ErrorResponse
  196. {
  197. ResponseStatus = new ResponseStatus
  198. {
  199. ErrorCode = ex.GetType().GetOperationName(),
  200. Message = ex.Message,
  201. StackTrace = ex.StackTrace
  202. }
  203. };
  204. var contentType = httpReq.ResponseContentType;
  205. var serializer = HostContext.ContentTypes.GetResponseSerializer(contentType);
  206. if (serializer == null)
  207. {
  208. contentType = HostContext.Config.DefaultContentType;
  209. serializer = HostContext.ContentTypes.GetResponseSerializer(contentType);
  210. }
  211. var httpError = ex as IHttpError;
  212. if (httpError != null)
  213. {
  214. httpRes.StatusCode = httpError.Status;
  215. httpRes.StatusDescription = httpError.StatusDescription;
  216. }
  217. else
  218. {
  219. httpRes.StatusCode = 500;
  220. }
  221. httpRes.ContentType = contentType;
  222. serializer(httpReq, errorResponse, httpRes);
  223. httpRes.Close();
  224. }
  225. catch
  226. {
  227. //_logger.ErrorException("Error this.ProcessRequest(context)(Exception while writing error to the response)", errorEx);
  228. }
  229. }
  230. /// <summary>
  231. /// Shut down the Web Service
  232. /// </summary>
  233. public void Stop()
  234. {
  235. if (_listener != null)
  236. {
  237. _listener.Stop();
  238. }
  239. }
  240. private readonly Dictionary<string, int> _skipLogExtensions = new Dictionary<string, int>(StringComparer.OrdinalIgnoreCase)
  241. {
  242. {".js", 0},
  243. {".css", 0},
  244. {".woff", 0},
  245. {".woff2", 0},
  246. {".ttf", 0},
  247. {".html", 0}
  248. };
  249. private bool EnableLogging(string url, string localPath)
  250. {
  251. var extension = GetExtension(url);
  252. if (string.IsNullOrWhiteSpace(extension) || !_skipLogExtensions.ContainsKey(extension))
  253. {
  254. if (string.IsNullOrWhiteSpace(localPath) || localPath.IndexOf("system/ping", StringComparison.OrdinalIgnoreCase) == -1)
  255. {
  256. return true;
  257. }
  258. }
  259. return false;
  260. }
  261. private string GetExtension(string url)
  262. {
  263. var parts = url.Split(new[] { '?' }, 2);
  264. return Path.GetExtension(parts[0]);
  265. }
  266. public static string RemoveQueryStringByKey(string url, string key)
  267. {
  268. var uri = new Uri(url);
  269. // this gets all the query string key value pairs as a collection
  270. var newQueryString = MyHttpUtility.ParseQueryString(uri.Query);
  271. if (newQueryString.Count == 0)
  272. {
  273. return url;
  274. }
  275. // this removes the key if exists
  276. newQueryString.Remove(key);
  277. // this gets the page path from root without QueryString
  278. string pagePathWithoutQueryString = uri.GetLeftPart(UriPartial.Path);
  279. return newQueryString.Count > 0
  280. ? String.Format("{0}?{1}", pagePathWithoutQueryString, newQueryString)
  281. : pagePathWithoutQueryString;
  282. }
  283. private string GetUrlToLog(string url)
  284. {
  285. url = RemoveQueryStringByKey(url, "api_key");
  286. return url;
  287. }
  288. private string NormalizeConfiguredLocalAddress(string address)
  289. {
  290. var index = address.Trim('/').IndexOf('/');
  291. if (index != -1)
  292. {
  293. address = address.Substring(index + 1);
  294. }
  295. return address.Trim('/');
  296. }
  297. private bool ValidateHost(Uri url)
  298. {
  299. var hosts = _config
  300. .Configuration
  301. .LocalNetworkAddresses
  302. .Select(NormalizeConfiguredLocalAddress)
  303. .ToList();
  304. if (hosts.Count == 0)
  305. {
  306. return true;
  307. }
  308. var host = url.Host ?? string.Empty;
  309. _logger.Debug("Validating host {0}", host);
  310. if (_networkManager.IsInPrivateAddressSpace(host))
  311. {
  312. hosts.Add("localhost");
  313. hosts.Add("127.0.0.1");
  314. return hosts.Any(i => host.IndexOf(i, StringComparison.OrdinalIgnoreCase) != -1);
  315. }
  316. return true;
  317. }
  318. /// <summary>
  319. /// Overridable method that can be used to implement a custom hnandler
  320. /// </summary>
  321. /// <param name="httpReq">The HTTP req.</param>
  322. /// <param name="url">The URL.</param>
  323. /// <returns>Task.</returns>
  324. protected async Task RequestHandler(IHttpRequest httpReq, Uri url)
  325. {
  326. var date = DateTime.Now;
  327. var httpRes = httpReq.Response;
  328. if (_disposed)
  329. {
  330. httpRes.StatusCode = 503;
  331. httpRes.Close();
  332. return ;
  333. }
  334. if (!ValidateHost(url))
  335. {
  336. httpRes.StatusCode = 400;
  337. httpRes.ContentType = "text/plain";
  338. httpRes.Write("Invalid host");
  339. httpRes.Close();
  340. return;
  341. }
  342. if (string.Equals(httpReq.Verb, "OPTIONS", StringComparison.OrdinalIgnoreCase))
  343. {
  344. httpRes.StatusCode = 200;
  345. httpRes.AddHeader("Access-Control-Allow-Origin", "*");
  346. httpRes.AddHeader("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE, PATCH, OPTIONS");
  347. httpRes.AddHeader("Access-Control-Allow-Headers", "Content-Type, Authorization, Range, X-MediaBrowser-Token, X-Emby-Authorization");
  348. httpRes.ContentType = "text/html";
  349. httpRes.Close();
  350. }
  351. var operationName = httpReq.OperationName;
  352. var localPath = url.LocalPath;
  353. var urlString = url.OriginalString;
  354. var enableLog = EnableLogging(urlString, localPath);
  355. var urlToLog = urlString;
  356. if (enableLog)
  357. {
  358. urlToLog = GetUrlToLog(urlString);
  359. LoggerUtils.LogRequest(_logger, urlToLog, httpReq.HttpMethod, httpReq.UserAgent);
  360. }
  361. if (string.Equals(localPath, "/emby/", StringComparison.OrdinalIgnoreCase) ||
  362. string.Equals(localPath, "/mediabrowser/", StringComparison.OrdinalIgnoreCase))
  363. {
  364. httpRes.RedirectToUrl(DefaultRedirectPath);
  365. return;
  366. }
  367. if (string.Equals(localPath, "/emby", StringComparison.OrdinalIgnoreCase) ||
  368. string.Equals(localPath, "/mediabrowser", StringComparison.OrdinalIgnoreCase))
  369. {
  370. httpRes.RedirectToUrl("emby/" + DefaultRedirectPath);
  371. return;
  372. }
  373. if (string.Equals(localPath, "/mediabrowser/", StringComparison.OrdinalIgnoreCase) ||
  374. string.Equals(localPath, "/mediabrowser", StringComparison.OrdinalIgnoreCase) ||
  375. localPath.IndexOf("mediabrowser/web", StringComparison.OrdinalIgnoreCase) != -1)
  376. {
  377. httpRes.StatusCode = 200;
  378. httpRes.ContentType = "text/html";
  379. var newUrl = urlString.Replace("mediabrowser", "emby", StringComparison.OrdinalIgnoreCase)
  380. .Replace("/dashboard/", "/web/", StringComparison.OrdinalIgnoreCase);
  381. if (!string.Equals(newUrl, urlString, StringComparison.OrdinalIgnoreCase))
  382. {
  383. httpRes.Write("<!doctype html><html><head><title>Emby</title></head><body>Please update your Emby bookmark to <a href=\"" + newUrl + "\">" + newUrl + "</a></body></html>");
  384. httpRes.Close();
  385. return;
  386. }
  387. }
  388. if (localPath.IndexOf("dashboard/", StringComparison.OrdinalIgnoreCase) != -1 &&
  389. localPath.IndexOf("web/dashboard", StringComparison.OrdinalIgnoreCase) == -1)
  390. {
  391. httpRes.StatusCode = 200;
  392. httpRes.ContentType = "text/html";
  393. var newUrl = urlString.Replace("mediabrowser", "emby", StringComparison.OrdinalIgnoreCase)
  394. .Replace("/dashboard/", "/web/", StringComparison.OrdinalIgnoreCase);
  395. if (!string.Equals(newUrl, urlString, StringComparison.OrdinalIgnoreCase))
  396. {
  397. httpRes.Write("<!doctype html><html><head><title>Emby</title></head><body>Please update your Emby bookmark to <a href=\"" + newUrl + "\">" + newUrl + "</a></body></html>");
  398. httpRes.Close();
  399. return;
  400. }
  401. }
  402. if (string.Equals(localPath, "/web", StringComparison.OrdinalIgnoreCase))
  403. {
  404. httpRes.RedirectToUrl(DefaultRedirectPath);
  405. return;
  406. }
  407. if (string.Equals(localPath, "/web/", StringComparison.OrdinalIgnoreCase))
  408. {
  409. httpRes.RedirectToUrl("../" + DefaultRedirectPath);
  410. return;
  411. }
  412. if (string.Equals(localPath, "/", StringComparison.OrdinalIgnoreCase))
  413. {
  414. httpRes.RedirectToUrl(DefaultRedirectPath);
  415. return;
  416. }
  417. if (string.IsNullOrEmpty(localPath))
  418. {
  419. httpRes.RedirectToUrl("/" + DefaultRedirectPath);
  420. return;
  421. }
  422. if (string.Equals(localPath, "/emby/pin", StringComparison.OrdinalIgnoreCase))
  423. {
  424. httpRes.RedirectToUrl("web/pin.html");
  425. return;
  426. }
  427. if (!string.IsNullOrWhiteSpace(GlobalResponse))
  428. {
  429. httpRes.StatusCode = 503;
  430. httpRes.ContentType = "text/html";
  431. httpRes.Write(GlobalResponse);
  432. httpRes.Close();
  433. return;
  434. }
  435. var handler = HttpHandlerFactory.GetHandler(httpReq);
  436. var remoteIp = httpReq.RemoteIp;
  437. var serviceStackHandler = handler as IServiceStackHandler;
  438. if (serviceStackHandler != null)
  439. {
  440. var restHandler = serviceStackHandler as RestHandler;
  441. if (restHandler != null)
  442. {
  443. httpReq.OperationName = operationName = restHandler.RestPath.RequestType.GetOperationName();
  444. }
  445. try
  446. {
  447. await serviceStackHandler.ProcessRequestAsync(httpReq, httpRes, operationName).ConfigureAwait(false);
  448. }
  449. finally
  450. {
  451. httpRes.Close();
  452. var statusCode = httpRes.StatusCode;
  453. var duration = DateTime.Now - date;
  454. if (enableLog)
  455. {
  456. LoggerUtils.LogResponse(_logger, statusCode, urlToLog, remoteIp, duration);
  457. }
  458. }
  459. }
  460. else
  461. {
  462. httpRes.Close();
  463. }
  464. }
  465. /// <summary>
  466. /// Adds the rest handlers.
  467. /// </summary>
  468. /// <param name="services">The services.</param>
  469. public void Init(IEnumerable<IRestfulService> services)
  470. {
  471. _restServices.AddRange(services);
  472. ServiceController = CreateServiceController();
  473. _logger.Info("Calling ServiceStack AppHost.Init");
  474. base.Init();
  475. }
  476. public override Model.Services.RouteAttribute[] GetRouteAttributes(Type requestType)
  477. {
  478. var routes = base.GetRouteAttributes(requestType).ToList();
  479. var clone = routes.ToList();
  480. foreach (var route in clone)
  481. {
  482. routes.Add(new Model.Services.RouteAttribute(NormalizeEmbyRoutePath(route.Path), route.Verbs)
  483. {
  484. Notes = route.Notes,
  485. Priority = route.Priority,
  486. Summary = route.Summary
  487. });
  488. routes.Add(new Model.Services.RouteAttribute(NormalizeRoutePath(route.Path), route.Verbs)
  489. {
  490. Notes = route.Notes,
  491. Priority = route.Priority,
  492. Summary = route.Summary
  493. });
  494. routes.Add(new Model.Services.RouteAttribute(DoubleNormalizeEmbyRoutePath(route.Path), route.Verbs)
  495. {
  496. Notes = route.Notes,
  497. Priority = route.Priority,
  498. Summary = route.Summary
  499. });
  500. }
  501. return routes.ToArray();
  502. }
  503. private string NormalizeEmbyRoutePath(string path)
  504. {
  505. if (path.StartsWith("/", StringComparison.OrdinalIgnoreCase))
  506. {
  507. return "/emby" + path;
  508. }
  509. return "emby/" + path;
  510. }
  511. private string DoubleNormalizeEmbyRoutePath(string path)
  512. {
  513. if (path.StartsWith("/", StringComparison.OrdinalIgnoreCase))
  514. {
  515. return "/emby/emby" + path;
  516. }
  517. return "emby/emby/" + path;
  518. }
  519. private string NormalizeRoutePath(string path)
  520. {
  521. if (path.StartsWith("/", StringComparison.OrdinalIgnoreCase))
  522. {
  523. return "/mediabrowser" + path;
  524. }
  525. return "mediabrowser/" + path;
  526. }
  527. /// <summary>
  528. /// Releases the specified instance.
  529. /// </summary>
  530. /// <param name="instance">The instance.</param>
  531. public override void Release(object instance)
  532. {
  533. // Leave this empty so SS doesn't try to dispose our objects
  534. }
  535. private bool _disposed;
  536. private readonly object _disposeLock = new object();
  537. protected virtual void Dispose(bool disposing)
  538. {
  539. if (_disposed) return;
  540. base.Dispose();
  541. lock (_disposeLock)
  542. {
  543. if (_disposed) return;
  544. if (disposing)
  545. {
  546. Stop();
  547. }
  548. //release unmanaged resources here...
  549. _disposed = true;
  550. }
  551. }
  552. public override void Dispose()
  553. {
  554. Dispose(true);
  555. GC.SuppressFinalize(this);
  556. }
  557. public void StartServer(IEnumerable<string> urlPrefixes, string certificatePath)
  558. {
  559. CertificatePath = certificatePath;
  560. UrlPrefixes = urlPrefixes.ToList();
  561. Start(UrlPrefixes.First());
  562. }
  563. }
  564. }