mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-09-16 15:17:14 +00:00
bf7ce2daaa
* feat(discord): add Discord notification bot service, settings UI, and event subscriber - internal/web/service/discord: implement lightweight Discord REST API v10 client and EventBus subscriber - internal/web/service/setting: add discordBotEnable, discordBotToken, discordChannelId, discordEnabledEvents, discordCpu, discordMemory settings and secret protection - internal/web/controller: register POST /panel/api/setting/testDiscord endpoint - frontend: add Discord settings tab, notifications configuration, sidebar navigation, and command palette integration - translation: add localization keys across all 13 locales - tests: add comprehensive unit tests with httptest server and verify route/i18n contracts * fix(discord): address PR review findings on concurrency, linting, i18n, and stories - subscriber: eliminate unbounded goroutines, sending inline per EventBus contract - discord: accept context.Context in SendMessage, SendEmbed, SendTest with http.NewRequestWithContext - format: apply gofumpt to controller and entity struct alignments - i18n: localize testDiscord controller responses across all 13 locales - storybook: add DiscordNotifications.stories.tsx component story * docs: add Discord bot setup and operations guide - add docs/content/docs/en/operations/discord-bot.mdx with setup steps, event indicators, settings, and troubleshooting - add docs/content/docs/ru/operations/discord-bot.mdx with localized instructions - update operations/meta.json across en, ru, zh, fa - link Discord bot from panel configuration overview * feat(discord): add discordLang, discordRunTime, discordBotBackup settings and update settings UI - internal/web/entity: add DiscordRunTime, DiscordBotBackup, DiscordLang fields to AllSetting - internal/web/service/setting: add defaultValueMap entries, getters, and setters - frontend: update AllSetting schema, model defaults, and generate OpenAPI / Zod contracts - frontend: extract shared NotifyTimeField component and update DiscordTab with General and Notifications tabs - translation: add localization keys across all 13 locales * feat(discord): implement scheduled status reports and database backup attachments - internal/web/service/discord: add SendMessageWithFiles supporting multipart uploads - internal/web/service/discord: implement BuildReport and SendReport generating rich status embeds - internal/web/service/discord: attach database backup (and config.json) when discordBotBackup is enabled - internal/web/job: implement DiscordNotifyJob scheduled via robfig/cron - internal/web/locale: add LocalizerFor and I18nForLang helpers - internal/web/controller: trigger reloadDiscordFunc to dynamically reschedule cron upon setting changes - internal/web/web: register and reschedule DiscordNotifyJob - tests: comprehensive unit tests for multipart uploads, status reporting, and job execution * feat(discord): add interactive bot commands via Gateway WebSocket and update documentation - internal/web/service/discord/gateway: connect to Discord Gateway v10 via WebSocket (gorilla/websocket) - internal/web/service/discord/gateway: handle heartbeat loop, reconnection, and command dispatch - commands: implement !status, !report, !backup, !usage <email>, !inbounds, !restart, !help (with ! and / prefixes) - internal/web/web: start/stop Gateway client with server and reload dynamically on setting updates - docs: update operations guide (en, ru) with scheduled reports, backups, commands, and privileged intents - tests: add end-to-end WebSocket Gateway test verifying command handling * style(discord): fix goimports formatting and add 3x-ui to gitignore * fix(discord): stop gateway panics, reconnect storms and proxy bypass The Gateway client wrote to its websocket from both the heartbeat ticker and the read loop answering server-requested op 1 heartbeats. gorilla panics on concurrent writes and neither goroutine recovers, so a colliding heartbeat took the whole panel process down; writes now share writeMu. It also reconnected every 5s forever after close codes Discord marks non-reconnectable (4004 bad token, 4010-4014, including 4014 when Message Content Intent is off), re-identifying and logging a warning each time. The loop now stops on those codes; the docs say to restart the panel. The gateway dialed with websocket.DefaultDialer, bypassing the panel egress proxy the REST client already uses, so where Discord is filtered notifications arrived but commands never connected. * fix(discord): deliver the scheduled report when the backup upload fails SendReport posted the report embed and the x-ui.db/config.json attachments in one multipart request. Once the database outgrows Discord's upload cap (20 MiB by default) the request is rejected and the report embed is lost with it on every run, leaving only a log warning. Send the embed first and the attachments as a second message. * chore(discord): delete tests that pass whether or not the code works TestDiscordNotifyJob_NilServiceNoPanic and TestHandleEvent_NilDiscordService feed a nil DiscordService that web.go never passes, and TestDiscordNotifyJob_DisabledNoPanic passes with or without the enable guard because Xray is not running under test. * fix(discord): require admin user IDs for bot commands and honor discordLang Any member who could post in the configured channel could run !backup (the whole x-ui.db and config.json, even with discordBotBackup off), !restart and !usage. Commands now run only for the Discord user IDs in the new discordAdminIds setting; an empty list turns commands off. discordLang was saved and offered in the UI, but nothing read it, so every embed stayed English. The test message, alerts, the scheduled report and command replies now render through I18nForLang in the chosen language, with a discord section in all 13 locales. InitLocalizer takes an fs.FS so tests load the real translation files. --------- Co-authored-by: Sanaei <ho3ein.sanaei@gmail.com>
276 lines
7.9 KiB
Go
276 lines
7.9 KiB
Go
package discord
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"io"
|
|
"mime/multipart"
|
|
"net/http"
|
|
"os"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/mhsanaei/3x-ui/v3/internal/web/locale"
|
|
"github.com/mhsanaei/3x-ui/v3/internal/web/service"
|
|
)
|
|
|
|
const (
|
|
defaultDiscordBaseURL = "https://discord.com/api/v10"
|
|
discordUserAgent = "DiscordBot (https://github.com/mhsanaei/3x-ui, 3.x)"
|
|
|
|
ColorGreen = 0x2ECC71
|
|
ColorRed = 0xE74C3C
|
|
ColorOrange = 0xF39C12
|
|
ColorBlue = 0x3498DB
|
|
)
|
|
|
|
// FileAttachment represents a file attachment to be uploaded with a Discord message.
|
|
type FileAttachment struct {
|
|
Filename string
|
|
Data []byte
|
|
}
|
|
|
|
// MessagePayload represents the Discord create message payload.
|
|
type MessagePayload struct {
|
|
Content string `json:"content,omitempty"`
|
|
Embeds []Embed `json:"embeds,omitempty"`
|
|
}
|
|
|
|
// Embed represents a Discord embed object.
|
|
type Embed struct {
|
|
Title string `json:"title,omitempty"`
|
|
Description string `json:"description,omitempty"`
|
|
Color int `json:"color,omitempty"`
|
|
Fields []EmbedField `json:"fields,omitempty"`
|
|
Footer *EmbedFooter `json:"footer,omitempty"`
|
|
Timestamp string `json:"timestamp,omitempty"`
|
|
}
|
|
|
|
// EmbedField represents a field in a Discord embed.
|
|
type EmbedField struct {
|
|
Name string `json:"name"`
|
|
Value string `json:"value"`
|
|
Inline bool `json:"inline,omitempty"`
|
|
}
|
|
|
|
// EmbedFooter represents a footer in a Discord embed.
|
|
type EmbedFooter struct {
|
|
Text string `json:"text"`
|
|
}
|
|
|
|
// DiscordService manages communication with the Discord API.
|
|
type DiscordService struct {
|
|
settingService service.SettingService
|
|
httpClient *http.Client
|
|
baseURL string
|
|
}
|
|
|
|
// NewDiscordService creates a new DiscordService.
|
|
func NewDiscordService(settingService service.SettingService) *DiscordService {
|
|
return &DiscordService{
|
|
settingService: settingService,
|
|
baseURL: defaultDiscordBaseURL,
|
|
}
|
|
}
|
|
|
|
// SetHTTPClient sets a custom HTTP client (useful for unit testing).
|
|
func (s *DiscordService) SetHTTPClient(client *http.Client) {
|
|
s.httpClient = client
|
|
}
|
|
|
|
// SetBaseURL sets a custom base URL for the Discord API (useful for testing with httptest).
|
|
func (s *DiscordService) SetBaseURL(url string) {
|
|
s.baseURL = strings.TrimRight(url, "/")
|
|
}
|
|
|
|
func (s *DiscordService) getClient() *http.Client {
|
|
if s.httpClient != nil {
|
|
return s.httpClient
|
|
}
|
|
return s.settingService.NewProxiedHTTPClient(10 * time.Second)
|
|
}
|
|
|
|
func (s *DiscordService) getBaseURL() string {
|
|
if s.baseURL != "" {
|
|
return s.baseURL
|
|
}
|
|
return defaultDiscordBaseURL
|
|
}
|
|
|
|
func (s *DiscordService) authCredentials() (token string, channelID string, err error) {
|
|
rawToken, err := s.settingService.GetDiscordBotToken()
|
|
if err != nil || strings.TrimSpace(rawToken) == "" {
|
|
return "", "", errors.New("discord bot token is not configured")
|
|
}
|
|
rawChannel, err := s.settingService.GetDiscordChannelId()
|
|
if err != nil || strings.TrimSpace(rawChannel) == "" {
|
|
return "", "", errors.New("discord channel id is not configured")
|
|
}
|
|
|
|
cleanToken := strings.TrimSpace(rawToken)
|
|
cleanToken = strings.TrimPrefix(cleanToken, "Bot ")
|
|
cleanToken = strings.TrimSpace(cleanToken)
|
|
if cleanToken == "" {
|
|
return "", "", errors.New("discord bot token is not configured")
|
|
}
|
|
return cleanToken, strings.TrimSpace(rawChannel), nil
|
|
}
|
|
|
|
func parseDiscordResponse(resp *http.Response) error {
|
|
respBody, _ := io.ReadAll(io.LimitReader(resp.Body, 4096))
|
|
bodyStr := string(respBody)
|
|
|
|
switch resp.StatusCode {
|
|
case http.StatusOK, http.StatusCreated, http.StatusNoContent:
|
|
return nil
|
|
case http.StatusBadRequest:
|
|
return fmt.Errorf("discord bad request (400): %s", bodyStr)
|
|
case http.StatusUnauthorized:
|
|
return errors.New("discord unauthorized (401): invalid bot token")
|
|
case http.StatusForbidden:
|
|
return errors.New("discord forbidden (403): bot lacks permissions for channel")
|
|
case http.StatusNotFound:
|
|
return errors.New("discord not found (404): channel not found")
|
|
case http.StatusTooManyRequests:
|
|
return fmt.Errorf("discord rate limited (429): %s", bodyStr)
|
|
default:
|
|
return fmt.Errorf("discord API error (%d): %s", resp.StatusCode, bodyStr)
|
|
}
|
|
}
|
|
|
|
// SendMessage sends a Discord message payload to the configured channel.
|
|
func (s *DiscordService) SendMessage(ctx context.Context, payload MessagePayload) error {
|
|
if ctx == nil {
|
|
ctx = context.Background()
|
|
}
|
|
cleanToken, channelID, err := s.authCredentials()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
bodyBytes, err := json.Marshal(payload)
|
|
if err != nil {
|
|
return fmt.Errorf("marshal discord payload: %w", err)
|
|
}
|
|
|
|
endpoint := fmt.Sprintf("%s/channels/%s/messages", s.getBaseURL(), channelID)
|
|
req, err := http.NewRequestWithContext(ctx, http.MethodPost, endpoint, bytes.NewReader(bodyBytes))
|
|
if err != nil {
|
|
return fmt.Errorf("create discord request: %w", err)
|
|
}
|
|
|
|
req.Header.Set("Content-Type", "application/json")
|
|
req.Header.Set("Authorization", "Bot "+cleanToken)
|
|
req.Header.Set("User-Agent", discordUserAgent)
|
|
|
|
resp, err := s.getClient().Do(req)
|
|
if err != nil {
|
|
return fmt.Errorf("discord request failed: %w", err)
|
|
}
|
|
defer resp.Body.Close()
|
|
|
|
return parseDiscordResponse(resp)
|
|
}
|
|
|
|
// SendMessageWithFiles sends a Discord message payload with optional file attachments using multipart/form-data.
|
|
func (s *DiscordService) SendMessageWithFiles(ctx context.Context, payload MessagePayload, files ...FileAttachment) error {
|
|
if len(files) == 0 {
|
|
return s.SendMessage(ctx, payload)
|
|
}
|
|
if ctx == nil {
|
|
ctx = context.Background()
|
|
}
|
|
cleanToken, channelID, err := s.authCredentials()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
body := &bytes.Buffer{}
|
|
writer := multipart.NewWriter(body)
|
|
|
|
payloadBytes, err := json.Marshal(payload)
|
|
if err != nil {
|
|
return fmt.Errorf("marshal discord payload: %w", err)
|
|
}
|
|
|
|
if err := writer.WriteField("payload_json", string(payloadBytes)); err != nil {
|
|
return fmt.Errorf("write payload_json: %w", err)
|
|
}
|
|
|
|
for i, file := range files {
|
|
part, err := writer.CreateFormFile(fmt.Sprintf("files[%d]", i), file.Filename)
|
|
if err != nil {
|
|
return fmt.Errorf("create form file part %d: %w", i, err)
|
|
}
|
|
if _, err := part.Write(file.Data); err != nil {
|
|
return fmt.Errorf("write form file part %d: %w", i, err)
|
|
}
|
|
}
|
|
|
|
if err := writer.Close(); err != nil {
|
|
return fmt.Errorf("close multipart writer: %w", err)
|
|
}
|
|
|
|
endpoint := fmt.Sprintf("%s/channels/%s/messages", s.getBaseURL(), channelID)
|
|
req, err := http.NewRequestWithContext(ctx, http.MethodPost, endpoint, body)
|
|
if err != nil {
|
|
return fmt.Errorf("create discord request: %w", err)
|
|
}
|
|
|
|
req.Header.Set("Content-Type", writer.FormDataContentType())
|
|
req.Header.Set("Authorization", "Bot "+cleanToken)
|
|
req.Header.Set("User-Agent", discordUserAgent)
|
|
|
|
resp, err := s.getClient().Do(req)
|
|
if err != nil {
|
|
return fmt.Errorf("discord request failed: %w", err)
|
|
}
|
|
defer resp.Body.Close()
|
|
|
|
return parseDiscordResponse(resp)
|
|
}
|
|
|
|
// SendEmbed is a helper to send an embed payload.
|
|
func (s *DiscordService) SendEmbed(ctx context.Context, embed Embed) error {
|
|
return s.SendMessage(ctx, MessagePayload{
|
|
Embeds: []Embed{embed},
|
|
})
|
|
}
|
|
|
|
// translator renders messages in the configured Discord bot language, read once per message.
|
|
func translator(settingService service.SettingService) func(key string, params ...string) string {
|
|
lang, err := settingService.GetDiscordLang()
|
|
if err != nil || lang == "" {
|
|
lang = "en-US"
|
|
}
|
|
return func(key string, params ...string) string {
|
|
return locale.I18nForLang(lang, key, params...)
|
|
}
|
|
}
|
|
|
|
// SendTest sends a test embed to verify Discord bot configuration.
|
|
func (s *DiscordService) SendTest(ctx context.Context) error {
|
|
tr := translator(s.settingService)
|
|
now := time.Now().UTC().Format(time.RFC3339)
|
|
hostname, _ := os.Hostname()
|
|
if hostname == "" {
|
|
hostname = "3x-ui"
|
|
}
|
|
embed := Embed{
|
|
Title: tr("discord.test.title"),
|
|
Description: tr("discord.test.body"),
|
|
Color: ColorGreen,
|
|
Timestamp: now,
|
|
Fields: []EmbedField{
|
|
{Name: tr("host"), Value: hostname, Inline: true},
|
|
},
|
|
Footer: &EmbedFooter{
|
|
Text: tr("discord.footer"),
|
|
},
|
|
}
|
|
return s.SendEmbed(ctx, embed)
|
|
}
|