botsfw

type AnalyticsSettings struct {
	GaTrackingID string // TODO: Refactor to list of analytics providers
	Enabled      func(r *http.Request) bool
}

type Attachment interface {
	AttachmentType() AttachmentType
}

type AttachmentType int

type BotAPISendMessageChannel string

type BotAPIUser interface {
	// FirstName returns user's first name
	FirstName() string

	// LastName returns user's last name
	LastName() string
}

type BotAppContext interface {
	strongo.AppUserSettings // TODO: Do we really need it here?
	i18n.TranslationContext

	NewBotAppUserEntity() botsfwmodels.AppUserData
	GetBotChatEntityFactory(platform string) func() botsfwmodels.ChatData
}

type BotContext struct {
	BotHost     BotHost     // describes current bot app host environment
	BotSettings BotSettings // keeps parameters of a bot that are static and are not changed in runtime
}

type BotDriver struct {
	Analytics AnalyticsSettings
	// contains filtered or unexported fields
}

type BotHost interface {

	// Context returns a context.Context for a request. We need this as some platforms (as Google App Engine Standard)
	// require usage of a context with a specific wrapper
	Context(r *http.Request) context.Context

	// GetHTTPClient returns HTTP client for current host
	// We need this as some platforms (as Google App Engine Standard) require setting http client in a specific way.
	GetHTTPClient(c context.Context) *http.Client
}

type BotInputProvider interface {
	// Input returns a webhook input from a specific bot interface (Telegram, FB Messenger, Viber, etc.)
	Input() WebhookInput
}

type BotMessage interface {
	BotMessageType() BotMessageType
}

type BotMessageType int

type BotPlatform interface {

	// ID returns bot platform ID like 'telegram', 'fbmessenger', 'viber', etc.
	ID() string

	// Version returns a version of a bot platform adapter. It is used for debugging purposes.
	Version() string
}

type BotRecordsFieldsSetter interface {

	// Platform returns platform name, e.g. 'telegram', 'fbmessenger', etc.
	// This method is for debug pruposes and to indicate that different platforms may have different fields
	// Though '*' can be used for a generic setter that works for all platforms
	// If both '*' and platform specific setters are defined, the generic setter will be used first.
	Platform() string

	// SetAppUserFields sets fields of app user record
	SetAppUserFields(appUser botsfwmodels.AppUserData, sender WebhookSender) error

	// SetBotUserFields sets fields of bot user record
	SetBotUserFields(botUser botsfwmodels.BotUserData, sender WebhookSender, botID, botUserID, appUserID string) error

	// SetBotChatFields sets fields of bot chat record
	// TODO: document isAccessGranted parameter
	SetBotChatFields(botChat botsfwmodels.ChatData, chat WebhookChat, botID, botUserID, appUserID string, isAccessGranted bool) error
}

type BotSettings struct {
	Platform         Platform
	Env              strongo.Environment
	ID               string
	Profile          string
	Code             string
	Token            string
	PaymentToken     string
	PaymentTestToken string
	VerifyToken      string // Used by Facebook
	Locale           i18n.Locale
	Router           WebhooksRouter
	GAToken          string // TODO: Refactor tu support multiple or move out
}

type BotState interface {
	IsNewerThen(chatEntity botsfwmodels.ChatData) bool
}

type CallbackAction func(whc WebhookContext, callbackUrl *url.URL) (m MessageFromBot, err error)

type ChatIntID int64

type ChatUID interface {
	ChatUID() string
}

type Command struct {
	InputTypes     []WebhookInputType // Instant match if != WebhookInputUnknown && == whc.InputTypes()
	Icon           string
	Replies        []Command
	Code           string
	Title          string
	Titles         map[string]string
	ExactMatch     string
	Commands       []string
	Matcher        CommandMatcher
	Action         CommandAction
	CallbackAction CallbackAction
}

type CommandAction func(whc WebhookContext) (m MessageFromBot, err error)

type CommandMatcher func(Command, WebhookContext) bool

type EntryInput struct {
	Entry WebhookEntry
	Input WebhookInput
}

type EntryInputs struct {
	Entry  WebhookEntry
	Inputs []WebhookInput
}

type ErrAuthFailed string

type GaContext interface {
	GaQueuer
	// Flush() error
	GaCommon() gamp.Common
	GaEvent(category, action string) *gamp.Event
	GaEventWithLabel(category, action, label string) *gamp.Event
}

