buny-jabber-bot/main.go

package main

import (
	"crypto/tls"
	"errors"
	"fmt"
	"io"
	"net"
	"os"
	"os/signal"
	"time"

	"github.com/eleksir/go-xmpp"
	log "github.com/sirupsen/logrus"
	"gopkg.in/tomb.v1"
)

// init начальная подготовка: чтение и валидация конфига, инициализация логгера.
func init() {
	log.SetFormatter(&log.TextFormatter{ //nolint:exhaustruct
		DisableQuote:           true,
		DisableLevelTruncation: false,
		DisableColors:          true,
		FullTimestamp:          true,
		TimestampFormat:        "2006-01-02 15:04:05",
	})

	if err := readConfig(); err != nil {
		log.Error(err)

		os.Exit(1)
	}

	// no panic
	switch config.Loglevel {
	case "fatal":
		log.SetLevel(log.FatalLevel)
	case "error":
		log.SetLevel(log.ErrorLevel)
	case "warn":
		log.SetLevel(log.WarnLevel)
	case "info":
		log.SetLevel(log.InfoLevel)
	case "debug":
		log.SetLevel(log.DebugLevel)
	case "trace":
		log.SetLevel(log.TraceLevel)
	default:
		log.SetLevel(log.InfoLevel)
	}
}

// main - фактичеcки начало и основное тело программы.
func main() {
	// Откроем лог и скормим его логгеру.
	if config.Log != "" {
		logfile, err := os.OpenFile(config.Log, os.O_WRONLY|os.O_APPEND|os.O_CREATE, 0644)

		if err != nil {
			log.Fatalf("Unable to open log file %s: %s", config.Log, err)
		}

		log.SetOutput(logfile)
	}

	myLogLevel := log.GetLevel()
	log.Warnf("Loglevel set to %v", myLogLevel)

	verboseClient := false

	if myLogLevel == log.TraceLevel {
		verboseClient = true
	}

	// Самое время вгрузить белые и чёрные списки, если что - получим ошибку в лог.
	if err := readWhitelist(); err != nil {
		log.Error(err)

		os.Exit(1)
	}

	if err := readBlacklist(); err != nil {
		log.Error(err)

		os.Exit(1)
	}

	// github.com/mattn/go-xmpp пишет в stdio, нам этого не надо, ловим выхлоп его в logrus с уровнем trace.
	xmpp.DebugWriter = log.WithFields(log.Fields{"logger": "stdlib"}).WriterLevel(log.TraceLevel)

	// Хэндлер сигналов не надо трогать, он нужен для завершения программы целиком.
	go sigHandler()
	signal.Notify(sigChan, os.Interrupt)

	// Враппер основной программы. Фактически на каждой серьёзной ошибке, например, сетевой, mainLoop и некоторые
	// вспомогательные корутины прекращает свою работу. Здесь мы это ловим и запускаем их снова. Задача в том, чтобы
	// запустить все асинхронные процессы заново, с чистого листа, но уже с распарсенным конфигом.
	for {
		options = &xmpp.Options{ //nolint:exhaustruct
			Host:     fmt.Sprintf("%s:%d", config.Jabber.Server, config.Jabber.Port),
			User:     config.Jabber.User,
			Password: config.Jabber.Password,
			Resource: config.Jabber.Resource,
			NoTLS:    !config.Jabber.Ssl,
			StartTLS: config.Jabber.StartTLS,
			TLSConfig: &tls.Config{ //nolint:exhaustruct
				ServerName:         config.Jabber.Server,
				InsecureSkipVerify: !config.Jabber.SslVerify, //nolint:gosec
			},
			InsecureAllowUnencryptedAuth: config.Jabber.InsecureAllowUnencryptedAuth,
			Debug:                        verboseClient,
			Session:                      false,
			Status:                       "xa",
			StatusMessage:                randomPhrase(config.Jabber.StartupStatus),
			DialTimeout:                  time.Duration(config.Jabber.ConnectionTimeout) * time.Second,
		}

		// Через tomb попробуем сделать завершение горутинок управляемым.
		gTomb = tomb.Tomb{}

		// Устанавливаем соединение и гребём события, посылаемые сервером - основной и вспомогательные циклы программы.
		myLoop()

		// Логгируем причину завершения mainLoop и вспомогательных циклов программы.
		log.Error(gTomb.Wait())

		// Если у нас wire error, то вызов .Close() повлечёт за собой ошибку, но мы вынуждены звать .Close(), чтоб
		// закрыть tls контекст и почистить всё что связанно с прерванным соединением.
		log.Infoln("Closing connection to jabber server")
		_ = talk.Close()

		time.Sleep(time.Duration(config.Jabber.ReconnectDelay) * time.Second)
	}
}

// Основной цикл программы.
func myLoop() {
	for {
		select {
		case <-gTomb.Dying():
			gTomb.Done()
			return //nolint:nlreturn

		default:
			// Зададим начальное значение глобальным переменным
			serverPingTimestampRx = 0
			serverPingTimestampTx = 0
			roomsConnected = make([]string, 1)
			lastActivity = 0
			lastServerActivity = 0
			lastMucActivity = NewCollection()
			serverCapsQueried = false
			serverCapsList = NewCollection()
			mucCapsList = NewCollection()
			serverPingTimestampTx = 0
			serverPingTimestampRx = 0
			roomPresences = NewCollection()

			// Установим коннект
			establishConnection()

			serverPingTimestampRx = time.Now().Unix() // Считаем, что если коннект запустился, то первый пинг успешен.

			// Тыкаем сервер палочкой, проверяем, что коннект жив и вываливаемся из mainLoop, если он не жив.
			go probeServerLiveness()

			// Тыкаем muc-и палочкой, проверяем, что они живы и вываливаемся из mainLoop, если пинги пропали.
			// Если пинги до комнаты пропали, то это фактически значит, что либо сервер потерял связь с MUC-компонентом,
			// либо у нас какой-то wire error.
			go probeMUCLiveness()

			// Гребём ивенты...
			for {
				// Стриггерилось завершение работы приложения, или соединение не установлено (порвалось, например)
				// грести не надо
				if shutdown {
					break
				}

				if !isConnected {
					// Tight loop - это наверно не очень хорошо, думаю, ничего страшного не будет, если мы поспим 100мс.
					time.Sleep(100 * time.Millisecond)
					continue
				}

				// Вынимаем ивент из "провода"
				chat, err := talk.Recv()

				if err != nil {
					log.Errorf("Unable to get events from server: %s", err)

					// Попробуем скрасить печальные будни generic-ошибок...
					switch {
					// Стрим не читается, он закрылся с той стороны во время чтения
					case errors.Is(err, io.EOF):
						err = fmt.Errorf("tcp stream closed while reading, err=%w", err)

					// Пытаемся читать закрытый сокет
					case errors.Is(err, net.ErrClosed):
						err = fmt.Errorf("unable to read closed socket, err=%w", err)

					// Не смогли записать в сокет
					case errors.Is(err, net.ErrWriteToConnected):
						err = fmt.Errorf("unable to write to socket, err=%w", err)

					// Не сетевая проблема
					default:
						// Это уже что-то странное.
						// Вероятно, ошибка парсинга xml. Собственно, баг сервера, тут мы ничего поделать не можем.
						err = fmt.Errorf("error during parsing received message, err=%w", err)
					}

					gTomb.Kill(err)

					// Не забываем выходить на ошибке :(
					return
				}

				parseEvent(chat)
			}
		}
	}
}

/* vim: set ft=go noet ai ts=4 sw=4 sts=4: */