server

Documentation

Overview

Package server 包含Admin子站,HTTP,WebSocket,反向WebSocket请求处理的相关函数与结构体

Index

• Variables
• func AdminDoConfigBase(s *webServer, c *gin.Context)
• func AdminDoConfigHTTP(s *webServer, c *gin.Context)
• func AdminDoConfigJSON(s *webServer, c *gin.Context)
• func AdminDoConfigReverseWS(s *webServer, c *gin.Context)
• func AdminDoConfigWS(s *webServer, c *gin.Context)
• func AdminDoRestart(s *webServer, c *gin.Context)
• func AdminDoRestartDocker(s *webServer, c *gin.Context)
• func AdminDoWebWrite(s *webServer, c *gin.Context)
• func AdminGetConfigJSON(s *webServer, c *gin.Context)
• func AdminProcessRestart(s *webServer, c *gin.Context)
• func AdminWebWrite(s *webServer, c *gin.Context)
• func AuthMiddleWare() gin.HandlerFunc
• func Failed(code int, msg string) coolq.MSG
• func GetConf() *global.JSONConfig
• type WebSocketClient
  • func NewWebSocketClient(conf *global.GoCQReverseWebSocketConfig, authToken string, b *coolq.CQBot) *WebSocketClient
  • func (c *WebSocketClient) Run()

Variables

var API = map[string]func(*coolq.CQBot, resultGetter) coolq.MSG{
	"get_login_info":             getLoginInfo,
	"get_friend_list":            getFriendList,
	"get_group_list":             getGroupList,
	"get_group_info":             getGroupInfo,
	"get_group_member_list":      getGroupMemberList,
	"get_group_member_info":      getGroupMemberInfo,
	"send_msg":                   sendMSG,
	"send_group_msg":             sendGroupMSG,
	"send_group_forward_msg":     sendGroupForwardMSG,
	"send_private_msg":           sendPrivateMSG,
	"delete_msg":                 deleteMSG,
	"set_friend_add_request":     setFriendAddRequest,
	"set_group_add_request":      setGroupAddRequest,
	"set_group_card":             setGroupCard,
	"set_group_special_title":    setGroupSpecialTitle,
	"set_group_kick":             setGroupKick,
	"set_group_ban":              setGroupBan,
	"set_group_whole_ban":        setGroupWholeBan,
	"set_group_name":             setGroupName,
	"set_group_admin":            setGroupAdmin,
	"_send_group_notice":         sendGroupNotice,
	"set_group_leave":            setGroupLeave,
	"get_image":                  getImage,
	"get_forward_msg":            getForwardMSG,
	"get_msg":                    getMSG,
	"download_file":              downloadFile,
	"get_group_honor_info":       getGroupHonorInfo,
	"set_restart":                setRestart,
	"can_send_image":             canSendImage,
	"can_send_record":            canSendRecord,
	"get_stranger_info":          getStrangerInfo,
	"get_status":                 getStatus,
	"get_version_info":           getVersionInfo,
	"get_group_system_msg":       getGroupSystemMSG,
	"get_group_file_system_info": getGroupFileSystemInfo,
	"get_group_root_files":       getGroupRootFiles,
	"get_group_files_by_folder":  getGroupFilesByFolder,
	"get_group_file_url":         getGroupFileURL,
	"upload_group_file":          uploadGroupFile,
	"get_group_msg_history":      getGroupMsgHistory,
	"_get_vip_info":              getVipInfo,
	"reload_event_filter":        reloadEventFilter,
	".ocr_image":                 ocrImage,
	"ocr_image":                  ocrImage,
	"get_group_at_all_remain":    getGroupAtAllRemain,
	"get_online_clients":         getOnlineClients,
	".get_word_slices":           getWordSlices,
	"set_group_portrait":         setGroupPortrait,
	"set_essence_msg":            setEssenceMSG,
	"delete_essence_msg":         deleteEssenceMSG,
	"get_essence_msg_list":       getEssenceMsgList,
	"check_url_safely":           checkUrlSafely,
	"set_group_anonymous_ban":    setGroupAnonymousBan,
	".handle_quick_operation":    handleQuickOperation,
}

