LiveTvController.cs 62 KB

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