Synchronize access to data

Emby.Server.Implementations/Session/SessionWebSocketListener.cs

@@ -1,6 +1,5 @@
-using System.Collections.Generic;
 using System;
-using System.Collections.Concurrent;
+using System.Collections.Generic;
 using System.Linq;
 using System.Net.WebSockets;
 using System.Threading;
@@ -26,9 +25,9 @@ namespace Emby.Server.Implementations.Session
         public readonly int WebSocketLostTimeout = 60;
 
         /// <summary>
-        /// The keep-alive timer factor; controls how often the timer will check on the status of the WebSockets.
+        /// The keep-alive interval factor; controls how often the watcher will check on the status of the WebSockets.
         /// </summary>
-        public readonly double TimerFactor = 0.2;
+        public readonly double IntervalFactor = 0.2;
 
         /// <summary>
         /// The ForceKeepAlive factor; controls when a ForceKeepAlive is sent.
@@ -53,14 +52,24 @@ namespace Emby.Server.Implementations.Session
         private readonly IHttpServer _httpServer;
 
         /// <summary>
-        /// The KeepAlive timer.
+        /// The KeepAlive cancellation token.
         /// </summary>
-        private Timer _keepAliveTimer;
+        private CancellationTokenSource _keepAliveCancellationToken;
+
+        /// <summary>
+        /// Lock used for accesing the KeepAlive cancellation token.
+        /// </summary>
+        private readonly object _keepAliveLock = new object();
 
         /// <summary>
         /// The WebSocket watchlist.
         /// </summary>
-        private readonly ConcurrentDictionary<IWebSocketConnection, byte> _webSockets = new ConcurrentDictionary<IWebSocketConnection, byte>();
+        private readonly HashSet<IWebSocketConnection> _webSockets = new HashSet<IWebSocketConnection>();
+
+        /// <summary>
+        /// Lock used for accesing the WebSockets watchlist.
+        /// </summary>
+        private readonly object _webSocketsLock = new object();
 
         /// <summary>
         /// Initializes a new instance of the <see cref="SessionWebSocketListener" /> class.
@@ -113,7 +122,7 @@ namespace Emby.Server.Implementations.Session
         public void Dispose()
         {
             _httpServer.WebSocketConnected -= _serverManager_WebSocketConnected;
-            StopKeepAliveTimer();
+            StopKeepAlive();
         }
 
         /// <summary>
@@ -140,6 +149,7 @@ namespace Emby.Server.Implementations.Session
         private void OnWebSocketClosed(object sender, EventArgs e)
         {
             var webSocket = (IWebSocketConnection) sender;
+            _logger.LogDebug("WebSockets {0} closed.", webSocket);
             RemoveWebSocket(webSocket);
         }
 
@@ -147,15 +157,20 @@ namespace Emby.Server.Implementations.Session
         /// Adds a WebSocket to the KeepAlive watchlist.
         /// </summary>
         /// <param name="webSocket">The WebSocket to monitor.</param>
-        private async void KeepAliveWebSocket(IWebSocketConnection webSocket)
+        private async Task KeepAliveWebSocket(IWebSocketConnection webSocket)
         {
-            if (!_webSockets.TryAdd(webSocket, 0))
+            lock (_webSocketsLock)
             {
-                _logger.LogWarning("Multiple attempts to keep alive single WebSocket {0}", webSocket);
+                if (!_webSockets.Add(webSocket))
-                return;
+                {
+                    _logger.LogWarning("Multiple attempts to keep alive single WebSocket {0}", webSocket);
+                    return;
+                }
+                webSocket.Closed += OnWebSocketClosed;
+                webSocket.LastKeepAliveDate = DateTime.UtcNow;
+
+                StartKeepAlive();
             }
-            webSocket.Closed += OnWebSocketClosed;
-            webSocket.LastKeepAliveDate = DateTime.UtcNow;
 
             // Notify WebSocket about timeout
             try
@@ -164,10 +179,8 @@ namespace Emby.Server.Implementations.Session
             }
             catch (WebSocketException exception)
             {
-                _logger.LogWarning(exception, "Error sending ForceKeepAlive message to WebSocket.");
+                _logger.LogWarning(exception, "Error sending ForceKeepAlive message to WebSocket {0}.", webSocket);
             }
