Upload a file to compare response sizes.
JSON definition · shared/definitions/store-files.json
View on GitHub
{
"title": "Expense report",
"completeText": "Submit expense report",
"elements": [
{
"type": "text",
"name": "purpose",
"title": "Purpose of the expense",
"isRequired": true
},
{
"type": "file",
"name": "receipt",
"title": "Receipts",
"storeDataAsText": false,
"allowMultiple": true,
"maxSize": 5242880,
"acceptedTypes": "image/png,image/jpeg,image/webp,image/gif,application/pdf",
"isRequired": true,
"waitForUpload": true,
"description": "PNG, JPEG, WebP, GIF, or PDF files up to 5 MB each"
}
]
}
Client · shared/client/store-files.js · sjs:store-files.client
View on GitHub
// Upload: your server stores the files and returns an id (or a URL) for each
survey.onUploadFiles.add(async (_, options) => {
const body = new FormData();
options.files.forEach(file => body.append("files[]", file)); // "files[]": PHP keeps only the last of several "files"
const response = await fetch("/api/files", { method: "POST", body }).catch(() => null);
const ids = response?.ok ? await response.json().catch(() => null) : null;
if (!Array.isArray(ids) || ids.length !== options.files.length || ids.some(id => typeof id !== "string" || !id)) {
return options.callback([], ["Couldn't upload files. Please try again."]);
}
// The response stores these ids, not the file contents
options.callback(options.files.map((file, i) => ({ file, content: ids[i] })));
});
Client · shared/client/store-files.js · sjs:store-files.preview
View on GitHub
// Preview: only when the stored value is not a public URL the browser can open
survey.onDownloadFile.add(async (_, options) => {
try {
const res = await fetch(`/api/files/${encodeURIComponent(options.content)}`);
if (!res.ok) throw new Error("Preview unavailable");
const reader = new FileReader();
reader.onload = () => options.callback("success", reader.result);
reader.onerror = () => options.callback("error");
reader.readAsDataURL(await res.blob());
} catch {
options.callback("error");
show("file-status", "Couldn't load the preview. The file may be missing or inaccessible.");
}
});
Server · app/routes/store_files.py · sjs:store-files.server
View on GitHub
# POST /api/files — store uploads, return their ids in the same order
@router.post("/api/files")
async def store_files(request: Request, db: Db, files_dir: FilesDir) -> list[str]:
async with request.form(max_files=20, max_fields=20) as form: # closes the spooled uploads afterwards
# Field "files[]", the name on every platform: PHP keeps only the last of several fields named "files"
files = [f for f in form.getlist("files[]") if isinstance(f, UploadFile)]
if not files:
raise HTTPException(422, 'Upload one or more files in a field named "files[]"')
uploads = [(f, await f.read(MAX_BYTES + 1)) for f in files] # check the whole batch before storing any
for file, content in uploads:
if len(content) > MAX_BYTES:
raise HTTPException(422, "Each file must be 5 MB or less")
if detect_type(content) not in TYPES: # by the bytes, never the client's type
raise HTTPException(422, f"{file.filename} is not a PNG, JPEG, WebP, GIF or PDF file")
ids = []
for file, content in uploads:
id = str(uuid.uuid4()) # named by id, never by the client
(files_dir / id).write_bytes(content)
db.execute("INSERT INTO files (id, name, type) VALUES (?, ?, ?)", (id, file.filename, detect_type(content)))
ids.append(id)
return ids
Server · app/routes/store_files.py · sjs:store-files.download
View on GitHub
# GET /api/files/{id} — the content, for private files only; check access first
@router.get("/api/files/{id}")
def download_file(id: str, user: CurrentUser, db: Db, files_dir: FilesDir) -> FileResponse:
file = db.execute("SELECT id, name, type FROM files WHERE id = ?", (id,)).fetchone()
if file is None or not can_read_file(user, file):
raise HTTPException(404) # 404, not 403: don't confirm the file exists
# nosniff and sandbox: an uploaded HTML or SVG never runs as this site
return FileResponse(files_dir / file["id"], media_type=file["type"],
headers={"X-Content-Type-Options": "nosniff", "Content-Security-Policy": "sandbox"})