Add custom download folders and refine RSS dialog #37 (#44)

* Add custom download folders

* Refine RSS defaults and dialog layout

* Record template folder in download path

* Store template folder in history paths

* Resolve template vars for history paths

* Default RSS directory to Subscriptions
This commit is contained in:
Nexmoe
2025-12-20 13:05:12 +08:00
committed by GitHub
parent dbcd77963f
commit 86e6b93476
12 changed files with 342 additions and 84 deletions

View File

@@ -4,8 +4,17 @@ import { resolvePathWithHome } from '../utils/path-helpers'
export const sanitizeFilenameTemplate = (template: string): string => {
const trimmed = template.trim()
const sanitized = trimmed.replace(/[/\\]+/g, '-')
return sanitized === '' ? '%(title)s via VidBee.%(ext)s' : sanitized
if (!trimmed) {
return '%(title)s via VidBee.%(ext)s'
}
const normalized = trimmed.replace(/\\/g, '/')
const safeParts = normalized
.split('/')
.map((part) => part.trim())
.filter((part) => part !== '' && part !== '.' && part !== '..')
.map((part) => part.replace(/[<>:"|?*]/g, '-').replace(/[. ]+$/g, ''))
.filter((part) => part !== '')
return safeParts.length === 0 ? '%(title)s via VidBee.%(ext)s' : safeParts.join('/')
}
export const resolveVideoFormatSelector = (options: DownloadOptions): string => {

View File

@@ -1,6 +1,5 @@
import { type IpcContext, IpcMethod, IpcService } from 'electron-ipc-decorator'
import type { AppSettings } from '../../../shared/types'
import { sanitizeFilenameTemplate } from '../../download-engine/args-builder'
import { subscriptionScheduler } from '../../lib/subscription-scheduler'
import { settingsManager } from '../../settings'
import { updateTrayMenu } from '../../tray'
@@ -12,20 +11,12 @@ class SettingsService extends IpcService {
@IpcMethod()
get<K extends keyof AppSettings>(_context: IpcContext, key: K): AppSettings[K] {
const value = settingsManager.get(key)
if (key === 'subscriptionFilenameTemplate' && typeof value === 'string') {
return sanitizeFilenameTemplate(value) as AppSettings[K]
}
return value
return settingsManager.get(key)
}
@IpcMethod()
set<K extends keyof AppSettings>(_context: IpcContext, key: K, value: AppSettings[K]): void {
if (key === 'subscriptionFilenameTemplate' && typeof value === 'string') {
settingsManager.set(key, sanitizeFilenameTemplate(value) as AppSettings[K])
} else {
settingsManager.set(key, value)
}
settingsManager.set(key, value)
if (key === 'language') {
updateTrayMenu()
@@ -46,22 +37,11 @@ class SettingsService extends IpcService {
@IpcMethod()
getAll(_context: IpcContext): AppSettings {
const settings = settingsManager.getAll()
if (typeof settings.subscriptionFilenameTemplate === 'string') {
settings.subscriptionFilenameTemplate = sanitizeFilenameTemplate(
settings.subscriptionFilenameTemplate
)
}
return settings
return settingsManager.getAll()
}
@IpcMethod()
setAll(_context: IpcContext, settings: Partial<AppSettings>): void {
if (typeof settings.subscriptionFilenameTemplate === 'string') {
settings.subscriptionFilenameTemplate = sanitizeFilenameTemplate(
settings.subscriptionFilenameTemplate
)
}
settingsManager.setAll(settings)
if (settings.language) {

View File

@@ -1,3 +1,4 @@
import path from 'node:path'
import { type IpcContext, IpcMethod, IpcService } from 'electron-ipc-decorator'
import type {
SubscriptionCreatePayload,
@@ -5,6 +6,7 @@ import type {
SubscriptionRule,
SubscriptionUpdatePayload
} from '../../../shared/types'
import { DEFAULT_SUBSCRIPTION_FILENAME_TEMPLATE } from '../../../shared/types'
import { sanitizeFilenameTemplate } from '../../download-engine/args-builder'
import { subscriptionManager } from '../../lib/subscription-manager'
import { subscriptionScheduler } from '../../lib/subscription-scheduler'
@@ -112,6 +114,7 @@ class SubscriptionService extends IpcService {
): Promise<SubscriptionRule> {
const resolved = resolveFeedFromInput(options.url)
const settings = settingsManager.getAll()
const defaultDownloadDirectory = path.join(settings.downloadPath, 'Subscriptions')
const payload: SubscriptionCreatePayload = {
sourceUrl: resolved.sourceUrl,
feedUrl: resolved.feedUrl,
@@ -120,9 +123,9 @@ class SubscriptionService extends IpcService {
tags: options.tags,
onlyDownloadLatest:
options.onlyDownloadLatest ?? settings.subscriptionOnlyLatestDefault ?? true,
downloadDirectory: options.downloadDirectory || settings.downloadPath,
downloadDirectory: options.downloadDirectory || defaultDownloadDirectory,
namingTemplate: sanitizeFilenameTemplate(
options.namingTemplate || settings.subscriptionFilenameTemplate
options.namingTemplate || DEFAULT_SUBSCRIPTION_FILENAME_TEMPLATE
),
enabled: options.enabled ?? true
}

View File

@@ -1,4 +1,5 @@
import { EventEmitter } from 'node:events'
import fs from 'node:fs'
import path from 'node:path'
import type { YTDlpEventEmitter } from 'yt-dlp-wrap-plus'
import type {
@@ -12,7 +13,11 @@ import type {
VideoFormat,
VideoInfo
} from '../../shared/types'
import { buildDownloadArgs, resolveVideoFormatSelector } from '../download-engine/args-builder'
import {
buildDownloadArgs,
resolveVideoFormatSelector,
sanitizeFilenameTemplate
} from '../download-engine/args-builder'
import {
findFormatByIdCandidates,
parseSizeToBytes,
@@ -31,6 +36,115 @@ interface DownloadProcess {
process: YTDlpEventEmitter
}
const ensureDirectoryExists = (dir?: string): void => {
if (!dir) {
return
}
try {
fs.mkdirSync(dir, { recursive: true })
} catch (error) {
scopedLoggers.download.error('Failed to ensure download directory:', error)
}
}
const sanitizeFolderName = (value: string, fallback: string): string => {
const trimmed = value.trim()
if (!trimmed) {
return fallback
}
const sanitized = trimmed
.replace(/[\\/:*?"<>|]+/g, '-')
.replace(/\s+/g, ' ')
.replace(/[. ]+$/g, '')
return sanitized || fallback
}
const isLikelyChannelUrl = (url: string): boolean => {
const normalized = url.toLowerCase()
if (normalized.includes('list=')) {
return false
}
return /youtube\.com\/(channel\/|c\/|user\/|@)/.test(normalized)
}
const resolveAutoPlaylistDownloadPath = (
basePath: string,
info: PlaylistInfo,
url: string
): string => {
const kindFolder = isLikelyChannelUrl(url) ? 'Channels' : 'Playlists'
const title = sanitizeFolderName(
info.title || (kindFolder === 'Channels' ? 'Channel' : 'Playlist'),
kindFolder === 'Channels' ? 'Channel' : 'Playlist'
)
return path.join(basePath, kindFolder, title)
}
const resolveAutoVideoDownloadPath = (basePath: string, info?: VideoInfo): string => {
const root = path.join(basePath, 'Videos')
if (!info) {
return root
}
const label = info.uploader?.trim() || info.title?.trim()
if (!label) {
return root
}
return path.join(root, sanitizeFolderName(label, 'Video'))
}
const sanitizeTemplateValue = (value: string): string =>
value
.replace(/[\\/:*?"<>|]+/g, '-')
.replace(/\s+/g, ' ')
.trim()
.replace(/[. ]+$/g, '')
const resolveTemplateToken = (token: string, info?: VideoInfo): string | undefined => {
if (!info) {
return undefined
}
switch (token) {
case 'uploader':
return info.uploader
case 'title':
return info.title
case 'id':
return info.id
case 'channel':
return info.uploader
case 'extractor':
return info.extractor_key
default:
return undefined
}
}
const resolveHistoryDownloadPath = (
basePath: string,
filenameTemplate?: string,
info?: VideoInfo
): string => {
if (!filenameTemplate?.trim()) {
return basePath
}
const safeTemplate = sanitizeFilenameTemplate(filenameTemplate)
const resolvedTemplate = safeTemplate.replace(/%\(([^)]+)\)s/g, (match, token) => {
const value = resolveTemplateToken(token, info)
if (!value) {
return match
}
return sanitizeTemplateValue(value)
})
const templateDir = path.posix.dirname(resolvedTemplate)
if (templateDir === '.' || templateDir === '/') {
return basePath
}
if (/%\([^)]+\)s/.test(templateDir)) {
return basePath
}
return path.join(basePath, templateDir)
}
class DownloadEngine extends EventEmitter {
private activeDownloads: Map<string, DownloadProcess> = new Map()
private queue: DownloadQueue
@@ -316,6 +430,10 @@ class DownloadEngine extends EventEmitter {
const rangeEnd = Math.max(requestedStart, requestedEnd)
const rawEntries = playlistInfo.entries.slice(rangeStart, rangeEnd + 1)
const settings = settingsManager.getAll()
const resolvedDownloadPath =
options.customDownloadPath?.trim() ||
resolveAutoPlaylistDownloadPath(settings.downloadPath, playlistInfo, options.url)
ensureDirectoryExists(resolvedDownloadPath)
const selectedEntries = rawEntries.filter((entry) => {
if (!entry.url) {
@@ -339,7 +457,8 @@ class DownloadEngine extends EventEmitter {
url: entry.url,
type: options.type,
format: options.format,
audioFormat: options.type === 'audio' ? options.format : undefined
audioFormat: options.type === 'audio' ? options.format : undefined,
customDownloadPath: resolvedDownloadPath
}
const createdAt = Date.now()
@@ -370,7 +489,7 @@ class DownloadEngine extends EventEmitter {
title: entry.title,
status: 'pending',
downloadedAt: createdAt,
downloadPath: settings.downloadPath,
downloadPath: resolvedDownloadPath,
playlistId: groupId,
playlistTitle: playlistInfo.title,
playlistIndex: entry.index,
@@ -400,6 +519,12 @@ class DownloadEngine extends EventEmitter {
const settings = settingsManager.getAll()
const targetDownloadPath = options.customDownloadPath?.trim() || settings.downloadPath
const origin = options.origin ?? 'manual'
const historyDownloadPath = resolveHistoryDownloadPath(
targetDownloadPath,
options.customFilenameTemplate
)
ensureDirectoryExists(targetDownloadPath)
ensureDirectoryExists(historyDownloadPath)
const item: DownloadItem = {
id,
@@ -419,7 +544,7 @@ class DownloadEngine extends EventEmitter {
title: item.title,
status: 'pending',
downloadedAt: createdAt,
downloadPath: targetDownloadPath,
downloadPath: historyDownloadPath,
tags: options.tags,
origin,
subscriptionId: options.subscriptionId
@@ -431,7 +556,7 @@ class DownloadEngine extends EventEmitter {
const ytdlp = ytdlpManager.getInstance()
const settings = settingsManager.getAll()
const defaultDownloadPath = settings.downloadPath
const resolvedDownloadPath = options.customDownloadPath?.trim() || defaultDownloadPath
let resolvedDownloadPath = options.customDownloadPath?.trim() || defaultDownloadPath
// Set environment variables for proper encoding on Windows
if (process.platform === 'win32') {
@@ -482,6 +607,19 @@ class DownloadEngine extends EventEmitter {
scopedLoggers.download.warn('Failed to get detailed video info for ID:', id, error)
}
if (!options.customDownloadPath?.trim()) {
resolvedDownloadPath = resolveAutoVideoDownloadPath(defaultDownloadPath, videoInfo)
options.customDownloadPath = resolvedDownloadPath
}
const historyDownloadPath = resolveHistoryDownloadPath(
resolvedDownloadPath,
options.customFilenameTemplate,
videoInfo
)
ensureDirectoryExists(historyDownloadPath)
this.upsertHistoryEntry(id, options, { downloadPath: historyDownloadPath })
const applySelectedFormat = (formatId: string | undefined): boolean => {
if (!formatId) {
return false

View File

@@ -3,6 +3,7 @@ import fs from 'node:fs'
import log from 'electron-log/main'
import Parser from 'rss-parser'
import type { SubscriptionFeedItem, SubscriptionRule } from '../../shared/types'
import { DEFAULT_SUBSCRIPTION_FILENAME_TEMPLATE } from '../../shared/types'
import { settingsManager } from '../settings'
import { downloadEngine } from './download-engine'
import { historyManager } from './history-manager'
@@ -406,7 +407,7 @@ export class SubscriptionScheduler extends EventEmitter {
const settings = settingsManager.getAll()
const downloadDirectory = subscription.downloadDirectory?.trim() || settings.downloadPath
const namingTemplate =
subscription.namingTemplate?.trim() || settings.subscriptionFilenameTemplate
subscription.namingTemplate?.trim() || DEFAULT_SUBSCRIPTION_FILENAME_TEMPLATE
ensureDirectoryExists(downloadDirectory)
const tags = Array.from(new Set([subscription.platform, ...subscription.tags]))

View File

@@ -10,7 +10,6 @@ const ElectronStore = require('electron-store')
const Store = ElectronStore.default || ElectronStore
const OLD_DEFAULT_DOWNLOAD_PATH = path.join(os.homedir(), 'Downloads')
const ensureDirectoryExists = (dir: string) => {
try {
fs.mkdirSync(dir, { recursive: true })