package irc import ( "crypto/tls" "fmt" "regexp" "strings" "sync" "time" "github.com/autobrr/autobrr/internal/announce" "github.com/autobrr/autobrr/internal/domain" "github.com/autobrr/autobrr/internal/notification" "github.com/autobrr/autobrr/internal/release" "github.com/autobrr/autobrr/pkg/errors" "github.com/avast/retry-go" "github.com/dcarbone/zadapters/zstdlog" "github.com/ergochat/irc-go/ircevent" "github.com/ergochat/irc-go/ircmsg" "github.com/rs/zerolog" ) type channelHealth struct { m sync.RWMutex name string monitoring bool monitoringSince time.Time lastAnnounce time.Time } // SetLastAnnounce set last announce to now func (h *channelHealth) SetLastAnnounce() { h.m.Lock() h.lastAnnounce = time.Now() h.m.Unlock() } // SetMonitoring set monitoring and time func (h *channelHealth) SetMonitoring() { h.m.Lock() h.monitoring = true h.monitoringSince = time.Now() h.m.Unlock() } // resetMonitoring remove monitoring and time func (h *channelHealth) resetMonitoring() { h.m.Lock() h.monitoring = false h.monitoringSince = time.Time{} h.lastAnnounce = time.Time{} h.m.Unlock() } type Handler struct { log zerolog.Logger network *domain.IrcNetwork releaseSvc release.Service notificationService notification.Service announceProcessors map[string]announce.Processor definitions map[string]*domain.IndexerDefinition client *ircevent.Connection m sync.RWMutex connected bool connectedSince time.Time haveDisconnected bool manuallyDisconnected bool validAnnouncers map[string]struct{} validChannels map[string]struct{} channelHealth map[string]*channelHealth connectionErrors []string failedNickServAttempts int authenticated bool } func NewHandler(log zerolog.Logger, network domain.IrcNetwork, definitions []*domain.IndexerDefinition, releaseSvc release.Service, notificationSvc notification.Service) *Handler { h := &Handler{ log: log.With().Str("network", network.Server).Logger(), client: nil, network: &network, releaseSvc: releaseSvc, notificationService: notificationSvc, definitions: map[string]*domain.IndexerDefinition{}, announceProcessors: map[string]announce.Processor{}, validAnnouncers: map[string]struct{}{}, validChannels: map[string]struct{}{}, channelHealth: map[string]*channelHealth{}, authenticated: false, } // init indexer, announceProcessor h.InitIndexers(definitions) return h } func (h *Handler) InitIndexers(definitions []*domain.IndexerDefinition) { // Networks can be shared by multiple indexers but channels are unique // so let's add a new AnnounceProcessor per channel for _, definition := range definitions { if _, ok := h.definitions[definition.Identifier]; ok { continue } h.definitions[definition.Identifier] = definition // indexers can use multiple channels, but it's not common, but let's handle that anyway. for _, channel := range definition.IRC.Channels { // some channels are defined in mixed case channel = strings.ToLower(channel) h.announceProcessors[channel] = announce.NewAnnounceProcessor(h.log, h.releaseSvc, definition) h.channelHealth[channel] = &channelHealth{ name: channel, monitoring: false, } // create map of valid channels h.validChannels[channel] = struct{}{} } // create map of valid announcers for _, announcer := range definition.IRC.Announcers { h.validAnnouncers[announcer] = struct{}{} } } } func (h *Handler) removeIndexer() { // TODO remove validAnnouncers // TODO remove validChannels // TODO remove definition // TODO remove announceProcessor } func (h *Handler) Run() error { // TODO validate // check if network requires nickserv // chech if network or channels requires invite command addr := fmt.Sprintf("%v:%d", h.network.Server, h.network.Port) subLogger := zstdlog.NewStdLoggerWithLevel(h.log.With().Logger(), zerolog.TraceLevel) h.client = &ircevent.Connection{ Nick: h.network.NickServ.Account, User: h.network.NickServ.Account, RealName: h.network.NickServ.Account, Password: h.network.Pass, SASLLogin: h.network.NickServ.Account, SASLPassword: h.network.NickServ.Password, SASLOptional: true, Server: addr, KeepAlive: 4 * time.Minute, Timeout: 2 * time.Minute, ReconnectFreq: 15 * time.Second, Version: "autobrr", QuitMessage: "bye from autobrr", Debug: true, Log: subLogger, } if h.network.TLS { h.client.UseTLS = true h.client.TLSConfig = &tls.Config{InsecureSkipVerify: true} } h.client.AddConnectCallback(h.onConnect) h.client.AddDisconnectCallback(h.onDisconnect) h.client.AddCallback("MODE", h.handleMode) h.client.AddCallback("INVITE", h.handleInvite) h.client.AddCallback("366", h.handleJoined) h.client.AddCallback("PART", h.handlePart) h.client.AddCallback("PRIVMSG", h.onMessage) h.client.AddCallback("NOTICE", h.onNotice) h.client.AddCallback("NICK", h.onNick) h.client.AddCallback("903", h.handleSASLSuccess) if err := h.client.Connect(); err != nil { h.log.Error().Stack().Err(err).Msg("connect error") // reset connection status on handler and channels h.resetConnectionStatus() // count connect attempts connectAttempts := 1 // retry initial connect if network is down // using exponential backoff of 15 seconds err := retry.Do( func() error { h.log.Debug().Msgf("connect attempt %d", connectAttempts) err := h.client.Connect() if err != nil { connectAttempts++ return err } h.log.Debug().Msgf("connected at attempt %d", connectAttempts) return nil }, retry.Delay(time.Second*15), retry.Attempts(25), retry.DelayType(func(n uint, err error, config *retry.Config) time.Duration { return retry.BackOffDelay(n, err, config) }), ) h.log.Error().Stack().Err(err).Msgf("connect error: attempt %d", connectAttempts) } h.client.Loop() return nil } func (h *Handler) isOurNick(nick string) bool { return h.network.NickServ.Account == nick } func (h *Handler) isOurCurrentNick(nick string) bool { return h.client.CurrentNick() == nick } func (h *Handler) setConnectionStatus() { h.m.Lock() // set connected since now h.connectedSince = time.Now() h.connected = true h.m.Unlock() } func (h *Handler) resetConnectionStatus() { h.m.Lock() // set connected false if we loose connection or stop h.connectedSince = time.Time{} h.connected = false // loop over channelHealth and reset each one for _, h := range h.channelHealth { if h != nil { h.resetMonitoring() } } h.m.Unlock() } func (h *Handler) GetNetwork() *domain.IrcNetwork { return h.network } func (h *Handler) UpdateNetwork(network *domain.IrcNetwork) { h.m.Lock() h.network = network h.m.Unlock() } func (h *Handler) SetNetwork(network *domain.IrcNetwork) { h.m.Lock() h.network = network h.m.Unlock() } func (h *Handler) AddChannelHealth(channel string) { h.m.Lock() h.channelHealth[channel] = &channelHealth{ name: channel, monitoring: true, monitoringSince: time.Now(), } h.m.Unlock() } func (h *Handler) Stop() { h.log.Debug().Msg("Disconnecting...") h.m.Lock() h.manuallyDisconnected = true h.m.Unlock() h.client.Quit() } func (h *Handler) Restart() error { h.log.Debug().Msg("Restarting network...") h.m.Lock() h.manuallyDisconnected = true h.m.Unlock() h.client.Quit() time.Sleep(4 * time.Second) return h.Run() } func (h *Handler) onConnect(m ircmsg.Message) { // 0. Authenticated via SASL - join // 1. No nickserv, no invite command - join // 2. Nickserv password - join after auth // 3. nickserv and invite command - send nickserv pass, wait for mode to send invite cmd, then join // 4. invite command - join h.resetConnectErrors() h.setConnectionStatus() if h.haveDisconnected { h.notificationService.Send(domain.NotificationEventIRCReconnected, domain.NotificationPayload{ Subject: "IRC Reconnected", Message: fmt.Sprintf("Network: %v", h.network.Name), }) // reset haveDisconnected h.haveDisconnected = false } h.log.Debug().Msgf("connected to: %v", h.network.Name) time.Sleep(1 * time.Second) // if already authenticated via SASL then join channels if h.authenticated { h.log.Trace().Msg("on connect - already authenticated: join channels") // check for invite command if h.network.InviteCommand != "" { if err := h.sendConnectCommands(h.network.InviteCommand); err != nil { h.log.Error().Stack().Err(err).Msgf("error sending connect command %v", h.network.InviteCommand) return } // let's return because MODE will change, and we join when we have the correct mode return } // if authenticated and no invite command lets join h.JoinChannels() return } // if not authenticated, no nickserv pass but invite command, send invite command to trigger MODE change then join if h.network.NickServ.Password == "" && h.network.InviteCommand != "" { h.log.Trace().Msg("on connect invite command not empty: send connect commands") if err := h.sendConnectCommands(h.network.InviteCommand); err != nil { h.log.Error().Stack().Err(err).Msgf("error sending connect command %v", h.network.InviteCommand) return } return // if not authenticated but we do have a nick serv pass, send identify to trigger MODE change and then join } else if h.network.NickServ.Password != "" { h.log.Trace().Msg("on connect not authenticated and password not empty: send nickserv identify") if err := h.NickServIdentify(h.network.NickServ.Password); err != nil { h.log.Error().Stack().Err(err).Msg("error nickserv") return } // return and wait for NOTICE of nickserv auth return } // if no password nor invite command, join channels h.log.Trace().Msg("on connect - no nickserv or invite command: join channels") h.JoinChannels() return } func (h *Handler) onDisconnect(m ircmsg.Message) { h.log.Debug().Msgf("DISCONNECT") h.haveDisconnected = true h.resetConnectionStatus() h.resetAuthenticated() // check if we are responsible for disconnect if !h.manuallyDisconnected { // only send notification if we did not initiate disconnect/restart/stop h.notificationService.Send(domain.NotificationEventIRCDisconnected, domain.NotificationPayload{ Subject: "IRC Disconnected unexpectedly", Message: fmt.Sprintf("Network: %v", h.network.Name), }) // reset h.manuallyDisconnected = false } } func (h *Handler) onNotice(msg ircmsg.Message) { switch msg.Nick() { case "NickServ": h.handleNickServ(msg) } } func (h *Handler) handleNickServ(msg ircmsg.Message) { h.log.Trace().Msgf("NOTICE from nickserv: %v", msg.Params) if contains(msg.Params[1], "Invalid account credentials", "Authentication failed: Invalid account credentials", "password incorrect", ) { h.addConnectError("authentication failed: Bad account credentials") h.log.Warn().Msg("NickServ: authentication failed - bad account credentials") if h.failedNickServAttempts >= 1 { h.log.Warn().Msgf("NickServ %d failed login attempts", h.failedNickServAttempts) // stop network and notify user h.Stop() } h.failedNickServAttempts++ } if contains(msg.Params[1], "Account does not exist", "Authentication failed: Account does not exist", // Nick ANICK isn't registered ) { h.addConnectError("authentication failed: account does not exist") if h.failedNickServAttempts >= 2 { h.log.Warn().Msgf("NickServ %d failed login attempts", h.failedNickServAttempts) // stop network and notify user h.Stop() } h.failedNickServAttempts++ } if contains(msg.Params[1], "This nickname is registered and protected", "please choose a different nick", "choose a different nick", ) { if h.failedNickServAttempts >= 3 { h.log.Warn().Msgf("NickServ %d failed login attempts", h.failedNickServAttempts) h.addConnectError("authentication failed: nick in use and not authenticated") // stop network and notify user h.Stop() } h.failedNickServAttempts++ } // You're now logged in as test-bot // Password accepted - you are now recognized. if contains(msg.Params[1], "you're now logged in as", "password accepted", "you are now recognized") { h.log.Debug().Msgf("NOTICE nickserv logged in: %v", msg.Params) } // fallback for networks that require both password and nick to NickServ IDENTIFY // Invalid parameters. For usage, do /msg NickServ HELP IDENTIFY if contains(msg.Params[1], "invalid parameters", "help identify") { h.log.Debug().Msgf("NOTICE nickserv invalid: %v", msg.Params) if err := h.client.Send("PRIVMSG", "NickServ", fmt.Sprintf("IDENTIFY %v %v", h.network.NickServ.Account, h.network.NickServ.Password)); err != nil { return } } } // handleSASLSuccess we get here early so set authenticated before we hit onConnect func (h *Handler) handleSASLSuccess(msg ircmsg.Message) { h.setAuthenticated() } func (h *Handler) setAuthenticated() { h.m.Lock() defer h.m.Unlock() h.authenticated = true } func (h *Handler) resetAuthenticated() { h.m.Lock() defer h.m.Unlock() h.authenticated = false } func contains(s string, substr ...string) bool { s = strings.ToLower(s) for _, c := range substr { c = strings.ToLower(c) if strings.Contains(s, c) { return true } else if c == s { return true } } return false } func (h *Handler) onNick(msg ircmsg.Message) { h.log.Trace().Msgf("NICK event: %v params: %v", msg.Nick(), msg.Params) if h.client.CurrentNick() != h.client.PreferredNick() { h.log.Debug().Msgf("nick miss-match: got %v want %v", h.client.CurrentNick(), h.client.PreferredNick()) } } func (h *Handler) onMessage(msg ircmsg.Message) { if len(msg.Params) < 2 { return } // parse announce announcer := msg.Nick() channel := msg.Params[0] message := msg.Params[1] // check if message is from a valid channel, if not return validChannel := h.isValidChannel(channel) if !validChannel { return } // check if message is from announce bot, if not return validAnnouncer := h.isValidAnnouncer(announcer) if !validAnnouncer { return } // clean message cleanedMsg := h.cleanMessage(message) h.log.Debug().Str("channel", channel).Str("user", announcer).Msgf("%v", cleanedMsg) if err := h.sendToAnnounceProcessor(channel, cleanedMsg); err != nil { h.log.Error().Stack().Err(err).Msgf("could not queue line: %v", cleanedMsg) return } return } func (h *Handler) sendToAnnounceProcessor(channel string, msg string) error { channel = strings.ToLower(channel) // check if queue exists queue, ok := h.announceProcessors[channel] if !ok { return errors.New("queue '%v' not found", channel) } // if it exists, add msg err := queue.AddLineToQueue(channel, msg) if err != nil { h.log.Error().Stack().Err(err).Msgf("could not queue line: %v", msg) return err } v, ok := h.channelHealth[channel] if !ok { return nil } v.SetLastAnnounce() return nil } func (h *Handler) JoinChannels() { for _, channel := range h.network.Channels { if err := h.JoinChannel(channel.Name, channel.Password); err != nil { h.log.Error().Stack().Err(err).Msgf("error joining channel %v", channel.Name) continue } time.Sleep(1 * time.Second) } } func (h *Handler) JoinChannel(channel string, password string) error { m := ircmsg.Message{ Command: "JOIN", Params: []string{channel}, } // support channel password if password != "" { m.Params = []string{channel, password} } h.log.Debug().Msgf("sending JOIN command %v", strings.Join(m.Params, " ")) err := h.client.SendIRCMessage(m) if err != nil { h.log.Error().Stack().Err(err).Msgf("error handling join: %v", channel) return err } return nil } func (h *Handler) handlePart(msg ircmsg.Message) { if !h.isOurNick(msg.Nick()) { h.log.Trace().Msgf("PART other user: %+v", msg) return } channel := msg.Params[0] h.log.Debug().Msgf("PART channel %v", channel) // reset monitoring status v, ok := h.channelHealth[channel] if !ok { return } v.resetMonitoring() // TODO remove announceProcessor h.log.Debug().Msgf("Left channel %v", channel) return } func (h *Handler) PartChannel(channel string) error { h.log.Debug().Msgf("PART channel %v", channel) if err := h.client.Part(channel); err != nil { h.log.Error().Err(err).Msgf("error handling part: %v", channel) return err } // reset monitoring status v, ok := h.channelHealth[channel] if !ok { return nil } v.resetMonitoring() // TODO remove announceProcessor h.log.Info().Msgf("Left channel: %v", channel) return nil } func (h *Handler) handleJoined(msg ircmsg.Message) { if !h.isOurNick(msg.Params[0]) { h.log.Trace().Msgf("JOINED other user: %+v", msg) return } // get channel channel := strings.ToLower(msg.Params[1]) h.log.Debug().Msgf("JOINED: %v", msg.Params[1]) // check if channel is valid and if not lets part valid := h.isValidHandlerChannel(channel) if !valid { if err := h.PartChannel(channel); err != nil { h.log.Error().Err(err).Msgf("error handling part for unwanted channel: %v", channel) return } return } // set monitoring on current channelHealth, or add new v, ok := h.channelHealth[channel] if ok { v.SetMonitoring() } else if v == nil { h.AddChannelHealth(channel) } h.log.Info().Msgf("Monitoring channel %v", msg.Params[1]) } func (h *Handler) sendConnectCommands(msg string) error { connectCommand := strings.ReplaceAll(msg, "/msg", "") connectCommands := strings.Split(connectCommand, ",") for _, command := range connectCommands { cmd := strings.TrimSpace(command) m := ircmsg.Message{ Command: "PRIVMSG", Params: strings.Split(cmd, " "), } h.log.Debug().Msgf("sending connect command: %v", cmd) err := h.client.SendIRCMessage(m) if err != nil { h.log.Error().Err(err).Msgf("error handling invite: %v", m) return err } } return nil } func (h *Handler) handleInvite(msg ircmsg.Message) { if len(msg.Params) < 2 { return } // get channel channel := msg.Params[1] h.log.Trace().Msgf("INVITE from %v to join: %v ", msg.Nick(), channel) validChannel := h.isValidHandlerChannel(channel) if !validChannel { h.log.Trace().Msgf("invite from %v to join: %v - invalid channel, skip joining", msg.Nick(), channel) return } h.log.Debug().Msgf("INVITE from %v, joining %v", msg.Nick(), channel) err := h.client.Join(channel) if err != nil { h.log.Error().Stack().Err(err).Msgf("error handling join: %v", channel) return } return } func (h *Handler) NickServIdentify(password string) error { m := ircmsg.Message{ Command: "PRIVMSG", Params: []string{"NickServ", "IDENTIFY", password}, } h.log.Debug().Msgf("NickServ: %v", m) err := h.client.SendIRCMessage(m) if err != nil { h.log.Error().Stack().Err(err).Msgf("error identifying with nickserv: %v", m) return err } return nil } func (h *Handler) NickChange(nick string) error { h.log.Debug().Msgf("NICK change: %v", nick) h.client.SetNick(nick) return nil } func (h *Handler) CurrentNick() string { return h.client.CurrentNick() } func (h *Handler) PreferredNick() string { return h.client.PreferredNick() } func (h *Handler) handleMode(msg ircmsg.Message) { h.log.Trace().Msgf("MODE: %+v", msg) // if our nick and user mode +r (Identifies the nick as being Registered (settable by services only)) then return if h.isOurCurrentNick(msg.Params[0]) && strings.Contains(msg.Params[1], "+r") { if !h.authenticated { h.setAuthenticated() } h.resetConnectErrors() h.failedNickServAttempts = 0 // if invite command send if h.network.InviteCommand != "" { // send connect commands if err := h.sendConnectCommands(h.network.InviteCommand); err != nil { h.log.Error().Stack().Err(err).Msgf("error sending connect command %v", h.network.InviteCommand) return } } time.Sleep(1 * time.Second) //join channels h.JoinChannels() return } return } // check if announcer is one from the list in the definition func (h *Handler) isValidAnnouncer(nick string) bool { _, ok := h.validAnnouncers[nick] if !ok { return false } return true } // check if channel is one from the list in the definition func (h *Handler) isValidChannel(channel string) bool { _, ok := h.validChannels[strings.ToLower(channel)] if !ok { return false } return true } // check if channel is from definition or user defined func (h *Handler) isValidHandlerChannel(channel string) bool { channel = strings.ToLower(channel) _, ok := h.validChannels[channel] if ok { return true } for _, ircChannel := range h.network.Channels { if channel == strings.ToLower(ircChannel.Name) { return true } } return false } // irc line can contain lots of extra stuff like color so lets clean that func (h *Handler) cleanMessage(message string) string { var regexMessageClean = `\x0f|\x1f|\x02|\x03(?:[\d]{1,2}(?:,[\d]{1,2})?)?` rxp, err := regexp.Compile(regexMessageClean) if err != nil { h.log.Error().Err(err).Msgf("error compiling regex: %v", regexMessageClean) return "" } return rxp.ReplaceAllString(message, "") } func (h *Handler) addConnectError(message string) { h.m.Lock() defer h.m.Unlock() h.connectionErrors = append(h.connectionErrors, message) } func (h *Handler) resetConnectErrors() { h.m.Lock() defer h.m.Unlock() h.connectionErrors = []string{} }