Janitory work

- Moved lots of stuff into FD.FS.Abstractions
- Reactivated StyleCop.Analyzers
- Added more documentation
- Added more option classes
- ConfigureAwait(false)
- API cleanup (leaner)
- Replaced rda.SocketsForPCL with .NET Core socket API

Author: fubar-coder

.editorconfig

@@ -0,0 +1,56 @@
+root = true
+
+[*]
+end_of_line = CRLF
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.sql]
+insert_final_newline = false
+
+[*.cs]
+indent_size = 4
+charset = utf-8
+csharp_style_var_for_built_in_types = true:suggestion
+csharp_style_var_when_type_is_apparent = true:suggestion
+csharp_style_pattern_matching_over_is_with_cast_check = true:warning
+csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
+csharp_prefer_braces = true:suggestion
+dotnet_sort_system_directives_first = true
+dotnet_separate_import_directive_groups = true
+csharp_new_line_before_open_brace = all
+
+# name all constant fields using PascalCase
+dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols  = constant_fields
+dotnet_naming_rule.constant_fields_should_be_pascal_case.style    = constant_fields_style
+
+dotnet_naming_symbols.constant_fields.applicable_kinds   = field
+dotnet_naming_symbols.constant_fields.required_modifiers = const
+
+dotnet_naming_style.constant_fields_style.capitalization = pascal_case
+
+# static fields should have s_ prefix
+dotnet_naming_rule.static_fields_fields_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.static_fields_fields_should_be_pascal_case.symbols  = static_fields
+dotnet_naming_rule.static_fields_fields_should_be_pascal_case.style    = static_fields_style
+
+dotnet_naming_symbols.static_fields.applicable_kinds   = field
+dotnet_naming_symbols.static_fields.required_modifiers = static
+
+dotnet_naming_style.static_fields_style.capitalization = pascal_case
+
+# internal and private fields should be _camelCase
+dotnet_naming_rule.camel_case_for_private_internal_fields.severity = suggestion
+dotnet_naming_rule.camel_case_for_private_internal_fields.symbols  = private_internal_fields
+dotnet_naming_rule.camel_case_for_private_internal_fields.style    = camel_case_underscore_style
+
+dotnet_naming_symbols.private_internal_fields.applicable_kinds = field
+dotnet_naming_symbols.private_internal_fields.applicable_accessibilities = private, internal
+
+dotnet_naming_style.camel_case_underscore_style.required_prefix = _
+dotnet_naming_style.camel_case_underscore_style.capitalization = camel_case
+
+[*.{csproj,proj,targets}]
+indent_size = 2

FtpServer.ruleset

@@ -1,4 +1,4 @@
-// <copyright file="AnonymousFtpUser.cs" company="Fubar Development Junker">
+// <copyright file="AnonymousFtpUser.cs" company="Fubar Development Junker">
 // Copyright (c) Fubar Development Junker. All rights reserved.
 // </copyright>
 
@@ -12,7 +12,7 @@ namespace FubarDev.FtpServer.AccountManagement
     /// <summary>
     /// An anonymous FTP user
     /// </summary>
