-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathuploads.py
More file actions
459 lines (359 loc) · 15.9 KB
/
uploads.py
File metadata and controls
459 lines (359 loc) · 15.9 KB
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
import contextlib
import secrets
from datetime import UTC, datetime
from pathlib import Path
from typing import TYPE_CHECKING, Annotated, Any
import aiofiles
from fastapi import APIRouter, Depends, Header, HTTPException, Query, Request, Response, status
from sqlalchemy import select
from sqlalchemy.engine.result import Result
from sqlalchemy.ext.asyncio import AsyncSession
from sqlalchemy.sql.selectable import Select
from backend.app import models, schemas
from backend.app.config import settings
from backend.app.db import get_db
from backend.app.metadata_schema import validate_metadata
from backend.app.postprocessing import ProcessingQueue
from backend.app.utils import detect_mimetype, is_multimedia, mime_allowed
if TYPE_CHECKING:
from sqlalchemy.engine.result import Result
from sqlalchemy.sql.selectable import Select
router = APIRouter(prefix="/api/uploads", tags=["uploads"])
def get_processing_queue(request: Request) -> ProcessingQueue | None:
"""Get the processing queue from app state (returns None if not available in tests)."""
return getattr(request.app.state, "processing_queue", None)
async def _ensure_token(
db: AsyncSession,
token_value: str | None = None,
token_id: int | None = None,
check_remaining: bool = True,
) -> models.UploadToken:
"""
Ensure the upload token is valid, not expired or disabled, and optionally has remaining uploads.
Args:
db (AsyncSession): Database session.
token_value (str | None): The upload token string.
token_id (int | None): The upload token ID.
check_remaining (bool): Whether to check remaining uploads. Defaults to True.
Returns:
UploadToken: The valid upload token object.
"""
if token_value:
stmt: Select[tuple[models.UploadToken]] = select(models.UploadToken).where(models.UploadToken.token == token_value)
elif token_id:
stmt: Select[tuple[models.UploadToken]] = select(models.UploadToken).where(models.UploadToken.id == token_id)
else:
msg = "Either token_value or token_id must be provided"
raise ValueError(msg)
res: Result[tuple[models.UploadToken]] = await db.execute(stmt)
if not (token := res.scalar_one_or_none()):
raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail="Token not found")
now: datetime = datetime.now(UTC)
expires_at: datetime = token.expires_at
if expires_at.tzinfo is None:
expires_at = expires_at.replace(tzinfo=UTC)
if expires_at < now:
raise HTTPException(status_code=status.HTTP_403_FORBIDDEN, detail="Token expired")
if token.disabled:
raise HTTPException(status_code=status.HTTP_403_FORBIDDEN, detail="Token disabled")
if check_remaining and token.remaining_uploads <= 0:
raise HTTPException(status_code=status.HTTP_403_FORBIDDEN, detail="Upload limit reached")
return token
async def _get_upload_record(db: AsyncSession, upload_id: str) -> models.UploadRecord:
"""
Retrieve the upload record by its public ID.
Args:
db (AsyncSession): Database session.
upload_id (str): The public ID of the upload.
Returns:
UploadRecord: The upload record object.
"""
stmt: Select[tuple[models.UploadRecord]] = select(models.UploadRecord).where(models.UploadRecord.public_id == upload_id)
res: Result[tuple[models.UploadRecord]] = await db.execute(stmt)
if not (record := res.scalar_one_or_none()):
raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail="Upload not found")
return record
async def _finalize_upload(
db: AsyncSession,
record: models.UploadRecord,
queue: ProcessingQueue | None,
) -> models.UploadRecord:
"""Validate and finalize an uploaded file after all bytes have been received."""
if record.upload_length is None:
raise HTTPException(status_code=status.HTTP_409_CONFLICT, detail="Upload length unknown")
if record.upload_offset < record.upload_length:
raise HTTPException(status_code=status.HTTP_409_CONFLICT, detail="Upload not finished")
if record.status in {"completed", "postprocessing"}:
return record
path = Path(record.storage_path)
if not path.exists():
raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail="Uploaded file not found")
try:
actual_mimetype: str = detect_mimetype(path)
except Exception as e:
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Failed to detect file type: {e}",
) from e
stmt: Select[tuple[models.UploadToken]] = select(models.UploadToken).where(models.UploadToken.id == record.token_id)
res: Result[tuple[models.UploadToken]] = await db.execute(stmt)
if not (token := res.scalar_one_or_none()):
raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail="Token not found")
if not mime_allowed(actual_mimetype, token.allowed_mime):
path.unlink(missing_ok=True)
await db.delete(record)
await db.commit()
raise HTTPException(
status_code=status.HTTP_415_UNSUPPORTED_MEDIA_TYPE,
detail=f"Actual file type '{actual_mimetype}' does not match allowed types",
)
record.mimetype = actual_mimetype
if is_multimedia(actual_mimetype):
record.status = "postprocessing"
record.completed_at = None
await db.commit()
await db.refresh(record)
if queue:
await queue.enqueue(record.public_id)
return record
record.status = "completed"
record.completed_at = datetime.now(UTC)
await db.commit()
await db.refresh(record)
return record
@router.post("/initiate", response_model=schemas.InitiateUploadResponse, status_code=status.HTTP_201_CREATED, name="initiate_upload")
async def initiate_upload(
request: Request,
payload: schemas.UploadRequest,
db: Annotated[AsyncSession, Depends(get_db)],
token: Annotated[str, Query(description="Upload token")] = ...,
) -> schemas.InitiateUploadResponse:
"""
Initiate a new upload record and prepare for TUS upload.
Args:
request (Request): The incoming HTTP request.
payload (UploadRequest): The upload request payload.
db (AsyncSession): Database session.
token (str): The upload token string.
Returns:
InitiateUploadResponse: Details for the initiated upload.
"""
token_row: models.UploadToken = await _ensure_token(db, token)
cleaned_metadata: dict[str, Any] = validate_metadata(payload.meta_data or {})
if payload.size_bytes and payload.size_bytes > token_row.max_size_bytes:
raise HTTPException(
status_code=status.HTTP_413_CONTENT_TOO_LARGE,
detail="File size exceeds token limit",
)
if not mime_allowed(payload.filetype, token_row.allowed_mime):
raise HTTPException(
status_code=status.HTTP_415_UNSUPPORTED_MEDIA_TYPE,
detail="File type not allowed for this token",
)
ext: str | None = None
if payload.filename:
ext: str = Path(payload.filename).suffix.lstrip(".")
record = models.UploadRecord(
public_id=secrets.token_urlsafe(18),
token_id=token_row.id,
filename=payload.filename,
ext=ext,
mimetype=payload.filetype,
size_bytes=payload.size_bytes,
meta_data=cleaned_metadata,
storage_path="",
upload_length=payload.size_bytes,
status="initiated",
)
db.add(record)
await db.flush()
storage_dir: Path = Path(settings.storage_path).expanduser().resolve() / token_row.token
storage_dir.mkdir(parents=True, exist_ok=True)
filename_on_disk: str = f"{record.id}.{ext}" if ext else str(record.id)
storage_path: Path = storage_dir / filename_on_disk
record.storage_path = str(storage_path)
token_row.uploads_used += 1
await db.commit()
await db.refresh(record)
await db.refresh(token_row)
return schemas.InitiateUploadResponse(
upload_id=record.public_id,
upload_url=str(request.app.url_path_for("tus_head", upload_id=record.public_id)),
download_url=str(request.app.url_path_for("download_file", download_token=token_row.download_token, upload_id=record.public_id)),
meta_data=cleaned_metadata,
allowed_mime=token_row.allowed_mime,
remaining_uploads=token_row.remaining_uploads,
)
@router.head("/{upload_id}/tus", name="tus_head")
async def tus_head(upload_id: str, db: Annotated[AsyncSession, Depends(get_db)]):
"""
Handle TUS protocol HEAD request to get upload status.
Args:
upload_id (str): The public ID of the upload.
db (AsyncSession): Database session.
Returns:
Response: HTTP response with upload offset and length.
"""
record: models.UploadRecord = await _get_upload_record(db, upload_id)
await _ensure_token(db, token_id=record.token_id, check_remaining=False)
if record.upload_length is None:
raise HTTPException(status_code=status.HTTP_409_CONFLICT, detail="Upload length unknown")
return Response(
status_code=status.HTTP_200_OK,
headers={
"Upload-Offset": str(record.upload_offset or 0),
"Upload-Length": str(record.upload_length),
"Tus-Resumable": "1.0.0",
},
)
@router.patch("/{upload_id}/tus", name="tus_patch")
async def tus_patch(
upload_id: str,
request: Request,
db: Annotated[AsyncSession, Depends(get_db)],
upload_offset: Annotated[int, Header(convert_underscores=False, alias="Upload-Offset")] = ...,
content_length: Annotated[int | None, Header()] = None,
content_type: Annotated[str, Header(convert_underscores=False, alias="Content-Type")] = ...,
) -> Response:
"""
Handle TUS protocol PATCH request to upload file chunks.
Args:
upload_id (str): The public ID of the upload.
request (Request): The incoming HTTP request.
db (AsyncSession): Database session.
upload_offset (int): The current upload offset from the client.
content_length (int | None): The Content-Length header value.
content_type (str): The Content-Type header value.
Returns:
Response: HTTP response with updated upload offset.
"""
from starlette.requests import ClientDisconnect
if content_type != "application/offset+octet-stream":
raise HTTPException(status_code=status.HTTP_415_UNSUPPORTED_MEDIA_TYPE, detail="Invalid Content-Type")
if content_length and content_length > settings.max_chunk_bytes:
raise HTTPException(
status_code=status.HTTP_413_CONTENT_TOO_LARGE,
detail=f"Chunk too large. Max {settings.max_chunk_bytes} bytes",
)
record: models.UploadRecord = await _get_upload_record(db, upload_id)
await _ensure_token(db, token_id=record.token_id, check_remaining=False)
if record.upload_length is None:
raise HTTPException(status_code=status.HTTP_409_CONFLICT, detail="Upload length unknown")
if record.upload_offset != upload_offset:
raise HTTPException(status_code=status.HTTP_409_CONFLICT, detail="Mismatched Upload-Offset")
if "completed" == record.status:
return Response(status_code=status.HTTP_204_NO_CONTENT, headers={"Upload-Offset": str(record.upload_offset)})
path = Path(record.storage_path)
path.parent.mkdir(parents=True, exist_ok=True)
bytes_written: int = 0
try:
async with aiofiles.open(path, "ab") as f:
async for chunk in request.stream():
await f.write(chunk)
bytes_written += len(chunk)
except ClientDisconnect:
pass
if bytes_written > 0:
record.upload_offset += bytes_written
if record.upload_offset > record.upload_length:
raise HTTPException(status_code=status.HTTP_413_CONTENT_TOO_LARGE, detail="Upload exceeds declared length")
record.status = "in_progress"
try:
await db.commit()
await db.refresh(record)
except Exception:
await db.rollback()
await db.refresh(record)
return Response(
status_code=status.HTTP_204_NO_CONTENT,
headers={
"Upload-Offset": str(record.upload_offset),
"Tus-Resumable": "1.0.0",
"Upload-Length": str(record.upload_length),
},
)
@router.options("/tus", name="tus_options")
async def tus_options() -> Response:
"""Handle TUS protocol OPTIONS request."""
return Response(
status_code=status.HTTP_204_NO_CONTENT,
headers={
"Tus-Resumable": "1.0.0",
"Tus-Version": "1.0.0",
"Tus-Extension": "creation,termination",
},
)
@router.delete("/{upload_id}/tus", status_code=status.HTTP_204_NO_CONTENT, name="tus_delete")
async def tus_delete(upload_id: str, db: Annotated[AsyncSession, Depends(get_db)]) -> Response:
"""
Delete an upload record and its associated file.
Args:
upload_id (str): The public ID of the upload.
db (AsyncSession): Database session.
Returns:
Response: HTTP 204 No Content response.
"""
record: models.UploadRecord = await _get_upload_record(db, upload_id)
await _ensure_token(db, token_id=record.token_id, check_remaining=False)
path = Path(record.storage_path or "")
if path.exists():
with contextlib.suppress(OSError):
path.unlink()
await db.delete(record)
await db.commit()
return Response(status_code=status.HTTP_204_NO_CONTENT)
@router.post("/{upload_id}/complete", response_model=schemas.UploadRecordResponse, name="mark_complete")
async def mark_complete(
upload_id: str,
db: Annotated[AsyncSession, Depends(get_db)],
queue: Annotated[ProcessingQueue | None, Depends(get_processing_queue)],
token: Annotated[str, Query(description="Upload token")] = ...,
) -> models.UploadRecord:
"""
Mark an upload as complete.
Args:
upload_id (str): The public ID of the upload.
db (AsyncSession): Database session.
queue (ProcessingQueue | None): The processing queue for post-processing.
token (str): The upload token string.
Returns:
UploadRecord: The updated upload record.
"""
record: models.UploadRecord = await _get_upload_record(db, upload_id)
token_row: models.UploadToken = await _ensure_token(db, token_value=token, check_remaining=False)
if record.token_id != token_row.id:
raise HTTPException(status_code=status.HTTP_403_FORBIDDEN, detail="Upload does not belong to this token")
return await _finalize_upload(db, record, queue)
@router.delete("/{upload_id}/cancel", response_model=dict, name="cancel_upload")
async def cancel_upload(
upload_id: str,
db: Annotated[AsyncSession, Depends(get_db)],
token: Annotated[str, Query(description="Upload token")] = ...,
) -> dict[str, Any]:
"""
Cancel an incomplete upload, delete the record, and restore the upload slot.
Args:
upload_id (str): The public ID of the upload.
db (AsyncSession): Database session.
token (str): The upload token string.
Returns:
dict: Confirmation message and remaining uploads.
"""
record: models.UploadRecord = await _get_upload_record(db, upload_id)
token_row: models.UploadToken = await _ensure_token(db, token_value=token, check_remaining=False)
if record.token_id != token_row.id:
raise HTTPException(status_code=status.HTTP_403_FORBIDDEN, detail="Upload does not belong to this token")
if "completed" == record.status:
raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, detail="Cannot cancel completed upload")
path = Path(record.storage_path or "")
if path.exists():
with contextlib.suppress(OSError):
path.unlink()
await db.delete(record)
token_row.uploads_used -= 1
await db.commit()
await db.refresh(token_row)
return {
"message": "Upload cancelled successfully",
"remaining_uploads": token_row.remaining_uploads,
}