-
-            StartKeepAliveTimer();
         }
 
         /// <summary>
@@ -176,88 +189,131 @@ namespace Emby.Server.Implementations.Session
         /// <param name="webSocket">The WebSocket to remove.</param>
         private void RemoveWebSocket(IWebSocketConnection webSocket)
         {
-            webSocket.Closed -= OnWebSocketClosed;
+            lock (_webSocketsLock)
-            _webSockets.TryRemove(webSocket, out _);
-        }
-
-        /// <summary>
-        /// Starts the KeepAlive timer.
-        /// </summary>
-        private void StartKeepAliveTimer()
-        {
-            if (_keepAliveTimer == null)
             {
-                _keepAliveTimer = new Timer(
+                if (!_webSockets.Remove(webSocket))
-                    KeepAliveSockets,
+                {
-                    null,
+                    _logger.LogWarning("WebSocket {0} not on watchlist.", webSocket);
-                    TimeSpan.FromSeconds(WebSocketLostTimeout * TimerFactor),
+                }
-                    TimeSpan.FromSeconds(WebSocketLostTimeout * TimerFactor)
+                else
-                );
+                {
+                    webSocket.Closed -= OnWebSocketClosed;
+                }
             }
         }
 
         /// <summary>
-        /// Stops the KeepAlive timer.
+        /// Starts the KeepAlive watcher.
         /// </summary>
-        private void StopKeepAliveTimer()
+        private void StartKeepAlive()
         {
-            if (_keepAliveTimer != null)
+            lock (_keepAliveLock)
             {
-                _keepAliveTimer.Dispose();
+                if (_keepAliveCancellationToken == null)
-                _keepAliveTimer = null;
+                {
-            }
+                    _keepAliveCancellationToken = new CancellationTokenSource();
-
+                    // Start KeepAlive watcher
-            foreach (var pair in _webSockets)
+                    KeepAliveSockets(
-            {
+                        TimeSpan.FromSeconds(WebSocketLostTimeout * IntervalFactor),
-                pair.Key.Closed -= OnWebSocketClosed;
+                        _keepAliveCancellationToken.Token);
+                }
             }
         }
 
         /// <summary>
-        /// Checks status of KeepAlive of WebSockets.
+        /// Stops the KeepAlive watcher.
         /// </summary>
