jellyfin/MediaBrowser.Controller/Entities/CollectionFolder.cs

403 lines
12 KiB
C#
Raw Normal View History

using MediaBrowser.Controller.IO;
using MediaBrowser.Controller.Library;
2014-02-08 22:38:02 +00:00
using MediaBrowser.Controller.Providers;
using System;
2013-02-21 01:33:05 +00:00
using System.Collections.Generic;
using System.IO;
2013-02-21 01:33:05 +00:00
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
2017-05-26 06:48:54 +00:00
using MediaBrowser.Controller.Configuration;
2016-08-13 20:54:29 +00:00
using MediaBrowser.Model.Configuration;
2017-06-23 16:04:45 +00:00
using MediaBrowser.Model.Entities;
2016-10-22 02:08:34 +00:00
using MediaBrowser.Model.Extensions;
2016-10-25 19:02:04 +00:00
using MediaBrowser.Model.IO;
using MediaBrowser.Model.Serialization;
2013-02-21 01:33:05 +00:00
namespace MediaBrowser.Controller.Entities
{
/// <summary>
/// Specialized Folder class that points to a subset of the physical folders in the system.
/// It is created from the user-specific folders within the system root
/// </summary>
public class CollectionFolder : Folder, ICollectionFolder
2013-02-21 01:33:05 +00:00
{
public static IXmlSerializer XmlSerializer { get; set; }
public CollectionFolder()
{
2017-08-24 19:52:19 +00:00
PhysicalLocationsList = EmptyStringArray;
PhysicalFolderIds = EmptyGuidArray;
}
2017-10-02 00:13:43 +00:00
//public override double? GetDefaultPrimaryImageAspectRatio()
//{
// double value = 16;
// value /= 9;
2017-09-22 20:33:01 +00:00
2017-10-02 00:13:43 +00:00
// return value;
//}
2017-09-22 20:33:01 +00:00
2016-10-25 19:02:04 +00:00
[IgnoreDataMember]
2016-10-11 06:46:59 +00:00
public override bool SupportsPlayedStatus
{
get
{
return false;
}
}
2017-06-29 19:10:58 +00:00
[IgnoreDataMember]
public override bool SupportsInheritedParentImages
{
get
{
return false;
}
}
2015-02-06 05:39:07 +00:00
public override bool CanDelete()
{
return false;
}
2013-07-12 19:56:40 +00:00
public string CollectionType { get; set; }
2016-08-13 06:33:31 +00:00
private static readonly Dictionary<string, LibraryOptions> LibraryOptions = new Dictionary<string, LibraryOptions>();
public LibraryOptions GetLibraryOptions()
{
return GetLibraryOptions(Path);
}
private static LibraryOptions LoadLibraryOptions(string path)
{
try
{
var result = XmlSerializer.DeserializeFromFile(typeof(LibraryOptions), GetLibraryOptionsPath(path)) as LibraryOptions;
if (result == null)
{
return new LibraryOptions();
}
return result;
}
catch (FileNotFoundException)
{
return new LibraryOptions();
}
2016-10-25 19:02:04 +00:00
catch (IOException)
{
return new LibraryOptions();
}
catch (Exception ex)
{
Logger.ErrorException("Error loading library options", ex);
return new LibraryOptions();
}
}
private static string GetLibraryOptionsPath(string path)
{
return System.IO.Path.Combine(path, "options.xml");
}
2016-08-14 03:12:26 +00:00
public void UpdateLibraryOptions(LibraryOptions options)
{
SaveLibraryOptions(Path, options);
}
public static LibraryOptions GetLibraryOptions(string path)
{
lock (LibraryOptions)
{
LibraryOptions options;
if (!LibraryOptions.TryGetValue(path, out options))
{
options = LoadLibraryOptions(path);
LibraryOptions[path] = options;
}
return options;
}
}
public static void SaveLibraryOptions(string path, LibraryOptions options)
{
2016-08-14 03:12:26 +00:00
lock (LibraryOptions)
{
LibraryOptions[path] = options;
XmlSerializer.SerializeToFile(options, GetLibraryOptionsPath(path));
}
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Allow different display preferences for each collection folder
/// </summary>
/// <value>The display prefs id.</value>
2016-10-25 19:02:04 +00:00
[IgnoreDataMember]
public override Guid DisplayPreferencesId
2013-02-21 01:33:05 +00:00
{
get
{
return Id;
}
}
2016-10-25 19:02:04 +00:00
[IgnoreDataMember]
2017-08-24 19:52:19 +00:00
public override string[] PhysicalLocations
{
get
{
return PhysicalLocationsList;
}
}
2015-02-19 19:00:56 +00:00
public override bool IsSaveLocalMetadataEnabled()
{
return true;
}
2017-08-24 19:52:19 +00:00
public string[] PhysicalLocationsList { get; set; }
public Guid[] PhysicalFolderIds { get; set; }
protected override FileSystemMetadata[] GetFileSystemChildren(IDirectoryService directoryService)
{
2017-08-24 19:52:19 +00:00
return CreateResolveArgs(directoryService, true).FileSystemChildren;
2016-05-19 19:57:30 +00:00
}
private bool _requiresRefresh;
public override bool RequiresRefresh()
{
var changed = base.RequiresRefresh() || _requiresRefresh;
if (!changed)
{
2017-08-24 19:52:19 +00:00
var locations = PhysicalLocations;
2016-05-19 19:57:30 +00:00
2017-08-24 19:52:19 +00:00
var newLocations = CreateResolveArgs(new DirectoryService(Logger, FileSystem), false).PhysicalLocations;
2016-05-19 19:57:30 +00:00
if (!locations.SequenceEqual(newLocations))
{
changed = true;
}
}
2016-12-13 07:36:30 +00:00
if (!changed)
{
2017-08-24 19:52:19 +00:00
var folderIds = PhysicalFolderIds;
2016-12-13 07:36:30 +00:00
var newFolderIds = GetPhysicalFolders(false).Select(i => i.Id).ToList();
if (!folderIds.SequenceEqual(newFolderIds))
{
changed = true;
}
}
2016-05-19 19:57:30 +00:00
return changed;
}
public override bool BeforeMetadataRefresh()
{
var changed = base.BeforeMetadataRefresh() || _requiresRefresh;
_requiresRefresh = false;
return changed;
}
2017-06-23 16:04:45 +00:00
public override double? GetRefreshProgress()
{
var folders = GetPhysicalFolders(true).ToList();
double totalProgresses = 0;
var foldersWithProgress = 0;
foreach (var folder in folders)
{
var progress = ProviderManager.GetRefreshProgress(folder.Id);
if (progress.HasValue)
{
totalProgresses += progress.Value;
foldersWithProgress++;
}
}
if (foldersWithProgress == 0)
{
return null;
}
return (totalProgresses / foldersWithProgress);
}
2016-12-13 07:36:30 +00:00
protected override bool RefreshLinkedChildren(IEnumerable<FileSystemMetadata> fileSystemChildren)
2016-12-15 06:41:10 +00:00
{
return RefreshLinkedChildrenInternal(true);
}
private bool RefreshLinkedChildrenInternal(bool setFolders)
2016-12-13 07:36:30 +00:00
{
var physicalFolders = GetPhysicalFolders(false)
.ToList();
var linkedChildren = physicalFolders
.SelectMany(c => c.LinkedChildren)
.ToList();
2017-05-04 18:14:45 +00:00
var changed = !linkedChildren.SequenceEqual(LinkedChildren, new LinkedChildComparer(FileSystem));
2016-12-13 07:36:30 +00:00
2017-08-10 18:01:31 +00:00
LinkedChildren = linkedChildren.ToArray(linkedChildren.Count);
2016-12-13 07:36:30 +00:00
2017-08-24 19:52:19 +00:00
var folderIds = PhysicalFolderIds;
var newFolderIds = physicalFolders.Select(i => i.Id).ToArray();
2016-12-13 07:36:30 +00:00
if (!folderIds.SequenceEqual(newFolderIds))
{
changed = true;
2016-12-15 06:41:10 +00:00
if (setFolders)
{
2017-08-24 19:52:19 +00:00
PhysicalFolderIds = newFolderIds;
2016-12-15 06:41:10 +00:00
}
2016-12-13 07:36:30 +00:00
}
return changed;
}
2014-12-24 06:28:40 +00:00
internal override bool IsValidFromResolver(BaseItem newItem)
{
var newCollectionFolder = newItem as CollectionFolder;
if (newCollectionFolder != null)
{
if (!string.Equals(CollectionType, newCollectionFolder.CollectionType, StringComparison.OrdinalIgnoreCase))
{
return false;
}
}
return base.IsValidFromResolver(newItem);
}
2016-05-19 19:57:30 +00:00
private ItemResolveArgs CreateResolveArgs(IDirectoryService directoryService, bool setPhysicalLocations)
{
var path = ContainingFolderPath;
2015-01-27 22:45:59 +00:00
var args = new ItemResolveArgs(ConfigurationManager.ApplicationPaths, directoryService)
{
2015-10-04 03:38:46 +00:00
FileInfo = FileSystem.GetDirectoryInfo(path),
Path = path,
2017-09-18 16:52:22 +00:00
Parent = GetParent() as Folder,
2014-10-23 04:26:01 +00:00
CollectionType = CollectionType
};
// Gather child folder and files
if (args.IsDirectory)
{
var isPhysicalRoot = args.IsPhysicalRoot;
// When resolving the root, we need it's grandchildren (children of user views)
var flattenFolderDepth = isPhysicalRoot ? 2 : 0;
2017-08-20 19:10:00 +00:00
var files = FileData.GetFilteredFileSystemEntries(directoryService, args.Path, FileSystem, Logger, args, flattenFolderDepth: flattenFolderDepth, resolveShortcuts: isPhysicalRoot || args.IsVf);
// Need to remove subpaths that may have been resolved from shortcuts
// Example: if \\server\movies exists, then strip out \\server\movies\action
if (isPhysicalRoot)
{
2017-08-20 19:10:00 +00:00
files = LibraryManager.NormalizeRootPathList(files).ToArray();
}
2017-08-20 19:10:00 +00:00
args.FileSystemChildren = files;
}
2016-05-19 19:57:30 +00:00
_requiresRefresh = _requiresRefresh || !args.PhysicalLocations.SequenceEqual(PhysicalLocations);
if (setPhysicalLocations)
{
2017-08-24 19:52:19 +00:00
PhysicalLocationsList = args.PhysicalLocations;
2016-05-19 19:57:30 +00:00
}
return args;
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Compare our current children (presumably just read from the repo) with the current state of the file system and adjust for any changes
/// ***Currently does not contain logic to maintain items that are unavailable in the file system***
/// </summary>
/// <param name="progress">The progress.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <param name="recursive">if set to <c>true</c> [recursive].</param>
/// <param name="refreshChildMetadata">if set to <c>true</c> [refresh child metadata].</param>
/// <param name="refreshOptions">The refresh options.</param>
2014-02-10 18:39:41 +00:00
/// <param name="directoryService">The directory service.</param>
2013-02-21 01:33:05 +00:00
/// <returns>Task.</returns>
2015-01-27 06:50:40 +00:00
protected override Task ValidateChildrenInternal(IProgress<double> progress, CancellationToken cancellationToken, bool recursive, bool refreshChildMetadata, MetadataRefreshOptions refreshOptions, IDirectoryService directoryService)
2013-02-21 01:33:05 +00:00
{
2015-01-27 06:50:40 +00:00
return Task.FromResult(true);
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Our children are actually just references to the ones in the physical root...
/// </summary>
2013-02-21 01:33:05 +00:00
/// <value>The actual children.</value>
2016-10-25 19:02:04 +00:00
[IgnoreDataMember]
2017-06-03 07:36:32 +00:00
public override IEnumerable<BaseItem> Children
2013-02-21 01:33:05 +00:00
{
2014-05-14 14:15:33 +00:00
get { return GetActualChildren(); }
}
2017-06-03 07:36:32 +00:00
public IEnumerable<BaseItem> GetActualChildren()
{
2016-12-13 07:36:30 +00:00
return GetPhysicalFolders(true).SelectMany(c => c.Children);
2015-11-14 18:57:26 +00:00
}
2017-06-23 16:04:45 +00:00
public IEnumerable<Folder> GetPhysicalFolders()
{
return GetPhysicalFolders(true);
}
2016-12-13 07:36:30 +00:00
private IEnumerable<Folder> GetPhysicalFolders(bool enableCache)
2015-11-14 18:57:26 +00:00
{
2016-12-13 07:36:30 +00:00
if (enableCache)
{
return PhysicalFolderIds.Select(i => LibraryManager.GetItemById(i)).OfType<Folder>();
}
2016-04-27 17:53:23 +00:00
var rootChildren = LibraryManager.RootFolder.Children
.OfType<Folder>()
2016-04-27 17:53:23 +00:00
.ToList();
2017-05-04 18:14:45 +00:00
return PhysicalLocations.Where(i => !FileSystem.AreEqual(i, Path)).SelectMany(i => GetPhysicalParents(i, rootChildren)).DistinctBy(i => i.Id);
2016-04-27 17:53:23 +00:00
}
private IEnumerable<Folder> GetPhysicalParents(string path, List<Folder> rootChildren)
{
var result = rootChildren
2017-05-04 18:14:45 +00:00
.Where(i => FileSystem.AreEqual(i.Path, path))
2016-04-27 17:53:23 +00:00
.ToList();
if (result.Count == 0)
{
var folder = LibraryManager.FindByPath(path, true) as Folder;
if (folder != null)
{
result.Add(folder);
}
}
return result;
}
2015-06-29 01:10:45 +00:00
2016-10-25 19:02:04 +00:00
[IgnoreDataMember]
2015-06-29 01:10:45 +00:00
public override bool SupportsPeople
{
get
{
return false;
}
}
2013-02-21 01:33:05 +00:00
}
}