Compare commits

...
4 Commits
Author SHA1 Message Date
CNWei f7d0630fe6 chore(settings): 去掉老库自动补内置引擎的兼容逻辑
- load() 不再把缺的内置引擎补进返回结果;老库缺内置引擎时保存会被 400 拒绝(不做自动迁移)
- 删除对应的 load_merges_new_builtin_engines 测试
- HANDOFF 同步说明
2026-11-06 13:51:28 +08:00
CNWei 733c1552ce feat(search): 内置 DuckDuckGo,内置引擎不允许删除
- 默认引擎清单加 duckduckgo(https://duckduckgo.com/?q={query}),图标用组件库 0.3.5 的 DuckDuckGo 品牌图标
- 后端:内置六个必须存在,缺了返回 400;老库读取时按 id 补齐缺的内置引擎(插在内置那一组里,不覆盖用户改过的值)
- 后台:内置引擎不渲染「删除」按钮,removeEngine 也做了兜底;自定义引擎照常可删
2026-11-06 12:40:31 +08:00
CNWei fdfd17657c feat(search): 自定义引擎支持图标地址(png / svg)
- settings.search.engines[] 新增 icon:空=品牌图标/通用地球,'/' 开头走托管目录,或 http(s) 链接
- 后端校验图标地址(空 / 托管路径 / http(s),≤500 字符)
- 后台每张引擎卡加「图标地址」输入;前后台都用组件库 EngineIcon 的 src(<img> 渲染,SVG 静态不执行脚本)
- @stash/ui 0.3.4
2026-11-06 12:30:15 +08:00
CNWei 281f04b060 feat(search): 后台可以自己添加搜索引擎
- 搜索引擎 id 放宽:小写字母/数字/-/_,1–30 位,internal 保留;最多 10 个
- 后台搜索框面板加「添加搜索引擎」(id 自动生成 custom-xxx)与每行「删除」
- 自定义引擎用组件库 EngineIcon 的通用地球图标(@stash/ui 0.3.3)
- 搜索地址仍要求 http(s):// + {query},默认项被删/停用时回落到站内搜索
2026-11-06 12:19:06 +08:00
6 changed files with 226 additions and 39 deletions
+10 -5
View File
@@ -117,11 +117,12 @@ stash-ui/src/components/ SearchField / Input / EngineIcon 等
"search": {
"default": "internal",
"engines": [
{ "id": "google", "name": "Google", "url": "https://www.google.com/search?q={query}", "enabled": true },
{ "id": "google", "name": "Google", "url": "https://www.google.com/search?q={query}", "icon": "", "enabled": true },
{ "id": "bing", "name": "Bing", "url": "https://www.bing.com/search?q={query}", "enabled": true },
{ "id": "baidu", "name": "百度", "url": "https://www.baidu.com/s?wd={query}", "enabled": true },
{ "id": "sogou", "name": "搜狗", "url": "https://www.sogou.com/web?query={query}", "enabled": true },
{ "id": "360", "name": "360", "url": "https://www.so.com/s?q={query}", "enabled": true }
{ "id": "360", "name": "360", "url": "https://www.so.com/s?q={query}", "enabled": true },
{ "id": "duckduckgo", "name": "DuckDuckGo", "url": "https://duckduckgo.com/?q={query}", "enabled": true }
]
},
"profile": { "name": "...", "role": "...", "description": "...", "location": "...", "avatar": "" },
@@ -132,7 +133,11 @@ stash-ui/src/components/ SearchField / Input / EngineIcon 等
- `search.default` 可以是 `internal` 或某个引擎 id;默认默认值是 `internal`。
- 上面是字段结构示例;实际值以 `GET /api/settings` 为准(交接时 `search.default=internal`、`site.theme=light`,background 两项使用自定义 picsum 图)。
- 外部引擎 URL 必须以 `http(s)://` 开头并包含 `{query}`,否则后端 400。
- 引擎 id 固定为 `google / bing / baidu / sogou / 360`,因为图标与 id 对应;暂不支持新增自定义引擎。
- 引擎 id 只能用小写字母 / 数字 / `-` / `_`(1–30 位,`internal` 保留);内置六个(含 DuckDuckGo)用品牌图标,
且**不能删除**(只能改名 / 改地址 / 停用)。不做老库兼容:库里的设置缺内置引擎时,保存会 400;
后台新加的引擎 id 自动生成为 `custom-xxx`、图标用通用地球(组件库 EngineIcon 自动回落)。
- 每个引擎可带 `icon`(png / svg 地址,`/` 开头的托管路径或 http(s) 链接):给了就用 `<img>` 渲染自己
的图标,留空回落到品牌图标 / 地球;SVG 走 img 是静态的,不执行脚本。
- `background.light/dark` 为空时用内置 `stash-web/src/assets/site-bg.jpg` / `site-bg-dark.jpg`;否则填托管目录 `public/` 路径或完整 URL。
- 旧 settings JSON 缺失字段会自动回落默认值;多余旧字段在下次保存时被丢弃。
@@ -145,7 +150,7 @@ stash-ui/src/components/ SearchField / Input / EngineIcon 等
- **首页管理**
- 页头:开关、速度、滚动条目、品牌 / 图标 / 配色;
- 背景管理:亮色 / 暗色背景 URL + 预览 + 恢复内置;
- 搜索框:默认搜索项、五个外部引擎的名称 / URL / 启停、恢复默认;
- 搜索框:默认搜索项、外部引擎的名称 / URL / 启停、添加 / 删除自定义引擎、恢复默认;
- 侧边栏:资料卡 / 本地服务 / 分组导航显隐;
- 内容卡片:卡片 + 勾选分组 + 预览条数 + 排序;
- **资料管理**:头像、名称、角色、简介、位置;
@@ -211,7 +216,7 @@ PATCH /api/auth/password
| 项 | 说明 |
| --- | --- |
| 推送 | 本地 `develop` 领先远端 20 个提交,尚未推送;Gitea HTTPS 凭据需准备 |
| 搜索引擎 | id 固定五个;新增需同时补 EngineIcon、后端校验、前端默认值、后台面板 |
| 搜索引擎 | 内置六个(含 DuckDuckGo,有品牌图标,不能删只能停用)+ 后台添加的自定义引擎(最多 10 个,通用地球图标) |
| 搜索选择记忆 | 存本机 localStorage(`stash-search-engine`);换设备 / 清站点数据后回到后台默认 |
| 图片上传 | 背景 / 头像 / Logo 只支持 URL,不支持上传 |
| 卡片/分组拖拽 | 排序用数值 / 现有 SortableList;分组拖拽排序未做 |
+103 -6
View File
@@ -14,6 +14,9 @@ pub const MAX_HEADER_ITEMS: usize = 8;
pub const MIN_SPEED: u32 = 8;
pub const MAX_SPEED: u32 = 120;
pub const MAX_FONT_LINKS: usize = 20;
/// 内置搜索引擎:有品牌图标,后台只能改名称 / 地址 / 启停,不能删除。
pub const BUILTIN_ENGINE_IDS: [&str; 6] =
["google", "bing", "baidu", "sogou", "360", "duckduckgo"];
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq, Default)]
#[serde(rename_all = "snake_case")]
@@ -162,6 +165,8 @@ pub struct SearchEngineSettings {
pub name: String,
/// 搜索地址模板,用 `{query}` 表示关键词
pub url: String,
/// 自定义图标地址(png / svg);空表示用内置品牌图标或通用地球
pub icon: String,
pub enabled: bool,
}
@@ -182,30 +187,42 @@ impl Default for SearchSettings {
id: "google".into(),
name: "Google".into(),
url: "https://www.google.com/search?q={query}".into(),
icon: String::new(),
enabled: true,
},
SearchEngineSettings {
id: "bing".into(),
name: "Bing".into(),
url: "https://www.bing.com/search?q={query}".into(),
icon: String::new(),
enabled: true,
},
SearchEngineSettings {
id: "baidu".into(),
name: "百度".into(),
url: "https://www.baidu.com/s?wd={query}".into(),
icon: String::new(),
enabled: true,
},
SearchEngineSettings {
id: "sogou".into(),
name: "搜狗".into(),
url: "https://www.sogou.com/web?query={query}".into(),
icon: String::new(),
enabled: true,
},
SearchEngineSettings {
id: "360".into(),
name: "360".into(),
url: "https://www.so.com/s?q={query}".into(),
icon: String::new(),
enabled: true,
},
SearchEngineSettings {
id: "duckduckgo".into(),
name: "DuckDuckGo".into(),
url: "https://duckduckgo.com/?q={query}".into(),
icon: String::new(),
enabled: true,
},
],
@@ -337,6 +354,16 @@ pub struct SettingsDocument {
pub settings: Settings,
}
/// 引擎 id:小写字母 / 数字 / `-` / `_`,1–30 位;`internal` 是站内搜索的保留 id。
fn valid_engine_id(id: &str) -> bool {
let count = id.chars().count();
if count == 0 || count > 30 || id == "internal" {
return false;
}
id.chars()
.all(|c| c.is_ascii_lowercase() || c.is_ascii_digit() || c == '-' || c == '_')
}
/// 校验:条数、长度、速度范围。
pub fn validate(settings: &Settings) -> Result<(), StashError> {
if settings.header.items.is_empty() {
@@ -437,13 +464,13 @@ pub fn validate(settings: &Settings) -> Result<(), StashError> {
}
let mut ids = std::collections::HashSet::new();
for engine in &settings.search.engines {
if !matches!(
engine.id.as_str(),
"google" | "bing" | "baidu" | "sogou" | "360"
) {
return Err(StashError::InvalidDirectory("搜索引擎标识不合法".into()));
let id = engine.id.trim();
if !valid_engine_id(id) {
return Err(StashError::InvalidDirectory(
"搜索引擎标识只能用小写字母 / 数字 / - / _(1–30 位,internal 为保留字)".into(),
));
}
if !ids.insert(engine.id.as_str()) {
if !ids.insert(id) {
return Err(StashError::InvalidDirectory("搜索引擎标识不能重复".into()));
}
let name = engine.name.trim();
@@ -459,6 +486,26 @@ pub fn validate(settings: &Settings) -> Result<(), StashError> {
"搜索地址需以 http(s):// 开头并包含 {query}".into(),
));
}
let icon = engine.icon.trim();
if icon.chars().count() > 500 {
return Err(StashError::InvalidDirectory("引擎图标地址最多 500 个字符".into()));
}
if !icon.is_empty()
&& !(icon.starts_with("http://")
|| icon.starts_with("https://")
|| icon.starts_with('/'))
{
return Err(StashError::InvalidDirectory(
"引擎图标需为空、/ 开头的托管路径或 http(s):// 链接".into(),
));
}
}
for builtin in BUILTIN_ENGINE_IDS {
if !ids.contains(builtin) {
return Err(StashError::InvalidDirectory(format!(
"内置搜索引擎不能删除(缺少 {builtin})"
)));
}
}
let default = settings.search.default.trim();
if default != "internal" {
@@ -619,6 +666,56 @@ mod tests {
assert!(matches!(error, StashError::Conflict(_)));
}
#[test]
fn custom_search_engines_use_safe_ids() {
let mut conn = db();
let mut settings = Settings::default();
settings.search.engines.push(SearchEngineSettings {
id: "my-engine_1".into(),
name: "自定义".into(),
url: "https://example.com/search?q={query}".into(),
icon: "/favicon.svg".into(),
enabled: true,
});
assert!(save(&mut conn, settings, 0).is_ok(), "合法自定义 id 应能保存");
for bad_id in ["Bad Id", "internal", "", "引擎"] {
let mut bad = Settings::default();
bad.search.engines.push(SearchEngineSettings {
id: bad_id.into(),
name: "坏".into(),
url: "https://example.com/?q={query}".into(),
icon: String::new(),
enabled: true,
});
assert!(save(&mut conn, bad, 0).is_err(), "{bad_id} 应被拒绝");
}
let mut bad_icon = Settings::default();
bad_icon.search.engines.push(SearchEngineSettings {
id: "custom-x".into(),
name: "坏图标".into(),
url: "https://example.com/?q={query}".into(),
icon: "javascript:alert(1)".into(),
enabled: true,
});
assert!(save(&mut conn, bad_icon, 0).is_err(), "非法图标地址应被拒绝");
}
#[test]
fn builtin_engines_cannot_be_removed() {
let mut conn = db();
let mut missing = Settings::default();
missing.search.engines.retain(|engine| engine.id != "duckduckgo");
assert!(save(&mut conn, missing, 0).is_err(), "缺内置引擎应被拒绝");
// 改名 / 停用不算删除,允许
let mut renamed = Settings::default();
renamed.search.engines[0].name = "改过的名字".into();
renamed.search.engines[0].enabled = false;
assert!(save(&mut conn, renamed, 0).is_ok());
}
#[test]
fn invalid_settings_are_rejected() {
let mut conn = db();
+7
View File
@@ -1606,6 +1606,13 @@ html.theme-transition .site-background {
margin-left: auto;
}
/* 引擎卡片右上角:启用开关 + 删除 */
.search-engine-actions {
display: flex;
align-items: center;
gap: var(--su-space-2);
}
.search-engine-fields {
display: grid;
grid-template-columns: minmax(0, 1fr) minmax(0, 2fr);
+9 -5
View File
@@ -10,7 +10,6 @@ import {
SearchField,
Space,
Toaster,
type EngineIconName,
type MenuItem,
} from '@stash/ui'
import { useEffect, useMemo, useRef, useState } from 'react'
@@ -70,7 +69,7 @@ type Route =
| { kind: 'item'; key: string; itemId: string }
| { kind: 'api' }
const INTERNAL_SEARCH = { id: 'internal', name: '站内搜索', url: '' } as const
const INTERNAL_SEARCH = { id: 'internal', name: '站内搜索', url: '', icon: '' } as const
const SEARCH_ENGINE_KEY = 'stash-search-engine'
@@ -363,7 +362,12 @@ export default function AppNext() {
INTERNAL_SEARCH,
...site.search.engines
.filter((engine) => engine.enabled)
.map((engine) => ({ id: engine.id, name: engine.name, url: engine.url })),
.map((engine) => ({
id: engine.id,
name: engine.name,
url: engine.url,
icon: engine.icon ?? '',
})),
]
const searchEngine =
searchEngines.find((engine) => engine.id === searchEngineId) ??
@@ -931,7 +935,7 @@ export default function AppNext() {
}
onClick={() => setEngineOpen((open) => !open)}
>
<EngineIcon name={searchEngine.id as EngineIconName} size={14} />
<EngineIcon name={searchEngine.id} src={searchEngine.icon} size={14} />
<span>{searchEngine.name}</span>
</button>
@@ -978,7 +982,7 @@ export default function AppNext() {
className={`engine-option${engine.id === searchEngine.id ? ' is-active' : ''}`}
onClick={() => chooseEngine(engine.id)}
>
<EngineIcon name={engine.id as EngineIconName} size={18} />
<EngineIcon name={engine.id} src={engine.icon} size={18} />
<span>{engine.name}</span>
</button>
))}
+55 -4
View File
@@ -28,7 +28,6 @@ import {
ToggleRow,
Toaster,
toast,
type EngineIconName,
type IconName,
type MenuItem,
} from '@stash/ui'
@@ -38,6 +37,7 @@ import { LoginDialog } from '../auth/LoginDialog'
import { GroupMark as GroupGlyph } from '../common/GroupMark'
import { isDarkScheme, readThemeOverride, writeThemeOverride } from '../../theme'
import {
BUILTIN_SEARCH_ENGINE_IDS,
DEFAULT_SEARCH_ENGINES,
fetchSettings,
saveSettings,
@@ -2092,6 +2092,35 @@ function SearchPanel({
onChange({ ...value, engines, default: nextDefault })
}
/** 自定义引擎:id 只是内部键,点「添加」自动生成,后台不用手填 */
const addEngine = () => {
if (value.engines.length >= 10) return
onChange({
...value,
engines: [
...value.engines,
{
id: `custom-${Date.now().toString(36)}`,
name: '新搜索引擎',
url: '',
icon: '',
enabled: true,
},
],
})
}
const removeEngine = (id: string) => {
// 内置引擎只能停用,不能删
if (BUILTIN_SEARCH_ENGINE_IDS.some((builtin) => builtin === id)) return
const engines = value.engines.filter((engine) => engine.id !== id)
onChange({
...value,
engines,
default: value.default === id ? 'internal' : value.default,
})
}
const defaultOptions = [
{ value: 'internal', label: '站内搜索' },
...value.engines
@@ -2103,8 +2132,8 @@ function SearchPanel({
<Space direction="column" gap="lg" align="stretch" className="admin-form">
<Title level={4}>搜索框</Title>
<Text size="sm" tone="muted">
说明:站内搜索始终可用;外部搜索引擎可以改名称、地址和启停,地址里的 {'{query}'}{' '}
会替换成关键词。默认项是刷新后搜索框选中的引擎。
说明:站内搜索始终可用;外部搜索引擎可以改名称、地址和启停,也可以自己加(最多 10 个),
地址里的 {'{query}'} 会替换成关键词。默认项是刷新后搜索框选中的引擎。
</Text>
<FormField label="默认搜索项">
@@ -2122,13 +2151,18 @@ function SearchPanel({
key={engine.id}
>
<div className="search-engine-head">
<EngineIcon name={engine.id as EngineIconName} size={18} />
<EngineIcon name={engine.id} src={engine.icon} size={18} />
<Text strong>{engine.name || engine.id}</Text>
<div className="search-engine-actions">
<Switch
checked={engine.enabled}
label={`启用 ${engine.name || engine.id}`}
onChange={(enabled) => updateEngine(engine.id, { enabled })}
/>
{!BUILTIN_SEARCH_ENGINE_IDS.some((builtin) => builtin === engine.id) && (
<TextButton onClick={() => removeEngine(engine.id)}>删除</TextButton>
)}
</div>
</div>
<div className="search-engine-fields">
<FormField label="名称" htmlFor={`search-name-${engine.id}`}>
@@ -2150,11 +2184,27 @@ function SearchPanel({
/>
</FormField>
</div>
<FormField
label="图标地址"
htmlFor={`search-icon-${engine.id}`}
hint="png / svg;留空用默认图标(内置品牌或通用地球),站内图片放 public/ 后填 /xxx.svg"
>
<Input
id={`search-icon-${engine.id}`}
value={engine.icon ?? ''}
placeholder="/icons/xxx.svg 或 https://…"
onChange={(event) => updateEngine(engine.id, { icon: event.target.value })}
/>
</FormField>
</div>
))}
</div>
<div>
<Space gap="sm" wrap>
<Button variant="secondary" onClick={addEngine} disabled={value.engines.length >= 10}>
添加搜索引擎
</Button>
<Button
variant="secondary"
onClick={() =>
@@ -2166,6 +2216,7 @@ function SearchPanel({
>
恢复默认引擎
</Button>
</Space>
</div>
</Space>
)
+26 -3
View File
@@ -78,13 +78,14 @@ export function writeCachedBackground(background: BackgroundSettings): void {
}
}
export type SearchEngineId = 'google' | 'bing' | 'baidu' | 'sogou' | '360'
export type SearchEngineSettings = {
id: SearchEngineId
/** 内置引擎用固定 id(对应品牌图标);自定义引擎由后台生成 custom-xxx */
id: string
name: string
/** 搜索地址模板,用 {query} 表示关键词 */
url: string
/** 自定义图标地址(png / svg);空表示用品牌图标或通用地球 */
icon: string
enabled: boolean
}
@@ -100,34 +101,56 @@ export const DEFAULT_SEARCH_ENGINES: SearchEngineSettings[] = [
id: 'google',
name: 'Google',
url: 'https://www.google.com/search?q={query}',
icon: '',
enabled: true,
},
{
id: 'bing',
name: 'Bing',
url: 'https://www.bing.com/search?q={query}',
icon: '',
enabled: true,
},
{
id: 'baidu',
name: '百度',
url: 'https://www.baidu.com/s?wd={query}',
icon: '',
enabled: true,
},
{
id: 'sogou',
name: '搜狗',
url: 'https://www.sogou.com/web?query={query}',
icon: '',
enabled: true,
},
{
id: '360',
name: '360',
url: 'https://www.so.com/s?q={query}',
icon: '',
enabled: true,
},
{
id: 'duckduckgo',
name: 'DuckDuckGo',
url: 'https://duckduckgo.com/?q={query}',
icon: '',
enabled: true,
},
]
/** 内置引擎:有品牌图标、后台不能删除(只能改名 / 改地址 / 停用) */
export const BUILTIN_SEARCH_ENGINE_IDS = [
'google',
'bing',
'baidu',
'sogou',
'360',
'duckduckgo',
] as const
export type SiteSettings = {
header: {
enabled: boolean