-
-
Notifications
You must be signed in to change notification settings - Fork 13
/
SpeakerController.cs
336 lines (300 loc) · 12.5 KB
/
SpeakerController.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
using System.Collections.Generic;
using IO = System.IO;
using System.Threading.Tasks;
using BackendFramework.Helper;
using BackendFramework.Interfaces;
using BackendFramework.Models;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
namespace BackendFramework.Controllers
{
[Authorize]
[Produces("application/json")]
[Route("v1/projects/{projectId}/speakers")]
public class SpeakerController : Controller
{
private readonly ISpeakerRepository _speakerRepo;
private readonly IPermissionService _permissionService;
public SpeakerController(ISpeakerRepository speakerRepo, IPermissionService permissionService)
{
_speakerRepo = speakerRepo;
_permissionService = permissionService;
}
/// <summary> Gets all <see cref="Speaker"/>s for specified projectId </summary>
/// <returns> List of Speakers </returns>
[HttpGet(Name = "GetProjectSpeakers")]
[ProducesResponseType(StatusCodes.Status200OK, Type = typeof(List<Speaker>))]
public async Task<IActionResult> GetProjectSpeakers(string projectId)
{
// Check permissions
if (!await _permissionService.HasProjectPermission(HttpContext, Permission.WordEntry, projectId))
{
return Forbid();
}
// Return speakers
return Ok(await _speakerRepo.GetAllSpeakers(projectId));
}
/// <summary> Deletes all <see cref="Speaker"/>s for specified projectId </summary>
/// <returns> bool: true if success; false if no speakers in project </returns>
[HttpDelete(Name = "DeleteProjectSpeakers")]
[ProducesResponseType(StatusCodes.Status200OK, Type = typeof(bool))]
public async Task<IActionResult> DeleteProjectSpeakers(string projectId)
{
// Check permissions
if (!await _permissionService.IsSiteAdmin(HttpContext))
{
return Forbid();
}
// Delete speakers and return success
return Ok(await _speakerRepo.DeleteAllSpeakers(projectId));
}
/// <summary> Gets the <see cref="Speaker"/> for the specified projectId and speakerId </summary>
/// <returns> Speaker </returns>
[HttpGet("{speakerId}", Name = "GetSpeaker")]
[ProducesResponseType(StatusCodes.Status200OK, Type = typeof(Speaker))]
public async Task<IActionResult> GetSpeaker(string projectId, string speakerId)
{
// Check permissions
if (!await _permissionService.HasProjectPermission(HttpContext, Permission.WordEntry, projectId))
{
return Forbid();
}
// Ensure the speaker exists
var speaker = await _speakerRepo.GetSpeaker(projectId, speakerId);
if (speaker is null)
{
return NotFound(speakerId);
}
// Return speaker
return Ok(speaker);
}
/// <summary> Creates a <see cref="Speaker"/> for the specified projectId </summary>
/// <returns> Id of created Speaker </returns>
[HttpGet("create/{name}", Name = "CreateSpeaker")]
[ProducesResponseType(StatusCodes.Status200OK, Type = typeof(string))]
public async Task<IActionResult> CreateSpeaker(string projectId, string name)
{
// Check permissions
if (!await _permissionService.HasProjectPermission(
HttpContext, Permission.DeleteEditSettingsAndUsers, projectId))
{
return Forbid();
}
// Ensure the new name is valid
name = name.Trim();
if (string.IsNullOrEmpty(name))
{
return BadRequest("projectSettings.speaker.nameEmpty");
}
if (await _speakerRepo.IsSpeakerNameInProject(projectId, name))
{
return BadRequest("projectSettings.speaker.nameTaken");
}
// Create speaker and return id
var speaker = new Speaker { Name = name, ProjectId = projectId };
return Ok((await _speakerRepo.Create(speaker)).Id);
}
/// <summary> Deletes the <see cref="Speaker"/> for the specified projectId and speakerId </summary>
/// <returns> bool: true if success; false if failure </returns>
[HttpDelete("{speakerId}", Name = "DeleteSpeaker")]
[ProducesResponseType(StatusCodes.Status200OK, Type = typeof(bool))]
public async Task<IActionResult> DeleteSpeaker(string projectId, string speakerId)
{
// Check permissions
if (!await _permissionService.HasProjectPermission(
HttpContext, Permission.DeleteEditSettingsAndUsers, projectId))
{
return Forbid();
}
// Ensure the speaker exists
if (await _speakerRepo.GetSpeaker(projectId, speakerId) is null)
{
return NotFound(speakerId);
}
// Delete consent file
var path = FileStorage.GetConsentFilePath(speakerId);
if (path is not null)
{
IO.File.Delete(path);
}
// Delete speaker and return success
return Ok(await _speakerRepo.Delete(projectId, speakerId));
}
/// <summary> Removes consent of the <see cref="Speaker"/> for specified projectId and speakerId </summary>
/// <returns> Id of updated Speaker </returns>
[HttpDelete("consent/{speakerId}", Name = "RemoveConsent")]
[ProducesResponseType(StatusCodes.Status200OK, Type = typeof(string))]
public async Task<IActionResult> RemoveConsent(string projectId, string speakerId)
{
// Check permissions
if (!await _permissionService.HasProjectPermission(
HttpContext, Permission.DeleteEditSettingsAndUsers, projectId))
{
return Forbid();
}
// Ensure the speaker exists
var speaker = await _speakerRepo.GetSpeaker(projectId, speakerId);
if (speaker is null)
{
return NotFound(speakerId);
}
// Delete consent file
if (speaker.Consent is ConsentType.None)
{
return StatusCode(StatusCodes.Status304NotModified, speakerId);
}
var path = FileStorage.GetConsentFilePath(speaker.Id);
if (path is not null)
{
IO.File.Delete(path);
}
// Update speaker and return result with id
speaker.Consent = ConsentType.None;
return await _speakerRepo.Update(speakerId, speaker) switch
{
ResultOfUpdate.NotFound => NotFound(speakerId),
ResultOfUpdate.Updated => Ok(speakerId),
_ => StatusCode(StatusCodes.Status304NotModified, speakerId)
};
}
/// <summary> Updates the <see cref="Speaker"/>'s name for the specified projectId and speakerId </summary>
/// <returns> Id of updated Speaker </returns>
[HttpGet("update/{speakerId}/{name}", Name = "UpdateSpeakerName")]
[ProducesResponseType(StatusCodes.Status200OK, Type = typeof(string))]
public async Task<IActionResult> UpdateSpeakerName(string projectId, string speakerId, string name)
{
// Check permissions
if (!await _permissionService.HasProjectPermission(
HttpContext, Permission.DeleteEditSettingsAndUsers, projectId))
{
return Forbid();
}
// Ensure the speaker exists
var speaker = await _speakerRepo.GetSpeaker(projectId, speakerId);
if (speaker is null)
{
return NotFound(speakerId);
}
// Ensure the new name is valid
name = name.Trim();
if (string.IsNullOrEmpty(name))
{
return BadRequest("projectSettings.speaker.nameEmpty");
}
if (await _speakerRepo.IsSpeakerNameInProject(projectId, name))
{
return BadRequest("projectSettings.speaker.nameTaken");
}
// Update name and return result with id
speaker.Name = name;
return await _speakerRepo.Update(speakerId, speaker) switch
{
ResultOfUpdate.NotFound => NotFound(speakerId),
ResultOfUpdate.Updated => Ok(speakerId),
_ => StatusCode(StatusCodes.Status304NotModified, speakerId)
};
}
/// <summary> Saves a consent file locally and updates the specified <see cref="Speaker"/> </summary>
/// <returns> Updated speaker </returns>
[HttpPost("consent/{speakerId}", Name = "UploadConsent")]
[ProducesResponseType(StatusCodes.Status200OK, Type = typeof(Speaker))]
public async Task<IActionResult> UploadConsent(
string projectId, string speakerId, [FromForm] FileUpload upload)
{
// Sanitize user input
try
{
projectId = Sanitization.SanitizeId(projectId);
speakerId = Sanitization.SanitizeId(speakerId);
}
catch
{
return new UnsupportedMediaTypeResult();
}
// Check permissions
if (!await _permissionService.HasProjectPermission(HttpContext, Permission.WordEntry, projectId))
{
return Forbid();
}
// Ensure the speaker exists
var speaker = await _speakerRepo.GetSpeaker(projectId, speakerId);
if (speaker is null)
{
return NotFound(speakerId);
}
// Ensure file is valid
var file = upload.File;
if (file is null)
{
return BadRequest("Null File");
}
if (file.Length == 0)
{
return BadRequest("Empty File");
}
var extension = IO.Path.GetExtension(file.FileName) ?? "";
if (file.ContentType.Contains("audio"))
{
speaker.Consent = ConsentType.Audio;
extension = ".webm";
}
else if (file.ContentType.Contains("image"))
{
speaker.Consent = ConsentType.Image;
}
else
{
return BadRequest("File should be audio or image");
}
// Delete old consent file
var old = FileStorage.GetConsentFilePath(speaker.Id);
if (old is not null)
{
IO.File.Delete(old);
}
// Copy file data to a new local file
var path = FileStorage.GenerateConsentFilePath(speakerId, extension);
await using (var fs = new IO.FileStream(path, IO.FileMode.OpenOrCreate))
{
await file.CopyToAsync(fs);
}
// Update and return speaker
return await _speakerRepo.Update(speakerId, speaker) switch
{
ResultOfUpdate.NotFound => NotFound(speaker),
_ => Ok(speaker),
};
}
/// <summary> Get speaker's consent </summary>
/// <returns> Stream of local audio/image file </returns>
[AllowAnonymous]
[HttpGet("consent/{speakerId}", Name = "DownloadConsent")]
[ProducesResponseType(StatusCodes.Status200OK, Type = typeof(FileContentResult))]
public IActionResult DownloadConsent(string speakerId)
{
// SECURITY: Omitting authentication so the frontend can use the API endpoint directly as a URL.
// if (!await _permissionService.HasProjectPermission(HttpContext, Permission.WordEntry))
// {
// return Forbid();
// }
// Sanitize user input
try
{
speakerId = Sanitization.SanitizeId(speakerId);
}
catch
{
return new UnsupportedMediaTypeResult();
}
// Ensure file exists
var path = FileStorage.GetConsentFilePath(speakerId);
if (path is null)
{
return NotFound(speakerId);
}
// Return file as stream
return File(IO.File.OpenRead(path), "application/octet-stream");
}
}
}