LibraryManager.cs 111 KB

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