ItemByNameUserDataService.cs 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300
  1. using MediaBrowser.Controller.Entities;
  2. using MediaBrowser.Controller.Library;
  3. using MediaBrowser.Controller.Persistence;
  4. using ServiceStack.ServiceHost;
  5. using ServiceStack.Text.Controller;
  6. using System;
  7. using System.Threading;
  8. using System.Threading.Tasks;
  9. namespace MediaBrowser.Api.UserLibrary
  10. {
  11. /// <summary>
  12. /// Class MarkItemByNameFavorite
  13. /// </summary>
  14. [Route("/Users/{UserId}/Favorites/Artists/{Name}", "POST")]
  15. [Route("/Users/{UserId}/Favorites/Persons/{Name}", "POST")]
  16. [Route("/Users/{UserId}/Favorites/Studios/{Name}", "POST")]
  17. [Route("/Users/{UserId}/Favorites/Genres/{Name}", "POST")]
  18. [Route("/Users/{UserId}/Favorites/MusicGenres/{Name}", "POST")]
  19. [Api(Description = "Marks something as a favorite")]
  20. public class MarkItemByNameFavorite : IReturnVoid
  21. {
  22. /// <summary>
  23. /// Gets or sets the user id.
  24. /// </summary>
  25. /// <value>The user id.</value>
  26. [ApiMember(Name = "UserId", Description = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  27. public Guid UserId { get; set; }
  28. /// <summary>
  29. /// Gets or sets the name.
  30. /// </summary>
  31. /// <value>The name.</value>
  32. [ApiMember(Name = "Name", Description = "The name", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  33. public string Name { get; set; }
  34. }
  35. /// <summary>
  36. /// Class UnmarkItemByNameFavorite
  37. /// </summary>
  38. [Route("/Users/{UserId}/Favorites/Artists/{Name}", "DELETE")]
  39. [Route("/Users/{UserId}/Favorites/Persons/{Name}", "DELETE")]
  40. [Route("/Users/{UserId}/Favorites/Studios/{Name}", "DELETE")]
  41. [Route("/Users/{UserId}/Favorites/Genres/{Name}", "DELETE")]
  42. [Route("/Users/{UserId}/Favorites/MusicGenres/{Name}", "DELETE")]
  43. [Api(Description = "Unmarks something as a favorite")]
  44. public class UnmarkItemByNameFavorite : IReturnVoid
  45. {
  46. /// <summary>
  47. /// Gets or sets the user id.
  48. /// </summary>
  49. /// <value>The user id.</value>
  50. [ApiMember(Name = "UserId", Description = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")]
  51. public Guid UserId { get; set; }
  52. /// <summary>
  53. /// Gets or sets the name.
  54. /// </summary>
  55. /// <value>The name.</value>
  56. [ApiMember(Name = "Name", Description = "The name", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")]
  57. public string Name { get; set; }
  58. }
  59. /// <summary>
  60. /// Class UpdateItemByNameRating
  61. /// </summary>
  62. [Route("/Users/{UserId}/Ratings/Artists/{Name}", "POST")]
  63. [Route("/Users/{UserId}/Ratings/Persons/{Name}", "POST")]
  64. [Route("/Users/{UserId}/Ratings/Studios/{Name}", "POST")]
  65. [Route("/Users/{UserId}/Ratings/Genres/{Name}", "POST")]
  66. [Route("/Users/{UserId}/Ratings/MusicGenres/{Name}", "POST")]
  67. [Api(Description = "Updates a user's rating for an item")]
  68. public class UpdateItemByNameRating : IReturnVoid
  69. {
  70. /// <summary>
  71. /// Gets or sets the user id.
  72. /// </summary>
  73. /// <value>The user id.</value>
  74. [ApiMember(Name = "UserId", Description = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  75. public Guid UserId { get; set; }
  76. /// <summary>
  77. /// Gets or sets the name.
  78. /// </summary>
  79. /// <value>The name.</value>
  80. [ApiMember(Name = "Name", Description = "The name", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  81. public string Name { get; set; }
  82. /// <summary>
  83. /// Gets or sets a value indicating whether this <see cref="UpdateUserItemRating" /> is likes.
  84. /// </summary>
  85. /// <value><c>true</c> if likes; otherwise, <c>false</c>.</value>
  86. [ApiMember(Name = "Likes", Description = "Whether the user likes the item or not. true/false", IsRequired = true, DataType = "boolean", ParameterType = "query", Verb = "POST")]
  87. public bool Likes { get; set; }
  88. }
  89. /// <summary>
  90. /// Class DeleteItemByNameRating
  91. /// </summary>
  92. [Route("/Users/{UserId}/Ratings/Artists/{Name}", "DELETE")]
  93. [Route("/Users/{UserId}/Ratings/Persons/{Name}", "DELETE")]
  94. [Route("/Users/{UserId}/Ratings/Studios/{Name}", "DELETE")]
  95. [Route("/Users/{UserId}/Ratings/Genres/{Name}", "DELETE")]
  96. [Route("/Users/{UserId}/Ratings/MusicGenres/{Name}", "DELETE")]
  97. [Api(Description = "Deletes a user's saved personal rating for an item")]
  98. public class DeleteItemByNameRating : IReturnVoid
  99. {
  100. /// <summary>
  101. /// Gets or sets the user id.
  102. /// </summary>
  103. /// <value>The user id.</value>
  104. [ApiMember(Name = "UserId", Description = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")]
  105. public Guid UserId { get; set; }
  106. /// <summary>
  107. /// Gets or sets the name.
  108. /// </summary>
  109. /// <value>The name.</value>
  110. [ApiMember(Name = "Name", Description = "The item name (genre, person, year, studio, artist)", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")]
  111. public string Name { get; set; }
  112. }
  113. /// <summary>
  114. /// Class ItemByNameUserDataService
  115. /// </summary>
  116. public class ItemByNameUserDataService : BaseApiService
  117. {
  118. /// <summary>
  119. /// The user data repository
  120. /// </summary>
  121. protected readonly IUserDataRepository UserDataRepository;
  122. /// <summary>
  123. /// The library manager
  124. /// </summary>
  125. protected readonly ILibraryManager LibraryManager;
  126. /// <summary>
  127. /// Initializes a new instance of the <see cref="ItemByNameUserDataService" /> class.
  128. /// </summary>
  129. /// <param name="userDataRepository">The user data repository.</param>
  130. /// <param name="libraryManager">The library manager.</param>
  131. public ItemByNameUserDataService(IUserDataRepository userDataRepository, ILibraryManager libraryManager)
  132. {
  133. UserDataRepository = userDataRepository;
  134. LibraryManager = libraryManager;
  135. }
  136. /// <summary>
  137. /// Posts the specified request.
  138. /// </summary>
  139. /// <param name="request">The request.</param>
  140. public void Post(MarkItemByNameFavorite request)
  141. {
  142. var pathInfo = PathInfo.Parse(RequestContext.PathInfo);
  143. var type = pathInfo.GetArgumentValue<string>(3);
  144. var task = MarkFavorite(request.UserId, type, request.Name, true);
  145. Task.WaitAll(task);
  146. }
  147. /// <summary>
  148. /// Posts the specified request.
  149. /// </summary>
  150. /// <param name="request">The request.</param>
  151. public void Post(UpdateItemByNameRating request)
  152. {
  153. var pathInfo = PathInfo.Parse(RequestContext.PathInfo);
  154. var type = pathInfo.GetArgumentValue<string>(3);
  155. var task = MarkLike(request.UserId, type, request.Name, request.Likes);
  156. Task.WaitAll(task);
  157. }
  158. /// <summary>
  159. /// Deletes the specified request.
  160. /// </summary>
  161. /// <param name="request">The request.</param>
  162. public void Delete(UnmarkItemByNameFavorite request)
  163. {
  164. var pathInfo = PathInfo.Parse(RequestContext.PathInfo);
  165. var type = pathInfo.GetArgumentValue<string>(3);
  166. var task = MarkFavorite(request.UserId, type, request.Name, false);
  167. Task.WaitAll(task);
  168. }
  169. /// <summary>
  170. /// Deletes the specified request.
  171. /// </summary>
  172. /// <param name="request">The request.</param>
  173. public void Delete(DeleteItemByNameRating request)
  174. {
  175. var pathInfo = PathInfo.Parse(RequestContext.PathInfo);
  176. var type = pathInfo.GetArgumentValue<string>(3);
  177. var task = MarkLike(request.UserId, type, request.Name, null);
  178. Task.WaitAll(task);
  179. }
  180. /// <summary>
  181. /// Marks the favorite.
  182. /// </summary>
  183. /// <param name="userId">The user id.</param>
  184. /// <param name="type">The type.</param>
  185. /// <param name="name">The name.</param>
  186. /// <param name="isFavorite">if set to <c>true</c> [is favorite].</param>
  187. /// <returns>Task.</returns>
  188. protected async Task MarkFavorite(Guid userId, string type, string name, bool isFavorite)
  189. {
  190. BaseItem item;
  191. if (string.Equals(type, "Persons"))
  192. {
  193. item = await GetPerson(name, LibraryManager).ConfigureAwait(false);
  194. }
  195. else if (string.Equals(type, "Artists"))
  196. {
  197. item = await GetArtist(name, LibraryManager).ConfigureAwait(false);
  198. }
  199. else if (string.Equals(type, "Genres"))
  200. {
  201. item = await GetGenre(name, LibraryManager).ConfigureAwait(false);
  202. }
  203. else if (string.Equals(type, "MusicGenres"))
  204. {
  205. item = await GetMusicGenre(name, LibraryManager).ConfigureAwait(false);
  206. }
  207. else if (string.Equals(type, "Studios"))
  208. {
  209. item = await GetStudio(name, LibraryManager).ConfigureAwait(false);
  210. }
  211. else
  212. {
  213. throw new ArgumentException();
  214. }
  215. var key = item.GetUserDataKey();
  216. // Get the user data for this item
  217. var data = UserDataRepository.GetUserData(userId, key);
  218. // Set favorite status
  219. data.IsFavorite = isFavorite;
  220. await UserDataRepository.SaveUserData(userId, key, data, CancellationToken.None).ConfigureAwait(false);
  221. }
  222. /// <summary>
  223. /// Marks the like.
  224. /// </summary>
  225. /// <param name="userId">The user id.</param>
  226. /// <param name="type">The type.</param>
  227. /// <param name="name">The name.</param>
  228. /// <param name="likes">if set to <c>true</c> [likes].</param>
  229. /// <returns>Task.</returns>
  230. protected async Task MarkLike(Guid userId, string type, string name, bool? likes)
  231. {
  232. BaseItem item;
  233. if (string.Equals(type, "Persons"))
  234. {
  235. item = await GetPerson(name, LibraryManager).ConfigureAwait(false);
  236. }
  237. else if (string.Equals(type, "Artists"))
  238. {
  239. item = await GetArtist(name, LibraryManager).ConfigureAwait(false);
  240. }
  241. else if (string.Equals(type, "Genres"))
  242. {
  243. item = await GetGenre(name, LibraryManager).ConfigureAwait(false);
  244. }
  245. else if (string.Equals(type, "MusicGenres"))
  246. {
  247. item = await GetMusicGenre(name, LibraryManager).ConfigureAwait(false);
  248. }
  249. else if (string.Equals(type, "Studios"))
  250. {
  251. item = await GetStudio(name, LibraryManager).ConfigureAwait(false);
  252. }
  253. else
  254. {
  255. throw new ArgumentException();
  256. }
  257. var key = item.GetUserDataKey();
  258. // Get the user data for this item
  259. var data = UserDataRepository.GetUserData(userId, key);
  260. data.Likes = likes;
  261. await UserDataRepository.SaveUserData(userId, key, data, CancellationToken.None).ConfigureAwait(false);
  262. }
  263. }
  264. }