Compare commits
7 Commits
v1.0.0-bet
...
v1.0.0-bet
| Author | SHA1 | Date | |
|---|---|---|---|
|
3b6bb82e04
|
|||
|
0574222608
|
|||
|
b1b0cbdfbd
|
|||
|
7e12e0a9f9
|
|||
|
8b9a974da9
|
|||
|
4dc172a3b5
|
|||
|
f42d47af53
|
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
|
# 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
|
||||||
391
bot.go
391
bot.go
@@ -1,3 +1,34 @@
|
|||||||
|
// 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()
|
||||||
|
// <-ctx.Done() // wait for shutdown signal
|
||||||
|
//
|
||||||
|
// All methods are thread-safe except direct field access. Use provided accessors
|
||||||
|
// (e.g., GetDBContext, SetUpdateOffset) for safe concurrent access.
|
||||||
package laniakea
|
package laniakea
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -8,6 +39,7 @@ import (
|
|||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
"sync"
|
"sync"
|
||||||
|
"time"
|
||||||
|
|
||||||
"git.nix13.pw/scuroneko/extypes"
|
"git.nix13.pw/scuroneko/extypes"
|
||||||
"git.nix13.pw/scuroneko/laniakea/tgapi"
|
"git.nix13.pw/scuroneko/laniakea/tgapi"
|
||||||
@@ -16,30 +48,81 @@ import (
|
|||||||
"github.com/alitto/pond/v2"
|
"github.com/alitto/pond/v2"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// 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 {
|
type BotOpts struct {
|
||||||
Token string
|
// 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
|
UpdateTypes []string
|
||||||
|
|
||||||
Debug bool
|
// 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
|
ErrorTemplate string
|
||||||
Prefixes []string
|
|
||||||
|
|
||||||
LoggerBasePath 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
|
UseRequestLogger bool
|
||||||
WriteToFile 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
|
UseTestServer bool
|
||||||
APIUrl string
|
|
||||||
|
|
||||||
RateLimit int
|
// 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
|
DropRLOverflow bool
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// NewOpts returns a new BotOpts with zero values.
|
||||||
func NewOpts() *BotOpts { return new(BotOpts) }
|
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 {
|
func LoadOptsFromEnv() *BotOpts {
|
||||||
rateLimit := 30
|
rateLimit := 30
|
||||||
if rl := os.Getenv("RATE_LIMIT"); rl != "" {
|
if rl := os.Getenv("RATE_LIMIT"); rl != "" {
|
||||||
rateLimit, _ = strconv.Atoi(rl)
|
if n, err := strconv.Atoi(rl); err == nil {
|
||||||
|
rateLimit = n
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return &BotOpts{
|
return &BotOpts{
|
||||||
@@ -50,6 +133,7 @@ func LoadOptsFromEnv() *BotOpts {
|
|||||||
ErrorTemplate: os.Getenv("ERROR_TEMPLATE"),
|
ErrorTemplate: os.Getenv("ERROR_TEMPLATE"),
|
||||||
Prefixes: LoadPrefixesFromEnv(),
|
Prefixes: LoadPrefixesFromEnv(),
|
||||||
|
|
||||||
|
LoggerBasePath: os.Getenv("LOGGER_BASE_PATH"),
|
||||||
UseRequestLogger: os.Getenv("USE_REQ_LOG") == "true",
|
UseRequestLogger: os.Getenv("USE_REQ_LOG") == "true",
|
||||||
WriteToFile: os.Getenv("WRITE_TO_FILE") == "true",
|
WriteToFile: os.Getenv("WRITE_TO_FILE") == "true",
|
||||||
|
|
||||||
@@ -60,6 +144,9 @@ func LoadOptsFromEnv() *BotOpts {
|
|||||||
DropRLOverflow: os.Getenv("DROP_RL_OVERFLOW") == "true",
|
DropRLOverflow: os.Getenv("DROP_RL_OVERFLOW") == "true",
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// LoadPrefixesFromEnv returns the PREFIXES environment variable split by semicolon.
|
||||||
|
// Defaults to ["/"] if not set.
|
||||||
func LoadPrefixesFromEnv() []string {
|
func LoadPrefixesFromEnv() []string {
|
||||||
prefixesS, exists := os.LookupEnv("PREFIXES")
|
prefixesS, exists := os.LookupEnv("PREFIXES")
|
||||||
if !exists {
|
if !exists {
|
||||||
@@ -68,48 +155,95 @@ func LoadPrefixesFromEnv() []string {
|
|||||||
return strings.Split(prefixesS, ";")
|
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{}
|
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 }
|
type NoDB struct{ DbContext }
|
||||||
|
|
||||||
|
// 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 {
|
type Bot[T DbContext] struct {
|
||||||
token string
|
token string
|
||||||
debug bool
|
debug bool
|
||||||
errorTemplate string
|
errorTemplate string
|
||||||
username string
|
username string
|
||||||
|
|
||||||
logger *slog.Logger
|
logger *slog.Logger // Main bot logger (JSON stdout + optional file)
|
||||||
RequestLogger *slog.Logger
|
RequestLogger *slog.Logger // Optional request-level API logging
|
||||||
extraLoggers extypes.Slice[*slog.Logger]
|
extraLoggers extypes.Slice[*slog.Logger] // API, Uploader, and custom loggers
|
||||||
|
|
||||||
plugins []Plugin[T]
|
plugins []Plugin[T] // Command/event handlers
|
||||||
middlewares []Middleware[T]
|
middlewares []Middleware[T] // Pre-processing filters (sorted by order)
|
||||||
prefixes []string
|
prefixes []string // Command prefixes (e.g., "/", "!")
|
||||||
runners []Runner[T]
|
runners []Runner[T] // Background tasks (e.g., cleanup, cron)
|
||||||
|
|
||||||
api *tgapi.API
|
api *tgapi.API // Telegram API client
|
||||||
uploader *tgapi.Uploader
|
uploader *tgapi.Uploader // File uploader
|
||||||
dbContext *T
|
dbContext *T // Injected database context
|
||||||
l10n *L10n
|
l10n *L10n // Localization manager
|
||||||
draftProvider *DraftProvider
|
draftProvider *DraftProvider // Draft message builder
|
||||||
|
|
||||||
updateOffsetMu sync.Mutex
|
updateOffsetMu sync.Mutex
|
||||||
updateOffset int
|
updateOffset int // Last processed update ID
|
||||||
updateTypes []tgapi.UpdateType
|
updateTypes []tgapi.UpdateType // Types of updates to fetch
|
||||||
updateQueue chan *tgapi.Update
|
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] {
|
func NewBot[T any](opts *BotOpts) *Bot[T] {
|
||||||
updateQueue := make(chan *tgapi.Update, 512)
|
if opts.Token == "" {
|
||||||
|
panic("laniakea: BotOpts.Token is required")
|
||||||
var limiter *utils.RateLimiter
|
|
||||||
if opts.RateLimit > 0 {
|
|
||||||
limiter = utils.NewRateLimiter()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
apiOpts := tgapi.NewAPIOpts(opts.Token).SetAPIUrl(opts.APIUrl).UseTestServer(opts.UseTestServer).SetLimiter(limiter)
|
updateQueue := make(chan *tgapi.Update, 512)
|
||||||
api := tgapi.NewAPI(apiOpts)
|
|
||||||
|
|
||||||
|
//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)
|
uploader := tgapi.NewUploader(api)
|
||||||
|
|
||||||
|
prefixes := opts.Prefixes
|
||||||
|
if len(prefixes) == 0 {
|
||||||
|
prefixes = []string{"/"}
|
||||||
|
}
|
||||||
|
|
||||||
bot := &Bot[T]{
|
bot := &Bot[T]{
|
||||||
updateOffset: 0,
|
updateOffset: 0,
|
||||||
errorTemplate: "%s",
|
errorTemplate: "%s",
|
||||||
@@ -117,7 +251,7 @@ func NewBot[T any](opts *BotOpts) *Bot[T] {
|
|||||||
api: api,
|
api: api,
|
||||||
uploader: uploader,
|
uploader: uploader,
|
||||||
debug: opts.Debug,
|
debug: opts.Debug,
|
||||||
prefixes: opts.Prefixes,
|
prefixes: prefixes,
|
||||||
token: opts.Token,
|
token: opts.Token,
|
||||||
plugins: make([]Plugin[T], 0),
|
plugins: make([]Plugin[T], 0),
|
||||||
updateTypes: make([]tgapi.UpdateType, 0),
|
updateTypes: make([]tgapi.UpdateType, 0),
|
||||||
@@ -126,6 +260,8 @@ func NewBot[T any](opts *BotOpts) *Bot[T] {
|
|||||||
l10n: &L10n{},
|
l10n: &L10n{},
|
||||||
draftProvider: NewRandomDraftProvider(api),
|
draftProvider: NewRandomDraftProvider(api),
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Add API and Uploader loggers to extraLoggers for unified output
|
||||||
bot.extraLoggers = bot.extraLoggers.Push(api.GetLogger()).Push(uploader.GetLogger())
|
bot.extraLoggers = bot.extraLoggers.Push(api.GetLogger()).Push(uploader.GetLogger())
|
||||||
|
|
||||||
if len(opts.ErrorTemplate) > 0 {
|
if len(opts.ErrorTemplate) > 0 {
|
||||||
@@ -136,6 +272,7 @@ func NewBot[T any](opts *BotOpts) *Bot[T] {
|
|||||||
}
|
}
|
||||||
bot.initLoggers(opts)
|
bot.initLoggers(opts)
|
||||||
|
|
||||||
|
// Fetch bot info to validate token and get username
|
||||||
u, err := api.GetMe()
|
u, err := api.GetMe()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
_ = bot.Close()
|
_ = bot.Close()
|
||||||
@@ -143,12 +280,22 @@ func NewBot[T any](opts *BotOpts) *Bot[T] {
|
|||||||
}
|
}
|
||||||
bot.username = Val(u.Username, "")
|
bot.username = Val(u.Username, "")
|
||||||
if bot.username == "" {
|
if bot.username == "" {
|
||||||
bot.logger.Warn("Can't get bot username. Named command wouldn't work!")
|
bot.logger.Warn("Can't get bot username. Named command handlers won't work!")
|
||||||
}
|
}
|
||||||
bot.logger.Infof("Authorized as %s\n", u.FirstName)
|
bot.logger.Infoln(fmt.Sprintf("Authorized as %s (@%s)", u.FirstName, Val(u.Username, "unknown")))
|
||||||
|
|
||||||
return bot
|
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 {
|
func (bot *Bot[T]) Close() error {
|
||||||
if err := bot.uploader.Close(); err != nil {
|
if err := bot.uploader.Close(); err != nil {
|
||||||
bot.logger.Errorln(err)
|
bot.logger.Errorln(err)
|
||||||
@@ -156,14 +303,22 @@ func (bot *Bot[T]) Close() error {
|
|||||||
if err := bot.api.CloseApi(); err != nil {
|
if err := bot.api.CloseApi(); err != nil {
|
||||||
bot.logger.Errorln(err)
|
bot.logger.Errorln(err)
|
||||||
}
|
}
|
||||||
if err := bot.RequestLogger.Close(); err != nil {
|
if bot.RequestLogger != nil {
|
||||||
bot.logger.Errorln(err)
|
if err := bot.RequestLogger.Close(); err != nil {
|
||||||
|
bot.logger.Errorln(err)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
if err := bot.logger.Close(); err != nil {
|
if err := bot.logger.Close(); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
return nil
|
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) {
|
func (bot *Bot[T]) initLoggers(opts *BotOpts) {
|
||||||
level := slog.FATAL
|
level := slog.FATAL
|
||||||
if opts.Debug {
|
if opts.Debug {
|
||||||
@@ -195,27 +350,59 @@ func (bot *Bot[T]) initLoggers(opts *BotOpts) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// GetUpdateOffset returns the current update offset (thread-safe).
|
||||||
func (bot *Bot[T]) GetUpdateOffset() int {
|
func (bot *Bot[T]) GetUpdateOffset() int {
|
||||||
bot.updateOffsetMu.Lock()
|
bot.updateOffsetMu.Lock()
|
||||||
defer bot.updateOffsetMu.Unlock()
|
defer bot.updateOffsetMu.Unlock()
|
||||||
return bot.updateOffset
|
return bot.updateOffset
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetUpdateOffset sets the update offset for next GetUpdates call (thread-safe).
|
||||||
func (bot *Bot[T]) SetUpdateOffset(offset int) {
|
func (bot *Bot[T]) SetUpdateOffset(offset int) {
|
||||||
bot.updateOffsetMu.Lock()
|
bot.updateOffsetMu.Lock()
|
||||||
defer bot.updateOffsetMu.Unlock()
|
defer bot.updateOffsetMu.Unlock()
|
||||||
bot.updateOffset = offset
|
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 }
|
func (bot *Bot[T]) GetUpdateTypes() []tgapi.UpdateType { return bot.updateTypes }
|
||||||
func (bot *Bot[T]) GetLogger() *slog.Logger { return bot.logger }
|
|
||||||
func (bot *Bot[T]) GetDBContext() *T { return bot.dbContext }
|
// GetLogger returns the main bot logger.
|
||||||
func (bot *Bot[T]) L10n(lang, key string) string { return bot.l10n.Translate(lang, key) }
|
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 }
|
||||||
|
|
||||||
|
// 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] {
|
func (bot *Bot[T]) SetDraftProvider(p *DraftProvider) *Bot[T] {
|
||||||
bot.draftProvider = p
|
bot.draftProvider = p
|
||||||
return bot
|
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
|
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] {
|
func (bot *Bot[T]) AddDatabaseLoggerWriter(writer DbLogger[T]) *Bot[T] {
|
||||||
w := writer(bot.dbContext)
|
w := writer(bot.dbContext)
|
||||||
bot.logger.AddWriter(w)
|
bot.logger.AddWriter(w)
|
||||||
@@ -228,31 +415,51 @@ func (bot *Bot[T]) AddDatabaseLoggerWriter(writer DbLogger[T]) *Bot[T] {
|
|||||||
return bot
|
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] {
|
func (bot *Bot[T]) DatabaseContext(ctx *T) *Bot[T] {
|
||||||
bot.dbContext = ctx
|
bot.dbContext = ctx
|
||||||
return bot
|
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] {
|
func (bot *Bot[T]) UpdateTypes(t ...tgapi.UpdateType) *Bot[T] {
|
||||||
bot.updateTypes = make([]tgapi.UpdateType, 0)
|
bot.updateTypes = make([]tgapi.UpdateType, 0)
|
||||||
bot.updateTypes = append(bot.updateTypes, t...)
|
bot.updateTypes = append(bot.updateTypes, t...)
|
||||||
return bot
|
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] {
|
func (bot *Bot[T]) AddUpdateType(t ...tgapi.UpdateType) *Bot[T] {
|
||||||
bot.updateTypes = append(bot.updateTypes, t...)
|
bot.updateTypes = append(bot.updateTypes, t...)
|
||||||
return bot
|
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] {
|
func (bot *Bot[T]) AddPrefixes(prefixes ...string) *Bot[T] {
|
||||||
bot.prefixes = append(bot.prefixes, prefixes...)
|
bot.prefixes = append(bot.prefixes, prefixes...)
|
||||||
return bot
|
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] {
|
func (bot *Bot[T]) ErrorTemplate(s string) *Bot[T] {
|
||||||
bot.errorTemplate = s
|
bot.errorTemplate = s
|
||||||
return bot
|
return bot
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Debug enables or disables debug logging.
|
||||||
func (bot *Bot[T]) Debug(debug bool) *Bot[T] {
|
func (bot *Bot[T]) Debug(debug bool) *Bot[T] {
|
||||||
bot.debug = debug
|
bot.debug = debug
|
||||||
return bot
|
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] {
|
func (bot *Bot[T]) AddPlugins(plugin ...*Plugin[T]) *Bot[T] {
|
||||||
for _, p := range plugin {
|
for _, p := range plugin {
|
||||||
bot.plugins = append(bot.plugins, *p)
|
bot.plugins = append(bot.plugins, *p)
|
||||||
@@ -260,33 +467,96 @@ func (bot *Bot[T]) AddPlugins(plugin ...*Plugin[T]) *Bot[T] {
|
|||||||
}
|
}
|
||||||
return bot
|
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] {
|
func (bot *Bot[T]) AddMiddleware(middleware ...Middleware[T]) *Bot[T] {
|
||||||
bot.middlewares = append(bot.middlewares, middleware...)
|
|
||||||
for _, m := range 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))
|
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 {
|
sort.Slice(bot.middlewares, func(i, j int) bool {
|
||||||
first := bot.middlewares[i]
|
first := bot.middlewares[i]
|
||||||
second := bot.middlewares[j]
|
second := bot.middlewares[j]
|
||||||
if first.order == second.order {
|
if first.order != second.order {
|
||||||
return first.name < second.name
|
return first.order < second.order
|
||||||
}
|
}
|
||||||
return first.order < second.order
|
return first.name < second.name
|
||||||
})
|
})
|
||||||
|
|
||||||
return bot
|
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] {
|
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.runners = append(bot.runners, runner)
|
||||||
bot.logger.Debugln(fmt.Sprintf("runner with name \"%s\" registered", runner.name))
|
bot.logger.Debugln(fmt.Sprintf("runner with name \"%s\" registered", runner.name))
|
||||||
return bot
|
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] {
|
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
|
bot.l10n = l
|
||||||
return bot
|
return bot
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// enqueueUpdate attempts to add an update to the internal processing queue.
|
||||||
|
//
|
||||||
|
// Returns extypes.QueueFullErr if the queue is full and the update cannot be enqueued.
|
||||||
|
// This is non-blocking and used to implement rate-limiting behavior.
|
||||||
|
//
|
||||||
|
// When DropRLOverflow is enabled, this error is ignored and the update is dropped.
|
||||||
|
// Otherwise, the update is retried via the main update loop.
|
||||||
func (bot *Bot[T]) enqueueUpdate(u *tgapi.Update) error {
|
func (bot *Bot[T]) enqueueUpdate(u *tgapi.Update) error {
|
||||||
select {
|
select {
|
||||||
case bot.updateQueue <- u:
|
case bot.updateQueue <- u:
|
||||||
@@ -295,6 +565,26 @@ func (bot *Bot[T]) enqueueUpdate(u *tgapi.Update) error {
|
|||||||
return extypes.QueueFullErr
|
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) {
|
func (bot *Bot[T]) RunWithContext(ctx context.Context) {
|
||||||
if len(bot.prefixes) == 0 {
|
if len(bot.prefixes) == 0 {
|
||||||
bot.logger.Fatalln("no prefixes defined")
|
bot.logger.Fatalln("no prefixes defined")
|
||||||
@@ -309,6 +599,8 @@ func (bot *Bot[T]) RunWithContext(ctx context.Context) {
|
|||||||
bot.ExecRunners()
|
bot.ExecRunners()
|
||||||
|
|
||||||
bot.logger.Infoln("Bot running. Press CTRL+C to exit.")
|
bot.logger.Infoln("Bot running. Press CTRL+C to exit.")
|
||||||
|
|
||||||
|
// Start update polling in a goroutine
|
||||||
go func() {
|
go func() {
|
||||||
for {
|
for {
|
||||||
select {
|
select {
|
||||||
@@ -317,13 +609,14 @@ func (bot *Bot[T]) RunWithContext(ctx context.Context) {
|
|||||||
default:
|
default:
|
||||||
updates, err := bot.Updates()
|
updates, err := bot.Updates()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
bot.logger.Errorln(err)
|
bot.logger.Errorln("failed to fetch updates:", err)
|
||||||
|
time.Sleep(2 * time.Second) // exponential backoff
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, u := range updates {
|
for _, u := range updates {
|
||||||
select {
|
select {
|
||||||
case bot.updateQueue <- new(u):
|
case bot.updateQueue <- &u:
|
||||||
case <-ctx.Done():
|
case <-ctx.Done():
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -332,14 +625,22 @@ func (bot *Bot[T]) RunWithContext(ctx context.Context) {
|
|||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
|
|
||||||
|
// Start worker pool for concurrent update handling
|
||||||
pool := pond.NewPool(16)
|
pool := pond.NewPool(16)
|
||||||
for update := range bot.updateQueue {
|
for update := range bot.updateQueue {
|
||||||
update := update
|
update := update // capture loop variable
|
||||||
pool.Submit(func() {
|
pool.Submit(func() {
|
||||||
bot.handle(update)
|
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() {
|
func (bot *Bot[T]) Run() {
|
||||||
bot.RunWithContext(context.Background())
|
bot.RunWithContext(context.Background())
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,3 +1,12 @@
|
|||||||
|
// 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
|
package laniakea
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -8,23 +17,52 @@ import (
|
|||||||
"git.nix13.pw/scuroneko/laniakea/tgapi"
|
"git.nix13.pw/scuroneko/laniakea/tgapi"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// 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 {
|
func generateBotCommand[T any](cmd Command[T]) tgapi.BotCommand {
|
||||||
desc := cmd.command
|
desc := cmd.command
|
||||||
if len(cmd.description) > 0 {
|
if len(cmd.description) > 0 {
|
||||||
desc = cmd.description
|
desc = cmd.description
|
||||||
}
|
}
|
||||||
|
|
||||||
var descArgs []string
|
var descArgs []string
|
||||||
for _, a := range cmd.args {
|
for _, a := range cmd.args {
|
||||||
if a.required {
|
if a.required {
|
||||||
descArgs = append(descArgs, fmt.Sprintf("%s", a.text))
|
descArgs = append(descArgs, a.text)
|
||||||
} else {
|
} else {
|
||||||
descArgs = append(descArgs, fmt.Sprintf("[%s]", a.text))
|
descArgs = append(descArgs, fmt.Sprintf("[%s]", a.text))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
desc = fmt.Sprintf("%s. Usage: /%s %s", desc, cmd.command, strings.Join(descArgs, " "))
|
desc = fmt.Sprintf("%s. Usage: /%s %s", desc, cmd.command, strings.Join(descArgs, " "))
|
||||||
return tgapi.BotCommand{Command: cmd.command, Description: desc}
|
return tgapi.BotCommand{Command: cmd.command, Description: desc}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// 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 {
|
func generateBotCommandForPlugin[T any](pl Plugin[T]) []tgapi.BotCommand {
|
||||||
commands := make([]tgapi.BotCommand, 0)
|
commands := make([]tgapi.BotCommand, 0)
|
||||||
for _, cmd := range pl.commands {
|
for _, cmd := range pl.commands {
|
||||||
@@ -36,37 +74,66 @@ func generateBotCommandForPlugin[T any](pl Plugin[T]) []tgapi.BotCommand {
|
|||||||
return commands
|
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 {
|
func (bot *Bot[T]) AutoGenerateCommands() error {
|
||||||
|
// Clear existing commands to avoid duplication or stale entries
|
||||||
_, err := bot.api.DeleteMyCommands(tgapi.DeleteMyCommandsP{})
|
_, err := bot.api.DeleteMyCommands(tgapi.DeleteMyCommandsP{})
|
||||||
if err != nil {
|
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)
|
commands := make([]tgapi.BotCommand, 0)
|
||||||
for _, pl := range bot.plugins {
|
for _, pl := range bot.plugins {
|
||||||
if pl.skipAutoCmd {
|
if pl.skipAutoCmd {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
commands = append(commands, generateBotCommandForPlugin(pl)...)
|
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 {
|
if len(commands) > 100 {
|
||||||
return ErrTooManyCommands
|
return ErrTooManyCommands
|
||||||
}
|
}
|
||||||
|
|
||||||
privateChatsScope := &tgapi.BotCommandScope{Type: tgapi.BotCommandScopePrivateType}
|
// Register commands for each scope
|
||||||
groupChatsScope := &tgapi.BotCommandScope{Type: tgapi.BotCommandScopeGroupType}
|
scopes := []*tgapi.BotCommandScope{
|
||||||
chatAdminsScope := &tgapi.BotCommandScope{Type: tgapi.BotCommandScopeAllChatAdministratorsType}
|
{Type: tgapi.BotCommandScopePrivateType},
|
||||||
_, err = bot.api.SetMyCommands(tgapi.SetMyCommandsP{Commands: commands, Scope: privateChatsScope})
|
{Type: tgapi.BotCommandScopeGroupType},
|
||||||
if err != nil {
|
{Type: tgapi.BotCommandScopeAllChatAdministratorsType},
|
||||||
return err
|
|
||||||
}
|
}
|
||||||
_, err = bot.api.SetMyCommands(tgapi.SetMyCommandsP{Commands: commands, Scope: groupChatsScope})
|
|
||||||
if err != nil {
|
for _, scope := range scopes {
|
||||||
return err
|
_, err = bot.api.SetMyCommands(tgapi.SetMyCommandsP{
|
||||||
|
Commands: commands,
|
||||||
|
Scope: scope,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
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
|
||||||
}
|
}
|
||||||
|
|||||||
283
drafts.go
283
drafts.go
@@ -1,3 +1,31 @@
|
|||||||
|
// 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)
|
||||||
|
// provider.SetChat(-1001234567890, 0).SetParseMode(tgapi.ParseModeHTML)
|
||||||
|
//
|
||||||
|
// draft := provider.NewDraft(tgapi.ParseModeMarkdown)
|
||||||
|
// 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
|
package laniakea
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -7,38 +35,137 @@ import (
|
|||||||
"git.nix13.pw/scuroneko/laniakea/tgapi"
|
"git.nix13.pw/scuroneko/laniakea/tgapi"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// draftIdGenerator defines an interface for generating unique draft IDs.
|
||||||
type draftIdGenerator interface {
|
type draftIdGenerator interface {
|
||||||
|
// Next returns the next unique draft ID.
|
||||||
Next() uint64
|
Next() uint64
|
||||||
}
|
}
|
||||||
|
|
||||||
type RandomDraftIdGenerator struct {
|
// RandomDraftIdGenerator generates draft IDs using cryptographically secure random numbers.
|
||||||
draftIdGenerator
|
// 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 {
|
func (g *RandomDraftIdGenerator) Next() uint64 {
|
||||||
return rand.Uint64()
|
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 {
|
type LinearDraftIdGenerator struct {
|
||||||
draftIdGenerator
|
|
||||||
lastId atomic.Uint64
|
lastId atomic.Uint64
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Next returns the next linear ID, atomically incremented.
|
||||||
func (g *LinearDraftIdGenerator) Next() uint64 {
|
func (g *LinearDraftIdGenerator) Next() uint64 {
|
||||||
return g.lastId.Add(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 {
|
type DraftProvider struct {
|
||||||
api *tgapi.API
|
api *tgapi.API
|
||||||
|
drafts map[uint64]*Draft
|
||||||
|
generator draftIdGenerator
|
||||||
|
|
||||||
|
// Internal defaults — not exposed directly to users.
|
||||||
chatID int64
|
chatID int64
|
||||||
messageThreadID int
|
messageThreadID int
|
||||||
parseMode tgapi.ParseMode
|
parseMode tgapi.ParseMode
|
||||||
entities []tgapi.MessageEntity
|
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 {
|
type Draft struct {
|
||||||
api *tgapi.API
|
api *tgapi.API
|
||||||
provider *DraftProvider
|
provider *DraftProvider
|
||||||
@@ -52,57 +179,98 @@ type Draft struct {
|
|||||||
Message string
|
Message string
|
||||||
}
|
}
|
||||||
|
|
||||||
func NewRandomDraftProvider(api *tgapi.API) *DraftProvider {
|
// NewDraft creates a new draft with the provided parse mode.
|
||||||
return &DraftProvider{
|
//
|
||||||
api: api, generator: &RandomDraftIdGenerator{},
|
// The draft inherits the provider's chatID, messageThreadID, and entities.
|
||||||
drafts: make(map[uint64]*Draft),
|
// 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 {
|
id := p.generator.Next()
|
||||||
g := &LinearDraftIdGenerator{}
|
|
||||||
g.lastId.Store(startValue)
|
|
||||||
return &DraftProvider{
|
|
||||||
api: api,
|
|
||||||
generator: g,
|
|
||||||
drafts: make(map[uint64]*Draft),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
func (d *DraftProvider) NewDraft() *Draft {
|
|
||||||
id := d.generator.Next()
|
|
||||||
entitiesCopy := make([]tgapi.MessageEntity, 0)
|
|
||||||
copy(entitiesCopy, d.entities)
|
|
||||||
draft := &Draft{
|
draft := &Draft{
|
||||||
api: d.api,
|
api: p.api,
|
||||||
provider: d,
|
provider: p,
|
||||||
chatID: d.chatID,
|
chatID: p.chatID,
|
||||||
messageThreadID: d.messageThreadID,
|
messageThreadID: p.messageThreadID,
|
||||||
parseMode: d.parseMode,
|
parseMode: parseMode,
|
||||||
entities: entitiesCopy,
|
entities: p.entities, // Shallow copy — caller must ensure immutability
|
||||||
ID: id,
|
ID: id,
|
||||||
Message: "",
|
Message: "",
|
||||||
}
|
}
|
||||||
d.drafts[id] = draft
|
p.drafts[id] = draft
|
||||||
return draft
|
return draft
|
||||||
}
|
}
|
||||||
|
|
||||||
func (d *Draft) Push(newText string) error {
|
// SetChat overrides the draft's target chat and message thread.
|
||||||
d.Message += newText
|
//
|
||||||
params := tgapi.SendMessageDraftP{
|
// This is useful for sending a draft to a different chat than the provider's default.
|
||||||
ChatID: d.chatID,
|
func (d *Draft) SetChat(chatID int64, messageThreadID int) *Draft {
|
||||||
DraftID: d.ID,
|
d.chatID = chatID
|
||||||
Text: d.Message,
|
d.messageThreadID = messageThreadID
|
||||||
ParseMode: d.parseMode,
|
return d
|
||||||
Entities: d.entities,
|
|
||||||
}
|
|
||||||
if d.messageThreadID > 0 {
|
|
||||||
params.MessageThreadID = d.messageThreadID
|
|
||||||
}
|
|
||||||
_, err := d.api.SendMessageDraft(params)
|
|
||||||
return err
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// 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() {
|
func (d *Draft) Clear() {
|
||||||
d.Message = ""
|
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 {
|
func (d *Draft) Flush() error {
|
||||||
if d.Message == "" {
|
if d.Message == "" {
|
||||||
return nil
|
return nil
|
||||||
@@ -117,10 +285,27 @@ func (d *Draft) Flush() error {
|
|||||||
if d.messageThreadID > 0 {
|
if d.messageThreadID > 0 {
|
||||||
params.MessageThreadID = d.messageThreadID
|
params.MessageThreadID = d.messageThreadID
|
||||||
}
|
}
|
||||||
|
|
||||||
_, err := d.api.SendMessage(params)
|
_, err := d.api.SendMessage(params)
|
||||||
if err == nil {
|
if err == nil {
|
||||||
d.Clear()
|
d.Delete()
|
||||||
delete(d.provider.drafts, d.ID)
|
|
||||||
}
|
}
|
||||||
return err
|
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,
|
||||||
|
Text: d.Message,
|
||||||
|
ParseMode: d.parseMode,
|
||||||
|
Entities: d.entities,
|
||||||
|
}
|
||||||
|
if d.messageThreadID > 0 {
|
||||||
|
params.MessageThreadID = d.messageThreadID
|
||||||
|
}
|
||||||
|
_, err := d.api.SendMessageDraft(params)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|||||||
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.13
|
||||||
|
|
||||||
|
replace (
|
||||||
|
git.nix13.pw/scuroneko/laniakea v1.0.0-beta.13 => ../../
|
||||||
|
)
|
||||||
|
|
||||||
|
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 (
|
require (
|
||||||
git.nix13.pw/scuroneko/extypes v1.2.1
|
git.nix13.pw/scuroneko/extypes v1.2.1
|
||||||
git.nix13.pw/scuroneko/slog v1.0.2
|
git.nix13.pw/scuroneko/slog v1.0.2
|
||||||
github.com/alitto/pond/v2 v2.6.2
|
github.com/alitto/pond/v2 v2.7.0
|
||||||
golang.org/x/time v0.14.0
|
golang.org/x/time v0.15.0
|
||||||
)
|
)
|
||||||
|
|
||||||
require (
|
require (
|
||||||
github.com/fatih/color v1.18.0 // indirect
|
github.com/fatih/color v1.18.0 // indirect
|
||||||
github.com/mattn/go-colorable v0.1.14 // indirect
|
github.com/mattn/go-colorable v0.1.14 // indirect
|
||||||
github.com/mattn/go-isatty v0.0.20 // 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/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 h1:vZyUROygxC2d5FJHUQM/30xFEHY1JT/aweDZXA4rm2g=
|
||||||
git.nix13.pw/scuroneko/slog v1.0.2/go.mod h1:3Qm2wzkR5KjwOponMfG7TcGSDjmYaFqRAmLvSPTuWJI=
|
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.7.0 h1:c76L+yN916m/DRXjGCeUBHHu92uWnh/g1bwVk4zyyXg=
|
||||||
github.com/alitto/pond/v2 v2.6.2/go.mod h1:xkjYEgQ05RSpWdfSd1nM3OVv7TBhLdy7rMp3+2Nq+yE=
|
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 h1:S8gINlzdQ840/4pfAwic/ZE0djQEH3wM94VfqLTZcOM=
|
||||||
github.com/fatih/color v1.18.0/go.mod h1:4FelSpRwEGDpQ12mAdzqdOukCy4u8WUtOY6lkT/6HfU=
|
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 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 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
|
||||||
github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
|
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.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
golang.org/x/sys v0.41.0 h1:Ivj+2Cp/ylzLiEU89QhWblYnOE9zerudt9Ftecq2C6k=
|
golang.org/x/sys v0.42.0 h1:omrd2nAlyT5ESRdCLYdm3+fMfNFE/+Rf4bDIQImRJeo=
|
||||||
golang.org/x/sys v0.41.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
|
golang.org/x/sys v0.42.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
|
||||||
golang.org/x/time v0.14.0 h1:MRx4UaLrDotUKUdCIqzPC48t1Y9hANFKIRpNx+Te8PI=
|
golang.org/x/time v0.15.0 h1:bbrp8t3bGUeFOx08pvsMYRTCVSMk89u4tKbNOZbp88U=
|
||||||
golang.org/x/time v0.14.0/go.mod h1:eL/Oa2bBBK0TkX57Fyni+NgnyQQN4LitPmob2Hjnqw4=
|
golang.org/x/time v0.15.0/go.mod h1:Y4YMaQmXwGQZoFaVFk4YpCt4FLQMYKZe9oeV/f4MSno=
|
||||||
|
|||||||
127
keyboard.go
127
keyboard.go
@@ -1,3 +1,13 @@
|
|||||||
|
// 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
|
package laniakea
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -8,12 +18,26 @@ import (
|
|||||||
"git.nix13.pw/scuroneko/laniakea/tgapi"
|
"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 (
|
const (
|
||||||
ButtonStyleDanger tgapi.KeyboardButtonStyle = "danger"
|
ButtonStyleDanger tgapi.KeyboardButtonStyle = "danger"
|
||||||
ButtonStyleSuccess tgapi.KeyboardButtonStyle = "success"
|
ButtonStyleSuccess tgapi.KeyboardButtonStyle = "success"
|
||||||
ButtonStylePrimary tgapi.KeyboardButtonStyle = "primary"
|
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
|
||||||
|
// - SetCallbackData() — 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 {
|
type InlineKbButtonBuilder struct {
|
||||||
text string
|
text string
|
||||||
iconCustomEmojiID string
|
iconCustomEmojiID string
|
||||||
@@ -22,26 +46,48 @@ type InlineKbButtonBuilder struct {
|
|||||||
callbackData string
|
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 {
|
func NewInlineKbButton(text string) InlineKbButtonBuilder {
|
||||||
return InlineKbButtonBuilder{text: text}
|
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 {
|
func (b InlineKbButtonBuilder) SetIconCustomEmojiId(id string) InlineKbButtonBuilder {
|
||||||
b.iconCustomEmojiID = id
|
b.iconCustomEmojiID = id
|
||||||
return b
|
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 {
|
func (b InlineKbButtonBuilder) SetStyle(style tgapi.KeyboardButtonStyle) InlineKbButtonBuilder {
|
||||||
b.style = style
|
b.style = style
|
||||||
return b
|
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 {
|
func (b InlineKbButtonBuilder) SetUrl(url string) InlineKbButtonBuilder {
|
||||||
b.url = url
|
b.url = url
|
||||||
return b
|
return b
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetCallbackData 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: SetCallbackData("delete_user", 123, "confirm") → {"cmd":"delete_user","args":["123","confirm"]}
|
||||||
func (b InlineKbButtonBuilder) SetCallbackData(cmd string, args ...any) InlineKbButtonBuilder {
|
func (b InlineKbButtonBuilder) SetCallbackData(cmd string, args ...any) InlineKbButtonBuilder {
|
||||||
b.callbackData = NewCallbackData(cmd, args...).ToJson()
|
b.callbackData = NewCallbackData(cmd, args...).ToJson()
|
||||||
return b
|
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 {
|
func (b InlineKbButtonBuilder) build() tgapi.InlineKeyboardButton {
|
||||||
return tgapi.InlineKeyboardButton{
|
return tgapi.InlineKeyboardButton{
|
||||||
Text: b.text,
|
Text: b.text,
|
||||||
@@ -52,12 +98,22 @@ 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 {
|
type InlineKeyboard struct {
|
||||||
CurrentLine extypes.Slice[tgapi.InlineKeyboardButton]
|
CurrentLine extypes.Slice[tgapi.InlineKeyboardButton] // Current row being built
|
||||||
Lines [][]tgapi.InlineKeyboardButton
|
Lines [][]tgapi.InlineKeyboardButton // Completed rows
|
||||||
maxRow int
|
maxRow int // Max buttons per row (e.g., 3 or 4)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// 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 {
|
func NewInlineKeyboard(maxRow int) *InlineKeyboard {
|
||||||
return &InlineKeyboard{
|
return &InlineKeyboard{
|
||||||
CurrentLine: make(extypes.Slice[tgapi.InlineKeyboardButton], 0),
|
CurrentLine: make(extypes.Slice[tgapi.InlineKeyboardButton], 0),
|
||||||
@@ -66,6 +122,8 @@ func NewInlineKeyboard(maxRow int) *InlineKeyboard {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// 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 {
|
func (in *InlineKeyboard) append(button tgapi.InlineKeyboardButton) *InlineKeyboard {
|
||||||
if in.CurrentLine.Len() == in.maxRow {
|
if in.CurrentLine.Len() == in.maxRow {
|
||||||
in.AddLine()
|
in.AddLine()
|
||||||
@@ -74,27 +132,45 @@ func (in *InlineKeyboard) append(button tgapi.InlineKeyboardButton) *InlineKeybo
|
|||||||
return in
|
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 {
|
func (in *InlineKeyboard) AddUrlButton(text, url string) *InlineKeyboard {
|
||||||
return in.append(tgapi.InlineKeyboardButton{Text: text, URL: url})
|
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 {
|
func (in *InlineKeyboard) AddUrlButtonStyle(text string, style tgapi.KeyboardButtonStyle, url string) *InlineKeyboard {
|
||||||
return in.append(tgapi.InlineKeyboardButton{Text: text, Style: style, URL: url})
|
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 as JSON using NewCallbackData.
|
||||||
func (in *InlineKeyboard) AddCallbackButton(text string, cmd string, args ...any) *InlineKeyboard {
|
func (in *InlineKeyboard) AddCallbackButton(text string, cmd string, args ...any) *InlineKeyboard {
|
||||||
return in.append(tgapi.InlineKeyboardButton{
|
return in.append(tgapi.InlineKeyboardButton{
|
||||||
Text: text, CallbackData: NewCallbackData(cmd, args...).ToJson(),
|
Text: text,
|
||||||
})
|
|
||||||
}
|
|
||||||
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(),
|
CallbackData: NewCallbackData(cmd, args...).ToJson(),
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// 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(),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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 {
|
func (in *InlineKeyboard) AddButton(b InlineKbButtonBuilder) *InlineKeyboard {
|
||||||
return in.append(b.build())
|
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 {
|
func (in *InlineKeyboard) AddLine() *InlineKeyboard {
|
||||||
if in.CurrentLine.Len() == 0 {
|
if in.CurrentLine.Len() == 0 {
|
||||||
return in
|
return in
|
||||||
@@ -103,6 +179,11 @@ func (in *InlineKeyboard) AddLine() *InlineKeyboard {
|
|||||||
in.CurrentLine = make(extypes.Slice[tgapi.InlineKeyboardButton], 0)
|
in.CurrentLine = make(extypes.Slice[tgapi.InlineKeyboardButton], 0)
|
||||||
return in
|
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 {
|
func (in *InlineKeyboard) Get() *tgapi.ReplyMarkup {
|
||||||
if in.CurrentLine.Len() > 0 {
|
if in.CurrentLine.Len() > 0 {
|
||||||
in.Lines = append(in.Lines, in.CurrentLine)
|
in.Lines = append(in.Lines, in.CurrentLine)
|
||||||
@@ -110,11 +191,26 @@ func (in *InlineKeyboard) Get() *tgapi.ReplyMarkup {
|
|||||||
return &tgapi.ReplyMarkup{InlineKeyboard: in.Lines}
|
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 {
|
type CallbackData struct {
|
||||||
Command string `json:"cmd"`
|
Command string `json:"cmd"` // The command name to route to
|
||||||
Args []string `json:"args"`
|
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 {
|
func NewCallbackData(command string, args ...any) *CallbackData {
|
||||||
stringArgs := make([]string, len(args))
|
stringArgs := make([]string, len(args))
|
||||||
for i, arg := range args {
|
for i, arg := range args {
|
||||||
@@ -125,9 +221,18 @@ func NewCallbackData(command string, args ...any) *CallbackData {
|
|||||||
Args: stringArgs,
|
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 {
|
func (d *CallbackData) ToJson() string {
|
||||||
data, err := json.Marshal(d)
|
data, err := json.Marshal(d)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
// Fallback: return minimal valid JSON to avoid Telegram API rejection
|
||||||
return `{"cmd":""}`
|
return `{"cmd":""}`
|
||||||
}
|
}
|
||||||
return string(data)
|
return string(data)
|
||||||
|
|||||||
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
|
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
|
type DictEntry map[string]string
|
||||||
|
|
||||||
|
// L10n is a localization manager that maps keys to language-specific strings.
|
||||||
type L10n struct {
|
type L10n struct {
|
||||||
entries map[string]DictEntry
|
entries map[string]DictEntry // Map of translation keys to language dictionaries
|
||||||
fallbackLang string
|
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 {
|
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 {
|
func (l *L10n) AddDictEntry(key string, value DictEntry) *L10n {
|
||||||
l.entries[key] = value
|
l.entries[key] = value
|
||||||
return l
|
return l
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// GetFallbackLanguage returns the currently configured fallback language code.
|
||||||
func (l *L10n) GetFallbackLanguage() string {
|
func (l *L10n) GetFallbackLanguage() string {
|
||||||
return l.fallbackLang
|
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 {
|
func (l *L10n) Translate(lang, key string) string {
|
||||||
s, ok := l.entries[key]
|
entries, exists := l.entries[key]
|
||||||
if !ok {
|
if !exists {
|
||||||
return key
|
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
|
||||||
}
|
}
|
||||||
|
|||||||
269
msg_context.go
269
msg_context.go
@@ -1,3 +1,22 @@
|
|||||||
|
// 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
|
package laniakea
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -5,13 +24,14 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
|
|
||||||
"git.nix13.pw/scuroneko/laniakea/tgapi"
|
"git.nix13.pw/scuroneko/laniakea/tgapi"
|
||||||
"git.nix13.pw/scuroneko/laniakea/utils"
|
|
||||||
"git.nix13.pw/scuroneko/slog"
|
"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 {
|
type MsgContext struct {
|
||||||
Api *tgapi.API
|
Api *tgapi.API
|
||||||
|
|
||||||
Msg *tgapi.Message
|
Msg *tgapi.Message
|
||||||
Update tgapi.Update
|
Update tgapi.Update
|
||||||
From *tgapi.User
|
From *tgapi.User
|
||||||
@@ -28,19 +48,23 @@ type MsgContext struct {
|
|||||||
draftProvider *DraftProvider
|
draftProvider *DraftProvider
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// AnswerMessage represents a message sent or edited via MsgContext.
|
||||||
|
// It holds metadata to allow further editing or deletion.
|
||||||
type AnswerMessage struct {
|
type AnswerMessage struct {
|
||||||
MessageID int
|
MessageID int
|
||||||
Text string
|
Text string
|
||||||
IsMedia bool
|
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{
|
params := tgapi.EditMessageTextP{
|
||||||
MessageID: messageId,
|
MessageID: messageId,
|
||||||
ChatID: ctx.Msg.Chat.ID,
|
ChatID: ctx.Msg.Chat.ID,
|
||||||
Text: text,
|
Text: text,
|
||||||
ParseMode: tgapi.ParseMD,
|
ParseMode: parseMode,
|
||||||
}
|
}
|
||||||
if keyboard != nil {
|
if keyboard != nil {
|
||||||
params.ReplyMarkup = keyboard.Get()
|
params.ReplyMarkup = keyboard.Get()
|
||||||
@@ -54,27 +78,67 @@ func (ctx *MsgContext) edit(messageId int, text string, keyboard *InlineKeyboard
|
|||||||
MessageID: msg.MessageID, ctx: ctx, Text: text, IsMedia: false,
|
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 {
|
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 {
|
if ctx.CallbackMsgId == 0 {
|
||||||
ctx.botLogger.Errorln("Can't edit non-callback update message")
|
ctx.botLogger.Errorln("Can't edit non-callback update message")
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
return ctx.edit(ctx.CallbackMsgId, text, keyboard, parseMode)
|
||||||
return ctx.edit(ctx.CallbackMsgId, text, keyboard)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// 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 {
|
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{
|
params := tgapi.EditMessageCaptionP{
|
||||||
ChatID: ctx.Msg.Chat.ID,
|
ChatID: ctx.Msg.Chat.ID,
|
||||||
MessageID: messageId,
|
MessageID: messageId,
|
||||||
Caption: text,
|
Caption: text,
|
||||||
ParseMode: tgapi.ParseMD,
|
ParseMode: parseMode,
|
||||||
}
|
}
|
||||||
if kb != nil {
|
if kb != nil {
|
||||||
params.ReplyMarkup = kb.Get()
|
params.ReplyMarkup = kb.Get()
|
||||||
@@ -88,22 +152,38 @@ func (ctx *MsgContext) editPhotoText(messageId int, text string, kb *InlineKeybo
|
|||||||
MessageID: msg.MessageID, ctx: ctx, Text: text, IsMedia: true,
|
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 {
|
func (m *AnswerMessage) EditCaption(text string) *AnswerMessage {
|
||||||
if m.MessageID == 0 {
|
return m.ctx.editPhotoText(m.MessageID, text, nil, tgapi.ParseNone)
|
||||||
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)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
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{
|
params := tgapi.SendMessageP{
|
||||||
ChatID: ctx.Msg.Chat.ID,
|
ChatID: ctx.Msg.Chat.ID,
|
||||||
Text: text,
|
Text: text,
|
||||||
ParseMode: tgapi.ParseMDV2,
|
ParseMode: parseMode,
|
||||||
}
|
}
|
||||||
if keyboard != nil {
|
if keyboard != nil {
|
||||||
params.ReplyMarkup = keyboard.Get()
|
params.ReplyMarkup = keyboard.Get()
|
||||||
@@ -129,21 +209,49 @@ func (ctx *MsgContext) answer(text string, keyboard *InlineKeyboard) *AnswerMess
|
|||||||
MessageID: msg.MessageID, ctx: ctx, IsMedia: false, Text: text,
|
MessageID: msg.MessageID, ctx: ctx, IsMedia: false, Text: text,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Answer sends a plain text message (ParseNone).
|
||||||
func (ctx *MsgContext) Answer(text string) *AnswerMessage {
|
func (ctx *MsgContext) Answer(text string) *AnswerMessage {
|
||||||
return ctx.answer(text, nil)
|
return ctx.answer(text, nil, tgapi.ParseNone)
|
||||||
}
|
|
||||||
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)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
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{
|
params := tgapi.SendPhotoP{
|
||||||
ChatID: ctx.Msg.Chat.ID,
|
ChatID: ctx.Msg.Chat.ID,
|
||||||
Caption: text,
|
Caption: text,
|
||||||
ParseMode: tgapi.ParseMD,
|
ParseMode: parseMode,
|
||||||
Photo: photoId,
|
Photo: photoId,
|
||||||
}
|
}
|
||||||
if kb != nil {
|
if kb != nil {
|
||||||
@@ -156,21 +264,50 @@ func (ctx *MsgContext) answerPhoto(photoId, text string, kb *InlineKeyboard) *An
|
|||||||
msg, err := ctx.Api.SendPhoto(params)
|
msg, err := ctx.Api.SendPhoto(params)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
ctx.botLogger.Errorln(err)
|
ctx.botLogger.Errorln(err)
|
||||||
return &AnswerMessage{
|
return nil
|
||||||
ctx: ctx, Text: text, IsMedia: true,
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
return &AnswerMessage{
|
return &AnswerMessage{
|
||||||
MessageID: msg.MessageID, ctx: ctx, Text: text, IsMedia: true,
|
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 {
|
func (ctx *MsgContext) AnswerPhoto(photoId, text string) *AnswerMessage {
|
||||||
return ctx.answerPhoto(photoId, text, nil)
|
return ctx.answerPhoto(photoId, text, nil, tgapi.ParseNone)
|
||||||
}
|
|
||||||
func (ctx *MsgContext) AnswerPhotoKeyboard(photoId, text string, kb *InlineKeyboard) *AnswerMessage {
|
|
||||||
return ctx.answerPhoto(photoId, text, kb)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// 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) {
|
func (ctx *MsgContext) delete(messageId int) {
|
||||||
_, err := ctx.Api.DeleteMessage(tgapi.DeleteMessageP{
|
_, err := ctx.Api.DeleteMessage(tgapi.DeleteMessageP{
|
||||||
ChatID: ctx.Msg.Chat.ID,
|
ChatID: ctx.Msg.Chat.ID,
|
||||||
@@ -180,9 +317,15 @@ func (ctx *MsgContext) delete(messageId int) {
|
|||||||
ctx.botLogger.Errorln(err)
|
ctx.botLogger.Errorln(err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
func (m *AnswerMessage) Delete() { m.ctx.delete(m.MessageID) }
|
|
||||||
|
// 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) }
|
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) {
|
func (ctx *MsgContext) answerCallbackQuery(url, text string, showAlert bool) {
|
||||||
if len(ctx.CallbackQueryId) == 0 {
|
if len(ctx.CallbackQueryId) == 0 {
|
||||||
return
|
return
|
||||||
@@ -195,11 +338,20 @@ func (ctx *MsgContext) answerCallbackQuery(url, text string, showAlert bool) {
|
|||||||
ctx.botLogger.Errorln(err)
|
ctx.botLogger.Errorln(err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
func (ctx *MsgContext) AnswerCbQuery() { ctx.answerCallbackQuery("", "", false) }
|
|
||||||
func (ctx *MsgContext) AnswerCbQueryText(text string) { ctx.answerCallbackQuery("", text, false) }
|
|
||||||
func (ctx *MsgContext) AnswerCbQueryAlert(text string) { ctx.answerCallbackQuery("", text, true) }
|
|
||||||
func (ctx *MsgContext) AnswerCbQueryUrl(u string) { ctx.answerCallbackQuery(u, "", false) }
|
|
||||||
|
|
||||||
|
// 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) {
|
func (ctx *MsgContext) SendAction(action tgapi.ChatActionType) {
|
||||||
params := tgapi.SendChatActionP{
|
params := tgapi.SendChatActionP{
|
||||||
ChatID: ctx.Msg.Chat.ID, Action: action,
|
ChatID: ctx.Msg.Chat.ID, Action: action,
|
||||||
@@ -213,30 +365,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) {
|
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 != "" {
|
if ctx.CallbackQueryId != "" {
|
||||||
ctx.answerCallbackQuery("", text, false)
|
ctx.answerCallbackQuery("", text, false)
|
||||||
} else {
|
} else {
|
||||||
ctx.answer(text, nil)
|
ctx.answer(text, nil, tgapi.ParseNone)
|
||||||
}
|
}
|
||||||
ctx.botLogger.Errorln(err)
|
ctx.botLogger.Errorln(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Error is an alias for error().
|
||||||
func (ctx *MsgContext) Error(err error) { ctx.error(err) }
|
func (ctx *MsgContext) Error(err error) { ctx.error(err) }
|
||||||
|
|
||||||
func (ctx *MsgContext) NewDraft() *Draft {
|
func (ctx *MsgContext) newDraft(parseMode tgapi.ParseMode) *Draft {
|
||||||
c := context.Background()
|
c := context.Background()
|
||||||
if err := ctx.Api.Limiter.Wait(c, ctx.Msg.Chat.ID); err != nil {
|
if err := ctx.Api.Limiter.Wait(c, ctx.Msg.Chat.ID); err != nil {
|
||||||
ctx.botLogger.Errorln(err)
|
ctx.botLogger.Errorln(err)
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
draft := ctx.draftProvider.NewDraft()
|
draft := ctx.draftProvider.NewDraft(parseMode).SetChat(ctx.Msg.Chat.ID, ctx.Msg.MessageThreadID)
|
||||||
draft.chatID = ctx.Msg.Chat.ID
|
|
||||||
draft.messageThreadID = ctx.Msg.MessageThreadID
|
|
||||||
return draft
|
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 {
|
func (ctx *MsgContext) Translate(key string) string {
|
||||||
if ctx.From == nil {
|
if ctx.From == nil {
|
||||||
return key
|
return key
|
||||||
|
|||||||
227
plugins.go
227
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
|
package laniakea
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -7,83 +19,122 @@ import (
|
|||||||
"git.nix13.pw/scuroneko/extypes"
|
"git.nix13.pw/scuroneko/extypes"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
// CommandValueType defines the expected type of a command argument.
|
||||||
CommandValueStringType CommandValueType = "string"
|
|
||||||
CommandValueIntType CommandValueType = "int"
|
|
||||||
CommandValueBoolType CommandValueType = "bool"
|
|
||||||
CommandValueAnyType CommandValueType = "any"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
CommandRegexInt = regexp.MustCompile("\\d+")
|
|
||||||
CommandRegexString = regexp.MustCompile(".+")
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
ErrCmdArgCountMismatch = errors.New("command arg count mismatch")
|
|
||||||
ErrCmdArgRegexpMismatch = errors.New("command arg regexp mismatch")
|
|
||||||
)
|
|
||||||
|
|
||||||
type CommandValueType string
|
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"
|
||||||
|
)
|
||||||
|
|
||||||
|
// CommandRegexInt matches one or more digits.
|
||||||
|
var CommandRegexInt = regexp.MustCompile(`\d+`)
|
||||||
|
|
||||||
|
// CommandRegexString matches any non-empty string.
|
||||||
|
var CommandRegexString = regexp.MustCompile(".+")
|
||||||
|
|
||||||
|
// 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 {
|
type CommandArg struct {
|
||||||
valueType CommandValueType
|
valueType CommandValueType // Type of expected value
|
||||||
text string
|
text string // Human-readable description (not used in validation)
|
||||||
regex *regexp.Regexp
|
regex *regexp.Regexp // Regex used to validate input
|
||||||
required bool
|
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 {
|
func NewCommandArg(text string, valueType CommandValueType) *CommandArg {
|
||||||
regex := CommandRegexString
|
regex := CommandRegexString
|
||||||
switch valueType {
|
switch valueType {
|
||||||
case CommandValueIntType:
|
case CommandValueIntType:
|
||||||
regex = CommandRegexInt
|
regex = CommandRegexInt
|
||||||
|
case CommandValueAnyType:
|
||||||
|
regex = nil // Skip validation
|
||||||
}
|
}
|
||||||
return &CommandArg{valueType, text, regex, false}
|
return &CommandArg{valueType, text, regex, false}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetRequired marks this argument as required.
|
||||||
|
// Returns the receiver for method chaining.
|
||||||
func (c *CommandArg) SetRequired() *CommandArg {
|
func (c *CommandArg) SetRequired() *CommandArg {
|
||||||
c.required = true
|
c.required = true
|
||||||
return c
|
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)
|
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 {
|
type Command[T DbContext] struct {
|
||||||
command string
|
command string // The command trigger (e.g., "/start")
|
||||||
description string
|
description string // Human-readable description for help
|
||||||
exec CommandExecutor[T]
|
exec CommandExecutor[T] // Function to execute when command is triggered
|
||||||
args extypes.Slice[CommandArg]
|
args extypes.Slice[CommandArg] // List of expected arguments
|
||||||
middlewares extypes.Slice[Middleware[T]]
|
middlewares extypes.Slice[Middleware[T]] // Optional middleware chain
|
||||||
skipAutoCmd bool
|
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] {
|
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}
|
return &Command[T]{command, "", exec, extypes.Slice[CommandArg](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] {
|
func (c *Command[T]) Use(m Middleware[T]) *Command[T] {
|
||||||
c.middlewares = c.middlewares.Push(m)
|
c.middlewares = c.middlewares.Push(m)
|
||||||
return c
|
return c
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetDescription sets the human-readable description of the command.
|
||||||
func (c *Command[T]) SetDescription(desc string) *Command[T] {
|
func (c *Command[T]) SetDescription(desc string) *Command[T] {
|
||||||
c.description = desc
|
c.description = desc
|
||||||
return c
|
return c
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SkipCommandAutoGen marks this command to be excluded from auto-generated help menus.
|
||||||
func (c *Command[T]) SkipCommandAutoGen() *Command[T] {
|
func (c *Command[T]) SkipCommandAutoGen() *Command[T] {
|
||||||
c.skipAutoCmd = true
|
c.skipAutoCmd = true
|
||||||
return c
|
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 {
|
func (c *Command[T]) validateArgs(args []string) error {
|
||||||
cmdArgs := c.args.Filter(func(e CommandArg) bool { return !e.required })
|
// Count required args
|
||||||
if len(args) < cmdArgs.Len() {
|
requiredCount := c.args.Filter(func(a CommandArg) bool { return a.required }).Len()
|
||||||
|
if len(args) < requiredCount {
|
||||||
return ErrCmdArgCountMismatch
|
return ErrCmdArgCountMismatch
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Validate each argument against its regex
|
||||||
for i, arg := range args {
|
for i, arg := range args {
|
||||||
if i >= c.args.Len() {
|
if i >= c.args.Len() {
|
||||||
|
// Extra arguments beyond defined args are ignored
|
||||||
break
|
break
|
||||||
}
|
}
|
||||||
cmdArg := c.args.Get(i)
|
cmdArg := c.args.Get(i)
|
||||||
if cmdArg.regex == nil {
|
if cmdArg.regex == nil {
|
||||||
continue
|
continue // Skip validation for CommandValueAnyType
|
||||||
}
|
}
|
||||||
if !cmdArg.regex.MatchString(arg) {
|
if !cmdArg.regex.MatchString(arg) {
|
||||||
return ErrCmdArgRegexpMismatch
|
return ErrCmdArgRegexpMismatch
|
||||||
@@ -92,57 +143,122 @@ func (c *Command[T]) validateArgs(args []string) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Plugin represents a collection of commands and payloads (e.g., callback handlers),
|
||||||
|
// with shared middleware and configuration.
|
||||||
type Plugin[T DbContext] struct {
|
type Plugin[T DbContext] struct {
|
||||||
name string
|
name string // Name of the plugin (e.g., "admin", "user")
|
||||||
commands map[string]Command[T]
|
commands map[string]Command[T] // Registered commands (triggered by message)
|
||||||
payloads map[string]Command[T]
|
payloads map[string]Command[T] // Registered payloads (triggered by callback data)
|
||||||
middlewares extypes.Slice[Middleware[T]]
|
middlewares extypes.Slice[Middleware[T]] // Shared middlewares for all commands/payloads
|
||||||
skipAutoCmd bool
|
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] {
|
func NewPlugin[T DbContext](name string) *Plugin[T] {
|
||||||
return &Plugin[T]{
|
return &Plugin[T]{
|
||||||
name, map[string]Command[T]{},
|
name, make(map[string]Command[T]),
|
||||||
map[string]Command[T]{}, extypes.Slice[Middleware[T]]{}, false,
|
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] {
|
func (p *Plugin[T]) AddCommand(command *Command[T]) *Plugin[T] {
|
||||||
p.commands[command.command] = *command
|
p.commands[command.command] = *command
|
||||||
return p
|
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] {
|
func (p *Plugin[T]) NewCommand(exec CommandExecutor[T], command string, args ...CommandArg) *Command[T] {
|
||||||
return NewCommand(exec, command, args...)
|
cmd := NewCommand(exec, command, args...)
|
||||||
|
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] {
|
func (p *Plugin[T]) AddPayload(command *Command[T]) *Plugin[T] {
|
||||||
p.payloads[command.command] = *command
|
p.payloads[command.command] = *command
|
||||||
return p
|
return p
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// 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] {
|
func (p *Plugin[T]) AddMiddleware(middleware Middleware[T]) *Plugin[T] {
|
||||||
p.middlewares = p.middlewares.Push(middleware)
|
p.middlewares = p.middlewares.Push(middleware)
|
||||||
return p
|
return p
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SkipCommandAutoGen marks the entire plugin to be excluded from auto-generated help menus.
|
||||||
func (p *Plugin[T]) SkipCommandAutoGen() *Plugin[T] {
|
func (p *Plugin[T]) SkipCommandAutoGen() *Plugin[T] {
|
||||||
p.skipAutoCmd = true
|
p.skipAutoCmd = true
|
||||||
return p
|
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) {
|
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 {
|
if err := command.validateArgs(ctx.Args); err != nil {
|
||||||
ctx.error(err)
|
ctx.error(err)
|
||||||
return
|
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)
|
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) {
|
func (p *Plugin[T]) executePayload(payload string, ctx *MsgContext, dbContext *T) {
|
||||||
pl := p.payloads[payload]
|
command, exists := p.payloads[payload]
|
||||||
if err := pl.validateArgs(ctx.Args); err != nil {
|
if !exists {
|
||||||
|
ctx.error(errors.New("payload not found"))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := command.validateArgs(ctx.Args); err != nil {
|
||||||
ctx.error(err)
|
ctx.error(err)
|
||||||
return
|
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 {
|
func (p *Plugin[T]) executeMiddlewares(ctx *MsgContext, db *T) bool {
|
||||||
for _, m := range p.middlewares {
|
for _, m := range p.middlewares {
|
||||||
if !m.Execute(ctx, db) {
|
if !m.Execute(ctx, db) {
|
||||||
@@ -152,28 +268,41 @@ func (p *Plugin[T]) executeMiddlewares(ctx *MsgContext, db *T) bool {
|
|||||||
return true
|
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
|
type MiddlewareExecutor[T DbContext] func(ctx *MsgContext, db *T) bool
|
||||||
|
|
||||||
// Middleware
|
// Middleware represents a reusable execution interceptor.
|
||||||
// When async, returned value ignored
|
// Can be synchronous (blocking) or asynchronous (non-blocking).
|
||||||
type Middleware[T DbContext] struct {
|
type Middleware[T DbContext] struct {
|
||||||
name string
|
name string // Human-readable name for logging/debugging
|
||||||
executor MiddlewareExecutor[T]
|
executor MiddlewareExecutor[T] // Function to execute
|
||||||
order int
|
order int // Optional sort order (not used yet)
|
||||||
async bool
|
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] {
|
func NewMiddleware[T DbContext](name string, executor MiddlewareExecutor[T]) *Middleware[T] {
|
||||||
return &Middleware[T]{name, executor, 0, false}
|
return &Middleware[T]{name, executor, 0, false}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetOrder sets the execution order (currently ignored).
|
||||||
func (m *Middleware[T]) SetOrder(order int) *Middleware[T] {
|
func (m *Middleware[T]) SetOrder(order int) *Middleware[T] {
|
||||||
m.order = order
|
m.order = order
|
||||||
return m
|
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] {
|
func (m *Middleware[T]) SetAsync(async bool) *Middleware[T] {
|
||||||
m.async = async
|
m.async = async
|
||||||
return m
|
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 {
|
func (m *Middleware[T]) Execute(ctx *MsgContext, db *T) bool {
|
||||||
if m.async {
|
if m.async {
|
||||||
go m.executor(ctx, db)
|
go m.executor(ctx, db)
|
||||||
|
|||||||
137
runners.go
137
runners.go
@@ -1,58 +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
|
package laniakea
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"time"
|
"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
|
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 {
|
type Runner[T DbContext] struct {
|
||||||
name string
|
name string // Human-readable name for logging
|
||||||
onetime bool
|
onetime bool // If true, runs once; if false, runs periodically
|
||||||
async bool
|
async bool // If true, runs in a goroutine; else, runs synchronously
|
||||||
timeout time.Duration
|
timeout time.Duration // Duration to wait between periodic executions (ignored if onetime=true)
|
||||||
fn RunnerFn[T]
|
fn RunnerFn[T] // The function to execute
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewRunner creates a new Runner with async=true by default.
|
// NewRunner creates a new Runner with the given name and function.
|
||||||
// Builder methods (Onetime, Async, Timeout) modify the Runner in-place.
|
// 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().
|
// DO NOT call builder methods concurrently or after Execute().
|
||||||
func NewRunner[T DbContext](name string, fn RunnerFn[T]) *Runner[T] {
|
func NewRunner[T DbContext](name string, fn RunnerFn[T]) *Runner[T] {
|
||||||
return &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
|
// Onetime sets whether the runner executes once or repeatedly.
|
||||||
return b
|
// If true, the runner runs only once.
|
||||||
}
|
// If false, the runner runs in a loop with the configured timeout.
|
||||||
func (b *Runner[T]) Async(async bool) *Runner[T] {
|
func (r *Runner[T]) Onetime(onetime bool) *Runner[T] {
|
||||||
b.async = async
|
r.onetime = onetime
|
||||||
return b
|
return r
|
||||||
}
|
|
||||||
func (b *Runner[T]) Timeout(timeout time.Duration) *Runner[T] {
|
|
||||||
b.timeout = timeout
|
|
||||||
return b
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// 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() {
|
func (bot *Bot[T]) ExecRunners() {
|
||||||
bot.logger.Infoln("Executing runners...")
|
bot.logger.Infoln("Executing runners...")
|
||||||
for _, runner := range bot.runners {
|
for _, runner := range bot.runners {
|
||||||
|
// Validate configuration
|
||||||
if !runner.onetime && !runner.async {
|
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
|
continue
|
||||||
}
|
}
|
||||||
if !runner.onetime && runner.async && runner.timeout == (time.Second*0) {
|
if !runner.onetime && runner.async && runner.timeout == 0 {
|
||||||
bot.logger.Warnf("Background runner \"%s\" should have timeout", runner.name)
|
bot.logger.Warnf("Background runner \"%s\" has no timeout — may cause tight loop\n", runner.name)
|
||||||
}
|
}
|
||||||
|
|
||||||
if runner.async && runner.onetime {
|
if runner.onetime && runner.async {
|
||||||
go func() {
|
// One-time async: fire and forget
|
||||||
err := runner.fn(bot)
|
go func(r Runner[T]) {
|
||||||
|
err := r.fn(bot)
|
||||||
if err != nil {
|
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)
|
||||||
}
|
}
|
||||||
}()
|
}(runner)
|
||||||
} else if !runner.async && runner.onetime {
|
} else if runner.onetime && !runner.async {
|
||||||
|
// One-time sync: block until done
|
||||||
t := time.Now()
|
t := time.Now()
|
||||||
err := runner.fn(bot)
|
err := runner.fn(bot)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -60,18 +125,20 @@ func (bot *Bot[T]) ExecRunners() {
|
|||||||
}
|
}
|
||||||
elapsed := time.Since(t)
|
elapsed := time.Since(t)
|
||||||
if elapsed > time.Second*2 {
|
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 {
|
} else if !runner.onetime && runner.async {
|
||||||
go func() {
|
// Background loop: periodic execution
|
||||||
|
go func(r Runner[T]) {
|
||||||
for {
|
for {
|
||||||
err := runner.fn(bot)
|
err := r.fn(bot)
|
||||||
if err != nil {
|
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
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -224,7 +224,6 @@ func (r TelegramRequest[R, P]) doRequest(ctx context.Context, api *API) (R, erro
|
|||||||
}
|
}
|
||||||
|
|
||||||
api.logger.Debugln("REQ", url, string(data))
|
api.logger.Debugln("REQ", url, string(data))
|
||||||
|
|
||||||
resp, err := api.client.Do(req)
|
resp, err := api.client.Do(req)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return zero, fmt.Errorf("HTTP request failed: %w", err)
|
return zero, fmt.Errorf("HTTP request failed: %w", err)
|
||||||
|
|||||||
@@ -209,7 +209,9 @@ func (api *API) DeclineChatJoinRequest(params DeclineChatJoinRequestP) (bool, er
|
|||||||
|
|
||||||
func (api *API) SetChatPhoto() {
|
func (api *API) SetChatPhoto() {
|
||||||
uploader := NewUploader(api)
|
uploader := NewUploader(api)
|
||||||
defer uploader.Close()
|
defer func() {
|
||||||
|
_ = uploader.Close()
|
||||||
|
}()
|
||||||
}
|
}
|
||||||
|
|
||||||
type DeleteChatPhotoP struct {
|
type DeleteChatPhotoP struct {
|
||||||
|
|||||||
@@ -12,6 +12,7 @@ const (
|
|||||||
ParseMDV2 ParseMode = "MarkdownV2"
|
ParseMDV2 ParseMode = "MarkdownV2"
|
||||||
ParseHTML ParseMode = "HTML"
|
ParseHTML ParseMode = "HTML"
|
||||||
ParseMD ParseMode = "Markdown"
|
ParseMD ParseMode = "Markdown"
|
||||||
|
ParseNone ParseMode = "None"
|
||||||
)
|
)
|
||||||
|
|
||||||
type EmptyParams struct{}
|
type EmptyParams struct{}
|
||||||
@@ -57,6 +58,8 @@ func (api *API) GetFileByLink(link string) ([]byte, error) {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
defer res.Body.Close()
|
defer func() {
|
||||||
|
_ = res.Body.Close()
|
||||||
|
}()
|
||||||
return io.ReadAll(res.Body)
|
return io.ReadAll(res.Body)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -261,20 +261,20 @@ type Gifts struct {
|
|||||||
Gifts []Gift `json:"gifts"`
|
Gifts []Gift `json:"gifts"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type OwnedGiftType string
|
||||||
|
|
||||||
const (
|
const (
|
||||||
OwnedGiftRegularType OwnedGiftType = "regular"
|
OwnedGiftRegularType OwnedGiftType = "regular"
|
||||||
OwnedGiftUniqueType OwnedGiftType = "unique"
|
OwnedGiftUniqueType OwnedGiftType = "unique"
|
||||||
)
|
)
|
||||||
|
|
||||||
type OwnedGiftType string
|
type OwnedGift struct {
|
||||||
type BaseOwnedGift struct {
|
|
||||||
Type OwnedGiftType `json:"type"`
|
Type OwnedGiftType `json:"type"`
|
||||||
OwnerGiftID *string `json:"owner_gift_id,omitempty"`
|
OwnerGiftID *string `json:"owner_gift_id,omitempty"`
|
||||||
SendDate *int `json:"send_date,omitempty"`
|
SendDate *int `json:"send_date,omitempty"`
|
||||||
IsSaved *bool `json:"is_saved,omitempty"`
|
IsSaved *bool `json:"is_saved,omitempty"`
|
||||||
}
|
|
||||||
type OwnedGiftRegular struct {
|
// Поля, характерные для "regular"
|
||||||
BaseOwnedGift
|
|
||||||
Gift Gift `json:"gift"`
|
Gift Gift `json:"gift"`
|
||||||
SenderUser User `json:"sender_user,omitempty"`
|
SenderUser User `json:"sender_user,omitempty"`
|
||||||
Text string `json:"text,omitempty"`
|
Text string `json:"text,omitempty"`
|
||||||
@@ -286,18 +286,15 @@ type OwnedGiftRegular struct {
|
|||||||
PrepaidUpgradeStarCount *int `json:"prepaid_upgrade_star_count,omitempty"`
|
PrepaidUpgradeStarCount *int `json:"prepaid_upgrade_star_count,omitempty"`
|
||||||
IsUpgradeSeparate *bool `json:"is_upgrade_separate,omitempty"`
|
IsUpgradeSeparate *bool `json:"is_upgrade_separate,omitempty"`
|
||||||
UniqueGiftNumber *int `json:"unique_gift_number,omitempty"`
|
UniqueGiftNumber *int `json:"unique_gift_number,omitempty"`
|
||||||
}
|
|
||||||
type OwnedGiftUnique struct {
|
// Поля, характерные для "unique"
|
||||||
BaseOwnedGift
|
|
||||||
CanBeTransferred *bool `json:"can_be_transferred,omitempty"`
|
CanBeTransferred *bool `json:"can_be_transferred,omitempty"`
|
||||||
TransferStarCount *int `json:"transfer_star_count,omitempty"`
|
TransferStarCount *int `json:"transfer_star_count,omitempty"`
|
||||||
NextTransferDate *int `json:"next_transfer_date,omitempty"`
|
NextTransferDate *int `json:"next_transfer_date,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type OwnedGifts struct {
|
type OwnedGifts struct {
|
||||||
TotalCount int `json:"total_count"`
|
TotalCount int `json:"total_count"`
|
||||||
Gifts []struct {
|
Gifts []OwnedGift `json:"gifts"`
|
||||||
OwnedGiftRegular
|
NextOffset string `json:"next_offset"`
|
||||||
OwnedGiftUnique
|
|
||||||
} `json:"gifts"`
|
|
||||||
NextOffset string `json:"next_offset"`
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -113,6 +113,9 @@ func (r UploaderRequest[R, P]) doRequest(ctx context.Context, up *Uploader) (R,
|
|||||||
|
|
||||||
body, err := readBody(resp.Body)
|
body, err := readBody(resp.Body)
|
||||||
_ = resp.Body.Close()
|
_ = resp.Body.Close()
|
||||||
|
if err != nil {
|
||||||
|
return zero, err
|
||||||
|
}
|
||||||
up.logger.Debugln("UPLOADER RES", r.method, string(body))
|
up.logger.Debugln("UPLOADER RES", r.method, string(body))
|
||||||
|
|
||||||
response, err := parseBody[R](body)
|
response, err := parseBody[R](body)
|
||||||
@@ -145,7 +148,7 @@ func (r UploaderRequest[R, P]) doRequest(ctx context.Context, up *Uploader) (R,
|
|||||||
func (r UploaderRequest[R, P]) DoWithContext(ctx context.Context, up *Uploader) (R, error) {
|
func (r UploaderRequest[R, P]) DoWithContext(ctx context.Context, up *Uploader) (R, error) {
|
||||||
var zero R
|
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)
|
return r.doRequest(ctx, up)
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -156,10 +159,10 @@ func (r UploaderRequest[R, P]) DoWithContext(ctx context.Context, up *Uploader)
|
|||||||
case <-ctx.Done():
|
case <-ctx.Done():
|
||||||
return zero, ctx.Err()
|
return zero, ctx.Err()
|
||||||
case res := <-result:
|
case res := <-result:
|
||||||
if res.Err != nil {
|
if res.err != nil {
|
||||||
return zero, res.Err
|
return zero, res.err
|
||||||
}
|
}
|
||||||
if val, ok := res.Value.(R); ok {
|
if val, ok := res.value.(R); ok {
|
||||||
return val, nil
|
return val, nil
|
||||||
}
|
}
|
||||||
return zero, ErrPoolUnexpected
|
return zero, ErrPoolUnexpected
|
||||||
|
|||||||
50
utils.go
50
utils.go
@@ -1,6 +1,10 @@
|
|||||||
package laniakea
|
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 Ptr[T any](v T) *T { return &v }
|
||||||
func Val[T any](p *T, def T) T {
|
func Val[T any](p *T, def T) T {
|
||||||
@@ -9,7 +13,45 @@ func Val[T any](p *T, def T) T {
|
|||||||
}
|
}
|
||||||
return def
|
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
|
||||||
|
)
|
||||||
|
|||||||
@@ -2,7 +2,6 @@ package utils
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"os"
|
"os"
|
||||||
"strings"
|
|
||||||
|
|
||||||
"git.nix13.pw/scuroneko/slog"
|
"git.nix13.pw/scuroneko/slog"
|
||||||
)
|
)
|
||||||
@@ -14,29 +13,3 @@ func GetLoggerLevel() slog.LogLevel {
|
|||||||
}
|
}
|
||||||
return level
|
return level
|
||||||
}
|
}
|
||||||
|
|
||||||
// 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
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,9 +1,9 @@
|
|||||||
package utils
|
package utils
|
||||||
|
|
||||||
const (
|
const (
|
||||||
VersionString = "1.0.0-beta.9"
|
VersionString = "1.0.0-beta.14"
|
||||||
VersionMajor = 1
|
VersionMajor = 1
|
||||||
VersionMinor = 0
|
VersionMinor = 0
|
||||||
VersionPatch = 0
|
VersionPatch = 0
|
||||||
Beta = 9
|
VersionBeta = 14
|
||||||
)
|
)
|
||||||
|
|||||||
Reference in New Issue
Block a user