Using channel to send responses

fubar-coder · fubar-coder · commit 737c3dca8e4b · 2019-05-09T21:55:30.000+02:00
The WriteAsync functions are now obsolete.
diff --git a/FubarDev.FtpServer.sln.DotSettings b/FubarDev.FtpServer.sln.DotSettings
@@ -40,6 +40,7 @@ Copyright (c) Fubar Development Junker. All rights reserved.&#xD;
 	<s:String x:Key="/Default/CodeStyle/Naming/CppNaming/UserRules/=UNION/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="" Suffix="" Style="aa_bb" /&gt;</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CppNaming/UserRules/=UNION_005FMEMBER/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="" Suffix="" Style="aa_bb" /&gt;</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=IAC/@EntryIndexedValue">IAC</s:String>
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=IO/@EntryIndexedValue">IO</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=IP/@EntryIndexedValue">IP</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=PAM/@EntryIndexedValue">PAM</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/PredefinedNamingRules/=PrivateStaticReadonly/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="_" Suffix="" Style="aaBb" /&gt;</s:String>
@@ -91,4 +92,5 @@ Copyright (c) Fubar Development Junker. All rights reserved.&#xD;
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EMigrateThisQualifierSettings/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=abortable/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Fubar/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=NLST/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=PASV/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>
diff --git a/src/FubarDev.FtpServer.Abstractions/Features/IConnectionFeature.cs b/src/FubarDev.FtpServer.Abstractions/Features/IConnectionFeature.cs
@@ -3,6 +3,8 @@
 // </copyright>
 
 using System.Net;
+using System.Threading.Channels;
+
 using JetBrains.Annotations;
 
 namespace FubarDev.FtpServer.Features
@@ -20,5 +22,10 @@ public interface IConnectionFeature
         /// </summary>
         [NotNull]
         Address RemoteAddress { get; }
+
+        /// <summary>
+        /// Gets the response writer.
+        /// </summary>
+        ChannelWriter<IFtpResponse> ResponseWriter { get; }
     }
 }
