LiveTvController.cs 62 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240
  1. using System;
  2. using System.Collections.Generic;
  3. using System.ComponentModel.DataAnnotations;
  4. using System.Diagnostics.CodeAnalysis;
  5. using System.IO;
  6. using System.Linq;
  7. using System.Net.Http;
  8. using System.Net.Mime;
  9. using System.Security.Cryptography;
  10. using System.Text;
  11. using System.Threading;
  12. using System.Threading.Tasks;
  13. using Jellyfin.Api.Constants;
  14. using Jellyfin.Api.Extensions;
  15. using Jellyfin.Api.Helpers;
  16. using Jellyfin.Api.Models.LiveTvDtos;
  17. using Jellyfin.Data.Enums;
  18. using MediaBrowser.Common;
  19. using MediaBrowser.Common.Configuration;
  20. using MediaBrowser.Common.Net;
  21. using MediaBrowser.Controller.Dto;
  22. using MediaBrowser.Controller.Entities;
  23. using MediaBrowser.Controller.Entities.TV;
  24. using MediaBrowser.Controller.Library;
  25. using MediaBrowser.Controller.LiveTv;
  26. using MediaBrowser.Controller.Net;
  27. using MediaBrowser.Model.Dto;
  28. using MediaBrowser.Model.LiveTv;
  29. using MediaBrowser.Model.Net;
  30. using MediaBrowser.Model.Querying;
  31. using Microsoft.AspNetCore.Authorization;
  32. using Microsoft.AspNetCore.Http;
  33. using Microsoft.AspNetCore.Mvc;
  34. namespace Jellyfin.Api.Controllers
  35. {
  36. /// <summary>
  37. /// Live tv controller.
  38. /// </summary>
  39. public class LiveTvController : BaseJellyfinApiController
  40. {
  41. private readonly ILiveTvManager _liveTvManager;
  42. private readonly IUserManager _userManager;
  43. private readonly IHttpClientFactory _httpClientFactory;
  44. private readonly ILibraryManager _libraryManager;
  45. private readonly IDtoService _dtoService;
  46. private readonly ISessionContext _sessionContext;
  47. private readonly IMediaSourceManager _mediaSourceManager;
  48. private readonly IConfigurationManager _configurationManager;
  49. private readonly TranscodingJobHelper _transcodingJobHelper;
  50. /// <summary>
  51. /// Initializes a new instance of the <see cref="LiveTvController"/> class.
  52. /// </summary>
  53. /// <param name="liveTvManager">Instance of the <see cref="ILiveTvManager"/> interface.</param>
  54. /// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param>
  55. /// <param name="httpClientFactory">Instance of the <see cref="IHttpClientFactory"/> interface.</param>
  56. /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param>
  57. /// <param name="dtoService">Instance of the <see cref="IDtoService"/> interface.</param>
  58. /// <param name="sessionContext">Instance of the <see cref="ISessionContext"/> interface.</param>
  59. /// <param name="mediaSourceManager">Instance of the <see cref="IMediaSourceManager"/> interface.</param>
  60. /// <param name="configurationManager">Instance of the <see cref="IConfigurationManager"/> interface.</param>
  61. /// <param name="transcodingJobHelper">Instance of the <see cref="TranscodingJobHelper"/> class.</param>
  62. public LiveTvController(
  63. ILiveTvManager liveTvManager,
  64. IUserManager userManager,
  65. IHttpClientFactory httpClientFactory,
  66. ILibraryManager libraryManager,
  67. IDtoService dtoService,
  68. ISessionContext sessionContext,
  69. IMediaSourceManager mediaSourceManager,
  70. IConfigurationManager configurationManager,
  71. TranscodingJobHelper transcodingJobHelper)
  72. {
  73. _liveTvManager = liveTvManager;
  74. _userManager = userManager;
  75. _httpClientFactory = httpClientFactory;
  76. _libraryManager = libraryManager;
  77. _dtoService = dtoService;
  78. _sessionContext = sessionContext;
  79. _mediaSourceManager = mediaSourceManager;
  80. _configurationManager = configurationManager;
  81. _transcodingJobHelper = transcodingJobHelper;
  82. }
  83. /// <summary>
  84. /// Gets available live tv services.
  85. /// </summary>
  86. /// <response code="200">Available live tv services returned.</response>
  87. /// <returns>
  88. /// An <see cref="OkResult"/> containing the available live tv services.
  89. /// </returns>
  90. [HttpGet("Info")]
  91. [ProducesResponseType(StatusCodes.Status200OK)]
  92. [Authorize(Policy = Policies.DefaultAuthorization)]
  93. public ActionResult<LiveTvInfo> GetLiveTvInfo()
  94. {
  95. return _liveTvManager.GetLiveTvInfo(CancellationToken.None);
  96. }
  97. /// <summary>
  98. /// Gets available live tv channels.
  99. /// </summary>
  100. /// <param name="type">Optional. Filter by channel type.</param>
  101. /// <param name="userId">Optional. Filter by user and attach user data.</param>
  102. /// <param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
  103. /// <param name="isMovie">Optional. Filter for movies.</param>
  104. /// <param name="isSeries">Optional. Filter for series.</param>
  105. /// <param name="isNews">Optional. Filter for news.</param>
  106. /// <param name="isKids">Optional. Filter for kids.</param>
  107. /// <param name="isSports">Optional. Filter for sports.</param>
  108. /// <param name="limit">Optional. The maximum number of records to return.</param>
  109. /// <param name="isFavorite">Optional. Filter by channels that are favorites, or not.</param>
  110. /// <param name="isLiked">Optional. Filter by channels that are liked, or not.</param>
  111. /// <param name="isDisliked">Optional. Filter by channels that are disliked, or not.</param>
  112. /// <param name="enableImages">Optional. Include image information in output.</param>
  113. /// <param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
  114. /// <param name="enableImageTypes">"Optional. The image types to include in the output.</param>
  115. /// <param name="fields">Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.</param>
  116. /// <param name="enableUserData">Optional. Include user data.</param>
  117. /// <param name="sortBy">Optional. Key to sort by.</param>
  118. /// <param name="sortOrder">Optional. Sort order.</param>
  119. /// <param name="enableFavoriteSorting">Optional. Incorporate favorite and like status into channel sorting.</param>
  120. /// <param name="addCurrentProgram">Optional. Adds current program info to each channel.</param>
  121. /// <response code="200">Available live tv channels returned.</response>
  122. /// <returns>
  123. /// An <see cref="OkResult"/> containing the resulting available live tv channels.
  124. /// </returns>
  125. [HttpGet("Channels")]
  126. [ProducesResponseType(StatusCodes.Status200OK)]
  127. [Authorize(Policy = Policies.DefaultAuthorization)]
  128. public ActionResult<QueryResult<BaseItemDto>> GetLiveTvChannels(
  129. [FromQuery] ChannelType? type,
  130. [FromQuery] Guid? userId,
  131. [FromQuery] int? startIndex,
  132. [FromQuery] bool? isMovie,
  133. [FromQuery] bool? isSeries,
  134. [FromQuery] bool? isNews,
  135. [FromQuery] bool? isKids,
  136. [FromQuery] bool? isSports,
  137. [FromQuery] int? limit,
  138. [FromQuery] bool? isFavorite,
  139. [FromQuery] bool? isLiked,
  140. [FromQuery] bool? isDisliked,
  141. [FromQuery] bool? enableImages,
  142. [FromQuery] int? imageTypeLimit,
  143. [FromQuery] string? enableImageTypes,
  144. [FromQuery] string? fields,
  145. [FromQuery] bool? enableUserData,
  146. [FromQuery] string? sortBy,
  147. [FromQuery] SortOrder? sortOrder,
  148. [FromQuery] bool enableFavoriteSorting = false,
  149. [FromQuery] bool addCurrentProgram = true)
  150. {
  151. var dtoOptions = new DtoOptions()
  152. .AddItemFields(fields)
  153. .AddClientFields(Request)
  154. .AddAdditionalDtoOptions(enableImages, enableUserData, imageTypeLimit, enableImageTypes);
  155. var channelResult = _liveTvManager.GetInternalChannels(
  156. new LiveTvChannelQuery
  157. {
  158. ChannelType = type,
  159. UserId = userId ?? Guid.Empty,
  160. StartIndex = startIndex,
  161. Limit = limit,
  162. IsFavorite = isFavorite,
  163. IsLiked = isLiked,
  164. IsDisliked = isDisliked,
  165. EnableFavoriteSorting = enableFavoriteSorting,
  166. IsMovie = isMovie,
  167. IsSeries = isSeries,
  168. IsNews = isNews,
  169. IsKids = isKids,
  170. IsSports = isSports,
  171. SortBy = RequestHelpers.Split(sortBy, ',', true),
  172. SortOrder = sortOrder ?? SortOrder.Ascending,
  173. AddCurrentProgram = addCurrentProgram
  174. },
  175. dtoOptions,
  176. CancellationToken.None);
  177. var user = userId.HasValue && !userId.Equals(Guid.Empty)
  178. ? _userManager.GetUserById(userId.Value)
  179. : null;
  180. var fieldsList = dtoOptions.Fields.ToList();
  181. fieldsList.Remove(ItemFields.CanDelete);
  182. fieldsList.Remove(ItemFields.CanDownload);
  183. fieldsList.Remove(ItemFields.DisplayPreferencesId);
  184. fieldsList.Remove(ItemFields.Etag);
  185. dtoOptions.Fields = fieldsList.ToArray();
  186. dtoOptions.AddCurrentProgram = addCurrentProgram;
  187. var returnArray = _dtoService.GetBaseItemDtos(channelResult.Items, dtoOptions, user);
  188. return new QueryResult<BaseItemDto>
  189. {
  190. Items = returnArray,
  191. TotalRecordCount = channelResult.TotalRecordCount
  192. };
  193. }
  194. /// <summary>
  195. /// Gets a live tv channel.
  196. /// </summary>
  197. /// <param name="channelId">Channel id.</param>
  198. /// <param name="userId">Optional. Attach user data.</param>
  199. /// <response code="200">Live tv channel returned.</response>
  200. /// <returns>An <see cref="OkResult"/> containing the live tv channel.</returns>
  201. [HttpGet("Channels/{channelId}")]
  202. [ProducesResponseType(StatusCodes.Status200OK)]
  203. [Authorize(Policy = Policies.DefaultAuthorization)]
  204. public ActionResult<BaseItemDto> GetChannel([FromRoute, Required] Guid channelId, [FromQuery] Guid? userId)
  205. {
  206. var user = userId.HasValue && !userId.Equals(Guid.Empty)
  207. ? _userManager.GetUserById(userId.Value)
  208. : null;
  209. var item = channelId.Equals(Guid.Empty)
  210. ? _libraryManager.GetUserRootFolder()
  211. : _libraryManager.GetItemById(channelId);
  212. var dtoOptions = new DtoOptions()
  213. .AddClientFields(Request);
  214. return _dtoService.GetBaseItemDto(item, dtoOptions, user);
  215. }
  216. /// <summary>
  217. /// Gets live tv recordings.
  218. /// </summary>
  219. /// <param name="channelId">Optional. Filter by channel id.</param>
  220. /// <param name="userId">Optional. Filter by user and attach user data.</param>
  221. /// <param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
  222. /// <param name="limit">Optional. The maximum number of records to return.</param>
  223. /// <param name="status">Optional. Filter by recording status.</param>
  224. /// <param name="isInProgress">Optional. Filter by recordings that are in progress, or not.</param>
  225. /// <param name="seriesTimerId">Optional. Filter by recordings belonging to a series timer.</param>
  226. /// <param name="enableImages">Optional. Include image information in output.</param>
  227. /// <param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
  228. /// <param name="enableImageTypes">Optional. The image types to include in the output.</param>
  229. /// <param name="fields">Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.</param>
  230. /// <param name="enableUserData">Optional. Include user data.</param>
  231. /// <param name="isMovie">Optional. Filter for movies.</param>
  232. /// <param name="isSeries">Optional. Filter for series.</param>
  233. /// <param name="isKids">Optional. Filter for kids.</param>
  234. /// <param name="isSports">Optional. Filter for sports.</param>
  235. /// <param name="isNews">Optional. Filter for news.</param>
  236. /// <param name="isLibraryItem">Optional. Filter for is library item.</param>
  237. /// <param name="enableTotalRecordCount">Optional. Return total record count.</param>
  238. /// <response code="200">Live tv recordings returned.</response>
  239. /// <returns>An <see cref="OkResult"/> containing the live tv recordings.</returns>
  240. [HttpGet("Recordings")]
  241. [ProducesResponseType(StatusCodes.Status200OK)]
  242. [Authorize(Policy = Policies.DefaultAuthorization)]
  243. public ActionResult<QueryResult<BaseItemDto>> GetRecordings(
  244. [FromQuery] string? channelId,
  245. [FromQuery] Guid? userId,
  246. [FromQuery] int? startIndex,
  247. [FromQuery] int? limit,
  248. [FromQuery] RecordingStatus? status,
  249. [FromQuery] bool? isInProgress,
  250. [FromQuery] string? seriesTimerId,
  251. [FromQuery] bool? enableImages,
  252. [FromQuery] int? imageTypeLimit,
  253. [FromQuery] string? enableImageTypes,
  254. [FromQuery] string? fields,
  255. [FromQuery] bool? enableUserData,
  256. [FromQuery] bool? isMovie,
  257. [FromQuery] bool? isSeries,
  258. [FromQuery] bool? isKids,
  259. [FromQuery] bool? isSports,
  260. [FromQuery] bool? isNews,
  261. [FromQuery] bool? isLibraryItem,
  262. [FromQuery] bool enableTotalRecordCount = true)
  263. {
  264. var dtoOptions = new DtoOptions()
  265. .AddItemFields(fields)
  266. .AddClientFields(Request)
  267. .AddAdditionalDtoOptions(enableImages, enableUserData, imageTypeLimit, enableImageTypes);
  268. return _liveTvManager.GetRecordings(
  269. new RecordingQuery
  270. {
  271. ChannelId = channelId,
  272. UserId = userId ?? Guid.Empty,
  273. StartIndex = startIndex,
  274. Limit = limit,
  275. Status = status,
  276. SeriesTimerId = seriesTimerId,
  277. IsInProgress = isInProgress,
  278. EnableTotalRecordCount = enableTotalRecordCount,
  279. IsMovie = isMovie,
  280. IsNews = isNews,
  281. IsSeries = isSeries,
  282. IsKids = isKids,
  283. IsSports = isSports,
  284. IsLibraryItem = isLibraryItem,
  285. Fields = RequestHelpers.GetItemFields(fields),
  286. ImageTypeLimit = imageTypeLimit,
  287. EnableImages = enableImages
  288. }, dtoOptions);
  289. }
  290. /// <summary>
  291. /// Gets live tv recording series.
  292. /// </summary>
  293. /// <param name="channelId">Optional. Filter by channel id.</param>
  294. /// <param name="userId">Optional. Filter by user and attach user data.</param>
  295. /// <param name="groupId">Optional. Filter by recording group.</param>
  296. /// <param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
  297. /// <param name="limit">Optional. The maximum number of records to return.</param>
  298. /// <param name="status">Optional. Filter by recording status.</param>
  299. /// <param name="isInProgress">Optional. Filter by recordings that are in progress, or not.</param>
  300. /// <param name="seriesTimerId">Optional. Filter by recordings belonging to a series timer.</param>
  301. /// <param name="enableImages">Optional. Include image information in output.</param>
  302. /// <param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
  303. /// <param name="enableImageTypes">Optional. The image types to include in the output.</param>
  304. /// <param name="fields">Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.</param>
  305. /// <param name="enableUserData">Optional. Include user data.</param>
  306. /// <param name="enableTotalRecordCount">Optional. Return total record count.</param>
  307. /// <response code="200">Live tv recordings returned.</response>
  308. /// <returns>An <see cref="OkResult"/> containing the live tv recordings.</returns>
  309. [HttpGet("Recordings/Series")]
  310. [ProducesResponseType(StatusCodes.Status200OK)]
  311. [Authorize(Policy = Policies.DefaultAuthorization)]
  312. [Obsolete("This endpoint is obsolete.")]
  313. [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "channelId", Justification = "Imported from ServiceStack")]
  314. [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "userId", Justification = "Imported from ServiceStack")]
  315. [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "groupId", Justification = "Imported from ServiceStack")]
  316. [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "startIndex", Justification = "Imported from ServiceStack")]
  317. [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "limit", Justification = "Imported from ServiceStack")]
  318. [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "status", Justification = "Imported from ServiceStack")]
  319. [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "isInProgress", Justification = "Imported from ServiceStack")]
  320. [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "seriesTimerId", Justification = "Imported from ServiceStack")]
  321. [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "enableImages", Justification = "Imported from ServiceStack")]
  322. [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "imageTypeLimit", Justification = "Imported from ServiceStack")]
  323. [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "enableImageTypes", Justification = "Imported from ServiceStack")]
  324. [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "fields", Justification = "Imported from ServiceStack")]
  325. [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "enableUserData", Justification = "Imported from ServiceStack")]
  326. [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "enableTotalRecordCount", Justification = "Imported from ServiceStack")]
  327. public ActionResult<QueryResult<BaseItemDto>> GetRecordingsSeries(
  328. [FromQuery] string? channelId,
  329. [FromQuery] Guid? userId,
  330. [FromQuery] string? groupId,
  331. [FromQuery] int? startIndex,
  332. [FromQuery] int? limit,
  333. [FromQuery] RecordingStatus? status,
  334. [FromQuery] bool? isInProgress,
  335. [FromQuery] string? seriesTimerId,
  336. [FromQuery] bool? enableImages,
  337. [FromQuery] int? imageTypeLimit,
  338. [FromQuery] string? enableImageTypes,
  339. [FromQuery] string? fields,
  340. [FromQuery] bool? enableUserData,
  341. [FromQuery] bool enableTotalRecordCount = true)
  342. {
  343. return new QueryResult<BaseItemDto>();
  344. }
  345. /// <summary>
  346. /// Gets live tv recording groups.
  347. /// </summary>
  348. /// <param name="userId">Optional. Filter by user and attach user data.</param>
  349. /// <response code="200">Recording groups returned.</response>
  350. /// <returns>An <see cref="OkResult"/> containing the recording groups.</returns>
  351. [HttpGet("Recordings/Groups")]
  352. [ProducesResponseType(StatusCodes.Status200OK)]
  353. [Authorize(Policy = Policies.DefaultAuthorization)]
  354. [Obsolete("This endpoint is obsolete.")]
  355. [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "userId", Justification = "Imported from ServiceStack")]
  356. public ActionResult<QueryResult<BaseItemDto>> GetRecordingGroups([FromQuery] Guid? userId)
  357. {
  358. return new QueryResult<BaseItemDto>();
  359. }
  360. /// <summary>
  361. /// Gets recording folders.
  362. /// </summary>
  363. /// <param name="userId">Optional. Filter by user and attach user data.</param>
  364. /// <response code="200">Recording folders returned.</response>
  365. /// <returns>An <see cref="OkResult"/> containing the recording folders.</returns>
  366. [HttpGet("Recordings/Folders")]
  367. [ProducesResponseType(StatusCodes.Status200OK)]
  368. [Authorize(Policy = Policies.DefaultAuthorization)]
  369. public ActionResult<QueryResult<BaseItemDto>> GetRecordingFolders([FromQuery] Guid? userId)
  370. {
  371. var user = userId.HasValue && !userId.Equals(Guid.Empty)
  372. ? _userManager.GetUserById(userId.Value)
  373. : null;
  374. var folders = _liveTvManager.GetRecordingFolders(user);
  375. var returnArray = _dtoService.GetBaseItemDtos(folders, new DtoOptions(), user);
  376. return new QueryResult<BaseItemDto>
  377. {
  378. Items = returnArray,
  379. TotalRecordCount = returnArray.Count
  380. };
  381. }
  382. /// <summary>
  383. /// Gets a live tv recording.
  384. /// </summary>
  385. /// <param name="recordingId">Recording id.</param>
  386. /// <param name="userId">Optional. Attach user data.</param>
  387. /// <response code="200">Recording returned.</response>
  388. /// <returns>An <see cref="OkResult"/> containing the live tv recording.</returns>
  389. [HttpGet("Recordings/{recordingId}")]
  390. [ProducesResponseType(StatusCodes.Status200OK)]
  391. [Authorize(Policy = Policies.DefaultAuthorization)]
  392. public ActionResult<BaseItemDto> GetRecording([FromRoute, Required] Guid recordingId, [FromQuery] Guid? userId)
  393. {
  394. var user = userId.HasValue && !userId.Equals(Guid.Empty)
  395. ? _userManager.GetUserById(userId.Value)
  396. : null;
  397. var item = recordingId.Equals(Guid.Empty) ? _libraryManager.GetUserRootFolder() : _libraryManager.GetItemById(recordingId);
  398. var dtoOptions = new DtoOptions()
  399. .AddClientFields(Request);
  400. return _dtoService.GetBaseItemDto(item, dtoOptions, user);
  401. }
  402. /// <summary>
  403. /// Resets a tv tuner.
  404. /// </summary>
  405. /// <param name="tunerId">Tuner id.</param>
  406. /// <response code="204">Tuner reset.</response>
  407. /// <returns>A <see cref="NoContentResult"/>.</returns>
  408. [HttpPost("Tuners/{tunerId}/Reset")]
  409. [ProducesResponseType(StatusCodes.Status204NoContent)]
  410. [Authorize(Policy = Policies.DefaultAuthorization)]
  411. public ActionResult ResetTuner([FromRoute, Required] string tunerId)
  412. {
  413. AssertUserCanManageLiveTv();
  414. _liveTvManager.ResetTuner(tunerId, CancellationToken.None);
  415. return NoContent();
  416. }
  417. /// <summary>
  418. /// Gets a timer.
  419. /// </summary>
  420. /// <param name="timerId">Timer id.</param>
  421. /// <response code="200">Timer returned.</response>
  422. /// <returns>
  423. /// A <see cref="Task"/> containing an <see cref="OkResult"/> which contains the timer.
  424. /// </returns>
  425. [HttpGet("Timers/{timerId}")]
  426. [ProducesResponseType(StatusCodes.Status200OK)]
  427. [Authorize(Policy = Policies.DefaultAuthorization)]
  428. public async Task<ActionResult<TimerInfoDto>> GetTimer([FromRoute, Required] string timerId)
  429. {
  430. return await _liveTvManager.GetTimer(timerId, CancellationToken.None).ConfigureAwait(false);
  431. }
  432. /// <summary>
  433. /// Gets the default values for a new timer.
  434. /// </summary>
  435. /// <param name="programId">Optional. To attach default values based on a program.</param>
  436. /// <response code="200">Default values returned.</response>
  437. /// <returns>
  438. /// A <see cref="Task"/> containing an <see cref="OkResult"/> which contains the default values for a timer.
  439. /// </returns>
  440. [HttpGet("Timers/Defaults")]
  441. [ProducesResponseType(StatusCodes.Status200OK)]
  442. [Authorize(Policy = Policies.DefaultAuthorization)]
  443. public async Task<ActionResult<SeriesTimerInfoDto>> GetDefaultTimer([FromQuery] string? programId)
  444. {
  445. return string.IsNullOrEmpty(programId)
  446. ? await _liveTvManager.GetNewTimerDefaults(CancellationToken.None).ConfigureAwait(false)
  447. : await _liveTvManager.GetNewTimerDefaults(programId, CancellationToken.None).ConfigureAwait(false);
  448. }
  449. /// <summary>
  450. /// Gets the live tv timers.
  451. /// </summary>
  452. /// <param name="channelId">Optional. Filter by channel id.</param>
  453. /// <param name="seriesTimerId">Optional. Filter by timers belonging to a series timer.</param>
  454. /// <param name="isActive">Optional. Filter by timers that are active.</param>
  455. /// <param name="isScheduled">Optional. Filter by timers that are scheduled.</param>
  456. /// <returns>
  457. /// A <see cref="Task"/> containing an <see cref="OkResult"/> which contains the live tv timers.
  458. /// </returns>
  459. [HttpGet("Timers")]
  460. [ProducesResponseType(StatusCodes.Status200OK)]
  461. [Authorize(Policy = Policies.DefaultAuthorization)]
  462. public async Task<ActionResult<QueryResult<TimerInfoDto>>> GetTimers(
  463. [FromQuery] string? channelId,
  464. [FromQuery] string? seriesTimerId,
  465. [FromQuery] bool? isActive,
  466. [FromQuery] bool? isScheduled)
  467. {
  468. return await _liveTvManager.GetTimers(
  469. new TimerQuery
  470. {
  471. ChannelId = channelId,
  472. SeriesTimerId = seriesTimerId,
  473. IsActive = isActive,
  474. IsScheduled = isScheduled
  475. }, CancellationToken.None)
  476. .ConfigureAwait(false);
  477. }
  478. /// <summary>
  479. /// Gets available live tv epgs.
  480. /// </summary>
  481. /// <param name="channelIds">The channels to return guide information for.</param>
  482. /// <param name="userId">Optional. Filter by user id.</param>
  483. /// <param name="minStartDate">Optional. The minimum premiere start date.</param>
  484. /// <param name="hasAired">Optional. Filter by programs that have completed airing, or not.</param>
  485. /// <param name="isAiring">Optional. Filter by programs that are currently airing, or not.</param>
  486. /// <param name="maxStartDate">Optional. The maximum premiere start date.</param>
  487. /// <param name="minEndDate">Optional. The minimum premiere end date.</param>
  488. /// <param name="maxEndDate">Optional. The maximum premiere end date.</param>
  489. /// <param name="isMovie">Optional. Filter for movies.</param>
  490. /// <param name="isSeries">Optional. Filter for series.</param>
  491. /// <param name="isNews">Optional. Filter for news.</param>
  492. /// <param name="isKids">Optional. Filter for kids.</param>
  493. /// <param name="isSports">Optional. Filter for sports.</param>
  494. /// <param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
  495. /// <param name="limit">Optional. The maximum number of records to return.</param>
  496. /// <param name="sortBy">Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate.</param>
  497. /// <param name="sortOrder">Sort Order - Ascending,Descending.</param>
  498. /// <param name="genres">The genres to return guide information for.</param>
  499. /// <param name="genreIds">The genre ids to return guide information for.</param>
  500. /// <param name="enableImages">Optional. Include image information in output.</param>
  501. /// <param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
  502. /// <param name="enableImageTypes">Optional. The image types to include in the output.</param>
  503. /// <param name="enableUserData">Optional. Include user data.</param>
  504. /// <param name="seriesTimerId">Optional. Filter by series timer id.</param>
  505. /// <param name="librarySeriesId">Optional. Filter by library series id.</param>
  506. /// <param name="fields">Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.</param>
  507. /// <param name="enableTotalRecordCount">Retrieve total record count.</param>
  508. /// <response code="200">Live tv epgs returned.</response>
  509. /// <returns>
  510. /// A <see cref="Task"/> containing a <see cref="OkResult"/> which contains the live tv epgs.
  511. /// </returns>
  512. [HttpGet("Programs")]
  513. [ProducesResponseType(StatusCodes.Status200OK)]
  514. [Authorize(Policy = Policies.DefaultAuthorization)]
  515. public async Task<ActionResult<QueryResult<BaseItemDto>>> GetLiveTvPrograms(
  516. [FromQuery] string? channelIds,
  517. [FromQuery] Guid? userId,
  518. [FromQuery] DateTime? minStartDate,
  519. [FromQuery] bool? hasAired,
  520. [FromQuery] bool? isAiring,
  521. [FromQuery] DateTime? maxStartDate,
  522. [FromQuery] DateTime? minEndDate,
  523. [FromQuery] DateTime? maxEndDate,
  524. [FromQuery] bool? isMovie,
  525. [FromQuery] bool? isSeries,
  526. [FromQuery] bool? isNews,
  527. [FromQuery] bool? isKids,
  528. [FromQuery] bool? isSports,
  529. [FromQuery] int? startIndex,
  530. [FromQuery] int? limit,
  531. [FromQuery] string? sortBy,
  532. [FromQuery] string? sortOrder,
  533. [FromQuery] string? genres,
  534. [FromQuery] string? genreIds,
  535. [FromQuery] bool? enableImages,
  536. [FromQuery] int? imageTypeLimit,
  537. [FromQuery] string? enableImageTypes,
  538. [FromQuery] bool? enableUserData,
  539. [FromQuery] string? seriesTimerId,
  540. [FromQuery] Guid? librarySeriesId,
  541. [FromQuery] string? fields,
  542. [FromQuery] bool enableTotalRecordCount = true)
  543. {
  544. var user = userId.HasValue && !userId.Equals(Guid.Empty)
  545. ? _userManager.GetUserById(userId.Value)
  546. : null;
  547. var query = new InternalItemsQuery(user)
  548. {
  549. ChannelIds = RequestHelpers.Split(channelIds, ',', true)
  550. .Select(i => new Guid(i)).ToArray(),
  551. HasAired = hasAired,
  552. IsAiring = isAiring,
  553. EnableTotalRecordCount = enableTotalRecordCount,
  554. MinStartDate = minStartDate,
  555. MinEndDate = minEndDate,
  556. MaxStartDate = maxStartDate,
  557. MaxEndDate = maxEndDate,
  558. StartIndex = startIndex,
  559. Limit = limit,
  560. OrderBy = RequestHelpers.GetOrderBy(sortBy, sortOrder),
  561. IsNews = isNews,
  562. IsMovie = isMovie,
  563. IsSeries = isSeries,
  564. IsKids = isKids,
  565. IsSports = isSports,
  566. SeriesTimerId = seriesTimerId,
  567. Genres = RequestHelpers.Split(genres, ',', true),
  568. GenreIds = RequestHelpers.GetGuids(genreIds)
  569. };
  570. if (librarySeriesId != null && !librarySeriesId.Equals(Guid.Empty))
  571. {
  572. query.IsSeries = true;
  573. if (_libraryManager.GetItemById(librarySeriesId.Value) is Series series)
  574. {
  575. query.Name = series.Name;
  576. }
  577. }
  578. var dtoOptions = new DtoOptions()
  579. .AddItemFields(fields)
  580. .AddClientFields(Request)
  581. .AddAdditionalDtoOptions(enableImages, enableUserData, imageTypeLimit, enableImageTypes);
  582. return await _liveTvManager.GetPrograms(query, dtoOptions, CancellationToken.None).ConfigureAwait(false);
  583. }
  584. /// <summary>
  585. /// Gets available live tv epgs.
  586. /// </summary>
  587. /// <param name="body">Request body.</param>
  588. /// <response code="200">Live tv epgs returned.</response>
  589. /// <returns>
  590. /// A <see cref="Task"/> containing a <see cref="OkResult"/> which contains the live tv epgs.
  591. /// </returns>
  592. [HttpPost("Programs")]
  593. [ProducesResponseType(StatusCodes.Status200OK)]
  594. [Authorize(Policy = Policies.DefaultAuthorization)]
  595. public async Task<ActionResult<QueryResult<BaseItemDto>>> GetPrograms([FromBody] GetProgramsDto body)
  596. {
  597. var user = body.UserId.Equals(Guid.Empty) ? null : _userManager.GetUserById(body.UserId);
  598. var query = new InternalItemsQuery(user)
  599. {
  600. ChannelIds = RequestHelpers.Split(body.ChannelIds, ',', true)
  601. .Select(i => new Guid(i)).ToArray(),
  602. HasAired = body.HasAired,
  603. IsAiring = body.IsAiring,
  604. EnableTotalRecordCount = body.EnableTotalRecordCount,
  605. MinStartDate = body.MinStartDate,
  606. MinEndDate = body.MinEndDate,
  607. MaxStartDate = body.MaxStartDate,
  608. MaxEndDate = body.MaxEndDate,
  609. StartIndex = body.StartIndex,
  610. Limit = body.Limit,
  611. OrderBy = RequestHelpers.GetOrderBy(body.SortBy, body.SortOrder),
  612. IsNews = body.IsNews,
  613. IsMovie = body.IsMovie,
  614. IsSeries = body.IsSeries,
  615. IsKids = body.IsKids,
  616. IsSports = body.IsSports,
  617. SeriesTimerId = body.SeriesTimerId,
  618. Genres = RequestHelpers.Split(body.Genres, ',', true),
  619. GenreIds = RequestHelpers.GetGuids(body.GenreIds)
  620. };
  621. if (!body.LibrarySeriesId.Equals(Guid.Empty))
  622. {
  623. query.IsSeries = true;
  624. if (_libraryManager.GetItemById(body.LibrarySeriesId) is Series series)
  625. {
  626. query.Name = series.Name;
  627. }
  628. }
  629. var dtoOptions = new DtoOptions()
  630. .AddItemFields(body.Fields)
  631. .AddClientFields(Request)
  632. .AddAdditionalDtoOptions(body.EnableImages, body.EnableUserData, body.ImageTypeLimit, body.EnableImageTypes);
  633. return await _liveTvManager.GetPrograms(query, dtoOptions, CancellationToken.None).ConfigureAwait(false);
  634. }
  635. /// <summary>
  636. /// Gets recommended live tv epgs.
  637. /// </summary>
  638. /// <param name="userId">Optional. filter by user id.</param>
  639. /// <param name="limit">Optional. The maximum number of records to return.</param>
  640. /// <param name="isAiring">Optional. Filter by programs that are currently airing, or not.</param>
  641. /// <param name="hasAired">Optional. Filter by programs that have completed airing, or not.</param>
  642. /// <param name="isSeries">Optional. Filter for series.</param>
  643. /// <param name="isMovie">Optional. Filter for movies.</param>
  644. /// <param name="isNews">Optional. Filter for news.</param>
  645. /// <param name="isKids">Optional. Filter for kids.</param>
  646. /// <param name="isSports">Optional. Filter for sports.</param>
  647. /// <param name="enableImages">Optional. Include image information in output.</param>
  648. /// <param name="imageTypeLimit">Optional. The max number of images to return, per image type.</param>
  649. /// <param name="enableImageTypes">Optional. The image types to include in the output.</param>
  650. /// <param name="genreIds">The genres to return guide information for.</param>
  651. /// <param name="fields">Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.</param>
  652. /// <param name="enableUserData">Optional. include user data.</param>
  653. /// <param name="enableTotalRecordCount">Retrieve total record count.</param>
  654. /// <response code="200">Recommended epgs returned.</response>
  655. /// <returns>A <see cref="OkResult"/> containing the queryresult of recommended epgs.</returns>
  656. [HttpGet("Programs/Recommended")]
  657. [Authorize(Policy = Policies.DefaultAuthorization)]
  658. [ProducesResponseType(StatusCodes.Status200OK)]
  659. public ActionResult<QueryResult<BaseItemDto>> GetRecommendedPrograms(
  660. [FromQuery] Guid? userId,
  661. [FromQuery] int? limit,
  662. [FromQuery] bool? isAiring,
  663. [FromQuery] bool? hasAired,
  664. [FromQuery] bool? isSeries,
  665. [FromQuery] bool? isMovie,
  666. [FromQuery] bool? isNews,
  667. [FromQuery] bool? isKids,
  668. [FromQuery] bool? isSports,
  669. [FromQuery] bool? enableImages,
  670. [FromQuery] int? imageTypeLimit,
  671. [FromQuery] string? enableImageTypes,
  672. [FromQuery] string? genreIds,
  673. [FromQuery] string? fields,
  674. [FromQuery] bool? enableUserData,
  675. [FromQuery] bool enableTotalRecordCount = true)
  676. {
  677. var user = userId.HasValue && !userId.Equals(Guid.Empty)
  678. ? _userManager.GetUserById(userId.Value)
  679. : null;
  680. var query = new InternalItemsQuery(user)
  681. {
  682. IsAiring = isAiring,
  683. Limit = limit,
  684. HasAired = hasAired,
  685. IsSeries = isSeries,
  686. IsMovie = isMovie,
  687. IsKids = isKids,
  688. IsNews = isNews,
  689. IsSports = isSports,
  690. EnableTotalRecordCount = enableTotalRecordCount,
  691. GenreIds = RequestHelpers.GetGuids(genreIds)
  692. };
  693. var dtoOptions = new DtoOptions()
  694. .AddItemFields(fields)
  695. .AddClientFields(Request)
  696. .AddAdditionalDtoOptions(enableImages, enableUserData, imageTypeLimit, enableImageTypes);
  697. return _liveTvManager.GetRecommendedPrograms(query, dtoOptions, CancellationToken.None);
  698. }
  699. /// <summary>
  700. /// Gets a live tv program.
  701. /// </summary>
  702. /// <param name="programId">Program id.</param>
  703. /// <param name="userId">Optional. Attach user data.</param>
  704. /// <response code="200">Program returned.</response>
  705. /// <returns>An <see cref="OkResult"/> containing the livetv program.</returns>
  706. [HttpGet("Programs/{programId}")]
  707. [Authorize(Policy = Policies.DefaultAuthorization)]
  708. [ProducesResponseType(StatusCodes.Status200OK)]
  709. public async Task<ActionResult<BaseItemDto>> GetProgram(
  710. [FromRoute, Required] string programId,
  711. [FromQuery] Guid? userId)
  712. {
  713. var user = userId.HasValue && !userId.Equals(Guid.Empty)
  714. ? _userManager.GetUserById(userId.Value)
  715. : null;
  716. return await _liveTvManager.GetProgram(programId, CancellationToken.None, user).ConfigureAwait(false);
  717. }
  718. /// <summary>
  719. /// Deletes a live tv recording.
  720. /// </summary>
  721. /// <param name="recordingId">Recording id.</param>
  722. /// <response code="204">Recording deleted.</response>
  723. /// <response code="404">Item not found.</response>
  724. /// <returns>A <see cref="NoContentResult"/> on success, or a <see cref="NotFoundResult"/> if item not found.</returns>
  725. [HttpDelete("Recordings/{recordingId}")]
  726. [Authorize(Policy = Policies.DefaultAuthorization)]
  727. [ProducesResponseType(StatusCodes.Status204NoContent)]
  728. [ProducesResponseType(StatusCodes.Status404NotFound)]
  729. public ActionResult DeleteRecording([FromRoute, Required] Guid recordingId)
  730. {
  731. AssertUserCanManageLiveTv();
  732. var item = _libraryManager.GetItemById(recordingId);
  733. if (item == null)
  734. {
  735. return NotFound();
  736. }
  737. _libraryManager.DeleteItem(item, new DeleteOptions
  738. {
  739. DeleteFileLocation = false
  740. });
  741. return NoContent();
  742. }
  743. /// <summary>
  744. /// Cancels a live tv timer.
  745. /// </summary>
  746. /// <param name="timerId">Timer id.</param>
  747. /// <response code="204">Timer deleted.</response>
  748. /// <returns>A <see cref="NoContentResult"/>.</returns>
  749. [HttpDelete("Timers/{timerId}")]
  750. [Authorize(Policy = Policies.DefaultAuthorization)]
  751. [ProducesResponseType(StatusCodes.Status204NoContent)]
  752. public async Task<ActionResult> CancelTimer([FromRoute, Required] string timerId)
  753. {
  754. AssertUserCanManageLiveTv();
  755. await _liveTvManager.CancelTimer(timerId).ConfigureAwait(false);
  756. return NoContent();
  757. }
  758. /// <summary>
  759. /// Updates a live tv timer.
  760. /// </summary>
  761. /// <param name="timerId">Timer id.</param>
  762. /// <param name="timerInfo">New timer info.</param>
  763. /// <response code="204">Timer updated.</response>
  764. /// <returns>A <see cref="NoContentResult"/>.</returns>
  765. [HttpPost("Timers/{timerId}")]
  766. [Authorize(Policy = Policies.DefaultAuthorization)]
  767. [ProducesResponseType(StatusCodes.Status204NoContent)]
  768. [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "timerId", Justification = "Imported from ServiceStack")]
  769. public async Task<ActionResult> UpdateTimer([FromRoute, Required] string timerId, [FromBody] TimerInfoDto timerInfo)
  770. {
  771. AssertUserCanManageLiveTv();
  772. await _liveTvManager.UpdateTimer(timerInfo, CancellationToken.None).ConfigureAwait(false);
  773. return NoContent();
  774. }
  775. /// <summary>
  776. /// Creates a live tv timer.
  777. /// </summary>
  778. /// <param name="timerInfo">New timer info.</param>
  779. /// <response code="204">Timer created.</response>
  780. /// <returns>A <see cref="NoContentResult"/>.</returns>
  781. [HttpPost("Timers")]
  782. [Authorize(Policy = Policies.DefaultAuthorization)]
  783. [ProducesResponseType(StatusCodes.Status204NoContent)]
  784. public async Task<ActionResult> CreateTimer([FromBody] TimerInfoDto timerInfo)
  785. {
  786. AssertUserCanManageLiveTv();
  787. await _liveTvManager.CreateTimer(timerInfo, CancellationToken.None).ConfigureAwait(false);
  788. return NoContent();
  789. }
  790. /// <summary>
  791. /// Gets a live tv series timer.
  792. /// </summary>
  793. /// <param name="timerId">Timer id.</param>
  794. /// <response code="200">Series timer returned.</response>
  795. /// <response code="404">Series timer not found.</response>
  796. /// <returns>A <see cref="OkResult"/> on success, or a <see cref="NotFoundResult"/> if timer not found.</returns>
  797. [HttpGet("SeriesTimers/{timerId}")]
  798. [Authorize(Policy = Policies.DefaultAuthorization)]
  799. [ProducesResponseType(StatusCodes.Status200OK)]
  800. [ProducesResponseType(StatusCodes.Status404NotFound)]
  801. public async Task<ActionResult<SeriesTimerInfoDto>> GetSeriesTimer([FromRoute, Required] string timerId)
  802. {
  803. var timer = await _liveTvManager.GetSeriesTimer(timerId, CancellationToken.None).ConfigureAwait(false);
  804. if (timer == null)
  805. {
  806. return NotFound();
  807. }
  808. return timer;
  809. }
  810. /// <summary>
  811. /// Gets live tv series timers.
  812. /// </summary>
  813. /// <param name="sortBy">Optional. Sort by SortName or Priority.</param>
  814. /// <param name="sortOrder">Optional. Sort in Ascending or Descending order.</param>
  815. /// <response code="200">Timers returned.</response>
  816. /// <returns>An <see cref="OkResult"/> of live tv series timers.</returns>
  817. [HttpGet("SeriesTimers")]
  818. [Authorize(Policy = Policies.DefaultAuthorization)]
  819. [ProducesResponseType(StatusCodes.Status200OK)]
  820. public async Task<ActionResult<QueryResult<SeriesTimerInfoDto>>> GetSeriesTimers([FromQuery] string? sortBy, [FromQuery] SortOrder? sortOrder)
  821. {
  822. return await _liveTvManager.GetSeriesTimers(
  823. new SeriesTimerQuery
  824. {
  825. SortOrder = sortOrder ?? SortOrder.Ascending,
  826. SortBy = sortBy
  827. }, CancellationToken.None).ConfigureAwait(false);
  828. }
  829. /// <summary>
  830. /// Cancels a live tv series timer.
  831. /// </summary>
  832. /// <param name="timerId">Timer id.</param>
  833. /// <response code="204">Timer cancelled.</response>
  834. /// <returns>A <see cref="NoContentResult"/>.</returns>
  835. [HttpDelete("SeriesTimers/{timerId}")]
  836. [Authorize(Policy = Policies.DefaultAuthorization)]
  837. [ProducesResponseType(StatusCodes.Status204NoContent)]
  838. public async Task<ActionResult> CancelSeriesTimer([FromRoute, Required] string timerId)
  839. {
  840. AssertUserCanManageLiveTv();
  841. await _liveTvManager.CancelSeriesTimer(timerId).ConfigureAwait(false);
  842. return NoContent();
  843. }
  844. /// <summary>
  845. /// Updates a live tv series timer.
  846. /// </summary>
  847. /// <param name="timerId">Timer id.</param>
  848. /// <param name="seriesTimerInfo">New series timer info.</param>
  849. /// <response code="204">Series timer updated.</response>
  850. /// <returns>A <see cref="NoContentResult"/>.</returns>
  851. [HttpPost("SeriesTimers/{timerId}")]
  852. [Authorize(Policy = Policies.DefaultAuthorization)]
  853. [ProducesResponseType(StatusCodes.Status204NoContent)]
  854. [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "timerId", Justification = "Imported from ServiceStack")]
  855. public async Task<ActionResult> UpdateSeriesTimer([FromRoute, Required] string timerId, [FromBody] SeriesTimerInfoDto seriesTimerInfo)
  856. {
  857. AssertUserCanManageLiveTv();
  858. await _liveTvManager.UpdateSeriesTimer(seriesTimerInfo, CancellationToken.None).ConfigureAwait(false);
  859. return NoContent();
  860. }
  861. /// <summary>
  862. /// Creates a live tv series timer.
  863. /// </summary>
  864. /// <param name="seriesTimerInfo">New series timer info.</param>
  865. /// <response code="204">Series timer info created.</response>
  866. /// <returns>A <see cref="NoContentResult"/>.</returns>
  867. [HttpPost("SeriesTimers")]
  868. [Authorize(Policy = Policies.DefaultAuthorization)]
  869. [ProducesResponseType(StatusCodes.Status204NoContent)]
  870. public async Task<ActionResult> CreateSeriesTimer([FromBody] SeriesTimerInfoDto seriesTimerInfo)
  871. {
  872. AssertUserCanManageLiveTv();
  873. await _liveTvManager.CreateSeriesTimer(seriesTimerInfo, CancellationToken.None).ConfigureAwait(false);
  874. return NoContent();
  875. }
  876. /// <summary>
  877. /// Get recording group.
  878. /// </summary>
  879. /// <param name="groupId">Group id.</param>
  880. /// <returns>A <see cref="NotFoundResult"/>.</returns>
  881. [HttpGet("Recordings/Groups/{groupId}")]
  882. [Authorize(Policy = Policies.DefaultAuthorization)]
  883. [ProducesResponseType(StatusCodes.Status404NotFound)]
  884. [Obsolete("This endpoint is obsolete.")]
  885. public ActionResult<BaseItemDto> GetRecordingGroup([FromRoute, Required] Guid? groupId)
  886. {
  887. return NotFound();
  888. }
  889. /// <summary>
  890. /// Get guid info.
  891. /// </summary>
  892. /// <response code="200">Guid info returned.</response>
  893. /// <returns>An <see cref="OkResult"/> containing the guide info.</returns>
  894. [HttpGet("GuideInfo")]
  895. [Authorize(Policy = Policies.DefaultAuthorization)]
  896. [ProducesResponseType(StatusCodes.Status200OK)]
  897. public ActionResult<GuideInfo> GetGuideInfo()
  898. {
  899. return _liveTvManager.GetGuideInfo();
  900. }
  901. /// <summary>
  902. /// Adds a tuner host.
  903. /// </summary>
  904. /// <param name="tunerHostInfo">New tuner host.</param>
  905. /// <response code="200">Created tuner host returned.</response>
  906. /// <returns>A <see cref="OkResult"/> containing the created tuner host.</returns>
  907. [HttpPost("TunerHosts")]
  908. [Authorize(Policy = Policies.DefaultAuthorization)]
  909. [ProducesResponseType(StatusCodes.Status200OK)]
  910. public async Task<ActionResult<TunerHostInfo>> AddTunerHost([FromBody] TunerHostInfo tunerHostInfo)
  911. {
  912. return await _liveTvManager.SaveTunerHost(tunerHostInfo).ConfigureAwait(false);
  913. }
  914. /// <summary>
  915. /// Deletes a tuner host.
  916. /// </summary>
  917. /// <param name="id">Tuner host id.</param>
  918. /// <response code="204">Tuner host deleted.</response>
  919. /// <returns>A <see cref="NoContentResult"/>.</returns>
  920. [HttpDelete("TunerHosts")]
  921. [Authorize(Policy = Policies.DefaultAuthorization)]
  922. [ProducesResponseType(StatusCodes.Status204NoContent)]
  923. public ActionResult DeleteTunerHost([FromQuery] string? id)
  924. {
  925. var config = _configurationManager.GetConfiguration<LiveTvOptions>("livetv");
  926. config.TunerHosts = config.TunerHosts.Where(i => !string.Equals(id, i.Id, StringComparison.OrdinalIgnoreCase)).ToArray();
  927. _configurationManager.SaveConfiguration("livetv", config);
  928. return NoContent();
  929. }
  930. /// <summary>
  931. /// Gets default listings provider info.
  932. /// </summary>
  933. /// <response code="200">Default listings provider info returned.</response>
  934. /// <returns>An <see cref="OkResult"/> containing the default listings provider info.</returns>
  935. [HttpGet("ListingProviders/Default")]
  936. [Authorize(Policy = Policies.DefaultAuthorization)]
  937. [ProducesResponseType(StatusCodes.Status200OK)]
  938. public ActionResult<ListingsProviderInfo> GetDefaultListingProvider()
  939. {
  940. return new ListingsProviderInfo();
  941. }
  942. /// <summary>
  943. /// Adds a listings provider.
  944. /// </summary>
  945. /// <param name="pw">Password.</param>
  946. /// <param name="listingsProviderInfo">New listings info.</param>
  947. /// <param name="validateListings">Validate listings.</param>
  948. /// <param name="validateLogin">Validate login.</param>
  949. /// <response code="200">Created listings provider returned.</response>
  950. /// <returns>A <see cref="OkResult"/> containing the created listings provider.</returns>
  951. [HttpPost("ListingProviders")]
  952. [Authorize(Policy = Policies.DefaultAuthorization)]
  953. [ProducesResponseType(StatusCodes.Status200OK)]
  954. [SuppressMessage("Microsoft.Performance", "CA5350:RemoveSha1", MessageId = "AddListingProvider", Justification = "Imported from ServiceStack")]
  955. public async Task<ActionResult<ListingsProviderInfo>> AddListingProvider(
  956. [FromQuery] string? pw,
  957. [FromBody] ListingsProviderInfo listingsProviderInfo,
  958. [FromQuery] bool validateListings = false,
  959. [FromQuery] bool validateLogin = false)
  960. {
  961. using var sha = SHA1.Create();
  962. if (!string.IsNullOrEmpty(pw))
  963. {
  964. listingsProviderInfo.Password = Hex.Encode(sha.ComputeHash(Encoding.UTF8.GetBytes(pw)));
  965. }
  966. return await _liveTvManager.SaveListingProvider(listingsProviderInfo, validateLogin, validateListings).ConfigureAwait(false);
  967. }
  968. /// <summary>
  969. /// Delete listing provider.
  970. /// </summary>
  971. /// <param name="id">Listing provider id.</param>
  972. /// <response code="204">Listing provider deleted.</response>
  973. /// <returns>A <see cref="NoContentResult"/>.</returns>
  974. [HttpDelete("ListingProviders")]
  975. [Authorize(Policy = Policies.DefaultAuthorization)]
  976. [ProducesResponseType(StatusCodes.Status204NoContent)]
  977. public ActionResult DeleteListingProvider([FromQuery] string? id)
  978. {
  979. _liveTvManager.DeleteListingsProvider(id);
  980. return NoContent();
  981. }
  982. /// <summary>
  983. /// Gets available lineups.
  984. /// </summary>
  985. /// <param name="id">Provider id.</param>
  986. /// <param name="type">Provider type.</param>
  987. /// <param name="location">Location.</param>
  988. /// <param name="country">Country.</param>
  989. /// <response code="200">Available lineups returned.</response>
  990. /// <returns>A <see cref="OkResult"/> containing the available lineups.</returns>
  991. [HttpGet("ListingProviders/Lineups")]
  992. [Authorize(Policy = Policies.DefaultAuthorization)]
  993. [ProducesResponseType(StatusCodes.Status200OK)]
  994. public async Task<ActionResult<IEnumerable<NameIdPair>>> GetLineups(
  995. [FromQuery] string? id,
  996. [FromQuery] string? type,
  997. [FromQuery] string? location,
  998. [FromQuery] string? country)
  999. {
  1000. return await _liveTvManager.GetLineups(type, id, country, location).ConfigureAwait(false);
  1001. }
  1002. /// <summary>
  1003. /// Gets available countries.
  1004. /// </summary>
  1005. /// <response code="200">Available countries returned.</response>
  1006. /// <returns>A <see cref="FileResult"/> containing the available countries.</returns>
  1007. [HttpGet("ListingProviders/SchedulesDirect/Countries")]
  1008. [Authorize(Policy = Policies.DefaultAuthorization)]
  1009. [ProducesResponseType(StatusCodes.Status200OK)]
  1010. public async Task<ActionResult> GetSchedulesDirectCountries()
  1011. {
  1012. var client = _httpClientFactory.CreateClient(NamedClient.Default);
  1013. // https://json.schedulesdirect.org/20141201/available/countries
  1014. // Can't dispose the response as it's required up the call chain.
  1015. var response = await client.GetAsync("https://json.schedulesdirect.org/20141201/available/countries")
  1016. .ConfigureAwait(false);
  1017. return File(await response.Content.ReadAsStreamAsync().ConfigureAwait(false), MediaTypeNames.Application.Json);
  1018. }
  1019. /// <summary>
  1020. /// Get channel mapping options.
  1021. /// </summary>
  1022. /// <param name="providerId">Provider id.</param>
  1023. /// <response code="200">Channel mapping options returned.</response>
  1024. /// <returns>An <see cref="OkResult"/> containing the channel mapping options.</returns>
  1025. [HttpGet("ChannelMappingOptions")]
  1026. [Authorize(Policy = Policies.DefaultAuthorization)]
  1027. [ProducesResponseType(StatusCodes.Status200OK)]
  1028. public async Task<ActionResult<ChannelMappingOptionsDto>> GetChannelMappingOptions([FromQuery] string? providerId)
  1029. {
  1030. var config = _configurationManager.GetConfiguration<LiveTvOptions>("livetv");
  1031. var listingsProviderInfo = config.ListingProviders.First(i => string.Equals(providerId, i.Id, StringComparison.OrdinalIgnoreCase));
  1032. var listingsProviderName = _liveTvManager.ListingProviders.First(i => string.Equals(i.Type, listingsProviderInfo.Type, StringComparison.OrdinalIgnoreCase)).Name;
  1033. var tunerChannels = await _liveTvManager.GetChannelsForListingsProvider(providerId, CancellationToken.None)
  1034. .ConfigureAwait(false);
  1035. var providerChannels = await _liveTvManager.GetChannelsFromListingsProviderData(providerId, CancellationToken.None)
  1036. .ConfigureAwait(false);
  1037. var mappings = listingsProviderInfo.ChannelMappings;
  1038. return new ChannelMappingOptionsDto
  1039. {
  1040. TunerChannels = tunerChannels.Select(i => _liveTvManager.GetTunerChannelMapping(i, mappings, providerChannels)).ToList(),
  1041. ProviderChannels = providerChannels.Select(i => new NameIdPair
  1042. {
  1043. Name = i.Name,
  1044. Id = i.Id
  1045. }).ToList(),
  1046. Mappings = mappings,
  1047. ProviderName = listingsProviderName
  1048. };
  1049. }
  1050. /// <summary>
  1051. /// Set channel mappings.
  1052. /// </summary>
  1053. /// <param name="providerId">Provider id.</param>
  1054. /// <param name="tunerChannelId">Tuner channel id.</param>
  1055. /// <param name="providerChannelId">Provider channel id.</param>
  1056. /// <response code="200">Created channel mapping returned.</response>
  1057. /// <returns>An <see cref="OkResult"/> containing the created channel mapping.</returns>
  1058. [HttpPost("ChannelMappings")]
  1059. [Authorize(Policy = Policies.DefaultAuthorization)]
  1060. [ProducesResponseType(StatusCodes.Status200OK)]
  1061. public async Task<ActionResult<TunerChannelMapping>> SetChannelMapping(
  1062. [FromQuery] string? providerId,
  1063. [FromQuery] string? tunerChannelId,
  1064. [FromQuery] string? providerChannelId)
  1065. {
  1066. return await _liveTvManager.SetChannelMapping(providerId, tunerChannelId, providerChannelId).ConfigureAwait(false);
  1067. }
  1068. /// <summary>
  1069. /// Get tuner host types.
  1070. /// </summary>
  1071. /// <response code="200">Tuner host types returned.</response>
  1072. /// <returns>An <see cref="OkResult"/> containing the tuner host types.</returns>
  1073. [HttpGet("TunerHosts/Types")]
  1074. [Authorize(Policy = Policies.DefaultAuthorization)]
  1075. [ProducesResponseType(StatusCodes.Status200OK)]
  1076. public ActionResult<IEnumerable<NameIdPair>> GetTunerHostTypes()
  1077. {
  1078. return _liveTvManager.GetTunerHostTypes();
  1079. }
  1080. /// <summary>
  1081. /// Discover tuners.
  1082. /// </summary>
  1083. /// <param name="newDevicesOnly">Only discover new tuners.</param>
  1084. /// <response code="200">Tuners returned.</response>
  1085. /// <returns>An <see cref="OkResult"/> containing the tuners.</returns>
  1086. [HttpGet("Tuners/Discvover")]
  1087. [Authorize(Policy = Policies.DefaultAuthorization)]
  1088. [ProducesResponseType(StatusCodes.Status200OK)]
  1089. public async Task<ActionResult<IEnumerable<TunerHostInfo>>> DiscoverTuners([FromQuery] bool newDevicesOnly = false)
  1090. {
  1091. return await _liveTvManager.DiscoverTuners(newDevicesOnly, CancellationToken.None).ConfigureAwait(false);
  1092. }
  1093. /// <summary>
  1094. /// Gets a live tv recording stream.
  1095. /// </summary>
  1096. /// <param name="recordingId">Recording id.</param>
  1097. /// <response code="200">Recording stream returned.</response>
  1098. /// <response code="404">Recording not found.</response>
  1099. /// <returns>
  1100. /// An <see cref="OkResult"/> containing the recording stream on success,
  1101. /// or a <see cref="NotFoundResult"/> if recording not found.
  1102. /// </returns>
  1103. [HttpGet("LiveRecordings/{recordingId}/stream")]
  1104. [ProducesResponseType(StatusCodes.Status200OK)]
  1105. [ProducesResponseType(StatusCodes.Status404NotFound)]
  1106. public async Task<ActionResult> GetLiveRecordingFile([FromRoute, Required] string recordingId)
  1107. {
  1108. var path = _liveTvManager.GetEmbyTvActiveRecordingPath(recordingId);
  1109. if (string.IsNullOrWhiteSpace(path))
  1110. {
  1111. return NotFound();
  1112. }
  1113. await using var memoryStream = new MemoryStream();
  1114. await new ProgressiveFileCopier(path, null, _transcodingJobHelper, CancellationToken.None)
  1115. .WriteToAsync(memoryStream, CancellationToken.None)
  1116. .ConfigureAwait(false);
  1117. return File(memoryStream, MimeTypes.GetMimeType(path));
  1118. }
  1119. /// <summary>
  1120. /// Gets a live tv channel stream.
  1121. /// </summary>
  1122. /// <param name="streamId">Stream id.</param>
  1123. /// <param name="container">Container type.</param>
  1124. /// <response code="200">Stream returned.</response>
  1125. /// <response code="404">Stream not found.</response>
  1126. /// <returns>
  1127. /// An <see cref="OkResult"/> containing the channel stream on success,
  1128. /// or a <see cref="NotFoundResult"/> if stream not found.
  1129. /// </returns>
  1130. [HttpGet("LiveStreamFiles/{streamId}/stream.{container}")]
  1131. [ProducesResponseType(StatusCodes.Status200OK)]
  1132. [ProducesResponseType(StatusCodes.Status404NotFound)]
  1133. public async Task<ActionResult> GetLiveStreamFile([FromRoute, Required] string streamId, [FromRoute, Required] string container)
  1134. {
  1135. var liveStreamInfo = await _mediaSourceManager.GetDirectStreamProviderByUniqueId(streamId, CancellationToken.None).ConfigureAwait(false);
  1136. if (liveStreamInfo == null)
  1137. {
  1138. return NotFound();
  1139. }
  1140. await using var memoryStream = new MemoryStream();
  1141. await new ProgressiveFileCopier(liveStreamInfo, null, _transcodingJobHelper, CancellationToken.None)
  1142. .WriteToAsync(memoryStream, CancellationToken.None)
  1143. .ConfigureAwait(false);
  1144. return File(memoryStream, MimeTypes.GetMimeType("file." + container));
  1145. }
  1146. private void AssertUserCanManageLiveTv()
  1147. {
  1148. var user = _sessionContext.GetUser(Request);
  1149. if (user == null)
  1150. {
  1151. throw new SecurityException("Anonymous live tv management is not allowed.");
  1152. }
  1153. if (!user.HasPermission(PermissionKind.EnableLiveTvManagement))
  1154. {
  1155. throw new SecurityException("The current user does not have permission to manage live tv.");
  1156. }
  1157. }
  1158. }
  1159. }