2024-08-07 13:52:34 +08:00
package v2
2024-07-23 14:48:37 +08:00
import (
2024-08-07 13:52:34 +08:00
"github.com/1Panel-dev/1Panel/agent/app/api/v2/helper"
2024-07-23 14:48:37 +08:00
"github.com/1Panel-dev/1Panel/agent/app/dto"
2026-04-16 19:11:05 +08:00
"github.com/1Panel-dev/1Panel/agent/app/dto/request"
2024-07-23 14:48:37 +08:00
"github.com/1Panel-dev/1Panel/agent/global"
2025-04-17 22:26:23 +08:00
"github.com/1Panel-dev/1Panel/agent/utils/ssh"
2024-07-23 14:48:37 +08:00
"github.com/gin-gonic/gin"
)
// @Tags System Setting
// @Summary Load system setting info
// @Success 200 {object} dto.SettingInfo
// @Security ApiKeyAuth
2025-01-21 18:32:14 +08:00
// @Security Timestamp
2024-07-23 14:48:37 +08:00
// @Router /settings/search [post]
func ( b * BaseApi ) GetSettingInfo ( c * gin . Context ) {
setting , err := settingService . GetSettingInfo ()
if err != nil {
2024-10-29 18:42:12 +08:00
helper . InternalServer ( c , err )
2024-07-23 14:48:37 +08:00
return
}
helper . SuccessWithData ( c , setting )
}
2026-06-02 15:11:43 +08:00
// @Tags System Setting
// @Summary Get terminal AI setting info
// @Success 200
// @Security ApiKeyAuth
// @Security Timestamp
// @Router /settings/terminal/ai/search [post]
2026-03-19 15:25:19 +08:00
func ( b * BaseApi ) GetTerminalAISettingInfo ( c * gin . Context ) {
setting , err := settingService . GetTerminalAIInfo ()
if err != nil {
helper . InternalServer ( c , err )
return
}
helper . SuccessWithData ( c , setting )
}
2024-07-23 14:48:37 +08:00
// @Tags System Setting
// @Summary Load system available status
// @Success 200
// @Security ApiKeyAuth
2025-01-21 18:32:14 +08:00
// @Security Timestamp
2024-07-23 14:48:37 +08:00
// @Router /settings/search/available [get]
func ( b * BaseApi ) GetSystemAvailable ( c * gin . Context ) {
2025-04-18 15:44:28 +08:00
helper . Success ( c )
2024-07-23 14:48:37 +08:00
}
// @Tags System Setting
// @Summary Update system setting
// @Accept json
2026-05-08 09:54:28 +08:00
// @Param request body dto.AgentSettingUpdate true "request"
2024-07-23 14:48:37 +08:00
// @Success 200
// @Security ApiKeyAuth
2025-01-21 18:32:14 +08:00
// @Security Timestamp
2024-07-23 14:48:37 +08:00
// @Router /settings/update [post]
// @x-panel-log {"bodyKeys":["key","value"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"修改系统配置 [key] => [value]","formatEN":"update system setting [key] => [value]"}
func ( b * BaseApi ) UpdateSetting ( c * gin . Context ) {
2026-05-08 09:54:28 +08:00
var req dto . AgentSettingUpdate
2024-07-23 14:48:37 +08:00
if err := helper . CheckBindAndValidate ( & req , c ); err != nil {
return
}
if err := settingService . Update ( req . Key , req . Value ); err != nil {
2024-10-29 18:42:12 +08:00
helper . InternalServer ( c , err )
2024-07-23 14:48:37 +08:00
return
}
2025-04-18 15:44:28 +08:00
helper . Success ( c )
2024-07-23 14:48:37 +08:00
}
2026-06-02 15:11:43 +08:00
// @Tags System Setting
// @Summary Update terminal AI setting
// @Accept json
// @Param request body dto.TerminalAIInfo true "request"
// @Success 200
// @Security ApiKeyAuth
// @Security Timestamp
// @Router /settings/terminal/ai/update [post]
// @x-panel-log {"bodyKeys":["aiStatus","aiAccountId"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新终端 AI 设置 [aiStatus][aiAccountId]","formatEN":"update terminal AI setting [aiStatus][aiAccountId]"}
2026-03-19 15:25:19 +08:00
func ( b * BaseApi ) UpdateTerminalAISetting ( c * gin . Context ) {
var req dto . TerminalAIInfo
if err := helper . CheckBindAndValidate ( & req , c ); err != nil {
return
}
if err := settingService . UpdateTerminalAI ( req ); err != nil {
helper . InternalServer ( c , err )
return
}
helper . Success ( c )
}
2026-06-02 15:11:43 +08:00
// @Tags System Setting
// @Summary Get file manage AI setting info
// @Success 200
// @Security ApiKeyAuth
// @Security Timestamp
// @Router /settings/files/ai/search [post]
2026-04-03 22:11:01 +08:00
func ( b * BaseApi ) GetFileManageAISettingInfo ( c * gin . Context ) {
setting , err := settingService . GetFileManageAIInfo ()
if err != nil {
helper . InternalServer ( c , err )
return
}
helper . SuccessWithData ( c , setting )
}
2026-06-02 15:11:43 +08:00
// @Tags System Setting
// @Summary Update file manage AI setting
// @Accept json
// @Param request body dto.FileManageAIInfo true "request"
// @Success 200
// @Security ApiKeyAuth
// @Security Timestamp
// @Router /settings/files/ai/update [post]
// @x-panel-log {"bodyKeys":["aiStatus","aiAccountId"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新文件管理 AI 设置 [aiStatus][aiAccountId]","formatEN":"update file manage AI setting [aiStatus][aiAccountId]"}
2026-04-03 22:11:01 +08:00
func ( b * BaseApi ) UpdateFileManageAISetting ( c * gin . Context ) {
var req dto . FileManageAIInfo
if err := helper . CheckBindAndValidate ( & req , c ); err != nil {
return
}
if err := settingService . UpdateFileManageAI ( req ); err != nil {
helper . InternalServer ( c , err )
return
}
helper . Success ( c )
}
2026-04-16 19:11:05 +08:00
// @Tags System Setting
// @Summary Load file history setting info
// @Success 200 {object} response.FileHistorySettingInfo
// @Security ApiKeyAuth
// @Security Timestamp
// @Router /settings/file-history/search [post]
func ( b * BaseApi ) GetFileHistorySettingInfo ( c * gin . Context ) {
setting , err := settingService . GetFileHistorySettingInfo ()
if err != nil {
helper . InternalServer ( c , err )
return
}
helper . SuccessWithData ( c , setting )
}
// @Tags System Setting
// @Summary Update file history setting
// @Accept json
// @Param request body request.FileHistorySettingUpdate true "request"
// @Success 200
// @Security ApiKeyAuth
// @Security Timestamp
// @Router /settings/file-history/update [post]
func ( b * BaseApi ) UpdateFileHistorySetting ( c * gin . Context ) {
var req request . FileHistorySettingUpdate
if err := helper . CheckBindAndValidate ( & req , c ); err != nil {
return
}
if err := settingService . UpdateFileHistorySetting ( req ); err != nil {
helper . InternalServer ( c , err )
return
}
helper . Success ( c )
}
2026-05-08 16:31:15 +08:00
// @Tags System Setting
// @Summary Load website dir
// @Success 200 {string} path
// @Security ApiKeyAuth
// @Security Timestamp
// @Router /settings/website/dir [get]
func ( b * BaseApi ) LoadWebsiteDir ( c * gin . Context ) {
helper . SuccessWithData ( c , settingService . GetWebsiteDir ())
}
2024-07-23 14:48:37 +08:00
// @Tags System Setting
// @Summary Load local backup dir
// @Success 200 {string} path
// @Security ApiKeyAuth
2025-01-21 18:32:14 +08:00
// @Security Timestamp
2024-07-23 14:48:37 +08:00
// @Router /settings/basedir [get]
func ( b * BaseApi ) LoadBaseDir ( c * gin . Context ) {
2025-01-24 11:00:07 +08:00
helper . SuccessWithData ( c , global . Dir . DataDir )
2024-07-23 14:48:37 +08:00
}
2025-04-17 22:26:23 +08:00
2025-09-05 17:39:36 +08:00
// @Tags System Setting
// @Summary Load local conn
// @Success 200 {object} dto.SSHConnData
// @Security ApiKeyAuth
// @Security Timestamp
2025-09-08 22:08:42 +08:00
// @Router /settings/ssh/conn [get]
2025-09-05 17:39:36 +08:00
func ( b * BaseApi ) LoadLocalConn ( c * gin . Context ) {
2025-10-13 21:29:14 +08:00
helper . SuccessWithData ( c , settingService . GetLocalConn ())
2025-09-05 17:39:36 +08:00
}
2026-06-02 15:11:43 +08:00
// @Tags System Setting
// @Summary Check local conn
// @Success 200
// @Security ApiKeyAuth
// @Security Timestamp
// @Router /settings/ssh/check [post]
2025-04-17 22:26:23 +08:00
func ( b * BaseApi ) CheckLocalConn ( c * gin . Context ) {
2026-01-27 13:37:14 +08:00
client , err := loadLocalConn ()
if err == nil && client != nil {
client . Close ()
}
2025-04-17 22:26:23 +08:00
helper . SuccessWithData ( c , err == nil )
}
2025-12-15 15:19:21 +08:00
// @Tags System Setting
// @Summary Update local is conn
// @Accept json
// @Param request body dto.SSHDefaultConn true "request"
// @Success 200
// @Security ApiKeyAuth
// @Security Timestamp
2026-06-02 15:11:43 +08:00
// @Router /settings/ssh/default [post]
2025-12-15 15:19:21 +08:00
// @x-panel-log {"bodyKeys":["defaultConn"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"本地终端默认连接 [defaultConn]","formatEN":"update system default conn [defaultConn]"}
func ( b * BaseApi ) SetDefaultIsConn ( c * gin . Context ) {
var req dto . SSHDefaultConn
if err := helper . CheckBindAndValidate ( & req , c ); err != nil {
return
}
if err := settingService . SetDefaultIsConn ( req ); err != nil {
helper . InternalServer ( c , err )
return
}
helper . Success ( c )
}
2025-04-17 22:26:23 +08:00
// @Tags System Setting
// @Summary Check local conn info
2025-12-08 17:34:24 +08:00
// @Success 200 {boolean} isOk
2025-04-17 22:26:23 +08:00
// @Security ApiKeyAuth
// @Security Timestamp
// @Router /settings/ssh/check/info [post]
func ( b * BaseApi ) CheckLocalConnByInfo ( c * gin . Context ) {
var req dto . SSHConnData
if err := helper . CheckBindAndValidate ( & req , c ); err != nil {
return
}
2025-09-05 17:39:36 +08:00
2025-04-17 22:26:23 +08:00
helper . SuccessWithData ( c , settingService . TestConnByInfo ( req ))
}
// @Tags System Setting
// @Summary Save local conn info
// @Success 200
// @Security ApiKeyAuth
// @Security Timestamp
// @Router /settings/ssh [post]
2025-09-05 17:39:36 +08:00
func ( b * BaseApi ) SaveLocalConn ( c * gin . Context ) {
2025-04-17 22:26:23 +08:00
var req dto . SSHConnData
if err := helper . CheckBindAndValidate ( & req , c ); err != nil {
return
}
2025-09-05 17:39:36 +08:00
if err := settingService . SaveConnInfo ( req ); err != nil {
helper . InternalServer ( c , err )
return
}
helper . Success ( c )
2025-04-17 22:26:23 +08:00
}
func loadLocalConn () ( * ssh . SSHClient , error ) {
2026-05-08 09:54:28 +08:00
connInDB , err := settingService . GetLocalConnForSSH ()
if err != nil {
2025-04-17 22:26:23 +08:00
return nil , err
}
2025-09-05 17:39:36 +08:00
sshInfo := ssh . ConnInfo {
Addr : connInDB . Addr ,
Port : int ( connInDB . Port ),
User : connInDB . User ,
AuthMode : connInDB . AuthMode ,
Password : connInDB . Password ,
PrivateKey : [] byte ( connInDB . PrivateKey ),
PassPhrase : [] byte ( connInDB . PassPhrase ),
}
return ssh . NewClient ( sshInfo )
2025-04-17 22:26:23 +08:00
}
2025-04-30 18:39:53 +08:00
2025-11-24 15:55:14 +08:00
// @Tags System Setting
// @Summary Save common description
// @Accept json
// @Param request body dto.CommonDescription true "request"
// @Success 200
// @Security ApiKeyAuth
// @Security Timestamp
// @Router /settings/description/save [post]
func ( b * BaseApi ) SaveDescription ( c * gin . Context ) {
var req dto . CommonDescription
if err := helper . CheckBindAndValidate ( & req , c ); err != nil {
return
}
if err := settingService . SaveDescription ( req ); err != nil {
helper . InternalServer ( c , err )
return
}
helper . Success ( c )
}