Folder.cs 60 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748
  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 official rating filter
  936. if (query.OfficialRatings.Length > 0)
  937. {
  938. Logger.Debug("Query requires post-filtering due to OfficialRatings");
  939. return true;
  940. }
  941. // Apply person filter
  942. if (query.ItemIdsFromPersonFilters != null)
  943. {
  944. Logger.Debug("Query requires post-filtering due to ItemIdsFromPersonFilters");
  945. return true;
  946. }
  947. if (query.MinPlayers.HasValue)
  948. {
  949. Logger.Debug("Query requires post-filtering due to MinPlayers");
  950. return true;
  951. }
  952. if (query.MaxPlayers.HasValue)
  953. {
  954. Logger.Debug("Query requires post-filtering due to MaxPlayers");
  955. return true;
  956. }
  957. if (query.MinIndexNumber.HasValue)
  958. {
  959. Logger.Debug("Query requires post-filtering due to MinIndexNumber");
  960. return true;
  961. }
  962. if (query.OfficialRatings.Length > 0)
  963. {
  964. Logger.Debug("Query requires post-filtering due to OfficialRatings");
  965. return true;
  966. }
  967. if (query.IsMissing.HasValue)
  968. {
  969. Logger.Debug("Query requires post-filtering due to IsMissing");
  970. return true;
  971. }
  972. if (query.IsUnaired.HasValue)
  973. {
  974. Logger.Debug("Query requires post-filtering due to IsUnaired");
  975. return true;
  976. }
  977. if (query.IsVirtualUnaired.HasValue)
  978. {
  979. Logger.Debug("Query requires post-filtering due to IsVirtualUnaired");
  980. return true;
  981. }
  982. if (UserViewBuilder.CollapseBoxSetItems(query, this, query.User))
  983. {
  984. Logger.Debug("Query requires post-filtering due to CollapseBoxSetItems");
  985. return true;
  986. }
  987. if (!string.IsNullOrWhiteSpace(query.AdjacentTo))
  988. {
  989. Logger.Debug("Query requires post-filtering due to AdjacentTo");
  990. return true;
  991. }
  992. if (!string.IsNullOrWhiteSpace(query.NameContains))
  993. {
  994. Logger.Debug("Query requires post-filtering due to NameContains");
  995. return true;
  996. }
  997. if (!string.IsNullOrWhiteSpace(query.NameLessThan))
  998. {
  999. Logger.Debug("Query requires post-filtering due to NameLessThan");
  1000. return true;
  1001. }
  1002. if (!string.IsNullOrWhiteSpace(query.NameStartsWith))
  1003. {
  1004. Logger.Debug("Query requires post-filtering due to NameStartsWith");
  1005. return true;
  1006. }
  1007. if (!string.IsNullOrWhiteSpace(query.NameStartsWithOrGreater))
  1008. {
  1009. Logger.Debug("Query requires post-filtering due to NameStartsWithOrGreater");
  1010. return true;
  1011. }
  1012. if (query.AirDays.Length > 0)
  1013. {
  1014. Logger.Debug("Query requires post-filtering due to AirDays");
  1015. return true;
  1016. }
  1017. if (query.SeriesStatuses.Length > 0)
  1018. {
  1019. Logger.Debug("Query requires post-filtering due to SeriesStatuses");
  1020. return true;
  1021. }
  1022. if (query.AiredDuringSeason.HasValue)
  1023. {
  1024. Logger.Debug("Query requires post-filtering due to AiredDuringSeason");
  1025. return true;
  1026. }
  1027. return false;
  1028. }
  1029. public virtual async Task<QueryResult<BaseItem>> GetItems(InternalItemsQuery query)
  1030. {
  1031. if (SourceType == SourceType.Channel)
  1032. {
  1033. try
  1034. {
  1035. // Don't blow up here because it could cause parent screens with other content to fail
  1036. return await ChannelManager.GetChannelItemsInternal(new ChannelItemQuery
  1037. {
  1038. ChannelId = ChannelId,
  1039. FolderId = Id.ToString("N"),
  1040. Limit = query.Limit,
  1041. StartIndex = query.StartIndex,
  1042. UserId = query.User.Id.ToString("N"),
  1043. SortBy = query.SortBy,
  1044. SortOrder = query.SortOrder
  1045. }, new Progress<double>(), CancellationToken.None);
  1046. }
  1047. catch
  1048. {
  1049. // Already logged at lower levels
  1050. return new QueryResult<BaseItem>
  1051. {
  1052. };
  1053. }
  1054. }
  1055. if (query.Recursive)
  1056. {
  1057. return QueryRecursive(query);
  1058. }
  1059. var user = query.User;
  1060. Func<BaseItem, bool> filter = i => UserViewBuilder.Filter(i, user, query, UserDataManager, LibraryManager);
  1061. IEnumerable<BaseItem> items;
  1062. if (query.User == null)
  1063. {
  1064. items = query.Recursive
  1065. ? GetRecursiveChildren(filter)
  1066. : Children.Where(filter);
  1067. }
  1068. else
  1069. {
  1070. items = query.Recursive
  1071. ? GetRecursiveChildren(user, filter)
  1072. : GetChildren(user, true).Where(filter);
  1073. }
  1074. var result = PostFilterAndSort(items, query);
  1075. return result;
  1076. }
  1077. protected QueryResult<BaseItem> PostFilterAndSort(IEnumerable<BaseItem> items, InternalItemsQuery query)
  1078. {
  1079. return UserViewBuilder.PostFilterAndSort(items, this, null, query, LibraryManager);
  1080. }
  1081. public virtual IEnumerable<BaseItem> GetChildren(User user, bool includeLinkedChildren)
  1082. {
  1083. if (user == null)
  1084. {
  1085. throw new ArgumentNullException();
  1086. }
  1087. //the true root should return our users root folder children
  1088. if (IsPhysicalRoot) return user.RootFolder.GetChildren(user, includeLinkedChildren);
  1089. var result = new Dictionary<Guid, BaseItem>();
  1090. AddChildren(user, includeLinkedChildren, result, false, null);
  1091. return result.Values;
  1092. }
  1093. protected virtual IEnumerable<BaseItem> GetEligibleChildrenForRecursiveChildren(User user)
  1094. {
  1095. return Children;
  1096. }
  1097. /// <summary>
  1098. /// Adds the children to list.
  1099. /// </summary>
  1100. /// <param name="user">The user.</param>
  1101. /// <param name="includeLinkedChildren">if set to <c>true</c> [include linked children].</param>
  1102. /// <param name="result">The result.</param>
  1103. /// <param name="recursive">if set to <c>true</c> [recursive].</param>
  1104. /// <param name="filter">The filter.</param>
  1105. /// <returns><c>true</c> if XXXX, <c>false</c> otherwise</returns>
  1106. private void AddChildren(User user, bool includeLinkedChildren, Dictionary<Guid, BaseItem> result, bool recursive, Func<BaseItem, bool> filter)
  1107. {
  1108. foreach (var child in GetEligibleChildrenForRecursiveChildren(user))
  1109. {
  1110. if (child.IsVisible(user))
  1111. {
  1112. if (filter == null || filter(child))
  1113. {
  1114. result[child.Id] = child;
  1115. }
  1116. if (recursive && child.IsFolder)
  1117. {
  1118. var folder = (Folder)child;
  1119. folder.AddChildren(user, includeLinkedChildren, result, true, filter);
  1120. }
  1121. }
  1122. }
  1123. if (includeLinkedChildren)
  1124. {
  1125. foreach (var child in GetLinkedChildren(user))
  1126. {
  1127. if (child.IsVisible(user))
  1128. {
  1129. if (filter == null || filter(child))
  1130. {
  1131. result[child.Id] = child;
  1132. }
  1133. }
  1134. }
  1135. }
  1136. }
  1137. /// <summary>
  1138. /// Gets allowed recursive children of an item
  1139. /// </summary>
  1140. /// <param name="user">The user.</param>
  1141. /// <param name="includeLinkedChildren">if set to <c>true</c> [include linked children].</param>
  1142. /// <returns>IEnumerable{BaseItem}.</returns>
  1143. /// <exception cref="System.ArgumentNullException"></exception>
  1144. public IEnumerable<BaseItem> GetRecursiveChildren(User user, bool includeLinkedChildren = true)
  1145. {
  1146. return GetRecursiveChildren(user, i => true);
  1147. }
  1148. public virtual IEnumerable<BaseItem> GetRecursiveChildren(User user, Func<BaseItem, bool> filter)
  1149. {
  1150. if (user == null)
  1151. {
  1152. throw new ArgumentNullException("user");
  1153. }
  1154. var result = new Dictionary<Guid, BaseItem>();
  1155. AddChildren(user, true, result, true, filter);
  1156. return result.Values;
  1157. }
  1158. /// <summary>
  1159. /// Gets the recursive children.
  1160. /// </summary>
  1161. /// <returns>IList{BaseItem}.</returns>
  1162. public IList<BaseItem> GetRecursiveChildren()
  1163. {
  1164. return GetRecursiveChildren(i => true);
  1165. }
  1166. public IList<BaseItem> GetRecursiveChildren(Func<BaseItem, bool> filter)
  1167. {
  1168. var list = new List<BaseItem>();
  1169. AddChildrenToList(list, true, filter);
  1170. return list;
  1171. }
  1172. /// <summary>
  1173. /// Adds the children to list.
  1174. /// </summary>
  1175. /// <param name="list">The list.</param>
  1176. /// <param name="recursive">if set to <c>true</c> [recursive].</param>
  1177. /// <param name="filter">The filter.</param>
  1178. private void AddChildrenToList(List<BaseItem> list, bool recursive, Func<BaseItem, bool> filter)
  1179. {
  1180. foreach (var child in Children)
  1181. {
  1182. if (filter == null || filter(child))
  1183. {
  1184. list.Add(child);
  1185. }
  1186. if (recursive && child.IsFolder)
  1187. {
  1188. var folder = (Folder)child;
  1189. folder.AddChildrenToList(list, true, filter);
  1190. }
  1191. }
  1192. }
  1193. /// <summary>
  1194. /// Gets the linked children.
  1195. /// </summary>
  1196. /// <returns>IEnumerable{BaseItem}.</returns>
  1197. public IEnumerable<BaseItem> GetLinkedChildren()
  1198. {
  1199. return LinkedChildren
  1200. .Select(GetLinkedChild)
  1201. .Where(i => i != null);
  1202. }
  1203. protected virtual bool FilterLinkedChildrenPerUser
  1204. {
  1205. get
  1206. {
  1207. return false;
  1208. }
  1209. }
  1210. public IEnumerable<BaseItem> GetLinkedChildren(User user)
  1211. {
  1212. if (!FilterLinkedChildrenPerUser || user == null)
  1213. {
  1214. return GetLinkedChildren();
  1215. }
  1216. var locations = user.RootFolder
  1217. .Children
  1218. .OfType<CollectionFolder>()
  1219. .Where(i => i.IsVisible(user))
  1220. .SelectMany(i => i.PhysicalLocations)
  1221. .ToList();
  1222. return LinkedChildren
  1223. .Select(i =>
  1224. {
  1225. var requiresPostFilter = true;
  1226. if (!string.IsNullOrWhiteSpace(i.Path))
  1227. {
  1228. requiresPostFilter = false;
  1229. if (!locations.Any(l => FileSystem.ContainsSubPath(l, i.Path)))
  1230. {
  1231. return null;
  1232. }
  1233. }
  1234. var child = GetLinkedChild(i);
  1235. if (requiresPostFilter && child != null)
  1236. {
  1237. if (string.IsNullOrWhiteSpace(child.Path))
  1238. {
  1239. Logger.Debug("Found LinkedChild with null path: {0}", child.Name);
  1240. return child;
  1241. }
  1242. if (!locations.Any(l => FileSystem.ContainsSubPath(l, child.Path)))
  1243. {
  1244. return null;
  1245. }
  1246. }
  1247. return child;
  1248. })
  1249. .Where(i => i != null);
  1250. }
  1251. /// <summary>
  1252. /// Gets the linked children.
  1253. /// </summary>
  1254. /// <returns>IEnumerable{BaseItem}.</returns>
  1255. public IEnumerable<Tuple<LinkedChild, BaseItem>> GetLinkedChildrenInfos()
  1256. {
  1257. return LinkedChildren
  1258. .Select(i => new Tuple<LinkedChild, BaseItem>(i, GetLinkedChild(i)))
  1259. .Where(i => i.Item2 != null);
  1260. }
  1261. [IgnoreDataMember]
  1262. protected override bool SupportsOwnedItems
  1263. {
  1264. get
  1265. {
  1266. return base.SupportsOwnedItems || SupportsShortcutChildren;
  1267. }
  1268. }
  1269. protected override async Task<bool> RefreshedOwnedItems(MetadataRefreshOptions options, List<FileSystemMetadata> fileSystemChildren, CancellationToken cancellationToken)
  1270. {
  1271. var changesFound = false;
  1272. if (LocationType == LocationType.FileSystem)
  1273. {
  1274. if (RefreshLinkedChildren(fileSystemChildren))
  1275. {
  1276. changesFound = true;
  1277. }
  1278. }
  1279. var baseHasChanges = await base.RefreshedOwnedItems(options, fileSystemChildren, cancellationToken).ConfigureAwait(false);
  1280. return baseHasChanges || changesFound;
  1281. }
  1282. /// <summary>
  1283. /// Refreshes the linked children.
  1284. /// </summary>
  1285. /// <returns><c>true</c> if XXXX, <c>false</c> otherwise</returns>
  1286. private bool RefreshLinkedChildren(IEnumerable<FileSystemMetadata> fileSystemChildren)
  1287. {
  1288. var currentManualLinks = LinkedChildren.Where(i => i.Type == LinkedChildType.Manual).ToList();
  1289. var currentShortcutLinks = LinkedChildren.Where(i => i.Type == LinkedChildType.Shortcut).ToList();
  1290. List<LinkedChild> newShortcutLinks;
  1291. if (SupportsShortcutChildren)
  1292. {
  1293. newShortcutLinks = fileSystemChildren
  1294. .Where(i => (i.Attributes & FileAttributes.Directory) != FileAttributes.Directory && FileSystem.IsShortcut(i.FullName))
  1295. .Select(i =>
  1296. {
  1297. try
  1298. {
  1299. Logger.Debug("Found shortcut at {0}", i.FullName);
  1300. var resolvedPath = FileSystem.ResolveShortcut(i.FullName);
  1301. if (!string.IsNullOrEmpty(resolvedPath))
  1302. {
  1303. return new LinkedChild
  1304. {
  1305. Path = resolvedPath,
  1306. Type = LinkedChildType.Shortcut
  1307. };
  1308. }
  1309. Logger.Error("Error resolving shortcut {0}", i.FullName);
  1310. return null;
  1311. }
  1312. catch (IOException ex)
  1313. {
  1314. Logger.ErrorException("Error resolving shortcut {0}", ex, i.FullName);
  1315. return null;
  1316. }
  1317. })
  1318. .Where(i => i != null)
  1319. .ToList();
  1320. }
  1321. else { newShortcutLinks = new List<LinkedChild>(); }
  1322. if (!newShortcutLinks.SequenceEqual(currentShortcutLinks, new LinkedChildComparer()))
  1323. {
  1324. Logger.Info("Shortcut links have changed for {0}", Path);
  1325. newShortcutLinks.AddRange(currentManualLinks);
  1326. LinkedChildren = newShortcutLinks;
  1327. return true;
  1328. }
  1329. foreach (var child in LinkedChildren)
  1330. {
  1331. // Reset the cached value
  1332. child.ItemId = null;
  1333. }
  1334. return false;
  1335. }
  1336. /// <summary>
  1337. /// Folders need to validate and refresh
  1338. /// </summary>
  1339. /// <returns>Task.</returns>
  1340. public override async Task ChangedExternally()
  1341. {
  1342. var progress = new Progress<double>();
  1343. await ValidateChildren(progress, CancellationToken.None).ConfigureAwait(false);
  1344. await base.ChangedExternally().ConfigureAwait(false);
  1345. }
  1346. /// <summary>
  1347. /// Marks the played.
  1348. /// </summary>
  1349. /// <param name="user">The user.</param>
  1350. /// <param name="datePlayed">The date played.</param>
  1351. /// <param name="resetPosition">if set to <c>true</c> [reset position].</param>
  1352. /// <returns>Task.</returns>
  1353. public override async Task MarkPlayed(User user,
  1354. DateTime? datePlayed,
  1355. bool resetPosition)
  1356. {
  1357. var query = new InternalItemsQuery
  1358. {
  1359. User = user,
  1360. Recursive = true,
  1361. IsFolder = false,
  1362. IsUnaired = false
  1363. };
  1364. if (!user.Configuration.DisplayMissingEpisodes)
  1365. {
  1366. query.IsMissing = false;
  1367. }
  1368. var itemsResult = await GetItems(query).ConfigureAwait(false);
  1369. // Sweep through recursively and update status
  1370. var tasks = itemsResult.Items.Select(c => c.MarkPlayed(user, datePlayed, resetPosition));
  1371. await Task.WhenAll(tasks).ConfigureAwait(false);
  1372. }
  1373. /// <summary>
  1374. /// Marks the unplayed.
  1375. /// </summary>
  1376. /// <param name="user">The user.</param>
  1377. /// <returns>Task.</returns>
  1378. public override async Task MarkUnplayed(User user)
  1379. {
  1380. var itemsResult = await GetItems(new InternalItemsQuery
  1381. {
  1382. User = user,
  1383. Recursive = true,
  1384. IsFolder = false
  1385. }).ConfigureAwait(false);
  1386. // Sweep through recursively and update status
  1387. var tasks = itemsResult.Items.Select(c => c.MarkUnplayed(user));
  1388. await Task.WhenAll(tasks).ConfigureAwait(false);
  1389. }
  1390. /// <summary>
  1391. /// Finds an item by path, recursively
  1392. /// </summary>
  1393. /// <param name="path">The path.</param>
  1394. /// <returns>BaseItem.</returns>
  1395. /// <exception cref="System.ArgumentNullException"></exception>
  1396. public BaseItem FindByPath(string path)
  1397. {
  1398. if (string.IsNullOrEmpty(path))
  1399. {
  1400. throw new ArgumentNullException();
  1401. }
  1402. if (string.Equals(Path, path, StringComparison.OrdinalIgnoreCase))
  1403. {
  1404. return this;
  1405. }
  1406. if (PhysicalLocations.Contains(path, StringComparer.OrdinalIgnoreCase))
  1407. {
  1408. return this;
  1409. }
  1410. return GetRecursiveChildren(i => string.Equals(i.Path, path, StringComparison.OrdinalIgnoreCase) ||
  1411. (!i.IsFolder && !i.IsInMixedFolder && string.Equals(i.ContainingFolderPath, path, StringComparison.OrdinalIgnoreCase)) ||
  1412. i.PhysicalLocations.Contains(path, StringComparer.OrdinalIgnoreCase))
  1413. .FirstOrDefault();
  1414. }
  1415. public override bool IsPlayed(User user)
  1416. {
  1417. return GetRecursiveChildren(user, i => !i.IsFolder && i.LocationType != LocationType.Virtual)
  1418. .All(i => i.IsPlayed(user));
  1419. }
  1420. public override bool IsUnplayed(User user)
  1421. {
  1422. return !IsPlayed(user);
  1423. }
  1424. public override void FillUserDataDtoValues(UserItemDataDto dto, UserItemData userData, User user)
  1425. {
  1426. var recursiveItemCount = 0;
  1427. var unplayed = 0;
  1428. double totalPercentPlayed = 0;
  1429. IEnumerable<BaseItem> children;
  1430. var folder = this;
  1431. var season = folder as Season;
  1432. if (season != null)
  1433. {
  1434. children = season.GetEpisodes(user).Where(i => i.LocationType != LocationType.Virtual);
  1435. }
  1436. else
  1437. {
  1438. children = folder.GetRecursiveChildren(user, i => !i.IsFolder && i.LocationType != LocationType.Virtual);
  1439. }
  1440. // Loop through each recursive child
  1441. foreach (var child in children)
  1442. {
  1443. recursiveItemCount++;
  1444. var isUnplayed = true;
  1445. var itemUserData = UserDataManager.GetUserData(user.Id, child.GetUserDataKey());
  1446. // Incrememt totalPercentPlayed
  1447. if (itemUserData != null)
  1448. {
  1449. if (itemUserData.Played)
  1450. {
  1451. totalPercentPlayed += 100;
  1452. isUnplayed = false;
  1453. }
  1454. else if (itemUserData.PlaybackPositionTicks > 0 && child.RunTimeTicks.HasValue && child.RunTimeTicks.Value > 0)
  1455. {
  1456. double itemPercent = itemUserData.PlaybackPositionTicks;
  1457. itemPercent /= child.RunTimeTicks.Value;
  1458. totalPercentPlayed += itemPercent;
  1459. }
  1460. }
  1461. if (isUnplayed)
  1462. {
  1463. unplayed++;
  1464. }
  1465. }
  1466. dto.UnplayedItemCount = unplayed;
  1467. if (recursiveItemCount > 0)
  1468. {
  1469. dto.PlayedPercentage = totalPercentPlayed / recursiveItemCount;
  1470. dto.Played = dto.PlayedPercentage.Value >= 100;
  1471. }
  1472. }
  1473. }
  1474. }