n0h4rt/chadango

Modern Chatango Bot Framework written in Go

chadango's Issues

Fix code scanning alert - Incorrect conversion between integer types

Tracking issue for:

• https://github.com/n0h4rt/chadango/security/code-scanning/1

Fix code scanning alert - Incorrect conversion between integer types

Tracking issue for:

• https://github.com/n0h4rt/chadango/security/code-scanning/2

OnLogin, and OnLogout events are not triggered correctly.

The OnLogout event is fired as OnLogin with anonymous user provided, but it should trigger OnLogout with the username of the user who logged out.

Add Persistence interface

This will allow Persistence to be implemented with other options besides a gob file, such as Redis, a Database, etc.

Something like this:

type Persistence interface {
	Initialize() error
	StartAutoSave(context.Context)
	Close() error
	GetBotData() *SyncMap[string, any]
	GetChatData(string) *SyncMap[string, any]
}

Some typos

chadango/constants.go

Lines 55 to 57 in 20a1771

	ErrConnectionClosed = errors.New("connection closed")
	ErrRetryEnds = errors.New("connection closed")

chadango/constants.go

Lines 77 to 81 in 20a1771

	ErrClearFailed = errors.New("clear failed")
	ErrAddModFailed = errors.New("clear failed")
	ErrUpdateModFailed = errors.New("clear failed")
	ErrRemoveModFailed = errors.New("clear failed")

Ineffective error assignment

The error assignment inside the callback becomes ineffective as it gets overridden by SyncSend. This issue occurs in various methods, including methods in the group.go file.

chadango/private.go

Lines 257 to 290 in 20a1771

	// SendMessage sends a private message with the specified text to the username.
	func (p *Private) SendMessage(username, text string) (err error) {
	cb := func(frame string) bool {
	head, _, _ := strings.Cut(frame, ":")
	switch head {
	case "show_fw":
	err = ErrFloodWarning
	return true
	case "toofast":
	err = ErrFloodBanned
	return true
	case "show_offline_limit":
	// The maximum number of unread messages is 51.
	// show_offline_limit:nekonyan
	err = ErrOfflineLimit
	return true
	default:
	p.events <- frame
	}
	return false
	}
	username = strings.ToLower(username)
	text = fmt.Sprintf(`<n%s/><m v="1"><g x%02ds%s="%s">%s</g></m>`, p.NameColor, p.TextSize, p.TextColor, p.TextFont, text)
	// The "msg" command does not produce a response, so we wait for 0.5 seconds to handle any potential errors that may occur.
	// The potential errors include "show_fw", "toofast", and "show_offline_limit".
	if err = p.SyncSendWithTimeout(cb, 500*time.Millisecond, "msg", username, text, "\r\n"); err == ErrTimeout {
	return nil
	}
	// Notifies the PM server that the client has just been active.
	p.WentActive()
	return
	}

Inconsistent callback design between the SyncSend* methods and the Range method of *SyncMap

The callback should return false if a correct frame is acquired, and true otherwise.

chadango/group.go

Lines 243 to 244 in 20a1771

	// The `callback` should return `true` if a correct frame is acquired, and `false` otherwise.
	func (g *Group) SyncSendWithTimeout(callback func(string) bool, timeout time.Duration, args ...string) (err error) {

chadango/private.go

Lines 217 to 218 in 20a1771

	// The `callback` should return `true` if a correct frame is acquired, and `false` otherwise.
	func (p *Private) SyncSendWithTimeout(callback func(string) bool, timeout time.Duration, args ...string) (err error) {

Just like the implementation in SyncMap.

chadango/syncmap.go

Lines 45 to 46 in 20a1771

	// If the function returns false, the iteration stops.
	func (sm *SyncMap[K, V]) Range(fun func(K, V) bool) {

chadango/syncmap.go

Lines 160 to 161 in 20a1771

	// If the function returns false, the iteration stops.
	func (sm *OrderedSyncMap[K, V]) Range(fun func(K, V) bool) {

chadango/syncmap.go

Lines 172 to 173 in 20a1771

	// If the function returns false, the iteration stops.
	func (sm *OrderedSyncMap[K, V]) RangeReversed(fun func(K, V) bool) {

When the app.Stop() method is called, only one group connection is properly disconnected

The line number 170 should be return true to allow the iteration to continue.

chadango/dispatcher.go

Lines 164 to 173 in a49508e

	cb := func(_ string, group *Group) bool {
	wg.Add(1)
	go func() {
	group.Disconnect()
	wg.Done()
	}()
	return false
	}
	app.Groups.Range(cb)

runtime error: slice bounds out of range [:8] with length 0

Error occurred upon processing the "i" event.

chadango/message.go

Line 168 in d2e7265

user.IsSelf = fields[3] == group.SessionID[:8] && strings.EqualFold(user.Name, group.LoginName)

It seems there is a race condition where the "i" event is processed before the "ok" event.

chadango/group.go

Line 1239 in d2e7265

g.SessionID = fields[1]