LiveTvController.cs 61 KB

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