bot

package
v0.260301.1100-preview Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 1, 2026 License: MPL-2.0 Imports: 23 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildActionKeyboard 

func BuildActionKeyboard() *imbot.KeyboardBuilder

BuildActionKeyboard builds the inline keyboard for actions (Clear/Bind)

func BuildCancelKeyboard 

func BuildCancelKeyboard() *imbot.KeyboardBuilder

BuildCancelKeyboard builds a simple cancel keyboard

func BuildCreateConfirmKeyboard 

func BuildCreateConfirmKeyboard(path string) (*imbot.KeyboardBuilder, string)

BuildCreateConfirmKeyboard builds the confirmation keyboard for creating a directory

func BuildCustomPathPrompt 

func BuildCustomPathPrompt() string

BuildCustomPathPrompt returns the text for custom path input prompt

func ExpandPath 

func ExpandPath(path string) (string, error)

ExpandPath expands ~ to home directory and returns absolute path

func InitChatSchema 

func InitChatSchema(db *sql.DB) error

InitChatSchema initializes the chat schema

func RunBot 

func RunBot(ctx context.Context, store *Store, sessionMgr *session.Manager, agentBoot *agentboot.AgentBoot, permHandler permission.Handler) error

RunBot starts a multi-platform bot that proxies messages to remote-coder sessions.

func RunBotWithSettingsOnly 

func RunBotWithSettingsOnly(ctx context.Context, settings Settings, store *Store, sessionMgr *session.Manager, agentBoot *agentboot.AgentBoot, permHandler permission.Handler) error

RunBotWithSettingsOnly runs a bot using only the settings

func SendDirectoryBrowser 

func SendDirectoryBrowser(ctx context.Context, bot imbot.Bot, browser *DirectoryBrowser, chatID string, editMessageID string) (string, error)

SendDirectoryBrowser sends or updates the directory browser message

func ValidateProjectPath 

func ValidateProjectPath(path string) error

ValidateProjectPath checks if the path exists and is accessible

Types

type BindFlowState 

type BindFlowState struct {
	ChatID       string
	CurrentPath  string
	Page         int
	TotalDirs    int
	PageSize     int
	MessageID    string // Message ID to edit
	ExpiresAt    time.Time
	WaitingInput bool     // Waiting for custom path input
	PromptMsgID  string   // Prompt message ID for cleanup
	Dirs         []string // Current directory list (for navigation by index)
}

BindFlowState represents the state of an ongoing bind flow

type BotHandler added in v0.260305.1400 

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

BotHandler encapsulates all bot message handling logic and dependencies

func NewBotHandler added in v0.260305.1400 

func NewBotHandler(
	ctx context.Context,
	store *Store,
	sessionMgr *session.Manager,
	agentBoot *agentboot.AgentBoot,
	permHandler permission.Handler,
	summaryEngine *summarizer.Engine,
	directoryBrowser *DirectoryBrowser,
	manager *imbot.Manager,
) *BotHandler

NewBotHandler creates a new bot handler with all dependencies

func (*BotHandler) HandleMessage added in v0.260305.1400 

func (h *BotHandler) HandleMessage(msg imbot.Message, platform imbot.Platform)

HandleMessage is the main entry point for handling bot messages

func (*BotHandler) SendText added in v0.260305.1400 

func (h *BotHandler) SendText(hCtx HandlerContext, text string)

SendText sends a plain text message

type BotLifecycle added in v0.260305.1400 

type BotLifecycle interface {
	// Start starts a bot by UUID
	Start(ctx context.Context, uuid string) error
	// Stop stops a bot by UUID
	Stop(uuid string)
	// IsRunning checks if a bot is running
	IsRunning(uuid string) bool
	// Sync ensures running bots match the enabled settings
	Sync(ctx context.Context) error
}

BotLifecycle defines the interface for controlling bot lifecycle This allows the API layer to control bot startup/shutdown without direct dependency on the Manager type

type Chat 

