HttpListenerHost.cs 22 KB

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