Folder.cs 60 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749
  1. using MediaBrowser.Common.Progress;
  2. using MediaBrowser.Controller.Entities.TV;
  3. using MediaBrowser.Controller.Library;
  4. using MediaBrowser.Controller.Providers;
  5. using MediaBrowser.Model.Dto;
  6. using MediaBrowser.Model.Entities;
  7. using MediaBrowser.Model.Querying;
  8. using System;
  9. using System.Collections;
  10. using System.Collections.Generic;
  11. using System.IO;
  12. using System.Linq;
  13. using System.Runtime.Serialization;
  14. using System.Threading;
  15. using System.Threading.Tasks;
  16. using CommonIO;
  17. using MediaBrowser.Common.IO;
  18. using MediaBrowser.Controller.Entities.Movies;
  19. using MediaBrowser.Controller.Playlists;
  20. using MediaBrowser.Model.Channels;
  21. namespace MediaBrowser.Controller.Entities
  22. {
  23. /// <summary>
  24. /// Class Folder
  25. /// </summary>
  26. public class Folder : BaseItem, IHasThemeMedia, IHasTags
  27. {
  28. public static IUserManager UserManager { get; set; }
  29. public static IUserViewManager UserViewManager { get; set; }
  30. public List<Guid> ThemeSongIds { get; set; }
  31. public List<Guid> ThemeVideoIds { get; set; }
  32. public Folder()
  33. {
  34. LinkedChildren = new List<LinkedChild>();
  35. ThemeSongIds = new List<Guid>();
  36. ThemeVideoIds = new List<Guid>();
  37. }
  38. [IgnoreDataMember]
  39. public virtual bool IsPreSorted
  40. {
  41. get { return false; }
  42. }
  43. /// <summary>
  44. /// Gets a value indicating whether this instance is folder.
  45. /// </summary>
  46. /// <value><c>true</c> if this instance is folder; otherwise, <c>false</c>.</value>
  47. [IgnoreDataMember]
  48. public override bool IsFolder
  49. {
  50. get
  51. {
  52. return true;
  53. }
  54. }
  55. [IgnoreDataMember]
  56. public override string FileNameWithoutExtension
  57. {
  58. get
  59. {
  60. if (LocationType == LocationType.FileSystem)
  61. {
  62. return System.IO.Path.GetFileName(Path);
  63. }
  64. return null;
  65. }
  66. }
  67. protected override bool IsAllowTagFilterEnforced()
  68. {
  69. if (this is ICollectionFolder)
  70. {
  71. return false;
  72. }
  73. if (this is UserView)
  74. {
  75. return false;
  76. }
  77. return true;
  78. }
  79. /// <summary>
  80. /// Gets or sets a value indicating whether this instance is physical root.
  81. /// </summary>
  82. /// <value><c>true</c> if this instance is physical root; otherwise, <c>false</c>.</value>
  83. public bool IsPhysicalRoot { get; set; }
  84. /// <summary>
  85. /// Gets or sets a value indicating whether this instance is root.
  86. /// </summary>
  87. /// <value><c>true</c> if this instance is root; otherwise, <c>false</c>.</value>
  88. public bool IsRoot { get; set; }
  89. /// <summary>
  90. /// Gets a value indicating whether this instance is virtual folder.
  91. /// </summary>
  92. /// <value><c>true</c> if this instance is virtual folder; otherwise, <c>false</c>.</value>
  93. [IgnoreDataMember]
  94. public virtual bool IsVirtualFolder
  95. {
  96. get
  97. {
  98. return false;
  99. }
  100. }
  101. public virtual List<LinkedChild> LinkedChildren { get; set; }
  102. [IgnoreDataMember]
  103. protected virtual bool SupportsShortcutChildren
  104. {
  105. get { return ConfigurationManager.Configuration.EnableWindowsShortcuts; }
  106. }
  107. /// <summary>
  108. /// Adds the child.
  109. /// </summary>
  110. /// <param name="item">The item.</param>
  111. /// <param name="cancellationToken">The cancellation token.</param>
  112. /// <returns>Task.</returns>
  113. /// <exception cref="System.InvalidOperationException">Unable to add + item.Name</exception>
  114. public async Task AddChild(BaseItem item, CancellationToken cancellationToken)
  115. {
  116. item.SetParent(this);
  117. if (item.Id == Guid.Empty)
  118. {
  119. item.Id = LibraryManager.GetNewItemId(item.Path, item.GetType());
  120. }
  121. if (ActualChildren.Any(i => i.Id == item.Id))
  122. {
  123. throw new ArgumentException(string.Format("A child with the Id {0} already exists.", item.Id));
  124. }
  125. if (item.DateCreated == DateTime.MinValue)
  126. {
  127. item.DateCreated = DateTime.UtcNow;
  128. }
  129. if (item.DateModified == DateTime.MinValue)
  130. {
  131. item.DateModified = DateTime.UtcNow;
  132. }
  133. AddChildInternal(item);
  134. await LibraryManager.CreateItem(item, cancellationToken).ConfigureAwait(false);
  135. if (!EnableNewFolderQuerying())
  136. {
  137. await ItemRepository.SaveChildren(Id, ActualChildren.Select(i => i.Id).ToList(), cancellationToken).ConfigureAwait(false);
  138. }
  139. }
  140. private static bool EnableNewFolderQuerying()
  141. {
  142. return ConfigurationManager.Configuration.MigrationVersion >= 1;
  143. }
  144. protected void AddChildrenInternal(IEnumerable<BaseItem> children)
  145. {
  146. var actualChildren = ActualChildren;
  147. lock (_childrenSyncLock)
  148. {
  149. var newChildren = actualChildren.ToList();
  150. newChildren.AddRange(children);
  151. _children = newChildren;
  152. }
  153. }
  154. protected void AddChildInternal(BaseItem child)
  155. {
  156. var actualChildren = ActualChildren;
  157. lock (_childrenSyncLock)
  158. {
  159. var newChildren = actualChildren.ToList();
  160. newChildren.Add(child);
  161. _children = newChildren;
  162. }
  163. }
  164. protected void RemoveChildrenInternal(IEnumerable<BaseItem> children)
  165. {
  166. var ids = children.Select(i => i.Id).ToList();
  167. var actualChildren = ActualChildren;
  168. lock (_childrenSyncLock)
  169. {
  170. _children = actualChildren.Where(i => !ids.Contains(i.Id)).ToList();
  171. }
  172. }
  173. protected void ClearChildrenInternal()
  174. {
  175. lock (_childrenSyncLock)
  176. {
  177. _children = new List<BaseItem>();
  178. }
  179. }
  180. /// <summary>
  181. /// Removes the child.
  182. /// </summary>
  183. /// <param name="item">The item.</param>
  184. /// <param name="cancellationToken">The cancellation token.</param>
  185. /// <returns>Task.</returns>
  186. /// <exception cref="System.InvalidOperationException">Unable to remove + item.Name</exception>
  187. public Task RemoveChild(BaseItem item, CancellationToken cancellationToken)
  188. {
  189. RemoveChildrenInternal(new[] { item });
  190. item.SetParent(null);
  191. if (!EnableNewFolderQuerying())
  192. {
  193. return ItemRepository.SaveChildren(Id, ActualChildren.Select(i => i.Id).ToList(), cancellationToken);
  194. }
  195. return Task.FromResult(true);
  196. }
  197. /// <summary>
  198. /// Clears the children.
  199. /// </summary>
  200. /// <param name="cancellationToken">The cancellation token.</param>
  201. /// <returns>Task.</returns>
  202. public Task ClearChildren(CancellationToken cancellationToken)
  203. {
  204. var items = ActualChildren.ToList();
  205. ClearChildrenInternal();
  206. foreach (var item in items)
  207. {
  208. LibraryManager.ReportItemRemoved(item);
  209. }
  210. return ItemRepository.SaveChildren(Id, ActualChildren.Select(i => i.Id).ToList(), cancellationToken);
  211. }
  212. #region Indexing
  213. /// <summary>
  214. /// Returns the valid set of index by options for this folder type.
  215. /// Override or extend to modify.
  216. /// </summary>
  217. /// <returns>Dictionary{System.StringFunc{UserIEnumerable{BaseItem}}}.</returns>
  218. protected virtual IEnumerable<string> GetIndexByOptions()
  219. {
  220. return new List<string> {
  221. {"None"},
  222. {"Performer"},
  223. {"Genre"},
  224. {"Director"},
  225. {"Year"},
  226. {"Studio"}
  227. };
  228. }
  229. /// <summary>
  230. /// Get the list of indexy by choices for this folder (localized).
  231. /// </summary>
  232. /// <value>The index by option strings.</value>
  233. [IgnoreDataMember]
  234. public IEnumerable<string> IndexByOptionStrings
  235. {
  236. get { return GetIndexByOptions(); }
  237. }
  238. #endregion
  239. /// <summary>
  240. /// The children
  241. /// </summary>
  242. private IReadOnlyList<BaseItem> _children;
  243. /// <summary>
  244. /// The _children sync lock
  245. /// </summary>
  246. private readonly object _childrenSyncLock = new object();
  247. /// <summary>
  248. /// Gets or sets the actual children.
  249. /// </summary>
  250. /// <value>The actual children.</value>
  251. protected virtual IEnumerable<BaseItem> ActualChildren
  252. {
  253. get
  254. {
  255. if (_children == null)
  256. {
  257. lock (_childrenSyncLock)
  258. {
  259. if (_children == null)
  260. {
  261. _children = LoadChildren().ToList();
  262. }
  263. }
  264. }
  265. return _children;
  266. }
  267. }
  268. /// <summary>
  269. /// thread-safe access to the actual children of this folder - without regard to user
  270. /// </summary>
  271. /// <value>The children.</value>
  272. [IgnoreDataMember]
  273. public IEnumerable<BaseItem> Children
  274. {
  275. get { return ActualChildren.ToList(); }
  276. }
  277. /// <summary>
  278. /// thread-safe access to all recursive children of this folder - without regard to user
  279. /// </summary>
  280. /// <value>The recursive children.</value>
  281. [IgnoreDataMember]
  282. public IEnumerable<BaseItem> RecursiveChildren
  283. {
  284. get { return GetRecursiveChildren(); }
  285. }
  286. public override bool IsVisible(User user)
  287. {
  288. if (this is ICollectionFolder && !(this is BasePluginFolder))
  289. {
  290. if (user.Policy.BlockedMediaFolders != null)
  291. {
  292. if (user.Policy.BlockedMediaFolders.Contains(Id.ToString("N"), StringComparer.OrdinalIgnoreCase) ||
  293. // Backwards compatibility
  294. user.Policy.BlockedMediaFolders.Contains(Name, StringComparer.OrdinalIgnoreCase))
  295. {
  296. return false;
  297. }
  298. }
  299. else
  300. {
  301. if (!user.Policy.EnableAllFolders && !user.Policy.EnabledFolders.Contains(Id.ToString("N"), StringComparer.OrdinalIgnoreCase))
  302. {
  303. return false;
  304. }
  305. }
  306. }
  307. return base.IsVisible(user);
  308. }
  309. /// <summary>
  310. /// Loads our children. Validation will occur externally.
  311. /// We want this sychronous.
  312. /// </summary>
  313. protected virtual IEnumerable<BaseItem> LoadChildren()
  314. {
  315. //just load our children from the repo - the library will be validated and maintained in other processes
  316. return GetCachedChildren();
  317. }
  318. public Task ValidateChildren(IProgress<double> progress, CancellationToken cancellationToken)
  319. {
  320. return ValidateChildren(progress, cancellationToken, new MetadataRefreshOptions(new DirectoryService(FileSystem)));
  321. }
  322. /// <summary>
  323. /// Validates that the children of the folder still exist
  324. /// </summary>
  325. /// <param name="progress">The progress.</param>
  326. /// <param name="cancellationToken">The cancellation token.</param>
  327. /// <param name="metadataRefreshOptions">The metadata refresh options.</param>
  328. /// <param name="recursive">if set to <c>true</c> [recursive].</param>
  329. /// <returns>Task.</returns>
  330. public Task ValidateChildren(IProgress<double> progress, CancellationToken cancellationToken, MetadataRefreshOptions metadataRefreshOptions, bool recursive = true)
  331. {
  332. return ValidateChildrenInternal(progress, cancellationToken, recursive, true, metadataRefreshOptions, metadataRefreshOptions.DirectoryService);
  333. }
  334. private Dictionary<Guid, BaseItem> GetActualChildrenDictionary()
  335. {
  336. var dictionary = new Dictionary<Guid, BaseItem>();
  337. foreach (var child in ActualChildren)
  338. {
  339. var id = child.Id;
  340. if (dictionary.ContainsKey(id))
  341. {
  342. Logger.Error("Found folder containing items with duplicate id. Path: {0}, Child Name: {1}",
  343. Path ?? Name,
  344. child.Path ?? child.Name);
  345. }
  346. else
  347. {
  348. dictionary[id] = child;
  349. }
  350. }
  351. return dictionary;
  352. }
  353. private bool IsValidFromResolver(BaseItem current, BaseItem newItem)
  354. {
  355. return current.IsValidFromResolver(newItem);
  356. }
  357. /// <summary>
  358. /// Validates the children internal.
  359. /// </summary>
  360. /// <param name="progress">The progress.</param>
  361. /// <param name="cancellationToken">The cancellation token.</param>
  362. /// <param name="recursive">if set to <c>true</c> [recursive].</param>
  363. /// <param name="refreshChildMetadata">if set to <c>true</c> [refresh child metadata].</param>
  364. /// <param name="refreshOptions">The refresh options.</param>
  365. /// <param name="directoryService">The directory service.</param>
  366. /// <returns>Task.</returns>
  367. protected async virtual Task ValidateChildrenInternal(IProgress<double> progress, CancellationToken cancellationToken, bool recursive, bool refreshChildMetadata, MetadataRefreshOptions refreshOptions, IDirectoryService directoryService)
  368. {
  369. var locationType = LocationType;
  370. cancellationToken.ThrowIfCancellationRequested();
  371. var validChildren = new List<BaseItem>();
  372. if (locationType != LocationType.Remote && locationType != LocationType.Virtual)
  373. {
  374. IEnumerable<BaseItem> nonCachedChildren;
  375. try
  376. {
  377. nonCachedChildren = GetNonCachedChildren(directoryService);
  378. }
  379. catch (IOException ex)
  380. {
  381. nonCachedChildren = new BaseItem[] { };
  382. Logger.ErrorException("Error getting file system entries for {0}", ex, Path);
  383. }
  384. if (nonCachedChildren == null) return; //nothing to validate
  385. progress.Report(5);
  386. //build a dictionary of the current children we have now by Id so we can compare quickly and easily
  387. var currentChildren = GetActualChildrenDictionary();
  388. //create a list for our validated children
  389. var newItems = new List<BaseItem>();
  390. cancellationToken.ThrowIfCancellationRequested();
  391. foreach (var child in nonCachedChildren)
  392. {
  393. BaseItem currentChild;
  394. if (currentChildren.TryGetValue(child.Id, out currentChild) && IsValidFromResolver(currentChild, child))
  395. {
  396. var currentChildLocationType = currentChild.LocationType;
  397. if (currentChildLocationType != LocationType.Remote &&
  398. currentChildLocationType != LocationType.Virtual)
  399. {
  400. currentChild.DateModified = child.DateModified;
  401. }
  402. await UpdateIsOffline(currentChild, false).ConfigureAwait(false);
  403. validChildren.Add(currentChild);
  404. continue;
  405. }
  406. // Brand new item - needs to be added
  407. child.SetParent(this);
  408. newItems.Add(child);
  409. validChildren.Add(child);
  410. }
  411. // If any items were added or removed....
  412. if (newItems.Count > 0 || currentChildren.Count != validChildren.Count)
  413. {
  414. // That's all the new and changed ones - now see if there are any that are missing
  415. var itemsRemoved = currentChildren.Values.Except(validChildren).ToList();
  416. var actualRemovals = new List<BaseItem>();
  417. foreach (var item in itemsRemoved)
  418. {
  419. if (item.LocationType == LocationType.Virtual ||
  420. item.LocationType == LocationType.Remote)
  421. {
  422. // Don't remove these because there's no way to accurately validate them.
  423. validChildren.Add(item);
  424. }
  425. else if (!string.IsNullOrEmpty(item.Path) && IsPathOffline(item.Path))
  426. {
  427. await UpdateIsOffline(item, true).ConfigureAwait(false);
  428. validChildren.Add(item);
  429. }
  430. else
  431. {
  432. actualRemovals.Add(item);
  433. }
  434. }
  435. if (actualRemovals.Count > 0)
  436. {
  437. RemoveChildrenInternal(actualRemovals);
  438. foreach (var item in actualRemovals)
  439. {
  440. Logger.Debug("Removed item: " + item.Path);
  441. item.SetParent(null);
  442. item.IsOffline = false;
  443. await LibraryManager.DeleteItem(item, new DeleteOptions { DeleteFileLocation = false }).ConfigureAwait(false);
  444. LibraryManager.ReportItemRemoved(item);
  445. }
  446. }
  447. await LibraryManager.CreateItems(newItems, cancellationToken).ConfigureAwait(false);
  448. AddChildrenInternal(newItems);
  449. if (!EnableNewFolderQuerying())
  450. {
  451. await ItemRepository.SaveChildren(Id, ActualChildren.Select(i => i.Id).ToList(), cancellationToken).ConfigureAwait(false);
  452. }
  453. }
  454. }
  455. progress.Report(10);
  456. cancellationToken.ThrowIfCancellationRequested();
  457. if (recursive)
  458. {
  459. await ValidateSubFolders(ActualChildren.OfType<Folder>().ToList(), directoryService, progress, cancellationToken).ConfigureAwait(false);
  460. }
  461. progress.Report(20);
  462. if (refreshChildMetadata)
  463. {
  464. var container = this as IMetadataContainer;
  465. var innerProgress = new ActionableProgress<double>();
  466. innerProgress.RegisterAction(p => progress.Report((.80 * p) + 20));
  467. if (container != null)
  468. {
  469. await container.RefreshAllMetadata(refreshOptions, innerProgress, cancellationToken).ConfigureAwait(false);
  470. }
  471. else
  472. {
  473. await RefreshMetadataRecursive(refreshOptions, recursive, innerProgress, cancellationToken);
  474. }
  475. }
  476. progress.Report(100);
  477. }
  478. private Task UpdateIsOffline(BaseItem item, bool newValue)
  479. {
  480. if (item.IsOffline != newValue)
  481. {
  482. item.IsOffline = newValue;
  483. return item.UpdateToRepository(ItemUpdateType.None, CancellationToken.None);
  484. }
  485. return Task.FromResult(true);
  486. }
  487. private async Task RefreshMetadataRecursive(MetadataRefreshOptions refreshOptions, bool recursive, IProgress<double> progress, CancellationToken cancellationToken)
  488. {
  489. var children = ActualChildren.ToList();
  490. var percentages = new Dictionary<Guid, double>(children.Count);
  491. var numComplete = 0;
  492. var count = children.Count;
  493. foreach (var child in children)
  494. {
  495. cancellationToken.ThrowIfCancellationRequested();
  496. if (child.IsFolder)
  497. {
  498. var innerProgress = new ActionableProgress<double>();
  499. // Avoid implicitly captured closure
  500. var currentChild = child;
  501. innerProgress.RegisterAction(p =>
  502. {
  503. lock (percentages)
  504. {
  505. percentages[currentChild.Id] = p / 100;
  506. var innerPercent = percentages.Values.Sum();
  507. innerPercent /= count;
  508. innerPercent *= 100;
  509. progress.Report(innerPercent);
  510. }
  511. });
  512. await RefreshChildMetadata(child, refreshOptions, recursive, innerProgress, cancellationToken)
  513. .ConfigureAwait(false);
  514. }
  515. else
  516. {
  517. await RefreshChildMetadata(child, refreshOptions, false, new Progress<double>(), cancellationToken)
  518. .ConfigureAwait(false);
  519. }
  520. numComplete++;
  521. double percent = numComplete;
  522. percent /= count;
  523. percent *= 100;
  524. progress.Report(percent);
  525. }
  526. progress.Report(100);
  527. }
  528. private async Task RefreshChildMetadata(BaseItem child, MetadataRefreshOptions refreshOptions, bool recursive, IProgress<double> progress, CancellationToken cancellationToken)
  529. {
  530. var container = child as IMetadataContainer;
  531. if (container != null)
  532. {
  533. await container.RefreshAllMetadata(refreshOptions, progress, cancellationToken).ConfigureAwait(false);
  534. }
  535. else
  536. {
  537. await child.RefreshMetadata(refreshOptions, cancellationToken).ConfigureAwait(false);
  538. if (recursive)
  539. {
  540. var folder = child as Folder;
  541. if (folder != null)
  542. {
  543. await folder.RefreshMetadataRecursive(refreshOptions, true, progress, cancellationToken);
  544. }
  545. }
  546. }
  547. progress.Report(100);
  548. }
  549. /// <summary>
  550. /// Refreshes the children.
  551. /// </summary>
  552. /// <param name="children">The children.</param>
  553. /// <param name="directoryService">The directory service.</param>
  554. /// <param name="progress">The progress.</param>
  555. /// <param name="cancellationToken">The cancellation token.</param>
  556. /// <returns>Task.</returns>
  557. private async Task ValidateSubFolders(IList<Folder> children, IDirectoryService directoryService, IProgress<double> progress, CancellationToken cancellationToken)
  558. {
  559. var list = children;
  560. var childCount = list.Count;
  561. var percentages = new Dictionary<Guid, double>(list.Count);
  562. foreach (var item in list)
  563. {
  564. cancellationToken.ThrowIfCancellationRequested();
  565. var child = item;
  566. var innerProgress = new ActionableProgress<double>();
  567. innerProgress.RegisterAction(p =>
  568. {
  569. lock (percentages)
  570. {
  571. percentages[child.Id] = p / 100;
  572. var percent = percentages.Values.Sum();
  573. percent /= childCount;
  574. progress.Report((10 * percent) + 10);
  575. }
  576. });
  577. await child.ValidateChildrenInternal(innerProgress, cancellationToken, true, false, null, directoryService)
  578. .ConfigureAwait(false);
  579. }
  580. }
  581. /// <summary>
  582. /// Determines whether the specified path is offline.
  583. /// </summary>
  584. /// <param name="path">The path.</param>
  585. /// <returns><c>true</c> if the specified path is offline; otherwise, <c>false</c>.</returns>
  586. public static bool IsPathOffline(string path)
  587. {
  588. if (FileSystem.FileExists(path))
  589. {
  590. return false;
  591. }
  592. var originalPath = path;
  593. // Depending on whether the path is local or unc, it may return either null or '\' at the top
  594. while (!string.IsNullOrEmpty(path) && path.Length > 1)
  595. {
  596. if (FileSystem.DirectoryExists(path))
  597. {
  598. return false;
  599. }
  600. path = System.IO.Path.GetDirectoryName(path);
  601. }
  602. if (ContainsPath(LibraryManager.GetVirtualFolders(), originalPath))
  603. {
  604. return true;
  605. }
  606. return false;
  607. }
  608. /// <summary>
  609. /// Determines whether the specified folders contains path.
  610. /// </summary>
  611. /// <param name="folders">The folders.</param>
  612. /// <param name="path">The path.</param>
  613. /// <returns><c>true</c> if the specified folders contains path; otherwise, <c>false</c>.</returns>
  614. private static bool ContainsPath(IEnumerable<VirtualFolderInfo> folders, string path)
  615. {
  616. return folders.SelectMany(i => i.Locations).Any(i => ContainsPath(i, path));
  617. }
  618. private static bool ContainsPath(string parent, string path)
  619. {
  620. return string.Equals(parent, path, StringComparison.OrdinalIgnoreCase) || FileSystem.ContainsSubPath(parent, path);
  621. }
  622. /// <summary>
  623. /// Get the children of this folder from the actual file system
  624. /// </summary>
  625. /// <returns>IEnumerable{BaseItem}.</returns>
  626. protected virtual IEnumerable<BaseItem> GetNonCachedChildren(IDirectoryService directoryService)
  627. {
  628. var collectionType = LibraryManager.GetContentType(this);
  629. return LibraryManager.ResolvePaths(GetFileSystemChildren(directoryService), directoryService, this, collectionType);
  630. }
  631. /// <summary>
  632. /// Get our children from the repo - stubbed for now
  633. /// </summary>
  634. /// <returns>IEnumerable{BaseItem}.</returns>
  635. protected IEnumerable<BaseItem> GetCachedChildren()
  636. {
  637. if (EnableNewFolderQuerying())
  638. {
  639. return ItemRepository.GetItemList(new InternalItemsQuery
  640. {
  641. ParentId = Id
  642. }).Select(RetrieveChild).Where(i => i != null);
  643. }
  644. return ItemRepository.GetChildrenItems(Id).Select(RetrieveChild).Where(i => i != null);
  645. }
  646. private BaseItem RetrieveChild(BaseItem child)
  647. {
  648. if (child == null || child.Id == Guid.Empty)
  649. {
  650. Logger.Error("Item found with empty Id: " + (child.Path ?? child.Name));
  651. return null;
  652. }
  653. var item = LibraryManager.GetMemoryItemById(child.Id);
  654. if (item != null)
  655. {
  656. if (item is IByReferenceItem)
  657. {
  658. return LibraryManager.GetOrAddByReferenceItem(item);
  659. }
  660. item.SetParent(this);
  661. }
  662. else
  663. {
  664. child.SetParent(this);
  665. LibraryManager.RegisterItem(child);
  666. item = child;
  667. }
  668. return item;
  669. }
  670. public QueryResult<BaseItem> QueryRecursive(InternalItemsQuery query)
  671. {
  672. var user = query.User;
  673. if (RequiresPostFiltering(query))
  674. {
  675. IEnumerable<BaseItem> items;
  676. Func<BaseItem, bool> filter = i => UserViewBuilder.Filter(i, user, query, UserDataManager, LibraryManager);
  677. if (query.User == null)
  678. {
  679. items = GetRecursiveChildren(filter);
  680. }
  681. else
  682. {
  683. items = GetRecursiveChildren(user, filter);
  684. }
  685. return PostFilterAndSort(items, query);
  686. }
  687. if (!(this is UserRootFolder) && !(this is AggregateFolder))
  688. {
  689. query.ParentId = query.ParentId ?? Id;
  690. }
  691. return LibraryManager.GetItemsResult(query);
  692. }
  693. private bool RequiresPostFiltering(InternalItemsQuery query)
  694. {
  695. if (LinkedChildren.Count > 0)
  696. {
  697. if (!(this is ICollectionFolder))
  698. {
  699. Logger.Debug("Query requires post-filtering due to LinkedChildren");
  700. return true;
  701. }
  702. }
  703. if (query.SortBy != null && query.SortBy.Length > 0)
  704. {
  705. if (query.SortBy.Contains(ItemSortBy.DatePlayed, StringComparer.OrdinalIgnoreCase))
  706. {
  707. Logger.Debug("Query requires post-filtering due to ItemSortBy.DatePlayed");
  708. return true;
  709. }
  710. if (query.SortBy.Contains(ItemSortBy.IsFavoriteOrLiked, StringComparer.OrdinalIgnoreCase))
  711. {
  712. Logger.Debug("Query requires post-filtering due to ItemSortBy.IsFavoriteOrLiked");
  713. return true;
  714. }
  715. if (query.SortBy.Contains(ItemSortBy.IsPlayed, StringComparer.OrdinalIgnoreCase))
  716. {
  717. Logger.Debug("Query requires post-filtering due to ItemSortBy.IsPlayed");
  718. return true;
  719. }
  720. if (query.SortBy.Contains(ItemSortBy.IsUnplayed, StringComparer.OrdinalIgnoreCase))
  721. {
  722. Logger.Debug("Query requires post-filtering due to ItemSortBy.IsUnplayed");
  723. return true;
  724. }
  725. if (query.SortBy.Contains(ItemSortBy.AiredEpisodeOrder, StringComparer.OrdinalIgnoreCase))
  726. {
  727. Logger.Debug("Query requires post-filtering due to ItemSortBy.AiredEpisodeOrder");
  728. return true;
  729. }
  730. if (query.SortBy.Contains(ItemSortBy.Album, StringComparer.OrdinalIgnoreCase))
  731. {
  732. Logger.Debug("Query requires post-filtering due to ItemSortBy.Album");
  733. return true;
  734. }
  735. if (query.SortBy.Contains(ItemSortBy.AlbumArtist, StringComparer.OrdinalIgnoreCase))
  736. {
  737. Logger.Debug("Query requires post-filtering due to ItemSortBy.AlbumArtist");
  738. return true;
  739. }
  740. if (query.SortBy.Contains(ItemSortBy.Artist, StringComparer.OrdinalIgnoreCase))
  741. {
  742. Logger.Debug("Query requires post-filtering due to ItemSortBy.Artist");
  743. return true;
  744. }
  745. if (query.SortBy.Contains(ItemSortBy.Budget, StringComparer.OrdinalIgnoreCase))
  746. {
  747. Logger.Debug("Query requires post-filtering due to ItemSortBy.Budget");
  748. return true;
  749. }
  750. if (query.SortBy.Contains(ItemSortBy.CriticRating, StringComparer.OrdinalIgnoreCase))
  751. {
  752. Logger.Debug("Query requires post-filtering due to ItemSortBy.CriticRating");
  753. return true;
  754. }
  755. if (query.SortBy.Contains(ItemSortBy.DateLastContentAdded, StringComparer.OrdinalIgnoreCase))
  756. {
  757. Logger.Debug("Query requires post-filtering due to ItemSortBy.DateLastContentAdded");
  758. return true;
  759. }
  760. if (query.SortBy.Contains(ItemSortBy.GameSystem, StringComparer.OrdinalIgnoreCase))
  761. {
  762. Logger.Debug("Query requires post-filtering due to ItemSortBy.GameSystem");
  763. return true;
  764. }
  765. if (query.SortBy.Contains(ItemSortBy.Metascore, StringComparer.OrdinalIgnoreCase))
  766. {
  767. Logger.Debug("Query requires post-filtering due to ItemSortBy.Metascore");
  768. return true;
  769. }
  770. if (query.SortBy.Contains(ItemSortBy.OfficialRating, StringComparer.OrdinalIgnoreCase))
  771. {
  772. Logger.Debug("Query requires post-filtering due to ItemSortBy.OfficialRating");
  773. return true;
  774. }
  775. if (query.SortBy.Contains(ItemSortBy.PlayCount, StringComparer.OrdinalIgnoreCase))
  776. {
  777. Logger.Debug("Query requires post-filtering due to ItemSortBy.PlayCount");
  778. return true;
  779. }
  780. if (query.SortBy.Contains(ItemSortBy.Players, StringComparer.OrdinalIgnoreCase))
  781. {
  782. Logger.Debug("Query requires post-filtering due to ItemSortBy.Players");
  783. return true;
  784. }
  785. if (query.SortBy.Contains(ItemSortBy.Revenue, StringComparer.OrdinalIgnoreCase))
  786. {
  787. Logger.Debug("Query requires post-filtering due to ItemSortBy.Revenue");
  788. return true;
  789. }
  790. if (query.SortBy.Contains(ItemSortBy.SeriesSortName, StringComparer.OrdinalIgnoreCase))
  791. {
  792. Logger.Debug("Query requires post-filtering due to ItemSortBy.SeriesSortName");
  793. return true;
  794. }
  795. if (query.SortBy.Contains(ItemSortBy.StartDate, StringComparer.OrdinalIgnoreCase))
  796. {
  797. Logger.Debug("Query requires post-filtering due to ItemSortBy.StartDate");
  798. return true;
  799. }
  800. if (query.SortBy.Contains(ItemSortBy.Studio, StringComparer.OrdinalIgnoreCase))
  801. {
  802. Logger.Debug("Query requires post-filtering due to ItemSortBy.Studio");
  803. return true;
  804. }
  805. if (query.SortBy.Contains(ItemSortBy.VideoBitRate, StringComparer.OrdinalIgnoreCase))
  806. {
  807. Logger.Debug("Query requires post-filtering due to ItemSortBy.VideoBitRate");
  808. return true;
  809. }
  810. }
  811. if (query.PersonIds.Length > 0)
  812. {
  813. Logger.Debug("Query requires post-filtering due to PersonIds");
  814. return true;
  815. }
  816. if (query.IsLiked.HasValue)
  817. {
  818. Logger.Debug("Query requires post-filtering due to IsLiked");
  819. return true;
  820. }
  821. if (query.IsFavoriteOrLiked.HasValue)
  822. {
  823. Logger.Debug("Query requires post-filtering due to IsFavoriteOrLiked");
  824. return true;
  825. }
  826. if (query.IsFavorite.HasValue)
  827. {
  828. Logger.Debug("Query requires post-filtering due to IsFavorite");
  829. return true;
  830. }
  831. if (query.IsResumable.HasValue)
  832. {
  833. Logger.Debug("Query requires post-filtering due to IsResumable");
  834. return true;
  835. }
  836. if (query.IsPlayed.HasValue)
  837. {
  838. Logger.Debug("Query requires post-filtering due to IsPlayed");
  839. return true;
  840. }
  841. if (query.IsInBoxSet.HasValue)
  842. {
  843. Logger.Debug("Query requires post-filtering due to IsInBoxSet");
  844. return true;
  845. }
  846. // Filter by Video3DFormat
  847. if (query.Is3D.HasValue)
  848. {
  849. Logger.Debug("Query requires post-filtering due to Is3D");
  850. return true;
  851. }
  852. if (query.HasOverview.HasValue)
  853. {
  854. Logger.Debug("Query requires post-filtering due to HasOverview");
  855. return true;
  856. }
  857. if (query.HasImdbId.HasValue)
  858. {
  859. Logger.Debug("Query requires post-filtering due to HasImdbId");
  860. return true;
  861. }
  862. if (query.HasTmdbId.HasValue)
  863. {
  864. Logger.Debug("Query requires post-filtering due to HasTmdbId");
  865. return true;
  866. }
  867. if (query.HasTvdbId.HasValue)
  868. {
  869. Logger.Debug("Query requires post-filtering due to HasTvdbId");
  870. return true;
  871. }
  872. if (query.IsYearMismatched.HasValue)
  873. {
  874. Logger.Debug("Query requires post-filtering due to IsYearMismatched");
  875. return true;
  876. }
  877. if (query.HasOfficialRating.HasValue)
  878. {
  879. Logger.Debug("Query requires post-filtering due to HasOfficialRating");
  880. return true;
  881. }
  882. if (query.IsPlaceHolder.HasValue)
  883. {
  884. Logger.Debug("Query requires post-filtering due to IsPlaceHolder");
  885. return true;
  886. }
  887. if (query.HasSpecialFeature.HasValue)
  888. {
  889. Logger.Debug("Query requires post-filtering due to HasSpecialFeature");
  890. return true;
  891. }
  892. if (query.HasSubtitles.HasValue)
  893. {
  894. Logger.Debug("Query requires post-filtering due to HasSubtitles");
  895. return true;
  896. }
  897. if (query.HasTrailer.HasValue)
  898. {
  899. Logger.Debug("Query requires post-filtering due to HasTrailer");
  900. return true;
  901. }
  902. if (query.HasThemeSong.HasValue)
  903. {
  904. Logger.Debug("Query requires post-filtering due to HasThemeSong");
  905. return true;
  906. }
  907. if (query.HasThemeVideo.HasValue)
  908. {
  909. Logger.Debug("Query requires post-filtering due to HasThemeVideo");
  910. return true;
  911. }
  912. // Filter by VideoType
  913. if (query.VideoTypes.Length > 0)
  914. {
  915. Logger.Debug("Query requires post-filtering due to VideoTypes");
  916. return true;
  917. }
  918. if (query.ImageTypes.Length > 0)
  919. {
  920. Logger.Debug("Query requires post-filtering due to ImageTypes");
  921. return true;
  922. }
  923. // Apply studio filter
  924. if (query.StudioIds.Length > 0)
  925. {
  926. Logger.Debug("Query requires post-filtering due to StudioIds");
  927. return true;
  928. }
  929. // Apply genre filter
  930. if (query.GenreIds.Length > 0)
  931. {
  932. Logger.Debug("Query requires post-filtering due to GenreIds");
  933. return true;
  934. }
  935. // Apply year filter
  936. if (query.Years.Length > 0)
  937. {
  938. Logger.Debug("Query requires post-filtering due to Years");
  939. return true;
  940. }
  941. // Apply official rating filter
  942. if (query.OfficialRatings.Length > 0)
  943. {
  944. Logger.Debug("Query requires post-filtering due to OfficialRatings");
  945. return true;
  946. }
  947. // Apply person filter
  948. if (query.ItemIdsFromPersonFilters != null)
  949. {
  950. Logger.Debug("Query requires post-filtering due to ItemIdsFromPersonFilters");
  951. return true;
  952. }
  953. if (query.MinPlayers.HasValue)
  954. {
  955. Logger.Debug("Query requires post-filtering due to MinPlayers");
  956. return true;
  957. }
  958. if (query.MaxPlayers.HasValue)
  959. {
  960. Logger.Debug("Query requires post-filtering due to MaxPlayers");
  961. return true;
  962. }
  963. if (query.MinCommunityRating.HasValue)
  964. {
  965. Logger.Debug("Query requires post-filtering due to MinCommunityRating");
  966. return true;
  967. }
  968. if (query.MinIndexNumber.HasValue)
  969. {
  970. Logger.Debug("Query requires post-filtering due to MinIndexNumber");
  971. return true;
  972. }
  973. if (query.Years.Length > 0)
  974. {
  975. Logger.Debug("Query requires post-filtering due to Years");
  976. return true;
  977. }
  978. if (query.OfficialRatings.Length > 0)
  979. {
  980. Logger.Debug("Query requires post-filtering due to OfficialRatings");
  981. return true;
  982. }
  983. if (query.IsMissing.HasValue)
  984. {
  985. Logger.Debug("Query requires post-filtering due to IsMissing");
  986. return true;
  987. }
  988. if (query.IsUnaired.HasValue)
  989. {
  990. Logger.Debug("Query requires post-filtering due to IsUnaired");
  991. return true;
  992. }
  993. if (query.IsVirtualUnaired.HasValue)
  994. {
  995. Logger.Debug("Query requires post-filtering due to IsVirtualUnaired");
  996. return true;
  997. }
  998. if (UserViewBuilder.CollapseBoxSetItems(query, this, query.User))
  999. {
  1000. Logger.Debug("Query requires post-filtering due to CollapseBoxSetItems");
  1001. return true;
  1002. }
  1003. if (!string.IsNullOrWhiteSpace(query.AdjacentTo))
  1004. {
  1005. Logger.Debug("Query requires post-filtering due to AdjacentTo");
  1006. return true;
  1007. }
  1008. if (!string.IsNullOrWhiteSpace(query.NameContains))
  1009. {
  1010. Logger.Debug("Query requires post-filtering due to NameContains");
  1011. return true;
  1012. }
  1013. if (!string.IsNullOrWhiteSpace(query.NameLessThan))
  1014. {
  1015. Logger.Debug("Query requires post-filtering due to NameLessThan");
  1016. return true;
  1017. }
  1018. if (!string.IsNullOrWhiteSpace(query.NameStartsWith))
  1019. {
  1020. Logger.Debug("Query requires post-filtering due to NameStartsWith");
  1021. return true;
  1022. }
  1023. if (!string.IsNullOrWhiteSpace(query.NameStartsWithOrGreater))
  1024. {
  1025. Logger.Debug("Query requires post-filtering due to NameStartsWithOrGreater");
  1026. return true;
  1027. }
  1028. return false;
  1029. }
  1030. public virtual async Task<QueryResult<BaseItem>> GetItems(InternalItemsQuery query)
  1031. {
  1032. if (SourceType == SourceType.Channel)
  1033. {
  1034. try
  1035. {
  1036. // Don't blow up here because it could cause parent screens with other content to fail
  1037. return await ChannelManager.GetChannelItemsInternal(new ChannelItemQuery
  1038. {
  1039. ChannelId = ChannelId,
  1040. FolderId = Id.ToString("N"),
  1041. Limit = query.Limit,
  1042. StartIndex = query.StartIndex,
  1043. UserId = query.User.Id.ToString("N"),
  1044. SortBy = query.SortBy,
  1045. SortOrder = query.SortOrder
  1046. }, new Progress<double>(), CancellationToken.None);
  1047. }
  1048. catch
  1049. {
  1050. // Already logged at lower levels
  1051. return new QueryResult<BaseItem>
  1052. {
  1053. };
  1054. }
  1055. }
  1056. if (query.Recursive)
  1057. {
  1058. return QueryRecursive(query);
  1059. }
  1060. var user = query.User;
  1061. Func<BaseItem, bool> filter = i => UserViewBuilder.Filter(i, user, query, UserDataManager, LibraryManager);
  1062. IEnumerable<BaseItem> items;
  1063. if (query.User == null)
  1064. {
  1065. items = query.Recursive
  1066. ? GetRecursiveChildren(filter)
  1067. : Children.Where(filter);
  1068. }
  1069. else
  1070. {
  1071. items = query.Recursive
  1072. ? GetRecursiveChildren(user, filter)
  1073. : GetChildren(user, true).Where(filter);
  1074. }
  1075. var result = PostFilterAndSort(items, query);
  1076. return result;
  1077. }
  1078. protected QueryResult<BaseItem> PostFilterAndSort(IEnumerable<BaseItem> items, InternalItemsQuery query)
  1079. {
  1080. return UserViewBuilder.PostFilterAndSort(items, this, null, query, LibraryManager);
  1081. }
  1082. public virtual IEnumerable<BaseItem> GetChildren(User user, bool includeLinkedChildren)
  1083. {
  1084. if (user == null)
  1085. {
  1086. throw new ArgumentNullException();
  1087. }
  1088. //the true root should return our users root folder children
  1089. if (IsPhysicalRoot) return user.RootFolder.GetChildren(user, includeLinkedChildren);
  1090. var result = new Dictionary<Guid, BaseItem>();
  1091. AddChildren(user, includeLinkedChildren, result, false, null);
  1092. return result.Values;
  1093. }
  1094. protected virtual IEnumerable<BaseItem> GetEligibleChildrenForRecursiveChildren(User user)
  1095. {
  1096. return Children;
  1097. }
  1098. /// <summary>
  1099. /// Adds the children to list.
  1100. /// </summary>
  1101. /// <param name="user">The user.</param>
  1102. /// <param name="includeLinkedChildren">if set to <c>true</c> [include linked children].</param>
  1103. /// <param name="result">The result.</param>
  1104. /// <param name="recursive">if set to <c>true</c> [recursive].</param>
  1105. /// <param name="filter">The filter.</param>
  1106. /// <returns><c>true</c> if XXXX, <c>false</c> otherwise</returns>
  1107. private void AddChildren(User user, bool includeLinkedChildren, Dictionary<Guid, BaseItem> result, bool recursive, Func<BaseItem, bool> filter)
  1108. {
  1109. foreach (var child in GetEligibleChildrenForRecursiveChildren(user))
  1110. {
  1111. if (child.IsVisible(user))
  1112. {
  1113. if (filter == null || filter(child))
  1114. {
  1115. result[child.Id] = child;
  1116. }
  1117. if (recursive && child.IsFolder)
  1118. {
  1119. var folder = (Folder)child;
  1120. folder.AddChildren(user, includeLinkedChildren, result, true, filter);
  1121. }
  1122. }
  1123. }
  1124. if (includeLinkedChildren)
  1125. {
  1126. foreach (var child in GetLinkedChildren(user))
  1127. {
  1128. if (child.IsVisible(user))
  1129. {
  1130. if (filter == null || filter(child))
  1131. {
  1132. result[child.Id] = child;
  1133. }
  1134. }
  1135. }
  1136. }
  1137. }
  1138. /// <summary>
  1139. /// Gets allowed recursive children of an item
  1140. /// </summary>
  1141. /// <param name="user">The user.</param>
  1142. /// <param name="includeLinkedChildren">if set to <c>true</c> [include linked children].</param>
  1143. /// <returns>IEnumerable{BaseItem}.</returns>
  1144. /// <exception cref="System.ArgumentNullException"></exception>
  1145. public IEnumerable<BaseItem> GetRecursiveChildren(User user, bool includeLinkedChildren = true)
  1146. {
  1147. return GetRecursiveChildren(user, i => true);
  1148. }
  1149. public virtual IEnumerable<BaseItem> GetRecursiveChildren(User user, Func<BaseItem, bool> filter)
  1150. {
  1151. if (user == null)
  1152. {
  1153. throw new ArgumentNullException("user");
  1154. }
  1155. var result = new Dictionary<Guid, BaseItem>();
  1156. AddChildren(user, true, result, true, filter);
  1157. return result.Values;
  1158. }
  1159. /// <summary>
  1160. /// Gets the recursive children.
  1161. /// </summary>
  1162. /// <returns>IList{BaseItem}.</returns>
  1163. public IList<BaseItem> GetRecursiveChildren()
  1164. {
  1165. return GetRecursiveChildren(i => true);
  1166. }
  1167. public IList<BaseItem> GetRecursiveChildren(Func<BaseItem, bool> filter)
  1168. {
  1169. var list = new List<BaseItem>();
  1170. AddChildrenToList(list, true, filter);
  1171. return list;
  1172. }
  1173. /// <summary>
  1174. /// Adds the children to list.
  1175. /// </summary>
  1176. /// <param name="list">The list.</param>
  1177. /// <param name="recursive">if set to <c>true</c> [recursive].</param>
  1178. /// <param name="filter">The filter.</param>
  1179. private void AddChildrenToList(List<BaseItem> list, bool recursive, Func<BaseItem, bool> filter)
  1180. {
  1181. foreach (var child in Children)
  1182. {
  1183. if (filter == null || filter(child))
  1184. {
  1185. list.Add(child);
  1186. }
  1187. if (recursive && child.IsFolder)
  1188. {
  1189. var folder = (Folder)child;
  1190. folder.AddChildrenToList(list, true, filter);
  1191. }
  1192. }
  1193. }
  1194. /// <summary>
  1195. /// Gets the linked children.
  1196. /// </summary>
  1197. /// <returns>IEnumerable{BaseItem}.</returns>
  1198. public IEnumerable<BaseItem> GetLinkedChildren()
  1199. {
  1200. return LinkedChildren
  1201. .Select(GetLinkedChild)
  1202. .Where(i => i != null);
  1203. }
  1204. protected virtual bool FilterLinkedChildrenPerUser
  1205. {
  1206. get
  1207. {
  1208. return false;
  1209. }
  1210. }
  1211. public IEnumerable<BaseItem> GetLinkedChildren(User user)
  1212. {
  1213. if (!FilterLinkedChildrenPerUser || user == null)
  1214. {
  1215. return GetLinkedChildren();
  1216. }
  1217. var locations = user.RootFolder
  1218. .Children
  1219. .OfType<CollectionFolder>()
  1220. .Where(i => i.IsVisible(user))
  1221. .SelectMany(i => i.PhysicalLocations)
  1222. .ToList();
  1223. return LinkedChildren
  1224. .Select(i =>
  1225. {
  1226. var requiresPostFilter = true;
  1227. if (!string.IsNullOrWhiteSpace(i.Path))
  1228. {
  1229. requiresPostFilter = false;
  1230. if (!locations.Any(l => FileSystem.ContainsSubPath(l, i.Path)))
  1231. {
  1232. return null;
  1233. }
  1234. }
  1235. var child = GetLinkedChild(i);
  1236. if (requiresPostFilter && child != null)
  1237. {
  1238. if (string.IsNullOrWhiteSpace(child.Path))
  1239. {
  1240. Logger.Debug("Found LinkedChild with null path: {0}", child.Name);
  1241. return child;
  1242. }
  1243. if (!locations.Any(l => FileSystem.ContainsSubPath(l, child.Path)))
  1244. {
  1245. return null;
  1246. }
  1247. }
  1248. return child;
  1249. })
  1250. .Where(i => i != null);
  1251. }
  1252. /// <summary>
  1253. /// Gets the linked children.
  1254. /// </summary>
  1255. /// <returns>IEnumerable{BaseItem}.</returns>
  1256. public IEnumerable<Tuple<LinkedChild, BaseItem>> GetLinkedChildrenInfos()
  1257. {
  1258. return LinkedChildren
  1259. .Select(i => new Tuple<LinkedChild, BaseItem>(i, GetLinkedChild(i)))
  1260. .Where(i => i.Item2 != null);
  1261. }
  1262. [IgnoreDataMember]
  1263. protected override bool SupportsOwnedItems
  1264. {
  1265. get
  1266. {
  1267. return base.SupportsOwnedItems || SupportsShortcutChildren;
  1268. }
  1269. }
  1270. protected override async Task<bool> RefreshedOwnedItems(MetadataRefreshOptions options, List<FileSystemMetadata> fileSystemChildren, CancellationToken cancellationToken)
  1271. {
  1272. var changesFound = false;
  1273. if (LocationType == LocationType.FileSystem)
  1274. {
  1275. if (RefreshLinkedChildren(fileSystemChildren))
  1276. {
  1277. changesFound = true;
  1278. }
  1279. }
  1280. var baseHasChanges = await base.RefreshedOwnedItems(options, fileSystemChildren, cancellationToken).ConfigureAwait(false);
  1281. return baseHasChanges || changesFound;
  1282. }
  1283. /// <summary>
  1284. /// Refreshes the linked children.
  1285. /// </summary>
  1286. /// <returns><c>true</c> if XXXX, <c>false</c> otherwise</returns>
  1287. private bool RefreshLinkedChildren(IEnumerable<FileSystemMetadata> fileSystemChildren)
  1288. {
  1289. var currentManualLinks = LinkedChildren.Where(i => i.Type == LinkedChildType.Manual).ToList();
  1290. var currentShortcutLinks = LinkedChildren.Where(i => i.Type == LinkedChildType.Shortcut).ToList();
  1291. List<LinkedChild> newShortcutLinks;
  1292. if (SupportsShortcutChildren)
  1293. {
  1294. newShortcutLinks = fileSystemChildren
  1295. .Where(i => (i.Attributes & FileAttributes.Directory) != FileAttributes.Directory && FileSystem.IsShortcut(i.FullName))
  1296. .Select(i =>
  1297. {
  1298. try
  1299. {
  1300. Logger.Debug("Found shortcut at {0}", i.FullName);
  1301. var resolvedPath = FileSystem.ResolveShortcut(i.FullName);
  1302. if (!string.IsNullOrEmpty(resolvedPath))
  1303. {
  1304. return new LinkedChild
  1305. {
  1306. Path = resolvedPath,
  1307. Type = LinkedChildType.Shortcut
  1308. };
  1309. }
  1310. Logger.Error("Error resolving shortcut {0}", i.FullName);
  1311. return null;
  1312. }
  1313. catch (IOException ex)
  1314. {
  1315. Logger.ErrorException("Error resolving shortcut {0}", ex, i.FullName);
  1316. return null;
  1317. }
  1318. })
  1319. .Where(i => i != null)
  1320. .ToList();
  1321. }
  1322. else { newShortcutLinks = new List<LinkedChild>(); }
  1323. if (!newShortcutLinks.SequenceEqual(currentShortcutLinks, new LinkedChildComparer()))
  1324. {
  1325. Logger.Info("Shortcut links have changed for {0}", Path);
  1326. newShortcutLinks.AddRange(currentManualLinks);
  1327. LinkedChildren = newShortcutLinks;
  1328. return true;
  1329. }
  1330. foreach (var child in LinkedChildren)
  1331. {
  1332. // Reset the cached value
  1333. child.ItemId = null;
  1334. }
  1335. return false;
  1336. }
  1337. /// <summary>
  1338. /// Folders need to validate and refresh
  1339. /// </summary>
  1340. /// <returns>Task.</returns>
  1341. public override async Task ChangedExternally()
  1342. {
  1343. var progress = new Progress<double>();
  1344. await ValidateChildren(progress, CancellationToken.None).ConfigureAwait(false);
  1345. await base.ChangedExternally().ConfigureAwait(false);
  1346. }
  1347. /// <summary>
  1348. /// Marks the played.
  1349. /// </summary>
  1350. /// <param name="user">The user.</param>
  1351. /// <param name="datePlayed">The date played.</param>
  1352. /// <param name="resetPosition">if set to <c>true</c> [reset position].</param>
  1353. /// <returns>Task.</returns>
  1354. public override async Task MarkPlayed(User user,
  1355. DateTime? datePlayed,
  1356. bool resetPosition)
  1357. {
  1358. var query = new InternalItemsQuery
  1359. {
  1360. User = user,
  1361. Recursive = true,
  1362. IsFolder = false,
  1363. IsUnaired = false
  1364. };
  1365. if (!user.Configuration.DisplayMissingEpisodes)
  1366. {
  1367. query.IsMissing = false;
  1368. }
  1369. var itemsResult = await GetItems(query).ConfigureAwait(false);
  1370. // Sweep through recursively and update status
  1371. var tasks = itemsResult.Items.Select(c => c.MarkPlayed(user, datePlayed, resetPosition));
  1372. await Task.WhenAll(tasks).ConfigureAwait(false);
  1373. }
  1374. /// <summary>
  1375. /// Marks the unplayed.
  1376. /// </summary>
  1377. /// <param name="user">The user.</param>
  1378. /// <returns>Task.</returns>
  1379. public override async Task MarkUnplayed(User user)
  1380. {
  1381. var itemsResult = await GetItems(new InternalItemsQuery
  1382. {
  1383. User = user,
  1384. Recursive = true,
  1385. IsFolder = false
  1386. }).ConfigureAwait(false);
  1387. // Sweep through recursively and update status
  1388. var tasks = itemsResult.Items.Select(c => c.MarkUnplayed(user));
  1389. await Task.WhenAll(tasks).ConfigureAwait(false);
  1390. }
  1391. /// <summary>
  1392. /// Finds an item by path, recursively
  1393. /// </summary>
  1394. /// <param name="path">The path.</param>
  1395. /// <returns>BaseItem.</returns>
  1396. /// <exception cref="System.ArgumentNullException"></exception>
  1397. public BaseItem FindByPath(string path)
  1398. {
  1399. if (string.IsNullOrEmpty(path))
  1400. {
  1401. throw new ArgumentNullException();
  1402. }
  1403. if (string.Equals(Path, path, StringComparison.OrdinalIgnoreCase))
  1404. {
  1405. return this;
  1406. }
  1407. if (PhysicalLocations.Contains(path, StringComparer.OrdinalIgnoreCase))
  1408. {
  1409. return this;
  1410. }
  1411. return GetRecursiveChildren(i => string.Equals(i.Path, path, StringComparison.OrdinalIgnoreCase) ||
  1412. (!i.IsFolder && !i.IsInMixedFolder && string.Equals(i.ContainingFolderPath, path, StringComparison.OrdinalIgnoreCase)) ||
  1413. i.PhysicalLocations.Contains(path, StringComparer.OrdinalIgnoreCase))
  1414. .FirstOrDefault();
  1415. }
  1416. public override bool IsPlayed(User user)
  1417. {
  1418. return GetRecursiveChildren(user, i => !i.IsFolder && i.LocationType != LocationType.Virtual)
  1419. .All(i => i.IsPlayed(user));
  1420. }
  1421. public override bool IsUnplayed(User user)
  1422. {
  1423. return !IsPlayed(user);
  1424. }
  1425. public override void FillUserDataDtoValues(UserItemDataDto dto, UserItemData userData, User user)
  1426. {
  1427. var recursiveItemCount = 0;
  1428. var unplayed = 0;
  1429. double totalPercentPlayed = 0;
  1430. IEnumerable<BaseItem> children;
  1431. var folder = this;
  1432. var season = folder as Season;
  1433. if (season != null)
  1434. {
  1435. children = season.GetEpisodes(user).Where(i => i.LocationType != LocationType.Virtual);
  1436. }
  1437. else
  1438. {
  1439. children = folder.GetRecursiveChildren(user, i => !i.IsFolder && i.LocationType != LocationType.Virtual);
  1440. }
  1441. // Loop through each recursive child
  1442. foreach (var child in children)
  1443. {
  1444. recursiveItemCount++;
  1445. var isUnplayed = true;
  1446. var itemUserData = UserDataManager.GetUserData(user.Id, child.GetUserDataKey());
  1447. // Incrememt totalPercentPlayed
  1448. if (itemUserData != null)
  1449. {
  1450. if (itemUserData.Played)
  1451. {
  1452. totalPercentPlayed += 100;
  1453. isUnplayed = false;
  1454. }
  1455. else if (itemUserData.PlaybackPositionTicks > 0 && child.RunTimeTicks.HasValue && child.RunTimeTicks.Value > 0)
  1456. {
  1457. double itemPercent = itemUserData.PlaybackPositionTicks;
  1458. itemPercent /= child.RunTimeTicks.Value;
  1459. totalPercentPlayed += itemPercent;
  1460. }
  1461. }
  1462. if (isUnplayed)
  1463. {
  1464. unplayed++;
  1465. }
  1466. }
  1467. dto.UnplayedItemCount = unplayed;
  1468. if (recursiveItemCount > 0)
  1469. {
  1470. dto.PlayedPercentage = totalPercentPlayed / recursiveItemCount;
  1471. dto.Played = dto.PlayedPercentage.Value >= 100;
  1472. }
  1473. }
  1474. }
  1475. }