LibraryManager.cs 110 KB

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