ImageService.cs 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Globalization;
  4. using System.IO;
  5. using System.Linq;
  6. using System.Runtime.CompilerServices;
  7. using System.Threading;
  8. using System.Threading.Tasks;
  9. using MediaBrowser.Common.Extensions;
  10. using MediaBrowser.Controller.Configuration;
  11. using MediaBrowser.Controller.Drawing;
  12. using MediaBrowser.Controller.Dto;
  13. using MediaBrowser.Controller.Entities;
  14. using MediaBrowser.Controller.Library;
  15. using MediaBrowser.Controller.Net;
  16. using MediaBrowser.Controller.Providers;
  17. using MediaBrowser.Model.Drawing;
  18. using MediaBrowser.Model.Dto;
  19. using MediaBrowser.Model.Entities;
  20. using MediaBrowser.Model.IO;
  21. using MediaBrowser.Model.Net;
  22. using MediaBrowser.Model.Services;
  23. using Microsoft.Extensions.Logging;
  24. using Microsoft.Net.Http.Headers;
  25. using User = Jellyfin.Data.Entities.User;
  26. namespace MediaBrowser.Api.Images
  27. {
  28. /// <summary>
  29. /// Class GetItemImage.
  30. /// </summary>
  31. [Route("/Items/{Id}/Images", "GET", Summary = "Gets information about an item's images")]
  32. [Authenticated]
  33. public class GetItemImageInfos : IReturn<List<ImageInfo>>
  34. {
  35. /// <summary>
  36. /// Gets or sets the id.
  37. /// </summary>
  38. /// <value>The id.</value>
  39. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
  40. public string Id { get; set; }
  41. }
  42. [Route("/Items/{Id}/Images/{Type}", "GET")]
  43. [Route("/Items/{Id}/Images/{Type}/{Index}", "GET")]
  44. [Route("/Items/{Id}/Images/{Type}", "HEAD")]
  45. [Route("/Items/{Id}/Images/{Type}/{Index}", "HEAD")]
  46. [Route("/Items/{Id}/Images/{Type}/{Index}/{Tag}/{Format}/{MaxWidth}/{MaxHeight}/{PercentPlayed}/{UnplayedCount}", "GET")]
  47. [Route("/Items/{Id}/Images/{Type}/{Index}/{Tag}/{Format}/{MaxWidth}/{MaxHeight}/{PercentPlayed}/{UnplayedCount}", "HEAD")]
  48. public class GetItemImage : ImageRequest
  49. {
  50. /// <summary>
  51. /// Gets or sets the id.
  52. /// </summary>
  53. /// <value>The id.</value>
  54. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path")]
  55. public Guid Id { get; set; }
  56. }
  57. /// <summary>
  58. /// Class UpdateItemImageIndex.
  59. /// </summary>
  60. [Route("/Items/{Id}/Images/{Type}/{Index}/Index", "POST", Summary = "Updates the index for an item image")]
  61. [Authenticated(Roles = "admin")]
  62. public class UpdateItemImageIndex : IReturnVoid
  63. {
  64. /// <summary>
  65. /// Gets or sets the id.
  66. /// </summary>
  67. /// <value>The id.</value>
  68. [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  69. public string Id { get; set; }
  70. /// <summary>
  71. /// Gets or sets the type of the image.
  72. /// </summary>
  73. /// <value>The type of the image.</value>
  74. [ApiMember(Name = "Type", Description = "Image Type", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
  75. public ImageType Type { get; set; }
  76. /// <summary>
  77. /// Gets or sets the index.
  78. /// </summary>
  79. /// <value>The index.</value>
  80. [ApiMember(Name = "Index", Description = "Image Index", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "POST")]
  81. public int Index { get; set; }
  82. /// <summary>
  83. /// Gets or sets the new index.
  84. /// </summary>
  85. /// <value>The new index.</value>
  86. [ApiMember(Name = "NewIndex", Description = "The new image index", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "POST")]
  87. public int NewIndex { get; set; }
  88. }
  89. /// <summary>
  90. /// Class GetPersonImage.
  91. /// </summary>
  92. [Route("/Artists/{Name}/Images/{Type}", "GET")]
  93. [Route("/Artists/{Name}/Images/{Type}/{Index}", "GET")]
  94. [Route("/Genres/{Name}/Images/{Type}", "GET")]
  95. [Route("/Genres/{Name}/Images/{Type}/{Index}", "GET")]
  96. [Route("/MusicGenres/{Name}/Images/{Type}", "GET")]
  97. [Route("/MusicGenres/{Name}/Images/{Type}/{Index}", "GET")]
  98. [Route("/Persons/{Name}/Images/{Type}", "GET")]
  99. [Route("/Persons/{Name}/Images/{Type}/{Index}", "GET")]
  100. [Route("/Studios/{Name}/Images/{Type}", "GET")]
  101. [Route("/Studios/{Name}/Images/{Type}/{Index}", "GET")]
  102. ////[Route("/Years/{Year}/Images/{Type}", "GET")]
  103. ////[Route("/Years/{Year}/Images/{Type}/{Index}", "GET")]
  104. [Route("/Artists/{Name}/Images/{Type}", "HEAD")]
  105. [Route("/Artists/{Name}/Images/{Type}/{Index}", "HEAD")]
  106. [Route("/Genres/{Name}/Images/{Type}", "HEAD")]
  107. [Route("/Genres/{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 Guid 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 Guid 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 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(
  226. ILogger<ImageService> logger,
  227. IServerConfigurationManager serverConfigurationManager,
  228. IHttpResultFactory httpResultFactory,
  229. IUserManager userManager,
  230. ILibraryManager libraryManager,
  231. IProviderManager providerManager,
  232. IImageProcessor imageProcessor,
  233. IFileSystem fileSystem,
  234. IAuthorizationContext authContext)
  235. : base(logger, serverConfigurationManager, httpResultFactory)
  236. {
  237. _userManager = userManager;
  238. _libraryManager = libraryManager;
  239. _providerManager = providerManager;
  240. _imageProcessor = imageProcessor;
  241. _fileSystem = fileSystem;
  242. _authContext = authContext;
  243. }
  244. /// <summary>
  245. /// Gets the specified request.
  246. /// </summary>
  247. /// <param name="request">The request.</param>
  248. /// <returns>System.Object.</returns>
  249. public object Get(GetItemImageInfos request)
  250. {
  251. var item = _libraryManager.GetItemById(request.Id);
  252. var result = GetItemImageInfos(item);
  253. return ToOptimizedResult(result);
  254. }
  255. /// <summary>
  256. /// Gets the item image infos.
  257. /// </summary>
  258. /// <param name="item">The item.</param>
  259. /// <returns>Task{List{ImageInfo}}.</returns>
  260. public List<ImageInfo> GetItemImageInfos(BaseItem item)
  261. {
  262. var list = new List<ImageInfo>();
  263. var itemImages = item.ImageInfos;
  264. if (itemImages.Length == 0)
  265. {
  266. // short-circuit
  267. return list;
  268. }
  269. _libraryManager.UpdateImages(item); // this makes sure dimensions and hashes are correct
  270. foreach (var image in itemImages)
  271. {
  272. if (!item.AllowsMultipleImages(image.Type))
  273. {
  274. var info = GetImageInfo(item, image, null);
  275. if (info != null)
  276. {
  277. list.Add(info);
  278. }
  279. }
  280. }
  281. foreach (var imageType in itemImages.Select(i => i.Type).Distinct().Where(item.AllowsMultipleImages))
  282. {
  283. var index = 0;
  284. // Prevent implicitly captured closure
  285. var currentImageType = imageType;
  286. foreach (var image in itemImages.Where(i => i.Type == currentImageType))
  287. {
  288. var info = GetImageInfo(item, image, index);
  289. if (info != null)
  290. {
  291. list.Add(info);
  292. }
  293. index++;
  294. }
  295. }
  296. return list;
  297. }
  298. private ImageInfo GetImageInfo(BaseItem item, ItemImageInfo info, int? imageIndex)
  299. {
  300. int? width = null;
  301. int? height = null;
  302. string blurhash = null;
  303. long length = 0;
  304. try
  305. {
  306. if (info.IsLocalFile)
  307. {
  308. var fileInfo = _fileSystem.GetFileInfo(info.Path);
  309. length = fileInfo.Length;
  310. blurhash = info.BlurHash;
  311. width = info.Width;
  312. height = info.Height;
  313. if (width <= 0 || height <= 0)
  314. {
  315. width = null;
  316. height = null;
  317. }
  318. }
  319. }
  320. catch (Exception ex)
  321. {
  322. Logger.LogError(ex, "Error getting image information for {Item}", item.Name);
  323. }
  324. try
  325. {
  326. return new ImageInfo
  327. {
  328. Path = info.Path,
  329. ImageIndex = imageIndex,
  330. ImageType = info.Type,
  331. ImageTag = _imageProcessor.GetImageCacheTag(item, info),
  332. Size = length,
  333. BlurHash = blurhash,
  334. Width = width,
  335. Height = height
  336. };
  337. }
  338. catch (Exception ex)
  339. {
  340. Logger.LogError(ex, "Error getting image information for {Path}", info.Path);
  341. return null;
  342. }
  343. }
  344. /// <summary>
  345. /// Gets the specified request.
  346. /// </summary>
  347. /// <param name="request">The request.</param>
  348. /// <returns>System.Object.</returns>
  349. public object Get(GetItemImage request)
  350. {
  351. return GetImage(request, request.Id, null, false);
  352. }
  353. /// <summary>
  354. /// Gets the specified request.
  355. /// </summary>
  356. /// <param name="request">The request.</param>
  357. /// <returns>System.Object.</returns>
  358. public object Head(GetItemImage request)
  359. {
  360. return GetImage(request, request.Id, null, true);
  361. }
  362. /// <summary>
  363. /// Gets the specified request.
  364. /// </summary>
  365. /// <param name="request">The request.</param>
  366. /// <returns>System.Object.</returns>
  367. public object Get(GetUserImage request)
  368. {
  369. var item = _userManager.GetUserById(request.Id);
  370. return GetImage(request, item, false);
  371. }
  372. public object Head(GetUserImage request)
  373. {
  374. var item = _userManager.GetUserById(request.Id);
  375. return GetImage(request, item, true);
  376. }
  377. public object Get(GetItemByNameImage request)
  378. {
  379. var type = GetPathValue(0).ToString();
  380. var item = GetItemByName(request.Name, type, _libraryManager, new DtoOptions(false));
  381. return GetImage(request, item.Id, item, false);
  382. }
  383. public object Head(GetItemByNameImage request)
  384. {
  385. var type = GetPathValue(0).ToString();
  386. var item = GetItemByName(request.Name, type, _libraryManager, new DtoOptions(false));
  387. return GetImage(request, item.Id, item, true);
  388. }
  389. /// <summary>
  390. /// Posts the specified request.
  391. /// </summary>
  392. /// <param name="request">The request.</param>
  393. public Task Post(PostUserImage request)
  394. {
  395. var id = Guid.Parse(GetPathValue(1));
  396. AssertCanUpdateUser(_authContext, _userManager, id, true);
  397. request.Type = Enum.Parse<ImageType>(GetPathValue(3).ToString(), true);
  398. var user = _userManager.GetUserById(id);
  399. return PostImage(user, request.RequestStream, Request.ContentType);
  400. }
  401. /// <summary>
  402. /// Posts the specified request.
  403. /// </summary>
  404. /// <param name="request">The request.</param>
  405. public Task Post(PostItemImage request)
  406. {
  407. var id = Guid.Parse(GetPathValue(1));
  408. request.Type = Enum.Parse<ImageType>(GetPathValue(3).ToString(), true);
  409. var item = _libraryManager.GetItemById(id);
  410. return PostImage(item, request.RequestStream, request.Type, Request.ContentType);
  411. }
  412. /// <summary>
  413. /// Deletes the specified request.
  414. /// </summary>
  415. /// <param name="request">The request.</param>
  416. public void Delete(DeleteUserImage request)
  417. {
  418. var userId = request.Id;
  419. AssertCanUpdateUser(_authContext, _userManager, userId, true);
  420. var user = _userManager.GetUserById(userId);
  421. try
  422. {
  423. File.Delete(user.ProfileImage.Path);
  424. }
  425. catch (IOException e)
  426. {
  427. Logger.LogError(e, "Error deleting user profile image:");
  428. }
  429. _userManager.ClearProfileImage(user);
  430. }
  431. /// <summary>
  432. /// Deletes the specified request.
  433. /// </summary>
  434. /// <param name="request">The request.</param>
  435. public void Delete(DeleteItemImage request)
  436. {
  437. var item = _libraryManager.GetItemById(request.Id);
  438. item.DeleteImage(request.Type, request.Index ?? 0);
  439. }
  440. /// <summary>
  441. /// Posts the specified request.
  442. /// </summary>
  443. /// <param name="request">The request.</param>
  444. public void Post(UpdateItemImageIndex request)
  445. {
  446. var item = _libraryManager.GetItemById(request.Id);
  447. UpdateItemIndex(item, request.Type, request.Index, request.NewIndex);
  448. }
  449. /// <summary>
  450. /// Updates the index of the item.
  451. /// </summary>
  452. /// <param name="item">The item.</param>
  453. /// <param name="type">The type.</param>
  454. /// <param name="currentIndex">Index of the current.</param>
  455. /// <param name="newIndex">The new index.</param>
  456. /// <returns>Task.</returns>
  457. private void UpdateItemIndex(BaseItem item, ImageType type, int currentIndex, int newIndex)
  458. {
  459. item.SwapImages(type, currentIndex, newIndex);
  460. }
  461. /// <summary>
  462. /// Gets the image.
  463. /// </summary>
  464. /// <param name="request">The request.</param>
  465. /// <param name="item">The item.</param>
  466. /// <param name="isHeadRequest">if set to <c>true</c> [is head request].</param>
  467. /// <returns>System.Object.</returns>
  468. /// <exception cref="ResourceNotFoundException"></exception>
  469. public Task<object> GetImage(ImageRequest request, Guid itemId, BaseItem item, bool isHeadRequest)
  470. {
  471. if (request.PercentPlayed.HasValue)
  472. {
  473. if (request.PercentPlayed.Value <= 0)
  474. {
  475. request.PercentPlayed = null;
  476. }
  477. else if (request.PercentPlayed.Value >= 100)
  478. {
  479. request.PercentPlayed = null;
  480. request.AddPlayedIndicator = true;
  481. }
  482. }
  483. if (request.PercentPlayed.HasValue)
  484. {
  485. request.UnplayedCount = null;
  486. }
  487. if (request.UnplayedCount.HasValue
  488. && request.UnplayedCount.Value <= 0)
  489. {
  490. request.UnplayedCount = null;
  491. }
  492. if (item == null)
  493. {
  494. item = _libraryManager.GetItemById(itemId);
  495. if (item == null)
  496. {
  497. throw new ResourceNotFoundException(string.Format("Item {0} not found.", itemId.ToString("N", CultureInfo.InvariantCulture)));
  498. }
  499. }
  500. var imageInfo = GetImageInfo(request, item);
  501. if (imageInfo == null)
  502. {
  503. throw new ResourceNotFoundException(string.Format("{0} does not have an image of type {1}", item.Name, request.Type));
  504. }
  505. bool cropWhitespace;
  506. if (request.CropWhitespace.HasValue)
  507. {
  508. cropWhitespace = request.CropWhitespace.Value;
  509. }
  510. else
  511. {
  512. cropWhitespace = request.Type == ImageType.Logo || request.Type == ImageType.Art;
  513. }
  514. var outputFormats = GetOutputFormats(request);
  515. TimeSpan? cacheDuration = null;
  516. if (!string.IsNullOrEmpty(request.Tag))
  517. {
  518. cacheDuration = TimeSpan.FromDays(365);
  519. }
  520. var responseHeaders = new Dictionary<string, string>
  521. {
  522. {"transferMode.dlna.org", "Interactive"},
  523. {"realTimeInfo.dlna.org", "DLNA.ORG_TLAG=*"}
  524. };
  525. return GetImageResult(
  526. item,
  527. itemId,
  528. request,
  529. imageInfo,
  530. cropWhitespace,
  531. outputFormats,
  532. cacheDuration,
  533. responseHeaders,
  534. isHeadRequest);
  535. }
  536. public Task<object> GetImage(ImageRequest request, User user, bool isHeadRequest)
  537. {
  538. var imageInfo = GetImageInfo(request, user);
  539. TimeSpan? cacheDuration = null;
  540. if (!string.IsNullOrEmpty(request.Tag))
  541. {
  542. cacheDuration = TimeSpan.FromDays(365);
  543. }
  544. var responseHeaders = new Dictionary<string, string>
  545. {
  546. {"transferMode.dlna.org", "Interactive"},
  547. {"realTimeInfo.dlna.org", "DLNA.ORG_TLAG=*"}
  548. };
  549. var outputFormats = GetOutputFormats(request);
  550. return GetImageResult(user.Id,
  551. request,
  552. imageInfo,
  553. outputFormats,
  554. cacheDuration,
  555. responseHeaders,
  556. isHeadRequest);
  557. }
  558. private async Task<object> GetImageResult(
  559. Guid itemId,
  560. ImageRequest request,
  561. ItemImageInfo info,
  562. IReadOnlyCollection<ImageFormat> supportedFormats,
  563. TimeSpan? cacheDuration,
  564. IDictionary<string, string> headers,
  565. bool isHeadRequest)
  566. {
  567. info.Type = ImageType.Profile;
  568. var options = new ImageProcessingOptions
  569. {
  570. CropWhiteSpace = true,
  571. Height = request.Height,
  572. ImageIndex = request.Index ?? 0,
  573. Image = info,
  574. Item = null, // Hack alert
  575. ItemId = itemId,
  576. MaxHeight = request.MaxHeight,
  577. MaxWidth = request.MaxWidth,
  578. Quality = request.Quality ?? 100,
  579. Width = request.Width,
  580. AddPlayedIndicator = request.AddPlayedIndicator,
  581. PercentPlayed = 0,
  582. UnplayedCount = request.UnplayedCount,
  583. Blur = request.Blur,
  584. BackgroundColor = request.BackgroundColor,
  585. ForegroundLayer = request.ForegroundLayer,
  586. SupportedOutputFormats = supportedFormats
  587. };
  588. var imageResult = await _imageProcessor.ProcessImage(options).ConfigureAwait(false);
  589. headers[HeaderNames.Vary] = HeaderNames.Accept;
  590. return await ResultFactory.GetStaticFileResult(Request, new StaticFileResultOptions
  591. {
  592. CacheDuration = cacheDuration,
  593. ResponseHeaders = headers,
  594. ContentType = imageResult.Item2,
  595. DateLastModified = imageResult.Item3,
  596. IsHeadRequest = isHeadRequest,
  597. Path = imageResult.Item1,
  598. FileShare = FileShare.Read
  599. }).ConfigureAwait(false);
  600. }
  601. private async Task<object> GetImageResult(
  602. BaseItem item,
  603. Guid itemId,
  604. ImageRequest request,
  605. ItemImageInfo image,
  606. bool cropwhitespace,
  607. IReadOnlyCollection<ImageFormat> supportedFormats,
  608. TimeSpan? cacheDuration,
  609. IDictionary<string, string> headers,
  610. bool isHeadRequest)
  611. {
  612. if (!image.IsLocalFile)
  613. {
  614. item ??= _libraryManager.GetItemById(itemId);
  615. image = await _libraryManager.ConvertImageToLocal(item, image, request.Index ?? 0).ConfigureAwait(false);
  616. }
  617. var options = new ImageProcessingOptions
  618. {
  619. CropWhiteSpace = cropwhitespace,
  620. Height = request.Height,
  621. ImageIndex = request.Index ?? 0,
  622. Image = image,
  623. Item = item,
  624. ItemId = itemId,
  625. MaxHeight = request.MaxHeight,
  626. MaxWidth = request.MaxWidth,
  627. Quality = request.Quality ?? 100,
  628. Width = request.Width,
  629. AddPlayedIndicator = request.AddPlayedIndicator,
  630. PercentPlayed = request.PercentPlayed ?? 0,
  631. UnplayedCount = request.UnplayedCount,
  632. Blur = request.Blur,
  633. BackgroundColor = request.BackgroundColor,
  634. ForegroundLayer = request.ForegroundLayer,
  635. SupportedOutputFormats = supportedFormats
  636. };
  637. var imageResult = await _imageProcessor.ProcessImage(options).ConfigureAwait(false);
  638. headers[HeaderNames.Vary] = HeaderNames.Accept;
  639. return await ResultFactory.GetStaticFileResult(Request, new StaticFileResultOptions
  640. {
  641. CacheDuration = cacheDuration,
  642. ResponseHeaders = headers,
  643. ContentType = imageResult.Item2,
  644. DateLastModified = imageResult.Item3,
  645. IsHeadRequest = isHeadRequest,
  646. Path = imageResult.Item1,
  647. FileShare = FileShare.Read
  648. }).ConfigureAwait(false);
  649. }
  650. private ImageFormat[] GetOutputFormats(ImageRequest request)
  651. {
  652. if (!string.IsNullOrWhiteSpace(request.Format)
  653. && Enum.TryParse(request.Format, true, out ImageFormat format))
  654. {
  655. return new[] { format };
  656. }
  657. return GetClientSupportedFormats();
  658. }
  659. private ImageFormat[] GetClientSupportedFormats()
  660. {
  661. var supportedFormats = Request.AcceptTypes ?? Array.Empty<string>();
  662. if (supportedFormats.Length > 0)
  663. {
  664. for (int i = 0; i < supportedFormats.Length; i++)
  665. {
  666. int index = supportedFormats[i].IndexOf(';');
  667. if (index != -1)
  668. {
  669. supportedFormats[i] = supportedFormats[i].Substring(0, index);
  670. }
  671. }
  672. }
  673. var acceptParam = Request.QueryString["accept"];
  674. var supportsWebP = SupportsFormat(supportedFormats, acceptParam, "webp", false);
  675. if (!supportsWebP)
  676. {
  677. var userAgent = Request.UserAgent ?? string.Empty;
  678. if (userAgent.IndexOf("crosswalk", StringComparison.OrdinalIgnoreCase) != -1 &&
  679. userAgent.IndexOf("android", StringComparison.OrdinalIgnoreCase) != -1)
  680. {
  681. supportsWebP = true;
  682. }
  683. }
  684. var formats = new List<ImageFormat>(4);
  685. if (supportsWebP)
  686. {
  687. formats.Add(ImageFormat.Webp);
  688. }
  689. formats.Add(ImageFormat.Jpg);
  690. formats.Add(ImageFormat.Png);
  691. if (SupportsFormat(supportedFormats, acceptParam, "gif", true))
  692. {
  693. formats.Add(ImageFormat.Gif);
  694. }
  695. return formats.ToArray();
  696. }
  697. private bool SupportsFormat(IEnumerable<string> requestAcceptTypes, string acceptParam, string format, bool acceptAll)
  698. {
  699. var mimeType = "image/" + format;
  700. if (requestAcceptTypes.Contains(mimeType))
  701. {
  702. return true;
  703. }
  704. if (acceptAll && requestAcceptTypes.Contains("*/*"))
  705. {
  706. return true;
  707. }
  708. return string.Equals(Request.QueryString["accept"], format, StringComparison.OrdinalIgnoreCase);
  709. }
  710. /// <summary>
  711. /// Gets the image path.
  712. /// </summary>
  713. /// <param name="request">The request.</param>
  714. /// <param name="item">The item.</param>
  715. /// <returns>System.String.</returns>
  716. private static ItemImageInfo GetImageInfo(ImageRequest request, BaseItem item)
  717. {
  718. var index = request.Index ?? 0;
  719. return item.GetImageInfo(request.Type, index);
  720. }
  721. private static ItemImageInfo GetImageInfo(ImageRequest request, User user)
  722. {
  723. var info = new ItemImageInfo
  724. {
  725. Path = user.ProfileImage.Path,
  726. Type = ImageType.Primary,
  727. DateModified = user.ProfileImage.LastModified,
  728. };
  729. if (request.Width.HasValue)
  730. {
  731. info.Width = request.Width.Value;
  732. }
  733. if (request.Height.HasValue)
  734. {
  735. info.Height = request.Height.Value;
  736. }
  737. return info;
  738. }
  739. /// <summary>
  740. /// Posts the image.
  741. /// </summary>
  742. /// <param name="entity">The entity.</param>
  743. /// <param name="inputStream">The input stream.</param>
  744. /// <param name="imageType">Type of the image.</param>
  745. /// <param name="mimeType">Type of the MIME.</param>
  746. /// <returns>Task.</returns>
  747. public async Task PostImage(BaseItem entity, Stream inputStream, ImageType imageType, string mimeType)
  748. {
  749. var memoryStream = await GetMemoryStream(inputStream);
  750. // Handle image/png; charset=utf-8
  751. mimeType = mimeType.Split(';').FirstOrDefault();
  752. await _providerManager.SaveImage(entity, memoryStream, mimeType, imageType, null, CancellationToken.None).ConfigureAwait(false);
  753. entity.UpdateToRepository(ItemUpdateType.ImageUpdate, CancellationToken.None);
  754. }
  755. private static async Task<MemoryStream> GetMemoryStream(Stream inputStream)
  756. {
  757. using var reader = new StreamReader(inputStream);
  758. var text = await reader.ReadToEndAsync().ConfigureAwait(false);
  759. var bytes = Convert.FromBase64String(text);
  760. return new MemoryStream(bytes)
  761. {
  762. Position = 0
  763. };
  764. }
  765. private async Task PostImage(User user, Stream inputStream, string mimeType)
  766. {
  767. var memoryStream = await GetMemoryStream(inputStream);
  768. // Handle image/png; charset=utf-8
  769. mimeType = mimeType.Split(';').FirstOrDefault();
  770. var userDataPath = Path.Combine(ServerConfigurationManager.ApplicationPaths.UserConfigurationDirectoryPath, user.Username);
  771. if (user.ProfileImage != null)
  772. {
  773. _userManager.ClearProfileImage(user);
  774. }
  775. user.ProfileImage = new Jellyfin.Data.Entities.ImageInfo(Path.Combine(userDataPath, "profile" + MimeTypes.ToExtension(mimeType)));
  776. await _providerManager
  777. .SaveImage(user, memoryStream, mimeType, user.ProfileImage.Path)
  778. .ConfigureAwait(false);
  779. await _userManager.UpdateUserAsync(user);
  780. }
  781. }
  782. }