REPOSITORY / ScuroNeko/Laniakea
Compare commits
Compare commits
121 Commits
v0.2.6
...
v1.0.0-rc.16
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
667fa3cc61
|
||
|
|
fc4386df75
|
||
|
|
a34734366d
|
||
|
|
3aee299869
|
||
|
|
b0882a46d5
|
||
|
|
7d4b150b0b | ||
|
|
e92a0d37f3 | ||
|
|
768dc859d7
|
||
|
|
d6da95394c
|
||
|
|
c9ec18ccea
|
||
|
|
aa18da73d5
|
||
|
|
2b64e8543f
|
||
|
|
83bcab6415
|
||
|
|
d55f58c092
|
||
|
|
ba25dab6b1
|
||
|
|
a818174fbf
|
||
|
|
140f3397b2
|
||
|
|
e2444752c2
|
||
|
|
66eb72cb3c
|
||
|
|
f74496a3e8
|
||
|
|
a4d70e1510
|
||
|
|
3ad9e48d71
|
||
|
|
4f8d583b03
|
||
|
|
68e7529f16
|
||
|
|
0ee0917af5
|
||
|
|
8618397bc1
|
||
|
|
945b8240e6
|
||
|
|
5d3199dc21
|
||
|
|
158625c220
|
||
|
|
7901fb659e
|
||
|
|
eda635e72c
|
||
|
|
f0da64c7af
|
||
|
|
3861746a3e
|
||
|
|
401173714e
|
||
|
|
7776acaf12
|
||
|
|
db31246eeb
|
||
|
|
d04c91342b
|
||
|
|
2e14d8b5df
|
||
|
|
6b9075c722
|
||
|
|
0b1a58a514
|
||
|
|
c59dd1fe8e
|
||
|
|
2fc171d9a3
|
||
|
|
4ebe76dd4a
|
||
|
|
1e043da05d
|
||
|
|
389ec9f9d7
|
||
|
|
fb81bb91bd
|
||
|
|
589e11b22d
|
||
|
|
5976fcd0b8
|
||
|
|
6ba8520bb7
|
||
|
|
e4203e8fc0
|
||
|
|
c179a3f5f0
|
||
|
|
d6e2daec04
|
||
|
|
3b6bb82e04
|
||
|
|
0574222608
|
||
|
|
b1b0cbdfbd
|
||
|
|
7e12e0a9f9
|
||
|
|
8b9a974da9
|
||
|
|
4dc172a3b5
|
||
|
|
f42d47af53
|
||
|
|
9895edf966
|
||
|
|
6cf3355a36
|
||
|
|
fa7a296a66
|
||
|
|
7101aba548 | ||
|
|
2de46a27c8 | ||
|
|
ae7426c36a | ||
|
|
61562e8a3b | ||
|
|
a84e24ff25
|
||
|
|
c0a26024f4
|
||
|
|
786da652e6
|
||
|
|
28ec2b7ca9
|
||
|
|
da122a3be4
|
||
|
|
1bf7499496
|
||
|
|
7b9292557e
|
||
|
|
466093e39b
|
||
|
|
0e0f8a0813
|
||
|
|
d84b0a1b55
|
||
|
|
434638a61d
|
||
|
|
c2909b4cfb
|
||
|
|
746847cf61
|
||
|
|
b2bda02c0f
|
||
|
|
bb51a0ecb1 | ||
|
|
4527dd661a
|
||
|
|
4129b8e688
|
||
|
|
12883f428e
|
||
|
|
f29ef979bf
|
||
|
|
9ef9a240a4
|
||
|
|
3912beefac
|
||
|
|
ece131c14a
|
||
|
|
6c989b2cc8
|
||
|
|
a5ca836fa4 | ||
|
|
f2e600e0a9 | ||
|
|
c4b827fb31
|
||
|
|
2a030aa0d8
|
||
|
|
f2d85b848f
|
||
|
|
7ac293dd38
|
||
|
|
ef78c5d9b4
|
||
|
|
a04375efbd
|
||
|
|
c1bdc2fdf6
|
||
|
|
83dca1ab39
|
||
|
|
2cc2f96f02
|
||
|
|
9d18bef97e
|
||
|
|
60f09e940a
|
||
|
|
7a6f135487
|
||
|
|
2e9e82d43b
|
||
|
|
55d4065259
|
||
|
|
b89f27574f | ||
|
|
689eb8a5e2 | ||
|
|
6fd482b58f | ||
|
|
913fa20e19 | ||
|
|
c71aad0c79 | ||
|
|
90e2f38c18 | ||
|
|
0921d306fd | ||
|
|
6970c37c6b | ||
|
|
1d636c40a6 | ||
|
|
95516480b0 | ||
|
|
9da4115fe7 | ||
|
|
f0483564f2 | ||
|
|
f1bb4b62c1 | ||
|
|
ce9952340f | ||
|
|
012854be41 | ||
|
|
eaa5dbaf10 |
@@ -0,0 +1,12 @@
|
|||||||
|
name: Golang lint
|
||||||
|
run-name: Linting code
|
||||||
|
on: [push]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
lint:
|
||||||
|
runs-on: go-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout repository code
|
||||||
|
uses: actions/checkout@v6
|
||||||
|
- name: Run golangci-lint
|
||||||
|
run: golangci-lint run
|
||||||
+5
-1
@@ -1,2 +1,6 @@
|
|||||||
.idea/
|
.idea/
|
||||||
test/
|
.wiki/
|
||||||
|
.vscode/
|
||||||
|
test/
|
||||||
|
.codex/
|
||||||
|
.codex
|
||||||
|
|||||||
@@ -0,0 +1,14 @@
|
|||||||
|
version: "2"
|
||||||
|
run:
|
||||||
|
timeout: 5m
|
||||||
|
linters:
|
||||||
|
disable-all: true
|
||||||
|
enable:
|
||||||
|
- errcheck
|
||||||
|
- govet
|
||||||
|
- ineffassign
|
||||||
|
- staticcheck
|
||||||
|
- unused
|
||||||
|
issues:
|
||||||
|
max-issues-per-linter: 0
|
||||||
|
max-same-issues: 0
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
repos:
|
||||||
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||||
|
rev: v6.0.0
|
||||||
|
hooks:
|
||||||
|
- id: trailing-whitespace
|
||||||
|
- id: end-of-file-fixer
|
||||||
|
- id: check-merge-conflict
|
||||||
|
- id: check-yaml
|
||||||
|
- id: check-json
|
||||||
|
- id: mixed-line-ending
|
||||||
|
args: ["--fix=lf"]
|
||||||
|
|
||||||
|
- repo: local
|
||||||
|
hooks:
|
||||||
|
- id: gofmt
|
||||||
|
name: gofmt
|
||||||
|
entry: gofmt -w
|
||||||
|
language: system
|
||||||
|
types: [go]
|
||||||
|
|
||||||
|
- id: go-vet
|
||||||
|
name: go vet
|
||||||
|
entry: go vet ./...
|
||||||
|
language: system
|
||||||
|
pass_filenames: false
|
||||||
|
types: [go]
|
||||||
|
|
||||||
|
- id: golangci-lint
|
||||||
|
name: golangci-lint
|
||||||
|
entry: golangci-lint run
|
||||||
|
language: system
|
||||||
|
pass_filenames: false
|
||||||
|
types: [go]
|
||||||
|
|
||||||
|
- id: go-test
|
||||||
|
name: go test
|
||||||
|
entry: go test ./...
|
||||||
|
language: system
|
||||||
|
pass_filenames: false
|
||||||
|
stages: [pre-push]
|
||||||
|
types: [go]
|
||||||
@@ -0,0 +1,165 @@
|
|||||||
|
# AGENTS.md
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
This repository uses Codex for full-project Go code review, not diff-only review.
|
||||||
|
|
||||||
|
When asked to review code, inspect the entire repository and use repository-wide context. Do not limit analysis to the latest commit, pull request diff, or recently changed files.
|
||||||
|
|
||||||
|
## Review priorities
|
||||||
|
Review the codebase with focus on:
|
||||||
|
- correctness and reliability;
|
||||||
|
- maintainability and architecture;
|
||||||
|
- idiomatic Go;
|
||||||
|
- testability;
|
||||||
|
- performance where justified by code evidence;
|
||||||
|
- security;
|
||||||
|
- godoc quality.
|
||||||
|
|
||||||
|
## Scope rules
|
||||||
|
- Always review the whole repository unless the prompt explicitly narrows scope.
|
||||||
|
- Check cross-package interactions, public APIs, package boundaries, and shared patterns.
|
||||||
|
- Prefer concrete fixes over generic advice.
|
||||||
|
- When feasible, make small, high-confidence improvements directly.
|
||||||
|
- When uncertain, state confidence level and evidence.
|
||||||
|
|
||||||
|
## Documentation languages
|
||||||
|
- When creating or expanding project documentation, generate and maintain both English and Russian versions in the same turn whenever reasonably possible.
|
||||||
|
- For wiki pages, prefer paired pages such as `Page.md` and `Page-RU.md`.
|
||||||
|
- Keep English and Russian pages aligned in structure, major examples, and user-facing guidance.
|
||||||
|
- If only one language can be updated safely in the current turn, explicitly say which language is lagging and why.
|
||||||
|
|
||||||
|
## Wiki and backlog workflow
|
||||||
|
- Treat the wiki as the primary place for large design ideas, architectural drafts, and framework backlog notes.
|
||||||
|
- If the agent identifies a substantial new concept or design direction, such as scenes, callback agents, a webhook model, or another framework-level abstraction, the agent must ask the user whether it should also formalize that idea as a draft wiki page.
|
||||||
|
- When the user agrees, prefer paired wiki pages such as `Page.md` and `Page-RU.md`, and clearly mark draft design pages with `DRAFT` when the API is not implemented or not yet stable.
|
||||||
|
- Keep `TODO.md`, the wiki backlog pages, and `CHANGELOG.md` aligned when framework-level items move between planned and completed states in the main repository.
|
||||||
|
- Wiki-only edits must never be added to `CHANGELOG.md`.
|
||||||
|
- `AGENTS.md`-only edits must never be added to `CHANGELOG.md`.
|
||||||
|
|
||||||
|
## Go review expectations
|
||||||
|
Check for:
|
||||||
|
- bugs, fragile logic, invalid assumptions, nil handling issues, resource leaks;
|
||||||
|
- poor error handling;
|
||||||
|
- misuse of context, cancellation, timeouts, retries, and cleanup;
|
||||||
|
- race risks, deadlocks, blocking hazards, unsafe shared state;
|
||||||
|
- non-idiomatic naming, APIs, interfaces, package structure, and error patterns;
|
||||||
|
- unnecessary complexity, duplication, or weak abstractions;
|
||||||
|
- obvious performance problems supported by the code;
|
||||||
|
- security risks such as unsafe input handling, secret leakage, insecure logging, injection risks, and risky file or network operations.
|
||||||
|
|
||||||
|
## Godoc rules
|
||||||
|
Review comments for all declarations.
|
||||||
|
|
||||||
|
### Exported declarations
|
||||||
|
Exported types, funcs, methods, vars, and consts must have godoc comments.
|
||||||
|
|
||||||
|
Each exported godoc comment must:
|
||||||
|
- start with the identifier name;
|
||||||
|
- explain the purpose or behavior;
|
||||||
|
- be as short as possible without losing important meaning;
|
||||||
|
- avoid repeating the signature mechanically;
|
||||||
|
- stay high-signal and informative.
|
||||||
|
|
||||||
|
### Unexported declarations
|
||||||
|
Unexported types, funcs, methods, vars, and consts should generally not have godoc-style comments unless there is a strong reason.
|
||||||
|
|
||||||
|
### Always report
|
||||||
|
- missing godoc on exported declarations;
|
||||||
|
- unnecessary godoc on unexported declarations;
|
||||||
|
- comments that are too long, vague, redundant, or low-value;
|
||||||
|
- comments that should be shortened or rewritten.
|
||||||
|
|
||||||
|
When feasible, rewrite bad godoc into better versions.
|
||||||
|
|
||||||
|
## Testing expectations
|
||||||
|
Treat tests as a required part of review.
|
||||||
|
|
||||||
|
- Assess existing test quality, not only test presence.
|
||||||
|
- Add or propose as many useful tests as reasonably possible.
|
||||||
|
- Prioritize public APIs, critical flows, edge cases, negative paths, boundary conditions, and concurrency-sensitive logic.
|
||||||
|
- Prefer table-driven tests where appropriate.
|
||||||
|
- Add regression tests for bugs you find.
|
||||||
|
- If a case is hard to test directly, explain the gap and the best test strategy.
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
Before finalizing changes, run the relevant project checks when available:
|
||||||
|
- build
|
||||||
|
- tests
|
||||||
|
- lint
|
||||||
|
- static analysis
|
||||||
|
|
||||||
|
Prefer the repository’s documented commands. If multiple choices exist, use the most standard and least destructive ones first.
|
||||||
|
|
||||||
|
## Versioning and changelog
|
||||||
|
- After every code or documentation change in the main repository, update `CHANGELOG.md`.
|
||||||
|
- Changes made only inside the `.wiki/` repository must not be added to `CHANGELOG.md`.
|
||||||
|
- Changes made only in `AGENTS.md` must not be added to `CHANGELOG.md`.
|
||||||
|
- Add changes only to the section for the next version after the latest published git tag.
|
||||||
|
- The agent must check the latest published tag, `CHANGELOG.md`, and `utils/version.go` before editing the changelog.
|
||||||
|
- The agent must verify that the target changelog version matches the version declared in `utils/version.go`.
|
||||||
|
- If the latest published tag is, for example, `v1.0.0`, and `CHANGELOG.md` does not yet contain the next version section, the agent must stop and ask the user which version the change belongs to:
|
||||||
|
1. `v1.0.1`
|
||||||
|
2. `v1.1.0`
|
||||||
|
3. `v2.0.0`
|
||||||
|
- The agent must not guess the next version when that section is missing.
|
||||||
|
- If the user-selected version does not match `utils/version.go`, the agent must warn about the mismatch and require the version file to be updated before proceeding.
|
||||||
|
- Changelog entries must describe all user-visible behavior changes made in the turn, including API additions, fixes, behavior changes, and breaking changes.
|
||||||
|
- When a framework backlog item recorded in `TODO.md` is completed, the agent must also update the backlog status using the existing format:
|
||||||
|
1. move the completed item into the top of the `Done` section;
|
||||||
|
2. replace the numbered backlog label with a version tag, for example `1. Scene Model` becomes `[v2.0.0] Scene Model`;
|
||||||
|
3. keep the item title and descriptive notes aligned with the corresponding `CHANGELOG.md` entry.
|
||||||
|
- The agent must treat `TODO.md` and `CHANGELOG.md` as linked records: a completed backlog item should not be left in one file as done and in the other as still pending or undocumented.
|
||||||
|
|
||||||
|
## Breaking changes policy
|
||||||
|
- The agent must detect potential breaking changes before editing public APIs.
|
||||||
|
- Breaking changes are forbidden unless the selected target version is a new major version.
|
||||||
|
- If the requested change is breaking and the user did not bump the major version, the agent must stop and warn that the change is not allowed under the current version.
|
||||||
|
- In that case, the agent must offer only these options:
|
||||||
|
1. do not make the breaking change;
|
||||||
|
2. introduce a backward-compatible alternative such as a new method, function, type, or struct, but only if that keeps the codebase reasonably small and clear;
|
||||||
|
3. bump the major version and then apply the breaking change.
|
||||||
|
- Prefer additive compatibility over signature changes when the additive option is small and maintainable.
|
||||||
|
- Example: if a method like `ctx.answer(...)` needs an extra parameter, the agent must either require a major-version bump or add a new method that keeps the old method working.
|
||||||
|
|
||||||
|
## Commit message format
|
||||||
|
- When the user asks for a commit message, the agent must produce it in this format:
|
||||||
|
1. one to four short lines;
|
||||||
|
2. each line must use the format `(<kind>): <text>`;
|
||||||
|
3. `<kind>` must be a short change type such as `fix`, `new`, `tests`, `doc`, `refactor`, or `ci/cd`;
|
||||||
|
4. `<text>` must be a concise 1-5 word description of the change or function;
|
||||||
|
5. each line must start on its own new line;
|
||||||
|
6. when multiple lines are present, kinds must be ordered from top to bottom by this priority: `new`, `fix`, `refactor`, `ci/cd`, `tests`, `doc`.
|
||||||
|
- The agent must output the commit message as a plain multiline block that the user can copy directly.
|
||||||
|
- Do not collapse the lines into a paragraph, bullet list, or wrapped prose explanation.
|
||||||
|
- Keep commit text concise and high-signal.
|
||||||
|
- Do not turn commit messages into changelogs.
|
||||||
|
|
||||||
|
## Commit signing
|
||||||
|
- All commits created by the agent must be GPG-signed.
|
||||||
|
- If commit signing or pushing requires leaving the sandbox, the agent must request escalation explicitly before running the command.
|
||||||
|
- If a signed commit cannot be created successfully, the agent must report the failure clearly and stop instead of creating an unsigned fallback commit.
|
||||||
|
|
||||||
|
## Output format
|
||||||
|
For repo-wide review tasks, structure the result as:
|
||||||
|
|
||||||
|
1. Overall summary
|
||||||
|
2. Critical findings
|
||||||
|
3. Major findings
|
||||||
|
4. Minor findings
|
||||||
|
5. Godoc issues
|
||||||
|
6. Test gaps and added/proposed tests
|
||||||
|
7. Good decisions worth keeping
|
||||||
|
8. Summary of concrete changes made
|
||||||
|
|
||||||
|
For each finding include:
|
||||||
|
- location;
|
||||||
|
- issue;
|
||||||
|
- why it matters;
|
||||||
|
- recommended fix.
|
||||||
|
|
||||||
|
## Working style
|
||||||
|
- Be direct, specific, and action-oriented.
|
||||||
|
- Do not stop at style-only feedback.
|
||||||
|
- Use full repository context before drawing conclusions.
|
||||||
|
- Prefer minimal, high-confidence patches.
|
||||||
|
- Preserve behavior unless intentionally fixing a bug.
|
||||||
+339
@@ -0,0 +1,339 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
## v1.0.0-rc.16
|
||||||
|
|
||||||
|
### Breaking Changes
|
||||||
|
- Replaced `git.scuroneko.dev/scuroneko/slog` with `git.scuroneko.dev/scuroneko/sneklog/v2` across public logger APIs, including `AppDataLogger`, logger getters, and custom logger setters.
|
||||||
|
- Renamed exported `Json`, `Url`, and `Id` identifiers to idiomatic `JSON`, `URL`, and `ID` spellings, including `BotOpts.APIURL`, `BotOpts.SetAPIURL(...)`, `tgapi.APIOpts.SetAPIURL(...)`, `BotOptsFileJSONCodec`, `BotPayloadJSON`, and related README examples.
|
||||||
|
- Made the request logger field internal; use `Bot.SetRequestLogger(...)` and `Bot.GetRequestLogger()` instead of accessing `Bot.RequestLogger` directly.
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- Added `Bot.UpdatesIter(...)` as an iterator wrapper around a single `Bot.Updates(...)` call, including error delivery through the iterator.
|
||||||
|
- Added scene-local callback payload handlers through `Scene.OnPayload(...)`, including observer lifecycle events for scene payload execution.
|
||||||
|
- Added configurable logger output through `BotOpts.LogFormat`, `BotOpts.SetLogFormat(...)`, `BotOpts.SetLogFormatter(...)`, `tgapi.APIOpts.SetLogFormat(...)`, and `tgapi.APIOpts.SetLogFormatter(...)`.
|
||||||
|
- Added JSON BotOpts file format versioning through `ConfigVersion`, `ErrConfigVersionMismatch`, and `BotOpts.FileConfigVersion`.
|
||||||
|
- Added `Bot.SetLogger(...)`, `Bot.SetRequestLogger(...)`, `Bot.SetWebHookLogger(...)`, `Bot.GetRequestLogger()`, and `Bot.GetWebHookLogger()` helpers for explicit logger customization.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- Updated `pond/v2` to `v2.7.1`.
|
||||||
|
- `Bot.RunWithContext(...)` now closes an explicitly set request logger when `UseRequestLogger` is false and closes webhook loggers before long-polling startup.
|
||||||
|
- Bot loggers now apply the configured token replacer consistently across the main bot logger, request logger, internal API and uploader loggers, webhook logger, app-data logger writers, and auto-managed plugin loggers.
|
||||||
|
- JSON `BotOpts` files now write `version`, reject newer unsupported config versions, keep older unversioned files loadable, and preserve the loaded file version in `BotOpts.FileConfigVersion`.
|
||||||
|
- `Bot.RunWithContext(...)` treats `context.DeadlineExceeded` like `context.Canceled` and exits polling without retry logging.
|
||||||
|
- README and README_RU now use the current `JSON`, `URL`, and `ID` public API names.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- Fixed the go-lint workflow file to end with a newline.
|
||||||
|
|
||||||
|
### Tests
|
||||||
|
- Added regression coverage for `Bot.UpdatesIter(...)` error delivery and early iterator stop behavior.
|
||||||
|
- Added regression coverage proving `Bot.RunWithContext(...)` preserves polling retry attempts and backoff delays across repeated getUpdates failures.
|
||||||
|
- Added regression coverage proving polling startup preserves an enabled request logger.
|
||||||
|
- Updated file logger regression coverage for the current `sneklog` text prefix format.
|
||||||
|
- Added regression coverage proving token masking still applies after `initLoggers(...)` switches loggers to file-backed writers and that auto-managed plugin loggers inherit token masking.
|
||||||
|
- Added regression coverage for JSON config version handling and scene-local payload routing, including observer lifecycle events and callback fallthrough behavior.
|
||||||
|
- Updated logger helper tests for the explicit log format and formatter parameters.
|
||||||
|
|
||||||
|
## v1.0.0-rc.15
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- Added file-based `BotOpts` loading and saving through `LoadBotOptsFile(...)`, `SaveBotOptsFile(...)`, and the `BotOptsFileCodec` API, with built-in JSON support.
|
||||||
|
- Added plugin-level message fallback handlers for text messages and channel posts that do not match commands.
|
||||||
|
- Added godoc for the exported `BotOpts` file codec and load/save helpers.
|
||||||
|
- README, README_RU, and bot-configuration wiki pages now document file-based `BotOpts` loading, built-in JSON support, env placeholder expansion, and custom codec usage including the TOML example.
|
||||||
|
- Active scenes now let unmatched slash-commands continue into normal bot command routing instead of also executing the current scene step or scene message fallback.
|
||||||
|
|
||||||
|
### Tests
|
||||||
|
- Added regression coverage for JSON `BotOpts` file codecs, file load/save helpers, decode failures, and env placeholder expansion.
|
||||||
|
- Added regression coverage for plugin message fallback routing, observer lifecycle events, command precedence, and middleware blocking.
|
||||||
|
- Added regression coverage proving unmatched slash-commands do not trigger active scene step handlers before normal bot command routing.
|
||||||
|
|
||||||
|
## v1.0.0-rc.14
|
||||||
|
|
||||||
|
### Bot API 9.6
|
||||||
|
|
||||||
|
#### Managed Bots
|
||||||
|
- Added the field can_manage_bots to the class User.
|
||||||
|
- Added the class KeyboardButtonRequestManagedBot and the field request_managed_bot to the class KeyboardButton.
|
||||||
|
- Added the class ManagedBotCreated and the field managed_bot_created to the class Message.
|
||||||
|
- Added updates about the creation of managed bots and the change of their token, represented by the class ManagedBotUpdated and the field managed_bot in the class Update.
|
||||||
|
- Added the methods getManagedBotToken and replaceManagedBotToken.
|
||||||
|
- Added the class PreparedKeyboardButton and the method savePreparedKeyboardButton, allowing bots to request users, chats and managed bots from Mini Apps.
|
||||||
|
- Added the method requestChat to the class WebApp.
|
||||||
|
- Added support for https://t.me/newbot/{manager_bot_username}/{suggested_bot_username}[?name={suggested_bot_name}] links, allowing bots to request the creation of a managed bot via a link.
|
||||||
|
|
||||||
|
### Polls
|
||||||
|
- Added support for quizzes with multiple correct answers.
|
||||||
|
- Replaced the field correct_option_id with the field correct_option_ids in the class Poll.
|
||||||
|
- Replaced the parameter correct_option_id with the parameter correct_option_ids in the method sendPoll.
|
||||||
|
- Allowed to pass allows_multiple_answers for quizzes in the method sendPoll.
|
||||||
|
- Increased the maximum time for automatic poll closure to 2628000 seconds.
|
||||||
|
- Added the field allows_revoting to the class Poll.
|
||||||
|
- Added the parameter allows_revoting to the method sendPoll.
|
||||||
|
- Added the parameter shuffle_options to the method sendPoll.
|
||||||
|
- Added the parameter allow_adding_options to the method sendPoll.
|
||||||
|
- Added the parameter hide_results_until_closes to the method sendPoll.
|
||||||
|
- Added the fields description and description_entities to the class Poll.
|
||||||
|
- Added the parameters description, description_parse_mode, and description_entities to the method sendPoll.
|
||||||
|
- Added the field persistent_id to the class PollOption, representing a persistent identifier for the option.
|
||||||
|
- Added the field option_persistent_ids to the class PollAnswer.
|
||||||
|
- Added the fields added_by_user and added_by_chat to the class PollOption, denoting the user and the chat which added the option.
|
||||||
|
- Added the field addition_date to the class PollOption, describing the date when the option was added.
|
||||||
|
- Added the class PollOptionAdded and the field poll_option_added to the class Message.
|
||||||
|
- Added the class PollOptionDeleted and the field poll_option_deleted to the class Message.
|
||||||
|
- Added the field poll_option_id to the class ReplyParameters, allowing bots to reply to a specific poll option.
|
||||||
|
- Added the field reply_to_poll_option_id to the class Message.
|
||||||
|
- Allowed “date_time” entities in checklist title, checklist task text, TextQuote, ReplyParameters quote, sendGift, and giftPremiumSubscription.
|
||||||
|
|
||||||
|
**More info**: https://core.telegram.org/bots/api#april-3-2026
|
||||||
|
|
||||||
|
### Breaking Changes
|
||||||
|
- Exported `tgapi` request parameter structs were renamed from the `*P` suffix to their method names. Update code such as `tgapi.SendMessageP{...}` to `tgapi.SendMessage{...}`.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- *Support for Bot API 9.6*
|
||||||
|
- Added missing godoc for recently introduced Telegram Bot API managed-bot, prepared-button, chat-owner, and video-quality exported declarations.
|
||||||
|
- Renamed exported `tgapi` request parameter structs from the `*P` suffix to their method names, for example `SendMessageP` -> `SendMessage` and `SetWebhookP` -> `SetWebhook`.
|
||||||
|
- Added missing godoc for the exported observer `Event` marker interface.
|
||||||
|
- Webhook execution now shares the bot's queued update-dispatch path with polling, including worker-pool delivery, runner startup, single-use run semantics, and default fallback to bot-level update type filters when webhook-specific filters are not set.
|
||||||
|
- Webhook godoc and the English and Russian READMEs now describe the bot-level webhook runtime, its single-use lifecycle, and the main `RunWebHookWithContext(...)` entry points more explicitly.
|
||||||
|
- `Bot.Close()` once again releases only local resources and no longer deletes remote webhook registrations implicitly; explicit remote webhook teardown remains opt-in through `CloseWebHook()`.
|
||||||
|
- Polling and webhook docs now explicitly state that a deployment must delete its webhook before switching from webhook delivery to long polling.
|
||||||
|
- Webhook startup now validates path shape and TLS file count before remote webhook setup, and the shared webhook mux now serves both HTTP and TLS runtime paths consistently.
|
||||||
|
- Webhook-related `tgapi` request params now use `int8` for `max_connections`, matching Telegram's `1..100` range and the higher-level webhook options API.
|
||||||
|
- Webhook startup now also requires a non-empty `SecretToken` when the optional `/status` endpoint is enabled, preventing anonymous exposure of webhook operational metadata.
|
||||||
|
- Webhook debug logging now records update metadata instead of dumping raw request bodies.
|
||||||
|
- Package docs, README guidance, and core wiki pages now align with the current public API and runtime model, including `NoData`, `SetAppData(...)`, `SetL10n(...)`, `AddAppDataLoggerWriter(...)`, shared runner startup semantics, and the webhook runtime entry points.
|
||||||
|
|
||||||
|
### Tests
|
||||||
|
- Added regression coverage for webhook queue delivery, webhook runtime single-use behavior, runner startup in webhook mode, and default webhook `allowed_updates` inheritance from bot-level update type configuration.
|
||||||
|
- Added regression coverage proving `Bot.Close()` does not make remote webhook delete requests.
|
||||||
|
- Added webhook regression coverage for path validation, TLS file-count validation, oversized-body rejection, status-endpoint secret checks, and invalid TLS startup arguments.
|
||||||
|
- Added webhook regression coverage proving `/status` cannot be enabled without a non-empty `SecretToken`.
|
||||||
|
- Added regression coverage for Bot API 9.6 poll decoding, `managed_bot` update decoding, and structured `setChatMenuButton(...)` request serialization.
|
||||||
|
- Added regression coverage for `MaybeInaccessibleMessage` accessible and inaccessible JSON decoding.
|
||||||
|
|
||||||
|
## v1.0.0-rc.13
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- `AsUserError(...)`, `AsInternalError(...)`, `IsUserError(...)`, and `IsInternalError(...)` for explicitly marking centralized handler errors as user-visible or internal-only without breaking the existing default error flow.
|
||||||
|
- `Policy[T]`, `RequirePolicy(...)`, and built-in chat and callback policy helpers for expressing reusable authorization rules through the existing middleware pipeline.
|
||||||
|
- `Bot.UsePolicy(...)` and `Plugin.UsePolicy(...)` as shorthand for registering policies as middleware.
|
||||||
|
- `AllPolicies(...)`, `AnyPolicy(...)`, and `NotPolicy(...)` for composing reusable authorization rules without introducing a second execution pipeline.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- Bot configuration mutators now treat the bot as configuration-frozen after the first run begins and ignore late mutation attempts for bot-level config such as prefixes, payload defaults, plugins, middleware, runners, localization, scene session wiring, and database context injection.
|
||||||
|
- `MsgContext` godoc and field comments now describe the normalized update contract more explicitly, including when `Msg`, `From`, callback target fields, `Text`, and `Args` are expected to be populated.
|
||||||
|
- `MsgContext` normalization now also carries `Chat` and `ChatID` for more Telegram update kinds, allowing policy and update handlers to rely on normalized chat identity outside message-only flows.
|
||||||
|
- `MsgContext.Error(...)` and returned handler errors now suppress the automatic user reply when the error is explicitly marked with `AsInternalError(...)`, while keeping the previous user-visible default for unclassified errors.
|
||||||
|
- Godoc, README examples, and regression-test naming now consistently describe the shared generic dependency model as app data, including `NoData` and `SetAppData(...)`.
|
||||||
|
- Observer configuration now treats `SetObserver(nil)` as clearing instrumentation instead of leaving the previous observer attached.
|
||||||
|
- Observer lifecycle events now cover generic update handlers and scene command, step, and message-fallback handlers with logical handler names and durations.
|
||||||
|
- `RequirePolicy(...)` now emits `PolicyCheckedEvent` for both passed and denied policy decisions.
|
||||||
|
- Scene command, step, and message-fallback flows now emit observer `ErrorEvent`s with scene-specific handler kinds and logical handler names.
|
||||||
|
- Scene transition observer events now use the same transition payload for scene command, step, and message-fallback flows.
|
||||||
|
- Observer error emission now also covers generic update handlers, callback payload decode failures, runner failures, and polling retries, including dedicated runner and polling handler kinds in `ErrorEvent`.
|
||||||
|
- `TODO.md` and the framework backlog pages now mark the observability model as completed for `v1.0.0-rc.13`.
|
||||||
|
- `tgapi.Chat.Type` now uses the typed `tgapi.ChatType` enum in public DTOs and tests instead of raw string casts.
|
||||||
|
|
||||||
|
### Tests
|
||||||
|
- Added regression coverage for the bot configuration freeze model, including ignored post-run mutations for core bot configuration methods and late registration paths.
|
||||||
|
- Added table-driven update-contract coverage for `prepareUpdateCtx(...)`, including message-backed, callback-backed, user-backed, and no-user update kinds.
|
||||||
|
- Added regression tests for policy middleware blocking, built-in private-chat policy decisions, normalized chat identity, and admin checks that use normalized `ChatID` and `FromID`.
|
||||||
|
- Added regression tests for policy composition semantics, including all-of, any-of, and deny inversion with preserved internal failures.
|
||||||
|
- Added regression tests for `SetObserver(...)`, `GetObserver()`, and clearing the observer with `SetObserver(nil)`.
|
||||||
|
- Added observer regression tests for generic update-handler errors, callback payload decode failures, runner failure events, and polling retry emission.
|
||||||
|
- Added observer regression tests for update and scene handler lifecycle events and `PolicyCheckedEvent` emission.
|
||||||
|
- Added regression tests proving that `edited_message` and `edited_channel_post` stay out of command routing and continue through generic update handlers.
|
||||||
|
- Added callback-routing regression tests for both chat-message and inline-message callback targets, including `CallbackQueryId`, `CallbackMsgId`, `InlineMsgId`, and payload-argument guarantees.
|
||||||
|
- Added regression tests for the new error-visibility model in both message and callback flows, including silent internal-only errors and explicit user-visible callback replies.
|
||||||
|
|
||||||
|
## v1.0.0-rc.12
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- `AnswerLong(...)`, `AnswerLongf(...)`, `KeyboardLong(...)`, and `SplitMessageText(...)` for explicit plain-text splitting of long replies without changing the semantics of existing single-message helpers.
|
||||||
|
- Centralized library-level validation errors in `errors.go`, including `ErrEmptyMessage`, `ErrMessageTooLong`, `ErrCaptionTooLong`, and context/target validation sentinels.
|
||||||
|
- `Bot.GetPayloadType()`, `InlineKeyboard.GetPayloadType()`, and optional strict payload decoding via `BotOpts.StrictPayloadType` / `Bot.SetStrictPayloadType(...)`.
|
||||||
|
- `MsgContext.BindArgs(...)` for binding positional command arguments into exported struct fields.
|
||||||
|
- Binding sentinels `ErrBindArgsTargetNotPointer`, `ErrBindArgsTargetNotStruct`, `ErrBindArgsUnsupportedFieldType`, and `ErrBindArgsConversion`.
|
||||||
|
- Work-in-progress scene/session support, including plugin scene registration, scoped scene sessions, scene entry/exit APIs on `MsgContext`, default in-memory session storage, scene-local routing before normal command handling, and state helpers on `SceneContext`.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- `CommandExecutor` now returns `error`, and command, payload, and non-command update handlers now use centralized bot error handling for returned errors.
|
||||||
|
- README and README_RU examples now use the new handler signature and document the long-message helpers.
|
||||||
|
- README and README_RU now link to the project wiki, and the wiki now includes a page-priority tracker while content is being filled in.
|
||||||
|
- README and README_RU now document scenes, session scopes, scene state helpers, and `SceneActionPass` semantics.
|
||||||
|
- `TODO.md` and the framework backlog pages now group the remaining framework work into explicit priority 1, 2, and 3 buckets.
|
||||||
|
- Payload-type comments and docs now distinguish between the bot's default payload type and keyboard-local overrides.
|
||||||
|
- Scene runtime sentinel errors now have explicit godoc comments.
|
||||||
|
- Public scene structs now document their exported fields more explicitly.
|
||||||
|
- `MsgContext.Context()` now safely falls back to `context.Background()` when no request-scoped context is attached.
|
||||||
|
- `MsgContext` reply, edit, callback, delete, action, and draft-limiter paths now use the context accessor instead of reaching into raw internal state.
|
||||||
|
- Version constants were bumped to `v1.0.0-rc.12`.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- Message and caption validation now runs before Telegram API calls, rejecting empty messages, oversized message text, and oversized captions with stable sentinel errors.
|
||||||
|
- Draft flushing and draft updates now reject oversized messages before sending invalid requests.
|
||||||
|
- Callback payload decoding now optionally enforces strict type matching, while the default tolerant mode logs Base64-to-JSON decoding in debug mode and still accepts keyboard-local payload overrides.
|
||||||
|
- Positional argument binding now leaves missing trailing struct fields at zero values, joins the remaining arguments into the final string field, and returns clearer binding errors.
|
||||||
|
- Request-scoped contexts are now created per update handler execution and safely reused through `MsgContext.Context()` even for manually constructed test contexts.
|
||||||
|
- Command and payload handlers now have regression coverage for end-to-end typed argument binding through the normal routing path.
|
||||||
|
|
||||||
|
### Breaking Changes
|
||||||
|
- `CommandExecutor[T]` changed from `func(ctx *MsgContext, db T)` to `func(ctx *MsgContext, db T) error`.
|
||||||
|
- `Plugin.NewCommand(...)`, `Plugin.NewPayload(...)`, and `Plugin.AddUpdateHandler(...)` now require handlers with the new error-returning signature.
|
||||||
|
|
||||||
|
### Tests
|
||||||
|
- Added regression tests for `MsgContext.BindArgs(...)`, including scalar conversion, tail-string binding, zero-value trailing fields, invalid targets, unsupported field types, and end-to-end command/payload binding.
|
||||||
|
- Added scene regression tests for runtime guards, scene-local command handling, and `SceneActionPass` preserving session state.
|
||||||
|
- Added scene regression tests for message fallback handling, user-scoped session lookup without `Msg`, and custom `SessionStore` error propagation.
|
||||||
|
|
||||||
|
## v1.0.0-rc.11
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- `chat_boost` update decoding now accepts string `boost_id` values, matching the current Telegram Bot API schema and preventing polling failures on boosted-chat updates.
|
||||||
|
|
||||||
|
## v1.0.0-rc.10
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- `Plugin.AddUpdateHandler` for routing non-command Telegram updates by `tgapi.UpdateType`.
|
||||||
|
- Derived `tgapi.Update.Type` assignment during JSON decoding, plus `tgapi.UpdateTypeUnknown` for unmatched payloads.
|
||||||
|
- `tgapi.API.OpenFileByLink(...)` and `OpenFileByLinkWithContext(...)` for streaming downloads from Telegram's file server.
|
||||||
|
- Regression tests for update dispatch, keyboard builders, localization fallback, runners, rate limiting, parse mode encoding, streaming downloads, and context isolation.
|
||||||
|
- Regression tests for bot single-run enforcement, nil plugin registration, `L10n` concurrent access, `API.Close()` idle-connection cleanup, and `tgapi` worker-pool edge cases.
|
||||||
|
- `SEMVER.md` documenting versioning expectations for the project.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- `NewBot` now returns `(*Bot[T], error)` instead of terminating the host process on configuration or startup failures.
|
||||||
|
- `Run` and `RunWithContext` now return errors; `RunWithContext` returns `ErrNoPrefixes` and `ErrNoPlugins` for invalid bot configuration.
|
||||||
|
- Polling retries now use exponential backoff instead of busy-looping on repeated `getUpdates` failures.
|
||||||
|
- `Bot` is now explicitly single-use; repeated `Run()` or `RunWithContext(...)` calls return `ErrBotAlreadyRun`.
|
||||||
|
- Database context wiring now uses `T` consistently instead of forcing `*T`; shared dependencies should typically use pointer types such as `*sql.DB`.
|
||||||
|
- `DatabaseContext`, `GetDBContext`, and `DbLogger` were updated to the new `T`-based dependency model.
|
||||||
|
- `DatabaseContext(...)` now warns once when `T` is a value type, to highlight likely unintended copying of shared dependencies.
|
||||||
|
- `AddDatabaseLoggerWriter(...)` now skips unset and nil database contexts instead of calling the writer with invalid values.
|
||||||
|
- `L10n` is now safe for concurrent use and copies added dictionary entries to avoid external mutation after registration.
|
||||||
|
- Plugin registration now snapshots commands, payloads, middlewares, and update handlers so later mutations of the original `*Plugin` do not leak into the bot.
|
||||||
|
- `AddPlugins(...)` now skips nil plugin pointers instead of panicking.
|
||||||
|
- `GetUpdateTypes()` now returns a copy instead of exposing internal slice state.
|
||||||
|
- Update handling now normalizes `MsgContext` for more Telegram update kinds and routes plugin-level update handlers with isolated context copies.
|
||||||
|
- `message`, `channel_post`, and `callback_query` remain on the command/payload flow; non-command updates can be handled through plugin update handlers.
|
||||||
|
- Command auto-generation now validates Telegram command names with the correct character set and `1..32` length limit, and emits commands in deterministic sorted order.
|
||||||
|
- Builder-style APIs were normalized to value returns for `NewCommandArg`, `NewMiddleware`, `NewRunner`, and `NewCallbackData`.
|
||||||
|
- `MenuButton` replaced `BaseMenuButton`, and `GetChatMenuButton(...)` now returns the renamed type.
|
||||||
|
- Several Telegram DTOs were tightened for optionality and serialization correctness, including `InputPaidMedia`, `MenuButton`, optional gift fields, and message entity slices.
|
||||||
|
- `tgapi.NewRequest(...)`, `NewRequestWithChatID(...)`, `NewUploaderRequest(...)`, and `NewUploaderRequestWithChatID(...)` are now documented as low-level unsafe escape hatches rather than internal helpers.
|
||||||
|
- `tgapi.API.Close()` now closes idle HTTP connections before releasing logger resources.
|
||||||
|
- Multipart form encoding now writes scalar field bytes directly instead of converting through temporary strings.
|
||||||
|
- README, README_RU, package docs, and exported godoc were updated to match the current APIs and concurrency/lifecycle model.
|
||||||
|
- Version constants were bumped to `v1.0.0-rc.10`.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- Required command arguments are now enforced by declared argument index, not only by total required count.
|
||||||
|
- `ParseNone` now omits `parse_mode` from JSON requests instead of serializing `"None"`.
|
||||||
|
- Upload file type detection is now case-insensitive for file extensions.
|
||||||
|
- Draft creation no longer panics when no limiter is configured, and draft flushing now rejects zero chat IDs before sending invalid requests.
|
||||||
|
- Channel posts with `SenderChat` no longer panic in the command path and now preserve the expected `MsgContext` fields.
|
||||||
|
- File logger initialization now falls back to stdout loggers instead of terminating the process on logger setup failures.
|
||||||
|
- `GetChatMenuButton` and `SetChatMenuButton` now serialize `chat_id` correctly when omitted.
|
||||||
|
- Update decoding tests now match the canonical `deleted_business_messages` model and no longer rely on the removed singular alias.
|
||||||
|
|
||||||
|
### Breaking Changes
|
||||||
|
- `NewBot[T](opts)` now returns `(*Bot[T], error)`.
|
||||||
|
- `Run()` now returns `error`.
|
||||||
|
- `RunWithContext(ctx)` now returns `error`.
|
||||||
|
- `Run()` and `RunWithContext(ctx)` are now single-use per bot instance; create a new `Bot` after they return.
|
||||||
|
- Database context handlers now receive `T` instead of `*T`. For shared dependencies, instantiate the bot with a pointer type, for example `Bot[*sql.DB]`.
|
||||||
|
- `DatabaseContext(...)` now takes `T` instead of `*T`.
|
||||||
|
- `GetDBContext()` now returns `T` instead of `*T`.
|
||||||
|
- `DbLogger[T]` now receives `T` instead of `*T`.
|
||||||
|
- `NewCommandArg(...)`, `NewMiddleware(...)`, `NewRunner(...)`, and `NewCallbackData(...)` now return values instead of pointers.
|
||||||
|
- `BaseMenuButton` was renamed to `MenuButton`, and `GetChatMenuButton(...)` now returns `MenuButton`.
|
||||||
|
- `tgapi.Update` no longer exposes the deprecated `DeletedBusinessMessage` alias; use `DeletedBusinessMessages`.
|
||||||
|
|
||||||
|
### Tests
|
||||||
|
- Added coverage for polling backoff helpers, command sorting, database logger safety checks, update handler routing, update-context isolation, channel posts with `SenderChat`, parse mode encoding, streaming downloads, and rate limiter behavior.
|
||||||
|
|
||||||
|
## v1.0.0-rc.7
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- Package-level logger helpers: `utils.CreateLogger(prefix, level)` and `utils.CreateFileLogger(prefix, level, filePath)`.
|
||||||
|
- `MsgContext.Logger`, populated from the matched plugin and falling back to the bot logger.
|
||||||
|
- Plugin lifecycle/configuration APIs: `SetLogger`, `RemoveLogger`, `SetOnClose`, and `Close`.
|
||||||
|
- `Bot.CloseRemote(ctx)` as the explicit wrapper for Telegram Bot API close.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- Logger initialization is now unified across `Bot`, `tgapi.API`, and `tgapi.Uploader`.
|
||||||
|
- `Bot.Close()` now performs local resource teardown only and invokes `Plugin.Close()` for registered plugins.
|
||||||
|
- Local `tgapi.API` shutdown was renamed to `Close()`.
|
||||||
|
- Telegram Bot API close wrappers in `tgapi.API` were renamed to `CloseRemote()` and `CloseRemoteWithContext()`.
|
||||||
|
- `Bot.Debug()` now updates log levels for the bot logger, request logger, and already registered plugin loggers.
|
||||||
|
- `Bot.AddPlugins()` now creates a default plugin logger automatically when one is not provided.
|
||||||
|
- `Bot.AddDatabaseLoggerWriter()` now also attaches the writer to already registered plugin loggers.
|
||||||
|
- GoDoc was expanded for the new shutdown and logging APIs, and plugin registration is now documented as a configuration commit point.
|
||||||
|
|
||||||
|
### Breaking Changes
|
||||||
|
- `(*Bot).Close(ctx context.Context)` was replaced with `(*Bot).Close()`.
|
||||||
|
- `(*tgapi.API).CloseApi()` was renamed to `(*tgapi.API).Close()`.
|
||||||
|
- `(*tgapi.API).Close()` was renamed to `(*tgapi.API).CloseRemote()`.
|
||||||
|
- `(*tgapi.API).CloseWithContext()` was renamed to `(*tgapi.API).CloseRemoteWithContext(ctx)`.
|
||||||
|
|
||||||
|
### Migration
|
||||||
|
- Replace `bot.Close(ctx)` with `bot.Close()`.
|
||||||
|
- If you need Telegram Bot API close, use `bot.CloseRemote(ctx)`.
|
||||||
|
- Replace `api.CloseApi()` with `api.Close()`.
|
||||||
|
- Replace `api.Close()` with `api.CloseRemote()`.
|
||||||
|
- Replace `api.CloseWithContext(ctx)` with `api.CloseRemoteWithContext(ctx)`.
|
||||||
|
- Configure plugin loggers and `OnClose` hooks before calling `bot.AddPlugins(...)`.
|
||||||
|
|
||||||
|
### Tests
|
||||||
|
- Updated tests for the new shutdown and logging behavior.
|
||||||
|
|
||||||
|
### Notes
|
||||||
|
- Registering a plugin via `AddPlugins(...)` is a configuration commit point; the plugin should not be mutated through the original `*Plugin` afterward.
|
||||||
|
- If plugin loggers must receive a database writer, call `AddDatabaseLoggerWriter(...)` after registering plugins.
|
||||||
|
|
||||||
|
## v1.0.0-rc.4
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- `WithContext` variants across `tgapi` API and uploader methods so callers can pass cancellation and deadline contexts consistently.
|
||||||
|
- `UploaderCertificateType`, `UploadSetWebhookP`, `Uploader.SetWebhook(...)`, and `Uploader.SetWebhookWithContext(...)` for multipart webhook certificate uploads.
|
||||||
|
- Missing media thumbnail fields where applicable.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- GoDoc for context-aware methods was improved, and `See` references now point to method-specific Telegram Bot API anchors.
|
||||||
|
- `EditMessageTextP` now includes `entities` and `link_preview_options`.
|
||||||
|
- `EditMessageCaptionP` now includes `caption_entities` and `show_caption_above_media`.
|
||||||
|
- `StopPollP` now uses `reply_markup` and no longer carries `inline_message_id`.
|
||||||
|
- `SendStickerP` now includes reply and suggested-post related fields.
|
||||||
|
- `SendDocumentP` now includes `disable_content_type_detection`.
|
||||||
|
- `SendInvoiceP` no longer includes unsupported `business_connection_id`.
|
||||||
|
- `SetWebhookP` no longer carries `certificate`; GoDoc now points to uploader-based certificate upload.
|
||||||
|
- Existing non-context methods remain available, and the `Do(...)` call style is preserved.
|
||||||
|
|
||||||
|
### Breaking Changes
|
||||||
|
- Users sending webhook certificates through JSON `SetWebhookP.Certificate` must migrate to `Uploader.SetWebhook(...)`.
|
||||||
|
|
||||||
|
## v1.0.0-rc.3
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- The update polling loop no longer logs or retries after `context.Canceled` during shutdown.
|
||||||
|
- Extra retry delay was removed from canceled polling requests so `RunWithContext` can exit immediately while stopping.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- Shutdown behavior remains explicit: callers are still responsible for invoking `Close()` after `RunWithContext` returns.
|
||||||
|
|
||||||
|
## v1.0.0-rc.2
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- Fixed a shutdown crash caused by `DatabaseWriter` calling `Close()` through an uninitialized embedded logger writer.
|
||||||
|
- Fixed bot shutdown hanging during Telegram long polling by making update polling use a cancelable context.
|
||||||
|
- Reduced the chance of container termination with exit code `137` during shutdown by allowing `getUpdates` to stop promptly on cancellation.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- Switched the project to use the local `laniakea` replacement for the shutdown fix.
|
||||||
|
- Documentation now clarifies that `RunWithContext` does not close resources automatically and callers must invoke `Close()` explicitly.
|
||||||
|
- `Updates` documentation now describes context-driven cancellation behavior.
|
||||||
|
|
||||||
|
### Tests
|
||||||
|
- Added regression tests for database logger writer shutdown behavior.
|
||||||
@@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
@@ -0,0 +1,342 @@
|
|||||||
|
# Laniakea
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
[](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)
|
||||||
|
|
||||||
|
[Wiki](https://git.scuroneko.dev/ScuroNeko/Laniakea/wiki)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## ✨ 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 application data or state contexts to your handlers.
|
||||||
|
* **Configurable API:** Mix `Set...` and `Add...` helpers to configure bots clearly (for example, `bot.SetErrorTemplate(...).AddPlugins(...)`).
|
||||||
|
* **Polling and Webhook Runtime:** Run bots through long polling with `Run()` / `RunWithContext(...)` or through a bot-owned webhook server with `RunWebHookWithContext(...)`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📦 Installation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
go get git.scuroneko.dev/scuroneko/laniakea
|
||||||
|
```
|
||||||
|
|
||||||
|
or
|
||||||
|
|
||||||
|
```bash
|
||||||
|
go get github.com/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.scuroneko.dev/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.)
|
||||||
|
// - data: your shared application data (here we use NoData, a placeholder for no shared data)
|
||||||
|
func echo(ctx *laniakea.MsgContext, data laniakea.NoData) error {
|
||||||
|
// 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
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
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.NoData as the application data type (no shared data needed for this example).
|
||||||
|
bot, err := laniakea.NewBot[laniakea.NoData](opts)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
// 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.NoData]("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, data laniakea.NoData) error {
|
||||||
|
ctx.Answer("Pong")
|
||||||
|
return nil
|
||||||
|
}, "ping"))
|
||||||
|
|
||||||
|
// 6. Configure the bot with a custom error template and add the plugin.
|
||||||
|
// SetErrorTemplate 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.SetErrorTemplate("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).
|
||||||
|
if err := bot.Run(); err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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 custom shared application data (for example, *sql.DB or a service container) that will be available in all handlers. Use laniakea.NoData 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) error`), the second is the command name (without the slash).
|
||||||
|
5. **Handler Functions**: Receive *MsgContext (message details, methods like Answer) and your custom application data T, and return an error for centralized error handling.
|
||||||
|
6. `SetErrorTemplate`: Sets a template for error messages. The %s placeholder is replaced by the actual error.
|
||||||
|
7. `AutoGenerateCommands`: Registers plugin-defined commands with Telegram across the supported scopes.
|
||||||
|
8. `Run()`: Starts the bot's update polling loop and returns an error if startup or polling fails.
|
||||||
|
9. `RunWebHookWithContext(...)`: Starts the bot-owned webhook runtime when Telegram should deliver updates over HTTP instead of long polling.
|
||||||
|
10. A `Bot` instance is single-use. After `Run()`, `RunWithContext()`, or `RunWebHookWithContext()` returns, create a new bot instance for the next session.
|
||||||
|
|
||||||
|
## File-Based Config
|
||||||
|
|
||||||
|
`BotOpts` can also be loaded from or saved to config files through the file codec API.
|
||||||
|
|
||||||
|
Built in:
|
||||||
|
- `BotOptsFileJSONCodec` for JSON files.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```go
|
||||||
|
codec := laniakea.BotOptsFileJSONCodec{}
|
||||||
|
opts, err := laniakea.LoadBotOptsFile(codec, "config.json")
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
bot, err := laniakea.NewBot[laniakea.NoData](opts)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Placeholders like `{{ TG_TOKEN }}` inside the file are expanded from environment variables before decoding.
|
||||||
|
|
||||||
|
You can also implement your own codec for other formats by satisfying `BotOptsFileCodec`.
|
||||||
|
Only JSON is supported out of the box right now. If you want another format such as TOML, use `BotOptsFileJSONCodec` as the reference implementation for your own codec.
|
||||||
|
|
||||||
|
See the full guide in the wiki: [Bot Options and Configuration](https://git.scuroneko.dev/ScuroNeko/Laniakea/wiki/Bot-Options-and-Configuration)
|
||||||
|
|
||||||
|
## Webhook Runtime
|
||||||
|
|
||||||
|
Laniakea also supports a bot-owned webhook runtime through `RunWebHookWithContext(...)` and `RunWebHook(...)`.
|
||||||
|
|
||||||
|
Use it when:
|
||||||
|
- Telegram should push updates to your HTTP endpoint instead of your bot polling for them.
|
||||||
|
- You want webhook-delivered updates to reuse the same internal queue, worker pool, runners, and single-use lifecycle as polling.
|
||||||
|
- You want Laniakea to register the webhook and own the local HTTP server.
|
||||||
|
|
||||||
|
Production notes:
|
||||||
|
- Set `BotWebHookOpts.SecretToken` for request authentication.
|
||||||
|
- `BotWebHookOpts.SecretToken` is required when `BotWebHookOpts.UseStatusPath` is enabled.
|
||||||
|
- Keep `BotWebHookOpts.Path` specific instead of serving webhook traffic on `/`.
|
||||||
|
- If you switch an existing deployment from webhook mode to long polling, delete the webhook first with `CloseWebHook()` or `tgapi.DeleteWebhook(...)`. Telegram keeps webhook delivery active until it is removed.
|
||||||
|
- Use `RunWebHookWithContext(...)` with a cancelable context, then call `Close()` after runtime shutdown.
|
||||||
|
|
||||||
|
See the full guide in the wiki: [Webhook Runtime](https://git.scuroneko.dev/ScuroNeko/Laniakea/wiki/Webhook-Runtime)
|
||||||
|
|
||||||
|
## 📖 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) error {
|
||||||
|
// Access command arguments via ctx.Args ([]string)
|
||||||
|
// Reply to the user: ctx.Answer("some text")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### MsgContext
|
||||||
|
|
||||||
|
Provides access to the incoming message and useful reply methods:
|
||||||
|
|
||||||
|
- `Answer(text string) *AnswerMessage`: Sends a message with parse_mode none.
|
||||||
|
- `AnswerLong(text string) []*AnswerMessage`: Splits long plain text into multiple messages.
|
||||||
|
- `AnswerMarkdown(text string) *AnswerMessage`: Sends a message formatted with MarkdownV2 (you handle escaping).
|
||||||
|
- `Keyboard(text string, keyboard *InlineKeyboard) *AnswerMessage`: Sends a message with parse_mode none and inline keyboard.
|
||||||
|
- `KeyboardLong(text string, keyboard *InlineKeyboard) []*AnswerMessage`: Splits long plain text into multiple messages and attaches the keyboard to the final chunk.
|
||||||
|
- `KeyboardMarkdown(text string, keyboard *InlineKeyboard) *AnswerMessage`: Sends a message formatted with MarkdownV2 (you handle escaping) and inline keyboard.
|
||||||
|
- `AnswerPhoto(photoID, text string) *AnswerMessage`: Sends a message with photo with parse_mode none.
|
||||||
|
- `AnswerPhotoMarkdown(photoID, text string) *AnswerMessage`: Sends a photo with MarkdownV2 caption (you handle escaping).
|
||||||
|
- `EditCallback(text string)`: Edits message with parse_mode none after clicking inline button.
|
||||||
|
- `EditCallbackMarkdown(text string)`: Edits a message formatted with MarkdownV2 (you handle escaping) after clicking inline button.
|
||||||
|
- `SendAction(action tgapi.ChatActionType)`: Sends a “typing”, “uploading photo”, etc., action.
|
||||||
|
- Fields: `Text`, `Args`, `From`, `FromID`, `Msg`, `InlineMsgID`, `CallbackQueryID`, etc.
|
||||||
|
- And more methods and fields!
|
||||||
|
|
||||||
|
### tgapi: API and Uploader
|
||||||
|
|
||||||
|
`tgapi` provides two clients:
|
||||||
|
|
||||||
|
- `API` for JSON requests (e.g., `SendMessage`, `EditMessageText`, methods using file_id/URL).
|
||||||
|
- `Uploader` for multipart uploads (e.g., `SendPhoto`, `SendDocument`, `SendVideo` with binary files).
|
||||||
|
|
||||||
|
This split keeps method intent explicit: JSON-only calls go through `API`, file uploads go through `Uploader`.
|
||||||
|
|
||||||
|
For advanced cases, `tgapi.NewRequest(...)` and `tgapi.NewUploaderRequest(...)` remain public as low-level escape hatches. They are intentionally less safe than method-specific helpers: callers must supply the correct Telegram method name and compatible request/response types themselves.
|
||||||
|
|
||||||
|
### App Data
|
||||||
|
|
||||||
|
The `T` in `NewBot[T]` is a powerful feature. You can pass any type, but shared dependencies such as database pools, service containers, or API clients should usually use a pointer type.
|
||||||
|
|
||||||
|
```go
|
||||||
|
type MyDB struct { /* ... */ }
|
||||||
|
db := &MyDB{...}
|
||||||
|
bot, err := laniakea.NewBot[*MyDB](opts)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
bot.SetAppData(db)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Scenes and Sessions
|
||||||
|
|
||||||
|
Scenes model multi-step conversations inside a plugin. Each active scene is stored in a session keyed by scope, so you can isolate flows per user, per chat, or per user-chat pair.
|
||||||
|
|
||||||
|
```go
|
||||||
|
plugin := laniakea.NewPlugin[MyDB]("signup")
|
||||||
|
|
||||||
|
plugin.NewScene("signup").
|
||||||
|
SetScope(laniakea.SceneScopeUserChat).
|
||||||
|
SetEntry("ask_name").
|
||||||
|
OnStep("ask_name", func(ctx *laniakea.SceneContext, db MyDB) (laniakea.SceneResult, error) {
|
||||||
|
if ctx.Text == "" {
|
||||||
|
ctx.Answer("What is your name?")
|
||||||
|
return ctx.Stay(), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := ctx.SaveData(struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
}{Name: ctx.Text}); err != nil {
|
||||||
|
return laniakea.SceneResult{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx.Answer("Nice to meet you.")
|
||||||
|
return ctx.Next("done"), nil
|
||||||
|
}).
|
||||||
|
OnStep("done", func(ctx *laniakea.SceneContext, db MyDB) (laniakea.SceneResult, error) {
|
||||||
|
return ctx.Exit(), nil
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
- Use `ctx.EnterScene("signup")` to enter the configured entry step.
|
||||||
|
- Use `ctx.EnterSceneStep("signup", "done")` when you need an explicit starting step.
|
||||||
|
- Return `ctx.Stay()`, `ctx.Next(step)`, `ctx.Exit()`, or `ctx.Pass()` from scene handlers to control flow.
|
||||||
|
- `SceneActionPass` keeps the current session unchanged and continues normal bot routing.
|
||||||
|
- Use `SceneContext.SaveData(...)` and `SceneContext.BindData(...)` for JSON session state.
|
||||||
|
- Use `SceneScopeUser`, `SceneScopeChat`, or `SceneScopeUserChat` depending on how widely a conversation should be shared.
|
||||||
|
|
||||||
|
## 🧩 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 `AddMiddleware` on a plugin to add one or more shared middleware functions. They are executed in the order they are added.
|
||||||
|
|
||||||
|
```go
|
||||||
|
plugin := laniakea.NewPlugin[*MyDB]("admin")
|
||||||
|
plugin.AddMiddleware(laniakea.NewMiddleware("logging", loggingMiddleware))
|
||||||
|
plugin.AddMiddleware(laniakea.NewMiddleware("admin-only", 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.
|
||||||
|
|
||||||
|
## ⚙️ Advanced Configuration
|
||||||
|
- **Inline Keyboards**: Build keyboards using `laniakea.NewInlineKeyboardJSON`, `laniakea.NewInlineKeyboardBase64`, or `laniakea.NewInlineKeyboard`. `Bot.SetPayloadType(...)` defines the default payload format, and `InlineKeyboard.SetPayloadType(...)` overrides it for one keyboard.
|
||||||
|
- **Rate Limiting**: Pass a configured utils.RateLimiter via BotOpts to handle Telegram's rate limits gracefully.
|
||||||
|
- **Localization**: `L10n` is safe for concurrent use once attached to the bot.
|
||||||
|
- **Custom Update Handlers**: Use `plugin.AddUpdateHandler(...)` for Telegram update types that are not part of the command/payload flow.
|
||||||
|
- **Lifecycle**: `RunWithContext(...)` and `RunWebHookWithContext(...)` do not call `Close()` for you. Shut the bot down explicitly, and create a fresh `Bot` for the next run.
|
||||||
|
|
||||||
|
## Telegram Update Handling
|
||||||
|
- Commands and payloads are handled through plugins.
|
||||||
|
- Non-command updates can be routed with `plugin.AddUpdateHandler(updateType, handler)`.
|
||||||
|
- `message`, `channel_post`, and `callback_query` stay on the command/payload flow.
|
||||||
|
- `tgapi.Update` exposes a derived `Type` field after JSON unmarshalling so handlers can inspect the effective update kind directly.
|
||||||
|
|
||||||
|
## 📝 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.scuroneko.dev/scuroneko/laniakea)
|
||||||
|
|
||||||
|
[Wiki](https://git.scuroneko.dev/ScuroNeko/Laniakea/wiki)
|
||||||
|
|
||||||
|
[Telegram Bot API](https://core.telegram.org/bots/api)
|
||||||
|
|
||||||
|
✅ Built with ❤️ by scuroneko
|
||||||
+338
@@ -0,0 +1,338 @@
|
|||||||
|
# Laniakea
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
[](https://go.dev/)
|
||||||
|
[](LICENSE)
|
||||||
|

|
||||||
|
|
||||||
|
Легковесная, простая в использовании и производительная обёртка для Telegram Bot API на Go. Она упрощает разработку ботов благодаря чистой системе плагинов, поддержке Middleware, автоматической генерации команд и встроенному рейтлимитеру.
|
||||||
|
|
||||||
|
[English](README.md)
|
||||||
|
|
||||||
|
[Wiki](https://git.scuroneko.dev/ScuroNeko/Laniakea/wiki)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## ✨ Возможности
|
||||||
|
|
||||||
|
* **Простой и интуитивный API:** Разработан для лёгкости использования, основан на практических примерах.
|
||||||
|
* **Система плагинов:** Организуйте функциональность бота в независимые, переиспользуемые плагины.
|
||||||
|
* **Обработка команд:** Легко регистрируйте команды и извлекайте аргументы.
|
||||||
|
* **Поддержка промежуточных слоёв (Middleware):** Выполняйте код до или после команд (например, логирование, проверка доступа).
|
||||||
|
* **Автоматическая генерация команд:** Генерируйте справку и списки команд автоматически.
|
||||||
|
* **Встроенный ограничитель запросов (Rate Limiter):** Защитите бота от превышения лимитов Telegram API (с обработкой `retry_after`).
|
||||||
|
* **Контекст данных:** Передавайте общие данные приложения или state в обработчики.
|
||||||
|
* **Настраиваемый API:** Комбинируйте `Set...` и `Add...` helper-методы для понятной конфигурации, например `bot.SetErrorTemplate(...).AddPlugins(...)`.
|
||||||
|
* **Polling и Webhook Runtime:** Запускайте бота через long polling с `Run()` / `RunWithContext(...)` или через webhook server, которым владеет сам бот, с `RunWebHookWithContext(...)`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📦 Установка
|
||||||
|
|
||||||
|
```bash
|
||||||
|
go get git.scuroneko.dev/scuroneko/laniakea
|
||||||
|
```
|
||||||
|
|
||||||
|
или
|
||||||
|
|
||||||
|
```bash
|
||||||
|
go get github.com/scuroneko/laniakea
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🚀 Быстрый старт (с пошаговыми комментариями)
|
||||||
|
Вот минимальный пример бота "echo/ping" с подробными комментариями.
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"log"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea" // Импортируем библиотеку Laniakea
|
||||||
|
)
|
||||||
|
|
||||||
|
// echo — это функция-обработчик команды.
|
||||||
|
// Она получает два параметра:
|
||||||
|
// - ctx: контекст сообщения (содержит информацию о сообщении, отправителе, чате и т.д.)
|
||||||
|
// - data: ваши общие данные приложения (здесь мы используем NoData — заглушку без общих зависимостей)
|
||||||
|
func echo(ctx *laniakea.MsgContext, data laniakea.NoData) error {
|
||||||
|
// Отвечаем пользователю текстом, который он прислал, без префикса команды.
|
||||||
|
// ctx.Text содержит сообщение пользователя, из которого удалена часть с командой.
|
||||||
|
ctx.Answer(ctx.Text) // Ввод пользователя БЕЗ команды
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
// 1. Создаём опции бота. Замените "TOKEN" на реальный токен от @BotFather.
|
||||||
|
opts := &laniakea.BotOpts{Token: "TOKEN"}
|
||||||
|
|
||||||
|
// 2. Инициализируем новый экземпляр бота.
|
||||||
|
// Используем laniakea.NoData как тип данных приложения (общие зависимости не нужны для примера).
|
||||||
|
bot, err := laniakea.NewBot[laniakea.NoData](opts)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
// Гарантируем освобождение ресурсов бота при выходе.
|
||||||
|
defer bot.Close()
|
||||||
|
|
||||||
|
// 3. Создаём новый плагин с именем "ping".
|
||||||
|
// Плагины помогают группировать связанные команды и промежуточные обработчики.
|
||||||
|
p := laniakea.NewPlugin[laniakea.NoData]("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, data laniakea.NoData) error {
|
||||||
|
ctx.Answer("Pong")
|
||||||
|
return nil
|
||||||
|
}, "ping"))
|
||||||
|
|
||||||
|
// 6. Настраиваем бота: задаём шаблон ошибки и добавляем плагин.
|
||||||
|
// SetErrorTemplate устанавливает формат для сообщений об ошибках (где %s будет заменён на текст ошибки).
|
||||||
|
// AddPlugins(p) регистрирует наш плагин "ping" в боте.
|
||||||
|
bot = bot.SetErrorTemplate("Ошибка\n\n%s").AddPlugins(p)
|
||||||
|
|
||||||
|
// 7. Автоматически генерируем команды, такие как /start, /help и список всех зарегистрированных команд.
|
||||||
|
// Это необязательно, но очень полезно для большинства ботов.
|
||||||
|
if err := bot.AutoGenerateCommands(); err != nil {
|
||||||
|
log.Println(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// 8. Запускаем бота, начиная прослушивание обновлений (long polling).
|
||||||
|
if err := bot.Run(); err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Как это работает
|
||||||
|
1. `BotOpts`: Содержит конфигурацию, например, токен API.
|
||||||
|
2. `NewBot[T]`: Создаёт экземпляр бота. Параметр типа T позволяет передать общие данные приложения (например, *sql.DB или контейнер сервисов), которые будут доступны во всех обработчиках. Используйте laniakea.NoData, если они не нужны.
|
||||||
|
3. `NewPlugin`: Создаёт логическую группу для команд и Middleware.
|
||||||
|
4. `AddCommand`: Регистрирует команду. Первый аргумент — функция-обработчик (`func(*MsgContext, T) error`), второй — имя команды (без слеша).
|
||||||
|
5. **Функции-обработчики**: Получают *MsgContext (детали сообщения, методы типа Answer) и ваши данные приложения типа T, а ошибку возвращают для централизованной обработки.
|
||||||
|
6. `SetErrorTemplate`: Устанавливает шаблон для сообщений об ошибках. Плейсхолдер %s заменяется на текст ошибки.
|
||||||
|
7. `AutoGenerateCommands`: Регистрирует команды из плагинов в Telegram для поддерживаемых scope.
|
||||||
|
8. `Run()`: Запускает цикл опроса обновлений бота и возвращает ошибку, если старт или polling завершился неуспешно.
|
||||||
|
9. `RunWebHookWithContext(...)`: Запускает bot-owned webhook runtime, когда Telegram должен доставлять update по HTTP вместо long polling.
|
||||||
|
10. Экземпляр `Bot` одноразовый. После завершения `Run()`, `RunWithContext()` или `RunWebHookWithContext()` для следующего запуска создавайте новый бот.
|
||||||
|
|
||||||
|
## Конфиг из файла
|
||||||
|
|
||||||
|
`BotOpts` можно не только собирать вручную или из environment, но и загружать и сохранять через file codec API.
|
||||||
|
|
||||||
|
Из коробки доступно:
|
||||||
|
- `BotOptsFileJSONCodec` для JSON-файлов.
|
||||||
|
|
||||||
|
Пример:
|
||||||
|
|
||||||
|
```go
|
||||||
|
codec := laniakea.BotOptsFileJSONCodec{}
|
||||||
|
opts, err := laniakea.LoadBotOptsFile(codec, "config.json")
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
bot, err := laniakea.NewBot[laniakea.NoData](opts)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Плейсхолдеры вида `{{ TG_TOKEN }}` внутри файла перед декодированием разворачиваются из переменных окружения.
|
||||||
|
|
||||||
|
Для других форматов можно реализовать собственный codec через интерфейс `BotOptsFileCodec`.
|
||||||
|
Из коробки сейчас поддерживается только JSON. Если нужен другой формат, например TOML, используй `BotOptsFileJSONCodec` как эталонную реализацию собственного codec.
|
||||||
|
|
||||||
|
Подробности есть в wiki: [Bot Options and Configuration RU](https://git.scuroneko.dev/ScuroNeko/Laniakea/wiki/Bot-Options-and-Configuration-RU)
|
||||||
|
|
||||||
|
## Webhook Runtime
|
||||||
|
|
||||||
|
Laniakea также поддерживает bot-owned webhook runtime через `RunWebHookWithContext(...)` и `RunWebHook(...)`.
|
||||||
|
|
||||||
|
Используй его, когда:
|
||||||
|
- Telegram должен сам отправлять update на твой HTTP endpoint вместо polling.
|
||||||
|
- Ты хочешь, чтобы webhook-update проходили через ту же внутреннюю очередь, тот же worker pool, тех же runners и тот же single-use lifecycle, что и polling.
|
||||||
|
- Ты хочешь, чтобы Laniakea сама регистрировала webhook и владела локальным HTTP server.
|
||||||
|
|
||||||
|
Практические замечания:
|
||||||
|
- Задавай `BotWebHookOpts.SecretToken` для аутентификации запросов.
|
||||||
|
- Непустой `BotWebHookOpts.SecretToken` обязателен, если включён `BotWebHookOpts.UseStatusPath`.
|
||||||
|
- Используй явный `BotWebHookOpts.Path`, а не `/`.
|
||||||
|
- Если ты переводишь уже существующий deployment с webhook-режима на long polling, сначала удали webhook через `CloseWebHook()` или `tgapi.DeleteWebhook(...)`. Пока webhook не удалён, Telegram продолжает доставку через него.
|
||||||
|
- Запускай `RunWebHookWithContext(...)` с cancelable context и после остановки runtime всё равно вызывай `Close()`.
|
||||||
|
|
||||||
|
Полное руководство есть в wiki: [Webhook Runtime](https://git.scuroneko.dev/ScuroNeko/Laniakea/wiki/Webhook-Runtime-RU)
|
||||||
|
|
||||||
|
## 📖 Основные концепции
|
||||||
|
### Плагины (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) error {
|
||||||
|
// Доступ к аргументам команды через ctx.Args ([]string)
|
||||||
|
// Ответ пользователю: ctx.Answer("какой-то текст")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Контекст сообщения (MsgContext)
|
||||||
|
Предоставляет доступ к входящему сообщению и полезные методы для ответа:
|
||||||
|
|
||||||
|
- `Answer(text string)`: Отправляет сообщение с parse_mode none.
|
||||||
|
- `AnswerLong(text string) []*AnswerMessage`: Разбивает длинный plain text на несколько сообщений.
|
||||||
|
- `AnswerMarkdown(text string)`: Отправляет сообщение, отформатированное MarkdownV2 (экранирование на вашей стороне).
|
||||||
|
- `Keyboard(text string, keyboard *InlineKeyboard) *AnswerMessage`: Отправляет сообщение с parse_mode none и Inline клавиатурой.
|
||||||
|
- `KeyboardLong(text string, keyboard *InlineKeyboard) []*AnswerMessage`: Разбивает длинный plain text на несколько сообщений и вешает клавиатуру на последний chunk.
|
||||||
|
- `KeyboardMarkdown(text string, keyboard *InlineKeyboard) *AnswerMessage`: Отправляет сообщение, отформатированное MarkdownV2 (экранирование на вашей стороне), и Inline клавиатурой.
|
||||||
|
- `AnswerPhoto(photoID, text string) *AnswerMessage`: Отправляет фотографию с подписью и parse_mode none.
|
||||||
|
- `AnswerPhotoMarkdown(photoID, text string) *AnswerMessage`: Отправляет фотографию с подписью, отформатированной MarkdownV2 (экранирование на вашей стороне).
|
||||||
|
- `EditCallback(text string)`: Редактирует сообщение с `parse_mode` none после нажатия inline-кнопки.
|
||||||
|
- `EditCallbackMarkdown(text string)`: Редактирует сообщение в формате MarkdownV2 (экранирование на вашей стороне) после нажатия inline-кнопки.
|
||||||
|
- `SendAction(action tgapi.ChatActionType)`: Отправляет действие "печатает", "загружает фото" и т.д.
|
||||||
|
- Поля: `Text`, `Args`, `From`, `FromID`, `Msg`, `InlineMsgID`, `CallbackQueryID` и другие.
|
||||||
|
- И много других методов и полей!
|
||||||
|
|
||||||
|
### App Data
|
||||||
|
Параметр типа `T` в `NewBot[T]` — мощная возможность. Вы можете передать любой тип, но для разделяемых зависимостей вроде пула соединений с БД, контейнера сервисов или API-клиента обычно стоит использовать pointer type.
|
||||||
|
|
||||||
|
```go
|
||||||
|
type MyDB struct { /* ... */ }
|
||||||
|
db := &MyDB{...}
|
||||||
|
bot, err := laniakea.NewBot[*MyDB](opts)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
bot.SetAppData(db)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Сцены и сессии (Scenes and Sessions)
|
||||||
|
|
||||||
|
Сцены описывают многошаговые диалоги внутри плагина. Активная сцена хранится в session state, ключ которого зависит от scope, поэтому поток можно изолировать на пользователя, на чат или на пару пользователь-чат.
|
||||||
|
|
||||||
|
```go
|
||||||
|
plugin := laniakea.NewPlugin[MyDB]("signup")
|
||||||
|
|
||||||
|
plugin.NewScene("signup").
|
||||||
|
SetScope(laniakea.SceneScopeUserChat).
|
||||||
|
SetEntry("ask_name").
|
||||||
|
OnStep("ask_name", func(ctx *laniakea.SceneContext, db MyDB) (laniakea.SceneResult, error) {
|
||||||
|
if ctx.Text == "" {
|
||||||
|
ctx.Answer("Как тебя зовут?")
|
||||||
|
return ctx.Stay(), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := ctx.SaveData(struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
}{Name: ctx.Text}); err != nil {
|
||||||
|
return laniakea.SceneResult{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx.Answer("Приятно познакомиться.")
|
||||||
|
return ctx.Next("done"), nil
|
||||||
|
}).
|
||||||
|
OnStep("done", func(ctx *laniakea.SceneContext, db MyDB) (laniakea.SceneResult, error) {
|
||||||
|
return ctx.Exit(), nil
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
- Используйте `ctx.EnterScene("signup")`, чтобы войти в entry step, настроенный у сцены.
|
||||||
|
- Используйте `ctx.EnterSceneStep("signup", "done")`, если нужен явный стартовый step.
|
||||||
|
- Из scene handler возвращайте `ctx.Stay()`, `ctx.Next(step)`, `ctx.Exit()` или `ctx.Pass()` для управления потоком.
|
||||||
|
- `SceneActionPass` не меняет текущую session state и продолжает обычный routing бота.
|
||||||
|
- Для JSON-состояния сцены используйте `SceneContext.SaveData(...)` и `SceneContext.BindData(...)`.
|
||||||
|
- Выбирайте `SceneScopeUser`, `SceneScopeChat` или `SceneScopeUserChat` в зависимости от того, насколько широко должен разделяться диалог.
|
||||||
|
|
||||||
|
### tgapi: API и Uploader
|
||||||
|
|
||||||
|
В `tgapi` есть два клиента:
|
||||||
|
|
||||||
|
- `API` для JSON-запросов (`SendMessage`, `EditMessageText`, методы с `file_id`/URL).
|
||||||
|
- `Uploader` для multipart-загрузок (`SendPhoto`, `SendDocument`, `SendVideo` с бинарными файлами).
|
||||||
|
|
||||||
|
Для продвинутых сценариев `tgapi.NewRequest(...)` и `tgapi.NewUploaderRequest(...)` остаются публичными low-level escape hatch API. Они менее безопасны, чем типизированные helper-методы: вызывающая сторона сама отвечает за корректное имя Telegram-метода и совместимые типы параметров/ответа.
|
||||||
|
|
||||||
|
## 🧩 Промежуточные слои (Middleware)
|
||||||
|
Middleware — это функции, которые выполняются перед обработчиком команды. Они идеально подходят для сквозных задач, таких как логирование, контроль доступа, ограничение скорости запросов или модификация контекста.
|
||||||
|
|
||||||
|
### Сигнатура
|
||||||
|
Функция middleware имеет ту же сигнатуру, что и обработчик команды, но должна возвращать bool:
|
||||||
|
|
||||||
|
```go
|
||||||
|
func(ctx *MsgContext, db T) bool
|
||||||
|
```
|
||||||
|
|
||||||
|
- Если возвращается true, выполняется следующий middleware (или сама команда).
|
||||||
|
- Если возвращается false, цепочка выполнения немедленно прерывается (команда не запускается).
|
||||||
|
|
||||||
|
### Добавление middleware
|
||||||
|
Используйте метод `AddMiddleware` плагина для добавления одной или нескольких функций middleware. Они выполняются в порядке добавления.
|
||||||
|
|
||||||
|
```go
|
||||||
|
plugin := laniakea.NewPlugin[*MyDB]("admin")
|
||||||
|
plugin.AddMiddleware(laniakea.NewMiddleware("logging", loggingMiddleware))
|
||||||
|
plugin.AddMiddleware(laniakea.NewMiddleware("admin-only", 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 (например, добавлять пользовательские поля) перед запуском команды.
|
||||||
|
|
||||||
|
## ⚙️ Расширенная настройка
|
||||||
|
- **Инлайн-клавиатуры**: Создавайте клавиатуры с помощью `laniakea.NewInlineKeyboardJSON`, `laniakea.NewInlineKeyboardBase64` или `laniakea.NewInlineKeyboard`. `Bot.SetPayloadType(...)` задаёт payload format по умолчанию, а `InlineKeyboard.SetPayloadType(...)` переопределяет его для конкретной клавиатуры.
|
||||||
|
- **Ограничение запросов**: Передайте настроенный `utils.RateLimiter` через `BotOpts` для корректной обработки лимитов Telegram.
|
||||||
|
- **Локализация**: `L10n` безопасен для конкурентного использования после подключения к боту.
|
||||||
|
- **Пользовательские update handlers**: Используйте `plugin.AddUpdateHandler(...)` для Telegram update types вне command/payload flow.
|
||||||
|
- **Жизненный цикл**: `RunWithContext(...)` и `RunWebHookWithContext(...)` не вызывают `Close()` автоматически. Завершайте бот явно и создавайте новый `Bot` для следующего запуска.
|
||||||
|
|
||||||
|
## Обработка Telegram Updates
|
||||||
|
- Команды и payload-ы обрабатываются через плагины.
|
||||||
|
- Для некомандных update-ов можно зарегистрировать обработчик через `plugin.AddUpdateHandler(updateType, handler)`.
|
||||||
|
- `message`, `channel_post` и `callback_query` остаются в command/payload flow.
|
||||||
|
- После JSON-декодирования `tgapi.Update` заполняет поле `Type`, чтобы обработчики могли явно видеть итоговый вид update.
|
||||||
|
|
||||||
|
## 📝 Лицензия
|
||||||
|
Этот проект лицензирован под GNU General Public License v3.0 - подробности см. в файле [LICENSE](LICENSE).
|
||||||
|
|
||||||
|
## 📚 Дополнительная информация
|
||||||
|
[GoDoc Laniakea](https://pkg.go.dev/git.scuroneko.dev/scuroneko/laniakea)
|
||||||
|
|
||||||
|
[Wiki](https://git.scuroneko.dev/ScuroNeko/Laniakea/wiki)
|
||||||
|
|
||||||
|
[Telegram Bot API](https://core.telegram.org/bots/api)
|
||||||
|
|
||||||
|
✅ Создано с ❤️ scuroneko
|
||||||
@@ -0,0 +1,45 @@
|
|||||||
|
# Semantic Versioning Policy
|
||||||
|
|
||||||
|
This project follows Semantic Versioning with the rules below.
|
||||||
|
|
||||||
|
## Public API Surface
|
||||||
|
|
||||||
|
The public API consists of:
|
||||||
|
- exported identifiers in package `laniakea`
|
||||||
|
- exported identifiers in package `tgapi`
|
||||||
|
- documented behavior in `README.md`, `README_RU.md`, and package godoc
|
||||||
|
|
||||||
|
Anything unexported is internal and may change without notice.
|
||||||
|
|
||||||
|
## Breaking Changes
|
||||||
|
|
||||||
|
A release requires a major version bump when it changes any of the following:
|
||||||
|
- exported function, method, type, field, constant, or variable names
|
||||||
|
- function or method signatures
|
||||||
|
- JSON field names or request/response wire compatibility in `tgapi`
|
||||||
|
- documented behavioral guarantees relied on by callers
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
- removing an exported alias
|
||||||
|
- changing callback payload encoding defaults
|
||||||
|
- changing handler dispatch semantics in a way that breaks existing bots
|
||||||
|
|
||||||
|
## Minor Changes
|
||||||
|
|
||||||
|
A release uses a minor version bump for backward-compatible additions:
|
||||||
|
- new exported types, methods, helpers, or update handlers
|
||||||
|
- support for new Telegram Bot API fields or methods
|
||||||
|
- optional configuration knobs that do not change existing defaults
|
||||||
|
|
||||||
|
## Patch Changes
|
||||||
|
|
||||||
|
A release uses a patch version bump for backward-compatible fixes:
|
||||||
|
- bug fixes
|
||||||
|
- test-only changes
|
||||||
|
- godoc and README clarifications
|
||||||
|
- internal refactors with no public behavior change
|
||||||
|
|
||||||
|
## Pre-Releases
|
||||||
|
|
||||||
|
`-rc.N` builds may still adjust API details before `v1.0.0`.
|
||||||
|
Once `v1.0.0` is released, breaking changes require a new major version.
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
# TODO
|
||||||
|
|
||||||
|
The framework backlog has moved to the wiki.
|
||||||
|
|
||||||
|
Primary page:
|
||||||
|
|
||||||
|
- https://git.scuroneko.dev/ScuroNeko/Laniakea/wiki/Framework-Backlog
|
||||||
|
|
||||||
|
Russian page:
|
||||||
|
|
||||||
|
- https://git.scuroneko.dev/ScuroNeko/Laniakea/wiki/Framework-Backlog-RU
|
||||||
|
|
||||||
|
Current priority split:
|
||||||
|
|
||||||
|
- `Partial`: none.
|
||||||
|
- `Ideas`: service layer and dependency graph model, plugin composition contract.
|
||||||
|
|
||||||
|
Completed former high-priority items:
|
||||||
|
|
||||||
|
- `[v1.0.0-rc.14] Webhook runtime model.`
|
||||||
|
- `[v1.0.0-rc.13] Observability model`: added first-class `Observer` events for update, command, payload, scene, policy, runner, polling, and centralized error flows, with safe event dispatch and regression coverage for the new runtime hooks.
|
||||||
|
- `[v1.0.0-rc.13] Authorization and policy model`: added first-class `Policy[T]`, middleware integration through `RequirePolicy(...)`, plugin and bot policy registration helpers, built-in Telegram-aware policies, and composable `AllPolicies(...)`, `AnyPolicy(...)`, and `NotPolicy(...)` helpers with regression coverage.
|
||||||
|
- `[v1.0.0-rc.13] Update schema contract`: documented and tested the normalized `MsgContext` update-routing contract, including routing categories and per-update field guarantees.
|
||||||
|
- `[v1.0.0-rc.13] User-facing vs internal error model`: added explicit user-visible vs internal-only error markers and updated centralized handler error routing accordingly.
|
||||||
|
- `[v1.0.0-rc.13] Configuration freeze model`: formalized bot configuration freeze after first run, documented lifecycle commit points, and added regression coverage for ignored late mutations.
|
||||||
|
- `[v1.0.0-rc.12] Conversation / Scene Model`.
|
||||||
|
- `[v1.0.0-rc.12] Typed Handler Input Model`.
|
||||||
|
- `[v1.0.0-rc.12] Request Context / Cancellation Model`.
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 297 KiB |
+224
@@ -0,0 +1,224 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"slices"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
|
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||||
|
)
|
||||||
|
|
||||||
|
// AddPrefixes adds one or more command prefixes (e.g., "/", "!").
|
||||||
|
// The bot must have at least one prefix before any runtime entry point starts.
|
||||||
|
func (bot *Bot[T]) AddPrefixes(prefixes ...string) *Bot[T] {
|
||||||
|
if !bot.configMutable("AddPrefixes") {
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
bot.prefixes = append(bot.prefixes, prefixes...)
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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] {
|
||||||
|
if !bot.configMutable("SetDraftProvider") {
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
bot.draftProvider = p
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetDraftProvider returns the draft provider currently used by the bot.
|
||||||
|
func (bot *Bot[T]) GetDraftProvider() *DraftProvider {
|
||||||
|
return bot.draftProvider
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetObserver sets an event observer for instrumentation.
|
||||||
|
func (bot *Bot[T]) SetObserver(observer Observer) *Bot[T] {
|
||||||
|
if !bot.configMutable("SetObserver") {
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
if observer == nil {
|
||||||
|
if bot.logger != nil {
|
||||||
|
bot.logger.Warn("SetObserver called with nil observer; instrumentation will be disabled")
|
||||||
|
}
|
||||||
|
bot.observer = nil
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
bot.observer = observer
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetObserver returns the bot's event observer, or nil if no observer is set.
|
||||||
|
func (bot *Bot[T]) GetObserver() Observer {
|
||||||
|
return bot.observer
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetSessionStore replaces the session store used for scene management.
|
||||||
|
func (bot *Bot[T]) SetSessionStore(store SessionStore) *Bot[T] {
|
||||||
|
if !bot.configMutable("SetSessionStore") {
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
if store == nil {
|
||||||
|
bot.logger.Warn("SetSessionStore called with nil store; using default MemorySessionStore")
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
bot.sessionStore = store
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetSessionStore returns the session store used for scene management.
|
||||||
|
func (bot *Bot[T]) GetSessionStore() SessionStore {
|
||||||
|
return bot.sessionStore
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetSceneScopePriority sets the lookup order for resolving active scene sessions.
|
||||||
|
func (bot *Bot[T]) SetSceneScopePriority(priority []SceneScope) *Bot[T] {
|
||||||
|
if !bot.configMutable("SetSceneScopePriority") {
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
newPriority := make([]SceneScope, 0, 3)
|
||||||
|
for _, scope := range priority {
|
||||||
|
if scope != SceneScopeUser && scope != SceneScopeChat && scope != SceneScopeUserChat {
|
||||||
|
bot.logger.Warnln(fmt.Sprintf("invalid scene scope %v in priority list; ignoring", scope))
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if slices.Index(newPriority, scope) >= 0 {
|
||||||
|
bot.logger.Warnln(fmt.Sprintf("duplicate scope %v in scene scope priority; ignoring duplicates", scope))
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
newPriority = append(newPriority, scope)
|
||||||
|
}
|
||||||
|
if len(newPriority) == 0 || len(newPriority) > 3 {
|
||||||
|
bot.logger.Warnln("scene scope priority must have 1 to 3 scopes; ignoring invalid input")
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
bot.sceneScopePriority = append([]SceneScope(nil), newPriority...)
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetAppData injects shared application data into the bot.
|
||||||
|
//
|
||||||
|
// The data is accessible to commands, payload handlers, middleware, scenes,
|
||||||
|
// and runners through the generic type parameter T.
|
||||||
|
//
|
||||||
|
// For shared dependencies such as *sql.DB, prefer using a pointer type as T.
|
||||||
|
// Value-typed application data is supported, but the bot warns once because
|
||||||
|
// handlers receive T by value.
|
||||||
|
func (bot *Bot[T]) SetAppData(ctx T) *Bot[T] {
|
||||||
|
if !bot.configMutable("SetAppData") {
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
if !bot.warnedValueData && shouldWarnOnValueAppData[T]() && bot.logger != nil {
|
||||||
|
bot.logger.Warnln("app data uses a value type; shared dependencies should usually use a pointer type as T")
|
||||||
|
bot.warnedValueData = true
|
||||||
|
}
|
||||||
|
bot.appData = ctx
|
||||||
|
bot.hasAppData = true
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetAppData returns the injected application data.
|
||||||
|
// If SetAppData was not called, it returns the zero value of T.
|
||||||
|
func (bot *Bot[T]) GetAppData() T { return bot.appData }
|
||||||
|
|
||||||
|
// SetUpdateTypes sets the list of update types the bot will request from Telegram.
|
||||||
|
// Overwrites any previously set types.
|
||||||
|
func (bot *Bot[T]) SetUpdateTypes(t ...tgapi.UpdateType) *Bot[T] {
|
||||||
|
if !bot.configMutable("UpdateTypes") {
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
bot.updateTypes = make([]tgapi.UpdateType, 0)
|
||||||
|
bot.updateTypes = append(bot.updateTypes, t...)
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
|
||||||
|
// AddUpdateType adds one or more update types to the list.
|
||||||
|
// Does not overwrite existing types.
|
||||||
|
func (bot *Bot[T]) AddUpdateType(t ...tgapi.UpdateType) *Bot[T] {
|
||||||
|
if !bot.configMutable("AddUpdateType") {
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
bot.updateTypes = append(bot.updateTypes, t...)
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetUpdateTypes returns the list of update types the bot is configured to receive.
|
||||||
|
func (bot *Bot[T]) GetUpdateTypes() []tgapi.UpdateType {
|
||||||
|
return append([]tgapi.UpdateType(nil), bot.updateTypes...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetPayloadType sets the default payload encoding type used for callback data.
|
||||||
|
// JSON stores payload as a string: `{"cmd":"command","args":[...]}`.
|
||||||
|
// Base64 stores the same JSON encoded as a Base64URL string.
|
||||||
|
// InlineKeyboard.SetPayloadType may override this value for an individual keyboard.
|
||||||
|
func (bot *Bot[T]) SetPayloadType(t BotPayloadType) *Bot[T] {
|
||||||
|
if !bot.configMutable("SetPayloadType") {
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
bot.payloadType = t
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetPayloadType returns the bot's default callback payload encoding type.
|
||||||
|
func (bot *Bot[T]) GetPayloadType() BotPayloadType { return bot.payloadType }
|
||||||
|
|
||||||
|
// SetStrictPayloadType enables or disables strict callback payload decoding.
|
||||||
|
// When enabled, callback payloads must match the bot's default payload type.
|
||||||
|
func (bot *Bot[T]) SetStrictPayloadType(strict bool) *Bot[T] {
|
||||||
|
if !bot.configMutable("SetStrictPayloadType") {
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
bot.strictPayloadType = strict
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetErrorTemplate 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]) SetErrorTemplate(s string) *Bot[T] {
|
||||||
|
if !bot.configMutable("ErrorTemplate") {
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
bot.errorTemplate = s
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetDebug enables or disables debug logging.
|
||||||
|
func (bot *Bot[T]) SetDebug(debug bool) *Bot[T] {
|
||||||
|
bot.debug = debug
|
||||||
|
level := sneklog.FATAL
|
||||||
|
if debug {
|
||||||
|
level = sneklog.DEBUG
|
||||||
|
}
|
||||||
|
|
||||||
|
bot.logger.SetLevel(level)
|
||||||
|
if bot.requestLogger != nil {
|
||||||
|
bot.requestLogger.SetLevel(level)
|
||||||
|
}
|
||||||
|
for _, p := range bot.plugins {
|
||||||
|
if p.logger == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
p.logger.SetLevel(level)
|
||||||
|
}
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetL10n 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).
|
||||||
|
//
|
||||||
|
// Replaces any previously set L10n instance.
|
||||||
|
func (bot *Bot[T]) SetL10n(l *L10n) *Bot[T] {
|
||||||
|
if !bot.configMutable("SetL10n") {
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
if l == nil {
|
||||||
|
bot.logger.Warn("SetL10n called with nil L10n; localization will be disabled")
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
bot.l10n = l
|
||||||
|
return bot
|
||||||
|
}
|
||||||
+294
@@ -0,0 +1,294 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||||
|
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||||
|
)
|
||||||
|
|
||||||
|
// BotOpts holds configuration options for initializing a Bot.
|
||||||
|
//
|
||||||
|
// Values are loaded from environment variables via LoadOptsFromEnv().
|
||||||
|
// Use &BotOpts{} to create a value and set fields manually.
|
||||||
|
type BotOpts struct {
|
||||||
|
// Token is the Telegram bot token (required).
|
||||||
|
Token string
|
||||||
|
|
||||||
|
// UpdateTypes is a list of update types to listen for.
|
||||||
|
// Example: "["message", "edited_message", "callback_query"]"
|
||||||
|
// Defaults to empty (Telegram will return all types).
|
||||||
|
UpdateTypes []tgapi.UpdateType
|
||||||
|
|
||||||
|
// Debug enables debug-level logging.
|
||||||
|
Debug bool
|
||||||
|
|
||||||
|
// ErrorTemplate is the format string used to wrap error messages sent to users.
|
||||||
|
// Use "%s" to insert the actual error. Example: "❌ Error: %s"
|
||||||
|
ErrorTemplate string
|
||||||
|
|
||||||
|
// Prefixes is a list of command prefixes (e.g., ["/", "!"]).
|
||||||
|
// Defaults to ["/"] if not set via environment.
|
||||||
|
Prefixes []string
|
||||||
|
|
||||||
|
// LoggerBasePath is the directory where log files are written.
|
||||||
|
// Defaults to "./".
|
||||||
|
LoggerBasePath string
|
||||||
|
|
||||||
|
// UseRequestLogger enables detailed logging of all Telegram API requests.
|
||||||
|
UseRequestLogger bool
|
||||||
|
|
||||||
|
// WriteToFile enables writing logs to files (main.log and requests.log).
|
||||||
|
WriteToFile bool
|
||||||
|
|
||||||
|
// UseTestServer uses Telegram's test server (https://api.test.telegram.org).
|
||||||
|
UseTestServer bool
|
||||||
|
|
||||||
|
// APIURL overrides the default Telegram API endpoint (useful for proxies or self-hosted).
|
||||||
|
APIURL string
|
||||||
|
|
||||||
|
// RateLimit is the maximum number of API requests per second.
|
||||||
|
// Telegram allows up to 30 req/s for most bots. Defaults to 30.
|
||||||
|
RateLimit int
|
||||||
|
|
||||||
|
// DropRLOverflow drops incoming updates when rate limit is exceeded instead of queuing.
|
||||||
|
// Use this to prioritize responsiveness over reliability.
|
||||||
|
DropRLOverflow bool
|
||||||
|
|
||||||
|
// StrictPayloadType disables callback payload fallback decoding.
|
||||||
|
// When enabled, the bot accepts only the configured default payload type.
|
||||||
|
StrictPayloadType bool
|
||||||
|
|
||||||
|
// MaxWorkers is the maximum number of update handlers that may run concurrently.
|
||||||
|
MaxWorkers int
|
||||||
|
|
||||||
|
// FileConfigVersion stores the version declared by the config file used to
|
||||||
|
// load these options.
|
||||||
|
//
|
||||||
|
// It is zero when the options were not loaded from a versioned file.
|
||||||
|
FileConfigVersion int
|
||||||
|
|
||||||
|
LogFormat utils.LogFormat
|
||||||
|
LogFormatter *sneklog.Formatter
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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
|
||||||
|
// - STRICT_PAYLOAD_TYPE: "true" to reject callback payloads encoded in a different format
|
||||||
|
// - MAX_WORKERS: maximum number of concurrent update handlers (default: 32)
|
||||||
|
// - JSON_LOG:
|
||||||
|
//
|
||||||
|
// Returns a populated BotOpts.
|
||||||
|
// NewBot validates required fields and returns ErrTokenRequired when TG_TOKEN is missing.
|
||||||
|
func LoadOptsFromEnv() *BotOpts {
|
||||||
|
rateLimit := 30
|
||||||
|
maxWorkers := 32
|
||||||
|
|
||||||
|
stringUpdateTypes := splitEnvList(os.Getenv("UPDATE_TYPES"))
|
||||||
|
updateTypes := make([]tgapi.UpdateType, 0, len(stringUpdateTypes))
|
||||||
|
for _, updateType := range stringUpdateTypes {
|
||||||
|
updateTypes = append(updateTypes, tgapi.UpdateType(updateType))
|
||||||
|
}
|
||||||
|
|
||||||
|
if rl := os.Getenv("RATE_LIMIT"); rl != "" {
|
||||||
|
if n, err := strconv.Atoi(rl); err == nil {
|
||||||
|
rateLimit = n
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if mw := os.Getenv("MAX_WORKERS"); mw != "" {
|
||||||
|
if n, err := strconv.Atoi(os.Getenv("MAX_WORKERS")); err == nil {
|
||||||
|
maxWorkers = n
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return &BotOpts{
|
||||||
|
Token: os.Getenv("TG_TOKEN"),
|
||||||
|
UpdateTypes: updateTypes,
|
||||||
|
|
||||||
|
Debug: os.Getenv("DEBUG") == "true",
|
||||||
|
ErrorTemplate: os.Getenv("ERROR_TEMPLATE"),
|
||||||
|
Prefixes: LoadPrefixesFromEnv(),
|
||||||
|
|
||||||
|
LoggerBasePath: os.Getenv("LOGGER_BASE_PATH"),
|
||||||
|
UseRequestLogger: os.Getenv("USE_REQ_LOG") == "true",
|
||||||
|
WriteToFile: os.Getenv("WRITE_TO_FILE") == "true",
|
||||||
|
|
||||||
|
UseTestServer: os.Getenv("USE_TEST_SERVER") == "true",
|
||||||
|
APIURL: os.Getenv("API_URL"),
|
||||||
|
|
||||||
|
RateLimit: rateLimit,
|
||||||
|
DropRLOverflow: os.Getenv("DROP_RL_OVERFLOW") == "true",
|
||||||
|
StrictPayloadType: os.Getenv("STRICT_PAYLOAD_TYPE") == "true",
|
||||||
|
|
||||||
|
MaxWorkers: maxWorkers,
|
||||||
|
FileConfigVersion: 0,
|
||||||
|
LogFormat: utils.LogFormat(os.Getenv("LOG_FORMAT")),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetToken sets the Telegram bot token (required).
|
||||||
|
func (opts *BotOpts) SetToken(token string) *BotOpts {
|
||||||
|
opts.Token = token
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetUpdateTypes sets the list of update types to listen for.
|
||||||
|
// If empty (default), Telegram will return all update types.
|
||||||
|
// Example: opts.SetUpdateTypes("message", "callback_query").
|
||||||
|
func (opts *BotOpts) SetUpdateTypes(types ...tgapi.UpdateType) *BotOpts {
|
||||||
|
opts.UpdateTypes = types
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetDebug enables or disables debug-level logging.
|
||||||
|
// Default is false.
|
||||||
|
func (opts *BotOpts) SetDebug(debug bool) *BotOpts {
|
||||||
|
opts.Debug = debug
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetErrorTemplate sets the format string for error messages sent to users.
|
||||||
|
// Use "%s" to insert the actual error. Example: "❌ Error: %s"
|
||||||
|
// If not set, defaults to "%s".
|
||||||
|
func (opts *BotOpts) SetErrorTemplate(tpl string) *BotOpts {
|
||||||
|
opts.ErrorTemplate = tpl
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetPrefixes sets the command prefixes (e.g., "/", "!").
|
||||||
|
// If not set via environment, defaults to ["/"].
|
||||||
|
func (opts *BotOpts) SetPrefixes(prefixes ...string) *BotOpts {
|
||||||
|
opts.Prefixes = prefixes
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetLoggerBasePath sets the directory where log files are written.
|
||||||
|
// Defaults to "./".
|
||||||
|
func (opts *BotOpts) SetLoggerBasePath(path string) *BotOpts {
|
||||||
|
opts.LoggerBasePath = path
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetUseRequestLogger enables detailed logging of all Telegram API requests.
|
||||||
|
// Default is false.
|
||||||
|
func (opts *BotOpts) SetUseRequestLogger(use bool) *BotOpts {
|
||||||
|
opts.UseRequestLogger = use
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetWriteToFile enables writing logs to files (main.log and requests.log).
|
||||||
|
// Default is false.
|
||||||
|
func (opts *BotOpts) SetWriteToFile(write bool) *BotOpts {
|
||||||
|
opts.WriteToFile = write
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetUseTestServer enables using Telegram's test server (https://api.telegram.org/bot<token>/test).
|
||||||
|
// Default is false.
|
||||||
|
func (opts *BotOpts) SetUseTestServer(use bool) *BotOpts {
|
||||||
|
opts.UseTestServer = use
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetAPIURL overrides the default Telegram API endpoint (useful for proxies or self-hosted).
|
||||||
|
// If not set, defaults to "https://api.telegram.org".
|
||||||
|
func (opts *BotOpts) SetAPIURL(url string) *BotOpts {
|
||||||
|
opts.APIURL = url
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetRateLimit sets the maximum number of API requests per second.
|
||||||
|
// Telegram allows up to 30 req/s for most bots. Defaults to 30.
|
||||||
|
func (opts *BotOpts) SetRateLimit(limit int) *BotOpts {
|
||||||
|
opts.RateLimit = limit
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetDropRLOverflow drops incoming updates when rate limit is exceeded instead of queuing.
|
||||||
|
// Use this to prioritize responsiveness over reliability. Default is false.
|
||||||
|
func (opts *BotOpts) SetDropRLOverflow(drop bool) *BotOpts {
|
||||||
|
opts.DropRLOverflow = drop
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetStrictPayloadType enables or disables strict callback payload decoding.
|
||||||
|
// When enabled, the bot accepts only the configured default payload type.
|
||||||
|
func (opts *BotOpts) SetStrictPayloadType(strict bool) *BotOpts {
|
||||||
|
opts.StrictPayloadType = strict
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetMaxWorkers sets the maximum number of concurrent update handlers.
|
||||||
|
// Must be called before NewBot, as the value is captured during bot creation.
|
||||||
|
//
|
||||||
|
// The optimal value depends on your bot's workload:
|
||||||
|
// - For I/O-bound handlers (e.g., database queries, external API calls), you may
|
||||||
|
// need more workers, but be mindful of downstream service limits.
|
||||||
|
// - For CPU-bound handlers, keep workers close to the number of CPU cores.
|
||||||
|
//
|
||||||
|
// Recommended starting points (adjust based on profiling and monitoring):
|
||||||
|
// - Small to medium bots with fast handlers: 16–32
|
||||||
|
// - Medium to large bots with fast handlers: 32–64
|
||||||
|
// - Large bots with heavy I/O: 64–128 (ensure your infrastructure can handle it)
|
||||||
|
//
|
||||||
|
// The default is 32. Monitor queue length and processing latency to fine-tune.
|
||||||
|
func (opts *BotOpts) SetMaxWorkers(workers int) *BotOpts {
|
||||||
|
opts.MaxWorkers = workers
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
func (opts *BotOpts) SetLogFormat(format utils.LogFormat) *BotOpts {
|
||||||
|
opts.LogFormat = format
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
func (opts *BotOpts) SetLogFormatter(formatter *sneklog.Formatter) *BotOpts {
|
||||||
|
opts.LogFormatter = formatter
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// LoadPrefixesFromEnv returns the PREFIXES environment variable split by semicolon.
|
||||||
|
// Defaults to ["/"] if not set.
|
||||||
|
func LoadPrefixesFromEnv() []string {
|
||||||
|
prefixesS, exists := os.LookupEnv("PREFIXES")
|
||||||
|
if !exists {
|
||||||
|
return []string{"/"}
|
||||||
|
}
|
||||||
|
prefixes := splitEnvList(prefixesS)
|
||||||
|
if len(prefixes) == 0 {
|
||||||
|
return []string{"/"}
|
||||||
|
}
|
||||||
|
return prefixes
|
||||||
|
}
|
||||||
|
|
||||||
|
func splitEnvList(value string) []string {
|
||||||
|
if value == "" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
parts := strings.Split(value, ";")
|
||||||
|
out := make([]string, 0, len(parts))
|
||||||
|
for _, part := range parts {
|
||||||
|
part = strings.TrimSpace(part)
|
||||||
|
if part == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
out = append(out, part)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
@@ -0,0 +1,172 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"regexp"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ConfigVersion is the current version of the built-in JSON BotOpts file format.
|
||||||
|
const ConfigVersion = 1
|
||||||
|
|
||||||
|
// ErrConfigVersionMismatch reports that a config file declares a newer version
|
||||||
|
// than this library knows how to decode.
|
||||||
|
var ErrConfigVersionMismatch = fmt.Errorf("config version mismatch: expected %d", ConfigVersion)
|
||||||
|
|
||||||
|
type botOptsFileJSONLogger struct {
|
||||||
|
LoggerBasePath string `json:"base_path"`
|
||||||
|
UseRequestLogger bool `json:"use_request_logger"`
|
||||||
|
WriteToFile bool `json:"write_to_file"`
|
||||||
|
LogFormat utils.LogFormat `json:"log_format"`
|
||||||
|
}
|
||||||
|
type botOptsFileJSONAPI struct {
|
||||||
|
UseTestServer bool `json:"use_test_server"`
|
||||||
|
APIURL string `json:"url"`
|
||||||
|
RateLimit int `json:"rate_limit"`
|
||||||
|
DropRLOverflow bool `json:"drop_overflow"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// BotOptsFileJSON is the JSON file representation of BotOpts.
|
||||||
|
type BotOptsFileJSON struct {
|
||||||
|
Version int `json:"version"`
|
||||||
|
Token string `json:"token"`
|
||||||
|
UpdateTypes []tgapi.UpdateType `json:"update_types"`
|
||||||
|
Debug bool `json:"debug"`
|
||||||
|
ErrorTemplate string `json:"error_template"`
|
||||||
|
Prefixes []string `json:"prefixes"`
|
||||||
|
Logger botOptsFileJSONLogger `json:"logger"`
|
||||||
|
API botOptsFileJSONAPI `json:"api"`
|
||||||
|
StrictPayloadType bool `json:"strict_payload_type"`
|
||||||
|
MaxWorkers int `json:"max_workers"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// BotOptsFileJSONCodec encodes and decodes BotOpts using BotOptsFileJSON.
|
||||||
|
type BotOptsFileJSONCodec struct{}
|
||||||
|
|
||||||
|
// FromBytes decodes BotOpts from JSON file bytes.
|
||||||
|
func (codec BotOptsFileJSONCodec) FromBytes(data []byte) (*BotOpts, error) {
|
||||||
|
fileOpts := new(BotOptsFileJSON)
|
||||||
|
err := json.Unmarshal(data, fileOpts)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if fileOpts.Version > ConfigVersion {
|
||||||
|
return nil, ErrConfigVersionMismatch
|
||||||
|
}
|
||||||
|
opts := &BotOpts{
|
||||||
|
Token: fileOpts.Token,
|
||||||
|
UpdateTypes: fileOpts.UpdateTypes,
|
||||||
|
Debug: fileOpts.Debug,
|
||||||
|
ErrorTemplate: fileOpts.ErrorTemplate,
|
||||||
|
Prefixes: fileOpts.Prefixes,
|
||||||
|
|
||||||
|
LoggerBasePath: fileOpts.Logger.LoggerBasePath,
|
||||||
|
UseRequestLogger: fileOpts.Logger.UseRequestLogger,
|
||||||
|
WriteToFile: fileOpts.Logger.WriteToFile,
|
||||||
|
LogFormat: fileOpts.Logger.LogFormat,
|
||||||
|
|
||||||
|
UseTestServer: fileOpts.API.UseTestServer,
|
||||||
|
APIURL: fileOpts.API.APIURL,
|
||||||
|
RateLimit: fileOpts.API.RateLimit,
|
||||||
|
DropRLOverflow: fileOpts.API.DropRLOverflow,
|
||||||
|
|
||||||
|
StrictPayloadType: fileOpts.StrictPayloadType,
|
||||||
|
MaxWorkers: fileOpts.MaxWorkers,
|
||||||
|
|
||||||
|
FileConfigVersion: fileOpts.Version,
|
||||||
|
}
|
||||||
|
return opts, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ToBytes encodes BotOpts into JSON file bytes.
|
||||||
|
func (codec BotOptsFileJSONCodec) ToBytes(opts *BotOpts) ([]byte, error) {
|
||||||
|
fileOpts := &BotOptsFileJSON{
|
||||||
|
Version: ConfigVersion,
|
||||||
|
Token: opts.Token,
|
||||||
|
UpdateTypes: opts.UpdateTypes,
|
||||||
|
Debug: opts.Debug,
|
||||||
|
ErrorTemplate: opts.ErrorTemplate,
|
||||||
|
Prefixes: opts.Prefixes,
|
||||||
|
Logger: botOptsFileJSONLogger{
|
||||||
|
LoggerBasePath: opts.LoggerBasePath,
|
||||||
|
UseRequestLogger: opts.UseRequestLogger,
|
||||||
|
WriteToFile: opts.WriteToFile,
|
||||||
|
LogFormat: opts.LogFormat,
|
||||||
|
},
|
||||||
|
API: botOptsFileJSONAPI{
|
||||||
|
UseTestServer: opts.UseTestServer,
|
||||||
|
APIURL: opts.APIURL,
|
||||||
|
RateLimit: opts.RateLimit,
|
||||||
|
DropRLOverflow: opts.DropRLOverflow,
|
||||||
|
},
|
||||||
|
StrictPayloadType: opts.StrictPayloadType,
|
||||||
|
MaxWorkers: opts.MaxWorkers,
|
||||||
|
}
|
||||||
|
data, err := json.Marshal(fileOpts)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return data, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (codec BotOptsFileJSONCodec) Load(filename string) (*BotOpts, error) {
|
||||||
|
return LoadBotOptsFile(codec, filename)
|
||||||
|
}
|
||||||
|
func (codec BotOptsFileJSONCodec) Save(filename string, opts *BotOpts) error {
|
||||||
|
return SaveBotOptsFile(codec, filename, opts)
|
||||||
|
}
|
||||||
|
|
||||||
|
var envParameterRegex = regexp.MustCompile(`\{\{\s*(\w+)\s*\}\}`)
|
||||||
|
|
||||||
|
// BotOptsFileCodec decodes and encodes BotOpts file formats.
|
||||||
|
type BotOptsFileCodec interface {
|
||||||
|
FromBytes([]byte) (*BotOpts, error)
|
||||||
|
ToBytes(*BotOpts) ([]byte, error)
|
||||||
|
Load(filename string) (*BotOpts, error)
|
||||||
|
Save(filename string, opts *BotOpts) error
|
||||||
|
}
|
||||||
|
|
||||||
|
// LoadBotOptsFile reads a config file, expands env placeholders, and decodes BotOpts.
|
||||||
|
func LoadBotOptsFile(codec BotOptsFileCodec, filename string) (*BotOpts, error) {
|
||||||
|
f, err := os.Open(filename)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
defer func() { _ = f.Close() }()
|
||||||
|
data, err := io.ReadAll(f)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
data = expandEnvPlaceholdersInFile(data)
|
||||||
|
return codec.FromBytes(data)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SaveBotOptsFile encodes BotOpts with codec and writes the result to filename.
|
||||||
|
func SaveBotOptsFile(codec BotOptsFileCodec, filename string, opts *BotOpts) error {
|
||||||
|
data, err := codec.ToBytes(opts)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
err = os.WriteFile(filename, data, 0644)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func expandEnvPlaceholdersInFile(data []byte) []byte {
|
||||||
|
return envParameterRegex.ReplaceAllFunc(data, func(match []byte) []byte {
|
||||||
|
group := envParameterRegex.FindSubmatch(match)
|
||||||
|
if len(group) != 2 {
|
||||||
|
return match
|
||||||
|
}
|
||||||
|
key := group[1]
|
||||||
|
value := os.Getenv(string(key))
|
||||||
|
return []byte(value)
|
||||||
|
})
|
||||||
|
}
|
||||||
@@ -0,0 +1,139 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"reflect"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestBotOptsFileJSONCodecRoundTrip(t *testing.T) {
|
||||||
|
codec := BotOptsFileJSONCodec{}
|
||||||
|
want := &BotOpts{
|
||||||
|
Token: "TOKEN",
|
||||||
|
UpdateTypes: []tgapi.UpdateType{tgapi.UpdateTypeMessage, tgapi.UpdateTypeCallbackQuery},
|
||||||
|
Debug: true,
|
||||||
|
ErrorTemplate: "Error: %s",
|
||||||
|
Prefixes: []string{"/", "!"},
|
||||||
|
LoggerBasePath: "/tmp/logs",
|
||||||
|
UseRequestLogger: true,
|
||||||
|
WriteToFile: true,
|
||||||
|
UseTestServer: true,
|
||||||
|
APIURL: "https://api.example.invalid",
|
||||||
|
RateLimit: 42,
|
||||||
|
DropRLOverflow: true,
|
||||||
|
StrictPayloadType: true,
|
||||||
|
MaxWorkers: 64,
|
||||||
|
FileConfigVersion: ConfigVersion,
|
||||||
|
}
|
||||||
|
|
||||||
|
data, err := codec.ToBytes(want)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("ToBytes returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
got, err := codec.FromBytes(data)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("FromBytes returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !reflect.DeepEqual(got, want) {
|
||||||
|
t.Fatalf("round-trip mismatch:\n got: %#v\nwant: %#v", got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadBotOptsFileExpandsEnvPlaceholders(t *testing.T) {
|
||||||
|
t.Setenv("TG_TOKEN", "TOKEN_FROM_ENV")
|
||||||
|
t.Setenv("BOT_API_URL", "https://api.example.invalid")
|
||||||
|
|
||||||
|
dir := t.TempDir()
|
||||||
|
filename := filepath.Join(dir, "config.json")
|
||||||
|
data := []byte(`{
|
||||||
|
"token": "{{ TG_TOKEN }}",
|
||||||
|
"api": {
|
||||||
|
"url": "{{BOT_API_URL}}"
|
||||||
|
},
|
||||||
|
"error_template": "Error: %s"
|
||||||
|
}`)
|
||||||
|
if err := os.WriteFile(filename, data, 0o644); err != nil {
|
||||||
|
t.Fatalf("WriteFile returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
got, err := LoadBotOptsFile(BotOptsFileJSONCodec{}, filename)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("LoadBotOptsFile returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if got.Token != "TOKEN_FROM_ENV" {
|
||||||
|
t.Fatalf("unexpected token: got %q want %q", got.Token, "TOKEN_FROM_ENV")
|
||||||
|
}
|
||||||
|
if got.APIURL != "https://api.example.invalid" {
|
||||||
|
t.Fatalf("unexpected api url: got %q want %q", got.APIURL, "https://api.example.invalid")
|
||||||
|
}
|
||||||
|
if got.ErrorTemplate != "Error: %s" {
|
||||||
|
t.Fatalf("unexpected error template: got %q", got.ErrorTemplate)
|
||||||
|
}
|
||||||
|
if got.FileConfigVersion != 0 {
|
||||||
|
t.Fatalf("unexpected file config version: got %d want 0", got.FileConfigVersion)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadBotOptsFileReturnsDecodeError(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
filename := filepath.Join(dir, "config.json")
|
||||||
|
if err := os.WriteFile(filename, []byte(`{"token":`), 0o644); err != nil {
|
||||||
|
t.Fatalf("WriteFile returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, err := LoadBotOptsFile(BotOptsFileJSONCodec{}, filename); err == nil {
|
||||||
|
t.Fatal("expected decode error, got nil")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSaveBotOptsFileWritesEncodedData(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
filename := filepath.Join(dir, "config.json")
|
||||||
|
want := &BotOpts{
|
||||||
|
Token: "TOKEN",
|
||||||
|
UpdateTypes: []tgapi.UpdateType{tgapi.UpdateTypeMessage},
|
||||||
|
ErrorTemplate: "Error: %s",
|
||||||
|
Prefixes: []string{"/"},
|
||||||
|
APIURL: "https://api.example.invalid",
|
||||||
|
RateLimit: 30,
|
||||||
|
MaxWorkers: 32,
|
||||||
|
FileConfigVersion: ConfigVersion,
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := SaveBotOptsFile(BotOptsFileJSONCodec{}, filename, want); err != nil {
|
||||||
|
t.Fatalf("SaveBotOptsFile returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
got, err := LoadBotOptsFile(BotOptsFileJSONCodec{}, filename)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("LoadBotOptsFile returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !reflect.DeepEqual(got, want) {
|
||||||
|
t.Fatalf("saved file mismatch:\n got: %#v\nwant: %#v", got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadBotOptsFileRejectsFutureConfigVersion(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
filename := filepath.Join(dir, "config.json")
|
||||||
|
data := []byte(`{
|
||||||
|
"version": 2,
|
||||||
|
"token": "TOKEN"
|
||||||
|
}`)
|
||||||
|
if err := os.WriteFile(filename, data, 0o644); err != nil {
|
||||||
|
t.Fatalf("WriteFile returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err := LoadBotOptsFile(BotOptsFileJSONCodec{}, filename)
|
||||||
|
if !errors.Is(err, ErrConfigVersionMismatch) {
|
||||||
|
t.Fatalf("expected ErrConfigVersionMismatch, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,56 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"reflect"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestLoadOptsFromEnvIgnoresEmptyUpdateTypes(t *testing.T) {
|
||||||
|
t.Setenv("UPDATE_TYPES", "")
|
||||||
|
|
||||||
|
opts := LoadOptsFromEnv()
|
||||||
|
if len(opts.UpdateTypes) != 0 {
|
||||||
|
t.Fatalf("expected no update types, got %v", opts.UpdateTypes)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadOptsFromEnvSplitsAndTrimsUpdateTypes(t *testing.T) {
|
||||||
|
t.Setenv("UPDATE_TYPES", "message; ; callback_query ")
|
||||||
|
|
||||||
|
opts := LoadOptsFromEnv()
|
||||||
|
want := []tgapi.UpdateType{tgapi.UpdateTypeMessage, tgapi.UpdateTypeCallbackQuery}
|
||||||
|
if !reflect.DeepEqual(opts.UpdateTypes, want) {
|
||||||
|
t.Fatalf("unexpected update types: got %v want %v", opts.UpdateTypes, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadPrefixesFromEnvDefaultsOnEmptyValue(t *testing.T) {
|
||||||
|
t.Setenv("PREFIXES", "")
|
||||||
|
|
||||||
|
got := LoadPrefixesFromEnv()
|
||||||
|
want := []string{"/"}
|
||||||
|
if !reflect.DeepEqual(got, want) {
|
||||||
|
t.Fatalf("unexpected prefixes: got %v want %v", got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadPrefixesFromEnvDropsEmptyValues(t *testing.T) {
|
||||||
|
t.Setenv("PREFIXES", "/; ; ! ")
|
||||||
|
|
||||||
|
got := LoadPrefixesFromEnv()
|
||||||
|
want := []string{"/", "!"}
|
||||||
|
if !reflect.DeepEqual(got, want) {
|
||||||
|
t.Fatalf("unexpected prefixes: got %v want %v", got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadOptsFromEnvReadsStrictPayloadType(t *testing.T) {
|
||||||
|
t.Setenv("STRICT_PAYLOAD_TYPE", "true")
|
||||||
|
|
||||||
|
opts := LoadOptsFromEnv()
|
||||||
|
if !opts.StrictPayloadType {
|
||||||
|
t.Fatal("expected StrictPayloadType to be enabled")
|
||||||
|
}
|
||||||
|
}
|
||||||
+160
@@ -0,0 +1,160 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"sort"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||||
|
)
|
||||||
|
|
||||||
|
// AddPlugins registers one or more plugins.
|
||||||
|
// Plugins are executed in registration order unless filtered by middleware.
|
||||||
|
//
|
||||||
|
// Registration is a commit point for plugin configuration. The Bot stores
|
||||||
|
// plugin metadata internally, so plugins must be fully configured before they
|
||||||
|
// are passed here. Post-registration mutation through the original *Plugin is
|
||||||
|
// not a supported API, even if some changes appear to work due to shared maps.
|
||||||
|
func (bot *Bot[T]) AddPlugins(plugin ...*Plugin[T]) *Bot[T] {
|
||||||
|
if !bot.configMutable("AddPlugins") {
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
level := bot.GetLoggerLevel()
|
||||||
|
for _, p := range plugin {
|
||||||
|
if p == nil {
|
||||||
|
if bot.logger != nil {
|
||||||
|
bot.logger.Warn("nil plugin skipped")
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
cloned := clonePlugin(p)
|
||||||
|
if cloned.logger == nil {
|
||||||
|
cloned.logger = utils.CreateLogger(cloned.name, level, bot.logFormat, bot.logFormatter)
|
||||||
|
}
|
||||||
|
bot.addTokenReplacer(cloned.logger)
|
||||||
|
bot.plugins = append(bot.plugins, cloned)
|
||||||
|
if bot.logger != nil {
|
||||||
|
bot.logger.Debugln(fmt.Sprintf("plugins with name \"%s\" registered", cloned.name))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
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)
|
||||||
|
//
|
||||||
|
// Middleware with an empty name are skipped with a warning.
|
||||||
|
func (bot *Bot[T]) AddMiddleware(middleware ...Middleware[T]) *Bot[T] {
|
||||||
|
if !bot.configMutable("AddMiddleware") {
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
for _, m := range middleware {
|
||||||
|
if m.name == "" {
|
||||||
|
bot.logger.Warnln("middleware must have a non-empty name")
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
bot.middlewares = append(bot.middlewares, m)
|
||||||
|
bot.logger.Debugln(fmt.Sprintf("middleware with name \"%s\" registered", m.name))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Stable sort by order (ascending), then by name (lexicographic)
|
||||||
|
sort.Slice(bot.middlewares, func(i, j int) bool {
|
||||||
|
first := bot.middlewares[i]
|
||||||
|
second := bot.middlewares[j]
|
||||||
|
if first.order != second.order {
|
||||||
|
return first.order < second.order
|
||||||
|
}
|
||||||
|
return first.name < second.name
|
||||||
|
})
|
||||||
|
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
|
||||||
|
// UsePolicy registers a Policy as a bot-level middleware.
|
||||||
|
func (bot *Bot[T]) UsePolicy(name string, policy Policy[T]) *Bot[T] {
|
||||||
|
mw := RequirePolicy(name, policy)
|
||||||
|
return bot.AddMiddleware(mw)
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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 start from the bot runtime entry points, immediately after
|
||||||
|
// RunWithContext or RunWebHookWithContext begins.
|
||||||
|
//
|
||||||
|
// Example:
|
||||||
|
//
|
||||||
|
// bot.AddRunner(cleanupRunner)
|
||||||
|
//
|
||||||
|
// Runners with an empty name are skipped with a warning.
|
||||||
|
func (bot *Bot[T]) AddRunner(runner Runner[T]) *Bot[T] {
|
||||||
|
if !bot.configMutable("AddRunner") {
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
if runner.name == "" {
|
||||||
|
bot.logger.Warnln("runner must have a non-empty name")
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
bot.runners = append(bot.runners, runner)
|
||||||
|
bot.logger.Debugln(fmt.Sprintf("runner with name \"%s\" registered", runner.name))
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
|
||||||
|
// AddAppDataLoggerWriter adds an app-data-backed logger writer to all loggers.
|
||||||
|
//
|
||||||
|
// The writer will receive logs from:
|
||||||
|
// - Main bot logger
|
||||||
|
// - Request logger (if enabled)
|
||||||
|
// - API and Uploader loggers
|
||||||
|
// - Already registered plugin loggers
|
||||||
|
//
|
||||||
|
// Call this after AddPlugins if plugin loggers should also receive the writer.
|
||||||
|
// Plugins registered later do not automatically inherit previously added
|
||||||
|
// writers; call AddAppDataLoggerWriter again after adding them.
|
||||||
|
//
|
||||||
|
// Example:
|
||||||
|
//
|
||||||
|
// bot.AddAppDataLoggerWriter(func(data *MyAppData) sneklog.LoggerWriter {
|
||||||
|
// return data.QueryLogger()
|
||||||
|
// })
|
||||||
|
func (bot *Bot[T]) AddAppDataLoggerWriter(writer AppDataLogger[T]) *Bot[T] {
|
||||||
|
if !bot.hasAppData {
|
||||||
|
bot.logger.Warnln("app data is not set; skipping app-data logger writer")
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
if isNilValue(bot.appData) {
|
||||||
|
bot.logger.Warnln("app data is nil; skipping app-data logger writer")
|
||||||
|
return bot
|
||||||
|
}
|
||||||
|
w := writer(bot.appData)
|
||||||
|
bot.logger.AddWriters(w)
|
||||||
|
if bot.requestLogger != nil {
|
||||||
|
bot.requestLogger.AddWriters(w)
|
||||||
|
}
|
||||||
|
for _, l := range bot.managedExtraLoggers() {
|
||||||
|
l.AddWriters(w)
|
||||||
|
}
|
||||||
|
for _, p := range bot.plugins {
|
||||||
|
if p.logger != nil {
|
||||||
|
p.logger.AddWriters(w)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
bot.addTokenReplacer(bot.logger, bot.requestLogger)
|
||||||
|
bot.addTokenReplacer(bot.managedExtraLoggers()...)
|
||||||
|
return bot
|
||||||
|
}
|
||||||
@@ -0,0 +1,59 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
func (bot *Bot[T]) getSession(key string) (SceneSession, error) {
|
||||||
|
return bot.sessionStore.Get(key)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) setSession(key string, session SceneSession) error {
|
||||||
|
return bot.sessionStore.Set(key, session)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) deleteSession(key string) error {
|
||||||
|
return bot.sessionStore.Delete(key)
|
||||||
|
}
|
||||||
|
func (bot *Bot[T]) findScene(name string) (*sceneMeta, bool) {
|
||||||
|
for _, plugin := range bot.plugins {
|
||||||
|
scene, ok := plugin.scenes[name]
|
||||||
|
if !ok {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
steps := make(map[string]struct{}, len(scene.steps))
|
||||||
|
for step := range scene.steps {
|
||||||
|
steps[step] = struct{}{}
|
||||||
|
}
|
||||||
|
|
||||||
|
return &sceneMeta{
|
||||||
|
Name: scene.Name,
|
||||||
|
Scope: scene.Scope,
|
||||||
|
Entry: scene.Entry,
|
||||||
|
Steps: steps,
|
||||||
|
}, true
|
||||||
|
}
|
||||||
|
return nil, false
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) findSceneSession(ctx *MsgContext) (string, SceneSession, error) {
|
||||||
|
var zero SceneSession
|
||||||
|
|
||||||
|
for _, scope := range bot.sceneScopePriority {
|
||||||
|
key, ok := buildSceneKey(scope, ctx)
|
||||||
|
if !ok {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
session, err := bot.sessionStore.Get(key)
|
||||||
|
if err != nil {
|
||||||
|
return "", zero, err
|
||||||
|
}
|
||||||
|
if session.Scene != "" {
|
||||||
|
return key, session, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return "", zero, ErrCantFindSession
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) buildSceneKey(scope SceneScope, ctx *MsgContext) (string, bool) {
|
||||||
|
return buildSceneKey(scope, ctx)
|
||||||
|
}
|
||||||
+785
@@ -0,0 +1,785 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
|
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||||
|
)
|
||||||
|
|
||||||
|
type pollingRoundTripFunc func(*http.Request) (*http.Response, error)
|
||||||
|
|
||||||
|
func (f pollingRoundTripFunc) RoundTrip(req *http.Request) (*http.Response, error) {
|
||||||
|
return f(req)
|
||||||
|
}
|
||||||
|
|
||||||
|
type pollingRetryObserver struct {
|
||||||
|
recordingObserver
|
||||||
|
cancel context.CancelFunc
|
||||||
|
cancelAfter int
|
||||||
|
}
|
||||||
|
|
||||||
|
func (o *pollingRetryObserver) OnPollingRetry(ctx context.Context, ev PollingRetryEvent) {
|
||||||
|
o.recordingObserver.OnPollingRetry(ctx, ev)
|
||||||
|
if o.cancel != nil && (o.cancelAfter == 0 || len(o.retries) >= o.cancelAfter) {
|
||||||
|
o.cancel()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type testObserver struct{}
|
||||||
|
|
||||||
|
func (testObserver) OnReceiveUpdate(context.Context, UpdateReceivedEvent) {}
|
||||||
|
func (testObserver) OnHandledUpdate(context.Context, UpdateHandledEvent) {}
|
||||||
|
func (testObserver) OnHandlerStarted(context.Context, HandlerStartedEvent) {}
|
||||||
|
func (testObserver) OnHandlerFinished(context.Context, HandlerFinishedEvent) {
|
||||||
|
}
|
||||||
|
func (testObserver) OnSceneTransition(context.Context, SceneTransitionEvent) {}
|
||||||
|
func (testObserver) OnPolicyChecked(context.Context, PolicyCheckedEvent) {}
|
||||||
|
func (testObserver) OnRunnerFinished(context.Context, RunnerFinishedEvent) {}
|
||||||
|
func (testObserver) OnPollingRetry(context.Context, PollingRetryEvent) {}
|
||||||
|
func (testObserver) OnError(context.Context, ErrorEvent) {}
|
||||||
|
|
||||||
|
func TestGetUpdateTypesReturnsCopy(t *testing.T) {
|
||||||
|
bot := &Bot[NoData]{updateTypes: []tgapi.UpdateType{tgapi.UpdateTypeMessage}}
|
||||||
|
|
||||||
|
got := bot.GetUpdateTypes()
|
||||||
|
got[0] = tgapi.UpdateTypeCallbackQuery
|
||||||
|
|
||||||
|
if want := []tgapi.UpdateType{tgapi.UpdateTypeMessage}; !reflect.DeepEqual(bot.updateTypes, want) {
|
||||||
|
t.Fatalf("GetUpdateTypes exposed internal slice: got %v want %v", bot.updateTypes, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAddPluginsSnapshotsConfiguration(t *testing.T) {
|
||||||
|
bot := &Bot[NoData]{logger: sneklog.NewLogger()}
|
||||||
|
plugin := NewPlugin[NoData]("demo")
|
||||||
|
|
||||||
|
cmd := plugin.NewCommand(func(ctx *MsgContext, db NoData) error { return nil }, "start")
|
||||||
|
plugin.AddMiddleware(NewMiddleware("base", func(ctx *MsgContext, db NoData) bool { return true }))
|
||||||
|
|
||||||
|
bot.AddPlugins(plugin)
|
||||||
|
|
||||||
|
cmd.SetDescription("mutated after registration")
|
||||||
|
plugin.NewCommand(func(ctx *MsgContext, db NoData) error { return nil }, "late")
|
||||||
|
plugin.AddMiddleware(NewMiddleware("late", func(ctx *MsgContext, db NoData) bool { return true }))
|
||||||
|
|
||||||
|
registered := bot.plugins[0]
|
||||||
|
if _, exists := registered.commands["late"]; exists {
|
||||||
|
t.Fatal("late command leaked into registered plugin snapshot")
|
||||||
|
}
|
||||||
|
if registered.commands["start"].description != "" {
|
||||||
|
t.Fatalf("registered command description unexpectedly mutated: %q", registered.commands["start"].description)
|
||||||
|
}
|
||||||
|
if len(registered.middlewares) != 1 {
|
||||||
|
t.Fatalf("registered middlewares unexpectedly mutated: got %d want 1", len(registered.middlewares))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBotPayloadTypeConfiguration(t *testing.T) {
|
||||||
|
bot := &Bot[NoData]{payloadType: BotPayloadBase64}
|
||||||
|
|
||||||
|
if got := bot.GetPayloadType(); got != BotPayloadBase64 {
|
||||||
|
t.Fatalf("unexpected initial payload type: %q", got)
|
||||||
|
}
|
||||||
|
bot.SetPayloadType(BotPayloadJSON)
|
||||||
|
if got := bot.GetPayloadType(); got != BotPayloadJSON {
|
||||||
|
t.Fatalf("unexpected updated payload type: %q", got)
|
||||||
|
}
|
||||||
|
bot.SetStrictPayloadType(true)
|
||||||
|
if !bot.strictPayloadType {
|
||||||
|
t.Fatal("expected strict payload type to be enabled")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAddPluginsSkipsNilPlugin(t *testing.T) {
|
||||||
|
bot := &Bot[NoData]{logger: sneklog.NewLogger()}
|
||||||
|
plugin := NewPlugin[NoData]("demo")
|
||||||
|
|
||||||
|
bot.AddPlugins(nil, plugin)
|
||||||
|
|
||||||
|
if len(bot.plugins) != 1 {
|
||||||
|
t.Fatalf("expected exactly one registered plugin, got %d", len(bot.plugins))
|
||||||
|
}
|
||||||
|
if bot.plugins[0].name != "demo" {
|
||||||
|
t.Fatalf("unexpected plugin name: %q", bot.plugins[0].name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInitLoggersFallsBackToStdoutLoggerOnFileError(t *testing.T) {
|
||||||
|
bot := &Bot[NoData]{}
|
||||||
|
|
||||||
|
bot.initLoggers(&BotOpts{
|
||||||
|
Debug: true,
|
||||||
|
WriteToFile: true,
|
||||||
|
UseRequestLogger: true,
|
||||||
|
LoggerBasePath: filepath.Join(t.TempDir(), "missing", "nested"),
|
||||||
|
})
|
||||||
|
|
||||||
|
if bot.logger == nil {
|
||||||
|
t.Fatal("expected main logger fallback")
|
||||||
|
}
|
||||||
|
if bot.requestLogger == nil {
|
||||||
|
t.Fatal("expected request logger fallback")
|
||||||
|
}
|
||||||
|
if err := bot.requestLogger.Close(); err != nil {
|
||||||
|
t.Fatalf("failed to close request logger: %v", err)
|
||||||
|
}
|
||||||
|
if err := bot.logger.Close(); err != nil {
|
||||||
|
t.Fatalf("failed to close main logger: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInitLoggersAppliesTokenReplacerToFileLoggers(t *testing.T) {
|
||||||
|
tempDir := t.TempDir()
|
||||||
|
api := tgapi.NewAPI(tgapi.NewAPIOpts("secret-token"))
|
||||||
|
uploader := tgapi.NewUploader(api)
|
||||||
|
bot := &Bot[NoData]{token: "secret-token", api: api, uploader: uploader}
|
||||||
|
t.Cleanup(func() {
|
||||||
|
if err := uploader.Close(); err != nil {
|
||||||
|
t.Fatalf("failed to close uploader: %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
t.Cleanup(func() {
|
||||||
|
if err := api.Close(); err != nil {
|
||||||
|
t.Fatalf("failed to close api: %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
bot.initLoggers(&BotOpts{
|
||||||
|
Debug: true,
|
||||||
|
WriteToFile: true,
|
||||||
|
UseRequestLogger: true,
|
||||||
|
LoggerBasePath: tempDir,
|
||||||
|
})
|
||||||
|
|
||||||
|
apiPath := filepath.Join(tempDir, "api.log")
|
||||||
|
apiFile, err := os.OpenFile(apiPath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to open api log: %v", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = apiFile.Close() }()
|
||||||
|
bot.api.GetLogger().AddWriters(bot.api.GetLogger().CreateTextWriter(apiFile))
|
||||||
|
|
||||||
|
uploaderPath := filepath.Join(tempDir, "uploader.log")
|
||||||
|
uploaderFile, err := os.OpenFile(uploaderPath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to open uploader log: %v", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = uploaderFile.Close() }()
|
||||||
|
bot.uploader.GetLogger().AddWriters(bot.uploader.GetLogger().CreateTextWriter(uploaderFile))
|
||||||
|
|
||||||
|
bot.logger.Infoln("main secret-token")
|
||||||
|
bot.requestLogger.Infoln("request secret-token")
|
||||||
|
bot.api.GetLogger().Infoln("api secret-token")
|
||||||
|
bot.uploader.GetLogger().Infoln("uploader secret-token")
|
||||||
|
|
||||||
|
if err := bot.requestLogger.Close(); err != nil {
|
||||||
|
t.Fatalf("failed to close request logger: %v", err)
|
||||||
|
}
|
||||||
|
if err := bot.logger.Close(); err != nil {
|
||||||
|
t.Fatalf("failed to close main logger: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
mainLog, err := os.ReadFile(filepath.Join(tempDir, "main.log"))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to read main log: %v", err)
|
||||||
|
}
|
||||||
|
requestLog, err := os.ReadFile(filepath.Join(tempDir, "requests.log"))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to read request log: %v", err)
|
||||||
|
}
|
||||||
|
apiLog, err := os.ReadFile(apiPath)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to read api log: %v", err)
|
||||||
|
}
|
||||||
|
uploaderLog, err := os.ReadFile(uploaderPath)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to read uploader log: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range []struct {
|
||||||
|
name string
|
||||||
|
data string
|
||||||
|
}{
|
||||||
|
{name: "main", data: string(mainLog)},
|
||||||
|
{name: "request", data: string(requestLog)},
|
||||||
|
{name: "api", data: string(apiLog)},
|
||||||
|
{name: "uploader", data: string(uploaderLog)},
|
||||||
|
} {
|
||||||
|
if strings.Contains(tt.data, "secret-token") {
|
||||||
|
t.Fatalf("%s log leaked raw token: %q", tt.name, tt.data)
|
||||||
|
}
|
||||||
|
if !strings.Contains(tt.data, "<TOKEN>") {
|
||||||
|
t.Fatalf("%s log did not contain masked token: %q", tt.name, tt.data)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAddPluginsAppliesTokenReplacerToPluginLogger(t *testing.T) {
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
token: "secret-token",
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
}
|
||||||
|
defer func() { _ = bot.logger.Close() }()
|
||||||
|
|
||||||
|
plugin := NewPlugin[NoData]("demo")
|
||||||
|
bot.AddPlugins(plugin)
|
||||||
|
|
||||||
|
logPath := filepath.Join(t.TempDir(), "plugin.log")
|
||||||
|
file, err := os.OpenFile(logPath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to open plugin log: %v", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = file.Close() }()
|
||||||
|
|
||||||
|
bot.plugins[0].logger.AddWriters(bot.plugins[0].logger.CreateTextWriter(file))
|
||||||
|
bot.plugins[0].logger.Infoln("plugin secret-token")
|
||||||
|
|
||||||
|
data, err := os.ReadFile(logPath)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to read plugin log: %v", err)
|
||||||
|
}
|
||||||
|
if strings.Contains(string(data), "secret-token") {
|
||||||
|
t.Fatalf("plugin log leaked raw token: %q", string(data))
|
||||||
|
}
|
||||||
|
if !strings.Contains(string(data), "<TOKEN>") {
|
||||||
|
t.Fatalf("plugin log did not contain masked token: %q", string(data))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNextPollRetryDelay(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
prev time.Duration
|
||||||
|
want time.Duration
|
||||||
|
}{
|
||||||
|
{name: "initial", prev: 0, want: time.Second},
|
||||||
|
{name: "double", prev: 2 * time.Second, want: 4 * time.Second},
|
||||||
|
{name: "cap", prev: 20 * time.Second, want: 30 * time.Second},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
if got := nextPollRetryDelay(tt.prev); got != tt.want {
|
||||||
|
t.Fatalf("nextPollRetryDelay(%s) = %s, want %s", tt.prev, got, tt.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAddDatabaseLoggerWriterSkipsWhenAppDataIsUnset(t *testing.T) {
|
||||||
|
bot := &Bot[NoData]{logger: sneklog.NewLogger()}
|
||||||
|
called := false
|
||||||
|
|
||||||
|
bot.AddAppDataLoggerWriter(func(db NoData) sneklog.LoggerWriter {
|
||||||
|
called = true
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
|
||||||
|
if called {
|
||||||
|
t.Fatal("expected app-data logger writer to be skipped when app data is unset")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAddDatabaseLoggerWriterSkipsWhenAppDataIsNil(t *testing.T) {
|
||||||
|
type testDB struct{}
|
||||||
|
|
||||||
|
bot := &Bot[*testDB]{logger: sneklog.NewLogger()}
|
||||||
|
var db *testDB
|
||||||
|
bot.SetAppData(db)
|
||||||
|
|
||||||
|
called := false
|
||||||
|
bot.AddAppDataLoggerWriter(func(db *testDB) sneklog.LoggerWriter {
|
||||||
|
called = true
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
|
||||||
|
if called {
|
||||||
|
t.Fatal("expected app-data logger writer to be skipped when app data is nil")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestShouldWarnOnValueAppData(t *testing.T) {
|
||||||
|
type testDB struct{}
|
||||||
|
type dbIface interface{ Ping() error }
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
got bool
|
||||||
|
want bool
|
||||||
|
}{
|
||||||
|
{name: "NoData", got: shouldWarnOnValueAppData[NoData](), want: false},
|
||||||
|
{name: "pointer", got: shouldWarnOnValueAppData[*testDB](), want: false},
|
||||||
|
{name: "interface", got: shouldWarnOnValueAppData[dbIface](), want: false},
|
||||||
|
{name: "map", got: shouldWarnOnValueAppData[map[string]int](), want: false},
|
||||||
|
{name: "struct", got: shouldWarnOnValueAppData[testDB](), want: true},
|
||||||
|
{name: "int", got: shouldWarnOnValueAppData[int](), want: true},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
if tt.got != tt.want {
|
||||||
|
t.Fatalf("shouldWarnOnValueAppData = %v, want %v", tt.got, tt.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetAppDataMarksValueWarningOnce(t *testing.T) {
|
||||||
|
type testDB struct{}
|
||||||
|
|
||||||
|
bot := &Bot[testDB]{logger: sneklog.NewLogger()}
|
||||||
|
bot.SetAppData(testDB{})
|
||||||
|
if !bot.warnedValueData {
|
||||||
|
t.Fatal("expected value-typed app data to mark warning state")
|
||||||
|
}
|
||||||
|
|
||||||
|
ptrBot := &Bot[*testDB]{logger: sneklog.NewLogger()}
|
||||||
|
ptrBot.SetAppData(&testDB{})
|
||||||
|
if ptrBot.warnedValueData {
|
||||||
|
t.Fatal("did not expect pointer-typed app data to mark warning state")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetObserverAndGetObserver(t *testing.T) {
|
||||||
|
bot := &Bot[NoData]{logger: sneklog.NewLogger()}
|
||||||
|
observer := testObserver{}
|
||||||
|
|
||||||
|
if got := bot.GetObserver(); got != nil {
|
||||||
|
t.Fatalf("expected nil observer by default, got %#v", got)
|
||||||
|
}
|
||||||
|
|
||||||
|
bot.SetObserver(observer)
|
||||||
|
if got := bot.GetObserver(); got == nil {
|
||||||
|
t.Fatal("expected observer to be stored")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetObserverNilClearsObserver(t *testing.T) {
|
||||||
|
bot := &Bot[NoData]{logger: sneklog.NewLogger()}
|
||||||
|
bot.SetObserver(testObserver{})
|
||||||
|
|
||||||
|
if bot.GetObserver() == nil {
|
||||||
|
t.Fatal("expected observer to be set")
|
||||||
|
}
|
||||||
|
|
||||||
|
bot.SetObserver(nil)
|
||||||
|
if got := bot.GetObserver(); got != nil {
|
||||||
|
t.Fatalf("expected nil observer after clearing, got %#v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRunWithContextRejectsSecondRun(t *testing.T) {
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
cancel()
|
||||||
|
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
prefixes: []string{"/"},
|
||||||
|
plugins: []Plugin[NoData]{{name: "demo"}},
|
||||||
|
updateQueue: make(chan *tgapi.Update, 1),
|
||||||
|
maxWorkers: 1,
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := bot.RunWithContext(ctx); err != nil {
|
||||||
|
t.Fatalf("first RunWithContext returned error: %v", err)
|
||||||
|
}
|
||||||
|
if err := bot.RunWithContext(ctx); !errors.Is(err, ErrBotAlreadyRun) {
|
||||||
|
t.Fatalf("expected ErrBotAlreadyRun on second run, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRunWithContextKeepsEnabledRequestLogger(t *testing.T) {
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
cancel()
|
||||||
|
|
||||||
|
requestLogger := sneklog.NewLogger()
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
requestLogger: requestLogger,
|
||||||
|
useReqLogger: true,
|
||||||
|
prefixes: []string{"/"},
|
||||||
|
plugins: []Plugin[NoData]{{name: "demo"}},
|
||||||
|
updateQueue: make(chan *tgapi.Update, 1),
|
||||||
|
maxWorkers: 1,
|
||||||
|
}
|
||||||
|
t.Cleanup(func() {
|
||||||
|
_ = bot.Close()
|
||||||
|
})
|
||||||
|
|
||||||
|
if err := bot.RunWithContext(ctx); err != nil {
|
||||||
|
t.Fatalf("RunWithContext returned error: %v", err)
|
||||||
|
}
|
||||||
|
if got := bot.GetRequestLogger(); got != requestLogger {
|
||||||
|
t.Fatalf("expected enabled request logger to be preserved, got %#v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCloseDoesNotDeleteWebhook(t *testing.T) {
|
||||||
|
requests := 0
|
||||||
|
client := &http.Client{
|
||||||
|
Transport: pollingRoundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
requests++
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||||
|
Body: io.NopCloser(strings.NewReader(`{"ok":true,"result":true}`)),
|
||||||
|
}, nil
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
|
||||||
|
api := tgapi.NewAPI(
|
||||||
|
tgapi.NewAPIOpts("token").
|
||||||
|
SetAPIURL("http://example.invalid").
|
||||||
|
SetHTTPClient(client),
|
||||||
|
)
|
||||||
|
uploader := tgapi.NewUploader(api)
|
||||||
|
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
webHookLogger: sneklog.NewLogger(),
|
||||||
|
api: api,
|
||||||
|
uploader: uploader,
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := bot.Close(); err != nil {
|
||||||
|
t.Fatalf("Close returned error: %v", err)
|
||||||
|
}
|
||||||
|
if requests != 0 {
|
||||||
|
t.Fatalf("Close performed unexpected remote requests: got %d want 0", requests)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRunWithContextEmitsPollingRetryAndErrorEvents(t *testing.T) {
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
observer := &pollingRetryObserver{cancel: cancel}
|
||||||
|
|
||||||
|
client := &http.Client{
|
||||||
|
Transport: pollingRoundTripFunc(func(r *http.Request) (*http.Response, error) {
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||||
|
Body: io.NopCloser(strings.NewReader(`{"ok":false,"error_code":500,"description":"boom"}`)),
|
||||||
|
}, nil
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
|
||||||
|
api := tgapi.NewAPI(
|
||||||
|
tgapi.NewAPIOpts("token").
|
||||||
|
SetAPIURL("http://example.invalid").
|
||||||
|
SetHTTPClient(client),
|
||||||
|
)
|
||||||
|
defer func() {
|
||||||
|
_ = api.Close()
|
||||||
|
}()
|
||||||
|
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
api: api,
|
||||||
|
prefixes: []string{"/"},
|
||||||
|
plugins: []Plugin[NoData]{{name: "demo"}},
|
||||||
|
updateQueue: make(chan *tgapi.Update, 1),
|
||||||
|
maxWorkers: 1,
|
||||||
|
observer: observer,
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := bot.RunWithContext(ctx); err != nil {
|
||||||
|
t.Fatalf("RunWithContext returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(observer.retries) != 1 {
|
||||||
|
t.Fatalf("expected one polling retry event, got %d", len(observer.retries))
|
||||||
|
}
|
||||||
|
if got := observer.retries[0]; got.Attempt != 1 || got.Delay <= 0 || got.Err == nil {
|
||||||
|
t.Fatalf("unexpected polling retry event: %#v", got)
|
||||||
|
}
|
||||||
|
if len(observer.errors) != 1 {
|
||||||
|
t.Fatalf("expected one polling error event, got %d", len(observer.errors))
|
||||||
|
}
|
||||||
|
if got := observer.errors[0]; got.HandlerKind != HandlerPollingKind || got.HandlerName != "getUpdates" || got.Plugin != "bot" || got.Err == nil || got.UserFacing {
|
||||||
|
t.Fatalf("unexpected polling error event: %#v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRunWithContextPreservesPollingRetryBackoff(t *testing.T) {
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
observer := &pollingRetryObserver{cancel: cancel, cancelAfter: 2}
|
||||||
|
|
||||||
|
client := &http.Client{
|
||||||
|
Transport: pollingRoundTripFunc(func(r *http.Request) (*http.Response, error) {
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||||
|
Body: io.NopCloser(strings.NewReader(`{"ok":false,"error_code":500,"description":"boom"}`)),
|
||||||
|
}, nil
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
|
||||||
|
api := tgapi.NewAPI(
|
||||||
|
tgapi.NewAPIOpts("token").
|
||||||
|
SetAPIURL("http://example.invalid").
|
||||||
|
SetHTTPClient(client),
|
||||||
|
)
|
||||||
|
defer func() {
|
||||||
|
_ = api.Close()
|
||||||
|
}()
|
||||||
|
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
api: api,
|
||||||
|
prefixes: []string{"/"},
|
||||||
|
plugins: []Plugin[NoData]{{name: "demo"}},
|
||||||
|
updateQueue: make(chan *tgapi.Update, 1),
|
||||||
|
maxWorkers: 1,
|
||||||
|
observer: observer,
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := bot.RunWithContext(ctx); err != nil {
|
||||||
|
t.Fatalf("RunWithContext returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(observer.retries) != 2 {
|
||||||
|
t.Fatalf("expected two polling retry events, got %d", len(observer.retries))
|
||||||
|
}
|
||||||
|
if got := observer.retries[0]; got.Attempt != 1 || got.Delay != time.Second {
|
||||||
|
t.Fatalf("unexpected first retry event: %#v", got)
|
||||||
|
}
|
||||||
|
if got := observer.retries[1]; got.Attempt != 2 || got.Delay != 2*time.Second {
|
||||||
|
t.Fatalf("unexpected second retry event: %#v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBotConfigurationFreezesAfterRunStarts(t *testing.T) {
|
||||||
|
type testDB struct{ Name string }
|
||||||
|
|
||||||
|
makeBot := func() *Bot[*testDB] {
|
||||||
|
return &Bot[*testDB]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
prefixes: []string{"/"},
|
||||||
|
updateTypes: []tgapi.UpdateType{tgapi.UpdateTypeMessage},
|
||||||
|
payloadType: BotPayloadBase64,
|
||||||
|
strictPayloadType: false,
|
||||||
|
errorTemplate: "%s",
|
||||||
|
l10n: &L10n{},
|
||||||
|
draftProvider: &DraftProvider{},
|
||||||
|
sessionStore: NewMemorySessionStore(),
|
||||||
|
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
check func(t *testing.T, bot *Bot[*testDB])
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "SetAppData",
|
||||||
|
check: func(t *testing.T, bot *Bot[*testDB]) {
|
||||||
|
original := &testDB{Name: "before"}
|
||||||
|
bot.SetAppData(original)
|
||||||
|
if err := bot.beginRun(); err != nil {
|
||||||
|
t.Fatalf("beginRun returned error: %v", err)
|
||||||
|
}
|
||||||
|
t.Cleanup(bot.finishRun)
|
||||||
|
|
||||||
|
later := &testDB{Name: "after"}
|
||||||
|
bot.SetAppData(later)
|
||||||
|
if bot.appData != original {
|
||||||
|
t.Fatal("SetAppData mutated after configuration freeze")
|
||||||
|
}
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "UpdateTypes",
|
||||||
|
check: func(t *testing.T, bot *Bot[*testDB]) {
|
||||||
|
original := append([]tgapi.UpdateType(nil), bot.updateTypes...)
|
||||||
|
if err := bot.beginRun(); err != nil {
|
||||||
|
t.Fatalf("beginRun returned error: %v", err)
|
||||||
|
}
|
||||||
|
t.Cleanup(bot.finishRun)
|
||||||
|
|
||||||
|
bot.SetUpdateTypes(tgapi.UpdateTypePoll)
|
||||||
|
if !reflect.DeepEqual(bot.updateTypes, original) {
|
||||||
|
t.Fatalf("UpdateTypes mutated after configuration freeze: got %v want %v", bot.updateTypes, original)
|
||||||
|
}
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "AddUpdateType",
|
||||||
|
check: func(t *testing.T, bot *Bot[*testDB]) {
|
||||||
|
original := append([]tgapi.UpdateType(nil), bot.updateTypes...)
|
||||||
|
if err := bot.beginRun(); err != nil {
|
||||||
|
t.Fatalf("beginRun returned error: %v", err)
|
||||||
|
}
|
||||||
|
t.Cleanup(bot.finishRun)
|
||||||
|
|
||||||
|
bot.AddUpdateType(tgapi.UpdateTypePoll)
|
||||||
|
if !reflect.DeepEqual(bot.updateTypes, original) {
|
||||||
|
t.Fatalf("AddUpdateType mutated after configuration freeze: got %v want %v", bot.updateTypes, original)
|
||||||
|
}
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "SetPayloadType",
|
||||||
|
check: func(t *testing.T, bot *Bot[*testDB]) {
|
||||||
|
if err := bot.beginRun(); err != nil {
|
||||||
|
t.Fatalf("beginRun returned error: %v", err)
|
||||||
|
}
|
||||||
|
t.Cleanup(bot.finishRun)
|
||||||
|
|
||||||
|
bot.SetPayloadType(BotPayloadJSON)
|
||||||
|
if bot.payloadType != BotPayloadBase64 {
|
||||||
|
t.Fatalf("payloadType mutated after configuration freeze: got %q want %q", bot.payloadType, BotPayloadBase64)
|
||||||
|
}
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "SetStrictPayloadType",
|
||||||
|
check: func(t *testing.T, bot *Bot[*testDB]) {
|
||||||
|
if err := bot.beginRun(); err != nil {
|
||||||
|
t.Fatalf("beginRun returned error: %v", err)
|
||||||
|
}
|
||||||
|
t.Cleanup(bot.finishRun)
|
||||||
|
|
||||||
|
bot.SetStrictPayloadType(true)
|
||||||
|
if bot.strictPayloadType {
|
||||||
|
t.Fatal("strictPayloadType mutated after configuration freeze")
|
||||||
|
}
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "AddPrefixes",
|
||||||
|
check: func(t *testing.T, bot *Bot[*testDB]) {
|
||||||
|
original := append([]string(nil), bot.prefixes...)
|
||||||
|
if err := bot.beginRun(); err != nil {
|
||||||
|
t.Fatalf("beginRun returned error: %v", err)
|
||||||
|
}
|
||||||
|
t.Cleanup(bot.finishRun)
|
||||||
|
|
||||||
|
bot.AddPrefixes("!")
|
||||||
|
if !reflect.DeepEqual(bot.prefixes, original) {
|
||||||
|
t.Fatalf("prefixes mutated after configuration freeze: got %v want %v", bot.prefixes, original)
|
||||||
|
}
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "ErrorTemplate",
|
||||||
|
check: func(t *testing.T, bot *Bot[*testDB]) {
|
||||||
|
if err := bot.beginRun(); err != nil {
|
||||||
|
t.Fatalf("beginRun returned error: %v", err)
|
||||||
|
}
|
||||||
|
t.Cleanup(bot.finishRun)
|
||||||
|
|
||||||
|
bot.SetErrorTemplate("changed")
|
||||||
|
if bot.errorTemplate != "%s" {
|
||||||
|
t.Fatalf("errorTemplate mutated after configuration freeze: got %q want %q", bot.errorTemplate, "%s")
|
||||||
|
}
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "SetDraftProvider",
|
||||||
|
check: func(t *testing.T, bot *Bot[*testDB]) {
|
||||||
|
original := bot.draftProvider
|
||||||
|
if err := bot.beginRun(); err != nil {
|
||||||
|
t.Fatalf("beginRun returned error: %v", err)
|
||||||
|
}
|
||||||
|
t.Cleanup(bot.finishRun)
|
||||||
|
|
||||||
|
bot.SetDraftProvider(&DraftProvider{})
|
||||||
|
if bot.draftProvider != original {
|
||||||
|
t.Fatal("draftProvider mutated after configuration freeze")
|
||||||
|
}
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "SetSessionStore",
|
||||||
|
check: func(t *testing.T, bot *Bot[*testDB]) {
|
||||||
|
original := bot.sessionStore
|
||||||
|
if err := bot.beginRun(); err != nil {
|
||||||
|
t.Fatalf("beginRun returned error: %v", err)
|
||||||
|
}
|
||||||
|
t.Cleanup(bot.finishRun)
|
||||||
|
|
||||||
|
bot.SetSessionStore(NewMemorySessionStore())
|
||||||
|
if bot.sessionStore != original {
|
||||||
|
t.Fatal("sessionStore mutated after configuration freeze")
|
||||||
|
}
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "SetSceneScopePriority",
|
||||||
|
check: func(t *testing.T, bot *Bot[*testDB]) {
|
||||||
|
original := append([]SceneScope(nil), bot.sceneScopePriority...)
|
||||||
|
if err := bot.beginRun(); err != nil {
|
||||||
|
t.Fatalf("beginRun returned error: %v", err)
|
||||||
|
}
|
||||||
|
t.Cleanup(bot.finishRun)
|
||||||
|
|
||||||
|
bot.SetSceneScopePriority([]SceneScope{SceneScopeUser})
|
||||||
|
if !reflect.DeepEqual(bot.sceneScopePriority, original) {
|
||||||
|
t.Fatalf("sceneScopePriority mutated after configuration freeze: got %v want %v", bot.sceneScopePriority, original)
|
||||||
|
}
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "AddL10n",
|
||||||
|
check: func(t *testing.T, bot *Bot[*testDB]) {
|
||||||
|
original := bot.l10n
|
||||||
|
if err := bot.beginRun(); err != nil {
|
||||||
|
t.Fatalf("beginRun returned error: %v", err)
|
||||||
|
}
|
||||||
|
t.Cleanup(bot.finishRun)
|
||||||
|
|
||||||
|
bot.SetL10n(&L10n{})
|
||||||
|
if bot.l10n != original {
|
||||||
|
t.Fatal("l10n mutated after configuration freeze")
|
||||||
|
}
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
tt.check(t, makeBot())
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAddPluginsAndRuntimeRegistrationsNoOpAfterRunStarts(t *testing.T) {
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
prefixes: []string{"/"},
|
||||||
|
middlewares: []Middleware[NoData]{NewMiddleware("base", func(ctx *MsgContext, db NoData) bool { return true })},
|
||||||
|
runners: []Runner[NoData]{NewRunner("base", func(bot *Bot[NoData]) error { return nil })},
|
||||||
|
}
|
||||||
|
plugin := NewPlugin[NoData]("late")
|
||||||
|
|
||||||
|
if err := bot.beginRun(); err != nil {
|
||||||
|
t.Fatalf("beginRun returned error: %v", err)
|
||||||
|
}
|
||||||
|
defer bot.finishRun()
|
||||||
|
|
||||||
|
bot.AddPlugins(plugin)
|
||||||
|
bot.AddMiddleware(NewMiddleware("late", func(ctx *MsgContext, db NoData) bool { return true }))
|
||||||
|
bot.AddRunner(NewRunner("late", func(bot *Bot[NoData]) error { return nil }))
|
||||||
|
|
||||||
|
if len(bot.plugins) != 0 {
|
||||||
|
t.Fatalf("expected AddPlugins to be ignored after configuration freeze, got %d plugins", len(bot.plugins))
|
||||||
|
}
|
||||||
|
if len(bot.middlewares) != 1 {
|
||||||
|
t.Fatalf("expected AddMiddleware to be ignored after configuration freeze, got %d middlewares", len(bot.middlewares))
|
||||||
|
}
|
||||||
|
if len(bot.runners) != 1 {
|
||||||
|
t.Fatalf("expected AddRunner to be ignored after configuration freeze, got %d runners", len(bot.runners))
|
||||||
|
}
|
||||||
|
}
|
||||||
+218
@@ -0,0 +1,218 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"maps"
|
||||||
|
"reflect"
|
||||||
|
"slices"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/extypes"
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||||
|
"github.com/alitto/pond/v2"
|
||||||
|
)
|
||||||
|
|
||||||
|
func (bot *Bot[T]) addTokenReplacer(loggers ...*sneklog.Logger) {
|
||||||
|
if bot.token == "" {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
for _, logger := range loggers {
|
||||||
|
if logger == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
logger.AddReplacer(bot.token, "<TOKEN>")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func appendUniqueLogger(loggers []*sneklog.Logger, logger *sneklog.Logger) []*sneklog.Logger {
|
||||||
|
if logger == nil {
|
||||||
|
return loggers
|
||||||
|
}
|
||||||
|
if slices.Contains(loggers, logger) {
|
||||||
|
return loggers
|
||||||
|
}
|
||||||
|
return append(loggers, logger)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) managedExtraLoggers() []*sneklog.Logger {
|
||||||
|
loggers := append([]*sneklog.Logger(nil), bot.extraLoggers...)
|
||||||
|
if bot.api != nil {
|
||||||
|
loggers = appendUniqueLogger(loggers, bot.api.GetLogger())
|
||||||
|
}
|
||||||
|
if bot.uploader != nil {
|
||||||
|
loggers = appendUniqueLogger(loggers, bot.uploader.GetLogger())
|
||||||
|
}
|
||||||
|
return loggers
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) enqueueUpdate(ctx context.Context, update tgapi.Update) error {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return ctx.Err()
|
||||||
|
case bot.updateQueue <- new(update):
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) startUpdateWorkers(ctx context.Context) {
|
||||||
|
pool := pond.NewPool(bot.maxWorkers)
|
||||||
|
for update := range bot.updateQueue {
|
||||||
|
u := update // capture loop variable
|
||||||
|
pool.Submit(func() {
|
||||||
|
bot.handle(ctx, u)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
pool.Stop() // Wait for all tasks to complete and stop the pool
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) initLoggers(opts *BotOpts) {
|
||||||
|
level := sneklog.FATAL
|
||||||
|
if opts.Debug {
|
||||||
|
level = sneklog.DEBUG
|
||||||
|
}
|
||||||
|
|
||||||
|
format, formatter := opts.LogFormat, opts.LogFormatter
|
||||||
|
if bot.logger == nil {
|
||||||
|
bot.logger = utils.CreateLogger("BOT", level, format, formatter)
|
||||||
|
if opts.WriteToFile {
|
||||||
|
path := fmt.Sprintf("%s/main.log", strings.TrimRight(opts.LoggerBasePath, "/"))
|
||||||
|
logger, err := utils.CreateFileLogger("BOT", level, path, format, formatter)
|
||||||
|
if err != nil {
|
||||||
|
bot.logger.Errorln(err)
|
||||||
|
} else {
|
||||||
|
bot.logger = logger
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if opts.UseRequestLogger && bot.requestLogger == nil {
|
||||||
|
bot.requestLogger = utils.CreateLogger("REQUESTS", level, format, formatter)
|
||||||
|
if opts.WriteToFile {
|
||||||
|
path := fmt.Sprintf("%s/requests.log", strings.TrimRight(opts.LoggerBasePath, "/"))
|
||||||
|
logger, err := utils.CreateFileLogger("REQUESTS", level, path, format, formatter)
|
||||||
|
if err != nil {
|
||||||
|
bot.logger.Errorln(err)
|
||||||
|
} else {
|
||||||
|
bot.requestLogger = logger
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
bot.addTokenReplacer(bot.logger, bot.requestLogger)
|
||||||
|
bot.addTokenReplacer(bot.managedExtraLoggers()...)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) beginRun() error {
|
||||||
|
bot.runStateMu.Lock()
|
||||||
|
defer bot.runStateMu.Unlock()
|
||||||
|
if bot.running || bot.ran {
|
||||||
|
return ErrBotAlreadyRun
|
||||||
|
}
|
||||||
|
bot.running = true
|
||||||
|
bot.ran = true
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) finishRun() {
|
||||||
|
bot.runStateMu.Lock()
|
||||||
|
bot.running = false
|
||||||
|
bot.runStateMu.Unlock()
|
||||||
|
}
|
||||||
|
|
||||||
|
func nextPollRetryDelay(prev time.Duration) time.Duration {
|
||||||
|
if prev <= 0 {
|
||||||
|
return time.Second
|
||||||
|
}
|
||||||
|
next := prev * 2
|
||||||
|
if next > 30*time.Second {
|
||||||
|
return 30 * time.Second
|
||||||
|
}
|
||||||
|
return next
|
||||||
|
}
|
||||||
|
|
||||||
|
func isNilValue[T any](v T) bool {
|
||||||
|
rv := reflect.ValueOf(v)
|
||||||
|
if !rv.IsValid() {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
switch rv.Kind() {
|
||||||
|
case reflect.Chan, reflect.Func, reflect.Interface, reflect.Map, reflect.Pointer, reflect.Slice:
|
||||||
|
return rv.IsNil()
|
||||||
|
default:
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func shouldWarnOnValueAppData[T any]() bool {
|
||||||
|
t := reflect.TypeFor[T]()
|
||||||
|
if t == reflect.TypeFor[NoData]() {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
switch t.Kind() {
|
||||||
|
case reflect.Pointer, reflect.Interface, reflect.Map, reflect.Slice, reflect.Func, reflect.Chan:
|
||||||
|
return false
|
||||||
|
default:
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func clonePlugin[T AppData](p *Plugin[T]) Plugin[T] {
|
||||||
|
cloned := Plugin[T]{
|
||||||
|
name: p.name,
|
||||||
|
commands: make(map[string]*Command[T], len(p.commands)),
|
||||||
|
payloads: make(map[string]*Command[T], len(p.payloads)),
|
||||||
|
scenes: make(map[string]*Scene[T], len(p.scenes)),
|
||||||
|
middlewares: append(extypes.Slice[Middleware[T]](nil), p.middlewares...),
|
||||||
|
skipAutoCmd: p.skipAutoCmd,
|
||||||
|
logger: p.logger,
|
||||||
|
messageFallback: p.messageFallback,
|
||||||
|
handlers: make(map[tgapi.UpdateType]CommandExecutor[T]),
|
||||||
|
onClose: p.onClose,
|
||||||
|
}
|
||||||
|
|
||||||
|
for name, command := range p.commands {
|
||||||
|
cloned.commands[name] = cloneCommand(command)
|
||||||
|
}
|
||||||
|
for name, command := range p.payloads {
|
||||||
|
cloned.payloads[name] = cloneCommand(command)
|
||||||
|
}
|
||||||
|
for name, scene := range p.scenes {
|
||||||
|
cloned.scenes[name] = cloneScene(scene)
|
||||||
|
}
|
||||||
|
maps.Copy(cloned.handlers, p.handlers)
|
||||||
|
|
||||||
|
return cloned
|
||||||
|
}
|
||||||
|
|
||||||
|
func cloneCommand[T AppData](command *Command[T]) *Command[T] {
|
||||||
|
if command == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
cloned := *command
|
||||||
|
cloned.args = append(extypes.Slice[CommandArg](nil), command.args...)
|
||||||
|
cloned.middlewares = append(extypes.Slice[Middleware[T]](nil), command.middlewares...)
|
||||||
|
return &cloned
|
||||||
|
}
|
||||||
|
|
||||||
|
func cloneScene[T AppData](scene *Scene[T]) *Scene[T] {
|
||||||
|
if scene == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
cloned := *scene
|
||||||
|
cloned.steps = make(map[string]SceneHandler[T], len(scene.steps))
|
||||||
|
cloned.commands = make(map[string]SceneHandler[T], len(scene.commands))
|
||||||
|
cloned.payloads = make(map[string]SceneHandler[T], len(scene.payloads))
|
||||||
|
|
||||||
|
maps.Copy(cloned.steps, scene.steps)
|
||||||
|
maps.Copy(cloned.commands, scene.commands)
|
||||||
|
maps.Copy(cloned.payloads, scene.payloads)
|
||||||
|
|
||||||
|
return &cloned
|
||||||
|
}
|
||||||
+462
@@ -0,0 +1,462 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"os"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||||
|
)
|
||||||
|
|
||||||
|
// BotWebHookOpts configures Telegram webhook registration and the local HTTP server.
|
||||||
|
type BotWebHookOpts struct {
|
||||||
|
Path string
|
||||||
|
LocalPort int
|
||||||
|
UseStatusPath bool
|
||||||
|
|
||||||
|
URL string
|
||||||
|
Certificate []byte
|
||||||
|
IPAddress string
|
||||||
|
MaxConnections int8
|
||||||
|
AllowedUpdates []tgapi.UpdateType
|
||||||
|
DropPendingUpdates bool
|
||||||
|
SecretToken string
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewBotWebHookOpts returns webhook options with the default path, local port, and max connections.
|
||||||
|
func NewBotWebHookOpts() *BotWebHookOpts {
|
||||||
|
return &BotWebHookOpts{
|
||||||
|
Path: "/",
|
||||||
|
LocalPort: 8080,
|
||||||
|
MaxConnections: 40,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetPath sets the local HTTP path that receives Telegram webhook requests.
|
||||||
|
func (opts *BotWebHookOpts) SetPath(path string) *BotWebHookOpts {
|
||||||
|
opts.Path = path
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetLocalPort sets the local HTTP port used by the webhook server.
|
||||||
|
func (opts *BotWebHookOpts) SetLocalPort(port int) *BotWebHookOpts {
|
||||||
|
opts.LocalPort = port
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetUseStatusPath enables or disables the optional /status endpoint.
|
||||||
|
// A non-empty SecretToken is required when this endpoint is enabled.
|
||||||
|
func (opts *BotWebHookOpts) SetUseStatusPath(use bool) *BotWebHookOpts {
|
||||||
|
opts.UseStatusPath = use
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetURL sets the public base URL Telegram should call for incoming updates.
|
||||||
|
func (opts *BotWebHookOpts) SetURL(url string) *BotWebHookOpts {
|
||||||
|
opts.URL = url
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetCertificate sets the self-signed webhook certificate bytes to upload.
|
||||||
|
func (opts *BotWebHookOpts) SetCertificate(certificate []byte) *BotWebHookOpts {
|
||||||
|
opts.Certificate = certificate
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// MustLoadCertificate loads a webhook certificate from disk and panics on failure.
|
||||||
|
func (opts *BotWebHookOpts) MustLoadCertificate(filename string) *BotWebHookOpts {
|
||||||
|
f, err := os.Open(filename)
|
||||||
|
if err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
defer func() {
|
||||||
|
_ = f.Close()
|
||||||
|
}()
|
||||||
|
opts.Certificate, err = io.ReadAll(f)
|
||||||
|
if err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetIPAddress sets the fixed IP address Telegram should use for webhook delivery.
|
||||||
|
func (opts *BotWebHookOpts) SetIPAddress(ip string) *BotWebHookOpts {
|
||||||
|
opts.IPAddress = ip
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetMaxConnections sets Telegram's maximum number of simultaneous webhook connections.
|
||||||
|
func (opts *BotWebHookOpts) SetMaxConnections(max int8) *BotWebHookOpts {
|
||||||
|
opts.MaxConnections = max
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetAllowedUpdates sets the Telegram update types that should be delivered to the webhook.
|
||||||
|
func (opts *BotWebHookOpts) SetAllowedUpdates(updates ...tgapi.UpdateType) *BotWebHookOpts {
|
||||||
|
opts.AllowedUpdates = append([]tgapi.UpdateType(nil), updates...)
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetDropPendingUpdates configures whether Telegram should drop pending updates while setting the webhook.
|
||||||
|
func (opts *BotWebHookOpts) SetDropPendingUpdates(drop bool) *BotWebHookOpts {
|
||||||
|
opts.DropPendingUpdates = drop
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetSecretToken sets the secret token expected in Telegram webhook requests.
|
||||||
|
// The same token is also required to access /status when that endpoint is enabled.
|
||||||
|
func (opts *BotWebHookOpts) SetSecretToken(secretToken string) *BotWebHookOpts {
|
||||||
|
opts.SecretToken = secretToken
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// RunWebHookWithContext registers the webhook and serves incoming updates until ctx is canceled.
|
||||||
|
//
|
||||||
|
// The bot uses the same update queue, worker pool, runner startup, and single-use lifecycle
|
||||||
|
// guarantees as RunWithContext. When opts.AllowedUpdates is empty, the bot-level update types
|
||||||
|
// configured through SetUpdateTypes/AddUpdateType are used. When UseStatusPath is enabled,
|
||||||
|
// SecretToken must be non-empty so the operational endpoint is not left public.
|
||||||
|
//
|
||||||
|
// When two TLS files are provided, the method serves HTTPS using the existing key-then-cert
|
||||||
|
// argument order.
|
||||||
|
func (bot *Bot[T]) RunWebHookWithContext(ctx context.Context, opts *BotWebHookOpts, tlsFiles ...string) error {
|
||||||
|
if opts == nil {
|
||||||
|
return errors.New("nil BotWebHookOpts")
|
||||||
|
}
|
||||||
|
if len(bot.prefixes) == 0 {
|
||||||
|
return ErrNoPrefixes
|
||||||
|
}
|
||||||
|
if len(bot.plugins) == 0 {
|
||||||
|
return ErrNoPlugins
|
||||||
|
}
|
||||||
|
if opts.URL == "" {
|
||||||
|
return errors.New("empty BotWebHookOpts.URL")
|
||||||
|
}
|
||||||
|
if opts.MaxConnections > 100 || opts.MaxConnections <= 0 {
|
||||||
|
return errors.New("BotWebHookOpts.MaxConnections must between 1 and 100")
|
||||||
|
}
|
||||||
|
if err := validateWebhookPath(opts.Path, opts.UseStatusPath); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if opts.UseStatusPath && opts.SecretToken == "" {
|
||||||
|
return errors.New("BotWebHookOpts.SecretToken required when status path is enabled")
|
||||||
|
}
|
||||||
|
if err := validateWebhookTLSFiles(tlsFiles); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
bot.webHookLogger = utils.CreateLogger("WEBHOOK", bot.GetLoggerLevel(), bot.logFormat, bot.logFormatter)
|
||||||
|
bot.addTokenReplacer(bot.webHookLogger)
|
||||||
|
if opts.SecretToken == "" {
|
||||||
|
bot.webHookLogger.Warnln("Bot webhook secret token empty. It's VERY recommended to set secret.")
|
||||||
|
}
|
||||||
|
|
||||||
|
if opts.Certificate != nil && bot.uploader == nil {
|
||||||
|
return errors.New("bot uploader nil, but certificate set")
|
||||||
|
}
|
||||||
|
|
||||||
|
return bot.runWebhookRuntime(ctx, func(runCtx context.Context) error {
|
||||||
|
i, err := bot.api.GetWebhookInfoWithContext(runCtx)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if i.URL == "" {
|
||||||
|
bot.webHookLogger.Warnln("API returned webhook info with empty URL. There may be a long-poll")
|
||||||
|
} else {
|
||||||
|
_, err = bot.api.DeleteWebhookWithContext(runCtx, tgapi.DeleteWebhook{})
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
bot.webHookLogger.Infof("Bot webhook deleted: %s", i.URL)
|
||||||
|
}
|
||||||
|
|
||||||
|
allowedUpdates := bot.webhookAllowedUpdates(opts)
|
||||||
|
|
||||||
|
var ok bool
|
||||||
|
if opts.Certificate != nil {
|
||||||
|
ok, err = bot.uploader.SetWebhookWithContext(runCtx, tgapi.UploadSetWebhook{
|
||||||
|
URL: fmt.Sprintf("%s%s", opts.URL, opts.Path),
|
||||||
|
IPAddress: opts.IPAddress,
|
||||||
|
MaxConnections: opts.MaxConnections,
|
||||||
|
AllowedUpdates: allowedUpdates,
|
||||||
|
DropPendingUpdates: opts.DropPendingUpdates,
|
||||||
|
SecretToken: opts.SecretToken,
|
||||||
|
}, tgapi.NewUploaderFile("certificate", opts.Certificate))
|
||||||
|
} else {
|
||||||
|
ok, err = bot.api.SetWebhookWithContext(runCtx, tgapi.SetWebhook{
|
||||||
|
URL: fmt.Sprintf("%s%s", opts.URL, opts.Path),
|
||||||
|
IPAddress: opts.IPAddress,
|
||||||
|
MaxConnections: opts.MaxConnections,
|
||||||
|
AllowedUpdates: allowedUpdates,
|
||||||
|
DropPendingUpdates: opts.DropPendingUpdates,
|
||||||
|
SecretToken: opts.SecretToken,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if !ok {
|
||||||
|
return errors.New("failed to set webhook")
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(tlsFiles) == 2 {
|
||||||
|
return bot.runWebHookTLS(runCtx, opts, tlsFiles[0], tlsFiles[1])
|
||||||
|
}
|
||||||
|
|
||||||
|
return bot.runWebHook(runCtx, opts)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// RunWebHook starts the webhook runtime with a background context.
|
||||||
|
//
|
||||||
|
// It is shorthand for RunWebHookWithContext(context.Background(), opts, tlsFiles...).
|
||||||
|
func (bot *Bot[T]) RunWebHook(opts *BotWebHookOpts, tlsFiles ...string) error {
|
||||||
|
return bot.RunWebHookWithContext(context.Background(), opts, tlsFiles...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CloseWebHook removes the current Telegram webhook registration.
|
||||||
|
//
|
||||||
|
// It is separate from Close, which only releases local resources.
|
||||||
|
// Call it before switching a deployment from webhook delivery to polling.
|
||||||
|
func (bot *Bot[T]) CloseWebHook() error {
|
||||||
|
var e []error
|
||||||
|
if bot.api == nil {
|
||||||
|
e = append(e, errors.New("bot api nil"))
|
||||||
|
} else {
|
||||||
|
if _, err := bot.api.DeleteWebhook(tgapi.DeleteWebhook{}); err != nil {
|
||||||
|
if bot.webHookLogger != nil {
|
||||||
|
bot.webHookLogger.Errorf("Failed to close webhook: %s", err.Error())
|
||||||
|
} else if bot.logger != nil {
|
||||||
|
bot.logger.Errorf("Failed to close webhook: %s", err.Error())
|
||||||
|
}
|
||||||
|
e = append(e, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if bot.webHookLogger != nil {
|
||||||
|
if err := bot.webHookLogger.Close(); err != nil {
|
||||||
|
e = append(e, err)
|
||||||
|
}
|
||||||
|
bot.webHookLogger = nil
|
||||||
|
}
|
||||||
|
return errors.Join(e...)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) webhookAllowedUpdates(opts *BotWebHookOpts) []tgapi.UpdateType {
|
||||||
|
if len(opts.AllowedUpdates) > 0 {
|
||||||
|
return append([]tgapi.UpdateType(nil), opts.AllowedUpdates...)
|
||||||
|
}
|
||||||
|
return bot.GetUpdateTypes()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) runWebhookRuntime(ctx context.Context, run func(context.Context) error) error {
|
||||||
|
if err := bot.beginRun(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer bot.finishRun()
|
||||||
|
|
||||||
|
runCtx, cancel := context.WithCancel(ctx)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
bot.ExecRunners(runCtx)
|
||||||
|
|
||||||
|
workersDone := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
bot.startUpdateWorkers(runCtx)
|
||||||
|
close(workersDone)
|
||||||
|
}()
|
||||||
|
|
||||||
|
runErr := run(runCtx)
|
||||||
|
cancel()
|
||||||
|
close(bot.updateQueue)
|
||||||
|
<-workersDone
|
||||||
|
bot.runnerOnceWG.Wait()
|
||||||
|
bot.runnerBgWG.Wait()
|
||||||
|
|
||||||
|
return runErr
|
||||||
|
}
|
||||||
|
|
||||||
|
func updateHandler[T any](ctx context.Context, bot *Bot[T], secret string) http.HandlerFunc {
|
||||||
|
return func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
defer func() {
|
||||||
|
_ = r.Body.Close()
|
||||||
|
}()
|
||||||
|
if r.Method != http.MethodPost {
|
||||||
|
w.WriteHeader(http.StatusMethodNotAllowed)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if secret != "" && r.Header.Get("X-Telegram-Bot-Api-Secret-Token") != secret {
|
||||||
|
w.WriteHeader(http.StatusForbidden)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
const maxWebhookBodySize = 256 << 10 // 256 KiB
|
||||||
|
r.Body = http.MaxBytesReader(w, r.Body, maxWebhookBodySize)
|
||||||
|
|
||||||
|
data, err := io.ReadAll(r.Body)
|
||||||
|
if err != nil {
|
||||||
|
if _, ok := errors.AsType[*http.MaxBytesError](err); ok {
|
||||||
|
w.WriteHeader(http.StatusRequestEntityTooLarge)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
w.WriteHeader(http.StatusBadRequest)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if len(data) == 0 {
|
||||||
|
w.WriteHeader(http.StatusBadRequest)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
var up tgapi.Update
|
||||||
|
if err := json.Unmarshal(data, &up); err != nil {
|
||||||
|
w.WriteHeader(http.StatusBadRequest)
|
||||||
|
bot.webHookLogger.Errorln(err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
bot.webHookLogger.Debugf("UPDATE id=%d type=%s size=%d from=%s", up.UpdateID, up.Type, len(data), r.RemoteAddr)
|
||||||
|
if err := bot.enqueueUpdate(ctx, up); err != nil {
|
||||||
|
bot.webHookLogger.Errorln(err)
|
||||||
|
w.WriteHeader(http.StatusServiceUnavailable)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func statusHandler[T any](bot *Bot[T], opts *BotWebHookOpts) http.HandlerFunc {
|
||||||
|
return func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
auth := ""
|
||||||
|
if r.Header.Get("Authorization") != "" {
|
||||||
|
auth = r.Header.Get("Authorization")
|
||||||
|
} else if r.Header.Get("X-Telegram-Bot-Api-Secret-Token") != "" {
|
||||||
|
auth = r.Header.Get("X-Telegram-Bot-Api-Secret-Token")
|
||||||
|
}
|
||||||
|
if auth != opts.SecretToken {
|
||||||
|
w.WriteHeader(http.StatusNotFound)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
i, err := bot.api.GetWebhookInfoWithContext(r.Context())
|
||||||
|
if err != nil {
|
||||||
|
bot.webHookLogger.Errorln(err)
|
||||||
|
w.WriteHeader(http.StatusInternalServerError)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
data, err := json.MarshalIndent(i, "", " ")
|
||||||
|
if err != nil {
|
||||||
|
bot.webHookLogger.Errorln(err)
|
||||||
|
w.WriteHeader(http.StatusInternalServerError)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
if _, err := fmt.Fprint(w, string(data)); err != nil {
|
||||||
|
bot.webHookLogger.Errorln(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) newWebHookMux(ctx context.Context, opts *BotWebHookOpts) *http.ServeMux {
|
||||||
|
r := http.NewServeMux()
|
||||||
|
if opts.UseStatusPath {
|
||||||
|
r.HandleFunc("/status", statusHandler(bot, opts))
|
||||||
|
}
|
||||||
|
r.HandleFunc(opts.Path, updateHandler(ctx, bot, opts.SecretToken))
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
func (bot *Bot[T]) runWebHook(ctx context.Context, opts *BotWebHookOpts) error {
|
||||||
|
srv := &http.Server{
|
||||||
|
Addr: fmt.Sprintf(":%d", opts.LocalPort),
|
||||||
|
Handler: bot.newWebHookMux(ctx, opts),
|
||||||
|
}
|
||||||
|
errCh := make(chan error, 1)
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
err := srv.ListenAndServe()
|
||||||
|
if err != nil && !errors.Is(err, http.ErrServerClosed) {
|
||||||
|
errCh <- err
|
||||||
|
return
|
||||||
|
}
|
||||||
|
errCh <- nil
|
||||||
|
}()
|
||||||
|
|
||||||
|
bot.webHookLogger.Infoln(fmt.Sprintf("Bot WebHook started at %s; waiting for updates at %s", srv.Addr, opts.URL))
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
shutdownCtx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
if err := srv.Shutdown(shutdownCtx); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return <-errCh
|
||||||
|
|
||||||
|
case err := <-errCh:
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
func (bot *Bot[T]) runWebHookTLS(ctx context.Context, opts *BotWebHookOpts, key, cert string) error {
|
||||||
|
srv := &http.Server{
|
||||||
|
Addr: fmt.Sprintf(":%d", opts.LocalPort),
|
||||||
|
Handler: bot.newWebHookMux(ctx, opts),
|
||||||
|
}
|
||||||
|
errCh := make(chan error, 1)
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
err := srv.ListenAndServeTLS(cert, key)
|
||||||
|
if err != nil && !errors.Is(err, http.ErrServerClosed) {
|
||||||
|
errCh <- err
|
||||||
|
return
|
||||||
|
}
|
||||||
|
errCh <- nil
|
||||||
|
}()
|
||||||
|
|
||||||
|
bot.webHookLogger.Infoln(fmt.Sprintf("Bot webhook started with TLS(%s, %s) at %s; waiting for updates at %s", key, cert, srv.Addr, opts.URL))
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
shutdownCtx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
if err := srv.Shutdown(shutdownCtx); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return <-errCh
|
||||||
|
|
||||||
|
case err := <-errCh:
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
func validateWebhookPath(path string, useStatusPath bool) error {
|
||||||
|
if path == "" {
|
||||||
|
return errors.New("empty BotWebHookOpts.Path")
|
||||||
|
}
|
||||||
|
if !strings.HasPrefix(path, "/") {
|
||||||
|
return errors.New("BotWebHookOpts.Path must start with '/'")
|
||||||
|
}
|
||||||
|
if strings.Contains(path, "?") || strings.Contains(path, "#") {
|
||||||
|
return errors.New("BotWebHookOpts.Path must not contain query or fragment")
|
||||||
|
}
|
||||||
|
if useStatusPath && path == "/status" {
|
||||||
|
return errors.New("BotWebHookOpts.Path must not be '/status' when status path is enabled")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func validateWebhookTLSFiles(tlsFiles []string) error {
|
||||||
|
switch len(tlsFiles) {
|
||||||
|
case 0, 2:
|
||||||
|
return nil
|
||||||
|
case 1:
|
||||||
|
return errors.New("you must specify both private and public keys")
|
||||||
|
default:
|
||||||
|
return errors.New("too many files; you must specify only private and public keys")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,293 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"strings"
|
||||||
|
"sync/atomic"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
|
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestEnqueueUpdateCopiesValue(t *testing.T) {
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
updateQueue: make(chan *tgapi.Update, 1),
|
||||||
|
}
|
||||||
|
|
||||||
|
update := tgapi.Update{UpdateID: 42}
|
||||||
|
if err := bot.enqueueUpdate(context.Background(), update); err != nil {
|
||||||
|
t.Fatalf("enqueueUpdate returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
update.UpdateID = 99
|
||||||
|
|
||||||
|
got := <-bot.updateQueue
|
||||||
|
if got.UpdateID != 42 {
|
||||||
|
t.Fatalf("enqueueUpdate did not copy the update value: got %d want %d", got.UpdateID, 42)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUpdateHandlerEnqueuesUpdate(t *testing.T) {
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
updateQueue: make(chan *tgapi.Update, 1),
|
||||||
|
webHookLogger: sneklog.NewLogger(),
|
||||||
|
}
|
||||||
|
t.Cleanup(func() {
|
||||||
|
_ = bot.webHookLogger.Close()
|
||||||
|
})
|
||||||
|
|
||||||
|
req := httptest.NewRequest(http.MethodPost, "/", strings.NewReader(`{"update_id":7,"message":{"message_id":1,"date":1,"chat":{"id":1,"type":"private"},"text":"/start"}}`))
|
||||||
|
req.Header.Set("X-Telegram-Bot-Api-Secret-Token", "secret")
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
|
||||||
|
updateHandler(context.Background(), bot, "secret").ServeHTTP(rec, req)
|
||||||
|
|
||||||
|
if rec.Result().StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("unexpected status: got %d want %d", rec.Result().StatusCode, http.StatusOK)
|
||||||
|
}
|
||||||
|
|
||||||
|
select {
|
||||||
|
case got := <-bot.updateQueue:
|
||||||
|
if got.UpdateID != 7 {
|
||||||
|
t.Fatalf("unexpected update id in queue: got %d want %d", got.UpdateID, 7)
|
||||||
|
}
|
||||||
|
if got.Type != tgapi.UpdateTypeMessage {
|
||||||
|
t.Fatalf("unexpected update type in queue: got %q want %q", got.Type, tgapi.UpdateTypeMessage)
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
t.Fatal("expected webhook handler to enqueue an update")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRunWebhookRuntimeRejectsSecondRun(t *testing.T) {
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
updateQueue: make(chan *tgapi.Update, 1),
|
||||||
|
maxWorkers: 1,
|
||||||
|
}
|
||||||
|
t.Cleanup(func() {
|
||||||
|
_ = bot.logger.Close()
|
||||||
|
})
|
||||||
|
|
||||||
|
if err := bot.runWebhookRuntime(context.Background(), func(context.Context) error { return nil }); err != nil {
|
||||||
|
t.Fatalf("first runWebhookRuntime returned error: %v", err)
|
||||||
|
}
|
||||||
|
if err := bot.runWebhookRuntime(context.Background(), func(context.Context) error { return nil }); !errors.Is(err, ErrBotAlreadyRun) {
|
||||||
|
t.Fatalf("expected ErrBotAlreadyRun on second run, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRunWebhookRuntimeExecutesRunners(t *testing.T) {
|
||||||
|
var calls atomic.Int32
|
||||||
|
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
updateQueue: make(chan *tgapi.Update, 1),
|
||||||
|
maxWorkers: 1,
|
||||||
|
runners: []Runner[NoData]{
|
||||||
|
NewRunner("runner", func(bot *Bot[NoData]) error {
|
||||||
|
calls.Add(1)
|
||||||
|
return nil
|
||||||
|
}).Onetime(true).Async(false),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
t.Cleanup(func() {
|
||||||
|
_ = bot.logger.Close()
|
||||||
|
})
|
||||||
|
|
||||||
|
if err := bot.runWebhookRuntime(context.Background(), func(context.Context) error { return nil }); err != nil {
|
||||||
|
t.Fatalf("runWebhookRuntime returned error: %v", err)
|
||||||
|
}
|
||||||
|
if got := calls.Load(); got != 1 {
|
||||||
|
t.Fatalf("expected runner to execute once, got %d", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWebhookAllowedUpdatesUsesBotUpdateTypesByDefault(t *testing.T) {
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
updateTypes: []tgapi.UpdateType{tgapi.UpdateTypeMessage, tgapi.UpdateTypeCallbackQuery},
|
||||||
|
}
|
||||||
|
opts := NewBotWebHookOpts()
|
||||||
|
|
||||||
|
got := bot.webhookAllowedUpdates(opts)
|
||||||
|
if len(got) != 2 {
|
||||||
|
t.Fatalf("unexpected allowed updates length: got %d want %d", len(got), 2)
|
||||||
|
}
|
||||||
|
if got[0] != tgapi.UpdateTypeMessage || got[1] != tgapi.UpdateTypeCallbackQuery {
|
||||||
|
t.Fatalf("unexpected allowed updates: %v", got)
|
||||||
|
}
|
||||||
|
|
||||||
|
got[0] = tgapi.UpdateTypePoll
|
||||||
|
if bot.updateTypes[0] != tgapi.UpdateTypeMessage {
|
||||||
|
t.Fatalf("webhookAllowedUpdates exposed internal slice: got %v", bot.updateTypes)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestValidateWebhookPath(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
path string
|
||||||
|
useStatusPath bool
|
||||||
|
wantErr bool
|
||||||
|
}{
|
||||||
|
{name: "root", path: "/", wantErr: false},
|
||||||
|
{name: "custom path", path: "/telegram", wantErr: false},
|
||||||
|
{name: "empty", path: "", wantErr: true},
|
||||||
|
{name: "missing slash", path: "telegram", wantErr: true},
|
||||||
|
{name: "query", path: "/telegram?x=1", wantErr: true},
|
||||||
|
{name: "fragment", path: "/telegram#main", wantErr: true},
|
||||||
|
{name: "status collision", path: "/status", useStatusPath: true, wantErr: true},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tc := range tests {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
err := validateWebhookPath(tc.path, tc.useStatusPath)
|
||||||
|
if tc.wantErr && err == nil {
|
||||||
|
t.Fatal("expected error, got nil")
|
||||||
|
}
|
||||||
|
if !tc.wantErr && err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestValidateWebhookTLSFiles(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
files []string
|
||||||
|
wantErr bool
|
||||||
|
}{
|
||||||
|
{name: "no tls", files: nil, wantErr: false},
|
||||||
|
{name: "two files", files: []string{"key.pem", "cert.pem"}, wantErr: false},
|
||||||
|
{name: "one file", files: []string{"cert.pem"}, wantErr: true},
|
||||||
|
{name: "three files", files: []string{"a", "b", "c"}, wantErr: true},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tc := range tests {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
err := validateWebhookTLSFiles(tc.files)
|
||||||
|
if tc.wantErr && err == nil {
|
||||||
|
t.Fatal("expected error, got nil")
|
||||||
|
}
|
||||||
|
if !tc.wantErr && err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUpdateHandlerRejectsOversizedBody(t *testing.T) {
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
updateQueue: make(chan *tgapi.Update, 1),
|
||||||
|
webHookLogger: sneklog.NewLogger(),
|
||||||
|
}
|
||||||
|
t.Cleanup(func() {
|
||||||
|
_ = bot.webHookLogger.Close()
|
||||||
|
})
|
||||||
|
|
||||||
|
req := httptest.NewRequest(http.MethodPost, "/", strings.NewReader(strings.Repeat("a", (256<<10)+1)))
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
|
||||||
|
updateHandler(context.Background(), bot, "").ServeHTTP(rec, req)
|
||||||
|
|
||||||
|
if rec.Result().StatusCode != http.StatusRequestEntityTooLarge {
|
||||||
|
t.Fatalf("unexpected status: got %d want %d", rec.Result().StatusCode, http.StatusRequestEntityTooLarge)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStatusHandlerRequiresMatchingSecret(t *testing.T) {
|
||||||
|
client := &http.Client{
|
||||||
|
Transport: pollingRoundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||||
|
Body: io.NopCloser(strings.NewReader(`{"ok":true,"result":{"url":"https://bot.example.com/telegram"}}`)),
|
||||||
|
}, nil
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
api := tgapi.NewAPI(
|
||||||
|
tgapi.NewAPIOpts("token").
|
||||||
|
SetAPIURL("http://example.invalid").
|
||||||
|
SetHTTPClient(client),
|
||||||
|
)
|
||||||
|
defer func() {
|
||||||
|
_ = api.Close()
|
||||||
|
}()
|
||||||
|
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
api: api,
|
||||||
|
webHookLogger: sneklog.NewLogger(),
|
||||||
|
}
|
||||||
|
t.Cleanup(func() {
|
||||||
|
_ = bot.webHookLogger.Close()
|
||||||
|
})
|
||||||
|
|
||||||
|
handler := statusHandler(bot, &BotWebHookOpts{SecretToken: "secret"})
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
headerName string
|
||||||
|
headerVal string
|
||||||
|
wantStatus int
|
||||||
|
}{
|
||||||
|
{name: "missing auth", wantStatus: http.StatusNotFound},
|
||||||
|
{name: "wrong auth", headerName: "Authorization", headerVal: "wrong", wantStatus: http.StatusNotFound},
|
||||||
|
{name: "matching telegram header", headerName: "X-Telegram-Bot-Api-Secret-Token", headerVal: "secret", wantStatus: http.StatusOK},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tc := range tests {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
req := httptest.NewRequest(http.MethodGet, "/status", nil)
|
||||||
|
if tc.headerName != "" {
|
||||||
|
req.Header.Set(tc.headerName, tc.headerVal)
|
||||||
|
}
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
|
||||||
|
handler.ServeHTTP(rec, req)
|
||||||
|
|
||||||
|
if rec.Result().StatusCode != tc.wantStatus {
|
||||||
|
t.Fatalf("unexpected status: got %d want %d", rec.Result().StatusCode, tc.wantStatus)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRunWebHookWithContextRejectsInvalidTLSFilesBeforeRemoteSetup(t *testing.T) {
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
prefixes: []string{"/"},
|
||||||
|
plugins: []Plugin[NoData]{{name: "demo"}},
|
||||||
|
}
|
||||||
|
opts := NewBotWebHookOpts().SetURL("https://bot.example.com")
|
||||||
|
|
||||||
|
err := bot.RunWebHookWithContext(context.Background(), opts, "cert.pem")
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected tls validation error, got nil")
|
||||||
|
}
|
||||||
|
if !strings.Contains(err.Error(), "both private and public keys") {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRunWebHookWithContextRequiresSecretWhenStatusPathEnabled(t *testing.T) {
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
prefixes: []string{"/"},
|
||||||
|
plugins: []Plugin[NoData]{{name: "demo"}},
|
||||||
|
}
|
||||||
|
opts := NewBotWebHookOpts().
|
||||||
|
SetURL("https://bot.example.com").
|
||||||
|
SetUseStatusPath(true)
|
||||||
|
|
||||||
|
err := bot.RunWebHookWithContext(context.Background(), opts)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected status-path secret validation error, got nil")
|
||||||
|
}
|
||||||
|
if !strings.Contains(err.Error(), "SecretToken required") {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,175 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"regexp"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
|
)
|
||||||
|
|
||||||
|
// CmdRegexp matches command names allowed for Telegram command registration.
|
||||||
|
var CmdRegexp = regexp.MustCompile("^[_a-z0-9]{1,32}$")
|
||||||
|
|
||||||
|
// 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")
|
||||||
|
|
||||||
|
// Internal helper to build a BotCommand description with generated usage text.
|
||||||
|
func generateBotCommand[T any](cmd *Command[T]) tgapi.BotCommand {
|
||||||
|
desc := ""
|
||||||
|
if len(cmd.description) > 0 {
|
||||||
|
desc = cmd.description
|
||||||
|
}
|
||||||
|
|
||||||
|
var descArgs []string
|
||||||
|
for _, a := range cmd.args {
|
||||||
|
if a.required {
|
||||||
|
descArgs = append(descArgs, fmt.Sprintf("<%s>", a.text))
|
||||||
|
} else {
|
||||||
|
descArgs = append(descArgs, fmt.Sprintf("[%s]", a.text))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
usage := fmt.Sprintf("Usage: /%s %s", cmd.command, strings.Join(descArgs, " "))
|
||||||
|
if desc != "" {
|
||||||
|
desc = fmt.Sprintf("%s. %s", desc, usage)
|
||||||
|
return tgapi.BotCommand{Command: cmd.command, Description: desc}
|
||||||
|
}
|
||||||
|
return tgapi.BotCommand{Command: cmd.command, Description: usage}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Internal helper to validate Telegram command names.
|
||||||
|
func checkCmdRegex(cmd string) bool { return CmdRegexp.MatchString(cmd) }
|
||||||
|
|
||||||
|
// Internal helper to collect non-skipped, valid commands from one plugin.
|
||||||
|
func gatherCommandsForPlugin[T any](pl Plugin[T]) []tgapi.BotCommand {
|
||||||
|
commands := make([]tgapi.BotCommand, 0)
|
||||||
|
names := make([]string, 0, len(pl.commands))
|
||||||
|
for name := range pl.commands {
|
||||||
|
names = append(names, name)
|
||||||
|
}
|
||||||
|
sort.Strings(names)
|
||||||
|
|
||||||
|
for _, name := range names {
|
||||||
|
cmd := pl.commands[name]
|
||||||
|
if cmd.skipAutoCmd {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if !checkCmdRegex(cmd.command) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
commands = append(commands, generateBotCommand(cmd))
|
||||||
|
}
|
||||||
|
return commands
|
||||||
|
}
|
||||||
|
|
||||||
|
// Internal helper to collect all auto-generated commands from registered plugins.
|
||||||
|
func gatherCommands[T any](bot *Bot[T]) []tgapi.BotCommand {
|
||||||
|
commands := make([]tgapi.BotCommand, 0)
|
||||||
|
for _, pl := range bot.plugins {
|
||||||
|
if pl.skipAutoCmd {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
commands = append(commands, gatherCommandsForPlugin(pl)...)
|
||||||
|
bot.logger.Debugln(fmt.Sprintf("Registered %d commands from plugin %s", len(pl.commands), pl.name))
|
||||||
|
}
|
||||||
|
return commands
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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 {
|
||||||
|
commands := gatherCommands(bot)
|
||||||
|
if len(commands) > 100 {
|
||||||
|
return ErrTooManyCommands
|
||||||
|
}
|
||||||
|
|
||||||
|
// Clear existing commands to avoid duplication or stale entries
|
||||||
|
_, err := bot.api.DeleteMyCommands(tgapi.DeleteMyCommands{})
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to delete existing commands: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Register commands for each scope
|
||||||
|
scopes := []*tgapi.BotCommandScope{
|
||||||
|
{Type: tgapi.BotCommandScopePrivateType},
|
||||||
|
{Type: tgapi.BotCommandScopeGroupType},
|
||||||
|
{Type: tgapi.BotCommandScopeAllChatAdministratorsType},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, scope := range scopes {
|
||||||
|
_, err = bot.api.SetMyCommands(tgapi.SetMyCommands{
|
||||||
|
Commands: commands,
|
||||||
|
Scope: scope,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to set commands for scope %q: %w", scope.Type, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// AutoGenerateCommandsForScope registers all plugin-defined commands with Telegram's Bot API
|
||||||
|
// for the specified command scope. It first deletes any existing commands in that scope
|
||||||
|
// to ensure a clean state, then sets the new set of commands.
|
||||||
|
//
|
||||||
|
// The scope parameter defines where the commands should be available (e.g., private chats,
|
||||||
|
// group chats, chat administrators). See tgapi.BotCommandScope and its predefined types.
|
||||||
|
//
|
||||||
|
// Returns ErrTooManyCommands if the total number of commands exceeds 100.
|
||||||
|
// Returns any API error from Telegram (e.g., network issues, invalid scope).
|
||||||
|
//
|
||||||
|
// Usage:
|
||||||
|
//
|
||||||
|
// privateScope := &tgapi.BotCommandScope{Type: tgapi.BotCommandScopePrivateType}
|
||||||
|
// if err := bot.AutoGenerateCommandsForScope(privateScope); err != nil {
|
||||||
|
// log.Fatal(err)
|
||||||
|
// }
|
||||||
|
func (bot *Bot[T]) AutoGenerateCommandsForScope(scope *tgapi.BotCommandScope) error {
|
||||||
|
commands := gatherCommands(bot)
|
||||||
|
if len(commands) > 100 {
|
||||||
|
return ErrTooManyCommands
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err := bot.api.DeleteMyCommands(tgapi.DeleteMyCommands{Scope: scope})
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to delete existing commands: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err = bot.api.SetMyCommands(tgapi.SetMyCommands{
|
||||||
|
Commands: commands,
|
||||||
|
Scope: scope,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to set commands for scope %q: %w", scope.Type, err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,85 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"reflect"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"sync/atomic"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
|
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||||
|
)
|
||||||
|
|
||||||
|
type roundTripFunc func(*http.Request) (*http.Response, error)
|
||||||
|
|
||||||
|
func (fn roundTripFunc) RoundTrip(req *http.Request) (*http.Response, error) {
|
||||||
|
return fn(req)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAutoGenerateCommandsChecksLimitBeforeDelete(t *testing.T) {
|
||||||
|
var calls atomic.Int64
|
||||||
|
client := &http.Client{
|
||||||
|
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
calls.Add(1)
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||||
|
Body: io.NopCloser(strings.NewReader(`{"ok":true,"result":true}`)),
|
||||||
|
}, nil
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
api := tgapi.NewAPI(
|
||||||
|
tgapi.NewAPIOpts("token").
|
||||||
|
SetAPIURL("https://example.test").
|
||||||
|
SetHTTPClient(client),
|
||||||
|
)
|
||||||
|
defer func() {
|
||||||
|
if err := api.Close(); err != nil {
|
||||||
|
t.Fatalf("Close returned error: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
plugin := NewPlugin[NoData]("overflow")
|
||||||
|
exec := func(ctx *MsgContext, db NoData) error { return nil }
|
||||||
|
for i := 0; i < 101; i++ {
|
||||||
|
plugin.AddCommand(NewCommand(exec, "cmd"+strconv.Itoa(i)))
|
||||||
|
}
|
||||||
|
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
api: api,
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
plugins: []Plugin[NoData]{*plugin},
|
||||||
|
}
|
||||||
|
|
||||||
|
err := bot.AutoGenerateCommands()
|
||||||
|
if !errors.Is(err, ErrTooManyCommands) {
|
||||||
|
t.Fatalf("expected ErrTooManyCommands, got %v", err)
|
||||||
|
}
|
||||||
|
if calls.Load() != 0 {
|
||||||
|
t.Fatalf("expected no HTTP calls before limit validation, got %d", calls.Load())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGatherCommandsForPluginReturnsSortedCommands(t *testing.T) {
|
||||||
|
plugin := NewPlugin[NoData]("sorted")
|
||||||
|
exec := func(ctx *MsgContext, db NoData) error { return nil }
|
||||||
|
|
||||||
|
plugin.AddCommand(NewCommand(exec, "zeta"))
|
||||||
|
plugin.AddCommand(NewCommand(exec, "alpha"))
|
||||||
|
plugin.AddCommand(NewCommand(exec, "mid"))
|
||||||
|
|
||||||
|
commands := gatherCommandsForPlugin(*plugin)
|
||||||
|
got := make([]string, 0, len(commands))
|
||||||
|
for _, cmd := range commands {
|
||||||
|
got = append(got, cmd.Command)
|
||||||
|
}
|
||||||
|
|
||||||
|
want := []string{"alpha", "mid", "zeta"}
|
||||||
|
if !reflect.DeepEqual(got, want) {
|
||||||
|
t.Fatalf("unexpected command order: got %v want %v", got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
/*
|
||||||
|
Package laniakea provides a modular, extensible framework for building scalable Telegram bots.
|
||||||
|
|
||||||
|
Core concepts:
|
||||||
|
|
||||||
|
- Bot manages Telegram API access, update processing, logging, rate limiting, and dependency injection.
|
||||||
|
- Plugins group commands, payloads, and non-command update handlers behind shared middleware.
|
||||||
|
- MsgContext provides access to the current update and reply/edit/delete helpers.
|
||||||
|
- InlineKeyboard builds callback-driven keyboards and structured payloads.
|
||||||
|
- DraftProvider accumulates multi-step replies before sending them.
|
||||||
|
- L10n stores key-based translations with fallback behavior.
|
||||||
|
- Runners execute startup or background tasks alongside the polling loop.
|
||||||
|
|
||||||
|
Example usage:
|
||||||
|
|
||||||
|
bot, err := laniakea.NewBot[*mydb.AppData](laniakea.LoadOptsFromEnv())
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
bot.SetAppData(myDB).
|
||||||
|
AddUpdateType(tgapi.UpdateTypeMessage).
|
||||||
|
AddPrefixes("/", "!").
|
||||||
|
AddPlugins(&startPlugin, &helpPlugin).
|
||||||
|
AddMiddleware(authMiddleware, logMiddleware).
|
||||||
|
AddRunner(cleanupRunner).
|
||||||
|
SetL10n(l10n.New())
|
||||||
|
|
||||||
|
return bot.Run()
|
||||||
|
|
||||||
|
Configure bots, plugins, and localization before starting Run, RunWithContext, or RunWebHookWithContext.
|
||||||
|
Runtime accessors are safe for concurrent use unless stated otherwise.
|
||||||
|
*/
|
||||||
|
package laniakea
|
||||||
@@ -0,0 +1,262 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"math/rand/v2"
|
||||||
|
"sync"
|
||||||
|
"sync/atomic"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Interface for generating unique draft IDs.
|
||||||
|
type draftIDGenerator interface {
|
||||||
|
// Next returns the next unique draft ID.
|
||||||
|
Next() uint64
|
||||||
|
}
|
||||||
|
|
||||||
|
// RandomDraftIDGenerator generates draft IDs using cryptographically secure random numbers.
|
||||||
|
// Suitable for distributed systems or when ID predictability is undesirable.
|
||||||
|
type RandomDraftIDGenerator struct{}
|
||||||
|
|
||||||
|
// Next returns a random 64-bit unsigned integer.
|
||||||
|
func (g *RandomDraftIDGenerator) Next() uint64 {
|
||||||
|
return rand.Uint64()
|
||||||
|
}
|
||||||
|
|
||||||
|
// LinearDraftIDGenerator generates draft IDs using a monotonically increasing counter.
|
||||||
|
// Useful for debugging, persistence, or when drafts must be ordered.
|
||||||
|
type LinearDraftIDGenerator struct {
|
||||||
|
lastID atomic.Uint64
|
||||||
|
}
|
||||||
|
|
||||||
|
// Next returns the next linear ID, atomically incremented.о
|
||||||
|
func (g *LinearDraftIDGenerator) Next() uint64 {
|
||||||
|
return g.lastID.Add(1)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DraftProvider manages a collection of Drafts and a shared draft ID generator.
|
||||||
|
//
|
||||||
|
// DraftProvider is safe for concurrent use.
|
||||||
|
type DraftProvider struct {
|
||||||
|
mu sync.RWMutex
|
||||||
|
api *tgapi.API
|
||||||
|
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),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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) {
|
||||||
|
p.mu.RLock()
|
||||||
|
defer p.mu.RUnlock()
|
||||||
|
draft, ok := p.drafts[id]
|
||||||
|
return draft, ok
|
||||||
|
}
|
||||||
|
|
||||||
|
// FlushAll sends all pending drafts as final messages and clears them.
|
||||||
|
//
|
||||||
|
// If one or more drafts fail to send, FlushAll still attempts all drafts and
|
||||||
|
// returns the first encountered error.
|
||||||
|
//
|
||||||
|
// After successful flush, each draft is removed from the provider and cleared.
|
||||||
|
func (p *DraftProvider) FlushAll() error {
|
||||||
|
p.mu.RLock()
|
||||||
|
drafts := make([]*Draft, 0, len(p.drafts))
|
||||||
|
for _, draft := range p.drafts {
|
||||||
|
drafts = append(drafts, draft)
|
||||||
|
}
|
||||||
|
p.mu.RUnlock()
|
||||||
|
|
||||||
|
var firstErr error
|
||||||
|
for _, draft := range drafts {
|
||||||
|
if err := draft.Flush(); err != nil && firstErr == nil {
|
||||||
|
firstErr = err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return firstErr
|
||||||
|
}
|
||||||
|
|
||||||
|
// Draft represents a single message draft that can be edited and flushed.
|
||||||
|
//
|
||||||
|
// Drafts are safe to use from a single goroutine. Multiple goroutines must
|
||||||
|
// synchronize access manually.
|
||||||
|
//
|
||||||
|
// Drafts are automatically removed from the provider's map when Flush() succeeds.
|
||||||
|
type Draft struct {
|
||||||
|
api *tgapi.API
|
||||||
|
provider *DraftProvider
|
||||||
|
|
||||||
|
chatID int64
|
||||||
|
messageThreadID int
|
||||||
|
parseMode tgapi.ParseMode
|
||||||
|
entities []tgapi.MessageEntity
|
||||||
|
|
||||||
|
ID uint64
|
||||||
|
Message string
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewDraft creates a new draft with the provided parse mode.
|
||||||
|
//
|
||||||
|
// The caller must set a chat with SetChat before Push or Flush.
|
||||||
|
func (p *DraftProvider) NewDraft(parseMode tgapi.ParseMode) *Draft {
|
||||||
|
id := p.generator.Next()
|
||||||
|
draft := &Draft{
|
||||||
|
api: p.api,
|
||||||
|
provider: p,
|
||||||
|
parseMode: parseMode,
|
||||||
|
ID: id,
|
||||||
|
Message: "",
|
||||||
|
}
|
||||||
|
p.mu.Lock()
|
||||||
|
p.drafts[id] = draft
|
||||||
|
p.mu.Unlock()
|
||||||
|
return draft
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChat overrides the draft's target chat and message thread.
|
||||||
|
//
|
||||||
|
// This is useful for sending a draft to a different chat than the provider's default.
|
||||||
|
func (d *Draft) SetChat(chatID int64, messageThreadID int) *Draft {
|
||||||
|
d.chatID = chatID
|
||||||
|
d.messageThreadID = messageThreadID
|
||||||
|
return d
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetEntities replaces the draft's message entities.
|
||||||
|
//
|
||||||
|
// Entities are stored by reference. If you plan to mutate the slice later,
|
||||||
|
// pass a copy: `SetEntities(append([]tgapi.MessageEntity{}, myEntities...))`.
|
||||||
|
func (d *Draft) SetEntities(entities []tgapi.MessageEntity) *Draft {
|
||||||
|
d.entities = entities
|
||||||
|
return d
|
||||||
|
}
|
||||||
|
|
||||||
|
// Push appends text to the draft and attempts to update the server-side draft.
|
||||||
|
//
|
||||||
|
// Returns an error if the Telegram API rejects the update (e.g., due to network issues).
|
||||||
|
// The draft's Message field is always updated, even if the API call fails.
|
||||||
|
//
|
||||||
|
// Use this method to build the message incrementally.
|
||||||
|
func (d *Draft) Push(text string) error {
|
||||||
|
return d.push(text)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetMessage returns the current content of the draft.
|
||||||
|
//
|
||||||
|
// Useful for inspection, logging, or validation before flushing.
|
||||||
|
func (d *Draft) GetMessage() string {
|
||||||
|
return d.Message
|
||||||
|
}
|
||||||
|
|
||||||
|
// Clear resets the draft's message content to empty string.
|
||||||
|
//
|
||||||
|
// Does not affect server-side draft — use Flush() for that.
|
||||||
|
func (d *Draft) Clear() {
|
||||||
|
d.Message = ""
|
||||||
|
}
|
||||||
|
|
||||||
|
// Delete removes the draft from its provider and clears its content.
|
||||||
|
//
|
||||||
|
// This is an internal method used by Flush(). You may call it manually if you
|
||||||
|
// want to cancel a draft without sending it.
|
||||||
|
func (d *Draft) Delete() {
|
||||||
|
if d.provider != nil {
|
||||||
|
d.provider.mu.Lock()
|
||||||
|
delete(d.provider.drafts, d.ID)
|
||||||
|
d.provider.mu.Unlock()
|
||||||
|
}
|
||||||
|
d.Clear()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Flush sends the draft as a final message and clears it locally.
|
||||||
|
//
|
||||||
|
// If successful:
|
||||||
|
// - The message is sent to Telegram.
|
||||||
|
// - The draft's content is cleared.
|
||||||
|
// - The draft is removed from the provider's map.
|
||||||
|
//
|
||||||
|
// If an error occurs:
|
||||||
|
// - The message is NOT sent.
|
||||||
|
// - The draft remains in the provider and retains its content.
|
||||||
|
// - You can call Flush() again to retry.
|
||||||
|
//
|
||||||
|
// If the draft is empty, Flush() returns nil without calling the API.
|
||||||
|
func (d *Draft) Flush() error {
|
||||||
|
if d.Message == "" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if d.chatID == 0 {
|
||||||
|
return ErrDraftChatIDZero
|
||||||
|
}
|
||||||
|
if err := validateMessageText(d.Message); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
params := tgapi.SendMessage{
|
||||||
|
ChatID: d.chatID,
|
||||||
|
ParseMode: d.parseMode,
|
||||||
|
Entities: d.entities,
|
||||||
|
Text: d.Message,
|
||||||
|
}
|
||||||
|
if d.messageThreadID > 0 {
|
||||||
|
params.MessageThreadID = d.messageThreadID
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err := d.api.SendMessage(params)
|
||||||
|
if err == nil {
|
||||||
|
d.Delete()
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Internal helper for Push that updates the server-side draft.
|
||||||
|
func (d *Draft) push(text string) error {
|
||||||
|
if d.chatID == 0 {
|
||||||
|
return ErrDraftChatIDZero
|
||||||
|
}
|
||||||
|
d.Message += text
|
||||||
|
if err := validateMessageText(d.Message); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
params := tgapi.SendMessageDraft{
|
||||||
|
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
|
||||||
|
}
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
|
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestDraftFlushRequiresChatID(t *testing.T) {
|
||||||
|
draft := NewRandomDraftProvider(&tgapi.API{}).NewDraft(tgapi.ParseNone)
|
||||||
|
draft.Message = "hello"
|
||||||
|
|
||||||
|
if err := draft.Flush(); !errors.Is(err, ErrDraftChatIDZero) {
|
||||||
|
t.Fatalf("expected ErrDraftChatIDZero, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMsgContextNewDraftWorksWithoutLimiter(t *testing.T) {
|
||||||
|
ctx := &MsgContext{
|
||||||
|
API: &tgapi.API{},
|
||||||
|
Msg: &tgapi.Message{
|
||||||
|
Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate},
|
||||||
|
},
|
||||||
|
Logger: sneklog.NewLogger(),
|
||||||
|
draftProvider: NewRandomDraftProvider(&tgapi.API{}),
|
||||||
|
}
|
||||||
|
|
||||||
|
draft := ctx.NewDraft()
|
||||||
|
if draft == nil {
|
||||||
|
t.Fatal("expected draft")
|
||||||
|
}
|
||||||
|
if draft.chatID != 42 {
|
||||||
|
t.Fatalf("unexpected chat id: %d", draft.chatID)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDraftFlushRejectsLongMessage(t *testing.T) {
|
||||||
|
draft := NewRandomDraftProvider(&tgapi.API{}).NewDraft(tgapi.ParseNone).SetChat(42, 0)
|
||||||
|
draft.Message = strings.Repeat("a", maxMessageTextLen+1)
|
||||||
|
|
||||||
|
if err := draft.Flush(); !errors.Is(err, ErrMessageTooLong) {
|
||||||
|
t.Fatalf("expected ErrMessageTooLong, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDraftPushRejectsLongMessage(t *testing.T) {
|
||||||
|
draft := NewRandomDraftProvider(&tgapi.API{}).NewDraft(tgapi.ParseNone).SetChat(42, 0)
|
||||||
|
|
||||||
|
if err := draft.Push(strings.Repeat("a", maxMessageTextLen+1)); !errors.Is(err, ErrMessageTooLong) {
|
||||||
|
t.Fatalf("expected ErrMessageTooLong, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,59 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import "errors"
|
||||||
|
|
||||||
|
type classifiedError struct {
|
||||||
|
err error
|
||||||
|
userVisible bool
|
||||||
|
internalOnly bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *classifiedError) Error() string {
|
||||||
|
if e == nil || e.err == nil {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return e.err.Error()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *classifiedError) Unwrap() error {
|
||||||
|
if e == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return e.err
|
||||||
|
}
|
||||||
|
|
||||||
|
// AsUserError marks err as safe to show to the user through the centralized
|
||||||
|
// handler error flow.
|
||||||
|
func AsUserError(err error) error {
|
||||||
|
if err == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return &classifiedError{err: err, userVisible: true}
|
||||||
|
}
|
||||||
|
|
||||||
|
// AsInternalError marks err as internal-only so it will be logged but not sent
|
||||||
|
// to the user through the centralized handler error flow.
|
||||||
|
func AsInternalError(err error) error {
|
||||||
|
if err == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return &classifiedError{err: err, internalOnly: true}
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsUserError reports whether err was explicitly marked as user-visible.
|
||||||
|
func IsUserError(err error) bool {
|
||||||
|
var classified *classifiedError
|
||||||
|
if !errors.As(err, &classified) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return classified.userVisible
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsInternalError reports whether err was explicitly marked as internal-only.
|
||||||
|
func IsInternalError(err error) bool {
|
||||||
|
var classified *classifiedError
|
||||||
|
if !errors.As(err, &classified) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return classified.internalOnly
|
||||||
|
}
|
||||||
@@ -0,0 +1,81 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"unicode/utf8"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
maxMessageTextLen = 4096
|
||||||
|
maxMessageCaptionLen = 1024
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
// ErrEmptyMessage reports that a required message text is empty.
|
||||||
|
ErrEmptyMessage = errors.New("empty message")
|
||||||
|
// ErrMessageTooLong reports that a message exceeds Telegram's text limit.
|
||||||
|
ErrMessageTooLong = errors.New("message too long")
|
||||||
|
// ErrCaptionTooLong reports that a caption exceeds Telegram's caption limit.
|
||||||
|
ErrCaptionTooLong = errors.New("caption too long")
|
||||||
|
// ErrMessageSplitImpossible reports that automatic message splitting cannot preserve semantics.
|
||||||
|
ErrMessageSplitImpossible = errors.New("message split is impossible")
|
||||||
|
// ErrPayloadTypeMismatch reports that callback payload encoding does not match bot policy.
|
||||||
|
ErrPayloadTypeMismatch = errors.New("payload type mismatch")
|
||||||
|
// ErrDraftChatIDZero reports that a draft has no target chat ID.
|
||||||
|
ErrDraftChatIDZero = errors.New("zero draft chat ID")
|
||||||
|
// ErrMessageNil reports that a required message value is nil.
|
||||||
|
ErrMessageNil = errors.New("message is nil")
|
||||||
|
// ErrMessageContextNil reports that an operation requires ctx.Msg but none is set.
|
||||||
|
ErrMessageContextNil = errors.New("message context is nil")
|
||||||
|
// ErrEditTargetMissing reports that an edit operation has no message target.
|
||||||
|
ErrEditTargetMissing = errors.New("edit target is missing")
|
||||||
|
// ErrCallbackMessageMissing reports that a callback operation has no callback message target.
|
||||||
|
ErrCallbackMessageMissing = errors.New("callback message is missing")
|
||||||
|
// ErrDraftProviderNil reports that draft creation was requested without a draft provider.
|
||||||
|
ErrDraftProviderNil = errors.New("draft provider is nil")
|
||||||
|
// ErrAPIIsNil reports that an operation requires an API client but none is set.
|
||||||
|
ErrAPIIsNil = errors.New("api is nil")
|
||||||
|
// ErrMessageIDZero reports that an operation requires a non-zero message ID.
|
||||||
|
ErrMessageIDZero = errors.New("message ID is zero")
|
||||||
|
// ErrBindArgsTargetNotPointer reports that BindArgs received a nil or non-pointer destination.
|
||||||
|
ErrBindArgsTargetNotPointer = errors.New("bind args: dst must be a non-nil pointer")
|
||||||
|
// ErrBindArgsTargetNotStruct reports that BindArgs received a pointer to a non-struct value.
|
||||||
|
ErrBindArgsTargetNotStruct = errors.New("bind args: dst must point to a struct")
|
||||||
|
// ErrBindArgsUnsupportedFieldType reports that BindArgs encountered an unsupported field kind.
|
||||||
|
ErrBindArgsUnsupportedFieldType = errors.New("bind args: unsupported field type")
|
||||||
|
// ErrBindArgsConversion reports that BindArgs could not convert a string argument into a field type.
|
||||||
|
ErrBindArgsConversion = errors.New("bind args: conversion failed")
|
||||||
|
// ErrCantFindSession reports that no scene session matches the current context.
|
||||||
|
ErrCantFindSession = errors.New("can't find session for this context")
|
||||||
|
// ErrSceneNotFound reports that the requested scene is not registered.
|
||||||
|
ErrSceneNotFound = errors.New("scene not found")
|
||||||
|
// ErrSceneStepNotFound reports that the requested scene step is not registered.
|
||||||
|
ErrSceneStepNotFound = errors.New("scene step not found")
|
||||||
|
// ErrNotInScene reports that the current context has no active scene session.
|
||||||
|
ErrNotInScene = errors.New("not in scene")
|
||||||
|
// ErrSceneEntryNotSet reports that a scene has no configured entry step.
|
||||||
|
ErrSceneEntryNotSet = errors.New("scene entry step not set")
|
||||||
|
// ErrSceneRuntimeNil reports that scene APIs were used without an attached runtime.
|
||||||
|
ErrSceneRuntimeNil = errors.New("scene runtime is nil")
|
||||||
|
)
|
||||||
|
|
||||||
|
func validateMessageText(text string) error {
|
||||||
|
length := utf8.RuneCountInString(text)
|
||||||
|
switch {
|
||||||
|
case length == 0:
|
||||||
|
return ErrEmptyMessage
|
||||||
|
case length > maxMessageTextLen:
|
||||||
|
return fmt.Errorf("%w: got %d, limit %d", ErrMessageTooLong, length, maxMessageTextLen)
|
||||||
|
default:
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func validateCaptionText(text string) error {
|
||||||
|
length := utf8.RuneCountInString(text)
|
||||||
|
if length > maxMessageCaptionLen {
|
||||||
|
return fmt.Errorf("%w: got %d, limit %d", ErrCaptionTooLong, length, maxMessageCaptionLen)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -1,29 +1,12 @@
|
|||||||
module git.nix13.pw/scuroneko/laniakea
|
module git.scuroneko.dev/scuroneko/laniakea
|
||||||
|
|
||||||
go 1.25
|
go 1.26
|
||||||
|
|
||||||
|
retract v1.0.0-rc.5
|
||||||
|
|
||||||
require (
|
require (
|
||||||
git.nix13.pw/scuroneko/slog v1.0.0
|
git.scuroneko.dev/scuroneko/extypes v1.2.3
|
||||||
github.com/redis/go-redis/v9 v9.17.3
|
git.scuroneko.dev/scuroneko/sneklog/v2 v2.3.0
|
||||||
github.com/vinovest/sqlx v1.7.1
|
github.com/alitto/pond/v2 v2.7.1
|
||||||
go.mongodb.org/mongo-driver/v2 v2.4.2
|
golang.org/x/time v0.15.0
|
||||||
)
|
|
||||||
|
|
||||||
require (
|
|
||||||
github.com/cespare/xxhash/v2 v2.3.0 // indirect
|
|
||||||
github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect
|
|
||||||
github.com/fatih/color v1.18.0 // indirect
|
|
||||||
github.com/golang/snappy v1.0.0 // indirect
|
|
||||||
github.com/klauspost/compress v1.16.7 // indirect
|
|
||||||
github.com/mattn/go-colorable v0.1.14 // indirect
|
|
||||||
github.com/mattn/go-isatty v0.0.20 // indirect
|
|
||||||
github.com/muir/sqltoken v0.1.0 // indirect
|
|
||||||
github.com/xdg-go/pbkdf2 v1.0.0 // indirect
|
|
||||||
github.com/xdg-go/scram v1.1.2 // indirect
|
|
||||||
github.com/xdg-go/stringprep v1.0.4 // indirect
|
|
||||||
github.com/youmark/pkcs8 v0.0.0-20240726163527-a2c0da244d78 // indirect
|
|
||||||
golang.org/x/crypto v0.33.0 // indirect
|
|
||||||
golang.org/x/sync v0.11.0 // indirect
|
|
||||||
golang.org/x/sys v0.40.0 // indirect
|
|
||||||
golang.org/x/text v0.22.0 // indirect
|
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -1,87 +1,8 @@
|
|||||||
filippo.io/edwards25519 v1.1.0 h1:FNf4tywRC1HmFuKW5xopWpigGjJKiJSV0Cqo0cJWDaA=
|
git.scuroneko.dev/scuroneko/extypes v1.2.3 h1:n7QsfTZEn9fJNZLXGH/LkNq4cADaRk+LTu6LNMv9y6s=
|
||||||
filippo.io/edwards25519 v1.1.0/go.mod h1:BxyFTGdWcka3PhytdK4V28tE5sGfRvvvRV7EaN4VDT4=
|
git.scuroneko.dev/scuroneko/extypes v1.2.3/go.mod h1:MhYpXC6sloLOpoM2guf64eSOrz+ET/QJZ8toobc3Ors=
|
||||||
git.nix13.pw/scuroneko/slog v1.0.0 h1:PI0YePrmCopjrljUfwCtBIEwNYB+PBgDzPcCXbetpcE=
|
git.scuroneko.dev/scuroneko/sneklog/v2 v2.3.0 h1:gaPe5azwuDTh48jRB/P2FUgOs7f1ToNr0S+NBizKvY8=
|
||||||
git.nix13.pw/scuroneko/slog v1.0.0/go.mod h1:3Qm2wzkR5KjwOponMfG7TcGSDjmYaFqRAmLvSPTuWJI=
|
git.scuroneko.dev/scuroneko/sneklog/v2 v2.3.0/go.mod h1:q8XnLXzLdGjW0Jtcbh9/+G9WmfD68rsPQvLXEPxvum4=
|
||||||
github.com/bsm/ginkgo/v2 v2.12.0 h1:Ny8MWAHyOepLGlLKYmXG4IEkioBysk6GpaRTLC8zwWs=
|
github.com/alitto/pond/v2 v2.7.1 h1:QxMbcfjcVTa0pyxX5Ib1226mM8u8D7gKUVkCUU4DYIw=
|
||||||
github.com/bsm/ginkgo/v2 v2.12.0/go.mod h1:SwYbGRRDovPVboqFv0tPTcG1sN61LM1Z4ARdbAV9g4c=
|
github.com/alitto/pond/v2 v2.7.1/go.mod h1:xkjYEgQ05RSpWdfSd1nM3OVv7TBhLdy7rMp3+2Nq+yE=
|
||||||
github.com/bsm/gomega v1.27.10 h1:yeMWxP2pV2fG3FgAODIY8EiRE3dy0aeFYt4l7wh6yKA=
|
golang.org/x/time v0.15.0 h1:bbrp8t3bGUeFOx08pvsMYRTCVSMk89u4tKbNOZbp88U=
|
||||||
github.com/bsm/gomega v1.27.10/go.mod h1:JyEr/xRbxbtgWNi8tIEVPUYZ5Dzef52k01W3YH0H+O0=
|
golang.org/x/time v0.15.0/go.mod h1:Y4YMaQmXwGQZoFaVFk4YpCt4FLQMYKZe9oeV/f4MSno=
|
||||||
github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs=
|
|
||||||
github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
|
|
||||||
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
|
|
||||||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
|
||||||
github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f h1:lO4WD4F/rVNCu3HqELle0jiPLLBs70cWOduZpkS1E78=
|
|
||||||
github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f/go.mod h1:cuUVRXasLTGF7a8hSLbxyZXjz+1KgoB3wDUb6vlszIc=
|
|
||||||
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/go-sql-driver/mysql v1.9.0 h1:Y0zIbQXhQKmQgTp44Y1dp3wTXcn804QoTptLZT1vtvo=
|
|
||||||
github.com/go-sql-driver/mysql v1.9.0/go.mod h1:pDetrLJeA3oMujJuvXc8RJoasr589B6A9fwzD3QMrqw=
|
|
||||||
github.com/golang/snappy v1.0.0 h1:Oy607GVXHs7RtbggtPBnr2RmDArIsAefDwvrdWvRhGs=
|
|
||||||
github.com/golang/snappy v1.0.0/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q=
|
|
||||||
github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
|
|
||||||
github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
|
|
||||||
github.com/klauspost/compress v1.16.7 h1:2mk3MPGNzKyxErAw8YaohYh69+pa4sIQSC0fPGCFR9I=
|
|
||||||
github.com/klauspost/compress v1.16.7/go.mod h1:ntbaceVETuRiXiv4DpjP66DpAtAGkEQskQzEyD//IeE=
|
|
||||||
github.com/lib/pq v1.10.9 h1:YXG7RB+JIjhP29X+OtkiDnYaXQwpS4JEWq7dtCCRUEw=
|
|
||||||
github.com/lib/pq v1.10.9/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o=
|
|
||||||
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=
|
|
||||||
github.com/mattn/go-sqlite3 v1.14.16 h1:yOQRA0RpS5PFz/oikGwBEqvAWhWg5ufRz4ETLjwpU1Y=
|
|
||||||
github.com/mattn/go-sqlite3 v1.14.16/go.mod h1:2eHXhiwb8IkHr+BDWZGa96P6+rkvnG63S2DGjv9HUNg=
|
|
||||||
github.com/muir/sqltoken v0.1.0 h1:edosEGsOClOZNfgGQNQSgxR9O6LiVefm2rDRqp2InuI=
|
|
||||||
github.com/muir/sqltoken v0.1.0/go.mod h1:lgOIORnKekMsuc/ZwdPOfwz/PtWLPCke43cEbT3uDuY=
|
|
||||||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
|
||||||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
|
||||||
github.com/redis/go-redis/v9 v9.17.3 h1:fN29NdNrE17KttK5Ndf20buqfDZwGNgoUr9qjl1DQx4=
|
|
||||||
github.com/redis/go-redis/v9 v9.17.3/go.mod h1:u410H11HMLoB+TP67dz8rL9s6QW2j76l0//kSOd3370=
|
|
||||||
github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
|
|
||||||
github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
|
|
||||||
github.com/vinovest/sqlx v1.7.1 h1:kdq4v0N9kRLpytWGSWOw4aulOGdQPmIoMR6Y+cTBxow=
|
|
||||||
github.com/vinovest/sqlx v1.7.1/go.mod h1:3fAv74r4iDMv2PpFomADb+vex5ukzfYn4GseC9KngD8=
|
|
||||||
github.com/xdg-go/pbkdf2 v1.0.0 h1:Su7DPu48wXMwC3bs7MCNG+z4FhcyEuz5dlvchbq0B0c=
|
|
||||||
github.com/xdg-go/pbkdf2 v1.0.0/go.mod h1:jrpuAogTd400dnrH08LKmI/xc1MbPOebTwRqcT5RDeI=
|
|
||||||
github.com/xdg-go/scram v1.1.2 h1:FHX5I5B4i4hKRVRBCFRxq1iQRej7WO3hhBuJf+UUySY=
|
|
||||||
github.com/xdg-go/scram v1.1.2/go.mod h1:RT/sEzTbU5y00aCK8UOx6R7YryM0iF1N2MOmC3kKLN4=
|
|
||||||
github.com/xdg-go/stringprep v1.0.4 h1:XLI/Ng3O1Atzq0oBs3TWm+5ZVgkq2aqdlvP9JtoZ6c8=
|
|
||||||
github.com/xdg-go/stringprep v1.0.4/go.mod h1:mPGuuIYwz7CmR2bT9j4GbQqutWS1zV24gijq1dTyGkM=
|
|
||||||
github.com/youmark/pkcs8 v0.0.0-20240726163527-a2c0da244d78 h1:ilQV1hzziu+LLM3zUTJ0trRztfwgjqKnBWNtSRkbmwM=
|
|
||||||
github.com/youmark/pkcs8 v0.0.0-20240726163527-a2c0da244d78/go.mod h1:aL8wCCfTfSfmXjznFBSZNN13rSJjlIOI1fUNAtF7rmI=
|
|
||||||
github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
|
|
||||||
go.mongodb.org/mongo-driver/v2 v2.4.2 h1:HrJ+Auygxceby9MLp3YITobef5a8Bv4HcPFIkml1U7U=
|
|
||||||
go.mongodb.org/mongo-driver/v2 v2.4.2/go.mod h1:jHeEDJHJq7tm6ZF45Issun9dbogjfnPySb1vXA7EeAI=
|
|
||||||
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
|
|
||||||
golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
|
|
||||||
golang.org/x/crypto v0.33.0 h1:IOBPskki6Lysi0lo9qQvbxiQ+FvsCC/YWOecCHAixus=
|
|
||||||
golang.org/x/crypto v0.33.0/go.mod h1:bVdXmD7IV/4GdElGPozy6U7lWdRXA4qyRVGJV57uQ5M=
|
|
||||||
golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
|
|
||||||
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
|
|
||||||
golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
|
|
||||||
golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
|
|
||||||
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
|
||||||
golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
|
||||||
golang.org/x/sync v0.11.0 h1:GGz8+XQP4FvTTrjZPzNKTMFtSXH80RAzG+5ghFPgK9w=
|
|
||||||
golang.org/x/sync v0.11.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
|
|
||||||
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
|
||||||
golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
|
||||||
golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
|
||||||
golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
|
||||||
golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
|
||||||
golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
|
||||||
golang.org/x/sys v0.40.0 h1:DBZZqJ2Rkml6QMQsZywtnjnnGvHza6BTfYFWY9kjEWQ=
|
|
||||||
golang.org/x/sys v0.40.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
|
|
||||||
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
|
|
||||||
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
|
|
||||||
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
|
|
||||||
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
|
|
||||||
golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
|
|
||||||
golang.org/x/text v0.3.8/go.mod h1:E6s5w1FMmriuDzIBO73fBruAKo1PCIq6d2Q6DHfQ8WQ=
|
|
||||||
golang.org/x/text v0.22.0 h1:bofq7m3/HAFvbF51jz3Q9wLg3jkvSPuiZu/pD1XwgtM=
|
|
||||||
golang.org/x/text v0.22.0/go.mod h1:YRoo4H8PVmsu+E3Ou7cqLVH8oXWIHVoX0jqUWALQhfY=
|
|
||||||
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
|
|
||||||
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
|
|
||||||
golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
|
|
||||||
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
|
||||||
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
|
||||||
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
|
||||||
|
|||||||
+189
@@ -0,0 +1,189 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/base64"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ErrInvalidPayloadType is returned when callback payload encoding type is unknown.
|
||||||
|
var ErrInvalidPayloadType = errors.New("invalid payload type")
|
||||||
|
|
||||||
|
func (bot *Bot[T]) handle(parentCtx context.Context, u *tgapi.Update) {
|
||||||
|
defer func() {
|
||||||
|
if r := recover(); r != nil {
|
||||||
|
bot.logger.Errorln(fmt.Sprintf("panic in handle: %v", r))
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
startTime := time.Now()
|
||||||
|
|
||||||
|
ctx, cancel := context.WithCancel(parentCtx)
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
msgCtx := &MsgContext{
|
||||||
|
Update: *u, API: bot.api,
|
||||||
|
Logger: bot.logger,
|
||||||
|
errorTemplate: bot.errorTemplate,
|
||||||
|
l10n: bot.l10n,
|
||||||
|
draftProvider: bot.draftProvider,
|
||||||
|
sceneRuntime: bot,
|
||||||
|
observer: bot.observer,
|
||||||
|
payloadType: bot.payloadType,
|
||||||
|
ctx: ctx,
|
||||||
|
}
|
||||||
|
bot.prepareUpdateCtx(u, msgCtx)
|
||||||
|
bot.safeEmitEvent(ctx, UpdateReceivedEvent{
|
||||||
|
UpdateID: u.UpdateID,
|
||||||
|
UpdateType: u.Type,
|
||||||
|
FromID: msgCtx.FromID,
|
||||||
|
ChatID: msgCtx.ChatID,
|
||||||
|
})
|
||||||
|
|
||||||
|
for _, middleware := range bot.middlewares {
|
||||||
|
if !middleware.Execute(msgCtx, bot.appData) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
sceneHandled, err := bot.tryHandleScene(msgCtx)
|
||||||
|
if err != nil {
|
||||||
|
bot.logger.Errorln(err)
|
||||||
|
bot.safeEmitEvent(ctx, UpdateHandledEvent{
|
||||||
|
UpdateID: u.UpdateID,
|
||||||
|
UpdateType: u.Type,
|
||||||
|
FromID: msgCtx.FromID,
|
||||||
|
ChatID: msgCtx.ChatID,
|
||||||
|
Duration: time.Since(startTime),
|
||||||
|
Handled: false,
|
||||||
|
})
|
||||||
|
bot.safeEmitEvent(ctx, ErrorEvent{
|
||||||
|
UpdateID: u.UpdateID,
|
||||||
|
UpdateType: u.Type,
|
||||||
|
Plugin: "bot",
|
||||||
|
HandlerKind: HandlerSceneKind,
|
||||||
|
HandlerName: "tryHandleScene",
|
||||||
|
FromID: msgCtx.FromID,
|
||||||
|
ChatID: msgCtx.ChatID,
|
||||||
|
Err: err,
|
||||||
|
UserFacing: false,
|
||||||
|
})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if sceneHandled {
|
||||||
|
bot.safeEmitEvent(ctx, UpdateHandledEvent{
|
||||||
|
UpdateID: u.UpdateID,
|
||||||
|
UpdateType: u.Type,
|
||||||
|
FromID: msgCtx.FromID,
|
||||||
|
ChatID: msgCtx.ChatID,
|
||||||
|
Duration: time.Since(startTime),
|
||||||
|
Handled: true,
|
||||||
|
})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
handled := false
|
||||||
|
switch u.Type {
|
||||||
|
case tgapi.UpdateTypeMessage, tgapi.UpdateTypeChannelPost:
|
||||||
|
handled = bot.handleMessage(u, msgCtx)
|
||||||
|
case tgapi.UpdateTypeCallbackQuery:
|
||||||
|
handled = bot.handleCallback(u, msgCtx)
|
||||||
|
default:
|
||||||
|
handled = bot.handleUpdate(u, msgCtx)
|
||||||
|
}
|
||||||
|
bot.safeEmitEvent(ctx, UpdateHandledEvent{
|
||||||
|
UpdateID: u.UpdateID,
|
||||||
|
UpdateType: u.Type,
|
||||||
|
FromID: msgCtx.FromID,
|
||||||
|
ChatID: msgCtx.ChatID,
|
||||||
|
Duration: time.Since(startTime),
|
||||||
|
Handled: handled,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func cloneMsgContext(src *MsgContext) *MsgContext {
|
||||||
|
cloned := *src
|
||||||
|
if src.Args != nil {
|
||||||
|
cloned.Args = append([]string(nil), src.Args...)
|
||||||
|
}
|
||||||
|
return &cloned
|
||||||
|
}
|
||||||
|
|
||||||
|
func encodeJSONPayload(d CallbackData) (string, error) {
|
||||||
|
b, err := json.Marshal(d)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
return string(b), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func decodeJSONPayload(s string) (CallbackData, error) {
|
||||||
|
var data CallbackData
|
||||||
|
err := json.Unmarshal([]byte(s), &data)
|
||||||
|
return data, err
|
||||||
|
}
|
||||||
|
|
||||||
|
func encodeBase64Payload(d CallbackData) (string, error) {
|
||||||
|
data, err := encodeJSONPayload(d)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
dst := make([]byte, base64.RawURLEncoding.EncodedLen(len([]byte(data))))
|
||||||
|
base64.RawURLEncoding.Encode(dst, []byte(data))
|
||||||
|
return string(dst), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func decodeBase64Payload(s string) (CallbackData, error) {
|
||||||
|
b, err := base64.RawURLEncoding.DecodeString(s)
|
||||||
|
if err != nil {
|
||||||
|
return CallbackData{}, err
|
||||||
|
}
|
||||||
|
return decodeJSONPayload(string(b))
|
||||||
|
}
|
||||||
|
|
||||||
|
func decodePayload(payloadType BotPayloadType, s string, strict bool) (CallbackData, BotPayloadType, error) {
|
||||||
|
switch payloadType {
|
||||||
|
case BotPayloadBase64:
|
||||||
|
data, err := decodeBase64Payload(s)
|
||||||
|
if err == nil {
|
||||||
|
return data, BotPayloadBase64, nil
|
||||||
|
}
|
||||||
|
if strict {
|
||||||
|
return CallbackData{}, "", fmt.Errorf("%w: expected %s", ErrPayloadTypeMismatch, BotPayloadBase64)
|
||||||
|
}
|
||||||
|
data, err = decodeJSONPayload(s)
|
||||||
|
if err != nil {
|
||||||
|
return CallbackData{}, "", err
|
||||||
|
}
|
||||||
|
return data, BotPayloadJSON, nil
|
||||||
|
case BotPayloadJSON:
|
||||||
|
data, err := decodeJSONPayload(s)
|
||||||
|
if err == nil {
|
||||||
|
return data, BotPayloadJSON, nil
|
||||||
|
}
|
||||||
|
if strict {
|
||||||
|
return CallbackData{}, "", fmt.Errorf("%w: expected %s", ErrPayloadTypeMismatch, BotPayloadJSON)
|
||||||
|
}
|
||||||
|
data, err = decodeBase64Payload(s)
|
||||||
|
if err != nil {
|
||||||
|
return CallbackData{}, "", err
|
||||||
|
}
|
||||||
|
return data, BotPayloadBase64, nil
|
||||||
|
}
|
||||||
|
return CallbackData{}, "", ErrInvalidPayloadType
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) decodePayload(s string) (CallbackData, error) {
|
||||||
|
data, decodedType, err := decodePayload(bot.payloadType, s, bot.strictPayloadType)
|
||||||
|
if err != nil {
|
||||||
|
return CallbackData{}, err
|
||||||
|
}
|
||||||
|
if decodedType == BotPayloadBase64 && bot.debug && bot.logger != nil {
|
||||||
|
bot.logger.Debugf("decoded callback payload base64->json: raw=%q json=%s", s, data.ToJSON())
|
||||||
|
}
|
||||||
|
return data, nil
|
||||||
|
}
|
||||||
+1233
File diff suppressed because it is too large
Load Diff
+251
-32
@@ -1,74 +1,293 @@
|
|||||||
package laniakea
|
package laniakea
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"encoding/json"
|
|
||||||
"fmt"
|
"fmt"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/extypes"
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// ButtonStyleDanger marks a destructive inline keyboard action.
|
||||||
|
ButtonStyleDanger tgapi.KeyboardButtonStyle = "danger"
|
||||||
|
// ButtonStyleSuccess marks a confirmatory inline keyboard action.
|
||||||
|
ButtonStyleSuccess tgapi.KeyboardButtonStyle = "success"
|
||||||
|
// ButtonStylePrimary marks a primary inline keyboard action.
|
||||||
|
ButtonStylePrimary tgapi.KeyboardButtonStyle = "primary"
|
||||||
|
)
|
||||||
|
|
||||||
|
// InlineKbButtonBuilder is a fluent builder for creating a single inline keyboard button.
|
||||||
|
//
|
||||||
|
// Use NewInlineKbButton() to start, then chain methods to configure:
|
||||||
|
// - SetIconCustomEmojiID() — adds a custom emoji icon
|
||||||
|
// - SetStyle() — sets visual style (danger/success/primary)
|
||||||
|
// - SetURL() — makes button open a URL
|
||||||
|
// - SetCallbackDataJSON() — attaches structured command + args for bot handling
|
||||||
|
//
|
||||||
|
// Call build() to produce the final tgapi.InlineKeyboardButton.
|
||||||
|
// Builder methods are immutable — each returns a copy.
|
||||||
|
type InlineKbButtonBuilder struct {
|
||||||
|
text string
|
||||||
|
iconCustomEmojiID string
|
||||||
|
style tgapi.KeyboardButtonStyle
|
||||||
|
url 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 {
|
||||||
|
return InlineKbButtonBuilder{text: text}
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetIconCustomEmojiID sets a custom emoji ID to display as the button's icon.
|
||||||
|
// This is a Telegram Bot API feature for custom emoji icons.
|
||||||
|
func (b InlineKbButtonBuilder) SetIconCustomEmojiID(id string) InlineKbButtonBuilder {
|
||||||
|
b.iconCustomEmojiID = id
|
||||||
|
return b
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetStyle sets the visual style of the button.
|
||||||
|
// Valid values: ButtonStyleDanger, ButtonStyleSuccess, ButtonStylePrimary.
|
||||||
|
// If not set, the button uses the default style.
|
||||||
|
func (b InlineKbButtonBuilder) SetStyle(style tgapi.KeyboardButtonStyle) InlineKbButtonBuilder {
|
||||||
|
b.style = style
|
||||||
|
return b
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetURL sets a URL that will be opened when the button is pressed.
|
||||||
|
// If both URL and CallbackData are set, Telegram will prioritize URL.
|
||||||
|
func (b InlineKbButtonBuilder) SetURL(url string) InlineKbButtonBuilder {
|
||||||
|
b.url = url
|
||||||
|
return b
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetCallbackDataJSON sets a structured callback payload that will be sent to the bot
|
||||||
|
// when the button is pressed. The command and arguments are serialized as JSON.
|
||||||
|
//
|
||||||
|
// Args are converted to strings using fmt.Sprint. Non-string types (e.g., int, bool)
|
||||||
|
// are safely serialized, but complex structs may not serialize usefully.
|
||||||
|
//
|
||||||
|
// Example: SetCallbackDataJSON("delete_user", 123, "confirm") → {"cmd":"delete_user","args":["123","confirm"]}.
|
||||||
|
func (b InlineKbButtonBuilder) SetCallbackDataJSON(cmd string, args ...any) InlineKbButtonBuilder {
|
||||||
|
b.callbackData = NewCallbackData(cmd, args...).ToJSON()
|
||||||
|
return b
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetCallbackDataBase64 sets a structured callback payload encoded as Base64.
|
||||||
|
// This can be useful when the JSON payload exceeds Telegram's callback data length limit.
|
||||||
|
// Args are converted to strings using fmt.Sprint.
|
||||||
|
func (b InlineKbButtonBuilder) SetCallbackDataBase64(cmd string, args ...any) InlineKbButtonBuilder {
|
||||||
|
b.callbackData = NewCallbackData(cmd, args...).ToBase64()
|
||||||
|
return b
|
||||||
|
}
|
||||||
|
|
||||||
|
// Internal helper that converts the builder state into a Telegram button.
|
||||||
|
func (b InlineKbButtonBuilder) build() tgapi.InlineKeyboardButton {
|
||||||
|
return tgapi.InlineKeyboardButton{
|
||||||
|
Text: b.text,
|
||||||
|
URL: b.url,
|
||||||
|
Style: b.style,
|
||||||
|
IconCustomEmojiID: b.iconCustomEmojiID,
|
||||||
|
CallbackData: b.callbackData,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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 []InlineKeyboardButton
|
CurrentLine extypes.Slice[tgapi.InlineKeyboardButton] // Current row being built
|
||||||
Lines [][]InlineKeyboardButton
|
Lines [][]tgapi.InlineKeyboardButton // Completed rows
|
||||||
maxRow int
|
maxRow int // Max buttons per row (e.g., 3 or 4)
|
||||||
|
|
||||||
|
payloadType BotPayloadType // Serialization format for callback data (JSON or Base64)
|
||||||
}
|
}
|
||||||
|
|
||||||
func NewInlineKeyboard(maxRow int) *InlineKeyboard {
|
// NewInlineKeyboardJSON creates a new keyboard builder with the specified maximum
|
||||||
|
// number of buttons per row.
|
||||||
|
//
|
||||||
|
// Example: NewInlineKeyboardJSON(3) creates a keyboard with at most 3 buttons per line.
|
||||||
|
func NewInlineKeyboardJSON(maxRow int) *InlineKeyboard {
|
||||||
|
return NewInlineKeyboard(BotPayloadJSON, maxRow)
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewInlineKeyboardBase64 creates a new keyboard builder with the specified maximum
|
||||||
|
// number of buttons per row, using Base64 encoding for button payloads.
|
||||||
|
//
|
||||||
|
// Example: NewInlineKeyboardBase64(3) creates a keyboard with at most 3 buttons per line.
|
||||||
|
func NewInlineKeyboardBase64(maxRow int) *InlineKeyboard {
|
||||||
|
return NewInlineKeyboard(BotPayloadBase64, maxRow)
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewInlineKeyboard creates a new keyboard builder with the specified payload encoding
|
||||||
|
// type and maximum number of buttons per row.
|
||||||
|
//
|
||||||
|
// Use NewInlineKeyboardJSON or NewInlineKeyboardBase64 for the common cases.
|
||||||
|
func NewInlineKeyboard(payloadType BotPayloadType, maxRow int) *InlineKeyboard {
|
||||||
return &InlineKeyboard{
|
return &InlineKeyboard{
|
||||||
CurrentLine: make([]InlineKeyboardButton, 0),
|
CurrentLine: make(extypes.Slice[tgapi.InlineKeyboardButton], 0),
|
||||||
Lines: make([][]InlineKeyboardButton, 0),
|
Lines: make([][]tgapi.InlineKeyboardButton, 0),
|
||||||
maxRow: maxRow,
|
maxRow: maxRow,
|
||||||
|
payloadType: payloadType,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (in *InlineKeyboard) append(button InlineKeyboardButton) *InlineKeyboard {
|
// SetPayloadType sets the keyboard-local serialization format for callback data added via
|
||||||
if len(in.CurrentLine) == in.maxRow {
|
// AddCallbackButton and AddCallbackButtonStyle methods.
|
||||||
in.AddLine()
|
// It overrides the bot's default payload type for this keyboard only.
|
||||||
}
|
func (in *InlineKeyboard) SetPayloadType(t BotPayloadType) *InlineKeyboard {
|
||||||
in.CurrentLine = append(in.CurrentLine, button)
|
in.payloadType = t
|
||||||
return in
|
return in
|
||||||
}
|
}
|
||||||
func (in *InlineKeyboard) AddUrlButton(text, url string) *InlineKeyboard {
|
|
||||||
return in.append(InlineKeyboardButton{Text: text, URL: url})
|
// GetPayloadType returns the keyboard-local callback payload encoding type.
|
||||||
}
|
func (in *InlineKeyboard) GetPayloadType() BotPayloadType { return in.payloadType }
|
||||||
func (in *InlineKeyboard) AddCallbackButton(text string, cmd string, args ...any) *InlineKeyboard {
|
|
||||||
return in.append(InlineKeyboardButton{Text: text, CallbackData: NewCallbackData(cmd, args...).ToJson()})
|
// SetMaxRow sets the maximum number of buttons appended to a row before the
|
||||||
|
// keyboard automatically starts a new line.
|
||||||
|
func (in *InlineKeyboard) SetMaxRow(maxRow int) *InlineKeyboard {
|
||||||
|
in.maxRow = maxRow
|
||||||
|
return in
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Internal helper that appends a button and auto-flushes a full row.
|
||||||
|
func (in *InlineKeyboard) append(button tgapi.InlineKeyboardButton) *InlineKeyboard {
|
||||||
|
if in.CurrentLine.Len() == in.maxRow {
|
||||||
|
in.AddLine()
|
||||||
|
}
|
||||||
|
in.CurrentLine = in.CurrentLine.Push(button)
|
||||||
|
return in
|
||||||
|
}
|
||||||
|
|
||||||
|
// AddURLButton adds a button that opens a URL when pressed.
|
||||||
|
// No callback data is attached.
|
||||||
|
func (in *InlineKeyboard) AddURLButton(text, url string) *InlineKeyboard {
|
||||||
|
return in.append(tgapi.InlineKeyboardButton{Text: text, URL: url})
|
||||||
|
}
|
||||||
|
|
||||||
|
// AddURLButtonStyle adds a button with a visual style that opens a URL.
|
||||||
|
// Style must be one of: ButtonStyleDanger, ButtonStyleSuccess, ButtonStylePrimary.
|
||||||
|
func (in *InlineKeyboard) AddURLButtonStyle(text string, style tgapi.KeyboardButtonStyle, url string) *InlineKeyboard {
|
||||||
|
return in.append(tgapi.InlineKeyboardButton{Text: text, Style: style, URL: url})
|
||||||
|
}
|
||||||
|
|
||||||
|
// AddCallbackButton adds a button that sends a structured callback payload to the bot.
|
||||||
|
// The command and args are serialized according to the current payloadType.
|
||||||
|
func (in *InlineKeyboard) AddCallbackButton(text string, cmd string, args ...any) *InlineKeyboard {
|
||||||
|
return in.append(tgapi.InlineKeyboardButton{
|
||||||
|
Text: text,
|
||||||
|
CallbackData: NewCallbackData(cmd, args...).Encode(in.payloadType),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// AddCallbackButtonStyle adds a styled callback button.
|
||||||
|
// Style affects visual appearance; callback data is sent to bot on press.
|
||||||
|
func (in *InlineKeyboard) AddCallbackButtonStyle(text string, style tgapi.KeyboardButtonStyle, cmd string, args ...any) *InlineKeyboard {
|
||||||
|
return in.append(tgapi.InlineKeyboardButton{
|
||||||
|
Text: text,
|
||||||
|
Style: style,
|
||||||
|
CallbackData: NewCallbackData(cmd, args...).Encode(in.payloadType),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// AddButton adds a button pre-configured via InlineKbButtonBuilder.
|
||||||
|
// This is the most flexible way to create buttons with custom emoji, style, URL, and callback.
|
||||||
|
func (in *InlineKeyboard) AddButton(b InlineKbButtonBuilder) *InlineKeyboard {
|
||||||
|
return in.append(b.build())
|
||||||
|
}
|
||||||
|
|
||||||
|
// AddLine manually ends the current row and starts a new one.
|
||||||
|
// If the current row is empty, nothing happens.
|
||||||
func (in *InlineKeyboard) AddLine() *InlineKeyboard {
|
func (in *InlineKeyboard) AddLine() *InlineKeyboard {
|
||||||
if len(in.CurrentLine) == 0 {
|
if in.CurrentLine.Len() == 0 {
|
||||||
return in
|
return in
|
||||||
}
|
}
|
||||||
in.Lines = append(in.Lines, in.CurrentLine)
|
in.Lines = append(in.Lines, in.CurrentLine)
|
||||||
in.CurrentLine = make([]InlineKeyboardButton, 0)
|
in.CurrentLine = make(extypes.Slice[tgapi.InlineKeyboardButton], 0)
|
||||||
return in
|
return in
|
||||||
}
|
}
|
||||||
func (in *InlineKeyboard) Get() InlineKeyboardMarkup {
|
|
||||||
if len(in.CurrentLine) > 0 {
|
// Get finalizes the keyboard and returns a tgapi.ReplyMarkup.
|
||||||
in.Lines = append(in.Lines, in.CurrentLine)
|
// Automatically flushes the current line if not empty.
|
||||||
}
|
//
|
||||||
return InlineKeyboardMarkup{
|
// Returns a pointer to a ReplyMarkup suitable for use with tgapi.SendMessage.
|
||||||
InlineKeyboard: in.Lines,
|
func (in *InlineKeyboard) Get() *tgapi.ReplyMarkup {
|
||||||
|
if in.CurrentLine.Len() > 0 {
|
||||||
|
in.AddLine()
|
||||||
}
|
}
|
||||||
|
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
|
||||||
}
|
}
|
||||||
|
|
||||||
func NewCallbackData(command string, args ...any) *CallbackData {
|
// NewCallbackData creates a new CallbackData instance with the given command and args.
|
||||||
|
//
|
||||||
|
// All args are converted to strings using fmt.Sprint. This is safe for primitives
|
||||||
|
// (int, string, bool, float64) but may not serialize complex structs meaningfully.
|
||||||
|
//
|
||||||
|
// Use this to build callback payloads for bot command routing.
|
||||||
|
func NewCallbackData(command string, args ...any) CallbackData {
|
||||||
stringArgs := make([]string, len(args))
|
stringArgs := make([]string, len(args))
|
||||||
for i, arg := range args {
|
for i, arg := range args {
|
||||||
stringArgs[i] = fmt.Sprint(arg)
|
stringArgs[i] = fmt.Sprint(arg)
|
||||||
}
|
}
|
||||||
return &CallbackData{
|
return CallbackData{
|
||||||
Command: command,
|
Command: command,
|
||||||
Args: stringArgs,
|
Args: stringArgs,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
func (d *CallbackData) ToJson() string {
|
|
||||||
data, err := json.Marshal(d)
|
// ToJSON serializes the CallbackData to a JSON string.
|
||||||
|
//
|
||||||
|
// If serialization fails (e.g., due to unmarshalable fields), returns a fallback
|
||||||
|
// JSON object: {"cmd":""} to prevent breaking Telegram's API.
|
||||||
|
//
|
||||||
|
// This fallback ensures the bot receives a valid JSON payload even if internal
|
||||||
|
// errors occur — avoiding "invalid callback_data" errors from Telegram.
|
||||||
|
func (d CallbackData) ToJSON() string {
|
||||||
|
data, err := encodeJSONPayload(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 data
|
||||||
|
}
|
||||||
|
|
||||||
|
// ToBase64 serializes the CallbackData to a JSON string and then encodes it as Base64.
|
||||||
|
// Returns an empty string if serialization or encoding fails.
|
||||||
|
func (d CallbackData) ToBase64() string {
|
||||||
|
s, err := encodeBase64Payload(d)
|
||||||
|
if err != nil {
|
||||||
|
return ``
|
||||||
|
}
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
// Encode serializes the CallbackData according to the specified payload type.
|
||||||
|
// Supported types: BotPayloadJSON and BotPayloadBase64.
|
||||||
|
// For unknown types, returns an empty string.
|
||||||
|
func (d CallbackData) Encode(t BotPayloadType) string {
|
||||||
|
switch t {
|
||||||
|
case BotPayloadBase64:
|
||||||
|
return d.ToBase64()
|
||||||
|
case BotPayloadJSON:
|
||||||
|
return d.ToJSON()
|
||||||
|
}
|
||||||
|
return ""
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,97 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestInlineKeyboardWrapsRowsAndEncodesJSONPayloads(t *testing.T) {
|
||||||
|
kb := NewInlineKeyboardJSON(2).
|
||||||
|
AddCallbackButton("A", "cmd", 1).
|
||||||
|
AddCallbackButton("B", "cmd", 2).
|
||||||
|
AddCallbackButton("C", "cmd", 3)
|
||||||
|
|
||||||
|
markup := kb.Get()
|
||||||
|
if got := len(markup.InlineKeyboard); got != 2 {
|
||||||
|
t.Fatalf("unexpected row count: %d", got)
|
||||||
|
}
|
||||||
|
if got := len(markup.InlineKeyboard[0]); got != 2 {
|
||||||
|
t.Fatalf("unexpected first row size: %d", got)
|
||||||
|
}
|
||||||
|
if got := len(markup.InlineKeyboard[1]); got != 1 {
|
||||||
|
t.Fatalf("unexpected second row size: %d", got)
|
||||||
|
}
|
||||||
|
if !strings.Contains(markup.InlineKeyboard[0][0].CallbackData, `"cmd":"cmd"`) {
|
||||||
|
t.Fatalf("expected JSON callback payload, got %q", markup.InlineKeyboard[0][0].CallbackData)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInlineKeyboardBuilderPreservesConfiguredButtonFields(t *testing.T) {
|
||||||
|
kb := NewInlineKeyboardBase64(3).
|
||||||
|
AddButton(
|
||||||
|
NewInlineKbButton("Docs").
|
||||||
|
SetStyle(ButtonStylePrimary).
|
||||||
|
SetURL("https://example.test"),
|
||||||
|
)
|
||||||
|
|
||||||
|
button := kb.Get().InlineKeyboard[0][0]
|
||||||
|
if button.Style != ButtonStylePrimary {
|
||||||
|
t.Fatalf("unexpected style: %q", button.Style)
|
||||||
|
}
|
||||||
|
if button.URL != "https://example.test" {
|
||||||
|
t.Fatalf("unexpected url: %q", button.URL)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInlineKeyboardGetPayloadTypeReturnsLocalOverride(t *testing.T) {
|
||||||
|
kb := NewInlineKeyboardJSON(2)
|
||||||
|
if got := kb.GetPayloadType(); got != BotPayloadJSON {
|
||||||
|
t.Fatalf("unexpected initial payload type: %q", got)
|
||||||
|
}
|
||||||
|
kb.SetPayloadType(BotPayloadBase64)
|
||||||
|
if got := kb.GetPayloadType(); got != BotPayloadBase64 {
|
||||||
|
t.Fatalf("unexpected updated payload type: %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDecodePayloadAcceptsBase64KeyboardPayloadWhenBotPrefersJSON(t *testing.T) {
|
||||||
|
kb := NewInlineKeyboardBase64(1).
|
||||||
|
AddCallbackButton("A", "cmd", 1, "two")
|
||||||
|
|
||||||
|
got, _, err := decodePayload(BotPayloadJSON, kb.Get().InlineKeyboard[0][0].CallbackData, false)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("decodePayload returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
want := CallbackData{Command: "cmd", Args: []string{"1", "two"}}
|
||||||
|
if !reflect.DeepEqual(got, want) {
|
||||||
|
t.Fatalf("unexpected payload: got %#v want %#v", got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDecodePayloadAcceptsJSONKeyboardPayloadWhenBotPrefersBase64(t *testing.T) {
|
||||||
|
kb := NewInlineKeyboardJSON(1).
|
||||||
|
AddCallbackButton("A", "cmd", 1, "two")
|
||||||
|
|
||||||
|
got, _, err := decodePayload(BotPayloadBase64, kb.Get().InlineKeyboard[0][0].CallbackData, false)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("decodePayload returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
want := CallbackData{Command: "cmd", Args: []string{"1", "two"}}
|
||||||
|
if !reflect.DeepEqual(got, want) {
|
||||||
|
t.Fatalf("unexpected payload: got %#v want %#v", got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDecodePayloadStrictRejectsMismatchedType(t *testing.T) {
|
||||||
|
kb := NewInlineKeyboardBase64(1).
|
||||||
|
AddCallbackButton("A", "cmd", 1)
|
||||||
|
|
||||||
|
_, _, err := decodePayload(BotPayloadJSON, kb.Get().InlineKeyboard[0][0].CallbackData, true)
|
||||||
|
if !errors.Is(err, ErrPayloadTypeMismatch) {
|
||||||
|
t.Fatalf("expected ErrPayloadTypeMismatch, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,71 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import "sync"
|
||||||
|
|
||||||
|
// DictEntry maps language codes to translated strings.
|
||||||
|
type DictEntry map[string]string
|
||||||
|
|
||||||
|
// L10n stores translations with a configurable fallback language and is safe for concurrent use.
|
||||||
|
type L10n struct {
|
||||||
|
mu sync.RWMutex
|
||||||
|
entries map[string]DictEntry
|
||||||
|
fallbackLang string
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewL10n creates a localization store with the given fallback language.
|
||||||
|
func NewL10n(fallbackLanguage string) *L10n {
|
||||||
|
return &L10n{
|
||||||
|
entries: make(map[string]DictEntry),
|
||||||
|
fallbackLang: fallbackLanguage,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// AddDictEntry stores translations for key.
|
||||||
|
func (l *L10n) AddDictEntry(key string, value DictEntry) *L10n {
|
||||||
|
l.mu.Lock()
|
||||||
|
defer l.mu.Unlock()
|
||||||
|
if l.entries == nil {
|
||||||
|
l.entries = make(map[string]DictEntry)
|
||||||
|
}
|
||||||
|
l.entries[key] = cloneDictEntry(value)
|
||||||
|
return l
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetFallbackLanguage returns the currently configured fallback language code.
|
||||||
|
func (l *L10n) GetFallbackLanguage() string {
|
||||||
|
l.mu.RLock()
|
||||||
|
defer l.mu.RUnlock()
|
||||||
|
return l.fallbackLang
|
||||||
|
}
|
||||||
|
|
||||||
|
// Translate returns the translation for key in lang, falling back to the configured language or the key itself.
|
||||||
|
func (l *L10n) Translate(lang, key string) string {
|
||||||
|
l.mu.RLock()
|
||||||
|
defer l.mu.RUnlock()
|
||||||
|
|
||||||
|
entries, exists := l.entries[key]
|
||||||
|
if !exists {
|
||||||
|
return key
|
||||||
|
}
|
||||||
|
|
||||||
|
if translation, ok := entries[lang]; ok {
|
||||||
|
return translation
|
||||||
|
}
|
||||||
|
|
||||||
|
if fallback, ok := entries[l.fallbackLang]; ok {
|
||||||
|
return fallback
|
||||||
|
}
|
||||||
|
|
||||||
|
return key
|
||||||
|
}
|
||||||
|
|
||||||
|
func cloneDictEntry(src DictEntry) DictEntry {
|
||||||
|
if src == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
cloned := make(DictEntry, len(src))
|
||||||
|
for lang, text := range src {
|
||||||
|
cloned[lang] = text
|
||||||
|
}
|
||||||
|
return cloned
|
||||||
|
}
|
||||||
@@ -0,0 +1,77 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestL10nTranslateUsesFallbackAndKey(t *testing.T) {
|
||||||
|
l10n := NewL10n("en").
|
||||||
|
AddDictEntry("greeting", DictEntry{"en": "Hello", "ru": "Privet"}).
|
||||||
|
AddDictEntry("partial", DictEntry{"ru": "Tolko ru"})
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
lang string
|
||||||
|
key string
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
{name: "exact match", lang: "ru", key: "greeting", want: "Privet"},
|
||||||
|
{name: "fallback language", lang: "es", key: "greeting", want: "Hello"},
|
||||||
|
{name: "missing fallback returns key", lang: "en", key: "partial", want: "partial"},
|
||||||
|
{name: "unknown key returns key", lang: "en", key: "unknown", want: "unknown"},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
if got := l10n.Translate(tt.lang, tt.key); got != tt.want {
|
||||||
|
t.Fatalf("unexpected translation: got %q want %q", got, tt.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestL10nAddDictEntryCopiesInput(t *testing.T) {
|
||||||
|
l10n := NewL10n("en")
|
||||||
|
entry := DictEntry{"en": "Hello"}
|
||||||
|
|
||||||
|
l10n.AddDictEntry("greeting", entry)
|
||||||
|
entry["en"] = "Mutated"
|
||||||
|
|
||||||
|
if got := l10n.Translate("en", "greeting"); got != "Hello" {
|
||||||
|
t.Fatalf("unexpected translation after external mutation: got %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestL10nZeroValueIsUsable(t *testing.T) {
|
||||||
|
var l10n L10n
|
||||||
|
|
||||||
|
l10n.AddDictEntry("greeting", DictEntry{"en": "Hello"})
|
||||||
|
|
||||||
|
if got := l10n.Translate("en", "greeting"); got != "Hello" {
|
||||||
|
t.Fatalf("unexpected translation from zero-value l10n: got %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestL10nConcurrentAccess(t *testing.T) {
|
||||||
|
l10n := NewL10n("en")
|
||||||
|
l10n.AddDictEntry("base", DictEntry{"en": "Hello"})
|
||||||
|
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
for i := 0; i < 8; i++ {
|
||||||
|
wg.Add(1)
|
||||||
|
go func(i int) {
|
||||||
|
defer wg.Done()
|
||||||
|
for j := 0; j < 100; j++ {
|
||||||
|
l10n.AddDictEntry(fmt.Sprintf("key-%d-%d", i, j), DictEntry{"en": "value"})
|
||||||
|
_ = l10n.Translate("en", "base")
|
||||||
|
}
|
||||||
|
}(i)
|
||||||
|
}
|
||||||
|
wg.Wait()
|
||||||
|
|
||||||
|
if got := l10n.Translate("en", "base"); got != "Hello" {
|
||||||
|
t.Fatalf("unexpected translation after concurrent access: got %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
+69
-149
@@ -1,169 +1,89 @@
|
|||||||
package laniakea
|
package laniakea
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"context"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"fmt"
|
"iter"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
)
|
)
|
||||||
|
|
||||||
var NoParams = make(map[string]any)
|
// Updates fetches new updates from Telegram API using long polling.
|
||||||
|
// It respects the bot's current update offset and automatically advances it
|
||||||
|
// after successful retrieval. The method supports selective update types
|
||||||
|
// through AllowedUpdates and includes optional request logging.
|
||||||
|
//
|
||||||
|
// Parameters:
|
||||||
|
// - ctx: request context used to cancel the in-flight long polling request
|
||||||
|
//
|
||||||
|
// Returns:
|
||||||
|
// - []tgapi.Update: slice of received updates (empty if none available)
|
||||||
|
// - error: any error encountered during the API call
|
||||||
|
//
|
||||||
|
// Behavior:
|
||||||
|
// 1. Uses the bot's current update offset (via GetUpdateOffset)
|
||||||
|
// 2. Requests updates with 30-second timeout
|
||||||
|
// 3. Filters updates by types specified in bot.GetUpdateTypes()
|
||||||
|
// 4. Logs raw update JSON if RequestLogger is configured
|
||||||
|
// 5. Automatically updates the offset to the last received update ID + 1
|
||||||
|
// 6. Returns all received updates (empty slice if none)
|
||||||
|
//
|
||||||
|
// Note: This is a blocking call that waits up to 30 seconds for new updates,
|
||||||
|
// unless ctx is canceled earlier. For non-blocking behavior, consider using
|
||||||
|
// webhooks instead.
|
||||||
|
//
|
||||||
|
// Example:
|
||||||
|
//
|
||||||
|
// updates, err := bot.Updates(ctx)
|
||||||
|
// if err != nil {
|
||||||
|
// log.Fatal(err)
|
||||||
|
// }
|
||||||
|
// for _, update := range updates {
|
||||||
|
// // process update
|
||||||
|
// }
|
||||||
|
func (bot *Bot[T]) Updates(ctx context.Context) ([]tgapi.Update, error) {
|
||||||
|
offset := bot.GetUpdateOffset()
|
||||||
|
params := tgapi.UpdateParams{
|
||||||
|
Offset: new(offset),
|
||||||
|
Timeout: new(30),
|
||||||
|
AllowedUpdates: bot.GetUpdateTypes(),
|
||||||
|
}
|
||||||
|
|
||||||
func (b *Bot) Updates() ([]*Update, error) {
|
updates, err := bot.api.GetUpdatesWithContext(ctx, params)
|
||||||
params := make(map[string]any)
|
|
||||||
params["offset"] = b.updateOffset
|
|
||||||
params["timeout"] = 30
|
|
||||||
params["allowed_updates"] = b.updateTypes
|
|
||||||
|
|
||||||
data, err := b.request("getUpdates", params)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
res := make([]*Update, 0)
|
|
||||||
for _, u := range data["data"].([]any) {
|
|
||||||
updateObj := new(Update)
|
|
||||||
data, err := json.Marshal(u)
|
|
||||||
if err != nil {
|
|
||||||
return res, err
|
|
||||||
}
|
|
||||||
err = json.Unmarshal(data, updateObj)
|
|
||||||
if err != nil {
|
|
||||||
return res, err
|
|
||||||
}
|
|
||||||
//err = MapToStruct(u.(map[string]any), updateObj)
|
|
||||||
//if err != nil {
|
|
||||||
// return res, err
|
|
||||||
//}
|
|
||||||
b.updateOffset = updateObj.UpdateID + 1
|
|
||||||
err = b.updateQueue.Enqueue(updateObj)
|
|
||||||
if err != nil {
|
|
||||||
return res, err
|
|
||||||
}
|
|
||||||
res = append(res, updateObj)
|
|
||||||
|
|
||||||
if b.debug && b.requestLogger != nil {
|
if bot.requestLogger != nil {
|
||||||
j, err := MapToJson(u.(map[string]interface{}))
|
for _, u := range updates {
|
||||||
|
j, err := json.Marshal(u)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
b.logger.Error(err)
|
bot.GetLogger().Error(err)
|
||||||
}
|
}
|
||||||
b.requestLogger.Debugln(fmt.Sprintf("UPDATE %s", j))
|
bot.requestLogger.Debugf("UPDATE %s\n", j)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return res, err
|
if len(updates) > 0 {
|
||||||
}
|
bot.SetUpdateOffset(updates[len(updates)-1].UpdateID + 1)
|
||||||
|
|
||||||
func (b *Bot) GetMe() (*User, error) {
|
|
||||||
data, err := b.request("getMe", NoParams)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
}
|
||||||
user := new(User)
|
return updates, err
|
||||||
err = MapToStruct(data, user)
|
|
||||||
return user, err
|
|
||||||
}
|
}
|
||||||
|
|
||||||
type SendMessageP struct {
|
// UpdatesIter fetches updates once and yields each update in order.
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
//
|
||||||
ChatID int `json:"chat_id"`
|
// If fetching updates fails, the iterator yields the error once with a zero
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
// update and then stops.
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
func (bot *Bot[T]) UpdatesIter(ctx context.Context) iter.Seq2[tgapi.Update, error] {
|
||||||
Text string `json:"text"`
|
return func(yield func(tgapi.Update, error) bool) {
|
||||||
Entities []*MessageEntity `json:"entities,omitempty"`
|
updates, err := bot.Updates(ctx)
|
||||||
LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"`
|
if err != nil {
|
||||||
DisableNotifications bool `json:"disable_notifications,omitempty"`
|
yield(tgapi.Update{}, err)
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
return
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
}
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
for _, u := range updates {
|
||||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
if !yield(u, nil) {
|
||||||
ReplyMarkup InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
return
|
||||||
}
|
}
|
||||||
|
}
|
||||||
func (b *Bot) SendMessage(params *SendMessageP) (*Message, error) {
|
|
||||||
data, err := b.request("sendMessage", params)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
}
|
||||||
message := new(Message)
|
|
||||||
err = MapToStruct(data, message)
|
|
||||||
return message, err
|
|
||||||
}
|
|
||||||
|
|
||||||
type SendPhotoP struct {
|
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
|
||||||
ChatID int `json:"chat_id"`
|
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
|
||||||
Photo string `json:"photo"`
|
|
||||||
Caption string `json:"caption,omitempty"`
|
|
||||||
CaptionEntities []*MessageEntity `json:"caption_entities,omitempty"`
|
|
||||||
ShowCaptionAboveMedia bool `json:"show_caption_above_media"`
|
|
||||||
HasSpoiler bool `json:"has_spoiler"`
|
|
||||||
DisableNotifications bool `json:"disable_notifications,omitempty"`
|
|
||||||
ProtectContent bool `json:"protect_content,omitempty"`
|
|
||||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
|
||||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
|
||||||
ReplyMarkup InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
func (b *Bot) SendPhoto(params *SendPhotoP) (*Message, error) {
|
|
||||||
data, err := b.request("sendPhoto", params)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
message := new(Message)
|
|
||||||
err = MapToStruct(data, message)
|
|
||||||
return message, err
|
|
||||||
}
|
|
||||||
|
|
||||||
type EditMessageTextP struct {
|
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
|
||||||
ChatID int `json:"chat_id,omitempty"`
|
|
||||||
MessageID int `json:"message_id,omitempty"`
|
|
||||||
InlineMessageID string `json:"inline_message_id,omitempty"`
|
|
||||||
Text string `json:"text"`
|
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
|
||||||
ReplyMarkup InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
func (b *Bot) EditMessageText(params *EditMessageTextP) (*Message, error) {
|
|
||||||
data, err := b.request("editMessageText", params)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
message := new(Message)
|
|
||||||
err = MapToStruct(data, message)
|
|
||||||
return message, err
|
|
||||||
}
|
|
||||||
|
|
||||||
type EditMessageCaptionP struct {
|
|
||||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
|
||||||
ChatID int `json:"chat_id,omitempty"`
|
|
||||||
MessageID int `json:"message_id,omitempty"`
|
|
||||||
InlineMessageID string `json:"inline_message_id,omitempty"`
|
|
||||||
Caption string `json:"caption"`
|
|
||||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
|
||||||
ReplyMarkup InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
func (b *Bot) EditMessageCaption(params *EditMessageCaptionP) (*Message, error) {
|
|
||||||
data, err := b.request("editMessageCaption", params)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
message := new(Message)
|
|
||||||
err = MapToStruct(data, message)
|
|
||||||
return message, err
|
|
||||||
}
|
|
||||||
|
|
||||||
type DeleteMessageP struct {
|
|
||||||
ChatID int `json:"chat_id"`
|
|
||||||
MessageID int `json:"message_id"`
|
|
||||||
}
|
|
||||||
|
|
||||||
func (b *Bot) DeleteMessage(params *DeleteMessageP) (*Message, error) {
|
|
||||||
data, err := b.request("deleteMessage", params)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
message := new(Message)
|
|
||||||
err = MapToStruct(data, message)
|
|
||||||
return message, err
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,78 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestUpdatesIterYieldsFetchError(t *testing.T) {
|
||||||
|
bot := newUpdatesIterTestBot(t, `{"ok":false,"error_code":500,"description":"boom"}`)
|
||||||
|
|
||||||
|
var gotErr error
|
||||||
|
var gotUpdates int
|
||||||
|
bot.UpdatesIter(context.Background())(func(update tgapi.Update, err error) bool {
|
||||||
|
gotUpdates++
|
||||||
|
if update.UpdateID != 0 {
|
||||||
|
t.Fatalf("expected zero update on error, got %d", update.UpdateID)
|
||||||
|
}
|
||||||
|
gotErr = err
|
||||||
|
return true
|
||||||
|
})
|
||||||
|
|
||||||
|
if gotUpdates != 1 {
|
||||||
|
t.Fatalf("expected one yielded error, got %d yields", gotUpdates)
|
||||||
|
}
|
||||||
|
if gotErr == nil {
|
||||||
|
t.Fatal("expected fetch error")
|
||||||
|
}
|
||||||
|
if !strings.Contains(gotErr.Error(), "boom") {
|
||||||
|
t.Fatalf("expected Telegram error description, got %v", gotErr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUpdatesIterStopsWhenYieldReturnsFalse(t *testing.T) {
|
||||||
|
bot := newUpdatesIterTestBot(t, `{"ok":true,"result":[{"update_id":11},{"update_id":12}]}`)
|
||||||
|
|
||||||
|
var gotIDs []int
|
||||||
|
bot.UpdatesIter(context.Background())(func(update tgapi.Update, err error) bool {
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
gotIDs = append(gotIDs, update.UpdateID)
|
||||||
|
return false
|
||||||
|
})
|
||||||
|
|
||||||
|
if len(gotIDs) != 1 || gotIDs[0] != 11 {
|
||||||
|
t.Fatalf("expected only first update, got %v", gotIDs)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func newUpdatesIterTestBot(t *testing.T, response string) *Bot[NoData] {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
api := tgapi.NewAPI(
|
||||||
|
tgapi.NewAPIOpts("token").
|
||||||
|
SetAPIURL("https://example.test").
|
||||||
|
SetHTTPClient(&http.Client{
|
||||||
|
Transport: pollingRoundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||||
|
Body: io.NopCloser(strings.NewReader(response)),
|
||||||
|
}, nil
|
||||||
|
}),
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
t.Cleanup(func() {
|
||||||
|
if err := api.Close(); err != nil {
|
||||||
|
t.Fatalf("Close returned error: %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
return &Bot[NoData]{api: api}
|
||||||
|
}
|
||||||
+792
@@ -0,0 +1,792 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
"reflect"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
|
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||||
|
)
|
||||||
|
|
||||||
|
// MsgContext holds the normalized per-update context passed to command, payload,
|
||||||
|
// scene, middleware, and generic update handlers.
|
||||||
|
//
|
||||||
|
// MsgContext is populated from the current Telegram update before handler routing.
|
||||||
|
// Not every field is guaranteed for every update kind. In particular:
|
||||||
|
// - Update is always present.
|
||||||
|
// - Msg is populated only for update kinds that carry a Telegram message object.
|
||||||
|
// - From and FromID are populated only when the update exposes a user identity.
|
||||||
|
// - Chat and ChatID are populated only when the update exposes a chat identity.
|
||||||
|
// - Text, Args, and Prefix are populated only by command or scene command routing.
|
||||||
|
// - CallbackQueryID, CallbackMsgID, and InlineMsgID are populated only for
|
||||||
|
// callback query handling when the corresponding callback targets exist.
|
||||||
|
//
|
||||||
|
// Helper methods on MsgContext may require a message-backed context. For example,
|
||||||
|
// reply helpers need Msg, while inline callback edit helpers can work through
|
||||||
|
// InlineMsgID when there is no chat message.
|
||||||
|
type MsgContext struct {
|
||||||
|
API *tgapi.API
|
||||||
|
Update tgapi.Update
|
||||||
|
|
||||||
|
// Msg is the normalized Telegram message for message-backed update kinds.
|
||||||
|
// It is nil for updates that do not include a message object.
|
||||||
|
Msg *tgapi.Message
|
||||||
|
// From is the normalized Telegram user for update kinds that expose one.
|
||||||
|
// It stays nil for sender-chat-only updates and update kinds without a user.
|
||||||
|
From *tgapi.User
|
||||||
|
// Chat is the normalized Telegram chat for update kinds that expose one.
|
||||||
|
// It is nil for updates that do not include a chat identity.
|
||||||
|
Chat *tgapi.Chat
|
||||||
|
|
||||||
|
// Logger is the logger assigned by the matched plugin for the current handler call.
|
||||||
|
// It may fall back to the bot logger when the plugin has no dedicated logger.
|
||||||
|
Logger *sneklog.Logger
|
||||||
|
|
||||||
|
// InlineMsgID is the inline message identifier for callback queries that target
|
||||||
|
// an inline message instead of a chat message.
|
||||||
|
InlineMsgID string
|
||||||
|
// CallbackMsgID is the message ID targeted by the current callback query when
|
||||||
|
// the callback comes from a chat message.
|
||||||
|
CallbackMsgID int
|
||||||
|
// CallbackQueryID is the Telegram callback query ID for payload handlers and
|
||||||
|
// callback-backed scene handlers.
|
||||||
|
CallbackQueryID string
|
||||||
|
// FromID is the normalized sender ID when the current update exposes a user.
|
||||||
|
// It is zero when the update has no user identity.
|
||||||
|
FromID int64
|
||||||
|
// ChatID is the normalized chat ID when the current update exposes a chat.
|
||||||
|
// It is zero when the update has no chat identity.
|
||||||
|
ChatID int64
|
||||||
|
// Prefix is the matched command prefix for command routing and scene-local
|
||||||
|
// command routing. It is empty outside those flows.
|
||||||
|
Prefix string
|
||||||
|
// Text is the parsed command tail for command routing, the parsed scene-command
|
||||||
|
// tail for scene-local command routing, or the trimmed message text seen by a
|
||||||
|
// scene step/message handler. It is empty when the current routing path does
|
||||||
|
// not derive text input.
|
||||||
|
Text string
|
||||||
|
// Args contains parsed command or payload arguments for the current routing
|
||||||
|
// path. It is nil or empty when no argument vector is derived.
|
||||||
|
Args []string
|
||||||
|
|
||||||
|
errorTemplate string
|
||||||
|
l10n *L10n
|
||||||
|
draftProvider *DraftProvider
|
||||||
|
payloadType BotPayloadType
|
||||||
|
sceneRuntime sceneRuntime
|
||||||
|
observer Observer
|
||||||
|
|
||||||
|
ctx context.Context
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnswerMessage represents a message sent or edited via MsgContext.
|
||||||
|
// It holds metadata to allow further editing or deletion.
|
||||||
|
type AnswerMessage struct {
|
||||||
|
MessageID int
|
||||||
|
Text string
|
||||||
|
IsMedia bool
|
||||||
|
ctx *MsgContext // internal back-reference
|
||||||
|
}
|
||||||
|
|
||||||
|
// Internal helper for text edits with optional keyboard and parse mode.
|
||||||
|
func (ctx *MsgContext) edit(messageID int, text string, keyboard *InlineKeyboard, parseMode tgapi.ParseMode) *AnswerMessage {
|
||||||
|
if err := validateMessageText(text); err != nil {
|
||||||
|
ctx.Logger.Errorln(err)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
params := tgapi.EditMessageText{
|
||||||
|
Text: text,
|
||||||
|
ParseMode: parseMode,
|
||||||
|
}
|
||||||
|
switch {
|
||||||
|
case messageID > 0 && ctx.Msg != nil:
|
||||||
|
params.MessageID = messageID
|
||||||
|
params.ChatID = ctx.Msg.Chat.ID
|
||||||
|
case ctx.InlineMsgID != "":
|
||||||
|
params.InlineMessageID = ctx.InlineMsgID
|
||||||
|
default:
|
||||||
|
ctx.Logger.Errorln(ErrEditTargetMissing)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if keyboard != nil {
|
||||||
|
params.ReplyMarkup = keyboard.Get()
|
||||||
|
}
|
||||||
|
msg, _, err := ctx.API.EditMessageTextWithContext(ctx.Context(), params)
|
||||||
|
if err != nil {
|
||||||
|
ctx.Logger.Errorln(err)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
resultMessageID := messageID
|
||||||
|
if msg.MessageID > 0 {
|
||||||
|
resultMessageID = msg.MessageID
|
||||||
|
}
|
||||||
|
return &AnswerMessage{
|
||||||
|
MessageID: resultMessageID, ctx: ctx, Text: text, IsMedia: false,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Edit replaces the text of the message without changing the keyboard or parse mode.
|
||||||
|
// Uses ParseNone (plain text).
|
||||||
|
func (m *AnswerMessage) Edit(text string) *AnswerMessage {
|
||||||
|
return m.ctx.edit(m.MessageID, text, nil, tgapi.ParseNone)
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Internal helper for editing callback-linked messages.
|
||||||
|
func (ctx *MsgContext) editCallback(text string, keyboard *InlineKeyboard, parseMode tgapi.ParseMode) *AnswerMessage {
|
||||||
|
if ctx.CallbackMsgID == 0 && ctx.InlineMsgID == "" {
|
||||||
|
ctx.Logger.Errorln(ErrCallbackMessageMissing)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return ctx.edit(ctx.CallbackMsgID, text, keyboard, parseMode)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditCallback edits the callback message using plain text (ParseNone).
|
||||||
|
func (ctx *MsgContext) EditCallback(text string, keyboard *InlineKeyboard) *AnswerMessage {
|
||||||
|
return ctx.editCallback(text, keyboard, tgapi.ParseNone)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditCallbackMarkdown edits the callback message using MarkdownV2.
|
||||||
|
//
|
||||||
|
// ⚠️ WARNING: User input must be escaped with laniakea.EscapeMarkdownV2() before passing here.
|
||||||
|
func (ctx *MsgContext) EditCallbackMarkdown(text string, keyboard *InlineKeyboard) *AnswerMessage {
|
||||||
|
return ctx.editCallback(text, keyboard, tgapi.ParseMDV2)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditCallbackf formats a string using fmt.Sprintf and edits the callback message with plain text.
|
||||||
|
func (ctx *MsgContext) EditCallbackf(format string, keyboard *InlineKeyboard, args ...any) *AnswerMessage {
|
||||||
|
return ctx.editCallback(fmt.Sprintf(format, args...), keyboard, tgapi.ParseNone)
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Internal helper for media-caption edits.
|
||||||
|
func (ctx *MsgContext) editPhotoText(messageID int, text string, kb *InlineKeyboard, parseMode tgapi.ParseMode) *AnswerMessage {
|
||||||
|
if err := validateCaptionText(text); err != nil {
|
||||||
|
ctx.Logger.Errorln(err)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
params := tgapi.EditMessageCaption{
|
||||||
|
Caption: text,
|
||||||
|
ParseMode: parseMode,
|
||||||
|
}
|
||||||
|
switch {
|
||||||
|
case messageID > 0 && ctx.Msg != nil:
|
||||||
|
params.ChatID = ctx.Msg.Chat.ID
|
||||||
|
params.MessageID = messageID
|
||||||
|
case ctx.InlineMsgID != "":
|
||||||
|
params.InlineMessageID = ctx.InlineMsgID
|
||||||
|
default:
|
||||||
|
ctx.Logger.Errorln(ErrEditTargetMissing)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if kb != nil {
|
||||||
|
params.ReplyMarkup = kb.Get()
|
||||||
|
}
|
||||||
|
|
||||||
|
msg, _, err := ctx.API.EditMessageCaptionWithContext(ctx.Context(), params)
|
||||||
|
if err != nil {
|
||||||
|
ctx.Logger.Errorln(err)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
resultMessageID := messageID
|
||||||
|
if msg.MessageID > 0 {
|
||||||
|
resultMessageID = msg.MessageID
|
||||||
|
}
|
||||||
|
return &AnswerMessage{
|
||||||
|
MessageID: resultMessageID, ctx: ctx, Text: text, IsMedia: true,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditCaption edits the caption of a media message using plain text.
|
||||||
|
func (m *AnswerMessage) EditCaption(text string) *AnswerMessage {
|
||||||
|
return m.ctx.editPhotoText(m.MessageID, text, nil, tgapi.ParseNone)
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Internal helper for message replies with optional keyboard and parse mode.
|
||||||
|
func (ctx *MsgContext) answer(text string, keyboard *InlineKeyboard, parseMode tgapi.ParseMode) *AnswerMessage {
|
||||||
|
if ctx.Msg == nil {
|
||||||
|
ctx.Logger.Errorln(ErrMessageContextNil)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if err := validateMessageText(text); err != nil {
|
||||||
|
ctx.Logger.Errorln(err)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
params := tgapi.SendMessage{
|
||||||
|
ChatID: ctx.Msg.Chat.ID,
|
||||||
|
Text: text,
|
||||||
|
ParseMode: parseMode,
|
||||||
|
}
|
||||||
|
if keyboard != nil {
|
||||||
|
params.ReplyMarkup = keyboard.Get()
|
||||||
|
}
|
||||||
|
if ctx.Msg.MessageThreadID > 0 {
|
||||||
|
params.MessageThreadID = ctx.Msg.MessageThreadID
|
||||||
|
}
|
||||||
|
if ctx.Msg.DirectMessageTopic != nil {
|
||||||
|
params.DirectMessagesTopicID = ctx.Msg.DirectMessageTopic.TopicID
|
||||||
|
}
|
||||||
|
|
||||||
|
msg, err := ctx.API.SendMessageWithContext(ctx.Context(), params)
|
||||||
|
if err != nil {
|
||||||
|
ctx.Logger.Errorln(err)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return &AnswerMessage{
|
||||||
|
MessageID: msg.MessageID, ctx: ctx, IsMedia: false, Text: text,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Answer sends a plain text message (ParseNone).
|
||||||
|
func (ctx *MsgContext) Answer(text string) *AnswerMessage {
|
||||||
|
return ctx.answer(text, nil, tgapi.ParseNone)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnswerLong sends one or more plain-text messages if text exceeds Telegram's limit.
|
||||||
|
//
|
||||||
|
// The text is split into Telegram-safe chunks. Returned messages preserve send
|
||||||
|
// order. If a chunk fails to send, already-sent messages are returned.
|
||||||
|
func (ctx *MsgContext) AnswerLong(text string) []*AnswerMessage {
|
||||||
|
return ctx.answerLong(text, nil, tgapi.ParseNone)
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnswerLongf formats a string using fmt.Sprintf and sends it as one or more plain-text messages.
|
||||||
|
func (ctx *MsgContext) AnswerLongf(template string, args ...any) []*AnswerMessage {
|
||||||
|
return ctx.answerLong(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)
|
||||||
|
}
|
||||||
|
|
||||||
|
// KeyboardLong sends long plain text split across multiple messages.
|
||||||
|
//
|
||||||
|
// The inline keyboard is attached only to the final chunk.
|
||||||
|
func (ctx *MsgContext) KeyboardLong(text string, kb *InlineKeyboard) []*AnswerMessage {
|
||||||
|
return ctx.answerLong(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)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ctx *MsgContext) answerLong(text string, keyboard *InlineKeyboard, parseMode tgapi.ParseMode) []*AnswerMessage {
|
||||||
|
if parseMode != tgapi.ParseNone {
|
||||||
|
ctx.Logger.Errorln(ErrMessageSplitImpossible)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if ctx.Msg == nil {
|
||||||
|
ctx.Logger.Errorln(ErrMessageContextNil)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if err := validateMessageText(text); err == nil {
|
||||||
|
msg := ctx.answer(text, keyboard, parseMode)
|
||||||
|
if msg == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return []*AnswerMessage{msg}
|
||||||
|
} else if !errors.Is(err, ErrMessageTooLong) {
|
||||||
|
ctx.Logger.Errorln(err)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
parts := SplitMessageText(text)
|
||||||
|
messages := make([]*AnswerMessage, 0, len(parts))
|
||||||
|
for i, part := range parts {
|
||||||
|
partKeyboard := (*InlineKeyboard)(nil)
|
||||||
|
if i == len(parts)-1 {
|
||||||
|
partKeyboard = keyboard
|
||||||
|
}
|
||||||
|
msg := ctx.answer(part, partKeyboard, parseMode)
|
||||||
|
if msg == nil {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
messages = append(messages, msg)
|
||||||
|
}
|
||||||
|
if len(messages) == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return messages
|
||||||
|
}
|
||||||
|
|
||||||
|
// Internal helper for photo replies with optional caption and keyboard.
|
||||||
|
func (ctx *MsgContext) answerPhoto(photoID, text string, kb *InlineKeyboard, parseMode tgapi.ParseMode) *AnswerMessage {
|
||||||
|
if ctx.Msg == nil {
|
||||||
|
ctx.Logger.Errorln(ErrMessageContextNil)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if err := validateCaptionText(text); err != nil {
|
||||||
|
ctx.Logger.Errorln(err)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
params := tgapi.SendPhoto{
|
||||||
|
ChatID: ctx.Msg.Chat.ID,
|
||||||
|
Caption: text,
|
||||||
|
ParseMode: parseMode,
|
||||||
|
Photo: photoID,
|
||||||
|
}
|
||||||
|
if kb != nil {
|
||||||
|
params.ReplyMarkup = kb.Get()
|
||||||
|
}
|
||||||
|
if ctx.Msg.MessageThreadID > 0 {
|
||||||
|
params.MessageThreadID = ctx.Msg.MessageThreadID
|
||||||
|
}
|
||||||
|
if ctx.Msg.DirectMessageTopic != nil {
|
||||||
|
params.DirectMessagesTopicID = int(ctx.Msg.DirectMessageTopic.TopicID)
|
||||||
|
}
|
||||||
|
|
||||||
|
msg, err := ctx.API.SendPhotoWithContext(ctx.Context(), params)
|
||||||
|
if err != nil {
|
||||||
|
ctx.Logger.Errorln(err)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return &AnswerMessage{
|
||||||
|
MessageID: msg.MessageID, ctx: ctx, Text: text, IsMedia: true,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnswerPhoto sends a photo with plain text caption.
|
||||||
|
func (ctx *MsgContext) AnswerPhoto(photoID, text string) *AnswerMessage {
|
||||||
|
return ctx.answerPhoto(photoID, text, nil, tgapi.ParseNone)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnswerPhotoMarkdown sends a photo with MarkdownV2 caption.
|
||||||
|
//
|
||||||
|
// ⚠️ WARNING: User input must be escaped with laniakea.EscapeMarkdownV2() before passing here.
|
||||||
|
func (ctx *MsgContext) AnswerPhotoMarkdown(photoID, text string) *AnswerMessage {
|
||||||
|
return ctx.answerPhoto(photoID, text, nil, tgapi.ParseMDV2)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnswerPhotoKeyboard sends a photo with caption and inline keyboard (plain text).
|
||||||
|
func (ctx *MsgContext) AnswerPhotoKeyboard(photoID, text string, kb *InlineKeyboard) *AnswerMessage {
|
||||||
|
return ctx.answerPhoto(photoID, text, kb, tgapi.ParseNone)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnswerPhotoKeyboardMarkdown sends a photo with caption and inline keyboard using MarkdownV2.
|
||||||
|
//
|
||||||
|
// ⚠️ WARNING: User input must be escaped with laniakea.EscapeMarkdownV2() before passing here.
|
||||||
|
func (ctx *MsgContext) AnswerPhotoKeyboardMarkdown(photoID, text string, kb *InlineKeyboard) *AnswerMessage {
|
||||||
|
return ctx.answerPhoto(photoID, text, kb, tgapi.ParseMDV2)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnswerPhotof formats a string and sends it as a photo caption (plain text).
|
||||||
|
func (ctx *MsgContext) AnswerPhotof(photoID, template string, args ...any) *AnswerMessage {
|
||||||
|
return ctx.answerPhoto(photoID, fmt.Sprintf(template, args...), nil, tgapi.ParseNone)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnswerPhotofMarkdown formats a string and sends it as a photo caption using MarkdownV2.
|
||||||
|
//
|
||||||
|
// ⚠️ WARNING: User input must be escaped with laniakea.EscapeMarkdownV2() before passing here.
|
||||||
|
func (ctx *MsgContext) AnswerPhotofMarkdown(photoID, template string, args ...any) *AnswerMessage {
|
||||||
|
return ctx.answerPhoto(photoID, fmt.Sprintf(template, args...), nil, tgapi.ParseMDV2)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Internal helper that deletes a message by ID.
|
||||||
|
func (ctx *MsgContext) delete(messageID int) {
|
||||||
|
if messageID == 0 {
|
||||||
|
ctx.Logger.Errorln(ErrMessageIDZero)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if ctx.Msg == nil {
|
||||||
|
ctx.Logger.Errorln(ErrMessageContextNil)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
_, err := ctx.API.DeleteMessageWithContext(ctx.Context(), tgapi.DeleteMessage{
|
||||||
|
ChatID: ctx.Msg.Chat.ID,
|
||||||
|
MessageID: messageID,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
ctx.Logger.Errorln(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Delete removes the message associated with this AnswerMessage.
|
||||||
|
func (m *AnswerMessage) Delete() { m.ctx.delete(m.MessageID) }
|
||||||
|
|
||||||
|
// CallbackDelete deletes the message that triggered the callback query.
|
||||||
|
func (ctx *MsgContext) CallbackDelete() {
|
||||||
|
if ctx.CallbackMsgID == 0 {
|
||||||
|
ctx.Logger.Errorln(ErrCallbackMessageMissing)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
ctx.delete(ctx.CallbackMsgID)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Internal helper that answers a callback query with optional text, alert, or URL.
|
||||||
|
func (ctx *MsgContext) answerCallbackQuery(url, text string, showAlert bool) {
|
||||||
|
if len(ctx.CallbackQueryID) == 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
_, err := ctx.API.AnswerCallbackQueryWithContext(ctx.Context(), tgapi.AnswerCallbackQuery{
|
||||||
|
CallbackQueryID: ctx.CallbackQueryID,
|
||||||
|
Text: text, ShowAlert: showAlert, URL: url,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
ctx.Logger.Errorln(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnswerCbQuery answers the callback query with no text or alert.
|
||||||
|
func (ctx *MsgContext) AnswerCbQuery() { ctx.answerCallbackQuery("", "", false) }
|
||||||
|
|
||||||
|
// AnswerCbQueryText answers the callback query with a text notification.
|
||||||
|
func (ctx *MsgContext) AnswerCbQueryText(text string) { ctx.answerCallbackQuery("", text, false) }
|
||||||
|
|
||||||
|
// AnswerCbQueryAlert answers the callback query with a user-visible alert.
|
||||||
|
func (ctx *MsgContext) AnswerCbQueryAlert(text string) { ctx.answerCallbackQuery("", text, true) }
|
||||||
|
|
||||||
|
// AnswerCbQueryURL answers the callback query with a URL redirect.
|
||||||
|
func (ctx *MsgContext) AnswerCbQueryURL(u string) { ctx.answerCallbackQuery(u, "", false) }
|
||||||
|
|
||||||
|
// SendAction sends a chat action (typing, uploading_photo, etc.) to indicate bot activity.
|
||||||
|
func (ctx *MsgContext) SendAction(action tgapi.ChatActionType) {
|
||||||
|
if ctx.Msg == nil {
|
||||||
|
ctx.Logger.Errorln("Can't send action without chat message context")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
params := tgapi.SendChatAction{
|
||||||
|
ChatID: ctx.Msg.Chat.ID, Action: action,
|
||||||
|
}
|
||||||
|
if ctx.Msg.MessageThreadID > 0 {
|
||||||
|
params.MessageThreadID = ctx.Msg.MessageThreadID
|
||||||
|
}
|
||||||
|
_, err := ctx.API.SendChatActionWithContext(ctx.Context(), params)
|
||||||
|
if err != nil {
|
||||||
|
ctx.Logger.Errorln(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Internal helper that formats, sends, and logs an error.
|
||||||
|
func (ctx *MsgContext) error(err error) {
|
||||||
|
if err == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
ctx.Logger.Errorln(err)
|
||||||
|
if IsInternalError(err) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
text := fmt.Sprintf(ctx.errorTemplate, err.Error())
|
||||||
|
|
||||||
|
if ctx.CallbackQueryID != "" {
|
||||||
|
ctx.answerCallbackQuery("", text, false)
|
||||||
|
} else {
|
||||||
|
ctx.answer(text, nil, tgapi.ParseNone)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Error is an alias for error().
|
||||||
|
func (ctx *MsgContext) Error(err error) { ctx.error(err) }
|
||||||
|
|
||||||
|
func (ctx *MsgContext) newDraft(parseMode tgapi.ParseMode) *Draft {
|
||||||
|
if ctx.Msg == nil {
|
||||||
|
ctx.Logger.Errorln(ErrMessageContextNil)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if ctx.API == nil {
|
||||||
|
ctx.Logger.Errorln(ErrAPIIsNil)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if ctx.draftProvider == nil {
|
||||||
|
ctx.Logger.Errorln(ErrDraftProviderNil)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if ctx.API.Limiter != nil {
|
||||||
|
c, cancel := context.WithTimeout(ctx.Context(), 5*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
if err := ctx.API.Limiter.Wait(c, ctx.Msg.Chat.ID); err != nil {
|
||||||
|
ctx.Logger.Errorln(err)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
draft := ctx.draftProvider.NewDraft(parseMode).SetChat(ctx.Msg.Chat.ID, ctx.Msg.MessageThreadID)
|
||||||
|
return draft
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewDraft creates a new message draft associated with the current chat.
|
||||||
|
// Uses the API limiter to avoid rate limiting.
|
||||||
|
func (ctx *MsgContext) NewDraft() *Draft {
|
||||||
|
return ctx.newDraft(tgapi.ParseNone)
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewDraftMarkdown creates a new message draft associated with the current chat,
|
||||||
|
// with Markdown V2 parse mode enabled.
|
||||||
|
// Uses the API limiter to avoid rate limiting.
|
||||||
|
func (ctx *MsgContext) NewDraftMarkdown() *Draft {
|
||||||
|
return ctx.newDraft(tgapi.ParseMDV2)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Translate looks up a key in the current user's language.
|
||||||
|
// Falls back to the bot's default language if user's language is unknown or unsupported.
|
||||||
|
func (ctx *MsgContext) Translate(key string) string {
|
||||||
|
if ctx.From == nil {
|
||||||
|
return key
|
||||||
|
}
|
||||||
|
lang := Val(ctx.From.LanguageCode, ctx.l10n.GetFallbackLanguage())
|
||||||
|
return ctx.l10n.Translate(lang, key)
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewInlineKeyboard creates a new keyboard builder with the context's payload
|
||||||
|
// encoding type and the specified maximum number of buttons per row.
|
||||||
|
func (ctx *MsgContext) NewInlineKeyboard(maxRow int) *InlineKeyboard {
|
||||||
|
return NewInlineKeyboard(ctx.payloadType, maxRow)
|
||||||
|
}
|
||||||
|
|
||||||
|
func bindPositional(args []string, dst any) error {
|
||||||
|
v := reflect.ValueOf(dst)
|
||||||
|
if v.Kind() != reflect.Pointer || v.IsNil() {
|
||||||
|
return ErrBindArgsTargetNotPointer
|
||||||
|
}
|
||||||
|
|
||||||
|
v = v.Elem()
|
||||||
|
if v.Kind() != reflect.Struct {
|
||||||
|
return ErrBindArgsTargetNotStruct
|
||||||
|
}
|
||||||
|
|
||||||
|
t := v.Type()
|
||||||
|
fields := make([]int, 0, v.NumField())
|
||||||
|
|
||||||
|
for i := 0; i < v.NumField(); i++ {
|
||||||
|
field := v.Field(i)
|
||||||
|
if !field.CanSet() {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
fields = append(fields, i)
|
||||||
|
}
|
||||||
|
|
||||||
|
argIndex := 0
|
||||||
|
for fieldPos, fieldIndex := range fields {
|
||||||
|
field := v.Field(fieldIndex)
|
||||||
|
fieldType := t.Field(fieldIndex)
|
||||||
|
|
||||||
|
if argIndex >= len(args) {
|
||||||
|
// Leave trailing fields at their zero values when arguments run out.
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
isLastBindableField := fieldPos == len(fields)-1
|
||||||
|
|
||||||
|
raw := args[argIndex]
|
||||||
|
if isLastBindableField && field.Kind() == reflect.String {
|
||||||
|
raw = strings.Join(args[argIndex:], " ")
|
||||||
|
}
|
||||||
|
|
||||||
|
switch field.Kind() {
|
||||||
|
case reflect.String:
|
||||||
|
field.SetString(raw)
|
||||||
|
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
|
||||||
|
n, err := strconv.ParseInt(raw, 10, 64)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("%w: field %s: %v", ErrBindArgsConversion, fieldType.Name, err)
|
||||||
|
}
|
||||||
|
field.SetInt(n)
|
||||||
|
case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
|
||||||
|
n, err := strconv.ParseUint(raw, 10, 64)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("%w: field %s: %v", ErrBindArgsConversion, fieldType.Name, err)
|
||||||
|
}
|
||||||
|
field.SetUint(n)
|
||||||
|
case reflect.Float32, reflect.Float64:
|
||||||
|
f, err := strconv.ParseFloat(raw, 64)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("%w: field %s: %v", ErrBindArgsConversion, fieldType.Name, err)
|
||||||
|
}
|
||||||
|
field.SetFloat(f)
|
||||||
|
case reflect.Bool:
|
||||||
|
b, err := strconv.ParseBool(raw)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("%w: field %s: %v", ErrBindArgsConversion, fieldType.Name, err)
|
||||||
|
}
|
||||||
|
field.SetBool(b)
|
||||||
|
default:
|
||||||
|
return fmt.Errorf("%w: field %s: %s", ErrBindArgsUnsupportedFieldType, fieldType.Name, field.Kind())
|
||||||
|
}
|
||||||
|
|
||||||
|
if isLastBindableField && field.Kind() == reflect.String {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
argIndex++
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// BindArgs binds positional command arguments from ctx.Args into dst.
|
||||||
|
//
|
||||||
|
// Exported struct fields are filled in declaration order. When fewer arguments
|
||||||
|
// are provided than fields, the remaining fields keep their zero values. If the
|
||||||
|
// final bindable field is a string, it receives the remaining arguments joined
|
||||||
|
// with spaces.
|
||||||
|
func (ctx *MsgContext) BindArgs(dst any) error {
|
||||||
|
return bindPositional(ctx.Args, dst)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Context returns the request-scoped context associated with the current update.
|
||||||
|
func (ctx *MsgContext) Context() context.Context {
|
||||||
|
if ctx.ctx == nil {
|
||||||
|
return context.Background()
|
||||||
|
}
|
||||||
|
return ctx.ctx
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ctx *MsgContext) emitPolicyChecked(event PolicyCheckedEvent) {
|
||||||
|
if ctx == nil || ctx.observer == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
defer func() {
|
||||||
|
if r := recover(); r != nil {
|
||||||
|
if ctx.Logger != nil {
|
||||||
|
ctx.Logger.Errorln(fmt.Sprintf("panic in observer policy event: %v", r))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
log.Printf("panic in observer policy event: %v", r)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
ctx.observer.OnPolicyChecked(ctx.Context(), event)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EnterScene enters the named scene at its configured entry step.
|
||||||
|
func (ctx *MsgContext) EnterScene(name string) error {
|
||||||
|
if ctx.sceneRuntime == nil {
|
||||||
|
return ErrSceneRuntimeNil
|
||||||
|
}
|
||||||
|
|
||||||
|
scene, ok := ctx.sceneRuntime.findScene(name)
|
||||||
|
if !ok {
|
||||||
|
return ErrSceneNotFound
|
||||||
|
}
|
||||||
|
|
||||||
|
key, ok := ctx.sceneRuntime.buildSceneKey(scene.Scope, ctx)
|
||||||
|
if !ok {
|
||||||
|
return ErrCantFindSession
|
||||||
|
}
|
||||||
|
if scene.Entry == "" {
|
||||||
|
return ErrSceneEntryNotSet
|
||||||
|
}
|
||||||
|
if _, ok := scene.Steps[scene.Entry]; !ok {
|
||||||
|
return ErrSceneStepNotFound
|
||||||
|
}
|
||||||
|
|
||||||
|
session := SceneSession{
|
||||||
|
Scene: scene.Name,
|
||||||
|
Step: scene.Entry,
|
||||||
|
}
|
||||||
|
|
||||||
|
return ctx.sceneRuntime.setSession(key, session)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EnterSceneStep enters the named scene at a specific step.
|
||||||
|
func (ctx *MsgContext) EnterSceneStep(name, step string) error {
|
||||||
|
if ctx.sceneRuntime == nil {
|
||||||
|
return ErrSceneRuntimeNil
|
||||||
|
}
|
||||||
|
|
||||||
|
scene, ok := ctx.sceneRuntime.findScene(name)
|
||||||
|
if !ok {
|
||||||
|
return ErrSceneNotFound
|
||||||
|
}
|
||||||
|
if _, ok := scene.Steps[step]; !ok {
|
||||||
|
return ErrSceneStepNotFound
|
||||||
|
}
|
||||||
|
|
||||||
|
key, ok := ctx.sceneRuntime.buildSceneKey(scene.Scope, ctx)
|
||||||
|
if !ok {
|
||||||
|
return ErrCantFindSession
|
||||||
|
}
|
||||||
|
|
||||||
|
session := SceneSession{
|
||||||
|
Scene: scene.Name,
|
||||||
|
Step: step,
|
||||||
|
}
|
||||||
|
|
||||||
|
return ctx.sceneRuntime.setSession(key, session)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExitScene leaves the currently active scene for this context.
|
||||||
|
func (ctx *MsgContext) ExitScene() error {
|
||||||
|
if ctx.sceneRuntime == nil {
|
||||||
|
return ErrSceneRuntimeNil
|
||||||
|
}
|
||||||
|
|
||||||
|
_, session, err := ctx.sceneRuntime.findSceneSession(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if session.Scene == "" {
|
||||||
|
return ErrNotInScene
|
||||||
|
}
|
||||||
|
|
||||||
|
scene, ok := ctx.sceneRuntime.findScene(session.Scene)
|
||||||
|
if !ok {
|
||||||
|
return ErrSceneNotFound
|
||||||
|
}
|
||||||
|
|
||||||
|
key, ok := ctx.sceneRuntime.buildSceneKey(scene.Scope, ctx)
|
||||||
|
if !ok {
|
||||||
|
return ErrCantFindSession
|
||||||
|
}
|
||||||
|
|
||||||
|
return ctx.sceneRuntime.deleteSession(key)
|
||||||
|
}
|
||||||
@@ -0,0 +1,468 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
|
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestAnswerPhotoIncludesDirectMessagesTopicID(t *testing.T) {
|
||||||
|
var gotBody map[string]any
|
||||||
|
|
||||||
|
client := &http.Client{
|
||||||
|
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
body, err := io.ReadAll(req.Body)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to read request body: %v", err)
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(body, &gotBody); err != nil {
|
||||||
|
t.Fatalf("failed to decode request body: %v", err)
|
||||||
|
}
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||||
|
Body: io.NopCloser(strings.NewReader(`{"ok":true,"result":{"message_id":9,"date":1}}`)),
|
||||||
|
}, nil
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
|
||||||
|
api := tgapi.NewAPI(
|
||||||
|
tgapi.NewAPIOpts("token").
|
||||||
|
SetAPIURL("https://example.test").
|
||||||
|
SetHTTPClient(client),
|
||||||
|
)
|
||||||
|
defer func() {
|
||||||
|
if err := api.Close(); err != nil {
|
||||||
|
t.Fatalf("Close returned error: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
ctx := &MsgContext{
|
||||||
|
API: api,
|
||||||
|
Msg: &tgapi.Message{
|
||||||
|
Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate},
|
||||||
|
DirectMessageTopic: &tgapi.DirectMessageTopic{TopicID: 77},
|
||||||
|
},
|
||||||
|
Logger: sneklog.NewLogger(),
|
||||||
|
}
|
||||||
|
|
||||||
|
answer := ctx.AnswerPhoto("photo-id", "caption")
|
||||||
|
if answer == nil {
|
||||||
|
t.Fatal("expected answer message")
|
||||||
|
}
|
||||||
|
if answer.MessageID != 9 {
|
||||||
|
t.Fatalf("unexpected message id: %d", answer.MessageID)
|
||||||
|
}
|
||||||
|
if got := gotBody["direct_messages_topic_id"]; got != float64(77) {
|
||||||
|
t.Fatalf("unexpected direct_messages_topic_id: %v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBindArgsBindsScalarFields(t *testing.T) {
|
||||||
|
type input struct {
|
||||||
|
ID int
|
||||||
|
Active bool
|
||||||
|
Score float64
|
||||||
|
Name string
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx := &MsgContext{Args: []string{"42", "true", "3.5", "Ada", "Lovelace"}}
|
||||||
|
var got input
|
||||||
|
|
||||||
|
if err := ctx.BindArgs(&got); err != nil {
|
||||||
|
t.Fatalf("BindArgs returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
want := input{
|
||||||
|
ID: 42,
|
||||||
|
Active: true,
|
||||||
|
Score: 3.5,
|
||||||
|
Name: "Ada Lovelace",
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(got, want) {
|
||||||
|
t.Fatalf("unexpected bound value: got %#v want %#v", got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBindArgsLeavesTrailingFieldsZeroWhenArgsRunOut(t *testing.T) {
|
||||||
|
type input struct {
|
||||||
|
ID int
|
||||||
|
Reason string
|
||||||
|
Admin bool
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx := &MsgContext{Args: []string{"7"}}
|
||||||
|
var got input
|
||||||
|
|
||||||
|
if err := ctx.BindArgs(&got); err != nil {
|
||||||
|
t.Fatalf("BindArgs returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if got.ID != 7 {
|
||||||
|
t.Fatalf("unexpected ID: got %d want 7", got.ID)
|
||||||
|
}
|
||||||
|
if got.Reason != "" {
|
||||||
|
t.Fatalf("expected zero-value Reason, got %q", got.Reason)
|
||||||
|
}
|
||||||
|
if got.Admin {
|
||||||
|
t.Fatal("expected zero-value Admin")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBindArgsRejectsInvalidTargets(t *testing.T) {
|
||||||
|
ctx := &MsgContext{Args: []string{"1"}}
|
||||||
|
|
||||||
|
if err := ctx.BindArgs(nil); !errors.Is(err, ErrBindArgsTargetNotPointer) {
|
||||||
|
t.Fatalf("expected ErrBindArgsTargetNotPointer for nil target, got %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var notStruct int
|
||||||
|
if err := ctx.BindArgs(¬Struct); !errors.Is(err, ErrBindArgsTargetNotStruct) {
|
||||||
|
t.Fatalf("expected ErrBindArgsTargetNotStruct for non-struct target, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBindArgsReportsConversionFailures(t *testing.T) {
|
||||||
|
type input struct {
|
||||||
|
ID int
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx := &MsgContext{Args: []string{"oops"}}
|
||||||
|
var got input
|
||||||
|
|
||||||
|
err := ctx.BindArgs(&got)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected BindArgs to fail")
|
||||||
|
}
|
||||||
|
if !errors.Is(err, ErrBindArgsConversion) {
|
||||||
|
t.Fatalf("expected ErrBindArgsConversion, got %v", err)
|
||||||
|
}
|
||||||
|
if !strings.Contains(err.Error(), "field ID") {
|
||||||
|
t.Fatalf("expected field name in error, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBindArgsRejectsUnsupportedFieldTypes(t *testing.T) {
|
||||||
|
type input struct {
|
||||||
|
Tags []string
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx := &MsgContext{Args: []string{"tag"}}
|
||||||
|
var got input
|
||||||
|
|
||||||
|
err := ctx.BindArgs(&got)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected BindArgs to fail")
|
||||||
|
}
|
||||||
|
if !errors.Is(err, ErrBindArgsUnsupportedFieldType) {
|
||||||
|
t.Fatalf("expected ErrBindArgsUnsupportedFieldType, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestErrorDefaultRemainsUserVisibleForMessageFlow(t *testing.T) {
|
||||||
|
var requests int
|
||||||
|
var gotBody map[string]any
|
||||||
|
|
||||||
|
client := &http.Client{
|
||||||
|
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
requests++
|
||||||
|
body, err := io.ReadAll(req.Body)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to read request body: %v", err)
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(body, &gotBody); err != nil {
|
||||||
|
t.Fatalf("failed to decode request body: %v", err)
|
||||||
|
}
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||||
|
Body: io.NopCloser(strings.NewReader(`{"ok":true,"result":{"message_id":9,"date":1}}`)),
|
||||||
|
}, nil
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
|
||||||
|
api := tgapi.NewAPI(
|
||||||
|
tgapi.NewAPIOpts("token").
|
||||||
|
SetAPIURL("https://example.test").
|
||||||
|
SetHTTPClient(client),
|
||||||
|
)
|
||||||
|
defer func() {
|
||||||
|
if err := api.Close(); err != nil {
|
||||||
|
t.Fatalf("Close returned error: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
ctx := &MsgContext{
|
||||||
|
API: api,
|
||||||
|
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate}},
|
||||||
|
Logger: sneklog.NewLogger(),
|
||||||
|
errorTemplate: "Error: %s",
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx.error(errors.New("boom"))
|
||||||
|
|
||||||
|
if requests != 1 {
|
||||||
|
t.Fatalf("expected one user-facing error reply, got %d requests", requests)
|
||||||
|
}
|
||||||
|
if got := gotBody["text"]; got != "Error: boom" {
|
||||||
|
t.Fatalf("unexpected error reply text: %v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestErrorInternalSkipsUserReplyForMessageFlow(t *testing.T) {
|
||||||
|
client := &http.Client{
|
||||||
|
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
t.Fatal("unexpected HTTP request for internal-only error")
|
||||||
|
return nil, nil
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
|
||||||
|
api := tgapi.NewAPI(
|
||||||
|
tgapi.NewAPIOpts("token").
|
||||||
|
SetAPIURL("https://example.test").
|
||||||
|
SetHTTPClient(client),
|
||||||
|
)
|
||||||
|
defer func() {
|
||||||
|
if err := api.Close(); err != nil {
|
||||||
|
t.Fatalf("Close returned error: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
ctx := &MsgContext{
|
||||||
|
API: api,
|
||||||
|
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate}},
|
||||||
|
Logger: sneklog.NewLogger(),
|
||||||
|
errorTemplate: "Error: %s",
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx.error(AsInternalError(errors.New("boom")))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestErrorInternalSkipsCallbackAnswer(t *testing.T) {
|
||||||
|
client := &http.Client{
|
||||||
|
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
t.Fatal("unexpected callback answer request for internal-only error")
|
||||||
|
return nil, nil
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
|
||||||
|
api := tgapi.NewAPI(
|
||||||
|
tgapi.NewAPIOpts("token").
|
||||||
|
SetAPIURL("https://example.test").
|
||||||
|
SetHTTPClient(client),
|
||||||
|
)
|
||||||
|
defer func() {
|
||||||
|
if err := api.Close(); err != nil {
|
||||||
|
t.Fatalf("Close returned error: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
ctx := &MsgContext{
|
||||||
|
API: api,
|
||||||
|
Logger: sneklog.NewLogger(),
|
||||||
|
errorTemplate: "%s",
|
||||||
|
CallbackQueryID: "cb-1",
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx.error(AsInternalError(errors.New("boom")))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestErrorUserVisibleAnswersCallback(t *testing.T) {
|
||||||
|
var requests int
|
||||||
|
var gotBody map[string]any
|
||||||
|
|
||||||
|
client := &http.Client{
|
||||||
|
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
requests++
|
||||||
|
body, err := io.ReadAll(req.Body)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to read request body: %v", err)
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(body, &gotBody); err != nil {
|
||||||
|
t.Fatalf("failed to decode request body: %v", err)
|
||||||
|
}
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||||
|
Body: io.NopCloser(strings.NewReader(`{"ok":true,"result":true}`)),
|
||||||
|
}, nil
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
|
||||||
|
api := tgapi.NewAPI(
|
||||||
|
tgapi.NewAPIOpts("token").
|
||||||
|
SetAPIURL("https://example.test").
|
||||||
|
SetHTTPClient(client),
|
||||||
|
)
|
||||||
|
defer func() {
|
||||||
|
if err := api.Close(); err != nil {
|
||||||
|
t.Fatalf("Close returned error: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
ctx := &MsgContext{
|
||||||
|
API: api,
|
||||||
|
Logger: sneklog.NewLogger(),
|
||||||
|
errorTemplate: "Oops: %s",
|
||||||
|
CallbackQueryID: "cb-1",
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx.error(AsUserError(errors.New("boom")))
|
||||||
|
|
||||||
|
if requests != 1 {
|
||||||
|
t.Fatalf("expected one callback error answer, got %d requests", requests)
|
||||||
|
}
|
||||||
|
if got := gotBody["text"]; got != "Oops: boom" {
|
||||||
|
t.Fatalf("unexpected callback error text: %v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAnswerRejectsEmptyMessage(t *testing.T) {
|
||||||
|
ctx := &MsgContext{
|
||||||
|
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate}},
|
||||||
|
Logger: sneklog.NewLogger(),
|
||||||
|
}
|
||||||
|
|
||||||
|
if answer := ctx.Answer(""); answer != nil {
|
||||||
|
t.Fatal("expected nil answer for empty message")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAnswerRejectsLongMessageWithoutSendingRequest(t *testing.T) {
|
||||||
|
client := &http.Client{
|
||||||
|
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
t.Fatal("unexpected HTTP request")
|
||||||
|
return nil, nil
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
|
||||||
|
api := tgapi.NewAPI(
|
||||||
|
tgapi.NewAPIOpts("token").
|
||||||
|
SetAPIURL("https://example.test").
|
||||||
|
SetHTTPClient(client),
|
||||||
|
)
|
||||||
|
defer func() {
|
||||||
|
if err := api.Close(); err != nil {
|
||||||
|
t.Fatalf("Close returned error: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
ctx := &MsgContext{
|
||||||
|
API: api,
|
||||||
|
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate}},
|
||||||
|
Logger: sneklog.NewLogger(),
|
||||||
|
}
|
||||||
|
|
||||||
|
if answer := ctx.Answer(strings.Repeat("a", maxMessageTextLen+1)); answer != nil {
|
||||||
|
t.Fatal("expected nil answer for long message")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestValidateMessageText(t *testing.T) {
|
||||||
|
if err := validateMessageText(""); !errors.Is(err, ErrEmptyMessage) {
|
||||||
|
t.Fatalf("expected ErrEmptyMessage, got %v", err)
|
||||||
|
}
|
||||||
|
if err := validateMessageText(strings.Repeat("a", maxMessageTextLen+1)); !errors.Is(err, ErrMessageTooLong) {
|
||||||
|
t.Fatalf("expected ErrMessageTooLong, got %v", err)
|
||||||
|
}
|
||||||
|
if err := validateMessageText("ok"); err != nil {
|
||||||
|
t.Fatalf("expected nil error, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestValidateCaptionText(t *testing.T) {
|
||||||
|
if err := validateCaptionText(strings.Repeat("a", maxMessageCaptionLen+1)); !errors.Is(err, ErrCaptionTooLong) {
|
||||||
|
t.Fatalf("expected ErrCaptionTooLong, got %v", err)
|
||||||
|
}
|
||||||
|
if err := validateCaptionText(""); err != nil {
|
||||||
|
t.Fatalf("expected nil error, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSplitMessageTextPreservesContent(t *testing.T) {
|
||||||
|
text := "alpha beta\n" + strings.Repeat("x", maxMessageTextLen) + " omega"
|
||||||
|
|
||||||
|
parts := SplitMessageText(text)
|
||||||
|
if len(parts) < 2 {
|
||||||
|
t.Fatalf("expected multiple parts, got %d", len(parts))
|
||||||
|
}
|
||||||
|
|
||||||
|
for i, part := range parts {
|
||||||
|
if got := len([]rune(part)); got > maxMessageTextLen {
|
||||||
|
t.Fatalf("part %d exceeded limit: %d", i, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if got := strings.Join(parts, ""); got != text {
|
||||||
|
t.Fatalf("split/join mismatch: got %q want %q", got, text)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAnswerLongSplitsRequestsAndAttachesKeyboardToLastChunk(t *testing.T) {
|
||||||
|
var requests []map[string]any
|
||||||
|
|
||||||
|
client := &http.Client{
|
||||||
|
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
body, err := io.ReadAll(req.Body)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to read request body: %v", err)
|
||||||
|
}
|
||||||
|
var got map[string]any
|
||||||
|
if err := json.Unmarshal(body, &got); err != nil {
|
||||||
|
t.Fatalf("failed to decode request body: %v", err)
|
||||||
|
}
|
||||||
|
requests = append(requests, got)
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||||
|
Body: io.NopCloser(strings.NewReader(`{"ok":true,"result":{"message_id":9,"date":1}}`)),
|
||||||
|
}, nil
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
|
||||||
|
api := tgapi.NewAPI(
|
||||||
|
tgapi.NewAPIOpts("token").
|
||||||
|
SetAPIURL("https://example.test").
|
||||||
|
SetHTTPClient(client),
|
||||||
|
)
|
||||||
|
defer func() {
|
||||||
|
if err := api.Close(); err != nil {
|
||||||
|
t.Fatalf("Close returned error: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
ctx := &MsgContext{
|
||||||
|
API: api,
|
||||||
|
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate}},
|
||||||
|
Logger: sneklog.NewLogger(),
|
||||||
|
}
|
||||||
|
kb := NewInlineKeyboardJSON(1).AddCallbackButton("A", "cmd")
|
||||||
|
text := strings.Repeat("a", maxMessageTextLen) + " " + strings.Repeat("b", 32)
|
||||||
|
|
||||||
|
messages := ctx.KeyboardLong(text, kb)
|
||||||
|
if got := len(messages); got != 2 {
|
||||||
|
t.Fatalf("expected 2 sent messages, got %d", got)
|
||||||
|
}
|
||||||
|
if got := len(requests); got != 2 {
|
||||||
|
t.Fatalf("expected 2 requests, got %d", got)
|
||||||
|
}
|
||||||
|
if _, ok := requests[0]["reply_markup"]; ok {
|
||||||
|
t.Fatal("did not expect keyboard on first chunk")
|
||||||
|
}
|
||||||
|
if _, ok := requests[1]["reply_markup"]; !ok {
|
||||||
|
t.Fatal("expected keyboard on final chunk")
|
||||||
|
}
|
||||||
|
|
||||||
|
gotTexts := []string{requests[0]["text"].(string), requests[1]["text"].(string)}
|
||||||
|
wantTexts := SplitMessageText(text)
|
||||||
|
if !reflect.DeepEqual(gotTexts, wantTexts) {
|
||||||
|
t.Fatalf("unexpected chunk texts: got %q want %q", gotTexts, wantTexts)
|
||||||
|
}
|
||||||
|
}
|
||||||
+297
@@ -0,0 +1,297 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
|
)
|
||||||
|
|
||||||
|
func (bot *Bot[T]) handleMessage(update *tgapi.Update, ctx *MsgContext) bool {
|
||||||
|
text, ok := messageText(update)
|
||||||
|
if !ok {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
prefix, cmd, args := bot.parseCommand(text)
|
||||||
|
if cmd == "" {
|
||||||
|
return bot.handleFallback(update, ctx)
|
||||||
|
}
|
||||||
|
ctx.Prefix = prefix
|
||||||
|
|
||||||
|
if strings.Contains(cmd, "@") {
|
||||||
|
botUsername := bot.username
|
||||||
|
if botUsername != "" && strings.HasSuffix(cmd, "@"+botUsername) {
|
||||||
|
cmd = cmd[:len(cmd)-len("@"+botUsername)] // убираем @botname
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Ищем команду по точному совпадению
|
||||||
|
for _, plugin := range bot.plugins {
|
||||||
|
if _, exists := plugin.commands[cmd]; exists {
|
||||||
|
|
||||||
|
ctx.Text = args
|
||||||
|
ctx.Args = strings.Fields(args) // Убирает лишние пробелы
|
||||||
|
|
||||||
|
if plugin.logger != nil {
|
||||||
|
ctx.Logger = plugin.logger
|
||||||
|
}
|
||||||
|
if !plugin.executeMiddlewares(ctx, bot.appData) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
startTime := time.Now()
|
||||||
|
bot.safeEmitEvent(ctx.Context(), HandlerStartedEvent{
|
||||||
|
UpdateID: update.UpdateID,
|
||||||
|
UpdateType: update.Type,
|
||||||
|
Plugin: plugin.name,
|
||||||
|
HandlerKind: HandlerCommandKind,
|
||||||
|
HandlerName: cmd,
|
||||||
|
FromID: ctx.FromID,
|
||||||
|
ChatID: ctx.ChatID,
|
||||||
|
})
|
||||||
|
|
||||||
|
err := plugin.executeCmd(cmd, ctx, bot.appData)
|
||||||
|
handlerEndEvent := HandlerFinishedEvent{
|
||||||
|
UpdateID: update.UpdateID,
|
||||||
|
UpdateType: update.Type,
|
||||||
|
Plugin: plugin.name,
|
||||||
|
HandlerKind: HandlerCommandKind,
|
||||||
|
HandlerName: cmd,
|
||||||
|
FromID: ctx.FromID,
|
||||||
|
ChatID: ctx.ChatID,
|
||||||
|
Duration: time.Since(startTime),
|
||||||
|
}
|
||||||
|
|
||||||
|
var errorEvent *ErrorEvent = nil
|
||||||
|
if err != nil {
|
||||||
|
ctx.error(err)
|
||||||
|
handlerEndEvent.Err = err
|
||||||
|
handlerEndEvent.UserFacing = IsUserError(err)
|
||||||
|
errorEvent = &ErrorEvent{
|
||||||
|
UpdateID: update.UpdateID,
|
||||||
|
UpdateType: update.Type,
|
||||||
|
Plugin: plugin.name,
|
||||||
|
HandlerKind: HandlerCommandKind,
|
||||||
|
HandlerName: cmd,
|
||||||
|
FromID: ctx.FromID,
|
||||||
|
ChatID: ctx.ChatID,
|
||||||
|
Err: err,
|
||||||
|
UserFacing: handlerEndEvent.UserFacing,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
bot.safeEmitEvent(ctx.Context(), handlerEndEvent)
|
||||||
|
if errorEvent != nil {
|
||||||
|
bot.safeEmitEvent(ctx.Context(), *errorEvent)
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return bot.handleFallback(update, ctx)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) handleFallback(update *tgapi.Update, ctx *MsgContext) bool {
|
||||||
|
text, ok := messageText(update)
|
||||||
|
if !ok {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
prefix, _, _ := bot.parseCommand(text)
|
||||||
|
handled := false
|
||||||
|
for _, plugin := range bot.plugins {
|
||||||
|
if plugin.messageFallback == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
pluginCtx := cloneMsgContext(ctx)
|
||||||
|
pluginCtx.Prefix = prefix
|
||||||
|
pluginCtx.Text = text
|
||||||
|
pluginCtx.Args = strings.Fields(text)
|
||||||
|
if plugin.logger != nil {
|
||||||
|
pluginCtx.Logger = plugin.logger
|
||||||
|
}
|
||||||
|
if !plugin.executeMiddlewares(pluginCtx, bot.appData) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
startTime := time.Now()
|
||||||
|
bot.safeEmitEvent(pluginCtx.Context(), HandlerStartedEvent{
|
||||||
|
UpdateID: update.UpdateID,
|
||||||
|
UpdateType: update.Type,
|
||||||
|
Plugin: plugin.name,
|
||||||
|
HandlerKind: HandlerMessageKind,
|
||||||
|
HandlerName: "message_fallback",
|
||||||
|
FromID: pluginCtx.FromID,
|
||||||
|
ChatID: pluginCtx.ChatID,
|
||||||
|
})
|
||||||
|
err := plugin.messageFallback(pluginCtx, bot.appData)
|
||||||
|
endEvent := HandlerFinishedEvent{
|
||||||
|
UpdateID: update.UpdateID,
|
||||||
|
UpdateType: update.Type,
|
||||||
|
Plugin: plugin.name,
|
||||||
|
HandlerKind: HandlerMessageKind,
|
||||||
|
HandlerName: "message_fallback",
|
||||||
|
FromID: pluginCtx.FromID,
|
||||||
|
ChatID: pluginCtx.ChatID,
|
||||||
|
Duration: time.Since(startTime),
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
endEvent.Err = err
|
||||||
|
endEvent.UserFacing = IsUserError(err)
|
||||||
|
}
|
||||||
|
bot.safeEmitEvent(pluginCtx.Context(), endEvent)
|
||||||
|
if err != nil {
|
||||||
|
pluginCtx.error(err)
|
||||||
|
bot.safeEmitEvent(pluginCtx.Context(), ErrorEvent{
|
||||||
|
UpdateID: update.UpdateID,
|
||||||
|
UpdateType: update.Type,
|
||||||
|
Plugin: plugin.name,
|
||||||
|
HandlerKind: HandlerMessageKind,
|
||||||
|
HandlerName: "message_fallback",
|
||||||
|
FromID: pluginCtx.FromID,
|
||||||
|
ChatID: pluginCtx.ChatID,
|
||||||
|
Err: err,
|
||||||
|
UserFacing: IsUserError(err),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
handled = true
|
||||||
|
}
|
||||||
|
return handled
|
||||||
|
}
|
||||||
|
|
||||||
|
func messageText(update *tgapi.Update) (string, bool) {
|
||||||
|
var msg *tgapi.Message
|
||||||
|
if update.Message != nil {
|
||||||
|
msg = update.Message
|
||||||
|
} else if update.ChannelPost != nil {
|
||||||
|
msg = update.ChannelPost
|
||||||
|
} else {
|
||||||
|
return "", false
|
||||||
|
}
|
||||||
|
|
||||||
|
var text string
|
||||||
|
if len(msg.Text) > 0 {
|
||||||
|
text = msg.Text
|
||||||
|
} else if len(msg.Caption) > 0 {
|
||||||
|
text = msg.Caption
|
||||||
|
} else {
|
||||||
|
return "", false
|
||||||
|
}
|
||||||
|
return text, true
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) handleCallback(update *tgapi.Update, ctx *MsgContext) bool {
|
||||||
|
data, err := bot.decodePayload(update.CallbackQuery.Data)
|
||||||
|
if err != nil {
|
||||||
|
bot.logger.Errorln(err)
|
||||||
|
bot.safeEmitEvent(ctx.Context(), ErrorEvent{
|
||||||
|
UpdateID: update.UpdateID,
|
||||||
|
UpdateType: update.Type,
|
||||||
|
Plugin: "bot",
|
||||||
|
HandlerKind: HandlerPayloadKind,
|
||||||
|
HandlerName: "decodePayload",
|
||||||
|
FromID: ctx.FromID,
|
||||||
|
ChatID: ctx.ChatID,
|
||||||
|
Err: err,
|
||||||
|
UserFacing: false,
|
||||||
|
})
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx.Args = data.Args
|
||||||
|
|
||||||
|
for _, plugin := range bot.plugins {
|
||||||
|
_, ok := plugin.payloads[data.Command]
|
||||||
|
if !ok {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx.Logger = plugin.logger
|
||||||
|
if ctx.Logger == nil {
|
||||||
|
ctx.Logger = bot.logger
|
||||||
|
}
|
||||||
|
|
||||||
|
if !plugin.executeMiddlewares(ctx, bot.appData) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
startTime := time.Now()
|
||||||
|
bot.safeEmitEvent(ctx.Context(), HandlerStartedEvent{
|
||||||
|
UpdateID: update.UpdateID,
|
||||||
|
UpdateType: update.Type,
|
||||||
|
Plugin: plugin.name,
|
||||||
|
HandlerKind: HandlerPayloadKind,
|
||||||
|
HandlerName: data.Command,
|
||||||
|
FromID: ctx.FromID,
|
||||||
|
ChatID: ctx.ChatID,
|
||||||
|
})
|
||||||
|
err := plugin.executePayload(data.Command, ctx, bot.appData)
|
||||||
|
|
||||||
|
endEvent := HandlerFinishedEvent{
|
||||||
|
UpdateID: update.UpdateID,
|
||||||
|
UpdateType: update.Type,
|
||||||
|
Plugin: plugin.name,
|
||||||
|
HandlerKind: HandlerPayloadKind,
|
||||||
|
HandlerName: data.Command,
|
||||||
|
FromID: ctx.FromID,
|
||||||
|
ChatID: ctx.ChatID,
|
||||||
|
Duration: time.Since(startTime),
|
||||||
|
}
|
||||||
|
var errorEvent *ErrorEvent = nil
|
||||||
|
if err != nil {
|
||||||
|
ctx.error(err)
|
||||||
|
errorEvent = &ErrorEvent{
|
||||||
|
UpdateID: update.UpdateID,
|
||||||
|
UpdateType: update.Type,
|
||||||
|
Plugin: plugin.name,
|
||||||
|
HandlerKind: HandlerPayloadKind,
|
||||||
|
HandlerName: data.Command,
|
||||||
|
FromID: ctx.FromID,
|
||||||
|
ChatID: ctx.ChatID,
|
||||||
|
Err: err,
|
||||||
|
UserFacing: IsUserError(err),
|
||||||
|
}
|
||||||
|
endEvent.Err = err
|
||||||
|
endEvent.UserFacing = errorEvent.UserFacing
|
||||||
|
}
|
||||||
|
bot.safeEmitEvent(ctx.Context(), endEvent)
|
||||||
|
if errorEvent != nil {
|
||||||
|
bot.safeEmitEvent(ctx.Context(), *errorEvent)
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) checkPrefixes(text string) (string, bool) {
|
||||||
|
for _, prefix := range bot.prefixes {
|
||||||
|
if prefix == "" {
|
||||||
|
if bot.logger != nil {
|
||||||
|
bot.logger.Warnln("empty prefix is not allowed")
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if strings.HasPrefix(text, prefix) {
|
||||||
|
return prefix, true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return "", false
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) parseCommand(text string) (prefix, cmd, args string) {
|
||||||
|
if prefix, hasPrefix := bot.checkPrefixes(text); hasPrefix {
|
||||||
|
text = strings.TrimSpace(text[len(prefix):])
|
||||||
|
spaceIndex := strings.Index(text, " ")
|
||||||
|
var cmd string
|
||||||
|
var args string
|
||||||
|
if spaceIndex == -1 {
|
||||||
|
cmd = text
|
||||||
|
args = ""
|
||||||
|
} else {
|
||||||
|
cmd = text[:spaceIndex]
|
||||||
|
args = strings.TrimSpace(text[spaceIndex:])
|
||||||
|
}
|
||||||
|
return prefix, cmd, args
|
||||||
|
}
|
||||||
|
return "", "", ""
|
||||||
|
}
|
||||||
+188
@@ -0,0 +1,188 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
|
)
|
||||||
|
|
||||||
|
// HandlerEventKind identifies the kind of handler observed by runtime events.
|
||||||
|
type HandlerEventKind string
|
||||||
|
|
||||||
|
const (
|
||||||
|
// HandlerCommandKind identifies a command handler.
|
||||||
|
HandlerCommandKind HandlerEventKind = "command"
|
||||||
|
// HandlerMessageKind identifies a message fallback handler.
|
||||||
|
HandlerMessageKind HandlerEventKind = "message"
|
||||||
|
// HandlerPayloadKind identifies a callback payload handler.
|
||||||
|
HandlerPayloadKind HandlerEventKind = "payload"
|
||||||
|
// HandlerUpdateKind identifies a generic update handler.
|
||||||
|
HandlerUpdateKind HandlerEventKind = "update"
|
||||||
|
// HandlerRunnerKind identifies a background runner execution.
|
||||||
|
HandlerRunnerKind HandlerEventKind = "runner"
|
||||||
|
// HandlerPollingKind identifies polling and getUpdates runtime work.
|
||||||
|
HandlerPollingKind HandlerEventKind = "polling"
|
||||||
|
// HandlerSceneKind identifies a scene runtime handler wrapper.
|
||||||
|
HandlerSceneKind HandlerEventKind = "scene"
|
||||||
|
// HandlerSceneStepKind identifies a scene step handler.
|
||||||
|
HandlerSceneStepKind HandlerEventKind = "scene_step"
|
||||||
|
// HandlerSceneCommandKind identifies a scene-local command handler.
|
||||||
|
HandlerSceneCommandKind HandlerEventKind = "scene_command"
|
||||||
|
// HandlerScenePayloadKind identifies a scene-local callback payload handler.
|
||||||
|
HandlerScenePayloadKind HandlerEventKind = "scene_payload"
|
||||||
|
// HandlerSceneMessageKind identifies a scene message fallback handler.
|
||||||
|
HandlerSceneMessageKind HandlerEventKind = "scene_message"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Event is the marker interface implemented by all observer runtime events.
|
||||||
|
type Event interface {
|
||||||
|
isEvent()
|
||||||
|
}
|
||||||
|
|
||||||
|
// UpdateReceivedEvent describes an update entering the bot runtime.
|
||||||
|
type UpdateReceivedEvent struct {
|
||||||
|
UpdateID int
|
||||||
|
UpdateType tgapi.UpdateType
|
||||||
|
FromID int64
|
||||||
|
ChatID int64
|
||||||
|
}
|
||||||
|
|
||||||
|
// UpdateHandledEvent describes a completed update execution path.
|
||||||
|
type UpdateHandledEvent struct {
|
||||||
|
UpdateID int
|
||||||
|
UpdateType tgapi.UpdateType
|
||||||
|
FromID int64
|
||||||
|
ChatID int64
|
||||||
|
Duration time.Duration
|
||||||
|
Handled bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// HandlerStartedEvent describes a handler about to execute.
|
||||||
|
type HandlerStartedEvent struct {
|
||||||
|
UpdateID int
|
||||||
|
UpdateType tgapi.UpdateType
|
||||||
|
Plugin string
|
||||||
|
HandlerKind HandlerEventKind
|
||||||
|
HandlerName string
|
||||||
|
FromID int64
|
||||||
|
ChatID int64
|
||||||
|
}
|
||||||
|
|
||||||
|
// HandlerFinishedEvent describes a handler that has completed.
|
||||||
|
type HandlerFinishedEvent struct {
|
||||||
|
UpdateID int
|
||||||
|
UpdateType tgapi.UpdateType
|
||||||
|
Plugin string
|
||||||
|
HandlerKind HandlerEventKind
|
||||||
|
HandlerName string
|
||||||
|
FromID int64
|
||||||
|
ChatID int64
|
||||||
|
Duration time.Duration
|
||||||
|
Err error
|
||||||
|
UserFacing bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// SceneTransitionEvent describes a scene state transition.
|
||||||
|
type SceneTransitionEvent struct {
|
||||||
|
Plugin string
|
||||||
|
Scene string
|
||||||
|
From string
|
||||||
|
To string
|
||||||
|
Action SceneAction
|
||||||
|
FromID int64
|
||||||
|
ChatID int64
|
||||||
|
}
|
||||||
|
|
||||||
|
// PolicyCheckedEvent describes the result of a policy evaluation.
|
||||||
|
type PolicyCheckedEvent struct {
|
||||||
|
Name string
|
||||||
|
Plugin string
|
||||||
|
FromID int64
|
||||||
|
ChatID int64
|
||||||
|
Passed bool
|
||||||
|
Err error
|
||||||
|
Internal bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// RunnerFinishedEvent describes a completed background runner execution.
|
||||||
|
type RunnerFinishedEvent struct {
|
||||||
|
Name string
|
||||||
|
Duration time.Duration
|
||||||
|
Err error
|
||||||
|
}
|
||||||
|
|
||||||
|
// PollingRetryEvent describes a polling retry after a failed getUpdates call.
|
||||||
|
type PollingRetryEvent struct {
|
||||||
|
Attempt int
|
||||||
|
Delay time.Duration
|
||||||
|
Err error
|
||||||
|
}
|
||||||
|
|
||||||
|
// ErrorEvent describes an error routed through framework error handling.
|
||||||
|
type ErrorEvent struct {
|
||||||
|
UpdateID int
|
||||||
|
UpdateType tgapi.UpdateType
|
||||||
|
Plugin string
|
||||||
|
HandlerKind HandlerEventKind
|
||||||
|
HandlerName string
|
||||||
|
FromID int64
|
||||||
|
ChatID int64
|
||||||
|
Err error
|
||||||
|
UserFacing bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func (UpdateReceivedEvent) isEvent() {}
|
||||||
|
func (UpdateHandledEvent) isEvent() {}
|
||||||
|
func (HandlerStartedEvent) isEvent() {}
|
||||||
|
func (HandlerFinishedEvent) isEvent() {}
|
||||||
|
func (SceneTransitionEvent) isEvent() {}
|
||||||
|
func (PolicyCheckedEvent) isEvent() {}
|
||||||
|
func (RunnerFinishedEvent) isEvent() {}
|
||||||
|
func (PollingRetryEvent) isEvent() {}
|
||||||
|
func (ErrorEvent) isEvent() {}
|
||||||
|
|
||||||
|
// Observer receives best-effort runtime instrumentation events.
|
||||||
|
type Observer interface {
|
||||||
|
OnReceiveUpdate(ctx context.Context, event UpdateReceivedEvent)
|
||||||
|
OnHandledUpdate(ctx context.Context, event UpdateHandledEvent)
|
||||||
|
OnHandlerStarted(ctx context.Context, event HandlerStartedEvent)
|
||||||
|
OnHandlerFinished(ctx context.Context, event HandlerFinishedEvent)
|
||||||
|
OnSceneTransition(ctx context.Context, event SceneTransitionEvent)
|
||||||
|
OnPolicyChecked(ctx context.Context, event PolicyCheckedEvent)
|
||||||
|
OnRunnerFinished(ctx context.Context, event RunnerFinishedEvent)
|
||||||
|
OnPollingRetry(ctx context.Context, event PollingRetryEvent)
|
||||||
|
OnError(ctx context.Context, event ErrorEvent)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) safeEmitEvent(ctx context.Context, event Event) {
|
||||||
|
if bot.observer == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
defer func() {
|
||||||
|
if r := recover(); r != nil {
|
||||||
|
bot.logger.Errorln(fmt.Sprintf("panic in observer: %v", r))
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
switch e := event.(type) {
|
||||||
|
case UpdateReceivedEvent:
|
||||||
|
bot.observer.OnReceiveUpdate(ctx, e)
|
||||||
|
case UpdateHandledEvent:
|
||||||
|
bot.observer.OnHandledUpdate(ctx, e)
|
||||||
|
case HandlerStartedEvent:
|
||||||
|
bot.observer.OnHandlerStarted(ctx, e)
|
||||||
|
case HandlerFinishedEvent:
|
||||||
|
bot.observer.OnHandlerFinished(ctx, e)
|
||||||
|
case SceneTransitionEvent:
|
||||||
|
bot.observer.OnSceneTransition(ctx, e)
|
||||||
|
case PolicyCheckedEvent:
|
||||||
|
bot.observer.OnPolicyChecked(ctx, e)
|
||||||
|
case RunnerFinishedEvent:
|
||||||
|
bot.observer.OnRunnerFinished(ctx, e)
|
||||||
|
case PollingRetryEvent:
|
||||||
|
bot.observer.OnPollingRetry(ctx, e)
|
||||||
|
case ErrorEvent:
|
||||||
|
bot.observer.OnError(ctx, e)
|
||||||
|
}
|
||||||
|
}
|
||||||
+400
-74
@@ -1,116 +1,442 @@
|
|||||||
package laniakea
|
package laniakea
|
||||||
|
|
||||||
import "log"
|
import (
|
||||||
|
"errors"
|
||||||
|
"regexp"
|
||||||
|
|
||||||
type CommandExecutor func(ctx *MsgContext, dbContext *DatabaseContext)
|
"git.scuroneko.dev/scuroneko/extypes"
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||||
|
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||||
|
)
|
||||||
|
|
||||||
type PluginBuilder struct {
|
// CommandValueType defines the expected type of command argument.
|
||||||
name string
|
type CommandValueType string
|
||||||
commands map[string]*CommandExecutor
|
|
||||||
payloads map[string]*CommandExecutor
|
const (
|
||||||
updateListener *CommandExecutor
|
// CommandValueStringType expects any non-empty string.
|
||||||
|
CommandValueStringType CommandValueType = "string"
|
||||||
|
// CommandValueIntType expects a decimal integer (digits only).
|
||||||
|
CommandValueIntType CommandValueType = "int"
|
||||||
|
// CommandValueBoolType expects a exact "true" or "false".
|
||||||
|
CommandValueBoolType CommandValueType = "bool"
|
||||||
|
// CommandValueAnyType accepts any input without validation.
|
||||||
|
CommandValueAnyType CommandValueType = "any"
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
// CommandRegexInt matches one or more digits.
|
||||||
|
CommandRegexInt = regexp.MustCompile(`^\d+$`)
|
||||||
|
// CommandRegexString matches any non-empty string.
|
||||||
|
CommandRegexString = regexp.MustCompile(`^.+$`)
|
||||||
|
// CommandRegexBool matches true or false.
|
||||||
|
CommandRegexBool = regexp.MustCompile(`^(true|false)$`)
|
||||||
|
)
|
||||||
|
|
||||||
|
// 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")
|
||||||
|
|
||||||
|
var (
|
||||||
|
errCommandNotFound = errors.New("command not found")
|
||||||
|
errPayloadNotFound = errors.New("payload not found")
|
||||||
|
)
|
||||||
|
|
||||||
|
// CommandArg defines a single argument for a command, including type, regex,
|
||||||
|
// and whether it is required.
|
||||||
|
type CommandArg struct {
|
||||||
|
valueType CommandValueType // Type of expected value
|
||||||
|
text string // Human-readable description (not used in validation)
|
||||||
|
regex *regexp.Regexp // Regex used to validate input
|
||||||
|
required bool // Whether this argument must be provided
|
||||||
}
|
}
|
||||||
|
|
||||||
type Plugin struct {
|
// NewCommandArg creates a new CommandArg with the given text and type.
|
||||||
Name string
|
// Uses a default regex based on the type (string or int).
|
||||||
Commands map[string]*CommandExecutor
|
// For CommandValueAnyType, no validation is performed.
|
||||||
Payloads map[string]*CommandExecutor
|
func NewCommandArg(text string) CommandArg {
|
||||||
UpdateListener *CommandExecutor
|
return CommandArg{CommandValueAnyType, text, CommandRegexString, false}
|
||||||
}
|
}
|
||||||
|
|
||||||
func NewPlugin(name string) *PluginBuilder {
|
// SetValueType sets expected value type and switches built-in validation regexp.
|
||||||
return &PluginBuilder{
|
func (c CommandArg) SetValueType(t CommandValueType) CommandArg {
|
||||||
name: name,
|
regex := CommandRegexString
|
||||||
commands: make(map[string]*CommandExecutor),
|
switch t {
|
||||||
payloads: make(map[string]*CommandExecutor),
|
case CommandValueIntType:
|
||||||
|
regex = CommandRegexInt
|
||||||
|
case CommandValueBoolType:
|
||||||
|
regex = CommandRegexBool
|
||||||
|
case CommandValueAnyType:
|
||||||
|
regex = nil // Skip validation
|
||||||
|
}
|
||||||
|
c.valueType = t
|
||||||
|
c.regex = regex
|
||||||
|
return c
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetRequired marks this argument as required.
|
||||||
|
// Returns the receiver for method chaining.
|
||||||
|
func (c CommandArg) SetRequired() CommandArg {
|
||||||
|
c.required = true
|
||||||
|
return c
|
||||||
|
}
|
||||||
|
|
||||||
|
// CommandExecutor is the function type that executes a command.
|
||||||
|
// It receives the message context and injected application data.
|
||||||
|
// Returning a non-nil error routes it through the bot's error handler.
|
||||||
|
type CommandExecutor[T AppData] func(ctx *MsgContext, dbContext T) error
|
||||||
|
|
||||||
|
// 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 AppData] struct {
|
||||||
|
command string // The command trigger (e.g., "/start")
|
||||||
|
description string // Human-readable description for help
|
||||||
|
exec CommandExecutor[T] // Function to execute when command is triggered
|
||||||
|
args extypes.Slice[CommandArg] // List of expected arguments
|
||||||
|
middlewares extypes.Slice[Middleware[T]] // Optional middleware chain
|
||||||
|
skipAutoCmd bool // If true, this command won't be auto-added to help menus
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewCommand creates a new Command with the given executor, command string, and arguments.
|
||||||
|
// The command string should not include the leading slash (e.g., "start", not "/start").
|
||||||
|
func NewCommand[T any](exec CommandExecutor[T], command string, args ...CommandArg) *Command[T] {
|
||||||
|
return &Command[T]{command, "", exec, args, make(extypes.Slice[Middleware[T]], 0), false}
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewPayload creates a new Command with the given executor, command payload string, and arguments.
|
||||||
|
// The command string can contain any symbols, but it is recommended to use only "_", "-", ".", a-z, A-Z, and 0-9.
|
||||||
|
func NewPayload[T any](exec CommandExecutor[T], command string, args ...CommandArg) *Command[T] {
|
||||||
|
return &Command[T]{command, "", exec, args, make(extypes.Slice[Middleware[T]], 0), false}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Use adds a middleware to the command's execution chain.
|
||||||
|
// Middlewares are executed in the order they are added.
|
||||||
|
func (c *Command[T]) Use(m Middleware[T]) *Command[T] {
|
||||||
|
c.middlewares = c.middlewares.Push(m)
|
||||||
|
return c
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetDescription sets the human-readable description of the command.
|
||||||
|
func (c *Command[T]) SetDescription(desc string) *Command[T] {
|
||||||
|
c.description = desc
|
||||||
|
return c
|
||||||
|
}
|
||||||
|
|
||||||
|
// SkipCommandAutoGen marks this command to be excluded from auto-generated help menus.
|
||||||
|
func (c *Command[T]) SkipCommandAutoGen() *Command[T] {
|
||||||
|
c.skipAutoCmd = true
|
||||||
|
return c
|
||||||
|
}
|
||||||
|
|
||||||
|
// Internal helper that validates provided command arguments.
|
||||||
|
func (c *Command[T]) validateArgs(args []string) error {
|
||||||
|
for i := range c.args.Len() {
|
||||||
|
if i >= len(args) && c.args.Get(i).required {
|
||||||
|
return ErrCmdArgCountMismatch
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate each argument against its regex
|
||||||
|
for i, arg := range args {
|
||||||
|
if i >= c.args.Len() {
|
||||||
|
// Extra arguments beyond defined args are ignored
|
||||||
|
break
|
||||||
|
}
|
||||||
|
cmdArg := c.args.Get(i)
|
||||||
|
if cmdArg.regex == nil {
|
||||||
|
continue // Skip validation for CommandValueAnyType
|
||||||
|
}
|
||||||
|
if !cmdArg.regex.MatchString(arg) {
|
||||||
|
return ErrCmdArgRegexpMismatch
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Plugin represents a collection of commands and payloads (e.g., callback handlers),
|
||||||
|
// with shared middleware and configuration.
|
||||||
|
//
|
||||||
|
// A Plugin is intended to be fully configured before it is passed to Bot.AddPlugins.
|
||||||
|
// After registration, treat the plugin as committed and do not mutate it further.
|
||||||
|
// Post-registration changes through the original *Plugin are not a supported API.
|
||||||
|
type Plugin[T AppData] struct {
|
||||||
|
name string // Name of the plugin (e.g., "admin", "user")
|
||||||
|
commands map[string]*Command[T] // Registered commands (triggered by message)
|
||||||
|
payloads map[string]*Command[T] // Registered payloads (triggered by callback data)
|
||||||
|
scenes map[string]*Scene[T] // Optional scenes for multi-step interactions
|
||||||
|
middlewares extypes.Slice[Middleware[T]] // Shared middlewares for all commands/payloads
|
||||||
|
skipAutoCmd bool // If true, all commands in this plugin are excluded from auto-help
|
||||||
|
logger *sneklog.Logger
|
||||||
|
|
||||||
|
messageFallback CommandExecutor[T]
|
||||||
|
handlers map[tgapi.UpdateType]CommandExecutor[T]
|
||||||
|
|
||||||
|
onClose func() error
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewPlugin creates a new Plugin with the given name.
|
||||||
|
func NewPlugin[T AppData](name string) *Plugin[T] {
|
||||||
|
return &Plugin[T]{
|
||||||
|
name: name,
|
||||||
|
commands: make(map[string]*Command[T]),
|
||||||
|
payloads: make(map[string]*Command[T]),
|
||||||
|
middlewares: make(extypes.Slice[Middleware[T]], 0),
|
||||||
|
scenes: make(map[string]*Scene[T]),
|
||||||
|
skipAutoCmd: false,
|
||||||
|
logger: nil,
|
||||||
|
handlers: make(map[tgapi.UpdateType]CommandExecutor[T]),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (p *PluginBuilder) Command(f CommandExecutor, cmd ...string) *PluginBuilder {
|
// AddCommand registers a command in the plugin.
|
||||||
for _, c := range cmd {
|
// The command's .command field is used as the key.
|
||||||
p.commands[c] = &f
|
func (p *Plugin[T]) AddCommand(command *Command[T]) *Plugin[T] {
|
||||||
|
if command == nil {
|
||||||
|
if p.logger != nil {
|
||||||
|
p.logger.Warnln("trying to add nil command")
|
||||||
|
}
|
||||||
|
return p
|
||||||
}
|
}
|
||||||
|
p.commands[command.command] = command
|
||||||
return p
|
return p
|
||||||
}
|
}
|
||||||
|
|
||||||
func (p *PluginBuilder) Payload(f CommandExecutor, payloads ...string) *PluginBuilder {
|
// NewCommand creates and immediately adds a new command to the plugin.
|
||||||
for _, payload := range payloads {
|
// Returns the created command for further configuration.
|
||||||
p.payloads[payload] = &f
|
func (p *Plugin[T]) NewCommand(exec CommandExecutor[T], command string, args ...CommandArg) *Command[T] {
|
||||||
|
cmd := NewCommand(exec, command, args...)
|
||||||
|
p.AddCommand(cmd)
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
// AddPayload registers a payload (e.g., callback query data) in the plugin.
|
||||||
|
// Payloads are triggered by inline button callback_data, not by message text.
|
||||||
|
func (p *Plugin[T]) AddPayload(command *Command[T]) *Plugin[T] {
|
||||||
|
if command == nil {
|
||||||
|
if p.logger != nil {
|
||||||
|
p.logger.Warnln("trying to add nil command")
|
||||||
|
}
|
||||||
|
return p
|
||||||
}
|
}
|
||||||
|
p.payloads[command.command] = command
|
||||||
return p
|
return p
|
||||||
}
|
}
|
||||||
|
|
||||||
func (p *PluginBuilder) UpdateListener(listener CommandExecutor) *PluginBuilder {
|
// NewPayload creates and immediately adds a new payload command to the plugin.
|
||||||
p.updateListener = &listener
|
// Returns the created payload command for further configuration.
|
||||||
|
func (p *Plugin[T]) NewPayload(exec CommandExecutor[T], command string, args ...CommandArg) *Command[T] {
|
||||||
|
cmd := NewPayload(exec, command, args...)
|
||||||
|
p.AddPayload(cmd)
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
// AddScene registers a multi-step scene in the plugin.
|
||||||
|
func (p *Plugin[T]) AddScene(scene *Scene[T]) *Plugin[T] {
|
||||||
|
if scene == nil {
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
scene.PluginName = p.name
|
||||||
|
scene.setPluginName(p.name)
|
||||||
|
p.scenes[scene.Name] = scene
|
||||||
return p
|
return p
|
||||||
}
|
}
|
||||||
|
|
||||||
func (p *PluginBuilder) Build() *Plugin {
|
// NewScene creates, registers, and returns a new scene owned by the plugin.
|
||||||
if len(p.commands) == 0 && len(p.payloads) == 0 {
|
func (p *Plugin[T]) NewScene(name string) *Scene[T] {
|
||||||
log.Println("no command or payloads")
|
scene := NewScene[T](name)
|
||||||
|
scene.setPluginName(p.name)
|
||||||
|
p.AddScene(scene)
|
||||||
|
return scene
|
||||||
|
}
|
||||||
|
|
||||||
|
// UsePolicy registers a Policy as plugin middleware for all plugin handlers.
|
||||||
|
func (p *Plugin[T]) UsePolicy(name string, policy Policy[T]) *Plugin[T] {
|
||||||
|
mw := RequirePolicy(name, policy)
|
||||||
|
return p.AddMiddleware(mw)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AddUpdateHandler registers a handler for a non-command update type.
|
||||||
|
// Message, channel post, and callback query updates stay on the command/payload flow.
|
||||||
|
func (p *Plugin[T]) AddUpdateHandler(t tgapi.UpdateType, handler CommandExecutor[T]) *Plugin[T] {
|
||||||
|
switch t {
|
||||||
|
case tgapi.UpdateTypeMessage, tgapi.UpdateTypeChannelPost, tgapi.UpdateTypeCallbackQuery:
|
||||||
|
if p.logger == nil {
|
||||||
|
logger := utils.CreateLogger(p.name, utils.GetLoggerLevel(), utils.LogFormatText, nil)
|
||||||
|
logger.Warnf("%s can't be registred through AddUpdateHandler. Use AddPayload/NewPayload or AddCommand/NewCommand", t)
|
||||||
|
_ = logger.Close()
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
p.logger.Warnf("%s can't be registred through AddUpdateHandler. Use AddPayload/NewPayload or AddCommand/NewCommand", t)
|
||||||
|
return p
|
||||||
}
|
}
|
||||||
plugin := &Plugin{
|
p.handlers[t] = handler
|
||||||
Name: p.name,
|
return p
|
||||||
Commands: p.commands,
|
}
|
||||||
Payloads: p.payloads,
|
|
||||||
UpdateListener: p.updateListener,
|
// AddMiddleware adds a middleware to the plugin's global middleware chain.
|
||||||
|
// Middlewares are executed before any command or payload.
|
||||||
|
func (p *Plugin[T]) AddMiddleware(middleware Middleware[T]) *Plugin[T] {
|
||||||
|
p.middlewares = p.middlewares.Push(middleware)
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// SkipCommandAutoGen marks the entire plugin to be excluded from auto-generated help menus.
|
||||||
|
func (p *Plugin[T]) SkipCommandAutoGen() *Plugin[T] {
|
||||||
|
p.skipAutoCmd = true
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetLogger sets the logger used for this plugin's handlers.
|
||||||
|
//
|
||||||
|
// Call this before Bot.AddPlugins. If the plugin is already registered, changing
|
||||||
|
// the original *Plugin does not update the Bot's internal copy.
|
||||||
|
func (p *Plugin[T]) SetLogger(l *sneklog.Logger) *Plugin[T] {
|
||||||
|
p.logger = l
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// RemoveLogger clears the custom logger for this plugin.
|
||||||
|
//
|
||||||
|
// Call this before Bot.AddPlugins. If the plugin is already registered, changing
|
||||||
|
// the original *Plugin does not update the Bot's internal copy.
|
||||||
|
func (p *Plugin[T]) RemoveLogger() *Plugin[T] {
|
||||||
|
p.logger = nil
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetOnClose registers a callback invoked from Plugin.Close after the plugin
|
||||||
|
// logger is closed.
|
||||||
|
//
|
||||||
|
// Call this before Bot.AddPlugins. If the plugin is already registered, changing
|
||||||
|
// the original *Plugin does not update the Bot's internal copy.
|
||||||
|
func (p *Plugin[T]) SetOnClose(f func() error) *Plugin[T] {
|
||||||
|
p.onClose = f
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetMessageFallback registers a fallback handler for messages that do not
|
||||||
|
// match a command.
|
||||||
|
func (p *Plugin[T]) SetMessageFallback(handler CommandExecutor[T]) *Plugin[T] {
|
||||||
|
p.messageFallback = handler
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Close releases plugin-owned resources such as its logger and optional
|
||||||
|
// OnClose callback.
|
||||||
|
func (p *Plugin[T]) Close() error {
|
||||||
|
var e []error
|
||||||
|
if p.logger != nil {
|
||||||
|
if err := p.logger.Close(); err != nil {
|
||||||
|
e = append(e, err)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
return plugin
|
if p.onClose != nil {
|
||||||
|
if err := p.onClose(); err != nil {
|
||||||
|
e = append(e, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return errors.Join(e...)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (p *Plugin) Execute(cmd string, ctx *MsgContext, dbContext *DatabaseContext) {
|
// Internal helper that validates and executes a command handler.
|
||||||
(*p.Commands[cmd])(ctx, dbContext)
|
func (p *Plugin[T]) executeCmd(cmd string, ctx *MsgContext, db T) error {
|
||||||
|
command, exists := p.commands[cmd]
|
||||||
|
if !exists {
|
||||||
|
return AsInternalError(errCommandNotFound)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := command.validateArgs(ctx.Args); err != nil {
|
||||||
|
return AsUserError(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run command-specific middlewares
|
||||||
|
for _, m := range command.middlewares {
|
||||||
|
if !m.Execute(ctx, db) {
|
||||||
|
return AsInternalError(errors.New("middleware blocked call"))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Execute command
|
||||||
|
return command.exec(ctx, db)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (p *Plugin) ExecutePayload(payload string, ctx *MsgContext, dbContext *DatabaseContext) {
|
// Internal helper that validates and executes a payload handler.
|
||||||
(*p.Payloads[payload])(ctx, dbContext)
|
func (p *Plugin[T]) executePayload(payload string, ctx *MsgContext, db T) error {
|
||||||
|
command, exists := p.payloads[payload]
|
||||||
|
if !exists {
|
||||||
|
return AsInternalError(errPayloadNotFound)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := command.validateArgs(ctx.Args); err != nil {
|
||||||
|
return AsUserError(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run command-specific middlewares
|
||||||
|
for _, m := range command.middlewares {
|
||||||
|
if !m.Execute(ctx, db) {
|
||||||
|
return AsInternalError(errors.New("middleware blocked call"))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Execute payload
|
||||||
|
return command.exec(ctx, db)
|
||||||
}
|
}
|
||||||
|
|
||||||
type Middleware struct {
|
// Internal helper that runs plugin middlewares in order.
|
||||||
Name string
|
func (p *Plugin[T]) executeMiddlewares(ctx *MsgContext, db T) bool {
|
||||||
Executor *CommandExecutor
|
for _, m := range p.middlewares {
|
||||||
Order int
|
if !m.Execute(ctx, db) {
|
||||||
Async bool
|
return false
|
||||||
}
|
}
|
||||||
type MiddlewareBuilder struct {
|
}
|
||||||
name string
|
return true
|
||||||
executor *CommandExecutor
|
|
||||||
order int
|
|
||||||
async bool
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func NewMiddleware(name string) *MiddlewareBuilder {
|
// MiddlewareExecutor is the function type for middleware logic.
|
||||||
return &MiddlewareBuilder{name: name, async: false}
|
// Returns true to continue execution, false to block it.
|
||||||
|
// If async, return value is ignored.
|
||||||
|
type MiddlewareExecutor[T AppData] func(ctx *MsgContext, db T) bool
|
||||||
|
|
||||||
|
// Middleware represents a reusable execution interceptor.
|
||||||
|
// Can be synchronous (blocking) or asynchronous (non-blocking).
|
||||||
|
type Middleware[T AppData] struct {
|
||||||
|
name string // Human-readable name for logging/debugging
|
||||||
|
executor MiddlewareExecutor[T] // Function to execute
|
||||||
|
order int // Optional sort order (not used yet)
|
||||||
|
async bool // If true, runs in goroutine and doesn't block
|
||||||
}
|
}
|
||||||
func (m *MiddlewareBuilder) SetName(name string) *MiddlewareBuilder {
|
|
||||||
m.name = name
|
// NewMiddleware creates a new synchronous middleware.
|
||||||
return m
|
func NewMiddleware[T AppData](name string, executor MiddlewareExecutor[T]) Middleware[T] {
|
||||||
|
return Middleware[T]{name, executor, 0, false}
|
||||||
}
|
}
|
||||||
func (m *MiddlewareBuilder) SetExecutor(executor CommandExecutor) *MiddlewareBuilder {
|
|
||||||
m.executor = &executor
|
// SetOrder sets the execution order (currently ignored).
|
||||||
return m
|
func (m Middleware[T]) SetOrder(order int) Middleware[T] {
|
||||||
}
|
|
||||||
func (m *MiddlewareBuilder) SetOrder(order int) *MiddlewareBuilder {
|
|
||||||
m.order = order
|
m.order = order
|
||||||
return m
|
return m
|
||||||
}
|
}
|
||||||
func (m *MiddlewareBuilder) SetAsync(async bool) *MiddlewareBuilder {
|
|
||||||
|
// SetAsync marks the middleware to run asynchronously.
|
||||||
|
// Execution continues regardless of its return value.
|
||||||
|
func (m Middleware[T]) SetAsync(async bool) Middleware[T] {
|
||||||
m.async = async
|
m.async = async
|
||||||
return m
|
return m
|
||||||
}
|
}
|
||||||
func (m *MiddlewareBuilder) Build() *Middleware {
|
|
||||||
return &Middleware{
|
// Execute runs the middleware.
|
||||||
Name: m.name,
|
// If async, runs in a goroutine and returns true immediately.
|
||||||
Executor: m.executor,
|
// Otherwise, returns the result of the executor.
|
||||||
Order: m.order,
|
func (m Middleware[T]) Execute(ctx *MsgContext, db T) bool {
|
||||||
Async: m.async,
|
if m.async {
|
||||||
}
|
ctx := *ctx // copy context to avoid race condition
|
||||||
}
|
go func(ctx MsgContext) {
|
||||||
func (m *Middleware) Execute(ctx *MsgContext, db *DatabaseContext) {
|
m.executor(&ctx, db)
|
||||||
exec := *m.Executor
|
}(ctx)
|
||||||
if m.Async {
|
return true
|
||||||
go exec(ctx, db)
|
|
||||||
} else {
|
|
||||||
exec(ctx, db)
|
|
||||||
}
|
}
|
||||||
|
return m.executor(ctx, db)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,40 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestValidateArgsRequiresFullMatch(t *testing.T) {
|
||||||
|
intCmd := NewCommand(func(ctx *MsgContext, db NoData) error { return nil }, "int", NewCommandArg("n").SetValueType(CommandValueIntType).SetRequired())
|
||||||
|
if err := intCmd.validateArgs([]string{"123"}); err != nil {
|
||||||
|
t.Fatalf("expected valid integer argument, got %v", err)
|
||||||
|
}
|
||||||
|
if err := intCmd.validateArgs([]string{"123abc"}); !errors.Is(err, ErrCmdArgRegexpMismatch) {
|
||||||
|
t.Fatalf("expected ErrCmdArgRegexpMismatch for partial int match, got %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
boolCmd := NewCommand(func(ctx *MsgContext, db NoData) error { return nil }, "bool", NewCommandArg("flag").SetValueType(CommandValueBoolType).SetRequired())
|
||||||
|
if err := boolCmd.validateArgs([]string{"false"}); err != nil {
|
||||||
|
t.Fatalf("expected valid bool argument, got %v", err)
|
||||||
|
}
|
||||||
|
if err := boolCmd.validateArgs([]string{"falsey"}); !errors.Is(err, ErrCmdArgRegexpMismatch) {
|
||||||
|
t.Fatalf("expected ErrCmdArgRegexpMismatch for partial bool match, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestValidateArgsEnforcesRequiredArgIndex(t *testing.T) {
|
||||||
|
cmd := NewCommand(
|
||||||
|
func(ctx *MsgContext, db NoData) error { return nil },
|
||||||
|
"mixed",
|
||||||
|
NewCommandArg("optional"),
|
||||||
|
NewCommandArg("required").SetRequired(),
|
||||||
|
)
|
||||||
|
|
||||||
|
if err := cmd.validateArgs([]string{"only-optional"}); !errors.Is(err, ErrCmdArgCountMismatch) {
|
||||||
|
t.Fatalf("expected ErrCmdArgCountMismatch when required second arg is missing, got %v", err)
|
||||||
|
}
|
||||||
|
if err := cmd.validateArgs([]string{"optional", "required"}); err != nil {
|
||||||
|
t.Fatalf("expected both args to validate, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,224 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Policy defines a reusable authorization rule for the current update context.
|
||||||
|
type Policy[T AppData] func(ctx *MsgContext, data T) error
|
||||||
|
|
||||||
|
// RequirePolicy adapts a Policy into a blocking middleware.
|
||||||
|
func RequirePolicy[T AppData](name string, p Policy[T]) Middleware[T] {
|
||||||
|
return NewMiddleware(name, func(ctx *MsgContext, data T) bool {
|
||||||
|
if err := p(ctx, data); err != nil {
|
||||||
|
ctx.emitPolicyChecked(PolicyCheckedEvent{
|
||||||
|
Name: name,
|
||||||
|
FromID: ctx.FromID,
|
||||||
|
ChatID: ctx.ChatID,
|
||||||
|
Passed: false,
|
||||||
|
Err: err,
|
||||||
|
Internal: IsInternalError(err),
|
||||||
|
})
|
||||||
|
ctx.error(err)
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
ctx.emitPolicyChecked(PolicyCheckedEvent{
|
||||||
|
Name: name,
|
||||||
|
FromID: ctx.FromID,
|
||||||
|
ChatID: ctx.ChatID,
|
||||||
|
Passed: true,
|
||||||
|
})
|
||||||
|
return true
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// AllPolicies composes policies that all must succeed.
|
||||||
|
func AllPolicies[T AppData](policies ...Policy[T]) Policy[T] {
|
||||||
|
return func(ctx *MsgContext, data T) error {
|
||||||
|
for _, p := range policies {
|
||||||
|
if err := p(ctx, data); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnyPolicy composes policies where at least one must succeed.
|
||||||
|
func AnyPolicy[T AppData](policies ...Policy[T]) Policy[T] {
|
||||||
|
return func(ctx *MsgContext, data T) error {
|
||||||
|
var firstDeny error
|
||||||
|
var internalErr error
|
||||||
|
for _, p := range policies {
|
||||||
|
err := p(ctx, data)
|
||||||
|
if err == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if IsInternalError(err) {
|
||||||
|
if internalErr == nil {
|
||||||
|
internalErr = err
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if firstDeny == nil {
|
||||||
|
firstDeny = err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if internalErr != nil {
|
||||||
|
return internalErr
|
||||||
|
}
|
||||||
|
if firstDeny != nil {
|
||||||
|
return firstDeny
|
||||||
|
}
|
||||||
|
return AsUserError(errors.New("no policy matched"))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// NotPolicy inverts a policy deny result while preserving internal failures.
|
||||||
|
func NotPolicy[T AppData](policy Policy[T]) Policy[T] {
|
||||||
|
return func(ctx *MsgContext, data T) error {
|
||||||
|
var err error
|
||||||
|
if err = policy(ctx, data); err == nil {
|
||||||
|
return AsUserError(errors.New("the action is not allowed due to policy violation"))
|
||||||
|
}
|
||||||
|
if IsInternalError(err) {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// RequirePrivateChat allows execution only in private chats.
|
||||||
|
func RequirePrivateChat[T AppData]() Policy[T] {
|
||||||
|
return func(ctx *MsgContext, data T) error {
|
||||||
|
if ctx.Msg == nil || ctx.Msg.Chat == nil {
|
||||||
|
return AsInternalError(errors.New("private-chat policy requires message chat context"))
|
||||||
|
}
|
||||||
|
|
||||||
|
if ctx.Msg.Chat.Type != tgapi.ChatTypePrivate {
|
||||||
|
return AsUserError(errors.New("this action is only available in private chat"))
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// RequireGroupChat allows execution only in group or supergroup chats.
|
||||||
|
func RequireGroupChat[T AppData]() Policy[T] {
|
||||||
|
return func(ctx *MsgContext, data T) error {
|
||||||
|
if ctx.Msg == nil || ctx.Msg.Chat == nil {
|
||||||
|
return AsInternalError(errors.New("group-chat policy requires message chat context"))
|
||||||
|
}
|
||||||
|
|
||||||
|
if ctx.Msg.Chat.Type != tgapi.ChatTypeGroup && ctx.Msg.Chat.Type != tgapi.ChatTypeSupergroup {
|
||||||
|
return AsUserError(errors.New("this action is only available in group chats"))
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// RequireSupergroupChat allows execution only in supergroup chats.
|
||||||
|
func RequireSupergroupChat[T AppData]() Policy[T] {
|
||||||
|
return func(ctx *MsgContext, data T) error {
|
||||||
|
if ctx.Msg == nil || ctx.Msg.Chat == nil {
|
||||||
|
return AsInternalError(errors.New("supergroup-chat policy requires message chat context"))
|
||||||
|
}
|
||||||
|
|
||||||
|
if ctx.Msg.Chat.Type != tgapi.ChatTypeSupergroup {
|
||||||
|
return AsUserError(errors.New("this action is only available in supergroup chats"))
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// RequireChatAdmin allows execution only for chat administrators or owners.
|
||||||
|
func RequireChatAdmin[T AppData]() Policy[T] {
|
||||||
|
return func(ctx *MsgContext, data T) error {
|
||||||
|
if ctx.FromID == 0 || ctx.ChatID == 0 {
|
||||||
|
return AsInternalError(errors.New("chat-admin policy requires message chat context"))
|
||||||
|
}
|
||||||
|
|
||||||
|
member, err := ctx.API.GetChatMember(tgapi.GetChatMember{
|
||||||
|
ChatID: ctx.ChatID,
|
||||||
|
UserID: ctx.FromID,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return AsInternalError(fmt.Errorf("failed to fetch chat member status: %w", err))
|
||||||
|
}
|
||||||
|
|
||||||
|
if member.Status != tgapi.ChatMemberStatusAdministrator && member.Status != tgapi.ChatMemberStatusOwner {
|
||||||
|
return AsUserError(errors.New("this action is only available to chat admins"))
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// RequireChatCreator allows execution only for the chat owner.
|
||||||
|
func RequireChatCreator[T AppData]() Policy[T] {
|
||||||
|
return func(ctx *MsgContext, data T) error {
|
||||||
|
if ctx.FromID == 0 || ctx.ChatID == 0 {
|
||||||
|
return AsInternalError(errors.New("chat-creator policy requires message chat context"))
|
||||||
|
}
|
||||||
|
|
||||||
|
member, err := ctx.API.GetChatMember(tgapi.GetChatMember{
|
||||||
|
ChatID: ctx.ChatID,
|
||||||
|
UserID: ctx.FromID,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return AsInternalError(fmt.Errorf("failed to fetch chat creator: %w", err))
|
||||||
|
}
|
||||||
|
|
||||||
|
if member.Status != tgapi.ChatMemberStatusOwner {
|
||||||
|
return AsUserError(errors.New("this action is only available to the chat creator"))
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// RequireBotAdmin allows execution only when the bot is an admin in the chat.
|
||||||
|
func RequireBotAdmin[T AppData]() Policy[T] {
|
||||||
|
return func(ctx *MsgContext, data T) error {
|
||||||
|
if ctx.ChatID == 0 {
|
||||||
|
return AsInternalError(errors.New("bot-admin policy requires message chat context"))
|
||||||
|
}
|
||||||
|
|
||||||
|
bot, err := ctx.API.GetMe()
|
||||||
|
if err != nil {
|
||||||
|
return AsInternalError(fmt.Errorf("failed to fetch bot info: %w", err))
|
||||||
|
}
|
||||||
|
|
||||||
|
member, err := ctx.API.GetChatMember(tgapi.GetChatMember{
|
||||||
|
ChatID: ctx.ChatID,
|
||||||
|
UserID: bot.ID,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return AsInternalError(fmt.Errorf("failed to fetch bot member status: %w", err))
|
||||||
|
}
|
||||||
|
|
||||||
|
if member.Status != tgapi.ChatMemberStatusAdministrator && member.Status != tgapi.ChatMemberStatusOwner {
|
||||||
|
return AsUserError(errors.New("this action requires the bot to be an admin in the chat"))
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// RequireCallbackFromUser allows execution only for callback queries sent by non-bot users.
|
||||||
|
func RequireCallbackFromUser[T AppData]() Policy[T] {
|
||||||
|
return func(ctx *MsgContext, data T) error {
|
||||||
|
if ctx.Update.CallbackQuery == nil {
|
||||||
|
return AsInternalError(errors.New("callback-user policy requires callback query context"))
|
||||||
|
}
|
||||||
|
if ctx.Update.CallbackQuery.From.IsBot {
|
||||||
|
return AsUserError(errors.New("this action is only available to human users"))
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
+281
@@ -0,0 +1,281 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
|
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestRequirePolicyStopsExecutionOnDeniedPolicy(t *testing.T) {
|
||||||
|
var requests int
|
||||||
|
var gotBody map[string]any
|
||||||
|
|
||||||
|
client := &http.Client{
|
||||||
|
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
requests++
|
||||||
|
body, err := io.ReadAll(req.Body)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to read request body: %v", err)
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(body, &gotBody); err != nil {
|
||||||
|
t.Fatalf("failed to decode request body: %v", err)
|
||||||
|
}
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||||
|
Body: io.NopCloser(strings.NewReader(`{"ok":true,"result":{"message_id":9,"date":1}}`)),
|
||||||
|
}, nil
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
|
||||||
|
api := tgapi.NewAPI(
|
||||||
|
tgapi.NewAPIOpts("token").
|
||||||
|
SetAPIURL("https://example.test").
|
||||||
|
SetHTTPClient(client),
|
||||||
|
)
|
||||||
|
defer func() {
|
||||||
|
if err := api.Close(); err != nil {
|
||||||
|
t.Fatalf("Close returned error: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
ctx := &MsgContext{
|
||||||
|
API: api,
|
||||||
|
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate}},
|
||||||
|
Logger: sneklog.NewLogger(),
|
||||||
|
errorTemplate: "Error: %s",
|
||||||
|
}
|
||||||
|
|
||||||
|
mw := RequirePolicy("deny", func(ctx *MsgContext, data NoData) error {
|
||||||
|
return AsUserError(errors.New("blocked"))
|
||||||
|
})
|
||||||
|
|
||||||
|
if mw.Execute(ctx, NoData{}) {
|
||||||
|
t.Fatal("expected denied policy middleware to stop execution")
|
||||||
|
}
|
||||||
|
if requests != 1 {
|
||||||
|
t.Fatalf("expected one user-facing error reply, got %d requests", requests)
|
||||||
|
}
|
||||||
|
if got := gotBody["text"]; got != "Error: blocked" {
|
||||||
|
t.Fatalf("unexpected policy error reply text: %v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRequirePrivateChatAllowsPrivateChat(t *testing.T) {
|
||||||
|
ctx := &MsgContext{
|
||||||
|
Msg: &tgapi.Message{
|
||||||
|
Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate},
|
||||||
|
},
|
||||||
|
Logger: sneklog.NewLogger(),
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := RequirePrivateChat[NoData]()(ctx, NoData{}); err != nil {
|
||||||
|
t.Fatalf("RequirePrivateChat returned error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRequirePrivateChatDeniesNonPrivateChat(t *testing.T) {
|
||||||
|
ctx := &MsgContext{
|
||||||
|
Msg: &tgapi.Message{
|
||||||
|
Chat: &tgapi.Chat{ID: -100, Type: tgapi.ChatTypeSupergroup},
|
||||||
|
},
|
||||||
|
Logger: sneklog.NewLogger(),
|
||||||
|
}
|
||||||
|
|
||||||
|
err := RequirePrivateChat[NoData]()(ctx, NoData{})
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected RequirePrivateChat to deny non-private chats")
|
||||||
|
}
|
||||||
|
if !IsUserError(err) {
|
||||||
|
t.Fatalf("expected user-visible deny error, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRequireChatAdminUsesNormalizedIDs(t *testing.T) {
|
||||||
|
var sawGetChatMember bool
|
||||||
|
var gotBody map[string]any
|
||||||
|
|
||||||
|
client := &http.Client{
|
||||||
|
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
if !strings.Contains(req.URL.Path, "getChatMember") {
|
||||||
|
t.Fatalf("unexpected API method: %s", req.URL.Path)
|
||||||
|
}
|
||||||
|
sawGetChatMember = true
|
||||||
|
body, err := io.ReadAll(req.Body)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to read request body: %v", err)
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(body, &gotBody); err != nil {
|
||||||
|
t.Fatalf("failed to decode request body: %v", err)
|
||||||
|
}
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||||
|
Body: io.NopCloser(strings.NewReader(
|
||||||
|
`{"ok":true,"result":{"status":"administrator","user":{"id":55,"is_bot":false,"first_name":"tester"}}}`,
|
||||||
|
)),
|
||||||
|
}, nil
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
|
||||||
|
api := tgapi.NewAPI(
|
||||||
|
tgapi.NewAPIOpts("token").
|
||||||
|
SetAPIURL("https://example.test").
|
||||||
|
SetHTTPClient(client),
|
||||||
|
)
|
||||||
|
defer func() {
|
||||||
|
if err := api.Close(); err != nil {
|
||||||
|
t.Fatalf("Close returned error: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
ctx := &MsgContext{
|
||||||
|
API: api,
|
||||||
|
ChatID: -2001,
|
||||||
|
FromID: 55,
|
||||||
|
Logger: sneklog.NewLogger(),
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := RequireChatAdmin[NoData]()(ctx, NoData{}); err != nil {
|
||||||
|
t.Fatalf("RequireChatAdmin returned error: %v", err)
|
||||||
|
}
|
||||||
|
if !sawGetChatMember {
|
||||||
|
t.Fatal("expected GetChatMember to be called")
|
||||||
|
}
|
||||||
|
if got := gotBody["chat_id"]; got != float64(-2001) {
|
||||||
|
t.Fatalf("unexpected chat_id in request: %v", got)
|
||||||
|
}
|
||||||
|
if got := gotBody["user_id"]; got != float64(55) {
|
||||||
|
t.Fatalf("unexpected user_id in request: %v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAllPoliciesReturnsFirstError(t *testing.T) {
|
||||||
|
want := AsUserError(errors.New("blocked"))
|
||||||
|
policy := AllPolicies(
|
||||||
|
func(ctx *MsgContext, data NoData) error { return nil },
|
||||||
|
func(ctx *MsgContext, data NoData) error { return want },
|
||||||
|
func(ctx *MsgContext, data NoData) error {
|
||||||
|
t.Fatal("unexpected evaluation after first failure")
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
err := policy(&MsgContext{Logger: sneklog.NewLogger()}, NoData{})
|
||||||
|
if !errors.Is(err, want) {
|
||||||
|
t.Fatalf("expected first policy error, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAnyPolicyAllowsLaterSuccessAfterInternalError(t *testing.T) {
|
||||||
|
policy := AnyPolicy(
|
||||||
|
func(ctx *MsgContext, data NoData) error { return AsInternalError(errors.New("temporary")) },
|
||||||
|
func(ctx *MsgContext, data NoData) error { return nil },
|
||||||
|
)
|
||||||
|
|
||||||
|
if err := policy(&MsgContext{Logger: sneklog.NewLogger()}, NoData{}); err != nil {
|
||||||
|
t.Fatalf("expected later success to allow access, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAnyPolicyReturnsInternalErrorWhenNonePass(t *testing.T) {
|
||||||
|
internal := AsInternalError(errors.New("temporary"))
|
||||||
|
policy := AnyPolicy(
|
||||||
|
func(ctx *MsgContext, data NoData) error { return AsUserError(errors.New("denied")) },
|
||||||
|
func(ctx *MsgContext, data NoData) error { return internal },
|
||||||
|
)
|
||||||
|
|
||||||
|
err := policy(&MsgContext{Logger: sneklog.NewLogger()}, NoData{})
|
||||||
|
if !errors.Is(err, internal) {
|
||||||
|
t.Fatalf("expected internal error, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAnyPolicyReturnsFirstDenyWhenNoPolicyPasses(t *testing.T) {
|
||||||
|
first := AsUserError(errors.New("first deny"))
|
||||||
|
policy := AnyPolicy(
|
||||||
|
func(ctx *MsgContext, data NoData) error { return first },
|
||||||
|
func(ctx *MsgContext, data NoData) error { return AsUserError(errors.New("second deny")) },
|
||||||
|
)
|
||||||
|
|
||||||
|
err := policy(&MsgContext{Logger: sneklog.NewLogger()}, NoData{})
|
||||||
|
if !errors.Is(err, first) {
|
||||||
|
t.Fatalf("expected first deny error, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNotPolicyInvertsUserDenyButPreservesInternalErrors(t *testing.T) {
|
||||||
|
inverted := NotPolicy(func(ctx *MsgContext, data NoData) error {
|
||||||
|
return AsUserError(errors.New("denied"))
|
||||||
|
})
|
||||||
|
if err := inverted(&MsgContext{Logger: sneklog.NewLogger()}, NoData{}); err != nil {
|
||||||
|
t.Fatalf("expected inverted deny to succeed, got %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
internal := AsInternalError(errors.New("temporary"))
|
||||||
|
preserve := NotPolicy(func(ctx *MsgContext, data NoData) error {
|
||||||
|
return internal
|
||||||
|
})
|
||||||
|
err := preserve(&MsgContext{Logger: sneklog.NewLogger()}, NoData{})
|
||||||
|
if !errors.Is(err, internal) {
|
||||||
|
t.Fatalf("expected internal error to be preserved, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRequirePolicyEmitsObserverEvents(t *testing.T) {
|
||||||
|
t.Run("allow", func(t *testing.T) {
|
||||||
|
observer := &recordingObserver{}
|
||||||
|
ctx := &MsgContext{
|
||||||
|
Logger: sneklog.NewLogger(),
|
||||||
|
ctx: context.Background(),
|
||||||
|
observer: observer,
|
||||||
|
FromID: 10,
|
||||||
|
ChatID: 20,
|
||||||
|
}
|
||||||
|
|
||||||
|
mw := RequirePolicy("allow", func(ctx *MsgContext, data NoData) error {
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
|
||||||
|
if !mw.Execute(ctx, NoData{}) {
|
||||||
|
t.Fatal("expected allowed policy middleware to continue execution")
|
||||||
|
}
|
||||||
|
if len(observer.policies) != 1 {
|
||||||
|
t.Fatalf("expected one policy event, got %d", len(observer.policies))
|
||||||
|
}
|
||||||
|
if got := observer.policies[0]; got.Name != "allow" || !got.Passed || got.Err != nil || got.Internal {
|
||||||
|
t.Fatalf("unexpected policy event: %#v", got)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("deny", func(t *testing.T) {
|
||||||
|
observer := &recordingObserver{}
|
||||||
|
ctx := &MsgContext{
|
||||||
|
Logger: sneklog.NewLogger(),
|
||||||
|
ctx: context.Background(),
|
||||||
|
observer: observer,
|
||||||
|
errorTemplate: "%s",
|
||||||
|
}
|
||||||
|
|
||||||
|
mw := RequirePolicy("deny", func(ctx *MsgContext, data NoData) error {
|
||||||
|
return AsInternalError(errors.New("blocked"))
|
||||||
|
})
|
||||||
|
|
||||||
|
if mw.Execute(ctx, NoData{}) {
|
||||||
|
t.Fatal("expected denied policy middleware to stop execution")
|
||||||
|
}
|
||||||
|
if len(observer.policies) != 1 {
|
||||||
|
t.Fatalf("expected one policy event, got %d", len(observer.policies))
|
||||||
|
}
|
||||||
|
if got := observer.policies[0]; got.Name != "deny" || got.Passed || got.Err == nil || !got.Internal {
|
||||||
|
t.Fatalf("unexpected policy event: %#v", got)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
@@ -1,71 +0,0 @@
|
|||||||
package laniakea
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"sync"
|
|
||||||
)
|
|
||||||
|
|
||||||
var QueueFullErr = errors.New("queue is full")
|
|
||||||
|
|
||||||
type Queue[T any] struct {
|
|
||||||
size uint64
|
|
||||||
mu sync.RWMutex
|
|
||||||
queue []T
|
|
||||||
}
|
|
||||||
|
|
||||||
func CreateQueue[T any](size uint64) *Queue[T] {
|
|
||||||
return &Queue[T]{
|
|
||||||
queue: make([]T, 0),
|
|
||||||
size: size,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (q *Queue[T]) Enqueue(el T) error {
|
|
||||||
if q.IsFull() {
|
|
||||||
return QueueFullErr
|
|
||||||
}
|
|
||||||
q.queue = append(q.queue, el)
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (q *Queue[T]) Peak() T {
|
|
||||||
q.mu.RLock()
|
|
||||||
defer q.mu.RUnlock()
|
|
||||||
return q.queue[0]
|
|
||||||
}
|
|
||||||
|
|
||||||
func (q *Queue[T]) IsEmpty() bool {
|
|
||||||
return q.Length() == 0
|
|
||||||
}
|
|
||||||
|
|
||||||
func (q *Queue[T]) IsFull() bool {
|
|
||||||
return q.Length() == q.size
|
|
||||||
}
|
|
||||||
|
|
||||||
func (q *Queue[T]) Length() uint64 {
|
|
||||||
q.mu.RLock()
|
|
||||||
defer q.mu.RUnlock()
|
|
||||||
return uint64(len(q.queue))
|
|
||||||
}
|
|
||||||
|
|
||||||
func (q *Queue[T]) Dequeue() T {
|
|
||||||
q.mu.RLock()
|
|
||||||
el := q.queue[0]
|
|
||||||
q.mu.RUnlock()
|
|
||||||
|
|
||||||
if q.Length() == 1 {
|
|
||||||
q.mu.Lock()
|
|
||||||
q.queue = make([]T, 0)
|
|
||||||
q.mu.Unlock()
|
|
||||||
return el
|
|
||||||
}
|
|
||||||
|
|
||||||
q.mu.Lock()
|
|
||||||
q.queue = q.queue[1:]
|
|
||||||
q.mu.Unlock()
|
|
||||||
return el
|
|
||||||
}
|
|
||||||
|
|
||||||
func (q *Queue[T]) Raw() []T {
|
|
||||||
return q.queue
|
|
||||||
}
|
|
||||||
+187
@@ -0,0 +1,187 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"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 AppData] 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 AppData] struct {
|
||||||
|
name string // Human-readable name for logging
|
||||||
|
onetime bool // If true, runs once; if false, runs periodically
|
||||||
|
async bool // If true, runs in a goroutine; else, runs synchronously
|
||||||
|
timeout time.Duration // Duration to wait between periodic executions (ignored if onetime=true)
|
||||||
|
fn RunnerFn[T] // The function to execute
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewRunner creates a new Runner with the given name and function.
|
||||||
|
// By default, the Runner is configured as async=true (non-blocking).
|
||||||
|
//
|
||||||
|
// Builder methods (Onetime, Async, Timeout) can be chained to customize behavior.
|
||||||
|
// DO NOT call builder methods concurrently or after Execute().
|
||||||
|
func NewRunner[T AppData](name string, fn RunnerFn[T]) Runner[T] {
|
||||||
|
return Runner[T]{
|
||||||
|
name: name,
|
||||||
|
fn: fn,
|
||||||
|
async: true, // Default: run asynchronously
|
||||||
|
timeout: 0, // Default: no timeout (ignored if onetime=true)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Onetime sets whether the runner executes once or repeatedly.
|
||||||
|
// If true, the runner runs only once.
|
||||||
|
// If false, the runner runs in a loop with the configured timeout.
|
||||||
|
func (r Runner[T]) Onetime(onetime bool) Runner[T] {
|
||||||
|
r.onetime = onetime
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
|
||||||
|
// Async sets whether the runner executes synchronously or asynchronously.
|
||||||
|
// If true, the runner runs in a goroutine (non-blocking).
|
||||||
|
// If false, the runner blocks the caller during execution.
|
||||||
|
//
|
||||||
|
// Note: If onetime=false and async=false, the runner will be skipped with a warning.
|
||||||
|
func (r Runner[T]) Async(async bool) Runner[T] {
|
||||||
|
r.async = async
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
|
||||||
|
// Timeout sets the duration to wait between repeated executions for
|
||||||
|
// non-onetime runners.
|
||||||
|
//
|
||||||
|
// If onetime=true, this value is ignored.
|
||||||
|
// If onetime=false and async=true, this timeout determines the sleep interval
|
||||||
|
// between loop iterations.
|
||||||
|
//
|
||||||
|
// A zero value (time.Duration(0)) is allowed but may trigger a warning
|
||||||
|
// if used with a background (non-onetime) async runner.
|
||||||
|
func (r Runner[T]) Timeout(timeout time.Duration) Runner[T] {
|
||||||
|
r.timeout = timeout
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExecRunners executes all runners registered on the Bot with context-based lifecycle management.
|
||||||
|
//
|
||||||
|
// 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 a loop with timeout between iterations until ctx.Done().
|
||||||
|
// - !onetime + sync: Skipped with warning.
|
||||||
|
//
|
||||||
|
// Background runners listen for ctx.Done() and gracefully shut down when the context is canceled.
|
||||||
|
//
|
||||||
|
// This method is typically called once during bot startup from RunWithContext or
|
||||||
|
// RunWebHookWithContext.
|
||||||
|
func (bot *Bot[T]) ExecRunners(ctx context.Context) {
|
||||||
|
bot.logger.Infoln("Executing runners...")
|
||||||
|
for _, runner := range bot.runners {
|
||||||
|
// Validate configuration
|
||||||
|
if !runner.onetime && !runner.async {
|
||||||
|
bot.logger.Warnf("Runner %s not onetime, but sync — skipping\n", runner.name)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if !runner.onetime && runner.async && runner.timeout == 0 {
|
||||||
|
bot.logger.Warnf("Background runner \"%s\" has no timeout — skipping\n", runner.name)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if runner.onetime && runner.async {
|
||||||
|
// One-time async: fire and forget
|
||||||
|
bot.runnerOnceWG.Add(1)
|
||||||
|
go func(r Runner[T]) {
|
||||||
|
defer bot.runnerOnceWG.Done()
|
||||||
|
startedAt := time.Now()
|
||||||
|
err := r.fn(bot)
|
||||||
|
bot.safeEmitEvent(ctx, RunnerFinishedEvent{
|
||||||
|
Name: r.name,
|
||||||
|
Duration: time.Since(startedAt),
|
||||||
|
Err: err,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
bot.safeEmitEvent(ctx, ErrorEvent{
|
||||||
|
Plugin: "bot",
|
||||||
|
HandlerKind: HandlerRunnerKind,
|
||||||
|
HandlerName: r.name,
|
||||||
|
Err: err,
|
||||||
|
UserFacing: false,
|
||||||
|
})
|
||||||
|
bot.logger.Warnf("Runner %s failed: %s\n", r.name, err)
|
||||||
|
}
|
||||||
|
}(runner)
|
||||||
|
} else if runner.onetime && !runner.async {
|
||||||
|
// One-time sync: block until done
|
||||||
|
t := time.Now()
|
||||||
|
err := runner.fn(bot)
|
||||||
|
elapsed := time.Since(t)
|
||||||
|
bot.safeEmitEvent(ctx, RunnerFinishedEvent{
|
||||||
|
Name: runner.name,
|
||||||
|
Duration: elapsed,
|
||||||
|
Err: err,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
bot.safeEmitEvent(ctx, ErrorEvent{
|
||||||
|
Plugin: "bot",
|
||||||
|
HandlerKind: HandlerRunnerKind,
|
||||||
|
HandlerName: runner.name,
|
||||||
|
Err: err,
|
||||||
|
UserFacing: false,
|
||||||
|
})
|
||||||
|
bot.logger.Warnf("Runner %s failed: %s\n", runner.name, err)
|
||||||
|
}
|
||||||
|
if elapsed > time.Second*2 {
|
||||||
|
bot.logger.Warnf("Runner %s too slow. Elapsed time %v >= 2s\n", runner.name, elapsed)
|
||||||
|
}
|
||||||
|
} else if !runner.onetime && runner.async {
|
||||||
|
// Background loop: periodic execution with graceful shutdown
|
||||||
|
bot.runnerBgWG.Add(1)
|
||||||
|
go func(r Runner[T]) {
|
||||||
|
defer bot.runnerBgWG.Done()
|
||||||
|
ticker := time.NewTicker(r.timeout)
|
||||||
|
defer ticker.Stop()
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return
|
||||||
|
case <-ticker.C:
|
||||||
|
startedAt := time.Now()
|
||||||
|
err := r.fn(bot)
|
||||||
|
bot.safeEmitEvent(ctx, RunnerFinishedEvent{
|
||||||
|
Name: r.name,
|
||||||
|
Duration: time.Since(startedAt),
|
||||||
|
Err: err,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
bot.safeEmitEvent(ctx, ErrorEvent{
|
||||||
|
Plugin: "bot",
|
||||||
|
HandlerKind: HandlerRunnerKind,
|
||||||
|
HandlerName: r.name,
|
||||||
|
Err: err,
|
||||||
|
UserFacing: false,
|
||||||
|
})
|
||||||
|
bot.logger.Warnf("Runner %s failed: %s\n", r.name, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}(runner)
|
||||||
|
}
|
||||||
|
// Note: !onetime && !async is already skipped above
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,97 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"sync/atomic"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||||
|
)
|
||||||
|
|
||||||
|
type runnerObserver struct {
|
||||||
|
recordingObserver
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestExecRunnersRunsOnetimeSyncRunner(t *testing.T) {
|
||||||
|
var calls atomic.Int32
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
runners: []Runner[NoData]{
|
||||||
|
NewRunner("sync-once", func(*Bot[NoData]) error {
|
||||||
|
calls.Add(1)
|
||||||
|
return nil
|
||||||
|
}).Onetime(true).Async(false),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
bot.ExecRunners(context.Background())
|
||||||
|
|
||||||
|
if got := calls.Load(); got != 1 {
|
||||||
|
t.Fatalf("unexpected sync runner call count: %d", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestExecRunnersStopsBackgroundRunnerOnCancel(t *testing.T) {
|
||||||
|
var calls atomic.Int32
|
||||||
|
triggered := make(chan struct{}, 1)
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
runners: []Runner[NoData]{
|
||||||
|
NewRunner("background", func(*Bot[NoData]) error {
|
||||||
|
if calls.Add(1) == 1 {
|
||||||
|
triggered <- struct{}{}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}).Timeout(5 * time.Millisecond),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
bot.ExecRunners(ctx)
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-triggered:
|
||||||
|
case <-time.After(time.Second):
|
||||||
|
t.Fatal("background runner did not execute")
|
||||||
|
}
|
||||||
|
|
||||||
|
cancel()
|
||||||
|
bot.runnerBgWG.Wait()
|
||||||
|
|
||||||
|
if calls.Load() == 0 {
|
||||||
|
t.Fatal("expected background runner to be called at least once")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestExecRunnersEmitObserverEvents(t *testing.T) {
|
||||||
|
observer := &runnerObserver{}
|
||||||
|
wantErr := errors.New("runner failed")
|
||||||
|
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
observer: observer,
|
||||||
|
runners: []Runner[NoData]{
|
||||||
|
NewRunner("sync-once", func(*Bot[NoData]) error {
|
||||||
|
return wantErr
|
||||||
|
}).Onetime(true).Async(false),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
bot.ExecRunners(context.Background())
|
||||||
|
|
||||||
|
if len(observer.runners) != 1 {
|
||||||
|
t.Fatalf("expected one runner-finished event, got %d", len(observer.runners))
|
||||||
|
}
|
||||||
|
if got := observer.runners[0]; got.Name != "sync-once" || !errors.Is(got.Err, wantErr) {
|
||||||
|
t.Fatalf("unexpected runner-finished event: %#v", got)
|
||||||
|
}
|
||||||
|
if len(observer.errors) != 1 {
|
||||||
|
t.Fatalf("expected one error event, got %d", len(observer.errors))
|
||||||
|
}
|
||||||
|
if got := observer.errors[0]; got.HandlerKind != HandlerRunnerKind || got.HandlerName != "sync-once" || !errors.Is(got.Err, wantErr) {
|
||||||
|
t.Fatalf("unexpected runner error event: %#v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,254 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"sync"
|
||||||
|
)
|
||||||
|
|
||||||
|
// SceneHandler handles a scene step, scene command, or fallback message.
|
||||||
|
type SceneHandler[T any] func(ctx *SceneContext, db T) (SceneResult, error)
|
||||||
|
|
||||||
|
// Scene defines a multi-step conversational flow.
|
||||||
|
type Scene[T any] struct {
|
||||||
|
// Name identifies the scene in plugin registration and session state.
|
||||||
|
Name string
|
||||||
|
// Scope controls how active scene sessions are keyed and shared.
|
||||||
|
Scope SceneScope
|
||||||
|
// Entry names the first step used by MsgContext.EnterScene.
|
||||||
|
Entry string
|
||||||
|
// PluginName stores the owning plugin name for scene resolution.
|
||||||
|
PluginName string
|
||||||
|
|
||||||
|
steps map[string]SceneHandler[T]
|
||||||
|
commands map[string]SceneHandler[T]
|
||||||
|
payloads map[string]SceneHandler[T]
|
||||||
|
message SceneHandler[T]
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewScene creates a new scene with user-chat scope by default.
|
||||||
|
func NewScene[T any](name string) *Scene[T] {
|
||||||
|
return &Scene[T]{
|
||||||
|
Name: name,
|
||||||
|
Scope: SceneScopeUserChat,
|
||||||
|
Entry: "",
|
||||||
|
steps: make(map[string]SceneHandler[T]),
|
||||||
|
commands: make(map[string]SceneHandler[T]),
|
||||||
|
payloads: make(map[string]SceneHandler[T]),
|
||||||
|
message: nil,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetScope changes how scene sessions are keyed and shared.
|
||||||
|
func (s *Scene[T]) SetScope(scope SceneScope) *Scene[T] {
|
||||||
|
s.Scope = scope
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetEntry sets the initial step entered by MsgContext.EnterScene.
|
||||||
|
func (s *Scene[T]) SetEntry(step string) *Scene[T] {
|
||||||
|
s.Entry = step
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Scene[T]) setPluginName(name string) *Scene[T] {
|
||||||
|
s.PluginName = name
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
// OnStep registers a handler for a named scene step.
|
||||||
|
func (s *Scene[T]) OnStep(step string, handler SceneHandler[T]) *Scene[T] {
|
||||||
|
s.steps[step] = handler
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
// OnCommand registers a command handler active while the scene is running.
|
||||||
|
func (s *Scene[T]) OnCommand(cmd string, handler SceneHandler[T]) *Scene[T] {
|
||||||
|
s.commands[cmd] = handler
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
// OnPayload registers a callback payload handler active while the scene is running.
|
||||||
|
func (s *Scene[T]) OnPayload(cmd string, handler SceneHandler[T]) *Scene[T] {
|
||||||
|
s.payloads[cmd] = handler
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
// OnMessage registers a fallback handler used when no scene command or step matches.
|
||||||
|
func (s *Scene[T]) OnMessage(handler SceneHandler[T]) *Scene[T] {
|
||||||
|
s.message = handler
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Scene[T]) executeCommand(cmd string, ctx *SceneContext, db T) (SceneResult, bool, error) {
|
||||||
|
handler, ok := s.commands[cmd]
|
||||||
|
if !ok {
|
||||||
|
return SceneResult{}, false, nil
|
||||||
|
}
|
||||||
|
result, err := handler(ctx, db)
|
||||||
|
return result, true, err
|
||||||
|
}
|
||||||
|
func (s *Scene[T]) executePayload(cmd string, ctx *SceneContext, db T) (SceneResult, bool, error) {
|
||||||
|
handler, ok := s.payloads[cmd]
|
||||||
|
if !ok {
|
||||||
|
return SceneResult{}, false, nil
|
||||||
|
}
|
||||||
|
result, err := handler(ctx, db)
|
||||||
|
return result, true, err
|
||||||
|
}
|
||||||
|
func (s *Scene[T]) executeStep(step string, ctx *SceneContext, db T) (SceneResult, bool, error) {
|
||||||
|
handler, ok := s.steps[step]
|
||||||
|
if !ok {
|
||||||
|
return SceneResult{}, false, nil
|
||||||
|
}
|
||||||
|
result, err := handler(ctx, db)
|
||||||
|
return result, true, err
|
||||||
|
}
|
||||||
|
func (s *Scene[T]) executeMessage(ctx *SceneContext, db T) (SceneResult, bool, error) {
|
||||||
|
if s.message == nil {
|
||||||
|
return SceneResult{}, false, nil
|
||||||
|
}
|
||||||
|
result, err := s.message(ctx, db)
|
||||||
|
return result, true, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// SceneSession stores the active scene state for one session key.
|
||||||
|
type SceneSession struct {
|
||||||
|
// Scene is the registered scene name for the active session.
|
||||||
|
Scene string
|
||||||
|
// Step is the current step name inside the active scene.
|
||||||
|
Step string
|
||||||
|
// Data stores opaque session payload bytes, typically JSON.
|
||||||
|
Data []byte
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetData stores arbitrary opaque session data.
|
||||||
|
func (s *SceneSession) SetData(data []byte) {
|
||||||
|
s.Data = data
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetData returns the raw session data payload.
|
||||||
|
func (s *SceneSession) GetData() []byte {
|
||||||
|
return s.Data
|
||||||
|
}
|
||||||
|
|
||||||
|
// HasData reports whether the session has a non-empty data payload.
|
||||||
|
func (s *SceneSession) HasData() bool {
|
||||||
|
return len(s.Data) > 0
|
||||||
|
}
|
||||||
|
|
||||||
|
// ClearData removes any stored session data.
|
||||||
|
func (s *SceneSession) ClearData() {
|
||||||
|
s.Data = nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// BindData unmarshals the stored JSON payload into v.
|
||||||
|
func (s *SceneSession) BindData(v any) error {
|
||||||
|
if len(s.Data) == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return json.Unmarshal(s.Data, v)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SaveData marshals v as JSON and stores it in the session.
|
||||||
|
func (s *SceneSession) SaveData(v any) error {
|
||||||
|
data, err := json.Marshal(v)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
s.Data = data
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SessionStore persists scene sessions by key.
|
||||||
|
type SessionStore interface {
|
||||||
|
Get(key string) (SceneSession, error)
|
||||||
|
Set(key string, session SceneSession) error
|
||||||
|
Delete(key string) error
|
||||||
|
}
|
||||||
|
|
||||||
|
// MemorySessionStore stores scene sessions in memory.
|
||||||
|
type MemorySessionStore struct {
|
||||||
|
store map[string]SceneSession
|
||||||
|
mu sync.RWMutex
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewMemorySessionStore creates an empty in-memory session store.
|
||||||
|
func NewMemorySessionStore() *MemorySessionStore {
|
||||||
|
return &MemorySessionStore{
|
||||||
|
store: make(map[string]SceneSession),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get returns the session stored under key, or the zero session when absent.
|
||||||
|
func (s *MemorySessionStore) Get(key string) (SceneSession, error) {
|
||||||
|
s.mu.RLock()
|
||||||
|
defer s.mu.RUnlock()
|
||||||
|
if session, ok := s.store[key]; ok {
|
||||||
|
return session, nil
|
||||||
|
}
|
||||||
|
return SceneSession{}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set stores session under key.
|
||||||
|
func (s *MemorySessionStore) Set(key string, session SceneSession) error {
|
||||||
|
s.mu.Lock()
|
||||||
|
s.store[key] = session
|
||||||
|
s.mu.Unlock()
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Delete removes the session stored under key.
|
||||||
|
func (s *MemorySessionStore) Delete(key string) error {
|
||||||
|
s.mu.Lock()
|
||||||
|
delete(s.store, key)
|
||||||
|
s.mu.Unlock()
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SceneResult describes how scene execution should proceed after a handler returns.
|
||||||
|
type SceneResult struct {
|
||||||
|
Action SceneAction
|
||||||
|
Next string
|
||||||
|
}
|
||||||
|
|
||||||
|
// SceneAction controls how the bot updates scene state after a handler returns.
|
||||||
|
type SceneAction int
|
||||||
|
|
||||||
|
const (
|
||||||
|
// SceneActionStay keeps the current scene and step active.
|
||||||
|
SceneActionStay SceneAction = iota
|
||||||
|
// SceneActionNext moves the session to another named step.
|
||||||
|
SceneActionNext
|
||||||
|
// SceneActionExit removes the current scene session.
|
||||||
|
SceneActionExit
|
||||||
|
// SceneActionPass lets normal bot routing continue after the scene handler.
|
||||||
|
SceneActionPass
|
||||||
|
)
|
||||||
|
|
||||||
|
// SceneScope defines how scene sessions are keyed.
|
||||||
|
type SceneScope int
|
||||||
|
|
||||||
|
const (
|
||||||
|
// SceneScopeUser shares a scene across all chats for one user.
|
||||||
|
SceneScopeUser SceneScope = iota
|
||||||
|
// SceneScopeChat shares a scene across all users in one chat.
|
||||||
|
SceneScopeChat
|
||||||
|
// SceneScopeUserChat isolates a scene per user-chat pair.
|
||||||
|
SceneScopeUserChat
|
||||||
|
)
|
||||||
|
|
||||||
|
type sceneRuntime interface {
|
||||||
|
findScene(name string) (*sceneMeta, bool)
|
||||||
|
getSession(key string) (SceneSession, error)
|
||||||
|
setSession(key string, session SceneSession) error
|
||||||
|
deleteSession(key string) error
|
||||||
|
buildSceneKey(scope SceneScope, ctx *MsgContext) (string, bool)
|
||||||
|
findSceneSession(ctx *MsgContext) (string, SceneSession, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
type sceneMeta struct {
|
||||||
|
Name string
|
||||||
|
Scope SceneScope
|
||||||
|
Entry string
|
||||||
|
Steps map[string]struct{}
|
||||||
|
}
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
// SceneContext wraps MsgContext with scene session state for scene handlers.
|
||||||
|
type SceneContext struct {
|
||||||
|
*MsgContext
|
||||||
|
sess SceneSession
|
||||||
|
key string
|
||||||
|
}
|
||||||
|
|
||||||
|
// Next advances the current scene to step.
|
||||||
|
func (ctx *SceneContext) Next(step string) SceneResult {
|
||||||
|
return SceneResult{
|
||||||
|
Action: SceneActionNext,
|
||||||
|
Next: step,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Stay keeps the current scene step active.
|
||||||
|
func (ctx *SceneContext) Stay() SceneResult {
|
||||||
|
return SceneResult{Action: SceneActionStay}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Exit leaves the current scene.
|
||||||
|
func (ctx *SceneContext) Exit() SceneResult {
|
||||||
|
return SceneResult{Action: SceneActionExit}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Pass stops scene handling and lets normal routing continue.
|
||||||
|
func (ctx *SceneContext) Pass() SceneResult {
|
||||||
|
return SceneResult{Action: SceneActionPass}
|
||||||
|
}
|
||||||
|
|
||||||
|
// BindData unmarshals the current scene session payload into v.
|
||||||
|
func (ctx *SceneContext) BindData(v any) error {
|
||||||
|
return ctx.sess.BindData(v)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SaveData marshals v and stores it in the current scene session payload.
|
||||||
|
func (ctx *SceneContext) SaveData(v any) error {
|
||||||
|
return ctx.sess.SaveData(v)
|
||||||
|
}
|
||||||
@@ -0,0 +1,296 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func (bot *Bot[T]) tryHandleScene(ctx *MsgContext) (bool, error) {
|
||||||
|
key, session, err := bot.findSceneSession(ctx)
|
||||||
|
if err != nil {
|
||||||
|
if errors.Is(err, ErrCantFindSession) || errors.Is(err, ErrMessageNil) {
|
||||||
|
return false, nil
|
||||||
|
}
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
if session.Scene == "" {
|
||||||
|
return false, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, plugin := range bot.plugins {
|
||||||
|
scene, ok := plugin.scenes[session.Scene]
|
||||||
|
if !ok {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if scene.PluginName != "" && scene.PluginName != plugin.name {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if !plugin.executeMiddlewares(ctx, bot.appData) {
|
||||||
|
return false, nil
|
||||||
|
}
|
||||||
|
sceneCtx := &SceneContext{
|
||||||
|
MsgContext: ctx,
|
||||||
|
sess: session,
|
||||||
|
key: key,
|
||||||
|
}
|
||||||
|
|
||||||
|
return bot.executeScene(sceneCtx, scene)
|
||||||
|
}
|
||||||
|
return false, ErrSceneNotFound
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) executeScene(ctx *SceneContext, scene *Scene[T]) (bool, error) {
|
||||||
|
if ctx.MsgContext == nil || ctx.sess.Scene == "" {
|
||||||
|
return false, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
var text string
|
||||||
|
if ctx.Msg != nil {
|
||||||
|
text = ctx.Msg.Text
|
||||||
|
if text == "" {
|
||||||
|
text = ctx.Msg.Caption
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
text = strings.TrimSpace(text)
|
||||||
|
prefix, cmd, args := bot.parseCommand(text)
|
||||||
|
if cmd != "" {
|
||||||
|
ctx.Prefix = prefix
|
||||||
|
ctx.Text = args
|
||||||
|
ctx.Args = strings.Fields(args)
|
||||||
|
|
||||||
|
if _, ok := scene.commands[cmd]; ok {
|
||||||
|
startTime := time.Now()
|
||||||
|
bot.emitSceneStarted(ctx, scene, HandlerSceneCommandKind, cmd)
|
||||||
|
res, _, err := scene.executeCommand(cmd, ctx, bot.appData)
|
||||||
|
if err != nil {
|
||||||
|
bot.emitSceneFinished(ctx, scene, HandlerSceneCommandKind, cmd, startTime, err)
|
||||||
|
bot.emitSceneError(ctx, scene, HandlerSceneCommandKind, cmd, err)
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
from := ctx.sess.Step
|
||||||
|
ok, err := bot.applySceneResult(scene, ctx, res)
|
||||||
|
bot.emitSceneFinished(ctx, scene, HandlerSceneCommandKind, cmd, startTime, err)
|
||||||
|
if err != nil {
|
||||||
|
bot.emitSceneError(ctx, scene, HandlerSceneCommandKind, cmd, err)
|
||||||
|
}
|
||||||
|
if ok {
|
||||||
|
bot.emitSceneTransition(ctx, scene, from, res)
|
||||||
|
}
|
||||||
|
return ok, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Unmatched slash-commands should continue through normal bot command routing
|
||||||
|
// instead of also triggering the active scene step or fallback handler.
|
||||||
|
return false, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
query := ctx.Update.CallbackQuery
|
||||||
|
if query != nil {
|
||||||
|
data, err := bot.decodePayload(query.Data)
|
||||||
|
if err != nil {
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
ctx.Args = data.Args
|
||||||
|
cmd := data.Command
|
||||||
|
if _, ok := scene.payloads[cmd]; ok {
|
||||||
|
startTime := time.Now()
|
||||||
|
bot.emitSceneStarted(ctx, scene, HandlerScenePayloadKind, cmd)
|
||||||
|
res, _, err := scene.executePayload(cmd, ctx, bot.appData)
|
||||||
|
if err != nil {
|
||||||
|
bot.emitSceneFinished(ctx, scene, HandlerScenePayloadKind, cmd, startTime, err)
|
||||||
|
bot.emitSceneError(ctx, scene, HandlerScenePayloadKind, cmd, err)
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
from := ctx.sess.Step
|
||||||
|
ok, err := bot.applySceneResult(scene, ctx, res)
|
||||||
|
bot.emitSceneFinished(ctx, scene, HandlerScenePayloadKind, cmd, startTime, err)
|
||||||
|
if err != nil {
|
||||||
|
bot.emitSceneError(ctx, scene, HandlerScenePayloadKind, cmd, err)
|
||||||
|
}
|
||||||
|
if ok {
|
||||||
|
bot.emitSceneTransition(ctx, scene, from, res)
|
||||||
|
}
|
||||||
|
return ok, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Unmatched payloads should not trigger the active scene step or fallback handler.
|
||||||
|
// This allows using payloads for other bot features like pagination without interfering with active scenes.
|
||||||
|
return false, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx.Text = text
|
||||||
|
ctx.Args = nil
|
||||||
|
ctx.Prefix = ""
|
||||||
|
if ctx.sess.Step != "" {
|
||||||
|
step := ctx.sess.Step
|
||||||
|
if _, ok := scene.steps[step]; ok {
|
||||||
|
startTime := time.Now()
|
||||||
|
bot.emitSceneStarted(ctx, scene, HandlerSceneStepKind, step)
|
||||||
|
res, _, err := scene.executeStep(step, ctx, bot.appData)
|
||||||
|
if err != nil {
|
||||||
|
bot.emitSceneFinished(ctx, scene, HandlerSceneStepKind, step, startTime, err)
|
||||||
|
bot.emitSceneError(ctx, scene, HandlerSceneStepKind, step, err)
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
from := step
|
||||||
|
ok, err := bot.applySceneResult(scene, ctx, res)
|
||||||
|
bot.emitSceneFinished(ctx, scene, HandlerSceneStepKind, step, startTime, err)
|
||||||
|
if err != nil {
|
||||||
|
bot.emitSceneError(ctx, scene, HandlerSceneStepKind, from, err)
|
||||||
|
}
|
||||||
|
if ok {
|
||||||
|
bot.emitSceneTransition(ctx, scene, from, res)
|
||||||
|
}
|
||||||
|
return ok, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if scene.message != nil {
|
||||||
|
startTime := time.Now()
|
||||||
|
bot.emitSceneStarted(ctx, scene, HandlerSceneMessageKind, "message_fallback")
|
||||||
|
res, _, err := scene.executeMessage(ctx, bot.appData)
|
||||||
|
if err != nil {
|
||||||
|
bot.emitSceneFinished(ctx, scene, HandlerSceneMessageKind, "message_fallback", startTime, err)
|
||||||
|
bot.emitSceneError(ctx, scene, HandlerSceneMessageKind, "message_fallback", err)
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
from := ctx.sess.Step
|
||||||
|
ok, err := bot.applySceneResult(scene, ctx, res)
|
||||||
|
bot.emitSceneFinished(ctx, scene, HandlerSceneMessageKind, "message_fallback", startTime, err)
|
||||||
|
if err != nil {
|
||||||
|
bot.emitSceneError(ctx, scene, HandlerSceneMessageKind, "message_fallback", err)
|
||||||
|
}
|
||||||
|
if ok {
|
||||||
|
bot.emitSceneTransition(ctx, scene, from, res)
|
||||||
|
}
|
||||||
|
return ok, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return false, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) emitSceneStarted(ctx *SceneContext, scene *Scene[T], kind HandlerEventKind, name string) {
|
||||||
|
bot.safeEmitEvent(ctx.Context(), HandlerStartedEvent{
|
||||||
|
UpdateID: ctx.Update.UpdateID,
|
||||||
|
UpdateType: ctx.Update.Type,
|
||||||
|
Plugin: scene.PluginName,
|
||||||
|
HandlerKind: kind,
|
||||||
|
HandlerName: name,
|
||||||
|
FromID: ctx.FromID,
|
||||||
|
ChatID: ctx.ChatID,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) emitSceneFinished(ctx *SceneContext, scene *Scene[T], kind HandlerEventKind, name string, startedAt time.Time, err error) {
|
||||||
|
bot.safeEmitEvent(ctx.Context(), HandlerFinishedEvent{
|
||||||
|
UpdateID: ctx.Update.UpdateID,
|
||||||
|
UpdateType: ctx.Update.Type,
|
||||||
|
Plugin: scene.PluginName,
|
||||||
|
HandlerKind: kind,
|
||||||
|
HandlerName: name,
|
||||||
|
FromID: ctx.FromID,
|
||||||
|
ChatID: ctx.ChatID,
|
||||||
|
Duration: time.Since(startedAt),
|
||||||
|
Err: err,
|
||||||
|
UserFacing: IsUserError(err),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) emitSceneError(ctx *SceneContext, scene *Scene[T], kind HandlerEventKind, name string, err error) {
|
||||||
|
bot.safeEmitEvent(ctx.Context(), ErrorEvent{
|
||||||
|
UpdateID: ctx.Update.UpdateID,
|
||||||
|
UpdateType: ctx.Update.Type,
|
||||||
|
Plugin: scene.PluginName,
|
||||||
|
HandlerKind: kind,
|
||||||
|
HandlerName: name,
|
||||||
|
FromID: ctx.FromID,
|
||||||
|
ChatID: ctx.ChatID,
|
||||||
|
Err: err,
|
||||||
|
UserFacing: IsUserError(err),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) emitSceneTransition(ctx *SceneContext, scene *Scene[T], from string, result SceneResult) {
|
||||||
|
if result.Action == SceneActionPass {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
var to string
|
||||||
|
switch result.Action {
|
||||||
|
case SceneActionNext:
|
||||||
|
to = result.Next
|
||||||
|
case SceneActionExit:
|
||||||
|
to = ""
|
||||||
|
default:
|
||||||
|
to = from
|
||||||
|
}
|
||||||
|
|
||||||
|
bot.safeEmitEvent(ctx.Context(), SceneTransitionEvent{
|
||||||
|
Plugin: scene.PluginName,
|
||||||
|
Scene: scene.Name,
|
||||||
|
From: from,
|
||||||
|
To: to,
|
||||||
|
Action: result.Action,
|
||||||
|
FromID: ctx.FromID,
|
||||||
|
ChatID: ctx.ChatID,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) applySceneResult(scene *Scene[T], ctx *SceneContext, result SceneResult) (bool, error) {
|
||||||
|
switch result.Action {
|
||||||
|
case SceneActionStay:
|
||||||
|
if err := bot.sessionStore.Set(ctx.key, ctx.sess); err != nil {
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
return true, nil
|
||||||
|
case SceneActionNext:
|
||||||
|
if result.Next == "" {
|
||||||
|
return false, ErrSceneStepNotFound
|
||||||
|
}
|
||||||
|
if _, ok := scene.steps[result.Next]; !ok {
|
||||||
|
return false, ErrSceneStepNotFound
|
||||||
|
}
|
||||||
|
ctx.sess.Step = result.Next
|
||||||
|
if err := bot.sessionStore.Set(ctx.key, ctx.sess); err != nil {
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
return true, nil
|
||||||
|
case SceneActionExit:
|
||||||
|
if err := bot.sessionStore.Delete(ctx.key); err != nil {
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
return true, nil
|
||||||
|
case SceneActionPass:
|
||||||
|
return false, nil
|
||||||
|
default:
|
||||||
|
return false, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
func buildSceneKey(scope SceneScope, ctx *MsgContext) (string, bool) {
|
||||||
|
if ctx == nil {
|
||||||
|
return "", false
|
||||||
|
}
|
||||||
|
|
||||||
|
switch scope {
|
||||||
|
case SceneScopeUserChat:
|
||||||
|
if ctx.Msg == nil || ctx.Msg.Chat == nil || ctx.FromID == 0 {
|
||||||
|
return "", false
|
||||||
|
}
|
||||||
|
return fmt.Sprintf("user_id:%d:chat_id:%d", ctx.FromID, ctx.Msg.Chat.ID), true
|
||||||
|
case SceneScopeChat:
|
||||||
|
if ctx.Msg == nil || ctx.Msg.Chat == nil {
|
||||||
|
return "", false
|
||||||
|
}
|
||||||
|
return fmt.Sprintf("chat_id:%d", ctx.Msg.Chat.ID), true
|
||||||
|
case SceneScopeUser:
|
||||||
|
if ctx.FromID == 0 {
|
||||||
|
return "", false
|
||||||
|
}
|
||||||
|
return fmt.Sprintf("user_id:%d", ctx.FromID), true
|
||||||
|
default:
|
||||||
|
return "", false
|
||||||
|
}
|
||||||
|
}
|
||||||
+898
@@ -0,0 +1,898 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
|
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||||
|
)
|
||||||
|
|
||||||
|
type failingSessionStore struct {
|
||||||
|
getErr error
|
||||||
|
setErr error
|
||||||
|
deleteErr error
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s failingSessionStore) Get(string) (SceneSession, error) {
|
||||||
|
return SceneSession{}, s.getErr
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s failingSessionStore) Set(string, SceneSession) error {
|
||||||
|
return s.setErr
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s failingSessionStore) Delete(string) error {
|
||||||
|
return s.deleteErr
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPluginAddSceneRegistersScene(t *testing.T) {
|
||||||
|
plugin := NewPlugin[NoData]("wizard")
|
||||||
|
scene := NewScene[NoData]("signup")
|
||||||
|
|
||||||
|
plugin.AddScene(scene)
|
||||||
|
|
||||||
|
if got, ok := plugin.scenes["signup"]; !ok || got != scene {
|
||||||
|
t.Fatalf("scene was not registered in plugin: ok=%v got=%p want=%p", ok, got, scene)
|
||||||
|
}
|
||||||
|
if scene.PluginName != "wizard" {
|
||||||
|
t.Fatalf("unexpected plugin name on scene: got %q want %q", scene.PluginName, "wizard")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBotAddPluginsPreservesScenesAndHandlesThem(t *testing.T) {
|
||||||
|
called := false
|
||||||
|
|
||||||
|
plugin := NewPlugin[NoData]("wizard")
|
||||||
|
plugin.NewScene("signup").
|
||||||
|
SetEntry("start").
|
||||||
|
OnStep("start", func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||||
|
called = true
|
||||||
|
if ctx.Text != "hello there" {
|
||||||
|
t.Fatalf("unexpected scene text: got %q want %q", ctx.Text, "hello there")
|
||||||
|
}
|
||||||
|
return ctx.Exit(), nil
|
||||||
|
})
|
||||||
|
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
prefixes: []string{"/"},
|
||||||
|
sessionStore: NewMemorySessionStore(),
|
||||||
|
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||||
|
}
|
||||||
|
bot.AddPlugins(plugin)
|
||||||
|
|
||||||
|
sceneMeta, ok := bot.findScene("signup")
|
||||||
|
if !ok {
|
||||||
|
t.Fatal("expected scene metadata to be available after plugin registration")
|
||||||
|
}
|
||||||
|
if sceneMeta.Entry != "start" {
|
||||||
|
t.Fatalf("unexpected scene entry: got %q want %q", sceneMeta.Entry, "start")
|
||||||
|
}
|
||||||
|
|
||||||
|
enterCtx := &MsgContext{
|
||||||
|
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||||
|
FromID: 42,
|
||||||
|
sceneRuntime: bot,
|
||||||
|
}
|
||||||
|
if err := enterCtx.EnterScene("signup"); err != nil {
|
||||||
|
t.Fatalf("EnterScene returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
bot.handle(context.Background(), &tgapi.Update{
|
||||||
|
UpdateID: 1,
|
||||||
|
Type: tgapi.UpdateTypeMessage,
|
||||||
|
Message: &tgapi.Message{
|
||||||
|
MessageID: 7,
|
||||||
|
Text: "hello there",
|
||||||
|
Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate},
|
||||||
|
From: &tgapi.User{ID: 42},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
if !called {
|
||||||
|
t.Fatal("expected scene step handler to be called")
|
||||||
|
}
|
||||||
|
|
||||||
|
lookupCtx := &MsgContext{
|
||||||
|
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||||
|
FromID: 42,
|
||||||
|
}
|
||||||
|
if _, session, err := bot.findSceneSession(lookupCtx); err == nil && session.Scene != "" {
|
||||||
|
t.Fatalf("expected scene session to be removed after exit, got %#v", session)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBuildSceneKeyRejectsMissingContextFields(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
scope SceneScope
|
||||||
|
ctx *MsgContext
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "nil context",
|
||||||
|
scope: SceneScopeUserChat,
|
||||||
|
ctx: nil,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "missing message for chat scope",
|
||||||
|
scope: SceneScopeChat,
|
||||||
|
ctx: &MsgContext{},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "missing from id for user scope",
|
||||||
|
scope: SceneScopeUser,
|
||||||
|
ctx: &MsgContext{},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "missing from id for user chat scope",
|
||||||
|
scope: SceneScopeUserChat,
|
||||||
|
ctx: &MsgContext{
|
||||||
|
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
if key, ok := buildSceneKey(tt.scope, tt.ctx); ok || key != "" {
|
||||||
|
t.Fatalf("expected invalid scene key, got key=%q ok=%v", key, ok)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEnterSceneRejectsMissingEntryConfiguration(t *testing.T) {
|
||||||
|
t.Run("empty entry", func(t *testing.T) {
|
||||||
|
plugin := NewPlugin[NoData]("wizard")
|
||||||
|
plugin.NewScene("signup")
|
||||||
|
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
sessionStore: NewMemorySessionStore(),
|
||||||
|
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||||
|
}
|
||||||
|
bot.AddPlugins(plugin)
|
||||||
|
|
||||||
|
ctx := &MsgContext{
|
||||||
|
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||||
|
FromID: 42,
|
||||||
|
sceneRuntime: bot,
|
||||||
|
}
|
||||||
|
|
||||||
|
err := ctx.EnterScene("signup")
|
||||||
|
if !errors.Is(err, ErrSceneEntryNotSet) {
|
||||||
|
t.Fatalf("expected ErrSceneEntryNotSet, got %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("missing entry step", func(t *testing.T) {
|
||||||
|
plugin := NewPlugin[NoData]("wizard")
|
||||||
|
plugin.NewScene("signup").SetEntry("start")
|
||||||
|
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
sessionStore: NewMemorySessionStore(),
|
||||||
|
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||||
|
}
|
||||||
|
bot.AddPlugins(plugin)
|
||||||
|
|
||||||
|
ctx := &MsgContext{
|
||||||
|
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||||
|
FromID: 42,
|
||||||
|
sceneRuntime: bot,
|
||||||
|
}
|
||||||
|
|
||||||
|
err := ctx.EnterScene("signup")
|
||||||
|
if !errors.Is(err, ErrSceneStepNotFound) {
|
||||||
|
t.Fatalf("expected ErrSceneStepNotFound, got %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSceneContextMethodsRequireRuntime(t *testing.T) {
|
||||||
|
ctx := &MsgContext{}
|
||||||
|
|
||||||
|
if err := ctx.EnterScene("signup"); !errors.Is(err, ErrSceneRuntimeNil) {
|
||||||
|
t.Fatalf("expected ErrSceneRuntimeNil from EnterScene, got %v", err)
|
||||||
|
}
|
||||||
|
if err := ctx.EnterSceneStep("signup", "start"); !errors.Is(err, ErrSceneRuntimeNil) {
|
||||||
|
t.Fatalf("expected ErrSceneRuntimeNil from EnterSceneStep, got %v", err)
|
||||||
|
}
|
||||||
|
if err := ctx.ExitScene(); !errors.Is(err, ErrSceneRuntimeNil) {
|
||||||
|
t.Fatalf("expected ErrSceneRuntimeNil from ExitScene, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSceneCommandHandlerRunsBeforeStep(t *testing.T) {
|
||||||
|
sceneCommandCalled := false
|
||||||
|
stepCalled := false
|
||||||
|
|
||||||
|
plugin := NewPlugin[NoData]("wizard")
|
||||||
|
plugin.NewScene("signup").
|
||||||
|
SetEntry("start").
|
||||||
|
OnStep("start", func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||||
|
stepCalled = true
|
||||||
|
return ctx.Stay(), nil
|
||||||
|
}).
|
||||||
|
OnCommand("cancel", func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||||
|
sceneCommandCalled = true
|
||||||
|
if ctx.Prefix != "/" {
|
||||||
|
t.Fatalf("unexpected prefix: got %q want /", ctx.Prefix)
|
||||||
|
}
|
||||||
|
if ctx.Text != "right now" {
|
||||||
|
t.Fatalf("unexpected scene command text: got %q want %q", ctx.Text, "right now")
|
||||||
|
}
|
||||||
|
if len(ctx.Args) != 2 || ctx.Args[0] != "right" || ctx.Args[1] != "now" {
|
||||||
|
t.Fatalf("unexpected scene command args: %#v", ctx.Args)
|
||||||
|
}
|
||||||
|
return ctx.Exit(), nil
|
||||||
|
})
|
||||||
|
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
prefixes: []string{"/"},
|
||||||
|
sessionStore: NewMemorySessionStore(),
|
||||||
|
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||||
|
}
|
||||||
|
bot.AddPlugins(plugin)
|
||||||
|
|
||||||
|
enterCtx := &MsgContext{
|
||||||
|
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||||
|
FromID: 42,
|
||||||
|
sceneRuntime: bot,
|
||||||
|
}
|
||||||
|
if err := enterCtx.EnterScene("signup"); err != nil {
|
||||||
|
t.Fatalf("EnterScene returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
bot.handle(context.Background(), &tgapi.Update{
|
||||||
|
UpdateID: 2,
|
||||||
|
Type: tgapi.UpdateTypeMessage,
|
||||||
|
Message: &tgapi.Message{
|
||||||
|
MessageID: 8,
|
||||||
|
Text: "/cancel right now",
|
||||||
|
Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate},
|
||||||
|
From: &tgapi.User{ID: 42},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
if !sceneCommandCalled {
|
||||||
|
t.Fatal("expected scene command handler to be called")
|
||||||
|
}
|
||||||
|
if stepCalled {
|
||||||
|
t.Fatal("expected scene command to short-circuit the scene step")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSceneCommandObserverEmitsLifecycleEvents(t *testing.T) {
|
||||||
|
observer := &recordingObserver{}
|
||||||
|
plugin := NewPlugin[NoData]("wizard")
|
||||||
|
plugin.NewScene("signup").
|
||||||
|
SetEntry("start").
|
||||||
|
OnStep("start", func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||||
|
return ctx.Stay(), nil
|
||||||
|
}).
|
||||||
|
OnCommand("cancel", func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||||
|
return ctx.Exit(), nil
|
||||||
|
})
|
||||||
|
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
prefixes: []string{"/"},
|
||||||
|
sessionStore: NewMemorySessionStore(),
|
||||||
|
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||||
|
observer: observer,
|
||||||
|
}
|
||||||
|
bot.AddPlugins(plugin)
|
||||||
|
|
||||||
|
enterCtx := &MsgContext{
|
||||||
|
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||||
|
FromID: 42,
|
||||||
|
sceneRuntime: bot,
|
||||||
|
}
|
||||||
|
if err := enterCtx.EnterScene("signup"); err != nil {
|
||||||
|
t.Fatalf("EnterScene returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
bot.handle(context.Background(), &tgapi.Update{
|
||||||
|
UpdateID: 22,
|
||||||
|
Type: tgapi.UpdateTypeMessage,
|
||||||
|
Message: &tgapi.Message{
|
||||||
|
MessageID: 9,
|
||||||
|
Text: "/cancel",
|
||||||
|
Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate},
|
||||||
|
From: &tgapi.User{ID: 42},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
if len(observer.started) != 1 {
|
||||||
|
t.Fatalf("expected one scene started event, got %d", len(observer.started))
|
||||||
|
}
|
||||||
|
if got := observer.started[0]; got.HandlerKind != HandlerSceneCommandKind || got.HandlerName != "cancel" || got.Plugin != "wizard" {
|
||||||
|
t.Fatalf("unexpected scene started event: %#v", got)
|
||||||
|
}
|
||||||
|
if len(observer.finished) != 1 {
|
||||||
|
t.Fatalf("expected one scene finished event, got %d", len(observer.finished))
|
||||||
|
}
|
||||||
|
if got := observer.finished[0]; got.HandlerKind != HandlerSceneCommandKind || got.HandlerName != "cancel" || got.Plugin != "wizard" || got.Err != nil {
|
||||||
|
t.Fatalf("unexpected scene finished event: %#v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSceneStepObserverEmitsLifecycleEvents(t *testing.T) {
|
||||||
|
observer := &recordingObserver{}
|
||||||
|
plugin := NewPlugin[NoData]("wizard")
|
||||||
|
plugin.NewScene("signup").
|
||||||
|
SetEntry("start").
|
||||||
|
OnStep("start", func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||||
|
return ctx.Stay(), nil
|
||||||
|
})
|
||||||
|
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
prefixes: []string{"/"},
|
||||||
|
sessionStore: NewMemorySessionStore(),
|
||||||
|
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||||
|
observer: observer,
|
||||||
|
}
|
||||||
|
bot.AddPlugins(plugin)
|
||||||
|
|
||||||
|
enterCtx := &MsgContext{
|
||||||
|
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||||
|
FromID: 42,
|
||||||
|
sceneRuntime: bot,
|
||||||
|
}
|
||||||
|
if err := enterCtx.EnterScene("signup"); err != nil {
|
||||||
|
t.Fatalf("EnterScene returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
bot.handle(context.Background(), &tgapi.Update{
|
||||||
|
UpdateID: 23,
|
||||||
|
Type: tgapi.UpdateTypeMessage,
|
||||||
|
Message: &tgapi.Message{
|
||||||
|
MessageID: 10,
|
||||||
|
Text: "hello there",
|
||||||
|
Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate},
|
||||||
|
From: &tgapi.User{ID: 42},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
if len(observer.started) != 1 {
|
||||||
|
t.Fatalf("expected one scene started event, got %d", len(observer.started))
|
||||||
|
}
|
||||||
|
if got := observer.started[0]; got.HandlerKind != HandlerSceneStepKind || got.HandlerName != "start" || got.Plugin != "wizard" {
|
||||||
|
t.Fatalf("unexpected scene step started event: %#v", got)
|
||||||
|
}
|
||||||
|
if len(observer.finished) != 1 {
|
||||||
|
t.Fatalf("expected one scene finished event, got %d", len(observer.finished))
|
||||||
|
}
|
||||||
|
if got := observer.finished[0]; got.HandlerKind != HandlerSceneStepKind || got.HandlerName != "start" || got.Plugin != "wizard" || got.Err != nil {
|
||||||
|
t.Fatalf("unexpected scene step finished event: %#v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSceneMessageObserverEmitsLifecycleEvents(t *testing.T) {
|
||||||
|
observer := &recordingObserver{}
|
||||||
|
plugin := NewPlugin[NoData]("wizard")
|
||||||
|
scene := plugin.NewScene("signup").
|
||||||
|
SetEntry("start").
|
||||||
|
OnStep("start", func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||||
|
return ctx.Stay(), nil
|
||||||
|
}).
|
||||||
|
OnMessage(func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||||
|
return ctx.Exit(), nil
|
||||||
|
})
|
||||||
|
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
prefixes: []string{"/"},
|
||||||
|
sessionStore: NewMemorySessionStore(),
|
||||||
|
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||||
|
observer: observer,
|
||||||
|
}
|
||||||
|
bot.AddPlugins(plugin)
|
||||||
|
|
||||||
|
key, ok := buildSceneKey(SceneScopeUserChat, &MsgContext{
|
||||||
|
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||||
|
FromID: 42,
|
||||||
|
})
|
||||||
|
if !ok {
|
||||||
|
t.Fatal("expected scene key to be built")
|
||||||
|
}
|
||||||
|
if err := bot.sessionStore.Set(key, SceneSession{Scene: scene.Name}); err != nil {
|
||||||
|
t.Fatalf("failed to seed scene session: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
bot.handle(context.Background(), &tgapi.Update{
|
||||||
|
UpdateID: 24,
|
||||||
|
Type: tgapi.UpdateTypeMessage,
|
||||||
|
Message: &tgapi.Message{
|
||||||
|
MessageID: 11,
|
||||||
|
Text: "hello there",
|
||||||
|
Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate},
|
||||||
|
From: &tgapi.User{ID: 42},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
if len(observer.started) != 1 {
|
||||||
|
t.Fatalf("expected one scene started event, got %d", len(observer.started))
|
||||||
|
}
|
||||||
|
if got := observer.started[0]; got.HandlerKind != HandlerSceneMessageKind || got.HandlerName != "message_fallback" || got.Plugin != "wizard" {
|
||||||
|
t.Fatalf("unexpected scene message started event: %#v", got)
|
||||||
|
}
|
||||||
|
if len(observer.finished) != 1 {
|
||||||
|
t.Fatalf("expected one scene finished event, got %d", len(observer.finished))
|
||||||
|
}
|
||||||
|
if got := observer.finished[0]; got.HandlerKind != HandlerSceneMessageKind || got.HandlerName != "message_fallback" || got.Plugin != "wizard" || got.Err != nil {
|
||||||
|
t.Fatalf("unexpected scene message finished event: %#v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestScenePayloadHandlerRunsBeforeStep(t *testing.T) {
|
||||||
|
payloadCalled := false
|
||||||
|
stepCalled := false
|
||||||
|
|
||||||
|
plugin := NewPlugin[NoData]("wizard")
|
||||||
|
plugin.NewScene("signup").
|
||||||
|
SetEntry("start").
|
||||||
|
OnStep("start", func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||||
|
stepCalled = true
|
||||||
|
return ctx.Stay(), nil
|
||||||
|
}).
|
||||||
|
OnPayload("confirm", func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||||
|
payloadCalled = true
|
||||||
|
if got, want := ctx.Args, []string{"7", "ok"}; len(got) != len(want) || got[0] != want[0] || got[1] != want[1] {
|
||||||
|
t.Fatalf("unexpected payload args: got %v want %v", got, want)
|
||||||
|
}
|
||||||
|
if ctx.Text != "" {
|
||||||
|
t.Fatalf("callback flow must not populate Text, got %q", ctx.Text)
|
||||||
|
}
|
||||||
|
return ctx.Exit(), nil
|
||||||
|
})
|
||||||
|
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
payloadType: BotPayloadJSON,
|
||||||
|
sessionStore: NewMemorySessionStore(),
|
||||||
|
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||||
|
}
|
||||||
|
bot.AddPlugins(plugin)
|
||||||
|
|
||||||
|
enterCtx := &MsgContext{
|
||||||
|
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||||
|
FromID: 42,
|
||||||
|
sceneRuntime: bot,
|
||||||
|
}
|
||||||
|
if err := enterCtx.EnterScene("signup"); err != nil {
|
||||||
|
t.Fatalf("EnterScene returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
data, err := encodeJSONPayload(CallbackData{Command: "confirm", Args: []string{"7", "ok"}})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("encodeJSONPayload returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
bot.handle(context.Background(), &tgapi.Update{
|
||||||
|
UpdateID: 25,
|
||||||
|
Type: tgapi.UpdateTypeCallbackQuery,
|
||||||
|
CallbackQuery: &tgapi.CallbackQuery{
|
||||||
|
ID: "cb-scene",
|
||||||
|
Data: data,
|
||||||
|
From: tgapi.User{ID: 42},
|
||||||
|
Message: &tgapi.Message{
|
||||||
|
MessageID: 12,
|
||||||
|
Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
if !payloadCalled {
|
||||||
|
t.Fatal("expected scene payload handler to be called")
|
||||||
|
}
|
||||||
|
if stepCalled {
|
||||||
|
t.Fatal("expected scene payload to short-circuit the active step")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestScenePayloadObserverEmitsLifecycleEvents(t *testing.T) {
|
||||||
|
observer := &recordingObserver{}
|
||||||
|
plugin := NewPlugin[NoData]("wizard")
|
||||||
|
plugin.NewScene("signup").
|
||||||
|
SetEntry("start").
|
||||||
|
OnStep("start", func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||||
|
return ctx.Stay(), nil
|
||||||
|
}).
|
||||||
|
OnPayload("confirm", func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||||
|
return ctx.Exit(), nil
|
||||||
|
})
|
||||||
|
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
payloadType: BotPayloadJSON,
|
||||||
|
sessionStore: NewMemorySessionStore(),
|
||||||
|
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||||
|
observer: observer,
|
||||||
|
}
|
||||||
|
bot.AddPlugins(plugin)
|
||||||
|
|
||||||
|
enterCtx := &MsgContext{
|
||||||
|
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||||
|
FromID: 42,
|
||||||
|
sceneRuntime: bot,
|
||||||
|
}
|
||||||
|
if err := enterCtx.EnterScene("signup"); err != nil {
|
||||||
|
t.Fatalf("EnterScene returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
data, err := encodeJSONPayload(CallbackData{Command: "confirm"})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("encodeJSONPayload returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
bot.handle(context.Background(), &tgapi.Update{
|
||||||
|
UpdateID: 26,
|
||||||
|
Type: tgapi.UpdateTypeCallbackQuery,
|
||||||
|
CallbackQuery: &tgapi.CallbackQuery{
|
||||||
|
ID: "cb-scene",
|
||||||
|
Data: data,
|
||||||
|
From: tgapi.User{ID: 42},
|
||||||
|
Message: &tgapi.Message{
|
||||||
|
MessageID: 13,
|
||||||
|
Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
if len(observer.started) != 1 {
|
||||||
|
t.Fatalf("expected one scene started event, got %d", len(observer.started))
|
||||||
|
}
|
||||||
|
if got := observer.started[0]; got.HandlerKind != HandlerScenePayloadKind || got.HandlerName != "confirm" || got.Plugin != "wizard" {
|
||||||
|
t.Fatalf("unexpected scene payload started event: %#v", got)
|
||||||
|
}
|
||||||
|
if len(observer.finished) != 1 {
|
||||||
|
t.Fatalf("expected one scene finished event, got %d", len(observer.finished))
|
||||||
|
}
|
||||||
|
if got := observer.finished[0]; got.HandlerKind != HandlerScenePayloadKind || got.HandlerName != "confirm" || got.Plugin != "wizard" || got.Err != nil {
|
||||||
|
t.Fatalf("unexpected scene payload finished event: %#v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSceneUnmatchedPayloadFallsThroughWithoutRunningStep(t *testing.T) {
|
||||||
|
stepCalled := false
|
||||||
|
|
||||||
|
plugin := NewPlugin[NoData]("wizard")
|
||||||
|
plugin.NewPayload(func(ctx *MsgContext, db NoData) error { return nil }, "ping")
|
||||||
|
plugin.NewScene("signup").
|
||||||
|
SetEntry("start").
|
||||||
|
OnStep("start", func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||||
|
stepCalled = true
|
||||||
|
return ctx.Stay(), nil
|
||||||
|
})
|
||||||
|
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
payloadType: BotPayloadJSON,
|
||||||
|
sessionStore: NewMemorySessionStore(),
|
||||||
|
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||||
|
}
|
||||||
|
bot.AddPlugins(plugin)
|
||||||
|
|
||||||
|
enterCtx := &MsgContext{
|
||||||
|
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||||
|
FromID: 42,
|
||||||
|
sceneRuntime: bot,
|
||||||
|
}
|
||||||
|
if err := enterCtx.EnterScene("signup"); err != nil {
|
||||||
|
t.Fatalf("EnterScene returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
key, ok := buildSceneKey(SceneScopeUserChat, &MsgContext{
|
||||||
|
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||||
|
FromID: 42,
|
||||||
|
})
|
||||||
|
if !ok {
|
||||||
|
t.Fatal("expected scene key to be built")
|
||||||
|
}
|
||||||
|
|
||||||
|
data, err := encodeJSONPayload(CallbackData{Command: "ping"})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("encodeJSONPayload returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
bot.handle(context.Background(), &tgapi.Update{
|
||||||
|
UpdateID: 27,
|
||||||
|
Type: tgapi.UpdateTypeCallbackQuery,
|
||||||
|
CallbackQuery: &tgapi.CallbackQuery{
|
||||||
|
ID: "cb-global",
|
||||||
|
Data: data,
|
||||||
|
From: tgapi.User{ID: 42},
|
||||||
|
Message: &tgapi.Message{
|
||||||
|
MessageID: 14,
|
||||||
|
Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
if stepCalled {
|
||||||
|
t.Fatal("scene step must not run for an unmatched payload")
|
||||||
|
}
|
||||||
|
|
||||||
|
after, err := bot.sessionStore.Get(key)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Get after handle returned error: %v", err)
|
||||||
|
}
|
||||||
|
if after.Scene != "signup" || after.Step != "start" {
|
||||||
|
t.Fatalf("unexpected session after payload fallback: %#v", after)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestScenePassDoesNotPersistSessionData(t *testing.T) {
|
||||||
|
commandCalled := false
|
||||||
|
|
||||||
|
plugin := NewPlugin[NoData]("wizard")
|
||||||
|
plugin.NewCommand(func(ctx *MsgContext, db NoData) error {
|
||||||
|
commandCalled = true
|
||||||
|
return nil
|
||||||
|
}, "ping")
|
||||||
|
plugin.NewScene("signup").
|
||||||
|
SetEntry("start").
|
||||||
|
OnStep("start", func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||||
|
if err := ctx.SaveData(struct {
|
||||||
|
Value string `json:"value"`
|
||||||
|
}{Value: "changed"}); err != nil {
|
||||||
|
t.Fatalf("SaveData returned error: %v", err)
|
||||||
|
}
|
||||||
|
return ctx.Pass(), nil
|
||||||
|
})
|
||||||
|
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
prefixes: []string{"/"},
|
||||||
|
sessionStore: NewMemorySessionStore(),
|
||||||
|
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||||
|
}
|
||||||
|
bot.AddPlugins(plugin)
|
||||||
|
|
||||||
|
enterCtx := &MsgContext{
|
||||||
|
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||||
|
FromID: 42,
|
||||||
|
sceneRuntime: bot,
|
||||||
|
}
|
||||||
|
if err := enterCtx.EnterScene("signup"); err != nil {
|
||||||
|
t.Fatalf("EnterScene returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
key, ok := buildSceneKey(SceneScopeUserChat, &MsgContext{
|
||||||
|
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||||
|
FromID: 42,
|
||||||
|
})
|
||||||
|
if !ok {
|
||||||
|
t.Fatal("expected scene key to be built")
|
||||||
|
}
|
||||||
|
|
||||||
|
before, err := bot.sessionStore.Get(key)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Get before handle returned error: %v", err)
|
||||||
|
}
|
||||||
|
if before.HasData() {
|
||||||
|
t.Fatalf("expected empty session data before handle, got %#v", before)
|
||||||
|
}
|
||||||
|
|
||||||
|
bot.handle(context.Background(), &tgapi.Update{
|
||||||
|
UpdateID: 3,
|
||||||
|
Type: tgapi.UpdateTypeMessage,
|
||||||
|
Message: &tgapi.Message{
|
||||||
|
MessageID: 9,
|
||||||
|
Text: "/ping",
|
||||||
|
Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate},
|
||||||
|
From: &tgapi.User{ID: 42},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
if !commandCalled {
|
||||||
|
t.Fatal("expected normal command routing to continue after SceneActionPass")
|
||||||
|
}
|
||||||
|
|
||||||
|
after, err := bot.sessionStore.Get(key)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Get after handle returned error: %v", err)
|
||||||
|
}
|
||||||
|
if after.Scene != "signup" || after.Step != "start" {
|
||||||
|
t.Fatalf("unexpected session after pass: %#v", after)
|
||||||
|
}
|
||||||
|
if after.HasData() {
|
||||||
|
t.Fatalf("expected SceneActionPass to leave session data unchanged, got %#v", after)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSceneUnmatchedCommandFallsThroughWithoutRunningStep(t *testing.T) {
|
||||||
|
commandCalled := false
|
||||||
|
stepCalled := false
|
||||||
|
|
||||||
|
plugin := NewPlugin[NoData]("wizard")
|
||||||
|
plugin.NewScene("signup").
|
||||||
|
SetEntry("start").
|
||||||
|
OnStep("start", func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||||
|
stepCalled = true
|
||||||
|
return ctx.Stay(), nil
|
||||||
|
})
|
||||||
|
plugin.NewCommand(func(ctx *MsgContext, db NoData) error {
|
||||||
|
commandCalled = true
|
||||||
|
return nil
|
||||||
|
}, "ping")
|
||||||
|
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
prefixes: []string{"/"},
|
||||||
|
sessionStore: NewMemorySessionStore(),
|
||||||
|
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||||
|
}
|
||||||
|
bot.AddPlugins(plugin)
|
||||||
|
|
||||||
|
enterCtx := &MsgContext{
|
||||||
|
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||||
|
FromID: 42,
|
||||||
|
sceneRuntime: bot,
|
||||||
|
}
|
||||||
|
if err := enterCtx.EnterScene("signup"); err != nil {
|
||||||
|
t.Fatalf("EnterScene returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
key, ok := buildSceneKey(SceneScopeUserChat, &MsgContext{
|
||||||
|
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||||
|
FromID: 42,
|
||||||
|
})
|
||||||
|
if !ok {
|
||||||
|
t.Fatal("expected scene key to be built")
|
||||||
|
}
|
||||||
|
|
||||||
|
bot.handle(context.Background(), &tgapi.Update{
|
||||||
|
UpdateID: 5,
|
||||||
|
Type: tgapi.UpdateTypeMessage,
|
||||||
|
Message: &tgapi.Message{
|
||||||
|
MessageID: 10,
|
||||||
|
Text: "/ping",
|
||||||
|
Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate},
|
||||||
|
From: &tgapi.User{ID: 42},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
if !commandCalled {
|
||||||
|
t.Fatal("expected normal command routing to handle /ping")
|
||||||
|
}
|
||||||
|
if stepCalled {
|
||||||
|
t.Fatal("scene step must not run for an unmatched slash-command")
|
||||||
|
}
|
||||||
|
|
||||||
|
after, err := bot.sessionStore.Get(key)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Get after handle returned error: %v", err)
|
||||||
|
}
|
||||||
|
if after.Scene != "signup" || after.Step != "start" {
|
||||||
|
t.Fatalf("unexpected session after command fallback: %#v", after)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSceneMessageFallbackRunsWhenNoCommandOrStepMatch(t *testing.T) {
|
||||||
|
fallbackCalled := false
|
||||||
|
|
||||||
|
plugin := NewPlugin[NoData]("wizard")
|
||||||
|
plugin.NewScene("signup").
|
||||||
|
SetEntry("start").
|
||||||
|
OnStep("start", func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||||
|
return ctx.Stay(), nil
|
||||||
|
}).
|
||||||
|
OnMessage(func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||||
|
fallbackCalled = true
|
||||||
|
if ctx.Text != "hello fallback" {
|
||||||
|
t.Fatalf("unexpected fallback text: got %q want %q", ctx.Text, "hello fallback")
|
||||||
|
}
|
||||||
|
return ctx.Exit(), nil
|
||||||
|
})
|
||||||
|
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
prefixes: []string{"/"},
|
||||||
|
sessionStore: NewMemorySessionStore(),
|
||||||
|
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||||
|
}
|
||||||
|
bot.AddPlugins(plugin)
|
||||||
|
|
||||||
|
enterCtx := &MsgContext{
|
||||||
|
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||||
|
FromID: 42,
|
||||||
|
sceneRuntime: bot,
|
||||||
|
}
|
||||||
|
if err := enterCtx.EnterScene("signup"); err != nil {
|
||||||
|
t.Fatalf("EnterScene returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
key, ok := buildSceneKey(SceneScopeUserChat, &MsgContext{
|
||||||
|
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||||
|
FromID: 42,
|
||||||
|
})
|
||||||
|
if !ok {
|
||||||
|
t.Fatal("expected scene key to be built")
|
||||||
|
}
|
||||||
|
if err := bot.sessionStore.Set(key, SceneSession{Scene: "signup", Step: "unknown"}); err != nil {
|
||||||
|
t.Fatalf("Set returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
bot.handle(context.Background(), &tgapi.Update{
|
||||||
|
UpdateID: 4,
|
||||||
|
Type: tgapi.UpdateTypeMessage,
|
||||||
|
Message: &tgapi.Message{
|
||||||
|
MessageID: 10,
|
||||||
|
Text: "hello fallback",
|
||||||
|
Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate},
|
||||||
|
From: &tgapi.User{ID: 42},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
if !fallbackCalled {
|
||||||
|
t.Fatal("expected scene fallback handler to be called")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFindSceneSessionSupportsUserScopeWithoutMessage(t *testing.T) {
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
sessionStore: NewMemorySessionStore(),
|
||||||
|
sceneScopePriority: []SceneScope{SceneScopeUser, SceneScopeChat, SceneScopeUserChat},
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := bot.sessionStore.Set("user_id:42", SceneSession{Scene: "signup", Step: "start"}); err != nil {
|
||||||
|
t.Fatalf("Set returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
key, session, err := bot.findSceneSession(&MsgContext{FromID: 42})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("findSceneSession returned error: %v", err)
|
||||||
|
}
|
||||||
|
if key != "user_id:42" {
|
||||||
|
t.Fatalf("unexpected session key: got %q want %q", key, "user_id:42")
|
||||||
|
}
|
||||||
|
if session.Scene != "signup" || session.Step != "start" {
|
||||||
|
t.Fatalf("unexpected session: %#v", session)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSceneStoreErrorsPropagate(t *testing.T) {
|
||||||
|
getErr := errors.New("get failed")
|
||||||
|
setErr := errors.New("set failed")
|
||||||
|
|
||||||
|
t.Run("find scene session get error", func(t *testing.T) {
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
sessionStore: failingSessionStore{getErr: getErr},
|
||||||
|
sceneScopePriority: []SceneScope{SceneScopeUser},
|
||||||
|
}
|
||||||
|
|
||||||
|
_, _, err := bot.findSceneSession(&MsgContext{FromID: 42})
|
||||||
|
if !errors.Is(err, getErr) {
|
||||||
|
t.Fatalf("expected getErr, got %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("apply scene result set error", func(t *testing.T) {
|
||||||
|
scene := NewScene[NoData]("signup").OnStep("start", func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||||
|
return ctx.Stay(), nil
|
||||||
|
})
|
||||||
|
bot := &Bot[NoData]{
|
||||||
|
logger: sneklog.NewLogger(),
|
||||||
|
sessionStore: failingSessionStore{setErr: setErr},
|
||||||
|
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err := bot.applySceneResult(scene, &SceneContext{
|
||||||
|
MsgContext: &MsgContext{},
|
||||||
|
sess: SceneSession{Scene: "signup", Step: "start"},
|
||||||
|
key: "user_id:42:chat_id:100",
|
||||||
|
}, SceneResult{Action: SceneActionStay})
|
||||||
|
if !errors.Is(err, setErr) {
|
||||||
|
t.Fatalf("expected setErr, got %v", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
// SplitMessageText splits plain text into Telegram-safe message chunks.
|
||||||
|
//
|
||||||
|
// The function preserves the original text exactly: concatenating all returned
|
||||||
|
// chunks reconstructs text byte-for-byte. It prefers splitting at newlines or
|
||||||
|
// spaces within the Telegram message limit and falls back to hard rune-based
|
||||||
|
// splits when no separator is available.
|
||||||
|
func SplitMessageText(text string) []string {
|
||||||
|
return splitTextByLimit(text, maxMessageTextLen)
|
||||||
|
}
|
||||||
|
|
||||||
|
func splitTextByLimit(text string, limit int) []string {
|
||||||
|
if text == "" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
runes := []rune(text)
|
||||||
|
chunks := make([]string, 0, len(runes)/limit+1)
|
||||||
|
|
||||||
|
for start := 0; start < len(runes); {
|
||||||
|
end := start + limit
|
||||||
|
if end >= len(runes) {
|
||||||
|
chunks = append(chunks, string(runes[start:]))
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
splitAt := -1
|
||||||
|
for i := end - 1; i > start; i-- {
|
||||||
|
if runes[i] == '\n' || runes[i] == ' ' {
|
||||||
|
splitAt = i + 1
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if splitAt == -1 {
|
||||||
|
splitAt = end
|
||||||
|
}
|
||||||
|
|
||||||
|
chunks = append(chunks, string(runes[start:splitAt]))
|
||||||
|
start = splitAt
|
||||||
|
}
|
||||||
|
|
||||||
|
return chunks
|
||||||
|
}
|
||||||
+332
@@ -0,0 +1,332 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||||
|
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||||
|
)
|
||||||
|
|
||||||
|
// APIOpts holds configuration options for initializing the Telegram API client.
|
||||||
|
// Use the provided setter methods to build options — do not construct directly.
|
||||||
|
type APIOpts struct {
|
||||||
|
token string
|
||||||
|
client *http.Client
|
||||||
|
useTestServer bool
|
||||||
|
apiURL string
|
||||||
|
|
||||||
|
logFormat utils.LogFormat
|
||||||
|
logFormatter *sneklog.Formatter
|
||||||
|
|
||||||
|
limiter *utils.RateLimiter
|
||||||
|
dropOverflowLimit bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewAPIOpts creates a new APIOpts with default values.
|
||||||
|
// Use setter methods to customize behavior.
|
||||||
|
func NewAPIOpts(token string) *APIOpts {
|
||||||
|
return &APIOpts{
|
||||||
|
token: token,
|
||||||
|
client: nil,
|
||||||
|
useTestServer: false,
|
||||||
|
apiURL: "https://api.telegram.org",
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetHTTPClient sets a custom HTTP client. Use this for timeouts, proxies, or custom transport.
|
||||||
|
// If not set, a default client with 45s timeout is used.
|
||||||
|
func (opts *APIOpts) SetHTTPClient(client *http.Client) *APIOpts {
|
||||||
|
if client != nil {
|
||||||
|
opts.client = client
|
||||||
|
}
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// UseTestServer enables use of Telegram's test server (https://api.test.telegram.org).
|
||||||
|
// Only for development/testing.
|
||||||
|
func (opts *APIOpts) UseTestServer(use bool) *APIOpts {
|
||||||
|
opts.useTestServer = use
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetAPIURL overrides the default Telegram API URL.
|
||||||
|
// Useful for self-hosted bots or proxies.
|
||||||
|
func (opts *APIOpts) SetAPIURL(apiURL string) *APIOpts {
|
||||||
|
if apiURL != "" {
|
||||||
|
opts.apiURL = apiURL
|
||||||
|
}
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
func (opts *APIOpts) SetLogFormat(format utils.LogFormat) *APIOpts {
|
||||||
|
opts.logFormat = format
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
func (opts *APIOpts) SetLogFormatter(formatter *sneklog.Formatter) *APIOpts {
|
||||||
|
opts.logFormatter = formatter
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetLimiter sets a rate limiter to enforce Telegram's API limits.
|
||||||
|
// Recommended: use utils.NewRateLimiter() for correct per-chat and global throttling.
|
||||||
|
func (opts *APIOpts) SetLimiter(limiter *utils.RateLimiter) *APIOpts {
|
||||||
|
opts.limiter = limiter
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetLimiterDrop enables "drop mode" for rate limiting.
|
||||||
|
// If true, requests exceeding limits return ErrDropOverflow immediately.
|
||||||
|
// If false, requests block until capacity is available.
|
||||||
|
func (opts *APIOpts) SetLimiterDrop(b bool) *APIOpts {
|
||||||
|
opts.dropOverflowLimit = b
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// API is the main Telegram Bot API client for JSON requests.
|
||||||
|
//
|
||||||
|
// Use API methods when sending JSON payloads (for example with file_id, URL, or other
|
||||||
|
// non-multipart fields). For multipart file uploads, use Uploader.
|
||||||
|
//
|
||||||
|
// It manages HTTP requests, rate limiting, retries, and connection pooling.
|
||||||
|
type API struct {
|
||||||
|
token string
|
||||||
|
client *http.Client
|
||||||
|
logger *sneklog.Logger
|
||||||
|
useTestServer bool
|
||||||
|
apiURL string
|
||||||
|
|
||||||
|
logFormat utils.LogFormat
|
||||||
|
logFormatter *sneklog.Formatter
|
||||||
|
|
||||||
|
pool *workerPool
|
||||||
|
Limiter *utils.RateLimiter
|
||||||
|
dropOverflowLimit bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewAPI creates a new API client from options.
|
||||||
|
// Always call Close() when done to release resources.
|
||||||
|
func NewAPI(opts *APIOpts) *API {
|
||||||
|
if opts == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
logger := utils.CreateLogger(
|
||||||
|
"API", utils.GetLoggerLevel(),
|
||||||
|
opts.logFormat, opts.logFormatter,
|
||||||
|
)
|
||||||
|
|
||||||
|
client := opts.client
|
||||||
|
if client == nil {
|
||||||
|
client = &http.Client{Timeout: time.Second * 45}
|
||||||
|
}
|
||||||
|
|
||||||
|
pool := newWorkerPool(16, 256)
|
||||||
|
pool.start()
|
||||||
|
|
||||||
|
return &API{
|
||||||
|
token: opts.token,
|
||||||
|
client: client,
|
||||||
|
logger: logger,
|
||||||
|
useTestServer: opts.useTestServer,
|
||||||
|
apiURL: opts.apiURL,
|
||||||
|
|
||||||
|
logFormat: opts.logFormat,
|
||||||
|
logFormatter: opts.logFormatter,
|
||||||
|
|
||||||
|
pool: pool,
|
||||||
|
Limiter: opts.limiter,
|
||||||
|
dropOverflowLimit: opts.dropOverflowLimit,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Close shuts down the internal worker pool and closes the logger.
|
||||||
|
// Must be called to avoid resource leaks.
|
||||||
|
// See https://core.telegram.org/bots/api
|
||||||
|
func (api *API) Close() error {
|
||||||
|
api.pool.stop()
|
||||||
|
if api.client != nil {
|
||||||
|
api.client.CloseIdleConnections()
|
||||||
|
}
|
||||||
|
return api.logger.Close()
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetLogger returns the internal logger for custom logging.
|
||||||
|
// See https://core.telegram.org/bots/api
|
||||||
|
func (api *API) GetLogger() *sneklog.Logger {
|
||||||
|
return api.logger
|
||||||
|
}
|
||||||
|
|
||||||
|
// ResponseParameters contains Telegram API response metadata (e.g., retry_after, migrate_to_chat_id).
|
||||||
|
type ResponseParameters struct {
|
||||||
|
MigrateToChatID *int64 `json:"migrate_to_chat_id,omitempty"`
|
||||||
|
RetryAfter *int `json:"retry_after,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// TelegramResponse is the standard Telegram Bot API response structure.
|
||||||
|
// Generic over Result type R.
|
||||||
|
type TelegramResponse[R any] struct {
|
||||||
|
Ok bool `json:"ok"`
|
||||||
|
Description string `json:"description,omitempty"`
|
||||||
|
Result R `json:"result,omitempty"`
|
||||||
|
ErrorCode int `json:"error_code,omitempty"`
|
||||||
|
Parameters *ResponseParameters `json:"parameters,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// TelegramRequest is a low-level Telegram API request wrapper.
|
||||||
|
//
|
||||||
|
// Prefer method-specific helpers such as SendMessage or GetUpdates. TelegramRequest
|
||||||
|
// bypasses method-specific parameter types and convenience helpers, so callers are
|
||||||
|
// responsible for using the correct method name and compatible request and response types.
|
||||||
|
// In that sense it is an unsafe escape hatch compared with the typed API surface.
|
||||||
|
type TelegramRequest[R, P any] struct {
|
||||||
|
method string
|
||||||
|
params P
|
||||||
|
chatID int64
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewRequest creates a low-level TelegramRequest with no associated chat ID.
|
||||||
|
func NewRequest[R, P any](method string, params P) TelegramRequest[R, P] {
|
||||||
|
return TelegramRequest[R, P]{method, params, 0}
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewRequestWithChatID creates a low-level TelegramRequest with an associated chat ID.
|
||||||
|
// The chat ID is used for per-chat rate limiting.
|
||||||
|
func NewRequestWithChatID[R, P any](method string, params P, chatID int64) TelegramRequest[R, P] {
|
||||||
|
return TelegramRequest[R, P]{method, params, chatID}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r TelegramRequest[R, P]) doRequest(ctx context.Context, api *API) (R, error) {
|
||||||
|
var zero R
|
||||||
|
reqData, err := json.Marshal(r.params)
|
||||||
|
if err != nil {
|
||||||
|
return zero, fmt.Errorf("failed to marshal request: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
methodPrefix := ""
|
||||||
|
if api.useTestServer {
|
||||||
|
methodPrefix = "/test"
|
||||||
|
}
|
||||||
|
url := fmt.Sprintf("%s/bot%s%s/%s", api.apiURL, api.token, methodPrefix, r.method)
|
||||||
|
req, err := http.NewRequestWithContext(ctx, "POST", url, nil)
|
||||||
|
if err != nil {
|
||||||
|
return zero, fmt.Errorf("failed to create request: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
req.Header.Set("Content-Type", "application/json")
|
||||||
|
req.Header.Set("Accept", "application/json")
|
||||||
|
req.Header.Set("User-Agent", fmt.Sprintf("Laniakea/%s", utils.VersionString))
|
||||||
|
|
||||||
|
for {
|
||||||
|
// Apply rate limiting before making the request
|
||||||
|
if api.Limiter != nil {
|
||||||
|
if err := api.Limiter.Check(ctx, api.dropOverflowLimit, r.chatID); err != nil {
|
||||||
|
return zero, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
buf := bytes.NewBuffer(reqData)
|
||||||
|
req.Body = io.NopCloser(buf)
|
||||||
|
req.ContentLength = int64(len(reqData))
|
||||||
|
|
||||||
|
api.logger.Debugln("REQ", url, string(reqData))
|
||||||
|
resp, err := api.client.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return zero, fmt.Errorf("HTTP request failed: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
respData, err := readBody(resp.Body)
|
||||||
|
_ = resp.Body.Close() // ensure body is closed
|
||||||
|
if err != nil {
|
||||||
|
return zero, fmt.Errorf("failed to read response body: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
api.logger.Debugln("RES", r.method, string(respData))
|
||||||
|
|
||||||
|
response, err := parseBody[R](respData)
|
||||||
|
if err != nil {
|
||||||
|
return zero, fmt.Errorf("failed to parse response: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !response.Ok {
|
||||||
|
// Handle rate limiting (429)
|
||||||
|
if response.ErrorCode == 429 && response.Parameters != nil && response.Parameters.RetryAfter != nil {
|
||||||
|
after := *response.Parameters.RetryAfter
|
||||||
|
api.logger.Warnf("Rate limited by Telegram, retry after %d seconds (chat: %d)", after, r.chatID)
|
||||||
|
|
||||||
|
// Apply cooldown to global or chat-specific limiter
|
||||||
|
if api.Limiter != nil {
|
||||||
|
if r.chatID > 0 {
|
||||||
|
api.Limiter.SetChatLock(r.chatID, after)
|
||||||
|
} else {
|
||||||
|
api.Limiter.SetGlobalLock(after)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Wait and retry
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return zero, ctx.Err()
|
||||||
|
case <-time.After(time.Duration(after) * time.Second):
|
||||||
|
continue // retry request
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Other API errors
|
||||||
|
return zero, fmt.Errorf("[%d] %s", response.ErrorCode, response.Description)
|
||||||
|
}
|
||||||
|
|
||||||
|
return response.Result, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// DoWithContext executes the request asynchronously via the worker pool.
|
||||||
|
// Returns result or error via channel. Respects context cancellation.
|
||||||
|
func (r TelegramRequest[R, P]) DoWithContext(ctx context.Context, api *API) (R, error) {
|
||||||
|
var zero R
|
||||||
|
|
||||||
|
resultChan, err := api.pool.submit(ctx, func(ctx context.Context) (any, error) {
|
||||||
|
return r.doRequest(ctx, api)
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return zero, err
|
||||||
|
}
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return zero, ctx.Err()
|
||||||
|
case res := <-resultChan:
|
||||||
|
if res.err != nil {
|
||||||
|
return zero, res.err
|
||||||
|
}
|
||||||
|
if val, ok := res.value.(R); ok {
|
||||||
|
return val, nil
|
||||||
|
}
|
||||||
|
return zero, ErrPoolUnexpected
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Do executes the request synchronously with a background context.
|
||||||
|
// Use only for simple, non-critical calls.
|
||||||
|
func (r TelegramRequest[R, P]) Do(api *API) (R, error) {
|
||||||
|
return r.DoWithContext(context.Background(), api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Internal helper that reads and caps a Telegram response body.
|
||||||
|
func readBody(body io.ReadCloser) ([]byte, error) {
|
||||||
|
reader := io.LimitReader(body, 10<<20) // 10 MB
|
||||||
|
return io.ReadAll(reader)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Internal helper that parses a typed Telegram API response body.
|
||||||
|
func parseBody[R any](data []byte) (TelegramResponse[R], error) {
|
||||||
|
var resp TelegramResponse[R]
|
||||||
|
err := json.Unmarshal(data, &resp)
|
||||||
|
if err != nil {
|
||||||
|
return resp, fmt.Errorf("failed to unmarshal JSON: %w", err)
|
||||||
|
}
|
||||||
|
return resp, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,90 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
type roundTripFunc func(*http.Request) (*http.Response, error)
|
||||||
|
|
||||||
|
func (fn roundTripFunc) RoundTrip(req *http.Request) (*http.Response, error) {
|
||||||
|
return fn(req)
|
||||||
|
}
|
||||||
|
|
||||||
|
type closingTransport struct {
|
||||||
|
roundTripFunc
|
||||||
|
closed bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *closingTransport) CloseIdleConnections() {
|
||||||
|
t.closed = true
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAPILeavesAcceptEncodingToHTTPTransport(t *testing.T) {
|
||||||
|
var gotPath string
|
||||||
|
var gotAcceptEncoding string
|
||||||
|
|
||||||
|
client := &http.Client{
|
||||||
|
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
gotPath = req.URL.Path
|
||||||
|
gotAcceptEncoding = req.Header.Get("Accept-Encoding")
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||||
|
Body: io.NopCloser(strings.NewReader(`{"ok":true,"result":{"id":1,"is_bot":true,"first_name":"Test"}}`)),
|
||||||
|
}, nil
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
|
||||||
|
api := NewAPI(
|
||||||
|
NewAPIOpts("token").
|
||||||
|
SetAPIURL("https://example.test").
|
||||||
|
SetHTTPClient(client),
|
||||||
|
)
|
||||||
|
defer func() {
|
||||||
|
if err := api.Close(); err != nil {
|
||||||
|
t.Fatalf("Close returned error: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
user, err := api.GetMe()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("GetMe returned error: %v", err)
|
||||||
|
}
|
||||||
|
if user.FirstName != "Test" {
|
||||||
|
t.Fatalf("unexpected first name: %q", user.FirstName)
|
||||||
|
}
|
||||||
|
if gotPath != "/bottoken/getMe" {
|
||||||
|
t.Fatalf("unexpected request path: %s", gotPath)
|
||||||
|
}
|
||||||
|
if gotAcceptEncoding != "" {
|
||||||
|
t.Fatalf("expected empty Accept-Encoding header, got %q", gotAcceptEncoding)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAPICloseClosesIdleConnections(t *testing.T) {
|
||||||
|
transport := &closingTransport{
|
||||||
|
roundTripFunc: func(req *http.Request) (*http.Response, error) {
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||||
|
Body: io.NopCloser(strings.NewReader(`{"ok":true,"result":{"id":1,"is_bot":true,"first_name":"Test"}}`)),
|
||||||
|
}, nil
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
api := NewAPI(
|
||||||
|
NewAPIOpts("token").
|
||||||
|
SetAPIURL("https://example.test").
|
||||||
|
SetHTTPClient(&http.Client{Transport: transport}),
|
||||||
|
)
|
||||||
|
|
||||||
|
if err := api.Close(); err != nil {
|
||||||
|
t.Fatalf("Close returned error: %v", err)
|
||||||
|
}
|
||||||
|
if !transport.closed {
|
||||||
|
t.Fatal("expected Close to close idle HTTP connections")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,362 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import "context"
|
||||||
|
|
||||||
|
// SendPhoto holds parameters for the sendPhoto method.
|
||||||
|
// See https://core.telegram.org/bots/api#sendphoto
|
||||||
|
type SendPhoto struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
Photo string `json:"photo"`
|
||||||
|
Caption string `json:"caption,omitempty"`
|
||||||
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
|
||||||
|
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||||
|
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||||
|
DisableNotifications bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendPhoto sends a photo.
|
||||||
|
// See https://core.telegram.org/bots/api#sendphoto
|
||||||
|
func (api *API) SendPhoto(params SendPhoto) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendPhoto", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendPhotoWithContext is the context-aware variant of SendPhoto.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#sendphoto
|
||||||
|
func (api *API) SendPhotoWithContext(ctx context.Context, params SendPhoto) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendPhoto", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendAudio holds parameters for the sendAudio method.
|
||||||
|
// See https://core.telegram.org/bots/api#sendaudio
|
||||||
|
type SendAudio struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
Audio string `json:"audio"`
|
||||||
|
Caption string `json:"caption,omitempty"`
|
||||||
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
Duration int `json:"duration,omitempty"`
|
||||||
|
Performer string `json:"performer,omitempty"`
|
||||||
|
Title string `json:"title,omitempty"`
|
||||||
|
Thumbnail string `json:"thumbnail,omitempty"`
|
||||||
|
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendAudio sends an audio file.
|
||||||
|
// See https://core.telegram.org/bots/api#sendaudio
|
||||||
|
func (api *API) SendAudio(params SendAudio) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendAudio", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendAudioWithContext is the context-aware variant of SendAudio.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#sendaudio
|
||||||
|
func (api *API) SendAudioWithContext(ctx context.Context, params SendAudio) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendAudio", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendDocument holds parameters for the sendDocument method.
|
||||||
|
// See https://core.telegram.org/bots/api#senddocument
|
||||||
|
type SendDocument struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
Document string `json:"document"`
|
||||||
|
Thumbnail string `json:"thumbnail,omitempty"`
|
||||||
|
Caption string `json:"caption,omitempty"`
|
||||||
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
DisableContentTypeDetection bool `json:"disable_content_type_detection,omitempty"`
|
||||||
|
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendDocument sends a document.
|
||||||
|
// See https://core.telegram.org/bots/api#senddocument
|
||||||
|
func (api *API) SendDocument(params SendDocument) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendDocument", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendDocumentWithContext is the context-aware variant of SendDocument.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#senddocument
|
||||||
|
func (api *API) SendDocumentWithContext(ctx context.Context, params SendDocument) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendDocument", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendVideo holds parameters for the sendVideo method.
|
||||||
|
// See https://core.telegram.org/bots/api#sendvideo
|
||||||
|
type SendVideo struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
Video string `json:"video"`
|
||||||
|
Thumbnail string `json:"thumbnail,omitempty"`
|
||||||
|
Duration int `json:"duration,omitempty"`
|
||||||
|
Width int `json:"width,omitempty"`
|
||||||
|
Height int `json:"height,omitempty"`
|
||||||
|
Cover string `json:"cover,omitempty"`
|
||||||
|
|
||||||
|
StartTimestamp int `json:"start_timestamp,omitempty"`
|
||||||
|
Caption string `json:"caption,omitempty"`
|
||||||
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
|
||||||
|
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||||
|
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||||
|
SupportsStreaming bool `json:"supports_streaming,omitempty"`
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendVideo sends a video.
|
||||||
|
// See https://core.telegram.org/bots/api#sendvideo
|
||||||
|
func (api *API) SendVideo(params SendVideo) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendVideo", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendVideoWithContext is the context-aware variant of SendVideo.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#sendvideo
|
||||||
|
func (api *API) SendVideoWithContext(ctx context.Context, params SendVideo) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendVideo", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendAnimation holds parameters for the sendAnimation method.
|
||||||
|
// See https://core.telegram.org/bots/api#sendanimation
|
||||||
|
type SendAnimation struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
Animation string `json:"animation"`
|
||||||
|
Thumbnail string `json:"thumbnail,omitempty"`
|
||||||
|
Duration int `json:"duration,omitempty"`
|
||||||
|
Width int `json:"width,omitempty"`
|
||||||
|
Height int `json:"height,omitempty"`
|
||||||
|
|
||||||
|
Caption string `json:"caption,omitempty"`
|
||||||
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||||
|
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendAnimation sends an animation file (GIF or H.264/MPEG-4 AVC video without sound).
|
||||||
|
// See https://core.telegram.org/bots/api#sendanimation
|
||||||
|
func (api *API) SendAnimation(params SendAnimation) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendAnimation", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendAnimationWithContext is the context-aware variant of SendAnimation.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#sendanimation
|
||||||
|
func (api *API) SendAnimationWithContext(ctx context.Context, params SendAnimation) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendAnimation", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendVoice holds parameters for the sendVoice method.
|
||||||
|
// See https://core.telegram.org/bots/api#sendvoice
|
||||||
|
type SendVoice struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
Voice string `json:"voice"`
|
||||||
|
Caption string `json:"caption,omitempty"`
|
||||||
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
Duration int `json:"duration,omitempty"`
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendVoice sends a voice note.
|
||||||
|
// See https://core.telegram.org/bots/api#sendvoice
|
||||||
|
func (api *API) SendVoice(params SendVoice) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendVoice", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendVoiceWithContext is the context-aware variant of SendVoice.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#sendvoice
|
||||||
|
func (api *API) SendVoiceWithContext(ctx context.Context, params SendVoice) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendVoice", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendVideoNote holds parameters for the sendVideoNote method.
|
||||||
|
// See https://core.telegram.org/bots/api#sendvideonote
|
||||||
|
type SendVideoNote struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
VideoNote string `json:"video_note"`
|
||||||
|
Thumbnail string `json:"thumbnail,omitempty"`
|
||||||
|
Duration int `json:"duration,omitempty"`
|
||||||
|
Length int `json:"length,omitempty"`
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendVideoNote sends a video note (rounded video message).
|
||||||
|
// See https://core.telegram.org/bots/api#sendvideonote
|
||||||
|
func (api *API) SendVideoNote(params SendVideoNote) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendVideoNote", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendVideoNoteWithContext is the context-aware variant of SendVideoNote.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#sendvideonote
|
||||||
|
func (api *API) SendVideoNoteWithContext(ctx context.Context, params SendVideoNote) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendVideoNote", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendPaidMedia holds parameters for the sendPaidMedia method.
|
||||||
|
// See https://core.telegram.org/bots/api#sendpaidmedia
|
||||||
|
type SendPaidMedia struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
StarCount int `json:"star_count,omitempty"`
|
||||||
|
|
||||||
|
Media []InputPaidMedia `json:"media"`
|
||||||
|
Payload string `json:"payload,omitempty"`
|
||||||
|
Caption string `json:"caption,omitempty"`
|
||||||
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
|
||||||
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendPaidMedia sends paid media.
|
||||||
|
// See https://core.telegram.org/bots/api#sendpaidmedia
|
||||||
|
func (api *API) SendPaidMedia(params SendPaidMedia) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendPaidMedia", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendPaidMediaWithContext is the context-aware variant of SendPaidMedia.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#sendpaidmedia
|
||||||
|
func (api *API) SendPaidMediaWithContext(ctx context.Context, params SendPaidMedia) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendPaidMedia", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendMediaGroup holds parameters for the sendMediaGroup method.
|
||||||
|
// See https://core.telegram.org/bots/api#sendmediagroup
|
||||||
|
type SendMediaGroup struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
Media []InputMedia `json:"media"`
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendMediaGroup sends a group of photos, videos, documents or audios as an album.
|
||||||
|
// See https://core.telegram.org/bots/api#sendmediagroup
|
||||||
|
func (api *API) SendMediaGroup(params SendMediaGroup) ([]Message, error) {
|
||||||
|
req := NewRequestWithChatID[[]Message]("sendMediaGroup", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendMediaGroupWithContext is the context-aware variant of SendMediaGroup.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#sendmediagroup
|
||||||
|
func (api *API) SendMediaGroupWithContext(ctx context.Context, params SendMediaGroup) ([]Message, error) {
|
||||||
|
req := NewRequestWithChatID[[]Message]("sendMediaGroup", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
@@ -0,0 +1,322 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
type Animation struct {
|
||||||
|
FileID string `json:"file_id"`
|
||||||
|
FileUniqueID string `json:"file_unique_id"`
|
||||||
|
Width int `json:"width"`
|
||||||
|
Height int `json:"height"`
|
||||||
|
Duration int `json:"duration"`
|
||||||
|
|
||||||
|
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||||
|
FileName string `json:"file_name"`
|
||||||
|
MimeType string `json:"mime_type"`
|
||||||
|
FileSize int `json:"file_size"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Audio represents an audio file to be treated as music by the Telegram clients.
|
||||||
|
// See https://core.telegram.org/bots/api#audio
|
||||||
|
type Audio struct {
|
||||||
|
FileID string `json:"file_id"`
|
||||||
|
FileUniqueID string `json:"file_unique_id"`
|
||||||
|
Duration int `json:"duration"`
|
||||||
|
|
||||||
|
Performer string `json:"performer,omitempty"`
|
||||||
|
Title string `json:"title,omitempty"`
|
||||||
|
FileName string `json:"file_name,omitempty"`
|
||||||
|
MimeType string `json:"mime_type,omitempty"`
|
||||||
|
FileSize int64 `json:"file_size,omitempty"`
|
||||||
|
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type Document struct {
|
||||||
|
FileID string `json:"file_id"`
|
||||||
|
FileUniqueID string `json:"file_unique_id"`
|
||||||
|
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||||
|
FileName string `json:"file_name"`
|
||||||
|
MimeType string `json:"mime_type"`
|
||||||
|
FileSize int `json:"file_size,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Story represents a story.
|
||||||
|
type Story struct {
|
||||||
|
Chat Chat `json:"chat"`
|
||||||
|
ID int `json:"id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type Video struct {
|
||||||
|
FileID string `json:"file_id"`
|
||||||
|
FileUniqueID string `json:"file_unique_id"`
|
||||||
|
Width int `json:"width"`
|
||||||
|
Height int `json:"height"`
|
||||||
|
Duration int `json:"duration"`
|
||||||
|
|
||||||
|
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||||
|
Cover []PhotoSize `json:"cover,omitempty"`
|
||||||
|
StartTimestamp int64 `json:"start_timestamp"`
|
||||||
|
Qualities []VideoQuality `json:"qualities,omitempty"`
|
||||||
|
FileName string `json:"file_name,omitempty"`
|
||||||
|
MimeType string `json:"mime_type,omitempty"`
|
||||||
|
FileSize int64 `json:"file_size,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// VideoQuality describes an alternative quality for a video.
|
||||||
|
// See https://core.telegram.org/bots/api#videoquality
|
||||||
|
type VideoQuality struct {
|
||||||
|
FileID string `json:"file_id"`
|
||||||
|
FileUniqueID string `json:"file_unique_id"`
|
||||||
|
Width int `json:"width"`
|
||||||
|
Height int `json:"height"`
|
||||||
|
Codec string `json:"codec"`
|
||||||
|
FileSize int64 `json:"file_size,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type VideoNote struct {
|
||||||
|
FileID string `json:"file_id"`
|
||||||
|
FileUniqueID string `json:"file_unique_id"`
|
||||||
|
Length int `json:"length"`
|
||||||
|
Duration int `json:"duration"`
|
||||||
|
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||||
|
FileSize int64 `json:"file_size,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type Voice struct {
|
||||||
|
FileID string `json:"file_id"`
|
||||||
|
FileUniqueID string `json:"file_unique_id"`
|
||||||
|
Duration int `json:"duration"`
|
||||||
|
MimeType string `json:"mime_type,omitempty"`
|
||||||
|
FileSize int `json:"file_size,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type PaidMediaInfo struct {
|
||||||
|
StarCount int `json:"star_count"`
|
||||||
|
PaidMedia []PaidMedia `json:"paid_media"`
|
||||||
|
}
|
||||||
|
type PaidMediaType string
|
||||||
|
|
||||||
|
const (
|
||||||
|
PaidMediaPreviewType PaidMediaType = "preview"
|
||||||
|
PaidMediaPhotoType PaidMediaType = "photo"
|
||||||
|
PaidMediaVideoType PaidMediaType = "video"
|
||||||
|
)
|
||||||
|
|
||||||
|
type PaidMedia struct {
|
||||||
|
Type PaidMediaType `json:"type,omitempty"`
|
||||||
|
|
||||||
|
Width int `json:"width,omitempty"`
|
||||||
|
Height int `json:"height,omitempty"`
|
||||||
|
Duration int `json:"duration,omitempty"`
|
||||||
|
|
||||||
|
Photo []PhotoSize `json:"photo,omitempty"`
|
||||||
|
|
||||||
|
Video *Video `json:"video,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type Contact struct {
|
||||||
|
PhoneNumber string `json:"phone_number"`
|
||||||
|
FirstName string `json:"first_name"`
|
||||||
|
LastName string `json:"last_name,omitempty"`
|
||||||
|
UserID int64 `json:"user_id,omitempty"`
|
||||||
|
Vcard string `json:"vcard,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type Dice struct {
|
||||||
|
Emoji string `json:"emoji"`
|
||||||
|
Value int `json:"value"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// PollOption contains information about one answer option in a poll.
|
||||||
|
// See https://core.telegram.org/bots/api#polloption
|
||||||
|
type PollOption struct {
|
||||||
|
PersistentID string `json:"persistent_id"`
|
||||||
|
Text string `json:"text"`
|
||||||
|
TextEntities []MessageEntity `json:"text_entities"`
|
||||||
|
VoterCount int `json:"voter_count"`
|
||||||
|
|
||||||
|
AddedByUser *User `json:"added_by_user,omitempty"`
|
||||||
|
AddedByChat *Chat `json:"added_by_chat,omitempty"`
|
||||||
|
AdditionDate int `json:"addition_date,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// InputPollOption contains information about one answer option in a poll to be sent.
|
||||||
|
// See https://core.telegram.org/bots/api#inputpolloption
|
||||||
|
type InputPollOption struct {
|
||||||
|
Text string `json:"text"`
|
||||||
|
TextParseMode ParseMode `json:"text_parse_mode,omitempty"`
|
||||||
|
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type PollOptionAdded struct {
|
||||||
|
PollMessage *InaccessibleMessage `json:"poll_message,omitempty"`
|
||||||
|
OptionPersistentID string `json:"option_persistent_id"`
|
||||||
|
OptionText string `json:"option_text"`
|
||||||
|
OptionTextEntities []MessageEntity `json:"option_text_entities,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type PollOptionDeleted struct {
|
||||||
|
PollMessage *InaccessibleMessage `json:"poll_message,omitempty"`
|
||||||
|
OptionPersistentID string `json:"option_persistent_id"`
|
||||||
|
OptionText string `json:"option_text"`
|
||||||
|
OptionTextEntities []MessageEntity `json:"option_text_entities,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// PollType represents the type of a poll.
|
||||||
|
type PollType string
|
||||||
|
|
||||||
|
const (
|
||||||
|
// PollTypeRegular identifies a regular poll.
|
||||||
|
PollTypeRegular PollType = "regular"
|
||||||
|
// PollTypeQuiz identifies a quiz poll.
|
||||||
|
PollTypeQuiz PollType = "quiz"
|
||||||
|
)
|
||||||
|
|
||||||
|
// PollAnswer represents an answer of a user in a poll.
|
||||||
|
// See https://core.telegram.org/bots/api#pollanswer
|
||||||
|
type PollAnswer struct {
|
||||||
|
PollID string `json:"poll_id"`
|
||||||
|
VoterChat Chat `json:"voter_chat"`
|
||||||
|
User User `json:"user"`
|
||||||
|
OptionIDs []int `json:"option_ids"`
|
||||||
|
OptionPersistentIDs []string `json:"option_persistent_ids"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Poll contains information about a poll.
|
||||||
|
// See https://core.telegram.org/bots/api#poll
|
||||||
|
type Poll struct {
|
||||||
|
ID string `json:"id"`
|
||||||
|
Question string `json:"question"`
|
||||||
|
QuestionEntities []MessageEntity `json:"question_entities"`
|
||||||
|
Options []PollOption `json:"options"`
|
||||||
|
TotalVoterCount int `json:"total_voter_count"`
|
||||||
|
IsClosed bool `json:"is_closed"`
|
||||||
|
IsAnonymous bool `json:"is_anonymous"`
|
||||||
|
Type PollType `json:"type"`
|
||||||
|
|
||||||
|
AllowsMultipleAnswers bool `json:"allows_multiple_answers"`
|
||||||
|
AllowsRevoting bool `json:"allows_revoting"`
|
||||||
|
CorrectOptionIDs []int `json:"correct_option_ids,omitempty"`
|
||||||
|
Explanation string `json:"explanation,omitempty"`
|
||||||
|
ExplanationEntities []MessageEntity `json:"explanation_entities,omitempty"`
|
||||||
|
OpenPeriod int `json:"open_period,omitempty"`
|
||||||
|
CloseDate int `json:"close_date,omitempty"`
|
||||||
|
Description string `json:"description,omitempty"`
|
||||||
|
DescriptionEntities []MessageEntity `json:"description_entities,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type ChecklistTask struct {
|
||||||
|
ID int `json:"id"`
|
||||||
|
Text string `json:"text"`
|
||||||
|
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
||||||
|
CompletedByUser *User `json:"completed_by_user,omitempty"`
|
||||||
|
CompletedByChat *Chat `json:"completed_by_chat,omitempty"`
|
||||||
|
CompletionDate int `json:"completion_date,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type Checklist struct {
|
||||||
|
Title string `json:"title"`
|
||||||
|
TitleEntities []MessageEntity `json:"title_entities,omitempty"`
|
||||||
|
Tasks []ChecklistTask `json:"tasks"`
|
||||||
|
OthersCanAddTasks bool `json:"others_can_add_tasks,omitempty"`
|
||||||
|
OthersCanMarkTasksAsDone bool `json:"others_can_mark_tasks_as_done,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// InputChecklistTask describes a task in a checklist.
|
||||||
|
type InputChecklistTask struct {
|
||||||
|
ID int `json:"id"`
|
||||||
|
Text string `json:"text"`
|
||||||
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// InputChecklist represents a checklist to be sent.
|
||||||
|
type InputChecklist struct {
|
||||||
|
Title string `json:"title"`
|
||||||
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
TitleEntities []MessageEntity `json:"title_entities,omitempty"`
|
||||||
|
Tasks []InputChecklistTask `json:"tasks"`
|
||||||
|
OtherCanAddTasks bool `json:"other_can_add_tasks,omitempty"`
|
||||||
|
OtherCanMarkTasksAsDone bool `json:"other_can_mark_tasks_as_done,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type ChecklistTaskDone struct {
|
||||||
|
ChecklistMessage *Message `json:"checklist_message,omitempty"`
|
||||||
|
MarkedAsDoneTaskIDs []int `json:"marked_as_done_task_ids,omitempty"`
|
||||||
|
MarkedAsNotDoneTaskIDs []int `json:"marked_as_not_done_task_ids,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type ChecklistTasksAdded struct {
|
||||||
|
ChecklistMessage *Message `json:"checklist_message,omitempty"`
|
||||||
|
Tasks []ChecklistTask `json:"tasks"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// InputMediaType represents the type of input media.
|
||||||
|
type InputMediaType string
|
||||||
|
|
||||||
|
const (
|
||||||
|
// InputMediaTypeAnimation is a GIF or H.264/MPEG-4 AVC video without sound.
|
||||||
|
InputMediaTypeAnimation InputMediaType = "animation"
|
||||||
|
// InputMediaTypeDocument is a general file.
|
||||||
|
InputMediaTypeDocument InputMediaType = "document"
|
||||||
|
// InputMediaTypePhoto is a photo.
|
||||||
|
InputMediaTypePhoto InputMediaType = "photo"
|
||||||
|
// InputMediaTypeVideo is a video.
|
||||||
|
InputMediaTypeVideo InputMediaType = "video"
|
||||||
|
// InputMediaTypeAudio is an audio file.
|
||||||
|
InputMediaTypeAudio InputMediaType = "audio"
|
||||||
|
)
|
||||||
|
|
||||||
|
// InputMedia represents the content of a media message to be sent.
|
||||||
|
// It is a union type described in https://core.telegram.org/bots/api#inputmedia.
|
||||||
|
type InputMedia struct {
|
||||||
|
Type InputMediaType `json:"type"`
|
||||||
|
Media string `json:"media"`
|
||||||
|
|
||||||
|
Caption *string `json:"caption,omitempty"`
|
||||||
|
ParseMode *ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"`
|
||||||
|
HasSpoiler *bool `json:"has_spoiler,omitempty"`
|
||||||
|
|
||||||
|
Cover *string `json:"cover"`
|
||||||
|
StartTimestamp *int `json:"start_timestamp"`
|
||||||
|
Width *int `json:"width,omitempty"`
|
||||||
|
Height *int `json:"height,omitempty"`
|
||||||
|
Duration *int `json:"duration,omitempty"`
|
||||||
|
SupportsStreaming *bool `json:"supports_streaming,omitempty"`
|
||||||
|
|
||||||
|
Performer *string `json:"performer,omitempty"`
|
||||||
|
Title *string `json:"title,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// InputPaidMediaType represents the type of paid media.
|
||||||
|
type InputPaidMediaType string
|
||||||
|
|
||||||
|
const (
|
||||||
|
// InputPaidMediaTypeVideo represents a paid video.
|
||||||
|
InputPaidMediaTypeVideo InputPaidMediaType = "video"
|
||||||
|
// InputPaidMediaTypePhoto represents a paid photo.
|
||||||
|
InputPaidMediaTypePhoto InputPaidMediaType = "photo"
|
||||||
|
)
|
||||||
|
|
||||||
|
// InputPaidMedia describes the paid media to be sent.
|
||||||
|
// See https://core.telegram.org/bots/api#inputpaidmedia
|
||||||
|
type InputPaidMedia struct {
|
||||||
|
Type InputPaidMediaType `json:"type"`
|
||||||
|
Media string `json:"media"`
|
||||||
|
|
||||||
|
Cover *string `json:"cover,omitempty"`
|
||||||
|
StartTimestamp *int64 `json:"start_timestamp,omitempty"`
|
||||||
|
Width *int `json:"width,omitempty"`
|
||||||
|
Height *int `json:"height,omitempty"`
|
||||||
|
Duration *int `json:"duration,omitempty"`
|
||||||
|
SupportsStreaming *bool `json:"supports_streaming,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// PhotoSize represents one size of a photo or a file/sticker thumbnail.
|
||||||
|
// See https://core.telegram.org/bots/api#photosize
|
||||||
|
type PhotoSize struct {
|
||||||
|
FileID string `json:"file_id"`
|
||||||
|
FileUniqueID string `json:"file_unique_id"`
|
||||||
|
Width int `json:"width"`
|
||||||
|
Height int `json:"height"`
|
||||||
|
FileSize int64 `json:"file_size,omitempty"`
|
||||||
|
}
|
||||||
@@ -0,0 +1,400 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import "context"
|
||||||
|
|
||||||
|
// SetMyCommands holds parameters for the setMyCommands method.
|
||||||
|
// See https://core.telegram.org/bots/api#setmycommands
|
||||||
|
type SetMyCommands struct {
|
||||||
|
Commands []BotCommand `json:"commands"`
|
||||||
|
Scope *BotCommandScope `json:"scope,omitempty"`
|
||||||
|
Language string `json:"language_code,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetMyCommands changes the list of the bot's commands.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setmycommands
|
||||||
|
func (api *API) SetMyCommands(params SetMyCommands) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setMyCommands", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetMyCommandsWithContext is the context-aware variant of SetMyCommands.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setmycommands
|
||||||
|
func (api *API) SetMyCommandsWithContext(ctx context.Context, params SetMyCommands) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setMyCommands", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteMyCommands holds parameters for the deleteMyCommands method.
|
||||||
|
// See https://core.telegram.org/bots/api#deletemycommands
|
||||||
|
type DeleteMyCommands struct {
|
||||||
|
Scope *BotCommandScope `json:"scope,omitempty"`
|
||||||
|
Language string `json:"language_code,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteMyCommands deletes the list of the bot's commands for the given scope and user language.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#deletemycommands
|
||||||
|
func (api *API) DeleteMyCommands(params DeleteMyCommands) (bool, error) {
|
||||||
|
req := NewRequest[bool]("deleteMyCommands", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteMyCommandsWithContext is the context-aware variant of DeleteMyCommands.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#deletemycommands
|
||||||
|
func (api *API) DeleteMyCommandsWithContext(ctx context.Context, params DeleteMyCommands) (bool, error) {
|
||||||
|
req := NewRequest[bool]("deleteMyCommands", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetMyCommands holds parameters for the getMyCommands method.
|
||||||
|
// See https://core.telegram.org/bots/api#getmycommands
|
||||||
|
type GetMyCommands struct {
|
||||||
|
Scope *BotCommandScope `json:"scope,omitempty"`
|
||||||
|
Language string `json:"language_code,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetMyCommands returns the current list of the bot's commands for the given scope and user language.
|
||||||
|
// See https://core.telegram.org/bots/api#getmycommands
|
||||||
|
func (api *API) GetMyCommands(params GetMyCommands) ([]BotCommand, error) {
|
||||||
|
req := NewRequest[[]BotCommand]("getMyCommands", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetMyCommandsWithContext is the context-aware variant of GetMyCommands.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getmycommands
|
||||||
|
func (api *API) GetMyCommandsWithContext(ctx context.Context, params GetMyCommands) ([]BotCommand, error) {
|
||||||
|
req := NewRequest[[]BotCommand]("getMyCommands", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetMyName holds parameters for the setMyName method.
|
||||||
|
// See https://core.telegram.org/bots/api#setmyname
|
||||||
|
type SetMyName struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Language string `json:"language_code,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetMyName changes the bot's name.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setmyname
|
||||||
|
func (api *API) SetMyName(params SetMyName) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setMyName", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetMyNameWithContext is the context-aware variant of SetMyName.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setmyname
|
||||||
|
func (api *API) SetMyNameWithContext(ctx context.Context, params SetMyName) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setMyName", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetMyName holds parameters for the getMyName method.
|
||||||
|
// See https://core.telegram.org/bots/api#getmyname
|
||||||
|
type GetMyName struct {
|
||||||
|
Language string `json:"language_code,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetMyName returns the bot's name for the given language.
|
||||||
|
// See https://core.telegram.org/bots/api#getmyname
|
||||||
|
func (api *API) GetMyName(params GetMyName) (BotName, error) {
|
||||||
|
req := NewRequest[BotName]("getMyName", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetMyNameWithContext is the context-aware variant of GetMyName.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getmyname
|
||||||
|
func (api *API) GetMyNameWithContext(ctx context.Context, params GetMyName) (BotName, error) {
|
||||||
|
req := NewRequest[BotName]("getMyName", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetMyDescription holds parameters for the setMyDescription method.
|
||||||
|
// See https://core.telegram.org/bots/api#setmydescription
|
||||||
|
type SetMyDescription struct {
|
||||||
|
Description string `json:"description"`
|
||||||
|
Language string `json:"language_code,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetMyDescription changes the bot's description.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setmydescription
|
||||||
|
func (api *API) SetMyDescription(params SetMyDescription) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setMyDescription", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetMyDescriptionWithContext is the context-aware variant of SetMyDescription.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setmydescription
|
||||||
|
func (api *API) SetMyDescriptionWithContext(ctx context.Context, params SetMyDescription) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setMyDescription", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetMyDescription holds parameters for the getMyDescription method.
|
||||||
|
// See https://core.telegram.org/bots/api#getmydescription
|
||||||
|
type GetMyDescription struct {
|
||||||
|
Language string `json:"language_code,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetMyDescription returns the bot's description for the given language.
|
||||||
|
// See https://core.telegram.org/bots/api#getmydescription
|
||||||
|
func (api *API) GetMyDescription(params GetMyDescription) (BotDescription, error) {
|
||||||
|
req := NewRequest[BotDescription]("getMyDescription", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetMyDescriptionWithContext is the context-aware variant of GetMyDescription.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getmydescription
|
||||||
|
func (api *API) GetMyDescriptionWithContext(ctx context.Context, params GetMyDescription) (BotDescription, error) {
|
||||||
|
req := NewRequest[BotDescription]("getMyDescription", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetMyShortDescription holds parameters for the setMyShortDescription method.
|
||||||
|
// See https://core.telegram.org/bots/api#setmyshortdescription
|
||||||
|
type SetMyShortDescription struct {
|
||||||
|
ShortDescription string `json:"short_description,omitempty"`
|
||||||
|
Language string `json:"language_code,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetMyShortDescription changes the bot's short description.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setmyshortdescription
|
||||||
|
func (api *API) SetMyShortDescription(params SetMyShortDescription) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setMyShortDescription", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetMyShortDescriptionWithContext is the context-aware variant of SetMyShortDescription.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setmyshortdescription
|
||||||
|
func (api *API) SetMyShortDescriptionWithContext(ctx context.Context, params SetMyShortDescription) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setMyShortDescription", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetMyShortDescription holds parameters for the getMyShortDescription method.
|
||||||
|
// See https://core.telegram.org/bots/api#getmyshortdescription
|
||||||
|
type GetMyShortDescription struct {
|
||||||
|
Language string `json:"language_code,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetMyShortDescription returns the bot's short description for the given language.
|
||||||
|
// See https://core.telegram.org/bots/api#getmyshortdescription
|
||||||
|
func (api *API) GetMyShortDescription(params GetMyShortDescription) (BotShortDescription, error) {
|
||||||
|
req := NewRequest[BotShortDescription]("getMyShortDescription", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetMyShortDescriptionWithContext is the context-aware variant of GetMyShortDescription.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getmyshortdescription
|
||||||
|
func (api *API) GetMyShortDescriptionWithContext(ctx context.Context, params GetMyShortDescription) (BotShortDescription, error) {
|
||||||
|
req := NewRequest[BotShortDescription]("getMyShortDescription", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetMyProfilePhoto holds parameters for the setMyProfilePhoto method.
|
||||||
|
// See https://core.telegram.org/bots/api#setmyprofilephoto
|
||||||
|
type SetMyProfilePhoto struct {
|
||||||
|
Photo InputProfilePhoto `json:"photo"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetMyProfilePhoto changes the bot's profile photo.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setmyprofilephoto
|
||||||
|
func (api *API) SetMyProfilePhoto(params SetMyProfilePhoto) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setMyProfilePhoto", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetMyProfilePhotoWithContext is the context-aware variant of SetMyProfilePhoto.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setmyprofilephoto
|
||||||
|
func (api *API) SetMyProfilePhotoWithContext(ctx context.Context, params SetMyProfilePhoto) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setMyProfilePhoto", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RemoveMyProfilePhoto removes the bot's profile photo.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#removemyprofilephoto
|
||||||
|
func (api *API) RemoveMyProfilePhoto() (bool, error) {
|
||||||
|
req := NewRequest[bool]("removeMyProfilePhoto", NoParams)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RemoveMyProfilePhotoWithContext is the context-aware variant of RemoveMyProfilePhoto.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#removemyprofilephoto
|
||||||
|
func (api *API) RemoveMyProfilePhotoWithContext(ctx context.Context) (bool, error) {
|
||||||
|
req := NewRequest[bool]("removeMyProfilePhoto", NoParams)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChatMenuButton holds parameters for the setChatMenuButton method.
|
||||||
|
// See https://core.telegram.org/bots/api#setchatmenubutton
|
||||||
|
type SetChatMenuButton struct {
|
||||||
|
ChatID int64 `json:"chat_id,omitempty"`
|
||||||
|
MenuButton *MenuButton `json:"menu_button,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChatMenuButton changes the menu button for a given chat or the default menu button.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setchatmenubutton
|
||||||
|
func (api *API) SetChatMenuButton(params SetChatMenuButton) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setChatMenuButton", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChatMenuButtonWithContext is the context-aware variant of SetChatMenuButton.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setchatmenubutton
|
||||||
|
func (api *API) SetChatMenuButtonWithContext(ctx context.Context, params SetChatMenuButton) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setChatMenuButton", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetChatMenuButton holds parameters for the getChatMenuButton method.
|
||||||
|
// See https://core.telegram.org/bots/api#getchatmenubutton
|
||||||
|
type GetChatMenuButton struct {
|
||||||
|
ChatID int64 `json:"chat_id,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetChatMenuButton returns the current menu button for the given chat.
|
||||||
|
// See https://core.telegram.org/bots/api#getchatmenubutton
|
||||||
|
func (api *API) GetChatMenuButton(params GetChatMenuButton) (MenuButton, error) {
|
||||||
|
req := NewRequest[MenuButton]("getChatMenuButton", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetChatMenuButtonWithContext is the context-aware variant of GetChatMenuButton.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getchatmenubutton
|
||||||
|
func (api *API) GetChatMenuButtonWithContext(ctx context.Context, params GetChatMenuButton) (MenuButton, error) {
|
||||||
|
req := NewRequest[MenuButton]("getChatMenuButton", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetMyDefaultAdministratorRights holds parameters for the setMyDefaultAdministratorRights method.
|
||||||
|
// See https://core.telegram.org/bots/api#setmydefaultadministratorrights
|
||||||
|
type SetMyDefaultAdministratorRights struct {
|
||||||
|
Rights *ChatAdministratorRights `json:"rights"`
|
||||||
|
ForChannels bool `json:"for_channels"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetMyDefaultAdministratorRights changes the default administrator rights for the bot.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setmydefaultadministratorrights
|
||||||
|
func (api *API) SetMyDefaultAdministratorRights(params SetMyDefaultAdministratorRights) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setMyDefaultAdministratorRights", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetMyDefaultAdministratorRightsWithContext is the context-aware variant of SetMyDefaultAdministratorRights.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setmydefaultadministratorrights
|
||||||
|
func (api *API) SetMyDefaultAdministratorRightsWithContext(ctx context.Context, params SetMyDefaultAdministratorRights) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setMyDefaultAdministratorRights", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetMyDefaultAdministratorRights holds parameters for the getMyDefaultAdministratorRights method.
|
||||||
|
// See https://core.telegram.org/bots/api#getmydefaultadministratorrights
|
||||||
|
type GetMyDefaultAdministratorRights struct {
|
||||||
|
ForChannels bool `json:"for_channels"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetMyDefaultAdministratorRights returns the current default administrator rights for the bot.
|
||||||
|
// See https://core.telegram.org/bots/api#getmydefaultadministratorrights
|
||||||
|
func (api *API) GetMyDefaultAdministratorRights(params GetMyDefaultAdministratorRights) (ChatAdministratorRights, error) {
|
||||||
|
req := NewRequest[ChatAdministratorRights]("getMyDefaultAdministratorRights", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetMyDefaultAdministratorRightsWithContext is the context-aware variant of GetMyDefaultAdministratorRights.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getmydefaultadministratorrights
|
||||||
|
func (api *API) GetMyDefaultAdministratorRightsWithContext(ctx context.Context, params GetMyDefaultAdministratorRights) (ChatAdministratorRights, error) {
|
||||||
|
req := NewRequest[ChatAdministratorRights]("getMyDefaultAdministratorRights", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetAvailableGifts returns the list of gifts that can be sent by the bot.
|
||||||
|
// See https://core.telegram.org/bots/api#getavailablegifts
|
||||||
|
func (api *API) GetAvailableGifts() (Gifts, error) {
|
||||||
|
req := NewRequest[Gifts]("getAvailableGifts", NoParams)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetAvailableGiftsWithContext is the context-aware variant of GetAvailableGifts.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getavailablegifts
|
||||||
|
func (api *API) GetAvailableGiftsWithContext(ctx context.Context) (Gifts, error) {
|
||||||
|
req := NewRequest[Gifts]("getAvailableGifts", NoParams)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendGift holds parameters for the sendGift method.
|
||||||
|
// See https://core.telegram.org/bots/api#sendgift
|
||||||
|
type SendGift struct {
|
||||||
|
UserID int64 `json:"user_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id,omitempty"`
|
||||||
|
GiftID string `json:"gift_id"`
|
||||||
|
PayForUpgrade bool `json:"pay_for_upgrade"`
|
||||||
|
Text string `json:"text"`
|
||||||
|
TextParseMode ParseMode `json:"text_parse_mode,omitempty"`
|
||||||
|
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendGift sends a gift to the given user or chat.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#sendgift
|
||||||
|
func (api *API) SendGift(params SendGift) (bool, error) {
|
||||||
|
req := NewRequest[bool]("sendGift", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendGiftWithContext is the context-aware variant of SendGift.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#sendgift
|
||||||
|
func (api *API) SendGiftWithContext(ctx context.Context, params SendGift) (bool, error) {
|
||||||
|
req := NewRequest[bool]("sendGift", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GiftPremiumSubscription holds parameters for the giftPremiumSubscription method.
|
||||||
|
// See https://core.telegram.org/bots/api#giftpremiumsubscription
|
||||||
|
type GiftPremiumSubscription struct {
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
MonthCount int `json:"month_count"`
|
||||||
|
StarCount int `json:"star_count"`
|
||||||
|
Text string `json:"text,omitempty"`
|
||||||
|
TextParseMode ParseMode `json:"text_parse_mode,omitempty"`
|
||||||
|
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GiftPremiumSubscription gifts a Telegram Premium subscription to the user.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#giftpremiumsubscription
|
||||||
|
func (api *API) GiftPremiumSubscription(params GiftPremiumSubscription) (bool, error) {
|
||||||
|
req := NewRequest[bool]("giftPremiumSubscription", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GiftPremiumSubscriptionWithContext is the context-aware variant of GiftPremiumSubscription.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#giftpremiumsubscription
|
||||||
|
func (api *API) GiftPremiumSubscriptionWithContext(ctx context.Context, params GiftPremiumSubscription) (bool, error) {
|
||||||
|
req := NewRequest[bool]("giftPremiumSubscription", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
@@ -0,0 +1,96 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
// BotCommand represents a bot command.
|
||||||
|
// See https://core.telegram.org/bots/api#botcommand
|
||||||
|
type BotCommand struct {
|
||||||
|
Command string `json:"command"`
|
||||||
|
Description string `json:"description"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// BotCommandScopeType indicates the type of a command scope.
|
||||||
|
type BotCommandScopeType string
|
||||||
|
|
||||||
|
const (
|
||||||
|
// BotCommandScopeDefaultType is the default command scope.
|
||||||
|
BotCommandScopeDefaultType BotCommandScopeType = "default"
|
||||||
|
// BotCommandScopePrivateType covers all private chats.
|
||||||
|
BotCommandScopePrivateType BotCommandScopeType = "all_private_chats"
|
||||||
|
// BotCommandScopeGroupType covers all group and supergroup chats.
|
||||||
|
BotCommandScopeGroupType BotCommandScopeType = "all_group_chats"
|
||||||
|
// BotCommandScopeAllChatAdministratorsType covers all chat administrators.
|
||||||
|
BotCommandScopeAllChatAdministratorsType BotCommandScopeType = "all_chat_administrators"
|
||||||
|
// BotCommandScopeChatType covers a specific chat.
|
||||||
|
BotCommandScopeChatType BotCommandScopeType = "chat"
|
||||||
|
// BotCommandScopeChatAdministratorsType covers administrators of a specific chat.
|
||||||
|
BotCommandScopeChatAdministratorsType BotCommandScopeType = "chat_administrators"
|
||||||
|
// BotCommandScopeChatMemberType covers a specific member of a specific chat.
|
||||||
|
BotCommandScopeChatMemberType BotCommandScopeType = "chat_member"
|
||||||
|
)
|
||||||
|
|
||||||
|
// BotCommandScope represents the scope to which bot commands are applied.
|
||||||
|
// See https://core.telegram.org/bots/api#botcommandscope
|
||||||
|
type BotCommandScope struct {
|
||||||
|
Type BotCommandScopeType `json:"type"`
|
||||||
|
ChatID *int64 `json:"chat_id,omitempty"`
|
||||||
|
UserID *int64 `json:"user_id,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// BotName represents the bot's name.
|
||||||
|
type BotName struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// BotDescription represents the bot's description.
|
||||||
|
type BotDescription struct {
|
||||||
|
Description string `json:"description"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// BotShortDescription represents the bot's short description.
|
||||||
|
type BotShortDescription struct {
|
||||||
|
ShortDescription string `json:"short_description"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// InputProfilePhotoType indicates the type of a profile photo input.
|
||||||
|
type InputProfilePhotoType string
|
||||||
|
|
||||||
|
const (
|
||||||
|
// InputProfilePhotoStaticType identifies a static profile photo input.
|
||||||
|
InputProfilePhotoStaticType InputProfilePhotoType = "static"
|
||||||
|
// InputProfilePhotoAnimatedType identifies an animated profile photo input.
|
||||||
|
InputProfilePhotoAnimatedType InputProfilePhotoType = "animated"
|
||||||
|
)
|
||||||
|
|
||||||
|
// InputProfilePhoto describes a profile photo to set.
|
||||||
|
// See https://core.telegram.org/bots/api#inputprofilephoto
|
||||||
|
type InputProfilePhoto struct {
|
||||||
|
Type InputProfilePhotoType `json:"type"`
|
||||||
|
|
||||||
|
// Static fields (for static photos)
|
||||||
|
Photo *string `json:"photo,omitempty"`
|
||||||
|
|
||||||
|
// Animated fields (for animated profile videos)
|
||||||
|
Animation *string `json:"animation,omitempty"`
|
||||||
|
MainFrameTimestamp *float64 `json:"main_frame_timestamp,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// MenuButtonType indicates the type of a menu button.
|
||||||
|
type MenuButtonType string
|
||||||
|
|
||||||
|
const (
|
||||||
|
// MenuButtonCommandsType identifies a commands menu button.
|
||||||
|
MenuButtonCommandsType MenuButtonType = "commands"
|
||||||
|
// MenuButtonWebAppType identifies a web app menu button.
|
||||||
|
MenuButtonWebAppType MenuButtonType = "web_app"
|
||||||
|
// MenuButtonDefaultType identifies Telegram's default menu button.
|
||||||
|
MenuButtonDefaultType MenuButtonType = "default"
|
||||||
|
)
|
||||||
|
|
||||||
|
// MenuButton represents a menu button.
|
||||||
|
// See https://core.telegram.org/bots/api#menubutton
|
||||||
|
type MenuButton struct {
|
||||||
|
Type MenuButtonType `json:"type"`
|
||||||
|
|
||||||
|
// WebApp fields (for web_app button)
|
||||||
|
Text *string `json:"text"`
|
||||||
|
WebApp *WebAppInfo `json:"web_app"`
|
||||||
|
}
|
||||||
@@ -0,0 +1,560 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import "context"
|
||||||
|
|
||||||
|
// VerifyUser holds parameters for the verifyUser method.
|
||||||
|
// See https://core.telegram.org/bots/api#verifyuser
|
||||||
|
type VerifyUser struct {
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
CustomDescription string `json:"custom_description,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// VerifyUser verifies a user.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#verifyuser
|
||||||
|
func (api *API) VerifyUser(params VerifyUser) (bool, error) {
|
||||||
|
req := NewRequest[bool]("verifyUser", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// VerifyUserWithContext is the context-aware variant of VerifyUser.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#verifyuser
|
||||||
|
func (api *API) VerifyUserWithContext(ctx context.Context, params VerifyUser) (bool, error) {
|
||||||
|
req := NewRequest[bool]("verifyUser", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// VerifyChat holds parameters for the verifyChat method.
|
||||||
|
// See https://core.telegram.org/bots/api#verifychat
|
||||||
|
type VerifyChat struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
CustomDescription string `json:"custom_description,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// VerifyChat verifies a chat.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#verifychat
|
||||||
|
func (api *API) VerifyChat(params VerifyChat) (bool, error) {
|
||||||
|
req := NewRequest[bool]("verifyChat", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// VerifyChatWithContext is the context-aware variant of VerifyChat.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#verifychat
|
||||||
|
func (api *API) VerifyChatWithContext(ctx context.Context, params VerifyChat) (bool, error) {
|
||||||
|
req := NewRequest[bool]("verifyChat", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RemoveUserVerification holds parameters for the removeUserVerification method.
|
||||||
|
// See https://core.telegram.org/bots/api#removeuserverification
|
||||||
|
type RemoveUserVerification struct {
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// RemoveUserVerification removes a user's verification.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#removeuserverification
|
||||||
|
func (api *API) RemoveUserVerification(params RemoveUserVerification) (bool, error) {
|
||||||
|
req := NewRequest[bool]("removeUserVerification", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RemoveUserVerificationWithContext is the context-aware variant of RemoveUserVerification.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#removeuserverification
|
||||||
|
func (api *API) RemoveUserVerificationWithContext(ctx context.Context, params RemoveUserVerification) (bool, error) {
|
||||||
|
req := NewRequest[bool]("removeUserVerification", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RemoveChatVerification holds parameters for the removeChatVerification method.
|
||||||
|
// See https://core.telegram.org/bots/api#removechatverification
|
||||||
|
type RemoveChatVerification struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// RemoveChatVerification removes a chat's verification.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#removechatverification
|
||||||
|
func (api *API) RemoveChatVerification(params RemoveChatVerification) (bool, error) {
|
||||||
|
req := NewRequest[bool]("removeChatVerification", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RemoveChatVerificationWithContext is the context-aware variant of RemoveChatVerification.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#removechatverification
|
||||||
|
func (api *API) RemoveChatVerificationWithContext(ctx context.Context, params RemoveChatVerification) (bool, error) {
|
||||||
|
req := NewRequest[bool]("removeChatVerification", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReadBusinessMessage holds parameters for the readBusinessMessage method.
|
||||||
|
// See https://core.telegram.org/bots/api#readbusinessmessage
|
||||||
|
type ReadBusinessMessage struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageID int `json:"message_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReadBusinessMessage marks a business message as read.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#readbusinessmessage
|
||||||
|
func (api *API) ReadBusinessMessage(params ReadBusinessMessage) (bool, error) {
|
||||||
|
req := NewRequest[bool]("readBusinessMessage", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReadBusinessMessageWithContext is the context-aware variant of ReadBusinessMessage.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#readbusinessmessage
|
||||||
|
func (api *API) ReadBusinessMessageWithContext(ctx context.Context, params ReadBusinessMessage) (bool, error) {
|
||||||
|
req := NewRequest[bool]("readBusinessMessage", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetBusinessConnection holds parameters for the getBusinessConnection method.
|
||||||
|
// See https://core.telegram.org/bots/api#getbusinessconnection
|
||||||
|
type GetBusinessConnection struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetBusinessConnection returns information about a business connection.
|
||||||
|
// See https://core.telegram.org/bots/api#getbusinessconnection
|
||||||
|
func (api *API) GetBusinessConnection(params GetBusinessConnection) (BusinessConnection, error) {
|
||||||
|
req := NewRequest[BusinessConnection]("getBusinessConnection", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetBusinessConnectionWithContext is the context-aware variant of GetBusinessConnection.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getbusinessconnection
|
||||||
|
func (api *API) GetBusinessConnectionWithContext(ctx context.Context, params GetBusinessConnection) (BusinessConnection, error) {
|
||||||
|
req := NewRequest[BusinessConnection]("getBusinessConnection", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteBusinessMessages holds parameters for the deleteBusinessMessages method.
|
||||||
|
// See https://core.telegram.org/bots/api#deletebusinessmessages
|
||||||
|
type DeleteBusinessMessages struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
MessageIDs []int `json:"message_ids"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteBusinessMessages deletes business messages.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#deletebusinessmessages
|
||||||
|
func (api *API) DeleteBusinessMessages(params DeleteBusinessMessages) (bool, error) {
|
||||||
|
req := NewRequest[bool]("deleteBusinessMessages", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteBusinessMessagesWithContext is the context-aware variant of DeleteBusinessMessages.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#deletebusinessmessages
|
||||||
|
func (api *API) DeleteBusinessMessagesWithContext(ctx context.Context, params DeleteBusinessMessages) (bool, error) {
|
||||||
|
req := NewRequest[bool]("deleteBusinessMessages", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetBusinessAccountName holds parameters for the setBusinessAccountName method.
|
||||||
|
// See https://core.telegram.org/bots/api#setbusinessaccountname
|
||||||
|
type SetBusinessAccountName struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
FirstName string `json:"first_name"`
|
||||||
|
LastName string `json:"last_name,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetBusinessAccountName sets the first and last name of a business account.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setbusinessaccountname
|
||||||
|
func (api *API) SetBusinessAccountName(params SetBusinessAccountName) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setBusinessAccountName", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetBusinessAccountNameWithContext is the context-aware variant of SetBusinessAccountName.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setbusinessaccountname
|
||||||
|
func (api *API) SetBusinessAccountNameWithContext(ctx context.Context, params SetBusinessAccountName) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setBusinessAccountName", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetBusinessAccountUsername holds parameters for the setBusinessAccountUsername method.
|
||||||
|
// See https://core.telegram.org/bots/api#setbusinessaccountusername
|
||||||
|
type SetBusinessAccountUsername struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
Username string `json:"username,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetBusinessAccountUsername sets the username of a business account.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setbusinessaccountusername
|
||||||
|
func (api *API) SetBusinessAccountUsername(params SetBusinessAccountUsername) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setBusinessAccountUsername", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetBusinessAccountUsernameWithContext is the context-aware variant of SetBusinessAccountUsername.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setbusinessaccountusername
|
||||||
|
func (api *API) SetBusinessAccountUsernameWithContext(ctx context.Context, params SetBusinessAccountUsername) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setBusinessAccountUsername", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetBusinessAccountBio holds parameters for the setBusinessAccountBio method.
|
||||||
|
// See https://core.telegram.org/bots/api#setbusinessaccountbio
|
||||||
|
type SetBusinessAccountBio struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
Bio string `json:"bio,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetBusinessAccountBio sets the bio of a business account.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setbusinessaccountbio
|
||||||
|
func (api *API) SetBusinessAccountBio(params SetBusinessAccountBio) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setBusinessAccountBio", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetBusinessAccountBioWithContext is the context-aware variant of SetBusinessAccountBio.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setbusinessaccountbio
|
||||||
|
func (api *API) SetBusinessAccountBioWithContext(ctx context.Context, params SetBusinessAccountBio) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setBusinessAccountBio", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetBusinessAccountProfilePhoto holds parameters for the setBusinessAccountProfilePhoto method.
|
||||||
|
// See https://core.telegram.org/bots/api#setbusinessaccountprofilephoto
|
||||||
|
type SetBusinessAccountProfilePhoto struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
Photo InputProfilePhoto `json:"photo,omitempty"`
|
||||||
|
IsPublic bool `json:"is_public,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetBusinessAccountProfilePhoto sets the profile photo of a business account.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setbusinessaccountprofilephoto
|
||||||
|
func (api *API) SetBusinessAccountProfilePhoto(params SetBusinessAccountProfilePhoto) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setBusinessAccountProfilePhoto", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetBusinessAccountProfilePhotoWithContext is the context-aware variant of SetBusinessAccountProfilePhoto.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setbusinessaccountprofilephoto
|
||||||
|
func (api *API) SetBusinessAccountProfilePhotoWithContext(ctx context.Context, params SetBusinessAccountProfilePhoto) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setBusinessAccountProfilePhoto", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RemoveBusinessAccountProfilePhoto holds parameters for the removeBusinessAccountProfilePhoto method.
|
||||||
|
// See https://core.telegram.org/bots/api#removebusinessaccountprofilephoto
|
||||||
|
type RemoveBusinessAccountProfilePhoto struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
IsPublic bool `json:"is_public,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// RemoveBusinessAccountProfilePhoto removes the profile photo of a business account.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#removebusinessaccountprofilephoto
|
||||||
|
func (api *API) RemoveBusinessAccountProfilePhoto(params RemoveBusinessAccountProfilePhoto) (bool, error) {
|
||||||
|
req := NewRequest[bool]("removeBusinessAccountProfilePhoto", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RemoveBusinessAccountProfilePhotoWithContext is the context-aware variant of RemoveBusinessAccountProfilePhoto.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#removebusinessaccountprofilephoto
|
||||||
|
func (api *API) RemoveBusinessAccountProfilePhotoWithContext(ctx context.Context, params RemoveBusinessAccountProfilePhoto) (bool, error) {
|
||||||
|
req := NewRequest[bool]("removeBusinessAccountProfilePhoto", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetBusinessAccountGiftSettings holds parameters for the setBusinessAccountGiftSettings method.
|
||||||
|
// See https://core.telegram.org/bots/api#setbusinessaccountgiftsettings
|
||||||
|
type SetBusinessAccountGiftSettings struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
ShowGiftButton bool `json:"show_gift_button"`
|
||||||
|
AcceptedGiftTypes AcceptedGiftTypes `json:"accepted_gift_types"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetBusinessAccountGiftSettings sets gift settings for a business account.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setbusinessaccountgiftsettings
|
||||||
|
func (api *API) SetBusinessAccountGiftSettings(params SetBusinessAccountGiftSettings) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setBusinessAccountGiftSettings", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetBusinessAccountGiftSettingsWithContext is the context-aware variant of SetBusinessAccountGiftSettings.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setbusinessaccountgiftsettings
|
||||||
|
func (api *API) SetBusinessAccountGiftSettingsWithContext(ctx context.Context, params SetBusinessAccountGiftSettings) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setBusinessAccountGiftSettings", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetBusinessAccountStarBalance holds parameters for the getBusinessAccountStarBalance method.
|
||||||
|
// See https://core.telegram.org/bots/api#getbusinessaccountstarbalance
|
||||||
|
type GetBusinessAccountStarBalance struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetBusinessAccountStarBalance returns the star balance of a business account.
|
||||||
|
// See https://core.telegram.org/bots/api#getbusinessaccountstarbalance
|
||||||
|
func (api *API) GetBusinessAccountStarBalance(params GetBusinessAccountStarBalance) (StarAmount, error) {
|
||||||
|
req := NewRequest[StarAmount]("getBusinessAccountStarBalance", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetBusinessAccountStarBalanceWithContext is the context-aware variant of GetBusinessAccountStarBalance.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getbusinessaccountstarbalance
|
||||||
|
func (api *API) GetBusinessAccountStarBalanceWithContext(ctx context.Context, params GetBusinessAccountStarBalance) (StarAmount, error) {
|
||||||
|
req := NewRequest[StarAmount]("getBusinessAccountStarBalance", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TransferBusinessAccountStars holds parameters for the transferBusinessAccountStars method.
|
||||||
|
// See https://core.telegram.org/bots/api#transferbusinessaccountstars
|
||||||
|
type TransferBusinessAccountStars struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
StarCount int `json:"star_count"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// TransferBusinessAccountStars transfers stars from a business account.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#transferbusinessaccountstars
|
||||||
|
func (api *API) TransferBusinessAccountStars(params TransferBusinessAccountStars) (bool, error) {
|
||||||
|
req := NewRequest[bool]("transferBusinessAccountStars", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TransferBusinessAccountStarsWithContext is the context-aware variant of TransferBusinessAccountStars.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#transferbusinessaccountstars
|
||||||
|
func (api *API) TransferBusinessAccountStarsWithContext(ctx context.Context, params TransferBusinessAccountStars) (bool, error) {
|
||||||
|
req := NewRequest[bool]("transferBusinessAccountStars", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetBusinessAccountGifts holds parameters for the getBusinessAccountGifts method.
|
||||||
|
// See https://core.telegram.org/bots/api#getbusinessaccountgifts
|
||||||
|
type GetBusinessAccountGifts struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
ExcludeUnsaved bool `json:"exclude_unsaved,omitempty"`
|
||||||
|
ExcludeSaved bool `json:"exclude_saved,omitempty"`
|
||||||
|
ExcludeUnlimited bool `json:"exclude_unlimited,omitempty"`
|
||||||
|
ExcludeLimitedUpgradable bool `json:"exclude_limited_upgradable,omitempty"`
|
||||||
|
ExcludeLimitedNonUpgradable bool `json:"exclude_limited_non_upgradable,omitempty"`
|
||||||
|
ExcludeUnique bool `json:"exclude_unique,omitempty"`
|
||||||
|
ExcludeFromBlockchain bool `json:"exclude_from_blockchain,omitempty"`
|
||||||
|
SortByPrice bool `json:"sort_by_price,omitempty"`
|
||||||
|
Offset string `json:"offset,omitempty"`
|
||||||
|
Limit int `json:"limit,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetBusinessAccountGifts returns gifts owned by a business account.
|
||||||
|
// See https://core.telegram.org/bots/api#getbusinessaccountgifts
|
||||||
|
func (api *API) GetBusinessAccountGifts(params GetBusinessAccountGifts) (OwnedGifts, error) {
|
||||||
|
req := NewRequest[OwnedGifts]("getBusinessAccountGifts", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetBusinessAccountGiftsWithContext is the context-aware variant of GetBusinessAccountGifts.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getbusinessaccountgifts
|
||||||
|
func (api *API) GetBusinessAccountGiftsWithContext(ctx context.Context, params GetBusinessAccountGifts) (OwnedGifts, error) {
|
||||||
|
req := NewRequest[OwnedGifts]("getBusinessAccountGifts", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ConvertGiftToStars holds parameters for the convertGiftToStars method.
|
||||||
|
// See https://core.telegram.org/bots/api#convertgifttostars
|
||||||
|
type ConvertGiftToStars struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
OwnedGiftID string `json:"owned_gift_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ConvertGiftToStars converts a gift to Telegram Stars.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#convertgifttostars
|
||||||
|
func (api *API) ConvertGiftToStars(params ConvertGiftToStars) (bool, error) {
|
||||||
|
req := NewRequest[bool]("convertGiftToStars", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ConvertGiftToStarsWithContext is the context-aware variant of ConvertGiftToStars.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#convertgifttostars
|
||||||
|
func (api *API) ConvertGiftToStarsWithContext(ctx context.Context, params ConvertGiftToStars) (bool, error) {
|
||||||
|
req := NewRequest[bool]("convertGiftToStars", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UpgradeGift holds parameters for the upgradeGift method.
|
||||||
|
// See https://core.telegram.org/bots/api#upgradegift
|
||||||
|
type UpgradeGift struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
OwnedGiftID string `json:"owned_gift_id"`
|
||||||
|
KeepOriginalDetails bool `json:"keep_original_details,omitempty"`
|
||||||
|
StarCount int `json:"star_count,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// UpgradeGift upgrades a gift.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#upgradegift
|
||||||
|
func (api *API) UpgradeGift(params UpgradeGift) (bool, error) {
|
||||||
|
req := NewRequest[bool]("upgradeGift", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UpgradeGiftWithContext is the context-aware variant of UpgradeGift.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#upgradegift
|
||||||
|
func (api *API) UpgradeGiftWithContext(ctx context.Context, params UpgradeGift) (bool, error) {
|
||||||
|
req := NewRequest[bool]("upgradeGift", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TransferGift holds parameters for the transferGift method.
|
||||||
|
// See https://core.telegram.org/bots/api#transfergift
|
||||||
|
type TransferGift struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
OwnedGiftID string `json:"owned_gift_id"`
|
||||||
|
NewOwnerChatID int64 `json:"new_owner_chat_id"`
|
||||||
|
StarCount int `json:"star_count,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// TransferGift transfers a gift to another chat.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#transfergift
|
||||||
|
func (api *API) TransferGift(params TransferGift) (bool, error) {
|
||||||
|
req := NewRequest[bool]("transferGift", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TransferGiftWithContext is the context-aware variant of TransferGift.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#transfergift
|
||||||
|
func (api *API) TransferGiftWithContext(ctx context.Context, params TransferGift) (bool, error) {
|
||||||
|
req := NewRequest[bool]("transferGift", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// PostStory holds parameters for the postStory method.
|
||||||
|
// See https://core.telegram.org/bots/api#poststory
|
||||||
|
type PostStory struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
Content InputStoryContent `json:"content"`
|
||||||
|
ActivePeriod int `json:"active_period"`
|
||||||
|
|
||||||
|
Caption string `json:"caption,omitempty"`
|
||||||
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
Areas []StoryArea `json:"areas"`
|
||||||
|
|
||||||
|
PostToChatPage bool `json:"post_to_chat_page,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// PostStory posts a story with a photo.
|
||||||
|
// See https://core.telegram.org/bots/api#poststory
|
||||||
|
func (api *API) PostStory(params PostStory) (Story, error) {
|
||||||
|
req := NewRequest[Story]("postStory", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// PostStoryWithContext is the context-aware variant of PostStoryPhoto.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#poststory
|
||||||
|
func (api *API) PostStoryWithContext(ctx context.Context, params PostStory) (Story, error) {
|
||||||
|
req := NewRequest[Story]("postStory", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RepostStory holds parameters for the repostStory method.
|
||||||
|
// See https://core.telegram.org/bots/api#repoststory
|
||||||
|
type RepostStory struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
FromChatID int64 `json:"from_chat_id"`
|
||||||
|
FromStoryID int `json:"from_story_id"`
|
||||||
|
ActivePeriod int `json:"active_period"`
|
||||||
|
PostToChatPage bool `json:"post_to_chat_page,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// RepostStory reposts a story from another chat.
|
||||||
|
// Returns the reposted story.
|
||||||
|
// See https://core.telegram.org/bots/api#repoststory
|
||||||
|
func (api *API) RepostStory(params RepostStory) (Story, error) {
|
||||||
|
req := NewRequest[Story]("repostStory", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RepostStoryWithContext is the context-aware variant of RepostStory.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#repoststory
|
||||||
|
func (api *API) RepostStoryWithContext(ctx context.Context, params RepostStory) (Story, error) {
|
||||||
|
req := NewRequest[Story]("repostStory", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditStory holds parameters for the editStory method.
|
||||||
|
// See https://core.telegram.org/bots/api#editstory
|
||||||
|
type EditStory struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
StoryID int `json:"story_id"`
|
||||||
|
Content InputStoryContent `json:"content"`
|
||||||
|
|
||||||
|
Caption string `json:"caption,omitempty"`
|
||||||
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
Areas []StoryArea `json:"areas,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditStory edits an existing story.
|
||||||
|
// Returns the updated story.
|
||||||
|
// See https://core.telegram.org/bots/api#editstory
|
||||||
|
func (api *API) EditStory(params EditStory) (Story, error) {
|
||||||
|
req := NewRequest[Story]("editStory", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditStoryWithContext is the context-aware variant of EditStory.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#editstory
|
||||||
|
func (api *API) EditStoryWithContext(ctx context.Context, params EditStory) (Story, error) {
|
||||||
|
req := NewRequest[Story]("editStory", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteStory holds parameters for the deleteStory method.
|
||||||
|
// See https://core.telegram.org/bots/api#deletestory
|
||||||
|
type DeleteStory struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
StoryID int `json:"story_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteStory deletes a story.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#deletestory
|
||||||
|
func (api *API) DeleteStory(params DeleteStory) (bool, error) {
|
||||||
|
req := NewRequest[bool]("deleteStory", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteStoryWithContext is the context-aware variant of DeleteStory.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#deletestory
|
||||||
|
func (api *API) DeleteStoryWithContext(ctx context.Context, params DeleteStory) (bool, error) {
|
||||||
|
req := NewRequest[bool]("deleteStory", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
@@ -0,0 +1,156 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
// BusinessIntro contains information about the business intro.
|
||||||
|
// See https://core.telegram.org/bots/api#businessintro
|
||||||
|
type BusinessIntro struct {
|
||||||
|
Title string `json:"title,omitempty"`
|
||||||
|
Message string `json:"message,omitempty"`
|
||||||
|
Sticker *Sticker `json:"sticker,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// BusinessLocation contains information about the business location.
|
||||||
|
// See https://core.telegram.org/bots/api#businesslocation
|
||||||
|
type BusinessLocation struct {
|
||||||
|
Address string `json:"address"`
|
||||||
|
Location *Location `json:"location,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// BusinessOpeningHoursInterval represents an interval of opening hours.
|
||||||
|
// See https://core.telegram.org/bots/api#businessopeninghoursinterval
|
||||||
|
type BusinessOpeningHoursInterval struct {
|
||||||
|
OpeningMinute int `json:"opening_minute"`
|
||||||
|
ClosingMinute int `json:"closing_minute"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// BusinessOpeningHours represents the opening hours of a business.
|
||||||
|
// See https://core.telegram.org/bots/api#businessopeninghours
|
||||||
|
type BusinessOpeningHours struct {
|
||||||
|
TimeZoneName string `json:"time_zone_name"`
|
||||||
|
OpeningHours []BusinessOpeningHoursInterval `json:"opening_hours"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// BusinessBotRights represents the rights of a business bot.
|
||||||
|
// All fields are optional booleans that, when present, are always true.
|
||||||
|
// See https://core.telegram.org/bots/api#businessbotrights
|
||||||
|
type BusinessBotRights struct {
|
||||||
|
CanReply *bool `json:"can_reply,omitempty"`
|
||||||
|
CanReadMessages *bool `json:"can_read_messages,omitempty"`
|
||||||
|
CanDeleteSentMessages *bool `json:"can_delete_sent_messages,omitempty"`
|
||||||
|
CanDeleteAllMessages *bool `json:"can_delete_all_messages,omitempty"`
|
||||||
|
CanEditName *bool `json:"can_edit_name,omitempty"`
|
||||||
|
CanEditBio *bool `json:"can_edit_bio,omitempty"`
|
||||||
|
CanEditProfilePhoto *bool `json:"can_edit_profile_photo,omitempty"`
|
||||||
|
CanEditUsername *bool `json:"can_edit_username,omitempty"`
|
||||||
|
CanChangeGiftSettings *bool `json:"can_change_gift_settings,omitempty"`
|
||||||
|
CanViewGiftsAndStars *bool `json:"can_view_gifts_and_stars,omitempty"`
|
||||||
|
CanConvertGiftsToStars *bool `json:"can_convert_gifts_to_stars,omitempty"`
|
||||||
|
CanTransferAndUpgradeGifts *bool `json:"can_transfer_and_upgrade_gifts,omitempty"`
|
||||||
|
CanTransferStars *bool `json:"can_transfer_stars,omitempty"`
|
||||||
|
CanManageStories *bool `json:"can_manage_stories,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// BusinessConnection contains information about a business connection.
|
||||||
|
// See https://core.telegram.org/bots/api#businessconnection
|
||||||
|
type BusinessConnection struct {
|
||||||
|
ID string `json:"id"`
|
||||||
|
User User `json:"user"`
|
||||||
|
UserChatID int64 `json:"user_chat_id"`
|
||||||
|
Date int `json:"date"`
|
||||||
|
Rights *BusinessBotRights `json:"rights,omitempty"`
|
||||||
|
IsEnabled bool `json:"is_enabled"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// BusinessMessagesDeleted is received when messages are deleted from a connected business account.
|
||||||
|
// See https://core.telegram.org/bots/api#businessmessagesdeleted
|
||||||
|
type BusinessMessagesDeleted struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
Chat Chat `json:"chat"`
|
||||||
|
MessageIDs []int `json:"message_ids"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// InputStoryContentType indicates the type of input story content.
|
||||||
|
type InputStoryContentType string
|
||||||
|
|
||||||
|
const (
|
||||||
|
// InputStoryContentPhotoType identifies photo story content.
|
||||||
|
InputStoryContentPhotoType InputStoryContentType = "photo"
|
||||||
|
// InputStoryContentVideoType identifies video story content.
|
||||||
|
InputStoryContentVideoType InputStoryContentType = "video"
|
||||||
|
)
|
||||||
|
|
||||||
|
// InputStoryContent represents the content of a story to be posted.
|
||||||
|
// See https://core.telegram.org/bots/api#inputstorycontent
|
||||||
|
type InputStoryContent struct {
|
||||||
|
Type InputStoryContentType `json:"type"`
|
||||||
|
|
||||||
|
// Photo fields
|
||||||
|
Photo *string `json:"photo,omitempty"`
|
||||||
|
|
||||||
|
// Video fields
|
||||||
|
Video *string `json:"video,omitempty"`
|
||||||
|
Duration *float64 `json:"duration,omitempty"`
|
||||||
|
CoverFrameTimestamp *float64 `json:"cover_frame_timestamp,omitempty"`
|
||||||
|
IsAnimation *bool `json:"is_animation,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// StoryAreaPosition describes the position of a clickable area on a story.
|
||||||
|
// See https://core.telegram.org/bots/api#storyareaposition
|
||||||
|
type StoryAreaPosition struct {
|
||||||
|
XPercentage float64 `json:"x_percentage"`
|
||||||
|
YPercentage float64 `json:"y_percentage"`
|
||||||
|
WidthPercentage float64 `json:"width_percentage"`
|
||||||
|
HeightPercentage float64 `json:"height_percentage"`
|
||||||
|
RotationAngle float64 `json:"rotation_angle"`
|
||||||
|
CornerRadiusPercentage float64 `json:"corner_radius_percentage"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// StoryAreaTypeType indicates the type of story area.
|
||||||
|
type StoryAreaTypeType string
|
||||||
|
|
||||||
|
const (
|
||||||
|
// StoryAreaTypeLocationType identifies a location story area.
|
||||||
|
StoryAreaTypeLocationType StoryAreaTypeType = "location"
|
||||||
|
// StoryAreaTypeReactionType identifies a suggested reaction story area.
|
||||||
|
StoryAreaTypeReactionType StoryAreaTypeType = "suggested_reaction"
|
||||||
|
// StoryAreaTypeLinkType identifies a link story area.
|
||||||
|
StoryAreaTypeLinkType StoryAreaTypeType = "link"
|
||||||
|
// StoryAreaTypeWeatherType identifies a weather story area.
|
||||||
|
StoryAreaTypeWeatherType StoryAreaTypeType = "weather"
|
||||||
|
// StoryAreaTypeUniqueGiftType identifies a unique gift story area.
|
||||||
|
StoryAreaTypeUniqueGiftType StoryAreaTypeType = "unique_gift"
|
||||||
|
)
|
||||||
|
|
||||||
|
// StoryAreaType describes the type of a clickable area on a story.
|
||||||
|
// Fields should be set according to the Type.
|
||||||
|
// See https://core.telegram.org/bots/api#storyareatype
|
||||||
|
type StoryAreaType struct {
|
||||||
|
Type StoryAreaTypeType `json:"type"`
|
||||||
|
|
||||||
|
// Location
|
||||||
|
Latitude *float64 `json:"latitude,omitempty"`
|
||||||
|
Longitude *float64 `json:"longitude,omitempty"`
|
||||||
|
Address *LocationAddress `json:"address,omitempty"`
|
||||||
|
|
||||||
|
// Suggested reaction
|
||||||
|
ReactionType *ReactionType `json:"reaction_type,omitempty"`
|
||||||
|
IsDark *bool `json:"is_dark,omitempty"`
|
||||||
|
IsFlipped *bool `json:"is_flipped,omitempty"`
|
||||||
|
|
||||||
|
// Link
|
||||||
|
URL *string `json:"url,omitempty"`
|
||||||
|
|
||||||
|
// Weather
|
||||||
|
Temperature *float64 `json:"temperature,omitempty"`
|
||||||
|
Emoji *string `json:"emoji,omitempty"`
|
||||||
|
BackgroundColor *int `json:"background_color,omitempty"`
|
||||||
|
|
||||||
|
// Unique gift
|
||||||
|
Name *string `json:"name,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// StoryArea represents a clickable area on a story.
|
||||||
|
// See https://core.telegram.org/bots/api#storyarea
|
||||||
|
type StoryArea struct {
|
||||||
|
Position StoryAreaPosition `json:"position"`
|
||||||
|
Type StoryAreaType `json:"type"`
|
||||||
|
}
|
||||||
@@ -0,0 +1,794 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import "context"
|
||||||
|
|
||||||
|
// BanChatMember holds parameters for the banChatMember method.
|
||||||
|
// See https://core.telegram.org/bots/api#banchatmember
|
||||||
|
type BanChatMember struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
UntilDate int `json:"until_date,omitempty"`
|
||||||
|
RevokeMessages bool `json:"revoke_messages,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// BanChatMember bans a user in a chat.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#banchatmember
|
||||||
|
func (api *API) BanChatMember(params BanChatMember) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("banChatMember", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BanChatMemberWithContext is the context-aware variant of BanChatMember.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#banchatmember
|
||||||
|
func (api *API) BanChatMemberWithContext(ctx context.Context, params BanChatMember) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("banChatMember", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnbanChatMember holds parameters for the unbanChatMember method.
|
||||||
|
// See https://core.telegram.org/bots/api#unbanchatmember
|
||||||
|
type UnbanChatMember struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
OnlyIfBanned bool `json:"only_if_banned"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnbanChatMember unbans a previously banned user in a chat.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#unbanchatmember
|
||||||
|
func (api *API) UnbanChatMember(params UnbanChatMember) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("unbanChatMember", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnbanChatMemberWithContext is the context-aware variant of UnbanChatMember.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#unbanchatmember
|
||||||
|
func (api *API) UnbanChatMemberWithContext(ctx context.Context, params UnbanChatMember) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("unbanChatMember", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RestrictChatMember holds parameters for the restrictChatMember method.
|
||||||
|
// See https://core.telegram.org/bots/api#restrictchatmember
|
||||||
|
type RestrictChatMember struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
Permissions ChatPermissions `json:"permissions"`
|
||||||
|
UseIndependentChatPermissions bool `json:"use_independent_chat_permissions,omitempty"`
|
||||||
|
UntilDate int `json:"until_date,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// RestrictChatMember restricts a user in a chat.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#restrictchatmember
|
||||||
|
func (api *API) RestrictChatMember(params RestrictChatMember) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("restrictChatMember", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RestrictChatMemberWithContext is the context-aware variant of RestrictChatMember.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#restrictchatmember
|
||||||
|
func (api *API) RestrictChatMemberWithContext(ctx context.Context, params RestrictChatMember) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("restrictChatMember", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// PromoteChatMember holds parameters for the promoteChatMember method.
|
||||||
|
// See https://core.telegram.org/bots/api#promotechatmember
|
||||||
|
type PromoteChatMember struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
IsAnonymous bool `json:"is_anonymous,omitempty"`
|
||||||
|
|
||||||
|
CanManageChat bool `json:"can_manage_chat,omitempty"`
|
||||||
|
CanDeleteMessages bool `json:"can_delete_messages,omitempty"`
|
||||||
|
CanManageVideoChats bool `json:"can_manage_video_chats,omitempty"`
|
||||||
|
CanRestrictMembers bool `json:"can_restrict_members,omitempty"`
|
||||||
|
CanPromoteMembers bool `json:"can_promote_members,omitempty"`
|
||||||
|
CanChangeInfo bool `json:"can_change_info,omitempty"`
|
||||||
|
CanInviteUsers bool `json:"can_invite_users,omitempty"`
|
||||||
|
CanPostStories bool `json:"can_post_stories,omitempty"`
|
||||||
|
CanEditStories bool `json:"can_edit_stories,omitempty"`
|
||||||
|
CanDeleteStories bool `json:"can_delete_stories,omitempty"`
|
||||||
|
CanPostMessages bool `json:"can_post_messages,omitempty"`
|
||||||
|
CanEditMessages bool `json:"can_edit_messages,omitempty"`
|
||||||
|
CanPinMessages bool `json:"can_pin_messages,omitempty"`
|
||||||
|
CanManageTopics bool `json:"can_manage_topics,omitempty"`
|
||||||
|
CanManageDirectMessages bool `json:"can_manage_direct_messages,omitempty"`
|
||||||
|
CanManageTags bool `json:"can_manage_tags,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// PromoteChatMember promotes or demotes a user in a chat.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#promotechatmember
|
||||||
|
func (api *API) PromoteChatMember(params PromoteChatMember) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("promoteChatMember", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// PromoteChatMemberWithContext is the context-aware variant of PromoteChatMember.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#promotechatmember
|
||||||
|
func (api *API) PromoteChatMemberWithContext(ctx context.Context, params PromoteChatMember) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("promoteChatMember", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChatAdministratorCustomTitle holds parameters for the setChatAdministratorCustomTitle method.
|
||||||
|
// See https://core.telegram.org/bots/api#setchatadministratorcustomtitle
|
||||||
|
type SetChatAdministratorCustomTitle struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
CustomTitle string `json:"custom_title"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChatAdministratorCustomTitle sets a custom title for an administrator.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setchatadministratorcustomtitle
|
||||||
|
func (api *API) SetChatAdministratorCustomTitle(params SetChatAdministratorCustomTitle) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("setChatAdministratorCustomTitle", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChatAdministratorCustomTitleWithContext is the context-aware variant of SetChatAdministratorCustomTitle.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setchatadministratorcustomtitle
|
||||||
|
func (api *API) SetChatAdministratorCustomTitleWithContext(ctx context.Context, params SetChatAdministratorCustomTitle) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("setChatAdministratorCustomTitle", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChatMemberTag holds parameters for the setChatMemberTag method.
|
||||||
|
// See https://core.telegram.org/bots/api#setchatmembertag
|
||||||
|
type SetChatMemberTag struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
Tag string `json:"tag,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChatMemberTag sets a tag for a chat member.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setchatmembertag
|
||||||
|
func (api *API) SetChatMemberTag(params SetChatMemberTag) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("setChatMemberTag", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChatMemberTagWithContext is the context-aware variant of SetChatMemberTag.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setchatmembertag
|
||||||
|
func (api *API) SetChatMemberTagWithContext(ctx context.Context, params SetChatMemberTag) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("setChatMemberTag", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BanChatSenderChat holds parameters for the banChatSenderChat method.
|
||||||
|
// See https://core.telegram.org/bots/api#banchatsenderchat
|
||||||
|
type BanChatSenderChat struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
SenderChatID int64 `json:"sender_chat_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// BanChatSenderChat bans a channel chat in a supergroup or channel.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#banchatsenderchat
|
||||||
|
func (api *API) BanChatSenderChat(params BanChatSenderChat) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("banChatSenderChat", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BanChatSenderChatWithContext is the context-aware variant of BanChatSenderChat.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#banchatsenderchat
|
||||||
|
func (api *API) BanChatSenderChatWithContext(ctx context.Context, params BanChatSenderChat) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("banChatSenderChat", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnbanChatSenderChat holds parameters for the unbanChatSenderChat method.
|
||||||
|
// See https://core.telegram.org/bots/api#unbanchatsenderchat
|
||||||
|
type UnbanChatSenderChat struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
SenderChatID int64 `json:"sender_chat_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnbanChatSenderChat unbans a previously banned channel chat.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#unbanchatsenderchat
|
||||||
|
func (api *API) UnbanChatSenderChat(params UnbanChatSenderChat) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("unbanChatSenderChat", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnbanChatSenderChatWithContext is the context-aware variant of UnbanChatSenderChat.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#unbanchatsenderchat
|
||||||
|
func (api *API) UnbanChatSenderChatWithContext(ctx context.Context, params UnbanChatSenderChat) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("unbanChatSenderChat", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChatPermissions holds parameters for the setChatPermissions method.
|
||||||
|
// See https://core.telegram.org/bots/api#setchatpermissions
|
||||||
|
type SetChatPermissions struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
Permissions ChatPermissions `json:"permissions"`
|
||||||
|
UseIndependentChatPermissions bool `json:"use_independent_chat_permissions,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChatPermissions sets default chat permissions for all members.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setchatpermissions
|
||||||
|
func (api *API) SetChatPermissions(params SetChatPermissions) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("setChatPermissions", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChatPermissionsWithContext is the context-aware variant of SetChatPermissions.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setchatpermissions
|
||||||
|
func (api *API) SetChatPermissionsWithContext(ctx context.Context, params SetChatPermissions) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("setChatPermissions", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportChatInviteLink holds parameters for the exportChatInviteLink method.
|
||||||
|
// See https://core.telegram.org/bots/api#exportchatinvitelink
|
||||||
|
type ExportChatInviteLink struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportChatInviteLink generates a new primary invite link for a chat.
|
||||||
|
// Returns the new invite link as string.
|
||||||
|
// See https://core.telegram.org/bots/api#exportchatinvitelink
|
||||||
|
func (api *API) ExportChatInviteLink(params ExportChatInviteLink) (string, error) {
|
||||||
|
req := NewRequestWithChatID[string]("exportChatInviteLink", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExportChatInviteLinkWithContext is the context-aware variant of ExportChatInviteLink.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#exportchatinvitelink
|
||||||
|
func (api *API) ExportChatInviteLinkWithContext(ctx context.Context, params ExportChatInviteLink) (string, error) {
|
||||||
|
req := NewRequestWithChatID[string]("exportChatInviteLink", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CreateChatInviteLink holds parameters for the createChatInviteLink method.
|
||||||
|
// See https://core.telegram.org/bots/api#createchatinvitelink
|
||||||
|
type CreateChatInviteLink struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
Name *string `json:"name,omitempty"`
|
||||||
|
ExpireDate int `json:"expire_date,omitempty"`
|
||||||
|
MemberLimit int `json:"member_limit,omitempty"`
|
||||||
|
CreatesJoinRequest bool `json:"creates_join_request,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// CreateChatInviteLink creates an additional invite link for a chat.
|
||||||
|
// Returns the created invite link.
|
||||||
|
// See https://core.telegram.org/bots/api#createchatinvitelink
|
||||||
|
func (api *API) CreateChatInviteLink(params CreateChatInviteLink) (ChatInviteLink, error) {
|
||||||
|
req := NewRequestWithChatID[ChatInviteLink]("createChatInviteLink", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CreateChatInviteLinkWithContext is the context-aware variant of CreateChatInviteLink.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#createchatinvitelink
|
||||||
|
func (api *API) CreateChatInviteLinkWithContext(ctx context.Context, params CreateChatInviteLink) (ChatInviteLink, error) {
|
||||||
|
req := NewRequestWithChatID[ChatInviteLink]("createChatInviteLink", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditChatInviteLink holds parameters for the editChatInviteLink method.
|
||||||
|
// See https://core.telegram.org/bots/api#editchatinvitelink
|
||||||
|
type EditChatInviteLink struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
InviteLink string `json:"invite_link"`
|
||||||
|
|
||||||
|
Name string `json:"name,omitempty"`
|
||||||
|
ExpireDate int `json:"expire_date,omitempty"`
|
||||||
|
MemberLimit int `json:"member_limit,omitempty"`
|
||||||
|
CreatesJoinRequest bool `json:"creates_join_request,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditChatInviteLink edits a non‑primary invite link.
|
||||||
|
// Returns the edited invite link.
|
||||||
|
// See https://core.telegram.org/bots/api#editchatinvitelink
|
||||||
|
func (api *API) EditChatInviteLink(params EditChatInviteLink) (ChatInviteLink, error) {
|
||||||
|
req := NewRequestWithChatID[ChatInviteLink]("editChatInviteLink", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditChatInviteLinkWithContext is the context-aware variant of EditChatInviteLink.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#editchatinvitelink
|
||||||
|
func (api *API) EditChatInviteLinkWithContext(ctx context.Context, params EditChatInviteLink) (ChatInviteLink, error) {
|
||||||
|
req := NewRequestWithChatID[ChatInviteLink]("editChatInviteLink", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CreateChatSubscriptionInviteLink holds parameters for the createChatSubscriptionInviteLink method.
|
||||||
|
// See https://core.telegram.org/bots/api#createchatsubscriptioninvitelink
|
||||||
|
type CreateChatSubscriptionInviteLink struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
Name string `json:"name,omitempty"`
|
||||||
|
SubscriptionPeriod int `json:"subscription_period,omitempty"`
|
||||||
|
SubscriptionPrice int `json:"subscription_price,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// CreateChatSubscriptionInviteLink creates a subscription invite link for a channel chat.
|
||||||
|
// Returns the created invite link.
|
||||||
|
// See https://core.telegram.org/bots/api#createchatsubscriptioninvitelink
|
||||||
|
func (api *API) CreateChatSubscriptionInviteLink(params CreateChatSubscriptionInviteLink) (ChatInviteLink, error) {
|
||||||
|
req := NewRequestWithChatID[ChatInviteLink]("createChatSubscriptionInviteLink", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CreateChatSubscriptionInviteLinkWithContext is the context-aware variant of CreateChatSubscriptionInviteLink.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#createchatsubscriptioninvitelink
|
||||||
|
func (api *API) CreateChatSubscriptionInviteLinkWithContext(ctx context.Context, params CreateChatSubscriptionInviteLink) (ChatInviteLink, error) {
|
||||||
|
req := NewRequestWithChatID[ChatInviteLink]("createChatSubscriptionInviteLink", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditChatSubscriptionInviteLink holds parameters for the editChatSubscriptionInviteLink method.
|
||||||
|
// See https://core.telegram.org/bots/api#editchatsubscriptioninvitelink
|
||||||
|
type EditChatSubscriptionInviteLink struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
InviteLink string `json:"invite_link"`
|
||||||
|
Name string `json:"name,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditChatSubscriptionInviteLink edits a subscription invite link.
|
||||||
|
// Returns the edited invite link.
|
||||||
|
// See https://core.telegram.org/bots/api#editchatsubscriptioninvitelink
|
||||||
|
func (api *API) EditChatSubscriptionInviteLink(params EditChatSubscriptionInviteLink) (ChatInviteLink, error) {
|
||||||
|
req := NewRequestWithChatID[ChatInviteLink]("editChatSubscriptionInviteLink", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditChatSubscriptionInviteLinkWithContext is the context-aware variant of EditChatSubscriptionInviteLink.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#editchatsubscriptioninvitelink
|
||||||
|
func (api *API) EditChatSubscriptionInviteLinkWithContext(ctx context.Context, params EditChatSubscriptionInviteLink) (ChatInviteLink, error) {
|
||||||
|
req := NewRequestWithChatID[ChatInviteLink]("editChatSubscriptionInviteLink", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RevokeChatInviteLink holds parameters for the revokeChatInviteLink method.
|
||||||
|
// See https://core.telegram.org/bots/api#revokechatinvitelink
|
||||||
|
type RevokeChatInviteLink struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
InviteLink string `json:"invite_link"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// RevokeChatInviteLink revokes an invite link.
|
||||||
|
// Returns the revoked invite link object.
|
||||||
|
// See https://core.telegram.org/bots/api#revokechatinvitelink
|
||||||
|
func (api *API) RevokeChatInviteLink(params RevokeChatInviteLink) (ChatInviteLink, error) {
|
||||||
|
req := NewRequestWithChatID[ChatInviteLink]("revokeChatInviteLink", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RevokeChatInviteLinkWithContext is the context-aware variant of RevokeChatInviteLink.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#revokechatinvitelink
|
||||||
|
func (api *API) RevokeChatInviteLinkWithContext(ctx context.Context, params RevokeChatInviteLink) (ChatInviteLink, error) {
|
||||||
|
req := NewRequestWithChatID[ChatInviteLink]("revokeChatInviteLink", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ApproveChatJoinRequest holds parameters for the approveChatJoinRequest method.
|
||||||
|
// See https://core.telegram.org/bots/api#approvechatjoinrequest
|
||||||
|
type ApproveChatJoinRequest struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ApproveChatJoinRequest approves a chat join request.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#approvechatjoinrequest
|
||||||
|
func (api *API) ApproveChatJoinRequest(params ApproveChatJoinRequest) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("approveChatJoinRequest", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ApproveChatJoinRequestWithContext is the context-aware variant of ApproveChatJoinRequest.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#approvechatjoinrequest
|
||||||
|
func (api *API) ApproveChatJoinRequestWithContext(ctx context.Context, params ApproveChatJoinRequest) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("approveChatJoinRequest", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeclineChatJoinRequest holds parameters for the declineChatJoinRequest method.
|
||||||
|
// See https://core.telegram.org/bots/api#declinechatjoinrequest
|
||||||
|
type DeclineChatJoinRequest struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeclineChatJoinRequest declines a chat join request.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#declinechatjoinrequest
|
||||||
|
func (api *API) DeclineChatJoinRequest(params DeclineChatJoinRequest) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("declineChatJoinRequest", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeclineChatJoinRequestWithContext is the context-aware variant of DeclineChatJoinRequest.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#declinechatjoinrequest
|
||||||
|
func (api *API) DeclineChatJoinRequestWithContext(ctx context.Context, params DeclineChatJoinRequest) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("declineChatJoinRequest", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChatPhoto holds parameters for the setChatPhoto method.
|
||||||
|
// See https://core.telegram.org/bots/api#setchatphoto
|
||||||
|
type SetChatPhoto struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChatPhoto changes the chat photo.
|
||||||
|
// photo is the file to upload as the new photo.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setchatphoto
|
||||||
|
func (api *API) SetChatPhoto(params SetChatPhoto, photo UploaderFile) (bool, error) {
|
||||||
|
uploader := NewUploader(api)
|
||||||
|
defer func() {
|
||||||
|
_ = uploader.Close()
|
||||||
|
}()
|
||||||
|
req := NewUploaderRequestWithChatID[bool]("setChatPhoto", params, params.ChatID, photo.SetType(UploaderPhotoType))
|
||||||
|
return req.Do(uploader)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteChatPhoto holds parameters for the deleteChatPhoto method.
|
||||||
|
// See https://core.telegram.org/bots/api#deletechatphoto
|
||||||
|
type DeleteChatPhoto struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteChatPhoto deletes a chat photo.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#deletechatphoto
|
||||||
|
func (api *API) DeleteChatPhoto(params DeleteChatPhoto) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("deleteChatPhoto", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteChatPhotoWithContext is the context-aware variant of DeleteChatPhoto.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#deletechatphoto
|
||||||
|
func (api *API) DeleteChatPhotoWithContext(ctx context.Context, params DeleteChatPhoto) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("deleteChatPhoto", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChatTitle holds parameters for the setChatTitle method.
|
||||||
|
// See https://core.telegram.org/bots/api#setchattitle
|
||||||
|
type SetChatTitle struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
Title string `json:"title"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChatTitle changes the chat title.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setchattitle
|
||||||
|
func (api *API) SetChatTitle(params SetChatTitle) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("setChatTitle", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChatTitleWithContext is the context-aware variant of SetChatTitle.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setchattitle
|
||||||
|
func (api *API) SetChatTitleWithContext(ctx context.Context, params SetChatTitle) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("setChatTitle", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChatDescription holds parameters for the setChatDescription method.
|
||||||
|
// See https://core.telegram.org/bots/api#setchatdescription
|
||||||
|
type SetChatDescription struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
Description string `json:"description"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChatDescription changes the chat description.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setchatdescription
|
||||||
|
func (api *API) SetChatDescription(params SetChatDescription) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("setChatDescription", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChatDescriptionWithContext is the context-aware variant of SetChatDescription.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setchatdescription
|
||||||
|
func (api *API) SetChatDescriptionWithContext(ctx context.Context, params SetChatDescription) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("setChatDescription", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// PinChatMessage holds parameters for the pinChatMessage method.
|
||||||
|
// See https://core.telegram.org/bots/api#pinchatmessage
|
||||||
|
type PinChatMessage struct {
|
||||||
|
BusinessConnectionID *string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageID int `json:"message_id"`
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// PinChatMessage pins a message in a chat.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#pinchatmessage
|
||||||
|
func (api *API) PinChatMessage(params PinChatMessage) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("pinChatMessage", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// PinChatMessageWithContext is the context-aware variant of PinChatMessage.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#pinchatmessage
|
||||||
|
func (api *API) PinChatMessageWithContext(ctx context.Context, params PinChatMessage) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("pinChatMessage", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnpinChatMessage holds parameters for the unpinChatMessage method.
|
||||||
|
// See https://core.telegram.org/bots/api#unpinchatmessage
|
||||||
|
type UnpinChatMessage struct {
|
||||||
|
BusinessConnectionID *string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageID int `json:"message_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnpinChatMessage unpins a message in a chat.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#unpinchatmessage
|
||||||
|
func (api *API) UnpinChatMessage(params UnpinChatMessage) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("unpinChatMessage", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnpinChatMessageWithContext is the context-aware variant of UnpinChatMessage.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#unpinchatmessage
|
||||||
|
func (api *API) UnpinChatMessageWithContext(ctx context.Context, params UnpinChatMessage) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("unpinChatMessage", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnpinAllChatMessages holds parameters for the unpinAllChatMessages method.
|
||||||
|
// See https://core.telegram.org/bots/api#unpinallchatmessages
|
||||||
|
type UnpinAllChatMessages struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnpinAllChatMessages unpins all pinned messages in a chat.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#unpinallchatmessages
|
||||||
|
func (api *API) UnpinAllChatMessages(params UnpinAllChatMessages) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("unpinAllChatMessages", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnpinAllChatMessagesWithContext is the context-aware variant of UnpinAllChatMessages.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#unpinallchatmessages
|
||||||
|
func (api *API) UnpinAllChatMessagesWithContext(ctx context.Context, params UnpinAllChatMessages) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("unpinAllChatMessages", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// LeaveChat holds parameters for the leaveChat method.
|
||||||
|
// See https://core.telegram.org/bots/api#leavechat
|
||||||
|
type LeaveChat struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// LeaveChat makes the bot leave a chat.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#leavechat
|
||||||
|
func (api *API) LeaveChat(params LeaveChat) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("leaveChat", params, params.ChatID) // fixed method name
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// LeaveChatWithContext is the context-aware variant of LeaveChat.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#leavechat
|
||||||
|
func (api *API) LeaveChatWithContext(ctx context.Context, params LeaveChat) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("leaveChat", params, params.ChatID) // fixed method name
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetChat holds parameters for the getChat method.
|
||||||
|
// See https://core.telegram.org/bots/api#getchat
|
||||||
|
type GetChat struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetChat gets up‑to‑date information about a chat.
|
||||||
|
// See https://core.telegram.org/bots/api#getchat
|
||||||
|
func (api *API) GetChat(params GetChat) (ChatFullInfo, error) {
|
||||||
|
req := NewRequestWithChatID[ChatFullInfo]("getChat", params, params.ChatID) // fixed method name
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetChatWithContext is the context-aware variant of GetChat.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getchat
|
||||||
|
func (api *API) GetChatWithContext(ctx context.Context, params GetChat) (ChatFullInfo, error) {
|
||||||
|
req := NewRequestWithChatID[ChatFullInfo]("getChat", params, params.ChatID) // fixed method name
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetChatAdministrators holds parameters for the getChatAdministrators method.
|
||||||
|
// See https://core.telegram.org/bots/api#getchatadministrators
|
||||||
|
type GetChatAdministrators struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetChatAdministrators returns a list of administrators in a chat.
|
||||||
|
// See https://core.telegram.org/bots/api#getchatadministrators
|
||||||
|
func (api *API) GetChatAdministrators(params GetChatAdministrators) ([]ChatMember, error) {
|
||||||
|
req := NewRequestWithChatID[[]ChatMember]("getChatAdministrators", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetChatAdministratorsWithContext is the context-aware variant of GetChatAdministrators.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getchatadministrators
|
||||||
|
func (api *API) GetChatAdministratorsWithContext(ctx context.Context, params GetChatAdministrators) ([]ChatMember, error) {
|
||||||
|
req := NewRequestWithChatID[[]ChatMember]("getChatAdministrators", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetChatMembersCount holds parameters for the getChatMemberCount method.
|
||||||
|
// See https://core.telegram.org/bots/api#getchatmembercount
|
||||||
|
type GetChatMembersCount struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetChatMemberCount returns the number of members in a chat.
|
||||||
|
// See https://core.telegram.org/bots/api#getchatmembercount
|
||||||
|
func (api *API) GetChatMemberCount(params GetChatMembersCount) (int, error) {
|
||||||
|
req := NewRequestWithChatID[int]("getChatMemberCount", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetChatMemberCountWithContext is the context-aware variant of GetChatMemberCount.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getchatmembercount
|
||||||
|
func (api *API) GetChatMemberCountWithContext(ctx context.Context, params GetChatMembersCount) (int, error) {
|
||||||
|
req := NewRequestWithChatID[int]("getChatMemberCount", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetChatMember holds parameters for the getChatMember method.
|
||||||
|
// See https://core.telegram.org/bots/api#getchatmember
|
||||||
|
type GetChatMember struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetChatMember returns information about a member of a chat.
|
||||||
|
// See https://core.telegram.org/bots/api#getchatmember
|
||||||
|
func (api *API) GetChatMember(params GetChatMember) (ChatMember, error) {
|
||||||
|
req := NewRequestWithChatID[ChatMember]("getChatMember", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetChatMemberWithContext is the context-aware variant of GetChatMember.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getchatmember
|
||||||
|
func (api *API) GetChatMemberWithContext(ctx context.Context, params GetChatMember) (ChatMember, error) {
|
||||||
|
req := NewRequestWithChatID[ChatMember]("getChatMember", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChatStickerSet holds parameters for the setChatStickerSet method.
|
||||||
|
// See https://core.telegram.org/bots/api#setchatstickerset
|
||||||
|
type SetChatStickerSet struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
StickerSetName string `json:"sticker_set_name"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChatStickerSet associates a sticker set with a supergroup.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setchatstickerset
|
||||||
|
func (api *API) SetChatStickerSet(params SetChatStickerSet) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("setChatStickerSet", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChatStickerSetWithContext is the context-aware variant of SetChatStickerSet.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setchatstickerset
|
||||||
|
func (api *API) SetChatStickerSetWithContext(ctx context.Context, params SetChatStickerSet) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("setChatStickerSet", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteChatStickerSet holds parameters for the deleteChatStickerSet method.
|
||||||
|
// See https://core.telegram.org/bots/api#deletechatstickerset
|
||||||
|
type DeleteChatStickerSet struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteChatStickerSet deletes a sticker set from a supergroup.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#deletechatstickerset
|
||||||
|
func (api *API) DeleteChatStickerSet(params DeleteChatStickerSet) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("deleteChatStickerSet", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteChatStickerSetWithContext is the context-aware variant of DeleteChatStickerSet.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#deletechatstickerset
|
||||||
|
func (api *API) DeleteChatStickerSetWithContext(ctx context.Context, params DeleteChatStickerSet) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("deleteChatStickerSet", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetUserChatBoosts holds parameters for the getUserChatBoosts method.
|
||||||
|
// See https://core.telegram.org/bots/api#getuserchatboosts
|
||||||
|
type GetUserChatBoosts struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetUserChatBoosts returns the list of boosts a user has given to a chat.
|
||||||
|
// See https://core.telegram.org/bots/api#getuserchatboosts
|
||||||
|
func (api *API) GetUserChatBoosts(params GetUserChatBoosts) (UserChatBoosts, error) {
|
||||||
|
req := NewRequestWithChatID[UserChatBoosts]("getUserChatBoosts", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetUserChatBoostsWithContext is the context-aware variant of GetUserChatBoosts.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getuserchatboosts
|
||||||
|
func (api *API) GetUserChatBoostsWithContext(ctx context.Context, params GetUserChatBoosts) (UserChatBoosts, error) {
|
||||||
|
req := NewRequestWithChatID[UserChatBoosts]("getUserChatBoosts", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetChatGifts holds parameters for the getChatGifts method.
|
||||||
|
// See https://core.telegram.org/bots/api#getchatgifts
|
||||||
|
type GetChatGifts struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
ExcludeUnsaved bool `json:"exclude_unsaved,omitempty"`
|
||||||
|
ExcludeSaved bool `json:"exclude_saved,omitempty"`
|
||||||
|
ExcludeUnlimited bool `json:"exclude_unlimited,omitempty"`
|
||||||
|
ExcludeLimitedUpgradable bool `json:"exclude_limited_upgradable,omitempty"`
|
||||||
|
ExcludeLimitedNonUpgradable bool `json:"exclude_limited_non_upgradable,omitempty"`
|
||||||
|
ExcludeUnique bool `json:"exclude_unique,omitempty"`
|
||||||
|
ExcludeFromBlockchain bool `json:"exclude_from_blockchain,omitempty"`
|
||||||
|
SortByPrice bool `json:"sort_by_price,omitempty"`
|
||||||
|
Offset string `json:"offset,omitempty"`
|
||||||
|
Limit int `json:"limit,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetChatGifts returns gifts owned by a chat.
|
||||||
|
// See https://core.telegram.org/bots/api#getchatgifts
|
||||||
|
func (api *API) GetChatGifts(params GetChatGifts) (OwnedGifts, error) {
|
||||||
|
req := NewRequestWithChatID[OwnedGifts]("getChatGifts", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetChatGiftsWithContext is the context-aware variant of GetChatGifts.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getchatgifts
|
||||||
|
func (api *API) GetChatGiftsWithContext(ctx context.Context, params GetChatGifts) (OwnedGifts, error) {
|
||||||
|
req := NewRequestWithChatID[OwnedGifts]("getChatGifts", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
@@ -0,0 +1,297 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
// Chat represents a chat (private, group, supergroup, channel).
|
||||||
|
// See https://core.telegram.org/bots/api#chat
|
||||||
|
type Chat struct {
|
||||||
|
ID int64 `json:"id"`
|
||||||
|
Type ChatType `json:"type"`
|
||||||
|
Title *string `json:"title,omitempty"`
|
||||||
|
Username *string `json:"username,omitempty"`
|
||||||
|
FirstName *string `json:"first_name,omitempty"`
|
||||||
|
LastName *string `json:"last_name,omitempty"`
|
||||||
|
IsForum *bool `json:"is_forum,omitempty"`
|
||||||
|
IsDirectMessages *bool `json:"is_direct_messages,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ChatType represents the type of a chat.
|
||||||
|
type ChatType string
|
||||||
|
|
||||||
|
const (
|
||||||
|
// ChatTypePrivate identifies a private chat.
|
||||||
|
ChatTypePrivate ChatType = "private"
|
||||||
|
// ChatTypeGroup identifies a basic group chat.
|
||||||
|
ChatTypeGroup ChatType = "group"
|
||||||
|
// ChatTypeSupergroup identifies a supergroup chat.
|
||||||
|
ChatTypeSupergroup ChatType = "supergroup"
|
||||||
|
// ChatTypeChannel identifies a channel chat.
|
||||||
|
ChatTypeChannel ChatType = "channel"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ChatFullInfo contains full information about a chat.
|
||||||
|
// See https://core.telegram.org/bots/api#chatfullinfo
|
||||||
|
type ChatFullInfo struct {
|
||||||
|
ID int64 `json:"id"`
|
||||||
|
Type ChatType `json:"type"`
|
||||||
|
Title string `json:"title"`
|
||||||
|
Username string `json:"username"`
|
||||||
|
FirstName string `json:"first_name"`
|
||||||
|
LastName string `json:"last_name"`
|
||||||
|
IsForum bool `json:"is_forum"`
|
||||||
|
IsDirectMessages bool `json:"is_direct_messages"`
|
||||||
|
AccentColorID int `json:"accent_color_id"`
|
||||||
|
MaxReactionCount int `json:"max_reaction_count"`
|
||||||
|
Photo *ChatPhoto `json:"photo,omitempty"`
|
||||||
|
ActiveUsernames []string `json:"active_usernames,omitempty"`
|
||||||
|
Birthdate *Birthdate `json:"birthdate,omitempty"`
|
||||||
|
|
||||||
|
BusinessIntro *BusinessIntro `json:"business_intro,omitempty"`
|
||||||
|
BusinessLocation *BusinessLocation `json:"business_location,omitempty"`
|
||||||
|
BusinessOpeningHours *BusinessOpeningHours `json:"business_opening_hours,omitempty"`
|
||||||
|
|
||||||
|
PersonalChat *Chat `json:"personal_chat,omitempty"`
|
||||||
|
ParentChat *Chat `json:"parent_chat,omitempty"`
|
||||||
|
|
||||||
|
AvailableReaction []ReactionType `json:"available_reaction,omitempty"`
|
||||||
|
|
||||||
|
BackgroundCustomEmojiID *string `json:"background_custom_emoji_id,omitempty"`
|
||||||
|
ProfileAccentColorID *int `json:"profile_accent_color_id,omitempty"`
|
||||||
|
ProfileBackgroundCustomEmojiID *string `json:"profile_background_custom_emoji_id,omitempty"`
|
||||||
|
EmojiStatusCustomEmojiID *string `json:"emoji_status_custom_emoji_id,omitempty"`
|
||||||
|
EmojiStatusExpirationDate *int `json:"emoji_status_expiration_date,omitempty"`
|
||||||
|
|
||||||
|
Bio *string `json:"bio,omitempty"`
|
||||||
|
HasPrivateForwards *bool `json:"has_private_forwards,omitempty"`
|
||||||
|
HasRestrictedVoiceAndVideoMessages *bool `json:"has_restricted_voice_and_video_messages,omitempty"`
|
||||||
|
JoinToSendMessages *bool `json:"join_to_send_messages,omitempty"`
|
||||||
|
JoinByRequest *bool `json:"join_by_request,omitempty"`
|
||||||
|
|
||||||
|
Description *string `json:"description,omitempty"`
|
||||||
|
InviteLink *string `json:"invite_link,omitempty"`
|
||||||
|
PinnedMessage *Message `json:"pinned_message,omitempty"`
|
||||||
|
Permissions *ChatPermissions `json:"permissions,omitempty"`
|
||||||
|
AcceptedGiftTypes *AcceptedGiftTypes `json:"accepted_gift_types,omitempty"`
|
||||||
|
|
||||||
|
CanSendPaidMedia *bool `json:"can_send_paid_media,omitempty"`
|
||||||
|
SlowModeDelay *int `json:"slow_mode_delay,omitempty"`
|
||||||
|
UnrestrictedBoostCount *int `json:"unrestricted_boost_count,omitempty"`
|
||||||
|
MessageAutoDeleteTime *int `json:"message_auto_delete_time,omitempty"`
|
||||||
|
HasAggressiveAntiSpamEnabled *bool `json:"has_aggressive_anti_spam_enabled,omitempty"`
|
||||||
|
HasHiddenMembers *bool `json:"has_hidden_members,omitempty"`
|
||||||
|
HasProtectedContent *bool `json:"has_protected_content,omitempty"`
|
||||||
|
HasVisibleHistory *bool `json:"has_visible_history,omitempty"`
|
||||||
|
StickerSetName *string `json:"sticker_set_name,omitempty"`
|
||||||
|
CanSetStickerSet *bool `json:"can_set_sticker_set,omitempty"`
|
||||||
|
CustomEmojiStickerSetName *string `json:"custom_emoji_sticker_set_name,omitempty"`
|
||||||
|
LinkedChatID *int64 `json:"linked_chat_id,omitempty"`
|
||||||
|
|
||||||
|
Location *ChatLocation `json:"location,omitempty"`
|
||||||
|
Rating *UserRating `json:"rating,omitempty"`
|
||||||
|
FirstProfileAudio *Audio `json:"first_profile_audio,omitempty"`
|
||||||
|
UniqueGiftColors *UniqueGiftColors `json:"unique_gift_colors,omitempty"`
|
||||||
|
PaidMessageStarCount *int `json:"paid_message_star_count,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ChatPhoto represents a chat photo.
|
||||||
|
// See https://core.telegram.org/bots/api#chatphoto
|
||||||
|
type ChatPhoto struct {
|
||||||
|
SmallFileID string `json:"small_file_id"`
|
||||||
|
SmallFileUniqueID string `json:"small_file_unique_id"`
|
||||||
|
BigFileID string `json:"big_file_id"`
|
||||||
|
BigFileUniqueID string `json:"big_file_unique_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ChatPermissions describes actions that a non‑administrator user is allowed to take in a chat.
|
||||||
|
// See https://core.telegram.org/bots/api#chatpermissions
|
||||||
|
type ChatPermissions struct {
|
||||||
|
CanSendMessages bool `json:"can_send_messages"`
|
||||||
|
CanSendAudios bool `json:"can_send_audios"`
|
||||||
|
CanSendDocuments bool `json:"can_send_documents"`
|
||||||
|
CanSendPhotos bool `json:"can_send_photos"`
|
||||||
|
CanSendVideos bool `json:"can_send_videos"`
|
||||||
|
CanSendVideoNotes bool `json:"can_send_video_notes"`
|
||||||
|
CanSendVoiceNotes bool `json:"can_send_voice_notes"`
|
||||||
|
CanSendPolls bool `json:"can_send_polls"`
|
||||||
|
CanSendOtherMessages bool `json:"can_send_other_messages"`
|
||||||
|
CanAddWebPagePreview bool `json:"can_add_web_page_previews"`
|
||||||
|
CanEditTag bool `json:"can_edit_tag"`
|
||||||
|
CanChangeInfo bool `json:"can_change_info"`
|
||||||
|
CanInviteUsers bool `json:"can_invite_users"`
|
||||||
|
CanPinMessages bool `json:"can_pin_messages"`
|
||||||
|
CanManageTopics bool `json:"can_manage_topics"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ChatLocation represents a location to which a chat is connected.
|
||||||
|
// See https://core.telegram.org/bots/api#chatlocation
|
||||||
|
type ChatLocation struct {
|
||||||
|
Location Location `json:"location"`
|
||||||
|
Address string `json:"address"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ChatInviteLink represents an invite link for a chat.
|
||||||
|
// See https://core.telegram.org/bots/api#chatinvitelink
|
||||||
|
type ChatInviteLink struct {
|
||||||
|
InviteLink string `json:"invite_link"`
|
||||||
|
Creator User `json:"creator"`
|
||||||
|
CreateJoinRequest bool `json:"creates_join_request"`
|
||||||
|
IsPrimary bool `json:"is_primary"`
|
||||||
|
IsRevoked bool `json:"is_revoked"`
|
||||||
|
|
||||||
|
Name *string `json:"name,omitempty"`
|
||||||
|
ExpireDate *int `json:"expire_date,omitempty"`
|
||||||
|
MemberLimit *int `json:"member_limit,omitempty"`
|
||||||
|
PendingJoinRequestCount *int `json:"pending_join_request_count,omitempty"`
|
||||||
|
SubscriptionPeriod *int `json:"subscription_period,omitempty"`
|
||||||
|
SubscriptionPrice *int `json:"subscription_price,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ChatMemberStatusType indicates the status of a chat member.
|
||||||
|
type ChatMemberStatusType string
|
||||||
|
|
||||||
|
const (
|
||||||
|
// ChatMemberStatusOwner identifies a chat owner.
|
||||||
|
ChatMemberStatusOwner ChatMemberStatusType = "owner"
|
||||||
|
// ChatMemberStatusAdministrator identifies a chat administrator.
|
||||||
|
ChatMemberStatusAdministrator ChatMemberStatusType = "administrator"
|
||||||
|
// ChatMemberStatusMember identifies a regular member.
|
||||||
|
ChatMemberStatusMember ChatMemberStatusType = "member"
|
||||||
|
// ChatMemberStatusRestricted identifies a restricted member.
|
||||||
|
ChatMemberStatusRestricted ChatMemberStatusType = "restricted"
|
||||||
|
// ChatMemberStatusLeft identifies a user who left the chat.
|
||||||
|
ChatMemberStatusLeft ChatMemberStatusType = "left"
|
||||||
|
// ChatMemberStatusBanned identifies a banned user.
|
||||||
|
ChatMemberStatusBanned ChatMemberStatusType = "kicked"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ChatMember contains information about one member of a chat.
|
||||||
|
// See https://core.telegram.org/bots/api#chatmember
|
||||||
|
type ChatMember struct {
|
||||||
|
Status ChatMemberStatusType `json:"status"`
|
||||||
|
User User `json:"user"`
|
||||||
|
Tag string `json:"tag,omitempty"`
|
||||||
|
|
||||||
|
// Owner
|
||||||
|
IsAnonymous *bool `json:"is_anonymous"`
|
||||||
|
CustomTitle *string `json:"custom_title,omitempty"`
|
||||||
|
|
||||||
|
// Administrator
|
||||||
|
CanBeEdited *bool `json:"can_be_edited,omitempty"`
|
||||||
|
CanManageChat *bool `json:"can_manage_chat,omitempty"`
|
||||||
|
CanDeleteMessages *bool `json:"can_delete_messages,omitempty"`
|
||||||
|
CanManageVideoChats *bool `json:"can_manage_video_chats,omitempty"`
|
||||||
|
CanRestrictMembers *bool `json:"can_restrict_members,omitempty"`
|
||||||
|
CanPromoteMembers *bool `json:"can_promote_members,omitempty"`
|
||||||
|
CanChangeInfo *bool `json:"can_change_info,omitempty"`
|
||||||
|
CanInviteUsers *bool `json:"can_invite_users,omitempty"`
|
||||||
|
CanPostStories *bool `json:"can_post_stories,omitempty"`
|
||||||
|
CanEditStories *bool `json:"can_edit_stories,omitempty"`
|
||||||
|
CanDeleteStories *bool `json:"can_delete_stories,omitempty"`
|
||||||
|
|
||||||
|
CanPostMessages *bool `json:"can_post_messages,omitempty"`
|
||||||
|
CanEditMessages *bool `json:"can_edit_messages,omitempty"`
|
||||||
|
CanPinMessages *bool `json:"can_pin_messages,omitempty"`
|
||||||
|
CanManageTopics *bool `json:"can_manage_topics,omitempty"`
|
||||||
|
CanManageDirectMessages *bool `json:"can_manage_direct_messages,omitempty"`
|
||||||
|
CanManageTags *bool `json:"can_manage_tags,omitempty"`
|
||||||
|
|
||||||
|
// Member
|
||||||
|
UntilDate *int `json:"until_date,omitempty"`
|
||||||
|
|
||||||
|
// Restricted
|
||||||
|
IsMember *bool `json:"is_member,omitempty"`
|
||||||
|
CanSendMessages *bool `json:"can_send_messages,omitempty"`
|
||||||
|
CanSendAudios *bool `json:"can_send_audios,omitempty"`
|
||||||
|
CanSendDocuments *bool `json:"can_send_documents,omitempty"`
|
||||||
|
CanSendPhotos *bool `json:"can_send_photos,omitempty"`
|
||||||
|
CanSendVideos *bool `json:"can_send_videos,omitempty"`
|
||||||
|
CanSendVideoNotes *bool `json:"can_send_video_notes,omitempty"`
|
||||||
|
CanSendVoiceNotes *bool `json:"can_send_voice_notes,omitempty"`
|
||||||
|
CanSendPolls *bool `json:"can_send_polls,omitempty"`
|
||||||
|
CanSendOtherMessages *bool `json:"can_send_other_messages,omitempty"`
|
||||||
|
CanAddWebPagePreview *bool `json:"can_add_web_page_previews,omitempty"`
|
||||||
|
CanEditTag *bool `json:"can_edit_tag,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ChatBoostSource describes the source of a chat boost.
|
||||||
|
// See https://core.telegram.org/bots/api#chatboostsource
|
||||||
|
type ChatBoostSource struct {
|
||||||
|
Source string `json:"source"`
|
||||||
|
User User `json:"user"`
|
||||||
|
|
||||||
|
// Giveaway
|
||||||
|
GiveawayMessageID *int `json:"giveaway_message_id,omitempty"`
|
||||||
|
PrizeStarCount *int `json:"prize_star_count,omitempty"`
|
||||||
|
IsUnclaimed *bool `json:"is_unclaimed,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ChatBoost represents a boost added to a chat.
|
||||||
|
// See https://core.telegram.org/bots/api#chatboost
|
||||||
|
type ChatBoost struct {
|
||||||
|
BoostID string `json:"boost_id"`
|
||||||
|
AddDate int `json:"add_date"`
|
||||||
|
ExpirationDate int `json:"expiration_date"`
|
||||||
|
Source ChatBoostSource `json:"source"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// UserChatBoosts represents a list of boosts a user has given to a chat.
|
||||||
|
// See https://core.telegram.org/bots/api#userchatboosts
|
||||||
|
type UserChatBoosts struct {
|
||||||
|
Boosts []ChatBoost `json:"boosts"`
|
||||||
|
}
|
||||||
|
type ChatBoostAdded struct {
|
||||||
|
BoostCount int `json:"boost_count"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type ChatBackground struct {
|
||||||
|
Type BackgroundType `json:"type"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ChatOwnerLeft describes a service message about a chat owner leaving.
|
||||||
|
// See https://core.telegram.org/bots/api#chatownerleft
|
||||||
|
type ChatOwnerLeft struct {
|
||||||
|
NewOwner *User `json:"new_owner,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ChatOwnerChanged describes a service message about a chat owner change.
|
||||||
|
// See https://core.telegram.org/bots/api#chatownerchanged
|
||||||
|
type ChatOwnerChanged struct {
|
||||||
|
NewOwner User `json:"new_owner"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ChatAdministratorRights represents the rights of an administrator in a chat.
|
||||||
|
// See https://core.telegram.org/bots/api#chatadministratorrights
|
||||||
|
type ChatAdministratorRights struct {
|
||||||
|
IsAnonymous bool `json:"is_anonymous"`
|
||||||
|
CanManageChat bool `json:"can_manage_chat"`
|
||||||
|
CanDeleteMessages bool `json:"can_delete_messages"`
|
||||||
|
CanManageVideoChats bool `json:"can_manage_video_chats"`
|
||||||
|
CanRestrictMembers bool `json:"can_restrict_members"`
|
||||||
|
CanPromoteMembers bool `json:"can_promote_members"`
|
||||||
|
CanChangeInfo bool `json:"can_change_info"`
|
||||||
|
CanInviteUsers bool `json:"can_invite_users"`
|
||||||
|
CanPostStories bool `json:"can_post_stories"`
|
||||||
|
CanEditStories bool `json:"can_edit_stories"`
|
||||||
|
CanDeleteStories bool `json:"can_delete_stories"`
|
||||||
|
|
||||||
|
CanPostMessages *bool `json:"can_post_messages,omitempty"`
|
||||||
|
CanEditMessages *bool `json:"can_edit_messages,omitempty"`
|
||||||
|
CanPinMessages *bool `json:"can_pin_messages,omitempty"`
|
||||||
|
CanManageTopics *bool `json:"can_manage_topics,omitempty"`
|
||||||
|
CanManageDirectMessages *bool `json:"can_manage_direct_messages,omitempty"`
|
||||||
|
CanManageTags *bool `json:"can_manage_tags,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ChatBoostUpdated represents a boost added to a chat or changed.
|
||||||
|
// See https://core.telegram.org/bots/api#chatboostupdated
|
||||||
|
type ChatBoostUpdated struct {
|
||||||
|
Chat Chat `json:"chat"`
|
||||||
|
Boost ChatBoost `json:"boost"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ChatBoostRemoved represents a boost removed from a chat.
|
||||||
|
// See https://core.telegram.org/bots/api#chatboostremoved
|
||||||
|
type ChatBoostRemoved struct {
|
||||||
|
Chat Chat `json:"chat"`
|
||||||
|
BoostID string `json:"boost_id"`
|
||||||
|
RemoveDate int `json:"remove_date"`
|
||||||
|
Source ChatBoostSource `json:"source"`
|
||||||
|
}
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import "errors"
|
||||||
|
|
||||||
|
// ErrPoolUnexpected reports an unexpected result type returned from the worker pool.
|
||||||
|
var ErrPoolUnexpected = errors.New("unexpected response from pool")
|
||||||
|
|
||||||
|
// ErrPoolQueueFull reports that the internal request queue is full.
|
||||||
|
var ErrPoolQueueFull = errors.New("worker pool queue full")
|
||||||
|
|
||||||
|
// ErrPoolStopped reports that a request was submitted after the worker pool stopped.
|
||||||
|
var ErrPoolStopped = errors.New("worker pool stopped")
|
||||||
@@ -0,0 +1,245 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import "context"
|
||||||
|
|
||||||
|
// BaseForumTopic contains common fields for forum topic operations that require a chat ID and a message thread ID.
|
||||||
|
type BaseForumTopic struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetForumTopicIconStickers returns the list of custom emoji that can be used as a forum topic icon.
|
||||||
|
// See https://core.telegram.org/bots/api#getforumtopiciconstickers
|
||||||
|
func (api *API) GetForumTopicIconStickers() ([]Sticker, error) {
|
||||||
|
req := NewRequest[[]Sticker]("getForumTopicIconStickers", NoParams)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetForumTopicIconStickersWithContext is the context-aware variant of GetForumTopicIconStickers.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getforumtopiciconstickers
|
||||||
|
func (api *API) GetForumTopicIconStickersWithContext(ctx context.Context) ([]Sticker, error) {
|
||||||
|
req := NewRequest[[]Sticker]("getForumTopicIconStickers", NoParams)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CreateForumTopic holds parameters for the createForumTopic method.
|
||||||
|
// See https://core.telegram.org/bots/api#createforumtopic
|
||||||
|
type CreateForumTopic struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
Name string `json:"name"`
|
||||||
|
IconColor ForumTopicIconColor `json:"icon_color"`
|
||||||
|
IconCustomEmojiID string `json:"icon_custom_emoji_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// CreateForumTopic creates a topic in a forum supergroup.
|
||||||
|
// Returns the created ForumTopic on success.
|
||||||
|
// See https://core.telegram.org/bots/api#createforumtopic
|
||||||
|
func (api *API) CreateForumTopic(params CreateForumTopic) (ForumTopic, error) {
|
||||||
|
req := NewRequestWithChatID[ForumTopic]("createForumTopic", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CreateForumTopicWithContext is the context-aware variant of CreateForumTopic.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#createforumtopic
|
||||||
|
func (api *API) CreateForumTopicWithContext(ctx context.Context, params CreateForumTopic) (ForumTopic, error) {
|
||||||
|
req := NewRequestWithChatID[ForumTopic]("createForumTopic", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditForumTopic holds parameters for the editForumTopic method.
|
||||||
|
// See https://core.telegram.org/bots/api#editforumtopic
|
||||||
|
type EditForumTopic struct {
|
||||||
|
BaseForumTopic
|
||||||
|
Name string `json:"name"`
|
||||||
|
IconCustomEmojiID string `json:"icon_custom_emoji_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditForumTopic edits name and icon of a forum topic.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#editforumtopic
|
||||||
|
func (api *API) EditForumTopic(params EditForumTopic) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("editForumTopic", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditForumTopicWithContext is the context-aware variant of EditForumTopic.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#editforumtopic
|
||||||
|
func (api *API) EditForumTopicWithContext(ctx context.Context, params EditForumTopic) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("editForumTopic", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CloseForumTopic closes an open forum topic.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#closeforumtopic
|
||||||
|
func (api *API) CloseForumTopic(params BaseForumTopic) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("closeForumTopic", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CloseForumTopicWithContext is the context-aware variant of CloseForumTopic.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#closeforumtopic
|
||||||
|
func (api *API) CloseForumTopicWithContext(ctx context.Context, params BaseForumTopic) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("closeForumTopic", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReopenForumTopic reopens a closed forum topic.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#reopenforumtopic
|
||||||
|
func (api *API) ReopenForumTopic(params BaseForumTopic) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("reopenForumTopic", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReopenForumTopicWithContext is the context-aware variant of ReopenForumTopic.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#reopenforumtopic
|
||||||
|
func (api *API) ReopenForumTopicWithContext(ctx context.Context, params BaseForumTopic) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("reopenForumTopic", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteForumTopic deletes a forum topic.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#deleteforumtopic
|
||||||
|
func (api *API) DeleteForumTopic(params BaseForumTopic) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("deleteForumTopic", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteForumTopicWithContext is the context-aware variant of DeleteForumTopic.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#deleteforumtopic
|
||||||
|
func (api *API) DeleteForumTopicWithContext(ctx context.Context, params BaseForumTopic) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("deleteForumTopic", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnpinAllForumTopicMessages clears the list of pinned messages in a forum topic.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#unpinallforumtopicmessages
|
||||||
|
func (api *API) UnpinAllForumTopicMessages(params BaseForumTopic) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("unpinAllForumTopicMessages", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnpinAllForumTopicMessagesWithContext is the context-aware variant of UnpinAllForumTopicMessages.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#unpinallforumtopicmessages
|
||||||
|
func (api *API) UnpinAllForumTopicMessagesWithContext(ctx context.Context, params BaseForumTopic) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("unpinAllForumTopicMessages", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BaseGeneralForumTopic contains common fields for general forum topic operations that require a chat ID.
|
||||||
|
type BaseGeneralForumTopic struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditGeneralForumTopic holds parameters for the editGeneralForumTopic method.
|
||||||
|
// See https://core.telegram.org/bots/api#editgeneralforumtopic
|
||||||
|
type EditGeneralForumTopic struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
Name string `json:"name"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditGeneralForumTopic edits the name of the 'General' topic in a forum supergroup.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#editgeneralforumtopic
|
||||||
|
func (api *API) EditGeneralForumTopic(params EditGeneralForumTopic) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("editGeneralForumTopic", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditGeneralForumTopicWithContext is the context-aware variant of EditGeneralForumTopic.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#editgeneralforumtopic
|
||||||
|
func (api *API) EditGeneralForumTopicWithContext(ctx context.Context, params EditGeneralForumTopic) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("editGeneralForumTopic", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CloseGeneralForumTopic closes the 'General' topic in a forum supergroup.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#closegeneralforumtopic
|
||||||
|
func (api *API) CloseGeneralForumTopic(params BaseGeneralForumTopic) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("closeGeneralForumTopic", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CloseGeneralForumTopicWithContext is the context-aware variant of CloseGeneralForumTopic.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#closegeneralforumtopic
|
||||||
|
func (api *API) CloseGeneralForumTopicWithContext(ctx context.Context, params BaseGeneralForumTopic) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("closeGeneralForumTopic", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReopenGeneralForumTopic reopens the 'General' topic in a forum supergroup.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#reopengeneralforumtopic
|
||||||
|
func (api *API) ReopenGeneralForumTopic(params BaseGeneralForumTopic) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("reopenGeneralForumTopic", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReopenGeneralForumTopicWithContext is the context-aware variant of ReopenGeneralForumTopic.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#reopengeneralforumtopic
|
||||||
|
func (api *API) ReopenGeneralForumTopicWithContext(ctx context.Context, params BaseGeneralForumTopic) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("reopenGeneralForumTopic", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// HideGeneralForumTopic hides the 'General' topic in a forum supergroup.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#hidegeneralforumtopic
|
||||||
|
func (api *API) HideGeneralForumTopic(params BaseGeneralForumTopic) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("hideGeneralForumTopic", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// HideGeneralForumTopicWithContext is the context-aware variant of HideGeneralForumTopic.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#hidegeneralforumtopic
|
||||||
|
func (api *API) HideGeneralForumTopicWithContext(ctx context.Context, params BaseGeneralForumTopic) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("hideGeneralForumTopic", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnhideGeneralForumTopic unhides the 'General' topic in a forum supergroup.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#unhidegeneralforumtopic
|
||||||
|
func (api *API) UnhideGeneralForumTopic(params BaseGeneralForumTopic) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("unhideGeneralForumTopic", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnhideGeneralForumTopicWithContext is the context-aware variant of UnhideGeneralForumTopic.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#unhidegeneralforumtopic
|
||||||
|
func (api *API) UnhideGeneralForumTopicWithContext(ctx context.Context, params BaseGeneralForumTopic) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("unhideGeneralForumTopic", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnpinAllGeneralForumTopicMessages clears the list of pinned messages in the 'General' topic.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#unpinallgeneralforumtopicmessages
|
||||||
|
func (api *API) UnpinAllGeneralForumTopicMessages(params BaseGeneralForumTopic) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("unpinAllGeneralForumTopicMessages", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnpinAllGeneralForumTopicMessagesWithContext is the context-aware variant of UnpinAllGeneralForumTopicMessages.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#unpinallgeneralforumtopicmessages
|
||||||
|
func (api *API) UnpinAllGeneralForumTopicMessagesWithContext(ctx context.Context, params BaseGeneralForumTopic) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("unpinAllGeneralForumTopicMessages", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
// ForumTopic represents a forum topic.
|
||||||
|
// See https://core.telegram.org/bots/api#forumtopic
|
||||||
|
type ForumTopic struct {
|
||||||
|
MessageThreadID int `json:"message_thread_id"`
|
||||||
|
Name string `json:"name"`
|
||||||
|
IconColor int `json:"icon_color"`
|
||||||
|
IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
|
||||||
|
IsNameImplicit bool `json:"is_name_implicit,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ForumTopicIconColor represents the color of a forum topic icon.
|
||||||
|
// The value is an integer representing the color in RGB format.
|
||||||
|
// See https://core.telegram.org/bots/api#forumtopiciconcolor
|
||||||
|
type ForumTopicIconColor int
|
||||||
|
|
||||||
|
const (
|
||||||
|
// ForumTopicIconColorBlue is the blue color for forum topic icons (value 7322096).
|
||||||
|
ForumTopicIconColorBlue ForumTopicIconColor = 7322096
|
||||||
|
)
|
||||||
|
|
||||||
|
type ForumTopicCreated struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
IconColor int `json:"icon_color"`
|
||||||
|
IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
|
||||||
|
IsNameImplicit bool `json:"is_name_implicit,omitempty"`
|
||||||
|
}
|
||||||
|
type ForumTopicEdited struct {
|
||||||
|
Name string `json:"name,omitempty"`
|
||||||
|
IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
|
||||||
|
}
|
||||||
|
type ForumTopicClosed struct{}
|
||||||
|
type ForumTopicReopened struct{}
|
||||||
|
type GeneralForumTopicHidden struct{}
|
||||||
|
type GeneralForumTopicUnhidden struct {
|
||||||
|
}
|
||||||
@@ -0,0 +1,102 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import "context"
|
||||||
|
|
||||||
|
// SendGame holds parameters for the sendGame method.
|
||||||
|
// See https://core.telegram.org/bots/api#sendgame
|
||||||
|
type SendGame struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
|
||||||
|
GameShortName string `json:"game_short_name"`
|
||||||
|
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendGame sends a game message.
|
||||||
|
// See https://core.telegram.org/bots/api#sendgame
|
||||||
|
func (api *API) SendGame(params SendGame) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendGame", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendGameWithContext is the context-aware variant of SendGame.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#sendgame
|
||||||
|
func (api *API) SendGameWithContext(ctx context.Context, params SendGame) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendGame", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetGameScore holds parameters for the setGameScore method.
|
||||||
|
// See https://core.telegram.org/bots/api#setgamescore
|
||||||
|
type SetGameScore struct {
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
Score int `json:"score"`
|
||||||
|
Force bool `json:"force,omitempty"`
|
||||||
|
DisableEditMessage bool `json:"disable_edit_message,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id,omitempty"`
|
||||||
|
MessageID int `json:"message_id,omitempty"`
|
||||||
|
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetGameScore sets a user's score in a game message.
|
||||||
|
// If inline_message_id is provided, returns a boolean success flag.
|
||||||
|
// Otherwise returns the edited Message.
|
||||||
|
// See https://core.telegram.org/bots/api#setgamescore
|
||||||
|
func (api *API) SetGameScore(params SetGameScore) (Message, bool, error) {
|
||||||
|
var zero Message
|
||||||
|
if params.InlineMessageID != "" {
|
||||||
|
req := NewRequestWithChatID[bool]("setGameScore", params, params.ChatID)
|
||||||
|
res, err := req.Do(api)
|
||||||
|
return zero, res, err
|
||||||
|
}
|
||||||
|
req := NewRequestWithChatID[Message]("setGameScore", params, params.ChatID)
|
||||||
|
res, err := req.Do(api)
|
||||||
|
return res, false, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetGameScoreWithContext is the context-aware variant of SetGameScore.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setgamescore
|
||||||
|
func (api *API) SetGameScoreWithContext(ctx context.Context, params SetGameScore) (Message, bool, error) {
|
||||||
|
var zero Message
|
||||||
|
if params.InlineMessageID != "" {
|
||||||
|
req := NewRequestWithChatID[bool]("setGameScore", params, params.ChatID)
|
||||||
|
res, err := req.DoWithContext(ctx, api)
|
||||||
|
return zero, res, err
|
||||||
|
}
|
||||||
|
req := NewRequestWithChatID[Message]("setGameScore", params, params.ChatID)
|
||||||
|
res, err := req.DoWithContext(ctx, api)
|
||||||
|
return res, false, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetGameHighScores holds parameters for the getGameHighScores method.
|
||||||
|
// See https://core.telegram.org/bots/api#getgamehighscores
|
||||||
|
type GetGameHighScores struct {
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
ChatID int64 `json:"chat_id,omitempty"`
|
||||||
|
MessageID int `json:"message_id,omitempty"`
|
||||||
|
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetGameHighScores returns game high score data for a user.
|
||||||
|
// See https://core.telegram.org/bots/api#getgamehighscores
|
||||||
|
func (api *API) GetGameHighScores(params GetGameHighScores) ([]GameHighScore, error) {
|
||||||
|
req := NewRequestWithChatID[[]GameHighScore]("getGameHighScores", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetGameHighScoresWithContext is the context-aware variant of GetGameHighScores.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getgamehighscores
|
||||||
|
func (api *API) GetGameHighScoresWithContext(ctx context.Context, params GetGameHighScores) ([]GameHighScore, error) {
|
||||||
|
req := NewRequestWithChatID[[]GameHighScore]("getGameHighScores", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
type Game struct {
|
||||||
|
Title string `json:"title"`
|
||||||
|
Description string `json:"description"`
|
||||||
|
Photo []PhotoSize `json:"photo"`
|
||||||
|
Text string `json:"text,omitempty"`
|
||||||
|
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
||||||
|
Animation *Animation `json:"animation,omitempty"`
|
||||||
|
}
|
||||||
|
type CallbackGame struct{}
|
||||||
|
|
||||||
|
// GameHighScore represents one row in a game high score table.
|
||||||
|
// See https://core.telegram.org/bots/api#gamehighscore
|
||||||
|
type GameHighScore struct {
|
||||||
|
Position int `json:"position"`
|
||||||
|
User User `json:"user"`
|
||||||
|
Score int `json:"score"`
|
||||||
|
}
|
||||||
@@ -0,0 +1,100 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import "context"
|
||||||
|
|
||||||
|
// AnswerInlineQuery holds parameters for the answerInlineQuery method.
|
||||||
|
// See https://core.telegram.org/bots/api#answerinlinequery
|
||||||
|
type AnswerInlineQuery struct {
|
||||||
|
InlineQueryID string `json:"inline_query_id"`
|
||||||
|
Results []InlineQueryResult `json:"results"`
|
||||||
|
CacheTime int `json:"cache_time,omitempty"`
|
||||||
|
IsPersonal bool `json:"is_personal,omitempty"`
|
||||||
|
NextOffset string `json:"next_offset,omitempty"`
|
||||||
|
Button *InlineQueryResultsButton `json:"button,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnswerInlineQuery sends answers to an inline query.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#answerinlinequery
|
||||||
|
func (api *API) AnswerInlineQuery(params AnswerInlineQuery) (bool, error) {
|
||||||
|
req := NewRequest[bool]("answerInlineQuery", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnswerInlineQueryWithContext is the context-aware variant of AnswerInlineQuery.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#answerinlinequery
|
||||||
|
func (api *API) AnswerInlineQueryWithContext(ctx context.Context, params AnswerInlineQuery) (bool, error) {
|
||||||
|
req := NewRequest[bool]("answerInlineQuery", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnswerWebAppQuery holds parameters for the answerWebAppQuery method.
|
||||||
|
// See https://core.telegram.org/bots/api#answerwebappquery
|
||||||
|
type AnswerWebAppQuery struct {
|
||||||
|
WebAppQueryID string `json:"web_app_query_id"`
|
||||||
|
Result InlineQueryResult `json:"result"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnswerWebAppQuery sets the result of a Web App interaction.
|
||||||
|
// See https://core.telegram.org/bots/api#answerwebappquery
|
||||||
|
func (api *API) AnswerWebAppQuery(params AnswerWebAppQuery) (SentWebAppMessage, error) {
|
||||||
|
req := NewRequest[SentWebAppMessage]("answerWebAppQuery", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnswerWebAppQueryWithContext is the context-aware variant of AnswerWebAppQuery.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#answerwebappquery
|
||||||
|
func (api *API) AnswerWebAppQueryWithContext(ctx context.Context, params AnswerWebAppQuery) (SentWebAppMessage, error) {
|
||||||
|
req := NewRequest[SentWebAppMessage]("answerWebAppQuery", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SavePreparedInlineMessage holds parameters for the savePreparedInlineMessage method.
|
||||||
|
// See https://core.telegram.org/bots/api#savepreparedinlinemessage
|
||||||
|
type SavePreparedInlineMessage struct {
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
Result InlineQueryResult `json:"result"`
|
||||||
|
AllowUserChats bool `json:"allow_user_chats,omitempty"`
|
||||||
|
AllowBotChats bool `json:"allow_bot_chats,omitempty"`
|
||||||
|
AllowGroupChats bool `json:"allow_group_chats,omitempty"`
|
||||||
|
AllowChannelChats bool `json:"allow_channel_chats,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SavePreparedInlineMessage stores a prepared message for Mini App users.
|
||||||
|
// See https://core.telegram.org/bots/api#savepreparedinlinemessage
|
||||||
|
func (api *API) SavePreparedInlineMessage(params SavePreparedInlineMessage) (PreparedInlineMessage, error) {
|
||||||
|
req := NewRequest[PreparedInlineMessage]("savePreparedInlineMessage", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SavePreparedInlineMessageWithContext is the context-aware variant of SavePreparedInlineMessage.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#savepreparedinlinemessage
|
||||||
|
func (api *API) SavePreparedInlineMessageWithContext(ctx context.Context, params SavePreparedInlineMessage) (PreparedInlineMessage, error) {
|
||||||
|
req := NewRequest[PreparedInlineMessage]("savePreparedInlineMessage", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SavePreparedKeyboardButton holds parameters for the savePreparedKeyboardButton method.
|
||||||
|
// See https://core.telegram.org/bots/api#savepreparedkeyboardbutton
|
||||||
|
type SavePreparedKeyboardButton struct {
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
Button KeyboardButton `json:"button"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SavePreparedKeyboardButton stores a prepared keyboard button for Mini App users.
|
||||||
|
// See https://core.telegram.org/bots/api#savepreparedkeyboardbutton
|
||||||
|
func (api *API) SavePreparedKeyboardButton(params SavePreparedKeyboardButton) (PreparedKeyboardButton, error) {
|
||||||
|
req := NewRequest[PreparedKeyboardButton]("savePreparedKeyboardButton", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SavePreparedKeyboardButtonWithContext is the context-aware variant of SavePreparedKeyboardButton.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#savepreparedkeyboardbutton
|
||||||
|
func (api *API) SavePreparedKeyboardButtonWithContext(ctx context.Context, params SavePreparedKeyboardButton) (PreparedKeyboardButton, error) {
|
||||||
|
req := NewRequest[PreparedKeyboardButton]("savePreparedKeyboardButton", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
// InlineQueryResult is a JSON-serializable inline query result object.
|
||||||
|
// See https://core.telegram.org/bots/api#inlinequeryresult
|
||||||
|
type InlineQueryResult map[string]any
|
||||||
|
|
||||||
|
// InlineQueryResultsButton represents a button shown above inline query results.
|
||||||
|
// See https://core.telegram.org/bots/api#inlinequeryresultsbutton
|
||||||
|
type InlineQueryResultsButton struct {
|
||||||
|
Text string `json:"text"`
|
||||||
|
WebApp *WebAppInfo `json:"web_app,omitempty"`
|
||||||
|
StartParameter string `json:"start_parameter,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SentWebAppMessage describes an inline message sent by a Web App on behalf of a user.
|
||||||
|
// See https://core.telegram.org/bots/api#sentwebappmessage
|
||||||
|
type SentWebAppMessage struct {
|
||||||
|
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// PreparedInlineMessage describes a prepared inline message.
|
||||||
|
// See https://core.telegram.org/bots/api#preparedinlinemessage
|
||||||
|
type PreparedInlineMessage struct {
|
||||||
|
ID string `json:"id"`
|
||||||
|
ExpirationDate int `json:"expiration_date"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// PreparedKeyboardButton describes a prepared keyboard button.
|
||||||
|
// See https://core.telegram.org/bots/api#preparedkeyboardbutton
|
||||||
|
type PreparedKeyboardButton struct {
|
||||||
|
ID string `json:"id"`
|
||||||
|
}
|
||||||
@@ -0,0 +1,925 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import "context"
|
||||||
|
|
||||||
|
// SendMessage holds parameters for the sendMessage method.
|
||||||
|
// See https://core.telegram.org/bots/api#sendmessage
|
||||||
|
type SendMessage struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int64 `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
Text string `json:"text"`
|
||||||
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
Entities []MessageEntity `json:"entities,omitempty"`
|
||||||
|
LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"`
|
||||||
|
DisableNotifications bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendMessage sends a text message.
|
||||||
|
// See https://core.telegram.org/bots/api#sendmessage
|
||||||
|
func (api *API) SendMessage(params SendMessage) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message, SendMessage]("sendMessage", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendMessageWithContext is the context-aware variant of SendMessage.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#sendmessage
|
||||||
|
func (api *API) SendMessageWithContext(ctx context.Context, params SendMessage) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message, SendMessage]("sendMessage", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ForwardMessage holds parameters for the forwardMessage method.
|
||||||
|
// See https://core.telegram.org/bots/api#forwardmessage
|
||||||
|
type ForwardMessage struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
MessageID int `json:"message_id,omitempty"`
|
||||||
|
FromChatID int64 `json:"from_chat_id,omitempty"`
|
||||||
|
VideoStartTimestamp int `json:"video_start_timestamp,omitempty"`
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ForwardMessage forwards a message.
|
||||||
|
// See https://core.telegram.org/bots/api#forwardmessage
|
||||||
|
func (api *API) ForwardMessage(params ForwardMessage) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("forwardMessage", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ForwardMessageWithContext is the context-aware variant of ForwardMessage.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#forwardmessage
|
||||||
|
func (api *API) ForwardMessageWithContext(ctx context.Context, params ForwardMessage) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("forwardMessage", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ForwardMessages holds parameters for the forwardMessages method.
|
||||||
|
// See https://core.telegram.org/bots/api#forwardmessages
|
||||||
|
type ForwardMessages struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
FromChatID int64 `json:"from_chat_id,omitempty"`
|
||||||
|
MessageIDs []int `json:"message_ids,omitempty"`
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ForwardMessages forwards multiple messages.
|
||||||
|
// Returns an array of message IDs of the sent messages.
|
||||||
|
// See https://core.telegram.org/bots/api#forwardmessages
|
||||||
|
func (api *API) ForwardMessages(params ForwardMessages) ([]MessageID, error) {
|
||||||
|
req := NewRequestWithChatID[[]MessageID]("forwardMessages", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ForwardMessagesWithContext is the context-aware variant of ForwardMessages.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#forwardmessages
|
||||||
|
func (api *API) ForwardMessagesWithContext(ctx context.Context, params ForwardMessages) ([]MessageID, error) {
|
||||||
|
req := NewRequestWithChatID[[]MessageID]("forwardMessages", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CopyMessage holds parameters for the copyMessage method.
|
||||||
|
// See https://core.telegram.org/bots/api#copymessage
|
||||||
|
type CopyMessage struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
FromChatID int64 `json:"from_chat_id"`
|
||||||
|
MessageID int `json:"message_id"`
|
||||||
|
VideoStartTimestamp int `json:"video_start_timestamp,omitempty"`
|
||||||
|
Caption string `json:"caption,omitempty"`
|
||||||
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
|
||||||
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// CopyMessage copies a message.
|
||||||
|
// Returns the MessageID of the sent copy.
|
||||||
|
// See https://core.telegram.org/bots/api#copymessage
|
||||||
|
func (api *API) CopyMessage(params CopyMessage) (int, error) {
|
||||||
|
msgID, err := NewRequestWithChatID[MessageID]("copyMessage", params, params.ChatID).Do(api)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
return msgID.MessageID, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// CopyMessageWithContext is the context-aware variant of CopyMessage.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#copymessage
|
||||||
|
func (api *API) CopyMessageWithContext(ctx context.Context, params CopyMessage) (int, error) {
|
||||||
|
msgID, err := NewRequestWithChatID[MessageID]("copyMessage", params, params.ChatID).DoWithContext(ctx, api)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
return msgID.MessageID, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// CopyMessages holds parameters for the copyMessages method.
|
||||||
|
// See https://core.telegram.org/bots/api#copymessages
|
||||||
|
type CopyMessages struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
FromChatID int64 `json:"from_chat_id,omitempty"`
|
||||||
|
MessageIDs []int `json:"message_ids,omitempty"`
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
RemoveCaption bool `json:"remove_caption,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// CopyMessages copies multiple messages.
|
||||||
|
// Returns an array of message IDs of the sent copies.
|
||||||
|
// See https://core.telegram.org/bots/api#copymessages
|
||||||
|
func (api *API) CopyMessages(params CopyMessages) ([]MessageID, error) {
|
||||||
|
req := NewRequestWithChatID[[]MessageID]("copyMessages", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CopyMessagesWithContext is the context-aware variant of CopyMessages.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#copymessages
|
||||||
|
func (api *API) CopyMessagesWithContext(ctx context.Context, params CopyMessages) ([]MessageID, error) {
|
||||||
|
req := NewRequestWithChatID[[]MessageID]("copyMessages", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendLocation holds parameters for the sendLocation method.
|
||||||
|
// See https://core.telegram.org/bots/api#sendlocation
|
||||||
|
type SendLocation struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
Latitude float64 `json:"latitude"`
|
||||||
|
Longitude float64 `json:"longitude"`
|
||||||
|
HorizontalAccuracy float64 `json:"horizontal_accuracy,omitempty"`
|
||||||
|
LivePeriod int `json:"live_period,omitempty"`
|
||||||
|
Heading int `json:"heading,omitempty"`
|
||||||
|
ProximityAlertRadius int `json:"proximity_alert_radius,omitempty"`
|
||||||
|
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendLocation sends a point on the map.
|
||||||
|
// See https://core.telegram.org/bots/api#sendlocation
|
||||||
|
func (api *API) SendLocation(params SendLocation) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendLocation", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendLocationWithContext is the context-aware variant of SendLocation.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#sendlocation
|
||||||
|
func (api *API) SendLocationWithContext(ctx context.Context, params SendLocation) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendLocation", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendVenue holds parameters for the sendVenue method.
|
||||||
|
// See https://core.telegram.org/bots/api#sendvenue
|
||||||
|
type SendVenue struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
Latitude float64 `json:"latitude"`
|
||||||
|
Longitude float64 `json:"longitude"`
|
||||||
|
Title string `json:"title"`
|
||||||
|
Address string `json:"address"`
|
||||||
|
FoursquareID string `json:"foursquare_id,omitempty"`
|
||||||
|
FoursquareType string `json:"foursquare_type,omitempty"`
|
||||||
|
GooglePlaceID string `json:"google_place_id,omitempty"`
|
||||||
|
GooglePlaceType string `json:"google_place_type,omitempty"`
|
||||||
|
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendVenue sends information about a venue.
|
||||||
|
// See https://core.telegram.org/bots/api#sendvenue
|
||||||
|
func (api *API) SendVenue(params SendVenue) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendVenue", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendVenueWithContext is the context-aware variant of SendVenue.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#sendvenue
|
||||||
|
func (api *API) SendVenueWithContext(ctx context.Context, params SendVenue) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendVenue", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendContact holds parameters for the sendContact method.
|
||||||
|
// See https://core.telegram.org/bots/api#sendcontact
|
||||||
|
type SendContact struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
PhoneNumber string `json:"phone_number"`
|
||||||
|
FirstName string `json:"first_name"`
|
||||||
|
LastName string `json:"last_name,omitempty"`
|
||||||
|
Vcard string `json:"vcard"`
|
||||||
|
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendContact sends a phone contact.
|
||||||
|
// See https://core.telegram.org/bots/api#sendcontact
|
||||||
|
func (api *API) SendContact(params SendContact) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendContact", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendContactWithContext is the context-aware variant of SendContact.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#sendcontact
|
||||||
|
func (api *API) SendContactWithContext(ctx context.Context, params SendContact) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendContact", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendPoll holds parameters for the sendPoll method.
|
||||||
|
// See https://core.telegram.org/bots/api#sendpoll
|
||||||
|
type SendPoll struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
|
||||||
|
Question string `json:"question"`
|
||||||
|
QuestionParseMode ParseMode `json:"question_parse_mode,omitempty"`
|
||||||
|
QuestionEntities []MessageEntity `json:"question_entities,omitempty"`
|
||||||
|
Options []InputPollOption `json:"options"`
|
||||||
|
IsAnonymous bool `json:"is_anonymous,omitempty"`
|
||||||
|
Type PollType `json:"type"`
|
||||||
|
AllowsMultipleAnswers bool `json:"allows_multiple_answers,omitempty"`
|
||||||
|
AllowsRevoting bool `json:"allows_revoting,omitempty"`
|
||||||
|
ShuffleOptions bool `json:"shuffle_options,omitempty"`
|
||||||
|
AllowAddingOptions bool `json:"allow_adding_options,omitempty"`
|
||||||
|
HideResultsUntilCloses bool `json:"hide_results_until_closes,omitempty"`
|
||||||
|
CorrectOptionIDs []int `json:"correct_option_ids,omitempty"`
|
||||||
|
Explanation string `json:"explanation,omitempty"`
|
||||||
|
ExplanationParseMode ParseMode `json:"explanation_parse_mode,omitempty"`
|
||||||
|
ExplanationEntities []MessageEntity `json:"explanation_entities,omitempty"`
|
||||||
|
OpenPeriod int `json:"open_period,omitempty"`
|
||||||
|
CloseDate int `json:"close_date"`
|
||||||
|
IsClosed bool `json:"is_closed,omitempty"`
|
||||||
|
|
||||||
|
Description string `json:"description"`
|
||||||
|
DescriptionParseMode ParseMode `json:"description_parse_mode,omitempty"`
|
||||||
|
DescriptionEntities []MessageEntity `json:"description_entities,omitempty"`
|
||||||
|
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendPoll sends a native poll.
|
||||||
|
// See https://core.telegram.org/bots/api#sendpoll
|
||||||
|
func (api *API) SendPoll(params SendPoll) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendPoll", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendPollWithContext is the context-aware variant of SendPoll.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#sendpoll
|
||||||
|
func (api *API) SendPollWithContext(ctx context.Context, params SendPoll) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendPoll", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendChecklist holds parameters for the sendChecklist method.
|
||||||
|
// See https://core.telegram.org/bots/api#sendchecklist
|
||||||
|
type SendChecklist struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
Checklist InputChecklist `json:"checklist"`
|
||||||
|
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendChecklist sends a checklist.
|
||||||
|
// See https://core.telegram.org/bots/api#sendchecklist
|
||||||
|
func (api *API) SendChecklist(params SendChecklist) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendChecklist", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendChecklistWithContext is the context-aware variant of SendChecklist.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#sendchecklist
|
||||||
|
func (api *API) SendChecklistWithContext(ctx context.Context, params SendChecklist) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendChecklist", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendDice holds parameters for the sendDice method.
|
||||||
|
// See https://core.telegram.org/bots/api#senddice
|
||||||
|
type SendDice struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
Emoji string `json:"emoji,omitempty"`
|
||||||
|
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendDice sends a dice, which will have a random value.
|
||||||
|
// See https://core.telegram.org/bots/api#senddice
|
||||||
|
func (api *API) SendDice(params SendDice) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendDice", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendDiceWithContext is the context-aware variant of SendDice.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#senddice
|
||||||
|
func (api *API) SendDiceWithContext(ctx context.Context, params SendDice) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendDice", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendMessageDraft holds parameters for the sendMessageDraft method.
|
||||||
|
// See https://core.telegram.org/bots/api#sendmessagedraft
|
||||||
|
type SendMessageDraft struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DraftID uint64 `json:"draft_id"`
|
||||||
|
Text string `json:"text"`
|
||||||
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
Entities []MessageEntity `json:"entities,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendMessageDraft sends or updates a draft message in the target chat.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#sendmessagedraft
|
||||||
|
func (api *API) SendMessageDraft(params SendMessageDraft) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("sendMessageDraft", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendMessageDraftWithContext is the context-aware variant of SendMessageDraft.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#sendmessagedraft
|
||||||
|
func (api *API) SendMessageDraftWithContext(ctx context.Context, params SendMessageDraft) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("sendMessageDraft", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendChatAction holds parameters for the sendChatAction method.
|
||||||
|
// See https://core.telegram.org/bots/api#sendchataction
|
||||||
|
type SendChatAction struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
Action ChatActionType `json:"action"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendChatAction sends a chat action (typing, uploading photo, etc.).
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#sendchataction
|
||||||
|
func (api *API) SendChatAction(params SendChatAction) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("sendChatAction", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendChatActionWithContext is the context-aware variant of SendChatAction.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#sendchataction
|
||||||
|
func (api *API) SendChatActionWithContext(ctx context.Context, params SendChatAction) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("sendChatAction", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetMessageReaction holds parameters for the setMessageReaction method.
|
||||||
|
// See https://core.telegram.org/bots/api#setmessagereaction
|
||||||
|
type SetMessageReaction struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageID int `json:"message_id"`
|
||||||
|
Reaction []ReactionType `json:"reaction"`
|
||||||
|
IsBig bool `json:"is_big,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetMessageReaction changes the chosen reaction on a message.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setmessagereaction
|
||||||
|
func (api *API) SetMessageReaction(params SetMessageReaction) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("setMessageReaction", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetMessageReactionWithContext is the context-aware variant of SetMessageReaction.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setmessagereaction
|
||||||
|
func (api *API) SetMessageReactionWithContext(ctx context.Context, params SetMessageReaction) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("setMessageReaction", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditMessageText holds parameters for the editMessageText method.
|
||||||
|
// See https://core.telegram.org/bots/api#editmessagetext
|
||||||
|
type EditMessageText struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id,omitempty"`
|
||||||
|
MessageID int `json:"message_id,omitempty"`
|
||||||
|
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||||
|
Text string `json:"text"`
|
||||||
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
Entities []MessageEntity `json:"entities,omitempty"`
|
||||||
|
LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"`
|
||||||
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditMessageText edits text messages.
|
||||||
|
// If inline_message_id is provided, returns a boolean success flag;
|
||||||
|
// otherwise returns the edited Message.
|
||||||
|
// See https://core.telegram.org/bots/api#editmessagetext
|
||||||
|
func (api *API) EditMessageText(params EditMessageText) (Message, bool, error) {
|
||||||
|
var zero Message
|
||||||
|
if params.InlineMessageID != "" {
|
||||||
|
req := NewRequestWithChatID[bool]("editMessageText", params, params.ChatID)
|
||||||
|
res, err := req.Do(api)
|
||||||
|
return zero, res, err
|
||||||
|
}
|
||||||
|
req := NewRequestWithChatID[Message]("editMessageText", params, params.ChatID)
|
||||||
|
res, err := req.Do(api)
|
||||||
|
return res, false, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditMessageTextWithContext is the context-aware variant of EditMessageText.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#editmessagetext
|
||||||
|
func (api *API) EditMessageTextWithContext(ctx context.Context, params EditMessageText) (Message, bool, error) {
|
||||||
|
var zero Message
|
||||||
|
if params.InlineMessageID != "" {
|
||||||
|
req := NewRequestWithChatID[bool]("editMessageText", params, params.ChatID)
|
||||||
|
res, err := req.DoWithContext(ctx, api)
|
||||||
|
return zero, res, err
|
||||||
|
}
|
||||||
|
req := NewRequestWithChatID[Message]("editMessageText", params, params.ChatID)
|
||||||
|
res, err := req.DoWithContext(ctx, api)
|
||||||
|
return res, false, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditMessageCaption holds parameters for the editMessageCaption method.
|
||||||
|
// See https://core.telegram.org/bots/api#editmessagecaption
|
||||||
|
type EditMessageCaption struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id,omitempty"`
|
||||||
|
MessageID int `json:"message_id,omitempty"`
|
||||||
|
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||||
|
Caption string `json:"caption"`
|
||||||
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||||
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditMessageCaption edits captions of messages.
|
||||||
|
// If inline_message_id is provided, returns a boolean success flag;
|
||||||
|
// otherwise returns the edited Message.
|
||||||
|
// See https://core.telegram.org/bots/api#editmessagecaption
|
||||||
|
func (api *API) EditMessageCaption(params EditMessageCaption) (Message, bool, error) {
|
||||||
|
var zero Message
|
||||||
|
if params.InlineMessageID != "" {
|
||||||
|
req := NewRequestWithChatID[bool]("editMessageCaption", params, params.ChatID)
|
||||||
|
res, err := req.Do(api)
|
||||||
|
return zero, res, err
|
||||||
|
}
|
||||||
|
req := NewRequestWithChatID[Message]("editMessageCaption", params, params.ChatID)
|
||||||
|
res, err := req.Do(api)
|
||||||
|
return res, false, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditMessageCaptionWithContext is the context-aware variant of EditMessageCaption.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#editmessagecaption
|
||||||
|
func (api *API) EditMessageCaptionWithContext(ctx context.Context, params EditMessageCaption) (Message, bool, error) {
|
||||||
|
var zero Message
|
||||||
|
if params.InlineMessageID != "" {
|
||||||
|
req := NewRequestWithChatID[bool]("editMessageCaption", params, params.ChatID)
|
||||||
|
res, err := req.DoWithContext(ctx, api)
|
||||||
|
return zero, res, err
|
||||||
|
}
|
||||||
|
req := NewRequestWithChatID[Message]("editMessageCaption", params, params.ChatID)
|
||||||
|
res, err := req.DoWithContext(ctx, api)
|
||||||
|
return res, false, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditMessageMedia holds parameters for the editMessageMedia method.
|
||||||
|
// See https://core.telegram.org/bots/api#editmessagemedia
|
||||||
|
type EditMessageMedia struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id,omitempty"`
|
||||||
|
MessageID int `json:"message_id,omitempty"`
|
||||||
|
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||||
|
Media InputMedia `json:"media"`
|
||||||
|
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditMessageMedia edits media messages.
|
||||||
|
// If inline_message_id is provided, returns a boolean success flag;
|
||||||
|
// otherwise returns the edited Message.
|
||||||
|
// See https://core.telegram.org/bots/api#editmessagemedia
|
||||||
|
func (api *API) EditMessageMedia(params EditMessageMedia) (Message, bool, error) {
|
||||||
|
var zero Message
|
||||||
|
if params.InlineMessageID != "" {
|
||||||
|
req := NewRequestWithChatID[bool]("editMessageMedia", params, params.ChatID)
|
||||||
|
res, err := req.Do(api)
|
||||||
|
return zero, res, err
|
||||||
|
}
|
||||||
|
req := NewRequestWithChatID[Message]("editMessageMedia", params, params.ChatID)
|
||||||
|
res, err := req.Do(api)
|
||||||
|
return res, false, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditMessageMediaWithContext is the context-aware variant of EditMessageMedia.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#editmessagemedia
|
||||||
|
func (api *API) EditMessageMediaWithContext(ctx context.Context, params EditMessageMedia) (Message, bool, error) {
|
||||||
|
var zero Message
|
||||||
|
if params.InlineMessageID != "" {
|
||||||
|
req := NewRequestWithChatID[bool]("editMessageMedia", params, params.ChatID)
|
||||||
|
res, err := req.DoWithContext(ctx, api)
|
||||||
|
return zero, res, err
|
||||||
|
}
|
||||||
|
req := NewRequestWithChatID[Message]("editMessageMedia", params, params.ChatID)
|
||||||
|
res, err := req.DoWithContext(ctx, api)
|
||||||
|
return res, false, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditMessageLiveLocation holds parameters for the editMessageLiveLocation method.
|
||||||
|
// See https://core.telegram.org/bots/api#editmessagelivelocation
|
||||||
|
type EditMessageLiveLocation struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id,omitempty"`
|
||||||
|
MessageID int `json:"message_id,omitempty"`
|
||||||
|
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||||
|
|
||||||
|
Latitude float64 `json:"latitude"`
|
||||||
|
Longitude float64 `json:"longitude"`
|
||||||
|
LivePeriod int `json:"live_period,omitempty"`
|
||||||
|
HorizontalAccuracy float64 `json:"horizontal_accuracy,omitempty"`
|
||||||
|
Heading int `json:"heading,omitempty"`
|
||||||
|
ProximityAlertRadius int `json:"proximity_alert_radius,omitempty"`
|
||||||
|
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditMessageLiveLocation edits live location messages.
|
||||||
|
// If inline_message_id is provided, returns a boolean success flag;
|
||||||
|
// otherwise returns the edited Message.
|
||||||
|
// See https://core.telegram.org/bots/api#editmessagelivelocation
|
||||||
|
func (api *API) EditMessageLiveLocation(params EditMessageLiveLocation) (Message, bool, error) {
|
||||||
|
var zero Message
|
||||||
|
if params.InlineMessageID != "" {
|
||||||
|
req := NewRequestWithChatID[bool]("editMessageLiveLocation", params, params.ChatID)
|
||||||
|
res, err := req.Do(api)
|
||||||
|
return zero, res, err
|
||||||
|
}
|
||||||
|
req := NewRequestWithChatID[Message]("editMessageLiveLocation", params, params.ChatID)
|
||||||
|
res, err := req.Do(api)
|
||||||
|
return res, false, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditMessageLiveLocationWithContext is the context-aware variant of EditMessageLiveLocation.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#editmessagelivelocation
|
||||||
|
func (api *API) EditMessageLiveLocationWithContext(ctx context.Context, params EditMessageLiveLocation) (Message, bool, error) {
|
||||||
|
var zero Message
|
||||||
|
if params.InlineMessageID != "" {
|
||||||
|
req := NewRequestWithChatID[bool]("editMessageLiveLocation", params, params.ChatID)
|
||||||
|
res, err := req.DoWithContext(ctx, api)
|
||||||
|
return zero, res, err
|
||||||
|
}
|
||||||
|
req := NewRequestWithChatID[Message]("editMessageLiveLocation", params, params.ChatID)
|
||||||
|
res, err := req.DoWithContext(ctx, api)
|
||||||
|
return res, false, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// StopMessageLiveLocation holds parameters for the stopMessageLiveLocation method.
|
||||||
|
// See https://core.telegram.org/bots/api#stopmessagelivelocation
|
||||||
|
type StopMessageLiveLocation struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id,omitempty"`
|
||||||
|
MessageID int `json:"message_id,omitempty"`
|
||||||
|
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||||
|
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// StopMessageLiveLocation stops a live location message.
|
||||||
|
// If inline_message_id is provided, returns a boolean success flag;
|
||||||
|
// otherwise returns the edited Message.
|
||||||
|
// See https://core.telegram.org/bots/api#stopmessagelivelocation
|
||||||
|
func (api *API) StopMessageLiveLocation(params StopMessageLiveLocation) (Message, bool, error) {
|
||||||
|
var zero Message
|
||||||
|
if params.InlineMessageID != "" {
|
||||||
|
req := NewRequestWithChatID[bool]("stopMessageLiveLocation", params, params.ChatID)
|
||||||
|
res, err := req.Do(api)
|
||||||
|
return zero, res, err
|
||||||
|
}
|
||||||
|
req := NewRequestWithChatID[Message]("stopMessageLiveLocation", params, params.ChatID)
|
||||||
|
res, err := req.Do(api)
|
||||||
|
return res, false, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// StopMessageLiveLocationWithContext is the context-aware variant of StopMessageLiveLocation.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#stopmessagelivelocation
|
||||||
|
func (api *API) StopMessageLiveLocationWithContext(ctx context.Context, params StopMessageLiveLocation) (Message, bool, error) {
|
||||||
|
var zero Message
|
||||||
|
if params.InlineMessageID != "" {
|
||||||
|
req := NewRequestWithChatID[bool]("stopMessageLiveLocation", params, params.ChatID)
|
||||||
|
res, err := req.DoWithContext(ctx, api)
|
||||||
|
return zero, res, err
|
||||||
|
}
|
||||||
|
req := NewRequestWithChatID[Message]("stopMessageLiveLocation", params, params.ChatID)
|
||||||
|
res, err := req.DoWithContext(ctx, api)
|
||||||
|
return res, false, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditMessageChecklist holds parameters for the editMessageChecklist method.
|
||||||
|
type EditMessageChecklist struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageID int `json:"message_id"`
|
||||||
|
Checklist InputChecklist `json:"checklist"`
|
||||||
|
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditMessageChecklist edits a checklist message.
|
||||||
|
// See https://core.telegram.org/bots/api#editmessagechecklist
|
||||||
|
func (api *API) EditMessageChecklist(params EditMessageChecklist) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("editMessageChecklist", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditMessageChecklistWithContext is the context-aware variant of EditMessageChecklist.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#editmessagechecklist
|
||||||
|
func (api *API) EditMessageChecklistWithContext(ctx context.Context, params EditMessageChecklist) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("editMessageChecklist", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditMessageReplyMarkup holds parameters for the editMessageReplyMarkup method.
|
||||||
|
// See https://core.telegram.org/bots/api#editmessagereplymarkup
|
||||||
|
type EditMessageReplyMarkup struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id,omitempty"`
|
||||||
|
MessageID int `json:"message_id,omitempty"`
|
||||||
|
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||||
|
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditMessageReplyMarkup edits only the reply markup of messages.
|
||||||
|
// If inline_message_id is provided, returns a boolean success flag;
|
||||||
|
// otherwise returns the edited Message.
|
||||||
|
// See https://core.telegram.org/bots/api#editmessagereplymarkup
|
||||||
|
func (api *API) EditMessageReplyMarkup(params EditMessageReplyMarkup) (Message, bool, error) {
|
||||||
|
var zero Message
|
||||||
|
if params.InlineMessageID != "" {
|
||||||
|
req := NewRequestWithChatID[bool]("editMessageReplyMarkup", params, params.ChatID)
|
||||||
|
res, err := req.Do(api)
|
||||||
|
return zero, res, err
|
||||||
|
}
|
||||||
|
req := NewRequestWithChatID[Message]("editMessageReplyMarkup", params, params.ChatID)
|
||||||
|
res, err := req.Do(api)
|
||||||
|
return res, false, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditMessageReplyMarkupWithContext is the context-aware variant of EditMessageReplyMarkup.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#editmessagereplymarkup
|
||||||
|
func (api *API) EditMessageReplyMarkupWithContext(ctx context.Context, params EditMessageReplyMarkup) (Message, bool, error) {
|
||||||
|
var zero Message
|
||||||
|
if params.InlineMessageID != "" {
|
||||||
|
req := NewRequestWithChatID[bool]("editMessageReplyMarkup", params, params.ChatID)
|
||||||
|
res, err := req.DoWithContext(ctx, api)
|
||||||
|
return zero, res, err
|
||||||
|
}
|
||||||
|
req := NewRequestWithChatID[Message]("editMessageReplyMarkup", params, params.ChatID)
|
||||||
|
res, err := req.DoWithContext(ctx, api)
|
||||||
|
return res, false, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// StopPoll holds parameters for the stopPoll method.
|
||||||
|
// See https://core.telegram.org/bots/api#stoppoll
|
||||||
|
type StopPoll struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageID int `json:"message_id"`
|
||||||
|
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// StopPoll stops a poll that was sent by the bot.
|
||||||
|
// Returns the stopped Poll.
|
||||||
|
// See https://core.telegram.org/bots/api#stoppoll
|
||||||
|
func (api *API) StopPoll(params StopPoll) (Poll, error) {
|
||||||
|
req := NewRequestWithChatID[Poll]("stopPoll", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// StopPollWithContext is the context-aware variant of StopPoll.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#stoppoll
|
||||||
|
func (api *API) StopPollWithContext(ctx context.Context, params StopPoll) (Poll, error) {
|
||||||
|
req := NewRequestWithChatID[Poll]("stopPoll", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ApproveSuggestedPost holds parameters for the approveSuggestedPost method.
|
||||||
|
// See https://core.telegram.org/bots/api#approvesuggestedpost
|
||||||
|
type ApproveSuggestedPost struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageID int `json:"message_id"`
|
||||||
|
SendDate int `json:"send_date,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ApproveSuggestedPost approves a suggested channel post.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#approvesuggestedpost
|
||||||
|
func (api *API) ApproveSuggestedPost(params ApproveSuggestedPost) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("approveSuggestedPost", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ApproveSuggestedPostWithContext is the context-aware variant of ApproveSuggestedPost.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#approvesuggestedpost
|
||||||
|
func (api *API) ApproveSuggestedPostWithContext(ctx context.Context, params ApproveSuggestedPost) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("approveSuggestedPost", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeclineSuggestedPost holds parameters for the declineSuggestedPost method.
|
||||||
|
// See https://core.telegram.org/bots/api#declinesuggestedpost
|
||||||
|
type DeclineSuggestedPost struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageID int `json:"message_id"`
|
||||||
|
Comment string `json:"comment,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeclineSuggestedPost declines a suggested channel post.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#declinesuggestedpost
|
||||||
|
func (api *API) DeclineSuggestedPost(params DeclineSuggestedPost) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("declineSuggestedPost", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeclineSuggestedPostWithContext is the context-aware variant of DeclineSuggestedPost.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#declinesuggestedpost
|
||||||
|
func (api *API) DeclineSuggestedPostWithContext(ctx context.Context, params DeclineSuggestedPost) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("declineSuggestedPost", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteMessage holds parameters for the deleteMessage method.
|
||||||
|
// See https://core.telegram.org/bots/api#deletemessage
|
||||||
|
type DeleteMessage struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageID int `json:"message_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteMessage deletes a message.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#deletemessage
|
||||||
|
func (api *API) DeleteMessage(params DeleteMessage) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("deleteMessage", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteMessageWithContext is the context-aware variant of DeleteMessage.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#deletemessage
|
||||||
|
func (api *API) DeleteMessageWithContext(ctx context.Context, params DeleteMessage) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("deleteMessage", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteMessages holds parameters for the deleteMessages method.
|
||||||
|
// See https://core.telegram.org/bots/api#deletemessages
|
||||||
|
type DeleteMessages struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageIDs []int `json:"message_ids"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteMessages deletes multiple messages at once.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#deletemessages
|
||||||
|
func (api *API) DeleteMessages(params DeleteMessages) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("deleteMessages", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteMessagesWithContext is the context-aware variant of DeleteMessages.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#deletemessages
|
||||||
|
func (api *API) DeleteMessagesWithContext(ctx context.Context, params DeleteMessages) (bool, error) {
|
||||||
|
req := NewRequestWithChatID[bool]("deleteMessages", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnswerCallbackQuery holds parameters for the answerCallbackQuery method.
|
||||||
|
// See https://core.telegram.org/bots/api#answercallbackquery
|
||||||
|
type AnswerCallbackQuery struct {
|
||||||
|
CallbackQueryID string `json:"callback_query_id"`
|
||||||
|
Text string `json:"text,omitempty"`
|
||||||
|
ShowAlert bool `json:"show_alert,omitempty"`
|
||||||
|
URL string `json:"url,omitempty"`
|
||||||
|
CacheTime int `json:"cache_time,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnswerCallbackQuery sends answers to callback queries sent from inline keyboards.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#answercallbackquery
|
||||||
|
func (api *API) AnswerCallbackQuery(params AnswerCallbackQuery) (bool, error) {
|
||||||
|
req := NewRequest[bool]("answerCallbackQuery", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnswerCallbackQueryWithContext is the context-aware variant of AnswerCallbackQuery.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#answercallbackquery
|
||||||
|
func (api *API) AnswerCallbackQueryWithContext(ctx context.Context, params AnswerCallbackQuery) (bool, error) {
|
||||||
|
req := NewRequest[bool]("answerCallbackQuery", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
@@ -0,0 +1,666 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/extypes"
|
||||||
|
)
|
||||||
|
|
||||||
|
// MessageID represents a message identifier wrapper returned by some API methods.
|
||||||
|
type MessageID struct {
|
||||||
|
MessageID int `json:"message_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// DirectMessageTopic represents a forum topic in a direct message.
|
||||||
|
type DirectMessageTopic struct {
|
||||||
|
TopicID int64 `json:"topic_id"`
|
||||||
|
User *User `json:"user,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type MessageOriginType string
|
||||||
|
|
||||||
|
const (
|
||||||
|
MessageOriginUserType = "user"
|
||||||
|
MessageOriginHiddenUserType = "hidden_user"
|
||||||
|
MessageOriginChatType = "chat"
|
||||||
|
MessageOriginChannel = "channel"
|
||||||
|
)
|
||||||
|
|
||||||
|
type MessageOrigin struct {
|
||||||
|
Type MessageOriginType `json:"type"`
|
||||||
|
Date int64 `json:"date"`
|
||||||
|
|
||||||
|
SenderUser *User `json:"sender_user,omitempty"`
|
||||||
|
|
||||||
|
SenderUserName string `json:"sender_user_name,omitempty"`
|
||||||
|
|
||||||
|
SenderChat *Chat `json:"sender_chat,omitempty"`
|
||||||
|
|
||||||
|
Chat *Chat `json:"chat,omitempty"`
|
||||||
|
MessageID int `json:"message_id"`
|
||||||
|
|
||||||
|
AuthorSignature string `json:"author_signature,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type ExternalReplyInfo struct {
|
||||||
|
Origin MessageOrigin `json:"origin"`
|
||||||
|
Chat *Chat `json:"chat,omitempty"`
|
||||||
|
MessageID int `json:"message_id,omitempty"`
|
||||||
|
LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"`
|
||||||
|
Animation *Animation `json:"animation,omitempty"`
|
||||||
|
Audio *Audio `json:"audio,omitempty"`
|
||||||
|
Document *Document `json:"document,omitempty"`
|
||||||
|
PaidMedia *PaidMediaInfo `json:"paid_media,omitempty"`
|
||||||
|
Photo []PhotoSize `json:"photo,omitempty"`
|
||||||
|
Sticker *Sticker `json:"sticker,omitempty"`
|
||||||
|
Story *Story `json:"story,omitempty"`
|
||||||
|
Video *Video `json:"video,omitempty"`
|
||||||
|
VideoNote *VideoNote `json:"video_note,omitempty"`
|
||||||
|
Voice *Voice `json:"voice,omitempty"`
|
||||||
|
HasMediaSpoiler bool `json:"has_media_spoiler,omitempty"`
|
||||||
|
Checklist *Checklist `json:"checklist,omitempty"`
|
||||||
|
Contact *Contact `json:"contact,omitempty"`
|
||||||
|
Dice *Dice `json:"dice,omitempty"`
|
||||||
|
Game *Game `json:"game,omitempty"`
|
||||||
|
Giveaway *Giveaway `json:"giveaway,omitempty"`
|
||||||
|
GiveawayWinners *GiveawayWinners `json:"giveaway_winners,omitempty"`
|
||||||
|
Invoice *Invoice `json:"invoice,omitempty"`
|
||||||
|
Location *Location `json:"location,omitempty"`
|
||||||
|
Poll *Poll `json:"poll,omitempty"`
|
||||||
|
Venue *Venue `json:"venue,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type TextQuote struct {
|
||||||
|
Text string `json:"text"`
|
||||||
|
Entities []MessageEntity `json:"entities"`
|
||||||
|
Position int `json:"position"`
|
||||||
|
IsManual bool `json:"is_manual,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type MessageAutoDeleteTimerChanged struct {
|
||||||
|
MessageAutoDeleteTime int `json:"message_auto_delete_time"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type DirectMessagePriceChanged struct {
|
||||||
|
AreDirectMessagesEnabled bool `json:"are_direct_messages_enabled"`
|
||||||
|
DirectMessageStarCount int `json:"direct_message_star_count,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type PaidMessagePriceChanged struct {
|
||||||
|
PaidMessageStarCount int `json:"paid_message_star_count"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Message represents a Telegram message.
|
||||||
|
// See https://core.telegram.org/bots/api#message
|
||||||
|
type Message struct {
|
||||||
|
MessageID int `json:"message_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessageTopic *DirectMessageTopic `json:"direct_message_topic,omitempty"`
|
||||||
|
From *User `json:"from,omitempty"`
|
||||||
|
|
||||||
|
SenderChat *Chat `json:"sender_chat,omitempty"`
|
||||||
|
SenderBoostCount int `json:"sender_boost_count,omitempty"`
|
||||||
|
SenderBusinessBot *User `json:"sender_business_bot,omitempty"`
|
||||||
|
SenderTag string `json:"sender_tag,omitempty"`
|
||||||
|
Date int `json:"date"`
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
Chat *Chat `json:"chat,omitempty"`
|
||||||
|
ForwardOrigin *MessageOrigin `json:"forward_origin,omitempty"`
|
||||||
|
|
||||||
|
IsTopicMessage bool `json:"is_topic_message,omitempty"`
|
||||||
|
IsAutomaticForward bool `json:"is_automatic_forward,omitempty"`
|
||||||
|
ReplyToMessage *Message `json:"reply_to_message,omitempty"`
|
||||||
|
ExternalReply *ExternalReplyInfo `json:"external_reply,omitempty"`
|
||||||
|
Quote *TextQuote `json:"quote,omitempty"`
|
||||||
|
|
||||||
|
ReplyToStory *Story `json:"reply_to_story,omitempty"`
|
||||||
|
ReplyToChecklistTaskID int `json:"reply_to_checklist_task_id,omitempty"`
|
||||||
|
ReplyToPollOptionID string `json:"reply_to_poll_option_id,omitempty"`
|
||||||
|
ViaBot *User `json:"via_bot,omitempty"`
|
||||||
|
EditDate int `json:"edit_date,omitempty"`
|
||||||
|
HasProtectedContent bool `json:"has_protected_content,omitempty"`
|
||||||
|
IsFromOffline bool `json:"is_from_offline,omitempty"`
|
||||||
|
IsPaidPost bool `json:"is_paid_post,omitempty"`
|
||||||
|
MediaGroupID string `json:"media_group_id,omitempty"`
|
||||||
|
AuthorSignature string `json:"author_signature,omitempty"`
|
||||||
|
PaidStarCount int `json:"paid_star_count,omitempty"`
|
||||||
|
|
||||||
|
Text string `json:"text"`
|
||||||
|
Entities []MessageEntity `json:"entities,omitempty"`
|
||||||
|
LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"`
|
||||||
|
SuggestedPostInfo *SuggestedPostInfo `json:"suggested_post_info,omitempty"`
|
||||||
|
EffectID string `json:"effect_id,omitempty"`
|
||||||
|
|
||||||
|
Animation *Animation `json:"animation,omitempty"`
|
||||||
|
Audio *Audio `json:"audio,omitempty"`
|
||||||
|
Document *Document `json:"document,omitempty"`
|
||||||
|
PaidMedia *PaidMediaInfo `json:"paid_media,omitempty"`
|
||||||
|
Photo extypes.Slice[PhotoSize] `json:"photo,omitempty"`
|
||||||
|
Sticker *Sticker `json:"sticker,omitempty"`
|
||||||
|
Story *Story `json:"story,omitempty"`
|
||||||
|
Video *Video `json:"video,omitempty"`
|
||||||
|
VideoNote *VideoNote `json:"video_note,omitempty"`
|
||||||
|
Voice *Voice `json:"voice,omitempty"`
|
||||||
|
Caption string `json:"caption,omitempty"`
|
||||||
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||||
|
HasMediaSpoiler bool `json:"has_media_spoiler,omitempty"`
|
||||||
|
Checklist *Checklist `json:"checklist,omitempty"`
|
||||||
|
Contact *Contact `json:"contact,omitempty"`
|
||||||
|
Dice *Dice `json:"dice,omitempty"`
|
||||||
|
Game *Game `json:"game,omitempty"`
|
||||||
|
Poll *Poll `json:"poll,omitempty"`
|
||||||
|
Venue *Venue `json:"venue,omitempty"`
|
||||||
|
Location *Location `json:"location,omitempty"`
|
||||||
|
|
||||||
|
NewChatMembers []User `json:"new_chat_members,omitempty"`
|
||||||
|
LeftChatMember *User `json:"left_chat_member,omitempty"`
|
||||||
|
ChatOwnerLeft *ChatOwnerLeft `json:"chat_owner_left,omitempty"`
|
||||||
|
ChatOwnerChanged *ChatOwnerChanged `json:"chat_owner_changed,omitempty"`
|
||||||
|
NewChatTitle string `json:"new_chat_title,omitempty"`
|
||||||
|
NewChatPhoto []PhotoSize `json:"new_chat_photo,omitempty"`
|
||||||
|
DeleteChatPhoto bool `json:"delete_chat_photo,omitempty"`
|
||||||
|
GroupChatCreated bool `json:"group_chat_created,omitempty"`
|
||||||
|
SupergroupChatCreated bool `json:"supergroup_chat_created,omitempty"`
|
||||||
|
ChannelChatCreated bool `json:"channel_chat_created,omitempty"`
|
||||||
|
MessageAutoDeleteTimerChanged *MessageAutoDeleteTimerChanged `json:"message_auto_delete_timer_changed,omitempty"`
|
||||||
|
MigrateToChatID int64 `json:"migrate_to_chat_id,omitempty"`
|
||||||
|
MigrateFromChatID int64 `json:"migrate_from_chat_id,omitempty"`
|
||||||
|
PinnedMessage *MaybeInaccessibleMessage `json:"pinned_message,omitempty"`
|
||||||
|
|
||||||
|
Invoice *Invoice `json:"invoice,omitempty"`
|
||||||
|
SuccessfulPayment *SuccessfulPayment `json:"successful_payment,omitempty"`
|
||||||
|
RefundedPayment *RefundedPayment `json:"refunded_payment,omitempty"`
|
||||||
|
UsersShared *UsersShared `json:"users_shared,omitempty"`
|
||||||
|
ChatShared *ChatShared `json:"chat_shared,omitempty"`
|
||||||
|
Gift *GiftInfo `json:"gift,omitempty"`
|
||||||
|
UniqueGift *UniqueGiftInfo `json:"unique_gift,omitempty"`
|
||||||
|
GiftUpgradeSent *GiftInfo `json:"gift_upgrade_sent,omitempty"`
|
||||||
|
|
||||||
|
ConnectedWebsite string `json:"connected_website,omitempty"`
|
||||||
|
WriteAccessAllowed *WriteAccessAllowed `json:"write_access_allowed,omitempty"`
|
||||||
|
PassportData *PassportData `json:"passport_data,omitempty"`
|
||||||
|
ProximityAlertTriggered *ProximityAlertTriggered `json:"proximity_alert_triggered,omitempty"`
|
||||||
|
BoostAdded *ChatBoostAdded `json:"boost_added,omitempty"`
|
||||||
|
ChatBackgroundSet *ChatBackground `json:"chat_background_set,omitempty"`
|
||||||
|
|
||||||
|
ChecklistTaskDone *ChecklistTaskDone `json:"checklist_task_done,omitempty"`
|
||||||
|
ChecklistTasksAdded *ChecklistTasksAdded `json:"checklist_tasks_added,omitempty"`
|
||||||
|
DirectMessagePriceChanged *DirectMessagePriceChanged `json:"direct_message_price_changed,omitempty"`
|
||||||
|
ForumTopicCreated *ForumTopicCreated `json:"forum_topic_created,omitempty"`
|
||||||
|
ForumTopicEdited *ForumTopicEdited `json:"forum_topic_edited,omitempty"`
|
||||||
|
ForumTopicClosed *ForumTopicClosed `json:"forum_topic_closed,omitempty"`
|
||||||
|
ForumTopicReopened *ForumTopicReopened `json:"forum_topic_reopened,omitempty"`
|
||||||
|
GeneralForumTopicHidden *GeneralForumTopicHidden `json:"general_forum_topic_hidden,omitempty"`
|
||||||
|
GeneralForumTopicUnhidden *GeneralForumTopicUnhidden `json:"general_forum_topic_unhidden,omitempty"`
|
||||||
|
|
||||||
|
GiveawayCreated *GiveawayCreated `json:"giveaway_created,omitempty"`
|
||||||
|
Giveaway *Giveaway `json:"giveaway,omitempty"`
|
||||||
|
GiveawayWinners *GiveawayWinners `json:"giveaway_winners,omitempty"`
|
||||||
|
GiveawayCompleted *GiveawayCompleted `json:"giveaway_completed,omitempty"`
|
||||||
|
|
||||||
|
ManagedBotCreated *ManagedBotCreated `json:"managed_bot_created,omitempty"`
|
||||||
|
PaidMessagePriceChanged *PaidMessagePriceChanged `json:"paid_message_price_changed,omitempty"`
|
||||||
|
PollOptionAdded *PollOptionAdded `json:"poll_option_added,omitempty"`
|
||||||
|
PollOptionDeleted *PollOptionDeleted `json:"poll_option_deleted,omitempty"`
|
||||||
|
|
||||||
|
SuggestedPostApproved *SuggestedPostApproved `json:"suggested_post_approved,omitempty"`
|
||||||
|
SuggestedPostApprovalFailed *SuggestedPostApprovalFailed `json:"suggested_post_approval_failed,omitempty"`
|
||||||
|
SuggestedPostDeclined *SuggestedPostDeclined `json:"suggested_post_declined,omitempty"`
|
||||||
|
SuggestedPostPaid *SuggestedPostPaid `json:"suggested_post_paid,omitempty"`
|
||||||
|
SuggestedPostRefunded *SuggestedPostRefunded `json:"suggested_post_refunded,omitempty"`
|
||||||
|
|
||||||
|
VideoChatScheduled *VideoChatScheduled `json:"video_chat_scheduled,omitempty"`
|
||||||
|
VideoChatStarted *VideoChatStarted `json:"video_chat_started,omitempty"`
|
||||||
|
VideoChatEnded *VideoChatEnded `json:"video_chat_ended,omitempty"`
|
||||||
|
VideoChatParticipantsInvited *VideoChatParticipantsInvited `json:"video_chat_participants_invited,omitempty"`
|
||||||
|
|
||||||
|
WebAppData *WebAppData `json:"web_app_data,omitempty"`
|
||||||
|
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// InaccessibleMessage describes a message that was deleted or is otherwise inaccessible.
|
||||||
|
// See https://core.telegram.org/bots/api#inaccessiblemessage
|
||||||
|
type InaccessibleMessage struct {
|
||||||
|
Chat Chat `json:"chat"`
|
||||||
|
MessageID int `json:"message_id"`
|
||||||
|
Date int `json:"date"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// MaybeInaccessibleMessage is a union type that can be either Message or InaccessibleMessage.
|
||||||
|
// See https://core.telegram.org/bots/api#maybeinaccessiblemessage
|
||||||
|
type MaybeInaccessibleMessage struct {
|
||||||
|
msg *Message
|
||||||
|
ina *InaccessibleMessage
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnmarshalJSON decodes either an accessible Message or an InaccessibleMessage.
|
||||||
|
func (m *MaybeInaccessibleMessage) UnmarshalJSON(data []byte) error {
|
||||||
|
tmp := struct {
|
||||||
|
Date int `json:"date"`
|
||||||
|
}{}
|
||||||
|
if err := json.Unmarshal(data, &tmp); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
var err error
|
||||||
|
if tmp.Date > 0 {
|
||||||
|
err = json.Unmarshal(data, &m.msg)
|
||||||
|
} else {
|
||||||
|
err = json.Unmarshal(data, &m.ina)
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarshalJSON encodes the populated accessible or inaccessible message payload.
|
||||||
|
func (m *MaybeInaccessibleMessage) MarshalJSON() ([]byte, error) {
|
||||||
|
if m.msg != nil {
|
||||||
|
return json.Marshal(m.msg)
|
||||||
|
} else if m.ina != nil {
|
||||||
|
return json.Marshal(m.ina)
|
||||||
|
}
|
||||||
|
return json.Marshal(nil)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Message returns the accessible message payload when present.
|
||||||
|
func (m *MaybeInaccessibleMessage) Message() *Message {
|
||||||
|
return m.msg
|
||||||
|
}
|
||||||
|
|
||||||
|
// InaccessibleMessage returns the inaccessible message payload when present.
|
||||||
|
func (m *MaybeInaccessibleMessage) InaccessibleMessage() *InaccessibleMessage {
|
||||||
|
return m.ina
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsAccessible reports whether the payload is an accessible message.
|
||||||
|
func (m *MaybeInaccessibleMessage) IsAccessible() bool {
|
||||||
|
return m.msg != nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsInaccessible reports whether the payload is an inaccessible message.
|
||||||
|
func (m *MaybeInaccessibleMessage) IsInaccessible() bool {
|
||||||
|
return m.ina != nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// MessageID returns the message identifier from either payload form.
|
||||||
|
func (m *MaybeInaccessibleMessage) MessageID() int {
|
||||||
|
if m.IsAccessible() {
|
||||||
|
return m.msg.MessageID
|
||||||
|
} else if m.IsInaccessible() {
|
||||||
|
return m.ina.MessageID
|
||||||
|
}
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
// Chat returns the chat from either payload form.
|
||||||
|
func (m *MaybeInaccessibleMessage) Chat() *Chat {
|
||||||
|
if m.IsAccessible() {
|
||||||
|
return m.msg.Chat
|
||||||
|
} else if m.IsInaccessible() {
|
||||||
|
return &m.ina.Chat
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// MessageEntityType represents the type of a message entity.
|
||||||
|
type MessageEntityType string
|
||||||
|
|
||||||
|
const (
|
||||||
|
// MessageEntityMention identifies an @mention entity.
|
||||||
|
MessageEntityMention MessageEntityType = "mention"
|
||||||
|
// MessageEntityHashtag identifies a hashtag entity.
|
||||||
|
MessageEntityHashtag MessageEntityType = "hashtag"
|
||||||
|
// MessageEntityCashtag identifies a cashtag entity.
|
||||||
|
MessageEntityCashtag MessageEntityType = "cashtag"
|
||||||
|
// MessageEntityBotCommand identifies a bot command entity.
|
||||||
|
MessageEntityBotCommand MessageEntityType = "bot_command"
|
||||||
|
// MessageEntityURL identifies a URL entity.
|
||||||
|
MessageEntityURL MessageEntityType = "url"
|
||||||
|
// MessageEntityEmail identifies an email entity.
|
||||||
|
MessageEntityEmail MessageEntityType = "email"
|
||||||
|
// MessageEntityPhoneNumber identifies a phone number entity.
|
||||||
|
MessageEntityPhoneNumber MessageEntityType = "phone_number"
|
||||||
|
// MessageEntityBold identifies bold text.
|
||||||
|
MessageEntityBold MessageEntityType = "bold"
|
||||||
|
// MessageEntityItalic identifies italic text.
|
||||||
|
MessageEntityItalic MessageEntityType = "italic"
|
||||||
|
// MessageEntityUnderline identifies underlined text.
|
||||||
|
MessageEntityUnderline MessageEntityType = "underline"
|
||||||
|
// MessageEntityStrike identifies strikethrough text.
|
||||||
|
MessageEntityStrike MessageEntityType = "strikethrough"
|
||||||
|
// MessageEntitySpoiler identifies spoiler text.
|
||||||
|
MessageEntitySpoiler MessageEntityType = "spoiler"
|
||||||
|
// MessageEntityBlockquote identifies a blockquote entity.
|
||||||
|
MessageEntityBlockquote MessageEntityType = "blockquote"
|
||||||
|
// MessageEntityExpandableBlockquote identifies an expandable blockquote entity.
|
||||||
|
MessageEntityExpandableBlockquote MessageEntityType = "expandable_blockquote"
|
||||||
|
// MessageEntityCode identifies inline code.
|
||||||
|
MessageEntityCode MessageEntityType = "code"
|
||||||
|
// MessageEntityPre identifies a preformatted block.
|
||||||
|
MessageEntityPre MessageEntityType = "pre"
|
||||||
|
// MessageEntityTextLink identifies linked text.
|
||||||
|
MessageEntityTextLink MessageEntityType = "text_link"
|
||||||
|
// MessageEntityTextMention identifies a text mention.
|
||||||
|
MessageEntityTextMention MessageEntityType = "text_mention"
|
||||||
|
// MessageEntityCustomEmoji identifies a custom emoji entity.
|
||||||
|
MessageEntityCustomEmoji MessageEntityType = "custom_emoji"
|
||||||
|
// MessageEntityDateTime identifies a date-time entity.
|
||||||
|
MessageEntityDateTime MessageEntityType = "date_time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// MessageEntity represents one special entity in a text message.
|
||||||
|
// See https://core.telegram.org/bots/api#messageentity
|
||||||
|
type MessageEntity struct {
|
||||||
|
Type MessageEntityType `json:"type"`
|
||||||
|
|
||||||
|
Offset int `json:"offset"`
|
||||||
|
Length int `json:"length"`
|
||||||
|
URL string `json:"url,omitempty"`
|
||||||
|
User *User `json:"user,omitempty"`
|
||||||
|
Language string `json:"language,omitempty"`
|
||||||
|
CustomEmojiID string `json:"custom_emoji_id,omitempty"`
|
||||||
|
|
||||||
|
UnixTime int `json:"unix_time,omitempty"`
|
||||||
|
DateTimeFormat string `json:"date_time_format,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReplyParameters describes the parameters to use when replying to a message.
|
||||||
|
// See https://core.telegram.org/bots/api#replyparameters
|
||||||
|
type ReplyParameters struct {
|
||||||
|
MessageID int `json:"message_id"`
|
||||||
|
ChatID int64 `json:"chat_id,omitempty"`
|
||||||
|
|
||||||
|
AllowSendingWithoutReply bool `json:"allow_sending_without_reply,omitempty"`
|
||||||
|
Quote string `json:"quote,omitempty"`
|
||||||
|
QuoteParsingMode string `json:"quote_parsing_mode,omitempty"`
|
||||||
|
QuoteEntities []MessageEntity `json:"quote_entities,omitempty"`
|
||||||
|
QuotePosition int `json:"quote_position,omitempty"`
|
||||||
|
ChecklistTaskID int `json:"checklist_task_id,omitempty"`
|
||||||
|
PollOptionID string `json:"poll_option_id,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// LinkPreviewOptions describes the options used for link preview generation.
|
||||||
|
// See https://core.telegram.org/bots/api#linkpreviewoptions
|
||||||
|
type LinkPreviewOptions struct {
|
||||||
|
IsDisabled bool `json:"is_disabled,omitempty"`
|
||||||
|
URL string `json:"url,omitempty"`
|
||||||
|
PreferSmallMedia bool `json:"prefer_small_media,omitempty"`
|
||||||
|
PreferLargeMedia bool `json:"prefer_large_media,omitempty"`
|
||||||
|
ShowAboveText bool `json:"show_above_text,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReplyMarkup represents a custom keyboard or inline keyboard.
|
||||||
|
// See https://core.telegram.org/bots/api#replymarkup
|
||||||
|
type ReplyMarkup struct {
|
||||||
|
InlineKeyboard [][]InlineKeyboardButton `json:"inline_keyboard,omitempty"`
|
||||||
|
|
||||||
|
Keyboard [][]KeyboardButton `json:"keyboard,omitempty"`
|
||||||
|
IsPersistent bool `json:"is_persistent,omitempty"`
|
||||||
|
ResizeKeyboard bool `json:"resize_keyboard,omitempty"`
|
||||||
|
OneTimeKeyboard bool `json:"one_time_keyboard,omitempty"`
|
||||||
|
InputFieldPlaceholder string `json:"input_field_placeholder,omitempty"`
|
||||||
|
Selective bool `json:"selective,omitempty"`
|
||||||
|
|
||||||
|
RemoveKeyboard bool `json:"remove_keyboard,omitempty"`
|
||||||
|
|
||||||
|
ForceReply bool `json:"force_reply,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// InlineKeyboardMarkup represents an inline keyboard that appears right next to the message it belongs to.
|
||||||
|
// See https://core.telegram.org/bots/api#inlinekeyboardmarkup
|
||||||
|
type InlineKeyboardMarkup struct {
|
||||||
|
InlineKeyboard [][]InlineKeyboardButton `json:"inline_keyboard,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// KeyboardButtonStyle represents the style of a keyboard button.
|
||||||
|
type KeyboardButtonStyle string
|
||||||
|
|
||||||
|
const (
|
||||||
|
// KeyboardButtonStyleDanger marks a destructive keyboard button.
|
||||||
|
KeyboardButtonStyleDanger KeyboardButtonStyle = "danger"
|
||||||
|
// KeyboardButtonStyleSuccess marks a confirmatory keyboard button.
|
||||||
|
KeyboardButtonStyleSuccess KeyboardButtonStyle = "success"
|
||||||
|
// KeyboardButtonStylePrimary marks a primary keyboard button.
|
||||||
|
KeyboardButtonStylePrimary KeyboardButtonStyle = "primary"
|
||||||
|
)
|
||||||
|
|
||||||
|
// KeyboardButton represents one button of the reply keyboard.
|
||||||
|
// See https://core.telegram.org/bots/api#keyboardbutton
|
||||||
|
type KeyboardButton struct {
|
||||||
|
Text string `json:"text"`
|
||||||
|
IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
|
||||||
|
Style KeyboardButtonStyle `json:"style,omitempty"`
|
||||||
|
RequestUsers *KeyboardButtonRequestUsers `json:"request_users,omitempty"`
|
||||||
|
RequestChat *KeyboardButtonRequestChat `json:"request_chat,omitempty"`
|
||||||
|
RequestManagedBot *KeyboardButtonRequestManagedBot `json:"request_managed_bot,omitempty"`
|
||||||
|
RequestContact bool `json:"request_contact,omitempty"`
|
||||||
|
RequestLocation bool `json:"request_location,omitempty"`
|
||||||
|
RequestPoll *KeyboardButtonPollType `json:"request_poll,omitempty"`
|
||||||
|
WebApp *WebAppInfo `json:"web_app,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// KeyboardButtonRequestUsers defines criteria used to request suitable users.
|
||||||
|
// See https://core.telegram.org/bots/api#keyboardbuttonrequestusers
|
||||||
|
type KeyboardButtonRequestUsers struct {
|
||||||
|
RequestID int `json:"request_id"`
|
||||||
|
UserIsBot *bool `json:"user_is_bot,omitempty"`
|
||||||
|
UserIsPremium *bool `json:"user_is_premium,omitempty"`
|
||||||
|
MaxQuantity int `json:"max_quantity,omitempty"`
|
||||||
|
RequestName bool `json:"request_name,omitempty"`
|
||||||
|
RequestUsername bool `json:"request_username,omitempty"`
|
||||||
|
RequestPhoto bool `json:"request_photo,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// KeyboardButtonRequestChat defines criteria used to request a suitable chat.
|
||||||
|
// See https://core.telegram.org/bots/api#keyboardbuttonrequestchat
|
||||||
|
type KeyboardButtonRequestChat struct {
|
||||||
|
RequestID int `json:"request_id"`
|
||||||
|
ChatIsChannel bool `json:"chat_is_channel"`
|
||||||
|
ChatIsForum *bool `json:"chat_is_forum,omitempty"`
|
||||||
|
ChatHasUsername *bool `json:"chat_has_username,omitempty"`
|
||||||
|
ChatIsCreated *bool `json:"chat_is_created,omitempty"`
|
||||||
|
UserAdministratorRights *ChatAdministratorRights `json:"user_administrator_rights,omitempty"`
|
||||||
|
BotAdministratorRights *ChatAdministratorRights `json:"bot_administrator_rights,omitempty"`
|
||||||
|
BotIsMember bool `json:"bot_is_member,omitempty"`
|
||||||
|
RequestTitle bool `json:"request_title,omitempty"`
|
||||||
|
RequestUsername bool `json:"request_username,omitempty"`
|
||||||
|
RequestPhoto bool `json:"request_photo,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// KeyboardButtonRequestManagedBot defines criteria used to request a managed bot.
|
||||||
|
// See https://core.telegram.org/bots/api#keyboardbuttonrequestmanagedbot
|
||||||
|
type KeyboardButtonRequestManagedBot struct {
|
||||||
|
RequestID int32 `json:"request_id"`
|
||||||
|
SuggestedName string `json:"suggested_name,omitempty"`
|
||||||
|
SuggestedUsername string `json:"suggested_username,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// KeyboardButtonPollType represents the type of a poll that may be created from a keyboard button.
|
||||||
|
// See https://core.telegram.org/bots/api#keyboardbuttonpolltype
|
||||||
|
type KeyboardButtonPollType struct {
|
||||||
|
Type PollType `json:"type,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// InlineKeyboardButton represents one button of an inline keyboard.
|
||||||
|
// See https://core.telegram.org/bots/api#inlinekeyboardbutton
|
||||||
|
type InlineKeyboardButton struct {
|
||||||
|
Text string `json:"text"`
|
||||||
|
URL string `json:"url,omitempty"`
|
||||||
|
CallbackData string `json:"callback_data,omitempty"`
|
||||||
|
Style KeyboardButtonStyle `json:"style,omitempty"`
|
||||||
|
IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReplyKeyboardMarkup represents a custom keyboard with reply options.
|
||||||
|
// See https://core.telegram.org/bots/api#replykeyboardmarkup
|
||||||
|
type ReplyKeyboardMarkup struct {
|
||||||
|
Keyboard [][]KeyboardButton `json:"keyboard"`
|
||||||
|
IsPersistent bool `json:"is_persistent,omitempty"`
|
||||||
|
ResizeKeyboard bool `json:"resize_keyboard,omitempty"`
|
||||||
|
OneTimeKeyboard bool `json:"one_time_keyboard,omitempty"`
|
||||||
|
InputFieldPlaceholder string `json:"input_field_placeholder,omitempty"`
|
||||||
|
Selective bool `json:"selective,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// CallbackQuery represents an incoming callback query from a callback button in an inline keyboard.
|
||||||
|
// See https://core.telegram.org/bots/api#callbackquery
|
||||||
|
type CallbackQuery struct {
|
||||||
|
ID string `json:"id"`
|
||||||
|
From User `json:"from"`
|
||||||
|
Message *Message `json:"message,omitempty"`
|
||||||
|
InlineMessageID *string `json:"inline_message_id,omitempty"`
|
||||||
|
ChatInstance string `json:"chat_instance,omitempty"`
|
||||||
|
Data string `json:"data,omitempty"`
|
||||||
|
GameShortName string `json:"game_short_name,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ChatActionType represents the type of chat action.
|
||||||
|
type ChatActionType string
|
||||||
|
|
||||||
|
const (
|
||||||
|
// ChatActionTyping tells Telegram the bot is typing.
|
||||||
|
ChatActionTyping ChatActionType = "typing"
|
||||||
|
// ChatActionUploadPhoto tells Telegram the bot is uploading a photo.
|
||||||
|
ChatActionUploadPhoto ChatActionType = "upload_photo"
|
||||||
|
// ChatActionUploadVideo tells Telegram the bot is uploading a video.
|
||||||
|
ChatActionUploadVideo ChatActionType = "upload_video"
|
||||||
|
// ChatActionUploadVoice tells Telegram the bot is uploading a voice message.
|
||||||
|
ChatActionUploadVoice ChatActionType = "upload_voice"
|
||||||
|
// ChatActionUploadDocument tells Telegram the bot is uploading a document.
|
||||||
|
ChatActionUploadDocument ChatActionType = "upload_document"
|
||||||
|
// ChatActionChooseSticker tells Telegram the bot is choosing a sticker.
|
||||||
|
ChatActionChooseSticker ChatActionType = "choose_sticker"
|
||||||
|
// ChatActionFindLocation tells Telegram the bot is finding a location.
|
||||||
|
ChatActionFindLocation ChatActionType = "find_location"
|
||||||
|
// ChatActionUploadVideoNote tells Telegram the bot is uploading a video note.
|
||||||
|
ChatActionUploadVideoNote ChatActionType = "upload_video_note"
|
||||||
|
// ChatActionUploadVideoNone is a deprecated alias for ChatActionUploadVideoNote.
|
||||||
|
ChatActionUploadVideoNone = ChatActionUploadVideoNote
|
||||||
|
)
|
||||||
|
|
||||||
|
// MessageReactionUpdated represents a change of a reaction on a message.
|
||||||
|
// See https://core.telegram.org/bots/api#messagereactionupdated
|
||||||
|
type MessageReactionUpdated struct {
|
||||||
|
Chat *Chat `json:"chat"`
|
||||||
|
MessageID int `json:"message_id"`
|
||||||
|
User *User `json:"user,omitempty"`
|
||||||
|
ActorChat *Chat `json:"actor_chat"`
|
||||||
|
Date int `json:"date"`
|
||||||
|
OldReaction []ReactionType `json:"old_reaction"`
|
||||||
|
NewReaction []ReactionType `json:"new_reaction"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// MessageReactionCountUpdated represents a change in the count of reactions on a message.
|
||||||
|
// See https://core.telegram.org/bots/api#messagereactioncountupdated
|
||||||
|
type MessageReactionCountUpdated struct {
|
||||||
|
Chat *Chat `json:"chat"`
|
||||||
|
MessageID int `json:"message_id"`
|
||||||
|
Date int `json:"date"`
|
||||||
|
Reactions []*ReactionCount `json:"reactions"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReactionType describes the type of a reaction.
|
||||||
|
// See https://core.telegram.org/bots/api#reactiontype
|
||||||
|
type ReactionType struct {
|
||||||
|
Type string `json:"type"`
|
||||||
|
// ReactionTypeEmoji
|
||||||
|
Emoji *string `json:"emoji,omitempty"`
|
||||||
|
// ReactionTypeCustomEmoji
|
||||||
|
CustomEmojiID *string `json:"custom_emoji_id,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReactionCount represents a reaction added to a message along with the number of times it was added.
|
||||||
|
// See https://core.telegram.org/bots/api#reactioncount
|
||||||
|
type ReactionCount struct {
|
||||||
|
Type ReactionType `json:"type"`
|
||||||
|
TotalCount int `json:"total_count"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SuggestedPostPrice represents the price of a suggested post.
|
||||||
|
type SuggestedPostPrice struct {
|
||||||
|
Currency string `json:"currency"`
|
||||||
|
Amount int `json:"amount"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SuggestedPostInfo contains information about a suggested post.
|
||||||
|
// See https://core.telegram.org/bots/api#suggestedpostinfo
|
||||||
|
type SuggestedPostInfo struct {
|
||||||
|
State string `json:"state"` // "pending", "approved", or "declined"
|
||||||
|
Price SuggestedPostPrice `json:"price"`
|
||||||
|
SendDate int `json:"send_date"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SuggestedPostParameters holds parameters for suggesting a post.
|
||||||
|
type SuggestedPostParameters struct {
|
||||||
|
Price SuggestedPostPrice `json:"price"`
|
||||||
|
SendDate int `json:"send_date"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ManagedBotCreated describes a service message about a newly created managed bot.
|
||||||
|
// See https://core.telegram.org/bots/api#managedbotcreated
|
||||||
|
type ManagedBotCreated struct {
|
||||||
|
Bot User `json:"bot"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ManagedBotUpdated describes an update about a managed bot and its manager.
|
||||||
|
// See https://core.telegram.org/bots/api#managedbotupdated
|
||||||
|
type ManagedBotUpdated struct {
|
||||||
|
User User `json:"user"`
|
||||||
|
Bot User `json:"bot"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type SharedUser struct {
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
FirstName string `json:"first_name,omitempty"`
|
||||||
|
LastName string `json:"last_name,omitempty"`
|
||||||
|
Username string `json:"username,omitempty"`
|
||||||
|
Photo []PhotoSize `json:"photo,omitempty"`
|
||||||
|
}
|
||||||
|
type UsersShared struct {
|
||||||
|
RequestID int `json:"request_id"`
|
||||||
|
Users []SharedUser `json:"users"`
|
||||||
|
}
|
||||||
|
type ChatShared struct {
|
||||||
|
RequestID int `json:"request_id"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
Title string `json:"title,omitempty"`
|
||||||
|
Username string `json:"username,omitempty"`
|
||||||
|
Photo []PhotoSize `json:"photo,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type SuggestedPostApproved struct {
|
||||||
|
SuggestedPostMessage *Message `json:"suggested_post_message,omitempty"`
|
||||||
|
Price SuggestedPostPrice `json:"price"`
|
||||||
|
SendDate int `json:"send_date"`
|
||||||
|
}
|
||||||
|
type SuggestedPostApprovalFailed struct {
|
||||||
|
SuggestedPostMessage *Message `json:"suggested_post_message,omitempty"`
|
||||||
|
Price SuggestedPostPrice `json:"price"`
|
||||||
|
}
|
||||||
|
type SuggestedPostDeclined struct {
|
||||||
|
SuggestedPostMessage *Message `json:"suggested_post_message,omitempty"`
|
||||||
|
Comment string `json:"comment,omitempty"`
|
||||||
|
}
|
||||||
|
type SuggestedPostPaid struct {
|
||||||
|
SuggestedPostMessage *Message `json:"suggested_post_message,omitempty"`
|
||||||
|
Currency string `json:"currency"`
|
||||||
|
Amount int `json:"amount"`
|
||||||
|
StarAmount *StarAmount `json:"star_amount,omitempty"`
|
||||||
|
}
|
||||||
|
type SuggestedPostRefunded struct {
|
||||||
|
SuggestedPostMessage *Message `json:"suggested_post_message,omitempty"`
|
||||||
|
Reason string `json:"reason,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type VideoChatScheduled struct {
|
||||||
|
StartDate int64 `json:"start_date"`
|
||||||
|
}
|
||||||
|
type VideoChatStarted struct{}
|
||||||
|
type VideoChatEnded struct {
|
||||||
|
Duration int64 `json:"duration"`
|
||||||
|
}
|
||||||
|
type VideoChatParticipantsInvited struct {
|
||||||
|
Users []User `json:"users"`
|
||||||
|
}
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestReplyKeyboardMarkupMarshalsKeyboardButtons(t *testing.T) {
|
||||||
|
markup := ReplyKeyboardMarkup{
|
||||||
|
Keyboard: [][]KeyboardButton{{
|
||||||
|
{
|
||||||
|
Text: "Create poll",
|
||||||
|
RequestPoll: &KeyboardButtonPollType{Type: PollTypeQuiz},
|
||||||
|
},
|
||||||
|
}},
|
||||||
|
}
|
||||||
|
|
||||||
|
data, err := json.Marshal(markup)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Marshal returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
got := string(data)
|
||||||
|
if !strings.Contains(got, `"keyboard":[[{"text":"Create poll","request_poll":{"type":"quiz"}}]]`) {
|
||||||
|
t.Fatalf("unexpected reply keyboard JSON: %s", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestChatActionUploadVideoNoteValue(t *testing.T) {
|
||||||
|
if ChatActionUploadVideoNote != "upload_video_note" {
|
||||||
|
t.Fatalf("unexpected chat action value: %q", ChatActionUploadVideoNote)
|
||||||
|
}
|
||||||
|
if ChatActionUploadVideoNone != ChatActionUploadVideoNote {
|
||||||
|
t.Fatalf("expected deprecated alias to match upload_video_note, got %q", ChatActionUploadVideoNone)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,282 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||||
|
)
|
||||||
|
|
||||||
|
// UpdateParams holds parameters for the getUpdates method.
|
||||||
|
// See https://core.telegram.org/bots/api#getupdates
|
||||||
|
type UpdateParams struct {
|
||||||
|
Offset *int `json:"offset,omitempty"`
|
||||||
|
Limit *int `json:"limit,omitempty"`
|
||||||
|
Timeout *int `json:"timeout,omitempty"`
|
||||||
|
AllowedUpdates []UpdateType `json:"allowed_updates,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetMe returns basic information about the bot.
|
||||||
|
// See https://core.telegram.org/bots/api#getme
|
||||||
|
func (api *API) GetMe() (User, error) {
|
||||||
|
req := NewRequest[User]("getMe", NoParams)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetMeWithContext is the context-aware variant of GetMe.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getme
|
||||||
|
func (api *API) GetMeWithContext(ctx context.Context) (User, error) {
|
||||||
|
req := NewRequest[User]("getMe", NoParams)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetManagedBotToken holds parameters for the getManagedBotToken method.
|
||||||
|
// See https://core.telegram.org/bots/api#getmanagedbottoken
|
||||||
|
type GetManagedBotToken struct {
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetManagedBotToken returns the current token of a managed bot.
|
||||||
|
// See https://core.telegram.org/bots/api#getmanagedbottoken
|
||||||
|
func (api *API) GetManagedBotToken(params GetManagedBotToken) (string, error) {
|
||||||
|
req := NewRequest[string]("getManagedBotToken", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetManagedBotTokenWithContext is the context-aware variant of GetManagedBotToken.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getmanagedbottoken
|
||||||
|
func (api *API) GetManagedBotTokenWithContext(ctx context.Context, params GetManagedBotToken) (string, error) {
|
||||||
|
req := NewRequest[string]("getManagedBotToken", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReplaceManagedBotToken holds parameters for the replaceManagedBotToken method.
|
||||||
|
// See https://core.telegram.org/bots/api#replacemanagedbottoken
|
||||||
|
type ReplaceManagedBotToken struct {
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReplaceManagedBotToken replaces and returns the token of a managed bot.
|
||||||
|
// See https://core.telegram.org/bots/api#replacemanagedbottoken
|
||||||
|
func (api *API) ReplaceManagedBotToken(params ReplaceManagedBotToken) (string, error) {
|
||||||
|
req := NewRequest[string]("replaceManagedBotToken", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReplaceManagedBotTokenWithContext is the context-aware variant of ReplaceManagedBotToken.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#replacemanagedbottoken
|
||||||
|
func (api *API) ReplaceManagedBotTokenWithContext(ctx context.Context, params ReplaceManagedBotToken) (string, error) {
|
||||||
|
req := NewRequest[string]("replaceManagedBotToken", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// LogOut logs the bot out from the cloud Bot API server.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#logout
|
||||||
|
func (api *API) LogOut() (bool, error) {
|
||||||
|
req := NewRequest[bool, EmptyParams]("logOut", NoParams)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// LogOutWithContext is the context-aware variant of LogOut.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#logout
|
||||||
|
func (api *API) LogOutWithContext(ctx context.Context) (bool, error) {
|
||||||
|
req := NewRequest[bool, EmptyParams]("logOut", NoParams)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CloseRemote closes the bot instance on the local server.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#close
|
||||||
|
func (api *API) CloseRemote() (bool, error) {
|
||||||
|
req := NewRequest[bool, EmptyParams]("close", NoParams)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CloseRemoteWithContext is the context-aware variant of CloseRemote.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#close
|
||||||
|
func (api *API) CloseRemoteWithContext(ctx context.Context) (bool, error) {
|
||||||
|
req := NewRequest[bool, EmptyParams]("close", NoParams)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetUpdates receives incoming updates using long polling.
|
||||||
|
// See https://core.telegram.org/bots/api#getupdates
|
||||||
|
func (api *API) GetUpdates(params UpdateParams) ([]Update, error) {
|
||||||
|
req := NewRequest[[]Update]("getUpdates", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetUpdatesWithContext is the context-aware variant of GetUpdates.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getupdates
|
||||||
|
func (api *API) GetUpdatesWithContext(ctx context.Context, params UpdateParams) ([]Update, error) {
|
||||||
|
req := NewRequest[[]Update]("getUpdates", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetWebhook holds parameters for the setWebhook method.
|
||||||
|
// To upload a self-signed certificate, use Uploader.SetWebhook.
|
||||||
|
// See https://core.telegram.org/bots/api#setwebhook
|
||||||
|
type SetWebhook struct {
|
||||||
|
URL string `json:"url"`
|
||||||
|
IPAddress string `json:"ip_address,omitempty"`
|
||||||
|
MaxConnections int8 `json:"max_connections,omitempty"`
|
||||||
|
AllowedUpdates []UpdateType `json:"allowed_updates,omitempty"`
|
||||||
|
DropPendingUpdates bool `json:"drop_pending_updates,omitempty"`
|
||||||
|
SecretToken string `json:"secret_token,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetWebhook sets a webhook URL for incoming updates.
|
||||||
|
// For certificate upload, use Uploader.SetWebhook.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setwebhook
|
||||||
|
func (api *API) SetWebhook(params SetWebhook) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setWebhook", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetWebhookWithContext is the context-aware variant of SetWebhook.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// For certificate upload, use Uploader.SetWebhook.
|
||||||
|
// See https://core.telegram.org/bots/api#setwebhook
|
||||||
|
func (api *API) SetWebhookWithContext(ctx context.Context, params SetWebhook) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setWebhook", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteWebhook holds parameters for the deleteWebhook method.
|
||||||
|
// See https://core.telegram.org/bots/api#deletewebhook
|
||||||
|
type DeleteWebhook struct {
|
||||||
|
DropPendingUpdates bool `json:"drop_pending_updates,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteWebhook removes the current webhook integration.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#deletewebhook
|
||||||
|
func (api *API) DeleteWebhook(params DeleteWebhook) (bool, error) {
|
||||||
|
req := NewRequest[bool]("deleteWebhook", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteWebhookWithContext is the context-aware variant of DeleteWebhook.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#deletewebhook
|
||||||
|
func (api *API) DeleteWebhookWithContext(ctx context.Context, params DeleteWebhook) (bool, error) {
|
||||||
|
req := NewRequest[bool]("deleteWebhook", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetWebhookInfo returns the current webhook status.
|
||||||
|
// See https://core.telegram.org/bots/api#getwebhookinfo
|
||||||
|
func (api *API) GetWebhookInfo() (WebhookInfo, error) {
|
||||||
|
req := NewRequest[WebhookInfo]("getWebhookInfo", NoParams)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetWebhookInfoWithContext is the context-aware variant of GetWebhookInfo.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getwebhookinfo
|
||||||
|
func (api *API) GetWebhookInfoWithContext(ctx context.Context) (WebhookInfo, error) {
|
||||||
|
req := NewRequest[WebhookInfo]("getWebhookInfo", NoParams)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetFile holds parameters for the getFile method.
|
||||||
|
// See https://core.telegram.org/bots/api#getfile
|
||||||
|
type GetFile struct {
|
||||||
|
FileID string `json:"file_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetFile returns basic information about a file and prepares it for downloading.
|
||||||
|
// See https://core.telegram.org/bots/api#getfile
|
||||||
|
func (api *API) GetFile(params GetFile) (File, error) {
|
||||||
|
req := NewRequest[File]("getFile", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetFileWithContext is the context-aware variant of GetFile.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getfile
|
||||||
|
func (api *API) GetFileWithContext(ctx context.Context, params GetFile) (File, error) {
|
||||||
|
req := NewRequest[File]("getFile", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetFileByLink downloads a file from Telegram's file server using the provided file link.
|
||||||
|
// The link is usually obtained from File.FilePath.
|
||||||
|
// For large files, prefer OpenFileByLink or OpenFileByLinkWithContext to stream the response body.
|
||||||
|
// See https://core.telegram.org/bots/api#file
|
||||||
|
func (api *API) GetFileByLink(link string) ([]byte, error) {
|
||||||
|
return api.getFileByLink(context.Background(), link)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetFileByLinkWithContext is the context-aware variant of GetFileByLink.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// For large files, prefer OpenFileByLinkWithContext to stream the response body.
|
||||||
|
// See https://core.telegram.org/bots/api#file
|
||||||
|
func (api *API) GetFileByLinkWithContext(ctx context.Context, link string) ([]byte, error) {
|
||||||
|
return api.getFileByLink(ctx, link)
|
||||||
|
}
|
||||||
|
|
||||||
|
// OpenFileByLink opens a streaming response body for a file hosted on Telegram's file server.
|
||||||
|
// The caller must close the returned ReadCloser.
|
||||||
|
// See https://core.telegram.org/bots/api#file
|
||||||
|
func (api *API) OpenFileByLink(link string) (io.ReadCloser, error) {
|
||||||
|
return api.openFileByLink(context.Background(), link)
|
||||||
|
}
|
||||||
|
|
||||||
|
// OpenFileByLinkWithContext is the context-aware variant of OpenFileByLink.
|
||||||
|
// The caller must close the returned ReadCloser.
|
||||||
|
// See https://core.telegram.org/bots/api#file
|
||||||
|
func (api *API) OpenFileByLinkWithContext(ctx context.Context, link string) (io.ReadCloser, error) {
|
||||||
|
return api.openFileByLink(ctx, link)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (api *API) getFileByLink(ctx context.Context, link string) ([]byte, error) {
|
||||||
|
body, err := api.openFileByLink(ctx, link)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
defer func() {
|
||||||
|
_ = body.Close()
|
||||||
|
}()
|
||||||
|
return io.ReadAll(body)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (api *API) openFileByLink(ctx context.Context, link string) (io.ReadCloser, error) {
|
||||||
|
methodPrefix := ""
|
||||||
|
if api.useTestServer {
|
||||||
|
methodPrefix = "/test"
|
||||||
|
}
|
||||||
|
u := fmt.Sprintf("%s/file/bot%s%s/%s", api.apiURL, api.token, methodPrefix, link)
|
||||||
|
|
||||||
|
req, err := http.NewRequestWithContext(ctx, http.MethodGet, u, nil)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
req.Header.Set("User-Agent", fmt.Sprintf("Laniakea/%s", utils.VersionString))
|
||||||
|
|
||||||
|
res, err := api.client.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if res.StatusCode < http.StatusOK || res.StatusCode >= http.StatusMultipleChoices {
|
||||||
|
defer func() {
|
||||||
|
_ = res.Body.Close()
|
||||||
|
}()
|
||||||
|
body, readErr := io.ReadAll(io.LimitReader(res.Body, 4<<10))
|
||||||
|
if readErr != nil {
|
||||||
|
return nil, fmt.Errorf("unexpected status %d", res.StatusCode)
|
||||||
|
}
|
||||||
|
return nil, fmt.Errorf("unexpected status %d: %s", res.StatusCode, string(body))
|
||||||
|
}
|
||||||
|
return res.Body, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,210 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestGetFileByLinkUsesConfiguredAPIURL(t *testing.T) {
|
||||||
|
var gotPath string
|
||||||
|
|
||||||
|
client := &http.Client{
|
||||||
|
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
gotPath = req.URL.Path
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Body: io.NopCloser(strings.NewReader("payload")),
|
||||||
|
}, nil
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
|
||||||
|
api := NewAPI(
|
||||||
|
NewAPIOpts("token").
|
||||||
|
SetAPIURL("https://example.test").
|
||||||
|
SetHTTPClient(client),
|
||||||
|
)
|
||||||
|
defer func() {
|
||||||
|
if err := api.Close(); err != nil {
|
||||||
|
t.Fatalf("Close returned error: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
data, err := api.GetFileByLink("files/report.txt")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("GetFileByLink returned error: %v", err)
|
||||||
|
}
|
||||||
|
if string(data) != "payload" {
|
||||||
|
t.Fatalf("unexpected payload: %q", string(data))
|
||||||
|
}
|
||||||
|
if gotPath != "/file/bottoken/files/report.txt" {
|
||||||
|
t.Fatalf("unexpected request path: %s", gotPath)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestOpenFileByLinkStreamsResponseBody(t *testing.T) {
|
||||||
|
api := NewAPI(
|
||||||
|
NewAPIOpts("token").
|
||||||
|
SetAPIURL("https://example.test").
|
||||||
|
SetHTTPClient(&http.Client{
|
||||||
|
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Body: io.NopCloser(strings.NewReader("streamed payload")),
|
||||||
|
}, nil
|
||||||
|
}),
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
defer func() {
|
||||||
|
if err := api.Close(); err != nil {
|
||||||
|
t.Fatalf("Close returned error: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
body, err := api.OpenFileByLink("files/report.txt")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("OpenFileByLink returned error: %v", err)
|
||||||
|
}
|
||||||
|
defer func() {
|
||||||
|
if err := body.Close(); err != nil {
|
||||||
|
t.Fatalf("Close returned error: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
data, err := io.ReadAll(body)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to read body: %v", err)
|
||||||
|
}
|
||||||
|
if string(data) != "streamed payload" {
|
||||||
|
t.Fatalf("unexpected payload: %q", string(data))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGetFileByLinkReturnsHTTPStatusError(t *testing.T) {
|
||||||
|
client := &http.Client{
|
||||||
|
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusNotFound,
|
||||||
|
Body: io.NopCloser(strings.NewReader("missing\n")),
|
||||||
|
}, nil
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
|
||||||
|
api := NewAPI(
|
||||||
|
NewAPIOpts("token").
|
||||||
|
SetAPIURL("https://example.test").
|
||||||
|
SetHTTPClient(client),
|
||||||
|
)
|
||||||
|
defer func() {
|
||||||
|
if err := api.Close(); err != nil {
|
||||||
|
t.Fatalf("Close returned error: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
_, err := api.GetFileByLink("files/report.txt")
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error for non-2xx response")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGetUpdatesOmitsAllowedUpdatesWhenEmpty(t *testing.T) {
|
||||||
|
var gotBody map[string]any
|
||||||
|
|
||||||
|
client := &http.Client{
|
||||||
|
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
body, err := io.ReadAll(req.Body)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to read request body: %v", err)
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(body, &gotBody); err != nil {
|
||||||
|
t.Fatalf("failed to decode request body: %v", err)
|
||||||
|
}
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||||
|
Body: io.NopCloser(strings.NewReader(`{"ok":true,"result":[]}`)),
|
||||||
|
}, nil
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
|
||||||
|
api := NewAPI(
|
||||||
|
NewAPIOpts("token").
|
||||||
|
SetAPIURL("https://example.test").
|
||||||
|
SetHTTPClient(client),
|
||||||
|
)
|
||||||
|
defer func() {
|
||||||
|
if err := api.Close(); err != nil {
|
||||||
|
t.Fatalf("Close returned error: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
updates, err := api.GetUpdates(UpdateParams{})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("GetUpdates returned error: %v", err)
|
||||||
|
}
|
||||||
|
if len(updates) != 0 {
|
||||||
|
t.Fatalf("expected no updates, got %d", len(updates))
|
||||||
|
}
|
||||||
|
if _, exists := gotBody["allowed_updates"]; exists {
|
||||||
|
t.Fatalf("expected allowed_updates to be omitted, got %v", gotBody["allowed_updates"])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetChatMenuButtonSendsStructuredMenuButton(t *testing.T) {
|
||||||
|
var gotBody map[string]any
|
||||||
|
|
||||||
|
client := &http.Client{
|
||||||
|
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
body, err := io.ReadAll(req.Body)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to read request body: %v", err)
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(body, &gotBody); err != nil {
|
||||||
|
t.Fatalf("failed to decode request body: %v", err)
|
||||||
|
}
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||||
|
Body: io.NopCloser(strings.NewReader(`{"ok":true,"result":true}`)),
|
||||||
|
}, nil
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
|
||||||
|
api := NewAPI(
|
||||||
|
NewAPIOpts("token").
|
||||||
|
SetAPIURL("https://example.test").
|
||||||
|
SetHTTPClient(client),
|
||||||
|
)
|
||||||
|
defer func() {
|
||||||
|
if err := api.Close(); err != nil {
|
||||||
|
t.Fatalf("Close returned error: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
text := "Open"
|
||||||
|
if _, err := api.SetChatMenuButton(SetChatMenuButton{
|
||||||
|
ChatID: 42,
|
||||||
|
MenuButton: &MenuButton{
|
||||||
|
Type: MenuButtonWebAppType,
|
||||||
|
Text: &text,
|
||||||
|
WebApp: &WebAppInfo{
|
||||||
|
URL: "https://example.test/app",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}); err != nil {
|
||||||
|
t.Fatalf("SetChatMenuButton returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
menuButton, ok := gotBody["menu_button"].(map[string]any)
|
||||||
|
if !ok {
|
||||||
|
t.Fatalf("expected structured menu_button, got %#v", gotBody["menu_button"])
|
||||||
|
}
|
||||||
|
if menuButton["type"] != string(MenuButtonWebAppType) {
|
||||||
|
t.Fatalf("unexpected menu button type: %#v", menuButton["type"])
|
||||||
|
}
|
||||||
|
if menuButton["text"] != text {
|
||||||
|
t.Fatalf("unexpected menu button text: %#v", menuButton["text"])
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
// ParseMode represents the text formatting mode for message parsing.
|
||||||
|
type ParseMode string
|
||||||
|
|
||||||
|
const (
|
||||||
|
// ParseMDV2 enables MarkdownV2 style parsing.
|
||||||
|
ParseMDV2 ParseMode = "MarkdownV2"
|
||||||
|
// ParseHTML enables HTML style parsing.
|
||||||
|
ParseHTML ParseMode = "HTML"
|
||||||
|
// ParseMD enables legacy Markdown style parsing.
|
||||||
|
ParseMD ParseMode = "Markdown"
|
||||||
|
// ParseNone disables parse_mode and leaves plain-text requests unannotated.
|
||||||
|
ParseNone ParseMode = ""
|
||||||
|
)
|
||||||
|
|
||||||
|
// EmptyParams is a placeholder for methods that take no parameters.
|
||||||
|
type EmptyParams struct{}
|
||||||
|
|
||||||
|
// NoParams is a convenient instance of EmptyParams.
|
||||||
|
var NoParams = EmptyParams{}
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestParseNoneOmitsParseModeInJSON(t *testing.T) {
|
||||||
|
data, err := json.Marshal(SendMessage{
|
||||||
|
ChatID: 42,
|
||||||
|
Text: "hello",
|
||||||
|
ParseMode: ParseNone,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Marshal returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if strings.Contains(string(data), `"parse_mode"`) {
|
||||||
|
t.Fatalf("expected parse_mode to be omitted, got %s", string(data))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseModeStillSerializesExplicitModes(t *testing.T) {
|
||||||
|
data, err := json.Marshal(SendMessage{
|
||||||
|
ChatID: 42,
|
||||||
|
Text: "hello",
|
||||||
|
ParseMode: ParseMDV2,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Marshal returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !strings.Contains(string(data), `"parse_mode":"MarkdownV2"`) {
|
||||||
|
t.Fatalf("expected MarkdownV2 parse_mode, got %s", string(data))
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import "context"
|
||||||
|
|
||||||
|
// SetPassportDataErrors holds parameters for the setPassportDataErrors method.
|
||||||
|
// See https://core.telegram.org/bots/api#setpassportdataerrors
|
||||||
|
type SetPassportDataErrors struct {
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
Errors []PassportElementError `json:"errors"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetPassportDataErrors informs a user about Telegram Passport data errors.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setpassportdataerrors
|
||||||
|
func (api *API) SetPassportDataErrors(params SetPassportDataErrors) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setPassportDataErrors", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetPassportDataErrorsWithContext is the context-aware variant of SetPassportDataErrors.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setpassportdataerrors
|
||||||
|
func (api *API) SetPassportDataErrorsWithContext(ctx context.Context, params SetPassportDataErrors) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setPassportDataErrors", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
@@ -0,0 +1,64 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
type PassportData struct {
|
||||||
|
Data []EncryptedPassportElement `json:"data"`
|
||||||
|
Credentials EncryptedCredentials `json:"credentials"`
|
||||||
|
}
|
||||||
|
type PassportFile struct {
|
||||||
|
FileID string `json:"file_id"`
|
||||||
|
FileUniqueID string `json:"file_unique_id"`
|
||||||
|
FileSize int64 `json:"file_size"`
|
||||||
|
FileDate int64 `json:"file_date"`
|
||||||
|
}
|
||||||
|
type PassportElementType string
|
||||||
|
|
||||||
|
const (
|
||||||
|
PassportPersonalDetailsType PassportElementType = "personal_details"
|
||||||
|
PassportPassportType PassportElementType = "passport"
|
||||||
|
PassportDriverLicenseType PassportElementType = "driver_license"
|
||||||
|
PassportIdentityCardType PassportElementType = "identity_card"
|
||||||
|
PassportInternalPassportType PassportElementType = "internal_passport"
|
||||||
|
PassportAddressType PassportElementType = "address"
|
||||||
|
PassportUtilityBillType PassportElementType = "utility_bill"
|
||||||
|
PassportBankStatementType PassportElementType = "bank_statement"
|
||||||
|
PassportRentalAgreementType PassportElementType = "rental_agreement"
|
||||||
|
PassportPassportRegistrationType PassportElementType = "passport_registration"
|
||||||
|
PassportTemporaryRegistrationType PassportElementType = "temporary_registration"
|
||||||
|
PassportPhoneNumberType PassportElementType = "phone_number"
|
||||||
|
PassportEmailType PassportElementType = "email"
|
||||||
|
)
|
||||||
|
|
||||||
|
type EncryptedPassportElement struct {
|
||||||
|
Type PassportElementType `json:"type"`
|
||||||
|
Data string `json:"data,omitempty"`
|
||||||
|
PhoneNumber string `json:"phone_number,omitempty"`
|
||||||
|
Email string `json:"email,omitempty"`
|
||||||
|
Files []PassportFile `json:"files,omitempty"`
|
||||||
|
FrontSide *PassportFile `json:"front_side,omitempty"`
|
||||||
|
ReverseSide *PassportFile `json:"reverse_side,omitempty"`
|
||||||
|
Selfie *PassportFile `json:"selfie,omitempty"`
|
||||||
|
Translation *PassportFile `json:"translation,omitempty"`
|
||||||
|
Hash string `json:"hash,omitempty"`
|
||||||
|
}
|
||||||
|
type EncryptedCredentials struct {
|
||||||
|
Data string `json:"data"`
|
||||||
|
Hash string `json:"hash"`
|
||||||
|
Secret string `json:"secret"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// PassportElementError is a JSON-serializable passport element error object.
|
||||||
|
// See https://core.telegram.org/bots/api#passportelementerror
|
||||||
|
type PassportElementError struct {
|
||||||
|
Source string `json:"source"`
|
||||||
|
Type PassportElementType `json:"type"`
|
||||||
|
|
||||||
|
FieldName string `json:"field_name,omitempty"`
|
||||||
|
DataHash string `json:"data_hash,omitempty"`
|
||||||
|
|
||||||
|
FileHash string `json:"file_hash,omitempty"`
|
||||||
|
FileHashes []string `json:"file_hashes,omitempty"`
|
||||||
|
|
||||||
|
ElementHash string `json:"element_hash,omitempty"`
|
||||||
|
|
||||||
|
Message string `json:"message"`
|
||||||
|
}
|
||||||
@@ -0,0 +1,150 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import "context"
|
||||||
|
|
||||||
|
// SendInvoice holds parameters for the sendInvoice method.
|
||||||
|
// See https://core.telegram.org/bots/api#sendinvoice
|
||||||
|
type SendInvoice struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
Title string `json:"title"`
|
||||||
|
Description string `json:"description"`
|
||||||
|
Payload string `json:"payload"`
|
||||||
|
ProviderToken string `json:"provider_token,omitempty"`
|
||||||
|
Currency string `json:"currency"`
|
||||||
|
Prices []LabeledPrice `json:"prices"`
|
||||||
|
|
||||||
|
MaxTipAmount int `json:"max_tip_amount,omitempty"`
|
||||||
|
SuggestedTipAmounts []int `json:"suggested_tip_amounts,omitempty"`
|
||||||
|
StartParameter string `json:"start_parameter,omitempty"`
|
||||||
|
ProviderData string `json:"provider_data,omitempty"`
|
||||||
|
PhotoURL string `json:"photo_url,omitempty"`
|
||||||
|
PhotoSize int `json:"photo_size,omitempty"`
|
||||||
|
PhotoWidth int `json:"photo_width,omitempty"`
|
||||||
|
PhotoHeight int `json:"photo_height,omitempty"`
|
||||||
|
NeedName bool `json:"need_name,omitempty"`
|
||||||
|
NeedPhoneNumber bool `json:"need_phone_number,omitempty"`
|
||||||
|
NeedEmail bool `json:"need_email,omitempty"`
|
||||||
|
NeedShippingAddress bool `json:"need_shipping_address,omitempty"`
|
||||||
|
SendPhoneToProvider bool `json:"send_phone_number_to_provider,omitempty"`
|
||||||
|
SendEmailToProvider bool `json:"send_email_to_provider,omitempty"`
|
||||||
|
IsFlexible bool `json:"is_flexible,omitempty"`
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendInvoice sends an invoice.
|
||||||
|
// See https://core.telegram.org/bots/api#sendinvoice
|
||||||
|
func (api *API) SendInvoice(params SendInvoice) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendInvoice", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendInvoiceWithContext is the context-aware variant of SendInvoice.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#sendinvoice
|
||||||
|
func (api *API) SendInvoiceWithContext(ctx context.Context, params SendInvoice) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendInvoice", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CreateInvoiceLink holds parameters for the createInvoiceLink method.
|
||||||
|
// See https://core.telegram.org/bots/api#createinvoicelink
|
||||||
|
type CreateInvoiceLink struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
|
||||||
|
Title string `json:"title"`
|
||||||
|
Description string `json:"description"`
|
||||||
|
Payload string `json:"payload"`
|
||||||
|
ProviderToken string `json:"provider_token,omitempty"`
|
||||||
|
Currency string `json:"currency"`
|
||||||
|
Prices []LabeledPrice `json:"prices"`
|
||||||
|
|
||||||
|
SubscriptionPeriod int `json:"subscription_period,omitempty"`
|
||||||
|
MaxTipAmount int `json:"max_tip_amount,omitempty"`
|
||||||
|
SuggestedTipAmounts []int `json:"suggested_tip_amounts,omitempty"`
|
||||||
|
ProviderData string `json:"provider_data,omitempty"`
|
||||||
|
PhotoURL string `json:"photo_url,omitempty"`
|
||||||
|
PhotoSize int `json:"photo_size,omitempty"`
|
||||||
|
PhotoWidth int `json:"photo_width,omitempty"`
|
||||||
|
PhotoHeight int `json:"photo_height,omitempty"`
|
||||||
|
NeedName bool `json:"need_name,omitempty"`
|
||||||
|
NeedPhoneNumber bool `json:"need_phone_number,omitempty"`
|
||||||
|
NeedEmail bool `json:"need_email,omitempty"`
|
||||||
|
NeedShippingAddress bool `json:"need_shipping_address,omitempty"`
|
||||||
|
SendPhoneToProvider bool `json:"send_phone_number_to_provider,omitempty"`
|
||||||
|
SendEmailToProvider bool `json:"send_email_to_provider,omitempty"`
|
||||||
|
IsFlexible bool `json:"is_flexible,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// CreateInvoiceLink creates an invoice link.
|
||||||
|
// See https://core.telegram.org/bots/api#createinvoicelink
|
||||||
|
func (api *API) CreateInvoiceLink(params CreateInvoiceLink) (string, error) {
|
||||||
|
req := NewRequest[string]("createInvoiceLink", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CreateInvoiceLinkWithContext is the context-aware variant of CreateInvoiceLink.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#createinvoicelink
|
||||||
|
func (api *API) CreateInvoiceLinkWithContext(ctx context.Context, params CreateInvoiceLink) (string, error) {
|
||||||
|
req := NewRequest[string]("createInvoiceLink", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnswerShippingQuery holds parameters for the answerShippingQuery method.
|
||||||
|
// See https://core.telegram.org/bots/api#answershippingquery
|
||||||
|
type AnswerShippingQuery struct {
|
||||||
|
ShippingQueryID string `json:"shipping_query_id"`
|
||||||
|
OK bool `json:"ok"`
|
||||||
|
ShippingOptions []ShippingOption `json:"shipping_options,omitempty"`
|
||||||
|
ErrorMessage string `json:"error_message,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnswerShippingQuery answers a shipping query.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#answershippingquery
|
||||||
|
func (api *API) AnswerShippingQuery(params AnswerShippingQuery) (bool, error) {
|
||||||
|
req := NewRequest[bool]("answerShippingQuery", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnswerShippingQueryWithContext is the context-aware variant of AnswerShippingQuery.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#answershippingquery
|
||||||
|
func (api *API) AnswerShippingQueryWithContext(ctx context.Context, params AnswerShippingQuery) (bool, error) {
|
||||||
|
req := NewRequest[bool]("answerShippingQuery", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnswerPreCheckoutQuery holds parameters for the answerPreCheckoutQuery method.
|
||||||
|
// See https://core.telegram.org/bots/api#answerprecheckoutquery
|
||||||
|
type AnswerPreCheckoutQuery struct {
|
||||||
|
PreCheckoutQueryID string `json:"pre_checkout_query_id"`
|
||||||
|
OK bool `json:"ok"`
|
||||||
|
ErrorMessage string `json:"error_message,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnswerPreCheckoutQuery answers a pre-checkout query.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#answerprecheckoutquery
|
||||||
|
func (api *API) AnswerPreCheckoutQuery(params AnswerPreCheckoutQuery) (bool, error) {
|
||||||
|
req := NewRequest[bool]("answerPreCheckoutQuery", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnswerPreCheckoutQueryWithContext is the context-aware variant of AnswerPreCheckoutQuery.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#answerprecheckoutquery
|
||||||
|
func (api *API) AnswerPreCheckoutQueryWithContext(ctx context.Context, params AnswerPreCheckoutQuery) (bool, error) {
|
||||||
|
req := NewRequest[bool]("answerPreCheckoutQuery", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
@@ -0,0 +1,96 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
// LabeledPrice represents a price portion.
|
||||||
|
// See https://core.telegram.org/bots/api#labeledprice
|
||||||
|
type LabeledPrice struct {
|
||||||
|
Label string `json:"label"`
|
||||||
|
Amount int `json:"amount"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type Invoice struct {
|
||||||
|
Title string `json:"title"`
|
||||||
|
Description string `json:"description"`
|
||||||
|
StartParameter string `json:"start_parameter"`
|
||||||
|
Currency string `json:"currency"`
|
||||||
|
TotalAmount int `json:"total_amount"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ShippingQuery represents an incoming shipping query.
|
||||||
|
// See https://core.telegram.org/bots/api#shippingquery
|
||||||
|
type ShippingQuery struct {
|
||||||
|
ID string `json:"id"`
|
||||||
|
From User `json:"from"`
|
||||||
|
InvoicePayload string `json:"invoice_payload"`
|
||||||
|
ShippingAddress ShippingAddress `json:"shipping_address"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ShippingAddress represents a shipping address.
|
||||||
|
// See https://core.telegram.org/bots/api#shippingaddress
|
||||||
|
type ShippingAddress struct {
|
||||||
|
CountryCode string `json:"country_code"`
|
||||||
|
State string `json:"state"`
|
||||||
|
City string `json:"city"`
|
||||||
|
StreetLine1 string `json:"street_line1"`
|
||||||
|
StreetLine2 string `json:"street_line2"`
|
||||||
|
PostCode string `json:"post_code"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// OrderInfo represents information about an order.
|
||||||
|
// See https://core.telegram.org/bots/api#orderinfo
|
||||||
|
type OrderInfo struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
PhoneNumber string `json:"phone_number"`
|
||||||
|
Email string `json:"email"`
|
||||||
|
ShippingAddress ShippingAddress `json:"shipping_address"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// PreCheckoutQuery represents an incoming pre-checkout query.
|
||||||
|
// See https://core.telegram.org/bots/api#precheckoutquery
|
||||||
|
type PreCheckoutQuery struct {
|
||||||
|
ID string `json:"id"`
|
||||||
|
From User `json:"from"`
|
||||||
|
Currency string `json:"currency"`
|
||||||
|
TotalAmount int `json:"total_amount"`
|
||||||
|
InvoicePayload string `json:"invoice_payload"`
|
||||||
|
ShippingOptionID string `json:"shipping_option_id"`
|
||||||
|
OrderInfo *OrderInfo `json:"order_info,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// PaidMediaPurchased represents a purchased paid media.
|
||||||
|
// See https://core.telegram.org/bots/api#paidmediapurchased
|
||||||
|
type PaidMediaPurchased struct {
|
||||||
|
From User `json:"from"`
|
||||||
|
PaidMediaPayload string `json:"paid_media_payload"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ShippingOption represents one shipping option.
|
||||||
|
// See https://core.telegram.org/bots/api#shippingoption
|
||||||
|
type ShippingOption struct {
|
||||||
|
ID string `json:"id"`
|
||||||
|
Title string `json:"title"`
|
||||||
|
Prices []LabeledPrice `json:"prices"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type SuccessfulPayment struct {
|
||||||
|
Currency string `json:"currency"`
|
||||||
|
TotalAmount int `json:"total_amount"`
|
||||||
|
InvoicePayload string `json:"invoice_payload"`
|
||||||
|
|
||||||
|
SubscriptionExpirationDate int `json:"subscription_expiration_date,omitempty"`
|
||||||
|
IsRecurring bool `json:"is_recurring,omitempty"`
|
||||||
|
IsFirstRecurring bool `json:"is_first_recurring,omitempty"`
|
||||||
|
ShippingOptionID string `json:"shipping_option_id,omitempty"`
|
||||||
|
OrderInfo *OrderInfo `json:"order_info,omitempty"`
|
||||||
|
|
||||||
|
TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
|
||||||
|
ProviderPaymentChargeID string `json:"proviced_payment_charge_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type RefundedPayment struct {
|
||||||
|
Currency string `json:"currency"`
|
||||||
|
TotalAmount int `json:"total_amount"`
|
||||||
|
InvoicePayload string `json:"invoice_payload"`
|
||||||
|
|
||||||
|
TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
|
||||||
|
ProviderPaymentChargeID string `json:"proviced_payment_charge_id,omitempty"`
|
||||||
|
}
|
||||||
+135
@@ -0,0 +1,135 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"sync"
|
||||||
|
)
|
||||||
|
|
||||||
|
type workerPool struct {
|
||||||
|
taskCh chan requestEnvelope
|
||||||
|
queueSize int
|
||||||
|
workers int
|
||||||
|
wg sync.WaitGroup
|
||||||
|
quit chan struct{}
|
||||||
|
stopOnce sync.Once
|
||||||
|
started bool
|
||||||
|
stopped bool
|
||||||
|
startedMu sync.Mutex
|
||||||
|
}
|
||||||
|
|
||||||
|
type requestEnvelope struct {
|
||||||
|
ctx context.Context
|
||||||
|
doFunc func(context.Context) (any, error)
|
||||||
|
resultCh chan requestResult
|
||||||
|
}
|
||||||
|
|
||||||
|
type requestResult struct {
|
||||||
|
value any
|
||||||
|
err error
|
||||||
|
}
|
||||||
|
|
||||||
|
func newWorkerPool(workers int, queueSize int) *workerPool {
|
||||||
|
if workers <= 0 {
|
||||||
|
workers = 1
|
||||||
|
}
|
||||||
|
if queueSize <= 0 {
|
||||||
|
queueSize = 100
|
||||||
|
}
|
||||||
|
|
||||||
|
return &workerPool{
|
||||||
|
taskCh: make(chan requestEnvelope, queueSize),
|
||||||
|
queueSize: queueSize,
|
||||||
|
workers: workers,
|
||||||
|
quit: make(chan struct{}),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *workerPool) start() {
|
||||||
|
p.startedMu.Lock()
|
||||||
|
defer p.startedMu.Unlock()
|
||||||
|
if p.started {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
p.started = true
|
||||||
|
|
||||||
|
for i := 0; i < p.workers; i++ {
|
||||||
|
p.wg.Add(1)
|
||||||
|
go p.worker()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *workerPool) stop() {
|
||||||
|
p.stopOnce.Do(func() {
|
||||||
|
p.startedMu.Lock()
|
||||||
|
p.stopped = true
|
||||||
|
p.started = false
|
||||||
|
close(p.quit)
|
||||||
|
p.startedMu.Unlock()
|
||||||
|
|
||||||
|
p.wg.Wait()
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *workerPool) submit(ctx context.Context, do func(context.Context) (any, error)) (<-chan requestResult, error) {
|
||||||
|
p.startedMu.Lock()
|
||||||
|
if p.stopped || !p.started {
|
||||||
|
p.startedMu.Unlock()
|
||||||
|
return nil, ErrPoolStopped
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(p.taskCh) >= p.queueSize {
|
||||||
|
p.startedMu.Unlock()
|
||||||
|
return nil, ErrPoolQueueFull
|
||||||
|
}
|
||||||
|
|
||||||
|
resultCh := make(chan requestResult, 1)
|
||||||
|
|
||||||
|
envelope := requestEnvelope{
|
||||||
|
ctx: ctx,
|
||||||
|
doFunc: do,
|
||||||
|
resultCh: resultCh,
|
||||||
|
}
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
p.startedMu.Unlock()
|
||||||
|
return nil, ctx.Err()
|
||||||
|
case p.taskCh <- envelope:
|
||||||
|
p.startedMu.Unlock()
|
||||||
|
return resultCh, nil
|
||||||
|
default:
|
||||||
|
p.startedMu.Unlock()
|
||||||
|
return nil, ErrPoolQueueFull
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *workerPool) worker() {
|
||||||
|
defer p.wg.Done()
|
||||||
|
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-p.quit:
|
||||||
|
// Drain queued work after stop. No new tasks are accepted.
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case envelope := <-p.taskCh:
|
||||||
|
p.executeEnvelope(envelope)
|
||||||
|
default:
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
case envelope := <-p.taskCh:
|
||||||
|
p.executeEnvelope(envelope)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *workerPool) executeEnvelope(envelope requestEnvelope) {
|
||||||
|
value, err := envelope.doFunc(envelope.ctx)
|
||||||
|
envelope.resultCh <- requestResult{
|
||||||
|
value: value,
|
||||||
|
err: err,
|
||||||
|
}
|
||||||
|
close(envelope.resultCh)
|
||||||
|
}
|
||||||
@@ -0,0 +1,62 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestWorkerPoolSubmitAfterStop(t *testing.T) {
|
||||||
|
pool := newWorkerPool(1, 1)
|
||||||
|
pool.start()
|
||||||
|
pool.stop()
|
||||||
|
|
||||||
|
if _, err := pool.submit(context.Background(), func(context.Context) (any, error) {
|
||||||
|
return nil, nil
|
||||||
|
}); !errors.Is(err, ErrPoolStopped) {
|
||||||
|
t.Fatalf("expected ErrPoolStopped, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWorkerPoolQueueFull(t *testing.T) {
|
||||||
|
pool := newWorkerPool(1, 1)
|
||||||
|
pool.start()
|
||||||
|
defer pool.stop()
|
||||||
|
|
||||||
|
started := make(chan struct{})
|
||||||
|
release := make(chan struct{})
|
||||||
|
|
||||||
|
firstResult, err := pool.submit(context.Background(), func(context.Context) (any, error) {
|
||||||
|
close(started)
|
||||||
|
<-release
|
||||||
|
return "first", nil
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("first submit returned error: %v", err)
|
||||||
|
}
|
||||||
|
<-started
|
||||||
|
|
||||||
|
secondResult, err := pool.submit(context.Background(), func(context.Context) (any, error) {
|
||||||
|
return "second", nil
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("second submit returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, err := pool.submit(context.Background(), func(context.Context) (any, error) {
|
||||||
|
return "third", nil
|
||||||
|
}); !errors.Is(err, ErrPoolQueueFull) {
|
||||||
|
t.Fatalf("expected ErrPoolQueueFull, got %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
close(release)
|
||||||
|
|
||||||
|
first := <-firstResult
|
||||||
|
if first.err != nil || first.value != "first" {
|
||||||
|
t.Fatalf("unexpected first result: %+v", first)
|
||||||
|
}
|
||||||
|
second := <-secondResult
|
||||||
|
if second.err != nil || second.value != "second" {
|
||||||
|
t.Fatalf("unexpected second result: %+v", second)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,87 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import "context"
|
||||||
|
|
||||||
|
// GetStarTransactions holds parameters for the getStarTransactions method.
|
||||||
|
// See https://core.telegram.org/bots/api#getstartransactions
|
||||||
|
type GetStarTransactions struct {
|
||||||
|
Offset int `json:"offset,omitempty"`
|
||||||
|
Limit int `json:"limit,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetMyStarBalance returns the bot's Telegram Star balance.
|
||||||
|
// See https://core.telegram.org/bots/api#getmystarbalance
|
||||||
|
func (api *API) GetMyStarBalance() (StarAmount, error) {
|
||||||
|
req := NewRequest[StarAmount]("getMyStarBalance", NoParams)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetMyStarBalanceWithContext is the context-aware variant of GetMyStarBalance.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getmystarbalance
|
||||||
|
func (api *API) GetMyStarBalanceWithContext(ctx context.Context) (StarAmount, error) {
|
||||||
|
req := NewRequest[StarAmount]("getMyStarBalance", NoParams)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetStarTransactions returns Telegram Star transactions for the bot.
|
||||||
|
// See https://core.telegram.org/bots/api#getstartransactions
|
||||||
|
func (api *API) GetStarTransactions(params GetStarTransactions) (StarTransactions, error) {
|
||||||
|
req := NewRequest[StarTransactions]("getStarTransactions", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetStarTransactionsWithContext is the context-aware variant of GetStarTransactions.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getstartransactions
|
||||||
|
func (api *API) GetStarTransactionsWithContext(ctx context.Context, params GetStarTransactions) (StarTransactions, error) {
|
||||||
|
req := NewRequest[StarTransactions]("getStarTransactions", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RefundStarPayment holds parameters for the refundStarPayment method.
|
||||||
|
// See https://core.telegram.org/bots/api#refundstarpayment
|
||||||
|
type RefundStarPayment struct {
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// RefundStarPayment refunds a successful Telegram Stars payment.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#refundstarpayment
|
||||||
|
func (api *API) RefundStarPayment(params RefundStarPayment) (bool, error) {
|
||||||
|
req := NewRequest[bool]("refundStarPayment", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RefundStarPaymentWithContext is the context-aware variant of RefundStarPayment.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#refundstarpayment
|
||||||
|
func (api *API) RefundStarPaymentWithContext(ctx context.Context, params RefundStarPayment) (bool, error) {
|
||||||
|
req := NewRequest[bool]("refundStarPayment", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditUserStarSubscription holds parameters for the editUserStarSubscription method.
|
||||||
|
// See https://core.telegram.org/bots/api#edituserstarsubscription
|
||||||
|
type EditUserStarSubscription struct {
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
|
||||||
|
IsCanceled bool `json:"is_canceled"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditUserStarSubscription cancels or re-enables a user star subscription extension.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#edituserstarsubscription
|
||||||
|
func (api *API) EditUserStarSubscription(params EditUserStarSubscription) (bool, error) {
|
||||||
|
req := NewRequest[bool]("editUserStarSubscription", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EditUserStarSubscriptionWithContext is the context-aware variant of EditUserStarSubscription.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#edituserstarsubscription
|
||||||
|
func (api *API) EditUserStarSubscriptionWithContext(ctx context.Context, params EditUserStarSubscription) (bool, error) {
|
||||||
|
req := NewRequest[bool]("editUserStarSubscription", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
// StarTransaction describes a Telegram Star transaction.
|
||||||
|
// See https://core.telegram.org/bots/api#startransaction
|
||||||
|
type StarTransaction struct {
|
||||||
|
ID string `json:"id"`
|
||||||
|
Amount int `json:"amount"`
|
||||||
|
NanostarAmount int `json:"nanostar_amount,omitempty"`
|
||||||
|
Date int `json:"date"`
|
||||||
|
Source map[string]any `json:"source,omitempty"`
|
||||||
|
Receiver map[string]any `json:"receiver,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// StarTransactions contains a list of Telegram Star transactions.
|
||||||
|
// See https://core.telegram.org/bots/api#startransactions
|
||||||
|
type StarTransactions struct {
|
||||||
|
Transactions []StarTransaction `json:"transactions"`
|
||||||
|
}
|
||||||
@@ -0,0 +1,395 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import "context"
|
||||||
|
|
||||||
|
// SendSticker holds parameters for the sendSticker method.
|
||||||
|
// See https://core.telegram.org/bots/api#sendsticker
|
||||||
|
type SendSticker struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
Sticker string `json:"sticker"`
|
||||||
|
Emoji string `json:"emoji,omitempty"`
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendSticker sends a static .WEBP, animated .TGS, or video .WEBM sticker.
|
||||||
|
// See https://core.telegram.org/bots/api#sendsticker
|
||||||
|
func (api *API) SendSticker(params SendSticker) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendSticker", params, params.ChatID)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendStickerWithContext is the context-aware variant of SendSticker.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#sendsticker
|
||||||
|
func (api *API) SendStickerWithContext(ctx context.Context, params SendSticker) (Message, error) {
|
||||||
|
req := NewRequestWithChatID[Message]("sendSticker", params, params.ChatID)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetStickerSet holds parameters for the getStickerSet method.
|
||||||
|
// See https://core.telegram.org/bots/api#getstickerset
|
||||||
|
type GetStickerSet struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetStickerSet returns a sticker set by its name.
|
||||||
|
// See https://core.telegram.org/bots/api#getstickerset
|
||||||
|
func (api *API) GetStickerSet(params GetStickerSet) (StickerSet, error) {
|
||||||
|
req := NewRequest[StickerSet]("getStickerSet", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetStickerSetWithContext is the context-aware variant of GetStickerSet.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getstickerset
|
||||||
|
func (api *API) GetStickerSetWithContext(ctx context.Context, params GetStickerSet) (StickerSet, error) {
|
||||||
|
req := NewRequest[StickerSet]("getStickerSet", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetCustomEmojiStickers holds parameters for the getCustomEmojiStickers method.
|
||||||
|
// See https://core.telegram.org/bots/api#getcustomemojistickers
|
||||||
|
type GetCustomEmojiStickers struct {
|
||||||
|
CustomEmojiIDs []string `json:"custom_emoji_ids"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetCustomEmojiStickers returns information about custom emoji stickers by their IDs.
|
||||||
|
// See https://core.telegram.org/bots/api#getcustomemojistickers
|
||||||
|
func (api *API) GetCustomEmojiStickers(params GetCustomEmojiStickers) ([]Sticker, error) {
|
||||||
|
req := NewRequest[[]Sticker]("getCustomEmojiStickers", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetCustomEmojiStickersWithContext is the context-aware variant of GetCustomEmojiStickers.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getcustomemojistickers
|
||||||
|
func (api *API) GetCustomEmojiStickersWithContext(ctx context.Context, params GetCustomEmojiStickers) ([]Sticker, error) {
|
||||||
|
req := NewRequest[[]Sticker]("getCustomEmojiStickers", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UploadStickerFile holds parameters for the uploadStickerFile method.
|
||||||
|
// See https://core.telegram.org/bots/api#uploadstickerfile
|
||||||
|
type UploadStickerFile struct {
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
StickerFormat InputStickerFormat `json:"sticker_format"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// UploadStickerFile uploads a sticker file for later use in sticker set methods.
|
||||||
|
// sticker is the file to upload.
|
||||||
|
// See https://core.telegram.org/bots/api#uploadstickerfile
|
||||||
|
func (api *API) UploadStickerFile(params UploadStickerFile, sticker UploaderFile) (File, error) {
|
||||||
|
uploader := NewUploader(api)
|
||||||
|
defer func() {
|
||||||
|
_ = uploader.Close()
|
||||||
|
}()
|
||||||
|
req := NewUploaderRequest[File]("uploadStickerFile", params, sticker.SetType(UploaderStickerType))
|
||||||
|
return req.Do(uploader)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UploadStickerFileWithContext is the context-aware variant of UploadStickerFile.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#uploadstickerfile
|
||||||
|
func (api *API) UploadStickerFileWithContext(ctx context.Context, params UploadStickerFile, sticker UploaderFile) (File, error) {
|
||||||
|
uploader := NewUploader(api)
|
||||||
|
defer func() {
|
||||||
|
_ = uploader.Close()
|
||||||
|
}()
|
||||||
|
req := NewUploaderRequest[File]("uploadStickerFile", params, sticker.SetType(UploaderStickerType))
|
||||||
|
return req.DoWithContext(ctx, uploader)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CreateNewStickerSet holds parameters for the createNewStickerSet method.
|
||||||
|
// See https://core.telegram.org/bots/api#createnewstickerset
|
||||||
|
type CreateNewStickerSet struct {
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
Name string `json:"name"`
|
||||||
|
Title string `json:"title"`
|
||||||
|
|
||||||
|
Stickers []InputSticker `json:"stickers"`
|
||||||
|
StickerType StickerType `json:"sticker_type,omitempty"`
|
||||||
|
NeedsRepainting bool `json:"needs_repainting,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// CreateNewStickerSet creates a new sticker set owned by a user.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#createnewstickerset
|
||||||
|
func (api *API) CreateNewStickerSet(params CreateNewStickerSet) (bool, error) {
|
||||||
|
req := NewRequest[bool]("createNewStickerSet", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CreateNewStickerSetWithContext is the context-aware variant of CreateNewStickerSet.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#createnewstickerset
|
||||||
|
func (api *API) CreateNewStickerSetWithContext(ctx context.Context, params CreateNewStickerSet) (bool, error) {
|
||||||
|
req := NewRequest[bool]("createNewStickerSet", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AddStickerToSet holds parameters for the addStickerToSet method.
|
||||||
|
// See https://core.telegram.org/bots/api#addstickertoset
|
||||||
|
type AddStickerToSet struct {
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
Name string `json:"name"`
|
||||||
|
Sticker InputSticker `json:"sticker"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// AddStickerToSet adds a new sticker to a set created by the bot.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#addstickertoset
|
||||||
|
func (api *API) AddStickerToSet(params AddStickerToSet) (bool, error) {
|
||||||
|
req := NewRequest[bool]("addStickerToSet", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AddStickerToSetWithContext is the context-aware variant of AddStickerToSet.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#addstickertoset
|
||||||
|
func (api *API) AddStickerToSetWithContext(ctx context.Context, params AddStickerToSet) (bool, error) {
|
||||||
|
req := NewRequest[bool]("addStickerToSet", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetStickerPositionInSet holds parameters for the setStickerPositionInSet method.
|
||||||
|
// See https://core.telegram.org/bots/api#setstickerpositioninset
|
||||||
|
type SetStickerPositionInSet struct {
|
||||||
|
Sticker string `json:"sticker"`
|
||||||
|
Position int `json:"position"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetStickerPositionInSet moves a sticker in a set to a specific position.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setstickerpositioninset
|
||||||
|
func (api *API) SetStickerPositionInSet(params SetStickerPositionInSet) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setStickerPositionInSet", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetStickerPositionInSetWithContext is the context-aware variant of SetStickerPositionInSet.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setstickerpositioninset
|
||||||
|
func (api *API) SetStickerPositionInSetWithContext(ctx context.Context, params SetStickerPositionInSet) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setStickerPositionInSet", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteStickerFromSet holds parameters for the deleteStickerFromSet method.
|
||||||
|
// See https://core.telegram.org/bots/api#deletestickerfromset
|
||||||
|
type DeleteStickerFromSet struct {
|
||||||
|
Sticker string `json:"sticker"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteStickerFromSet deletes a sticker from a set created by the bot.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#deletestickerfromset
|
||||||
|
func (api *API) DeleteStickerFromSet(params DeleteStickerFromSet) (bool, error) {
|
||||||
|
req := NewRequest[bool]("deleteStickerFromSet", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteStickerFromSetWithContext is the context-aware variant of DeleteStickerFromSet.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#deletestickerfromset
|
||||||
|
func (api *API) DeleteStickerFromSetWithContext(ctx context.Context, params DeleteStickerFromSet) (bool, error) {
|
||||||
|
req := NewRequest[bool]("deleteStickerFromSet", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReplaceStickerInSet holds parameters for the replaceStickerInSet method.
|
||||||
|
// See https://core.telegram.org/bots/api#replacestickerinset
|
||||||
|
type ReplaceStickerInSet struct {
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
Name string `json:"name"`
|
||||||
|
OldSticker string `json:"old_sticker"`
|
||||||
|
Sticker InputSticker `json:"sticker"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReplaceStickerInSet replaces an existing sticker in a set with a new one.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#replacestickerinset
|
||||||
|
func (api *API) ReplaceStickerInSet(params ReplaceStickerInSet) (bool, error) {
|
||||||
|
req := NewRequest[bool]("replaceStickerInSet", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReplaceStickerInSetWithContext is the context-aware variant of ReplaceStickerInSet.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#replacestickerinset
|
||||||
|
func (api *API) ReplaceStickerInSetWithContext(ctx context.Context, params ReplaceStickerInSet) (bool, error) {
|
||||||
|
req := NewRequest[bool]("replaceStickerInSet", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetStickerEmojiList holds parameters for the setStickerEmojiList method.
|
||||||
|
// See https://core.telegram.org/bots/api#setstickeremojilist
|
||||||
|
type SetStickerEmojiList struct {
|
||||||
|
Sticker string `json:"sticker"`
|
||||||
|
EmojiList []string `json:"emoji_list"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetStickerEmojiList changes the list of emoji associated with a sticker.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setstickeremojilist
|
||||||
|
func (api *API) SetStickerEmojiList(params SetStickerEmojiList) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setStickerEmojiList", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetStickerEmojiListWithContext is the context-aware variant of SetStickerEmojiList.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setstickeremojilist
|
||||||
|
func (api *API) SetStickerEmojiListWithContext(ctx context.Context, params SetStickerEmojiList) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setStickerEmojiList", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetStickerKeywords holds parameters for the setStickerKeywords method.
|
||||||
|
// See https://core.telegram.org/bots/api#setstickerkeywords
|
||||||
|
type SetStickerKeywords struct {
|
||||||
|
Sticker string `json:"sticker"`
|
||||||
|
Keywords []string `json:"keywords"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetStickerKeywords changes the keywords of a sticker.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setstickerkeywords
|
||||||
|
func (api *API) SetStickerKeywords(params SetStickerKeywords) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setStickerKeywords", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetStickerKeywordsWithContext is the context-aware variant of SetStickerKeywords.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setstickerkeywords
|
||||||
|
func (api *API) SetStickerKeywordsWithContext(ctx context.Context, params SetStickerKeywords) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setStickerKeywords", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetStickerMaskPosition holds parameters for the setStickerMaskPosition method.
|
||||||
|
// See https://core.telegram.org/bots/api#setstickermaskposition
|
||||||
|
type SetStickerMaskPosition struct {
|
||||||
|
Sticker string `json:"sticker"`
|
||||||
|
MaskPosition *MaskPosition `json:"mask_position,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetStickerMaskPosition changes the mask position of a mask sticker.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setstickermaskposition
|
||||||
|
func (api *API) SetStickerMaskPosition(params SetStickerMaskPosition) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setStickerMaskPosition", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetStickerMaskPositionWithContext is the context-aware variant of SetStickerMaskPosition.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setstickermaskposition
|
||||||
|
func (api *API) SetStickerMaskPositionWithContext(ctx context.Context, params SetStickerMaskPosition) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setStickerMaskPosition", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetStickerSetTitle holds parameters for the setStickerSetTitle method.
|
||||||
|
// See https://core.telegram.org/bots/api#setstickersettitle
|
||||||
|
type SetStickerSetTitle struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Title string `json:"title"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetStickerSetTitle sets the title of a sticker set created by the bot.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setstickersettitle
|
||||||
|
func (api *API) SetStickerSetTitle(params SetStickerSetTitle) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setStickerSetTitle", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetStickerSetTitleWithContext is the context-aware variant of SetStickerSetTitle.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setstickersettitle
|
||||||
|
func (api *API) SetStickerSetTitleWithContext(ctx context.Context, params SetStickerSetTitle) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setStickerSetTitle", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetStickerSetThumbnail holds parameters for the setStickerSetThumbnail method.
|
||||||
|
// See https://core.telegram.org/bots/api#setstickersetthumbnail
|
||||||
|
type SetStickerSetThumbnail struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
Thumbnail string `json:"thumbnail"`
|
||||||
|
Format InputStickerFormat `json:"format"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetStickerSetThumbnail sets the thumbnail of a sticker set.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setstickersetthumbnail
|
||||||
|
func (api *API) SetStickerSetThumbnail(params SetStickerSetThumbnail) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setStickerSetThumbnail", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetStickerSetThumbnailWithContext is the context-aware variant of SetStickerSetThumbnail.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setstickersetthumbnail
|
||||||
|
func (api *API) SetStickerSetThumbnailWithContext(ctx context.Context, params SetStickerSetThumbnail) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setStickerSetThumbnail", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetCustomEmojiStickerSetThumbnail holds parameters for the setCustomEmojiStickerSetThumbnail method.
|
||||||
|
// See https://core.telegram.org/bots/api#setcustomemojistickersetthumbnail
|
||||||
|
type SetCustomEmojiStickerSetThumbnail struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
CustomEmojiID string `json:"custom_emoji_id,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetCustomEmojiStickerSetThumbnail sets the thumbnail of a custom emoji sticker set.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setcustomemojistickersetthumbnail
|
||||||
|
func (api *API) SetCustomEmojiStickerSetThumbnail(params SetCustomEmojiStickerSetThumbnail) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setCustomEmojiStickerSetThumbnail", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetCustomEmojiStickerSetThumbnailWithContext is the context-aware variant of SetCustomEmojiStickerSetThumbnail.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setcustomemojistickersetthumbnail
|
||||||
|
func (api *API) SetCustomEmojiStickerSetThumbnailWithContext(ctx context.Context, params SetCustomEmojiStickerSetThumbnail) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setCustomEmojiStickerSetThumbnail", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteStickerSet holds parameters for the deleteStickerSet method.
|
||||||
|
// See https://core.telegram.org/bots/api#deletestickerset
|
||||||
|
type DeleteStickerSet struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteStickerSet deletes a sticker set created by the bot.
|
||||||
|
// Returns True on success.
|
||||||
|
// See https://core.telegram.org/bots/api#deletestickerset
|
||||||
|
func (api *API) DeleteStickerSet(params DeleteStickerSet) (bool, error) {
|
||||||
|
req := NewRequest[bool]("deleteStickerSet", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteStickerSetWithContext is the context-aware variant of DeleteStickerSet.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#deletestickerset
|
||||||
|
func (api *API) DeleteStickerSetWithContext(ctx context.Context, params DeleteStickerSet) (bool, error) {
|
||||||
|
req := NewRequest[bool]("deleteStickerSet", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
@@ -0,0 +1,88 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
// MaskPositionPoint represents the part of the face where a mask should be placed.
|
||||||
|
type MaskPositionPoint string
|
||||||
|
|
||||||
|
const (
|
||||||
|
// MaskPositionForehead places the mask on the forehead.
|
||||||
|
MaskPositionForehead MaskPositionPoint = "forehead"
|
||||||
|
// MaskPositionEyes places the mask on the eyes.
|
||||||
|
MaskPositionEyes MaskPositionPoint = "eyes"
|
||||||
|
// MaskPositionMouth places the mask on the mouth.
|
||||||
|
MaskPositionMouth MaskPositionPoint = "mouth"
|
||||||
|
// MaskPositionChin places the mask on the chin.
|
||||||
|
MaskPositionChin MaskPositionPoint = "chin"
|
||||||
|
)
|
||||||
|
|
||||||
|
// MaskPosition describes the position on faces where a mask should be placed by default.
|
||||||
|
// See https://core.telegram.org/bots/api#maskposition
|
||||||
|
type MaskPosition struct {
|
||||||
|
Point MaskPositionPoint `json:"point"`
|
||||||
|
XShift float32 `json:"x_shift"`
|
||||||
|
YShift float32 `json:"y_shift"`
|
||||||
|
Scale float32 `json:"scale"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// StickerType represents the type of a sticker.
|
||||||
|
type StickerType string
|
||||||
|
|
||||||
|
const (
|
||||||
|
// StickerTypeRegular is a regular sticker.
|
||||||
|
StickerTypeRegular StickerType = "regular"
|
||||||
|
// StickerTypeMask is a mask sticker that can be placed on faces.
|
||||||
|
StickerTypeMask StickerType = "mask"
|
||||||
|
// StickerTypeCustomEmoji is a custom emoji sticker.
|
||||||
|
StickerTypeCustomEmoji StickerType = "custom_emoji"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Sticker represents a sticker.
|
||||||
|
// See https://core.telegram.org/bots/api#sticker
|
||||||
|
type Sticker struct {
|
||||||
|
FileID string `json:"file_id"`
|
||||||
|
FileUniqueID string `json:"file_unique_id"`
|
||||||
|
Type StickerType `json:"type"`
|
||||||
|
Width int `json:"width"`
|
||||||
|
Height int `json:"height"`
|
||||||
|
IsAnimated bool `json:"is_animated"`
|
||||||
|
IsVideo bool `json:"is_video"`
|
||||||
|
|
||||||
|
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||||
|
Emoji *string `json:"emoji,omitempty"`
|
||||||
|
SetName *string `json:"set_name,omitempty"`
|
||||||
|
MaskPosition *MaskPosition `json:"mask_position,omitempty"`
|
||||||
|
CustomEmojiID *string `json:"custom_emoji_id,omitempty"`
|
||||||
|
NeedRepainting *bool `json:"need_repainting,omitempty"`
|
||||||
|
FileSize *int64 `json:"file_size,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// StickerSet represents a sticker set.
|
||||||
|
// See https://core.telegram.org/bots/api#stickerset
|
||||||
|
type StickerSet struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Title string `json:"title"`
|
||||||
|
StickerType StickerType `json:"sticker_type"`
|
||||||
|
Stickers []Sticker `json:"stickers"`
|
||||||
|
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// InputStickerFormat represents the format of an input sticker.
|
||||||
|
type InputStickerFormat string
|
||||||
|
|
||||||
|
const (
|
||||||
|
// InputStickerFormatStatic is a static sticker (WEBP).
|
||||||
|
InputStickerFormatStatic InputStickerFormat = "static"
|
||||||
|
// InputStickerFormatAnimated is an animated sticker (TGS).
|
||||||
|
InputStickerFormatAnimated InputStickerFormat = "animated"
|
||||||
|
// InputStickerFormatVideo is a video sticker (WEBM).
|
||||||
|
InputStickerFormatVideo InputStickerFormat = "video"
|
||||||
|
)
|
||||||
|
|
||||||
|
// InputSticker describes a sticker to be added to a sticker set.
|
||||||
|
// See https://core.telegram.org/bots/api#inputsticker
|
||||||
|
type InputSticker struct {
|
||||||
|
Sticker string `json:"sticker"`
|
||||||
|
Format InputStickerFormat `json:"format"`
|
||||||
|
EmojiList []string `json:"emoji_list"`
|
||||||
|
MaskPosition *MaskPosition `json:"mask_position,omitempty"`
|
||||||
|
Keywords []string `json:"keywords,omitempty"`
|
||||||
|
}
|
||||||
+534
@@ -0,0 +1,534 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import "encoding/json"
|
||||||
|
|
||||||
|
// UpdateType represents the type of incoming update.
|
||||||
|
type UpdateType string
|
||||||
|
|
||||||
|
const (
|
||||||
|
// UpdateTypeUnknown marks an update whose payload does not match a known Telegram update kind.
|
||||||
|
UpdateTypeUnknown UpdateType = "unknown"
|
||||||
|
|
||||||
|
// UpdateTypeMessage is a regular message update.
|
||||||
|
UpdateTypeMessage UpdateType = "message"
|
||||||
|
// UpdateTypeEditedMessage is an edited message update.
|
||||||
|
UpdateTypeEditedMessage UpdateType = "edited_message"
|
||||||
|
// UpdateTypeChannelPost is a channel post update.
|
||||||
|
UpdateTypeChannelPost UpdateType = "channel_post"
|
||||||
|
// UpdateTypeEditedChannelPost is an edited channel post update.
|
||||||
|
UpdateTypeEditedChannelPost UpdateType = "edited_channel_post"
|
||||||
|
// UpdateTypeMessageReaction is a message reaction update.
|
||||||
|
UpdateTypeMessageReaction UpdateType = "message_reaction"
|
||||||
|
// UpdateTypeMessageReactionCount is a message reaction count update.
|
||||||
|
UpdateTypeMessageReactionCount UpdateType = "message_reaction_count"
|
||||||
|
|
||||||
|
// UpdateTypeBusinessConnection is a business connection update.
|
||||||
|
UpdateTypeBusinessConnection UpdateType = "business_connection"
|
||||||
|
// UpdateTypeBusinessMessage is a business message update.
|
||||||
|
UpdateTypeBusinessMessage UpdateType = "business_message"
|
||||||
|
// UpdateTypeEditedBusinessMessage is an edited business message update.
|
||||||
|
UpdateTypeEditedBusinessMessage UpdateType = "edited_business_message"
|
||||||
|
// UpdateTypeDeletedBusinessMessages is a deleted business messages update.
|
||||||
|
UpdateTypeDeletedBusinessMessages UpdateType = "deleted_business_messages"
|
||||||
|
|
||||||
|
// UpdateTypeInlineQuery is an inline query update.
|
||||||
|
UpdateTypeInlineQuery UpdateType = "inline_query"
|
||||||
|
// UpdateTypeChosenInlineResult is a chosen inline result update.
|
||||||
|
UpdateTypeChosenInlineResult UpdateType = "chosen_inline_result"
|
||||||
|
// UpdateTypeCallbackQuery is a callback query update.
|
||||||
|
UpdateTypeCallbackQuery UpdateType = "callback_query"
|
||||||
|
// UpdateTypeShippingQuery is a shipping query update.
|
||||||
|
UpdateTypeShippingQuery UpdateType = "shipping_query"
|
||||||
|
// UpdateTypePreCheckoutQuery is a pre-checkout query update.
|
||||||
|
UpdateTypePreCheckoutQuery UpdateType = "pre_checkout_query"
|
||||||
|
// UpdateTypePurchasedPaidMedia is a purchased paid media update.
|
||||||
|
UpdateTypePurchasedPaidMedia UpdateType = "purchased_paid_media"
|
||||||
|
// UpdateTypePoll is a poll update.
|
||||||
|
UpdateTypePoll UpdateType = "poll"
|
||||||
|
// UpdateTypePollAnswer is a poll answer update.
|
||||||
|
UpdateTypePollAnswer UpdateType = "poll_answer"
|
||||||
|
// UpdateTypeMyChatMember is a my chat member update.
|
||||||
|
UpdateTypeMyChatMember UpdateType = "my_chat_member"
|
||||||
|
// UpdateTypeChatMember is a chat member update.
|
||||||
|
UpdateTypeChatMember UpdateType = "chat_member"
|
||||||
|
// UpdateTypeChatJoinRequest is a chat join request update.
|
||||||
|
UpdateTypeChatJoinRequest UpdateType = "chat_join_request"
|
||||||
|
// UpdateTypeChatBoost is a chat boost update.
|
||||||
|
UpdateTypeChatBoost UpdateType = "chat_boost"
|
||||||
|
// UpdateTypeRemovedChatBoost is a removed chat boost update.
|
||||||
|
UpdateTypeRemovedChatBoost UpdateType = "removed_chat_boost"
|
||||||
|
|
||||||
|
UpdateTypeManagedBot UpdateType = "managed_bot"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Update represents an incoming update from Telegram.
|
||||||
|
// See https://core.telegram.org/bots/api#update
|
||||||
|
type Update struct {
|
||||||
|
Type UpdateType `json:"-"`
|
||||||
|
|
||||||
|
UpdateID int `json:"update_id"`
|
||||||
|
Message *Message `json:"message,omitempty"`
|
||||||
|
EditedMessage *Message `json:"edited_message,omitempty"`
|
||||||
|
ChannelPost *Message `json:"channel_post,omitempty"`
|
||||||
|
EditedChannelPost *Message `json:"edited_channel_post,omitempty"`
|
||||||
|
|
||||||
|
BusinessConnection *BusinessConnection `json:"business_connection,omitempty"`
|
||||||
|
BusinessMessage *Message `json:"business_message,omitempty"`
|
||||||
|
EditedBusinessMessage *Message `json:"edited_business_message,omitempty"`
|
||||||
|
DeletedBusinessMessages *BusinessMessagesDeleted `json:"deleted_business_messages,omitempty"`
|
||||||
|
MessageReaction *MessageReactionUpdated `json:"message_reaction,omitempty"`
|
||||||
|
MessageReactionCount *MessageReactionCountUpdated `json:"message_reaction_count,omitempty"`
|
||||||
|
|
||||||
|
InlineQuery *InlineQuery `json:"inline_query,omitempty"`
|
||||||
|
ChosenInlineResult *ChosenInlineResult `json:"chosen_inline_result,omitempty"`
|
||||||
|
CallbackQuery *CallbackQuery `json:"callback_query,omitempty"`
|
||||||
|
ShippingQuery *ShippingQuery `json:"shipping_query,omitempty"`
|
||||||
|
PreCheckoutQuery *PreCheckoutQuery `json:"pre_checkout_query,omitempty"`
|
||||||
|
PurchasedPaidMedia *PaidMediaPurchased `json:"purchased_paid_media,omitempty"`
|
||||||
|
|
||||||
|
Poll *Poll `json:"poll,omitempty"`
|
||||||
|
PollAnswer *PollAnswer `json:"poll_answer,omitempty"`
|
||||||
|
MyChatMember *ChatMemberUpdated `json:"my_chat_member,omitempty"`
|
||||||
|
ChatMember *ChatMemberUpdated `json:"chat_member,omitempty"`
|
||||||
|
ChatJoinRequest *ChatJoinRequest `json:"chat_join_request,omitempty"`
|
||||||
|
ChatBoost *ChatBoostUpdated `json:"chat_boost,omitempty"`
|
||||||
|
RemovedChatBoost *ChatBoostRemoved `json:"removed_chat_boost,omitempty"`
|
||||||
|
|
||||||
|
ManagedBot *ManagedBotUpdated `json:"managed_bot,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnmarshalJSON decodes an update and derives its Type from the populated payload field.
|
||||||
|
func (u *Update) UnmarshalJSON(data []byte) error {
|
||||||
|
type Alias Update
|
||||||
|
|
||||||
|
var aux Alias
|
||||||
|
if err := json.Unmarshal(data, &aux); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
*u = Update(aux)
|
||||||
|
|
||||||
|
switch {
|
||||||
|
case u.Message != nil:
|
||||||
|
u.Type = UpdateTypeMessage
|
||||||
|
case u.EditedMessage != nil:
|
||||||
|
u.Type = UpdateTypeEditedMessage
|
||||||
|
case u.ChannelPost != nil:
|
||||||
|
u.Type = UpdateTypeChannelPost
|
||||||
|
case u.EditedChannelPost != nil:
|
||||||
|
u.Type = UpdateTypeEditedChannelPost
|
||||||
|
|
||||||
|
case u.BusinessConnection != nil:
|
||||||
|
u.Type = UpdateTypeBusinessConnection
|
||||||
|
case u.BusinessMessage != nil:
|
||||||
|
u.Type = UpdateTypeBusinessMessage
|
||||||
|
case u.EditedBusinessMessage != nil:
|
||||||
|
u.Type = UpdateTypeEditedBusinessMessage
|
||||||
|
case u.DeletedBusinessMessages != nil:
|
||||||
|
u.Type = UpdateTypeDeletedBusinessMessages
|
||||||
|
case u.MessageReaction != nil:
|
||||||
|
u.Type = UpdateTypeMessageReaction
|
||||||
|
case u.MessageReactionCount != nil:
|
||||||
|
u.Type = UpdateTypeMessageReactionCount
|
||||||
|
|
||||||
|
case u.InlineQuery != nil:
|
||||||
|
u.Type = UpdateTypeInlineQuery
|
||||||
|
case u.ChosenInlineResult != nil:
|
||||||
|
u.Type = UpdateTypeChosenInlineResult
|
||||||
|
case u.CallbackQuery != nil:
|
||||||
|
u.Type = UpdateTypeCallbackQuery
|
||||||
|
case u.ShippingQuery != nil:
|
||||||
|
u.Type = UpdateTypeShippingQuery
|
||||||
|
case u.PreCheckoutQuery != nil:
|
||||||
|
u.Type = UpdateTypePreCheckoutQuery
|
||||||
|
case u.PurchasedPaidMedia != nil:
|
||||||
|
u.Type = UpdateTypePurchasedPaidMedia
|
||||||
|
|
||||||
|
case u.Poll != nil:
|
||||||
|
u.Type = UpdateTypePoll
|
||||||
|
case u.PollAnswer != nil:
|
||||||
|
u.Type = UpdateTypePollAnswer
|
||||||
|
case u.MyChatMember != nil:
|
||||||
|
u.Type = UpdateTypeMyChatMember
|
||||||
|
case u.ChatMember != nil:
|
||||||
|
u.Type = UpdateTypeChatMember
|
||||||
|
case u.ChatJoinRequest != nil:
|
||||||
|
u.Type = UpdateTypeChatJoinRequest
|
||||||
|
case u.ChatBoost != nil:
|
||||||
|
u.Type = UpdateTypeChatBoost
|
||||||
|
case u.RemovedChatBoost != nil:
|
||||||
|
u.Type = UpdateTypeRemovedChatBoost
|
||||||
|
case u.ManagedBot != nil:
|
||||||
|
u.Type = UpdateTypeManagedBot
|
||||||
|
default:
|
||||||
|
u.Type = UpdateTypeUnknown
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// WebhookInfo describes the current webhook status.
|
||||||
|
// See https://core.telegram.org/bots/api#webhookinfo
|
||||||
|
type WebhookInfo struct {
|
||||||
|
URL string `json:"url"`
|
||||||
|
HasCustomCertificate bool `json:"has_custom_certificate"`
|
||||||
|
PendingUpdateCount int `json:"pending_update_count"`
|
||||||
|
IPAddress string `json:"ip_address,omitempty"`
|
||||||
|
LastErrorDate int `json:"last_error_date,omitempty"`
|
||||||
|
LastErrorMessage string `json:"last_error_message,omitempty"`
|
||||||
|
LastSynchronizationErrorDate int `json:"last_synchronization_error_date,omitempty"`
|
||||||
|
MaxConnections int `json:"max_connections,omitempty"`
|
||||||
|
AllowedUpdates []string `json:"allowed_updates,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type ProximityAlertTriggered struct {
|
||||||
|
Traveler User `json:"traveler"`
|
||||||
|
Watcher User `json:"watcher"`
|
||||||
|
Distance int `json:"distance"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// InlineQuery represents an incoming inline query.
|
||||||
|
// See https://core.telegram.org/bots/api#inlinequery
|
||||||
|
type InlineQuery struct {
|
||||||
|
ID string `json:"id"`
|
||||||
|
From User `json:"from"`
|
||||||
|
Query string `json:"query"`
|
||||||
|
Offset string `json:"offset"`
|
||||||
|
ChatType *ChatType `json:"chat_type,omitempty"`
|
||||||
|
Location *Location `json:"location,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ChosenInlineResult represents a result of an inline query that was chosen by the user.
|
||||||
|
// See https://core.telegram.org/bots/api#choseninlineresult
|
||||||
|
type ChosenInlineResult struct {
|
||||||
|
ResultID string `json:"result_id"`
|
||||||
|
From User `json:"from"`
|
||||||
|
Location *Location `json:"location,omitempty"`
|
||||||
|
InlineMessageID string `json:"inline_message_id"`
|
||||||
|
Query string `json:"query"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// File represents a file ready to be downloaded.
|
||||||
|
// See https://core.telegram.org/bots/api#file
|
||||||
|
type File struct {
|
||||||
|
FileID string `json:"file_id"`
|
||||||
|
FileUniqueID string `json:"file_unique_id"`
|
||||||
|
FileSize int64 `json:"file_size,omitempty"`
|
||||||
|
FilePath string `json:"file_path,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ChatMemberUpdated represents changes in the status of a chat member.
|
||||||
|
// See https://core.telegram.org/bots/api#chatmemberupdated
|
||||||
|
type ChatMemberUpdated struct {
|
||||||
|
Chat Chat `json:"chat"`
|
||||||
|
From User `json:"from"`
|
||||||
|
Date int64 `json:"date"`
|
||||||
|
OldChatMember ChatMember `json:"old_chat_member"`
|
||||||
|
NewChatMember ChatMember `json:"new_chat_member"`
|
||||||
|
InviteLink *ChatInviteLink `json:"invite_link,omitempty"`
|
||||||
|
ViaJoinRequest *bool `json:"via_join_request,omitempty"`
|
||||||
|
ViaChatFolderInviteLink *bool `json:"via_chat_folder_invite_link,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ChatJoinRequest represents a join request sent to a chat.
|
||||||
|
// See https://core.telegram.org/bots/api#chatjoinrequest
|
||||||
|
type ChatJoinRequest struct {
|
||||||
|
Chat Chat `json:"chat"`
|
||||||
|
From User `json:"from"`
|
||||||
|
UserChatID int64 `json:"user_chat_id"`
|
||||||
|
Date int64 `json:"date"`
|
||||||
|
Bio *string `json:"bio,omitempty"`
|
||||||
|
InviteLink *ChatInviteLink `json:"invite_link,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Location represents a point on the map.
|
||||||
|
// See https://core.telegram.org/bots/api#location
|
||||||
|
type Location struct {
|
||||||
|
Latitude float64 `json:"latitude"`
|
||||||
|
Longitude float64 `json:"longitude"`
|
||||||
|
HorizontalAccuracy float64 `json:"horizontal_accuracy"`
|
||||||
|
LivePeriod int `json:"live_period"`
|
||||||
|
Heading int `json:"heading"`
|
||||||
|
ProximityAlertRadius int `json:"proximity_alert_radius"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// LocationAddress represents a human-readable address of a location.
|
||||||
|
type LocationAddress struct {
|
||||||
|
CountryCode string `json:"country_code"`
|
||||||
|
State *string `json:"state,omitempty"`
|
||||||
|
City *string `json:"city,omitempty"`
|
||||||
|
Street *string `json:"street,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Venue represents a venue.
|
||||||
|
// See https://core.telegram.org/bots/api#venue
|
||||||
|
type Venue struct {
|
||||||
|
Location Location `json:"location"`
|
||||||
|
Title string `json:"title"`
|
||||||
|
Address string `json:"address"`
|
||||||
|
FoursquareID string `json:"foursquare_id,omitempty"`
|
||||||
|
FoursquareType string `json:"foursquare_type,omitempty"`
|
||||||
|
GooglePlaceID string `json:"google_place_id,omitempty"`
|
||||||
|
GooglePlaceType string `json:"google_place_type,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// WebAppInfo contains information about a Web App.
|
||||||
|
// See https://core.telegram.org/bots/api#webappinfo
|
||||||
|
type WebAppInfo struct {
|
||||||
|
URL string `json:"url"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type WebAppData struct {
|
||||||
|
Data string `json:"data"`
|
||||||
|
ButtonText string `json:"button_text"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// StarAmount represents an amount of Telegram Stars.
|
||||||
|
type StarAmount struct {
|
||||||
|
Amount int `json:"amount"`
|
||||||
|
NanostarAmount int `json:"nanostar_amount"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// AcceptedGiftTypes represents the types of gifts accepted by a user or chat.
|
||||||
|
type AcceptedGiftTypes struct {
|
||||||
|
UnlimitedGifts bool `json:"unlimited_gifts"`
|
||||||
|
LimitedGifts bool `json:"limited_gifts"`
|
||||||
|
UniqueGifts bool `json:"unique_gifts"`
|
||||||
|
PremiumSubscription bool `json:"premium_subscription"`
|
||||||
|
GiftsFromChannels bool `json:"gifts_from_channels"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GiftBackground represents the background of a gift.
|
||||||
|
type GiftBackground struct {
|
||||||
|
CenterColor int `json:"center_color"`
|
||||||
|
EdgeColor int `json:"edge_color"`
|
||||||
|
TextColor int `json:"text_color"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Gift represents a gift that can be sent.
|
||||||
|
type Gift struct {
|
||||||
|
ID string `json:"id"`
|
||||||
|
Sticker Sticker `json:"sticker"`
|
||||||
|
StarCount int `json:"star_count"`
|
||||||
|
UpdateStarCount *int `json:"update_star_count,omitempty"`
|
||||||
|
IsPremium *bool `json:"is_premium,omitempty"`
|
||||||
|
HasColors *bool `json:"has_colors,omitempty"`
|
||||||
|
TotalCount *int `json:"total_count,omitempty"`
|
||||||
|
RemainingCount *int `json:"remaining_count,omitempty"`
|
||||||
|
PersonalTotalCount *int `json:"personal_total_count,omitempty"`
|
||||||
|
PersonalRemainingCount *int `json:"personal_remaining_count,omitempty"`
|
||||||
|
Background *GiftBackground `json:"background,omitempty"`
|
||||||
|
UniqueGiftVariantColor *int `json:"unique_gift_variant_color,omitempty"`
|
||||||
|
PublisherChat *Chat `json:"publisher_chat,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Gifts represents a list of gifts.
|
||||||
|
type Gifts struct {
|
||||||
|
Gifts []Gift `json:"gifts"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type UniqueGiftModel struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Sticker Sticker `json:"sticker"`
|
||||||
|
RarityPerMille int `json:"rarity_per_mille"`
|
||||||
|
Rarity string `json:"rarity,omitempty"`
|
||||||
|
}
|
||||||
|
type UniqueGiftSymbol struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Sticker Sticker `json:"sticker"`
|
||||||
|
RarityPerMille int `json:"rarity_per_mille"`
|
||||||
|
}
|
||||||
|
type UniqueGiftBackdropColors struct {
|
||||||
|
CenterColor int `json:"center_color"`
|
||||||
|
EdgeColor int `json:"edge_color"`
|
||||||
|
SymbolColor int `json:"symbol_color"`
|
||||||
|
TextColor int `json:"text_color"`
|
||||||
|
}
|
||||||
|
type UniqueGiftBackdrop struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Colors UniqueGiftBackdropColors `json:"colors"`
|
||||||
|
RarityPerMille int `json:"rarity_per_mille"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// UniqueGiftColors represents color information for a unique gift.
|
||||||
|
type UniqueGiftColors struct {
|
||||||
|
ModelCustomEmojiID string `json:"model_custom_emoji_id"`
|
||||||
|
SymbolCustomEmojiID string `json:"symbol_custom_emoji_id"`
|
||||||
|
LightThemeMainColor int `json:"light_theme_main_color"`
|
||||||
|
LightThemeOtherColors []int `json:"light_theme_other_colors"`
|
||||||
|
DarkThemeMainColor int `json:"dark_theme_main_color"`
|
||||||
|
DarkThemeOtherColors []int `json:"dark_theme_other_colors"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type UniqueGift struct {
|
||||||
|
GiftID string `json:"gift_id"`
|
||||||
|
BaseName string `json:"base_name"`
|
||||||
|
Name string `json:"name"`
|
||||||
|
Number int `json:"number"`
|
||||||
|
Model UniqueGiftModel `json:"model"`
|
||||||
|
Symbol UniqueGiftSymbol `json:"symbol"`
|
||||||
|
Backdrop UniqueGiftBackdrop `json:"backdrop"`
|
||||||
|
|
||||||
|
IsPremium bool `json:"is_premium,omitempty"`
|
||||||
|
IsBurned bool `json:"is_burned,omitempty"`
|
||||||
|
IsFromBlockchain bool `json:"is_from_blockchain,omitempty"`
|
||||||
|
Colors *UniqueGiftColors `json:"colors,omitempty"`
|
||||||
|
PublisherChat *Chat `json:"publisher_chat,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type GiftInfo struct {
|
||||||
|
Gift Gift `json:"gift"`
|
||||||
|
|
||||||
|
OwnedGiftID string `json:"owned_gift_id,omitempty"`
|
||||||
|
ConvertStarCount int `json:"convert_star_count,omitempty"`
|
||||||
|
PrepaidUpgradeStarCount int `json:"prepaid_upgrade_star_count,omitempty"`
|
||||||
|
IsUpgradeSeparate bool `json:"is_upgrade_separate,omitempty"`
|
||||||
|
CanBeUpgraded bool `json:"can_be_upgraded,omitempty"`
|
||||||
|
Text string `json:"text,omitempty"`
|
||||||
|
Entities []MessageEntity `json:"entities,omitempty"`
|
||||||
|
IsPrivate bool `json:"is_private,omitempty"`
|
||||||
|
UniqueGiftNumber int `json:"unique_gift_number,omitempty"`
|
||||||
|
}
|
||||||
|
type UniqueGiftInfo struct {
|
||||||
|
Gift UniqueGift `json:"gift"`
|
||||||
|
Origin string `json:"origin"`
|
||||||
|
LastResaleCurrency string `json:"last_resale_currency,omitempty"`
|
||||||
|
LastResaleAmount int `json:"last_resale_amount,omitempty"`
|
||||||
|
OwnedGiftID string `json:"owned_gift_id,omitempty"`
|
||||||
|
TransferStarCount int `json:"transfer_star_count,omitempty"`
|
||||||
|
NextTransferDate int `json:"next_transfer_date,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// OwnedGiftType represents the type of an owned gift.
|
||||||
|
type OwnedGiftType string
|
||||||
|
|
||||||
|
const (
|
||||||
|
// OwnedGiftRegularType identifies a regular owned gift.
|
||||||
|
OwnedGiftRegularType OwnedGiftType = "regular"
|
||||||
|
// OwnedGiftUniqueType identifies a unique owned gift.
|
||||||
|
OwnedGiftUniqueType OwnedGiftType = "unique"
|
||||||
|
)
|
||||||
|
|
||||||
|
// OwnedGift represents a gift owned by a user or chat.
|
||||||
|
type OwnedGift struct {
|
||||||
|
Type OwnedGiftType `json:"type"`
|
||||||
|
OwnedGiftID string `json:"ownen_gift_id,omitempty"`
|
||||||
|
SendDate int `json:"send_date,omitempty"`
|
||||||
|
IsSaved bool `json:"is_saved,omitempty"`
|
||||||
|
|
||||||
|
// Fields specific to "regular" type
|
||||||
|
Gift Gift `json:"gift"`
|
||||||
|
SenderUser *User `json:"sender_user,omitempty"`
|
||||||
|
Text string `json:"text,omitempty"`
|
||||||
|
Entities []MessageEntity `json:"entities,omitempty"`
|
||||||
|
IsPrivate bool `json:"is_private,omitempty"`
|
||||||
|
CanBeUpgraded bool `json:"can_be_upgraded,omitempty"`
|
||||||
|
WasRefunded bool `json:"was_refunded,omitempty"`
|
||||||
|
ConvertStarCount int `json:"convert_star_count,omitempty"`
|
||||||
|
PrepaidUpgradeStarCount int `json:"prepaid_upgrade_star_count,omitempty"`
|
||||||
|
IsUpgradeSeparate bool `json:"is_upgrade_separate,omitempty"`
|
||||||
|
UniqueGiftNumber int `json:"unique_gift_number,omitempty"`
|
||||||
|
|
||||||
|
// Fields specific to "unique" type
|
||||||
|
CanBeTransferred bool `json:"can_be_transferred,omitempty"`
|
||||||
|
TransferStarCount int `json:"transfer_star_count,omitempty"`
|
||||||
|
NextTransferDate int `json:"next_transfer_date,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// OwnedGifts represents a list of owned gifts with pagination.
|
||||||
|
type OwnedGifts struct {
|
||||||
|
TotalCount int `json:"total_count"`
|
||||||
|
Gifts []OwnedGift `json:"gifts"`
|
||||||
|
NextOffset string `json:"next_offset"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type GiveawayCreated struct {
|
||||||
|
PrizeStarCount int `json:"prize_star_count,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type Giveaway struct {
|
||||||
|
Chats []Chat `json:"chats"`
|
||||||
|
WinnersSelectionDate int `json:"winners_selection_date"`
|
||||||
|
WinnerCount int `json:"winner_count"`
|
||||||
|
|
||||||
|
OnlyNewMembers bool `json:"only_new_members,omitempty"`
|
||||||
|
HasPublicWinners bool `json:"has_public_winners,omitempty"`
|
||||||
|
PrizeDescription string `json:"prize_description,omitempty"`
|
||||||
|
CountryCodes []string `json:"country_codes,omitempty"`
|
||||||
|
PrizeStarCount int `json:"prize_star_count,omitempty"`
|
||||||
|
PremiumSubscriptionMonthCount int `json:"premium_subscription_month_count,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type GiveawayWinners struct {
|
||||||
|
Chat Chat `json:"chat"`
|
||||||
|
GiveawayMessageID int `json:"giveaway_message_id"`
|
||||||
|
WinnersSelectionDate int `json:"winners_selection_date"`
|
||||||
|
WinnerCount int `json:"winner_count"`
|
||||||
|
Winners []User `json:"winners"`
|
||||||
|
|
||||||
|
AdditionalChatCount int `json:"additional_chat_count,omitempty"`
|
||||||
|
PrizeStarCount int `json:"prize_star_count,omitempty"`
|
||||||
|
PremiumSubscriptionMonthCount int `json:"premium_subscription_month_count,omitempty"`
|
||||||
|
UnclaimedPrizeCount int `json:"unclaimed_prize_count,omitempty"`
|
||||||
|
OnlyNewMembers bool `json:"only_new_members,omitempty"`
|
||||||
|
WasRefunded bool `json:"was_refunded,omitempty"`
|
||||||
|
PrizeDescription string `json:"prize_description,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type GiveawayCompleted struct {
|
||||||
|
WinnerCount int `json:"winner_count"`
|
||||||
|
UnclaimedPrizeCount int `json:"unclaimed_prize_count,omitempty"`
|
||||||
|
GiveawayMessage *Message `json:"giveaway_message,omitempty"`
|
||||||
|
IsStarGiveaway bool `json:"is_star_giveaway,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type WriteAccessAllowed struct {
|
||||||
|
FromRequest bool `json:"from_request,omitempty"`
|
||||||
|
WebAppName string `json:"web_app_name,omitempty"`
|
||||||
|
FromAttachmentMenu bool `json:"from_attachment_menu,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type BackgroundFillType string
|
||||||
|
|
||||||
|
const (
|
||||||
|
BackgroundFillSolidType BackgroundFillType = "solid"
|
||||||
|
BackgroundFillGradientType BackgroundFillType = "gradient"
|
||||||
|
BackgroundFillFreeformGradientType BackgroundFillType = "freeform_gradient"
|
||||||
|
)
|
||||||
|
|
||||||
|
type BackgroundFill struct {
|
||||||
|
Type BackgroundFillType `json:"type"`
|
||||||
|
|
||||||
|
Color int `json:"color,omitempty"`
|
||||||
|
|
||||||
|
TopColor int `json:"top_color,omitempty"`
|
||||||
|
BottomColor int `json:"bottom_color,omitempty"`
|
||||||
|
RotationAngle int `json:"rotation_angle,omitempty"`
|
||||||
|
|
||||||
|
Colors []int `json:"colors,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type BackgroundTypeType string
|
||||||
|
|
||||||
|
const (
|
||||||
|
BackgroundTypeFillType BackgroundTypeType = "fill"
|
||||||
|
BackgroundTypeWallpaperType BackgroundTypeType = "wallpaper"
|
||||||
|
BackgroundTypePatternType BackgroundTypeType = "pattern"
|
||||||
|
BackgroundTypeChatThemeType BackgroundTypeType = "chat_theme"
|
||||||
|
)
|
||||||
|
|
||||||
|
type BackgroundType struct {
|
||||||
|
Type BackgroundTypeType `json:"type"`
|
||||||
|
|
||||||
|
Fill *BackgroundFill `json:"fill,omitempty"`
|
||||||
|
DarkThemeDimming int `json:"dark_theme_dimming,omitempty"`
|
||||||
|
|
||||||
|
Document *Document `json:"document,omitempty"`
|
||||||
|
IsBlurred bool `json:"is_blurred,omitempty"`
|
||||||
|
IsMoving bool `json:"is_moving,omitempty"`
|
||||||
|
|
||||||
|
Intensity int `json:"intensity,omitempty"`
|
||||||
|
IsInverted bool `json:"is_inverted,omitempty"`
|
||||||
|
|
||||||
|
ThemeName string `json:"theme_name,omitempty"`
|
||||||
|
}
|
||||||
@@ -0,0 +1,217 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestUpdateUnmarshalSetsType(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
body string
|
||||||
|
want UpdateType
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "deleted business messages",
|
||||||
|
body: `{
|
||||||
|
"update_id": 1,
|
||||||
|
"deleted_business_messages": {
|
||||||
|
"business_connection_id": "conn",
|
||||||
|
"chat": {"id": 42, "type": "private"},
|
||||||
|
"message_ids": [3, 5]
|
||||||
|
}
|
||||||
|
}`,
|
||||||
|
want: UpdateTypeDeletedBusinessMessages,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "callback query",
|
||||||
|
body: `{
|
||||||
|
"update_id": 2,
|
||||||
|
"callback_query": {
|
||||||
|
"id": "cb",
|
||||||
|
"from": {"id": 1, "is_bot": false, "first_name": "Test"},
|
||||||
|
"chat_instance": "instance",
|
||||||
|
"data": "payload"
|
||||||
|
}
|
||||||
|
}`,
|
||||||
|
want: UpdateTypeCallbackQuery,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "chat boost",
|
||||||
|
body: `{
|
||||||
|
"update_id": 3,
|
||||||
|
"chat_boost": {
|
||||||
|
"chat": {"id": -1001, "type": "supergroup", "title": "Boosted"},
|
||||||
|
"boost": {
|
||||||
|
"boost_id": "boost-1",
|
||||||
|
"add_date": 1735689600,
|
||||||
|
"expiration_date": 1738291600,
|
||||||
|
"source": {
|
||||||
|
"source": "premium",
|
||||||
|
"user": {"id": 1, "is_bot": false, "first_name": "Test"}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}`,
|
||||||
|
want: UpdateTypeChatBoost,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "unknown",
|
||||||
|
body: `{"update_id":4}`,
|
||||||
|
want: UpdateTypeUnknown,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "managed bot",
|
||||||
|
body: `{
|
||||||
|
"update_id": 5,
|
||||||
|
"managed_bot": {
|
||||||
|
"user": {"id": 11, "is_bot": false, "first_name": "Manager"},
|
||||||
|
"bot": {"id": 12, "is_bot": true, "first_name": "Worker"}
|
||||||
|
}
|
||||||
|
}`,
|
||||||
|
want: UpdateTypeManagedBot,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
var update Update
|
||||||
|
if err := json.Unmarshal([]byte(tt.body), &update); err != nil {
|
||||||
|
t.Fatalf("Unmarshal returned error: %v", err)
|
||||||
|
}
|
||||||
|
if update.Type != tt.want {
|
||||||
|
t.Fatalf("unexpected update type: got %q want %q", update.Type, tt.want)
|
||||||
|
}
|
||||||
|
if tt.want == UpdateTypeChatBoost && update.ChatBoost.Boost.BoostID != "boost-1" {
|
||||||
|
t.Fatalf("unexpected boost id: got %q want %q", update.ChatBoost.Boost.BoostID, "boost-1")
|
||||||
|
}
|
||||||
|
if tt.want == UpdateTypeManagedBot && update.ManagedBot.Bot.ID != 12 {
|
||||||
|
t.Fatalf("unexpected managed bot id: got %d want %d", update.ManagedBot.Bot.ID, 12)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPollUnmarshalSupportsBotAPI96Fields(t *testing.T) {
|
||||||
|
var poll Poll
|
||||||
|
|
||||||
|
body := `{
|
||||||
|
"id": "poll-1",
|
||||||
|
"question": "Pick winners",
|
||||||
|
"question_entities": [],
|
||||||
|
"options": [],
|
||||||
|
"total_voter_count": 2,
|
||||||
|
"is_closed": false,
|
||||||
|
"is_anonymous": false,
|
||||||
|
"type": "quiz",
|
||||||
|
"allows_multiple_answers": true,
|
||||||
|
"allows_revoting": true,
|
||||||
|
"correct_option_ids": [1, 3]
|
||||||
|
}`
|
||||||
|
|
||||||
|
if err := json.Unmarshal([]byte(body), &poll); err != nil {
|
||||||
|
t.Fatalf("Unmarshal returned error: %v", err)
|
||||||
|
}
|
||||||
|
if !poll.AllowsRevoting {
|
||||||
|
t.Fatal("expected allows_revoting to be decoded")
|
||||||
|
}
|
||||||
|
if len(poll.CorrectOptionIDs) != 2 || poll.CorrectOptionIDs[0] != 1 || poll.CorrectOptionIDs[1] != 3 {
|
||||||
|
t.Fatalf("unexpected correct option ids: %#v", poll.CorrectOptionIDs)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUpdateMarshalOmitsSyntheticTypeField(t *testing.T) {
|
||||||
|
update := Update{
|
||||||
|
UpdateID: 1,
|
||||||
|
Type: UpdateTypeCallbackQuery,
|
||||||
|
CallbackQuery: &CallbackQuery{
|
||||||
|
ID: "cb",
|
||||||
|
From: User{ID: 1, FirstName: "Test"},
|
||||||
|
ChatInstance: "instance",
|
||||||
|
Data: "payload",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
data, err := json.Marshal(update)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Marshal returned error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
got := string(data)
|
||||||
|
if strings.Contains(got, `"type"`) {
|
||||||
|
t.Fatalf("unexpected synthetic type field, got %s", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUpdateShippingQueryIsNilWhenAbsent(t *testing.T) {
|
||||||
|
var update Update
|
||||||
|
if err := json.Unmarshal([]byte(`{"update_id":1}`), &update); err != nil {
|
||||||
|
t.Fatalf("Unmarshal returned error: %v", err)
|
||||||
|
}
|
||||||
|
if update.ShippingQuery != nil {
|
||||||
|
t.Fatalf("expected ShippingQuery to be nil, got %+v", update.ShippingQuery)
|
||||||
|
}
|
||||||
|
if update.Type != UpdateTypeUnknown {
|
||||||
|
t.Fatalf("expected UpdateTypeUnknown, got %q", update.Type)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMaybeInaccessibleMessageUnmarshalAccessibleMessage(t *testing.T) {
|
||||||
|
var wrapper MaybeInaccessibleMessage
|
||||||
|
|
||||||
|
body := `{
|
||||||
|
"message_id": 10,
|
||||||
|
"date": 1700000000,
|
||||||
|
"chat": {"id": 42, "type": "private"},
|
||||||
|
"text": "hello"
|
||||||
|
}`
|
||||||
|
|
||||||
|
if err := json.Unmarshal([]byte(body), &wrapper); err != nil {
|
||||||
|
t.Fatalf("Unmarshal returned error: %v", err)
|
||||||
|
}
|
||||||
|
if !wrapper.IsAccessible() {
|
||||||
|
t.Fatal("expected accessible message payload")
|
||||||
|
}
|
||||||
|
if wrapper.IsInaccessible() {
|
||||||
|
t.Fatal("expected inaccessible payload to be empty")
|
||||||
|
}
|
||||||
|
if wrapper.Message() == nil || wrapper.Message().Text != "hello" {
|
||||||
|
t.Fatalf("unexpected accessible payload: %#v", wrapper.Message())
|
||||||
|
}
|
||||||
|
if wrapper.MessageID() != 10 {
|
||||||
|
t.Fatalf("unexpected message id: got %d want %d", wrapper.MessageID(), 10)
|
||||||
|
}
|
||||||
|
if wrapper.Chat() == nil || wrapper.Chat().ID != 42 {
|
||||||
|
t.Fatalf("unexpected chat payload: %#v", wrapper.Chat())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMaybeInaccessibleMessageUnmarshalInaccessibleMessage(t *testing.T) {
|
||||||
|
var wrapper MaybeInaccessibleMessage
|
||||||
|
|
||||||
|
body := `{
|
||||||
|
"message_id": 7,
|
||||||
|
"date": 0,
|
||||||
|
"chat": {"id": -1001, "type": "supergroup"}
|
||||||
|
}`
|
||||||
|
|
||||||
|
if err := json.Unmarshal([]byte(body), &wrapper); err != nil {
|
||||||
|
t.Fatalf("Unmarshal returned error: %v", err)
|
||||||
|
}
|
||||||
|
if wrapper.IsAccessible() {
|
||||||
|
t.Fatal("expected accessible payload to be empty")
|
||||||
|
}
|
||||||
|
if !wrapper.IsInaccessible() {
|
||||||
|
t.Fatal("expected inaccessible message payload")
|
||||||
|
}
|
||||||
|
if wrapper.InaccessibleMessage() == nil || wrapper.InaccessibleMessage().MessageID != 7 {
|
||||||
|
t.Fatalf("unexpected inaccessible payload: %#v", wrapper.InaccessibleMessage())
|
||||||
|
}
|
||||||
|
if wrapper.MessageID() != 7 {
|
||||||
|
t.Fatalf("unexpected message id: got %d want %d", wrapper.MessageID(), 7)
|
||||||
|
}
|
||||||
|
if wrapper.Chat() == nil || wrapper.Chat().ID != -1001 {
|
||||||
|
t.Fatalf("unexpected chat payload: %#v", wrapper.Chat())
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,267 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"mime/multipart"
|
||||||
|
"net/http"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||||
|
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// UploaderPhotoType is the multipart field name for photo uploads.
|
||||||
|
UploaderPhotoType UploaderFileType = "photo"
|
||||||
|
// UploaderVideoType is the multipart field name for video uploads.
|
||||||
|
UploaderVideoType UploaderFileType = "video"
|
||||||
|
// UploaderAudioType is the multipart field name for audio uploads.
|
||||||
|
UploaderAudioType UploaderFileType = "audio"
|
||||||
|
// UploaderDocumentType is the multipart field name for document uploads.
|
||||||
|
UploaderDocumentType UploaderFileType = "document"
|
||||||
|
// UploaderVoiceType is the multipart field name for voice uploads.
|
||||||
|
UploaderVoiceType UploaderFileType = "voice"
|
||||||
|
// UploaderVideoNoteType is the multipart field name for video-note uploads.
|
||||||
|
UploaderVideoNoteType UploaderFileType = "video_note"
|
||||||
|
// UploaderThumbnailType is the multipart field name for thumbnail uploads.
|
||||||
|
UploaderThumbnailType UploaderFileType = "thumbnail"
|
||||||
|
// UploaderStickerType is the multipart field name for sticker uploads.
|
||||||
|
UploaderStickerType UploaderFileType = "sticker"
|
||||||
|
// UploaderCertificateType is the multipart field name for webhook certificate uploads.
|
||||||
|
UploaderCertificateType UploaderFileType = "certificate"
|
||||||
|
)
|
||||||
|
|
||||||
|
// UploaderFileType represents the Telegram form field name for a file upload.
|
||||||
|
type UploaderFileType string
|
||||||
|
|
||||||
|
// UploaderFile holds the data and metadata for a single file to be uploaded.
|
||||||
|
type UploaderFile struct {
|
||||||
|
filename string
|
||||||
|
data []byte
|
||||||
|
field UploaderFileType
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewUploaderFile creates a new UploaderFile, auto-detecting the field type from the file extension.
|
||||||
|
// If detection is incorrect, use SetType to override.
|
||||||
|
func NewUploaderFile(name string, data []byte) UploaderFile {
|
||||||
|
t := uploaderTypeByExt(name)
|
||||||
|
return UploaderFile{filename: name, data: data, field: t}
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetType overrides the auto-detected upload field type.
|
||||||
|
// For example, use it when a voice file is detected as audio.
|
||||||
|
func (f UploaderFile) SetType(t UploaderFileType) UploaderFile {
|
||||||
|
f.field = t
|
||||||
|
return f
|
||||||
|
}
|
||||||
|
|
||||||
|
// Uploader is a Telegram Bot API client specialized for multipart file uploads.
|
||||||
|
//
|
||||||
|
// Use Uploader methods when you need to upload binary files directly
|
||||||
|
// (InputFile/multipart). For JSON-only calls (file_id, URL, plain params), use API.
|
||||||
|
type Uploader struct {
|
||||||
|
api *API
|
||||||
|
logger *sneklog.Logger
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewUploader creates a multipart uploader bound to an API client.
|
||||||
|
func NewUploader(api *API) *Uploader {
|
||||||
|
if api == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
logger := utils.CreateLogger(
|
||||||
|
"UPLOADER", utils.GetLoggerLevel(),
|
||||||
|
api.logFormat, api.logFormatter,
|
||||||
|
)
|
||||||
|
return &Uploader{api, logger}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Close flushes and closes uploader logger resources.
|
||||||
|
// See https://core.telegram.org/bots/api
|
||||||
|
func (u *Uploader) Close() error { return u.logger.Close() }
|
||||||
|
|
||||||
|
// GetLogger returns uploader logger instance.
|
||||||
|
// See https://core.telegram.org/bots/api
|
||||||
|
func (u *Uploader) GetLogger() *sneklog.Logger { return u.logger }
|
||||||
|
|
||||||
|
// UploaderRequest is a low-level multipart upload request wrapper.
|
||||||
|
//
|
||||||
|
// Prefer method-specific helpers such as SendPhoto or SetWebhook. UploaderRequest
|
||||||
|
// is intended for advanced use cases where callers manage the method name, files,
|
||||||
|
// and request/response types themselves. In that sense it is an unsafe escape
|
||||||
|
// hatch compared with the typed uploader API.
|
||||||
|
type UploaderRequest[R, P any] struct {
|
||||||
|
method string
|
||||||
|
files []UploaderFile
|
||||||
|
params P
|
||||||
|
chatID int64
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewUploaderRequest creates a low-level multipart upload request with no associated chat ID.
|
||||||
|
func NewUploaderRequest[R, P any](method string, params P, files ...UploaderFile) UploaderRequest[R, P] {
|
||||||
|
return UploaderRequest[R, P]{method: method, files: files, params: params, chatID: 0}
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewUploaderRequestWithChatID creates a low-level multipart upload request with an associated chat ID.
|
||||||
|
// The chat ID is used for per-chat rate limiting.
|
||||||
|
func NewUploaderRequestWithChatID[R, P any](method string, params P, chatID int64, files ...UploaderFile) UploaderRequest[R, P] {
|
||||||
|
return UploaderRequest[R, P]{method: method, files: files, params: params, chatID: chatID}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r UploaderRequest[R, P]) doRequest(ctx context.Context, up *Uploader) (R, error) {
|
||||||
|
var zero R
|
||||||
|
|
||||||
|
methodPrefix := ""
|
||||||
|
if up.api.useTestServer {
|
||||||
|
methodPrefix = "/test"
|
||||||
|
}
|
||||||
|
url := fmt.Sprintf("%s/bot%s%s/%s", up.api.apiURL, up.api.token, methodPrefix, r.method)
|
||||||
|
|
||||||
|
for {
|
||||||
|
if up.api.Limiter != nil {
|
||||||
|
if err := up.api.Limiter.Check(ctx, up.api.dropOverflowLimit, r.chatID); err != nil {
|
||||||
|
return zero, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
buf, contentType, err := prepareMultipart(r.files, r.params)
|
||||||
|
if err != nil {
|
||||||
|
return zero, err
|
||||||
|
}
|
||||||
|
req, err := http.NewRequestWithContext(ctx, "POST", url, buf)
|
||||||
|
if err != nil {
|
||||||
|
return zero, err
|
||||||
|
}
|
||||||
|
req.Header.Set("Content-Type", contentType)
|
||||||
|
req.Header.Set("Accept", "application/json")
|
||||||
|
req.Header.Set("User-Agent", fmt.Sprintf("Laniakea/%s", utils.VersionString))
|
||||||
|
req.ContentLength = int64(buf.Len())
|
||||||
|
|
||||||
|
up.logger.Debugln("UPLOADER REQ", r.method)
|
||||||
|
resp, err := up.api.client.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return zero, err
|
||||||
|
}
|
||||||
|
|
||||||
|
body, err := readBody(resp.Body)
|
||||||
|
_ = resp.Body.Close()
|
||||||
|
if err != nil {
|
||||||
|
return zero, err
|
||||||
|
}
|
||||||
|
up.logger.Debugln("UPLOADER RES", r.method, string(body))
|
||||||
|
|
||||||
|
response, err := parseBody[R](body)
|
||||||
|
if err != nil {
|
||||||
|
return zero, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if !response.Ok {
|
||||||
|
if response.ErrorCode == 429 && response.Parameters != nil && response.Parameters.RetryAfter != nil {
|
||||||
|
after := *response.Parameters.RetryAfter
|
||||||
|
up.logger.Warnf("Rate limited, retry after %d seconds (chat: %d)", after, r.chatID)
|
||||||
|
if up.api.Limiter != nil {
|
||||||
|
if r.chatID > 0 {
|
||||||
|
up.api.Limiter.SetChatLock(r.chatID, after)
|
||||||
|
} else {
|
||||||
|
up.api.Limiter.SetGlobalLock(after)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return zero, ctx.Err()
|
||||||
|
case <-time.After(time.Duration(after) * time.Second):
|
||||||
|
continue // Повторяем запрос
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return zero, fmt.Errorf("[%d] %s", response.ErrorCode, response.Description)
|
||||||
|
}
|
||||||
|
return response.Result, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// DoWithContext executes the upload request asynchronously via the worker pool.
|
||||||
|
// Returns the result or error. Respects context cancellation.
|
||||||
|
func (r UploaderRequest[R, P]) DoWithContext(ctx context.Context, up *Uploader) (R, error) {
|
||||||
|
var zero R
|
||||||
|
|
||||||
|
result, err := up.api.pool.submit(ctx, func(ctx context.Context) (any, error) {
|
||||||
|
return r.doRequest(ctx, up)
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return zero, err
|
||||||
|
}
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return zero, ctx.Err()
|
||||||
|
case res := <-result:
|
||||||
|
if res.err != nil {
|
||||||
|
return zero, res.err
|
||||||
|
}
|
||||||
|
if val, ok := res.value.(R); ok {
|
||||||
|
return val, nil
|
||||||
|
}
|
||||||
|
return zero, ErrPoolUnexpected
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Do executes the upload request synchronously with a background context.
|
||||||
|
// Use only for simple, non-critical uploads.
|
||||||
|
func (r UploaderRequest[R, P]) Do(up *Uploader) (R, error) {
|
||||||
|
return r.DoWithContext(context.Background(), up)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Internal helper that builds a finalized multipart body from files and params.
|
||||||
|
func prepareMultipart[P any](files []UploaderFile, params P) (*bytes.Buffer, string, error) {
|
||||||
|
buf := bytes.NewBuffer(nil)
|
||||||
|
w := multipart.NewWriter(buf)
|
||||||
|
|
||||||
|
for _, file := range files {
|
||||||
|
fw, err := w.CreateFormFile(string(file.field), file.filename)
|
||||||
|
if err != nil {
|
||||||
|
_ = w.Close() // Закрываем, чтобы не было утечки
|
||||||
|
return nil, "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err = fw.Write(file.data)
|
||||||
|
if err != nil {
|
||||||
|
_ = w.Close()
|
||||||
|
return nil, "", err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
err := utils.Encode(w, params) // Предполагается, что это записывает в w
|
||||||
|
if err != nil {
|
||||||
|
_ = w.Close()
|
||||||
|
return nil, "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
err = w.Close() // ✅ ОБЯЗАТЕЛЬНО вызвать в конце — иначе запрос битый!
|
||||||
|
if err != nil {
|
||||||
|
return nil, "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
return buf, w.FormDataContentType(), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Internal helper that infers an upload field name from a file extension.
|
||||||
|
func uploaderTypeByExt(filename string) UploaderFileType {
|
||||||
|
ext := strings.ToLower(filepath.Ext(filename))
|
||||||
|
switch ext {
|
||||||
|
case ".jpg", ".jpeg", ".png", ".webp", ".bmp":
|
||||||
|
return UploaderPhotoType
|
||||||
|
case ".mp4":
|
||||||
|
return UploaderVideoType
|
||||||
|
case ".mp3", ".m4a":
|
||||||
|
return UploaderAudioType
|
||||||
|
case ".ogg":
|
||||||
|
return UploaderVoiceType
|
||||||
|
default:
|
||||||
|
return UploaderDocumentType
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,159 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"mime"
|
||||||
|
"mime/multipart"
|
||||||
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestUploaderEncodesJSONFieldsAndLeavesAcceptEncodingToHTTPTransport(t *testing.T) {
|
||||||
|
var (
|
||||||
|
gotPath string
|
||||||
|
gotAcceptEncoding string
|
||||||
|
gotFields map[string]string
|
||||||
|
gotFileName string
|
||||||
|
gotFileData []byte
|
||||||
|
roundTripErr error
|
||||||
|
)
|
||||||
|
|
||||||
|
client := &http.Client{
|
||||||
|
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||||
|
gotPath = req.URL.Path
|
||||||
|
gotAcceptEncoding = req.Header.Get("Accept-Encoding")
|
||||||
|
|
||||||
|
gotFields, gotFileName, gotFileData, roundTripErr = readMultipartRequest(req)
|
||||||
|
if roundTripErr != nil {
|
||||||
|
roundTripErr = fmt.Errorf("readMultipartRequest: %w", roundTripErr)
|
||||||
|
}
|
||||||
|
|
||||||
|
return &http.Response{
|
||||||
|
StatusCode: http.StatusOK,
|
||||||
|
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||||
|
Body: io.NopCloser(strings.NewReader(`{"ok":true,"result":{"message_id":5,"date":1}}`)),
|
||||||
|
}, nil
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
|
||||||
|
api := NewAPI(
|
||||||
|
NewAPIOpts("token").
|
||||||
|
SetAPIURL("https://example.test").
|
||||||
|
SetHTTPClient(client),
|
||||||
|
)
|
||||||
|
defer func() {
|
||||||
|
if err := api.Close(); err != nil {
|
||||||
|
t.Fatalf("Close returned error: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
uploader := NewUploader(api)
|
||||||
|
defer func() {
|
||||||
|
if err := uploader.Close(); err != nil {
|
||||||
|
t.Fatalf("Close returned error: %v", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
msg, err := uploader.SendPhoto(
|
||||||
|
UploadPhoto{
|
||||||
|
ChatID: 42,
|
||||||
|
CaptionEntities: []MessageEntity{{
|
||||||
|
Type: MessageEntityBold,
|
||||||
|
Offset: 0,
|
||||||
|
Length: 4,
|
||||||
|
}},
|
||||||
|
ReplyMarkup: &ReplyMarkup{
|
||||||
|
InlineKeyboard: [][]InlineKeyboardButton{{
|
||||||
|
{Text: "A", CallbackData: "b"},
|
||||||
|
}},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
NewUploaderFile("photo.jpg", []byte("img")),
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("SendPhoto returned error: %v", err)
|
||||||
|
}
|
||||||
|
if msg.MessageID != 5 {
|
||||||
|
t.Fatalf("unexpected message id: %d", msg.MessageID)
|
||||||
|
}
|
||||||
|
if roundTripErr != nil {
|
||||||
|
t.Fatalf("multipart parse failed: %v", roundTripErr)
|
||||||
|
}
|
||||||
|
if gotPath != "/bottoken/sendPhoto" {
|
||||||
|
t.Fatalf("unexpected request path: %s", gotPath)
|
||||||
|
}
|
||||||
|
if gotAcceptEncoding != "" {
|
||||||
|
t.Fatalf("expected empty Accept-Encoding header, got %q", gotAcceptEncoding)
|
||||||
|
}
|
||||||
|
if got := gotFields["chat_id"]; got != "42" {
|
||||||
|
t.Fatalf("chat_id mismatch: %q", got)
|
||||||
|
}
|
||||||
|
if got := gotFields["caption_entities"]; got != `[{"type":"bold","offset":0,"length":4}]` {
|
||||||
|
t.Fatalf("caption_entities mismatch: %q", got)
|
||||||
|
}
|
||||||
|
if got := gotFields["reply_markup"]; got != `{"inline_keyboard":[[{"text":"A","callback_data":"b"}]]}` {
|
||||||
|
t.Fatalf("reply_markup mismatch: %q", got)
|
||||||
|
}
|
||||||
|
if gotFileName != "photo.jpg" {
|
||||||
|
t.Fatalf("unexpected file name: %q", gotFileName)
|
||||||
|
}
|
||||||
|
if string(gotFileData) != "img" {
|
||||||
|
t.Fatalf("unexpected file content: %q", string(gotFileData))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewUploaderFileDetectsFileTypeCaseInsensitively(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
filename string
|
||||||
|
want UploaderFileType
|
||||||
|
}{
|
||||||
|
{name: "uppercase photo", filename: "PHOTO.JPG", want: UploaderPhotoType},
|
||||||
|
{name: "uppercase voice", filename: "voice.OGG", want: UploaderVoiceType},
|
||||||
|
{name: "unknown defaults to document", filename: "archive.BIN", want: UploaderDocumentType},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
file := NewUploaderFile(tt.filename, []byte("x"))
|
||||||
|
if file.field != tt.want {
|
||||||
|
t.Fatalf("unexpected uploader field: got %q want %q", file.field, tt.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func readMultipartRequest(req *http.Request) (map[string]string, string, []byte, error) {
|
||||||
|
_, params, err := mime.ParseMediaType(req.Header.Get("Content-Type"))
|
||||||
|
if err != nil {
|
||||||
|
return nil, "", nil, err
|
||||||
|
}
|
||||||
|
reader := multipart.NewReader(req.Body, params["boundary"])
|
||||||
|
|
||||||
|
fields := make(map[string]string)
|
||||||
|
var fileName string
|
||||||
|
var fileData []byte
|
||||||
|
for {
|
||||||
|
part, err := reader.NextPart()
|
||||||
|
if err == io.EOF {
|
||||||
|
return fields, fileName, fileData, nil
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return nil, "", nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
data, err := io.ReadAll(part)
|
||||||
|
if err != nil {
|
||||||
|
return nil, "", nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if part.FileName() != "" {
|
||||||
|
fileName = part.FileName()
|
||||||
|
fileData = data
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
fields[part.FormName()] = string(data)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,356 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import "context"
|
||||||
|
|
||||||
|
// UploadPhoto holds parameters for uploading a photo using the Uploader.
|
||||||
|
// See https://core.telegram.org/bots/api#sendphoto
|
||||||
|
type UploadPhoto struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
Caption string `json:"caption,omitempty"`
|
||||||
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
|
||||||
|
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||||
|
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendPhoto uploads a photo via multipart and sends it as a message.
|
||||||
|
// file is the photo file to upload.
|
||||||
|
// See https://core.telegram.org/bots/api#sendphoto
|
||||||
|
func (u *Uploader) SendPhoto(params UploadPhoto, file UploaderFile) (Message, error) {
|
||||||
|
req := NewUploaderRequestWithChatID[Message]("sendPhoto", params, params.ChatID, file)
|
||||||
|
return req.Do(u)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendPhotoWithContext is the context-aware variant of SendPhoto.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// SendPhotoWithContext is the context-aware variant of SendPhoto.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#sendphoto
|
||||||
|
func (u *Uploader) SendPhotoWithContext(ctx context.Context, params UploadPhoto, file UploaderFile) (Message, error) {
|
||||||
|
req := NewUploaderRequestWithChatID[Message]("sendPhoto", params, params.ChatID, file)
|
||||||
|
return req.DoWithContext(ctx, u)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UploadAudio holds parameters for uploading an audio file using the Uploader.
|
||||||
|
// See https://core.telegram.org/bots/api#sendaudio
|
||||||
|
type UploadAudio struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
Caption string `json:"caption,omitempty"`
|
||||||
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
|
||||||
|
Duration int `json:"duration,omitempty"`
|
||||||
|
Performer string `json:"performer,omitempty"`
|
||||||
|
Title string `json:"title,omitempty"`
|
||||||
|
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendAudio uploads an audio file via multipart and sends it as a message.
|
||||||
|
// files are the audio file(s) to upload (typically one file).
|
||||||
|
// See https://core.telegram.org/bots/api#sendaudio
|
||||||
|
func (u *Uploader) SendAudio(params UploadAudio, files ...UploaderFile) (Message, error) {
|
||||||
|
req := NewUploaderRequestWithChatID[Message]("sendAudio", params, params.ChatID, files...)
|
||||||
|
return req.Do(u)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendAudioWithContext is the context-aware variant of SendAudio.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// SendAudioWithContext is the context-aware variant of SendAudio.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#sendaudio
|
||||||
|
func (u *Uploader) SendAudioWithContext(ctx context.Context, params UploadAudio, files ...UploaderFile) (Message, error) {
|
||||||
|
req := NewUploaderRequestWithChatID[Message]("sendAudio", params, params.ChatID, files...)
|
||||||
|
return req.DoWithContext(ctx, u)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UploadDocument holds parameters for uploading a document using the Uploader.
|
||||||
|
// See https://core.telegram.org/bots/api#senddocument
|
||||||
|
type UploadDocument struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
Caption string `json:"caption,omitempty"`
|
||||||
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
|
||||||
|
DisableContentTypeDetection bool `json:"disable_content_type_detection,omitempty"`
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendDocument uploads a document via multipart and sends it as a message.
|
||||||
|
// files are the document file(s) to upload (typically one file).
|
||||||
|
// See https://core.telegram.org/bots/api#senddocument
|
||||||
|
func (u *Uploader) SendDocument(params UploadDocument, files ...UploaderFile) (Message, error) {
|
||||||
|
req := NewUploaderRequestWithChatID[Message]("sendDocument", params, params.ChatID, files...)
|
||||||
|
return req.Do(u)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendDocumentWithContext is the context-aware variant of SendDocument.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// SendDocumentWithContext is the context-aware variant of SendDocument.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#senddocument
|
||||||
|
func (u *Uploader) SendDocumentWithContext(ctx context.Context, params UploadDocument, files ...UploaderFile) (Message, error) {
|
||||||
|
req := NewUploaderRequestWithChatID[Message]("sendDocument", params, params.ChatID, files...)
|
||||||
|
return req.DoWithContext(ctx, u)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UploadVideo holds parameters for uploading a video using the Uploader.
|
||||||
|
// See https://core.telegram.org/bots/api#sendvideo
|
||||||
|
type UploadVideo struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
Duration int `json:"duration,omitempty"`
|
||||||
|
Width int `json:"width,omitempty"`
|
||||||
|
Height int `json:"height,omitempty"`
|
||||||
|
|
||||||
|
StartTimestamp int64 `json:"start_timestamp,omitempty"`
|
||||||
|
Caption string `json:"caption,omitempty"`
|
||||||
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
|
||||||
|
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||||
|
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||||
|
SupportsStreaming bool `json:"supports_streaming,omitempty"`
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendVideo uploads a video via multipart and sends it as a message.
|
||||||
|
// files are the video file(s) to upload (typically one file).
|
||||||
|
// See https://core.telegram.org/bots/api#sendvideo
|
||||||
|
func (u *Uploader) SendVideo(params UploadVideo, files ...UploaderFile) (Message, error) {
|
||||||
|
req := NewUploaderRequestWithChatID[Message]("sendVideo", params, params.ChatID, files...)
|
||||||
|
return req.Do(u)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendVideoWithContext is the context-aware variant of SendVideo.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// SendVideoWithContext is the context-aware variant of SendVideo.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#sendvideo
|
||||||
|
func (u *Uploader) SendVideoWithContext(ctx context.Context, params UploadVideo, files ...UploaderFile) (Message, error) {
|
||||||
|
req := NewUploaderRequestWithChatID[Message]("sendVideo", params, params.ChatID, files...)
|
||||||
|
return req.DoWithContext(ctx, u)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UploadAnimation holds parameters for uploading an animation using the Uploader.
|
||||||
|
// See https://core.telegram.org/bots/api#sendanimation
|
||||||
|
type UploadAnimation struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
Duration int `json:"duration,omitempty"`
|
||||||
|
Width int `json:"width,omitempty"`
|
||||||
|
Height int `json:"height,omitempty"`
|
||||||
|
|
||||||
|
Caption string `json:"caption,omitempty"`
|
||||||
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
|
||||||
|
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||||
|
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendAnimation uploads an animation via multipart and sends it as a message.
|
||||||
|
// files are the animation file(s) to upload (typically one file).
|
||||||
|
// See https://core.telegram.org/bots/api#sendanimation
|
||||||
|
func (u *Uploader) SendAnimation(params UploadAnimation, files ...UploaderFile) (Message, error) {
|
||||||
|
req := NewUploaderRequestWithChatID[Message]("sendAnimation", params, params.ChatID, files...)
|
||||||
|
return req.Do(u)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendAnimationWithContext is the context-aware variant of SendAnimation.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// SendAnimationWithContext is the context-aware variant of SendAnimation.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#sendanimation
|
||||||
|
func (u *Uploader) SendAnimationWithContext(ctx context.Context, params UploadAnimation, files ...UploaderFile) (Message, error) {
|
||||||
|
req := NewUploaderRequestWithChatID[Message]("sendAnimation", params, params.ChatID, files...)
|
||||||
|
return req.DoWithContext(ctx, u)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UploadVoice holds parameters for uploading a voice note using the Uploader.
|
||||||
|
// See https://core.telegram.org/bots/api#sendvoice
|
||||||
|
type UploadVoice struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
Caption string `json:"caption,omitempty"`
|
||||||
|
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||||
|
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||||
|
Duration int `json:"duration,omitempty"`
|
||||||
|
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendVoice uploads a voice note via multipart and sends it as a message.
|
||||||
|
// files are the voice file(s) to upload (typically one file).
|
||||||
|
// See https://core.telegram.org/bots/api#sendvoice
|
||||||
|
func (u *Uploader) SendVoice(params UploadVoice, files ...UploaderFile) (Message, error) {
|
||||||
|
req := NewUploaderRequestWithChatID[Message]("sendVoice", params, params.ChatID, files...)
|
||||||
|
return req.Do(u)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendVoiceWithContext is the context-aware variant of SendVoice.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// SendVoiceWithContext is the context-aware variant of SendVoice.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#sendvoice
|
||||||
|
func (u *Uploader) SendVoiceWithContext(ctx context.Context, params UploadVoice, files ...UploaderFile) (Message, error) {
|
||||||
|
req := NewUploaderRequestWithChatID[Message]("sendVoice", params, params.ChatID, files...)
|
||||||
|
return req.DoWithContext(ctx, u)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UploadVideoNote holds parameters for uploading a video note (rounded video) using the Uploader.
|
||||||
|
// See https://core.telegram.org/bots/api#sendvideonote
|
||||||
|
type UploadVideoNote struct {
|
||||||
|
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||||
|
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||||
|
|
||||||
|
Duration int `json:"duration,omitempty"`
|
||||||
|
Length int `json:"length,omitempty"`
|
||||||
|
|
||||||
|
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||||
|
ProtectContent bool `json:"protect_content,omitempty"`
|
||||||
|
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||||
|
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||||
|
|
||||||
|
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||||
|
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||||
|
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendVideoNote uploads a video note via multipart and sends it as a message.
|
||||||
|
// files are the video note file(s) to upload (typically one file).
|
||||||
|
// See https://core.telegram.org/bots/api#sendvideonote
|
||||||
|
func (u *Uploader) SendVideoNote(params UploadVideoNote, files ...UploaderFile) (Message, error) {
|
||||||
|
req := NewUploaderRequestWithChatID[Message]("sendVideoNote", params, params.ChatID, files...)
|
||||||
|
return req.Do(u)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SendVideoNoteWithContext is the context-aware variant of SendVideoNote.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// SendVideoNoteWithContext is the context-aware variant of SendVideoNote.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#sendvideonote
|
||||||
|
func (u *Uploader) SendVideoNoteWithContext(ctx context.Context, params UploadVideoNote, files ...UploaderFile) (Message, error) {
|
||||||
|
req := NewUploaderRequestWithChatID[Message]("sendVideoNote", params, params.ChatID, files...)
|
||||||
|
return req.DoWithContext(ctx, u)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UploadChatPhoto holds parameters for uploading a chat photo using the Uploader.
|
||||||
|
// See https://core.telegram.org/bots/api#setchatphoto
|
||||||
|
type UploadChatPhoto struct {
|
||||||
|
ChatID int64 `json:"chat_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChatPhoto uploads a new chat photo.
|
||||||
|
// photo is the photo file to upload.
|
||||||
|
// See https://core.telegram.org/bots/api#setchatphoto
|
||||||
|
func (u *Uploader) SetChatPhoto(params UploadChatPhoto, photo UploaderFile) (bool, error) {
|
||||||
|
req := NewUploaderRequestWithChatID[bool]("setChatPhoto", params, params.ChatID, photo)
|
||||||
|
return req.Do(u)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetChatPhotoWithContext is the context-aware variant of SetChatPhoto.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// SetChatPhotoWithContext is the context-aware variant of SetChatPhoto.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setchatphoto
|
||||||
|
func (u *Uploader) SetChatPhotoWithContext(ctx context.Context, params UploadChatPhoto, photo UploaderFile) (bool, error) {
|
||||||
|
req := NewUploaderRequestWithChatID[bool]("setChatPhoto", params, params.ChatID, photo)
|
||||||
|
return req.DoWithContext(ctx, u)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UploadSetWebhook holds multipart parameters for the setWebhook method.
|
||||||
|
// Use this type when uploading a self-signed certificate file.
|
||||||
|
// See https://core.telegram.org/bots/api#setwebhook
|
||||||
|
type UploadSetWebhook struct {
|
||||||
|
URL string `json:"url"`
|
||||||
|
IPAddress string `json:"ip_address,omitempty"`
|
||||||
|
MaxConnections int8 `json:"max_connections,omitempty"`
|
||||||
|
AllowedUpdates []UpdateType `json:"allowed_updates,omitempty"`
|
||||||
|
DropPendingUpdates bool `json:"drop_pending_updates,omitempty"`
|
||||||
|
SecretToken string `json:"secret_token,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetWebhook uploads a certificate and sets a webhook URL.
|
||||||
|
// certificate maps to the multipart field \"certificate\".
|
||||||
|
// See https://core.telegram.org/bots/api#setwebhook
|
||||||
|
func (u *Uploader) SetWebhook(params UploadSetWebhook, certificate UploaderFile) (bool, error) {
|
||||||
|
req := NewUploaderRequest[bool]("setWebhook", params, certificate.SetType(UploaderCertificateType))
|
||||||
|
return req.Do(u)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetWebhookWithContext is the context-aware variant of SetWebhook.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setwebhook
|
||||||
|
func (u *Uploader) SetWebhookWithContext(ctx context.Context, params UploadSetWebhook, certificate UploaderFile) (bool, error) {
|
||||||
|
req := NewUploaderRequest[bool]("setWebhook", params, certificate.SetType(UploaderCertificateType))
|
||||||
|
return req.DoWithContext(ctx, u)
|
||||||
|
}
|
||||||
@@ -0,0 +1,102 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
import "context"
|
||||||
|
|
||||||
|
// GetUserProfilePhotos holds parameters for the GetUserProfilePhotos method.
|
||||||
|
// See https://core.telegram.org/bots/api#getuserprofilephotos
|
||||||
|
type GetUserProfilePhotos struct {
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
Offset int `json:"offset,omitempty"`
|
||||||
|
Limit int `json:"limit,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetUserProfilePhotos returns a list of profile pictures for a user.
|
||||||
|
// See https://core.telegram.org/bots/api#getuserprofilephotos
|
||||||
|
func (api *API) GetUserProfilePhotos(params GetUserProfilePhotos) (UserProfilePhotos, error) {
|
||||||
|
req := NewRequest[UserProfilePhotos]("getUserProfilePhotos", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetUserProfilePhotosWithContext is the context-aware variant of GetUserProfilePhotos.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getuserprofilephotos
|
||||||
|
func (api *API) GetUserProfilePhotosWithContext(ctx context.Context, params GetUserProfilePhotos) (UserProfilePhotos, error) {
|
||||||
|
req := NewRequest[UserProfilePhotos]("getUserProfilePhotos", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetUserProfileAudios holds parameters for the GetUserProfileAudios method.
|
||||||
|
// See https://core.telegram.org/bots/api#getuserprofileaudios
|
||||||
|
type GetUserProfileAudios struct {
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
Offset int `json:"offset,omitempty"`
|
||||||
|
Limit int `json:"limit,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetUserProfileAudios returns a list of profile audios for a user.
|
||||||
|
// See https://core.telegram.org/bots/api#getuserprofileaudios
|
||||||
|
func (api *API) GetUserProfileAudios(params GetUserProfileAudios) (UserProfileAudios, error) {
|
||||||
|
req := NewRequest[UserProfileAudios]("getUserProfileAudios", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetUserProfileAudiosWithContext is the context-aware variant of GetUserProfileAudios.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getuserprofileaudios
|
||||||
|
func (api *API) GetUserProfileAudiosWithContext(ctx context.Context, params GetUserProfileAudios) (UserProfileAudios, error) {
|
||||||
|
req := NewRequest[UserProfileAudios]("getUserProfileAudios", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetUserEmojiStatus holds parameters for the SetUserEmojiStatus method.
|
||||||
|
// See https://core.telegram.org/bots/api#setuseremojistatus
|
||||||
|
type SetUserEmojiStatus struct {
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
EmojiID string `json:"emoji_status_custom_emoji_id,omitempty"`
|
||||||
|
ExpirationDate int `json:"emoji_status_expiration_date,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetUserEmojiStatus sets a custom emoji status for a user.
|
||||||
|
// Returns true on success.
|
||||||
|
// See https://core.telegram.org/bots/api#setuseremojistatus
|
||||||
|
func (api *API) SetUserEmojiStatus(params SetUserEmojiStatus) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setUserEmojiStatus", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetUserEmojiStatusWithContext is the context-aware variant of SetUserEmojiStatus.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#setuseremojistatus
|
||||||
|
func (api *API) SetUserEmojiStatusWithContext(ctx context.Context, params SetUserEmojiStatus) (bool, error) {
|
||||||
|
req := NewRequest[bool]("setUserEmojiStatus", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetUserGifts holds parameters for the GetUserGifts method.
|
||||||
|
// See https://core.telegram.org/bots/api#getusergifts
|
||||||
|
type GetUserGifts struct {
|
||||||
|
UserID int64 `json:"user_id"`
|
||||||
|
ExcludeUnlimited bool `json:"exclude_unlimited,omitempty"`
|
||||||
|
ExcludeLimitedUpgradable bool `json:"exclude_limited_upgradable,omitempty"`
|
||||||
|
ExcludeLimitedNonUpgradable bool `json:"exclude_limited_non_upgradable,omitempty"`
|
||||||
|
ExcludeUnique bool `json:"exclude_unique,omitempty"`
|
||||||
|
ExcludeFromBlockchain bool `json:"exclude_from_blockchain,omitempty"`
|
||||||
|
SortByPrice bool `json:"sort_by_price,omitempty"`
|
||||||
|
Offset string `json:"offset,omitempty"`
|
||||||
|
Limit int `json:"limit,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetUserGifts returns gifts owned by a user.
|
||||||
|
// See https://core.telegram.org/bots/api#getusergifts
|
||||||
|
func (api *API) GetUserGifts(params GetUserGifts) (OwnedGifts, error) {
|
||||||
|
req := NewRequest[OwnedGifts]("getUserGifts", params)
|
||||||
|
return req.Do(api)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetUserGiftsWithContext is the context-aware variant of GetUserGifts.
|
||||||
|
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||||
|
// See https://core.telegram.org/bots/api#getusergifts
|
||||||
|
func (api *API) GetUserGiftsWithContext(ctx context.Context, params GetUserGifts) (OwnedGifts, error) {
|
||||||
|
req := NewRequest[OwnedGifts]("getUserGifts", params)
|
||||||
|
return req.DoWithContext(ctx, api)
|
||||||
|
}
|
||||||
@@ -0,0 +1,53 @@
|
|||||||
|
package tgapi
|
||||||
|
|
||||||
|
// User represents a Telegram user or bot.
|
||||||
|
// See https://core.telegram.org/bots/api#user
|
||||||
|
type User struct {
|
||||||
|
ID int64 `json:"id"`
|
||||||
|
IsBot bool `json:"is_bot"`
|
||||||
|
FirstName string `json:"first_name"`
|
||||||
|
LastName *string `json:"last_name,omitempty"`
|
||||||
|
Username *string `json:"username,omitempty"`
|
||||||
|
LanguageCode *string `json:"language_code,omitempty"`
|
||||||
|
IsPremium *bool `json:"is_premium,omitempty"`
|
||||||
|
AddedToAttachmentMenu *bool `json:"added_to_attachment_menu,omitempty"`
|
||||||
|
CanJoinGroups *bool `json:"can_join_groups,omitempty"`
|
||||||
|
CanReadAllGroupMessages *bool `json:"can_read_all_group_messages,omitempty"`
|
||||||
|
CanManageBots *bool `json:"can_manage_bots,omitempty"`
|
||||||
|
SupportsInlineQueries *bool `json:"supports_inline_queries,omitempty"`
|
||||||
|
CanConnectToBusiness *bool `json:"can_connect_to_business,omitempty"`
|
||||||
|
HasMainWebApp *bool `json:"has_main_web_app,omitempty"`
|
||||||
|
HasTopicsEnabled *bool `json:"has_topics_enabled,omitempty"`
|
||||||
|
AllowsUsersToCreateTopics *bool `json:"allows_users_to_create_topics,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// UserProfilePhotos represents a user's profile photos.
|
||||||
|
// See https://core.telegram.org/bots/api#userprofilephotos
|
||||||
|
type UserProfilePhotos struct {
|
||||||
|
TotalCount int `json:"total_count"`
|
||||||
|
Photos [][]PhotoSize `json:"photos"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// UserProfileAudios represents a user's profile audios.
|
||||||
|
// See https://core.telegram.org/bots/api#userprofileaudios
|
||||||
|
type UserProfileAudios struct {
|
||||||
|
TotalCount int `json:"total_count"`
|
||||||
|
Audios []Audio `json:"audios"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// UserRating represents a user's rating with level progression.
|
||||||
|
// See https://core.telegram.org/bots/api#userrating
|
||||||
|
type UserRating struct {
|
||||||
|
Level int `json:"level"`
|
||||||
|
Rating int `json:"rating"`
|
||||||
|
CurrentLevelRating int `json:"current_level_rating"`
|
||||||
|
NextLevelRating int `json:"next_level_rating"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Birthdate represents a user's birthdate.
|
||||||
|
// See https://core.telegram.org/bots/api#birthdate
|
||||||
|
type Birthdate struct {
|
||||||
|
Day int `json:"day"`
|
||||||
|
Month int `json:"month"`
|
||||||
|
Year int `json:"year"`
|
||||||
|
}
|
||||||
@@ -1,174 +0,0 @@
|
|||||||
package laniakea
|
|
||||||
|
|
||||||
type Update struct {
|
|
||||||
UpdateID int `json:"update_id"`
|
|
||||||
Message *Message `json:"message"`
|
|
||||||
EditedMessage *Message `json:"edited_message,omitempty"`
|
|
||||||
ChannelPost *Message `json:"channel_post,omitempty"`
|
|
||||||
EditedChannelPost *Message `json:"edited_channel_post,omitempty"`
|
|
||||||
BusinessConnection *BusinessConnection `json:"business_connection,omitempty"`
|
|
||||||
BusinessMessage *Message `json:"business_message,omitempty"`
|
|
||||||
EditedBusinessMessage *Message `json:"edited_business_message,omitempty"`
|
|
||||||
DeletedBusinessMessage *Message `json:"deleted_business_messages,omitempty"`
|
|
||||||
MessageReaction *MessageReactionUpdated `json:"message_reaction,omitempty"`
|
|
||||||
MessageReactionCount *MessageReactionCountUpdated `json:"message_reaction_count,omitempty"`
|
|
||||||
CallbackQuery *CallbackQuery `json:"callback_query,omitempty"`
|
|
||||||
InlineQuery int
|
|
||||||
ChosenInlineResult int
|
|
||||||
}
|
|
||||||
|
|
||||||
type User struct {
|
|
||||||
ID int `json:"id"`
|
|
||||||
IsBot bool `json:"is_bot"`
|
|
||||||
FirstName string `json:"first_name"`
|
|
||||||
LastName string `json:"last_name,omitempty"`
|
|
||||||
Username string `json:"username,omitempty"`
|
|
||||||
LanguageCode string `json:"language_code,omitempty"`
|
|
||||||
IsPremium bool `json:"is_premium,omitempty"`
|
|
||||||
AddedToAttachmentMenu bool `json:"added_to_attachment_menu,omitempty"`
|
|
||||||
CanJoinGroups bool `json:"can_join_groups,omitempty"`
|
|
||||||
CanReadAllGroupMessages bool `json:"can_read_all_group_messages,omitempty"`
|
|
||||||
SupportsInlineQueries bool `json:"supports_inline_queries,omitempty"`
|
|
||||||
CanConnectToBusiness bool `json:"can_connect_to_business,omitempty"`
|
|
||||||
HasMainWebApp bool `json:"has_main_web_app,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type Chat struct {
|
|
||||||
ID int `json:"id"`
|
|
||||||
Type string `json:"type"`
|
|
||||||
Title string `json:"title,omitempty"`
|
|
||||||
Username string `json:"username,omitempty"`
|
|
||||||
FirstName string `json:"first_name,omitempty"`
|
|
||||||
LastName string `json:"last_name,omitempty"`
|
|
||||||
IsForum bool `json:"is_forum,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type MessageReplyMarkup struct {
|
|
||||||
InlineKeyboard [][]InlineKeyboardButton `json:"inline_keyboard"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type Message struct {
|
|
||||||
MessageID int `json:"message_id"`
|
|
||||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
|
||||||
From *User `json:"from,omitempty"`
|
|
||||||
Chat *Chat `json:"chat,omitempty"`
|
|
||||||
Text string `json:"text"`
|
|
||||||
|
|
||||||
Photo []*PhotoSize `json:"photo,omitempty"`
|
|
||||||
Caption string `json:"caption,omitempty"`
|
|
||||||
ReplyToMessage *Message `json:"reply_to_message"`
|
|
||||||
|
|
||||||
ReplyMarkup *MessageReplyMarkup `json:"reply_markup,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type InaccessableMessage struct {
|
|
||||||
Chat *Chat `json:"chat"`
|
|
||||||
MessageID int `json:"message_id"`
|
|
||||||
Date int `json:"date"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type MaybeInaccessibleMessage struct {
|
|
||||||
}
|
|
||||||
|
|
||||||
type MessageEntity struct {
|
|
||||||
Type string `json:"type"`
|
|
||||||
Offset int `json:"offset"`
|
|
||||||
Length int `json:"length"`
|
|
||||||
URL string `json:"url,omitempty"`
|
|
||||||
User *User `json:"user,omitempty"`
|
|
||||||
Language string `json:"language,omitempty"`
|
|
||||||
CustomEmojiID string `json:"custom_emoji_id,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type ReplyParameters struct {
|
|
||||||
MessageID int `json:"message_id"`
|
|
||||||
ChatID int `json:"chat_id,omitempty"`
|
|
||||||
AllowSendingWithoutReply bool `json:"allow_sending_without_reply,omitempty"`
|
|
||||||
Quote string `json:"quote,omitempty"`
|
|
||||||
QuoteParsingMode string `json:"quote_parsing_mode,omitempty"`
|
|
||||||
QuoteEntities []*MessageEntity `json:"quote_entities,omitempty"`
|
|
||||||
QuotePosition int `json:"quote_postigin,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type PhotoSize struct {
|
|
||||||
FileID string `json:"file_id"`
|
|
||||||
FileUniqueID string `json:"file_unique_id"`
|
|
||||||
Width int `json:"width"`
|
|
||||||
Height int `json:"height"`
|
|
||||||
FileSize int `json:"file_size,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type LinkPreviewOptions struct {
|
|
||||||
IsDisabled bool `json:"is_disabled,omitempty"`
|
|
||||||
URL string `json:"url,omitempty"`
|
|
||||||
PreferSmallMedia bool `json:"prefer_small_media,omitempty"`
|
|
||||||
PreferLargeMedia bool `json:"prefer_large_media,omitempty"`
|
|
||||||
ShowAboveText bool `json:"show_above_text,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type InlineKeyboardMarkup struct {
|
|
||||||
InlineKeyboard [][]InlineKeyboardButton `json:"inline_keyboard,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type InlineKeyboardButton struct {
|
|
||||||
Text string `json:"text"`
|
|
||||||
URL string `json:"url,omitempty"`
|
|
||||||
CallbackData string `json:"callback_data,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type ReplyKeyboardMarkup struct {
|
|
||||||
Keyboard [][]int `json:"keyboard"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type CallbackQuery struct {
|
|
||||||
ID string `json:"id"`
|
|
||||||
From *User `json:"from"`
|
|
||||||
Message *Message `json:"message"`
|
|
||||||
|
|
||||||
Data string `json:"data"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type BusinessConnection struct {
|
|
||||||
ID string `json:"id"`
|
|
||||||
User *User `json:"user"`
|
|
||||||
UserChatID int `json:"user_chat_id"`
|
|
||||||
Date int `json:"date"`
|
|
||||||
CanReply bool `json:"can_reply"`
|
|
||||||
IsEnabled bool `json:"id_enabled"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type MessageReactionUpdated struct {
|
|
||||||
Chat *Chat `json:"chat"`
|
|
||||||
MessageID int `json:"message_id"`
|
|
||||||
User *User `json:"user,omitempty"`
|
|
||||||
ActorChat *Chat `json:"actor_chat"`
|
|
||||||
Date int `json:"date"`
|
|
||||||
OldReaction []*ReactionType `json:"old_reaction"`
|
|
||||||
NewReaction []*ReactionType `json:"new_reaction"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type MessageReactionCountUpdated struct {
|
|
||||||
Chat *Chat `json:"chat"`
|
|
||||||
MessageID int `json:"message_id"`
|
|
||||||
Date int `json:"date"`
|
|
||||||
Reactions []*ReactionCount `json:"reactions"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type ReactionType struct {
|
|
||||||
Type string `json:"type"`
|
|
||||||
}
|
|
||||||
type ReactionTypeEmoji struct {
|
|
||||||
ReactionType
|
|
||||||
Emoji string `json:"emoji"`
|
|
||||||
}
|
|
||||||
type ReactionTypeCustomEmoji struct {
|
|
||||||
ReactionType
|
|
||||||
CustomEmojiID string `json:"custom_emoji_id"`
|
|
||||||
}
|
|
||||||
type ReactionTypePaid struct {
|
|
||||||
ReactionType
|
|
||||||
}
|
|
||||||
type ReactionCount struct {
|
|
||||||
Type *ReactionType `json:"type"`
|
|
||||||
TotalCount int `json:"total_count"`
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,223 @@
|
|||||||
|
package laniakea
|
||||||
|
|
||||||
|
import (
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||||
|
)
|
||||||
|
|
||||||
|
func (bot *Bot[T]) handleUpdate(u *tgapi.Update, ctx *MsgContext) bool {
|
||||||
|
handled := false
|
||||||
|
for _, plugin := range bot.plugins {
|
||||||
|
handler, ok := plugin.handlers[u.Type]
|
||||||
|
if !ok {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
pluginCtx := cloneMsgContext(ctx)
|
||||||
|
if plugin.logger != nil {
|
||||||
|
pluginCtx.Logger = plugin.logger
|
||||||
|
}
|
||||||
|
if !plugin.executeMiddlewares(pluginCtx, bot.appData) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
startTime := time.Now()
|
||||||
|
bot.safeEmitEvent(pluginCtx.Context(), HandlerStartedEvent{
|
||||||
|
UpdateID: u.UpdateID,
|
||||||
|
UpdateType: u.Type,
|
||||||
|
Plugin: plugin.name,
|
||||||
|
HandlerKind: HandlerUpdateKind,
|
||||||
|
HandlerName: string(u.Type),
|
||||||
|
FromID: pluginCtx.FromID,
|
||||||
|
ChatID: pluginCtx.ChatID,
|
||||||
|
})
|
||||||
|
err := handler(pluginCtx, bot.appData)
|
||||||
|
endEvent := HandlerFinishedEvent{
|
||||||
|
UpdateID: u.UpdateID,
|
||||||
|
UpdateType: u.Type,
|
||||||
|
Plugin: plugin.name,
|
||||||
|
HandlerKind: HandlerUpdateKind,
|
||||||
|
HandlerName: string(u.Type),
|
||||||
|
FromID: pluginCtx.FromID,
|
||||||
|
ChatID: pluginCtx.ChatID,
|
||||||
|
Duration: time.Since(startTime),
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
endEvent.Err = err
|
||||||
|
endEvent.UserFacing = IsUserError(err)
|
||||||
|
}
|
||||||
|
bot.safeEmitEvent(pluginCtx.Context(), endEvent)
|
||||||
|
if err != nil {
|
||||||
|
bot.safeEmitEvent(pluginCtx.Context(), ErrorEvent{
|
||||||
|
UpdateID: u.UpdateID,
|
||||||
|
UpdateType: u.Type,
|
||||||
|
Plugin: plugin.name,
|
||||||
|
HandlerKind: HandlerUpdateKind,
|
||||||
|
HandlerName: string(u.Type),
|
||||||
|
FromID: pluginCtx.FromID,
|
||||||
|
ChatID: pluginCtx.ChatID,
|
||||||
|
Err: err,
|
||||||
|
UserFacing: IsUserError(err),
|
||||||
|
})
|
||||||
|
pluginCtx.error(err)
|
||||||
|
}
|
||||||
|
handled = true
|
||||||
|
}
|
||||||
|
return handled
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bot *Bot[T]) prepareUpdateCtx(u *tgapi.Update, ctx *MsgContext) {
|
||||||
|
var from *tgapi.User
|
||||||
|
var chat *tgapi.Chat
|
||||||
|
switch u.Type {
|
||||||
|
case tgapi.UpdateTypeMessage:
|
||||||
|
if u.Message != nil {
|
||||||
|
ctx.Msg = u.Message
|
||||||
|
if u.Message.Chat != nil {
|
||||||
|
chat = u.Message.Chat
|
||||||
|
}
|
||||||
|
if u.Message.From != nil {
|
||||||
|
from = u.Message.From
|
||||||
|
}
|
||||||
|
}
|
||||||
|
case tgapi.UpdateTypeEditedMessage:
|
||||||
|
if u.EditedMessage != nil {
|
||||||
|
ctx.Msg = u.EditedMessage
|
||||||
|
if u.EditedMessage.Chat != nil {
|
||||||
|
chat = u.EditedMessage.Chat
|
||||||
|
}
|
||||||
|
if u.EditedMessage.From != nil {
|
||||||
|
from = u.EditedMessage.From
|
||||||
|
}
|
||||||
|
}
|
||||||
|
case tgapi.UpdateTypeChannelPost:
|
||||||
|
if u.ChannelPost != nil {
|
||||||
|
ctx.Msg = u.ChannelPost
|
||||||
|
if u.ChannelPost.Chat != nil {
|
||||||
|
chat = u.ChannelPost.Chat
|
||||||
|
}
|
||||||
|
if u.ChannelPost.From != nil {
|
||||||
|
from = u.ChannelPost.From
|
||||||
|
}
|
||||||
|
}
|
||||||
|
case tgapi.UpdateTypeEditedChannelPost:
|
||||||
|
if u.EditedChannelPost != nil {
|
||||||
|
ctx.Msg = u.EditedChannelPost
|
||||||
|
if u.EditedChannelPost.Chat != nil {
|
||||||
|
chat = u.EditedChannelPost.Chat
|
||||||
|
}
|
||||||
|
if u.EditedChannelPost.From != nil {
|
||||||
|
from = u.EditedChannelPost.From
|
||||||
|
}
|
||||||
|
}
|
||||||
|
case tgapi.UpdateTypeBusinessMessage:
|
||||||
|
if u.BusinessMessage != nil {
|
||||||
|
ctx.Msg = u.BusinessMessage
|
||||||
|
if u.BusinessMessage.Chat != nil {
|
||||||
|
chat = u.BusinessMessage.Chat
|
||||||
|
}
|
||||||
|
if u.BusinessMessage.From != nil {
|
||||||
|
from = u.BusinessMessage.From
|
||||||
|
}
|
||||||
|
}
|
||||||
|
case tgapi.UpdateTypeEditedBusinessMessage:
|
||||||
|
if u.EditedBusinessMessage != nil {
|
||||||
|
ctx.Msg = u.EditedBusinessMessage
|
||||||
|
if u.EditedBusinessMessage.Chat != nil {
|
||||||
|
chat = u.EditedBusinessMessage.Chat
|
||||||
|
}
|
||||||
|
if u.EditedBusinessMessage.From != nil {
|
||||||
|
from = u.EditedBusinessMessage.From
|
||||||
|
}
|
||||||
|
}
|
||||||
|
case tgapi.UpdateTypeInlineQuery:
|
||||||
|
if u.InlineQuery != nil {
|
||||||
|
from = &u.InlineQuery.From
|
||||||
|
}
|
||||||
|
case tgapi.UpdateTypeChosenInlineResult:
|
||||||
|
if u.ChosenInlineResult != nil {
|
||||||
|
from = &u.ChosenInlineResult.From
|
||||||
|
}
|
||||||
|
case tgapi.UpdateTypeCallbackQuery:
|
||||||
|
if u.CallbackQuery != nil {
|
||||||
|
if u.CallbackQuery.Message != nil {
|
||||||
|
ctx.Msg = u.CallbackQuery.Message
|
||||||
|
ctx.CallbackMsgID = u.CallbackQuery.Message.MessageID
|
||||||
|
if u.CallbackQuery.Message.Chat != nil {
|
||||||
|
chat = u.CallbackQuery.Message.Chat
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if u.CallbackQuery.InlineMessageID != nil {
|
||||||
|
ctx.InlineMsgID = *u.CallbackQuery.InlineMessageID
|
||||||
|
}
|
||||||
|
ctx.CallbackQueryID = u.CallbackQuery.ID
|
||||||
|
from = &u.CallbackQuery.From
|
||||||
|
}
|
||||||
|
case tgapi.UpdateTypeShippingQuery:
|
||||||
|
if u.ShippingQuery != nil {
|
||||||
|
from = &u.ShippingQuery.From
|
||||||
|
}
|
||||||
|
case tgapi.UpdateTypePreCheckoutQuery:
|
||||||
|
if u.PreCheckoutQuery != nil {
|
||||||
|
from = &u.PreCheckoutQuery.From
|
||||||
|
}
|
||||||
|
case tgapi.UpdateTypePurchasedPaidMedia:
|
||||||
|
if u.PurchasedPaidMedia != nil {
|
||||||
|
from = &u.PurchasedPaidMedia.From
|
||||||
|
}
|
||||||
|
case tgapi.UpdateTypeMyChatMember:
|
||||||
|
if u.MyChatMember != nil {
|
||||||
|
from = &u.MyChatMember.From
|
||||||
|
chat = &u.MyChatMember.Chat
|
||||||
|
}
|
||||||
|
case tgapi.UpdateTypeChatMember:
|
||||||
|
if u.ChatMember != nil {
|
||||||
|
from = &u.ChatMember.From
|
||||||
|
chat = &u.ChatMember.Chat
|
||||||
|
}
|
||||||
|
case tgapi.UpdateTypeChatJoinRequest:
|
||||||
|
if u.ChatJoinRequest != nil {
|
||||||
|
from = &u.ChatJoinRequest.From
|
||||||
|
chat = &u.ChatJoinRequest.Chat
|
||||||
|
|
||||||
|
}
|
||||||
|
case tgapi.UpdateTypeBusinessConnection:
|
||||||
|
if u.BusinessConnection != nil {
|
||||||
|
from = &u.BusinessConnection.User
|
||||||
|
}
|
||||||
|
case tgapi.UpdateTypePollAnswer:
|
||||||
|
if u.PollAnswer != nil {
|
||||||
|
from = &u.PollAnswer.User
|
||||||
|
}
|
||||||
|
case tgapi.UpdateTypeMessageReaction:
|
||||||
|
if u.MessageReaction != nil {
|
||||||
|
from = u.MessageReaction.User
|
||||||
|
chat = u.MessageReaction.Chat
|
||||||
|
}
|
||||||
|
case tgapi.UpdateTypeChatBoost:
|
||||||
|
if u.ChatBoost != nil {
|
||||||
|
from = &u.ChatBoost.Boost.Source.User
|
||||||
|
chat = &u.ChatBoost.Chat
|
||||||
|
}
|
||||||
|
case tgapi.UpdateTypeRemovedChatBoost:
|
||||||
|
if u.RemovedChatBoost != nil {
|
||||||
|
from = &u.RemovedChatBoost.Source.User
|
||||||
|
chat = &u.RemovedChatBoost.Chat
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if ctx.Msg != nil && from == nil {
|
||||||
|
from = ctx.Msg.From
|
||||||
|
}
|
||||||
|
if from != nil {
|
||||||
|
ctx.From = from
|
||||||
|
ctx.FromID = from.ID
|
||||||
|
} else {
|
||||||
|
ctx.FromID = 0
|
||||||
|
}
|
||||||
|
if chat != nil {
|
||||||
|
ctx.Chat = chat
|
||||||
|
ctx.ChatID = chat.ID
|
||||||
|
} else {
|
||||||
|
ctx.ChatID = 0
|
||||||
|
}
|
||||||
|
}
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user