LibraryManager.cs 111 KB

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