-        /// <param name="state">The state.</param>
+        private void StopKeepAlive()
-        private async void KeepAliveSockets(object state)
         {
-            var inactive = _webSockets.Keys.Where(i =>
+            lock (_keepAliveLock)
             {
-                var elapsed = (DateTime.UtcNow - i.LastKeepAliveDate).TotalSeconds;
+                if (_keepAliveCancellationToken != null)
-                return (elapsed > WebSocketLostTimeout * ForceKeepAliveFactor) && (elapsed < WebSocketLostTimeout);
+                {
-            });
+                    _keepAliveCancellationToken.Cancel();
-            var lost = _webSockets.Keys.Where(i => (DateTime.UtcNow - i.LastKeepAliveDate).TotalSeconds >= WebSocketLostTimeout);
+                    _keepAliveCancellationToken = null;
-
+                }
-            if (inactive.Any())
-            {
-                _logger.LogDebug("Sending ForceKeepAlive message to {0} inactive WebSockets.", inactive.Count());
             }
 
-            foreach (var webSocket in inactive)
+            lock (_webSocketsLock)
             {
+                foreach (var webSocket in _webSockets)
+                {
+                    webSocket.Closed -= OnWebSocketClosed;
+                }
+                _webSockets.Clear();
+            }
+        }
+
+        /// <summary>
+        /// Checks status of KeepAlive of WebSockets once every the specified interval time.
+        /// </summary>
+        /// <param name="interval">The interval.</param>
+        /// <param name="cancellationToken">The cancellation token.</param>
+        private async Task KeepAliveSockets(TimeSpan interval, CancellationToken cancellationToken)
+        {
+            while (true)
+            {
+                _logger.LogDebug("Watching {0} WebSockets.", _webSockets.Count());
+
+                IEnumerable<IWebSocketConnection> inactive;
+                IEnumerable<IWebSocketConnection> lost;
+                lock (_webSocketsLock)
+                {
+                    inactive = _webSockets.Where(i =>
+                    {
+                        var elapsed = (DateTime.UtcNow - i.LastKeepAliveDate).TotalSeconds;
+                        return (elapsed > WebSocketLostTimeout * ForceKeepAliveFactor) && (elapsed < WebSocketLostTimeout);
+                    });
+                    lost = _webSockets.Where(i => (DateTime.UtcNow - i.LastKeepAliveDate).TotalSeconds >= WebSocketLostTimeout);
+                }
+
+                if (inactive.Any())
+                {
+                    _logger.LogInformation("Sending ForceKeepAlive message to {0} inactive WebSockets.", inactive.Count());
+                }
+
+                foreach (var webSocket in inactive)
+                {
+                    try
+                    {
+                        await SendForceKeepAlive(webSocket);
+                    }
+                    catch (WebSocketException exception)
+                    {
+                        _logger.LogInformation(exception, "Error sending ForceKeepAlive message to WebSocket.");
+                        lost = lost.Append(webSocket);
+                    }
+                }
+
+                lock (_webSocketsLock)
+                {
+                    if (lost.Any())
+                    {
+                        _logger.LogInformation("Lost {0} WebSockets.", lost.Count());
+                        foreach (var webSocket in lost.ToList())
+                        {
+                            // TODO: handle session relative to the lost webSocket
+                            RemoveWebSocket(webSocket);
+                        }
+                    }
+
+                    if (!_webSockets.Any())
+                    {
+                        StopKeepAlive();
+                    }
+                }
+
+                // Wait for next interval
+                Task task = Task.Delay(interval, cancellationToken);
                 try
                 {
-                    await SendForceKeepAlive(webSocket);
+                    await task;
                 }
-                catch (WebSocketException exception)
+                catch (TaskCanceledException)
                 {
-                    _logger.LogInformation(exception, "Error sending ForceKeepAlive message to WebSocket.");
+                    return;
-                    lost.Append(webSocket);
                 }
             }
-
-            if (lost.Any())
-            {
-                _logger.LogInformation("Lost {0} WebSockets.", lost.Count());
-                foreach (var webSocket in lost)
-                {
-                    // TODO: handle session relative to the lost webSocket
-                    RemoveWebSocket(webSocket);
-                }
-            }
-
-            if (!_webSockets.Any())
-            {
-                StopKeepAliveTimer();
-            }
         }
 
         /// <summary>

Emby.Server.Implementations/Syncplay/SyncplayManager.cs

@@ -1,5 +1,4 @@
 using System;
-using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.Globalization;
 using System.Linq;
@@ -42,14 +41,19 @@ namespace Emby.Server.Implementations.Syncplay
         /// <summary>
         /// The map between sessions and groups.
         /// </summary>
-        private readonly ConcurrentDictionary<string, ISyncplayController> _sessionToGroupMap =
+        private readonly Dictionary<string, ISyncplayController> _sessionToGroupMap =
-            new ConcurrentDictionary<string, ISyncplayController>(StringComparer.OrdinalIgnoreCase);
+            new Dictionary<string, ISyncplayController>(StringComparer.OrdinalIgnoreCase);
 
         /// <summary>
         /// The groups.
         /// </summary>
