< Summary - Jellyfin

Information
Class: Jellyfin.Api.WebSocketListeners.ActivityLogWebSocketListener
Assembly: Jellyfin.Api
File(s): /srv/git/jellyfin/Jellyfin.Api/WebSocketListeners/ActivityLogWebSocketListener.cs
Line coverage
42%
Covered lines: 6
Uncovered lines: 8
Coverable lines: 14
Total lines: 85
Line coverage: 42.8%
Branch coverage
0%
Covered branches: 0
Total branches: 2
Branch coverage: 0%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Coverage history

Coverage history 0 25 50 75 100

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.ctor(...)100%11100%
get_Type()100%210%
get_StartType()100%210%
get_StopType()100%210%
GetDataToSend()100%210%
Start(...)0%620%
OnEntryCreated(...)100%11100%

File(s)

/srv/git/jellyfin/Jellyfin.Api/WebSocketListeners/ActivityLogWebSocketListener.cs

#LineLine coverage
 1using System;
 2using System.Threading.Tasks;
 3using Jellyfin.Data.Enums;
 4using Jellyfin.Data.Events;
 5using MediaBrowser.Controller.Authentication;
 6using MediaBrowser.Controller.Net;
 7using MediaBrowser.Model.Activity;
 8using MediaBrowser.Model.Session;
 9using Microsoft.Extensions.Logging;
 10
 11namespace Jellyfin.Api.WebSocketListeners;
 12
 13/// <summary>
 14/// Class ActivityLogWebSocketListener.
 15/// </summary>
 16public class ActivityLogWebSocketListener : BasePeriodicWebSocketListener<ActivityLogEntry[], WebSocketListenerState>
 17{
 18    /// <summary>
 19    /// The _kernel.
 20    /// </summary>
 21    private readonly IActivityManager _activityManager;
 22
 23    private bool _disposed;
 24
 25    /// <summary>
 26    /// Initializes a new instance of the <see cref="ActivityLogWebSocketListener"/> class.
 27    /// </summary>
 28    /// <param name="logger">Instance of the <see cref="ILogger{ActivityLogWebSocketListener}"/> interface.</param>
 29    /// <param name="activityManager">Instance of the <see cref="IActivityManager"/> interface.</param>
 30    public ActivityLogWebSocketListener(ILogger<ActivityLogWebSocketListener> logger, IActivityManager activityManager)
 2031        : base(logger)
 32    {
 2033        _activityManager = activityManager;
 2034        _activityManager.EntryCreated += OnEntryCreated;
 2035    }
 36
 37    /// <inheritdoc />
 038    protected override SessionMessageType Type => SessionMessageType.ActivityLogEntry;
 39
 40    /// <inheritdoc />
 041    protected override SessionMessageType StartType => SessionMessageType.ActivityLogEntryStart;
 42
 43    /// <inheritdoc />
 044    protected override SessionMessageType StopType => SessionMessageType.ActivityLogEntryStop;
 45
 46    /// <summary>
 47    /// Gets the data to send.
 48    /// </summary>
 49    /// <returns>Task{SystemInfo}.</returns>
 50    protected override Task<ActivityLogEntry[]> GetDataToSend()
 51    {
 052        return Task.FromResult(Array.Empty<ActivityLogEntry>());
 53    }
 54
 55    /// <inheritdoc />
 56    protected override async ValueTask DisposeAsyncCore()
 57    {
 58        if (!_disposed)
 59        {
 60            _activityManager.EntryCreated -= OnEntryCreated;
 61            _disposed = true;
 62        }
 63
 64        await base.DisposeAsyncCore().ConfigureAwait(false);
 65    }
 66
 67    /// <summary>
 68    /// Starts sending messages over an activity log web socket.
 69    /// </summary>
 70    /// <param name="message">The message.</param>
 71    protected override void Start(WebSocketMessageInfo message)
 72    {
 073        if (!message.Connection.AuthorizationInfo.User.HasPermission(PermissionKind.IsAdministrator))
 74        {
 075            throw new AuthenticationException("Only admin users can retrieve the activity log.");
 76        }
 77
 078        base.Start(message);
 079    }
 80
 81    private void OnEntryCreated(object? sender, GenericEventArgs<ActivityLogEntry> e)
 82    {
 3683        SendData(true);
 3684    }
 85}