HttpListenerHost.cs 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539
  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.Net;
  23. using MediaBrowser.Common.Security;
  24. namespace MediaBrowser.Server.Implementations.HttpServer
  25. {
  26. public class HttpListenerHost : ServiceStackHost, IHttpServer
  27. {
  28. private string DefaultRedirectPath { get; set; }
  29. private readonly ILogger _logger;
  30. public IEnumerable<string> UrlPrefixes { get; private set; }
  31. private readonly List<IRestfulService> _restServices = new List<IRestfulService>();
  32. private IHttpListener _listener;
  33. private readonly ContainerAdapter _containerAdapter;
  34. public event EventHandler<WebSocketConnectEventArgs> WebSocketConnected;
  35. public event EventHandler<WebSocketConnectingEventArgs> WebSocketConnecting;
  36. public string CertificatePath { get; private set; }
  37. private readonly IServerConfigurationManager _config;
  38. private readonly INetworkManager _networkManager;
  39. public HttpListenerHost(IApplicationHost applicationHost,
  40. ILogManager logManager,
  41. IServerConfigurationManager config,
  42. string serviceName,
  43. string defaultRedirectPath, INetworkManager networkManager, params Assembly[] assembliesWithServices)
  44. : base(serviceName, assembliesWithServices)
  45. {
  46. DefaultRedirectPath = defaultRedirectPath;
  47. _networkManager = networkManager;
  48. _config = config;
  49. _logger = logManager.GetLogger("HttpServer");
  50. _containerAdapter = new ContainerAdapter(applicationHost);
  51. }
  52. public string GlobalResponse { get; set; }
  53. public override void Configure(Container container)
  54. {
  55. HostConfig.Instance.DefaultRedirectPath = DefaultRedirectPath;
  56. HostConfig.Instance.MapExceptionToStatusCode = new Dictionary<Type, int>
  57. {
  58. {typeof (InvalidOperationException), 422},
  59. {typeof (ResourceNotFoundException), 404},
  60. {typeof (FileNotFoundException), 404},
  61. {typeof (DirectoryNotFoundException), 404},
  62. {typeof (SecurityException), 401},
  63. {typeof (PaymentRequiredException), 402},
  64. {typeof (UnauthorizedAccessException), 500},
  65. {typeof (ApplicationException), 500}
  66. };
  67. HostConfig.Instance.DebugMode = true;
  68. HostConfig.Instance.LogFactory = LogManager.LogFactory;
  69. // The Markdown feature causes slow startup times (5 mins+) on cold boots for some users
  70. // Custom format allows images
  71. HostConfig.Instance.EnableFeatures = Feature.Csv | Feature.Html | Feature.Json | Feature.Jsv | Feature.Metadata | Feature.Xml | Feature.CustomFormat;
  72. container.Adapter = _containerAdapter;
  73. Plugins.Add(new SwaggerFeature());
  74. Plugins.Add(new CorsFeature(allowedHeaders: "Content-Type, Authorization, Range, X-MediaBrowser-Token, X-Emby-Authorization"));
  75. //Plugins.Add(new AuthFeature(() => new AuthUserSession(), new IAuthProvider[] {
  76. // new SessionAuthProvider(_containerAdapter.Resolve<ISessionContext>()),
  77. //}));
  78. PreRequestFilters.Add((httpReq, httpRes) =>
  79. {
  80. //Handles Request and closes Responses after emitting global HTTP Headers
  81. if (string.Equals(httpReq.Verb, "OPTIONS", StringComparison.OrdinalIgnoreCase))
  82. {
  83. httpRes.EndRequest(); //add a 'using ServiceStack;'
  84. }
  85. });
  86. HostContext.GlobalResponseFilters.Add(new ResponseFilter(_logger, () => _config.Configuration.DenyIFrameEmbedding).FilterResponse);
  87. }
  88. public override void OnAfterInit()
  89. {
  90. SetAppDomainData();
  91. base.OnAfterInit();
  92. }
  93. public override void OnConfigLoad()
  94. {
  95. base.OnConfigLoad();
  96. Config.HandlerFactoryPath = null;
  97. Config.MetadataRedirectPath = "metadata";
  98. }
  99. protected override ServiceController CreateServiceController(params Assembly[] assembliesWithServices)
  100. {
  101. var types = _restServices.Select(r => r.GetType()).ToArray();
  102. return new ServiceController(this, () => types);
  103. }
  104. public virtual void SetAppDomainData()
  105. {
  106. //Required for Mono to resolve VirtualPathUtility and Url.Content urls
  107. var domain = Thread.GetDomain(); // or AppDomain.Current
  108. domain.SetData(".appDomain", "1");
  109. domain.SetData(".appVPath", "/");
  110. domain.SetData(".appPath", domain.BaseDirectory);
  111. if (string.IsNullOrEmpty(domain.GetData(".appId") as string))
  112. {
  113. domain.SetData(".appId", "1");
  114. }
  115. if (string.IsNullOrEmpty(domain.GetData(".domainId") as string))
  116. {
  117. domain.SetData(".domainId", "1");
  118. }
  119. }
  120. public override ServiceStackHost Start(string listeningAtUrlBase)
  121. {
  122. StartListener();
  123. return this;
  124. }
  125. /// <summary>
  126. /// Starts the Web Service
  127. /// </summary>
  128. private void StartListener()
  129. {
  130. HostContext.Config.HandlerFactoryPath = ListenerRequest.GetHandlerPathIfAny(UrlPrefixes.First());
  131. _listener = GetListener();
  132. _listener.WebSocketConnected = OnWebSocketConnected;
  133. _listener.WebSocketConnecting = OnWebSocketConnecting;
  134. _listener.ErrorHandler = ErrorHandler;
  135. _listener.RequestHandler = RequestHandler;
  136. _listener.Start(UrlPrefixes);
  137. }
  138. private IHttpListener GetListener()
  139. {
  140. return new WebSocketSharpListener(_logger, CertificatePath);
  141. }
  142. private void OnWebSocketConnecting(WebSocketConnectingEventArgs args)
  143. {
  144. if (WebSocketConnecting != null)
  145. {
  146. WebSocketConnecting(this, args);
  147. }
  148. }
  149. private void OnWebSocketConnected(WebSocketConnectEventArgs args)
  150. {
  151. if (WebSocketConnected != null)
  152. {
  153. WebSocketConnected(this, args);
  154. }
  155. }
  156. private void ErrorHandler(Exception ex, IRequest httpReq)
  157. {
  158. try
  159. {
  160. var httpRes = httpReq.Response;
  161. if (httpRes.IsClosed)
  162. {
  163. return;
  164. }
  165. var errorResponse = new ErrorResponse
  166. {
  167. ResponseStatus = new ResponseStatus
  168. {
  169. ErrorCode = ex.GetType().GetOperationName(),
  170. Message = ex.Message,
  171. StackTrace = ex.StackTrace
  172. }
  173. };
  174. var contentType = httpReq.ResponseContentType;
  175. var serializer = HostContext.ContentTypes.GetResponseSerializer(contentType);
  176. if (serializer == null)
  177. {
  178. contentType = HostContext.Config.DefaultContentType;
  179. serializer = HostContext.ContentTypes.GetResponseSerializer(contentType);
  180. }
  181. var httpError = ex as IHttpError;
  182. if (httpError != null)
  183. {
  184. httpRes.StatusCode = httpError.Status;
  185. httpRes.StatusDescription = httpError.StatusDescription;
  186. }
  187. else
  188. {
  189. httpRes.StatusCode = 500;
  190. }
  191. httpRes.ContentType = contentType;
  192. serializer(httpReq, errorResponse, httpRes);
  193. httpRes.Close();
  194. }
  195. catch (Exception errorEx)
  196. {
  197. //_logger.ErrorException("Error this.ProcessRequest(context)(Exception while writing error to the response)", errorEx);
  198. }
  199. }
  200. /// <summary>
  201. /// Shut down the Web Service
  202. /// </summary>
  203. public void Stop()
  204. {
  205. if (_listener != null)
  206. {
  207. _listener.Stop();
  208. }
  209. }
  210. private readonly Dictionary<string, int> _skipLogExtensions = new Dictionary<string, int>(StringComparer.OrdinalIgnoreCase)
  211. {
  212. {".js", 0},
  213. {".css", 0},
  214. {".woff", 0},
  215. {".woff2", 0},
  216. {".ttf", 0},
  217. {".html", 0}
  218. };
  219. private bool EnableLogging(string url, string localPath)
  220. {
  221. var extension = GetExtension(url);
  222. if (string.IsNullOrWhiteSpace(extension) || !_skipLogExtensions.ContainsKey(extension))
  223. {
  224. if (string.IsNullOrWhiteSpace(localPath) || localPath.IndexOf("system/ping", StringComparison.OrdinalIgnoreCase) == -1)
  225. {
  226. return true;
  227. }
  228. }
  229. return false;
  230. }
  231. private string GetExtension(string url)
  232. {
  233. var parts = url.Split(new[] { '?' }, 2);
  234. return Path.GetExtension(parts[0]);
  235. }
  236. /// <summary>
  237. /// Overridable method that can be used to implement a custom hnandler
  238. /// </summary>
  239. /// <param name="httpReq">The HTTP req.</param>
  240. /// <param name="url">The URL.</param>
  241. /// <returns>Task.</returns>
  242. protected Task RequestHandler(IHttpRequest httpReq, Uri url)
  243. {
  244. var date = DateTime.Now;
  245. var httpRes = httpReq.Response;
  246. var operationName = httpReq.OperationName;
  247. var localPath = url.LocalPath;
  248. var urlString = url.OriginalString;
  249. var enableLog = EnableLogging(urlString, localPath);
  250. if (enableLog)
  251. {
  252. LoggerUtils.LogRequest(_logger, urlString, httpReq.HttpMethod, httpReq.UserAgent);
  253. }
  254. if (string.Equals(localPath, "/mediabrowser/", StringComparison.OrdinalIgnoreCase) ||
  255. string.Equals(localPath, "/emby/", StringComparison.OrdinalIgnoreCase))
  256. {
  257. httpRes.RedirectToUrl(DefaultRedirectPath);
  258. return Task.FromResult(true);
  259. }
  260. if (string.Equals(localPath, "/mediabrowser", StringComparison.OrdinalIgnoreCase))
  261. {
  262. httpRes.RedirectToUrl("mediabrowser/" + DefaultRedirectPath);
  263. return Task.FromResult(true);
  264. }
  265. if (string.Equals(localPath, "/emby", StringComparison.OrdinalIgnoreCase))
  266. {
  267. httpRes.RedirectToUrl("emby/" + DefaultRedirectPath);
  268. return Task.FromResult(true);
  269. }
  270. if (string.Equals(localPath, "/web", StringComparison.OrdinalIgnoreCase))
  271. {
  272. httpRes.RedirectToUrl(DefaultRedirectPath);
  273. return Task.FromResult(true);
  274. }
  275. if (string.Equals(localPath, "/web/", StringComparison.OrdinalIgnoreCase))
  276. {
  277. httpRes.RedirectToUrl("../" + DefaultRedirectPath);
  278. return Task.FromResult(true);
  279. }
  280. if (string.Equals(localPath, "/", StringComparison.OrdinalIgnoreCase))
  281. {
  282. httpRes.RedirectToUrl(DefaultRedirectPath);
  283. return Task.FromResult(true);
  284. }
  285. if (string.IsNullOrEmpty(localPath))
  286. {
  287. httpRes.RedirectToUrl("/" + DefaultRedirectPath);
  288. return Task.FromResult(true);
  289. }
  290. if (!string.IsNullOrWhiteSpace(GlobalResponse))
  291. {
  292. if (string.Equals(GetExtension(urlString), "html", StringComparison.OrdinalIgnoreCase))
  293. {
  294. httpRes.Write(GlobalResponse);
  295. httpRes.ContentType = "text/plain";
  296. }
  297. else
  298. {
  299. httpRes.StatusCode = 503;
  300. }
  301. return Task.FromResult(true);
  302. }
  303. var handler = HttpHandlerFactory.GetHandler(httpReq);
  304. var remoteIp = httpReq.RemoteIp;
  305. var serviceStackHandler = handler as IServiceStackHandler;
  306. if (serviceStackHandler != null)
  307. {
  308. var restHandler = serviceStackHandler as RestHandler;
  309. if (restHandler != null)
  310. {
  311. httpReq.OperationName = operationName = restHandler.RestPath.RequestType.GetOperationName();
  312. }
  313. var task = serviceStackHandler.ProcessRequestAsync(httpReq, httpRes, operationName);
  314. task.ContinueWith(x => httpRes.Close(), TaskContinuationOptions.OnlyOnRanToCompletion | TaskContinuationOptions.AttachedToParent);
  315. //Matches Exceptions handled in HttpListenerBase.InitTask()
  316. task.ContinueWith(x =>
  317. {
  318. var statusCode = httpRes.StatusCode;
  319. var duration = DateTime.Now - date;
  320. if (enableLog)
  321. {
  322. LoggerUtils.LogResponse(_logger, statusCode, urlString, remoteIp, duration);
  323. }
  324. }, TaskContinuationOptions.None);
  325. return task;
  326. }
  327. return new NotImplementedException("Cannot execute handler: " + handler + " at PathInfo: " + httpReq.PathInfo)
  328. .AsTaskException();
  329. }
  330. /// <summary>
  331. /// Adds the rest handlers.
  332. /// </summary>
  333. /// <param name="services">The services.</param>
  334. public void Init(IEnumerable<IRestfulService> services)
  335. {
  336. _restServices.AddRange(services);
  337. ServiceController = CreateServiceController();
  338. _logger.Info("Calling ServiceStack AppHost.Init");
  339. base.Init();
  340. }
  341. public override RouteAttribute[] GetRouteAttributes(Type requestType)
  342. {
  343. var routes = base.GetRouteAttributes(requestType).ToList();
  344. var clone = routes.ToList();
  345. foreach (var route in clone)
  346. {
  347. routes.Add(new RouteAttribute(NormalizeEmbyRoutePath(route.Path), route.Verbs)
  348. {
  349. Notes = route.Notes,
  350. Priority = route.Priority,
  351. Summary = route.Summary
  352. });
  353. routes.Add(new RouteAttribute(NormalizeRoutePath(route.Path), route.Verbs)
  354. {
  355. Notes = route.Notes,
  356. Priority = route.Priority,
  357. Summary = route.Summary
  358. });
  359. // TODO: This is a hack for iOS. Remove it asap.
  360. routes.Add(new RouteAttribute(DoubleNormalizeRoutePath(route.Path), route.Verbs)
  361. {
  362. Notes = route.Notes,
  363. Priority = route.Priority,
  364. Summary = route.Summary
  365. });
  366. routes.Add(new RouteAttribute(DoubleNormalizeEmbyRoutePath(route.Path), route.Verbs)
  367. {
  368. Notes = route.Notes,
  369. Priority = route.Priority,
  370. Summary = route.Summary
  371. });
  372. }
  373. return routes.ToArray();
  374. }
  375. private string NormalizeEmbyRoutePath(string path)
  376. {
  377. if (path.StartsWith("/", StringComparison.OrdinalIgnoreCase))
  378. {
  379. return "/emby" + path;
  380. }
  381. return "emby/" + path;
  382. }
  383. private string DoubleNormalizeEmbyRoutePath(string path)
  384. {
  385. if (path.StartsWith("/", StringComparison.OrdinalIgnoreCase))
  386. {
  387. return "/emby/emby" + path;
  388. }
  389. return "emby/emby/" + path;
  390. }
  391. private string NormalizeRoutePath(string path)
  392. {
  393. if (path.StartsWith("/", StringComparison.OrdinalIgnoreCase))
  394. {
  395. return "/mediabrowser" + path;
  396. }
  397. return "mediabrowser/" + path;
  398. }
  399. private string DoubleNormalizeRoutePath(string path)
  400. {
  401. if (path.StartsWith("/", StringComparison.OrdinalIgnoreCase))
  402. {
  403. return "/mediabrowser/mediabrowser" + path;
  404. }
  405. return "mediabrowser/mediabrowser/" + path;
  406. }
  407. /// <summary>
  408. /// Releases the specified instance.
  409. /// </summary>
  410. /// <param name="instance">The instance.</param>
  411. public override void Release(object instance)
  412. {
  413. // Leave this empty so SS doesn't try to dispose our objects
  414. }
  415. private bool _disposed;
  416. private readonly object _disposeLock = new object();
  417. protected virtual void Dispose(bool disposing)
  418. {
  419. if (_disposed) return;
  420. base.Dispose();
  421. lock (_disposeLock)
  422. {
  423. if (_disposed) return;
  424. if (disposing)
  425. {
  426. Stop();
  427. }
  428. //release unmanaged resources here...
  429. _disposed = true;
  430. }
  431. }
  432. public override void Dispose()
  433. {
  434. Dispose(true);
  435. GC.SuppressFinalize(this);
  436. }
  437. public void StartServer(IEnumerable<string> urlPrefixes, string certificatePath)
  438. {
  439. CertificatePath = certificatePath;
  440. UrlPrefixes = urlPrefixes.ToList();
  441. Start(UrlPrefixes.First());
  442. }
  443. }
  444. }