LibraryManager.cs 68 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957
  1. using MediaBrowser.Common.Extensions;
  2. using MediaBrowser.Common.IO;
  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.Naming.Audio;
  19. using MediaBrowser.Naming.Common;
  20. using MediaBrowser.Naming.IO;
  21. using MediaBrowser.Naming.TV;
  22. using MediaBrowser.Naming.Video;
  23. using MediaBrowser.Server.Implementations.Library.Validators;
  24. using MediaBrowser.Server.Implementations.ScheduledTasks;
  25. using System;
  26. using System.Collections.Concurrent;
  27. using System.Collections.Generic;
  28. using System.Globalization;
  29. using System.IO;
  30. using System.Linq;
  31. using System.Threading;
  32. using System.Threading.Tasks;
  33. using SortOrder = MediaBrowser.Model.Entities.SortOrder;
  34. namespace MediaBrowser.Server.Implementations.Library
  35. {
  36. /// <summary>
  37. /// Class LibraryManager
  38. /// </summary>
  39. public class LibraryManager : ILibraryManager
  40. {
  41. /// <summary>
  42. /// Gets or sets the postscan tasks.
  43. /// </summary>
  44. /// <value>The postscan tasks.</value>
  45. private ILibraryPostScanTask[] PostscanTasks { get; set; }
  46. /// <summary>
  47. /// Gets the intro providers.
  48. /// </summary>
  49. /// <value>The intro providers.</value>
  50. private IIntroProvider[] IntroProviders { get; set; }
  51. /// <summary>
  52. /// Gets the list of entity resolution ignore rules
  53. /// </summary>
  54. /// <value>The entity resolution ignore rules.</value>
  55. private IResolverIgnoreRule[] EntityResolutionIgnoreRules { get; set; }
  56. /// <summary>
  57. /// Gets the list of BasePluginFolders added by plugins
  58. /// </summary>
  59. /// <value>The plugin folders.</value>
  60. private IVirtualFolderCreator[] PluginFolderCreators { get; set; }
  61. /// <summary>
  62. /// Gets the list of currently registered entity resolvers
  63. /// </summary>
  64. /// <value>The entity resolvers enumerable.</value>
  65. private IItemResolver[] EntityResolvers { get; set; }
  66. /// <summary>
  67. /// Gets or sets the comparers.
  68. /// </summary>
  69. /// <value>The comparers.</value>
  70. private IBaseItemComparer[] Comparers { get; set; }
  71. /// <summary>
  72. /// Gets the active item repository
  73. /// </summary>
  74. /// <value>The item repository.</value>
  75. public IItemRepository ItemRepository { get; set; }
  76. /// <summary>
  77. /// Occurs when [item added].
  78. /// </summary>
  79. public event EventHandler<ItemChangeEventArgs> ItemAdded;
  80. /// <summary>
  81. /// Occurs when [item updated].
  82. /// </summary>
  83. public event EventHandler<ItemChangeEventArgs> ItemUpdated;
  84. /// <summary>
  85. /// Occurs when [item removed].
  86. /// </summary>
  87. public event EventHandler<ItemChangeEventArgs> ItemRemoved;
  88. /// <summary>
  89. /// The _logger
  90. /// </summary>
  91. private readonly ILogger _logger;
  92. /// <summary>
  93. /// The _task manager
  94. /// </summary>
  95. private readonly ITaskManager _taskManager;
  96. /// <summary>
  97. /// The _user manager
  98. /// </summary>
  99. private readonly IUserManager _userManager;
  100. /// <summary>
  101. /// The _user data repository
  102. /// </summary>
  103. private readonly IUserDataManager _userDataRepository;
  104. /// <summary>
  105. /// Gets or sets the configuration manager.
  106. /// </summary>
  107. /// <value>The configuration manager.</value>
  108. private IServerConfigurationManager ConfigurationManager { get; set; }
  109. /// <summary>
  110. /// A collection of items that may be referenced from multiple physical places in the library
  111. /// (typically, multiple user roots). We store them here and be sure they all reference a
  112. /// single instance.
  113. /// </summary>
  114. /// <value>The by reference items.</value>
  115. private ConcurrentDictionary<Guid, BaseItem> ByReferenceItems { get; set; }
  116. private readonly Func<ILibraryMonitor> _libraryMonitorFactory;
  117. private readonly Func<IProviderManager> _providerManagerFactory;
  118. /// <summary>
  119. /// The _library items cache
  120. /// </summary>
  121. private readonly ConcurrentDictionary<Guid, BaseItem> _libraryItemsCache;
  122. /// <summary>
  123. /// Gets the library items cache.
  124. /// </summary>
  125. /// <value>The library items cache.</value>
  126. private ConcurrentDictionary<Guid, BaseItem> LibraryItemsCache
  127. {
  128. get
  129. {
  130. return _libraryItemsCache;
  131. }
  132. }
  133. private readonly IFileSystem _fileSystem;
  134. /// <summary>
  135. /// Initializes a new instance of the <see cref="LibraryManager" /> class.
  136. /// </summary>
  137. /// <param name="logger">The logger.</param>
  138. /// <param name="taskManager">The task manager.</param>
  139. /// <param name="userManager">The user manager.</param>
  140. /// <param name="configurationManager">The configuration manager.</param>
  141. /// <param name="userDataRepository">The user data repository.</param>
  142. public LibraryManager(ILogger logger, ITaskManager taskManager, IUserManager userManager, IServerConfigurationManager configurationManager, IUserDataManager userDataRepository, Func<ILibraryMonitor> libraryMonitorFactory, IFileSystem fileSystem, Func<IProviderManager> providerManagerFactory)
  143. {
  144. _logger = logger;
  145. _taskManager = taskManager;
  146. _userManager = userManager;
  147. ConfigurationManager = configurationManager;
  148. _userDataRepository = userDataRepository;
  149. _libraryMonitorFactory = libraryMonitorFactory;
  150. _fileSystem = fileSystem;
  151. _providerManagerFactory = providerManagerFactory;
  152. ByReferenceItems = new ConcurrentDictionary<Guid, BaseItem>();
  153. _libraryItemsCache = new ConcurrentDictionary<Guid, BaseItem>();
  154. ConfigurationManager.ConfigurationUpdated += ConfigurationUpdated;
  155. RecordConfigurationValues(configurationManager.Configuration);
  156. }
  157. /// <summary>
  158. /// Adds the parts.
  159. /// </summary>
  160. /// <param name="rules">The rules.</param>
  161. /// <param name="pluginFolders">The plugin folders.</param>
  162. /// <param name="resolvers">The resolvers.</param>
  163. /// <param name="introProviders">The intro providers.</param>
  164. /// <param name="itemComparers">The item comparers.</param>
  165. /// <param name="postscanTasks">The postscan tasks.</param>
  166. public void AddParts(IEnumerable<IResolverIgnoreRule> rules,
  167. IEnumerable<IVirtualFolderCreator> pluginFolders,
  168. IEnumerable<IItemResolver> resolvers,
  169. IEnumerable<IIntroProvider> introProviders,
  170. IEnumerable<IBaseItemComparer> itemComparers,
  171. IEnumerable<ILibraryPostScanTask> postscanTasks)
  172. {
  173. EntityResolutionIgnoreRules = rules.ToArray();
  174. PluginFolderCreators = pluginFolders.ToArray();
  175. EntityResolvers = resolvers.OrderBy(i => i.Priority).ToArray();
  176. IntroProviders = introProviders.ToArray();
  177. Comparers = itemComparers.ToArray();
  178. PostscanTasks = postscanTasks.OrderBy(i =>
  179. {
  180. var hasOrder = i as IHasOrder;
  181. return hasOrder == null ? 0 : hasOrder.Order;
  182. }).ToArray();
  183. }
  184. /// <summary>
  185. /// The _root folder
  186. /// </summary>
  187. private AggregateFolder _rootFolder;
  188. /// <summary>
  189. /// The _root folder sync lock
  190. /// </summary>
  191. private object _rootFolderSyncLock = new object();
  192. /// <summary>
  193. /// The _root folder initialized
  194. /// </summary>
  195. private bool _rootFolderInitialized;
  196. /// <summary>
  197. /// Gets the root folder.
  198. /// </summary>
  199. /// <value>The root folder.</value>
  200. public AggregateFolder RootFolder
  201. {
  202. get
  203. {
  204. LazyInitializer.EnsureInitialized(ref _rootFolder, ref _rootFolderInitialized, ref _rootFolderSyncLock, CreateRootFolder);
  205. return _rootFolder;
  206. }
  207. private set
  208. {
  209. _rootFolder = value;
  210. if (value == null)
  211. {
  212. _rootFolderInitialized = false;
  213. }
  214. }
  215. }
  216. /// <summary>
  217. /// The _items by name path
  218. /// </summary>
  219. private string _itemsByNamePath;
  220. /// <summary>
  221. /// The _season zero display name
  222. /// </summary>
  223. private string _seasonZeroDisplayName;
  224. private bool _wizardCompleted;
  225. /// <summary>
  226. /// Records the configuration values.
  227. /// </summary>
  228. /// <param name="configuration">The configuration.</param>
  229. private void RecordConfigurationValues(ServerConfiguration configuration)
  230. {
  231. _seasonZeroDisplayName = configuration.SeasonZeroDisplayName;
  232. _itemsByNamePath = ConfigurationManager.ApplicationPaths.ItemsByNamePath;
  233. _wizardCompleted = configuration.IsStartupWizardCompleted;
  234. }
  235. /// <summary>
  236. /// Configurations the updated.
  237. /// </summary>
  238. /// <param name="sender">The sender.</param>
  239. /// <param name="e">The <see cref="EventArgs" /> instance containing the event data.</param>
  240. void ConfigurationUpdated(object sender, EventArgs e)
  241. {
  242. var config = ConfigurationManager.Configuration;
  243. var ibnPathChanged = !string.Equals(_itemsByNamePath, ConfigurationManager.ApplicationPaths.ItemsByNamePath, StringComparison.Ordinal);
  244. if (ibnPathChanged)
  245. {
  246. RemoveItemsByNameFromCache();
  247. }
  248. var newSeasonZeroName = ConfigurationManager.Configuration.SeasonZeroDisplayName;
  249. var seasonZeroNameChanged = !string.Equals(_seasonZeroDisplayName, newSeasonZeroName, StringComparison.Ordinal);
  250. var wizardChanged = config.IsStartupWizardCompleted != _wizardCompleted;
  251. RecordConfigurationValues(config);
  252. Task.Run(async () =>
  253. {
  254. if (seasonZeroNameChanged)
  255. {
  256. await UpdateSeasonZeroNames(newSeasonZeroName, CancellationToken.None).ConfigureAwait(false);
  257. }
  258. if (seasonZeroNameChanged || ibnPathChanged || wizardChanged)
  259. {
  260. _taskManager.CancelIfRunningAndQueue<RefreshMediaLibraryTask>();
  261. }
  262. });
  263. }
  264. private void RemoveItemsByNameFromCache()
  265. {
  266. RemoveItemsFromCache(i => i is Person);
  267. RemoveItemsFromCache(i => i is Year);
  268. RemoveItemsFromCache(i => i is Genre);
  269. RemoveItemsFromCache(i => i is MusicGenre);
  270. RemoveItemsFromCache(i => i is GameGenre);
  271. RemoveItemsFromCache(i => i is Studio);
  272. RemoveItemsFromCache(i =>
  273. {
  274. var artist = i as MusicArtist;
  275. return artist != null && artist.IsAccessedByName;
  276. });
  277. }
  278. private void RemoveItemsFromCache(Func<BaseItem, bool> remove)
  279. {
  280. var items = _libraryItemsCache.ToList().Where(i => remove(i.Value)).ToList();
  281. foreach (var item in items)
  282. {
  283. BaseItem value;
  284. _libraryItemsCache.TryRemove(item.Key, out value);
  285. }
  286. }
  287. /// <summary>
  288. /// Updates the season zero names.
  289. /// </summary>
  290. /// <param name="newName">The new name.</param>
  291. /// <param name="cancellationToken">The cancellation token.</param>
  292. /// <returns>Task.</returns>
  293. private async Task UpdateSeasonZeroNames(string newName, CancellationToken cancellationToken)
  294. {
  295. var seasons = RootFolder.RecursiveChildren
  296. .OfType<Season>()
  297. .Where(i => i.IndexNumber.HasValue && i.IndexNumber.Value == 0 && !string.Equals(i.Name, newName, StringComparison.Ordinal))
  298. .ToList();
  299. foreach (var season in seasons)
  300. {
  301. season.Name = newName;
  302. try
  303. {
  304. await UpdateItem(season, ItemUpdateType.MetadataDownload, cancellationToken).ConfigureAwait(false);
  305. }
  306. catch (Exception ex)
  307. {
  308. _logger.ErrorException("Error saving {0}", ex, season.Path);
  309. }
  310. }
  311. }
  312. /// <summary>
  313. /// Updates the item in library cache.
  314. /// </summary>
  315. /// <param name="item">The item.</param>
  316. private void UpdateItemInLibraryCache(BaseItem item)
  317. {
  318. RegisterItem(item);
  319. }
  320. public void RegisterItem(BaseItem item)
  321. {
  322. if (item == null)
  323. {
  324. throw new ArgumentNullException("item");
  325. }
  326. RegisterItem(item.Id, item);
  327. }
  328. private void RegisterItem(Guid id, BaseItem item)
  329. {
  330. LibraryItemsCache.AddOrUpdate(id, item, delegate { return item; });
  331. }
  332. public async Task DeleteItem(BaseItem item, DeleteOptions options)
  333. {
  334. _logger.Debug("Deleting item, Type: {0}, Name: {1}, Path: {2}, Id: {3}",
  335. item.GetType().Name,
  336. item.Name,
  337. item.Path ?? string.Empty,
  338. item.Id);
  339. var parent = item.Parent;
  340. var locationType = item.LocationType;
  341. var children = item.IsFolder
  342. ? ((Folder)item).RecursiveChildren.ToList()
  343. : new List<BaseItem>();
  344. foreach (var metadataPath in GetMetadataPaths(item, children))
  345. {
  346. _logger.Debug("Deleting path {0}", metadataPath);
  347. try
  348. {
  349. Directory.Delete(metadataPath, true);
  350. }
  351. catch (DirectoryNotFoundException)
  352. {
  353. }
  354. catch (Exception ex)
  355. {
  356. _logger.ErrorException("Error deleting {0}", ex, metadataPath);
  357. }
  358. }
  359. if (options.DeleteFileLocation && locationType != LocationType.Remote && locationType != LocationType.Virtual)
  360. {
  361. foreach (var path in item.GetDeletePaths().ToList())
  362. {
  363. if (Directory.Exists(path))
  364. {
  365. _logger.Debug("Deleting path {0}", path);
  366. Directory.Delete(path, true);
  367. }
  368. else if (File.Exists(path))
  369. {
  370. _logger.Debug("Deleting path {0}", path);
  371. File.Delete(path);
  372. }
  373. }
  374. if (parent != null)
  375. {
  376. await parent.ValidateChildren(new Progress<double>(), CancellationToken.None)
  377. .ConfigureAwait(false);
  378. }
  379. }
  380. else if (parent != null)
  381. {
  382. await parent.RemoveChild(item, CancellationToken.None).ConfigureAwait(false);
  383. }
  384. await ItemRepository.DeleteItem(item.Id, CancellationToken.None).ConfigureAwait(false);
  385. foreach (var child in children)
  386. {
  387. await ItemRepository.DeleteItem(child.Id, CancellationToken.None).ConfigureAwait(false);
  388. }
  389. BaseItem removed;
  390. _libraryItemsCache.TryRemove(item.Id, out removed);
  391. ReportItemRemoved(item);
  392. }
  393. private 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. /// <returns>BaseItem.</returns>
  407. private BaseItem ResolveItem(ItemResolveArgs args)
  408. {
  409. var item = EntityResolvers.Select(r => Resolve(args, r))
  410. .FirstOrDefault(i => i != null);
  411. if (item != null)
  412. {
  413. ResolverHelper.SetInitialItemValues(item, args, _fileSystem, this);
  414. }
  415. return item;
  416. }
  417. private BaseItem Resolve(ItemResolveArgs args, IItemResolver resolver)
  418. {
  419. try
  420. {
  421. return resolver.ResolvePath(args);
  422. }
  423. catch (Exception ex)
  424. {
  425. _logger.ErrorException("Error in {0} resolving {1}", ex, resolver.GetType().Name, args.Path);
  426. return null;
  427. }
  428. }
  429. public Guid GetNewItemId(string key, Type type)
  430. {
  431. if (string.IsNullOrWhiteSpace(key))
  432. {
  433. throw new ArgumentNullException("key");
  434. }
  435. if (type == null)
  436. {
  437. throw new ArgumentNullException("type");
  438. }
  439. if (ConfigurationManager.Configuration.EnableLocalizedGuids && key.StartsWith(ConfigurationManager.ApplicationPaths.ProgramDataPath))
  440. {
  441. // Try to normalize paths located underneath program-data in an attempt to make them more portable
  442. key = key.Substring(ConfigurationManager.ApplicationPaths.ProgramDataPath.Length)
  443. .TrimStart(new[] { '/', '\\' })
  444. .Replace("/", "\\");
  445. }
  446. key = type.FullName + key.ToLower();
  447. return key.GetMD5();
  448. }
  449. public IEnumerable<BaseItem> ReplaceVideosWithPrimaryVersions(IEnumerable<BaseItem> items)
  450. {
  451. var dict = new Dictionary<Guid, BaseItem>();
  452. foreach (var item in items)
  453. {
  454. var video = item as Video;
  455. if (video != null)
  456. {
  457. if (video.PrimaryVersionId.HasValue)
  458. {
  459. var primary = GetItemById(video.PrimaryVersionId.Value) as Video;
  460. if (primary != null)
  461. {
  462. dict[primary.Id] = primary;
  463. continue;
  464. }
  465. }
  466. }
  467. dict[item.Id] = item;
  468. }
  469. return dict.Values;
  470. }
  471. /// <summary>
  472. /// Ensure supplied item has only one instance throughout
  473. /// </summary>
  474. /// <param name="item">The item.</param>
  475. /// <returns>The proper instance to the item</returns>
  476. public BaseItem GetOrAddByReferenceItem(BaseItem item)
  477. {
  478. // Add this item to our list if not there already
  479. if (!ByReferenceItems.TryAdd(item.Id, item))
  480. {
  481. // Already there - return the existing reference
  482. item = ByReferenceItems[item.Id];
  483. }
  484. return item;
  485. }
  486. public BaseItem ResolvePath(FileSystemInfo fileInfo,
  487. Folder parent = null)
  488. {
  489. return ResolvePath(fileInfo, new DirectoryService(_logger), parent);
  490. }
  491. private BaseItem ResolvePath(FileSystemInfo fileInfo, IDirectoryService directoryService, Folder parent = null, string collectionType = null)
  492. {
  493. if (fileInfo == null)
  494. {
  495. throw new ArgumentNullException("fileInfo");
  496. }
  497. var fullPath = fileInfo.FullName;
  498. if (string.IsNullOrWhiteSpace(collectionType))
  499. {
  500. collectionType = GetConfiguredContentType(fullPath);
  501. }
  502. var args = new ItemResolveArgs(ConfigurationManager.ApplicationPaths, this, directoryService)
  503. {
  504. Parent = parent,
  505. Path = fullPath,
  506. FileInfo = fileInfo,
  507. CollectionType = collectionType
  508. };
  509. // Return null if ignore rules deem that we should do so
  510. if (EntityResolutionIgnoreRules.Any(r => r.ShouldIgnore(args)))
  511. {
  512. return null;
  513. }
  514. // Gather child folder and files
  515. if (args.IsDirectory)
  516. {
  517. var isPhysicalRoot = args.IsPhysicalRoot;
  518. // When resolving the root, we need it's grandchildren (children of user views)
  519. var flattenFolderDepth = isPhysicalRoot ? 2 : 0;
  520. var fileSystemDictionary = FileData.GetFilteredFileSystemEntries(directoryService, args.Path, _fileSystem, _logger, args, flattenFolderDepth: flattenFolderDepth, resolveShortcuts: isPhysicalRoot || args.IsVf);
  521. // Need to remove subpaths that may have been resolved from shortcuts
  522. // Example: if \\server\movies exists, then strip out \\server\movies\action
  523. if (isPhysicalRoot)
  524. {
  525. var paths = NormalizeRootPathList(fileSystemDictionary.Keys);
  526. fileSystemDictionary = paths.Select(i => (FileSystemInfo)new DirectoryInfo(i)).ToDictionary(i => i.FullName);
  527. }
  528. args.FileSystemDictionary = fileSystemDictionary;
  529. }
  530. // Check to see if we should resolve based on our contents
  531. if (args.IsDirectory && !ShouldResolvePathContents(args))
  532. {
  533. return null;
  534. }
  535. return ResolveItem(args);
  536. }
  537. public IEnumerable<string> NormalizeRootPathList(IEnumerable<string> paths)
  538. {
  539. var list = paths.Select(_fileSystem.NormalizePath)
  540. .Distinct(StringComparer.OrdinalIgnoreCase)
  541. .ToList();
  542. var dupes = list.Where(subPath => !subPath.EndsWith(":\\", StringComparison.OrdinalIgnoreCase) && list.Any(i => _fileSystem.ContainsSubPath(i, subPath)))
  543. .ToList();
  544. foreach (var dupe in dupes)
  545. {
  546. _logger.Info("Found duplicate path: {0}", dupe);
  547. }
  548. return list.Except(dupes, StringComparer.OrdinalIgnoreCase);
  549. }
  550. /// <summary>
  551. /// Determines whether a path should be ignored based on its contents - called after the contents have been read
  552. /// </summary>
  553. /// <param name="args">The args.</param>
  554. /// <returns><c>true</c> if XXXX, <c>false</c> otherwise</returns>
  555. private static bool ShouldResolvePathContents(ItemResolveArgs args)
  556. {
  557. // Ignore any folders containing a file called .ignore
  558. return !args.ContainsFileSystemEntryByName(".ignore");
  559. }
  560. public IEnumerable<BaseItem> ResolvePaths(IEnumerable<FileSystemInfo> files, IDirectoryService directoryService, Folder parent, string collectionType)
  561. {
  562. var fileList = files.ToList();
  563. if (parent != null)
  564. {
  565. var multiItemResolvers = EntityResolvers.OfType<IMultiItemResolver>();
  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));
  578. return items;
  579. }
  580. }
  581. }
  582. return ResolveFileList(fileList, directoryService, parent, collectionType);
  583. }
  584. private IEnumerable<BaseItem> ResolveFileList(IEnumerable<FileSystemInfo> fileList, IDirectoryService directoryService, Folder parent, string collectionType)
  585. {
  586. return fileList.Select(f =>
  587. {
  588. try
  589. {
  590. return ResolvePath(f, directoryService, 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. Directory.CreateDirectory(rootFolderPath);
  608. var rootFolder = GetItemById(GetNewItemId(rootFolderPath, typeof(AggregateFolder))) as AggregateFolder ?? (AggregateFolder)ResolvePath(new DirectoryInfo(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. folder = GetItemById(folder.Id) as BasePluginFolder ?? folder;
  627. rootFolder.AddVirtualChild(folder);
  628. RegisterItem(folder);
  629. }
  630. }
  631. return rootFolder;
  632. }
  633. private UserRootFolder _userRootFolder;
  634. private readonly object _syncLock = new object();
  635. public Folder GetUserRootFolder()
  636. {
  637. if (_userRootFolder == null)
  638. {
  639. lock (_syncLock)
  640. {
  641. if (_userRootFolder == null)
  642. {
  643. var userRootPath = ConfigurationManager.ApplicationPaths.DefaultUserViewsPath;
  644. Directory.CreateDirectory(userRootPath);
  645. _userRootFolder = GetItemById(GetNewItemId(userRootPath, typeof(UserRootFolder))) as UserRootFolder;
  646. if (_userRootFolder == null)
  647. {
  648. _userRootFolder = (UserRootFolder)ResolvePath(new DirectoryInfo(userRootPath));
  649. }
  650. }
  651. }
  652. }
  653. return _userRootFolder;
  654. }
  655. /// <summary>
  656. /// Gets a Person
  657. /// </summary>
  658. /// <param name="name">The name.</param>
  659. /// <returns>Task{Person}.</returns>
  660. public Person GetPerson(string name)
  661. {
  662. return GetItemByName<Person>(ConfigurationManager.ApplicationPaths.PeoplePath, name);
  663. }
  664. /// <summary>
  665. /// Gets a Studio
  666. /// </summary>
  667. /// <param name="name">The name.</param>
  668. /// <returns>Task{Studio}.</returns>
  669. public Studio GetStudio(string name)
  670. {
  671. return GetItemByName<Studio>(ConfigurationManager.ApplicationPaths.StudioPath, name);
  672. }
  673. /// <summary>
  674. /// Gets a Genre
  675. /// </summary>
  676. /// <param name="name">The name.</param>
  677. /// <returns>Task{Genre}.</returns>
  678. public Genre GetGenre(string name)
  679. {
  680. return GetItemByName<Genre>(ConfigurationManager.ApplicationPaths.GenrePath, name);
  681. }
  682. /// <summary>
  683. /// Gets the genre.
  684. /// </summary>
  685. /// <param name="name">The name.</param>
  686. /// <returns>Task{MusicGenre}.</returns>
  687. public MusicGenre GetMusicGenre(string name)
  688. {
  689. return GetItemByName<MusicGenre>(ConfigurationManager.ApplicationPaths.MusicGenrePath, name);
  690. }
  691. /// <summary>
  692. /// Gets the game genre.
  693. /// </summary>
  694. /// <param name="name">The name.</param>
  695. /// <returns>Task{GameGenre}.</returns>
  696. public GameGenre GetGameGenre(string name)
  697. {
  698. return GetItemByName<GameGenre>(ConfigurationManager.ApplicationPaths.GameGenrePath, name);
  699. }
  700. /// <summary>
  701. /// The us culture
  702. /// </summary>
  703. private static readonly CultureInfo UsCulture = new CultureInfo("en-US");
  704. /// <summary>
  705. /// Gets a Year
  706. /// </summary>
  707. /// <param name="value">The value.</param>
  708. /// <returns>Task{Year}.</returns>
  709. /// <exception cref="System.ArgumentOutOfRangeException"></exception>
  710. public Year GetYear(int value)
  711. {
  712. if (value <= 0)
  713. {
  714. throw new ArgumentOutOfRangeException("Years less than or equal to 0 are invalid.");
  715. }
  716. return GetItemByName<Year>(ConfigurationManager.ApplicationPaths.YearPath, value.ToString(UsCulture));
  717. }
  718. /// <summary>
  719. /// Gets a Genre
  720. /// </summary>
  721. /// <param name="name">The name.</param>
  722. /// <returns>Task{Genre}.</returns>
  723. public MusicArtist GetArtist(string name)
  724. {
  725. return GetItemByName<MusicArtist>(ConfigurationManager.ApplicationPaths.ArtistsPath, name);
  726. }
  727. private T GetItemByName<T>(string path, string name)
  728. where T : BaseItem, new()
  729. {
  730. if (string.IsNullOrWhiteSpace(path))
  731. {
  732. throw new ArgumentNullException("path");
  733. }
  734. if (string.IsNullOrWhiteSpace(name))
  735. {
  736. throw new ArgumentNullException("name");
  737. }
  738. var validFilename = _fileSystem.GetValidFilename(name).Trim();
  739. string subFolderPrefix = null;
  740. var type = typeof(T);
  741. if (type == typeof(Person))
  742. {
  743. subFolderPrefix = validFilename.Substring(0, 1);
  744. }
  745. var fullPath = string.IsNullOrEmpty(subFolderPrefix) ?
  746. Path.Combine(path, validFilename) :
  747. Path.Combine(path, subFolderPrefix, validFilename);
  748. var id = GetNewItemId(fullPath, type);
  749. BaseItem obj;
  750. if (!_libraryItemsCache.TryGetValue(id, out obj))
  751. {
  752. obj = CreateItemByName<T>(fullPath, name, id);
  753. RegisterItem(id, obj);
  754. }
  755. return obj as T;
  756. }
  757. /// <summary>
  758. /// Creates an IBN item based on a given path
  759. /// </summary>
  760. /// <typeparam name="T"></typeparam>
  761. /// <param name="path">The path.</param>
  762. /// <param name="name">The name.</param>
  763. /// <returns>Task{``0}.</returns>
  764. /// <exception cref="System.IO.IOException">Path not created: + path</exception>
  765. private T CreateItemByName<T>(string path, string name, Guid id)
  766. where T : BaseItem, new()
  767. {
  768. var isArtist = typeof(T) == typeof(MusicArtist);
  769. if (isArtist)
  770. {
  771. var validFilename = _fileSystem.GetValidFilename(name).Trim();
  772. var existing = RootFolder.RecursiveChildren
  773. .OfType<T>()
  774. .FirstOrDefault(i => string.Equals(_fileSystem.GetValidFilename(i.Name).Trim(), validFilename, StringComparison.OrdinalIgnoreCase));
  775. if (existing != null)
  776. {
  777. return existing;
  778. }
  779. }
  780. var fileInfo = new DirectoryInfo(path);
  781. var isNew = false;
  782. if (!fileInfo.Exists)
  783. {
  784. fileInfo = Directory.CreateDirectory(path);
  785. isNew = true;
  786. }
  787. var item = isNew ? null : GetItemById(id) as T;
  788. if (item == null)
  789. {
  790. item = new T
  791. {
  792. Name = name,
  793. Id = id,
  794. DateCreated = _fileSystem.GetCreationTimeUtc(fileInfo),
  795. DateModified = _fileSystem.GetLastWriteTimeUtc(fileInfo),
  796. Path = path
  797. };
  798. }
  799. if (isArtist)
  800. {
  801. (item as MusicArtist).IsAccessedByName = true;
  802. }
  803. return item;
  804. }
  805. /// <summary>
  806. /// Validate and refresh the People sub-set of the IBN.
  807. /// The items are stored in the db but not loaded into memory until actually requested by an operation.
  808. /// </summary>
  809. /// <param name="cancellationToken">The cancellation token.</param>
  810. /// <param name="progress">The progress.</param>
  811. /// <returns>Task.</returns>
  812. public Task ValidatePeople(CancellationToken cancellationToken, IProgress<double> progress)
  813. {
  814. // Ensure the location is available.
  815. Directory.CreateDirectory(ConfigurationManager.ApplicationPaths.PeoplePath);
  816. return new PeopleValidator(this, _logger, ConfigurationManager).ValidatePeople(cancellationToken, progress);
  817. }
  818. /// <summary>
  819. /// Validates the artists.
  820. /// </summary>
  821. /// <param name="cancellationToken">The cancellation token.</param>
  822. /// <param name="progress">The progress.</param>
  823. /// <returns>Task.</returns>
  824. public Task ValidateArtists(CancellationToken cancellationToken, IProgress<double> progress)
  825. {
  826. // Ensure the location is unavailable.
  827. Directory.CreateDirectory(ConfigurationManager.ApplicationPaths.ArtistsPath);
  828. return new ArtistsValidator(this, _userManager, _logger).Run(progress, cancellationToken);
  829. }
  830. /// <summary>
  831. /// Validates the music genres.
  832. /// </summary>
  833. /// <param name="cancellationToken">The cancellation token.</param>
  834. /// <param name="progress">The progress.</param>
  835. /// <returns>Task.</returns>
  836. public Task ValidateMusicGenres(CancellationToken cancellationToken, IProgress<double> progress)
  837. {
  838. // Ensure the location is unavailable.
  839. Directory.CreateDirectory(ConfigurationManager.ApplicationPaths.MusicGenrePath);
  840. return new MusicGenresValidator(this, _logger).Run(progress, cancellationToken);
  841. }
  842. /// <summary>
  843. /// Validates the game genres.
  844. /// </summary>
  845. /// <param name="cancellationToken">The cancellation token.</param>
  846. /// <param name="progress">The progress.</param>
  847. /// <returns>Task.</returns>
  848. public Task ValidateGameGenres(CancellationToken cancellationToken, IProgress<double> progress)
  849. {
  850. // Ensure the location is unavailable.
  851. Directory.CreateDirectory(ConfigurationManager.ApplicationPaths.GameGenrePath);
  852. return new GameGenresValidator(this, _userManager, _logger).Run(progress, cancellationToken);
  853. }
  854. /// <summary>
  855. /// Validates the studios.
  856. /// </summary>
  857. /// <param name="cancellationToken">The cancellation token.</param>
  858. /// <param name="progress">The progress.</param>
  859. /// <returns>Task.</returns>
  860. public Task ValidateStudios(CancellationToken cancellationToken, IProgress<double> progress)
  861. {
  862. // Ensure the location is unavailable.
  863. Directory.CreateDirectory(ConfigurationManager.ApplicationPaths.StudioPath);
  864. return new StudiosValidator(this, _userManager, _logger).Run(progress, cancellationToken);
  865. }
  866. /// <summary>
  867. /// Validates the genres.
  868. /// </summary>
  869. /// <param name="cancellationToken">The cancellation token.</param>
  870. /// <param name="progress">The progress.</param>
  871. /// <returns>Task.</returns>
  872. public Task ValidateGenres(CancellationToken cancellationToken, IProgress<double> progress)
  873. {
  874. // Ensure the location is unavailable.
  875. Directory.CreateDirectory(ConfigurationManager.ApplicationPaths.GenrePath);
  876. return new GenresValidator(this, _userManager, _logger).Run(progress, cancellationToken);
  877. }
  878. /// <summary>
  879. /// Reloads the root media folder
  880. /// </summary>
  881. /// <param name="progress">The progress.</param>
  882. /// <param name="cancellationToken">The cancellation token.</param>
  883. /// <returns>Task.</returns>
  884. public Task ValidateMediaLibrary(IProgress<double> progress, CancellationToken cancellationToken)
  885. {
  886. // Just run the scheduled task so that the user can see it
  887. _taskManager.CancelIfRunningAndQueue<RefreshMediaLibraryTask>();
  888. return Task.FromResult(true);
  889. }
  890. /// <summary>
  891. /// Queues the library scan.
  892. /// </summary>
  893. public void QueueLibraryScan()
  894. {
  895. // Just run the scheduled task so that the user can see it
  896. _taskManager.QueueScheduledTask<RefreshMediaLibraryTask>();
  897. }
  898. /// <summary>
  899. /// Validates the media library internal.
  900. /// </summary>
  901. /// <param name="progress">The progress.</param>
  902. /// <param name="cancellationToken">The cancellation token.</param>
  903. /// <returns>Task.</returns>
  904. public async Task ValidateMediaLibraryInternal(IProgress<double> progress, CancellationToken cancellationToken)
  905. {
  906. _libraryMonitorFactory().Stop();
  907. try
  908. {
  909. await PerformLibraryValidation(progress, cancellationToken).ConfigureAwait(false);
  910. }
  911. finally
  912. {
  913. _libraryMonitorFactory().Start();
  914. }
  915. }
  916. private async Task PerformLibraryValidation(IProgress<double> progress, CancellationToken cancellationToken)
  917. {
  918. _logger.Info("Validating media library");
  919. await RootFolder.RefreshMetadata(cancellationToken).ConfigureAwait(false);
  920. progress.Report(.5);
  921. // Start by just validating the children of the root, but go no further
  922. await RootFolder.ValidateChildren(new Progress<double>(), cancellationToken, new MetadataRefreshOptions(), recursive: false);
  923. progress.Report(1);
  924. var userRoot = GetUserRootFolder();
  925. await userRoot.RefreshMetadata(cancellationToken).ConfigureAwait(false);
  926. await userRoot.ValidateChildren(new Progress<double>(), cancellationToken, new MetadataRefreshOptions(), recursive: false).ConfigureAwait(false);
  927. progress.Report(2);
  928. var innerProgress = new ActionableProgress<double>();
  929. innerProgress.RegisterAction(pct => progress.Report(2 + pct * .73));
  930. // Now validate the entire media library
  931. await RootFolder.ValidateChildren(innerProgress, cancellationToken, new MetadataRefreshOptions(), recursive: true).ConfigureAwait(false);
  932. progress.Report(75);
  933. innerProgress = new ActionableProgress<double>();
  934. innerProgress.RegisterAction(pct => progress.Report(75 + pct * .25));
  935. // Run post-scan tasks
  936. await RunPostScanTasks(innerProgress, cancellationToken).ConfigureAwait(false);
  937. progress.Report(100);
  938. // Bad practice, i know. But we keep a lot in memory, unfortunately.
  939. GC.Collect(2, GCCollectionMode.Forced, true);
  940. GC.Collect(2, GCCollectionMode.Forced, true);
  941. }
  942. /// <summary>
  943. /// Runs the post scan tasks.
  944. /// </summary>
  945. /// <param name="progress">The progress.</param>
  946. /// <param name="cancellationToken">The cancellation token.</param>
  947. /// <returns>Task.</returns>
  948. private async Task RunPostScanTasks(IProgress<double> progress, CancellationToken cancellationToken)
  949. {
  950. var tasks = PostscanTasks.ToList();
  951. var numComplete = 0;
  952. var numTasks = tasks.Count;
  953. foreach (var task in tasks)
  954. {
  955. var innerProgress = new ActionableProgress<double>();
  956. // Prevent access to modified closure
  957. var currentNumComplete = numComplete;
  958. innerProgress.RegisterAction(pct =>
  959. {
  960. double innerPercent = (currentNumComplete * 100) + pct;
  961. innerPercent /= numTasks;
  962. progress.Report(innerPercent);
  963. });
  964. try
  965. {
  966. await task.Run(innerProgress, cancellationToken);
  967. }
  968. catch (OperationCanceledException)
  969. {
  970. _logger.Info("Post-scan task cancelled: {0}", task.GetType().Name);
  971. }
  972. catch (Exception ex)
  973. {
  974. _logger.ErrorException("Error running postscan task", ex);
  975. }
  976. numComplete++;
  977. double percent = numComplete;
  978. percent /= numTasks;
  979. progress.Report(percent * 100);
  980. }
  981. progress.Report(100);
  982. }
  983. /// <summary>
  984. /// Gets the default view.
  985. /// </summary>
  986. /// <returns>IEnumerable{VirtualFolderInfo}.</returns>
  987. public IEnumerable<VirtualFolderInfo> GetDefaultVirtualFolders()
  988. {
  989. return GetView(ConfigurationManager.ApplicationPaths.DefaultUserViewsPath);
  990. }
  991. /// <summary>
  992. /// Gets the view.
  993. /// </summary>
  994. /// <param name="user">The user.</param>
  995. /// <returns>IEnumerable{VirtualFolderInfo}.</returns>
  996. public IEnumerable<VirtualFolderInfo> GetVirtualFolders(User user)
  997. {
  998. return GetDefaultVirtualFolders();
  999. }
  1000. /// <summary>
  1001. /// Gets the view.
  1002. /// </summary>
  1003. /// <param name="path">The path.</param>
  1004. /// <returns>IEnumerable{VirtualFolderInfo}.</returns>
  1005. private IEnumerable<VirtualFolderInfo> GetView(string path)
  1006. {
  1007. return Directory.EnumerateDirectories(path, "*", SearchOption.TopDirectoryOnly)
  1008. .Select(dir => new VirtualFolderInfo
  1009. {
  1010. Name = Path.GetFileName(dir),
  1011. Locations = Directory.EnumerateFiles(dir, "*.mblink", SearchOption.TopDirectoryOnly)
  1012. .Select(_fileSystem.ResolveShortcut)
  1013. .OrderBy(i => i)
  1014. .ToList(),
  1015. CollectionType = GetCollectionType(dir)
  1016. });
  1017. }
  1018. private string GetCollectionType(string path)
  1019. {
  1020. return new DirectoryInfo(path).EnumerateFiles("*.collection", SearchOption.TopDirectoryOnly)
  1021. .Select(i => _fileSystem.GetFileNameWithoutExtension(i))
  1022. .FirstOrDefault();
  1023. }
  1024. /// <summary>
  1025. /// Gets the item by id.
  1026. /// </summary>
  1027. /// <param name="id">The id.</param>
  1028. /// <returns>BaseItem.</returns>
  1029. /// <exception cref="System.ArgumentNullException">id</exception>
  1030. public BaseItem GetItemById(Guid id)
  1031. {
  1032. if (id == Guid.Empty)
  1033. {
  1034. throw new ArgumentNullException("id");
  1035. }
  1036. BaseItem item;
  1037. if (LibraryItemsCache.TryGetValue(id, out item))
  1038. {
  1039. return item;
  1040. }
  1041. item = RetrieveItem(id);
  1042. if (item != null)
  1043. {
  1044. RegisterItem(item);
  1045. }
  1046. return item;
  1047. }
  1048. public BaseItem GetMemoryItemById(Guid id)
  1049. {
  1050. if (id == Guid.Empty)
  1051. {
  1052. throw new ArgumentNullException("id");
  1053. }
  1054. BaseItem item;
  1055. LibraryItemsCache.TryGetValue(id, out item);
  1056. return item;
  1057. }
  1058. /// <summary>
  1059. /// Gets the intros.
  1060. /// </summary>
  1061. /// <param name="item">The item.</param>
  1062. /// <param name="user">The user.</param>
  1063. /// <returns>IEnumerable{System.String}.</returns>
  1064. public async Task<IEnumerable<Video>> GetIntros(BaseItem item, User user)
  1065. {
  1066. var tasks = IntroProviders
  1067. .OrderBy(i => (i.GetType().Name.IndexOf("Default", StringComparison.OrdinalIgnoreCase) == -1 ? 0 : 1))
  1068. .Take(1)
  1069. .Select(i => GetIntros(i, item, user));
  1070. var items = await Task.WhenAll(tasks).ConfigureAwait(false);
  1071. return items
  1072. .SelectMany(i => i.ToArray())
  1073. .Select(ResolveIntro)
  1074. .Where(i => i != null);
  1075. }
  1076. /// <summary>
  1077. /// Gets the intros.
  1078. /// </summary>
  1079. /// <param name="provider">The provider.</param>
  1080. /// <param name="item">The item.</param>
  1081. /// <param name="user">The user.</param>
  1082. /// <returns>Task&lt;IEnumerable&lt;IntroInfo&gt;&gt;.</returns>
  1083. private async Task<IEnumerable<IntroInfo>> GetIntros(IIntroProvider provider, BaseItem item, User user)
  1084. {
  1085. try
  1086. {
  1087. return await provider.GetIntros(item, user).ConfigureAwait(false);
  1088. }
  1089. catch (Exception ex)
  1090. {
  1091. _logger.ErrorException("Error getting intros", ex);
  1092. return new List<IntroInfo>();
  1093. }
  1094. }
  1095. /// <summary>
  1096. /// Gets all intro files.
  1097. /// </summary>
  1098. /// <returns>IEnumerable{System.String}.</returns>
  1099. public IEnumerable<string> GetAllIntroFiles()
  1100. {
  1101. return IntroProviders.SelectMany(i =>
  1102. {
  1103. try
  1104. {
  1105. return i.GetAllIntroFiles().ToList();
  1106. }
  1107. catch (Exception ex)
  1108. {
  1109. _logger.ErrorException("Error getting intro files", ex);
  1110. return new List<string>();
  1111. }
  1112. });
  1113. }
  1114. /// <summary>
  1115. /// Resolves the intro.
  1116. /// </summary>
  1117. /// <param name="info">The info.</param>
  1118. /// <returns>Video.</returns>
  1119. private Video ResolveIntro(IntroInfo info)
  1120. {
  1121. Video video = null;
  1122. if (info.ItemId.HasValue)
  1123. {
  1124. // Get an existing item by Id
  1125. video = GetItemById(info.ItemId.Value) as Video;
  1126. if (video == null)
  1127. {
  1128. _logger.Error("Unable to locate item with Id {0}.", info.ItemId.Value);
  1129. }
  1130. }
  1131. else if (!string.IsNullOrEmpty(info.Path))
  1132. {
  1133. try
  1134. {
  1135. // Try to resolve the path into a video
  1136. video = ResolvePath(_fileSystem.GetFileSystemInfo(info.Path)) as Video;
  1137. if (video == null)
  1138. {
  1139. _logger.Error("Intro resolver returned null for {0}.", info.Path);
  1140. }
  1141. else
  1142. {
  1143. // Pull the saved db item that will include metadata
  1144. var dbItem = GetItemById(video.Id) as Video;
  1145. if (dbItem != null)
  1146. {
  1147. video = dbItem;
  1148. }
  1149. }
  1150. }
  1151. catch (Exception ex)
  1152. {
  1153. _logger.ErrorException("Error resolving path {0}.", ex, info.Path);
  1154. }
  1155. }
  1156. else
  1157. {
  1158. _logger.Error("IntroProvider returned an IntroInfo with null Path and ItemId.");
  1159. }
  1160. return video;
  1161. }
  1162. /// <summary>
  1163. /// Sorts the specified sort by.
  1164. /// </summary>
  1165. /// <param name="items">The items.</param>
  1166. /// <param name="user">The user.</param>
  1167. /// <param name="sortBy">The sort by.</param>
  1168. /// <param name="sortOrder">The sort order.</param>
  1169. /// <returns>IEnumerable{BaseItem}.</returns>
  1170. public IEnumerable<BaseItem> Sort(IEnumerable<BaseItem> items, User user, IEnumerable<string> sortBy, SortOrder sortOrder)
  1171. {
  1172. var isFirst = true;
  1173. IOrderedEnumerable<BaseItem> orderedItems = null;
  1174. foreach (var orderBy in sortBy.Select(o => GetComparer(o, user)).Where(c => c != null))
  1175. {
  1176. if (isFirst)
  1177. {
  1178. orderedItems = sortOrder == SortOrder.Descending ? items.OrderByDescending(i => i, orderBy) : items.OrderBy(i => i, orderBy);
  1179. }
  1180. else
  1181. {
  1182. orderedItems = sortOrder == SortOrder.Descending ? orderedItems.ThenByDescending(i => i, orderBy) : orderedItems.ThenBy(i => i, orderBy);
  1183. }
  1184. isFirst = false;
  1185. }
  1186. return orderedItems ?? items;
  1187. }
  1188. /// <summary>
  1189. /// Gets the comparer.
  1190. /// </summary>
  1191. /// <param name="name">The name.</param>
  1192. /// <param name="user">The user.</param>
  1193. /// <returns>IBaseItemComparer.</returns>
  1194. private IBaseItemComparer GetComparer(string name, User user)
  1195. {
  1196. var comparer = Comparers.FirstOrDefault(c => string.Equals(name, c.Name, StringComparison.OrdinalIgnoreCase));
  1197. if (comparer != null)
  1198. {
  1199. // If it requires a user, create a new one, and assign the user
  1200. if (comparer is IUserBaseItemComparer)
  1201. {
  1202. var userComparer = (IUserBaseItemComparer)Activator.CreateInstance(comparer.GetType());
  1203. userComparer.User = user;
  1204. userComparer.UserManager = _userManager;
  1205. userComparer.UserDataRepository = _userDataRepository;
  1206. return userComparer;
  1207. }
  1208. }
  1209. return comparer;
  1210. }
  1211. /// <summary>
  1212. /// Creates the item.
  1213. /// </summary>
  1214. /// <param name="item">The item.</param>
  1215. /// <param name="cancellationToken">The cancellation token.</param>
  1216. /// <returns>Task.</returns>
  1217. public Task CreateItem(BaseItem item, CancellationToken cancellationToken)
  1218. {
  1219. return CreateItems(new[] { item }, cancellationToken);
  1220. }
  1221. /// <summary>
  1222. /// Creates the items.
  1223. /// </summary>
  1224. /// <param name="items">The items.</param>
  1225. /// <param name="cancellationToken">The cancellation token.</param>
  1226. /// <returns>Task.</returns>
  1227. public async Task CreateItems(IEnumerable<BaseItem> items, CancellationToken cancellationToken)
  1228. {
  1229. var list = items.ToList();
  1230. await ItemRepository.SaveItems(list, cancellationToken).ConfigureAwait(false);
  1231. foreach (var item in list)
  1232. {
  1233. UpdateItemInLibraryCache(item);
  1234. }
  1235. if (ItemAdded != null)
  1236. {
  1237. foreach (var item in list)
  1238. {
  1239. try
  1240. {
  1241. ItemAdded(this, new ItemChangeEventArgs { Item = item });
  1242. }
  1243. catch (Exception ex)
  1244. {
  1245. _logger.ErrorException("Error in ItemAdded event handler", ex);
  1246. }
  1247. }
  1248. }
  1249. }
  1250. /// <summary>
  1251. /// Updates the item.
  1252. /// </summary>
  1253. /// <param name="item">The item.</param>
  1254. /// <param name="updateReason">The update reason.</param>
  1255. /// <param name="cancellationToken">The cancellation token.</param>
  1256. /// <returns>Task.</returns>
  1257. public async Task UpdateItem(BaseItem item, ItemUpdateType updateReason, CancellationToken cancellationToken)
  1258. {
  1259. var locationType = item.LocationType;
  1260. if (locationType != LocationType.Remote && locationType != LocationType.Virtual)
  1261. {
  1262. await _providerManagerFactory().SaveMetadata(item, updateReason).ConfigureAwait(false);
  1263. }
  1264. item.DateLastSaved = DateTime.UtcNow;
  1265. var logName = item.LocationType == LocationType.Remote ? item.Name ?? item.Path : item.Path ?? item.Name;
  1266. _logger.Debug("Saving {0} to database.", logName);
  1267. await ItemRepository.SaveItem(item, cancellationToken).ConfigureAwait(false);
  1268. UpdateItemInLibraryCache(item);
  1269. if (ItemUpdated != null)
  1270. {
  1271. try
  1272. {
  1273. ItemUpdated(this, new ItemChangeEventArgs
  1274. {
  1275. Item = item,
  1276. UpdateReason = updateReason
  1277. });
  1278. }
  1279. catch (Exception ex)
  1280. {
  1281. _logger.ErrorException("Error in ItemUpdated event handler", ex);
  1282. }
  1283. }
  1284. }
  1285. /// <summary>
  1286. /// Reports the item removed.
  1287. /// </summary>
  1288. /// <param name="item">The item.</param>
  1289. public void ReportItemRemoved(BaseItem item)
  1290. {
  1291. if (ItemRemoved != null)
  1292. {
  1293. try
  1294. {
  1295. ItemRemoved(this, new ItemChangeEventArgs { Item = item });
  1296. }
  1297. catch (Exception ex)
  1298. {
  1299. _logger.ErrorException("Error in ItemRemoved event handler", ex);
  1300. }
  1301. }
  1302. }
  1303. /// <summary>
  1304. /// Retrieves the item.
  1305. /// </summary>
  1306. /// <param name="id">The id.</param>
  1307. /// <returns>BaseItem.</returns>
  1308. public BaseItem RetrieveItem(Guid id)
  1309. {
  1310. return ItemRepository.RetrieveItem(id);
  1311. }
  1312. public string GetContentType(BaseItem item)
  1313. {
  1314. // Types cannot be overridden, so go from the top down until we find a configured content type
  1315. var type = GetTopFolderContentType(item);
  1316. if (!string.IsNullOrWhiteSpace(type))
  1317. {
  1318. return type;
  1319. }
  1320. type = GetInheritedContentType(item);
  1321. if (!string.IsNullOrWhiteSpace(type))
  1322. {
  1323. return type;
  1324. }
  1325. return GetConfiguredContentType(item);
  1326. }
  1327. public string GetInheritedContentType(BaseItem item)
  1328. {
  1329. return item.Parents
  1330. .Select(GetConfiguredContentType)
  1331. .LastOrDefault(i => !string.IsNullOrWhiteSpace(i));
  1332. }
  1333. private string GetConfiguredContentType(BaseItem item)
  1334. {
  1335. return GetConfiguredContentType(item.ContainingFolderPath);
  1336. }
  1337. private string GetConfiguredContentType(string path)
  1338. {
  1339. var type = ConfigurationManager.Configuration.ContentTypes
  1340. .FirstOrDefault(i => string.Equals(i.Name, path, StringComparison.OrdinalIgnoreCase) || _fileSystem.ContainsSubPath(i.Name, path));
  1341. return type == null ? null : type.Value;
  1342. }
  1343. private string GetTopFolderContentType(BaseItem item)
  1344. {
  1345. while (!(item.Parent is AggregateFolder) && item.Parent != null)
  1346. {
  1347. item = item.Parent;
  1348. }
  1349. if (item == null)
  1350. {
  1351. return null;
  1352. }
  1353. return GetUserRootFolder().Children
  1354. .OfType<ICollectionFolder>()
  1355. .Where(i => string.Equals(i.Path, item.Path, StringComparison.OrdinalIgnoreCase) || i.PhysicalLocations.Contains(item.Path))
  1356. .Select(i => i.CollectionType)
  1357. .FirstOrDefault(i => !string.IsNullOrWhiteSpace(i));
  1358. }
  1359. public async Task<UserView> GetNamedView(string name,
  1360. string type,
  1361. string sortName,
  1362. CancellationToken cancellationToken)
  1363. {
  1364. var path = Path.Combine(ConfigurationManager.ApplicationPaths.ItemsByNamePath,
  1365. "views");
  1366. path = Path.Combine(path, _fileSystem.GetValidFilename(type));
  1367. var id = GetNewItemId(path + "_namedview_" + name, typeof(UserView));
  1368. var item = GetItemById(id) as UserView;
  1369. var refresh = false;
  1370. if (item == null ||
  1371. !string.Equals(item.Path, path, StringComparison.OrdinalIgnoreCase))
  1372. {
  1373. Directory.CreateDirectory(path);
  1374. item = new UserView
  1375. {
  1376. Path = path,
  1377. Id = id,
  1378. DateCreated = DateTime.UtcNow,
  1379. Name = name,
  1380. ViewType = type,
  1381. ForcedSortName = sortName
  1382. };
  1383. await CreateItem(item, cancellationToken).ConfigureAwait(false);
  1384. refresh = true;
  1385. }
  1386. if (!refresh && item != null)
  1387. {
  1388. refresh = (DateTime.UtcNow - item.DateLastSaved).TotalHours >= 24;
  1389. }
  1390. if (refresh)
  1391. {
  1392. await item.RefreshMetadata(new MetadataRefreshOptions
  1393. {
  1394. ForceSave = true
  1395. }, cancellationToken).ConfigureAwait(false);
  1396. }
  1397. return item;
  1398. }
  1399. public async Task<UserView> GetSpecialFolder(User user,
  1400. string name,
  1401. string parentId,
  1402. string viewType,
  1403. string sortName,
  1404. CancellationToken cancellationToken)
  1405. {
  1406. if (string.IsNullOrWhiteSpace(name))
  1407. {
  1408. throw new ArgumentNullException("name");
  1409. }
  1410. if (string.IsNullOrWhiteSpace(parentId))
  1411. {
  1412. throw new ArgumentNullException("parentId");
  1413. }
  1414. if (string.IsNullOrWhiteSpace(viewType))
  1415. {
  1416. throw new ArgumentNullException("viewType");
  1417. }
  1418. var id = GetNewItemId("7_namedview_" + name + user.Id.ToString("N") + parentId, typeof(UserView));
  1419. var path = BaseItem.GetInternalMetadataPathForId(id);
  1420. var item = GetItemById(id) as UserView;
  1421. var refresh = false;
  1422. if (item == null)
  1423. {
  1424. Directory.CreateDirectory(path);
  1425. item = new UserView
  1426. {
  1427. Path = path,
  1428. Id = id,
  1429. DateCreated = DateTime.UtcNow,
  1430. Name = name,
  1431. ViewType = viewType,
  1432. ForcedSortName = sortName,
  1433. UserId = user.Id,
  1434. ParentId = new Guid(parentId)
  1435. };
  1436. await CreateItem(item, cancellationToken).ConfigureAwait(false);
  1437. refresh = true;
  1438. }
  1439. if (!refresh && item != null)
  1440. {
  1441. refresh = (DateTime.UtcNow - item.DateLastSaved).TotalHours >= 24;
  1442. }
  1443. if (refresh)
  1444. {
  1445. await item.RefreshMetadata(new MetadataRefreshOptions
  1446. {
  1447. ForceSave = true
  1448. }, cancellationToken).ConfigureAwait(false);
  1449. }
  1450. return item;
  1451. }
  1452. public bool IsVideoFile(string path)
  1453. {
  1454. var resolver = new VideoResolver(new ExtendedNamingOptions(), new Naming.Logging.NullLogger());
  1455. return resolver.IsVideoFile(path);
  1456. }
  1457. public bool IsAudioFile(string path)
  1458. {
  1459. var parser = new AudioFileParser(new ExtendedNamingOptions());
  1460. return parser.IsAudioFile(path);
  1461. }
  1462. public int? GetSeasonNumberFromPath(string path)
  1463. {
  1464. return new SeasonPathParser(new ExtendedNamingOptions(), new RegexProvider()).Parse(path, true).SeasonNumber;
  1465. }
  1466. public bool FillMissingEpisodeNumbersFromPath(Episode episode)
  1467. {
  1468. var resolver = new EpisodeResolver(new ExtendedNamingOptions(),
  1469. new Naming.Logging.NullLogger());
  1470. var locationType = episode.LocationType;
  1471. var fileType = /*args.IsDirectory ? FileInfoType.Directory :*/ FileInfoType.File;
  1472. var episodeInfo = locationType == LocationType.FileSystem || locationType == LocationType.Offline ?
  1473. resolver.Resolve(episode.Path, fileType) :
  1474. new Naming.TV.EpisodeInfo();
  1475. if (episodeInfo == null)
  1476. {
  1477. episodeInfo = new Naming.TV.EpisodeInfo();
  1478. }
  1479. var changed = false;
  1480. if (!episode.IndexNumber.HasValue)
  1481. {
  1482. episode.IndexNumber = episodeInfo.EpisodeNumber;
  1483. if (episode.IndexNumber.HasValue)
  1484. {
  1485. changed = true;
  1486. }
  1487. }
  1488. if (!episode.IndexNumberEnd.HasValue)
  1489. {
  1490. episode.IndexNumberEnd = episodeInfo.EndingEpsiodeNumber;
  1491. if (episode.IndexNumberEnd.HasValue)
  1492. {
  1493. changed = true;
  1494. }
  1495. }
  1496. if (!episode.ParentIndexNumber.HasValue)
  1497. {
  1498. episode.ParentIndexNumber = episodeInfo.SeasonNumber;
  1499. if (!episode.ParentIndexNumber.HasValue)
  1500. {
  1501. var season = episode.Season;
  1502. if (season != null)
  1503. {
  1504. episode.ParentIndexNumber = season.IndexNumber;
  1505. }
  1506. }
  1507. if (episode.ParentIndexNumber.HasValue)
  1508. {
  1509. changed = true;
  1510. }
  1511. }
  1512. return changed;
  1513. }
  1514. public ItemLookupInfo ParseName(string name)
  1515. {
  1516. var resolver = new VideoResolver(new ExtendedNamingOptions(), new Naming.Logging.NullLogger());
  1517. var result = resolver.CleanDateTime(name);
  1518. var cleanName = resolver.CleanString(result.Name);
  1519. return new ItemLookupInfo
  1520. {
  1521. Name = cleanName.Name,
  1522. Year = result.Year
  1523. };
  1524. }
  1525. public IEnumerable<Video> FindTrailers(BaseItem owner, List<FileSystemInfo> fileSystemChildren, IDirectoryService directoryService)
  1526. {
  1527. var files = fileSystemChildren.OfType<DirectoryInfo>()
  1528. .Where(i => string.Equals(i.Name, BaseItem.TrailerFolderName, StringComparison.OrdinalIgnoreCase))
  1529. .SelectMany(i => i.EnumerateFiles("*", SearchOption.TopDirectoryOnly))
  1530. .ToList();
  1531. var videoListResolver = new VideoListResolver(new ExtendedNamingOptions(), new Naming.Logging.NullLogger());
  1532. var videos = videoListResolver.Resolve(fileSystemChildren.Select(i => new PortableFileInfo
  1533. {
  1534. FullName = i.FullName,
  1535. Type = GetFileType(i)
  1536. }).ToList());
  1537. var currentVideo = videos.FirstOrDefault(i => string.Equals(owner.Path, i.Files.First().Path, StringComparison.OrdinalIgnoreCase));
  1538. if (currentVideo != null)
  1539. {
  1540. files.AddRange(currentVideo.Extras.Where(i => string.Equals(i.ExtraType, "trailer", StringComparison.OrdinalIgnoreCase)).Select(i => new FileInfo(i.Path)));
  1541. }
  1542. return ResolvePaths(files, directoryService, null, null)
  1543. .OfType<Video>()
  1544. .Select(video =>
  1545. {
  1546. // Try to retrieve it from the db. If we don't find it, use the resolved version
  1547. var dbItem = GetItemById(video.Id) as Video;
  1548. if (dbItem != null)
  1549. {
  1550. video = dbItem;
  1551. }
  1552. video.ExtraType = ExtraType.Trailer;
  1553. return video;
  1554. // Sort them so that the list can be easily compared for changes
  1555. }).OrderBy(i => i.Path).ToList();
  1556. }
  1557. private FileInfoType GetFileType(FileSystemInfo info)
  1558. {
  1559. if ((info.Attributes & FileAttributes.Directory) == FileAttributes.Directory)
  1560. {
  1561. return FileInfoType.Directory;
  1562. }
  1563. return FileInfoType.File;
  1564. }
  1565. public IEnumerable<Video> FindExtras(BaseItem owner, List<FileSystemInfo> fileSystemChildren, IDirectoryService directoryService)
  1566. {
  1567. var files = fileSystemChildren.OfType<DirectoryInfo>()
  1568. .Where(i => string.Equals(i.Name, "extras", StringComparison.OrdinalIgnoreCase) || string.Equals(i.Name, "specials", StringComparison.OrdinalIgnoreCase))
  1569. .SelectMany(i => i.EnumerateFiles("*", SearchOption.TopDirectoryOnly))
  1570. .ToList();
  1571. var videoListResolver = new VideoListResolver(new ExtendedNamingOptions(), new Naming.Logging.NullLogger());
  1572. var videos = videoListResolver.Resolve(fileSystemChildren.Select(i => new PortableFileInfo
  1573. {
  1574. FullName = i.FullName,
  1575. Type = GetFileType(i)
  1576. }).ToList());
  1577. var currentVideo = videos.FirstOrDefault(i => string.Equals(owner.Path, i.Files.First().Path, StringComparison.OrdinalIgnoreCase));
  1578. if (currentVideo != null)
  1579. {
  1580. files.AddRange(currentVideo.Extras.Where(i => !string.Equals(i.ExtraType, "trailer", StringComparison.OrdinalIgnoreCase)).Select(i => new FileInfo(i.Path)));
  1581. }
  1582. return ResolvePaths(files, directoryService, null, null)
  1583. .OfType<Video>()
  1584. .Select(video =>
  1585. {
  1586. // Try to retrieve it from the db. If we don't find it, use the resolved version
  1587. var dbItem = GetItemById(video.Id) as Video;
  1588. if (dbItem != null)
  1589. {
  1590. video = dbItem;
  1591. }
  1592. SetExtraTypeFromFilename(video);
  1593. return video;
  1594. // Sort them so that the list can be easily compared for changes
  1595. }).OrderBy(i => i.Path).ToList();
  1596. }
  1597. private void SetExtraTypeFromFilename(Video item)
  1598. {
  1599. var resolver = new ExtraResolver(new ExtendedNamingOptions(), new Naming.Logging.NullLogger(), new RegexProvider());
  1600. var result = resolver.GetExtraInfo(item.Path);
  1601. if (string.Equals(result.ExtraType, "deletedscene", StringComparison.OrdinalIgnoreCase))
  1602. {
  1603. item.ExtraType = ExtraType.DeletedScene;
  1604. }
  1605. else if (string.Equals(result.ExtraType, "behindthescenes", StringComparison.OrdinalIgnoreCase))
  1606. {
  1607. item.ExtraType = ExtraType.BehindTheScenes;
  1608. }
  1609. else if (string.Equals(result.ExtraType, "interview", StringComparison.OrdinalIgnoreCase))
  1610. {
  1611. item.ExtraType = ExtraType.Interview;
  1612. }
  1613. else if (string.Equals(result.ExtraType, "scene", StringComparison.OrdinalIgnoreCase))
  1614. {
  1615. item.ExtraType = ExtraType.Scene;
  1616. }
  1617. else if (string.Equals(result.ExtraType, "sample", StringComparison.OrdinalIgnoreCase))
  1618. {
  1619. item.ExtraType = ExtraType.Sample;
  1620. }
  1621. else
  1622. {
  1623. item.ExtraType = ExtraType.Clip;
  1624. }
  1625. }
  1626. }
  1627. }