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 · examples/views/store_files.py · sjs:store-files.server
View on GitHub
# POST /api/files — store uploads, return their ids in the same order
def upload(request: HttpRequest) -> JsonResponse:
# Field "files[]", the name on every platform. Not request.FILES["files[]"]: that is only the last file
files = request.FILES.getlist("files[]")
if not files:
return JsonResponse({"error": 'Upload one or more files in a field named "files[]"'}, status=422)
types = [detect_type(file.read(4096)) for file in files] # by the bytes, never the client's type
for file, type in zip(files, types): # check the whole batch before storing any
if file.size > MAX_BYTES:
return JsonResponse({"error": "Each file must be 5 MB or less"}, status=422)
if type not in TYPES:
return JsonResponse({"error": f"{file.name} is not a PNG, JPEG, WebP, GIF or PDF file"}, status=422)
storage, ids = uploads(request), []
for file, type in zip(files, types):
id = str(uuid.uuid4())
storage.save(id, file) # named by id, never by the client
File.objects.create(id=id, name=file.name, type=type)
ids.append(id)
return JsonResponse(ids, safe=False)
Server · examples/views/store_files.py · sjs:store-files.download
View on GitHub
# GET /api/files/<id> — the content, for private files only; check access first
def download(request: HttpRequest, file_id: str) -> FileResponse | JsonResponse:
file = File.objects.filter(id=file_id).first()
if file is None or not can_read_file(request.user, file):
return JsonResponse({"error": "Not found"}, status=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(uploads(request).open(file.id), content_type=file.type,
headers={"X-Content-Type-Options": "nosniff", "Content-Security-Policy": "sandbox"})