LibraryManager.cs 111 KB

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