LibraryManager.cs 111 KB

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