Commit 9d384f97 by Apple\Apple

refactor(console_setting): migrate console settings to model_setting auto-injection

Backend
- Introduce `setting/console_setting` package that defines `ConsoleSetting` struct with JSON tags and validation rules.
- Register the new module with `config.GlobalConfig` to enable automatic injection/export of configuration values.
- Remove legacy `setting/console.go` and the manual `OptionMap` hooks; clean up `model/option.go`.
- Add `controller/console_migrate.go` providing `/api/option/migrate_console_setting` endpoint for one-off data migration.
- Update controllers (`misc`, `option`, `uptime_kuma`) and router to consume namespaced keys `console_setting.*`.

Frontend
- Refactor dashboard pages (`SettingsAPIInfo`, `SettingsAnnouncements`, `SettingsFAQ`, `SettingsUptimeKuma`) and detail page to read/write the new keys.
- Simplify `DashboardSetting.js` state to only include namespaced options.

BREAKING CHANGE: All console-related option keys are now stored under `console_setting.*`. Run the migration endpoint once after deployment to preserve existing data.
parent edd44b7e
...@@ -11,6 +11,7 @@ import ( ...@@ -11,6 +11,7 @@ import (
"one-api/setting" "one-api/setting"
"one-api/setting/operation_setting" "one-api/setting/operation_setting"
"one-api/setting/system_setting" "one-api/setting/system_setting"
"one-api/setting/console_setting"
"strings" "strings"
"github.com/gin-gonic/gin" "github.com/gin-gonic/gin"
...@@ -79,9 +80,9 @@ func GetStatus(c *gin.Context) { ...@@ -79,9 +80,9 @@ func GetStatus(c *gin.Context) {
"oidc_client_id": system_setting.GetOIDCSettings().ClientId, "oidc_client_id": system_setting.GetOIDCSettings().ClientId,
"oidc_authorization_endpoint": system_setting.GetOIDCSettings().AuthorizationEndpoint, "oidc_authorization_endpoint": system_setting.GetOIDCSettings().AuthorizationEndpoint,
"setup": constant.Setup, "setup": constant.Setup,
"api_info": setting.GetApiInfo(), "api_info": console_setting.GetApiInfo(),
"announcements": setting.GetAnnouncements(), "announcements": console_setting.GetAnnouncements(),
"faq": setting.GetFAQ(), "faq": console_setting.GetFAQ(),
}, },
}) })
return return
......
...@@ -6,6 +6,7 @@ import ( ...@@ -6,6 +6,7 @@ import (
"one-api/common" "one-api/common"
"one-api/model" "one-api/model"
"one-api/setting" "one-api/setting"
"one-api/setting/console_setting"
"one-api/setting/system_setting" "one-api/setting/system_setting"
"strings" "strings"
...@@ -119,8 +120,8 @@ func UpdateOption(c *gin.Context) { ...@@ -119,8 +120,8 @@ func UpdateOption(c *gin.Context) {
}) })
return return
} }
case "ApiInfo": case "console_setting.api_info":
err = setting.ValidateApiInfo(option.Value) err = console_setting.ValidateApiInfo(option.Value)
if err != nil { if err != nil {
c.JSON(http.StatusOK, gin.H{ c.JSON(http.StatusOK, gin.H{
"success": false, "success": false,
...@@ -128,8 +129,8 @@ func UpdateOption(c *gin.Context) { ...@@ -128,8 +129,8 @@ func UpdateOption(c *gin.Context) {
}) })
return return
} }
case "Announcements": case "console_setting.announcements":
err = setting.ValidateConsoleSettings(option.Value, "Announcements") err = console_setting.ValidateConsoleSettings(option.Value, "Announcements")
if err != nil { if err != nil {
c.JSON(http.StatusOK, gin.H{ c.JSON(http.StatusOK, gin.H{
"success": false, "success": false,
...@@ -137,8 +138,8 @@ func UpdateOption(c *gin.Context) { ...@@ -137,8 +138,8 @@ func UpdateOption(c *gin.Context) {
}) })
return return
} }
case "FAQ": case "console_setting.faq":
err = setting.ValidateConsoleSettings(option.Value, "FAQ") err = console_setting.ValidateConsoleSettings(option.Value, "FAQ")
if err != nil { if err != nil {
c.JSON(http.StatusOK, gin.H{ c.JSON(http.StatusOK, gin.H{
"success": false, "success": false,
......
...@@ -6,7 +6,7 @@ import ( ...@@ -6,7 +6,7 @@ import (
"errors" "errors"
"fmt" "fmt"
"net/http" "net/http"
"one-api/common" "one-api/setting/console_setting"
"strings" "strings"
"time" "time"
...@@ -77,10 +77,9 @@ func getAndDecode(ctx context.Context, client *http.Client, url string, dest int ...@@ -77,10 +77,9 @@ func getAndDecode(ctx context.Context, client *http.Client, url string, dest int
} }
func GetUptimeKumaStatus(c *gin.Context) { func GetUptimeKumaStatus(c *gin.Context) {
common.OptionMapRWMutex.RLock() cs := console_setting.GetConsoleSetting()
uptimeKumaUrl := common.OptionMap["UptimeKumaUrl"] uptimeKumaUrl := cs.UptimeKumaUrl
slug := common.OptionMap["UptimeKumaSlug"] slug := cs.UptimeKumaSlug
common.OptionMapRWMutex.RUnlock()
if uptimeKumaUrl == "" || slug == "" { if uptimeKumaUrl == "" || slug == "" {
c.JSON(http.StatusOK, gin.H{ c.JSON(http.StatusOK, gin.H{
......
...@@ -123,9 +123,6 @@ func InitOptionMap() { ...@@ -123,9 +123,6 @@ func InitOptionMap() {
common.OptionMap["SensitiveWords"] = setting.SensitiveWordsToString() common.OptionMap["SensitiveWords"] = setting.SensitiveWordsToString()
common.OptionMap["StreamCacheQueueLength"] = strconv.Itoa(setting.StreamCacheQueueLength) common.OptionMap["StreamCacheQueueLength"] = strconv.Itoa(setting.StreamCacheQueueLength)
common.OptionMap["AutomaticDisableKeywords"] = operation_setting.AutomaticDisableKeywordsToString() common.OptionMap["AutomaticDisableKeywords"] = operation_setting.AutomaticDisableKeywordsToString()
common.OptionMap["ApiInfo"] = ""
common.OptionMap["UptimeKumaUrl"] = ""
common.OptionMap["UptimeKumaSlug"] = ""
// 自动添加所有注册的模型配置 // 自动添加所有注册的模型配置
modelConfigs := config.GlobalConfig.ExportAllConfigs() modelConfigs := config.GlobalConfig.ExportAllConfigs()
......
package console_setting
import "one-api/setting/config"
type ConsoleSetting struct {
ApiInfo string `json:"api_info"` // 控制台 API 信息 (JSON 数组字符串)
UptimeKumaUrl string `json:"uptime_kuma_url"` // Uptime Kuma 服务地址(如 https://status.example.com )
UptimeKumaSlug string `json:"uptime_kuma_slug"` // Uptime Kuma Status Page Slug
Announcements string `json:"announcements"` // 系统公告 (JSON 数组字符串)
FAQ string `json:"faq"` // 常见问题 (JSON 数组字符串)
}
// 默认配置
var defaultConsoleSetting = ConsoleSetting{
ApiInfo: "",
UptimeKumaUrl: "",
UptimeKumaSlug: "",
Announcements: "",
FAQ: "",
}
// 全局实例
var consoleSetting = defaultConsoleSetting
func init() {
// 注册到全局配置管理器,键名为 console_setting
config.GlobalConfig.Register("console_setting", &consoleSetting)
}
// GetConsoleSetting 获取 ConsoleSetting 配置实例
func GetConsoleSetting() *ConsoleSetting {
return &consoleSetting
}
\ No newline at end of file
...@@ -8,11 +8,11 @@ import SettingsUptimeKuma from '../../pages/Setting/Dashboard/SettingsUptimeKuma ...@@ -8,11 +8,11 @@ import SettingsUptimeKuma from '../../pages/Setting/Dashboard/SettingsUptimeKuma
const DashboardSetting = () => { const DashboardSetting = () => {
let [inputs, setInputs] = useState({ let [inputs, setInputs] = useState({
ApiInfo: '', 'console_setting.api_info': '',
Announcements: '', 'console_setting.announcements': '',
FAQ: '', 'console_setting.faq': '',
UptimeKumaUrl: '', 'console_setting.uptime_kuma_url': '',
UptimeKumaSlug: '', 'console_setting.uptime_kuma_slug': '',
}); });
let [loading, setLoading] = useState(false); let [loading, setLoading] = useState(false);
......
...@@ -1231,10 +1231,10 @@ const Detail = (props) => { ...@@ -1231,10 +1231,10 @@ const Detail = (props) => {
{faqData.map((item, index) => ( {faqData.map((item, index) => (
<Collapse.Panel <Collapse.Panel
key={index} key={index}
header={item.title} header={item.question}
itemKey={index.toString()} itemKey={index.toString()}
> >
<p>{item.content}</p> <p>{item.answer}</p>
</Collapse.Panel> </Collapse.Panel>
))} ))}
</Collapse> </Collapse>
......
...@@ -85,7 +85,7 @@ const SettingsAPIInfo = ({ options, refresh }) => { ...@@ -85,7 +85,7 @@ const SettingsAPIInfo = ({ options, refresh }) => {
try { try {
setLoading(true); setLoading(true);
const apiInfoJson = JSON.stringify(apiInfoList); const apiInfoJson = JSON.stringify(apiInfoList);
await updateOption('ApiInfo', apiInfoJson); await updateOption('console_setting.api_info', apiInfoJson);
setHasChanges(false); setHasChanges(false);
} catch (error) { } catch (error) {
console.error('API信息更新失败', error); console.error('API信息更新失败', error);
...@@ -185,10 +185,11 @@ const SettingsAPIInfo = ({ options, refresh }) => { ...@@ -185,10 +185,11 @@ const SettingsAPIInfo = ({ options, refresh }) => {
}; };
useEffect(() => { useEffect(() => {
if (options.ApiInfo !== undefined) { const apiInfoStr = options['console_setting.api_info'] ?? options.ApiInfo;
parseApiInfo(options.ApiInfo); if (apiInfoStr !== undefined) {
parseApiInfo(apiInfoStr);
} }
}, [options.ApiInfo]); }, [options['console_setting.api_info'], options.ApiInfo]);
const columns = [ const columns = [
{ {
......
...@@ -176,7 +176,7 @@ const SettingsAnnouncements = ({ options, refresh }) => { ...@@ -176,7 +176,7 @@ const SettingsAnnouncements = ({ options, refresh }) => {
try { try {
setLoading(true); setLoading(true);
const announcementsJson = JSON.stringify(announcementsList); const announcementsJson = JSON.stringify(announcementsList);
await updateOption('Announcements', announcementsJson); await updateOption('console_setting.announcements', announcementsJson);
setHasChanges(false); setHasChanges(false);
} catch (error) { } catch (error) {
console.error('系统公告更新失败', error); console.error('系统公告更新失败', error);
...@@ -288,10 +288,11 @@ const SettingsAnnouncements = ({ options, refresh }) => { ...@@ -288,10 +288,11 @@ const SettingsAnnouncements = ({ options, refresh }) => {
}; };
useEffect(() => { useEffect(() => {
if (options.Announcements !== undefined) { const annStr = options['console_setting.announcements'] ?? options.Announcements;
parseAnnouncements(options.Announcements); if (annStr !== undefined) {
parseAnnouncements(annStr);
} }
}, [options.Announcements]); }, [options['console_setting.announcements'], options.Announcements]);
const handleBatchDelete = () => { const handleBatchDelete = () => {
if (selectedRowKeys.length === 0) { if (selectedRowKeys.length === 0) {
......
...@@ -37,8 +37,8 @@ const SettingsFAQ = ({ options, refresh }) => { ...@@ -37,8 +37,8 @@ const SettingsFAQ = ({ options, refresh }) => {
const [loading, setLoading] = useState(false); const [loading, setLoading] = useState(false);
const [hasChanges, setHasChanges] = useState(false); const [hasChanges, setHasChanges] = useState(false);
const [faqForm, setFaqForm] = useState({ const [faqForm, setFaqForm] = useState({
title: '', question: '',
content: '' answer: ''
}); });
const [currentPage, setCurrentPage] = useState(1); const [currentPage, setCurrentPage] = useState(1);
const [pageSize, setPageSize] = useState(10); const [pageSize, setPageSize] = useState(10);
...@@ -47,8 +47,8 @@ const SettingsFAQ = ({ options, refresh }) => { ...@@ -47,8 +47,8 @@ const SettingsFAQ = ({ options, refresh }) => {
const columns = [ const columns = [
{ {
title: t('问题标题'), title: t('问题标题'),
dataIndex: 'title', dataIndex: 'question',
key: 'title', key: 'question',
render: (text) => ( render: (text) => (
<div style={{ <div style={{
maxWidth: '300px', maxWidth: '300px',
...@@ -61,8 +61,8 @@ const SettingsFAQ = ({ options, refresh }) => { ...@@ -61,8 +61,8 @@ const SettingsFAQ = ({ options, refresh }) => {
}, },
{ {
title: t('回答内容'), title: t('回答内容'),
dataIndex: 'content', dataIndex: 'answer',
key: 'content', key: 'answer',
render: (text) => ( render: (text) => (
<div style={{ <div style={{
maxWidth: '400px', maxWidth: '400px',
...@@ -124,7 +124,7 @@ const SettingsFAQ = ({ options, refresh }) => { ...@@ -124,7 +124,7 @@ const SettingsFAQ = ({ options, refresh }) => {
try { try {
setLoading(true); setLoading(true);
const faqJson = JSON.stringify(faqList); const faqJson = JSON.stringify(faqList);
await updateOption('FAQ', faqJson); await updateOption('console_setting.faq', faqJson);
setHasChanges(false); setHasChanges(false);
} catch (error) { } catch (error) {
console.error('常见问答更新失败', error); console.error('常见问答更新失败', error);
...@@ -137,8 +137,8 @@ const SettingsFAQ = ({ options, refresh }) => { ...@@ -137,8 +137,8 @@ const SettingsFAQ = ({ options, refresh }) => {
const handleAddFaq = () => { const handleAddFaq = () => {
setEditingFaq(null); setEditingFaq(null);
setFaqForm({ setFaqForm({
title: '', question: '',
content: '' answer: ''
}); });
setShowFaqModal(true); setShowFaqModal(true);
}; };
...@@ -146,8 +146,8 @@ const SettingsFAQ = ({ options, refresh }) => { ...@@ -146,8 +146,8 @@ const SettingsFAQ = ({ options, refresh }) => {
const handleEditFaq = (faq) => { const handleEditFaq = (faq) => {
setEditingFaq(faq); setEditingFaq(faq);
setFaqForm({ setFaqForm({
title: faq.title, question: faq.question,
content: faq.content answer: faq.answer
}); });
setShowFaqModal(true); setShowFaqModal(true);
}; };
...@@ -169,7 +169,7 @@ const SettingsFAQ = ({ options, refresh }) => { ...@@ -169,7 +169,7 @@ const SettingsFAQ = ({ options, refresh }) => {
}; };
const handleSaveFaq = async () => { const handleSaveFaq = async () => {
if (!faqForm.title || !faqForm.content) { if (!faqForm.question || !faqForm.answer) {
showError('请填写完整的问答信息'); showError('请填写完整的问答信息');
return; return;
} }
...@@ -226,10 +226,10 @@ const SettingsFAQ = ({ options, refresh }) => { ...@@ -226,10 +226,10 @@ const SettingsFAQ = ({ options, refresh }) => {
}; };
useEffect(() => { useEffect(() => {
if (options.FAQ !== undefined) { if (options['console_setting.faq'] !== undefined) {
parseFAQ(options.FAQ); parseFAQ(options['console_setting.faq']);
} }
}, [options.FAQ]); }, [options['console_setting.faq']]);
const handleBatchDelete = () => { const handleBatchDelete = () => {
if (selectedRowKeys.length === 0) { if (selectedRowKeys.length === 0) {
...@@ -372,21 +372,21 @@ const SettingsFAQ = ({ options, refresh }) => { ...@@ -372,21 +372,21 @@ const SettingsFAQ = ({ options, refresh }) => {
> >
<Form layout='vertical' initValues={faqForm} key={editingFaq ? editingFaq.id : 'new'}> <Form layout='vertical' initValues={faqForm} key={editingFaq ? editingFaq.id : 'new'}>
<Form.Input <Form.Input
field='title' field='question'
label={t('问题标题')} label={t('问题标题')}
placeholder={t('请输入问题标题')} placeholder={t('请输入问题标题')}
maxLength={200} maxLength={200}
rules={[{ required: true, message: t('请输入问题标题') }]} rules={[{ required: true, message: t('请输入问题标题') }]}
onChange={(value) => setFaqForm({ ...faqForm, title: value })} onChange={(value) => setFaqForm({ ...faqForm, question: value })}
/> />
<Form.TextArea <Form.TextArea
field='content' field='answer'
label={t('回答内容')} label={t('回答内容')}
placeholder={t('请输入回答内容')} placeholder={t('请输入回答内容')}
maxCount={1000} maxCount={1000}
rows={6} rows={6}
rules={[{ required: true, message: t('请输入回答内容') }]} rules={[{ required: true, message: t('请输入回答内容') }]}
onChange={(value) => setFaqForm({ ...faqForm, content: value })} onChange={(value) => setFaqForm({ ...faqForm, answer: value })}
/> />
</Form> </Form>
</Modal> </Modal>
......
...@@ -22,9 +22,9 @@ const SettingsUptimeKuma = ({ options, refresh }) => { ...@@ -22,9 +22,9 @@ const SettingsUptimeKuma = ({ options, refresh }) => {
const formApiRef = useRef(null); const formApiRef = useRef(null);
const initValues = useMemo(() => ({ const initValues = useMemo(() => ({
uptimeKumaUrl: options?.UptimeKumaUrl || '', uptimeKumaUrl: options?.['console_setting.uptime_kuma_url'] || '',
uptimeKumaSlug: options?.UptimeKumaSlug || '' uptimeKumaSlug: options?.['console_setting.uptime_kuma_slug'] || ''
}), [options?.UptimeKumaUrl, options?.UptimeKumaSlug]); }), [options?.['console_setting.uptime_kuma_url'], options?.['console_setting.uptime_kuma_slug']]);
useEffect(() => { useEffect(() => {
if (formApiRef.current) { if (formApiRef.current) {
...@@ -46,18 +46,18 @@ const SettingsUptimeKuma = ({ options, refresh }) => { ...@@ -46,18 +46,18 @@ const SettingsUptimeKuma = ({ options, refresh }) => {
const trimmedUrl = (uptimeKumaUrl || '').trim(); const trimmedUrl = (uptimeKumaUrl || '').trim();
const trimmedSlug = (uptimeKumaSlug || '').trim(); const trimmedSlug = (uptimeKumaSlug || '').trim();
if (trimmedUrl === options?.UptimeKumaUrl && trimmedSlug === options?.UptimeKumaSlug) { if (trimmedUrl === options?.['console_setting.uptime_kuma_url'] && trimmedSlug === options?.['console_setting.uptime_kuma_slug']) {
showSuccess(t('无需保存,配置未变动')); showSuccess(t('无需保存,配置未变动'));
return; return;
} }
const [urlRes, slugRes] = await Promise.all([ const [urlRes, slugRes] = await Promise.all([
trimmedUrl === options?.UptimeKumaUrl ? Promise.resolve({ data: { success: true } }) : API.put('/api/option/', { trimmedUrl === options?.['console_setting.uptime_kuma_url'] ? Promise.resolve({ data: { success: true } }) : API.put('/api/option/', {
key: 'UptimeKumaUrl', key: 'console_setting.uptime_kuma_url',
value: trimmedUrl value: trimmedUrl
}), }),
trimmedSlug === options?.UptimeKumaSlug ? Promise.resolve({ data: { success: true } }) : API.put('/api/option/', { trimmedSlug === options?.['console_setting.uptime_kuma_slug'] ? Promise.resolve({ data: { success: true } }) : API.put('/api/option/', {
key: 'UptimeKumaSlug', key: 'console_setting.uptime_kuma_slug',
value: trimmedSlug value: trimmedSlug
}) })
]); ]);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment