bantracker

Documentation

Index

• Constants
• func CheckBan(b *Ban, user *channeltracker.User) bool
• type Ban
  • func ParseBan(channel, ban string) *Ban
• type BanList
• type BanTracker
  • func (b *BanTracker) GetMatchingBans(channel string, user *channeltracker.User) []*Ban
• type ChannelConfig

Constants

const (
	PermBTAdmin   = "bantracker.admin" // Constant for assigning a permission to bantracker admins
	PermBTView    = "bantracker.view"  // Constant for assigning a permission to bantracker viewers
	PermBTPattern = "bantracker.%s.%s"
)

Define constants

Functions

func CheckBan

func CheckBan(b *Ban, user *channeltracker.User) bool

Types

type Ban

type Ban struct {
	Source   string
	Type     string
	Pattern  string
	Forward  string
	Negation bool
	Raw      string
}

Ban tracks the type and pattern of each ban. If a $j ban, stores the sub bans

func ParseBan

func ParseBan(channel, ban string) *Ban

type BanList

type BanList struct {
	// contains filtered or unexported fields
}

BanList stores the bans for a channel

type BanTracker

type BanTracker struct {
	// contains filtered or unexported fields
}

BanTracker is the base type for this plugin, all functionality is built on this

func (*BanTracker) GetMatchingBans

func (b *BanTracker) GetMatchingBans(channel string, user *channeltracker.User) []*Ban

type ChannelConfig

type ChannelConfig struct {
	gorm.Model
	Target  string `gorm:"unique"`
	Monitor string
	Logging string
	Echo    bool
}

ChannelConfig stores the information for each channel.