LibraryManager.cs 108 KB

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