LocalImageProvider.cs 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362
  1. using MediaBrowser.Common.IO;
  2. using MediaBrowser.Controller.Entities;
  3. using MediaBrowser.Controller.Entities.Audio;
  4. using MediaBrowser.Controller.Entities.Movies;
  5. using MediaBrowser.Controller.Entities.TV;
  6. using MediaBrowser.Controller.Providers;
  7. using MediaBrowser.Model.Entities;
  8. using System;
  9. using System.Collections.Generic;
  10. using System.Globalization;
  11. using System.IO;
  12. using System.Linq;
  13. namespace MediaBrowser.LocalMetadata.Images
  14. {
  15. public class LocalImageProvider : ILocalImageFileProvider
  16. {
  17. private readonly IFileSystem _fileSystem;
  18. public LocalImageProvider(IFileSystem fileSystem)
  19. {
  20. _fileSystem = fileSystem;
  21. }
  22. public string Name
  23. {
  24. get { return "Local Images"; }
  25. }
  26. public int Order
  27. {
  28. get { return 0; }
  29. }
  30. public bool Supports(IHasImages item)
  31. {
  32. if (item.SupportsLocalMetadata)
  33. {
  34. // Episode has it's own provider
  35. if (item.IsOwnedItem || item is Episode || item is Audio || item is Photo)
  36. {
  37. return false;
  38. }
  39. return true;
  40. }
  41. if (item.LocationType == LocationType.Virtual)
  42. {
  43. var season = item as Season;
  44. if (season != null)
  45. {
  46. var series = season.Series;
  47. if (series != null && series.LocationType == LocationType.FileSystem)
  48. {
  49. return true;
  50. }
  51. }
  52. }
  53. return false;
  54. }
  55. private IEnumerable<FileSystemInfo> GetFiles(IHasImages item, bool includeDirectories, IDirectoryService directoryService)
  56. {
  57. if (item.LocationType != LocationType.FileSystem)
  58. {
  59. return new List<FileSystemInfo>();
  60. }
  61. var path = item.ContainingFolderPath;
  62. if (includeDirectories)
  63. {
  64. return directoryService.GetFileSystemEntries(path)
  65. .Where(i => BaseItem.SupportedImageExtensions.Contains(i.Extension, StringComparer.OrdinalIgnoreCase) ||
  66. (i.Attributes & FileAttributes.Directory) == FileAttributes.Directory);
  67. }
  68. return directoryService.GetFiles(path)
  69. .Where(i => BaseItem.SupportedImageExtensions.Contains(i.Extension, StringComparer.OrdinalIgnoreCase));
  70. }
  71. public List<LocalImageInfo> GetImages(IHasImages item, IDirectoryService directoryService)
  72. {
  73. var files = GetFiles(item, true, directoryService).ToList();
  74. var list = new List<LocalImageInfo>();
  75. PopulateImages(item, list, files, true, directoryService);
  76. return list;
  77. }
  78. public List<LocalImageInfo> GetImages(IHasImages item, string path, bool checkForCacheKeyFiles, IDirectoryService directoryService)
  79. {
  80. return GetImages(item, new[] { path }, checkForCacheKeyFiles, directoryService);
  81. }
  82. public List<LocalImageInfo> GetImages(IHasImages item, IEnumerable<string> paths, bool checkForCacheKeyFiles, IDirectoryService directoryService)
  83. {
  84. var files = paths.SelectMany(directoryService.GetFiles)
  85. .Where(i =>
  86. {
  87. var ext = i.Extension;
  88. return !string.IsNullOrEmpty(ext) &&
  89. BaseItem.SupportedImageExtensions.Contains(ext, StringComparer.OrdinalIgnoreCase);
  90. })
  91. .ToList();
  92. var list = new List<LocalImageInfo>();
  93. PopulateImages(item, list, files, false, directoryService);
  94. if (checkForCacheKeyFiles)
  95. {
  96. AddCacheKeyImage(files, list, ImageType.Primary);
  97. AddCacheKeyImage(files, list, ImageType.Thumb);
  98. }
  99. return list;
  100. }
  101. private void PopulateImages(IHasImages item, List<LocalImageInfo> images, List<FileSystemInfo> files, bool supportParentSeriesFiles, IDirectoryService directoryService)
  102. {
  103. var imagePrefix = string.Empty;
  104. var baseItem = item as BaseItem;
  105. if (baseItem != null && baseItem.IsInMixedFolder)
  106. {
  107. imagePrefix = _fileSystem.GetFileNameWithoutExtension(item.Path) + "-";
  108. }
  109. PopulatePrimaryImages(item, images, files, imagePrefix);
  110. PopulateBackdrops(item, images, files, imagePrefix, directoryService);
  111. PopulateScreenshots(images, files, imagePrefix);
  112. AddImage(files, images, imagePrefix + "logo", ImageType.Logo);
  113. AddImage(files, images, imagePrefix + "clearart", ImageType.Art);
  114. AddImage(files, images, imagePrefix + "disc", ImageType.Disc);
  115. AddImage(files, images, imagePrefix + "cdart", ImageType.Disc);
  116. AddImage(files, images, imagePrefix + "box", ImageType.Box);
  117. AddImage(files, images, imagePrefix + "back", ImageType.BoxRear);
  118. AddImage(files, images, imagePrefix + "boxrear", ImageType.BoxRear);
  119. AddImage(files, images, imagePrefix + "menu", ImageType.Menu);
  120. // Banner
  121. AddImage(files, images, imagePrefix + "banner", ImageType.Banner);
  122. // Thumb
  123. AddImage(files, images, imagePrefix + "thumb", ImageType.Thumb);
  124. AddImage(files, images, imagePrefix + "landscape", ImageType.Thumb);
  125. if (supportParentSeriesFiles)
  126. {
  127. var season = item as Season;
  128. if (season != null)
  129. {
  130. PopulateSeasonImagesFromSeriesFolder(season, images, directoryService);
  131. }
  132. }
  133. }
  134. private void PopulatePrimaryImages(IHasImages item, List<LocalImageInfo> images, List<FileSystemInfo> files, string imagePrefix)
  135. {
  136. AddImage(files, images, imagePrefix + "folder", ImageType.Primary);
  137. AddImage(files, images, imagePrefix + "cover", ImageType.Primary);
  138. AddImage(files, images, imagePrefix + "poster", ImageType.Primary);
  139. AddImage(files, images, imagePrefix + "default", ImageType.Primary);
  140. // Support plex/xbmc convention
  141. if (item is Series)
  142. {
  143. AddImage(files, images, imagePrefix + "show", ImageType.Primary);
  144. }
  145. // Support plex/xbmc convention
  146. if (item is Video && !(item is Episode))
  147. {
  148. AddImage(files, images, imagePrefix + "movie", ImageType.Primary);
  149. }
  150. if (!string.IsNullOrEmpty(item.Path))
  151. {
  152. var name = _fileSystem.GetFileNameWithoutExtension(item.Path);
  153. if (!string.IsNullOrEmpty(name))
  154. {
  155. AddImage(files, images, name, ImageType.Primary);
  156. AddImage(files, images, name + "-poster", ImageType.Primary);
  157. }
  158. }
  159. }
  160. private void PopulateBackdrops(IHasImages item, List<LocalImageInfo> images, List<FileSystemInfo> files, string imagePrefix, IDirectoryService directoryService)
  161. {
  162. PopulateBackdrops(images, files, imagePrefix, "backdrop", "backdrop", ImageType.Backdrop);
  163. if (!string.IsNullOrEmpty(item.Path))
  164. {
  165. var name = _fileSystem.GetFileNameWithoutExtension(item.Path);
  166. if (!string.IsNullOrEmpty(name))
  167. {
  168. AddImage(files, images, imagePrefix + name + "-fanart", ImageType.Backdrop);
  169. }
  170. }
  171. PopulateBackdrops(images, files, imagePrefix, "fanart", "fanart-", ImageType.Backdrop);
  172. PopulateBackdrops(images, files, imagePrefix, "background", "background-", ImageType.Backdrop);
  173. PopulateBackdrops(images, files, imagePrefix, "art", "art-", ImageType.Backdrop);
  174. var extraFanartFolder = files
  175. .FirstOrDefault(i => string.Equals(i.Name, "extrafanart", StringComparison.OrdinalIgnoreCase));
  176. if (extraFanartFolder != null)
  177. {
  178. PopulateBackdropsFromExtraFanart(extraFanartFolder.FullName, images, directoryService);
  179. }
  180. }
  181. private void PopulateBackdropsFromExtraFanart(string path, List<LocalImageInfo> images, IDirectoryService directoryService)
  182. {
  183. var imageFiles = directoryService.GetFiles(path)
  184. .Where(i =>
  185. {
  186. var extension = i.Extension;
  187. if (string.IsNullOrEmpty(extension))
  188. {
  189. return false;
  190. }
  191. return BaseItem.SupportedImageExtensions.Contains(extension, StringComparer.OrdinalIgnoreCase);
  192. });
  193. images.AddRange(imageFiles.Select(i => new LocalImageInfo
  194. {
  195. FileInfo = i,
  196. Type = ImageType.Backdrop
  197. }));
  198. }
  199. private void PopulateScreenshots(List<LocalImageInfo> images, List<FileSystemInfo> files, string imagePrefix)
  200. {
  201. PopulateBackdrops(images, files, imagePrefix, "screenshot", "screenshot", ImageType.Screenshot);
  202. }
  203. private void PopulateBackdrops(List<LocalImageInfo> images, List<FileSystemInfo> files, string imagePrefix, string firstFileName, string subsequentFileNamePrefix, ImageType type)
  204. {
  205. AddImage(files, images, imagePrefix + firstFileName, type);
  206. var unfound = 0;
  207. for (var i = 1; i <= 20; i++)
  208. {
  209. // Screenshot Image
  210. var found = AddImage(files, images, imagePrefix + subsequentFileNamePrefix + i, type);
  211. if (!found)
  212. {
  213. unfound++;
  214. if (unfound >= 3)
  215. {
  216. break;
  217. }
  218. }
  219. }
  220. }
  221. private readonly CultureInfo _usCulture = new CultureInfo("en-US");
  222. private void PopulateSeasonImagesFromSeriesFolder(Season season, List<LocalImageInfo> images, IDirectoryService directoryService)
  223. {
  224. var seasonNumber = season.IndexNumber;
  225. var series = season.Series;
  226. if (!seasonNumber.HasValue || series.LocationType != LocationType.FileSystem)
  227. {
  228. return;
  229. }
  230. var seriesFiles = GetFiles(series, false, directoryService).ToList();
  231. // Try using the season name
  232. var prefix = season.Name.ToLower().Replace(" ", string.Empty);
  233. var filenamePrefixes = new List<string> { prefix };
  234. var seasonMarker = seasonNumber.Value == 0
  235. ? "-specials"
  236. : seasonNumber.Value.ToString("00", _usCulture);
  237. // Get this one directly from the file system since we have to go up a level
  238. if (!string.Equals(prefix, seasonMarker, StringComparison.OrdinalIgnoreCase))
  239. {
  240. filenamePrefixes.Add("season" + seasonMarker);
  241. }
  242. foreach (var filename in filenamePrefixes)
  243. {
  244. AddImage(seriesFiles, images, filename + "-poster", ImageType.Primary);
  245. AddImage(seriesFiles, images, filename + "-fanart", ImageType.Backdrop);
  246. AddImage(seriesFiles, images, filename + "-banner", ImageType.Banner);
  247. AddImage(seriesFiles, images, filename + "-landscape", ImageType.Thumb);
  248. }
  249. }
  250. private bool AddImage(IEnumerable<FileSystemInfo> files, List<LocalImageInfo> images, string name, ImageType type)
  251. {
  252. var image = GetImage(files, name) as FileInfo;
  253. if (image != null)
  254. {
  255. images.Add(new LocalImageInfo
  256. {
  257. FileInfo = image,
  258. Type = type
  259. });
  260. return true;
  261. }
  262. return false;
  263. }
  264. private void AddCacheKeyImage(IEnumerable<FileSystemInfo> files, List<LocalImageInfo> images, ImageType type)
  265. {
  266. var candidates = files
  267. .Where(i => _fileSystem.GetFileNameWithoutExtension(i).StartsWith(type.ToString() + "_key_", StringComparison.OrdinalIgnoreCase))
  268. .ToList();
  269. var image = BaseItem.SupportedImageExtensions
  270. .Select(i => candidates.FirstOrDefault(c => string.Equals(c.Extension, i, StringComparison.OrdinalIgnoreCase)))
  271. .FirstOrDefault(i => i != null) as FileInfo;
  272. if (image != null)
  273. {
  274. images.Add(new LocalImageInfo
  275. {
  276. FileInfo = image,
  277. Type = type
  278. });
  279. }
  280. }
  281. private FileSystemInfo GetImage(IEnumerable<FileSystemInfo> files, string name)
  282. {
  283. var candidates = files
  284. .Where(i => string.Equals(name, _fileSystem.GetFileNameWithoutExtension(i), StringComparison.OrdinalIgnoreCase))
  285. .ToList();
  286. return BaseItem.SupportedImageExtensions
  287. .Select(i => candidates.FirstOrDefault(c => string.Equals(c.Extension, i, StringComparison.OrdinalIgnoreCase)))
  288. .FirstOrDefault(i => i != null);
  289. }
  290. }
  291. }