diff --git a/src/FubarDev.FtpServer.Abstractions/FtpConnectionData.cs b/src/FubarDev.FtpServer.Abstractions/FtpConnectionData.cs
@@ -271,7 +271,7 @@ private class RestCommandFeature : IRestCommandFeature
         /// </summary>
         private class RenameCommandFeature : IRenameCommandFeature
         {
-            public RenameCommandFeature(SearchResult<IUnixFileSystemEntry> renameFrom)
+            public RenameCommandFeature([NotNull] SearchResult<IUnixFileSystemEntry> renameFrom)
             {
                 RenameFrom = renameFrom;
             }
diff --git a/src/FubarDev.FtpServer.Abstractions/FubarDev.FtpServer.Abstractions.csproj b/src/FubarDev.FtpServer.Abstractions/FubarDev.FtpServer.Abstractions.csproj
@@ -21,6 +21,7 @@
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="NGettext" Version="0.6.3" />
+    <PackageReference Include="System.Threading.Channels" Version="4.5.0" />
   </ItemGroup>
   <Import Project="../../PackageLibrary.props" />
 </Project>
diff --git a/src/FubarDev.FtpServer.Abstractions/IFtpConnection.cs b/src/FubarDev.FtpServer.Abstractions/IFtpConnection.cs
@@ -104,6 +104,8 @@ public interface IFtpConnection : IConnectionFeature, IDisposable
         /// <param name="response">The response to write to the client.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
         /// <returns>The task.</returns>
+        [Obsolete("Use the IConnectionFeature.ResponseWriter instead.")]
+        [NotNull]
         Task WriteAsync([NotNull] IFtpResponse response, CancellationToken cancellationToken);
 
         /// <summary>
@@ -112,12 +114,16 @@ public interface IFtpConnection : IConnectionFeature, IDisposable
         /// <param name="response">The response to write to the client.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
         /// <returns>The task.</returns>
+        [Obsolete("Use the IConnectionFeature.ResponseWriter instead.")]
+        [NotNull]
         Task WriteAsync([NotNull] string response, CancellationToken cancellationToken);
 
         /// <summary>
         /// Creates a response socket for e.g. LIST/NLST.
         /// </summary>
         /// <returns>The data connection.</returns>
+        [NotNull]
+        [ItemNotNull]
         Task<TcpClient> CreateResponseSocket();
 
         /// <summary>
diff --git a/src/FubarDev.FtpServer.Commands/CommandExtensions/SiteBlstCommandExtension.cs b/src/FubarDev.FtpServer.Commands/CommandExtensions/SiteBlstCommandExtension.cs
@@ -96,7 +96,8 @@ private Task<IFtpResponse> SendBlstDirectly()
 
         private async Task<IFtpResponse> SendBlstWithDataConnection(CancellationToken cancellationToken)
         {
-            await Connection.WriteAsync(new FtpResponse(150, T("Opening data connection.")), cancellationToken).ConfigureAwait(false);
+            var connFeature = Connection.Features.Get<IConnectionFeature>();
+            await connFeature.ResponseWriter.WriteAsync(new FtpResponse(150, T("Opening data connection.")), cancellationToken).ConfigureAwait(false);
 
             return await Connection.SendResponseAsync(
                 ExecuteSend,
diff --git a/src/FubarDev.FtpServer.Commands/CommandHandlers/AppeCommandHandler.cs b/src/FubarDev.FtpServer.Commands/CommandHandlers/AppeCommandHandler.cs
@@ -76,7 +76,10 @@ public override async Task<IFtpResponse> Process(FtpCommand command, Cancellatio
                 return new FtpResponse(553, T("File name not allowed."));
             }
 
-            await Connection.WriteAsync(new FtpResponse(150, T("Opening connection for data transfer.")), cancellationToken).ConfigureAwait(false);
+            var connFeature = Connection.Features.Get<IConnectionFeature>();
+            await connFeature.ResponseWriter
+               .WriteAsync(new FtpResponse(150, T("Opening connection for data transfer.")), cancellationToken)
+               .ConfigureAwait(false);
 
             return await Connection
                 .SendResponseAsync(client => ExecuteSend(client, fileInfo, restartPosition, cancellationToken))
diff --git a/src/FubarDev.FtpServer.Commands/CommandHandlers/ListCommandHandler.cs b/src/FubarDev.FtpServer.Commands/CommandHandlers/ListCommandHandler.cs
@@ -59,7 +59,10 @@ public ListCommandHandler(
         /// <inheritdoc/>
         public override async Task<IFtpResponse> Process(FtpCommand command, CancellationToken cancellationToken)
         {
-            await Connection.WriteAsync(new FtpResponse(150, T("Opening data connection.")), cancellationToken).ConfigureAwait(false);
+            var connFeature = Connection.Features.Get<IConnectionFeature>();
+            await connFeature.ResponseWriter
+               .WriteAsync(new FtpResponse(150, T("Opening data connection.")), cancellationToken)
+               .ConfigureAwait(false);
 
             return await Connection.SendResponseAsync(
                     client => ExecuteSend(client, command, cancellationToken),
diff --git a/src/FubarDev.FtpServer.Commands/CommandHandlers/MlstCommandHandler.cs b/src/FubarDev.FtpServer.Commands/CommandHandlers/MlstCommandHandler.cs
@@ -157,7 +157,10 @@ private async Task<IFtpResponse> ProcessMlsdAsync(FtpCommand command, Cancellati
                 }
             }
 
-            await Connection.WriteAsync(new FtpResponse(150, T("Opening data connection.")), cancellationToken).ConfigureAwait(false);
+            var connFeature = Connection.Features.Get<IConnectionFeature>();
+            await connFeature.ResponseWriter
+               .WriteAsync(new FtpResponse(150, T("Opening data connection.")), cancellationToken)
+               .ConfigureAwait(false);
 
             var authInfoFeature = Connection.Features.Get<IAuthorizationInformationFeature>();
             var factsFeature = Connection.Features.Get<IMlstFactsFeature>() ?? CreateMlstFactsFeature();
diff --git a/src/FubarDev.FtpServer.Commands/CommandHandlers/PasvCommandHandler.cs b/src/FubarDev.FtpServer.Commands/CommandHandlers/PasvCommandHandler.cs
@@ -99,18 +99,19 @@ public override async Task<IFtpResponse> Process(FtpCommand command, Cancellatio
                 {
                     var address = listener.PasvEndPoint.Address;
 
+                    var connFeature = Connection.Features.Get<IConnectionFeature>();
                     var localPort = listener.PasvEndPoint.Port;
                     if (isEpsv || address.AddressFamily == AddressFamily.InterNetworkV6)
                     {
                         var listenerAddress = new Address(localPort);
-                        await Connection.WriteAsync(
+                        await connFeature.ResponseWriter.WriteAsync(
                             new FtpResponse(229, T("Entering Extended Passive Mode ({0}).", listenerAddress)),
                             cancellationToken).ConfigureAwait(false);
                     }
                     else
                     {
                         var listenerAddress = new Address(address.ToString(), localPort);
-                        await Connection.WriteAsync(
+                        await connFeature.ResponseWriter.WriteAsync(
                             new FtpResponse(227, T("Entering Passive Mode ({0}).", listenerAddress)),
                             cancellationToken).ConfigureAwait(false);
                     }
diff --git a/src/FubarDev.FtpServer.Commands/CommandHandlers/RetrCommandHandler.cs b/src/FubarDev.FtpServer.Commands/CommandHandlers/RetrCommandHandler.cs
@@ -63,9 +63,12 @@ public override async Task<IFtpResponse> Process(FtpCommand command, Cancellatio
                 return new FtpResponse(550, T("File doesn't exist."));
             }
 
+            var connFeature = Connection.Features.Get<IConnectionFeature>();
             using (var input = await fsFeature.FileSystem.OpenReadAsync(fileInfo.Entry, restartPosition ?? 0, cancellationToken).ConfigureAwait(false))
             {
-                await Connection.WriteAsync(new FtpResponse(150, T("Opening connection for data transfer.")), cancellationToken).ConfigureAwait(false);
+                await connFeature.ResponseWriter
+                   .WriteAsync(new FtpResponse(150, T("Opening connection for data transfer.")), cancellationToken)
+                   .ConfigureAwait(false);
 
                 // ReSharper disable once AccessToDisposedClosure
                 return await Connection.SendResponseAsync(
diff --git a/src/FubarDev.FtpServer.Commands/CommandHandlers/StorCommandHandler.cs b/src/FubarDev.FtpServer.Commands/CommandHandlers/StorCommandHandler.cs
@@ -79,7 +79,10 @@ public override async Task<IFtpResponse> Process(FtpCommand command, Cancellatio
 
             var doReplace = restartPosition.GetValueOrDefault() == 0 && fileInfo.Entry != null;
 
-            await Connection.WriteAsync(new FtpResponse(150, T("Opening connection for data transfer.")), cancellationToken).ConfigureAwait(false);
+            var connFeature = Connection.Features.Get<IConnectionFeature>();
+            await connFeature.ResponseWriter
+               .WriteAsync(new FtpResponse(150, T("Opening connection for data transfer.")), cancellationToken)
+               .ConfigureAwait(false);
 
             return await Connection
                 .SendResponseAsync(
diff --git a/src/FubarDev.FtpServer/Authentication/TlsAuthenticationMechanism.cs b/src/FubarDev.FtpServer/Authentication/TlsAuthenticationMechanism.cs
@@ -94,7 +94,8 @@ await _sslStreamWrapperFactory.CloseStreamAsync(secureConnectionFeature.SocketSt
                     catch (Exception ex)
                     {
                         conn.Log?.LogWarning(0, ex, "SSL stream authentication failed: {0}", ex.Message);
-                        await conn
+                        var connFeature = conn.Features.Get<IConnectionFeature>();
+                        await connFeature.ResponseWriter
                            .WriteAsync(new FtpResponse(421, T("TLS authentication failed")), ct)
                            .ConfigureAwait(false);
                     }
diff --git a/src/FubarDev.FtpServer/FtpConnection.cs b/src/FubarDev.FtpServer/FtpConnection.cs
diff --git a/src/FubarDev.FtpServer/FtpServer.cs b/src/FubarDev.FtpServer/FtpServer.cs

Original file line number	Diff line number	Diff line change
`@@ -271,7 +271,7 @@ private class RestCommandFeature : IRestCommandFeature`
`271`	`271`	`/// </summary>`
`272`	`272`	`private class RenameCommandFeature : IRenameCommandFeature`
`273`	`273`	`{`
`274`		`- public RenameCommandFeature(SearchResult<IUnixFileSystemEntry> renameFrom)`
	`274`	`+ public RenameCommandFeature([NotNull] SearchResult<IUnixFileSystemEntry> renameFrom)`
`275`	`275`	`{`
`276`	`276`	`RenameFrom = renameFrom;`
`277`	`277`	`}`
Original file line number	Diff line number	Diff line change
`@@ -96,7 +96,8 @@ private Task<IFtpResponse> SendBlstDirectly()`
`96`	`96`
`97`	`97`	`private async Task<IFtpResponse> SendBlstWithDataConnection(CancellationToken cancellationToken)`
`98`	`98`	`{`
`99`		`- await Connection.WriteAsync(new FtpResponse(150, T("Opening data connection.")), cancellationToken).ConfigureAwait(false);`
	`99`	`+ var connFeature = Connection.Features.Get<IConnectionFeature>();`
	`100`	`+ await connFeature.ResponseWriter.WriteAsync(new FtpResponse(150, T("Opening data connection.")), cancellationToken).ConfigureAwait(false);`
`100`	`101`
`101`	`102`	`return await Connection.SendResponseAsync(`
`102`	`103`	`ExecuteSend,`
Original file line number	Diff line number	Diff line change
`@@ -157,7 +157,10 @@ private async Task<IFtpResponse> ProcessMlsdAsync(FtpCommand command, Cancellati`
`157`	`157`	`}`
`158`	`158`	`}`
`159`	`159`
`160`		`- await Connection.WriteAsync(new FtpResponse(150, T("Opening data connection.")), cancellationToken).ConfigureAwait(false);`
	`160`	`+ var connFeature = Connection.Features.Get<IConnectionFeature>();`
	`161`	`+ await connFeature.ResponseWriter`
	`162`	`+ .WriteAsync(new FtpResponse(150, T("Opening data connection.")), cancellationToken)`
	`163`	`+ .ConfigureAwait(false);`
`161`	`164`
`162`	`165`	`var authInfoFeature = Connection.Features.Get<IAuthorizationInformationFeature>();`
`163`	`166`	`var factsFeature = Connection.Features.Get<IMlstFactsFeature>() ?? CreateMlstFactsFeature();`
Original file line number	Diff line number	Diff line change
`@@ -99,18 +99,19 @@ public override async Task<IFtpResponse> Process(FtpCommand command, Cancellatio`
`99`	`99`	`{`
`100`	`100`	`var address = listener.PasvEndPoint.Address;`
`101`	`101`
	`102`	`+ var connFeature = Connection.Features.Get<IConnectionFeature>();`
`102`	`103`	`var localPort = listener.PasvEndPoint.Port;`
`103`	`104`	`if (isEpsv \|\| address.AddressFamily == AddressFamily.InterNetworkV6)`
`104`	`105`	`{`
`105`	`106`	`var listenerAddress = new Address(localPort);`
`106`		`- await Connection.WriteAsync(`
	`107`	`+ await connFeature.ResponseWriter.WriteAsync(`
`107`	`108`	`new FtpResponse(229, T("Entering Extended Passive Mode ({0}).", listenerAddress)),`
`108`	`109`	`cancellationToken).ConfigureAwait(false);`
`109`	`110`	`}`
`110`	`111`	`else`
`111`	`112`	`{`
`112`	`113`	`var listenerAddress = new Address(address.ToString(), localPort);`
`113`		`- await Connection.WriteAsync(`
	`114`	`+ await connFeature.ResponseWriter.WriteAsync(`
`114`	`115`	`new FtpResponse(227, T("Entering Passive Mode ({0}).", listenerAddress)),`
`115`	`116`	`cancellationToken).ConfigureAwait(false);`
`116`	`117`	`}`