type Chat struct {
	ChatID      string `json:"chat_id"`
	Platform    string `json:"platform"`
	ProjectPath string `json:"project_path,omitempty"`
	OwnerID     string `json:"owner_id,omitempty"`
	SessionID   string `json:"session_id,omitempty"`

	// Group-specific
	IsWhitelisted bool   `json:"is_whitelisted"`
	WhitelistedBy string `json:"whitelisted_by,omitempty"`

	// Bash state
	BashCwd string `json:"bash_cwd,omitempty"`

	CreatedAt time.Time `json:"created_at"`
	UpdatedAt time.Time `json:"updated_at"`
}

Chat represents all state associated with a chat (direct or group)

type ChatStore 

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

ChatStore handles unified chat persistence

func NewChatStore 

func NewChatStore(db *sql.DB) (*ChatStore, error)

NewChatStore creates a new chat store

func (*ChatStore) AddToWhitelist 

func (s *ChatStore) AddToWhitelist(chatID, platform, addedBy string) error

AddToWhitelist adds a chat to the whitelist

func (*ChatStore) BindProject 

func (s *ChatStore) BindProject(chatID, platform, projectPath, ownerID string) error

BindProject binds a project to a chat (creates chat if not exists)

func (*ChatStore) GetBashCwd 

func (s *ChatStore) GetBashCwd(chatID string) (string, bool, error)

GetBashCwd retrieves the bash working directory for a chat

func (*ChatStore) GetChat 

func (s *ChatStore) GetChat(chatID string) (*Chat, error)

GetChat retrieves a chat by ID

func (*ChatStore) GetOrCreateChat 

func (s *ChatStore) GetOrCreateChat(chatID, platform string) (*Chat, error)

GetOrCreateChat gets a chat or creates it if not exists

func (*ChatStore) GetProjectPath 

func (s *ChatStore) GetProjectPath(chatID string) (string, bool, error)

GetProjectPath retrieves the project path for a chat

func (*ChatStore) GetSession 

func (s *ChatStore) GetSession(chatID string) (string, bool, error)

GetSession retrieves the session for a chat

func (*ChatStore) IsWhitelisted 

func (s *ChatStore) IsWhitelisted(chatID string) bool

IsWhitelisted checks if a chat is whitelisted

func (*ChatStore) ListChatsByOwner 

func (s *ChatStore) ListChatsByOwner(ownerID, platform string) ([]*Chat, error)

ListChatsByOwner lists all chats owned by a user

func (*ChatStore) RemoveFromWhitelist 

func (s *ChatStore) RemoveFromWhitelist(chatID string) error

RemoveFromWhitelist removes a chat from the whitelist

func (*ChatStore) SetBashCwd 

func (s *ChatStore) SetBashCwd(chatID, cwd string) error

SetBashCwd sets the bash working directory for a chat

func (*ChatStore) SetSession 

func (s *ChatStore) SetSession(chatID, sessionID string) error

SetSession sets the session for a chat (creates chat if not exists)

func (*ChatStore) UpdateChat 

func (s *ChatStore) UpdateChat(chatID string, fn func(*Chat)) error

UpdateChat updates specific fields of a chat

func (*ChatStore) UpsertChat 

func (s *ChatStore) UpsertChat(chat *Chat) error

UpsertChat creates or updates a chat

type DirectoryBrowser 

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

DirectoryBrowser manages directory navigation for bind flow

func NewDirectoryBrowser 

func NewDirectoryBrowser() *DirectoryBrowser

NewDirectoryBrowser creates a new directory browser

func (*DirectoryBrowser) BuildKeyboard 

func (b *DirectoryBrowser) BuildKeyboard(chatID string) (*BindFlowState, *imbot.KeyboardBuilder, string, error)

BuildKeyboard builds the inline keyboard for directory browsing

func (*DirectoryBrowser) Clear 

func (b *DirectoryBrowser) Clear(chatID string)

Clear removes the state for a chat

func (*DirectoryBrowser) GetCurrentPath 

func (b *DirectoryBrowser) GetCurrentPath(chatID string) string

GetCurrentPath returns the current path for a chat

func (*DirectoryBrowser) GetState 

func (b *DirectoryBrowser) GetState(chatID string) *BindFlowState

GetState returns the current state for a chat

func (*DirectoryBrowser) IsWaitingInput 

func (b *DirectoryBrowser) IsWaitingInput(chatID string) bool

IsWaitingInput checks if the chat is waiting for custom path input

