LibraryManager.cs 112 KB

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