LibraryManager.cs 92 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669
  1. using Interfaces.IO;
  2. using MediaBrowser.Common.Extensions;
  3. using MediaBrowser.Common.Progress;
  4. using MediaBrowser.Common.ScheduledTasks;
  5. using MediaBrowser.Controller.Configuration;
  6. using MediaBrowser.Controller.Entities;
  7. using MediaBrowser.Controller.Entities.Audio;
  8. using MediaBrowser.Controller.Entities.TV;
  9. using MediaBrowser.Controller.IO;
  10. using MediaBrowser.Controller.Library;
  11. using MediaBrowser.Controller.Persistence;
  12. using MediaBrowser.Controller.Providers;
  13. using MediaBrowser.Controller.Resolvers;
  14. using MediaBrowser.Controller.Sorting;
  15. using MediaBrowser.Model.Configuration;
  16. using MediaBrowser.Model.Entities;
  17. using MediaBrowser.Model.Logging;
  18. using MediaBrowser.Model.Querying;
  19. using MediaBrowser.Naming.Audio;
  20. using MediaBrowser.Naming.Common;
  21. using MediaBrowser.Naming.TV;
  22. using MediaBrowser.Naming.Video;
  23. using MediaBrowser.Server.Implementations.Library.Validators;
  24. using MediaBrowser.Server.Implementations.Logging;
  25. using MediaBrowser.Server.Implementations.ScheduledTasks;
  26. using System;
  27. using System.Collections.Concurrent;
  28. using System.Collections.Generic;
  29. using System.Globalization;
  30. using System.IO;
  31. using System.Linq;
  32. using System.Net;
  33. using System.Threading;
  34. using System.Threading.Tasks;
  35. using CommonIO;
  36. using MediaBrowser.Model.Extensions;
  37. using MediaBrowser.Model.Library;
  38. using MediaBrowser.Model.Net;
  39. using MediaBrowser.Server.Implementations.Library.Resolvers;
  40. using MoreLinq;
  41. using SortOrder = MediaBrowser.Model.Entities.SortOrder;
  42. using VideoResolver = MediaBrowser.Naming.Video.VideoResolver;
  43. namespace MediaBrowser.Server.Implementations.Library
  44. {
  45. /// <summary>
  46. /// Class LibraryManager
  47. /// </summary>
  48. public class LibraryManager : ILibraryManager
  49. {
  50. /// <summary>
  51. /// Gets or sets the postscan tasks.
  52. /// </summary>
  53. /// <value>The postscan tasks.</value>
  54. private ILibraryPostScanTask[] PostscanTasks { get; set; }
  55. /// <summary>
  56. /// Gets the intro providers.
  57. /// </summary>
  58. /// <value>The intro providers.</value>
  59. private IIntroProvider[] IntroProviders { get; set; }
  60. /// <summary>
  61. /// Gets the list of entity resolution ignore rules
  62. /// </summary>
  63. /// <value>The entity resolution ignore rules.</value>
  64. private IResolverIgnoreRule[] EntityResolutionIgnoreRules { get; set; }
  65. /// <summary>
  66. /// Gets the list of BasePluginFolders added by plugins
  67. /// </summary>
  68. /// <value>The plugin folders.</value>
  69. private IVirtualFolderCreator[] PluginFolderCreators { get; set; }
  70. /// <summary>
  71. /// Gets the list of currently registered entity resolvers
  72. /// </summary>
  73. /// <value>The entity resolvers enumerable.</value>
  74. private IItemResolver[] EntityResolvers { get; set; }
  75. private IMultiItemResolver[] MultiItemResolvers { get; set; }
  76. /// <summary>
  77. /// Gets or sets the comparers.
  78. /// </summary>
  79. /// <value>The comparers.</value>
  80. private IBaseItemComparer[] Comparers { get; set; }
  81. /// <summary>
  82. /// Gets the active item repository
  83. /// </summary>
  84. /// <value>The item repository.</value>
  85. public IItemRepository ItemRepository { get; set; }
  86. /// <summary>
  87. /// Occurs when [item added].
  88. /// </summary>
  89. public event EventHandler<ItemChangeEventArgs> ItemAdded;
  90. /// <summary>
  91. /// Occurs when [item updated].
  92. /// </summary>
  93. public event EventHandler<ItemChangeEventArgs> ItemUpdated;
  94. /// <summary>
  95. /// Occurs when [item removed].
  96. /// </summary>
  97. public event EventHandler<ItemChangeEventArgs> ItemRemoved;
  98. /// <summary>
  99. /// The _logger
  100. /// </summary>
  101. private readonly ILogger _logger;
  102. /// <summary>
  103. /// The _task manager
  104. /// </summary>
  105. private readonly ITaskManager _taskManager;
  106. /// <summary>
  107. /// The _user manager
  108. /// </summary>
  109. private readonly IUserManager _userManager;
  110. /// <summary>
  111. /// The _user data repository
  112. /// </summary>
  113. private readonly IUserDataManager _userDataRepository;
  114. /// <summary>
  115. /// Gets or sets the configuration manager.
  116. /// </summary>
  117. /// <value>The configuration manager.</value>
  118. private IServerConfigurationManager ConfigurationManager { get; set; }
  119. /// <summary>
  120. /// A collection of items that may be referenced from multiple physical places in the library
  121. /// (typically, multiple user roots). We store them here and be sure they all reference a
  122. /// single instance.
  123. /// </summary>
  124. /// <value>The by reference items.</value>
  125. private ConcurrentDictionary<Guid, BaseItem> ByReferenceItems { get; set; }
  126. private readonly Func<ILibraryMonitor> _libraryMonitorFactory;
  127. private readonly Func<IProviderManager> _providerManagerFactory;
  128. private readonly Func<IUserViewManager> _userviewManager;
  129. public bool IsScanRunning { get; private set; }
  130. /// <summary>
  131. /// The _library items cache
  132. /// </summary>
  133. private readonly ConcurrentDictionary<Guid, BaseItem> _libraryItemsCache;
  134. /// <summary>
  135. /// Gets the library items cache.
  136. /// </summary>
  137. /// <value>The library items cache.</value>
  138. private ConcurrentDictionary<Guid, BaseItem> LibraryItemsCache
  139. {
  140. get
  141. {
  142. return _libraryItemsCache;
  143. }
  144. }
  145. private readonly IFileSystem _fileSystem;
  146. /// <summary>
  147. /// Initializes a new instance of the <see cref="LibraryManager" /> class.
  148. /// </summary>
  149. /// <param name="logger">The logger.</param>
  150. /// <param name="taskManager">The task manager.</param>
  151. /// <param name="userManager">The user manager.</param>
  152. /// <param name="configurationManager">The configuration manager.</param>
  153. /// <param name="userDataRepository">The user data repository.</param>
  154. public LibraryManager(ILogger logger, ITaskManager taskManager, IUserManager userManager, IServerConfigurationManager configurationManager, IUserDataManager userDataRepository, Func<ILibraryMonitor> libraryMonitorFactory, IFileSystem fileSystem, Func<IProviderManager> providerManagerFactory, Func<IUserViewManager> userviewManager)
  155. {
  156. _logger = logger;
  157. _taskManager = taskManager;
  158. _userManager = userManager;
  159. ConfigurationManager = configurationManager;
  160. _userDataRepository = userDataRepository;
  161. _libraryMonitorFactory = libraryMonitorFactory;
  162. _fileSystem = fileSystem;
  163. _providerManagerFactory = providerManagerFactory;
  164. _userviewManager = userviewManager;
  165. ByReferenceItems = new ConcurrentDictionary<Guid, BaseItem>();
  166. _libraryItemsCache = new ConcurrentDictionary<Guid, BaseItem>();
  167. ConfigurationManager.ConfigurationUpdated += ConfigurationUpdated;
  168. RecordConfigurationValues(configurationManager.Configuration);
  169. }
  170. /// <summary>
  171. /// Adds the parts.
  172. /// </summary>
  173. /// <param name="rules">The rules.</param>
  174. /// <param name="pluginFolders">The plugin folders.</param>
  175. /// <param name="resolvers">The resolvers.</param>
  176. /// <param name="introProviders">The intro providers.</param>
  177. /// <param name="itemComparers">The item comparers.</param>
  178. /// <param name="postscanTasks">The postscan tasks.</param>
  179. public void AddParts(IEnumerable<IResolverIgnoreRule> rules,
  180. IEnumerable<IVirtualFolderCreator> pluginFolders,
  181. IEnumerable<IItemResolver> resolvers,
  182. IEnumerable<IIntroProvider> introProviders,
  183. IEnumerable<IBaseItemComparer> itemComparers,
  184. IEnumerable<ILibraryPostScanTask> postscanTasks)
  185. {
  186. EntityResolutionIgnoreRules = rules.ToArray();
  187. PluginFolderCreators = pluginFolders.ToArray();
  188. EntityResolvers = resolvers.OrderBy(i => i.Priority).ToArray();
  189. MultiItemResolvers = EntityResolvers.OfType<IMultiItemResolver>().ToArray();
  190. IntroProviders = introProviders.ToArray();
  191. Comparers = itemComparers.ToArray();
  192. PostscanTasks = postscanTasks.OrderBy(i =>
  193. {
  194. var hasOrder = i as IHasOrder;
  195. return hasOrder == null ? 0 : hasOrder.Order;
  196. }).ToArray();
  197. }
  198. /// <summary>
  199. /// The _root folder
  200. /// </summary>
  201. private volatile AggregateFolder _rootFolder;
  202. /// <summary>
  203. /// The _root folder sync lock
  204. /// </summary>
  205. private readonly object _rootFolderSyncLock = new object();
  206. /// <summary>
  207. /// Gets the root folder.
  208. /// </summary>
  209. /// <value>The root folder.</value>
  210. public AggregateFolder RootFolder
  211. {
  212. get
  213. {
  214. if (_rootFolder == null)
  215. {
  216. lock (_rootFolderSyncLock)
  217. {
  218. if (_rootFolder == null)
  219. {
  220. _rootFolder = CreateRootFolder();
  221. }
  222. }
  223. }
  224. return _rootFolder;
  225. }
  226. }
  227. /// <summary>
  228. /// The _season zero display name
  229. /// </summary>
  230. private string _seasonZeroDisplayName;
  231. private bool _wizardCompleted;
  232. /// <summary>
  233. /// Records the configuration values.
  234. /// </summary>
  235. /// <param name="configuration">The configuration.</param>
  236. private void RecordConfigurationValues(ServerConfiguration configuration)
  237. {
  238. _seasonZeroDisplayName = configuration.SeasonZeroDisplayName;
  239. _wizardCompleted = configuration.IsStartupWizardCompleted;
  240. }
  241. /// <summary>
  242. /// Configurations the updated.
  243. /// </summary>
  244. /// <param name="sender">The sender.</param>
  245. /// <param name="e">The <see cref="EventArgs" /> instance containing the event data.</param>
  246. void ConfigurationUpdated(object sender, EventArgs e)
  247. {
  248. var config = ConfigurationManager.Configuration;
  249. var newSeasonZeroName = ConfigurationManager.Configuration.SeasonZeroDisplayName;
  250. var seasonZeroNameChanged = !string.Equals(_seasonZeroDisplayName, newSeasonZeroName, StringComparison.Ordinal);
  251. var wizardChanged = config.IsStartupWizardCompleted != _wizardCompleted;
  252. RecordConfigurationValues(config);
  253. if (seasonZeroNameChanged || wizardChanged)
  254. {
  255. _taskManager.CancelIfRunningAndQueue<RefreshMediaLibraryTask>();
  256. }
  257. if (seasonZeroNameChanged)
  258. {
  259. Task.Run(async () =>
  260. {
  261. await UpdateSeasonZeroNames(newSeasonZeroName, CancellationToken.None).ConfigureAwait(false);
  262. });
  263. }
  264. }
  265. /// <summary>
  266. /// Updates the season zero names.
  267. /// </summary>
  268. /// <param name="newName">The new name.</param>
  269. /// <param name="cancellationToken">The cancellation token.</param>
  270. /// <returns>Task.</returns>
  271. private async Task UpdateSeasonZeroNames(string newName, CancellationToken cancellationToken)
  272. {
  273. var seasons = RootFolder.GetRecursiveChildren(i => i is Season)
  274. .Cast<Season>()
  275. .Where(i => i.IndexNumber.HasValue && i.IndexNumber.Value == 0 && !string.Equals(i.Name, newName, StringComparison.Ordinal))
  276. .ToList();
  277. foreach (var season in seasons)
  278. {
  279. season.Name = newName;
  280. try
  281. {
  282. await UpdateItem(season, ItemUpdateType.MetadataDownload, cancellationToken).ConfigureAwait(false);
  283. }
  284. catch (Exception ex)
  285. {
  286. _logger.ErrorException("Error saving {0}", ex, season.Path);
  287. }
  288. }
  289. }
  290. /// <summary>
  291. /// Updates the item in library cache.
  292. /// </summary>
  293. /// <param name="item">The item.</param>
  294. private void UpdateItemInLibraryCache(BaseItem item)
  295. {
  296. RegisterItem(item);
  297. }
  298. public void RegisterItem(BaseItem item)
  299. {
  300. if (item == null)
  301. {
  302. throw new ArgumentNullException("item");
  303. }
  304. RegisterItem(item.Id, item);
  305. }
  306. private void RegisterItem(Guid id, BaseItem item)
  307. {
  308. if (item.SourceType != SourceType.Library)
  309. {
  310. return;
  311. }
  312. if (item is IItemByName)
  313. {
  314. if (!(item is MusicArtist))
  315. {
  316. return;
  317. }
  318. }
  319. //if (!(item is Folder))
  320. //{
  321. // return;
  322. //}
  323. LibraryItemsCache.AddOrUpdate(id, item, delegate { return item; });
  324. }
  325. public async Task DeleteItem(BaseItem item, DeleteOptions options)
  326. {
  327. if (item == null)
  328. {
  329. throw new ArgumentNullException("item");
  330. }
  331. _logger.Debug("Deleting item, Type: {0}, Name: {1}, Path: {2}, Id: {3}",
  332. item.GetType().Name,
  333. item.Name ?? "Unknown name",
  334. item.Path ?? string.Empty,
  335. item.Id);
  336. var parent = item.Parent;
  337. var locationType = item.LocationType;
  338. var children = item.IsFolder
  339. ? ((Folder)item).GetRecursiveChildren().ToList()
  340. : new List<BaseItem>();
  341. foreach (var metadataPath in GetMetadataPaths(item, children))
  342. {
  343. _logger.Debug("Deleting path {0}", metadataPath);
  344. try
  345. {
  346. _fileSystem.DeleteDirectory(metadataPath, true);
  347. }
  348. catch (DirectoryNotFoundException)
  349. {
  350. }
  351. catch (Exception ex)
  352. {
  353. _logger.ErrorException("Error deleting {0}", ex, metadataPath);
  354. }
  355. }
  356. if (options.DeleteFileLocation && locationType != LocationType.Remote && locationType != LocationType.Virtual)
  357. {
  358. foreach (var path in item.GetDeletePaths().ToList())
  359. {
  360. if (_fileSystem.DirectoryExists(path))
  361. {
  362. _logger.Debug("Deleting path {0}", path);
  363. _fileSystem.DeleteDirectory(path, true);
  364. }
  365. else if (_fileSystem.FileExists(path))
  366. {
  367. _logger.Debug("Deleting path {0}", path);
  368. _fileSystem.DeleteFile(path);
  369. }
  370. }
  371. if (parent != null)
  372. {
  373. await parent.ValidateChildren(new Progress<double>(), CancellationToken.None)
  374. .ConfigureAwait(false);
  375. }
  376. }
  377. else if (parent != null)
  378. {
  379. parent.RemoveChild(item);
  380. }
  381. await ItemRepository.DeleteItem(item.Id, CancellationToken.None).ConfigureAwait(false);
  382. foreach (var child in children)
  383. {
  384. await ItemRepository.DeleteItem(child.Id, CancellationToken.None).ConfigureAwait(false);
  385. }
  386. BaseItem removed;
  387. _libraryItemsCache.TryRemove(item.Id, out removed);
  388. ReportItemRemoved(item);
  389. }
  390. private IEnumerable<string> GetMetadataPaths(BaseItem item, IEnumerable<BaseItem> children)
  391. {
  392. var list = new List<string>
  393. {
  394. item.GetInternalMetadataPath()
  395. };
  396. list.AddRange(children.Select(i => i.GetInternalMetadataPath()));
  397. return list;
  398. }
  399. /// <summary>
  400. /// Resolves the item.
  401. /// </summary>
  402. /// <param name="args">The args.</param>
  403. /// <param name="resolvers">The resolvers.</param>
  404. /// <returns>BaseItem.</returns>
  405. private BaseItem ResolveItem(ItemResolveArgs args, IItemResolver[] resolvers)
  406. {
  407. var item = (resolvers ?? EntityResolvers).Select(r => Resolve(args, r))
  408. .FirstOrDefault(i => i != null);
  409. if (item != null)
  410. {
  411. ResolverHelper.SetInitialItemValues(item, args, _fileSystem, this);
  412. }
  413. return item;
  414. }
  415. private BaseItem Resolve(ItemResolveArgs args, IItemResolver resolver)
  416. {
  417. try
  418. {
  419. return resolver.ResolvePath(args);
  420. }
  421. catch (Exception ex)
  422. {
  423. _logger.ErrorException("Error in {0} resolving {1}", ex, resolver.GetType().Name, args.Path);
  424. return null;
  425. }
  426. }
  427. public Guid GetNewItemId(string key, Type type)
  428. {
  429. if (string.IsNullOrWhiteSpace(key))
  430. {
  431. throw new ArgumentNullException("key");
  432. }
  433. if (type == null)
  434. {
  435. throw new ArgumentNullException("type");
  436. }
  437. if (ConfigurationManager.Configuration.EnableLocalizedGuids && key.StartsWith(ConfigurationManager.ApplicationPaths.ProgramDataPath))
  438. {
  439. // Try to normalize paths located underneath program-data in an attempt to make them more portable
  440. key = key.Substring(ConfigurationManager.ApplicationPaths.ProgramDataPath.Length)
  441. .TrimStart(new[] { '/', '\\' })
  442. .Replace("/", "\\");
  443. }
  444. if (!ConfigurationManager.Configuration.EnableCaseSensitiveItemIds)
  445. {
  446. key = key.ToLower();
  447. }
  448. key = type.FullName + key;
  449. return key.GetMD5();
  450. }
  451. public IEnumerable<BaseItem> ReplaceVideosWithPrimaryVersions(IEnumerable<BaseItem> items)
  452. {
  453. if (items == null)
  454. {
  455. throw new ArgumentNullException("items");
  456. }
  457. return items.DistinctBy(i => i.PresentationUniqueKey, StringComparer.OrdinalIgnoreCase);
  458. }
  459. /// <summary>
  460. /// Ensure supplied item has only one instance throughout
  461. /// </summary>
  462. /// <param name="item">The item.</param>
  463. /// <returns>The proper instance to the item</returns>
  464. public BaseItem GetOrAddByReferenceItem(BaseItem item)
  465. {
  466. // Add this item to our list if not there already
  467. if (!ByReferenceItems.TryAdd(item.Id, item))
  468. {
  469. // Already there - return the existing reference
  470. item = ByReferenceItems[item.Id];
  471. }
  472. return item;
  473. }
  474. public BaseItem ResolvePath(FileSystemMetadata fileInfo,
  475. Folder parent = null)
  476. {
  477. return ResolvePath(fileInfo, new DirectoryService(_logger, _fileSystem), null, parent);
  478. }
  479. private BaseItem ResolvePath(FileSystemMetadata fileInfo, IDirectoryService directoryService, IItemResolver[] resolvers, Folder parent = null, string collectionType = null)
  480. {
  481. if (fileInfo == null)
  482. {
  483. throw new ArgumentNullException("fileInfo");
  484. }
  485. var fullPath = fileInfo.FullName;
  486. if (string.IsNullOrWhiteSpace(collectionType) && parent != null)
  487. {
  488. collectionType = GetContentTypeOverride(fullPath, true);
  489. }
  490. var args = new ItemResolveArgs(ConfigurationManager.ApplicationPaths, directoryService)
  491. {
  492. Parent = parent,
  493. Path = fullPath,
  494. FileInfo = fileInfo,
  495. CollectionType = collectionType
  496. };
  497. // Return null if ignore rules deem that we should do so
  498. if (IgnoreFile(args.FileInfo, args.Parent))
  499. {
  500. return null;
  501. }
  502. // Gather child folder and files
  503. if (args.IsDirectory)
  504. {
  505. var isPhysicalRoot = args.IsPhysicalRoot;
  506. // When resolving the root, we need it's grandchildren (children of user views)
  507. var flattenFolderDepth = isPhysicalRoot ? 2 : 0;
  508. var fileSystemDictionary = FileData.GetFilteredFileSystemEntries(directoryService, args.Path, _fileSystem, _logger, args, flattenFolderDepth: flattenFolderDepth, resolveShortcuts: isPhysicalRoot || args.IsVf);
  509. // Need to remove subpaths that may have been resolved from shortcuts
  510. // Example: if \\server\movies exists, then strip out \\server\movies\action
  511. if (isPhysicalRoot)
  512. {
  513. var paths = NormalizeRootPathList(fileSystemDictionary.Values);
  514. fileSystemDictionary = paths.ToDictionary(i => i.FullName);
  515. }
  516. args.FileSystemDictionary = fileSystemDictionary;
  517. }
  518. // Check to see if we should resolve based on our contents
  519. if (args.IsDirectory && !ShouldResolvePathContents(args))
  520. {
  521. return null;
  522. }
  523. return ResolveItem(args, resolvers);
  524. }
  525. public bool IgnoreFile(FileSystemMetadata file, BaseItem parent)
  526. {
  527. return EntityResolutionIgnoreRules.Any(r => r.ShouldIgnore(file, parent));
  528. }
  529. public IEnumerable<FileSystemMetadata> NormalizeRootPathList(IEnumerable<FileSystemMetadata> paths)
  530. {
  531. var originalList = paths.ToList();
  532. var list = originalList.Where(i => i.IsDirectory)
  533. .Select(i => _fileSystem.NormalizePath(i.FullName))
  534. .Distinct(StringComparer.OrdinalIgnoreCase)
  535. .ToList();
  536. var dupes = list.Where(subPath => !subPath.EndsWith(":\\", StringComparison.OrdinalIgnoreCase) && list.Any(i => _fileSystem.ContainsSubPath(i, subPath)))
  537. .ToList();
  538. foreach (var dupe in dupes)
  539. {
  540. _logger.Info("Found duplicate path: {0}", dupe);
  541. }
  542. var newList = list.Except(dupes, StringComparer.OrdinalIgnoreCase).Select(_fileSystem.GetDirectoryInfo).ToList();
  543. newList.AddRange(originalList.Where(i => !i.IsDirectory));
  544. return newList;
  545. }
  546. /// <summary>
  547. /// Determines whether a path should be ignored based on its contents - called after the contents have been read
  548. /// </summary>
  549. /// <param name="args">The args.</param>
  550. /// <returns><c>true</c> if XXXX, <c>false</c> otherwise</returns>
  551. private static bool ShouldResolvePathContents(ItemResolveArgs args)
  552. {
  553. // Ignore any folders containing a file called .ignore
  554. return !args.ContainsFileSystemEntryByName(".ignore");
  555. }
  556. public IEnumerable<BaseItem> ResolvePaths(IEnumerable<FileSystemMetadata> files, IDirectoryService directoryService, Folder parent, string collectionType)
  557. {
  558. return ResolvePaths(files, directoryService, parent, collectionType, EntityResolvers);
  559. }
  560. public IEnumerable<BaseItem> ResolvePaths(IEnumerable<FileSystemMetadata> files, IDirectoryService directoryService, Folder parent, string collectionType, IItemResolver[] resolvers)
  561. {
  562. var fileList = files.Where(i => !IgnoreFile(i, parent)).ToList();
  563. if (parent != null)
  564. {
  565. var multiItemResolvers = resolvers == null ? MultiItemResolvers : resolvers.OfType<IMultiItemResolver>().ToArray();
  566. foreach (var resolver in multiItemResolvers)
  567. {
  568. var result = resolver.ResolveMultiple(parent, fileList, collectionType, directoryService);
  569. if (result != null && result.Items.Count > 0)
  570. {
  571. var items = new List<BaseItem>();
  572. items.AddRange(result.Items);
  573. foreach (var item in items)
  574. {
  575. ResolverHelper.SetInitialItemValues(item, parent, _fileSystem, this, directoryService);
  576. }
  577. items.AddRange(ResolveFileList(result.ExtraFiles, directoryService, parent, collectionType, resolvers));
  578. return items;
  579. }
  580. }
  581. }
  582. return ResolveFileList(fileList, directoryService, parent, collectionType, resolvers);
  583. }
  584. private IEnumerable<BaseItem> ResolveFileList(IEnumerable<FileSystemMetadata> fileList, IDirectoryService directoryService, Folder parent, string collectionType, IItemResolver[] resolvers)
  585. {
  586. return fileList.Select(f =>
  587. {
  588. try
  589. {
  590. return ResolvePath(f, directoryService, resolvers, parent, collectionType);
  591. }
  592. catch (Exception ex)
  593. {
  594. _logger.ErrorException("Error resolving path {0}", ex, f.FullName);
  595. return null;
  596. }
  597. }).Where(i => i != null);
  598. }
  599. /// <summary>
  600. /// Creates the root media folder
  601. /// </summary>
  602. /// <returns>AggregateFolder.</returns>
  603. /// <exception cref="System.InvalidOperationException">Cannot create the root folder until plugins have loaded</exception>
  604. public AggregateFolder CreateRootFolder()
  605. {
  606. var rootFolderPath = ConfigurationManager.ApplicationPaths.RootFolderPath;
  607. _fileSystem.CreateDirectory(rootFolderPath);
  608. var rootFolder = GetItemById(GetNewItemId(rootFolderPath, typeof(AggregateFolder))) as AggregateFolder ?? (AggregateFolder)ResolvePath(_fileSystem.GetDirectoryInfo(rootFolderPath));
  609. // Add in the plug-in folders
  610. foreach (var child in PluginFolderCreators)
  611. {
  612. var folder = child.GetFolder();
  613. if (folder != null)
  614. {
  615. if (folder.Id == Guid.Empty)
  616. {
  617. if (string.IsNullOrWhiteSpace(folder.Path))
  618. {
  619. folder.Id = GetNewItemId(folder.GetType().Name, folder.GetType());
  620. }
  621. else
  622. {
  623. folder.Id = GetNewItemId(folder.Path, folder.GetType());
  624. }
  625. }
  626. var dbItem = GetItemById(folder.Id) as BasePluginFolder;
  627. if (dbItem != null && string.Equals(dbItem.Path, folder.Path, StringComparison.OrdinalIgnoreCase))
  628. {
  629. folder = dbItem;
  630. }
  631. if (folder.ParentId != rootFolder.Id)
  632. {
  633. folder.ParentId = rootFolder.Id;
  634. var task = folder.UpdateToRepository(ItemUpdateType.MetadataImport, CancellationToken.None);
  635. Task.WaitAll(task);
  636. }
  637. rootFolder.AddVirtualChild(folder);
  638. RegisterItem(folder);
  639. }
  640. }
  641. return rootFolder;
  642. }
  643. private volatile UserRootFolder _userRootFolder;
  644. private readonly object _syncLock = new object();
  645. public Folder GetUserRootFolder()
  646. {
  647. if (_userRootFolder == null)
  648. {
  649. lock (_syncLock)
  650. {
  651. if (_userRootFolder == null)
  652. {
  653. var userRootPath = ConfigurationManager.ApplicationPaths.DefaultUserViewsPath;
  654. _fileSystem.CreateDirectory(userRootPath);
  655. var tmpItem = GetItemById(GetNewItemId(userRootPath, typeof(UserRootFolder))) as UserRootFolder;
  656. if (tmpItem == null)
  657. {
  658. tmpItem = (UserRootFolder)ResolvePath(_fileSystem.GetDirectoryInfo(userRootPath));
  659. }
  660. _userRootFolder = tmpItem;
  661. }
  662. }
  663. }
  664. return _userRootFolder;
  665. }
  666. public BaseItem FindByPath(string path, bool? isFolder)
  667. {
  668. var query = new InternalItemsQuery
  669. {
  670. Path = path,
  671. IsFolder = isFolder
  672. };
  673. // Only use the database result if there's exactly one item, otherwise we run the risk of returning old data that hasn't been cleaned yet.
  674. var items = GetItemIds(query).Select(GetItemById).Where(i => i != null).ToArray();
  675. if (items.Length == 1)
  676. {
  677. return items[0];
  678. }
  679. if (items.Length == 0)
  680. {
  681. return null;
  682. }
  683. return RootFolder.FindByPath(path);
  684. }
  685. /// <summary>
  686. /// Gets a Person
  687. /// </summary>
  688. /// <param name="name">The name.</param>
  689. /// <returns>Task{Person}.</returns>
  690. public Person GetPerson(string name)
  691. {
  692. return GetItemByName<Person>(ConfigurationManager.ApplicationPaths.PeoplePath, name);
  693. }
  694. /// <summary>
  695. /// Gets a Studio
  696. /// </summary>
  697. /// <param name="name">The name.</param>
  698. /// <returns>Task{Studio}.</returns>
  699. public Studio GetStudio(string name)
  700. {
  701. return GetItemByName<Studio>(ConfigurationManager.ApplicationPaths.StudioPath, name);
  702. }
  703. /// <summary>
  704. /// Gets a Genre
  705. /// </summary>
  706. /// <param name="name">The name.</param>
  707. /// <returns>Task{Genre}.</returns>
  708. public Genre GetGenre(string name)
  709. {
  710. return GetItemByName<Genre>(ConfigurationManager.ApplicationPaths.GenrePath, name);
  711. }
  712. /// <summary>
  713. /// Gets the genre.
  714. /// </summary>
  715. /// <param name="name">The name.</param>
  716. /// <returns>Task{MusicGenre}.</returns>
  717. public MusicGenre GetMusicGenre(string name)
  718. {
  719. return GetItemByName<MusicGenre>(ConfigurationManager.ApplicationPaths.MusicGenrePath, name);
  720. }
  721. /// <summary>
  722. /// Gets the game genre.
  723. /// </summary>
  724. /// <param name="name">The name.</param>
  725. /// <returns>Task{GameGenre}.</returns>
  726. public GameGenre GetGameGenre(string name)
  727. {
  728. return GetItemByName<GameGenre>(ConfigurationManager.ApplicationPaths.GameGenrePath, name);
  729. }
  730. /// <summary>
  731. /// The us culture
  732. /// </summary>
  733. private static readonly CultureInfo UsCulture = new CultureInfo("en-US");
  734. /// <summary>
  735. /// Gets a Year
  736. /// </summary>
  737. /// <param name="value">The value.</param>
  738. /// <returns>Task{Year}.</returns>
  739. /// <exception cref="System.ArgumentOutOfRangeException"></exception>
  740. public Year GetYear(int value)
  741. {
  742. if (value <= 0)
  743. {
  744. throw new ArgumentOutOfRangeException("Years less than or equal to 0 are invalid.");
  745. }
  746. return GetItemByName<Year>(ConfigurationManager.ApplicationPaths.YearPath, value.ToString(UsCulture));
  747. }
  748. /// <summary>
  749. /// Gets the artists path.
  750. /// </summary>
  751. /// <value>The artists path.</value>
  752. public string ArtistsPath
  753. {
  754. get
  755. {
  756. return Path.Combine(ConfigurationManager.ApplicationPaths.ItemsByNamePath, "artists");
  757. }
  758. }
  759. /// <summary>
  760. /// Gets a Genre
  761. /// </summary>
  762. /// <param name="name">The name.</param>
  763. /// <returns>Task{Genre}.</returns>
  764. public MusicArtist GetArtist(string name)
  765. {
  766. return GetItemByName<MusicArtist>(ArtistsPath, name);
  767. }
  768. private T GetItemByName<T>(string path, string name)
  769. where T : BaseItem, new()
  770. {
  771. if (string.IsNullOrWhiteSpace(path))
  772. {
  773. throw new ArgumentNullException("path");
  774. }
  775. if (string.IsNullOrWhiteSpace(name))
  776. {
  777. throw new ArgumentNullException("name");
  778. }
  779. var validFilename = _fileSystem.GetValidFilename(name).Trim();
  780. string subFolderPrefix = null;
  781. var type = typeof(T);
  782. if (type == typeof(Person))
  783. {
  784. var subFolderIndex = 0;
  785. while (!char.IsLetterOrDigit(validFilename[subFolderIndex]))
  786. {
  787. subFolderIndex++;
  788. }
  789. subFolderPrefix = validFilename.Substring(subFolderIndex, 1);
  790. }
  791. var fullPath = string.IsNullOrEmpty(subFolderPrefix) ?
  792. Path.Combine(path, validFilename) :
  793. Path.Combine(path, subFolderPrefix, validFilename);
  794. var id = GetNewItemId(fullPath, type);
  795. BaseItem obj;
  796. if (!_libraryItemsCache.TryGetValue(id, out obj))
  797. {
  798. obj = CreateItemByName<T>(fullPath, name, id);
  799. RegisterItem(id, obj);
  800. }
  801. return obj as T;
  802. }
  803. private T CreateItemByName<T>(string path, string name, Guid id)
  804. where T : BaseItem, new()
  805. {
  806. var isArtist = typeof(T) == typeof(MusicArtist);
  807. if (isArtist)
  808. {
  809. var existing = GetItemList(new InternalItemsQuery
  810. {
  811. IncludeItemTypes = new[] { typeof(T).Name },
  812. Name = name
  813. }).Cast<MusicArtist>()
  814. .Where(i => !i.IsAccessedByName)
  815. .Cast<T>()
  816. .FirstOrDefault();
  817. if (existing != null)
  818. {
  819. return existing;
  820. }
  821. }
  822. var item = GetItemById(id) as T;
  823. if (item == null)
  824. {
  825. item = new T
  826. {
  827. Name = name,
  828. Id = id,
  829. DateCreated = DateTime.UtcNow,
  830. DateModified = DateTime.UtcNow,
  831. Path = path
  832. };
  833. if (isArtist)
  834. {
  835. (item as MusicArtist).IsAccessedByName = true;
  836. }
  837. var task = CreateItem(item, CancellationToken.None);
  838. Task.WaitAll(task);
  839. }
  840. return item;
  841. }
  842. public IEnumerable<MusicArtist> GetAlbumArtists(IEnumerable<IHasAlbumArtist> items)
  843. {
  844. var names = items
  845. .SelectMany(i => i.AlbumArtists)
  846. .DistinctNames()
  847. .Select(i =>
  848. {
  849. try
  850. {
  851. var artist = GetArtist(i);
  852. return artist;
  853. }
  854. catch
  855. {
  856. // Already logged at lower levels
  857. return null;
  858. }
  859. })
  860. .Where(i => i != null);
  861. return names;
  862. }
  863. public IEnumerable<MusicArtist> GetArtists(IEnumerable<IHasArtist> items)
  864. {
  865. var names = items
  866. .SelectMany(i => i.AllArtists)
  867. .DistinctNames()
  868. .Select(i =>
  869. {
  870. try
  871. {
  872. var artist = GetArtist(i);
  873. return artist;
  874. }
  875. catch
  876. {
  877. // Already logged at lower levels
  878. return null;
  879. }
  880. })
  881. .Where(i => i != null);
  882. return names;
  883. }
  884. /// <summary>
  885. /// Validate and refresh the People sub-set of the IBN.
  886. /// The items are stored in the db but not loaded into memory until actually requested by an operation.
  887. /// </summary>
  888. /// <param name="cancellationToken">The cancellation token.</param>
  889. /// <param name="progress">The progress.</param>
  890. /// <returns>Task.</returns>
  891. public Task ValidatePeople(CancellationToken cancellationToken, IProgress<double> progress)
  892. {
  893. // Ensure the location is available.
  894. _fileSystem.CreateDirectory(ConfigurationManager.ApplicationPaths.PeoplePath);
  895. return new PeopleValidator(this, _logger, ConfigurationManager, _fileSystem).ValidatePeople(cancellationToken, progress);
  896. }
  897. /// <summary>
  898. /// Reloads the root media folder
  899. /// </summary>
  900. /// <param name="progress">The progress.</param>
  901. /// <param name="cancellationToken">The cancellation token.</param>
  902. /// <returns>Task.</returns>
  903. public Task ValidateMediaLibrary(IProgress<double> progress, CancellationToken cancellationToken)
  904. {
  905. // Just run the scheduled task so that the user can see it
  906. _taskManager.CancelIfRunningAndQueue<RefreshMediaLibraryTask>();
  907. return Task.FromResult(true);
  908. }
  909. /// <summary>
  910. /// Queues the library scan.
  911. /// </summary>
  912. public void QueueLibraryScan()
  913. {
  914. // Just run the scheduled task so that the user can see it
  915. _taskManager.QueueScheduledTask<RefreshMediaLibraryTask>();
  916. }
  917. /// <summary>
  918. /// Validates the media library internal.
  919. /// </summary>
  920. /// <param name="progress">The progress.</param>
  921. /// <param name="cancellationToken">The cancellation token.</param>
  922. /// <returns>Task.</returns>
  923. public async Task ValidateMediaLibraryInternal(IProgress<double> progress, CancellationToken cancellationToken)
  924. {
  925. IsScanRunning = true;
  926. _libraryMonitorFactory().Stop();
  927. try
  928. {
  929. await PerformLibraryValidation(progress, cancellationToken).ConfigureAwait(false);
  930. }
  931. finally
  932. {
  933. _libraryMonitorFactory().Start();
  934. IsScanRunning = false;
  935. }
  936. }
  937. private async Task PerformLibraryValidation(IProgress<double> progress, CancellationToken cancellationToken)
  938. {
  939. _logger.Info("Validating media library");
  940. await RootFolder.RefreshMetadata(cancellationToken).ConfigureAwait(false);
  941. progress.Report(.5);
  942. // Start by just validating the children of the root, but go no further
  943. await RootFolder.ValidateChildren(new Progress<double>(), cancellationToken, new MetadataRefreshOptions(_fileSystem), recursive: false);
  944. progress.Report(1);
  945. var userRoot = GetUserRootFolder();
  946. await userRoot.RefreshMetadata(cancellationToken).ConfigureAwait(false);
  947. await userRoot.ValidateChildren(new Progress<double>(), cancellationToken, new MetadataRefreshOptions(_fileSystem), recursive: false).ConfigureAwait(false);
  948. progress.Report(2);
  949. var innerProgress = new ActionableProgress<double>();
  950. innerProgress.RegisterAction(pct => progress.Report(2 + pct * .73));
  951. // Now validate the entire media library
  952. await RootFolder.ValidateChildren(innerProgress, cancellationToken, new MetadataRefreshOptions(_fileSystem), recursive: true).ConfigureAwait(false);
  953. progress.Report(75);
  954. innerProgress = new ActionableProgress<double>();
  955. innerProgress.RegisterAction(pct => progress.Report(75 + pct * .25));
  956. // Run post-scan tasks
  957. await RunPostScanTasks(innerProgress, cancellationToken).ConfigureAwait(false);
  958. progress.Report(100);
  959. // Bad practice, i know. But we keep a lot in memory, unfortunately.
  960. GC.Collect(2, GCCollectionMode.Forced, true);
  961. GC.Collect(2, GCCollectionMode.Forced, true);
  962. }
  963. /// <summary>
  964. /// Runs the post scan tasks.
  965. /// </summary>
  966. /// <param name="progress">The progress.</param>
  967. /// <param name="cancellationToken">The cancellation token.</param>
  968. /// <returns>Task.</returns>
  969. private async Task RunPostScanTasks(IProgress<double> progress, CancellationToken cancellationToken)
  970. {
  971. var tasks = PostscanTasks.ToList();
  972. var numComplete = 0;
  973. var numTasks = tasks.Count;
  974. foreach (var task in tasks)
  975. {
  976. var innerProgress = new ActionableProgress<double>();
  977. // Prevent access to modified closure
  978. var currentNumComplete = numComplete;
  979. innerProgress.RegisterAction(pct =>
  980. {
  981. double innerPercent = currentNumComplete * 100 + pct;
  982. innerPercent /= numTasks;
  983. progress.Report(innerPercent);
  984. });
  985. _logger.Debug("Running post-scan task {0}", task.GetType().Name);
  986. try
  987. {
  988. await task.Run(innerProgress, cancellationToken).ConfigureAwait(false);
  989. }
  990. catch (OperationCanceledException)
  991. {
  992. _logger.Info("Post-scan task cancelled: {0}", task.GetType().Name);
  993. }
  994. catch (Exception ex)
  995. {
  996. _logger.ErrorException("Error running postscan task", ex);
  997. }
  998. numComplete++;
  999. double percent = numComplete;
  1000. percent /= numTasks;
  1001. progress.Report(percent * 100);
  1002. }
  1003. progress.Report(100);
  1004. }
  1005. /// <summary>
  1006. /// Gets the default view.
  1007. /// </summary>
  1008. /// <returns>IEnumerable{VirtualFolderInfo}.</returns>
  1009. public IEnumerable<VirtualFolderInfo> GetVirtualFolders()
  1010. {
  1011. return GetView(ConfigurationManager.ApplicationPaths.DefaultUserViewsPath);
  1012. }
  1013. /// <summary>
  1014. /// Gets the view.
  1015. /// </summary>
  1016. /// <param name="path">The path.</param>
  1017. /// <returns>IEnumerable{VirtualFolderInfo}.</returns>
  1018. private IEnumerable<VirtualFolderInfo> GetView(string path)
  1019. {
  1020. var topLibraryFolders = GetUserRootFolder().Children.ToList();
  1021. return _fileSystem.GetDirectoryPaths(path)
  1022. .Select(dir => GetVirtualFolderInfo(dir, topLibraryFolders));
  1023. }
  1024. private VirtualFolderInfo GetVirtualFolderInfo(string dir, List<BaseItem> collectionFolders)
  1025. {
  1026. var info = new VirtualFolderInfo
  1027. {
  1028. Name = Path.GetFileName(dir),
  1029. Locations = Directory.EnumerateFiles(dir, "*.mblink", SearchOption.TopDirectoryOnly)
  1030. .Select(_fileSystem.ResolveShortcut)
  1031. .OrderBy(i => i)
  1032. .ToList(),
  1033. CollectionType = GetCollectionType(dir)
  1034. };
  1035. var libraryFolder = collectionFolders.FirstOrDefault(i => string.Equals(i.Path, dir, StringComparison.OrdinalIgnoreCase));
  1036. if (libraryFolder != null && libraryFolder.HasImage(ImageType.Primary))
  1037. {
  1038. info.PrimaryImageItemId = libraryFolder.Id.ToString("N");
  1039. }
  1040. if (libraryFolder != null)
  1041. {
  1042. info.ItemId = libraryFolder.Id.ToString("N");
  1043. }
  1044. return info;
  1045. }
  1046. private string GetCollectionType(string path)
  1047. {
  1048. return _fileSystem.GetFiles(path, false)
  1049. .Where(i => string.Equals(i.Extension, ".collection", StringComparison.OrdinalIgnoreCase))
  1050. .Select(i => _fileSystem.GetFileNameWithoutExtension(i))
  1051. .FirstOrDefault();
  1052. }
  1053. /// <summary>
  1054. /// Gets the item by id.
  1055. /// </summary>
  1056. /// <param name="id">The id.</param>
  1057. /// <returns>BaseItem.</returns>
  1058. /// <exception cref="System.ArgumentNullException">id</exception>
  1059. public BaseItem GetItemById(Guid id)
  1060. {
  1061. if (id == Guid.Empty)
  1062. {
  1063. throw new ArgumentNullException("id");
  1064. }
  1065. BaseItem item;
  1066. if (LibraryItemsCache.TryGetValue(id, out item))
  1067. {
  1068. return item;
  1069. }
  1070. item = RetrieveItem(id);
  1071. if (item != null)
  1072. {
  1073. RegisterItem(item);
  1074. }
  1075. return item;
  1076. }
  1077. public BaseItem GetMemoryItemById(Guid id)
  1078. {
  1079. if (id == Guid.Empty)
  1080. {
  1081. throw new ArgumentNullException("id");
  1082. }
  1083. BaseItem item;
  1084. LibraryItemsCache.TryGetValue(id, out item);
  1085. return item;
  1086. }
  1087. public IEnumerable<BaseItem> GetItemList(InternalItemsQuery query)
  1088. {
  1089. if (query.User != null)
  1090. {
  1091. AddUserToQuery(query, query.User);
  1092. }
  1093. var result = ItemRepository.GetItemIdsList(query);
  1094. return result.Select(GetItemById).Where(i => i != null);
  1095. }
  1096. public QueryResult<BaseItem> QueryItems(InternalItemsQuery query)
  1097. {
  1098. if (query.User != null)
  1099. {
  1100. AddUserToQuery(query, query.User);
  1101. }
  1102. return ItemRepository.GetItems(query);
  1103. }
  1104. public List<Guid> GetItemIds(InternalItemsQuery query)
  1105. {
  1106. if (query.User != null)
  1107. {
  1108. AddUserToQuery(query, query.User);
  1109. }
  1110. return ItemRepository.GetItemIdsList(query);
  1111. }
  1112. public IEnumerable<BaseItem> GetItemList(InternalItemsQuery query, IEnumerable<string> parentIds)
  1113. {
  1114. var parents = parentIds.Select(i => GetItemById(new Guid(i))).Where(i => i != null).ToList();
  1115. SetTopParentIdsOrAncestors(query, parents);
  1116. return GetItemIds(query).Select(GetItemById).Where(i => i != null);
  1117. }
  1118. public QueryResult<BaseItem> GetItemsResult(InternalItemsQuery query)
  1119. {
  1120. if (query.Recursive && query.ParentId.HasValue)
  1121. {
  1122. var parent = GetItemById(query.ParentId.Value);
  1123. if (parent != null)
  1124. {
  1125. SetTopParentIdsOrAncestors(query, new List<BaseItem> { parent });
  1126. query.ParentId = null;
  1127. }
  1128. }
  1129. if (query.User != null)
  1130. {
  1131. AddUserToQuery(query, query.User);
  1132. }
  1133. var initialResult = ItemRepository.GetItemIds(query);
  1134. return new QueryResult<BaseItem>
  1135. {
  1136. TotalRecordCount = initialResult.TotalRecordCount,
  1137. Items = initialResult.Items.Select(GetItemById).Where(i => i != null).ToArray()
  1138. };
  1139. }
  1140. public QueryResult<BaseItem> GetItemsResult(InternalItemsQuery query, IEnumerable<string> parentIds)
  1141. {
  1142. var parents = parentIds.Select(i => GetItemById(new Guid(i))).Where(i => i != null).ToList();
  1143. SetTopParentIdsOrAncestors(query, parents);
  1144. return GetItemsResult(query);
  1145. }
  1146. private void SetTopParentIdsOrAncestors(InternalItemsQuery query, List<BaseItem> parents)
  1147. {
  1148. if (parents.All(i =>
  1149. {
  1150. if (i is ICollectionFolder || i is UserView)
  1151. {
  1152. return true;
  1153. }
  1154. _logger.Debug("Query requires ancestor query due to type: " + i.GetType().Name);
  1155. return false;
  1156. }))
  1157. {
  1158. // Optimize by querying against top level views
  1159. query.TopParentIds = parents.SelectMany(i => GetTopParentsForQuery(i, query.User)).Select(i => i.Id.ToString("N")).ToArray();
  1160. }
  1161. else
  1162. {
  1163. // We need to be able to query from any arbitrary ancestor up the tree
  1164. query.AncestorIds = parents.SelectMany(i => i.GetIdsForAncestorQuery()).Select(i => i.ToString("N")).ToArray();
  1165. }
  1166. }
  1167. private void AddUserToQuery(InternalItemsQuery query, User user)
  1168. {
  1169. if (query.AncestorIds.Length == 0 && !query.ParentId.HasValue && query.ChannelIds.Length == 0 && query.TopParentIds.Length == 0)
  1170. {
  1171. var userViews = _userviewManager().GetUserViews(new UserViewQuery
  1172. {
  1173. UserId = user.Id.ToString("N"),
  1174. IncludeHidden = true
  1175. }, CancellationToken.None).Result.ToList();
  1176. query.TopParentIds = userViews.SelectMany(i => GetTopParentsForQuery(i, user)).Select(i => i.Id.ToString("N")).ToArray();
  1177. }
  1178. }
  1179. private IEnumerable<BaseItem> GetTopParentsForQuery(BaseItem item, User user)
  1180. {
  1181. var view = item as UserView;
  1182. if (view != null)
  1183. {
  1184. if (string.Equals(view.ViewType, CollectionType.LiveTv))
  1185. {
  1186. return new[] { view };
  1187. }
  1188. if (string.Equals(view.ViewType, CollectionType.Channels))
  1189. {
  1190. // TODO: Return channels
  1191. return new[] { view };
  1192. }
  1193. // Translate view into folders
  1194. if (view.DisplayParentId != Guid.Empty)
  1195. {
  1196. var displayParent = GetItemById(view.DisplayParentId);
  1197. if (displayParent != null)
  1198. {
  1199. return GetTopParentsForQuery(displayParent, user);
  1200. }
  1201. return new BaseItem[] { };
  1202. }
  1203. if (view.ParentId != Guid.Empty)
  1204. {
  1205. var displayParent = GetItemById(view.ParentId);
  1206. if (displayParent != null)
  1207. {
  1208. return GetTopParentsForQuery(displayParent, user);
  1209. }
  1210. return new BaseItem[] { };
  1211. }
  1212. // Handle grouping
  1213. if (user != null && !string.IsNullOrWhiteSpace(view.ViewType) && UserView.IsEligibleForGrouping(view.ViewType))
  1214. {
  1215. var collectionFolders = user.RootFolder.GetChildren(user, true).OfType<CollectionFolder>().Where(i => string.IsNullOrWhiteSpace(i.CollectionType) || string.Equals(i.CollectionType, view.ViewType, StringComparison.OrdinalIgnoreCase));
  1216. return collectionFolders.SelectMany(i => GetTopParentsForQuery(i, user));
  1217. }
  1218. return new BaseItem[] { };
  1219. }
  1220. var collectionFolder = item as CollectionFolder;
  1221. if (collectionFolder != null)
  1222. {
  1223. return collectionFolder.GetPhysicalParents();
  1224. }
  1225. var topParent = item.GetTopParent();
  1226. if (topParent != null)
  1227. {
  1228. return new[] { topParent };
  1229. }
  1230. return new BaseItem[] { };
  1231. }
  1232. /// <summary>
  1233. /// Gets the intros.
  1234. /// </summary>
  1235. /// <param name="item">The item.</param>
  1236. /// <param name="user">The user.</param>
  1237. /// <returns>IEnumerable{System.String}.</returns>
  1238. public async Task<IEnumerable<Video>> GetIntros(BaseItem item, User user)
  1239. {
  1240. var tasks = IntroProviders
  1241. .OrderBy(i => i.GetType().Name.IndexOf("Default", StringComparison.OrdinalIgnoreCase) == -1 ? 0 : 1)
  1242. .Take(1)
  1243. .Select(i => GetIntros(i, item, user));
  1244. var items = await Task.WhenAll(tasks).ConfigureAwait(false);
  1245. return items
  1246. .SelectMany(i => i.ToArray())
  1247. .Select(ResolveIntro)
  1248. .Where(i => i != null);
  1249. }
  1250. /// <summary>
  1251. /// Gets the intros.
  1252. /// </summary>
  1253. /// <param name="provider">The provider.</param>
  1254. /// <param name="item">The item.</param>
  1255. /// <param name="user">The user.</param>
  1256. /// <returns>Task&lt;IEnumerable&lt;IntroInfo&gt;&gt;.</returns>
  1257. private async Task<IEnumerable<IntroInfo>> GetIntros(IIntroProvider provider, BaseItem item, User user)
  1258. {
  1259. try
  1260. {
  1261. return await provider.GetIntros(item, user).ConfigureAwait(false);
  1262. }
  1263. catch (Exception ex)
  1264. {
  1265. _logger.ErrorException("Error getting intros", ex);
  1266. return new List<IntroInfo>();
  1267. }
  1268. }
  1269. /// <summary>
  1270. /// Gets all intro files.
  1271. /// </summary>
  1272. /// <returns>IEnumerable{System.String}.</returns>
  1273. public IEnumerable<string> GetAllIntroFiles()
  1274. {
  1275. return IntroProviders.SelectMany(i =>
  1276. {
  1277. try
  1278. {
  1279. return i.GetAllIntroFiles().ToList();
  1280. }
  1281. catch (Exception ex)
  1282. {
  1283. _logger.ErrorException("Error getting intro files", ex);
  1284. return new List<string>();
  1285. }
  1286. });
  1287. }
  1288. /// <summary>
  1289. /// Resolves the intro.
  1290. /// </summary>
  1291. /// <param name="info">The info.</param>
  1292. /// <returns>Video.</returns>
  1293. private Video ResolveIntro(IntroInfo info)
  1294. {
  1295. Video video = null;
  1296. if (info.ItemId.HasValue)
  1297. {
  1298. // Get an existing item by Id
  1299. video = GetItemById(info.ItemId.Value) as Video;
  1300. if (video == null)
  1301. {
  1302. _logger.Error("Unable to locate item with Id {0}.", info.ItemId.Value);
  1303. }
  1304. }
  1305. else if (!string.IsNullOrEmpty(info.Path))
  1306. {
  1307. try
  1308. {
  1309. // Try to resolve the path into a video
  1310. video = ResolvePath(_fileSystem.GetFileSystemInfo(info.Path)) as Video;
  1311. if (video == null)
  1312. {
  1313. _logger.Error("Intro resolver returned null for {0}.", info.Path);
  1314. }
  1315. else
  1316. {
  1317. // Pull the saved db item that will include metadata
  1318. var dbItem = GetItemById(video.Id) as Video;
  1319. if (dbItem != null)
  1320. {
  1321. video = dbItem;
  1322. }
  1323. else
  1324. {
  1325. return null;
  1326. }
  1327. }
  1328. }
  1329. catch (Exception ex)
  1330. {
  1331. _logger.ErrorException("Error resolving path {0}.", ex, info.Path);
  1332. }
  1333. }
  1334. else
  1335. {
  1336. _logger.Error("IntroProvider returned an IntroInfo with null Path and ItemId.");
  1337. }
  1338. return video;
  1339. }
  1340. /// <summary>
  1341. /// Sorts the specified sort by.
  1342. /// </summary>
  1343. /// <param name="items">The items.</param>
  1344. /// <param name="user">The user.</param>
  1345. /// <param name="sortBy">The sort by.</param>
  1346. /// <param name="sortOrder">The sort order.</param>
  1347. /// <returns>IEnumerable{BaseItem}.</returns>
  1348. public IEnumerable<BaseItem> Sort(IEnumerable<BaseItem> items, User user, IEnumerable<string> sortBy, SortOrder sortOrder)
  1349. {
  1350. var isFirst = true;
  1351. IOrderedEnumerable<BaseItem> orderedItems = null;
  1352. foreach (var orderBy in sortBy.Select(o => GetComparer(o, user)).Where(c => c != null))
  1353. {
  1354. if (isFirst)
  1355. {
  1356. orderedItems = sortOrder == SortOrder.Descending ? items.OrderByDescending(i => i, orderBy) : items.OrderBy(i => i, orderBy);
  1357. }
  1358. else
  1359. {
  1360. orderedItems = sortOrder == SortOrder.Descending ? orderedItems.ThenByDescending(i => i, orderBy) : orderedItems.ThenBy(i => i, orderBy);
  1361. }
  1362. isFirst = false;
  1363. }
  1364. return orderedItems ?? items;
  1365. }
  1366. /// <summary>
  1367. /// Gets the comparer.
  1368. /// </summary>
  1369. /// <param name="name">The name.</param>
  1370. /// <param name="user">The user.</param>
  1371. /// <returns>IBaseItemComparer.</returns>
  1372. private IBaseItemComparer GetComparer(string name, User user)
  1373. {
  1374. var comparer = Comparers.FirstOrDefault(c => string.Equals(name, c.Name, StringComparison.OrdinalIgnoreCase));
  1375. if (comparer != null)
  1376. {
  1377. // If it requires a user, create a new one, and assign the user
  1378. if (comparer is IUserBaseItemComparer)
  1379. {
  1380. var userComparer = (IUserBaseItemComparer)Activator.CreateInstance(comparer.GetType());
  1381. userComparer.User = user;
  1382. userComparer.UserManager = _userManager;
  1383. userComparer.UserDataRepository = _userDataRepository;
  1384. return userComparer;
  1385. }
  1386. }
  1387. return comparer;
  1388. }
  1389. /// <summary>
  1390. /// Creates the item.
  1391. /// </summary>
  1392. /// <param name="item">The item.</param>
  1393. /// <param name="cancellationToken">The cancellation token.</param>
  1394. /// <returns>Task.</returns>
  1395. public Task CreateItem(BaseItem item, CancellationToken cancellationToken)
  1396. {
  1397. return CreateItems(new[] { item }, cancellationToken);
  1398. }
  1399. /// <summary>
  1400. /// Creates the items.
  1401. /// </summary>
  1402. /// <param name="items">The items.</param>
  1403. /// <param name="cancellationToken">The cancellation token.</param>
  1404. /// <returns>Task.</returns>
  1405. public async Task CreateItems(IEnumerable<BaseItem> items, CancellationToken cancellationToken)
  1406. {
  1407. var list = items.ToList();
  1408. await ItemRepository.SaveItems(list, cancellationToken).ConfigureAwait(false);
  1409. foreach (var item in list)
  1410. {
  1411. UpdateItemInLibraryCache(item);
  1412. }
  1413. if (ItemAdded != null)
  1414. {
  1415. foreach (var item in list)
  1416. {
  1417. try
  1418. {
  1419. ItemAdded(this, new ItemChangeEventArgs { Item = item });
  1420. }
  1421. catch (Exception ex)
  1422. {
  1423. _logger.ErrorException("Error in ItemAdded event handler", ex);
  1424. }
  1425. }
  1426. }
  1427. }
  1428. /// <summary>
  1429. /// Updates the item.
  1430. /// </summary>
  1431. /// <param name="item">The item.</param>
  1432. /// <param name="updateReason">The update reason.</param>
  1433. /// <param name="cancellationToken">The cancellation token.</param>
  1434. /// <returns>Task.</returns>
  1435. public async Task UpdateItem(BaseItem item, ItemUpdateType updateReason, CancellationToken cancellationToken)
  1436. {
  1437. var locationType = item.LocationType;
  1438. if (locationType != LocationType.Remote && locationType != LocationType.Virtual)
  1439. {
  1440. await _providerManagerFactory().SaveMetadata(item, updateReason).ConfigureAwait(false);
  1441. }
  1442. item.DateLastSaved = DateTime.UtcNow;
  1443. var logName = item.LocationType == LocationType.Remote ? item.Name ?? item.Path : item.Path ?? item.Name;
  1444. _logger.Debug("Saving {0} to database.", logName);
  1445. await ItemRepository.SaveItem(item, cancellationToken).ConfigureAwait(false);
  1446. UpdateItemInLibraryCache(item);
  1447. if (ItemUpdated != null)
  1448. {
  1449. try
  1450. {
  1451. ItemUpdated(this, new ItemChangeEventArgs
  1452. {
  1453. Item = item,
  1454. UpdateReason = updateReason
  1455. });
  1456. }
  1457. catch (Exception ex)
  1458. {
  1459. _logger.ErrorException("Error in ItemUpdated event handler", ex);
  1460. }
  1461. }
  1462. }
  1463. /// <summary>
  1464. /// Reports the item removed.
  1465. /// </summary>
  1466. /// <param name="item">The item.</param>
  1467. public void ReportItemRemoved(BaseItem item)
  1468. {
  1469. if (ItemRemoved != null)
  1470. {
  1471. try
  1472. {
  1473. ItemRemoved(this, new ItemChangeEventArgs { Item = item });
  1474. }
  1475. catch (Exception ex)
  1476. {
  1477. _logger.ErrorException("Error in ItemRemoved event handler", ex);
  1478. }
  1479. }
  1480. }
  1481. /// <summary>
  1482. /// Retrieves the item.
  1483. /// </summary>
  1484. /// <param name="id">The id.</param>
  1485. /// <returns>BaseItem.</returns>
  1486. public BaseItem RetrieveItem(Guid id)
  1487. {
  1488. return ItemRepository.RetrieveItem(id);
  1489. }
  1490. public IEnumerable<Folder> GetCollectionFolders(BaseItem item)
  1491. {
  1492. while (!(item.GetParent() is AggregateFolder) && item.GetParent() != null)
  1493. {
  1494. item = item.GetParent();
  1495. }
  1496. if (item == null)
  1497. {
  1498. return new List<Folder>();
  1499. }
  1500. return GetUserRootFolder().Children
  1501. .OfType<Folder>()
  1502. .Where(i => string.Equals(i.Path, item.Path, StringComparison.OrdinalIgnoreCase) || i.PhysicalLocations.Contains(item.Path, StringComparer.OrdinalIgnoreCase));
  1503. }
  1504. public string GetContentType(BaseItem item)
  1505. {
  1506. string configuredContentType = GetConfiguredContentType(item, false);
  1507. if (!string.IsNullOrWhiteSpace(configuredContentType))
  1508. {
  1509. return configuredContentType;
  1510. }
  1511. configuredContentType = GetConfiguredContentType(item, true);
  1512. if (!string.IsNullOrWhiteSpace(configuredContentType))
  1513. {
  1514. return configuredContentType;
  1515. }
  1516. return GetInheritedContentType(item);
  1517. }
  1518. public string GetInheritedContentType(BaseItem item)
  1519. {
  1520. var type = GetTopFolderContentType(item);
  1521. if (!string.IsNullOrWhiteSpace(type))
  1522. {
  1523. return type;
  1524. }
  1525. return item.GetParents()
  1526. .Select(GetConfiguredContentType)
  1527. .LastOrDefault(i => !string.IsNullOrWhiteSpace(i));
  1528. }
  1529. public string GetConfiguredContentType(BaseItem item)
  1530. {
  1531. return GetConfiguredContentType(item, false);
  1532. }
  1533. public string GetConfiguredContentType(string path)
  1534. {
  1535. return GetContentTypeOverride(path, false);
  1536. }
  1537. public string GetConfiguredContentType(BaseItem item, bool inheritConfiguredPath)
  1538. {
  1539. ICollectionFolder collectionFolder = item as ICollectionFolder;
  1540. if (collectionFolder != null)
  1541. {
  1542. return collectionFolder.CollectionType;
  1543. }
  1544. return GetContentTypeOverride(item.ContainingFolderPath, inheritConfiguredPath);
  1545. }
  1546. private string GetContentTypeOverride(string path, bool inherit)
  1547. {
  1548. var nameValuePair = ConfigurationManager.Configuration.ContentTypes.FirstOrDefault(i => string.Equals(i.Name, path, StringComparison.OrdinalIgnoreCase) || (inherit && _fileSystem.ContainsSubPath(i.Name, path)));
  1549. if (nameValuePair != null)
  1550. {
  1551. return nameValuePair.Value;
  1552. }
  1553. return null;
  1554. }
  1555. private string GetTopFolderContentType(BaseItem item)
  1556. {
  1557. if (item == null)
  1558. {
  1559. return null;
  1560. }
  1561. while (!(item.GetParent() is AggregateFolder) && item.GetParent() != null)
  1562. {
  1563. item = item.GetParent();
  1564. }
  1565. return GetUserRootFolder().Children
  1566. .OfType<ICollectionFolder>()
  1567. .Where(i => string.Equals(i.Path, item.Path, StringComparison.OrdinalIgnoreCase) || i.PhysicalLocations.Contains(item.Path))
  1568. .Select(i => i.CollectionType)
  1569. .FirstOrDefault(i => !string.IsNullOrWhiteSpace(i));
  1570. }
  1571. private readonly TimeSpan _viewRefreshInterval = TimeSpan.FromHours(24);
  1572. //private readonly TimeSpan _viewRefreshInterval = TimeSpan.FromMinutes(1);
  1573. public Task<UserView> GetNamedView(User user,
  1574. string name,
  1575. string viewType,
  1576. string sortName,
  1577. CancellationToken cancellationToken)
  1578. {
  1579. return GetNamedView(user, name, null, viewType, sortName, cancellationToken);
  1580. }
  1581. public async Task<UserView> GetNamedView(string name,
  1582. string viewType,
  1583. string sortName,
  1584. CancellationToken cancellationToken)
  1585. {
  1586. var path = Path.Combine(ConfigurationManager.ApplicationPaths.ItemsByNamePath, "views");
  1587. path = Path.Combine(path, _fileSystem.GetValidFilename(viewType));
  1588. var id = GetNewItemId(path + "_namedview_" + name, typeof(UserView));
  1589. var item = GetItemById(id) as UserView;
  1590. var refresh = false;
  1591. if (item == null || !string.Equals(item.Path, path, StringComparison.OrdinalIgnoreCase))
  1592. {
  1593. _fileSystem.CreateDirectory(path);
  1594. item = new UserView
  1595. {
  1596. Path = path,
  1597. Id = id,
  1598. DateCreated = DateTime.UtcNow,
  1599. Name = name,
  1600. ViewType = viewType,
  1601. ForcedSortName = sortName
  1602. };
  1603. await CreateItem(item, cancellationToken).ConfigureAwait(false);
  1604. refresh = true;
  1605. }
  1606. if (!refresh)
  1607. {
  1608. refresh = DateTime.UtcNow - item.DateLastRefreshed >= _viewRefreshInterval;
  1609. }
  1610. if (!refresh && item.DisplayParentId != Guid.Empty)
  1611. {
  1612. var displayParent = GetItemById(item.DisplayParentId);
  1613. refresh = displayParent != null && displayParent.DateLastSaved > item.DateLastRefreshed;
  1614. }
  1615. if (refresh)
  1616. {
  1617. await item.UpdateToRepository(ItemUpdateType.MetadataImport, CancellationToken.None).ConfigureAwait(false);
  1618. _providerManagerFactory().QueueRefresh(item.Id, new MetadataRefreshOptions(_fileSystem)
  1619. {
  1620. // Not sure why this is necessary but need to figure it out
  1621. // View images are not getting utilized without this
  1622. ForceSave = true
  1623. });
  1624. }
  1625. return item;
  1626. }
  1627. public async Task<UserView> GetNamedView(User user,
  1628. string name,
  1629. string parentId,
  1630. string viewType,
  1631. string sortName,
  1632. CancellationToken cancellationToken)
  1633. {
  1634. var idValues = "38_namedview_" + name + user.Id.ToString("N") + (parentId ?? string.Empty) + (viewType ?? string.Empty);
  1635. var id = GetNewItemId(idValues, typeof(UserView));
  1636. var path = Path.Combine(ConfigurationManager.ApplicationPaths.InternalMetadataPath, "views", id.ToString("N"));
  1637. var item = GetItemById(id) as UserView;
  1638. var isNew = false;
  1639. if (item == null)
  1640. {
  1641. _fileSystem.CreateDirectory(path);
  1642. item = new UserView
  1643. {
  1644. Path = path,
  1645. Id = id,
  1646. DateCreated = DateTime.UtcNow,
  1647. Name = name,
  1648. ViewType = viewType,
  1649. ForcedSortName = sortName,
  1650. UserId = user.Id
  1651. };
  1652. if (!string.IsNullOrWhiteSpace(parentId))
  1653. {
  1654. item.DisplayParentId = new Guid(parentId);
  1655. }
  1656. await CreateItem(item, cancellationToken).ConfigureAwait(false);
  1657. isNew = true;
  1658. }
  1659. var refresh = isNew || DateTime.UtcNow - item.DateLastRefreshed >= _viewRefreshInterval;
  1660. if (!refresh && item.DisplayParentId != Guid.Empty)
  1661. {
  1662. var displayParent = GetItemById(item.DisplayParentId);
  1663. refresh = displayParent != null && displayParent.DateLastSaved > item.DateLastRefreshed;
  1664. }
  1665. if (refresh)
  1666. {
  1667. _providerManagerFactory().QueueRefresh(item.Id, new MetadataRefreshOptions(_fileSystem)
  1668. {
  1669. // Need to force save to increment DateLastSaved
  1670. ForceSave = true
  1671. });
  1672. }
  1673. return item;
  1674. }
  1675. public async Task<UserView> GetShadowView(BaseItem parent,
  1676. string viewType,
  1677. string sortName,
  1678. CancellationToken cancellationToken)
  1679. {
  1680. if (parent == null)
  1681. {
  1682. throw new ArgumentNullException("parent");
  1683. }
  1684. var name = parent.Name;
  1685. var parentId = parent.Id;
  1686. var idValues = "38_namedview_" + name + parentId + (viewType ?? string.Empty);
  1687. var id = GetNewItemId(idValues, typeof(UserView));
  1688. var path = parent.Path;
  1689. var item = GetItemById(id) as UserView;
  1690. var isNew = false;
  1691. if (item == null)
  1692. {
  1693. _fileSystem.CreateDirectory(path);
  1694. item = new UserView
  1695. {
  1696. Path = path,
  1697. Id = id,
  1698. DateCreated = DateTime.UtcNow,
  1699. Name = name,
  1700. ViewType = viewType,
  1701. ForcedSortName = sortName
  1702. };
  1703. item.DisplayParentId = parentId;
  1704. await CreateItem(item, cancellationToken).ConfigureAwait(false);
  1705. isNew = true;
  1706. }
  1707. var refresh = isNew || DateTime.UtcNow - item.DateLastRefreshed >= _viewRefreshInterval;
  1708. if (!refresh && item.DisplayParentId != Guid.Empty)
  1709. {
  1710. var displayParent = GetItemById(item.DisplayParentId);
  1711. refresh = displayParent != null && displayParent.DateLastSaved > item.DateLastRefreshed;
  1712. }
  1713. if (refresh)
  1714. {
  1715. _providerManagerFactory().QueueRefresh(item.Id, new MetadataRefreshOptions(_fileSystem)
  1716. {
  1717. // Need to force save to increment DateLastSaved
  1718. ForceSave = true
  1719. });
  1720. }
  1721. return item;
  1722. }
  1723. public async Task<UserView> GetNamedView(string name,
  1724. string parentId,
  1725. string viewType,
  1726. string sortName,
  1727. string uniqueId,
  1728. CancellationToken cancellationToken)
  1729. {
  1730. if (string.IsNullOrWhiteSpace(name))
  1731. {
  1732. throw new ArgumentNullException("name");
  1733. }
  1734. var idValues = "37_namedview_" + name + (parentId ?? string.Empty) + (viewType ?? string.Empty);
  1735. if (!string.IsNullOrWhiteSpace(uniqueId))
  1736. {
  1737. idValues += uniqueId;
  1738. }
  1739. var id = GetNewItemId(idValues, typeof(UserView));
  1740. var path = Path.Combine(ConfigurationManager.ApplicationPaths.InternalMetadataPath, "views", id.ToString("N"));
  1741. var item = GetItemById(id) as UserView;
  1742. var isNew = false;
  1743. if (item == null)
  1744. {
  1745. _fileSystem.CreateDirectory(path);
  1746. item = new UserView
  1747. {
  1748. Path = path,
  1749. Id = id,
  1750. DateCreated = DateTime.UtcNow,
  1751. Name = name,
  1752. ViewType = viewType,
  1753. ForcedSortName = sortName
  1754. };
  1755. if (!string.IsNullOrWhiteSpace(parentId))
  1756. {
  1757. item.DisplayParentId = new Guid(parentId);
  1758. }
  1759. await CreateItem(item, cancellationToken).ConfigureAwait(false);
  1760. isNew = true;
  1761. }
  1762. if (!string.Equals(viewType, item.ViewType, StringComparison.OrdinalIgnoreCase))
  1763. {
  1764. item.ViewType = viewType;
  1765. await item.UpdateToRepository(ItemUpdateType.MetadataEdit, cancellationToken).ConfigureAwait(false);
  1766. }
  1767. var refresh = isNew || DateTime.UtcNow - item.DateLastRefreshed >= _viewRefreshInterval;
  1768. if (!refresh && item.DisplayParentId != Guid.Empty)
  1769. {
  1770. var displayParent = GetItemById(item.DisplayParentId);
  1771. refresh = displayParent != null && displayParent.DateLastSaved > item.DateLastRefreshed;
  1772. }
  1773. if (refresh)
  1774. {
  1775. _providerManagerFactory().QueueRefresh(item.Id, new MetadataRefreshOptions(_fileSystem)
  1776. {
  1777. // Need to force save to increment DateLastSaved
  1778. ForceSave = true
  1779. });
  1780. }
  1781. return item;
  1782. }
  1783. public bool IsVideoFile(string path)
  1784. {
  1785. var resolver = new VideoResolver(GetNamingOptions(), new PatternsLogger());
  1786. return resolver.IsVideoFile(path);
  1787. }
  1788. public bool IsAudioFile(string path)
  1789. {
  1790. var parser = new AudioFileParser(GetNamingOptions());
  1791. return parser.IsAudioFile(path);
  1792. }
  1793. public int? GetSeasonNumberFromPath(string path)
  1794. {
  1795. return new SeasonPathParser(GetNamingOptions(), new RegexProvider()).Parse(path, true, true).SeasonNumber;
  1796. }
  1797. public bool FillMissingEpisodeNumbersFromPath(Episode episode)
  1798. {
  1799. var resolver = new EpisodeResolver(GetNamingOptions(),
  1800. new PatternsLogger());
  1801. var isFolder = episode.VideoType == VideoType.BluRay || episode.VideoType == VideoType.Dvd ||
  1802. episode.VideoType == VideoType.HdDvd;
  1803. var locationType = episode.LocationType;
  1804. var episodeInfo = locationType == LocationType.FileSystem || locationType == LocationType.Offline ?
  1805. resolver.Resolve(episode.Path, isFolder) :
  1806. new Naming.TV.EpisodeInfo();
  1807. if (episodeInfo == null)
  1808. {
  1809. episodeInfo = new Naming.TV.EpisodeInfo();
  1810. }
  1811. var changed = false;
  1812. if (episodeInfo.IsByDate)
  1813. {
  1814. if (episode.IndexNumber.HasValue)
  1815. {
  1816. episode.IndexNumber = null;
  1817. changed = true;
  1818. }
  1819. if (episode.IndexNumberEnd.HasValue)
  1820. {
  1821. episode.IndexNumberEnd = null;
  1822. changed = true;
  1823. }
  1824. if (!episode.PremiereDate.HasValue)
  1825. {
  1826. if (episodeInfo.Year.HasValue && episodeInfo.Month.HasValue && episodeInfo.Day.HasValue)
  1827. {
  1828. episode.PremiereDate = new DateTime(episodeInfo.Year.Value, episodeInfo.Month.Value, episodeInfo.Day.Value).ToUniversalTime();
  1829. }
  1830. if (episode.PremiereDate.HasValue)
  1831. {
  1832. changed = true;
  1833. }
  1834. }
  1835. if (!episode.ProductionYear.HasValue)
  1836. {
  1837. episode.ProductionYear = episodeInfo.Year;
  1838. if (episode.ProductionYear.HasValue)
  1839. {
  1840. changed = true;
  1841. }
  1842. }
  1843. if (!episode.ParentIndexNumber.HasValue)
  1844. {
  1845. var season = episode.Season;
  1846. if (season != null)
  1847. {
  1848. episode.ParentIndexNumber = season.IndexNumber;
  1849. }
  1850. if (episode.ParentIndexNumber.HasValue)
  1851. {
  1852. changed = true;
  1853. }
  1854. }
  1855. }
  1856. else
  1857. {
  1858. if (!episode.IndexNumber.HasValue)
  1859. {
  1860. episode.IndexNumber = episodeInfo.EpisodeNumber;
  1861. if (episode.IndexNumber.HasValue)
  1862. {
  1863. changed = true;
  1864. }
  1865. }
  1866. if (!episode.IndexNumberEnd.HasValue)
  1867. {
  1868. episode.IndexNumberEnd = episodeInfo.EndingEpsiodeNumber;
  1869. if (episode.IndexNumberEnd.HasValue)
  1870. {
  1871. changed = true;
  1872. }
  1873. }
  1874. if (!episode.ParentIndexNumber.HasValue)
  1875. {
  1876. episode.ParentIndexNumber = episodeInfo.SeasonNumber;
  1877. if (!episode.ParentIndexNumber.HasValue)
  1878. {
  1879. var season = episode.Season;
  1880. if (season != null)
  1881. {
  1882. episode.ParentIndexNumber = season.IndexNumber;
  1883. }
  1884. }
  1885. if (episode.ParentIndexNumber.HasValue)
  1886. {
  1887. changed = true;
  1888. }
  1889. }
  1890. }
  1891. return changed;
  1892. }
  1893. public NamingOptions GetNamingOptions()
  1894. {
  1895. var options = new ExtendedNamingOptions();
  1896. // These cause apps to have problems
  1897. options.AudioFileExtensions.Remove(".m3u");
  1898. options.AudioFileExtensions.Remove(".wpl");
  1899. if (!ConfigurationManager.Configuration.EnableAudioArchiveFiles)
  1900. {
  1901. options.AudioFileExtensions.Remove(".rar");
  1902. options.AudioFileExtensions.Remove(".zip");
  1903. }
  1904. if (!ConfigurationManager.Configuration.EnableVideoArchiveFiles)
  1905. {
  1906. options.VideoFileExtensions.Remove(".rar");
  1907. options.VideoFileExtensions.Remove(".zip");
  1908. }
  1909. return options;
  1910. }
  1911. public ItemLookupInfo ParseName(string name)
  1912. {
  1913. var resolver = new VideoResolver(GetNamingOptions(), new PatternsLogger());
  1914. var result = resolver.CleanDateTime(name);
  1915. var cleanName = resolver.CleanString(result.Name);
  1916. return new ItemLookupInfo
  1917. {
  1918. Name = cleanName.Name,
  1919. Year = result.Year
  1920. };
  1921. }
  1922. public IEnumerable<Video> FindTrailers(BaseItem owner, List<FileSystemMetadata> fileSystemChildren, IDirectoryService directoryService)
  1923. {
  1924. var files = fileSystemChildren.Where(i => i.IsDirectory)
  1925. .Where(i => string.Equals(i.Name, BaseItem.TrailerFolderName, StringComparison.OrdinalIgnoreCase))
  1926. .SelectMany(i => _fileSystem.GetFiles(i.FullName, false))
  1927. .ToList();
  1928. var videoListResolver = new VideoListResolver(GetNamingOptions(), new PatternsLogger());
  1929. var videos = videoListResolver.Resolve(fileSystemChildren.Select(i => new FileMetadata
  1930. {
  1931. Id = i.FullName,
  1932. IsFolder = (i.Attributes & FileAttributes.Directory) == FileAttributes.Directory
  1933. }).ToList());
  1934. var currentVideo = videos.FirstOrDefault(i => string.Equals(owner.Path, i.Files.First().Path, StringComparison.OrdinalIgnoreCase));
  1935. if (currentVideo != null)
  1936. {
  1937. files.AddRange(currentVideo.Extras.Where(i => string.Equals(i.ExtraType, "trailer", StringComparison.OrdinalIgnoreCase)).Select(i => _fileSystem.GetFileInfo(i.Path)));
  1938. }
  1939. var resolvers = new IItemResolver[]
  1940. {
  1941. new GenericVideoResolver<Trailer>(this)
  1942. };
  1943. return ResolvePaths(files, directoryService, null, null, resolvers)
  1944. .OfType<Trailer>()
  1945. .Select(video =>
  1946. {
  1947. // Try to retrieve it from the db. If we don't find it, use the resolved version
  1948. var dbItem = GetItemById(video.Id) as Trailer;
  1949. if (dbItem != null)
  1950. {
  1951. video = dbItem;
  1952. }
  1953. video.ExtraType = ExtraType.Trailer;
  1954. video.TrailerTypes = new List<TrailerType> { TrailerType.LocalTrailer };
  1955. return video;
  1956. // Sort them so that the list can be easily compared for changes
  1957. }).OrderBy(i => i.Path).ToList();
  1958. }
  1959. public IEnumerable<Video> FindExtras(BaseItem owner, List<FileSystemMetadata> fileSystemChildren, IDirectoryService directoryService)
  1960. {
  1961. var files = fileSystemChildren.Where(i => i.IsDirectory)
  1962. .Where(i => string.Equals(i.Name, "extras", StringComparison.OrdinalIgnoreCase) || string.Equals(i.Name, "specials", StringComparison.OrdinalIgnoreCase))
  1963. .SelectMany(i => _fileSystem.GetFiles(i.FullName, false))
  1964. .ToList();
  1965. var videoListResolver = new VideoListResolver(GetNamingOptions(), new PatternsLogger());
  1966. var videos = videoListResolver.Resolve(fileSystemChildren.Select(i => new FileMetadata
  1967. {
  1968. Id = i.FullName,
  1969. IsFolder = (i.Attributes & FileAttributes.Directory) == FileAttributes.Directory
  1970. }).ToList());
  1971. var currentVideo = videos.FirstOrDefault(i => string.Equals(owner.Path, i.Files.First().Path, StringComparison.OrdinalIgnoreCase));
  1972. if (currentVideo != null)
  1973. {
  1974. files.AddRange(currentVideo.Extras.Where(i => !string.Equals(i.ExtraType, "trailer", StringComparison.OrdinalIgnoreCase)).Select(i => _fileSystem.GetFileInfo(i.Path)));
  1975. }
  1976. return ResolvePaths(files, directoryService, null, null)
  1977. .OfType<Video>()
  1978. .Select(video =>
  1979. {
  1980. // Try to retrieve it from the db. If we don't find it, use the resolved version
  1981. var dbItem = GetItemById(video.Id) as Video;
  1982. if (dbItem != null)
  1983. {
  1984. video = dbItem;
  1985. }
  1986. SetExtraTypeFromFilename(video);
  1987. return video;
  1988. // Sort them so that the list can be easily compared for changes
  1989. }).OrderBy(i => i.Path).ToList();
  1990. }
  1991. public string SubstitutePath(string path, string from, string to)
  1992. {
  1993. if (string.IsNullOrWhiteSpace(path))
  1994. {
  1995. throw new ArgumentNullException("path");
  1996. }
  1997. if (string.IsNullOrWhiteSpace(from))
  1998. {
  1999. throw new ArgumentNullException("from");
  2000. }
  2001. if (string.IsNullOrWhiteSpace(to))
  2002. {
  2003. throw new ArgumentNullException("to");
  2004. }
  2005. var newPath = path.Replace(from, to, StringComparison.OrdinalIgnoreCase);
  2006. if (!string.Equals(newPath, path))
  2007. {
  2008. if (to.IndexOf('/') != -1)
  2009. {
  2010. newPath = newPath.Replace('\\', '/');
  2011. }
  2012. else
  2013. {
  2014. newPath = newPath.Replace('/', '\\');
  2015. }
  2016. }
  2017. return newPath;
  2018. }
  2019. private void SetExtraTypeFromFilename(Video item)
  2020. {
  2021. var resolver = new ExtraResolver(GetNamingOptions(), new PatternsLogger(), new RegexProvider());
  2022. var result = resolver.GetExtraInfo(item.Path);
  2023. if (string.Equals(result.ExtraType, "deletedscene", StringComparison.OrdinalIgnoreCase))
  2024. {
  2025. item.ExtraType = ExtraType.DeletedScene;
  2026. }
  2027. else if (string.Equals(result.ExtraType, "behindthescenes", StringComparison.OrdinalIgnoreCase))
  2028. {
  2029. item.ExtraType = ExtraType.BehindTheScenes;
  2030. }
  2031. else if (string.Equals(result.ExtraType, "interview", StringComparison.OrdinalIgnoreCase))
  2032. {
  2033. item.ExtraType = ExtraType.Interview;
  2034. }
  2035. else if (string.Equals(result.ExtraType, "scene", StringComparison.OrdinalIgnoreCase))
  2036. {
  2037. item.ExtraType = ExtraType.Scene;
  2038. }
  2039. else if (string.Equals(result.ExtraType, "sample", StringComparison.OrdinalIgnoreCase))
  2040. {
  2041. item.ExtraType = ExtraType.Sample;
  2042. }
  2043. else
  2044. {
  2045. item.ExtraType = ExtraType.Clip;
  2046. }
  2047. }
  2048. public List<PersonInfo> GetPeople(InternalPeopleQuery query)
  2049. {
  2050. return ItemRepository.GetPeople(query);
  2051. }
  2052. public List<PersonInfo> GetPeople(BaseItem item)
  2053. {
  2054. if (item.SupportsPeople)
  2055. {
  2056. var people = GetPeople(new InternalPeopleQuery
  2057. {
  2058. ItemId = item.Id
  2059. });
  2060. if (people.Count > 0)
  2061. {
  2062. return people;
  2063. }
  2064. }
  2065. return new List<PersonInfo>();
  2066. }
  2067. public List<Person> GetPeopleItems(InternalPeopleQuery query)
  2068. {
  2069. return ItemRepository.GetPeopleNames(query).Select(i =>
  2070. {
  2071. try
  2072. {
  2073. return GetPerson(i);
  2074. }
  2075. catch (Exception ex)
  2076. {
  2077. _logger.ErrorException("Error getting person", ex);
  2078. return null;
  2079. }
  2080. }).Where(i => i != null).ToList();
  2081. }
  2082. public List<string> GetPeopleNames(InternalPeopleQuery query)
  2083. {
  2084. return ItemRepository.GetPeopleNames(query);
  2085. }
  2086. public List<PersonInfo> GetAllPeople()
  2087. {
  2088. return GetPeople(new InternalPeopleQuery())
  2089. .DistinctBy(i => i.Name, StringComparer.OrdinalIgnoreCase)
  2090. .ToList();
  2091. }
  2092. public Task UpdatePeople(BaseItem item, List<PersonInfo> people)
  2093. {
  2094. if (!item.SupportsPeople)
  2095. {
  2096. return Task.FromResult(true);
  2097. }
  2098. return ItemRepository.UpdatePeople(item.Id, people);
  2099. }
  2100. private readonly SemaphoreSlim _dynamicImageResourcePool = new SemaphoreSlim(1, 1);
  2101. public async Task<ItemImageInfo> ConvertImageToLocal(IHasImages item, ItemImageInfo image, int imageIndex)
  2102. {
  2103. foreach (var url in image.Path.Split('|'))
  2104. {
  2105. try
  2106. {
  2107. _logger.Debug("ConvertImageToLocal item {0} - image url: {1}", item.Id, url);
  2108. await _providerManagerFactory().SaveImage(item, url, _dynamicImageResourcePool, image.Type, imageIndex, CancellationToken.None).ConfigureAwait(false);
  2109. var newImage = item.GetImageInfo(image.Type, imageIndex);
  2110. if (newImage != null)
  2111. {
  2112. newImage.IsPlaceholder = image.IsPlaceholder;
  2113. }
  2114. await item.UpdateToRepository(ItemUpdateType.ImageUpdate, CancellationToken.None).ConfigureAwait(false);
  2115. return item.GetImageInfo(image.Type, imageIndex);
  2116. }
  2117. catch (HttpException ex)
  2118. {
  2119. if (ex.StatusCode.HasValue && ex.StatusCode.Value == HttpStatusCode.NotFound)
  2120. {
  2121. continue;
  2122. }
  2123. throw;
  2124. }
  2125. }
  2126. // Remove this image to prevent it from retrying over and over
  2127. item.RemoveImage(image);
  2128. await item.UpdateToRepository(ItemUpdateType.ImageUpdate, CancellationToken.None).ConfigureAwait(false);
  2129. throw new InvalidOperationException();
  2130. }
  2131. public void AddVirtualFolder(string name, string collectionType, string[] mediaPaths, bool refreshLibrary)
  2132. {
  2133. if (string.IsNullOrWhiteSpace(name))
  2134. {
  2135. throw new ArgumentNullException("name");
  2136. }
  2137. name = _fileSystem.GetValidFilename(name);
  2138. var rootFolderPath = ConfigurationManager.ApplicationPaths.DefaultUserViewsPath;
  2139. var virtualFolderPath = Path.Combine(rootFolderPath, name);
  2140. while (_fileSystem.DirectoryExists(virtualFolderPath))
  2141. {
  2142. name += "1";
  2143. virtualFolderPath = Path.Combine(rootFolderPath, name);
  2144. }
  2145. if (mediaPaths != null)
  2146. {
  2147. var invalidpath = mediaPaths.FirstOrDefault(i => !_fileSystem.DirectoryExists(i));
  2148. if (invalidpath != null)
  2149. {
  2150. throw new ArgumentException("The specified path does not exist: " + invalidpath + ".");
  2151. }
  2152. }
  2153. _libraryMonitorFactory().Stop();
  2154. try
  2155. {
  2156. _fileSystem.CreateDirectory(virtualFolderPath);
  2157. if (!string.IsNullOrEmpty(collectionType))
  2158. {
  2159. var path = Path.Combine(virtualFolderPath, collectionType + ".collection");
  2160. using (File.Create(path))
  2161. {
  2162. }
  2163. }
  2164. if (mediaPaths != null)
  2165. {
  2166. foreach (var path in mediaPaths)
  2167. {
  2168. AddMediaPath(name, path);
  2169. }
  2170. }
  2171. }
  2172. finally
  2173. {
  2174. Task.Run(() =>
  2175. {
  2176. // No need to start if scanning the library because it will handle it
  2177. if (refreshLibrary)
  2178. {
  2179. ValidateMediaLibrary(new Progress<double>(), CancellationToken.None);
  2180. }
  2181. else
  2182. {
  2183. // Need to add a delay here or directory watchers may still pick up the changes
  2184. var task = Task.Delay(1000);
  2185. // Have to block here to allow exceptions to bubble
  2186. Task.WaitAll(task);
  2187. _libraryMonitorFactory().Start();
  2188. }
  2189. });
  2190. }
  2191. }
  2192. private const string ShortcutFileExtension = ".mblink";
  2193. public void AddMediaPath(string virtualFolderName, string path)
  2194. {
  2195. if (string.IsNullOrWhiteSpace(path))
  2196. {
  2197. throw new ArgumentNullException("path");
  2198. }
  2199. if (!_fileSystem.DirectoryExists(path))
  2200. {
  2201. throw new DirectoryNotFoundException("The path does not exist.");
  2202. }
  2203. var rootFolderPath = ConfigurationManager.ApplicationPaths.DefaultUserViewsPath;
  2204. var virtualFolderPath = Path.Combine(rootFolderPath, virtualFolderName);
  2205. var shortcutFilename = _fileSystem.GetFileNameWithoutExtension(path);
  2206. var lnk = Path.Combine(virtualFolderPath, shortcutFilename + ShortcutFileExtension);
  2207. while (_fileSystem.FileExists(lnk))
  2208. {
  2209. shortcutFilename += "1";
  2210. lnk = Path.Combine(virtualFolderPath, shortcutFilename + ShortcutFileExtension);
  2211. }
  2212. _fileSystem.CreateShortcut(lnk, path);
  2213. }
  2214. }
  2215. }