LibraryManager.cs 107 KB

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