| | | 1 | | using System; |
| | | 2 | | using System.Collections.Concurrent; |
| | | 3 | | using System.Collections.Generic; |
| | | 4 | | using System.Linq; |
| | | 5 | | using System.Threading.Tasks; |
| | | 6 | | using Jellyfin.Data.Events; |
| | | 7 | | using MediaBrowser.Common.Configuration; |
| | | 8 | | using MediaBrowser.Model.Tasks; |
| | | 9 | | using Microsoft.Extensions.Logging; |
| | | 10 | | |
| | | 11 | | namespace Emby.Server.Implementations.ScheduledTasks; |
| | | 12 | | |
| | | 13 | | /// <summary> |
| | | 14 | | /// Class TaskManager. |
| | | 15 | | /// </summary> |
| | | 16 | | public class TaskManager : ITaskManager |
| | | 17 | | { |
| | | 18 | | /// <summary> |
| | | 19 | | /// The _task queue. |
| | | 20 | | /// </summary> |
| | 21 | 21 | | private readonly ConcurrentQueue<Tuple<Type, TaskOptions>> _taskQueue = |
| | 21 | 22 | | new ConcurrentQueue<Tuple<Type, TaskOptions>>(); |
| | | 23 | | |
| | | 24 | | private readonly IApplicationPaths _applicationPaths; |
| | | 25 | | private readonly ILogger<TaskManager> _logger; |
| | | 26 | | |
| | | 27 | | /// <summary> |
| | | 28 | | /// Initializes a new instance of the <see cref="TaskManager" /> class. |
| | | 29 | | /// </summary> |
| | | 30 | | /// <param name="applicationPaths">The application paths.</param> |
| | | 31 | | /// <param name="logger">The logger.</param> |
| | | 32 | | public TaskManager( |
| | | 33 | | IApplicationPaths applicationPaths, |
| | | 34 | | ILogger<TaskManager> logger) |
| | | 35 | | { |
| | 21 | 36 | | _applicationPaths = applicationPaths; |
| | 21 | 37 | | _logger = logger; |
| | | 38 | | |
| | 21 | 39 | | ScheduledTasks = []; |
| | 21 | 40 | | } |
| | | 41 | | |
| | | 42 | | /// <inheritdoc /> |
| | | 43 | | public event EventHandler<GenericEventArgs<IScheduledTaskWorker>>? TaskExecuting; |
| | | 44 | | |
| | | 45 | | /// <inheritdoc /> |
| | | 46 | | public event EventHandler<TaskCompletionEventArgs>? TaskCompleted; |
| | | 47 | | |
| | | 48 | | /// <inheritdoc /> |
| | | 49 | | public IReadOnlyList<IScheduledTaskWorker> ScheduledTasks { get; private set; } |
| | | 50 | | |
| | | 51 | | /// <inheritdoc /> |
| | | 52 | | public void CancelIfRunningAndQueue<T>(TaskOptions options) |
| | | 53 | | where T : IScheduledTask |
| | | 54 | | { |
| | 20 | 55 | | var task = ScheduledTasks.First(t => t.ScheduledTask.GetType() == typeof(T)); |
| | 20 | 56 | | ((ScheduledTaskWorker)task).CancelIfRunning(); |
| | | 57 | | |
| | 20 | 58 | | QueueScheduledTask<T>(options); |
| | 20 | 59 | | } |
| | | 60 | | |
| | | 61 | | /// <inheritdoc /> |
| | | 62 | | public void CancelIfRunningAndQueue<T>() |
| | | 63 | | where T : IScheduledTask |
| | | 64 | | { |
| | 20 | 65 | | CancelIfRunningAndQueue<T>(new TaskOptions()); |
| | 20 | 66 | | } |
| | | 67 | | |
| | | 68 | | /// <inheritdoc /> |
| | | 69 | | public void CancelIfRunning<T>() |
| | | 70 | | where T : IScheduledTask |
| | | 71 | | { |
| | 0 | 72 | | var task = ScheduledTasks.First(t => t.ScheduledTask.GetType() == typeof(T)); |
| | 0 | 73 | | ((ScheduledTaskWorker)task).CancelIfRunning(); |
| | 0 | 74 | | } |
| | | 75 | | |
| | | 76 | | /// <inheritdoc /> |
| | | 77 | | public void QueueScheduledTask<T>(TaskOptions options) |
| | | 78 | | where T : IScheduledTask |
| | | 79 | | { |
| | 20 | 80 | | var scheduledTask = ScheduledTasks.FirstOrDefault(t => t.ScheduledTask.GetType() == typeof(T)); |
| | | 81 | | |
| | 20 | 82 | | if (scheduledTask is null) |
| | | 83 | | { |
| | 0 | 84 | | _logger.LogError("Unable to find scheduled task of type {Type} in QueueScheduledTask.", typeof(T).Name); |
| | | 85 | | } |
| | | 86 | | else |
| | | 87 | | { |
| | 20 | 88 | | QueueScheduledTask(scheduledTask, options); |
| | | 89 | | } |
| | 20 | 90 | | } |
| | | 91 | | |
| | | 92 | | /// <inheritdoc /> |
| | | 93 | | public void QueueScheduledTask<T>() |
| | | 94 | | where T : IScheduledTask |
| | | 95 | | { |
| | 0 | 96 | | QueueScheduledTask<T>(new TaskOptions()); |
| | 0 | 97 | | } |
| | | 98 | | |
| | | 99 | | /// <inheritdoc /> |
| | | 100 | | public void QueueIfNotRunning<T>() |
| | | 101 | | where T : IScheduledTask |
| | | 102 | | { |
| | 0 | 103 | | var task = ScheduledTasks.First(t => t.ScheduledTask.GetType() == typeof(T)); |
| | | 104 | | |
| | 0 | 105 | | if (task.State != TaskState.Running) |
| | | 106 | | { |
| | 0 | 107 | | QueueScheduledTask<T>(new TaskOptions()); |
| | | 108 | | } |
| | 0 | 109 | | } |
| | | 110 | | |
| | | 111 | | /// <inheritdoc /> |
| | | 112 | | public void Execute<T>() |
| | | 113 | | where T : IScheduledTask |
| | | 114 | | { |
| | 0 | 115 | | var scheduledTask = ScheduledTasks.FirstOrDefault(t => t.ScheduledTask.GetType() == typeof(T)); |
| | | 116 | | |
| | 0 | 117 | | if (scheduledTask is null) |
| | | 118 | | { |
| | 0 | 119 | | _logger.LogError("Unable to find scheduled task of type {Type} in Execute.", typeof(T).Name); |
| | | 120 | | } |
| | | 121 | | else |
| | | 122 | | { |
| | 0 | 123 | | var type = scheduledTask.ScheduledTask.GetType(); |
| | | 124 | | |
| | 0 | 125 | | _logger.LogDebug("Queuing task {Name}", type.Name); |
| | | 126 | | |
| | 0 | 127 | | lock (_taskQueue) |
| | | 128 | | { |
| | 0 | 129 | | if (scheduledTask.State == TaskState.Idle) |
| | | 130 | | { |
| | 0 | 131 | | Execute(scheduledTask, new TaskOptions()); |
| | | 132 | | } |
| | 0 | 133 | | } |
| | | 134 | | } |
| | 0 | 135 | | } |
| | | 136 | | |
| | | 137 | | /// <inheritdoc /> |
| | | 138 | | public void QueueScheduledTask(IScheduledTask task, TaskOptions options) |
| | | 139 | | { |
| | 6 | 140 | | var scheduledTask = ScheduledTasks.FirstOrDefault(t => t.ScheduledTask.GetType() == task.GetType()); |
| | | 141 | | |
| | 6 | 142 | | if (scheduledTask is null) |
| | | 143 | | { |
| | 0 | 144 | | _logger.LogError("Unable to find scheduled task of type {Type} in QueueScheduledTask.", task.GetType().Name) |
| | | 145 | | } |
| | | 146 | | else |
| | | 147 | | { |
| | 6 | 148 | | QueueScheduledTask(scheduledTask, options); |
| | | 149 | | } |
| | 6 | 150 | | } |
| | | 151 | | |
| | | 152 | | /// <summary> |
| | | 153 | | /// Queues the scheduled task. |
| | | 154 | | /// </summary> |
| | | 155 | | /// <param name="task">The task.</param> |
| | | 156 | | /// <param name="options">The task options.</param> |
| | | 157 | | private void QueueScheduledTask(IScheduledTaskWorker task, TaskOptions options) |
| | | 158 | | { |
| | 26 | 159 | | var type = task.ScheduledTask.GetType(); |
| | | 160 | | |
| | 26 | 161 | | _logger.LogDebug("Queuing task {Name}", type.Name); |
| | | 162 | | |
| | 26 | 163 | | lock (_taskQueue) |
| | | 164 | | { |
| | 26 | 165 | | if (task.State == TaskState.Idle) |
| | | 166 | | { |
| | 26 | 167 | | Execute(task, options); |
| | 26 | 168 | | return; |
| | | 169 | | } |
| | | 170 | | |
| | 0 | 171 | | _taskQueue.Enqueue(new Tuple<Type, TaskOptions>(type, options)); |
| | 0 | 172 | | } |
| | 26 | 173 | | } |
| | | 174 | | |
| | | 175 | | /// <inheritdoc /> |
| | | 176 | | public void AddTasks(IEnumerable<IScheduledTask> tasks) |
| | | 177 | | { |
| | 21 | 178 | | var list = tasks.Select(t => new ScheduledTaskWorker(t, _applicationPaths, this, _logger)); |
| | | 179 | | |
| | 21 | 180 | | ScheduledTasks = ScheduledTasks.Concat(list).ToArray(); |
| | 21 | 181 | | } |
| | | 182 | | |
| | | 183 | | /// <inheritdoc /> |
| | | 184 | | public void Dispose() |
| | | 185 | | { |
| | 21 | 186 | | Dispose(true); |
| | 21 | 187 | | GC.SuppressFinalize(this); |
| | 21 | 188 | | } |
| | | 189 | | |
| | | 190 | | /// <summary> |
| | | 191 | | /// Releases unmanaged and - optionally - managed resources. |
| | | 192 | | /// </summary> |
| | | 193 | | /// <param name="dispose"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only |
| | | 194 | | protected virtual void Dispose(bool dispose) |
| | | 195 | | { |
| | 882 | 196 | | foreach (var task in ScheduledTasks) |
| | | 197 | | { |
| | 420 | 198 | | task.Dispose(); |
| | | 199 | | } |
| | 21 | 200 | | } |
| | | 201 | | |
| | | 202 | | /// <inheritdoc /> |
| | | 203 | | public void Cancel(IScheduledTaskWorker task) |
| | | 204 | | { |
| | 0 | 205 | | ((ScheduledTaskWorker)task).Cancel(); |
| | 0 | 206 | | } |
| | | 207 | | |
| | | 208 | | /// <inheritdoc /> |
| | | 209 | | public Task Execute(IScheduledTaskWorker task, TaskOptions options) |
| | | 210 | | { |
| | 26 | 211 | | return ((ScheduledTaskWorker)task).Execute(options); |
| | | 212 | | } |
| | | 213 | | |
| | | 214 | | /// <summary> |
| | | 215 | | /// Called when [task executing]. |
| | | 216 | | /// </summary> |
| | | 217 | | /// <param name="task">The task.</param> |
| | | 218 | | internal void OnTaskExecuting(IScheduledTaskWorker task) |
| | | 219 | | { |
| | 26 | 220 | | TaskExecuting?.Invoke(this, new GenericEventArgs<IScheduledTaskWorker>(task)); |
| | 23 | 221 | | } |
| | | 222 | | |
| | | 223 | | /// <summary> |
| | | 224 | | /// Called when [task completed]. |
| | | 225 | | /// </summary> |
| | | 226 | | /// <param name="task">The task.</param> |
| | | 227 | | /// <param name="result">The result.</param> |
| | | 228 | | internal void OnTaskCompleted(IScheduledTaskWorker task, TaskResult result) |
| | | 229 | | { |
| | 31 | 230 | | TaskCompleted?.Invoke(task, new TaskCompletionEventArgs(task, result)); |
| | | 231 | | |
| | 31 | 232 | | ExecuteQueuedTasks(); |
| | 31 | 233 | | } |
| | | 234 | | |
| | | 235 | | /// <summary> |
| | | 236 | | /// Executes the queued tasks. |
| | | 237 | | /// </summary> |
| | | 238 | | private void ExecuteQueuedTasks() |
| | | 239 | | { |
| | 31 | 240 | | lock (_taskQueue) |
| | | 241 | | { |
| | 31 | 242 | | var list = new List<Tuple<Type, TaskOptions>>(); |
| | | 243 | | |
| | 31 | 244 | | while (_taskQueue.TryDequeue(out var item)) |
| | | 245 | | { |
| | 0 | 246 | | if (list.All(i => i.Item1 != item.Item1)) |
| | | 247 | | { |
| | 0 | 248 | | list.Add(item); |
| | | 249 | | } |
| | 0 | 250 | | } |
| | | 251 | | |
| | 62 | 252 | | foreach (var enqueuedType in list) |
| | | 253 | | { |
| | 0 | 254 | | var scheduledTask = ScheduledTasks.First(t => t.ScheduledTask.GetType() == enqueuedType.Item1); |
| | | 255 | | |
| | 0 | 256 | | if (scheduledTask.State == TaskState.Idle) |
| | | 257 | | { |
| | 0 | 258 | | Execute(scheduledTask, enqueuedType.Item2); |
| | | 259 | | } |
| | | 260 | | } |
| | | 261 | | } |
| | 31 | 262 | | } |
| | | 263 | | } |