Merge branch 'master' into studios-images-plugin

# Conflicts:
#	MediaBrowser.Providers/MediaBrowser.Providers.csproj

1 files changed, 73 insertions, 39 deletions

diff --git a/MediaBrowser.Controller/Library/ItemResolveArgs.cs b/MediaBrowser.Controller/Library/ItemResolveArgs.cs
index 12a311dc33..91d162b411 100644
--- a/MediaBrowser.Controller/Library/ItemResolveArgs.cs
+++ b/MediaBrowser.Controller/Library/ItemResolveArgs.cs
@@ -1,4 +1,6 @@
-#pragma warning disable CS1591
+#nullable disable
+
+#pragma warning disable CA1721, CA1819, CS1591
 
 using System;
 using System.Collections.Generic;
@@ -14,14 +16,14 @@ namespace MediaBrowser.Controller.Library
     /// These are arguments relating to the file system that are collected once and then referred to
     /// whenever needed.  Primarily for entity resolution.
     /// </summary>
-    public class ItemResolveArgs : EventArgs
+    public class ItemResolveArgs
     {
         /// <summary>
         /// The _app paths.
         /// </summary>
         private readonly IServerApplicationPaths _appPaths;
 
-        public IDirectoryService DirectoryService { get; private set; }
+        private LibraryOptions _libraryOptions;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="ItemResolveArgs" /> class.
@@ -34,17 +36,19 @@ namespace MediaBrowser.Controller.Library
             DirectoryService = directoryService;
         }
 
+        // TODO remove dependencies as properties, they should be injected where it makes sense
+        public IDirectoryService DirectoryService { get; }
+
         /// <summary>
-        /// Gets the file system children.
+        /// Gets or sets the file system children.
         /// </summary>
         /// <value>The file system children.</value>
         public FileSystemMetadata[] FileSystemChildren { get; set; }
 
-        public LibraryOptions LibraryOptions { get; set; }
-
-        public LibraryOptions GetLibraryOptions()
+        public LibraryOptions LibraryOptions
         {
-            return LibraryOptions ?? (LibraryOptions = Parent == null ? new LibraryOptions() : BaseItem.LibraryManager.GetLibraryOptions(Parent));
+            get => _libraryOptions ??= Parent == null ? new LibraryOptions() : BaseItem.LibraryManager.GetLibraryOptions(Parent);
+            set => _libraryOptions = value;
         }
 
         /// <summary>
@@ -60,10 +64,10 @@ namespace MediaBrowser.Controller.Library
         public FileSystemMetadata FileInfo { get; set; }
 
         /// <summary>
-        /// Gets or sets the path.
+        /// Gets the path.
         /// </summary>
         /// <value>The path.</value>
-        public string Path { get; set; }
+        public string Path => FileInfo.FullName;
 
         /// <summary>
         /// Gets a value indicating whether this instance is directory.
@@ -106,6 +110,21 @@ namespace MediaBrowser.Controller.Library
         /// <value>The additional locations.</value>
         private List<string> AdditionalLocations { get; set; }
 
+        /// <summary>
+        /// Gets the physical locations.
+        /// </summary>
+        /// <value>The physical locations.</value>
+        public string[] PhysicalLocations
+        {
+            get
+            {
+                var paths = string.IsNullOrEmpty(Path) ? Array.Empty<string>() : new[] { Path };
+                return AdditionalLocations == null ? paths : paths.Concat(AdditionalLocations).ToArray();
+            }
+        }
+
+        public string CollectionType { get; set; }
+
         public bool HasParent<T>()
             where T : Folder
         {
@@ -136,10 +155,20 @@ namespace MediaBrowser.Controller.Library
         }
 
         /// <summary>
+        /// Determines whether the specified <see cref="object" /> is equal to this instance.
+        /// </summary>
+        /// <param name="obj">The object to compare with the current object.</param>
+        /// <returns><c>true</c> if the specified <see cref="object" /> is equal to this instance; otherwise, <c>false</c>.</returns>
+        public override bool Equals(object obj)
+        {
+            return Equals(obj as ItemResolveArgs);
+        }
+
+        /// <summary>
         /// Adds the additional location.
         /// </summary>
         /// <param name="path">The path.</param>
