ImageService.cs 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777
  1. using MediaBrowser.Common.Extensions;
  2. using MediaBrowser.Controller.Drawing;
  3. using MediaBrowser.Controller.Entities;
  4. using MediaBrowser.Controller.Library;
  5. using MediaBrowser.Controller.Net;
  6. using MediaBrowser.Controller.Persistence;
  7. using MediaBrowser.Controller.Providers;
  8. using MediaBrowser.Model.Drawing;
  9. using MediaBrowser.Model.Dto;
  10. using MediaBrowser.Model.Entities;
  11. using ServiceStack;
  12. using ServiceStack.Web;
  13. using System;
  14. using System.Collections.Generic;
  15. using System.IO;
  16. using System.Linq;
  17. using System.Threading;
  18. using System.Threading.Tasks;
  19. using CommonIO;
  20. namespace MediaBrowser.Api.Images
  21. {
  22. /// <summary>
  23. /// Class GetItemImage
  24. /// </summary>
  25. [Route("/Items/{Id}/Images", "GET", Summary = "Gets information about an item's images")]
  26. [Authenticated]
  27. public class GetItemImageInfos : IReturn<List<ImageInfo>>
  28. {
  29. /// <summary>
  30. /// Gets or sets the id.
  31. /// </summary>
  32. /// <value>The id.</value>
  33. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  34. public string Id { get; set; }
  35. }
  36. [Route("/Items/{Id}/Images/{Type}", "GET")]
  37. [Route("/Items/{Id}/Images/{Type}/{Index}", "GET")]
  38. [Route("/Items/{Id}/Images/{Type}", "HEAD")]
  39. [Route("/Items/{Id}/Images/{Type}/{Index}", "HEAD")]
  40. [Route("/Items/{Id}/Images/{Type}/{Index}/{Tag}/{Format}/{MaxWidth}/{MaxHeight}/{PercentPlayed}/{UnplayedCount}", "GET")]
  41. [Route("/Items/{Id}/Images/{Type}/{Index}/{Tag}/{Format}/{MaxWidth}/{MaxHeight}/{PercentPlayed}/{UnplayedCount}", "HEAD")]
  42. public class GetItemImage : ImageRequest
  43. {
  44. /// <summary>
  45. /// Gets or sets the id.
  46. /// </summary>
  47. /// <value>The id.</value>
  48. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  49. public string Id { get; set; }
  50. }
  51. /// <summary>
  52. /// Class UpdateItemImageIndex
  53. /// </summary>
  54. [Route("/Items/{Id}/Images/{Type}/{Index}/Index", "POST", Summary = "Updates the index for an item image")]
  55. [Authenticated(Roles = "admin")]
  56. public class UpdateItemImageIndex : IReturnVoid
  57. {
  58. /// <summary>
  59. /// Gets or sets the id.
  60. /// </summary>
  61. /// <value>The id.</value>
  62. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  63. public string Id { get; set; }
  64. /// <summary>
  65. /// Gets or sets the type of the image.
  66. /// </summary>
  67. /// <value>The type of the image.</value>
  68. [ApiMember(Name = "Type", Description = "Image Type", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  69. public ImageType Type { get; set; }
  70. /// <summary>
  71. /// Gets or sets the index.
  72. /// </summary>
  73. /// <value>The index.</value>
  74. [ApiMember(Name = "Index", Description = "Image Index", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "POST")]
  75. public int Index { get; set; }
  76. /// <summary>
  77. /// Gets or sets the new index.
  78. /// </summary>
  79. /// <value>The new index.</value>
  80. [ApiMember(Name = "NewIndex", Description = "The new image index", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
  81. public int NewIndex { get; set; }
  82. }
  83. /// <summary>
  84. /// Class GetPersonImage
  85. /// </summary>
  86. [Route("/Artists/{Name}/Images/{Type}", "GET")]
  87. [Route("/Artists/{Name}/Images/{Type}/{Index}", "GET")]
  88. [Route("/Genres/{Name}/Images/{Type}", "GET")]
  89. [Route("/Genres/{Name}/Images/{Type}/{Index}", "GET")]
  90. [Route("/GameGenres/{Name}/Images/{Type}", "GET")]
  91. [Route("/GameGenres/{Name}/Images/{Type}/{Index}", "GET")]
  92. [Route("/MusicGenres/{Name}/Images/{Type}", "GET")]
  93. [Route("/MusicGenres/{Name}/Images/{Type}/{Index}", "GET")]
  94. [Route("/Persons/{Name}/Images/{Type}", "GET")]
  95. [Route("/Persons/{Name}/Images/{Type}/{Index}", "GET")]
  96. [Route("/Studios/{Name}/Images/{Type}", "GET")]
  97. [Route("/Studios/{Name}/Images/{Type}/{Index}", "GET")]
  98. [Route("/Years/{Year}/Images/{Type}", "GET")]
  99. [Route("/Years/{Year}/Images/{Type}/{Index}", "GET")]
  100. [Route("/Artists/{Name}/Images/{Type}", "HEAD")]
  101. [Route("/Artists/{Name}/Images/{Type}/{Index}", "HEAD")]
  102. [Route("/Genres/{Name}/Images/{Type}", "HEAD")]
  103. [Route("/Genres/{Name}/Images/{Type}/{Index}", "HEAD")]
  104. [Route("/GameGenres/{Name}/Images/{Type}", "HEAD")]
  105. [Route("/GameGenres/{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 string 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 string 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. [Api(Description = "Posts an item image")]
  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 IItemRepository _itemRepo;
  219. private readonly IImageProcessor _imageProcessor;
  220. private readonly IFileSystem _fileSystem;
  221. /// <summary>
  222. /// Initializes a new instance of the <see cref="ImageService" /> class.
  223. /// </summary>
  224. public ImageService(IUserManager userManager, ILibraryManager libraryManager, IProviderManager providerManager, IItemRepository itemRepo, IImageProcessor imageProcessor, IFileSystem fileSystem)
  225. {
  226. _userManager = userManager;
  227. _libraryManager = libraryManager;
  228. _providerManager = providerManager;
  229. _itemRepo = itemRepo;
  230. _imageProcessor = imageProcessor;
  231. _fileSystem = fileSystem;
  232. }
  233. /// <summary>
  234. /// Gets the specified request.
  235. /// </summary>
  236. /// <param name="request">The request.</param>
  237. /// <returns>System.Object.</returns>
  238. public object Get(GetItemImageInfos request)
  239. {
  240. var item = _libraryManager.GetItemById(request.Id);
  241. var result = GetItemImageInfos(item);
  242. return ToOptimizedSerializedResultUsingCache(result);
  243. }
  244. /// <summary>
  245. /// Gets the item image infos.
  246. /// </summary>
  247. /// <param name="item">The item.</param>
  248. /// <returns>Task{List{ImageInfo}}.</returns>
  249. public List<ImageInfo> GetItemImageInfos(BaseItem item)
  250. {
  251. var list = new List<ImageInfo>();
  252. foreach (var image in item.ImageInfos.Where(i => !item.AllowsMultipleImages(i.Type)))
  253. {
  254. var info = GetImageInfo(item, image, null);
  255. if (info != null)
  256. {
  257. list.Add(info);
  258. }
  259. }
  260. foreach (var imageType in item.ImageInfos.Select(i => i.Type).Distinct().Where(item.AllowsMultipleImages))
  261. {
  262. var index = 0;
  263. // Prevent implicitly captured closure
  264. var currentImageType = imageType;
  265. foreach (var image in item.ImageInfos.Where(i => i.Type == currentImageType))
  266. {
  267. var info = GetImageInfo(item, image, index);
  268. if (info != null)
  269. {
  270. list.Add(info);
  271. }
  272. index++;
  273. }
  274. }
  275. return list;
  276. }
  277. private ImageInfo GetImageInfo(IHasImages item, ItemImageInfo info, int? imageIndex)
  278. {
  279. try
  280. {
  281. int? width = null;
  282. int? height = null;
  283. long length = 0;
  284. try
  285. {
  286. if (info.IsLocalFile)
  287. {
  288. var fileInfo = new FileInfo(info.Path);
  289. length = fileInfo.Length;
  290. var size = _imageProcessor.GetImageSize(info);
  291. width = Convert.ToInt32(size.Width);
  292. height = Convert.ToInt32(size.Height);
  293. }
  294. }
  295. catch
  296. {
  297. }
  298. return new ImageInfo
  299. {
  300. Path = info.Path,
  301. ImageIndex = imageIndex,
  302. ImageType = info.Type,
  303. ImageTag = _imageProcessor.GetImageCacheTag(item, info),
  304. Size = length,
  305. Width = width,
  306. Height = height
  307. };
  308. }
  309. catch (Exception ex)
  310. {
  311. Logger.ErrorException("Error getting image information for {0}", ex, info.Path);
  312. return null;
  313. }
  314. }
  315. /// <summary>
  316. /// Gets the specified request.
  317. /// </summary>
  318. /// <param name="request">The request.</param>
  319. /// <returns>System.Object.</returns>
  320. public object Get(GetItemImage request)
  321. {
  322. var item = string.IsNullOrEmpty(request.Id) ?
  323. _libraryManager.RootFolder :
  324. _libraryManager.GetItemById(request.Id);
  325. return GetImage(request, item, false);
  326. }
  327. /// <summary>
  328. /// Gets the specified request.
  329. /// </summary>
  330. /// <param name="request">The request.</param>
  331. /// <returns>System.Object.</returns>
  332. public object Head(GetItemImage request)
  333. {
  334. var item = string.IsNullOrEmpty(request.Id) ?
  335. _libraryManager.RootFolder :
  336. _libraryManager.GetItemById(request.Id);
  337. return GetImage(request, item, true);
  338. }
  339. /// <summary>
  340. /// Gets the specified request.
  341. /// </summary>
  342. /// <param name="request">The request.</param>
  343. /// <returns>System.Object.</returns>
  344. public object Get(GetUserImage request)
  345. {
  346. var item = _userManager.GetUserById(request.Id);
  347. return GetImage(request, item, false);
  348. }
  349. public object Head(GetUserImage request)
  350. {
  351. var item = _userManager.GetUserById(request.Id);
  352. return GetImage(request, item, true);
  353. }
  354. public object Get(GetItemByNameImage request)
  355. {
  356. var type = GetPathValue(0);
  357. var item = GetItemByName(request.Name, type, _libraryManager);
  358. return GetImage(request, item, false);
  359. }
  360. public object Head(GetItemByNameImage request)
  361. {
  362. var type = GetPathValue(0);
  363. var item = GetItemByName(request.Name, type, _libraryManager);
  364. return GetImage(request, item, true);
  365. }
  366. /// <summary>
  367. /// Posts the specified request.
  368. /// </summary>
  369. /// <param name="request">The request.</param>
  370. public void Post(PostUserImage request)
  371. {
  372. var userId = GetPathValue(1);
  373. AssertCanUpdateUser(_userManager, userId);
  374. request.Type = (ImageType)Enum.Parse(typeof(ImageType), GetPathValue(3), true);
  375. var item = _userManager.GetUserById(userId);
  376. var task = PostImage(item, request.RequestStream, request.Type, Request.ContentType);
  377. Task.WaitAll(task);
  378. }
  379. /// <summary>
  380. /// Posts the specified request.
  381. /// </summary>
  382. /// <param name="request">The request.</param>
  383. public void Post(PostItemImage request)
  384. {
  385. var id = GetPathValue(1);
  386. request.Type = (ImageType)Enum.Parse(typeof(ImageType), GetPathValue(3), true);
  387. var item = _libraryManager.GetItemById(id);
  388. var task = PostImage(item, request.RequestStream, request.Type, Request.ContentType);
  389. Task.WaitAll(task);
  390. }
  391. /// <summary>
  392. /// Deletes the specified request.
  393. /// </summary>
  394. /// <param name="request">The request.</param>
  395. public void Delete(DeleteUserImage request)
  396. {
  397. var userId = request.Id;
  398. AssertCanUpdateUser(_userManager, userId);
  399. var item = _userManager.GetUserById(userId);
  400. var task = item.DeleteImage(request.Type, request.Index ?? 0);
  401. Task.WaitAll(task);
  402. }
  403. /// <summary>
  404. /// Deletes the specified request.
  405. /// </summary>
  406. /// <param name="request">The request.</param>
  407. public void Delete(DeleteItemImage request)
  408. {
  409. var item = _libraryManager.GetItemById(request.Id);
  410. var task = item.DeleteImage(request.Type, request.Index ?? 0);
  411. Task.WaitAll(task);
  412. }
  413. /// <summary>
  414. /// Posts the specified request.
  415. /// </summary>
  416. /// <param name="request">The request.</param>
  417. public void Post(UpdateItemImageIndex request)
  418. {
  419. var item = _libraryManager.GetItemById(request.Id);
  420. var task = UpdateItemIndex(item, request.Type, request.Index, request.NewIndex);
  421. Task.WaitAll(task);
  422. }
  423. /// <summary>
  424. /// Updates the index of the item.
  425. /// </summary>
  426. /// <param name="item">The item.</param>
  427. /// <param name="type">The type.</param>
  428. /// <param name="currentIndex">Index of the current.</param>
  429. /// <param name="newIndex">The new index.</param>
  430. /// <returns>Task.</returns>
  431. private Task UpdateItemIndex(IHasImages item, ImageType type, int currentIndex, int newIndex)
  432. {
  433. return item.SwapImages(type, currentIndex, newIndex);
  434. }
  435. /// <summary>
  436. /// Gets the image.
  437. /// </summary>
  438. /// <param name="request">The request.</param>
  439. /// <param name="item">The item.</param>
  440. /// <param name="isHeadRequest">if set to <c>true</c> [is head request].</param>
  441. /// <returns>System.Object.</returns>
  442. /// <exception cref="ResourceNotFoundException"></exception>
  443. public object GetImage(ImageRequest request, IHasImages item, bool isHeadRequest)
  444. {
  445. if (request.PercentPlayed.HasValue)
  446. {
  447. if (request.PercentPlayed.Value <= 0)
  448. {
  449. request.PercentPlayed = null;
  450. }
  451. else if (request.PercentPlayed.Value >= 100)
  452. {
  453. request.PercentPlayed = null;
  454. request.AddPlayedIndicator = true;
  455. }
  456. }
  457. if (request.PercentPlayed.HasValue)
  458. {
  459. request.UnplayedCount = null;
  460. }
  461. if (request.UnplayedCount.HasValue)
  462. {
  463. if (request.UnplayedCount.Value <= 0)
  464. {
  465. request.UnplayedCount = null;
  466. }
  467. }
  468. var imageInfo = GetImageInfo(request, item);
  469. if (imageInfo == null)
  470. {
  471. throw new ResourceNotFoundException(string.Format("{0} does not have an image of type {1}", item.Name, request.Type));
  472. }
  473. var supportedImageEnhancers = request.EnableImageEnhancers ? _imageProcessor.ImageEnhancers.Where(i =>
  474. {
  475. try
  476. {
  477. return i.Supports(item, request.Type);
  478. }
  479. catch (Exception ex)
  480. {
  481. Logger.ErrorException("Error in image enhancer: {0}", ex, i.GetType().Name);
  482. return false;
  483. }
  484. }).ToList() : new List<IImageEnhancer>();
  485. var cropwhitespace = request.Type == ImageType.Logo || request.Type == ImageType.Art;
  486. if (request.CropWhitespace.HasValue)
  487. {
  488. cropwhitespace = request.CropWhitespace.Value;
  489. }
  490. var outputFormats = GetOutputFormats(request, imageInfo, cropwhitespace, supportedImageEnhancers);
  491. var cacheGuid = new Guid(_imageProcessor.GetImageCacheTag(item, imageInfo, supportedImageEnhancers));
  492. TimeSpan? cacheDuration = null;
  493. if (!string.IsNullOrEmpty(request.Tag) && cacheGuid == new Guid(request.Tag))
  494. {
  495. cacheDuration = TimeSpan.FromDays(365);
  496. }
  497. var responseHeaders = new Dictionary<string, string>
  498. {
  499. {"transferMode.dlna.org", "Interactive"},
  500. {"realTimeInfo.dlna.org", "DLNA.ORG_TLAG=*"}
  501. };
  502. return GetImageResult(item,
  503. request,
  504. imageInfo,
  505. cropwhitespace,
  506. outputFormats,
  507. supportedImageEnhancers,
  508. cacheDuration,
  509. responseHeaders,
  510. isHeadRequest)
  511. .Result;
  512. }
  513. private async Task<object> GetImageResult(IHasImages item,
  514. ImageRequest request,
  515. ItemImageInfo image,
  516. bool cropwhitespace,
  517. List<ImageFormat> supportedFormats,
  518. List<IImageEnhancer> enhancers,
  519. TimeSpan? cacheDuration,
  520. IDictionary<string, string> headers,
  521. bool isHeadRequest)
  522. {
  523. var options = new ImageProcessingOptions
  524. {
  525. CropWhiteSpace = cropwhitespace,
  526. Enhancers = enhancers,
  527. Height = request.Height,
  528. ImageIndex = request.Index ?? 0,
  529. Image = image,
  530. Item = item,
  531. MaxHeight = request.MaxHeight,
  532. MaxWidth = request.MaxWidth,
  533. Quality = request.Quality ?? 100,
  534. Width = request.Width,
  535. AddPlayedIndicator = request.AddPlayedIndicator,
  536. PercentPlayed = request.PercentPlayed ?? 0,
  537. UnplayedCount = request.UnplayedCount,
  538. BackgroundColor = request.BackgroundColor,
  539. SupportedOutputFormats = supportedFormats
  540. };
  541. var imageResult = await _imageProcessor.ProcessImage(options).ConfigureAwait(false);
  542. headers["Vary"] = "Accept";
  543. return ResultFactory.GetStaticFileResult(Request, new StaticFileResultOptions
  544. {
  545. CacheDuration = cacheDuration,
  546. ResponseHeaders = headers,
  547. ContentType = imageResult.Item2,
  548. IsHeadRequest = isHeadRequest,
  549. Path = imageResult.Item1,
  550. // Sometimes imagemagick keeps a hold on the file briefly even after it's done writing to it.
  551. // I'd rather do this than add a delay after saving the file
  552. FileShare = FileShare.ReadWrite
  553. });
  554. }
  555. private List<ImageFormat> GetOutputFormats(ImageRequest request, ItemImageInfo image, bool cropwhitespace, List<IImageEnhancer> enhancers)
  556. {
  557. if (!string.IsNullOrWhiteSpace(request.Format))
  558. {
  559. ImageFormat format;
  560. if (Enum.TryParse(request.Format, true, out format))
  561. {
  562. return new List<ImageFormat> { format };
  563. }
  564. }
  565. var extension = Path.GetExtension(image.Path);
  566. ImageFormat? inputFormat = null;
  567. if (string.Equals(extension, ".jpg", StringComparison.OrdinalIgnoreCase) ||
  568. string.Equals(extension, ".jpeg", StringComparison.OrdinalIgnoreCase))
  569. {
  570. inputFormat = ImageFormat.Jpg;
  571. }
  572. else if (string.Equals(extension, ".png", StringComparison.OrdinalIgnoreCase))
  573. {
  574. inputFormat = ImageFormat.Png;
  575. }
  576. var clientSupportedFormats = GetClientSupportedFormats();
  577. var serverFormats = _imageProcessor.GetSupportedImageOutputFormats();
  578. var outputFormats = new List<ImageFormat>();
  579. // Client doesn't care about format, so start with webp if supported
  580. if (serverFormats.Contains(ImageFormat.Webp) && clientSupportedFormats.Contains(ImageFormat.Webp))
  581. {
  582. outputFormats.Add(ImageFormat.Webp);
  583. }
  584. if (enhancers.Count > 0)
  585. {
  586. outputFormats.Add(ImageFormat.Png);
  587. }
  588. if (inputFormat.HasValue && inputFormat.Value == ImageFormat.Jpg)
  589. {
  590. outputFormats.Add(ImageFormat.Jpg);
  591. }
  592. // We can't predict if there will be transparency or not, so play it safe
  593. outputFormats.Add(ImageFormat.Png);
  594. return outputFormats;
  595. }
  596. private ImageFormat[] GetClientSupportedFormats()
  597. {
  598. var supportsWebP = (Request.AcceptTypes ?? new string[] { }).Contains("image/webp", StringComparer.OrdinalIgnoreCase);
  599. var userAgent = Request.UserAgent ?? string.Empty;
  600. if (!supportsWebP)
  601. {
  602. if (string.Equals(Request.QueryString["accept"], "webp", StringComparison.OrdinalIgnoreCase))
  603. {
  604. supportsWebP = true;
  605. }
  606. }
  607. if (!supportsWebP)
  608. {
  609. if (userAgent.IndexOf("crosswalk", StringComparison.OrdinalIgnoreCase) != -1 &&
  610. userAgent.IndexOf("android", StringComparison.OrdinalIgnoreCase) != -1)
  611. {
  612. supportsWebP = true;
  613. }
  614. }
  615. if (supportsWebP)
  616. {
  617. // Not displaying properly on iOS
  618. if (userAgent.IndexOf("cfnetwork", StringComparison.OrdinalIgnoreCase) == -1)
  619. {
  620. return new[] { ImageFormat.Webp, ImageFormat.Jpg, ImageFormat.Png };
  621. }
  622. }
  623. return new[] { ImageFormat.Jpg, ImageFormat.Png };
  624. }
  625. /// <summary>
  626. /// Gets the image path.
  627. /// </summary>
  628. /// <param name="request">The request.</param>
  629. /// <param name="item">The item.</param>
  630. /// <returns>System.String.</returns>
  631. private ItemImageInfo GetImageInfo(ImageRequest request, IHasImages item)
  632. {
  633. var index = request.Index ?? 0;
  634. return item.GetImageInfo(request.Type, index);
  635. }
  636. /// <summary>
  637. /// Posts the image.
  638. /// </summary>
  639. /// <param name="entity">The entity.</param>
  640. /// <param name="inputStream">The input stream.</param>
  641. /// <param name="imageType">Type of the image.</param>
  642. /// <param name="mimeType">Type of the MIME.</param>
  643. /// <returns>Task.</returns>
  644. public async Task PostImage(BaseItem entity, Stream inputStream, ImageType imageType, string mimeType)
  645. {
  646. using (var reader = new StreamReader(inputStream))
  647. {
  648. var text = await reader.ReadToEndAsync().ConfigureAwait(false);
  649. var bytes = Convert.FromBase64String(text);
  650. var memoryStream = new MemoryStream(bytes)
  651. {
  652. Position = 0
  653. };
  654. // Handle image/png; charset=utf-8
  655. mimeType = mimeType.Split(';').FirstOrDefault();
  656. await _providerManager.SaveImage(entity, memoryStream, mimeType, imageType, null, CancellationToken.None).ConfigureAwait(false);
  657. await entity.UpdateToRepository(ItemUpdateType.ImageUpdate, CancellationToken.None).ConfigureAwait(false);
  658. }
  659. }
  660. }
  661. }