mirror of
https://github.com/ZHANGTIANYAO1/teamspeak-music-bot.git
synced 2026-10-02 04:52:50 +08:00
feat: add configurable default music source (#126)
Make the default playback source a user-configurable setting so servers that mostly play e.g. Bilibili no longer need to type `-b` on every `!play`. Previously defaultPlatform() always picked the first enabled provider by a fixed priority order, with no way to override it. - config: add optional `defaultPlatform: GateableProvider | null`. loadConfig sanitizes it — kept only when it names a known provider that is also currently enabled, else null. defaultPlatform() returns the preference when enabled, otherwise falls back to the fixed priority order. - POST /api/bot/settings accepts `defaultPlatform` (validated against the possibly-updated enabledProviders; null/"" clears it), and reconciles a stored default that a new enabledProviders list no longer allows. GET and POST responses expose the field. - WebUI: new "默认音源" section with a source picker; saving refreshes the store's default source so it takes effect immediately without a restart. - Tests: extend config defaultPlatform priority tests and add coverage for the settings endpoint and /providers routing. - README: document `defaultPlatform` in the enabledProviders section. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
1 parent
051171b019
commit
987513a5f6
7 files changed
+279
-9
No files matched your search
+38
-7
@@ -61,15 +61,24 @@ export function isProviderEnabled(config: BotConfig, platform: string): boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* The default platform for !play/!add/!playlist/!album and all REST/WebUI calls:
|
||||
* the first enabled provider in a fixed priority order (netease with the default
|
||||
* config; jellyfin ranks after the online music platforms because it is an
|
||||
* opt-in source, but ahead of the video sites for users who run it as their
|
||||
* only music library). Falls back to "netease" when nothing is enabled so
|
||||
* callers always get a provider — the enabled-gate then produces the friendly
|
||||
* error.
|
||||
* The default platform for !play/!add/!playlist/!album and all REST/WebUI calls.
|
||||
*
|
||||
* An explicit user preference (`config.defaultPlatform`) wins whenever it points
|
||||
* at a source that is currently enabled — this lets e.g. a Bilibili-loving server
|
||||
* set B站 as the default so `!play <歌名>` needs no `-b` flag (issue #126). The
|
||||
* enabled-guard here matters at runtime too: if the operator later disables the
|
||||
* preferred source, we must fall through instead of returning a dead default.
|
||||
*
|
||||
* With no (usable) preference we fall back to the first enabled provider in a
|
||||
* fixed priority order (netease with the default config; jellyfin ranks after
|
||||
* the online music platforms because it is an opt-in source, but ahead of the
|
||||
* video sites for users who run it as their only music library). Falls back to
|
||||
* "netease" when nothing is enabled so callers always get a provider — the
|
||||
* enabled-gate then produces the friendly error.
|
||||
*/
|
||||
export function defaultPlatform(config: BotConfig): GateableProvider {
|
||||
const pref = config.defaultPlatform;
|
||||
if (pref && config.enabledProviders.includes(pref)) return pref;
|
||||
for (const p of ["netease", "qq", "kugou", "jellyfin", "bilibili", "youtube"] as const) {
|
||||
if (config.enabledProviders.includes(p)) return p;
|
||||
}
|
||||
@@ -110,6 +119,14 @@ export interface BotConfig {
|
||||
* API servers must not start (or bind ports 3001/3200) unless enabled.
|
||||
*/
|
||||
enabledProviders: GateableProvider[];
|
||||
/**
|
||||
* Optional operator-chosen default source for commands/REST/WebUI calls that
|
||||
* omit a platform (issue #126). When set to an enabled gateable provider it
|
||||
* overrides the fixed priority order in defaultPlatform(); `null` (the default)
|
||||
* keeps that priority order. loadConfig cleans stale/unknown/disabled values
|
||||
* back to null.
|
||||
*/
|
||||
defaultPlatform: GateableProvider | null;
|
||||
}
|
||||
|
||||
export function getDefaultConfig(): BotConfig {
|
||||
@@ -163,6 +180,7 @@ export function getDefaultConfig(): BotConfig {
|
||||
userId: "",
|
||||
},
|
||||
enabledProviders: ["netease", "qq", "bilibili", "youtube", "kugou"],
|
||||
defaultPlatform: null,
|
||||
};
|
||||
}
|
||||
|
||||
@@ -317,6 +335,18 @@ export function loadConfig(path: string): BotConfig {
|
||||
)
|
||||
: defaults.enabledProviders;
|
||||
|
||||
// defaultPlatform → an explicit operator default (issue #126). Keep it only
|
||||
// when it names a KNOWN gateable provider that is ALSO currently enabled;
|
||||
// anything else (unknown value, disabled source, wrong type, missing) becomes
|
||||
// null so defaultPlatform() falls back to the fixed priority order.
|
||||
const rawDefault = partial.defaultPlatform;
|
||||
const defaultPlatformPref: GateableProvider | null =
|
||||
typeof rawDefault === "string" &&
|
||||
(GATEABLE_PROVIDERS as readonly string[]).includes(rawDefault) &&
|
||||
enabledProviders.includes(rawDefault as GateableProvider)
|
||||
? (rawDefault as GateableProvider)
|
||||
: null;
|
||||
|
||||
return {
|
||||
...defaults,
|
||||
...partial,
|
||||
@@ -325,6 +355,7 @@ export function loadConfig(path: string): BotConfig {
|
||||
spotify,
|
||||
jellyfin,
|
||||
enabledProviders,
|
||||
defaultPlatform: defaultPlatformPref,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
Reference in new issue
Block a user