Percent-encode commas in download filenames

encodeURI leaves , ; and other reserved characters raw in the RFC 5987
filename* value. A comma in an album title ("Yellow Aster Butte, WA")
makes Chrome see two Content-Disposition headers and fail the download
with ERR_RESPONSE_HEADERS_MULTIPLE_CONTENT_DISPOSITION. Single-asset
downloads had the same bug for original filenames with a comma.

Both call sites now share attachmentDisposition(), which uses
encodeURIComponent plus the attr-char exclusions ' ( ) *.
This commit is contained in:
Adrian Lam
2026-10-03 01:53:48 -04:00
parent aa520b47fc
commit 930d990580
3 changed files with 28 additions and 6 deletions
+2 -2
View File
@@ -12,6 +12,7 @@ import { isVideoAsset, resolveDownloadEndpoint, resolveImageEndpoint } from '../
import { pipeline } from 'stream/promises'
import { readableFromWeb } from '../utils/webStream'
import { log } from '../utils/log'
import { attachmentDisposition } from './download'
/**
* Stream an asset from Immich back to the client.
@@ -104,8 +105,7 @@ export async function assetBuffer (req: IncomingShareRequest, res: Response, ass
const playbackMime = useVideoPlayback
? (data.headers.get('content-type') || '').split(';')[0].trim() || undefined
: undefined
const filename = encodeURI(getFilename(asset, servedSize, playbackMime))
res.setHeader('Content-Disposition', `attachment; filename*=UTF-8''${filename}`)
res.setHeader('Content-Disposition', attachmentDisposition(getFilename(asset, servedSize, playbackMime)))
}
}
headerList.forEach(header => {
+9 -3
View File
@@ -131,9 +131,7 @@ export async function downloadAssets (res: Response, share: SharedLink, assets:
function startZipResponse (res: Response, share: SharedLink, archive: Archiver) {
res.setHeader('Content-Type', 'application/zip')
let filename = (sanitize(title(share)) || 'photos') + '.zip'
filename = encodeURI(filename)
res.setHeader('Content-Disposition', `attachment; filename*=UTF-8''${filename}`)
res.setHeader('Content-Disposition', attachmentDisposition((sanitize(title(share)) || 'photos') + '.zip'))
// Hint to intermediate proxies (Nginx, etc.) not to buffer this response.
res.setHeader('X-Accel-Buffering', 'no')
res.setHeader('Cache-Control', 'no-store')
@@ -246,6 +244,14 @@ function enrichFromHeaders (asset: Asset, response: globalThis.Response): Asset
}
}
export function attachmentDisposition (filename: string): string {
// encodeURI leaves `,` and `;` raw, which split the header: Chrome reads a
// comma as a second Content-Disposition and refuses the download.
const encoded = encodeURIComponent(filename)
.replace(/['()*]/g, c => '%' + c.charCodeAt(0).toString(16).toUpperCase())
return `attachment; filename*=UTF-8''${encoded}`
}
/**
* Extract a filename from a `Content-Disposition` header. Prefers the RFC 5987
* `filename*=UTF-8''...` form (percent-decoded) over the plain `filename=`.
+17 -1
View File
@@ -1,5 +1,5 @@
import { describe, it, expect } from 'vitest'
import { filenameFromContentDisposition } from '../src/stream/download'
import { attachmentDisposition, filenameFromContentDisposition } from '../src/stream/download'
// Used by the zip download path to recover the real filename for album grid
// assets (which arrive without originalFileName) from the /original response.
@@ -23,3 +23,19 @@ describe('filenameFromContentDisposition', () => {
expect(filenameFromContentDisposition(null)).toBeUndefined()
})
})
describe('attachmentDisposition', () => {
it('percent-encodes commas and semicolons so the header stays a single value', () => {
const header = attachmentDisposition('Yellow Aster Butte, WA; day 1.zip')
expect(header).toBe("attachment; filename*=UTF-8''Yellow%20Aster%20Butte%2C%20WA%3B%20day%201.zip")
})
it('percent-encodes the characters RFC 5987 excludes from attr-char', () => {
expect(attachmentDisposition("it's (1)*.jpg")).toBe("attachment; filename*=UTF-8''it%27s%20%281%29%2A.jpg")
})
it('round-trips through filenameFromContentDisposition', () => {
const name = "Photo été, #2 & 'friends' (100%).jpg"
expect(filenameFromContentDisposition(attachmentDisposition(name))).toBe(name)
})
})