LibraryManager.cs 58 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680
  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.IO;
  20. using MediaBrowser.Naming.Video;
  21. using MediaBrowser.Server.Implementations.Library.Resolvers.TV;
  22. using MediaBrowser.Server.Implementations.Library.Validators;
  23. using MediaBrowser.Server.Implementations.ScheduledTasks;
  24. using MoreLinq;
  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. public BaseItem ResolveItem(ItemResolveArgs args)
  408. {
  409. var item = EntityResolvers.Select(r =>
  410. {
  411. try
  412. {
  413. return r.ResolvePath(args);
  414. }
  415. catch (Exception ex)
  416. {
  417. _logger.ErrorException("Error in {0} resolving {1}", ex, r.GetType().Name, args.Path);
  418. return null;
  419. }
  420. }).FirstOrDefault(i => i != null);
  421. if (item != null)
  422. {
  423. ResolverHelper.SetInitialItemValues(item, args, _fileSystem);
  424. }
  425. return item;
  426. }
  427. public IEnumerable<BaseItem> ReplaceVideosWithPrimaryVersions(IEnumerable<BaseItem> items)
  428. {
  429. var dict = new Dictionary<Guid, BaseItem>();
  430. foreach (var item in items)
  431. {
  432. var video = item as Video;
  433. if (video != null)
  434. {
  435. if (video.PrimaryVersionId.HasValue)
  436. {
  437. var primary = GetItemById(video.PrimaryVersionId.Value) as Video;
  438. if (primary != null)
  439. {
  440. dict[primary.Id] = primary;
  441. continue;
  442. }
  443. }
  444. }
  445. dict[item.Id] = item;
  446. }
  447. return dict.Values;
  448. }
  449. /// <summary>
  450. /// Ensure supplied item has only one instance throughout
  451. /// </summary>
  452. /// <param name="item">The item.</param>
  453. /// <returns>The proper instance to the item</returns>
  454. public BaseItem GetOrAddByReferenceItem(BaseItem item)
  455. {
  456. // Add this item to our list if not there already
  457. if (!ByReferenceItems.TryAdd(item.Id, item))
  458. {
  459. // Already there - return the existing reference
  460. item = ByReferenceItems[item.Id];
  461. }
  462. return item;
  463. }
  464. public BaseItem ResolvePath(FileSystemInfo fileInfo,
  465. Folder parent = null,
  466. string collectionType = null)
  467. {
  468. return ResolvePath(fileInfo, new DirectoryService(_logger), parent, collectionType);
  469. }
  470. public BaseItem ResolvePath(FileSystemInfo fileInfo, IDirectoryService directoryService, Folder parent = null, string collectionType = null)
  471. {
  472. if (fileInfo == null)
  473. {
  474. throw new ArgumentNullException("fileInfo");
  475. }
  476. var args = new ItemResolveArgs(ConfigurationManager.ApplicationPaths, this, directoryService)
  477. {
  478. Parent = parent,
  479. Path = fileInfo.FullName,
  480. FileInfo = fileInfo,
  481. CollectionType = collectionType
  482. };
  483. // Return null if ignore rules deem that we should do so
  484. if (EntityResolutionIgnoreRules.Any(r => r.ShouldIgnore(args)))
  485. {
  486. return null;
  487. }
  488. // Gather child folder and files
  489. if (args.IsDirectory)
  490. {
  491. var isPhysicalRoot = args.IsPhysicalRoot;
  492. // When resolving the root, we need it's grandchildren (children of user views)
  493. var flattenFolderDepth = isPhysicalRoot ? 2 : 0;
  494. var fileSystemDictionary = FileData.GetFilteredFileSystemEntries(directoryService, args.Path, _fileSystem, _logger, args, flattenFolderDepth: flattenFolderDepth, resolveShortcuts: isPhysicalRoot || args.IsVf);
  495. // Need to remove subpaths that may have been resolved from shortcuts
  496. // Example: if \\server\movies exists, then strip out \\server\movies\action
  497. if (isPhysicalRoot)
  498. {
  499. var paths = NormalizeRootPathList(fileSystemDictionary.Keys);
  500. fileSystemDictionary = paths.Select(i => (FileSystemInfo)new DirectoryInfo(i)).ToDictionary(i => i.FullName);
  501. }
  502. args.FileSystemDictionary = fileSystemDictionary;
  503. }
  504. // Check to see if we should resolve based on our contents
  505. if (args.IsDirectory && !ShouldResolvePathContents(args))
  506. {
  507. return null;
  508. }
  509. return ResolveItem(args);
  510. }
  511. public IEnumerable<string> NormalizeRootPathList(IEnumerable<string> paths)
  512. {
  513. var list = paths.Select(_fileSystem.NormalizePath)
  514. .Distinct(StringComparer.OrdinalIgnoreCase)
  515. .ToList();
  516. var dupes = list.Where(subPath => !subPath.EndsWith(":\\", StringComparison.OrdinalIgnoreCase) && list.Any(i => _fileSystem.ContainsSubPath(i, subPath)))
  517. .ToList();
  518. foreach (var dupe in dupes)
  519. {
  520. _logger.Info("Found duplicate path: {0}", dupe);
  521. }
  522. return list.Except(dupes, StringComparer.OrdinalIgnoreCase);
  523. }
  524. /// <summary>
  525. /// Determines whether a path should be ignored based on its contents - called after the contents have been read
  526. /// </summary>
  527. /// <param name="args">The args.</param>
  528. /// <returns><c>true</c> if XXXX, <c>false</c> otherwise</returns>
  529. private static bool ShouldResolvePathContents(ItemResolveArgs args)
  530. {
  531. // Ignore any folders containing a file called .ignore
  532. return !args.ContainsFileSystemEntryByName(".ignore");
  533. }
  534. public List<T> ResolvePaths<T>(IEnumerable<FileSystemInfo> files, IDirectoryService directoryService, Folder parent, string collectionType = null)
  535. where T : BaseItem
  536. {
  537. var list = new List<T>();
  538. Parallel.ForEach(files, f =>
  539. {
  540. try
  541. {
  542. var item = ResolvePath(f, directoryService, parent, collectionType) as T;
  543. if (item != null)
  544. {
  545. lock (list)
  546. {
  547. list.Add(item);
  548. }
  549. }
  550. }
  551. catch (Exception ex)
  552. {
  553. _logger.ErrorException("Error resolving path {0}", ex, f.FullName);
  554. }
  555. });
  556. return list;
  557. }
  558. /// <summary>
  559. /// Creates the root media folder
  560. /// </summary>
  561. /// <returns>AggregateFolder.</returns>
  562. /// <exception cref="System.InvalidOperationException">Cannot create the root folder until plugins have loaded</exception>
  563. public AggregateFolder CreateRootFolder()
  564. {
  565. var rootFolderPath = ConfigurationManager.ApplicationPaths.RootFolderPath;
  566. Directory.CreateDirectory(rootFolderPath);
  567. var rootFolder = GetItemById(rootFolderPath.GetMBId(typeof(AggregateFolder))) as AggregateFolder ?? (AggregateFolder)ResolvePath(new DirectoryInfo(rootFolderPath));
  568. // Add in the plug-in folders
  569. foreach (var child in PluginFolderCreators)
  570. {
  571. var folder = child.GetFolder();
  572. if (folder != null)
  573. {
  574. if (folder.Id == Guid.Empty)
  575. {
  576. folder.Id = (folder.Path ?? folder.GetType().Name).GetMBId(folder.GetType());
  577. }
  578. folder = GetItemById(folder.Id) as BasePluginFolder ?? folder;
  579. rootFolder.AddVirtualChild(folder);
  580. RegisterItem(folder);
  581. }
  582. }
  583. return rootFolder;
  584. }
  585. private UserRootFolder _userRootFolder;
  586. public Folder GetUserRootFolder()
  587. {
  588. if (_userRootFolder == null)
  589. {
  590. var userRootPath = ConfigurationManager.ApplicationPaths.DefaultUserViewsPath;
  591. Directory.CreateDirectory(userRootPath);
  592. _userRootFolder = GetItemById(userRootPath.GetMBId(typeof(UserRootFolder))) as UserRootFolder ??
  593. (UserRootFolder)ResolvePath(new DirectoryInfo(userRootPath));
  594. }
  595. return _userRootFolder;
  596. }
  597. /// <summary>
  598. /// Gets a Person
  599. /// </summary>
  600. /// <param name="name">The name.</param>
  601. /// <returns>Task{Person}.</returns>
  602. public Person GetPerson(string name)
  603. {
  604. return GetItemByName<Person>(ConfigurationManager.ApplicationPaths.PeoplePath, name);
  605. }
  606. /// <summary>
  607. /// Gets a Studio
  608. /// </summary>
  609. /// <param name="name">The name.</param>
  610. /// <returns>Task{Studio}.</returns>
  611. public Studio GetStudio(string name)
  612. {
  613. return GetItemByName<Studio>(ConfigurationManager.ApplicationPaths.StudioPath, name);
  614. }
  615. /// <summary>
  616. /// Gets a Genre
  617. /// </summary>
  618. /// <param name="name">The name.</param>
  619. /// <returns>Task{Genre}.</returns>
  620. public Genre GetGenre(string name)
  621. {
  622. return GetItemByName<Genre>(ConfigurationManager.ApplicationPaths.GenrePath, name);
  623. }
  624. /// <summary>
  625. /// Gets the genre.
  626. /// </summary>
  627. /// <param name="name">The name.</param>
  628. /// <returns>Task{MusicGenre}.</returns>
  629. public MusicGenre GetMusicGenre(string name)
  630. {
  631. return GetItemByName<MusicGenre>(ConfigurationManager.ApplicationPaths.MusicGenrePath, name);
  632. }
  633. /// <summary>
  634. /// Gets the game genre.
  635. /// </summary>
  636. /// <param name="name">The name.</param>
  637. /// <returns>Task{GameGenre}.</returns>
  638. public GameGenre GetGameGenre(string name)
  639. {
  640. return GetItemByName<GameGenre>(ConfigurationManager.ApplicationPaths.GameGenrePath, name);
  641. }
  642. /// <summary>
  643. /// The us culture
  644. /// </summary>
  645. private static readonly CultureInfo UsCulture = new CultureInfo("en-US");
  646. /// <summary>
  647. /// Gets a Year
  648. /// </summary>
  649. /// <param name="value">The value.</param>
  650. /// <returns>Task{Year}.</returns>
  651. /// <exception cref="System.ArgumentOutOfRangeException"></exception>
  652. public Year GetYear(int value)
  653. {
  654. if (value <= 0)
  655. {
  656. throw new ArgumentOutOfRangeException("Years less than or equal to 0 are invalid.");
  657. }
  658. return GetItemByName<Year>(ConfigurationManager.ApplicationPaths.YearPath, value.ToString(UsCulture));
  659. }
  660. /// <summary>
  661. /// Gets a Genre
  662. /// </summary>
  663. /// <param name="name">The name.</param>
  664. /// <returns>Task{Genre}.</returns>
  665. public MusicArtist GetArtist(string name)
  666. {
  667. return GetItemByName<MusicArtist>(ConfigurationManager.ApplicationPaths.ArtistsPath, name);
  668. }
  669. private T GetItemByName<T>(string path, string name)
  670. where T : BaseItem, new()
  671. {
  672. if (string.IsNullOrWhiteSpace(path))
  673. {
  674. throw new ArgumentNullException("path");
  675. }
  676. if (string.IsNullOrWhiteSpace(name))
  677. {
  678. throw new ArgumentNullException("name");
  679. }
  680. var validFilename = _fileSystem.GetValidFilename(name).Trim();
  681. string subFolderPrefix = null;
  682. var type = typeof(T);
  683. if (type == typeof(Person) && ConfigurationManager.Configuration.EnablePeoplePrefixSubFolders)
  684. {
  685. subFolderPrefix = validFilename.Substring(0, 1);
  686. }
  687. var fullPath = string.IsNullOrEmpty(subFolderPrefix) ?
  688. Path.Combine(path, validFilename) :
  689. Path.Combine(path, subFolderPrefix, validFilename);
  690. var id = fullPath.GetMBId(type);
  691. BaseItem obj;
  692. if (!_libraryItemsCache.TryGetValue(id, out obj))
  693. {
  694. obj = CreateItemByName<T>(fullPath, name, id);
  695. RegisterItem(id, obj);
  696. }
  697. return obj as T;
  698. }
  699. /// <summary>
  700. /// Creates an IBN item based on a given path
  701. /// </summary>
  702. /// <typeparam name="T"></typeparam>
  703. /// <param name="path">The path.</param>
  704. /// <param name="name">The name.</param>
  705. /// <returns>Task{``0}.</returns>
  706. /// <exception cref="System.IO.IOException">Path not created: + path</exception>
  707. private T CreateItemByName<T>(string path, string name, Guid id)
  708. where T : BaseItem, new()
  709. {
  710. var isArtist = typeof(T) == typeof(MusicArtist);
  711. if (isArtist)
  712. {
  713. var validFilename = _fileSystem.GetValidFilename(name).Trim();
  714. var existing = RootFolder.RecursiveChildren
  715. .OfType<T>()
  716. .FirstOrDefault(i => string.Equals(_fileSystem.GetValidFilename(i.Name).Trim(), validFilename, StringComparison.OrdinalIgnoreCase));
  717. if (existing != null)
  718. {
  719. return existing;
  720. }
  721. }
  722. var fileInfo = new DirectoryInfo(path);
  723. var isNew = false;
  724. if (!fileInfo.Exists)
  725. {
  726. fileInfo = Directory.CreateDirectory(path);
  727. isNew = true;
  728. }
  729. var item = isNew ? null : GetItemById(id) as T;
  730. if (item == null)
  731. {
  732. item = new T
  733. {
  734. Name = name,
  735. Id = id,
  736. DateCreated = _fileSystem.GetCreationTimeUtc(fileInfo),
  737. DateModified = _fileSystem.GetLastWriteTimeUtc(fileInfo),
  738. Path = path
  739. };
  740. }
  741. if (isArtist)
  742. {
  743. (item as MusicArtist).IsAccessedByName = true;
  744. }
  745. return item;
  746. }
  747. /// <summary>
  748. /// Validate and refresh the People sub-set of the IBN.
  749. /// The items are stored in the db but not loaded into memory until actually requested by an operation.
  750. /// </summary>
  751. /// <param name="cancellationToken">The cancellation token.</param>
  752. /// <param name="progress">The progress.</param>
  753. /// <returns>Task.</returns>
  754. public Task ValidatePeople(CancellationToken cancellationToken, IProgress<double> progress)
  755. {
  756. // Ensure the location is available.
  757. Directory.CreateDirectory(ConfigurationManager.ApplicationPaths.PeoplePath);
  758. return new PeopleValidator(this, _logger, ConfigurationManager).ValidatePeople(cancellationToken, progress);
  759. }
  760. /// <summary>
  761. /// Validates the artists.
  762. /// </summary>
  763. /// <param name="cancellationToken">The cancellation token.</param>
  764. /// <param name="progress">The progress.</param>
  765. /// <returns>Task.</returns>
  766. public Task ValidateArtists(CancellationToken cancellationToken, IProgress<double> progress)
  767. {
  768. // Ensure the location is unavailable.
  769. Directory.CreateDirectory(ConfigurationManager.ApplicationPaths.ArtistsPath);
  770. return new ArtistsValidator(this, _userManager, _logger).Run(progress, cancellationToken);
  771. }
  772. /// <summary>
  773. /// Validates the music genres.
  774. /// </summary>
  775. /// <param name="cancellationToken">The cancellation token.</param>
  776. /// <param name="progress">The progress.</param>
  777. /// <returns>Task.</returns>
  778. public Task ValidateMusicGenres(CancellationToken cancellationToken, IProgress<double> progress)
  779. {
  780. // Ensure the location is unavailable.
  781. Directory.CreateDirectory(ConfigurationManager.ApplicationPaths.MusicGenrePath);
  782. return new MusicGenresValidator(this, _logger).Run(progress, cancellationToken);
  783. }
  784. /// <summary>
  785. /// Validates the game genres.
  786. /// </summary>
  787. /// <param name="cancellationToken">The cancellation token.</param>
  788. /// <param name="progress">The progress.</param>
  789. /// <returns>Task.</returns>
  790. public Task ValidateGameGenres(CancellationToken cancellationToken, IProgress<double> progress)
  791. {
  792. // Ensure the location is unavailable.
  793. Directory.CreateDirectory(ConfigurationManager.ApplicationPaths.GameGenrePath);
  794. return new GameGenresValidator(this, _userManager, _logger).Run(progress, cancellationToken);
  795. }
  796. /// <summary>
  797. /// Validates the studios.
  798. /// </summary>
  799. /// <param name="cancellationToken">The cancellation token.</param>
  800. /// <param name="progress">The progress.</param>
  801. /// <returns>Task.</returns>
  802. public Task ValidateStudios(CancellationToken cancellationToken, IProgress<double> progress)
  803. {
  804. // Ensure the location is unavailable.
  805. Directory.CreateDirectory(ConfigurationManager.ApplicationPaths.StudioPath);
  806. return new StudiosValidator(this, _userManager, _logger).Run(progress, cancellationToken);
  807. }
  808. /// <summary>
  809. /// Validates the genres.
  810. /// </summary>
  811. /// <param name="cancellationToken">The cancellation token.</param>
  812. /// <param name="progress">The progress.</param>
  813. /// <returns>Task.</returns>
  814. public Task ValidateGenres(CancellationToken cancellationToken, IProgress<double> progress)
  815. {
  816. // Ensure the location is unavailable.
  817. Directory.CreateDirectory(ConfigurationManager.ApplicationPaths.GenrePath);
  818. return new GenresValidator(this, _userManager, _logger).Run(progress, cancellationToken);
  819. }
  820. /// <summary>
  821. /// Reloads the root media folder
  822. /// </summary>
  823. /// <param name="progress">The progress.</param>
  824. /// <param name="cancellationToken">The cancellation token.</param>
  825. /// <returns>Task.</returns>
  826. public Task ValidateMediaLibrary(IProgress<double> progress, CancellationToken cancellationToken)
  827. {
  828. // Just run the scheduled task so that the user can see it
  829. _taskManager.CancelIfRunningAndQueue<RefreshMediaLibraryTask>();
  830. return Task.FromResult(true);
  831. }
  832. /// <summary>
  833. /// Queues the library scan.
  834. /// </summary>
  835. public void QueueLibraryScan()
  836. {
  837. // Just run the scheduled task so that the user can see it
  838. _taskManager.QueueScheduledTask<RefreshMediaLibraryTask>();
  839. }
  840. /// <summary>
  841. /// Validates the media library internal.
  842. /// </summary>
  843. /// <param name="progress">The progress.</param>
  844. /// <param name="cancellationToken">The cancellation token.</param>
  845. /// <returns>Task.</returns>
  846. public async Task ValidateMediaLibraryInternal(IProgress<double> progress, CancellationToken cancellationToken)
  847. {
  848. _libraryMonitorFactory().Stop();
  849. try
  850. {
  851. await PerformLibraryValidation(progress, cancellationToken).ConfigureAwait(false);
  852. }
  853. finally
  854. {
  855. _libraryMonitorFactory().Start();
  856. }
  857. }
  858. private async Task PerformLibraryValidation(IProgress<double> progress, CancellationToken cancellationToken)
  859. {
  860. _logger.Info("Validating media library");
  861. await RootFolder.RefreshMetadata(cancellationToken).ConfigureAwait(false);
  862. progress.Report(.5);
  863. // Start by just validating the children of the root, but go no further
  864. await RootFolder.ValidateChildren(new Progress<double>(), cancellationToken, new MetadataRefreshOptions(), recursive: false);
  865. progress.Report(1);
  866. var userRoot = GetUserRootFolder();
  867. await userRoot.RefreshMetadata(cancellationToken).ConfigureAwait(false);
  868. await userRoot.ValidateChildren(new Progress<double>(), cancellationToken, new MetadataRefreshOptions(), recursive: false).ConfigureAwait(false);
  869. progress.Report(2);
  870. var innerProgress = new ActionableProgress<double>();
  871. innerProgress.RegisterAction(pct => progress.Report(2 + pct * .73));
  872. // Now validate the entire media library
  873. await RootFolder.ValidateChildren(innerProgress, cancellationToken, new MetadataRefreshOptions(), recursive: true).ConfigureAwait(false);
  874. progress.Report(75);
  875. innerProgress = new ActionableProgress<double>();
  876. innerProgress.RegisterAction(pct => progress.Report(75 + pct * .25));
  877. // Run post-scan tasks
  878. await RunPostScanTasks(innerProgress, cancellationToken).ConfigureAwait(false);
  879. progress.Report(100);
  880. // Bad practice, i know. But we keep a lot in memory, unfortunately.
  881. GC.Collect(2, GCCollectionMode.Forced, true);
  882. GC.Collect(2, GCCollectionMode.Forced, true);
  883. }
  884. /// <summary>
  885. /// Runs the post scan tasks.
  886. /// </summary>
  887. /// <param name="progress">The progress.</param>
  888. /// <param name="cancellationToken">The cancellation token.</param>
  889. /// <returns>Task.</returns>
  890. private async Task RunPostScanTasks(IProgress<double> progress, CancellationToken cancellationToken)
  891. {
  892. var tasks = PostscanTasks.ToList();
  893. var numComplete = 0;
  894. var numTasks = tasks.Count;
  895. foreach (var task in tasks)
  896. {
  897. var innerProgress = new ActionableProgress<double>();
  898. // Prevent access to modified closure
  899. var currentNumComplete = numComplete;
  900. innerProgress.RegisterAction(pct =>
  901. {
  902. double innerPercent = (currentNumComplete * 100) + pct;
  903. innerPercent /= numTasks;
  904. progress.Report(innerPercent);
  905. });
  906. try
  907. {
  908. await task.Run(innerProgress, cancellationToken);
  909. }
  910. catch (OperationCanceledException)
  911. {
  912. _logger.Info("Post-scan task cancelled: {0}", task.GetType().Name);
  913. }
  914. catch (Exception ex)
  915. {
  916. _logger.ErrorException("Error running postscan task", ex);
  917. }
  918. numComplete++;
  919. double percent = numComplete;
  920. percent /= numTasks;
  921. progress.Report(percent * 100);
  922. }
  923. progress.Report(100);
  924. }
  925. /// <summary>
  926. /// Gets the default view.
  927. /// </summary>
  928. /// <returns>IEnumerable{VirtualFolderInfo}.</returns>
  929. public IEnumerable<VirtualFolderInfo> GetDefaultVirtualFolders()
  930. {
  931. return GetView(ConfigurationManager.ApplicationPaths.DefaultUserViewsPath);
  932. }
  933. /// <summary>
  934. /// Gets the view.
  935. /// </summary>
  936. /// <param name="user">The user.</param>
  937. /// <returns>IEnumerable{VirtualFolderInfo}.</returns>
  938. public IEnumerable<VirtualFolderInfo> GetVirtualFolders(User user)
  939. {
  940. return GetDefaultVirtualFolders();
  941. }
  942. /// <summary>
  943. /// Gets the view.
  944. /// </summary>
  945. /// <param name="path">The path.</param>
  946. /// <returns>IEnumerable{VirtualFolderInfo}.</returns>
  947. private IEnumerable<VirtualFolderInfo> GetView(string path)
  948. {
  949. return Directory.EnumerateDirectories(path, "*", SearchOption.TopDirectoryOnly)
  950. .Select(dir => new VirtualFolderInfo
  951. {
  952. Name = Path.GetFileName(dir),
  953. Locations = Directory.EnumerateFiles(dir, "*.mblink", SearchOption.TopDirectoryOnly)
  954. .Select(_fileSystem.ResolveShortcut)
  955. .OrderBy(i => i)
  956. .ToList(),
  957. CollectionType = GetCollectionType(dir)
  958. });
  959. }
  960. private string GetCollectionType(string path)
  961. {
  962. return new DirectoryInfo(path).EnumerateFiles("*.collection", SearchOption.TopDirectoryOnly)
  963. .Select(i => _fileSystem.GetFileNameWithoutExtension(i))
  964. .FirstOrDefault();
  965. }
  966. /// <summary>
  967. /// Gets the item by id.
  968. /// </summary>
  969. /// <param name="id">The id.</param>
  970. /// <returns>BaseItem.</returns>
  971. /// <exception cref="System.ArgumentNullException">id</exception>
  972. public BaseItem GetItemById(Guid id)
  973. {
  974. if (id == Guid.Empty)
  975. {
  976. throw new ArgumentNullException("id");
  977. }
  978. BaseItem item;
  979. if (LibraryItemsCache.TryGetValue(id, out item))
  980. {
  981. return item;
  982. }
  983. item = RetrieveItem(id);
  984. if (item != null)
  985. {
  986. RegisterItem(item);
  987. }
  988. return item;
  989. }
  990. public BaseItem GetMemoryItemById(Guid id)
  991. {
  992. if (id == Guid.Empty)
  993. {
  994. throw new ArgumentNullException("id");
  995. }
  996. BaseItem item;
  997. LibraryItemsCache.TryGetValue(id, out item);
  998. return item;
  999. }
  1000. /// <summary>
  1001. /// Gets the intros.
  1002. /// </summary>
  1003. /// <param name="item">The item.</param>
  1004. /// <param name="user">The user.</param>
  1005. /// <returns>IEnumerable{System.String}.</returns>
  1006. public async Task<IEnumerable<Video>> GetIntros(BaseItem item, User user)
  1007. {
  1008. var tasks = IntroProviders
  1009. .OrderBy(i => (i.GetType().Name.IndexOf("Default", StringComparison.OrdinalIgnoreCase) == -1 ? 0 : 1))
  1010. .Take(1)
  1011. .Select(i => GetIntros(i, item, user));
  1012. var items = await Task.WhenAll(tasks).ConfigureAwait(false);
  1013. return items
  1014. .SelectMany(i => i.ToArray())
  1015. .Select(ResolveIntro)
  1016. .Where(i => i != null);
  1017. }
  1018. /// <summary>
  1019. /// Gets the intros.
  1020. /// </summary>
  1021. /// <param name="provider">The provider.</param>
  1022. /// <param name="item">The item.</param>
  1023. /// <param name="user">The user.</param>
  1024. /// <returns>Task&lt;IEnumerable&lt;IntroInfo&gt;&gt;.</returns>
  1025. private async Task<IEnumerable<IntroInfo>> GetIntros(IIntroProvider provider, BaseItem item, User user)
  1026. {
  1027. try
  1028. {
  1029. return await provider.GetIntros(item, user).ConfigureAwait(false);
  1030. }
  1031. catch (Exception ex)
  1032. {
  1033. _logger.ErrorException("Error getting intros", ex);
  1034. return new List<IntroInfo>();
  1035. }
  1036. }
  1037. /// <summary>
  1038. /// Gets all intro files.
  1039. /// </summary>
  1040. /// <returns>IEnumerable{System.String}.</returns>
  1041. public IEnumerable<string> GetAllIntroFiles()
  1042. {
  1043. return IntroProviders.SelectMany(i =>
  1044. {
  1045. try
  1046. {
  1047. return i.GetAllIntroFiles().ToList();
  1048. }
  1049. catch (Exception ex)
  1050. {
  1051. _logger.ErrorException("Error getting intro files", ex);
  1052. return new List<string>();
  1053. }
  1054. });
  1055. }
  1056. /// <summary>
  1057. /// Resolves the intro.
  1058. /// </summary>
  1059. /// <param name="info">The info.</param>
  1060. /// <returns>Video.</returns>
  1061. private Video ResolveIntro(IntroInfo info)
  1062. {
  1063. Video video = null;
  1064. if (info.ItemId.HasValue)
  1065. {
  1066. // Get an existing item by Id
  1067. video = GetItemById(info.ItemId.Value) as Video;
  1068. if (video == null)
  1069. {
  1070. _logger.Error("Unable to locate item with Id {0}.", info.ItemId.Value);
  1071. }
  1072. }
  1073. else if (!string.IsNullOrEmpty(info.Path))
  1074. {
  1075. try
  1076. {
  1077. // Try to resolve the path into a video
  1078. video = ResolvePath(_fileSystem.GetFileSystemInfo(info.Path)) as Video;
  1079. if (video == null)
  1080. {
  1081. _logger.Error("Intro resolver returned null for {0}.", info.Path);
  1082. }
  1083. else
  1084. {
  1085. // Pull the saved db item that will include metadata
  1086. var dbItem = GetItemById(video.Id) as Video;
  1087. if (dbItem != null)
  1088. {
  1089. video = dbItem;
  1090. }
  1091. }
  1092. }
  1093. catch (Exception ex)
  1094. {
  1095. _logger.ErrorException("Error resolving path {0}.", ex, info.Path);
  1096. }
  1097. }
  1098. else
  1099. {
  1100. _logger.Error("IntroProvider returned an IntroInfo with null Path and ItemId.");
  1101. }
  1102. return video;
  1103. }
  1104. /// <summary>
  1105. /// Sorts the specified sort by.
  1106. /// </summary>
  1107. /// <param name="items">The items.</param>
  1108. /// <param name="user">The user.</param>
  1109. /// <param name="sortBy">The sort by.</param>
  1110. /// <param name="sortOrder">The sort order.</param>
  1111. /// <returns>IEnumerable{BaseItem}.</returns>
  1112. public IEnumerable<BaseItem> Sort(IEnumerable<BaseItem> items, User user, IEnumerable<string> sortBy, SortOrder sortOrder)
  1113. {
  1114. var isFirst = true;
  1115. IOrderedEnumerable<BaseItem> orderedItems = null;
  1116. foreach (var orderBy in sortBy.Select(o => GetComparer(o, user)).Where(c => c != null))
  1117. {
  1118. if (isFirst)
  1119. {
  1120. orderedItems = sortOrder == SortOrder.Descending ? items.OrderByDescending(i => i, orderBy) : items.OrderBy(i => i, orderBy);
  1121. }
  1122. else
  1123. {
  1124. orderedItems = sortOrder == SortOrder.Descending ? orderedItems.ThenByDescending(i => i, orderBy) : orderedItems.ThenBy(i => i, orderBy);
  1125. }
  1126. isFirst = false;
  1127. }
  1128. return orderedItems ?? items;
  1129. }
  1130. /// <summary>
  1131. /// Gets the comparer.
  1132. /// </summary>
  1133. /// <param name="name">The name.</param>
  1134. /// <param name="user">The user.</param>
  1135. /// <returns>IBaseItemComparer.</returns>
  1136. private IBaseItemComparer GetComparer(string name, User user)
  1137. {
  1138. var comparer = Comparers.FirstOrDefault(c => string.Equals(name, c.Name, StringComparison.OrdinalIgnoreCase));
  1139. if (comparer != null)
  1140. {
  1141. // If it requires a user, create a new one, and assign the user
  1142. if (comparer is IUserBaseItemComparer)
  1143. {
  1144. var userComparer = (IUserBaseItemComparer)Activator.CreateInstance(comparer.GetType());
  1145. userComparer.User = user;
  1146. userComparer.UserManager = _userManager;
  1147. userComparer.UserDataRepository = _userDataRepository;
  1148. return userComparer;
  1149. }
  1150. }
  1151. return comparer;
  1152. }
  1153. /// <summary>
  1154. /// Creates the item.
  1155. /// </summary>
  1156. /// <param name="item">The item.</param>
  1157. /// <param name="cancellationToken">The cancellation token.</param>
  1158. /// <returns>Task.</returns>
  1159. public Task CreateItem(BaseItem item, CancellationToken cancellationToken)
  1160. {
  1161. return CreateItems(new[] { item }, cancellationToken);
  1162. }
  1163. /// <summary>
  1164. /// Creates the items.
  1165. /// </summary>
  1166. /// <param name="items">The items.</param>
  1167. /// <param name="cancellationToken">The cancellation token.</param>
  1168. /// <returns>Task.</returns>
  1169. public async Task CreateItems(IEnumerable<BaseItem> items, CancellationToken cancellationToken)
  1170. {
  1171. var list = items.ToList();
  1172. await ItemRepository.SaveItems(list, cancellationToken).ConfigureAwait(false);
  1173. foreach (var item in list)
  1174. {
  1175. UpdateItemInLibraryCache(item);
  1176. }
  1177. if (ItemAdded != null)
  1178. {
  1179. foreach (var item in list)
  1180. {
  1181. try
  1182. {
  1183. ItemAdded(this, new ItemChangeEventArgs { Item = item });
  1184. }
  1185. catch (Exception ex)
  1186. {
  1187. _logger.ErrorException("Error in ItemAdded event handler", ex);
  1188. }
  1189. }
  1190. }
  1191. }
  1192. /// <summary>
  1193. /// Updates the item.
  1194. /// </summary>
  1195. /// <param name="item">The item.</param>
  1196. /// <param name="updateReason">The update reason.</param>
  1197. /// <param name="cancellationToken">The cancellation token.</param>
  1198. /// <returns>Task.</returns>
  1199. public async Task UpdateItem(BaseItem item, ItemUpdateType updateReason, CancellationToken cancellationToken)
  1200. {
  1201. var locationType = item.LocationType;
  1202. if (locationType != LocationType.Remote && locationType != LocationType.Virtual)
  1203. {
  1204. await _providerManagerFactory().SaveMetadata(item, updateReason).ConfigureAwait(false);
  1205. }
  1206. item.DateLastSaved = DateTime.UtcNow;
  1207. var logName = item.LocationType == LocationType.Remote ? item.Name ?? item.Path : item.Path ?? item.Name;
  1208. _logger.Debug("Saving {0} to database.", logName);
  1209. await ItemRepository.SaveItem(item, cancellationToken).ConfigureAwait(false);
  1210. UpdateItemInLibraryCache(item);
  1211. if (ItemUpdated != null)
  1212. {
  1213. try
  1214. {
  1215. ItemUpdated(this, new ItemChangeEventArgs
  1216. {
  1217. Item = item,
  1218. UpdateReason = updateReason
  1219. });
  1220. }
  1221. catch (Exception ex)
  1222. {
  1223. _logger.ErrorException("Error in ItemUpdated event handler", ex);
  1224. }
  1225. }
  1226. }
  1227. /// <summary>
  1228. /// Reports the item removed.
  1229. /// </summary>
  1230. /// <param name="item">The item.</param>
  1231. public void ReportItemRemoved(BaseItem item)
  1232. {
  1233. if (ItemRemoved != null)
  1234. {
  1235. try
  1236. {
  1237. ItemRemoved(this, new ItemChangeEventArgs { Item = item });
  1238. }
  1239. catch (Exception ex)
  1240. {
  1241. _logger.ErrorException("Error in ItemRemoved event handler", ex);
  1242. }
  1243. }
  1244. }
  1245. /// <summary>
  1246. /// Retrieves the item.
  1247. /// </summary>
  1248. /// <param name="id">The id.</param>
  1249. /// <returns>BaseItem.</returns>
  1250. public BaseItem RetrieveItem(Guid id)
  1251. {
  1252. return ItemRepository.RetrieveItem(id);
  1253. }
  1254. /// <summary>
  1255. /// Finds the type of the collection.
  1256. /// </summary>
  1257. /// <param name="item">The item.</param>
  1258. /// <returns>System.String.</returns>
  1259. public string FindCollectionType(BaseItem item)
  1260. {
  1261. while (!(item.Parent is AggregateFolder) && item.Parent != null)
  1262. {
  1263. item = item.Parent;
  1264. }
  1265. if (item == null)
  1266. {
  1267. return null;
  1268. }
  1269. var collectionTypes = GetUserRootFolder().Children
  1270. .OfType<ICollectionFolder>()
  1271. .Where(i => !string.IsNullOrEmpty(i.CollectionType) && (string.Equals(i.Path, item.Path, StringComparison.OrdinalIgnoreCase) || i.PhysicalLocations.Contains(item.Path)))
  1272. .Select(i => i.CollectionType)
  1273. .Distinct()
  1274. .ToList();
  1275. return collectionTypes.Count == 1 ? collectionTypes[0] : null;
  1276. }
  1277. public async Task<UserView> GetNamedView(string name,
  1278. string type,
  1279. string sortName,
  1280. CancellationToken cancellationToken)
  1281. {
  1282. var path = Path.Combine(ConfigurationManager.ApplicationPaths.ItemsByNamePath,
  1283. "views");
  1284. path = Path.Combine(path, _fileSystem.GetValidFilename(type));
  1285. var id = (path + "_namedview_" + name).GetMBId(typeof(UserView));
  1286. var item = GetItemById(id) as UserView;
  1287. var refresh = false;
  1288. if (item == null ||
  1289. !string.Equals(item.Path, path, StringComparison.OrdinalIgnoreCase))
  1290. {
  1291. Directory.CreateDirectory(path);
  1292. item = new UserView
  1293. {
  1294. Path = path,
  1295. Id = id,
  1296. DateCreated = DateTime.UtcNow,
  1297. Name = name,
  1298. ViewType = type,
  1299. ForcedSortName = sortName
  1300. };
  1301. await CreateItem(item, cancellationToken).ConfigureAwait(false);
  1302. refresh = true;
  1303. }
  1304. if (!refresh && item != null)
  1305. {
  1306. refresh = (DateTime.UtcNow - item.DateLastSaved).TotalHours >= 24;
  1307. }
  1308. if (refresh)
  1309. {
  1310. await item.RefreshMetadata(new MetadataRefreshOptions
  1311. {
  1312. ForceSave = true
  1313. }, cancellationToken).ConfigureAwait(false);
  1314. }
  1315. return item;
  1316. }
  1317. public async Task<UserView> GetSpecialFolder(User user,
  1318. string name,
  1319. string parentId,
  1320. string viewType,
  1321. string sortName,
  1322. CancellationToken cancellationToken)
  1323. {
  1324. if (string.IsNullOrWhiteSpace(name))
  1325. {
  1326. throw new ArgumentNullException("name");
  1327. }
  1328. if (string.IsNullOrWhiteSpace(parentId))
  1329. {
  1330. throw new ArgumentNullException("parentId");
  1331. }
  1332. if (string.IsNullOrWhiteSpace(viewType))
  1333. {
  1334. throw new ArgumentNullException("viewType");
  1335. }
  1336. var id = ("7_namedview_" + name + user.Id.ToString("N") + parentId).GetMBId(typeof(UserView));
  1337. var path = BaseItem.GetInternalMetadataPathForId(id);
  1338. var item = GetItemById(id) as UserView;
  1339. var refresh = false;
  1340. if (item == null)
  1341. {
  1342. Directory.CreateDirectory(path);
  1343. item = new UserView
  1344. {
  1345. Path = path,
  1346. Id = id,
  1347. DateCreated = DateTime.UtcNow,
  1348. Name = name,
  1349. ViewType = viewType,
  1350. ForcedSortName = sortName,
  1351. UserId = user.Id,
  1352. ParentId = new Guid(parentId)
  1353. };
  1354. await CreateItem(item, cancellationToken).ConfigureAwait(false);
  1355. refresh = true;
  1356. }
  1357. if (!refresh && item != null)
  1358. {
  1359. refresh = (DateTime.UtcNow - item.DateLastSaved).TotalHours >= 24;
  1360. }
  1361. if (refresh)
  1362. {
  1363. await item.RefreshMetadata(new MetadataRefreshOptions
  1364. {
  1365. ForceSave = true
  1366. }, cancellationToken).ConfigureAwait(false);
  1367. }
  1368. return item;
  1369. }
  1370. public bool IsVideoFile(string path)
  1371. {
  1372. var parser = new VideoFileParser(new ExpandedVideoOptions(), new Naming.Logging.NullLogger());
  1373. return parser.IsVideoFile(path);
  1374. }
  1375. public bool IsAudioFile(string path)
  1376. {
  1377. var parser = new AudioFileParser(new AudioOptions());
  1378. return parser.IsAudioFile(path);
  1379. }
  1380. public bool IsMultiPartFile(string path)
  1381. {
  1382. var parser = new MultiPartParser(new ExpandedVideoOptions(), new Naming.Logging.NullLogger());
  1383. return parser.Parse(path, FileInfoType.File).IsMultiPart;
  1384. }
  1385. public bool IsMultiPartFolder(string path)
  1386. {
  1387. var parser = new MultiPartParser(new ExpandedVideoOptions(), new Naming.Logging.NullLogger());
  1388. return parser.Parse(path, FileInfoType.Directory).IsMultiPart;
  1389. }
  1390. public int? GetSeasonNumberFromPath(string path)
  1391. {
  1392. return SeriesResolver.GetSeasonNumberFromPath(path);
  1393. }
  1394. public int? GetSeasonNumberFromEpisodeFile(string path)
  1395. {
  1396. return SeriesResolver.GetSeasonNumberFromEpisodeFile(path);
  1397. }
  1398. public int? GetEndingEpisodeNumberFromFile(string path)
  1399. {
  1400. return SeriesResolver.GetEndingEpisodeNumberFromFile(path);
  1401. }
  1402. public int? GetEpisodeNumberFromFile(string path, bool considerSeasonless)
  1403. {
  1404. return SeriesResolver.GetEpisodeNumberFromFile(path, considerSeasonless);
  1405. }
  1406. }
  1407. }