LibraryManager.cs 113 KB

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