-        private readonly ConcurrentDictionary<string, ISyncplayController> _groups =
+        private readonly Dictionary<string, ISyncplayController> _groups =
-            new ConcurrentDictionary<string, ISyncplayController>(StringComparer.OrdinalIgnoreCase);
+            new Dictionary<string, ISyncplayController>(StringComparer.OrdinalIgnoreCase);
+
+        /// <summary>
+        /// Lock used for accesing any group.
+        /// </summary>
+        private readonly object _groupsLock = new object();
 
         private bool _disposed = false;
 
@@ -175,15 +179,18 @@ namespace Emby.Server.Implementations.Syncplay
                 return;
             }
 
-            if (IsSessionInGroup(session))
+            lock (_groupsLock)
             {
-                LeaveGroup(session);
+                if (IsSessionInGroup(session))
+                {
+                    LeaveGroup(session);
+                }
+
+                var group = new SyncplayController(_logger, _sessionManager, this);
+                _groups[group.GetGroupId().ToString()] = group;
+
+                group.InitGroup(session);
             }
-
-            var group = new SyncplayController(_logger, _sessionManager, this);
-            _groups[group.GetGroupId().ToString()] = group;
-
-            group.InitGroup(session);
         }
 
         /// <inheritdoc />
@@ -203,67 +210,73 @@ namespace Emby.Server.Implementations.Syncplay
                 return;
             }
 
-            ISyncplayController group;
+            lock (_groupsLock)
-            _groups.TryGetValue(groupId, out group);
-
-            if (group == null)
             {
-                _logger.LogWarning("Syncplaymanager JoinGroup: {0} tried to join group {0} that does not exist.", session.Id, groupId);
+                ISyncplayController group;
+                _groups.TryGetValue(groupId, out group);
 
-                var error = new GroupUpdate<string>()
+                if (group == null)
                 {
-                    Type = GroupUpdateType.GroupNotJoined
+                    _logger.LogWarning("Syncplaymanager JoinGroup: {0} tried to join group {0} that does not exist.", session.Id, groupId);
-                };
-                _sessionManager.SendSyncplayGroupUpdate(session.Id.ToString(), error, CancellationToken.None);
-                return;
-            }
 
-            if (!HasAccessToItem(user, group.GetPlayingItemId()))
+                    var error = new GroupUpdate<string>()
-            {
+                    {
-                _logger.LogWarning("Syncplaymanager JoinGroup: {0} does not have access to {1}.", session.Id, group.GetPlayingItemId());
+                        Type = GroupUpdateType.GroupNotJoined
+                    };
+                    _sessionManager.SendSyncplayGroupUpdate(session.Id.ToString(), error, CancellationToken.None);
+                    return;
+                }
 
-                var error = new GroupUpdate<string>()
+                if (!HasAccessToItem(user, group.GetPlayingItemId()))
                 {
-                    GroupId = group.GetGroupId().ToString(),
+                    _logger.LogWarning("Syncplaymanager JoinGroup: {0} does not have access to {1}.", session.Id, group.GetPlayingItemId());
-                    Type = GroupUpdateType.LibraryAccessDenied
-                };
-                _sessionManager.SendSyncplayGroupUpdate(session.Id.ToString(), error, CancellationToken.None);
-                return;
-            }
 
-            if (IsSessionInGroup(session))
+                    var error = new GroupUpdate<string>()
-            {
+                    {
-                if (GetSessionGroup(session).Equals(groupId)) return;
+                        GroupId = group.GetGroupId().ToString(),
-                LeaveGroup(session);
+                        Type = GroupUpdateType.LibraryAccessDenied
-            }
+                    };
+                    _sessionManager.SendSyncplayGroupUpdate(session.Id.ToString(), error, CancellationToken.None);
+                    return;
+                }
 
