LibraryManager.cs 112 KB

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