func (*DirectoryBrowser) Navigate 

func (b *DirectoryBrowser) Navigate(chatID string, path string) error

Navigate navigates to a subdirectory

func (*DirectoryBrowser) NavigateByIndex 

func (b *DirectoryBrowser) NavigateByIndex(chatID string, index int) error

NavigateByIndex navigates to a subdirectory by index (stored in state.Dirs)

func (*DirectoryBrowser) NavigateUp 

func (b *DirectoryBrowser) NavigateUp(chatID string) error

NavigateUp navigates to the parent directory

func (*DirectoryBrowser) NextPage 

func (b *DirectoryBrowser) NextPage(chatID string) error

NextPage moves to the next page of directories

func (*DirectoryBrowser) PrevPage 

func (b *DirectoryBrowser) PrevPage(chatID string) error

PrevPage moves to the previous page of directories

func (*DirectoryBrowser) SetMessageID 

func (b *DirectoryBrowser) SetMessageID(chatID string, messageID string)

SetMessageID sets the message ID for editing

func (*DirectoryBrowser) SetWaitingInput 

func (b *DirectoryBrowser) SetWaitingInput(chatID string, waiting bool, promptMsgID string)

SetWaitingInput sets the waiting for input state

func (*DirectoryBrowser) Start 

func (b *DirectoryBrowser) Start(chatID string) (*BindFlowState, error)

Start begins a new bind flow for a chat

type HandlerContext added in v0.260305.1400 

type HandlerContext struct {
	Bot       imbot.Bot
	ChatID    string
	SenderID  string
	MessageID string
	Platform  imbot.Platform
	IsDirect  bool
	IsGroup   bool
	Text      string
	Metadata  map[string]interface{}
}

HandlerContext contains per-message context data

type Manager 

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

Manager manages the lifecycle of running bot instances

func NewManager 

func NewManager(store SettingsStore, sessionMgr *session.Manager, agentBoot *agentboot.AgentBoot, permHandler permission.Handler) *Manager

NewManager creates a new bot manager with a settings store

func (*Manager) IsRunning 

func (m *Manager) IsRunning(uuid string) bool

IsRunning checks if a bot is running

func (*Manager) SetDBPath added in v0.260305.1400 

func (m *Manager) SetDBPath(dbPath string)

SetDBPath sets the database path for chat store operations

func (*Manager) Start 

func (m *Manager) Start(parentCtx context.Context, uuid string) error

Start starts a bot by UUID

func (*Manager) StartEnabled 

func (m *Manager) StartEnabled(ctx context.Context) error

StartEnabled starts all enabled bots

func (*Manager) StartEnabledStopDisabled added in v0.260305.1400 

func (m *Manager) StartEnabledStopDisabled(ctx context.Context) error

StartEnabledStopDisabled is a convenience method that ensures running bots match enabled settings. It's an alias for Sync() with clearer naming for specific use cases.

func (*Manager) Stop 

func (m *Manager) Stop(uuid string)

Stop stops a bot by UUID

func (*Manager) StopAll 

func (m *Manager) StopAll()

StopAll stops all running bots

func (*Manager) Sync added in v0.260305.1400 

func (m *Manager) Sync(ctx context.Context) error

Sync ensures the running bots match the enabled settings in the store. It starts bots that are enabled but not running, and stops bots that are running but disabled.

type ResponseMeta 

type ResponseMeta struct {
	ProjectPath string
	SessionID   string
	ChatID      string
	UserID      string
}

ResponseMeta contains metadata for response formatting

type Settings 

type Settings struct {
	UUID          string            `json:"uuid,omitempty"`
	Name          string            `json:"name,omitempty"`           // User-defined name for the bot
	Token         string            `json:"token,omitempty"`          // Legacy: for backward compatibility
	Platform      string            `json:"platform"`                 // Platform identifier
	AuthType      string            `json:"auth_type"`                // Auth type: token, oauth, qr
	Auth          map[string]string `json:"auth"`                     // Dynamic auth fields based on platform
	ProxyURL      string            `json:"proxy_url,omitempty"`      // Optional proxy URL
	ChatIDLock    string            `json:"chat_id,omitempty"`        // Optional chat ID lock
	BashAllowlist []string          `json:"bash_allowlist,omitempty"` // Optional bash command allowlist
	Enabled       bool              `json:"enabled"`                  // Whether this bot is enabled
	CreatedAt     string            `json:"created_at,omitempty"`
	UpdatedAt     string            `json:"updated_at,omitempty"`
}

