0
0
Fork 0
mirror of https://github.com/crazy-max/diun.git synced 2025-01-12 11:38:11 +00:00
crazy-max_diun/vendor/github.com/PaulSonOfLars/gotgbot/v2/bot.go
dependabot[bot] 64f77319b2
chore(deps): bump github.com/PaulSonOfLars/gotgbot/v2
Bumps [github.com/PaulSonOfLars/gotgbot/v2](https://github.com/PaulSonOfLars/gotgbot) from 2.0.0-rc.27 to 2.0.0-rc.30.
- [Release notes](https://github.com/PaulSonOfLars/gotgbot/releases)
- [Commits](https://github.com/PaulSonOfLars/gotgbot/compare/v2.0.0-rc.27...v2.0.0-rc.30)

---
updated-dependencies:
- dependency-name: github.com/PaulSonOfLars/gotgbot/v2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-12-14 23:37:14 +00:00

127 lines
3.8 KiB
Go

package gotgbot
import (
"context"
"encoding/json"
"errors"
"fmt"
"net/http"
"strconv"
"strings"
"time"
)
//go:generate go run ./scripts/generate
var (
ErrNilBotClient = errors.New("nil BotClient")
ErrInvalidTokenFormat = errors.New("invalid token format")
)
// Bot is the default Bot struct used to send and receive messages to the telegram API.
type Bot struct {
// Token stores the bot's secret token obtained from t.me/BotFather, and used to interact with telegram's API.
Token string
// The bot's User info, as returned by Bot.GetMe. Populated when created through the NewBot method.
User
// The bot client to use to make requests
BotClient
}
// BotOpts declares all optional parameters for the NewBot function.
type BotOpts struct {
// BotClient allows for passing in custom configurations of BotClient, such as handling extra errors or providing
// metrics.
BotClient BotClient
// DisableTokenCheck can be used to disable the token validity check.
// Useful when running in time-constrained environments where the startup time should be minimised, and where the
// token can be assumed to be valid (eg lambdas).
// Warning: Disabling the token check will mean that the Bot.User struct will no longer be populated.
DisableTokenCheck bool
// Request opts to use for checking token validity with Bot.GetMe. Can be slow - a high timeout (eg 10s) is
// recommended.
RequestOpts *RequestOpts
}
// NewBot returns a new Bot struct populated with the necessary defaults.
func NewBot(token string, opts *BotOpts) (*Bot, error) {
botClient := BotClient(&BaseBotClient{
Client: http.Client{},
UseTestEnvironment: false,
DefaultRequestOpts: nil,
})
// Large timeout on the initial GetMe request as this can sometimes be slow.
getMeReqOpts := &RequestOpts{
Timeout: 10 * time.Second,
}
checkTokenValidity := true
if opts != nil {
if opts.BotClient != nil {
botClient = opts.BotClient
}
if opts.RequestOpts != nil {
getMeReqOpts = opts.RequestOpts
}
checkTokenValidity = !opts.DisableTokenCheck
}
b := Bot{
Token: token,
BotClient: botClient,
}
if checkTokenValidity {
// Get bot info. This serves two purposes:
// 1. Check token is valid.
// 2. Populate the bot struct "User" field.
botUser, err := b.GetMe(&GetMeOpts{RequestOpts: getMeReqOpts})
if err != nil {
return nil, fmt.Errorf("failed to check bot token: %w", err)
}
b.User = *botUser
} else {
// If token checks are disabled, we populate the bot's ID from the token.
split := strings.Split(token, ":")
if len(split) != 2 {
return nil, fmt.Errorf("%w: expected '123:abcd', got %s", ErrInvalidTokenFormat, token)
}
id, err := strconv.ParseInt(split[0], 10, 64)
if err != nil {
return nil, fmt.Errorf("failed to parse bot ID from token: %w", err)
}
b.User = User{
Id: id,
IsBot: true,
// We mark these fields as missing so we can know why they're not available
FirstName: "<missing>",
Username: "<missing>",
}
}
return &b, nil
}
// UseMiddleware allows you to wrap the existing bot client to enhance functionality
//
// Deprecated: Instead of using middlewares, consider implementing the BotClient interface.
func (bot *Bot) UseMiddleware(mw func(client BotClient) BotClient) *Bot {
bot.BotClient = mw(bot.BotClient)
return bot
}
func (bot *Bot) Request(method string, params map[string]string, data map[string]FileReader, opts *RequestOpts) (json.RawMessage, error) {
return bot.RequestWithContext(context.Background(), method, params, data, opts)
}
func (bot *Bot) RequestWithContext(ctx context.Context, method string, params map[string]string, data map[string]FileReader, opts *RequestOpts) (json.RawMessage, error) {
if bot.BotClient == nil {
return nil, ErrNilBotClient
}
return bot.BotClient.RequestWithContext(ctx, bot.Token, method, params, data, opts)
}