2022-09-15 10:44:43 +08:00
package v1
import (
2022-09-14 23:27:17 +08:00
"errors"
2023-08-02 22:36:37 +08:00
"os"
"path"
2022-09-14 23:27:17 +08:00
2022-10-17 16:32:31 +08:00
"github.com/1Panel-dev/1Panel/backend/app/api/v1/helper"
"github.com/1Panel-dev/1Panel/backend/app/dto"
"github.com/1Panel-dev/1Panel/backend/constant"
"github.com/1Panel-dev/1Panel/backend/global"
"github.com/1Panel-dev/1Panel/backend/utils/mfa"
2022-09-15 10:44:43 +08:00
"github.com/gin-gonic/gin"
)
2023-01-04 22:31:51 +08:00
// @Tags System Setting
// @Summary Load system setting info
// @Description 加载系统配置信息
// @Success 200 {object} dto.SettingInfo
// @Security ApiKeyAuth
// @Router /settings/search [post]
2022-09-15 10:44:43 +08:00
func ( b * BaseApi ) GetSettingInfo ( c * gin . Context ) {
setting , err := settingService . GetSettingInfo ( )
if err != nil {
helper . ErrorWithDetail ( c , constant . CodeErrInternalServer , constant . ErrTypeInternalServer , err )
return
}
helper . SuccessWithData ( c , setting )
}
2023-01-31 15:22:05 +08:00
// @Tags System Setting
// @Summary Load system available status
// @Description 获取系统可用状态
// @Success 200
// @Security ApiKeyAuth
// @Router /settings/search/available [get]
func ( b * BaseApi ) GetSystemAvailable ( c * gin . Context ) {
helper . SuccessWithData ( c , nil )
}
2023-01-04 22:31:51 +08:00
// @Tags System Setting
// @Summary Update system setting
// @Description 更新系统配置
// @Accept json
// @Param request body dto.SettingUpdate true "request"
// @Success 200
// @Security ApiKeyAuth
// @Router /settings/update [post]
2023-10-07 15:46:44 +08:00
// @x-panel-log {"bodyKeys":["key","value"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"修改系统配置 [key] => [value]","formatEN":"update system setting [key] => [value]"}
2022-09-09 17:17:02 +08:00
func ( b * BaseApi ) UpdateSetting ( c * gin . Context ) {
2022-09-15 10:44:43 +08:00
var req dto . SettingUpdate
2023-10-27 14:19:26 +08:00
if err := helper . CheckBindAndValidate ( & req , c ) ; err != nil {
2022-09-15 10:44:43 +08:00
return
}
2023-02-10 18:07:29 +08:00
if err := settingService . Update ( req . Key , req . Value ) ; err != nil {
2022-09-08 18:47:15 +08:00
helper . ErrorWithDetail ( c , constant . CodeErrInternalServer , constant . ErrTypeInternalServer , err )
2023-04-17 11:12:43 +08:00
return
}
helper . SuccessWithData ( c , nil )
}
2024-04-08 16:52:07 +08:00
// @Tags System Setting
// @Summary Update system setting
2024-04-11 17:16:10 +08:00
// @Description 隐藏高级功能菜单
2024-04-08 16:52:07 +08:00
// @Accept json
// @Param request body dto.SettingUpdate true "request"
// @Success 200
// @Security ApiKeyAuth
// @Router /settings/menu/update [post]
2024-04-11 17:16:10 +08:00
// @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"隐藏高级功能菜单","formatEN":"Hide advanced feature menu."}
2024-04-08 16:52:07 +08:00
func ( b * BaseApi ) UpdateMenu ( c * gin . Context ) {
var req dto . SettingUpdate
if err := helper . CheckBindAndValidate ( & req , c ) ; err != nil {
return
}
if err := settingService . Update ( req . Key , req . Value ) ; err != nil {
helper . ErrorWithDetail ( c , constant . CodeErrInternalServer , constant . ErrTypeInternalServer , err )
return
}
helper . SuccessWithData ( c , nil )
}
2023-01-04 22:31:51 +08:00
// @Tags System Setting
// @Summary Update system password
// @Description 更新系统登录密码
// @Accept json
// @Param request body dto.PasswordUpdate true "request"
// @Success 200
// @Security ApiKeyAuth
// @Router /settings/password/update [post]
2023-10-07 15:46:44 +08:00
// @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"修改系统密码","formatEN":"update system password"}
2022-09-08 18:47:15 +08:00
func ( b * BaseApi ) UpdatePassword ( c * gin . Context ) {
var req dto . PasswordUpdate
2023-10-27 14:19:26 +08:00
if err := helper . CheckBindAndValidate ( & req , c ) ; err != nil {
2022-09-08 18:47:15 +08:00
return
}
if err := settingService . UpdatePassword ( c , req . OldPassword , req . NewPassword ) ; err != nil {
2022-09-15 10:44:43 +08:00
helper . ErrorWithDetail ( c , constant . CodeErrInternalServer , constant . ErrTypeInternalServer , err )
return
}
helper . SuccessWithData ( c , nil )
}
2022-09-13 18:45:03 +08:00
2023-04-25 14:34:16 +08:00
// @Tags System Setting
// @Summary Update system ssl
// @Description 修改系统 ssl 登录
// @Accept json
// @Param request body dto.SSLUpdate true "request"
// @Success 200
// @Security ApiKeyAuth
// @Router /settings/ssl/update [post]
2023-10-07 15:46:44 +08:00
// @x-panel-log {"bodyKeys":["ssl"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"修改系统 ssl => [ssl]","formatEN":"update system ssl => [ssl]"}
2023-04-25 14:34:16 +08:00
func ( b * BaseApi ) UpdateSSL ( c * gin . Context ) {
var req dto . SSLUpdate
2023-10-27 14:19:26 +08:00
if err := helper . CheckBindAndValidate ( & req , c ) ; err != nil {
2023-04-25 14:34:16 +08:00
return
}
if err := settingService . UpdateSSL ( c , req ) ; err != nil {
helper . ErrorWithDetail ( c , constant . CodeErrInternalServer , constant . ErrTypeInternalServer , err )
return
}
helper . SuccessWithData ( c , nil )
}
// @Tags System Setting
// @Summary Load system cert info
// @Description 获取证书信息
// @Success 200 {object} dto.SettingInfo
// @Security ApiKeyAuth
// @Router /settings/ssl/info [get]
func ( b * BaseApi ) LoadFromCert ( c * gin . Context ) {
info , err := settingService . LoadFromCert ( )
if err != nil {
helper . ErrorWithDetail ( c , constant . CodeErrInternalServer , constant . ErrTypeInternalServer , err )
return
}
helper . SuccessWithData ( c , info )
}
2023-08-02 22:36:37 +08:00
// @Tags System Setting
// @Summary Download system cert
// @Description 下载证书
// @Success 200
// @Security ApiKeyAuth
// @Router /settings/ssl/download [post]
func ( b * BaseApi ) DownloadSSL ( c * gin . Context ) {
pathItem := path . Join ( global . CONF . System . BaseDir , "1panel/secret/server.crt" )
if _ , err := os . Stat ( pathItem ) ; err != nil {
helper . ErrorWithDetail ( c , constant . CodeErrInternalServer , constant . ErrTypeInternalServer , err )
return
}
c . File ( pathItem )
}
2023-10-25 10:41:26 +08:00
// @Tags System Setting
// @Summary Load system address
// @Description 获取系统地址信息
// @Accept json
// @Success 200
// @Security ApiKeyAuth
// @Router /settings/interface [get]
func ( b * BaseApi ) LoadInterfaceAddr ( c * gin . Context ) {
data , err := settingService . LoadInterfaceAddr ( )
if err != nil {
helper . ErrorWithDetail ( c , constant . CodeErrInternalServer , constant . ErrTypeInternalServer , err )
return
}
helper . SuccessWithData ( c , data )
}
// @Tags System Setting
// @Summary Update system bind info
// @Description 更新系统监听信息
// @Accept json
// @Param request body dto.BindInfo true "request"
// @Success 200
// @Security ApiKeyAuth
// @Router /settings/bind/update [post]
// @x-panel-log {"bodyKeys":["ipv6", "bindAddress"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"修改系统监听信息 => ipv6: [ipv6], 监听 IP: [bindAddress]","formatEN":"update system bind info => ipv6: [ipv6], 监听 IP: [bindAddress]"}
func ( b * BaseApi ) UpdateBindInfo ( c * gin . Context ) {
var req dto . BindInfo
2023-10-27 14:19:26 +08:00
if err := helper . CheckBindAndValidate ( & req , c ) ; err != nil {
2023-10-25 10:41:26 +08:00
return
}
if err := settingService . UpdateBindInfo ( req ) ; err != nil {
helper . ErrorWithDetail ( c , constant . CodeErrInternalServer , constant . ErrTypeInternalServer , err )
return
}
helper . SuccessWithData ( c , nil )
}
2023-01-29 16:38:34 +08:00
// @Tags System Setting
// @Summary Update system port
// @Description 更新系统端口
// @Accept json
// @Param request body dto.PortUpdate true "request"
// @Success 200
// @Security ApiKeyAuth
// @Router /settings/port/update [post]
2023-10-07 15:46:44 +08:00
// @x-panel-log {"bodyKeys":["serverPort"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"修改系统端口 => [serverPort]","formatEN":"update system port => [serverPort]"}
2023-01-29 16:38:34 +08:00
func ( b * BaseApi ) UpdatePort ( c * gin . Context ) {
var req dto . PortUpdate
2023-10-27 14:19:26 +08:00
if err := helper . CheckBindAndValidate ( & req , c ) ; err != nil {
2023-01-29 16:38:34 +08:00
return
}
if err := settingService . UpdatePort ( req . ServerPort ) ; err != nil {
helper . ErrorWithDetail ( c , constant . CodeErrInternalServer , constant . ErrTypeInternalServer , err )
return
}
helper . SuccessWithData ( c , nil )
}
2023-01-04 22:31:51 +08:00
// @Tags System Setting
// @Summary Reset system password expired
// @Description 重置过期系统登录密码
// @Accept json
// @Param request body dto.PasswordUpdate true "request"
// @Success 200
// @Security ApiKeyAuth
// @Router /settings/expired/handle [post]
2023-10-07 15:46:44 +08:00
// @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"重置过期密码","formatEN":"reset an expired Password"}
2022-09-29 16:15:59 +08:00
func ( b * BaseApi ) HandlePasswordExpired ( c * gin . Context ) {
var req dto . PasswordUpdate
2023-10-27 14:19:26 +08:00
if err := helper . CheckBindAndValidate ( & req , c ) ; err != nil {
2022-09-29 16:15:59 +08:00
return
}
if err := settingService . HandlePasswordExpired ( c , req . OldPassword , req . NewPassword ) ; err != nil {
helper . ErrorWithDetail ( c , constant . CodeErrInternalServer , constant . ErrTypeInternalServer , err )
return
}
helper . SuccessWithData ( c , nil )
}
2023-05-22 17:45:39 +08:00
// @Tags System Setting
2023-01-29 16:38:34 +08:00
// @Summary Load local backup dir
// @Description 获取安装根目录
// @Success 200 {string} path
// @Security ApiKeyAuth
// @Router /settings/basedir [get]
func ( b * BaseApi ) LoadBaseDir ( c * gin . Context ) {
helper . SuccessWithData ( c , global . CONF . System . DataDir )
}
2023-01-04 22:31:51 +08:00
// @Tags System Setting
// @Summary Load mfa info
// @Description 获取 mfa 信息
2023-09-28 15:46:18 +08:00
// @Accept json
// @Param request body dto.MfaCredential true "request"
2023-01-04 22:31:51 +08:00
// @Success 200 {object} mfa.Otp
// @Security ApiKeyAuth
2023-09-28 15:46:18 +08:00
// @Router /settings/mfa [post]
func ( b * BaseApi ) LoadMFA ( c * gin . Context ) {
var req dto . MfaRequest
2023-10-27 14:19:26 +08:00
if err := helper . CheckBindAndValidate ( & req , c ) ; err != nil {
2023-06-25 17:52:13 +08:00
return
}
2023-09-28 15:46:18 +08:00
otp , err := mfa . GetOtp ( "admin" , req . Title , req . Interval )
2022-09-14 23:27:17 +08:00
if err != nil {
helper . ErrorWithDetail ( c , constant . CodeErrInternalServer , constant . ErrTypeInternalServer , err )
return
}
helper . SuccessWithData ( c , otp )
}
2023-01-04 22:31:51 +08:00
// @Tags System Setting
// @Summary Bind mfa
// @Description Mfa 绑定
// @Accept json
// @Param request body dto.MfaCredential true "request"
// @Success 200
// @Security ApiKeyAuth
// @Router /settings/mfa/bind [post]
2023-10-07 15:46:44 +08:00
// @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"mfa 绑定","formatEN":"bind mfa"}
2022-09-14 23:27:17 +08:00
func ( b * BaseApi ) MFABind ( c * gin . Context ) {
var req dto . MfaCredential
2023-10-27 14:19:26 +08:00
if err := helper . CheckBindAndValidate ( & req , c ) ; err != nil {
2022-09-14 23:27:17 +08:00
return
}
2023-10-27 14:19:26 +08:00
2023-06-25 17:52:13 +08:00
success := mfa . ValidCode ( req . Code , req . Interval , req . Secret )
2022-09-14 23:27:17 +08:00
if ! success {
helper . ErrorWithDetail ( c , constant . CodeErrInternalServer , constant . ErrTypeInternalServer , errors . New ( "code is not valid" ) )
return
}
2023-06-25 17:52:13 +08:00
if err := settingService . Update ( "MFAInterval" , req . Interval ) ; err != nil {
helper . ErrorWithDetail ( c , constant . CodeErrInternalServer , constant . ErrTypeInternalServer , err )
return
}
2023-02-10 18:07:29 +08:00
if err := settingService . Update ( "MFAStatus" , "enable" ) ; err != nil {
2022-09-14 23:27:17 +08:00
helper . ErrorWithDetail ( c , constant . CodeErrInternalServer , constant . ErrTypeInternalServer , err )
return
}
2023-02-10 18:07:29 +08:00
if err := settingService . Update ( "MFASecret" , req . Secret ) ; err != nil {
2022-09-14 23:27:17 +08:00
helper . ErrorWithDetail ( c , constant . CodeErrInternalServer , constant . ErrTypeInternalServer , err )
return
}
helper . SuccessWithData ( c , nil )
}