Settings represents bot configuration with platform-specific auth

type SettingsStore added in v0.260305.1400 

type SettingsStore interface {
	// GetSettingsByUUIDInterface returns settings by UUID as interface{}
	GetSettingsByUUIDInterface(uuid string) (interface{}, error)
	// ListEnabledSettingsInterface returns all enabled settings as interface{}
	ListEnabledSettingsInterface() (interface{}, error)
}

SettingsStore defines the interface for bot settings storage This allows both the legacy bot.Store and the new db.ImBotSettingsStore to be used

type Store 

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

func NewStore 

func NewStore(dbPath string) (*Store, error)

func NewStoreForChatOnly added in v0.260305.1400 

func NewStoreForChatOnly(dbPath string) (*Store, error)

NewStoreForChatOnly creates a minimal bot.Store for chat state management only

func (*Store) AddGroupToWhitelist 

func (s *Store) AddGroupToWhitelist(groupID, platform, addedBy string) error

func (*Store) ChatStore 

func (s *Store) ChatStore() *ChatStore

ChatStore returns the chat store

func (*Store) Close 

func (s *Store) Close() error

func (*Store) CreateSettings 

func (s *Store) CreateSettings(settings Settings) (Settings, error)

CreateSettings creates a new bot configuration

func (*Store) DB 

func (s *Store) DB() *sql.DB

DB returns the underlying database connection

func (*Store) DeleteSettings 

func (s *Store) DeleteSettings(uuid string) error

DeleteSettings deletes a bot configuration

func (*Store) GetBashCwd 

func (s *Store) GetBashCwd(chatID string) (string, bool, error)

func (*Store) GetSessionForChat 

func (s *Store) GetSessionForChat(chatID string) (string, bool, error)

func (*Store) GetSettings 

func (s *Store) GetSettings() (Settings, error)

func (*Store) GetSettingsByUUID 

func (s *Store) GetSettingsByUUID(uuid string) (Settings, error)

GetSettingsByUUID returns a single bot configuration by UUID

func (*Store) GetSettingsByUUIDInterface 

func (s *Store) GetSettingsByUUIDInterface(uuid string) (interface{}, error)

GetSettingsByUUIDInterface returns settings as interface{} for SettingsStore interface

func (*Store) IsGroupWhitelisted 

func (s *Store) IsGroupWhitelisted(groupID string) bool

func (*Store) ListEnabledSettings 

func (s *Store) ListEnabledSettings() ([]Settings, error)

ListEnabledSettings returns all enabled bot configurations

func (*Store) ListEnabledSettingsInterface 

func (s *Store) ListEnabledSettingsInterface() (interface{}, error)

ListEnabledSettingsInterface returns settings as interface{} for SettingsStore interface

func (*Store) ListSettings 

func (s *Store) ListSettings() ([]Settings, error)

ListSettings returns all bot configurations from v2 table

func (*Store) ListWhitelistedGroups 

func (s *Store) ListWhitelistedGroups() ([]struct {
	GroupID   string
	Platform  string
	AddedBy   string
	CreatedAt string
}, error)

ListWhitelistedGroups returns all whitelisted groups

func (*Store) RemoveGroupFromWhitelist 

func (s *Store) RemoveGroupFromWhitelist(groupID string) error

func (*Store) SaveSettings 

func (s *Store) SaveSettings(settings Settings) error

func (*Store) SetBashCwd 

func (s *Store) SetBashCwd(chatID, cwd string) error

func (*Store) SetSessionForChat 

func (s *Store) SetSessionForChat(chatID, sessionID string) error

func (*Store) ToggleSettings 

func (s *Store) ToggleSettings(uuid string) (bool, error)

ToggleSettings toggles the enabled status of a bot configuration

func (*Store) UpdateSettings 

func (s *Store) UpdateSettings(uuid string, settings Settings) error

UpdateSettings updates an existing bot configuration

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.