From 44ccf133dd44211ce1200595c7a9bea8e7609c1e Mon Sep 17 00:00:00 2001 From: Runxi Yu Date: Sun, 06 Apr 2025 10:01:02 +0800 Subject: [PATCH] irc: Move everything from lindenii-irc --- forged/internal/irc/bot.go | 5 ++--- forged/internal/irc/conn.go | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ forged/internal/irc/errors.go | 8 ++++++++ forged/internal/irc/message.go | 126 +++++++++++++++++++++++++++++++++++++++++++++++++++++ forged/internal/irc/source.go | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ go.mod | 1 - go.sum | 2 -- diff --git a/forged/internal/irc/bot.go b/forged/internal/irc/bot.go index 046799ff07a44f2356e5e3b5ecdef1482e748854..1c6d32fbcca9fc070b6f1be559c728df67d6d3dd 100644 --- a/forged/internal/irc/bot.go +++ b/forged/internal/irc/bot.go @@ -10,7 +10,6 @@ "log/slog" "net" "go.lindenii.runxiyu.org/forge/forged/internal/misc" - irc "go.lindenii.runxiyu.org/lindenii-irc" ) // Config contains IRC connection and identity settings for the bot. @@ -55,7 +54,7 @@ return err } defer underlyingConn.Close() - conn := irc.NewConn(underlyingConn) + conn := NewConn(underlyingConn) logAndWriteLn := func(s string) (n int, err error) { slog.Debug("irc tx", "line", s) @@ -103,7 +102,7 @@ readLoopError <- err return } case "JOIN": - c, ok := msg.Source.(irc.Client) + c, ok := msg.Source.(Client) if !ok { slog.Error("unable to convert source of JOIN to client") } diff --git a/forged/internal/irc/conn.go b/forged/internal/irc/conn.go new file mode 100644 index 0000000000000000000000000000000000000000..b975b720b0bbaa922f63035738438c98ab73d0d1 --- /dev/null +++ b/forged/internal/irc/conn.go @@ -0,0 +1,49 @@ +package irc + +import ( + "bufio" + "net" + "slices" + + "go.lindenii.runxiyu.org/forge/forged/internal/misc" +) + +type Conn struct { + netConn net.Conn + bufReader *bufio.Reader +} + +func NewConn(netConn net.Conn) Conn { + return Conn{ + netConn: netConn, + bufReader: bufio.NewReader(netConn), + } +} + +func (c *Conn) ReadMessage() (msg Message, line string, err error) { + raw, err := c.bufReader.ReadSlice('\n') + if err != nil { + return + } + + if raw[len(raw)-1] == '\n' { + raw = raw[:len(raw)-1] + } + if raw[len(raw)-1] == '\r' { + raw = raw[:len(raw)-1] + } + + lineBytes := slices.Clone(raw) + line = misc.BytesToString(lineBytes) + msg, err = Parse(lineBytes) + + return +} + +func (c *Conn) Write(p []byte) (n int, err error) { + return c.netConn.Write(p) +} + +func (c *Conn) WriteString(s string) (n int, err error) { + return c.netConn.Write(misc.StringToBytes(s)) +} diff --git a/forged/internal/irc/errors.go b/forged/internal/irc/errors.go new file mode 100644 index 0000000000000000000000000000000000000000..3506c7056ffad80bf6d5831c7bfd0797b007dda1 --- /dev/null +++ b/forged/internal/irc/errors.go @@ -0,0 +1,8 @@ +package irc + +import "errors" + +var ( + ErrInvalidIRCv3Tag = errors.New("invalid ircv3 tag") + ErrMalformedMsg = errors.New("malformed irc message") +) diff --git a/forged/internal/irc/message.go b/forged/internal/irc/message.go new file mode 100644 index 0000000000000000000000000000000000000000..84b6867586a59982362514368541ab82a7b810d6 --- /dev/null +++ b/forged/internal/irc/message.go @@ -0,0 +1,126 @@ +// SPDX-License-Identifier: MIT +// SPDX-FileCopyrightText: Copyright (c) 2018-2024 luk3yx +// SPDX-FileCopyrightText: Copyright (c) 2025 Runxi Yu + +package irc + +import ( + "bytes" + + "go.lindenii.runxiyu.org/forge/forged/internal/misc" +) + +type Message struct { + Command string + Source Source + Tags map[string]string + Args []string +} + +// All strings returned are borrowed from the input byte slice. +func Parse(raw []byte) (msg Message, err error) { + sp := bytes.Split(raw, []byte{' '}) // TODO: Use bytes.Cut instead here + + if bytes.HasPrefix(sp[0], []byte{'@'}) { // TODO: Check size manually + if len(sp[0]) < 2 { + err = ErrMalformedMsg + return + } + sp[0] = sp[0][1:] + + msg.Tags, err = tagsToMap(sp[0]) + if err != nil { + return + } + + if len(sp) < 2 { + err = ErrMalformedMsg + return + } + sp = sp[1:] + } else { + msg.Tags = nil // TODO: Is a nil map the correct thing to use here? + } + + if bytes.HasPrefix(sp[0], []byte{':'}) { // TODO: Check size manually + if len(sp[0]) < 2 { + err = ErrMalformedMsg + return + } + sp[0] = sp[0][1:] + + msg.Source = parseSource(sp[0]) + + if len(sp) < 2 { + err = ErrMalformedMsg + return + } + sp = sp[1:] + } + + msg.Command = misc.BytesToString(sp[0]) + if len(sp) < 2 { + return + } + sp = sp[1:] + + for i := 0; i < len(sp); i++ { + if len(sp[i]) == 0 { + continue + } + if sp[i][0] == ':' { + if len(sp[i]) < 2 { + sp[i] = []byte{} + } else { + sp[i] = sp[i][1:] + } + msg.Args = append(msg.Args, misc.BytesToString(bytes.Join(sp[i:], []byte{' '}))) + // TODO: Avoid Join by not using sp in the first place + break + } + msg.Args = append(msg.Args, misc.BytesToString(sp[i])) + } + + return +} + +var ircv3TagEscapes = map[byte]byte{ //nolint:gochecknoglobals + ':': ';', + 's': ' ', + 'r': '\r', + 'n': '\n', +} + +func tagsToMap(raw []byte) (tags map[string]string, err error) { + tags = make(map[string]string) + for rawTag := range bytes.SplitSeq(raw, []byte{';'}) { + key, value, found := bytes.Cut(rawTag, []byte{'='}) + if !found { + err = ErrInvalidIRCv3Tag + return + } + if len(value) == 0 { + tags[misc.BytesToString(key)] = "" + } else { + if !bytes.Contains(value, []byte{'\\'}) { + tags[misc.BytesToString(key)] = misc.BytesToString(value) + } else { + valueUnescaped := bytes.NewBuffer(make([]byte, 0, len(value))) + for i := 0; i < len(value); i++ { + if value[i] == '\\' { + i++ + byteUnescaped, ok := ircv3TagEscapes[value[i]] + if !ok { + byteUnescaped = value[i] + } + valueUnescaped.WriteByte(byteUnescaped) + } else { + valueUnescaped.WriteByte(value[i]) + } + } + tags[misc.BytesToString(key)] = misc.BytesToString(valueUnescaped.Bytes()) + } + } + } + return +} diff --git a/forged/internal/irc/source.go b/forged/internal/irc/source.go new file mode 100644 index 0000000000000000000000000000000000000000..d955f45652cde1dbf74bb22385793f517c08e9f1 --- /dev/null +++ b/forged/internal/irc/source.go @@ -0,0 +1,50 @@ +// SPDX-License-Identifier: MIT +// SPDX-FileCopyrightText: Copyright (c) 2025 Runxi Yu + +package irc + +import ( + "bytes" + + "go.lindenii.runxiyu.org/forge/forged/internal/misc" +) + +type Source interface { + AsSourceString() string +} + +func parseSource(s []byte) Source { + nick, userhost, found := bytes.Cut(s, []byte{'!'}) + if !found { + return Server{name: misc.BytesToString(s)} + } + + user, host, found := bytes.Cut(userhost, []byte{'@'}) + if !found { + return Server{name: misc.BytesToString(s)} + } + + return Client{ + Nick: misc.BytesToString(nick), + User: misc.BytesToString(user), + Host: misc.BytesToString(host), + } +} + +type Server struct { + name string +} + +func (s Server) AsSourceString() string { + return s.name +} + +type Client struct { + Nick string + User string + Host string +} + +func (c Client) AsSourceString() string { + return c.Nick + "!" + c.User + "@" + c.Host +} diff --git a/go.mod b/go.mod index d9cda014dd88575da75db6e9ece8658e8e15dc52..b9eeef9a491933f2df1ffbd8b06d92d5ca9821c0 100644 --- a/go.mod +++ b/go.mod @@ -18,7 +18,6 @@ github.com/niklasfasching/go-org v1.7.0 github.com/tdewolff/minify/v2 v2.22.4 github.com/yuin/goldmark v1.7.8 go.lindenii.runxiyu.org/lindenii-common v0.0.0-20250321131425-dda3538a9cd4 - go.lindenii.runxiyu.org/lindenii-irc v0.0.0-20250322030600-1e47f911f1fa golang.org/x/crypto v0.36.0 ) diff --git a/go.sum b/go.sum index b3c4db735c79fe8181d3ea27a8d8951f6ce888c1..6b1b55581e38f595203d82cdda946c61e3423d98 100644 --- a/go.sum +++ b/go.sum @@ -123,8 +123,6 @@ github.com/yuin/goldmark v1.7.8 h1:iERMLn0/QJeHFhxSt3p6PeN9mGnvIKSpG9YYorDMnic= github.com/yuin/goldmark v1.7.8/go.mod h1:uzxRWxtg69N339t3louHJ7+O03ezfj6PlliRlaOzY1E= go.lindenii.runxiyu.org/lindenii-common v0.0.0-20250321131425-dda3538a9cd4 h1:xX6s8+Yo5fRHzVswlJvKQjjN6lZCG7lAh33dTXBqsYE= go.lindenii.runxiyu.org/lindenii-common v0.0.0-20250321131425-dda3538a9cd4/go.mod h1:bOxuuGXA3UpbLb1lKohr2j2MVcGGLcqfAprGx9VCkMA= -go.lindenii.runxiyu.org/lindenii-irc v0.0.0-20250322030600-1e47f911f1fa h1:LU3ZN/9xVUOEHyUCa5d+lvrL2sqhy/PR2iM2DuAQDqs= -go.lindenii.runxiyu.org/lindenii-irc v0.0.0-20250322030600-1e47f911f1fa/go.mod h1:fE6Ks8GK7PHZGAPkTWG593UmF7FmyugcRcqmey3Nvy0= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= -- 2.48.1