LibraryManager.cs 113 KB

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