package main import ( "encoding/json" "errors" "fmt" "math/rand" "os" "path/filepath" "syscall" "time" "github.com/eleksir/go-xmpp" "github.com/hjson/hjson-go" log "github.com/sirupsen/logrus" "golang.org/x/exp/slices" ) // sigHandler() Хэндлер сигналов закрывает все бд, все сетевые соединения и сваливает из приложения. func sigHandler() { log.Debug("Installing signal handler") for s := range sigChan { switch s { case syscall.SIGINT: log.Infoln("Got SIGINT, quitting") case syscall.SIGTERM: log.Infoln("Got SIGTERM, quitting") case syscall.SIGQUIT: log.Infoln("Got SIGQUIT, quitting") // Заходим на новую итерацию, если у нас "неинтересный" сигнал. default: continue } // Чтобы не срать в логи ошибками, проставим shutdown state приложения в true. shutdown = true if isConnected && !shutdown { log.Debug("Try to set our presence to Unavailable and status to Offline") // Вот тут понадобится коллекция известных пользователей, чтобы им разослать presence, что бот свалил в offline // Пока за неимением лучшего сообщим об этом самим себе. for _, room := range roomsConnected { if _, err := talk.SendPresence( xmpp.Presence{ //nolint:exhaustruct To: room, Status: "Offline", Type: "unavailable", }, ); err != nil { log.Infof("Unable to send presence to jabber server: %s", err) } } // И закрываем соединение. log.Debugf("Closing connection to jabber server") if err := talk.Close(); err != nil { log.Infof("Unable to close connection to jabber server: %s", err) } } os.Exit(0) } } // readConfig читает и валидирует конфиг, а также выставляет некоторые default-ы, если значений для параметров в конфиге // нет. func readConfig() { //nolint:gocognit configLoaded := false executablePath, err := os.Executable() if err != nil { log.Errorf("Unable to get current executable path: %s", err) os.Exit(1) } configJSONPath := fmt.Sprintf("%s/data/config.json", filepath.Dir(executablePath)) locations := []string{ "~/.buny-jabber-bot.json", "~/buny-jabber-bot.json", "/etc/buny-jabber-bot.json", configJSONPath, } for _, location := range locations { fileInfo, err := os.Stat(location) // Предполагаем, что файла либо нет, либо мы не можем его прочитать, второе надо бы логгировать, но пока забьём. if err != nil { continue } // Конфиг-файл длинноват для конфига, попробуем следующего кандидата. if fileInfo.Size() > 65535 { log.Warnf("Config file %s is too long for config, skipping", location) continue } buf, err := os.ReadFile(location) // Не удалось прочитать, попробуем следующего кандидата. if err != nil { log.Warnf("Skip reading config file %s: %s", location, err) continue } // Исходя из документации, hjson какбы умеет парсить "кривой" json, но парсит его в map-ку. // Интереснее на выходе получить структурку: то есть мы вначале конфиг преобразуем в map-ку, затем эту map-ку // сериализуем в json, а потом json превращаем в структурку. Не очень эффективно, но он и нечасто требуется. var ( sampleConfig myConfig tmp map[string]interface{} ) err = hjson.Unmarshal(buf, &tmp) // Не удалось распарсить - попробуем следующего кандидата. if err != nil { log.Warnf("Skip parsing config file %s: %s", location, err) continue } tmpJSON, err := json.Marshal(tmp) // Не удалось преобразовать map-ку в json if err != nil { log.Warnf("Skip parsing config file %s: %s", location, err) continue } if err := json.Unmarshal(tmpJSON, &sampleConfig); err != nil { log.Warnf("Skip parsing config file %s: %s", location, err) continue } // Значения для Jabber-клиента if sampleConfig.Jabber.Server == "" { log.Error("Jabber server is not defined in config, using localhost") sampleConfig.Jabber.Server = "localhost" //nolint:wsl } if sampleConfig.Jabber.Port == 0 { sampleConfig.Jabber.Port = 5222 if sampleConfig.Jabber.Ssl { if !sampleConfig.Jabber.StartTLS { sampleConfig.Jabber.Port = 5223 log.Info("Jabber port is not defined in config, using 5223") } else { log.Info("Jabber port is not defined in config, using 5222") } } } if !sampleConfig.Jabber.Ssl { sampleConfig.Jabber.StartTLS = false } if !sampleConfig.Jabber.Ssl || !sampleConfig.Jabber.StartTLS { sampleConfig.Jabber.SslVerify = false } // sampleConfig.Jabber.InsecureAllowUnencryptedAuth = false, если не задан if sampleConfig.Jabber.ConnectionTimeout == 0 { sampleConfig.Jabber.ConnectionTimeout = 10 log.Info("Jabber server connection_timeout not defined in config, using 10 seconds") } if sampleConfig.Jabber.ReconnectDelay == 0 { sampleConfig.Jabber.ReconnectDelay = 3 log.Info("Jabber server reconnect_delay not defined in config, using 3 seconds") } if sampleConfig.Jabber.ServerPingDelay == 0 { sampleConfig.Jabber.ServerPingDelay = 60 log.Info("Jabber server_ping_delay not defined in config, using 60 seconds") } if sampleConfig.Jabber.MucPingDelay == 0 { sampleConfig.Jabber.MucPingDelay = 900 log.Info("Jabber muc_ping_delay not defined in config, using 900 seconds") } if sampleConfig.Jabber.MucRejoinDelay == 0 { sampleConfig.Jabber.MucRejoinDelay = 3 log.Info("Jabber muc_rejoin_delay not defined in config, using 3 seconds") } if sampleConfig.Jabber.PingSplayDelay == 0 { sampleConfig.Jabber.PingSplayDelay = 3 log.Info("Jabber ping_splay_delay not defined in config, using 3 seconds") } if sampleConfig.Jabber.Nick == "" { log.Errorf("Jabber nick is not defined in config, quitting") os.Exit(1) } if sampleConfig.Jabber.Resource == "" { sampleConfig.Jabber.Resource = "buny bot" log.Info("Jabber resource not defined in config, using buny bot") } if sampleConfig.Jabber.User == "" { sampleConfig.Jabber.User = fmt.Sprintf("%s@%s", sampleConfig.Jabber.Nick, sampleConfig.Jabber.Server) log.Infof("Jabber user not defined in config, guessing, it can be %s", sampleConfig.Jabber.User) } // Если sampleConfig.Jabber.Password не задан, то авторизации не будет // Если sampleConfig.Jabber.Sasl не задан, то авторизация происходит через NickServ // Нам бот нужен в каких-то чат-румах, а не "просто так" if len(sampleConfig.Jabber.Channels) < 1 { log.Errorf("No jabber channels/rooms defined in config, quitting") os.Exit(1) } if sampleConfig.Loglevel == "" { sampleConfig.Loglevel = "info" log.Info("loglevel not defined in config, using info") } // sampleConfig.Log = "" if not set config = sampleConfig configLoaded = true log.Infof("Using %s as config file", location) //nolint:wsl break } if !configLoaded { log.Error("Config was not loaded! Refusing to start.") os.Exit(1) } } // readWhitelist() читает и валидирует белые списки пользователей. func readWhitelist() { whitelistLoaded := false executablePath, err := os.Executable() if err != nil { log.Errorf("Unable to get current executable path: %s", err) os.Exit(1) } whitelistJSONPath := fmt.Sprintf("%s/data/whitelist.json", filepath.Dir(executablePath)) locations := []string{ "~/.buny-jabber-bot-whitelist.json", "~/buny-jabber-bot-whitelist.json", "/etc/buny-jabber-bot-whitelist.json", whitelistJSONPath, } for _, location := range locations { fileInfo, err := os.Stat(location) // Предполагаем, что файла либо нет, либо мы не можем его прочитать, второе надо бы логгировать, но пока забьём if err != nil { continue } // Файл белого списка длинноват для белого списка, попробуем следующего кандидата if fileInfo.Size() > 2097152 { log.Warnf("Whitelist file %s is too long for whitelist, skipping", location) continue } buf, err := os.ReadFile(location) // Не удалось прочитать, попробуем следующего кандидата if err != nil { log.Warnf("Skip reading whitelist file %s: %s", location, err) continue } // Исходя из документации, hjson какбы умеет парсить "кривой" json, но парсит его в map-ку. // Интереснее на выходе получить структурку: то есть мы вначале конфиг преобразуем в map-ку, затем эту map-ку // сериализуем в json, а потом json превращаем в структурку. Не очень эффективно, но он и нечасто требуется. var ( sampleWhitelist myWhiteList tmp map[string]interface{} ) err = hjson.Unmarshal(buf, &tmp) // Не удалось распарсить - попробуем следующего кандидата if err != nil { log.Warnf("Skip parsing whitelist file %s: %s", location, err) continue } tmpJSON, err := json.Marshal(tmp) // Не удалось преобразовать map-ку в json if err != nil { log.Warnf("Skip parsing whitelist file %s: %s", location, err) continue } if err := json.Unmarshal(tmpJSON, &sampleWhitelist); err != nil { log.Warnf("Skip parsing whitelist file %s: %s", location, err) continue } whiteList = sampleWhitelist whitelistLoaded = true log.Infof("Using %s as whiteList file", location) break } if !whitelistLoaded { log.Error("Whitelist was not loaded! Refusing to start.") os.Exit(1) } } // readBlacklist() читает и валидирует чёрные списки пользователей. func readBlacklist() { blacklistLoaded := false executablePath, err := os.Executable() if err != nil { log.Errorf("Unable to get current executable path: %s", err) os.Exit(1) } whitelistJSONPath := fmt.Sprintf("%s/data/blacklist.json", filepath.Dir(executablePath)) locations := []string{ "~/.buny-jabber-bot-blacklist.json", "~/buny-jabber-bot-blacklist.json", "/etc/buny-jabber-bot-blacklist.json", whitelistJSONPath, } for _, location := range locations { fileInfo, err := os.Stat(location) // Предполагаем, что файла либо нет, либо мы не можем его прочитать, второе надо бы логгировать, но пока забьём if err != nil { continue } // Файл чёрного списка длинноват для чёрного списка, попробуем следующего кандидата if fileInfo.Size() > 16777216 { log.Warnf("Blacklist file %s is too long for blacklist, skipping", location) continue } buf, err := os.ReadFile(location) // Не удалось прочитать, попробуем следующего кандидата if err != nil { log.Warnf("Skip reading blacklist file %s: %s", location, err) continue } // Исходя из документации, hjson какбы умеет парсить "кривой" json, но парсит его в map-ку. // Интереснее на выходе получить структурку: то есть мы вначале конфиг преобразуем в map-ку, затем эту map-ку // сериализуем в json, а потом json превращаем в структурку. Не очень эффективно, но он и нечасто требуется. var ( sampleBlacklist myBlackList tmp map[string]interface{} ) err = hjson.Unmarshal(buf, &tmp) // Не удалось распарсить - попробуем следующего кандидата if err != nil { log.Warnf("Skip parsing blacklist file %s: %s", location, err) continue } tmpJSON, err := json.Marshal(tmp) // Не удалось преобразовать map-ку в json if err != nil { log.Warnf("Skip parsing blacklist file %s: %s", location, err) continue } if err := json.Unmarshal(tmpJSON, &sampleBlacklist); err != nil { log.Warnf("Skip parsing whitelist file %s: %s", location, err) continue } blackList = sampleBlacklist blacklistLoaded = true log.Infof("Using %s as blacklist file", location) break } if !blacklistLoaded { log.Error("Blacklist was not loaded! Refusing to start.") os.Exit(1) } } // establishConnection() устанавливает соединение с jabber-сервером. func establishConnection() { var err error if connecting && !isConnected { return } // Проставляем глобальные переменные. connecting = true isConnected = false roomsConnected = make([]string, 0) talk, err = options.NewClient() if err != nil { gTomb.Kill(err) return } // По идее keepalive должен же проходить только, если мы уже на сервере, так? if _, err := talk.SendKeepAlive(); err != nil { log.Errorf("Try to send initial KeepAlive, got error: %s", err) gTomb.Kill(err) } log.Info("Connected") // Джойнимся к чятикам, но делаем это в фоне, чтобы не блочиться на ошибках, например, если бота забанили for _, room := range config.Jabber.Channels { go joinMuc(room) } if _, err := talk.SendPresence( xmpp.Presence{ //nolint:exhaustruct Status: "Ready to chat", }, ); err != nil { log.Infof("Unable to send presence to jabber server: %s", err) gTomb.Kill(err) return } lastActivity = time.Now().Unix() connecting = false isConnected = true log.Debugf("Sending disco#info to %s", config.Jabber.Server) _, err = talk.DiscoverInfo(talk.JID(), config.Jabber.Server) if err != nil { log.Infof("Unable to send disco#info to jabber server: %s", err) gTomb.Kill(err) return } } // joinMuc(room string) джойнится к конференциям/каналам/комнатам в джаббере. func joinMuc(room string) { log.Debugf("Sending disco#info from %s to %s", talk.JID(), room) if _, err := talk.DiscoverInfo(talk.JID(), room); err != nil { log.Infof("Unable to send disco#info to MUC %s: %s", room, err) gTomb.Kill(err) } // Ждём, пока muc нам вернёт список фичей. for i := 0; i < (20 * int(config.Jabber.ConnectionTimeout)); i++ { var ( myRoom interface{} supported bool exist bool ) time.Sleep(50 * time.Millisecond) if myRoom, exist = mucCapsList.Get(room); !exist { // Пока не задискаверилась continue } if supported, exist = myRoom.(map[string]bool)["muc_unsecured"]; exist { if supported { break } log.Infof("Unable to join to password-protected room. Don't know how to enter passwords :)") return } } if _, err := talk.JoinMUCNoHistory(room, config.Jabber.Nick); err != nil { log.Errorf("Unable to join to MUC: %s", room) gTomb.Kill(err) } log.Infof("Joining to MUC: %s", room) // Ждём, когда прилетит presence из комнаты, тогда мы точно знаем, что мы вошли. entered := false for i := 0; i < (20 * int(config.Jabber.ConnectionTimeout)); i++ { time.Sleep(50 * time.Millisecond) if slices.Contains(roomsConnected, room) { entered = true break } } if !entered { log.Errorf( "Unable to enter to MUC %s, join timeout after %d seconds (server does not return my presence for this room)", room, 20*int(config.Jabber.ConnectionTimeout)+1, ) return } // Вот теперь точно можно слать статус. log.Infof("Joined to MUC: %s", room) if _, err := talk.SendPresence( xmpp.Presence{ //nolint:exhaustruct To: room, Status: "Ready to chat", }, ); err != nil { log.Infof("Unable to send presence to MUC %s: %s", room, err) gTomb.Kill(err) return } } // probeServerLiveness() проверяет живость соединения с сервером. Для многих серверов обязательная штука, без которой // они выкидывают клиента через некоторое время неактивности. func probeServerLiveness() { //nolint:gocognit defer gTomb.Done() for { select { case <-gTomb.Dying(): return default: for { if shutdown { return } sleepTime := time.Duration(config.Jabber.ServerPingDelay) * 1000 * time.Millisecond sleepTime += time.Duration(rand.Int63n(1000*config.Jabber.PingSplayDelay)) * time.Millisecond //nolint:gosec time.Sleep(sleepTime) if !isConnected { continue } // Пингуем, только если не было никакой активности в течение > config.Jabber.ServerPingDelay, // в худшем случе это будет ~ (config.Jabber.PingSplayDelay * 2) + config.Jabber.PingSplayDelay // if (time.Now().Unix() - lastServerActivity) < (config.Jabber.ServerPingDelay + config.Jabber.PingSplayDelay) { // continue // } if serverCapsQueried { // Сервер ответил на disco#info var ( value interface{} exist bool ) value, exist = serverCapsList.Get("urn:xmpp:ping") switch { // Сервер анонсировал, что умеет в c2s пинги case exist && value.(bool): // Таймаут c2s пинга. Возьмём сумму задержки между пингами, добавим таймаут коннекта и добавим // максимальную корректировку разброса. txTimeout := config.Jabber.ServerPingDelay + config.Jabber.ConnectionTimeout txTimeout += config.Jabber.PingSplayDelay rxTimeout := txTimeout rxTimeAgo := time.Now().Unix() - serverPingTimestampRx if serverPingTimestampTx > 0 { // Первая пуля от нас ушла... switch { // Давненько мы не получали понгов от сервера, вероятно, соединение с сервером утеряно? case rxTimeAgo > (rxTimeout * 2): err := errors.New( fmt.Sprintf( "Stall connection detected. No c2s pong for %d seconds", rxTimeAgo, ), ) gTomb.Kill(err) continue // По-умолчанию, мы отправляем c2s пинг default: log.Debugf("Sending c2s ping from %s to %s", talk.JID(), config.Jabber.Server) if err := talk.PingC2S(talk.JID(), config.Jabber.Server); err != nil { gTomb.Kill(err) continue } serverPingTimestampTx = time.Now().Unix() } } else { // Первая пуля пока не вылетела, отправляем log.Debugf("Sending first c2s ping from %s to %s", talk.JID(), config.Jabber.Server) if err := talk.PingC2S(talk.JID(), config.Jabber.Server); err != nil { gTomb.Kill(err) continue } serverPingTimestampTx = time.Now().Unix() } // Сервер не анонсировал, что умеет в c2s пинги default: log.Debug("Sending keepalive whitespace ping") if _, err := talk.SendKeepAlive(); err != nil { gTomb.Kill(err) continue } } } else { // Сервер не ответил на disco#info log.Debug("Sending keepalive whitespace ping") if _, err := talk.SendKeepAlive(); err != nil { gTomb.Kill(err) continue } } } } } } // probeMUCLiveness() Пингует MUC-и, нужно для проверки, что клиент ещё находится в MUC-е. func probeMUCLiveness() { defer gTomb.Done() for { select { case <-gTomb.Dying(): return default: for { for _, room := range roomsConnected { var ( exist bool lastActivityTS interface{} ) // Если записи про комнату нету, то пинговать её бессмысленно. if lastActivityTS, exist = lastMucActivity.Get(room); !exist { continue } // Если время последней активности в чятике не превысило // config.Jabber.ServerPingDelay + config.Jabber.PingSplayDelay, ничего не пингуем. if (time.Now().Unix() - lastActivityTS.(int64)) < (config.Jabber.ServerPingDelay + config.Jabber.PingSplayDelay) { continue } /* Пинг MUC-а по сценарию без серверной оптимизации мы реализовывать не будем. Это как-то не надёжно. go func(room string) { // Небольшая рандомная задержка перед пингом комнаты sleepTime := time.Duration(rand.Int63n(1000*config.Jabber.PingSplayDelay)) * time.Millisecond //nolint:gosec time.Sleep(sleepTime) if err := talk.PingS2S(talk.JID(), room+"/"+config.Jabber.Nick); err != nil { gTomb.Kill(err) continue } }(room) */ var roomMap interface{} roomMap, exist = mucCapsList.Get(room) // Пинги комнаты проводим, только если она записана, как прошедшая disco#info и поддерживающая // Server Optimization. if exist && roomMap.(map[string]bool)["http://jabber.org/protocol/muc#self-ping-optimization"] { go func(room string) { // Небольшая рандомная задержка перед пингом комнаты. sleepTime := time.Duration(rand.Int63n(1000*config.Jabber.PingSplayDelay)) * time.Millisecond //nolint:gosec time.Sleep(sleepTime) log.Debugf("Sending MUC ping from %s to %s", talk.JID(), room) if err := talk.PingS2S(talk.JID(), room); err != nil { gTomb.Kill(err) } }(room) } } time.Sleep(time.Duration(config.Jabber.MucPingDelay) * time.Second) } } } } /* vim: set ft=go noet ai ts=4 sw=4 sts=4: */