jellyfin/Jellyfin.Api/WebSocketListeners/SessionInfoWebSocketListener.cs
crobibero b11de39c34 Backport pull request #13499 from jellyfin/release-10.10.z
Allow api key to subscribe to admin websockets

Original-merge: 03082e90f971a44e0967caa16026696b830bdf88

Merged-by: joshuaboniface <joshua@boniface.me>

Backported-by: Bond_009 <bond.009@outlook.com>
2025-02-09 08:50:53 -05:00

127 lines
4.5 KiB
C#

using System.Collections.Generic;
using System.Threading.Tasks;
using Jellyfin.Data.Enums;
using MediaBrowser.Controller.Authentication;
using MediaBrowser.Controller.Library;
using MediaBrowser.Controller.Net;
using MediaBrowser.Controller.Session;
using MediaBrowser.Model.Session;
using Microsoft.Extensions.Logging;
namespace Jellyfin.Api.WebSocketListeners;
/// <summary>
/// Class SessionInfoWebSocketListener.
/// </summary>
public class SessionInfoWebSocketListener : BasePeriodicWebSocketListener<IEnumerable<SessionInfo>, WebSocketListenerState>
{
private readonly ISessionManager _sessionManager;
private bool _disposed;
/// <summary>
/// Initializes a new instance of the <see cref="SessionInfoWebSocketListener"/> class.
/// </summary>
/// <param name="logger">Instance of the <see cref="ILogger{SessionInfoWebSocketListener}"/> interface.</param>
/// <param name="sessionManager">Instance of the <see cref="ISessionManager"/> interface.</param>
public SessionInfoWebSocketListener(ILogger<SessionInfoWebSocketListener> logger, ISessionManager sessionManager)
: base(logger)
{
_sessionManager = sessionManager;
_sessionManager.SessionStarted += OnSessionManagerSessionStarted;
_sessionManager.SessionEnded += OnSessionManagerSessionEnded;
_sessionManager.PlaybackStart += OnSessionManagerPlaybackStart;
_sessionManager.PlaybackStopped += OnSessionManagerPlaybackStopped;
_sessionManager.PlaybackProgress += OnSessionManagerPlaybackProgress;
_sessionManager.CapabilitiesChanged += OnSessionManagerCapabilitiesChanged;
_sessionManager.SessionActivity += OnSessionManagerSessionActivity;
}
/// <inheritdoc />
protected override SessionMessageType Type => SessionMessageType.Sessions;
/// <inheritdoc />
protected override SessionMessageType StartType => SessionMessageType.SessionsStart;
/// <inheritdoc />
protected override SessionMessageType StopType => SessionMessageType.SessionsStop;
/// <summary>
/// Gets the data to send.
/// </summary>
/// <returns>Task{SystemInfo}.</returns>
protected override Task<IEnumerable<SessionInfo>> GetDataToSend()
{
return Task.FromResult(_sessionManager.Sessions);
}
/// <inheritdoc />
protected override async ValueTask DisposeAsyncCore()
{
if (!_disposed)
{
_sessionManager.SessionStarted -= OnSessionManagerSessionStarted;
_sessionManager.SessionEnded -= OnSessionManagerSessionEnded;
_sessionManager.PlaybackStart -= OnSessionManagerPlaybackStart;
_sessionManager.PlaybackStopped -= OnSessionManagerPlaybackStopped;
_sessionManager.PlaybackProgress -= OnSessionManagerPlaybackProgress;
_sessionManager.CapabilitiesChanged -= OnSessionManagerCapabilitiesChanged;
_sessionManager.SessionActivity -= OnSessionManagerSessionActivity;
_disposed = true;
}
await base.DisposeAsyncCore().ConfigureAwait(false);
}
/// <summary>
/// Starts sending messages over a session info web socket.
/// </summary>
/// <param name="message">The message.</param>
protected override void Start(WebSocketMessageInfo message)
{
if (!message.Connection.AuthorizationInfo.IsApiKey
&& (message.Connection.AuthorizationInfo.User is null
|| !message.Connection.AuthorizationInfo.User.HasPermission(PermissionKind.IsAdministrator)))
{
throw new AuthenticationException("Only admin users can subscribe to session information.");
}
base.Start(message);
}
private void OnSessionManagerSessionActivity(object? sender, SessionEventArgs e)
{
SendData(false);
}
private void OnSessionManagerCapabilitiesChanged(object? sender, SessionEventArgs e)
{
SendData(true);
}
private void OnSessionManagerPlaybackProgress(object? sender, PlaybackProgressEventArgs e)
{
SendData(!e.IsAutomated);
}
private void OnSessionManagerPlaybackStopped(object? sender, PlaybackStopEventArgs e)
{
SendData(true);
}
private void OnSessionManagerPlaybackStart(object? sender, PlaybackProgressEventArgs e)
{
SendData(true);
}
private void OnSessionManagerSessionEnded(object? sender, SessionEventArgs e)
{
SendData(true);
}
private void OnSessionManagerSessionStarted(object? sender, SessionEventArgs e)
{
SendData(true);
}
}