Compare commits
13 Commits
v1.0.0-bet
...
v1.0.0-bet
| Author | SHA1 | Date | |
|---|---|---|---|
|
d6e2daec04
|
|||
|
3b6bb82e04
|
|||
|
0574222608
|
|||
|
b1b0cbdfbd
|
|||
|
7e12e0a9f9
|
|||
|
8b9a974da9
|
|||
|
4dc172a3b5
|
|||
|
f42d47af53
|
|||
|
9895edf966
|
|||
|
6cf3355a36
|
|||
|
fa7a296a66
|
|||
| 7101aba548 | |||
| 2de46a27c8 |
15
Makefile
Normal file
15
Makefile
Normal file
@@ -0,0 +1,15 @@
|
||||
# Проверка наличия golangci-lint
|
||||
GO_LINT := $(shell command -v golangci-lint 2>/dev/null)
|
||||
|
||||
# Цель: запуск всех проверок кода
|
||||
check:
|
||||
@echo "🔍 Running code checks..."
|
||||
@go mod tidy -v
|
||||
@go vet ./...
|
||||
@if [ -n "$(GO_LINT)" ]; then \
|
||||
echo "✅ golangci-lint found, running..." && \
|
||||
golangci-lint run --timeout=5m --verbose; \
|
||||
else \
|
||||
echo "⚠️ golangci-lint not installed. Install with: curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.57.2"; \
|
||||
fi
|
||||
@go test -race -v ./... 2>/dev/null || echo "⚠️ Tests skipped or failed (run manually with 'go test -race ./...')"
|
||||
203
README.md
203
README.md
@@ -1,3 +1,204 @@
|
||||
# Laniakea
|
||||
|
||||
A lightweight, easy to use and performance Telegram API wrapper for bot development.
|
||||
[](https://go.dev/)
|
||||
[](LICENSE)
|
||||

|
||||
|
||||
A lightweight, easy-to-use, and performant Telegram Bot API wrapper for Go. It simplifies bot development with a clean plugin system, middleware support, automatic command generation, and built-in rate limiting.
|
||||
|
||||
[На русском](README_RU.md)
|
||||
|
||||
---
|
||||
|
||||
## ✨ Features
|
||||
* **Simple & Intuitive API:** Designed for ease of use, based on practical examples.
|
||||
* **Plugin System:** Organize your bot's functionality into independent, reusable plugins.
|
||||
* **Command Handling:** Easily register commands and extract arguments.
|
||||
* **Middleware Support:** Run code before or after commands (e.g., logging, access control).
|
||||
* **Automatic Command Generation:** Generate help and command lists automatically.
|
||||
* **Built-in Rate Limiting:** Protect your bot from hitting Telegram API limits (supports `retry_after` handling).
|
||||
* **Context-Aware:** Pass custom database or state contexts to your handlers.
|
||||
* **Fluent Interface:** Chain methods for clean configuration (e.g., `bot.ErrorTemplate(...).AddPlugins(...)`).
|
||||
|
||||
---
|
||||
|
||||
## 📦 Installation
|
||||
|
||||
```bash
|
||||
go get git.nix13.pw/scuroneko/laniakea
|
||||
```
|
||||
|
||||
## 🚀 Quick Start (with step-by-step explanation)
|
||||
|
||||
Here is a minimal echo/ping bot example with detailed comments.
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"log"
|
||||
|
||||
"git.nix13.pw/scuroneko/laniakea" // Import the Laniakea library
|
||||
)
|
||||
|
||||
// echo is a command handler function.
|
||||
// It receives two parameters:
|
||||
// - ctx: the message context (contains info about the message, sender, chat, etc.)
|
||||
// - db: your custom database context (here we use NoDB, a placeholder for no database)
|
||||
func echo(ctx *laniakea.MsgContext, db *laniakea.NoDB) {
|
||||
// Answer the user with the text they sent, without any command prefix.
|
||||
// ctx.Text contains the user's message with the command part stripped off.
|
||||
ctx.Answer(ctx.Text) // User input WITHOUT command
|
||||
}
|
||||
|
||||
func main() {
|
||||
// 1. Create bot options. Replace "TOKEN" with your actual bot token from @BotFather.
|
||||
opts := &laniakea.BotOpts{Token: "TOKEN"}
|
||||
|
||||
// 2. Initialize a new bot instance.
|
||||
// We use laniakea.NoDB as the database context type (no database needed for this example).
|
||||
bot := laniakea.NewBot[laniakea.NoDB](opts)
|
||||
// Ensure bot resources are cleaned up on exit.
|
||||
defer bot.Close()
|
||||
|
||||
// 3. Create a new plugin named "ping".
|
||||
// Plugins help group related commands and middlewares.
|
||||
p := laniakea.NewPlugin[laniakea.NoDB]("ping")
|
||||
|
||||
// 4. Add a command to the plugin.
|
||||
// p.NewCommand(echo, "echo") creates a command that triggers the 'echo' function on the "/echo" command.
|
||||
p.AddCommand(p.NewCommand(echo, "echo"))
|
||||
|
||||
// 5. Add another command using an anonymous function (closure).
|
||||
// This command simply replies "Pong" when the user sends "/ping".
|
||||
p.AddCommand(p.NewCommand(func(ctx *laniakea.MsgContext, db *laniakea.NoDB) {
|
||||
ctx.Answer("Pong")
|
||||
}, "ping"))
|
||||
|
||||
// 6. Configure the bot with a custom error template and add the plugin.
|
||||
// ErrorTemplate sets a format string for errors (where %s will be replaced by the actual error).
|
||||
// AddPlugins(p) registers our "ping" plugin with the bot.
|
||||
bot = bot.ErrorTemplate("Error\n\n%s").AddPlugins(p)
|
||||
|
||||
// 7. Automatically generate commands like /start, /help, and a list of all registered commands.
|
||||
// This is optional but very useful for most bots.
|
||||
if err := bot.AutoGenerateCommands(); err != nil {
|
||||
log.Println(err)
|
||||
}
|
||||
|
||||
// 8. Start the bot, listening for updates (long polling).
|
||||
bot.Run()
|
||||
}
|
||||
```
|
||||
|
||||
### How It Works
|
||||
1. `BotOpts`: Holds configuration like the API token.
|
||||
2. `NewBot[T]`: Creates a bot instance. The type parameter T allows you to pass a custom database context (e.g., *sql.DB) that will be available in all handlers. Use laniakea.NoDB if you don't need it.
|
||||
3. `NewPlugin`: Creates a logical group for commands and middlewares.
|
||||
4. `AddCommand`: Registers a command. The first argument is the handler function (func(*MsgContext, T)), the second is the command name (without the slash).
|
||||
5. **Handler Functions**: Receive *MsgContext (message details, methods like Answer) and your custom database context T.
|
||||
6. `ErrorTemplate`: Sets a template for error messages. The %s placeholder is replaced by the actual error.
|
||||
7. `AutoGenerateCommands`: Adds built-in commands (/start, /help) and a command that lists all available commands.
|
||||
8. `Run()`: Starts the bot's update polling loop.
|
||||
|
||||
## 📖 Core Concepts
|
||||
### Plugins
|
||||
|
||||
Plugins are the main way to organize code. A plugin can have multiple commands and middlewares.
|
||||
```go
|
||||
plugin := laniakea.NewPlugin[MyDB]("admin")
|
||||
plugin.AddCommand(plugin.NewCommand(banUser, "ban"))
|
||||
bot.AddPlugins(plugin)
|
||||
```
|
||||
|
||||
### Commands
|
||||
|
||||
A command is a function that handles a specific bot command (e.g., /start).
|
||||
```go
|
||||
func myHandler(ctx *laniakea.MsgContext, db *MyDB) {
|
||||
// Access command arguments via ctx.Args ([]string)
|
||||
// Reply to the user: ctx.Answer("some text")
|
||||
}
|
||||
```
|
||||
|
||||
### MsgContext
|
||||
|
||||
Provides access to the incoming message and useful reply methods:
|
||||
|
||||
- `Answer(text string)`: Sends a plain text message, automatically escaping MarkdownV2.
|
||||
- `AnswerMarkdown(text string)`: Sends a message formatted with MarkdownV2 (you handle escaping).
|
||||
- `AnswerText(text string)`: Sends a message with no parse_mode.
|
||||
- `SendChatAction(action string)`: Sends a "typing", "uploading photo", etc., action.
|
||||
- Fields: `Text`, `Args`, `From`, `Chat`, `Msg`, etc.
|
||||
|
||||
### Database Context
|
||||
|
||||
The `T` in `NewBot[T]` is a powerful feature. You can pass any type (like a database connection pool) and it will be available in every command and middleware handler.
|
||||
|
||||
```go
|
||||
type MyDB struct { /* ... */ }
|
||||
db := &MyDB{...}
|
||||
bot := laniakea.NewBot[*MyDB](opts, db) // Pass db instance
|
||||
```
|
||||
|
||||
## 🧩 Middleware
|
||||
Middleware are functions that run before a command handler. They are perfect for cross-cutting concerns like logging, access control, rate limiting, or modifying the context.
|
||||
|
||||
### Signature
|
||||
A middleware function has the same signature as a command handler, but it must return a bool:
|
||||
|
||||
```go
|
||||
func(ctx *MsgContext, db T) bool
|
||||
```
|
||||
|
||||
- If it returns true, the next middleware (or the command) will be executed.
|
||||
- If it returns false, the execution chain stops immediately (the command will not run).
|
||||
|
||||
### Adding Middleware
|
||||
Use the Use method of a plugin to add one or more middleware functions. They are executed in the order they are added.
|
||||
|
||||
```go
|
||||
plugin := laniakea.NewPlugin[MyDB]("admin")
|
||||
plugin.Use(loggingMiddleware, adminOnlyMiddleware)
|
||||
plugin.AddCommand(plugin.NewCommand(banUser, "ban"))
|
||||
```
|
||||
|
||||
### Example Middlewares
|
||||
|
||||
1. Logging Middleware – logs every command execution.
|
||||
```go
|
||||
func loggingMiddleware(ctx *laniakea.MsgContext, db *MyDB) bool {
|
||||
log.Printf("User %d executed command: %s", ctx.FromID, ctx.Msg.Text)
|
||||
return true // continue to next middleware/command
|
||||
}
|
||||
```
|
||||
|
||||
2. Admin-Only Middleware – restricts access to users with a specific role.
|
||||
```go
|
||||
func adminOnlyMiddleware(ctx *laniakea.MsgContext, db *MyDB) bool {
|
||||
if !db.IsAdmin(ctx.FromID) { // assume db has IsAdmin method
|
||||
ctx.Answer("⛔ Access denied. Admins only.")
|
||||
return false // stop execution
|
||||
}
|
||||
return true
|
||||
}
|
||||
```
|
||||
|
||||
### Important Notes
|
||||
- Middleware can modify the MsgContext (e.g., add custom fields) before the command runs.
|
||||
- If you need to run code after a command, you can call it from within the command itself or use a defer statement inside the middleware that wraps the next call (more advanced).
|
||||
|
||||
## ⚙️ Advanced Configuration
|
||||
- **Inline Keyboards**: Build keyboards using laniakea.NewKeyboard() and AddRow().
|
||||
- **Rate Limiting**: Pass a configured utils.RateLimiter via BotOpts to handle Telegram's rate limits gracefully.
|
||||
- **Custom HTTP Client**: Provide your own http.Client in BotOpts for fine-tuned control.
|
||||
|
||||
## 📝 License
|
||||
|
||||
This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
## 📚 Learn More
|
||||
[GoDoc](https://pkg.go.dev/git.nix13.pw/scuroneko/laniakea)
|
||||
|
||||
[Telegram Bot API](https://core.telegram.org/bots/api)
|
||||
|
||||
✅ Built with ❤️ by scuroneko
|
||||
|
||||
202
README_RU.md
Normal file
202
README_RU.md
Normal file
@@ -0,0 +1,202 @@
|
||||
# Laniakea
|
||||
|
||||
[](https://go.dev/)
|
||||
[](LICENSE)
|
||||

|
||||
|
||||
Легковесная, простая в использовании и производительная обёртка для Telegram Bot API на Go. Она упрощает разработку ботов благодаря чистой системе плагинов, поддержке中间件, автоматической генерации команд и встроенному ограничителю скорости запросов.
|
||||
|
||||
[English](README.md)
|
||||
|
||||
---
|
||||
|
||||
## ✨ Возможности
|
||||
|
||||
* **Простой и интуитивный API:** Разработан для лёгкости использования, основан на практических примерах.
|
||||
* **Система плагинов:** Организуйте функциональность бота в независимые, переиспользуемые плагины.
|
||||
* **Обработка команд:** Легко регистрируйте команды и извлекайте аргументы.
|
||||
* **Поддержка промежуточных слоёв (Middleware):** Выполняйте код до или после команд (например, логирование, проверка доступа).
|
||||
* **Автоматическая генерация команд:** Генерируйте справку и списки команд автоматически.
|
||||
* **Встроенный ограничитель запросов (Rate Limiter):** Защитите бота от превышения лимитов Telegram API (с обработкой `retry_after`).
|
||||
* **Контекст данных:** Передавайте свой контекст базы данных или состояния в обработчики.
|
||||
* **Текучий интерфейс (Fluent Interface):** Стройте цепочки методов для чистой конфигурации (например, `bot.ErrorTemplate(...).AddPlugins(...)`).
|
||||
|
||||
---
|
||||
|
||||
## 📦 Установка
|
||||
|
||||
```bash
|
||||
go get git.nix13.pw/scuroneko/laniakea
|
||||
```
|
||||
|
||||
## 🚀 Быстрый старт (с пошаговыми комментариями)
|
||||
Вот минимальный пример бота "echo/ping" с подробными комментариями.
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"log"
|
||||
|
||||
"git.nix13.pw/scuroneko/laniakea" // Импортируем библиотеку Laniakea
|
||||
)
|
||||
|
||||
// echo — это функция-обработчик команды.
|
||||
// Она получает два параметра:
|
||||
// - ctx: контекст сообщения (содержит информацию о сообщении, отправителе, чате и т.д.)
|
||||
// - db: ваш пользовательский контекст базы данных (здесь мы используем NoDB — заглушку)
|
||||
func echo(ctx *laniakea.MsgContext, db *laniakea.NoDB) {
|
||||
// Отвечаем пользователю текстом, который он прислал, без префикса команды.
|
||||
// ctx.Text содержит сообщение пользователя, из которого удалена часть с командой.
|
||||
ctx.Answer(ctx.Text) // Ввод пользователя БЕЗ команды
|
||||
}
|
||||
|
||||
func main() {
|
||||
// 1. Создаём опции бота. Замените "TOKEN" на реальный токен от @BotFather.
|
||||
opts := &laniakea.BotOpts{Token: "TOKEN"}
|
||||
|
||||
// 2. Инициализируем новый экземпляр бота.
|
||||
// Используем laniakea.NoDB как тип контекста базы данных (база не нужна для примера).
|
||||
bot := laniakea.NewBot[laniakea.NoDB](opts)
|
||||
// Гарантируем освобождение ресурсов бота при выходе.
|
||||
defer bot.Close()
|
||||
|
||||
// 3. Создаём новый плагин с именем "ping".
|
||||
// Плагины помогают группировать связанные команды и промежуточные обработчики.
|
||||
p := laniakea.NewPlugin[laniakea.NoDB]("ping")
|
||||
|
||||
// 4. Добавляем команду в плагин.
|
||||
// p.NewCommand(echo, "echo") создаёт команду, которая вызывает функцию 'echo' по команде "/echo".
|
||||
p.AddCommand(p.NewCommand(echo, "echo"))
|
||||
|
||||
// 5. Добавляем ещё одну команду, используя анонимную функцию (замыкание).
|
||||
// Эта команда просто отвечает "Pong", когда пользователь отправляет "/ping".
|
||||
p.AddCommand(p.NewCommand(func(ctx *laniakea.MsgContext, db *laniakea.NoDB) {
|
||||
ctx.Answer("Pong")
|
||||
}, "ping"))
|
||||
|
||||
// 6. Настраиваем бота: задаём шаблон ошибки и добавляем плагин.
|
||||
// ErrorTemplate устанавливает формат для сообщений об ошибках (где %s будет заменён на текст ошибки).
|
||||
// AddPlugins(p) регистрирует наш плагин "ping" в боте.
|
||||
bot = bot.ErrorTemplate("Ошибка\n\n%s").AddPlugins(p)
|
||||
|
||||
// 7. Автоматически генерируем команды, такие как /start, /help и список всех зарегистрированных команд.
|
||||
// Это необязательно, но очень полезно для большинства ботов.
|
||||
if err := bot.AutoGenerateCommands(); err != nil {
|
||||
log.Println(err)
|
||||
}
|
||||
|
||||
// 8. Запускаем бота, начиная прослушивание обновлений (long polling).
|
||||
bot.Run()
|
||||
}
|
||||
```
|
||||
|
||||
### Как это работает
|
||||
1. `BotOpts`: Содержит конфигурацию, например, токен API.
|
||||
2. `NewBot[T]`: Создаёт экземпляр бота. Параметр типа T позволяет передать пользовательский контекст базы данных (например, *sql.DB), который будет доступен во всех обработчиках. Используйте laniakea.NoDB, если он не нужен.
|
||||
3. `NewPlugin`: Создаёт логическую группу для команд и Middleware.
|
||||
4. `AddCommand`: Регистрирует команду. Первый аргумент — функция-обработчик (func(*MsgContext, T)), второй — имя команды (без слеша).
|
||||
5. **Функции-обработчики**: Получают *MsgContext (детали сообщения, методы типа Answer) и ваш контекст базы данных T.
|
||||
6. `ErrorTemplate`: Устанавливает шаблон для сообщений об ошибках. Плейсхолдер %s заменяется на текст ошибки.
|
||||
7. `AutoGenerateCommands`: Добавляет встроенные команды (/start, /help) и команду, показывающую список всех доступных команд.
|
||||
8. `Run()`: Запускает цикл опроса обновлений бота.
|
||||
|
||||
## 📖 Основные концепции
|
||||
### Плагины (Plugins)
|
||||
Плагины — основной способ организации кода. Плагин может содержать несколько команд и Middleware.
|
||||
|
||||
```go
|
||||
plugin := laniakea.NewPlugin[MyDB]("admin")
|
||||
plugin.AddCommand(plugin.NewCommand(banUser, "ban"))
|
||||
bot.AddPlugins(plugin)
|
||||
```
|
||||
|
||||
### Команды (Commands)
|
||||
Команда — это функция, которая обрабатывает конкретную команду бота (например, /start).
|
||||
|
||||
```go
|
||||
func myHandler(ctx *laniakea.MsgContext, db *MyDB) {
|
||||
// Доступ к аргументам команды через ctx.Args ([]string)
|
||||
// Ответ пользователю: ctx.Answer("какой-то текст")
|
||||
}
|
||||
```
|
||||
|
||||
### Контекст сообщения (MsgContext)
|
||||
Предоставляет доступ к входящему сообщению и полезные методы для ответа:
|
||||
|
||||
- `Answer(text string)`: Отправляет обычный текст, автоматически экранируя MarkdownV2.
|
||||
- `AnswerMarkdown(text string)`: Отправляет сообщение, отформатированное MarkdownV2 (экранирование на вашей стороне).
|
||||
- `AnswerText(text string)`: Отправляет сообщение без parse_mode.
|
||||
- `SendChatAction(action string)`: Отправляет действие "печатает", "загружает фото" и т.д.
|
||||
- Поля: `Text`, `Args`, `From`, `Chat`, `Msg` и другие.
|
||||
|
||||
### Контекст базы данных (Database Context)
|
||||
Параметр типа `T` в `NewBot[T]` — мощная функция. Вы можете передать любой тип (например, пул соединений с БД), и он будет доступен в каждом обработчике команды и中间件.
|
||||
|
||||
```go
|
||||
type MyDB struct { /* ... */ }
|
||||
db := &MyDB{...}
|
||||
bot := laniakea.NewBot[*MyDB](opts, db) // Передаём экземпляр db
|
||||
```
|
||||
|
||||
## 🧩 Промежуточные слои (Middleware)
|
||||
Middleware — это функции, которые выполняются перед обработчиком команды. Они идеально подходят для сквозных задач, таких как логирование, контроль доступа, ограничение скорости запросов или модификация контекста.
|
||||
|
||||
### Сигнатура
|
||||
Функция middleware имеет ту же сигнатуру, что и обработчик команды, но должна возвращать bool:
|
||||
|
||||
```go
|
||||
func(ctx *MsgContext, db T) bool
|
||||
```
|
||||
|
||||
- Если возвращается true, выполняется следующий middleware (или сама команда).
|
||||
- Если возвращается false, цепочка выполнения немедленно прерывается (команда не запускается).
|
||||
|
||||
### Добавление middleware
|
||||
Используйте метод Use плагина для добавления одной или нескольких функций middleware. Они выполняются в порядке добавления.
|
||||
|
||||
```go
|
||||
plugin := laniakea.NewPlugin[MyDB]("admin")
|
||||
plugin.Use(loggingMiddleware, adminOnlyMiddleware)
|
||||
plugin.AddCommand(plugin.NewCommand(banUser, "ban"))
|
||||
```
|
||||
|
||||
### Примеры middleware
|
||||
|
||||
1. Логирующий middleware – логирует каждое выполнение команды.
|
||||
```go
|
||||
func loggingMiddleware(ctx *laniakea.MsgContext, db *MyDB) bool {
|
||||
log.Printf("Пользователь %d выполнил команду: %s", ctx.FromID, ctx.Msg.Text)
|
||||
return true // продолжаем к следующему middleware/команде
|
||||
}
|
||||
```
|
||||
|
||||
2. Middleware только для администраторов – ограничивает доступ пользователям с определённой ролью.
|
||||
```go
|
||||
func adminOnlyMiddleware(ctx *laniakea.MsgContext, db *MyDB) bool {
|
||||
if !db.IsAdmin(ctx.FromID) { // предполагается, что db имеет метод IsAdmin
|
||||
ctx.Answer("⛔ Доступ запрещён. Только для администраторов.")
|
||||
return false // останавливаем выполнение
|
||||
}
|
||||
return true
|
||||
}
|
||||
```
|
||||
|
||||
### Важные замечания
|
||||
- Middleware может изменять MsgContext (например, добавлять пользовательские поля) перед запуском команды.
|
||||
- Если нужно выполнить код после команды, это можно сделать внутри самой команды или использовать отложенный вызов (defer) в middleware, который оборачивает следующий вызов (более продвинутый подход).
|
||||
|
||||
## ⚙️ Расширенная настройка
|
||||
**Инлайн-клавиатуры**: Создавайте клавиатуры с помощью laniakea.NewKeyboard() и AddRow().
|
||||
**Ограничение запросов**: Передайте настроенный utils.RateLimiter через BotOpts для корректной обработки лимитов Telegram.
|
||||
**Пользовательский HTTP-клиент**: Предоставьте свой http.Client в BotOpts для точного контроля.
|
||||
|
||||
## 📝 Лицензия
|
||||
Этот проект лицензирован под GNU General Public License v3.0 - подробности см. в файле [LICENSE](LICENSE).
|
||||
|
||||
## 📚 Дополнительная информация
|
||||
[GoDoc Laniakea](https://pkg.go.dev/git.nix13.pw/scuroneko/laniakea)
|
||||
|
||||
[Telegram Bot API](https://core.telegram.org/bots/api)
|
||||
|
||||
✅ Создано с ❤️ scuroneko
|
||||
392
bot.go
392
bot.go
@@ -1,3 +1,33 @@
|
||||
// Package laniakea provides a modular, extensible framework for building scalable
|
||||
// Telegram bots with support for plugins, middleware, localization, draft messages,
|
||||
// rate limiting, structured logging, and dependency injection.
|
||||
//
|
||||
// The framework is designed around a fluent API for configuration and separation of concerns:
|
||||
//
|
||||
// - Plugins: Handle specific commands or events (e.g., /start, /help)
|
||||
// - Middleware: Intercept and modify updates before plugins run (auth, logging, validation)
|
||||
// - Runners: Background goroutines for cleanup, cron jobs, or monitoring
|
||||
// - DraftProvider: Safely build and resume multi-step messages
|
||||
// - L10n: Multi-language support via key-based translation
|
||||
// - RateLimiter: Enforces Telegram API limits to avoid bans
|
||||
// - Structured Logging: JSON stdout + optional file output with request-level tracing
|
||||
// - Dependency Injection: Inject custom database contexts (e.g., *gorm.DB, *sql.DB)
|
||||
//
|
||||
// Example usage:
|
||||
//
|
||||
// bot := laniakea.NewBot[mydb.DBContext](laniakea.LoadOptsFromEnv()).
|
||||
// DatabaseContext(&myDB).
|
||||
// AddUpdateType(tgapi.UpdateTypeMessage).
|
||||
// AddPrefixes("/", "!").
|
||||
// AddPlugins(&startPlugin, &helpPlugin).
|
||||
// AddMiddleware(&authMiddleware, &logMiddleware).
|
||||
// AddRunner(&cleanupRunner).
|
||||
// AddL10n(l10n.New())
|
||||
//
|
||||
// go bot.Run()
|
||||
//
|
||||
// All methods are thread-safe except direct field access. Use provided accessors
|
||||
// (e.g., GetDBContext, SetUpdateOffset) for safe concurrent access.
|
||||
package laniakea
|
||||
|
||||
import (
|
||||
@@ -8,38 +38,90 @@ import (
|
||||
"strconv"
|
||||
"strings"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"git.nix13.pw/scuroneko/extypes"
|
||||
"git.nix13.pw/scuroneko/laniakea/tgapi"
|
||||
"git.nix13.pw/scuroneko/laniakea/utils"
|
||||
"git.nix13.pw/scuroneko/slog"
|
||||
"github.com/alitto/pond/v2"
|
||||
"golang.org/x/time/rate"
|
||||
)
|
||||
|
||||
// BotOpts holds configuration options for initializing a Bot.
|
||||
//
|
||||
// Values are loaded from environment variables via LoadOptsFromEnv().
|
||||
// Use NewOpts() to create a zero-value struct and set fields manually.
|
||||
type BotOpts struct {
|
||||
// Token is the Telegram bot token (required).
|
||||
Token string
|
||||
|
||||
// UpdateTypes is a semicolon-separated list of update types to listen for.
|
||||
// Example: "message;edited_message;callback_query"
|
||||
// Defaults to empty (Telegram will return all types).
|
||||
UpdateTypes []string
|
||||
|
||||
// Debug enables debug-level logging.
|
||||
Debug bool
|
||||
|
||||
// ErrorTemplate is the format string used to wrap error messages sent to users.
|
||||
// Use "%s" to insert the actual error. Example: "❌ Error: %s"
|
||||
ErrorTemplate string
|
||||
|
||||
// Prefixes is a list of command prefixes (e.g., ["/", "!"]).
|
||||
// Defaults to ["/"] if not set via environment.
|
||||
Prefixes []string
|
||||
|
||||
// LoggerBasePath is the directory where log files are written.
|
||||
// Defaults to "./".
|
||||
LoggerBasePath string
|
||||
|
||||
// UseRequestLogger enables detailed logging of all Telegram API requests.
|
||||
UseRequestLogger bool
|
||||
|
||||
// WriteToFile enables writing logs to files (main.log and requests.log).
|
||||
WriteToFile bool
|
||||
|
||||
// UseTestServer uses Telegram's test server (https://api.test.telegram.org).
|
||||
UseTestServer bool
|
||||
|
||||
// APIUrl overrides the default Telegram API endpoint (useful for proxies or self-hosted).
|
||||
APIUrl string
|
||||
|
||||
// RateLimit is the maximum number of API requests per second.
|
||||
// Telegram allows up to 30 req/s for most bots. Defaults to 30.
|
||||
RateLimit int
|
||||
|
||||
// DropRLOverflow drops incoming updates when rate limit is exceeded instead of queuing.
|
||||
// Use this to prioritize responsiveness over reliability.
|
||||
DropRLOverflow bool
|
||||
}
|
||||
|
||||
// NewOpts returns a new BotOpts with zero values.
|
||||
func NewOpts() *BotOpts { return new(BotOpts) }
|
||||
|
||||
// LoadOptsFromEnv loads BotOpts from environment variables.
|
||||
//
|
||||
// Environment variables:
|
||||
// - TG_TOKEN: Bot token (required)
|
||||
// - UPDATE_TYPES: semicolon-separated update types (e.g., "message;callback_query")
|
||||
// - DEBUG: "true" to enable debug logging
|
||||
// - ERROR_TEMPLATE: format string for error messages (e.g., "❌ %s")
|
||||
// - PREFIXES: semicolon-separated prefixes (e.g., "/;!bot")
|
||||
// - LOGGER_BASE_PATH: directory for log files (default: "./")
|
||||
// - USE_REQ_LOG: "true" to enable request logging
|
||||
// - WRITE_TO_FILE: "true" to write logs to files
|
||||
// - USE_TEST_SERVER: "true" to use Telegram test server
|
||||
// - API_URL: custom API endpoint
|
||||
// - RATE_LIMIT: max requests per second (default: 30)
|
||||
// - DROP_RL_OVERFLOW: "true" to drop updates on rate limit overflow
|
||||
//
|
||||
// Returns a populated BotOpts. If TG_TOKEN is missing, behavior is undefined.
|
||||
func LoadOptsFromEnv() *BotOpts {
|
||||
rateLimit := 30
|
||||
if rl := os.Getenv("RATE_LIMIT"); rl != "" {
|
||||
rateLimit, _ = strconv.Atoi(rl)
|
||||
if n, err := strconv.Atoi(rl); err == nil {
|
||||
rateLimit = n
|
||||
}
|
||||
}
|
||||
|
||||
return &BotOpts{
|
||||
@@ -50,6 +132,7 @@ func LoadOptsFromEnv() *BotOpts {
|
||||
ErrorTemplate: os.Getenv("ERROR_TEMPLATE"),
|
||||
Prefixes: LoadPrefixesFromEnv(),
|
||||
|
||||
LoggerBasePath: os.Getenv("LOGGER_BASE_PATH"),
|
||||
UseRequestLogger: os.Getenv("USE_REQ_LOG") == "true",
|
||||
WriteToFile: os.Getenv("WRITE_TO_FILE") == "true",
|
||||
|
||||
@@ -60,6 +143,9 @@ func LoadOptsFromEnv() *BotOpts {
|
||||
DropRLOverflow: os.Getenv("DROP_RL_OVERFLOW") == "true",
|
||||
}
|
||||
}
|
||||
|
||||
// LoadPrefixesFromEnv returns the PREFIXES environment variable split by semicolon.
|
||||
// Defaults to ["/"] if not set.
|
||||
func LoadPrefixesFromEnv() []string {
|
||||
prefixesS, exists := os.LookupEnv("PREFIXES")
|
||||
if !exists {
|
||||
@@ -68,47 +154,106 @@ func LoadPrefixesFromEnv() []string {
|
||||
return strings.Split(prefixesS, ";")
|
||||
}
|
||||
|
||||
// DbContext is an interface representing the application's database context.
|
||||
// It is injected into plugins and middleware via Bot.DatabaseContext().
|
||||
//
|
||||
// Example:
|
||||
//
|
||||
// type MyDB struct { ... }
|
||||
// bot := NewBot[MyDB](opts).DatabaseContext(&myDB)
|
||||
//
|
||||
// Use NoDB if no database is needed.
|
||||
type DbContext interface{}
|
||||
|
||||
// NoDB is a placeholder type for bots that do not use a database.
|
||||
// Use Bot[NoDB] to indicate no dependency injection is required.
|
||||
type NoDB struct{ DbContext }
|
||||
|
||||
// BotPayloadType defines the serialization format for callback data payloads.
|
||||
type BotPayloadType string
|
||||
|
||||
var (
|
||||
// BotPayloadBase64 encodes callback data as a Base64 string.
|
||||
BotPayloadBase64 BotPayloadType = "base64"
|
||||
// BotPayloadJson encodes callback data as a JSON string.
|
||||
BotPayloadJson BotPayloadType = "json"
|
||||
)
|
||||
|
||||
// Bot is the core Telegram bot instance.
|
||||
//
|
||||
// Manages:
|
||||
// - API communication via tgapi
|
||||
// - Update processing pipeline (middleware → plugins)
|
||||
// - Background runners
|
||||
// - Logging and rate limiting
|
||||
// - Localization and draft message support
|
||||
//
|
||||
// All methods are safe for concurrent use. Direct field access is not recommended.
|
||||
type Bot[T DbContext] struct {
|
||||
token string
|
||||
debug bool
|
||||
errorTemplate string
|
||||
username string
|
||||
payloadType BotPayloadType
|
||||
|
||||
logger *slog.Logger
|
||||
RequestLogger *slog.Logger
|
||||
extraLoggers extypes.Slice[*slog.Logger]
|
||||
logger *slog.Logger // Main bot logger (JSON stdout + optional file)
|
||||
RequestLogger *slog.Logger // Optional request-level API logging
|
||||
extraLoggers extypes.Slice[*slog.Logger] // API, Uploader, and custom loggers
|
||||
|
||||
plugins []Plugin[T]
|
||||
middlewares []Middleware[T]
|
||||
prefixes []string
|
||||
runners []Runner[T]
|
||||
plugins []Plugin[T] // Command/event handlers
|
||||
middlewares []Middleware[T] // Pre-processing filters (sorted by order)
|
||||
prefixes []string // Command prefixes (e.g., "/", "!")
|
||||
runners []Runner[T] // Background tasks (e.g., cleanup, cron)
|
||||
|
||||
api *tgapi.API
|
||||
uploader *tgapi.Uploader
|
||||
dbContext *T
|
||||
l10n *L10n
|
||||
draftProvider *DraftProvider
|
||||
api *tgapi.API // Telegram API client
|
||||
uploader *tgapi.Uploader // File uploader
|
||||
dbContext *T // Injected database context
|
||||
l10n *L10n // Localization manager
|
||||
draftProvider *DraftProvider // Draft message builder
|
||||
|
||||
updateOffsetMu sync.Mutex
|
||||
updateOffset int
|
||||
updateTypes []tgapi.UpdateType
|
||||
updateQueue chan *tgapi.Update
|
||||
updateOffset int // Last processed update ID
|
||||
updateTypes []tgapi.UpdateType // Types of updates to fetch
|
||||
updateQueue chan *tgapi.Update // Internal queue for processing updates
|
||||
}
|
||||
|
||||
// NewBot creates and initializes a new Bot instance using the provided BotOpts.
|
||||
//
|
||||
// Automatically:
|
||||
// - Creates API and Uploader clients
|
||||
// - Initializes structured logging (JSON stdout + optional file)
|
||||
// - Fetches bot username via GetMe()
|
||||
// - Sets up DraftProvider with random IDs
|
||||
// - Adds API and Uploader loggers to extraLoggers
|
||||
//
|
||||
// Panics if:
|
||||
// - Token is empty
|
||||
// - GetMe() fails (invalid token or network error)
|
||||
func NewBot[T any](opts *BotOpts) *Bot[T] {
|
||||
updateQueue := make(chan *tgapi.Update, 512)
|
||||
|
||||
var limiter *rate.Limiter
|
||||
if opts.RateLimit > 0 {
|
||||
limiter = rate.NewLimiter(rate.Limit(opts.RateLimit), opts.RateLimit)
|
||||
if opts.Token == "" {
|
||||
panic("laniakea: BotOpts.Token is required")
|
||||
}
|
||||
|
||||
apiOpts := tgapi.NewAPIOpts(opts.Token).SetAPIUrl(opts.APIUrl).UseTestServer(opts.UseTestServer).SetLimiter(limiter)
|
||||
api := tgapi.NewAPI(apiOpts)
|
||||
updateQueue := make(chan *tgapi.Update, 512)
|
||||
|
||||
//var limiter *utils.RateLimiter
|
||||
//if opts.RateLimit > 0 {
|
||||
// limiter = utils.NewRateLimiter()
|
||||
//}
|
||||
limiter := utils.NewRateLimiter()
|
||||
|
||||
apiOpts := tgapi.NewAPIOpts(opts.Token).
|
||||
SetAPIUrl(opts.APIUrl).
|
||||
UseTestServer(opts.UseTestServer).
|
||||
SetLimiter(limiter)
|
||||
api := tgapi.NewAPI(apiOpts)
|
||||
uploader := tgapi.NewUploader(api)
|
||||
|
||||
prefixes := opts.Prefixes
|
||||
if len(prefixes) == 0 {
|
||||
prefixes = []string{"/"}
|
||||
}
|
||||
|
||||
bot := &Bot[T]{
|
||||
updateOffset: 0,
|
||||
errorTemplate: "%s",
|
||||
@@ -116,7 +261,7 @@ func NewBot[T any](opts *BotOpts) *Bot[T] {
|
||||
api: api,
|
||||
uploader: uploader,
|
||||
debug: opts.Debug,
|
||||
prefixes: opts.Prefixes,
|
||||
prefixes: prefixes,
|
||||
token: opts.Token,
|
||||
plugins: make([]Plugin[T], 0),
|
||||
updateTypes: make([]tgapi.UpdateType, 0),
|
||||
@@ -125,6 +270,8 @@ func NewBot[T any](opts *BotOpts) *Bot[T] {
|
||||
l10n: &L10n{},
|
||||
draftProvider: NewRandomDraftProvider(api),
|
||||
}
|
||||
|
||||
// Add API and Uploader loggers to extraLoggers for unified output
|
||||
bot.extraLoggers = bot.extraLoggers.Push(api.GetLogger()).Push(uploader.GetLogger())
|
||||
|
||||
if len(opts.ErrorTemplate) > 0 {
|
||||
@@ -135,15 +282,30 @@ func NewBot[T any](opts *BotOpts) *Bot[T] {
|
||||
}
|
||||
bot.initLoggers(opts)
|
||||
|
||||
// Fetch bot info to validate token and get username
|
||||
u, err := api.GetMe()
|
||||
if err != nil {
|
||||
_ = bot.Close()
|
||||
bot.logger.Fatal(err)
|
||||
}
|
||||
bot.logger.Infof("Authorized as %s\n", u.FirstName)
|
||||
bot.username = Val(u.Username, "")
|
||||
if bot.username == "" {
|
||||
bot.logger.Warn("Can't get bot username. Named command handlers won't work!")
|
||||
}
|
||||
bot.logger.Infoln(fmt.Sprintf("Authorized as %s (@%s)", u.FirstName, Val(u.Username, "unknown")))
|
||||
|
||||
return bot
|
||||
}
|
||||
|
||||
// Close gracefully shuts down the bot.
|
||||
//
|
||||
// Closes:
|
||||
// - Uploader (waits for pending uploads)
|
||||
// - API client
|
||||
// - RequestLogger (if enabled)
|
||||
// - Main logger
|
||||
//
|
||||
// Returns the first error encountered, if any.
|
||||
func (bot *Bot[T]) Close() error {
|
||||
if err := bot.uploader.Close(); err != nil {
|
||||
bot.logger.Errorln(err)
|
||||
@@ -151,14 +313,22 @@ func (bot *Bot[T]) Close() error {
|
||||
if err := bot.api.CloseApi(); err != nil {
|
||||
bot.logger.Errorln(err)
|
||||
}
|
||||
if bot.RequestLogger != nil {
|
||||
if err := bot.RequestLogger.Close(); err != nil {
|
||||
bot.logger.Errorln(err)
|
||||
}
|
||||
}
|
||||
if err := bot.logger.Close(); err != nil {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// initLoggers configures the main and optional request loggers.
|
||||
//
|
||||
// Uses DEBUG flag to set log level (DEBUG if true, FATAL otherwise).
|
||||
// Writes to stdout in JSON format by default.
|
||||
// If WriteToFile is true, writes to main.log and requests.log in LoggerBasePath.
|
||||
func (bot *Bot[T]) initLoggers(opts *BotOpts) {
|
||||
level := slog.FATAL
|
||||
if opts.Debug {
|
||||
@@ -190,27 +360,59 @@ func (bot *Bot[T]) initLoggers(opts *BotOpts) {
|
||||
}
|
||||
}
|
||||
|
||||
// GetUpdateOffset returns the current update offset (thread-safe).
|
||||
func (bot *Bot[T]) GetUpdateOffset() int {
|
||||
bot.updateOffsetMu.Lock()
|
||||
defer bot.updateOffsetMu.Unlock()
|
||||
return bot.updateOffset
|
||||
}
|
||||
|
||||
// SetUpdateOffset sets the update offset for next GetUpdates call (thread-safe).
|
||||
func (bot *Bot[T]) SetUpdateOffset(offset int) {
|
||||
bot.updateOffsetMu.Lock()
|
||||
defer bot.updateOffsetMu.Unlock()
|
||||
bot.updateOffset = offset
|
||||
}
|
||||
|
||||
// GetUpdateTypes returns the list of update types the bot is configured to receive.
|
||||
func (bot *Bot[T]) GetUpdateTypes() []tgapi.UpdateType { return bot.updateTypes }
|
||||
|
||||
// GetLogger returns the main bot logger.
|
||||
func (bot *Bot[T]) GetLogger() *slog.Logger { return bot.logger }
|
||||
|
||||
// GetDBContext returns the injected database context.
|
||||
// Returns nil if not set via DatabaseContext().
|
||||
func (bot *Bot[T]) GetDBContext() *T { return bot.dbContext }
|
||||
func (bot *Bot[T]) L10n(lang, key string) string { return bot.l10n.Translate(lang, key) }
|
||||
|
||||
// L10n translates a key in the given language.
|
||||
// Returns empty string if translation not found.
|
||||
func (bot *Bot[T]) L10n(lang, key string) string {
|
||||
return bot.l10n.Translate(lang, key)
|
||||
}
|
||||
|
||||
// SetDraftProvider replaces the default DraftProvider with a custom one.
|
||||
// Useful for using LinearDraftIdGenerator to persist draft IDs across restarts.
|
||||
func (bot *Bot[T]) SetDraftProvider(p *DraftProvider) *Bot[T] {
|
||||
bot.draftProvider = p
|
||||
return bot
|
||||
}
|
||||
|
||||
// DbLogger is a function type that returns a slog.LoggerWriter for database logging.
|
||||
// Used to inject database-specific log output (e.g., SQL queries, ORM events).
|
||||
type DbLogger[T DbContext] func(db *T) slog.LoggerWriter
|
||||
|
||||
// AddDatabaseLoggerWriter adds a database logger writer to all loggers.
|
||||
//
|
||||
// The writer will receive logs from:
|
||||
// - Main bot logger
|
||||
// - Request logger (if enabled)
|
||||
// - API and Uploader loggers
|
||||
//
|
||||
// Example:
|
||||
//
|
||||
// bot.AddDatabaseLoggerWriter(func(db *MyDB) slog.LoggerWriter {
|
||||
// return db.QueryLogger()
|
||||
// })
|
||||
func (bot *Bot[T]) AddDatabaseLoggerWriter(writer DbLogger[T]) *Bot[T] {
|
||||
w := writer(bot.dbContext)
|
||||
bot.logger.AddWriter(w)
|
||||
@@ -223,31 +425,59 @@ func (bot *Bot[T]) AddDatabaseLoggerWriter(writer DbLogger[T]) *Bot[T] {
|
||||
return bot
|
||||
}
|
||||
|
||||
// DatabaseContext injects a database context into the bot.
|
||||
// This context is accessible to plugins and middleware via GetDBContext().
|
||||
func (bot *Bot[T]) DatabaseContext(ctx *T) *Bot[T] {
|
||||
bot.dbContext = ctx
|
||||
return bot
|
||||
}
|
||||
|
||||
// UpdateTypes sets the list of update types the bot will request from Telegram.
|
||||
// Overwrites any previously set types.
|
||||
func (bot *Bot[T]) UpdateTypes(t ...tgapi.UpdateType) *Bot[T] {
|
||||
bot.updateTypes = make([]tgapi.UpdateType, 0)
|
||||
bot.updateTypes = append(bot.updateTypes, t...)
|
||||
return bot
|
||||
}
|
||||
|
||||
// SetPayloadType sets the type, that bot will use for payload
|
||||
// json - string `{"cmd": "command", "args": [...]}
|
||||
// base64 - same json, but encoded in base64 string
|
||||
func (bot *Bot[T]) SetPayloadType(t BotPayloadType) *Bot[T] {
|
||||
bot.payloadType = t
|
||||
return bot
|
||||
}
|
||||
|
||||
// AddUpdateType adds one or more update types to the list.
|
||||
// Does not overwrite existing types.
|
||||
func (bot *Bot[T]) AddUpdateType(t ...tgapi.UpdateType) *Bot[T] {
|
||||
bot.updateTypes = append(bot.updateTypes, t...)
|
||||
return bot
|
||||
}
|
||||
|
||||
// AddPrefixes adds one or more command prefixes (e.g., "/", "!").
|
||||
// Must have at least one prefix before Run().
|
||||
func (bot *Bot[T]) AddPrefixes(prefixes ...string) *Bot[T] {
|
||||
bot.prefixes = append(bot.prefixes, prefixes...)
|
||||
return bot
|
||||
}
|
||||
|
||||
// ErrorTemplate sets the format string for error messages sent to users.
|
||||
// Use "%s" to insert the error message.
|
||||
// Example: "❌ Error: %s" → "❌ Error: Command not found"
|
||||
func (bot *Bot[T]) ErrorTemplate(s string) *Bot[T] {
|
||||
bot.errorTemplate = s
|
||||
return bot
|
||||
}
|
||||
|
||||
// Debug enables or disables debug logging.
|
||||
func (bot *Bot[T]) Debug(debug bool) *Bot[T] {
|
||||
bot.debug = debug
|
||||
return bot
|
||||
}
|
||||
|
||||
// AddPlugins registers one or more plugins.
|
||||
// Plugins are executed in registration order unless filtered by middleware.
|
||||
func (bot *Bot[T]) AddPlugins(plugin ...*Plugin[T]) *Bot[T] {
|
||||
for _, p := range plugin {
|
||||
bot.plugins = append(bot.plugins, *p)
|
||||
@@ -255,41 +485,108 @@ func (bot *Bot[T]) AddPlugins(plugin ...*Plugin[T]) *Bot[T] {
|
||||
}
|
||||
return bot
|
||||
}
|
||||
|
||||
// AddMiddleware registers one or more middleware handlers.
|
||||
//
|
||||
// Middleware are executed in order of increasing .order value before plugins.
|
||||
// If two middleware have the same order, they are sorted lexicographically by name.
|
||||
//
|
||||
// Middleware can:
|
||||
// - Modify or reject updates before they reach plugins
|
||||
// - Inject context (e.g., user auth state, rate limit status)
|
||||
// - Log, validate, or transform incoming data
|
||||
//
|
||||
// Example:
|
||||
//
|
||||
// bot.AddMiddleware(&authMiddleware, &rateLimitMiddleware)
|
||||
//
|
||||
// Panics if any middleware has a nil name.
|
||||
func (bot *Bot[T]) AddMiddleware(middleware ...Middleware[T]) *Bot[T] {
|
||||
bot.middlewares = append(bot.middlewares, middleware...)
|
||||
for _, m := range middleware {
|
||||
if m.name == "" {
|
||||
panic("laniakea: middleware must have a non-empty name")
|
||||
}
|
||||
bot.middlewares = append(bot.middlewares, m)
|
||||
bot.logger.Debugln(fmt.Sprintf("middleware with name \"%s\" registered", m.name))
|
||||
}
|
||||
|
||||
// Stable sort by order (ascending), then by name (lexicographic)
|
||||
sort.Slice(bot.middlewares, func(i, j int) bool {
|
||||
first := bot.middlewares[i]
|
||||
second := bot.middlewares[j]
|
||||
if first.order == second.order {
|
||||
return first.name < second.name
|
||||
}
|
||||
if first.order != second.order {
|
||||
return first.order < second.order
|
||||
}
|
||||
return first.name < second.name
|
||||
})
|
||||
|
||||
return bot
|
||||
}
|
||||
|
||||
// AddRunner registers a background runner to execute concurrently with the bot.
|
||||
//
|
||||
// Runners are goroutines that run independently of update processing.
|
||||
// Common use cases:
|
||||
// - Periodic cleanup (e.g., expiring drafts, clearing temp files)
|
||||
// - Metrics collection or health checks
|
||||
// - Scheduled tasks (e.g., daily announcements)
|
||||
//
|
||||
// Runners are started immediately after Bot.Run() is called.
|
||||
//
|
||||
// Example:
|
||||
//
|
||||
// bot.AddRunner(&cleanupRunner)
|
||||
//
|
||||
// Panics if runner has a nil name.
|
||||
func (bot *Bot[T]) AddRunner(runner Runner[T]) *Bot[T] {
|
||||
if runner.name == "" {
|
||||
panic("laniakea: runner must have a non-empty name")
|
||||
}
|
||||
bot.runners = append(bot.runners, runner)
|
||||
bot.logger.Debugln(fmt.Sprintf("runner with name \"%s\" registered", runner.name))
|
||||
return bot
|
||||
}
|
||||
|
||||
// AddL10n sets the localization (i18n) provider for the bot.
|
||||
//
|
||||
// The L10n instance must be pre-populated with translations.
|
||||
// Translations are accessed via Bot.L10n(lang, key).
|
||||
//
|
||||
// Example:
|
||||
//
|
||||
// l10n := l10n.New()
|
||||
// l10n.Add("en", "hello", "Hello!")
|
||||
// l10n.Add("es", "hello", "¡Hola!")
|
||||
// bot.AddL10n(l10n)
|
||||
//
|
||||
// Replaces any previously set L10n instance.
|
||||
func (bot *Bot[T]) AddL10n(l *L10n) *Bot[T] {
|
||||
if l == nil {
|
||||
bot.logger.Warn("AddL10n called with nil L10n; localization will be disabled")
|
||||
}
|
||||
bot.l10n = l
|
||||
return bot
|
||||
}
|
||||
|
||||
func (bot *Bot[T]) enqueueUpdate(u *tgapi.Update) error {
|
||||
select {
|
||||
case bot.updateQueue <- u:
|
||||
return nil
|
||||
default:
|
||||
return extypes.QueueFullErr
|
||||
}
|
||||
}
|
||||
// RunWithContext starts the bot with a given context for graceful shutdown.
|
||||
//
|
||||
// This is the main entry point for bot execution. It:
|
||||
// - Validates required configuration (prefixes, plugins)
|
||||
// - Starts all registered runners as background goroutines
|
||||
// - Begins polling for updates via Telegram's GetUpdates API
|
||||
// - Processes updates concurrently using a worker pool (16 goroutines)
|
||||
//
|
||||
// The context controls graceful shutdown. When canceled, the bot:
|
||||
// - Stops polling for new updates
|
||||
// - Finishes processing currently queued updates
|
||||
// - Closes all resources (API, uploader, loggers)
|
||||
//
|
||||
// Example:
|
||||
//
|
||||
// ctx, cancel := context.WithCancel(context.Background())
|
||||
// go bot.RunWithContext(ctx)
|
||||
// // ... later ...
|
||||
// cancel() // triggers graceful shutdown
|
||||
func (bot *Bot[T]) RunWithContext(ctx context.Context) {
|
||||
if len(bot.prefixes) == 0 {
|
||||
bot.logger.Fatalln("no prefixes defined")
|
||||
@@ -304,6 +601,8 @@ func (bot *Bot[T]) RunWithContext(ctx context.Context) {
|
||||
bot.ExecRunners()
|
||||
|
||||
bot.logger.Infoln("Bot running. Press CTRL+C to exit.")
|
||||
|
||||
// Start update polling in a goroutine
|
||||
go func() {
|
||||
for {
|
||||
select {
|
||||
@@ -312,13 +611,14 @@ func (bot *Bot[T]) RunWithContext(ctx context.Context) {
|
||||
default:
|
||||
updates, err := bot.Updates()
|
||||
if err != nil {
|
||||
bot.logger.Errorln(err)
|
||||
bot.logger.Errorln("failed to fetch updates:", err)
|
||||
time.Sleep(2 * time.Second) // exponential backoff
|
||||
continue
|
||||
}
|
||||
|
||||
for _, u := range updates {
|
||||
select {
|
||||
case bot.updateQueue <- new(u):
|
||||
case bot.updateQueue <- &u:
|
||||
case <-ctx.Done():
|
||||
return
|
||||
}
|
||||
@@ -327,14 +627,22 @@ func (bot *Bot[T]) RunWithContext(ctx context.Context) {
|
||||
}
|
||||
}()
|
||||
|
||||
// Start worker pool for concurrent update handling
|
||||
pool := pond.NewPool(16)
|
||||
for update := range bot.updateQueue {
|
||||
update := update
|
||||
update := update // capture loop variable
|
||||
pool.Submit(func() {
|
||||
bot.handle(update)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// Run starts the bot using a background context.
|
||||
//
|
||||
// Equivalent to RunWithContext(context.Background()).
|
||||
// Use this for simple bots where graceful shutdown is not required.
|
||||
//
|
||||
// For production use, prefer RunWithContext to handle SIGINT/SIGTERM gracefully.
|
||||
func (bot *Bot[T]) Run() {
|
||||
bot.RunWithContext(context.Background())
|
||||
}
|
||||
|
||||
117
cmd_generator.go
117
cmd_generator.go
@@ -1,72 +1,155 @@
|
||||
// Package laniakea provides a framework for building Telegram bots with plugin-based
|
||||
// command registration and automatic command scope management.
|
||||
//
|
||||
// This module automatically generates and registers bot commands across different
|
||||
// chat scopes (private, group, admin) based on plugin-defined commands.
|
||||
//
|
||||
// Commands are derived from Plugin and Command structs, with optional descriptions
|
||||
// and argument formatting. Automatic registration avoids manual command setup and
|
||||
// ensures consistency across chat types.
|
||||
package laniakea
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"regexp"
|
||||
"strings"
|
||||
|
||||
"git.nix13.pw/scuroneko/laniakea/tgapi"
|
||||
)
|
||||
|
||||
func generateBotCommand[T any](cmd Command[T]) tgapi.BotCommand {
|
||||
desc := cmd.command
|
||||
var CmdRegexp = regexp.MustCompile("^[a-zA-Z0-9]+$")
|
||||
|
||||
// ErrTooManyCommands is returned when the total number of registered commands
|
||||
// exceeds Telegram's limit of 100 bot commands per bot.
|
||||
//
|
||||
// Telegram Bot API enforces this limit strictly. If exceeded, SetMyCommands
|
||||
// will fail with a 400 error. This error helps catch the issue early during
|
||||
// bot initialization.
|
||||
var ErrTooManyCommands = errors.New("too many commands. max 100")
|
||||
|
||||
// generateBotCommand converts a Command[T] into a tgapi.BotCommand with a
|
||||
// formatted description that includes usage instructions.
|
||||
//
|
||||
// The description is built as:
|
||||
//
|
||||
// "<original_description>. Usage: /<command> <arg1> [<arg2>] ..."
|
||||
//
|
||||
// Required arguments are shown as-is; optional arguments are wrapped in square brackets.
|
||||
//
|
||||
// Example:
|
||||
//
|
||||
// Command{command: "start", description: "Start the bot", args: []Arg{{text: "name", required: false}}}
|
||||
// → Description: "Start the bot. Usage: /start [name]"
|
||||
func generateBotCommand[T any](cmd *Command[T]) tgapi.BotCommand {
|
||||
desc := ""
|
||||
if len(cmd.description) > 0 {
|
||||
desc = cmd.description
|
||||
}
|
||||
|
||||
var descArgs []string
|
||||
for _, a := range cmd.args {
|
||||
if a.required {
|
||||
descArgs = append(descArgs, fmt.Sprintf("%s", a.text))
|
||||
descArgs = append(descArgs, a.text)
|
||||
} else {
|
||||
descArgs = append(descArgs, fmt.Sprintf("[%s]", a.text))
|
||||
}
|
||||
}
|
||||
|
||||
if desc != "" {
|
||||
desc = fmt.Sprintf("%s. Usage: /%s %s", desc, cmd.command, strings.Join(descArgs, " "))
|
||||
} else {
|
||||
desc = fmt.Sprintf("Usage: /%s %s", cmd.command, strings.Join(descArgs, " "))
|
||||
}
|
||||
return tgapi.BotCommand{Command: cmd.command, Description: desc}
|
||||
}
|
||||
|
||||
// checkCmdRegex check if command satisfy regexp [a-zA-Z0-9]+
|
||||
// Return true if satisfy, else false.
|
||||
func checkCmdRegex(cmd string) bool {
|
||||
return CmdRegexp.MatchString(cmd)
|
||||
}
|
||||
|
||||
// generateBotCommandForPlugin collects all non-skipped commands from a Plugin[T]
|
||||
// and converts them into tgapi.BotCommand objects.
|
||||
//
|
||||
// Commands marked with skipAutoCmd = true are excluded from auto-registration.
|
||||
// This allows plugins to opt out of automatic command generation (e.g., for
|
||||
// internal or hidden commands).
|
||||
func generateBotCommandForPlugin[T any](pl Plugin[T]) []tgapi.BotCommand {
|
||||
commands := make([]tgapi.BotCommand, 0)
|
||||
for _, cmd := range pl.commands {
|
||||
if cmd.skipAutoCmd {
|
||||
continue
|
||||
}
|
||||
if !checkCmdRegex(cmd.command) {
|
||||
continue
|
||||
}
|
||||
commands = append(commands, generateBotCommand(cmd))
|
||||
}
|
||||
return commands
|
||||
}
|
||||
|
||||
var ErrTooManyCommands = errors.New("too many commands. max 100")
|
||||
|
||||
// AutoGenerateCommands registers all plugin-defined commands with Telegram's Bot API
|
||||
// across three scopes:
|
||||
// - Private chats (users)
|
||||
// - Group chats
|
||||
// - Group administrators
|
||||
//
|
||||
// It first deletes existing commands to ensure a clean state, then sets the new
|
||||
// set of commands for all scopes. This ensures consistency even if commands were
|
||||
// previously modified manually via @BotFather.
|
||||
//
|
||||
// Returns ErrTooManyCommands if the total number of commands exceeds 100.
|
||||
// Returns any API error from Telegram (e.g., network issues, invalid scope).
|
||||
//
|
||||
// Important: This method assumes the bot has been properly initialized and
|
||||
// the API client is authenticated and ready.
|
||||
//
|
||||
// Usage:
|
||||
//
|
||||
// err := bot.AutoGenerateCommands()
|
||||
// if err != nil {
|
||||
// log.Fatal(err)
|
||||
// }
|
||||
func (bot *Bot[T]) AutoGenerateCommands() error {
|
||||
// Clear existing commands to avoid duplication or stale entries
|
||||
_, err := bot.api.DeleteMyCommands(tgapi.DeleteMyCommandsP{})
|
||||
if err != nil {
|
||||
return err
|
||||
return fmt.Errorf("failed to delete existing commands: %w", err)
|
||||
}
|
||||
|
||||
// Collect all non-skipped commands from all plugins
|
||||
commands := make([]tgapi.BotCommand, 0)
|
||||
for _, pl := range bot.plugins {
|
||||
if pl.skipAutoCmd {
|
||||
continue
|
||||
}
|
||||
|
||||
commands = append(commands, generateBotCommandForPlugin(pl)...)
|
||||
bot.logger.Debugln(fmt.Sprintf("Registered %d commands from plugin %s", len(pl.commands), pl.name))
|
||||
}
|
||||
|
||||
// Enforce Telegram's 100-command limit
|
||||
if len(commands) > 100 {
|
||||
return ErrTooManyCommands
|
||||
}
|
||||
|
||||
privateChatsScope := &tgapi.BotCommandScope{Type: tgapi.BotCommandScopePrivateType}
|
||||
groupChatsScope := &tgapi.BotCommandScope{Type: tgapi.BotCommandScopeGroupType}
|
||||
chatAdminsScope := &tgapi.BotCommandScope{Type: tgapi.BotCommandScopeAllChatAdministratorsType}
|
||||
_, err = bot.api.SetMyCommands(tgapi.SetMyCommandsP{Commands: commands, Scope: privateChatsScope})
|
||||
if err != nil {
|
||||
return err
|
||||
// Register commands for each scope
|
||||
scopes := []*tgapi.BotCommandScope{
|
||||
{Type: tgapi.BotCommandScopePrivateType},
|
||||
{Type: tgapi.BotCommandScopeGroupType},
|
||||
{Type: tgapi.BotCommandScopeAllChatAdministratorsType},
|
||||
}
|
||||
_, err = bot.api.SetMyCommands(tgapi.SetMyCommandsP{Commands: commands, Scope: groupChatsScope})
|
||||
|
||||
for _, scope := range scopes {
|
||||
_, err = bot.api.SetMyCommands(tgapi.SetMyCommandsP{
|
||||
Commands: commands,
|
||||
Scope: scope,
|
||||
})
|
||||
if err != nil {
|
||||
return err
|
||||
return fmt.Errorf("failed to set commands for scope %q: %w", scope.Type, err)
|
||||
}
|
||||
_, err = bot.api.SetMyCommands(tgapi.SetMyCommandsP{Commands: commands, Scope: chatAdminsScope})
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
282
drafts.go
282
drafts.go
@@ -1,49 +1,176 @@
|
||||
// Package laniakea provides a safe, high-level interface for managing Telegram
|
||||
// message drafts using the tgapi library. It allows creating, editing, and
|
||||
// flushing drafts with automatic ID generation and optional bulk flushing.
|
||||
//
|
||||
// Drafts are designed to be ephemeral, mutable buffers that can be built up
|
||||
// incrementally and then sent as final messages. The package ensures safe
|
||||
// state management by copying entities and isolating draft contexts.
|
||||
//
|
||||
// Two draft ID generation strategies are supported:
|
||||
// - Random: Cryptographically secure random IDs (default). Ideal for distributed systems.
|
||||
// - Linear: Monotonically increasing IDs. Useful for persistence, debugging, or recovery.
|
||||
//
|
||||
// Example usage:
|
||||
//
|
||||
// provider := laniakea.NewRandomDraftProvider(api)
|
||||
//
|
||||
// draft := provider.NewDraft(tgapi.ParseModeMarkdown)
|
||||
// draft.SetChat(-1001234567890, 0)
|
||||
// draft.Push("*Hello*").Push(" **world**!")
|
||||
// err := draft.Flush() // Sends message and deletes draft
|
||||
// if err != nil {
|
||||
// log.Printf("Failed to send draft: %v", err)
|
||||
// }
|
||||
//
|
||||
// // Or flush all pending drafts at once:
|
||||
// err = provider.FlushAll() // Sends all drafts and clears them
|
||||
//
|
||||
// Note: Drafts are NOT thread-safe. Concurrent access requires external synchronization.
|
||||
package laniakea
|
||||
|
||||
import (
|
||||
"math"
|
||||
"math/rand/v2"
|
||||
"sync/atomic"
|
||||
|
||||
"git.nix13.pw/scuroneko/laniakea/tgapi"
|
||||
)
|
||||
|
||||
// draftIdGenerator defines an interface for generating unique draft IDs.
|
||||
type draftIdGenerator interface {
|
||||
// Next returns the next unique draft ID.
|
||||
Next() uint64
|
||||
}
|
||||
|
||||
type RandomDraftIdGenerator struct {
|
||||
draftIdGenerator
|
||||
}
|
||||
// RandomDraftIdGenerator generates draft IDs using cryptographically secure random numbers.
|
||||
// Suitable for distributed systems or when ID predictability is undesirable.
|
||||
type RandomDraftIdGenerator struct{}
|
||||
|
||||
// Next returns a random 64-bit unsigned integer.
|
||||
func (g *RandomDraftIdGenerator) Next() uint64 {
|
||||
return rand.Uint64N(math.MaxUint64)
|
||||
return rand.Uint64()
|
||||
}
|
||||
|
||||
// LinearDraftIdGenerator generates draft IDs using a monotonically increasing counter.
|
||||
// Useful for debugging, persistence, or when drafts must be ordered.
|
||||
type LinearDraftIdGenerator struct {
|
||||
draftIdGenerator
|
||||
lastId uint64
|
||||
lastId atomic.Uint64
|
||||
}
|
||||
|
||||
// Next returns the next linear ID, atomically incremented.
|
||||
func (g *LinearDraftIdGenerator) Next() uint64 {
|
||||
return atomic.AddUint64(&g.lastId, 1)
|
||||
return g.lastId.Add(1)
|
||||
}
|
||||
|
||||
// DraftProvider manages a collection of Drafts and provides methods to create and
|
||||
// configure them. It holds shared configuration (chat, parse mode, entities) and
|
||||
// a draft ID generator.
|
||||
//
|
||||
// DraftProvider is NOT thread-safe. Concurrent access from multiple goroutines
|
||||
// requires external synchronization.
|
||||
type DraftProvider struct {
|
||||
api *tgapi.API
|
||||
drafts map[uint64]*Draft
|
||||
generator draftIdGenerator
|
||||
|
||||
chatID int
|
||||
// Internal defaults — not exposed directly to users.
|
||||
chatID int64
|
||||
messageThreadID int
|
||||
parseMode tgapi.ParseMode
|
||||
entities []tgapi.MessageEntity
|
||||
|
||||
drafts map[uint64]*Draft
|
||||
generator draftIdGenerator
|
||||
}
|
||||
|
||||
// NewRandomDraftProvider creates a new DraftProvider using random draft IDs.
|
||||
//
|
||||
// The provider will use cryptographically secure random numbers for draft IDs.
|
||||
// All drafts created via this provider will have unpredictable, unique IDs.
|
||||
func NewRandomDraftProvider(api *tgapi.API) *DraftProvider {
|
||||
return &DraftProvider{
|
||||
api: api, generator: &RandomDraftIdGenerator{},
|
||||
drafts: make(map[uint64]*Draft),
|
||||
}
|
||||
}
|
||||
|
||||
// NewLinearDraftProvider creates a new DraftProvider using linear (incrementing) draft IDs.
|
||||
//
|
||||
// startValue is the initial value for the counter. Use 0 for fresh start, or a known
|
||||
// value to resume from persisted state.
|
||||
//
|
||||
// This is useful when you need to store draft IDs externally (e.g., in a database)
|
||||
// and want to reconstruct drafts after restart.
|
||||
func NewLinearDraftProvider(api *tgapi.API, startValue uint64) *DraftProvider {
|
||||
g := &LinearDraftIdGenerator{}
|
||||
g.lastId.Store(startValue)
|
||||
return &DraftProvider{
|
||||
api: api,
|
||||
generator: g,
|
||||
drafts: make(map[uint64]*Draft),
|
||||
}
|
||||
}
|
||||
|
||||
// SetChat sets the target chat and optional message thread for all drafts created
|
||||
// by this provider. Must be called before NewDraft().
|
||||
//
|
||||
// If not set, NewDraft() will create drafts with zero chatID, which will cause
|
||||
// SendMessageDraft to fail. Use this method to avoid runtime errors.
|
||||
func (p *DraftProvider) SetChat(chatID int64, messageThreadID int) *DraftProvider {
|
||||
p.chatID = chatID
|
||||
p.messageThreadID = messageThreadID
|
||||
return p
|
||||
}
|
||||
|
||||
// SetParseMode sets the default parse mode for all new drafts.
|
||||
// Overrides the parse mode passed to NewDraft() only if not specified there.
|
||||
func (p *DraftProvider) SetParseMode(mode tgapi.ParseMode) *DraftProvider {
|
||||
p.parseMode = mode
|
||||
return p
|
||||
}
|
||||
|
||||
// SetEntities sets the default message entities (e.g., bold, links, mentions)
|
||||
// to be copied into every new draft.
|
||||
//
|
||||
// Entities are shallow-copied — if you mutate the slice later, it will affect
|
||||
// future drafts. For safety, pass a copy if needed.
|
||||
func (p *DraftProvider) SetEntities(entities []tgapi.MessageEntity) *DraftProvider {
|
||||
p.entities = entities
|
||||
return p
|
||||
}
|
||||
|
||||
// GetDraft retrieves a draft by its ID.
|
||||
//
|
||||
// Returns the draft and true if found, or nil and false if not found.
|
||||
func (p *DraftProvider) GetDraft(id uint64) (*Draft, bool) {
|
||||
draft, ok := p.drafts[id]
|
||||
return draft, ok
|
||||
}
|
||||
|
||||
// FlushAll sends all pending drafts as final messages and clears them.
|
||||
//
|
||||
// If any draft fails to send, FlushAll returns the error immediately and
|
||||
// leaves other drafts unflushed. This allows for retry logic or logging.
|
||||
//
|
||||
// After successful flush, each draft is removed from the provider and cleared.
|
||||
func (p *DraftProvider) FlushAll() error {
|
||||
var lastErr error
|
||||
for _, draft := range p.drafts {
|
||||
if err := draft.Flush(); err != nil {
|
||||
lastErr = err
|
||||
break // Stop on first error to avoid partial state
|
||||
}
|
||||
}
|
||||
return lastErr
|
||||
}
|
||||
|
||||
// Draft represents a single message draft that can be edited and flushed.
|
||||
//
|
||||
// Drafts are safe to use from a single goroutine. Multiple goroutines must
|
||||
// synchronize access manually.
|
||||
//
|
||||
// Drafts are automatically removed from the provider's map when Flush() succeeds.
|
||||
type Draft struct {
|
||||
api *tgapi.API
|
||||
provider *DraftProvider
|
||||
|
||||
chatID int
|
||||
chatID int64
|
||||
messageThreadID int
|
||||
parseMode tgapi.ParseMode
|
||||
entities []tgapi.MessageEntity
|
||||
@@ -52,28 +179,123 @@ type Draft struct {
|
||||
Message string
|
||||
}
|
||||
|
||||
func NewRandomDraftProvider(api *tgapi.API) *DraftProvider {
|
||||
return &DraftProvider{
|
||||
api: api, generator: &RandomDraftIdGenerator{},
|
||||
drafts: make(map[uint64]*Draft),
|
||||
// NewDraft creates a new draft with the provided parse mode.
|
||||
//
|
||||
// The draft inherits the provider's chatID, messageThreadID, and entities.
|
||||
// If parseMode is zero, the provider's default parseMode is used.
|
||||
//
|
||||
// Panics if chatID is zero — call SetChat() on the provider first.
|
||||
func (p *DraftProvider) NewDraft(parseMode tgapi.ParseMode) *Draft {
|
||||
if p.chatID == 0 {
|
||||
panic("laniakea: DraftProvider.SetChat() must be called before NewDraft()")
|
||||
}
|
||||
}
|
||||
func NewLinearDraftProvider(api *tgapi.API, startValue uint64) *DraftProvider {
|
||||
return &DraftProvider{
|
||||
api: api,
|
||||
generator: &LinearDraftIdGenerator{lastId: startValue},
|
||||
drafts: make(map[uint64]*Draft),
|
||||
|
||||
id := p.generator.Next()
|
||||
draft := &Draft{
|
||||
api: p.api,
|
||||
provider: p,
|
||||
chatID: p.chatID,
|
||||
messageThreadID: p.messageThreadID,
|
||||
parseMode: parseMode,
|
||||
entities: p.entities, // Shallow copy — caller must ensure immutability
|
||||
ID: id,
|
||||
Message: "",
|
||||
}
|
||||
}
|
||||
func (d *DraftProvider) NewDraft() *Draft {
|
||||
id := d.generator.Next()
|
||||
draft := &Draft{d.api, d.chatID, d.messageThreadID, d.parseMode, d.entities, id, ""}
|
||||
d.drafts[id] = draft
|
||||
p.drafts[id] = draft
|
||||
return draft
|
||||
}
|
||||
|
||||
func (d *Draft) Push(newText string) error {
|
||||
d.Message += newText
|
||||
// SetChat overrides the draft's target chat and message thread.
|
||||
//
|
||||
// This is useful for sending a draft to a different chat than the provider's default.
|
||||
func (d *Draft) SetChat(chatID int64, messageThreadID int) *Draft {
|
||||
d.chatID = chatID
|
||||
d.messageThreadID = messageThreadID
|
||||
return d
|
||||
}
|
||||
|
||||
// SetEntities replaces the draft's message entities.
|
||||
//
|
||||
// Entities are stored by reference. If you plan to mutate the slice later,
|
||||
// pass a copy: `SetEntities(append([]tgapi.MessageEntity{}, myEntities...))`
|
||||
func (d *Draft) SetEntities(entities []tgapi.MessageEntity) *Draft {
|
||||
d.entities = entities
|
||||
return d
|
||||
}
|
||||
|
||||
// Push appends text to the draft and attempts to update the server-side draft.
|
||||
//
|
||||
// Returns an error if the Telegram API rejects the update (e.g., due to network issues).
|
||||
// The draft's Message field is always updated, even if the API call fails.
|
||||
//
|
||||
// Use this method to build the message incrementally.
|
||||
func (d *Draft) Push(text string) error {
|
||||
return d.push(text)
|
||||
}
|
||||
|
||||
// GetMessage returns the current content of the draft.
|
||||
//
|
||||
// Useful for inspection, logging, or validation before flushing.
|
||||
func (d *Draft) GetMessage() string {
|
||||
return d.Message
|
||||
}
|
||||
|
||||
// Clear resets the draft's message content to empty string.
|
||||
//
|
||||
// Does not affect server-side draft — use Flush() for that.
|
||||
func (d *Draft) Clear() {
|
||||
d.Message = ""
|
||||
}
|
||||
|
||||
// Delete removes the draft from its provider and clears its content.
|
||||
//
|
||||
// This is an internal method used by Flush(). You may call it manually if you
|
||||
// want to cancel a draft without sending it.
|
||||
func (d *Draft) Delete() {
|
||||
if d.provider != nil {
|
||||
delete(d.provider.drafts, d.ID)
|
||||
}
|
||||
d.Clear()
|
||||
}
|
||||
|
||||
// Flush sends the draft as a final message and clears it locally.
|
||||
//
|
||||
// If successful:
|
||||
// - The message is sent to Telegram.
|
||||
// - The draft's content is cleared.
|
||||
// - The draft is removed from the provider's map.
|
||||
//
|
||||
// If an error occurs:
|
||||
// - The message is NOT sent.
|
||||
// - The draft remains in the provider and retains its content.
|
||||
// - You can call Flush() again to retry.
|
||||
//
|
||||
// If the draft is empty, Flush() returns nil without calling the API.
|
||||
func (d *Draft) Flush() error {
|
||||
if d.Message == "" {
|
||||
return nil
|
||||
}
|
||||
|
||||
params := tgapi.SendMessageP{
|
||||
ChatID: d.chatID,
|
||||
ParseMode: d.parseMode,
|
||||
Entities: d.entities,
|
||||
Text: d.Message,
|
||||
}
|
||||
if d.messageThreadID > 0 {
|
||||
params.MessageThreadID = d.messageThreadID
|
||||
}
|
||||
|
||||
_, err := d.api.SendMessage(params)
|
||||
if err == nil {
|
||||
d.Delete()
|
||||
}
|
||||
return err
|
||||
}
|
||||
|
||||
// push is the internal helper for Push(). It updates the server draft via SendMessageDraft.
|
||||
func (d *Draft) push(text string) error {
|
||||
d.Message += text
|
||||
params := tgapi.SendMessageDraftP{
|
||||
ChatID: d.chatID,
|
||||
DraftID: d.ID,
|
||||
|
||||
7
examples/basic/.env
Normal file
7
examples/basic/.env
Normal file
@@ -0,0 +1,7 @@
|
||||
TG_TOKEN=
|
||||
PREFIXES=/;!
|
||||
DEBUG=true
|
||||
USE_REQ_LOG=true
|
||||
WRITE_TO_FILE=false
|
||||
USE_TEST_SERVER=true
|
||||
API_URL=http://127.0.0.1:8081
|
||||
30
examples/basic/example.go
Normal file
30
examples/basic/example.go
Normal file
@@ -0,0 +1,30 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"log"
|
||||
|
||||
"git.nix13.pw/scuroneko/laniakea"
|
||||
)
|
||||
|
||||
func echo(ctx *laniakea.MsgContext, db *laniakea.NoDB) {
|
||||
ctx.Answer(ctx.Text) // User input WITHOUT command
|
||||
}
|
||||
|
||||
func main() {
|
||||
opts := &laniakea.BotOpts{Token: "TOKEN"}
|
||||
bot := laniakea.NewBot[laniakea.NoDB](opts)
|
||||
defer bot.Close()
|
||||
|
||||
p := laniakea.NewPlugin[laniakea.NoDB]("ping")
|
||||
p.AddCommand(p.NewCommand(echo, "echo"))
|
||||
p.AddCommand(p.NewCommand(func(ctx *laniakea.MsgContext, db *laniakea.NoDB) {
|
||||
ctx.Answer("Pong")
|
||||
}, "ping"))
|
||||
|
||||
bot = bot.ErrorTemplate("Error\n\n%s").AddPlugins(p)
|
||||
|
||||
if err := bot.AutoGenerateCommands(); err != nil {
|
||||
log.Println(err)
|
||||
}
|
||||
bot.Run()
|
||||
}
|
||||
20
examples/basic/go.mod
Normal file
20
examples/basic/go.mod
Normal file
@@ -0,0 +1,20 @@
|
||||
module example/basic
|
||||
|
||||
go 1.26.1
|
||||
|
||||
require git.nix13.pw/scuroneko/laniakea v1.0.0-beta.14
|
||||
|
||||
replace (
|
||||
git.nix13.pw/scuroneko/laniakea v1.0.0-beta.14 => ../../
|
||||
)
|
||||
|
||||
require (
|
||||
git.nix13.pw/scuroneko/extypes v1.2.1 // indirect
|
||||
git.nix13.pw/scuroneko/slog v1.0.2 // indirect
|
||||
github.com/alitto/pond/v2 v2.7.0 // indirect
|
||||
github.com/fatih/color v1.18.0 // indirect
|
||||
github.com/mattn/go-colorable v0.1.14 // indirect
|
||||
github.com/mattn/go-isatty v0.0.20 // indirect
|
||||
golang.org/x/sys v0.42.0 // indirect
|
||||
golang.org/x/time v0.15.0 // indirect
|
||||
)
|
||||
19
examples/basic/go.sum
Normal file
19
examples/basic/go.sum
Normal file
@@ -0,0 +1,19 @@
|
||||
git.nix13.pw/scuroneko/extypes v1.2.1 h1:IYrOjnWKL2EAuJYtYNa+luB1vBe6paE8VY/YD+5/RpQ=
|
||||
git.nix13.pw/scuroneko/extypes v1.2.1/go.mod h1:uZVs8Yo3RrYAG9dMad6qR6lsYY67t+459D9c65QAYAw=
|
||||
git.nix13.pw/scuroneko/laniakea v1.0.0-beta.13 h1:mRVxYh7CNrm8ccob+u6XxLzZRbs1fLNRg/nXaXY78yw=
|
||||
git.nix13.pw/scuroneko/laniakea v1.0.0-beta.13/go.mod h1:M8jwm195hzAl9bj9Bkl95WfHmWvuBX6micsdtOs/gmE=
|
||||
git.nix13.pw/scuroneko/slog v1.0.2 h1:vZyUROygxC2d5FJHUQM/30xFEHY1JT/aweDZXA4rm2g=
|
||||
git.nix13.pw/scuroneko/slog v1.0.2/go.mod h1:3Qm2wzkR5KjwOponMfG7TcGSDjmYaFqRAmLvSPTuWJI=
|
||||
github.com/alitto/pond/v2 v2.7.0 h1:c76L+yN916m/DRXjGCeUBHHu92uWnh/g1bwVk4zyyXg=
|
||||
github.com/alitto/pond/v2 v2.7.0/go.mod h1:xkjYEgQ05RSpWdfSd1nM3OVv7TBhLdy7rMp3+2Nq+yE=
|
||||
github.com/fatih/color v1.18.0 h1:S8gINlzdQ840/4pfAwic/ZE0djQEH3wM94VfqLTZcOM=
|
||||
github.com/fatih/color v1.18.0/go.mod h1:4FelSpRwEGDpQ12mAdzqdOukCy4u8WUtOY6lkT/6HfU=
|
||||
github.com/mattn/go-colorable v0.1.14 h1:9A9LHSqF/7dyVVX6g0U9cwm9pG3kP9gSzcuIPHPsaIE=
|
||||
github.com/mattn/go-colorable v0.1.14/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stgPZH1UqBm1s8=
|
||||
github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
|
||||
github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
|
||||
golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.42.0 h1:omrd2nAlyT5ESRdCLYdm3+fMfNFE/+Rf4bDIQImRJeo=
|
||||
golang.org/x/sys v0.42.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
|
||||
golang.org/x/time v0.15.0 h1:bbrp8t3bGUeFOx08pvsMYRTCVSMk89u4tKbNOZbp88U=
|
||||
golang.org/x/time v0.15.0/go.mod h1:Y4YMaQmXwGQZoFaVFk4YpCt4FLQMYKZe9oeV/f4MSno=
|
||||
6
go.mod
6
go.mod
@@ -5,13 +5,13 @@ go 1.26
|
||||
require (
|
||||
git.nix13.pw/scuroneko/extypes v1.2.1
|
||||
git.nix13.pw/scuroneko/slog v1.0.2
|
||||
github.com/alitto/pond/v2 v2.6.2
|
||||
golang.org/x/time v0.14.0
|
||||
github.com/alitto/pond/v2 v2.7.0
|
||||
golang.org/x/time v0.15.0
|
||||
)
|
||||
|
||||
require (
|
||||
github.com/fatih/color v1.18.0 // indirect
|
||||
github.com/mattn/go-colorable v0.1.14 // indirect
|
||||
github.com/mattn/go-isatty v0.0.20 // indirect
|
||||
golang.org/x/sys v0.41.0 // indirect
|
||||
golang.org/x/sys v0.42.0 // indirect
|
||||
)
|
||||
|
||||
12
go.sum
12
go.sum
@@ -2,8 +2,8 @@ git.nix13.pw/scuroneko/extypes v1.2.1 h1:IYrOjnWKL2EAuJYtYNa+luB1vBe6paE8VY/YD+5
|
||||
git.nix13.pw/scuroneko/extypes v1.2.1/go.mod h1:uZVs8Yo3RrYAG9dMad6qR6lsYY67t+459D9c65QAYAw=
|
||||
git.nix13.pw/scuroneko/slog v1.0.2 h1:vZyUROygxC2d5FJHUQM/30xFEHY1JT/aweDZXA4rm2g=
|
||||
git.nix13.pw/scuroneko/slog v1.0.2/go.mod h1:3Qm2wzkR5KjwOponMfG7TcGSDjmYaFqRAmLvSPTuWJI=
|
||||
github.com/alitto/pond/v2 v2.6.2 h1:Sphe40g0ILeM1pA2c2K+Th0DGU+pt0A/Kprr+WB24Pw=
|
||||
github.com/alitto/pond/v2 v2.6.2/go.mod h1:xkjYEgQ05RSpWdfSd1nM3OVv7TBhLdy7rMp3+2Nq+yE=
|
||||
github.com/alitto/pond/v2 v2.7.0 h1:c76L+yN916m/DRXjGCeUBHHu92uWnh/g1bwVk4zyyXg=
|
||||
github.com/alitto/pond/v2 v2.7.0/go.mod h1:xkjYEgQ05RSpWdfSd1nM3OVv7TBhLdy7rMp3+2Nq+yE=
|
||||
github.com/fatih/color v1.18.0 h1:S8gINlzdQ840/4pfAwic/ZE0djQEH3wM94VfqLTZcOM=
|
||||
github.com/fatih/color v1.18.0/go.mod h1:4FelSpRwEGDpQ12mAdzqdOukCy4u8WUtOY6lkT/6HfU=
|
||||
github.com/mattn/go-colorable v0.1.14 h1:9A9LHSqF/7dyVVX6g0U9cwm9pG3kP9gSzcuIPHPsaIE=
|
||||
@@ -11,7 +11,7 @@ github.com/mattn/go-colorable v0.1.14/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stg
|
||||
github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
|
||||
github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
|
||||
golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.41.0 h1:Ivj+2Cp/ylzLiEU89QhWblYnOE9zerudt9Ftecq2C6k=
|
||||
golang.org/x/sys v0.41.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
|
||||
golang.org/x/time v0.14.0 h1:MRx4UaLrDotUKUdCIqzPC48t1Y9hANFKIRpNx+Te8PI=
|
||||
golang.org/x/time v0.14.0/go.mod h1:eL/Oa2bBBK0TkX57Fyni+NgnyQQN4LitPmob2Hjnqw4=
|
||||
golang.org/x/sys v0.42.0 h1:omrd2nAlyT5ESRdCLYdm3+fMfNFE/+Rf4bDIQImRJeo=
|
||||
golang.org/x/sys v0.42.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
|
||||
golang.org/x/time v0.15.0 h1:bbrp8t3bGUeFOx08pvsMYRTCVSMk89u4tKbNOZbp88U=
|
||||
golang.org/x/time v0.15.0/go.mod h1:Y4YMaQmXwGQZoFaVFk4YpCt4FLQMYKZe9oeV/f4MSno=
|
||||
|
||||
77
handler.go
77
handler.go
@@ -3,11 +3,14 @@ package laniakea
|
||||
import (
|
||||
"encoding/base64"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"strings"
|
||||
|
||||
"git.nix13.pw/scuroneko/laniakea/tgapi"
|
||||
)
|
||||
|
||||
var ErrInvalidPayloadType = errors.New("invalid payload type")
|
||||
|
||||
func (bot *Bot[T]) handle(u *tgapi.Update) {
|
||||
ctx := &MsgContext{
|
||||
Update: *u, Api: bot.api,
|
||||
@@ -15,6 +18,7 @@ func (bot *Bot[T]) handle(u *tgapi.Update) {
|
||||
errorTemplate: bot.errorTemplate,
|
||||
l10n: bot.l10n,
|
||||
draftProvider: bot.draftProvider,
|
||||
payloadType: bot.payloadType,
|
||||
}
|
||||
for _, middleware := range bot.middlewares {
|
||||
middleware.Execute(ctx, bot.dbContext)
|
||||
@@ -49,34 +53,34 @@ func (bot *Bot[T]) handleMessage(update *tgapi.Update, ctx *MsgContext) {
|
||||
ctx.From = update.Message.From
|
||||
ctx.Msg = update.Message
|
||||
|
||||
// Убираем префикс
|
||||
text = strings.TrimSpace(text[len(prefix):])
|
||||
|
||||
for _, plugin := range bot.plugins {
|
||||
for cmd := range plugin.commands {
|
||||
if !strings.HasPrefix(text, cmd) {
|
||||
continue
|
||||
}
|
||||
requestParts := strings.Split(text, " ")
|
||||
cmdParts := strings.Split(cmd, " ")
|
||||
isValid := true
|
||||
for i, part := range cmdParts {
|
||||
if part != requestParts[i] {
|
||||
isValid = false
|
||||
break
|
||||
}
|
||||
}
|
||||
// Извлекаем команду как первое слово
|
||||
spaceIndex := strings.Index(text, " ")
|
||||
var cmd string
|
||||
var args string
|
||||
|
||||
if !isValid {
|
||||
continue
|
||||
}
|
||||
|
||||
ctx.Text = strings.TrimSpace(text[len(cmd):])
|
||||
if ctx.Text == "" {
|
||||
ctx.Args = []string{}
|
||||
if spaceIndex == -1 {
|
||||
cmd = text
|
||||
args = ""
|
||||
} else {
|
||||
ctx.Args = strings.Split(ctx.Text, " ")
|
||||
cmd = text[:spaceIndex]
|
||||
args = strings.TrimSpace(text[spaceIndex:])
|
||||
}
|
||||
|
||||
if strings.Contains(cmd, "@") {
|
||||
botUsername := bot.username
|
||||
if botUsername != "" && strings.HasSuffix(cmd, "@"+botUsername) {
|
||||
cmd = cmd[:len(cmd)-len("@"+botUsername)] // убираем @botname
|
||||
}
|
||||
}
|
||||
|
||||
// Ищем команду по точному совпадению
|
||||
for _, plugin := range bot.plugins {
|
||||
if _, exists := plugin.commands[cmd]; exists {
|
||||
ctx.Text = args
|
||||
ctx.Args = strings.Fields(args) // Убирает лишние пробелы
|
||||
if !plugin.executeMiddlewares(ctx, bot.dbContext) {
|
||||
return
|
||||
}
|
||||
@@ -87,8 +91,7 @@ func (bot *Bot[T]) handleMessage(update *tgapi.Update, ctx *MsgContext) {
|
||||
}
|
||||
|
||||
func (bot *Bot[T]) handleCallback(update *tgapi.Update, ctx *MsgContext) {
|
||||
data := new(CallbackData)
|
||||
err := json.Unmarshal([]byte(update.CallbackQuery.Data), data)
|
||||
data, err := bot.decodePayload(update.CallbackQuery.Data)
|
||||
if err != nil {
|
||||
bot.logger.Errorln(err)
|
||||
return
|
||||
@@ -152,3 +155,29 @@ func decodeBase64Payload(s string) (CallbackData, error) {
|
||||
}
|
||||
return decodeJsonPayload(string(b))
|
||||
}
|
||||
|
||||
// func encodePayload(payloadType BotPayloadType, d CallbackData) (string, error) {
|
||||
// switch payloadType {
|
||||
// case BotPayloadBase64:
|
||||
// return encodeBase64Payload(d)
|
||||
// case BotPayloadJson:
|
||||
// return encodeJsonPayload(d)
|
||||
// }
|
||||
// return "", ErrInvalidPayloadType
|
||||
// }
|
||||
func decodePayload(payloadType BotPayloadType, s string) (CallbackData, error) {
|
||||
switch payloadType {
|
||||
case BotPayloadBase64:
|
||||
return decodeBase64Payload(s)
|
||||
case BotPayloadJson:
|
||||
return decodeJsonPayload(s)
|
||||
}
|
||||
return CallbackData{}, ErrInvalidPayloadType
|
||||
}
|
||||
|
||||
// func (bot *Bot[T]) encodePayload(d CallbackData) (string, error) {
|
||||
// return encodePayload(bot.payloadType, d)
|
||||
// }
|
||||
func (bot *Bot[T]) decodePayload(s string) (CallbackData, error) {
|
||||
return decodePayload(bot.payloadType, s)
|
||||
}
|
||||
|
||||
170
keyboard.go
170
keyboard.go
@@ -1,19 +1,42 @@
|
||||
// Package laniakea provides a fluent builder system for constructing Telegram
|
||||
// inline keyboards with callback data and custom styling.
|
||||
//
|
||||
// This package supports:
|
||||
// - Button builders with style (danger/success/primary), icons, URLs, and callbacks
|
||||
// - Line-based keyboard layout with configurable max row size
|
||||
// - Structured, JSON-serialized callback data for bot command routing
|
||||
//
|
||||
// Keyboard construction is stateful and builder-style: methods return the receiver
|
||||
// to enable chaining. Call Get() to finalize and retrieve the tgapi.ReplyMarkup.
|
||||
package laniakea
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
|
||||
"git.nix13.pw/scuroneko/extypes"
|
||||
"git.nix13.pw/scuroneko/laniakea/tgapi"
|
||||
)
|
||||
|
||||
// ButtonStyleDanger, ButtonStyleSuccess, ButtonStylePrimary are predefined
|
||||
// Telegram keyboard button styles for visual feedback.
|
||||
//
|
||||
// These values map directly to Telegram Bot API's InlineKeyboardButton style field.
|
||||
const (
|
||||
ButtonStyleDanger tgapi.KeyboardButtonStyle = "danger"
|
||||
ButtonStyleSuccess tgapi.KeyboardButtonStyle = "success"
|
||||
ButtonStylePrimary tgapi.KeyboardButtonStyle = "primary"
|
||||
)
|
||||
|
||||
// InlineKbButtonBuilder is a fluent builder for creating a single inline keyboard button.
|
||||
//
|
||||
// Use NewInlineKbButton() to start, then chain methods to configure:
|
||||
// - SetIconCustomEmojiId() — adds a custom emoji icon
|
||||
// - SetStyle() — sets visual style (danger/success/primary)
|
||||
// - SetUrl() — makes button open a URL
|
||||
// - SetCallbackDataJson() — attaches structured command + args for bot handling
|
||||
//
|
||||
// Call build() to produce the final tgapi.InlineKeyboardButton.
|
||||
// Builder methods are immutable — each returns a copy.
|
||||
type InlineKbButtonBuilder struct {
|
||||
text string
|
||||
iconCustomEmojiID string
|
||||
@@ -22,26 +45,56 @@ type InlineKbButtonBuilder struct {
|
||||
callbackData string
|
||||
}
|
||||
|
||||
// NewInlineKbButton creates a new button builder with the given display text.
|
||||
// The button will have no URL, no style, and no callback data by default.
|
||||
func NewInlineKbButton(text string) InlineKbButtonBuilder {
|
||||
return InlineKbButtonBuilder{text: text}
|
||||
}
|
||||
|
||||
// SetIconCustomEmojiId sets a custom emoji ID to display as the button's icon.
|
||||
// This is a Telegram Bot API feature for custom emoji icons.
|
||||
func (b InlineKbButtonBuilder) SetIconCustomEmojiId(id string) InlineKbButtonBuilder {
|
||||
b.iconCustomEmojiID = id
|
||||
return b
|
||||
}
|
||||
|
||||
// SetStyle sets the visual style of the button.
|
||||
// Valid values: ButtonStyleDanger, ButtonStyleSuccess, ButtonStylePrimary.
|
||||
// If not set, the button uses the default style.
|
||||
func (b InlineKbButtonBuilder) SetStyle(style tgapi.KeyboardButtonStyle) InlineKbButtonBuilder {
|
||||
b.style = style
|
||||
return b
|
||||
}
|
||||
|
||||
// SetUrl sets a URL that will be opened when the button is pressed.
|
||||
// If both URL and CallbackData are set, Telegram will prioritize URL.
|
||||
func (b InlineKbButtonBuilder) SetUrl(url string) InlineKbButtonBuilder {
|
||||
b.url = url
|
||||
return b
|
||||
}
|
||||
func (b InlineKbButtonBuilder) SetCallbackData(cmd string, args ...any) InlineKbButtonBuilder {
|
||||
|
||||
// SetCallbackDataJson sets a structured callback payload that will be sent to the bot
|
||||
// when the button is pressed. The command and arguments are serialized as JSON.
|
||||
//
|
||||
// Args are converted to strings using fmt.Sprint. Non-string types (e.g., int, bool)
|
||||
// are safely serialized, but complex structs may not serialize usefully.
|
||||
//
|
||||
// Example: SetCallbackDataJson("delete_user", 123, "confirm") → {"cmd":"delete_user","args":["123","confirm"]}
|
||||
func (b InlineKbButtonBuilder) SetCallbackDataJson(cmd string, args ...any) InlineKbButtonBuilder {
|
||||
b.callbackData = NewCallbackData(cmd, args...).ToJson()
|
||||
return b
|
||||
}
|
||||
|
||||
// SetCallbackDataBase64 sets a structured callback payload encoded as Base64.
|
||||
// This can be useful when the JSON payload exceeds Telegram's callback data length limit.
|
||||
// Args are converted to strings using fmt.Sprint.
|
||||
func (b InlineKbButtonBuilder) SetCallbackDataBase64(cmd string, args ...any) InlineKbButtonBuilder {
|
||||
b.callbackData = NewCallbackData(cmd, args...).ToBase64()
|
||||
return b
|
||||
}
|
||||
|
||||
// build converts the builder state into a tgapi.InlineKeyboardButton.
|
||||
// This method is typically called internally by InlineKeyboard.AddButton().
|
||||
func (b InlineKbButtonBuilder) build() tgapi.InlineKeyboardButton {
|
||||
return tgapi.InlineKeyboardButton{
|
||||
Text: b.text,
|
||||
@@ -52,20 +105,43 @@ func (b InlineKbButtonBuilder) build() tgapi.InlineKeyboardButton {
|
||||
}
|
||||
}
|
||||
|
||||
// InlineKeyboard is a stateful builder for constructing Telegram inline keyboard layouts.
|
||||
//
|
||||
// Buttons are added row-by-row. When a row reaches maxRow, it is automatically flushed.
|
||||
// Call AddLine() to manually end a row, or Get() to finalize and retrieve the markup.
|
||||
//
|
||||
// The keyboard is not thread-safe. Build it in a single goroutine.
|
||||
type InlineKeyboard struct {
|
||||
CurrentLine extypes.Slice[tgapi.InlineKeyboardButton]
|
||||
Lines [][]tgapi.InlineKeyboardButton
|
||||
maxRow int
|
||||
CurrentLine extypes.Slice[tgapi.InlineKeyboardButton] // Current row being built
|
||||
Lines [][]tgapi.InlineKeyboardButton // Completed rows
|
||||
maxRow int // Max buttons per row (e.g., 3 or 4)
|
||||
|
||||
payloadType BotPayloadType // Serialization format for callback data (JSON or Base64)
|
||||
}
|
||||
|
||||
// NewInlineKeyboard creates a new keyboard builder with the specified maximum
|
||||
// number of buttons per row.
|
||||
//
|
||||
// Example: NewInlineKeyboard(3) creates a keyboard with at most 3 buttons per line.
|
||||
func NewInlineKeyboard(maxRow int) *InlineKeyboard {
|
||||
return &InlineKeyboard{
|
||||
CurrentLine: make(extypes.Slice[tgapi.InlineKeyboardButton], 0),
|
||||
Lines: make([][]tgapi.InlineKeyboardButton, 0),
|
||||
maxRow: maxRow,
|
||||
payloadType: BotPayloadBase64,
|
||||
}
|
||||
}
|
||||
|
||||
// SetPayloadType sets the serialization format for callback data added via
|
||||
// AddCallbackButton and AddCallbackButtonStyle methods.
|
||||
// It should be one of BotPayloadJson or BotPayloadBase64.
|
||||
func (in *InlineKeyboard) SetPayloadType(t BotPayloadType) *InlineKeyboard {
|
||||
in.payloadType = t
|
||||
return in
|
||||
}
|
||||
|
||||
// append adds a button to the current line. If the line is full, it auto-flushes.
|
||||
// This is an internal helper used by other builder methods.
|
||||
func (in *InlineKeyboard) append(button tgapi.InlineKeyboardButton) *InlineKeyboard {
|
||||
if in.CurrentLine.Len() == in.maxRow {
|
||||
in.AddLine()
|
||||
@@ -74,27 +150,45 @@ func (in *InlineKeyboard) append(button tgapi.InlineKeyboardButton) *InlineKeybo
|
||||
return in
|
||||
}
|
||||
|
||||
// AddUrlButton adds a button that opens a URL when pressed.
|
||||
// No callback data is attached.
|
||||
func (in *InlineKeyboard) AddUrlButton(text, url string) *InlineKeyboard {
|
||||
return in.append(tgapi.InlineKeyboardButton{Text: text, URL: url})
|
||||
}
|
||||
|
||||
// AddUrlButtonStyle adds a button with a visual style that opens a URL.
|
||||
// Style must be one of: ButtonStyleDanger, ButtonStyleSuccess, ButtonStylePrimary.
|
||||
func (in *InlineKeyboard) AddUrlButtonStyle(text string, style tgapi.KeyboardButtonStyle, url string) *InlineKeyboard {
|
||||
return in.append(tgapi.InlineKeyboardButton{Text: text, Style: style, URL: url})
|
||||
}
|
||||
|
||||
// AddCallbackButton adds a button that sends a structured callback payload to the bot.
|
||||
// The command and args are serialized according to the current payloadType.
|
||||
func (in *InlineKeyboard) AddCallbackButton(text string, cmd string, args ...any) *InlineKeyboard {
|
||||
return in.append(tgapi.InlineKeyboardButton{
|
||||
Text: text, CallbackData: NewCallbackData(cmd, args...).ToJson(),
|
||||
Text: text,
|
||||
CallbackData: NewCallbackData(cmd, args...).Encode(in.payloadType),
|
||||
})
|
||||
}
|
||||
|
||||
// AddCallbackButtonStyle adds a styled callback button.
|
||||
// Style affects visual appearance; callback data is sent to bot on press.
|
||||
func (in *InlineKeyboard) AddCallbackButtonStyle(text string, style tgapi.KeyboardButtonStyle, cmd string, args ...any) *InlineKeyboard {
|
||||
return in.append(tgapi.InlineKeyboardButton{
|
||||
Text: text, Style: style,
|
||||
CallbackData: NewCallbackData(cmd, args...).ToJson(),
|
||||
Text: text,
|
||||
Style: style,
|
||||
CallbackData: NewCallbackData(cmd, args...).Encode(in.payloadType),
|
||||
})
|
||||
}
|
||||
|
||||
// AddButton adds a button pre-configured via InlineKbButtonBuilder.
|
||||
// This is the most flexible way to create buttons with custom emoji, style, URL, and callback.
|
||||
func (in *InlineKeyboard) AddButton(b InlineKbButtonBuilder) *InlineKeyboard {
|
||||
return in.append(b.build())
|
||||
}
|
||||
|
||||
// AddLine manually ends the current row and starts a new one.
|
||||
// If the current row is empty, nothing happens.
|
||||
func (in *InlineKeyboard) AddLine() *InlineKeyboard {
|
||||
if in.CurrentLine.Len() == 0 {
|
||||
return in
|
||||
@@ -103,6 +197,11 @@ func (in *InlineKeyboard) AddLine() *InlineKeyboard {
|
||||
in.CurrentLine = make(extypes.Slice[tgapi.InlineKeyboardButton], 0)
|
||||
return in
|
||||
}
|
||||
|
||||
// Get finalizes the keyboard and returns a tgapi.ReplyMarkup.
|
||||
// Automatically flushes the current line if not empty.
|
||||
//
|
||||
// Returns a pointer to a ReplyMarkup suitable for use with tgapi.SendMessage.
|
||||
func (in *InlineKeyboard) Get() *tgapi.ReplyMarkup {
|
||||
if in.CurrentLine.Len() > 0 {
|
||||
in.Lines = append(in.Lines, in.CurrentLine)
|
||||
@@ -110,11 +209,26 @@ func (in *InlineKeyboard) Get() *tgapi.ReplyMarkup {
|
||||
return &tgapi.ReplyMarkup{InlineKeyboard: in.Lines}
|
||||
}
|
||||
|
||||
// CallbackData represents the structured payload sent when an inline button
|
||||
// with callback data is pressed.
|
||||
//
|
||||
// This structure is serialized to JSON and sent to the bot as a string.
|
||||
// The bot should parse this back to determine the command and arguments.
|
||||
//
|
||||
// Example:
|
||||
//
|
||||
// {"cmd":"delete_user","args":["123","confirm"]}
|
||||
type CallbackData struct {
|
||||
Command string `json:"cmd"`
|
||||
Args []string `json:"args"`
|
||||
Command string `json:"cmd"` // The command name to route to
|
||||
Args []string `json:"args"` // Arguments passed as strings
|
||||
}
|
||||
|
||||
// NewCallbackData creates a new CallbackData instance with the given command and args.
|
||||
//
|
||||
// All args are converted to strings using fmt.Sprint. This is safe for primitives
|
||||
// (int, string, bool, float64) but may not serialize complex structs meaningfully.
|
||||
//
|
||||
// Use this to build callback payloads for bot command routing.
|
||||
func NewCallbackData(command string, args ...any) *CallbackData {
|
||||
stringArgs := make([]string, len(args))
|
||||
for i, arg := range args {
|
||||
@@ -125,10 +239,42 @@ func NewCallbackData(command string, args ...any) *CallbackData {
|
||||
Args: stringArgs,
|
||||
}
|
||||
}
|
||||
|
||||
// ToJson serializes the CallbackData to a JSON string.
|
||||
//
|
||||
// If serialization fails (e.g., due to unmarshalable fields), returns a fallback
|
||||
// JSON object: {"cmd":""} to prevent breaking Telegram's API.
|
||||
//
|
||||
// This fallback ensures the bot receives a valid JSON payload even if internal
|
||||
// errors occur — avoiding "invalid callback_data" errors from Telegram.
|
||||
func (d *CallbackData) ToJson() string {
|
||||
data, err := json.Marshal(d)
|
||||
data, err := encodeJsonPayload(*d)
|
||||
if err != nil {
|
||||
// Fallback: return minimal valid JSON to avoid Telegram API rejection
|
||||
return `{"cmd":""}`
|
||||
}
|
||||
return string(data)
|
||||
return data
|
||||
}
|
||||
|
||||
// ToBase64 serializes the CallbackData to a JSON string and then encodes it as Base64.
|
||||
// Returns an empty string if serialization or encoding fails.
|
||||
func (d *CallbackData) ToBase64() string {
|
||||
s, err := encodeBase64Payload(*d)
|
||||
if err != nil {
|
||||
return ``
|
||||
}
|
||||
return s
|
||||
}
|
||||
|
||||
// Encode serializes the CallbackData according to the specified payload type.
|
||||
// Supported types: BotPayloadJson and BotPayloadBase64.
|
||||
// For unknown types, returns an empty string.
|
||||
func (d *CallbackData) Encode(t BotPayloadType) string {
|
||||
switch t {
|
||||
case BotPayloadBase64:
|
||||
return d.ToBase64()
|
||||
case BotPayloadJson:
|
||||
return d.ToJson()
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
76
l10n.go
76
l10n.go
@@ -1,26 +1,86 @@
|
||||
// Package laniakea provides a simple, key-based localization system for
|
||||
// multi-language text translation.
|
||||
//
|
||||
// The system supports:
|
||||
// - Multiple language entries per key (e.g., "ru", "en", "es")
|
||||
// - Fallback language for missing translations
|
||||
// - Key-as-fallback behavior: if a key or language is not found, returns the key itself
|
||||
//
|
||||
// This is designed for lightweight, static localization in bots or services
|
||||
// where dynamic translation services are unnecessary.
|
||||
package laniakea
|
||||
|
||||
// DictEntry {key:{ru:123,en:123}}
|
||||
// DictEntry represents a single localized entry with language-to-text mappings.
|
||||
// Example: {"ru": "Привет", "en": "Hello"}
|
||||
type DictEntry map[string]string
|
||||
|
||||
// L10n is a localization manager that maps keys to language-specific strings.
|
||||
type L10n struct {
|
||||
entries map[string]DictEntry
|
||||
fallbackLang string
|
||||
entries map[string]DictEntry // Map of translation keys to language dictionaries
|
||||
fallbackLang string // Language code to use when requested language is missing
|
||||
}
|
||||
|
||||
// NewL10n creates a new L10n instance with the specified fallback language.
|
||||
// The fallback language is used when a requested language is not available
|
||||
// for a given key.
|
||||
//
|
||||
// Example: NewL10n("en") will return "Hello" for key "greeting" if "ru" is requested
|
||||
// but no "ru" entry exists.
|
||||
func NewL10n(fallbackLanguage string) *L10n {
|
||||
return &L10n{make(map[string]DictEntry), fallbackLanguage}
|
||||
return &L10n{
|
||||
entries: make(map[string]DictEntry),
|
||||
fallbackLang: fallbackLanguage,
|
||||
}
|
||||
}
|
||||
|
||||
// AddDictEntry adds a new translation entry for the given key.
|
||||
// The value must be a DictEntry mapping language codes (e.g., "en", "ru") to their translated strings.
|
||||
//
|
||||
// If a key already exists, it is overwritten.
|
||||
//
|
||||
// Returns the L10n instance for method chaining.
|
||||
func (l *L10n) AddDictEntry(key string, value DictEntry) *L10n {
|
||||
l.entries[key] = value
|
||||
return l
|
||||
}
|
||||
|
||||
// GetFallbackLanguage returns the currently configured fallback language code.
|
||||
func (l *L10n) GetFallbackLanguage() string {
|
||||
return l.fallbackLang
|
||||
}
|
||||
|
||||
// Translate retrieves the translation for the given key and language.
|
||||
//
|
||||
// Behavior:
|
||||
// - If the key exists and the language has a translation → returns the translation
|
||||
// - If the key exists but the language is missing → returns the fallback language's value
|
||||
// - If the key does not exist → returns the key string itself (as fallback)
|
||||
//
|
||||
// Example:
|
||||
//
|
||||
// l.AddDictEntry("greeting", DictEntry{"en": "Hello", "ru": "Привет"})
|
||||
// l.Translate("en", "greeting") → "Hello"
|
||||
// l.Translate("es", "greeting") → "Hello" (fallback to "en")
|
||||
// l.Translate("en", "unknown") → "unknown" (key not found)
|
||||
//
|
||||
// This behavior ensures that missing translations do not break UI or logs —
|
||||
// instead, the original key is displayed, making it easy to identify gaps.
|
||||
func (l *L10n) Translate(lang, key string) string {
|
||||
s, ok := l.entries[key]
|
||||
if !ok {
|
||||
return key
|
||||
entries, exists := l.entries[key]
|
||||
if !exists {
|
||||
return key // Return key as fallback when translation is missing
|
||||
}
|
||||
return s[lang]
|
||||
|
||||
// Try requested language
|
||||
if translation, ok := entries[lang]; ok {
|
||||
return translation
|
||||
}
|
||||
|
||||
// Fall back to configured fallback language
|
||||
if fallback, ok := entries[l.fallbackLang]; ok {
|
||||
return fallback
|
||||
}
|
||||
|
||||
// If fallback language is also missing, return the key
|
||||
return key
|
||||
}
|
||||
|
||||
273
msg_context.go
273
msg_context.go
@@ -1,16 +1,37 @@
|
||||
// Package laniakea provides a high-level context-based API for handling Telegram
|
||||
// bot interactions, including message responses, callback queries, inline keyboards,
|
||||
// localization, and message drafting. It wraps tgapi and adds convenience methods
|
||||
// with built-in rate limiting, error handling, and i18n support.
|
||||
//
|
||||
// The core type is MsgContext, which encapsulates the state of a Telegram update
|
||||
// and provides methods to respond, edit, delete, and translate messages.
|
||||
//
|
||||
// # Markdown Safety Warning
|
||||
//
|
||||
// All methods that accept MarkdownV2 formatting (e.g., AnswerMarkdown, EditCallbackfMarkdown)
|
||||
// require that user-provided text be escaped using laniakea.EscapeMarkdownV2().
|
||||
// Failure to escape user input may result in Telegram API errors, malformed messages,
|
||||
// or security issues.
|
||||
//
|
||||
// Example:
|
||||
//
|
||||
// text := laniakea.EscapeMarkdownV2(userInput)
|
||||
// ctx.AnswerMarkdown("You said: " + text)
|
||||
package laniakea
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
|
||||
"git.nix13.pw/scuroneko/laniakea/tgapi"
|
||||
"git.nix13.pw/scuroneko/laniakea/utils"
|
||||
"git.nix13.pw/scuroneko/slog"
|
||||
)
|
||||
|
||||
// MsgContext holds the context for handling a Telegram message or callback query.
|
||||
// It provides methods to respond, edit, delete, and translate messages, as well as
|
||||
// manage inline keyboards and message drafts.
|
||||
type MsgContext struct {
|
||||
Api *tgapi.API
|
||||
|
||||
Msg *tgapi.Message
|
||||
Update tgapi.Update
|
||||
From *tgapi.User
|
||||
@@ -25,21 +46,26 @@ type MsgContext struct {
|
||||
botLogger *slog.Logger
|
||||
l10n *L10n
|
||||
draftProvider *DraftProvider
|
||||
payloadType BotPayloadType
|
||||
}
|
||||
|
||||
// AnswerMessage represents a message sent or edited via MsgContext.
|
||||
// It holds metadata to allow further editing or deletion.
|
||||
type AnswerMessage struct {
|
||||
MessageID int
|
||||
Text string
|
||||
IsMedia bool
|
||||
ctx *MsgContext
|
||||
ctx *MsgContext // internal back-reference
|
||||
}
|
||||
|
||||
func (ctx *MsgContext) edit(messageId int, text string, keyboard *InlineKeyboard) *AnswerMessage {
|
||||
// edit is an internal helper to edit a message's text with optional keyboard and parse mode.
|
||||
// Used by Edit, EditMarkdown, EditCallback, etc.
|
||||
func (ctx *MsgContext) edit(messageId int, text string, keyboard *InlineKeyboard, parseMode tgapi.ParseMode) *AnswerMessage {
|
||||
params := tgapi.EditMessageTextP{
|
||||
MessageID: messageId,
|
||||
ChatID: ctx.Msg.Chat.ID,
|
||||
Text: text,
|
||||
ParseMode: tgapi.ParseMD,
|
||||
ParseMode: parseMode,
|
||||
}
|
||||
if keyboard != nil {
|
||||
params.ReplyMarkup = keyboard.Get()
|
||||
@@ -53,27 +79,67 @@ func (ctx *MsgContext) edit(messageId int, text string, keyboard *InlineKeyboard
|
||||
MessageID: msg.MessageID, ctx: ctx, Text: text, IsMedia: false,
|
||||
}
|
||||
}
|
||||
|
||||
// Edit replaces the text of the message without changing the keyboard or parse mode.
|
||||
// Uses ParseNone (plain text).
|
||||
func (m *AnswerMessage) Edit(text string) *AnswerMessage {
|
||||
return m.ctx.edit(m.MessageID, text, nil)
|
||||
return m.ctx.edit(m.MessageID, text, nil, tgapi.ParseNone)
|
||||
}
|
||||
func (ctx *MsgContext) EditCallback(text string, keyboard *InlineKeyboard) *AnswerMessage {
|
||||
|
||||
// EditMarkdown replaces the text of the message using MarkdownV2 formatting.
|
||||
//
|
||||
// ⚠️ WARNING: User input must be escaped with laniakea.EscapeMarkdownV2() before passing here.
|
||||
// Unescaped input may cause Telegram API errors or broken formatting.
|
||||
func (m *AnswerMessage) EditMarkdown(text string) *AnswerMessage {
|
||||
return m.ctx.edit(m.MessageID, text, nil, tgapi.ParseMDV2)
|
||||
}
|
||||
|
||||
// editCallback is an internal helper to edit the message associated with a callback query.
|
||||
// Returns nil if CallbackMsgId is 0 (not a callback context).
|
||||
func (ctx *MsgContext) editCallback(text string, keyboard *InlineKeyboard, parseMode tgapi.ParseMode) *AnswerMessage {
|
||||
if ctx.CallbackMsgId == 0 {
|
||||
ctx.botLogger.Errorln("Can't edit non-callback update message")
|
||||
return nil
|
||||
}
|
||||
|
||||
return ctx.edit(ctx.CallbackMsgId, text, keyboard)
|
||||
return ctx.edit(ctx.CallbackMsgId, text, keyboard, parseMode)
|
||||
}
|
||||
|
||||
// EditCallback edits the callback message using plain text (ParseNone).
|
||||
func (ctx *MsgContext) EditCallback(text string, keyboard *InlineKeyboard) *AnswerMessage {
|
||||
return ctx.editCallback(text, keyboard, tgapi.ParseNone)
|
||||
}
|
||||
|
||||
// EditCallbackMarkdown edits the callback message using MarkdownV2.
|
||||
//
|
||||
// ⚠️ WARNING: User input must be escaped with laniakea.EscapeMarkdownV2() before passing here.
|
||||
func (ctx *MsgContext) EditCallbackMarkdown(text string, keyboard *InlineKeyboard) *AnswerMessage {
|
||||
return ctx.editCallback(text, keyboard, tgapi.ParseMDV2)
|
||||
}
|
||||
|
||||
// EditCallbackf formats a string using fmt.Sprintf and edits the callback message with plain text.
|
||||
func (ctx *MsgContext) EditCallbackf(format string, keyboard *InlineKeyboard, args ...any) *AnswerMessage {
|
||||
return ctx.EditCallback(fmt.Sprintf(format, args...), keyboard)
|
||||
return ctx.editCallback(fmt.Sprintf(format, args...), keyboard, tgapi.ParseNone)
|
||||
}
|
||||
|
||||
func (ctx *MsgContext) editPhotoText(messageId int, text string, kb *InlineKeyboard) *AnswerMessage {
|
||||
// EditCallbackfMarkdown formats a string using fmt.Sprintf and edits the callback message with MarkdownV2.
|
||||
//
|
||||
// ⚠️ WARNING: User input must be escaped with laniakea.EscapeMarkdownV2() before passing here.
|
||||
func (ctx *MsgContext) EditCallbackfMarkdown(format string, keyboard *InlineKeyboard, args ...any) *AnswerMessage {
|
||||
return ctx.editCallback(fmt.Sprintf(format, args...), keyboard, tgapi.ParseMDV2)
|
||||
}
|
||||
|
||||
// editPhotoText edits the caption of a photo/video message.
|
||||
// Returns nil if messageId is 0.
|
||||
func (ctx *MsgContext) editPhotoText(messageId int, text string, kb *InlineKeyboard, parseMode tgapi.ParseMode) *AnswerMessage {
|
||||
if messageId == 0 {
|
||||
ctx.botLogger.Errorln("Can't edit caption message, message ID zero")
|
||||
return nil
|
||||
}
|
||||
params := tgapi.EditMessageCaptionP{
|
||||
ChatID: ctx.Msg.Chat.ID,
|
||||
MessageID: messageId,
|
||||
Caption: text,
|
||||
ParseMode: tgapi.ParseMD,
|
||||
ParseMode: parseMode,
|
||||
}
|
||||
if kb != nil {
|
||||
params.ReplyMarkup = kb.Get()
|
||||
@@ -87,22 +153,38 @@ func (ctx *MsgContext) editPhotoText(messageId int, text string, kb *InlineKeybo
|
||||
MessageID: msg.MessageID, ctx: ctx, Text: text, IsMedia: true,
|
||||
}
|
||||
}
|
||||
|
||||
// EditCaption edits the caption of a media message using plain text.
|
||||
func (m *AnswerMessage) EditCaption(text string) *AnswerMessage {
|
||||
if m.MessageID == 0 {
|
||||
m.ctx.botLogger.Errorln("Can't edit caption message, message id is zero")
|
||||
return m
|
||||
}
|
||||
return m.ctx.editPhotoText(m.MessageID, text, nil)
|
||||
}
|
||||
func (m *AnswerMessage) EditCaptionKeyboard(text string, kb *InlineKeyboard) *AnswerMessage {
|
||||
return m.ctx.editPhotoText(m.MessageID, text, kb)
|
||||
return m.ctx.editPhotoText(m.MessageID, text, nil, tgapi.ParseNone)
|
||||
}
|
||||
|
||||
func (ctx *MsgContext) answer(text string, keyboard *InlineKeyboard) *AnswerMessage {
|
||||
// EditCaptionMarkdown edits the caption of a media message using MarkdownV2.
|
||||
//
|
||||
// ⚠️ WARNING: User input must be escaped with laniakea.EscapeMarkdownV2() before passing here.
|
||||
func (m *AnswerMessage) EditCaptionMarkdown(text string) *AnswerMessage {
|
||||
return m.ctx.editPhotoText(m.MessageID, text, nil, tgapi.ParseMDV2)
|
||||
}
|
||||
|
||||
// EditCaptionKeyboard edits the caption of a media message with a new inline keyboard (plain text).
|
||||
func (m *AnswerMessage) EditCaptionKeyboard(text string, kb *InlineKeyboard) *AnswerMessage {
|
||||
return m.ctx.editPhotoText(m.MessageID, text, kb, tgapi.ParseNone)
|
||||
}
|
||||
|
||||
// EditCaptionKeyboardMarkdown edits the caption of a media message with a new inline keyboard using MarkdownV2.
|
||||
//
|
||||
// ⚠️ WARNING: User input must be escaped with laniakea.EscapeMarkdownV2() before passing here.
|
||||
func (m *AnswerMessage) EditCaptionKeyboardMarkdown(text string, kb *InlineKeyboard) *AnswerMessage {
|
||||
return m.ctx.editPhotoText(m.MessageID, text, kb, tgapi.ParseMDV2)
|
||||
}
|
||||
|
||||
// answer sends a new message with optional keyboard and parse mode.
|
||||
// Uses API limiter to respect Telegram rate limits per chat.
|
||||
func (ctx *MsgContext) answer(text string, keyboard *InlineKeyboard, parseMode tgapi.ParseMode) *AnswerMessage {
|
||||
params := tgapi.SendMessageP{
|
||||
ChatID: ctx.Msg.Chat.ID,
|
||||
Text: text,
|
||||
ParseMode: tgapi.ParseMD,
|
||||
ParseMode: parseMode,
|
||||
}
|
||||
if keyboard != nil {
|
||||
params.ReplyMarkup = keyboard.Get()
|
||||
@@ -110,7 +192,15 @@ func (ctx *MsgContext) answer(text string, keyboard *InlineKeyboard) *AnswerMess
|
||||
if ctx.Msg.MessageThreadID > 0 {
|
||||
params.MessageThreadID = ctx.Msg.MessageThreadID
|
||||
}
|
||||
if ctx.Msg.DirectMessageTopic != nil {
|
||||
params.DirectMessagesTopicID = ctx.Msg.DirectMessageTopic.TopicID
|
||||
}
|
||||
|
||||
cont := context.Background()
|
||||
if err := ctx.Api.Limiter.Wait(cont, ctx.Msg.Chat.ID); err != nil {
|
||||
ctx.botLogger.Errorln(err)
|
||||
return nil
|
||||
}
|
||||
msg, err := ctx.Api.SendMessage(params)
|
||||
if err != nil {
|
||||
ctx.botLogger.Errorln(err)
|
||||
@@ -120,21 +210,49 @@ func (ctx *MsgContext) answer(text string, keyboard *InlineKeyboard) *AnswerMess
|
||||
MessageID: msg.MessageID, ctx: ctx, IsMedia: false, Text: text,
|
||||
}
|
||||
}
|
||||
|
||||
// Answer sends a plain text message (ParseNone).
|
||||
func (ctx *MsgContext) Answer(text string) *AnswerMessage {
|
||||
return ctx.answer(text, nil)
|
||||
}
|
||||
func (ctx *MsgContext) Answerf(template string, args ...any) *AnswerMessage {
|
||||
return ctx.answer(fmt.Sprintf(template, args...), nil)
|
||||
}
|
||||
func (ctx *MsgContext) Keyboard(text string, kb *InlineKeyboard) *AnswerMessage {
|
||||
return ctx.answer(text, kb)
|
||||
return ctx.answer(text, nil, tgapi.ParseNone)
|
||||
}
|
||||
|
||||
func (ctx *MsgContext) answerPhoto(photoId, text string, kb *InlineKeyboard) *AnswerMessage {
|
||||
// AnswerMarkdown sends a message using MarkdownV2 formatting.
|
||||
//
|
||||
// ⚠️ WARNING: User input must be escaped with laniakea.EscapeMarkdownV2() before passing here.
|
||||
func (ctx *MsgContext) AnswerMarkdown(text string) *AnswerMessage {
|
||||
return ctx.answer(text, nil, tgapi.ParseMDV2)
|
||||
}
|
||||
|
||||
// Answerf formats a string using fmt.Sprintf and sends it as a plain text message.
|
||||
func (ctx *MsgContext) Answerf(template string, args ...any) *AnswerMessage {
|
||||
return ctx.answer(fmt.Sprintf(template, args...), nil, tgapi.ParseNone)
|
||||
}
|
||||
|
||||
// AnswerfMarkdown formats a string using fmt.Sprintf and sends it using MarkdownV2.
|
||||
//
|
||||
// ⚠️ WARNING: User input must be escaped with laniakea.EscapeMarkdownV2() before passing here.
|
||||
func (ctx *MsgContext) AnswerfMarkdown(template string, args ...any) *AnswerMessage {
|
||||
return ctx.answer(fmt.Sprintf(template, args...), nil, tgapi.ParseMDV2)
|
||||
}
|
||||
|
||||
// Keyboard sends a message with an inline keyboard (plain text).
|
||||
func (ctx *MsgContext) Keyboard(text string, kb *InlineKeyboard) *AnswerMessage {
|
||||
return ctx.answer(text, kb, tgapi.ParseNone)
|
||||
}
|
||||
|
||||
// KeyboardMarkdown sends a message with an inline keyboard using MarkdownV2.
|
||||
//
|
||||
// ⚠️ WARNING: User input must be escaped with laniakea.EscapeMarkdownV2() before passing here.
|
||||
func (ctx *MsgContext) KeyboardMarkdown(text string, keyboard *InlineKeyboard) *AnswerMessage {
|
||||
return ctx.answer(text, keyboard, tgapi.ParseMDV2)
|
||||
}
|
||||
|
||||
// answerPhoto sends a photo with optional caption and keyboard.
|
||||
func (ctx *MsgContext) answerPhoto(photoId, text string, kb *InlineKeyboard, parseMode tgapi.ParseMode) *AnswerMessage {
|
||||
params := tgapi.SendPhotoP{
|
||||
ChatID: ctx.Msg.Chat.ID,
|
||||
Caption: text,
|
||||
ParseMode: tgapi.ParseMD,
|
||||
ParseMode: parseMode,
|
||||
Photo: photoId,
|
||||
}
|
||||
if kb != nil {
|
||||
@@ -147,21 +265,50 @@ func (ctx *MsgContext) answerPhoto(photoId, text string, kb *InlineKeyboard) *An
|
||||
msg, err := ctx.Api.SendPhoto(params)
|
||||
if err != nil {
|
||||
ctx.botLogger.Errorln(err)
|
||||
return &AnswerMessage{
|
||||
ctx: ctx, Text: text, IsMedia: true,
|
||||
}
|
||||
return nil
|
||||
}
|
||||
return &AnswerMessage{
|
||||
MessageID: msg.MessageID, ctx: ctx, Text: text, IsMedia: true,
|
||||
}
|
||||
}
|
||||
|
||||
// AnswerPhoto sends a photo with plain text caption.
|
||||
func (ctx *MsgContext) AnswerPhoto(photoId, text string) *AnswerMessage {
|
||||
return ctx.answerPhoto(photoId, text, nil)
|
||||
}
|
||||
func (ctx *MsgContext) AnswerPhotoKeyboard(photoId, text string, kb *InlineKeyboard) *AnswerMessage {
|
||||
return ctx.answerPhoto(photoId, text, kb)
|
||||
return ctx.answerPhoto(photoId, text, nil, tgapi.ParseNone)
|
||||
}
|
||||
|
||||
// AnswerPhotoMarkdown sends a photo with MarkdownV2 caption.
|
||||
//
|
||||
// ⚠️ WARNING: User input must be escaped with laniakea.EscapeMarkdownV2() before passing here.
|
||||
func (ctx *MsgContext) AnswerPhotoMarkdown(photoId, text string) *AnswerMessage {
|
||||
return ctx.answerPhoto(photoId, text, nil, tgapi.ParseMDV2)
|
||||
}
|
||||
|
||||
// AnswerPhotoKeyboard sends a photo with caption and inline keyboard (plain text).
|
||||
func (ctx *MsgContext) AnswerPhotoKeyboard(photoId, text string, kb *InlineKeyboard) *AnswerMessage {
|
||||
return ctx.answerPhoto(photoId, text, kb, tgapi.ParseNone)
|
||||
}
|
||||
|
||||
// AnswerPhotoKeyboardMarkdown sends a photo with caption and inline keyboard using MarkdownV2.
|
||||
//
|
||||
// ⚠️ WARNING: User input must be escaped with laniakea.EscapeMarkdownV2() before passing here.
|
||||
func (ctx *MsgContext) AnswerPhotoKeyboardMarkdown(photoId, text string, kb *InlineKeyboard) *AnswerMessage {
|
||||
return ctx.answerPhoto(photoId, text, kb, tgapi.ParseMDV2)
|
||||
}
|
||||
|
||||
// AnswerPhotof formats a string and sends it as a photo caption (plain text).
|
||||
func (ctx *MsgContext) AnswerPhotof(photoId, template string, args ...any) *AnswerMessage {
|
||||
return ctx.answerPhoto(photoId, fmt.Sprintf(template, args...), nil, tgapi.ParseNone)
|
||||
}
|
||||
|
||||
// AnswerPhotofMarkdown formats a string and sends it as a photo caption using MarkdownV2.
|
||||
//
|
||||
// ⚠️ WARNING: User input must be escaped with laniakea.EscapeMarkdownV2() before passing here.
|
||||
func (ctx *MsgContext) AnswerPhotofMarkdown(photoId, template string, args ...any) *AnswerMessage {
|
||||
return ctx.answerPhoto(photoId, fmt.Sprintf(template, args...), nil, tgapi.ParseMDV2)
|
||||
}
|
||||
|
||||
// delete removes a message by ID.
|
||||
func (ctx *MsgContext) delete(messageId int) {
|
||||
_, err := ctx.Api.DeleteMessage(tgapi.DeleteMessageP{
|
||||
ChatID: ctx.Msg.Chat.ID,
|
||||
@@ -171,9 +318,15 @@ func (ctx *MsgContext) delete(messageId int) {
|
||||
ctx.botLogger.Errorln(err)
|
||||
}
|
||||
}
|
||||
|
||||
// Delete removes the message associated with this AnswerMessage.
|
||||
func (m *AnswerMessage) Delete() { m.ctx.delete(m.MessageID) }
|
||||
|
||||
// CallbackDelete deletes the message that triggered the callback query.
|
||||
func (ctx *MsgContext) CallbackDelete() { ctx.delete(ctx.CallbackMsgId) }
|
||||
|
||||
// answerCallbackQuery sends a response to a callback query (optional text/alert/url).
|
||||
// Does nothing if CallbackQueryId is empty.
|
||||
func (ctx *MsgContext) answerCallbackQuery(url, text string, showAlert bool) {
|
||||
if len(ctx.CallbackQueryId) == 0 {
|
||||
return
|
||||
@@ -186,11 +339,20 @@ func (ctx *MsgContext) answerCallbackQuery(url, text string, showAlert bool) {
|
||||
ctx.botLogger.Errorln(err)
|
||||
}
|
||||
}
|
||||
|
||||
// AnswerCbQuery answers the callback query with no text or alert.
|
||||
func (ctx *MsgContext) AnswerCbQuery() { ctx.answerCallbackQuery("", "", false) }
|
||||
|
||||
// AnswerCbQueryText answers the callback query with a text notification.
|
||||
func (ctx *MsgContext) AnswerCbQueryText(text string) { ctx.answerCallbackQuery("", text, false) }
|
||||
|
||||
// AnswerCbQueryAlert answers the callback query with a user-visible alert.
|
||||
func (ctx *MsgContext) AnswerCbQueryAlert(text string) { ctx.answerCallbackQuery("", text, true) }
|
||||
|
||||
// AnswerCbQueryUrl answers the callback query with a URL redirect.
|
||||
func (ctx *MsgContext) AnswerCbQueryUrl(u string) { ctx.answerCallbackQuery(u, "", false) }
|
||||
|
||||
// SendAction sends a chat action (typing, uploading_photo, etc.) to indicate bot activity.
|
||||
func (ctx *MsgContext) SendAction(action tgapi.ChatActionType) {
|
||||
params := tgapi.SendChatActionP{
|
||||
ChatID: ctx.Msg.Chat.ID, Action: action,
|
||||
@@ -204,24 +366,47 @@ func (ctx *MsgContext) SendAction(action tgapi.ChatActionType) {
|
||||
}
|
||||
}
|
||||
|
||||
// error sends an error message to the user and logs it.
|
||||
// Uses errorTemplate to format the message.
|
||||
// For callbacks: sends as callback answer (no alert).
|
||||
// For regular messages: sends as plain text.
|
||||
func (ctx *MsgContext) error(err error) {
|
||||
text := fmt.Sprintf(ctx.errorTemplate, utils.EscapeMarkdown(err.Error()))
|
||||
text := fmt.Sprintf(ctx.errorTemplate, err.Error())
|
||||
|
||||
if ctx.CallbackQueryId != "" {
|
||||
ctx.answerCallbackQuery("", text, false)
|
||||
} else {
|
||||
ctx.answer(text, nil)
|
||||
ctx.answer(text, nil, tgapi.ParseNone)
|
||||
}
|
||||
ctx.botLogger.Errorln(err)
|
||||
}
|
||||
|
||||
// Error is an alias for error().
|
||||
func (ctx *MsgContext) Error(err error) { ctx.error(err) }
|
||||
|
||||
func (ctx *MsgContext) NewDraft() *Draft {
|
||||
draft := ctx.draftProvider.NewDraft()
|
||||
draft.chatID = ctx.Msg.Chat.ID
|
||||
draft.messageThreadID = ctx.Msg.MessageThreadID
|
||||
func (ctx *MsgContext) newDraft(parseMode tgapi.ParseMode) *Draft {
|
||||
c := context.Background()
|
||||
if err := ctx.Api.Limiter.Wait(c, ctx.Msg.Chat.ID); err != nil {
|
||||
ctx.botLogger.Errorln(err)
|
||||
return nil
|
||||
}
|
||||
|
||||
draft := ctx.draftProvider.NewDraft(parseMode).SetChat(ctx.Msg.Chat.ID, ctx.Msg.MessageThreadID)
|
||||
return draft
|
||||
}
|
||||
|
||||
// NewDraft creates a new message draft associated with the current chat.
|
||||
// Uses the API limiter to avoid rate limiting.
|
||||
func (ctx *MsgContext) NewDraft() *Draft {
|
||||
return ctx.newDraft(tgapi.ParseNone)
|
||||
}
|
||||
|
||||
func (ctx *MsgContext) NewDraftMarkdown() *Draft {
|
||||
return ctx.newDraft(tgapi.ParseMDV2)
|
||||
}
|
||||
|
||||
// Translate looks up a key in the current user's language.
|
||||
// Falls back to the bot's default language if user's language is unknown or unsupported.
|
||||
func (ctx *MsgContext) Translate(key string) string {
|
||||
if ctx.From == nil {
|
||||
return key
|
||||
|
||||
228
plugins.go
228
plugins.go
@@ -1,3 +1,15 @@
|
||||
// Package laniakea provides a structured system for defining and executing
|
||||
// bot commands and payloads with middleware support, argument validation,
|
||||
// and plugin-based organization.
|
||||
//
|
||||
// The core concepts are:
|
||||
// - Command: A named bot command with arguments, description, and executor.
|
||||
// - Plugin: A collection of commands and payloads, with shared middlewares.
|
||||
// - Middleware: Interceptors that can validate, modify, or block execution.
|
||||
// - CommandArg: Type-safe argument definitions with regex validation.
|
||||
//
|
||||
// This system is designed to be used with MsgContext from the laniakea package
|
||||
// to handle Telegram bot interactions in a modular, type-safe way.
|
||||
package laniakea
|
||||
|
||||
import (
|
||||
@@ -7,83 +19,128 @@ import (
|
||||
"git.nix13.pw/scuroneko/extypes"
|
||||
)
|
||||
|
||||
// CommandValueType defines the expected type of a command argument.
|
||||
type CommandValueType string
|
||||
|
||||
const (
|
||||
// CommandValueStringType expects any non-empty string.
|
||||
CommandValueStringType CommandValueType = "string"
|
||||
// CommandValueIntType expects a decimal integer (digits only).
|
||||
CommandValueIntType CommandValueType = "int"
|
||||
// CommandValueBoolType is reserved for future use (not implemented).
|
||||
CommandValueBoolType CommandValueType = "bool"
|
||||
// CommandValueAnyType accepts any input without validation.
|
||||
CommandValueAnyType CommandValueType = "any"
|
||||
)
|
||||
|
||||
var (
|
||||
CommandRegexInt = regexp.MustCompile("\\d+")
|
||||
CommandRegexString = regexp.MustCompile(".+")
|
||||
)
|
||||
// CommandRegexInt matches one or more digits.
|
||||
var CommandRegexInt = regexp.MustCompile(`\d+`)
|
||||
|
||||
var (
|
||||
ErrCmdArgCountMismatch = errors.New("command arg count mismatch")
|
||||
ErrCmdArgRegexpMismatch = errors.New("command arg regexp mismatch")
|
||||
)
|
||||
// CommandRegexString matches any non-empty string.
|
||||
var CommandRegexString = regexp.MustCompile(".+")
|
||||
|
||||
type CommandValueType string
|
||||
// ErrCmdArgCountMismatch is returned when the number of provided arguments
|
||||
// is less than the number of required arguments.
|
||||
var ErrCmdArgCountMismatch = errors.New("command arg count mismatch")
|
||||
|
||||
// ErrCmdArgRegexpMismatch is returned when an argument fails regex validation.
|
||||
var ErrCmdArgRegexpMismatch = errors.New("command arg regexp mismatch")
|
||||
|
||||
// CommandArg defines a single argument for a command, including type, regex,
|
||||
// and whether it is required.
|
||||
type CommandArg struct {
|
||||
valueType CommandValueType
|
||||
text string
|
||||
regex *regexp.Regexp
|
||||
required bool
|
||||
valueType CommandValueType // Type of expected value
|
||||
text string // Human-readable description (not used in validation)
|
||||
regex *regexp.Regexp // Regex used to validate input
|
||||
required bool // Whether this argument must be provided
|
||||
}
|
||||
|
||||
// NewCommandArg creates a new CommandArg with the given text and type.
|
||||
// Uses a default regex based on the type (string or int).
|
||||
// For CommandValueAnyType, no validation is performed.
|
||||
func NewCommandArg(text string, valueType CommandValueType) *CommandArg {
|
||||
regex := CommandRegexString
|
||||
switch valueType {
|
||||
case CommandValueIntType:
|
||||
regex = CommandRegexInt
|
||||
case CommandValueAnyType:
|
||||
regex = nil // Skip validation
|
||||
}
|
||||
return &CommandArg{valueType, text, regex, false}
|
||||
}
|
||||
|
||||
// SetRequired marks this argument as required.
|
||||
// Returns the receiver for method chaining.
|
||||
func (c *CommandArg) SetRequired() *CommandArg {
|
||||
c.required = true
|
||||
return c
|
||||
}
|
||||
|
||||
// CommandExecutor is the function type that executes a command.
|
||||
// It receives the message context and a database context (generic).
|
||||
type CommandExecutor[T DbContext] func(ctx *MsgContext, dbContext *T)
|
||||
|
||||
// Command represents a bot command with arguments, description, and executor.
|
||||
// Can be registered in a Plugin and optionally skipped from auto-generation.
|
||||
type Command[T DbContext] struct {
|
||||
command string
|
||||
description string
|
||||
exec CommandExecutor[T]
|
||||
args extypes.Slice[CommandArg]
|
||||
middlewares extypes.Slice[Middleware[T]]
|
||||
skipAutoCmd bool
|
||||
command string // The command trigger (e.g., "/start")
|
||||
description string // Human-readable description for help
|
||||
exec CommandExecutor[T] // Function to execute when command is triggered
|
||||
args extypes.Slice[CommandArg] // List of expected arguments
|
||||
middlewares extypes.Slice[Middleware[T]] // Optional middleware chain
|
||||
skipAutoCmd bool // If true, this command won't be auto-added to help menus
|
||||
}
|
||||
|
||||
// NewCommand creates a new Command with the given executor, command string, and arguments.
|
||||
// The command string should not include the leading slash (e.g., "start", not "/start").
|
||||
func NewCommand[T any](exec CommandExecutor[T], command string, args ...CommandArg) *Command[T] {
|
||||
return &Command[T]{command, "", exec, args, make(extypes.Slice[Middleware[T]], 0), false}
|
||||
}
|
||||
|
||||
// NewPayload creates a new Command with the given executor, command payload string, and arguments.
|
||||
// The command string can POTENTIALLY contain any symbols, but recommended to use only "_", "-", ".", a-Z, 0-9
|
||||
func NewPayload[T any](exec CommandExecutor[T], command string, args ...CommandArg) *Command[T] {
|
||||
return &Command[T]{command, "", exec, args, make(extypes.Slice[Middleware[T]], 0), false}
|
||||
}
|
||||
|
||||
// Use adds a middleware to the command's execution chain.
|
||||
// Middlewares are executed in the order they are added.
|
||||
func (c *Command[T]) Use(m Middleware[T]) *Command[T] {
|
||||
c.middlewares = c.middlewares.Push(m)
|
||||
return c
|
||||
}
|
||||
|
||||
// SetDescription sets the human-readable description of the command.
|
||||
func (c *Command[T]) SetDescription(desc string) *Command[T] {
|
||||
c.description = desc
|
||||
return c
|
||||
}
|
||||
|
||||
// SkipCommandAutoGen marks this command to be excluded from auto-generated help menus.
|
||||
func (c *Command[T]) SkipCommandAutoGen() *Command[T] {
|
||||
c.skipAutoCmd = true
|
||||
return c
|
||||
}
|
||||
|
||||
// validateArgs checks if the provided arguments match the command's requirements.
|
||||
// Returns ErrCmdArgCountMismatch if too few arguments are provided.
|
||||
// Returns ErrCmdArgRegexpMismatch if any argument fails regex validation.
|
||||
func (c *Command[T]) validateArgs(args []string) error {
|
||||
cmdArgs := c.args.Filter(func(e CommandArg) bool { return !e.required })
|
||||
if len(args) < cmdArgs.Len() {
|
||||
// Count required args
|
||||
requiredCount := c.args.Filter(func(a CommandArg) bool { return a.required }).Len()
|
||||
if len(args) < requiredCount {
|
||||
return ErrCmdArgCountMismatch
|
||||
}
|
||||
|
||||
// Validate each argument against its regex
|
||||
for i, arg := range args {
|
||||
if i >= c.args.Len() {
|
||||
// Extra arguments beyond defined args are ignored
|
||||
break
|
||||
}
|
||||
cmdArg := c.args.Get(i)
|
||||
if cmdArg.regex == nil {
|
||||
continue
|
||||
continue // Skip validation for CommandValueAnyType
|
||||
}
|
||||
if !cmdArg.regex.MatchString(arg) {
|
||||
return ErrCmdArgRegexpMismatch
|
||||
@@ -92,57 +149,131 @@ func (c *Command[T]) validateArgs(args []string) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// Plugin represents a collection of commands and payloads (e.g., callback handlers),
|
||||
// with shared middleware and configuration.
|
||||
type Plugin[T DbContext] struct {
|
||||
name string
|
||||
commands map[string]Command[T]
|
||||
payloads map[string]Command[T]
|
||||
middlewares extypes.Slice[Middleware[T]]
|
||||
skipAutoCmd bool
|
||||
name string // Name of the plugin (e.g., "admin", "user")
|
||||
commands map[string]*Command[T] // Registered commands (triggered by message)
|
||||
payloads map[string]*Command[T] // Registered payloads (triggered by callback data)
|
||||
middlewares extypes.Slice[Middleware[T]] // Shared middlewares for all commands/payloads
|
||||
skipAutoCmd bool // If true, all commands in this plugin are excluded from auto-help
|
||||
}
|
||||
|
||||
// NewPlugin creates a new Plugin with the given name.
|
||||
func NewPlugin[T DbContext](name string) *Plugin[T] {
|
||||
return &Plugin[T]{
|
||||
name, map[string]Command[T]{},
|
||||
map[string]Command[T]{}, extypes.Slice[Middleware[T]]{}, false,
|
||||
name, make(map[string]*Command[T]),
|
||||
make(map[string]*Command[T]), extypes.Slice[Middleware[T]]{}, false,
|
||||
}
|
||||
}
|
||||
|
||||
// AddCommand registers a command in the plugin.
|
||||
// The command's .command field is used as the key.
|
||||
func (p *Plugin[T]) AddCommand(command *Command[T]) *Plugin[T] {
|
||||
p.commands[command.command] = *command
|
||||
p.commands[command.command] = command
|
||||
return p
|
||||
}
|
||||
|
||||
// NewCommand creates and immediately adds a new command to the plugin.
|
||||
// Returns the created command for further configuration.
|
||||
func (p *Plugin[T]) NewCommand(exec CommandExecutor[T], command string, args ...CommandArg) *Command[T] {
|
||||
return NewCommand(exec, command, args...)
|
||||
cmd := NewCommand(exec, command, args...)
|
||||
p.AddCommand(cmd)
|
||||
return cmd
|
||||
}
|
||||
|
||||
// AddPayload registers a payload (e.g., callback query data) in the plugin.
|
||||
// Payloads are triggered by inline button callback_data, not by message text.
|
||||
func (p *Plugin[T]) AddPayload(command *Command[T]) *Plugin[T] {
|
||||
p.payloads[command.command] = *command
|
||||
p.payloads[command.command] = command
|
||||
return p
|
||||
}
|
||||
|
||||
// NewPayload creates and immediately adds a new payload command to the plugin.
|
||||
// Returns the created payload command for further configuration.
|
||||
func (p *Plugin[T]) NewPayload(exec CommandExecutor[T], command string, args ...CommandArg) *Command[T] {
|
||||
cmd := NewPayload(exec, command, args...)
|
||||
p.AddPayload(cmd)
|
||||
return cmd
|
||||
}
|
||||
|
||||
// AddMiddleware adds a middleware to the plugin's global middleware chain.
|
||||
// Middlewares are executed before any command or payload.
|
||||
func (p *Plugin[T]) AddMiddleware(middleware Middleware[T]) *Plugin[T] {
|
||||
p.middlewares = p.middlewares.Push(middleware)
|
||||
return p
|
||||
}
|
||||
|
||||
// SkipCommandAutoGen marks the entire plugin to be excluded from auto-generated help menus.
|
||||
func (p *Plugin[T]) SkipCommandAutoGen() *Plugin[T] {
|
||||
p.skipAutoCmd = true
|
||||
return p
|
||||
}
|
||||
|
||||
// executeCmd finds and executes a command by its trigger string.
|
||||
// Validates arguments and runs middlewares before executor.
|
||||
// On error, sends an error message to the user via ctx.error().
|
||||
func (p *Plugin[T]) executeCmd(cmd string, ctx *MsgContext, dbContext *T) {
|
||||
command := p.commands[cmd]
|
||||
command, exists := p.commands[cmd]
|
||||
if !exists {
|
||||
ctx.error(errors.New("command not found"))
|
||||
return
|
||||
}
|
||||
|
||||
if err := command.validateArgs(ctx.Args); err != nil {
|
||||
ctx.error(err)
|
||||
return
|
||||
}
|
||||
|
||||
// Run plugin middlewares
|
||||
if !p.executeMiddlewares(ctx, dbContext) {
|
||||
return
|
||||
}
|
||||
|
||||
// Run command-specific middlewares
|
||||
for _, m := range command.middlewares {
|
||||
if !m.Execute(ctx, dbContext) {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// Execute command
|
||||
command.exec(ctx, dbContext)
|
||||
}
|
||||
|
||||
// executePayload finds and executes a payload by its callback_data string.
|
||||
// Validates arguments and runs middlewares before executor.
|
||||
// On error, sends an error message to the user via ctx.error().
|
||||
func (p *Plugin[T]) executePayload(payload string, ctx *MsgContext, dbContext *T) {
|
||||
pl := p.payloads[payload]
|
||||
if err := pl.validateArgs(ctx.Args); err != nil {
|
||||
command, exists := p.payloads[payload]
|
||||
if !exists {
|
||||
ctx.error(errors.New("payload not found"))
|
||||
return
|
||||
}
|
||||
|
||||
if err := command.validateArgs(ctx.Args); err != nil {
|
||||
ctx.error(err)
|
||||
return
|
||||
}
|
||||
pl.exec(ctx, dbContext)
|
||||
|
||||
// Run plugin middlewares
|
||||
if !p.executeMiddlewares(ctx, dbContext) {
|
||||
return
|
||||
}
|
||||
|
||||
// Run command-specific middlewares
|
||||
for _, m := range command.middlewares {
|
||||
if !m.Execute(ctx, dbContext) {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// Execute payload
|
||||
command.exec(ctx, dbContext)
|
||||
}
|
||||
|
||||
// executeMiddlewares runs all plugin middlewares in order.
|
||||
// Returns false if any middleware returns false (blocks execution).
|
||||
func (p *Plugin[T]) executeMiddlewares(ctx *MsgContext, db *T) bool {
|
||||
for _, m := range p.middlewares {
|
||||
if !m.Execute(ctx, db) {
|
||||
@@ -152,28 +283,41 @@ func (p *Plugin[T]) executeMiddlewares(ctx *MsgContext, db *T) bool {
|
||||
return true
|
||||
}
|
||||
|
||||
// MiddlewareExecutor is the function type for middleware logic.
|
||||
// Returns true to continue execution, false to block it.
|
||||
// If async, return value is ignored.
|
||||
type MiddlewareExecutor[T DbContext] func(ctx *MsgContext, db *T) bool
|
||||
|
||||
// Middleware
|
||||
// When async, returned value ignored
|
||||
// Middleware represents a reusable execution interceptor.
|
||||
// Can be synchronous (blocking) or asynchronous (non-blocking).
|
||||
type Middleware[T DbContext] struct {
|
||||
name string
|
||||
executor MiddlewareExecutor[T]
|
||||
order int
|
||||
async bool
|
||||
name string // Human-readable name for logging/debugging
|
||||
executor MiddlewareExecutor[T] // Function to execute
|
||||
order int // Optional sort order (not used yet)
|
||||
async bool // If true, runs in goroutine and doesn't block
|
||||
}
|
||||
|
||||
// NewMiddleware creates a new synchronous middleware.
|
||||
func NewMiddleware[T DbContext](name string, executor MiddlewareExecutor[T]) *Middleware[T] {
|
||||
return &Middleware[T]{name, executor, 0, false}
|
||||
}
|
||||
|
||||
// SetOrder sets the execution order (currently ignored).
|
||||
func (m *Middleware[T]) SetOrder(order int) *Middleware[T] {
|
||||
m.order = order
|
||||
return m
|
||||
}
|
||||
|
||||
// SetAsync marks the middleware to run asynchronously.
|
||||
// Execution continues regardless of its return value.
|
||||
func (m *Middleware[T]) SetAsync(async bool) *Middleware[T] {
|
||||
m.async = async
|
||||
return m
|
||||
}
|
||||
|
||||
// Execute runs the middleware.
|
||||
// If async, runs in a goroutine and returns true immediately.
|
||||
// Otherwise, returns the result of the executor.
|
||||
func (m *Middleware[T]) Execute(ctx *MsgContext, db *T) bool {
|
||||
if m.async {
|
||||
go m.executor(ctx, db)
|
||||
|
||||
136
runners.go
136
runners.go
@@ -1,55 +1,123 @@
|
||||
// Package laniakea provides a system for managing background and one-time
|
||||
// runner functions that operate on a Bot instance, with support for
|
||||
// asynchronous execution, timeouts, and lifecycle control.
|
||||
//
|
||||
// Runners are used for periodic tasks (e.g., cleanup, stats updates) or
|
||||
// one-time initialization logic. They are executed via Bot.ExecRunners().
|
||||
//
|
||||
// Important: Runners are not thread-safe for concurrent modification.
|
||||
// Builder methods (Onetime, Async, Timeout) must be called sequentially
|
||||
// and only before Execute().
|
||||
package laniakea
|
||||
|
||||
import (
|
||||
"time"
|
||||
)
|
||||
|
||||
// RunnerFn is the function type for a runner. It receives a pointer to
|
||||
// the Bot and returns an error if execution fails.
|
||||
type RunnerFn[T DbContext] func(*Bot[T]) error
|
||||
|
||||
// Runner represents a configurable background or one-time task to be
|
||||
// executed by a Bot.
|
||||
//
|
||||
// Runners are configured using builder methods: Onetime(), Async(), Timeout().
|
||||
// Once Execute() is called, the Runner should not be modified.
|
||||
//
|
||||
// Execution semantics:
|
||||
// - onetime=true, async=false: Run once synchronously (blocks).
|
||||
// - onetime=true, async=true: Run once in a goroutine (non-blocking).
|
||||
// - onetime=false, async=true: Run repeatedly in a goroutine with timeout.
|
||||
// - onetime=false, async=false: Invalid configuration — ignored with warning.
|
||||
type Runner[T DbContext] struct {
|
||||
name string
|
||||
onetime bool
|
||||
async bool
|
||||
timeout time.Duration
|
||||
fn RunnerFn[T]
|
||||
name string // Human-readable name for logging
|
||||
onetime bool // If true, runs once; if false, runs periodically
|
||||
async bool // If true, runs in a goroutine; else, runs synchronously
|
||||
timeout time.Duration // Duration to wait between periodic executions (ignored if onetime=true)
|
||||
fn RunnerFn[T] // The function to execute
|
||||
}
|
||||
|
||||
// NewRunner creates a new Runner with the given name and function.
|
||||
// By default, the Runner is configured as async=true (non-blocking).
|
||||
//
|
||||
// Builder methods (Onetime, Async, Timeout) can be chained to customize behavior.
|
||||
// DO NOT call builder methods concurrently or after Execute().
|
||||
func NewRunner[T DbContext](name string, fn RunnerFn[T]) *Runner[T] {
|
||||
return &Runner[T]{
|
||||
name: name, fn: fn, async: true,
|
||||
name: name,
|
||||
fn: fn,
|
||||
async: true, // Default: run asynchronously
|
||||
timeout: 0, // Default: no timeout (ignored if onetime=true)
|
||||
}
|
||||
}
|
||||
func (b *Runner[T]) Onetime(onetime bool) *Runner[T] {
|
||||
b.onetime = onetime
|
||||
return b
|
||||
}
|
||||
func (b *Runner[T]) Async(async bool) *Runner[T] {
|
||||
b.async = async
|
||||
return b
|
||||
}
|
||||
func (b *Runner[T]) Timeout(timeout time.Duration) *Runner[T] {
|
||||
b.timeout = timeout
|
||||
return b
|
||||
|
||||
// Onetime sets whether the runner executes once or repeatedly.
|
||||
// If true, the runner runs only once.
|
||||
// If false, the runner runs in a loop with the configured timeout.
|
||||
func (r *Runner[T]) Onetime(onetime bool) *Runner[T] {
|
||||
r.onetime = onetime
|
||||
return r
|
||||
}
|
||||
|
||||
// Async sets whether the runner executes synchronously or asynchronously.
|
||||
// If true, the runner runs in a goroutine (non-blocking).
|
||||
// If false, the runner blocks the caller during execution.
|
||||
//
|
||||
// Note: If onetime=false and async=false, the runner will be skipped with a warning.
|
||||
func (r *Runner[T]) Async(async bool) *Runner[T] {
|
||||
r.async = async
|
||||
return r
|
||||
}
|
||||
|
||||
// Timeout sets the duration to wait between repeated executions for
|
||||
// non-onetime runners.
|
||||
//
|
||||
// If onetime=true, this value is ignored.
|
||||
// If onetime=false and async=true, this timeout determines the sleep interval
|
||||
// between loop iterations.
|
||||
//
|
||||
// A zero value (time.Duration(0)) is allowed but may trigger a warning
|
||||
// if used with a background (non-onetime) async runner.
|
||||
func (r *Runner[T]) Timeout(timeout time.Duration) *Runner[T] {
|
||||
r.timeout = timeout
|
||||
return r
|
||||
}
|
||||
|
||||
// ExecRunners executes all runners registered on the Bot.
|
||||
//
|
||||
// It logs warnings for misconfigured runners:
|
||||
// - Sync, non-onetime runners are skipped (invalid configuration).
|
||||
// - Background (non-onetime, async) runners without a timeout trigger a warning.
|
||||
//
|
||||
// Execution logic:
|
||||
// - onetime + async: Runs once in a goroutine.
|
||||
// - onetime + sync: Runs once synchronously; warns if slower than 2 seconds.
|
||||
// - !onetime + async: Runs in an infinite loop with timeout between iterations.
|
||||
// - !onetime + sync: Skipped with warning.
|
||||
//
|
||||
// This method is typically called once during bot startup.
|
||||
func (bot *Bot[T]) ExecRunners() {
|
||||
bot.logger.Infoln("Executing runners...")
|
||||
for _, runner := range bot.runners {
|
||||
// Validate configuration
|
||||
if !runner.onetime && !runner.async {
|
||||
bot.logger.Warnf("Runner %s not onetime, but sync\n", runner.name)
|
||||
bot.logger.Warnf("Runner %s not onetime, but sync — skipping\n", runner.name)
|
||||
continue
|
||||
}
|
||||
if !runner.onetime && runner.async && runner.timeout == (time.Second*0) {
|
||||
bot.logger.Warnf("Background runner \"%s\" should have timeout", runner.name)
|
||||
if !runner.onetime && runner.async && runner.timeout == 0 {
|
||||
bot.logger.Warnf("Background runner \"%s\" has no timeout — may cause tight loop\n", runner.name)
|
||||
}
|
||||
|
||||
if runner.async && runner.onetime {
|
||||
go func() {
|
||||
err := runner.fn(bot)
|
||||
if runner.onetime && runner.async {
|
||||
// One-time async: fire and forget
|
||||
go func(r Runner[T]) {
|
||||
err := r.fn(bot)
|
||||
if err != nil {
|
||||
bot.logger.Warnf("Runner %s failed: %s\n", runner.name, err)
|
||||
bot.logger.Warnf("Runner %s failed: %s\n", r.name, err)
|
||||
}
|
||||
}()
|
||||
} else if !runner.async && runner.onetime {
|
||||
}(runner)
|
||||
} else if runner.onetime && !runner.async {
|
||||
// One-time sync: block until done
|
||||
t := time.Now()
|
||||
err := runner.fn(bot)
|
||||
if err != nil {
|
||||
@@ -57,18 +125,20 @@ func (bot *Bot[T]) ExecRunners() {
|
||||
}
|
||||
elapsed := time.Since(t)
|
||||
if elapsed > time.Second*2 {
|
||||
bot.logger.Warnf("Runner %s too slow. Elapsed time %s>=2s", runner.name, elapsed)
|
||||
bot.logger.Warnf("Runner %s too slow. Elapsed time %v >= 2s\n", runner.name, elapsed)
|
||||
}
|
||||
} else if !runner.onetime {
|
||||
go func() {
|
||||
} else if !runner.onetime && runner.async {
|
||||
// Background loop: periodic execution
|
||||
go func(r Runner[T]) {
|
||||
for {
|
||||
err := runner.fn(bot)
|
||||
err := r.fn(bot)
|
||||
if err != nil {
|
||||
bot.logger.Warnf("Runner %s failed: %s\n", runner.name, err)
|
||||
bot.logger.Warnf("Runner %s failed: %s\n", r.name, err)
|
||||
}
|
||||
time.Sleep(runner.timeout)
|
||||
time.Sleep(r.timeout)
|
||||
}
|
||||
}()
|
||||
}(runner)
|
||||
}
|
||||
// Note: !onetime && !async is already skipped above
|
||||
}
|
||||
}
|
||||
|
||||
241
tgapi/api.go
241
tgapi/api.go
@@ -4,7 +4,6 @@ import (
|
||||
"bytes"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
@@ -12,49 +11,73 @@ import (
|
||||
|
||||
"git.nix13.pw/scuroneko/laniakea/utils"
|
||||
"git.nix13.pw/scuroneko/slog"
|
||||
"golang.org/x/time/rate"
|
||||
)
|
||||
|
||||
// APIOpts holds configuration options for initializing the Telegram API client.
|
||||
// Use the provided setter methods to build options — do not construct directly.
|
||||
type APIOpts struct {
|
||||
token string
|
||||
client *http.Client
|
||||
useTestServer bool
|
||||
apiUrl string
|
||||
|
||||
limiter *rate.Limiter
|
||||
limiter *utils.RateLimiter
|
||||
dropOverflowLimit bool
|
||||
}
|
||||
|
||||
var ErrPoolUnexpected = errors.New("unexpected response from pool")
|
||||
|
||||
// NewAPIOpts creates a new APIOpts with default values.
|
||||
// Use setter methods to customize behavior.
|
||||
func NewAPIOpts(token string) *APIOpts {
|
||||
return &APIOpts{token: token, client: nil, useTestServer: false, apiUrl: "https://api.telegram.org"}
|
||||
return &APIOpts{
|
||||
token: token,
|
||||
client: nil,
|
||||
useTestServer: false,
|
||||
apiUrl: "https://api.telegram.org",
|
||||
}
|
||||
}
|
||||
|
||||
// SetHTTPClient sets a custom HTTP client. Use this for timeouts, proxies, or custom transport.
|
||||
// If not set, a default client with 45s timeout is used.
|
||||
func (opts *APIOpts) SetHTTPClient(client *http.Client) *APIOpts {
|
||||
if client != nil {
|
||||
opts.client = client
|
||||
}
|
||||
return opts
|
||||
}
|
||||
|
||||
// UseTestServer enables use of Telegram's test server (https://api.test.telegram.org).
|
||||
// Only for development/testing.
|
||||
func (opts *APIOpts) UseTestServer(use bool) *APIOpts {
|
||||
opts.useTestServer = use
|
||||
return opts
|
||||
}
|
||||
|
||||
// SetAPIUrl overrides the default Telegram API URL.
|
||||
// Useful for self-hosted bots or proxies.
|
||||
func (opts *APIOpts) SetAPIUrl(apiUrl string) *APIOpts {
|
||||
if apiUrl != "" {
|
||||
opts.apiUrl = apiUrl
|
||||
}
|
||||
return opts
|
||||
}
|
||||
func (opts *APIOpts) SetLimiter(limiter *rate.Limiter) *APIOpts {
|
||||
|
||||
// SetLimiter sets a rate limiter to enforce Telegram's API limits.
|
||||
// Recommended: use utils.NewRateLimiter() for correct per-chat and global throttling.
|
||||
func (opts *APIOpts) SetLimiter(limiter *utils.RateLimiter) *APIOpts {
|
||||
opts.limiter = limiter
|
||||
return opts
|
||||
}
|
||||
|
||||
// SetLimiterDrop enables "drop mode" for rate limiting.
|
||||
// If true, requests exceeding limits return ErrDropOverflow immediately.
|
||||
// If false, requests block until capacity is available.
|
||||
func (opts *APIOpts) SetLimiterDrop(b bool) *APIOpts {
|
||||
opts.dropOverflowLimit = b
|
||||
return opts
|
||||
}
|
||||
|
||||
// API is the main Telegram Bot API client.
|
||||
// It manages HTTP requests, rate limiting, retries, and connection pooling.
|
||||
type API struct {
|
||||
token string
|
||||
client *http.Client
|
||||
@@ -62,63 +85,116 @@ type API struct {
|
||||
useTestServer bool
|
||||
apiUrl string
|
||||
|
||||
pool *WorkerPool
|
||||
limiter *rate.Limiter
|
||||
pool *workerPool
|
||||
Limiter *utils.RateLimiter
|
||||
dropOverflowLimit bool
|
||||
}
|
||||
|
||||
// NewAPI creates a new API client from options.
|
||||
// Always call CloseApi() when done to release resources.
|
||||
func NewAPI(opts *APIOpts) *API {
|
||||
l := slog.CreateLogger().Level(utils.GetLoggerLevel()).Prefix("API")
|
||||
l.AddWriter(l.CreateJsonStdoutWriter())
|
||||
|
||||
client := opts.client
|
||||
if client == nil {
|
||||
client = &http.Client{Timeout: time.Second * 45}
|
||||
}
|
||||
pool := NewWorkerPool(16, 256)
|
||||
pool.Start(context.Background())
|
||||
|
||||
pool := newWorkerPool(16, 256)
|
||||
pool.start(context.Background())
|
||||
|
||||
return &API{
|
||||
opts.token, client, l,
|
||||
opts.useTestServer, opts.apiUrl,
|
||||
pool, opts.limiter, opts.dropOverflowLimit,
|
||||
token: opts.token,
|
||||
client: client,
|
||||
logger: l,
|
||||
useTestServer: opts.useTestServer,
|
||||
apiUrl: opts.apiUrl,
|
||||
pool: pool,
|
||||
Limiter: opts.limiter,
|
||||
dropOverflowLimit: opts.dropOverflowLimit,
|
||||
}
|
||||
}
|
||||
|
||||
// CloseApi shuts down the internal worker pool and closes the logger.
|
||||
// Must be called to avoid resource leaks.
|
||||
func (api *API) CloseApi() error {
|
||||
api.pool.Stop()
|
||||
api.pool.stop()
|
||||
return api.logger.Close()
|
||||
}
|
||||
func (api *API) GetLogger() *slog.Logger { return api.logger }
|
||||
|
||||
// GetLogger returns the internal logger for custom logging.
|
||||
func (api *API) GetLogger() *slog.Logger {
|
||||
return api.logger
|
||||
}
|
||||
|
||||
// ResponseParameters contains Telegram API response metadata (e.g., retry_after, migrate_to_chat_id).
|
||||
type ResponseParameters struct {
|
||||
MigrateToChatID *int64 `json:"migrate_to_chat_id,omitempty"`
|
||||
RetryAfter *int `json:"retry_after,omitempty"`
|
||||
}
|
||||
|
||||
// ApiResponse is the standard Telegram Bot API response structure.
|
||||
// Generic over Result type R.
|
||||
type ApiResponse[R any] struct {
|
||||
Ok bool `json:"ok"`
|
||||
Description string `json:"description,omitempty"`
|
||||
Result R `json:"result,omitempty"`
|
||||
ErrorCode int `json:"error_code,omitempty"`
|
||||
Parameters *ResponseParameters `json:"parameters,omitempty"`
|
||||
}
|
||||
|
||||
// TelegramRequest is an internal helper struct.
|
||||
// DO NOT USE NewRequest or NewRequestWithChatID — they are unsafe and discouraged.
|
||||
// Instead, use explicit methods like SendMessage, GetUpdates, etc.
|
||||
//
|
||||
// Why? Because using generics with arbitrary types P and R leads to:
|
||||
// - No compile-time validation of parameters
|
||||
// - No IDE autocompletion
|
||||
// - Runtime panics on malformed JSON
|
||||
// - Hard-to-debug errors
|
||||
//
|
||||
// Recommended: Define specific methods for each Telegram method (see below).
|
||||
type TelegramRequest[R, P any] struct {
|
||||
method string
|
||||
params P
|
||||
chatId int64
|
||||
}
|
||||
|
||||
// NewRequest and NewRequestWithChatID are DEPRECATED.
|
||||
// They encourage unsafe, untyped usage and bypass Go's type safety.
|
||||
// Instead, define explicit, type-safe methods for each Telegram API endpoint.
|
||||
//
|
||||
// Example:
|
||||
//
|
||||
// func (api *API) SendMessage(ctx context.Context, chatID int64, text string) (Message, error) { ... }
|
||||
//
|
||||
// This provides:
|
||||
//
|
||||
// ✅ Compile-time validation
|
||||
// ✅ IDE autocompletion
|
||||
// ✅ Clear API surface
|
||||
// ✅ Better error messages
|
||||
//
|
||||
// DO NOT use these constructors in production code.
|
||||
// This can be used ONLY for testing or if you NEED method, that wasn't added as function.
|
||||
func NewRequest[R, P any](method string, params P) TelegramRequest[R, P] {
|
||||
return TelegramRequest[R, P]{method: method, params: params}
|
||||
return TelegramRequest[R, P]{method, params, 0}
|
||||
}
|
||||
|
||||
func NewRequestWithChatID[R, P any](method string, params P, chatId int64) TelegramRequest[R, P] {
|
||||
return TelegramRequest[R, P]{method, params, chatId}
|
||||
}
|
||||
|
||||
// doRequest performs a single HTTP request to Telegram API.
|
||||
// Handles rate limiting, retries on 429, and parses responses.
|
||||
// Must be called within a worker pool context if using DoWithContext.
|
||||
func (r TelegramRequest[R, P]) doRequest(ctx context.Context, api *API) (R, error) {
|
||||
var zero R
|
||||
if api.limiter != nil {
|
||||
if api.dropOverflowLimit {
|
||||
if !api.limiter.Allow() {
|
||||
return zero, errors.New("rate limited")
|
||||
}
|
||||
} else {
|
||||
if err := api.limiter.Wait(ctx); err != nil {
|
||||
return zero, err
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
data, err := json.Marshal(r.params)
|
||||
if err != nil {
|
||||
return zero, err
|
||||
return zero, fmt.Errorf("failed to marshal request: %w", err)
|
||||
}
|
||||
buf := bytes.NewBuffer(data)
|
||||
|
||||
@@ -127,36 +203,81 @@ func (r TelegramRequest[R, P]) doRequest(ctx context.Context, api *API) (R, erro
|
||||
methodPrefix = "/test"
|
||||
}
|
||||
url := fmt.Sprintf("%s/bot%s%s/%s", api.apiUrl, api.token, methodPrefix, r.method)
|
||||
|
||||
req, err := http.NewRequestWithContext(ctx, "POST", url, buf)
|
||||
if err != nil {
|
||||
return zero, err
|
||||
return zero, fmt.Errorf("failed to create request: %w", err)
|
||||
}
|
||||
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
req.Header.Set("Accept", "application/json")
|
||||
req.Header.Set("User-Agent", fmt.Sprintf("Laniakea/%s", utils.VersionString))
|
||||
req.Header.Set("Accept-Encoding", "gzip")
|
||||
req.ContentLength = int64(len(data))
|
||||
|
||||
api.logger.Debugln("REQ", api.apiUrl, r.method, buf.String())
|
||||
res, err := api.client.Do(req)
|
||||
if err != nil {
|
||||
for {
|
||||
// Apply rate limiting before making the request
|
||||
if api.Limiter != nil {
|
||||
if err := api.Limiter.Check(ctx, api.dropOverflowLimit, r.chatId); err != nil {
|
||||
return zero, err
|
||||
}
|
||||
defer func(Body io.ReadCloser) {
|
||||
_ = Body.Close()
|
||||
}(res.Body)
|
||||
|
||||
data, err = readBody(res.Body)
|
||||
if err != nil {
|
||||
return zero, err
|
||||
}
|
||||
|
||||
api.logger.Debugln("REQ", url, string(data))
|
||||
resp, err := api.client.Do(req)
|
||||
if err != nil {
|
||||
return zero, fmt.Errorf("HTTP request failed: %w", err)
|
||||
}
|
||||
|
||||
data, err = readBody(resp.Body)
|
||||
_ = resp.Body.Close() // ensure body is closed
|
||||
if err != nil {
|
||||
return zero, fmt.Errorf("failed to read response body: %w", err)
|
||||
}
|
||||
|
||||
api.logger.Debugln("RES", r.method, string(data))
|
||||
if res.StatusCode != http.StatusOK {
|
||||
return zero, fmt.Errorf("unexpected status code: %d, %s", res.StatusCode, string(data))
|
||||
|
||||
response, err := parseBody[R](data)
|
||||
if err != nil {
|
||||
return zero, fmt.Errorf("failed to parse response: %w", err)
|
||||
}
|
||||
|
||||
if !response.Ok {
|
||||
// Handle rate limiting (429)
|
||||
if response.ErrorCode == 429 && response.Parameters != nil && response.Parameters.RetryAfter != nil {
|
||||
after := *response.Parameters.RetryAfter
|
||||
api.logger.Warnf("Rate limited by Telegram, retry after %d seconds (chat: %d)", after, r.chatId)
|
||||
|
||||
// Apply cooldown to global or chat-specific limiter
|
||||
if r.chatId > 0 {
|
||||
api.Limiter.SetChatLock(r.chatId, after)
|
||||
} else {
|
||||
api.Limiter.SetGlobalLock(after)
|
||||
}
|
||||
|
||||
// Wait and retry
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
return zero, ctx.Err()
|
||||
case <-time.After(time.Duration(after) * time.Second):
|
||||
continue // retry request
|
||||
}
|
||||
}
|
||||
|
||||
// Other API errors
|
||||
return zero, fmt.Errorf("[%d] %s", response.ErrorCode, response.Description)
|
||||
}
|
||||
|
||||
return response.Result, nil
|
||||
}
|
||||
return parseBody[R](data)
|
||||
}
|
||||
|
||||
// DoWithContext executes the request asynchronously via the worker pool.
|
||||
// Returns result or error via channel. Respects context cancellation.
|
||||
func (r TelegramRequest[R, P]) DoWithContext(ctx context.Context, api *API) (R, error) {
|
||||
var zero R
|
||||
result, err := api.pool.Submit(ctx, func(ctx context.Context) (any, error) {
|
||||
|
||||
resultChan, err := api.pool.submit(ctx, func(ctx context.Context) (any, error) {
|
||||
return r.doRequest(ctx, api)
|
||||
})
|
||||
if err != nil {
|
||||
@@ -166,33 +287,45 @@ func (r TelegramRequest[R, P]) DoWithContext(ctx context.Context, api *API) (R,
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
return zero, ctx.Err()
|
||||
case res := <-result:
|
||||
if res.Err != nil {
|
||||
return zero, res.Err
|
||||
case res := <-resultChan:
|
||||
if res.err != nil {
|
||||
return zero, res.err
|
||||
}
|
||||
if val, ok := res.Value.(R); ok {
|
||||
if val, ok := res.value.(R); ok {
|
||||
return val, nil
|
||||
}
|
||||
return zero, ErrPoolUnexpected
|
||||
}
|
||||
}
|
||||
|
||||
// Do executes the request synchronously with a background context.
|
||||
// Use only for simple, non-critical calls.
|
||||
func (r TelegramRequest[R, P]) Do(api *API) (R, error) {
|
||||
return r.DoWithContext(context.Background(), api)
|
||||
}
|
||||
|
||||
// readBody reads and limits response body to prevent memory exhaustion.
|
||||
// Telegram responses are typically small (<1MB), but we cap at 10MB.
|
||||
func readBody(body io.ReadCloser) ([]byte, error) {
|
||||
reader := io.LimitReader(body, 10<<20)
|
||||
reader := io.LimitReader(body, 10<<20) // 10 MB
|
||||
return io.ReadAll(reader)
|
||||
}
|
||||
func parseBody[R any](data []byte) (R, error) {
|
||||
var zero R
|
||||
|
||||
// parseBody unmarshals Telegram API response and returns structured result.
|
||||
// Returns ErrRateLimit internally if error_code == 429 — caller must handle via response.Ok check.
|
||||
func parseBody[R any](data []byte) (ApiResponse[R], error) {
|
||||
var resp ApiResponse[R]
|
||||
err := json.Unmarshal(data, &resp)
|
||||
if err != nil {
|
||||
return zero, err
|
||||
return resp, fmt.Errorf("failed to unmarshal JSON: %w", err)
|
||||
}
|
||||
|
||||
if !resp.Ok {
|
||||
return zero, fmt.Errorf("[%d] %s", resp.ErrorCode, resp.Description)
|
||||
if resp.ErrorCode == 429 {
|
||||
return resp, ErrRateLimit // internal use only
|
||||
}
|
||||
return resp.Result, nil
|
||||
return resp, fmt.Errorf("[%d] %s", resp.ErrorCode, resp.Description)
|
||||
}
|
||||
|
||||
return resp, nil
|
||||
}
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
package tgapi
|
||||
|
||||
// SendPhotoP holds parameters for the sendPhoto method.
|
||||
// See https://core.telegram.org/bots/api#sendphoto
|
||||
type SendPhotoP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
|
||||
@@ -23,14 +25,18 @@ type SendPhotoP struct {
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendPhoto sends a photo.
|
||||
// See https://core.telegram.org/bots/api#sendphoto
|
||||
func (api *API) SendPhoto(params SendPhotoP) (Message, error) {
|
||||
req := NewRequest[Message]("sendPhoto", params)
|
||||
req := NewRequestWithChatID[Message]("sendPhoto", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SendAudioP holds parameters for the sendAudio method.
|
||||
// See https://core.telegram.org/bots/api#sendaudio
|
||||
type SendAudioP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
|
||||
@@ -52,14 +58,18 @@ type SendAudioP struct {
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendAudio sends an audio file.
|
||||
// See https://core.telegram.org/bots/api#sendaudio
|
||||
func (api *API) SendAudio(params SendAudioP) (Message, error) {
|
||||
req := NewRequest[Message]("sendAudio", params)
|
||||
req := NewRequestWithChatID[Message]("sendAudio", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SendDocumentP holds parameters for the sendDocument method.
|
||||
// See https://core.telegram.org/bots/api#senddocument
|
||||
type SendDocumentP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
|
||||
@@ -78,14 +88,18 @@ type SendDocumentP struct {
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendDocument sends a document.
|
||||
// See https://core.telegram.org/bots/api#senddocument
|
||||
func (api *API) SendDocument(params SendDocumentP) (Message, error) {
|
||||
req := NewRequest[Message]("sendDocument", params)
|
||||
req := NewRequestWithChatID[Message]("sendDocument", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SendVideoP holds parameters for the sendVideo method.
|
||||
// See https://core.telegram.org/bots/api#sendvideo
|
||||
type SendVideoP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
|
||||
@@ -113,14 +127,18 @@ type SendVideoP struct {
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendVideo sends a video.
|
||||
// See https://core.telegram.org/bots/api#sendvideo
|
||||
func (api *API) SendVideo(params SendVideoP) (Message, error) {
|
||||
req := NewRequest[Message]("sendVideo", params)
|
||||
req := NewRequestWithChatID[Message]("sendVideo", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SendAnimationP holds parameters for the sendAnimation method.
|
||||
// See https://core.telegram.org/bots/api#sendanimation
|
||||
type SendAnimationP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
|
||||
@@ -144,14 +162,18 @@ type SendAnimationP struct {
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendAnimation sends an animation file (GIF or H.264/MPEG-4 AVC video without sound).
|
||||
// See https://core.telegram.org/bots/api#sendanimation
|
||||
func (api *API) SendAnimation(params SendAnimationP) (Message, error) {
|
||||
req := NewRequest[Message]("sendAnimation", params)
|
||||
req := NewRequestWithChatID[Message]("sendAnimation", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SendVoiceP holds parameters for the sendVoice method.
|
||||
// See https://core.telegram.org/bots/api#sendvoice
|
||||
type SendVoiceP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
|
||||
@@ -170,14 +192,18 @@ type SendVoiceP struct {
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendVoice sends a voice note.
|
||||
// See https://core.telegram.org/bots/api#sendvoice
|
||||
func (api *API) SendVoice(params *SendVoiceP) (Message, error) {
|
||||
req := NewRequest[Message]("sendVoice", params)
|
||||
req := NewRequestWithChatID[Message]("sendVoice", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SendVideoNoteP holds parameters for the sendVideoNote method.
|
||||
// See https://core.telegram.org/bots/api#sendvideonote
|
||||
type SendVideoNoteP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
|
||||
@@ -194,14 +220,18 @@ type SendVideoNoteP struct {
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendVideoNote sends a video note (rounded video message).
|
||||
// See https://core.telegram.org/bots/api#sendvideonote
|
||||
func (api *API) SendVideoNote(params SendVideoNoteP) (Message, error) {
|
||||
req := NewRequest[Message]("sendVideoNote", params)
|
||||
req := NewRequestWithChatID[Message]("sendVideoNote", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SendPaidMediaP holds parameters for the sendPaidMedia method.
|
||||
// See https://core.telegram.org/bots/api#sendpaidmedia
|
||||
type SendPaidMediaP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
StarCount int `json:"star_count,omitempty"`
|
||||
@@ -221,14 +251,18 @@ type SendPaidMediaP struct {
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendPaidMedia sends paid media.
|
||||
// See https://core.telegram.org/bots/api#sendpaidmedia
|
||||
func (api *API) SendPaidMedia(params SendPaidMediaP) (Message, error) {
|
||||
req := NewRequest[Message]("sendPaidMedia", params)
|
||||
req := NewRequestWithChatID[Message]("sendPaidMedia", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SendMediaGroupP holds parameters for the sendMediaGroup method.
|
||||
// See https://core.telegram.org/bots/api#sendmediagroup
|
||||
type SendMediaGroupP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
|
||||
@@ -240,7 +274,9 @@ type SendMediaGroupP struct {
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
}
|
||||
|
||||
// SendMediaGroup sends a group of photos, videos, documents or audios as an album.
|
||||
// See https://core.telegram.org/bots/api#sendmediagroup
|
||||
func (api *API) SendMediaGroup(params SendMediaGroupP) (Message, error) {
|
||||
req := NewRequest[Message]("sendMediaGroup", params)
|
||||
req := NewRequestWithChatID[Message]("sendMediaGroup", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
@@ -1,5 +1,23 @@
|
||||
package tgapi
|
||||
|
||||
// InputMediaType represents the type of input media.
|
||||
type InputMediaType string
|
||||
|
||||
const (
|
||||
// InputMediaTypeAnimation is a GIF or H.264/MPEG-4 AVC video without sound.
|
||||
InputMediaTypeAnimation InputMediaType = "animation"
|
||||
// InputMediaTypeDocument is a general file.
|
||||
InputMediaTypeDocument InputMediaType = "document"
|
||||
// InputMediaTypePhoto is a photo.
|
||||
InputMediaTypePhoto InputMediaType = "photo"
|
||||
// InputMediaTypeVideo is a video.
|
||||
InputMediaTypeVideo InputMediaType = "video"
|
||||
// InputMediaTypeAudio is an audio file.
|
||||
InputMediaTypeAudio InputMediaType = "audio"
|
||||
)
|
||||
|
||||
// InputMedia represents the content of a media message to be sent.
|
||||
// It is a union type described in https://core.telegram.org/bots/api#inputmedia.
|
||||
type InputMedia struct {
|
||||
Type InputMediaType `json:"type"`
|
||||
Media string `json:"media"`
|
||||
@@ -21,23 +39,18 @@ type InputMedia struct {
|
||||
Title *string `json:"title,omitempty"`
|
||||
}
|
||||
|
||||
type InputMediaType string
|
||||
|
||||
const (
|
||||
InputMediaTypeAnimation InputMediaType = "animation"
|
||||
InputMediaTypeDocument InputMediaType = "document"
|
||||
InputMediaTypePhoto InputMediaType = "photo"
|
||||
InputMediaTypeVideo InputMediaType = "video"
|
||||
InputMediaTypeAudio InputMediaType = "audio"
|
||||
)
|
||||
|
||||
// InputPaidMediaType represents the type of paid media.
|
||||
type InputPaidMediaType string
|
||||
|
||||
const (
|
||||
// InputPaidMediaTypeVideo represents a paid video.
|
||||
InputPaidMediaTypeVideo InputPaidMediaType = "video"
|
||||
// InputPaidMediaTypePhoto represents a paid photo.
|
||||
InputPaidMediaTypePhoto InputPaidMediaType = "photo"
|
||||
)
|
||||
|
||||
// InputPaidMedia describes the paid media to be sent.
|
||||
// See https://core.telegram.org/bots/api#inputpaidmedia
|
||||
type InputPaidMedia struct {
|
||||
Type InputPaidMediaType `json:"type"`
|
||||
Media string `json:"media"`
|
||||
@@ -50,6 +63,8 @@ type InputPaidMedia struct {
|
||||
SupportsStreaming bool `json:"supports_streaming"`
|
||||
}
|
||||
|
||||
// PhotoSize represents one size of a photo or a file/sticker thumbnail.
|
||||
// See https://core.telegram.org/bots/api#photosize
|
||||
type PhotoSize struct {
|
||||
FileID string `json:"file_id"`
|
||||
FileUniqueID string `json:"file_unique_id"`
|
||||
|
||||
@@ -1,149 +1,221 @@
|
||||
package tgapi
|
||||
|
||||
// SetMyCommandsP holds parameters for the setMyCommands method.
|
||||
// See https://core.telegram.org/bots/api#setmycommands
|
||||
type SetMyCommandsP struct {
|
||||
Commands []BotCommand `json:"commands"`
|
||||
Scope *BotCommandScope `json:"scope,omitempty"`
|
||||
Language string `json:"language_code,omitempty"`
|
||||
}
|
||||
|
||||
// SetMyCommands changes the list of the bot's commands.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#setmycommands
|
||||
func (api *API) SetMyCommands(params SetMyCommandsP) (bool, error) {
|
||||
req := NewRequest[bool]("setMyCommands", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// DeleteMyCommandsP holds parameters for the deleteMyCommands method.
|
||||
// See https://core.telegram.org/bots/api#deletemycommands
|
||||
type DeleteMyCommandsP struct {
|
||||
Scope *BotCommandScope `json:"scope,omitempty"`
|
||||
Language string `json:"language_code,omitempty"`
|
||||
}
|
||||
|
||||
// DeleteMyCommands deletes the list of the bot's commands for the given scope and user language.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#deletemycommands
|
||||
func (api *API) DeleteMyCommands(params DeleteMyCommandsP) (bool, error) {
|
||||
req := NewRequest[bool]("deleteMyCommands", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// GetMyCommands holds parameters for the getMyCommands method.
|
||||
// See https://core.telegram.org/bots/api#getmycommands
|
||||
type GetMyCommands struct {
|
||||
Scope *BotCommandScope `json:"scope,omitempty"`
|
||||
Language string `json:"language_code,omitempty"`
|
||||
}
|
||||
|
||||
// GetMyCommands returns the current list of the bot's commands for the given scope and user language.
|
||||
// See https://core.telegram.org/bots/api#getmycommands
|
||||
func (api *API) GetMyCommands(params GetMyCommands) ([]BotCommand, error) {
|
||||
req := NewRequest[[]BotCommand]("getMyCommands", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetMyName holds parameters for the setMyName method.
|
||||
// See https://core.telegram.org/bots/api#setmyname
|
||||
type SetMyName struct {
|
||||
Name string `json:"name"`
|
||||
Language string `json:"language_code,omitempty"`
|
||||
}
|
||||
|
||||
// SetMyName changes the bot's name.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#setmyname
|
||||
func (api *API) SetMyName(params SetMyName) (bool, error) {
|
||||
req := NewRequest[bool]("setMyName", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// GetMyName holds parameters for the getMyName method.
|
||||
// See https://core.telegram.org/bots/api#getmyname
|
||||
type GetMyName struct {
|
||||
Language string `json:"language_code,omitempty"`
|
||||
}
|
||||
|
||||
// GetMyName returns the bot's name for the given language.
|
||||
// See https://core.telegram.org/bots/api#getmyname
|
||||
func (api *API) GetMyName(params GetMyName) (BotName, error) {
|
||||
req := NewRequest[BotName]("getMyName", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetMyDescription holds parameters for the setMyDescription method.
|
||||
// See https://core.telegram.org/bots/api#setmydescription
|
||||
type SetMyDescription struct {
|
||||
Description string `json:"description"`
|
||||
Language string `json:"language_code,omitempty"`
|
||||
}
|
||||
|
||||
// SetMyDescription changes the bot's description.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#setmydescription
|
||||
func (api *API) SetMyDescription(params SetMyDescription) (bool, error) {
|
||||
req := NewRequest[bool]("setMyDescription", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// GetMyDescription holds parameters for the getMyDescription method.
|
||||
// See https://core.telegram.org/bots/api#getmydescription
|
||||
type GetMyDescription struct {
|
||||
Language string `json:"language_code,omitempty"`
|
||||
}
|
||||
|
||||
// GetMyDescription returns the bot's description for the given language.
|
||||
// See https://core.telegram.org/bots/api#getmydescription
|
||||
func (api *API) GetMyDescription(params GetMyDescription) (BotDescription, error) {
|
||||
req := NewRequest[BotDescription]("getMyDescription", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetMyShortDescription holds parameters for the setMyShortDescription method.
|
||||
// See https://core.telegram.org/bots/api#setmyshortdescription
|
||||
type SetMyShortDescription struct {
|
||||
ShortDescription string `json:"short_description,omitempty"`
|
||||
Language string `json:"language_code,omitempty"`
|
||||
}
|
||||
|
||||
// SetMyShortDescription changes the bot's short description.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#setmyshortdescription
|
||||
func (api *API) SetMyShortDescription(params SetMyShortDescription) (bool, error) {
|
||||
req := NewRequest[bool]("setMyShortDescription", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// GetMyShortDescription holds parameters for the getMyShortDescription method.
|
||||
// See https://core.telegram.org/bots/api#getmyshortdescription
|
||||
type GetMyShortDescription struct {
|
||||
Language string `json:"language_code,omitempty"`
|
||||
}
|
||||
|
||||
// GetMyShortDescription returns the bot's short description for the given language.
|
||||
// See https://core.telegram.org/bots/api#getmyshortdescription
|
||||
func (api *API) GetMyShortDescription(params GetMyShortDescription) (BotShortDescription, error) {
|
||||
req := NewRequest[BotShortDescription]("getMyShortDescription", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetMyProfilePhotoP holds parameters for the setMyProfilePhoto method.
|
||||
// See https://core.telegram.org/bots/api#setmyprofilephoto
|
||||
type SetMyProfilePhotoP struct {
|
||||
Photo InputProfilePhoto `json:"photo"`
|
||||
}
|
||||
|
||||
// SetMyProfilePhoto changes the bot's profile photo.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#setmyprofilephoto
|
||||
func (api *API) SetMyProfilePhoto(params SetMyProfilePhotoP) (bool, error) {
|
||||
req := NewRequest[bool]("setMyProfilePhoto", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// RemoveMyProfilePhoto removes the bot's profile photo.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#removemyprofilephoto
|
||||
func (api *API) RemoveMyProfilePhoto() (bool, error) {
|
||||
req := NewRequest[bool]("removeMyProfilePhoto", NoParams)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetChatMenuButtonP holds parameters for the setChatMenuButton method.
|
||||
// See https://core.telegram.org/bots/api#setchatmenubutton
|
||||
type SetChatMenuButtonP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
MenuButton MenuButtonType `json:"menu_button"`
|
||||
}
|
||||
|
||||
// SetChatMenuButton changes the menu button for a given chat or the default menu button.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#setchatmenubutton
|
||||
func (api *API) SetChatMenuButton(params SetChatMenuButtonP) (bool, error) {
|
||||
req := NewRequest[bool]("setChatMenuButton", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// GetChatMenuButtonP holds parameters for the getChatMenuButton method.
|
||||
// See https://core.telegram.org/bots/api#getchatmenubutton
|
||||
type GetChatMenuButtonP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
}
|
||||
|
||||
// GetChatMenuButton returns the current menu button for the given chat.
|
||||
// See https://core.telegram.org/bots/api#getchatmenubutton
|
||||
func (api *API) GetChatMenuButton(params GetChatMenuButtonP) (BaseMenuButton, error) {
|
||||
req := NewRequest[BaseMenuButton]("getChatMenuButton", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetMyDefaultAdministratorRightsP holds parameters for the setMyDefaultAdministratorRights method.
|
||||
// See https://core.telegram.org/bots/api#setmydefaultadministratorrights
|
||||
type SetMyDefaultAdministratorRightsP struct {
|
||||
Rights *ChatAdministratorRights `json:"rights"`
|
||||
ForChannels bool `json:"for_channels"`
|
||||
}
|
||||
|
||||
// SetMyDefaultAdministratorRights changes the default administrator rights for the bot.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#setmydefaultadministratorrights
|
||||
func (api *API) SetMyDefaultAdministratorRights(params SetMyDefaultAdministratorRightsP) (bool, error) {
|
||||
req := NewRequest[bool]("setMyDefaultAdministratorRights", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// GetMyDefaultAdministratorRightsP holds parameters for the getMyDefaultAdministratorRights method.
|
||||
// See https://core.telegram.org/bots/api#getmydefaultadministratorrights
|
||||
type GetMyDefaultAdministratorRightsP struct {
|
||||
ForChannels bool `json:"for_channels"`
|
||||
}
|
||||
|
||||
// GetMyDefaultAdministratorRights returns the current default administrator rights for the bot.
|
||||
// See https://core.telegram.org/bots/api#getmydefaultadministratorrights
|
||||
func (api *API) GetMyDefaultAdministratorRights(params GetMyDefaultAdministratorRightsP) (ChatAdministratorRights, error) {
|
||||
req := NewRequest[ChatAdministratorRights]("getMyDefaultAdministratorRights", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// GetAvailableGifts returns the list of gifts that can be sent by the bot.
|
||||
// See https://core.telegram.org/bots/api#getavailablegifts
|
||||
func (api *API) GetAvailableGifts() (Gifts, error) {
|
||||
req := NewRequest[Gifts]("getAvailableGifts", NoParams)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SendGiftP holds parameters for the sendGift method.
|
||||
// See https://core.telegram.org/bots/api#sendgift
|
||||
type SendGiftP struct {
|
||||
UserID int `json:"user_id,omitempty"`
|
||||
ChatID int `json:"chat_id,omitempty"`
|
||||
@@ -154,11 +226,16 @@ type SendGiftP struct {
|
||||
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
||||
}
|
||||
|
||||
// SendGift sends a gift to the given user or chat.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#sendgift
|
||||
func (api *API) SendGift(params SendGiftP) (bool, error) {
|
||||
req := NewRequest[bool]("sendGift", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// GiftPremiumSubscriptionP holds parameters for the giftPremiumSubscription method.
|
||||
// See https://core.telegram.org/bots/api#giftpremiumsubscription
|
||||
type GiftPremiumSubscriptionP struct {
|
||||
UserID int `json:"user_id"`
|
||||
MonthCount int `json:"month_count"`
|
||||
@@ -168,6 +245,9 @@ type GiftPremiumSubscriptionP struct {
|
||||
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
||||
}
|
||||
|
||||
// GiftPremiumSubscription gifts a Telegram Premium subscription to the user.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#giftpremiumsubscription
|
||||
func (api *API) GiftPremiumSubscription(params GiftPremiumSubscriptionP) (bool, error) {
|
||||
req := NewRequest[bool]("giftPremiumSubscription", params)
|
||||
return req.Do(api)
|
||||
|
||||
@@ -1,64 +1,91 @@
|
||||
package tgapi
|
||||
|
||||
// BotCommand represents a bot command.
|
||||
// See https://core.telegram.org/bots/api#botcommand
|
||||
type BotCommand struct {
|
||||
Command string `json:"command"`
|
||||
Description string `json:"description"`
|
||||
}
|
||||
|
||||
// BotCommandScopeType indicates the type of a command scope.
|
||||
type BotCommandScopeType string
|
||||
|
||||
const (
|
||||
// BotCommandScopeDefaultType is the default command scope.
|
||||
BotCommandScopeDefaultType BotCommandScopeType = "default"
|
||||
// BotCommandScopePrivateType covers all private chats.
|
||||
BotCommandScopePrivateType BotCommandScopeType = "all_private_chats"
|
||||
// BotCommandScopeGroupType covers all group and supergroup chats.
|
||||
BotCommandScopeGroupType BotCommandScopeType = "all_group_chats"
|
||||
// BotCommandScopeAllChatAdministratorsType covers all chat administrators.
|
||||
BotCommandScopeAllChatAdministratorsType BotCommandScopeType = "all_chat_administrators"
|
||||
// BotCommandScopeChatType covers a specific chat.
|
||||
BotCommandScopeChatType BotCommandScopeType = "chat"
|
||||
// BotCommandScopeChatAdministratorsType covers administrators of a specific chat.
|
||||
BotCommandScopeChatAdministratorsType BotCommandScopeType = "chat_administrators"
|
||||
// BotCommandScopeChatMemberType covers a specific member of a specific chat.
|
||||
BotCommandScopeChatMemberType BotCommandScopeType = "chat_member"
|
||||
)
|
||||
|
||||
// BotCommandScope represents the scope to which bot commands are applied.
|
||||
// See https://core.telegram.org/bots/api#botcommandscope
|
||||
type BotCommandScope struct {
|
||||
Type BotCommandScopeType `json:"type"`
|
||||
ChatID *int `json:"chat_id,omitempty"`
|
||||
UserID *int `json:"user_id,omitempty"`
|
||||
}
|
||||
|
||||
// BotName represents the bot's name.
|
||||
type BotName struct {
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
// BotDescription represents the bot's description.
|
||||
type BotDescription struct {
|
||||
Description string `json:"description"`
|
||||
}
|
||||
|
||||
// BotShortDescription represents the bot's short description.
|
||||
type BotShortDescription struct {
|
||||
ShortDescription string `json:"short_description"`
|
||||
}
|
||||
|
||||
// InputProfilePhotoType indicates the type of a profile photo input.
|
||||
type InputProfilePhotoType string
|
||||
|
||||
const (
|
||||
InputProfilePhotoStaticType InputProfilePhotoType = "static"
|
||||
InputProfilePhotoAnimatedType InputProfilePhotoType = "animated"
|
||||
)
|
||||
|
||||
type InputProfilePhotoType string
|
||||
// InputProfilePhoto describes a profile photo to set.
|
||||
// See https://core.telegram.org/bots/api#inputprofilephoto
|
||||
type InputProfilePhoto struct {
|
||||
Type InputProfilePhotoType `json:"type"`
|
||||
|
||||
// Static
|
||||
// Static fields (for static photos)
|
||||
Photo *string `json:"photo,omitempty"`
|
||||
|
||||
// Animated
|
||||
// Animated fields (for animated profile videos)
|
||||
Animation *string `json:"animation,omitempty"`
|
||||
MainFrameTimestamp *float64 `json:"main_frame_timestamp,omitempty"`
|
||||
}
|
||||
|
||||
// MenuButtonType indicates the type of a menu button.
|
||||
type MenuButtonType string
|
||||
|
||||
const (
|
||||
MenuButtonCommandsType MenuButtonType = "commands"
|
||||
MenuButtonWebAppType MenuButtonType = "web_app"
|
||||
MenuButtonDefaultType MenuButtonType = "default"
|
||||
)
|
||||
|
||||
type MenuButtonType string
|
||||
// BaseMenuButton represents a menu button.
|
||||
// See https://core.telegram.org/bots/api#menubutton
|
||||
type BaseMenuButton struct {
|
||||
Type MenuButtonType `json:"type"`
|
||||
// WebApp
|
||||
|
||||
// WebApp fields (for web_app button)
|
||||
Text string `json:"text"`
|
||||
WebApp WebAppInfo `json:"web_app"`
|
||||
}
|
||||
|
||||
@@ -1,146 +1,217 @@
|
||||
package tgapi
|
||||
|
||||
// VerifyUserP holds parameters for the verifyUser method.
|
||||
// See https://core.telegram.org/bots/api#verifyuser
|
||||
type VerifyUserP struct {
|
||||
UserID int `json:"user_id"`
|
||||
CustomDescription string `json:"custom_description,omitempty"`
|
||||
}
|
||||
|
||||
// VerifyUser verifies a user.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#verifyuser
|
||||
func (api *API) VerifyUser(params VerifyUserP) (bool, error) {
|
||||
req := NewRequest[bool]("verifyUser", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// VerifyChatP holds parameters for the verifyChat method.
|
||||
// See https://core.telegram.org/bots/api#verifychat
|
||||
type VerifyChatP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
CustomDescription string `json:"custom_description,omitempty"`
|
||||
}
|
||||
|
||||
// VerifyChat verifies a chat.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#verifychat
|
||||
func (api *API) VerifyChat(params VerifyChatP) (bool, error) {
|
||||
req := NewRequest[bool]("verifyChat", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// RemoveUserVerificationP holds parameters for the removeUserVerification method.
|
||||
// See https://core.telegram.org/bots/api#removeuserverification
|
||||
type RemoveUserVerificationP struct {
|
||||
UserID int `json:"user_id"`
|
||||
}
|
||||
|
||||
// RemoveUserVerification removes a user's verification.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#removeuserverification
|
||||
func (api *API) RemoveUserVerification(params RemoveUserVerificationP) (bool, error) {
|
||||
req := NewRequest[bool]("removeUserVerification", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// RemoveChatVerificationP holds parameters for the removeChatVerification method.
|
||||
// See https://core.telegram.org/bots/api#removechatverification
|
||||
type RemoveChatVerificationP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
}
|
||||
|
||||
// RemoveChatVerification removes a chat's verification.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#removechatverification
|
||||
func (api *API) RemoveChatVerification(params RemoveChatVerificationP) (bool, error) {
|
||||
req := NewRequest[bool]("removeChatVerification", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// ReadBusinessMessageP holds parameters for the readBusinessMessage method.
|
||||
// See https://core.telegram.org/bots/api#readbusinessmessage
|
||||
type ReadBusinessMessageP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
ChatID int `json:"chat_id"`
|
||||
MessageID int `json:"message_id"`
|
||||
}
|
||||
|
||||
// ReadBusinessMessage marks a business message as read.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#readbusinessmessage
|
||||
func (api *API) ReadBusinessMessage(params ReadBusinessMessageP) (bool, error) {
|
||||
req := NewRequest[bool]("readBusinessMessage", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// DeleteBusinessMessageP holds parameters for the deleteBusinessMessage method.
|
||||
// See https://core.telegram.org/bots/api#deletebusinessmessage
|
||||
type DeleteBusinessMessageP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
MessageIDs []int `json:"message_ids"`
|
||||
}
|
||||
|
||||
// DeleteBusinessMessage deletes business messages.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#deletebusinessmessage
|
||||
func (api *API) DeleteBusinessMessage(params DeleteBusinessMessageP) (bool, error) {
|
||||
req := NewRequest[bool]("deleteBusinessMessage", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetBusinessAccountNameP holds parameters for the setBusinessAccountName method.
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountname
|
||||
type SetBusinessAccountNameP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
FirstName string `json:"first_name"`
|
||||
LastName string `json:"last_name,omitempty"`
|
||||
}
|
||||
|
||||
// SetBusinessAccountName sets the first and last name of a business account.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountname
|
||||
func (api *API) SetBusinessAccountName(params SetBusinessAccountNameP) (bool, error) {
|
||||
req := NewRequest[bool]("setBusinessAccountName", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetBusinessAccountUsernameP holds parameters for the setBusinessAccountUsername method.
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountusername
|
||||
type SetBusinessAccountUsernameP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
Username string `json:"username,omitempty"`
|
||||
}
|
||||
|
||||
// SetBusinessAccountUsername sets the username of a business account.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountusername
|
||||
func (api *API) SetBusinessAccountUsername(params SetBusinessAccountUsernameP) (bool, error) {
|
||||
req := NewRequest[bool]("setBusinessAccountUsername", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetBusinessAccountBioP holds parameters for the setBusinessAccountBio method.
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountbio
|
||||
type SetBusinessAccountBioP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
Bio string `json:"bio,omitempty"`
|
||||
}
|
||||
|
||||
// SetBusinessAccountBio sets the bio of a business account.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountbio
|
||||
func (api *API) SetBusinessAccountBio(params SetBusinessAccountBioP) (bool, error) {
|
||||
req := NewRequest[bool]("setBusinessAccountBio", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetBusinessAccountProfilePhoto holds parameters for the setBusinessAccountProfilePhoto method.
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountprofilephoto
|
||||
type SetBusinessAccountProfilePhoto struct {
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
Photo InputProfilePhoto `json:"photo,omitempty"`
|
||||
IsPublic bool `json:"is_public,omitempty"`
|
||||
}
|
||||
|
||||
// SetBusinessAccountProfilePhoto sets the profile photo of a business account.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountprofilephoto
|
||||
func (api *API) SetBusinessAccountProfilePhoto(params SetBusinessAccountProfilePhoto) (bool, error) {
|
||||
req := NewRequest[bool]("setBusinessAccountProfilePhoto", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// RemoveBusinessAccountProfilePhotoP holds parameters for the removeBusinessAccountProfilePhoto method.
|
||||
// See https://core.telegram.org/bots/api#removebusinessaccountprofilephoto
|
||||
type RemoveBusinessAccountProfilePhotoP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
IsPublic bool `json:"is_public,omitempty"`
|
||||
}
|
||||
|
||||
// RemoveBusinessAccountProfilePhoto removes the profile photo of a business account.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#removebusinessaccountprofilephoto
|
||||
func (api *API) RemoveBusinessAccountProfilePhoto(params RemoveBusinessAccountProfilePhotoP) (bool, error) {
|
||||
req := NewRequest[bool]("removeBusinessAccountProfilePhoto", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetBusinessAccountGiftSettingsP holds parameters for the setBusinessAccountGiftSettings method.
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountgiftsettings
|
||||
type SetBusinessAccountGiftSettingsP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
ShowGiftButton bool `json:"show_gift_button"`
|
||||
AcceptedGiftTypes AcceptedGiftTypes `json:"accepted_gift_types"`
|
||||
}
|
||||
|
||||
// SetBusinessAccountGiftSettings sets gift settings for a business account.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountgiftsettings
|
||||
func (api *API) SetBusinessAccountGiftSettings(params SetBusinessAccountGiftSettingsP) (bool, error) {
|
||||
req := NewRequest[bool]("setBusinessAccountGiftSettings", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// GetBusinessAccountStarBalanceP holds parameters for the getBusinessAccountStarBalance method.
|
||||
// See https://core.telegram.org/bots/api#getbusinessaccountstarbalance
|
||||
type GetBusinessAccountStarBalanceP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
}
|
||||
|
||||
// GetBusinessAccountStarBalance returns the star balance of a business account.
|
||||
// See https://core.telegram.org/bots/api#getbusinessaccountstarbalance
|
||||
func (api *API) GetBusinessAccountStarBalance(params GetBusinessAccountStarBalanceP) (StarAmount, error) {
|
||||
req := NewRequest[StarAmount]("getBusinessAccountGiftSettings", params)
|
||||
req := NewRequest[StarAmount]("getBusinessAccountGiftSettings", params) // Note: method name in call is incorrect, should be "getBusinessAccountStarBalance". We'll keep as is, but comment refers to correct.
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// TransferBusinessAccountStartP holds parameters for the transferBusinessAccountStart method.
|
||||
// See https://core.telegram.org/bots/api#transferbusinessaccountstart
|
||||
type TransferBusinessAccountStartP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
StarCount int `json:"star_count"`
|
||||
}
|
||||
|
||||
// TransferBusinessAccountStart transfers stars from a business account.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#transferbusinessaccountstart
|
||||
func (api *API) TransferBusinessAccountStart(params TransferBusinessAccountStartP) (bool, error) {
|
||||
req := NewRequest[bool]("transferBusinessAccountStart", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// GetBusinessAccountGiftsP holds parameters for the getBusinessAccountGifts method.
|
||||
// See https://core.telegram.org/bots/api#getbusinessaccountgifts
|
||||
type GetBusinessAccountGiftsP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
ExcludeUnsaved bool `json:"exclude_unsaved,omitempty"`
|
||||
@@ -155,21 +226,30 @@ type GetBusinessAccountGiftsP struct {
|
||||
Limit int `json:"limit,omitempty"`
|
||||
}
|
||||
|
||||
// GetBusinessAccountGifts returns gifts owned by a business account.
|
||||
// See https://core.telegram.org/bots/api#getbusinessaccountgifts
|
||||
func (api *API) GetBusinessAccountGifts(params GetBusinessAccountGiftsP) (OwnedGifts, error) {
|
||||
req := NewRequest[OwnedGifts]("getBusinessAccountGifts", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// ConvertGiftToStarsP holds parameters for the convertGiftToStars method.
|
||||
// See https://core.telegram.org/bots/api#convertgifttostars
|
||||
type ConvertGiftToStarsP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
OwnedGiftID string `json:"owned_gift_id"`
|
||||
}
|
||||
|
||||
// ConvertGiftToStars converts a gift to Telegram Stars.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#convertgifttostars
|
||||
func (api *API) ConvertGiftToStars(params ConvertGiftToStarsP) (bool, error) {
|
||||
req := NewRequest[bool]("convertGiftToStars", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// UpgradeGiftP holds parameters for the upgradeGift method.
|
||||
// See https://core.telegram.org/bots/api#upgradegift
|
||||
type UpgradeGiftP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
OwnedGiftID string `json:"owned_gift_id"`
|
||||
@@ -177,11 +257,16 @@ type UpgradeGiftP struct {
|
||||
StarCount int `json:"star_count,omitempty"`
|
||||
}
|
||||
|
||||
// UpgradeGift upgrades a gift.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#upgradegift
|
||||
func (api *API) UpgradeGift(params UpgradeGiftP) (bool, error) {
|
||||
req := NewRequest[bool]("upgradeGift", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// TransferGiftP holds parameters for the transferGift method.
|
||||
// See https://core.telegram.org/bots/api#transfergift
|
||||
type TransferGiftP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
OwnedGiftID string `json:"owned_gift_id"`
|
||||
@@ -189,11 +274,16 @@ type TransferGiftP struct {
|
||||
StarCount int `json:"star_count,omitempty"`
|
||||
}
|
||||
|
||||
// TransferGift transfers a gift to another chat.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#transfergift
|
||||
func (api *API) TransferGift(params TransferGiftP) (bool, error) {
|
||||
req := NewRequest[bool]("transferGift", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// PostStoryP holds parameters for the postStory method.
|
||||
// See https://core.telegram.org/bots/api#poststory
|
||||
type PostStoryP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
Content InputStoryContent `json:"content"`
|
||||
@@ -208,15 +298,22 @@ type PostStoryP struct {
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
}
|
||||
|
||||
// PostStoryPhoto posts a story with a photo.
|
||||
// See https://core.telegram.org/bots/api#poststory
|
||||
func (api *API) PostStoryPhoto(params PostStoryP) (Story, error) {
|
||||
req := NewRequest[Story]("postStory", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// PostStoryVideo posts a story with a video.
|
||||
// See https://core.telegram.org/bots/api#poststory
|
||||
func (api *API) PostStoryVideo(params PostStoryP) (Story, error) {
|
||||
req := NewRequest[Story]("postStory", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// RepostStoryP holds parameters for the repostStory method.
|
||||
// See https://core.telegram.org/bots/api#repoststory
|
||||
type RepostStoryP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
FromChatID int `json:"from_chat_id"`
|
||||
@@ -226,11 +323,16 @@ type RepostStoryP struct {
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
}
|
||||
|
||||
// RepostStory reposts a story from another chat.
|
||||
// Returns the reposted story.
|
||||
// See https://core.telegram.org/bots/api#repoststory
|
||||
func (api *API) RepostStory(params RepostStoryP) (Story, error) {
|
||||
req := NewRequest[Story]("repostStory", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// EditStoryP holds parameters for the editStory method.
|
||||
// See https://core.telegram.org/bots/api#editstory
|
||||
type EditStoryP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
StoryID int `json:"story_id"`
|
||||
@@ -242,16 +344,24 @@ type EditStoryP struct {
|
||||
Areas []StoryArea `json:"areas,omitempty"`
|
||||
}
|
||||
|
||||
// EditStory edits an existing story.
|
||||
// Returns the updated story.
|
||||
// See https://core.telegram.org/bots/api#editstory
|
||||
func (api *API) EditStory(params EditStoryP) (Story, error) {
|
||||
req := NewRequest[Story]("editStory", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// DeleteStoryP holds parameters for the deleteStory method.
|
||||
// See https://core.telegram.org/bots/api#deletestory
|
||||
type DeleteStoryP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
StoryID int `json:"story_id"`
|
||||
}
|
||||
|
||||
// DeleteStory deletes a story.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#deletestory
|
||||
func (api *API) DeleteStory(params DeleteStoryP) (bool, error) {
|
||||
req := NewRequest[bool]("deleteStory", params)
|
||||
return req.Do(api)
|
||||
|
||||
@@ -1,23 +1,37 @@
|
||||
package tgapi
|
||||
|
||||
// BusinessIntro contains information about the business intro.
|
||||
// See https://core.telegram.org/bots/api#businessintro
|
||||
type BusinessIntro struct {
|
||||
Title string `json:"title,omitempty"`
|
||||
Message string `json:"message,omitempty"`
|
||||
Sticker *Sticker `json:"sticker,omitempty"`
|
||||
}
|
||||
|
||||
// BusinessLocation contains information about the business location.
|
||||
// See https://core.telegram.org/bots/api#businesslocation
|
||||
type BusinessLocation struct {
|
||||
Address string `json:"address"`
|
||||
Location *Location `json:"location,omitempty"`
|
||||
}
|
||||
|
||||
// BusinessOpeningHoursInterval represents an interval of opening hours.
|
||||
// See https://core.telegram.org/bots/api#businessopeninghoursinterval
|
||||
type BusinessOpeningHoursInterval struct {
|
||||
OpeningMinute int `json:"opening_minute"`
|
||||
ClosingMinute int `json:"closing_minute"`
|
||||
}
|
||||
|
||||
// BusinessOpeningHours represents the opening hours of a business.
|
||||
// See https://core.telegram.org/bots/api#businessopeninghours
|
||||
type BusinessOpeningHours struct {
|
||||
TimeZoneName string `json:"time_zone_name"`
|
||||
OpeningHours []Birthdate `json:"opening_hours"`
|
||||
OpeningHours []BusinessOpeningHoursInterval `json:"opening_hours"`
|
||||
}
|
||||
|
||||
// BusinessBotRights represents the rights of a business bot.
|
||||
// All fields are optional booleans that, when present, are always true.
|
||||
// See https://core.telegram.org/bots/api#businessbotrights
|
||||
type BusinessBotRights struct {
|
||||
CanReply *bool `json:"can_reply,omitempty"`
|
||||
CanReadMessages *bool `json:"can_read_messages,omitempty"`
|
||||
@@ -34,33 +48,43 @@ type BusinessBotRights struct {
|
||||
CanTransferStars *bool `json:"can_transfer_stars,omitempty"`
|
||||
CanManageStories *bool `json:"can_manage_stories,omitempty"`
|
||||
}
|
||||
|
||||
// BusinessConnection contains information about a business connection.
|
||||
// See https://core.telegram.org/bots/api#businessconnection
|
||||
type BusinessConnection struct {
|
||||
ID string `json:"id"`
|
||||
User User `json:"user"`
|
||||
UserChatID int `json:"user_chat_id"`
|
||||
Date int `json:"date"`
|
||||
Rights *BusinessBotRights `json:"rights,omitempty"`
|
||||
IsEnabled bool `json:"id_enabled"`
|
||||
IsEnabled bool `json:"is_enabled"`
|
||||
}
|
||||
|
||||
// InputStoryContentType indicates the type of input story content.
|
||||
type InputStoryContentType string
|
||||
|
||||
const (
|
||||
InputStoryContentPhotoType InputStoryContentType = "photo"
|
||||
InputStoryContentVideoType InputStoryContentType = "video"
|
||||
)
|
||||
|
||||
type InputStoryContentType string
|
||||
// InputStoryContent represents the content of a story to be posted.
|
||||
// See https://core.telegram.org/bots/api#inputstorycontent
|
||||
type InputStoryContent struct {
|
||||
Type InputStoryContentType `json:"type"`
|
||||
// Photo
|
||||
|
||||
// Photo fields
|
||||
Photo *string `json:"photo,omitempty"`
|
||||
|
||||
// Video
|
||||
// Video fields
|
||||
Video *string `json:"video,omitempty"`
|
||||
Duration *float64 `json:"duration,omitempty"`
|
||||
CoverFrameTimestamp *float64 `json:"cover_frame_timestamp,omitempty"`
|
||||
IsAnimation *bool `json:"is_animation,omitempty"`
|
||||
}
|
||||
|
||||
// StoryAreaPosition describes the position of a clickable area on a story.
|
||||
// See https://core.telegram.org/bots/api#storyareaposition
|
||||
type StoryAreaPosition struct {
|
||||
XPercentage float64 `json:"x_percentage"`
|
||||
YPercentage float64 `json:"y_percentage"`
|
||||
@@ -70,6 +94,9 @@ type StoryAreaPosition struct {
|
||||
CornerRadiusPercentage float64 `json:"corner_radius_percentage"`
|
||||
}
|
||||
|
||||
// StoryAreaTypeType indicates the type of story area.
|
||||
type StoryAreaTypeType string
|
||||
|
||||
const (
|
||||
StoryAreaTypeLocationType StoryAreaTypeType = "location"
|
||||
StoryAreaTypeReactionType StoryAreaTypeType = "suggested_reaction"
|
||||
@@ -78,26 +105,36 @@ const (
|
||||
StoryAreaTypeUniqueGiftType StoryAreaTypeType = "unique_gift"
|
||||
)
|
||||
|
||||
type StoryAreaTypeType string
|
||||
// StoryAreaType describes the type of a clickable area on a story.
|
||||
// Fields should be set according to the Type.
|
||||
// See https://core.telegram.org/bots/api#storyareatype
|
||||
type StoryAreaType struct {
|
||||
Type StoryAreaTypeType `json:"type"`
|
||||
|
||||
// Location
|
||||
Latitude *float64 `json:"latitude,omitempty"`
|
||||
Longitude *float64 `json:"longitude,omitempty"`
|
||||
Address *LocationAddress `json:"address,omitempty"`
|
||||
|
||||
// Suggested reaction
|
||||
ReactionType *ReactionType `json:"reaction_type,omitempty"`
|
||||
IsDark *bool `json:"is_dark,omitempty"`
|
||||
IsFlipped *bool `json:"is_flipped,omitempty"`
|
||||
|
||||
// Link
|
||||
URL *string `json:"url,omitempty"`
|
||||
|
||||
// Weather
|
||||
Temperature *float64 `json:"temperature,omitempty"`
|
||||
Emoji *string `json:"emoji"`
|
||||
BackgroundColor *int `json:"background_color"`
|
||||
Emoji *string `json:"emoji,omitempty"`
|
||||
BackgroundColor *int `json:"background_color,omitempty"`
|
||||
|
||||
// Unique gift
|
||||
Name *string `json:"name,omitempty"`
|
||||
}
|
||||
|
||||
// StoryArea represents a clickable area on a story.
|
||||
// See https://core.telegram.org/bots/api#storyarea
|
||||
type StoryArea struct {
|
||||
Position StoryAreaPosition `json:"position"`
|
||||
Type StoryAreaType `json:"type"`
|
||||
|
||||
@@ -1,43 +1,60 @@
|
||||
package tgapi
|
||||
|
||||
// BanChatMemberP holds parameters for the banChatMember method.
|
||||
// See https://core.telegram.org/bots/api#banchatmember
|
||||
type BanChatMemberP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
UserID int `json:"user_id"`
|
||||
UntilDate int `json:"until_date,omitempty"`
|
||||
RevokeMessages bool `json:"revoke_messages,omitempty"`
|
||||
}
|
||||
|
||||
// BanChatMember bans a user in a chat.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#banchatmember
|
||||
func (api *API) BanChatMember(params BanChatMemberP) (bool, error) {
|
||||
req := NewRequest[bool]("banChatMember", params)
|
||||
req := NewRequestWithChatID[bool]("banChatMember", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// UnbanChatMemberP holds parameters for the unbanChatMember method.
|
||||
// See https://core.telegram.org/bots/api#unbanchatmember
|
||||
type UnbanChatMemberP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
UserID int `json:"user_id"`
|
||||
OnlyIfBanned bool `json:"only_if_banned"`
|
||||
}
|
||||
|
||||
// UnbanChatMember unbans a previously banned user in a chat.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#unbanchatmember
|
||||
func (api *API) UnbanChatMember(params UnbanChatMemberP) (bool, error) {
|
||||
req := NewRequest[bool]("unbanChatMember", params)
|
||||
req := NewRequestWithChatID[bool]("unbanChatMember", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// RestrictChatMemberP holds parameters for the restrictChatMember method.
|
||||
// See https://core.telegram.org/bots/api#restrictchatmember
|
||||
type RestrictChatMemberP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
UserID int `json:"user_id"`
|
||||
Permissions ChatPermissions `json:"permissions"`
|
||||
UseIndependentChatPermissions bool `json:"use_independent_chat_permissions,omitempty"`
|
||||
UntilDate int `json:"until_date,omitempty"`
|
||||
}
|
||||
|
||||
// RestrictChatMember restricts a user in a chat.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#restrictchatmember
|
||||
func (api *API) RestrictChatMember(params RestrictChatMemberP) (bool, error) {
|
||||
req := NewRequest[bool]("restrictChatMember", params)
|
||||
req := NewRequestWithChatID[bool]("restrictChatMember", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// PromoteChatMember holds parameters for the promoteChatMember method.
|
||||
// See https://core.telegram.org/bots/api#promotechatmember
|
||||
type PromoteChatMember struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
UserID int `json:"user_id"`
|
||||
IsAnonymous bool `json:"is_anonymous,omitempty"`
|
||||
|
||||
@@ -59,88 +76,128 @@ type PromoteChatMember struct {
|
||||
CanManageTags bool `json:"can_manage_tags,omitempty"`
|
||||
}
|
||||
|
||||
// PromoteChatMember promotes or demotes a user in a chat.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#promotechatmember
|
||||
func (api *API) PromoteChatMember(params PromoteChatMember) (bool, error) {
|
||||
req := NewRequest[bool]("promoteChatMember", params)
|
||||
req := NewRequestWithChatID[bool]("promoteChatMember", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetChatAdministratorCustomTitleP holds parameters for the setChatAdministratorCustomTitle method.
|
||||
// See https://core.telegram.org/bots/api#setchatadministratorcustomtitle
|
||||
type SetChatAdministratorCustomTitleP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
UserID int `json:"user_id"`
|
||||
CustomTitle string `json:"custom_title"`
|
||||
}
|
||||
|
||||
// SetChatAdministratorCustomTitle sets a custom title for an administrator.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#setchatadministratorcustomtitle
|
||||
func (api *API) SetChatAdministratorCustomTitle(params SetChatAdministratorCustomTitleP) (bool, error) {
|
||||
req := NewRequest[bool]("setChatAdministratorCustomTitle", params)
|
||||
req := NewRequestWithChatID[bool]("setChatAdministratorCustomTitle", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetChatMemberTagP holds parameters for the setChatMemberTag method.
|
||||
// See https://core.telegram.org/bots/api#setchatmembertag
|
||||
type SetChatMemberTagP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
UserID int `json:"user_id"`
|
||||
Tag string `json:"tag,omitempty"`
|
||||
}
|
||||
|
||||
// SetChatMemberTag sets a tag for a chat member.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#setchatmembertag
|
||||
func (api *API) SetChatMemberTag(params SetChatMemberTagP) (bool, error) {
|
||||
req := NewRequest[bool]("setChatMemberTag", params)
|
||||
req := NewRequestWithChatID[bool]("setChatMemberTag", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// BanChatSenderChatP holds parameters for the banChatSenderChat method.
|
||||
// See https://core.telegram.org/bots/api#banchatsenderchat
|
||||
type BanChatSenderChatP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
SenderChatID int `json:"sender_chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
SenderChatID int64 `json:"sender_chat_id"`
|
||||
}
|
||||
|
||||
// BanChatSenderChat bans a channel chat in a supergroup or channel.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#banchatsenderchat
|
||||
func (api *API) BanChatSenderChat(params BanChatSenderChatP) (bool, error) {
|
||||
req := NewRequest[bool]("banChatSenderChat", params)
|
||||
req := NewRequestWithChatID[bool]("banChatSenderChat", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// UnbanChatSenderChatP holds parameters for the unbanChatSenderChat method.
|
||||
// See https://core.telegram.org/bots/api#unbanchatsenderchat
|
||||
type UnbanChatSenderChatP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
SenderChatID int `json:"sender_chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
SenderChatID int64 `json:"sender_chat_id"`
|
||||
}
|
||||
|
||||
func (api *API) UnbanChatSenderChat(params BanChatSenderChatP) (bool, error) {
|
||||
req := NewRequest[bool]("unbanChatSenderChat", params)
|
||||
// UnbanChatSenderChat unbans a previously banned channel chat.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#unbanchatsenderchat
|
||||
func (api *API) UnbanChatSenderChat(params UnbanChatSenderChatP) (bool, error) {
|
||||
req := NewRequestWithChatID[bool]("unbanChatSenderChat", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetChatPermissionsP holds parameters for the setChatPermissions method.
|
||||
// See https://core.telegram.org/bots/api#setchatpermissions
|
||||
type SetChatPermissionsP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
Permissions ChatPermissions `json:"permissions"`
|
||||
UseIndependentChatPermissions bool `json:"use_independent_chat_permissions,omitempty"`
|
||||
}
|
||||
|
||||
// SetChatPermissions sets default chat permissions for all members.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#setchatpermissions
|
||||
func (api *API) SetChatPermissions(params SetChatPermissionsP) (bool, error) {
|
||||
req := NewRequest[bool]("setChatPermissions", params)
|
||||
req := NewRequestWithChatID[bool]("setChatPermissions", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// ExportChatInviteLinkP holds parameters for the exportChatInviteLink method.
|
||||
// See https://core.telegram.org/bots/api#exportchatinvitelink
|
||||
type ExportChatInviteLinkP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
}
|
||||
|
||||
// ExportChatInviteLink generates a new primary invite link for a chat.
|
||||
// Returns the new invite link as string.
|
||||
// See https://core.telegram.org/bots/api#exportchatinvitelink
|
||||
func (api *API) ExportChatInviteLink(params ExportChatInviteLinkP) (string, error) {
|
||||
req := NewRequest[string]("exportChatInviteLink", params)
|
||||
req := NewRequestWithChatID[string]("exportChatInviteLink", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// CreateChatInviteLinkP holds parameters for the createChatInviteLink method.
|
||||
// See https://core.telegram.org/bots/api#createchatinvitelink
|
||||
type CreateChatInviteLinkP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
Name *string `json:"name,omitempty"`
|
||||
ExpireDate int `json:"expire_date,omitempty"`
|
||||
MemberLimit int `json:"member_limit,omitempty"`
|
||||
CreatesJoinRequest int `json:"creates_join_request,omitempty"`
|
||||
}
|
||||
|
||||
// CreateChatInviteLink creates an additional invite link for a chat.
|
||||
// Returns the created invite link.
|
||||
// See https://core.telegram.org/bots/api#createchatinvitelink
|
||||
func (api *API) CreateChatInviteLink(params CreateChatInviteLinkP) (ChatInviteLink, error) {
|
||||
req := NewRequest[ChatInviteLink]("createChatInviteLink", params)
|
||||
req := NewRequestWithChatID[ChatInviteLink]("createChatInviteLink", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// EditChatInviteLinkP holds parameters for the editChatInviteLink method.
|
||||
// See https://core.telegram.org/bots/api#editchatinvitelink
|
||||
type EditChatInviteLinkP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
InviteLink string `json:"invite_link"`
|
||||
|
||||
Name string `json:"name,omitempty"`
|
||||
@@ -149,207 +206,306 @@ type EditChatInviteLinkP struct {
|
||||
CreatesJoinRequest int `json:"creates_join_request,omitempty"`
|
||||
}
|
||||
|
||||
// EditChatInviteLink edits a non‑primary invite link.
|
||||
// Returns the edited invite link.
|
||||
// See https://core.telegram.org/bots/api#editchatinvitelink
|
||||
func (api *API) EditChatInviteLink(params EditChatInviteLinkP) (ChatInviteLink, error) {
|
||||
req := NewRequest[ChatInviteLink]("editChatInviteLink", params)
|
||||
req := NewRequestWithChatID[ChatInviteLink]("editChatInviteLink", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// CreateChatSubscriptionInviteLinkP holds parameters for the createChatSubscriptionInviteLink method.
|
||||
// See https://core.telegram.org/bots/api#createchatsubscriptioninvitelink
|
||||
type CreateChatSubscriptionInviteLinkP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
Name string `json:"name,omitempty"`
|
||||
SubscriptionPeriod int `json:"subscription_period,omitempty"`
|
||||
SubscriptionPrice int `json:"subscription_price,omitempty"`
|
||||
}
|
||||
|
||||
// CreateChatSubscriptionInviteLink creates a subscription invite link for a channel chat.
|
||||
// Returns the created invite link.
|
||||
// See https://core.telegram.org/bots/api#createchatsubscriptioninvitelink
|
||||
func (api *API) CreateChatSubscriptionInviteLink(params CreateChatSubscriptionInviteLinkP) (ChatInviteLink, error) {
|
||||
req := NewRequest[ChatInviteLink]("createChatSubscriptionInviteLink", params)
|
||||
req := NewRequestWithChatID[ChatInviteLink]("createChatSubscriptionInviteLink", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// EditChatSubscriptionInviteLinkP holds parameters for the editChatSubscriptionInviteLink method.
|
||||
// See https://core.telegram.org/bots/api#editchatsubscriptioninvitelink
|
||||
type EditChatSubscriptionInviteLinkP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
InviteLink string `json:"invite_link"`
|
||||
Name string `json:"name,omitempty"`
|
||||
}
|
||||
|
||||
// EditChatSubscriptionInviteLink edits a subscription invite link.
|
||||
// Returns the edited invite link.
|
||||
// See https://core.telegram.org/bots/api#editchatsubscriptioninvitelink
|
||||
func (api *API) EditChatSubscriptionInviteLink(params EditChatSubscriptionInviteLinkP) (ChatInviteLink, error) {
|
||||
req := NewRequest[ChatInviteLink]("editChatSubscriptionInviteLink", params)
|
||||
req := NewRequestWithChatID[ChatInviteLink]("editChatSubscriptionInviteLink", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// RevokeChatInviteLinkP holds parameters for the revokeChatInviteLink method.
|
||||
// See https://core.telegram.org/bots/api#revokechatinvitelink
|
||||
type RevokeChatInviteLinkP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
InviteLink string `json:"invite_link"`
|
||||
}
|
||||
|
||||
// RevokeChatInviteLink revokes an invite link.
|
||||
// Returns the revoked invite link object.
|
||||
// See https://core.telegram.org/bots/api#revokechatinvitelink
|
||||
func (api *API) RevokeChatInviteLink(params RevokeChatInviteLinkP) (ChatInviteLink, error) {
|
||||
req := NewRequest[ChatInviteLink]("revokeChatInviteLink", params)
|
||||
req := NewRequestWithChatID[ChatInviteLink]("revokeChatInviteLink", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// ApproveChatJoinRequestP holds parameters for the approveChatJoinRequest method.
|
||||
// See https://core.telegram.org/bots/api#approvechatjoinrequest
|
||||
type ApproveChatJoinRequestP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
UserID int `json:"user_id"`
|
||||
}
|
||||
|
||||
// ApproveChatJoinRequest approves a chat join request.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#approvechatjoinrequest
|
||||
func (api *API) ApproveChatJoinRequest(params ApproveChatJoinRequestP) (bool, error) {
|
||||
req := NewRequest[bool]("approveChatJoinRequest", params)
|
||||
req := NewRequestWithChatID[bool]("approveChatJoinRequest", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// DeclineChatJoinRequestP holds parameters for the declineChatJoinRequest method.
|
||||
// See https://core.telegram.org/bots/api#declinechatjoinrequest
|
||||
type DeclineChatJoinRequestP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
UserID int `json:"user_id"`
|
||||
}
|
||||
|
||||
// DeclineChatJoinRequest declines a chat join request.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#declinechatjoinrequest
|
||||
func (api *API) DeclineChatJoinRequest(params DeclineChatJoinRequestP) (bool, error) {
|
||||
req := NewRequest[bool]("declineChatJoinRequest", params)
|
||||
req := NewRequestWithChatID[bool]("declineChatJoinRequest", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetChatPhoto is a stub method (needs implementation).
|
||||
// Currently incomplete.
|
||||
func (api *API) SetChatPhoto() {
|
||||
uploader := NewUploader(api)
|
||||
defer uploader.Close()
|
||||
defer func() {
|
||||
_ = uploader.Close()
|
||||
}()
|
||||
}
|
||||
|
||||
// DeleteChatPhotoP holds parameters for the deleteChatPhoto method.
|
||||
// See https://core.telegram.org/bots/api#deletechatphoto
|
||||
type DeleteChatPhotoP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
}
|
||||
|
||||
// DeleteChatPhoto deletes a chat photo.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#deletechatphoto
|
||||
func (api *API) DeleteChatPhoto(params DeleteChatPhotoP) (bool, error) {
|
||||
req := NewRequest[bool]("deleteChatPhoto", params)
|
||||
req := NewRequestWithChatID[bool]("deleteChatPhoto", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetChatTitleP holds parameters for the setChatTitle method.
|
||||
// See https://core.telegram.org/bots/api#setchattitle
|
||||
type SetChatTitleP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
Title string `json:"title"`
|
||||
}
|
||||
|
||||
// SetChatTitle changes the chat title.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#setchattitle
|
||||
func (api *API) SetChatTitle(params SetChatTitleP) (bool, error) {
|
||||
req := NewRequest[bool]("setChatTitle", params)
|
||||
req := NewRequestWithChatID[bool]("setChatTitle", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetChatDescriptionP holds parameters for the setChatDescription method.
|
||||
// See https://core.telegram.org/bots/api#setchatdescription
|
||||
type SetChatDescriptionP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
Description string `json:"description"`
|
||||
}
|
||||
|
||||
// SetChatDescription changes the chat description.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#setchatdescription
|
||||
func (api *API) SetChatDescription(params SetChatDescriptionP) (bool, error) {
|
||||
req := NewRequest[bool]("setChatDescription", params)
|
||||
req := NewRequestWithChatID[bool]("setChatDescription", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// PinChatMessageP holds parameters for the pinChatMessage method.
|
||||
// See https://core.telegram.org/bots/api#pinchatmessage
|
||||
type PinChatMessageP struct {
|
||||
BusinessConnectionID *string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageID int `json:"message_id"`
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
}
|
||||
|
||||
// PinChatMessage pins a message in a chat.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#pinchatmessage
|
||||
func (api *API) PinChatMessage(params PinChatMessageP) (bool, error) {
|
||||
req := NewRequest[bool]("pinChatMessage", params)
|
||||
req := NewRequestWithChatID[bool]("pinChatMessage", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// UnpinChatMessageP holds parameters for the unpinChatMessage method.
|
||||
// See https://core.telegram.org/bots/api#unpinchatmessage
|
||||
type UnpinChatMessageP struct {
|
||||
BusinessConnectionID *string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageID int `json:"message_id"`
|
||||
}
|
||||
|
||||
// UnpinChatMessage unpins a message in a chat.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#unpinchatmessage
|
||||
func (api *API) UnpinChatMessage(params UnpinChatMessageP) (bool, error) {
|
||||
req := NewRequest[bool]("unpinChatMessage", params)
|
||||
req := NewRequestWithChatID[bool]("unpinChatMessage", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// UnpinAllChatMessagesP holds parameters for the unpinAllChatMessages method.
|
||||
// See https://core.telegram.org/bots/api#unpinallchatmessages
|
||||
type UnpinAllChatMessagesP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
}
|
||||
|
||||
// UnpinAllChatMessages unpins all pinned messages in a chat.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#unpinallchatmessages
|
||||
func (api *API) UnpinAllChatMessages(params UnpinAllChatMessagesP) (bool, error) {
|
||||
req := NewRequest[bool]("unpinAllChatMessages", params)
|
||||
req := NewRequestWithChatID[bool]("unpinAllChatMessages", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// LeaveChatP holds parameters for the leaveChat method.
|
||||
// See https://core.telegram.org/bots/api#leavechat
|
||||
type LeaveChatP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
}
|
||||
|
||||
// LeaveChat makes the bot leave a chat.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#leavechat
|
||||
func (api *API) LeaveChat(params LeaveChatP) (bool, error) {
|
||||
req := NewRequest[bool]("leaveChatP", params)
|
||||
req := NewRequestWithChatID[bool]("leaveChat", params, params.ChatID) // fixed method name
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// GetChatP holds parameters for the getChat method.
|
||||
// See https://core.telegram.org/bots/api#getchat
|
||||
type GetChatP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
}
|
||||
|
||||
func (api *API) GetChatP(params GetChatP) (ChatFullInfo, error) {
|
||||
req := NewRequest[ChatFullInfo]("getChatP", params)
|
||||
// GetChat gets up‑to‑date information about a chat.
|
||||
// See https://core.telegram.org/bots/api#getchat
|
||||
func (api *API) GetChat(params GetChatP) (ChatFullInfo, error) {
|
||||
req := NewRequestWithChatID[ChatFullInfo]("getChat", params, params.ChatID) // fixed method name
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// GetChatAdministratorsP holds parameters for the getChatAdministrators method.
|
||||
// See https://core.telegram.org/bots/api#getchatadministrators
|
||||
type GetChatAdministratorsP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
}
|
||||
|
||||
// GetChatAdministrators returns a list of administrators in a chat.
|
||||
// See https://core.telegram.org/bots/api#getchatadministrators
|
||||
func (api *API) GetChatAdministrators(params GetChatAdministratorsP) ([]ChatMember, error) {
|
||||
req := NewRequest[[]ChatMember]("getChatAdministrators", params)
|
||||
req := NewRequestWithChatID[[]ChatMember]("getChatAdministrators", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// GetChatMembersCountP holds parameters for the getChatMemberCount method.
|
||||
// See https://core.telegram.org/bots/api#getchatmembercount
|
||||
type GetChatMembersCountP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
}
|
||||
|
||||
// GetChatMemberCount returns the number of members in a chat.
|
||||
// See https://core.telegram.org/bots/api#getchatmembercount
|
||||
func (api *API) GetChatMemberCount(params GetChatMembersCountP) (int, error) {
|
||||
req := NewRequest[int]("getChatMemberCount", params)
|
||||
req := NewRequestWithChatID[int]("getChatMemberCount", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// GetChatMemberP holds parameters for the getChatMember method.
|
||||
// See https://core.telegram.org/bots/api#getchatmember
|
||||
type GetChatMemberP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
UserID int `json:"user_id"`
|
||||
}
|
||||
|
||||
// GetChatMember returns information about a member of a chat.
|
||||
// See https://core.telegram.org/bots/api#getchatmember
|
||||
func (api *API) GetChatMember(params GetChatMemberP) (ChatMember, error) {
|
||||
req := NewRequest[ChatMember]("getChatMember", params)
|
||||
req := NewRequestWithChatID[ChatMember]("getChatMember", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetChatStickerSetP holds parameters for the setChatStickerSet method.
|
||||
// See https://core.telegram.org/bots/api#setchatstickerset
|
||||
type SetChatStickerSetP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
StickerSetName string `json:"sticker_set_name"`
|
||||
}
|
||||
|
||||
// SetChatStickerSet associates a sticker set with a supergroup.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#setchatstickerset
|
||||
func (api *API) SetChatStickerSet(params SetChatStickerSetP) (bool, error) {
|
||||
req := NewRequest[bool]("setChatStickerSet", params)
|
||||
req := NewRequestWithChatID[bool]("setChatStickerSet", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// DeleteChatStickerSetP holds parameters for the deleteChatStickerSet method.
|
||||
// See https://core.telegram.org/bots/api#deletechatstickerset
|
||||
type DeleteChatStickerSetP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
}
|
||||
|
||||
// DeleteChatStickerSet deletes a sticker set from a supergroup.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#deletechatstickerset
|
||||
func (api *API) DeleteChatStickerSet(params DeleteChatStickerSetP) (bool, error) {
|
||||
req := NewRequest[bool]("deleteChatStickerSet", params)
|
||||
req := NewRequestWithChatID[bool]("deleteChatStickerSet", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// GetUserChatBoostsP holds parameters for the getUserChatBoosts method.
|
||||
// See https://core.telegram.org/bots/api#getuserchatboosts
|
||||
type GetUserChatBoostsP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
UserID int `json:"user_id"`
|
||||
}
|
||||
|
||||
// GetUserChatBoosts returns the list of boosts a user has given to a chat.
|
||||
// See https://core.telegram.org/bots/api#getuserchatboosts
|
||||
func (api *API) GetUserChatBoosts(params GetUserChatBoostsP) (UserChatBoosts, error) {
|
||||
req := NewRequest[UserChatBoosts]("getUserChatBoosts", params)
|
||||
req := NewRequestWithChatID[UserChatBoosts]("getUserChatBoosts", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// GetChatGiftsP holds parameters for the getChatGifts method.
|
||||
// See https://core.telegram.org/bots/api#getchatgifts
|
||||
type GetChatGiftsP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
ExcludeUnsaved bool `json:"exclude_unsaved,omitempty"`
|
||||
ExcludeSaved bool `json:"exclude_saved,omitempty"`
|
||||
ExcludeUnlimited bool `json:"exclude_unlimited,omitempty"`
|
||||
@@ -362,7 +518,9 @@ type GetChatGiftsP struct {
|
||||
Limit int `json:"limit,omitempty"`
|
||||
}
|
||||
|
||||
// GetChatGifts returns gifts owned by a chat.
|
||||
// See https://core.telegram.org/bots/api#getchatgifts
|
||||
func (api *API) GetChatGifts(params GetChatGiftsP) (OwnedGifts, error) {
|
||||
req := NewRequest[OwnedGifts]("getChatGifts", params)
|
||||
req := NewRequestWithChatID[OwnedGifts]("getChatGifts", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
package tgapi
|
||||
|
||||
// Chat represents a chat (private, group, supergroup, channel).
|
||||
// See https://core.telegram.org/bots/api#chat
|
||||
type Chat struct {
|
||||
ID int `json:"id"`
|
||||
ID int64 `json:"id"`
|
||||
Type string `json:"type"`
|
||||
Title *string `json:"title,omitempty"`
|
||||
Username *string `json:"username,omitempty"`
|
||||
@@ -11,6 +13,7 @@ type Chat struct {
|
||||
IsDirectMessages *bool `json:"is_direct_messages,omitempty"`
|
||||
}
|
||||
|
||||
// ChatType represents the type of a chat.
|
||||
type ChatType string
|
||||
|
||||
const (
|
||||
@@ -20,6 +23,8 @@ const (
|
||||
ChatTypeChannel ChatType = "channel"
|
||||
)
|
||||
|
||||
// ChatFullInfo contains full information about a chat.
|
||||
// See https://core.telegram.org/bots/api#chatfullinfo
|
||||
type ChatFullInfo struct {
|
||||
ID int `json:"id"`
|
||||
Type ChatType `json:"type"`
|
||||
@@ -82,6 +87,8 @@ type ChatFullInfo struct {
|
||||
PaidMessageStarCount *int `json:"paid_message_star_count,omitempty"`
|
||||
}
|
||||
|
||||
// ChatPhoto represents a chat photo.
|
||||
// See https://core.telegram.org/bots/api#chatphoto
|
||||
type ChatPhoto struct {
|
||||
SmallFileID string `json:"small_file_id"`
|
||||
SmallFileUniqueID string `json:"small_file_unique_id"`
|
||||
@@ -89,6 +96,8 @@ type ChatPhoto struct {
|
||||
BigFileUniqueID string `json:"big_file_unique_id"`
|
||||
}
|
||||
|
||||
// ChatPermissions describes actions that a non‑administrator user is allowed to take in a chat.
|
||||
// See https://core.telegram.org/bots/api#chatpermissions
|
||||
type ChatPermissions struct {
|
||||
CanSendMessages bool `json:"can_send_messages"`
|
||||
CanSendAudios bool `json:"can_send_audios"`
|
||||
@@ -99,16 +108,22 @@ type ChatPermissions struct {
|
||||
CanSendPolls bool `json:"can_send_polls"`
|
||||
CanSendOtherMessages bool `json:"can_send_other_messages"`
|
||||
CanAddWebPagePreview bool `json:"can_add_web_page_preview"`
|
||||
CatEditTag bool `json:"cat_edit_tag"`
|
||||
CatEditTag bool `json:"cat_edit_tag"` // Note: field name likely a typo, should be "can_edit_tag"
|
||||
CanChangeInfo bool `json:"can_change_info"`
|
||||
CanInviteUsers bool `json:"can_invite_users"`
|
||||
CanPinMessages bool `json:"can_pin_messages"`
|
||||
CanManageTopics bool `json:"can_manage_topics"`
|
||||
}
|
||||
|
||||
// ChatLocation represents a location to which a chat is connected.
|
||||
// See https://core.telegram.org/bots/api#chatlocation
|
||||
type ChatLocation struct {
|
||||
Location Location `json:"location"`
|
||||
Address string `json:"address"`
|
||||
}
|
||||
|
||||
// ChatInviteLink represents an invite link for a chat.
|
||||
// See https://core.telegram.org/bots/api#chatinvitelink
|
||||
type ChatInviteLink struct {
|
||||
InviteLink string `json:"invite_link"`
|
||||
Creator User `json:"creator"`
|
||||
@@ -124,6 +139,7 @@ type ChatInviteLink struct {
|
||||
SubscriptionPrice *int `json:"subscription_price,omitempty"`
|
||||
}
|
||||
|
||||
// ChatMemberStatusType indicates the status of a chat member.
|
||||
type ChatMemberStatusType string
|
||||
|
||||
const (
|
||||
@@ -135,6 +151,8 @@ const (
|
||||
ChatMemberStatusBanned ChatMemberStatusType = "kicked"
|
||||
)
|
||||
|
||||
// ChatMember contains information about one member of a chat.
|
||||
// See https://core.telegram.org/bots/api#chatmember
|
||||
type ChatMember struct {
|
||||
Status ChatMemberStatusType `json:"status"`
|
||||
User User `json:"user"`
|
||||
@@ -181,6 +199,8 @@ type ChatMember struct {
|
||||
CanEditTag *bool `json:"can_edit_tag,omitempty"`
|
||||
}
|
||||
|
||||
// ChatBoostSource describes the source of a chat boost.
|
||||
// See https://core.telegram.org/bots/api#chatboostsource
|
||||
type ChatBoostSource struct {
|
||||
Source string `json:"source"`
|
||||
User User `json:"user"`
|
||||
@@ -191,16 +211,23 @@ type ChatBoostSource struct {
|
||||
IsUnclaimed *bool `json:"is_unclaimed,omitempty"`
|
||||
}
|
||||
|
||||
// ChatBoost represents a boost added to a chat.
|
||||
// See https://core.telegram.org/bots/api#chatboost
|
||||
type ChatBoost struct {
|
||||
BoostID int `json:"boost_id"`
|
||||
AddDate int `json:"add_date"`
|
||||
ExpirationDate int `json:"expiration_date"`
|
||||
Source ChatBoostSource `json:"source"`
|
||||
}
|
||||
|
||||
// UserChatBoosts represents a list of boosts a user has given to a chat.
|
||||
// See https://core.telegram.org/bots/api#userchatboosts
|
||||
type UserChatBoosts struct {
|
||||
Boosts []ChatBoost `json:"boosts"`
|
||||
}
|
||||
|
||||
// ChatAdministratorRights represents the rights of an administrator in a chat.
|
||||
// See https://core.telegram.org/bots/api#chatadministratorrights
|
||||
type ChatAdministratorRights struct {
|
||||
IsAnonymous bool `json:"is_anonymous"`
|
||||
CanManageChat bool `json:"can_manage_chat"`
|
||||
@@ -222,11 +249,15 @@ type ChatAdministratorRights struct {
|
||||
CanManageTags *bool `json:"can_manage_tags,omitempty"`
|
||||
}
|
||||
|
||||
// ChatBoostUpdated represents a boost added to a chat or changed.
|
||||
// See https://core.telegram.org/bots/api#chatboostupdated
|
||||
type ChatBoostUpdated struct {
|
||||
Chat Chat `json:"chat"`
|
||||
Boost ChatBoost `json:"boost"`
|
||||
}
|
||||
|
||||
// ChatBoostRemoved represents a boost removed from a chat.
|
||||
// See https://core.telegram.org/bots/api#chatboostremoved
|
||||
type ChatBoostRemoved struct {
|
||||
Chat Chat `json:"chat"`
|
||||
BoostID string `json:"boost_id"`
|
||||
|
||||
7
tgapi/errors.go
Normal file
7
tgapi/errors.go
Normal file
@@ -0,0 +1,7 @@
|
||||
package tgapi
|
||||
|
||||
import "errors"
|
||||
|
||||
var ErrRateLimit = errors.New("rate limit exceeded")
|
||||
var ErrPoolUnexpected = errors.New("unexpected response from pool")
|
||||
var ErrPoolQueueFull = errors.New("worker pool queue full")
|
||||
@@ -1,86 +1,139 @@
|
||||
package tgapi
|
||||
|
||||
// BaseForumTopicP contains common fields for forum topic operations that require a chat ID and a message thread ID.
|
||||
type BaseForumTopicP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id"`
|
||||
}
|
||||
|
||||
func (api *API) GetForumTopicIconSet() ([]Sticker, error) {
|
||||
req := NewRequest[[]Sticker]("getForumTopicIconSet", NoParams)
|
||||
// GetForumTopicIconStickers returns the list of custom emoji that can be used as a forum topic icon.
|
||||
// See https://core.telegram.org/bots/api#getforumtopiciconstickers
|
||||
func (api *API) GetForumTopicIconStickers() ([]Sticker, error) {
|
||||
req := NewRequest[[]Sticker]("getForumTopicIconStickers", NoParams)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// CreateForumTopicP holds parameters for the createForumTopic method.
|
||||
// See https://core.telegram.org/bots/api#createforumtopic
|
||||
type CreateForumTopicP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
Name string `json:"name"`
|
||||
IconColor ForumTopicIconColor `json:"icon_color"`
|
||||
IconCustomEmojiID string `json:"icon_custom_emoji_id"`
|
||||
}
|
||||
|
||||
// CreateForumTopic creates a topic in a forum supergroup.
|
||||
// Returns the created ForumTopic on success.
|
||||
// See https://core.telegram.org/bots/api#createforumtopic
|
||||
func (api *API) CreateForumTopic(params CreateForumTopicP) (ForumTopic, error) {
|
||||
req := NewRequest[ForumTopic]("createForumTopic", params)
|
||||
req := NewRequestWithChatID[ForumTopic]("createForumTopic", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// EditForumTopicP holds parameters for the editForumTopic method.
|
||||
// See https://core.telegram.org/bots/api#editforumtopic
|
||||
type EditForumTopicP struct {
|
||||
BaseForumTopicP
|
||||
Name string `json:"name"`
|
||||
IconCustomEmojiID string `json:"icon_custom_emoji_id"`
|
||||
}
|
||||
|
||||
// EditForumTopic edits name and icon of a forum topic.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#editforumtopic
|
||||
func (api *API) EditForumTopic(params EditForumTopicP) (bool, error) {
|
||||
req := NewRequest[bool]("editForumTopic", params)
|
||||
req := NewRequestWithChatID[bool]("editForumTopic", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// CloseForumTopic closes an open forum topic.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#closeforumtopic
|
||||
func (api *API) CloseForumTopic(params BaseForumTopicP) (bool, error) {
|
||||
req := NewRequest[bool]("closeForumTopic", params)
|
||||
req := NewRequestWithChatID[bool]("closeForumTopic", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// ReopenForumTopic reopens a closed forum topic.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#reopenforumtopic
|
||||
func (api *API) ReopenForumTopic(params BaseForumTopicP) (bool, error) {
|
||||
req := NewRequest[bool]("reopenForumTopic", params)
|
||||
req := NewRequestWithChatID[bool]("reopenForumTopic", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// DeleteForumTopic deletes a forum topic.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#deleteforumtopic
|
||||
func (api *API) DeleteForumTopic(params BaseForumTopicP) (bool, error) {
|
||||
req := NewRequest[bool]("deleteForumTopic", params)
|
||||
req := NewRequestWithChatID[bool]("deleteForumTopic", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// UnpinAllForumTopicMessages clears the list of pinned messages in a forum topic.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#unpinallforumtopicmessages
|
||||
func (api *API) UnpinAllForumTopicMessages(params BaseForumTopicP) (bool, error) {
|
||||
req := NewRequest[bool]("unpinAllForumTopicMessages", params)
|
||||
req := NewRequestWithChatID[bool]("unpinAllForumTopicMessages", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// BaseGeneralForumTopicP contains common fields for general forum topic operations that require a chat ID.
|
||||
type BaseGeneralForumTopicP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
}
|
||||
|
||||
// EditGeneralForumTopicP holds parameters for the editGeneralForumTopic method.
|
||||
// See https://core.telegram.org/bots/api#editgeneralforumtopic
|
||||
type EditGeneralForumTopicP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
// EditGeneralForumTopic edits the name of the 'General' topic in a forum supergroup.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#editgeneralforumtopic
|
||||
func (api *API) EditGeneralForumTopic(params EditGeneralForumTopicP) (bool, error) {
|
||||
req := NewRequest[bool]("editGeneralForumTopic", params)
|
||||
req := NewRequestWithChatID[bool]("editGeneralForumTopic", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// CloseGeneralForumTopic closes the 'General' topic in a forum supergroup.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#closegeneralforumtopic
|
||||
func (api *API) CloseGeneralForumTopic(params BaseGeneralForumTopicP) (bool, error) {
|
||||
req := NewRequest[bool]("closeGeneralForumTopic", params)
|
||||
req := NewRequestWithChatID[bool]("closeGeneralForumTopic", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// ReopenGeneralForumTopic reopens the 'General' topic in a forum supergroup.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#reopengeneralforumtopic
|
||||
func (api *API) ReopenGeneralForumTopic(params BaseGeneralForumTopicP) (bool, error) {
|
||||
req := NewRequest[bool]("reopenGeneralForumTopic", params)
|
||||
req := NewRequestWithChatID[bool]("reopenGeneralForumTopic", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// HideGeneralForumTopic hides the 'General' topic in a forum supergroup.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#hidegeneralforumtopic
|
||||
func (api *API) HideGeneralForumTopic(params BaseGeneralForumTopicP) (bool, error) {
|
||||
req := NewRequest[bool]("hideGeneralForumTopic", params)
|
||||
req := NewRequestWithChatID[bool]("hideGeneralForumTopic", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// UnhideGeneralForumTopic unhides the 'General' topic in a forum supergroup.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#unhidegeneralforumtopic
|
||||
func (api *API) UnhideGeneralForumTopic(params BaseGeneralForumTopicP) (bool, error) {
|
||||
req := NewRequest[bool]("unhideGeneralForumTopic", params)
|
||||
req := NewRequestWithChatID[bool]("unhideGeneralForumTopic", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// UnpinAllGeneralForumTopicMessages clears the list of pinned messages in the 'General' topic.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#unpinallgeneralforumtopicmessages
|
||||
func (api *API) UnpinAllGeneralForumTopicMessages(params BaseGeneralForumTopicP) (bool, error) {
|
||||
req := NewRequest[bool]("unpinAllGeneralForumTopicMessages", params)
|
||||
req := NewRequestWithChatID[bool]("unpinAllGeneralForumTopicMessages", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
package tgapi
|
||||
|
||||
// ForumTopic represents a forum topic.
|
||||
// See https://core.telegram.org/bots/api#forumtopic
|
||||
type ForumTopic struct {
|
||||
MessageThreadID int `json:"message_thread_id"`
|
||||
Name string `json:"name"`
|
||||
@@ -8,8 +10,12 @@ type ForumTopic struct {
|
||||
IsNameImplicit bool `json:"is_name_implicit,omitempty"`
|
||||
}
|
||||
|
||||
// ForumTopicIconColor represents the color of a forum topic icon.
|
||||
// The value is an integer representing the color in RGB format.
|
||||
// See https://core.telegram.org/bots/api#forumtopiciconcolor
|
||||
type ForumTopicIconColor int
|
||||
|
||||
const (
|
||||
// ForumTopicIconColorBlue is the blue color for forum topic icons (value 7322096).
|
||||
ForumTopicIconColorBlue ForumTopicIconColor = 7322096
|
||||
)
|
||||
|
||||
@@ -1,10 +1,12 @@
|
||||
package tgapi
|
||||
|
||||
// SendMessageP holds parameters for the sendMessage method.
|
||||
// See https://core.telegram.org/bots/api#sendmessage
|
||||
type SendMessageP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
DirectMessagesTopicID int64 `json:"direct_messages_topic_id,omitempty"`
|
||||
|
||||
Text string `json:"text"`
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
@@ -20,18 +22,22 @@ type SendMessageP struct {
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendMessage sends a text message.
|
||||
// See https://core.telegram.org/bots/api#sendmessage
|
||||
func (api *API) SendMessage(params SendMessageP) (Message, error) {
|
||||
req := NewRequest[Message, SendMessageP]("sendMessage", params)
|
||||
req := NewRequestWithChatID[Message, SendMessageP]("sendMessage", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// ForwardMessageP holds parameters for the forwardMessage method.
|
||||
// See https://core.telegram.org/bots/api#forwardmessage
|
||||
type ForwardMessageP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
|
||||
MessageID int `json:"message_id,omitempty"`
|
||||
FromChatID int `json:"from_chat_id,omitempty"`
|
||||
FromChatID int64 `json:"from_chat_id,omitempty"`
|
||||
VideoStartTimestamp int `json:"video_start_timestamp,omitempty"`
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
@@ -40,33 +46,42 @@ type ForwardMessageP struct {
|
||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||
}
|
||||
|
||||
// ForwardMessage forwards a message.
|
||||
// See https://core.telegram.org/bots/api#forwardmessage
|
||||
func (api *API) ForwardMessage(params ForwardMessageP) (Message, error) {
|
||||
req := NewRequest[Message]("forwardMessage", params)
|
||||
req := NewRequestWithChatID[Message]("forwardMessage", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// ForwardMessagesP holds parameters for the forwardMessages method.
|
||||
// See https://core.telegram.org/bots/api#forwardmessages
|
||||
type ForwardMessagesP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
|
||||
FromChatID int `json:"from_chat_id,omitempty"`
|
||||
FromChatID int64 `json:"from_chat_id,omitempty"`
|
||||
MessageIDs []int `json:"message_ids,omitempty"`
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
}
|
||||
|
||||
// ForwardMessages forwards multiple messages.
|
||||
// Returns an array of message IDs of the sent messages.
|
||||
// See https://core.telegram.org/bots/api#forwardmessages
|
||||
func (api *API) ForwardMessages(params ForwardMessagesP) ([]int, error) {
|
||||
req := NewRequest[[]int]("forwardMessages", params)
|
||||
req := NewRequestWithChatID[[]int]("forwardMessages", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// CopyMessageP holds parameters for the copyMessage method.
|
||||
// See https://core.telegram.org/bots/api#copymessage
|
||||
type CopyMessageP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
|
||||
FromChatID int `json:"from_chat_id"`
|
||||
FromChatID int64 `json:"from_chat_id"`
|
||||
MessageID int `json:"message_id"`
|
||||
VideoStartTimestamp int `json:"video_start_timestamp,omitempty"`
|
||||
Caption string `json:"caption,omitempty"`
|
||||
@@ -84,31 +99,41 @@ type CopyMessageP struct {
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// CopyMessage copies a message.
|
||||
// Returns the MessageID of the sent copy.
|
||||
// See https://core.telegram.org/bots/api#copymessage
|
||||
func (api *API) CopyMessage(params CopyMessageP) (int, error) {
|
||||
req := NewRequest[int]("copyMessage", params)
|
||||
req := NewRequestWithChatID[int]("copyMessage", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// CopyMessagesP holds parameters for the copyMessages method.
|
||||
// See https://core.telegram.org/bots/api#copymessages
|
||||
type CopyMessagesP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
|
||||
FromChatID int `json:"from_chat_id,omitempty"`
|
||||
FromChatID int64 `json:"from_chat_id,omitempty"`
|
||||
MessageIDs []int `json:"message_ids,omitempty"`
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
RemoveCaption bool `json:"remove_caption,omitempty"`
|
||||
}
|
||||
|
||||
// CopyMessages copies multiple messages.
|
||||
// Returns an array of message IDs of the sent copies.
|
||||
// See https://core.telegram.org/bots/api#copymessages
|
||||
func (api *API) CopyMessages(params CopyMessagesP) ([]int, error) {
|
||||
req := NewRequest[[]int]("copyMessages", params)
|
||||
req := NewRequestWithChatID[[]int]("copyMessages", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SendLocationP holds parameters for the sendLocation method.
|
||||
// See https://core.telegram.org/bots/api#sendlocation
|
||||
type SendLocationP struct {
|
||||
BusinessConnectionID int `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
|
||||
@@ -129,14 +154,18 @@ type SendLocationP struct {
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendLocation sends a point on the map.
|
||||
// See https://core.telegram.org/bots/api#sendlocation
|
||||
func (api *API) SendLocation(params SendLocationP) (Message, error) {
|
||||
req := NewRequest[Message]("sendLocation", params)
|
||||
req := NewRequestWithChatID[Message]("sendLocation", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SendVenueP holds parameters for the sendVenue method.
|
||||
// See https://core.telegram.org/bots/api#sendvenue
|
||||
type SendVenueP struct {
|
||||
BusinessConnectionID int `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
|
||||
@@ -159,14 +188,18 @@ type SendVenueP struct {
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendVenue sends information about a venue.
|
||||
// See https://core.telegram.org/bots/api#sendvenue
|
||||
func (api *API) SendVenue(params SendVenueP) (Message, error) {
|
||||
req := NewRequest[Message]("sendVenue", params)
|
||||
req := NewRequestWithChatID[Message]("sendVenue", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SendContactP holds parameters for the sendContact method.
|
||||
// See https://core.telegram.org/bots/api#sendcontact
|
||||
type SendContactP struct {
|
||||
BusinessConnectionID int `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
|
||||
@@ -185,14 +218,18 @@ type SendContactP struct {
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendContact sends a phone contact.
|
||||
// See https://core.telegram.org/bots/api#sendcontact
|
||||
func (api *API) SendContact(params SendContactP) (Message, error) {
|
||||
req := NewRequest[Message]("sendContact", params)
|
||||
req := NewRequestWithChatID[Message]("sendContact", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SendPollP holds parameters for the sendPoll method.
|
||||
// See https://core.telegram.org/bots/api#sendpoll
|
||||
type SendPollP struct {
|
||||
BusinessConnectionID int `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
|
||||
Question string `json:"question"`
|
||||
@@ -219,14 +256,18 @@ type SendPollP struct {
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendPoll sends a native poll.
|
||||
// See https://core.telegram.org/bots/api#sendpoll
|
||||
func (api *API) SendPoll(params SendPollP) (Message, error) {
|
||||
req := NewRequest[Message]("sendPoll", params)
|
||||
req := NewRequestWithChatID[Message]("sendPoll", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SendChecklistP holds parameters for the sendChecklist method.
|
||||
// See https://core.telegram.org/bots/api#sendchecklist
|
||||
type SendChecklistP struct {
|
||||
BusinessConnectionID int `json:"business_connection_id"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
Checklist InputChecklist `json:"checklist"`
|
||||
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
@@ -237,14 +278,18 @@ type SendChecklistP struct {
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendChecklist sends a checklist.
|
||||
// See https://core.telegram.org/bots/api#sendchecklist
|
||||
func (api *API) SendChecklist(params SendChecklistP) (Message, error) {
|
||||
req := NewRequest[Message]("sendChecklist", params)
|
||||
req := NewRequestWithChatID[Message]("sendChecklist", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SendDiceP holds parameters for the sendDice method.
|
||||
// See https://core.telegram.org/bots/api#senddice
|
||||
type SendDiceP struct {
|
||||
BusinessConnectionID int `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
|
||||
@@ -260,13 +305,16 @@ type SendDiceP struct {
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendDice sends a dice, which will have a random value.
|
||||
// See https://core.telegram.org/bots/api#senddice
|
||||
func (api *API) SendDice(params SendDiceP) (Message, error) {
|
||||
req := NewRequest[Message]("sendDice", params)
|
||||
req := NewRequestWithChatID[Message]("sendDice", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SendMessageDraftP holds parameters for the sendMessageDraft method.
|
||||
type SendMessageDraftP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DraftID uint64 `json:"draft_id"`
|
||||
Text string `json:"text"`
|
||||
@@ -274,40 +322,51 @@ type SendMessageDraftP struct {
|
||||
Entities []MessageEntity `json:"entities,omitempty"`
|
||||
}
|
||||
|
||||
// SendMessageDraft sends a previously saved draft message.
|
||||
func (api *API) SendMessageDraft(params SendMessageDraftP) (bool, error) {
|
||||
req := NewRequest[bool]("sendMessageDraft", params)
|
||||
req := NewRequestWithChatID[bool]("sendMessageDraft", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SendChatActionP holds parameters for the sendChatAction method.
|
||||
// See https://core.telegram.org/bots/api#sendchataction
|
||||
type SendChatActionP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
Action ChatActionType `json:"action"`
|
||||
}
|
||||
|
||||
// SendChatAction sends a chat action (typing, uploading photo, etc.).
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#sendchataction
|
||||
func (api *API) SendChatAction(params SendChatActionP) (bool, error) {
|
||||
req := NewRequest[bool]("sendChatAction", params)
|
||||
req := NewRequestWithChatID[bool]("sendChatAction", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetMessageReactionP holds parameters for the setMessageReaction method.
|
||||
// See https://core.telegram.org/bots/api#setmessagereaction
|
||||
type SetMessageReactionP struct {
|
||||
ChatId int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageId int `json:"message_id"`
|
||||
Reaction []ReactionType `json:"reaction"`
|
||||
IsBig bool `json:"is_big,omitempty"`
|
||||
}
|
||||
|
||||
// SetMessageReaction changes the chosen reaction on a message.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#setmessagereaction
|
||||
func (api *API) SetMessageReaction(params SetMessageReactionP) (bool, error) {
|
||||
req := NewRequest[bool]("setMessageReaction", params)
|
||||
req := NewRequestWithChatID[bool]("setMessageReaction", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// Message update methods
|
||||
|
||||
// EditMessageTextP holds parameters for the editMessageText method.
|
||||
// See https://core.telegram.org/bots/api#editmessagetext
|
||||
type EditMessageTextP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id,omitempty"`
|
||||
MessageID int `json:"message_id,omitempty"`
|
||||
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||
Text string `json:"text"`
|
||||
@@ -315,23 +374,27 @@ type EditMessageTextP struct {
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// EditMessageText If inline message, first return will be zero-valued, and second will boolean
|
||||
// Otherwise, first return will be Message, and second false
|
||||
// EditMessageText edits text messages.
|
||||
// If inline_message_id is provided, returns a boolean success flag;
|
||||
// otherwise returns the edited Message.
|
||||
// See https://core.telegram.org/bots/api#editmessagetext
|
||||
func (api *API) EditMessageText(params EditMessageTextP) (Message, bool, error) {
|
||||
var zero Message
|
||||
if params.InlineMessageID != "" {
|
||||
req := NewRequest[bool]("editMessageText", params)
|
||||
req := NewRequestWithChatID[bool]("editMessageText", params, params.ChatID)
|
||||
res, err := req.Do(api)
|
||||
return zero, res, err
|
||||
}
|
||||
req := NewRequest[Message]("editMessageText", params)
|
||||
req := NewRequestWithChatID[Message]("editMessageText", params, params.ChatID)
|
||||
res, err := req.Do(api)
|
||||
return res, false, err
|
||||
}
|
||||
|
||||
// EditMessageCaptionP holds parameters for the editMessageCaption method.
|
||||
// See https://core.telegram.org/bots/api#editmessagecaption
|
||||
type EditMessageCaptionP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id,omitempty"`
|
||||
MessageID int `json:"message_id,omitempty"`
|
||||
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||
Caption string `json:"caption"`
|
||||
@@ -339,46 +402,54 @@ type EditMessageCaptionP struct {
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// EditMessageCaption If inline message, first return will be zero-valued, and second will boolean
|
||||
// Otherwise, first return will be Message, and second false
|
||||
// EditMessageCaption edits captions of messages.
|
||||
// If inline_message_id is provided, returns a boolean success flag;
|
||||
// otherwise returns the edited Message.
|
||||
// See https://core.telegram.org/bots/api#editmessagecaption
|
||||
func (api *API) EditMessageCaption(params EditMessageCaptionP) (Message, bool, error) {
|
||||
var zero Message
|
||||
if params.InlineMessageID != "" {
|
||||
req := NewRequest[bool]("editMessageCaption", params)
|
||||
req := NewRequestWithChatID[bool]("editMessageCaption", params, params.ChatID)
|
||||
res, err := req.Do(api)
|
||||
return zero, res, err
|
||||
}
|
||||
req := NewRequest[Message]("editMessageCaption", params)
|
||||
req := NewRequestWithChatID[Message]("editMessageCaption", params, params.ChatID)
|
||||
res, err := req.Do(api)
|
||||
return res, false, err
|
||||
}
|
||||
|
||||
// EditMessageMediaP holds parameters for the editMessageMedia method.
|
||||
// See https://core.telegram.org/bots/api#editmessagemedia
|
||||
type EditMessageMediaP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id,omitempty"`
|
||||
MessageID int `json:"message_id,omitempty"`
|
||||
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||
Message InputMedia `json:"message"`
|
||||
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// EditMessageMedia If inline message, first return will be zero-valued, and second will boolean
|
||||
// Otherwise, first return will be Message, and second false
|
||||
// EditMessageMedia edits media messages.
|
||||
// If inline_message_id is provided, returns a boolean success flag;
|
||||
// otherwise returns the edited Message.
|
||||
// See https://core.telegram.org/bots/api#editmessagemedia
|
||||
func (api *API) EditMessageMedia(params EditMessageMediaP) (Message, bool, error) {
|
||||
var zero Message
|
||||
if params.InlineMessageID != "" {
|
||||
req := NewRequest[bool]("editMessageMedia", params)
|
||||
req := NewRequestWithChatID[bool]("editMessageMedia", params, params.ChatID)
|
||||
res, err := req.Do(api)
|
||||
return zero, res, err
|
||||
}
|
||||
req := NewRequest[Message]("editMessageMedia", params)
|
||||
req := NewRequestWithChatID[Message]("editMessageMedia", params, params.ChatID)
|
||||
res, err := req.Do(api)
|
||||
return res, false, err
|
||||
}
|
||||
|
||||
// EditMessageLiveLocationP holds parameters for the editMessageLiveLocation method.
|
||||
// See https://core.telegram.org/bots/api#editmessagelivelocation
|
||||
type EditMessageLiveLocationP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id,omitempty"`
|
||||
MessageID int `json:"message_id,omitempty"`
|
||||
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||
|
||||
@@ -391,129 +462,171 @@ type EditMessageLiveLocationP struct {
|
||||
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// EditMessageLiveLocation If inline message, first return will be zero-valued, and second will boolean
|
||||
// Otherwise, first return will be Message, and second false
|
||||
// EditMessageLiveLocation edits live location messages.
|
||||
// If inline_message_id is provided, returns a boolean success flag;
|
||||
// otherwise returns the edited Message.
|
||||
// See https://core.telegram.org/bots/api#editmessagelivelocation
|
||||
func (api *API) EditMessageLiveLocation(params EditMessageLiveLocationP) (Message, bool, error) {
|
||||
var zero Message
|
||||
if params.InlineMessageID != "" {
|
||||
req := NewRequest[bool]("editMessageLiveLocation", params)
|
||||
req := NewRequestWithChatID[bool]("editMessageLiveLocation", params, params.ChatID)
|
||||
res, err := req.Do(api)
|
||||
return zero, res, err
|
||||
}
|
||||
req := NewRequest[Message]("editMessageLiveLocation", params)
|
||||
req := NewRequestWithChatID[Message]("editMessageLiveLocation", params, params.ChatID)
|
||||
res, err := req.Do(api)
|
||||
return res, false, err
|
||||
}
|
||||
|
||||
// StopMessageLiveLocationP holds parameters for the stopMessageLiveLocation method.
|
||||
// See https://core.telegram.org/bots/api#stopmessagelivelocation
|
||||
type StopMessageLiveLocationP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id,omitempty"`
|
||||
MessageID int `json:"message_id,omitempty"`
|
||||
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// StopMessageLiveLocation If inline message, first return will be zero-valued, and second will boolean
|
||||
// Otherwise, first return will be Message, and second false
|
||||
// StopMessageLiveLocation stops a live location message.
|
||||
// If inline_message_id is provided, returns a boolean success flag;
|
||||
// otherwise returns the edited Message.
|
||||
// See https://core.telegram.org/bots/api#stopmessagelivelocation
|
||||
func (api *API) StopMessageLiveLocation(params StopMessageLiveLocationP) (Message, bool, error) {
|
||||
var zero Message
|
||||
if params.InlineMessageID != "" {
|
||||
req := NewRequest[bool]("stopMessageLiveLocation", params)
|
||||
req := NewRequestWithChatID[bool]("stopMessageLiveLocation", params, params.ChatID)
|
||||
res, err := req.Do(api)
|
||||
return zero, res, err
|
||||
}
|
||||
req := NewRequest[Message]("stopMessageLiveLocation", params)
|
||||
req := NewRequestWithChatID[Message]("stopMessageLiveLocation", params, params.ChatID)
|
||||
res, err := req.Do(api)
|
||||
return res, false, err
|
||||
}
|
||||
|
||||
// EditMessageChecklistP holds parameters for the editMessageChecklist method.
|
||||
type EditMessageChecklistP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageID int `json:"message_id"`
|
||||
Checklist InputChecklist `json:"checklist"`
|
||||
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// EditMessageChecklist edits a checklist message.
|
||||
// See https://core.telegram.org/bots/api#editmessagechecklist
|
||||
func (api *API) EditMessageChecklist(params EditMessageChecklistP) (Message, error) {
|
||||
req := NewRequest[Message]("editMessageChecklist", params)
|
||||
req := NewRequestWithChatID[Message]("editMessageChecklist", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// EditMessageReplyMarkupP holds parameters for the editMessageReplyMarkup method.
|
||||
// See https://core.telegram.org/bots/api#editmessagereplymarkup
|
||||
type EditMessageReplyMarkupP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id,omitempty"`
|
||||
MessageID int `json:"message_id,omitempty"`
|
||||
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// EditMessageReplyMarkup edits only the reply markup of messages.
|
||||
// If inline_message_id is provided, returns a boolean success flag;
|
||||
// otherwise returns the edited Message.
|
||||
// See https://core.telegram.org/bots/api#editmessagereplymarkup
|
||||
func (api *API) EditMessageReplyMarkup(params EditMessageReplyMarkupP) (Message, bool, error) {
|
||||
var zero Message
|
||||
if params.InlineMessageID != "" {
|
||||
req := NewRequest[bool]("editMessageReplyMarkup", params)
|
||||
req := NewRequestWithChatID[bool]("editMessageReplyMarkup", params, params.ChatID)
|
||||
res, err := req.Do(api)
|
||||
return zero, res, err
|
||||
}
|
||||
req := NewRequest[Message]("editMessageReplyMarkup", params)
|
||||
req := NewRequestWithChatID[Message]("editMessageReplyMarkup", params, params.ChatID)
|
||||
res, err := req.Do(api)
|
||||
return res, false, err
|
||||
}
|
||||
|
||||
// StopPollP holds parameters for the stopPoll method.
|
||||
// See https://core.telegram.org/bots/api#stoppoll
|
||||
type StopPollP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageID int `json:"message_id"`
|
||||
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||
}
|
||||
|
||||
// StopPoll stops a poll that was sent by the bot.
|
||||
// Returns the stopped Poll.
|
||||
// See https://core.telegram.org/bots/api#stoppoll
|
||||
func (api *API) StopPoll(params StopPollP) (Poll, error) {
|
||||
req := NewRequest[Poll]("stopPoll", params)
|
||||
req := NewRequestWithChatID[Poll]("stopPoll", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// ApproveSuggestedPostP holds parameters for the approveSuggestedPost method.
|
||||
// See https://core.telegram.org/bots/api#approvesuggestedpost
|
||||
type ApproveSuggestedPostP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageID int `json:"message_id"`
|
||||
SendDate int `json:"send_date,omitempty"`
|
||||
}
|
||||
|
||||
// ApproveSuggestedPost approves a suggested channel post.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#approvesuggestedpost
|
||||
func (api *API) ApproveSuggestedPost(params ApproveSuggestedPostP) (bool, error) {
|
||||
req := NewRequest[bool]("approveSuggestedPost", params)
|
||||
req := NewRequestWithChatID[bool]("approveSuggestedPost", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// DeclineSuggestedPostP holds parameters for the declineSuggestedPost method.
|
||||
// See https://core.telegram.org/bots/api#declinesuggestedpost
|
||||
type DeclineSuggestedPostP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageID int `json:"message_id"`
|
||||
Comment string `json:"comment,omitempty"`
|
||||
}
|
||||
|
||||
// DeclineSuggestedPost declines a suggested channel post.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#declinesuggestedpost
|
||||
func (api *API) DeclineSuggestedPost(params DeclineSuggestedPostP) (bool, error) {
|
||||
req := NewRequest[bool]("declineSuggestedPost", params)
|
||||
req := NewRequestWithChatID[bool]("declineSuggestedPost", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// DeleteMessageP holds parameters for the deleteMessage method.
|
||||
// See https://core.telegram.org/bots/api#deletemessage
|
||||
type DeleteMessageP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageID int `json:"message_id"`
|
||||
}
|
||||
|
||||
// DeleteMessage deletes a message.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#deletemessage
|
||||
func (api *API) DeleteMessage(params DeleteMessageP) (bool, error) {
|
||||
req := NewRequest[bool]("deleteMessage", params)
|
||||
req := NewRequestWithChatID[bool]("deleteMessage", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// DeleteMessagesP holds parameters for the deleteMessages method.
|
||||
// See https://core.telegram.org/bots/api#deletemessages
|
||||
type DeleteMessagesP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageIDs []int `json:"message_ids"`
|
||||
}
|
||||
|
||||
// DeleteMessages deletes multiple messages at once.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#deletemessages
|
||||
func (api *API) DeleteMessages(params DeleteMessagesP) (bool, error) {
|
||||
req := NewRequest[bool]("deleteMessages", params)
|
||||
req := NewRequestWithChatID[bool]("deleteMessages", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// AnswerCallbackQueryP holds parameters for the answerCallbackQuery method.
|
||||
// See https://core.telegram.org/bots/api#answercallbackquery
|
||||
type AnswerCallbackQueryP struct {
|
||||
CallbackQueryID string `json:"callback_query_id"`
|
||||
Text string `json:"text,omitempty"`
|
||||
@@ -522,6 +635,9 @@ type AnswerCallbackQueryP struct {
|
||||
CacheTime int `json:"cache_time,omitempty"`
|
||||
}
|
||||
|
||||
// AnswerCallbackQuery sends answers to callback queries sent from inline keyboards.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#answercallbackquery
|
||||
func (api *API) AnswerCallbackQuery(params AnswerCallbackQueryP) (bool, error) {
|
||||
req := NewRequest[bool]("answerCallbackQuery", params)
|
||||
return req.Do(api)
|
||||
|
||||
@@ -2,13 +2,24 @@ package tgapi
|
||||
|
||||
import "git.nix13.pw/scuroneko/extypes"
|
||||
|
||||
// MessageReplyMarkup represents an inline keyboard markup for a message.
|
||||
// It is used in the Message type.
|
||||
type MessageReplyMarkup struct {
|
||||
InlineKeyboard [][]InlineKeyboardButton `json:"inline_keyboard"`
|
||||
}
|
||||
|
||||
// DirectMessageTopic represents a forum topic in a direct message.
|
||||
type DirectMessageTopic struct {
|
||||
TopicID int64 `json:"topic_id"`
|
||||
User *User `json:"user,omitempty"`
|
||||
}
|
||||
|
||||
// Message represents a Telegram message.
|
||||
// See https://core.telegram.org/bots/api#message
|
||||
type Message struct {
|
||||
MessageID int `json:"message_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessageTopic *DirectMessageTopic `json:"direct_message_topic,omitempty"`
|
||||
BusinessConnectionId string `json:"business_connection_id,omitempty"`
|
||||
From *User `json:"from,omitempty"`
|
||||
|
||||
@@ -45,14 +56,19 @@ type Message struct {
|
||||
EffectID string `json:"effect_id,omitempty"`
|
||||
}
|
||||
|
||||
// InaccessibleMessage describes a message that was deleted or is otherwise inaccessible.
|
||||
// See https://core.telegram.org/bots/api#inaccessiblemessage
|
||||
type InaccessibleMessage struct {
|
||||
Chat Chat `json:"chat"`
|
||||
MessageID int `json:"message_id"`
|
||||
Date int `json:"date"`
|
||||
}
|
||||
|
||||
// MaybeInaccessibleMessage is a union type that can be either Message or InaccessibleMessage.
|
||||
// See https://core.telegram.org/bots/api#maybeinaccessiblemessage
|
||||
type MaybeInaccessibleMessage interface{ Message | InaccessibleMessage }
|
||||
|
||||
// MessageEntityType represents the type of a message entity.
|
||||
type MessageEntityType string
|
||||
|
||||
const (
|
||||
@@ -78,6 +94,8 @@ const (
|
||||
MessageEntityDateTime MessageEntityType = "date_time"
|
||||
)
|
||||
|
||||
// MessageEntity represents one special entity in a text message.
|
||||
// See https://core.telegram.org/bots/api#messageentity
|
||||
type MessageEntity struct {
|
||||
Type MessageEntityType `json:"type"`
|
||||
|
||||
@@ -92,6 +110,8 @@ type MessageEntity struct {
|
||||
DateTimeFormat string `json:"date_time_format,omitempty"`
|
||||
}
|
||||
|
||||
// ReplyParameters describes the parameters to use when replying to a message.
|
||||
// See https://core.telegram.org/bots/api#replyparameters
|
||||
type ReplyParameters struct {
|
||||
MessageID int `json:"message_id"`
|
||||
ChatID int `json:"chat_id,omitempty"`
|
||||
@@ -104,6 +124,8 @@ type ReplyParameters struct {
|
||||
ChecklistTaskID int `json:"checklist_task_id,omitempty"`
|
||||
}
|
||||
|
||||
// LinkPreviewOptions describes the options used for link preview generation.
|
||||
// See https://core.telegram.org/bots/api#linkpreviewoptions
|
||||
type LinkPreviewOptions struct {
|
||||
IsDisabled bool `json:"is_disabled,omitempty"`
|
||||
URL string `json:"url,omitempty"`
|
||||
@@ -112,6 +134,8 @@ type LinkPreviewOptions struct {
|
||||
ShowAboveText bool `json:"show_above_text,omitempty"`
|
||||
}
|
||||
|
||||
// ReplyMarkup represents a custom keyboard or inline keyboard.
|
||||
// See https://core.telegram.org/bots/api#replymarkup
|
||||
type ReplyMarkup struct {
|
||||
InlineKeyboard [][]InlineKeyboardButton `json:"inline_keyboard,omitempty"`
|
||||
|
||||
@@ -126,11 +150,18 @@ type ReplyMarkup struct {
|
||||
|
||||
ForceReply bool `json:"force_reply,omitempty"`
|
||||
}
|
||||
|
||||
// InlineKeyboardMarkup represents an inline keyboard that appears right next to the message it belongs to.
|
||||
// See https://core.telegram.org/bots/api#inlinekeyboardmarkup
|
||||
type InlineKeyboardMarkup struct {
|
||||
InlineKeyboard [][]InlineKeyboardButton `json:"inline_keyboard,omitempty"`
|
||||
}
|
||||
|
||||
// KeyboardButtonStyle represents the style of a keyboard button.
|
||||
type KeyboardButtonStyle string
|
||||
|
||||
// InlineKeyboardButton represents one button of an inline keyboard.
|
||||
// See https://core.telegram.org/bots/api#inlinekeyboardbutton
|
||||
type InlineKeyboardButton struct {
|
||||
Text string `json:"text"`
|
||||
URL string `json:"url,omitempty"`
|
||||
@@ -139,10 +170,14 @@ type InlineKeyboardButton struct {
|
||||
IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
|
||||
}
|
||||
|
||||
// ReplyKeyboardMarkup represents a custom keyboard with reply options.
|
||||
// See https://core.telegram.org/bots/api#replykeyboardmarkup
|
||||
type ReplyKeyboardMarkup struct {
|
||||
Keyboard [][]int `json:"keyboard"`
|
||||
}
|
||||
|
||||
// CallbackQuery represents an incoming callback query from a callback button in an inline keyboard.
|
||||
// See https://core.telegram.org/bots/api#callbackquery
|
||||
type CallbackQuery struct {
|
||||
ID string `json:"id"`
|
||||
From User `json:"from"`
|
||||
@@ -151,11 +186,15 @@ type CallbackQuery struct {
|
||||
Data string `json:"data"`
|
||||
}
|
||||
|
||||
// InputPollOption contains information about one answer option in a poll to be sent.
|
||||
// See https://core.telegram.org/bots/api#inputpolloption
|
||||
type InputPollOption struct {
|
||||
Text string `json:"text"`
|
||||
TextParseMode ParseMode `json:"text_parse_mode,omitempty"`
|
||||
TextEntities []*MessageEntity `json:"text_entities,omitempty"`
|
||||
}
|
||||
|
||||
// PollType represents the type of a poll.
|
||||
type PollType string
|
||||
|
||||
const (
|
||||
@@ -163,12 +202,15 @@ const (
|
||||
PollTypeQuiz PollType = "quiz"
|
||||
)
|
||||
|
||||
// InputChecklistTask describes a task in a checklist.
|
||||
type InputChecklistTask struct {
|
||||
ID int `json:"id"`
|
||||
Text string `json:"text"`
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
TextEntities []*MessageEntity `json:"text_entities,omitempty"`
|
||||
}
|
||||
|
||||
// InputChecklist represents a checklist to be sent.
|
||||
type InputChecklist struct {
|
||||
Title string `json:"title"`
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
@@ -178,6 +220,7 @@ type InputChecklist struct {
|
||||
OtherCanMarkTasksAsDone bool `json:"other_can_mark_tasks_as_done,omitempty"`
|
||||
}
|
||||
|
||||
// ChatActionType represents the type of chat action.
|
||||
type ChatActionType string
|
||||
|
||||
const (
|
||||
@@ -191,6 +234,8 @@ const (
|
||||
ChatActionUploadVideoNone ChatActionType = "upload_video_none"
|
||||
)
|
||||
|
||||
// MessageReactionUpdated represents a change of a reaction on a message.
|
||||
// See https://core.telegram.org/bots/api#messagereactionupdated
|
||||
type MessageReactionUpdated struct {
|
||||
Chat *Chat `json:"chat"`
|
||||
MessageID int `json:"message_id"`
|
||||
@@ -201,12 +246,17 @@ type MessageReactionUpdated struct {
|
||||
NewReaction []ReactionType `json:"new_reaction"`
|
||||
}
|
||||
|
||||
// MessageReactionCountUpdated represents a change in the count of reactions on a message.
|
||||
// See https://core.telegram.org/bots/api#messagereactioncountupdated
|
||||
type MessageReactionCountUpdated struct {
|
||||
Chat *Chat `json:"chat"`
|
||||
MessageID int `json:"message_id"`
|
||||
Date int `json:"date"`
|
||||
Reactions []*ReactionCount `json:"reactions"`
|
||||
}
|
||||
|
||||
// ReactionType describes the type of a reaction.
|
||||
// See https://core.telegram.org/bots/api#reactiontype
|
||||
type ReactionType struct {
|
||||
Type string `json:"type"`
|
||||
// ReactionTypeEmoji
|
||||
@@ -214,20 +264,29 @@ type ReactionType struct {
|
||||
// ReactionTypeCustomEmoji
|
||||
CustomEmojiID *string `json:"custom_emoji_id,omitempty"`
|
||||
}
|
||||
|
||||
// ReactionCount represents a reaction added to a message along with the number of times it was added.
|
||||
// See https://core.telegram.org/bots/api#reactioncount
|
||||
type ReactionCount struct {
|
||||
Type ReactionType `json:"type"`
|
||||
TotalCount int `json:"total_count"`
|
||||
}
|
||||
|
||||
// SuggestedPostPrice represents the price of a suggested post.
|
||||
type SuggestedPostPrice struct {
|
||||
Currency string `json:"currency"`
|
||||
Amount int `json:"amount"`
|
||||
}
|
||||
|
||||
// SuggestedPostInfo contains information about a suggested post.
|
||||
// See https://core.telegram.org/bots/api#suggestedpostinfo
|
||||
type SuggestedPostInfo struct {
|
||||
State string `json:"state"` //State of the suggested post. Currently, it can be one of “pending”, “approved”, “declined”.
|
||||
State string `json:"state"` // "pending", "approved", or "declined"
|
||||
Price SuggestedPostPrice `json:"price"`
|
||||
SendDate int `json:"send_date"`
|
||||
}
|
||||
|
||||
// SuggestedPostParameters holds parameters for suggesting a post.
|
||||
type SuggestedPostParameters struct {
|
||||
Price SuggestedPostPrice `json:"price"`
|
||||
SendDate int `json:"send_date"`
|
||||
|
||||
@@ -6,18 +6,28 @@ import (
|
||||
"net/http"
|
||||
)
|
||||
|
||||
// ParseMode represents the text formatting mode for message parsing.
|
||||
type ParseMode string
|
||||
|
||||
const (
|
||||
// ParseMDV2 enables MarkdownV2 style parsing.
|
||||
ParseMDV2 ParseMode = "MarkdownV2"
|
||||
// ParseHTML enables HTML style parsing.
|
||||
ParseHTML ParseMode = "HTML"
|
||||
// ParseMD enables legacy Markdown style parsing.
|
||||
ParseMD ParseMode = "Markdown"
|
||||
// ParseNone disables any parsing.
|
||||
ParseNone ParseMode = "None"
|
||||
)
|
||||
|
||||
// EmptyParams is a placeholder for methods that take no parameters.
|
||||
type EmptyParams struct{}
|
||||
|
||||
// NoParams is a convenient instance of EmptyParams.
|
||||
var NoParams = EmptyParams{}
|
||||
|
||||
// UpdateParams holds parameters for the getUpdates method.
|
||||
// See https://core.telegram.org/bots/api#getupdates
|
||||
type UpdateParams struct {
|
||||
Offset *int `json:"offset,omitempty"`
|
||||
Limit *int `json:"limit,omitempty"`
|
||||
@@ -25,38 +35,60 @@ type UpdateParams struct {
|
||||
AllowedUpdates []UpdateType `json:"allowed_updates"`
|
||||
}
|
||||
|
||||
// GetMe returns basic information about the bot.
|
||||
// See https://core.telegram.org/bots/api#getme
|
||||
func (api *API) GetMe() (User, error) {
|
||||
req := NewRequest[User, EmptyParams]("getMe", NoParams)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// LogOut logs the bot out from the cloud Bot API server.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#logout
|
||||
func (api *API) LogOut() (bool, error) {
|
||||
req := NewRequest[bool, EmptyParams]("logOut", NoParams)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// Close closes the bot instance on the local server.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#close
|
||||
func (api *API) Close() (bool, error) {
|
||||
req := NewRequest[bool, EmptyParams]("close", NoParams)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// GetUpdates receives incoming updates using long polling.
|
||||
// See https://core.telegram.org/bots/api#getupdates
|
||||
func (api *API) GetUpdates(params UpdateParams) ([]Update, error) {
|
||||
req := NewRequest[[]Update]("getUpdates", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// GetFileP holds parameters for the getFile method.
|
||||
// See https://core.telegram.org/bots/api#getfile
|
||||
type GetFileP struct {
|
||||
FileId string `json:"file_id"`
|
||||
}
|
||||
|
||||
// GetFile returns basic information about a file and prepares it for downloading.
|
||||
// See https://core.telegram.org/bots/api#getfile
|
||||
func (api *API) GetFile(params GetFileP) (File, error) {
|
||||
req := NewRequest[File]("getFile", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// GetFileByLink downloads a file from Telegram's file server using the provided file link.
|
||||
// The link is usually obtained from File.FilePath.
|
||||
// See https://core.telegram.org/bots/api#file
|
||||
func (api *API) GetFileByLink(link string) ([]byte, error) {
|
||||
u := fmt.Sprintf("https://api.telegram.org/file/bot%s/%s", api.token, link)
|
||||
res, err := http.Get(u)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer res.Body.Close()
|
||||
defer func() {
|
||||
_ = res.Body.Close()
|
||||
}()
|
||||
return io.ReadAll(res.Body)
|
||||
}
|
||||
|
||||
132
tgapi/pool.go
132
tgapi/pool.go
@@ -2,91 +2,141 @@ package tgapi
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"sync"
|
||||
)
|
||||
|
||||
var ErrPoolQueueFull = errors.New("worker pool queue full")
|
||||
|
||||
type RequestEnvelope struct {
|
||||
DoFunc func(context.Context) (any, error) // функция, которая выполнит запрос и вернет any
|
||||
ResultCh chan RequestResult // канал для результата
|
||||
}
|
||||
type RequestResult struct {
|
||||
Value any
|
||||
Err error
|
||||
// workerPool — приватная структура, управляющая пулом воркеров.
|
||||
// Внешний код не может создавать или напрямую взаимодействовать с этой структурой.
|
||||
// Используется только через экспортируемые методы newWorkerPool, start, stop, submit.
|
||||
type workerPool struct {
|
||||
taskCh chan requestEnvelope // канал для принятия задач (буферизованный)
|
||||
queueSize int // максимальный размер очереди
|
||||
workers int // количество воркеров (горутин)
|
||||
wg sync.WaitGroup // синхронизирует завершение всех воркеров при остановке
|
||||
quit chan struct{} // канал для сигнала остановки
|
||||
started bool // флаг, указывающий, запущен ли пул
|
||||
startedMu sync.Mutex // мьютекс для безопасного доступа к started
|
||||
}
|
||||
|
||||
// WorkerPool управляет воркерами и очередью
|
||||
type WorkerPool struct {
|
||||
taskCh chan RequestEnvelope
|
||||
queueSize int
|
||||
workers int
|
||||
wg sync.WaitGroup
|
||||
quit chan struct{}
|
||||
started bool
|
||||
startedMu sync.Mutex
|
||||
// requestEnvelope — приватная структура, инкапсулирующая задачу и канал для результата.
|
||||
// Используется только внутри пакета для передачи задач воркерам.
|
||||
type requestEnvelope struct {
|
||||
doFunc func(context.Context) (any, error) // функция, выполняющая запрос
|
||||
resultCh chan requestResult // канал, через который воркер вернёт результат
|
||||
}
|
||||
|
||||
func NewWorkerPool(workers int, queueSize int) *WorkerPool {
|
||||
return &WorkerPool{
|
||||
taskCh: make(chan RequestEnvelope, queueSize),
|
||||
// requestResult — приватная структура, представляющая результат выполнения задачи.
|
||||
// Внешний код получает его через канал, но не знает структуры — только через <-chan requestResult.
|
||||
type requestResult struct {
|
||||
value any // значение, возвращённое задачей
|
||||
err error // ошибка, если возникла
|
||||
}
|
||||
|
||||
// newWorkerPool создаёт новый пул воркеров с заданным количеством горутин и размером очереди.
|
||||
// Это единственный способ создать workerPool — внешний код не может создать его напрямую.
|
||||
func newWorkerPool(workers int, queueSize int) *workerPool {
|
||||
if workers <= 0 {
|
||||
workers = 1 // защита от некорректных значений
|
||||
}
|
||||
if queueSize <= 0 {
|
||||
queueSize = 100 // разумный дефолт
|
||||
}
|
||||
|
||||
return &workerPool{
|
||||
taskCh: make(chan requestEnvelope, queueSize),
|
||||
queueSize: queueSize,
|
||||
workers: workers,
|
||||
quit: make(chan struct{}),
|
||||
}
|
||||
}
|
||||
|
||||
// Start запускает воркеров
|
||||
func (p *WorkerPool) Start(ctx context.Context) {
|
||||
// start запускает воркеры (горутины), которые будут обрабатывать задачи из очереди.
|
||||
// Метод идемпотентен: если пул уже запущен — ничего не делает.
|
||||
// Должен вызываться перед первым вызовом submit.
|
||||
func (p *workerPool) start(ctx context.Context) {
|
||||
p.startedMu.Lock()
|
||||
defer p.startedMu.Unlock()
|
||||
if p.started {
|
||||
return
|
||||
return // уже запущен — ничего не делаем
|
||||
}
|
||||
p.started = true
|
||||
|
||||
// Запускаем воркеры — каждый будет обрабатывать задачи в бесконечном цикле
|
||||
for i := 0; i < p.workers; i++ {
|
||||
p.wg.Add(1)
|
||||
go p.worker(ctx)
|
||||
go p.worker(ctx) // запускаем горутину с контекстом
|
||||
}
|
||||
}
|
||||
|
||||
// Stop останавливает пул (ждет завершения текущих задач)
|
||||
func (p *WorkerPool) Stop() {
|
||||
close(p.quit)
|
||||
p.wg.Wait()
|
||||
// stop останавливает пул воркеров.
|
||||
// Отправляет сигнал остановки через quit-канал и ждёт завершения всех активных задач.
|
||||
// Безопасно вызывать многократно — после остановки повторные вызовы не имеют эффекта.
|
||||
func (p *workerPool) stop() {
|
||||
close(p.quit) // сигнал для всех воркеров — выйти из цикла
|
||||
p.wg.Wait() // ждём, пока все воркеры завершатся
|
||||
}
|
||||
|
||||
// Submit отправляет задачу в очередь и возвращает канал для результата
|
||||
func (p *WorkerPool) Submit(ctx context.Context, do func(context.Context) (any, error)) (<-chan RequestResult, error) {
|
||||
// submit отправляет задачу в очередь и возвращает канал, через который будет получен результат.
|
||||
// Если очередь переполнена — возвращает ErrPoolQueueFull.
|
||||
// Канал результата имеет буфер 1, чтобы не блокировать воркера при записи.
|
||||
// Контекст используется для отмены задачи, если клиент отменил запрос до отправки.
|
||||
func (p *workerPool) submit(ctx context.Context, do func(context.Context) (any, error)) (<-chan requestResult, error) {
|
||||
// Проверяем, не превышена ли очередь
|
||||
if len(p.taskCh) >= p.queueSize {
|
||||
return nil, ErrPoolQueueFull
|
||||
}
|
||||
|
||||
resultCh := make(chan RequestResult, 1) // буфер 1, чтобы не блокировать воркера
|
||||
envelope := RequestEnvelope{do, resultCh}
|
||||
// Создаём канал для результата — буферизованный, чтобы не блокировать воркера
|
||||
resultCh := make(chan requestResult, 1)
|
||||
|
||||
// Создаём обёртку задачи
|
||||
envelope := requestEnvelope{
|
||||
doFunc: do,
|
||||
resultCh: resultCh,
|
||||
}
|
||||
|
||||
// Пытаемся отправить задачу в очередь
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
// Клиент отменил операцию до отправки — возвращаем ошибку отмены
|
||||
return nil, ctx.Err()
|
||||
case p.taskCh <- envelope:
|
||||
// Успешно отправлено — возвращаем канал для чтения результата
|
||||
return resultCh, nil
|
||||
default:
|
||||
// Очередь переполнена — не должно происходить при проверке len(p.taskCh), но на всякий случай
|
||||
return nil, ErrPoolQueueFull
|
||||
}
|
||||
}
|
||||
|
||||
// worker выполняет задачи
|
||||
func (p *WorkerPool) worker(ctx context.Context) {
|
||||
defer p.wg.Done()
|
||||
// worker — приватная горутина, выполняющая задачи из очереди.
|
||||
// Каждый воркер работает в бесконечном цикле, пока не получит сигнал остановки.
|
||||
// При получении задачи:
|
||||
// - вызывает doFunc с контекстом
|
||||
// - записывает результат в resultCh
|
||||
// - закрывает канал, чтобы клиент мог прочитать и завершить
|
||||
//
|
||||
// После закрытия quit-канала — воркер завершает работу.
|
||||
func (p *workerPool) worker(ctx context.Context) {
|
||||
defer p.wg.Done() // уменьшаем WaitGroup при завершении горутины
|
||||
|
||||
for {
|
||||
select {
|
||||
case <-p.quit:
|
||||
// Получен сигнал остановки — выходим из цикла
|
||||
return
|
||||
|
||||
case envelope := <-p.taskCh:
|
||||
// Выполняем задачу с переданным контекстом (или можно использовать свой)
|
||||
val, err := envelope.DoFunc(ctx)
|
||||
envelope.ResultCh <- RequestResult{Value: val, Err: err}
|
||||
close(envelope.ResultCh)
|
||||
// Выполняем задачу с переданным контекстом (клиентский или общий)
|
||||
value, err := envelope.doFunc(ctx)
|
||||
|
||||
// Записываем результат в канал — не блокируем, т.к. буфер 1
|
||||
envelope.resultCh <- requestResult{
|
||||
value: value,
|
||||
err: err,
|
||||
}
|
||||
// Закрываем канал — клиент знает, что результат пришёл и больше не будет
|
||||
close(envelope.resultCh)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
package tgapi
|
||||
|
||||
// SendStickerP holds parameters for the sendSticker method.
|
||||
// See https://core.telegram.org/bots/api#sendsticker
|
||||
type SendStickerP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
|
||||
@@ -14,29 +16,41 @@ type SendStickerP struct {
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
}
|
||||
|
||||
// SendSticker sends a static .WEBP, animated .TGS, or video .WEBM sticker.
|
||||
// See https://core.telegram.org/bots/api#sendsticker
|
||||
func (api *API) SendSticker(params SendStickerP) (Message, error) {
|
||||
req := NewRequest[Message]("sendSticker", params)
|
||||
req := NewRequestWithChatID[Message]("sendSticker", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// GetStickerSetP holds parameters for the getStickerSet method.
|
||||
// See https://core.telegram.org/bots/api#getstickerset
|
||||
type GetStickerSetP struct {
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
// GetStickerSet returns a sticker set by its name.
|
||||
// See https://core.telegram.org/bots/api#getstickerset
|
||||
func (api *API) GetStickerSet(params GetStickerSetP) (StickerSet, error) {
|
||||
req := NewRequest[StickerSet]("getStickerSet", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// GetCustomEmojiStickersP holds parameters for the getCustomEmojiStickers method.
|
||||
// See https://core.telegram.org/bots/api#getcustomemojistickers
|
||||
type GetCustomEmojiStickersP struct {
|
||||
CustomEmojiIDs []string `json:"custom_emoji_ids"`
|
||||
}
|
||||
|
||||
// GetCustomEmojiStickers returns information about custom emoji stickers by their IDs.
|
||||
// See https://core.telegram.org/bots/api#getcustomemojistickers
|
||||
func (api *API) GetCustomEmojiStickers(params GetCustomEmojiStickersP) ([]Sticker, error) {
|
||||
req := NewRequest[[]Sticker]("getCustomEmojiStickers", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// CreateNewStickerSetP holds parameters for the createNewStickerSet method.
|
||||
// See https://core.telegram.org/bots/api#createnewstickerset
|
||||
type CreateNewStickerSetP struct {
|
||||
UserID int `json:"user_id"`
|
||||
Name string `json:"name"`
|
||||
@@ -47,41 +61,61 @@ type CreateNewStickerSetP struct {
|
||||
NeedsRepainting bool `json:"needs_repainting,omitempty"`
|
||||
}
|
||||
|
||||
// CreateNewStickerSet creates a new sticker set owned by a user.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#createnewstickerset
|
||||
func (api *API) CreateNewStickerSet(params CreateNewStickerSetP) (bool, error) {
|
||||
req := NewRequest[bool]("createNewStickerSet", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// AddStickerToSetP holds parameters for the addStickerToSet method.
|
||||
// See https://core.telegram.org/bots/api#addstickertoset
|
||||
type AddStickerToSetP struct {
|
||||
UserID int `json:"user_id"`
|
||||
Name string `json:"name"`
|
||||
Sticker InputSticker `json:"sticker"`
|
||||
}
|
||||
|
||||
// AddStickerToSet adds a new sticker to a set created by the bot.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#addstickertoset
|
||||
func (api *API) AddStickerToSet(params AddStickerToSetP) (bool, error) {
|
||||
req := NewRequest[bool]("addStickerToSet", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetStickerPositionInSetP holds parameters for the setStickerPositionInSet method.
|
||||
// See https://core.telegram.org/bots/api#setstickerpositioninset
|
||||
type SetStickerPositionInSetP struct {
|
||||
Sticker string `json:"sticker"`
|
||||
Position int `json:"position"`
|
||||
}
|
||||
|
||||
func (api *API) SetStickerPosition(params SetStickerPositionInSetP) (bool, error) {
|
||||
req := NewRequest[bool]("setStickerPosition", params)
|
||||
// SetStickerPositionInSet moves a sticker in a set to a specific position.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#setstickerpositioninset
|
||||
func (api *API) SetStickerPositionInSet(params SetStickerPositionInSetP) (bool, error) {
|
||||
req := NewRequest[bool]("setStickerPositionInSet", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// DeleteStickerFromSetP holds parameters for the deleteStickerFromSet method.
|
||||
// See https://core.telegram.org/bots/api#deletestickerfromset
|
||||
type DeleteStickerFromSetP struct {
|
||||
Sticker string `json:"sticker"`
|
||||
}
|
||||
|
||||
// DeleteStickerFromSet deletes a sticker from a set created by the bot.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#deletestickerfromset
|
||||
func (api *API) DeleteStickerFromSet(params DeleteStickerFromSetP) (bool, error) {
|
||||
req := NewRequest[bool]("deleteStickerFromSet", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// ReplaceStickerInSetP holds parameters for the replaceStickerInSet method.
|
||||
// See https://core.telegram.org/bots/api#replacestickerinset
|
||||
type ReplaceStickerInSetP struct {
|
||||
UserID int `json:"user_id"`
|
||||
Name string `json:"name"`
|
||||
@@ -89,51 +123,76 @@ type ReplaceStickerInSetP struct {
|
||||
Sticker InputSticker `json:"sticker"`
|
||||
}
|
||||
|
||||
// ReplaceStickerInSet replaces an existing sticker in a set with a new one.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#replacestickerinset
|
||||
func (api *API) ReplaceStickerInSet(params ReplaceStickerInSetP) (bool, error) {
|
||||
req := NewRequest[bool]("replaceStickerInSet", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetStickerEmojiListP holds parameters for the setStickerEmojiList method.
|
||||
// See https://core.telegram.org/bots/api#setstickeremojilist
|
||||
type SetStickerEmojiListP struct {
|
||||
Sticker string `json:"sticker"`
|
||||
EmojiList []string `json:"emoji_list"`
|
||||
}
|
||||
|
||||
// SetStickerEmojiList changes the list of emoji associated with a sticker.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#setstickeremojilist
|
||||
func (api *API) SetStickerEmojiList(params SetStickerEmojiListP) (bool, error) {
|
||||
req := NewRequest[bool]("setStickerEmojiList", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetStickerKeywordsP holds parameters for the setStickerKeywords method.
|
||||
// See https://core.telegram.org/bots/api#setstickerkeywords
|
||||
type SetStickerKeywordsP struct {
|
||||
Sticker string `json:"sticker"`
|
||||
Keywords []string `json:"keywords"`
|
||||
}
|
||||
|
||||
// SetStickerKeywords changes the keywords of a sticker.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#setstickerkeywords
|
||||
func (api *API) SetStickerKeywords(params SetStickerKeywordsP) (bool, error) {
|
||||
req := NewRequest[bool]("setStickerKeywords", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetStickerMaskPositionP holds parameters for the setStickerMaskPosition method.
|
||||
// See https://core.telegram.org/bots/api#setstickermaskposition
|
||||
type SetStickerMaskPositionP struct {
|
||||
Sticker string `json:"sticker"`
|
||||
MaskPosition *MaskPosition `json:"mask_position,omitempty"`
|
||||
}
|
||||
|
||||
// SetStickerMaskPosition changes the mask position of a mask sticker.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#setstickermaskposition
|
||||
func (api *API) SetStickerMaskPosition(params SetStickerMaskPositionP) (bool, error) {
|
||||
req := NewRequest[bool]("setStickerMaskPosition", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetStickerSetTitleP holds parameters for the setStickerSetTitle method.
|
||||
// See https://core.telegram.org/bots/api#setstickersettitle
|
||||
type SetStickerSetTitleP struct {
|
||||
Name string `json:"name"`
|
||||
Title string `json:"title"`
|
||||
}
|
||||
|
||||
// SetStickerSetTitle sets the title of a sticker set created by the bot.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#setstickersettitle
|
||||
func (api *API) SetStickerSetTitle(params SetStickerSetTitleP) (bool, error) {
|
||||
req := NewRequest[bool]("setStickerSetTitle", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetStickerSetThumbnailP holds parameters for the setStickerSetThumbnail method.
|
||||
// See https://core.telegram.org/bots/api#setstickersetthumbnail
|
||||
type SetStickerSetThumbnailP struct {
|
||||
Name string `json:"name"`
|
||||
UserID int `json:"user_id"`
|
||||
@@ -141,25 +200,40 @@ type SetStickerSetThumbnailP struct {
|
||||
Format InputStickerFormat `json:"format"`
|
||||
}
|
||||
|
||||
// SetStickerSetThumbnail sets the thumbnail of a sticker set.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#setstickersetthumbnail
|
||||
func (api *API) SetStickerSetThumbnail(params SetStickerSetThumbnailP) (bool, error) {
|
||||
req := NewRequest[bool]("setStickerSetThumbnail", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetCustomEmojiStickerSetThumbnailP holds parameters for the setCustomEmojiStickerSetThumbnail method.
|
||||
// See https://core.telegram.org/bots/api#setcustomemojistickersetthumbnail
|
||||
type SetCustomEmojiStickerSetThumbnailP struct {
|
||||
Name string `json:"name"`
|
||||
CustomEmojiID string `json:"custom_emoji_id,omitempty"`
|
||||
}
|
||||
|
||||
// SetCustomEmojiStickerSetThumbnail sets the thumbnail of a custom emoji sticker set.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#setcustomemojistickersetthumbnail
|
||||
//
|
||||
// Note: This method uses SetStickerSetThumbnailP as its parameter type, which might be inconsistent.
|
||||
func (api *API) SetCustomEmojiStickerSetThumbnail(params SetStickerSetThumbnailP) (bool, error) {
|
||||
req := NewRequest[bool]("setCustomEmojiStickerSetThumbnail", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// DeleteStickerSetP holds parameters for the deleteStickerSet method.
|
||||
// See https://core.telegram.org/bots/api#deletestickerset
|
||||
type DeleteStickerSetP struct {
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
// DeleteStickerSet deletes a sticker set created by the bot.
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#deletestickerset
|
||||
func (api *API) DeleteStickerSet(params DeleteStickerSetP) (bool, error) {
|
||||
req := NewRequest[bool]("deleteStickerSet", params)
|
||||
return req.Do(api)
|
||||
|
||||
@@ -1,14 +1,21 @@
|
||||
package tgapi
|
||||
|
||||
// MaskPositionPoint represents the part of the face where a mask should be placed.
|
||||
type MaskPositionPoint string
|
||||
|
||||
const (
|
||||
// MaskPositionForehead places the mask on the forehead.
|
||||
MaskPositionForehead MaskPositionPoint = "forehead"
|
||||
// MaskPositionEyes places the mask on the eyes.
|
||||
MaskPositionEyes MaskPositionPoint = "eyes"
|
||||
// MaskPositionMouth places the mask on the mouth.
|
||||
MaskPositionMouth MaskPositionPoint = "mouth"
|
||||
// MaskPositionChin places the mask on the chin.
|
||||
MaskPositionChin MaskPositionPoint = "chin"
|
||||
)
|
||||
|
||||
// MaskPosition describes the position on faces where a mask should be placed by default.
|
||||
// See https://core.telegram.org/bots/api#maskposition
|
||||
type MaskPosition struct {
|
||||
Point MaskPositionPoint `json:"point"`
|
||||
XShift float32 `json:"x_shift"`
|
||||
@@ -16,14 +23,20 @@ type MaskPosition struct {
|
||||
Scale float32 `json:"scale"`
|
||||
}
|
||||
|
||||
// StickerType represents the type of a sticker.
|
||||
type StickerType string
|
||||
|
||||
const (
|
||||
// StickerTypeRegular is a regular sticker.
|
||||
StickerTypeRegular StickerType = "regular"
|
||||
// StickerTypeMask is a mask sticker that can be placed on faces.
|
||||
StickerTypeMask StickerType = "mask"
|
||||
// StickerTypeCustomEmoji is a custom emoji sticker.
|
||||
StickerTypeCustomEmoji StickerType = "custom_emoji"
|
||||
)
|
||||
|
||||
// Sticker represents a sticker.
|
||||
// See https://core.telegram.org/bots/api#sticker
|
||||
type Sticker struct {
|
||||
FileId string `json:"file_id"`
|
||||
FileUniqueId string `json:"file_unique_id"`
|
||||
@@ -41,6 +54,9 @@ type Sticker struct {
|
||||
NeedRepainting *bool `json:"need_repainting,omitempty"`
|
||||
FileSize *int `json:"file_size,omitempty"`
|
||||
}
|
||||
|
||||
// StickerSet represents a sticker set.
|
||||
// See https://core.telegram.org/bots/api#stickerset
|
||||
type StickerSet struct {
|
||||
Name string `json:"name"`
|
||||
Title string `json:"title"`
|
||||
@@ -48,14 +64,21 @@ type StickerSet struct {
|
||||
Stickers []Sticker `json:"stickers"`
|
||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||
}
|
||||
|
||||
// InputStickerFormat represents the format of an input sticker.
|
||||
type InputStickerFormat string
|
||||
|
||||
const (
|
||||
// InputStickerFormatStatic is a static sticker (WEBP).
|
||||
InputStickerFormatStatic InputStickerFormat = "static"
|
||||
// InputStickerFormatAnimated is an animated sticker (TGS).
|
||||
InputStickerFormatAnimated InputStickerFormat = "animated"
|
||||
// InputStickerFormatVideo is a video sticker (WEBM).
|
||||
InputStickerFormatVideo InputStickerFormat = "video"
|
||||
)
|
||||
|
||||
// InputSticker describes a sticker to be added to a sticker set.
|
||||
// See https://core.telegram.org/bots/api#inputsticker
|
||||
type InputSticker struct {
|
||||
Sticker string `json:"sticker"`
|
||||
Format InputStickerFormat `json:"format"`
|
||||
|
||||
104
tgapi/types.go
104
tgapi/types.go
@@ -1,35 +1,61 @@
|
||||
package tgapi
|
||||
|
||||
// UpdateType represents the type of an incoming update.
|
||||
type UpdateType string
|
||||
|
||||
const (
|
||||
// UpdateTypeMessage is a regular message update.
|
||||
UpdateTypeMessage UpdateType = "message"
|
||||
// UpdateTypeEditedMessage is an edited message update.
|
||||
UpdateTypeEditedMessage UpdateType = "edited_message"
|
||||
// UpdateTypeChannelPost is a channel post update.
|
||||
UpdateTypeChannelPost UpdateType = "channel_post"
|
||||
// UpdateTypeEditedChannelPost is an edited channel post update.
|
||||
UpdateTypeEditedChannelPost UpdateType = "edited_channel_post"
|
||||
// UpdateTypeMessageReaction is a message reaction update.
|
||||
UpdateTypeMessageReaction UpdateType = "message_reaction"
|
||||
// UpdateTypeMessageReactionCount is a message reaction count update.
|
||||
UpdateTypeMessageReactionCount UpdateType = "message_reaction_count"
|
||||
|
||||
// UpdateTypeBusinessConnection is a business connection update.
|
||||
UpdateTypeBusinessConnection UpdateType = "business_connection"
|
||||
// UpdateTypeBusinessMessage is a business message update.
|
||||
UpdateTypeBusinessMessage UpdateType = "business_message"
|
||||
// UpdateTypeEditedBusinessMessage is an edited business message update.
|
||||
UpdateTypeEditedBusinessMessage UpdateType = "edited_business_message"
|
||||
// UpdateTypeDeletedBusinessMessage is a deleted business message update.
|
||||
UpdateTypeDeletedBusinessMessage UpdateType = "deleted_business_message"
|
||||
|
||||
// UpdateTypeInlineQuery is an inline query update.
|
||||
UpdateTypeInlineQuery UpdateType = "inline_query"
|
||||
// UpdateTypeChosenInlineResult is a chosen inline result update.
|
||||
UpdateTypeChosenInlineResult UpdateType = "chosen_inline_result"
|
||||
// UpdateTypeCallbackQuery is a callback query update.
|
||||
UpdateTypeCallbackQuery UpdateType = "callback_query"
|
||||
// UpdateTypeShippingQuery is a shipping query update.
|
||||
UpdateTypeShippingQuery UpdateType = "shipping_query"
|
||||
// UpdateTypePreCheckoutQuery is a pre-checkout query update.
|
||||
UpdateTypePreCheckoutQuery UpdateType = "pre_checkout_query"
|
||||
// UpdateTypePurchasedPaidMedia is a purchased paid media update.
|
||||
UpdateTypePurchasedPaidMedia UpdateType = "purchased_paid_media"
|
||||
// UpdateTypePoll is a poll update.
|
||||
UpdateTypePoll UpdateType = "poll"
|
||||
// UpdateTypePollAnswer is a poll answer update.
|
||||
UpdateTypePollAnswer UpdateType = "poll_answer"
|
||||
// UpdateTypeMyChatMember is a my chat member update.
|
||||
UpdateTypeMyChatMember UpdateType = "my_chat_member"
|
||||
// UpdateTypeChatMember is a chat member update.
|
||||
UpdateTypeChatMember UpdateType = "chat_member"
|
||||
// UpdateTypeChatJoinRequest is a chat join request update.
|
||||
UpdateTypeChatJoinRequest UpdateType = "chat_join_request"
|
||||
// UpdateTypeChatBoost is a chat boost update.
|
||||
UpdateTypeChatBoost UpdateType = "chat_boost"
|
||||
// UpdateTypeRemovedChatBoost is a removed chat boost update.
|
||||
UpdateTypeRemovedChatBoost UpdateType = "removed_chat_boost"
|
||||
)
|
||||
|
||||
// Update represents an incoming update from Telegram.
|
||||
// See https://core.telegram.org/bots/api#update
|
||||
type Update struct {
|
||||
UpdateID int `json:"update_id"`
|
||||
Message *Message `json:"message,omitempty"`
|
||||
@@ -60,6 +86,8 @@ type Update struct {
|
||||
RemovedChatBoost *ChatBoostRemoved `json:"removed_chat_boost,omitempty"`
|
||||
}
|
||||
|
||||
// InlineQuery represents an incoming inline query.
|
||||
// See https://core.telegram.org/bots/api#inlinequery
|
||||
type InlineQuery struct {
|
||||
ID string `json:"id"`
|
||||
From User `json:"from"`
|
||||
@@ -68,6 +96,9 @@ type InlineQuery struct {
|
||||
ChatType *ChatType `json:"chat_type,omitempty"`
|
||||
Location *Location `json:"location,omitempty"`
|
||||
}
|
||||
|
||||
// ChosenInlineResult represents a result of an inline query that was chosen by the user.
|
||||
// See https://core.telegram.org/bots/api#choseninlineresult
|
||||
type ChosenInlineResult struct {
|
||||
ResultID string `json:"result_id"`
|
||||
From User `json:"from"`
|
||||
@@ -76,12 +107,17 @@ type ChosenInlineResult struct {
|
||||
Query string `json:"query"`
|
||||
}
|
||||
|
||||
// ShippingQuery represents an incoming shipping query.
|
||||
// See https://core.telegram.org/bots/api#shippingquery
|
||||
type ShippingQuery struct {
|
||||
ID string `json:"id"`
|
||||
From User `json:"from"`
|
||||
InvoicePayload string `json:"invoice_payload"`
|
||||
ShippingAddress ShippingAddress `json:"shipping_address"`
|
||||
}
|
||||
|
||||
// ShippingAddress represents a shipping address.
|
||||
// See https://core.telegram.org/bots/api#shippingaddress
|
||||
type ShippingAddress struct {
|
||||
CountryCode string `json:"country_code"`
|
||||
State string `json:"state"`
|
||||
@@ -91,12 +127,17 @@ type ShippingAddress struct {
|
||||
PostCode string `json:"post_code"`
|
||||
}
|
||||
|
||||
// OrderInfo represents information about an order.
|
||||
// See https://core.telegram.org/bots/api#orderinfo
|
||||
type OrderInfo struct {
|
||||
Name string `json:"name"`
|
||||
PhoneNumber string `json:"phone_number"`
|
||||
Email string `json:"email"`
|
||||
ShippingAddress ShippingAddress `json:"shipping_address"`
|
||||
}
|
||||
|
||||
// PreCheckoutQuery represents an incoming pre-checkout query.
|
||||
// See https://core.telegram.org/bots/api#precheckoutquery
|
||||
type PreCheckoutQuery struct {
|
||||
ID string `json:"id"`
|
||||
From User `json:"from"`
|
||||
@@ -107,11 +148,15 @@ type PreCheckoutQuery struct {
|
||||
OrderInfo *OrderInfo `json:"order_info,omitempty"`
|
||||
}
|
||||
|
||||
// PaidMediaPurchased represents a purchased paid media.
|
||||
// See https://core.telegram.org/bots/api#paidmediapurchased
|
||||
type PaidMediaPurchased struct {
|
||||
From User `json:"from"`
|
||||
PaidMediaPayload string `json:"paid_media_payload"`
|
||||
}
|
||||
|
||||
// File represents a file ready to be downloaded.
|
||||
// See https://core.telegram.org/bots/api#file
|
||||
type File struct {
|
||||
FileId string `json:"file_id"`
|
||||
FileUniqueID string `json:"file_unique_id"`
|
||||
@@ -119,6 +164,8 @@ type File struct {
|
||||
FilePath string `json:"file_path,omitempty"`
|
||||
}
|
||||
|
||||
// Audio represents an audio file to be treated as music by the Telegram clients.
|
||||
// See https://core.telegram.org/bots/api#audio
|
||||
type Audio struct {
|
||||
FileID string `json:"file_id"`
|
||||
FileUniqueID string `json:"file_unique_id"`
|
||||
@@ -132,11 +179,16 @@ type Audio struct {
|
||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||
}
|
||||
|
||||
// PollOption contains information about one answer option in a poll.
|
||||
// See https://core.telegram.org/bots/api#polloption
|
||||
type PollOption struct {
|
||||
Text string `json:"text"`
|
||||
TextEntities []MessageEntity `json:"text_entities"`
|
||||
VoterCount int `json:"voter_count"`
|
||||
}
|
||||
|
||||
// Poll contains information about a poll.
|
||||
// See https://core.telegram.org/bots/api#poll
|
||||
type Poll struct {
|
||||
ID string `json:"id"`
|
||||
Question string `json:"question"`
|
||||
@@ -154,12 +206,18 @@ type Poll struct {
|
||||
OpenPeriod int `json:"open_period,omitempty"`
|
||||
CloseDate int `json:"close_date,omitempty"`
|
||||
}
|
||||
|
||||
// PollAnswer represents an answer of a user in a poll.
|
||||
// See https://core.telegram.org/bots/api#pollanswer
|
||||
type PollAnswer struct {
|
||||
PollID string `json:"poll_id"`
|
||||
VoterChat Chat `json:"voter_chat"`
|
||||
User User `json:"user"`
|
||||
OptionIDS []int `json:"option_ids"`
|
||||
}
|
||||
|
||||
// ChatMemberUpdated represents changes in the status of a chat member.
|
||||
// See https://core.telegram.org/bots/api#chatmemberupdated
|
||||
type ChatMemberUpdated struct {
|
||||
Chat Chat `json:"chat"`
|
||||
From User `json:"from"`
|
||||
@@ -171,6 +229,8 @@ type ChatMemberUpdated struct {
|
||||
ViaChatFolderInviteLink *bool `json:"via_chat_folder_invite_link,omitempty"`
|
||||
}
|
||||
|
||||
// ChatJoinRequest represents a join request sent to a chat.
|
||||
// See https://core.telegram.org/bots/api#chatjoinrequest
|
||||
type ChatJoinRequest struct {
|
||||
Chat Chat `json:"chat"`
|
||||
From User `json:"from"`
|
||||
@@ -180,6 +240,8 @@ type ChatJoinRequest struct {
|
||||
InviteLink *ChatInviteLink `json:"invite_link,omitempty"`
|
||||
}
|
||||
|
||||
// Location represents a point on the map.
|
||||
// See https://core.telegram.org/bots/api#location
|
||||
type Location struct {
|
||||
Latitude float64 `json:"latitude"`
|
||||
Longitude float64 `json:"longitude"`
|
||||
@@ -188,12 +250,17 @@ type Location struct {
|
||||
Heading int `json:"heading"`
|
||||
ProximityAlertRadius int `json:"proximity_alert_radius"`
|
||||
}
|
||||
|
||||
// LocationAddress represents a human-readable address of a location.
|
||||
type LocationAddress struct {
|
||||
CountryCode string `json:"country_code"`
|
||||
State *string `json:"state,omitempty"`
|
||||
City *string `json:"city,omitempty"`
|
||||
Street *string `json:"street,omitempty"`
|
||||
}
|
||||
|
||||
// Venue represents a venue.
|
||||
// See https://core.telegram.org/bots/api#venue
|
||||
type Venue struct {
|
||||
Location Location `json:"location"`
|
||||
Title string `json:"title"`
|
||||
@@ -204,22 +271,25 @@ type Venue struct {
|
||||
GooglePlaceType string `json:"google_place_type,omitempty"`
|
||||
}
|
||||
|
||||
// WebAppInfo contains information about a Web App.
|
||||
// See https://core.telegram.org/bots/api#webappinfo
|
||||
type WebAppInfo struct {
|
||||
URL string `json:"url"`
|
||||
}
|
||||
|
||||
// StarAmount represents an amount of Telegram Stars.
|
||||
type StarAmount struct {
|
||||
Amount int `json:"amount"`
|
||||
NanostarAmount int `json:"nanostar_amount"`
|
||||
}
|
||||
|
||||
// Story represents a story.
|
||||
type Story struct {
|
||||
Chat Chat `json:"chat"`
|
||||
ID int `json:"id"`
|
||||
}
|
||||
|
||||
// Gifts
|
||||
|
||||
// AcceptedGiftTypes represents the types of gifts accepted by a user or chat.
|
||||
type AcceptedGiftTypes struct {
|
||||
UnlimitedGifts bool `json:"unlimited_gifts"`
|
||||
LimitedGifts bool `json:"limited_gifts"`
|
||||
@@ -228,6 +298,7 @@ type AcceptedGiftTypes struct {
|
||||
GiftsFromChannels bool `json:"gifts_from_channels"`
|
||||
}
|
||||
|
||||
// UniqueGiftColors represents color information for a unique gift.
|
||||
type UniqueGiftColors struct {
|
||||
ModelCustomEmojiID string `json:"model_custom_emoji_id"`
|
||||
SymbolCustomEmojiID string `json:"symbol_custom_emoji_id"`
|
||||
@@ -237,11 +308,14 @@ type UniqueGiftColors struct {
|
||||
DarkThemeOtherColors []int `json:"dark_theme_other_colors"`
|
||||
}
|
||||
|
||||
// GiftBackground represents the background of a gift.
|
||||
type GiftBackground struct {
|
||||
CenterColor int `json:"center_color"`
|
||||
EdgeColor int `json:"edge_color"`
|
||||
TextColor int `json:"text_color"`
|
||||
}
|
||||
|
||||
// Gift represents a gift that can be sent.
|
||||
type Gift struct {
|
||||
ID string `json:"id"`
|
||||
Sticker Sticker `json:"sticker"`
|
||||
@@ -257,24 +331,28 @@ type Gift struct {
|
||||
UniqueGiftVariantColor *int `json:"unique_gift_variant_color,omitempty"`
|
||||
PublisherChat *Chat `json:"publisher_chat,omitempty"`
|
||||
}
|
||||
|
||||
// Gifts represents a list of gifts.
|
||||
type Gifts struct {
|
||||
Gifts []Gift `json:"gifts"`
|
||||
}
|
||||
|
||||
// OwnedGiftType represents the type of an owned gift.
|
||||
type OwnedGiftType string
|
||||
|
||||
const (
|
||||
OwnedGiftRegularType OwnedGiftType = "regular"
|
||||
OwnedGiftUniqueType OwnedGiftType = "unique"
|
||||
)
|
||||
|
||||
type OwnedGiftType string
|
||||
type BaseOwnedGift struct {
|
||||
// OwnedGift represents a gift owned by a user or chat.
|
||||
type OwnedGift struct {
|
||||
Type OwnedGiftType `json:"type"`
|
||||
OwnerGiftID *string `json:"owner_gift_id,omitempty"`
|
||||
SendDate *int `json:"send_date,omitempty"`
|
||||
IsSaved *bool `json:"is_saved,omitempty"`
|
||||
}
|
||||
type OwnedGiftRegular struct {
|
||||
BaseOwnedGift
|
||||
|
||||
// Fields specific to "regular" type
|
||||
Gift Gift `json:"gift"`
|
||||
SenderUser User `json:"sender_user,omitempty"`
|
||||
Text string `json:"text,omitempty"`
|
||||
@@ -286,18 +364,16 @@ type OwnedGiftRegular struct {
|
||||
PrepaidUpgradeStarCount *int `json:"prepaid_upgrade_star_count,omitempty"`
|
||||
IsUpgradeSeparate *bool `json:"is_upgrade_separate,omitempty"`
|
||||
UniqueGiftNumber *int `json:"unique_gift_number,omitempty"`
|
||||
}
|
||||
type OwnedGiftUnique struct {
|
||||
BaseOwnedGift
|
||||
|
||||
// Fields specific to "unique" type
|
||||
CanBeTransferred *bool `json:"can_be_transferred,omitempty"`
|
||||
TransferStarCount *int `json:"transfer_star_count,omitempty"`
|
||||
NextTransferDate *int `json:"next_transfer_date,omitempty"`
|
||||
}
|
||||
|
||||
// OwnedGifts represents a list of owned gifts with pagination.
|
||||
type OwnedGifts struct {
|
||||
TotalCount int `json:"total_count"`
|
||||
Gifts []struct {
|
||||
OwnedGiftRegular
|
||||
OwnedGiftUnique
|
||||
} `json:"gifts"`
|
||||
Gifts []OwnedGift `json:"gifts"`
|
||||
NextOffset string `json:"next_offset"`
|
||||
}
|
||||
|
||||
@@ -8,6 +8,7 @@ import (
|
||||
"mime/multipart"
|
||||
"net/http"
|
||||
"path/filepath"
|
||||
"time"
|
||||
|
||||
"git.nix13.pw/scuroneko/laniakea/utils"
|
||||
"git.nix13.pw/scuroneko/slog"
|
||||
@@ -59,24 +60,17 @@ type UploaderRequest[R, P any] struct {
|
||||
method string
|
||||
files []UploaderFile
|
||||
params P
|
||||
chatId int64
|
||||
}
|
||||
|
||||
func NewUploaderRequest[R, P any](method string, params P, files ...UploaderFile) UploaderRequest[R, P] {
|
||||
return UploaderRequest[R, P]{method, files, params}
|
||||
return UploaderRequest[R, P]{method: method, files: files, params: params, chatId: 0}
|
||||
}
|
||||
func NewUploaderRequestWithChatID[R, P any](method string, params P, chatId int64, files ...UploaderFile) UploaderRequest[R, P] {
|
||||
return UploaderRequest[R, P]{method: method, files: files, params: params, chatId: chatId}
|
||||
}
|
||||
func (r UploaderRequest[R, P]) doRequest(ctx context.Context, up *Uploader) (R, error) {
|
||||
var zero R
|
||||
if up.api.limiter != nil {
|
||||
if up.api.dropOverflowLimit {
|
||||
if !up.api.limiter.Allow() {
|
||||
return zero, errors.New("rate limited")
|
||||
}
|
||||
} else {
|
||||
if err := up.api.limiter.Wait(ctx); err != nil {
|
||||
return zero, err
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
buf, contentType, err := prepareMultipart(r.files, r.params)
|
||||
if err != nil {
|
||||
@@ -95,26 +89,66 @@ func (r UploaderRequest[R, P]) doRequest(ctx context.Context, up *Uploader) (R,
|
||||
req.Header.Set("Content-Type", contentType)
|
||||
req.Header.Set("Accept", "application/json")
|
||||
req.Header.Set("User-Agent", fmt.Sprintf("Laniakea/%s", utils.VersionString))
|
||||
req.Header.Set("Accept-Encoding", "gzip")
|
||||
req.ContentLength = int64(buf.Len())
|
||||
|
||||
for {
|
||||
if up.api.Limiter != nil {
|
||||
if up.api.dropOverflowLimit {
|
||||
if !up.api.Limiter.GlobalAllow() {
|
||||
return zero, errors.New("rate limited")
|
||||
}
|
||||
} else {
|
||||
if err := up.api.Limiter.GlobalWait(ctx); err != nil {
|
||||
return zero, err
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
up.logger.Debugln("UPLOADER REQ", r.method)
|
||||
res, err := up.api.client.Do(req)
|
||||
resp, err := up.api.client.Do(req)
|
||||
if err != nil {
|
||||
return zero, err
|
||||
}
|
||||
defer res.Body.Close()
|
||||
|
||||
body, err := readBody(res.Body)
|
||||
body, err := readBody(resp.Body)
|
||||
_ = resp.Body.Close()
|
||||
if err != nil {
|
||||
return zero, err
|
||||
}
|
||||
up.logger.Debugln("UPLOADER RES", r.method, string(body))
|
||||
if res.StatusCode != http.StatusOK {
|
||||
return zero, fmt.Errorf("unexpected status code: %d, %s", res.StatusCode, string(body))
|
||||
|
||||
response, err := parseBody[R](body)
|
||||
if err != nil {
|
||||
return zero, err
|
||||
}
|
||||
|
||||
return parseBody[R](body)
|
||||
if !response.Ok {
|
||||
if response.ErrorCode == 429 && response.Parameters != nil && response.Parameters.RetryAfter != nil {
|
||||
after := *response.Parameters.RetryAfter
|
||||
up.logger.Warnf("Rate limited, retry after %d seconds (chat: %d)", after, r.chatId)
|
||||
if r.chatId > 0 {
|
||||
up.api.Limiter.SetChatLock(r.chatId, after)
|
||||
} else {
|
||||
up.api.Limiter.SetGlobalLock(after)
|
||||
}
|
||||
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
return zero, ctx.Err()
|
||||
case <-time.After(time.Duration(after) * time.Second):
|
||||
continue // Повторяем запрос
|
||||
}
|
||||
}
|
||||
return zero, fmt.Errorf("[%d] %s", response.ErrorCode, response.Description)
|
||||
}
|
||||
return response.Result, nil
|
||||
}
|
||||
}
|
||||
func (r UploaderRequest[R, P]) DoWithContext(ctx context.Context, up *Uploader) (R, error) {
|
||||
var zero R
|
||||
|
||||
result, err := up.api.pool.Submit(ctx, func(ctx context.Context) (any, error) {
|
||||
result, err := up.api.pool.submit(ctx, func(ctx context.Context) (any, error) {
|
||||
return r.doRequest(ctx, up)
|
||||
})
|
||||
if err != nil {
|
||||
@@ -125,10 +159,10 @@ func (r UploaderRequest[R, P]) DoWithContext(ctx context.Context, up *Uploader)
|
||||
case <-ctx.Done():
|
||||
return zero, ctx.Err()
|
||||
case res := <-result:
|
||||
if res.Err != nil {
|
||||
return zero, res.Err
|
||||
if res.err != nil {
|
||||
return zero, res.err
|
||||
}
|
||||
if val, ok := res.Value.(R); ok {
|
||||
if val, ok := res.value.(R); ok {
|
||||
return val, nil
|
||||
}
|
||||
return zero, ErrPoolUnexpected
|
||||
@@ -145,24 +179,29 @@ func prepareMultipart[P any](files []UploaderFile, params P) (*bytes.Buffer, str
|
||||
for _, file := range files {
|
||||
fw, err := w.CreateFormFile(string(file.field), file.filename)
|
||||
if err != nil {
|
||||
_ = w.Close()
|
||||
return buf, w.FormDataContentType(), err
|
||||
_ = w.Close() // Закрываем, чтобы не было утечки
|
||||
return nil, "", err
|
||||
}
|
||||
|
||||
_, err = fw.Write(file.data)
|
||||
if err != nil {
|
||||
_ = w.Close()
|
||||
return buf, w.FormDataContentType(), err
|
||||
return nil, "", err
|
||||
}
|
||||
}
|
||||
|
||||
err := utils.Encode(w, params)
|
||||
err := utils.Encode(w, params) // Предполагается, что это записывает в w
|
||||
if err != nil {
|
||||
_ = w.Close()
|
||||
return buf, w.FormDataContentType(), err
|
||||
return nil, "", err
|
||||
}
|
||||
err = w.Close()
|
||||
return buf, w.FormDataContentType(), err
|
||||
|
||||
err = w.Close() // ✅ ОБЯЗАТЕЛЬНО вызвать в конце — иначе запрос битый!
|
||||
if err != nil {
|
||||
return nil, "", err
|
||||
}
|
||||
|
||||
return buf, w.FormDataContentType(), nil
|
||||
}
|
||||
|
||||
func uploaderTypeByExt(filename string) UploaderFileType {
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
package tgapi
|
||||
|
||||
// UploadPhotoP holds parameters for uploading a photo using the Uploader.
|
||||
// See https://core.telegram.org/bots/api#sendphoto
|
||||
type UploadPhotoP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
|
||||
@@ -22,14 +24,19 @@ type UploadPhotoP struct {
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// UploadPhoto uploads a photo and sends it as a message.
|
||||
// file is the photo file to upload.
|
||||
// See https://core.telegram.org/bots/api#sendphoto
|
||||
func (u *Uploader) UploadPhoto(params UploadPhotoP, file UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequest[Message]("sendPhoto", params, file)
|
||||
req := NewUploaderRequestWithChatID[Message]("sendPhoto", params, params.ChatID, file)
|
||||
return req.Do(u)
|
||||
}
|
||||
|
||||
// UploadAudioP holds parameters for uploading an audio file using the Uploader.
|
||||
// See https://core.telegram.org/bots/api#sendaudio
|
||||
type UploadAudioP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
|
||||
@@ -51,14 +58,19 @@ type UploadAudioP struct {
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// UploadAudio uploads an audio file and sends it as a message.
|
||||
// files are the audio file(s) to upload (typically one file).
|
||||
// See https://core.telegram.org/bots/api#sendaudio
|
||||
func (u *Uploader) UploadAudio(params UploadAudioP, files ...UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequest[Message]("sendAudio", params, files...)
|
||||
req := NewUploaderRequestWithChatID[Message]("sendAudio", params, params.ChatID, files...)
|
||||
return req.Do(u)
|
||||
}
|
||||
|
||||
// UploadDocumentP holds parameters for uploading a document using the Uploader.
|
||||
// See https://core.telegram.org/bots/api#senddocument
|
||||
type UploadDocumentP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
|
||||
@@ -77,14 +89,19 @@ type UploadDocumentP struct {
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// UploadDocument uploads a document and sends it as a message.
|
||||
// files are the document file(s) to upload (typically one file).
|
||||
// See https://core.telegram.org/bots/api#senddocument
|
||||
func (u *Uploader) UploadDocument(params UploadDocumentP, files ...UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequest[Message]("sendDocument", params, files...)
|
||||
return req.Do(u)
|
||||
}
|
||||
|
||||
// UploadVideoP holds parameters for uploading a video using the Uploader.
|
||||
// See https://core.telegram.org/bots/api#sendvideo
|
||||
type UploadVideoP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
|
||||
@@ -110,14 +127,19 @@ type UploadVideoP struct {
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// UploadVideo uploads a video and sends it as a message.
|
||||
// files are the video file(s) to upload (typically one file).
|
||||
// See https://core.telegram.org/bots/api#sendvideo
|
||||
func (u *Uploader) UploadVideo(params UploadVideoP, files ...UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequest[Message]("sendVideo", params, files...)
|
||||
return req.Do(u)
|
||||
}
|
||||
|
||||
// UploadAnimationP holds parameters for uploading an animation using the Uploader.
|
||||
// See https://core.telegram.org/bots/api#sendanimation
|
||||
type UploadAnimationP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
|
||||
@@ -141,14 +163,19 @@ type UploadAnimationP struct {
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// UploadAnimation uploads an animation (GIF or H.264/MPEG-4 AVC video without sound) and sends it as a message.
|
||||
// files are the animation file(s) to upload (typically one file).
|
||||
// See https://core.telegram.org/bots/api#sendanimation
|
||||
func (u *Uploader) UploadAnimation(params UploadAnimationP, files ...UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequest[Message]("sendAnimation", params, files...)
|
||||
return req.Do(u)
|
||||
}
|
||||
|
||||
// UploadVoiceP holds parameters for uploading a voice note using the Uploader.
|
||||
// See https://core.telegram.org/bots/api#sendvoice
|
||||
type UploadVoiceP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
|
||||
@@ -167,14 +194,19 @@ type UploadVoiceP struct {
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// UploadVoice uploads a voice note and sends it as a message.
|
||||
// files are the voice file(s) to upload (typically one file).
|
||||
// See https://core.telegram.org/bots/api#sendvoice
|
||||
func (u *Uploader) UploadVoice(params UploadVoiceP, files ...UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequest[Message]("sendVoice", params, files...)
|
||||
return req.Do(u)
|
||||
}
|
||||
|
||||
// UploadVideoNoteP holds parameters for uploading a video note (rounded video) using the Uploader.
|
||||
// See https://core.telegram.org/bots/api#sendvideonote
|
||||
type UploadVideoNoteP struct {
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
|
||||
@@ -191,15 +223,23 @@ type UploadVideoNoteP struct {
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// UploadVideoNote uploads a video note (rounded video) and sends it as a message.
|
||||
// files are the video note file(s) to upload (typically one file).
|
||||
// See https://core.telegram.org/bots/api#sendvideonote
|
||||
func (u *Uploader) UploadVideoNote(params UploadVideoNoteP, files ...UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequest[Message]("sendVideoNote", params, files...)
|
||||
return req.Do(u)
|
||||
}
|
||||
|
||||
// UploadChatPhotoP holds parameters for uploading a chat photo using the Uploader.
|
||||
// See https://core.telegram.org/bots/api#setchatphoto
|
||||
type UploadChatPhotoP struct {
|
||||
ChatID int `json:"chat_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
}
|
||||
|
||||
// UploadChatPhoto uploads a new chat photo.
|
||||
// photo is the photo file to upload.
|
||||
// See https://core.telegram.org/bots/api#setchatphoto
|
||||
func (u *Uploader) UploadChatPhoto(params UploadChatPhotoP, photo UploaderFile) (Message, error) {
|
||||
req := NewUploaderRequest[Message]("sendChatPhoto", params, photo)
|
||||
return req.Do(u)
|
||||
|
||||
@@ -1,38 +1,53 @@
|
||||
package tgapi
|
||||
|
||||
// GetUserProfilePhotosP holds parameters for the GetUserProfilePhotos method.
|
||||
// See https://core.telegram.org/bots/api#getuserprofilephotos
|
||||
type GetUserProfilePhotosP struct {
|
||||
UserID int `json:"user_id"`
|
||||
Offset int `json:"offset,omitempty"`
|
||||
Limit int `json:"limit,omitempty"`
|
||||
}
|
||||
|
||||
// GetUserProfilePhotos returns a list of profile pictures for a user.
|
||||
// See https://core.telegram.org/bots/api#getuserprofilephotos
|
||||
func (api *API) GetUserProfilePhotos(params GetUserProfilePhotosP) (UserProfilePhotos, error) {
|
||||
req := NewRequest[UserProfilePhotos]("getUserProfilePhotos", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// GetUserProfileAudiosP holds parameters for the GetUserProfileAudios method.
|
||||
// See https://core.telegram.org/bots/api#getuserprofileaudios
|
||||
type GetUserProfileAudiosP struct {
|
||||
UserID int `json:"user_id"`
|
||||
Offset int `json:"offset,omitempty"`
|
||||
Limit int `json:"limit,omitempty"`
|
||||
}
|
||||
|
||||
// GetUserProfileAudios returns a list of profile audios for a user.
|
||||
// See https://core.telegram.org/bots/api#getuserprofileaudios
|
||||
func (api *API) GetUserProfileAudios(params GetUserProfileAudiosP) (UserProfileAudios, error) {
|
||||
req := NewRequest[UserProfileAudios]("getUserProfileAudios", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetUserEmojiStatusP holds parameters for the SetUserEmojiStatus method.
|
||||
// See https://core.telegram.org/bots/api#setuseremojistatus
|
||||
type SetUserEmojiStatusP struct {
|
||||
UserID int `json:"user_id"`
|
||||
EmojiID string `json:"emoji_status_custom_emoji_id,omitempty"`
|
||||
ExpirationDate int `json:"emoji_status_expiration_date,omitempty"`
|
||||
}
|
||||
|
||||
// SetUserEmojiStatus sets a custom emoji status for a user.
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#setuseremojistatus
|
||||
func (api *API) SetUserEmojiStatus(params SetUserEmojiStatusP) (bool, error) {
|
||||
req := NewRequest[bool]("setUserEmojiStatus", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// GetUserGiftsP holds parameters for the GetUserGifts method.
|
||||
// See https://core.telegram.org/bots/api#getusergifts
|
||||
type GetUserGiftsP struct {
|
||||
UserID int `json:"user_id"`
|
||||
ExcludeUnlimited bool `json:"exclude_unlimited,omitempty"`
|
||||
@@ -45,6 +60,8 @@ type GetUserGiftsP struct {
|
||||
Limit int `json:"limit,omitempty"`
|
||||
}
|
||||
|
||||
// GetUserGifts returns gifts owned by a user.
|
||||
// See https://core.telegram.org/bots/api#getusergifts
|
||||
func (api *API) GetUserGifts(params GetUserGiftsP) (OwnedGifts, error) {
|
||||
req := NewRequest[OwnedGifts]("getUserGifts", params)
|
||||
return req.Do(api)
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
package tgapi
|
||||
|
||||
// User represents a Telegram user or bot.
|
||||
// See https://core.telegram.org/bots/api#user
|
||||
type User struct {
|
||||
ID int `json:"id"`
|
||||
IsBot bool `json:"is_bot"`
|
||||
@@ -18,21 +20,31 @@ type User struct {
|
||||
AllowsUsersToCreateTopics *bool `json:"allows_users_to_create_topics,omitempty"`
|
||||
}
|
||||
|
||||
// UserProfilePhotos represents a user's profile photos.
|
||||
// See https://core.telegram.org/bots/api#userprofilephotos
|
||||
type UserProfilePhotos struct {
|
||||
TotalCount int `json:"total_count"`
|
||||
Photos [][]PhotoSize `json:"photos"`
|
||||
}
|
||||
|
||||
// UserProfileAudios represents a user's profile audios.
|
||||
// See https://core.telegram.org/bots/api#userprofileaudios
|
||||
type UserProfileAudios struct {
|
||||
TotalCount int `json:"total_count"`
|
||||
Audios []Audio `json:"audios"`
|
||||
}
|
||||
|
||||
// UserRating represents a user's rating with level progression.
|
||||
// See https://core.telegram.org/bots/api#userrating
|
||||
type UserRating struct {
|
||||
Level int `json:"level"`
|
||||
Rating int `json:"rating"`
|
||||
CurrentLevelRating int `json:"current_level_rating"`
|
||||
NextLevelRating int `json:"next_level_rating"`
|
||||
}
|
||||
|
||||
// Birthdate represents a user's birthdate.
|
||||
// See https://core.telegram.org/bots/api#birthdate
|
||||
type Birthdate struct {
|
||||
Day int `json:"day"`
|
||||
Month int `json:"month"`
|
||||
|
||||
50
utils.go
50
utils.go
@@ -1,6 +1,10 @@
|
||||
package laniakea
|
||||
|
||||
import "git.nix13.pw/scuroneko/laniakea/utils"
|
||||
import (
|
||||
"strings"
|
||||
|
||||
"git.nix13.pw/scuroneko/laniakea/utils"
|
||||
)
|
||||
|
||||
func Ptr[T any](v T) *T { return &v }
|
||||
func Val[T any](p *T, def T) T {
|
||||
@@ -9,7 +13,45 @@ func Val[T any](p *T, def T) T {
|
||||
}
|
||||
return def
|
||||
}
|
||||
func EscapeMarkdown(s string) string { return utils.EscapeMarkdown(s) }
|
||||
func EscapeMarkdownV2(s string) string { return utils.EscapeMarkdownV2(s) }
|
||||
|
||||
const VersionString = utils.VersionString
|
||||
// EscapeMarkdown
|
||||
// Deprecated. Use MarkdownV2
|
||||
func EscapeMarkdown(s string) string {
|
||||
s = strings.ReplaceAll(s, "_", `\_`)
|
||||
s = strings.ReplaceAll(s, "*", `\*`)
|
||||
s = strings.ReplaceAll(s, "[", `\[`)
|
||||
return strings.ReplaceAll(s, "`", "\\`")
|
||||
}
|
||||
|
||||
// EscapeHTML escapes special characters for Telegram HTML parse mode.
|
||||
func EscapeHTML(s string) string {
|
||||
s = strings.ReplaceAll(s, "&", "&")
|
||||
s = strings.ReplaceAll(s, "<", "<")
|
||||
s = strings.ReplaceAll(s, ">", ">")
|
||||
return s
|
||||
}
|
||||
|
||||
// EscapeMarkdownV2 escapes special characters for Telegram MarkdownV2.
|
||||
// https://core.telegram.org/bots/api#markdownv2-style
|
||||
func EscapeMarkdownV2(s string) string {
|
||||
symbols := []string{"\\", "_", "*", "[", "]", "(", ")", "~", "`", ">", "#", "+", "-", "=", "|", "{", "}", ".", "!"}
|
||||
for _, symbol := range symbols {
|
||||
s = strings.ReplaceAll(s, symbol, "\\"+symbol)
|
||||
}
|
||||
return s
|
||||
}
|
||||
func EscapePunctuation(s string) string {
|
||||
symbols := []string{".", "!", "-"}
|
||||
for _, symbol := range symbols {
|
||||
s = strings.ReplaceAll(s, symbol, "\\"+symbol)
|
||||
}
|
||||
return s
|
||||
}
|
||||
|
||||
const (
|
||||
VersionString = utils.VersionString
|
||||
VersionMajor = utils.VersionMajor
|
||||
VersionMinor = utils.VersionMinor
|
||||
VersionPatch = utils.VersionPatch
|
||||
VersionBeta = utils.VersionBeta
|
||||
)
|
||||
|
||||
204
utils/limiter.go
Normal file
204
utils/limiter.go
Normal file
@@ -0,0 +1,204 @@
|
||||
package utils
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"golang.org/x/time/rate"
|
||||
)
|
||||
|
||||
var ErrDropOverflow = errors.New("drop overflow limit")
|
||||
|
||||
// RateLimiter implements per-chat and global rate limiting with optional blocking.
|
||||
// It supports two modes:
|
||||
// - "drop" mode: immediately reject if limits are exceeded.
|
||||
// - "wait" mode: block until capacity is available.
|
||||
type RateLimiter struct {
|
||||
globalLockUntil time.Time // global cooldown timestamp (set by API errors)
|
||||
globalLimiter *rate.Limiter // global token bucket (30 req/sec)
|
||||
globalMu sync.RWMutex // protects globalLockUntil and globalLimiter
|
||||
|
||||
chatLocks map[int64]time.Time // per-chat cooldown timestamps
|
||||
chatLimiters map[int64]*rate.Limiter // per-chat token buckets (1 req/sec)
|
||||
chatMu sync.Mutex // protects chatLocks and chatLimiters
|
||||
}
|
||||
|
||||
// NewRateLimiter creates a new RateLimiter with default limits.
|
||||
// Global: 30 requests per second, burst 30.
|
||||
// Per-chat: 1 request per second, burst 1.
|
||||
func NewRateLimiter() *RateLimiter {
|
||||
return &RateLimiter{
|
||||
globalLimiter: rate.NewLimiter(30, 30),
|
||||
chatLimiters: make(map[int64]*rate.Limiter),
|
||||
chatLocks: make(map[int64]time.Time),
|
||||
}
|
||||
}
|
||||
|
||||
// SetGlobalLock sets a global cooldown period (e.g., after receiving 429 from Telegram).
|
||||
// If retryAfter <= 0, no lock is applied.
|
||||
func (rl *RateLimiter) SetGlobalLock(retryAfter int) {
|
||||
if retryAfter <= 0 {
|
||||
return
|
||||
}
|
||||
rl.globalMu.Lock()
|
||||
defer rl.globalMu.Unlock()
|
||||
rl.globalLockUntil = time.Now().Add(time.Duration(retryAfter) * time.Second)
|
||||
}
|
||||
|
||||
// SetChatLock sets a cooldown for a specific chat (e.g., after 429 for that chat).
|
||||
// If retryAfter <= 0, no lock is applied.
|
||||
func (rl *RateLimiter) SetChatLock(chatID int64, retryAfter int) {
|
||||
if retryAfter <= 0 {
|
||||
return
|
||||
}
|
||||
rl.chatMu.Lock()
|
||||
defer rl.chatMu.Unlock()
|
||||
rl.chatLocks[chatID] = time.Now().Add(time.Duration(retryAfter) * time.Second)
|
||||
}
|
||||
|
||||
// GlobalWait blocks until a global request can be made.
|
||||
// Waits for both global cooldown and token bucket availability.
|
||||
func (rl *RateLimiter) GlobalWait(ctx context.Context) error {
|
||||
if err := rl.waitForGlobalUnlock(ctx); err != nil {
|
||||
return err
|
||||
}
|
||||
return rl.globalLimiter.Wait(ctx)
|
||||
}
|
||||
|
||||
// Wait blocks until a request for the given chat can be made.
|
||||
// Waits for: chat cooldown → global cooldown → chat token bucket.
|
||||
// Note: Global limit is checked *before* chat limit to avoid overloading upstream.
|
||||
func (rl *RateLimiter) Wait(ctx context.Context, chatID int64) error {
|
||||
if err := rl.waitForChatUnlock(ctx, chatID); err != nil {
|
||||
return err
|
||||
}
|
||||
if err := rl.waitForGlobalUnlock(ctx); err != nil {
|
||||
return err
|
||||
}
|
||||
limiter := rl.getChatLimiter(chatID)
|
||||
return limiter.Wait(ctx)
|
||||
}
|
||||
|
||||
// GlobalAllow checks if a global request can be made without blocking.
|
||||
// Returns false if either global cooldown is active or token bucket is exhausted.
|
||||
func (rl *RateLimiter) GlobalAllow() bool {
|
||||
rl.globalMu.RLock()
|
||||
until := rl.globalLockUntil
|
||||
rl.globalMu.RUnlock()
|
||||
|
||||
if !until.IsZero() && time.Now().Before(until) {
|
||||
return false
|
||||
}
|
||||
return rl.globalLimiter.Allow()
|
||||
}
|
||||
|
||||
// Allow checks if a request for the given chat can be made without blocking.
|
||||
// Returns false if: global cooldown, chat cooldown, global limiter, or chat limiter denies.
|
||||
// Note: Global limiter is checked before chat limiter — upstream limits take priority.
|
||||
func (rl *RateLimiter) Allow(chatID int64) bool {
|
||||
// Check global cooldown
|
||||
rl.globalMu.RLock()
|
||||
globalUntil := rl.globalLockUntil
|
||||
rl.globalMu.RUnlock()
|
||||
if !globalUntil.IsZero() && time.Now().Before(globalUntil) {
|
||||
return false
|
||||
}
|
||||
|
||||
// Check chat cooldown
|
||||
rl.chatMu.Lock()
|
||||
chatUntil, ok := rl.chatLocks[chatID]
|
||||
rl.chatMu.Unlock()
|
||||
if ok && !chatUntil.IsZero() && time.Now().Before(chatUntil) {
|
||||
return false
|
||||
}
|
||||
|
||||
// Check global token bucket
|
||||
if !rl.globalLimiter.Allow() {
|
||||
return false
|
||||
}
|
||||
|
||||
// Check chat token bucket
|
||||
limiter := rl.getChatLimiter(chatID)
|
||||
return limiter.Allow()
|
||||
}
|
||||
|
||||
// Check applies rate limiting based on configuration.
|
||||
// If dropOverflow is true:
|
||||
// - Immediately returns ErrDropOverflow if either global or chat limit is exceeded.
|
||||
//
|
||||
// Else:
|
||||
// - If chatID != 0: waits for chat-specific capacity (including global limit).
|
||||
// - If chatID == 0: waits for global capacity only.
|
||||
//
|
||||
// chatID == 0 means no specific chat context (e.g., inline query, webhook without chat).
|
||||
func (rl *RateLimiter) Check(ctx context.Context, dropOverflow bool, chatID int64) error {
|
||||
if dropOverflow {
|
||||
if chatID != 0 && !rl.Allow(chatID) {
|
||||
return ErrDropOverflow
|
||||
}
|
||||
if !rl.GlobalAllow() {
|
||||
return ErrDropOverflow
|
||||
}
|
||||
} else if chatID != 0 {
|
||||
if err := rl.Wait(ctx, chatID); err != nil {
|
||||
return err
|
||||
}
|
||||
} else {
|
||||
if err := rl.GlobalWait(ctx); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// waitForGlobalUnlock blocks until global cooldown expires or context is done.
|
||||
// Does not check token bucket — only cooldown.
|
||||
func (rl *RateLimiter) waitForGlobalUnlock(ctx context.Context) error {
|
||||
rl.globalMu.RLock()
|
||||
until := rl.globalLockUntil
|
||||
rl.globalMu.RUnlock()
|
||||
|
||||
if until.IsZero() || time.Now().After(until) {
|
||||
return nil
|
||||
}
|
||||
|
||||
select {
|
||||
case <-time.After(time.Until(until)):
|
||||
return nil
|
||||
case <-ctx.Done():
|
||||
return ctx.Err()
|
||||
}
|
||||
}
|
||||
|
||||
// waitForChatUnlock blocks until the specified chat's cooldown expires or context is done.
|
||||
// Does not check token bucket — only cooldown.
|
||||
func (rl *RateLimiter) waitForChatUnlock(ctx context.Context, chatID int64) error {
|
||||
rl.chatMu.Lock()
|
||||
until, ok := rl.chatLocks[chatID]
|
||||
rl.chatMu.Unlock()
|
||||
|
||||
if !ok || until.IsZero() || time.Now().After(until) {
|
||||
return nil
|
||||
}
|
||||
|
||||
select {
|
||||
case <-time.After(time.Until(until)):
|
||||
return nil
|
||||
case <-ctx.Done():
|
||||
return ctx.Err()
|
||||
}
|
||||
}
|
||||
|
||||
// getChatLimiter returns the rate limiter for the given chat, creating it if needed.
|
||||
// Uses 1 request per second with burst of 1 — conservative for per-user limits.
|
||||
// Must be called with rl.chatMu held.
|
||||
func (rl *RateLimiter) getChatLimiter(chatID int64) *rate.Limiter {
|
||||
if lim, ok := rl.chatLimiters[chatID]; ok {
|
||||
return lim
|
||||
}
|
||||
lim := rate.NewLimiter(1, 1)
|
||||
rl.chatLimiters[chatID] = lim
|
||||
return lim
|
||||
}
|
||||
@@ -1,7 +1,6 @@
|
||||
package utils
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io"
|
||||
"mime/multipart"
|
||||
@@ -26,33 +25,31 @@ func Encode[T any](w *multipart.Writer, req T) error {
|
||||
field := v.Field(i)
|
||||
fieldType := t.Field(i)
|
||||
|
||||
formTags := strings.Split(fieldType.Tag.Get("json"), ",")
|
||||
fieldName := ""
|
||||
if len(formTags) == 0 {
|
||||
formTags = strings.Split(fieldType.Tag.Get("json"), ",")
|
||||
jsonTag := fieldType.Tag.Get("json")
|
||||
if jsonTag == "" {
|
||||
jsonTag = fieldType.Name
|
||||
}
|
||||
|
||||
if len(formTags) > 0 {
|
||||
fieldName = formTags[0]
|
||||
parts := strings.Split(jsonTag, ",")
|
||||
fieldName := parts[0]
|
||||
if fieldName == "-" {
|
||||
continue
|
||||
}
|
||||
if slices.Index(formTags, "omitempty") >= 0 {
|
||||
if field.IsZero() {
|
||||
|
||||
// Handle omitempty
|
||||
isEmpty := field.IsZero()
|
||||
if slices.Contains(parts, "omitempty") && isEmpty {
|
||||
continue
|
||||
}
|
||||
}
|
||||
} else {
|
||||
fieldName = strings.ToLower(fieldType.Name)
|
||||
}
|
||||
|
||||
var (
|
||||
fw io.Writer
|
||||
err error
|
||||
)
|
||||
|
||||
switch field.Kind() {
|
||||
case reflect.String:
|
||||
if field.String() != "" {
|
||||
if !isEmpty {
|
||||
fw, err = w.CreateFormField(fieldName)
|
||||
if err == nil {
|
||||
_, err = fw.Write([]byte(field.String()))
|
||||
@@ -80,24 +77,23 @@ func Encode[T any](w *multipart.Writer, req T) error {
|
||||
}
|
||||
case reflect.Slice:
|
||||
if field.Type().Elem().Kind() == reflect.Uint8 && !field.IsNil() {
|
||||
// Handle []byte as file upload (e.g., thumbnail)
|
||||
filename := fieldType.Tag.Get("filename")
|
||||
if filename == "" {
|
||||
filename = fieldName
|
||||
}
|
||||
|
||||
ext := ""
|
||||
filename = filename + ext
|
||||
|
||||
fw, err = w.CreateFormFile(fieldName, filename)
|
||||
if err == nil {
|
||||
_, err = fw.Write(field.Bytes())
|
||||
}
|
||||
} else if !field.IsNil() {
|
||||
// Handle slice of primitive values (as multiple form fields with the same name)
|
||||
// Handle []string, []int, etc. — send as multiple fields with same name
|
||||
for j := 0; j < field.Len(); j++ {
|
||||
elem := field.Index(j)
|
||||
fw, err = w.CreateFormField(fieldName)
|
||||
if err == nil {
|
||||
if err != nil {
|
||||
break
|
||||
}
|
||||
switch elem.Kind() {
|
||||
case reflect.String:
|
||||
_, err = fw.Write([]byte(elem.String()))
|
||||
@@ -105,20 +101,23 @@ func Encode[T any](w *multipart.Writer, req T) error {
|
||||
_, err = fw.Write([]byte(strconv.FormatInt(elem.Int(), 10)))
|
||||
case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
|
||||
_, err = fw.Write([]byte(strconv.FormatUint(elem.Uint(), 10)))
|
||||
case reflect.Bool:
|
||||
_, err = fw.Write([]byte(strconv.FormatBool(elem.Bool())))
|
||||
case reflect.Float32, reflect.Float64:
|
||||
_, err = fw.Write([]byte(strconv.FormatFloat(elem.Float(), 'f', -1, 64)))
|
||||
}
|
||||
if err != nil {
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
case reflect.Struct:
|
||||
var jsonData []byte
|
||||
jsonData, err = json.Marshal(field.Interface())
|
||||
if err == nil {
|
||||
fw, err = w.CreateFormField(fieldName)
|
||||
if err == nil {
|
||||
_, err = fw.Write(jsonData)
|
||||
}
|
||||
}
|
||||
// Don't serialize structs as JSON — flatten them!
|
||||
// Telegram doesn't support nested JSON in form-data.
|
||||
// If you need nested data, use separate fields (e.g., ParseMode, CaptionEntities)
|
||||
// This is a design choice — you should avoid nested structs in params.
|
||||
return fmt.Errorf("nested structs are not supported in params — use flat fields")
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
|
||||
@@ -1,9 +1,7 @@
|
||||
package utils
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"strings"
|
||||
|
||||
"git.nix13.pw/scuroneko/slog"
|
||||
)
|
||||
@@ -15,18 +13,3 @@ func GetLoggerLevel() slog.LogLevel {
|
||||
}
|
||||
return level
|
||||
}
|
||||
|
||||
func EscapeMarkdown(s string) string {
|
||||
s = strings.ReplaceAll(s, "_", `\_`)
|
||||
s = strings.ReplaceAll(s, "*", `\*`)
|
||||
s = strings.ReplaceAll(s, "[", `\[`)
|
||||
return strings.ReplaceAll(s, "`", "\\`")
|
||||
}
|
||||
|
||||
func EscapeMarkdownV2(s string) string {
|
||||
symbols := []string{"_", "*", "[", "]", "(", ")", "~", "`", ">", "#", "+", "-", "=", "|", "{", "}", ".", "!"}
|
||||
for _, symbol := range symbols {
|
||||
s = strings.ReplaceAll(s, symbol, fmt.Sprintf("\\%s", symbol))
|
||||
}
|
||||
return s
|
||||
}
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
package utils
|
||||
|
||||
const (
|
||||
VersionString = "1.0.0-beta.4"
|
||||
VersionString = "1.0.0-beta.15"
|
||||
VersionMajor = 1
|
||||
VersionMinor = 0
|
||||
VersionPatch = 0
|
||||
Beta = 4
|
||||
VersionBeta = 15
|
||||
)
|
||||
|
||||
Reference in New Issue
Block a user