LibraryManager.cs 68 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984
  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.Logging;
  25. using MediaBrowser.Server.Implementations.ScheduledTasks;
  26. using System;
  27. using System.Collections.Concurrent;
  28. using System.Collections.Generic;
  29. using System.Globalization;
  30. using System.IO;
  31. using System.Linq;
  32. using System.Threading;
  33. using System.Threading.Tasks;
  34. using SortOrder = MediaBrowser.Model.Entities.SortOrder;
  35. namespace MediaBrowser.Server.Implementations.Library
  36. {
  37. /// <summary>
  38. /// Class LibraryManager
  39. /// </summary>
  40. public class LibraryManager : ILibraryManager
  41. {
  42. /// <summary>
  43. /// Gets or sets the postscan tasks.
  44. /// </summary>
  45. /// <value>The postscan tasks.</value>
  46. private ILibraryPostScanTask[] PostscanTasks { get; set; }
  47. /// <summary>
  48. /// Gets the intro providers.
  49. /// </summary>
  50. /// <value>The intro providers.</value>
  51. private IIntroProvider[] IntroProviders { get; set; }
  52. /// <summary>
  53. /// Gets the list of entity resolution ignore rules
  54. /// </summary>
  55. /// <value>The entity resolution ignore rules.</value>
  56. private IResolverIgnoreRule[] EntityResolutionIgnoreRules { get; set; }
  57. /// <summary>
  58. /// Gets the list of BasePluginFolders added by plugins
  59. /// </summary>
  60. /// <value>The plugin folders.</value>
  61. private IVirtualFolderCreator[] PluginFolderCreators { get; set; }
  62. /// <summary>
  63. /// Gets the list of currently registered entity resolvers
  64. /// </summary>
  65. /// <value>The entity resolvers enumerable.</value>
  66. private IItemResolver[] EntityResolvers { get; set; }
  67. private IMultiItemResolver[] MultiItemResolvers { get; set; }
  68. /// <summary>
  69. /// Gets or sets the comparers.
  70. /// </summary>
  71. /// <value>The comparers.</value>
  72. private IBaseItemComparer[] Comparers { get; set; }
  73. /// <summary>
  74. /// Gets the active item repository
  75. /// </summary>
  76. /// <value>The item repository.</value>
  77. public IItemRepository ItemRepository { get; set; }
  78. /// <summary>
  79. /// Occurs when [item added].
  80. /// </summary>
  81. public event EventHandler<ItemChangeEventArgs> ItemAdded;
  82. /// <summary>
  83. /// Occurs when [item updated].
  84. /// </summary>
  85. public event EventHandler<ItemChangeEventArgs> ItemUpdated;
  86. /// <summary>
  87. /// Occurs when [item removed].
  88. /// </summary>
  89. public event EventHandler<ItemChangeEventArgs> ItemRemoved;
  90. /// <summary>
  91. /// The _logger
  92. /// </summary>
  93. private readonly ILogger _logger;
  94. /// <summary>
  95. /// The _task manager
  96. /// </summary>
  97. private readonly ITaskManager _taskManager;
  98. /// <summary>
  99. /// The _user manager
  100. /// </summary>
  101. private readonly IUserManager _userManager;
  102. /// <summary>
  103. /// The _user data repository
  104. /// </summary>
  105. private readonly IUserDataManager _userDataRepository;
  106. /// <summary>
  107. /// Gets or sets the configuration manager.
  108. /// </summary>
  109. /// <value>The configuration manager.</value>
  110. private IServerConfigurationManager ConfigurationManager { get; set; }
  111. /// <summary>
  112. /// A collection of items that may be referenced from multiple physical places in the library
  113. /// (typically, multiple user roots). We store them here and be sure they all reference a
  114. /// single instance.
  115. /// </summary>
  116. /// <value>The by reference items.</value>
  117. private ConcurrentDictionary<Guid, BaseItem> ByReferenceItems { get; set; }
  118. private readonly Func<ILibraryMonitor> _libraryMonitorFactory;
  119. private readonly Func<IProviderManager> _providerManagerFactory;
  120. /// <summary>
  121. /// The _library items cache
  122. /// </summary>
  123. private readonly ConcurrentDictionary<Guid, BaseItem> _libraryItemsCache;
  124. /// <summary>
  125. /// Gets the library items cache.
  126. /// </summary>
  127. /// <value>The library items cache.</value>
  128. private ConcurrentDictionary<Guid, BaseItem> LibraryItemsCache
  129. {
  130. get
  131. {
  132. return _libraryItemsCache;
  133. }
  134. }
  135. private readonly IFileSystem _fileSystem;
  136. /// <summary>
  137. /// Initializes a new instance of the <see cref="LibraryManager" /> class.
  138. /// </summary>
  139. /// <param name="logger">The logger.</param>
  140. /// <param name="taskManager">The task manager.</param>
  141. /// <param name="userManager">The user manager.</param>
  142. /// <param name="configurationManager">The configuration manager.</param>
  143. /// <param name="userDataRepository">The user data repository.</param>
  144. public LibraryManager(ILogger logger, ITaskManager taskManager, IUserManager userManager, IServerConfigurationManager configurationManager, IUserDataManager userDataRepository, Func<ILibraryMonitor> libraryMonitorFactory, IFileSystem fileSystem, Func<IProviderManager> providerManagerFactory)
  145. {
  146. _logger = logger;
  147. _taskManager = taskManager;
  148. _userManager = userManager;
  149. ConfigurationManager = configurationManager;
  150. _userDataRepository = userDataRepository;
  151. _libraryMonitorFactory = libraryMonitorFactory;
  152. _fileSystem = fileSystem;
  153. _providerManagerFactory = providerManagerFactory;
  154. ByReferenceItems = new ConcurrentDictionary<Guid, BaseItem>();
  155. _libraryItemsCache = new ConcurrentDictionary<Guid, BaseItem>();
  156. ConfigurationManager.ConfigurationUpdated += ConfigurationUpdated;
  157. RecordConfigurationValues(configurationManager.Configuration);
  158. }
  159. /// <summary>
  160. /// Adds the parts.
  161. /// </summary>
  162. /// <param name="rules">The rules.</param>
  163. /// <param name="pluginFolders">The plugin folders.</param>
  164. /// <param name="resolvers">The resolvers.</param>
  165. /// <param name="introProviders">The intro providers.</param>
  166. /// <param name="itemComparers">The item comparers.</param>
  167. /// <param name="postscanTasks">The postscan tasks.</param>
  168. public void AddParts(IEnumerable<IResolverIgnoreRule> rules,
  169. IEnumerable<IVirtualFolderCreator> pluginFolders,
  170. IEnumerable<IItemResolver> resolvers,
  171. IEnumerable<IIntroProvider> introProviders,
  172. IEnumerable<IBaseItemComparer> itemComparers,
  173. IEnumerable<ILibraryPostScanTask> postscanTasks)
  174. {
  175. EntityResolutionIgnoreRules = rules.ToArray();
  176. PluginFolderCreators = pluginFolders.ToArray();
  177. EntityResolvers = resolvers.OrderBy(i => i.Priority).ToArray();
  178. MultiItemResolvers = EntityResolvers.OfType<IMultiItemResolver>().ToArray();
  179. IntroProviders = introProviders.ToArray();
  180. Comparers = itemComparers.ToArray();
  181. PostscanTasks = postscanTasks.OrderBy(i =>
  182. {
  183. var hasOrder = i as IHasOrder;
  184. return hasOrder == null ? 0 : hasOrder.Order;
  185. }).ToArray();
  186. }
  187. /// <summary>
  188. /// The _root folder
  189. /// </summary>
  190. private AggregateFolder _rootFolder;
  191. /// <summary>
  192. /// The _root folder sync lock
  193. /// </summary>
  194. private readonly object _rootFolderSyncLock = new object();
  195. /// <summary>
  196. /// Gets the root folder.
  197. /// </summary>
  198. /// <value>The root folder.</value>
  199. public AggregateFolder RootFolder
  200. {
  201. get
  202. {
  203. if (_rootFolder == null)
  204. {
  205. lock (_rootFolderSyncLock)
  206. {
  207. if (_rootFolder == null)
  208. {
  209. _rootFolder = CreateRootFolder();
  210. }
  211. }
  212. }
  213. return _rootFolder;
  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.GetRecursiveChildren(i => i is Season)
  296. .Cast<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.MetadataEdit, 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).GetRecursiveChildren().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. _fileSystem.DeleteDirectory(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. _fileSystem.DeleteDirectory(path, true);
  367. }
  368. else if (File.Exists(path))
  369. {
  370. _logger.Debug("Deleting path {0}", path);
  371. _fileSystem.DeleteFile(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) && parent != null)
  499. {
  500. collectionType = GetContentTypeOverride(fullPath, true);
  501. }
  502. var args = new ItemResolveArgs(ConfigurationManager.ApplicationPaths, 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. foreach (var resolver in MultiItemResolvers)
  566. {
  567. var result = resolver.ResolveMultiple(parent, fileList, collectionType, directoryService);
  568. if (result != null && result.Items.Count > 0)
  569. {
  570. var items = new List<BaseItem>();
  571. items.AddRange(result.Items);
  572. foreach (var item in items)
  573. {
  574. ResolverHelper.SetInitialItemValues(item, parent, _fileSystem, this, directoryService);
  575. }
  576. items.AddRange(ResolveFileList(result.ExtraFiles, directoryService, parent, collectionType));
  577. return items;
  578. }
  579. }
  580. }
  581. return ResolveFileList(fileList, directoryService, parent, collectionType);
  582. }
  583. private IEnumerable<BaseItem> ResolveFileList(IEnumerable<FileSystemInfo> fileList, IDirectoryService directoryService, Folder parent, string collectionType)
  584. {
  585. return fileList.Select(f =>
  586. {
  587. try
  588. {
  589. return ResolvePath(f, directoryService, parent, collectionType);
  590. }
  591. catch (Exception ex)
  592. {
  593. _logger.ErrorException("Error resolving path {0}", ex, f.FullName);
  594. return null;
  595. }
  596. }).Where(i => i != null);
  597. }
  598. /// <summary>
  599. /// Creates the root media folder
  600. /// </summary>
  601. /// <returns>AggregateFolder.</returns>
  602. /// <exception cref="System.InvalidOperationException">Cannot create the root folder until plugins have loaded</exception>
  603. public AggregateFolder CreateRootFolder()
  604. {
  605. var rootFolderPath = ConfigurationManager.ApplicationPaths.RootFolderPath;
  606. Directory.CreateDirectory(rootFolderPath);
  607. var rootFolder = GetItemById(GetNewItemId(rootFolderPath, typeof(AggregateFolder))) as AggregateFolder ?? (AggregateFolder)ResolvePath(new DirectoryInfo(rootFolderPath));
  608. // Add in the plug-in folders
  609. foreach (var child in PluginFolderCreators)
  610. {
  611. var folder = child.GetFolder();
  612. if (folder != null)
  613. {
  614. if (folder.Id == Guid.Empty)
  615. {
  616. if (string.IsNullOrWhiteSpace(folder.Path))
  617. {
  618. folder.Id = GetNewItemId(folder.GetType().Name, folder.GetType());
  619. }
  620. else
  621. {
  622. folder.Id = GetNewItemId(folder.Path, folder.GetType());
  623. }
  624. }
  625. folder = GetItemById(folder.Id) as BasePluginFolder ?? folder;
  626. rootFolder.AddVirtualChild(folder);
  627. RegisterItem(folder);
  628. }
  629. }
  630. return rootFolder;
  631. }
  632. private UserRootFolder _userRootFolder;
  633. private readonly object _syncLock = new object();
  634. public Folder GetUserRootFolder()
  635. {
  636. if (_userRootFolder == null)
  637. {
  638. lock (_syncLock)
  639. {
  640. if (_userRootFolder == null)
  641. {
  642. var userRootPath = ConfigurationManager.ApplicationPaths.DefaultUserViewsPath;
  643. Directory.CreateDirectory(userRootPath);
  644. var tmpItem = GetItemById(GetNewItemId(userRootPath, typeof(UserRootFolder))) as UserRootFolder;
  645. if (tmpItem == null)
  646. {
  647. tmpItem = (UserRootFolder)ResolvePath(new DirectoryInfo(userRootPath));
  648. }
  649. _userRootFolder = tmpItem;
  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 the artists path.
  720. /// </summary>
  721. /// <value>The artists path.</value>
  722. public string ArtistsPath
  723. {
  724. get
  725. {
  726. return Path.Combine(ConfigurationManager.ApplicationPaths.ItemsByNamePath, "artists");
  727. }
  728. }
  729. /// <summary>
  730. /// Gets a Genre
  731. /// </summary>
  732. /// <param name="name">The name.</param>
  733. /// <returns>Task{Genre}.</returns>
  734. public MusicArtist GetArtist(string name)
  735. {
  736. return GetItemByName<MusicArtist>(ArtistsPath, name);
  737. }
  738. private T GetItemByName<T>(string path, string name)
  739. where T : BaseItem, new()
  740. {
  741. if (string.IsNullOrWhiteSpace(path))
  742. {
  743. throw new ArgumentNullException("path");
  744. }
  745. if (string.IsNullOrWhiteSpace(name))
  746. {
  747. throw new ArgumentNullException("name");
  748. }
  749. var validFilename = _fileSystem.GetValidFilename(name).Trim();
  750. string subFolderPrefix = null;
  751. var type = typeof(T);
  752. if (type == typeof(Person))
  753. {
  754. subFolderPrefix = validFilename.Substring(0, 1);
  755. }
  756. var fullPath = string.IsNullOrEmpty(subFolderPrefix) ?
  757. Path.Combine(path, validFilename) :
  758. Path.Combine(path, subFolderPrefix, validFilename);
  759. var id = GetNewItemId(fullPath, type);
  760. BaseItem obj;
  761. if (!_libraryItemsCache.TryGetValue(id, out obj))
  762. {
  763. obj = CreateItemByName<T>(fullPath, name, id);
  764. RegisterItem(id, obj);
  765. }
  766. return obj as T;
  767. }
  768. private T CreateItemByName<T>(string path, string name, Guid id)
  769. where T : BaseItem, new()
  770. {
  771. var isArtist = typeof(T) == typeof(MusicArtist);
  772. if (isArtist)
  773. {
  774. var validFilename = _fileSystem.GetValidFilename(name).Trim();
  775. var existing = RootFolder
  776. .GetRecursiveChildren(i => i is T && string.Equals(_fileSystem.GetValidFilename(i.Name).Trim(), validFilename, StringComparison.OrdinalIgnoreCase))
  777. .Cast<T>()
  778. .FirstOrDefault();
  779. if (existing != null)
  780. {
  781. return existing;
  782. }
  783. }
  784. var fileInfo = new DirectoryInfo(path);
  785. var isNew = false;
  786. if (!fileInfo.Exists)
  787. {
  788. try
  789. {
  790. fileInfo = Directory.CreateDirectory(path);
  791. }
  792. catch (UnauthorizedAccessException ex)
  793. {
  794. _logger.Error("Error creating directory {0}", ex, path);
  795. throw new Exception(string.Format("Error creating directory {0}", path), ex);
  796. }
  797. isNew = true;
  798. }
  799. var item = isNew ? null : GetItemById(id) as T;
  800. if (item == null)
  801. {
  802. item = new T
  803. {
  804. Name = name,
  805. Id = id,
  806. DateCreated = _fileSystem.GetCreationTimeUtc(fileInfo),
  807. DateModified = _fileSystem.GetLastWriteTimeUtc(fileInfo),
  808. Path = path
  809. };
  810. }
  811. if (isArtist)
  812. {
  813. (item as MusicArtist).IsAccessedByName = true;
  814. }
  815. return item;
  816. }
  817. /// <summary>
  818. /// Validate and refresh the People sub-set of the IBN.
  819. /// The items are stored in the db but not loaded into memory until actually requested by an operation.
  820. /// </summary>
  821. /// <param name="cancellationToken">The cancellation token.</param>
  822. /// <param name="progress">The progress.</param>
  823. /// <returns>Task.</returns>
  824. public Task ValidatePeople(CancellationToken cancellationToken, IProgress<double> progress)
  825. {
  826. // Ensure the location is available.
  827. Directory.CreateDirectory(ConfigurationManager.ApplicationPaths.PeoplePath);
  828. return new PeopleValidator(this, _logger, ConfigurationManager).ValidatePeople(cancellationToken, progress);
  829. }
  830. /// <summary>
  831. /// Reloads the root media folder
  832. /// </summary>
  833. /// <param name="progress">The progress.</param>
  834. /// <param name="cancellationToken">The cancellation token.</param>
  835. /// <returns>Task.</returns>
  836. public Task ValidateMediaLibrary(IProgress<double> progress, CancellationToken cancellationToken)
  837. {
  838. // Just run the scheduled task so that the user can see it
  839. _taskManager.CancelIfRunningAndQueue<RefreshMediaLibraryTask>();
  840. return Task.FromResult(true);
  841. }
  842. /// <summary>
  843. /// Queues the library scan.
  844. /// </summary>
  845. public void QueueLibraryScan()
  846. {
  847. // Just run the scheduled task so that the user can see it
  848. _taskManager.QueueScheduledTask<RefreshMediaLibraryTask>();
  849. }
  850. /// <summary>
  851. /// Validates the media library internal.
  852. /// </summary>
  853. /// <param name="progress">The progress.</param>
  854. /// <param name="cancellationToken">The cancellation token.</param>
  855. /// <returns>Task.</returns>
  856. public async Task ValidateMediaLibraryInternal(IProgress<double> progress, CancellationToken cancellationToken)
  857. {
  858. _libraryMonitorFactory().Stop();
  859. try
  860. {
  861. await PerformLibraryValidation(progress, cancellationToken).ConfigureAwait(false);
  862. }
  863. finally
  864. {
  865. _libraryMonitorFactory().Start();
  866. }
  867. }
  868. private async Task PerformLibraryValidation(IProgress<double> progress, CancellationToken cancellationToken)
  869. {
  870. _logger.Info("Validating media library");
  871. await RootFolder.RefreshMetadata(cancellationToken).ConfigureAwait(false);
  872. progress.Report(.5);
  873. // Start by just validating the children of the root, but go no further
  874. await RootFolder.ValidateChildren(new Progress<double>(), cancellationToken, new MetadataRefreshOptions(), recursive: false);
  875. progress.Report(1);
  876. var userRoot = GetUserRootFolder();
  877. await userRoot.RefreshMetadata(cancellationToken).ConfigureAwait(false);
  878. await userRoot.ValidateChildren(new Progress<double>(), cancellationToken, new MetadataRefreshOptions(), recursive: false).ConfigureAwait(false);
  879. progress.Report(2);
  880. var innerProgress = new ActionableProgress<double>();
  881. innerProgress.RegisterAction(pct => progress.Report(2 + pct * .73));
  882. // Now validate the entire media library
  883. await RootFolder.ValidateChildren(innerProgress, cancellationToken, new MetadataRefreshOptions(), recursive: true).ConfigureAwait(false);
  884. progress.Report(75);
  885. innerProgress = new ActionableProgress<double>();
  886. innerProgress.RegisterAction(pct => progress.Report(75 + pct * .25));
  887. // Run post-scan tasks
  888. await RunPostScanTasks(innerProgress, cancellationToken).ConfigureAwait(false);
  889. progress.Report(100);
  890. // Bad practice, i know. But we keep a lot in memory, unfortunately.
  891. GC.Collect(2, GCCollectionMode.Forced, true);
  892. GC.Collect(2, GCCollectionMode.Forced, true);
  893. }
  894. /// <summary>
  895. /// Runs the post scan tasks.
  896. /// </summary>
  897. /// <param name="progress">The progress.</param>
  898. /// <param name="cancellationToken">The cancellation token.</param>
  899. /// <returns>Task.</returns>
  900. private async Task RunPostScanTasks(IProgress<double> progress, CancellationToken cancellationToken)
  901. {
  902. var tasks = PostscanTasks.ToList();
  903. var numComplete = 0;
  904. var numTasks = tasks.Count;
  905. foreach (var task in tasks)
  906. {
  907. var innerProgress = new ActionableProgress<double>();
  908. // Prevent access to modified closure
  909. var currentNumComplete = numComplete;
  910. innerProgress.RegisterAction(pct =>
  911. {
  912. double innerPercent = (currentNumComplete * 100) + pct;
  913. innerPercent /= numTasks;
  914. progress.Report(innerPercent);
  915. });
  916. try
  917. {
  918. await task.Run(innerProgress, cancellationToken);
  919. }
  920. catch (OperationCanceledException)
  921. {
  922. _logger.Info("Post-scan task cancelled: {0}", task.GetType().Name);
  923. }
  924. catch (Exception ex)
  925. {
  926. _logger.ErrorException("Error running postscan task", ex);
  927. }
  928. numComplete++;
  929. double percent = numComplete;
  930. percent /= numTasks;
  931. progress.Report(percent * 100);
  932. }
  933. progress.Report(100);
  934. }
  935. /// <summary>
  936. /// Gets the default view.
  937. /// </summary>
  938. /// <returns>IEnumerable{VirtualFolderInfo}.</returns>
  939. public IEnumerable<VirtualFolderInfo> GetVirtualFolders()
  940. {
  941. return GetView(ConfigurationManager.ApplicationPaths.DefaultUserViewsPath);
  942. }
  943. /// <summary>
  944. /// Gets the view.
  945. /// </summary>
  946. /// <param name="path">The path.</param>
  947. /// <returns>IEnumerable{VirtualFolderInfo}.</returns>
  948. private IEnumerable<VirtualFolderInfo> GetView(string path)
  949. {
  950. return Directory.EnumerateDirectories(path, "*", SearchOption.TopDirectoryOnly)
  951. .Select(dir => new VirtualFolderInfo
  952. {
  953. Name = Path.GetFileName(dir),
  954. Locations = Directory.EnumerateFiles(dir, "*.mblink", SearchOption.TopDirectoryOnly)
  955. .Select(_fileSystem.ResolveShortcut)
  956. .OrderBy(i => i)
  957. .ToList(),
  958. CollectionType = GetCollectionType(dir)
  959. });
  960. }
  961. private string GetCollectionType(string path)
  962. {
  963. return new DirectoryInfo(path).EnumerateFiles("*.collection", SearchOption.TopDirectoryOnly)
  964. .Select(i => _fileSystem.GetFileNameWithoutExtension(i))
  965. .FirstOrDefault();
  966. }
  967. /// <summary>
  968. /// Gets the item by id.
  969. /// </summary>
  970. /// <param name="id">The id.</param>
  971. /// <returns>BaseItem.</returns>
  972. /// <exception cref="System.ArgumentNullException">id</exception>
  973. public BaseItem GetItemById(Guid id)
  974. {
  975. if (id == Guid.Empty)
  976. {
  977. throw new ArgumentNullException("id");
  978. }
  979. BaseItem item;
  980. if (LibraryItemsCache.TryGetValue(id, out item))
  981. {
  982. return item;
  983. }
  984. item = RetrieveItem(id);
  985. if (item != null)
  986. {
  987. RegisterItem(item);
  988. }
  989. return item;
  990. }
  991. public BaseItem GetMemoryItemById(Guid id)
  992. {
  993. if (id == Guid.Empty)
  994. {
  995. throw new ArgumentNullException("id");
  996. }
  997. BaseItem item;
  998. LibraryItemsCache.TryGetValue(id, out item);
  999. return item;
  1000. }
  1001. /// <summary>
  1002. /// Gets the intros.
  1003. /// </summary>
  1004. /// <param name="item">The item.</param>
  1005. /// <param name="user">The user.</param>
  1006. /// <returns>IEnumerable{System.String}.</returns>
  1007. public async Task<IEnumerable<Video>> GetIntros(BaseItem item, User user)
  1008. {
  1009. var tasks = IntroProviders
  1010. .OrderBy(i => (i.GetType().Name.IndexOf("Default", StringComparison.OrdinalIgnoreCase) == -1 ? 0 : 1))
  1011. .Take(1)
  1012. .Select(i => GetIntros(i, item, user));
  1013. var items = await Task.WhenAll(tasks).ConfigureAwait(false);
  1014. return items
  1015. .SelectMany(i => i.ToArray())
  1016. .Select(ResolveIntro)
  1017. .Where(i => i != null);
  1018. }
  1019. /// <summary>
  1020. /// Gets the intros.
  1021. /// </summary>
  1022. /// <param name="provider">The provider.</param>
  1023. /// <param name="item">The item.</param>
  1024. /// <param name="user">The user.</param>
  1025. /// <returns>Task&lt;IEnumerable&lt;IntroInfo&gt;&gt;.</returns>
  1026. private async Task<IEnumerable<IntroInfo>> GetIntros(IIntroProvider provider, BaseItem item, User user)
  1027. {
  1028. try
  1029. {
  1030. return await provider.GetIntros(item, user).ConfigureAwait(false);
  1031. }
  1032. catch (Exception ex)
  1033. {
  1034. _logger.ErrorException("Error getting intros", ex);
  1035. return new List<IntroInfo>();
  1036. }
  1037. }
  1038. /// <summary>
  1039. /// Gets all intro files.
  1040. /// </summary>
  1041. /// <returns>IEnumerable{System.String}.</returns>
  1042. public IEnumerable<string> GetAllIntroFiles()
  1043. {
  1044. return IntroProviders.SelectMany(i =>
  1045. {
  1046. try
  1047. {
  1048. return i.GetAllIntroFiles().ToList();
  1049. }
  1050. catch (Exception ex)
  1051. {
  1052. _logger.ErrorException("Error getting intro files", ex);
  1053. return new List<string>();
  1054. }
  1055. });
  1056. }
  1057. /// <summary>
  1058. /// Resolves the intro.
  1059. /// </summary>
  1060. /// <param name="info">The info.</param>
  1061. /// <returns>Video.</returns>
  1062. private Video ResolveIntro(IntroInfo info)
  1063. {
  1064. Video video = null;
  1065. if (info.ItemId.HasValue)
  1066. {
  1067. // Get an existing item by Id
  1068. video = GetItemById(info.ItemId.Value) as Video;
  1069. if (video == null)
  1070. {
  1071. _logger.Error("Unable to locate item with Id {0}.", info.ItemId.Value);
  1072. }
  1073. }
  1074. else if (!string.IsNullOrEmpty(info.Path))
  1075. {
  1076. try
  1077. {
  1078. // Try to resolve the path into a video
  1079. video = ResolvePath(_fileSystem.GetFileSystemInfo(info.Path)) as Video;
  1080. if (video == null)
  1081. {
  1082. _logger.Error("Intro resolver returned null for {0}.", info.Path);
  1083. }
  1084. else
  1085. {
  1086. // Pull the saved db item that will include metadata
  1087. var dbItem = GetItemById(video.Id) as Video;
  1088. if (dbItem != null)
  1089. {
  1090. video = dbItem;
  1091. }
  1092. }
  1093. }
  1094. catch (Exception ex)
  1095. {
  1096. _logger.ErrorException("Error resolving path {0}.", ex, info.Path);
  1097. }
  1098. }
  1099. else
  1100. {
  1101. _logger.Error("IntroProvider returned an IntroInfo with null Path and ItemId.");
  1102. }
  1103. return video;
  1104. }
  1105. /// <summary>
  1106. /// Sorts the specified sort by.
  1107. /// </summary>
  1108. /// <param name="items">The items.</param>
  1109. /// <param name="user">The user.</param>
  1110. /// <param name="sortBy">The sort by.</param>
  1111. /// <param name="sortOrder">The sort order.</param>
  1112. /// <returns>IEnumerable{BaseItem}.</returns>
  1113. public IEnumerable<BaseItem> Sort(IEnumerable<BaseItem> items, User user, IEnumerable<string> sortBy, SortOrder sortOrder)
  1114. {
  1115. var isFirst = true;
  1116. IOrderedEnumerable<BaseItem> orderedItems = null;
  1117. foreach (var orderBy in sortBy.Select(o => GetComparer(o, user)).Where(c => c != null))
  1118. {
  1119. if (isFirst)
  1120. {
  1121. orderedItems = sortOrder == SortOrder.Descending ? items.OrderByDescending(i => i, orderBy) : items.OrderBy(i => i, orderBy);
  1122. }
  1123. else
  1124. {
  1125. orderedItems = sortOrder == SortOrder.Descending ? orderedItems.ThenByDescending(i => i, orderBy) : orderedItems.ThenBy(i => i, orderBy);
  1126. }
  1127. isFirst = false;
  1128. }
  1129. return orderedItems ?? items;
  1130. }
  1131. /// <summary>
  1132. /// Gets the comparer.
  1133. /// </summary>
  1134. /// <param name="name">The name.</param>
  1135. /// <param name="user">The user.</param>
  1136. /// <returns>IBaseItemComparer.</returns>
  1137. private IBaseItemComparer GetComparer(string name, User user)
  1138. {
  1139. var comparer = Comparers.FirstOrDefault(c => string.Equals(name, c.Name, StringComparison.OrdinalIgnoreCase));
  1140. if (comparer != null)
  1141. {
  1142. // If it requires a user, create a new one, and assign the user
  1143. if (comparer is IUserBaseItemComparer)
  1144. {
  1145. var userComparer = (IUserBaseItemComparer)Activator.CreateInstance(comparer.GetType());
  1146. userComparer.User = user;
  1147. userComparer.UserManager = _userManager;
  1148. userComparer.UserDataRepository = _userDataRepository;
  1149. return userComparer;
  1150. }
  1151. }
  1152. return comparer;
  1153. }
  1154. /// <summary>
  1155. /// Creates the item.
  1156. /// </summary>
  1157. /// <param name="item">The item.</param>
  1158. /// <param name="cancellationToken">The cancellation token.</param>
  1159. /// <returns>Task.</returns>
  1160. public Task CreateItem(BaseItem item, CancellationToken cancellationToken)
  1161. {
  1162. return CreateItems(new[] { item }, cancellationToken);
  1163. }
  1164. /// <summary>
  1165. /// Creates the items.
  1166. /// </summary>
  1167. /// <param name="items">The items.</param>
  1168. /// <param name="cancellationToken">The cancellation token.</param>
  1169. /// <returns>Task.</returns>
  1170. public async Task CreateItems(IEnumerable<BaseItem> items, CancellationToken cancellationToken)
  1171. {
  1172. var list = items.ToList();
  1173. await ItemRepository.SaveItems(list, cancellationToken).ConfigureAwait(false);
  1174. foreach (var item in list)
  1175. {
  1176. UpdateItemInLibraryCache(item);
  1177. }
  1178. if (ItemAdded != null)
  1179. {
  1180. foreach (var item in list)
  1181. {
  1182. try
  1183. {
  1184. ItemAdded(this, new ItemChangeEventArgs { Item = item });
  1185. }
  1186. catch (Exception ex)
  1187. {
  1188. _logger.ErrorException("Error in ItemAdded event handler", ex);
  1189. }
  1190. }
  1191. }
  1192. }
  1193. /// <summary>
  1194. /// Updates the item.
  1195. /// </summary>
  1196. /// <param name="item">The item.</param>
  1197. /// <param name="updateReason">The update reason.</param>
  1198. /// <param name="cancellationToken">The cancellation token.</param>
  1199. /// <returns>Task.</returns>
  1200. public async Task UpdateItem(BaseItem item, ItemUpdateType updateReason, CancellationToken cancellationToken)
  1201. {
  1202. var locationType = item.LocationType;
  1203. if (locationType != LocationType.Remote && locationType != LocationType.Virtual)
  1204. {
  1205. await _providerManagerFactory().SaveMetadata(item, updateReason).ConfigureAwait(false);
  1206. }
  1207. item.DateLastSaved = DateTime.UtcNow;
  1208. var logName = item.LocationType == LocationType.Remote ? item.Name ?? item.Path : item.Path ?? item.Name;
  1209. _logger.Debug("Saving {0} to database.", logName);
  1210. await ItemRepository.SaveItem(item, cancellationToken).ConfigureAwait(false);
  1211. UpdateItemInLibraryCache(item);
  1212. if (ItemUpdated != null)
  1213. {
  1214. try
  1215. {
  1216. ItemUpdated(this, new ItemChangeEventArgs
  1217. {
  1218. Item = item,
  1219. UpdateReason = updateReason
  1220. });
  1221. }
  1222. catch (Exception ex)
  1223. {
  1224. _logger.ErrorException("Error in ItemUpdated event handler", ex);
  1225. }
  1226. }
  1227. }
  1228. /// <summary>
  1229. /// Reports the item removed.
  1230. /// </summary>
  1231. /// <param name="item">The item.</param>
  1232. public void ReportItemRemoved(BaseItem item)
  1233. {
  1234. if (ItemRemoved != null)
  1235. {
  1236. try
  1237. {
  1238. ItemRemoved(this, new ItemChangeEventArgs { Item = item });
  1239. }
  1240. catch (Exception ex)
  1241. {
  1242. _logger.ErrorException("Error in ItemRemoved event handler", ex);
  1243. }
  1244. }
  1245. }
  1246. /// <summary>
  1247. /// Retrieves the item.
  1248. /// </summary>
  1249. /// <param name="id">The id.</param>
  1250. /// <returns>BaseItem.</returns>
  1251. public BaseItem RetrieveItem(Guid id)
  1252. {
  1253. return ItemRepository.RetrieveItem(id);
  1254. }
  1255. public string GetContentType(BaseItem item)
  1256. {
  1257. string configuredContentType = GetConfiguredContentType(item, false);
  1258. if (!string.IsNullOrWhiteSpace(configuredContentType))
  1259. {
  1260. return configuredContentType;
  1261. }
  1262. configuredContentType = GetConfiguredContentType(item, true);
  1263. if (!string.IsNullOrWhiteSpace(configuredContentType))
  1264. {
  1265. return configuredContentType;
  1266. }
  1267. return GetInheritedContentType(item);
  1268. }
  1269. public string GetInheritedContentType(BaseItem item)
  1270. {
  1271. var type = GetTopFolderContentType(item);
  1272. if (!string.IsNullOrWhiteSpace(type))
  1273. {
  1274. return type;
  1275. }
  1276. return item.Parents
  1277. .Select(GetConfiguredContentType)
  1278. .LastOrDefault(i => !string.IsNullOrWhiteSpace(i));
  1279. }
  1280. public string GetConfiguredContentType(BaseItem item)
  1281. {
  1282. return GetConfiguredContentType(item, false);
  1283. }
  1284. public string GetConfiguredContentType(string path)
  1285. {
  1286. return GetContentTypeOverride(path, false);
  1287. }
  1288. public string GetConfiguredContentType(BaseItem item, bool inheritConfiguredPath)
  1289. {
  1290. ICollectionFolder collectionFolder = item as ICollectionFolder;
  1291. if (collectionFolder != null)
  1292. {
  1293. return collectionFolder.CollectionType;
  1294. }
  1295. return GetContentTypeOverride(item.ContainingFolderPath, inheritConfiguredPath);
  1296. }
  1297. private string GetContentTypeOverride(string path, bool inherit)
  1298. {
  1299. var nameValuePair = ConfigurationManager.Configuration.ContentTypes.FirstOrDefault(i => string.Equals(i.Name, path, StringComparison.OrdinalIgnoreCase) || (inherit && _fileSystem.ContainsSubPath(i.Name, path)));
  1300. if (nameValuePair != null)
  1301. {
  1302. return nameValuePair.Value;
  1303. }
  1304. return null;
  1305. }
  1306. private string GetTopFolderContentType(BaseItem item)
  1307. {
  1308. while (!(item.Parent is AggregateFolder) && item.Parent != null)
  1309. {
  1310. item = item.Parent;
  1311. }
  1312. if (item == null)
  1313. {
  1314. return null;
  1315. }
  1316. return GetUserRootFolder().Children
  1317. .OfType<ICollectionFolder>()
  1318. .Where(i => string.Equals(i.Path, item.Path, StringComparison.OrdinalIgnoreCase) || i.PhysicalLocations.Contains(item.Path))
  1319. .Select(i => i.CollectionType)
  1320. .FirstOrDefault(i => !string.IsNullOrWhiteSpace(i));
  1321. }
  1322. public async Task<UserView> GetNamedView(string name,
  1323. string type,
  1324. string sortName,
  1325. CancellationToken cancellationToken)
  1326. {
  1327. var path = Path.Combine(ConfigurationManager.ApplicationPaths.ItemsByNamePath,
  1328. "views");
  1329. path = Path.Combine(path, _fileSystem.GetValidFilename(type));
  1330. var id = GetNewItemId(path + "_namedview_" + name, typeof(UserView));
  1331. var item = GetItemById(id) as UserView;
  1332. var refresh = false;
  1333. if (item == null ||
  1334. !string.Equals(item.Path, path, StringComparison.OrdinalIgnoreCase))
  1335. {
  1336. Directory.CreateDirectory(path);
  1337. item = new UserView
  1338. {
  1339. Path = path,
  1340. Id = id,
  1341. DateCreated = DateTime.UtcNow,
  1342. Name = name,
  1343. ViewType = type,
  1344. ForcedSortName = sortName
  1345. };
  1346. await CreateItem(item, cancellationToken).ConfigureAwait(false);
  1347. refresh = true;
  1348. }
  1349. if (!refresh && item != null)
  1350. {
  1351. refresh = (DateTime.UtcNow - item.DateLastSaved).TotalHours >= 24;
  1352. }
  1353. if (refresh)
  1354. {
  1355. await item.RefreshMetadata(new MetadataRefreshOptions
  1356. {
  1357. ForceSave = true
  1358. }, cancellationToken).ConfigureAwait(false);
  1359. }
  1360. return item;
  1361. }
  1362. public async Task<UserView> GetSpecialFolder(User user,
  1363. string name,
  1364. string parentId,
  1365. string viewType,
  1366. string sortName,
  1367. CancellationToken cancellationToken)
  1368. {
  1369. if (string.IsNullOrWhiteSpace(name))
  1370. {
  1371. throw new ArgumentNullException("name");
  1372. }
  1373. if (string.IsNullOrWhiteSpace(parentId))
  1374. {
  1375. throw new ArgumentNullException("parentId");
  1376. }
  1377. if (string.IsNullOrWhiteSpace(viewType))
  1378. {
  1379. throw new ArgumentNullException("viewType");
  1380. }
  1381. var id = GetNewItemId("7_namedview_" + name + user.Id.ToString("N") + parentId, typeof(UserView));
  1382. var path = Path.Combine(ConfigurationManager.ApplicationPaths.InternalMetadataPath, "views", "specialviews", id.ToString("N"));
  1383. var item = GetItemById(id) as UserView;
  1384. var refresh = false;
  1385. if (item == null)
  1386. {
  1387. Directory.CreateDirectory(path);
  1388. item = new UserView
  1389. {
  1390. Path = path,
  1391. Id = id,
  1392. DateCreated = DateTime.UtcNow,
  1393. Name = name,
  1394. ViewType = viewType,
  1395. ForcedSortName = sortName,
  1396. UserId = user.Id,
  1397. ParentId = new Guid(parentId)
  1398. };
  1399. await CreateItem(item, cancellationToken).ConfigureAwait(false);
  1400. refresh = true;
  1401. }
  1402. if (!refresh && item != null)
  1403. {
  1404. refresh = (DateTime.UtcNow - item.DateLastSaved).TotalHours >= 24;
  1405. }
  1406. if (refresh)
  1407. {
  1408. await item.RefreshMetadata(new MetadataRefreshOptions
  1409. {
  1410. ForceSave = true
  1411. }, cancellationToken).ConfigureAwait(false);
  1412. }
  1413. return item;
  1414. }
  1415. public bool IsVideoFile(string path)
  1416. {
  1417. var resolver = new VideoResolver(GetNamingOptions(), new PatternsLogger());
  1418. return resolver.IsVideoFile(path);
  1419. }
  1420. public bool IsAudioFile(string path)
  1421. {
  1422. var parser = new AudioFileParser(GetNamingOptions());
  1423. return parser.IsAudioFile(path);
  1424. }
  1425. public int? GetSeasonNumberFromPath(string path)
  1426. {
  1427. return new SeasonPathParser(GetNamingOptions(), new RegexProvider()).Parse(path, true, true).SeasonNumber;
  1428. }
  1429. public bool FillMissingEpisodeNumbersFromPath(Episode episode)
  1430. {
  1431. var resolver = new EpisodeResolver(GetNamingOptions(),
  1432. new PatternsLogger());
  1433. var fileType = episode.VideoType == VideoType.BluRay || episode.VideoType == VideoType.Dvd || episode.VideoType == VideoType.HdDvd ?
  1434. FileInfoType.Directory :
  1435. FileInfoType.File;
  1436. var locationType = episode.LocationType;
  1437. var episodeInfo = locationType == LocationType.FileSystem || locationType == LocationType.Offline ?
  1438. resolver.Resolve(episode.Path, fileType) :
  1439. new Naming.TV.EpisodeInfo();
  1440. if (episodeInfo == null)
  1441. {
  1442. episodeInfo = new Naming.TV.EpisodeInfo();
  1443. }
  1444. var changed = false;
  1445. if (episodeInfo.IsByDate)
  1446. {
  1447. if (episode.IndexNumber.HasValue)
  1448. {
  1449. episode.IndexNumber = null;
  1450. changed = true;
  1451. }
  1452. if (episode.IndexNumberEnd.HasValue)
  1453. {
  1454. episode.IndexNumberEnd = null;
  1455. changed = true;
  1456. }
  1457. if (!episode.PremiereDate.HasValue)
  1458. {
  1459. if (episodeInfo.Year.HasValue && episodeInfo.Month.HasValue && episodeInfo.Day.HasValue)
  1460. {
  1461. episode.PremiereDate = new DateTime(episodeInfo.Year.Value, episodeInfo.Month.Value, episodeInfo.Day.Value).ToUniversalTime();
  1462. }
  1463. if (episode.PremiereDate.HasValue)
  1464. {
  1465. changed = true;
  1466. }
  1467. }
  1468. if (!episode.ProductionYear.HasValue)
  1469. {
  1470. episode.ProductionYear = episodeInfo.Year;
  1471. if (episode.ProductionYear.HasValue)
  1472. {
  1473. changed = true;
  1474. }
  1475. }
  1476. if (!episode.ParentIndexNumber.HasValue)
  1477. {
  1478. var season = episode.Season;
  1479. if (season != null)
  1480. {
  1481. episode.ParentIndexNumber = season.IndexNumber;
  1482. }
  1483. if (episode.ParentIndexNumber.HasValue)
  1484. {
  1485. changed = true;
  1486. }
  1487. }
  1488. }
  1489. else
  1490. {
  1491. if (!episode.IndexNumber.HasValue)
  1492. {
  1493. episode.IndexNumber = episodeInfo.EpisodeNumber;
  1494. if (episode.IndexNumber.HasValue)
  1495. {
  1496. changed = true;
  1497. }
  1498. }
  1499. if (!episode.IndexNumberEnd.HasValue)
  1500. {
  1501. episode.IndexNumberEnd = episodeInfo.EndingEpsiodeNumber;
  1502. if (episode.IndexNumberEnd.HasValue)
  1503. {
  1504. changed = true;
  1505. }
  1506. }
  1507. if (!episode.ParentIndexNumber.HasValue)
  1508. {
  1509. episode.ParentIndexNumber = episodeInfo.SeasonNumber;
  1510. if (!episode.ParentIndexNumber.HasValue)
  1511. {
  1512. var season = episode.Season;
  1513. if (season != null)
  1514. {
  1515. episode.ParentIndexNumber = season.IndexNumber;
  1516. }
  1517. }
  1518. if (episode.ParentIndexNumber.HasValue)
  1519. {
  1520. changed = true;
  1521. }
  1522. }
  1523. }
  1524. return changed;
  1525. }
  1526. public NamingOptions GetNamingOptions()
  1527. {
  1528. var options = new ExtendedNamingOptions();
  1529. if (!ConfigurationManager.Configuration.EnableAudioArchiveFiles)
  1530. {
  1531. options.AudioFileExtensions.Remove(".rar");
  1532. options.AudioFileExtensions.Remove(".zip");
  1533. }
  1534. if (!ConfigurationManager.Configuration.EnableVideoArchiveFiles)
  1535. {
  1536. options.VideoFileExtensions.Remove(".rar");
  1537. options.VideoFileExtensions.Remove(".zip");
  1538. }
  1539. return options;
  1540. }
  1541. public ItemLookupInfo ParseName(string name)
  1542. {
  1543. var resolver = new VideoResolver(GetNamingOptions(), new PatternsLogger());
  1544. var result = resolver.CleanDateTime(name);
  1545. var cleanName = resolver.CleanString(result.Name);
  1546. return new ItemLookupInfo
  1547. {
  1548. Name = cleanName.Name,
  1549. Year = result.Year
  1550. };
  1551. }
  1552. public IEnumerable<Video> FindTrailers(BaseItem owner, List<FileSystemInfo> fileSystemChildren, IDirectoryService directoryService)
  1553. {
  1554. var files = fileSystemChildren.OfType<DirectoryInfo>()
  1555. .Where(i => string.Equals(i.Name, BaseItem.TrailerFolderName, StringComparison.OrdinalIgnoreCase))
  1556. .SelectMany(i => i.EnumerateFiles("*", SearchOption.TopDirectoryOnly))
  1557. .ToList();
  1558. var videoListResolver = new VideoListResolver(GetNamingOptions(), new PatternsLogger());
  1559. var videos = videoListResolver.Resolve(fileSystemChildren.Select(i => new PortableFileInfo
  1560. {
  1561. FullName = i.FullName,
  1562. Type = GetFileType(i)
  1563. }).ToList());
  1564. var currentVideo = videos.FirstOrDefault(i => string.Equals(owner.Path, i.Files.First().Path, StringComparison.OrdinalIgnoreCase));
  1565. if (currentVideo != null)
  1566. {
  1567. files.AddRange(currentVideo.Extras.Where(i => string.Equals(i.ExtraType, "trailer", StringComparison.OrdinalIgnoreCase)).Select(i => new FileInfo(i.Path)));
  1568. }
  1569. return ResolvePaths(files, directoryService, null, null)
  1570. .OfType<Video>()
  1571. .Select(video =>
  1572. {
  1573. // Try to retrieve it from the db. If we don't find it, use the resolved version
  1574. var dbItem = GetItemById(video.Id) as Video;
  1575. if (dbItem != null)
  1576. {
  1577. video = dbItem;
  1578. }
  1579. video.ExtraType = ExtraType.Trailer;
  1580. return video;
  1581. // Sort them so that the list can be easily compared for changes
  1582. }).OrderBy(i => i.Path).ToList();
  1583. }
  1584. private FileInfoType GetFileType(FileSystemInfo info)
  1585. {
  1586. if ((info.Attributes & FileAttributes.Directory) == FileAttributes.Directory)
  1587. {
  1588. return FileInfoType.Directory;
  1589. }
  1590. return FileInfoType.File;
  1591. }
  1592. public IEnumerable<Video> FindExtras(BaseItem owner, List<FileSystemInfo> fileSystemChildren, IDirectoryService directoryService)
  1593. {
  1594. var files = fileSystemChildren.OfType<DirectoryInfo>()
  1595. .Where(i => string.Equals(i.Name, "extras", StringComparison.OrdinalIgnoreCase) || string.Equals(i.Name, "specials", StringComparison.OrdinalIgnoreCase))
  1596. .SelectMany(i => i.EnumerateFiles("*", SearchOption.TopDirectoryOnly))
  1597. .ToList();
  1598. var videoListResolver = new VideoListResolver(GetNamingOptions(), new PatternsLogger());
  1599. var videos = videoListResolver.Resolve(fileSystemChildren.Select(i => new PortableFileInfo
  1600. {
  1601. FullName = i.FullName,
  1602. Type = GetFileType(i)
  1603. }).ToList());
  1604. var currentVideo = videos.FirstOrDefault(i => string.Equals(owner.Path, i.Files.First().Path, StringComparison.OrdinalIgnoreCase));
  1605. if (currentVideo != null)
  1606. {
  1607. files.AddRange(currentVideo.Extras.Where(i => !string.Equals(i.ExtraType, "trailer", StringComparison.OrdinalIgnoreCase)).Select(i => new FileInfo(i.Path)));
  1608. }
  1609. return ResolvePaths(files, directoryService, null, null)
  1610. .OfType<Video>()
  1611. .Select(video =>
  1612. {
  1613. // Try to retrieve it from the db. If we don't find it, use the resolved version
  1614. var dbItem = GetItemById(video.Id) as Video;
  1615. if (dbItem != null)
  1616. {
  1617. video = dbItem;
  1618. }
  1619. SetExtraTypeFromFilename(video);
  1620. return video;
  1621. // Sort them so that the list can be easily compared for changes
  1622. }).OrderBy(i => i.Path).ToList();
  1623. }
  1624. private void SetExtraTypeFromFilename(Video item)
  1625. {
  1626. var resolver = new ExtraResolver(GetNamingOptions(), new PatternsLogger(), new RegexProvider());
  1627. var result = resolver.GetExtraInfo(item.Path);
  1628. if (string.Equals(result.ExtraType, "deletedscene", StringComparison.OrdinalIgnoreCase))
  1629. {
  1630. item.ExtraType = ExtraType.DeletedScene;
  1631. }
  1632. else if (string.Equals(result.ExtraType, "behindthescenes", StringComparison.OrdinalIgnoreCase))
  1633. {
  1634. item.ExtraType = ExtraType.BehindTheScenes;
  1635. }
  1636. else if (string.Equals(result.ExtraType, "interview", StringComparison.OrdinalIgnoreCase))
  1637. {
  1638. item.ExtraType = ExtraType.Interview;
  1639. }
  1640. else if (string.Equals(result.ExtraType, "scene", StringComparison.OrdinalIgnoreCase))
  1641. {
  1642. item.ExtraType = ExtraType.Scene;
  1643. }
  1644. else if (string.Equals(result.ExtraType, "sample", StringComparison.OrdinalIgnoreCase))
  1645. {
  1646. item.ExtraType = ExtraType.Sample;
  1647. }
  1648. else
  1649. {
  1650. item.ExtraType = ExtraType.Clip;
  1651. }
  1652. }
  1653. }
  1654. }