LiveTvController.cs 56 KB

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