LibraryManager.cs 113 KB

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