type GaQueuer interface {
	Queue(message gamp.Message) error
}

type HttpRouter interface {
	Handle(method string, path string, handle http.HandlerFunc)
}

type InputMessage interface {
	Text() string
}

type Logger interface {
	Infof(c context.Context, format string, args ...interface{})
	Errorf(c context.Context, format string, args ...interface{})
	Debugf(c context.Context, format string, args ...interface{})
	Warningf(c context.Context, format string, args ...interface{})
	Criticalf(c context.Context, format string, args ...interface{})
}

type MessageFormat int

type MessageFromBot struct {
	ToChat             ChatUID    `json:",omitempty"`
	TextMessageFromBot            // This is a shortcut to MessageFromBot{}.BotMessage = TextMessageFromBot{text: "abc"}
	BotMessage         BotMessage `json:",omitempty"`
}

type MessageUID interface {
	UID() string
}

type MessengerResponse interface {
}

type OnMessageSentResponse struct {
	StatusCode      int
	TelegramMessage MessengerResponse // TODO: change to some interface
}

type Platform string

type SettingsBy struct {

	// ByCode keeps settings by bot code - it is a human-readable ID of a bot
	ByCode map[string]*BotSettings

	// ByID keeps settings by bot ID - it is a machine-readable ID of a bot.
	ByID map[string]*BotSettings
}

type SettingsProvider func(c context.Context) SettingsBy

type TextMessageFromBot struct {
	Text                  string              `json:",omitempty"`
	Format                MessageFormat       `json:",omitempty"`
	DisableWebPagePreview bool                `json:",omitempty"`
	DisableNotification   bool                `json:",omitempty"`
	Keyboard              botsgocore.Keyboard `json:",omitempty"`
	IsEdit                bool                `json:",omitempty"`
	EditMessageUID        MessageUID          `json:",omitempty"`
}

type TranslatorProvider func(c context.Context) i18n.Translator

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

type WebhookActor interface {
	Platform() string // TODO: Consider removing this?
	GetID() interface{}
	IsBotUser() bool
	GetFirstName() string
	GetLastName() string
	GetUserName() string
	GetLanguage() string
}

type WebhookAttachment interface {
	Type() string       // Enum(image, video, audio) for Facebook
	PayloadUrl() string // 'payload.url' for Facebook
}

type WebhookAudioMessage interface {
	WebhookMessage
}

type WebhookCallbackQuery interface {
	GetID() string
	GetInlineMessageID() string // Telegram only?
	GetFrom() WebhookSender
	GetMessage() WebhookMessage
	GetData() string
	Chat() WebhookChat
}

type WebhookChat interface {
	GetID() string
	GetType() string
	IsGroupChat() bool
}

type WebhookChosenInlineResult interface {
	GetResultID() string
	GetInlineMessageID() string // Telegram only?
	GetFrom() WebhookSender
	GetQuery() string
}

type WebhookContactMessage interface {
	PhoneNumber() string
	FirstName() string
	LastName() string
	UserID() interface{}
}

type WebhookContext interface {
	GA() GaContext
	//dal.TransactionCoordinator
	Environment() strongo.Environment
	BotInputProvider
	BotPlatform() BotPlatform

	Request() *http.Request

	// Context return context
	Context() context.Context

	// SetContext sets context
	SetContext(c context.Context)

	ExecutionContext() strongo.ExecutionContext
	BotAppContext() BotAppContext
	BotContext() BotContext

	MustBotChatID() string

	GetBotCode() string
	GetBotToken() string
	GetBotSettings() BotSettings

	ChatData() botsfwmodels.ChatData // Formerly ChatEntity()

	// IsInGroup indicates if message was received in a group chat
	IsInGroup() bool

	// CommandText TODO: needs to be documented
	CommandText(title, icon string) string

	// SetLocale sets locale for current session
	SetLocale(code5 string) error

	NewMessage(text string) MessageFromBot
	NewMessageByCode(messageCode string, a ...interface{}) MessageFromBot
	NewEditMessage(text string, format MessageFormat) (MessageFromBot, error)

	UpdateLastProcessed(chatEntity botsfwmodels.ChatData) error

	AppUserID() string

	// AppUserInt64ID TODO: Deprecate: use AppUserID() instead
	AppUserInt64ID() int64

	AppUserData() (botsfwmodels.AppUserData, error)

	BotState

	Store() botsfwdal.DataAccess

	// RecordsFieldsSetter returns a helper that sets fields of bot related records
	RecordsFieldsSetter() BotRecordsFieldsSetter

	WebhookInput // TODO: Should be removed!!!
	i18n.SingleLocaleTranslator

	Responder() WebhookResponder
}

