LibraryManager.cs 112 KB

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