LibraryManager.cs 116 KB

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