LibraryManager.cs 112 KB

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