Merge branch 'master' into SSDP

12 files changed, 79 insertions, 86 deletions

diff --git a/MediaBrowser.Controller/Net/AuthenticatedAttribute.cs b/MediaBrowser.Controller/Net/AuthenticatedAttribute.cs
index 29fb81e32..ad786f97b 100644
--- a/MediaBrowser.Controller/Net/AuthenticatedAttribute.cs
+++ b/MediaBrowser.Controller/Net/AuthenticatedAttribute.cs
@@ -31,9 +31,9 @@ namespace MediaBrowser.Controller.Net
         /// <summary>
         /// The request filter is executed before the service.
         /// </summary>
-        /// <param name="request">The http request wrapper</param>
-        /// <param name="response">The http response wrapper</param>
-        /// <param name="requestDto">The request DTO</param>
+        /// <param name="request">The http request wrapper.</param>
+        /// <param name="response">The http response wrapper.</param>
+        /// <param name="requestDto">The request DTO.</param>
         public void RequestFilter(IRequest request, HttpResponse response, object requestDto)
         {
             AuthService.Authenticate(request, this);
@@ -58,8 +58,11 @@ namespace MediaBrowser.Controller.Net
     public interface IAuthenticationAttributes
     {
         bool EscapeParentalControl { get; }
+
         bool AllowBeforeStartupWizard { get; }
+
         bool AllowLocal { get; }
+
         bool AllowLocalOnly { get; }
 
         string[] GetRoles();
diff --git a/MediaBrowser.Controller/Net/AuthorizationInfo.cs b/MediaBrowser.Controller/Net/AuthorizationInfo.cs
index 3e004763d..4361e253b 100644
--- a/MediaBrowser.Controller/Net/AuthorizationInfo.cs
+++ b/MediaBrowser.Controller/Net/AuthorizationInfo.cs
@@ -1,36 +1,40 @@
 using System;
-using MediaBrowser.Controller.Entities;
+using Jellyfin.Data.Entities;
 
 namespace MediaBrowser.Controller.Net
 {
     public class AuthorizationInfo
     {
         /// <summary>
-        /// Gets or sets the user identifier.
+        /// Gets the user identifier.
         /// </summary>
         /// <value>The user identifier.</value>
-        public Guid UserId => User == null ? Guid.Empty : User.Id;
+        public Guid UserId => User?.Id ?? Guid.Empty;
 
         /// <summary>
         /// Gets or sets the device identifier.
         /// </summary>
         /// <value>The device identifier.</value>
         public string DeviceId { get; set; }
+
         /// <summary>
         /// Gets or sets the device.
         /// </summary>
         /// <value>The device.</value>
         public string Device { get; set; }
+
         /// <summary>
         /// Gets or sets the client.
         /// </summary>
         /// <value>The client.</value>
         public string Client { get; set; }
+
         /// <summary>
         /// Gets or sets the version.
         /// </summary>
         /// <value>The version.</value>
         public string Version { get; set; }
+
         /// <summary>
         /// Gets or sets the token.
         /// </summary>
diff --git a/MediaBrowser.Controller/Net/BasePeriodicWebSocketListener.cs b/MediaBrowser.Controller/Net/BasePeriodicWebSocketListener.cs
index b710318ee..a54f6d57b 100644
--- a/MediaBrowser.Controller/Net/BasePeriodicWebSocketListener.cs
+++ b/MediaBrowser.Controller/Net/BasePeriodicWebSocketListener.cs
@@ -11,7 +11,7 @@ using Microsoft.Extensions.Logging;
 namespace MediaBrowser.Controller.Net
 {
     /// <summary>
-    /// Starts sending data over a web socket periodically when a message is received, and then stops when a corresponding stop message is received
+    /// Starts sending data over a web socket periodically when a message is received, and then stops when a corresponding stop message is received.
     /// </summary>
     /// <typeparam name="TReturnDataType">The type of the T return data type.</typeparam>
     /// <typeparam name="TStateType">The type of the T state type.</typeparam>
@@ -20,7 +20,7 @@ namespace MediaBrowser.Controller.Net
         where TReturnDataType : class
     {
         /// <summary>
-        /// The _active connections
+        /// The _active connections.
         /// </summary>
         private readonly List<Tuple<IWebSocketConnection, CancellationTokenSource, TStateType>> _activeConnections =
             new List<Tuple<IWebSocketConnection, CancellationTokenSource, TStateType>>();
@@ -38,11 +38,11 @@ namespace MediaBrowser.Controller.Net
         protected abstract Task<TReturnDataType> GetDataToSend();
 
         /// <summary>
-        /// The logger
+        /// The logger.
         /// </summary>
-        protected ILogger Logger;
+        protected ILogger<BasePeriodicWebSocketListener<TReturnDataType, TStateType>> Logger;
 
-        protected BasePeriodicWebSocketListener(ILogger logger)
+        protected BasePeriodicWebSocketListener(ILogger<BasePeriodicWebSocketListener<TReturnDataType, TStateType>> logger)
         {
             if (logger == null)
             {
@@ -77,22 +77,20 @@ namespace MediaBrowser.Controller.Net
             return Task.CompletedTask;
         }
 
-        protected readonly CultureInfo UsCulture = new CultureInfo("en-US");
-
         /// <summary>
-        /// Starts sending messages over a web socket
+        /// Starts sending messages over a web socket.
         /// </summary>
         /// <param name="message">The message.</param>
         private void Start(WebSocketMessageInfo message)
         {
             var vals = message.Data.Split(',');
 
-            var dueTimeMs = long.Parse(vals[0], UsCulture);
-            var periodMs = long.Parse(vals[1], UsCulture);
+            var dueTimeMs = long.Parse(vals[0], CultureInfo.InvariantCulture);
+            var periodMs = long.Parse(vals[1], CultureInfo.InvariantCulture);
 
             var cancellationTokenSource = new CancellationTokenSource();
 
-            Logger.LogDebug("{1} Begin transmitting over websocket to {0}", message.Connection.RemoteEndPoint, GetType().Name);
+            Logger.LogDebug("WS {1} begin transmitting to {0}", message.Connection.RemoteEndPoint, GetType().Name);
 
             var state = new TStateType
             {
@@ -106,7 +104,7 @@ namespace MediaBrowser.Controller.Net
             }
         }
 
-        protected void SendData(bool force)
+        protected async Task SendData(bool force)
         {
             Tuple<IWebSocketConnection, CancellationTokenSource, TStateType>[] tuples;
 
@@ -130,13 +128,18 @@ namespace MediaBrowser.Controller.Net
                     .ToArray();
             }
 
-            foreach (var tuple in tuples)
+            IEnumerable<Task> GetTasks()
             {
-                SendData(tuple);
+                foreach (var tuple in tuples)
+                {
+                    yield return SendData(tuple);
+                }
             }
+
+            await Task.WhenAll(GetTasks()).ConfigureAwait(false);
         }
 
-        private async void SendData(Tuple<IWebSocketConnection, CancellationTokenSource, TStateType> tuple)
+        private async Task SendData(Tuple<IWebSocketConnection, CancellationTokenSource, TStateType> tuple)
         {
             var connection = tuple.Item1;
 
@@ -150,12 +153,14 @@ namespace MediaBrowser.Controller.Net
 
                 if (data != null)
                 {
-                    await connection.SendAsync(new WebSocketMessage<TReturnDataType>
-                    {
-                        MessageType = Name,
-                        Data = data
-
-                    }, cancellationToken).ConfigureAwait(false);
+                    await connection.SendAsync(
+                        new WebSocketMessage<TReturnDataType>
+                        {
+                            MessageId = Guid.NewGuid(),
+                            MessageType = Name,
+                            Data = data
+                        },
+                        cancellationToken).ConfigureAwait(false);
 
                     state.DateLastSendUtc = DateTime.UtcNow;
                 }
@@ -175,7 +180,7 @@ namespace MediaBrowser.Controller.Net
         }
 
         /// <summary>
-        /// Stops sending messages over a web socket
+        /// Stops sending messages over a web socket.
         /// </summary>
         /// <param name="message">The message.</param>
         private void Stop(WebSocketMessageInfo message)
@@ -197,7 +202,7 @@ namespace MediaBrowser.Controller.Net
         /// <param name="connection">The connection.</param>
         private void DisposeConnection(Tuple<IWebSocketConnection, CancellationTokenSource, TStateType> connection)
         {
-            Logger.LogDebug("{1} stop transmitting over websocket to {0}", connection.Item1.RemoteEndPoint, GetType().Name);
+            Logger.LogDebug("WS {1} stop transmitting to {0}", connection.Item1.RemoteEndPoint, GetType().Name);
 
             // TODO disposing the connection seems to break websockets in subtle ways, so what is the purpose of this function really...
             // connection.Item1.Dispose();
@@ -209,7 +214,7 @@ namespace MediaBrowser.Controller.Net
             }
             catch (ObjectDisposedException)
             {
-                //TODO Investigate and properly fix.
+                // TODO Investigate and properly fix.
             }
 
             lock (_activeConnections)
@@ -242,13 +247,16 @@ namespace MediaBrowser.Controller.Net
         public void Dispose()
         {
             Dispose(true);
+            GC.SuppressFinalize(this);
         }
     }
 
     public class WebSocketListenerState
     {
         public DateTime DateLastSendUtc { get; set; }
+
         public long InitialDelayMs { get; set; }
+
         public long IntervalMs { get; set; }
     }
 }
diff --git a/MediaBrowser.Controller/Net/IAuthService.cs b/MediaBrowser.Controller/Net/IAuthService.cs
index 9132404a0..d8f6d19da 100644
--- a/MediaBrowser.Controller/Net/IAuthService.cs
+++ b/MediaBrowser.Controller/Net/IAuthService.cs
@@ -1,6 +1,6 @@
 #nullable enable
 
-using MediaBrowser.Controller.Entities;
+using Jellyfin.Data.Entities;
 using MediaBrowser.Model.Services;
 using Microsoft.AspNetCore.Http;
 
@@ -9,6 +9,7 @@ namespace MediaBrowser.Controller.Net
     public interface IAuthService
     {
         void Authenticate(IRequest request, IAuthenticationAttributes authAttribtues);
+
         User? Authenticate(HttpRequest request, IAuthenticationAttributes authAttribtues);
     }
 }
diff --git a/MediaBrowser.Controller/Net/IHttpResultFactory.cs b/MediaBrowser.Controller/Net/IHttpResultFactory.cs
index 25404fa78..609bd5f59 100644
--- a/MediaBrowser.Controller/Net/IHttpResultFactory.cs
+++ b/MediaBrowser.Controller/Net/IHttpResultFactory.cs
@@ -7,7 +7,7 @@ using MediaBrowser.Model.Services;
 namespace MediaBrowser.Controller.Net
 {
     /// <summary>
-    /// Interface IHttpResultFactory
+    /// Interface IHttpResultFactory.
     /// </summary>
     public interface IHttpResultFactory
     {
diff --git a/MediaBrowser.Controller/Net/IHttpServer.cs b/MediaBrowser.Controller/Net/IHttpServer.cs
index 806478864..e6609fae3 100644
--- a/MediaBrowser.Controller/Net/IHttpServer.cs
+++ b/MediaBrowser.Controller/Net/IHttpServer.cs
@@ -1,6 +1,5 @@
 using System;
 using System.Collections.Generic;
-using System.Threading;
 using System.Threading.Tasks;
 using MediaBrowser.Model.Events;
 using MediaBrowser.Model.Services;
@@ -9,9 +8,9 @@ using Microsoft.AspNetCore.Http;
 namespace MediaBrowser.Controller.Net
 {
     /// <summary>
-    /// Interface IHttpServer
+    /// Interface IHttpServer.
     /// </summary>
-    public interface IHttpServer : IDisposable
+    public interface IHttpServer
     {
         /// <summary>
         /// Gets the URL prefix.
@@ -20,11 +19,6 @@ namespace MediaBrowser.Controller.Net
         string[] UrlPrefixes { get; }
 
         /// <summary>
-        /// Stops this instance.
-        /// </summary>
-        void Stop();
-
-        /// <summary>
         /// Occurs when [web socket connected].
         /// </summary>
         event EventHandler<GenericEventArgs<IWebSocketConnection>> WebSocketConnected;
@@ -35,27 +29,22 @@ namespace MediaBrowser.Controller.Net
         void Init(IEnumerable<Type> serviceTypes, IEnumerable<IWebSocketListener> listener, IEnumerable<string> urlPrefixes);
 
         /// <summary>
-        /// If set, all requests will respond with this message
+        /// If set, all requests will respond with this message.
         /// </summary>
         string GlobalResponse { get; set; }
 
         /// <summary>
-        /// Sends the http context to the socket listener
+        /// The HTTP request handler.
         /// </summary>
-        /// <param name="ctx"></param>
+        /// <param name="context"></param>
         /// <returns></returns>
-        Task ProcessWebSocketRequest(HttpContext ctx);
+        Task RequestHandler(HttpContext context);
 
         /// <summary>
-        /// The HTTP request handler
+        /// Get the default CORS headers.
         /// </summary>
-        /// <param name="httpReq"></param>
-        /// <param name="urlString"></param>
-        /// <param name="host"></param>
-        /// <param name="localPath"></param>
-        /// <param name="cancellationToken"></param>
+        /// <param name="req"></param>
         /// <returns></returns>
-        Task RequestHandler(IHttpRequest httpReq, string urlString, string host, string localPath,
-            CancellationToken cancellationToken);
+        IDictionary<string, string> GetDefaultCorsHeaders(IRequest req);
     }
 }
diff --git a/MediaBrowser.Controller/Net/ISessionContext.cs b/MediaBrowser.Controller/Net/ISessionContext.cs
index 5c3c19f6b..421ac3fe2 100644
--- a/MediaBrowser.Controller/Net/ISessionContext.cs
+++ b/MediaBrowser.Controller/Net/ISessionContext.cs
@@ -1,4 +1,4 @@
-using MediaBrowser.Controller.Entities;
+using Jellyfin.Data.Entities;
 using MediaBrowser.Controller.Session;
 using MediaBrowser.Model.Services;
 
diff --git a/MediaBrowser.Controller/Net/IWebSocketConnection.cs b/MediaBrowser.Controller/Net/IWebSocketConnection.cs
index 31eb7ccb7..3ef8e5f6d 100644
--- a/MediaBrowser.Controller/Net/IWebSocketConnection.cs
+++ b/MediaBrowser.Controller/Net/IWebSocketConnection.cs
@@ -1,4 +1,7 @@
+#nullable enable
+
 using System;
+using System.Net;
 using System.Net.WebSockets;
 using System.Threading;
 using System.Threading.Tasks;
@@ -7,18 +10,12 @@ using Microsoft.AspNetCore.Http;
 
 namespace MediaBrowser.Controller.Net
 {
-    public interface IWebSocketConnection : IDisposable
+    public interface IWebSocketConnection
     {
         /// <summary>
         /// Occurs when [closed].
         /// </summary>
-        event EventHandler<EventArgs> Closed;
-
-        /// <summary>
-        /// Gets the id.
-        /// </summary>
-        /// <value>The id.</value>
-        Guid Id { get; }
+        event EventHandler<EventArgs>? Closed;
 
         /// <summary>
         /// Gets the last activity date.
@@ -27,21 +24,22 @@ namespace MediaBrowser.Controller.Net
         DateTime LastActivityDate { get; }
 
         /// <summary>
-        /// Gets or sets the URL.
+        /// Gets or sets the date of last Keeplive received.
         /// </summary>
-        /// <value>The URL.</value>
-        string Url { get; set; }
+        /// <value>The date of last Keeplive received.</value>
+        DateTime LastKeepAliveDate { get; set; }
+
         /// <summary>
         /// Gets or sets the query string.
         /// </summary>
         /// <value>The query string.</value>
-        IQueryCollection QueryString { get; set; }
+        IQueryCollection QueryString { get; }
 
         /// <summary>
         /// Gets or sets the receive action.
         /// </summary>
         /// <value>The receive action.</value>
-        Func<WebSocketMessageInfo, Task> OnReceive { get; set; }
+        Func<WebSocketMessageInfo, Task>? OnReceive { get; set; }
 
         /// <summary>
         /// Gets the state.
@@ -53,7 +51,7 @@ namespace MediaBrowser.Controller.Net
         /// Gets the remote end point.
         /// </summary>
         /// <value>The remote end point.</value>
-        string RemoteEndPoint { get; }
+        IPAddress? RemoteEndPoint { get; }
 
         /// <summary>
         /// Sends a message asynchronously.
@@ -65,21 +63,6 @@ namespace MediaBrowser.Controller.Net
         /// <exception cref="ArgumentNullException">message</exception>
         Task SendAsync<T>(WebSocketMessage<T> message, CancellationToken cancellationToken);
 
-        /// <summary>
-        /// Sends a message asynchronously.
-        /// </summary>
-        /// <param name="buffer">The buffer.</param>
-        /// <param name="cancellationToken">The cancellation token.</param>
-        /// <returns>Task.</returns>
-        Task SendAsync(byte[] buffer, CancellationToken cancellationToken);
-
-        /// <summary>
-        /// Sends a message asynchronously.
-        /// </summary>
-        /// <param name="text">The text.</param>
-        /// <param name="cancellationToken">The cancellation token.</param>
-        /// <returns>Task.</returns>
-        /// <exception cref="ArgumentNullException">buffer</exception>
-        Task SendAsync(string text, CancellationToken cancellationToken);
+        Task ProcessAsync(CancellationToken cancellationToken = default);
     }
 }
diff --git a/MediaBrowser.Controller/Net/IWebSocketListener.cs b/MediaBrowser.Controller/Net/IWebSocketListener.cs
index 0f472a2bc..7250a57b0 100644
--- a/MediaBrowser.Controller/Net/IWebSocketListener.cs
+++ b/MediaBrowser.Controller/Net/IWebSocketListener.cs
@@ -3,7 +3,7 @@ using System.Threading.Tasks;
 namespace MediaBrowser.Controller.Net
 {
     /// <summary>
-    ///This is an interface for listening to messages coming through a web socket connection
+    ///This is an interface for listening to messages coming through a web socket connection.
     /// </summary>
     public interface IWebSocketListener
     {
diff --git a/MediaBrowser.Controller/Net/SecurityException.cs b/MediaBrowser.Controller/Net/SecurityException.cs
index a5b94ea5e..f0d0b45a0 100644
--- a/MediaBrowser.Controller/Net/SecurityException.cs
+++ b/MediaBrowser.Controller/Net/SecurityException.cs
@@ -27,7 +27,7 @@ namespace MediaBrowser.Controller.Net
         /// <summary>
         /// Initializes a new instance of the <see cref="SecurityException"/> class.
         /// </summary>
-        /// <param name="message">The message that describes the error</param>
+        /// <param name="message">The message that describes the error.</param>
         /// <param name="innerException">The exception that is the cause of the current exception, or a null reference if no inner exception is specified.</param>
         public SecurityException(string message, Exception innerException)
             : base(message, innerException)
diff --git a/MediaBrowser.Controller/Net/StaticResultOptions.cs b/MediaBrowser.Controller/Net/StaticResultOptions.cs
index 071beaed1..85772e036 100644
--- a/MediaBrowser.Controller/Net/StaticResultOptions.cs
+++ b/MediaBrowser.Controller/Net/StaticResultOptions.cs
@@ -8,8 +8,11 @@ namespace MediaBrowser.Controller.Net
     public class StaticResultOptions
     {
         public string ContentType { get; set; }
+
         public TimeSpan? CacheDuration { get; set; }
+
         public DateTime? DateLastModified { get; set; }
+
         public Func<Task<Stream>> ContentFactory { get; set; }
 
         public bool IsHeadRequest { get; set; }
@@ -17,9 +20,11 @@ namespace MediaBrowser.Controller.Net
         public IDictionary<string, string> ResponseHeaders { get; set; }
 
         public Action OnComplete { get; set; }
+
         public Action OnError { get; set; }
 
         public string Path { get; set; }
+
         public long? ContentLength { get; set; }
 
         public FileShare FileShare { get; set; }
diff --git a/MediaBrowser.Controller/Net/WebSocketMessageInfo.cs b/MediaBrowser.Controller/Net/WebSocketMessageInfo.cs
index 5bf39cae6..be0b3ddc3 100644
--- a/MediaBrowser.Controller/Net/WebSocketMessageInfo.cs
+++ b/MediaBrowser.Controller/Net/WebSocketMessageInfo.cs
@@ -3,7 +3,7 @@ using MediaBrowser.Model.Net;
 namespace MediaBrowser.Controller.Net
 {
     /// <summary>
-    /// Class WebSocketMessageInfo
+    /// Class WebSocketMessageInfo.
     /// </summary>
     public class WebSocketMessageInfo : WebSocketMessage<string>
     {