ImageService.cs 28 KB

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