ImageService.cs 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Globalization;
  4. using System.IO;
  5. using System.Linq;
  6. using System.Threading;
  7. using System.Threading.Tasks;
  8. using MediaBrowser.Common.Extensions;
  9. using MediaBrowser.Controller.Configuration;
  10. using MediaBrowser.Controller.Drawing;
  11. using MediaBrowser.Controller.Dto;
  12. using MediaBrowser.Controller.Entities;
  13. using MediaBrowser.Controller.Library;
  14. using MediaBrowser.Controller.Net;
  15. using MediaBrowser.Controller.Providers;
  16. using MediaBrowser.Model.Drawing;
  17. using MediaBrowser.Model.Dto;
  18. using MediaBrowser.Model.Entities;
  19. using MediaBrowser.Model.IO;
  20. using MediaBrowser.Model.Net;
  21. using MediaBrowser.Model.Services;
  22. using Microsoft.Extensions.Logging;
  23. using Microsoft.Net.Http.Headers;
  24. using User = Jellyfin.Data.Entities.User;
  25. namespace MediaBrowser.Api.Images
  26. {
  27. /// <summary>
  28. /// Class GetItemImage.
  29. /// </summary>
  30. [Route("/Items/{Id}/Images", "GET", Summary = "Gets information about an item's images")]
  31. [Authenticated]
  32. public class GetItemImageInfos : IReturn<List<ImageInfo>>
  33. {
  34. /// <summary>
  35. /// Gets or sets the id.
  36. /// </summary>
  37. /// <value>The id.</value>
  38. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  39. public string Id { get; set; }
  40. }
  41. [Route("/Items/{Id}/Images/{Type}", "GET")]
  42. [Route("/Items/{Id}/Images/{Type}/{Index}", "GET")]
  43. [Route("/Items/{Id}/Images/{Type}", "HEAD")]
  44. [Route("/Items/{Id}/Images/{Type}/{Index}", "HEAD")]
  45. [Route("/Items/{Id}/Images/{Type}/{Index}/{Tag}/{Format}/{MaxWidth}/{MaxHeight}/{PercentPlayed}/{UnplayedCount}", "GET")]
  46. [Route("/Items/{Id}/Images/{Type}/{Index}/{Tag}/{Format}/{MaxWidth}/{MaxHeight}/{PercentPlayed}/{UnplayedCount}", "HEAD")]
  47. public class GetItemImage : ImageRequest
  48. {
  49. /// <summary>
  50. /// Gets or sets the id.
  51. /// </summary>
  52. /// <value>The id.</value>
  53. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path")]
  54. public Guid Id { get; set; }
  55. }
  56. /// <summary>
  57. /// Class UpdateItemImageIndex
  58. /// </summary>
  59. [Route("/Items/{Id}/Images/{Type}/{Index}/Index", "POST", Summary = "Updates the index for an item image")]
  60. [Authenticated(Roles = "admin")]
  61. public class UpdateItemImageIndex : IReturnVoid
  62. {
  63. /// <summary>
  64. /// Gets or sets the id.
  65. /// </summary>
  66. /// <value>The id.</value>
  67. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  68. public string Id { get; set; }
  69. /// <summary>
  70. /// Gets or sets the type of the image.
  71. /// </summary>
  72. /// <value>The type of the image.</value>
  73. [ApiMember(Name = "Type", Description = "Image Type", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  74. public ImageType Type { get; set; }
  75. /// <summary>
  76. /// Gets or sets the index.
  77. /// </summary>
  78. /// <value>The index.</value>
  79. [ApiMember(Name = "Index", Description = "Image Index", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "POST")]
  80. public int Index { get; set; }
  81. /// <summary>
  82. /// Gets or sets the new index.
  83. /// </summary>
  84. /// <value>The new index.</value>
  85. [ApiMember(Name = "NewIndex", Description = "The new image index", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "POST")]
  86. public int NewIndex { get; set; }
  87. }
  88. /// <summary>
  89. /// Class GetPersonImage
  90. /// </summary>
  91. [Route("/Artists/{Name}/Images/{Type}", "GET")]
  92. [Route("/Artists/{Name}/Images/{Type}/{Index}", "GET")]
  93. [Route("/Genres/{Name}/Images/{Type}", "GET")]
  94. [Route("/Genres/{Name}/Images/{Type}/{Index}", "GET")]
  95. [Route("/MusicGenres/{Name}/Images/{Type}", "GET")]
  96. [Route("/MusicGenres/{Name}/Images/{Type}/{Index}", "GET")]
  97. [Route("/Persons/{Name}/Images/{Type}", "GET")]
  98. [Route("/Persons/{Name}/Images/{Type}/{Index}", "GET")]
  99. [Route("/Studios/{Name}/Images/{Type}", "GET")]
  100. [Route("/Studios/{Name}/Images/{Type}/{Index}", "GET")]
  101. ////[Route("/Years/{Year}/Images/{Type}", "GET")]
  102. ////[Route("/Years/{Year}/Images/{Type}/{Index}", "GET")]
  103. [Route("/Artists/{Name}/Images/{Type}", "HEAD")]
  104. [Route("/Artists/{Name}/Images/{Type}/{Index}", "HEAD")]
  105. [Route("/Genres/{Name}/Images/{Type}", "HEAD")]
  106. [Route("/Genres/{Name}/Images/{Type}/{Index}", "HEAD")]
  107. [Route("/MusicGenres/{Name}/Images/{Type}", "HEAD")]
  108. [Route("/MusicGenres/{Name}/Images/{Type}/{Index}", "HEAD")]
  109. [Route("/Persons/{Name}/Images/{Type}", "HEAD")]
  110. [Route("/Persons/{Name}/Images/{Type}/{Index}", "HEAD")]
  111. [Route("/Studios/{Name}/Images/{Type}", "HEAD")]
  112. [Route("/Studios/{Name}/Images/{Type}/{Index}", "HEAD")]
  113. ////[Route("/Years/{Year}/Images/{Type}", "HEAD")]
  114. ////[Route("/Years/{Year}/Images/{Type}/{Index}", "HEAD")]
  115. public class GetItemByNameImage : ImageRequest
  116. {
  117. /// <summary>
  118. /// Gets or sets the name.
  119. /// </summary>
  120. /// <value>The name.</value>
  121. [ApiMember(Name = "Name", Description = "Item name", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  122. public string Name { get; set; }
  123. }
  124. /// <summary>
  125. /// Class GetUserImage
  126. /// </summary>
  127. [Route("/Users/{Id}/Images/{Type}", "GET")]
  128. [Route("/Users/{Id}/Images/{Type}/{Index}", "GET")]
  129. [Route("/Users/{Id}/Images/{Type}", "HEAD")]
  130. [Route("/Users/{Id}/Images/{Type}/{Index}", "HEAD")]
  131. public class GetUserImage : ImageRequest
  132. {
  133. /// <summary>
  134. /// Gets or sets the id.
  135. /// </summary>
  136. /// <value>The id.</value>
  137. [ApiMember(Name = "Id", Description = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  138. public Guid Id { get; set; }
  139. }
  140. /// <summary>
  141. /// Class DeleteItemImage
  142. /// </summary>
  143. [Route("/Items/{Id}/Images/{Type}", "DELETE")]
  144. [Route("/Items/{Id}/Images/{Type}/{Index}", "DELETE")]
  145. [Authenticated(Roles = "admin")]
  146. public class DeleteItemImage : DeleteImageRequest, IReturnVoid
  147. {
  148. /// <summary>
  149. /// Gets or sets the id.
  150. /// </summary>
  151. /// <value>The id.</value>
  152. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")]
  153. public string Id { get; set; }
  154. }
  155. /// <summary>
  156. /// Class DeleteUserImage
  157. /// </summary>
  158. [Route("/Users/{Id}/Images/{Type}", "DELETE")]
  159. [Route("/Users/{Id}/Images/{Type}/{Index}", "DELETE")]
  160. [Authenticated]
  161. public class DeleteUserImage : DeleteImageRequest, IReturnVoid
  162. {
  163. /// <summary>
  164. /// Gets or sets the id.
  165. /// </summary>
  166. /// <value>The id.</value>
  167. [ApiMember(Name = "Id", Description = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")]
  168. public Guid Id { get; set; }
  169. }
  170. /// <summary>
  171. /// Class PostUserImage
  172. /// </summary>
  173. [Route("/Users/{Id}/Images/{Type}", "POST")]
  174. [Route("/Users/{Id}/Images/{Type}/{Index}", "POST")]
  175. [Authenticated]
  176. public class PostUserImage : DeleteImageRequest, IRequiresRequestStream, IReturnVoid
  177. {
  178. /// <summary>
  179. /// Gets or sets the id.
  180. /// </summary>
  181. /// <value>The id.</value>
  182. [ApiMember(Name = "Id", Description = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  183. public string Id { get; set; }
  184. /// <summary>
  185. /// The raw Http Request Input Stream
  186. /// </summary>
  187. /// <value>The request stream.</value>
  188. public Stream RequestStream { get; set; }
  189. }
  190. /// <summary>
  191. /// Class PostItemImage
  192. /// </summary>
  193. [Route("/Items/{Id}/Images/{Type}", "POST")]
  194. [Route("/Items/{Id}/Images/{Type}/{Index}", "POST")]
  195. [Authenticated(Roles = "admin")]
  196. public class PostItemImage : DeleteImageRequest, IRequiresRequestStream, IReturnVoid
  197. {
  198. /// <summary>
  199. /// Gets or sets the id.
  200. /// </summary>
  201. /// <value>The id.</value>
  202. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  203. public string Id { get; set; }
  204. /// <summary>
  205. /// The raw Http Request Input Stream
  206. /// </summary>
  207. /// <value>The request stream.</value>
  208. public Stream RequestStream { get; set; }
  209. }
  210. /// <summary>
  211. /// Class ImageService
  212. /// </summary>
  213. public class ImageService : BaseApiService
  214. {
  215. private readonly IUserManager _userManager;
  216. private readonly ILibraryManager _libraryManager;
  217. private readonly IProviderManager _providerManager;
  218. private readonly IImageProcessor _imageProcessor;
  219. private readonly IFileSystem _fileSystem;
  220. private readonly IAuthorizationContext _authContext;
  221. /// <summary>
  222. /// Initializes a new instance of the <see cref="ImageService" /> class.
  223. /// </summary>
  224. public ImageService(
  225. ILogger<ImageService> logger,
  226. IServerConfigurationManager serverConfigurationManager,
  227. IHttpResultFactory httpResultFactory,
  228. IUserManager userManager,
  229. ILibraryManager libraryManager,
  230. IProviderManager providerManager,
  231. IImageProcessor imageProcessor,
  232. IFileSystem fileSystem,
  233. IAuthorizationContext authContext)
  234. : base(logger, serverConfigurationManager, httpResultFactory)
  235. {
  236. _userManager = userManager;
  237. _libraryManager = libraryManager;
  238. _providerManager = providerManager;
  239. _imageProcessor = imageProcessor;
  240. _fileSystem = fileSystem;
  241. _authContext = authContext;
  242. }
  243. /// <summary>
  244. /// Gets the specified request.
  245. /// </summary>
  246. /// <param name="request">The request.</param>
  247. /// <returns>System.Object.</returns>
  248. public object Get(GetItemImageInfos request)
  249. {
  250. var item = _libraryManager.GetItemById(request.Id);
  251. var result = GetItemImageInfos(item);
  252. return ToOptimizedResult(result);
  253. }
  254. /// <summary>
  255. /// Gets the item image infos.
  256. /// </summary>
  257. /// <param name="item">The item.</param>
  258. /// <returns>Task{List{ImageInfo}}.</returns>
  259. public List<ImageInfo> GetItemImageInfos(BaseItem item)
  260. {
  261. var list = new List<ImageInfo>();
  262. var itemImages = item.ImageInfos;
  263. foreach (var image in itemImages)
  264. {
  265. if (!item.AllowsMultipleImages(image.Type))
  266. {
  267. var info = GetImageInfo(item, image, null);
  268. if (info != null)
  269. {
  270. list.Add(info);
  271. }
  272. }
  273. }
  274. foreach (var imageType in itemImages.Select(i => i.Type).Distinct().Where(item.AllowsMultipleImages))
  275. {
  276. var index = 0;
  277. // Prevent implicitly captured closure
  278. var currentImageType = imageType;
  279. foreach (var image in itemImages.Where(i => i.Type == currentImageType))
  280. {
  281. var info = GetImageInfo(item, image, index);
  282. if (info != null)
  283. {
  284. list.Add(info);
  285. }
  286. index++;
  287. }
  288. }
  289. return list;
  290. }
  291. private ImageInfo GetImageInfo(BaseItem item, ItemImageInfo info, int? imageIndex)
  292. {
  293. int? width = null;
  294. int? height = null;
  295. long length = 0;
  296. try
  297. {
  298. if (info.IsLocalFile)
  299. {
  300. var fileInfo = _fileSystem.GetFileInfo(info.Path);
  301. length = fileInfo.Length;
  302. ImageDimensions size = _imageProcessor.GetImageDimensions(item, info);
  303. _libraryManager.UpdateImages(item);
  304. width = size.Width;
  305. height = size.Height;
  306. if (width <= 0 || height <= 0)
  307. {
  308. width = null;
  309. height = null;
  310. }
  311. }
  312. }
  313. catch (Exception ex)
  314. {
  315. Logger.LogError(ex, "Error getting image information for {Item}", item.Name);
  316. }
  317. try
  318. {
  319. return new ImageInfo
  320. {
  321. Path = info.Path,
  322. ImageIndex = imageIndex,
  323. ImageType = info.Type,
  324. ImageTag = _imageProcessor.GetImageCacheTag(item, info),
  325. Size = length,
  326. Width = width,
  327. Height = height
  328. };
  329. }
  330. catch (Exception ex)
  331. {
  332. Logger.LogError(ex, "Error getting image information for {Path}", info.Path);
  333. return null;
  334. }
  335. }
  336. /// <summary>
  337. /// Gets the specified request.
  338. /// </summary>
  339. /// <param name="request">The request.</param>
  340. /// <returns>System.Object.</returns>
  341. public object Get(GetItemImage request)
  342. {
  343. return GetImage(request, request.Id, null, false);
  344. }
  345. /// <summary>
  346. /// Gets the specified request.
  347. /// </summary>
  348. /// <param name="request">The request.</param>
  349. /// <returns>System.Object.</returns>
  350. public object Head(GetItemImage request)
  351. {
  352. return GetImage(request, request.Id, null, true);
  353. }
  354. /// <summary>
  355. /// Gets the specified request.
  356. /// </summary>
  357. /// <param name="request">The request.</param>
  358. /// <returns>System.Object.</returns>
  359. public object Get(GetUserImage request)
  360. {
  361. var item = _userManager.GetUserById(request.Id);
  362. return GetImage(request, item, false);
  363. }
  364. public object Head(GetUserImage request)
  365. {
  366. var item = _userManager.GetUserById(request.Id);
  367. return GetImage(request, item, true);
  368. }
  369. public object Get(GetItemByNameImage request)
  370. {
  371. var type = GetPathValue(0).ToString();
  372. var item = GetItemByName(request.Name, type, _libraryManager, new DtoOptions(false));
  373. return GetImage(request, item.Id, item, false);
  374. }
  375. public object Head(GetItemByNameImage request)
  376. {
  377. var type = GetPathValue(0).ToString();
  378. var item = GetItemByName(request.Name, type, _libraryManager, new DtoOptions(false));
  379. return GetImage(request, item.Id, item, true);
  380. }
  381. /// <summary>
  382. /// Posts the specified request.
  383. /// </summary>
  384. /// <param name="request">The request.</param>
  385. public Task Post(PostUserImage request)
  386. {
  387. var id = Guid.Parse(GetPathValue(1));
  388. AssertCanUpdateUser(_authContext, _userManager, id, true);
  389. request.Type = Enum.Parse<ImageType>(GetPathValue(3).ToString(), true);
  390. var user = _userManager.GetUserById(id);
  391. return PostImage(user, request.RequestStream, Request.ContentType);
  392. }
  393. /// <summary>
  394. /// Posts the specified request.
  395. /// </summary>
  396. /// <param name="request">The request.</param>
  397. public Task Post(PostItemImage request)
  398. {
  399. var id = Guid.Parse(GetPathValue(1));
  400. request.Type = Enum.Parse<ImageType>(GetPathValue(3).ToString(), true);
  401. var item = _libraryManager.GetItemById(id);
  402. return PostImage(item, request.RequestStream, request.Type, Request.ContentType);
  403. }
  404. /// <summary>
  405. /// Deletes the specified request.
  406. /// </summary>
  407. /// <param name="request">The request.</param>
  408. public void Delete(DeleteUserImage request)
  409. {
  410. var userId = request.Id;
  411. AssertCanUpdateUser(_authContext, _userManager, userId, true);
  412. var user = _userManager.GetUserById(userId);
  413. user.ProfileImage = null;
  414. }
  415. /// <summary>
  416. /// Deletes the specified request.
  417. /// </summary>
  418. /// <param name="request">The request.</param>
  419. public void Delete(DeleteItemImage request)
  420. {
  421. var item = _libraryManager.GetItemById(request.Id);
  422. item.DeleteImage(request.Type, request.Index ?? 0);
  423. }
  424. /// <summary>
  425. /// Posts the specified request.
  426. /// </summary>
  427. /// <param name="request">The request.</param>
  428. public void Post(UpdateItemImageIndex request)
  429. {
  430. var item = _libraryManager.GetItemById(request.Id);
  431. UpdateItemIndex(item, request.Type, request.Index, request.NewIndex);
  432. }
  433. /// <summary>
  434. /// Updates the index of the item.
  435. /// </summary>
  436. /// <param name="item">The item.</param>
  437. /// <param name="type">The type.</param>
  438. /// <param name="currentIndex">Index of the current.</param>
  439. /// <param name="newIndex">The new index.</param>
  440. /// <returns>Task.</returns>
  441. private void UpdateItemIndex(BaseItem item, ImageType type, int currentIndex, int newIndex)
  442. {
  443. item.SwapImages(type, currentIndex, newIndex);
  444. }
  445. /// <summary>
  446. /// Gets the image.
  447. /// </summary>
  448. /// <param name="request">The request.</param>
  449. /// <param name="item">The item.</param>
  450. /// <param name="isHeadRequest">if set to <c>true</c> [is head request].</param>
  451. /// <returns>System.Object.</returns>
  452. /// <exception cref="ResourceNotFoundException"></exception>
  453. public Task<object> GetImage(ImageRequest request, Guid itemId, BaseItem item, bool isHeadRequest)
  454. {
  455. if (request.PercentPlayed.HasValue)
  456. {
  457. if (request.PercentPlayed.Value <= 0)
  458. {
  459. request.PercentPlayed = null;
  460. }
  461. else if (request.PercentPlayed.Value >= 100)
  462. {
  463. request.PercentPlayed = null;
  464. request.AddPlayedIndicator = true;
  465. }
  466. }
  467. if (request.PercentPlayed.HasValue)
  468. {
  469. request.UnplayedCount = null;
  470. }
  471. if (request.UnplayedCount.HasValue
  472. && request.UnplayedCount.Value <= 0)
  473. {
  474. request.UnplayedCount = null;
  475. }
  476. if (item == null)
  477. {
  478. item = _libraryManager.GetItemById(itemId);
  479. if (item == null)
  480. {
  481. throw new ResourceNotFoundException(string.Format("Item {0} not found.", itemId.ToString("N", CultureInfo.InvariantCulture)));
  482. }
  483. }
  484. var imageInfo = GetImageInfo(request, item);
  485. if (imageInfo == null)
  486. {
  487. throw new ResourceNotFoundException(string.Format("{0} does not have an image of type {1}", item.Name, request.Type));
  488. }
  489. bool cropWhitespace;
  490. if (request.CropWhitespace.HasValue)
  491. {
  492. cropWhitespace = request.CropWhitespace.Value;
  493. }
  494. else
  495. {
  496. cropWhitespace = request.Type == ImageType.Logo || request.Type == ImageType.Art;
  497. }
  498. var outputFormats = GetOutputFormats(request);
  499. TimeSpan? cacheDuration = null;
  500. if (!string.IsNullOrEmpty(request.Tag))
  501. {
  502. cacheDuration = TimeSpan.FromDays(365);
  503. }
  504. var responseHeaders = new Dictionary<string, string>
  505. {
  506. {"transferMode.dlna.org", "Interactive"},
  507. {"realTimeInfo.dlna.org", "DLNA.ORG_TLAG=*"}
  508. };
  509. return GetImageResult(
  510. item,
  511. itemId,
  512. request,
  513. imageInfo,
  514. cropWhitespace,
  515. outputFormats,
  516. cacheDuration,
  517. responseHeaders,
  518. isHeadRequest);
  519. }
  520. public Task<object> GetImage(ImageRequest request, User user, bool isHeadRequest)
  521. {
  522. var imageInfo = GetImageInfo(request, user);
  523. TimeSpan? cacheDuration = null;
  524. if (!string.IsNullOrEmpty(request.Tag))
  525. {
  526. cacheDuration = TimeSpan.FromDays(365);
  527. }
  528. var responseHeaders = new Dictionary<string, string>
  529. {
  530. {"transferMode.dlna.org", "Interactive"},
  531. {"realTimeInfo.dlna.org", "DLNA.ORG_TLAG=*"}
  532. };
  533. var outputFormats = GetOutputFormats(request);
  534. return GetImageResult(
  535. user,
  536. user.Id,
  537. request,
  538. imageInfo,
  539. false,
  540. outputFormats,
  541. cacheDuration,
  542. responseHeaders,
  543. isHeadRequest);
  544. }
  545. private async Task<object> GetImageResult(
  546. User user,
  547. Guid itemId,
  548. ImageRequest request,
  549. ItemImageInfo info,
  550. bool cropWhitespace,
  551. IReadOnlyCollection<ImageFormat> supportedFormats,
  552. TimeSpan? cacheDuration,
  553. IDictionary<string, string> headers,
  554. bool isHeadRequest)
  555. {
  556. var options = new ImageProcessingOptions
  557. {
  558. CropWhiteSpace = true,
  559. Height = request.Height,
  560. ImageIndex = request.Index ?? 0,
  561. Image = info,
  562. Item = null, // Hack alert
  563. ItemId = itemId,
  564. MaxHeight = request.MaxHeight,
  565. MaxWidth = request.MaxWidth,
  566. Quality = request.Quality ?? 100,
  567. Width = request.Width,
  568. AddPlayedIndicator = request.AddPlayedIndicator,
  569. PercentPlayed = 0,
  570. UnplayedCount = request.UnplayedCount,
  571. Blur = request.Blur,
  572. BackgroundColor = request.BackgroundColor,
  573. ForegroundLayer = request.ForegroundLayer,
  574. SupportedOutputFormats = supportedFormats
  575. };
  576. var imageResult = await _imageProcessor.ProcessImage(options).ConfigureAwait(false);
  577. headers[HeaderNames.Vary] = HeaderNames.Accept;
  578. return await ResultFactory.GetStaticFileResult(Request, new StaticFileResultOptions
  579. {
  580. CacheDuration = cacheDuration,
  581. ResponseHeaders = headers,
  582. ContentType = imageResult.Item2,
  583. DateLastModified = imageResult.Item3,
  584. IsHeadRequest = isHeadRequest,
  585. Path = imageResult.Item1,
  586. FileShare = FileShare.Read
  587. }).ConfigureAwait(false);
  588. }
  589. private async Task<object> GetImageResult(
  590. BaseItem item,
  591. Guid itemId,
  592. ImageRequest request,
  593. ItemImageInfo image,
  594. bool cropwhitespace,
  595. IReadOnlyCollection<ImageFormat> supportedFormats,
  596. TimeSpan? cacheDuration,
  597. IDictionary<string, string> headers,
  598. bool isHeadRequest)
  599. {
  600. if (!image.IsLocalFile)
  601. {
  602. item ??= _libraryManager.GetItemById(itemId);
  603. image = await _libraryManager.ConvertImageToLocal(item, image, request.Index ?? 0).ConfigureAwait(false);
  604. }
  605. var options = new ImageProcessingOptions
  606. {
  607. CropWhiteSpace = cropwhitespace,
  608. Height = request.Height,
  609. ImageIndex = request.Index ?? 0,
  610. Image = image,
  611. Item = item,
  612. ItemId = itemId,
  613. MaxHeight = request.MaxHeight,
  614. MaxWidth = request.MaxWidth,
  615. Quality = request.Quality ?? 100,
  616. Width = request.Width,
  617. AddPlayedIndicator = request.AddPlayedIndicator,
  618. PercentPlayed = request.PercentPlayed ?? 0,
  619. UnplayedCount = request.UnplayedCount,
  620. Blur = request.Blur,
  621. BackgroundColor = request.BackgroundColor,
  622. ForegroundLayer = request.ForegroundLayer,
  623. SupportedOutputFormats = supportedFormats
  624. };
  625. var imageResult = await _imageProcessor.ProcessImage(options).ConfigureAwait(false);
  626. headers[HeaderNames.Vary] = HeaderNames.Accept;
  627. return await ResultFactory.GetStaticFileResult(Request, new StaticFileResultOptions
  628. {
  629. CacheDuration = cacheDuration,
  630. ResponseHeaders = headers,
  631. ContentType = imageResult.Item2,
  632. DateLastModified = imageResult.Item3,
  633. IsHeadRequest = isHeadRequest,
  634. Path = imageResult.Item1,
  635. FileShare = FileShare.Read
  636. }).ConfigureAwait(false);
  637. }
  638. private ImageFormat[] GetOutputFormats(ImageRequest request)
  639. {
  640. if (!string.IsNullOrWhiteSpace(request.Format)
  641. && Enum.TryParse(request.Format, true, out ImageFormat format))
  642. {
  643. return new[] { format };
  644. }
  645. return GetClientSupportedFormats();
  646. }
  647. private ImageFormat[] GetClientSupportedFormats()
  648. {
  649. var supportedFormats = Request.AcceptTypes ?? Array.Empty<string>();
  650. if (supportedFormats.Length > 0)
  651. {
  652. for (int i = 0; i < supportedFormats.Length; i++)
  653. {
  654. int index = supportedFormats[i].IndexOf(';');
  655. if (index != -1)
  656. {
  657. supportedFormats[i] = supportedFormats[i].Substring(0, index);
  658. }
  659. }
  660. }
  661. var acceptParam = Request.QueryString["accept"];
  662. var supportsWebP = SupportsFormat(supportedFormats, acceptParam, "webp", false);
  663. if (!supportsWebP)
  664. {
  665. var userAgent = Request.UserAgent ?? string.Empty;
  666. if (userAgent.IndexOf("crosswalk", StringComparison.OrdinalIgnoreCase) != -1 &&
  667. userAgent.IndexOf("android", StringComparison.OrdinalIgnoreCase) != -1)
  668. {
  669. supportsWebP = true;
  670. }
  671. }
  672. var formats = new List<ImageFormat>(4);
  673. if (supportsWebP)
  674. {
  675. formats.Add(ImageFormat.Webp);
  676. }
  677. formats.Add(ImageFormat.Jpg);
  678. formats.Add(ImageFormat.Png);
  679. if (SupportsFormat(supportedFormats, acceptParam, "gif", true))
  680. {
  681. formats.Add(ImageFormat.Gif);
  682. }
  683. return formats.ToArray();
  684. }
  685. private bool SupportsFormat(IEnumerable<string> requestAcceptTypes, string acceptParam, string format, bool acceptAll)
  686. {
  687. var mimeType = "image/" + format;
  688. if (requestAcceptTypes.Contains(mimeType))
  689. {
  690. return true;
  691. }
  692. if (acceptAll && requestAcceptTypes.Contains("*/*"))
  693. {
  694. return true;
  695. }
  696. return string.Equals(Request.QueryString["accept"], format, StringComparison.OrdinalIgnoreCase);
  697. }
  698. /// <summary>
  699. /// Gets the image path.
  700. /// </summary>
  701. /// <param name="request">The request.</param>
  702. /// <param name="item">The item.</param>
  703. /// <returns>System.String.</returns>
  704. private ItemImageInfo GetImageInfo(ImageRequest request, BaseItem item)
  705. {
  706. var index = request.Index ?? 0;
  707. return item.GetImageInfo(request.Type, index);
  708. }
  709. private ItemImageInfo GetImageInfo(ImageRequest request, User user)
  710. {
  711. var info = new ItemImageInfo
  712. {
  713. Path = user.ProfileImage.Path,
  714. Type = ImageType.Primary,
  715. DateModified = user.ProfileImage.LastModified,
  716. };
  717. if (request.Width.HasValue)
  718. {
  719. info.Width = request.Width.Value;
  720. }
  721. if (request.Height.HasValue)
  722. {
  723. info.Height = request.Height.Value;
  724. }
  725. return info;
  726. }
  727. /// <summary>
  728. /// Posts the image.
  729. /// </summary>
  730. /// <param name="entity">The entity.</param>
  731. /// <param name="inputStream">The input stream.</param>
  732. /// <param name="imageType">Type of the image.</param>
  733. /// <param name="mimeType">Type of the MIME.</param>
  734. /// <returns>Task.</returns>
  735. public async Task PostImage(BaseItem entity, Stream inputStream, ImageType imageType, string mimeType)
  736. {
  737. using var reader = new StreamReader(inputStream);
  738. var text = await reader.ReadToEndAsync().ConfigureAwait(false);
  739. var bytes = Convert.FromBase64String(text);
  740. var memoryStream = new MemoryStream(bytes)
  741. {
  742. Position = 0
  743. };
  744. // Handle image/png; charset=utf-8
  745. mimeType = mimeType.Split(';').FirstOrDefault();
  746. await _providerManager.SaveImage(entity, memoryStream, mimeType, imageType, null, CancellationToken.None).ConfigureAwait(false);
  747. entity.UpdateToRepository(ItemUpdateType.ImageUpdate, CancellationToken.None);
  748. }
  749. public async Task PostImage(User user, Stream inputStream, string mimeType)
  750. {
  751. using var reader = new StreamReader(inputStream);
  752. var text = await reader.ReadToEndAsync().ConfigureAwait(false);
  753. var bytes = Convert.FromBase64String(text);
  754. var memoryStream = new MemoryStream(bytes)
  755. {
  756. Position = 0
  757. };
  758. // Handle image/png; charset=utf-8
  759. mimeType = mimeType.Split(';').FirstOrDefault();
  760. var userDataPath = Path.Combine(ServerConfigurationManager.ApplicationPaths.UserConfigurationDirectoryPath, user.Username);
  761. await _providerManager
  762. .SaveImage(user, memoryStream, mimeType, Path.Combine(userDataPath, "profile" + MimeTypes.ToExtension(mimeType)))
  763. .ConfigureAwait(false);
  764. await _userManager.UpdateUserAsync(user);
  765. }
  766. }
  767. }