LibraryManager.cs 111 KB

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