ImageService.cs 28 KB

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