Emby.Server.Implementations/ScheduledTasks/Tasks/CleanActivityLogTask.cs


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

using System;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using MediaBrowser.Controller.Configuration;
using MediaBrowser.Model.Activity;
using MediaBrowser.Model.Globalization;
using MediaBrowser.Model.Tasks;

namespace Emby.Server.Implementations.ScheduledTasks.Tasks;

/// <summary>
/// Deletes old activity log entries.
/// </summary>
public class CleanActivityLogTask : IScheduledTask, IConfigurableScheduledTask
{
    private readonly ILocalizationManager _localization;
    private readonly IActivityManager _activityManager;
    private readonly IServerConfigurationManager _serverConfigurationManager;

    /// <summary>
    /// Initializes a new instance of the <see cref="CleanActivityLogTask"/> class.
    /// </summary>
    /// <param name="localization">Instance of the <see cref="ILocalizationManager"/> interface.</param>
    /// <param name="activityManager">Instance of the <see cref="IActivityManager"/> interface.</param>
    /// <param name="serverConfigurationManager">Instance of the <see cref="IServerConfigurationManager"/> interface.</param>
    public CleanActivityLogTask(
        ILocalizationManager localization,
        IActivityManager activityManager,
        IServerConfigurationManager serverConfigurationManager)
    {
        _localization = localization;
        _activityManager = activityManager;
        _serverConfigurationManager = serverConfigurationManager;
    }

    /// <inheritdoc />
    public string Name => _localization.GetLocalizedString("TaskCleanActivityLog");

    /// <inheritdoc />
    public string Key => "CleanActivityLog";

    /// <inheritdoc />
    public string Description => _localization.GetLocalizedString("TaskCleanActivityLogDescription");

    /// <inheritdoc />
    public string Category => _localization.GetLocalizedString("TasksMaintenanceCategory");

    /// <inheritdoc />
    public bool IsHidden => false;

    /// <inheritdoc />
    public bool IsEnabled => true;

    /// <inheritdoc />
    public bool IsLogged => true;

    /// <inheritdoc />
    public Task ExecuteAsync(IProgress<double> progress, CancellationToken cancellationToken)
    {
        var retentionDays = _serverConfigurationManager.Configuration.ActivityLogRetentionDays;
        if (!retentionDays.HasValue || retentionDays < 0)
        {
            throw new InvalidOperationException($"Activity Log Retention days must be at least 0. Currently: {retentionDays}");
        }

        var startDate = DateTime.UtcNow.AddDays(-retentionDays.Value);
        return _activityManager.CleanAsync(startDate);
    }

    /// <inheritdoc />
    public IEnumerable<TaskTriggerInfo> GetDefaultTriggers()
    {
        return [];
    }
}