LibraryManager.cs 111 KB

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