2
0

LibraryManager.cs 111 KB

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