-    public class AnonymousFtpUser : FtpUser
+    public class AnonymousFtpUser : IFtpUser
     {
         private readonly HashSet<string> _guestGroups = new HashSet<string>(new[] { "anonymous", "guest" }, StringComparer.OrdinalIgnoreCase);
 
@@ -21,19 +21,21 @@ public class AnonymousFtpUser : FtpUser
         /// </summary>
         /// <param name="email">The anonymous users email address</param>
         public AnonymousFtpUser([CanBeNull] string email)
-            : base("anonymous")
         {
             Email = email;
         }
 
+        /// <inheritdoc />
+        public string Name { get; } = "anonymous";
+
         /// <summary>
         /// Gets the anonymous users email address
         /// </summary>
         [CanBeNull]
         public string Email { get; }
 
         /// <inheritdoc/>
-        public override bool IsInGroup(string groupName)
+        public bool IsInGroup(string groupName)
         {
             return _guestGroups.Contains(groupName);
         }

FubarDev.FtpServer.AccountManagement/Anonymous/BlockAnonymousValidation.cs renamed to FubarDev.FtpServer.Abstractions/AccountManagement/Anonymous/BlockAnonymousValidation.cs

@@ -0,0 +1,27 @@
+// <copyright file="IFtpUser.cs" company="Fubar Development Junker">
+// Copyright (c) Fubar Development Junker. All rights reserved.
+// </copyright>
+
+using JetBrains.Annotations;
+
+namespace FubarDev.FtpServer.AccountManagement
+{
+    /// <summary>
+    /// A basic FTP user interface
+    /// </summary>
+    public interface IFtpUser
+    {
+        /// <summary>
+        /// Gets the name of the user
+        /// </summary>
+        [NotNull]
+        string Name { get; }
+
+        /// <summary>
+        /// Returns <code>true</code> when the user is in the given group.
+        /// </summary>
+        /// <param name="groupName">The name of the group</param>
+        /// <returns><c>true</c> when the user is in the queries <paramref name="groupName"/></returns>
+        bool IsInGroup([NotNull] string groupName);
+    }
+}

FubarDev.FtpServer.AccountManagement/Anonymous/IAnonymousPasswordValidator.cs renamed to FubarDev.FtpServer.Abstractions/AccountManagement/Anonymous/IAnonymousPasswordValidator.cs

@@ -1,4 +1,4 @@
-// <copyright file="MemberValidationResult.cs" company="Fubar Development Junker">
+// <copyright file="MemberValidationResult.cs" company="Fubar Development Junker">
 // Copyright (c) Fubar Development Junker. All rights reserved.
 // </copyright>
 
@@ -11,7 +11,7 @@ namespace FubarDev.FtpServer.AccountManagement
     /// </summary>
     public class MemberValidationResult
     {
-        private readonly FtpUser _user;
+        private readonly IFtpUser _user;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="MemberValidationResult"/> class.
@@ -29,14 +29,12 @@ public MemberValidationResult(MemberValidationStatus status)
         /// </summary>
         /// <param name="status">The success status for the validation</param>
         /// <param name="user">The validated user</param>
-        public MemberValidationResult(MemberValidationStatus status, FtpUser user)
+        public MemberValidationResult(MemberValidationStatus status, IFtpUser user)
         {
-            if (user == null)
-                throw new ArgumentNullException(nameof(user));
             if (status != MemberValidationStatus.Anonymous && status != MemberValidationStatus.AuthenticatedUser)
                 throw new ArgumentOutOfRangeException(nameof(status), "User object must only be specified when validation was successful.");
             Status = status;
-            _user = user;
+            _user = user ?? throw new ArgumentNullException(nameof(user));
         }
 
         /// <summary>
@@ -53,7 +51,7 @@ public MemberValidationStatus Status
         /// <summary>
         /// Gets the authenticated user.
         /// </summary>
-        public FtpUser User
+        public IFtpUser User
         {
             get
             {

FubarDev.FtpServer.AccountManagement/Anonymous/NoTopLevelDomainValidation.cs renamed to FubarDev.FtpServer.Abstractions/AccountManagement/Anonymous/NoTopLevelDomainValidation.cs

@@ -6,10 +6,13 @@
 //-----------------------------------------------------------------------
 
 using System;
+using System.Net.Sockets;
 using System.Text;
 
 using JetBrains.Annotations;
 
+using AF = System.Net.Sockets.AddressFamily;
+
 namespace FubarDev.FtpServer
 {
     /// <summary>
@@ -41,7 +44,7 @@ public Address(AddressFamily addressFamily, string address, int port)
         public Address(string address, int port)
         {
             _isEnhanced = false;
-            AddressFamily = address.IndexOf(':') == -1 ? FubarDev.FtpServer.AddressFamily.IPv4 : FubarDev.FtpServer.AddressFamily.IPv6;
+            AddressFamily = address.IndexOf(':') == -1 ? AF.InterNetwork : AF.InterNetworkV6;
             IpAddress = address;
             IpPort = port;
         }
@@ -97,7 +100,7 @@ public static Address Parse(string address)
         /// <returns>The newly created URI</returns>
         public Uri ToUri()
         {
-            if (AddressFamily != null && AddressFamily == FubarDev.FtpServer.AddressFamily.IPv6)
+            if (AddressFamily != null && AddressFamily == AF.InterNetworkV6)
             {
                 return new Uri($"port://[{IpAddress}]:{IpPort}/");
             }
@@ -113,7 +116,7 @@ public string ToString(bool logFormat)
         {
             if (logFormat)
             {
-                if (AddressFamily != null && AddressFamily == FubarDev.FtpServer.AddressFamily.IPv6)
+                if (AddressFamily != null && AddressFamily == AF.InterNetworkV6)
                 {
                     return $"[{IpAddress}]:{IpPort}";
                 }
@@ -136,10 +139,10 @@ public override string ToString()
                 {
                     switch (AddressFamily)
                     {
-                        case FubarDev.FtpServer.AddressFamily.IPv4:
+                        case AF.InterNetwork:
                             result.Append("1");
                             break;
-                        case FubarDev.FtpServer.AddressFamily.IPv6:
+                        case AF.InterNetworkV6:
                             result.Append("2");
                             break;
                         default:
@@ -203,9 +206,9 @@ private static Address ParseEnhanced(string address)
             switch (addressType)
             {
                 case 1:
-                    return new Address(FubarDev.FtpServer.AddressFamily.IPv4, ipAddress, port);
+                    return new Address(AF.InterNetwork, ipAddress, port);
                 case 2:
-                    return new Address(FubarDev.FtpServer.AddressFamily.IPv6, ipAddress, port);
+                    return new Address(AF.InterNetworkV6, ipAddress, port);
                 default:
                     throw new NotSupportedException($"Unknown network protocol {addressType}");
             }

FubarDev.FtpServer.AccountManagement/Anonymous/NoValidation.cs renamed to FubarDev.FtpServer.Abstractions/AccountManagement/Anonymous/NoValidation.cs

@@ -1,4 +1,4 @@
-//-----------------------------------------------------------------------
+//-----------------------------------------------------------------------
 // <copyright file="FileSystemExtensions.cs" company="Fubar Development Junker">
 //     Copyright (c) Fubar Development Junker. All rights reserved.
 // </copyright>
@@ -97,9 +97,8 @@ public static async Task<IUnixDirectoryEntry> GetDirectoryAsync([NotNull] this I
                     continue;
                 }
 
-                var foundEntry = await fileSystem.GetEntryByNameAsync(currentDir, pathElement, cancellationToken);
-                var foundDirEntry = foundEntry as IUnixDirectoryEntry;
-                if (foundDirEntry == null)
+                var foundEntry = await fileSystem.GetEntryByNameAsync(currentDir, pathElement, cancellationToken).ConfigureAwait(false);
+                if (!(foundEntry is IUnixDirectoryEntry foundDirEntry))
                     return null;
 
                 currentPath.Push(foundDirEntry);
@@ -136,11 +135,11 @@ public static Task<SearchResult<IUnixDirectoryEntry>> SearchDirectoryAsync([NotN
         [ItemCanBeNull]
         public static async Task<SearchResult<IUnixDirectoryEntry>> SearchDirectoryAsync([NotNull] this IUnixFileSystem fileSystem, [NotNull, ItemNotNull] Stack<IUnixDirectoryEntry> currentPath, [NotNull, ItemNotNull] IReadOnlyList<string> pathElements, CancellationToken cancellationToken)
         {
-            var sourceDir = await GetDirectoryAsync(fileSystem, currentPath, new ListSegment<string>(pathElements, 0, pathElements.Count - 1), cancellationToken);
+            var sourceDir = await GetDirectoryAsync(fileSystem, currentPath, new ListSegment<string>(pathElements, 0, pathElements.Count - 1), cancellationToken).ConfigureAwait(false);
             if (sourceDir == null)
                 return null;
             var fileName = pathElements[pathElements.Count - 1];
-            var foundEntry = await fileSystem.GetEntryByNameAsync(sourceDir, fileName, cancellationToken);
+            var foundEntry = await fileSystem.GetEntryByNameAsync(sourceDir, fileName, cancellationToken).ConfigureAwait(false);
             var foundDirEntry = foundEntry as IUnixDirectoryEntry;
             if (foundDirEntry == null && foundEntry != null)
                 return null;
@@ -175,11 +174,11 @@ public static Task<SearchResult<IUnixFileEntry>> SearchFileAsync([NotNull] this
         [ItemCanBeNull]
         public static async Task<SearchResult<IUnixFileEntry>> SearchFileAsync(this IUnixFileSystem fileSystem, [NotNull, ItemNotNull] Stack<IUnixDirectoryEntry> currentPath, [NotNull, ItemNotNull] IReadOnlyList<string> pathElements, CancellationToken cancellationToken)
         {
-            var sourceDir = await GetDirectoryAsync(fileSystem, currentPath, new ListSegment<string>(pathElements, 0, pathElements.Count - 1), cancellationToken);
+            var sourceDir = await GetDirectoryAsync(fileSystem, currentPath, new ListSegment<string>(pathElements, 0, pathElements.Count - 1), cancellationToken).ConfigureAwait(false);
             if (sourceDir == null)
                 return null;
             var fileName = pathElements[pathElements.Count - 1];
-            var foundEntry = await fileSystem.GetEntryByNameAsync(sourceDir, fileName, cancellationToken);
+            var foundEntry = await fileSystem.GetEntryByNameAsync(sourceDir, fileName, cancellationToken).ConfigureAwait(false);
             var foundFileEntry = foundEntry as IUnixFileEntry;
             if (foundEntry != null && foundFileEntry == null)
                 return null;
@@ -214,7 +213,7 @@ public static Task<SearchResult<IUnixFileSystemEntry>> SearchEntryAsync([NotNull
         [ItemCanBeNull]
         public static async Task<SearchResult<IUnixFileSystemEntry>> SearchEntryAsync(this IUnixFileSystem fileSystem, [NotNull, ItemNotNull] Stack<IUnixDirectoryEntry> currentPath, [NotNull, ItemNotNull] IReadOnlyList<string> pathElements, CancellationToken cancellationToken)
         {
-            var sourceDir = await GetDirectoryAsync(fileSystem, currentPath, new ListSegment<string>(pathElements, 0, pathElements.Count - 1), cancellationToken);
+            var sourceDir = await GetDirectoryAsync(fileSystem, currentPath, new ListSegment<string>(pathElements, 0, pathElements.Count - 1), cancellationToken).ConfigureAwait(false);
             if (sourceDir == null)
                 return null;
             IUnixFileSystemEntry foundEntry;
@@ -253,7 +252,7 @@ public static async Task<SearchResult<IUnixFileSystemEntry>> SearchEntryAsync(th
                     }
                     break;
                 default:
-                    foundEntry = await fileSystem.GetEntryByNameAsync(sourceDir, fileName, cancellationToken);
+                    foundEntry = await fileSystem.GetEntryByNameAsync(sourceDir, fileName, cancellationToken).ConfigureAwait(false);
                     break;
             }
             return new SearchResult<IUnixFileSystemEntry>(sourceDir, foundEntry, fileName);
@@ -373,7 +372,7 @@ public static IReadOnlyList<string> SplitPath([CanBeNull] string path)
                 return parts;
             var isEscaped = false;
             var partCollector = new StringBuilder();
-            foreach (var ch in path.ToCharArray())
+            foreach (var ch in path)
             {
                 if (!isEscaped)
                 {

FubarDev.FtpServer.AccountManagement/Anonymous/SimpleMailAddressValidation.cs renamed to FubarDev.FtpServer.Abstractions/AccountManagement/Anonymous/SimpleMailAddressValidation.cs

@@ -1,4 +1,4 @@
-//-----------------------------------------------------------------------
+//-----------------------------------------------------------------------
 // <copyright file="MemoryTemporaryData.cs" company="Fubar Development Junker">
 //     Copyright (c) Fubar Development Junker. All rights reserved.
 // </copyright>
@@ -31,7 +31,7 @@ public async Task FillAsync(Stream stream, CancellationToken cancellationToken)
         {
             _data?.Dispose();
             _data = new MemoryStream();
-            await stream.CopyToAsync(_data, 4096, cancellationToken);
+            await stream.CopyToAsync(_data, 4096, cancellationToken).ConfigureAwait(false);
         }
 
         /// <inheritdoc/>