LibraryManager.cs 112 KB

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