-
-
Notifications
You must be signed in to change notification settings - Fork 650
/
FtpClient_LowLevel.cs
1494 lines (1283 loc) · 57.2 KB
/
FtpClient_LowLevel.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
using System;
using System.IO;
using System.Net.Sockets;
using System.Text;
using System.Text.RegularExpressions;
using System.Reflection;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Security.Cryptography.X509Certificates;
using System.Globalization;
using System.Security.Authentication;
using System.Net;
using FluentFTP.Proxy;
#if !CORE
using System.Web;
#endif
#if (CORE || NETFX)
using System.Threading;
#endif
#if ASYNC
using System.Threading.Tasks;
#endif
namespace FluentFTP {
/// <summary>
/// FTP Control Connection. Speaks the FTP protocol with the server and
/// provides facilities for performing transactions.
///
/// Debugging problems with FTP transactions is much easier to do when
/// you can see exactly what is sent to the server and the reply
/// FluentFTP gets in return. Please review the Debug example
/// below for information on how to add <see cref="System.Diagnostics.TraceListener"/>s for capturing
/// the conversation between FluentFTP and the server.
/// </summary>
/// <example>The following example illustrates how to assist in debugging
/// FluentFTP by getting a transaction log from the server.
/// <code source="..\Examples\Debug.cs" lang="cs" />
/// </example>
/// <example>The following example demonstrates adding a custom file
/// listing parser in the event that you encounter a list format
/// not already supported.
/// <code source="..\Examples\CustomParser.cs" lang="cs" />
/// </example>
/// <example>The following example demonstrates how to validate
/// a SSL certificate when using SSL/TLS.
/// <code source="..\Examples\ValidateCertificate.cs" lang="cs" />
/// </example>
/// <example>The following example demonstrates how to download a file.
/// <code source="..\Examples\OpenRead.cs" lang="cs" />
/// </example>
/// <example>The following example demonstrates how to download a file
/// using a URI object.
/// <code source="..\Examples\OpenReadURI.cs" lang="cs" />
/// </example>
/// <example>The following example demonstrates how to upload a file.
/// <code source="..\Examples\OpenWrite.cs" lang="cs" />
/// </example>
/// <example>The following example demonstrates how to upload a file
/// using a URI object.
/// <code source="..\Examples\OpenWriteURI.cs" lang="cs" />
/// </example>
/// <example>The following example demonstrates how to append to a file.
/// <code source="..\Examples\OpenAppend.cs" lang="cs" />
/// </example>
/// <example>The following example demonstrates how to append to a file
/// using a URI object.
/// <code source="..\Examples\OpenAppendURI.cs" lang="cs" />
/// </example>
/// <example>The following example demonstrates how to get a file
/// listing from the server.
/// <code source="..\Examples\GetListing.cs" lang="cs" />
/// </example>
public partial class FtpClient : IDisposable {
#region Active/Passive Streams
/// <summary>
/// Opens the specified type of passive data stream
/// </summary>
/// <param name="type">Type of passive data stream to open</param>
/// <param name="command">The command to execute that requires a data stream</param>
/// <param name="restart">Restart location in bytes for file transfer</param>
/// <returns>A data stream ready to be used</returns>
FtpDataStream OpenPassiveDataStream(FtpDataConnectionType type, string command, long restart) {
FtpTrace.WriteFunc("OpenPassiveDataStream", new object[] { type, command, restart });
FtpDataStream stream = null;
FtpReply reply;
Match m;
string host = null;
int port = 0;
if (m_stream == null)
throw new InvalidOperationException("The control connection stream is null! Generally this means there is no connection to the server. Cannot open a passive data stream.");
if (type == FtpDataConnectionType.EPSV || type == FtpDataConnectionType.AutoPassive) {
if (!(reply = Execute("EPSV")).Success) {
// if we're connected with IPv4 and data channel type is AutoPassive then fallback to IPv4
if (reply.Type == FtpResponseType.PermanentNegativeCompletion && type == FtpDataConnectionType.AutoPassive && m_stream != null && m_stream.LocalEndPoint.AddressFamily == System.Net.Sockets.AddressFamily.InterNetwork)
return OpenPassiveDataStream(FtpDataConnectionType.PASV, command, restart);
throw new FtpCommandException(reply);
}
m = Regex.Match(reply.Message, @"\(\|\|\|(?<port>\d+)\|\)");
if (!m.Success) {
throw new FtpException("Failed to get the EPSV port from: " + reply.Message);
}
host = m_host;
port = int.Parse(m.Groups["port"].Value);
} else {
if (m_stream.LocalEndPoint.AddressFamily != System.Net.Sockets.AddressFamily.InterNetwork)
throw new FtpException("Only IPv4 is supported by the PASV command. Use EPSV instead.");
if (!(reply = Execute("PASV")).Success)
throw new FtpCommandException(reply);
m = Regex.Match(reply.Message, @"(?<quad1>\d+)," + @"(?<quad2>\d+)," + @"(?<quad3>\d+)," + @"(?<quad4>\d+)," + @"(?<port1>\d+)," + @"(?<port2>\d+)");
if (!m.Success || m.Groups.Count != 7)
throw new FtpException(("Malformed PASV response: " + reply.Message));
// PASVEX mode ignores the host supplied in the PASV response
if (type == FtpDataConnectionType.PASVEX)
host = m_host;
else
host = (m.Groups["quad1"].Value + "." + m.Groups["quad2"].Value + "." + m.Groups["quad3"].Value + "." + m.Groups["quad4"].Value);
port = (int.Parse(m.Groups["port1"].Value) << 8) + int.Parse(m.Groups["port2"].Value);
}
stream = new FtpDataStream(this);
stream.ConnectTimeout = DataConnectionConnectTimeout;
stream.ReadTimeout = DataConnectionReadTimeout;
Connect(stream, host, port, InternetProtocolVersions);
stream.SetSocketOption(System.Net.Sockets.SocketOptionLevel.Socket, System.Net.Sockets.SocketOptionName.KeepAlive, m_keepAlive);
if (restart > 0) {
if (!(reply = Execute("REST " + restart)).Success)
throw new FtpCommandException(reply);
}
if (!(reply = Execute(command)).Success) {
stream.Close();
if(command.StartsWith("NLST ") && reply.Code=="550" && reply.Message== "No files found.") {
//workaround for ftpd which responses "550 No files found." when folder exists but is empty
}
else {
throw new FtpCommandException(reply);
}
}
// the command status is used to determine
// if a reply needs to be read from the server
// when the stream is closed so always set it
// otherwise things can get out of sync.
stream.CommandStatus = reply;
#if !NO_SSL
// this needs to take place after the command is executed
if (m_dataConnectionEncryption && m_encryptionmode != FtpEncryptionMode.None) {
stream.ActivateEncryption(m_host,
this.ClientCertificates.Count > 0 ? this.ClientCertificates : null,
m_SslProtocols);
}
#endif
return stream;
}
#if ASYNC
/// <summary>
/// Opens the specified type of passive data stream
/// </summary>
/// <param name="type">Type of passive data stream to open</param>
/// <param name="command">The command to execute that requires a data stream</param>
/// <param name="restart">Restart location in bytes for file transfer</param>
/// <returns>A data stream ready to be used</returns>
async Task<FtpDataStream> OpenPassiveDataStreamAsync(FtpDataConnectionType type, string command, long restart)
{
FtpTrace.WriteFunc(nameof(OpenPassiveDataStreamAsync), new object[] { type, command, restart });
FtpDataStream stream = null;
FtpReply reply;
Match m;
string host = null;
int port = 0;
if (m_stream == null)
throw new InvalidOperationException("The control connection stream is null! Generally this means there is no connection to the server. Cannot open a passive data stream.");
if (type == FtpDataConnectionType.EPSV || type == FtpDataConnectionType.AutoPassive)
{
if (!(reply = await ExecuteAsync("EPSV")).Success)
{
// if we're connected with IPv4 and data channel type is AutoPassive then fallback to IPv4
if (reply.Type == FtpResponseType.PermanentNegativeCompletion && type == FtpDataConnectionType.AutoPassive && m_stream != null && m_stream.LocalEndPoint.AddressFamily == System.Net.Sockets.AddressFamily.InterNetwork)
return await OpenPassiveDataStreamAsync(FtpDataConnectionType.PASV, command, restart);
throw new FtpCommandException(reply);
}
m = Regex.Match(reply.Message, @"\(\|\|\|(?<port>\d+)\|\)");
if (!m.Success)
{
throw new FtpException("Failed to get the EPSV port from: " + reply.Message);
}
host = m_host;
port = int.Parse(m.Groups["port"].Value);
}
else
{
if (m_stream.LocalEndPoint.AddressFamily != System.Net.Sockets.AddressFamily.InterNetwork)
throw new FtpException("Only IPv4 is supported by the PASV command. Use EPSV instead.");
if (!(reply = await ExecuteAsync("PASV")).Success)
throw new FtpCommandException(reply);
m = Regex.Match(reply.Message, @"(?<quad1>\d+)," + @"(?<quad2>\d+)," + @"(?<quad3>\d+)," + @"(?<quad4>\d+)," + @"(?<port1>\d+)," + @"(?<port2>\d+)");
if (!m.Success || m.Groups.Count != 7)
throw new FtpException(("Malformed PASV response: " + reply.Message));
// PASVEX mode ignores the host supplied in the PASV response
if (type == FtpDataConnectionType.PASVEX)
host = m_host;
else
host = (m.Groups["quad1"].Value + "." + m.Groups["quad2"].Value + "." + m.Groups["quad3"].Value + "." + m.Groups["quad4"].Value);
port = (int.Parse(m.Groups["port1"].Value) << 8) + int.Parse(m.Groups["port2"].Value);
}
stream = new FtpDataStream(this);
stream.ConnectTimeout = DataConnectionConnectTimeout;
stream.ReadTimeout = DataConnectionReadTimeout;
await ConnectAsync(stream, host, port, InternetProtocolVersions);
stream.SetSocketOption(System.Net.Sockets.SocketOptionLevel.Socket, System.Net.Sockets.SocketOptionName.KeepAlive, m_keepAlive);
if (restart > 0)
{
if (!(reply = await ExecuteAsync("REST " + restart)).Success)
throw new FtpCommandException(reply);
}
if (!(reply = await ExecuteAsync(command)).Success)
{
stream.Close();
throw new FtpCommandException(reply);
}
// the command status is used to determine
// if a reply needs to be read from the server
// when the stream is closed so always set it
// otherwise things can get out of sync.
stream.CommandStatus = reply;
#if !NO_SSL
// this needs to take place after the command is executed
if (m_dataConnectionEncryption && m_encryptionmode != FtpEncryptionMode.None)
{
await stream.ActivateEncryptionAsync(m_host,
this.ClientCertificates.Count > 0 ? this.ClientCertificates : null,
m_SslProtocols);
}
#endif
return stream;
}
#endif
/// <summary>
/// Returns the ip address to be sent to the server for the active connection
/// </summary>
/// <param name="ip"></param>
/// <returns></returns>
string GetLocalAddress(IPAddress ip) {
// Use resolver
if (m_AddressResolver != null) {
return m_Address ?? (m_Address = m_AddressResolver());
}
// Use supplied ip
return ip.ToString();
}
/// <summary>
/// Opens the specified type of active data stream
/// </summary>
/// <param name="type">Type of passive data stream to open</param>
/// <param name="command">The command to execute that requires a data stream</param>
/// <param name="restart">Restart location in bytes for file transfer</param>
/// <returns>A data stream ready to be used</returns>
FtpDataStream OpenActiveDataStream(FtpDataConnectionType type, string command, long restart) {
FtpTrace.WriteFunc("OpenActiveDataStream", new object[] { type, command, restart });
FtpDataStream stream = new FtpDataStream(this);
FtpReply reply;
#if !CORE
IAsyncResult ar;
#endif
if (m_stream == null)
throw new InvalidOperationException("The control connection stream is null! Generally this means there is no connection to the server. Cannot open an active data stream.");
if (m_ActivePorts == null || !m_ActivePorts.Any()) {
// Use random port
stream.Listen(m_stream.LocalEndPoint.Address, 0);
} else {
var success = false;
// Use one of the specified ports
foreach (var port in m_ActivePorts) {
try {
stream.Listen(m_stream.LocalEndPoint.Address, port);
success = true;
break;
} catch (SocketException se) {
#if NETFX
// Already in use
if (se.ErrorCode != 10048)
throw;
#else
throw;
#endif
}
}
// No usable port found
if (!success)
throw new Exception("No valid active data port available!");
}
#if !CORE
ar = stream.BeginAccept(null, null);
#endif
if (type == FtpDataConnectionType.EPRT || type == FtpDataConnectionType.AutoActive) {
int ipver = 0;
switch (stream.LocalEndPoint.AddressFamily) {
case System.Net.Sockets.AddressFamily.InterNetwork:
ipver = 1; // IPv4
break;
case System.Net.Sockets.AddressFamily.InterNetworkV6:
ipver = 2; // IPv6
break;
default:
throw new InvalidOperationException("The IP protocol being used is not supported.");
}
if (!(reply = Execute("EPRT |" + ipver + "|" + GetLocalAddress(stream.LocalEndPoint.Address) + "|" + stream.LocalEndPoint.Port + "|")).Success) {
// if we're connected with IPv4 and the data channel type is AutoActive then try to fall back to the PORT command
if (reply.Type == FtpResponseType.PermanentNegativeCompletion && type == FtpDataConnectionType.AutoActive && m_stream != null && m_stream.LocalEndPoint.AddressFamily == System.Net.Sockets.AddressFamily.InterNetwork) {
stream.ControlConnection = null; // we don't want this failed EPRT attempt to close our control connection when the stream is closed so clear out the reference.
stream.Close();
return OpenActiveDataStream(FtpDataConnectionType.PORT, command, restart);
} else {
stream.Close();
throw new FtpCommandException(reply);
}
}
} else {
if (m_stream.LocalEndPoint.AddressFamily != System.Net.Sockets.AddressFamily.InterNetwork)
throw new FtpException("Only IPv4 is supported by the PORT command. Use EPRT instead.");
if (!(reply = Execute("PORT " +
GetLocalAddress(stream.LocalEndPoint.Address).Replace('.', ',') + "," +
stream.LocalEndPoint.Port / 256 + "," +
stream.LocalEndPoint.Port % 256)).Success) {
stream.Close();
throw new FtpCommandException(reply);
}
}
if (restart > 0) {
if (!(reply = Execute("REST " + restart)).Success)
throw new FtpCommandException(reply);
}
if (!(reply = Execute(command)).Success) {
stream.Close();
throw new FtpCommandException(reply);
}
// the command status is used to determine
// if a reply needs to be read from the server
// when the stream is closed so always set it
// otherwise things can get out of sync.
stream.CommandStatus = reply;
#if CORE
stream.AcceptAsync().Wait();
#else
ar.AsyncWaitHandle.WaitOne(m_dataConnectionConnectTimeout);
if (!ar.IsCompleted) {
stream.Close();
throw new TimeoutException("Timed out waiting for the server to connect to the active data socket.");
}
stream.EndAccept(ar);
#endif
#if !NO_SSL
if (m_dataConnectionEncryption && m_encryptionmode != FtpEncryptionMode.None) {
stream.ActivateEncryption(m_host,
this.ClientCertificates.Count > 0 ? this.ClientCertificates : null,
m_SslProtocols);
}
#endif
stream.SetSocketOption(System.Net.Sockets.SocketOptionLevel.Socket, System.Net.Sockets.SocketOptionName.KeepAlive, m_keepAlive);
stream.ReadTimeout = m_dataConnectionReadTimeout;
return stream;
}
#if ASYNC
/// <summary>
/// Opens the specified type of active data stream
/// </summary>
/// <param name="type">Type of passive data stream to open</param>
/// <param name="command">The command to execute that requires a data stream</param>
/// <param name="restart">Restart location in bytes for file transfer</param>
/// <returns>A data stream ready to be used</returns>
async Task<FtpDataStream> OpenActiveDataStreamAsync(FtpDataConnectionType type, string command, long restart)
{
FtpTrace.WriteFunc(nameof(OpenActiveDataStreamAsync), new object[] { type, command, restart });
FtpDataStream stream = new FtpDataStream(this);
FtpReply reply;
if (m_stream == null)
throw new InvalidOperationException("The control connection stream is null! Generally this means there is no connection to the server. Cannot open an active data stream.");
if (m_ActivePorts == null || !m_ActivePorts.Any())
{
// Use random port
stream.Listen(m_stream.LocalEndPoint.Address, 0);
}
else
{
var success = false;
// Use one of the specified ports
foreach (var port in m_ActivePorts)
{
try
{
stream.Listen(m_stream.LocalEndPoint.Address, port);
success = true;
break;
}
catch (SocketException se)
{
#if NETFX
// Already in use
if (se.ErrorCode != 10048)
throw;
#else
throw;
#endif
}
}
// No usable port found
if (!success)
throw new Exception("No valid active data port available!");
}
var result = stream.AcceptAsync();
if (type == FtpDataConnectionType.EPRT || type == FtpDataConnectionType.AutoActive)
{
int ipver = 0;
switch (stream.LocalEndPoint.AddressFamily)
{
case System.Net.Sockets.AddressFamily.InterNetwork:
ipver = 1; // IPv4
break;
case System.Net.Sockets.AddressFamily.InterNetworkV6:
ipver = 2; // IPv6
break;
default:
throw new InvalidOperationException("The IP protocol being used is not supported.");
}
if (!(reply = await ExecuteAsync("EPRT |" + ipver + "|" + GetLocalAddress(stream.LocalEndPoint.Address) + "|" + stream.LocalEndPoint.Port + "|")).Success)
{
// if we're connected with IPv4 and the data channel type is AutoActive then try to fall back to the PORT command
if (reply.Type == FtpResponseType.PermanentNegativeCompletion && type == FtpDataConnectionType.AutoActive && m_stream != null && m_stream.LocalEndPoint.AddressFamily == System.Net.Sockets.AddressFamily.InterNetwork)
{
stream.ControlConnection = null; // we don't want this failed EPRT attempt to close our control connection when the stream is closed so clear out the reference.
stream.Close();
return await OpenActiveDataStreamAsync(FtpDataConnectionType.PORT, command, restart);
}
else
{
stream.Close();
throw new FtpCommandException(reply);
}
}
}
else
{
if (m_stream.LocalEndPoint.AddressFamily != System.Net.Sockets.AddressFamily.InterNetwork)
throw new FtpException("Only IPv4 is supported by the PORT command. Use EPRT instead.");
if (!(reply = await ExecuteAsync("PORT " +
GetLocalAddress(stream.LocalEndPoint.Address).Replace('.', ',') + "," +
stream.LocalEndPoint.Port / 256 + "," +
stream.LocalEndPoint.Port % 256)).Success)
{
stream.Close();
throw new FtpCommandException(reply);
}
}
if (restart > 0)
{
if (!(reply = await ExecuteAsync("REST " + restart)).Success)
throw new FtpCommandException(reply);
}
if (!(reply = await ExecuteAsync(command)).Success)
{
stream.Close();
throw new FtpCommandException(reply);
}
// the command status is used to determine
// if a reply needs to be read from the server
// when the stream is closed so always set it
// otherwise things can get out of sync.
stream.CommandStatus = reply;
await result;
#if !NO_SSL
if (m_dataConnectionEncryption && m_encryptionmode != FtpEncryptionMode.None)
{
await stream.ActivateEncryptionAsync(m_host,
this.ClientCertificates.Count > 0 ? this.ClientCertificates : null,
m_SslProtocols);
}
#endif
stream.SetSocketOption(System.Net.Sockets.SocketOptionLevel.Socket, System.Net.Sockets.SocketOptionName.KeepAlive, m_keepAlive);
stream.ReadTimeout = m_dataConnectionReadTimeout;
return stream;
}
#endif
/// <summary>
/// Opens a data stream.
/// </summary>
/// <param name='command'>The command to execute that requires a data stream</param>
/// <param name="restart">Restart location in bytes for file transfer</param>
/// <returns>The data stream.</returns>
FtpDataStream OpenDataStream(string command, long restart) {
FtpDataConnectionType type = m_dataConnectionType;
FtpDataStream stream = null;
#if !CORE14
lock (m_lock) {
#endif
if (!IsConnected)
Connect();
// The PORT and PASV commands do not work with IPv6 so
// if either one of those types are set change them
// to EPSV or EPRT appropriately.
if (m_stream.LocalEndPoint.AddressFamily == System.Net.Sockets.AddressFamily.InterNetworkV6) {
switch (type) {
case FtpDataConnectionType.PORT:
type = FtpDataConnectionType.EPRT;
FtpTrace.WriteLine(FtpTraceLevel.Info, "Changed data connection type to EPRT because we are connected with IPv6.");
break;
case FtpDataConnectionType.PASV:
case FtpDataConnectionType.PASVEX:
type = FtpDataConnectionType.EPSV;
FtpTrace.WriteLine(FtpTraceLevel.Info, "Changed data connection type to EPSV because we are connected with IPv6.");
break;
}
}
switch (type) {
case FtpDataConnectionType.AutoPassive:
case FtpDataConnectionType.EPSV:
case FtpDataConnectionType.PASV:
case FtpDataConnectionType.PASVEX:
stream = OpenPassiveDataStream(type, command, restart);
break;
case FtpDataConnectionType.AutoActive:
case FtpDataConnectionType.EPRT:
case FtpDataConnectionType.PORT:
stream = OpenActiveDataStream(type, command, restart);
break;
}
if (stream == null)
throw new InvalidOperationException("The specified data channel type is not implemented.");
#if !CORE14
}
#endif
return stream;
}
#if ASYNC
/// <summary>
/// Opens a data stream.
/// </summary>
/// <param name='command'>The command to execute that requires a data stream</param>
/// <param name="restart">Restart location in bytes for file transfer</param>
/// <returns>The data stream.</returns>
async Task<FtpDataStream> OpenDataStreamAsync(string command, long restart)
{
FtpDataConnectionType type = m_dataConnectionType;
FtpDataStream stream = null;
if (!IsConnected)
await ConnectAsync();
// The PORT and PASV commands do not work with IPv6 so
// if either one of those types are set change them
// to EPSV or EPRT appropriately.
if (m_stream.LocalEndPoint.AddressFamily == System.Net.Sockets.AddressFamily.InterNetworkV6)
{
switch (type)
{
case FtpDataConnectionType.PORT:
type = FtpDataConnectionType.EPRT;
FtpTrace.WriteLine(FtpTraceLevel.Info, "Changed data connection type to EPRT because we are connected with IPv6.");
break;
case FtpDataConnectionType.PASV:
case FtpDataConnectionType.PASVEX:
type = FtpDataConnectionType.EPSV;
FtpTrace.WriteLine(FtpTraceLevel.Info, "Changed data connection type to EPSV because we are connected with IPv6.");
break;
}
}
switch (type)
{
case FtpDataConnectionType.AutoPassive:
case FtpDataConnectionType.EPSV:
case FtpDataConnectionType.PASV:
case FtpDataConnectionType.PASVEX:
stream = await OpenPassiveDataStreamAsync(type, command, restart);
break;
case FtpDataConnectionType.AutoActive:
case FtpDataConnectionType.EPRT:
case FtpDataConnectionType.PORT:
stream = await OpenActiveDataStreamAsync(type, command, restart);
break;
}
if (stream == null)
throw new InvalidOperationException("The specified data channel type is not implemented.");
return stream;
}
#endif
/// <summary>
/// Disconnects a data stream
/// </summary>
/// <param name="stream">The data stream to close</param>
internal FtpReply CloseDataStream(FtpDataStream stream) {
FtpTrace.WriteFunc("CloseDataStream");
FtpReply reply = new FtpReply();
if (stream == null)
throw new ArgumentException("The data stream parameter was null");
#if !CORE14
lock (m_lock) {
#endif
try {
if (IsConnected) {
// if the command that required the data connection was
// not successful then there will be no reply from
// the server, however if the command was successful
// the server will send a reply when the data connection
// is closed.
if (stream.CommandStatus.Type == FtpResponseType.PositivePreliminary) {
if (!(reply = GetReply()).Success) {
throw new FtpCommandException(reply);
}
}
}
} finally {
// if this is a clone of the original control
// connection we should Dispose()
if (IsClone) {
Disconnect();
Dispose();
}
}
#if !CORE14
}
#endif
return reply;
}
#endregion
#region Open Read
/// <summary>
/// Opens the specified file for reading
/// </summary>
/// <param name="path">The full or relative path of the file</param>
/// <returns>A stream for reading the file on the server</returns>
/// <example><code source="..\Examples\OpenRead.cs" lang="cs" /></example>
public Stream OpenRead(string path) {
return OpenRead(path, FtpDataType.Binary, 0, true);
}
/// <summary>
/// Opens the specified file for reading
/// </summary>
/// <param name="path">The full or relative path of the file</param>
/// <param name="type">ASCII/Binary</param>
/// <returns>A stream for reading the file on the server</returns>
/// <example><code source="..\Examples\OpenRead.cs" lang="cs" /></example>
public Stream OpenRead(string path, FtpDataType type) {
return OpenRead(path, type, 0, true);
}
/// <summary>
/// Opens the specified file for reading
/// </summary>
/// <param name="path">The full or relative path of the file</param>
/// <param name="type">ASCII/Binary</param>
/// <param name="checkIfFileExists">Only set this to false if you are SURE that the file does not exist. If true, it reads the file size and saves it into the stream length.</param>
/// <returns>A stream for reading the file on the server</returns>
/// <example><code source="..\Examples\OpenRead.cs" lang="cs" /></example>
public Stream OpenRead(string path, FtpDataType type, bool checkIfFileExists) {
return OpenRead(path, type, 0, checkIfFileExists);
}
/// <summary>
/// Opens the specified file for reading
/// </summary>
/// <param name="path">The full or relative path of the file</param>
/// <param name="type">ASCII/Binary</param>
/// <param name="restart">Resume location</param>
/// <returns>A stream for reading the file on the server</returns>
/// <example><code source="..\Examples\OpenRead.cs" lang="cs" /></example>
public virtual Stream OpenRead(string path, FtpDataType type, long restart) {
return OpenRead(path, type, restart, true);
}
/// <summary>
/// Opens the specified file for reading
/// </summary>
/// <param name="path">The full or relative path of the file</param>
/// <param name="restart">Resume location</param>
/// <returns>A stream for reading the file on the server</returns>
/// <example><code source="..\Examples\OpenRead.cs" lang="cs" /></example>
public Stream OpenRead(string path, long restart) {
return OpenRead(path, FtpDataType.Binary, restart, true);
}
/// <summary>
/// Opens the specified file for reading
/// </summary>
/// <param name="path">The full or relative path of the file</param>
/// <param name="restart">Resume location</param>
/// <param name="checkIfFileExists">Only set this to false if you are SURE that the file does not exist. If true, it reads the file size and saves it into the stream length.</param>
/// <returns>A stream for reading the file on the server</returns>
/// <example><code source="..\Examples\OpenRead.cs" lang="cs" /></example>
public Stream OpenRead(string path, long restart, bool checkIfFileExists) {
return OpenRead(path, FtpDataType.Binary, restart, checkIfFileExists);
}
/// <summary>
/// Opens the specified file for reading
/// </summary>
/// <param name="path">The full or relative path of the file</param>
/// <param name="type">ASCII/Binary</param>
/// <param name="restart">Resume location</param>
/// <param name="checkIfFileExists">Only set this to false if you are SURE that the file does not exist. If true, it reads the file size and saves it into the stream length.</param>
/// <returns>A stream for reading the file on the server</returns>
/// <example><code source="..\Examples\OpenRead.cs" lang="cs" /></example>
public virtual Stream OpenRead(string path, FtpDataType type, long restart, bool checkIfFileExists) {
// verify args
if (path.IsBlank())
throw new ArgumentException("Required parameter is null or blank.", "path");
FtpTrace.WriteFunc("OpenRead", new object[] { path, type, restart });
FtpClient client = null;
FtpDataStream stream = null;
long length = 0;
#if !CORE14
lock (m_lock) {
#endif
this.SetDataType(type);
if (m_threadSafeDataChannels) {
client = CloneConnection();
client.Connect();
client.SetWorkingDirectory(GetWorkingDirectory());
} else {
client = this;
}
length = checkIfFileExists ? client.GetFileSize(path) : 0;
stream = client.OpenDataStream(("RETR " + path.GetFtpPath()), restart);
#if !CORE14
}
#endif
if (stream != null) {
if (length > 0)
stream.SetLength(length);
if (restart > 0)
stream.SetPosition(restart);
}
return stream;
}
#if !CORE
/// <summary>
/// Begins an asynchronous operation to open the specified file for reading
/// </summary>
/// <param name="path">The full or relative path of the file</param>
/// <param name="callback">Async Callback</param>
/// <param name="state">State object</param>
/// <returns>IAsyncResult</returns>
/// <example><code source="..\Examples\BeginOpenRead.cs" lang="cs" /></example>
public IAsyncResult BeginOpenRead(string path, AsyncCallback callback, object state) {
return BeginOpenRead(path, FtpDataType.Binary, 0, callback, state);
}
/// <summary>
/// Opens the specified file for reading
/// </summary>
/// <param name="path">The full or relative path of the file</param>
/// <param name="type">ASCII/Binary</param>
/// <param name="callback">Async Callback</param>
/// <param name="state">State object</param>
/// <returns>IAsyncResult</returns>
/// <example><code source="..\Examples\BeginOpenRead.cs" lang="cs" /></example>
public IAsyncResult BeginOpenRead(string path, FtpDataType type, AsyncCallback callback, object state) {
return BeginOpenRead(path, type, 0, callback, state);
}
/// <summary>
/// Begins an asynchronous operation to open the specified file for reading
/// </summary>
/// <param name="path">The full or relative path of the file</param>
/// <param name="restart">Resume location</param>
/// <param name="callback">Async Callback</param>
/// <param name="state">State object</param>
/// <returns>IAsyncResult</returns>
/// <example><code source="..\Examples\BeginOpenRead.cs" lang="cs" /></example>
public IAsyncResult BeginOpenRead(string path, long restart, AsyncCallback callback, object state) {
return BeginOpenRead(path, FtpDataType.Binary, restart, callback, state);
}
delegate Stream AsyncOpenRead(string path, FtpDataType type, long restart);
/// <summary>
/// Begins an asynchronous operation to open the specified file for reading
/// </summary>
/// <param name="path">The full or relative path of the file</param>
/// <param name="type">ASCII/Binary</param>
/// <param name="restart">Resume location</param>
/// <param name="callback">Async Callback</param>
/// <param name="state">State object</param>
/// <returns>IAsyncResult</returns>
/// <example><code source="..\Examples\BeginOpenRead.cs" lang="cs" /></example>
public IAsyncResult BeginOpenRead(string path, FtpDataType type, long restart, AsyncCallback callback, object state) {
AsyncOpenRead func;
IAsyncResult ar;
lock (m_asyncmethods) {
ar = (func = new AsyncOpenRead(OpenRead)).BeginInvoke(path, type, restart, callback, state);
m_asyncmethods.Add(ar, func);
}
return ar;
}
/// <summary>
/// Ends a call to <see cref="o:BeginOpenRead"/>
/// </summary>
/// <param name="ar"><see cref="IAsyncResult"/> returned from <see cref="o:BeginOpenRead"/></param>
/// <returns>A readable stream of the remote file</returns>
/// <example><code source="..\Examples\BeginOpenRead.cs" lang="cs" /></example>
public Stream EndOpenRead(IAsyncResult ar) {
return GetAsyncDelegate<AsyncOpenRead>(ar).EndInvoke(ar);
}
#endif
#if ASYNC
/// <summary>
/// Opens the specified file for reading asynchronously
/// </summary>
/// <param name="path">The full or relative path of the file</param>
/// <param name="type">ASCII/Binary</param>
/// <param name="restart">Resume location</param>
/// <param name="checkIfFileExists">Only set this to false if you are SURE that the file does not exist. If true, it reads the file size and saves it into the stream length.</param>
/// <returns>A stream for reading the file on the server</returns>
public virtual async Task<Stream> OpenReadAsync(string path, FtpDataType type, long restart, bool checkIfFileExists)
{
// TODO: Add cancellation support
// verify args
if (path.IsBlank())
throw new ArgumentException("Required parameter is null or blank.", "path");
FtpTrace.WriteFunc(nameof(OpenReadAsync), new object[] { path, type, restart });
FtpClient client = null;
FtpDataStream stream = null;
long length = 0;
if (m_threadSafeDataChannels)
{
client = CloneConnection();
await client.ConnectAsync();
await client.SetWorkingDirectoryAsync(await GetWorkingDirectoryAsync());
}
else
{
client = this;
}
await client.SetDataTypeAsync(type);
length = checkIfFileExists ? await client.GetFileSizeAsync(path) : 0;
stream = await client.OpenDataStreamAsync(("RETR " + path.GetFtpPath()), restart);
if (stream != null)
{
if (length > 0)
stream.SetLength(length);
if (restart > 0)
stream.SetPosition(restart);
}
return stream;
}
/// <summary>
/// Opens the specified file for reading asynchronously
/// </summary>
/// <param name="path">The full or relative path of the file</param>
/// <param name="type">ASCII/Binary</param>
/// <param name="restart">Resume location</param>
/// <returns>A readable stream of the remote file</returns>
public Task<Stream> OpenReadAsync(string path, FtpDataType type, long restart) {
//TODO: Add cancellation support
return OpenReadAsync(path, type, restart, true);
}
/// <summary>
/// Opens the specified file for reading asynchronously
/// </summary>
/// <param name="path">The full or relative path of the file</param>
/// <param name="type">ASCII/Binary</param>
/// <returns>A readable stream of the remote file</returns>
public Task<Stream> OpenReadAsync(string path, FtpDataType type) {
//TODO: Add cancellation support
return OpenReadAsync(path, type, 0, true);
}
/// <summary>
/// Opens the specified file for reading asynchronously
/// </summary>
/// <param name="path">The full or relative path of the file</param>
/// <param name="restart">Resume location</param>
/// <returns>A readable stream of the remote file</returns>
public Task<Stream> OpenReadAsync(string path, long restart) {
//TODO: Add cancellation support
return OpenReadAsync(path, FtpDataType.Binary, restart, true);
}
/// <summary>
/// Opens the specified file for reading asynchronously
/// </summary>