LiveTvService.cs 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877
  1. using MediaBrowser.Common.Configuration;
  2. using MediaBrowser.Common.Net;
  3. using MediaBrowser.Controller.Dto;
  4. using MediaBrowser.Controller.Library;
  5. using MediaBrowser.Controller.LiveTv;
  6. using MediaBrowser.Controller.Net;
  7. using MediaBrowser.Model.Dto;
  8. using MediaBrowser.Model.Entities;
  9. using MediaBrowser.Model.LiveTv;
  10. using MediaBrowser.Model.Querying;
  11. using ServiceStack;
  12. using System;
  13. using System.Collections.Generic;
  14. using System.Globalization;
  15. using System.Linq;
  16. using System.Threading;
  17. using System.Threading.Tasks;
  18. namespace MediaBrowser.Api.LiveTv
  19. {
  20. /// <summary>
  21. /// This is insecure right now to avoid windows phone refactoring
  22. /// </summary>
  23. [Route("/LiveTv/Info", "GET", Summary = "Gets available live tv services.")]
  24. [Authenticated]
  25. public class GetLiveTvInfo : IReturn<LiveTvInfo>
  26. {
  27. }
  28. [Route("/LiveTv/Channels", "GET", Summary = "Gets available live tv channels.")]
  29. [Authenticated]
  30. public class GetChannels : IReturn<QueryResult<ChannelInfoDto>>, IHasDtoOptions
  31. {
  32. [ApiMember(Name = "Type", Description = "Optional filter by channel type.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  33. public ChannelType? Type { get; set; }
  34. [ApiMember(Name = "UserId", Description = "Optional filter by user and attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  35. public string UserId { get; set; }
  36. /// <summary>
  37. /// Skips over a given number of items within the results. Use for paging.
  38. /// </summary>
  39. /// <value>The start index.</value>
  40. [ApiMember(Name = "StartIndex", Description = "Optional. The record index to start at. All items with a lower index will be dropped from the results.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  41. public int? StartIndex { get; set; }
  42. /// <summary>
  43. /// The maximum number of items to return
  44. /// </summary>
  45. /// <value>The limit.</value>
  46. [ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  47. public int? Limit { get; set; }
  48. [ApiMember(Name = "IsFavorite", Description = "Filter by channels that are favorites, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  49. public bool? IsFavorite { get; set; }
  50. [ApiMember(Name = "IsLiked", Description = "Filter by channels that are liked, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  51. public bool? IsLiked { get; set; }
  52. [ApiMember(Name = "IsDisliked", Description = "Filter by channels that are disliked, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  53. public bool? IsDisliked { get; set; }
  54. [ApiMember(Name = "EnableFavoriteSorting", Description = "Incorporate favorite and like status into channel sorting.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  55. public bool EnableFavoriteSorting { get; set; }
  56. [ApiMember(Name = "EnableImages", Description = "Optional, include image information in output", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
  57. public bool? EnableImages { get; set; }
  58. [ApiMember(Name = "ImageTypeLimit", Description = "Optional, the max number of images to return, per image type", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  59. public int? ImageTypeLimit { get; set; }
  60. [ApiMember(Name = "EnableImageTypes", Description = "Optional. The image types to include in the output.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  61. public string EnableImageTypes { get; set; }
  62. /// <summary>
  63. /// Fields to return within the items, in addition to basic information
  64. /// </summary>
  65. /// <value>The fields.</value>
  66. [ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, CriticRatingSummary, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  67. public string Fields { get; set; }
  68. [ApiMember(Name = "AddCurrentProgram", Description = "Optional. Adds current program info to each channel", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  69. public bool AddCurrentProgram { get; set; }
  70. public GetChannels()
  71. {
  72. AddCurrentProgram = true;
  73. }
  74. }
  75. [Route("/LiveTv/Channels/{Id}", "GET", Summary = "Gets a live tv channel")]
  76. [Authenticated]
  77. public class GetChannel : IReturn<ChannelInfoDto>
  78. {
  79. /// <summary>
  80. /// Gets or sets the id.
  81. /// </summary>
  82. /// <value>The id.</value>
  83. [ApiMember(Name = "Id", Description = "Channel Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  84. public string Id { get; set; }
  85. [ApiMember(Name = "UserId", Description = "Optional attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  86. public string UserId { get; set; }
  87. }
  88. [Route("/LiveTv/Recordings", "GET", Summary = "Gets live tv recordings")]
  89. [Authenticated]
  90. public class GetRecordings : IReturn<QueryResult<BaseItemDto>>, IHasDtoOptions
  91. {
  92. [ApiMember(Name = "ChannelId", Description = "Optional filter by channel id.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  93. public string ChannelId { get; set; }
  94. [ApiMember(Name = "UserId", Description = "Optional filter by user and attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  95. public string UserId { get; set; }
  96. [ApiMember(Name = "GroupId", Description = "Optional filter by recording group.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  97. public string GroupId { get; set; }
  98. [ApiMember(Name = "StartIndex", Description = "Optional. The record index to start at. All items with a lower index will be dropped from the results.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  99. public int? StartIndex { get; set; }
  100. [ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  101. public int? Limit { get; set; }
  102. [ApiMember(Name = "Status", Description = "Optional filter by recording status.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  103. public RecordingStatus? Status { get; set; }
  104. [ApiMember(Name = "Status", Description = "Optional filter by recordings that are in progress, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  105. public bool? IsInProgress { get; set; }
  106. [ApiMember(Name = "SeriesTimerId", Description = "Optional filter by recordings belonging to a series timer", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  107. public string SeriesTimerId { get; set; }
  108. [ApiMember(Name = "EnableImages", Description = "Optional, include image information in output", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
  109. public bool? EnableImages { get; set; }
  110. [ApiMember(Name = "ImageTypeLimit", Description = "Optional, the max number of images to return, per image type", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  111. public int? ImageTypeLimit { get; set; }
  112. [ApiMember(Name = "EnableImageTypes", Description = "Optional. The image types to include in the output.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  113. public string EnableImageTypes { get; set; }
  114. /// <summary>
  115. /// Fields to return within the items, in addition to basic information
  116. /// </summary>
  117. /// <value>The fields.</value>
  118. [ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, CriticRatingSummary, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  119. public string Fields { get; set; }
  120. }
  121. [Route("/LiveTv/Recordings/Groups", "GET", Summary = "Gets live tv recording groups")]
  122. [Authenticated]
  123. public class GetRecordingGroups : IReturn<QueryResult<BaseItemDto>>
  124. {
  125. [ApiMember(Name = "UserId", Description = "Optional filter by user and attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  126. public string UserId { get; set; }
  127. }
  128. [Route("/LiveTv/Recordings/{Id}", "GET", Summary = "Gets a live tv recording")]
  129. [Authenticated]
  130. public class GetRecording : IReturn<BaseItemDto>
  131. {
  132. [ApiMember(Name = "Id", Description = "Recording Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  133. public string Id { get; set; }
  134. [ApiMember(Name = "UserId", Description = "Optional attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  135. public string UserId { get; set; }
  136. }
  137. [Route("/LiveTv/Tuners/{Id}/Reset", "POST", Summary = "Resets a tv tuner")]
  138. [Authenticated]
  139. public class ResetTuner : IReturnVoid
  140. {
  141. [ApiMember(Name = "Id", Description = "Tuner Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  142. public string Id { get; set; }
  143. }
  144. [Route("/LiveTv/Timers/{Id}", "GET", Summary = "Gets a live tv timer")]
  145. [Authenticated]
  146. public class GetTimer : IReturn<TimerInfoDto>
  147. {
  148. [ApiMember(Name = "Id", Description = "Timer Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  149. public string Id { get; set; }
  150. }
  151. [Route("/LiveTv/Timers/Defaults", "GET", Summary = "Gets default values for a new timer")]
  152. [Authenticated]
  153. public class GetDefaultTimer : IReturn<SeriesTimerInfoDto>
  154. {
  155. [ApiMember(Name = "ProgramId", Description = "Optional, to attach default values based on a program.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  156. public string ProgramId { get; set; }
  157. }
  158. [Route("/LiveTv/Timers", "GET", Summary = "Gets live tv timers")]
  159. [Authenticated]
  160. public class GetTimers : IReturn<QueryResult<TimerInfoDto>>
  161. {
  162. [ApiMember(Name = "ChannelId", Description = "Optional filter by channel id.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  163. public string ChannelId { get; set; }
  164. [ApiMember(Name = "SeriesTimerId", Description = "Optional filter by timers belonging to a series timer", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  165. public string SeriesTimerId { get; set; }
  166. }
  167. [Route("/LiveTv/Programs", "GET,POST", Summary = "Gets available live tv epgs..")]
  168. [Authenticated]
  169. public class GetPrograms : IReturn<QueryResult<BaseItemDto>>, IHasDtoOptions
  170. {
  171. [ApiMember(Name = "ChannelIds", Description = "The channels to return guide information for.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  172. public string ChannelIds { get; set; }
  173. [ApiMember(Name = "UserId", Description = "Optional filter by user id.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  174. public string UserId { get; set; }
  175. [ApiMember(Name = "MinStartDate", Description = "Optional. The minimum premiere date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  176. public string MinStartDate { get; set; }
  177. [ApiMember(Name = "HasAired", Description = "Optional. Filter by programs that have completed airing, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  178. public bool? HasAired { get; set; }
  179. [ApiMember(Name = "MaxStartDate", Description = "Optional. The maximum premiere date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  180. public string MaxStartDate { get; set; }
  181. [ApiMember(Name = "MinEndDate", Description = "Optional. The minimum premiere date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  182. public string MinEndDate { get; set; }
  183. [ApiMember(Name = "MaxEndDate", Description = "Optional. The maximum premiere date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  184. public string MaxEndDate { get; set; }
  185. [ApiMember(Name = "IsMovie", Description = "Optional filter for movies.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
  186. public bool? IsMovie { get; set; }
  187. [ApiMember(Name = "IsKids", Description = "Optional filter for kids.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
  188. public bool? IsKids { get; set; }
  189. [ApiMember(Name = "IsSports", Description = "Optional filter for sports.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
  190. public bool? IsSports { get; set; }
  191. [ApiMember(Name = "StartIndex", Description = "Optional. The record index to start at. All items with a lower index will be dropped from the results.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  192. public int? StartIndex { get; set; }
  193. [ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  194. public int? Limit { get; set; }
  195. [ApiMember(Name = "SortBy", Description = "Optional. Specify one or more sort orders, comma delimeted. Options: Name, StartDate", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  196. public string SortBy { get; set; }
  197. [ApiMember(Name = "SortOrder", Description = "Sort Order - Ascending,Descending", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  198. public SortOrder? SortOrder { get; set; }
  199. [ApiMember(Name = "Genres", Description = "The genres to return guide information for.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  200. public string Genres { get; set; }
  201. [ApiMember(Name = "EnableImages", Description = "Optional, include image information in output", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
  202. public bool? EnableImages { get; set; }
  203. [ApiMember(Name = "ImageTypeLimit", Description = "Optional, the max number of images to return, per image type", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  204. public int? ImageTypeLimit { get; set; }
  205. [ApiMember(Name = "EnableImageTypes", Description = "Optional. The image types to include in the output.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  206. public string EnableImageTypes { get; set; }
  207. /// <summary>
  208. /// Fields to return within the items, in addition to basic information
  209. /// </summary>
  210. /// <value>The fields.</value>
  211. [ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, CriticRatingSummary, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  212. public string Fields { get; set; }
  213. }
  214. [Route("/LiveTv/Programs/Recommended", "GET", Summary = "Gets available live tv epgs..")]
  215. [Authenticated]
  216. public class GetRecommendedPrograms : IReturn<QueryResult<BaseItemDto>>, IHasDtoOptions
  217. {
  218. [ApiMember(Name = "UserId", Description = "Optional filter by user id.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  219. public string UserId { get; set; }
  220. [ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  221. public int? Limit { get; set; }
  222. [ApiMember(Name = "IsAiring", Description = "Optional. Filter by programs that are currently airing, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  223. public bool? IsAiring { get; set; }
  224. [ApiMember(Name = "HasAired", Description = "Optional. Filter by programs that have completed airing, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  225. public bool? HasAired { get; set; }
  226. [ApiMember(Name = "IsSports", Description = "Optional filter for sports.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET,POST")]
  227. public bool? IsSports { get; set; }
  228. [ApiMember(Name = "IsMovie", Description = "Optional filter for movies.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  229. public bool? IsMovie { get; set; }
  230. [ApiMember(Name = "IsKids", Description = "Optional filter for kids.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  231. public bool? IsKids { get; set; }
  232. [ApiMember(Name = "EnableImages", Description = "Optional, include image information in output", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
  233. public bool? EnableImages { get; set; }
  234. [ApiMember(Name = "ImageTypeLimit", Description = "Optional, the max number of images to return, per image type", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  235. public int? ImageTypeLimit { get; set; }
  236. [ApiMember(Name = "EnableImageTypes", Description = "Optional. The image types to include in the output.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  237. public string EnableImageTypes { get; set; }
  238. /// <summary>
  239. /// Fields to return within the items, in addition to basic information
  240. /// </summary>
  241. /// <value>The fields.</value>
  242. [ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, CriticRatingSummary, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  243. public string Fields { get; set; }
  244. }
  245. [Route("/LiveTv/Programs/{Id}", "GET", Summary = "Gets a live tv program")]
  246. [Authenticated]
  247. public class GetProgram : IReturn<BaseItemDto>
  248. {
  249. [ApiMember(Name = "Id", Description = "Program Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  250. public string Id { get; set; }
  251. [ApiMember(Name = "UserId", Description = "Optional attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  252. public string UserId { get; set; }
  253. }
  254. [Route("/LiveTv/Recordings/{Id}", "DELETE", Summary = "Deletes a live tv recording")]
  255. [Authenticated]
  256. public class DeleteRecording : IReturnVoid
  257. {
  258. [ApiMember(Name = "Id", Description = "Recording Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  259. public string Id { get; set; }
  260. }
  261. [Route("/LiveTv/Timers/{Id}", "DELETE", Summary = "Cancels a live tv timer")]
  262. [Authenticated]
  263. public class CancelTimer : IReturnVoid
  264. {
  265. [ApiMember(Name = "Id", Description = "Timer Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  266. public string Id { get; set; }
  267. }
  268. [Route("/LiveTv/Timers/{Id}", "POST", Summary = "Updates a live tv timer")]
  269. [Authenticated]
  270. public class UpdateTimer : TimerInfoDto, IReturnVoid
  271. {
  272. }
  273. [Route("/LiveTv/Timers", "POST", Summary = "Creates a live tv timer")]
  274. [Authenticated]
  275. public class CreateTimer : TimerInfoDto, IReturnVoid
  276. {
  277. }
  278. [Route("/LiveTv/SeriesTimers/{Id}", "GET", Summary = "Gets a live tv series timer")]
  279. [Authenticated]
  280. public class GetSeriesTimer : IReturn<TimerInfoDto>
  281. {
  282. [ApiMember(Name = "Id", Description = "Timer Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  283. public string Id { get; set; }
  284. }
  285. [Route("/LiveTv/SeriesTimers", "GET", Summary = "Gets live tv series timers")]
  286. [Authenticated]
  287. public class GetSeriesTimers : IReturn<QueryResult<SeriesTimerInfoDto>>
  288. {
  289. [ApiMember(Name = "SortBy", Description = "Optional. Sort by SortName or Priority", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  290. public string SortBy { get; set; }
  291. [ApiMember(Name = "SortOrder", Description = "Optional. Sort in Ascending or Descending order", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET,POST")]
  292. public SortOrder SortOrder { get; set; }
  293. }
  294. [Route("/LiveTv/SeriesTimers/{Id}", "DELETE", Summary = "Cancels a live tv series timer")]
  295. [Authenticated]
  296. public class CancelSeriesTimer : IReturnVoid
  297. {
  298. [ApiMember(Name = "Id", Description = "Timer Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  299. public string Id { get; set; }
  300. }
  301. [Route("/LiveTv/SeriesTimers/{Id}", "POST", Summary = "Updates a live tv series timer")]
  302. [Authenticated]
  303. public class UpdateSeriesTimer : SeriesTimerInfoDto, IReturnVoid
  304. {
  305. }
  306. [Route("/LiveTv/SeriesTimers", "POST", Summary = "Creates a live tv series timer")]
  307. [Authenticated]
  308. public class CreateSeriesTimer : SeriesTimerInfoDto, IReturnVoid
  309. {
  310. }
  311. [Route("/LiveTv/Recordings/Groups/{Id}", "GET", Summary = "Gets a recording group")]
  312. [Authenticated]
  313. public class GetRecordingGroup : IReturn<BaseItemDto>
  314. {
  315. [ApiMember(Name = "Id", Description = "Recording group Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  316. public string Id { get; set; }
  317. }
  318. [Route("/LiveTv/GuideInfo", "GET", Summary = "Gets guide info")]
  319. [Authenticated]
  320. public class GetGuideInfo : IReturn<GuideInfo>
  321. {
  322. }
  323. [Route("/LiveTv/Folder", "GET", Summary = "Gets the users live tv folder, along with configured images")]
  324. [Authenticated]
  325. public class GetLiveTvFolder : IReturn<BaseItemDto>
  326. {
  327. [ApiMember(Name = "UserId", Description = "Optional attach user data.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  328. public string UserId { get; set; }
  329. }
  330. [Route("/LiveTv/TunerHosts", "POST", Summary = "Adds a tuner host")]
  331. [Authenticated]
  332. public class AddTunerHost : TunerHostInfo, IReturn<TunerHostInfo>
  333. {
  334. }
  335. [Route("/LiveTv/TunerHosts", "DELETE", Summary = "Deletes a tuner host")]
  336. [Authenticated]
  337. public class DeleteTunerHost : IReturnVoid
  338. {
  339. [ApiMember(Name = "Id", Description = "Tuner host id", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "DELETE")]
  340. public string Id { get; set; }
  341. }
  342. [Route("/LiveTv/ListingProviders", "POST", Summary = "Adds a listing provider")]
  343. [Authenticated(AllowBeforeStartupWizard = true)]
  344. public class AddListingProvider : ListingsProviderInfo, IReturn<ListingsProviderInfo>
  345. {
  346. public bool ValidateLogin { get; set; }
  347. public bool ValidateListings { get; set; }
  348. }
  349. [Route("/LiveTv/ListingProviders", "DELETE", Summary = "Deletes a listing provider")]
  350. [Authenticated(AllowBeforeStartupWizard = true)]
  351. public class DeleteListingProvider : IReturnVoid
  352. {
  353. [ApiMember(Name = "Id", Description = "Provider id", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "DELETE")]
  354. public string Id { get; set; }
  355. }
  356. [Route("/LiveTv/ListingProviders/Lineups", "GET", Summary = "Gets available lineups")]
  357. [Authenticated(AllowBeforeStartupWizard = true)]
  358. public class GetLineups : IReturn<List<NameIdPair>>
  359. {
  360. [ApiMember(Name = "Id", Description = "Provider id", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  361. public string Id { get; set; }
  362. [ApiMember(Name = "Type", Description = "Provider Type", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  363. public string Type { get; set; }
  364. [ApiMember(Name = "Location", Description = "Location", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  365. public string Location { get; set; }
  366. [ApiMember(Name = "Country", Description = "Country", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  367. public string Country { get; set; }
  368. }
  369. [Route("/LiveTv/ListingProviders/SchedulesDirect/Countries", "GET", Summary = "Gets available lineups")]
  370. [Authenticated(AllowBeforeStartupWizard = true)]
  371. public class GetSchedulesDirectCountries
  372. {
  373. }
  374. [Route("/LiveTv/Registration", "GET")]
  375. [Authenticated]
  376. public class GetLiveTvRegistrationInfo : IReturn<MBRegistrationRecord>
  377. {
  378. [ApiMember(Name = "ChannelId", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  379. public string ChannelId { get; set; }
  380. [ApiMember(Name = "ProgramId", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  381. public string ProgramId { get; set; }
  382. [ApiMember(Name = "Feature", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  383. public string Feature { get; set; }
  384. }
  385. public class LiveTvService : BaseApiService
  386. {
  387. private readonly ILiveTvManager _liveTvManager;
  388. private readonly IUserManager _userManager;
  389. private readonly IConfigurationManager _config;
  390. private readonly IHttpClient _httpClient;
  391. public LiveTvService(ILiveTvManager liveTvManager, IUserManager userManager, IConfigurationManager config, IHttpClient httpClient)
  392. {
  393. _liveTvManager = liveTvManager;
  394. _userManager = userManager;
  395. _config = config;
  396. _httpClient = httpClient;
  397. }
  398. public async Task<object> Get(GetLiveTvRegistrationInfo request)
  399. {
  400. var result = await _liveTvManager.GetRegistrationInfo(request.ChannelId, request.ProgramId, request.Feature).ConfigureAwait(false);
  401. return ToOptimizedResult(result);
  402. }
  403. public async Task<object> Get(GetSchedulesDirectCountries request)
  404. {
  405. // https://json.schedulesdirect.org/20141201/available/countries
  406. var response = await _httpClient.Get(new HttpRequestOptions
  407. {
  408. Url = "https://json.schedulesdirect.org/20141201/available/countries",
  409. CacheLength = TimeSpan.FromDays(1),
  410. CacheMode = CacheMode.Unconditional
  411. }).ConfigureAwait(false);
  412. return ResultFactory.GetResult(response, "application/json");
  413. }
  414. private void AssertUserCanManageLiveTv()
  415. {
  416. var user = SessionContext.GetUser(Request).Result;
  417. if (user == null)
  418. {
  419. throw new UnauthorizedAccessException("Anonymous live tv management is not allowed.");
  420. }
  421. if (!user.Policy.EnableLiveTvManagement)
  422. {
  423. throw new UnauthorizedAccessException("The current user does not have permission to manage live tv.");
  424. }
  425. }
  426. public async Task<object> Post(AddListingProvider request)
  427. {
  428. var result = await _liveTvManager.SaveListingProvider(request, request.ValidateLogin, request.ValidateListings).ConfigureAwait(false);
  429. return ToOptimizedResult(result);
  430. }
  431. public void Delete(DeleteListingProvider request)
  432. {
  433. var config = GetConfiguration();
  434. config.ListingProviders = config.ListingProviders.Where(i => !string.Equals(request.Id, i.Id, StringComparison.OrdinalIgnoreCase)).ToList();
  435. _config.SaveConfiguration("livetv", config);
  436. }
  437. public async Task<object> Post(AddTunerHost request)
  438. {
  439. var result = await _liveTvManager.SaveTunerHost(request).ConfigureAwait(false);
  440. return ToOptimizedResult(result);
  441. }
  442. public void Delete(DeleteTunerHost request)
  443. {
  444. var config = GetConfiguration();
  445. config.TunerHosts = config.TunerHosts.Where(i => !string.Equals(request.Id, i.Id, StringComparison.OrdinalIgnoreCase)).ToList();
  446. _config.SaveConfiguration("livetv", config);
  447. }
  448. private LiveTvOptions GetConfiguration()
  449. {
  450. return _config.GetConfiguration<LiveTvOptions>("livetv");
  451. }
  452. public async Task<object> Get(GetLineups request)
  453. {
  454. var info = await _liveTvManager.GetLineups(request.Type, request.Id, request.Country, request.Location).ConfigureAwait(false);
  455. return ToOptimizedSerializedResultUsingCache(info);
  456. }
  457. public async Task<object> Get(GetLiveTvInfo request)
  458. {
  459. var info = await _liveTvManager.GetLiveTvInfo(CancellationToken.None).ConfigureAwait(false);
  460. return ToOptimizedSerializedResultUsingCache(info);
  461. }
  462. public async Task<object> Get(GetChannels request)
  463. {
  464. var result = await _liveTvManager.GetChannels(new LiveTvChannelQuery
  465. {
  466. ChannelType = request.Type,
  467. UserId = request.UserId,
  468. StartIndex = request.StartIndex,
  469. Limit = request.Limit,
  470. IsFavorite = request.IsFavorite,
  471. IsLiked = request.IsLiked,
  472. IsDisliked = request.IsDisliked,
  473. EnableFavoriteSorting = request.EnableFavoriteSorting,
  474. AddCurrentProgram = request.AddCurrentProgram
  475. }, GetDtoOptions(request), CancellationToken.None).ConfigureAwait(false);
  476. return ToOptimizedSerializedResultUsingCache(result);
  477. }
  478. public async Task<object> Get(GetChannel request)
  479. {
  480. var user = string.IsNullOrEmpty(request.UserId) ? null : _userManager.GetUserById(request.UserId);
  481. var result = await _liveTvManager.GetChannel(request.Id, CancellationToken.None, user).ConfigureAwait(false);
  482. return ToOptimizedSerializedResultUsingCache(result);
  483. }
  484. public async Task<object> Get(GetLiveTvFolder request)
  485. {
  486. return ToOptimizedResult(await _liveTvManager.GetLiveTvFolder(request.UserId, CancellationToken.None).ConfigureAwait(false));
  487. }
  488. public async Task<object> Get(GetPrograms request)
  489. {
  490. var query = new ProgramQuery
  491. {
  492. ChannelIds = (request.ChannelIds ?? string.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries).ToArray(),
  493. UserId = request.UserId,
  494. HasAired = request.HasAired
  495. };
  496. if (!string.IsNullOrEmpty(request.MinStartDate))
  497. {
  498. query.MinStartDate = DateTime.Parse(request.MinStartDate, null, DateTimeStyles.RoundtripKind).ToUniversalTime();
  499. }
  500. if (!string.IsNullOrEmpty(request.MinEndDate))
  501. {
  502. query.MinEndDate = DateTime.Parse(request.MinEndDate, null, DateTimeStyles.RoundtripKind).ToUniversalTime();
  503. }
  504. if (!string.IsNullOrEmpty(request.MaxStartDate))
  505. {
  506. query.MaxStartDate = DateTime.Parse(request.MaxStartDate, null, DateTimeStyles.RoundtripKind).ToUniversalTime();
  507. }
  508. if (!string.IsNullOrEmpty(request.MaxEndDate))
  509. {
  510. query.MaxEndDate = DateTime.Parse(request.MaxEndDate, null, DateTimeStyles.RoundtripKind).ToUniversalTime();
  511. }
  512. query.StartIndex = request.StartIndex;
  513. query.Limit = request.Limit;
  514. query.SortBy = (request.SortBy ?? String.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
  515. query.SortOrder = request.SortOrder;
  516. query.IsMovie = request.IsMovie;
  517. query.IsKids = request.IsKids;
  518. query.IsSports = request.IsSports;
  519. query.Genres = (request.Genres ?? String.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
  520. var result = await _liveTvManager.GetPrograms(query, GetDtoOptions(request), CancellationToken.None).ConfigureAwait(false);
  521. return ToOptimizedResult(result);
  522. }
  523. public async Task<object> Get(GetRecommendedPrograms request)
  524. {
  525. var query = new RecommendedProgramQuery
  526. {
  527. UserId = request.UserId,
  528. IsAiring = request.IsAiring,
  529. Limit = request.Limit,
  530. HasAired = request.HasAired,
  531. IsMovie = request.IsMovie,
  532. IsKids = request.IsKids,
  533. IsSports = request.IsSports
  534. };
  535. var result = await _liveTvManager.GetRecommendedPrograms(query, GetDtoOptions(request), CancellationToken.None).ConfigureAwait(false);
  536. return ToOptimizedResult(result);
  537. }
  538. public object Post(GetPrograms request)
  539. {
  540. return Get(request);
  541. }
  542. public async Task<object> Get(GetRecordings request)
  543. {
  544. var options = GetDtoOptions(request);
  545. options.DeviceId = AuthorizationContext.GetAuthorizationInfo(Request).DeviceId;
  546. var result = await _liveTvManager.GetRecordings(new RecordingQuery
  547. {
  548. ChannelId = request.ChannelId,
  549. UserId = request.UserId,
  550. GroupId = request.GroupId,
  551. StartIndex = request.StartIndex,
  552. Limit = request.Limit,
  553. Status = request.Status,
  554. SeriesTimerId = request.SeriesTimerId,
  555. IsInProgress = request.IsInProgress
  556. }, options, CancellationToken.None).ConfigureAwait(false);
  557. return ToOptimizedResult(result);
  558. }
  559. public async Task<object> Get(GetRecording request)
  560. {
  561. var user = string.IsNullOrEmpty(request.UserId) ? null : _userManager.GetUserById(request.UserId);
  562. var options = new DtoOptions();
  563. options.DeviceId = AuthorizationContext.GetAuthorizationInfo(Request).DeviceId;
  564. var result = await _liveTvManager.GetRecording(request.Id, options, CancellationToken.None, user).ConfigureAwait(false);
  565. return ToOptimizedSerializedResultUsingCache(result);
  566. }
  567. public async Task<object> Get(GetTimer request)
  568. {
  569. var result = await _liveTvManager.GetTimer(request.Id, CancellationToken.None).ConfigureAwait(false);
  570. return ToOptimizedSerializedResultUsingCache(result);
  571. }
  572. public async Task<object> Get(GetTimers request)
  573. {
  574. var result = await _liveTvManager.GetTimers(new TimerQuery
  575. {
  576. ChannelId = request.ChannelId,
  577. SeriesTimerId = request.SeriesTimerId
  578. }, CancellationToken.None).ConfigureAwait(false);
  579. return ToOptimizedSerializedResultUsingCache(result);
  580. }
  581. public void Delete(DeleteRecording request)
  582. {
  583. AssertUserCanManageLiveTv();
  584. var task = _liveTvManager.DeleteRecording(request.Id);
  585. Task.WaitAll(task);
  586. }
  587. public void Delete(CancelTimer request)
  588. {
  589. AssertUserCanManageLiveTv();
  590. var task = _liveTvManager.CancelTimer(request.Id);
  591. Task.WaitAll(task);
  592. }
  593. public void Post(UpdateTimer request)
  594. {
  595. AssertUserCanManageLiveTv();
  596. var task = _liveTvManager.UpdateTimer(request, CancellationToken.None);
  597. Task.WaitAll(task);
  598. }
  599. public async Task<object> Get(GetSeriesTimers request)
  600. {
  601. var result = await _liveTvManager.GetSeriesTimers(new SeriesTimerQuery
  602. {
  603. SortOrder = request.SortOrder,
  604. SortBy = request.SortBy
  605. }, CancellationToken.None).ConfigureAwait(false);
  606. return ToOptimizedSerializedResultUsingCache(result);
  607. }
  608. public async Task<object> Get(GetSeriesTimer request)
  609. {
  610. var result = await _liveTvManager.GetSeriesTimer(request.Id, CancellationToken.None).ConfigureAwait(false);
  611. return ToOptimizedSerializedResultUsingCache(result);
  612. }
  613. public void Delete(CancelSeriesTimer request)
  614. {
  615. AssertUserCanManageLiveTv();
  616. var task = _liveTvManager.CancelSeriesTimer(request.Id);
  617. Task.WaitAll(task);
  618. }
  619. public void Post(UpdateSeriesTimer request)
  620. {
  621. AssertUserCanManageLiveTv();
  622. var task = _liveTvManager.UpdateSeriesTimer(request, CancellationToken.None);
  623. Task.WaitAll(task);
  624. }
  625. public async Task<object> Get(GetDefaultTimer request)
  626. {
  627. if (string.IsNullOrEmpty(request.ProgramId))
  628. {
  629. var result = await _liveTvManager.GetNewTimerDefaults(CancellationToken.None).ConfigureAwait(false);
  630. return ToOptimizedSerializedResultUsingCache(result);
  631. }
  632. else
  633. {
  634. var result = await _liveTvManager.GetNewTimerDefaults(request.ProgramId, CancellationToken.None).ConfigureAwait(false);
  635. return ToOptimizedSerializedResultUsingCache(result);
  636. }
  637. }
  638. public async Task<object> Get(GetProgram request)
  639. {
  640. var user = string.IsNullOrEmpty(request.UserId) ? null : _userManager.GetUserById(request.UserId);
  641. var result = await _liveTvManager.GetProgram(request.Id, CancellationToken.None, user).ConfigureAwait(false);
  642. return ToOptimizedSerializedResultUsingCache(result);
  643. }
  644. public void Post(CreateSeriesTimer request)
  645. {
  646. AssertUserCanManageLiveTv();
  647. var task = _liveTvManager.CreateSeriesTimer(request, CancellationToken.None);
  648. Task.WaitAll(task);
  649. }
  650. public void Post(CreateTimer request)
  651. {
  652. AssertUserCanManageLiveTv();
  653. var task = _liveTvManager.CreateTimer(request, CancellationToken.None);
  654. Task.WaitAll(task);
  655. }
  656. public async Task<object> Get(GetRecordingGroups request)
  657. {
  658. var result = await _liveTvManager.GetRecordingGroups(new RecordingGroupQuery
  659. {
  660. UserId = request.UserId
  661. }, CancellationToken.None).ConfigureAwait(false);
  662. return ToOptimizedSerializedResultUsingCache(result);
  663. }
  664. public async Task<object> Get(GetRecordingGroup request)
  665. {
  666. var result = await _liveTvManager.GetRecordingGroups(new RecordingGroupQuery
  667. {
  668. }, CancellationToken.None).ConfigureAwait(false);
  669. var group = result.Items.FirstOrDefault(i => string.Equals(i.Id, request.Id, StringComparison.OrdinalIgnoreCase));
  670. return ToOptimizedSerializedResultUsingCache(group);
  671. }
  672. public object Get(GetGuideInfo request)
  673. {
  674. return ToOptimizedResult(_liveTvManager.GetGuideInfo());
  675. }
  676. public void Post(ResetTuner request)
  677. {
  678. AssertUserCanManageLiveTv();
  679. var task = _liveTvManager.ResetTuner(request.Id, CancellationToken.None);
  680. Task.WaitAll(task);
  681. }
  682. }
  683. }