LibraryManager.cs 113 KB

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