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
|
using System;
using System.Net;
using System.IO;
namespace mooftpserv
{
/// <summary>
/// File system entry as returned by List.
/// </summary>
public struct FileSystemEntry
{
public string Name;
public bool IsDirectory;
public long Size;
public DateTime LastModifiedTimeUtc;
public string Mode;
}
/// <summary>
/// Wrapper that either contains a value or an error string.
/// </summary>
public class ResultOrError<T>
{
private T result;
private string error;
private ResultOrError(T result, string error)
{
this.result = result;
this.error = error;
}
public static ResultOrError<T> MakeResult(T result)
{
return new ResultOrError<T>(result, null);
}
public static ResultOrError<T> MakeError(string error)
{
if (error == null)
throw new ArgumentNullException();
return new ResultOrError<T>(default(T), error.Replace(Environment.NewLine, " "));
}
public bool HasError
{
get { return error != null; }
}
public string Error
{
get { return error; }
}
public T Result
{
get
{
if (HasError)
throw new InvalidOperationException(String.Format("No result available, error: {0}", error));
return result;
}
}
};
/// <summary>
/// Interface for file system access from FTP.
/// </summary>
public interface IFileSystemHandler
{
/// <summary>
/// Make a new instance for a new session with the given peer.
/// Each FTP session uses a separate, cloned instance.
/// </summary>
IFileSystemHandler Clone(IPEndPoint peer);
/// <summary>
/// PWD: Returns the path of the current working directory.
/// </summary>
/// <returns>
/// The absolute path of the current directory or an error string.
/// </returns>
ResultOrError<string> GetCurrentDirectory();
/// <summary>
/// CWD: Changes the current directory.
/// CDUP: Changes to parent directory (called with "..")
/// </summary>
/// <returns>
/// The new absolute path or an error string.
/// </returns>
/// <param name='path'>
/// A relative or absolute path to which to change.
/// </param>
ResultOrError<string> ChangeDirectory(string path);
/// <summary>
/// MKD: Create a directory.
/// </summary>
/// <returns>
/// The absolute path of the created directory or an error string.
/// </returns>
/// <param name='path'>
/// A relative or absolute path for the new directory.
/// </param>
ResultOrError<string> CreateDirectory(string path);
/// <summary>
/// RMD: Remove a directory.
/// </summary>
/// <returns>
/// A bool or an error string. The bool is not actually used.
/// </returns>
/// <param name='path'>
/// A relative or absolute path for the directory.
/// </param>
ResultOrError<bool> RemoveDirectory(string path);
/// <summary>
/// RETR: Open a stream for reading the specified file.
/// </summary>
/// <returns>
/// An opened stream for reading from the file, or an error string.
/// </returns>
/// <param name='path'>
/// A relative or absolute path for the file.
/// </param>
ResultOrError<Stream> ReadFile(string path);
/// <summary>
/// STOR: Open a stream for writing to the specified file.
/// If the file exists, it should be overwritten.
/// </summary>
/// <returns>
/// An opened stream for writing to the file, or an error string.
/// </returns>
/// <param name='path'>
/// A relative or absolute path for the file.
/// </param>
ResultOrError<Stream> WriteFile(string path);
ResultOrError<bool> WriteFileFinalize(string path, Stream stream);
/// <summary>
/// DELE: Deletes a file.
/// </summary>
/// <returns>
/// A bool or an error string. The bool is not actually used.
/// </returns>
/// <param name='path'>
/// A relative or absolute path for the file.
/// </param>
ResultOrError<bool> RemoveFile(string path);
/// <summary>
/// RNFR, RNTO: Renames or moves a file or directory.
/// </summary>
/// <returns>
/// A bool or an error string. The bool is not actually used.
/// </returns>
/// <param name="fromPath">
/// The relative or absolute path of an existing file or directory.
/// </param>
/// <param name="toPath">
/// A relative or absolute non-existing path to which the file will be renamed or moved.
/// </param>
ResultOrError<bool> RenameFile(string fromPath, string toPath);
/// <summary>
/// LIST: Return a list of files and folders in a directory, or for a file (like 'ls').
/// </summary>
/// <param name="path">
/// The relative or absolute path of an existing directory or file.
/// Can be null or empty to return the current directory.
/// </para>
/// <return>
/// An array of file system entries or an error string.
/// </return>
ResultOrError<FileSystemEntry[]> ListEntries(string path);
/// <summary>
/// LIST: Return a raw output of 'ls' command.
/// </summary>
/// <param name="path">
/// The relative or absolute path of an existing directory or file.
/// Can be null or empty to return the current directory.
/// </para>
/// <return>
/// Raw output of 'ls' command
/// </return>
ResultOrError<string> ListEntriesRaw(string path);
/// <summary>
/// SIZE: Gets the size of a file in bytes.
/// </summary>
/// <returns>
/// The file size, or -1 on error.
/// </returns>
/// <param name='path'>
/// A relative or absolute path.
/// </param>
ResultOrError<long> GetFileSize(string path);
/// <summary>
/// MDTM: Gets the last modified timestamp of a file.
/// </summary>
/// <returns>
/// The last modified time in UTC, or an error string.
/// </returns>
/// <param name='path'>
/// A relative or absolute path.
/// </param>
ResultOrError<DateTime> GetLastModifiedTimeUtc(string path);
ResultOrError<bool> SetLastModifiedTimeUtc(string path, DateTime time);
ResultOrError<bool> ChmodFile(string mode, string path);
}
}
|
