LiveTvController.cs 61 KB

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