2
0

LibraryManager.cs 110 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155
  1. #nullable disable
  2. #pragma warning disable CS1591
  3. using System;
  4. using System.Collections.Concurrent;
  5. using System.Collections.Generic;
  6. using System.Globalization;
  7. using System.IO;
  8. using System.Linq;
  9. using System.Net;
  10. using System.Net.Http;
  11. using System.Threading;
  12. using System.Threading.Tasks;
  13. using Emby.Naming.Common;
  14. using Emby.Naming.TV;
  15. using Emby.Server.Implementations.Library.Resolvers;
  16. using Emby.Server.Implementations.Library.Validators;
  17. using Emby.Server.Implementations.Playlists;
  18. using Emby.Server.Implementations.ScheduledTasks.Tasks;
  19. using Jellyfin.Data.Entities;
  20. using Jellyfin.Data.Enums;
  21. using Jellyfin.Extensions;
  22. using MediaBrowser.Common.Extensions;
  23. using MediaBrowser.Controller;
  24. using MediaBrowser.Controller.Configuration;
  25. using MediaBrowser.Controller.Drawing;
  26. using MediaBrowser.Controller.Dto;
  27. using MediaBrowser.Controller.Entities;
  28. using MediaBrowser.Controller.Entities.Audio;
  29. using MediaBrowser.Controller.IO;
  30. using MediaBrowser.Controller.Library;
  31. using MediaBrowser.Controller.LiveTv;
  32. using MediaBrowser.Controller.MediaEncoding;
  33. using MediaBrowser.Controller.Persistence;
  34. using MediaBrowser.Controller.Providers;
  35. using MediaBrowser.Controller.Resolvers;
  36. using MediaBrowser.Controller.Sorting;
  37. using MediaBrowser.Model.Configuration;
  38. using MediaBrowser.Model.Dlna;
  39. using MediaBrowser.Model.Drawing;
  40. using MediaBrowser.Model.Dto;
  41. using MediaBrowser.Model.Entities;
  42. using MediaBrowser.Model.IO;
  43. using MediaBrowser.Model.Library;
  44. using MediaBrowser.Model.Querying;
  45. using MediaBrowser.Model.Tasks;
  46. using Microsoft.Extensions.Logging;
  47. using Episode = MediaBrowser.Controller.Entities.TV.Episode;
  48. using EpisodeInfo = Emby.Naming.TV.EpisodeInfo;
  49. using Genre = MediaBrowser.Controller.Entities.Genre;
  50. using Person = MediaBrowser.Controller.Entities.Person;
  51. using VideoResolver = Emby.Naming.Video.VideoResolver;
  52. namespace Emby.Server.Implementations.Library
  53. {
  54. /// <summary>
  55. /// Class LibraryManager.
  56. /// </summary>
  57. public class LibraryManager : ILibraryManager
  58. {
  59. private const string ShortcutFileExtension = ".mblink";
  60. private readonly ILogger<LibraryManager> _logger;
  61. private readonly ConcurrentDictionary<Guid, BaseItem> _cache;
  62. private readonly ITaskManager _taskManager;
  63. private readonly IUserManager _userManager;
  64. private readonly IUserDataManager _userDataRepository;
  65. private readonly IServerConfigurationManager _configurationManager;
  66. private readonly Lazy<ILibraryMonitor> _libraryMonitorFactory;
  67. private readonly Lazy<IProviderManager> _providerManagerFactory;
  68. private readonly Lazy<IUserViewManager> _userviewManagerFactory;
  69. private readonly IServerApplicationHost _appHost;
  70. private readonly IMediaEncoder _mediaEncoder;
  71. private readonly IFileSystem _fileSystem;
  72. private readonly IItemRepository _itemRepository;
  73. private readonly IImageProcessor _imageProcessor;
  74. private readonly NamingOptions _namingOptions;
  75. private readonly ExtraResolver _extraResolver;
  76. /// <summary>
  77. /// The _root folder sync lock.
  78. /// </summary>
  79. private readonly object _rootFolderSyncLock = new object();
  80. private readonly object _userRootFolderSyncLock = new object();
  81. private readonly TimeSpan _viewRefreshInterval = TimeSpan.FromHours(24);
  82. /// <summary>
  83. /// The _root folder.
  84. /// </summary>
  85. private volatile AggregateFolder _rootFolder;
  86. private volatile UserRootFolder _userRootFolder;
  87. private bool _wizardCompleted;
  88. /// <summary>
  89. /// Initializes a new instance of the <see cref="LibraryManager" /> class.
  90. /// </summary>
  91. /// <param name="appHost">The application host.</param>
  92. /// <param name="loggerFactory">The logger factory.</param>
  93. /// <param name="taskManager">The task manager.</param>
  94. /// <param name="userManager">The user manager.</param>
  95. /// <param name="configurationManager">The configuration manager.</param>
  96. /// <param name="userDataRepository">The user data repository.</param>
  97. /// <param name="libraryMonitorFactory">The library monitor.</param>
  98. /// <param name="fileSystem">The file system.</param>
  99. /// <param name="providerManagerFactory">The provider manager.</param>
  100. /// <param name="userviewManagerFactory">The userview manager.</param>
  101. /// <param name="mediaEncoder">The media encoder.</param>
  102. /// <param name="itemRepository">The item repository.</param>
  103. /// <param name="imageProcessor">The image processor.</param>
  104. /// <param name="namingOptions">The naming options.</param>
  105. /// <param name="directoryService">The directory service.</param>
  106. public LibraryManager(
  107. IServerApplicationHost appHost,
  108. ILoggerFactory loggerFactory,
  109. ITaskManager taskManager,
  110. IUserManager userManager,
  111. IServerConfigurationManager configurationManager,
  112. IUserDataManager userDataRepository,
  113. Lazy<ILibraryMonitor> libraryMonitorFactory,
  114. IFileSystem fileSystem,
  115. Lazy<IProviderManager> providerManagerFactory,
  116. Lazy<IUserViewManager> userviewManagerFactory,
  117. IMediaEncoder mediaEncoder,
  118. IItemRepository itemRepository,
  119. IImageProcessor imageProcessor,
  120. NamingOptions namingOptions,
  121. IDirectoryService directoryService)
  122. {
  123. _appHost = appHost;
  124. _logger = loggerFactory.CreateLogger<LibraryManager>();
  125. _taskManager = taskManager;
  126. _userManager = userManager;
  127. _configurationManager = configurationManager;
  128. _userDataRepository = userDataRepository;
  129. _libraryMonitorFactory = libraryMonitorFactory;
  130. _fileSystem = fileSystem;
  131. _providerManagerFactory = providerManagerFactory;
  132. _userviewManagerFactory = userviewManagerFactory;
  133. _mediaEncoder = mediaEncoder;
  134. _itemRepository = itemRepository;
  135. _imageProcessor = imageProcessor;
  136. _cache = new ConcurrentDictionary<Guid, BaseItem>();
  137. _namingOptions = namingOptions;
  138. _extraResolver = new ExtraResolver(loggerFactory.CreateLogger<ExtraResolver>(), namingOptions, directoryService);
  139. _configurationManager.ConfigurationUpdated += ConfigurationUpdated;
  140. RecordConfigurationValues(configurationManager.Configuration);
  141. }
  142. /// <summary>
  143. /// Occurs when [item added].
  144. /// </summary>
  145. public event EventHandler<ItemChangeEventArgs> ItemAdded;
  146. /// <summary>
  147. /// Occurs when [item updated].
  148. /// </summary>
  149. public event EventHandler<ItemChangeEventArgs> ItemUpdated;
  150. /// <summary>
  151. /// Occurs when [item removed].
  152. /// </summary>
  153. public event EventHandler<ItemChangeEventArgs> ItemRemoved;
  154. /// <summary>
  155. /// Gets the root folder.
  156. /// </summary>
  157. /// <value>The root folder.</value>
  158. public AggregateFolder RootFolder
  159. {
  160. get
  161. {
  162. if (_rootFolder is null)
  163. {
  164. lock (_rootFolderSyncLock)
  165. {
  166. _rootFolder ??= CreateRootFolder();
  167. }
  168. }
  169. return _rootFolder;
  170. }
  171. }
  172. private ILibraryMonitor LibraryMonitor => _libraryMonitorFactory.Value;
  173. private IProviderManager ProviderManager => _providerManagerFactory.Value;
  174. private IUserViewManager UserViewManager => _userviewManagerFactory.Value;
  175. /// <summary>
  176. /// Gets or sets the postscan tasks.
  177. /// </summary>
  178. /// <value>The postscan tasks.</value>
  179. private ILibraryPostScanTask[] PostscanTasks { get; set; } = Array.Empty<ILibraryPostScanTask>();
  180. /// <summary>
  181. /// Gets or sets the intro providers.
  182. /// </summary>
  183. /// <value>The intro providers.</value>
  184. private IIntroProvider[] IntroProviders { get; set; } = Array.Empty<IIntroProvider>();
  185. /// <summary>
  186. /// Gets or sets the list of entity resolution ignore rules.
  187. /// </summary>
  188. /// <value>The entity resolution ignore rules.</value>
  189. private IResolverIgnoreRule[] EntityResolutionIgnoreRules { get; set; } = Array.Empty<IResolverIgnoreRule>();
  190. /// <summary>
  191. /// Gets or sets the list of currently registered entity resolvers.
  192. /// </summary>
  193. /// <value>The entity resolvers enumerable.</value>
  194. private IItemResolver[] EntityResolvers { get; set; } = Array.Empty<IItemResolver>();
  195. private IMultiItemResolver[] MultiItemResolvers { get; set; } = Array.Empty<IMultiItemResolver>();
  196. /// <summary>
  197. /// Gets or sets the comparers.
  198. /// </summary>
  199. /// <value>The comparers.</value>
  200. private IBaseItemComparer[] Comparers { get; set; } = Array.Empty<IBaseItemComparer>();
  201. public bool IsScanRunning { get; private set; }
  202. /// <summary>
  203. /// Adds the parts.
  204. /// </summary>
  205. /// <param name="rules">The rules.</param>
  206. /// <param name="resolvers">The resolvers.</param>
  207. /// <param name="introProviders">The intro providers.</param>
  208. /// <param name="itemComparers">The item comparers.</param>
  209. /// <param name="postscanTasks">The post scan tasks.</param>
  210. public void AddParts(
  211. IEnumerable<IResolverIgnoreRule> rules,
  212. IEnumerable<IItemResolver> resolvers,
  213. IEnumerable<IIntroProvider> introProviders,
  214. IEnumerable<IBaseItemComparer> itemComparers,
  215. IEnumerable<ILibraryPostScanTask> postscanTasks)
  216. {
  217. EntityResolutionIgnoreRules = rules.ToArray();
  218. EntityResolvers = resolvers.OrderBy(i => i.Priority).ToArray();
  219. MultiItemResolvers = EntityResolvers.OfType<IMultiItemResolver>().ToArray();
  220. IntroProviders = introProviders.ToArray();
  221. Comparers = itemComparers.ToArray();
  222. PostscanTasks = postscanTasks.ToArray();
  223. }
  224. /// <summary>
  225. /// Records the configuration values.
  226. /// </summary>
  227. /// <param name="configuration">The configuration.</param>
  228. private void RecordConfigurationValues(ServerConfiguration configuration)
  229. {
  230. _wizardCompleted = configuration.IsStartupWizardCompleted;
  231. }
  232. /// <summary>
  233. /// Configurations the updated.
  234. /// </summary>
  235. /// <param name="sender">The sender.</param>
  236. /// <param name="e">The <see cref="EventArgs" /> instance containing the event data.</param>
  237. private void ConfigurationUpdated(object sender, EventArgs e)
  238. {
  239. var config = _configurationManager.Configuration;
  240. var wizardChanged = config.IsStartupWizardCompleted != _wizardCompleted;
  241. RecordConfigurationValues(config);
  242. if (wizardChanged)
  243. {
  244. _taskManager.CancelIfRunningAndQueue<RefreshMediaLibraryTask>();
  245. }
  246. }
  247. public void RegisterItem(BaseItem item)
  248. {
  249. ArgumentNullException.ThrowIfNull(item);
  250. if (item is IItemByName)
  251. {
  252. if (item is not MusicArtist)
  253. {
  254. return;
  255. }
  256. }
  257. else if (!item.IsFolder)
  258. {
  259. if (item is not Video && item is not LiveTvChannel)
  260. {
  261. return;
  262. }
  263. }
  264. _cache[item.Id] = item;
  265. }
  266. public void DeleteItem(BaseItem item, DeleteOptions options)
  267. {
  268. DeleteItem(item, options, false);
  269. }
  270. public void DeleteItem(BaseItem item, DeleteOptions options, bool notifyParentItem)
  271. {
  272. ArgumentNullException.ThrowIfNull(item);
  273. var parent = item.GetOwner() ?? item.GetParent();
  274. DeleteItem(item, options, parent, notifyParentItem);
  275. }
  276. public void DeleteItem(BaseItem item, DeleteOptions options, BaseItem parent, bool notifyParentItem)
  277. {
  278. ArgumentNullException.ThrowIfNull(item);
  279. if (item.SourceType == SourceType.Channel)
  280. {
  281. if (options.DeleteFromExternalProvider)
  282. {
  283. try
  284. {
  285. BaseItem.ChannelManager.DeleteItem(item).GetAwaiter().GetResult();
  286. }
  287. catch (ArgumentException)
  288. {
  289. // channel no longer installed
  290. }
  291. }
  292. options.DeleteFileLocation = false;
  293. }
  294. if (item is LiveTvProgram)
  295. {
  296. _logger.LogDebug(
  297. "Removing item, Type: {0}, Name: {1}, Path: {2}, Id: {3}",
  298. item.GetType().Name,
  299. item.Name ?? "Unknown name",
  300. item.Path ?? string.Empty,
  301. item.Id);
  302. }
  303. else
  304. {
  305. _logger.LogInformation(
  306. "Removing item, Type: {0}, Name: {1}, Path: {2}, Id: {3}",
  307. item.GetType().Name,
  308. item.Name ?? "Unknown name",
  309. item.Path ?? string.Empty,
  310. item.Id);
  311. }
  312. var children = item.IsFolder
  313. ? ((Folder)item).GetRecursiveChildren(false)
  314. : Array.Empty<BaseItem>();
  315. foreach (var metadataPath in GetMetadataPaths(item, children))
  316. {
  317. if (!Directory.Exists(metadataPath))
  318. {
  319. continue;
  320. }
  321. _logger.LogDebug(
  322. "Deleting metadata path, Type: {0}, Name: {1}, Path: {2}, Id: {3}",
  323. item.GetType().Name,
  324. item.Name ?? "Unknown name",
  325. metadataPath,
  326. item.Id);
  327. try
  328. {
  329. Directory.Delete(metadataPath, true);
  330. }
  331. catch (Exception ex)
  332. {
  333. _logger.LogError(ex, "Error deleting {MetadataPath}", metadataPath);
  334. }
  335. }
  336. if (options.DeleteFileLocation && item.IsFileProtocol)
  337. {
  338. // Assume only the first is required
  339. // Add this flag to GetDeletePaths if required in the future
  340. var isRequiredForDelete = true;
  341. foreach (var fileSystemInfo in item.GetDeletePaths())
  342. {
  343. if (Directory.Exists(fileSystemInfo.FullName) || File.Exists(fileSystemInfo.FullName))
  344. {
  345. try
  346. {
  347. _logger.LogInformation(
  348. "Deleting item path, Type: {0}, Name: {1}, Path: {2}, Id: {3}",
  349. item.GetType().Name,
  350. item.Name ?? "Unknown name",
  351. fileSystemInfo.FullName,
  352. item.Id);
  353. if (fileSystemInfo.IsDirectory)
  354. {
  355. Directory.Delete(fileSystemInfo.FullName, true);
  356. }
  357. else
  358. {
  359. File.Delete(fileSystemInfo.FullName);
  360. }
  361. }
  362. catch (IOException)
  363. {
  364. if (isRequiredForDelete)
  365. {
  366. throw;
  367. }
  368. }
  369. catch (UnauthorizedAccessException)
  370. {
  371. if (isRequiredForDelete)
  372. {
  373. throw;
  374. }
  375. }
  376. }
  377. isRequiredForDelete = false;
  378. }
  379. }
  380. item.SetParent(null);
  381. _itemRepository.DeleteItem(item.Id);
  382. foreach (var child in children)
  383. {
  384. _itemRepository.DeleteItem(child.Id);
  385. }
  386. _cache.TryRemove(item.Id, out _);
  387. ReportItemRemoved(item, parent);
  388. }
  389. private static IEnumerable<string> GetMetadataPaths(BaseItem item, IEnumerable<BaseItem> children)
  390. {
  391. var list = new List<string>
  392. {
  393. item.GetInternalMetadataPath()
  394. };
  395. list.AddRange(children.Select(i => i.GetInternalMetadataPath()));
  396. return list;
  397. }
  398. /// <summary>
  399. /// Resolves the item.
  400. /// </summary>
  401. /// <param name="args">The args.</param>
  402. /// <param name="resolvers">The resolvers.</param>
  403. /// <returns>BaseItem.</returns>
  404. private BaseItem ResolveItem(ItemResolveArgs args, IItemResolver[] resolvers)
  405. {
  406. var item = (resolvers ?? EntityResolvers).Select(r => Resolve(args, r))
  407. .FirstOrDefault(i => i is not null);
  408. if (item is not null)
  409. {
  410. ResolverHelper.SetInitialItemValues(item, args, _fileSystem, this);
  411. }
  412. return item;
  413. }
  414. private BaseItem Resolve(ItemResolveArgs args, IItemResolver resolver)
  415. {
  416. try
  417. {
  418. return resolver.ResolvePath(args);
  419. }
  420. catch (Exception ex)
  421. {
  422. _logger.LogError(ex, "Error in {Resolver} resolving {Path}", resolver.GetType().Name, args.Path);
  423. return null;
  424. }
  425. }
  426. public Guid GetNewItemId(string key, Type type)
  427. {
  428. return GetNewItemIdInternal(key, type, false);
  429. }
  430. private Guid GetNewItemIdInternal(string key, Type type, bool forceCaseInsensitive)
  431. {
  432. ArgumentException.ThrowIfNullOrEmpty(key);
  433. ArgumentNullException.ThrowIfNull(type);
  434. string programDataPath = _configurationManager.ApplicationPaths.ProgramDataPath;
  435. if (key.StartsWith(programDataPath, StringComparison.Ordinal))
  436. {
  437. // Try to normalize paths located underneath program-data in an attempt to make them more portable
  438. key = key.Substring(programDataPath.Length)
  439. .TrimStart('/', '\\')
  440. .Replace('/', '\\');
  441. }
  442. if (forceCaseInsensitive || !_configurationManager.Configuration.EnableCaseSensitiveItemIds)
  443. {
  444. key = key.ToLowerInvariant();
  445. }
  446. key = type.FullName + key;
  447. return key.GetMD5();
  448. }
  449. public BaseItem ResolvePath(FileSystemMetadata fileInfo, Folder parent = null, IDirectoryService directoryService = null)
  450. => ResolvePath(fileInfo, directoryService ?? new DirectoryService(_fileSystem), null, parent);
  451. private BaseItem ResolvePath(
  452. FileSystemMetadata fileInfo,
  453. IDirectoryService directoryService,
  454. IItemResolver[] resolvers,
  455. Folder parent = null,
  456. CollectionType? collectionType = null,
  457. LibraryOptions libraryOptions = null)
  458. {
  459. ArgumentNullException.ThrowIfNull(fileInfo);
  460. var fullPath = fileInfo.FullName;
  461. if (collectionType is null && parent is not null)
  462. {
  463. collectionType = GetContentTypeOverride(fullPath, true);
  464. }
  465. var args = new ItemResolveArgs(_configurationManager.ApplicationPaths, this)
  466. {
  467. Parent = parent,
  468. FileInfo = fileInfo,
  469. CollectionType = collectionType,
  470. LibraryOptions = libraryOptions
  471. };
  472. // Return null if ignore rules deem that we should do so
  473. if (IgnoreFile(args.FileInfo, args.Parent))
  474. {
  475. return null;
  476. }
  477. // Gather child folder and files
  478. if (args.IsDirectory)
  479. {
  480. var isPhysicalRoot = args.IsPhysicalRoot;
  481. // When resolving the root, we need it's grandchildren (children of user views)
  482. var flattenFolderDepth = isPhysicalRoot ? 2 : 0;
  483. FileSystemMetadata[] files;
  484. var isVf = args.IsVf;
  485. try
  486. {
  487. files = FileData.GetFilteredFileSystemEntries(directoryService, args.Path, _fileSystem, _appHost, _logger, args, flattenFolderDepth: flattenFolderDepth, resolveShortcuts: isPhysicalRoot || isVf);
  488. }
  489. catch (Exception ex)
  490. {
  491. if (parent is not null && parent.IsPhysicalRoot)
  492. {
  493. _logger.LogError(ex, "Error in GetFilteredFileSystemEntries isPhysicalRoot: {0} IsVf: {1}", isPhysicalRoot, isVf);
  494. files = Array.Empty<FileSystemMetadata>();
  495. }
  496. else
  497. {
  498. throw;
  499. }
  500. }
  501. // Need to remove subpaths that may have been resolved from shortcuts
  502. // Example: if \\server\movies exists, then strip out \\server\movies\action
  503. if (isPhysicalRoot)
  504. {
  505. files = NormalizeRootPathList(files).ToArray();
  506. }
  507. args.FileSystemChildren = files;
  508. }
  509. // Check to see if we should resolve based on our contents
  510. if (args.IsDirectory && !ShouldResolvePathContents(args))
  511. {
  512. return null;
  513. }
  514. return ResolveItem(args, resolvers);
  515. }
  516. public bool IgnoreFile(FileSystemMetadata file, BaseItem parent)
  517. => EntityResolutionIgnoreRules.Any(r => r.ShouldIgnore(file, parent));
  518. public List<FileSystemMetadata> NormalizeRootPathList(IEnumerable<FileSystemMetadata> paths)
  519. {
  520. var originalList = paths.ToList();
  521. var list = originalList.Where(i => i.IsDirectory)
  522. .Select(i => Path.TrimEndingDirectorySeparator(i.FullName))
  523. .Distinct(StringComparer.OrdinalIgnoreCase)
  524. .ToList();
  525. var dupes = list.Where(subPath => !subPath.EndsWith(":\\", StringComparison.OrdinalIgnoreCase) && list.Any(i => _fileSystem.ContainsSubPath(i, subPath)))
  526. .ToList();
  527. foreach (var dupe in dupes)
  528. {
  529. _logger.LogInformation("Found duplicate path: {0}", dupe);
  530. }
  531. var newList = list.Except(dupes, StringComparer.OrdinalIgnoreCase).Select(_fileSystem.GetDirectoryInfo).ToList();
  532. newList.AddRange(originalList.Where(i => !i.IsDirectory));
  533. return newList;
  534. }
  535. /// <summary>
  536. /// Determines whether a path should be ignored based on its contents - called after the contents have been read.
  537. /// </summary>
  538. /// <param name="args">The args.</param>
  539. /// <returns><c>true</c> if XXXX, <c>false</c> otherwise.</returns>
  540. private static bool ShouldResolvePathContents(ItemResolveArgs args)
  541. {
  542. // Ignore any folders containing a file called .ignore
  543. return !args.ContainsFileSystemEntryByName(".ignore");
  544. }
  545. public IEnumerable<BaseItem> ResolvePaths(IEnumerable<FileSystemMetadata> files, IDirectoryService directoryService, Folder parent, LibraryOptions libraryOptions, CollectionType? collectionType = null)
  546. {
  547. return ResolvePaths(files, directoryService, parent, libraryOptions, collectionType, EntityResolvers);
  548. }
  549. public IEnumerable<BaseItem> ResolvePaths(
  550. IEnumerable<FileSystemMetadata> files,
  551. IDirectoryService directoryService,
  552. Folder parent,
  553. LibraryOptions libraryOptions,
  554. CollectionType? collectionType,
  555. IItemResolver[] resolvers)
  556. {
  557. var fileList = files.Where(i => !IgnoreFile(i, parent)).ToList();
  558. if (parent is not null)
  559. {
  560. var multiItemResolvers = resolvers is null ? MultiItemResolvers : resolvers.OfType<IMultiItemResolver>().ToArray();
  561. foreach (var resolver in multiItemResolvers)
  562. {
  563. var result = resolver.ResolveMultiple(parent, fileList, collectionType, directoryService);
  564. if (result?.Items.Count > 0)
  565. {
  566. var items = result.Items;
  567. items.RemoveAll(item => !ResolverHelper.SetInitialItemValues(item, parent, this, directoryService));
  568. items.AddRange(ResolveFileList(result.ExtraFiles, directoryService, parent, collectionType, resolvers, libraryOptions));
  569. return items;
  570. }
  571. }
  572. }
  573. return ResolveFileList(fileList, directoryService, parent, collectionType, resolvers, libraryOptions);
  574. }
  575. private IEnumerable<BaseItem> ResolveFileList(
  576. IReadOnlyList<FileSystemMetadata> fileList,
  577. IDirectoryService directoryService,
  578. Folder parent,
  579. CollectionType? collectionType,
  580. IItemResolver[] resolvers,
  581. LibraryOptions libraryOptions)
  582. {
  583. // Given that fileList is a list we can save enumerator allocations by indexing
  584. for (var i = 0; i < fileList.Count; i++)
  585. {
  586. var file = fileList[i];
  587. BaseItem result = null;
  588. try
  589. {
  590. result = ResolvePath(file, directoryService, resolvers, parent, collectionType, libraryOptions);
  591. }
  592. catch (Exception ex)
  593. {
  594. _logger.LogError(ex, "Error resolving path {Path}", file.FullName);
  595. }
  596. if (result is not null)
  597. {
  598. yield return result;
  599. }
  600. }
  601. }
  602. /// <summary>
  603. /// Creates the root media folder.
  604. /// </summary>
  605. /// <returns>AggregateFolder.</returns>
  606. /// <exception cref="InvalidOperationException">Cannot create the root folder until plugins have loaded.</exception>
  607. public AggregateFolder CreateRootFolder()
  608. {
  609. var rootFolderPath = _configurationManager.ApplicationPaths.RootFolderPath;
  610. Directory.CreateDirectory(rootFolderPath);
  611. var rootFolder = GetItemById(GetNewItemId(rootFolderPath, typeof(AggregateFolder))) as AggregateFolder ??
  612. ((Folder)ResolvePath(_fileSystem.GetDirectoryInfo(rootFolderPath)))
  613. .DeepCopy<Folder, AggregateFolder>();
  614. // In case program data folder was moved
  615. if (!string.Equals(rootFolder.Path, rootFolderPath, StringComparison.Ordinal))
  616. {
  617. _logger.LogInformation("Resetting root folder path to {0}", rootFolderPath);
  618. rootFolder.Path = rootFolderPath;
  619. }
  620. // Add in the plug-in folders
  621. var path = Path.Combine(_configurationManager.ApplicationPaths.DataPath, "playlists");
  622. Directory.CreateDirectory(path);
  623. Folder folder = new PlaylistsFolder
  624. {
  625. Path = path
  626. };
  627. if (folder.Id.IsEmpty())
  628. {
  629. if (string.IsNullOrEmpty(folder.Path))
  630. {
  631. folder.Id = GetNewItemId(folder.GetType().Name, folder.GetType());
  632. }
  633. else
  634. {
  635. folder.Id = GetNewItemId(folder.Path, folder.GetType());
  636. }
  637. }
  638. var dbItem = GetItemById(folder.Id) as BasePluginFolder;
  639. if (dbItem is not null && string.Equals(dbItem.Path, folder.Path, StringComparison.OrdinalIgnoreCase))
  640. {
  641. folder = dbItem;
  642. }
  643. if (!folder.ParentId.Equals(rootFolder.Id))
  644. {
  645. folder.ParentId = rootFolder.Id;
  646. folder.UpdateToRepositoryAsync(ItemUpdateType.MetadataImport, CancellationToken.None).GetAwaiter().GetResult();
  647. }
  648. rootFolder.AddVirtualChild(folder);
  649. RegisterItem(folder);
  650. return rootFolder;
  651. }
  652. public Folder GetUserRootFolder()
  653. {
  654. if (_userRootFolder is null)
  655. {
  656. lock (_userRootFolderSyncLock)
  657. {
  658. if (_userRootFolder is null)
  659. {
  660. var userRootPath = _configurationManager.ApplicationPaths.DefaultUserViewsPath;
  661. _logger.LogDebug("Creating userRootPath at {Path}", userRootPath);
  662. Directory.CreateDirectory(userRootPath);
  663. var newItemId = GetNewItemId(userRootPath, typeof(UserRootFolder));
  664. UserRootFolder tmpItem = null;
  665. try
  666. {
  667. tmpItem = GetItemById(newItemId) as UserRootFolder;
  668. }
  669. catch (Exception ex)
  670. {
  671. _logger.LogError(ex, "Error creating UserRootFolder {Path}", newItemId);
  672. }
  673. if (tmpItem is null)
  674. {
  675. _logger.LogDebug("Creating new userRootFolder with DeepCopy");
  676. tmpItem = ((Folder)ResolvePath(_fileSystem.GetDirectoryInfo(userRootPath))).DeepCopy<Folder, UserRootFolder>();
  677. }
  678. // In case program data folder was moved
  679. if (!string.Equals(tmpItem.Path, userRootPath, StringComparison.Ordinal))
  680. {
  681. _logger.LogInformation("Resetting user root folder path to {0}", userRootPath);
  682. tmpItem.Path = userRootPath;
  683. }
  684. _userRootFolder = tmpItem;
  685. _logger.LogDebug("Setting userRootFolder: {Folder}", _userRootFolder);
  686. }
  687. }
  688. }
  689. return _userRootFolder;
  690. }
  691. public BaseItem FindByPath(string path, bool? isFolder)
  692. {
  693. // If this returns multiple items it could be tricky figuring out which one is correct.
  694. // In most cases, the newest one will be and the others obsolete but not yet cleaned up
  695. ArgumentException.ThrowIfNullOrEmpty(path);
  696. var query = new InternalItemsQuery
  697. {
  698. Path = path,
  699. IsFolder = isFolder,
  700. OrderBy = new[] { (ItemSortBy.DateCreated, SortOrder.Descending) },
  701. Limit = 1,
  702. DtoOptions = new DtoOptions(true)
  703. };
  704. return GetItemList(query)
  705. .FirstOrDefault();
  706. }
  707. /// <summary>
  708. /// Gets the person.
  709. /// </summary>
  710. /// <param name="name">The name.</param>
  711. /// <returns>Task{Person}.</returns>
  712. public Person GetPerson(string name)
  713. {
  714. var path = Person.GetPath(name);
  715. var id = GetItemByNameId<Person>(path);
  716. if (GetItemById(id) is Person item)
  717. {
  718. return item;
  719. }
  720. return null;
  721. }
  722. /// <summary>
  723. /// Gets the studio.
  724. /// </summary>
  725. /// <param name="name">The name.</param>
  726. /// <returns>Task{Studio}.</returns>
  727. public Studio GetStudio(string name)
  728. {
  729. return CreateItemByName<Studio>(Studio.GetPath, name, new DtoOptions(true));
  730. }
  731. public Guid GetStudioId(string name)
  732. {
  733. return GetItemByNameId<Studio>(Studio.GetPath(name));
  734. }
  735. public Guid GetGenreId(string name)
  736. {
  737. return GetItemByNameId<Genre>(Genre.GetPath(name));
  738. }
  739. public Guid GetMusicGenreId(string name)
  740. {
  741. return GetItemByNameId<MusicGenre>(MusicGenre.GetPath(name));
  742. }
  743. /// <summary>
  744. /// Gets the genre.
  745. /// </summary>
  746. /// <param name="name">The name.</param>
  747. /// <returns>Task{Genre}.</returns>
  748. public Genre GetGenre(string name)
  749. {
  750. return CreateItemByName<Genre>(Genre.GetPath, name, new DtoOptions(true));
  751. }
  752. /// <summary>
  753. /// Gets the music genre.
  754. /// </summary>
  755. /// <param name="name">The name.</param>
  756. /// <returns>Task{MusicGenre}.</returns>
  757. public MusicGenre GetMusicGenre(string name)
  758. {
  759. return CreateItemByName<MusicGenre>(MusicGenre.GetPath, name, new DtoOptions(true));
  760. }
  761. /// <summary>
  762. /// Gets the year.
  763. /// </summary>
  764. /// <param name="value">The value.</param>
  765. /// <returns>Task{Year}.</returns>
  766. public Year GetYear(int value)
  767. {
  768. if (value <= 0)
  769. {
  770. throw new ArgumentOutOfRangeException(nameof(value), "Years less than or equal to 0 are invalid.");
  771. }
  772. var name = value.ToString(CultureInfo.InvariantCulture);
  773. return CreateItemByName<Year>(Year.GetPath, name, new DtoOptions(true));
  774. }
  775. /// <summary>
  776. /// Gets a Genre.
  777. /// </summary>
  778. /// <param name="name">The name.</param>
  779. /// <returns>Task{Genre}.</returns>
  780. public MusicArtist GetArtist(string name)
  781. {
  782. return GetArtist(name, new DtoOptions(true));
  783. }
  784. public MusicArtist GetArtist(string name, DtoOptions options)
  785. {
  786. return CreateItemByName<MusicArtist>(MusicArtist.GetPath, name, options);
  787. }
  788. private T CreateItemByName<T>(Func<string, string> getPathFn, string name, DtoOptions options)
  789. where T : BaseItem, new()
  790. {
  791. if (typeof(T) == typeof(MusicArtist))
  792. {
  793. var existing = GetItemList(new InternalItemsQuery
  794. {
  795. IncludeItemTypes = new[] { BaseItemKind.MusicArtist },
  796. Name = name,
  797. DtoOptions = options
  798. }).Cast<MusicArtist>()
  799. .OrderBy(i => i.IsAccessedByName ? 1 : 0)
  800. .Cast<T>()
  801. .FirstOrDefault();
  802. if (existing is not null)
  803. {
  804. return existing;
  805. }
  806. }
  807. var path = getPathFn(name);
  808. var id = GetItemByNameId<T>(path);
  809. var item = GetItemById(id) as T;
  810. if (item is null)
  811. {
  812. item = new T
  813. {
  814. Name = name,
  815. Id = id,
  816. DateCreated = DateTime.UtcNow,
  817. DateModified = DateTime.UtcNow,
  818. Path = path
  819. };
  820. CreateItem(item, null);
  821. }
  822. return item;
  823. }
  824. private Guid GetItemByNameId<T>(string path)
  825. where T : BaseItem, new()
  826. {
  827. var forceCaseInsensitiveId = _configurationManager.Configuration.EnableNormalizedItemByNameIds;
  828. return GetNewItemIdInternal(path, typeof(T), forceCaseInsensitiveId);
  829. }
  830. /// <inheritdoc />
  831. public Task ValidatePeopleAsync(IProgress<double> progress, CancellationToken cancellationToken)
  832. {
  833. // Ensure the location is available.
  834. Directory.CreateDirectory(_configurationManager.ApplicationPaths.PeoplePath);
  835. return new PeopleValidator(this, _logger, _fileSystem).ValidatePeople(cancellationToken, progress);
  836. }
  837. /// <summary>
  838. /// Reloads the root media folder.
  839. /// </summary>
  840. /// <param name="progress">The progress.</param>
  841. /// <param name="cancellationToken">The cancellation token.</param>
  842. /// <returns>Task.</returns>
  843. public Task ValidateMediaLibrary(IProgress<double> progress, CancellationToken cancellationToken)
  844. {
  845. // Just run the scheduled task so that the user can see it
  846. _taskManager.CancelIfRunningAndQueue<RefreshMediaLibraryTask>();
  847. return Task.CompletedTask;
  848. }
  849. /// <summary>
  850. /// Validates the media library internal.
  851. /// </summary>
  852. /// <param name="progress">The progress.</param>
  853. /// <param name="cancellationToken">The cancellation token.</param>
  854. /// <returns>Task.</returns>
  855. public async Task ValidateMediaLibraryInternal(IProgress<double> progress, CancellationToken cancellationToken)
  856. {
  857. IsScanRunning = true;
  858. LibraryMonitor.Stop();
  859. try
  860. {
  861. await PerformLibraryValidation(progress, cancellationToken).ConfigureAwait(false);
  862. }
  863. finally
  864. {
  865. LibraryMonitor.Start();
  866. IsScanRunning = false;
  867. }
  868. }
  869. private async Task ValidateTopLibraryFolders(CancellationToken cancellationToken)
  870. {
  871. await RootFolder.RefreshMetadata(cancellationToken).ConfigureAwait(false);
  872. // Start by just validating the children of the root, but go no further
  873. await RootFolder.ValidateChildren(
  874. new Progress<double>(),
  875. new MetadataRefreshOptions(new DirectoryService(_fileSystem)),
  876. recursive: false,
  877. cancellationToken).ConfigureAwait(false);
  878. await GetUserRootFolder().RefreshMetadata(cancellationToken).ConfigureAwait(false);
  879. await GetUserRootFolder().ValidateChildren(
  880. new Progress<double>(),
  881. new MetadataRefreshOptions(new DirectoryService(_fileSystem)),
  882. recursive: false,
  883. cancellationToken).ConfigureAwait(false);
  884. // Quickly scan CollectionFolders for changes
  885. foreach (var folder in GetUserRootFolder().Children.OfType<Folder>())
  886. {
  887. await folder.RefreshMetadata(cancellationToken).ConfigureAwait(false);
  888. }
  889. }
  890. private async Task PerformLibraryValidation(IProgress<double> progress, CancellationToken cancellationToken)
  891. {
  892. _logger.LogInformation("Validating media library");
  893. await ValidateTopLibraryFolders(cancellationToken).ConfigureAwait(false);
  894. var innerProgress = new Progress<double>(pct => progress.Report(pct * 0.96));
  895. // Validate the entire media library
  896. await RootFolder.ValidateChildren(innerProgress, new MetadataRefreshOptions(new DirectoryService(_fileSystem)), recursive: true, cancellationToken).ConfigureAwait(false);
  897. progress.Report(96);
  898. innerProgress = new Progress<double>(pct => progress.Report(96 + (pct * .04)));
  899. await RunPostScanTasks(innerProgress, cancellationToken).ConfigureAwait(false);
  900. progress.Report(100);
  901. }
  902. /// <summary>
  903. /// Runs the post scan tasks.
  904. /// </summary>
  905. /// <param name="progress">The progress.</param>
  906. /// <param name="cancellationToken">The cancellation token.</param>
  907. /// <returns>Task.</returns>
  908. private async Task RunPostScanTasks(IProgress<double> progress, CancellationToken cancellationToken)
  909. {
  910. var tasks = PostscanTasks.ToList();
  911. var numComplete = 0;
  912. var numTasks = tasks.Count;
  913. foreach (var task in tasks)
  914. {
  915. // Prevent access to modified closure
  916. var currentNumComplete = numComplete;
  917. var innerProgress = new Progress<double>(pct =>
  918. {
  919. double innerPercent = pct;
  920. innerPercent /= 100;
  921. innerPercent += currentNumComplete;
  922. innerPercent /= numTasks;
  923. innerPercent *= 100;
  924. progress.Report(innerPercent);
  925. });
  926. _logger.LogDebug("Running post-scan task {0}", task.GetType().Name);
  927. try
  928. {
  929. await task.Run(innerProgress, cancellationToken).ConfigureAwait(false);
  930. }
  931. catch (OperationCanceledException)
  932. {
  933. _logger.LogInformation("Post-scan task cancelled: {0}", task.GetType().Name);
  934. throw;
  935. }
  936. catch (Exception ex)
  937. {
  938. _logger.LogError(ex, "Error running post-scan task");
  939. }
  940. numComplete++;
  941. double percent = numComplete;
  942. percent /= numTasks;
  943. progress.Report(percent * 100);
  944. }
  945. _itemRepository.UpdateInheritedValues();
  946. progress.Report(100);
  947. }
  948. /// <summary>
  949. /// Gets the default view.
  950. /// </summary>
  951. /// <returns>IEnumerable{VirtualFolderInfo}.</returns>
  952. public List<VirtualFolderInfo> GetVirtualFolders()
  953. {
  954. return GetVirtualFolders(false);
  955. }
  956. public List<VirtualFolderInfo> GetVirtualFolders(bool includeRefreshState)
  957. {
  958. _logger.LogDebug("Getting topLibraryFolders");
  959. var topLibraryFolders = GetUserRootFolder().Children.ToList();
  960. _logger.LogDebug("Getting refreshQueue");
  961. var refreshQueue = includeRefreshState ? ProviderManager.GetRefreshQueue() : null;
  962. return _fileSystem.GetDirectoryPaths(_configurationManager.ApplicationPaths.DefaultUserViewsPath)
  963. .Select(dir => GetVirtualFolderInfo(dir, topLibraryFolders, refreshQueue))
  964. .ToList();
  965. }
  966. private VirtualFolderInfo GetVirtualFolderInfo(string dir, List<BaseItem> allCollectionFolders, HashSet<Guid> refreshQueue)
  967. {
  968. var info = new VirtualFolderInfo
  969. {
  970. Name = Path.GetFileName(dir),
  971. Locations = _fileSystem.GetFilePaths(dir, false)
  972. .Where(i => Path.GetExtension(i.AsSpan()).Equals(ShortcutFileExtension, StringComparison.OrdinalIgnoreCase))
  973. .Select(i =>
  974. {
  975. try
  976. {
  977. return _appHost.ExpandVirtualPath(_fileSystem.ResolveShortcut(i));
  978. }
  979. catch (Exception ex)
  980. {
  981. _logger.LogError(ex, "Error resolving shortcut file {File}", i);
  982. return null;
  983. }
  984. })
  985. .Where(i => i is not null)
  986. .Order()
  987. .ToArray(),
  988. CollectionType = GetCollectionType(dir)
  989. };
  990. var libraryFolder = allCollectionFolders.FirstOrDefault(i => string.Equals(i.Path, dir, StringComparison.OrdinalIgnoreCase));
  991. if (libraryFolder is not null)
  992. {
  993. var libraryFolderId = libraryFolder.Id.ToString("N", CultureInfo.InvariantCulture);
  994. info.ItemId = libraryFolderId;
  995. if (libraryFolder.HasImage(ImageType.Primary))
  996. {
  997. info.PrimaryImageItemId = libraryFolderId;
  998. }
  999. info.LibraryOptions = GetLibraryOptions(libraryFolder);
  1000. if (refreshQueue is not null)
  1001. {
  1002. info.RefreshProgress = libraryFolder.GetRefreshProgress();
  1003. info.RefreshStatus = info.RefreshProgress.HasValue ? "Active" : refreshQueue.Contains(libraryFolder.Id) ? "Queued" : "Idle";
  1004. }
  1005. }
  1006. return info;
  1007. }
  1008. private CollectionTypeOptions? GetCollectionType(string path)
  1009. {
  1010. var files = _fileSystem.GetFilePaths(path, new[] { ".collection" }, true, false);
  1011. foreach (ReadOnlySpan<char> file in files)
  1012. {
  1013. if (Enum.TryParse<CollectionTypeOptions>(Path.GetFileNameWithoutExtension(file), true, out var res))
  1014. {
  1015. return res;
  1016. }
  1017. }
  1018. return null;
  1019. }
  1020. /// <summary>
  1021. /// Gets the item by id.
  1022. /// </summary>
  1023. /// <param name="id">The id.</param>
  1024. /// <returns>BaseItem.</returns>
  1025. /// <exception cref="ArgumentNullException"><paramref name="id"/> is <c>null</c>.</exception>
  1026. public BaseItem GetItemById(Guid id)
  1027. {
  1028. if (id.IsEmpty())
  1029. {
  1030. throw new ArgumentException("Guid can't be empty", nameof(id));
  1031. }
  1032. if (_cache.TryGetValue(id, out BaseItem item))
  1033. {
  1034. return item;
  1035. }
  1036. item = RetrieveItem(id);
  1037. if (item is not null)
  1038. {
  1039. RegisterItem(item);
  1040. }
  1041. return item;
  1042. }
  1043. public List<BaseItem> GetItemList(InternalItemsQuery query, bool allowExternalContent)
  1044. {
  1045. if (query.Recursive && !query.ParentId.IsEmpty())
  1046. {
  1047. var parent = GetItemById(query.ParentId);
  1048. if (parent is not null)
  1049. {
  1050. SetTopParentIdsOrAncestors(query, new[] { parent });
  1051. }
  1052. }
  1053. if (query.User is not null)
  1054. {
  1055. AddUserToQuery(query, query.User, allowExternalContent);
  1056. }
  1057. var itemList = _itemRepository.GetItemList(query);
  1058. var user = query.User;
  1059. if (user is not null)
  1060. {
  1061. return itemList.Where(i => i.IsVisible(user)).ToList();
  1062. }
  1063. return itemList;
  1064. }
  1065. public List<BaseItem> GetItemList(InternalItemsQuery query)
  1066. {
  1067. return GetItemList(query, true);
  1068. }
  1069. public int GetCount(InternalItemsQuery query)
  1070. {
  1071. if (query.Recursive && !query.ParentId.IsEmpty())
  1072. {
  1073. var parent = GetItemById(query.ParentId);
  1074. if (parent is not null)
  1075. {
  1076. SetTopParentIdsOrAncestors(query, new[] { parent });
  1077. }
  1078. }
  1079. if (query.User is not null)
  1080. {
  1081. AddUserToQuery(query, query.User);
  1082. }
  1083. return _itemRepository.GetCount(query);
  1084. }
  1085. public List<BaseItem> GetItemList(InternalItemsQuery query, List<BaseItem> parents)
  1086. {
  1087. SetTopParentIdsOrAncestors(query, parents);
  1088. if (query.AncestorIds.Length == 0 && query.TopParentIds.Length == 0)
  1089. {
  1090. if (query.User is not null)
  1091. {
  1092. AddUserToQuery(query, query.User);
  1093. }
  1094. }
  1095. return _itemRepository.GetItemList(query);
  1096. }
  1097. public QueryResult<BaseItem> QueryItems(InternalItemsQuery query)
  1098. {
  1099. if (query.User is not null)
  1100. {
  1101. AddUserToQuery(query, query.User);
  1102. }
  1103. if (query.EnableTotalRecordCount)
  1104. {
  1105. return _itemRepository.GetItems(query);
  1106. }
  1107. return new QueryResult<BaseItem>(
  1108. query.StartIndex,
  1109. null,
  1110. _itemRepository.GetItemList(query));
  1111. }
  1112. public List<Guid> GetItemIds(InternalItemsQuery query)
  1113. {
  1114. if (query.User is not null)
  1115. {
  1116. AddUserToQuery(query, query.User);
  1117. }
  1118. return _itemRepository.GetItemIdsList(query);
  1119. }
  1120. public QueryResult<(BaseItem Item, ItemCounts ItemCounts)> GetStudios(InternalItemsQuery query)
  1121. {
  1122. if (query.User is not null)
  1123. {
  1124. AddUserToQuery(query, query.User);
  1125. }
  1126. SetTopParentOrAncestorIds(query);
  1127. return _itemRepository.GetStudios(query);
  1128. }
  1129. public QueryResult<(BaseItem Item, ItemCounts ItemCounts)> GetGenres(InternalItemsQuery query)
  1130. {
  1131. if (query.User is not null)
  1132. {
  1133. AddUserToQuery(query, query.User);
  1134. }
  1135. SetTopParentOrAncestorIds(query);
  1136. return _itemRepository.GetGenres(query);
  1137. }
  1138. public QueryResult<(BaseItem Item, ItemCounts ItemCounts)> GetMusicGenres(InternalItemsQuery query)
  1139. {
  1140. if (query.User is not null)
  1141. {
  1142. AddUserToQuery(query, query.User);
  1143. }
  1144. SetTopParentOrAncestorIds(query);
  1145. return _itemRepository.GetMusicGenres(query);
  1146. }
  1147. public QueryResult<(BaseItem Item, ItemCounts ItemCounts)> GetAllArtists(InternalItemsQuery query)
  1148. {
  1149. if (query.User is not null)
  1150. {
  1151. AddUserToQuery(query, query.User);
  1152. }
  1153. SetTopParentOrAncestorIds(query);
  1154. return _itemRepository.GetAllArtists(query);
  1155. }
  1156. public QueryResult<(BaseItem Item, ItemCounts ItemCounts)> GetArtists(InternalItemsQuery query)
  1157. {
  1158. if (query.User is not null)
  1159. {
  1160. AddUserToQuery(query, query.User);
  1161. }
  1162. SetTopParentOrAncestorIds(query);
  1163. return _itemRepository.GetArtists(query);
  1164. }
  1165. private void SetTopParentOrAncestorIds(InternalItemsQuery query)
  1166. {
  1167. var ancestorIds = query.AncestorIds;
  1168. int len = ancestorIds.Length;
  1169. if (len == 0)
  1170. {
  1171. return;
  1172. }
  1173. var parents = new BaseItem[len];
  1174. for (int i = 0; i < len; i++)
  1175. {
  1176. parents[i] = GetItemById(ancestorIds[i]);
  1177. if (parents[i] is not (ICollectionFolder or UserView))
  1178. {
  1179. return;
  1180. }
  1181. }
  1182. // Optimize by querying against top level views
  1183. query.TopParentIds = parents.SelectMany(i => GetTopParentIdsForQuery(i, query.User)).ToArray();
  1184. query.AncestorIds = Array.Empty<Guid>();
  1185. // Prevent searching in all libraries due to empty filter
  1186. if (query.TopParentIds.Length == 0)
  1187. {
  1188. query.TopParentIds = new[] { Guid.NewGuid() };
  1189. }
  1190. }
  1191. public QueryResult<(BaseItem Item, ItemCounts ItemCounts)> GetAlbumArtists(InternalItemsQuery query)
  1192. {
  1193. if (query.User is not null)
  1194. {
  1195. AddUserToQuery(query, query.User);
  1196. }
  1197. SetTopParentOrAncestorIds(query);
  1198. return _itemRepository.GetAlbumArtists(query);
  1199. }
  1200. public QueryResult<BaseItem> GetItemsResult(InternalItemsQuery query)
  1201. {
  1202. if (query.Recursive && !query.ParentId.IsEmpty())
  1203. {
  1204. var parent = GetItemById(query.ParentId);
  1205. if (parent is not null)
  1206. {
  1207. SetTopParentIdsOrAncestors(query, new[] { parent });
  1208. }
  1209. }
  1210. if (query.User is not null)
  1211. {
  1212. AddUserToQuery(query, query.User);
  1213. }
  1214. if (query.EnableTotalRecordCount)
  1215. {
  1216. return _itemRepository.GetItems(query);
  1217. }
  1218. return new QueryResult<BaseItem>(
  1219. query.StartIndex,
  1220. null,
  1221. _itemRepository.GetItemList(query));
  1222. }
  1223. private void SetTopParentIdsOrAncestors(InternalItemsQuery query, IReadOnlyCollection<BaseItem> parents)
  1224. {
  1225. if (parents.All(i => i is ICollectionFolder || i is UserView))
  1226. {
  1227. // Optimize by querying against top level views
  1228. query.TopParentIds = parents.SelectMany(i => GetTopParentIdsForQuery(i, query.User)).ToArray();
  1229. // Prevent searching in all libraries due to empty filter
  1230. if (query.TopParentIds.Length == 0)
  1231. {
  1232. query.TopParentIds = new[] { Guid.NewGuid() };
  1233. }
  1234. }
  1235. else
  1236. {
  1237. // We need to be able to query from any arbitrary ancestor up the tree
  1238. query.AncestorIds = parents.SelectMany(i => i.GetIdsForAncestorQuery()).ToArray();
  1239. // Prevent searching in all libraries due to empty filter
  1240. if (query.AncestorIds.Length == 0)
  1241. {
  1242. query.AncestorIds = new[] { Guid.NewGuid() };
  1243. }
  1244. }
  1245. query.Parent = null;
  1246. }
  1247. private void AddUserToQuery(InternalItemsQuery query, User user, bool allowExternalContent = true)
  1248. {
  1249. if (query.AncestorIds.Length == 0 &&
  1250. query.ParentId.IsEmpty() &&
  1251. query.ChannelIds.Count == 0 &&
  1252. query.TopParentIds.Length == 0 &&
  1253. string.IsNullOrEmpty(query.AncestorWithPresentationUniqueKey) &&
  1254. string.IsNullOrEmpty(query.SeriesPresentationUniqueKey) &&
  1255. query.ItemIds.Length == 0)
  1256. {
  1257. var userViews = UserViewManager.GetUserViews(new UserViewQuery
  1258. {
  1259. UserId = user.Id,
  1260. IncludeHidden = true,
  1261. IncludeExternalContent = allowExternalContent
  1262. });
  1263. query.TopParentIds = userViews.SelectMany(i => GetTopParentIdsForQuery(i, user)).ToArray();
  1264. // Prevent searching in all libraries due to empty filter
  1265. if (query.TopParentIds.Length == 0)
  1266. {
  1267. query.TopParentIds = new[] { Guid.NewGuid() };
  1268. }
  1269. }
  1270. }
  1271. private IEnumerable<Guid> GetTopParentIdsForQuery(BaseItem item, User user)
  1272. {
  1273. if (item is UserView view)
  1274. {
  1275. if (view.ViewType == CollectionType.livetv)
  1276. {
  1277. return new[] { view.Id };
  1278. }
  1279. // Translate view into folders
  1280. if (!view.DisplayParentId.IsEmpty())
  1281. {
  1282. var displayParent = GetItemById(view.DisplayParentId);
  1283. if (displayParent is not null)
  1284. {
  1285. return GetTopParentIdsForQuery(displayParent, user);
  1286. }
  1287. return Array.Empty<Guid>();
  1288. }
  1289. if (!view.ParentId.IsEmpty())
  1290. {
  1291. var displayParent = GetItemById(view.ParentId);
  1292. if (displayParent is not null)
  1293. {
  1294. return GetTopParentIdsForQuery(displayParent, user);
  1295. }
  1296. return Array.Empty<Guid>();
  1297. }
  1298. // Handle grouping
  1299. if (user is not null && view.ViewType != CollectionType.unknown && UserView.IsEligibleForGrouping(view.ViewType)
  1300. && user.GetPreference(PreferenceKind.GroupedFolders).Length > 0)
  1301. {
  1302. return GetUserRootFolder()
  1303. .GetChildren(user, true)
  1304. .OfType<CollectionFolder>()
  1305. .Where(i => i.CollectionType is null || i.CollectionType == view.ViewType)
  1306. .Where(i => user.IsFolderGrouped(i.Id))
  1307. .SelectMany(i => GetTopParentIdsForQuery(i, user));
  1308. }
  1309. return Array.Empty<Guid>();
  1310. }
  1311. if (item is CollectionFolder collectionFolder)
  1312. {
  1313. return collectionFolder.PhysicalFolderIds;
  1314. }
  1315. var topParent = item.GetTopParent();
  1316. if (topParent is not null)
  1317. {
  1318. return new[] { topParent.Id };
  1319. }
  1320. return Array.Empty<Guid>();
  1321. }
  1322. /// <summary>
  1323. /// Gets the intros.
  1324. /// </summary>
  1325. /// <param name="item">The item.</param>
  1326. /// <param name="user">The user.</param>
  1327. /// <returns>IEnumerable{System.String}.</returns>
  1328. public async Task<IEnumerable<Video>> GetIntros(BaseItem item, User user)
  1329. {
  1330. var tasks = IntroProviders
  1331. .Take(1)
  1332. .Select(i => GetIntros(i, item, user));
  1333. var items = await Task.WhenAll(tasks).ConfigureAwait(false);
  1334. return items
  1335. .SelectMany(i => i.ToArray())
  1336. .Select(ResolveIntro)
  1337. .Where(i => i is not null);
  1338. }
  1339. /// <summary>
  1340. /// Gets the intros.
  1341. /// </summary>
  1342. /// <param name="provider">The provider.</param>
  1343. /// <param name="item">The item.</param>
  1344. /// <param name="user">The user.</param>
  1345. /// <returns>Task&lt;IEnumerable&lt;IntroInfo&gt;&gt;.</returns>
  1346. private async Task<IEnumerable<IntroInfo>> GetIntros(IIntroProvider provider, BaseItem item, User user)
  1347. {
  1348. try
  1349. {
  1350. return await provider.GetIntros(item, user).ConfigureAwait(false);
  1351. }
  1352. catch (Exception ex)
  1353. {
  1354. _logger.LogError(ex, "Error getting intros");
  1355. return Enumerable.Empty<IntroInfo>();
  1356. }
  1357. }
  1358. /// <summary>
  1359. /// Resolves the intro.
  1360. /// </summary>
  1361. /// <param name="info">The info.</param>
  1362. /// <returns>Video.</returns>
  1363. private Video ResolveIntro(IntroInfo info)
  1364. {
  1365. Video video = null;
  1366. if (info.ItemId.HasValue)
  1367. {
  1368. // Get an existing item by Id
  1369. video = GetItemById(info.ItemId.Value) as Video;
  1370. if (video is null)
  1371. {
  1372. _logger.LogError("Unable to locate item with Id {ID}.", info.ItemId.Value);
  1373. }
  1374. }
  1375. else if (!string.IsNullOrEmpty(info.Path))
  1376. {
  1377. try
  1378. {
  1379. // Try to resolve the path into a video
  1380. video = ResolvePath(_fileSystem.GetFileSystemInfo(info.Path)) as Video;
  1381. if (video is null)
  1382. {
  1383. _logger.LogError("Intro resolver returned null for {Path}.", info.Path);
  1384. }
  1385. else
  1386. {
  1387. // Pull the saved db item that will include metadata
  1388. var dbItem = GetItemById(video.Id) as Video;
  1389. if (dbItem is not null)
  1390. {
  1391. video = dbItem;
  1392. }
  1393. else
  1394. {
  1395. return null;
  1396. }
  1397. }
  1398. }
  1399. catch (Exception ex)
  1400. {
  1401. _logger.LogError(ex, "Error resolving path {Path}.", info.Path);
  1402. }
  1403. }
  1404. else
  1405. {
  1406. _logger.LogError("IntroProvider returned an IntroInfo with null Path and ItemId.");
  1407. }
  1408. return video;
  1409. }
  1410. /// <summary>
  1411. /// Sorts the specified sort by.
  1412. /// </summary>
  1413. /// <param name="items">The items.</param>
  1414. /// <param name="user">The user.</param>
  1415. /// <param name="sortBy">The sort by.</param>
  1416. /// <param name="sortOrder">The sort order.</param>
  1417. /// <returns>IEnumerable{BaseItem}.</returns>
  1418. public IEnumerable<BaseItem> Sort(IEnumerable<BaseItem> items, User user, IEnumerable<ItemSortBy> sortBy, SortOrder sortOrder)
  1419. {
  1420. var isFirst = true;
  1421. IOrderedEnumerable<BaseItem> orderedItems = null;
  1422. foreach (var orderBy in sortBy.Select(o => GetComparer(o, user)).Where(c => c is not null))
  1423. {
  1424. if (isFirst)
  1425. {
  1426. orderedItems = sortOrder == SortOrder.Descending ? items.OrderByDescending(i => i, orderBy) : items.OrderBy(i => i, orderBy);
  1427. }
  1428. else
  1429. {
  1430. orderedItems = sortOrder == SortOrder.Descending ? orderedItems.ThenByDescending(i => i, orderBy) : orderedItems.ThenBy(i => i, orderBy);
  1431. }
  1432. isFirst = false;
  1433. }
  1434. return orderedItems ?? items;
  1435. }
  1436. public IEnumerable<BaseItem> Sort(IEnumerable<BaseItem> items, User user, IEnumerable<(ItemSortBy OrderBy, SortOrder SortOrder)> orderBy)
  1437. {
  1438. var isFirst = true;
  1439. IOrderedEnumerable<BaseItem> orderedItems = null;
  1440. foreach (var (name, sortOrder) in orderBy)
  1441. {
  1442. var comparer = GetComparer(name, user);
  1443. if (comparer is null)
  1444. {
  1445. continue;
  1446. }
  1447. if (isFirst)
  1448. {
  1449. orderedItems = sortOrder == SortOrder.Descending ? items.OrderByDescending(i => i, comparer) : items.OrderBy(i => i, comparer);
  1450. }
  1451. else
  1452. {
  1453. orderedItems = sortOrder == SortOrder.Descending ? orderedItems.ThenByDescending(i => i, comparer) : orderedItems.ThenBy(i => i, comparer);
  1454. }
  1455. isFirst = false;
  1456. }
  1457. return orderedItems ?? items;
  1458. }
  1459. /// <summary>
  1460. /// Gets the comparer.
  1461. /// </summary>
  1462. /// <param name="name">The name.</param>
  1463. /// <param name="user">The user.</param>
  1464. /// <returns>IBaseItemComparer.</returns>
  1465. private IBaseItemComparer GetComparer(ItemSortBy name, User user)
  1466. {
  1467. var comparer = Comparers.FirstOrDefault(c => name == c.Type);
  1468. // If it requires a user, create a new one, and assign the user
  1469. if (comparer is IUserBaseItemComparer)
  1470. {
  1471. var userComparer = (IUserBaseItemComparer)Activator.CreateInstance(comparer.GetType());
  1472. userComparer.User = user;
  1473. userComparer.UserManager = _userManager;
  1474. userComparer.UserDataRepository = _userDataRepository;
  1475. return userComparer;
  1476. }
  1477. return comparer;
  1478. }
  1479. /// <summary>
  1480. /// Creates the item.
  1481. /// </summary>
  1482. /// <param name="item">The item.</param>
  1483. /// <param name="parent">The parent item.</param>
  1484. public void CreateItem(BaseItem item, BaseItem parent)
  1485. {
  1486. CreateItems(new[] { item }, parent, CancellationToken.None);
  1487. }
  1488. /// <summary>
  1489. /// Creates the items.
  1490. /// </summary>
  1491. /// <param name="items">The items.</param>
  1492. /// <param name="parent">The parent item.</param>
  1493. /// <param name="cancellationToken">The cancellation token.</param>
  1494. public void CreateItems(IReadOnlyList<BaseItem> items, BaseItem parent, CancellationToken cancellationToken)
  1495. {
  1496. _itemRepository.SaveItems(items, cancellationToken);
  1497. foreach (var item in items)
  1498. {
  1499. RegisterItem(item);
  1500. }
  1501. if (ItemAdded is not null)
  1502. {
  1503. foreach (var item in items)
  1504. {
  1505. // With the live tv guide this just creates too much noise
  1506. if (item.SourceType != SourceType.Library)
  1507. {
  1508. continue;
  1509. }
  1510. try
  1511. {
  1512. ItemAdded(
  1513. this,
  1514. new ItemChangeEventArgs
  1515. {
  1516. Item = item,
  1517. Parent = parent ?? item.GetParent()
  1518. });
  1519. }
  1520. catch (Exception ex)
  1521. {
  1522. _logger.LogError(ex, "Error in ItemAdded event handler");
  1523. }
  1524. }
  1525. }
  1526. }
  1527. private bool ImageNeedsRefresh(ItemImageInfo image)
  1528. {
  1529. if (image.Path is not null && image.IsLocalFile)
  1530. {
  1531. if (image.Width == 0 || image.Height == 0 || string.IsNullOrEmpty(image.BlurHash))
  1532. {
  1533. return true;
  1534. }
  1535. try
  1536. {
  1537. return _fileSystem.GetLastWriteTimeUtc(image.Path) != image.DateModified;
  1538. }
  1539. catch (Exception ex)
  1540. {
  1541. _logger.LogError(ex, "Cannot get file info for {0}", image.Path);
  1542. return false;
  1543. }
  1544. }
  1545. return image.Path is not null && !image.IsLocalFile;
  1546. }
  1547. /// <inheritdoc />
  1548. public async Task UpdateImagesAsync(BaseItem item, bool forceUpdate = false)
  1549. {
  1550. ArgumentNullException.ThrowIfNull(item);
  1551. var outdated = forceUpdate
  1552. ? item.ImageInfos.Where(i => i.Path is not null).ToArray()
  1553. : item.ImageInfos.Where(ImageNeedsRefresh).ToArray();
  1554. // Skip image processing if current or live tv source
  1555. if (outdated.Length == 0 || item.SourceType != SourceType.Library)
  1556. {
  1557. RegisterItem(item);
  1558. return;
  1559. }
  1560. foreach (var img in outdated)
  1561. {
  1562. var image = img;
  1563. if (!img.IsLocalFile)
  1564. {
  1565. try
  1566. {
  1567. var index = item.GetImageIndex(img);
  1568. image = await ConvertImageToLocal(item, img, index).ConfigureAwait(false);
  1569. }
  1570. catch (ArgumentException)
  1571. {
  1572. _logger.LogWarning("Cannot get image index for {ImagePath}", img.Path);
  1573. continue;
  1574. }
  1575. catch (Exception ex) when (ex is InvalidOperationException or IOException)
  1576. {
  1577. _logger.LogWarning(ex, "Cannot fetch image from {ImagePath}", img.Path);
  1578. continue;
  1579. }
  1580. catch (HttpRequestException ex)
  1581. {
  1582. _logger.LogWarning(ex, "Cannot fetch image from {ImagePath}. Http status code: {HttpStatus}", img.Path, ex.StatusCode);
  1583. continue;
  1584. }
  1585. }
  1586. ImageDimensions size;
  1587. try
  1588. {
  1589. size = _imageProcessor.GetImageDimensions(item, image);
  1590. image.Width = size.Width;
  1591. image.Height = size.Height;
  1592. }
  1593. catch (Exception ex)
  1594. {
  1595. _logger.LogError(ex, "Cannot get image dimensions for {ImagePath}", image.Path);
  1596. size = default;
  1597. image.Width = 0;
  1598. image.Height = 0;
  1599. }
  1600. try
  1601. {
  1602. image.BlurHash = _imageProcessor.GetImageBlurHash(image.Path, size);
  1603. }
  1604. catch (Exception ex)
  1605. {
  1606. _logger.LogError(ex, "Cannot compute blurhash for {ImagePath}", image.Path);
  1607. image.BlurHash = string.Empty;
  1608. }
  1609. try
  1610. {
  1611. image.DateModified = _fileSystem.GetLastWriteTimeUtc(image.Path);
  1612. }
  1613. catch (Exception ex)
  1614. {
  1615. _logger.LogError(ex, "Cannot update DateModified for {ImagePath}", image.Path);
  1616. }
  1617. }
  1618. _itemRepository.SaveImages(item);
  1619. RegisterItem(item);
  1620. }
  1621. /// <inheritdoc />
  1622. public async Task UpdateItemsAsync(IReadOnlyList<BaseItem> items, BaseItem parent, ItemUpdateType updateReason, CancellationToken cancellationToken)
  1623. {
  1624. foreach (var item in items)
  1625. {
  1626. await RunMetadataSavers(item, updateReason).ConfigureAwait(false);
  1627. }
  1628. _itemRepository.SaveItems(items, cancellationToken);
  1629. if (ItemUpdated is not null)
  1630. {
  1631. foreach (var item in items)
  1632. {
  1633. // With the live tv guide this just creates too much noise
  1634. if (item.SourceType != SourceType.Library)
  1635. {
  1636. continue;
  1637. }
  1638. try
  1639. {
  1640. ItemUpdated(
  1641. this,
  1642. new ItemChangeEventArgs
  1643. {
  1644. Item = item,
  1645. Parent = parent,
  1646. UpdateReason = updateReason
  1647. });
  1648. }
  1649. catch (Exception ex)
  1650. {
  1651. _logger.LogError(ex, "Error in ItemUpdated event handler");
  1652. }
  1653. }
  1654. }
  1655. }
  1656. /// <inheritdoc />
  1657. public Task UpdateItemAsync(BaseItem item, BaseItem parent, ItemUpdateType updateReason, CancellationToken cancellationToken)
  1658. => UpdateItemsAsync(new[] { item }, parent, updateReason, cancellationToken);
  1659. public async Task RunMetadataSavers(BaseItem item, ItemUpdateType updateReason)
  1660. {
  1661. if (item.IsFileProtocol)
  1662. {
  1663. await ProviderManager.SaveMetadataAsync(item, updateReason).ConfigureAwait(false);
  1664. }
  1665. item.DateLastSaved = DateTime.UtcNow;
  1666. await UpdateImagesAsync(item, updateReason >= ItemUpdateType.ImageUpdate).ConfigureAwait(false);
  1667. }
  1668. /// <summary>
  1669. /// Reports the item removed.
  1670. /// </summary>
  1671. /// <param name="item">The item.</param>
  1672. /// <param name="parent">The parent item.</param>
  1673. public void ReportItemRemoved(BaseItem item, BaseItem parent)
  1674. {
  1675. if (ItemRemoved is not null)
  1676. {
  1677. try
  1678. {
  1679. ItemRemoved(
  1680. this,
  1681. new ItemChangeEventArgs
  1682. {
  1683. Item = item,
  1684. Parent = parent
  1685. });
  1686. }
  1687. catch (Exception ex)
  1688. {
  1689. _logger.LogError(ex, "Error in ItemRemoved event handler");
  1690. }
  1691. }
  1692. }
  1693. /// <summary>
  1694. /// Retrieves the item.
  1695. /// </summary>
  1696. /// <param name="id">The id.</param>
  1697. /// <returns>BaseItem.</returns>
  1698. public BaseItem RetrieveItem(Guid id)
  1699. {
  1700. return _itemRepository.RetrieveItem(id);
  1701. }
  1702. public List<Folder> GetCollectionFolders(BaseItem item)
  1703. {
  1704. return GetCollectionFolders(item, GetUserRootFolder().Children.OfType<Folder>());
  1705. }
  1706. public List<Folder> GetCollectionFolders(BaseItem item, IEnumerable<Folder> allUserRootChildren)
  1707. {
  1708. while (item is not null)
  1709. {
  1710. var parent = item.GetParent();
  1711. if (parent is AggregateFolder)
  1712. {
  1713. break;
  1714. }
  1715. if (parent is null)
  1716. {
  1717. var owner = item.GetOwner();
  1718. if (owner is null)
  1719. {
  1720. break;
  1721. }
  1722. item = owner;
  1723. }
  1724. else
  1725. {
  1726. item = parent;
  1727. }
  1728. }
  1729. if (item is null)
  1730. {
  1731. return new List<Folder>();
  1732. }
  1733. return GetCollectionFoldersInternal(item, allUserRootChildren);
  1734. }
  1735. private static List<Folder> GetCollectionFoldersInternal(BaseItem item, IEnumerable<Folder> allUserRootChildren)
  1736. {
  1737. return allUserRootChildren
  1738. .Where(i => string.Equals(i.Path, item.Path, StringComparison.OrdinalIgnoreCase) || i.PhysicalLocations.Contains(item.Path.AsSpan(), StringComparison.OrdinalIgnoreCase))
  1739. .ToList();
  1740. }
  1741. public LibraryOptions GetLibraryOptions(BaseItem item)
  1742. {
  1743. if (item is not CollectionFolder collectionFolder)
  1744. {
  1745. // List.Find is more performant than FirstOrDefault due to enumerator allocation
  1746. collectionFolder = GetCollectionFolders(item)
  1747. .Find(folder => folder is CollectionFolder) as CollectionFolder;
  1748. }
  1749. return collectionFolder is null
  1750. ? new LibraryOptions()
  1751. : collectionFolder.GetLibraryOptions();
  1752. }
  1753. public CollectionType? GetContentType(BaseItem item)
  1754. {
  1755. var configuredContentType = GetConfiguredContentType(item, false);
  1756. if (configuredContentType is not null)
  1757. {
  1758. return configuredContentType;
  1759. }
  1760. configuredContentType = GetConfiguredContentType(item, true);
  1761. if (configuredContentType is not null)
  1762. {
  1763. return configuredContentType;
  1764. }
  1765. return GetInheritedContentType(item);
  1766. }
  1767. public CollectionType? GetInheritedContentType(BaseItem item)
  1768. {
  1769. var type = GetTopFolderContentType(item);
  1770. if (type is not null)
  1771. {
  1772. return type;
  1773. }
  1774. return item.GetParents()
  1775. .Select(GetConfiguredContentType)
  1776. .LastOrDefault(i => i is not null);
  1777. }
  1778. public CollectionType? GetConfiguredContentType(BaseItem item)
  1779. {
  1780. return GetConfiguredContentType(item, false);
  1781. }
  1782. public CollectionType? GetConfiguredContentType(string path)
  1783. {
  1784. return GetContentTypeOverride(path, false);
  1785. }
  1786. public CollectionType? GetConfiguredContentType(BaseItem item, bool inheritConfiguredPath)
  1787. {
  1788. if (item is ICollectionFolder collectionFolder)
  1789. {
  1790. return collectionFolder.CollectionType;
  1791. }
  1792. return GetContentTypeOverride(item.ContainingFolderPath, inheritConfiguredPath);
  1793. }
  1794. private CollectionType? GetContentTypeOverride(string path, bool inherit)
  1795. {
  1796. var nameValuePair = _configurationManager.Configuration.ContentTypes
  1797. .FirstOrDefault(i => _fileSystem.AreEqual(i.Name, path)
  1798. || (inherit && !string.IsNullOrEmpty(i.Name)
  1799. && _fileSystem.ContainsSubPath(i.Name, path)));
  1800. if (Enum.TryParse<CollectionType>(nameValuePair?.Value, out var collectionType))
  1801. {
  1802. return collectionType;
  1803. }
  1804. return null;
  1805. }
  1806. private CollectionType? GetTopFolderContentType(BaseItem item)
  1807. {
  1808. if (item is null)
  1809. {
  1810. return null;
  1811. }
  1812. while (!item.ParentId.IsEmpty())
  1813. {
  1814. var parent = item.GetParent();
  1815. if (parent is null || parent is AggregateFolder)
  1816. {
  1817. break;
  1818. }
  1819. item = parent;
  1820. }
  1821. return GetUserRootFolder().Children
  1822. .OfType<ICollectionFolder>()
  1823. .Where(i => string.Equals(i.Path, item.Path, StringComparison.OrdinalIgnoreCase) || i.PhysicalLocations.Contains(item.Path))
  1824. .Select(i => i.CollectionType)
  1825. .FirstOrDefault(i => i is not null);
  1826. }
  1827. public UserView GetNamedView(
  1828. User user,
  1829. string name,
  1830. CollectionType? viewType,
  1831. string sortName)
  1832. {
  1833. return GetNamedView(user, name, Guid.Empty, viewType, sortName);
  1834. }
  1835. public UserView GetNamedView(
  1836. string name,
  1837. CollectionType viewType,
  1838. string sortName)
  1839. {
  1840. var path = Path.Combine(
  1841. _configurationManager.ApplicationPaths.InternalMetadataPath,
  1842. "views",
  1843. _fileSystem.GetValidFilename(viewType.ToString()));
  1844. var id = GetNewItemId(path + "_namedview_" + name, typeof(UserView));
  1845. var item = GetItemById(id) as UserView;
  1846. var refresh = false;
  1847. if (item is null || !string.Equals(item.Path, path, StringComparison.OrdinalIgnoreCase))
  1848. {
  1849. Directory.CreateDirectory(path);
  1850. item = new UserView
  1851. {
  1852. Path = path,
  1853. Id = id,
  1854. DateCreated = DateTime.UtcNow,
  1855. Name = name,
  1856. ViewType = viewType,
  1857. ForcedSortName = sortName
  1858. };
  1859. CreateItem(item, null);
  1860. refresh = true;
  1861. }
  1862. if (refresh)
  1863. {
  1864. item.UpdateToRepositoryAsync(ItemUpdateType.MetadataImport, CancellationToken.None).GetAwaiter().GetResult();
  1865. ProviderManager.QueueRefresh(item.Id, new MetadataRefreshOptions(new DirectoryService(_fileSystem)), RefreshPriority.Normal);
  1866. }
  1867. return item;
  1868. }
  1869. public UserView GetNamedView(
  1870. User user,
  1871. string name,
  1872. Guid parentId,
  1873. CollectionType? viewType,
  1874. string sortName)
  1875. {
  1876. var parentIdString = parentId.IsEmpty()
  1877. ? null
  1878. : parentId.ToString("N", CultureInfo.InvariantCulture);
  1879. var idValues = "38_namedview_" + name + user.Id.ToString("N", CultureInfo.InvariantCulture) + (parentIdString ?? string.Empty) + (viewType?.ToString() ?? string.Empty);
  1880. var id = GetNewItemId(idValues, typeof(UserView));
  1881. var path = Path.Combine(_configurationManager.ApplicationPaths.InternalMetadataPath, "views", id.ToString("N", CultureInfo.InvariantCulture));
  1882. var item = GetItemById(id) as UserView;
  1883. var isNew = false;
  1884. if (item is null)
  1885. {
  1886. Directory.CreateDirectory(path);
  1887. item = new UserView
  1888. {
  1889. Path = path,
  1890. Id = id,
  1891. DateCreated = DateTime.UtcNow,
  1892. Name = name,
  1893. ViewType = viewType,
  1894. ForcedSortName = sortName,
  1895. UserId = user.Id,
  1896. DisplayParentId = parentId
  1897. };
  1898. CreateItem(item, null);
  1899. isNew = true;
  1900. }
  1901. var refresh = isNew || DateTime.UtcNow - item.DateLastRefreshed >= _viewRefreshInterval;
  1902. if (!refresh && !item.DisplayParentId.IsEmpty())
  1903. {
  1904. var displayParent = GetItemById(item.DisplayParentId);
  1905. refresh = displayParent is not null && displayParent.DateLastSaved > item.DateLastRefreshed;
  1906. }
  1907. if (refresh)
  1908. {
  1909. ProviderManager.QueueRefresh(
  1910. item.Id,
  1911. new MetadataRefreshOptions(new DirectoryService(_fileSystem))
  1912. {
  1913. // Need to force save to increment DateLastSaved
  1914. ForceSave = true
  1915. },
  1916. RefreshPriority.Normal);
  1917. }
  1918. return item;
  1919. }
  1920. public UserView GetShadowView(
  1921. BaseItem parent,
  1922. CollectionType? viewType,
  1923. string sortName)
  1924. {
  1925. ArgumentNullException.ThrowIfNull(parent);
  1926. var name = parent.Name;
  1927. var parentId = parent.Id;
  1928. var idValues = "38_namedview_" + name + parentId + (viewType?.ToString() ?? string.Empty);
  1929. var id = GetNewItemId(idValues, typeof(UserView));
  1930. var path = parent.Path;
  1931. var item = GetItemById(id) as UserView;
  1932. var isNew = false;
  1933. if (item is null)
  1934. {
  1935. Directory.CreateDirectory(path);
  1936. item = new UserView
  1937. {
  1938. Path = path,
  1939. Id = id,
  1940. DateCreated = DateTime.UtcNow,
  1941. Name = name,
  1942. ViewType = viewType,
  1943. ForcedSortName = sortName
  1944. };
  1945. item.DisplayParentId = parentId;
  1946. CreateItem(item, null);
  1947. isNew = true;
  1948. }
  1949. var refresh = isNew || DateTime.UtcNow - item.DateLastRefreshed >= _viewRefreshInterval;
  1950. if (!refresh && !item.DisplayParentId.IsEmpty())
  1951. {
  1952. var displayParent = GetItemById(item.DisplayParentId);
  1953. refresh = displayParent is not null && displayParent.DateLastSaved > item.DateLastRefreshed;
  1954. }
  1955. if (refresh)
  1956. {
  1957. ProviderManager.QueueRefresh(
  1958. item.Id,
  1959. new MetadataRefreshOptions(new DirectoryService(_fileSystem))
  1960. {
  1961. // Need to force save to increment DateLastSaved
  1962. ForceSave = true
  1963. },
  1964. RefreshPriority.Normal);
  1965. }
  1966. return item;
  1967. }
  1968. public UserView GetNamedView(
  1969. string name,
  1970. Guid parentId,
  1971. CollectionType? viewType,
  1972. string sortName,
  1973. string uniqueId)
  1974. {
  1975. ArgumentException.ThrowIfNullOrEmpty(name);
  1976. var parentIdString = parentId.IsEmpty()
  1977. ? null
  1978. : parentId.ToString("N", CultureInfo.InvariantCulture);
  1979. var idValues = "37_namedview_" + name + (parentIdString ?? string.Empty) + (viewType?.ToString() ?? string.Empty);
  1980. if (!string.IsNullOrEmpty(uniqueId))
  1981. {
  1982. idValues += uniqueId;
  1983. }
  1984. var id = GetNewItemId(idValues, typeof(UserView));
  1985. var path = Path.Combine(_configurationManager.ApplicationPaths.InternalMetadataPath, "views", id.ToString("N", CultureInfo.InvariantCulture));
  1986. var item = GetItemById(id) as UserView;
  1987. var isNew = false;
  1988. if (item is null)
  1989. {
  1990. Directory.CreateDirectory(path);
  1991. item = new UserView
  1992. {
  1993. Path = path,
  1994. Id = id,
  1995. DateCreated = DateTime.UtcNow,
  1996. Name = name,
  1997. ViewType = viewType,
  1998. ForcedSortName = sortName
  1999. };
  2000. item.DisplayParentId = parentId;
  2001. CreateItem(item, null);
  2002. isNew = true;
  2003. }
  2004. if (viewType != item.ViewType)
  2005. {
  2006. item.ViewType = viewType;
  2007. item.UpdateToRepositoryAsync(ItemUpdateType.MetadataEdit, CancellationToken.None).GetAwaiter().GetResult();
  2008. }
  2009. var refresh = isNew || DateTime.UtcNow - item.DateLastRefreshed >= _viewRefreshInterval;
  2010. if (!refresh && !item.DisplayParentId.IsEmpty())
  2011. {
  2012. var displayParent = GetItemById(item.DisplayParentId);
  2013. refresh = displayParent is not null && displayParent.DateLastSaved > item.DateLastRefreshed;
  2014. }
  2015. if (refresh)
  2016. {
  2017. ProviderManager.QueueRefresh(
  2018. item.Id,
  2019. new MetadataRefreshOptions(new DirectoryService(_fileSystem))
  2020. {
  2021. // Need to force save to increment DateLastSaved
  2022. ForceSave = true
  2023. },
  2024. RefreshPriority.Normal);
  2025. }
  2026. return item;
  2027. }
  2028. public BaseItem GetParentItem(Guid? parentId, Guid? userId)
  2029. {
  2030. if (parentId.HasValue)
  2031. {
  2032. return GetItemById(parentId.Value);
  2033. }
  2034. if (!userId.IsNullOrEmpty())
  2035. {
  2036. return GetUserRootFolder();
  2037. }
  2038. return RootFolder;
  2039. }
  2040. /// <inheritdoc />
  2041. public void QueueLibraryScan()
  2042. {
  2043. _taskManager.QueueScheduledTask<RefreshMediaLibraryTask>();
  2044. }
  2045. /// <inheritdoc />
  2046. public int? GetSeasonNumberFromPath(string path)
  2047. => SeasonPathParser.Parse(path, true, true).SeasonNumber;
  2048. /// <inheritdoc />
  2049. public bool FillMissingEpisodeNumbersFromPath(Episode episode, bool forceRefresh)
  2050. {
  2051. var series = episode.Series;
  2052. bool? isAbsoluteNaming = series is not null && string.Equals(series.DisplayOrder, "absolute", StringComparison.OrdinalIgnoreCase);
  2053. if (!isAbsoluteNaming.Value)
  2054. {
  2055. // In other words, no filter applied
  2056. isAbsoluteNaming = null;
  2057. }
  2058. var resolver = new EpisodeResolver(_namingOptions);
  2059. var isFolder = episode.VideoType == VideoType.BluRay || episode.VideoType == VideoType.Dvd;
  2060. // TODO nullable - what are we trying to do there with empty episodeInfo?
  2061. EpisodeInfo episodeInfo = null;
  2062. if (episode.IsFileProtocol)
  2063. {
  2064. episodeInfo = resolver.Resolve(episode.Path, isFolder, null, null, isAbsoluteNaming);
  2065. // Resolve from parent folder if it's not the Season folder
  2066. var parent = episode.GetParent();
  2067. if (episodeInfo is null && parent.GetType() == typeof(Folder))
  2068. {
  2069. episodeInfo = resolver.Resolve(parent.Path, true, null, null, isAbsoluteNaming);
  2070. if (episodeInfo is not null)
  2071. {
  2072. // add the container
  2073. episodeInfo.Container = Path.GetExtension(episode.Path)?.TrimStart('.');
  2074. }
  2075. }
  2076. }
  2077. episodeInfo ??= new EpisodeInfo(episode.Path);
  2078. try
  2079. {
  2080. var libraryOptions = GetLibraryOptions(episode);
  2081. if (libraryOptions.EnableEmbeddedEpisodeInfos && string.Equals(episodeInfo.Container, "mp4", StringComparison.OrdinalIgnoreCase))
  2082. {
  2083. // Read from metadata
  2084. var mediaInfo = _mediaEncoder.GetMediaInfo(
  2085. new MediaInfoRequest
  2086. {
  2087. MediaSource = episode.GetMediaSources(false)[0],
  2088. MediaType = DlnaProfileType.Video
  2089. },
  2090. CancellationToken.None).GetAwaiter().GetResult();
  2091. if (mediaInfo.ParentIndexNumber > 0)
  2092. {
  2093. episodeInfo.SeasonNumber = mediaInfo.ParentIndexNumber;
  2094. }
  2095. if (mediaInfo.IndexNumber > 0)
  2096. {
  2097. episodeInfo.EpisodeNumber = mediaInfo.IndexNumber;
  2098. }
  2099. if (!string.IsNullOrEmpty(mediaInfo.ShowName))
  2100. {
  2101. episodeInfo.SeriesName = mediaInfo.ShowName;
  2102. }
  2103. }
  2104. }
  2105. catch (Exception ex)
  2106. {
  2107. _logger.LogError(ex, "Error reading the episode information with ffprobe. Episode: {EpisodeInfo}", episodeInfo.Path);
  2108. }
  2109. var changed = false;
  2110. if (episodeInfo.IsByDate)
  2111. {
  2112. if (episode.IndexNumber.HasValue)
  2113. {
  2114. episode.IndexNumber = null;
  2115. changed = true;
  2116. }
  2117. if (episode.IndexNumberEnd.HasValue)
  2118. {
  2119. episode.IndexNumberEnd = null;
  2120. changed = true;
  2121. }
  2122. if (!episode.PremiereDate.HasValue)
  2123. {
  2124. if (episodeInfo.Year.HasValue && episodeInfo.Month.HasValue && episodeInfo.Day.HasValue)
  2125. {
  2126. episode.PremiereDate = new DateTime(episodeInfo.Year.Value, episodeInfo.Month.Value, episodeInfo.Day.Value).ToUniversalTime();
  2127. }
  2128. if (episode.PremiereDate.HasValue)
  2129. {
  2130. changed = true;
  2131. }
  2132. }
  2133. if (!episode.ProductionYear.HasValue)
  2134. {
  2135. episode.ProductionYear = episodeInfo.Year;
  2136. if (episode.ProductionYear.HasValue)
  2137. {
  2138. changed = true;
  2139. }
  2140. }
  2141. }
  2142. else
  2143. {
  2144. if (!episode.IndexNumber.HasValue || forceRefresh)
  2145. {
  2146. if (episode.IndexNumber != episodeInfo.EpisodeNumber)
  2147. {
  2148. changed = true;
  2149. }
  2150. episode.IndexNumber = episodeInfo.EpisodeNumber;
  2151. }
  2152. if (!episode.IndexNumberEnd.HasValue || forceRefresh)
  2153. {
  2154. if (episode.IndexNumberEnd != episodeInfo.EndingEpisodeNumber)
  2155. {
  2156. changed = true;
  2157. }
  2158. episode.IndexNumberEnd = episodeInfo.EndingEpisodeNumber;
  2159. }
  2160. if (!episode.ParentIndexNumber.HasValue || forceRefresh)
  2161. {
  2162. if (episode.ParentIndexNumber != episodeInfo.SeasonNumber)
  2163. {
  2164. changed = true;
  2165. }
  2166. episode.ParentIndexNumber = episodeInfo.SeasonNumber;
  2167. }
  2168. }
  2169. if (!episode.ParentIndexNumber.HasValue)
  2170. {
  2171. var season = episode.Season;
  2172. if (season is not null)
  2173. {
  2174. episode.ParentIndexNumber = season.IndexNumber;
  2175. }
  2176. else
  2177. {
  2178. /*
  2179. Anime series don't generally have a season in their file name, however,
  2180. TVDb needs a season to correctly get the metadata.
  2181. Hence, a null season needs to be filled with something. */
  2182. // FIXME perhaps this would be better for TVDb parser to ask for season 1 if no season is specified
  2183. episode.ParentIndexNumber = 1;
  2184. }
  2185. if (episode.ParentIndexNumber.HasValue)
  2186. {
  2187. changed = true;
  2188. }
  2189. }
  2190. return changed;
  2191. }
  2192. public ItemLookupInfo ParseName(string name)
  2193. {
  2194. var namingOptions = _namingOptions;
  2195. var result = VideoResolver.CleanDateTime(name, namingOptions);
  2196. return new ItemLookupInfo
  2197. {
  2198. Name = VideoResolver.TryCleanString(result.Name, namingOptions, out var newName) ? newName : result.Name,
  2199. Year = result.Year
  2200. };
  2201. }
  2202. public IEnumerable<BaseItem> FindExtras(BaseItem owner, IReadOnlyList<FileSystemMetadata> fileSystemChildren, IDirectoryService directoryService)
  2203. {
  2204. var ownerVideoInfo = VideoResolver.Resolve(owner.Path, owner.IsFolder, _namingOptions);
  2205. if (ownerVideoInfo is null)
  2206. {
  2207. yield break;
  2208. }
  2209. var count = fileSystemChildren.Count;
  2210. for (var i = 0; i < count; i++)
  2211. {
  2212. var current = fileSystemChildren[i];
  2213. if (current.IsDirectory && _namingOptions.AllExtrasTypesFolderNames.ContainsKey(current.Name))
  2214. {
  2215. var filesInSubFolder = _fileSystem.GetFiles(current.FullName, null, false, false);
  2216. foreach (var file in filesInSubFolder)
  2217. {
  2218. if (!_extraResolver.TryGetExtraTypeForOwner(file.FullName, ownerVideoInfo, out var extraType))
  2219. {
  2220. continue;
  2221. }
  2222. var extra = GetExtra(file, extraType.Value);
  2223. if (extra is not null)
  2224. {
  2225. yield return extra;
  2226. }
  2227. }
  2228. }
  2229. else if (!current.IsDirectory && _extraResolver.TryGetExtraTypeForOwner(current.FullName, ownerVideoInfo, out var extraType))
  2230. {
  2231. var extra = GetExtra(current, extraType.Value);
  2232. if (extra is not null)
  2233. {
  2234. yield return extra;
  2235. }
  2236. }
  2237. }
  2238. BaseItem GetExtra(FileSystemMetadata file, ExtraType extraType)
  2239. {
  2240. var extra = ResolvePath(_fileSystem.GetFileInfo(file.FullName), directoryService, _extraResolver.GetResolversForExtraType(extraType));
  2241. if (extra is not Video && extra is not Audio)
  2242. {
  2243. return null;
  2244. }
  2245. // Try to retrieve it from the db. If we don't find it, use the resolved version
  2246. var itemById = GetItemById(extra.Id);
  2247. if (itemById is not null)
  2248. {
  2249. extra = itemById;
  2250. }
  2251. extra.ExtraType = extraType;
  2252. extra.ParentId = Guid.Empty;
  2253. extra.OwnerId = owner.Id;
  2254. return extra;
  2255. }
  2256. }
  2257. public string GetPathAfterNetworkSubstitution(string path, BaseItem ownerItem)
  2258. {
  2259. string newPath;
  2260. if (ownerItem is not null)
  2261. {
  2262. var libraryOptions = GetLibraryOptions(ownerItem);
  2263. if (libraryOptions is not null)
  2264. {
  2265. foreach (var pathInfo in libraryOptions.PathInfos)
  2266. {
  2267. if (path.TryReplaceSubPath(pathInfo.Path, pathInfo.NetworkPath, out newPath))
  2268. {
  2269. return newPath;
  2270. }
  2271. }
  2272. }
  2273. }
  2274. var metadataPath = _configurationManager.Configuration.MetadataPath;
  2275. var metadataNetworkPath = _configurationManager.Configuration.MetadataNetworkPath;
  2276. if (path.TryReplaceSubPath(metadataPath, metadataNetworkPath, out newPath))
  2277. {
  2278. return newPath;
  2279. }
  2280. foreach (var map in _configurationManager.Configuration.PathSubstitutions)
  2281. {
  2282. if (path.TryReplaceSubPath(map.From, map.To, out newPath))
  2283. {
  2284. return newPath;
  2285. }
  2286. }
  2287. return path;
  2288. }
  2289. public List<PersonInfo> GetPeople(InternalPeopleQuery query)
  2290. {
  2291. return _itemRepository.GetPeople(query);
  2292. }
  2293. public List<PersonInfo> GetPeople(BaseItem item)
  2294. {
  2295. if (item.SupportsPeople)
  2296. {
  2297. var people = GetPeople(new InternalPeopleQuery
  2298. {
  2299. ItemId = item.Id
  2300. });
  2301. if (people.Count > 0)
  2302. {
  2303. return people;
  2304. }
  2305. }
  2306. return new List<PersonInfo>();
  2307. }
  2308. public List<Person> GetPeopleItems(InternalPeopleQuery query)
  2309. {
  2310. return _itemRepository.GetPeopleNames(query)
  2311. .Select(i =>
  2312. {
  2313. try
  2314. {
  2315. return GetPerson(i);
  2316. }
  2317. catch (Exception ex)
  2318. {
  2319. _logger.LogError(ex, "Error getting person");
  2320. return null;
  2321. }
  2322. })
  2323. .Where(i => i is not null)
  2324. .Where(i => query.User is null || i.IsVisible(query.User))
  2325. .ToList();
  2326. }
  2327. public List<string> GetPeopleNames(InternalPeopleQuery query)
  2328. {
  2329. return _itemRepository.GetPeopleNames(query);
  2330. }
  2331. public void UpdatePeople(BaseItem item, List<PersonInfo> people)
  2332. {
  2333. UpdatePeopleAsync(item, people, CancellationToken.None).GetAwaiter().GetResult();
  2334. }
  2335. /// <inheritdoc />
  2336. public async Task UpdatePeopleAsync(BaseItem item, List<PersonInfo> people, CancellationToken cancellationToken)
  2337. {
  2338. if (!item.SupportsPeople)
  2339. {
  2340. return;
  2341. }
  2342. _itemRepository.UpdatePeople(item.Id, people);
  2343. await SavePeopleMetadataAsync(people, cancellationToken).ConfigureAwait(false);
  2344. }
  2345. public async Task<ItemImageInfo> ConvertImageToLocal(BaseItem item, ItemImageInfo image, int imageIndex)
  2346. {
  2347. foreach (var url in image.Path.Split('|'))
  2348. {
  2349. try
  2350. {
  2351. _logger.LogDebug("ConvertImageToLocal item {0} - image url: {1}", item.Id, url);
  2352. await ProviderManager.SaveImage(item, url, image.Type, imageIndex, CancellationToken.None).ConfigureAwait(false);
  2353. await item.UpdateToRepositoryAsync(ItemUpdateType.ImageUpdate, CancellationToken.None).ConfigureAwait(false);
  2354. return item.GetImageInfo(image.Type, imageIndex);
  2355. }
  2356. catch (HttpRequestException ex)
  2357. {
  2358. if (ex.StatusCode.HasValue
  2359. && (ex.StatusCode.Value == HttpStatusCode.NotFound || ex.StatusCode.Value == HttpStatusCode.Forbidden))
  2360. {
  2361. continue;
  2362. }
  2363. throw;
  2364. }
  2365. }
  2366. // Remove this image to prevent it from retrying over and over
  2367. item.RemoveImage(image);
  2368. await item.UpdateToRepositoryAsync(ItemUpdateType.ImageUpdate, CancellationToken.None).ConfigureAwait(false);
  2369. throw new InvalidOperationException();
  2370. }
  2371. public async Task AddVirtualFolder(string name, CollectionTypeOptions? collectionType, LibraryOptions options, bool refreshLibrary)
  2372. {
  2373. if (string.IsNullOrWhiteSpace(name))
  2374. {
  2375. throw new ArgumentNullException(nameof(name));
  2376. }
  2377. name = _fileSystem.GetValidFilename(name);
  2378. var rootFolderPath = _configurationManager.ApplicationPaths.DefaultUserViewsPath;
  2379. var existingNameCount = 1; // first numbered name will be 2
  2380. var virtualFolderPath = Path.Combine(rootFolderPath, name);
  2381. var originalName = name;
  2382. while (Directory.Exists(virtualFolderPath))
  2383. {
  2384. existingNameCount++;
  2385. name = originalName + existingNameCount;
  2386. virtualFolderPath = Path.Combine(rootFolderPath, name);
  2387. }
  2388. var mediaPathInfos = options.PathInfos;
  2389. if (mediaPathInfos is not null)
  2390. {
  2391. var invalidpath = mediaPathInfos.FirstOrDefault(i => !Directory.Exists(i.Path));
  2392. if (invalidpath is not null)
  2393. {
  2394. throw new ArgumentException("The specified path does not exist: " + invalidpath.Path + ".");
  2395. }
  2396. }
  2397. LibraryMonitor.Stop();
  2398. try
  2399. {
  2400. Directory.CreateDirectory(virtualFolderPath);
  2401. if (collectionType is not null)
  2402. {
  2403. var path = Path.Combine(virtualFolderPath, collectionType.ToString().ToLowerInvariant() + ".collection");
  2404. await File.WriteAllBytesAsync(path, Array.Empty<byte>()).ConfigureAwait(false);
  2405. }
  2406. CollectionFolder.SaveLibraryOptions(virtualFolderPath, options);
  2407. if (mediaPathInfos is not null)
  2408. {
  2409. foreach (var path in mediaPathInfos)
  2410. {
  2411. AddMediaPathInternal(name, path, false);
  2412. }
  2413. }
  2414. }
  2415. finally
  2416. {
  2417. if (refreshLibrary)
  2418. {
  2419. await ValidateTopLibraryFolders(CancellationToken.None).ConfigureAwait(false);
  2420. StartScanInBackground();
  2421. }
  2422. else
  2423. {
  2424. // Need to add a delay here or directory watchers may still pick up the changes
  2425. await Task.Delay(1000).ConfigureAwait(false);
  2426. LibraryMonitor.Start();
  2427. }
  2428. }
  2429. }
  2430. private async Task SavePeopleMetadataAsync(IEnumerable<PersonInfo> people, CancellationToken cancellationToken)
  2431. {
  2432. List<BaseItem> personsToSave = null;
  2433. foreach (var person in people)
  2434. {
  2435. cancellationToken.ThrowIfCancellationRequested();
  2436. var itemUpdateType = ItemUpdateType.MetadataDownload;
  2437. var saveEntity = false;
  2438. var personEntity = GetPerson(person.Name);
  2439. if (personEntity is null)
  2440. {
  2441. var path = Person.GetPath(person.Name);
  2442. personEntity = new Person()
  2443. {
  2444. Name = person.Name,
  2445. Id = GetItemByNameId<Person>(path),
  2446. DateCreated = DateTime.UtcNow,
  2447. DateModified = DateTime.UtcNow,
  2448. Path = path
  2449. };
  2450. personEntity.PresentationUniqueKey = personEntity.CreatePresentationUniqueKey();
  2451. saveEntity = true;
  2452. }
  2453. foreach (var id in person.ProviderIds)
  2454. {
  2455. if (!string.Equals(personEntity.GetProviderId(id.Key), id.Value, StringComparison.OrdinalIgnoreCase))
  2456. {
  2457. personEntity.SetProviderId(id.Key, id.Value);
  2458. saveEntity = true;
  2459. }
  2460. }
  2461. if (!string.IsNullOrWhiteSpace(person.ImageUrl) && !personEntity.HasImage(ImageType.Primary))
  2462. {
  2463. personEntity.SetImage(
  2464. new ItemImageInfo
  2465. {
  2466. Path = person.ImageUrl,
  2467. Type = ImageType.Primary
  2468. },
  2469. 0);
  2470. saveEntity = true;
  2471. itemUpdateType = ItemUpdateType.ImageUpdate;
  2472. }
  2473. if (saveEntity)
  2474. {
  2475. (personsToSave ??= new()).Add(personEntity);
  2476. await RunMetadataSavers(personEntity, itemUpdateType).ConfigureAwait(false);
  2477. }
  2478. }
  2479. if (personsToSave is not null)
  2480. {
  2481. CreateItems(personsToSave, null, CancellationToken.None);
  2482. }
  2483. }
  2484. private void StartScanInBackground()
  2485. {
  2486. Task.Run(() =>
  2487. {
  2488. // No need to start if scanning the library because it will handle it
  2489. ValidateMediaLibrary(new Progress<double>(), CancellationToken.None);
  2490. });
  2491. }
  2492. public void AddMediaPath(string virtualFolderName, MediaPathInfo mediaPath)
  2493. {
  2494. AddMediaPathInternal(virtualFolderName, mediaPath, true);
  2495. }
  2496. private void AddMediaPathInternal(string virtualFolderName, MediaPathInfo pathInfo, bool saveLibraryOptions)
  2497. {
  2498. ArgumentNullException.ThrowIfNull(pathInfo);
  2499. var path = pathInfo.Path;
  2500. if (string.IsNullOrWhiteSpace(path))
  2501. {
  2502. throw new ArgumentException(nameof(path));
  2503. }
  2504. if (!Directory.Exists(path))
  2505. {
  2506. throw new FileNotFoundException("The path does not exist.");
  2507. }
  2508. var rootFolderPath = _configurationManager.ApplicationPaths.DefaultUserViewsPath;
  2509. var virtualFolderPath = Path.Combine(rootFolderPath, virtualFolderName);
  2510. var shortcutFilename = Path.GetFileNameWithoutExtension(path);
  2511. var lnk = Path.Combine(virtualFolderPath, shortcutFilename + ShortcutFileExtension);
  2512. while (File.Exists(lnk))
  2513. {
  2514. shortcutFilename += "1";
  2515. lnk = Path.Combine(virtualFolderPath, shortcutFilename + ShortcutFileExtension);
  2516. }
  2517. _fileSystem.CreateShortcut(lnk, _appHost.ReverseVirtualPath(path));
  2518. RemoveContentTypeOverrides(path);
  2519. if (saveLibraryOptions)
  2520. {
  2521. var libraryOptions = CollectionFolder.GetLibraryOptions(virtualFolderPath);
  2522. var list = libraryOptions.PathInfos.ToList();
  2523. list.Add(pathInfo);
  2524. libraryOptions.PathInfos = list.ToArray();
  2525. SyncLibraryOptionsToLocations(virtualFolderPath, libraryOptions);
  2526. CollectionFolder.SaveLibraryOptions(virtualFolderPath, libraryOptions);
  2527. }
  2528. }
  2529. public void UpdateMediaPath(string virtualFolderName, MediaPathInfo mediaPath)
  2530. {
  2531. ArgumentNullException.ThrowIfNull(mediaPath);
  2532. var rootFolderPath = _configurationManager.ApplicationPaths.DefaultUserViewsPath;
  2533. var virtualFolderPath = Path.Combine(rootFolderPath, virtualFolderName);
  2534. var libraryOptions = CollectionFolder.GetLibraryOptions(virtualFolderPath);
  2535. SyncLibraryOptionsToLocations(virtualFolderPath, libraryOptions);
  2536. var list = libraryOptions.PathInfos.ToList();
  2537. foreach (var originalPathInfo in list)
  2538. {
  2539. if (string.Equals(mediaPath.Path, originalPathInfo.Path, StringComparison.Ordinal))
  2540. {
  2541. originalPathInfo.NetworkPath = mediaPath.NetworkPath;
  2542. break;
  2543. }
  2544. }
  2545. libraryOptions.PathInfos = list.ToArray();
  2546. CollectionFolder.SaveLibraryOptions(virtualFolderPath, libraryOptions);
  2547. }
  2548. private void SyncLibraryOptionsToLocations(string virtualFolderPath, LibraryOptions options)
  2549. {
  2550. var topLibraryFolders = GetUserRootFolder().Children.ToList();
  2551. var info = GetVirtualFolderInfo(virtualFolderPath, topLibraryFolders, null);
  2552. if (info.Locations.Length > 0 && info.Locations.Length != options.PathInfos.Length)
  2553. {
  2554. var list = options.PathInfos.ToList();
  2555. foreach (var location in info.Locations)
  2556. {
  2557. if (!list.Any(i => string.Equals(i.Path, location, StringComparison.Ordinal)))
  2558. {
  2559. list.Add(new MediaPathInfo(location));
  2560. }
  2561. }
  2562. options.PathInfos = list.ToArray();
  2563. }
  2564. }
  2565. public async Task RemoveVirtualFolder(string name, bool refreshLibrary)
  2566. {
  2567. if (string.IsNullOrWhiteSpace(name))
  2568. {
  2569. throw new ArgumentNullException(nameof(name));
  2570. }
  2571. var rootFolderPath = _configurationManager.ApplicationPaths.DefaultUserViewsPath;
  2572. var path = Path.Combine(rootFolderPath, name);
  2573. if (!Directory.Exists(path))
  2574. {
  2575. throw new FileNotFoundException("The media folder does not exist");
  2576. }
  2577. LibraryMonitor.Stop();
  2578. try
  2579. {
  2580. Directory.Delete(path, true);
  2581. }
  2582. finally
  2583. {
  2584. CollectionFolder.OnCollectionFolderChange();
  2585. if (refreshLibrary)
  2586. {
  2587. await ValidateTopLibraryFolders(CancellationToken.None).ConfigureAwait(false);
  2588. StartScanInBackground();
  2589. }
  2590. else
  2591. {
  2592. // Need to add a delay here or directory watchers may still pick up the changes
  2593. await Task.Delay(1000).ConfigureAwait(false);
  2594. LibraryMonitor.Start();
  2595. }
  2596. }
  2597. }
  2598. private void RemoveContentTypeOverrides(string path)
  2599. {
  2600. if (string.IsNullOrWhiteSpace(path))
  2601. {
  2602. throw new ArgumentNullException(nameof(path));
  2603. }
  2604. List<NameValuePair> removeList = null;
  2605. foreach (var contentType in _configurationManager.Configuration.ContentTypes)
  2606. {
  2607. if (string.IsNullOrWhiteSpace(contentType.Name)
  2608. || _fileSystem.AreEqual(path, contentType.Name)
  2609. || _fileSystem.ContainsSubPath(path, contentType.Name))
  2610. {
  2611. (removeList ??= new()).Add(contentType);
  2612. }
  2613. }
  2614. if (removeList is not null)
  2615. {
  2616. _configurationManager.Configuration.ContentTypes = _configurationManager.Configuration.ContentTypes
  2617. .Except(removeList)
  2618. .ToArray();
  2619. _configurationManager.SaveConfiguration();
  2620. }
  2621. }
  2622. public void RemoveMediaPath(string virtualFolderName, string mediaPath)
  2623. {
  2624. ArgumentException.ThrowIfNullOrEmpty(mediaPath);
  2625. var rootFolderPath = _configurationManager.ApplicationPaths.DefaultUserViewsPath;
  2626. var virtualFolderPath = Path.Combine(rootFolderPath, virtualFolderName);
  2627. if (!Directory.Exists(virtualFolderPath))
  2628. {
  2629. throw new FileNotFoundException(
  2630. string.Format(CultureInfo.InvariantCulture, "The media collection {0} does not exist", virtualFolderName));
  2631. }
  2632. var shortcut = _fileSystem.GetFilePaths(virtualFolderPath, true)
  2633. .Where(i => Path.GetExtension(i.AsSpan()).Equals(ShortcutFileExtension, StringComparison.OrdinalIgnoreCase))
  2634. .FirstOrDefault(f => _appHost.ExpandVirtualPath(_fileSystem.ResolveShortcut(f)).Equals(mediaPath, StringComparison.OrdinalIgnoreCase));
  2635. if (!string.IsNullOrEmpty(shortcut))
  2636. {
  2637. _fileSystem.DeleteFile(shortcut);
  2638. }
  2639. var libraryOptions = CollectionFolder.GetLibraryOptions(virtualFolderPath);
  2640. libraryOptions.PathInfos = libraryOptions
  2641. .PathInfos
  2642. .Where(i => !string.Equals(i.Path, mediaPath, StringComparison.Ordinal))
  2643. .ToArray();
  2644. CollectionFolder.SaveLibraryOptions(virtualFolderPath, libraryOptions);
  2645. }
  2646. }
  2647. }