From fc7670157b51bcc48aa6b0c34665949a394f6439 Mon Sep 17 00:00:00 2001 From: Alan Grainger <16197738+alangrainger@users.noreply.github.com> Date: Tue, 20 Oct 2026 09:28:04 +1300 Subject: [PATCH] Fix issue where custom separator could be the same as a character in the prefix --- app/tsconfig.json | 4 +--- docs/config/upload-service.md | 9 +++++---- docs/tag-and-review-uploads.md | 2 +- shared/tsconfig.json | 4 +--- upload-app/src/config.ts | 4 ++-- upload-app/src/filename.ts | 15 +++++++-------- upload-app/src/tag-uploads.ts | 6 +++--- upload-app/tests/config.test.ts | 2 +- upload-app/tests/filename.test.ts | 19 ++++++++++++------- upload-app/tests/tagUploads.test.ts | 2 ++ upload-app/tsconfig.json | 4 +--- 11 files changed, 36 insertions(+), 35 deletions(-) diff --git a/app/tsconfig.json b/app/tsconfig.json index 6b1cb2d..066691d 100644 --- a/app/tsconfig.json +++ b/app/tsconfig.json @@ -15,9 +15,7 @@ "strictNullChecks": true, "lib": [ "DOM", - "ES5", - "ES6", - "ES7" + "ES2021" ], "allowSyntheticDefaultImports": true, "skipLibCheck": true, diff --git a/docs/config/upload-service.md b/docs/config/upload-service.md index 6c33ca5..49bc3db 100644 --- a/docs/config/upload-service.md +++ b/docs/config/upload-service.md @@ -117,8 +117,8 @@ visitor's own claim; IPP cannot check it. For what to do with it, see **Type:** `string` · **Default:** `","` -The characters that end each visitor field in a stored filename, between the field and the original name, as in -`ipp_upload_jane-smith,IMG_0042.jpg`. The visitor's name is the only field today. The separator is removed from the +The single character that ends each visitor field in a stored filename, between the field and the original name, as +in `ipp_upload_jane-smith,IMG_0042.jpg`. The visitor's name is the only field today. The separator is removed from the visitor's own filename, so it always marks the end of a field. A file sent with no fields has no separator at all. A comma reads naturally, but some people name their photos with one, as in `Venice, Italy.jpg`, and that comma is @@ -134,8 +134,9 @@ lost. If your visitors do, set `"^"`: it is never written by a camera or a phone } ``` -Any punctuation that is legal in a filename works, with one or more characters. A letter, digit, hyphen, dot, space -or a character that is illegal in a filename (`/ ? < > \ : * | "`) is not accepted, and the default is used instead. +Any one punctuation character that is legal in a filename works. More than one character, a letter, digit, hyphen, +dot, space, a character that is illegal in a filename (`/ ? < > \ : * | "`) or a character in +[`filenamePrefix`](#filenameprefix) is not accepted, and the default is used instead. Changing it later leaves the files already stored with the old one. How the filename is read back is explained in [The separator](/tag-and-review-uploads#the-separator). diff --git a/docs/tag-and-review-uploads.md b/docs/tag-and-review-uploads.md index eb4e21c..9e25ee5 100644 --- a/docs/tag-and-review-uploads.md +++ b/docs/tag-and-review-uploads.md @@ -113,7 +113,7 @@ photo, so the script stops unless you pass `--prefix`. | `--apply` | off | Add the tags. Without it, the script only reports. | | `--parent ` | `Uploaded` | The parent tag. `--parent "Guests/Wedding"` gives `Guests/Wedding/jane-smith`. | | `--prefix ` | `upload.filenamePrefix` | The prefix the files were stored with, if it differs from the current setting. | -| `--separator ` | `upload.fieldSeparator` | The separator the files were stored with, if it differs from the current setting. Quote it: `'^'`. | +| `--separator ` | `upload.fieldSeparator` | The separator the files were stored with, if it differs from the current setting. Quote it: `'^'`. | ### Files uploaded with IPP 4.0.0 diff --git a/shared/tsconfig.json b/shared/tsconfig.json index f56fa15..9c63940 100644 --- a/shared/tsconfig.json +++ b/shared/tsconfig.json @@ -17,9 +17,7 @@ "strictNullChecks": true, "lib": [ "DOM", - "ES5", - "ES6", - "ES7" + "ES2021" ], "allowSyntheticDefaultImports": true, "skipLibCheck": true, diff --git a/upload-app/src/config.ts b/upload-app/src/config.ts index f0e1721..5817250 100644 --- a/upload-app/src/config.ts +++ b/upload-app/src/config.ts @@ -41,11 +41,11 @@ export function askName (): boolean { /** * The string that ends each visitor field in a stored filename, from * `ipp.upload.fieldSeparator`. The default when the configured value could be - * part of a field or a filename, see `isUsableSeparator`. + * part of a field or a filename, or is in the prefix, see `isUsableSeparator`. */ export function fieldSeparator (): string { const configured = getConfigOption('ipp.upload.fieldSeparator', DEFAULT_FIELD_SEPARATOR) - return isUsableSeparator(configured) ? configured : DEFAULT_FIELD_SEPARATOR + return isUsableSeparator(configured, filenamePrefix()) ? configured : DEFAULT_FIELD_SEPARATOR } /** Text shown under the placeholder on the upload page, from `ipp.upload.notice`. Empty hides it. */ diff --git a/upload-app/src/filename.ts b/upload-app/src/filename.ts index aeae94f..4dd137c 100644 --- a/upload-app/src/filename.ts +++ b/upload-app/src/filename.ts @@ -25,14 +25,13 @@ const MAX_UPLOADER_LENGTH = 32 export const DEFAULT_FIELD_SEPARATOR = ',' /** - * Whether `separator` can mark the end of a field: a string that `sanitize` - * leaves alone, with no slug character, dot or whitespace in it. A letter, - * digit or hyphen could be part of the name, a dot could be read as the - * extension, and whitespace would be trimmed from the ends of a stem. + * Whether `separator` can end a field: one character, kept by `sanitize`, not + * in `prefix`, and never part of a slug, an extension or a trimmed stem. */ -export function isUsableSeparator (separator: unknown): separator is string { - if (typeof separator !== 'string' || separator === '') return false - if (sanitize(separator) !== separator) return false +export function isUsableSeparator (separator: unknown, prefix: string): separator is string { + // Counted by code point, so an emoji is one character + if (typeof separator !== 'string' || [...separator].length !== 1) return false + if (sanitize(separator) !== separator || storedPrefix(prefix).includes(separator)) return false return !/[\p{L}\p{N}\-.\s]/u.test(separator) } @@ -79,7 +78,7 @@ export function uploadFilename (raw: unknown, prefix: string, uploader = '', sep if (!parts) return undefined const extension = parts[2] // The separator is removed from the visitor's name so it only ever marks a field - const stem = sanitize(parts[1]).split(separator).join('').trim() + const stem = sanitize(parts[1]).replaceAll(separator, '').trim() // An empty stem is a dotfile; a leading dot is a traversal remnant. if (!stem || stem.startsWith('.')) return undefined diff --git a/upload-app/src/tag-uploads.ts b/upload-app/src/tag-uploads.ts index a12062c..22a7cf2 100644 --- a/upload-app/src/tag-uploads.ts +++ b/upload-app/src/tag-uploads.ts @@ -28,12 +28,12 @@ const PERMISSIONS = 'asset.read, user.read, tag.create and tag.asset' const USAGE = `Tag visitor uploads in Immich by the name in their filename. -Usage: node dist/tag-uploads.js [--apply] [--parent ] [--prefix ] [--separator ] +Usage: node dist/tag-uploads.js [--apply] [--parent ] [--prefix ] [--separator ] --apply Add the tags. Without it, only report what would be tagged. --parent Parent tag for the visitor tags. Default "${DEFAULT_PARENT}". --prefix Filename prefix to look for. Default ipp.upload.filenamePrefix. - --separator Field separator to read. Default ipp.upload.fieldSeparator. + --separator Field separator to read. Default ipp.upload.fieldSeparator. IMMICH_API_KEY must hold an API key of the share owner, with the permissions ${PERMISSIONS}.` @@ -235,7 +235,7 @@ export async function main (argv: string[]): Promise { 'Pass --prefix with the prefix the files were stored with.') } const separator = values.separator ?? fieldSeparator() - if (!isUsableSeparator(separator)) return usage('"' + separator + '" cannot be a field separator.') + if (!isUsableSeparator(separator, prefix)) return usage('"' + separator + '" cannot be a field separator with the prefix "' + prefix + '".') const parent = (values.parent ?? DEFAULT_PARENT).split('/').map(part => part.trim()).filter(Boolean).join('/') if (!parent) return usage('The parent tag is empty.') diff --git a/upload-app/tests/config.test.ts b/upload-app/tests/config.test.ts index dd8331f..8fcd473 100644 --- a/upload-app/tests/config.test.ts +++ b/upload-app/tests/config.test.ts @@ -20,7 +20,7 @@ describe('upload options', () => { it('takes a usable field separator, and falls back for one that could be part of a field', () => { setConfig({ ipp: { upload: { fieldSeparator: '^' } } }) expect(fieldSeparator()).toBe('^') - for (const bad of ['', '-', 'a', '.', ' ', '/', 7, null]) { + for (const bad of ['', '-', 'a', '.', ' ', '/', '^^', '_', 7, null]) { setConfig({ ipp: { upload: { fieldSeparator: bad } } }) expect(fieldSeparator()).toBe(',') } diff --git a/upload-app/tests/filename.test.ts b/upload-app/tests/filename.test.ts index 5d1af6d..0985175 100644 --- a/upload-app/tests/filename.test.ts +++ b/upload-app/tests/filename.test.ts @@ -66,7 +66,6 @@ describe('uploadFilename', () => { it('uses the configured separator, and removes that one instead', () => { expect(uploadFilename('IMG_0042.jpg', 'ipp_upload_', 'jane-smith', '^')).toBe('ipp_upload_jane-smith^IMG_0042.jpg') expect(uploadFilename('Paris, France^2.jpg', 'ipp_upload_', 'jane-smith', '^')).toBe('ipp_upload_jane-smith^Paris, France2.jpg') - expect(uploadFilename('IMG_0042.jpg', 'ipp_upload_', 'jane-smith', '~~')).toBe('ipp_upload_jane-smith~~IMG_0042.jpg') }) it('stays within 254 characters with the extension intact', () => { @@ -113,14 +112,20 @@ describe('uploaderSlug', () => { describe('isUsableSeparator', () => { it('accepts punctuation that sanitize keeps', () => { - for (const separator of ['^', ',', '~', '#', '+', '^^', '~,']) expect(isUsableSeparator(separator)).toBe(true) + for (const separator of ['^', ',', '~', '#', '+']) expect(isUsableSeparator(separator, 'ipp_upload_')).toBe(true) }) - it('rejects anything that could be part of a name or a filename, or is not a string', () => { - for (const separator of ['', 'a', '1', '-', '.', ' ', 'x^', '^ ', '/', ':', '*', '"', '\u0000', 'ñ', '٣']) { - expect(isUsableSeparator(separator)).toBe(false) + it('rejects more than one character, anything that could be part of a name or a filename, or a non-string', () => { + for (const separator of ['', 'a', '1', '-', '.', ' ', 'x^', '^ ', '/', ':', '*', '"', '\u0000', 'ñ', '٣', '^^', '~,', '#!']) { + expect(isUsableSeparator(separator, 'ipp_upload_')).toBe(false) } - expect(isUsableSeparator(undefined)).toBe(false) - expect(isUsableSeparator(1)).toBe(false) + expect(isUsableSeparator(undefined, 'ipp_upload_')).toBe(false) + expect(isUsableSeparator(1, 'ipp_upload_')).toBe(false) + }) + + it('rejects a character in the prefix, which would hide the prefix from the stacking check', () => { + expect(isUsableSeparator('_', 'ipp_upload_')).toBe(false) + expect(isUsableSeparator(',', 'ipp,upload ')).toBe(false) + expect(isUsableSeparator('_', 'ipp-upload-')).toBe(true) }) }) diff --git a/upload-app/tests/tagUploads.test.ts b/upload-app/tests/tagUploads.test.ts index 377f02d..8f4a711 100644 --- a/upload-app/tests/tagUploads.test.ts +++ b/upload-app/tests/tagUploads.test.ts @@ -202,6 +202,8 @@ describe('main', () => { it('refuses an unknown flag or an unusable separator', async () => { expect(await main(['--aply'])).toBe(2) expect(await main(['--separator', '-'])).toBe(2) + expect(await main(['--separator', '_'])).toBe(2) + expect(errors[errors.length - 1]).toMatch(/with the prefix "ipp_upload_"/) }) it('reads the separator from config, and exits 1 on an Immich error', async () => { diff --git a/upload-app/tsconfig.json b/upload-app/tsconfig.json index 6b1cb2d..066691d 100644 --- a/upload-app/tsconfig.json +++ b/upload-app/tsconfig.json @@ -15,9 +15,7 @@ "strictNullChecks": true, "lib": [ "DOM", - "ES5", - "ES6", - "ES7" + "ES2021" ], "allowSyntheticDefaultImports": true, "skipLibCheck": true,