-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
DataFilesController.cs
243 lines (231 loc) · 11.9 KB
/
DataFilesController.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
namespace Serval.DataFiles.Controllers;
[ApiVersion("1.0")]
[Route("api/v{version:apiVersion}/files")]
[OpenApiTag("Files")]
public class DataFilesController : ServalControllerBase
{
private readonly IDataFileService _dataFileService;
private readonly IUrlService _urlService;
public DataFilesController(
IAuthorizationService authService,
IDataFileService dataFileService,
IUrlService urlService
)
: base(authService)
{
_dataFileService = dataFileService;
_urlService = urlService;
}
/// <summary>
/// Get all files
/// </summary>
/// <response code="200">A list of all files owned by the client</response>
/// <response code="401">The client is not authenticated</response>
/// <response code="403">The authenticated client cannot perform the operation</response>
/// <response code="503">A necessary service is currently unavailable. Check `/health` for more details. </response>
[Authorize(Scopes.ReadFiles)]
[HttpGet]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(typeof(void), StatusCodes.Status401Unauthorized)]
[ProducesResponseType(typeof(void), StatusCodes.Status403Forbidden)]
[ProducesResponseType(typeof(void), StatusCodes.Status503ServiceUnavailable)]
public async Task<IEnumerable<DataFileDto>> GetAllAsync(CancellationToken cancellationToken)
{
return (await _dataFileService.GetAllAsync(Owner, cancellationToken)).Select(Map);
}
/// <summary>
/// Get a file by unique id
/// </summary>
/// <param name="id">The unique identifier for the file</param>
/// <param name="cancellationToken"></param>
/// <response code="200">The file exists</response>
/// <response code="401">The client is not authenticated</response>
/// <response code="403">The authenticated client cannot perform the operation or does not own the file</response>
/// <response code="404">The file does not exist</response>
/// <response code="503">A necessary service is currently unavailable. Check `/health` for more details. </response>
[Authorize(Scopes.ReadFiles)]
[HttpGet("{id}", Name = "GetDataFile")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(typeof(void), StatusCodes.Status401Unauthorized)]
[ProducesResponseType(typeof(void), StatusCodes.Status403Forbidden)]
[ProducesResponseType(typeof(void), StatusCodes.Status404NotFound)]
[ProducesResponseType(typeof(void), StatusCodes.Status503ServiceUnavailable)]
public async Task<ActionResult<DataFileDto>> GetAsync([NotNull] string id, CancellationToken cancellationToken)
{
DataFile dataFile = await _dataFileService.GetAsync(id, cancellationToken);
await AuthorizeAsync(dataFile);
return Ok(Map(dataFile));
}
/// <summary>
/// Upload a new file
/// </summary>
/// <remarks>
/// Sample request:
///
/// POST /files
/// {
/// "format": "text",
/// "name": "myTeam:myProject:myFile.txt"
/// }
///
/// </remarks>
/// <param name="file">
/// The file to upload. Max size: 100MB
/// </param>
/// <param name="name">
/// A name to help identify and distinguish the file.
/// Recommendation: Create a multi-part name to distinguish between projects, uses, languages, etc.
/// The name does not have to be unique.
/// Example: myTranslationTeam:myProject:myLanguage:myFile.txt
/// </param>
/// <param name="format">
/// File format options:
/// * **Text**: One translation unit (a.k.a., verse) per line
/// * If a line contains a tab, characters before the tab are used as a unique identifier for the line, characters after the tab are understood as the content of the verse, and if there is another tab following the verse content, characters after this second tab are assumed to be column codes like "ss" etc. for sectioning and other formatting. See this example of a tab-delimited text file:
/// > verse_001_005 (tab) Ὑπομνῆσαι δὲ ὑμᾶς βούλομαι , εἰδότας ὑμᾶς ἅπαξ τοῦτο
/// > verse_001_006 (tab) Ἀγγέλους τε τοὺς μὴ τηρήσαντας τὴν ἑαυτῶν ἀρχήν , ἀλλὰ (tab) ss
/// > verse_001_007 (tab) Ὡς Σόδομα καὶ Γόμορρα , καὶ αἱ περὶ αὐτὰς πόλεις (tab) ss
/// * Otherwise, *no tabs* should be used in the file and a unique identifier will generated for each translation unit based on the line number.
/// * **Paratext**: A complete, zipped Paratext project backup: that is, a .zip archive of files including the USFM files and "Settings.xml" file. To generate a zipped backup for a project in Paratext, navigate to "Paratext/Advanced/Backup project to file..." and follow the dialogue.
/// </param>
/// <param name="idGenerator"></param>
/// <param name="cancellationToken"></param>
/// <response code="201">The file was created successfully</response>
/// <response code="400">Bad request. Is the file over 100 MB?</response>
/// <response code="401">The client is not authenticated</response>
/// <response code="403">The authenticated client cannot perform the operation</response>
/// <response code="503">A necessary service is currently unavailable. Check `/health` for more details. </response>
[Authorize(Scopes.CreateFiles)]
[HttpPost]
[RequestSizeLimit(100_000_000)]
[ProducesResponseType(StatusCodes.Status201Created)]
[ProducesResponseType(typeof(void), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(void), StatusCodes.Status401Unauthorized)]
[ProducesResponseType(typeof(void), StatusCodes.Status403Forbidden)]
[ProducesResponseType(typeof(void), StatusCodes.Status503ServiceUnavailable)]
public async Task<ActionResult<DataFileDto>> CreateAsync(
[BindRequired] IFormFile file,
[BindRequired, FromForm] FileFormat format,
[FromServices] IIdGenerator idGenerator,
[FromForm] string? name,
CancellationToken cancellationToken
)
{
var dataFile = new DataFile
{
Id = idGenerator.GenerateId(),
Name = name ?? file.FileName,
Format = format,
Owner = Owner
};
using (Stream stream = file.OpenReadStream())
{
await _dataFileService.CreateAsync(dataFile, stream, cancellationToken);
}
var dto = Map(dataFile);
return Created(dto.Url, dto);
}
/// <summary>
/// Download a file
/// </summary>
/// <param name="id">The unique identifier for the file</param>
/// <param name="cancellationToken"></param>
/// <response code="200">The file exists</response>
/// <response code="401">The client is not authenticated</response>
/// <response code="403">The authenticated client cannot perform the operation or does not own the file</response>
/// <response code="404">The file does not exist</response>
/// <response code="503">A necessary service is currently unavailable. Check `/health` for more details. </response>
[Authorize(Scopes.ReadFiles)]
[HttpPost("{id}/contents")]
[Produces("application/octet-stream")]
[ProducesResponseType(typeof(FileContentResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(void), StatusCodes.Status401Unauthorized)]
[ProducesResponseType(typeof(void), StatusCodes.Status403Forbidden)]
[ProducesResponseType(typeof(void), StatusCodes.Status404NotFound)]
[ProducesResponseType(typeof(void), StatusCodes.Status503ServiceUnavailable)]
public async Task<ActionResult> DownloadAsync([NotNull] string id, CancellationToken cancellationToken)
{
DataFile dataFile = await _dataFileService.GetAsync(id, cancellationToken);
await AuthorizeAsync(dataFile);
Stream stream = await _dataFileService.ReadAsync(id, cancellationToken);
return File(stream, "application/octet-stream", dataFile.Name);
}
/// <summary>
/// Update an existing file
/// </summary>
/// <param name="id">The existing file's unique id</param>
/// <param name="file">The updated file</param>
/// <param name="cancellationToken"></param>
/// <response code="200">The file was updated successfully</response>
/// <response code="400">Bad request. Is the file over 100 MB?</response>
/// <response code="401">The client is not authenticated</response>
/// <response code="403">The authenticated client cannot perform the operation or does not own the file</response>
/// <response code="404">The file does not exist and therefore cannot be updated</response>
/// <response code="503">A necessary service is currently unavailable. Check `/health` for more details. </response>
[Authorize(Scopes.UpdateFiles)]
[HttpPatch("{id}")]
[RequestSizeLimit(100_000_000)]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(typeof(void), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(void), StatusCodes.Status401Unauthorized)]
[ProducesResponseType(typeof(void), StatusCodes.Status403Forbidden)]
[ProducesResponseType(typeof(void), StatusCodes.Status404NotFound)]
[ProducesResponseType(typeof(void), StatusCodes.Status503ServiceUnavailable)]
public async Task<ActionResult<DataFileDto>> UpdateAsync(
[NotNull] string id,
[BindRequired] IFormFile file,
CancellationToken cancellationToken
)
{
await AuthorizeAsync(id, cancellationToken);
DataFile dataFile;
using (Stream stream = file.OpenReadStream())
dataFile = await _dataFileService.UpdateAsync(id, stream, cancellationToken);
var dto = Map(dataFile);
return Ok(dto);
}
/// <summary>
/// Delete an existing file
/// </summary>
/// <remarks>
/// If a file is in a corpora and the file is deleted, it will be automatically removed from the corpora.
/// If a build job has started before the file was deleted, the file will be used for the build job, even
/// though it will no longer be accessible through the API.
/// </remarks>
/// <param name="id">The existing file's unique id</param>
/// <param name="cancellationToken"></param>
/// <response code="200">The file was deleted successfully</response>
/// <response code="401">The client is not authenticated</response>
/// <response code="403">The authenticated client cannot perform the operation or does not own the file</response>
/// <response code="404">The file does not exist and therefore cannot be deleted</response>
/// <response code="503">A necessary service is currently unavailable. Check `/health` for more details. </response>
[Authorize(Scopes.DeleteFiles)]
[HttpDelete("{id}")]
[ProducesResponseType(typeof(void), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(void), StatusCodes.Status401Unauthorized)]
[ProducesResponseType(typeof(void), StatusCodes.Status403Forbidden)]
[ProducesResponseType(typeof(void), StatusCodes.Status404NotFound)]
[ProducesResponseType(typeof(void), StatusCodes.Status503ServiceUnavailable)]
public async Task<ActionResult> DeleteAsync([NotNull] string id, CancellationToken cancellationToken)
{
await AuthorizeAsync(id, cancellationToken);
await _dataFileService.DeleteAsync(id, cancellationToken);
return Ok();
}
private async Task AuthorizeAsync(string id, CancellationToken cancellationToken)
{
DataFile dataFile = await _dataFileService.GetAsync(id, cancellationToken);
await AuthorizeAsync(dataFile);
}
private DataFileDto Map(DataFile source)
{
return new DataFileDto
{
Id = source.Id,
Url = _urlService.GetUrl("GetDataFile", new { id = source.Id }),
Name = source.Name,
Format = source.Format,
Revision = source.Revision
};
}
}