type WebhookContextBase struct {

	// BotUserID is a user ID in bot's platform.
	// Telegram has it is an integer, but we keep it as a string for consistency & simplicity.
	BotUserID string
	// contains filtered or unexported fields
}

type WebhookConversationStarted interface {
	ConversationStartedMessage() interface{}
}

type WebhookDelivery interface {
	Payload() string
}

type WebhookDriver interface {
	RegisterWebhookHandlers(httpRouter HttpRouter, pathPrefix string, webhookHandlers ...WebhookHandler)
	HandleWebhook(w http.ResponseWriter, r *http.Request, webhookHandler WebhookHandler)
}

type WebhookEntry interface {
	GetID() interface{}
	GetTime() time.Time
}

type WebhookHandler interface {
	RegisterHttpHandlers(driver WebhookDriver, botHost BotHost, router HttpRouter, pathPrefix string)
	HandleWebhookRequest(w http.ResponseWriter, r *http.Request)
	GetBotContextAndInputs(c context.Context, r *http.Request) (botContext *BotContext, entriesWithInputs []EntryInputs, err error)
	CreateBotCoreStores(appContext BotAppContext, r *http.Request) botsfwdal.DataAccess
	CreateWebhookContext(appContext BotAppContext, r *http.Request, botContext BotContext, webhookInput WebhookInput, botCoreStores botsfwdal.DataAccess, gaMeasurement GaQueuer) WebhookContext //TODO: Can we get rid of http.Request? Needed for botHost.GetHTTPClient()
	GetResponder(w http.ResponseWriter, whc WebhookContext) WebhookResponder
	HandleUnmatched(whc WebhookContext) (m MessageFromBot)
}

type WebhookHandlerBase struct {
	WebhookDriver
	BotHost
	BotPlatform
	RecordsMaker        botsfwmodels.BotRecordsMaker
	RecordsFieldsSetter BotRecordsFieldsSetter
	TranslatorProvider  TranslatorProvider
	DataAccess          botsfwdal.DataAccess
}

type WebhookInlineQuery interface {
	GetID() interface{}
	GetInlineQueryID() string
	GetFrom() WebhookSender
	GetQuery() string
	GetOffset() string
}

type WebhookInlineQueryContext interface {
}

type WebhookInput interface {
	GetSender() WebhookSender
	GetRecipient() WebhookRecipient
	GetTime() time.Time
	InputType() WebhookInputType
	BotChatID() (string, error)
	Chat() WebhookChat
	LogRequest()
}

type WebhookInputType int

type WebhookLeftChatMembersMessage interface {
	BotChatID() (string, error)
	LeftChatMembers() []WebhookActor
}

type WebhookMessage interface {
	IntID() int64
	StringID() string
	Chat() WebhookChat
}

type WebhookNewChatMembersMessage interface {
	BotChatID() (string, error)
	NewChatMembers() []WebhookActor
}

type WebhookNewContext struct {
	BotContext
	WebhookInput
}

type WebhookPhotoMessage interface {
	WebhookMessage
}

type WebhookPostback interface {
	PostbackMessage() interface{}
	Payload() string
}

type WebhookRecipient interface {
	WebhookActor
}

type WebhookReferralMessage interface {
	Type() string
	Source() string
	RefData() string
}

type WebhookResponder interface {
	SendMessage(c context.Context, m MessageFromBot, channel BotAPISendMessageChannel) (OnMessageSentResponse, error)
}

type WebhookSender interface {
	GetAvatar() string // Extension to support avatar (Viber)
	WebhookActor
}

type WebhookStickerMessage interface {
	WebhookMessage
}

type WebhookSubscribed interface {
	SubscribedMessage() interface{}
}

type WebhookTextMessage interface {
	WebhookMessage
	Text() string
	IsEdited() bool
}

type WebhookUnsubscribed interface {
	UnsubscribedMessage() interface{}
}

type WebhookUser interface {
	WebhookSender

	// GetCountry is an extension to support language & country (Viber)
	GetCountry() string
}

type WebhookVoiceMessage interface {
	WebhookMessage
}

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