LiveTvController.cs 62 KB

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