aboutsummaryrefslogtreecommitdiff
path: root/Jellyfin.Api/Controllers/ScheduledTasksController.cs
blob: bb07af3979da198f0322255e2c48b80ad5e7b2cd (plain)
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
#nullable enable

using System;
using System.Collections.Generic;
using System.Linq;
using MediaBrowser.Model.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.ModelBinding;

namespace Jellyfin.Api.Controllers
{
    /// <summary>
    /// Scheduled Tasks Controller.
    /// </summary>
    public class ScheduledTasksController : BaseJellyfinApiController
    {
        private readonly ITaskManager _taskManager;

        /// <summary>
        /// Initializes a new instance of the <see cref="ScheduledTasksController"/> class.
        /// </summary>
        /// <param name="taskManager">Instance of the <see cref="ITaskManager"/> interface.</param>
        public ScheduledTasksController(ITaskManager taskManager)
        {
            _taskManager = taskManager;
        }

        /// <summary>
        /// Get tasks.
        /// </summary>
        /// <param name="isHidden">Optional filter tasks that are hidden, or not.</param>
        /// <param name="isEnabled">Optional filter tasks that are enabled, or not.</param>
        /// <returns>Task list.</returns>
        [HttpGet]
        [ProducesResponseType(typeof(TaskInfo[]), StatusCodes.Status200OK)]
        [ProducesResponseType(typeof(string), StatusCodes.Status500InternalServerError)]
        public IActionResult GetTasks(
            [FromQuery] bool? isHidden = false,
            [FromQuery] bool? isEnabled = false)
        {
            try
            {
                IEnumerable<IScheduledTaskWorker> tasks = _taskManager.ScheduledTasks.OrderBy(o => o.Name);

                if (isHidden.HasValue)
                {
                    var hiddenValue = isHidden.Value;
                    tasks = tasks.Where(o =>
                    {
                        var itemIsHidden = false;
                        if (o.ScheduledTask is IConfigurableScheduledTask configurableScheduledTask)
                        {
                            itemIsHidden = configurableScheduledTask.IsHidden;
                        }

                        return itemIsHidden == hiddenValue;
                    });
                }

                if (isEnabled.HasValue)
                {
                    var enabledValue = isEnabled.Value;
                    tasks = tasks.Where(o =>
                    {
                        var itemIsEnabled = false;
                        if (o.ScheduledTask is IConfigurableScheduledTask configurableScheduledTask)
                        {
                            itemIsEnabled = configurableScheduledTask.IsEnabled;
                        }

                        return itemIsEnabled == enabledValue;
                    });
                }

                var taskInfos = tasks.Select(ScheduledTaskHelpers.GetTaskInfo);

                // TODO ToOptimizedResult
                return Ok(taskInfos);
            }
            catch (Exception e)
            {
                return StatusCode(StatusCodes.Status500InternalServerError, e.Message);
            }
        }

        /// <summary>
        /// Get task by id.
        /// </summary>
        /// <param name="taskId">Task Id.</param>
        /// <returns>Task Info.</returns>
        [HttpGet("{TaskID}")]
        [ProducesResponseType(typeof(TaskInfo), StatusCodes.Status200OK)]
        [ProducesResponseType(StatusCodes.Status404NotFound)]
        [ProducesResponseType(typeof(string), StatusCodes.Status500InternalServerError)]
        public IActionResult GetTask([FromRoute] string taskId)
        {
            try
            {
                var task = _taskManager.ScheduledTasks.FirstOrDefault(i =>
                    string.Equals(i.Id, taskId, StringComparison.OrdinalIgnoreCase));

                if (task == null)
                {
                    return NotFound();
                }

                var result = ScheduledTaskHelpers.GetTaskInfo(task);
                return Ok(result);
            }
            catch (Exception e)
            {
                return StatusCode(StatusCodes.Status500InternalServerError, e.Message);
            }
        }

        /// <summary>
        /// Start specified task.
        /// </summary>
        /// <param name="taskId">Task Id.</param>
        /// <returns>Status.</returns>
        [HttpPost("Running/{TaskID}")]
        [ProducesResponseType(StatusCodes.Status200OK)]
        [ProducesResponseType(StatusCodes.Status404NotFound)]
        [ProducesResponseType(typeof(string), StatusCodes.Status500InternalServerError)]
        public IActionResult StartTask([FromRoute] string taskId)
        {
            try
            {
                var task = _taskManager.ScheduledTasks.FirstOrDefault(o =>
                    o.Id.Equals(taskId, StringComparison.OrdinalIgnoreCase));

                if (task == null)
                {
                    return NotFound();
                }

                _taskManager.Execute(task, new TaskOptions());
                return Ok();
            }
            catch (Exception e)
            {
                return StatusCode(StatusCodes.Status500InternalServerError, e.Message);
            }
        }

        /// <summary>
        /// Stop specified task.
        /// </summary>
        /// <param name="taskId">Task Id.</param>
        /// <returns>Status.</returns>
        [HttpDelete("Running/{TaskID}")]
        [ProducesResponseType(StatusCodes.Status200OK)]
        [ProducesResponseType(StatusCodes.Status404NotFound)]
        [ProducesResponseType(typeof(string), StatusCodes.Status500InternalServerError)]
        public IActionResult StopTask([FromRoute] string taskId)
        {
            try
            {
                var task = _taskManager.ScheduledTasks.FirstOrDefault(o =>
                    o.Id.Equals(taskId, StringComparison.OrdinalIgnoreCase));

                if (task == null)
                {
                    return NotFound();
                }

                _taskManager.Cancel(task);
                return Ok();
            }
            catch (Exception e)
            {
                return StatusCode(StatusCodes.Status500InternalServerError, e.Message);
            }
        }

        /// <summary>
        /// Update specified task triggers.
        /// </summary>
        /// <param name="taskId">Task Id.</param>
        /// <param name="triggerInfos">Triggers.</param>
        /// <returns>Status.</returns>
        [HttpPost("{TaskID}/Triggers")]
        [ProducesResponseType(StatusCodes.Status200OK)]
        [ProducesResponseType(StatusCodes.Status404NotFound)]
        [ProducesResponseType(typeof(string), StatusCodes.Status500InternalServerError)]
        public IActionResult UpdateTask([FromRoute] string taskId, [FromBody] TaskTriggerInfo[] triggerInfos)
        {
            try
            {
                var task = _taskManager.ScheduledTasks.FirstOrDefault(o =>
                    o.Id.Equals(taskId, StringComparison.OrdinalIgnoreCase));
                if (task == null)
                {
                    return NotFound();
                }

                task.Triggers = triggerInfos;
                return Ok();
            }
            catch (Exception e)
            {
                return StatusCode(StatusCodes.Status500InternalServerError, e.Message);
            }
        }
    }
}