plugins

type ActionDocumentation struct {
	Description string `json:"description"`
	Name        string `json:"name"`
	Type        string `json:"type"`

	Fields []ActionDocumentationField `json:"fields"`
}

type ActionDocumentationField struct {
	Default         string                       `json:"default"`
	Description     string                       `json:"description"`
	Key             string                       `json:"key"`
	Long            bool                         `json:"long"`
	Name            string                       `json:"name"`
	Optional        bool                         `json:"optional"`
	SupportTemplate bool                         `json:"support_template"`
	Type            ActionDocumentationFieldType `json:"type"`
}

type ActionDocumentationFieldType string

type Actor interface {
	// Execute will be called after the config was read into the Actor
	Execute(c *irc.Client, m *irc.Message, r *Rule, evtData FieldCollection, attrs FieldCollection) (preventCooldown bool, err error)
	// IsAsync may return true if the Execute function is to be executed
	// in a Go routine as of long runtime. Normally it should return false
	// except in very specific cases
	IsAsync() bool
	// Name must return an unique name for the actor in order to identify
	// it in the logs for debugging purposes
	Name() string
	// Validate will be called to validate the loaded configuration. It should
	// return an error if required keys are missing from the AttributeStore
	// or if keys contain broken configs
	Validate(FieldCollection) error
}

type ActorCreationFunc func() Actor

type ActorDocumentationRegistrationFunc func(ActionDocumentation)

type ActorRegistrationFunc func(name string, acf ActorCreationFunc)

type CronRegistrationFunc func(spec string, cmd func()) (cron.EntryID, error)

type FieldCollection map[string]interface{}

type HTTPRouteParamDocumentation struct {
	Description string
	Name        string
	Required    bool
	Type        string
}

type HTTPRouteRegistrationArgs struct {
	Accept              []string
	Description         string
	HandlerFunc         http.HandlerFunc
	IsPrefix            bool
	Method              string
	Module              string
	Name                string
	Path                string
	QueryParams         []HTTPRouteParamDocumentation
	RequiresEditorsAuth bool
	RequiresWriteAuth   bool
	ResponseType        HTTPRouteResponseType
	RouteParams         []HTTPRouteParamDocumentation
	SkipDocumentation   bool
}

type HTTPRouteRegistrationFunc func(HTTPRouteRegistrationArgs) error

type HTTPRouteResponseType uint64

type LoggerCreationFunc func(moduleName string) *log.Entry

type MsgFormatter func(tplString string, m *irc.Message, r *Rule, fields FieldCollection) (string, error)

type RawMessageHandlerFunc func(m *irc.Message) error

type RawMessageHandlerRegisterFunc func(RawMessageHandlerFunc) error

type RegisterFunc func(RegistrationArguments) error

type RegistrationArguments struct {
	// FormatMessage is a method to convert templates into strings using internally known variables / configs
	FormatMessage MsgFormatter
	// GetLogger returns a sirupsen log.Entry pre-configured with the module name
	GetLogger LoggerCreationFunc
	// GetStorageManager returns an interface to access the modules storage
	GetStorageManager func() StorageManager
	// GetTwitchClient retrieves a fully configured Twitch client with initialized cache
	GetTwitchClient func() *twitch.Client
	// RegisterActor is used to register a new IRC rule-actor implementing the Actor interface
	RegisterActor ActorRegistrationFunc
	// RegisterActorDocumentation is used to register an ActorDocumentation for the config editor
	RegisterActorDocumentation ActorDocumentationRegistrationFunc
	// RegisterAPIRoute registers a new HTTP handler function including documentation
	RegisterAPIRoute HTTPRouteRegistrationFunc
	// RegisterCron is a method to register cron functions in the global cron instance
	RegisterCron CronRegistrationFunc
	// RegisterRawMessageHandler is a method to register an handler to receive ALL messages received
	RegisterRawMessageHandler RawMessageHandlerRegisterFunc
	// RegisterTemplateFunction can be used to register a new template functions
	RegisterTemplateFunction TemplateFuncRegister
	// SendMessage can be used to send a message not triggered by an event
	SendMessage SendMessageFunc
}

type Rule struct {
	UUID        string `hash:"-" json:"uuid,omitempty" yaml:"uuid,omitempty"`
	Description string `json:"description,omitempty" yaml:"description,omitempty"`

	Actions []*RuleAction `json:"actions,omitempty" yaml:"actions,omitempty"`

	Cooldown        *time.Duration `json:"cooldown,omitempty" yaml:"cooldown,omitempty"`
	ChannelCooldown *time.Duration `json:"channel_cooldown,omitempty" yaml:"channel_cooldown,omitempty"`
	UserCooldown    *time.Duration `json:"user_cooldown,omitempty" yaml:"user_cooldown,omitempty"`
	SkipCooldownFor []string       `json:"skip_cooldown_for,omitempty" yaml:"skip_cooldown_for,omitempty"`

	MatchChannels []string `json:"match_channels,omitempty" yaml:"match_channels,omitempty"`
	MatchEvent    *string  `json:"match_event,omitempty" yaml:"match_event,omitempty"`
	MatchMessage  *string  `json:"match_message,omitempty" yaml:"match_message,omitempty"`
	MatchUsers    []string `json:"match_users,omitempty" yaml:"match_users,omitempty" `

	DisableOnMatchMessages []string `json:"disable_on_match_messages,omitempty" yaml:"disable_on_match_messages,omitempty"`

	Disable           *bool    `json:"disable,omitempty" yaml:"disable,omitempty"`
	DisableOnOffline  *bool    `json:"disable_on_offline,omitempty" yaml:"disable_on_offline,omitempty"`
	DisableOnPermit   *bool    `json:"disable_on_permit,omitempty" yaml:"disable_on_permit,omitempty"`
	DisableOnTemplate *string  `json:"disable_on_template,omitempty" yaml:"disable_on_template,omitempty"`
	DisableOn         []string `json:"disable_on,omitempty" yaml:"disable_on,omitempty"`
	EnableOn          []string `json:"enable_on,omitempty" yaml:"enable_on,omitempty"`
	// contains filtered or unexported fields
}

type RuleAction struct {
	Type       string          `json:"type" yaml:"type,omitempty"`
	Attributes FieldCollection `json:"attributes" yaml:"attributes,omitempty"`
}

type SendMessageFunc func(*irc.Message) error

type StorageManager interface {
	DeleteModuleStore(moduleUUID string) error
	GetModuleStore(moduleUUID string, storedObject StorageUnmarshaller) error
	SetModuleStore(moduleUUID string, storedObject StorageMarshaller) error
}

type StorageMarshaller interface {
	MarshalStoredObject() ([]byte, error)
}

type StorageUnmarshaller interface {
	UnmarshalStoredObject([]byte) error
}

type TemplateFuncGetter func(*irc.Message, *Rule, FieldCollection) interface{}

type TemplateFuncRegister func(name string, fg TemplateFuncGetter)

type TimerEntry struct {
	Kind TimerType `json:"kind"`
	Time time.Time `json:"time"`
}

type TimerStore interface {
	AddCooldown(tt TimerType, limiter, ruleID string, expiry time.Time)
	InCooldown(tt TimerType, limiter, ruleID string) bool
	AddPermit(channel, username string)
	HasPermit(channel, username string) bool
}

type TimerType uint8