jellyfin/MediaBrowser.Api/ScheduledTasks/ScheduledTaskService.cs

242 lines
8.2 KiB
C#
Raw Normal View History

using System;
2013-02-21 01:33:05 +00:00
using System.Collections.Generic;
using System.Linq;
using MediaBrowser.Common.Extensions;
2016-02-28 21:31:45 +00:00
using MediaBrowser.Controller.Configuration;
using MediaBrowser.Controller.Net;
2016-10-25 19:02:04 +00:00
using MediaBrowser.Model.Services;
using MediaBrowser.Model.Tasks;
2013-02-21 01:33:05 +00:00
2013-02-22 04:23:06 +00:00
namespace MediaBrowser.Api.ScheduledTasks
2013-02-21 01:33:05 +00:00
{
/// <summary>
/// Class GetScheduledTask
/// </summary>
2014-03-25 21:13:55 +00:00
[Route("/ScheduledTasks/{Id}", "GET", Summary = "Gets a scheduled task, by Id")]
2013-02-21 01:33:05 +00:00
public class GetScheduledTask : IReturn<TaskInfo>
{
/// <summary>
/// Gets or sets the id.
/// </summary>
/// <value>The id.</value>
[ApiMember(Name = "Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
2014-05-09 19:43:06 +00:00
public string Id { get; set; }
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Class GetScheduledTasks
/// </summary>
2014-03-25 21:13:55 +00:00
[Route("/ScheduledTasks", "GET", Summary = "Gets scheduled tasks")]
2017-08-19 19:43:35 +00:00
public class GetScheduledTasks : IReturn<TaskInfo[]>
2013-02-21 01:33:05 +00:00
{
[ApiMember(Name = "IsHidden", Description = "Optional filter tasks that are hidden, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
public bool? IsHidden { get; set; }
2015-01-20 21:32:48 +00:00
[ApiMember(Name = "IsEnabled", Description = "Optional filter tasks that are enabled, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
public bool? IsEnabled { get; set; }
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Class StartScheduledTask
/// </summary>
2014-03-25 21:13:55 +00:00
[Route("/ScheduledTasks/Running/{Id}", "POST", Summary = "Starts a scheduled task")]
2013-02-21 01:33:05 +00:00
public class StartScheduledTask : IReturnVoid
{
/// <summary>
/// Gets or sets the id.
/// </summary>
/// <value>The id.</value>
[ApiMember(Name = "Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
2014-05-09 19:43:06 +00:00
public string Id { get; set; }
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Class StopScheduledTask
/// </summary>
2014-03-25 21:13:55 +00:00
[Route("/ScheduledTasks/Running/{Id}", "DELETE", Summary = "Stops a scheduled task")]
2013-02-21 01:33:05 +00:00
public class StopScheduledTask : IReturnVoid
{
/// <summary>
/// Gets or sets the id.
/// </summary>
/// <value>The id.</value>
[ApiMember(Name = "Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")]
2014-05-09 19:43:06 +00:00
public string Id { get; set; }
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Class UpdateScheduledTaskTriggers
/// </summary>
2014-03-25 21:13:55 +00:00
[Route("/ScheduledTasks/{Id}/Triggers", "POST", Summary = "Updates the triggers for a scheduled task")]
2013-03-05 02:05:59 +00:00
public class UpdateScheduledTaskTriggers : List<TaskTriggerInfo>, IReturnVoid
2013-02-21 01:33:05 +00:00
{
/// <summary>
/// Gets or sets the task id.
/// </summary>
/// <value>The task id.</value>
[ApiMember(Name = "Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
2014-05-09 19:43:06 +00:00
public string Id { get; set; }
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Class ScheduledTasksService
/// </summary>
2014-11-15 02:31:03 +00:00
[Authenticated(Roles = "Admin")]
2013-03-16 05:52:33 +00:00
public class ScheduledTaskService : BaseApiService
2013-02-21 01:33:05 +00:00
{
2013-02-23 07:57:11 +00:00
/// <summary>
/// Gets or sets the task manager.
/// </summary>
/// <value>The task manager.</value>
private ITaskManager TaskManager { get; set; }
2016-02-28 21:31:45 +00:00
private readonly IServerConfigurationManager _config;
2013-02-24 21:53:54 +00:00
/// <summary>
/// Initializes a new instance of the <see cref="ScheduledTaskService" /> class.
/// </summary>
/// <param name="taskManager">The task manager.</param>
2016-02-28 21:31:45 +00:00
/// <exception cref="ArgumentNullException">taskManager</exception>
public ScheduledTaskService(ITaskManager taskManager, IServerConfigurationManager config)
2013-02-23 07:57:11 +00:00
{
2013-02-24 21:53:54 +00:00
if (taskManager == null)
{
throw new ArgumentNullException(nameof(taskManager));
2013-02-24 21:53:54 +00:00
}
2013-02-23 07:57:11 +00:00
TaskManager = taskManager;
2016-02-28 21:31:45 +00:00
_config = config;
2013-02-23 07:57:11 +00:00
}
2013-02-24 21:53:54 +00:00
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets the specified request.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>IEnumerable{TaskInfo}.</returns>
public object Get(GetScheduledTasks request)
{
IEnumerable<IScheduledTaskWorker> result = TaskManager.ScheduledTasks
.OrderBy(i => i.Name);
2013-02-21 01:33:05 +00:00
if (request.IsHidden.HasValue)
{
var val = request.IsHidden.Value;
result = result.Where(i =>
{
var isHidden = false;
var configurableTask = i.ScheduledTask as IConfigurableScheduledTask;
if (configurableTask != null)
{
isHidden = configurableTask.IsHidden;
}
return isHidden == val;
});
}
2015-01-20 21:32:48 +00:00
if (request.IsEnabled.HasValue)
{
var val = request.IsEnabled.Value;
result = result.Where(i =>
{
2015-01-21 03:54:45 +00:00
var isEnabled = true;
2015-01-20 21:32:48 +00:00
var configurableTask = i.ScheduledTask as IConfigurableScheduledTask;
if (configurableTask != null)
{
isEnabled = configurableTask.IsEnabled;
}
return isEnabled == val;
});
}
2019-01-07 23:27:46 +00:00
var infos = result
.Select(ScheduledTaskHelpers.GetTaskInfo)
2017-08-19 19:43:35 +00:00
.ToArray();
return ToOptimizedResult(infos);
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Gets the specified request.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>IEnumerable{TaskInfo}.</returns>
2019-01-13 20:37:13 +00:00
/// <exception cref="ResourceNotFoundException">Task not found</exception>
2013-02-21 01:33:05 +00:00
public object Get(GetScheduledTask request)
{
2014-05-09 19:43:06 +00:00
var task = TaskManager.ScheduledTasks.FirstOrDefault(i => string.Equals(i.Id, request.Id));
2013-02-21 01:33:05 +00:00
if (task == null)
{
throw new ResourceNotFoundException("Task not found");
}
var result = ScheduledTaskHelpers.GetTaskInfo(task);
return ToOptimizedResult(result);
}
/// <summary>
/// Posts the specified request.
/// </summary>
/// <param name="request">The request.</param>
2019-01-13 20:37:13 +00:00
/// <exception cref="ResourceNotFoundException">Task not found</exception>
2013-02-21 01:33:05 +00:00
public void Post(StartScheduledTask request)
{
2014-05-09 19:43:06 +00:00
var task = TaskManager.ScheduledTasks.FirstOrDefault(i => string.Equals(i.Id, request.Id));
2013-02-21 01:33:05 +00:00
if (task == null)
{
throw new ResourceNotFoundException("Task not found");
}
2018-09-12 17:26:21 +00:00
TaskManager.Execute(task, new TaskOptions());
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Posts the specified request.
/// </summary>
/// <param name="request">The request.</param>
2019-01-13 20:37:13 +00:00
/// <exception cref="ResourceNotFoundException">Task not found</exception>
2013-02-21 01:33:05 +00:00
public void Delete(StopScheduledTask request)
{
2014-05-09 19:43:06 +00:00
var task = TaskManager.ScheduledTasks.FirstOrDefault(i => string.Equals(i.Id, request.Id));
2013-02-21 01:33:05 +00:00
if (task == null)
{
throw new ResourceNotFoundException("Task not found");
}
2013-03-07 05:34:00 +00:00
TaskManager.Cancel(task);
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Posts the specified request.
/// </summary>
/// <param name="request">The request.</param>
2019-01-13 20:37:13 +00:00
/// <exception cref="ResourceNotFoundException">Task not found</exception>
2013-02-21 01:33:05 +00:00
public void Post(UpdateScheduledTaskTriggers request)
{
// We need to parse this manually because we told service stack not to with IRequiresRequestStream
// https://code.google.com/p/servicestack/source/browse/trunk/Common/ServiceStack.Text/ServiceStack.Text/Controller/PathInfo.cs
2015-01-22 16:41:34 +00:00
var id = GetPathValue(1);
2013-02-23 07:57:11 +00:00
2019-02-09 14:55:23 +00:00
var task = TaskManager.ScheduledTasks.FirstOrDefault(i => string.Equals(i.Id, id, StringComparison.Ordinal));
2013-02-21 01:33:05 +00:00
if (task == null)
{
throw new ResourceNotFoundException("Task not found");
}
2019-02-09 14:55:23 +00:00
task.Triggers = request.ToArray();
2013-02-21 01:33:05 +00:00
}
}
}