2
0

ImageService.cs 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792
  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.Controller.Dto;
  18. using MediaBrowser.Controller.IO;
  19. using MediaBrowser.Controller.LiveTv;
  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)
  257. {
  258. if (!item.AllowsMultipleImages(image.Type))
  259. {
  260. var info = GetImageInfo(item, image, null);
  261. if (info != null)
  262. {
  263. list.Add(info);
  264. }
  265. }
  266. }
  267. foreach (var imageType in itemImages.Select(i => i.Type).Distinct().Where(item.AllowsMultipleImages))
  268. {
  269. var index = 0;
  270. // Prevent implicitly captured closure
  271. var currentImageType = imageType;
  272. foreach (var image in itemImages.Where(i => i.Type == currentImageType))
  273. {
  274. var info = GetImageInfo(item, image, index);
  275. if (info != null)
  276. {
  277. list.Add(info);
  278. }
  279. index++;
  280. }
  281. }
  282. return list;
  283. }
  284. private ImageInfo GetImageInfo(IHasMetadata item, ItemImageInfo info, int? imageIndex)
  285. {
  286. try
  287. {
  288. int? width = null;
  289. int? height = null;
  290. long length = 0;
  291. try
  292. {
  293. if (info.IsLocalFile)
  294. {
  295. var fileInfo = _fileSystem.GetFileInfo(info.Path);
  296. length = fileInfo.Length;
  297. var size = _imageProcessor.GetImageSize(info, true);
  298. width = Convert.ToInt32(size.Width);
  299. height = Convert.ToInt32(size.Height);
  300. }
  301. }
  302. catch
  303. {
  304. }
  305. return new ImageInfo
  306. {
  307. Path = info.Path,
  308. ImageIndex = imageIndex,
  309. ImageType = info.Type,
  310. ImageTag = _imageProcessor.GetImageCacheTag(item, info),
  311. Size = length,
  312. Width = width,
  313. Height = height
  314. };
  315. }
  316. catch (Exception ex)
  317. {
  318. Logger.ErrorException("Error getting image information for {0}", ex, info.Path);
  319. return null;
  320. }
  321. }
  322. /// <summary>
  323. /// Gets the specified request.
  324. /// </summary>
  325. /// <param name="request">The request.</param>
  326. /// <returns>System.Object.</returns>
  327. public object Get(GetItemImage request)
  328. {
  329. var item = string.IsNullOrEmpty(request.Id) ?
  330. _libraryManager.RootFolder :
  331. _libraryManager.GetItemById(request.Id);
  332. return GetImage(request, item, false);
  333. }
  334. /// <summary>
  335. /// Gets the specified request.
  336. /// </summary>
  337. /// <param name="request">The request.</param>
  338. /// <returns>System.Object.</returns>
  339. public object Head(GetItemImage request)
  340. {
  341. var item = string.IsNullOrEmpty(request.Id) ?
  342. _libraryManager.RootFolder :
  343. _libraryManager.GetItemById(request.Id);
  344. return GetImage(request, item, true);
  345. }
  346. /// <summary>
  347. /// Gets the specified request.
  348. /// </summary>
  349. /// <param name="request">The request.</param>
  350. /// <returns>System.Object.</returns>
  351. public object Get(GetUserImage request)
  352. {
  353. var item = _userManager.GetUserById(request.Id);
  354. return GetImage(request, item, false);
  355. }
  356. public object Head(GetUserImage request)
  357. {
  358. var item = _userManager.GetUserById(request.Id);
  359. return GetImage(request, item, true);
  360. }
  361. public object Get(GetItemByNameImage request)
  362. {
  363. var type = GetPathValue(0);
  364. var item = GetItemByName(request.Name, type, _libraryManager, new DtoOptions(false));
  365. return GetImage(request, item, false);
  366. }
  367. public object Head(GetItemByNameImage request)
  368. {
  369. var type = GetPathValue(0);
  370. var item = GetItemByName(request.Name, type, _libraryManager, new DtoOptions(false));
  371. return GetImage(request, item, true);
  372. }
  373. /// <summary>
  374. /// Posts the specified request.
  375. /// </summary>
  376. /// <param name="request">The request.</param>
  377. public void Post(PostUserImage request)
  378. {
  379. var userId = GetPathValue(1);
  380. AssertCanUpdateUser(_authContext, _userManager, userId, true);
  381. request.Type = (ImageType)Enum.Parse(typeof(ImageType), GetPathValue(3), true);
  382. var item = _userManager.GetUserById(userId);
  383. var task = PostImage(item, request.RequestStream, request.Type, Request.ContentType);
  384. Task.WaitAll(task);
  385. }
  386. /// <summary>
  387. /// Posts the specified request.
  388. /// </summary>
  389. /// <param name="request">The request.</param>
  390. public void Post(PostItemImage request)
  391. {
  392. var id = GetPathValue(1);
  393. request.Type = (ImageType)Enum.Parse(typeof(ImageType), GetPathValue(3), true);
  394. var item = _libraryManager.GetItemById(id);
  395. var task = PostImage(item, request.RequestStream, request.Type, Request.ContentType);
  396. Task.WaitAll(task);
  397. }
  398. /// <summary>
  399. /// Deletes the specified request.
  400. /// </summary>
  401. /// <param name="request">The request.</param>
  402. public void Delete(DeleteUserImage request)
  403. {
  404. var userId = request.Id;
  405. AssertCanUpdateUser(_authContext, _userManager, userId, true);
  406. var item = _userManager.GetUserById(userId);
  407. var task = item.DeleteImage(request.Type, request.Index ?? 0);
  408. Task.WaitAll(task);
  409. }
  410. /// <summary>
  411. /// Deletes the specified request.
  412. /// </summary>
  413. /// <param name="request">The request.</param>
  414. public void Delete(DeleteItemImage request)
  415. {
  416. var item = _libraryManager.GetItemById(request.Id);
  417. var task = item.DeleteImage(request.Type, request.Index ?? 0);
  418. Task.WaitAll(task);
  419. }
  420. /// <summary>
  421. /// Posts the specified request.
  422. /// </summary>
  423. /// <param name="request">The request.</param>
  424. public void Post(UpdateItemImageIndex request)
  425. {
  426. var item = _libraryManager.GetItemById(request.Id);
  427. var task = UpdateItemIndex(item, request.Type, request.Index, request.NewIndex);
  428. Task.WaitAll(task);
  429. }
  430. /// <summary>
  431. /// Updates the index of the item.
  432. /// </summary>
  433. /// <param name="item">The item.</param>
  434. /// <param name="type">The type.</param>
  435. /// <param name="currentIndex">Index of the current.</param>
  436. /// <param name="newIndex">The new index.</param>
  437. /// <returns>Task.</returns>
  438. private Task UpdateItemIndex(IHasMetadata item, ImageType type, int currentIndex, int newIndex)
  439. {
  440. return item.SwapImages(type, currentIndex, newIndex);
  441. }
  442. /// <summary>
  443. /// Gets the image.
  444. /// </summary>
  445. /// <param name="request">The request.</param>
  446. /// <param name="item">The item.</param>
  447. /// <param name="isHeadRequest">if set to <c>true</c> [is head request].</param>
  448. /// <returns>System.Object.</returns>
  449. /// <exception cref="ResourceNotFoundException"></exception>
  450. public Task<object> GetImage(ImageRequest request, IHasMetadata item, bool isHeadRequest)
  451. {
  452. if (request.PercentPlayed.HasValue)
  453. {
  454. if (request.PercentPlayed.Value <= 0)
  455. {
  456. request.PercentPlayed = null;
  457. }
  458. else if (request.PercentPlayed.Value >= 100)
  459. {
  460. request.PercentPlayed = null;
  461. request.AddPlayedIndicator = true;
  462. }
  463. }
  464. if (request.PercentPlayed.HasValue)
  465. {
  466. request.UnplayedCount = null;
  467. }
  468. if (request.UnplayedCount.HasValue)
  469. {
  470. if (request.UnplayedCount.Value <= 0)
  471. {
  472. request.UnplayedCount = null;
  473. }
  474. }
  475. var imageInfo = GetImageInfo(request, item);
  476. if (imageInfo == null)
  477. {
  478. throw new ResourceNotFoundException(string.Format("{0} does not have an image of type {1}", item.Name, request.Type));
  479. }
  480. var supportedImageEnhancers = request.EnableImageEnhancers ? _imageProcessor.ImageEnhancers.Where(i =>
  481. {
  482. try
  483. {
  484. return i.Supports(item, request.Type);
  485. }
  486. catch (Exception ex)
  487. {
  488. Logger.ErrorException("Error in image enhancer: {0}", ex, i.GetType().Name);
  489. return false;
  490. }
  491. }).ToList() : new List<IImageEnhancer>();
  492. var cropwhitespace = request.Type == ImageType.Logo ||
  493. request.Type == ImageType.Art
  494. || (request.Type == ImageType.Primary && item is LiveTvChannel);
  495. if (request.CropWhitespace.HasValue)
  496. {
  497. cropwhitespace = request.CropWhitespace.Value;
  498. }
  499. var outputFormats = GetOutputFormats(request, imageInfo, cropwhitespace, supportedImageEnhancers);
  500. TimeSpan? cacheDuration = null;
  501. if (!string.IsNullOrEmpty(request.Tag))
  502. {
  503. cacheDuration = TimeSpan.FromDays(365);
  504. }
  505. var responseHeaders = new Dictionary<string, string>
  506. {
  507. {"transferMode.dlna.org", "Interactive"},
  508. {"realTimeInfo.dlna.org", "DLNA.ORG_TLAG=*"}
  509. };
  510. return GetImageResult(item,
  511. request,
  512. imageInfo,
  513. cropwhitespace,
  514. outputFormats,
  515. supportedImageEnhancers,
  516. cacheDuration,
  517. responseHeaders,
  518. isHeadRequest);
  519. }
  520. private async Task<object> GetImageResult(IHasMetadata item,
  521. ImageRequest request,
  522. ItemImageInfo image,
  523. bool cropwhitespace,
  524. List<ImageFormat> supportedFormats,
  525. List<IImageEnhancer> enhancers,
  526. TimeSpan? cacheDuration,
  527. IDictionary<string, string> headers,
  528. bool isHeadRequest)
  529. {
  530. var options = new ImageProcessingOptions
  531. {
  532. CropWhiteSpace = cropwhitespace,
  533. Enhancers = enhancers,
  534. Height = request.Height,
  535. ImageIndex = request.Index ?? 0,
  536. Image = image,
  537. Item = item,
  538. ItemId = item.Id.ToString("N"),
  539. ItemType = item.GetType().Name,
  540. MaxHeight = request.MaxHeight,
  541. MaxWidth = request.MaxWidth,
  542. Quality = request.Quality ?? 100,
  543. Width = request.Width,
  544. AddPlayedIndicator = request.AddPlayedIndicator,
  545. PercentPlayed = request.PercentPlayed ?? 0,
  546. UnplayedCount = request.UnplayedCount,
  547. Blur = request.Blur,
  548. BackgroundColor = request.BackgroundColor,
  549. ForegroundLayer = request.ForegroundLayer,
  550. SupportedOutputFormats = supportedFormats
  551. };
  552. var imageResult = await _imageProcessor.ProcessImage(options).ConfigureAwait(false);
  553. headers["Vary"] = "Accept";
  554. return await ResultFactory.GetStaticFileResult(Request, new StaticFileResultOptions
  555. {
  556. CacheDuration = cacheDuration,
  557. ResponseHeaders = headers,
  558. ContentType = imageResult.Item2,
  559. DateLastModified = imageResult.Item3,
  560. IsHeadRequest = isHeadRequest,
  561. Path = imageResult.Item1,
  562. // Sometimes imagemagick keeps a hold on the file briefly even after it's done writing to it.
  563. // I'd rather do this than add a delay after saving the file
  564. FileShare = FileShareMode.ReadWrite
  565. }).ConfigureAwait(false);
  566. }
  567. private List<ImageFormat> GetOutputFormats(ImageRequest request, ItemImageInfo image, bool cropwhitespace, List<IImageEnhancer> enhancers)
  568. {
  569. if (!string.IsNullOrWhiteSpace(request.Format))
  570. {
  571. ImageFormat format;
  572. if (Enum.TryParse(request.Format, true, out format))
  573. {
  574. return new List<ImageFormat> { format };
  575. }
  576. }
  577. var extension = Path.GetExtension(image.Path);
  578. ImageFormat? inputFormat = null;
  579. if (string.Equals(extension, ".jpg", StringComparison.OrdinalIgnoreCase) ||
  580. string.Equals(extension, ".jpeg", StringComparison.OrdinalIgnoreCase))
  581. {
  582. inputFormat = ImageFormat.Jpg;
  583. }
  584. else if (string.Equals(extension, ".png", StringComparison.OrdinalIgnoreCase))
  585. {
  586. inputFormat = ImageFormat.Png;
  587. }
  588. var clientSupportedFormats = GetClientSupportedFormats();
  589. var serverFormats = _imageProcessor.GetSupportedImageOutputFormats();
  590. var outputFormats = new List<ImageFormat>();
  591. // Client doesn't care about format, so start with webp if supported
  592. if (serverFormats.Contains(ImageFormat.Webp) && clientSupportedFormats.Contains(ImageFormat.Webp))
  593. {
  594. outputFormats.Add(ImageFormat.Webp);
  595. }
  596. if (enhancers.Count > 0)
  597. {
  598. outputFormats.Add(ImageFormat.Png);
  599. }
  600. if (inputFormat.HasValue && inputFormat.Value == ImageFormat.Jpg)
  601. {
  602. outputFormats.Add(ImageFormat.Jpg);
  603. }
  604. // We can't predict if there will be transparency or not, so play it safe
  605. outputFormats.Add(ImageFormat.Png);
  606. return outputFormats;
  607. }
  608. private ImageFormat[] GetClientSupportedFormats()
  609. {
  610. //Logger.Debug("Request types: {0}", string.Join(",", Request.AcceptTypes ?? new string[] { }));
  611. var supportsWebP = (Request.AcceptTypes ?? new string[] { }).Contains("image/webp", StringComparer.OrdinalIgnoreCase);
  612. var userAgent = Request.UserAgent ?? string.Empty;
  613. if (!supportsWebP)
  614. {
  615. if (string.Equals(Request.QueryString["accept"], "webp", StringComparison.OrdinalIgnoreCase))
  616. {
  617. supportsWebP = true;
  618. }
  619. }
  620. if (!supportsWebP)
  621. {
  622. if (userAgent.IndexOf("crosswalk", StringComparison.OrdinalIgnoreCase) != -1 &&
  623. userAgent.IndexOf("android", StringComparison.OrdinalIgnoreCase) != -1)
  624. {
  625. supportsWebP = true;
  626. }
  627. }
  628. if (supportsWebP)
  629. {
  630. // Not displaying properly on iOS
  631. if (userAgent.IndexOf("cfnetwork", StringComparison.OrdinalIgnoreCase) == -1)
  632. {
  633. return new[] { ImageFormat.Webp, ImageFormat.Jpg, ImageFormat.Png };
  634. }
  635. }
  636. return new[] { ImageFormat.Jpg, ImageFormat.Png };
  637. }
  638. /// <summary>
  639. /// Gets the image path.
  640. /// </summary>
  641. /// <param name="request">The request.</param>
  642. /// <param name="item">The item.</param>
  643. /// <returns>System.String.</returns>
  644. private ItemImageInfo GetImageInfo(ImageRequest request, IHasMetadata item)
  645. {
  646. var index = request.Index ?? 0;
  647. return item.GetImageInfo(request.Type, index);
  648. }
  649. /// <summary>
  650. /// Posts the image.
  651. /// </summary>
  652. /// <param name="entity">The entity.</param>
  653. /// <param name="inputStream">The input stream.</param>
  654. /// <param name="imageType">Type of the image.</param>
  655. /// <param name="mimeType">Type of the MIME.</param>
  656. /// <returns>Task.</returns>
  657. public async Task PostImage(BaseItem entity, Stream inputStream, ImageType imageType, string mimeType)
  658. {
  659. using (var reader = new StreamReader(inputStream))
  660. {
  661. var text = await reader.ReadToEndAsync().ConfigureAwait(false);
  662. var bytes = Convert.FromBase64String(text);
  663. var memoryStream = new MemoryStream(bytes)
  664. {
  665. Position = 0
  666. };
  667. // Handle image/png; charset=utf-8
  668. mimeType = mimeType.Split(';').FirstOrDefault();
  669. await _providerManager.SaveImage(entity, memoryStream, mimeType, imageType, null, CancellationToken.None).ConfigureAwait(false);
  670. await entity.UpdateToRepository(ItemUpdateType.ImageUpdate, CancellationToken.None).ConfigureAwait(false);
  671. }
  672. }
  673. }
  674. }