2021-05-06 18:39:20 -04:00
|
|
|
#nullable disable
|
|
|
|
|
2021-07-23 16:07:19 -04:00
|
|
|
#pragma warning disable CA1819, CS1591
|
2020-08-22 15:56:24 -04:00
|
|
|
|
2019-01-13 15:01:16 -05:00
|
|
|
using System;
|
2018-12-27 18:27:57 -05:00
|
|
|
using System.Collections.Concurrent;
|
|
|
|
using System.Collections.Generic;
|
|
|
|
using System.Linq;
|
2019-10-15 11:49:49 -04:00
|
|
|
using System.Text.Json.Serialization;
|
2018-12-27 18:27:57 -05:00
|
|
|
using System.Threading;
|
|
|
|
using System.Threading.Tasks;
|
2024-01-17 10:51:39 -05:00
|
|
|
using Jellyfin.Extensions;
|
2019-01-13 14:25:32 -05:00
|
|
|
using MediaBrowser.Controller.IO;
|
|
|
|
using MediaBrowser.Controller.Library;
|
2018-12-27 18:27:57 -05:00
|
|
|
using MediaBrowser.Controller.Providers;
|
|
|
|
using MediaBrowser.Model.IO;
|
|
|
|
|
|
|
|
namespace MediaBrowser.Controller.Entities
|
|
|
|
{
|
|
|
|
/// <summary>
|
|
|
|
/// Specialized folder that can have items added to it's children by external entities.
|
2021-07-26 21:13:37 -04:00
|
|
|
/// Used for our RootFolder so plugins can add items.
|
2018-12-27 18:27:57 -05:00
|
|
|
/// </summary>
|
|
|
|
public class AggregateFolder : Folder
|
|
|
|
{
|
2021-07-23 19:36:27 -04:00
|
|
|
private readonly object _childIdsLock = new object();
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// The _virtual children.
|
|
|
|
/// </summary>
|
|
|
|
private readonly ConcurrentBag<BaseItem> _virtualChildren = new ConcurrentBag<BaseItem>();
|
2021-05-13 09:32:02 -04:00
|
|
|
private bool _requiresRefresh;
|
2021-07-23 16:07:19 -04:00
|
|
|
private Guid[] _childrenIds = null;
|
|
|
|
|
2018-12-27 18:27:57 -05:00
|
|
|
public AggregateFolder()
|
|
|
|
{
|
2018-12-27 16:43:48 -05:00
|
|
|
PhysicalLocationsList = Array.Empty<string>();
|
2018-12-27 18:27:57 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Gets the virtual children.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The virtual children.</value>
|
2019-01-13 15:31:14 -05:00
|
|
|
public ConcurrentBag<BaseItem> VirtualChildren => _virtualChildren;
|
2018-12-27 18:27:57 -05:00
|
|
|
|
2021-07-23 19:36:27 -04:00
|
|
|
[JsonIgnore]
|
|
|
|
public override bool IsPhysicalRoot => true;
|
|
|
|
|
|
|
|
[JsonIgnore]
|
|
|
|
public override bool SupportsPlayedStatus => false;
|
|
|
|
|
2019-10-15 11:49:49 -04:00
|
|
|
[JsonIgnore]
|
2019-01-13 15:31:14 -05:00
|
|
|
public override string[] PhysicalLocations => PhysicalLocationsList;
|
2018-12-27 18:27:57 -05:00
|
|
|
|
|
|
|
public string[] PhysicalLocationsList { get; set; }
|
2021-07-23 19:36:27 -04:00
|
|
|
|
2021-07-23 16:07:19 -04:00
|
|
|
public override bool CanDelete()
|
|
|
|
{
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2018-12-27 18:27:57 -05:00
|
|
|
protected override FileSystemMetadata[] GetFileSystemChildren(IDirectoryService directoryService)
|
|
|
|
{
|
|
|
|
return CreateResolveArgs(directoryService, true).FileSystemChildren;
|
|
|
|
}
|
|
|
|
|
|
|
|
protected override List<BaseItem> LoadChildren()
|
|
|
|
{
|
|
|
|
lock (_childIdsLock)
|
|
|
|
{
|
2022-12-05 09:00:20 -05:00
|
|
|
if (_childrenIds is null || _childrenIds.Length == 0)
|
2018-12-27 18:27:57 -05:00
|
|
|
{
|
|
|
|
var list = base.LoadChildren();
|
|
|
|
_childrenIds = list.Select(i => i.Id).ToArray();
|
|
|
|
return list;
|
|
|
|
}
|
|
|
|
|
2022-12-05 09:01:13 -05:00
|
|
|
return _childrenIds.Select(LibraryManager.GetItemById).Where(i => i is not null).ToList();
|
2018-12-27 18:27:57 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
private void ClearCache()
|
|
|
|
{
|
|
|
|
lock (_childIdsLock)
|
|
|
|
{
|
|
|
|
_childrenIds = null;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
public override bool RequiresRefresh()
|
|
|
|
{
|
|
|
|
var changed = base.RequiresRefresh() || _requiresRefresh;
|
|
|
|
|
|
|
|
if (!changed)
|
|
|
|
{
|
|
|
|
var locations = PhysicalLocations;
|
|
|
|
|
2019-09-10 16:37:53 -04:00
|
|
|
var newLocations = CreateResolveArgs(new DirectoryService(FileSystem), false).PhysicalLocations;
|
2018-12-27 18:27:57 -05:00
|
|
|
|
|
|
|
if (!locations.SequenceEqual(newLocations))
|
|
|
|
{
|
|
|
|
changed = true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return changed;
|
|
|
|
}
|
|
|
|
|
2021-05-13 09:32:02 -04:00
|
|
|
public override bool BeforeMetadataRefresh(bool replaceAllMetadata)
|
2018-12-27 18:27:57 -05:00
|
|
|
{
|
|
|
|
ClearCache();
|
|
|
|
|
2021-05-13 09:32:02 -04:00
|
|
|
var changed = base.BeforeMetadataRefresh(replaceAllMetadata) || _requiresRefresh;
|
2018-12-27 18:27:57 -05:00
|
|
|
_requiresRefresh = false;
|
|
|
|
return changed;
|
|
|
|
}
|
|
|
|
|
|
|
|
private ItemResolveArgs CreateResolveArgs(IDirectoryService directoryService, bool setPhysicalLocations)
|
|
|
|
{
|
|
|
|
ClearCache();
|
|
|
|
|
|
|
|
var path = ContainingFolderPath;
|
|
|
|
|
2023-03-06 23:00:55 -05:00
|
|
|
var args = new ItemResolveArgs(ConfigurationManager.ApplicationPaths, LibraryManager)
|
2018-12-27 18:27:57 -05:00
|
|
|
{
|
2021-04-21 19:23:24 -04:00
|
|
|
FileInfo = FileSystem.GetDirectoryInfo(path)
|
2018-12-27 18:27:57 -05:00
|
|
|
};
|
|
|
|
|
|
|
|
// Gather child folder and files
|
|
|
|
if (args.IsDirectory)
|
|
|
|
{
|
|
|
|
// When resolving the root, we need it's grandchildren (children of user views)
|
|
|
|
var flattenFolderDepth = 2;
|
|
|
|
|
|
|
|
var files = FileData.GetFilteredFileSystemEntries(directoryService, args.Path, FileSystem, CollectionFolder.ApplicationHost, Logger, args, flattenFolderDepth: flattenFolderDepth, resolveShortcuts: true);
|
|
|
|
|
|
|
|
// Need to remove subpaths that may have been resolved from shortcuts
|
|
|
|
// Example: if \\server\movies exists, then strip out \\server\movies\action
|
|
|
|
files = LibraryManager.NormalizeRootPathList(files).ToArray();
|
|
|
|
|
|
|
|
args.FileSystemChildren = files;
|
|
|
|
}
|
|
|
|
|
|
|
|
_requiresRefresh = _requiresRefresh || !args.PhysicalLocations.SequenceEqual(PhysicalLocations);
|
|
|
|
if (setPhysicalLocations)
|
|
|
|
{
|
|
|
|
PhysicalLocationsList = args.PhysicalLocations;
|
|
|
|
}
|
|
|
|
|
|
|
|
return args;
|
|
|
|
}
|
|
|
|
|
|
|
|
protected override IEnumerable<BaseItem> GetNonCachedChildren(IDirectoryService directoryService)
|
|
|
|
{
|
|
|
|
return base.GetNonCachedChildren(directoryService).Concat(_virtualChildren);
|
|
|
|
}
|
|
|
|
|
2024-04-17 02:41:19 -04:00
|
|
|
protected override async Task ValidateChildrenInternal(IProgress<double> progress, bool recursive, bool refreshChildMetadata, bool allowRemoveRoot, MetadataRefreshOptions refreshOptions, IDirectoryService directoryService, CancellationToken cancellationToken)
|
2018-12-27 18:27:57 -05:00
|
|
|
{
|
|
|
|
ClearCache();
|
|
|
|
|
2024-04-17 02:41:19 -04:00
|
|
|
await base.ValidateChildrenInternal(progress, recursive, refreshChildMetadata, false, refreshOptions, directoryService, cancellationToken)
|
2018-12-27 18:27:57 -05:00
|
|
|
.ConfigureAwait(false);
|
|
|
|
|
|
|
|
ClearCache();
|
|
|
|
}
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Adds the virtual child.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="child">The child.</param>
|
2021-07-23 19:36:27 -04:00
|
|
|
/// <exception cref="ArgumentNullException">Throws if child is null.</exception>
|
2018-12-27 18:27:57 -05:00
|
|
|
public void AddVirtualChild(BaseItem child)
|
|
|
|
{
|
2022-10-06 14:21:23 -04:00
|
|
|
ArgumentNullException.ThrowIfNull(child);
|
2018-12-27 18:27:57 -05:00
|
|
|
|
|
|
|
_virtualChildren.Add(child);
|
|
|
|
}
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Finds the virtual child.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="id">The id.</param>
|
|
|
|
/// <returns>BaseItem.</returns>
|
2021-06-06 11:16:41 -04:00
|
|
|
/// <exception cref="ArgumentNullException">The id is empty.</exception>
|
2018-12-27 18:27:57 -05:00
|
|
|
public BaseItem FindVirtualChild(Guid id)
|
|
|
|
{
|
2024-01-17 10:51:39 -05:00
|
|
|
if (id.IsEmpty())
|
2018-12-27 18:27:57 -05:00
|
|
|
{
|
2019-01-06 15:50:43 -05:00
|
|
|
throw new ArgumentNullException(nameof(id));
|
2018-12-27 18:27:57 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
foreach (var child in _virtualChildren)
|
|
|
|
{
|
2022-02-21 08:15:09 -05:00
|
|
|
if (child.Id.Equals(id))
|
2018-12-27 18:27:57 -05:00
|
|
|
{
|
|
|
|
return child;
|
|
|
|
}
|
|
|
|
}
|
2020-06-15 17:43:52 -04:00
|
|
|
|
2018-12-27 18:27:57 -05:00
|
|
|
return null;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|