High performance self-hosted photo and video management solution.
TypeScript backup-toolfluttergoogle-photosgoogle-photos-alternativejavascriptmobile-appnestjsnodejsphoto-galleryphotosphotos-managementself-hostedsveltesveltekittypescriptvideos
fix(web): download archives via html POST forms (#30021)
Diogo Correiac9776fb99087
diff --git a/i18n/en.json b/i18n/en.jsonindex 57a8ae9503..32be9d6c78 100644--- a/i18n/en.json+++ b/i18n/en.json@@ -900,7 +900,9 @@"download_settings_description": "Manage settings related to asset download","download_waiting_to_retry": "Waiting to retry","downloading": "Downloading",+ "downloading_archive_filename_size": "Downloading archive {filename} (approximately {size})","downloading_asset_filename": "Downloading asset {filename}",+ "downloading_filename": "Downloading {filename}","downloading_from_icloud": "Downloading from iCloud","downloading_media": "Downloading media","drag_to_reorder": "Drag to reorder",@@ -1676,6 +1678,7 @@"port": "Port","preferences_settings_subtitle": "Manage the app's preferences","preferences_settings_title": "Preferences",+ "prepared_archives": "Prepared Archives","preparing": "Preparing","preset": "Preset","preview": "Preview",@@ -1815,6 +1818,7 @@"result": "Result","resume": "Resume","resume_paused_jobs": "Resume {count, plural, one {# paused job} other {# paused jobs}}",+ "retry": "Retry","review_duplicates": "Review duplicates","review_large_files": "Review large files","role": "Role",diff --git a/open-api/immich-openapi-specs.json b/open-api/immich-openapi-specs.jsonindex 2d471be154..4322e843df 100644--- a/open-api/immich-openapi-specs.json+++ b/open-api/immich-openapi-specs.json@@ -20799,6 +20799,10 @@},"DownloadArchiveDto": {"properties": {+ "archiveName": {+ "description": "The name of the archive to download, without extension",+ "type": "string"+ },"assetIds": {"description": "Asset IDs","items": {diff --git a/packages/sdk/src/fetch-client.ts b/packages/sdk/src/fetch-client.tsindex e511b4d589..d562f6877c 100644--- a/packages/sdk/src/fetch-client.ts+++ b/packages/sdk/src/fetch-client.ts@@ -1602,6 +1602,8 @@ export type UserConfigDto = {user: UserConfigUserDto;};export type DownloadArchiveDto = {+ /** The name of the archive to download, without extension */+ archiveName?: string;/** Asset IDs */assetIds: string[];/** Download edited asset if available */diff --git a/server/src/controllers/download.controller.spec.ts b/server/src/controllers/download.controller.spec.tsnew file mode 100644index 0000000000..ce3768895b--- /dev/null+++ b/server/src/controllers/download.controller.spec.ts@@ -0,0 +1,48 @@+import { Readable } from 'node:stream';+import { DownloadController } from 'src/controllers/download.controller';+import { DownloadService } from 'src/services/download.service';+import request from 'supertest';+import { factory } from 'test/small.factory';+import { ControllerContext, controllerSetup, mockBaseService } from 'test/utils';++describe(DownloadController.name, () => {+ let ctx: ControllerContext;+ const service = mockBaseService(DownloadService);++ beforeAll(async () => {+ ctx = await controllerSetup(DownloadController, [{ provide: DownloadService, useValue: service }]);+ return () => ctx.close();+ });++ beforeEach(() => {+ service.resetAllMocks();+ ctx.reset();+ });++ describe('POST /download/archive', () => {+ it('should accept comma-separated assetIds string', async () => {+ const downloadArchiveSpy = vi.spyOn(service, 'downloadArchive');+ service.downloadArchive.mockResolvedValue({ stream: Readable.from('') });++ const ids = [factory.uuid(), factory.uuid()];+ const { status } = await request(ctx.getHttpServer())+ .post(`/download/archive`)+ .type('form')+ .send({ assetIds: ids.join(',') });+ expect(status).toBe(200);+ expect(downloadArchiveSpy).toHaveBeenCalledWith(undefined, { assetIds: ids });+ });++ it('should accept assetIds array', async () => {+ const downloadArchiveSpy = vi.spyOn(service, 'downloadArchive');+ service.downloadArchive.mockResolvedValue({ stream: Readable.from('') });++ const ids = [factory.uuid(), factory.uuid()];+ const { status } = await request(ctx.getHttpServer()).post(`/download/archive`).send({+ assetIds: ids,+ });+ expect(status).toBe(200);+ expect(downloadArchiveSpy).toHaveBeenCalledWith(undefined, { assetIds: ids });+ });+ });+});diff --git a/server/src/dtos/download.dto.ts b/server/src/dtos/download.dto.tsindex c37fa5c113..fd61557d0c 100644--- a/server/src/dtos/download.dto.ts+++ b/server/src/dtos/download.dto.ts@@ -1,5 +1,4 @@import { createZodDto } from 'nestjs-zod';-import { AssetIdsSchema } from 'src/dtos/asset.dto';import z from 'zod';const DownloadInfoSchema = z@@ -25,9 +24,29 @@ const DownloadResponseSchema = z}).meta({ id: 'DownloadResponseDto' });-const DownloadArchiveSchema = AssetIdsSchema.extend({- edited: z.boolean().optional().describe('Download edited asset if available'),-}).meta({ id: 'DownloadArchiveDto' });+const DownloadArchiveSchema = z+ .object({+ // Support receiving assetIds as a comma-separated string due to POST form submission.+ // While we can send arrays, the total request parameter count is limited to 1000 fields,+ // which would limit this DTO to a maximum of 1000 assets.+ assetIds: z+ .preprocess((val) => (typeof val === 'string' ? val.split(',') : val), z.array(z.uuidv4()))+ .describe('Asset IDs'),+ edited: z+ .preprocess((val) => {+ if (val === 'true') {+ return true;+ }+ if (val === 'false') {+ return false;+ }+ return val;+ }, z.boolean())+ .optional()+ .describe('Download edited asset if available'),+ archiveName: z.string().optional().describe('The name of the archive to download, without extension'),+ })+ .meta({ id: 'DownloadArchiveDto' });export class DownloadInfoDto extends createZodDto(DownloadInfoSchema) {}export class DownloadResponseDto extends createZodDto(DownloadResponseSchema) {}diff --git a/server/src/repositories/storage.repository.ts b/server/src/repositories/storage.repository.tsindex 9604372fbe..7ee74d9870 100644--- a/server/src/repositories/storage.repository.ts+++ b/server/src/repositories/storage.repository.ts@@ -31,6 +31,7 @@ export interface WatchEvents {export interface ImmichReadStream {stream: Readable;type?: string;+ disposition?: string | string[];length?: number;}diff --git a/server/src/services/download.service.ts b/server/src/services/download.service.tsindex 3dc9c0dd03..c73da19543 100644--- a/server/src/services/download.service.ts+++ b/server/src/services/download.service.ts@@ -117,6 +117,9 @@ export class DownloadService extends BaseService {void zip.finalize();- return { stream: zip.stream };+ return {+ stream: zip.stream,+ disposition: dto.archiveName && `attachment; filename*=UTF-8''${encodeURIComponent(dto.archiveName)}.zip`,+ };}}diff --git a/server/src/utils/file.ts b/server/src/utils/file.tsindex 24d555f2fe..df3a0ce3e9 100644--- a/server/src/utils/file.ts+++ b/server/src/utils/file.ts@@ -86,6 +86,6 @@ export const sendFile = async (}};-export const asStreamableFile = ({ stream, type, length }: ImmichReadStream) => {- return new StreamableFile(stream, { type, length });+export const asStreamableFile = ({ stream, type, disposition, length }: ImmichReadStream) => {+ return new StreamableFile(stream, { type, disposition, length });};diff --git a/web/src/lib/components/album-page/AlbumViewer.svelte b/web/src/lib/components/album-page/AlbumViewer.svelteindex 7f294e2c20..2f1b43aee3 100644--- a/web/src/lib/components/album-page/AlbumViewer.svelte+++ b/web/src/lib/components/album-page/AlbumViewer.svelte@@ -101,7 +101,7 @@<AssetSelectControlBar><SelectAllAssets {timelineManager} assetInteraction={assetMultiSelectManager} />{#if sharedLink.allowDownload}- <DownloadAction filename="{album.albumName}.zip" />+ <DownloadAction filename={album.albumName} />{/if}</AssetSelectControlBar>{:else}diff --git a/web/src/lib/components/share-page/IndividualSharedViewer.svelte b/web/src/lib/components/share-page/IndividualSharedViewer.svelteindex a119f4ffea..7e7f056e1f 100644--- a/web/src/lib/components/share-page/IndividualSharedViewer.svelte+++ b/web/src/lib/components/share-page/IndividualSharedViewer.svelte@@ -44,7 +44,7 @@});const downloadAssets = async () => {- await downloadArchive(`immich-shared.zip`, { assetIds: assets.map((asset) => asset.id) });+ await downloadArchive(`immich-shared`, { assetIds: assets.map((asset) => asset.id) });};const handleUploadAssets = async (files: File[] = []) => {@@ -93,7 +93,7 @@onclick={handleSelectAll}/>{#if sharedLink?.allowDownload}- <DownloadAction filename="immich-shared.zip" />+ <DownloadAction filename="immich-shared" />{/if}{#if isOwned}<RemoveFromSharedLink bind:sharedLink />diff --git a/web/src/lib/components/timeline/actions/DownloadAction.svelte b/web/src/lib/components/timeline/actions/DownloadAction.svelteindex 43916c2165..b1b683ca28 100644--- a/web/src/lib/components/timeline/actions/DownloadAction.svelte+++ b/web/src/lib/components/timeline/actions/DownloadAction.svelte@@ -16,7 +16,7 @@menuItem?: boolean;}- let { filename = 'immich.zip', menuItem = false }: Props = $props();+ let { filename = 'immich', menuItem = false }: Props = $props();const handleDownloadFiles = async () => {const assets = assetMultiSelectManager.assets;diff --git a/web/src/lib/managers/download-manager.svelte.ts b/web/src/lib/managers/download-manager.svelte.tsindex f08e5eb929..5ff0dfccb1 100644--- a/web/src/lib/managers/download-manager.svelte.ts+++ b/web/src/lib/managers/download-manager.svelte.ts@@ -1,44 +1,31 @@-export interface DownloadProgress {- progress: number;+import { SvelteMap } from 'svelte/reactivity';++export interface DownloadState {+ url: string;+ assetIds: string[];+ archiveName: string;total: number;- percentage: number;- abort: AbortController | null;+ downloaded: boolean;}class DownloadManager {- assets = $state<Record<string, DownloadProgress>>({});-- isDownloading = $derived(Object.keys(this.assets).length > 0);-- #update(key: string, value: Partial<DownloadProgress> | null) {- if (value === null) {- delete this.assets[key];- return;- }+ assets = new SvelteMap<string, DownloadState>();- if (!Object.hasOwn(this.assets, key)) {- this.assets[key] = { progress: 0, total: 0, percentage: 0, abort: null };- }-- const item = this.assets[key];- Object.assign(item, value);- item.percentage = Math.min(Math.floor((item.progress / item.total) * 100), 100);- }+ isDownloading = $derived(this.assets.size > 0);- add(key: string, total: number, abort?: AbortController) {- this.#update(key, { total, abort });+ add(key: string, url: string, assetIds: string[], archiveName: string, total: number) {+ this.assets.set(key, { url, assetIds, archiveName, total, downloaded: false });}- clear(key: string) {- this.#update(key, null);+ clearAll() {+ this.assets.clear();}- update(key: string, progress: number, total?: number) {- const download: Partial<DownloadProgress> = { progress };- if (total !== undefined) {- download.total = total;+ markDownloaded(key: string) {+ const state = this.assets.get(key);+ if (state) {+ this.assets.set(key, { ...state, downloaded: true });}- this.#update(key, download);}}diff --git a/web/src/lib/services/album.service.ts b/web/src/lib/services/album.service.tsindex 08b1245e66..824c4fbb5b 100644--- a/web/src/lib/services/album.service.ts+++ b/web/src/lib/services/album.service.ts@@ -284,5 +284,5 @@ export const handleDeleteAlbum = async (album: AlbumResponseDto, options?: { pro};export const handleDownloadAlbum = async (album: AlbumResponseDto) => {- await downloadArchive(`${album.albumName}.zip`, { albumId: album.id });+ await downloadArchive(album.albumName, { albumId: album.id });};diff --git a/web/src/lib/utils.ts b/web/src/lib/utils.tsindex 3aecb5df59..43f99df30d 100644--- a/web/src/lib/utils.ts+++ b/web/src/lib/utils.ts@@ -24,7 +24,6 @@ import { init, register, t } from 'svelte-i18n';import { derived, get } from 'svelte/store';import { defaultLang, locales } from '$lib/constants';import { authManager } from '$lib/managers/auth-manager.svelte';-import { downloadManager } from '$lib/managers/download-manager.svelte';import { alwaysLoadOriginalFile, lang } from '$lib/stores/preferences.store';import { isWebCompatibleImage } from '$lib/utils/asset-utils';import { handleError } from '$lib/utils/handle-error';@@ -293,15 +292,38 @@ export const downloadUrl = (url: string, filename: string) => {URL.revokeObjectURL(url);};+export const downloadUrlPost = (url: string, assetIds: string[], archiveName: string) => {+ const form = document.createElement('form');+ form.method = 'post';+ form.action = url;+ form.target = '_blank';++ function mkInput(name: string, value: string) {+ const input = document.createElement('input');+ input.type = 'hidden';+ input.name = name;+ input.value = value;+ form.append(input);+ }++ mkInput('assetIds', assetIds.join(','));+ mkInput('archiveName', archiveName);+ mkInput('edited', 'true');++ document.body.append(form);+ form.submit();+ form.remove();+};+export const downloadBlob = (data: Blob, filename: string) => downloadUrl(URL.createObjectURL(data), filename);export const downloadJson = (data: unknown, filename: string) => {const blob = new Blob([JSON.stringify(data, jsonReplacer, 2)], { type: 'application/json' });const downloadKey = filename;- downloadManager.add(downloadKey, blob.size);- downloadManager.update(downloadKey, blob.size);downloadBlob(blob, downloadKey);- setTimeout(() => downloadManager.clear(downloadKey), 5000);++ const $t = get(t);+ toastManager.info($t('downloading_filename', { values: { filename } }));};export const oauth = {diff --git a/web/src/lib/utils/asset-utils.ts b/web/src/lib/utils/asset-utils.tsindex 5b8de3cfb0..5918137fd3 100644--- a/web/src/lib/utils/asset-utils.ts+++ b/web/src/lib/utils/asset-utils.ts@@ -27,7 +27,8 @@ import { downloadManager } from '$lib/managers/download-manager.svelte';import { eventManager } from '$lib/managers/event-manager.svelte';import { TimelineManager } from '$lib/managers/timeline-manager/timeline-manager.svelte';import type { TimelineAsset } from '$lib/managers/timeline-manager/types';-import { downloadBlob, downloadRequest, withError } from '$lib/utils';+import { locale } from '$lib/stores/preferences.store';+import { downloadUrlPost, withError } from '$lib/utils';import { getByteUnitString } from '$lib/utils/byte-units';import { getFormatter } from '$lib/utils/i18n';import { navigate } from '$lib/utils/navigation';@@ -92,7 +93,7 @@ export const downloadArchive = async (fileName: string, options: Omit<DownloadInfor (let index = 0; index < downloadInfo.archives.length; index++) {const archive = downloadInfo.archives[index];const suffix = downloadInfo.archives.length > 1 ? `+${index + 1}` : '';- const archiveName = fileName.replace('.zip', () => `${suffix}-${DateTime.now().toFormat('yyyyLLdd_HHmmss')}.zip`);+ const archiveName = `${fileName}${suffix}-${DateTime.now().toFormat('yyyyLLdd_HHmmss')}`;const queryParams = asQueryString(authManager.params);const downloadKey =@@ -100,27 +101,26 @@ export const downloadArchive = async (fileName: string, options: Omit<DownloadIn? `${archiveName} (${index + 1}/${downloadInfo.archives.length})`: `${archiveName} `;- const abort = new AbortController();- downloadManager.add(downloadKey, archive.size, abort);+ const url = getBaseUrl() + '/download/archive' + (queryParams ? `?${queryParams}` : '');try {- // TODO use sdk once it supports progress events- const { data } = await downloadRequest({- method: 'POST',- url: getBaseUrl() + '/download/archive' + (queryParams ? `?${queryParams}` : ''),- data: { assetIds: archive.assetIds, edited: true },- signal: abort.signal,- onDownloadProgress: (event) => downloadManager.update(downloadKey, event.loaded),- });-- downloadBlob(data, archiveName);+ if (downloadInfo.archives.length > 1) {+ downloadManager.add(downloadKey, url, archive.assetIds, archiveName, archive.size);+ } else {+ downloadUrlPost(url, archive.assetIds, archiveName);+ const $t = await getFormatter();+ const $locale = get(locale);+ toastManager.primary(+ $t('downloading_archive_filename_size', {+ values: { size: getByteUnitString(archive.size, $locale), filename: archiveName },+ }),+ { timeout: 10_000 },+ );+ }} catch (error) {const $t = get(t);handleError(error, $t('errors.unable_to_download_files'));- downloadManager.clear(downloadKey);return;- } finally {- setTimeout(() => downloadManager.clear(downloadKey), 5000);}}};diff --git a/web/src/routes/(user)/albums/[albumId=id]/[[photos=photos]]/[[assetId=id]]/+page.svelte b/web/src/routes/(user)/albums/[albumId=id]/[[photos=photos]]/[[assetId=id]]/+page.svelteindex 8f674f13c0..3b3b598e39 100644--- a/web/src/routes/(user)/albums/[albumId=id]/[[photos=photos]]/[[assetId=id]]/+page.svelte+++ b/web/src/routes/(user)/albums/[albumId=id]/[[photos=photos]]/[[assetId=id]]/+page.svelte@@ -473,7 +473,7 @@></FavoriteAction>{/if}<ButtonContextMenu icon={mdiDotsVertical} title={$t('menu')} offset={{ x: 175, y: 25 }}>- <DownloadAction menuItem filename="{album.albumName}.zip" />+ <DownloadAction menuItem filename={album.albumName} />{#if assetMultiSelectManager.isAllUserOwned}<ChangeDate menuItem /><ChangeDescription menuItem />diff --git a/web/src/routes/(user)/people/[personId]/[[photos=photos]]/[[assetId=id]]/+page.svelte b/web/src/routes/(user)/people/[personId]/[[photos=photos]]/[[assetId=id]]/+page.svelteindex e4389f09dc..7996f1655f 100644--- a/web/src/routes/(user)/people/[personId]/[[photos=photos]]/[[assetId=id]]/+page.svelte+++ b/web/src/routes/(user)/people/[personId]/[[photos=photos]]/[[assetId=id]]/+page.svelte@@ -472,7 +472,7 @@onFavorite={(ids, isFavorite) => timelineManager.update(ids, (asset) => (asset.isFavorite = isFavorite))}/><ButtonContextMenu icon={mdiDotsVertical} title={$t('menu')}>- <DownloadAction menuItem filename="{person.name || 'immich'}.zip" />+ <DownloadAction menuItem filename={person.name || 'immich'} /><MenuOptionicon={mdiAccountMultipleCheckOutline}text={$t('fix_incorrect_match')}diff --git a/web/src/routes/DownloadPanel.svelte b/web/src/routes/DownloadPanel.svelteindex 6931148f30..82425ccab2 100644--- a/web/src/routes/DownloadPanel.svelte+++ b/web/src/routes/DownloadPanel.svelte@@ -1,55 +1,52 @@<script lang="ts">- import { type DownloadProgress, downloadManager } from '$lib/managers/download-manager.svelte';+ import { type DownloadState, downloadManager } from '$lib/managers/download-manager.svelte';import { locale } from '$lib/stores/preferences.store';- import { Heading, IconButton } from '@immich/ui';- import { mdiClose } from '@mdi/js';+ import { CloseButton, Heading, IconButton } from '@immich/ui';+ import { mdiReload, mdiDownload } from '@mdi/js';import { t } from 'svelte-i18n';import { fly, slide } from 'svelte/transition';import { getByteUnitString } from '$lib/utils/byte-units';+ import { downloadUrlPost } from '$lib/utils';- const abort = (downloadKey: string, download: DownloadProgress) => {- download.abort?.abort();- downloadManager.clear(downloadKey);+ const startDownload = (downloadKey: string, download: DownloadState) => {+ downloadUrlPost(download.url, download.assetIds, download.archiveName);+ downloadManager.markDownloaded(downloadKey);+ };++ const closePanel = () => {+ downloadManager.clearAll();};</script>{#if downloadManager.isDownloading}<divtransition:fly={{ x: -100, duration: 350 }}- class="fixed inset-s-2 bottom-10 z-60 max-h-67.5 w-79 rounded-2xl border bg-subtle p-4 shadow-lg dark:border-white/10"+ class="fixed inset-s-2 bottom-10 z-60 max-h-67.5 w-89 rounded-2xl border bg-subtle p-4 shadow-lg dark:border-white/10">- <Heading size="tiny">{$t('downloading')}</Heading>+ <div class="flex items-center justify-between gap-2">+ <Heading size="tiny">{$t('prepared_archives')}</Heading>+ <CloseButton class="w-8" size="small" onclick={closePanel} />+ </div><div class="my-2 mb-2 flex max-h-50 flex-col overflow-y-auto text-sm">- {#each Object.keys(downloadManager.assets) as downloadKey (downloadKey)}- {@const download = downloadManager.assets[downloadKey]}- <div class="mb-2 flex place-items-center" transition:slide>- <div class="w-full pe-10">+ {#each downloadManager.assets as [downloadKey, download] (downloadKey)}+ <div class="mb-2 flex place-items-center gap-2" transition:slide>+ <div class="min-w-0 grow"><div class="flex place-items-center justify-between gap-2 text-xs font-medium"><p class="truncate">{downloadKey}</p>{#if download.total}<p class="whitespace-nowrap">{getByteUnitString(download.total, $locale)}</p>{/if}</div>- <div class="flex place-items-center gap-2">- <div class="h-2.5 w-full rounded-full bg-neutral-200 dark:bg-neutral-600">- <div class="h-2.5 rounded-full bg-primary" style={`width: ${download.percentage}%`}></div>- </div>- <p class="min-w-16 text-right whitespace-nowrap">- <span class="text-primary">- {(download.percentage / 100).toLocaleString($locale, { style: 'percent' })}- </span>- </p>- </div></div>- <div class="absolute inset-e-4">+ <div class="w-8"><IconButtoncolor="secondary"variant="outline"shape="round"- aria-label={$t('close')}- onclick={() => abort(downloadKey, download)}+ aria-label={$t(download.downloaded ? 'retry' : 'download')}+ onclick={() => startDownload(downloadKey, download)}size="tiny"- icon={mdiClose}+ icon={download.downloaded ? mdiReload : mdiDownload}/></div></div>