From 00fc97c57096d4ad8ae4f9841c1dcc12ebb6588e Mon Sep 17 00:00:00 2001 From: arabcoders Date: Thu, 7 Aug 2025 23:03:34 +0300 Subject: [PATCH] working version of custom fields. --- app/library/dl_fields.py | 10 +++++ ui/app/components/DLFields.vue | 75 ++++++++++++++++++++++--------- ui/app/components/NewDownload.vue | 50 ++++++++++++++++----- ui/app/types/dl_fields.d.ts | 6 +++ 4 files changed, 109 insertions(+), 32 deletions(-) diff --git a/app/library/dl_fields.py b/app/library/dl_fields.py index 34281b01..15ee8fdc 100644 --- a/app/library/dl_fields.py +++ b/app/library/dl_fields.py @@ -70,6 +70,12 @@ class DLField: kind: FieldType = FieldType.TEXT """The kind of the field. i.e. string, bool""" + icon: str = "" + """The icon of the field, it can be a font-awesome icon""" + + order: int = 0 + """The order of the field, used to sort the fields in the UI.""" + value: str = "" """The default value of the field, It's currently unused.""" @@ -254,6 +260,10 @@ class DLFields(metaclass=Singleton): msg = "Value must be a string." raise ValueError(msg) + if item.get("order") is not None and not isinstance(item.get("order"), int): + msg = "Order must be an integer." + raise ValueError(msg) + if not isinstance(item.get("extras", {}), dict): msg = "Extras must be a dictionary." raise ValueError(msg) # noqa: TRY004 diff --git a/ui/app/components/DLFields.vue b/ui/app/components/DLFields.vue index b1f50b25..fc012a5b 100644 --- a/ui/app/components/DLFields.vue +++ b/ui/app/components/DLFields.vue @@ -9,6 +9,12 @@
+ + + + Custom Fields + +

@@ -24,9 +30,13 @@

+
+ The idea behind the custom fields is to allow you to add new fields to the download + form to automate some of the yt-dlp options. +
-
+
@@ -38,7 +48,10 @@
- +
The name of the field, it will be shown in the UI. @@ -61,7 +77,10 @@
- + The long form of yt-dlp option name, e.g. --no-overwrites not -w. @@ -70,7 +89,10 @@
- + A short description of the field, it will be shown in the UI. @@ -78,34 +100,36 @@
- - +
-
@@ -211,10 +235,11 @@ const addNewField = () => items.value.push({ kind: 'string', field: '', value: '', + icon: '', + order: items.value.reduce((max, item) => Math.max(max, item.order || 1), 0) + 1, extras: {} }) - const deleteField = (index: number) => items.value.splice(index, 1) const validateItem = (item: DLField, index: number): boolean => { @@ -222,12 +247,17 @@ const validateItem = (item: DLField, index: number): boolean => { const requiredFields = ['name', 'field', 'kind', 'description'] for (const field of requiredFields) { - if (!item[field as keyof DLField] || item[field as keyof DLField]?.trim() === '') { + if (!item[field as keyof DLField]) { toast.error(`${item.name || index}: Field ${field} is required.`) return false } } + if (!item.order || item.order < 1) { + toast.error(`${item.name || index}: Order must be a positive number.`) + return false + } + if (!Object.values(FieldTypes).includes(item.kind)) { toast.error(`${item.name || index}: Invalid field type: ${item.kind}`) return false @@ -242,4 +272,5 @@ const validateItem = (item: DLField, index: number): boolean => { } onMounted(async () => await loadContent()) +const sortedDLFields = computed(() => items.value.sort((a, b) => (a.order || 0) - (b.order || 0))) diff --git a/ui/app/components/NewDownload.vue b/ui/app/components/NewDownload.vue index 4c1aa9cf..3fce0746 100644 --- a/ui/app/components/NewDownload.vue +++ b/ui/app/components/NewDownload.vue @@ -149,10 +149,11 @@
@@ -254,7 +255,7 @@ const show_description = useStorage('show_description', true) const addInProgress = ref(false) const showFields = ref(false) -const dlFields: Record = ref({}) +const dlFields = useStorage>('dl_fields', {}) const form = useStorage('local_config_v1', { id: null, @@ -278,10 +279,31 @@ const dialog_confirm = ref({ const FORCE_FLAG = '--no-download-archive' const addDownload = async () => { - if (form.value?.cli && '' !== form.value.cli) { - const options = await convertOptions(form.value.cli) - if (null === options) { - return + let form_cli = (form.value?.cli || '').trim() + + if (false === config.app.basic_mode) { + if (dlFields.value && Object.keys(dlFields.value).length > 0 && config.dl_fields && config.dl_fields.length > 0) { + const joined = [] + for (const [key, value] of Object.entries(dlFields.value)) { + if (!config.dl_fields.some(f => f.field === key)) { + continue + } + + if ([undefined, null, '', false].includes(value as any)) { + continue + } + joined.push(true === value ? `${key}` : `${key} ${value}`) + } + if (joined.length > 0) { + form_cli = form_cli ? `${form_cli} ${joined.join(' ')}` : joined.join(' ') + } + } + + if (form_cli && form_cli.trim()) { + const options = await convertOptions(form_cli) + if (null === options) { + return + } } } @@ -298,7 +320,7 @@ const addDownload = async () => { folder: config.app.basic_mode ? null : form.value.folder, template: config.app.basic_mode ? null : form.value.template, cookies: config.app.basic_mode ? '' : form.value.cookies, - cli: config.app.basic_mode ? null : form.value.cli, + cli: config.app.basic_mode ? null : form_cli, auto_start: config.app.basic_mode ? true : auto_start.value } as item_request @@ -323,15 +345,20 @@ const addDownload = async () => { return } + let had_errors = false + data.forEach((item: Record) => { if (false !== item.status) { return } toast.error(`Error: ${item.msg || 'Failed to add download.'}`) + had_errors = true }) - form.value.url = '' - emitter('clear_form') + if (false === had_errors) { + form.value.url = '' + emitter('clear_form') + } } catch (e: any) { console.error(e) @@ -357,6 +384,7 @@ const reset_config = () => { folder: '', extras: {}, } as item_request + dlFields.value = {} showAdvanced.value = false @@ -484,4 +512,6 @@ const forceDownload = computed({ } }, }) + +const sortedDLFields = computed(() => config.dl_fields.sort((a, b) => (a.order || 0) - (b.order || 0))) diff --git a/ui/app/types/dl_fields.d.ts b/ui/app/types/dl_fields.d.ts index 20f33743..60dc5872 100644 --- a/ui/app/types/dl_fields.d.ts +++ b/ui/app/types/dl_fields.d.ts @@ -16,6 +16,12 @@ type DLField = { /** The kind of the field. i.e. string, bool */ kind: DLFieldType; + /** The icon of the field, it can be a font-awesome icon */ + icon?: string; + + /** The order of the field, used to sort the fields in the UI. */ + order: number = 1; + /** The default value of the field, It's currently unused */ value: string;