2024-08-07 13:52:34 +08:00
package v2
2024-07-19 19:04:11 +08:00
import (
"encoding/base64"
"errors"
2026-06-17 15:31:51 +08:00
"net"
2025-03-14 10:08:31 +08:00
"net/http"
2024-07-19 19:04:11 +08:00
"os"
"path"
2025-03-14 10:08:31 +08:00
"regexp"
2026-06-02 15:13:59 +08:00
"strconv"
2026-01-08 14:01:43 +08:00
"strings"
2024-07-19 19:04:11 +08:00
2024-08-07 13:52:34 +08:00
"github.com/1Panel-dev/1Panel/core/app/api/v2/helper"
2026-04-23 17:00:50 +08:00
appauth "github.com/1Panel-dev/1Panel/core/app/auth"
2024-07-19 19:04:11 +08:00
"github.com/1Panel-dev/1Panel/core/app/dto"
2026-01-09 16:50:01 +08:00
"github.com/1Panel-dev/1Panel/core/buserr"
2024-07-19 19:04:11 +08:00
"github.com/1Panel-dev/1Panel/core/constant"
"github.com/1Panel-dev/1Panel/core/global"
2026-09-15 10:04:44 +08:00
"github.com/1Panel-dev/1Panel/core/init/session/psession"
2026-02-24 17:19:13 +08:00
"github.com/1Panel-dev/1Panel/core/utils/common"
2024-07-19 19:04:11 +08:00
"github.com/gin-gonic/gin"
)
2026-09-15 10:04:44 +08:00
// @Tags System Setting
// @Summary Load current user's file download preference
// @Success 200 {object} dto.FileDownloadPreference
// @Router /core/settings/file/download [get]
func ( b * BaseApi ) GetFileDownloadPreference ( c * gin . Context ) {
user , ok := fileDownloadPreferenceUser ( c )
if ! ok {
return
}
preference , err := settingService . GetFileDownloadPreference ( user . ID )
if err != nil {
helper . InternalServer ( c , err )
return
}
helper . SuccessWithData ( c , preference )
}
// @Tags System Setting
// @Summary Update current user's file download preference
// @Accept json
// @Param request body dto.FileDownloadPreference true "request"
// @Success 200
// @Router /core/settings/file/download [post]
func ( b * BaseApi ) UpdateFileDownloadPreference ( c * gin . Context ) {
user , ok := fileDownloadPreferenceUser ( c )
if ! ok {
return
}
var req dto . FileDownloadPreference
if err := helper . CheckBindAndValidate ( & req , c ); err != nil {
return
}
if err := settingService . UpdateFileDownloadPreference ( user . ID , req ); err != nil {
helper . InternalServer ( c , err )
return
}
helper . Success ( c )
}
func fileDownloadPreferenceUser ( c * gin . Context ) ( psession . SessionUser , bool ) {
user , err := global . SESSION . Get ( c )
if err != nil || user . ID == "" {
helper . BadAuth ( c , "ErrNotLogin" , buserr . New ( "ErrNotLogin" ))
return psession . SessionUser {}, false
}
return user , true
}
2024-07-19 19:04:11 +08:00
// @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-08-06 16:20:31 +08:00
// @Router /core/settings/search [post]
2024-07-19 19:04:11 +08:00
func ( b * BaseApi ) GetSettingInfo ( c * gin . Context ) {
setting , err := settingService . GetSettingInfo ()
if err != nil {
2025-09-25 18:44:08 +08:00
helper . InternalServer ( c , err )
return
}
helper . SuccessWithData ( c , setting )
}
2026-04-23 17:00:50 +08:00
// @Tags System Setting
// @Summary Load base system setting info
// @Success 200 {object} dto.SettingBaseInfo
// @Security ApiKeyAuth
// @Security Timestamp
// @Router /core/settings/search/base [post]
func ( b * BaseApi ) GetSettingBaseInfo ( c * gin . Context ) {
setting , err := settingService . GetSettingBaseInfo ()
if err != nil {
helper . InternalServer ( c , err )
return
}
helper . SuccessWithData ( c , setting )
}
2025-09-25 18:44:08 +08:00
// @Tags System Setting
2024-08-22 18:46:54 +08:00
// @Summary Load system terminal setting info
// @Success 200 {object} dto.TerminalInfo
// @Security ApiKeyAuth
2025-01-21 18:32:14 +08:00
// @Security Timestamp
2024-08-22 18:46:54 +08:00
// @Router /core/settings/terminal/search [post]
func ( b * BaseApi ) GetTerminalSettingInfo ( c * gin . Context ) {
setting , err := settingService . GetTerminalInfo ()
if err != nil {
2025-01-24 11:00:07 +08:00
helper . InternalServer ( c , err )
2024-08-22 18:46:54 +08:00
return
}
helper . SuccessWithData ( c , setting )
}
2024-07-19 19:04:11 +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-08-06 16:20:31 +08:00
// @Router /core/settings/search/available [get]
2024-07-19 19:04:11 +08:00
func ( b * BaseApi ) GetSystemAvailable ( c * gin . Context ) {
2025-04-18 16:52:27 +08:00
helper . Success ( c )
2024-07-19 19:04:11 +08:00
}
// @Tags System Setting
// @Summary Update system setting
// @Accept json
// @Param request body dto.SettingUpdate true "request"
// @Success 200
// @Security ApiKeyAuth
2025-01-21 18:32:14 +08:00
// @Security Timestamp
2024-08-06 16:20:31 +08:00
// @Router /core/settings/update [post]
2024-07-19 19:04:11 +08:00
// @x-panel-log {"bodyKeys":["key","value"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"修改系统配置 [key] => [value]","formatEN":"update system setting [key] => [value]"}
func ( b * BaseApi ) UpdateSetting ( c * gin . Context ) {
var req dto . SettingUpdate
2026-09-20 18:32:54 +08:00
if err := c . ShouldBindJSON ( & req ); err != nil {
helper . BadRequest ( c , err )
return
}
if appauth . IsAPICredentialSetting ( req . Key ) {
helper . BadRequest ( c , buserr . New ( "ErrInvalidParams" ))
return
}
if err := global . VALID . Struct ( & req ); err != nil {
helper . BadRequest ( c , err )
2024-07-19 19:04:11 +08:00
return
}
2025-03-19 17:17:22 +08:00
if req . Key == "SecurityEntrance" {
if ! checkEntrancePattern ( req . Value ) {
2026-01-09 16:50:01 +08:00
helper . ErrorWithDetail ( c , http . StatusBadRequest , "ErrInvalidParams" , buserr . WithName ( "ErrEntranceFormat" , req . Value ))
2025-03-19 17:17:22 +08:00
return
}
}
2026-06-02 15:13:59 +08:00
if ! checkSettingValueRange ( req . Key , req . Value ) {
helper . ErrorWithDetail ( c , http . StatusBadRequest , "ErrInvalidParams" , buserr . WithName ( "ErrInvalidParams" , req . Value ))
return
}
2026-02-24 17:19:13 +08:00
if req . Key == "PasskeyTrustedProxies" {
value , err := normalizePasskeyTrustedProxies ( req . Value )
if err != nil {
helper . BadRequest ( c , err )
return
}
req . Value = value
}
2026-08-21 17:33:14 +08:00
if req . Key == "AllowIPTrustedProxies" {
value , err := common . NormalizeTrustedProxies ( req . Value )
if err != nil {
helper . BadRequest ( c , err )
return
}
req . Value = value
}
2025-03-19 17:17:22 +08:00
2026-04-14 09:39:45 +08:00
if err := settingService . Update ( c , req . Key , req . Value ); err != nil {
2025-01-24 11:00:07 +08:00
helper . InternalServer ( c , err )
2024-08-22 18:46:54 +08:00
return
}
2025-02-26 17:02:17 +08:00
if req . Key == "SecurityEntrance" {
2026-04-23 17:00:50 +08:00
appauth . SetSecurityEntranceCookie ( c , req . Value )
2025-02-26 17:02:17 +08:00
}
2025-04-18 16:52:27 +08:00
helper . Success ( c )
2024-08-22 18:46:54 +08:00
}
2026-06-02 15:13:59 +08:00
func checkSettingValueRange ( key , value string ) bool {
switch key {
case "SessionTimeout" :
valueNum , err := strconv . Atoi ( value )
if err != nil {
return false
}
return valueNum >= 300 && valueNum <= 864000
case "ExpirationDays" :
valueNum , err := strconv . Atoi ( value )
if err != nil {
return false
}
return valueNum >= 0 && valueNum <= 60
default :
return true
}
}
2024-08-22 18:46:54 +08:00
// @Tags System Setting
// @Summary Update system terminal setting
// @Accept json
2026-09-09 18:39:08 +08:00
// @Param request body dto.TerminalUpdate true "request"
2024-08-22 18:46:54 +08:00
// @Success 200
// @Security ApiKeyAuth
2025-01-21 18:32:14 +08:00
// @Security Timestamp
2024-08-22 18:46:54 +08:00
// @Router /core/settings/terminal/update [post]
// @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"修改系统终端配置","formatEN":"update system terminal setting"}
func ( b * BaseApi ) UpdateTerminalSetting ( c * gin . Context ) {
2026-09-09 18:39:08 +08:00
var req dto . TerminalUpdate
2024-08-22 18:46:54 +08:00
if err := helper . CheckBindAndValidate ( & req , c ); err != nil {
return
}
if err := settingService . UpdateTerminal ( req ); err != nil {
2025-01-24 11:00:07 +08:00
helper . InternalServer ( c , err )
2024-07-19 19:04:11 +08:00
return
}
2025-04-18 16:52:27 +08:00
helper . Success ( c )
2024-07-19 19:04:11 +08:00
}
// @Tags System Setting
// @Summary Update proxy setting
// @Accept json
// @Param request body dto.ProxyUpdate true "request"
// @Success 200
// @Security ApiKeyAuth
2025-01-21 18:32:14 +08:00
// @Security Timestamp
2024-08-06 16:20:31 +08:00
// @Router /core/settings/proxy/update [post]
2024-07-19 19:04:11 +08:00
// @x-panel-log {"bodyKeys":["proxyUrl","proxyPort"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"服务器代理配置 [proxyPort]:[proxyPort]","formatEN":"set proxy [proxyPort]:[proxyPort]."}
func ( b * BaseApi ) UpdateProxy ( c * gin . Context ) {
var req dto . ProxyUpdate
if err := helper . CheckBindAndValidate ( & req , c ); err != nil {
return
}
if len ( req . ProxyPasswd ) != 0 && len ( req . ProxyType ) != 0 {
pass , err := base64 . StdEncoding . DecodeString ( req . ProxyPasswd )
if err != nil {
2024-10-29 18:42:12 +08:00
helper . BadRequest ( c , err )
2024-07-19 19:04:11 +08:00
return
}
req . ProxyPasswd = string ( pass )
}
if err := settingService . UpdateProxy ( req ); err != nil {
2025-01-24 11:00:07 +08:00
helper . InternalServer ( c , err )
2024-07-19 19:04:11 +08:00
return
}
2025-04-18 16:52:27 +08:00
helper . Success ( c )
2024-07-19 19:04:11 +08:00
}
// @Tags System Setting
// @Summary Update system setting
// @Accept json
// @Param request body dto.SettingUpdate true "request"
// @Success 200
// @Security ApiKeyAuth
2025-01-21 18:32:14 +08:00
// @Security Timestamp
2024-08-06 16:20:31 +08:00
// @Router /core/settings/menu/update [post]
2024-07-19 19:04:11 +08:00
// @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"隐藏高级功能菜单","formatEN":"Hide advanced feature menu."}
func ( b * BaseApi ) UpdateMenu ( c * gin . Context ) {
var req dto . SettingUpdate
if err := helper . CheckBindAndValidate ( & req , c ); err != nil {
return
}
2026-04-14 09:39:45 +08:00
if err := settingService . Update ( c , req . Key , req . Value ); err != nil {
2025-10-16 14:40:09 +08:00
helper . InternalServer ( c , err )
return
}
helper . Success ( c )
}
// @Tags Menu Setting
// @Summary Default menu
// @Accept json
// @Success 200
// @Security ApiKeyAuth
// @Security Timestamp
// @Router /core/settings/menu/default [post]
// @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"初始化菜单","formatEN":"Init menu."}
func ( b * BaseApi ) DefaultMenu ( c * gin . Context ) {
if err := settingService . DefaultMenu (); err != nil {
2025-01-24 11:00:07 +08:00
helper . InternalServer ( c , err )
2024-07-19 19:04:11 +08:00
return
}
2025-04-18 16:52:27 +08:00
helper . Success ( c )
2024-07-19 19:04:11 +08:00
}
// @Tags System Setting
// @Summary Update system ssl
// @Accept json
// @Param request body dto.SSLUpdate true "request"
// @Success 200
// @Security ApiKeyAuth
2025-01-21 18:32:14 +08:00
// @Security Timestamp
2024-08-06 16:20:31 +08:00
// @Router /core/settings/ssl/update [post]
2024-07-19 19:04:11 +08:00
// @x-panel-log {"bodyKeys":["ssl"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"修改系统 ssl => [ssl]","formatEN":"update system ssl => [ssl]"}
func ( b * BaseApi ) UpdateSSL ( c * gin . Context ) {
var req dto . SSLUpdate
if err := helper . CheckBindAndValidate ( & req , c ); err != nil {
return
}
if err := settingService . UpdateSSL ( c , req ); err != nil {
2025-01-24 11:00:07 +08:00
helper . InternalServer ( c , err )
2024-07-19 19:04:11 +08:00
return
}
2025-04-18 16:52:27 +08:00
helper . Success ( c )
2024-07-19 19:04:11 +08:00
}
// @Tags System Setting
// @Summary Load system cert info
2025-01-21 18:32:14 +08:00
// @Success 200 {object} dto.SSLInfo
2024-07-19 19:04:11 +08:00
// @Security ApiKeyAuth
2025-01-21 18:32:14 +08:00
// @Security Timestamp
2024-08-06 16:20:31 +08:00
// @Router /core/settings/ssl/info [get]
2024-07-19 19:04:11 +08:00
func ( b * BaseApi ) LoadFromCert ( c * gin . Context ) {
info , err := settingService . LoadFromCert ()
if err != nil {
2025-01-24 11:00:07 +08:00
helper . InternalServer ( c , err )
2024-07-19 19:04:11 +08:00
return
}
helper . SuccessWithData ( c , info )
}
// @Tags System Setting
// @Summary Download system cert
// @Success 200
// @Security ApiKeyAuth
2025-01-21 18:32:14 +08:00
// @Security Timestamp
2024-08-06 16:20:31 +08:00
// @Router /core/settings/ssl/download [post]
2024-07-19 19:04:11 +08:00
func ( b * BaseApi ) DownloadSSL ( c * gin . Context ) {
2025-01-24 11:00:07 +08:00
pathItem := path . Join ( global . CONF . Base . InstallDir , "1panel/secret/server.crt" )
2024-07-19 19:04:11 +08:00
if _ , err := os . Stat ( pathItem ); err != nil {
2025-01-24 11:00:07 +08:00
helper . InternalServer ( c , err )
2024-07-19 19:04:11 +08:00
return
}
c . File ( pathItem )
}
// @Tags System Setting
// @Summary Load system address
// @Accept json
2025-01-21 18:32:14 +08:00
// @Success 200 {array} string
2024-07-19 19:04:11 +08:00
// @Security ApiKeyAuth
2025-01-21 18:32:14 +08:00
// @Security Timestamp
2024-08-06 16:20:31 +08:00
// @Router /core/settings/interface [get]
2024-07-19 19:04:11 +08:00
func ( b * BaseApi ) LoadInterfaceAddr ( c * gin . Context ) {
data , err := settingService . LoadInterfaceAddr ()
if err != nil {
2025-01-24 11:00:07 +08:00
helper . InternalServer ( c , err )
2024-07-19 19:04:11 +08:00
return
}
helper . SuccessWithData ( c , data )
}
// @Tags System Setting
// @Summary Update system bind info
// @Accept json
// @Param request body dto.BindInfo true "request"
// @Success 200
// @Security ApiKeyAuth
2025-01-21 18:32:14 +08:00
// @Security Timestamp
2024-08-06 16:20:31 +08:00
// @Router /core/settings/bind/update [post]
2024-07-19 19:04:11 +08:00
// @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
if err := helper . CheckBindAndValidate ( & req , c ); err != nil {
return
}
if err := settingService . UpdateBindInfo ( req ); err != nil {
2025-01-24 11:00:07 +08:00
helper . InternalServer ( c , err )
2024-07-19 19:04:11 +08:00
return
}
2025-04-18 16:52:27 +08:00
helper . Success ( c )
2024-07-19 19:04:11 +08:00
}
// @Tags System Setting
// @Summary Update system port
// @Accept json
// @Param request body dto.PortUpdate true "request"
// @Success 200
// @Security ApiKeyAuth
2025-01-21 18:32:14 +08:00
// @Security Timestamp
2024-08-06 16:20:31 +08:00
// @Router /core/settings/port/update [post]
2024-07-19 19:04:11 +08:00
// @x-panel-log {"bodyKeys":["serverPort"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"修改系统端口 => [serverPort]","formatEN":"update system port => [serverPort]"}
func ( b * BaseApi ) UpdatePort ( c * gin . Context ) {
var req dto . PortUpdate
if err := helper . CheckBindAndValidate ( & req , c ); err != nil {
return
}
if err := settingService . UpdatePort ( req . ServerPort ); err != nil {
2025-01-24 11:00:07 +08:00
helper . InternalServer ( c , err )
2024-07-19 19:04:11 +08:00
return
}
2025-04-18 16:52:27 +08:00
helper . Success ( c )
2024-07-19 19:04:11 +08:00
}
2026-06-02 15:11:43 +08:00
// @Tags System Setting
// @Summary Reload SSL
// @Success 200
// @Security ApiKeyAuth
// @Security Timestamp
// @Router /core/settings/ssl/reload [post]
// @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"重载系统 SSL","formatEN":"reload system SSL"}
2024-12-23 16:59:46 +08:00
func ( b * BaseApi ) ReloadSSL ( c * gin . Context ) {
2026-11-08 22:39:54 +08:00
clientIP := common . GetRealClientIP ( c )
2026-06-17 15:31:51 +08:00
if ip := net . ParseIP ( clientIP ); ip == nil || ! ip . IsLoopback () {
2025-01-24 11:00:07 +08:00
helper . InternalServer ( c , errors . New ( "only localhost can reload ssl" ))
2024-12-23 16:59:46 +08:00
return
}
if err := settingService . UpdateSystemSSL (); err != nil {
2025-01-24 11:00:07 +08:00
helper . InternalServer ( c , err )
2024-12-23 16:59:46 +08:00
return
}
2025-04-18 16:52:27 +08:00
helper . Success ( c )
2024-12-23 16:59:46 +08:00
}
2025-01-21 18:32:14 +08:00
2025-05-06 18:07:37 +08:00
// @Tags App
// @Summary Update appstore config
// @Accept json
// @Param request body dto.AppstoreUpdate true "request"
// @Success 200
// @Security ApiKeyAuth
// @Security Timestamp
2025-09-11 22:03:31 +08:00
// @Router /core/settings/apps/store/update [post]
2025-05-06 18:07:37 +08:00
func ( b * BaseApi ) UpdateAppstoreConfig ( c * gin . Context ) {
var req dto . AppstoreUpdate
if err := helper . CheckBindAndValidate ( & req , c ); err != nil {
return
}
err := settingService . UpdateAppstoreConfig ( req )
if err != nil {
helper . InternalServer ( c , err )
return
}
helper . Success ( c )
}
// @Tags App
// @Summary Get appstore config
// @Success 200 {object} dto.AppstoreConfig
// @Security ApiKeyAuth
// @Security Timestamp
2025-09-11 22:03:31 +08:00
// @Router /core/settings/apps/store/config [get]
2025-05-06 18:07:37 +08:00
func ( b * BaseApi ) GetAppstoreConfig ( c * gin . Context ) {
res , err := settingService . GetAppstoreConfig ()
if err != nil {
helper . InternalServer ( c , err )
return
}
helper . SuccessWithData ( c , res )
}
2026-01-30 14:53:44 +08:00
// @Tags System Setting
// @Summary Load dashboard memo
// @Success 200 {string} memo
// @Security ApiKeyAuth
// @Security Timestamp
// @Router /core/settings/memo [get]
func ( b * BaseApi ) GetMemo ( c * gin . Context ) {
memo , err := settingService . GetMemo ()
if err != nil {
helper . InternalServer ( c , err )
return
}
helper . SuccessWithData ( c , memo )
}
// @Tags System Setting
// @Summary Update dashboard memo
// @Accept json
// @Param request body dto.MemoUpdate true "request"
// @Success 200
// @Security ApiKeyAuth
// @Security Timestamp
// @Router /core/settings/memo [post]
// @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新仪表盘备忘录","formatEN":"update dashboard memo"}
func ( b * BaseApi ) UpdateMemo ( c * gin . Context ) {
var req dto . MemoUpdate
if err := helper . CheckBindAndValidate ( & req , c ); err != nil {
return
}
if err := settingService . UpdateMemo ( req . Content ); err != nil {
helper . InternalServer ( c , err )
return
}
helper . Success ( c )
}
2025-03-14 10:08:31 +08:00
func checkEntrancePattern ( val string ) bool {
if len ( val ) == 0 {
return true
}
result , _ := regexp . MatchString ( "^[a-zA-Z0-9]{5,116}$" , val )
2026-01-08 14:01:43 +08:00
if ! result {
return false
}
lowerVal := strings . ToLower ( val )
for key := range constant . WebUrlMap {
if key == "/" || ! strings . HasPrefix ( key , "/" ) {
continue
}
if strings . Count ( key , "/" ) != 1 {
continue
}
segment := strings . ToLower ( strings . TrimPrefix ( key , "/" ))
if len ( segment ) < 5 {
continue
}
if lowerVal == segment {
return false
}
}
assetsList := [ 2 ] string { "public" , "assets" }
for _ , item := range assetsList {
if lowerVal == item {
return false
}
}
return true
2025-03-14 10:08:31 +08:00
}
2026-02-24 17:19:13 +08:00
func normalizePasskeyTrustedProxies ( value string ) ( string , error ) {
if strings . TrimSpace ( value ) == "" {
return "" , nil
}
lines := strings . Split ( value , "\n" )
validLines := make ([] string , 0 , len ( lines ))
for _ , line := range lines {
line = strings . TrimSpace ( line )
if line == "" {
continue
}
validLines = append ( validLines , line )
}
if len ( validLines ) == 0 {
return "" , nil
}
normalized := strings . Join ( validLines , "\n" )
if _ , err := common . HandleIPList ( normalized ); err != nil {
return "" , err
}
return normalized , nil
}