f167c02946
Closing the window no longer kills in-progress downloads, the library gains the same copied-link suggestion the downloads tab has, and the in-app updater can now authenticate to a sign-in-required Gitea. Background / tray: - The window's close handler now hides to the tray (instead of quitting) whenever a download is in flight, even if "Keep running in the tray" is off — quitting was killing the spawned yt-dlp processes. A one-time notification explains the app is still running. (download.ts exposes hasActiveDownloads().) - tray.ts now falls back to an embedded icon when no build/icon.ico ships, so the tray actually appears — previously an empty icon meant the tray was skipped and a minimized window could be stranded with no way back. - New "Start with Windows" setting (launchAtStartup) wired to app.setLoginItemSettings, synced at startup and on toggle. Useful with auto-download so watched channels stay current in the background. - The "Keep running in the tray" hint now explains it also enables background auto-download of new uploads. Library clipboard detection: - Extracted the downloads tab's clipboard watcher into a shared useClipboardLink hook and used it in the library's add-source field, so a copied channel/playlist link is offered there too. Updater fix (works on a private / sign-in-required instance): - Added an optional updateToken setting. When set, the updater sends it as a Gitea Authorization header on the release check, the checksum fetch, and the installer download — so "Check for updates" works where anonymous access is blocked (the previous "could not reach the update server" case). Blank = anonymous, unchanged. No token is ever shipped; it's only ever sent to the host-pinned update host. Settings gains a masked "Update access token" field. Typecheck clean; 187 tests pass; electron-vite build clean. New UI verified in the browser preview (tray/startup toggles, token field, library copied-link banner). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
295 lines
12 KiB
TypeScript
295 lines
12 KiB
TypeScript
import { app } from 'electron'
|
|
import { join } from 'path'
|
|
import { mkdirSync } from 'fs'
|
|
import Store from 'electron-store'
|
|
import { isSafeFilenameTemplate, isSafeOutputDir } from './validation'
|
|
import {
|
|
AUDIO_FORMATS,
|
|
VIDEO_CONTAINERS,
|
|
VIDEO_CODECS,
|
|
SPONSORBLOCK_CATEGORIES,
|
|
COOKIE_BROWSERS,
|
|
ACCENT_COLORS,
|
|
DEFAULT_DOWNLOAD_OPTIONS,
|
|
isYtdlpUpdateChannel,
|
|
type Settings,
|
|
type DownloadOptions,
|
|
type SponsorBlockCategory
|
|
} from '@shared/ipc'
|
|
|
|
const DEFAULTS: Settings = {
|
|
// Both blank by default → downloads land in Documents\Video / Documents\Audio
|
|
// (see getDefaultMediaDir). A non-empty value is an explicit per-kind override.
|
|
videoDir: '',
|
|
audioDir: '',
|
|
defaultKind: 'video',
|
|
defaultVideoQuality: 'Best available',
|
|
defaultAudioQuality: 'Best (MP3)',
|
|
maxConcurrent: 2,
|
|
filenameTemplate: '%(title)s.%(ext)s',
|
|
theme: 'light',
|
|
accentColor: 'teal',
|
|
clipboardWatch: true,
|
|
downloadOptions: DEFAULT_DOWNLOAD_OPTIONS,
|
|
proxy: '',
|
|
rateLimit: '',
|
|
useAria2c: false,
|
|
cookieSource: 'none',
|
|
cookiesBrowser: 'chrome',
|
|
youtubePlayerClient: '',
|
|
youtubePoToken: '',
|
|
restrictFilenames: false,
|
|
downloadArchive: false,
|
|
// yt-dlp is self-managed: a writable copy under userData, auto-updated on the
|
|
// nightly channel (fastest to follow YouTube changes that cause 403s).
|
|
autoUpdateYtdlp: true,
|
|
ytdlpChannel: 'nightly',
|
|
ytdlpLastUpdateCheck: 0,
|
|
customCommandEnabled: false,
|
|
defaultTemplateId: null,
|
|
notifyOnComplete: true,
|
|
autoDownloadNew: true,
|
|
hasCompletedOnboarding: false,
|
|
minimizeToTray: false,
|
|
launchAtStartup: false,
|
|
updateToken: ''
|
|
}
|
|
|
|
/**
|
|
* Sync the OS "run at sign-in" entry with the launchAtStartup setting. Called at
|
|
* startup and whenever the toggle changes. On Windows this writes/removes a
|
|
* per-user registry Run entry — no admin needed, matching the app's no-elevation
|
|
* stance. Best-effort: a failure here just means the toggle didn't take effect.
|
|
*/
|
|
export function applyLaunchAtStartup(enabled: boolean): void {
|
|
try {
|
|
app.setLoginItemSettings({ openAtLogin: enabled })
|
|
} catch {
|
|
/* non-fatal — e.g. unsupported platform */
|
|
}
|
|
}
|
|
|
|
/** Fixed path for the --download-archive file; not user-configurable. */
|
|
export function getDownloadArchivePath(): string {
|
|
return join(app.getPath('userData'), 'download-archive.txt')
|
|
}
|
|
|
|
/**
|
|
* The default per-kind download destination: video → Documents\Video,
|
|
* audio → Documents\Audio. Used when the user hasn't set an explicit output
|
|
* folder (Settings → Download folder), so downloads are sorted by type.
|
|
*/
|
|
export function getDefaultMediaDir(kind: 'video' | 'audio'): string {
|
|
return join(app.getPath('documents'), kind === 'audio' ? 'Audio' : 'Video')
|
|
}
|
|
|
|
/**
|
|
* Create the Documents\Video and Documents\Audio folders up front (called once
|
|
* at startup) so they exist the moment the app opens, not just after the first
|
|
* download. Best-effort: yt-dlp also creates the output dir at download time, so
|
|
* a failure here (read-only Documents, redirected folder) is non-fatal.
|
|
*/
|
|
export function ensureMediaDirs(): void {
|
|
for (const kind of ['video', 'audio'] as const) {
|
|
try {
|
|
mkdirSync(getDefaultMediaDir(kind), { recursive: true })
|
|
} catch {
|
|
/* non-fatal — the download path will be created on demand instead */
|
|
}
|
|
}
|
|
}
|
|
|
|
// Coerce an untrusted partial into a valid DownloadOptions, falling back to the
|
|
// defaults for any missing/invalid field. Used both to migrate older settings
|
|
// files (which predate downloadOptions) and to validate renderer writes.
|
|
function sanitizeOptions(input: unknown): DownloadOptions {
|
|
const o = (input && typeof input === 'object' ? input : {}) as Partial<DownloadOptions>
|
|
const d = DEFAULT_DOWNLOAD_OPTIONS
|
|
const bool = (v: unknown, fallback: boolean): boolean =>
|
|
typeof v === 'boolean' ? v : fallback
|
|
const cats = Array.isArray(o.sponsorBlockCategories)
|
|
? (o.sponsorBlockCategories.filter((c) =>
|
|
(SPONSORBLOCK_CATEGORIES as readonly string[]).includes(c)
|
|
) as SponsorBlockCategory[])
|
|
: d.sponsorBlockCategories
|
|
return {
|
|
audioFormat: AUDIO_FORMATS.includes(o.audioFormat as never) ? o.audioFormat! : d.audioFormat,
|
|
videoContainer: VIDEO_CONTAINERS.includes(o.videoContainer as never)
|
|
? o.videoContainer!
|
|
: d.videoContainer,
|
|
preferredVideoCodec: VIDEO_CODECS.includes(o.preferredVideoCodec as never)
|
|
? o.preferredVideoCodec!
|
|
: d.preferredVideoCodec,
|
|
formatSort: typeof o.formatSort === 'string' ? o.formatSort.trim() : d.formatSort,
|
|
embedSubtitles: bool(o.embedSubtitles, d.embedSubtitles),
|
|
subtitleLanguages:
|
|
typeof o.subtitleLanguages === 'string' && o.subtitleLanguages.trim()
|
|
? o.subtitleLanguages.trim()
|
|
: d.subtitleLanguages,
|
|
autoSubtitles: bool(o.autoSubtitles, d.autoSubtitles),
|
|
sponsorBlock: bool(o.sponsorBlock, d.sponsorBlock),
|
|
sponsorBlockMode: o.sponsorBlockMode === 'mark' ? 'mark' : 'remove',
|
|
sponsorBlockCategories: cats,
|
|
embedChapters: bool(o.embedChapters, d.embedChapters),
|
|
splitChapters: bool(o.splitChapters, d.splitChapters),
|
|
embedMetadata: bool(o.embedMetadata, d.embedMetadata),
|
|
embedThumbnail: bool(o.embedThumbnail, d.embedThumbnail),
|
|
cropThumbnail: bool(o.cropThumbnail, d.cropThumbnail),
|
|
writeInfoJson: bool(o.writeInfoJson, d.writeInfoJson),
|
|
writeThumbnailFile: bool(o.writeThumbnailFile, d.writeThumbnailFile),
|
|
writeDescription: bool(o.writeDescription, d.writeDescription)
|
|
}
|
|
}
|
|
|
|
// Constructed lazily — electron-store needs app paths, which exist only after
|
|
// the app is ready (all callers run post-ready).
|
|
let store: Store<Settings> | null = null
|
|
function getStore(): Store<Settings> {
|
|
if (!store) store = new Store<Settings>({ name: 'settings', defaults: DEFAULTS })
|
|
return store
|
|
}
|
|
|
|
export function getSettings(): Settings {
|
|
const s = getStore()
|
|
// getSettings() is on hot paths (buildCommand, notification checks, the system-
|
|
// theme bridge, several IPC handlers). electron-store writes to disk on every
|
|
// `set`, so only write when something actually changed — otherwise this churns
|
|
// the settings file on every read. (audit P1)
|
|
const cur = s.store
|
|
// videoDir/audioDir are intentionally left blank by default — an empty value
|
|
// routes that kind into Documents\Video / Documents\Audio (see buildCommand).
|
|
// Only an explicit user choice (Settings → folders) overrides that.
|
|
// Migrate settings files that predate downloadOptions (or hold a partial one),
|
|
// but only persist when sanitizing actually altered the stored value.
|
|
const sanitized = sanitizeOptions(cur.downloadOptions)
|
|
if (!downloadOptionsEqual(sanitized, cur.downloadOptions)) {
|
|
s.set('downloadOptions', sanitized)
|
|
}
|
|
// Coerce an accentColor left over from a renamed/removed preset (e.g. an old
|
|
// 'toffee' or 'indigo' default) onto the current default, so it resolves cleanly.
|
|
if (!(ACCENT_COLORS as readonly string[]).includes(cur.accentColor)) {
|
|
s.set('accentColor', DEFAULTS.accentColor)
|
|
}
|
|
return s.store
|
|
}
|
|
|
|
/** Shallow structural equality for DownloadOptions (sponsorBlockCategories compared by value). */
|
|
function downloadOptionsEqual(a: DownloadOptions, b: unknown): boolean {
|
|
if (!b || typeof b !== 'object') return false
|
|
const o = b as Partial<DownloadOptions>
|
|
const keys = Object.keys(a) as (keyof DownloadOptions)[]
|
|
for (const k of keys) {
|
|
if (k === 'sponsorBlockCategories') {
|
|
const av = a[k]
|
|
const bv = o[k]
|
|
if (!Array.isArray(bv) || av.length !== bv.length) return false
|
|
for (let i = 0; i < av.length; i++) if (av[i] !== bv[i]) return false
|
|
} else if (a[k] !== o[k]) {
|
|
return false
|
|
}
|
|
}
|
|
return true
|
|
}
|
|
|
|
// Validate each key before persisting — the renderer is the only caller today,
|
|
// but settings flow into process spawning (maxConcurrent) and the native window
|
|
// background (theme), so an out-of-range or malformed value shouldn't get stored.
|
|
export function setSettings(partial: Partial<Settings>): Settings {
|
|
const s = getStore()
|
|
for (const key of Object.keys(partial) as (keyof Settings)[]) {
|
|
const value = partial[key]
|
|
if (value === undefined) continue
|
|
switch (key) {
|
|
case 'theme':
|
|
if (value === 'light' || value === 'dark' || value === 'system') s.set('theme', value)
|
|
break
|
|
case 'accentColor':
|
|
if ((ACCENT_COLORS as readonly string[]).includes(value as string)) {
|
|
s.set('accentColor', value as Settings['accentColor'])
|
|
}
|
|
break
|
|
case 'defaultKind':
|
|
if (value === 'video' || value === 'audio') s.set('defaultKind', value)
|
|
break
|
|
case 'maxConcurrent': {
|
|
const n = Number(value)
|
|
if (Number.isFinite(n)) s.set('maxConcurrent', Math.min(5, Math.max(1, Math.round(n))))
|
|
break
|
|
}
|
|
case 'clipboardWatch':
|
|
case 'useAria2c':
|
|
case 'restrictFilenames':
|
|
case 'downloadArchive':
|
|
case 'autoUpdateYtdlp':
|
|
case 'customCommandEnabled':
|
|
case 'notifyOnComplete':
|
|
case 'autoDownloadNew':
|
|
case 'hasCompletedOnboarding':
|
|
case 'minimizeToTray':
|
|
if (typeof value === 'boolean') s.set(key, value)
|
|
break
|
|
case 'launchAtStartup':
|
|
if (typeof value === 'boolean') {
|
|
s.set('launchAtStartup', value)
|
|
applyLaunchAtStartup(value)
|
|
}
|
|
break
|
|
case 'ytdlpChannel':
|
|
// Same allowlist that guards the `--update-to` flag (audit F1).
|
|
if (isYtdlpUpdateChannel(value)) s.set('ytdlpChannel', value)
|
|
break
|
|
case 'ytdlpLastUpdateCheck': {
|
|
// Set by the main-process auto-updater; validated here since setSettings
|
|
// is the only writer. A bogus value at worst skips/forces one check.
|
|
const n = Number(value)
|
|
if (Number.isFinite(n) && n >= 0) s.set('ytdlpLastUpdateCheck', n)
|
|
break
|
|
}
|
|
case 'defaultTemplateId':
|
|
if (value === null || typeof value === 'string') s.set('defaultTemplateId', value)
|
|
break
|
|
case 'cookieSource':
|
|
if (value === 'none' || value === 'browser' || value === 'login') s.set(key, value)
|
|
break
|
|
case 'cookiesBrowser':
|
|
if ((COOKIE_BROWSERS as readonly string[]).includes(value as string)) {
|
|
s.set(key, value as Settings['cookiesBrowser'])
|
|
}
|
|
break
|
|
case 'downloadOptions':
|
|
// Always store a fully-validated object; the renderer sends the whole
|
|
// group (it merges field changes locally before calling setSettings).
|
|
s.set('downloadOptions', sanitizeOptions(value))
|
|
break
|
|
case 'videoDir':
|
|
case 'audioDir':
|
|
// An empty string is allowed — it clears the override and restores the
|
|
// Documents\Video / Documents\Audio default for that kind.
|
|
if (typeof value === 'string' && (value.trim() === '' || isSafeOutputDir(value.trim()))) {
|
|
s.set(key, value.trim())
|
|
}
|
|
break
|
|
case 'filenameTemplate':
|
|
if (typeof value === 'string' && isSafeFilenameTemplate(value.trim())) {
|
|
s.set('filenameTemplate', value.trim())
|
|
}
|
|
break
|
|
case 'defaultVideoQuality':
|
|
case 'defaultAudioQuality':
|
|
// proxy may carry plaintext credentials (user:pass@host); they are stored
|
|
// and exported by exportBackup as-is — documented, not masked.
|
|
case 'proxy':
|
|
case 'rateLimit':
|
|
case 'youtubePlayerClient':
|
|
case 'youtubePoToken':
|
|
if (typeof value === 'string') s.set(key, value)
|
|
break
|
|
case 'updateToken':
|
|
// A Gitea token has no spaces; trim and store as-is (like proxy creds).
|
|
if (typeof value === 'string') s.set('updateToken', value.trim())
|
|
break
|
|
}
|
|
}
|
|
return getSettings()
|
|
}
|