ImageService.cs 31 KB

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