var APIAdminRoutingTable = map[string]func(s *webServer, c *gin.Context){
	"do_restart":         AdminDoRestart,
	"do_process_restart": AdminProcessRestart,
	"get_web_write":      AdminWebWrite,
	"do_web_write":       AdminDoWebWrite,
	"do_restart_docker":  AdminDoRestartDocker,
	"do_config_base":     AdminDoConfigBase,
	"do_config_http":     AdminDoConfigHTTP,
	"do_config_ws":       AdminDoConfigWS,
	"do_config_reverse":  AdminDoConfigReverseWS,
	"do_config_json":     AdminDoConfigJSON,
	"get_config_json":    AdminGetConfigJSON,
}

APIAdminRoutingTable Admin子站的路由映射

var Console = make(chan os.Signal, 1)

Console 控制台channel

var Debug = false

Debug 是否启用Debug模式

var JSONConfig *global.JSONConfig

JSONConfig go-cqhttp配置

var Restart = make(chan struct{}, 1)

Restart 重启信号监听channel

var WebInput = make(chan string, 1) //长度1，用于阻塞

WebInput 网页输入channel

var WebServer = &webServer{}

WebServer Admin子站的Server

var WebSocketServer = &webSocketServer{}

WebSocketServer 初始化一个WebSocketServer实例

Functions

func AdminDoConfigBase

func AdminDoConfigBase(s *webServer, c *gin.Context)

AdminDoConfigBase 普通配置修改

func AdminDoConfigHTTP

func AdminDoConfigHTTP(s *webServer, c *gin.Context)

AdminDoConfigHTTP HTTP配置修改

func AdminDoConfigJSON

func AdminDoConfigJSON(s *webServer, c *gin.Context)

AdminDoConfigJSON config.hjson配置修改

func AdminDoConfigReverseWS

func AdminDoConfigReverseWS(s *webServer, c *gin.Context)

AdminDoConfigReverseWS 反向ws配置修改

func AdminDoConfigWS

func AdminDoConfigWS(s *webServer, c *gin.Context)

AdminDoConfigWS ws配置修改

func AdminDoRestart

func AdminDoRestart(s *webServer, c *gin.Context)

AdminDoRestart 热重启

func AdminDoRestartDocker

func AdminDoRestartDocker(s *webServer, c *gin.Context)

AdminDoRestartDocker 冷重启

func AdminDoWebWrite

func AdminDoWebWrite(s *webServer, c *gin.Context)

AdminDoWebWrite web输入处理

func AdminGetConfigJSON

func AdminGetConfigJSON(s *webServer, c *gin.Context)

AdminGetConfigJSON 拉取config.hjson配置

func AdminProcessRestart

func AdminProcessRestart(s *webServer, c *gin.Context)

AdminProcessRestart 进程重启

func AdminWebWrite

func AdminWebWrite(s *webServer, c *gin.Context)

AdminWebWrite web输入html页面

func AuthMiddleWare

func AuthMiddleWare() gin.HandlerFunc

AuthMiddleWare Admin控制器登录验证

func Failed

func Failed(code int, msg string) coolq.MSG

Failed 构建失败返回MSG

func GetConf

func GetConf() *global.JSONConfig

GetConf 获取当前配置文件信息

Types

type WebSocketClient

type WebSocketClient struct {
	// contains filtered or unexported fields
}

WebSocketClient WebSocket客户端实例

func NewWebSocketClient

func NewWebSocketClient(conf *global.GoCQReverseWebSocketConfig, authToken string, b *coolq.CQBot) *WebSocketClient

NewWebSocketClient 初始化一个NWebSocket客户端

func (*WebSocketClient) Run

func (c *WebSocketClient) Run()

Run 运行实例