| | | 1 | | #nullable disable |
| | | 2 | | |
| | | 3 | | #pragma warning disable CA1819, CS1591 |
| | | 4 | | |
| | | 5 | | using System; |
| | | 6 | | using System.Collections.Concurrent; |
| | | 7 | | using System.Collections.Generic; |
| | | 8 | | using System.Linq; |
| | | 9 | | using System.Text.Json.Serialization; |
| | | 10 | | using System.Threading; |
| | | 11 | | using System.Threading.Tasks; |
| | | 12 | | using Jellyfin.Extensions; |
| | | 13 | | using MediaBrowser.Controller.IO; |
| | | 14 | | using MediaBrowser.Controller.Library; |
| | | 15 | | using MediaBrowser.Controller.Providers; |
| | | 16 | | using MediaBrowser.Model.IO; |
| | | 17 | | |
| | | 18 | | namespace MediaBrowser.Controller.Entities |
| | | 19 | | { |
| | | 20 | | /// <summary> |
| | | 21 | | /// Specialized folder that can have items added to it's children by external entities. |
| | | 22 | | /// Used for our RootFolder so plugins can add items. |
| | | 23 | | /// </summary> |
| | | 24 | | public class AggregateFolder : Folder |
| | | 25 | | { |
| | 59 | 26 | | private readonly Lock _childIdsLock = new(); |
| | | 27 | | |
| | | 28 | | /// <summary> |
| | | 29 | | /// The _virtual children. |
| | | 30 | | /// </summary> |
| | 59 | 31 | | private readonly ConcurrentBag<BaseItem> _virtualChildren = new ConcurrentBag<BaseItem>(); |
| | | 32 | | private bool _requiresRefresh; |
| | | 33 | | private Guid[] _childrenIds = null; |
| | | 34 | | |
| | 59 | 35 | | public AggregateFolder() |
| | | 36 | | { |
| | 59 | 37 | | PhysicalLocationsList = Array.Empty<string>(); |
| | 59 | 38 | | } |
| | | 39 | | |
| | | 40 | | /// <summary> |
| | | 41 | | /// Gets the virtual children. |
| | | 42 | | /// </summary> |
| | | 43 | | /// <value>The virtual children.</value> |
| | 66 | 44 | | public ConcurrentBag<BaseItem> VirtualChildren => _virtualChildren; |
| | | 45 | | |
| | | 46 | | [JsonIgnore] |
| | 0 | 47 | | public override bool IsPhysicalRoot => true; |
| | | 48 | | |
| | | 49 | | [JsonIgnore] |
| | 0 | 50 | | public override bool SupportsPlayedStatus => false; |
| | | 51 | | |
| | | 52 | | [JsonIgnore] |
| | 89 | 53 | | public override string[] PhysicalLocations => PhysicalLocationsList; |
| | | 54 | | |
| | | 55 | | public string[] PhysicalLocationsList { get; set; } |
| | | 56 | | |
| | | 57 | | // Children caches the resolved items, _childrenIds the ids they were loaded from. Clearing |
| | | 58 | | // only the former sends the next read back through LoadChildren, which replays the stale |
| | | 59 | | // id list, so a caller invalidating this folder has to drop both. |
| | | 60 | | [JsonIgnore] |
| | | 61 | | public override IEnumerable<BaseItem> Children |
| | | 62 | | { |
| | 188 | 63 | | get => base.Children; |
| | | 64 | | set |
| | | 65 | | { |
| | 184 | 66 | | if (value is null) |
| | | 67 | | { |
| | 156 | 68 | | ClearCache(); |
| | | 69 | | } |
| | | 70 | | |
| | 184 | 71 | | base.Children = value; |
| | 184 | 72 | | } |
| | | 73 | | } |
| | | 74 | | |
| | | 75 | | public override bool CanDelete() |
| | | 76 | | { |
| | 0 | 77 | | return false; |
| | | 78 | | } |
| | | 79 | | |
| | | 80 | | protected override FileSystemMetadata[] GetFileSystemChildren(IDirectoryService directoryService) |
| | | 81 | | { |
| | 49 | 82 | | return CreateResolveArgs(directoryService, true).FileSystemChildren; |
| | | 83 | | } |
| | | 84 | | |
| | | 85 | | protected override IReadOnlyList<BaseItem> LoadChildren() |
| | 86 | 86 | | { |
| | | 87 | | lock (_childIdsLock) |
| | | 88 | | { |
| | 86 | 89 | | if (_childrenIds is null || _childrenIds.Length == 0) |
| | | 90 | | { |
| | 86 | 91 | | var list = base.LoadChildren(); |
| | 86 | 92 | | _childrenIds = list.Select(i => i.Id).ToArray(); |
| | 86 | 93 | | return list; |
| | | 94 | | } |
| | | 95 | | |
| | 0 | 96 | | return _childrenIds.Select(LibraryManager.GetItemById).Where(i => i is not null).ToList(); |
| | | 97 | | } |
| | 86 | 98 | | } |
| | | 99 | | |
| | | 100 | | private void ClearCache() |
| | 350 | 101 | | { |
| | | 102 | | lock (_childIdsLock) |
| | | 103 | | { |
| | 350 | 104 | | _childrenIds = null; |
| | 350 | 105 | | } |
| | 350 | 106 | | } |
| | | 107 | | |
| | | 108 | | public override bool RequiresRefresh() |
| | | 109 | | { |
| | 29 | 110 | | var changed = base.RequiresRefresh() || _requiresRefresh; |
| | | 111 | | |
| | 29 | 112 | | if (!changed) |
| | | 113 | | { |
| | 28 | 114 | | var locations = PhysicalLocations; |
| | | 115 | | |
| | 28 | 116 | | var newLocations = CreateResolveArgs(new DirectoryService(FileSystem), false).PhysicalLocations; |
| | | 117 | | |
| | 28 | 118 | | if (!locations.SequenceEqual(newLocations)) |
| | | 119 | | { |
| | 17 | 120 | | changed = true; |
| | | 121 | | } |
| | | 122 | | } |
| | | 123 | | |
| | 29 | 124 | | return changed; |
| | | 125 | | } |
| | | 126 | | |
| | | 127 | | public override bool BeforeMetadataRefresh(bool replaceAllMetadata) |
| | | 128 | | { |
| | 18 | 129 | | ClearCache(); |
| | | 130 | | |
| | 18 | 131 | | var changed = base.BeforeMetadataRefresh(replaceAllMetadata) || _requiresRefresh; |
| | 18 | 132 | | _requiresRefresh = false; |
| | 18 | 133 | | return changed; |
| | | 134 | | } |
| | | 135 | | |
| | | 136 | | private ItemResolveArgs CreateResolveArgs(IDirectoryService directoryService, bool setPhysicalLocations) |
| | | 137 | | { |
| | 77 | 138 | | ClearCache(); |
| | | 139 | | |
| | 77 | 140 | | var path = ContainingFolderPath; |
| | | 141 | | |
| | 77 | 142 | | var args = new ItemResolveArgs(ConfigurationManager.ApplicationPaths, LibraryManager) |
| | 77 | 143 | | { |
| | 77 | 144 | | FileInfo = FileSystem.GetDirectoryInfo(path) |
| | 77 | 145 | | }; |
| | | 146 | | |
| | | 147 | | // Gather child folder and files |
| | 77 | 148 | | if (args.IsDirectory) |
| | | 149 | | { |
| | | 150 | | // When resolving the root, we need it's grandchildren (children of user views) |
| | 77 | 151 | | var flattenFolderDepth = 2; |
| | | 152 | | |
| | 77 | 153 | | var files = FileData.GetFilteredFileSystemEntries(directoryService, args.Path, FileSystem, CollectionFol |
| | | 154 | | |
| | | 155 | | // Need to remove subpaths that may have been resolved from shortcuts |
| | | 156 | | // Example: if \\server\movies exists, then strip out \\server\movies\action |
| | 77 | 157 | | files = LibraryManager.NormalizeRootPathList(files).ToArray(); |
| | | 158 | | |
| | 77 | 159 | | args.FileSystemChildren = files; |
| | | 160 | | } |
| | | 161 | | |
| | 77 | 162 | | _requiresRefresh = _requiresRefresh || !args.PhysicalLocations.SequenceEqual(PhysicalLocations); |
| | 77 | 163 | | if (setPhysicalLocations) |
| | | 164 | | { |
| | 49 | 165 | | PhysicalLocationsList = args.PhysicalLocations; |
| | | 166 | | } |
| | | 167 | | |
| | 77 | 168 | | return args; |
| | | 169 | | } |
| | | 170 | | |
| | | 171 | | protected override IEnumerable<BaseItem> GetNonCachedChildren(IDirectoryService directoryService) |
| | | 172 | | { |
| | 49 | 173 | | return base.GetNonCachedChildren(directoryService).Concat(_virtualChildren); |
| | | 174 | | } |
| | | 175 | | |
| | | 176 | | protected override async Task ValidateChildrenInternal(IProgress<double> progress, bool recursive, bool refreshC |
| | | 177 | | { |
| | 50 | 178 | | ClearCache(); |
| | | 179 | | |
| | 50 | 180 | | await base.ValidateChildrenInternal(progress, recursive, refreshChildMetadata, allowRemoveRoot, refreshOptio |
| | 50 | 181 | | .ConfigureAwait(false); |
| | | 182 | | |
| | 49 | 183 | | ClearCache(); |
| | 49 | 184 | | } |
| | | 185 | | |
| | | 186 | | /// <summary> |
| | | 187 | | /// Adds the virtual child. |
| | | 188 | | /// </summary> |
| | | 189 | | /// <param name="child">The child.</param> |
| | | 190 | | /// <exception cref="ArgumentNullException">Throws if child is null.</exception> |
| | | 191 | | public void AddVirtualChild(BaseItem child) |
| | | 192 | | { |
| | 27 | 193 | | ArgumentNullException.ThrowIfNull(child); |
| | | 194 | | |
| | 27 | 195 | | _virtualChildren.Add(child); |
| | 27 | 196 | | } |
| | | 197 | | |
| | | 198 | | /// <summary> |
| | | 199 | | /// Finds the virtual child. |
| | | 200 | | /// </summary> |
| | | 201 | | /// <param name="id">The id.</param> |
| | | 202 | | /// <returns>BaseItem.</returns> |
| | | 203 | | /// <exception cref="ArgumentNullException">The id is empty.</exception> |
| | | 204 | | public BaseItem FindVirtualChild(Guid id) |
| | | 205 | | { |
| | 0 | 206 | | if (id.IsEmpty()) |
| | | 207 | | { |
| | 0 | 208 | | throw new ArgumentNullException(nameof(id)); |
| | | 209 | | } |
| | | 210 | | |
| | 0 | 211 | | foreach (var child in _virtualChildren) |
| | | 212 | | { |
| | 0 | 213 | | if (child.Id.Equals(id)) |
| | | 214 | | { |
| | 0 | 215 | | return child; |
| | | 216 | | } |
| | | 217 | | } |
| | | 218 | | |
| | 0 | 219 | | return null; |
| | 0 | 220 | | } |
| | | 221 | | } |
| | | 222 | | } |