Feature: Support multiline irc parsing (#39)

* feat: initial multiline support

* refactor: handle multiple indexers per network

* wip: setup indexer

* build: add docker compose for testing

* chore: remove temp mock indexers

* chore: update deps

* refactor: update and store network handler

* build: update test compose

* chore: minor cleanup
This commit is contained in:
Ludvig Lundgren 2021-12-21 21:15:42 +01:00 committed by GitHub
parent 506cef6f0f
commit c4d580eb03
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
17 changed files with 1100 additions and 1042 deletions

View file

@ -10,8 +10,9 @@ import (
"strings"
"time"
"github.com/autobrr/autobrr/internal/announce"
"github.com/autobrr/autobrr/internal/domain"
"github.com/autobrr/autobrr/internal/filter"
"github.com/autobrr/autobrr/internal/release"
"github.com/rs/zerolog/log"
"gopkg.in/irc.v3"
@ -21,9 +22,20 @@ var (
connectTimeout = 15 * time.Second
)
type channelHealth struct {
name string
monitoring bool
monitoringSince time.Time
lastPing time.Time
lastAnnounce time.Time
}
type Handler struct {
network *domain.IrcNetwork
announceService announce.Service
network *domain.IrcNetwork
filterService filter.Service
releaseService release.Service
announceProcessors map[string]Processor
definitions []domain.IndexerDefinition
client *irc.Client
conn net.Conn
@ -33,17 +45,42 @@ type Handler struct {
lastPing time.Time
lastAnnounce time.Time
validAnnouncers map[string]struct{}
channels map[string]channelHealth
}
func NewHandler(network domain.IrcNetwork, announceService announce.Service) *Handler {
return &Handler{
client: nil,
conn: nil,
ctx: nil,
stopped: make(chan struct{}),
network: &network,
announceService: announceService,
func NewHandler(network domain.IrcNetwork, filterService filter.Service, releaseService release.Service, definitions []domain.IndexerDefinition) *Handler {
h := &Handler{
client: nil,
conn: nil,
ctx: nil,
stopped: make(chan struct{}),
network: &network,
filterService: filterService,
releaseService: releaseService,
definitions: definitions,
announceProcessors: map[string]Processor{},
validAnnouncers: map[string]struct{}{},
}
// Networks can be shared by multiple indexers but channels are unique
// so let's add a new AnnounceProcessor per channel
for _, definition := range definitions {
// indexers can use multiple channels, but it's not common, but let's handle that anyway.
for _, channel := range definition.IRC.Channels {
channel = strings.ToLower(channel)
h.announceProcessors[channel] = NewAnnounceProcessor(definition, filterService, releaseService)
}
// create map of valid announcers
for _, announcer := range definition.IRC.Announcers {
h.validAnnouncers[announcer] = struct{}{}
}
}
return h
}
func (s *Handler) Run() error {
@ -101,11 +138,14 @@ func (s *Handler) Run() error {
switch m.Command {
case "001":
// 001 is a welcome event, so we join channels there
err := s.onConnect(c, s.network.Channels)
err := s.onConnect(s.network.Channels)
if err != nil {
log.Error().Msgf("error joining channels %v", err)
}
case "372", "375", "376":
// Handle MOTD
// 322 TOPIC
// 333 UP
// 353 @
@ -189,6 +229,10 @@ func (s *Handler) GetNetwork() *domain.IrcNetwork {
return s.network
}
func (s *Handler) UpdateNetwork(network *domain.IrcNetwork) {
s.network = network
}
func (s *Handler) Stop() {
s.cancel()
@ -210,7 +254,23 @@ func (s *Handler) isStopped() bool {
}
}
func (s *Handler) onConnect(client *irc.Client, channels []domain.IrcChannel) error {
func (s *Handler) Restart() error {
s.cancel()
if !s.isStopped() {
close(s.stopped)
}
if s.conn != nil {
s.conn.Close()
}
time.Sleep(2 * time.Second)
return s.Run()
}
func (s *Handler) onConnect(channels []domain.IrcChannel) error {
identified := false
time.Sleep(2 * time.Second)
@ -239,7 +299,7 @@ func (s *Handler) onConnect(client *irc.Client, channels []domain.IrcChannel) er
if !identified {
for _, channel := range channels {
err := s.handleJoinChannel(channel.Name)
err := s.HandleJoinChannel(channel.Name, channel.Password)
if err != nil {
log.Error().Err(err)
return err
@ -255,36 +315,47 @@ func (s *Handler) OnJoin(msg string) (interface{}, error) {
}
func (s *Handler) onMessage(msg *irc.Message) error {
//log.Debug().Msgf("raw msg: %v", msg)
// check if message is from announce bot and correct channel, if not return
//if msg.Name != s.network. {
//
//}
// parse announce
channel := &msg.Params[0]
announcer := &msg.Name
message := msg.Trailing()
// TODO add network
// add correlationID and tracing
announceID := fmt.Sprintf("%v:%v:%v", s.network.Server, *channel, *announcer)
announceID = strings.ToLower(announceID)
// check if message is from announce bot, if not return
validAnnouncer := s.isValidAnnouncer(*announcer)
if !validAnnouncer {
return nil
}
// clean message
cleanedMsg := cleanMessage(message)
log.Debug().Msgf("%v: %v %v: %v", s.network.Server, *channel, *announcer, cleanedMsg)
s.lastAnnounce = time.Now()
s.setLastAnnounce()
go func() {
err := s.announceService.Parse(announceID, cleanedMsg)
if err != nil {
log.Error().Err(err).Msgf("could not parse line: %v", cleanedMsg)
}
}()
if err := s.sendToAnnounceProcessor(*channel, cleanedMsg); err != nil {
log.Error().Stack().Err(err).Msgf("could not queue line: %v", cleanedMsg)
return err
}
return nil
}
func (s *Handler) sendToAnnounceProcessor(channel string, msg string) error {
channel = strings.ToLower(channel)
// check if queue exists
queue, ok := s.announceProcessors[channel]
if !ok {
return fmt.Errorf("queue '%v' not found", channel)
}
// if it exists, add msg
err := queue.AddLineToQueue(channel, msg)
if err != nil {
log.Error().Stack().Err(err).Msgf("could not queue line: %v", msg)
return err
}
return nil
}
@ -302,13 +373,19 @@ func (s *Handler) sendPrivMessage(msg string) error {
return nil
}
func (s *Handler) handleJoinChannel(channel string) error {
m := irc.Message{
Command: "JOIN",
Params: []string{channel},
func (s *Handler) HandleJoinChannel(channel string, password string) error {
// support channel password
params := []string{channel}
if password != "" {
params = append(params, password)
}
log.Debug().Msgf("%v: %v", s.network.Server, m.String())
m := irc.Message{
Command: "JOIN",
Params: params,
}
log.Trace().Msgf("%v: sending %v", s.network.Server, m.String())
time.Sleep(1 * time.Second)
@ -323,6 +400,27 @@ func (s *Handler) handleJoinChannel(channel string) error {
return nil
}
func (s *Handler) HandlePartChannel(channel string) error {
m := irc.Message{
Command: "PART",
Params: []string{channel},
}
log.Debug().Msgf("%v: %v", s.network.Server, m.String())
time.Sleep(1 * time.Second)
err := s.client.Write(m.String())
if err != nil {
log.Error().Err(err).Msgf("error handling part: %v", m.String())
return err
}
log.Info().Msgf("Left channel '%v' on network '%s'", channel, s.network.Server)
return nil
}
func (s *Handler) handleJoined(msg *irc.Message) {
log.Debug().Msgf("%v: JOINED: %v", s.network.Server, msg.Trailing())
@ -384,6 +482,40 @@ func (s *Handler) handleNickServPRIVMSG(nick, password string) error {
return nil
}
func (s *Handler) HandleNickServIdentify(nick, password string) error {
m := irc.Message{
Command: "PRIVMSG",
Params: []string{"NickServ", "IDENTIFY", nick, password},
}
log.Debug().Msgf("%v: NickServ: %v", s.network.Server, m.String())
err := s.client.Write(m.String())
if err != nil {
log.Error().Stack().Err(err).Msgf("error identifying with nickserv: %v", m.String())
return err
}
return nil
}
func (s *Handler) HandleNickChange(nick string) error {
m := irc.Message{
Command: "NICK",
Params: []string{nick},
}
log.Debug().Msgf("%v: Nick change: %v", s.network.Server, m.String())
err := s.client.Write(m.String())
if err != nil {
log.Error().Stack().Err(err).Msgf("error changing nick: %v", m.String())
return err
}
return nil
}
func (s *Handler) handleMode(msg *irc.Message) error {
log.Debug().Msgf("%v: MODE: %v %v", s.network.Server, msg.User, msg.Trailing())
@ -395,7 +527,7 @@ func (s *Handler) handleMode(msg *irc.Message) error {
}
for _, ch := range s.network.Channels {
err := s.handleJoinChannel(ch.Name)
err := s.HandleJoinChannel(ch.Name, ch.Password)
if err != nil {
log.Error().Err(err).Msgf("error joining channel: %v", ch.Name)
continue
@ -423,11 +555,36 @@ func (s *Handler) handlePing(msg *irc.Message) error {
return err
}
s.lastPing = time.Now()
s.setLastPing()
return nil
}
func (s *Handler) isValidAnnouncer(nick string) bool {
_, ok := s.validAnnouncers[nick]
if !ok {
return false
}
return true
}
func (s *Handler) setLastAnnounce() {
s.lastAnnounce = time.Now()
}
func (s *Handler) GetLastAnnounce() time.Time {
return s.lastAnnounce
}
func (s *Handler) setLastPing() {
s.lastPing = time.Now()
}
func (s *Handler) GetLastPing() time.Time {
return s.lastPing
}
// irc line can contain lots of extra stuff like color so lets clean that
func cleanMessage(message string) string {
var regexMessageClean = `\x0f|\x1f|\x02|\x03(?:[\d]{1,2}(?:,[\d]{1,2})?)?`