LiveTvController.cs 61 KB

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