From e1f8c18b516f5bd31f64b8faaa53266a3daddd7a Mon Sep 17 00:00:00 2001 From: Luke Pulverenti Date: Thu, 9 May 2013 13:38:02 -0400 Subject: added ability to track web sockets per session --- .../Library/UserManager.cs | 302 +---------------- .../MediaBrowser.Server.Implementations.csproj | 4 + .../Session/SessionManager.cs | 372 +++++++++++++++++++++ .../Session/SessionWebSocketListener.cs | 58 ++++ 4 files changed, 440 insertions(+), 296 deletions(-) create mode 100644 MediaBrowser.Server.Implementations/Session/SessionManager.cs create mode 100644 MediaBrowser.Server.Implementations/Session/SessionWebSocketListener.cs (limited to 'MediaBrowser.Server.Implementations') diff --git a/MediaBrowser.Server.Implementations/Library/UserManager.cs b/MediaBrowser.Server.Implementations/Library/UserManager.cs index 99485f726..dc863ca4d 100644 --- a/MediaBrowser.Server.Implementations/Library/UserManager.cs +++ b/MediaBrowser.Server.Implementations/Library/UserManager.cs @@ -7,7 +7,6 @@ using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Entities.Audio; using MediaBrowser.Controller.Library; using MediaBrowser.Controller.Persistence; -using MediaBrowser.Model.Connectivity; using MediaBrowser.Model.Logging; using System; using System.Collections.Concurrent; @@ -17,6 +16,7 @@ using System.Security.Cryptography; using System.Text; using System.Threading; using System.Threading.Tasks; +using MediaBrowser.Model.Session; namespace MediaBrowser.Server.Implementations.Library { @@ -28,8 +28,8 @@ namespace MediaBrowser.Server.Implementations.Library /// /// The _active connections /// - private readonly ConcurrentDictionary _activeConnections = - new ConcurrentDictionary(StringComparer.OrdinalIgnoreCase); + private readonly ConcurrentDictionary _activeConnections = + new ConcurrentDictionary(StringComparer.OrdinalIgnoreCase); /// /// The _users @@ -70,7 +70,7 @@ namespace MediaBrowser.Server.Implementations.Library /// Gets all connections. /// /// All connections. - public IEnumerable AllConnections + public IEnumerable AllConnections { get { return _activeConnections.Values.OrderByDescending(c => c.LastActivityDate); } } @@ -79,7 +79,7 @@ namespace MediaBrowser.Server.Implementations.Library /// Gets the active connections. /// /// The active connections. - public IEnumerable RecentConnections + public IEnumerable RecentConnections { get { return AllConnections.Where(c => (DateTime.UtcNow - c.LastActivityDate).TotalMinutes <= 5); } } @@ -89,8 +89,6 @@ namespace MediaBrowser.Server.Implementations.Library /// private readonly ILogger _logger; - private readonly IUserDataRepository _userDataRepository; - /// /// Gets or sets the configuration manager. /// @@ -109,11 +107,10 @@ namespace MediaBrowser.Server.Implementations.Library /// The logger. /// The configuration manager. /// The user data repository. - public UserManager(ILogger logger, IServerConfigurationManager configurationManager, IUserDataRepository userDataRepository) + public UserManager(ILogger logger, IServerConfigurationManager configurationManager) { _logger = logger; ConfigurationManager = configurationManager; - _userDataRepository = userDataRepository; } #region Events @@ -222,116 +219,6 @@ namespace MediaBrowser.Server.Implementations.Library } } - /// - /// Logs the user activity. - /// - /// The user. - /// Type of the client. - /// The device id. - /// Name of the device. - /// Task. - /// user - public Task LogUserActivity(User user, string clientType, string deviceId, string deviceName) - { - if (user == null) - { - throw new ArgumentNullException("user"); - } - - var activityDate = DateTime.UtcNow; - - var lastActivityDate = user.LastActivityDate; - - user.LastActivityDate = activityDate; - - LogConnection(user.Id, clientType, deviceId, deviceName, activityDate); - - // Don't log in the db anymore frequently than 10 seconds - if (lastActivityDate.HasValue && (activityDate - lastActivityDate.Value).TotalSeconds < 10) - { - return Task.FromResult(true); - } - - // Save this directly. No need to fire off all the events for this. - return UserRepository.SaveUser(user, CancellationToken.None); - } - - /// - /// Updates the now playing item id. - /// - /// The user. - /// Type of the client. - /// The device id. - /// Name of the device. - /// The item. - /// The current position ticks. - private void UpdateNowPlayingItemId(User user, string clientType, string deviceId, string deviceName, BaseItem item, long? currentPositionTicks = null) - { - var conn = GetConnection(user.Id, clientType, deviceId, deviceName); - - conn.NowPlayingPositionTicks = currentPositionTicks; - conn.NowPlayingItem = DtoBuilder.GetBaseItemInfo(item); - conn.LastActivityDate = DateTime.UtcNow; - } - - /// - /// Removes the now playing item id. - /// - /// The user. - /// Type of the client. - /// The device id. - /// Name of the device. - /// The item. - private void RemoveNowPlayingItemId(User user, string clientType, string deviceId, string deviceName, BaseItem item) - { - var conn = GetConnection(user.Id, clientType, deviceId, deviceName); - - if (conn.NowPlayingItem != null && conn.NowPlayingItem.Id.Equals(item.Id.ToString())) - { - conn.NowPlayingItem = null; - conn.NowPlayingPositionTicks = null; - } - } - - /// - /// Logs the connection. - /// - /// The user id. - /// Type of the client. - /// The device id. - /// Name of the device. - /// The last activity date. - private void LogConnection(Guid userId, string clientType, string deviceId, string deviceName, DateTime lastActivityDate) - { - GetConnection(userId, clientType, deviceId, deviceName).LastActivityDate = lastActivityDate; - } - - /// - /// Gets the connection. - /// - /// The user id. - /// Type of the client. - /// The device id. - /// Name of the device. - /// ClientConnectionInfo. - private ClientConnectionInfo GetConnection(Guid userId, string clientType, string deviceId, string deviceName) - { - var key = clientType + deviceId; - - var connection = _activeConnections.GetOrAdd(key, keyName => new ClientConnectionInfo - { - UserId = userId.ToString(), - Client = clientType, - DeviceName = deviceName, - DeviceId = deviceId - }); - - connection.DeviceName = deviceName; - connection.UserId = userId.ToString(); - - return connection; - } - /// /// Loads the users from the repository /// @@ -560,182 +447,5 @@ namespace MediaBrowser.Server.Implementations.Library DateModified = DateTime.UtcNow }; } - - /// - /// Used to report that playback has started for an item - /// - /// The user. - /// The item. - /// Type of the client. - /// The device id. - /// Name of the device. - /// - public void OnPlaybackStart(User user, BaseItem item, string clientType, string deviceId, string deviceName) - { - if (user == null) - { - throw new ArgumentNullException(); - } - if (item == null) - { - throw new ArgumentNullException(); - } - - UpdateNowPlayingItemId(user, clientType, deviceId, deviceName, item); - - // Nothing to save here - // Fire events to inform plugins - EventHelper.QueueEventIfNotNull(PlaybackStart, this, new PlaybackProgressEventArgs - { - Item = item, - User = user - }, _logger); - } - - /// - /// Used to report playback progress for an item - /// - /// The user. - /// The item. - /// The position ticks. - /// Type of the client. - /// The device id. - /// Name of the device. - /// Task. - /// - public async Task OnPlaybackProgress(User user, BaseItem item, long? positionTicks, string clientType, string deviceId, string deviceName) - { - if (user == null) - { - throw new ArgumentNullException(); - } - if (item == null) - { - throw new ArgumentNullException(); - } - - UpdateNowPlayingItemId(user, clientType, deviceId, deviceName, item, positionTicks); - - var key = item.GetUserDataKey(); - - if (positionTicks.HasValue) - { - var data = await _userDataRepository.GetUserData(user.Id, key).ConfigureAwait(false); - - UpdatePlayState(item, data, positionTicks.Value, false); - await _userDataRepository.SaveUserData(user.Id, key, data, CancellationToken.None).ConfigureAwait(false); - } - - EventHelper.QueueEventIfNotNull(PlaybackProgress, this, new PlaybackProgressEventArgs - { - Item = item, - User = user, - PlaybackPositionTicks = positionTicks - }, _logger); - } - - /// - /// Used to report that playback has ended for an item - /// - /// The user. - /// The item. - /// The position ticks. - /// Type of the client. - /// The device id. - /// Name of the device. - /// Task. - /// - public async Task OnPlaybackStopped(User user, BaseItem item, long? positionTicks, string clientType, string deviceId, string deviceName) - { - if (user == null) - { - throw new ArgumentNullException(); - } - if (item == null) - { - throw new ArgumentNullException(); - } - - RemoveNowPlayingItemId(user, clientType, deviceId, deviceName, item); - - var key = item.GetUserDataKey(); - - var data = await _userDataRepository.GetUserData(user.Id, key).ConfigureAwait(false); - - if (positionTicks.HasValue) - { - UpdatePlayState(item, data, positionTicks.Value, true); - } - else - { - // If the client isn't able to report this, then we'll just have to make an assumption - data.PlayCount++; - data.Played = true; - } - - await _userDataRepository.SaveUserData(user.Id, key, data, CancellationToken.None).ConfigureAwait(false); - - EventHelper.QueueEventIfNotNull(PlaybackStopped, this, new PlaybackProgressEventArgs - { - Item = item, - User = user, - PlaybackPositionTicks = positionTicks - }, _logger); - } - - /// - /// Updates playstate position for an item but does not save - /// - /// The item - /// User data for the item - /// The current playback position - /// Whether or not to increment playcount - private void UpdatePlayState(BaseItem item, UserItemData data, long positionTicks, bool incrementPlayCount) - { - // If a position has been reported, and if we know the duration - if (positionTicks > 0 && item.RunTimeTicks.HasValue && item.RunTimeTicks > 0) - { - var pctIn = Decimal.Divide(positionTicks, item.RunTimeTicks.Value) * 100; - - // Don't track in very beginning - if (pctIn < ConfigurationManager.Configuration.MinResumePct) - { - positionTicks = 0; - incrementPlayCount = false; - } - - // If we're at the end, assume completed - else if (pctIn > ConfigurationManager.Configuration.MaxResumePct || positionTicks >= item.RunTimeTicks.Value) - { - positionTicks = 0; - data.Played = true; - } - - else - { - // Enforce MinResumeDuration - var durationSeconds = TimeSpan.FromTicks(item.RunTimeTicks.Value).TotalSeconds; - - if (durationSeconds < ConfigurationManager.Configuration.MinResumeDurationSeconds) - { - positionTicks = 0; - data.Played = true; - } - } - } - - if (item is Audio) - { - data.PlaybackPositionTicks = 0; - } - - data.PlaybackPositionTicks = positionTicks; - - if (incrementPlayCount) - { - data.PlayCount++; - data.LastPlayedDate = DateTime.UtcNow; - } - } } } diff --git a/MediaBrowser.Server.Implementations/MediaBrowser.Server.Implementations.csproj b/MediaBrowser.Server.Implementations/MediaBrowser.Server.Implementations.csproj index f9e7f0385..45515b81f 100644 --- a/MediaBrowser.Server.Implementations/MediaBrowser.Server.Implementations.csproj +++ b/MediaBrowser.Server.Implementations/MediaBrowser.Server.Implementations.csproj @@ -156,6 +156,10 @@ + + Code + + diff --git a/MediaBrowser.Server.Implementations/Session/SessionManager.cs b/MediaBrowser.Server.Implementations/Session/SessionManager.cs new file mode 100644 index 000000000..051c8fb68 --- /dev/null +++ b/MediaBrowser.Server.Implementations/Session/SessionManager.cs @@ -0,0 +1,372 @@ +using MediaBrowser.Common.Events; +using MediaBrowser.Common.Net; +using MediaBrowser.Controller.Configuration; +using MediaBrowser.Controller.Dto; +using MediaBrowser.Controller.Entities; +using MediaBrowser.Controller.Entities.Audio; +using MediaBrowser.Controller.Library; +using MediaBrowser.Controller.Persistence; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.Logging; +using MediaBrowser.Model.Session; +using System; +using System.Collections.Concurrent; +using System.Collections.Generic; +using System.Linq; +using System.Threading; +using System.Threading.Tasks; + +namespace MediaBrowser.Server.Implementations.Session +{ + public class SessionManager : ISessionManager + { + private readonly IUserDataRepository _userDataRepository; + + private readonly IUserRepository _userRepository; + + /// + /// The _logger + /// + private readonly ILogger _logger; + + /// + /// Gets or sets the configuration manager. + /// + /// The configuration manager. + private readonly IServerConfigurationManager _configurationManager; + + /// + /// The _active connections + /// + private readonly ConcurrentDictionary _activeConnections = + new ConcurrentDictionary(StringComparer.OrdinalIgnoreCase); + + private readonly ConcurrentDictionary _websocketConnections = + new ConcurrentDictionary(); + + /// + /// Occurs when [playback start]. + /// + public event EventHandler PlaybackStart; + /// + /// Occurs when [playback progress]. + /// + public event EventHandler PlaybackProgress; + /// + /// Occurs when [playback stopped]. + /// + public event EventHandler PlaybackStopped; + + public SessionManager(IUserDataRepository userDataRepository, IServerConfigurationManager configurationManager, ILogger logger, IUserRepository userRepository) + { + _userDataRepository = userDataRepository; + _configurationManager = configurationManager; + _logger = logger; + _userRepository = userRepository; + } + + /// + /// Gets all connections. + /// + /// All connections. + public IEnumerable AllConnections + { + get { return _activeConnections.Values.OrderByDescending(c => c.LastActivityDate); } + } + + /// + /// Gets the active connections. + /// + /// The active connections. + public IEnumerable RecentConnections + { + get { return AllConnections.Where(c => (DateTime.UtcNow - c.LastActivityDate).TotalMinutes <= 5); } + } + + private readonly Task _trueTaskResult = Task.FromResult(true); + + /// + /// Logs the user activity. + /// + /// Type of the client. + /// The device id. + /// Name of the device. + /// The user. + /// Task. + /// user + public Task LogConnectionActivity(string clientType, string deviceId, string deviceName, User user) + { + var activityDate = DateTime.UtcNow; + + GetConnection(clientType, deviceId, deviceName, user).LastActivityDate = activityDate; + + if (user == null) + { + return _trueTaskResult; + } + + var lastActivityDate = user.LastActivityDate; + + user.LastActivityDate = activityDate; + + // Don't log in the db anymore frequently than 10 seconds + if (lastActivityDate.HasValue && (activityDate - lastActivityDate.Value).TotalSeconds < 10) + { + return _trueTaskResult; + } + + // Save this directly. No need to fire off all the events for this. + return _userRepository.SaveUser(user, CancellationToken.None); + } + + /// + /// Updates the now playing item id. + /// + /// The user. + /// Type of the client. + /// The device id. + /// Name of the device. + /// The item. + /// The current position ticks. + private void UpdateNowPlayingItemId(User user, string clientType, string deviceId, string deviceName, BaseItem item, long? currentPositionTicks = null) + { + var conn = GetConnection(clientType, deviceId, deviceName, user); + + conn.NowPlayingPositionTicks = currentPositionTicks; + conn.NowPlayingItem = DtoBuilder.GetBaseItemInfo(item); + conn.LastActivityDate = DateTime.UtcNow; + } + + /// + /// Removes the now playing item id. + /// + /// The user. + /// Type of the client. + /// The device id. + /// Name of the device. + /// The item. + private void RemoveNowPlayingItemId(User user, string clientType, string deviceId, string deviceName, BaseItem item) + { + var conn = GetConnection(clientType, deviceId, deviceName, user); + + if (conn.NowPlayingItem != null && conn.NowPlayingItem.Id.Equals(item.Id.ToString())) + { + conn.NowPlayingItem = null; + conn.NowPlayingPositionTicks = null; + } + } + + /// + /// Gets the connection. + /// + /// Type of the client. + /// The device id. + /// Name of the device. + /// The user. + /// SessionInfo. + private SessionInfo GetConnection(string clientType, string deviceId, string deviceName, User user) + { + var key = clientType + deviceId; + + var connection = _activeConnections.GetOrAdd(key, keyName => new SessionInfo + { + Client = clientType, + DeviceId = deviceId, + Id = Guid.NewGuid() + }); + + connection.DeviceName = deviceName; + + connection.UserId = user == null ? null : user.Id.ToString(); + + return connection; + } + + /// + /// Used to report that playback has started for an item + /// + /// The user. + /// The item. + /// Type of the client. + /// The device id. + /// Name of the device. + /// + public void OnPlaybackStart(User user, BaseItem item, string clientType, string deviceId, string deviceName) + { + if (user == null) + { + throw new ArgumentNullException(); + } + if (item == null) + { + throw new ArgumentNullException(); + } + + UpdateNowPlayingItemId(user, clientType, deviceId, deviceName, item); + + // Nothing to save here + // Fire events to inform plugins + EventHelper.QueueEventIfNotNull(PlaybackStart, this, new PlaybackProgressEventArgs + { + Item = item, + User = user + }, _logger); + } + + /// + /// Used to report playback progress for an item + /// + /// The user. + /// The item. + /// The position ticks. + /// Type of the client. + /// The device id. + /// Name of the device. + /// Task. + /// + public async Task OnPlaybackProgress(User user, BaseItem item, long? positionTicks, string clientType, string deviceId, string deviceName) + { + if (user == null) + { + throw new ArgumentNullException(); + } + if (item == null) + { + throw new ArgumentNullException(); + } + + UpdateNowPlayingItemId(user, clientType, deviceId, deviceName, item, positionTicks); + + var key = item.GetUserDataKey(); + + if (positionTicks.HasValue) + { + var data = await _userDataRepository.GetUserData(user.Id, key).ConfigureAwait(false); + + UpdatePlayState(item, data, positionTicks.Value, false); + await _userDataRepository.SaveUserData(user.Id, key, data, CancellationToken.None).ConfigureAwait(false); + } + + EventHelper.QueueEventIfNotNull(PlaybackProgress, this, new PlaybackProgressEventArgs + { + Item = item, + User = user, + PlaybackPositionTicks = positionTicks + }, _logger); + } + + /// + /// Used to report that playback has ended for an item + /// + /// The user. + /// The item. + /// The position ticks. + /// Type of the client. + /// The device id. + /// Name of the device. + /// Task. + /// + public async Task OnPlaybackStopped(User user, BaseItem item, long? positionTicks, string clientType, string deviceId, string deviceName) + { + if (user == null) + { + throw new ArgumentNullException(); + } + if (item == null) + { + throw new ArgumentNullException(); + } + + RemoveNowPlayingItemId(user, clientType, deviceId, deviceName, item); + + var key = item.GetUserDataKey(); + + var data = await _userDataRepository.GetUserData(user.Id, key).ConfigureAwait(false); + + if (positionTicks.HasValue) + { + UpdatePlayState(item, data, positionTicks.Value, true); + } + else + { + // If the client isn't able to report this, then we'll just have to make an assumption + data.PlayCount++; + data.Played = true; + } + + await _userDataRepository.SaveUserData(user.Id, key, data, CancellationToken.None).ConfigureAwait(false); + + EventHelper.QueueEventIfNotNull(PlaybackStopped, this, new PlaybackProgressEventArgs + { + Item = item, + User = user, + PlaybackPositionTicks = positionTicks + }, _logger); + } + + /// + /// Updates playstate position for an item but does not save + /// + /// The item + /// User data for the item + /// The current playback position + /// Whether or not to increment playcount + private void UpdatePlayState(BaseItem item, UserItemData data, long positionTicks, bool incrementPlayCount) + { + // If a position has been reported, and if we know the duration + if (positionTicks > 0 && item.RunTimeTicks.HasValue && item.RunTimeTicks > 0) + { + var pctIn = Decimal.Divide(positionTicks, item.RunTimeTicks.Value) * 100; + + // Don't track in very beginning + if (pctIn < _configurationManager.Configuration.MinResumePct) + { + positionTicks = 0; + incrementPlayCount = false; + } + + // If we're at the end, assume completed + else if (pctIn > _configurationManager.Configuration.MaxResumePct || positionTicks >= item.RunTimeTicks.Value) + { + positionTicks = 0; + data.Played = true; + } + + else + { + // Enforce MinResumeDuration + var durationSeconds = TimeSpan.FromTicks(item.RunTimeTicks.Value).TotalSeconds; + + if (durationSeconds < _configurationManager.Configuration.MinResumeDurationSeconds) + { + positionTicks = 0; + data.Played = true; + } + } + } + + if (item is Audio) + { + data.PlaybackPositionTicks = 0; + } + + data.PlaybackPositionTicks = positionTicks; + + if (incrementPlayCount) + { + data.PlayCount++; + data.LastPlayedDate = DateTime.UtcNow; + } + } + + /// + /// Identifies the web socket. + /// + /// The session id. + /// The web socket. + public void IdentifyWebSocket(Guid sessionId, IWebSocketConnection webSocket) + { + _websocketConnections.AddOrUpdate(sessionId, webSocket, (key, existing) => webSocket); + } + } +} diff --git a/MediaBrowser.Server.Implementations/Session/SessionWebSocketListener.cs b/MediaBrowser.Server.Implementations/Session/SessionWebSocketListener.cs new file mode 100644 index 000000000..7ce074cd7 --- /dev/null +++ b/MediaBrowser.Server.Implementations/Session/SessionWebSocketListener.cs @@ -0,0 +1,58 @@ +using System.Linq; +using MediaBrowser.Common.Net; +using MediaBrowser.Controller.Session; +using System; +using System.Threading.Tasks; + +namespace MediaBrowser.Server.Implementations.Session +{ + /// + /// Class SessionWebSocketListener + /// + public class SessionWebSocketListener : IWebSocketListener + { + /// + /// The _true task result + /// + private readonly Task _trueTaskResult = Task.FromResult(true); + + /// + /// The _session manager + /// + private readonly ISessionManager _sessionManager; + + /// + /// Initializes a new instance of the class. + /// + /// The session manager. + public SessionWebSocketListener(ISessionManager sessionManager) + { + _sessionManager = sessionManager; + } + + /// + /// Processes the message. + /// + /// The message. + /// Task. + public Task ProcessMessage(WebSocketMessageInfo message) + { + if (string.Equals(message.MessageType, "Identify", StringComparison.OrdinalIgnoreCase)) + { + var vals = message.Data.Split('|'); + + var deviceId = vals[0]; + var client = vals[1]; + + var session = _sessionManager.AllConnections.FirstOrDefault(i => string.Equals(i.DeviceId, deviceId) && string.Equals(i.Client, client)); + + if (session != null) + { + ((SessionManager)_sessionManager).IdentifyWebSocket(session.Id, message.Connection); + } + } + + return _trueTaskResult; + } + } +} -- cgit v1.2.3