-            group.SessionJoin(session, request);
+                if (IsSessionInGroup(session))
+                {
+                    if (GetSessionGroup(session).Equals(groupId)) return;
+                    LeaveGroup(session);
+                }
+
+                group.SessionJoin(session, request);
+            }
         }
 
         /// <inheritdoc />
         public void LeaveGroup(SessionInfo session)
         {
             // TODO: determine what happens to users that are in a group and get their permissions revoked
-
+            lock (_groupsLock)
-            ISyncplayController group;
-            _sessionToGroupMap.TryGetValue(session.Id, out group);
-
-            if (group == null)
             {
-                _logger.LogWarning("Syncplaymanager LeaveGroup: {0} does not belong to any group.", session.Id);
+                ISyncplayController group;
+                _sessionToGroupMap.TryGetValue(session.Id, out group);
 
-                var error = new GroupUpdate<string>()
+                if (group == null)
                 {
-                    Type = GroupUpdateType.NotInGroup
+                    _logger.LogWarning("Syncplaymanager LeaveGroup: {0} does not belong to any group.", session.Id);
-                };
-                _sessionManager.SendSyncplayGroupUpdate(session.Id.ToString(), error, CancellationToken.None);
-                return;
-            }
-            group.SessionLeave(session);
 
-            if (group.IsGroupEmpty())
+                    var error = new GroupUpdate<string>()
-            {
+                    {
-                _groups.Remove(group.GetGroupId().ToString(), out _);
+                        Type = GroupUpdateType.NotInGroup
+                    };
+                    _sessionManager.SendSyncplayGroupUpdate(session.Id.ToString(), error, CancellationToken.None);
+                    return;
+                }
+
+                group.SessionLeave(session);
+
+                if (group.IsGroupEmpty())
+                {
+                    _groups.Remove(group.GetGroupId().ToString(), out _);
+                }
             }
         }
 
@@ -314,21 +327,25 @@ namespace Emby.Server.Implementations.Syncplay
                 return;
             }
 
-            ISyncplayController group;
+            lock (_groupsLock)
-            _sessionToGroupMap.TryGetValue(session.Id, out group);
-
-            if (group == null)
             {
-                _logger.LogWarning("Syncplaymanager HandleRequest: {0} does not belong to any group.", session.Id);
+                ISyncplayController group;
+                _sessionToGroupMap.TryGetValue(session.Id, out group);
 
-                var error = new GroupUpdate<string>()
+                if (group == null)
                 {
-                    Type = GroupUpdateType.NotInGroup
+                    _logger.LogWarning("Syncplaymanager HandleRequest: {0} does not belong to any group.", session.Id);
-                };
+
-                _sessionManager.SendSyncplayGroupUpdate(session.Id.ToString(), error, CancellationToken.None);
+                    var error = new GroupUpdate<string>()
-                return;
+                    {
+                        Type = GroupUpdateType.NotInGroup
+                    };
+                    _sessionManager.SendSyncplayGroupUpdate(session.Id.ToString(), error, CancellationToken.None);
+                    return;
+                }
+
+                group.HandleRequest(session, request);
             }
-            group.HandleRequest(session, request);
         }
 
         /// <inheritdoc />

MediaBrowser.Api/Syncplay/TimeSyncService.cs

@@ -9,7 +9,6 @@ using Microsoft.Extensions.Logging;
 namespace MediaBrowser.Api.Syncplay
 {
     [Route("/GetUtcTime", "GET", Summary = "Get UtcTime")]
-    [Authenticated]
     public class GetUtcTime : IReturnVoid
     {
         // Nothing
@@ -33,13 +32,10 @@ namespace MediaBrowser.Api.Syncplay
         public TimeSyncService(
             ILogger<TimeSyncService> logger,
             IServerConfigurationManager serverConfigurationManager,
-            IHttpResultFactory httpResultFactory,
+            IHttpResultFactory httpResultFactory)
-            ISessionManager sessionManager,
-            ISessionContext sessionContext)
             : base(logger, serverConfigurationManager, httpResultFactory)
         {
-            _sessionManager = sessionManager;
+            // Do nothing
-            _sessionContext = sessionContext;
         }
 
         /// <summary>