LibraryManager.cs 110 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148
  1. #nullable disable
  2. #pragma warning disable CS1591
  3. using System;
  4. using System.Collections.Generic;
  5. using System.Globalization;
  6. using System.IO;
  7. using System.Linq;
  8. using System.Net;
  9. using System.Net.Http;
  10. using System.Threading;
  11. using System.Threading.Tasks;
  12. using Emby.Naming.Common;
  13. using Emby.Naming.TV;
  14. using Emby.Server.Implementations.Library.Resolvers;
  15. using Emby.Server.Implementations.Library.Validators;
  16. using Emby.Server.Implementations.Playlists;
  17. using Emby.Server.Implementations.ScheduledTasks.Tasks;
  18. using Jellyfin.Data.Entities;
  19. using Jellyfin.Data.Enums;
  20. using Jellyfin.Extensions;
  21. using MediaBrowser.Common.Extensions;
  22. using MediaBrowser.Common.Progress;
  23. using MediaBrowser.Controller;
  24. using MediaBrowser.Controller.Configuration;
  25. using MediaBrowser.Controller.Drawing;
  26. using MediaBrowser.Controller.Dto;
  27. using MediaBrowser.Controller.Entities;
  28. using MediaBrowser.Controller.Entities.Audio;
  29. using MediaBrowser.Controller.IO;
  30. using MediaBrowser.Controller.Library;
  31. using MediaBrowser.Controller.LiveTv;
  32. using MediaBrowser.Controller.MediaEncoding;
  33. using MediaBrowser.Controller.Persistence;
  34. using MediaBrowser.Controller.Providers;
  35. using MediaBrowser.Controller.Resolvers;
  36. using MediaBrowser.Controller.Sorting;
  37. using MediaBrowser.Model.Configuration;
  38. using MediaBrowser.Model.Dlna;
  39. using MediaBrowser.Model.Drawing;
  40. using MediaBrowser.Model.Dto;
  41. using MediaBrowser.Model.Entities;
  42. using MediaBrowser.Model.IO;
  43. using MediaBrowser.Model.Library;
  44. using MediaBrowser.Model.Querying;
  45. using MediaBrowser.Model.Tasks;
  46. using Microsoft.Extensions.Caching.Memory;
  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 IMemoryCache _memoryCache;
  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="memoryCache">The memory cache.</param>
  106. /// <param name="namingOptions">The naming options.</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. IMemoryCache memoryCache,
  122. NamingOptions namingOptions)
  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. _memoryCache = memoryCache;
  138. _namingOptions = namingOptions;
  139. _extraResolver = new ExtraResolver(loggerFactory.CreateLogger<ExtraResolver>(), namingOptions);
  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. _memoryCache.Set(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).ToList()
  315. : new List<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. _memoryCache.Remove(item.Id);
  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, directoryService)
  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 => _fileSystem.NormalizePath(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 not Person item)
  718. {
  719. item = new Person
  720. {
  721. Name = name,
  722. Id = id,
  723. DateCreated = DateTime.UtcNow,
  724. DateModified = DateTime.UtcNow,
  725. Path = path
  726. };
  727. }
  728. return item;
  729. }
  730. /// <summary>
  731. /// Gets the studio.
  732. /// </summary>
  733. /// <param name="name">The name.</param>
  734. /// <returns>Task{Studio}.</returns>
  735. public Studio GetStudio(string name)
  736. {
  737. return CreateItemByName<Studio>(Studio.GetPath, name, new DtoOptions(true));
  738. }
  739. public Guid GetStudioId(string name)
  740. {
  741. return GetItemByNameId<Studio>(Studio.GetPath(name));
  742. }
  743. public Guid GetGenreId(string name)
  744. {
  745. return GetItemByNameId<Genre>(Genre.GetPath(name));
  746. }
  747. public Guid GetMusicGenreId(string name)
  748. {
  749. return GetItemByNameId<MusicGenre>(MusicGenre.GetPath(name));
  750. }
  751. /// <summary>
  752. /// Gets the genre.
  753. /// </summary>
  754. /// <param name="name">The name.</param>
  755. /// <returns>Task{Genre}.</returns>
  756. public Genre GetGenre(string name)
  757. {
  758. return CreateItemByName<Genre>(Genre.GetPath, name, new DtoOptions(true));
  759. }
  760. /// <summary>
  761. /// Gets the music genre.
  762. /// </summary>
  763. /// <param name="name">The name.</param>
  764. /// <returns>Task{MusicGenre}.</returns>
  765. public MusicGenre GetMusicGenre(string name)
  766. {
  767. return CreateItemByName<MusicGenre>(MusicGenre.GetPath, name, new DtoOptions(true));
  768. }
  769. /// <summary>
  770. /// Gets the year.
  771. /// </summary>
  772. /// <param name="value">The value.</param>
  773. /// <returns>Task{Year}.</returns>
  774. public Year GetYear(int value)
  775. {
  776. if (value <= 0)
  777. {
  778. throw new ArgumentOutOfRangeException(nameof(value), "Years less than or equal to 0 are invalid.");
  779. }
  780. var name = value.ToString(CultureInfo.InvariantCulture);
  781. return CreateItemByName<Year>(Year.GetPath, name, new DtoOptions(true));
  782. }
  783. /// <summary>
  784. /// Gets a Genre.
  785. /// </summary>
  786. /// <param name="name">The name.</param>
  787. /// <returns>Task{Genre}.</returns>
  788. public MusicArtist GetArtist(string name)
  789. {
  790. return GetArtist(name, new DtoOptions(true));
  791. }
  792. public MusicArtist GetArtist(string name, DtoOptions options)
  793. {
  794. return CreateItemByName<MusicArtist>(MusicArtist.GetPath, name, options);
  795. }
  796. private T CreateItemByName<T>(Func<string, string> getPathFn, string name, DtoOptions options)
  797. where T : BaseItem, new()
  798. {
  799. if (typeof(T) == typeof(MusicArtist))
  800. {
  801. var existing = GetItemList(new InternalItemsQuery
  802. {
  803. IncludeItemTypes = new[] { BaseItemKind.MusicArtist },
  804. Name = name,
  805. DtoOptions = options
  806. }).Cast<MusicArtist>()
  807. .OrderBy(i => i.IsAccessedByName ? 1 : 0)
  808. .Cast<T>()
  809. .FirstOrDefault();
  810. if (existing is not null)
  811. {
  812. return existing;
  813. }
  814. }
  815. var path = getPathFn(name);
  816. var id = GetItemByNameId<T>(path);
  817. var item = GetItemById(id) as T;
  818. if (item is null)
  819. {
  820. item = new T
  821. {
  822. Name = name,
  823. Id = id,
  824. DateCreated = DateTime.UtcNow,
  825. DateModified = DateTime.UtcNow,
  826. Path = path
  827. };
  828. CreateItem(item, null);
  829. }
  830. return item;
  831. }
  832. private Guid GetItemByNameId<T>(string path)
  833. where T : BaseItem, new()
  834. {
  835. var forceCaseInsensitiveId = _configurationManager.Configuration.EnableNormalizedItemByNameIds;
  836. return GetNewItemIdInternal(path, typeof(T), forceCaseInsensitiveId);
  837. }
  838. /// <inheritdoc />
  839. public Task ValidatePeopleAsync(IProgress<double> progress, CancellationToken cancellationToken)
  840. {
  841. // Ensure the location is available.
  842. Directory.CreateDirectory(_configurationManager.ApplicationPaths.PeoplePath);
  843. return new PeopleValidator(this, _logger, _fileSystem).ValidatePeople(cancellationToken, progress);
  844. }
  845. /// <summary>
  846. /// Reloads the root media folder.
  847. /// </summary>
  848. /// <param name="progress">The progress.</param>
  849. /// <param name="cancellationToken">The cancellation token.</param>
  850. /// <returns>Task.</returns>
  851. public Task ValidateMediaLibrary(IProgress<double> progress, CancellationToken cancellationToken)
  852. {
  853. // Just run the scheduled task so that the user can see it
  854. _taskManager.CancelIfRunningAndQueue<RefreshMediaLibraryTask>();
  855. return Task.CompletedTask;
  856. }
  857. /// <summary>
  858. /// Validates the media library internal.
  859. /// </summary>
  860. /// <param name="progress">The progress.</param>
  861. /// <param name="cancellationToken">The cancellation token.</param>
  862. /// <returns>Task.</returns>
  863. public async Task ValidateMediaLibraryInternal(IProgress<double> progress, CancellationToken cancellationToken)
  864. {
  865. IsScanRunning = true;
  866. LibraryMonitor.Stop();
  867. try
  868. {
  869. await PerformLibraryValidation(progress, cancellationToken).ConfigureAwait(false);
  870. }
  871. finally
  872. {
  873. LibraryMonitor.Start();
  874. IsScanRunning = false;
  875. }
  876. }
  877. private async Task ValidateTopLibraryFolders(CancellationToken cancellationToken)
  878. {
  879. await RootFolder.RefreshMetadata(cancellationToken).ConfigureAwait(false);
  880. // Start by just validating the children of the root, but go no further
  881. await RootFolder.ValidateChildren(
  882. new SimpleProgress<double>(),
  883. new MetadataRefreshOptions(new DirectoryService(_fileSystem)),
  884. recursive: false,
  885. cancellationToken).ConfigureAwait(false);
  886. await GetUserRootFolder().RefreshMetadata(cancellationToken).ConfigureAwait(false);
  887. await GetUserRootFolder().ValidateChildren(
  888. new SimpleProgress<double>(),
  889. new MetadataRefreshOptions(new DirectoryService(_fileSystem)),
  890. recursive: false,
  891. cancellationToken).ConfigureAwait(false);
  892. // Quickly scan CollectionFolders for changes
  893. foreach (var folder in GetUserRootFolder().Children.OfType<Folder>())
  894. {
  895. await folder.RefreshMetadata(cancellationToken).ConfigureAwait(false);
  896. }
  897. }
  898. private async Task PerformLibraryValidation(IProgress<double> progress, CancellationToken cancellationToken)
  899. {
  900. _logger.LogInformation("Validating media library");
  901. await ValidateTopLibraryFolders(cancellationToken).ConfigureAwait(false);
  902. var innerProgress = new ActionableProgress<double>();
  903. innerProgress.RegisterAction(pct => progress.Report(pct * 0.96));
  904. // Validate the entire media library
  905. await RootFolder.ValidateChildren(innerProgress, new MetadataRefreshOptions(new DirectoryService(_fileSystem)), recursive: true, cancellationToken).ConfigureAwait(false);
  906. progress.Report(96);
  907. innerProgress = new ActionableProgress<double>();
  908. innerProgress.RegisterAction(pct => progress.Report(96 + (pct * .04)));
  909. await RunPostScanTasks(innerProgress, cancellationToken).ConfigureAwait(false);
  910. progress.Report(100);
  911. }
  912. /// <summary>
  913. /// Runs the post scan tasks.
  914. /// </summary>
  915. /// <param name="progress">The progress.</param>
  916. /// <param name="cancellationToken">The cancellation token.</param>
  917. /// <returns>Task.</returns>
  918. private async Task RunPostScanTasks(IProgress<double> progress, CancellationToken cancellationToken)
  919. {
  920. var tasks = PostscanTasks.ToList();
  921. var numComplete = 0;
  922. var numTasks = tasks.Count;
  923. foreach (var task in tasks)
  924. {
  925. var innerProgress = new ActionableProgress<double>();
  926. // Prevent access to modified closure
  927. var currentNumComplete = numComplete;
  928. innerProgress.RegisterAction(pct =>
  929. {
  930. double innerPercent = pct;
  931. innerPercent /= 100;
  932. innerPercent += currentNumComplete;
  933. innerPercent /= numTasks;
  934. innerPercent *= 100;
  935. progress.Report(innerPercent);
  936. });
  937. _logger.LogDebug("Running post-scan task {0}", task.GetType().Name);
  938. try
  939. {
  940. await task.Run(innerProgress, cancellationToken).ConfigureAwait(false);
  941. }
  942. catch (OperationCanceledException)
  943. {
  944. _logger.LogInformation("Post-scan task cancelled: {0}", task.GetType().Name);
  945. throw;
  946. }
  947. catch (Exception ex)
  948. {
  949. _logger.LogError(ex, "Error running post-scan task");
  950. }
  951. numComplete++;
  952. double percent = numComplete;
  953. percent /= numTasks;
  954. progress.Report(percent * 100);
  955. }
  956. _itemRepository.UpdateInheritedValues();
  957. progress.Report(100);
  958. }
  959. /// <summary>
  960. /// Gets the default view.
  961. /// </summary>
  962. /// <returns>IEnumerable{VirtualFolderInfo}.</returns>
  963. public List<VirtualFolderInfo> GetVirtualFolders()
  964. {
  965. return GetVirtualFolders(false);
  966. }
  967. public List<VirtualFolderInfo> GetVirtualFolders(bool includeRefreshState)
  968. {
  969. _logger.LogDebug("Getting topLibraryFolders");
  970. var topLibraryFolders = GetUserRootFolder().Children.ToList();
  971. _logger.LogDebug("Getting refreshQueue");
  972. var refreshQueue = includeRefreshState ? ProviderManager.GetRefreshQueue() : null;
  973. return _fileSystem.GetDirectoryPaths(_configurationManager.ApplicationPaths.DefaultUserViewsPath)
  974. .Select(dir => GetVirtualFolderInfo(dir, topLibraryFolders, refreshQueue))
  975. .ToList();
  976. }
  977. private VirtualFolderInfo GetVirtualFolderInfo(string dir, List<BaseItem> allCollectionFolders, Dictionary<Guid, Guid> refreshQueue)
  978. {
  979. var info = new VirtualFolderInfo
  980. {
  981. Name = Path.GetFileName(dir),
  982. Locations = _fileSystem.GetFilePaths(dir, false)
  983. .Where(i => string.Equals(ShortcutFileExtension, Path.GetExtension(i), StringComparison.OrdinalIgnoreCase))
  984. .Select(i =>
  985. {
  986. try
  987. {
  988. return _appHost.ExpandVirtualPath(_fileSystem.ResolveShortcut(i));
  989. }
  990. catch (Exception ex)
  991. {
  992. _logger.LogError(ex, "Error resolving shortcut file {File}", i);
  993. return null;
  994. }
  995. })
  996. .Where(i => i is not null)
  997. .OrderBy(i => i)
  998. .ToArray(),
  999. CollectionType = GetCollectionType(dir)
  1000. };
  1001. var libraryFolder = allCollectionFolders.FirstOrDefault(i => string.Equals(i.Path, dir, StringComparison.OrdinalIgnoreCase));
  1002. if (libraryFolder is not null && libraryFolder.HasImage(ImageType.Primary))
  1003. {
  1004. info.PrimaryImageItemId = libraryFolder.Id.ToString("N", CultureInfo.InvariantCulture);
  1005. }
  1006. if (libraryFolder is not null)
  1007. {
  1008. info.ItemId = libraryFolder.Id.ToString("N", CultureInfo.InvariantCulture);
  1009. info.LibraryOptions = GetLibraryOptions(libraryFolder);
  1010. if (refreshQueue is not null)
  1011. {
  1012. info.RefreshProgress = libraryFolder.GetRefreshProgress();
  1013. info.RefreshStatus = info.RefreshProgress.HasValue ? "Active" : refreshQueue.ContainsKey(libraryFolder.Id) ? "Queued" : "Idle";
  1014. }
  1015. }
  1016. return info;
  1017. }
  1018. private CollectionTypeOptions? GetCollectionType(string path)
  1019. {
  1020. var files = _fileSystem.GetFilePaths(path, new[] { ".collection" }, true, false);
  1021. foreach (ReadOnlySpan<char> file in files)
  1022. {
  1023. if (Enum.TryParse<CollectionTypeOptions>(Path.GetFileNameWithoutExtension(file), true, out var res))
  1024. {
  1025. return res;
  1026. }
  1027. }
  1028. return null;
  1029. }
  1030. /// <summary>
  1031. /// Gets the item by id.
  1032. /// </summary>
  1033. /// <param name="id">The id.</param>
  1034. /// <returns>BaseItem.</returns>
  1035. /// <exception cref="ArgumentNullException"><paramref name="id"/> is <c>null</c>.</exception>
  1036. public BaseItem GetItemById(Guid id)
  1037. {
  1038. if (id.Equals(default))
  1039. {
  1040. throw new ArgumentException("Guid can't be empty", nameof(id));
  1041. }
  1042. if (_memoryCache.TryGetValue(id, out BaseItem item))
  1043. {
  1044. return item;
  1045. }
  1046. item = RetrieveItem(id);
  1047. if (item is not null)
  1048. {
  1049. RegisterItem(item);
  1050. }
  1051. return item;
  1052. }
  1053. public List<BaseItem> GetItemList(InternalItemsQuery query, bool allowExternalContent)
  1054. {
  1055. if (query.Recursive && !query.ParentId.Equals(default))
  1056. {
  1057. var parent = GetItemById(query.ParentId);
  1058. if (parent is not null)
  1059. {
  1060. SetTopParentIdsOrAncestors(query, new List<BaseItem> { parent });
  1061. }
  1062. }
  1063. if (query.User is not null)
  1064. {
  1065. AddUserToQuery(query, query.User, allowExternalContent);
  1066. }
  1067. return _itemRepository.GetItemList(query);
  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 List<BaseItem> { 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 List<BaseItem> { 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, List<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. }
  1269. }
  1270. private IEnumerable<Guid> GetTopParentIdsForQuery(BaseItem item, User user)
  1271. {
  1272. if (item is UserView view)
  1273. {
  1274. if (string.Equals(view.ViewType, CollectionType.LiveTv, StringComparison.Ordinal))
  1275. {
  1276. return new[] { view.Id };
  1277. }
  1278. // Translate view into folders
  1279. if (!view.DisplayParentId.Equals(default))
  1280. {
  1281. var displayParent = GetItemById(view.DisplayParentId);
  1282. if (displayParent is not null)
  1283. {
  1284. return GetTopParentIdsForQuery(displayParent, user);
  1285. }
  1286. return Array.Empty<Guid>();
  1287. }
  1288. if (!view.ParentId.Equals(default))
  1289. {
  1290. var displayParent = GetItemById(view.ParentId);
  1291. if (displayParent is not null)
  1292. {
  1293. return GetTopParentIdsForQuery(displayParent, user);
  1294. }
  1295. return Array.Empty<Guid>();
  1296. }
  1297. // Handle grouping
  1298. if (user is not null && !string.IsNullOrEmpty(view.ViewType) && UserView.IsEligibleForGrouping(view.ViewType)
  1299. && user.GetPreference(PreferenceKind.GroupedFolders).Length > 0)
  1300. {
  1301. return GetUserRootFolder()
  1302. .GetChildren(user, true)
  1303. .OfType<CollectionFolder>()
  1304. .Where(i => string.IsNullOrEmpty(i.CollectionType) || string.Equals(i.CollectionType, view.ViewType, StringComparison.OrdinalIgnoreCase))
  1305. .Where(i => user.IsFolderGrouped(i.Id))
  1306. .SelectMany(i => GetTopParentIdsForQuery(i, user));
  1307. }
  1308. return Array.Empty<Guid>();
  1309. }
  1310. if (item is CollectionFolder collectionFolder)
  1311. {
  1312. return collectionFolder.PhysicalFolderIds;
  1313. }
  1314. var topParent = item.GetTopParent();
  1315. if (topParent is not null)
  1316. {
  1317. return new[] { topParent.Id };
  1318. }
  1319. return Array.Empty<Guid>();
  1320. }
  1321. /// <summary>
  1322. /// Gets the intros.
  1323. /// </summary>
  1324. /// <param name="item">The item.</param>
  1325. /// <param name="user">The user.</param>
  1326. /// <returns>IEnumerable{System.String}.</returns>
  1327. public async Task<IEnumerable<Video>> GetIntros(BaseItem item, User user)
  1328. {
  1329. var tasks = IntroProviders
  1330. .Take(1)
  1331. .Select(i => GetIntros(i, item, user));
  1332. var items = await Task.WhenAll(tasks).ConfigureAwait(false);
  1333. return items
  1334. .SelectMany(i => i.ToArray())
  1335. .Select(ResolveIntro)
  1336. .Where(i => i is not null);
  1337. }
  1338. /// <summary>
  1339. /// Gets the intros.
  1340. /// </summary>
  1341. /// <param name="provider">The provider.</param>
  1342. /// <param name="item">The item.</param>
  1343. /// <param name="user">The user.</param>
  1344. /// <returns>Task&lt;IEnumerable&lt;IntroInfo&gt;&gt;.</returns>
  1345. private async Task<IEnumerable<IntroInfo>> GetIntros(IIntroProvider provider, BaseItem item, User user)
  1346. {
  1347. try
  1348. {
  1349. return await provider.GetIntros(item, user).ConfigureAwait(false);
  1350. }
  1351. catch (Exception ex)
  1352. {
  1353. _logger.LogError(ex, "Error getting intros");
  1354. return new List<IntroInfo>();
  1355. }
  1356. }
  1357. /// <summary>
  1358. /// Resolves the intro.
  1359. /// </summary>
  1360. /// <param name="info">The info.</param>
  1361. /// <returns>Video.</returns>
  1362. private Video ResolveIntro(IntroInfo info)
  1363. {
  1364. Video video = null;
  1365. if (info.ItemId.HasValue)
  1366. {
  1367. // Get an existing item by Id
  1368. video = GetItemById(info.ItemId.Value) as Video;
  1369. if (video is null)
  1370. {
  1371. _logger.LogError("Unable to locate item with Id {ID}.", info.ItemId.Value);
  1372. }
  1373. }
  1374. else if (!string.IsNullOrEmpty(info.Path))
  1375. {
  1376. try
  1377. {
  1378. // Try to resolve the path into a video
  1379. video = ResolvePath(_fileSystem.GetFileSystemInfo(info.Path)) as Video;
  1380. if (video is null)
  1381. {
  1382. _logger.LogError("Intro resolver returned null for {Path}.", info.Path);
  1383. }
  1384. else
  1385. {
  1386. // Pull the saved db item that will include metadata
  1387. var dbItem = GetItemById(video.Id) as Video;
  1388. if (dbItem is not null)
  1389. {
  1390. video = dbItem;
  1391. }
  1392. else
  1393. {
  1394. return null;
  1395. }
  1396. }
  1397. }
  1398. catch (Exception ex)
  1399. {
  1400. _logger.LogError(ex, "Error resolving path {Path}.", info.Path);
  1401. }
  1402. }
  1403. else
  1404. {
  1405. _logger.LogError("IntroProvider returned an IntroInfo with null Path and ItemId.");
  1406. }
  1407. return video;
  1408. }
  1409. /// <summary>
  1410. /// Sorts the specified sort by.
  1411. /// </summary>
  1412. /// <param name="items">The items.</param>
  1413. /// <param name="user">The user.</param>
  1414. /// <param name="sortBy">The sort by.</param>
  1415. /// <param name="sortOrder">The sort order.</param>
  1416. /// <returns>IEnumerable{BaseItem}.</returns>
  1417. public IEnumerable<BaseItem> Sort(IEnumerable<BaseItem> items, User user, IEnumerable<string> sortBy, SortOrder sortOrder)
  1418. {
  1419. var isFirst = true;
  1420. IOrderedEnumerable<BaseItem> orderedItems = null;
  1421. foreach (var orderBy in sortBy.Select(o => GetComparer(o, user)).Where(c => c is not null))
  1422. {
  1423. if (isFirst)
  1424. {
  1425. orderedItems = sortOrder == SortOrder.Descending ? items.OrderByDescending(i => i, orderBy) : items.OrderBy(i => i, orderBy);
  1426. }
  1427. else
  1428. {
  1429. orderedItems = sortOrder == SortOrder.Descending ? orderedItems.ThenByDescending(i => i, orderBy) : orderedItems.ThenBy(i => i, orderBy);
  1430. }
  1431. isFirst = false;
  1432. }
  1433. return orderedItems ?? items;
  1434. }
  1435. public IEnumerable<BaseItem> Sort(IEnumerable<BaseItem> items, User user, IEnumerable<(string OrderBy, SortOrder SortOrder)> orderBy)
  1436. {
  1437. var isFirst = true;
  1438. IOrderedEnumerable<BaseItem> orderedItems = null;
  1439. foreach (var (name, sortOrder) in orderBy)
  1440. {
  1441. var comparer = GetComparer(name, user);
  1442. if (comparer is null)
  1443. {
  1444. continue;
  1445. }
  1446. if (isFirst)
  1447. {
  1448. orderedItems = sortOrder == SortOrder.Descending ? items.OrderByDescending(i => i, comparer) : items.OrderBy(i => i, comparer);
  1449. }
  1450. else
  1451. {
  1452. orderedItems = sortOrder == SortOrder.Descending ? orderedItems.ThenByDescending(i => i, comparer) : orderedItems.ThenBy(i => i, comparer);
  1453. }
  1454. isFirst = false;
  1455. }
  1456. return orderedItems ?? items;
  1457. }
  1458. /// <summary>
  1459. /// Gets the comparer.
  1460. /// </summary>
  1461. /// <param name="name">The name.</param>
  1462. /// <param name="user">The user.</param>
  1463. /// <returns>IBaseItemComparer.</returns>
  1464. private IBaseItemComparer GetComparer(string name, User user)
  1465. {
  1466. var comparer = Comparers.FirstOrDefault(c => string.Equals(name, c.Name, StringComparison.OrdinalIgnoreCase));
  1467. // If it requires a user, create a new one, and assign the user
  1468. if (comparer is IUserBaseItemComparer)
  1469. {
  1470. var userComparer = (IUserBaseItemComparer)Activator.CreateInstance(comparer.GetType());
  1471. userComparer.User = user;
  1472. userComparer.UserManager = _userManager;
  1473. userComparer.UserDataRepository = _userDataRepository;
  1474. return userComparer;
  1475. }
  1476. return comparer;
  1477. }
  1478. /// <summary>
  1479. /// Creates the item.
  1480. /// </summary>
  1481. /// <param name="item">The item.</param>
  1482. /// <param name="parent">The parent item.</param>
  1483. public void CreateItem(BaseItem item, BaseItem parent)
  1484. {
  1485. CreateItems(new[] { item }, parent, CancellationToken.None);
  1486. }
  1487. /// <summary>
  1488. /// Creates the items.
  1489. /// </summary>
  1490. /// <param name="items">The items.</param>
  1491. /// <param name="parent">The parent item.</param>
  1492. /// <param name="cancellationToken">The cancellation token.</param>
  1493. public void CreateItems(IReadOnlyList<BaseItem> items, BaseItem parent, CancellationToken cancellationToken)
  1494. {
  1495. _itemRepository.SaveItems(items, cancellationToken);
  1496. foreach (var item in items)
  1497. {
  1498. RegisterItem(item);
  1499. }
  1500. if (ItemAdded is not null)
  1501. {
  1502. foreach (var item in items)
  1503. {
  1504. // With the live tv guide this just creates too much noise
  1505. if (item.SourceType != SourceType.Library)
  1506. {
  1507. continue;
  1508. }
  1509. try
  1510. {
  1511. ItemAdded(
  1512. this,
  1513. new ItemChangeEventArgs
  1514. {
  1515. Item = item,
  1516. Parent = parent ?? item.GetParent()
  1517. });
  1518. }
  1519. catch (Exception ex)
  1520. {
  1521. _logger.LogError(ex, "Error in ItemAdded event handler");
  1522. }
  1523. }
  1524. }
  1525. }
  1526. private bool ImageNeedsRefresh(ItemImageInfo image)
  1527. {
  1528. if (image.Path is not null && image.IsLocalFile)
  1529. {
  1530. if (image.Width == 0 || image.Height == 0 || string.IsNullOrEmpty(image.BlurHash))
  1531. {
  1532. return true;
  1533. }
  1534. try
  1535. {
  1536. return _fileSystem.GetLastWriteTimeUtc(image.Path) != image.DateModified;
  1537. }
  1538. catch (Exception ex)
  1539. {
  1540. _logger.LogError(ex, "Cannot get file info for {0}", image.Path);
  1541. return false;
  1542. }
  1543. }
  1544. return image.Path is not null && !image.IsLocalFile;
  1545. }
  1546. /// <inheritdoc />
  1547. public async Task UpdateImagesAsync(BaseItem item, bool forceUpdate = false)
  1548. {
  1549. ArgumentNullException.ThrowIfNull(item);
  1550. var outdated = forceUpdate
  1551. ? item.ImageInfos.Where(i => i.Path is not null).ToArray()
  1552. : item.ImageInfos.Where(ImageNeedsRefresh).ToArray();
  1553. // Skip image processing if current or live tv source
  1554. if (outdated.Length == 0 || item.SourceType != SourceType.Library)
  1555. {
  1556. RegisterItem(item);
  1557. return;
  1558. }
  1559. foreach (var img in outdated)
  1560. {
  1561. var image = img;
  1562. if (!img.IsLocalFile)
  1563. {
  1564. try
  1565. {
  1566. var index = item.GetImageIndex(img);
  1567. image = await ConvertImageToLocal(item, img, index).ConfigureAwait(false);
  1568. }
  1569. catch (ArgumentException)
  1570. {
  1571. _logger.LogWarning("Cannot get image index for {ImagePath}", img.Path);
  1572. continue;
  1573. }
  1574. catch (Exception ex) when (ex is InvalidOperationException or IOException)
  1575. {
  1576. _logger.LogWarning(ex, "Cannot fetch image from {ImagePath}", img.Path);
  1577. continue;
  1578. }
  1579. catch (HttpRequestException ex)
  1580. {
  1581. _logger.LogWarning(ex, "Cannot fetch image from {ImagePath}. Http status code: {HttpStatus}", img.Path, ex.StatusCode);
  1582. continue;
  1583. }
  1584. }
  1585. ImageDimensions size;
  1586. try
  1587. {
  1588. size = _imageProcessor.GetImageDimensions(item, image);
  1589. image.Width = size.Width;
  1590. image.Height = size.Height;
  1591. }
  1592. catch (Exception ex)
  1593. {
  1594. _logger.LogError(ex, "Cannot get image dimensions for {ImagePath}", image.Path);
  1595. size = new ImageDimensions(0, 0);
  1596. image.Width = 0;
  1597. image.Height = 0;
  1598. }
  1599. try
  1600. {
  1601. image.BlurHash = _imageProcessor.GetImageBlurHash(image.Path, size);
  1602. }
  1603. catch (Exception ex)
  1604. {
  1605. _logger.LogError(ex, "Cannot compute blurhash for {ImagePath}", image.Path);
  1606. image.BlurHash = string.Empty;
  1607. }
  1608. try
  1609. {
  1610. image.DateModified = _fileSystem.GetLastWriteTimeUtc(image.Path);
  1611. }
  1612. catch (Exception ex)
  1613. {
  1614. _logger.LogError(ex, "Cannot update DateModified for {ImagePath}", image.Path);
  1615. }
  1616. }
  1617. _itemRepository.SaveImages(item);
  1618. RegisterItem(item);
  1619. }
  1620. /// <inheritdoc />
  1621. public async Task UpdateItemsAsync(IReadOnlyList<BaseItem> items, BaseItem parent, ItemUpdateType updateReason, CancellationToken cancellationToken)
  1622. {
  1623. foreach (var item in items)
  1624. {
  1625. await RunMetadataSavers(item, updateReason).ConfigureAwait(false);
  1626. }
  1627. _itemRepository.SaveItems(items, cancellationToken);
  1628. if (ItemUpdated is not null)
  1629. {
  1630. foreach (var item in items)
  1631. {
  1632. // With the live tv guide this just creates too much noise
  1633. if (item.SourceType != SourceType.Library)
  1634. {
  1635. continue;
  1636. }
  1637. try
  1638. {
  1639. ItemUpdated(
  1640. this,
  1641. new ItemChangeEventArgs
  1642. {
  1643. Item = item,
  1644. Parent = parent,
  1645. UpdateReason = updateReason
  1646. });
  1647. }
  1648. catch (Exception ex)
  1649. {
  1650. _logger.LogError(ex, "Error in ItemUpdated event handler");
  1651. }
  1652. }
  1653. }
  1654. }
  1655. /// <inheritdoc />
  1656. public Task UpdateItemAsync(BaseItem item, BaseItem parent, ItemUpdateType updateReason, CancellationToken cancellationToken)
  1657. => UpdateItemsAsync(new[] { item }, parent, updateReason, cancellationToken);
  1658. public async Task RunMetadataSavers(BaseItem item, ItemUpdateType updateReason)
  1659. {
  1660. if (item.IsFileProtocol)
  1661. {
  1662. await ProviderManager.SaveMetadataAsync(item, updateReason).ConfigureAwait(false);
  1663. }
  1664. item.DateLastSaved = DateTime.UtcNow;
  1665. await UpdateImagesAsync(item, updateReason >= ItemUpdateType.ImageUpdate).ConfigureAwait(false);
  1666. }
  1667. /// <summary>
  1668. /// Reports the item removed.
  1669. /// </summary>
  1670. /// <param name="item">The item.</param>
  1671. /// <param name="parent">The parent item.</param>
  1672. public void ReportItemRemoved(BaseItem item, BaseItem parent)
  1673. {
  1674. if (ItemRemoved is not null)
  1675. {
  1676. try
  1677. {
  1678. ItemRemoved(
  1679. this,
  1680. new ItemChangeEventArgs
  1681. {
  1682. Item = item,
  1683. Parent = parent
  1684. });
  1685. }
  1686. catch (Exception ex)
  1687. {
  1688. _logger.LogError(ex, "Error in ItemRemoved event handler");
  1689. }
  1690. }
  1691. }
  1692. /// <summary>
  1693. /// Retrieves the item.
  1694. /// </summary>
  1695. /// <param name="id">The id.</param>
  1696. /// <returns>BaseItem.</returns>
  1697. public BaseItem RetrieveItem(Guid id)
  1698. {
  1699. return _itemRepository.RetrieveItem(id);
  1700. }
  1701. public List<Folder> GetCollectionFolders(BaseItem item)
  1702. {
  1703. while (item is not null)
  1704. {
  1705. var parent = item.GetParent();
  1706. if (parent is null || parent is AggregateFolder)
  1707. {
  1708. break;
  1709. }
  1710. item = parent;
  1711. }
  1712. if (item is null)
  1713. {
  1714. return new List<Folder>();
  1715. }
  1716. return GetCollectionFoldersInternal(item, GetUserRootFolder().Children.OfType<Folder>());
  1717. }
  1718. public List<Folder> GetCollectionFolders(BaseItem item, List<Folder> allUserRootChildren)
  1719. {
  1720. while (item is not null)
  1721. {
  1722. var parent = item.GetParent();
  1723. if (parent is null || parent is AggregateFolder)
  1724. {
  1725. break;
  1726. }
  1727. item = parent;
  1728. }
  1729. if (item is null)
  1730. {
  1731. return new List<Folder>();
  1732. }
  1733. return GetCollectionFoldersInternal(item, allUserRootChildren);
  1734. }
  1735. private static List<Folder> GetCollectionFoldersInternal(BaseItem item, IEnumerable<Folder> allUserRootChildren)
  1736. {
  1737. return allUserRootChildren
  1738. .Where(i => string.Equals(i.Path, item.Path, StringComparison.OrdinalIgnoreCase) || i.PhysicalLocations.Contains(item.Path.AsSpan(), StringComparison.OrdinalIgnoreCase))
  1739. .ToList();
  1740. }
  1741. public LibraryOptions GetLibraryOptions(BaseItem item)
  1742. {
  1743. if (item is not CollectionFolder collectionFolder)
  1744. {
  1745. // List.Find is more performant than FirstOrDefault due to enumerator allocation
  1746. collectionFolder = GetCollectionFolders(item)
  1747. .Find(folder => folder is CollectionFolder) as CollectionFolder;
  1748. }
  1749. return collectionFolder is null ? new LibraryOptions() : collectionFolder.GetLibraryOptions();
  1750. }
  1751. public string GetContentType(BaseItem item)
  1752. {
  1753. string configuredContentType = GetConfiguredContentType(item, false);
  1754. if (!string.IsNullOrEmpty(configuredContentType))
  1755. {
  1756. return configuredContentType;
  1757. }
  1758. configuredContentType = GetConfiguredContentType(item, true);
  1759. if (!string.IsNullOrEmpty(configuredContentType))
  1760. {
  1761. return configuredContentType;
  1762. }
  1763. return GetInheritedContentType(item);
  1764. }
  1765. public string GetInheritedContentType(BaseItem item)
  1766. {
  1767. var type = GetTopFolderContentType(item);
  1768. if (!string.IsNullOrEmpty(type))
  1769. {
  1770. return type;
  1771. }
  1772. return item.GetParents()
  1773. .Select(GetConfiguredContentType)
  1774. .LastOrDefault(i => !string.IsNullOrEmpty(i));
  1775. }
  1776. public string GetConfiguredContentType(BaseItem item)
  1777. {
  1778. return GetConfiguredContentType(item, false);
  1779. }
  1780. public string GetConfiguredContentType(string path)
  1781. {
  1782. return GetContentTypeOverride(path, false);
  1783. }
  1784. public string GetConfiguredContentType(BaseItem item, bool inheritConfiguredPath)
  1785. {
  1786. if (item is ICollectionFolder collectionFolder)
  1787. {
  1788. return collectionFolder.CollectionType;
  1789. }
  1790. return GetContentTypeOverride(item.ContainingFolderPath, inheritConfiguredPath);
  1791. }
  1792. private string GetContentTypeOverride(string path, bool inherit)
  1793. {
  1794. var nameValuePair = _configurationManager.Configuration.ContentTypes
  1795. .FirstOrDefault(i => _fileSystem.AreEqual(i.Name, path)
  1796. || (inherit && !string.IsNullOrEmpty(i.Name)
  1797. && _fileSystem.ContainsSubPath(i.Name, path)));
  1798. return nameValuePair?.Value;
  1799. }
  1800. private string GetTopFolderContentType(BaseItem item)
  1801. {
  1802. if (item is null)
  1803. {
  1804. return null;
  1805. }
  1806. while (!item.ParentId.Equals(default))
  1807. {
  1808. var parent = item.GetParent();
  1809. if (parent is null || parent is AggregateFolder)
  1810. {
  1811. break;
  1812. }
  1813. item = parent;
  1814. }
  1815. return GetUserRootFolder().Children
  1816. .OfType<ICollectionFolder>()
  1817. .Where(i => string.Equals(i.Path, item.Path, StringComparison.OrdinalIgnoreCase) || i.PhysicalLocations.Contains(item.Path))
  1818. .Select(i => i.CollectionType)
  1819. .FirstOrDefault(i => !string.IsNullOrEmpty(i));
  1820. }
  1821. public UserView GetNamedView(
  1822. User user,
  1823. string name,
  1824. string viewType,
  1825. string sortName)
  1826. {
  1827. return GetNamedView(user, name, Guid.Empty, viewType, sortName);
  1828. }
  1829. public UserView GetNamedView(
  1830. string name,
  1831. string viewType,
  1832. string sortName)
  1833. {
  1834. var path = Path.Combine(
  1835. _configurationManager.ApplicationPaths.InternalMetadataPath,
  1836. "views",
  1837. _fileSystem.GetValidFilename(viewType));
  1838. var id = GetNewItemId(path + "_namedview_" + name, typeof(UserView));
  1839. var item = GetItemById(id) as UserView;
  1840. var refresh = false;
  1841. if (item is null || !string.Equals(item.Path, path, StringComparison.OrdinalIgnoreCase))
  1842. {
  1843. Directory.CreateDirectory(path);
  1844. item = new UserView
  1845. {
  1846. Path = path,
  1847. Id = id,
  1848. DateCreated = DateTime.UtcNow,
  1849. Name = name,
  1850. ViewType = viewType,
  1851. ForcedSortName = sortName
  1852. };
  1853. CreateItem(item, null);
  1854. refresh = true;
  1855. }
  1856. if (refresh)
  1857. {
  1858. item.UpdateToRepositoryAsync(ItemUpdateType.MetadataImport, CancellationToken.None).GetAwaiter().GetResult();
  1859. ProviderManager.QueueRefresh(item.Id, new MetadataRefreshOptions(new DirectoryService(_fileSystem)), RefreshPriority.Normal);
  1860. }
  1861. return item;
  1862. }
  1863. public UserView GetNamedView(
  1864. User user,
  1865. string name,
  1866. Guid parentId,
  1867. string viewType,
  1868. string sortName)
  1869. {
  1870. var parentIdString = parentId.Equals(default)
  1871. ? null
  1872. : parentId.ToString("N", CultureInfo.InvariantCulture);
  1873. var idValues = "38_namedview_" + name + user.Id.ToString("N", CultureInfo.InvariantCulture) + (parentIdString ?? string.Empty) + (viewType ?? string.Empty);
  1874. var id = GetNewItemId(idValues, typeof(UserView));
  1875. var path = Path.Combine(_configurationManager.ApplicationPaths.InternalMetadataPath, "views", id.ToString("N", CultureInfo.InvariantCulture));
  1876. var item = GetItemById(id) as UserView;
  1877. var isNew = false;
  1878. if (item is null)
  1879. {
  1880. Directory.CreateDirectory(path);
  1881. item = new UserView
  1882. {
  1883. Path = path,
  1884. Id = id,
  1885. DateCreated = DateTime.UtcNow,
  1886. Name = name,
  1887. ViewType = viewType,
  1888. ForcedSortName = sortName,
  1889. UserId = user.Id,
  1890. DisplayParentId = parentId
  1891. };
  1892. CreateItem(item, null);
  1893. isNew = true;
  1894. }
  1895. var refresh = isNew || DateTime.UtcNow - item.DateLastRefreshed >= _viewRefreshInterval;
  1896. if (!refresh && !item.DisplayParentId.Equals(default))
  1897. {
  1898. var displayParent = GetItemById(item.DisplayParentId);
  1899. refresh = displayParent is not null && displayParent.DateLastSaved > item.DateLastRefreshed;
  1900. }
  1901. if (refresh)
  1902. {
  1903. ProviderManager.QueueRefresh(
  1904. item.Id,
  1905. new MetadataRefreshOptions(new DirectoryService(_fileSystem))
  1906. {
  1907. // Need to force save to increment DateLastSaved
  1908. ForceSave = true
  1909. },
  1910. RefreshPriority.Normal);
  1911. }
  1912. return item;
  1913. }
  1914. public UserView GetShadowView(
  1915. BaseItem parent,
  1916. string viewType,
  1917. string sortName)
  1918. {
  1919. ArgumentNullException.ThrowIfNull(parent);
  1920. var name = parent.Name;
  1921. var parentId = parent.Id;
  1922. var idValues = "38_namedview_" + name + parentId + (viewType ?? string.Empty);
  1923. var id = GetNewItemId(idValues, typeof(UserView));
  1924. var path = parent.Path;
  1925. var item = GetItemById(id) as UserView;
  1926. var isNew = false;
  1927. if (item is null)
  1928. {
  1929. Directory.CreateDirectory(path);
  1930. item = new UserView
  1931. {
  1932. Path = path,
  1933. Id = id,
  1934. DateCreated = DateTime.UtcNow,
  1935. Name = name,
  1936. ViewType = viewType,
  1937. ForcedSortName = sortName
  1938. };
  1939. item.DisplayParentId = parentId;
  1940. CreateItem(item, null);
  1941. isNew = true;
  1942. }
  1943. var refresh = isNew || DateTime.UtcNow - item.DateLastRefreshed >= _viewRefreshInterval;
  1944. if (!refresh && !item.DisplayParentId.Equals(default))
  1945. {
  1946. var displayParent = GetItemById(item.DisplayParentId);
  1947. refresh = displayParent is not null && displayParent.DateLastSaved > item.DateLastRefreshed;
  1948. }
  1949. if (refresh)
  1950. {
  1951. ProviderManager.QueueRefresh(
  1952. item.Id,
  1953. new MetadataRefreshOptions(new DirectoryService(_fileSystem))
  1954. {
  1955. // Need to force save to increment DateLastSaved
  1956. ForceSave = true
  1957. },
  1958. RefreshPriority.Normal);
  1959. }
  1960. return item;
  1961. }
  1962. public UserView GetNamedView(
  1963. string name,
  1964. Guid parentId,
  1965. string viewType,
  1966. string sortName,
  1967. string uniqueId)
  1968. {
  1969. ArgumentException.ThrowIfNullOrEmpty(name);
  1970. var parentIdString = parentId.Equals(default)
  1971. ? null
  1972. : parentId.ToString("N", CultureInfo.InvariantCulture);
  1973. var idValues = "37_namedview_" + name + (parentIdString ?? string.Empty) + (viewType ?? string.Empty);
  1974. if (!string.IsNullOrEmpty(uniqueId))
  1975. {
  1976. idValues += uniqueId;
  1977. }
  1978. var id = GetNewItemId(idValues, typeof(UserView));
  1979. var path = Path.Combine(_configurationManager.ApplicationPaths.InternalMetadataPath, "views", id.ToString("N", CultureInfo.InvariantCulture));
  1980. var item = GetItemById(id) as UserView;
  1981. var isNew = false;
  1982. if (item is null)
  1983. {
  1984. Directory.CreateDirectory(path);
  1985. item = new UserView
  1986. {
  1987. Path = path,
  1988. Id = id,
  1989. DateCreated = DateTime.UtcNow,
  1990. Name = name,
  1991. ViewType = viewType,
  1992. ForcedSortName = sortName
  1993. };
  1994. item.DisplayParentId = parentId;
  1995. CreateItem(item, null);
  1996. isNew = true;
  1997. }
  1998. if (!string.Equals(viewType, item.ViewType, StringComparison.OrdinalIgnoreCase))
  1999. {
  2000. item.ViewType = viewType;
  2001. item.UpdateToRepositoryAsync(ItemUpdateType.MetadataEdit, CancellationToken.None).GetAwaiter().GetResult();
  2002. }
  2003. var refresh = isNew || DateTime.UtcNow - item.DateLastRefreshed >= _viewRefreshInterval;
  2004. if (!refresh && !item.DisplayParentId.Equals(default))
  2005. {
  2006. var displayParent = GetItemById(item.DisplayParentId);
  2007. refresh = displayParent is not null && displayParent.DateLastSaved > item.DateLastRefreshed;
  2008. }
  2009. if (refresh)
  2010. {
  2011. ProviderManager.QueueRefresh(
  2012. item.Id,
  2013. new MetadataRefreshOptions(new DirectoryService(_fileSystem))
  2014. {
  2015. // Need to force save to increment DateLastSaved
  2016. ForceSave = true
  2017. },
  2018. RefreshPriority.Normal);
  2019. }
  2020. return item;
  2021. }
  2022. public BaseItem GetParentItem(Guid? parentId, Guid? userId)
  2023. {
  2024. if (parentId.HasValue)
  2025. {
  2026. return GetItemById(parentId.Value);
  2027. }
  2028. if (userId.HasValue && !userId.Equals(default))
  2029. {
  2030. return GetUserRootFolder();
  2031. }
  2032. return RootFolder;
  2033. }
  2034. /// <inheritdoc />
  2035. public void QueueLibraryScan()
  2036. {
  2037. _taskManager.QueueScheduledTask<RefreshMediaLibraryTask>();
  2038. }
  2039. /// <inheritdoc />
  2040. public int? GetSeasonNumberFromPath(string path)
  2041. => SeasonPathParser.Parse(path, true, true).SeasonNumber;
  2042. /// <inheritdoc />
  2043. public bool FillMissingEpisodeNumbersFromPath(Episode episode, bool forceRefresh)
  2044. {
  2045. var series = episode.Series;
  2046. bool? isAbsoluteNaming = series is not null && string.Equals(series.DisplayOrder, "absolute", StringComparison.OrdinalIgnoreCase);
  2047. if (!isAbsoluteNaming.Value)
  2048. {
  2049. // In other words, no filter applied
  2050. isAbsoluteNaming = null;
  2051. }
  2052. var resolver = new EpisodeResolver(_namingOptions);
  2053. var isFolder = episode.VideoType == VideoType.BluRay || episode.VideoType == VideoType.Dvd;
  2054. // TODO nullable - what are we trying to do there with empty episodeInfo?
  2055. EpisodeInfo episodeInfo = null;
  2056. if (episode.IsFileProtocol)
  2057. {
  2058. episodeInfo = resolver.Resolve(episode.Path, isFolder, null, null, isAbsoluteNaming);
  2059. // Resolve from parent folder if it's not the Season folder
  2060. var parent = episode.GetParent();
  2061. if (episodeInfo is null && parent.GetType() == typeof(Folder))
  2062. {
  2063. episodeInfo = resolver.Resolve(parent.Path, true, null, null, isAbsoluteNaming);
  2064. if (episodeInfo is not null)
  2065. {
  2066. // add the container
  2067. episodeInfo.Container = Path.GetExtension(episode.Path)?.TrimStart('.');
  2068. }
  2069. }
  2070. }
  2071. episodeInfo ??= new EpisodeInfo(episode.Path);
  2072. try
  2073. {
  2074. var libraryOptions = GetLibraryOptions(episode);
  2075. if (libraryOptions.EnableEmbeddedEpisodeInfos && string.Equals(episodeInfo.Container, "mp4", StringComparison.OrdinalIgnoreCase))
  2076. {
  2077. // Read from metadata
  2078. var mediaInfo = _mediaEncoder.GetMediaInfo(
  2079. new MediaInfoRequest
  2080. {
  2081. MediaSource = episode.GetMediaSources(false)[0],
  2082. MediaType = DlnaProfileType.Video
  2083. },
  2084. CancellationToken.None).GetAwaiter().GetResult();
  2085. if (mediaInfo.ParentIndexNumber > 0)
  2086. {
  2087. episodeInfo.SeasonNumber = mediaInfo.ParentIndexNumber;
  2088. }
  2089. if (mediaInfo.IndexNumber > 0)
  2090. {
  2091. episodeInfo.EpisodeNumber = mediaInfo.IndexNumber;
  2092. }
  2093. if (!string.IsNullOrEmpty(mediaInfo.ShowName))
  2094. {
  2095. episodeInfo.SeriesName = mediaInfo.ShowName;
  2096. }
  2097. }
  2098. }
  2099. catch (Exception ex)
  2100. {
  2101. _logger.LogError(ex, "Error reading the episode information with ffprobe. Episode: {EpisodeInfo}", episodeInfo.Path);
  2102. }
  2103. var changed = false;
  2104. if (episodeInfo.IsByDate)
  2105. {
  2106. if (episode.IndexNumber.HasValue)
  2107. {
  2108. episode.IndexNumber = null;
  2109. changed = true;
  2110. }
  2111. if (episode.IndexNumberEnd.HasValue)
  2112. {
  2113. episode.IndexNumberEnd = null;
  2114. changed = true;
  2115. }
  2116. if (!episode.PremiereDate.HasValue)
  2117. {
  2118. if (episodeInfo.Year.HasValue && episodeInfo.Month.HasValue && episodeInfo.Day.HasValue)
  2119. {
  2120. episode.PremiereDate = new DateTime(episodeInfo.Year.Value, episodeInfo.Month.Value, episodeInfo.Day.Value).ToUniversalTime();
  2121. }
  2122. if (episode.PremiereDate.HasValue)
  2123. {
  2124. changed = true;
  2125. }
  2126. }
  2127. if (!episode.ProductionYear.HasValue)
  2128. {
  2129. episode.ProductionYear = episodeInfo.Year;
  2130. if (episode.ProductionYear.HasValue)
  2131. {
  2132. changed = true;
  2133. }
  2134. }
  2135. }
  2136. else
  2137. {
  2138. if (!episode.IndexNumber.HasValue || forceRefresh)
  2139. {
  2140. if (episode.IndexNumber != episodeInfo.EpisodeNumber)
  2141. {
  2142. changed = true;
  2143. }
  2144. episode.IndexNumber = episodeInfo.EpisodeNumber;
  2145. }
  2146. if (!episode.IndexNumberEnd.HasValue || forceRefresh)
  2147. {
  2148. if (episode.IndexNumberEnd != episodeInfo.EndingEpisodeNumber)
  2149. {
  2150. changed = true;
  2151. }
  2152. episode.IndexNumberEnd = episodeInfo.EndingEpisodeNumber;
  2153. }
  2154. if (!episode.ParentIndexNumber.HasValue || forceRefresh)
  2155. {
  2156. if (episode.ParentIndexNumber != episodeInfo.SeasonNumber)
  2157. {
  2158. changed = true;
  2159. }
  2160. episode.ParentIndexNumber = episodeInfo.SeasonNumber;
  2161. }
  2162. }
  2163. if (!episode.ParentIndexNumber.HasValue)
  2164. {
  2165. var season = episode.Season;
  2166. if (season is not null)
  2167. {
  2168. episode.ParentIndexNumber = season.IndexNumber;
  2169. }
  2170. else
  2171. {
  2172. /*
  2173. Anime series don't generally have a season in their file name, however,
  2174. TVDb needs a season to correctly get the metadata.
  2175. Hence, a null season needs to be filled with something. */
  2176. // FIXME perhaps this would be better for TVDb parser to ask for season 1 if no season is specified
  2177. episode.ParentIndexNumber = 1;
  2178. }
  2179. if (episode.ParentIndexNumber.HasValue)
  2180. {
  2181. changed = true;
  2182. }
  2183. }
  2184. return changed;
  2185. }
  2186. public ItemLookupInfo ParseName(string name)
  2187. {
  2188. var namingOptions = _namingOptions;
  2189. var result = VideoResolver.CleanDateTime(name, namingOptions);
  2190. return new ItemLookupInfo
  2191. {
  2192. Name = VideoResolver.TryCleanString(result.Name, namingOptions, out var newName) ? newName : result.Name,
  2193. Year = result.Year
  2194. };
  2195. }
  2196. public IEnumerable<BaseItem> FindExtras(BaseItem owner, IReadOnlyList<FileSystemMetadata> fileSystemChildren, IDirectoryService directoryService)
  2197. {
  2198. var ownerVideoInfo = VideoResolver.Resolve(owner.Path, owner.IsFolder, _namingOptions);
  2199. if (ownerVideoInfo is null)
  2200. {
  2201. yield break;
  2202. }
  2203. var count = fileSystemChildren.Count;
  2204. for (var i = 0; i < count; i++)
  2205. {
  2206. var current = fileSystemChildren[i];
  2207. if (current.IsDirectory && _namingOptions.AllExtrasTypesFolderNames.ContainsKey(current.Name))
  2208. {
  2209. var filesInSubFolder = _fileSystem.GetFiles(current.FullName, null, false, false);
  2210. foreach (var file in filesInSubFolder)
  2211. {
  2212. if (!_extraResolver.TryGetExtraTypeForOwner(file.FullName, ownerVideoInfo, out var extraType))
  2213. {
  2214. continue;
  2215. }
  2216. var extra = GetExtra(file, extraType.Value);
  2217. if (extra is not null)
  2218. {
  2219. yield return extra;
  2220. }
  2221. }
  2222. }
  2223. else if (!current.IsDirectory && _extraResolver.TryGetExtraTypeForOwner(current.FullName, ownerVideoInfo, out var extraType))
  2224. {
  2225. var extra = GetExtra(current, extraType.Value);
  2226. if (extra is not null)
  2227. {
  2228. yield return extra;
  2229. }
  2230. }
  2231. }
  2232. BaseItem GetExtra(FileSystemMetadata file, ExtraType extraType)
  2233. {
  2234. var extra = ResolvePath(_fileSystem.GetFileInfo(file.FullName), directoryService, _extraResolver.GetResolversForExtraType(extraType));
  2235. if (extra is not Video && extra is not Audio)
  2236. {
  2237. return null;
  2238. }
  2239. // Try to retrieve it from the db. If we don't find it, use the resolved version
  2240. var itemById = GetItemById(extra.Id);
  2241. if (itemById is not null)
  2242. {
  2243. extra = itemById;
  2244. }
  2245. extra.ExtraType = extraType;
  2246. extra.ParentId = Guid.Empty;
  2247. extra.OwnerId = owner.Id;
  2248. return extra;
  2249. }
  2250. }
  2251. public string GetPathAfterNetworkSubstitution(string path, BaseItem ownerItem)
  2252. {
  2253. string newPath;
  2254. if (ownerItem is not null)
  2255. {
  2256. var libraryOptions = GetLibraryOptions(ownerItem);
  2257. if (libraryOptions is not null)
  2258. {
  2259. foreach (var pathInfo in libraryOptions.PathInfos)
  2260. {
  2261. if (path.TryReplaceSubPath(pathInfo.Path, pathInfo.NetworkPath, out newPath))
  2262. {
  2263. return newPath;
  2264. }
  2265. }
  2266. }
  2267. }
  2268. var metadataPath = _configurationManager.Configuration.MetadataPath;
  2269. var metadataNetworkPath = _configurationManager.Configuration.MetadataNetworkPath;
  2270. if (path.TryReplaceSubPath(metadataPath, metadataNetworkPath, out newPath))
  2271. {
  2272. return newPath;
  2273. }
  2274. foreach (var map in _configurationManager.Configuration.PathSubstitutions)
  2275. {
  2276. if (path.TryReplaceSubPath(map.From, map.To, out newPath))
  2277. {
  2278. return newPath;
  2279. }
  2280. }
  2281. return path;
  2282. }
  2283. public List<PersonInfo> GetPeople(InternalPeopleQuery query)
  2284. {
  2285. return _itemRepository.GetPeople(query);
  2286. }
  2287. public List<PersonInfo> GetPeople(BaseItem item)
  2288. {
  2289. if (item.SupportsPeople)
  2290. {
  2291. var people = GetPeople(new InternalPeopleQuery
  2292. {
  2293. ItemId = item.Id
  2294. });
  2295. if (people.Count > 0)
  2296. {
  2297. return people;
  2298. }
  2299. }
  2300. return new List<PersonInfo>();
  2301. }
  2302. public List<Person> GetPeopleItems(InternalPeopleQuery query)
  2303. {
  2304. return _itemRepository.GetPeopleNames(query)
  2305. .Select(i =>
  2306. {
  2307. try
  2308. {
  2309. return GetPerson(i);
  2310. }
  2311. catch (Exception ex)
  2312. {
  2313. _logger.LogError(ex, "Error getting person");
  2314. return null;
  2315. }
  2316. })
  2317. .Where(i => i is not null)
  2318. .Where(i => query.User is null ?
  2319. true :
  2320. i.IsVisible(query.User))
  2321. .ToList();
  2322. }
  2323. public List<string> GetPeopleNames(InternalPeopleQuery query)
  2324. {
  2325. return _itemRepository.GetPeopleNames(query);
  2326. }
  2327. public void UpdatePeople(BaseItem item, List<PersonInfo> people)
  2328. {
  2329. UpdatePeopleAsync(item, people, CancellationToken.None).GetAwaiter().GetResult();
  2330. }
  2331. /// <inheritdoc />
  2332. public async Task UpdatePeopleAsync(BaseItem item, List<PersonInfo> people, CancellationToken cancellationToken)
  2333. {
  2334. if (!item.SupportsPeople)
  2335. {
  2336. return;
  2337. }
  2338. _itemRepository.UpdatePeople(item.Id, people);
  2339. await SavePeopleMetadataAsync(people, cancellationToken).ConfigureAwait(false);
  2340. }
  2341. public async Task<ItemImageInfo> ConvertImageToLocal(BaseItem item, ItemImageInfo image, int imageIndex)
  2342. {
  2343. foreach (var url in image.Path.Split('|'))
  2344. {
  2345. try
  2346. {
  2347. _logger.LogDebug("ConvertImageToLocal item {0} - image url: {1}", item.Id, url);
  2348. await ProviderManager.SaveImage(item, url, image.Type, imageIndex, CancellationToken.None).ConfigureAwait(false);
  2349. await item.UpdateToRepositoryAsync(ItemUpdateType.ImageUpdate, CancellationToken.None).ConfigureAwait(false);
  2350. return item.GetImageInfo(image.Type, imageIndex);
  2351. }
  2352. catch (HttpRequestException ex)
  2353. {
  2354. if (ex.StatusCode.HasValue
  2355. && (ex.StatusCode.Value == HttpStatusCode.NotFound || ex.StatusCode.Value == HttpStatusCode.Forbidden))
  2356. {
  2357. continue;
  2358. }
  2359. throw;
  2360. }
  2361. }
  2362. // Remove this image to prevent it from retrying over and over
  2363. item.RemoveImage(image);
  2364. await item.UpdateToRepositoryAsync(ItemUpdateType.ImageUpdate, CancellationToken.None).ConfigureAwait(false);
  2365. throw new InvalidOperationException();
  2366. }
  2367. public async Task AddVirtualFolder(string name, CollectionTypeOptions? collectionType, LibraryOptions options, bool refreshLibrary)
  2368. {
  2369. if (string.IsNullOrWhiteSpace(name))
  2370. {
  2371. throw new ArgumentNullException(nameof(name));
  2372. }
  2373. name = _fileSystem.GetValidFilename(name);
  2374. var rootFolderPath = _configurationManager.ApplicationPaths.DefaultUserViewsPath;
  2375. var existingNameCount = 1; // first numbered name will be 2
  2376. var virtualFolderPath = Path.Combine(rootFolderPath, name);
  2377. var originalName = name;
  2378. while (Directory.Exists(virtualFolderPath))
  2379. {
  2380. existingNameCount++;
  2381. name = originalName + existingNameCount;
  2382. virtualFolderPath = Path.Combine(rootFolderPath, name);
  2383. }
  2384. var mediaPathInfos = options.PathInfos;
  2385. if (mediaPathInfos is not null)
  2386. {
  2387. var invalidpath = mediaPathInfos.FirstOrDefault(i => !Directory.Exists(i.Path));
  2388. if (invalidpath is not null)
  2389. {
  2390. throw new ArgumentException("The specified path does not exist: " + invalidpath.Path + ".");
  2391. }
  2392. }
  2393. LibraryMonitor.Stop();
  2394. try
  2395. {
  2396. Directory.CreateDirectory(virtualFolderPath);
  2397. if (collectionType is not null)
  2398. {
  2399. var path = Path.Combine(virtualFolderPath, collectionType.ToString().ToLowerInvariant() + ".collection");
  2400. File.WriteAllBytes(path, Array.Empty<byte>());
  2401. }
  2402. CollectionFolder.SaveLibraryOptions(virtualFolderPath, options);
  2403. if (mediaPathInfos is not null)
  2404. {
  2405. foreach (var path in mediaPathInfos)
  2406. {
  2407. AddMediaPathInternal(name, path, false);
  2408. }
  2409. }
  2410. }
  2411. finally
  2412. {
  2413. if (refreshLibrary)
  2414. {
  2415. await ValidateTopLibraryFolders(CancellationToken.None).ConfigureAwait(false);
  2416. StartScanInBackground();
  2417. }
  2418. else
  2419. {
  2420. // Need to add a delay here or directory watchers may still pick up the changes
  2421. await Task.Delay(1000).ConfigureAwait(false);
  2422. LibraryMonitor.Start();
  2423. }
  2424. }
  2425. }
  2426. private async Task SavePeopleMetadataAsync(IEnumerable<PersonInfo> people, CancellationToken cancellationToken)
  2427. {
  2428. var personsToSave = new List<BaseItem>();
  2429. foreach (var person in people)
  2430. {
  2431. cancellationToken.ThrowIfCancellationRequested();
  2432. var itemUpdateType = ItemUpdateType.MetadataDownload;
  2433. var saveEntity = false;
  2434. var personEntity = GetPerson(person.Name);
  2435. // if PresentationUniqueKey is empty it's likely a new item.
  2436. if (string.IsNullOrEmpty(personEntity.PresentationUniqueKey))
  2437. {
  2438. personEntity.PresentationUniqueKey = personEntity.CreatePresentationUniqueKey();
  2439. saveEntity = true;
  2440. }
  2441. foreach (var id in person.ProviderIds)
  2442. {
  2443. if (!string.Equals(personEntity.GetProviderId(id.Key), id.Value, StringComparison.OrdinalIgnoreCase))
  2444. {
  2445. personEntity.SetProviderId(id.Key, id.Value);
  2446. saveEntity = true;
  2447. }
  2448. }
  2449. if (!string.IsNullOrWhiteSpace(person.ImageUrl) && !personEntity.HasImage(ImageType.Primary))
  2450. {
  2451. personEntity.SetImage(
  2452. new ItemImageInfo
  2453. {
  2454. Path = person.ImageUrl,
  2455. Type = ImageType.Primary
  2456. },
  2457. 0);
  2458. saveEntity = true;
  2459. itemUpdateType = ItemUpdateType.ImageUpdate;
  2460. }
  2461. if (saveEntity)
  2462. {
  2463. personsToSave.Add(personEntity);
  2464. await RunMetadataSavers(personEntity, itemUpdateType).ConfigureAwait(false);
  2465. }
  2466. }
  2467. if (personsToSave.Count > 0)
  2468. {
  2469. CreateItems(personsToSave, null, CancellationToken.None);
  2470. }
  2471. }
  2472. private void StartScanInBackground()
  2473. {
  2474. Task.Run(() =>
  2475. {
  2476. // No need to start if scanning the library because it will handle it
  2477. ValidateMediaLibrary(new SimpleProgress<double>(), CancellationToken.None);
  2478. });
  2479. }
  2480. public void AddMediaPath(string virtualFolderName, MediaPathInfo mediaPath)
  2481. {
  2482. AddMediaPathInternal(virtualFolderName, mediaPath, true);
  2483. }
  2484. private void AddMediaPathInternal(string virtualFolderName, MediaPathInfo pathInfo, bool saveLibraryOptions)
  2485. {
  2486. ArgumentNullException.ThrowIfNull(pathInfo);
  2487. var path = pathInfo.Path;
  2488. if (string.IsNullOrWhiteSpace(path))
  2489. {
  2490. throw new ArgumentException(nameof(path));
  2491. }
  2492. if (!Directory.Exists(path))
  2493. {
  2494. throw new FileNotFoundException("The path does not exist.");
  2495. }
  2496. var rootFolderPath = _configurationManager.ApplicationPaths.DefaultUserViewsPath;
  2497. var virtualFolderPath = Path.Combine(rootFolderPath, virtualFolderName);
  2498. var shortcutFilename = Path.GetFileNameWithoutExtension(path);
  2499. var lnk = Path.Combine(virtualFolderPath, shortcutFilename + ShortcutFileExtension);
  2500. while (File.Exists(lnk))
  2501. {
  2502. shortcutFilename += "1";
  2503. lnk = Path.Combine(virtualFolderPath, shortcutFilename + ShortcutFileExtension);
  2504. }
  2505. _fileSystem.CreateShortcut(lnk, _appHost.ReverseVirtualPath(path));
  2506. RemoveContentTypeOverrides(path);
  2507. if (saveLibraryOptions)
  2508. {
  2509. var libraryOptions = CollectionFolder.GetLibraryOptions(virtualFolderPath);
  2510. var list = libraryOptions.PathInfos.ToList();
  2511. list.Add(pathInfo);
  2512. libraryOptions.PathInfos = list.ToArray();
  2513. SyncLibraryOptionsToLocations(virtualFolderPath, libraryOptions);
  2514. CollectionFolder.SaveLibraryOptions(virtualFolderPath, libraryOptions);
  2515. }
  2516. }
  2517. public void UpdateMediaPath(string virtualFolderName, MediaPathInfo mediaPath)
  2518. {
  2519. ArgumentNullException.ThrowIfNull(mediaPath);
  2520. var rootFolderPath = _configurationManager.ApplicationPaths.DefaultUserViewsPath;
  2521. var virtualFolderPath = Path.Combine(rootFolderPath, virtualFolderName);
  2522. var libraryOptions = CollectionFolder.GetLibraryOptions(virtualFolderPath);
  2523. SyncLibraryOptionsToLocations(virtualFolderPath, libraryOptions);
  2524. var list = libraryOptions.PathInfos.ToList();
  2525. foreach (var originalPathInfo in list)
  2526. {
  2527. if (string.Equals(mediaPath.Path, originalPathInfo.Path, StringComparison.Ordinal))
  2528. {
  2529. originalPathInfo.NetworkPath = mediaPath.NetworkPath;
  2530. break;
  2531. }
  2532. }
  2533. libraryOptions.PathInfos = list.ToArray();
  2534. CollectionFolder.SaveLibraryOptions(virtualFolderPath, libraryOptions);
  2535. }
  2536. private void SyncLibraryOptionsToLocations(string virtualFolderPath, LibraryOptions options)
  2537. {
  2538. var topLibraryFolders = GetUserRootFolder().Children.ToList();
  2539. var info = GetVirtualFolderInfo(virtualFolderPath, topLibraryFolders, null);
  2540. if (info.Locations.Length > 0 && info.Locations.Length != options.PathInfos.Length)
  2541. {
  2542. var list = options.PathInfos.ToList();
  2543. foreach (var location in info.Locations)
  2544. {
  2545. if (!list.Any(i => string.Equals(i.Path, location, StringComparison.Ordinal)))
  2546. {
  2547. list.Add(new MediaPathInfo(location));
  2548. }
  2549. }
  2550. options.PathInfos = list.ToArray();
  2551. }
  2552. }
  2553. public async Task RemoveVirtualFolder(string name, bool refreshLibrary)
  2554. {
  2555. if (string.IsNullOrWhiteSpace(name))
  2556. {
  2557. throw new ArgumentNullException(nameof(name));
  2558. }
  2559. var rootFolderPath = _configurationManager.ApplicationPaths.DefaultUserViewsPath;
  2560. var path = Path.Combine(rootFolderPath, name);
  2561. if (!Directory.Exists(path))
  2562. {
  2563. throw new FileNotFoundException("The media folder does not exist");
  2564. }
  2565. LibraryMonitor.Stop();
  2566. try
  2567. {
  2568. Directory.Delete(path, true);
  2569. }
  2570. finally
  2571. {
  2572. CollectionFolder.OnCollectionFolderChange();
  2573. if (refreshLibrary)
  2574. {
  2575. await ValidateTopLibraryFolders(CancellationToken.None).ConfigureAwait(false);
  2576. StartScanInBackground();
  2577. }
  2578. else
  2579. {
  2580. // Need to add a delay here or directory watchers may still pick up the changes
  2581. await Task.Delay(1000).ConfigureAwait(false);
  2582. LibraryMonitor.Start();
  2583. }
  2584. }
  2585. }
  2586. private void RemoveContentTypeOverrides(string path)
  2587. {
  2588. if (string.IsNullOrWhiteSpace(path))
  2589. {
  2590. throw new ArgumentNullException(nameof(path));
  2591. }
  2592. var removeList = new List<NameValuePair>();
  2593. foreach (var contentType in _configurationManager.Configuration.ContentTypes)
  2594. {
  2595. if (string.IsNullOrWhiteSpace(contentType.Name))
  2596. {
  2597. removeList.Add(contentType);
  2598. }
  2599. else if (_fileSystem.AreEqual(path, contentType.Name)
  2600. || _fileSystem.ContainsSubPath(path, contentType.Name))
  2601. {
  2602. removeList.Add(contentType);
  2603. }
  2604. }
  2605. if (removeList.Count > 0)
  2606. {
  2607. _configurationManager.Configuration.ContentTypes = _configurationManager.Configuration.ContentTypes
  2608. .Except(removeList)
  2609. .ToArray();
  2610. _configurationManager.SaveConfiguration();
  2611. }
  2612. }
  2613. public void RemoveMediaPath(string virtualFolderName, string mediaPath)
  2614. {
  2615. ArgumentException.ThrowIfNullOrEmpty(mediaPath);
  2616. var rootFolderPath = _configurationManager.ApplicationPaths.DefaultUserViewsPath;
  2617. var virtualFolderPath = Path.Combine(rootFolderPath, virtualFolderName);
  2618. if (!Directory.Exists(virtualFolderPath))
  2619. {
  2620. throw new FileNotFoundException(
  2621. string.Format(CultureInfo.InvariantCulture, "The media collection {0} does not exist", virtualFolderName));
  2622. }
  2623. var shortcut = _fileSystem.GetFilePaths(virtualFolderPath, true)
  2624. .Where(i => string.Equals(ShortcutFileExtension, Path.GetExtension(i), StringComparison.OrdinalIgnoreCase))
  2625. .FirstOrDefault(f => _appHost.ExpandVirtualPath(_fileSystem.ResolveShortcut(f)).Equals(mediaPath, StringComparison.OrdinalIgnoreCase));
  2626. if (!string.IsNullOrEmpty(shortcut))
  2627. {
  2628. _fileSystem.DeleteFile(shortcut);
  2629. }
  2630. var libraryOptions = CollectionFolder.GetLibraryOptions(virtualFolderPath);
  2631. libraryOptions.PathInfos = libraryOptions
  2632. .PathInfos
  2633. .Where(i => !string.Equals(i.Path, mediaPath, StringComparison.Ordinal))
  2634. .ToArray();
  2635. CollectionFolder.SaveLibraryOptions(virtualFolderPath, libraryOptions);
  2636. }
  2637. }
  2638. }