-        /// <exception cref="ArgumentNullException"></exception>
+        /// <exception cref="ArgumentNullException"><paramref name="path"/> is <c>null</c> or empty.</exception>
         public void AddAdditionalLocation(string path)
         {
             if (string.IsNullOrEmpty(path))
@@ -147,35 +176,18 @@ namespace MediaBrowser.Controller.Library
                 throw new ArgumentException("The path was empty or null.", nameof(path));
             }
 
-            if (AdditionalLocations == null)
-            {
-                AdditionalLocations = new List<string>();
-            }
-
+            AdditionalLocations ??= new List<string>();
             AdditionalLocations.Add(path);
         }
 
         // REVIEW: @bond
 
         /// <summary>
-        /// Gets the physical locations.
-        /// </summary>
-        /// <value>The physical locations.</value>
-        public string[] PhysicalLocations
-        {
-            get
-            {
-                var paths = string.IsNullOrEmpty(Path) ? Array.Empty<string>() : new[] { Path };
-                return AdditionalLocations == null ? paths : paths.Concat(AdditionalLocations).ToArray();
-            }
-        }
-
-        /// <summary>
         /// Gets the name of the file system entry by.
         /// </summary>
         /// <param name="name">The name.</param>
         /// <returns>FileSystemInfo.</returns>
-        /// <exception cref="ArgumentNullException"></exception>
+        /// <exception cref="ArgumentNullException"><paramref name="name"/> is <c>null</c> or empty.</exception>
         public FileSystemMetadata GetFileSystemEntryByName(string name)
         {
             if (string.IsNullOrEmpty(name))
@@ -191,7 +203,7 @@ namespace MediaBrowser.Controller.Library
         /// </summary>
         /// <param name="path">The path.</param>
         /// <returns>FileSystemInfo.</returns>
-        /// <exception cref="ArgumentNullException"></exception>
+        /// <exception cref="ArgumentNullException">Throws if path is invalid.</exception>
         public FileSystemMetadata GetFileSystemEntryByPath(string path)
         {
             if (string.IsNullOrEmpty(path))
@@ -225,16 +237,38 @@ namespace MediaBrowser.Controller.Library
             return CollectionType;
         }
 
-        public string CollectionType { get; set; }
+        /// <summary>
+        /// Gets the configured content type for the path.
+        /// </summary>
+        /// <remarks>
+        /// This is subject to future refactoring as it relies on a static property in BaseItem.
+        /// </remarks>
+        /// <returns>The configured content type.</returns>
+        public string GetConfiguredContentType()
+        {
+            return BaseItem.LibraryManager.GetConfiguredContentType(Path);
+        }
 
         /// <summary>
-        /// Determines whether the specified <see cref="object" /> is equal to this instance.
+        /// Gets the file system children that do not hit the ignore file check.
         /// </summary>
-        /// <param name="obj">The object to compare with the current object.</param>
-        /// <returns><c>true</c> if the specified <see cref="object" /> is equal to this instance; otherwise, <c>false</c>.</returns>
-        public override bool Equals(object obj)
+        /// <remarks>
+        /// This is subject to future refactoring as it relies on a static property in BaseItem.
+        /// </remarks>
+        /// <returns>The file system children that are not ignored.</returns>
+        public IEnumerable<FileSystemMetadata> GetActualFileSystemChildren()
         {
-            return Equals(obj as ItemResolveArgs);
+            var numberOfChildren = FileSystemChildren.Length;
+            for (var i = 0; i < numberOfChildren; i++)
+            {
+                var child = FileSystemChildren[i];
+                if (BaseItem.LibraryManager.IgnoreFile(child, Parent))
+                {
+                    continue;
+                }
+
+                yield return child;
+            }
         }
 
         /// <summary>
@@ -243,14 +277,14 @@ namespace MediaBrowser.Controller.Library
         /// <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
         public override int GetHashCode()
         {
-            return Path.GetHashCode();
+            return Path.GetHashCode(StringComparison.Ordinal);
         }
 
         /// <summary>
         /// Equals the specified args.
         /// </summary>
         /// <param name="args">The args.</param>
-        /// <returns><c>true</c> if XXXX, <c>false</c> otherwise</returns>
+        /// <returns><c>true</c> if the arguments are the same, <c>false</c> otherwise.</returns>
         protected bool Equals(ItemResolveArgs args)
         {
             if (args != null)