ImageProcessor.cs 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889
  1. using ImageMagickSharp;
  2. using MediaBrowser.Common.Extensions;
  3. using MediaBrowser.Common.IO;
  4. using MediaBrowser.Controller;
  5. using MediaBrowser.Controller.Drawing;
  6. using MediaBrowser.Controller.Entities;
  7. using MediaBrowser.Controller.Providers;
  8. using MediaBrowser.Model.Drawing;
  9. using MediaBrowser.Model.Entities;
  10. using MediaBrowser.Model.Logging;
  11. using MediaBrowser.Model.Serialization;
  12. using System;
  13. using System.Collections.Concurrent;
  14. using System.Collections.Generic;
  15. using System.Globalization;
  16. using System.IO;
  17. using System.Linq;
  18. using System.Threading;
  19. using System.Threading.Tasks;
  20. namespace MediaBrowser.Server.Implementations.Drawing
  21. {
  22. /// <summary>
  23. /// Class ImageProcessor
  24. /// </summary>
  25. public class ImageProcessor : IImageProcessor, IDisposable
  26. {
  27. /// <summary>
  28. /// The us culture
  29. /// </summary>
  30. protected readonly CultureInfo UsCulture = new CultureInfo("en-US");
  31. /// <summary>
  32. /// The _cached imaged sizes
  33. /// </summary>
  34. private readonly ConcurrentDictionary<Guid, ImageSize> _cachedImagedSizes;
  35. /// <summary>
  36. /// Gets the list of currently registered image processors
  37. /// Image processors are specialized metadata providers that run after the normal ones
  38. /// </summary>
  39. /// <value>The image enhancers.</value>
  40. public IEnumerable<IImageEnhancer> ImageEnhancers { get; private set; }
  41. /// <summary>
  42. /// The _logger
  43. /// </summary>
  44. private readonly ILogger _logger;
  45. private readonly IFileSystem _fileSystem;
  46. private readonly IJsonSerializer _jsonSerializer;
  47. private readonly IServerApplicationPaths _appPaths;
  48. public ImageProcessor(ILogger logger, IServerApplicationPaths appPaths, IFileSystem fileSystem, IJsonSerializer jsonSerializer)
  49. {
  50. _logger = logger;
  51. _fileSystem = fileSystem;
  52. _jsonSerializer = jsonSerializer;
  53. _appPaths = appPaths;
  54. _saveImageSizeTimer = new Timer(SaveImageSizeCallback, null, Timeout.Infinite, Timeout.Infinite);
  55. Dictionary<Guid, ImageSize> sizeDictionary;
  56. try
  57. {
  58. sizeDictionary = jsonSerializer.DeserializeFromFile<Dictionary<Guid, ImageSize>>(ImageSizeFile) ??
  59. new Dictionary<Guid, ImageSize>();
  60. }
  61. catch (FileNotFoundException)
  62. {
  63. // No biggie
  64. sizeDictionary = new Dictionary<Guid, ImageSize>();
  65. }
  66. catch (DirectoryNotFoundException)
  67. {
  68. // No biggie
  69. sizeDictionary = new Dictionary<Guid, ImageSize>();
  70. }
  71. catch (Exception ex)
  72. {
  73. logger.ErrorException("Error parsing image size cache file", ex);
  74. sizeDictionary = new Dictionary<Guid, ImageSize>();
  75. }
  76. _cachedImagedSizes = new ConcurrentDictionary<Guid, ImageSize>(sizeDictionary);
  77. LogImageMagickVersionVersion();
  78. }
  79. private string ResizedImageCachePath
  80. {
  81. get
  82. {
  83. return Path.Combine(_appPaths.ImageCachePath, "resized-images");
  84. }
  85. }
  86. private string EnhancedImageCachePath
  87. {
  88. get
  89. {
  90. return Path.Combine(_appPaths.ImageCachePath, "enhanced-images");
  91. }
  92. }
  93. private string CroppedWhitespaceImageCachePath
  94. {
  95. get
  96. {
  97. return Path.Combine(_appPaths.ImageCachePath, "cropped-images");
  98. }
  99. }
  100. public void AddParts(IEnumerable<IImageEnhancer> enhancers)
  101. {
  102. ImageEnhancers = enhancers.ToArray();
  103. }
  104. public async Task ProcessImage(ImageProcessingOptions options, Stream toStream)
  105. {
  106. var file = await ProcessImage(options).ConfigureAwait(false);
  107. using (var fileStream = _fileSystem.GetFileStream(file, FileMode.Open, FileAccess.Read, FileShare.Read, true))
  108. {
  109. await fileStream.CopyToAsync(toStream).ConfigureAwait(false);
  110. }
  111. }
  112. public ImageFormat[] GetSupportedImageOutputFormats()
  113. {
  114. if (_webpAvailable)
  115. {
  116. return new[] { ImageFormat.Webp, ImageFormat.Gif, ImageFormat.Jpg, ImageFormat.Png };
  117. }
  118. return new[] { ImageFormat.Gif, ImageFormat.Jpg, ImageFormat.Png };
  119. }
  120. private bool _webpAvailable = true;
  121. private void TestWebp()
  122. {
  123. try
  124. {
  125. var tmpPath = Path.Combine(_appPaths.TempDirectory, Guid.NewGuid() + ".webp");
  126. Directory.CreateDirectory(Path.GetDirectoryName(tmpPath));
  127. using (var wand = new MagickWand(1, 1, new PixelWand("none", 1)))
  128. {
  129. wand.SaveImage(tmpPath);
  130. }
  131. }
  132. catch (Exception ex)
  133. {
  134. _logger.ErrorException("Error loading webp: ", ex);
  135. _webpAvailable = false;
  136. }
  137. }
  138. private void LogImageMagickVersionVersion()
  139. {
  140. try
  141. {
  142. _logger.Info("ImageMagick version: " + Wand.VersionString);
  143. }
  144. catch (Exception ex)
  145. {
  146. _logger.ErrorException("Error loading ImageMagick: ", ex);
  147. }
  148. TestWebp();
  149. }
  150. public async Task<string> ProcessImage(ImageProcessingOptions options)
  151. {
  152. if (options == null)
  153. {
  154. throw new ArgumentNullException("options");
  155. }
  156. var originalImagePath = options.Image.Path;
  157. if (options.HasDefaultOptions(originalImagePath) && options.Enhancers.Count == 0 && !options.CropWhiteSpace)
  158. {
  159. // Just spit out the original file if all the options are default
  160. return originalImagePath;
  161. }
  162. var dateModified = options.Image.DateModified;
  163. var length = options.Image.Length;
  164. if (options.CropWhiteSpace)
  165. {
  166. var tuple = await GetWhitespaceCroppedImage(originalImagePath, dateModified, length).ConfigureAwait(false);
  167. originalImagePath = tuple.Item1;
  168. dateModified = tuple.Item2;
  169. length = tuple.Item3;
  170. }
  171. if (options.Enhancers.Count > 0)
  172. {
  173. var tuple = await GetEnhancedImage(new ItemImageInfo
  174. {
  175. Length = length,
  176. DateModified = dateModified,
  177. Type = options.Image.Type,
  178. Path = originalImagePath
  179. }, options.Item, options.ImageIndex, options.Enhancers).ConfigureAwait(false);
  180. originalImagePath = tuple.Item1;
  181. dateModified = tuple.Item2;
  182. length = tuple.Item3;
  183. }
  184. var originalImageSize = GetImageSize(originalImagePath, dateModified);
  185. // Determine the output size based on incoming parameters
  186. var newSize = DrawingUtils.Resize(originalImageSize, options.Width, options.Height, options.MaxWidth, options.MaxHeight);
  187. if (options.HasDefaultOptionsWithoutSize(originalImagePath) && newSize.Equals(originalImageSize) && options.Enhancers.Count == 0)
  188. {
  189. // Just spit out the original file if the new size equals the old
  190. return originalImagePath;
  191. }
  192. var quality = options.Quality ?? 90;
  193. var outputFormat = GetOutputFormat(options.OutputFormat);
  194. var cacheFilePath = GetCacheFilePath(originalImagePath, newSize, quality, dateModified, length, outputFormat, options.AddPlayedIndicator, options.PercentPlayed, options.UnplayedCount, options.BackgroundColor);
  195. var semaphore = GetLock(cacheFilePath);
  196. await semaphore.WaitAsync().ConfigureAwait(false);
  197. // Check again in case of lock contention
  198. try
  199. {
  200. if (File.Exists(cacheFilePath))
  201. {
  202. semaphore.Release();
  203. return cacheFilePath;
  204. }
  205. }
  206. catch
  207. {
  208. semaphore.Release();
  209. throw;
  210. }
  211. try
  212. {
  213. CheckDisposed();
  214. var newWidth = Convert.ToInt32(newSize.Width);
  215. var newHeight = Convert.ToInt32(newSize.Height);
  216. Directory.CreateDirectory(Path.GetDirectoryName(cacheFilePath));
  217. if (string.IsNullOrWhiteSpace(options.BackgroundColor))
  218. {
  219. using (var originalImage = new MagickWand(originalImagePath))
  220. {
  221. originalImage.CurrentImage.ResizeImage(newWidth, newHeight);
  222. DrawIndicator(originalImage, newWidth, newHeight, options);
  223. originalImage.CurrentImage.CompressionQuality = quality;
  224. originalImage.SaveImage(cacheFilePath);
  225. return cacheFilePath;
  226. }
  227. }
  228. else
  229. {
  230. using (var wand = new MagickWand(newWidth, newHeight, options.BackgroundColor))
  231. {
  232. using (var originalImage = new MagickWand(originalImagePath))
  233. {
  234. originalImage.CurrentImage.ResizeImage(newWidth, newHeight);
  235. wand.CurrentImage.CompositeImage(originalImage, CompositeOperator.OverCompositeOp, 0, 0);
  236. DrawIndicator(wand, newWidth, newHeight, options);
  237. wand.CurrentImage.CompressionQuality = quality;
  238. wand.SaveImage(cacheFilePath);
  239. return cacheFilePath;
  240. }
  241. }
  242. }
  243. }
  244. finally
  245. {
  246. semaphore.Release();
  247. }
  248. }
  249. private ImageFormat GetOutputFormat(ImageFormat requestedFormat)
  250. {
  251. if (requestedFormat == ImageFormat.Webp && !_webpAvailable)
  252. {
  253. return ImageFormat.Png;
  254. }
  255. return requestedFormat;
  256. }
  257. /// <summary>
  258. /// Draws the indicator.
  259. /// </summary>
  260. /// <param name="wand">The wand.</param>
  261. /// <param name="imageWidth">Width of the image.</param>
  262. /// <param name="imageHeight">Height of the image.</param>
  263. /// <param name="options">The options.</param>
  264. private void DrawIndicator(MagickWand wand, int imageWidth, int imageHeight, ImageProcessingOptions options)
  265. {
  266. if (!options.AddPlayedIndicator && !options.UnplayedCount.HasValue && options.PercentPlayed.Equals(0))
  267. {
  268. return;
  269. }
  270. try
  271. {
  272. if (options.AddPlayedIndicator)
  273. {
  274. var currentImageSize = new ImageSize(imageWidth, imageHeight);
  275. new PlayedIndicatorDrawer(_appPaths).DrawPlayedIndicator(wand, currentImageSize);
  276. }
  277. else if (options.UnplayedCount.HasValue)
  278. {
  279. var currentImageSize = new ImageSize(imageWidth, imageHeight);
  280. new UnplayedCountIndicator(_appPaths).DrawUnplayedCountIndicator(wand, currentImageSize, options.UnplayedCount.Value);
  281. }
  282. if (options.PercentPlayed > 0)
  283. {
  284. new PercentPlayedDrawer().Process(wand, options.PercentPlayed);
  285. }
  286. }
  287. catch (Exception ex)
  288. {
  289. _logger.ErrorException("Error drawing indicator overlay", ex);
  290. }
  291. }
  292. /// <summary>
  293. /// Crops whitespace from an image, caches the result, and returns the cached path
  294. /// </summary>
  295. private async Task<Tuple<string, DateTime, long>> GetWhitespaceCroppedImage(string originalImagePath, DateTime dateModified, long length)
  296. {
  297. var name = originalImagePath;
  298. name += "datemodified=" + dateModified.Ticks;
  299. name += "length=" + length;
  300. var croppedImagePath = GetCachePath(CroppedWhitespaceImageCachePath, name, Path.GetExtension(originalImagePath));
  301. var semaphore = GetLock(croppedImagePath);
  302. await semaphore.WaitAsync().ConfigureAwait(false);
  303. // Check again in case of contention
  304. if (File.Exists(croppedImagePath))
  305. {
  306. semaphore.Release();
  307. return GetResult(croppedImagePath);
  308. }
  309. try
  310. {
  311. Directory.CreateDirectory(Path.GetDirectoryName(croppedImagePath));
  312. using (var wand = new MagickWand(originalImagePath))
  313. {
  314. wand.CurrentImage.TrimImage(10);
  315. wand.SaveImage(croppedImagePath);
  316. }
  317. }
  318. catch (Exception ex)
  319. {
  320. // We have to have a catch-all here because some of the .net image methods throw a plain old Exception
  321. _logger.ErrorException("Error cropping image {0}", ex, originalImagePath);
  322. return new Tuple<string, DateTime, long>(originalImagePath, dateModified, length);
  323. }
  324. finally
  325. {
  326. semaphore.Release();
  327. }
  328. return GetResult(croppedImagePath);
  329. }
  330. private Tuple<string, DateTime, long> GetResult(string path)
  331. {
  332. var file = new FileInfo(path);
  333. return new Tuple<string, DateTime, long>(path, _fileSystem.GetLastWriteTimeUtc(file), file.Length);
  334. }
  335. /// <summary>
  336. /// Increment this when there's a change requiring caches to be invalidated
  337. /// </summary>
  338. private const string Version = "3";
  339. /// <summary>
  340. /// Gets the cache file path based on a set of parameters
  341. /// </summary>
  342. private string GetCacheFilePath(string originalPath, ImageSize outputSize, int quality, DateTime dateModified, long length, ImageFormat format, bool addPlayedIndicator, double percentPlayed, int? unwatchedCount, string backgroundColor)
  343. {
  344. var filename = originalPath;
  345. filename += "width=" + outputSize.Width;
  346. filename += "height=" + outputSize.Height;
  347. filename += "quality=" + quality;
  348. filename += "datemodified=" + dateModified.Ticks;
  349. filename += "length=" + length;
  350. filename += "f=" + format;
  351. if (addPlayedIndicator)
  352. {
  353. filename += "pl=true";
  354. }
  355. if (percentPlayed > 0)
  356. {
  357. filename += "p=" + percentPlayed;
  358. }
  359. if (unwatchedCount.HasValue)
  360. {
  361. filename += "p=" + unwatchedCount.Value;
  362. }
  363. if (!string.IsNullOrEmpty(backgroundColor))
  364. {
  365. filename += "b=" + backgroundColor;
  366. }
  367. filename += "v=" + Version;
  368. return GetCachePath(ResizedImageCachePath, filename, "." + format.ToString().ToLower());
  369. }
  370. /// <summary>
  371. /// Gets the size of the image.
  372. /// </summary>
  373. /// <param name="path">The path.</param>
  374. /// <returns>ImageSize.</returns>
  375. public ImageSize GetImageSize(string path)
  376. {
  377. return GetImageSize(path, File.GetLastWriteTimeUtc(path));
  378. }
  379. public ImageSize GetImageSize(ItemImageInfo info)
  380. {
  381. return GetImageSize(info.Path, info.DateModified);
  382. }
  383. /// <summary>
  384. /// Gets the size of the image.
  385. /// </summary>
  386. /// <param name="path">The path.</param>
  387. /// <param name="imageDateModified">The image date modified.</param>
  388. /// <returns>ImageSize.</returns>
  389. /// <exception cref="System.ArgumentNullException">path</exception>
  390. private ImageSize GetImageSize(string path, DateTime imageDateModified)
  391. {
  392. if (string.IsNullOrEmpty(path))
  393. {
  394. throw new ArgumentNullException("path");
  395. }
  396. var name = path + "datemodified=" + imageDateModified.Ticks;
  397. ImageSize size;
  398. var cacheHash = name.GetMD5();
  399. if (!_cachedImagedSizes.TryGetValue(cacheHash, out size))
  400. {
  401. size = GetImageSizeInternal(path);
  402. _cachedImagedSizes.AddOrUpdate(cacheHash, size, (keyName, oldValue) => size);
  403. }
  404. return size;
  405. }
  406. /// <summary>
  407. /// Gets the image size internal.
  408. /// </summary>
  409. /// <param name="path">The path.</param>
  410. /// <returns>ImageSize.</returns>
  411. private ImageSize GetImageSizeInternal(string path)
  412. {
  413. ImageSize size;
  414. try
  415. {
  416. size = ImageHeader.GetDimensions(path, _logger, _fileSystem);
  417. }
  418. catch
  419. {
  420. _logger.Info("Failed to read image header for {0}. Doing it the slow way.", path);
  421. CheckDisposed();
  422. using (var wand = new MagickWand())
  423. {
  424. wand.PingImage(path);
  425. var img = wand.CurrentImage;
  426. size = new ImageSize
  427. {
  428. Width = img.Width,
  429. Height = img.Height
  430. };
  431. }
  432. }
  433. StartSaveImageSizeTimer();
  434. return size;
  435. }
  436. private readonly Timer _saveImageSizeTimer;
  437. private const int SaveImageSizeTimeout = 5000;
  438. private readonly object _saveImageSizeLock = new object();
  439. private void StartSaveImageSizeTimer()
  440. {
  441. _saveImageSizeTimer.Change(SaveImageSizeTimeout, Timeout.Infinite);
  442. }
  443. private void SaveImageSizeCallback(object state)
  444. {
  445. lock (_saveImageSizeLock)
  446. {
  447. try
  448. {
  449. var path = ImageSizeFile;
  450. Directory.CreateDirectory(Path.GetDirectoryName(path));
  451. _jsonSerializer.SerializeToFile(_cachedImagedSizes, path);
  452. }
  453. catch (Exception ex)
  454. {
  455. _logger.ErrorException("Error saving image size file", ex);
  456. }
  457. }
  458. }
  459. private string ImageSizeFile
  460. {
  461. get
  462. {
  463. return Path.Combine(_appPaths.DataPath, "imagesizes.json");
  464. }
  465. }
  466. /// <summary>
  467. /// Gets the image cache tag.
  468. /// </summary>
  469. /// <param name="item">The item.</param>
  470. /// <param name="image">The image.</param>
  471. /// <returns>Guid.</returns>
  472. /// <exception cref="System.ArgumentNullException">item</exception>
  473. public string GetImageCacheTag(IHasImages item, ItemImageInfo image)
  474. {
  475. if (item == null)
  476. {
  477. throw new ArgumentNullException("item");
  478. }
  479. if (image == null)
  480. {
  481. throw new ArgumentNullException("image");
  482. }
  483. var supportedEnhancers = GetSupportedEnhancers(item, image.Type);
  484. return GetImageCacheTag(item, image, supportedEnhancers.ToList());
  485. }
  486. /// <summary>
  487. /// Gets the image cache tag.
  488. /// </summary>
  489. /// <param name="item">The item.</param>
  490. /// <param name="image">The image.</param>
  491. /// <param name="imageEnhancers">The image enhancers.</param>
  492. /// <returns>Guid.</returns>
  493. /// <exception cref="System.ArgumentNullException">item</exception>
  494. public string GetImageCacheTag(IHasImages item, ItemImageInfo image, List<IImageEnhancer> imageEnhancers)
  495. {
  496. if (item == null)
  497. {
  498. throw new ArgumentNullException("item");
  499. }
  500. if (imageEnhancers == null)
  501. {
  502. throw new ArgumentNullException("imageEnhancers");
  503. }
  504. if (image == null)
  505. {
  506. throw new ArgumentNullException("image");
  507. }
  508. var originalImagePath = image.Path;
  509. var dateModified = image.DateModified;
  510. var imageType = image.Type;
  511. var length = image.Length;
  512. // Optimization
  513. if (imageEnhancers.Count == 0)
  514. {
  515. return (originalImagePath + dateModified.Ticks + string.Empty + length).GetMD5().ToString("N");
  516. }
  517. // Cache name is created with supported enhancers combined with the last config change so we pick up new config changes
  518. var cacheKeys = imageEnhancers.Select(i => i.GetConfigurationCacheKey(item, imageType)).ToList();
  519. cacheKeys.Add(originalImagePath + dateModified.Ticks + string.Empty + length);
  520. return string.Join("|", cacheKeys.ToArray()).GetMD5().ToString("N");
  521. }
  522. /// <summary>
  523. /// Gets the enhanced image.
  524. /// </summary>
  525. /// <param name="item">The item.</param>
  526. /// <param name="imageType">Type of the image.</param>
  527. /// <param name="imageIndex">Index of the image.</param>
  528. /// <returns>Task{System.String}.</returns>
  529. public async Task<string> GetEnhancedImage(IHasImages item, ImageType imageType, int imageIndex)
  530. {
  531. var enhancers = GetSupportedEnhancers(item, imageType).ToList();
  532. var imageInfo = item.GetImageInfo(imageType, imageIndex);
  533. var result = await GetEnhancedImage(imageInfo, item, imageIndex, enhancers);
  534. return result.Item1;
  535. }
  536. private async Task<Tuple<string, DateTime, long>> GetEnhancedImage(ItemImageInfo image,
  537. IHasImages item,
  538. int imageIndex,
  539. List<IImageEnhancer> enhancers)
  540. {
  541. var originalImagePath = image.Path;
  542. var dateModified = image.DateModified;
  543. var imageType = image.Type;
  544. var length = image.Length;
  545. try
  546. {
  547. var cacheGuid = GetImageCacheTag(item, image, enhancers);
  548. // Enhance if we have enhancers
  549. var ehnancedImagePath = await GetEnhancedImageInternal(originalImagePath, item, imageType, imageIndex, enhancers, cacheGuid).ConfigureAwait(false);
  550. // If the path changed update dateModified
  551. if (!ehnancedImagePath.Equals(originalImagePath, StringComparison.OrdinalIgnoreCase))
  552. {
  553. return GetResult(ehnancedImagePath);
  554. }
  555. }
  556. catch (Exception ex)
  557. {
  558. _logger.Error("Error enhancing image", ex);
  559. }
  560. return new Tuple<string, DateTime, long>(originalImagePath, dateModified, length);
  561. }
  562. /// <summary>
  563. /// Gets the enhanced image internal.
  564. /// </summary>
  565. /// <param name="originalImagePath">The original image path.</param>
  566. /// <param name="item">The item.</param>
  567. /// <param name="imageType">Type of the image.</param>
  568. /// <param name="imageIndex">Index of the image.</param>
  569. /// <param name="supportedEnhancers">The supported enhancers.</param>
  570. /// <param name="cacheGuid">The cache unique identifier.</param>
  571. /// <returns>Task&lt;System.String&gt;.</returns>
  572. /// <exception cref="ArgumentNullException">
  573. /// originalImagePath
  574. /// or
  575. /// item
  576. /// </exception>
  577. private async Task<string> GetEnhancedImageInternal(string originalImagePath,
  578. IHasImages item,
  579. ImageType imageType,
  580. int imageIndex,
  581. IEnumerable<IImageEnhancer> supportedEnhancers,
  582. string cacheGuid)
  583. {
  584. if (string.IsNullOrEmpty(originalImagePath))
  585. {
  586. throw new ArgumentNullException("originalImagePath");
  587. }
  588. if (item == null)
  589. {
  590. throw new ArgumentNullException("item");
  591. }
  592. // All enhanced images are saved as png to allow transparency
  593. var enhancedImagePath = GetCachePath(EnhancedImageCachePath, cacheGuid + ".png");
  594. var semaphore = GetLock(enhancedImagePath);
  595. await semaphore.WaitAsync().ConfigureAwait(false);
  596. // Check again in case of contention
  597. if (File.Exists(enhancedImagePath))
  598. {
  599. semaphore.Release();
  600. return enhancedImagePath;
  601. }
  602. try
  603. {
  604. Directory.CreateDirectory(Path.GetDirectoryName(enhancedImagePath));
  605. await ExecuteImageEnhancers(supportedEnhancers, originalImagePath, enhancedImagePath, item, imageType, imageIndex).ConfigureAwait(false);
  606. }
  607. finally
  608. {
  609. semaphore.Release();
  610. }
  611. return enhancedImagePath;
  612. }
  613. /// <summary>
  614. /// Executes the image enhancers.
  615. /// </summary>
  616. /// <param name="imageEnhancers">The image enhancers.</param>
  617. /// <param name="inputPath">The input path.</param>
  618. /// <param name="outputPath">The output path.</param>
  619. /// <param name="item">The item.</param>
  620. /// <param name="imageType">Type of the image.</param>
  621. /// <param name="imageIndex">Index of the image.</param>
  622. /// <returns>Task{EnhancedImage}.</returns>
  623. private async Task ExecuteImageEnhancers(IEnumerable<IImageEnhancer> imageEnhancers, string inputPath, string outputPath, IHasImages item, ImageType imageType, int imageIndex)
  624. {
  625. // Run the enhancers sequentially in order of priority
  626. foreach (var enhancer in imageEnhancers)
  627. {
  628. var typeName = enhancer.GetType().Name;
  629. try
  630. {
  631. await enhancer.EnhanceImageAsync(item, inputPath, outputPath, imageType, imageIndex).ConfigureAwait(false);
  632. }
  633. catch (Exception ex)
  634. {
  635. _logger.ErrorException("{0} failed enhancing {1}", ex, typeName, item.Name);
  636. throw;
  637. }
  638. // Feed the output into the next enhancer as input
  639. inputPath = outputPath;
  640. }
  641. }
  642. /// <summary>
  643. /// The _semaphoreLocks
  644. /// </summary>
  645. private readonly ConcurrentDictionary<string, SemaphoreSlim> _semaphoreLocks = new ConcurrentDictionary<string, SemaphoreSlim>();
  646. /// <summary>
  647. /// Gets the lock.
  648. /// </summary>
  649. /// <param name="filename">The filename.</param>
  650. /// <returns>System.Object.</returns>
  651. private SemaphoreSlim GetLock(string filename)
  652. {
  653. return _semaphoreLocks.GetOrAdd(filename, key => new SemaphoreSlim(1, 1));
  654. }
  655. /// <summary>
  656. /// Gets the cache path.
  657. /// </summary>
  658. /// <param name="path">The path.</param>
  659. /// <param name="uniqueName">Name of the unique.</param>
  660. /// <param name="fileExtension">The file extension.</param>
  661. /// <returns>System.String.</returns>
  662. /// <exception cref="System.ArgumentNullException">
  663. /// path
  664. /// or
  665. /// uniqueName
  666. /// or
  667. /// fileExtension
  668. /// </exception>
  669. public string GetCachePath(string path, string uniqueName, string fileExtension)
  670. {
  671. if (string.IsNullOrEmpty(path))
  672. {
  673. throw new ArgumentNullException("path");
  674. }
  675. if (string.IsNullOrEmpty(uniqueName))
  676. {
  677. throw new ArgumentNullException("uniqueName");
  678. }
  679. if (string.IsNullOrEmpty(fileExtension))
  680. {
  681. throw new ArgumentNullException("fileExtension");
  682. }
  683. var filename = uniqueName.GetMD5() + fileExtension;
  684. return GetCachePath(path, filename);
  685. }
  686. /// <summary>
  687. /// Gets the cache path.
  688. /// </summary>
  689. /// <param name="path">The path.</param>
  690. /// <param name="filename">The filename.</param>
  691. /// <returns>System.String.</returns>
  692. /// <exception cref="System.ArgumentNullException">
  693. /// path
  694. /// or
  695. /// filename
  696. /// </exception>
  697. public string GetCachePath(string path, string filename)
  698. {
  699. if (string.IsNullOrEmpty(path))
  700. {
  701. throw new ArgumentNullException("path");
  702. }
  703. if (string.IsNullOrEmpty(filename))
  704. {
  705. throw new ArgumentNullException("filename");
  706. }
  707. var prefix = filename.Substring(0, 1);
  708. path = Path.Combine(path, prefix);
  709. return Path.Combine(path, filename);
  710. }
  711. public IEnumerable<IImageEnhancer> GetSupportedEnhancers(IHasImages item, ImageType imageType)
  712. {
  713. return ImageEnhancers.Where(i =>
  714. {
  715. try
  716. {
  717. return i.Supports(item, imageType);
  718. }
  719. catch (Exception ex)
  720. {
  721. _logger.ErrorException("Error in image enhancer: {0}", ex, i.GetType().Name);
  722. return false;
  723. }
  724. });
  725. }
  726. private bool _disposed;
  727. public void Dispose()
  728. {
  729. _disposed = true;
  730. Wand.CloseEnvironment();
  731. _saveImageSizeTimer.Dispose();
  732. }
  733. private void CheckDisposed()
  734. {
  735. if (_disposed)
  736. {
  737. throw new ObjectDisposedException(GetType().Name);
  738. }
  739. }
  740. }
  741. }