Merge PR #281 - fix for video download failure
This commit is contained in:
@@ -61,10 +61,17 @@ function withMimeExtension (filename: string, mime: string | undefined): string
|
||||
* @param asset
|
||||
* @param [servedSize] - what size Immich will actually serve. Defaults to
|
||||
* ImageSize.original (the bytes match the original asset).
|
||||
* @param [servedMimeOverride] - actual MIME of the served bytes when they
|
||||
* differ from the original (a `/video/playback` transcode). Ignored when it
|
||||
* doesn't map to a known extension, so an unrecognised content-type can't
|
||||
* strip the filename's extension.
|
||||
*/
|
||||
export function getFilename (asset: Asset, servedSize: ImageSize = ImageSize.original): string {
|
||||
export function getFilename (asset: Asset, servedSize: ImageSize = ImageSize.original, servedMimeOverride?: string): string {
|
||||
const override = mimeToExt(servedMimeOverride) ? servedMimeOverride : undefined
|
||||
let servedMime: string | undefined
|
||||
if (servedSize === ImageSize.original) {
|
||||
if (override) {
|
||||
servedMime = override
|
||||
} else if (servedSize === ImageSize.original) {
|
||||
servedMime = asset.originalMimeType
|
||||
} else if (servedSize === ImageSize.thumbnail) {
|
||||
servedMime = 'image/webp'
|
||||
@@ -83,7 +90,9 @@ export function getFilename (asset: Asset, servedSize: ImageSize = ImageSize.ori
|
||||
// By default, use the asset's original filename
|
||||
const cleanName = asset.originalFileName ? sanitize(asset.originalFileName) : ''
|
||||
if (!cleanName) return withMimeExtension(asset.id, servedMime)
|
||||
const stem = servedSize === ImageSize.original
|
||||
// Keep the original extension only when the served bytes really are the
|
||||
// original file; a size downgrade or playback transcode replaces it.
|
||||
const stem = servedSize === ImageSize.original && !override
|
||||
? cleanName
|
||||
: cleanName.replace(/\.[a-zA-Z0-9]{2,5}$/, '')
|
||||
return withMimeExtension(stem, servedMime)
|
||||
|
||||
@@ -24,14 +24,12 @@ export interface ImageEndpoint {
|
||||
* listed because Immich doesn't expose a distinct MIME type for them - they
|
||||
* share `image/png` / `image/webp` with their static counterparts.
|
||||
*
|
||||
* Used by both the display path (lightbox preview URL) and the download path
|
||||
* (single-asset download + zip), so the lightbox shows the same bytes the
|
||||
* user gets when they hit "download".
|
||||
* Used by display sizing and by downloads that Immich can serve from the
|
||||
* original endpoint. IPP-forced video downloads have their own playback
|
||||
* fallback in `resolveDownloadEndpoint`.
|
||||
*/
|
||||
export function requiresOriginal (asset: Asset): boolean {
|
||||
if (asset.type === AssetType.video) {
|
||||
return true
|
||||
} else if (asset.originalMimeType?.startsWith('video/')) {
|
||||
if (isVideoAsset(asset)) {
|
||||
return true
|
||||
} else if (asset.originalMimeType === 'image/gif') {
|
||||
return true
|
||||
@@ -39,6 +37,15 @@ export function requiresOriginal (asset: Asset): boolean {
|
||||
return false
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether an asset is a video. Route handlers can coerce `type` from the URL,
|
||||
* while detailed Immich asset responses identify video originals by MIME type;
|
||||
* endpoint selection accepts either signal.
|
||||
*/
|
||||
export function isVideoAsset (asset: Asset): boolean {
|
||||
return asset.type === AssetType.video || !!asset.originalMimeType?.startsWith('video/')
|
||||
}
|
||||
|
||||
/*
|
||||
MIME types a browser can render directly, mirroring Immich's
|
||||
`isWebSupportedImage`. For these the `fullsize` tier resolves to the original
|
||||
@@ -125,6 +132,20 @@ export function resolveImageEndpoint (requested: ImageSize, asset: Asset): Image
|
||||
return endpointFor(served, asset, attachment)
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolve the endpoint for an IPP download. This is usually the same as an
|
||||
* `original` image-size request. The exception is a video on a shared link
|
||||
* whose Immich download permission is off: Immich refuses `/original` with
|
||||
* `asset.download` access, while `/video/playback` can still serve the
|
||||
* transcoded playback file that visitors are allowed to stream.
|
||||
*/
|
||||
export function resolveDownloadEndpoint (asset: Asset, immichAllowsOriginalDownload = true): ImageEndpoint {
|
||||
if (!immichAllowsOriginalDownload && isVideoAsset(asset)) {
|
||||
return { subpath: '/video/playback', attachment: true, servedSize: ImageSize.original }
|
||||
}
|
||||
return resolveImageEndpoint(ImageSize.original, asset)
|
||||
}
|
||||
|
||||
/**
|
||||
* The one place that maps a (clamped) ImageSize onto a concrete Immich path,
|
||||
* and the only place that knows `fullsize` is per-asset.
|
||||
|
||||
+1
-1
@@ -209,7 +209,7 @@ export async function handleShareRequest (req: IncomingShareRequest, res: Respon
|
||||
if ((directImage || directVideo) && !req.password) {
|
||||
// Output the asset directly rather than a gallery page, unless it's a
|
||||
// password-protected link
|
||||
await assetBuffer(req, res, link.assets[0], ImageSize.preview)
|
||||
await assetBuffer(req, res, link.assets[0], ImageSize.preview, link, directVideo)
|
||||
} else {
|
||||
// Show a gallery page
|
||||
const openItem = getConfigOption('ipp.gallery.singleItemAutoOpen', true) ? 1 : 0
|
||||
|
||||
+2
-2
@@ -266,7 +266,7 @@ app.get('/share/:type(photo|video)/:key/:id/:size?', decodeCookie, asyncHandler(
|
||||
}
|
||||
const asset: Asset = {
|
||||
...resolved.asset,
|
||||
type: req.params.type === 'video' ? AssetType.video : AssetType.image
|
||||
type: req.params.type === 'video' ? AssetType.video : resolved.asset.type
|
||||
}
|
||||
|
||||
const request = {
|
||||
@@ -274,7 +274,7 @@ app.get('/share/:type(photo|video)/:key/:id/:size?', decodeCookie, asyncHandler(
|
||||
key: req.params.key,
|
||||
range: req.headers.range || ''
|
||||
}
|
||||
await assetBuffer(request, res, asset, req.params.size)
|
||||
await assetBuffer(request, res, asset, req.params.size, resolved.link, req.params.type === 'video')
|
||||
}))
|
||||
|
||||
/*
|
||||
|
||||
+18
-7
@@ -5,10 +5,10 @@ import {
|
||||
validateImageSize
|
||||
} from '../immich'
|
||||
import { Response } from 'express-serve-static-core'
|
||||
import { Asset, AssetType, ImageSize, IncomingShareRequest } from '../types'
|
||||
import { Asset, ImageSize, IncomingShareRequest, SharedLink } from '../types'
|
||||
import { respondToInvalidRequest } from '../invalidRequestHandler'
|
||||
import { getFilename } from '../gallery/filename'
|
||||
import { resolveImageEndpoint } from '../gallery/sizing'
|
||||
import { isVideoAsset, resolveDownloadEndpoint, resolveImageEndpoint } from '../gallery/sizing'
|
||||
|
||||
/**
|
||||
* Stream an asset from Immich back to the client.
|
||||
@@ -18,7 +18,7 @@ import { resolveImageEndpoint } from '../gallery/sizing'
|
||||
* or locked assets are handled implicitly: Immich's own endpoints refuse
|
||||
* to serve them, and the upstream failure surfaces as a client 404.
|
||||
*/
|
||||
export async function assetBuffer (req: IncomingShareRequest, res: Response, asset: Asset, size?: ImageSize | string) {
|
||||
export async function assetBuffer (req: IncomingShareRequest, res: Response, asset: Asset, size?: ImageSize | string, share?: SharedLink, forceVideoPlayback = false) {
|
||||
const headerList = ['content-type', 'content-length', 'last-modified', 'etag']
|
||||
const fetchHeaders: Record<string, string> = {}
|
||||
let subpath: string
|
||||
@@ -26,8 +26,13 @@ export async function assetBuffer (req: IncomingShareRequest, res: Response, ass
|
||||
let attachment = false
|
||||
let servedSize: ImageSize | undefined
|
||||
|
||||
if (asset.type === AssetType.video) {
|
||||
const requested = validateImageSize(size)
|
||||
const useVideoPlayback = forceVideoPlayback || (isVideoAsset(asset) && requested === ImageSize.original && share?.allowDownload === false)
|
||||
|
||||
if (useVideoPlayback) {
|
||||
subpath = '/video/playback'
|
||||
attachment = requested === ImageSize.original
|
||||
servedSize = ImageSize.original
|
||||
res.setHeader('accept-ranges', 'bytes')
|
||||
// Only chunk when the client sent a Range header. A browser <video>
|
||||
// element does, so playback still streams in 2.5 MB chunks. Clients
|
||||
@@ -43,7 +48,6 @@ export async function assetBuffer (req: IncomingShareRequest, res: Response, ass
|
||||
res.status(206) // Partial Content
|
||||
}
|
||||
} else {
|
||||
const requested = validateImageSize(size)
|
||||
// Album "grid" items arrive without originalMimeType. The fullsize tier
|
||||
// needs it to pick /original (web formats) vs ?size=fullsize (RAW/HEIF), so
|
||||
// fetch the asset detail on demand (cached) before resolving.
|
||||
@@ -51,7 +55,9 @@ export async function assetBuffer (req: IncomingShareRequest, res: Response, ass
|
||||
const detail = await fetchAssetDetail(asset)
|
||||
if (detail?.originalMimeType) asset = { ...asset, originalMimeType: detail.originalMimeType }
|
||||
}
|
||||
const endpoint = resolveImageEndpoint(requested, asset)
|
||||
const endpoint = requested === ImageSize.original
|
||||
? resolveDownloadEndpoint(asset, share?.allowDownload !== false)
|
||||
: resolveImageEndpoint(requested, asset)
|
||||
subpath = endpoint.subpath
|
||||
sizeQueryParam = endpoint.sizeQueryParam
|
||||
attachment = endpoint.attachment
|
||||
@@ -73,7 +79,12 @@ export async function assetBuffer (req: IncomingShareRequest, res: Response, ass
|
||||
}
|
||||
|
||||
if (attachment && asset.originalFileName) {
|
||||
const filename = encodeURI(getFilename(asset, servedSize))
|
||||
// Playback downloads serve Immich's transcode, so the filename extension
|
||||
// must follow the response's content-type, not the original file's.
|
||||
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}`)
|
||||
}
|
||||
headerList.forEach(header => {
|
||||
|
||||
+16
-10
@@ -1,6 +1,6 @@
|
||||
import { assetFetchUrl, authHeadersForAsset } from '../immich'
|
||||
import { Response } from 'express-serve-static-core'
|
||||
import { Asset, ImageSize, SharedLink } from '../types'
|
||||
import { Asset, SharedLink } from '../types'
|
||||
import { getNumericConfigOption } from '../config/access'
|
||||
import { log } from '../utils/log'
|
||||
import archiver, { Archiver } from 'archiver'
|
||||
@@ -10,7 +10,7 @@ import { pipeline } from 'stream/promises'
|
||||
import { promises as fs, createWriteStream } from 'fs'
|
||||
import { tmpdir } from 'os'
|
||||
import { join } from 'path'
|
||||
import { resolveImageEndpoint, ImageEndpoint } from '../gallery/sizing'
|
||||
import { resolveDownloadEndpoint, ImageEndpoint } from '../gallery/sizing'
|
||||
import { title } from '../share'
|
||||
import { getFilename } from '../gallery/filename'
|
||||
import { createLimiter } from '../utils/limiter'
|
||||
@@ -48,7 +48,7 @@ export async function sweepStaleStagingDirs (maxAgeMs = 60 * 60 * 1000) {
|
||||
}
|
||||
}
|
||||
|
||||
type StagedAsset = { tempfile: string, asset: Asset, endpoint: ImageEndpoint }
|
||||
type StagedAsset = { tempfile: string, asset: Asset, endpoint: ImageEndpoint, servedMime?: string }
|
||||
type Failure = { asset: Asset, url: string, status?: number, error?: unknown }
|
||||
type StageOutcome = StagedAsset | { failure: Failure } | null
|
||||
|
||||
@@ -114,7 +114,7 @@ export async function downloadAssets (res: Response, share: SharedLink, assets:
|
||||
})
|
||||
|
||||
try {
|
||||
const stages = stageAssetsToDisk(assets, options, controller.signal)
|
||||
const stages = stageAssetsToDisk(share, assets, options, controller.signal)
|
||||
const failure = await archiveStaged(archive, stages, controller)
|
||||
if (clientGone) {
|
||||
log(`Zip download for share ${share.key} cancelled by client`)
|
||||
@@ -148,9 +148,9 @@ export async function downloadAssets (res: Response, share: SharedLink, assets:
|
||||
* concurrently. Returns the promise array in input order so the consumer can
|
||||
* archive in order.
|
||||
*/
|
||||
function stageAssetsToDisk (assets: Asset[], options: StagingOptions, signal: AbortSignal): Promise<StageOutcome>[] {
|
||||
function stageAssetsToDisk (share: SharedLink, assets: Asset[], options: StagingOptions, signal: AbortSignal): Promise<StageOutcome>[] {
|
||||
const limit = createLimiter(options.concurrency)
|
||||
return assets.map((asset, index) => limit(() => stageOne(asset, index, options, signal)))
|
||||
return assets.map((asset, index) => limit(() => stageOne(share, asset, index, options, signal)))
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -171,7 +171,7 @@ async function archiveStaged (archive: Archiver, stages: Promise<StageOutcome>[]
|
||||
break
|
||||
}
|
||||
// archive.file queues the entry; archiver lazily opens and reads it.
|
||||
archive.file(result.tempfile, { name: getFilename(result.asset, result.endpoint.servedSize) })
|
||||
archive.file(result.tempfile, { name: getFilename(result.asset, result.endpoint.servedSize, result.servedMime) })
|
||||
}
|
||||
|
||||
// After abort, wait for any in-flight stages to settle before we delete
|
||||
@@ -199,10 +199,10 @@ function abortDownload (archive: Archiver, res: Response, share: SharedLink, fai
|
||||
* Returns the staged asset on success, a wrapped Failure on error, or null
|
||||
* if we observed the abort flag and bailed without doing work.
|
||||
*/
|
||||
async function stageOne (asset: Asset, index: number, options: StagingOptions, signal: AbortSignal): Promise<StageOutcome> {
|
||||
async function stageOne (share: SharedLink, asset: Asset, index: number, options: StagingOptions, signal: AbortSignal): Promise<StageOutcome> {
|
||||
if (signal.aborted) return null
|
||||
|
||||
const endpoint = resolveImageEndpoint(ImageSize.original, asset)
|
||||
const endpoint = resolveDownloadEndpoint(asset, share.allowDownload !== false)
|
||||
const url = assetFetchUrl(asset, endpoint.subpath, endpoint.sizeQueryParam)
|
||||
const reqAuthHeaders = await authHeadersForAsset(asset)
|
||||
|
||||
@@ -216,12 +216,18 @@ async function stageOne (asset: Asset, index: number, options: StagingOptions, s
|
||||
// so recover them from the headers we already fetched - no extra calls.
|
||||
const stagedAsset = asset.originalFileName ? asset : enrichFromHeaders(asset, fetched.response)
|
||||
|
||||
// Playback-fallback downloads serve Immich's transcode; carry the response
|
||||
// content-type so the zip entry's extension matches the actual bytes.
|
||||
const servedMime = endpoint.subpath === '/video/playback'
|
||||
? (fetched.response.headers.get('content-type') || '').split(';')[0].trim() || undefined
|
||||
: undefined
|
||||
|
||||
// Use the array index in the path so we never collide on duplicate IDs.
|
||||
const tempfile = join(options.stagingDir, `${index}-${asset.id}`)
|
||||
const streamed = await streamBodyToTempFile(fetched.response, tempfile, options.idleTimeoutMs)
|
||||
if ('failure' in streamed) return { failure: { asset, url, error: streamed.failure } }
|
||||
|
||||
return { tempfile, asset: stagedAsset, endpoint }
|
||||
return { tempfile, asset: stagedAsset, endpoint, servedMime }
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
import { describe, it, expect, vi } from 'vitest'
|
||||
import { AssetType, ImageSize, KeyType } from '../src/types'
|
||||
import type { Asset } from '../src/types'
|
||||
import { getFilename } from '../src/gallery/filename'
|
||||
|
||||
/*
|
||||
getFilename reads `ipp.downloadedFilename` via getConfigOption; mock the
|
||||
config-access module so tests exercise the default (original filename) mode
|
||||
without loading a real config file.
|
||||
*/
|
||||
vi.mock('../src/config/access', () => ({
|
||||
getConfigOption: (_path: string, fallback?: unknown) => fallback
|
||||
}))
|
||||
|
||||
function videoAsset (originalFileName: string, originalMimeType = 'video/x-msvideo'): Asset {
|
||||
return {
|
||||
id: 'asset-id',
|
||||
key: 'k',
|
||||
keyType: KeyType.key,
|
||||
type: AssetType.video,
|
||||
isTrashed: false,
|
||||
originalFileName,
|
||||
originalMimeType
|
||||
}
|
||||
}
|
||||
|
||||
describe('getFilename servedMime override (playback-fallback downloads)', () => {
|
||||
it('swaps the extension to match the transcoded bytes', () => {
|
||||
expect(getFilename(videoAsset('clip.avi'), ImageSize.original, 'video/mp4')).toBe('clip.mp4')
|
||||
expect(getFilename(videoAsset('holiday.MOV', 'video/quicktime'), ImageSize.original, 'video/mp4')).toBe('holiday.mp4')
|
||||
})
|
||||
|
||||
it('keeps the name unchanged when the served mime matches the original', () => {
|
||||
expect(getFilename(videoAsset('clip.mp4', 'video/mp4'), ImageSize.original, 'video/mp4')).toBe('clip.mp4')
|
||||
})
|
||||
|
||||
it('ignores an unrecognised content-type instead of stripping the extension', () => {
|
||||
expect(getFilename(videoAsset('clip.avi'), ImageSize.original, 'application/octet-stream')).toBe('clip.avi')
|
||||
expect(getFilename(videoAsset('clip.avi'), ImageSize.original, undefined)).toBe('clip.avi')
|
||||
})
|
||||
|
||||
it('does not affect ordinary original downloads', () => {
|
||||
expect(getFilename(videoAsset('clip.avi'), ImageSize.original)).toBe('clip.avi')
|
||||
})
|
||||
})
|
||||
@@ -1,7 +1,7 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
||||
import { AssetType, ImageSize } from '../src/types'
|
||||
import type { Asset } from '../src/types'
|
||||
import { resolveImageEndpoint, requiresOriginal } from '../src/gallery/sizing'
|
||||
import { isVideoAsset, resolveDownloadEndpoint, resolveImageEndpoint, requiresOriginal } from '../src/gallery/sizing'
|
||||
|
||||
/*
|
||||
resolveImageEndpoint reads `ipp.maxDownloadQuality` and `ipp.maxZoomQuality`
|
||||
@@ -47,6 +47,14 @@ describe('requiresOriginal', () => {
|
||||
})
|
||||
})
|
||||
|
||||
describe('isVideoAsset', () => {
|
||||
it('accepts either the asset type or the original MIME type as the video signal', () => {
|
||||
expect(isVideoAsset(video)).toBe(true)
|
||||
expect(isVideoAsset(videoMimeImage)).toBe(true)
|
||||
expect(isVideoAsset(jpeg)).toBe(false)
|
||||
})
|
||||
})
|
||||
|
||||
describe('thumbnail - always the grid poster, never clamped', () => {
|
||||
it('serves thumbnail as-is for every asset type', () => {
|
||||
for (const a of [jpeg, heic, gif, video, videoMimeImage]) {
|
||||
@@ -122,3 +130,34 @@ describe('gif / video (requiresOriginal) - always the original file, ceilings by
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
describe('download endpoint', () => {
|
||||
it('keeps videos on /original when Immich allows original downloads', () => {
|
||||
cfg['ipp.maxDownloadQuality'] = 'preview'
|
||||
expect(resolveDownloadEndpoint(video, true)).toEqual({
|
||||
subpath: '/original', attachment: true, servedSize: ImageSize.original
|
||||
})
|
||||
})
|
||||
|
||||
it('falls back to video playback when Immich blocks original downloads', () => {
|
||||
cfg['ipp.maxDownloadQuality'] = 'preview'
|
||||
expect(resolveDownloadEndpoint(video, false)).toEqual({
|
||||
subpath: '/video/playback', attachment: true, servedSize: ImageSize.original
|
||||
})
|
||||
expect(resolveDownloadEndpoint(videoMimeImage, false).subpath).toBe('/video/playback')
|
||||
})
|
||||
|
||||
it('keeps image downloads on the maxDownloadQuality policy', () => {
|
||||
cfg['ipp.maxDownloadQuality'] = 'preview'
|
||||
expect(resolveDownloadEndpoint(jpeg, false)).toEqual({
|
||||
subpath: '/thumbnail', sizeQueryParam: 'preview', attachment: true, servedSize: ImageSize.preview
|
||||
})
|
||||
})
|
||||
|
||||
it('keeps animated image downloads on /original', () => {
|
||||
cfg['ipp.maxDownloadQuality'] = 'preview'
|
||||
expect(resolveDownloadEndpoint(gif, false)).toEqual({
|
||||
subpath: '/original', attachment: true, servedSize: ImageSize.original
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
@@ -66,6 +66,15 @@ Show the download UI - the "download all" zip, the multi-select download, and th
|
||||
|
||||
The bulk-zip and per-asset buttons can be toggled independently once downloads are allowed - see [`gallery.showDownloadZip`](/config/gallery#showdownloadzip) and [`lightbox.showDownload`](/config/lightbox#showdownload).
|
||||
|
||||
> [!NOTE]
|
||||
> With `2`, IPP shows the download UI even on shares whose **own** download toggle in Immich is off - but Immich still refuses to serve those shares' original files, so IPP works around it where it can:
|
||||
>
|
||||
> - **Videos** are downloaded as the transcoded playback file instead of the original (the same stream the visitor can already watch). The filename extension follows the transcoded format, typically `.mp4`.
|
||||
> - **Photos** download normally as long as [`maxDownloadQuality`](#maxdownloadquality) is below `original`; with `maxDownloadQuality: original` they fail, because the original file is exactly what Immich is refusing to serve.
|
||||
> - **Gifs** always download as the original file (their preview is a static frame), so they fail on these shares.
|
||||
>
|
||||
> To guarantee full-quality downloads of everything, leave the share's download permission on in Immich.
|
||||
|
||||
## `downloadFromImmichConcurrencyLimit`
|
||||
|
||||
**Type:** `int` · **Default:** `20`
|
||||
|
||||
Reference in New Issue
Block a user