LibraryManager.cs 114 KB

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