ImageService.cs 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802
  1. using MediaBrowser.Common.Extensions;
  2. using MediaBrowser.Common.IO;
  3. using MediaBrowser.Controller.Drawing;
  4. using MediaBrowser.Controller.Entities;
  5. using MediaBrowser.Controller.Library;
  6. using MediaBrowser.Controller.Net;
  7. using MediaBrowser.Controller.Persistence;
  8. using MediaBrowser.Controller.Providers;
  9. using MediaBrowser.Model.Drawing;
  10. using MediaBrowser.Model.Dto;
  11. using MediaBrowser.Model.Entities;
  12. using ServiceStack;
  13. using ServiceStack.Web;
  14. using System;
  15. using System.Collections.Generic;
  16. using System.IO;
  17. using System.Linq;
  18. using System.Threading;
  19. using System.Threading.Tasks;
  20. using CommonIO;
  21. using MimeTypes = MediaBrowser.Model.Net.MimeTypes;
  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. [Api(Description = "Posts an item image")]
  197. [Authenticated(Roles = "admin")]
  198. public class PostItemImage : DeleteImageRequest, IRequiresRequestStream, IReturnVoid
  199. {
  200. /// <summary>
  201. /// Gets or sets the id.
  202. /// </summary>
  203. /// <value>The id.</value>
  204. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  205. public string Id { get; set; }
  206. /// <summary>
  207. /// The raw Http Request Input Stream
  208. /// </summary>
  209. /// <value>The request stream.</value>
  210. public Stream RequestStream { get; set; }
  211. }
  212. /// <summary>
  213. /// Class ImageService
  214. /// </summary>
  215. public class ImageService : BaseApiService
  216. {
  217. private readonly IUserManager _userManager;
  218. private readonly ILibraryManager _libraryManager;
  219. private readonly IProviderManager _providerManager;
  220. private readonly IItemRepository _itemRepo;
  221. private readonly IImageProcessor _imageProcessor;
  222. private readonly IFileSystem _fileSystem;
  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)
  227. {
  228. _userManager = userManager;
  229. _libraryManager = libraryManager;
  230. _providerManager = providerManager;
  231. _itemRepo = itemRepo;
  232. _imageProcessor = imageProcessor;
  233. _fileSystem = fileSystem;
  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. foreach (var image in item.ImageInfos.Where(i => !item.AllowsMultipleImages(i.Type)))
  255. {
  256. var info = GetImageInfo(item, image, null);
  257. if (info != null)
  258. {
  259. list.Add(info);
  260. }
  261. }
  262. foreach (var imageType in item.ImageInfos.Select(i => i.Type).Distinct().Where(item.AllowsMultipleImages))
  263. {
  264. var index = 0;
  265. // Prevent implicitly captured closure
  266. var currentImageType = imageType;
  267. foreach (var image in item.ImageInfos.Where(i => i.Type == currentImageType))
  268. {
  269. var info = GetImageInfo(item, image, index);
  270. if (info != null)
  271. {
  272. list.Add(info);
  273. }
  274. index++;
  275. }
  276. }
  277. return list;
  278. }
  279. private ImageInfo GetImageInfo(IHasImages item, ItemImageInfo info, int? imageIndex)
  280. {
  281. try
  282. {
  283. int? width = null;
  284. int? height = null;
  285. long length = 0;
  286. try
  287. {
  288. if (info.IsLocalFile)
  289. {
  290. var fileInfo = new FileInfo(info.Path);
  291. length = fileInfo.Length;
  292. var size = _imageProcessor.GetImageSize(info);
  293. width = Convert.ToInt32(size.Width);
  294. height = Convert.ToInt32(size.Height);
  295. }
  296. }
  297. catch
  298. {
  299. }
  300. return new ImageInfo
  301. {
  302. Path = info.Path,
  303. ImageIndex = imageIndex,
  304. ImageType = info.Type,
  305. ImageTag = _imageProcessor.GetImageCacheTag(item, info),
  306. Size = length,
  307. Width = width,
  308. Height = height
  309. };
  310. }
  311. catch (Exception ex)
  312. {
  313. Logger.ErrorException("Error getting image information for {0}", ex, info.Path);
  314. return null;
  315. }
  316. }
  317. /// <summary>
  318. /// Gets the specified request.
  319. /// </summary>
  320. /// <param name="request">The request.</param>
  321. /// <returns>System.Object.</returns>
  322. public object Get(GetItemImage request)
  323. {
  324. var item = string.IsNullOrEmpty(request.Id) ?
  325. _libraryManager.RootFolder :
  326. _libraryManager.GetItemById(request.Id);
  327. return GetImage(request, item, false);
  328. }
  329. /// <summary>
  330. /// Gets the specified request.
  331. /// </summary>
  332. /// <param name="request">The request.</param>
  333. /// <returns>System.Object.</returns>
  334. public object Head(GetItemImage request)
  335. {
  336. var item = string.IsNullOrEmpty(request.Id) ?
  337. _libraryManager.RootFolder :
  338. _libraryManager.GetItemById(request.Id);
  339. return GetImage(request, item, true);
  340. }
  341. /// <summary>
  342. /// Gets the specified request.
  343. /// </summary>
  344. /// <param name="request">The request.</param>
  345. /// <returns>System.Object.</returns>
  346. public object Get(GetUserImage request)
  347. {
  348. var item = _userManager.GetUserById(request.Id);
  349. return GetImage(request, item, false);
  350. }
  351. public object Head(GetUserImage request)
  352. {
  353. var item = _userManager.GetUserById(request.Id);
  354. return GetImage(request, item, true);
  355. }
  356. public object Get(GetItemByNameImage request)
  357. {
  358. var type = GetPathValue(0);
  359. var item = GetItemByName(request.Name, type, _libraryManager);
  360. return GetImage(request, item, false);
  361. }
  362. public object Head(GetItemByNameImage request)
  363. {
  364. var type = GetPathValue(0);
  365. var item = GetItemByName(request.Name, type, _libraryManager);
  366. return GetImage(request, item, true);
  367. }
  368. /// <summary>
  369. /// Posts the specified request.
  370. /// </summary>
  371. /// <param name="request">The request.</param>
  372. public void Post(PostUserImage request)
  373. {
  374. var userId = GetPathValue(1);
  375. AssertCanUpdateUser(_userManager, userId);
  376. request.Type = (ImageType)Enum.Parse(typeof(ImageType), GetPathValue(3), true);
  377. var item = _userManager.GetUserById(userId);
  378. var task = PostImage(item, request.RequestStream, request.Type, Request.ContentType);
  379. Task.WaitAll(task);
  380. }
  381. /// <summary>
  382. /// Posts the specified request.
  383. /// </summary>
  384. /// <param name="request">The request.</param>
  385. public void Post(PostItemImage request)
  386. {
  387. var id = GetPathValue(1);
  388. request.Type = (ImageType)Enum.Parse(typeof(ImageType), GetPathValue(3), true);
  389. var item = _libraryManager.GetItemById(id);
  390. var task = PostImage(item, request.RequestStream, request.Type, Request.ContentType);
  391. Task.WaitAll(task);
  392. }
  393. /// <summary>
  394. /// Deletes the specified request.
  395. /// </summary>
  396. /// <param name="request">The request.</param>
  397. public void Delete(DeleteUserImage request)
  398. {
  399. var userId = request.Id;
  400. AssertCanUpdateUser(_userManager, userId);
  401. var item = _userManager.GetUserById(userId);
  402. var task = item.DeleteImage(request.Type, request.Index ?? 0);
  403. Task.WaitAll(task);
  404. }
  405. /// <summary>
  406. /// Deletes the specified request.
  407. /// </summary>
  408. /// <param name="request">The request.</param>
  409. public void Delete(DeleteItemImage request)
  410. {
  411. var item = _libraryManager.GetItemById(request.Id);
  412. var task = item.DeleteImage(request.Type, request.Index ?? 0);
  413. Task.WaitAll(task);
  414. }
  415. /// <summary>
  416. /// Posts the specified request.
  417. /// </summary>
  418. /// <param name="request">The request.</param>
  419. public void Post(UpdateItemImageIndex request)
  420. {
  421. var item = _libraryManager.GetItemById(request.Id);
  422. var task = UpdateItemIndex(item, request.Type, request.Index, request.NewIndex);
  423. Task.WaitAll(task);
  424. }
  425. /// <summary>
  426. /// Updates the index of the item.
  427. /// </summary>
  428. /// <param name="item">The item.</param>
  429. /// <param name="type">The type.</param>
  430. /// <param name="currentIndex">Index of the current.</param>
  431. /// <param name="newIndex">The new index.</param>
  432. /// <returns>Task.</returns>
  433. private Task UpdateItemIndex(IHasImages item, ImageType type, int currentIndex, int newIndex)
  434. {
  435. return item.SwapImages(type, currentIndex, newIndex);
  436. }
  437. /// <summary>
  438. /// Gets the image.
  439. /// </summary>
  440. /// <param name="request">The request.</param>
  441. /// <param name="item">The item.</param>
  442. /// <param name="isHeadRequest">if set to <c>true</c> [is head request].</param>
  443. /// <returns>System.Object.</returns>
  444. /// <exception cref="ResourceNotFoundException"></exception>
  445. public object GetImage(ImageRequest request, IHasImages item, bool isHeadRequest)
  446. {
  447. if (request.PercentPlayed.HasValue)
  448. {
  449. if (request.PercentPlayed.Value <= 0)
  450. {
  451. request.PercentPlayed = null;
  452. }
  453. else if (request.PercentPlayed.Value >= 100)
  454. {
  455. request.PercentPlayed = null;
  456. request.AddPlayedIndicator = true;
  457. }
  458. }
  459. if (request.PercentPlayed.HasValue)
  460. {
  461. request.UnplayedCount = null;
  462. }
  463. if (request.UnplayedCount.HasValue)
  464. {
  465. if (request.UnplayedCount.Value <= 0)
  466. {
  467. request.UnplayedCount = null;
  468. }
  469. }
  470. var imageInfo = GetImageInfo(request, item);
  471. if (imageInfo == null)
  472. {
  473. throw new ResourceNotFoundException(string.Format("{0} does not have an image of type {1}", item.Name, request.Type));
  474. }
  475. var supportedImageEnhancers = request.EnableImageEnhancers ? _imageProcessor.ImageEnhancers.Where(i =>
  476. {
  477. try
  478. {
  479. return i.Supports(item, request.Type);
  480. }
  481. catch (Exception ex)
  482. {
  483. Logger.ErrorException("Error in image enhancer: {0}", ex, i.GetType().Name);
  484. return false;
  485. }
  486. }).ToList() : new List<IImageEnhancer>();
  487. var cropwhitespace = request.Type == ImageType.Logo || request.Type == ImageType.Art;
  488. if (request.CropWhitespace.HasValue)
  489. {
  490. cropwhitespace = request.CropWhitespace.Value;
  491. }
  492. var format = GetOutputFormat(request, imageInfo, cropwhitespace, supportedImageEnhancers);
  493. var contentType = GetMimeType(format, imageInfo.Path);
  494. var cacheGuid = new Guid(_imageProcessor.GetImageCacheTag(item, imageInfo, supportedImageEnhancers));
  495. TimeSpan? cacheDuration = null;
  496. if (!string.IsNullOrEmpty(request.Tag) && cacheGuid == new Guid(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. format,
  510. supportedImageEnhancers,
  511. contentType,
  512. cacheDuration,
  513. responseHeaders,
  514. isHeadRequest)
  515. .Result;
  516. }
  517. private async Task<object> GetImageResult(IHasImages item,
  518. ImageRequest request,
  519. ItemImageInfo image,
  520. bool cropwhitespace,
  521. ImageFormat format,
  522. List<IImageEnhancer> enhancers,
  523. string contentType,
  524. TimeSpan? cacheDuration,
  525. IDictionary<string, string> headers,
  526. bool isHeadRequest)
  527. {
  528. var options = new ImageProcessingOptions
  529. {
  530. CropWhiteSpace = cropwhitespace,
  531. Enhancers = enhancers,
  532. Height = request.Height,
  533. ImageIndex = request.Index ?? 0,
  534. Image = image,
  535. Item = item,
  536. MaxHeight = request.MaxHeight,
  537. MaxWidth = request.MaxWidth,
  538. Quality = request.Quality,
  539. Width = request.Width,
  540. AddPlayedIndicator = request.AddPlayedIndicator,
  541. PercentPlayed = request.PercentPlayed ?? 0,
  542. UnplayedCount = request.UnplayedCount,
  543. BackgroundColor = request.BackgroundColor,
  544. OutputFormat = format
  545. };
  546. var file = await _imageProcessor.ProcessImage(options).ConfigureAwait(false);
  547. headers["Vary"] = "Accept";
  548. return ResultFactory.GetStaticFileResult(Request, new StaticFileResultOptions
  549. {
  550. CacheDuration = cacheDuration,
  551. ResponseHeaders = headers,
  552. ContentType = contentType,
  553. IsHeadRequest = isHeadRequest,
  554. Path = file
  555. });
  556. }
  557. private ImageFormat GetOutputFormat(ImageRequest request, ItemImageInfo image, bool cropwhitespace, List<IImageEnhancer> enhancers)
  558. {
  559. if (!string.IsNullOrWhiteSpace(request.Format))
  560. {
  561. ImageFormat format;
  562. if (Enum.TryParse(request.Format, true, out format))
  563. {
  564. return format;
  565. }
  566. }
  567. var extension = Path.GetExtension(image.Path);
  568. ImageFormat? inputFormat = null;
  569. if (string.Equals(extension, ".jpg", StringComparison.OrdinalIgnoreCase) ||
  570. string.Equals(extension, ".jpeg", StringComparison.OrdinalIgnoreCase))
  571. {
  572. inputFormat = ImageFormat.Jpg;
  573. }
  574. else if (string.Equals(extension, ".png", StringComparison.OrdinalIgnoreCase))
  575. {
  576. inputFormat = ImageFormat.Png;
  577. }
  578. var clientSupportedFormats = GetClientSupportedFormats();
  579. if (inputFormat.HasValue && clientSupportedFormats.Contains(inputFormat.Value) && enhancers.Count == 0)
  580. {
  581. if ((request.Quality ?? 100) == 100 && !request.Height.HasValue && !request.Width.HasValue &&
  582. !request.AddPlayedIndicator && !request.PercentPlayed.HasValue && !request.UnplayedCount.HasValue && string.IsNullOrWhiteSpace(request.BackgroundColor))
  583. {
  584. // TODO: Allow this when specfying max width/height if the value is in range
  585. if (!cropwhitespace && !request.MaxHeight.HasValue && !request.MaxWidth.HasValue)
  586. {
  587. return inputFormat.Value;
  588. }
  589. }
  590. }
  591. var serverFormats = _imageProcessor.GetSupportedImageOutputFormats();
  592. // Client doesn't care about format, so start with webp if supported
  593. if (serverFormats.Contains(ImageFormat.Webp) && clientSupportedFormats.Contains(ImageFormat.Webp))
  594. {
  595. return ImageFormat.Webp;
  596. }
  597. if (enhancers.Count > 0)
  598. {
  599. return ImageFormat.Png;
  600. }
  601. if (inputFormat.HasValue && inputFormat.Value == ImageFormat.Jpg)
  602. {
  603. return ImageFormat.Jpg;
  604. }
  605. // We can't predict if there will be transparency or not, so play it safe
  606. return ImageFormat.Png;
  607. }
  608. private ImageFormat[] GetClientSupportedFormats()
  609. {
  610. var supportsWebP = (Request.AcceptTypes ?? new string[] { }).Contains("image/webp", StringComparer.OrdinalIgnoreCase);
  611. var userAgent = Request.UserAgent ?? string.Empty;
  612. if (userAgent.IndexOf("crosswalk", StringComparison.OrdinalIgnoreCase) != -1 &&
  613. userAgent.IndexOf("android", StringComparison.OrdinalIgnoreCase) != -1)
  614. {
  615. supportsWebP = true;
  616. }
  617. if (supportsWebP)
  618. {
  619. // Not displaying properly on iOS
  620. if (userAgent.IndexOf("cfnetwork", StringComparison.OrdinalIgnoreCase) == -1)
  621. {
  622. return new[] { ImageFormat.Webp, ImageFormat.Jpg, ImageFormat.Png };
  623. }
  624. }
  625. return new[] { ImageFormat.Jpg, ImageFormat.Png };
  626. }
  627. private string GetMimeType(ImageFormat format, string path)
  628. {
  629. if (format == ImageFormat.Bmp)
  630. {
  631. return MimeTypes.GetMimeType("i.bmp");
  632. }
  633. if (format == ImageFormat.Gif)
  634. {
  635. return MimeTypes.GetMimeType("i.gif");
  636. }
  637. if (format == ImageFormat.Jpg)
  638. {
  639. return MimeTypes.GetMimeType("i.jpg");
  640. }
  641. if (format == ImageFormat.Png)
  642. {
  643. return MimeTypes.GetMimeType("i.png");
  644. }
  645. if (format == ImageFormat.Webp)
  646. {
  647. return MimeTypes.GetMimeType("i.webp");
  648. }
  649. return MimeTypes.GetMimeType(path);
  650. }
  651. /// <summary>
  652. /// Gets the image path.
  653. /// </summary>
  654. /// <param name="request">The request.</param>
  655. /// <param name="item">The item.</param>
  656. /// <returns>System.String.</returns>
  657. private ItemImageInfo GetImageInfo(ImageRequest request, IHasImages item)
  658. {
  659. var index = request.Index ?? 0;
  660. return item.GetImageInfo(request.Type, index);
  661. }
  662. /// <summary>
  663. /// Posts the image.
  664. /// </summary>
  665. /// <param name="entity">The entity.</param>
  666. /// <param name="inputStream">The input stream.</param>
  667. /// <param name="imageType">Type of the image.</param>
  668. /// <param name="mimeType">Type of the MIME.</param>
  669. /// <returns>Task.</returns>
  670. public async Task PostImage(BaseItem entity, Stream inputStream, ImageType imageType, string mimeType)
  671. {
  672. using (var reader = new StreamReader(inputStream))
  673. {
  674. var text = await reader.ReadToEndAsync().ConfigureAwait(false);
  675. var bytes = Convert.FromBase64String(text);
  676. var memoryStream = new MemoryStream(bytes)
  677. {
  678. Position = 0
  679. };
  680. // Handle image/png; charset=utf-8
  681. mimeType = mimeType.Split(';').FirstOrDefault();
  682. await _providerManager.SaveImage(entity, memoryStream, mimeType, imageType, null, CancellationToken.None).ConfigureAwait(false);
  683. await entity.UpdateToRepository(ItemUpdateType.ImageUpdate, CancellationToken.None).ConfigureAwait(false);
  684. }
  685. }
  686. }
  687. }