REPOSITORY / ScuroNeko/Laniakea
Compare commits
Compare commits
39 Commits
v1.0.0-rc.15
..
main
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d3e4276b97 | ||
|
|
24040fe164
|
||
|
|
29b208eeec
|
||
|
|
4d95bd0574 | ||
|
|
f03a081ed6
|
||
|
|
48ddf66540
|
||
|
|
b563e695df
|
||
|
|
38309e74f6
|
||
|
|
f4117c143e | ||
|
|
c2f6406819
|
||
|
|
9e3450df31
|
||
|
|
07ce1ccda0 | ||
|
|
effd26bd9a | ||
|
|
5514665625
|
||
|
|
950ce6b88c
|
||
|
|
8a3f2cedf2
|
||
|
|
61d0b1ebb8
|
||
|
|
1e26d871b5
|
||
|
|
affb802a7b
|
||
|
|
09fb9261df
|
||
|
|
5959d69945
|
||
|
|
daa1b862ed
|
||
|
|
7205b21fa2
|
||
|
|
6595265cb3
|
||
|
|
071fc2375e
|
||
|
|
269ccec007
|
||
|
|
b123709f28
|
||
|
|
4807dec6ae
|
||
|
|
667fa3cc61
|
||
|
|
fc4386df75
|
||
|
|
a34734366d
|
||
|
|
3aee299869
|
||
|
|
b0882a46d5
|
||
|
|
7d4b150b0b | ||
|
|
a7c8d68925 | ||
|
|
5f17b88787 | ||
|
|
6d6f5738cd | ||
|
|
fef718438a | ||
|
|
7f248fff62 |
@@ -1,6 +1,6 @@
|
||||
name: Golang lint
|
||||
run-name: Linting code
|
||||
on: [push]
|
||||
on: [push, pull_request]
|
||||
|
||||
jobs:
|
||||
lint:
|
||||
@@ -8,5 +8,32 @@ jobs:
|
||||
steps:
|
||||
- name: Checkout repository code
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Set up Go
|
||||
uses: actions/setup-go@v6.5.0
|
||||
with:
|
||||
go-version: '1.26.6'
|
||||
cache-dependency-path: go.sum
|
||||
|
||||
- name: Print toolchain version
|
||||
run: go version
|
||||
|
||||
- name: Verify formatting
|
||||
run: |
|
||||
files="$(gofmt -l .)"
|
||||
if [ -n "$files" ]; then
|
||||
echo "These files are not gofmt-formatted:"
|
||||
echo "$files"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: Run go test
|
||||
run: go test ./...
|
||||
|
||||
- name: Run go vet
|
||||
run: go vet ./...
|
||||
|
||||
- name: Run golangci-lint
|
||||
run: golangci-lint run
|
||||
uses: golangci/golangci-lint-action@v9.0.0
|
||||
with:
|
||||
version: v2.12.2
|
||||
|
||||
@@ -4,3 +4,6 @@
|
||||
test/
|
||||
.codex/
|
||||
.codex
|
||||
.agents/
|
||||
.claude/
|
||||
review.md
|
||||
+1
-2
@@ -2,10 +2,9 @@ version: "2"
|
||||
run:
|
||||
timeout: 5m
|
||||
linters:
|
||||
disable-all: true
|
||||
default: none
|
||||
enable:
|
||||
- errcheck
|
||||
- govet
|
||||
- ineffassign
|
||||
- staticcheck
|
||||
- unused
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# AGENTS.md
|
||||
|
||||
## Purpose
|
||||
This repository uses Codex for full-project Go code review, not diff-only review.
|
||||
This repository uses AI coding agents 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.
|
||||
|
||||
@@ -60,6 +60,11 @@ Each exported godoc comment must:
|
||||
- avoid repeating the signature mechanically;
|
||||
- stay high-signal and informative.
|
||||
|
||||
### Telegram API documentation and versions
|
||||
- When writing or updating godoc for Telegram Bot API types, fields, methods, or helpers, verify the description against the official [Telegram Bot API documentation](https://core.telegram.org/bots/api). Preserve relevant API semantics such as HTML equivalents, accepted ranges, formats, and optionality.
|
||||
- Add a `Since: Bot API X.Y` paragraph to each exported type, function, and method introduced in a specific Bot API version, using the established `tgapi` format.
|
||||
- Add an inline `// Since: Bot API X.Y` comment to an exported struct field only when its Bot API version differs from that of the containing struct. For example, if `InputRichMessage` was introduced in Bot API 10.1 and its `Media` field in Bot API 10.2, annotate only the `Media` field; do not repeat the struct's version on its original fields.
|
||||
|
||||
### Unexported declarations
|
||||
Unexported types, funcs, methods, vars, and consts should generally not have godoc-style comments unless there is a strong reason.
|
||||
|
||||
@@ -96,6 +101,9 @@ Prefer the repository’s documented commands. If multiple choices exist, use th
|
||||
- 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.
|
||||
- Before editing `CHANGELOG.md`, the agent must inspect the full diff between the latest published tag and the current worktree, for example `git diff --name-status <latest-tag> -- .` and targeted `git diff <latest-tag> -- <files>`.
|
||||
- Changelog entries must be based on all user-visible changes present between the latest published tag and the current files, including earlier uncommitted or pre-existing worktree changes, not only changes made in the current turn.
|
||||
- The agent must not add changelog entries for changes that are not present in the diff from the latest published tag, and must remove or rewrite stale entries that no longer match that diff.
|
||||
- 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`
|
||||
@@ -103,7 +111,7 @@ Prefer the repository’s documented commands. If multiple choices exist, use th
|
||||
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.
|
||||
- Changelog entries must describe all user-visible behavior changes in the diff from the latest published tag, 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`;
|
||||
@@ -112,8 +120,8 @@ Prefer the repository’s documented commands. If multiple choices exist, use th
|
||||
|
||||
## 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.
|
||||
- Breaking changes are forbidden unless the selected target version is a new major version, or it's necessary(i.e. fixing not working feature).
|
||||
- If the requested change is breaking, not necessary to fix a non-working feature, 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;
|
||||
@@ -123,9 +131,12 @@ Prefer the repository’s documented commands. If multiple choices exist, use th
|
||||
|
||||
## Commit message format
|
||||
- When the user asks for a commit message, the agent must produce it in this format:
|
||||
1. a short summary line;
|
||||
2. up to three additional lines with only the most important changes;
|
||||
3. each additional line must start on its own new line.
|
||||
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.
|
||||
|
||||
+249
@@ -1,5 +1,254 @@
|
||||
# Changelog
|
||||
|
||||
## v1.2.0
|
||||
|
||||
### Added
|
||||
- Added cancelable background runners through `ContextRunnerFn` and `NewContextRunner`; existing `RunnerFn` and `NewRunner` remain available for compatibility.
|
||||
- Added validated inline-keyboard APIs: `InlineKeyboardButtonBuilder.Validate`/`Build`, `InlineKeyboard.Validate`/`GetValidated`, and `CallbackData.EncodeValidated`, with typed errors for invalid actions, callback-data length, and oversized rows.
|
||||
- Added bounded file-download helpers `GetFileByLinkLimit` and `GetFileByLinkLimitWithContext` with `ErrFileTooLarge`; existing unbounded and streaming helpers remain available.
|
||||
- Added strict root rich-message parsing through `UnmarshalRichMessageStrict` and structural rich JSON depth/node limits with `ErrRichJSONDepth` and `ErrRichJSONNodes`.
|
||||
- Added `APIOpts.SetMaxRetries` for Telegram 429 responses. Automatic JSON and multipart retries now default to at most three attempts after the initial request and return `ErrRetryLimit` when exhausted.
|
||||
- Added `SetChatPhotoWithContext` and the correctly pluralized `DeleteAllMessageReactionsWithContext`; the old singular compatibility alias remains deprecated until v2.
|
||||
- Added `PollAnswer.VoterUser` and `PollAnswer.VoterChatInfo` presence helpers without changing the v1 value-field layout.
|
||||
- Added typed runtime errors for invalid scene actions, nil handlers, recovered handler panics, oversized Telegram responses, and recovered worker-pool task panics.
|
||||
- Added `CommandScopeUpdateError` and command-generation validation errors so callers can inspect invalid commands, duplicate names, invalid descriptions, and partially updated Telegram scopes.
|
||||
- Added rich-message editing helpers `MessageContext.EditCallbackRich`, `MessageContext.UpsertKeyboardRich`, `AnswerMessage.EditRich`, and `AnswerMessage.EditRichKeyboard`, plus `AnswerMessage.RichHTML` for rendered rich content.
|
||||
- Added `NewBotWithAPI` for constructing a bot with a preconfigured, injectable Telegram API client.
|
||||
|
||||
### Changed
|
||||
- Runtime observer callbacks now execute asynchronously in enqueue order on one bounded dispatcher instead of blocking update handlers and scene locks. Queue overflow drops events with sampled warnings, observer panics remain isolated, and shutdown cancels callback contexts, drains queued events, and reports callbacks that ignore cancellation.
|
||||
- Scene routing now holds a lock only for the active session key; updates without an active scene and unrelated user sessions in the same chat remain concurrent.
|
||||
- Multipart uploads now encode request bodies as streams instead of building a second complete in-memory copy for every attempt.
|
||||
- Logger replacement and app-data logger writer registration now follow the bot configuration freeze, reject nil values safely, and install bot-token redaction before publishing replacement loggers.
|
||||
- README and README_RU now document context runners, injectable API clients, bounded retries and downloads, streaming multipart uploads, keyboard validation, and asynchronous observer delivery.
|
||||
- Version metadata now reports `v1.2.0`.
|
||||
|
||||
### Fixed
|
||||
- Fixed HTTP transport errors exposing the bot token through Bot API request and file-download URLs while preserving error-chain inspection.
|
||||
- Fixed per-chat rate-limiter lifecycle races with concurrent cleanup, cooldown waits ignoring a later extension, shorter 429 locks replacing longer locks, and busy chats consuming global capacity before obtaining chat capacity.
|
||||
- Fixed scene `AsUserError` values not reaching users and producing duplicate observer errors; scene step, command, payload, and message-fallback errors now follow one consistent error path.
|
||||
- Fixed nil and panicking command, payload, update, message-fallback, scene, and middleware callbacks breaking handler/observer lifecycles. Panics are recovered per invocation and matching finish/error events are emitted.
|
||||
- Fixed asynchronous middleware error events and policy events bypassing the runtime observer dispatcher.
|
||||
- Fixed Telegram MarkdownV2 custom emoji syntax, multiline expandable blockquotes, code/pre escaping, and unsafe code-fence language strings.
|
||||
- Fixed `MessageContext.BindArgs` accepting values outside the destination integer or floating-point width.
|
||||
- Fixed empty successful draft flushes leaving stale drafts in `DraftProvider`.
|
||||
- Fixed generated command descriptions outside Telegram's 1–256-character range, duplicate command names across plugins, trailing usage whitespace, and silent partial multi-scope updates.
|
||||
- Fixed inline keyboard auto-wrap after reducing `maxRow`; legacy non-positive unlimited rows remain compatible for v1.
|
||||
- Fixed Telegram API responses larger than 10 MiB being silently truncated before JSON parsing; they now return `ErrResponseTooLarge`.
|
||||
- Fixed unknown `SceneAction` values being treated as a normal unhandled result.
|
||||
- Fixed worker-pool task panics terminating a worker and leaving the caller without a result.
|
||||
- Fixed zero or negative Telegram `retry_after` values causing a tight retry loop.
|
||||
- Fixed Telegram JSON wire names for `provider_payment_charge_id`, `owned_gift_id`, `others_can_add_tasks`, `others_can_mark_tasks_as_done`, `available_reactions`, and `quote_parse_mode`.
|
||||
- Fixed `MessageContext` text, photo, caption, rich-message, and chat-action helpers omitting business connection identifiers; message-backed helpers now also reject missing chats instead of panicking, while inline edits remain supported without a chat-backed message.
|
||||
- Fixed chat-admin, chat-creator, and bot-admin policies ignoring cancellation and deadlines from the active `MessageContext`.
|
||||
- Fixed command parsing treating tabs and newlines as part of command names and matching addressed bot usernames case-sensitively.
|
||||
- Fixed nested `RichTextArray` values bypassing rich-message depth validation and renderer limits.
|
||||
- Fixed polling panics being reported only through telemetry while `RunWithContext` returned success.
|
||||
- Fixed asynchronous middleware outliving the bot runtime and normal middleware denials being reported as internal handler errors.
|
||||
- Fixed caller-owned or aliased bot loggers being closed by the framework, bot-owned aliases being closed more than once, and replaced internal loggers leaking resources.
|
||||
- Fixed configuration codecs and JSON option encoding panicking on nil inputs.
|
||||
|
||||
### Documentation
|
||||
- Added field-level Godoc for the complete exported API surface, including official Telegram Bot API optionality, ranges, formats, and field semantics. The repository-wide AST audit now reports no undocumented exported declarations or struct fields.
|
||||
- Corrected draft-provider Godoc to avoid promising cryptographic unpredictability from `math/rand/v2` IDs.
|
||||
- Marked v1 compatibility surfaces that may change in v2: `PollAnswer` voter pointers, context-required runners, error-returning keyboard builders, strict rich-message parsing, lossless unknown rich types, bounded downloads, compatibility aliases, and corrected public field names.
|
||||
- Clarified that drop-overflow mode rejects outgoing API requests, one-shot asynchronous runners are awaited during shutdown, and pending uploads are drained by the shared API client.
|
||||
|
||||
### CI
|
||||
- Pinned the lint workflow to Go `1.26.6`, `golangci/golangci-lint-action@v9.0.0`, and golangci-lint `v2.12.2` for reproducible analysis.
|
||||
|
||||
### Tests
|
||||
- Added regression coverage for limiter concurrency and cooldown behavior, scene lock scope, all scene handler error paths, polling, handler, and worker panics, asynchronous observer delivery, cancellation, and bounded shutdown, asynchronous middleware lifecycle, logger ownership, runner and policy cancellation, nil configuration inputs, draft cleanup, command parsing, command validation and partial scopes, keyboard byte boundaries and rows, MarkdownV2 vectors, numeric binding boundaries, rich JSON and renderer depth limits, strict rich roots, rich-message editing, business-message helpers and photo replacement, bounded file downloads, retry caps, streaming multipart replay, and corrected Telegram wire keys.
|
||||
|
||||
## v1.1.0
|
||||
|
||||
### Breaking Changes
|
||||
- Fixed `Uploader.SendLivePhoto` and `Uploader.SendLivePhotoWithContext` to require both the live-photo video and its static image. The previous one-file signatures could not produce a valid `sendLivePhoto` request.
|
||||
|
||||
### Bot API 10.1
|
||||
- Added rich message receiving support: `tgapi.RichMessage` on `Message.RichMessage` (`rich_message`), the full set of `RichText*`/`RichBlock*` wire types with official API names, and `UnmarshalRichText`/`UnmarshalRichBlock`/`UnmarshalRichMessage` parsers. Unknown text-bearing types retain their nested text through fallback wrappers while unmodeled fields are discarded.
|
||||
- Added rich message sending support: `tgapi.InputRichMessage`, `tgapi.SendRichMessage` params, and `API.SendRichMessage`/`API.SendRichMessageWithContext`.
|
||||
- Added rich message draft streaming: `API.SendRichMessageDraft`/`API.SendRichMessageDraftWithContext` for ephemeral ~30-second previews of partially generated messages.
|
||||
- Added rich message editing: `EditMessageText.RichMessage` (`InputRichMessage`); `Text` is now omitted from the request when empty so rich-only edits are valid.
|
||||
- Added `tgapi.InputRichMessageContent` for rich content in inline query results.
|
||||
- Added join request query support: `User.SupportsJoinRequestQueries`, `ChatFullInfo.GuardBot`, `ChatJoinRequest.QueryID`, `API.AnswerChatJoinRequestQuery` with `ChatJoinRequestQueryResult` constants (`JoinRequestApprove`/`JoinRequestDecline`/`JoinRequestQueue`), and `API.SendChatJoinRequestWebApp` (plus `WithContext` variants).
|
||||
- Added poll link media: the `tgapi.Link` type, `PollMedia.Link`, and the "link" type with `URL` on `InputPollOptionMedia`.
|
||||
|
||||
### Bot API 10.2
|
||||
- Added block-based rich-message sending with `InputRichMessage.Blocks`, including animation, audio, photo, video, and voice-note input blocks. The `tgrich` package provides matching media constructors with optional block captions.
|
||||
- Added `InputRichMessage.Media` for media embedded in rich-message HTML or Markdown, with multipart `attach://` upload support.
|
||||
- Added multipart rich-message uploads through `Uploader.SendRichMessage`. Use `UploaderFile.SetAttachName` to match an `attach://` media reference; rich-message draft helpers reject direct uploads as required by Telegram.
|
||||
- Added ephemeral-message support: outgoing receiver and callback parameters, reply targets, message fields, edit and delete methods, and ephemeral bot commands. Added community service-message types and subscription update handling.
|
||||
|
||||
### Added
|
||||
- Added documented `tgrich` constructors and block types for building input rich messages.
|
||||
- Added `tgrich.BuildHTML` and `tgrich.ToHTML` to validate input block trees, convert them to HTML rich messages, and collect URL, `file_id`, or multipart media references.
|
||||
- Added `MessageContext.RichAnswer(...)` and `MessageContext.RichAnswerKeyboard(...)` for validating and sending `tgrich` input blocks.
|
||||
- Added `UpdateTypeSubscription` routing and normalized message, user, and chat context for guest messages, deleted business messages, anonymous poll answers, reaction counts, managed bots, chat boosts, and subscription updates.
|
||||
- Added webhook secret-format validation and the exported `ErrBotWebhookOptsSecretTokenInvalid` sentinel.
|
||||
|
||||
### Changed
|
||||
- `AutoGenerateCommandsForScope(nil)` now atomically replaces commands in Telegram's default scope without deleting the previous list first.
|
||||
- API debug logging now records redacted request JSON and response metadata instead of complete response bodies.
|
||||
- Scene updates sharing a user or chat session key are serialized, and duplicate scene names from later plugins are skipped with a warning.
|
||||
- Inline keyboard button builders now keep URL and callback actions mutually exclusive, and `InlineKeyboard.Get` returns independent markup data.
|
||||
- `NewBot` no longer aliases `BotOpts.Prefixes` or mutates `BotOpts.LoggerBasePath`.
|
||||
- README requirements now match the module's Go 1.26 directive.
|
||||
- Migrated the golangci-lint configuration to its v2 schema so the repository lint workflow runs again.
|
||||
- Added missing Godoc for exported error methods, enum constants, and all public Bot API 10.1/10.2 fields introduced in this release.
|
||||
|
||||
### Fixed
|
||||
- Fixed JSON BotOpts environment placeholders corrupting or injecting JSON when values contain quotes, backslashes, or control characters.
|
||||
- Preserved checkbox state when converting list items to ordered lists and made generated HTML attribute ordering deterministic.
|
||||
- Added validation for rich-block type discriminators, heading sizes, list fields, table cells, map parameters, and media values.
|
||||
- Fixed generated webhook secrets using padded Base64 characters that Telegram rejects, stopped logging generated secrets, and added HTTP read and idle timeouts to the webhook server.
|
||||
- Fixed negative group and channel IDs receiving global rather than per-chat `retry_after` cooldowns.
|
||||
- Fixed rejected per-chat requests consuming global rate-limit capacity and draft construction consuming an extra rate-limit token before the API request.
|
||||
- Fixed subscription updates being decoded as `UpdateTypeUnknown`.
|
||||
- Fixed rich-text and rich-block decoding silently accepting malformed typed fields or a top-level `null` rich-text value.
|
||||
- Fixed `tgrich.BuildHTML` disabling Telegram entity detection and accepting the draft-only thinking block; `BuildDraftHTML` now provides the explicit draft path.
|
||||
- Fixed `tgrich.BuildHTML` silently losing explicit bank-card, mention, hashtag, cashtag, and bot-command values when their visible text differs.
|
||||
- Fixed API debug logs exposing webhook, payment, callback, passport, and managed-bot secrets.
|
||||
- Fixed panics and nil callbacks in asynchronous middleware terminating the process; failures now reach the logger and observer error stream.
|
||||
- Fixed multipart helpers attempting direct file uploads for rich-message drafts, which Telegram does not support; they now return `ErrRichMessageDraftUploadUnsupported`.
|
||||
- Fixed draft ID zero values and collisions overwriting tracked drafts, nil draft APIs panicking, and draft entity slices aliasing caller memory.
|
||||
- Fixed scene session payloads and returned inline keyboard markup aliasing mutable internal slices.
|
||||
- Recovered panics from runner callbacks so they are reported through normal runner and error observer events instead of terminating the process.
|
||||
|
||||
### Tests
|
||||
- Added JSON regression coverage for rich-message embedded media and ephemeral send, edit, and delete parameters.
|
||||
- Added regression coverage for escaped environment placeholders and both required `sendLivePhoto` multipart fields.
|
||||
- Added regression coverage for API log redaction, same-session scene serialization, duplicate scene registration, async middleware failures, and rich entity preservation.
|
||||
- Added rich HTML renderer coverage for all input block and media types, multipart references, field validation, and Telegram's text, block, nesting, media, and table-width limits.
|
||||
- Added regression coverage for webhook token syntax, update context normalization, subscription routing, rate-limit capacity, draft ID collisions, runner panics, scene and keyboard aliasing, command replacement, and malformed rich JSON.
|
||||
|
||||
## v1.0.2
|
||||
|
||||
### Fixed
|
||||
- Fixed long-polling stopping permanently when the HTTP client's internal timeout fired. The polling loop was checking `errors.Is(err, context.DeadlineExceeded)`, which matched HTTP client timeout errors (`*url.Error` wraps `context.DeadlineExceeded`), causing the goroutine to exit as if the bot context was canceled. The check is now `ctx.Err() != nil` so only a real context cancellation stops polling.
|
||||
- Fixed the HTTP client timeout (45 s) being too close to the long-poll `getUpdates` timeout (30 s default), leaving insufficient margin for connection setup and response transfer. The client timeout is now derived from the configured `PollTimeout` plus a 60-second buffer.
|
||||
|
||||
## v1.0.1
|
||||
|
||||
### Fixed
|
||||
- Fixed webhook always accepting unauthenticated requests when `SecretToken` is not configured. A cryptographically random 32-byte token is now generated automatically when `SecretToken` is empty, so the webhook endpoint is always authenticated. The generated token is logged as a warning so the operator can record it.
|
||||
- Fixed `tgapi.NewAPI` and `tgapi.NewUploader` not installing token redaction on their managed loggers. The bot token is now masked as `<TOKEN>` in debug output even when the `tgapi` package is used standalone without the `laniakea.Bot` wrapper.
|
||||
|
||||
## v1.0.0
|
||||
|
||||
### Breaking Changes
|
||||
- Renamed `MsgContext` to `MessageContext` across the public API, including handler signatures (`CommandExecutor`, `MiddlewareExecutor`, scene handler types), all reply/edit/scene helpers, embedded fields on `SceneContext`, and documentation.
|
||||
- Removed the `NewPayload(...)` constructor. `NewCommand(...)` builds the underlying `Command[T]` for both `/-`commands and callback payloads; registration via `Plugin.AddPayload`/`Plugin.Payload` decides routing.
|
||||
- `MessageContext.Error(...)` no longer sends unclassified errors to the user. Only errors marked with `AsUserError(...)` are surfaced through the centralized reply path; everything else stays internal-only and is logged.
|
||||
- `Plugin.Close()` no longer closes a logger supplied through `Plugin.SetLogger(...)`. Only loggers created by the bot during `AddPlugins` registration are owned and closed; caller-supplied loggers remain the caller's responsibility.
|
||||
- Renamed final public APIs to idiomatic names before the stable release: `RunWebhookWithContext(...)`, `RunWebhook(...)`, `CloseWebhook()`, `BotWebhookOpts`, `NewBotWebhookOpts()`, `SetWebhookLogger(...)`, and `GetWebhookLogger()`.
|
||||
- Renamed plugin builder helpers from `NewCommand(...)` and `NewScene(...)` to `Command(...)` and `Scene(...)`; the surviving `NewCommand(...)` takes the command string before the executor.
|
||||
- Renamed command argument value constants to `CommandValueString`, `CommandValueInt`, `CommandValueBool`, and `CommandValueAny`; `NewCommandArg(...)` now defaults to unvalidated `CommandValueAny`.
|
||||
- Renamed runner builders from `Onetime(...)` and `Timeout(...)` to `Every(...)` and `Async(...)`; `Runner.Once()` is removed. Use the default configuration (every=0, async=true) for a fire-and-forget goroutine, or `Async(false)` for a synchronous blocking one-shot.
|
||||
- Renamed remaining public acronym/casing outliers including `AnswerCallback...`, `ParseMarkdownV2`, `ParseMarkdown`, `GetChatMemberCount`, `DropRateLimitOverflow`, `SetDropRateLimitOverflow`, and inline keyboard builder APIs.
|
||||
- Renamed `Observer` event delivery methods `OnReceiveUpdate` → `OnUpdateReceived` and `OnHandledUpdate` → `OnUpdateHandled` to match the `UpdateReceivedEvent`/`UpdateHandledEvent` names and the `OnX` pattern of all other observer methods.
|
||||
- `Scene.PluginName` is now unexported; it is assigned by the framework during plugin registration and must not be set by callers.
|
||||
- `SceneSession.Data` is now unexported; use the `Set`/`Get`/`HasData`/`ClearData`/`BindData`/`SaveData` helpers instead.
|
||||
- `BotPayloadType*` sentinels are now `const` instead of `var`; code that assigned to them will no longer compile.
|
||||
|
||||
### Bot API 10.0
|
||||
- Added full support for Telegram Bot API 10.0 types, methods, and update kinds.
|
||||
|
||||
### Added
|
||||
- Added `MessageContext.IsCallback()` and `MessageContext.HasPhoto()` helpers for callback-aware handler code.
|
||||
- Added `MessageContext.UpsertKeyboard(...)` and `MessageContext.UpsertKeyboardMarkdown(...)` helpers that edit callback messages, replace photo callback messages with a fresh chat message, and send a new chat message outside callback flow.
|
||||
- Added `CommandGroup`, `NewCommandGroup(...)`, `Plugin.CommandGroup(...)`, and `Plugin.AddCommandGroup(...)` helpers for registering prefixed command groups with shared middleware.
|
||||
- Added the `tgfmt` package with typed MarkdownV2, HTML, legacy Markdown formatting helpers, and a message entity builder.
|
||||
- Added `InlineKeyboardButtonBuilder.SetPayloadType(...)`, `InlineKeyboardButtonBuilder.SetCallbackData(...)`, and `MessageContext.NewInlineKeyboardButton(...)` helpers for payload-aware button building.
|
||||
- Added compact callback payload encoding through `BotPayloadCompact`, `BotPayloadCompactBase64`, compact inline keyboard builders, and matching `CallbackData` helpers.
|
||||
- Added `BotOpts.PollTimeout`, `BotOpts.SetPollTimeout(...)`, and the `POLL_TIMEOUT` environment variable to configure the long-polling `getUpdates` timeout (default 30 seconds).
|
||||
- Added `RateLimiter.Cleanup(idleThreshold)` to evict per-chat limiter state and expired chat cooldowns; the limiter now tracks per-chat last-seen time so long-running bots can bound memory through a periodic runner.
|
||||
- Added cached bot identity (`Bot.userID`) populated at `NewBot` so chat-admin policies and similar lookups reuse it instead of issuing a fresh `GetMe` request.
|
||||
- Added `tgapi.ResponseError` so Telegram API error codes, descriptions, and response parameters remain inspectable through returned errors.
|
||||
- Added nine exported webhook error sentinels — `ErrSetWebhookFailed`, `ErrBotAPINil`, `ErrBotWebhookOptsEmptyPath`, `ErrBotWebhookOptsPathNoSlash`, `ErrBotWebhookOptsPathHasQueryOrFragment`, `ErrBotWebhookOptsPathCollidesStatus`, `ErrBotWebhookTLSFilesIncomplete`, `ErrBotWebhookTLSFilesTooMany`, and `ErrStatusPathSecretRequired` — replacing the previous inline `errors.New(...)` calls so callers can match webhook startup errors with `errors.Is`.
|
||||
- Added `ErrInvalidPayload` for compact payload decoding failures so callers can distinguish malformed payload bytes from other decode errors.
|
||||
- Panics inside `Bot.handle` and the polling goroutine now emit an `ErrorEvent` through the observer so instrumentation sees runtime panics in addition to normal handler errors.
|
||||
|
||||
### Changed
|
||||
- Version metadata now reports the stable `v1.0.0` release instead of `v1.0.0-rc.16`.
|
||||
- Compact callback payload encoding now escapes `,`, `|`, and `\` in command and arg bytes so payloads containing those bytes round-trip without ambiguity. Note: the format coalesces "no args" with "single empty arg" — both encode as `cmd|` and decode to nil args.
|
||||
- `CallbackData.ToJSON()`, `ToBase64()`, `ToCompact()`, and `ToCompactBase64()` now all return an empty string on serialization failure; the previous `ToJSON()` fallback `{"cmd":""}` has been removed so encoder bugs surface visibly instead of routing to no handler.
|
||||
- Bot-level middleware blocks now emit a final `UpdateHandledEvent` with `Handled=false`, keeping observer update lifecycles balanced.
|
||||
- Plugin registration now warns when `AddCommand`, `AddPayload`, or `AddScene` overwrites an existing entry with the same name instead of silently replacing it.
|
||||
- `BotOpts`, `tgapi.APIOpts`, logger utilities, README, and wiki pages now document the final stable API names and configuration options consistently.
|
||||
- CI now checks formatting, tests, vet, and lint on both pushes and pull requests.
|
||||
|
||||
### Fixed
|
||||
- Fixed the update worker pool returning before in-flight handlers completed. `startUpdateWorkers` now calls `pool.StopAndWait()` so the bot waits for already-submitted tasks before runtime exit.
|
||||
- Fixed `RateLimiter.getChatLimiter` upgrading a held read lock to a write lock, which could deadlock under contention. The lookup now releases the read lock before acquiring the write lock and re-checks the map.
|
||||
- Fixed `RateLimiter` per-chat limiter and lock maps growing unbounded for the lifetime of long-running bots that serve many distinct chats.
|
||||
- Fixed `Draft.Push` mutating `Message` before validating the candidate length, leaving the draft in a half-mutated state when the candidate would exceed Telegram's limit. The candidate is now validated first; on failure the draft remains unchanged.
|
||||
- Fixed background runners running one extra iteration after context cancellation when both `ctx.Done()` and the ticker were ready in the same `select`.
|
||||
- Fixed `Plugin.Close()` double-closing a logger supplied by the caller through `SetLogger(...)`.
|
||||
- Fixed compact callback payload corruption for arguments containing `,` or `|` bytes.
|
||||
- Fixed `LoadOptsFromEnv` calling `os.Getenv("MAX_WORKERS")` twice when parsing the worker count.
|
||||
- Fixed `sceneRuntime` interface carrying a delegating `buildSceneKey` method that just forwarded to a package-level helper; `MessageContext` scene helpers now call the helper directly.
|
||||
- Fixed webhook startup so empty-secret warnings are logged only after the webhook logger is initialized.
|
||||
- Fixed webhook startup so a logger configured through `SetWebhookLogger(...)` is preserved.
|
||||
- Fixed long-polling 429 handling so `getUpdates` retries use Telegram `retry_after` directly and do not inflate later transient-error backoff.
|
||||
- Fixed `BotOptsFileJSON` silently dropping `PollTimeout` on round-trip; the field is now encoded and decoded correctly.
|
||||
- Fixed the `tgapi.Uploader` returning an ad-hoc error string on Telegram API failures; it now returns `*tgapi.ResponseError` matching the JSON API client, so `errors.As(err, &respErr)` works consistently for both upload and JSON paths.
|
||||
- Fixed webhook secret validation to use `subtle.ConstantTimeCompare` instead of a plain string equality check, removing the timing side-channel.
|
||||
- Fixed the `/status` handler returning HTTP 403 for a wrong secret, which disclosed endpoint existence; it now returns 404 uniformly for any unauthenticated request.
|
||||
|
||||
### Tests
|
||||
- Added regression coverage proving bot-level middleware blocks still complete the observer update lifecycle.
|
||||
- Added webhook runtime regression coverage for request enqueue through worker execution of a command handler.
|
||||
- Added regression coverage for inline callback keyboard upserts and callback target detection.
|
||||
- Added regression coverage for command group prefixing, middleware order, clone behavior, and plugin registration.
|
||||
- Added formatting coverage for escaping, composition, link destinations, HTML attributes, and legacy Markdown code blocks.
|
||||
- Added regression coverage for context-aware inline keyboard button payload encoding.
|
||||
- Added regression coverage for compact and Base64-encoded compact callback payload decoding.
|
||||
- Added regression coverage for long-polling `retry_after` handling on Telegram 429 responses.
|
||||
- Added regression coverage for compact callback payload round-tripping through `,`, `|`, and `\` separator bytes and a missing-separator decode error.
|
||||
- Added regression coverage for `Draft.Push` preserving the existing message when validation rejects the candidate.
|
||||
- Added regression coverage for `RateLimiter.Cleanup` evicting idle chat limiters and expired chat locks while leaving active state in place.
|
||||
- Updated `MessageContext.Error` tests so unclassified errors stay internal-only and only `AsUserError` reaches the user.
|
||||
- Added regression coverage for `BotOptsFileJSON` `PollTimeout` round-trip.
|
||||
- Added regression coverage proving the `tgapi.Uploader` surfaces `*tgapi.ResponseError` for Telegram 4xx responses.
|
||||
- Added regression coverage proving a panic inside `Bot.handle` emits an `ErrorEvent` through the observer.
|
||||
- Added regression coverage for the webhook `/status` endpoint rejecting wrong and same-length-but-different secrets with HTTP 404, and accepting the correct secret.
|
||||
- Added table-driven regression coverage for `parseCommand` with `/cmd@botname` stripping, bare commands, commands with arguments, and empty input.
|
||||
|
||||
## 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
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||

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

|
||||
|
||||
@@ -23,7 +23,7 @@ A lightweight, easy-to-use, and performant Telegram Bot API wrapper for Go. It s
|
||||
* **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(...)`.
|
||||
* **Polling and Webhook Runtime:** Run bots through long polling with `Run()` / `RunWithContext(...)` or through a bot-owned webhook server with `RunWebhookWithContext(...)`.
|
||||
|
||||
---
|
||||
|
||||
@@ -55,7 +55,7 @@ import (
|
||||
// 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 {
|
||||
func echo(ctx *laniakea.MessageContext, 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
|
||||
@@ -80,15 +80,15 @@ func main() {
|
||||
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"))
|
||||
// p.Command("echo", echo) creates a command that triggers the 'echo' function on the "/echo" command.
|
||||
p.Command("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 {
|
||||
p.Command("ping", func(ctx *laniakea.MessageContext, 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).
|
||||
@@ -112,25 +112,27 @@ func main() {
|
||||
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.
|
||||
4. `Command`: Creates and registers a command. The first argument is the command name without the slash, the second is the handler function (`func(*MessageContext, T) error`).
|
||||
5. **Handler Functions**: Receive *MessageContext (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.
|
||||
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.
|
||||
|
||||
For tests or custom transports, use `NewBotWithAPI[T](opts, api)` with a preconfigured `*tgapi.API`. The bot takes ownership of that client and closes it from `Bot.Close`; API transport, retry, and rate-limit fields in `BotOpts` do not override the supplied client.
|
||||
|
||||
## 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.
|
||||
- `BotOptsFileJSONCodec` for JSON files.
|
||||
|
||||
Example:
|
||||
|
||||
```go
|
||||
codec := laniakea.BotOptsFileJsonCodec{}
|
||||
codec := laniakea.BotOptsFileJSONCodec{}
|
||||
opts, err := laniakea.LoadBotOptsFile(codec, "config.json")
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
@@ -145,13 +147,13 @@ if err != nil {
|
||||
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.
|
||||
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(...)`.
|
||||
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.
|
||||
@@ -159,11 +161,11 @@ Use it when:
|
||||
- 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.
|
||||
- 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)
|
||||
|
||||
@@ -173,7 +175,7 @@ See the full guide in the wiki: [Webhook Runtime](https://git.scuroneko.dev/Scur
|
||||
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"))
|
||||
plugin.Command("ban", banUser)
|
||||
bot.AddPlugins(plugin)
|
||||
```
|
||||
|
||||
@@ -181,14 +183,14 @@ bot.AddPlugins(plugin)
|
||||
|
||||
A command is a function that handles a specific bot command (e.g., /start).
|
||||
```go
|
||||
func myHandler(ctx *laniakea.MsgContext, db *MyDB) error {
|
||||
func myHandler(ctx *laniakea.MessageContext, db *MyDB) error {
|
||||
// Access command arguments via ctx.Args ([]string)
|
||||
// Reply to the user: ctx.Answer("some text")
|
||||
return nil
|
||||
}
|
||||
```
|
||||
|
||||
### MsgContext
|
||||
### MessageContext
|
||||
|
||||
Provides access to the incoming message and useful reply methods:
|
||||
|
||||
@@ -198,12 +200,12 @@ Provides access to the incoming message and useful reply methods:
|
||||
- `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.
|
||||
- `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, keyboard *InlineKeyboard) *AnswerMessage`: Edits message with parse_mode none after clicking inline button.
|
||||
- `EditCallbackMarkdown(text string, keyboard *InlineKeyboard) *AnswerMessage`: 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.
|
||||
- Fields: `Text`, `Args`, `From`, `FromID`, `Msg`, `InlineMsgID`, `CallbackQueryID`, etc.
|
||||
- And more methods and fields!
|
||||
|
||||
### tgapi: API and Uploader
|
||||
@@ -217,6 +219,12 @@ This split keeps method intent explicit: JSON-only calls go through `API`, file
|
||||
|
||||
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.
|
||||
|
||||
Automatic retries after Telegram `429` responses are bounded to three by
|
||||
default; configure the cap with `NewAPIOpts(...).SetMaxRetries(...)`. Multipart
|
||||
uploads stream the encoded request instead of duplicating the complete body in
|
||||
memory. For downloads with an unknown size, use `OpenFileByLinkWithContext` or
|
||||
set an explicit bound with `GetFileByLinkLimitWithContext`.
|
||||
|
||||
### 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.
|
||||
@@ -238,7 +246,7 @@ Scenes model multi-step conversations inside a plugin. Each active scene is stor
|
||||
```go
|
||||
plugin := laniakea.NewPlugin[MyDB]("signup")
|
||||
|
||||
plugin.NewScene("signup").
|
||||
plugin.Scene("signup").
|
||||
SetScope(laniakea.SceneScopeUserChat).
|
||||
SetEntry("ask_name").
|
||||
OnStep("ask_name", func(ctx *laniakea.SceneContext, db MyDB) (laniakea.SceneResult, error) {
|
||||
@@ -268,6 +276,45 @@ plugin.NewScene("signup").
|
||||
- Use `SceneContext.SaveData(...)` and `SceneContext.BindData(...)` for JSON session state.
|
||||
- Use `SceneScopeUser`, `SceneScopeChat`, or `SceneScopeUserChat` depending on how widely a conversation should be shared.
|
||||
|
||||
## ⏱️ Runners
|
||||
|
||||
Runners are background tasks that execute alongside the bot runtime. They are registered before the bot starts and launched automatically when the bot starts.
|
||||
|
||||
```go
|
||||
import (
|
||||
"context"
|
||||
"time"
|
||||
)
|
||||
|
||||
// One-shot runner — fires once in a goroutine when the bot starts (default).
|
||||
bot.AddRunner(
|
||||
laniakea.NewRunner("seed-cache", func(b *laniakea.Bot[*MyDB]) error {
|
||||
return b.GetAppData().SeedCache()
|
||||
}),
|
||||
)
|
||||
|
||||
// Periodic runner — fires every 10 minutes in a goroutine.
|
||||
bot.AddRunner(
|
||||
laniakea.NewContextRunner("refresh-stats", func(ctx context.Context, b *laniakea.Bot[*MyDB]) error {
|
||||
return b.GetAppData().RefreshStats(ctx)
|
||||
}).Every(10 * time.Minute),
|
||||
)
|
||||
|
||||
// Synchronous one-shot — blocks runtime startup until it completes.
|
||||
bot.AddRunner(
|
||||
laniakea.NewRunner("migrate", func(b *laniakea.Bot[*MyDB]) error {
|
||||
return b.GetAppData().Migrate()
|
||||
}).Async(false),
|
||||
)
|
||||
```
|
||||
|
||||
Builder methods:
|
||||
- `Async(bool) *Runner[T]` — if `true` (default), runs in a goroutine; if `false`, blocks runtime startup.
|
||||
- `Every(time.Duration) *Runner[T]` — sets the repeat interval. Zero (default) means run once; positive value repeats. Periodic runners require `Async(true)`.
|
||||
|
||||
Prefer `NewContextRunner` for I/O and blocking work. Its context is canceled
|
||||
when polling or webhook execution stops, allowing shutdown to complete.
|
||||
|
||||
## 🧩 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.
|
||||
|
||||
@@ -275,7 +322,7 @@ Middleware are functions that run before a command handler. They are perfect for
|
||||
A middleware function has the same signature as a command handler, but it must return a bool:
|
||||
|
||||
```go
|
||||
func(ctx *MsgContext, db T) bool
|
||||
func(ctx *MessageContext, db T) bool
|
||||
```
|
||||
|
||||
- If it returns true, the next middleware (or the command) will be executed.
|
||||
@@ -288,14 +335,14 @@ Use `AddMiddleware` on a plugin to add one or more shared middleware functions.
|
||||
plugin := laniakea.NewPlugin[*MyDB]("admin")
|
||||
plugin.AddMiddleware(laniakea.NewMiddleware("logging", loggingMiddleware))
|
||||
plugin.AddMiddleware(laniakea.NewMiddleware("admin-only", adminOnlyMiddleware))
|
||||
plugin.AddCommand(plugin.NewCommand(banUser, "ban"))
|
||||
plugin.Command("ban", banUser)
|
||||
```
|
||||
|
||||
### Example Middlewares
|
||||
|
||||
1. Logging Middleware – logs every command execution.
|
||||
```go
|
||||
func loggingMiddleware(ctx *laniakea.MsgContext, db *MyDB) bool {
|
||||
func loggingMiddleware(ctx *laniakea.MessageContext, db *MyDB) bool {
|
||||
log.Printf("User %d executed command: %s", ctx.FromID, ctx.Msg.Text)
|
||||
return true // continue to next middleware/command
|
||||
}
|
||||
@@ -303,7 +350,7 @@ func loggingMiddleware(ctx *laniakea.MsgContext, db *MyDB) bool {
|
||||
|
||||
2. Admin-Only Middleware – restricts access to users with a specific role.
|
||||
```go
|
||||
func adminOnlyMiddleware(ctx *laniakea.MsgContext, db *MyDB) bool {
|
||||
func adminOnlyMiddleware(ctx *laniakea.MessageContext, db *MyDB) bool {
|
||||
if !db.IsAdmin(ctx.FromID) { // assume db has IsAdmin method
|
||||
ctx.Answer("⛔ Access denied. Admins only.")
|
||||
return false // stop execution
|
||||
@@ -313,14 +360,16 @@ func adminOnlyMiddleware(ctx *laniakea.MsgContext, db *MyDB) bool {
|
||||
```
|
||||
|
||||
### Important Notes
|
||||
- Middleware can modify the MsgContext (e.g., add custom fields) before the command runs.
|
||||
- Middleware can modify the MessageContext (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.
|
||||
- **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.
|
||||
- **Keyboard Validation**: Call `InlineKeyboard.GetValidated()` before sending untrusted or dynamically generated callback payloads; Telegram limits `callback_data` to 1–64 bytes.
|
||||
- **Rate Limiting**: Pass a configured utils.RateLimiter via BotOpts to handle Telegram's rate limits gracefully.
|
||||
- **Observers**: Runtime observer callbacks are dispatched asynchronously in order through a bounded queue. Slow observers do not block handlers; overload drops events with sampled warnings, and shutdown drains queued events.
|
||||
- **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.
|
||||
- **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.
|
||||
|
||||
+86
-36
@@ -2,7 +2,7 @@
|
||||
|
||||

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

|
||||
|
||||
@@ -24,7 +24,7 @@
|
||||
* **Встроенный ограничитель запросов (Rate Limiter):** Защитите бота от превышения лимитов Telegram API (с обработкой `retry_after`).
|
||||
* **Контекст данных:** Передавайте общие данные приложения или state в обработчики.
|
||||
* **Настраиваемый API:** Комбинируйте `Set...` и `Add...` helper-методы для понятной конфигурации, например `bot.SetErrorTemplate(...).AddPlugins(...)`.
|
||||
* **Polling и Webhook Runtime:** Запускайте бота через long polling с `Run()` / `RunWithContext(...)` или через webhook server, которым владеет сам бот, с `RunWebHookWithContext(...)`.
|
||||
* **Polling и Webhook Runtime:** Запускайте бота через long polling с `Run()` / `RunWithContext(...)` или через webhook server, которым владеет сам бот, с `RunWebhookWithContext(...)`.
|
||||
|
||||
---
|
||||
|
||||
@@ -56,7 +56,7 @@ import (
|
||||
// Она получает два параметра:
|
||||
// - ctx: контекст сообщения (содержит информацию о сообщении, отправителе, чате и т.д.)
|
||||
// - data: ваши общие данные приложения (здесь мы используем NoData — заглушку без общих зависимостей)
|
||||
func echo(ctx *laniakea.MsgContext, data laniakea.NoData) error {
|
||||
func echo(ctx *laniakea.MessageContext, data laniakea.NoData) error {
|
||||
// Отвечаем пользователю текстом, который он прислал, без префикса команды.
|
||||
// ctx.Text содержит сообщение пользователя, из которого удалена часть с командой.
|
||||
ctx.Answer(ctx.Text) // Ввод пользователя БЕЗ команды
|
||||
@@ -81,15 +81,15 @@ func main() {
|
||||
p := laniakea.NewPlugin[laniakea.NoData]("ping")
|
||||
|
||||
// 4. Добавляем команду в плагин.
|
||||
// p.NewCommand(echo, "echo") создаёт команду, которая вызывает функцию 'echo' по команде "/echo".
|
||||
p.AddCommand(p.NewCommand(echo, "echo"))
|
||||
// p.Command("echo", echo) создаёт команду, которая вызывает функцию 'echo' по команде "/echo".
|
||||
p.Command("echo", echo)
|
||||
|
||||
// 5. Добавляем ещё одну команду, используя анонимную функцию (замыкание).
|
||||
// Эта команда просто отвечает "Pong", когда пользователь отправляет "/ping".
|
||||
p.AddCommand(p.NewCommand(func(ctx *laniakea.MsgContext, data laniakea.NoData) error {
|
||||
p.Command("ping", func(ctx *laniakea.MessageContext, data laniakea.NoData) error {
|
||||
ctx.Answer("Pong")
|
||||
return nil
|
||||
}, "ping"))
|
||||
})
|
||||
|
||||
// 6. Настраиваем бота: задаём шаблон ошибки и добавляем плагин.
|
||||
// SetErrorTemplate устанавливает формат для сообщений об ошибках (где %s будет заменён на текст ошибки).
|
||||
@@ -113,25 +113,27 @@ func main() {
|
||||
1. `BotOpts`: Содержит конфигурацию, например, токен API.
|
||||
2. `NewBot[T]`: Создаёт экземпляр бота. Параметр типа T позволяет передать общие данные приложения (например, *sql.DB или контейнер сервисов), которые будут доступны во всех обработчиках. Используйте laniakea.NoData, если они не нужны.
|
||||
3. `NewPlugin`: Создаёт логическую группу для команд и Middleware.
|
||||
4. `AddCommand`: Регистрирует команду. Первый аргумент — функция-обработчик (`func(*MsgContext, T) error`), второй — имя команды (без слеша).
|
||||
5. **Функции-обработчики**: Получают *MsgContext (детали сообщения, методы типа Answer) и ваши данные приложения типа T, а ошибку возвращают для централизованной обработки.
|
||||
4. `Command`: Создаёт и регистрирует команду. Первый аргумент — имя команды без слеша, второй — функция-обработчик (`func(*MessageContext, T) error`).
|
||||
5. **Функции-обработчики**: Получают *MessageContext (детали сообщения, методы типа 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()` для следующего запуска создавайте новый бот.
|
||||
9. `RunWebhookWithContext(...)`: Запускает bot-owned webhook runtime, когда Telegram должен доставлять update по HTTP вместо long polling.
|
||||
10. Экземпляр `Bot` одноразовый. После завершения `Run()`, `RunWithContext()` или `RunWebhookWithContext()` для следующего запуска создавайте новый бот.
|
||||
|
||||
Для тестов или собственного transport используй `NewBotWithAPI[T](opts, api)` с заранее настроенным `*tgapi.API`. Бот становится владельцем этого клиента и закрывает его в `Bot.Close`; настройки transport, retry и rate limit из `BotOpts` не переопределяют переданный клиент.
|
||||
|
||||
## Конфиг из файла
|
||||
|
||||
`BotOpts` можно не только собирать вручную или из environment, но и загружать и сохранять через file codec API.
|
||||
|
||||
Из коробки доступно:
|
||||
- `BotOptsFileJsonCodec` для JSON-файлов.
|
||||
- `BotOptsFileJSONCodec` для JSON-файлов.
|
||||
|
||||
Пример:
|
||||
|
||||
```go
|
||||
codec := laniakea.BotOptsFileJsonCodec{}
|
||||
codec := laniakea.BotOptsFileJSONCodec{}
|
||||
opts, err := laniakea.LoadBotOptsFile(codec, "config.json")
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
@@ -146,13 +148,13 @@ if err != nil {
|
||||
Плейсхолдеры вида `{{ TG_TOKEN }}` внутри файла перед декодированием разворачиваются из переменных окружения.
|
||||
|
||||
Для других форматов можно реализовать собственный codec через интерфейс `BotOptsFileCodec`.
|
||||
Из коробки сейчас поддерживается только JSON. Если нужен другой формат, например TOML, используй `BotOptsFileJsonCodec` как эталонную реализацию собственного codec.
|
||||
Из коробки сейчас поддерживается только 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(...)`.
|
||||
Laniakea также поддерживает bot-owned webhook runtime через `RunWebhookWithContext(...)` и `RunWebhook(...)`.
|
||||
|
||||
Используй его, когда:
|
||||
- Telegram должен сам отправлять update на твой HTTP endpoint вместо polling.
|
||||
@@ -160,11 +162,11 @@ Laniakea также поддерживает bot-owned webhook runtime чере
|
||||
- Ты хочешь, чтобы 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()`.
|
||||
- Задавай `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)
|
||||
|
||||
@@ -174,7 +176,7 @@ Laniakea также поддерживает bot-owned webhook runtime чере
|
||||
|
||||
```go
|
||||
plugin := laniakea.NewPlugin[*MyDB]("admin")
|
||||
plugin.AddCommand(plugin.NewCommand(banUser, "ban"))
|
||||
plugin.Command("ban", banUser)
|
||||
bot.AddPlugins(plugin)
|
||||
```
|
||||
|
||||
@@ -182,14 +184,14 @@ bot.AddPlugins(plugin)
|
||||
Команда — это функция, которая обрабатывает конкретную команду бота (например, /start).
|
||||
|
||||
```go
|
||||
func myHandler(ctx *laniakea.MsgContext, db *MyDB) error {
|
||||
func myHandler(ctx *laniakea.MessageContext, db *MyDB) error {
|
||||
// Доступ к аргументам команды через ctx.Args ([]string)
|
||||
// Ответ пользователю: ctx.Answer("какой-то текст")
|
||||
return nil
|
||||
}
|
||||
```
|
||||
|
||||
### Контекст сообщения (MsgContext)
|
||||
### Контекст сообщения (MessageContext)
|
||||
Предоставляет доступ к входящему сообщению и полезные методы для ответа:
|
||||
|
||||
- `Answer(text string)`: Отправляет сообщение с parse_mode none.
|
||||
@@ -198,12 +200,12 @@ func myHandler(ctx *laniakea.MsgContext, db *MyDB) error {
|
||||
- `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-кнопки.
|
||||
- `AnswerPhoto(photoID, text string) *AnswerMessage`: Отправляет фотографию с подписью и parse_mode none.
|
||||
- `AnswerPhotoMarkdown(photoID, text string) *AnswerMessage`: Отправляет фотографию с подписью, отформатированной MarkdownV2 (экранирование на вашей стороне).
|
||||
- `EditCallback(text string, keyboard *InlineKeyboard) *AnswerMessage`: Редактирует сообщение с `parse_mode` none после нажатия inline-кнопки.
|
||||
- `EditCallbackMarkdown(text string, keyboard *InlineKeyboard) *AnswerMessage`: Редактирует сообщение в формате MarkdownV2 (экранирование на вашей стороне) после нажатия inline-кнопки.
|
||||
- `SendAction(action tgapi.ChatActionType)`: Отправляет действие "печатает", "загружает фото" и т.д.
|
||||
- Поля: `Text`, `Args`, `From`, `FromID`, `Msg`, `InlineMsgId`, `CallbackQueryId` и другие.
|
||||
- Поля: `Text`, `Args`, `From`, `FromID`, `Msg`, `InlineMsgID`, `CallbackQueryID` и другие.
|
||||
- И много других методов и полей!
|
||||
|
||||
### App Data
|
||||
@@ -226,7 +228,7 @@ bot.SetAppData(db)
|
||||
```go
|
||||
plugin := laniakea.NewPlugin[MyDB]("signup")
|
||||
|
||||
plugin.NewScene("signup").
|
||||
plugin.Scene("signup").
|
||||
SetScope(laniakea.SceneScopeUserChat).
|
||||
SetEntry("ask_name").
|
||||
OnStep("ask_name", func(ctx *laniakea.SceneContext, db MyDB) (laniakea.SceneResult, error) {
|
||||
@@ -256,6 +258,45 @@ plugin.NewScene("signup").
|
||||
- Для JSON-состояния сцены используйте `SceneContext.SaveData(...)` и `SceneContext.BindData(...)`.
|
||||
- Выбирайте `SceneScopeUser`, `SceneScopeChat` или `SceneScopeUserChat` в зависимости от того, насколько широко должен разделяться диалог.
|
||||
|
||||
## ⏱️ Раннеры (Runners)
|
||||
|
||||
Раннеры — фоновые задачи, которые выполняются вместе с bot runtime. Они регистрируются до запуска бота и автоматически запускаются при старте.
|
||||
|
||||
```go
|
||||
import (
|
||||
"context"
|
||||
"time"
|
||||
)
|
||||
|
||||
// Одноразовый раннер — запускается один раз в горутине при старте (по умолчанию).
|
||||
bot.AddRunner(
|
||||
laniakea.NewRunner("seed-cache", func(b *laniakea.Bot[*MyDB]) error {
|
||||
return b.GetAppData().SeedCache()
|
||||
}),
|
||||
)
|
||||
|
||||
// Периодический раннер — запускается каждые 10 минут в горутине.
|
||||
bot.AddRunner(
|
||||
laniakea.NewContextRunner("refresh-stats", func(ctx context.Context, b *laniakea.Bot[*MyDB]) error {
|
||||
return b.GetAppData().RefreshStats(ctx)
|
||||
}).Every(10 * time.Minute),
|
||||
)
|
||||
|
||||
// Синхронный одноразовый — блокирует запуск runtime до завершения.
|
||||
bot.AddRunner(
|
||||
laniakea.NewRunner("migrate", func(b *laniakea.Bot[*MyDB]) error {
|
||||
return b.GetAppData().Migrate()
|
||||
}).Async(false),
|
||||
)
|
||||
```
|
||||
|
||||
Методы builder:
|
||||
- `Async(bool) *Runner[T]` — если `true` (по умолчанию), запускается в горутине; если `false`, блокирует запуск runtime.
|
||||
- `Every(time.Duration) *Runner[T]` — задаёт интервал повторного запуска. Ноль (по умолчанию) означает одноразовый запуск; положительное значение — периодический. Периодические раннеры требуют `Async(true)`.
|
||||
|
||||
Для I/O и блокирующей работы предпочитайте `NewContextRunner`. Его context
|
||||
отменяется при остановке polling или webhook runtime, поэтому shutdown может завершиться.
|
||||
|
||||
### tgapi: API и Uploader
|
||||
|
||||
В `tgapi` есть два клиента:
|
||||
@@ -265,6 +306,13 @@ plugin.NewScene("signup").
|
||||
|
||||
Для продвинутых сценариев `tgapi.NewRequest(...)` и `tgapi.NewUploaderRequest(...)` остаются публичными low-level escape hatch API. Они менее безопасны, чем типизированные helper-методы: вызывающая сторона сама отвечает за корректное имя Telegram-метода и совместимые типы параметров/ответа.
|
||||
|
||||
Автоматические повторы после ответа Telegram `429` по умолчанию ограничены
|
||||
тремя; предел настраивается через `NewAPIOpts(...).SetMaxRetries(...)`.
|
||||
Multipart upload кодируется потоком без второй полной копии request body в
|
||||
памяти. Для download неизвестного размера используйте
|
||||
`OpenFileByLinkWithContext` либо задайте явный предел через
|
||||
`GetFileByLinkLimitWithContext`.
|
||||
|
||||
## 🧩 Промежуточные слои (Middleware)
|
||||
Middleware — это функции, которые выполняются перед обработчиком команды. Они идеально подходят для сквозных задач, таких как логирование, контроль доступа, ограничение скорости запросов или модификация контекста.
|
||||
|
||||
@@ -272,7 +320,7 @@ Middleware — это функции, которые выполняются пе
|
||||
Функция middleware имеет ту же сигнатуру, что и обработчик команды, но должна возвращать bool:
|
||||
|
||||
```go
|
||||
func(ctx *MsgContext, db T) bool
|
||||
func(ctx *MessageContext, db T) bool
|
||||
```
|
||||
|
||||
- Если возвращается true, выполняется следующий middleware (или сама команда).
|
||||
@@ -285,14 +333,14 @@ func(ctx *MsgContext, db T) bool
|
||||
plugin := laniakea.NewPlugin[*MyDB]("admin")
|
||||
plugin.AddMiddleware(laniakea.NewMiddleware("logging", loggingMiddleware))
|
||||
plugin.AddMiddleware(laniakea.NewMiddleware("admin-only", adminOnlyMiddleware))
|
||||
plugin.AddCommand(plugin.NewCommand(banUser, "ban"))
|
||||
plugin.Command("ban", banUser)
|
||||
```
|
||||
|
||||
### Примеры middleware
|
||||
|
||||
1. Логирующий middleware – логирует каждое выполнение команды.
|
||||
```go
|
||||
func loggingMiddleware(ctx *laniakea.MsgContext, db *MyDB) bool {
|
||||
func loggingMiddleware(ctx *laniakea.MessageContext, db *MyDB) bool {
|
||||
log.Printf("Пользователь %d выполнил команду: %s", ctx.FromID, ctx.Msg.Text)
|
||||
return true // продолжаем к следующему middleware/команде
|
||||
}
|
||||
@@ -300,7 +348,7 @@ func loggingMiddleware(ctx *laniakea.MsgContext, db *MyDB) bool {
|
||||
|
||||
2. Middleware только для администраторов – ограничивает доступ пользователям с определённой ролью.
|
||||
```go
|
||||
func adminOnlyMiddleware(ctx *laniakea.MsgContext, db *MyDB) bool {
|
||||
func adminOnlyMiddleware(ctx *laniakea.MessageContext, db *MyDB) bool {
|
||||
if !db.IsAdmin(ctx.FromID) { // предполагается, что db имеет метод IsAdmin
|
||||
ctx.Answer("⛔ Доступ запрещён. Только для администраторов.")
|
||||
return false // останавливаем выполнение
|
||||
@@ -310,14 +358,16 @@ func adminOnlyMiddleware(ctx *laniakea.MsgContext, db *MyDB) bool {
|
||||
```
|
||||
|
||||
### Важные замечания
|
||||
- Middleware может изменять MsgContext (например, добавлять пользовательские поля) перед запуском команды.
|
||||
- Middleware может изменять MessageContext (например, добавлять пользовательские поля) перед запуском команды.
|
||||
|
||||
## ⚙️ Расширенная настройка
|
||||
- **Инлайн-клавиатуры**: Создавайте клавиатуры с помощью `laniakea.NewInlineKeyboardJson`, `laniakea.NewInlineKeyboardBase64` или `laniakea.NewInlineKeyboard`. `Bot.SetPayloadType(...)` задаёт payload format по умолчанию, а `InlineKeyboard.SetPayloadType(...)` переопределяет его для конкретной клавиатуры.
|
||||
- **Инлайн-клавиатуры**: Создавайте клавиатуры с помощью `laniakea.NewInlineKeyboardJSON`, `laniakea.NewInlineKeyboardBase64` или `laniakea.NewInlineKeyboard`. `Bot.SetPayloadType(...)` задаёт payload format по умолчанию, а `InlineKeyboard.SetPayloadType(...)` переопределяет его для конкретной клавиатуры.
|
||||
- **Валидация клавиатур**: Вызывайте `InlineKeyboard.GetValidated()` перед отправкой недоверенных или динамически собранных callback payload; Telegram ограничивает `callback_data` диапазоном 1–64 байта.
|
||||
- **Ограничение запросов**: Передайте настроенный `utils.RateLimiter` через `BotOpts` для корректной обработки лимитов Telegram.
|
||||
- **Observer**: Во время runtime callbacks observer выполняются асинхронно и по порядку через ограниченную очередь. Медленный observer не блокирует handlers; при переполнении события отбрасываются с редкими предупреждениями, а shutdown обрабатывает уже поставленные в очередь события.
|
||||
- **Локализация**: `L10n` безопасен для конкурентного использования после подключения к боту.
|
||||
- **Пользовательские update handlers**: Используйте `plugin.AddUpdateHandler(...)` для Telegram update types вне command/payload flow.
|
||||
- **Жизненный цикл**: `RunWithContext(...)` и `RunWebHookWithContext(...)` не вызывают `Close()` автоматически. Завершайте бот явно и создавайте новый `Bot` для следующего запуска.
|
||||
- **Жизненный цикл**: `RunWithContext(...)` и `RunWebhookWithContext(...)` не вызывают `Close()` автоматически. Завершайте бот явно и создавайте новый `Bot` для следующего запуска.
|
||||
|
||||
## Обработка Telegram Updates
|
||||
- Команды и payload-ы обрабатываются через плагины.
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# TODO
|
||||
|
||||
---
|
||||
|
||||
The framework backlog has moved to the wiki.
|
||||
|
||||
Primary page:
|
||||
|
||||
@@ -4,13 +4,14 @@ import (
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/extypes"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||
"git.scuroneko.dev/scuroneko/slog"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
// AppData is the generic shared application data type injected into bots,
|
||||
@@ -36,22 +37,26 @@ type AppData any
|
||||
// data.
|
||||
//
|
||||
// Use Bot[NoData] to indicate no shared dependency injection is required.
|
||||
type NoData struct{ AppData }
|
||||
type NoData struct{}
|
||||
|
||||
// AppDataLogger builds a slog.LoggerWriter from injected application data.
|
||||
// AppDataLogger builds a sneklog.LoggerWriter from injected application data.
|
||||
//
|
||||
// Use it when shared application data exposes a log sink or adapter that should
|
||||
// receive framework logs.
|
||||
type AppDataLogger[T AppData] func(data T) slog.LoggerWriter
|
||||
type AppDataLogger[T AppData] func(data T) sneklog.LoggerWriter
|
||||
|
||||
// BotPayloadType defines the serialization format for callback data payloads.
|
||||
type BotPayloadType string
|
||||
|
||||
var (
|
||||
const (
|
||||
// BotPayloadBase64 encodes callback data as a Base64 string.
|
||||
BotPayloadBase64 BotPayloadType = "base64"
|
||||
// BotPayloadJson encodes callback data as a JSON string.
|
||||
BotPayloadJson BotPayloadType = "json"
|
||||
// BotPayloadJSON encodes callback data as a JSON string.
|
||||
BotPayloadJSON BotPayloadType = "json"
|
||||
// BotPayloadCompact encodes callback data as a compact delimited string.
|
||||
BotPayloadCompact BotPayloadType = "compact"
|
||||
// BotPayloadCompactBase64 encodes compact callback data as a Base64 string.
|
||||
BotPayloadCompactBase64 BotPayloadType = "compact-base64"
|
||||
)
|
||||
|
||||
var (
|
||||
@@ -59,7 +64,7 @@ var (
|
||||
ErrNoPrefixes = errors.New("no prefixes defined")
|
||||
// ErrNoPlugins reports that the bot was started without any registered plugins.
|
||||
ErrNoPlugins = errors.New("no plugins defined")
|
||||
// ErrBotAlreadyRun reports that Run, RunWithContext, or RunWebHookWithContext was called more than once.
|
||||
// ErrBotAlreadyRun reports that Run, RunWithContext, or RunWebhookWithContext was called more than once.
|
||||
ErrBotAlreadyRun = errors.New("bot can only be run once")
|
||||
|
||||
// ErrTokenRequired reports that BotOpts.Token was empty.
|
||||
@@ -78,22 +83,31 @@ var (
|
||||
// - Localization and draft message support
|
||||
//
|
||||
// Runtime accessors are safe for concurrent use. Configure the bot before Run,
|
||||
// RunWithContext, or RunWebHookWithContext.
|
||||
// A Bot is single-use: after Run, RunWithContext, or RunWebHookWithContext returns,
|
||||
// RunWithContext, or RunWebhookWithContext.
|
||||
// A Bot is single-use: after Run, RunWithContext, or RunWebhookWithContext returns,
|
||||
// create a new Bot for the next session.
|
||||
type Bot[T AppData] struct {
|
||||
token string
|
||||
debug bool
|
||||
errorTemplate string
|
||||
userID int64
|
||||
username string
|
||||
payloadType BotPayloadType
|
||||
strictPayloadType bool
|
||||
maxWorkers int
|
||||
pollTimeout int // Long-polling timeout in seconds for getUpdates
|
||||
|
||||
logger *slog.Logger // Main bot logger (JSON stdout + optional file)
|
||||
RequestLogger *slog.Logger // Optional request-level API logging
|
||||
webHookLogger *slog.Logger // Webhook logger. Available only after Bot.RunWebHookWithContext.
|
||||
extraLoggers extypes.Slice[*slog.Logger] // API, Uploader, and custom loggers
|
||||
logFormat utils.LogFormat
|
||||
logFormatter *sneklog.Formatter
|
||||
logger *sneklog.Logger // Main bot logger (JSON stdout + optional file)
|
||||
requestLogger *sneklog.Logger // Optional request-level API logging
|
||||
useReqLogger bool
|
||||
webhookLogger *sneklog.Logger // Webhook logger. Available only after Bot.RunWebhookWithContext.
|
||||
loggerOwned bool
|
||||
requestLoggerOwned bool
|
||||
webhookLoggerOwned bool
|
||||
detachedOwnedLoggers []*sneklog.Logger
|
||||
extraLoggers extypes.Slice[*sneklog.Logger] // API, Uploader, and custom loggers
|
||||
|
||||
plugins []Plugin[T] // Command/event handlers
|
||||
middlewares []Middleware[T] // Pre-processing filters (sorted by order)
|
||||
@@ -105,6 +119,7 @@ type Bot[T AppData] struct {
|
||||
l10n *L10n // Localization manager
|
||||
draftProvider *DraftProvider // Draft message builder
|
||||
observer Observer // Optional event observer for instrumentation
|
||||
observerAsync *observerDispatcher
|
||||
|
||||
appData T // Injected application data
|
||||
hasAppData bool
|
||||
@@ -112,6 +127,7 @@ type Bot[T AppData] struct {
|
||||
|
||||
sessionStore SessionStore // Session store for scene management
|
||||
sceneScopePriority []SceneScope
|
||||
sceneLocks sceneKeyLocker
|
||||
|
||||
updateOffsetMu sync.Mutex
|
||||
updateOffset int // Last processed update ID
|
||||
@@ -119,6 +135,7 @@ type Bot[T AppData] struct {
|
||||
updateQueue chan *tgapi.Update // Internal queue for processing updates
|
||||
runnerOnceWG sync.WaitGroup // Tracks one-time async runners
|
||||
runnerBgWG sync.WaitGroup // Tracks background async runners
|
||||
middlewareWG sync.WaitGroup // Tracks asynchronous middleware callbacks
|
||||
runStateMu sync.Mutex
|
||||
running bool
|
||||
ran bool
|
||||
@@ -145,6 +162,20 @@ func (bot *Bot[T]) configMutable(method string) bool {
|
||||
// - Sets up DraftProvider with random IDs
|
||||
// - Adds API and Uploader loggers to extraLoggers
|
||||
func NewBot[T any](opts *BotOpts) (*Bot[T], error) {
|
||||
return newBot[T](opts, nil)
|
||||
}
|
||||
|
||||
// NewBotWithAPI creates a Bot using a preconfigured API client.
|
||||
// The Bot takes ownership of api and closes it from Bot.Close. API transport,
|
||||
// retry, and rate-limit fields in opts do not reconfigure the supplied client.
|
||||
func NewBotWithAPI[T any](opts *BotOpts, api *tgapi.API) (*Bot[T], error) {
|
||||
if api == nil {
|
||||
return nil, ErrAPIIsNil
|
||||
}
|
||||
return newBot[T](opts, api)
|
||||
}
|
||||
|
||||
func newBot[T any](opts *BotOpts, api *tgapi.API) (*Bot[T], error) {
|
||||
if opts == nil {
|
||||
return nil, ErrOptsIsNil
|
||||
}
|
||||
@@ -157,42 +188,60 @@ func NewBot[T any](opts *BotOpts) (*Bot[T], error) {
|
||||
limiter := utils.NewRateLimiter()
|
||||
limiter.SetGlobalRate(opts.RateLimit)
|
||||
|
||||
apiOpts := tgapi.NewAPIOpts(opts.Token).
|
||||
SetAPIUrl(opts.APIUrl).
|
||||
UseTestServer(opts.UseTestServer).
|
||||
SetLimiter(limiter).
|
||||
SetLimiterDrop(opts.DropRLOverflow)
|
||||
api := tgapi.NewAPI(apiOpts)
|
||||
uploader := tgapi.NewUploader(api)
|
||||
|
||||
prefixes := opts.Prefixes
|
||||
if len(prefixes) == 0 {
|
||||
prefixes = []string{"/"}
|
||||
}
|
||||
|
||||
workers := 32
|
||||
if opts.MaxWorkers > 0 {
|
||||
workers = opts.MaxWorkers
|
||||
}
|
||||
|
||||
pollTimeout := 30
|
||||
if opts.PollTimeout > 0 {
|
||||
pollTimeout = opts.PollTimeout
|
||||
}
|
||||
|
||||
// HTTP client timeout must exceed pollTimeout to avoid spurious deadline
|
||||
// errors that the polling loop would misinterpret as context cancellation.
|
||||
httpTimeout := time.Duration(pollTimeout)*time.Second + 60*time.Second
|
||||
if api == nil {
|
||||
apiOpts := tgapi.NewAPIOpts(opts.Token).
|
||||
SetAPIURL(opts.APIURL).
|
||||
UseTestServer(opts.UseTestServer).
|
||||
SetLimiter(limiter).
|
||||
SetDropRateLimitOverflow(opts.DropRateLimitOverflow).
|
||||
SetLogFormat(opts.LogFormat).
|
||||
SetLogFormatter(opts.LogFormatter).
|
||||
SetHTTPClient(&http.Client{Timeout: httpTimeout})
|
||||
api = tgapi.NewAPI(apiOpts)
|
||||
}
|
||||
uploader := tgapi.NewUploader(api)
|
||||
|
||||
prefixes := append([]string(nil), opts.Prefixes...)
|
||||
if len(prefixes) == 0 {
|
||||
prefixes = []string{"/"}
|
||||
}
|
||||
|
||||
bot := &Bot[T]{
|
||||
updateOffset: 0,
|
||||
errorTemplate: "%s",
|
||||
payloadType: BotPayloadBase64,
|
||||
strictPayloadType: opts.StrictPayloadType,
|
||||
maxWorkers: workers,
|
||||
pollTimeout: pollTimeout,
|
||||
updateQueue: updateQueue,
|
||||
api: api,
|
||||
uploader: uploader,
|
||||
debug: opts.Debug,
|
||||
prefixes: prefixes,
|
||||
token: opts.Token,
|
||||
plugins: make([]Plugin[T], 0),
|
||||
updateTypes: append([]tgapi.UpdateType{}, opts.UpdateTypes...),
|
||||
runners: make([]Runner[T], 0),
|
||||
extraLoggers: make([]*slog.Logger, 0),
|
||||
l10n: &L10n{},
|
||||
draftProvider: NewRandomDraftProvider(api),
|
||||
logFormat: opts.LogFormat,
|
||||
logFormatter: opts.LogFormatter,
|
||||
useReqLogger: opts.UseRequestLogger,
|
||||
|
||||
plugins: make([]Plugin[T], 0),
|
||||
updateTypes: append([]tgapi.UpdateType{}, opts.UpdateTypes...),
|
||||
runners: make([]Runner[T], 0),
|
||||
extraLoggers: make([]*sneklog.Logger, 0),
|
||||
l10n: &L10n{},
|
||||
draftProvider: NewRandomDraftProvider(api),
|
||||
|
||||
sessionStore: NewMemorySessionStore(),
|
||||
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||
@@ -204,10 +253,21 @@ func NewBot[T any](opts *BotOpts) (*Bot[T], error) {
|
||||
if len(opts.ErrorTemplate) > 0 {
|
||||
bot.errorTemplate = opts.ErrorTemplate
|
||||
}
|
||||
if len(opts.LoggerBasePath) == 0 {
|
||||
opts.LoggerBasePath = "./"
|
||||
loggerOpts := *opts
|
||||
if len(loggerOpts.LoggerBasePath) == 0 {
|
||||
loggerOpts.LoggerBasePath = "./"
|
||||
}
|
||||
bot.initLoggers(&loggerOpts)
|
||||
|
||||
if opts.FileConfigVersion > 0 && opts.FileConfigVersion < ConfigVersion {
|
||||
bot.logger.Warnln(
|
||||
fmt.Sprintf(
|
||||
"Config file version %d is older than library version %d; please update your config file to access new features and avoid compatibility issues",
|
||||
opts.FileConfigVersion,
|
||||
ConfigVersion,
|
||||
),
|
||||
)
|
||||
}
|
||||
bot.initLoggers(opts)
|
||||
|
||||
// Fetch bot info to validate token and get username
|
||||
u, err := api.GetMe()
|
||||
@@ -216,25 +276,97 @@ func NewBot[T any](opts *BotOpts) (*Bot[T], error) {
|
||||
return nil, err
|
||||
}
|
||||
bot.username = Val(u.Username, "")
|
||||
bot.userID = u.ID
|
||||
if bot.username == "" {
|
||||
bot.logger.Warn("Can't get bot username. Named command handlers won't work!")
|
||||
}
|
||||
bot.logger.Infoln(fmt.Sprintf("Authorized as %s (@%s)", u.FirstName, Val(u.Username, "unknown")))
|
||||
bot.logger.Debugln("Bot initialized with configuration:", fmt.Sprintf("%+v", opts))
|
||||
|
||||
return bot, nil
|
||||
}
|
||||
|
||||
// SetLogger replaces the main bot logger before runtime starts.
|
||||
func (bot *Bot[T]) SetLogger(l *sneklog.Logger) *Bot[T] {
|
||||
if !bot.configMutable("SetLogger") {
|
||||
return bot
|
||||
}
|
||||
if l == nil {
|
||||
if bot.logger != nil {
|
||||
bot.logger.Warnln("SetLogger called with nil logger; nothing changed")
|
||||
}
|
||||
return bot
|
||||
}
|
||||
if l == bot.logger {
|
||||
return bot
|
||||
}
|
||||
bot.addTokenReplacer(l)
|
||||
bot.closeReplacedLogger(bot.logger, bot.loggerOwned, l, bot.requestLogger, bot.webhookLogger)
|
||||
bot.logger = l
|
||||
bot.loggerOwned = false
|
||||
return bot
|
||||
}
|
||||
|
||||
// SetRequestLogger replaces the request-level logger before runtime starts.
|
||||
func (bot *Bot[T]) SetRequestLogger(l *sneklog.Logger) *Bot[T] {
|
||||
if !bot.configMutable("SetRequestLogger") {
|
||||
return bot
|
||||
}
|
||||
if l == nil {
|
||||
if bot.logger != nil {
|
||||
bot.logger.Warnln("SetRequestLogger called with nil logger; nothing changed")
|
||||
}
|
||||
return bot
|
||||
}
|
||||
if l == bot.requestLogger {
|
||||
return bot
|
||||
}
|
||||
bot.addTokenReplacer(l)
|
||||
bot.closeReplacedLogger(bot.requestLogger, bot.requestLoggerOwned, l, bot.logger, bot.webhookLogger)
|
||||
bot.requestLogger = l
|
||||
bot.requestLoggerOwned = false
|
||||
return bot
|
||||
}
|
||||
|
||||
// SetWebhookLogger replaces the webhook logger before runtime starts.
|
||||
func (bot *Bot[T]) SetWebhookLogger(l *sneklog.Logger) *Bot[T] {
|
||||
if !bot.configMutable("SetWebhookLogger") {
|
||||
return bot
|
||||
}
|
||||
if l == nil {
|
||||
if bot.logger != nil {
|
||||
bot.logger.Warnln("SetWebhookLogger called with nil logger; nothing changed")
|
||||
}
|
||||
return bot
|
||||
}
|
||||
if l == bot.webhookLogger {
|
||||
return bot
|
||||
}
|
||||
bot.addTokenReplacer(l)
|
||||
bot.closeReplacedLogger(bot.webhookLogger, bot.webhookLoggerOwned, l, bot.logger, bot.requestLogger)
|
||||
bot.webhookLogger = l
|
||||
bot.webhookLoggerOwned = false
|
||||
return bot
|
||||
}
|
||||
|
||||
// GetAPI returns the underlying Telegram Bot API client.
|
||||
func (bot *Bot[T]) GetAPI() *tgapi.API { return bot.api }
|
||||
|
||||
// GetUploader returns the underlying file uploader client.
|
||||
func (bot *Bot[T]) GetUploader() *tgapi.Uploader { return bot.uploader }
|
||||
|
||||
// Close gracefully shuts down bot-owned resources.
|
||||
//
|
||||
// Close shuts down, in order:
|
||||
// - The asynchronous observer dispatcher, after draining queued events
|
||||
// - Registered plugins via Plugin.Close
|
||||
// - Webhook logger (if initialized)
|
||||
// - Uploader (waits for pending uploads)
|
||||
// - API client internals
|
||||
// - Uploader logger resources
|
||||
// - API client internals, after pending API and upload requests complete
|
||||
// - RequestLogger (if enabled)
|
||||
// - Main logger
|
||||
//
|
||||
// RunWithContext and RunWebHookWithContext do not call Close automatically.
|
||||
// RunWithContext and RunWebhookWithContext do not call Close automatically.
|
||||
// The caller is responsible for invoking Close after runtime returns to release
|
||||
// these resources.
|
||||
//
|
||||
@@ -250,17 +382,34 @@ func (bot *Bot[T]) Close() error {
|
||||
}
|
||||
e = append(e, err)
|
||||
}
|
||||
observerCtx, observerCancel := context.WithTimeout(context.Background(), observerShutdownTimeout)
|
||||
logCloseErr(bot.stopObserverDispatcher(observerCtx))
|
||||
observerCancel()
|
||||
|
||||
for _, p := range bot.plugins {
|
||||
if err := p.Close(); err != nil {
|
||||
e = append(e, err)
|
||||
}
|
||||
}
|
||||
if bot.webHookLogger != nil {
|
||||
if err := bot.webHookLogger.Close(); err != nil {
|
||||
logCloseErr(err)
|
||||
closedLoggers := make(map[*sneklog.Logger]struct{}, 3)
|
||||
closeOwnedLogger := func(logger *sneklog.Logger, owned bool) {
|
||||
if logger == nil || !owned {
|
||||
return
|
||||
}
|
||||
bot.webHookLogger = nil
|
||||
if _, exists := closedLoggers[logger]; exists {
|
||||
return
|
||||
}
|
||||
closedLoggers[logger] = struct{}{}
|
||||
logCloseErr(logger.Close())
|
||||
}
|
||||
for _, logger := range bot.detachedOwnedLoggers {
|
||||
closeOwnedLogger(logger, true)
|
||||
}
|
||||
bot.detachedOwnedLoggers = nil
|
||||
if bot.webhookLogger != nil {
|
||||
closeOwnedLogger(bot.webhookLogger, bot.webhookLoggerOwned)
|
||||
bot.webhookLogger = nil
|
||||
bot.webhookLoggerOwned = false
|
||||
}
|
||||
if bot.uploader != nil {
|
||||
if err := bot.uploader.Close(); err != nil {
|
||||
@@ -272,15 +421,15 @@ func (bot *Bot[T]) Close() error {
|
||||
logCloseErr(err)
|
||||
}
|
||||
}
|
||||
if bot.RequestLogger != nil {
|
||||
if err := bot.RequestLogger.Close(); err != nil {
|
||||
logCloseErr(err)
|
||||
}
|
||||
if bot.requestLogger != nil {
|
||||
closeOwnedLogger(bot.requestLogger, bot.requestLoggerOwned)
|
||||
bot.requestLogger = nil
|
||||
bot.requestLoggerOwned = false
|
||||
}
|
||||
if bot.logger != nil {
|
||||
if err := bot.logger.Close(); err != nil {
|
||||
e = append(e, err)
|
||||
}
|
||||
closeOwnedLogger(bot.logger, bot.loggerOwned)
|
||||
bot.logger = nil
|
||||
bot.loggerOwned = false
|
||||
}
|
||||
return errors.Join(e...)
|
||||
}
|
||||
@@ -311,20 +460,26 @@ func (bot *Bot[T]) SetUpdateOffset(offset int) {
|
||||
}
|
||||
|
||||
// GetLogger returns the main bot logger.
|
||||
func (bot *Bot[T]) GetLogger() *slog.Logger { return bot.logger }
|
||||
func (bot *Bot[T]) GetLogger() *sneklog.Logger { return bot.logger }
|
||||
|
||||
// GetRequestLogger returns the request-level logger, if configured.
|
||||
func (bot *Bot[T]) GetRequestLogger() *sneklog.Logger { return bot.requestLogger }
|
||||
|
||||
// GetWebhookLogger returns the webhook logger, if configured.
|
||||
func (bot *Bot[T]) GetWebhookLogger() *sneklog.Logger { return bot.webhookLogger }
|
||||
|
||||
// GetLoggerLevel returns the effective log level derived from the bot's debug
|
||||
// flag.
|
||||
func (bot *Bot[T]) GetLoggerLevel() slog.LogLevel {
|
||||
level := slog.FATAL
|
||||
func (bot *Bot[T]) GetLoggerLevel() sneklog.LogLevel {
|
||||
level := sneklog.FATAL
|
||||
if bot.debug {
|
||||
level = slog.DEBUG
|
||||
level = sneklog.DEBUG
|
||||
}
|
||||
return level
|
||||
}
|
||||
|
||||
// L10n translates a key in the given language.
|
||||
// Returns empty string if translation not found.
|
||||
// Returns key if translation not found.
|
||||
func (bot *Bot[T]) L10n(lang, key string) string {
|
||||
return bot.l10n.Translate(lang, key)
|
||||
}
|
||||
@@ -343,7 +498,7 @@ func (bot *Bot[T]) L10n(lang, key string) string {
|
||||
// - Waits for registered runners to exit
|
||||
//
|
||||
// If you are switching an existing deployment from webhook delivery to polling,
|
||||
// delete the current webhook first with CloseWebHook or tgapi.DeleteWebhook.
|
||||
// delete the current webhook first with CloseWebhook or tgapi.DeleteWebhook.
|
||||
// Telegram keeps webhook delivery active until the webhook is removed.
|
||||
//
|
||||
// RunWithContext does not close API, uploader, or logger resources on return.
|
||||
@@ -362,18 +517,53 @@ func (bot *Bot[T]) RunWithContext(ctx context.Context) error {
|
||||
return err
|
||||
}
|
||||
defer bot.finishRun()
|
||||
if !bot.useReqLogger && bot.requestLogger != nil {
|
||||
bot.logger.Warnln("Opts#UseRequestLogger is false, but Bot#requestLogger present. Remove Bot#SetRequestLogger or set Opts#UseRequestLogger to true!")
|
||||
if bot.requestLoggerOwned {
|
||||
if err := bot.requestLogger.Close(); err != nil {
|
||||
bot.logger.Errorln(err)
|
||||
}
|
||||
}
|
||||
bot.requestLogger = nil
|
||||
bot.requestLoggerOwned = false
|
||||
}
|
||||
if bot.webhookLogger != nil {
|
||||
bot.logger.Warnln("Bot#webhookLogger present. You shouldn't set this, if ran in Long Polling mode!")
|
||||
if bot.webhookLoggerOwned {
|
||||
if err := bot.webhookLogger.Close(); err != nil {
|
||||
bot.logger.Errorln(err)
|
||||
}
|
||||
}
|
||||
bot.webhookLogger = nil
|
||||
bot.webhookLoggerOwned = false
|
||||
}
|
||||
|
||||
bot.ExecRunners(ctx)
|
||||
|
||||
// Start update polling in a goroutine
|
||||
pollDone := make(chan error, 1)
|
||||
go func() {
|
||||
var terminalErr error
|
||||
defer func() {
|
||||
if r := recover(); r != nil {
|
||||
bot.logger.Errorln(fmt.Sprintf("panic in update polling: %v", r))
|
||||
err, ok := r.(error)
|
||||
if !ok {
|
||||
err = fmt.Errorf("%v", r)
|
||||
}
|
||||
terminalErr = fmt.Errorf("update polling: %w: %v", ErrHandlerPanic, err)
|
||||
bot.safeEmitEvent(ctx, ErrorEvent{
|
||||
Plugin: "bot",
|
||||
HandlerKind: HandlerPollingKind,
|
||||
HandlerName: "getUpdates",
|
||||
Err: err,
|
||||
UserFacing: false,
|
||||
})
|
||||
}
|
||||
close(bot.updateQueue)
|
||||
pollDone <- terminalErr
|
||||
}()
|
||||
retryDelay := time.Duration(0)
|
||||
backoffDelay := time.Duration(0)
|
||||
retryCount := 0
|
||||
for {
|
||||
select {
|
||||
@@ -382,11 +572,18 @@ func (bot *Bot[T]) RunWithContext(ctx context.Context) error {
|
||||
default:
|
||||
updates, err := bot.Updates(ctx)
|
||||
if err != nil {
|
||||
if errors.Is(err, context.Canceled) {
|
||||
if ctx.Err() != nil {
|
||||
return
|
||||
}
|
||||
bot.logger.Errorln("failed to fetch updates:", err)
|
||||
retryDelay = nextPollRetryDelay(retryDelay)
|
||||
retryDelay, ok := pollRetryAfterDelay(err)
|
||||
if ok {
|
||||
bot.logger.Warnln("getUpdates rate limited; retrying after", retryDelay)
|
||||
backoffDelay = 0
|
||||
} else {
|
||||
bot.logger.Errorln("failed to fetch updates:", err)
|
||||
backoffDelay = nextPollRetryDelay(backoffDelay)
|
||||
retryDelay = backoffDelay
|
||||
}
|
||||
retryCount++
|
||||
bot.safeEmitEvent(ctx, PollingRetryEvent{
|
||||
Attempt: retryCount,
|
||||
@@ -411,7 +608,7 @@ func (bot *Bot[T]) RunWithContext(ctx context.Context) error {
|
||||
}
|
||||
continue
|
||||
}
|
||||
retryDelay = 0
|
||||
backoffDelay = 0
|
||||
retryCount = 0
|
||||
|
||||
for _, update := range updates {
|
||||
@@ -429,7 +626,8 @@ func (bot *Bot[T]) RunWithContext(ctx context.Context) error {
|
||||
|
||||
bot.runnerOnceWG.Wait()
|
||||
bot.runnerBgWG.Wait()
|
||||
return nil
|
||||
bot.middlewareWG.Wait()
|
||||
return <-pollDone
|
||||
}
|
||||
|
||||
// Run starts the bot using a background context.
|
||||
|
||||
+15
-12
@@ -5,7 +5,7 @@ import (
|
||||
"slices"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/slog"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
// AddPrefixes adds one or more command prefixes (e.g., "/", "!").
|
||||
@@ -19,7 +19,7 @@ func (bot *Bot[T]) AddPrefixes(prefixes ...string) *Bot[T] {
|
||||
}
|
||||
|
||||
// SetDraftProvider replaces the default DraftProvider with a custom one.
|
||||
// Useful for using LinearDraftIdGenerator to persist draft IDs across restarts.
|
||||
// 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
|
||||
@@ -60,7 +60,7 @@ func (bot *Bot[T]) SetSessionStore(store SessionStore) *Bot[T] {
|
||||
return bot
|
||||
}
|
||||
if store == nil {
|
||||
bot.logger.Warn("SetSessionStore called with nil store; using default MemorySessionStore")
|
||||
bot.logger.Warn("SetSessionStore called with nil store; nothing changed")
|
||||
return bot
|
||||
}
|
||||
bot.sessionStore = store
|
||||
@@ -125,7 +125,7 @@ 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") {
|
||||
if !bot.configMutable("SetUpdateTypes") {
|
||||
return bot
|
||||
}
|
||||
bot.updateTypes = make([]tgapi.UpdateType, 0)
|
||||
@@ -177,7 +177,7 @@ func (bot *Bot[T]) SetStrictPayloadType(strict bool) *Bot[T] {
|
||||
// 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") {
|
||||
if !bot.configMutable("SetErrorTemplate") {
|
||||
return bot
|
||||
}
|
||||
bot.errorTemplate = s
|
||||
@@ -186,21 +186,24 @@ func (bot *Bot[T]) SetErrorTemplate(s string) *Bot[T] {
|
||||
|
||||
// SetDebug enables or disables debug logging.
|
||||
func (bot *Bot[T]) SetDebug(debug bool) *Bot[T] {
|
||||
if !bot.configMutable("SetDebug") {
|
||||
return bot
|
||||
}
|
||||
bot.debug = debug
|
||||
level := slog.FATAL
|
||||
level := sneklog.FATAL
|
||||
if debug {
|
||||
level = slog.DEBUG
|
||||
level = sneklog.DEBUG
|
||||
}
|
||||
|
||||
bot.logger.Level(level)
|
||||
if bot.RequestLogger != nil {
|
||||
bot.RequestLogger.Level(level)
|
||||
bot.logger.SetLevel(level)
|
||||
if bot.requestLogger != nil {
|
||||
bot.requestLogger.SetLevel(level)
|
||||
}
|
||||
for _, p := range bot.plugins {
|
||||
if p.logger == nil {
|
||||
continue
|
||||
}
|
||||
p.logger.Level(level)
|
||||
p.logger.SetLevel(level)
|
||||
}
|
||||
return bot
|
||||
}
|
||||
@@ -216,7 +219,7 @@ func (bot *Bot[T]) SetL10n(l *L10n) *Bot[T] {
|
||||
return bot
|
||||
}
|
||||
if l == nil {
|
||||
bot.logger.Warn("SetL10n called with nil L10n; localization will be disabled")
|
||||
bot.logger.Warn("SetL10n called with nil L10n; localization will not change")
|
||||
return bot
|
||||
}
|
||||
bot.l10n = l
|
||||
|
||||
+68
-19
@@ -6,6 +6,8 @@ import (
|
||||
"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.
|
||||
@@ -45,16 +47,16 @@ type BotOpts struct {
|
||||
// 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
|
||||
// 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
|
||||
// DropRateLimitOverflow rejects outgoing Telegram API requests immediately when
|
||||
// rate-limit capacity is unavailable instead of waiting for capacity.
|
||||
DropRateLimitOverflow bool
|
||||
|
||||
// StrictPayloadType disables callback payload fallback decoding.
|
||||
// When enabled, the bot accepts only the configured default payload type.
|
||||
@@ -62,6 +64,22 @@ type BotOpts struct {
|
||||
|
||||
// MaxWorkers is the maximum number of update handlers that may run concurrently.
|
||||
MaxWorkers int
|
||||
|
||||
// PollTimeout is the long-polling timeout in seconds for getUpdates.
|
||||
// Defaults to 30. Telegram allows 0..50; values outside that range are accepted
|
||||
// by the bot but rejected by Telegram at runtime.
|
||||
PollTimeout 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 selects text or JSON output for bot-managed loggers.
|
||||
LogFormat utils.LogFormat
|
||||
// LogFormatter customizes bot-managed logger writers when supported.
|
||||
LogFormatter *sneklog.Formatter
|
||||
}
|
||||
|
||||
// LoadOptsFromEnv loads BotOpts from environment variables.
|
||||
@@ -78,15 +96,18 @@ type BotOpts struct {
|
||||
// - 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
|
||||
// - DROP_RL_OVERFLOW: "true" to reject rate-limited API requests instead of waiting
|
||||
// - STRICT_PAYLOAD_TYPE: "true" to reject callback payloads encoded in a different format
|
||||
// - MAX_WORKERS: maximum number of concurrent update handlers (default: 32)
|
||||
// - POLL_TIMEOUT: long-polling timeout in seconds for getUpdates (default: 30)
|
||||
// - LOG_FORMAT: logger output format, "text" or "json" (default: "text")
|
||||
//
|
||||
// Returns a populated BotOpts.
|
||||
// NewBot validates required fields and returns ErrTokenRequired when TG_TOKEN is missing.
|
||||
func LoadOptsFromEnv() *BotOpts {
|
||||
rateLimit := 30
|
||||
maxWorkers := 32
|
||||
pollTimeout := 30
|
||||
|
||||
stringUpdateTypes := splitEnvList(os.Getenv("UPDATE_TYPES"))
|
||||
updateTypes := make([]tgapi.UpdateType, 0, len(stringUpdateTypes))
|
||||
@@ -101,11 +122,17 @@ func LoadOptsFromEnv() *BotOpts {
|
||||
}
|
||||
|
||||
if mw := os.Getenv("MAX_WORKERS"); mw != "" {
|
||||
if n, err := strconv.Atoi(os.Getenv("MAX_WORKERS")); err == nil {
|
||||
if n, err := strconv.Atoi(mw); err == nil {
|
||||
maxWorkers = n
|
||||
}
|
||||
}
|
||||
|
||||
if pt := os.Getenv("POLL_TIMEOUT"); pt != "" {
|
||||
if n, err := strconv.Atoi(pt); err == nil {
|
||||
pollTimeout = n
|
||||
}
|
||||
}
|
||||
|
||||
return &BotOpts{
|
||||
Token: os.Getenv("TG_TOKEN"),
|
||||
UpdateTypes: updateTypes,
|
||||
@@ -119,13 +146,16 @@ func LoadOptsFromEnv() *BotOpts {
|
||||
WriteToFile: os.Getenv("WRITE_TO_FILE") == "true",
|
||||
|
||||
UseTestServer: os.Getenv("USE_TEST_SERVER") == "true",
|
||||
APIUrl: os.Getenv("API_URL"),
|
||||
APIURL: os.Getenv("API_URL"),
|
||||
|
||||
RateLimit: rateLimit,
|
||||
DropRLOverflow: os.Getenv("DROP_RL_OVERFLOW") == "true",
|
||||
StrictPayloadType: os.Getenv("STRICT_PAYLOAD_TYPE") == "true",
|
||||
RateLimit: rateLimit,
|
||||
DropRateLimitOverflow: os.Getenv("DROP_RL_OVERFLOW") == "true",
|
||||
StrictPayloadType: os.Getenv("STRICT_PAYLOAD_TYPE") == "true",
|
||||
|
||||
MaxWorkers: maxWorkers,
|
||||
MaxWorkers: maxWorkers,
|
||||
PollTimeout: pollTimeout,
|
||||
FileConfigVersion: 0,
|
||||
LogFormat: utils.LogFormat(os.Getenv("LOG_FORMAT")),
|
||||
}
|
||||
}
|
||||
|
||||
@@ -193,10 +223,10 @@ func (opts *BotOpts) SetUseTestServer(use bool) *BotOpts {
|
||||
return opts
|
||||
}
|
||||
|
||||
// SetAPIUrl overrides the default Telegram API endpoint (useful for proxies or self-hosted).
|
||||
// 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
|
||||
func (opts *BotOpts) SetAPIURL(url string) *BotOpts {
|
||||
opts.APIURL = url
|
||||
return opts
|
||||
}
|
||||
|
||||
@@ -207,10 +237,10 @@ func (opts *BotOpts) SetRateLimit(limit int) *BotOpts {
|
||||
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
|
||||
// SetDropRateLimitOverflow configures outgoing Telegram API requests to fail
|
||||
// immediately when rate-limit capacity is unavailable. Default is false.
|
||||
func (opts *BotOpts) SetDropRateLimitOverflow(drop bool) *BotOpts {
|
||||
opts.DropRateLimitOverflow = drop
|
||||
return opts
|
||||
}
|
||||
|
||||
@@ -240,6 +270,25 @@ func (opts *BotOpts) SetMaxWorkers(workers int) *BotOpts {
|
||||
return opts
|
||||
}
|
||||
|
||||
// SetPollTimeout sets the long-polling timeout in seconds for getUpdates.
|
||||
// Defaults to 30. Telegram accepts 0..50.
|
||||
func (opts *BotOpts) SetPollTimeout(seconds int) *BotOpts {
|
||||
opts.PollTimeout = seconds
|
||||
return opts
|
||||
}
|
||||
|
||||
// SetLogFormat sets the output format used by bot-managed loggers.
|
||||
func (opts *BotOpts) SetLogFormat(format utils.LogFormat) *BotOpts {
|
||||
opts.LogFormat = format
|
||||
return opts
|
||||
}
|
||||
|
||||
// SetLogFormatter sets the formatter used by bot-managed logger writers.
|
||||
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 {
|
||||
|
||||
+103
-52
@@ -2,45 +2,73 @@ package laniakea
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"regexp"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||
)
|
||||
|
||||
// BotOptsFileJson is the JSON file representation of BotOpts.
|
||||
type BotOptsFileJson struct {
|
||||
Token string `json:"token"`
|
||||
UpdateTypes []tgapi.UpdateType `json:"update_types"`
|
||||
Debug bool `json:"debug"`
|
||||
ErrorTemplate string `json:"error_template"`
|
||||
Prefixes []string `json:"prefixes"`
|
||||
Logger struct {
|
||||
LoggerBasePath string `json:"base_path"`
|
||||
UseRequestLogger bool `json:"use_request_logger"`
|
||||
WriteToFile bool `json:"write_to_file"`
|
||||
} `json:"logger"`
|
||||
API struct {
|
||||
UseTestServer bool `json:"use_test_server"`
|
||||
APIUrl string `json:"url"`
|
||||
RateLimit int `json:"rate_limit"`
|
||||
DropRLOverflow bool `json:"drop_overflow"`
|
||||
} `json:"api"`
|
||||
StrictPayloadType bool `json:"strict_payload_type"`
|
||||
MaxWorkers int `json:"max_workers"`
|
||||
// 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"`
|
||||
PollTimeout int `json:"poll_timeout"`
|
||||
DropRLOverflow bool `json:"drop_overflow"`
|
||||
}
|
||||
|
||||
// BotOptsFileJsonCodec encodes and decodes BotOpts using BotOptsFileJson.
|
||||
type BotOptsFileJsonCodec struct{}
|
||||
// BotOptsFileJSON is the JSON file representation of BotOpts.
|
||||
type BotOptsFileJSON struct {
|
||||
// Version identifies the JSON configuration format version.
|
||||
Version int `json:"version"`
|
||||
// Token is the Telegram bot token.
|
||||
Token string `json:"token"`
|
||||
// UpdateTypes limits the update kinds requested from Telegram.
|
||||
UpdateTypes []tgapi.UpdateType `json:"update_types"`
|
||||
// Debug enables debug logging.
|
||||
Debug bool `json:"debug"`
|
||||
// ErrorTemplate formats user-facing handler errors.
|
||||
ErrorTemplate string `json:"error_template"`
|
||||
// Prefixes contains accepted command prefixes.
|
||||
Prefixes []string `json:"prefixes"`
|
||||
// Logger contains file logging options.
|
||||
Logger botOptsFileJSONLogger `json:"logger"`
|
||||
// API contains Telegram client and rate-limit options.
|
||||
API botOptsFileJSONAPI `json:"api"`
|
||||
// StrictPayloadType requires callback payloads to use the configured encoding.
|
||||
StrictPayloadType bool `json:"strict_payload_type"`
|
||||
// MaxWorkers limits concurrent update handlers.
|
||||
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)
|
||||
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,
|
||||
@@ -51,49 +79,47 @@ func (codec BotOptsFileJsonCodec) FromBytes(data []byte) (*BotOpts, error) {
|
||||
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,
|
||||
UseTestServer: fileOpts.API.UseTestServer,
|
||||
APIURL: fileOpts.API.APIURL,
|
||||
RateLimit: fileOpts.API.RateLimit,
|
||||
PollTimeout: fileOpts.API.PollTimeout,
|
||||
DropRateLimitOverflow: 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{
|
||||
func (codec BotOptsFileJSONCodec) ToBytes(opts *BotOpts) ([]byte, error) {
|
||||
if opts == nil {
|
||||
return nil, ErrOptsIsNil
|
||||
}
|
||||
fileOpts := &BotOptsFileJSON{
|
||||
Version: ConfigVersion,
|
||||
Token: opts.Token,
|
||||
UpdateTypes: opts.UpdateTypes,
|
||||
Debug: opts.Debug,
|
||||
ErrorTemplate: opts.ErrorTemplate,
|
||||
Prefixes: opts.Prefixes,
|
||||
|
||||
Logger: struct {
|
||||
LoggerBasePath string `json:"base_path"`
|
||||
UseRequestLogger bool `json:"use_request_logger"`
|
||||
WriteToFile bool `json:"write_to_file"`
|
||||
}{
|
||||
Logger: botOptsFileJSONLogger{
|
||||
LoggerBasePath: opts.LoggerBasePath,
|
||||
UseRequestLogger: opts.UseRequestLogger,
|
||||
WriteToFile: opts.WriteToFile,
|
||||
LogFormat: opts.LogFormat,
|
||||
},
|
||||
|
||||
API: struct {
|
||||
UseTestServer bool `json:"use_test_server"`
|
||||
APIUrl string `json:"url"`
|
||||
RateLimit int `json:"rate_limit"`
|
||||
DropRLOverflow bool `json:"drop_overflow"`
|
||||
}{
|
||||
API: botOptsFileJSONAPI{
|
||||
UseTestServer: opts.UseTestServer,
|
||||
APIUrl: opts.APIUrl,
|
||||
APIURL: opts.APIURL,
|
||||
RateLimit: opts.RateLimit,
|
||||
DropRLOverflow: opts.DropRLOverflow,
|
||||
PollTimeout: opts.PollTimeout,
|
||||
DropRLOverflow: opts.DropRateLimitOverflow,
|
||||
},
|
||||
|
||||
StrictPayloadType: opts.StrictPayloadType,
|
||||
MaxWorkers: opts.MaxWorkers,
|
||||
}
|
||||
@@ -104,14 +130,27 @@ func (codec BotOptsFileJsonCodec) ToBytes(opts *BotOpts) ([]byte, error) {
|
||||
return data, nil
|
||||
}
|
||||
|
||||
func (codec BotOptsFileJsonCodec) Load(filename string) (*BotOpts, error) {
|
||||
// Load reads BotOpts from a JSON config file.
|
||||
func (codec BotOptsFileJSONCodec) Load(filename string) (*BotOpts, error) {
|
||||
return LoadBotOptsFile(codec, filename)
|
||||
}
|
||||
func (codec BotOptsFileJsonCodec) Save(filename string, opts *BotOpts) error {
|
||||
|
||||
// Save writes BotOpts to a JSON config file.
|
||||
func (codec BotOptsFileJSONCodec) Save(filename string, opts *BotOpts) error {
|
||||
return SaveBotOptsFile(codec, filename, opts)
|
||||
}
|
||||
|
||||
var envParameterRegex = regexp.MustCompile(`\{\{\s*(\w+)\s*\}\}`)
|
||||
// EscapeEnv escapes an environment value for use inside a JSON string.
|
||||
func (codec BotOptsFileJSONCodec) EscapeEnv(s string) string {
|
||||
data, _ := json.Marshal(s)
|
||||
return string(data[1 : len(data)-1])
|
||||
}
|
||||
|
||||
var envParameterRegex = regexp.MustCompile(`\{\{\s*(\w+)\s*}}`)
|
||||
|
||||
type botOptsFileEnvEscaper interface {
|
||||
EscapeEnv(string) string
|
||||
}
|
||||
|
||||
// BotOptsFileCodec decodes and encodes BotOpts file formats.
|
||||
type BotOptsFileCodec interface {
|
||||
@@ -123,6 +162,9 @@ type BotOptsFileCodec interface {
|
||||
|
||||
// LoadBotOptsFile reads a config file, expands env placeholders, and decodes BotOpts.
|
||||
func LoadBotOptsFile(codec BotOptsFileCodec, filename string) (*BotOpts, error) {
|
||||
if isNilValue(codec) {
|
||||
return nil, ErrCodecIsNil
|
||||
}
|
||||
f, err := os.Open(filename)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
@@ -132,24 +174,30 @@ func LoadBotOptsFile(codec BotOptsFileCodec, filename string) (*BotOpts, error)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
data = expandEnvPlaceholdersInFile(data)
|
||||
data = expandEnvPlaceholdersInFile(codec, 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 {
|
||||
if isNilValue(codec) {
|
||||
return ErrCodecIsNil
|
||||
}
|
||||
if opts == nil {
|
||||
return ErrOptsIsNil
|
||||
}
|
||||
data, err := codec.ToBytes(opts)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
err = os.WriteFile(filename, data, 0644)
|
||||
err = os.WriteFile(filename, data, 0600)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func expandEnvPlaceholdersInFile(data []byte) []byte {
|
||||
func expandEnvPlaceholdersInFile(codec BotOptsFileCodec, data []byte) []byte {
|
||||
return envParameterRegex.ReplaceAllFunc(data, func(match []byte) []byte {
|
||||
group := envParameterRegex.FindSubmatch(match)
|
||||
if len(group) != 2 {
|
||||
@@ -157,6 +205,9 @@ func expandEnvPlaceholdersInFile(data []byte) []byte {
|
||||
}
|
||||
key := group[1]
|
||||
value := os.Getenv(string(key))
|
||||
if escaper, ok := codec.(botOptsFileEnvEscaper); ok {
|
||||
value = escaper.EscapeEnv(value)
|
||||
}
|
||||
return []byte(value)
|
||||
})
|
||||
}
|
||||
|
||||
+87
-29
@@ -1,6 +1,7 @@
|
||||
package laniakea
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"reflect"
|
||||
@@ -9,23 +10,25 @@ import (
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
)
|
||||
|
||||
func TestBotOptsFileJsonCodecRoundTrip(t *testing.T) {
|
||||
codec := BotOptsFileJsonCodec{}
|
||||
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,
|
||||
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,
|
||||
PollTimeout: 7,
|
||||
DropRateLimitOverflow: true,
|
||||
StrictPayloadType: true,
|
||||
MaxWorkers: 64,
|
||||
FileConfigVersion: ConfigVersion,
|
||||
}
|
||||
|
||||
data, err := codec.ToBytes(want)
|
||||
@@ -43,6 +46,21 @@ func TestBotOptsFileJsonCodecRoundTrip(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestBotOptsFileRejectsNilInputs(t *testing.T) {
|
||||
if _, err := (BotOptsFileJSONCodec{}).ToBytes(nil); !errors.Is(err, ErrOptsIsNil) {
|
||||
t.Fatalf("ToBytes error = %v, want ErrOptsIsNil", err)
|
||||
}
|
||||
if _, err := LoadBotOptsFile(nil, "unused"); !errors.Is(err, ErrCodecIsNil) {
|
||||
t.Fatalf("LoadBotOptsFile error = %v, want ErrCodecIsNil", err)
|
||||
}
|
||||
if err := SaveBotOptsFile(nil, "unused", &BotOpts{}); !errors.Is(err, ErrCodecIsNil) {
|
||||
t.Fatalf("SaveBotOptsFile error = %v, want ErrCodecIsNil", err)
|
||||
}
|
||||
if err := SaveBotOptsFile(BotOptsFileJSONCodec{}, "unused", nil); !errors.Is(err, ErrOptsIsNil) {
|
||||
t.Fatalf("SaveBotOptsFile nil opts error = %v, want ErrOptsIsNil", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoadBotOptsFileExpandsEnvPlaceholders(t *testing.T) {
|
||||
t.Setenv("TG_TOKEN", "TOKEN_FROM_ENV")
|
||||
t.Setenv("BOT_API_URL", "https://api.example.invalid")
|
||||
@@ -60,7 +78,7 @@ func TestLoadBotOptsFileExpandsEnvPlaceholders(t *testing.T) {
|
||||
t.Fatalf("WriteFile returned error: %v", err)
|
||||
}
|
||||
|
||||
got, err := LoadBotOptsFile(BotOptsFileJsonCodec{}, filename)
|
||||
got, err := LoadBotOptsFile(BotOptsFileJSONCodec{}, filename)
|
||||
if err != nil {
|
||||
t.Fatalf("LoadBotOptsFile returned error: %v", err)
|
||||
}
|
||||
@@ -68,12 +86,34 @@ func TestLoadBotOptsFileExpandsEnvPlaceholders(t *testing.T) {
|
||||
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.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 TestLoadBotOptsFileEscapesEnvironmentValuesForJSON(t *testing.T) {
|
||||
want := "quote: \"; slash: \\; newline:\n; tab:\t; control:\x01"
|
||||
t.Setenv("TG_TOKEN", want)
|
||||
|
||||
dir := t.TempDir()
|
||||
filename := filepath.Join(dir, "config.json")
|
||||
if err := os.WriteFile(filename, []byte(`{"token":"{{TG_TOKEN}}"}`), 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 != want {
|
||||
t.Fatalf("unexpected token: got %q want %q", got.Token, want)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoadBotOptsFileReturnsDecodeError(t *testing.T) {
|
||||
@@ -83,7 +123,7 @@ func TestLoadBotOptsFileReturnsDecodeError(t *testing.T) {
|
||||
t.Fatalf("WriteFile returned error: %v", err)
|
||||
}
|
||||
|
||||
if _, err := LoadBotOptsFile(BotOptsFileJsonCodec{}, filename); err == nil {
|
||||
if _, err := LoadBotOptsFile(BotOptsFileJSONCodec{}, filename); err == nil {
|
||||
t.Fatal("expected decode error, got nil")
|
||||
}
|
||||
}
|
||||
@@ -92,20 +132,21 @@ 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,
|
||||
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 {
|
||||
if err := SaveBotOptsFile(BotOptsFileJSONCodec{}, filename, want); err != nil {
|
||||
t.Fatalf("SaveBotOptsFile returned error: %v", err)
|
||||
}
|
||||
|
||||
got, err := LoadBotOptsFile(BotOptsFileJsonCodec{}, filename)
|
||||
got, err := LoadBotOptsFile(BotOptsFileJSONCodec{}, filename)
|
||||
if err != nil {
|
||||
t.Fatalf("LoadBotOptsFile returned error: %v", err)
|
||||
}
|
||||
@@ -114,3 +155,20 @@ func TestSaveBotOptsFileWritesEncodedData(t *testing.T) {
|
||||
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)
|
||||
}
|
||||
}
|
||||
|
||||
+45
-10
@@ -19,6 +19,12 @@ func (bot *Bot[T]) AddPlugins(plugin ...*Plugin[T]) *Bot[T] {
|
||||
return bot
|
||||
}
|
||||
level := bot.GetLoggerLevel()
|
||||
sceneOwners := make(map[string]string)
|
||||
for _, registered := range bot.plugins {
|
||||
for name := range registered.scenes {
|
||||
sceneOwners[name] = registered.name
|
||||
}
|
||||
}
|
||||
for _, p := range plugin {
|
||||
if p == nil {
|
||||
if bot.logger != nil {
|
||||
@@ -27,9 +33,21 @@ func (bot *Bot[T]) AddPlugins(plugin ...*Plugin[T]) *Bot[T] {
|
||||
continue
|
||||
}
|
||||
cloned := clonePlugin(p)
|
||||
if cloned.logger == nil {
|
||||
cloned.logger = utils.CreateLogger(cloned.name, level)
|
||||
for name := range cloned.scenes {
|
||||
if owner, duplicate := sceneOwners[name]; duplicate {
|
||||
if bot.logger != nil {
|
||||
bot.logger.Warnf("scene %q from plugin %q duplicates plugin %q; skipping", name, cloned.name, owner)
|
||||
}
|
||||
delete(cloned.scenes, name)
|
||||
continue
|
||||
}
|
||||
sceneOwners[name] = cloned.name
|
||||
}
|
||||
if cloned.logger == nil {
|
||||
cloned.logger = utils.CreateLogger(cloned.name, level, bot.logFormat, bot.logFormatter)
|
||||
cloned.loggerOwned = true
|
||||
}
|
||||
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))
|
||||
@@ -94,7 +112,7 @@ func (bot *Bot[T]) UsePolicy(name string, policy Policy[T]) *Bot[T] {
|
||||
// - Scheduled tasks (e.g., daily announcements)
|
||||
//
|
||||
// Runners start from the bot runtime entry points, immediately after
|
||||
// RunWithContext or RunWebHookWithContext begins.
|
||||
// RunWithContext or RunWebhookWithContext begins.
|
||||
//
|
||||
// Example:
|
||||
//
|
||||
@@ -128,10 +146,19 @@ func (bot *Bot[T]) AddRunner(runner Runner[T]) *Bot[T] {
|
||||
//
|
||||
// Example:
|
||||
//
|
||||
// bot.AddAppDataLoggerWriter(func(data *MyAppData) slog.LoggerWriter {
|
||||
// bot.AddAppDataLoggerWriter(func(data *MyAppData) sneklog.LoggerWriter {
|
||||
// return data.QueryLogger()
|
||||
// })
|
||||
func (bot *Bot[T]) AddAppDataLoggerWriter(writer AppDataLogger[T]) *Bot[T] {
|
||||
if !bot.configMutable("AddAppDataLoggerWriter") {
|
||||
return bot
|
||||
}
|
||||
if writer == nil {
|
||||
if bot.logger != nil {
|
||||
bot.logger.Warnln("AddAppDataLoggerWriter called with nil writer; nothing changed")
|
||||
}
|
||||
return bot
|
||||
}
|
||||
if !bot.hasAppData {
|
||||
bot.logger.Warnln("app data is not set; skipping app-data logger writer")
|
||||
return bot
|
||||
@@ -141,17 +168,25 @@ func (bot *Bot[T]) AddAppDataLoggerWriter(writer AppDataLogger[T]) *Bot[T] {
|
||||
return bot
|
||||
}
|
||||
w := writer(bot.appData)
|
||||
bot.logger.AddWriter(w)
|
||||
if bot.RequestLogger != nil {
|
||||
bot.RequestLogger.AddWriter(w)
|
||||
if isNilValue(w) {
|
||||
if bot.logger != nil {
|
||||
bot.logger.Warnln("app-data logger writer returned nil; nothing changed")
|
||||
}
|
||||
return bot
|
||||
}
|
||||
for _, l := range bot.extraLoggers {
|
||||
l.AddWriter(w)
|
||||
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.AddWriter(w)
|
||||
p.logger.AddWriters(w)
|
||||
}
|
||||
}
|
||||
bot.addTokenReplacer(bot.logger, bot.requestLogger)
|
||||
bot.addTokenReplacer(bot.managedExtraLoggers()...)
|
||||
return bot
|
||||
}
|
||||
|
||||
+4
-8
@@ -24,16 +24,16 @@ func (bot *Bot[T]) findScene(name string) (*sceneMeta, bool) {
|
||||
}
|
||||
|
||||
return &sceneMeta{
|
||||
Name: scene.Name,
|
||||
Scope: scene.Scope,
|
||||
Entry: scene.Entry,
|
||||
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) {
|
||||
func (bot *Bot[T]) findSceneSession(ctx *MessageContext) (string, SceneSession, error) {
|
||||
var zero SceneSession
|
||||
|
||||
for _, scope := range bot.sceneScopePriority {
|
||||
@@ -53,7 +53,3 @@ func (bot *Bot[T]) findSceneSession(ctx *MsgContext) (string, SceneSession, erro
|
||||
|
||||
return "", zero, ErrCantFindSession
|
||||
}
|
||||
|
||||
func (bot *Bot[T]) buildSceneKey(scope SceneScope, ctx *MsgContext) (string, bool) {
|
||||
return buildSceneKey(scope, ctx)
|
||||
}
|
||||
|
||||
+436
-34
@@ -5,6 +5,7 @@ import (
|
||||
"errors"
|
||||
"io"
|
||||
"net/http"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"reflect"
|
||||
"strings"
|
||||
@@ -12,7 +13,7 @@ import (
|
||||
"time"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/slog"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
type pollingRoundTripFunc func(*http.Request) (*http.Response, error)
|
||||
@@ -21,22 +22,31 @@ func (f pollingRoundTripFunc) RoundTrip(req *http.Request) (*http.Response, erro
|
||||
return f(req)
|
||||
}
|
||||
|
||||
type closeCountingWriter struct{ closes int }
|
||||
|
||||
func (w *closeCountingWriter) Close() error { w.closes++; return nil }
|
||||
func (w *closeCountingWriter) Write(p []byte) (int, error) { return len(p), nil }
|
||||
func (w *closeCountingWriter) Print(sneklog.LogLevel, string, []*sneklog.MethodTraceback, ...any) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
type pollingRetryObserver struct {
|
||||
recordingObserver
|
||||
cancel context.CancelFunc
|
||||
cancel context.CancelFunc
|
||||
cancelAfter int
|
||||
}
|
||||
|
||||
func (o *pollingRetryObserver) OnPollingRetry(ctx context.Context, ev PollingRetryEvent) {
|
||||
o.recordingObserver.OnPollingRetry(ctx, ev)
|
||||
if o.cancel != nil {
|
||||
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) OnUpdateReceived(context.Context, UpdateReceivedEvent) {}
|
||||
func (testObserver) OnUpdateHandled(context.Context, UpdateHandledEvent) {}
|
||||
func (testObserver) OnHandlerStarted(context.Context, HandlerStartedEvent) {}
|
||||
func (testObserver) OnHandlerFinished(context.Context, HandlerFinishedEvent) {
|
||||
}
|
||||
@@ -46,6 +56,17 @@ func (testObserver) OnRunnerFinished(context.Context, RunnerFinishedEvent) {}
|
||||
func (testObserver) OnPollingRetry(context.Context, PollingRetryEvent) {}
|
||||
func (testObserver) OnError(context.Context, ErrorEvent) {}
|
||||
|
||||
type blockingObserver struct {
|
||||
testObserver
|
||||
started chan struct{}
|
||||
release chan struct{}
|
||||
}
|
||||
|
||||
func (o *blockingObserver) OnError(context.Context, ErrorEvent) {
|
||||
close(o.started)
|
||||
<-o.release
|
||||
}
|
||||
|
||||
func TestGetUpdateTypesReturnsCopy(t *testing.T) {
|
||||
bot := &Bot[NoData]{updateTypes: []tgapi.UpdateType{tgapi.UpdateTypeMessage}}
|
||||
|
||||
@@ -58,17 +79,17 @@ func TestGetUpdateTypesReturnsCopy(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestAddPluginsSnapshotsConfiguration(t *testing.T) {
|
||||
bot := &Bot[NoData]{logger: slog.CreateLogger()}
|
||||
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 }))
|
||||
cmd := plugin.Command("start", func(ctx *MessageContext, db NoData) error { return nil })
|
||||
plugin.AddMiddleware(NewMiddleware("base", func(ctx *MessageContext, 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 }))
|
||||
plugin.Command("late", func(ctx *MessageContext, db NoData) error { return nil })
|
||||
plugin.AddMiddleware(NewMiddleware("late", func(ctx *MessageContext, db NoData) bool { return true }))
|
||||
|
||||
registered := bot.plugins[0]
|
||||
if _, exists := registered.commands["late"]; exists {
|
||||
@@ -88,8 +109,8 @@ func TestBotPayloadTypeConfiguration(t *testing.T) {
|
||||
if got := bot.GetPayloadType(); got != BotPayloadBase64 {
|
||||
t.Fatalf("unexpected initial payload type: %q", got)
|
||||
}
|
||||
bot.SetPayloadType(BotPayloadJson)
|
||||
if got := bot.GetPayloadType(); got != BotPayloadJson {
|
||||
bot.SetPayloadType(BotPayloadJSON)
|
||||
if got := bot.GetPayloadType(); got != BotPayloadJSON {
|
||||
t.Fatalf("unexpected updated payload type: %q", got)
|
||||
}
|
||||
bot.SetStrictPayloadType(true)
|
||||
@@ -99,7 +120,7 @@ func TestBotPayloadTypeConfiguration(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestAddPluginsSkipsNilPlugin(t *testing.T) {
|
||||
bot := &Bot[NoData]{logger: slog.CreateLogger()}
|
||||
bot := &Bot[NoData]{logger: sneklog.NewLogger()}
|
||||
plugin := NewPlugin[NoData]("demo")
|
||||
|
||||
bot.AddPlugins(nil, plugin)
|
||||
@@ -125,10 +146,10 @@ func TestInitLoggersFallsBackToStdoutLoggerOnFileError(t *testing.T) {
|
||||
if bot.logger == nil {
|
||||
t.Fatal("expected main logger fallback")
|
||||
}
|
||||
if bot.RequestLogger == nil {
|
||||
if bot.requestLogger == nil {
|
||||
t.Fatal("expected request logger fallback")
|
||||
}
|
||||
if err := bot.RequestLogger.Close(); err != nil {
|
||||
if err := bot.requestLogger.Close(); err != nil {
|
||||
t.Fatalf("failed to close request logger: %v", err)
|
||||
}
|
||||
if err := bot.logger.Close(); err != nil {
|
||||
@@ -136,6 +157,124 @@ func TestInitLoggersFallsBackToStdoutLoggerOnFileError(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
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
|
||||
@@ -157,10 +296,10 @@ func TestNextPollRetryDelay(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestAddDatabaseLoggerWriterSkipsWhenAppDataIsUnset(t *testing.T) {
|
||||
bot := &Bot[NoData]{logger: slog.CreateLogger()}
|
||||
bot := &Bot[NoData]{logger: sneklog.NewLogger()}
|
||||
called := false
|
||||
|
||||
bot.AddAppDataLoggerWriter(func(db NoData) slog.LoggerWriter {
|
||||
bot.AddAppDataLoggerWriter(func(db NoData) sneklog.LoggerWriter {
|
||||
called = true
|
||||
return nil
|
||||
})
|
||||
@@ -173,12 +312,12 @@ func TestAddDatabaseLoggerWriterSkipsWhenAppDataIsUnset(t *testing.T) {
|
||||
func TestAddDatabaseLoggerWriterSkipsWhenAppDataIsNil(t *testing.T) {
|
||||
type testDB struct{}
|
||||
|
||||
bot := &Bot[*testDB]{logger: slog.CreateLogger()}
|
||||
bot := &Bot[*testDB]{logger: sneklog.NewLogger()}
|
||||
var db *testDB
|
||||
bot.SetAppData(db)
|
||||
|
||||
called := false
|
||||
bot.AddAppDataLoggerWriter(func(db *testDB) slog.LoggerWriter {
|
||||
bot.AddAppDataLoggerWriter(func(db *testDB) sneklog.LoggerWriter {
|
||||
called = true
|
||||
return nil
|
||||
})
|
||||
@@ -188,6 +327,97 @@ func TestAddDatabaseLoggerWriterSkipsWhenAppDataIsNil(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoggerConfigurationRejectsNilAndLateMutation(t *testing.T) {
|
||||
original := sneklog.NewLogger()
|
||||
replacement := sneklog.NewLogger()
|
||||
bot := &Bot[NoData]{logger: original, token: "secret"}
|
||||
|
||||
bot.SetLogger(nil)
|
||||
if bot.logger != original {
|
||||
t.Fatal("SetLogger(nil) replaced the logger")
|
||||
}
|
||||
bot.SetAppData(NoData{})
|
||||
bot.AddAppDataLoggerWriter(nil)
|
||||
|
||||
if err := bot.beginRun(); err != nil {
|
||||
t.Fatalf("beginRun returned error: %v", err)
|
||||
}
|
||||
defer bot.finishRun()
|
||||
bot.SetLogger(replacement)
|
||||
bot.SetRequestLogger(replacement)
|
||||
bot.SetWebhookLogger(replacement)
|
||||
if bot.logger != original || bot.requestLogger != nil || bot.webhookLogger != nil {
|
||||
t.Fatal("logger configuration changed after runtime freeze")
|
||||
}
|
||||
}
|
||||
|
||||
func TestCloseRespectsLoggerOwnershipAndAliases(t *testing.T) {
|
||||
ownedWriter := new(closeCountingWriter)
|
||||
owned := sneklog.NewLogger().AddWriter(ownedWriter)
|
||||
bot := &Bot[NoData]{
|
||||
logger: owned, loggerOwned: true,
|
||||
requestLogger: owned, requestLoggerOwned: false,
|
||||
}
|
||||
if err := bot.Close(); err != nil {
|
||||
t.Fatalf("Close returned error: %v", err)
|
||||
}
|
||||
if ownedWriter.closes != 1 {
|
||||
t.Fatalf("owned aliased logger closed %d times, want 1", ownedWriter.closes)
|
||||
}
|
||||
|
||||
callerWriter := new(closeCountingWriter)
|
||||
callerLogger := sneklog.NewLogger().AddWriter(callerWriter)
|
||||
bot = &Bot[NoData]{logger: callerLogger, requestLogger: callerLogger, webhookLogger: callerLogger}
|
||||
if err := bot.Close(); err != nil {
|
||||
t.Fatalf("Close with caller logger returned error: %v", err)
|
||||
}
|
||||
if callerWriter.closes != 0 {
|
||||
t.Fatalf("caller-owned logger closed %d times", callerWriter.closes)
|
||||
}
|
||||
_ = callerLogger.Close()
|
||||
}
|
||||
|
||||
func TestRunWithContextReturnsPollingPanic(t *testing.T) {
|
||||
bot := &Bot[NoData]{
|
||||
logger: sneklog.NewLogger(), prefixes: []string{"/"},
|
||||
plugins: []Plugin[NoData]{{name: "demo"}}, updateQueue: make(chan *tgapi.Update, 1), maxWorkers: 1,
|
||||
}
|
||||
defer func() { _ = bot.logger.Close() }()
|
||||
|
||||
err := bot.RunWithContext(context.Background())
|
||||
if !errors.Is(err, ErrHandlerPanic) {
|
||||
t.Fatalf("RunWithContext error = %v, want ErrHandlerPanic", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestNewBotWithAPIUsesInjectedClient(t *testing.T) {
|
||||
client := &http.Client{Transport: pollingRoundTripFunc(func(*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":7,"is_bot":true,"first_name":"Test","username":"test_bot"}}`)),
|
||||
}, nil
|
||||
})}
|
||||
api := tgapi.NewAPI(tgapi.NewAPIOpts("token").SetAPIURL("http://example.invalid").SetHTTPClient(client))
|
||||
bot, err := NewBotWithAPI[NoData](&BotOpts{Token: "token"}, api)
|
||||
if err != nil {
|
||||
t.Fatalf("NewBotWithAPI returned error: %v", err)
|
||||
}
|
||||
if bot.GetAPI() != api || bot.GetUploader() == nil {
|
||||
t.Fatal("injected API was not used consistently")
|
||||
}
|
||||
if err := bot.Close(); err != nil {
|
||||
t.Fatalf("Close returned error: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAddAppDataLoggerWriterRejectsNilResult(t *testing.T) {
|
||||
bot := &Bot[NoData]{logger: sneklog.NewLogger(), hasAppData: true}
|
||||
defer func() { _ = bot.logger.Close() }()
|
||||
|
||||
bot.AddAppDataLoggerWriter(func(NoData) sneklog.LoggerWriter { return nil })
|
||||
}
|
||||
|
||||
func TestShouldWarnOnValueAppData(t *testing.T) {
|
||||
type testDB struct{}
|
||||
type dbIface interface{ Ping() error }
|
||||
@@ -217,13 +447,13 @@ func TestShouldWarnOnValueAppData(t *testing.T) {
|
||||
func TestSetAppDataMarksValueWarningOnce(t *testing.T) {
|
||||
type testDB struct{}
|
||||
|
||||
bot := &Bot[testDB]{logger: slog.CreateLogger()}
|
||||
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: slog.CreateLogger()}
|
||||
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")
|
||||
@@ -231,7 +461,7 @@ func TestSetAppDataMarksValueWarningOnce(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestSetObserverAndGetObserver(t *testing.T) {
|
||||
bot := &Bot[NoData]{logger: slog.CreateLogger()}
|
||||
bot := &Bot[NoData]{logger: sneklog.NewLogger()}
|
||||
observer := testObserver{}
|
||||
|
||||
if got := bot.GetObserver(); got != nil {
|
||||
@@ -245,7 +475,7 @@ func TestSetObserverAndGetObserver(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestSetObserverNilClearsObserver(t *testing.T) {
|
||||
bot := &Bot[NoData]{logger: slog.CreateLogger()}
|
||||
bot := &Bot[NoData]{logger: sneklog.NewLogger()}
|
||||
bot.SetObserver(testObserver{})
|
||||
|
||||
if bot.GetObserver() == nil {
|
||||
@@ -258,12 +488,56 @@ func TestSetObserverNilClearsObserver(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestRuntimeObserverDispatchIsAsyncAndDrained(t *testing.T) {
|
||||
observer := &blockingObserver{
|
||||
started: make(chan struct{}),
|
||||
release: make(chan struct{}),
|
||||
}
|
||||
bot := &Bot[NoData]{logger: sneklog.NewLogger(), observer: observer}
|
||||
if err := bot.beginRun(); err != nil {
|
||||
t.Fatalf("beginRun returned error: %v", err)
|
||||
}
|
||||
|
||||
emitted := make(chan struct{})
|
||||
go func() {
|
||||
bot.safeEmitEvent(context.Background(), ErrorEvent{Err: errors.New("boom")})
|
||||
close(emitted)
|
||||
}()
|
||||
select {
|
||||
case <-emitted:
|
||||
case <-time.After(100 * time.Millisecond):
|
||||
t.Fatal("safeEmitEvent blocked on observer callback")
|
||||
}
|
||||
select {
|
||||
case <-observer.started:
|
||||
case <-time.After(time.Second):
|
||||
t.Fatal("observer callback did not start")
|
||||
}
|
||||
|
||||
finished := make(chan struct{})
|
||||
go func() {
|
||||
bot.finishRun()
|
||||
close(finished)
|
||||
}()
|
||||
select {
|
||||
case <-finished:
|
||||
t.Fatal("finishRun returned before the queued callback completed")
|
||||
case <-time.After(10 * time.Millisecond):
|
||||
}
|
||||
close(observer.release)
|
||||
select {
|
||||
case <-finished:
|
||||
case <-time.After(time.Second):
|
||||
t.Fatal("finishRun did not drain observer callbacks")
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunWithContextRejectsSecondRun(t *testing.T) {
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
cancel()
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
prefixes: []string{"/"},
|
||||
plugins: []Plugin[NoData]{{name: "demo"}},
|
||||
updateQueue: make(chan *tgapi.Update, 1),
|
||||
@@ -278,6 +552,32 @@ func TestRunWithContextRejectsSecondRun(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
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{
|
||||
@@ -293,14 +593,14 @@ func TestCloseDoesNotDeleteWebhook(t *testing.T) {
|
||||
|
||||
api := tgapi.NewAPI(
|
||||
tgapi.NewAPIOpts("token").
|
||||
SetAPIUrl("http://example.invalid").
|
||||
SetAPIURL("http://example.invalid").
|
||||
SetHTTPClient(client),
|
||||
)
|
||||
uploader := tgapi.NewUploader(api)
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
webHookLogger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
webhookLogger: sneklog.NewLogger(),
|
||||
api: api,
|
||||
uploader: uploader,
|
||||
}
|
||||
@@ -330,7 +630,7 @@ func TestRunWithContextEmitsPollingRetryAndErrorEvents(t *testing.T) {
|
||||
|
||||
api := tgapi.NewAPI(
|
||||
tgapi.NewAPIOpts("token").
|
||||
SetAPIUrl("http://example.invalid").
|
||||
SetAPIURL("http://example.invalid").
|
||||
SetHTTPClient(client),
|
||||
)
|
||||
defer func() {
|
||||
@@ -338,7 +638,7 @@ func TestRunWithContextEmitsPollingRetryAndErrorEvents(t *testing.T) {
|
||||
}()
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
api: api,
|
||||
prefixes: []string{"/"},
|
||||
plugins: []Plugin[NoData]{{name: "demo"}},
|
||||
@@ -365,12 +665,114 @@ func TestRunWithContextEmitsPollingRetryAndErrorEvents(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
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 TestRunWithContextUsesTelegramRetryAfterForPollingRateLimit(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":429,"description":"Too Many Requests: retry after 5","parameters":{"retry_after":5}}`)),
|
||||
}, 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 != 5*time.Second {
|
||||
t.Fatalf("unexpected polling retry event: %#v", got)
|
||||
}
|
||||
var responseErr *tgapi.ResponseError
|
||||
if !errors.As(observer.retries[0].Err, &responseErr) {
|
||||
t.Fatalf("expected ResponseError, got %T", observer.retries[0].Err)
|
||||
}
|
||||
if responseErr.Code != 429 || responseErr.Parameters == nil || responseErr.Parameters.RetryAfter == nil || *responseErr.Parameters.RetryAfter != 5 {
|
||||
t.Fatalf("unexpected response error: %#v", responseErr)
|
||||
}
|
||||
}
|
||||
|
||||
func TestBotConfigurationFreezesAfterRunStarts(t *testing.T) {
|
||||
type testDB struct{ Name string }
|
||||
|
||||
makeBot := func() *Bot[*testDB] {
|
||||
return &Bot[*testDB]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
prefixes: []string{"/"},
|
||||
updateTypes: []tgapi.UpdateType{tgapi.UpdateTypeMessage},
|
||||
payloadType: BotPayloadBase64,
|
||||
@@ -442,7 +844,7 @@ func TestBotConfigurationFreezesAfterRunStarts(t *testing.T) {
|
||||
}
|
||||
t.Cleanup(bot.finishRun)
|
||||
|
||||
bot.SetPayloadType(BotPayloadJson)
|
||||
bot.SetPayloadType(BotPayloadJSON)
|
||||
if bot.payloadType != BotPayloadBase64 {
|
||||
t.Fatalf("payloadType mutated after configuration freeze: got %q want %q", bot.payloadType, BotPayloadBase64)
|
||||
}
|
||||
@@ -562,9 +964,9 @@ func TestBotConfigurationFreezesAfterRunStarts(t *testing.T) {
|
||||
|
||||
func TestAddPluginsAndRuntimeRegistrationsNoOpAfterRunStarts(t *testing.T) {
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
prefixes: []string{"/"},
|
||||
middlewares: []Middleware[NoData]{NewMiddleware("base", func(ctx *MsgContext, db NoData) bool { return true })},
|
||||
middlewares: []Middleware[NoData]{NewMiddleware("base", func(ctx *MessageContext, db NoData) bool { return true })},
|
||||
runners: []Runner[NoData]{NewRunner("base", func(bot *Bot[NoData]) error { return nil })},
|
||||
}
|
||||
plugin := NewPlugin[NoData]("late")
|
||||
@@ -575,7 +977,7 @@ func TestAddPluginsAndRuntimeRegistrationsNoOpAfterRunStarts(t *testing.T) {
|
||||
defer bot.finishRun()
|
||||
|
||||
bot.AddPlugins(plugin)
|
||||
bot.AddMiddleware(NewMiddleware("late", func(ctx *MsgContext, db NoData) bool { return true }))
|
||||
bot.AddMiddleware(NewMiddleware("late", func(ctx *MessageContext, db NoData) bool { return true }))
|
||||
bot.AddRunner(NewRunner("late", func(bot *Bot[NoData]) error { return nil }))
|
||||
|
||||
if len(bot.plugins) != 0 {
|
||||
|
||||
+124
-54
@@ -2,19 +2,70 @@ package laniakea
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"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/slog"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
"github.com/alitto/pond/v2"
|
||||
)
|
||||
|
||||
const observerShutdownTimeout = 5 * time.Second
|
||||
|
||||
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 (bot *Bot[T]) closeReplacedLogger(old *sneklog.Logger, owned bool, replacements ...*sneklog.Logger) {
|
||||
if old == nil || !owned || len(replacements) == 0 || replacements[0] == old {
|
||||
return
|
||||
}
|
||||
if slices.Contains(replacements[1:], old) {
|
||||
bot.detachedOwnedLoggers = appendUniqueLogger(bot.detachedOwnedLoggers, old)
|
||||
return
|
||||
}
|
||||
if err := old.Close(); err != nil && bot.logger != nil && bot.logger != old {
|
||||
bot.logger.Errorln(err)
|
||||
}
|
||||
}
|
||||
|
||||
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():
|
||||
@@ -32,57 +83,93 @@ func (bot *Bot[T]) startUpdateWorkers(ctx context.Context) {
|
||||
bot.handle(ctx, u)
|
||||
})
|
||||
}
|
||||
pool.Stop() // Wait for all tasks to complete and stop the pool
|
||||
pool.StopAndWait() // Wait for all tasks to complete and stop the pool
|
||||
}
|
||||
|
||||
func (bot *Bot[T]) initLoggers(opts *BotOpts) {
|
||||
level := slog.FATAL
|
||||
level := sneklog.FATAL
|
||||
if opts.Debug {
|
||||
level = slog.DEBUG
|
||||
level = sneklog.DEBUG
|
||||
}
|
||||
|
||||
bot.logger = utils.CreateLogger("BOT", level).AddReplacer(bot.token, "<TOKEN>")
|
||||
if opts.WriteToFile {
|
||||
path := fmt.Sprintf("%s/main.log", strings.TrimRight(opts.LoggerBasePath, "/"))
|
||||
logger, err := utils.CreateFileLogger("BOT", level, path)
|
||||
if err != nil {
|
||||
bot.logger.Errorln(err)
|
||||
} else {
|
||||
bot.logger = logger
|
||||
}
|
||||
}
|
||||
|
||||
if opts.UseRequestLogger {
|
||||
bot.RequestLogger = utils.CreateLogger("REQUESTS", level).AddReplacer(bot.token, "<TOKEN>")
|
||||
format, formatter := opts.LogFormat, opts.LogFormatter
|
||||
if bot.logger == nil {
|
||||
bot.logger = utils.CreateLogger("BOT", level, format, formatter)
|
||||
bot.loggerOwned = true
|
||||
if opts.WriteToFile {
|
||||
path := fmt.Sprintf("%s/requests.log", strings.TrimRight(opts.LoggerBasePath, "/"))
|
||||
logger, err := utils.CreateFileLogger("REQUESTS", level, path)
|
||||
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.RequestLogger = logger
|
||||
_ = bot.logger.Close()
|
||||
bot.logger = logger
|
||||
bot.loggerOwned = true
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if opts.UseRequestLogger && bot.requestLogger == nil {
|
||||
bot.requestLogger = utils.CreateLogger("REQUESTS", level, format, formatter)
|
||||
bot.requestLoggerOwned = true
|
||||
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.Close()
|
||||
bot.requestLogger = logger
|
||||
bot.requestLoggerOwned = true
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
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 {
|
||||
bot.runStateMu.Unlock()
|
||||
return ErrBotAlreadyRun
|
||||
}
|
||||
bot.running = true
|
||||
bot.ran = true
|
||||
bot.runStateMu.Unlock()
|
||||
if bot.observer != nil {
|
||||
bot.observerAsync = newObserverDispatcher(bot.observer, bot.logger)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (bot *Bot[T]) finishRun() {
|
||||
ctx, cancel := context.WithTimeout(context.Background(), observerShutdownTimeout)
|
||||
if err := bot.stopObserverDispatcher(ctx); err != nil && bot.logger != nil {
|
||||
bot.logger.Errorln(err)
|
||||
}
|
||||
cancel()
|
||||
bot.runStateMu.Lock()
|
||||
bot.running = false
|
||||
bot.runStateMu.Unlock()
|
||||
}
|
||||
|
||||
func (bot *Bot[T]) stopObserverDispatcher(ctx context.Context) error {
|
||||
if bot.observerAsync == nil {
|
||||
return nil
|
||||
}
|
||||
return bot.observerAsync.close(ctx)
|
||||
}
|
||||
|
||||
func (bot *Bot[T]) startAsyncTask(task func()) {
|
||||
bot.middlewareWG.Add(1)
|
||||
go func() {
|
||||
defer bot.middlewareWG.Done()
|
||||
task()
|
||||
}()
|
||||
}
|
||||
|
||||
func nextPollRetryDelay(prev time.Duration) time.Duration {
|
||||
if prev <= 0 {
|
||||
return time.Second
|
||||
@@ -94,6 +181,18 @@ func nextPollRetryDelay(prev time.Duration) time.Duration {
|
||||
return next
|
||||
}
|
||||
|
||||
func pollRetryAfterDelay(err error) (time.Duration, bool) {
|
||||
var responseErr *tgapi.ResponseError
|
||||
if !errors.As(err, &responseErr) || responseErr.Code != 429 || responseErr.Parameters == nil || responseErr.Parameters.RetryAfter == nil {
|
||||
return 0, false
|
||||
}
|
||||
after := *responseErr.Parameters.RetryAfter
|
||||
if after <= 0 {
|
||||
return 0, false
|
||||
}
|
||||
return time.Duration(after) * time.Second, true
|
||||
}
|
||||
|
||||
func isNilValue[T any](v T) bool {
|
||||
rv := reflect.ValueOf(v)
|
||||
if !rv.IsValid() {
|
||||
@@ -129,51 +228,22 @@ func clonePlugin[T AppData](p *Plugin[T]) Plugin[T] {
|
||||
middlewares: append(extypes.Slice[Middleware[T]](nil), p.middlewares...),
|
||||
skipAutoCmd: p.skipAutoCmd,
|
||||
logger: p.logger,
|
||||
loggerOwned: false, // user-supplied loggers stay caller-owned; bot may take ownership during registration
|
||||
messageFallback: p.messageFallback,
|
||||
handlers: make(map[tgapi.UpdateType]CommandExecutor[T]),
|
||||
onClose: p.onClose,
|
||||
}
|
||||
|
||||
for name, command := range p.commands {
|
||||
cloned.commands[name] = cloneCommand(command)
|
||||
cloned.commands[name] = command.clone()
|
||||
}
|
||||
for name, command := range p.payloads {
|
||||
cloned.payloads[name] = cloneCommand(command)
|
||||
cloned.payloads[name] = command.clone()
|
||||
}
|
||||
for name, scene := range p.scenes {
|
||||
cloned.scenes[name] = cloneScene(scene)
|
||||
cloned.scenes[name] = scene.clone()
|
||||
}
|
||||
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))
|
||||
|
||||
for name, handler := range scene.steps {
|
||||
cloned.steps[name] = handler
|
||||
}
|
||||
for name, handler := range scene.commands {
|
||||
cloned.commands[name] = handler
|
||||
}
|
||||
|
||||
return &cloned
|
||||
}
|
||||
|
||||
+152
-123
@@ -2,6 +2,7 @@ package laniakea
|
||||
|
||||
import (
|
||||
"context"
|
||||
"crypto/subtle"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
@@ -15,24 +16,34 @@ import (
|
||||
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||
)
|
||||
|
||||
// BotWebHookOpts configures Telegram webhook registration and the local HTTP server.
|
||||
type BotWebHookOpts struct {
|
||||
Path string
|
||||
LocalPort int
|
||||
// BotWebhookOpts configures Telegram webhook registration and the local HTTP server.
|
||||
type BotWebhookOpts struct {
|
||||
// Path is the local HTTP route that receives Telegram updates.
|
||||
Path string
|
||||
// LocalPort is the TCP port used by the webhook server.
|
||||
LocalPort int
|
||||
// UseStatusPath enables the authenticated /status endpoint.
|
||||
UseStatusPath bool
|
||||
|
||||
URL string
|
||||
Certificate []byte
|
||||
IPAddress string
|
||||
MaxConnections int8
|
||||
AllowedUpdates []tgapi.UpdateType
|
||||
// URL is the public base URL Telegram uses for delivery.
|
||||
URL string
|
||||
// Certificate contains a self-signed public certificate to upload.
|
||||
Certificate []byte
|
||||
// IPAddress fixes the destination IP used by Telegram.
|
||||
IPAddress string
|
||||
// MaxConnections limits simultaneous Telegram webhook connections to 1–100.
|
||||
MaxConnections int8
|
||||
// AllowedUpdates limits the update kinds delivered to the webhook.
|
||||
AllowedUpdates []tgapi.UpdateType
|
||||
// DropPendingUpdates requests deletion of queued updates during registration.
|
||||
DropPendingUpdates bool
|
||||
SecretToken string
|
||||
// SecretToken authenticates Telegram requests and the optional status endpoint.
|
||||
SecretToken string
|
||||
}
|
||||
|
||||
// NewBotWebHookOpts returns webhook options with the default path, local port, and max connections.
|
||||
func NewBotWebHookOpts() *BotWebHookOpts {
|
||||
return &BotWebHookOpts{
|
||||
// NewBotWebhookOpts returns webhook options with the default path, local port, and max connections.
|
||||
func NewBotWebhookOpts() *BotWebhookOpts {
|
||||
return &BotWebhookOpts{
|
||||
Path: "/",
|
||||
LocalPort: 8080,
|
||||
MaxConnections: 40,
|
||||
@@ -40,38 +51,38 @@ func NewBotWebHookOpts() *BotWebHookOpts {
|
||||
}
|
||||
|
||||
// SetPath sets the local HTTP path that receives Telegram webhook requests.
|
||||
func (opts *BotWebHookOpts) SetPath(path string) *BotWebHookOpts {
|
||||
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 {
|
||||
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 {
|
||||
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 {
|
||||
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 {
|
||||
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 {
|
||||
func (opts *BotWebhookOpts) MustLoadCertificate(filename string) *BotWebhookOpts {
|
||||
f, err := os.Open(filename)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
@@ -87,37 +98,37 @@ func (opts *BotWebHookOpts) MustLoadCertificate(filename string) *BotWebHookOpts
|
||||
}
|
||||
|
||||
// SetIPAddress sets the fixed IP address Telegram should use for webhook delivery.
|
||||
func (opts *BotWebHookOpts) SetIPAddress(ip string) *BotWebHookOpts {
|
||||
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 {
|
||||
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 {
|
||||
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 {
|
||||
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 {
|
||||
func (opts *BotWebhookOpts) SetSecretToken(secretToken string) *BotWebhookOpts {
|
||||
opts.SecretToken = secretToken
|
||||
return opts
|
||||
}
|
||||
|
||||
// RunWebHookWithContext registers the webhook and serves incoming updates until ctx is canceled.
|
||||
// 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
|
||||
@@ -126,9 +137,9 @@ func (opts *BotWebHookOpts) SetSecretToken(secretToken string) *BotWebHookOpts {
|
||||
//
|
||||
// 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 {
|
||||
func (bot *Bot[T]) RunWebhookWithContext(ctx context.Context, opts *BotWebhookOpts, tlsFiles ...string) error {
|
||||
if opts == nil {
|
||||
return errors.New("nil BotWebHookOpts")
|
||||
return ErrNilBotWebhookOpts
|
||||
}
|
||||
if len(bot.prefixes) == 0 {
|
||||
return ErrNoPrefixes
|
||||
@@ -136,44 +147,51 @@ func (bot *Bot[T]) RunWebHookWithContext(ctx context.Context, opts *BotWebHookOp
|
||||
if len(bot.plugins) == 0 {
|
||||
return ErrNoPlugins
|
||||
}
|
||||
autoSecret := ""
|
||||
if opts.SecretToken == "" {
|
||||
rndSecret, err := generateToken(32)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
opts.SecretToken = rndSecret
|
||||
autoSecret = rndSecret
|
||||
}
|
||||
if opts.URL == "" {
|
||||
return errors.New("empty BotWebHookOpts.URL")
|
||||
return ErrNoBotWebhookOptsURL
|
||||
}
|
||||
if opts.MaxConnections > 100 || opts.MaxConnections <= 0 {
|
||||
return errors.New("BotWebHookOpts.MaxConnections must between 1 and 100")
|
||||
return ErrBotWebhookOptsMaxConnectionsRange
|
||||
}
|
||||
if err := validateWebhookSecretToken(opts.SecretToken); err != nil {
|
||||
return err
|
||||
}
|
||||
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())
|
||||
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 ErrBotUploaderWhenCertificate
|
||||
}
|
||||
|
||||
return bot.runWebhookRuntime(ctx, func(runCtx context.Context) error {
|
||||
if autoSecret != "" {
|
||||
bot.webhookLogger.Warnln("No webhook secret was configured; generated a random secret token")
|
||||
}
|
||||
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")
|
||||
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)
|
||||
bot.webhookLogger.Infof("Bot webhook deleted: %s", i.URL)
|
||||
}
|
||||
|
||||
allowedUpdates := bot.webhookAllowedUpdates(opts)
|
||||
@@ -202,52 +220,55 @@ func (bot *Bot[T]) RunWebHookWithContext(ctx context.Context, opts *BotWebHookOp
|
||||
return err
|
||||
}
|
||||
if !ok {
|
||||
return errors.New("failed to set webhook")
|
||||
return ErrSetWebhookFailed
|
||||
}
|
||||
|
||||
if len(tlsFiles) == 2 {
|
||||
return bot.runWebHookTLS(runCtx, opts, tlsFiles[0], tlsFiles[1])
|
||||
return bot.runWebhookTLS(runCtx, opts, tlsFiles[0], tlsFiles[1])
|
||||
}
|
||||
|
||||
return bot.runWebHook(runCtx, opts)
|
||||
return bot.runWebhook(runCtx, opts)
|
||||
})
|
||||
}
|
||||
|
||||
// RunWebHook starts the webhook runtime with a background context.
|
||||
// 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...)
|
||||
// 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.
|
||||
// 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 {
|
||||
func (bot *Bot[T]) CloseWebhook() error {
|
||||
var e []error
|
||||
if bot.api == nil {
|
||||
e = append(e, errors.New("bot api nil"))
|
||||
e = append(e, ErrBotAPINil)
|
||||
} else {
|
||||
if _, err := bot.api.DeleteWebhook(tgapi.DeleteWebhook{}); err != nil {
|
||||
if bot.webHookLogger != nil {
|
||||
bot.webHookLogger.Errorf("Failed to close webhook: %s", err.Error())
|
||||
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)
|
||||
if bot.webhookLogger != nil {
|
||||
if bot.webhookLoggerOwned {
|
||||
if err := bot.webhookLogger.Close(); err != nil {
|
||||
e = append(e, err)
|
||||
}
|
||||
}
|
||||
bot.webHookLogger = nil
|
||||
bot.webhookLogger = nil
|
||||
bot.webhookLoggerOwned = false
|
||||
}
|
||||
return errors.Join(e...)
|
||||
}
|
||||
|
||||
func (bot *Bot[T]) webhookAllowedUpdates(opts *BotWebHookOpts) []tgapi.UpdateType {
|
||||
func (bot *Bot[T]) webhookAllowedUpdates(opts *BotWebhookOpts) []tgapi.UpdateType {
|
||||
if len(opts.AllowedUpdates) > 0 {
|
||||
return append([]tgapi.UpdateType(nil), opts.AllowedUpdates...)
|
||||
}
|
||||
@@ -263,6 +284,11 @@ func (bot *Bot[T]) runWebhookRuntime(ctx context.Context, run func(context.Conte
|
||||
runCtx, cancel := context.WithCancel(ctx)
|
||||
defer cancel()
|
||||
|
||||
if bot.webhookLogger == nil {
|
||||
bot.webhookLogger = utils.CreateLogger("WEBHOOK", bot.GetLoggerLevel(), bot.logFormat, bot.logFormatter)
|
||||
bot.webhookLoggerOwned = true
|
||||
}
|
||||
bot.addTokenReplacer(bot.webhookLogger)
|
||||
bot.ExecRunners(runCtx)
|
||||
|
||||
workersDone := make(chan struct{})
|
||||
@@ -275,13 +301,14 @@ func (bot *Bot[T]) runWebhookRuntime(ctx context.Context, run func(context.Conte
|
||||
cancel()
|
||||
close(bot.updateQueue)
|
||||
<-workersDone
|
||||
bot.middlewareWG.Wait()
|
||||
bot.runnerOnceWG.Wait()
|
||||
bot.runnerBgWG.Wait()
|
||||
|
||||
return runErr
|
||||
}
|
||||
|
||||
func updateHandler[T any](ctx context.Context, bot *Bot[T], secret string) http.HandlerFunc {
|
||||
func updateHandler[T any](ctx context.Context, bot *Bot[T], secret []byte) http.HandlerFunc {
|
||||
return func(w http.ResponseWriter, r *http.Request) {
|
||||
defer func() {
|
||||
_ = r.Body.Close()
|
||||
@@ -290,7 +317,9 @@ func updateHandler[T any](ctx context.Context, bot *Bot[T], secret string) http.
|
||||
w.WriteHeader(http.StatusMethodNotAllowed)
|
||||
return
|
||||
}
|
||||
if secret != "" && r.Header.Get("X-Telegram-Bot-Api-Secret-Token") != secret {
|
||||
provided := []byte(r.Header.Get("X-Telegram-Bot-Api-Secret-Token"))
|
||||
|
||||
if len(secret) > 0 && subtle.ConstantTimeCompare(secret, provided) != 1 {
|
||||
w.WriteHeader(http.StatusForbidden)
|
||||
return
|
||||
}
|
||||
@@ -314,12 +343,12 @@ func updateHandler[T any](ctx context.Context, bot *Bot[T], secret string) http.
|
||||
var up tgapi.Update
|
||||
if err := json.Unmarshal(data, &up); err != nil {
|
||||
w.WriteHeader(http.StatusBadRequest)
|
||||
bot.webHookLogger.Errorln(err)
|
||||
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)
|
||||
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)
|
||||
bot.webhookLogger.Errorln(err)
|
||||
w.WriteHeader(http.StatusServiceUnavailable)
|
||||
return
|
||||
}
|
||||
@@ -327,7 +356,7 @@ func updateHandler[T any](ctx context.Context, bot *Bot[T], secret string) http.
|
||||
}
|
||||
}
|
||||
|
||||
func statusHandler[T any](bot *Bot[T], opts *BotWebHookOpts) http.HandlerFunc {
|
||||
func statusHandler[T any](bot *Bot[T], secret []byte) http.HandlerFunc {
|
||||
return func(w http.ResponseWriter, r *http.Request) {
|
||||
auth := ""
|
||||
if r.Header.Get("Authorization") != "" {
|
||||
@@ -335,116 +364,116 @@ func statusHandler[T any](bot *Bot[T], opts *BotWebHookOpts) http.HandlerFunc {
|
||||
} 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 {
|
||||
if len(secret) > 0 && subtle.ConstantTimeCompare(secret, []byte(auth)) != 1 {
|
||||
w.WriteHeader(http.StatusNotFound)
|
||||
return
|
||||
}
|
||||
|
||||
i, err := bot.api.GetWebhookInfoWithContext(r.Context())
|
||||
if err != nil {
|
||||
bot.webHookLogger.Errorln(err)
|
||||
bot.webhookLogger.Errorln(err)
|
||||
w.WriteHeader(http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
data, err := json.MarshalIndent(i, "", " ")
|
||||
if err != nil {
|
||||
bot.webHookLogger.Errorln(err)
|
||||
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)
|
||||
bot.webhookLogger.Errorln(err)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func (bot *Bot[T]) newWebHookMux(ctx context.Context, opts *BotWebHookOpts) *http.ServeMux {
|
||||
func (bot *Bot[T]) newWebhookMux(ctx context.Context, opts *BotWebhookOpts) *http.ServeMux {
|
||||
token := []byte(opts.SecretToken)
|
||||
r := http.NewServeMux()
|
||||
if opts.UseStatusPath {
|
||||
r.HandleFunc("/status", statusHandler(bot, opts))
|
||||
r.HandleFunc("/status", statusHandler(bot, token))
|
||||
}
|
||||
r.HandleFunc(opts.Path, updateHandler(ctx, bot, opts.SecretToken))
|
||||
r.HandleFunc(opts.Path, updateHandler(ctx, bot, token))
|
||||
return r
|
||||
}
|
||||
func (bot *Bot[T]) runWebHook(ctx context.Context, opts *BotWebHookOpts) error {
|
||||
func (bot *Bot[T]) baseRunWebhook(ctx context.Context, opts *BotWebhookOpts, runFunc func(*http.Server, chan error)) error {
|
||||
srv := &http.Server{
|
||||
Addr: fmt.Sprintf(":%d", opts.LocalPort),
|
||||
Handler: bot.newWebHookMux(ctx, opts),
|
||||
Addr: fmt.Sprintf(":%d", opts.LocalPort),
|
||||
Handler: bot.newWebhookMux(ctx, opts),
|
||||
ReadHeaderTimeout: 5 * time.Second,
|
||||
ReadTimeout: 10 * time.Second,
|
||||
IdleTimeout: 60 * time.Second,
|
||||
}
|
||||
errCh := make(chan error, 1)
|
||||
|
||||
go func() {
|
||||
go runFunc(srv, errCh)
|
||||
|
||||
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]) runWebhook(ctx context.Context, opts *BotWebhookOpts) error {
|
||||
return bot.baseRunWebhook(ctx, opts, func(srv *http.Server, errCh chan error) {
|
||||
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() {
|
||||
func (bot *Bot[T]) runWebhookTLS(ctx context.Context, opts *BotWebhookOpts, key, cert string) error {
|
||||
return bot.baseRunWebhook(ctx, opts, func(srv *http.Server, errCh chan error) {
|
||||
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")
|
||||
return ErrBotWebhookOptsEmptyPath
|
||||
}
|
||||
if !strings.HasPrefix(path, "/") {
|
||||
return errors.New("BotWebHookOpts.Path must start with '/'")
|
||||
return ErrBotWebhookOptsPathNoSlash
|
||||
}
|
||||
if strings.Contains(path, "?") || strings.Contains(path, "#") {
|
||||
return errors.New("BotWebHookOpts.Path must not contain query or fragment")
|
||||
return ErrBotWebhookOptsPathHasQueryOrFragment
|
||||
}
|
||||
if useStatusPath && path == "/status" {
|
||||
return errors.New("BotWebHookOpts.Path must not be '/status' when status path is enabled")
|
||||
return ErrBotWebhookOptsPathCollidesStatus
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func validateWebhookSecretToken(token string) error {
|
||||
if len(token) < 1 || len(token) > 256 {
|
||||
return ErrBotWebhookOptsSecretTokenInvalid
|
||||
}
|
||||
for _, r := range token {
|
||||
if (r < 'A' || r > 'Z') &&
|
||||
(r < 'a' || r > 'z') &&
|
||||
(r < '0' || r > '9') &&
|
||||
r != '_' && r != '-' {
|
||||
return ErrBotWebhookOptsSecretTokenInvalid
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
@@ -454,8 +483,8 @@ func validateWebhookTLSFiles(tlsFiles []string) error {
|
||||
case 0, 2:
|
||||
return nil
|
||||
case 1:
|
||||
return errors.New("you must specify both private and public keys")
|
||||
return ErrBotWebhookTLSFilesIncomplete
|
||||
default:
|
||||
return errors.New("too many files; you must specify only private and public keys")
|
||||
return ErrBotWebhookTLSFilesTooMany
|
||||
}
|
||||
}
|
||||
|
||||
+130
-27
@@ -9,9 +9,10 @@ import (
|
||||
"strings"
|
||||
"sync/atomic"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/slog"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
func TestEnqueueUpdateCopiesValue(t *testing.T) {
|
||||
@@ -35,17 +36,17 @@ func TestEnqueueUpdateCopiesValue(t *testing.T) {
|
||||
func TestUpdateHandlerEnqueuesUpdate(t *testing.T) {
|
||||
bot := &Bot[NoData]{
|
||||
updateQueue: make(chan *tgapi.Update, 1),
|
||||
webHookLogger: slog.CreateLogger(),
|
||||
webhookLogger: sneklog.NewLogger(),
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
_ = bot.webHookLogger.Close()
|
||||
_ = 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)
|
||||
updateHandler(context.Background(), bot, []byte("secret")).ServeHTTP(rec, req)
|
||||
|
||||
if rec.Result().StatusCode != http.StatusOK {
|
||||
t.Fatalf("unexpected status: got %d want %d", rec.Result().StatusCode, http.StatusOK)
|
||||
@@ -66,7 +67,7 @@ func TestUpdateHandlerEnqueuesUpdate(t *testing.T) {
|
||||
|
||||
func TestRunWebhookRuntimeRejectsSecondRun(t *testing.T) {
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
updateQueue: make(chan *tgapi.Update, 1),
|
||||
maxWorkers: 1,
|
||||
}
|
||||
@@ -86,14 +87,14 @@ func TestRunWebhookRuntimeExecutesRunners(t *testing.T) {
|
||||
var calls atomic.Int32
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
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),
|
||||
}).Async(false),
|
||||
},
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
@@ -108,11 +109,83 @@ func TestRunWebhookRuntimeExecutesRunners(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunWebhookRuntimePreservesConfiguredWebhookLogger(t *testing.T) {
|
||||
webhookLogger := sneklog.NewLogger()
|
||||
bot := &Bot[NoData]{
|
||||
logger: sneklog.NewLogger(),
|
||||
webhookLogger: webhookLogger,
|
||||
updateQueue: make(chan *tgapi.Update, 1),
|
||||
maxWorkers: 1,
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
_ = bot.logger.Close()
|
||||
if bot.webhookLogger != nil {
|
||||
_ = bot.webhookLogger.Close()
|
||||
}
|
||||
})
|
||||
|
||||
if err := bot.runWebhookRuntime(context.Background(), func(context.Context) error { return nil }); err != nil {
|
||||
t.Fatalf("runWebhookRuntime returned error: %v", err)
|
||||
}
|
||||
if bot.webhookLogger != webhookLogger {
|
||||
t.Fatal("expected runWebhookRuntime to preserve configured webhook logger")
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunWebhookRuntimeProcessesEnqueuedUpdate(t *testing.T) {
|
||||
var calls atomic.Int32
|
||||
plugin := NewPlugin[NoData]("demo")
|
||||
plugin.Command("start", func(ctx *MessageContext, db NoData) error {
|
||||
calls.Add(1)
|
||||
return nil
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: sneklog.NewLogger(),
|
||||
webhookLogger: sneklog.NewLogger(),
|
||||
prefixes: []string{"/"},
|
||||
plugins: []Plugin[NoData]{*plugin},
|
||||
updateQueue: make(chan *tgapi.Update, 1),
|
||||
maxWorkers: 1,
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
_ = bot.logger.Close()
|
||||
_ = bot.webhookLogger.Close()
|
||||
})
|
||||
|
||||
err := bot.runWebhookRuntime(context.Background(), func(ctx context.Context) error {
|
||||
req := httptest.NewRequest(http.MethodPost, "/", strings.NewReader(`{"update_id":9,"message":{"message_id":1,"date":1,"chat":{"id":1,"type":"private"},"from":{"id":2,"is_bot":false,"first_name":"Test"},"text":"/start"}}`))
|
||||
rec := httptest.NewRecorder()
|
||||
|
||||
updateHandler(ctx, bot, []byte("")).ServeHTTP(rec, req)
|
||||
if rec.Result().StatusCode != http.StatusOK {
|
||||
t.Fatalf("unexpected status: got %d want %d", rec.Result().StatusCode, http.StatusOK)
|
||||
}
|
||||
|
||||
deadline := time.After(time.Second)
|
||||
for calls.Load() == 0 {
|
||||
select {
|
||||
case <-deadline:
|
||||
t.Fatal("webhook runtime did not process enqueued update")
|
||||
default:
|
||||
time.Sleep(time.Millisecond)
|
||||
}
|
||||
}
|
||||
return nil
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("runWebhookRuntime returned error: %v", err)
|
||||
}
|
||||
if calls.Load() != 1 {
|
||||
t.Fatalf("expected command handler to run once, got %d", calls.Load())
|
||||
}
|
||||
}
|
||||
|
||||
func TestWebhookAllowedUpdatesUsesBotUpdateTypesByDefault(t *testing.T) {
|
||||
bot := &Bot[NoData]{
|
||||
updateTypes: []tgapi.UpdateType{tgapi.UpdateTypeMessage, tgapi.UpdateTypeCallbackQuery},
|
||||
}
|
||||
opts := NewBotWebHookOpts()
|
||||
opts := NewBotWebhookOpts()
|
||||
|
||||
got := bot.webhookAllowedUpdates(opts)
|
||||
if len(got) != 2 {
|
||||
@@ -182,19 +255,46 @@ func TestValidateWebhookTLSFiles(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestValidateWebhookSecretToken(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
token string
|
||||
wantErr bool
|
||||
}{
|
||||
{name: "minimum", token: "a"},
|
||||
{name: "allowed alphabet", token: "AZaz09_-"},
|
||||
{name: "maximum", token: strings.Repeat("a", 256)},
|
||||
{name: "empty", token: "", wantErr: true},
|
||||
{name: "too long", token: strings.Repeat("a", 257), wantErr: true},
|
||||
{name: "padding", token: "abc=", wantErr: true},
|
||||
{name: "non ASCII", token: "секрет", wantErr: true},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
err := validateWebhookSecretToken(tt.token)
|
||||
if tt.wantErr && !errors.Is(err, ErrBotWebhookOptsSecretTokenInvalid) {
|
||||
t.Fatalf("expected ErrBotWebhookOptsSecretTokenInvalid, got %v", err)
|
||||
}
|
||||
if !tt.wantErr && err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestUpdateHandlerRejectsOversizedBody(t *testing.T) {
|
||||
bot := &Bot[NoData]{
|
||||
updateQueue: make(chan *tgapi.Update, 1),
|
||||
webHookLogger: slog.CreateLogger(),
|
||||
webhookLogger: sneklog.NewLogger(),
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
_ = bot.webHookLogger.Close()
|
||||
_ = 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)
|
||||
updateHandler(context.Background(), bot, []byte("")).ServeHTTP(rec, req)
|
||||
|
||||
if rec.Result().StatusCode != http.StatusRequestEntityTooLarge {
|
||||
t.Fatalf("unexpected status: got %d want %d", rec.Result().StatusCode, http.StatusRequestEntityTooLarge)
|
||||
@@ -213,7 +313,7 @@ func TestStatusHandlerRequiresMatchingSecret(t *testing.T) {
|
||||
}
|
||||
api := tgapi.NewAPI(
|
||||
tgapi.NewAPIOpts("token").
|
||||
SetAPIUrl("http://example.invalid").
|
||||
SetAPIURL("http://example.invalid").
|
||||
SetHTTPClient(client),
|
||||
)
|
||||
defer func() {
|
||||
@@ -222,13 +322,13 @@ func TestStatusHandlerRequiresMatchingSecret(t *testing.T) {
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
api: api,
|
||||
webHookLogger: slog.CreateLogger(),
|
||||
webhookLogger: sneklog.NewLogger(),
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
_ = bot.webHookLogger.Close()
|
||||
_ = bot.webhookLogger.Close()
|
||||
})
|
||||
|
||||
handler := statusHandler(bot, &BotWebHookOpts{SecretToken: "secret"})
|
||||
handler := statusHandler(bot, []byte("secret"))
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
@@ -238,6 +338,9 @@ func TestStatusHandlerRequiresMatchingSecret(t *testing.T) {
|
||||
}{
|
||||
{name: "missing auth", wantStatus: http.StatusNotFound},
|
||||
{name: "wrong auth", headerName: "Authorization", headerVal: "wrong", wantStatus: http.StatusNotFound},
|
||||
{name: "matching length wrong content", headerName: "X-Telegram-Bot-Api-Secret-Token", headerVal: "secres", wantStatus: http.StatusNotFound},
|
||||
{name: "shared prefix shorter", headerName: "X-Telegram-Bot-Api-Secret-Token", headerVal: "secre", wantStatus: http.StatusNotFound},
|
||||
{name: "shared prefix longer", headerName: "X-Telegram-Bot-Api-Secret-Token", headerVal: "secretxx", wantStatus: http.StatusNotFound},
|
||||
{name: "matching telegram header", headerName: "X-Telegram-Bot-Api-Secret-Token", headerVal: "secret", wantStatus: http.StatusOK},
|
||||
}
|
||||
|
||||
@@ -258,14 +361,14 @@ func TestStatusHandlerRequiresMatchingSecret(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunWebHookWithContextRejectsInvalidTLSFilesBeforeRemoteSetup(t *testing.T) {
|
||||
func TestRunWebhookWithContextRejectsInvalidTLSFilesBeforeRemoteSetup(t *testing.T) {
|
||||
bot := &Bot[NoData]{
|
||||
prefixes: []string{"/"},
|
||||
plugins: []Plugin[NoData]{{name: "demo"}},
|
||||
}
|
||||
opts := NewBotWebHookOpts().SetURL("https://bot.example.com")
|
||||
opts := NewBotWebhookOpts().SetURL("https://bot.example.com")
|
||||
|
||||
err := bot.RunWebHookWithContext(context.Background(), opts, "cert.pem")
|
||||
err := bot.RunWebhookWithContext(context.Background(), opts, "cert.pem")
|
||||
if err == nil {
|
||||
t.Fatal("expected tls validation error, got nil")
|
||||
}
|
||||
@@ -274,20 +377,20 @@ func TestRunWebHookWithContextRejectsInvalidTLSFilesBeforeRemoteSetup(t *testing
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunWebHookWithContextRequiresSecretWhenStatusPathEnabled(t *testing.T) {
|
||||
func TestRunWebhookWithContextAutoGeneratesSecretWhenEmpty(t *testing.T) {
|
||||
bot := &Bot[NoData]{
|
||||
prefixes: []string{"/"},
|
||||
plugins: []Plugin[NoData]{{name: "demo"}},
|
||||
}
|
||||
opts := NewBotWebHookOpts().
|
||||
SetURL("https://bot.example.com").
|
||||
SetUseStatusPath(true)
|
||||
// No SecretToken, no URL — function should auto-generate the token
|
||||
// and then fail with ErrNoBotWebhookOptsURL before any network call.
|
||||
opts := NewBotWebhookOpts().SetUseStatusPath(true)
|
||||
|
||||
err := bot.RunWebHookWithContext(context.Background(), opts)
|
||||
if err == nil {
|
||||
t.Fatal("expected status-path secret validation error, got nil")
|
||||
err := bot.RunWebhookWithContext(context.Background(), opts)
|
||||
if !errors.Is(err, ErrNoBotWebhookOptsURL) {
|
||||
t.Fatalf("expected ErrNoBotWebhookOptsURL after auto-generation, got: %v", err)
|
||||
}
|
||||
if !strings.Contains(err.Error(), "SecretToken required") {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
if opts.SecretToken == "" {
|
||||
t.Fatal("expected SecretToken to be auto-generated, got empty string")
|
||||
}
|
||||
}
|
||||
|
||||
+124
-54
@@ -1,17 +1,18 @@
|
||||
package laniakea
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"regexp"
|
||||
"sort"
|
||||
"strings"
|
||||
"unicode/utf8"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
)
|
||||
|
||||
// CmdRegexp matches command names allowed for Telegram command registration.
|
||||
var CmdRegexp = regexp.MustCompile("^[_a-z0-9]{1,32}$")
|
||||
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.
|
||||
@@ -21,7 +22,39 @@ var CmdRegexp = regexp.MustCompile("^[_a-z0-9]{1,32}$")
|
||||
// bot initialization.
|
||||
var ErrTooManyCommands = errors.New("too many commands. max 100")
|
||||
|
||||
// Internal helper to build a BotCommand description with generated usage text.
|
||||
var (
|
||||
// ErrInvalidBotCommand reports a command name that Telegram would reject.
|
||||
ErrInvalidBotCommand = errors.New("invalid bot command")
|
||||
// ErrInvalidBotCommandDescription reports an empty or overlong generated description.
|
||||
ErrInvalidBotCommandDescription = errors.New("invalid bot command description")
|
||||
// ErrDuplicateBotCommand reports the same command generated by multiple plugins.
|
||||
ErrDuplicateBotCommand = errors.New("duplicate bot command")
|
||||
// ErrPartialCommandScopeUpdate reports that an earlier command scope was
|
||||
// updated before a later scope failed.
|
||||
ErrPartialCommandScopeUpdate = errors.New("partial command scope update")
|
||||
)
|
||||
|
||||
// CommandScopeUpdateError describes a failed multi-scope command update.
|
||||
// UpdatedScopes lists scopes successfully changed before FailedScope failed.
|
||||
type CommandScopeUpdateError struct {
|
||||
// UpdatedScopes contains scopes changed before the failure.
|
||||
UpdatedScopes []tgapi.BotCommandScopeType
|
||||
// FailedScope identifies the scope whose update failed.
|
||||
FailedScope tgapi.BotCommandScopeType
|
||||
// Err is the Telegram API error for FailedScope.
|
||||
Err error
|
||||
}
|
||||
|
||||
// Error returns a human-readable partial-update description.
|
||||
func (e *CommandScopeUpdateError) Error() string {
|
||||
return fmt.Sprintf("%v: updated %v; failed scope %q: %v", ErrPartialCommandScopeUpdate, e.UpdatedScopes, e.FailedScope, e.Err)
|
||||
}
|
||||
|
||||
// Unwrap exposes both the partial-update sentinel and the underlying API error.
|
||||
func (e *CommandScopeUpdateError) Unwrap() []error {
|
||||
return []error{ErrPartialCommandScopeUpdate, e.Err}
|
||||
}
|
||||
|
||||
func generateBotCommand[T any](cmd *Command[T]) tgapi.BotCommand {
|
||||
desc := ""
|
||||
if len(cmd.description) > 0 {
|
||||
@@ -37,19 +70,20 @@ func generateBotCommand[T any](cmd *Command[T]) tgapi.BotCommand {
|
||||
}
|
||||
}
|
||||
|
||||
usage := fmt.Sprintf("Usage: /%s %s", cmd.command, strings.Join(descArgs, " "))
|
||||
usage := fmt.Sprintf("Usage: /%s", cmd.command)
|
||||
if len(descArgs) > 0 {
|
||||
usage += " " + 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: desc, IsEphemeral: cmd.isEphemeral}
|
||||
}
|
||||
return tgapi.BotCommand{Command: cmd.command, Description: usage}
|
||||
return tgapi.BotCommand{Command: cmd.command, Description: usage, IsEphemeral: cmd.isEphemeral}
|
||||
}
|
||||
|
||||
// Internal helper to validate Telegram command names.
|
||||
func checkCmdRegex(cmd string) bool { return CmdRegexp.MatchString(cmd) }
|
||||
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 {
|
||||
func gatherCommandsForPlugin[T any](pl Plugin[T]) ([]tgapi.BotCommand, error) {
|
||||
commands := make([]tgapi.BotCommand, 0)
|
||||
names := make([]string, 0, len(pl.commands))
|
||||
for name := range pl.commands {
|
||||
@@ -63,35 +97,55 @@ func gatherCommandsForPlugin[T any](pl Plugin[T]) []tgapi.BotCommand {
|
||||
continue
|
||||
}
|
||||
if !checkCmdRegex(cmd.command) {
|
||||
continue
|
||||
return nil, fmt.Errorf("%w %q in plugin %q", ErrInvalidBotCommand, cmd.command, pl.name)
|
||||
}
|
||||
commands = append(commands, generateBotCommand(cmd))
|
||||
generated := generateBotCommand(cmd)
|
||||
descriptionLength := utf8.RuneCountInString(generated.Description)
|
||||
if descriptionLength < 1 || descriptionLength > 256 {
|
||||
return nil, fmt.Errorf(
|
||||
"%w for %q in plugin %q: got %d characters, want 1..256",
|
||||
ErrInvalidBotCommandDescription,
|
||||
cmd.command,
|
||||
pl.name,
|
||||
descriptionLength,
|
||||
)
|
||||
}
|
||||
commands = append(commands, generated)
|
||||
}
|
||||
return commands
|
||||
return commands, nil
|
||||
}
|
||||
|
||||
// Internal helper to collect all auto-generated commands from registered plugins.
|
||||
func gatherCommands[T any](bot *Bot[T]) []tgapi.BotCommand {
|
||||
func gatherCommands[T any](bot *Bot[T]) ([]tgapi.BotCommand, error) {
|
||||
commands := make([]tgapi.BotCommand, 0)
|
||||
owners := make(map[string]string)
|
||||
for _, pl := range bot.plugins {
|
||||
if pl.skipAutoCmd {
|
||||
continue
|
||||
}
|
||||
commands = append(commands, gatherCommandsForPlugin(pl)...)
|
||||
pluginCommands, err := gatherCommandsForPlugin(pl)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
for _, command := range pluginCommands {
|
||||
if owner, exists := owners[command.Command]; exists {
|
||||
return nil, fmt.Errorf(
|
||||
"%w %q in plugins %q and %q",
|
||||
ErrDuplicateBotCommand,
|
||||
command.Command,
|
||||
owner,
|
||||
pl.name,
|
||||
)
|
||||
}
|
||||
owners[command.Command] = pl.name
|
||||
commands = append(commands, command)
|
||||
}
|
||||
bot.logger.Debugln(fmt.Sprintf("Registered %d commands from plugin %s", len(pl.commands), pl.name))
|
||||
}
|
||||
return commands
|
||||
return commands, nil
|
||||
}
|
||||
|
||||
// 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.
|
||||
// AutoGenerateCommands replaces plugin-defined commands in the private-chat,
|
||||
// group-chat, and all-chat-administrators scopes.
|
||||
//
|
||||
// Returns ErrTooManyCommands if the total number of commands exceeds 100.
|
||||
// Returns any API error from Telegram (e.g., network issues, invalid scope).
|
||||
@@ -106,40 +160,45 @@ func gatherCommands[T any](bot *Bot[T]) []tgapi.BotCommand {
|
||||
// log.Fatal(err)
|
||||
// }
|
||||
func (bot *Bot[T]) AutoGenerateCommands() error {
|
||||
commands := gatherCommands(bot)
|
||||
return bot.AutoGenerateCommandsWithContext(context.Background())
|
||||
}
|
||||
|
||||
// AutoGenerateCommandsWithContext is the context-aware variant of AutoGenerateCommands.
|
||||
func (bot *Bot[T]) AutoGenerateCommandsWithContext(ctx context.Context) error {
|
||||
commands, err := gatherCommands(bot)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
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{
|
||||
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)
|
||||
updatedScopes := make([]tgapi.BotCommandScopeType, 0, len(scopes))
|
||||
for i := range scopes {
|
||||
if err := bot.setCommandsForScope(ctx, &scopes[i], commands); err != nil {
|
||||
if len(updatedScopes) > 0 {
|
||||
return &CommandScopeUpdateError{
|
||||
UpdatedScopes: updatedScopes,
|
||||
FailedScope: scopes[i].Type,
|
||||
Err: err,
|
||||
}
|
||||
}
|
||||
return err
|
||||
}
|
||||
updatedScopes = append(updatedScopes, scopes[i].Type)
|
||||
}
|
||||
|
||||
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.
|
||||
// for the specified command scope. A nil scope selects Telegram's default scope.
|
||||
//
|
||||
// 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.
|
||||
@@ -154,22 +213,33 @@ func (bot *Bot[T]) AutoGenerateCommands() error {
|
||||
// log.Fatal(err)
|
||||
// }
|
||||
func (bot *Bot[T]) AutoGenerateCommandsForScope(scope *tgapi.BotCommandScope) error {
|
||||
commands := gatherCommands(bot)
|
||||
return bot.AutoGenerateCommandsForScopeWithContext(context.Background(), scope)
|
||||
}
|
||||
|
||||
// AutoGenerateCommandsForScopeWithContext is the context-aware variant of
|
||||
// AutoGenerateCommandsForScope.
|
||||
func (bot *Bot[T]) AutoGenerateCommandsForScopeWithContext(ctx context.Context, scope *tgapi.BotCommandScope) error {
|
||||
commands, err := gatherCommands(bot)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if len(commands) > 100 {
|
||||
return ErrTooManyCommands
|
||||
}
|
||||
return bot.setCommandsForScope(ctx, scope, commands)
|
||||
}
|
||||
|
||||
_, err := bot.api.DeleteMyCommands(tgapi.DeleteMyCommands{Scope: scope})
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to delete existing commands: %w", err)
|
||||
func (bot *Bot[T]) setCommandsForScope(ctx context.Context, scope *tgapi.BotCommandScope, commands []tgapi.BotCommand) error {
|
||||
if len(commands) > 100 {
|
||||
return ErrTooManyCommands
|
||||
}
|
||||
|
||||
_, err = bot.api.SetMyCommands(tgapi.SetMyCommands{
|
||||
Commands: commands,
|
||||
Scope: scope,
|
||||
})
|
||||
_, err := bot.api.SetMyCommandsWithContext(ctx, tgapi.SetMyCommands{Scope: scope, Commands: commands})
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to set commands for scope %q: %w", scope.Type, err)
|
||||
scopeType := tgapi.BotCommandScopeDefaultType
|
||||
if scope != nil {
|
||||
scopeType = scope.Type
|
||||
}
|
||||
return fmt.Errorf("failed to set commands for scope %q: %w", scopeType, err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
+187
-10
@@ -11,7 +11,7 @@ import (
|
||||
"testing"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/slog"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
type roundTripFunc func(*http.Request) (*http.Response, error)
|
||||
@@ -34,7 +34,7 @@ func TestAutoGenerateCommandsChecksLimitBeforeDelete(t *testing.T) {
|
||||
}
|
||||
api := tgapi.NewAPI(
|
||||
tgapi.NewAPIOpts("token").
|
||||
SetAPIUrl("https://example.test").
|
||||
SetAPIURL("https://example.test").
|
||||
SetHTTPClient(client),
|
||||
)
|
||||
defer func() {
|
||||
@@ -44,14 +44,14 @@ func TestAutoGenerateCommandsChecksLimitBeforeDelete(t *testing.T) {
|
||||
}()
|
||||
|
||||
plugin := NewPlugin[NoData]("overflow")
|
||||
exec := func(ctx *MsgContext, db NoData) error { return nil }
|
||||
exec := func(ctx *MessageContext, db NoData) error { return nil }
|
||||
for i := 0; i < 101; i++ {
|
||||
plugin.AddCommand(NewCommand(exec, "cmd"+strconv.Itoa(i)))
|
||||
plugin.Command("cmd"+strconv.Itoa(i), exec)
|
||||
}
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
api: api,
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
plugins: []Plugin[NoData]{*plugin},
|
||||
}
|
||||
|
||||
@@ -66,13 +66,16 @@ func TestAutoGenerateCommandsChecksLimitBeforeDelete(t *testing.T) {
|
||||
|
||||
func TestGatherCommandsForPluginReturnsSortedCommands(t *testing.T) {
|
||||
plugin := NewPlugin[NoData]("sorted")
|
||||
exec := func(ctx *MsgContext, db NoData) error { return nil }
|
||||
exec := func(ctx *MessageContext, db NoData) error { return nil }
|
||||
|
||||
plugin.AddCommand(NewCommand(exec, "zeta"))
|
||||
plugin.AddCommand(NewCommand(exec, "alpha"))
|
||||
plugin.AddCommand(NewCommand(exec, "mid"))
|
||||
plugin.Command("zeta", exec)
|
||||
plugin.Command("alpha", exec)
|
||||
plugin.Command("mid", exec)
|
||||
|
||||
commands := gatherCommandsForPlugin(*plugin)
|
||||
commands, err := gatherCommandsForPlugin(*plugin)
|
||||
if err != nil {
|
||||
t.Fatalf("gatherCommandsForPlugin returned error: %v", err)
|
||||
}
|
||||
got := make([]string, 0, len(commands))
|
||||
for _, cmd := range commands {
|
||||
got = append(got, cmd.Command)
|
||||
@@ -83,3 +86,177 @@ func TestGatherCommandsForPluginReturnsSortedCommands(t *testing.T) {
|
||||
t.Fatalf("unexpected command order: got %v want %v", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
func TestGeneratedCommandDescriptionBoundaries(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
description string
|
||||
wantLength int
|
||||
wantErr error
|
||||
}{
|
||||
{name: "generated usage", wantLength: len("Usage: /start")},
|
||||
{name: "exact limit", description: strings.Repeat("я", 241), wantLength: 256},
|
||||
{name: "over limit", description: strings.Repeat("я", 242), wantErr: ErrInvalidBotCommandDescription},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
plugin := NewPlugin[NoData]("commands")
|
||||
plugin.Command("start", func(ctx *MessageContext, db NoData) error { return nil }).SetDescription(tt.description)
|
||||
commands, err := gatherCommandsForPlugin(*plugin)
|
||||
if !errors.Is(err, tt.wantErr) {
|
||||
t.Fatalf("expected %v, got %v", tt.wantErr, err)
|
||||
}
|
||||
if err == nil {
|
||||
if got := len([]rune(commands[0].Description)); got != tt.wantLength {
|
||||
t.Fatalf("description length = %d, want %d", got, tt.wantLength)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestAutoGenerateCommandsValidatesBeforeRequest(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
plugins func(CommandExecutor[NoData]) []Plugin[NoData]
|
||||
wantErr error
|
||||
}{
|
||||
{
|
||||
name: "invalid command",
|
||||
plugins: func(exec CommandExecutor[NoData]) []Plugin[NoData] {
|
||||
plugin := NewPlugin[NoData]("invalid")
|
||||
plugin.Command("UPPER", exec)
|
||||
return []Plugin[NoData]{*plugin}
|
||||
},
|
||||
wantErr: ErrInvalidBotCommand,
|
||||
},
|
||||
{
|
||||
name: "description too long",
|
||||
plugins: func(exec CommandExecutor[NoData]) []Plugin[NoData] {
|
||||
plugin := NewPlugin[NoData]("long")
|
||||
plugin.Command("start", exec).SetDescription(strings.Repeat("я", 257))
|
||||
return []Plugin[NoData]{*plugin}
|
||||
},
|
||||
wantErr: ErrInvalidBotCommandDescription,
|
||||
},
|
||||
{
|
||||
name: "duplicate across plugins",
|
||||
plugins: func(exec CommandExecutor[NoData]) []Plugin[NoData] {
|
||||
first := NewPlugin[NoData]("first")
|
||||
second := NewPlugin[NoData]("second")
|
||||
first.Command("start", exec)
|
||||
second.Command("start", exec)
|
||||
return []Plugin[NoData]{*first, *second}
|
||||
},
|
||||
wantErr: ErrDuplicateBotCommand,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
var calls atomic.Int64
|
||||
client := &http.Client{Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||
calls.Add(1)
|
||||
return nil, errors.New("unexpected request")
|
||||
})}
|
||||
api := tgapi.NewAPI(tgapi.NewAPIOpts("token").SetAPIURL("https://example.test").SetHTTPClient(client))
|
||||
defer func() { _ = api.Close() }()
|
||||
|
||||
exec := func(ctx *MessageContext, db NoData) error { return nil }
|
||||
bot := &Bot[NoData]{api: api, logger: sneklog.NewLogger(), plugins: tt.plugins(exec)}
|
||||
defer func() { _ = bot.logger.Close() }()
|
||||
|
||||
err := bot.AutoGenerateCommands()
|
||||
if !errors.Is(err, tt.wantErr) {
|
||||
t.Fatalf("expected %v, got %v", tt.wantErr, err)
|
||||
}
|
||||
if calls.Load() != 0 {
|
||||
t.Fatalf("expected no requests, got %d", calls.Load())
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestAutoGenerateCommandsReportsPartialScopeUpdate(t *testing.T) {
|
||||
var calls atomic.Int64
|
||||
client := &http.Client{Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||
call := calls.Add(1)
|
||||
body := `{"ok":true,"result":true}`
|
||||
if call == 2 {
|
||||
body = `{"ok":false,"error_code":500,"description":"boom"}`
|
||||
}
|
||||
return &http.Response{
|
||||
StatusCode: http.StatusOK,
|
||||
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||
Body: io.NopCloser(strings.NewReader(body)),
|
||||
}, nil
|
||||
})}
|
||||
api := tgapi.NewAPI(tgapi.NewAPIOpts("token").SetAPIURL("https://example.test").SetHTTPClient(client))
|
||||
defer func() { _ = api.Close() }()
|
||||
plugin := NewPlugin[NoData]("commands")
|
||||
plugin.Command("start", func(ctx *MessageContext, db NoData) error { return nil })
|
||||
bot := &Bot[NoData]{api: api, logger: sneklog.NewLogger(), plugins: []Plugin[NoData]{*plugin}}
|
||||
defer func() { _ = bot.logger.Close() }()
|
||||
|
||||
err := bot.AutoGenerateCommands()
|
||||
if !errors.Is(err, ErrPartialCommandScopeUpdate) {
|
||||
t.Fatalf("expected ErrPartialCommandScopeUpdate, got %v", err)
|
||||
}
|
||||
var partial *CommandScopeUpdateError
|
||||
if !errors.As(err, &partial) {
|
||||
t.Fatalf("expected CommandScopeUpdateError, got %T", err)
|
||||
}
|
||||
if !reflect.DeepEqual(partial.UpdatedScopes, []tgapi.BotCommandScopeType{tgapi.BotCommandScopePrivateType}) {
|
||||
t.Fatalf("unexpected updated scopes: %v", partial.UpdatedScopes)
|
||||
}
|
||||
if partial.FailedScope != tgapi.BotCommandScopeGroupType {
|
||||
t.Fatalf("unexpected failed scope: %q", partial.FailedScope)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAutoGenerateCommandsForNilScopeUsesSingleAtomicReplacement(t *testing.T) {
|
||||
var methods []string
|
||||
client := &http.Client{
|
||||
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||
methods = append(methods, req.URL.Path)
|
||||
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]("commands")
|
||||
plugin.Command("start", func(ctx *MessageContext, db NoData) error { return nil })
|
||||
bot := &Bot[NoData]{
|
||||
api: api,
|
||||
logger: sneklog.NewLogger(),
|
||||
plugins: []Plugin[NoData]{*plugin},
|
||||
}
|
||||
defer func() {
|
||||
if err := bot.logger.Close(); err != nil {
|
||||
t.Fatalf("Close logger returned error: %v", err)
|
||||
}
|
||||
}()
|
||||
|
||||
if err := bot.AutoGenerateCommandsForScope(nil); err != nil {
|
||||
t.Fatalf("AutoGenerateCommandsForScope returned error: %v", err)
|
||||
}
|
||||
if len(methods) != 1 {
|
||||
t.Fatalf("expected one request, got %d", len(methods))
|
||||
}
|
||||
if !strings.HasSuffix(methods[0], "/setMyCommands") {
|
||||
t.Fatalf("expected setMyCommands request, got %v", methods[0])
|
||||
}
|
||||
}
|
||||
|
||||
+225
@@ -0,0 +1,225 @@
|
||||
package laniakea
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"regexp"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/extypes"
|
||||
)
|
||||
|
||||
// CommandValueType defines the expected type of command argument.
|
||||
type CommandValueType string
|
||||
|
||||
const (
|
||||
// CommandValueString expects any non-empty string.
|
||||
CommandValueString CommandValueType = "string"
|
||||
// CommandValueInt expects a decimal integer (digits only).
|
||||
CommandValueInt CommandValueType = "int"
|
||||
// CommandValueBool expects an exact "true" or "false".
|
||||
CommandValueBool CommandValueType = "bool"
|
||||
// CommandValueAny accepts any input without validation.
|
||||
CommandValueAny 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
|
||||
}
|
||||
|
||||
// NewCommandArg creates an optional argument without value validation.
|
||||
func NewCommandArg(text string) CommandArg {
|
||||
return CommandArg{CommandValueAny, text, nil, false}
|
||||
}
|
||||
|
||||
// SetValueType sets expected value type and switches built-in validation regexp.
|
||||
func (c CommandArg) SetValueType(t CommandValueType) CommandArg {
|
||||
var regex *regexp.Regexp
|
||||
switch t {
|
||||
case CommandValueInt:
|
||||
regex = CommandRegexInt
|
||||
case CommandValueBool:
|
||||
regex = CommandRegexBool
|
||||
case CommandValueString:
|
||||
regex = CommandRegexString
|
||||
}
|
||||
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 *MessageContext, 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
|
||||
isEphemeral bool
|
||||
}
|
||||
|
||||
// NewCommand creates a new Command with the given identifier, executor, and arguments.
|
||||
//
|
||||
// The identifier is used as the routing key for both /-prefixed commands and
|
||||
// callback payloads — the difference is registration: pass the result to
|
||||
// Plugin.AddCommand/Plugin.Command for message routing, or to
|
||||
// Plugin.AddPayload/Plugin.Payload for callback_data routing.
|
||||
//
|
||||
// For /-commands the identifier must not include the leading slash
|
||||
// (e.g. "start", not "/start") and should match [_a-z0-9]{1,32} to satisfy
|
||||
// Telegram's BotCommand validation. Payload identifiers may use any bytes
|
||||
// that fit Telegram's callback_data limit, though the configured payload
|
||||
// encoding may impose its own restrictions.
|
||||
func NewCommand[T any](command string, exec CommandExecutor[T], args ...CommandArg) *Command[T] {
|
||||
return &Command[T]{
|
||||
command, "", exec, args, make(extypes.Slice[Middleware[T]], 0), false, 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
|
||||
}
|
||||
|
||||
// SetEphemeral controls whether Telegram treats the command as ephemeral.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
func (c *Command[T]) SetEphemeral(b bool) *Command[T] {
|
||||
c.isEphemeral = b
|
||||
return c
|
||||
}
|
||||
|
||||
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 CommandValueAny.
|
||||
}
|
||||
if !cmdArg.regex.MatchString(arg) {
|
||||
return ErrCmdArgRegexpMismatch
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (c *Command[T]) clone() *Command[T] {
|
||||
if c == nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
cloned := *c
|
||||
cloned.args = append(extypes.Slice[CommandArg](nil), c.args...)
|
||||
cloned.middlewares = append(extypes.Slice[Middleware[T]](nil), c.middlewares...)
|
||||
return &cloned
|
||||
}
|
||||
|
||||
// CommandGroup builds a set of commands with a shared name prefix and middleware.
|
||||
type CommandGroup[T any] struct {
|
||||
prefix string
|
||||
middlewares extypes.Slice[Middleware[T]]
|
||||
commands extypes.Slice[*Command[T]]
|
||||
}
|
||||
|
||||
// NewCommandGroup creates a command group that prefixes every added command.
|
||||
func NewCommandGroup[T any](prefix string) *CommandGroup[T] {
|
||||
return &CommandGroup[T]{
|
||||
prefix: prefix,
|
||||
|
||||
middlewares: make([]Middleware[T], 0),
|
||||
commands: make([]*Command[T], 0),
|
||||
}
|
||||
}
|
||||
|
||||
// Use adds middleware that runs before each command's own middleware.
|
||||
func (g *CommandGroup[T]) Use(m Middleware[T]) *CommandGroup[T] {
|
||||
g.middlewares = append(g.middlewares, m)
|
||||
return g
|
||||
}
|
||||
|
||||
// AddCommand adds a prefixed copy of cmd to the group.
|
||||
func (g *CommandGroup[T]) AddCommand(cmd *Command[T]) *CommandGroup[T] {
|
||||
if cmd == nil {
|
||||
return g
|
||||
}
|
||||
newCmd := cmd.clone()
|
||||
newCmd.command = g.prefix + cmd.command
|
||||
g.commands = g.commands.Push(newCmd)
|
||||
return g
|
||||
}
|
||||
|
||||
// Build returns command copies with group middleware prepended.
|
||||
func (g *CommandGroup[T]) Build() []*Command[T] {
|
||||
commands := make([]*Command[T], 0)
|
||||
for _, cmd := range g.commands {
|
||||
cloned := cmd.clone()
|
||||
cloned.middlewares = append(
|
||||
append(extypes.Slice[Middleware[T]]{}, g.middlewares...),
|
||||
cloned.middlewares...,
|
||||
)
|
||||
commands = append(commands, cloned)
|
||||
}
|
||||
return commands
|
||||
}
|
||||
@@ -5,7 +5,7 @@ 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.
|
||||
- MessageContext 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.
|
||||
@@ -27,7 +27,7 @@ Example usage:
|
||||
|
||||
return bot.Run()
|
||||
|
||||
Configure bots, plugins, and localization before starting Run, RunWithContext, or RunWebHookWithContext.
|
||||
Configure bots, plugins, and localization before starting Run, RunWithContext, or RunWebhookWithContext.
|
||||
Runtime accessors are safe for concurrent use unless stated otherwise.
|
||||
*/
|
||||
package laniakea
|
||||
|
||||
@@ -8,30 +8,31 @@ import (
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
)
|
||||
|
||||
// Interface for generating unique draft IDs.
|
||||
type draftIdGenerator interface {
|
||||
// Next returns the next unique draft ID.
|
||||
type draftIDGenerator interface {
|
||||
Next() uint64
|
||||
}
|
||||
|
||||
// RandomDraftIdGenerator generates draft IDs using cryptographically secure random numbers.
|
||||
// Suitable for distributed systems or when ID predictability is undesirable.
|
||||
type RandomDraftIdGenerator struct{}
|
||||
// RandomDraftIDGenerator generates draft IDs using math/rand/v2.
|
||||
//
|
||||
// Suitable for general use thanks to the wide 64-bit value space. Not suitable
|
||||
// for security-sensitive purposes — use crypto/rand if unpredictability against
|
||||
// an adversary matters.
|
||||
type RandomDraftIDGenerator struct{}
|
||||
|
||||
// Next returns a random 64-bit unsigned integer.
|
||||
func (g *RandomDraftIdGenerator) Next() uint64 {
|
||||
func (g *RandomDraftIDGenerator) Next() uint64 {
|
||||
return rand.Uint64()
|
||||
}
|
||||
|
||||
// LinearDraftIdGenerator generates draft IDs using a monotonically increasing counter.
|
||||
// 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
|
||||
type LinearDraftIDGenerator struct {
|
||||
lastID atomic.Uint64
|
||||
}
|
||||
|
||||
// Next returns the next linear ID, atomically incremented.
|
||||
func (g *LinearDraftIdGenerator) Next() uint64 {
|
||||
return g.lastId.Add(1)
|
||||
func (g *LinearDraftIDGenerator) Next() uint64 {
|
||||
return g.lastID.Add(1)
|
||||
}
|
||||
|
||||
// DraftProvider manages a collection of Drafts and a shared draft ID generator.
|
||||
@@ -41,16 +42,14 @@ type DraftProvider struct {
|
||||
mu sync.RWMutex
|
||||
api *tgapi.API
|
||||
drafts map[uint64]*Draft
|
||||
generator draftIdGenerator
|
||||
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.
|
||||
// NewRandomDraftProvider creates a DraftProvider using non-cryptographic random IDs.
|
||||
// Zero values and collisions with active drafts are retried.
|
||||
func NewRandomDraftProvider(api *tgapi.API) *DraftProvider {
|
||||
return &DraftProvider{
|
||||
api: api, generator: &RandomDraftIdGenerator{},
|
||||
api: api, generator: &RandomDraftIDGenerator{},
|
||||
drafts: make(map[uint64]*Draft),
|
||||
}
|
||||
}
|
||||
@@ -63,8 +62,8 @@ func NewRandomDraftProvider(api *tgapi.API) *DraftProvider {
|
||||
// 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)
|
||||
g := &LinearDraftIDGenerator{}
|
||||
g.lastID.Store(startValue)
|
||||
return &DraftProvider{
|
||||
api: api,
|
||||
generator: g,
|
||||
@@ -120,7 +119,9 @@ type Draft struct {
|
||||
parseMode tgapi.ParseMode
|
||||
entities []tgapi.MessageEntity
|
||||
|
||||
ID uint64
|
||||
// ID uniquely identifies the draft within its provider.
|
||||
ID uint64
|
||||
// Message contains the current draft text.
|
||||
Message string
|
||||
}
|
||||
|
||||
@@ -128,7 +129,19 @@ type Draft struct {
|
||||
//
|
||||
// The caller must set a chat with SetChat before Push or Flush.
|
||||
func (p *DraftProvider) NewDraft(parseMode tgapi.ParseMode) *Draft {
|
||||
id := p.generator.Next()
|
||||
p.mu.Lock()
|
||||
defer p.mu.Unlock()
|
||||
|
||||
var id uint64
|
||||
for {
|
||||
id = p.generator.Next()
|
||||
if id == 0 {
|
||||
continue
|
||||
}
|
||||
if _, exists := p.drafts[id]; !exists {
|
||||
break
|
||||
}
|
||||
}
|
||||
draft := &Draft{
|
||||
api: p.api,
|
||||
provider: p,
|
||||
@@ -136,9 +149,7 @@ func (p *DraftProvider) NewDraft(parseMode tgapi.ParseMode) *Draft {
|
||||
ID: id,
|
||||
Message: "",
|
||||
}
|
||||
p.mu.Lock()
|
||||
p.drafts[id] = draft
|
||||
p.mu.Unlock()
|
||||
return draft
|
||||
}
|
||||
|
||||
@@ -153,10 +164,9 @@ func (d *Draft) SetChat(chatID int64, messageThreadID int) *Draft {
|
||||
|
||||
// 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...))`.
|
||||
// The entities slice is copied.
|
||||
func (d *Draft) SetEntities(entities []tgapi.MessageEntity) *Draft {
|
||||
d.entities = entities
|
||||
d.entities = append([]tgapi.MessageEntity(nil), entities...)
|
||||
return d
|
||||
}
|
||||
|
||||
@@ -186,8 +196,7 @@ func (d *Draft) Clear() {
|
||||
|
||||
// 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.
|
||||
// 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()
|
||||
@@ -212,6 +221,7 @@ func (d *Draft) Delete() {
|
||||
// If the draft is empty, Flush() returns nil without calling the API.
|
||||
func (d *Draft) Flush() error {
|
||||
if d.Message == "" {
|
||||
d.Delete()
|
||||
return nil
|
||||
}
|
||||
if d.chatID == 0 {
|
||||
@@ -220,6 +230,9 @@ func (d *Draft) Flush() error {
|
||||
if err := validateMessageText(d.Message); err != nil {
|
||||
return err
|
||||
}
|
||||
if d.api == nil {
|
||||
return ErrAPIIsNil
|
||||
}
|
||||
|
||||
params := tgapi.SendMessage{
|
||||
ChatID: d.chatID,
|
||||
@@ -238,15 +251,23 @@ func (d *Draft) Flush() error {
|
||||
return err
|
||||
}
|
||||
|
||||
// Internal helper for Push that updates the server-side draft.
|
||||
// The candidate Message (current content + new text) is validated before any
|
||||
// mutation, so a validation failure leaves the draft unchanged. After the
|
||||
// validation passes, Message is committed locally regardless of whether the
|
||||
// API call succeeds (per the Push docs: local state reflects the user's
|
||||
// intent, network failures can be retried).
|
||||
func (d *Draft) push(text string) error {
|
||||
if d.chatID == 0 {
|
||||
return ErrDraftChatIDZero
|
||||
}
|
||||
d.Message += text
|
||||
if err := validateMessageText(d.Message); err != nil {
|
||||
candidate := d.Message + text
|
||||
if err := validateMessageText(candidate); err != nil {
|
||||
return err
|
||||
}
|
||||
d.Message = candidate
|
||||
if d.api == nil {
|
||||
return ErrAPIIsNil
|
||||
}
|
||||
params := tgapi.SendMessageDraft{
|
||||
ChatID: d.chatID,
|
||||
DraftID: d.ID,
|
||||
|
||||
+88
-5
@@ -6,37 +6,103 @@ import (
|
||||
"testing"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/slog"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
type sequenceDraftIDGenerator struct {
|
||||
ids []uint64
|
||||
pos int
|
||||
}
|
||||
|
||||
func (g *sequenceDraftIDGenerator) Next() uint64 {
|
||||
id := g.ids[g.pos]
|
||||
g.pos++
|
||||
return id
|
||||
}
|
||||
|
||||
func TestDraftFlushRequiresChatID(t *testing.T) {
|
||||
draft := NewRandomDraftProvider(&tgapi.API{}).NewDraft(tgapi.ParseNone)
|
||||
draft.Message = "hello"
|
||||
|
||||
if err := draft.Flush(); err != ErrDraftChatIDZero {
|
||||
if err := draft.Flush(); !errors.Is(err, ErrDraftChatIDZero) {
|
||||
t.Fatalf("expected ErrDraftChatIDZero, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDraftFlushEmptyRemovesDraft(t *testing.T) {
|
||||
provider := NewLinearDraftProvider(nil, 0)
|
||||
draft := provider.NewDraft(tgapi.ParseNone)
|
||||
|
||||
if err := draft.Flush(); err != nil {
|
||||
t.Fatalf("Flush returned error: %v", err)
|
||||
}
|
||||
if _, ok := provider.GetDraft(draft.ID); ok {
|
||||
t.Fatal("empty flushed draft remained in provider")
|
||||
}
|
||||
}
|
||||
|
||||
func TestDraftFlushAllRemovesClearedDrafts(t *testing.T) {
|
||||
provider := NewLinearDraftProvider(nil, 0)
|
||||
draft := provider.NewDraft(tgapi.ParseNone)
|
||||
draft.Message = "discarded"
|
||||
draft.Clear()
|
||||
|
||||
if err := provider.FlushAll(); err != nil {
|
||||
t.Fatalf("FlushAll returned error: %v", err)
|
||||
}
|
||||
if _, ok := provider.GetDraft(draft.ID); ok {
|
||||
t.Fatal("cleared draft remained in provider")
|
||||
}
|
||||
}
|
||||
|
||||
func TestMsgContextNewDraftWorksWithoutLimiter(t *testing.T) {
|
||||
ctx := &MsgContext{
|
||||
Api: &tgapi.API{},
|
||||
ctx := &MessageContext{
|
||||
API: &tgapi.API{},
|
||||
Msg: &tgapi.Message{
|
||||
Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate},
|
||||
},
|
||||
Logger: slog.CreateLogger(),
|
||||
Logger: sneklog.NewLogger(),
|
||||
draftProvider: NewRandomDraftProvider(&tgapi.API{}),
|
||||
}
|
||||
|
||||
draft := ctx.NewDraft()
|
||||
if draft == nil {
|
||||
t.Fatal("expected draft")
|
||||
return
|
||||
}
|
||||
if draft.chatID != 42 {
|
||||
t.Fatalf("unexpected chat id: %d", draft.chatID)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDraftProviderSkipsZeroAndCollidingIDs(t *testing.T) {
|
||||
provider := &DraftProvider{
|
||||
api: &tgapi.API{},
|
||||
drafts: make(map[uint64]*Draft),
|
||||
generator: &sequenceDraftIDGenerator{ids: []uint64{0, 7, 7, 8}},
|
||||
}
|
||||
|
||||
first := provider.NewDraft(tgapi.ParseNone)
|
||||
second := provider.NewDraft(tgapi.ParseNone)
|
||||
if first.ID != 7 || second.ID != 8 {
|
||||
t.Fatalf("unexpected draft IDs: first=%d second=%d", first.ID, second.ID)
|
||||
}
|
||||
if got := len(provider.drafts); got != 2 {
|
||||
t.Fatalf("collision overwrote a draft: got %d drafts", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDraftReturnsErrorWhenAPIIsNil(t *testing.T) {
|
||||
draft := NewLinearDraftProvider(nil, 0).NewDraft(tgapi.ParseNone).SetChat(42, 0)
|
||||
if err := draft.Push("hello"); !errors.Is(err, ErrAPIIsNil) {
|
||||
t.Fatalf("expected ErrAPIIsNil from Push, got %v", err)
|
||||
}
|
||||
draft.Message = "hello"
|
||||
if err := draft.Flush(); !errors.Is(err, ErrAPIIsNil) {
|
||||
t.Fatalf("expected ErrAPIIsNil from Flush, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDraftFlushRejectsLongMessage(t *testing.T) {
|
||||
draft := NewRandomDraftProvider(&tgapi.API{}).NewDraft(tgapi.ParseNone).SetChat(42, 0)
|
||||
draft.Message = strings.Repeat("a", maxMessageTextLen+1)
|
||||
@@ -53,3 +119,20 @@ func TestDraftPushRejectsLongMessage(t *testing.T) {
|
||||
t.Fatalf("expected ErrMessageTooLong, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// TestDraftPushLeavesMessageUnchangedOnValidationFailure covers the validation
|
||||
// order fix: when the candidate Message (current + new text) overflows the
|
||||
// Telegram limit, the existing Message must remain intact so callers can
|
||||
// recover and retry with a shorter payload instead of finding the draft in
|
||||
// a half-mutated state.
|
||||
func TestDraftPushLeavesMessageUnchangedOnValidationFailure(t *testing.T) {
|
||||
draft := NewRandomDraftProvider(&tgapi.API{}).NewDraft(tgapi.ParseNone).SetChat(42, 0)
|
||||
draft.Message = "hello"
|
||||
|
||||
if err := draft.Push(strings.Repeat("a", maxMessageTextLen+1)); !errors.Is(err, ErrMessageTooLong) {
|
||||
t.Fatalf("expected ErrMessageTooLong, got %v", err)
|
||||
}
|
||||
if draft.Message != "hello" {
|
||||
t.Fatalf("expected draft Message to stay %q, got %q", "hello", draft.Message)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -8,6 +8,7 @@ type classifiedError struct {
|
||||
internalOnly bool
|
||||
}
|
||||
|
||||
// Error returns the underlying error message.
|
||||
func (e *classifiedError) Error() string {
|
||||
if e == nil || e.err == nil {
|
||||
return ""
|
||||
@@ -15,6 +16,7 @@ func (e *classifiedError) Error() string {
|
||||
return e.err.Error()
|
||||
}
|
||||
|
||||
// Unwrap returns the underlying error.
|
||||
func (e *classifiedError) Unwrap() error {
|
||||
if e == nil {
|
||||
return nil
|
||||
|
||||
@@ -38,6 +38,10 @@ var (
|
||||
ErrAPIIsNil = errors.New("api is nil")
|
||||
// ErrMessageIDZero reports that an operation requires a non-zero message ID.
|
||||
ErrMessageIDZero = errors.New("message ID is zero")
|
||||
// ErrCodecIsNil reports that a config operation received a nil codec.
|
||||
ErrCodecIsNil = errors.New("codec is nil")
|
||||
)
|
||||
var (
|
||||
// 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.
|
||||
@@ -58,6 +62,51 @@ var (
|
||||
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")
|
||||
// ErrInvalidSceneAction reports a SceneResult with an unknown action.
|
||||
ErrInvalidSceneAction = errors.New("invalid scene action")
|
||||
// ErrHandlerExecutorNil reports an attempted registration or execution of a nil handler.
|
||||
ErrHandlerExecutorNil = errors.New("handler executor is nil")
|
||||
// ErrHandlerPanic reports a panic recovered from a user handler.
|
||||
ErrHandlerPanic = errors.New("handler panicked")
|
||||
// ErrObserverShutdownTimeout reports that observer callbacks did not stop before shutdown timed out.
|
||||
ErrObserverShutdownTimeout = errors.New("observer shutdown timed out")
|
||||
// ErrInlineKeyboardButtonAction reports a button without exactly one action.
|
||||
ErrInlineKeyboardButtonAction = errors.New("inline keyboard button must have exactly one action")
|
||||
// ErrCallbackDataLength reports callback data outside Telegram's 1-64 byte range.
|
||||
ErrCallbackDataLength = errors.New("callback data must be between 1 and 64 bytes")
|
||||
// ErrInlineKeyboardRowTooLong reports a row exceeding the configured maximum.
|
||||
ErrInlineKeyboardRowTooLong = errors.New("inline keyboard row exceeds maximum size")
|
||||
)
|
||||
|
||||
var (
|
||||
// ErrNilBotWebhookOpts reports that a nil BotWebhookOpts was passed.
|
||||
ErrNilBotWebhookOpts = errors.New("nil BotWebhookOpts")
|
||||
// ErrNoBotWebhookOptsURL reports that BotWebhookOpts.URL is empty.
|
||||
ErrNoBotWebhookOptsURL = errors.New("empty BotWebhookOpts.URL")
|
||||
// ErrBotWebhookOptsMaxConnectionsRange reports that BotWebhookOpts.MaxConnections is out of range.
|
||||
ErrBotWebhookOptsMaxConnectionsRange = errors.New("BotWebhookOpts.MaxConnections must be between 1 and 100")
|
||||
// ErrBotWebhookOptsSecretTokenInvalid reports that SecretToken violates Telegram's format.
|
||||
ErrBotWebhookOptsSecretTokenInvalid = errors.New("BotWebhookOpts.SecretToken must be 1-256 characters from A-Z, a-z, 0-9, _ and -")
|
||||
// ErrBotUploaderWhenCertificate reports that a certificate was set without an uploader.
|
||||
ErrBotUploaderWhenCertificate = errors.New("bot uploader nil, but certificate set")
|
||||
// ErrStatusPathSecretRequired reports that UseStatusPath requires SecretToken to be set.
|
||||
ErrStatusPathSecretRequired = errors.New("SecretToken required when UseStatusPath is enabled")
|
||||
// ErrSetWebhookFailed reports that Telegram rejected the setWebhook request.
|
||||
ErrSetWebhookFailed = errors.New("failed to set webhook")
|
||||
// ErrBotAPINil reports that an operation requires an API client but none is set.
|
||||
ErrBotAPINil = errors.New("bot api is nil")
|
||||
// ErrBotWebhookOptsEmptyPath reports that BotWebhookOpts.Path is empty.
|
||||
ErrBotWebhookOptsEmptyPath = errors.New("empty BotWebhookOpts.Path")
|
||||
// ErrBotWebhookOptsPathNoSlash reports that BotWebhookOpts.Path does not start with '/'.
|
||||
ErrBotWebhookOptsPathNoSlash = errors.New("BotWebhookOpts.Path must start with '/'")
|
||||
// ErrBotWebhookOptsPathHasQueryOrFragment reports that BotWebhookOpts.Path contains a query or fragment.
|
||||
ErrBotWebhookOptsPathHasQueryOrFragment = errors.New("BotWebhookOpts.Path must not contain query or fragment")
|
||||
// ErrBotWebhookOptsPathCollidesStatus reports that BotWebhookOpts.Path collides with the reserved /status endpoint.
|
||||
ErrBotWebhookOptsPathCollidesStatus = errors.New("BotWebhookOpts.Path must not be '/status' when status path is enabled")
|
||||
// ErrBotWebhookTLSFilesIncomplete reports that only one of the two TLS files was provided.
|
||||
ErrBotWebhookTLSFilesIncomplete = errors.New("you must specify both private and public keys")
|
||||
// ErrBotWebhookTLSFilesTooMany reports that more than two TLS files were provided.
|
||||
ErrBotWebhookTLSFilesTooMany = errors.New("too many files; you must specify only private and public keys")
|
||||
)
|
||||
|
||||
func validateMessageText(text string) error {
|
||||
|
||||
@@ -6,14 +6,7 @@ retract v1.0.0-rc.5
|
||||
|
||||
require (
|
||||
git.scuroneko.dev/scuroneko/extypes v1.2.3
|
||||
git.scuroneko.dev/scuroneko/slog v1.2.0
|
||||
github.com/alitto/pond/v2 v2.7.0
|
||||
git.scuroneko.dev/scuroneko/sneklog/v2 v2.3.0
|
||||
github.com/alitto/pond/v2 v2.7.1
|
||||
golang.org/x/time v0.15.0
|
||||
)
|
||||
|
||||
require (
|
||||
github.com/fatih/color v1.19.0 // indirect
|
||||
github.com/mattn/go-colorable v0.1.14 // indirect
|
||||
github.com/mattn/go-isatty v0.0.21 // indirect
|
||||
golang.org/x/sys v0.43.0 // indirect
|
||||
)
|
||||
|
||||
@@ -1,16 +1,8 @@
|
||||
git.scuroneko.dev/scuroneko/extypes v1.2.3 h1:n7QsfTZEn9fJNZLXGH/LkNq4cADaRk+LTu6LNMv9y6s=
|
||||
git.scuroneko.dev/scuroneko/extypes v1.2.3/go.mod h1:MhYpXC6sloLOpoM2guf64eSOrz+ET/QJZ8toobc3Ors=
|
||||
git.scuroneko.dev/scuroneko/slog v1.2.0 h1:xbwzrMcmN0NG/zTgEn508mn2JVnfZN5z/Zsi3PREfDM=
|
||||
git.scuroneko.dev/scuroneko/slog v1.2.0/go.mod h1:r+oz9NzvvdtWd9/PjeS+n5vQoNHL38BdcdLoBtJPvFU=
|
||||
github.com/alitto/pond/v2 v2.7.0 h1:c76L+yN916m/DRXjGCeUBHHu92uWnh/g1bwVk4zyyXg=
|
||||
github.com/alitto/pond/v2 v2.7.0/go.mod h1:xkjYEgQ05RSpWdfSd1nM3OVv7TBhLdy7rMp3+2Nq+yE=
|
||||
github.com/fatih/color v1.19.0 h1:Zp3PiM21/9Ld6FzSKyL5c/BULoe/ONr9KlbYVOfG8+w=
|
||||
github.com/fatih/color v1.19.0/go.mod h1:zNk67I0ZUT1bEGsSGyCZYZNrHuTkJJB+r6Q9VuMi0LE=
|
||||
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.21 h1:xYae+lCNBP7QuW4PUnNG61ffM4hVIfm+zUzDuSzYLGs=
|
||||
github.com/mattn/go-isatty v0.0.21/go.mod h1:ZXfXG4SQHsB/w3ZeOYbR0PrPwLy+n6xiMrJlRFqopa4=
|
||||
golang.org/x/sys v0.43.0 h1:Rlag2XtaFTxp19wS8MXlJwTvoh8ArU6ezoyFsMyCTNI=
|
||||
golang.org/x/sys v0.43.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
|
||||
git.scuroneko.dev/scuroneko/sneklog/v2 v2.3.0 h1:gaPe5azwuDTh48jRB/P2FUgOs7f1ToNr0S+NBizKvY8=
|
||||
git.scuroneko.dev/scuroneko/sneklog/v2 v2.3.0/go.mod h1:q8XnLXzLdGjW0Jtcbh9/+G9WmfD68rsPQvLXEPxvum4=
|
||||
github.com/alitto/pond/v2 v2.7.1 h1:QxMbcfjcVTa0pyxX5Ib1226mM8u8D7gKUVkCUU4DYIw=
|
||||
github.com/alitto/pond/v2 v2.7.1/go.mod h1:xkjYEgQ05RSpWdfSd1nM3OVv7TBhLdy7rMp3+2Nq+yE=
|
||||
golang.org/x/time v0.15.0 h1:bbrp8t3bGUeFOx08pvsMYRTCVSMk89u4tKbNOZbp88U=
|
||||
golang.org/x/time v0.15.0/go.mod h1:Y4YMaQmXwGQZoFaVFk4YpCt4FLQMYKZe9oeV/f4MSno=
|
||||
|
||||
+194
-49
@@ -6,6 +6,7 @@ import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
@@ -14,10 +15,27 @@ import (
|
||||
// ErrInvalidPayloadType is returned when callback payload encoding type is unknown.
|
||||
var ErrInvalidPayloadType = errors.New("invalid payload type")
|
||||
|
||||
// ErrInvalidPayload reports that a callback payload could not be decoded under the
|
||||
// expected encoding (e.g. the compact format separator is missing).
|
||||
var ErrInvalidPayload = errors.New("invalid payload")
|
||||
|
||||
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))
|
||||
if bot.logger != nil {
|
||||
bot.logger.Errorln(fmt.Sprintf("panic in handle: %v", r))
|
||||
}
|
||||
|
||||
err, ok := r.(error)
|
||||
if !ok {
|
||||
err = fmt.Errorf("%v", r)
|
||||
}
|
||||
bot.safeEmitEvent(parentCtx, ErrorEvent{
|
||||
UpdateID: u.UpdateID,
|
||||
UpdateType: u.Type,
|
||||
Err: err,
|
||||
UserFacing: false,
|
||||
})
|
||||
}
|
||||
}()
|
||||
startTime := time.Now()
|
||||
@@ -25,15 +43,18 @@ func (bot *Bot[T]) handle(parentCtx context.Context, u *tgapi.Update) {
|
||||
ctx, cancel := context.WithCancel(parentCtx)
|
||||
defer cancel()
|
||||
|
||||
msgCtx := &MsgContext{
|
||||
Update: *u, Api: bot.api,
|
||||
msgCtx := &MessageContext{
|
||||
Update: *u, API: bot.api,
|
||||
Logger: bot.logger,
|
||||
errorTemplate: bot.errorTemplate,
|
||||
l10n: bot.l10n,
|
||||
draftProvider: bot.draftProvider,
|
||||
sceneRuntime: bot,
|
||||
observer: bot.observer,
|
||||
eventEmitter: bot.safeEmitEvent,
|
||||
asyncTask: bot.startAsyncTask,
|
||||
payloadType: bot.payloadType,
|
||||
botID: bot.userID,
|
||||
ctx: ctx,
|
||||
}
|
||||
bot.prepareUpdateCtx(u, msgCtx)
|
||||
@@ -46,13 +67,21 @@ func (bot *Bot[T]) handle(parentCtx context.Context, u *tgapi.Update) {
|
||||
|
||||
for _, middleware := range bot.middlewares {
|
||||
if !middleware.Execute(msgCtx, bot.appData) {
|
||||
bot.safeEmitEvent(ctx, UpdateHandledEvent{
|
||||
UpdateID: u.UpdateID,
|
||||
UpdateType: u.Type,
|
||||
FromID: msgCtx.FromID,
|
||||
ChatID: msgCtx.ChatID,
|
||||
Duration: time.Since(startTime),
|
||||
Handled: false,
|
||||
})
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
sceneHandled, err := bot.tryHandleScene(msgCtx)
|
||||
if err != nil {
|
||||
bot.logger.Errorln(err)
|
||||
msgCtx.error(err)
|
||||
bot.safeEmitEvent(ctx, UpdateHandledEvent{
|
||||
UpdateID: u.UpdateID,
|
||||
UpdateType: u.Type,
|
||||
@@ -61,17 +90,20 @@ func (bot *Bot[T]) handle(parentCtx context.Context, u *tgapi.Update) {
|
||||
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,
|
||||
})
|
||||
var reported *reportedSceneError
|
||||
if !errors.As(err, &reported) {
|
||||
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: IsUserError(err),
|
||||
})
|
||||
}
|
||||
return
|
||||
}
|
||||
if sceneHandled {
|
||||
@@ -105,7 +137,7 @@ func (bot *Bot[T]) handle(parentCtx context.Context, u *tgapi.Update) {
|
||||
})
|
||||
}
|
||||
|
||||
func cloneMsgContext(src *MsgContext) *MsgContext {
|
||||
func cloneMsgContext(src *MessageContext) *MessageContext {
|
||||
cloned := *src
|
||||
if src.Args != nil {
|
||||
cloned.Args = append([]string(nil), src.Args...)
|
||||
@@ -113,7 +145,7 @@ func cloneMsgContext(src *MsgContext) *MsgContext {
|
||||
return &cloned
|
||||
}
|
||||
|
||||
func encodeJsonPayload(d CallbackData) (string, error) {
|
||||
func encodeJSONPayload(d CallbackData) (string, error) {
|
||||
b, err := json.Marshal(d)
|
||||
if err != nil {
|
||||
return "", err
|
||||
@@ -121,14 +153,14 @@ func encodeJsonPayload(d CallbackData) (string, error) {
|
||||
return string(b), nil
|
||||
}
|
||||
|
||||
func decodeJsonPayload(s string) (CallbackData, error) {
|
||||
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)
|
||||
data, err := encodeJSONPayload(d)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
@@ -142,39 +174,152 @@ func decodeBase64Payload(s string) (CallbackData, error) {
|
||||
if err != nil {
|
||||
return CallbackData{}, err
|
||||
}
|
||||
return decodeJsonPayload(string(b))
|
||||
return decodeJSONPayload(string(b))
|
||||
}
|
||||
|
||||
// Compact payload format: cmd|arg1,arg2,...
|
||||
// Bytes \, |, and , inside a part are escaped with a leading backslash so the
|
||||
// payload round-trips without ambiguity. Encoding/decoding operate byte-wise
|
||||
// because all separators are single-byte ASCII; multi-byte UTF-8 code points
|
||||
// pass through unchanged.
|
||||
|
||||
func encodeCompactPart(s string) string {
|
||||
if !strings.ContainsAny(s, `\|,`) {
|
||||
return s
|
||||
}
|
||||
var b strings.Builder
|
||||
b.Grow(len(s) + 2)
|
||||
for i := 0; i < len(s); i++ {
|
||||
switch s[i] {
|
||||
case '\\', '|', ',':
|
||||
b.WriteByte('\\')
|
||||
}
|
||||
b.WriteByte(s[i])
|
||||
}
|
||||
return b.String()
|
||||
}
|
||||
|
||||
func decodeCompactPart(s string) string {
|
||||
if !strings.Contains(s, `\`) {
|
||||
return s
|
||||
}
|
||||
var b strings.Builder
|
||||
b.Grow(len(s))
|
||||
for i := 0; i < len(s); i++ {
|
||||
if s[i] == '\\' && i+1 < len(s) {
|
||||
b.WriteByte(s[i+1])
|
||||
i++
|
||||
continue
|
||||
}
|
||||
b.WriteByte(s[i])
|
||||
}
|
||||
return b.String()
|
||||
}
|
||||
|
||||
func encodeCompactPayload(d CallbackData) (string, error) {
|
||||
var b strings.Builder
|
||||
b.WriteString(encodeCompactPart(d.Command))
|
||||
b.WriteByte('|')
|
||||
for i, a := range d.Args {
|
||||
if i > 0 {
|
||||
b.WriteByte(',')
|
||||
}
|
||||
b.WriteString(encodeCompactPart(a))
|
||||
}
|
||||
return b.String(), nil
|
||||
}
|
||||
|
||||
func decodeCompactPayload(s string) (CallbackData, error) {
|
||||
sepIdx := -1
|
||||
for i := 0; i < len(s); i++ {
|
||||
if s[i] == '\\' && i+1 < len(s) {
|
||||
i++
|
||||
continue
|
||||
}
|
||||
if s[i] == '|' {
|
||||
sepIdx = i
|
||||
break
|
||||
}
|
||||
}
|
||||
if sepIdx == -1 {
|
||||
return CallbackData{}, ErrInvalidPayload
|
||||
}
|
||||
cmd := decodeCompactPart(s[:sepIdx])
|
||||
argsRaw := s[sepIdx+1:]
|
||||
if argsRaw == "" {
|
||||
return CallbackData{Command: cmd}, nil
|
||||
}
|
||||
|
||||
var args []string
|
||||
start := 0
|
||||
for i := 0; i < len(argsRaw); i++ {
|
||||
if argsRaw[i] == '\\' && i+1 < len(argsRaw) {
|
||||
i++
|
||||
continue
|
||||
}
|
||||
if argsRaw[i] == ',' {
|
||||
args = append(args, decodeCompactPart(argsRaw[start:i]))
|
||||
start = i + 1
|
||||
}
|
||||
}
|
||||
args = append(args, decodeCompactPart(argsRaw[start:]))
|
||||
return CallbackData{Command: cmd, Args: args}, nil
|
||||
}
|
||||
func encodeCompactBase64Payload(d CallbackData) (string, error) {
|
||||
payload, _ := encodeCompactPayload(d)
|
||||
return base64.RawURLEncoding.EncodeToString([]byte(payload)), nil
|
||||
}
|
||||
func decodeCompactBase64Payload(s string) (CallbackData, error) {
|
||||
b, err := base64.RawURLEncoding.DecodeString(s)
|
||||
if err != nil {
|
||||
return CallbackData{}, err
|
||||
}
|
||||
return decodeCompactPayload(string(b))
|
||||
}
|
||||
|
||||
func decodePayloadAs(payloadType BotPayloadType, s string) (CallbackData, error) {
|
||||
switch payloadType {
|
||||
case BotPayloadBase64:
|
||||
return decodeBase64Payload(s)
|
||||
case BotPayloadJSON:
|
||||
return decodeJSONPayload(s)
|
||||
case BotPayloadCompact:
|
||||
return decodeCompactPayload(s)
|
||||
case BotPayloadCompactBase64:
|
||||
return decodeCompactBase64Payload(s)
|
||||
}
|
||||
return CallbackData{}, ErrInvalidPayloadType
|
||||
}
|
||||
|
||||
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
|
||||
knownTypes := []BotPayloadType{
|
||||
BotPayloadBase64,
|
||||
BotPayloadJSON,
|
||||
BotPayloadCompact,
|
||||
BotPayloadCompactBase64,
|
||||
}
|
||||
return CallbackData{}, "", ErrInvalidPayloadType
|
||||
if _, err := decodePayloadAs(payloadType, ""); errors.Is(err, ErrInvalidPayloadType) {
|
||||
return CallbackData{}, "", ErrInvalidPayloadType
|
||||
}
|
||||
|
||||
data, err := decodePayloadAs(payloadType, s)
|
||||
if err == nil {
|
||||
return data, payloadType, nil
|
||||
}
|
||||
if strict {
|
||||
return CallbackData{}, "", fmt.Errorf("%w: expected %s", ErrPayloadTypeMismatch, payloadType)
|
||||
}
|
||||
|
||||
for _, candidate := range knownTypes {
|
||||
if candidate == payloadType {
|
||||
continue
|
||||
}
|
||||
data, err = decodePayloadAs(candidate, s)
|
||||
if err == nil {
|
||||
return data, candidate, nil
|
||||
}
|
||||
}
|
||||
return CallbackData{}, "", err
|
||||
}
|
||||
|
||||
func (bot *Bot[T]) decodePayload(s string) (CallbackData, error) {
|
||||
@@ -183,7 +328,7 @@ func (bot *Bot[T]) decodePayload(s string) (CallbackData, error) {
|
||||
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())
|
||||
bot.logger.Debugf("decoded callback payload base64->json: raw=%q json=%s", s, data.ToJSON())
|
||||
}
|
||||
return data, nil
|
||||
}
|
||||
|
||||
+569
-94
@@ -3,13 +3,18 @@ package laniakea
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"io"
|
||||
"net/http"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/slog"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
type recordingObserver struct {
|
||||
received []UpdateReceivedEvent
|
||||
started []HandlerStartedEvent
|
||||
finished []HandlerFinishedEvent
|
||||
errors []ErrorEvent
|
||||
@@ -19,8 +24,10 @@ type recordingObserver struct {
|
||||
retries []PollingRetryEvent
|
||||
}
|
||||
|
||||
func (*recordingObserver) OnReceiveUpdate(context.Context, UpdateReceivedEvent) {}
|
||||
func (o *recordingObserver) OnHandledUpdate(_ context.Context, ev UpdateHandledEvent) {
|
||||
func (o *recordingObserver) OnUpdateReceived(_ context.Context, ev UpdateReceivedEvent) {
|
||||
o.received = append(o.received, ev)
|
||||
}
|
||||
func (o *recordingObserver) OnUpdateHandled(_ context.Context, ev UpdateHandledEvent) {
|
||||
o.handled = append(o.handled, ev)
|
||||
}
|
||||
func (o *recordingObserver) OnHandlerStarted(_ context.Context, ev HandlerStartedEvent) {
|
||||
@@ -55,13 +62,13 @@ func TestCheckPrefixesSkipsEmptyPrefixes(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestBotMiddlewareReceivesLogger(t *testing.T) {
|
||||
logger := slog.CreateLogger()
|
||||
logger := sneklog.NewLogger()
|
||||
called := false
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: logger,
|
||||
middlewares: []Middleware[NoData]{
|
||||
NewMiddleware("logger-check", func(ctx *MsgContext, db NoData) bool {
|
||||
NewMiddleware("logger-check", func(ctx *MessageContext, db NoData) bool {
|
||||
called = true
|
||||
if ctx.Logger != logger {
|
||||
t.Fatalf("expected bot logger in middleware context, got %#v", ctx.Logger)
|
||||
@@ -87,7 +94,7 @@ func TestBotMiddlewareReceivesLogger(t *testing.T) {
|
||||
|
||||
func TestAddUpdateHandlerRejectsReservedUpdateTypes(t *testing.T) {
|
||||
plugin := NewPlugin[NoData]("test")
|
||||
handler := func(ctx *MsgContext, db NoData) error { return nil }
|
||||
handler := func(ctx *MessageContext, db NoData) error { return nil }
|
||||
|
||||
for _, updateType := range []tgapi.UpdateType{
|
||||
tgapi.UpdateTypeMessage,
|
||||
@@ -315,6 +322,15 @@ func TestPrepareUpdateCtxContract(t *testing.T) {
|
||||
wantFrom: true,
|
||||
wantFromID: 115,
|
||||
},
|
||||
{
|
||||
name: "anonymous poll answer",
|
||||
update: &tgapi.Update{
|
||||
Type: tgapi.UpdateTypePollAnswer,
|
||||
PollAnswer: &tgapi.PollAnswer{VoterChat: tgapi.Chat{ID: -2007}},
|
||||
},
|
||||
wantChat: true,
|
||||
wantChatID: -2007,
|
||||
},
|
||||
{
|
||||
name: "message reaction",
|
||||
update: &tgapi.Update{
|
||||
@@ -365,15 +381,71 @@ func TestPrepareUpdateCtxContract(t *testing.T) {
|
||||
name: "message reaction count",
|
||||
update: &tgapi.Update{
|
||||
Type: tgapi.UpdateTypeMessageReactionCount,
|
||||
MessageReactionCount: &tgapi.MessageReactionCountUpdated{},
|
||||
MessageReactionCount: &tgapi.MessageReactionCountUpdated{Chat: &tgapi.Chat{ID: -2008}},
|
||||
},
|
||||
wantChat: true,
|
||||
wantChatID: -2008,
|
||||
},
|
||||
{
|
||||
name: "guest message",
|
||||
update: &tgapi.Update{
|
||||
Type: tgapi.UpdateTypeGuestMessage,
|
||||
GuestMessage: &tgapi.Message{
|
||||
From: &tgapi.User{ID: 119},
|
||||
Chat: &tgapi.Chat{ID: -2009},
|
||||
},
|
||||
},
|
||||
wantMsg: true,
|
||||
wantFrom: true,
|
||||
wantFromID: 119,
|
||||
wantChat: true,
|
||||
wantChatID: -2009,
|
||||
},
|
||||
{
|
||||
name: "deleted business messages",
|
||||
update: &tgapi.Update{
|
||||
Type: tgapi.UpdateTypeDeletedBusinessMessages,
|
||||
DeletedBusinessMessages: &tgapi.BusinessMessagesDeleted{Chat: tgapi.Chat{ID: -2010}},
|
||||
},
|
||||
wantChat: true,
|
||||
wantChatID: -2010,
|
||||
},
|
||||
{
|
||||
name: "managed bot",
|
||||
update: &tgapi.Update{
|
||||
Type: tgapi.UpdateTypeManagedBot,
|
||||
ManagedBot: &tgapi.ManagedBotUpdated{User: tgapi.User{ID: 120}},
|
||||
},
|
||||
wantFrom: true,
|
||||
wantFromID: 120,
|
||||
},
|
||||
{
|
||||
name: "subscription",
|
||||
update: &tgapi.Update{
|
||||
Type: tgapi.UpdateTypeSubscription,
|
||||
Subscription: &tgapi.BotSubscriptionUpdated{User: tgapi.User{ID: 121}},
|
||||
},
|
||||
wantFrom: true,
|
||||
wantFromID: 121,
|
||||
},
|
||||
{
|
||||
name: "giveaway chat boost has no user",
|
||||
update: &tgapi.Update{
|
||||
Type: tgapi.UpdateTypeChatBoost,
|
||||
ChatBoost: &tgapi.ChatBoostUpdated{
|
||||
Chat: tgapi.Chat{ID: -2011},
|
||||
Boost: tgapi.ChatBoost{Source: tgapi.ChatBoostSource{Source: "giveaway"}},
|
||||
},
|
||||
},
|
||||
wantChat: true,
|
||||
wantChatID: -2011,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
bot := &Bot[NoData]{}
|
||||
ctx := &MsgContext{}
|
||||
ctx := &MessageContext{}
|
||||
bot.prepareUpdateCtx(tt.update, ctx)
|
||||
|
||||
if got := ctx.Msg != nil; got != tt.wantMsg {
|
||||
@@ -391,14 +463,14 @@ func TestPrepareUpdateCtxContract(t *testing.T) {
|
||||
if ctx.ChatID != tt.wantChatID {
|
||||
t.Fatalf("unexpected ChatID: got %d want %d", ctx.ChatID, tt.wantChatID)
|
||||
}
|
||||
if ctx.CallbackQueryId != tt.wantCallbackID {
|
||||
t.Fatalf("unexpected CallbackQueryId: got %q want %q", ctx.CallbackQueryId, tt.wantCallbackID)
|
||||
if ctx.CallbackQueryID != tt.wantCallbackID {
|
||||
t.Fatalf("unexpected CallbackQueryID: got %q want %q", ctx.CallbackQueryID, tt.wantCallbackID)
|
||||
}
|
||||
if ctx.CallbackMsgId != tt.wantCallbackMsgID {
|
||||
t.Fatalf("unexpected CallbackMsgId: got %d want %d", ctx.CallbackMsgId, tt.wantCallbackMsgID)
|
||||
if ctx.CallbackMsgID != tt.wantCallbackMsgID {
|
||||
t.Fatalf("unexpected CallbackMsgID: got %d want %d", ctx.CallbackMsgID, tt.wantCallbackMsgID)
|
||||
}
|
||||
if ctx.InlineMsgId != tt.wantInlineMsgID {
|
||||
t.Fatalf("unexpected InlineMsgId: got %q want %q", ctx.InlineMsgId, tt.wantInlineMsgID)
|
||||
if ctx.InlineMsgID != tt.wantInlineMsgID {
|
||||
t.Fatalf("unexpected InlineMsgID: got %q want %q", ctx.InlineMsgID, tt.wantInlineMsgID)
|
||||
}
|
||||
if ctx.Text != "" {
|
||||
t.Fatalf("prepareUpdateCtx must not populate Text, got %q", ctx.Text)
|
||||
@@ -447,7 +519,7 @@ func TestHandleUpdateHandlersPopulateFromContext(t *testing.T) {
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
called := false
|
||||
plugin := NewPlugin[NoData]("test").AddUpdateHandler(tt.update.Type, func(ctx *MsgContext, db NoData) error {
|
||||
plugin := NewPlugin[NoData]("test").AddUpdateHandler(tt.update.Type, func(ctx *MessageContext, db NoData) error {
|
||||
called = true
|
||||
if ctx.Update.UpdateID != tt.update.UpdateID {
|
||||
t.Fatalf("unexpected update in context: got %d want %d", ctx.Update.UpdateID, tt.update.UpdateID)
|
||||
@@ -468,7 +540,7 @@ func TestHandleUpdateHandlersPopulateFromContext(t *testing.T) {
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
plugins: []Plugin[NoData]{clonePlugin(plugin)},
|
||||
}
|
||||
|
||||
@@ -485,7 +557,7 @@ func TestHandleUpdateHandlersReceiveIsolatedContexts(t *testing.T) {
|
||||
firstCalled := false
|
||||
secondCalled := false
|
||||
|
||||
first := NewPlugin[NoData]("first").AddUpdateHandler(tgapi.UpdateTypeInlineQuery, func(ctx *MsgContext, db NoData) error {
|
||||
first := NewPlugin[NoData]("first").AddUpdateHandler(tgapi.UpdateTypeInlineQuery, func(ctx *MessageContext, db NoData) error {
|
||||
firstCalled = true
|
||||
if ctx.FromID != 41 {
|
||||
t.Fatalf("unexpected FromID in first handler: got %d want 41", ctx.FromID)
|
||||
@@ -496,7 +568,7 @@ func TestHandleUpdateHandlersReceiveIsolatedContexts(t *testing.T) {
|
||||
ctx.Args = []string{"mutated"}
|
||||
return nil
|
||||
})
|
||||
second := NewPlugin[NoData]("second").AddUpdateHandler(tgapi.UpdateTypeInlineQuery, func(ctx *MsgContext, db NoData) error {
|
||||
second := NewPlugin[NoData]("second").AddUpdateHandler(tgapi.UpdateTypeInlineQuery, func(ctx *MessageContext, db NoData) error {
|
||||
secondCalled = true
|
||||
if ctx.From == nil {
|
||||
t.Fatal("expected ctx.From to remain populated for second handler")
|
||||
@@ -514,7 +586,7 @@ func TestHandleUpdateHandlersReceiveIsolatedContexts(t *testing.T) {
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
plugins: []Plugin[NoData]{
|
||||
clonePlugin(first),
|
||||
clonePlugin(second),
|
||||
@@ -538,12 +610,12 @@ func TestHandleUpdateHandlersReceiveIsolatedContexts(t *testing.T) {
|
||||
|
||||
func TestHandleUpdateObserverEmitsUpdateErrors(t *testing.T) {
|
||||
observer := &recordingObserver{}
|
||||
plugin := NewPlugin[NoData]("test").AddUpdateHandler(tgapi.UpdateTypeInlineQuery, func(ctx *MsgContext, db NoData) error {
|
||||
plugin := NewPlugin[NoData]("test").AddUpdateHandler(tgapi.UpdateTypeInlineQuery, func(ctx *MessageContext, db NoData) error {
|
||||
return AsUserError(errors.New("update failed"))
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
plugins: []Plugin[NoData]{clonePlugin(plugin)},
|
||||
observer: observer,
|
||||
}
|
||||
@@ -587,11 +659,49 @@ func TestHandleUpdateObserverEmitsUpdateErrors(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandleObserverCompletesUpdateWhenBotMiddlewareBlocks(t *testing.T) {
|
||||
observer := &recordingObserver{}
|
||||
bot := &Bot[NoData]{
|
||||
logger: sneklog.NewLogger(),
|
||||
observer: observer,
|
||||
middlewares: []Middleware[NoData]{
|
||||
NewMiddleware("block", func(ctx *MessageContext, db NoData) bool {
|
||||
return false
|
||||
}),
|
||||
},
|
||||
}
|
||||
|
||||
bot.handle(context.Background(), &tgapi.Update{
|
||||
UpdateID: 8,
|
||||
Type: tgapi.UpdateTypeMessage,
|
||||
Message: &tgapi.Message{
|
||||
MessageID: 1,
|
||||
Date: 1,
|
||||
Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate},
|
||||
Text: "/start",
|
||||
},
|
||||
})
|
||||
|
||||
if len(observer.received) != 1 {
|
||||
t.Fatalf("expected one received event, got %d", len(observer.received))
|
||||
}
|
||||
if len(observer.handled) != 1 {
|
||||
t.Fatalf("expected one handled event, got %d", len(observer.handled))
|
||||
}
|
||||
got := observer.handled[0]
|
||||
if got.UpdateID != 8 || got.UpdateType != tgapi.UpdateTypeMessage || got.ChatID != 42 || got.Handled {
|
||||
t.Fatalf("unexpected handled event: %#v", got)
|
||||
}
|
||||
if len(observer.started) != 0 || len(observer.finished) != 0 || len(observer.errors) != 0 {
|
||||
t.Fatalf("middleware block should not emit handler lifecycle or errors: started=%d finished=%d errors=%d", len(observer.started), len(observer.finished), len(observer.errors))
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandleMessageFallbackRunsAfterCommandMiss(t *testing.T) {
|
||||
observer := &recordingObserver{}
|
||||
called := false
|
||||
plugin := NewPlugin[NoData]("test")
|
||||
plugin.SetMessageFallback(func(ctx *MsgContext, db NoData) error {
|
||||
plugin.SetMessageFallback(func(ctx *MessageContext, db NoData) error {
|
||||
called = true
|
||||
if ctx.Text != "/missing hello world" {
|
||||
t.Fatalf("unexpected fallback text: got %q", ctx.Text)
|
||||
@@ -607,7 +717,7 @@ func TestHandleMessageFallbackRunsAfterCommandMiss(t *testing.T) {
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
prefixes: []string{"/"},
|
||||
observer: observer,
|
||||
}
|
||||
@@ -646,7 +756,7 @@ func TestHandleMessageFallbackRunsAfterCommandMiss(t *testing.T) {
|
||||
|
||||
func TestHandleMessageFallbackRunsForPlainText(t *testing.T) {
|
||||
called := false
|
||||
plugin := NewPlugin[NoData]("test").SetMessageFallback(func(ctx *MsgContext, db NoData) error {
|
||||
plugin := NewPlugin[NoData]("test").SetMessageFallback(func(ctx *MessageContext, db NoData) error {
|
||||
called = true
|
||||
if ctx.Text != "hello fallback" {
|
||||
t.Fatalf("unexpected fallback text: got %q", ctx.Text)
|
||||
@@ -658,7 +768,7 @@ func TestHandleMessageFallbackRunsForPlainText(t *testing.T) {
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
prefixes: []string{"/"},
|
||||
}
|
||||
bot.AddPlugins(plugin)
|
||||
@@ -682,16 +792,16 @@ func TestHandleMessageFallbackRunsForPlainText(t *testing.T) {
|
||||
func TestHandleMessageFallbackRespectsMiddleware(t *testing.T) {
|
||||
called := false
|
||||
plugin := NewPlugin[NoData]("test")
|
||||
plugin.AddMiddleware(NewMiddleware("block", func(ctx *MsgContext, db NoData) bool {
|
||||
plugin.AddMiddleware(NewMiddleware("block", func(ctx *MessageContext, db NoData) bool {
|
||||
return false
|
||||
}))
|
||||
plugin.SetMessageFallback(func(ctx *MsgContext, db NoData) error {
|
||||
plugin.SetMessageFallback(func(ctx *MessageContext, db NoData) error {
|
||||
called = true
|
||||
return nil
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
prefixes: []string{"/"},
|
||||
}
|
||||
bot.AddPlugins(plugin)
|
||||
@@ -716,17 +826,17 @@ func TestHandleMessageFallbackDoesNotRunWhenCommandMatches(t *testing.T) {
|
||||
commandCalled := false
|
||||
fallbackCalled := false
|
||||
plugin := NewPlugin[NoData]("test")
|
||||
plugin.NewCommand(func(ctx *MsgContext, db NoData) error {
|
||||
plugin.Command("start", func(ctx *MessageContext, db NoData) error {
|
||||
commandCalled = true
|
||||
return nil
|
||||
}, "start")
|
||||
plugin.SetMessageFallback(func(ctx *MsgContext, db NoData) error {
|
||||
})
|
||||
plugin.SetMessageFallback(func(ctx *MessageContext, db NoData) error {
|
||||
fallbackCalled = true
|
||||
return nil
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
prefixes: []string{"/"},
|
||||
}
|
||||
bot.AddPlugins(plugin)
|
||||
@@ -753,7 +863,7 @@ func TestHandleMessageFallbackDoesNotRunWhenCommandMatches(t *testing.T) {
|
||||
func TestHandleChannelPostCommandWithSenderChat(t *testing.T) {
|
||||
called := false
|
||||
plugin := NewPlugin[NoData]("test")
|
||||
plugin.NewCommand(func(ctx *MsgContext, db NoData) error {
|
||||
plugin.Command("ping", func(ctx *MessageContext, db NoData) error {
|
||||
called = true
|
||||
if ctx.Msg == nil {
|
||||
t.Fatal("expected message context")
|
||||
@@ -768,10 +878,10 @@ func TestHandleChannelPostCommandWithSenderChat(t *testing.T) {
|
||||
t.Fatalf("expected zero FromID for sender_chat updates, got %d", ctx.FromID)
|
||||
}
|
||||
return nil
|
||||
}, "ping")
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
prefixes: []string{"/"},
|
||||
plugins: []Plugin[NoData]{clonePlugin(plugin)},
|
||||
}
|
||||
@@ -800,15 +910,15 @@ func TestCommandHandlerBindArgsEndToEnd(t *testing.T) {
|
||||
|
||||
var got banInput
|
||||
plugin := NewPlugin[NoData]("test")
|
||||
plugin.NewCommand(func(ctx *MsgContext, db NoData) error {
|
||||
plugin.Command("ban", func(ctx *MessageContext, db NoData) error {
|
||||
return ctx.BindArgs(&got)
|
||||
}, "ban",
|
||||
NewCommandArg("user_id").SetValueType(CommandValueIntType).SetRequired(),
|
||||
},
|
||||
NewCommandArg("user_id").SetValueType(CommandValueInt).SetRequired(),
|
||||
NewCommandArg("reason").SetRequired(),
|
||||
)
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
prefixes: []string{"/"},
|
||||
plugins: []Plugin[NoData]{clonePlugin(plugin)},
|
||||
}
|
||||
@@ -837,25 +947,25 @@ func TestPayloadHandlerBindArgsEndToEnd(t *testing.T) {
|
||||
|
||||
var got payloadInput
|
||||
plugin := NewPlugin[NoData]("test")
|
||||
plugin.NewPayload(func(ctx *MsgContext, db NoData) error {
|
||||
plugin.Payload("approve", func(ctx *MessageContext, db NoData) error {
|
||||
return ctx.BindArgs(&got)
|
||||
}, "approve",
|
||||
NewCommandArg("id").SetValueType(CommandValueIntType).SetRequired(),
|
||||
},
|
||||
NewCommandArg("id").SetValueType(CommandValueInt).SetRequired(),
|
||||
NewCommandArg("note").SetRequired(),
|
||||
)
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
payloadType: BotPayloadJson,
|
||||
logger: sneklog.NewLogger(),
|
||||
payloadType: BotPayloadJSON,
|
||||
plugins: []Plugin[NoData]{clonePlugin(plugin)},
|
||||
}
|
||||
|
||||
data, err := encodeJsonPayload(CallbackData{
|
||||
data, err := encodeJSONPayload(CallbackData{
|
||||
Command: "approve",
|
||||
Args: []string{"7", "looks", "good"},
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("encodeJsonPayload returned error: %v", err)
|
||||
t.Fatalf("encodeJSONPayload returned error: %v", err)
|
||||
}
|
||||
|
||||
bot.handle(context.Background(), &tgapi.Update{
|
||||
@@ -879,11 +989,11 @@ func TestHandleEditedMessageStaysOutOfCommandFlow(t *testing.T) {
|
||||
updateCalled := false
|
||||
|
||||
plugin := NewPlugin[NoData]("test")
|
||||
plugin.NewCommand(func(ctx *MsgContext, db NoData) error {
|
||||
plugin.Command("ping", func(ctx *MessageContext, db NoData) error {
|
||||
commandCalled = true
|
||||
return nil
|
||||
}, "ping")
|
||||
plugin.AddUpdateHandler(tgapi.UpdateTypeEditedMessage, func(ctx *MsgContext, db NoData) error {
|
||||
})
|
||||
plugin.AddUpdateHandler(tgapi.UpdateTypeEditedMessage, func(ctx *MessageContext, db NoData) error {
|
||||
updateCalled = true
|
||||
if ctx.Msg == nil {
|
||||
t.Fatal("expected ctx.Msg in edited message handler")
|
||||
@@ -898,7 +1008,7 @@ func TestHandleEditedMessageStaysOutOfCommandFlow(t *testing.T) {
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
prefixes: []string{"/"},
|
||||
plugins: []Plugin[NoData]{clonePlugin(plugin)},
|
||||
}
|
||||
@@ -927,11 +1037,11 @@ func TestHandleEditedChannelPostStaysOutOfCommandFlow(t *testing.T) {
|
||||
updateCalled := false
|
||||
|
||||
plugin := NewPlugin[NoData]("test")
|
||||
plugin.NewCommand(func(ctx *MsgContext, db NoData) error {
|
||||
plugin.Command("ping", func(ctx *MessageContext, db NoData) error {
|
||||
commandCalled = true
|
||||
return nil
|
||||
}, "ping")
|
||||
plugin.AddUpdateHandler(tgapi.UpdateTypeEditedChannelPost, func(ctx *MsgContext, db NoData) error {
|
||||
})
|
||||
plugin.AddUpdateHandler(tgapi.UpdateTypeEditedChannelPost, func(ctx *MessageContext, db NoData) error {
|
||||
updateCalled = true
|
||||
if ctx.Msg == nil {
|
||||
t.Fatal("expected ctx.Msg in edited channel post handler")
|
||||
@@ -940,7 +1050,7 @@ func TestHandleEditedChannelPostStaysOutOfCommandFlow(t *testing.T) {
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
prefixes: []string{"/"},
|
||||
plugins: []Plugin[NoData]{clonePlugin(plugin)},
|
||||
}
|
||||
@@ -966,16 +1076,16 @@ func TestHandleEditedChannelPostStaysOutOfCommandFlow(t *testing.T) {
|
||||
func TestHandleCallbackPopulatesMessageTargets(t *testing.T) {
|
||||
called := false
|
||||
plugin := NewPlugin[NoData]("test")
|
||||
plugin.NewPayload(func(ctx *MsgContext, db NoData) error {
|
||||
plugin.Payload("approve", func(ctx *MessageContext, db NoData) error {
|
||||
called = true
|
||||
if ctx.CallbackQueryId != "cb-msg" {
|
||||
t.Fatalf("unexpected CallbackQueryId: %q", ctx.CallbackQueryId)
|
||||
if ctx.CallbackQueryID != "cb-msg" {
|
||||
t.Fatalf("unexpected CallbackQueryID: %q", ctx.CallbackQueryID)
|
||||
}
|
||||
if ctx.CallbackMsgId != 55 {
|
||||
t.Fatalf("unexpected CallbackMsgId: %d", ctx.CallbackMsgId)
|
||||
if ctx.CallbackMsgID != 55 {
|
||||
t.Fatalf("unexpected CallbackMsgID: %d", ctx.CallbackMsgID)
|
||||
}
|
||||
if ctx.InlineMsgId != "" {
|
||||
t.Fatalf("did not expect InlineMsgId, got %q", ctx.InlineMsgId)
|
||||
if ctx.InlineMsgID != "" {
|
||||
t.Fatalf("did not expect InlineMsgID, got %q", ctx.InlineMsgID)
|
||||
}
|
||||
if ctx.Msg == nil {
|
||||
t.Fatal("expected callback message context")
|
||||
@@ -990,17 +1100,17 @@ func TestHandleCallbackPopulatesMessageTargets(t *testing.T) {
|
||||
t.Fatalf("unexpected callback args: got %v want %v", got, want)
|
||||
}
|
||||
return nil
|
||||
}, "approve")
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
payloadType: BotPayloadJson,
|
||||
logger: sneklog.NewLogger(),
|
||||
payloadType: BotPayloadJSON,
|
||||
plugins: []Plugin[NoData]{clonePlugin(plugin)},
|
||||
}
|
||||
|
||||
data, err := encodeJsonPayload(CallbackData{Command: "approve", Args: []string{"7", "ok"}})
|
||||
data, err := encodeJSONPayload(CallbackData{Command: "approve", Args: []string{"7", "ok"}})
|
||||
if err != nil {
|
||||
t.Fatalf("encodeJsonPayload returned error: %v", err)
|
||||
t.Fatalf("encodeJSONPayload returned error: %v", err)
|
||||
}
|
||||
|
||||
bot.handle(context.Background(), &tgapi.Update{
|
||||
@@ -1025,16 +1135,16 @@ func TestHandleCallbackPopulatesMessageTargets(t *testing.T) {
|
||||
func TestHandleCallbackPopulatesInlineTargets(t *testing.T) {
|
||||
called := false
|
||||
plugin := NewPlugin[NoData]("test")
|
||||
plugin.NewPayload(func(ctx *MsgContext, db NoData) error {
|
||||
plugin.Payload("inline.approve", func(ctx *MessageContext, db NoData) error {
|
||||
called = true
|
||||
if ctx.CallbackQueryId != "cb-inline" {
|
||||
t.Fatalf("unexpected CallbackQueryId: %q", ctx.CallbackQueryId)
|
||||
if ctx.CallbackQueryID != "cb-inline" {
|
||||
t.Fatalf("unexpected CallbackQueryID: %q", ctx.CallbackQueryID)
|
||||
}
|
||||
if ctx.CallbackMsgId != 0 {
|
||||
t.Fatalf("did not expect CallbackMsgId, got %d", ctx.CallbackMsgId)
|
||||
if ctx.CallbackMsgID != 0 {
|
||||
t.Fatalf("did not expect CallbackMsgID, got %d", ctx.CallbackMsgID)
|
||||
}
|
||||
if ctx.InlineMsgId != "inline-55" {
|
||||
t.Fatalf("unexpected InlineMsgId: %q", ctx.InlineMsgId)
|
||||
if ctx.InlineMsgID != "inline-55" {
|
||||
t.Fatalf("unexpected InlineMsgID: %q", ctx.InlineMsgID)
|
||||
}
|
||||
if ctx.Msg != nil {
|
||||
t.Fatalf("did not expect callback chat message context, got %#v", ctx.Msg)
|
||||
@@ -1049,17 +1159,17 @@ func TestHandleCallbackPopulatesInlineTargets(t *testing.T) {
|
||||
t.Fatalf("unexpected callback args: got %v want %v", got, want)
|
||||
}
|
||||
return nil
|
||||
}, "inline.approve")
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
payloadType: BotPayloadJson,
|
||||
logger: sneklog.NewLogger(),
|
||||
payloadType: BotPayloadJSON,
|
||||
plugins: []Plugin[NoData]{clonePlugin(plugin)},
|
||||
}
|
||||
|
||||
data, err := encodeJsonPayload(CallbackData{Command: "inline.approve", Args: []string{"9"}})
|
||||
data, err := encodeJSONPayload(CallbackData{Command: "inline.approve", Args: []string{"9"}})
|
||||
if err != nil {
|
||||
t.Fatalf("encodeJsonPayload returned error: %v", err)
|
||||
t.Fatalf("encodeJSONPayload returned error: %v", err)
|
||||
}
|
||||
|
||||
bot.handle(context.Background(), &tgapi.Update{
|
||||
@@ -1081,20 +1191,20 @@ func TestHandleCallbackPopulatesInlineTargets(t *testing.T) {
|
||||
func TestHandleCallbackObserverEmitsPayloadEvents(t *testing.T) {
|
||||
observer := &recordingObserver{}
|
||||
plugin := NewPlugin[NoData]("test")
|
||||
plugin.NewPayload(func(ctx *MsgContext, db NoData) error {
|
||||
plugin.Payload("approve", func(ctx *MessageContext, db NoData) error {
|
||||
return nil
|
||||
}, "approve")
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
payloadType: BotPayloadJson,
|
||||
logger: sneklog.NewLogger(),
|
||||
payloadType: BotPayloadJSON,
|
||||
plugins: []Plugin[NoData]{clonePlugin(plugin)},
|
||||
observer: observer,
|
||||
}
|
||||
|
||||
data, err := encodeJsonPayload(CallbackData{Command: "approve", Args: []string{"7"}})
|
||||
data, err := encodeJSONPayload(CallbackData{Command: "approve", Args: []string{"7"}})
|
||||
if err != nil {
|
||||
t.Fatalf("encodeJsonPayload returned error: %v", err)
|
||||
t.Fatalf("encodeJSONPayload returned error: %v", err)
|
||||
}
|
||||
|
||||
bot.handle(context.Background(), &tgapi.Update{
|
||||
@@ -1132,20 +1242,20 @@ func TestHandleCallbackObserverEmitsPayloadErrors(t *testing.T) {
|
||||
observer := &recordingObserver{}
|
||||
plugin := NewPlugin[NoData]("test")
|
||||
wantErr := AsInternalError(errors.New("boom"))
|
||||
plugin.NewPayload(func(ctx *MsgContext, db NoData) error {
|
||||
plugin.Payload("approve", func(ctx *MessageContext, db NoData) error {
|
||||
return wantErr
|
||||
}, "approve")
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
payloadType: BotPayloadJson,
|
||||
logger: sneklog.NewLogger(),
|
||||
payloadType: BotPayloadJSON,
|
||||
plugins: []Plugin[NoData]{clonePlugin(plugin)},
|
||||
observer: observer,
|
||||
}
|
||||
|
||||
data, err := encodeJsonPayload(CallbackData{Command: "approve", Args: []string{"7"}})
|
||||
data, err := encodeJSONPayload(CallbackData{Command: "approve", Args: []string{"7"}})
|
||||
if err != nil {
|
||||
t.Fatalf("encodeJsonPayload returned error: %v", err)
|
||||
t.Fatalf("encodeJSONPayload returned error: %v", err)
|
||||
}
|
||||
|
||||
bot.handle(context.Background(), &tgapi.Update{
|
||||
@@ -1179,11 +1289,376 @@ func TestHandleCallbackObserverEmitsPayloadErrors(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseCommandTable(t *testing.T) {
|
||||
bot := &Bot[NoData]{prefixes: []string{"/", "!"}}
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
text string
|
||||
wantPrefix string
|
||||
wantCmd string
|
||||
wantArgs string
|
||||
}{
|
||||
{name: "plain text", text: "hello", wantPrefix: "", wantCmd: "", wantArgs: ""},
|
||||
{name: "command no args", text: "/start", wantPrefix: "/", wantCmd: "start", wantArgs: ""},
|
||||
{name: "command with args", text: "/ban 42 reason", wantPrefix: "/", wantCmd: "ban", wantArgs: "42 reason"},
|
||||
{name: "tab separator", text: "/ban\t42", wantPrefix: "/", wantCmd: "ban", wantArgs: "42"},
|
||||
{name: "newline separator", text: "/ban\n42", wantPrefix: "/", wantCmd: "ban", wantArgs: "42"},
|
||||
{name: "alternate prefix", text: "!ping", wantPrefix: "!", wantCmd: "ping", wantArgs: ""},
|
||||
{name: "leading space after prefix", text: "/ start now", wantPrefix: "/", wantCmd: "start", wantArgs: "now"},
|
||||
{name: "command with botname", text: "/start@mybot extra", wantPrefix: "/", wantCmd: "start@mybot", wantArgs: "extra"},
|
||||
{name: "trailing whitespace", text: "/start ", wantPrefix: "/", wantCmd: "start", wantArgs: ""},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
prefix, cmd, args := bot.parseCommand(tt.text)
|
||||
if prefix != tt.wantPrefix {
|
||||
t.Fatalf("unexpected prefix: got %q want %q", prefix, tt.wantPrefix)
|
||||
}
|
||||
if cmd != tt.wantCmd {
|
||||
t.Fatalf("unexpected cmd: got %q want %q", cmd, tt.wantCmd)
|
||||
}
|
||||
if args != tt.wantArgs {
|
||||
t.Fatalf("unexpected args: got %q want %q", args, tt.wantArgs)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandleMessageStripsBotUsernameSuffix(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
botUsername string
|
||||
text string
|
||||
wantCalled bool
|
||||
}{
|
||||
{name: "matching botname", botUsername: "mybot", text: "/start@mybot hello", wantCalled: true},
|
||||
{name: "matching botname no args", botUsername: "mybot", text: "/start@mybot", wantCalled: true},
|
||||
{name: "matching botname ignores case", botUsername: "MyBot", text: "/start@mybot", wantCalled: true},
|
||||
{name: "other botname", botUsername: "mybot", text: "/start@otherbot hello", wantCalled: false},
|
||||
{name: "no botname", botUsername: "mybot", text: "/start hello", wantCalled: true},
|
||||
{name: "bot has no username", botUsername: "", text: "/start@mybot hello", wantCalled: false},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
called := false
|
||||
plugin := NewPlugin[NoData]("test")
|
||||
plugin.Command("start", func(ctx *MessageContext, db NoData) error {
|
||||
called = true
|
||||
return nil
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: sneklog.NewLogger(),
|
||||
prefixes: []string{"/"},
|
||||
username: tt.botUsername,
|
||||
plugins: []Plugin[NoData]{clonePlugin(plugin)},
|
||||
}
|
||||
|
||||
bot.handle(context.Background(), &tgapi.Update{
|
||||
UpdateID: 200,
|
||||
Type: tgapi.UpdateTypeMessage,
|
||||
Message: &tgapi.Message{
|
||||
MessageID: 1,
|
||||
Text: tt.text,
|
||||
From: &tgapi.User{ID: 1},
|
||||
Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate},
|
||||
},
|
||||
})
|
||||
|
||||
if called != tt.wantCalled {
|
||||
t.Fatalf("unexpected handler invocation: got called=%v want %v", called, tt.wantCalled)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandlePanicEmitsErrorEvent(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
panicWith any
|
||||
matchErr func(error) bool
|
||||
}{
|
||||
{
|
||||
name: "error value",
|
||||
panicWith: errors.New("boom"),
|
||||
matchErr: func(err error) bool {
|
||||
return errors.Is(err, ErrHandlerPanic) && strings.Contains(err.Error(), "boom")
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "string value",
|
||||
panicWith: "kaboom",
|
||||
matchErr: func(err error) bool {
|
||||
return errors.Is(err, ErrHandlerPanic) && strings.Contains(err.Error(), "kaboom")
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
observer := &recordingObserver{}
|
||||
plugin := NewPlugin[NoData]("test")
|
||||
plugin.Command("boom", func(ctx *MessageContext, db NoData) error {
|
||||
panic(tt.panicWith)
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: sneklog.NewLogger(),
|
||||
prefixes: []string{"/"},
|
||||
plugins: []Plugin[NoData]{clonePlugin(plugin)},
|
||||
observer: observer,
|
||||
}
|
||||
|
||||
bot.handle(context.Background(), &tgapi.Update{
|
||||
UpdateID: 100,
|
||||
Type: tgapi.UpdateTypeMessage,
|
||||
Message: &tgapi.Message{
|
||||
MessageID: 1,
|
||||
Text: "/boom",
|
||||
From: &tgapi.User{ID: 1},
|
||||
Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate},
|
||||
},
|
||||
})
|
||||
|
||||
panicEvent := (*ErrorEvent)(nil)
|
||||
for i := range observer.errors {
|
||||
ev := observer.errors[i]
|
||||
if ev.Plugin == "test" && ev.HandlerKind == HandlerCommandKind && ev.UpdateID == 100 {
|
||||
panicEvent = &ev
|
||||
break
|
||||
}
|
||||
}
|
||||
if panicEvent == nil {
|
||||
t.Fatalf("expected ErrorEvent from panic recovery, got events: %#v", observer.errors)
|
||||
}
|
||||
if panicEvent.UpdateType != tgapi.UpdateTypeMessage {
|
||||
t.Fatalf("unexpected UpdateType: %q", panicEvent.UpdateType)
|
||||
}
|
||||
if panicEvent.UserFacing {
|
||||
t.Fatal("panic ErrorEvent must not be marked user-facing")
|
||||
}
|
||||
if !tt.matchErr(panicEvent.Err) {
|
||||
t.Fatalf("unexpected panic Err: %v", panicEvent.Err)
|
||||
}
|
||||
if len(observer.finished) != 1 || !errors.Is(observer.finished[0].Err, ErrHandlerPanic) {
|
||||
t.Fatalf("expected balanced HandlerFinishedEvent, got %#v", observer.finished)
|
||||
}
|
||||
if len(observer.handled) != 1 || !observer.handled[0].Handled {
|
||||
t.Fatalf("expected completed handled update, got %#v", observer.handled)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestSceneUserErrorIsDeliveredOnce(t *testing.T) {
|
||||
failing := func(*SceneContext, NoData) (SceneResult, error) {
|
||||
return SceneResult{}, AsUserError(errors.New("try again"))
|
||||
}
|
||||
tests := []struct {
|
||||
name string
|
||||
step string
|
||||
kind HandlerEventKind
|
||||
setup func(*Scene[NoData])
|
||||
update func() tgapi.Update
|
||||
}{
|
||||
{
|
||||
name: "step", step: "start", kind: HandlerSceneStepKind,
|
||||
setup: func(scene *Scene[NoData]) { scene.OnStep("start", failing) },
|
||||
update: func() tgapi.Update { return sceneMessageUpdate(101, "hello") },
|
||||
},
|
||||
{
|
||||
name: "command", step: "start", kind: HandlerSceneCommandKind,
|
||||
setup: func(scene *Scene[NoData]) { scene.OnCommand("fail", failing) },
|
||||
update: func() tgapi.Update { return sceneMessageUpdate(102, "/fail") },
|
||||
},
|
||||
{
|
||||
name: "payload", step: "start", kind: HandlerScenePayloadKind,
|
||||
setup: func(scene *Scene[NoData]) { scene.OnPayload("fail", failing) },
|
||||
update: func() tgapi.Update {
|
||||
data, err := encodeJSONPayload(CallbackData{Command: "fail"})
|
||||
if err != nil {
|
||||
t.Fatalf("encodeJSONPayload returned error: %v", err)
|
||||
}
|
||||
return tgapi.Update{
|
||||
UpdateID: 103,
|
||||
Type: tgapi.UpdateTypeCallbackQuery,
|
||||
CallbackQuery: &tgapi.CallbackQuery{
|
||||
ID: "callback", Data: data, From: tgapi.User{ID: 1},
|
||||
Message: &tgapi.Message{MessageID: 1, Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate}},
|
||||
},
|
||||
}
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "message fallback", step: "missing", kind: HandlerSceneMessageKind,
|
||||
setup: func(scene *Scene[NoData]) { scene.OnMessage(failing) },
|
||||
update: func() tgapi.Update { return sceneMessageUpdate(104, "hello") },
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
requests := 0
|
||||
client := &http.Client{Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||
requests++
|
||||
result := `true`
|
||||
if !strings.HasSuffix(req.URL.Path, "/answerCallbackQuery") {
|
||||
result = `{"message_id":1,"date":0,"chat":{"id":42,"type":"private"}}`
|
||||
}
|
||||
return &http.Response{
|
||||
StatusCode: http.StatusOK,
|
||||
Body: io.NopCloser(strings.NewReader(`{"ok":true,"result":` + result + `}`)),
|
||||
Header: make(http.Header),
|
||||
}, nil
|
||||
})}
|
||||
api := tgapi.NewAPI(tgapi.NewAPIOpts("token").SetAPIURL("https://example.test").SetHTTPClient(client))
|
||||
defer func() { _ = api.Close() }()
|
||||
|
||||
scene := NewScene[NoData]("signup")
|
||||
tt.setup(scene)
|
||||
plugin := NewPlugin[NoData]("scene-plugin")
|
||||
plugin.AddScene(scene)
|
||||
store := NewMemorySessionStore()
|
||||
if err := store.Set("user_id:1:chat_id:42", SceneSession{Scene: "signup", Step: tt.step}); err != nil {
|
||||
t.Fatalf("Set returned error: %v", err)
|
||||
}
|
||||
observer := &recordingObserver{}
|
||||
bot := &Bot[NoData]{
|
||||
api: api, logger: sneklog.NewLogger(), errorTemplate: "error: %s",
|
||||
plugins: []Plugin[NoData]{clonePlugin(plugin)}, observer: observer,
|
||||
sessionStore: store, sceneScopePriority: []SceneScope{SceneScopeUserChat},
|
||||
prefixes: []string{"/"}, payloadType: BotPayloadJSON,
|
||||
}
|
||||
defer func() { _ = bot.logger.Close() }()
|
||||
|
||||
update := tt.update()
|
||||
bot.handle(context.Background(), &update)
|
||||
|
||||
if requests != 1 {
|
||||
t.Fatalf("expected one user-facing reply, got %d requests", requests)
|
||||
}
|
||||
if len(observer.errors) != 1 {
|
||||
t.Fatalf("expected one ErrorEvent, got %#v", observer.errors)
|
||||
}
|
||||
if event := observer.errors[0]; event.Plugin != "scene-plugin" || event.HandlerKind != tt.kind || !event.UserFacing {
|
||||
t.Fatalf("unexpected scene ErrorEvent: %#v", event)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestPolicyEventsUseConfiguredEmitter(t *testing.T) {
|
||||
directObserver := &recordingObserver{}
|
||||
emitted := 0
|
||||
ctx := &MessageContext{
|
||||
observer: directObserver,
|
||||
eventEmitter: func(_ context.Context, event Event) {
|
||||
if _, ok := event.(PolicyCheckedEvent); !ok {
|
||||
t.Fatalf("unexpected event type %T", event)
|
||||
}
|
||||
emitted++
|
||||
},
|
||||
}
|
||||
|
||||
ctx.emitPolicyChecked(PolicyCheckedEvent{Name: "admin", Passed: true})
|
||||
if emitted != 1 {
|
||||
t.Fatalf("emitter call count = %d, want 1", emitted)
|
||||
}
|
||||
if len(directObserver.policies) != 0 {
|
||||
t.Fatalf("policy bypassed configured emitter: %#v", directObserver.policies)
|
||||
}
|
||||
}
|
||||
|
||||
func sceneMessageUpdate(updateID int, text string) tgapi.Update {
|
||||
return tgapi.Update{
|
||||
UpdateID: updateID,
|
||||
Type: tgapi.UpdateTypeMessage,
|
||||
Message: &tgapi.Message{
|
||||
MessageID: 1,
|
||||
Text: text,
|
||||
From: &tgapi.User{ID: 1},
|
||||
Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate},
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandleDoesNotSerializeUnrelatedUsersWithoutScene(t *testing.T) {
|
||||
started := make(chan struct{}, 2)
|
||||
release := make(chan struct{})
|
||||
plugin := NewPlugin[NoData]("commands")
|
||||
plugin.Command("work", func(*MessageContext, NoData) error {
|
||||
started <- struct{}{}
|
||||
<-release
|
||||
return nil
|
||||
})
|
||||
bot := &Bot[NoData]{
|
||||
logger: sneklog.NewLogger(),
|
||||
plugins: []Plugin[NoData]{clonePlugin(plugin)},
|
||||
prefixes: []string{"/"},
|
||||
sessionStore: NewMemorySessionStore(),
|
||||
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||
}
|
||||
defer func() { _ = bot.logger.Close() }()
|
||||
|
||||
updateFor := func(id int) tgapi.Update {
|
||||
return tgapi.Update{UpdateID: id, Type: tgapi.UpdateTypeMessage, Message: &tgapi.Message{
|
||||
MessageID: id, Text: "/work", From: &tgapi.User{ID: int64(id)},
|
||||
Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypeSupergroup},
|
||||
}}
|
||||
}
|
||||
done := make(chan struct{}, 2)
|
||||
for id := 1; id <= 2; id++ {
|
||||
update := updateFor(id)
|
||||
go func() {
|
||||
bot.handle(context.Background(), &update)
|
||||
done <- struct{}{}
|
||||
}()
|
||||
}
|
||||
for range 2 {
|
||||
select {
|
||||
case <-started:
|
||||
case <-time.After(time.Second):
|
||||
close(release)
|
||||
t.Fatal("updates from unrelated users in one chat were serialized")
|
||||
}
|
||||
}
|
||||
close(release)
|
||||
<-done
|
||||
<-done
|
||||
}
|
||||
|
||||
func TestCommandMiddlewareBlockIsNotReportedAsError(t *testing.T) {
|
||||
called := false
|
||||
plugin := NewPlugin[NoData]("commands")
|
||||
plugin.Command("blocked", func(*MessageContext, NoData) error {
|
||||
called = true
|
||||
return nil
|
||||
}).Use(NewMiddleware("deny", func(*MessageContext, NoData) bool { return false }))
|
||||
observer := &recordingObserver{}
|
||||
bot := &Bot[NoData]{
|
||||
logger: sneklog.NewLogger(), plugins: []Plugin[NoData]{clonePlugin(plugin)},
|
||||
prefixes: []string{"/"}, observer: observer, sessionStore: NewMemorySessionStore(),
|
||||
}
|
||||
defer func() { _ = bot.logger.Close() }()
|
||||
update := sceneMessageUpdate(201, "/blocked")
|
||||
bot.handle(context.Background(), &update)
|
||||
|
||||
if called {
|
||||
t.Fatal("command executed after middleware blocked it")
|
||||
}
|
||||
if len(observer.errors) != 0 {
|
||||
t.Fatalf("middleware block emitted errors: %#v", observer.errors)
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandleCallbackObserverEmitsDecodeErrors(t *testing.T) {
|
||||
observer := &recordingObserver{}
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
payloadType: BotPayloadJson,
|
||||
logger: sneklog.NewLogger(),
|
||||
payloadType: BotPayloadJSON,
|
||||
observer: observer,
|
||||
}
|
||||
|
||||
@@ -1195,14 +1670,14 @@ func TestHandleCallbackObserverEmitsDecodeErrors(t *testing.T) {
|
||||
Data: "{not-json",
|
||||
From: tgapi.User{ID: 7},
|
||||
},
|
||||
}, &MsgContext{
|
||||
}, &MessageContext{
|
||||
Update: tgapi.Update{
|
||||
UpdateID: 34,
|
||||
Type: tgapi.UpdateTypeCallbackQuery,
|
||||
},
|
||||
Logger: bot.logger,
|
||||
ctx: context.Background(),
|
||||
CallbackQueryId: "cb-bad",
|
||||
CallbackQueryID: "cb-bad",
|
||||
From: &tgapi.User{ID: 7},
|
||||
FromID: 7,
|
||||
sceneRuntime: bot,
|
||||
|
||||
+253
-77
@@ -16,83 +16,142 @@ const (
|
||||
ButtonStylePrimary tgapi.KeyboardButtonStyle = "primary"
|
||||
)
|
||||
|
||||
// InlineKbButtonBuilder is a fluent builder for creating a single inline keyboard button.
|
||||
// InlineKeyboardButtonBuilder 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
|
||||
// Use NewInlineKeyboardButton() 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
|
||||
// - SetURL() — makes button open a URL
|
||||
// - SetCallbackDataJSON() — attaches structured command + args for bot handling
|
||||
//
|
||||
// Call build() to produce the final tgapi.InlineKeyboardButton.
|
||||
// Call Build to validate and 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
|
||||
type InlineKeyboardButtonBuilder struct {
|
||||
text string
|
||||
emojiID string
|
||||
style tgapi.KeyboardButtonStyle
|
||||
|
||||
url string
|
||||
data string
|
||||
|
||||
payloadType BotPayloadType
|
||||
}
|
||||
|
||||
// NewInlineKbButton creates a new button builder with the given display text.
|
||||
// NewInlineKeyboardButton 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}
|
||||
func NewInlineKeyboardButton(text string) InlineKeyboardButtonBuilder {
|
||||
return InlineKeyboardButtonBuilder{text: text}
|
||||
}
|
||||
|
||||
// SetIconCustomEmojiId sets a custom emoji ID to display as the button's icon.
|
||||
// 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
|
||||
func (b InlineKeyboardButtonBuilder) SetIconCustomEmojiID(id string) InlineKeyboardButtonBuilder {
|
||||
b.emojiID = 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 {
|
||||
func (b InlineKeyboardButtonBuilder) SetStyle(style tgapi.KeyboardButtonStyle) InlineKeyboardButtonBuilder {
|
||||
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 {
|
||||
// SetURL sets a URL that will be opened when the button is pressed.
|
||||
// It clears callback data because Telegram requires exactly one button action.
|
||||
func (b InlineKeyboardButtonBuilder) SetURL(url string) InlineKeyboardButtonBuilder {
|
||||
b.url = url
|
||||
if url != "" {
|
||||
b.data = ""
|
||||
}
|
||||
return b
|
||||
}
|
||||
|
||||
// SetCallbackDataJson sets a structured callback payload that will be sent to the bot
|
||||
// SetPayloadType sets the encoding used by SetCallbackData.
|
||||
func (b InlineKeyboardButtonBuilder) SetPayloadType(t BotPayloadType) InlineKeyboardButtonBuilder {
|
||||
b.payloadType = t
|
||||
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()
|
||||
// Example: SetCallbackDataJSON("delete_user", 123, "confirm") → {"cmd":"delete_user","args":["123","confirm"]}.
|
||||
func (b InlineKeyboardButtonBuilder) SetCallbackDataJSON(cmd string, args ...any) InlineKeyboardButtonBuilder {
|
||||
b.url = ""
|
||||
b.data = 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()
|
||||
// SetCallbackDataBase64 sets a Base64-encoded structured callback payload.
|
||||
// Base64 does not bypass Telegram's 64-byte callback-data limit.
|
||||
func (b InlineKeyboardButtonBuilder) SetCallbackDataBase64(cmd string, args ...any) InlineKeyboardButtonBuilder {
|
||||
b.url = ""
|
||||
b.data = NewCallbackData(cmd, args...).ToBase64()
|
||||
return b
|
||||
}
|
||||
|
||||
// Internal helper that converts the builder state into a Telegram button.
|
||||
func (b InlineKbButtonBuilder) build() tgapi.InlineKeyboardButton {
|
||||
// SetCallbackDataCompact sets a structured callback payload encoded as compact text.
|
||||
func (b InlineKeyboardButtonBuilder) SetCallbackDataCompact(cmd string, args ...any) InlineKeyboardButtonBuilder {
|
||||
b.url = ""
|
||||
b.data = NewCallbackData(cmd, args...).ToCompact()
|
||||
return b
|
||||
}
|
||||
|
||||
// SetCallbackDataCompactBase64 sets a compact callback payload encoded as Base64.
|
||||
func (b InlineKeyboardButtonBuilder) SetCallbackDataCompactBase64(cmd string, args ...any) InlineKeyboardButtonBuilder {
|
||||
b.url = ""
|
||||
b.data = NewCallbackData(cmd, args...).ToCompactBase64()
|
||||
return b
|
||||
}
|
||||
|
||||
// SetCallbackData sets a structured callback payload using the configured payload type.
|
||||
// The default payload type is JSON.
|
||||
func (b InlineKeyboardButtonBuilder) SetCallbackData(cmd string, args ...any) InlineKeyboardButtonBuilder {
|
||||
b.url = ""
|
||||
switch b.payloadType {
|
||||
case BotPayloadJSON:
|
||||
b.data = NewCallbackData(cmd, args...).ToJSON()
|
||||
case BotPayloadBase64:
|
||||
b.data = NewCallbackData(cmd, args...).ToBase64()
|
||||
case BotPayloadCompact:
|
||||
b.data = NewCallbackData(cmd, args...).ToCompact()
|
||||
case BotPayloadCompactBase64:
|
||||
b.data = NewCallbackData(cmd, args...).ToCompactBase64()
|
||||
default:
|
||||
b.data = NewCallbackData(cmd, args...).ToJSON()
|
||||
}
|
||||
return b
|
||||
}
|
||||
|
||||
func (b InlineKeyboardButtonBuilder) build() tgapi.InlineKeyboardButton {
|
||||
return tgapi.InlineKeyboardButton{
|
||||
Text: b.text,
|
||||
URL: b.url,
|
||||
Style: b.style,
|
||||
IconCustomEmojiID: b.iconCustomEmojiID,
|
||||
CallbackData: b.callbackData,
|
||||
IconCustomEmojiID: b.emojiID,
|
||||
CallbackData: b.data,
|
||||
}
|
||||
}
|
||||
|
||||
// Validate checks that the button has exactly one action and valid callback data.
|
||||
func (b InlineKeyboardButtonBuilder) Validate() error {
|
||||
return validateInlineKeyboardButton(b.build())
|
||||
}
|
||||
|
||||
// Build validates and returns the configured inline keyboard button.
|
||||
func (b InlineKeyboardButtonBuilder) Build() (tgapi.InlineKeyboardButton, error) {
|
||||
button := b.build()
|
||||
if err := validateInlineKeyboardButton(button); err != nil {
|
||||
return tgapi.InlineKeyboardButton{}, err
|
||||
}
|
||||
return button, nil
|
||||
}
|
||||
|
||||
// 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.
|
||||
@@ -100,19 +159,21 @@ func (b InlineKbButtonBuilder) build() tgapi.InlineKeyboardButton {
|
||||
//
|
||||
// The keyboard is not thread-safe. Build it in a single goroutine.
|
||||
type InlineKeyboard struct {
|
||||
CurrentLine extypes.Slice[tgapi.InlineKeyboardButton] // Current row being built
|
||||
Lines [][]tgapi.InlineKeyboardButton // Completed rows
|
||||
maxRow int // Max buttons per row (e.g., 3 or 4)
|
||||
// CurrentLine is the row currently being built.
|
||||
CurrentLine extypes.Slice[tgapi.InlineKeyboardButton]
|
||||
// Lines contains completed keyboard rows.
|
||||
Lines [][]tgapi.InlineKeyboardButton
|
||||
maxRow int // Max buttons per row (e.g., 3 or 4)
|
||||
|
||||
payloadType BotPayloadType // Serialization format for callback data (JSON or Base64)
|
||||
}
|
||||
|
||||
// NewInlineKeyboardJson creates a new keyboard builder with the specified maximum
|
||||
// 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)
|
||||
// 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
|
||||
@@ -123,10 +184,20 @@ func NewInlineKeyboardBase64(maxRow int) *InlineKeyboard {
|
||||
return NewInlineKeyboard(BotPayloadBase64, maxRow)
|
||||
}
|
||||
|
||||
// NewInlineKeyboardCompact creates a keyboard builder using compact callback payloads.
|
||||
func NewInlineKeyboardCompact(maxRow int) *InlineKeyboard {
|
||||
return NewInlineKeyboard(BotPayloadCompact, maxRow)
|
||||
}
|
||||
|
||||
// NewInlineKeyboardCompactBase64 creates a keyboard builder using Base64-encoded compact payloads.
|
||||
func NewInlineKeyboardCompactBase64(maxRow int) *InlineKeyboard {
|
||||
return NewInlineKeyboard(BotPayloadCompactBase64, 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.
|
||||
// Use NewInlineKeyboardJSON or NewInlineKeyboardBase64 for the common cases.
|
||||
func NewInlineKeyboard(payloadType BotPayloadType, maxRow int) *InlineKeyboard {
|
||||
return &InlineKeyboard{
|
||||
CurrentLine: make(extypes.Slice[tgapi.InlineKeyboardButton], 0),
|
||||
@@ -148,36 +219,39 @@ func (in *InlineKeyboard) SetPayloadType(t BotPayloadType) *InlineKeyboard {
|
||||
func (in *InlineKeyboard) GetPayloadType() BotPayloadType { return in.payloadType }
|
||||
|
||||
// SetMaxRow sets the maximum number of buttons appended to a row before the
|
||||
// keyboard automatically starts a new line.
|
||||
// keyboard automatically starts a new line. Values <= 0 retain the legacy
|
||||
// unlimited-row behavior; this convention is subject to change in v2.
|
||||
func (in *InlineKeyboard) SetMaxRow(maxRow int) *InlineKeyboard {
|
||||
in.maxRow = maxRow
|
||||
return in
|
||||
}
|
||||
|
||||
// Internal helper that appends a button and auto-flushes a full row.
|
||||
// GetMaxRow returns the maximum number of buttons per row.
|
||||
func (in *InlineKeyboard) GetMaxRow() int { return in.maxRow }
|
||||
|
||||
func (in *InlineKeyboard) append(button tgapi.InlineKeyboardButton) *InlineKeyboard {
|
||||
if in.CurrentLine.Len() == in.maxRow {
|
||||
if in.maxRow > 0 && 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.
|
||||
// AddURLButton adds a button that opens a URL when pressed.
|
||||
// No callback data is attached.
|
||||
func (in *InlineKeyboard) AddUrlButton(text, url string) *InlineKeyboard {
|
||||
func (in *InlineKeyboard) AddURLButton(text, url string) *InlineKeyboard {
|
||||
return in.append(tgapi.InlineKeyboardButton{Text: text, URL: url})
|
||||
}
|
||||
|
||||
// AddUrlButtonStyle adds a button with a visual style that opens a URL.
|
||||
// AddURLButtonStyle adds a button with a visual style that opens a URL.
|
||||
// Style must be one of: ButtonStyleDanger, ButtonStyleSuccess, ButtonStylePrimary.
|
||||
func (in *InlineKeyboard) AddUrlButtonStyle(text string, style tgapi.KeyboardButtonStyle, url string) *InlineKeyboard {
|
||||
func (in *InlineKeyboard) AddURLButtonStyle(text string, style tgapi.KeyboardButtonStyle, url string) *InlineKeyboard {
|
||||
return in.append(tgapi.InlineKeyboardButton{Text: text, Style: style, URL: url})
|
||||
}
|
||||
|
||||
// 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 {
|
||||
func (in *InlineKeyboard) AddCallbackButton(text, cmd string, args ...any) *InlineKeyboard {
|
||||
return in.append(tgapi.InlineKeyboardButton{
|
||||
Text: text,
|
||||
CallbackData: NewCallbackData(cmd, args...).Encode(in.payloadType),
|
||||
@@ -194,9 +268,9 @@ func (in *InlineKeyboard) AddCallbackButtonStyle(text string, style tgapi.Keyboa
|
||||
})
|
||||
}
|
||||
|
||||
// AddButton adds a button pre-configured via InlineKbButtonBuilder.
|
||||
// AddButton adds a button pre-configured via InlineKeyboardButtonBuilder.
|
||||
// This is the most flexible way to create buttons with custom emoji, style, URL, and callback.
|
||||
func (in *InlineKeyboard) AddButton(b InlineKbButtonBuilder) *InlineKeyboard {
|
||||
func (in *InlineKeyboard) AddButton(b InlineKeyboardButtonBuilder) *InlineKeyboard {
|
||||
return in.append(b.build())
|
||||
}
|
||||
|
||||
@@ -219,7 +293,67 @@ func (in *InlineKeyboard) Get() *tgapi.ReplyMarkup {
|
||||
if in.CurrentLine.Len() > 0 {
|
||||
in.AddLine()
|
||||
}
|
||||
return &tgapi.ReplyMarkup{InlineKeyboard: in.Lines}
|
||||
lines := make([][]tgapi.InlineKeyboardButton, len(in.Lines))
|
||||
for i := range in.Lines {
|
||||
lines[i] = append([]tgapi.InlineKeyboardButton(nil), in.Lines[i]...)
|
||||
}
|
||||
return &tgapi.ReplyMarkup{InlineKeyboard: lines}
|
||||
}
|
||||
|
||||
// GetValidated finalizes and validates the keyboard before returning it.
|
||||
//
|
||||
// Existing fluent Add* methods remain error-free for v1 compatibility. Their
|
||||
// signatures are subject to change in v2; new code should use GetValidated.
|
||||
func (in *InlineKeyboard) GetValidated() (*tgapi.ReplyMarkup, error) {
|
||||
markup := in.Get()
|
||||
if err := in.validateMarkup(markup); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return markup, nil
|
||||
}
|
||||
|
||||
// Validate checks completed and pending rows without finalizing the keyboard.
|
||||
func (in *InlineKeyboard) Validate() error {
|
||||
lines := make([][]tgapi.InlineKeyboardButton, 0, len(in.Lines)+1)
|
||||
lines = append(lines, in.Lines...)
|
||||
if len(in.CurrentLine) > 0 {
|
||||
lines = append(lines, in.CurrentLine)
|
||||
}
|
||||
return in.validateMarkup(&tgapi.ReplyMarkup{InlineKeyboard: lines})
|
||||
}
|
||||
|
||||
func (in *InlineKeyboard) validateMarkup(markup *tgapi.ReplyMarkup) error {
|
||||
for rowIndex, row := range markup.InlineKeyboard {
|
||||
if in.maxRow > 0 && len(row) > in.maxRow {
|
||||
return fmt.Errorf("%w: row %d has %d buttons, limit %d", ErrInlineKeyboardRowTooLong, rowIndex, len(row), in.maxRow)
|
||||
}
|
||||
for columnIndex, button := range row {
|
||||
if err := validateInlineKeyboardButton(button); err != nil {
|
||||
return fmt.Errorf("row %d button %d: %w", rowIndex, columnIndex, err)
|
||||
}
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func validateInlineKeyboardButton(button tgapi.InlineKeyboardButton) error {
|
||||
actions := 0
|
||||
if button.URL != "" {
|
||||
actions++
|
||||
}
|
||||
if button.CallbackData != "" {
|
||||
actions++
|
||||
}
|
||||
if actions != 1 {
|
||||
return ErrInlineKeyboardButtonAction
|
||||
}
|
||||
if button.CallbackData != "" {
|
||||
length := len([]byte(button.CallbackData))
|
||||
if length < 1 || length > 64 {
|
||||
return fmt.Errorf("%w: got %d", ErrCallbackDataLength, length)
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// CallbackData represents the structured payload sent when an inline button
|
||||
@@ -232,8 +366,10 @@ func (in *InlineKeyboard) Get() *tgapi.ReplyMarkup {
|
||||
//
|
||||
// {"cmd":"delete_user","args":["123","confirm"]}
|
||||
type CallbackData struct {
|
||||
Command string `json:"cmd"` // The command name to route to
|
||||
Args []string `json:"args"` // Arguments passed as strings
|
||||
// Command is the command name used for payload routing.
|
||||
Command string `json:"cmd"`
|
||||
// Args contains the string arguments passed to the payload handler.
|
||||
Args []string `json:"args"`
|
||||
}
|
||||
|
||||
// NewCallbackData creates a new CallbackData instance with the given command and args.
|
||||
@@ -247,24 +383,21 @@ func NewCallbackData(command string, args ...any) CallbackData {
|
||||
for i, arg := range args {
|
||||
stringArgs[i] = fmt.Sprint(arg)
|
||||
}
|
||||
return CallbackData{
|
||||
Command: command,
|
||||
Args: stringArgs,
|
||||
}
|
||||
return CallbackData{Command: command, Args: stringArgs}
|
||||
}
|
||||
|
||||
// ToJson serializes the CallbackData to a JSON string.
|
||||
//
|
||||
// If serialization fails (e.g., due to unmarshalable fields), returns a fallback
|
||||
// JSON object: {"cmd":""} to prevent breaking Telegram's API.
|
||||
//
|
||||
// This fallback ensures the bot receives a valid JSON payload even if internal
|
||||
// errors occur — avoiding "invalid callback_data" errors from Telegram.
|
||||
func (d CallbackData) ToJson() string {
|
||||
data, err := encodeJsonPayload(d)
|
||||
// All To* encoders return an empty string when serialization fails. Telegram
|
||||
// rejects empty callback_data, so an empty result surfaces a real bug rather
|
||||
// than masking it with a stub payload that silently routes to no handler.
|
||||
// Build CallbackData from primitives (string, []string) only — the encoders
|
||||
// have no failure modes for that input.
|
||||
|
||||
// ToJSON serializes the CallbackData to a JSON string.
|
||||
// Returns an empty string if serialization fails.
|
||||
func (d CallbackData) ToJSON() string {
|
||||
data, err := encodeJSONPayload(d)
|
||||
if err != nil {
|
||||
// Fallback: return minimal valid JSON to avoid Telegram API rejection
|
||||
return `{"cmd":""}`
|
||||
return ""
|
||||
}
|
||||
return data
|
||||
}
|
||||
@@ -272,22 +405,65 @@ func (d CallbackData) ToJson() string {
|
||||
// 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)
|
||||
data, err := encodeBase64Payload(d)
|
||||
if err != nil {
|
||||
return ``
|
||||
return ""
|
||||
}
|
||||
return s
|
||||
return data
|
||||
}
|
||||
|
||||
// ToCompact serializes the CallbackData to a compact delimited string.
|
||||
// Returns an empty string if serialization fails.
|
||||
//
|
||||
// The compact format coalesces "no args" with "single empty arg" — both
|
||||
// produce "cmd|" and decode back to nil args. Use ToJSON or ToBase64 when
|
||||
// that distinction must be preserved.
|
||||
func (d CallbackData) ToCompact() string {
|
||||
data, err := encodeCompactPayload(d)
|
||||
if err != nil {
|
||||
return ""
|
||||
}
|
||||
return data
|
||||
}
|
||||
|
||||
// ToCompactBase64 serializes the CallbackData to compact text and then encodes it as Base64.
|
||||
// Returns an empty string if serialization or encoding fails.
|
||||
func (d CallbackData) ToCompactBase64() string {
|
||||
data, err := encodeCompactBase64Payload(d)
|
||||
if err != nil {
|
||||
return ""
|
||||
}
|
||||
return data
|
||||
}
|
||||
|
||||
// Encode serializes the CallbackData according to the specified payload type.
|
||||
// Supported types: BotPayloadJson and BotPayloadBase64.
|
||||
// Supported types: BotPayloadJSON, BotPayloadBase64, BotPayloadCompact, and BotPayloadCompactBase64.
|
||||
// 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()
|
||||
case BotPayloadJSON:
|
||||
return d.ToJSON()
|
||||
case BotPayloadCompact:
|
||||
return d.ToCompact()
|
||||
case BotPayloadCompactBase64:
|
||||
return d.ToCompactBase64()
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
// EncodeValidated serializes callback data and enforces Telegram's 1-64 byte limit.
|
||||
func (d CallbackData) EncodeValidated(t BotPayloadType) (string, error) {
|
||||
encoded := d.Encode(t)
|
||||
if encoded == "" {
|
||||
if t != BotPayloadBase64 && t != BotPayloadJSON && t != BotPayloadCompact && t != BotPayloadCompactBase64 {
|
||||
return "", ErrInvalidPayloadType
|
||||
}
|
||||
return "", ErrCallbackDataLength
|
||||
}
|
||||
if length := len([]byte(encoded)); length > 64 {
|
||||
return "", fmt.Errorf("%w: got %d", ErrCallbackDataLength, length)
|
||||
}
|
||||
return encoded, nil
|
||||
}
|
||||
|
||||
+224
-10
@@ -8,7 +8,7 @@ import (
|
||||
)
|
||||
|
||||
func TestInlineKeyboardWrapsRowsAndEncodesJSONPayloads(t *testing.T) {
|
||||
kb := NewInlineKeyboardJson(2).
|
||||
kb := NewInlineKeyboardJSON(2).
|
||||
AddCallbackButton("A", "cmd", 1).
|
||||
AddCallbackButton("B", "cmd", 2).
|
||||
AddCallbackButton("C", "cmd", 3)
|
||||
@@ -31,9 +31,9 @@ func TestInlineKeyboardWrapsRowsAndEncodesJSONPayloads(t *testing.T) {
|
||||
func TestInlineKeyboardBuilderPreservesConfiguredButtonFields(t *testing.T) {
|
||||
kb := NewInlineKeyboardBase64(3).
|
||||
AddButton(
|
||||
NewInlineKbButton("Docs").
|
||||
NewInlineKeyboardButton("Docs").
|
||||
SetStyle(ButtonStylePrimary).
|
||||
SetUrl("https://example.test"),
|
||||
SetURL("https://example.test"),
|
||||
)
|
||||
|
||||
button := kb.Get().InlineKeyboard[0][0]
|
||||
@@ -45,9 +45,66 @@ func TestInlineKeyboardBuilderPreservesConfiguredButtonFields(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestInlineKeyboardButtonBuilderSetCallbackDataDefaultsToJSON(t *testing.T) {
|
||||
kb := NewInlineKeyboardBase64(1).
|
||||
AddButton(NewInlineKeyboardButton("A").SetCallbackData("cmd", 1, "two"))
|
||||
|
||||
button := kb.Get().InlineKeyboard[0][0]
|
||||
if !strings.Contains(button.CallbackData, `"cmd":"cmd"`) {
|
||||
t.Fatalf("expected JSON callback payload, got %q", button.CallbackData)
|
||||
}
|
||||
}
|
||||
|
||||
func TestInlineKeyboardButtonBuilderSetCallbackDataUsesConfiguredPayloadType(t *testing.T) {
|
||||
kb := NewInlineKeyboardJSON(1).
|
||||
AddButton(NewInlineKeyboardButton("A").
|
||||
SetPayloadType(BotPayloadBase64).
|
||||
SetCallbackData("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 TestInlineKeyboardButtonBuilderKeepsExactlyOneAction(t *testing.T) {
|
||||
callback := NewInlineKeyboardButton("Action").
|
||||
SetURL("https://example.test").
|
||||
SetCallbackDataJSON("confirm").
|
||||
build()
|
||||
if callback.URL != "" || callback.CallbackData == "" {
|
||||
t.Fatalf("callback action was not exclusive: %#v", callback)
|
||||
}
|
||||
|
||||
link := NewInlineKeyboardButton("Action").
|
||||
SetCallbackDataJSON("confirm").
|
||||
SetURL("https://example.test").
|
||||
build()
|
||||
if link.URL == "" || link.CallbackData != "" {
|
||||
t.Fatalf("URL action was not exclusive: %#v", link)
|
||||
}
|
||||
}
|
||||
|
||||
func TestInlineKeyboardGetReturnsIndependentMarkup(t *testing.T) {
|
||||
keyboard := NewInlineKeyboardJSON(1).AddURLButton("Docs", "https://example.test")
|
||||
first := keyboard.Get()
|
||||
first.InlineKeyboard[0][0].Text = "mutated"
|
||||
|
||||
second := keyboard.Get()
|
||||
if got := second.InlineKeyboard[0][0].Text; got != "Docs" {
|
||||
t.Fatalf("Get exposed builder state for mutation: got %q", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestInlineKeyboardGetPayloadTypeReturnsLocalOverride(t *testing.T) {
|
||||
kb := NewInlineKeyboardJson(2)
|
||||
if got := kb.GetPayloadType(); got != BotPayloadJson {
|
||||
kb := NewInlineKeyboardJSON(2)
|
||||
if got := kb.GetPayloadType(); got != BotPayloadJSON {
|
||||
t.Fatalf("unexpected initial payload type: %q", got)
|
||||
}
|
||||
kb.SetPayloadType(BotPayloadBase64)
|
||||
@@ -60,7 +117,7 @@ func TestDecodePayloadAcceptsBase64KeyboardPayloadWhenBotPrefersJSON(t *testing.
|
||||
kb := NewInlineKeyboardBase64(1).
|
||||
AddCallbackButton("A", "cmd", 1, "two")
|
||||
|
||||
got, _, err := decodePayload(BotPayloadJson, kb.Get().InlineKeyboard[0][0].CallbackData, false)
|
||||
got, _, err := decodePayload(BotPayloadJSON, kb.Get().InlineKeyboard[0][0].CallbackData, false)
|
||||
if err != nil {
|
||||
t.Fatalf("decodePayload returned error: %v", err)
|
||||
}
|
||||
@@ -72,7 +129,7 @@ func TestDecodePayloadAcceptsBase64KeyboardPayloadWhenBotPrefersJSON(t *testing.
|
||||
}
|
||||
|
||||
func TestDecodePayloadAcceptsJSONKeyboardPayloadWhenBotPrefersBase64(t *testing.T) {
|
||||
kb := NewInlineKeyboardJson(1).
|
||||
kb := NewInlineKeyboardJSON(1).
|
||||
AddCallbackButton("A", "cmd", 1, "two")
|
||||
|
||||
got, _, err := decodePayload(BotPayloadBase64, kb.Get().InlineKeyboard[0][0].CallbackData, false)
|
||||
@@ -86,12 +143,169 @@ func TestDecodePayloadAcceptsJSONKeyboardPayloadWhenBotPrefersBase64(t *testing.
|
||||
}
|
||||
}
|
||||
|
||||
func TestDecodePayloadStrictRejectsMismatchedType(t *testing.T) {
|
||||
kb := NewInlineKeyboardBase64(1).
|
||||
func TestDecodePayloadAcceptsCompactKeyboardPayloadWhenBotPrefersJSON(t *testing.T) {
|
||||
kb := NewInlineKeyboardCompact(1).
|
||||
AddCallbackButton("A", "cmd", 1, "two")
|
||||
|
||||
got, decodedType, err := decodePayload(BotPayloadJSON, kb.Get().InlineKeyboard[0][0].CallbackData, false)
|
||||
if err != nil {
|
||||
t.Fatalf("decodePayload returned error: %v", err)
|
||||
}
|
||||
if decodedType != BotPayloadCompact {
|
||||
t.Fatalf("unexpected decoded payload type: got %q want %q", decodedType, BotPayloadCompact)
|
||||
}
|
||||
|
||||
want := CallbackData{Command: "cmd", Args: []string{"1", "two"}}
|
||||
if !reflect.DeepEqual(got, want) {
|
||||
t.Fatalf("unexpected payload: got %#v want %#v", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDecodePayloadAcceptsCompactBase64KeyboardPayloadWhenBotPrefersJSON(t *testing.T) {
|
||||
kb := NewInlineKeyboardCompactBase64(1).
|
||||
AddCallbackButton("A", "cmd", 1, "two")
|
||||
|
||||
got, decodedType, err := decodePayload(BotPayloadJSON, kb.Get().InlineKeyboard[0][0].CallbackData, false)
|
||||
if err != nil {
|
||||
t.Fatalf("decodePayload returned error: %v", err)
|
||||
}
|
||||
if decodedType != BotPayloadCompactBase64 {
|
||||
t.Fatalf("unexpected decoded payload type: got %q want %q", decodedType, BotPayloadCompactBase64)
|
||||
}
|
||||
|
||||
want := CallbackData{Command: "cmd", Args: []string{"1", "two"}}
|
||||
if !reflect.DeepEqual(got, want) {
|
||||
t.Fatalf("unexpected payload: got %#v want %#v", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
// TestCompactPayloadRoundTripsWithSeparatorChars guards the compact-encoding
|
||||
// escape fix. Args containing the , | or \ separator bytes previously corrupted
|
||||
// on decode; now they must round-trip exactly.
|
||||
//
|
||||
// Note: the compact format coalesces "no args" with "single empty arg" — both
|
||||
// emit "cmd|" and decode to nil args. Use other encodings if that distinction
|
||||
// matters.
|
||||
func TestCompactPayloadRoundTripsWithSeparatorChars(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
data CallbackData
|
||||
}{
|
||||
{name: "plain", data: CallbackData{Command: "cmd", Args: []string{"one", "two"}}},
|
||||
{name: "no args", data: CallbackData{Command: "cmd"}},
|
||||
{name: "comma in arg", data: CallbackData{Command: "cmd", Args: []string{"a,b", "c"}}},
|
||||
{name: "pipe in arg", data: CallbackData{Command: "cmd", Args: []string{"a|b", "c"}}},
|
||||
{name: "backslash in arg", data: CallbackData{Command: "cmd", Args: []string{`a\b`, "c"}}},
|
||||
{name: "all specials in arg", data: CallbackData{Command: "cmd", Args: []string{`a,b|c\d`}}},
|
||||
{name: "specials in command", data: CallbackData{Command: "a|b,c", Args: []string{"x"}}},
|
||||
{name: "two empty args", data: CallbackData{Command: "cmd", Args: []string{"", ""}}},
|
||||
{name: "utf8 args", data: CallbackData{Command: "cmd", Args: []string{"привет", "мир"}}},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
encoded, err := encodeCompactPayload(tt.data)
|
||||
if err != nil {
|
||||
t.Fatalf("encodeCompactPayload returned error: %v", err)
|
||||
}
|
||||
got, err := decodeCompactPayload(encoded)
|
||||
if err != nil {
|
||||
t.Fatalf("decodeCompactPayload returned error: %v", err)
|
||||
}
|
||||
if got.Command != tt.data.Command {
|
||||
t.Fatalf("command mismatch: got %q want %q (encoded=%q)", got.Command, tt.data.Command, encoded)
|
||||
}
|
||||
if len(got.Args) != len(tt.data.Args) {
|
||||
t.Fatalf("args length mismatch: got %v want %v (encoded=%q)", got.Args, tt.data.Args, encoded)
|
||||
}
|
||||
for i := range tt.data.Args {
|
||||
if got.Args[i] != tt.data.Args[i] {
|
||||
t.Fatalf("arg %d mismatch: got %q want %q (encoded=%q)", i, got.Args[i], tt.data.Args[i], encoded)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestCompactPayloadDecodeRejectsMissingSeparator(t *testing.T) {
|
||||
if _, err := decodeCompactPayload("noseparator"); err == nil {
|
||||
t.Fatal("expected error decoding payload without separator")
|
||||
}
|
||||
}
|
||||
|
||||
func TestDecodePayloadStrictRejectsCompactMismatchedType(t *testing.T) {
|
||||
kb := NewInlineKeyboardCompact(1).
|
||||
AddCallbackButton("A", "cmd", 1)
|
||||
|
||||
_, _, err := decodePayload(BotPayloadJson, kb.Get().InlineKeyboard[0][0].CallbackData, true)
|
||||
_, _, err := decodePayload(BotPayloadJSON, kb.Get().InlineKeyboard[0][0].CallbackData, true)
|
||||
if !errors.Is(err, ErrPayloadTypeMismatch) {
|
||||
t.Fatalf("expected ErrPayloadTypeMismatch, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
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)
|
||||
}
|
||||
}
|
||||
|
||||
func TestInlineKeyboardValidation(t *testing.T) {
|
||||
if err := NewInlineKeyboardButton("missing action").Validate(); !errors.Is(err, ErrInlineKeyboardButtonAction) {
|
||||
t.Fatalf("expected ErrInlineKeyboardButtonAction, got %v", err)
|
||||
}
|
||||
|
||||
long := strings.Repeat("я", 33)
|
||||
button := NewInlineKeyboardButton("long").SetCallbackDataCompact(long)
|
||||
if err := button.Validate(); !errors.Is(err, ErrCallbackDataLength) {
|
||||
t.Fatalf("expected ErrCallbackDataLength, got %v", err)
|
||||
}
|
||||
|
||||
keyboard := NewInlineKeyboardCompact(1).AddButton(button)
|
||||
if _, err := keyboard.GetValidated(); !errors.Is(err, ErrCallbackDataLength) {
|
||||
t.Fatalf("expected validated keyboard to reject callback data, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestCallbackDataEncodeValidatedBoundaries(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
command string
|
||||
wantLen int
|
||||
wantErr error
|
||||
}{
|
||||
{name: "one byte", command: "", wantLen: 1},
|
||||
{name: "64 bytes", command: strings.Repeat("a", 63), wantLen: 64},
|
||||
{name: "65 bytes", command: strings.Repeat("a", 64), wantErr: ErrCallbackDataLength},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
encoded, err := (CallbackData{Command: tt.command}).EncodeValidated(BotPayloadCompact)
|
||||
if !errors.Is(err, tt.wantErr) {
|
||||
t.Fatalf("expected %v, got %v", tt.wantErr, err)
|
||||
}
|
||||
if err == nil && len([]byte(encoded)) != tt.wantLen {
|
||||
t.Fatalf("encoded length = %d, want %d", len([]byte(encoded)), tt.wantLen)
|
||||
}
|
||||
})
|
||||
}
|
||||
if _, err := (CallbackData{Command: "ok"}).EncodeValidated(BotPayloadType("unknown")); !errors.Is(err, ErrInvalidPayloadType) {
|
||||
t.Fatalf("expected ErrInvalidPayloadType, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestInlineKeyboardLoweredMaxRowStillWraps(t *testing.T) {
|
||||
keyboard := NewInlineKeyboardJSON(3).
|
||||
AddURLButton("A", "https://example.test/a").
|
||||
AddURLButton("B", "https://example.test/b").
|
||||
SetMaxRow(1).
|
||||
AddURLButton("C", "https://example.test/c")
|
||||
|
||||
markup := keyboard.Get()
|
||||
if len(markup.InlineKeyboard) != 2 || len(markup.InlineKeyboard[0]) != 2 || len(markup.InlineKeyboard[1]) != 1 {
|
||||
t.Fatalf("lowered maxRow stopped automatic wrapping: %#v", markup.InlineKeyboard)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
package laniakea
|
||||
|
||||
import "sync"
|
||||
import (
|
||||
"maps"
|
||||
"sync"
|
||||
)
|
||||
|
||||
// DictEntry maps language codes to translated strings.
|
||||
type DictEntry map[string]string
|
||||
@@ -64,8 +67,6 @@ func cloneDictEntry(src DictEntry) DictEntry {
|
||||
return nil
|
||||
}
|
||||
cloned := make(DictEntry, len(src))
|
||||
for lang, text := range src {
|
||||
cloned[lang] = text
|
||||
}
|
||||
maps.Copy(cloned, src)
|
||||
return cloned
|
||||
}
|
||||
|
||||
+34
-9
@@ -3,6 +3,7 @@ package laniakea
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"iter"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
)
|
||||
@@ -21,15 +22,15 @@ import (
|
||||
//
|
||||
// Behavior:
|
||||
// 1. Uses the bot's current update offset (via GetUpdateOffset)
|
||||
// 2. Requests updates with 30-second timeout
|
||||
// 2. Requests updates with the timeout configured via PollTimeout
|
||||
// 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.
|
||||
// Note: This is a blocking call that waits up to the configured PollTimeout
|
||||
// for new updates, unless ctx is canceled earlier. For non-blocking behavior,
|
||||
// consider using webhooks instead.
|
||||
//
|
||||
// Example:
|
||||
//
|
||||
@@ -42,28 +43,52 @@ import (
|
||||
// }
|
||||
func (bot *Bot[T]) Updates(ctx context.Context) ([]tgapi.Update, error) {
|
||||
offset := bot.GetUpdateOffset()
|
||||
timeout := bot.pollTimeout
|
||||
params := tgapi.UpdateParams{
|
||||
Offset: new(offset),
|
||||
Timeout: new(30),
|
||||
Timeout: new(timeout),
|
||||
AllowedUpdates: bot.GetUpdateTypes(),
|
||||
}
|
||||
|
||||
zero := make([]tgapi.Update, 0)
|
||||
updates, err := bot.api.GetUpdatesWithContext(ctx, params)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
return zero, err
|
||||
}
|
||||
|
||||
if bot.RequestLogger != nil {
|
||||
if bot.requestLogger != nil {
|
||||
for _, u := range updates {
|
||||
j, err := json.Marshal(u)
|
||||
if err != nil {
|
||||
bot.GetLogger().Error(err)
|
||||
}
|
||||
bot.RequestLogger.Debugf("UPDATE %s\n", j)
|
||||
bot.requestLogger.Debugf("UPDATE %s\n", j)
|
||||
}
|
||||
}
|
||||
if len(updates) > 0 {
|
||||
bot.SetUpdateOffset(updates[len(updates)-1].UpdateID + 1)
|
||||
}
|
||||
return updates, err
|
||||
if updates == nil {
|
||||
return zero, nil
|
||||
}
|
||||
return updates, nil
|
||||
}
|
||||
|
||||
// UpdatesIter fetches updates once and yields each update in order.
|
||||
//
|
||||
// If fetching updates fails, the iterator yields the error once with a zero
|
||||
// update and then stops.
|
||||
func (bot *Bot[T]) UpdatesIter(ctx context.Context) iter.Seq2[tgapi.Update, error] {
|
||||
return func(yield func(tgapi.Update, error) bool) {
|
||||
updates, err := bot.Updates(ctx)
|
||||
if err != nil {
|
||||
yield(tgapi.Update{}, err)
|
||||
return
|
||||
}
|
||||
for _, u := range updates {
|
||||
if !yield(u, nil) {
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -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}
|
||||
}
|
||||
+379
-185
@@ -8,30 +8,32 @@ import (
|
||||
"reflect"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/slog"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgrich"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
// MsgContext holds the normalized per-update context passed to command, payload,
|
||||
// MessageContext 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.
|
||||
// MessageContext 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
|
||||
// - 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,
|
||||
// Helper methods on MessageContext 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
|
||||
// InlineMsgID when there is no chat message.
|
||||
type MessageContext struct {
|
||||
// API is the Telegram API client used by context helpers.
|
||||
API *tgapi.API
|
||||
// Update is the Telegram update being handled.
|
||||
Update tgapi.Update
|
||||
|
||||
// Msg is the normalized Telegram message for message-backed update kinds.
|
||||
@@ -46,17 +48,17 @@ type MsgContext struct {
|
||||
|
||||
// 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 *slog.Logger
|
||||
Logger *sneklog.Logger
|
||||
|
||||
// InlineMsgId is the inline message identifier for callback queries that target
|
||||
// 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
|
||||
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
|
||||
CallbackMsgID int
|
||||
// CallbackQueryID is the Telegram callback query ID for payload handlers and
|
||||
// callback-backed scene handlers.
|
||||
CallbackQueryId string
|
||||
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
|
||||
@@ -81,48 +83,66 @@ type MsgContext struct {
|
||||
payloadType BotPayloadType
|
||||
sceneRuntime sceneRuntime
|
||||
observer Observer
|
||||
eventEmitter func(context.Context, Event)
|
||||
asyncTask func(func())
|
||||
botID int64
|
||||
|
||||
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,
|
||||
}
|
||||
func (ctx *MessageContext) buildEditMessageTextParams(messageID int, keyboard *InlineKeyboard, parseMode tgapi.ParseMode) (tgapi.EditMessageText, error) {
|
||||
params := tgapi.EditMessageText{}
|
||||
switch {
|
||||
case messageId > 0 && ctx.Msg != nil:
|
||||
params.MessageID = messageId
|
||||
case messageID > 0 && ctx.Msg != nil && ctx.Msg.Chat != nil:
|
||||
params.MessageID = messageID
|
||||
params.ChatID = ctx.Msg.Chat.ID
|
||||
case ctx.InlineMsgId != "":
|
||||
params.InlineMessageID = ctx.InlineMsgId
|
||||
params.BusinessConnectionID = ctx.Msg.BusinessConnectionID
|
||||
case ctx.InlineMsgID != "":
|
||||
params.InlineMessageID = ctx.InlineMsgID
|
||||
default:
|
||||
ctx.Logger.Errorln(ErrEditTargetMissing)
|
||||
return nil
|
||||
return params, ErrEditTargetMissing
|
||||
}
|
||||
if parseMode != "" {
|
||||
params.ParseMode = parseMode
|
||||
}
|
||||
if keyboard != nil {
|
||||
params.ReplyMarkup = keyboard.Get()
|
||||
}
|
||||
msg, _, err := ctx.Api.EditMessageTextWithContext(ctx.Context(), params)
|
||||
return params, nil
|
||||
}
|
||||
|
||||
// AnswerMessage represents a message sent or edited via MessageContext.
|
||||
// It holds metadata to allow further editing or deletion.
|
||||
type AnswerMessage struct {
|
||||
// MessageID identifies the sent Telegram message.
|
||||
MessageID int
|
||||
// Text contains the text or caption sent with the message.
|
||||
// For rich messages, it contains rendered HTML for v1 compatibility.
|
||||
Text string
|
||||
// RichHTML contains the rendered HTML of a rich message.
|
||||
RichHTML string // Since: Bot API 10.2
|
||||
// IsMedia reports whether the answer contains media.
|
||||
IsMedia bool
|
||||
ctx *MessageContext // internal back-reference
|
||||
}
|
||||
|
||||
func (ctx *MessageContext) edit(messageID int, text string, keyboard *InlineKeyboard, parseMode tgapi.ParseMode) *AnswerMessage {
|
||||
params, err := ctx.buildEditMessageTextParams(messageID, keyboard, parseMode)
|
||||
if err != nil {
|
||||
ctx.Logger.Errorln(err)
|
||||
return nil
|
||||
}
|
||||
resultMessageID := messageId
|
||||
if err := validateMessageText(text); err != nil {
|
||||
ctx.Logger.Errorln(err)
|
||||
return nil
|
||||
}
|
||||
params.Text = text
|
||||
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
|
||||
}
|
||||
@@ -139,47 +159,45 @@ func (m *AnswerMessage) Edit(text string) *AnswerMessage {
|
||||
|
||||
// EditMarkdown replaces the text of the message using MarkdownV2 formatting.
|
||||
//
|
||||
// ⚠️ WARNING: User input must be escaped with laniakea.EscapeMarkdownV2() before passing here.
|
||||
// ⚠️ WARNING: User input must be escaped with tgfmt.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)
|
||||
return m.ctx.edit(m.MessageID, text, nil, tgapi.ParseMarkdownV2)
|
||||
}
|
||||
|
||||
// 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 == "" {
|
||||
func (ctx *MessageContext) 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)
|
||||
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 {
|
||||
func (ctx *MessageContext) 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)
|
||||
// ⚠️ WARNING: User input must be escaped with tgfmt.EscapeMarkdownV2() before passing here.
|
||||
func (ctx *MessageContext) EditCallbackMarkdown(text string, keyboard *InlineKeyboard) *AnswerMessage {
|
||||
return ctx.editCallback(text, keyboard, tgapi.ParseMarkdownV2)
|
||||
}
|
||||
|
||||
// EditCallbackf formats a string using fmt.Sprintf and edits the callback message with plain text.
|
||||
func (ctx *MsgContext) EditCallbackf(format string, keyboard *InlineKeyboard, args ...any) *AnswerMessage {
|
||||
func (ctx *MessageContext) 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)
|
||||
// ⚠️ WARNING: User input must be escaped with tgfmt.EscapeMarkdownV2() before passing here.
|
||||
func (ctx *MessageContext) EditCallbackfMarkdown(format string, keyboard *InlineKeyboard, args ...any) *AnswerMessage {
|
||||
return ctx.editCallback(fmt.Sprintf(format, args...), keyboard, tgapi.ParseMarkdownV2)
|
||||
}
|
||||
|
||||
// Internal helper for media-caption edits.
|
||||
func (ctx *MsgContext) editPhotoText(messageId int, text string, kb *InlineKeyboard, parseMode tgapi.ParseMode) *AnswerMessage {
|
||||
func (ctx *MessageContext) editPhotoText(messageID int, text string, kb *InlineKeyboard, parseMode tgapi.ParseMode) *AnswerMessage {
|
||||
if err := validateCaptionText(text); err != nil {
|
||||
ctx.Logger.Errorln(err)
|
||||
return nil
|
||||
@@ -189,11 +207,12 @@ func (ctx *MsgContext) editPhotoText(messageId int, text string, kb *InlineKeybo
|
||||
ParseMode: parseMode,
|
||||
}
|
||||
switch {
|
||||
case messageId > 0 && ctx.Msg != nil:
|
||||
case messageID > 0 && ctx.Msg != nil && ctx.Msg.Chat != nil:
|
||||
params.ChatID = ctx.Msg.Chat.ID
|
||||
params.MessageID = messageId
|
||||
case ctx.InlineMsgId != "":
|
||||
params.InlineMessageID = ctx.InlineMsgId
|
||||
params.MessageID = messageID
|
||||
params.BusinessConnectionID = ctx.Msg.BusinessConnectionID
|
||||
case ctx.InlineMsgID != "":
|
||||
params.InlineMessageID = ctx.InlineMsgID
|
||||
default:
|
||||
ctx.Logger.Errorln(ErrEditTargetMissing)
|
||||
return nil
|
||||
@@ -202,12 +221,12 @@ func (ctx *MsgContext) editPhotoText(messageId int, text string, kb *InlineKeybo
|
||||
params.ReplyMarkup = kb.Get()
|
||||
}
|
||||
|
||||
msg, _, err := ctx.Api.EditMessageCaptionWithContext(ctx.Context(), params)
|
||||
msg, _, err := ctx.API.EditMessageCaptionWithContext(ctx.Context(), params)
|
||||
if err != nil {
|
||||
ctx.Logger.Errorln(err)
|
||||
return nil
|
||||
}
|
||||
resultMessageID := messageId
|
||||
resultMessageID := messageID
|
||||
if msg.MessageID > 0 {
|
||||
resultMessageID = msg.MessageID
|
||||
}
|
||||
@@ -223,9 +242,9 @@ func (m *AnswerMessage) EditCaption(text string) *AnswerMessage {
|
||||
|
||||
// EditCaptionMarkdown edits the caption of a media message using MarkdownV2.
|
||||
//
|
||||
// ⚠️ WARNING: User input must be escaped with laniakea.EscapeMarkdownV2() before passing here.
|
||||
// ⚠️ WARNING: User input must be escaped with tgfmt.EscapeMarkdownV2() before passing here.
|
||||
func (m *AnswerMessage) EditCaptionMarkdown(text string) *AnswerMessage {
|
||||
return m.ctx.editPhotoText(m.MessageID, text, nil, tgapi.ParseMDV2)
|
||||
return m.ctx.editPhotoText(m.MessageID, text, nil, tgapi.ParseMarkdownV2)
|
||||
}
|
||||
|
||||
// EditCaptionKeyboard edits the caption of a media message with a new inline keyboard (plain text).
|
||||
@@ -235,14 +254,13 @@ func (m *AnswerMessage) EditCaptionKeyboard(text string, kb *InlineKeyboard) *An
|
||||
|
||||
// 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.
|
||||
// ⚠️ WARNING: User input must be escaped with tgfmt.EscapeMarkdownV2() before passing here.
|
||||
func (m *AnswerMessage) EditCaptionKeyboardMarkdown(text string, kb *InlineKeyboard) *AnswerMessage {
|
||||
return m.ctx.editPhotoText(m.MessageID, text, kb, tgapi.ParseMDV2)
|
||||
return m.ctx.editPhotoText(m.MessageID, text, kb, tgapi.ParseMarkdownV2)
|
||||
}
|
||||
|
||||
// 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 {
|
||||
func (ctx *MessageContext) answer(text string, keyboard *InlineKeyboard, parseMode tgapi.ParseMode) *AnswerMessage {
|
||||
if ctx.Msg == nil || ctx.Msg.Chat == nil {
|
||||
ctx.Logger.Errorln(ErrMessageContextNil)
|
||||
return nil
|
||||
}
|
||||
@@ -251,9 +269,10 @@ func (ctx *MsgContext) answer(text string, keyboard *InlineKeyboard, parseMode t
|
||||
return nil
|
||||
}
|
||||
params := tgapi.SendMessage{
|
||||
ChatID: ctx.Msg.Chat.ID,
|
||||
Text: text,
|
||||
ParseMode: parseMode,
|
||||
BusinessConnectionID: ctx.Msg.BusinessConnectionID,
|
||||
ChatID: ctx.Msg.Chat.ID,
|
||||
Text: text,
|
||||
ParseMode: parseMode,
|
||||
}
|
||||
if keyboard != nil {
|
||||
params.ReplyMarkup = keyboard.Get()
|
||||
@@ -265,7 +284,7 @@ func (ctx *MsgContext) answer(text string, keyboard *InlineKeyboard, parseMode t
|
||||
params.DirectMessagesTopicID = ctx.Msg.DirectMessageTopic.TopicID
|
||||
}
|
||||
|
||||
msg, err := ctx.Api.SendMessageWithContext(ctx.Context(), params)
|
||||
msg, err := ctx.API.SendMessageWithContext(ctx.Context(), params)
|
||||
if err != nil {
|
||||
ctx.Logger.Errorln(err)
|
||||
return nil
|
||||
@@ -276,7 +295,7 @@ func (ctx *MsgContext) answer(text string, keyboard *InlineKeyboard, parseMode t
|
||||
}
|
||||
|
||||
// Answer sends a plain text message (ParseNone).
|
||||
func (ctx *MsgContext) Answer(text string) *AnswerMessage {
|
||||
func (ctx *MessageContext) Answer(text string) *AnswerMessage {
|
||||
return ctx.answer(text, nil, tgapi.ParseNone)
|
||||
}
|
||||
|
||||
@@ -284,59 +303,59 @@ func (ctx *MsgContext) Answer(text string) *AnswerMessage {
|
||||
//
|
||||
// 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 {
|
||||
func (ctx *MessageContext) 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)
|
||||
// ⚠️ WARNING: User input must be escaped with tgfmt.EscapeMarkdownV2() before passing here.
|
||||
func (ctx *MessageContext) AnswerMarkdown(text string) *AnswerMessage {
|
||||
return ctx.answer(text, nil, tgapi.ParseMarkdownV2)
|
||||
}
|
||||
|
||||
// Answerf formats a string using fmt.Sprintf and sends it as a plain text message.
|
||||
func (ctx *MsgContext) Answerf(template string, args ...any) *AnswerMessage {
|
||||
func (ctx *MessageContext) 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 {
|
||||
func (ctx *MessageContext) 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)
|
||||
// ⚠️ WARNING: User input must be escaped with tgfmt.EscapeMarkdownV2() before passing here.
|
||||
func (ctx *MessageContext) AnswerfMarkdown(template string, args ...any) *AnswerMessage {
|
||||
return ctx.answer(fmt.Sprintf(template, args...), nil, tgapi.ParseMarkdownV2)
|
||||
}
|
||||
|
||||
// Keyboard sends a message with an inline keyboard (plain text).
|
||||
func (ctx *MsgContext) Keyboard(text string, kb *InlineKeyboard) *AnswerMessage {
|
||||
func (ctx *MessageContext) 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 {
|
||||
func (ctx *MessageContext) 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)
|
||||
// ⚠️ WARNING: User input must be escaped with tgfmt.EscapeMarkdownV2() before passing here.
|
||||
func (ctx *MessageContext) KeyboardMarkdown(text string, keyboard *InlineKeyboard) *AnswerMessage {
|
||||
return ctx.answer(text, keyboard, tgapi.ParseMarkdownV2)
|
||||
}
|
||||
|
||||
func (ctx *MsgContext) answerLong(text string, keyboard *InlineKeyboard, parseMode tgapi.ParseMode) []*AnswerMessage {
|
||||
func (ctx *MessageContext) answerLong(text string, keyboard *InlineKeyboard, parseMode tgapi.ParseMode) []*AnswerMessage {
|
||||
if parseMode != tgapi.ParseNone {
|
||||
ctx.Logger.Errorln(ErrMessageSplitImpossible)
|
||||
return nil
|
||||
}
|
||||
if ctx.Msg == nil {
|
||||
if ctx.Msg == nil || ctx.Msg.Chat == nil {
|
||||
ctx.Logger.Errorln(ErrMessageContextNil)
|
||||
return nil
|
||||
}
|
||||
@@ -370,9 +389,8 @@ func (ctx *MsgContext) answerLong(text string, keyboard *InlineKeyboard, parseMo
|
||||
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 {
|
||||
func (ctx *MessageContext) answerPhoto(photoID, text string, kb *InlineKeyboard, parseMode tgapi.ParseMode) *AnswerMessage {
|
||||
if ctx.Msg == nil || ctx.Msg.Chat == nil {
|
||||
ctx.Logger.Errorln(ErrMessageContextNil)
|
||||
return nil
|
||||
}
|
||||
@@ -381,10 +399,11 @@ func (ctx *MsgContext) answerPhoto(photoId, text string, kb *InlineKeyboard, par
|
||||
return nil
|
||||
}
|
||||
params := tgapi.SendPhoto{
|
||||
ChatID: ctx.Msg.Chat.ID,
|
||||
Caption: text,
|
||||
ParseMode: parseMode,
|
||||
Photo: photoId,
|
||||
BusinessConnectionID: ctx.Msg.BusinessConnectionID,
|
||||
ChatID: ctx.Msg.Chat.ID,
|
||||
Caption: text,
|
||||
ParseMode: parseMode,
|
||||
Photo: photoID,
|
||||
}
|
||||
if kb != nil {
|
||||
params.ReplyMarkup = kb.Get()
|
||||
@@ -396,7 +415,7 @@ func (ctx *MsgContext) answerPhoto(photoId, text string, kb *InlineKeyboard, par
|
||||
params.DirectMessagesTopicID = int(ctx.Msg.DirectMessageTopic.TopicID)
|
||||
}
|
||||
|
||||
msg, err := ctx.Api.SendPhotoWithContext(ctx.Context(), params)
|
||||
msg, err := ctx.API.SendPhotoWithContext(ctx.Context(), params)
|
||||
if err != nil {
|
||||
ctx.Logger.Errorln(err)
|
||||
return nil
|
||||
@@ -407,54 +426,53 @@ func (ctx *MsgContext) answerPhoto(photoId, text string, kb *InlineKeyboard, par
|
||||
}
|
||||
|
||||
// AnswerPhoto sends a photo with plain text caption.
|
||||
func (ctx *MsgContext) AnswerPhoto(photoId, text string) *AnswerMessage {
|
||||
return ctx.answerPhoto(photoId, text, nil, tgapi.ParseNone)
|
||||
func (ctx *MessageContext) 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)
|
||||
// ⚠️ WARNING: User input must be escaped with tgfmt.EscapeMarkdownV2() before passing here.
|
||||
func (ctx *MessageContext) AnswerPhotoMarkdown(photoID, text string) *AnswerMessage {
|
||||
return ctx.answerPhoto(photoID, text, nil, tgapi.ParseMarkdownV2)
|
||||
}
|
||||
|
||||
// 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)
|
||||
func (ctx *MessageContext) 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)
|
||||
// ⚠️ WARNING: User input must be escaped with tgfmt.EscapeMarkdownV2() before passing here.
|
||||
func (ctx *MessageContext) AnswerPhotoKeyboardMarkdown(photoID, text string, kb *InlineKeyboard) *AnswerMessage {
|
||||
return ctx.answerPhoto(photoID, text, kb, tgapi.ParseMarkdownV2)
|
||||
}
|
||||
|
||||
// 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)
|
||||
func (ctx *MessageContext) 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)
|
||||
// ⚠️ WARNING: User input must be escaped with tgfmt.EscapeMarkdownV2() before passing here.
|
||||
func (ctx *MessageContext) AnswerPhotofMarkdown(photoID, template string, args ...any) *AnswerMessage {
|
||||
return ctx.answerPhoto(photoID, fmt.Sprintf(template, args...), nil, tgapi.ParseMarkdownV2)
|
||||
}
|
||||
|
||||
// Internal helper that deletes a message by ID.
|
||||
func (ctx *MsgContext) delete(messageId int) {
|
||||
if messageId == 0 {
|
||||
func (ctx *MessageContext) delete(messageID int) {
|
||||
if messageID == 0 {
|
||||
ctx.Logger.Errorln(ErrMessageIDZero)
|
||||
return
|
||||
}
|
||||
if ctx.Msg == nil {
|
||||
if ctx.Msg == nil || ctx.Msg.Chat == nil {
|
||||
ctx.Logger.Errorln(ErrMessageContextNil)
|
||||
return
|
||||
}
|
||||
_, err := ctx.Api.DeleteMessageWithContext(ctx.Context(), tgapi.DeleteMessage{
|
||||
_, err := ctx.API.DeleteMessageWithContext(ctx.Context(), tgapi.DeleteMessage{
|
||||
ChatID: ctx.Msg.Chat.ID,
|
||||
MessageID: messageId,
|
||||
MessageID: messageID,
|
||||
})
|
||||
if err != nil {
|
||||
ctx.Logger.Errorln(err)
|
||||
@@ -465,21 +483,20 @@ func (ctx *MsgContext) delete(messageId int) {
|
||||
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 {
|
||||
func (ctx *MessageContext) CallbackDelete() {
|
||||
if ctx.CallbackMsgID == 0 {
|
||||
ctx.Logger.Errorln(ErrCallbackMessageMissing)
|
||||
return
|
||||
}
|
||||
ctx.delete(ctx.CallbackMsgId)
|
||||
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 {
|
||||
func (ctx *MessageContext) answerCallbackQuery(url, text string, showAlert bool) {
|
||||
if len(ctx.CallbackQueryID) == 0 {
|
||||
return
|
||||
}
|
||||
_, err := ctx.Api.AnswerCallbackQueryWithContext(ctx.Context(), tgapi.AnswerCallbackQuery{
|
||||
CallbackQueryID: ctx.CallbackQueryId,
|
||||
_, err := ctx.API.AnswerCallbackQueryWithContext(ctx.Context(), tgapi.AnswerCallbackQuery{
|
||||
CallbackQueryID: ctx.CallbackQueryID,
|
||||
Text: text, ShowAlert: showAlert, URL: url,
|
||||
})
|
||||
if err != nil {
|
||||
@@ -487,63 +504,69 @@ func (ctx *MsgContext) answerCallbackQuery(url, text string, showAlert bool) {
|
||||
}
|
||||
}
|
||||
|
||||
// AnswerCbQuery answers the callback query with no text or alert.
|
||||
func (ctx *MsgContext) AnswerCbQuery() { ctx.answerCallbackQuery("", "", false) }
|
||||
// AnswerCallback answers the callback query with no text or alert.
|
||||
func (ctx *MessageContext) AnswerCallback() { ctx.answerCallbackQuery("", "", false) }
|
||||
|
||||
// AnswerCbQueryText answers the callback query with a text notification.
|
||||
func (ctx *MsgContext) AnswerCbQueryText(text string) { ctx.answerCallbackQuery("", text, false) }
|
||||
// AnswerCallbackText answers the callback query with a text notification.
|
||||
func (ctx *MessageContext) AnswerCallbackText(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) }
|
||||
// AnswerCallbackAlert answers the callback query with a user-visible alert.
|
||||
func (ctx *MessageContext) AnswerCallbackAlert(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) }
|
||||
// AnswerCallbackURL answers the callback query with a URL redirect.
|
||||
func (ctx *MessageContext) AnswerCallbackURL(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")
|
||||
func (ctx *MessageContext) SendAction(action tgapi.ChatActionType) {
|
||||
if ctx.Msg == nil || ctx.Msg.Chat == nil {
|
||||
ctx.Logger.Errorln(ErrMessageContextNil)
|
||||
return
|
||||
}
|
||||
params := tgapi.SendChatAction{
|
||||
ChatID: ctx.Msg.Chat.ID, Action: action,
|
||||
BusinessConnectionID: ctx.Msg.BusinessConnectionID,
|
||||
ChatID: ctx.Msg.Chat.ID,
|
||||
Action: action,
|
||||
}
|
||||
if ctx.Msg.MessageThreadID > 0 {
|
||||
params.MessageThreadID = ctx.Msg.MessageThreadID
|
||||
}
|
||||
_, err := ctx.Api.SendChatActionWithContext(ctx.Context(), params)
|
||||
_, 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) {
|
||||
func (ctx *MessageContext) error(err error) {
|
||||
if err == nil {
|
||||
return
|
||||
}
|
||||
ctx.Logger.Errorln(err)
|
||||
if IsInternalError(err) {
|
||||
if !IsUserError(err) {
|
||||
return
|
||||
}
|
||||
text := fmt.Sprintf(ctx.errorTemplate, err.Error())
|
||||
|
||||
if ctx.CallbackQueryId != "" {
|
||||
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) }
|
||||
// Error routes err through the centralized handler error path.
|
||||
//
|
||||
// The error is logged via ctx.Logger. When IsUserError(err) is true, the
|
||||
// formatted error template is delivered to the user — through an answer
|
||||
// to the active callback query when one exists, otherwise as a chat reply.
|
||||
// Internal errors are logged but not surfaced to the user.
|
||||
func (ctx *MessageContext) Error(err error) { ctx.error(err) }
|
||||
|
||||
func (ctx *MsgContext) newDraft(parseMode tgapi.ParseMode) *Draft {
|
||||
if ctx.Msg == nil {
|
||||
func (ctx *MessageContext) newDraft(parseMode tgapi.ParseMode) *Draft {
|
||||
if ctx.Msg == nil || ctx.Msg.Chat == nil {
|
||||
ctx.Logger.Errorln(ErrMessageContextNil)
|
||||
return nil
|
||||
}
|
||||
if ctx.Api == nil {
|
||||
if ctx.API == nil {
|
||||
ctx.Logger.Errorln(ErrAPIIsNil)
|
||||
return nil
|
||||
}
|
||||
@@ -552,35 +575,26 @@ func (ctx *MsgContext) newDraft(parseMode tgapi.ParseMode) *Draft {
|
||||
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 {
|
||||
// Draft sends are rate-limited by the API client.
|
||||
func (ctx *MessageContext) 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)
|
||||
// Draft sends are rate-limited by the API client.
|
||||
func (ctx *MessageContext) NewDraftMarkdown() *Draft {
|
||||
return ctx.newDraft(tgapi.ParseMarkdownV2)
|
||||
}
|
||||
|
||||
// Translate looks up a key in the current user's language.
|
||||
// Falls back to the bot's default language if user's language is unknown or unsupported.
|
||||
func (ctx *MsgContext) Translate(key string) string {
|
||||
func (ctx *MessageContext) Translate(key string) string {
|
||||
if ctx.From == nil {
|
||||
return key
|
||||
}
|
||||
@@ -590,10 +604,15 @@ func (ctx *MsgContext) Translate(key string) string {
|
||||
|
||||
// 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 {
|
||||
func (ctx *MessageContext) NewInlineKeyboard(maxRow int) *InlineKeyboard {
|
||||
return NewInlineKeyboard(ctx.payloadType, maxRow)
|
||||
}
|
||||
|
||||
// NewInlineKeyboardButton creates a button builder using the context payload encoding.
|
||||
func (ctx *MessageContext) NewInlineKeyboardButton(text string) InlineKeyboardButtonBuilder {
|
||||
return NewInlineKeyboardButton(text).SetPayloadType(ctx.payloadType)
|
||||
}
|
||||
|
||||
func bindPositional(args []string, dst any) error {
|
||||
v := reflect.ValueOf(dst)
|
||||
if v.Kind() != reflect.Pointer || v.IsNil() {
|
||||
@@ -637,19 +656,19 @@ func bindPositional(args []string, dst any) error {
|
||||
case reflect.String:
|
||||
field.SetString(raw)
|
||||
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
|
||||
n, err := strconv.ParseInt(raw, 10, 64)
|
||||
n, err := strconv.ParseInt(raw, 10, field.Type().Bits())
|
||||
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)
|
||||
n, err := strconv.ParseUint(raw, 10, field.Type().Bits())
|
||||
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)
|
||||
f, err := strconv.ParseFloat(raw, field.Type().Bits())
|
||||
if err != nil {
|
||||
return fmt.Errorf("%w: field %s: %v", ErrBindArgsConversion, fieldType.Name, err)
|
||||
}
|
||||
@@ -679,20 +698,27 @@ func bindPositional(args []string, dst any) error {
|
||||
// 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 {
|
||||
func (ctx *MessageContext) 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 {
|
||||
func (ctx *MessageContext) 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 {
|
||||
func (ctx *MessageContext) emitPolicyChecked(event PolicyCheckedEvent) {
|
||||
if ctx == nil {
|
||||
return
|
||||
}
|
||||
if ctx.eventEmitter != nil {
|
||||
ctx.eventEmitter(ctx.Context(), event)
|
||||
return
|
||||
}
|
||||
if ctx.observer == nil {
|
||||
return
|
||||
}
|
||||
defer func() {
|
||||
@@ -708,7 +734,7 @@ func (ctx *MsgContext) emitPolicyChecked(event PolicyCheckedEvent) {
|
||||
}
|
||||
|
||||
// EnterScene enters the named scene at its configured entry step.
|
||||
func (ctx *MsgContext) EnterScene(name string) error {
|
||||
func (ctx *MessageContext) EnterScene(name string) error {
|
||||
if ctx.sceneRuntime == nil {
|
||||
return ErrSceneRuntimeNil
|
||||
}
|
||||
@@ -718,7 +744,7 @@ func (ctx *MsgContext) EnterScene(name string) error {
|
||||
return ErrSceneNotFound
|
||||
}
|
||||
|
||||
key, ok := ctx.sceneRuntime.buildSceneKey(scene.Scope, ctx)
|
||||
key, ok := buildSceneKey(scene.Scope, ctx)
|
||||
if !ok {
|
||||
return ErrCantFindSession
|
||||
}
|
||||
@@ -738,7 +764,7 @@ func (ctx *MsgContext) EnterScene(name string) error {
|
||||
}
|
||||
|
||||
// EnterSceneStep enters the named scene at a specific step.
|
||||
func (ctx *MsgContext) EnterSceneStep(name, step string) error {
|
||||
func (ctx *MessageContext) EnterSceneStep(name, step string) error {
|
||||
if ctx.sceneRuntime == nil {
|
||||
return ErrSceneRuntimeNil
|
||||
}
|
||||
@@ -751,21 +777,18 @@ func (ctx *MsgContext) EnterSceneStep(name, step string) error {
|
||||
return ErrSceneStepNotFound
|
||||
}
|
||||
|
||||
key, ok := ctx.sceneRuntime.buildSceneKey(scene.Scope, ctx)
|
||||
key, ok := buildSceneKey(scene.Scope, ctx)
|
||||
if !ok {
|
||||
return ErrCantFindSession
|
||||
}
|
||||
|
||||
session := SceneSession{
|
||||
Scene: scene.Name,
|
||||
Step: step,
|
||||
}
|
||||
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 {
|
||||
func (ctx *MessageContext) ExitScene() error {
|
||||
if ctx.sceneRuntime == nil {
|
||||
return ErrSceneRuntimeNil
|
||||
}
|
||||
@@ -783,10 +806,181 @@ func (ctx *MsgContext) ExitScene() error {
|
||||
return ErrSceneNotFound
|
||||
}
|
||||
|
||||
key, ok := ctx.sceneRuntime.buildSceneKey(scene.Scope, ctx)
|
||||
key, ok := buildSceneKey(scene.Scope, ctx)
|
||||
if !ok {
|
||||
return ErrCantFindSession
|
||||
}
|
||||
|
||||
return ctx.sceneRuntime.deleteSession(key)
|
||||
}
|
||||
|
||||
// IsCallback reports whether the context belongs to a callback query.
|
||||
func (ctx *MessageContext) IsCallback() bool {
|
||||
return ctx.CallbackQueryID != "" || ctx.CallbackMsgID > 0 || ctx.InlineMsgID != ""
|
||||
}
|
||||
|
||||
// HasPhoto reports whether the current message contains a photo payload.
|
||||
func (ctx *MessageContext) HasPhoto() bool {
|
||||
return ctx.Msg != nil && ctx.Msg.Photo.Len() > 0
|
||||
}
|
||||
|
||||
func (ctx *MessageContext) upsertKeyboard(text string, keyboard *InlineKeyboard, parseMode tgapi.ParseMode) *AnswerMessage {
|
||||
if ctx.IsCallback() {
|
||||
if ctx.HasPhoto() {
|
||||
ctx.CallbackDelete()
|
||||
return ctx.answer(text, keyboard, parseMode)
|
||||
}
|
||||
return ctx.editCallback(text, keyboard, parseMode)
|
||||
}
|
||||
return ctx.answer(text, keyboard, parseMode)
|
||||
}
|
||||
|
||||
// UpsertKeyboard edits a callback message or sends a new plain-text message with a keyboard.
|
||||
func (ctx *MessageContext) UpsertKeyboard(text string, keyboard *InlineKeyboard) *AnswerMessage {
|
||||
return ctx.upsertKeyboard(text, keyboard, tgapi.ParseNone)
|
||||
}
|
||||
|
||||
// UpsertKeyboardMarkdown edits a callback message or sends a new MarkdownV2 message with a keyboard.
|
||||
func (ctx *MessageContext) UpsertKeyboardMarkdown(text string, keyboard *InlineKeyboard) *AnswerMessage {
|
||||
return ctx.upsertKeyboard(text, keyboard, tgapi.ParseMarkdownV2)
|
||||
}
|
||||
|
||||
func (ctx *MessageContext) richAnswer(rich tgapi.InputRichMessage, keyboard *InlineKeyboard) *AnswerMessage {
|
||||
if ctx.Msg == nil || ctx.Msg.Chat == nil {
|
||||
ctx.Logger.Errorln(ErrMessageContextNil)
|
||||
return nil
|
||||
}
|
||||
params := tgapi.SendRichMessage{
|
||||
ChatID: ctx.Msg.Chat.ID,
|
||||
RichMessage: rich,
|
||||
}
|
||||
if keyboard != nil {
|
||||
params.ReplyMarkup = keyboard.Get()
|
||||
}
|
||||
if ctx.Msg.MessageThreadID > 0 {
|
||||
params.MessageThreadID = int64(ctx.Msg.MessageThreadID)
|
||||
}
|
||||
if ctx.Msg.DirectMessageTopic != nil {
|
||||
params.DirectMessagesTopicID = ctx.Msg.DirectMessageTopic.TopicID
|
||||
}
|
||||
if ctx.Msg.BusinessConnectionID != "" {
|
||||
params.BusinessConnectionID = ctx.Msg.BusinessConnectionID
|
||||
}
|
||||
|
||||
msg, err := ctx.API.SendRichMessageWithContext(ctx.Context(), params)
|
||||
if err != nil {
|
||||
ctx.Logger.Errorln(err)
|
||||
return nil
|
||||
}
|
||||
return &AnswerMessage{
|
||||
MessageID: msg.MessageID,
|
||||
Text: rich.HTML,
|
||||
RichHTML: rich.HTML,
|
||||
IsMedia: false,
|
||||
ctx: ctx,
|
||||
}
|
||||
}
|
||||
|
||||
func (ctx *MessageContext) richBlocksAnswer(keyboard *InlineKeyboard, blocks ...tgapi.InputRichBlock) *AnswerMessage {
|
||||
rich, err := tgrich.BuildHTML(blocks...)
|
||||
if err != nil {
|
||||
ctx.Logger.Errorln(err)
|
||||
return nil
|
||||
}
|
||||
return ctx.richAnswer(rich, keyboard)
|
||||
}
|
||||
|
||||
// RichAnswer builds and sends input rich-message blocks.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
func (ctx *MessageContext) RichAnswer(blocks ...tgapi.InputRichBlock) *AnswerMessage {
|
||||
return ctx.richBlocksAnswer(nil, blocks...)
|
||||
}
|
||||
|
||||
// RichAnswerKeyboard builds and sends input rich-message blocks with an inline keyboard.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
func (ctx *MessageContext) RichAnswerKeyboard(keyboard *InlineKeyboard, blocks ...tgapi.InputRichBlock) *AnswerMessage {
|
||||
return ctx.richBlocksAnswer(keyboard, blocks...)
|
||||
}
|
||||
|
||||
func (ctx *MessageContext) editRich(messageID int, keyboard *InlineKeyboard, blocks ...tgapi.InputRichBlock) *AnswerMessage {
|
||||
params, err := ctx.buildEditMessageTextParams(messageID, keyboard, "")
|
||||
if err != nil {
|
||||
ctx.Logger.Errorln(err)
|
||||
return nil
|
||||
}
|
||||
rich, err := tgrich.BuildHTML(blocks...)
|
||||
if err != nil {
|
||||
ctx.Logger.Errorln(err)
|
||||
return nil
|
||||
}
|
||||
params.RichMessage = &rich
|
||||
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, Text: rich.HTML, RichHTML: rich.HTML, IsMedia: false, ctx: ctx,
|
||||
}
|
||||
}
|
||||
func (ctx *MessageContext) editRichCallback(keyboard *InlineKeyboard, blocks ...tgapi.InputRichBlock) *AnswerMessage {
|
||||
if ctx.CallbackMsgID == 0 && ctx.InlineMsgID == "" {
|
||||
ctx.Logger.Errorln(ErrCallbackMessageMissing)
|
||||
return nil
|
||||
}
|
||||
return ctx.editRich(ctx.CallbackMsgID, keyboard, blocks...)
|
||||
}
|
||||
func (ctx *MessageContext) upsertRichKeyboard(keyboard *InlineKeyboard, blocks ...tgapi.InputRichBlock) *AnswerMessage {
|
||||
if ctx.IsCallback() {
|
||||
if ctx.HasPhoto() {
|
||||
rich, err := tgrich.BuildHTML(blocks...)
|
||||
if err != nil {
|
||||
ctx.Logger.Errorln(err)
|
||||
return nil
|
||||
}
|
||||
ctx.CallbackDelete()
|
||||
return ctx.richAnswer(rich, keyboard)
|
||||
}
|
||||
return ctx.editRichCallback(keyboard, blocks...)
|
||||
}
|
||||
return ctx.richBlocksAnswer(keyboard, blocks...)
|
||||
}
|
||||
|
||||
// EditCallbackRich builds rich blocks and replaces the callback message content and inline keyboard.
|
||||
// It doesn't upload local files referenced with attach://.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
func (ctx *MessageContext) EditCallbackRich(keyboard *InlineKeyboard, blocks ...tgapi.InputRichBlock) *AnswerMessage {
|
||||
return ctx.editRichCallback(keyboard, blocks...)
|
||||
}
|
||||
|
||||
// UpsertKeyboardRich builds rich blocks and either edits the callback message or sends a new message.
|
||||
// Photo callback messages are replaced because their text content can't be edited directly.
|
||||
// It doesn't upload local files referenced with attach://.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
func (ctx *MessageContext) UpsertKeyboardRich(keyboard *InlineKeyboard, blocks ...tgapi.InputRichBlock) *AnswerMessage {
|
||||
return ctx.upsertRichKeyboard(keyboard, blocks...)
|
||||
}
|
||||
|
||||
// EditRich builds rich blocks and replaces the message content without changing its inline keyboard.
|
||||
// It doesn't upload local files referenced with attach://.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
func (m *AnswerMessage) EditRich(blocks ...tgapi.InputRichBlock) *AnswerMessage {
|
||||
return m.ctx.editRich(m.MessageID, nil, blocks...)
|
||||
}
|
||||
|
||||
// EditRichKeyboard builds rich blocks and replaces the message content and inline keyboard.
|
||||
// It doesn't upload local files referenced with attach://.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
func (m *AnswerMessage) EditRichKeyboard(keyboard *InlineKeyboard, blocks ...tgapi.InputRichBlock) *AnswerMessage {
|
||||
return m.ctx.editRich(m.MessageID, keyboard, blocks...)
|
||||
}
|
||||
|
||||
+540
-41
@@ -10,9 +10,353 @@ import (
|
||||
"testing"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/slog"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgrich"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
func newMessageContextTestAPI(t *testing.T, transport roundTripFunc) *tgapi.API {
|
||||
t.Helper()
|
||||
api := tgapi.NewAPI(
|
||||
tgapi.NewAPIOpts("token").
|
||||
SetAPIURL("https://example.test").
|
||||
SetHTTPClient(&http.Client{Transport: transport}),
|
||||
)
|
||||
t.Cleanup(func() {
|
||||
if err := api.Close(); err != nil {
|
||||
t.Fatalf("Close returned error: %v", err)
|
||||
}
|
||||
})
|
||||
return api
|
||||
}
|
||||
|
||||
func readMessageContextRequest(t *testing.T, req *http.Request) map[string]any {
|
||||
t.Helper()
|
||||
body, err := io.ReadAll(req.Body)
|
||||
if err != nil {
|
||||
t.Fatalf("failed to read request body: %v", err)
|
||||
}
|
||||
var decoded map[string]any
|
||||
if err := json.Unmarshal(body, &decoded); err != nil {
|
||||
t.Fatalf("failed to decode request body: %v", err)
|
||||
}
|
||||
return decoded
|
||||
}
|
||||
|
||||
func messageContextResponse(result string) *http.Response {
|
||||
return &http.Response{
|
||||
StatusCode: http.StatusOK,
|
||||
Header: http.Header{"Content-Type": []string{"application/json"}},
|
||||
Body: io.NopCloser(strings.NewReader(`{"ok":true,"result":` + result + `}`)),
|
||||
}
|
||||
}
|
||||
|
||||
func TestMessageContextPropagatesBusinessConnection(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
wantMethod string
|
||||
result string
|
||||
invoke func(*MessageContext)
|
||||
}{
|
||||
{name: "send message", wantMethod: "sendMessage", result: `{"message_id":11,"date":1}`, invoke: func(ctx *MessageContext) { ctx.Answer("text") }},
|
||||
{name: "send photo", wantMethod: "sendPhoto", result: `{"message_id":11,"date":1}`, invoke: func(ctx *MessageContext) { ctx.AnswerPhoto("photo-id", "caption") }},
|
||||
{name: "edit caption", wantMethod: "editMessageCaption", result: `{"message_id":11,"date":1}`, invoke: func(ctx *MessageContext) { (&AnswerMessage{MessageID: 7, ctx: ctx}).EditCaption("caption") }},
|
||||
{name: "send action", wantMethod: "sendChatAction", result: `true`, invoke: func(ctx *MessageContext) { ctx.SendAction(tgapi.ChatActionTyping) }},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
var gotBody map[string]any
|
||||
api := newMessageContextTestAPI(t, roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||
if !strings.HasSuffix(req.URL.Path, "/"+tt.wantMethod) {
|
||||
t.Fatalf("request path = %q, want method %q", req.URL.Path, tt.wantMethod)
|
||||
}
|
||||
gotBody = readMessageContextRequest(t, req)
|
||||
return messageContextResponse(tt.result), nil
|
||||
}))
|
||||
ctx := &MessageContext{
|
||||
API: api,
|
||||
Msg: &tgapi.Message{
|
||||
BusinessConnectionID: "business-1",
|
||||
Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate},
|
||||
},
|
||||
Logger: sneklog.NewLogger(),
|
||||
}
|
||||
|
||||
tt.invoke(ctx)
|
||||
if got := gotBody["business_connection_id"]; got != "business-1" {
|
||||
t.Fatalf("business_connection_id = %v, want business-1", got)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestMessageContextHelpersRejectMissingChat(t *testing.T) {
|
||||
requests := 0
|
||||
api := newMessageContextTestAPI(t, roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||
requests++
|
||||
return nil, errors.New("unexpected request")
|
||||
}))
|
||||
ctx := &MessageContext{API: api, Msg: &tgapi.Message{}, CallbackMsgID: 7, Logger: sneklog.NewLogger()}
|
||||
|
||||
if answer := ctx.Answer("text"); answer != nil {
|
||||
t.Fatalf("Answer returned %#v for a message without a chat", answer)
|
||||
}
|
||||
if answer := ctx.EditCallback("text", nil); answer != nil {
|
||||
t.Fatalf("EditCallback returned %#v for a message without a chat", answer)
|
||||
}
|
||||
if requests != 0 {
|
||||
t.Fatalf("missing-chat helpers made %d requests", requests)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRichAnswerBuildsInputBlocks(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.Fatal(err)
|
||||
}
|
||||
if err := json.Unmarshal(body, &gotBody); err != nil {
|
||||
t.Fatal(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() { _ = api.Close() }()
|
||||
ctx := &MessageContext{
|
||||
API: api,
|
||||
Msg: &tgapi.Message{
|
||||
BusinessConnectionID: "business-1",
|
||||
Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate},
|
||||
},
|
||||
Logger: sneklog.NewLogger(),
|
||||
}
|
||||
|
||||
answer := ctx.RichAnswer(tgrich.P(tgrich.Bold(tgrich.Text("ready"))))
|
||||
if answer == nil {
|
||||
t.Fatal("RichAnswer() returned nil")
|
||||
}
|
||||
rich, ok := gotBody["rich_message"].(map[string]any)
|
||||
if !ok || rich["html"] != "<p><b>ready</b></p>" {
|
||||
t.Fatalf("rich_message = %#v", gotBody["rich_message"])
|
||||
}
|
||||
if _, exists := rich["skip_entity_detection"]; exists {
|
||||
t.Fatalf("rich_message unexpectedly disables entity detection: %#v", rich)
|
||||
}
|
||||
if got := gotBody["business_connection_id"]; got != "business-1" {
|
||||
t.Fatalf("business_connection_id = %v, want business-1", got)
|
||||
}
|
||||
if answer.Text != "<p><b>ready</b></p>" || answer.RichHTML != answer.Text {
|
||||
t.Fatalf("unexpected answer content: Text=%q RichHTML=%q", answer.Text, answer.RichHTML)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRichAnswerRejectsInvalidBlocksWithoutRequest(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() { _ = api.Close() }()
|
||||
ctx := &MessageContext{
|
||||
API: api,
|
||||
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate}},
|
||||
Logger: sneklog.NewLogger(),
|
||||
}
|
||||
|
||||
if answer := ctx.RichAnswer(tgrich.H(tgrich.Text("invalid"), 0)); answer != nil {
|
||||
t.Fatal("RichAnswer() returned an answer for an invalid heading")
|
||||
}
|
||||
}
|
||||
|
||||
func TestAnswerMessageEditRich(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
withKeyboard bool
|
||||
}{
|
||||
{name: "content only"},
|
||||
{name: "content and keyboard", withKeyboard: true},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
var gotPath string
|
||||
var gotBody map[string]any
|
||||
api := newMessageContextTestAPI(t, roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||
gotPath = req.URL.Path
|
||||
gotBody = readMessageContextRequest(t, req)
|
||||
return messageContextResponse(`{"message_id":11,"date":1}`), nil
|
||||
}))
|
||||
ctx := &MessageContext{
|
||||
API: api,
|
||||
Msg: &tgapi.Message{
|
||||
BusinessConnectionID: "business-1",
|
||||
Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate},
|
||||
},
|
||||
Logger: sneklog.NewLogger(),
|
||||
}
|
||||
original := &AnswerMessage{MessageID: 7, ctx: ctx}
|
||||
block := tgrich.P(tgrich.Bold(tgrich.Text("updated")))
|
||||
|
||||
var answer *AnswerMessage
|
||||
if tt.withKeyboard {
|
||||
kb := NewInlineKeyboardJSON(1).AddCallbackButton("A", "cmd")
|
||||
answer = original.EditRichKeyboard(kb, block)
|
||||
} else {
|
||||
answer = original.EditRich(block)
|
||||
}
|
||||
|
||||
if answer == nil {
|
||||
t.Fatal("rich edit returned nil")
|
||||
}
|
||||
if gotPath != "/bottoken/editMessageText" {
|
||||
t.Fatalf("unexpected request path: %s", gotPath)
|
||||
}
|
||||
if got := gotBody["chat_id"]; got != float64(42) {
|
||||
t.Fatalf("chat_id = %v, want 42", got)
|
||||
}
|
||||
if got := gotBody["message_id"]; got != float64(7) {
|
||||
t.Fatalf("message_id = %v, want 7", got)
|
||||
}
|
||||
if got := gotBody["business_connection_id"]; got != "business-1" {
|
||||
t.Fatalf("business_connection_id = %v, want business-1", got)
|
||||
}
|
||||
rich, ok := gotBody["rich_message"].(map[string]any)
|
||||
if !ok || rich["html"] != "<p><b>updated</b></p>" {
|
||||
t.Fatalf("rich_message = %#v", gotBody["rich_message"])
|
||||
}
|
||||
if _, exists := gotBody["text"]; exists {
|
||||
t.Fatalf("edit request unexpectedly contains text: %#v", gotBody)
|
||||
}
|
||||
_, hasKeyboard := gotBody["reply_markup"]
|
||||
if hasKeyboard != tt.withKeyboard {
|
||||
t.Fatalf("reply_markup presence = %v, want %v", hasKeyboard, tt.withKeyboard)
|
||||
}
|
||||
if answer.MessageID != 11 || answer.Text != "<p><b>updated</b></p>" || answer.RichHTML != answer.Text {
|
||||
t.Fatalf("unexpected answer: %#v", answer)
|
||||
}
|
||||
if answer.ctx != ctx {
|
||||
t.Fatal("edited answer lost its message context")
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestEditCallbackRichEditsInlineMessage(t *testing.T) {
|
||||
var gotBody map[string]any
|
||||
api := newMessageContextTestAPI(t, roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||
gotBody = readMessageContextRequest(t, req)
|
||||
return messageContextResponse("true"), nil
|
||||
}))
|
||||
ctx := &MessageContext{
|
||||
API: api,
|
||||
InlineMsgID: "inline-1",
|
||||
Logger: sneklog.NewLogger(),
|
||||
}
|
||||
kb := NewInlineKeyboardJSON(1).AddCallbackButton("A", "cmd")
|
||||
|
||||
answer := ctx.EditCallbackRich(kb, tgrich.P(tgrich.Text("inline")))
|
||||
if answer == nil {
|
||||
t.Fatal("EditCallbackRich returned nil")
|
||||
}
|
||||
if got := gotBody["inline_message_id"]; got != "inline-1" {
|
||||
t.Fatalf("inline_message_id = %v, want inline-1", got)
|
||||
}
|
||||
if _, exists := gotBody["chat_id"]; exists {
|
||||
t.Fatalf("inline edit unexpectedly contains chat_id: %#v", gotBody)
|
||||
}
|
||||
if _, exists := gotBody["business_connection_id"]; exists {
|
||||
t.Fatalf("inline edit unexpectedly contains business_connection_id: %#v", gotBody)
|
||||
}
|
||||
rich, ok := gotBody["rich_message"].(map[string]any)
|
||||
if !ok || rich["html"] != "<p>inline</p>" {
|
||||
t.Fatalf("rich_message = %#v", gotBody["rich_message"])
|
||||
}
|
||||
if _, exists := gotBody["reply_markup"]; !exists {
|
||||
t.Fatal("inline rich edit has no reply_markup")
|
||||
}
|
||||
if answer.MessageID != 0 || answer.Text != "<p>inline</p>" || answer.RichHTML != answer.Text {
|
||||
t.Fatalf("unexpected inline answer: %#v", answer)
|
||||
}
|
||||
}
|
||||
|
||||
func TestUpsertKeyboardRichValidatesPhotoBeforeDelete(t *testing.T) {
|
||||
requests := 0
|
||||
api := newMessageContextTestAPI(t, roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||
requests++
|
||||
t.Fatalf("unexpected request to %s", req.URL.Path)
|
||||
return nil, nil
|
||||
}))
|
||||
ctx := &MessageContext{
|
||||
API: api,
|
||||
CallbackMsgID: 7,
|
||||
Msg: &tgapi.Message{
|
||||
Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate},
|
||||
Photo: []tgapi.PhotoSize{{FileID: "photo-1"}},
|
||||
},
|
||||
Logger: sneklog.NewLogger(),
|
||||
}
|
||||
|
||||
answer := ctx.UpsertKeyboardRich(nil, tgrich.H(tgrich.Text("invalid"), 0))
|
||||
if answer != nil {
|
||||
t.Fatalf("UpsertKeyboardRich returned an answer for invalid blocks: %#v", answer)
|
||||
}
|
||||
if requests != 0 {
|
||||
t.Fatalf("invalid photo upsert made %d requests", requests)
|
||||
}
|
||||
}
|
||||
|
||||
func TestUpsertKeyboardRichReplacesPhotoCallback(t *testing.T) {
|
||||
var paths []string
|
||||
var sendBody map[string]any
|
||||
api := newMessageContextTestAPI(t, roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||
paths = append(paths, req.URL.Path)
|
||||
switch req.URL.Path {
|
||||
case "/bottoken/deleteMessage":
|
||||
return messageContextResponse("true"), nil
|
||||
case "/bottoken/sendRichMessage":
|
||||
sendBody = readMessageContextRequest(t, req)
|
||||
return messageContextResponse(`{"message_id":12,"date":1}`), nil
|
||||
default:
|
||||
t.Fatalf("unexpected request path: %s", req.URL.Path)
|
||||
return nil, nil
|
||||
}
|
||||
}))
|
||||
ctx := &MessageContext{
|
||||
API: api,
|
||||
CallbackMsgID: 7,
|
||||
Msg: &tgapi.Message{
|
||||
Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate},
|
||||
Photo: []tgapi.PhotoSize{{FileID: "photo-1"}},
|
||||
},
|
||||
Logger: sneklog.NewLogger(),
|
||||
}
|
||||
kb := NewInlineKeyboardJSON(1).AddCallbackButton("A", "cmd")
|
||||
|
||||
answer := ctx.UpsertKeyboardRich(kb, tgrich.P(tgrich.Text("replacement")))
|
||||
if answer == nil {
|
||||
t.Fatal("UpsertKeyboardRich returned nil")
|
||||
}
|
||||
wantPaths := []string{"/bottoken/deleteMessage", "/bottoken/sendRichMessage"}
|
||||
if !reflect.DeepEqual(paths, wantPaths) {
|
||||
t.Fatalf("request paths = %#v, want %#v", paths, wantPaths)
|
||||
}
|
||||
rich, ok := sendBody["rich_message"].(map[string]any)
|
||||
if !ok || rich["html"] != "<p>replacement</p>" {
|
||||
t.Fatalf("rich_message = %#v", sendBody["rich_message"])
|
||||
}
|
||||
if _, exists := sendBody["reply_markup"]; !exists {
|
||||
t.Fatal("replacement rich message has no reply_markup")
|
||||
}
|
||||
if answer.MessageID != 12 || answer.Text != "<p>replacement</p>" || answer.RichHTML != answer.Text {
|
||||
t.Fatalf("unexpected replacement answer: %#v", answer)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAnswerPhotoIncludesDirectMessagesTopicID(t *testing.T) {
|
||||
var gotBody map[string]any
|
||||
|
||||
@@ -35,7 +379,7 @@ func TestAnswerPhotoIncludesDirectMessagesTopicID(t *testing.T) {
|
||||
|
||||
api := tgapi.NewAPI(
|
||||
tgapi.NewAPIOpts("token").
|
||||
SetAPIUrl("https://example.test").
|
||||
SetAPIURL("https://example.test").
|
||||
SetHTTPClient(client),
|
||||
)
|
||||
defer func() {
|
||||
@@ -44,18 +388,19 @@ func TestAnswerPhotoIncludesDirectMessagesTopicID(t *testing.T) {
|
||||
}
|
||||
}()
|
||||
|
||||
ctx := &MsgContext{
|
||||
Api: api,
|
||||
ctx := &MessageContext{
|
||||
API: api,
|
||||
Msg: &tgapi.Message{
|
||||
Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate},
|
||||
DirectMessageTopic: &tgapi.DirectMessageTopic{TopicID: 77},
|
||||
},
|
||||
Logger: slog.CreateLogger(),
|
||||
Logger: sneklog.NewLogger(),
|
||||
}
|
||||
|
||||
answer := ctx.AnswerPhoto("photo-id", "caption")
|
||||
if answer == nil {
|
||||
t.Fatal("expected answer message")
|
||||
return
|
||||
}
|
||||
if answer.MessageID != 9 {
|
||||
t.Fatalf("unexpected message id: %d", answer.MessageID)
|
||||
@@ -73,7 +418,7 @@ func TestBindArgsBindsScalarFields(t *testing.T) {
|
||||
Name string
|
||||
}
|
||||
|
||||
ctx := &MsgContext{Args: []string{"42", "true", "3.5", "Ada", "Lovelace"}}
|
||||
ctx := &MessageContext{Args: []string{"42", "true", "3.5", "Ada", "Lovelace"}}
|
||||
var got input
|
||||
|
||||
if err := ctx.BindArgs(&got); err != nil {
|
||||
@@ -91,6 +436,23 @@ func TestBindArgsBindsScalarFields(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestNewInlineKeyboardButtonUsesContextPayloadType(t *testing.T) {
|
||||
ctx := &MessageContext{payloadType: BotPayloadBase64}
|
||||
|
||||
kb := NewInlineKeyboardJSON(1).
|
||||
AddButton(ctx.NewInlineKeyboardButton("A").SetCallbackData("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 TestBindArgsLeavesTrailingFieldsZeroWhenArgsRunOut(t *testing.T) {
|
||||
type input struct {
|
||||
ID int
|
||||
@@ -98,7 +460,7 @@ func TestBindArgsLeavesTrailingFieldsZeroWhenArgsRunOut(t *testing.T) {
|
||||
Admin bool
|
||||
}
|
||||
|
||||
ctx := &MsgContext{Args: []string{"7"}}
|
||||
ctx := &MessageContext{Args: []string{"7"}}
|
||||
var got input
|
||||
|
||||
if err := ctx.BindArgs(&got); err != nil {
|
||||
@@ -117,7 +479,7 @@ func TestBindArgsLeavesTrailingFieldsZeroWhenArgsRunOut(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestBindArgsRejectsInvalidTargets(t *testing.T) {
|
||||
ctx := &MsgContext{Args: []string{"1"}}
|
||||
ctx := &MessageContext{Args: []string{"1"}}
|
||||
|
||||
if err := ctx.BindArgs(nil); !errors.Is(err, ErrBindArgsTargetNotPointer) {
|
||||
t.Fatalf("expected ErrBindArgsTargetNotPointer for nil target, got %v", err)
|
||||
@@ -134,7 +496,7 @@ func TestBindArgsReportsConversionFailures(t *testing.T) {
|
||||
ID int
|
||||
}
|
||||
|
||||
ctx := &MsgContext{Args: []string{"oops"}}
|
||||
ctx := &MessageContext{Args: []string{"oops"}}
|
||||
var got input
|
||||
|
||||
err := ctx.BindArgs(&got)
|
||||
@@ -149,12 +511,35 @@ func TestBindArgsReportsConversionFailures(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestBindArgsRejectsNumericOverflow(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
arg string
|
||||
dst any
|
||||
}{
|
||||
{name: "int8 positive", arg: "128", dst: &struct{ Value int8 }{}},
|
||||
{name: "int8 negative", arg: "-129", dst: &struct{ Value int8 }{}},
|
||||
{name: "uint8 positive", arg: "256", dst: &struct{ Value uint8 }{}},
|
||||
{name: "uint8 negative", arg: "-1", dst: &struct{ Value uint8 }{}},
|
||||
{name: "float32", arg: "3.5e39", dst: &struct{ Value float32 }{}},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
ctx := &MessageContext{Args: []string{tt.arg}}
|
||||
if err := ctx.BindArgs(tt.dst); !errors.Is(err, ErrBindArgsConversion) {
|
||||
t.Fatalf("expected ErrBindArgsConversion, got %v", err)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestBindArgsRejectsUnsupportedFieldTypes(t *testing.T) {
|
||||
type input struct {
|
||||
Tags []string
|
||||
}
|
||||
|
||||
ctx := &MsgContext{Args: []string{"tag"}}
|
||||
ctx := &MessageContext{Args: []string{"tag"}}
|
||||
var got input
|
||||
|
||||
err := ctx.BindArgs(&got)
|
||||
@@ -166,7 +551,37 @@ func TestBindArgsRejectsUnsupportedFieldTypes(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestErrorDefaultRemainsUserVisibleForMessageFlow(t *testing.T) {
|
||||
func TestErrorDefaultStaysInternalForMessageFlow(t *testing.T) {
|
||||
client := &http.Client{
|
||||
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||
t.Fatal("unexpected HTTP request for unclassified 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 := &MessageContext{
|
||||
API: api,
|
||||
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate}},
|
||||
Logger: sneklog.NewLogger(),
|
||||
errorTemplate: "Error: %s",
|
||||
}
|
||||
|
||||
// Unclassified errors must not leak to the user. Only AsUserError replies.
|
||||
ctx.error(errors.New("boom"))
|
||||
}
|
||||
|
||||
func TestErrorUserVisibleAnswersForMessageFlow(t *testing.T) {
|
||||
var requests int
|
||||
var gotBody map[string]any
|
||||
|
||||
@@ -190,7 +605,7 @@ func TestErrorDefaultRemainsUserVisibleForMessageFlow(t *testing.T) {
|
||||
|
||||
api := tgapi.NewAPI(
|
||||
tgapi.NewAPIOpts("token").
|
||||
SetAPIUrl("https://example.test").
|
||||
SetAPIURL("https://example.test").
|
||||
SetHTTPClient(client),
|
||||
)
|
||||
defer func() {
|
||||
@@ -199,14 +614,14 @@ func TestErrorDefaultRemainsUserVisibleForMessageFlow(t *testing.T) {
|
||||
}
|
||||
}()
|
||||
|
||||
ctx := &MsgContext{
|
||||
Api: api,
|
||||
ctx := &MessageContext{
|
||||
API: api,
|
||||
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate}},
|
||||
Logger: slog.CreateLogger(),
|
||||
Logger: sneklog.NewLogger(),
|
||||
errorTemplate: "Error: %s",
|
||||
}
|
||||
|
||||
ctx.error(errors.New("boom"))
|
||||
ctx.error(AsUserError(errors.New("boom")))
|
||||
|
||||
if requests != 1 {
|
||||
t.Fatalf("expected one user-facing error reply, got %d requests", requests)
|
||||
@@ -226,7 +641,7 @@ func TestErrorInternalSkipsUserReplyForMessageFlow(t *testing.T) {
|
||||
|
||||
api := tgapi.NewAPI(
|
||||
tgapi.NewAPIOpts("token").
|
||||
SetAPIUrl("https://example.test").
|
||||
SetAPIURL("https://example.test").
|
||||
SetHTTPClient(client),
|
||||
)
|
||||
defer func() {
|
||||
@@ -235,10 +650,10 @@ func TestErrorInternalSkipsUserReplyForMessageFlow(t *testing.T) {
|
||||
}
|
||||
}()
|
||||
|
||||
ctx := &MsgContext{
|
||||
Api: api,
|
||||
ctx := &MessageContext{
|
||||
API: api,
|
||||
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate}},
|
||||
Logger: slog.CreateLogger(),
|
||||
Logger: sneklog.NewLogger(),
|
||||
errorTemplate: "Error: %s",
|
||||
}
|
||||
|
||||
@@ -255,7 +670,7 @@ func TestErrorInternalSkipsCallbackAnswer(t *testing.T) {
|
||||
|
||||
api := tgapi.NewAPI(
|
||||
tgapi.NewAPIOpts("token").
|
||||
SetAPIUrl("https://example.test").
|
||||
SetAPIURL("https://example.test").
|
||||
SetHTTPClient(client),
|
||||
)
|
||||
defer func() {
|
||||
@@ -264,11 +679,11 @@ func TestErrorInternalSkipsCallbackAnswer(t *testing.T) {
|
||||
}
|
||||
}()
|
||||
|
||||
ctx := &MsgContext{
|
||||
Api: api,
|
||||
Logger: slog.CreateLogger(),
|
||||
ctx := &MessageContext{
|
||||
API: api,
|
||||
Logger: sneklog.NewLogger(),
|
||||
errorTemplate: "%s",
|
||||
CallbackQueryId: "cb-1",
|
||||
CallbackQueryID: "cb-1",
|
||||
}
|
||||
|
||||
ctx.error(AsInternalError(errors.New("boom")))
|
||||
@@ -298,7 +713,7 @@ func TestErrorUserVisibleAnswersCallback(t *testing.T) {
|
||||
|
||||
api := tgapi.NewAPI(
|
||||
tgapi.NewAPIOpts("token").
|
||||
SetAPIUrl("https://example.test").
|
||||
SetAPIURL("https://example.test").
|
||||
SetHTTPClient(client),
|
||||
)
|
||||
defer func() {
|
||||
@@ -307,11 +722,11 @@ func TestErrorUserVisibleAnswersCallback(t *testing.T) {
|
||||
}
|
||||
}()
|
||||
|
||||
ctx := &MsgContext{
|
||||
Api: api,
|
||||
Logger: slog.CreateLogger(),
|
||||
ctx := &MessageContext{
|
||||
API: api,
|
||||
Logger: sneklog.NewLogger(),
|
||||
errorTemplate: "Oops: %s",
|
||||
CallbackQueryId: "cb-1",
|
||||
CallbackQueryID: "cb-1",
|
||||
}
|
||||
|
||||
ctx.error(AsUserError(errors.New("boom")))
|
||||
@@ -324,10 +739,94 @@ func TestErrorUserVisibleAnswersCallback(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestIsCallbackIncludesInlineCallbackTargets(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
ctx MessageContext
|
||||
want bool
|
||||
}{
|
||||
{name: "callback query id", ctx: MessageContext{CallbackQueryID: "cb-1"}, want: true},
|
||||
{name: "callback message id", ctx: MessageContext{CallbackMsgID: 12}, want: true},
|
||||
{name: "inline message id", ctx: MessageContext{InlineMsgID: "inline-1"}, want: true},
|
||||
{name: "not callback", ctx: MessageContext{}, want: false},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
if got := tt.ctx.IsCallback(); got != tt.want {
|
||||
t.Fatalf("IsCallback() = %v, want %v", got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestUpsertKeyboardEditsInlineCallback(t *testing.T) {
|
||||
var requests int
|
||||
var gotPath string
|
||||
var gotBody map[string]any
|
||||
|
||||
client := &http.Client{
|
||||
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||
requests++
|
||||
gotPath = req.URL.Path
|
||||
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 := &MessageContext{
|
||||
API: api,
|
||||
InlineMsgID: "inline-1",
|
||||
Logger: sneklog.NewLogger(),
|
||||
}
|
||||
kb := NewInlineKeyboardJSON(1).AddCallbackButton("A", "cmd")
|
||||
|
||||
answer := ctx.UpsertKeyboard("updated", kb)
|
||||
if answer == nil {
|
||||
t.Fatal("expected answer message")
|
||||
}
|
||||
if requests != 1 {
|
||||
t.Fatalf("expected one edit request, got %d", requests)
|
||||
}
|
||||
if gotPath != "/bottoken/editMessageText" {
|
||||
t.Fatalf("unexpected request path: %s", gotPath)
|
||||
}
|
||||
if got := gotBody["inline_message_id"]; got != "inline-1" {
|
||||
t.Fatalf("unexpected inline_message_id: %v", got)
|
||||
}
|
||||
if got := gotBody["text"]; got != "updated" {
|
||||
t.Fatalf("unexpected text: %v", got)
|
||||
}
|
||||
if _, ok := gotBody["reply_markup"]; !ok {
|
||||
t.Fatal("expected reply_markup in edit request")
|
||||
}
|
||||
}
|
||||
|
||||
func TestAnswerRejectsEmptyMessage(t *testing.T) {
|
||||
ctx := &MsgContext{
|
||||
ctx := &MessageContext{
|
||||
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate}},
|
||||
Logger: slog.CreateLogger(),
|
||||
Logger: sneklog.NewLogger(),
|
||||
}
|
||||
|
||||
if answer := ctx.Answer(""); answer != nil {
|
||||
@@ -345,7 +844,7 @@ func TestAnswerRejectsLongMessageWithoutSendingRequest(t *testing.T) {
|
||||
|
||||
api := tgapi.NewAPI(
|
||||
tgapi.NewAPIOpts("token").
|
||||
SetAPIUrl("https://example.test").
|
||||
SetAPIURL("https://example.test").
|
||||
SetHTTPClient(client),
|
||||
)
|
||||
defer func() {
|
||||
@@ -354,10 +853,10 @@ func TestAnswerRejectsLongMessageWithoutSendingRequest(t *testing.T) {
|
||||
}
|
||||
}()
|
||||
|
||||
ctx := &MsgContext{
|
||||
Api: api,
|
||||
ctx := &MessageContext{
|
||||
API: api,
|
||||
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate}},
|
||||
Logger: slog.CreateLogger(),
|
||||
Logger: sneklog.NewLogger(),
|
||||
}
|
||||
|
||||
if answer := ctx.Answer(strings.Repeat("a", maxMessageTextLen+1)); answer != nil {
|
||||
@@ -429,7 +928,7 @@ func TestAnswerLongSplitsRequestsAndAttachesKeyboardToLastChunk(t *testing.T) {
|
||||
|
||||
api := tgapi.NewAPI(
|
||||
tgapi.NewAPIOpts("token").
|
||||
SetAPIUrl("https://example.test").
|
||||
SetAPIURL("https://example.test").
|
||||
SetHTTPClient(client),
|
||||
)
|
||||
defer func() {
|
||||
@@ -438,12 +937,12 @@ func TestAnswerLongSplitsRequestsAndAttachesKeyboardToLastChunk(t *testing.T) {
|
||||
}
|
||||
}()
|
||||
|
||||
ctx := &MsgContext{
|
||||
Api: api,
|
||||
ctx := &MessageContext{
|
||||
API: api,
|
||||
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate}},
|
||||
Logger: slog.CreateLogger(),
|
||||
Logger: sneklog.NewLogger(),
|
||||
}
|
||||
kb := NewInlineKeyboardJson(1).AddCallbackButton("A", "cmd")
|
||||
kb := NewInlineKeyboardJSON(1).AddCallbackButton("A", "cmd")
|
||||
text := strings.Repeat("a", maxMessageTextLen) + " " + strings.Repeat("b", 32)
|
||||
|
||||
messages := ctx.KeyboardLong(text, kb)
|
||||
|
||||
+21
-11
@@ -1,13 +1,15 @@
|
||||
package laniakea
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"strings"
|
||||
"time"
|
||||
"unicode"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
)
|
||||
|
||||
func (bot *Bot[T]) handleMessage(update *tgapi.Update, ctx *MsgContext) bool {
|
||||
func (bot *Bot[T]) handleMessage(update *tgapi.Update, ctx *MessageContext) bool {
|
||||
text, ok := messageText(update)
|
||||
if !ok {
|
||||
return false
|
||||
@@ -21,19 +23,21 @@ func (bot *Bot[T]) handleMessage(update *tgapi.Update, ctx *MsgContext) bool {
|
||||
|
||||
if strings.Contains(cmd, "@") {
|
||||
botUsername := bot.username
|
||||
if botUsername != "" && strings.HasSuffix(cmd, "@"+botUsername) {
|
||||
cmd = cmd[:len(cmd)-len("@"+botUsername)] // убираем @botname
|
||||
at := strings.LastIndexByte(cmd, '@')
|
||||
if at > 0 && botUsername != "" && strings.EqualFold(cmd[at+1:], botUsername) {
|
||||
cmd = cmd[:at] // remove @botname
|
||||
}
|
||||
}
|
||||
// Ищем команду по точному совпадению
|
||||
|
||||
for _, plugin := range bot.plugins {
|
||||
if _, exists := plugin.commands[cmd]; exists {
|
||||
|
||||
ctx.Text = args
|
||||
ctx.Args = strings.Fields(args) // Убирает лишние пробелы
|
||||
ctx.Args = strings.Fields(args)
|
||||
ctx.Logger = plugin.logger
|
||||
|
||||
if plugin.logger != nil {
|
||||
ctx.Logger = plugin.logger
|
||||
if ctx.Logger == nil {
|
||||
ctx.Logger = bot.logger
|
||||
}
|
||||
if !plugin.executeMiddlewares(ctx, bot.appData) {
|
||||
return false
|
||||
@@ -51,6 +55,9 @@ func (bot *Bot[T]) handleMessage(update *tgapi.Update, ctx *MsgContext) bool {
|
||||
})
|
||||
|
||||
err := plugin.executeCmd(cmd, ctx, bot.appData)
|
||||
if errors.Is(err, errMiddlewareBlocked) {
|
||||
err = nil
|
||||
}
|
||||
handlerEndEvent := HandlerFinishedEvent{
|
||||
UpdateID: update.UpdateID,
|
||||
UpdateType: update.Type,
|
||||
@@ -90,7 +97,7 @@ func (bot *Bot[T]) handleMessage(update *tgapi.Update, ctx *MsgContext) bool {
|
||||
return bot.handleFallback(update, ctx)
|
||||
}
|
||||
|
||||
func (bot *Bot[T]) handleFallback(update *tgapi.Update, ctx *MsgContext) bool {
|
||||
func (bot *Bot[T]) handleFallback(update *tgapi.Update, ctx *MessageContext) bool {
|
||||
text, ok := messageText(update)
|
||||
if !ok {
|
||||
return false
|
||||
@@ -124,7 +131,7 @@ func (bot *Bot[T]) handleFallback(update *tgapi.Update, ctx *MsgContext) bool {
|
||||
FromID: pluginCtx.FromID,
|
||||
ChatID: pluginCtx.ChatID,
|
||||
})
|
||||
err := plugin.messageFallback(pluginCtx, bot.appData)
|
||||
err := callCommandExecutor(plugin.messageFallback, pluginCtx, bot.appData)
|
||||
endEvent := HandlerFinishedEvent{
|
||||
UpdateID: update.UpdateID,
|
||||
UpdateType: update.Type,
|
||||
@@ -180,7 +187,7 @@ func messageText(update *tgapi.Update) (string, bool) {
|
||||
return text, true
|
||||
}
|
||||
|
||||
func (bot *Bot[T]) handleCallback(update *tgapi.Update, ctx *MsgContext) bool {
|
||||
func (bot *Bot[T]) handleCallback(update *tgapi.Update, ctx *MessageContext) bool {
|
||||
data, err := bot.decodePayload(update.CallbackQuery.Data)
|
||||
if err != nil {
|
||||
bot.logger.Errorln(err)
|
||||
@@ -226,6 +233,9 @@ func (bot *Bot[T]) handleCallback(update *tgapi.Update, ctx *MsgContext) bool {
|
||||
ChatID: ctx.ChatID,
|
||||
})
|
||||
err := plugin.executePayload(data.Command, ctx, bot.appData)
|
||||
if errors.Is(err, errMiddlewareBlocked) {
|
||||
err = nil
|
||||
}
|
||||
|
||||
endEvent := HandlerFinishedEvent{
|
||||
UpdateID: update.UpdateID,
|
||||
@@ -281,7 +291,7 @@ func (bot *Bot[T]) checkPrefixes(text string) (string, bool) {
|
||||
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, " ")
|
||||
spaceIndex := strings.IndexFunc(text, unicode.IsSpace)
|
||||
var cmd string
|
||||
var args string
|
||||
if spaceIndex == -1 {
|
||||
|
||||
+155
-53
@@ -16,6 +16,8 @@ const (
|
||||
HandlerCommandKind HandlerEventKind = "command"
|
||||
// HandlerMessageKind identifies a message fallback handler.
|
||||
HandlerMessageKind HandlerEventKind = "message"
|
||||
// HandlerMiddlewareKind identifies middleware execution.
|
||||
HandlerMiddlewareKind HandlerEventKind = "middleware"
|
||||
// HandlerPayloadKind identifies a callback payload handler.
|
||||
HandlerPayloadKind HandlerEventKind = "payload"
|
||||
// HandlerUpdateKind identifies a generic update handler.
|
||||
@@ -30,6 +32,8 @@ const (
|
||||
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"
|
||||
)
|
||||
@@ -39,96 +43,174 @@ type Event interface {
|
||||
isEvent()
|
||||
}
|
||||
|
||||
func emitContextError(ctx *MessageContext, event ErrorEvent) {
|
||||
if ctx == nil {
|
||||
return
|
||||
}
|
||||
if ctx.Logger != nil {
|
||||
ctx.Logger.Errorln(event.Err)
|
||||
}
|
||||
if ctx.eventEmitter != nil {
|
||||
ctx.eventEmitter(ctx.Context(), event)
|
||||
return
|
||||
}
|
||||
if ctx.observer == nil {
|
||||
return
|
||||
}
|
||||
defer func() {
|
||||
if recovered := recover(); recovered != nil && ctx.Logger != nil {
|
||||
ctx.Logger.Errorln(fmt.Sprintf("panic in observer: %v", recovered))
|
||||
}
|
||||
}()
|
||||
ctx.observer.OnError(ctx.Context(), event)
|
||||
}
|
||||
|
||||
// UpdateReceivedEvent describes an update entering the bot runtime.
|
||||
type UpdateReceivedEvent struct {
|
||||
UpdateID int
|
||||
// UpdateID identifies the Telegram update.
|
||||
UpdateID int
|
||||
// UpdateType identifies the normalized update kind.
|
||||
UpdateType tgapi.UpdateType
|
||||
FromID int64
|
||||
ChatID int64
|
||||
// FromID identifies the originating user when available.
|
||||
FromID int64
|
||||
// ChatID identifies the originating chat when available.
|
||||
ChatID int64
|
||||
}
|
||||
|
||||
// UpdateHandledEvent describes a completed update execution path.
|
||||
type UpdateHandledEvent struct {
|
||||
UpdateID int
|
||||
// UpdateID identifies the Telegram update.
|
||||
UpdateID int
|
||||
// UpdateType identifies the normalized update kind.
|
||||
UpdateType tgapi.UpdateType
|
||||
FromID int64
|
||||
ChatID int64
|
||||
Duration time.Duration
|
||||
Handled bool
|
||||
// FromID identifies the originating user when available.
|
||||
FromID int64
|
||||
// ChatID identifies the originating chat when available.
|
||||
ChatID int64
|
||||
// Duration is the total framework handling time.
|
||||
Duration time.Duration
|
||||
// Handled reports whether a registered path handled the update.
|
||||
Handled bool
|
||||
}
|
||||
|
||||
// HandlerStartedEvent describes a handler about to execute.
|
||||
type HandlerStartedEvent struct {
|
||||
UpdateID int
|
||||
UpdateType tgapi.UpdateType
|
||||
Plugin string
|
||||
// UpdateID identifies the Telegram update.
|
||||
UpdateID int
|
||||
// UpdateType identifies the normalized update kind.
|
||||
UpdateType tgapi.UpdateType
|
||||
// Plugin names the plugin that owns the handler.
|
||||
Plugin string
|
||||
// HandlerKind classifies the handler.
|
||||
HandlerKind HandlerEventKind
|
||||
// HandlerName identifies the handler within its plugin and kind.
|
||||
HandlerName string
|
||||
FromID int64
|
||||
ChatID int64
|
||||
// FromID identifies the originating user when available.
|
||||
FromID int64
|
||||
// ChatID identifies the originating chat when available.
|
||||
ChatID int64
|
||||
}
|
||||
|
||||
// HandlerFinishedEvent describes a handler that has completed.
|
||||
type HandlerFinishedEvent struct {
|
||||
UpdateID int
|
||||
UpdateType tgapi.UpdateType
|
||||
Plugin string
|
||||
// UpdateID identifies the Telegram update.
|
||||
UpdateID int
|
||||
// UpdateType identifies the normalized update kind.
|
||||
UpdateType tgapi.UpdateType
|
||||
// Plugin names the plugin that owns the handler.
|
||||
Plugin string
|
||||
// HandlerKind classifies the handler.
|
||||
HandlerKind HandlerEventKind
|
||||
// HandlerName identifies the handler within its plugin and kind.
|
||||
HandlerName string
|
||||
FromID int64
|
||||
ChatID int64
|
||||
Duration time.Duration
|
||||
Err error
|
||||
UserFacing bool
|
||||
// FromID identifies the originating user when available.
|
||||
FromID int64
|
||||
// ChatID identifies the originating chat when available.
|
||||
ChatID int64
|
||||
// Duration is the handler execution time.
|
||||
Duration time.Duration
|
||||
// Err is the error returned or recovered from the handler.
|
||||
Err error
|
||||
// UserFacing reports whether Err is safe to show to the user.
|
||||
UserFacing bool
|
||||
}
|
||||
|
||||
// SceneTransitionEvent describes a scene state transition.
|
||||
type SceneTransitionEvent struct {
|
||||
// Plugin names the plugin that owns the scene.
|
||||
Plugin string
|
||||
Scene string
|
||||
From string
|
||||
To string
|
||||
// Scene names the transitioning scene.
|
||||
Scene string
|
||||
// From is the previous scene step.
|
||||
From string
|
||||
// To is the resulting scene step.
|
||||
To string
|
||||
// Action identifies the requested state transition.
|
||||
Action SceneAction
|
||||
// FromID identifies the session user when available.
|
||||
FromID int64
|
||||
// ChatID identifies the session chat when available.
|
||||
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
|
||||
// Name identifies the evaluated policy.
|
||||
Name string
|
||||
// Plugin names the plugin that requested the policy check.
|
||||
Plugin string
|
||||
// FromID identifies the evaluated user when available.
|
||||
FromID int64
|
||||
// ChatID identifies the evaluated chat when available.
|
||||
ChatID int64
|
||||
// Passed reports whether the policy accepted the context.
|
||||
Passed bool
|
||||
// Err is the policy evaluation error, if any.
|
||||
Err error
|
||||
// Internal reports whether evaluation failed internally rather than denying access.
|
||||
Internal bool
|
||||
}
|
||||
|
||||
// RunnerFinishedEvent describes a completed background runner execution.
|
||||
type RunnerFinishedEvent struct {
|
||||
Name string
|
||||
// Name identifies the runner.
|
||||
Name string
|
||||
// Duration is the callback execution time.
|
||||
Duration time.Duration
|
||||
Err error
|
||||
// Err is the callback error or recovered panic.
|
||||
Err error
|
||||
}
|
||||
|
||||
// PollingRetryEvent describes a polling retry after a failed getUpdates call.
|
||||
type PollingRetryEvent struct {
|
||||
// Attempt is the one-based retry number.
|
||||
Attempt int
|
||||
Delay time.Duration
|
||||
Err error
|
||||
// Delay is the time before the next polling attempt.
|
||||
Delay time.Duration
|
||||
// Err is the polling error that triggered the retry.
|
||||
Err error
|
||||
}
|
||||
|
||||
// ErrorEvent describes an error routed through framework error handling.
|
||||
type ErrorEvent struct {
|
||||
UpdateID int
|
||||
UpdateType tgapi.UpdateType
|
||||
Plugin string
|
||||
// UpdateID identifies the Telegram update when available.
|
||||
UpdateID int
|
||||
// UpdateType identifies the normalized update kind when available.
|
||||
UpdateType tgapi.UpdateType
|
||||
// Plugin names the component that reported the error.
|
||||
Plugin string
|
||||
// HandlerKind classifies the failing handler or runtime component.
|
||||
HandlerKind HandlerEventKind
|
||||
// HandlerName identifies the failing handler within its kind.
|
||||
HandlerName string
|
||||
FromID int64
|
||||
ChatID int64
|
||||
Err error
|
||||
UserFacing bool
|
||||
// FromID identifies the originating user when available.
|
||||
FromID int64
|
||||
// ChatID identifies the originating chat when available.
|
||||
ChatID int64
|
||||
// Err is the reported error.
|
||||
Err error
|
||||
// UserFacing reports whether Err is safe to show to the user.
|
||||
UserFacing bool
|
||||
}
|
||||
|
||||
func (UpdateReceivedEvent) isEvent() {}
|
||||
@@ -142,9 +224,15 @@ func (PollingRetryEvent) isEvent() {}
|
||||
func (ErrorEvent) isEvent() {}
|
||||
|
||||
// Observer receives best-effort runtime instrumentation events.
|
||||
//
|
||||
// During RunWithContext and RunWebhookWithContext, callbacks execute on a
|
||||
// dedicated dispatcher goroutine in enqueue order and never block update
|
||||
// handlers. The queue is bounded; overload drops events and emits sampled
|
||||
// warnings. Runtime shutdown cancels callback contexts and drains queued events;
|
||||
// Bot.Close returns ErrObserverShutdownTimeout if a callback ignores cancellation.
|
||||
type Observer interface {
|
||||
OnReceiveUpdate(ctx context.Context, event UpdateReceivedEvent)
|
||||
OnHandledUpdate(ctx context.Context, event UpdateHandledEvent)
|
||||
OnUpdateReceived(ctx context.Context, event UpdateReceivedEvent)
|
||||
OnUpdateHandled(ctx context.Context, event UpdateHandledEvent)
|
||||
OnHandlerStarted(ctx context.Context, event HandlerStartedEvent)
|
||||
OnHandlerFinished(ctx context.Context, event HandlerFinishedEvent)
|
||||
OnSceneTransition(ctx context.Context, event SceneTransitionEvent)
|
||||
@@ -158,29 +246,43 @@ func (bot *Bot[T]) safeEmitEvent(ctx context.Context, event Event) {
|
||||
if bot.observer == nil {
|
||||
return
|
||||
}
|
||||
if bot.observerAsync != nil {
|
||||
bot.observerAsync.enqueue(ctx, event)
|
||||
return
|
||||
}
|
||||
defer func() {
|
||||
if r := recover(); r != nil {
|
||||
bot.logger.Errorln(fmt.Sprintf("panic in observer: %v", r))
|
||||
if bot.logger != nil {
|
||||
bot.logger.Errorln(fmt.Sprintf("panic in observer: %v", r))
|
||||
}
|
||||
}
|
||||
}()
|
||||
bot.emitEvent(ctx, event)
|
||||
}
|
||||
|
||||
func (bot *Bot[T]) emitEvent(ctx context.Context, event Event) {
|
||||
emitObserverEvent(bot.observer, ctx, event)
|
||||
}
|
||||
|
||||
func emitObserverEvent(observer Observer, ctx context.Context, event Event) {
|
||||
switch e := event.(type) {
|
||||
case UpdateReceivedEvent:
|
||||
bot.observer.OnReceiveUpdate(ctx, e)
|
||||
observer.OnUpdateReceived(ctx, e)
|
||||
case UpdateHandledEvent:
|
||||
bot.observer.OnHandledUpdate(ctx, e)
|
||||
observer.OnUpdateHandled(ctx, e)
|
||||
case HandlerStartedEvent:
|
||||
bot.observer.OnHandlerStarted(ctx, e)
|
||||
observer.OnHandlerStarted(ctx, e)
|
||||
case HandlerFinishedEvent:
|
||||
bot.observer.OnHandlerFinished(ctx, e)
|
||||
observer.OnHandlerFinished(ctx, e)
|
||||
case SceneTransitionEvent:
|
||||
bot.observer.OnSceneTransition(ctx, e)
|
||||
observer.OnSceneTransition(ctx, e)
|
||||
case PolicyCheckedEvent:
|
||||
bot.observer.OnPolicyChecked(ctx, e)
|
||||
observer.OnPolicyChecked(ctx, e)
|
||||
case RunnerFinishedEvent:
|
||||
bot.observer.OnRunnerFinished(ctx, e)
|
||||
observer.OnRunnerFinished(ctx, e)
|
||||
case PollingRetryEvent:
|
||||
bot.observer.OnPollingRetry(ctx, e)
|
||||
observer.OnPollingRetry(ctx, e)
|
||||
case ErrorEvent:
|
||||
bot.observer.OnError(ctx, e)
|
||||
observer.OnError(ctx, e)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,125 @@
|
||||
package laniakea
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"sync"
|
||||
"sync/atomic"
|
||||
"time"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
const observerQueueSize = 1024
|
||||
|
||||
type queuedObserverEvent struct {
|
||||
ctx context.Context
|
||||
event Event
|
||||
}
|
||||
|
||||
type observerDispatcher struct {
|
||||
observer Observer
|
||||
logger *sneklog.Logger
|
||||
ctx context.Context
|
||||
cancel context.CancelFunc
|
||||
queue chan queuedObserverEvent
|
||||
stop chan struct{}
|
||||
mu sync.RWMutex
|
||||
closed bool
|
||||
wg sync.WaitGroup
|
||||
stopOnce sync.Once
|
||||
dropped atomic.Uint64
|
||||
}
|
||||
|
||||
func newObserverDispatcher(observer Observer, logger *sneklog.Logger) *observerDispatcher {
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
dispatcher := &observerDispatcher{
|
||||
observer: observer,
|
||||
logger: logger,
|
||||
ctx: ctx,
|
||||
cancel: cancel,
|
||||
queue: make(chan queuedObserverEvent, observerQueueSize),
|
||||
stop: make(chan struct{}),
|
||||
}
|
||||
dispatcher.wg.Add(1)
|
||||
go dispatcher.run()
|
||||
return dispatcher
|
||||
}
|
||||
|
||||
func (d *observerDispatcher) enqueue(ctx context.Context, event Event) {
|
||||
if ctx == nil {
|
||||
ctx = context.Background()
|
||||
}
|
||||
ctx = observerEventContext{Context: context.WithoutCancel(ctx), lifecycle: d.ctx}
|
||||
d.mu.RLock()
|
||||
defer d.mu.RUnlock()
|
||||
if d.closed {
|
||||
return
|
||||
}
|
||||
select {
|
||||
case d.queue <- queuedObserverEvent{ctx: ctx, event: event}:
|
||||
default:
|
||||
dropped := d.dropped.Add(1)
|
||||
if d.logger != nil && (dropped == 1 || dropped&(dropped-1) == 0) {
|
||||
d.logger.Warnf("observer queue full; dropped %d events", dropped)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func (d *observerDispatcher) run() {
|
||||
defer d.wg.Done()
|
||||
for {
|
||||
select {
|
||||
case queued := <-d.queue:
|
||||
d.dispatch(queued)
|
||||
case <-d.stop:
|
||||
for {
|
||||
select {
|
||||
case queued := <-d.queue:
|
||||
d.dispatch(queued)
|
||||
default:
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func (d *observerDispatcher) dispatch(queued queuedObserverEvent) {
|
||||
defer func() {
|
||||
if recovered := recover(); recovered != nil && d.logger != nil {
|
||||
d.logger.Errorln(fmt.Sprintf("panic in observer: %v", recovered))
|
||||
}
|
||||
}()
|
||||
emitObserverEvent(d.observer, queued.ctx, queued.event)
|
||||
}
|
||||
|
||||
func (d *observerDispatcher) close(ctx context.Context) error {
|
||||
d.stopOnce.Do(func() {
|
||||
d.mu.Lock()
|
||||
d.closed = true
|
||||
d.cancel()
|
||||
close(d.stop)
|
||||
d.mu.Unlock()
|
||||
})
|
||||
done := make(chan struct{})
|
||||
go func() {
|
||||
d.wg.Wait()
|
||||
close(done)
|
||||
}()
|
||||
select {
|
||||
case <-done:
|
||||
return nil
|
||||
case <-ctx.Done():
|
||||
return fmt.Errorf("%w: %v", ErrObserverShutdownTimeout, ctx.Err())
|
||||
}
|
||||
}
|
||||
|
||||
type observerEventContext struct {
|
||||
context.Context
|
||||
lifecycle context.Context
|
||||
}
|
||||
|
||||
func (ctx observerEventContext) Deadline() (time.Time, bool) { return ctx.lifecycle.Deadline() }
|
||||
func (ctx observerEventContext) Done() <-chan struct{} { return ctx.lifecycle.Done() }
|
||||
func (ctx observerEventContext) Err() error { return ctx.lifecycle.Err() }
|
||||
@@ -0,0 +1,59 @@
|
||||
package laniakea
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
type cancelAwareObserver struct {
|
||||
testObserver
|
||||
started chan struct{}
|
||||
}
|
||||
|
||||
func (o *cancelAwareObserver) OnUpdateReceived(ctx context.Context, _ UpdateReceivedEvent) {
|
||||
close(o.started)
|
||||
<-ctx.Done()
|
||||
}
|
||||
|
||||
type stubbornObserver struct {
|
||||
testObserver
|
||||
started chan struct{}
|
||||
release chan struct{}
|
||||
}
|
||||
|
||||
func (o *stubbornObserver) OnUpdateReceived(context.Context, UpdateReceivedEvent) {
|
||||
close(o.started)
|
||||
<-o.release
|
||||
}
|
||||
|
||||
func TestObserverDispatcherCancelsCallbackDuringClose(t *testing.T) {
|
||||
observer := &cancelAwareObserver{started: make(chan struct{})}
|
||||
dispatcher := newObserverDispatcher(observer, nil)
|
||||
dispatcher.enqueue(context.Background(), UpdateReceivedEvent{})
|
||||
<-observer.started
|
||||
|
||||
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
|
||||
defer cancel()
|
||||
if err := dispatcher.close(ctx); err != nil {
|
||||
t.Fatalf("close returned error: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestObserverDispatcherCloseTimeout(t *testing.T) {
|
||||
observer := &stubbornObserver{started: make(chan struct{}), release: make(chan struct{})}
|
||||
dispatcher := newObserverDispatcher(observer, nil)
|
||||
dispatcher.enqueue(context.Background(), UpdateReceivedEvent{})
|
||||
<-observer.started
|
||||
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Millisecond)
|
||||
defer cancel()
|
||||
if err := dispatcher.close(ctx); !errors.Is(err, ErrObserverShutdownTimeout) {
|
||||
t.Fatalf("close error = %v, want ErrObserverShutdownTimeout", err)
|
||||
}
|
||||
close(observer.release)
|
||||
if err := dispatcher.close(context.Background()); err != nil {
|
||||
t.Fatalf("second close returned error: %v", err)
|
||||
}
|
||||
}
|
||||
+164
-188
@@ -2,159 +2,15 @@ package laniakea
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"regexp"
|
||||
"fmt"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/extypes"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||
"git.scuroneko.dev/scuroneko/slog"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
// CommandValueType defines the expected type of command argument.
|
||||
type CommandValueType string
|
||||
|
||||
const (
|
||||
// CommandValueStringType expects any non-empty string.
|
||||
CommandValueStringType CommandValueType = "string"
|
||||
// CommandValueIntType expects a decimal integer (digits only).
|
||||
CommandValueIntType CommandValueType = "int"
|
||||
// CommandValueBoolType 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
|
||||
}
|
||||
|
||||
// NewCommandArg creates a new CommandArg with the given text and type.
|
||||
// Uses a default regex based on the type (string or int).
|
||||
// For CommandValueAnyType, no validation is performed.
|
||||
func NewCommandArg(text string) CommandArg {
|
||||
return CommandArg{CommandValueAnyType, text, CommandRegexString, false}
|
||||
}
|
||||
|
||||
// SetValueType sets expected value type and switches built-in validation regexp.
|
||||
func (c CommandArg) SetValueType(t CommandValueType) CommandArg {
|
||||
regex := CommandRegexString
|
||||
switch t {
|
||||
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
|
||||
}
|
||||
var errMiddlewareBlocked = errors.New("middleware blocked call")
|
||||
|
||||
// Plugin represents a collection of commands and payloads (e.g., callback handlers),
|
||||
// with shared middleware and configuration.
|
||||
@@ -169,7 +25,8 @@ type Plugin[T AppData] struct {
|
||||
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 *slog.Logger
|
||||
logger *sneklog.Logger
|
||||
loggerOwned bool // true when the logger was created by the bot during registration; only owned loggers are closed by Close
|
||||
|
||||
messageFallback CommandExecutor[T]
|
||||
handlers map[tgapi.UpdateType]CommandExecutor[T]
|
||||
@@ -192,7 +49,6 @@ func NewPlugin[T AppData](name string) *Plugin[T] {
|
||||
}
|
||||
|
||||
// AddCommand registers a command in the plugin.
|
||||
// The command's .command field is used as the key.
|
||||
func (p *Plugin[T]) AddCommand(command *Command[T]) *Plugin[T] {
|
||||
if command == nil {
|
||||
if p.logger != nil {
|
||||
@@ -200,14 +56,23 @@ func (p *Plugin[T]) AddCommand(command *Command[T]) *Plugin[T] {
|
||||
}
|
||||
return p
|
||||
}
|
||||
if command.exec == nil {
|
||||
if p.logger != nil {
|
||||
p.logger.Warnf("command '%s' has a nil executor; skipping", command.command)
|
||||
}
|
||||
return p
|
||||
}
|
||||
if _, exists := p.commands[command.command]; exists && p.logger != nil {
|
||||
p.logger.Warnf("command '%s' already registered in plugin '%s'; overwriting", command.command, p.name)
|
||||
}
|
||||
p.commands[command.command] = command
|
||||
return p
|
||||
}
|
||||
|
||||
// NewCommand creates and immediately adds a new command to the plugin.
|
||||
// Command creates and immediately adds a new command to the plugin.
|
||||
// Returns the created command for further configuration.
|
||||
func (p *Plugin[T]) NewCommand(exec CommandExecutor[T], command string, args ...CommandArg) *Command[T] {
|
||||
cmd := NewCommand(exec, command, args...)
|
||||
func (p *Plugin[T]) Command(command string, exec CommandExecutor[T], args ...CommandArg) *Command[T] {
|
||||
cmd := NewCommand(command, exec, args...)
|
||||
p.AddCommand(cmd)
|
||||
return cmd
|
||||
}
|
||||
@@ -221,35 +86,76 @@ func (p *Plugin[T]) AddPayload(command *Command[T]) *Plugin[T] {
|
||||
}
|
||||
return p
|
||||
}
|
||||
if command.exec == nil {
|
||||
if p.logger != nil {
|
||||
p.logger.Warnf("payload '%s' has a nil executor; skipping", command.command)
|
||||
}
|
||||
return p
|
||||
}
|
||||
if _, exists := p.payloads[command.command]; exists && p.logger != nil {
|
||||
p.logger.Warnf("payload '%s' is already registered in plugin '%s'; overwriting", command.command, p.name)
|
||||
}
|
||||
p.payloads[command.command] = command
|
||||
return p
|
||||
}
|
||||
|
||||
// NewPayload creates and immediately adds a new payload command to the plugin.
|
||||
// Payload creates and immediately adds a new payload command to the plugin.
|
||||
// Returns the created payload command for further configuration.
|
||||
func (p *Plugin[T]) NewPayload(exec CommandExecutor[T], command string, args ...CommandArg) *Command[T] {
|
||||
cmd := NewPayload(exec, command, args...)
|
||||
func (p *Plugin[T]) Payload(command string, exec CommandExecutor[T], args ...CommandArg) *Command[T] {
|
||||
cmd := NewCommand(command, exec, args...)
|
||||
p.AddPayload(cmd)
|
||||
return cmd
|
||||
}
|
||||
|
||||
// Scene creates, registers, and returns a new scene owned by the plugin.
|
||||
func (p *Plugin[T]) Scene(name string) *Scene[T] {
|
||||
scene := NewScene[T](name)
|
||||
scene.setPluginName(p.name)
|
||||
p.AddScene(scene)
|
||||
return scene
|
||||
}
|
||||
|
||||
// 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
|
||||
scene.pluginName = p.name
|
||||
if _, exists := p.scenes[scene.name]; exists && p.logger != nil {
|
||||
p.logger.Warnf("scene '%s' already registered in plugin '%s'; overwriting", scene.name, p.name)
|
||||
}
|
||||
p.scenes[scene.name] = scene
|
||||
return p
|
||||
}
|
||||
|
||||
// NewScene creates, registers, and returns a new scene owned by the plugin.
|
||||
func (p *Plugin[T]) NewScene(name string) *Scene[T] {
|
||||
scene := NewScene[T](name)
|
||||
scene.setPluginName(p.name)
|
||||
p.AddScene(scene)
|
||||
return scene
|
||||
// CommandGroup configures and registers a prefixed command group.
|
||||
func (p *Plugin[T]) CommandGroup(prefix string, groupFunc func(group *CommandGroup[T])) *Plugin[T] {
|
||||
if groupFunc == nil {
|
||||
return p
|
||||
}
|
||||
group := NewCommandGroup[T](prefix)
|
||||
groupFunc(group)
|
||||
if len(group.commands) == 0 {
|
||||
return p
|
||||
}
|
||||
for _, cmd := range group.Build() {
|
||||
p.AddCommand(cmd)
|
||||
}
|
||||
return p
|
||||
}
|
||||
|
||||
// AddCommandGroup registers every command built by group.
|
||||
func (p *Plugin[T]) AddCommandGroup(group *CommandGroup[T]) *Plugin[T] {
|
||||
if group == nil {
|
||||
return p
|
||||
}
|
||||
if len(group.commands) == 0 {
|
||||
return p
|
||||
}
|
||||
for _, cmd := range group.Build() {
|
||||
p.AddCommand(cmd)
|
||||
}
|
||||
return p
|
||||
}
|
||||
|
||||
// UsePolicy registers a Policy as plugin middleware for all plugin handlers.
|
||||
@@ -261,15 +167,21 @@ func (p *Plugin[T]) UsePolicy(name string, policy Policy[T]) *Plugin[T] {
|
||||
// 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] {
|
||||
if handler == nil {
|
||||
if p.logger != nil {
|
||||
p.logger.Warnf("update handler '%s' has a nil executor; skipping", t)
|
||||
}
|
||||
return p
|
||||
}
|
||||
switch t {
|
||||
case tgapi.UpdateTypeMessage, tgapi.UpdateTypeChannelPost, tgapi.UpdateTypeCallbackQuery:
|
||||
if p.logger == nil {
|
||||
logger := utils.CreateLogger(p.name, utils.GetLoggerLevel())
|
||||
logger.Warnf("%s can't be registred through AddUpdateHandler. Use AddPayload/NewPayload or AddCommand/NewCommand", t)
|
||||
logger := utils.CreateLogger(p.name, utils.GetLoggerLevel(), utils.LogFormatText, nil)
|
||||
logger.Warnf("%s can't be registered through AddUpdateHandler. Use AddPayload/Payload or AddCommand/Command", t)
|
||||
_ = logger.Close()
|
||||
return p
|
||||
}
|
||||
p.logger.Warnf("%s can't be registred through AddUpdateHandler. Use AddPayload/NewPayload or AddCommand/NewCommand", t)
|
||||
p.logger.Warnf("%s can't be registered through AddUpdateHandler. Use AddPayload/Payload or AddCommand/Command", t)
|
||||
return p
|
||||
}
|
||||
p.handlers[t] = handler
|
||||
@@ -293,7 +205,7 @@ func (p *Plugin[T]) SkipCommandAutoGen() *Plugin[T] {
|
||||
//
|
||||
// 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 *slog.Logger) *Plugin[T] {
|
||||
func (p *Plugin[T]) SetLogger(l *sneklog.Logger) *Plugin[T] {
|
||||
p.logger = l
|
||||
return p
|
||||
}
|
||||
@@ -326,9 +238,13 @@ func (p *Plugin[T]) SetMessageFallback(handler CommandExecutor[T]) *Plugin[T] {
|
||||
|
||||
// Close releases plugin-owned resources such as its logger and optional
|
||||
// OnClose callback.
|
||||
//
|
||||
// Only loggers created by the bot during registration are closed. A logger
|
||||
// supplied via SetLogger remains the caller's responsibility — the framework
|
||||
// never closes a logger it does not own.
|
||||
func (p *Plugin[T]) Close() error {
|
||||
var e []error
|
||||
if p.logger != nil {
|
||||
if p.logger != nil && p.loggerOwned {
|
||||
if err := p.logger.Close(); err != nil {
|
||||
e = append(e, err)
|
||||
}
|
||||
@@ -341,8 +257,7 @@ func (p *Plugin[T]) Close() error {
|
||||
return errors.Join(e...)
|
||||
}
|
||||
|
||||
// Internal helper that validates and executes a command handler.
|
||||
func (p *Plugin[T]) executeCmd(cmd string, ctx *MsgContext, db T) error {
|
||||
func (p *Plugin[T]) executeCmd(cmd string, ctx *MessageContext, db T) error {
|
||||
command, exists := p.commands[cmd]
|
||||
if !exists {
|
||||
return AsInternalError(errCommandNotFound)
|
||||
@@ -355,16 +270,15 @@ func (p *Plugin[T]) executeCmd(cmd string, ctx *MsgContext, db T) error {
|
||||
// Run command-specific middlewares
|
||||
for _, m := range command.middlewares {
|
||||
if !m.Execute(ctx, db) {
|
||||
return AsInternalError(errors.New("middleware blocked call"))
|
||||
return errMiddlewareBlocked
|
||||
}
|
||||
}
|
||||
|
||||
// Execute command
|
||||
return command.exec(ctx, db)
|
||||
return callCommandExecutor(command.exec, ctx, db)
|
||||
}
|
||||
|
||||
// Internal helper that validates and executes a payload handler.
|
||||
func (p *Plugin[T]) executePayload(payload string, ctx *MsgContext, db T) error {
|
||||
func (p *Plugin[T]) executePayload(payload string, ctx *MessageContext, db T) error {
|
||||
command, exists := p.payloads[payload]
|
||||
if !exists {
|
||||
return AsInternalError(errPayloadNotFound)
|
||||
@@ -377,16 +291,27 @@ func (p *Plugin[T]) executePayload(payload string, ctx *MsgContext, db T) error
|
||||
// Run command-specific middlewares
|
||||
for _, m := range command.middlewares {
|
||||
if !m.Execute(ctx, db) {
|
||||
return AsInternalError(errors.New("middleware blocked call"))
|
||||
return errMiddlewareBlocked
|
||||
}
|
||||
}
|
||||
|
||||
// Execute payload
|
||||
return command.exec(ctx, db)
|
||||
return callCommandExecutor(command.exec, ctx, db)
|
||||
}
|
||||
|
||||
// Internal helper that runs plugin middlewares in order.
|
||||
func (p *Plugin[T]) executeMiddlewares(ctx *MsgContext, db T) bool {
|
||||
func callCommandExecutor[T AppData](executor CommandExecutor[T], ctx *MessageContext, db T) (err error) {
|
||||
if executor == nil {
|
||||
return ErrHandlerExecutorNil
|
||||
}
|
||||
defer func() {
|
||||
if recovered := recover(); recovered != nil {
|
||||
err = fmt.Errorf("%w: %v", ErrHandlerPanic, recovered)
|
||||
}
|
||||
}()
|
||||
return executor(ctx, db)
|
||||
}
|
||||
|
||||
func (p *Plugin[T]) executeMiddlewares(ctx *MessageContext, db T) bool {
|
||||
for _, m := range p.middlewares {
|
||||
if !m.Execute(ctx, db) {
|
||||
return false
|
||||
@@ -398,14 +323,17 @@ func (p *Plugin[T]) executeMiddlewares(ctx *MsgContext, db T) bool {
|
||||
// MiddlewareExecutor is the function type for middleware logic.
|
||||
// Returns true to continue execution, false to block it.
|
||||
// If async, return value is ignored.
|
||||
type MiddlewareExecutor[T AppData] func(ctx *MsgContext, db T) bool
|
||||
type MiddlewareExecutor[T AppData] func(ctx *MessageContext, db T) bool
|
||||
|
||||
// ErrMiddlewareExecutorNil reports an attempt to execute middleware without a callback.
|
||||
var ErrMiddlewareExecutorNil = errors.New("middleware executor is nil")
|
||||
|
||||
// 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)
|
||||
order int // Sort order for bot-level middleware ordering
|
||||
async bool // If true, runs in goroutine and doesn't block
|
||||
}
|
||||
|
||||
@@ -414,7 +342,7 @@ func NewMiddleware[T AppData](name string, executor MiddlewareExecutor[T]) Middl
|
||||
return Middleware[T]{name, executor, 0, false}
|
||||
}
|
||||
|
||||
// SetOrder sets the execution order (currently ignored).
|
||||
// SetOrder sets the bot-level middleware execution order.
|
||||
func (m Middleware[T]) SetOrder(order int) Middleware[T] {
|
||||
m.order = order
|
||||
return m
|
||||
@@ -430,13 +358,61 @@ func (m Middleware[T]) SetAsync(async bool) Middleware[T] {
|
||||
// Execute runs the middleware.
|
||||
// If async, runs in a goroutine and returns true immediately.
|
||||
// Otherwise, returns the result of the executor.
|
||||
func (m Middleware[T]) Execute(ctx *MsgContext, db T) bool {
|
||||
//
|
||||
// Async note: the goroutine receives a shallow copy of MessageContext, so
|
||||
// scalar fields (FromID, ChatID, CallbackQueryID, ...) remain a stable
|
||||
// snapshot. Pointer and slice fields (Msg, From, Chat, API, Logger, Args)
|
||||
// continue to share storage with the synchronous flow. Async middleware
|
||||
// must treat those fields as read-only — mutating them races the sync chain
|
||||
// that mutates the same context concurrently.
|
||||
// Bot runtimes wait for tracked asynchronous middleware before returning.
|
||||
func (m Middleware[T]) Execute(ctx *MessageContext, db T) bool {
|
||||
if m.executor == nil {
|
||||
reportMiddlewareError(ctx, m.name, ErrMiddlewareExecutorNil)
|
||||
return false
|
||||
}
|
||||
if m.async {
|
||||
ctx := *ctx // copy context to avoid race condition
|
||||
go func(ctx MsgContext) {
|
||||
m.executor(&ctx, db)
|
||||
}(ctx)
|
||||
ctxCopy := *ctx
|
||||
task := func() {
|
||||
defer func() {
|
||||
if recovered := recover(); recovered != nil {
|
||||
reportMiddlewareError(&ctxCopy, m.name, fmt.Errorf("%w in middleware %q: %v", ErrHandlerPanic, m.name, recovered))
|
||||
}
|
||||
}()
|
||||
m.executor(&ctxCopy, db)
|
||||
}
|
||||
if ctx.asyncTask != nil {
|
||||
ctx.asyncTask(task)
|
||||
} else {
|
||||
go task()
|
||||
}
|
||||
return true
|
||||
}
|
||||
return m.executor(ctx, db)
|
||||
result := false
|
||||
func() {
|
||||
defer func() {
|
||||
if recovered := recover(); recovered != nil {
|
||||
reportMiddlewareError(ctx, m.name, fmt.Errorf("%w in middleware %q: %v", ErrHandlerPanic, m.name, recovered))
|
||||
}
|
||||
}()
|
||||
result = m.executor(ctx, db)
|
||||
}()
|
||||
return result
|
||||
}
|
||||
|
||||
func reportMiddlewareError(ctx *MessageContext, name string, err error) {
|
||||
event := ErrorEvent{
|
||||
Plugin: "bot",
|
||||
HandlerKind: HandlerMiddlewareKind,
|
||||
HandlerName: name,
|
||||
Err: err,
|
||||
UserFacing: false,
|
||||
}
|
||||
if ctx != nil {
|
||||
event.UpdateID = ctx.Update.UpdateID
|
||||
event.UpdateType = ctx.Update.Type
|
||||
event.FromID = ctx.FromID
|
||||
event.ChatID = ctx.ChatID
|
||||
}
|
||||
emitContextError(ctx, event)
|
||||
}
|
||||
|
||||
+199
-3
@@ -1,12 +1,119 @@
|
||||
package laniakea
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
)
|
||||
|
||||
type middlewareErrorObserver struct {
|
||||
testObserver
|
||||
errors chan ErrorEvent
|
||||
}
|
||||
|
||||
func (o *middlewareErrorObserver) OnError(_ context.Context, event ErrorEvent) {
|
||||
o.errors <- event
|
||||
}
|
||||
|
||||
func TestAsyncMiddlewareRecoversPanic(t *testing.T) {
|
||||
observer := &middlewareErrorObserver{errors: make(chan ErrorEvent, 1)}
|
||||
ctx := &MessageContext{
|
||||
Update: tgapi.Update{UpdateID: 7, Type: tgapi.UpdateTypeMessage},
|
||||
FromID: 42,
|
||||
ChatID: 100,
|
||||
observer: observer,
|
||||
}
|
||||
middleware := NewMiddleware[NoData]("panic", func(ctx *MessageContext, db NoData) bool {
|
||||
panic("boom")
|
||||
}).SetAsync(true)
|
||||
|
||||
if !middleware.Execute(ctx, NoData{}) {
|
||||
t.Fatal("async middleware blocked execution")
|
||||
}
|
||||
select {
|
||||
case event := <-observer.errors:
|
||||
if event.HandlerKind != HandlerMiddlewareKind || event.HandlerName != "panic" {
|
||||
t.Fatalf("unexpected error event: %#v", event)
|
||||
}
|
||||
if event.Err == nil {
|
||||
t.Fatal("panic error was not reported")
|
||||
}
|
||||
if !errors.Is(event.Err, ErrHandlerPanic) {
|
||||
t.Fatalf("expected ErrHandlerPanic, got %v", event.Err)
|
||||
}
|
||||
case <-time.After(time.Second):
|
||||
t.Fatal("timed out waiting for async middleware error")
|
||||
}
|
||||
}
|
||||
|
||||
func TestAsyncMiddlewareUsesContextTaskTracker(t *testing.T) {
|
||||
bot := new(Bot[NoData])
|
||||
started := make(chan struct{})
|
||||
release := make(chan struct{})
|
||||
ctx := &MessageContext{asyncTask: bot.startAsyncTask}
|
||||
middleware := NewMiddleware[NoData]("tracked", func(*MessageContext, NoData) bool {
|
||||
close(started)
|
||||
<-release
|
||||
return true
|
||||
}).SetAsync(true)
|
||||
|
||||
if !middleware.Execute(ctx, NoData{}) {
|
||||
t.Fatal("async middleware blocked execution")
|
||||
}
|
||||
<-started
|
||||
waited := make(chan struct{})
|
||||
go func() {
|
||||
bot.middlewareWG.Wait()
|
||||
close(waited)
|
||||
}()
|
||||
select {
|
||||
case <-waited:
|
||||
t.Fatal("task tracker finished before middleware returned")
|
||||
case <-time.After(20 * time.Millisecond):
|
||||
}
|
||||
close(release)
|
||||
select {
|
||||
case <-waited:
|
||||
case <-time.After(time.Second):
|
||||
t.Fatal("task tracker did not finish after middleware returned")
|
||||
}
|
||||
}
|
||||
|
||||
func TestSyncMiddlewareRecoversPanic(t *testing.T) {
|
||||
observer := &middlewareErrorObserver{errors: make(chan ErrorEvent, 1)}
|
||||
ctx := &MessageContext{observer: observer}
|
||||
middleware := NewMiddleware[NoData]("panic", func(ctx *MessageContext, db NoData) bool {
|
||||
panic("boom")
|
||||
})
|
||||
|
||||
if middleware.Execute(ctx, NoData{}) {
|
||||
t.Fatal("panicking synchronous middleware continued execution")
|
||||
}
|
||||
event := <-observer.errors
|
||||
if !errors.Is(event.Err, ErrHandlerPanic) {
|
||||
t.Fatalf("expected ErrHandlerPanic, got %v", event.Err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestMiddlewareRejectsNilExecutor(t *testing.T) {
|
||||
observer := &middlewareErrorObserver{errors: make(chan ErrorEvent, 1)}
|
||||
ctx := &MessageContext{observer: observer}
|
||||
middleware := NewMiddleware[NoData]("nil", nil)
|
||||
|
||||
if middleware.Execute(ctx, NoData{}) {
|
||||
t.Fatal("nil middleware executor was accepted")
|
||||
}
|
||||
event := <-observer.errors
|
||||
if !errors.Is(event.Err, ErrMiddlewareExecutorNil) {
|
||||
t.Fatalf("error = %v, want ErrMiddlewareExecutorNil", event.Err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestValidateArgsRequiresFullMatch(t *testing.T) {
|
||||
intCmd := NewCommand(func(ctx *MsgContext, db NoData) error { return nil }, "int", NewCommandArg("n").SetValueType(CommandValueIntType).SetRequired())
|
||||
intCmd := NewCommand("int", func(ctx *MessageContext, db NoData) error { return nil }, NewCommandArg("n").SetValueType(CommandValueInt).SetRequired())
|
||||
if err := intCmd.validateArgs([]string{"123"}); err != nil {
|
||||
t.Fatalf("expected valid integer argument, got %v", err)
|
||||
}
|
||||
@@ -14,7 +121,7 @@ func TestValidateArgsRequiresFullMatch(t *testing.T) {
|
||||
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())
|
||||
boolCmd := NewCommand("bool", func(ctx *MessageContext, db NoData) error { return nil }, NewCommandArg("flag").SetValueType(CommandValueBool).SetRequired())
|
||||
if err := boolCmd.validateArgs([]string{"false"}); err != nil {
|
||||
t.Fatalf("expected valid bool argument, got %v", err)
|
||||
}
|
||||
@@ -25,8 +132,8 @@ func TestValidateArgsRequiresFullMatch(t *testing.T) {
|
||||
|
||||
func TestValidateArgsEnforcesRequiredArgIndex(t *testing.T) {
|
||||
cmd := NewCommand(
|
||||
func(ctx *MsgContext, db NoData) error { return nil },
|
||||
"mixed",
|
||||
func(ctx *MessageContext, db NoData) error { return nil },
|
||||
NewCommandArg("optional"),
|
||||
NewCommandArg("required").SetRequired(),
|
||||
)
|
||||
@@ -38,3 +145,92 @@ func TestValidateArgsEnforcesRequiredArgIndex(t *testing.T) {
|
||||
t.Fatalf("expected both args to validate, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestCommandGroupBuildsPrefixedCommandsWithoutMutatingOriginal(t *testing.T) {
|
||||
groupMiddleware := NewMiddleware("group", func(ctx *MessageContext, db NoData) bool { return true })
|
||||
commandMiddleware := NewMiddleware("command", func(ctx *MessageContext, db NoData) bool { return true })
|
||||
cmd := NewCommand("ban", func(ctx *MessageContext, db NoData) error { return nil }).
|
||||
SetDescription("Ban user").
|
||||
Use(commandMiddleware)
|
||||
|
||||
group := NewCommandGroup[NoData]("admin_").
|
||||
Use(groupMiddleware).
|
||||
AddCommand(cmd)
|
||||
|
||||
built := group.Build()
|
||||
if len(built) != 1 {
|
||||
t.Fatalf("expected one command, got %d", len(built))
|
||||
}
|
||||
|
||||
grouped := built[0]
|
||||
if grouped.command != "admin_ban" {
|
||||
t.Fatalf("expected prefixed command name, got %q", grouped.command)
|
||||
}
|
||||
if grouped.description != "Ban user" {
|
||||
t.Fatalf("expected description to be copied, got %q", grouped.description)
|
||||
}
|
||||
if cmd.command != "ban" {
|
||||
t.Fatalf("expected original command name to stay unchanged, got %q", cmd.command)
|
||||
}
|
||||
if len(cmd.middlewares) != 1 || cmd.middlewares[0].name != "command" {
|
||||
t.Fatalf("expected original command middleware to stay unchanged, got %#v", cmd.middlewares)
|
||||
}
|
||||
if len(grouped.middlewares) != 2 {
|
||||
t.Fatalf("expected group and command middleware, got %d", len(grouped.middlewares))
|
||||
}
|
||||
if grouped.middlewares[0].name != "group" || grouped.middlewares[1].name != "command" {
|
||||
t.Fatalf("expected group middleware before command middleware, got %q then %q", grouped.middlewares[0].name, grouped.middlewares[1].name)
|
||||
}
|
||||
}
|
||||
|
||||
func TestCommandGroupBuildIsRepeatable(t *testing.T) {
|
||||
group := NewCommandGroup[NoData]("admin").
|
||||
Use(NewMiddleware("group", func(ctx *MessageContext, db NoData) bool { return true })).
|
||||
AddCommand(NewCommand("ban", func(ctx *MessageContext, db NoData) error { return nil }).
|
||||
Use(NewMiddleware("command", func(ctx *MessageContext, db NoData) bool { return true })))
|
||||
|
||||
first := group.Build()
|
||||
second := group.Build()
|
||||
|
||||
if len(first) != 1 || len(second) != 1 {
|
||||
t.Fatalf("expected one command from each build, got %d and %d", len(first), len(second))
|
||||
}
|
||||
if len(first[0].middlewares) != 2 {
|
||||
t.Fatalf("expected first build to have two middlewares, got %d", len(first[0].middlewares))
|
||||
}
|
||||
if len(second[0].middlewares) != 2 {
|
||||
t.Fatalf("expected second build to have two middlewares, got %d", len(second[0].middlewares))
|
||||
}
|
||||
if first[0] == second[0] {
|
||||
t.Fatal("expected repeated Build calls to return distinct command copies")
|
||||
}
|
||||
}
|
||||
|
||||
func TestPluginCommandGroupRegistersBuiltCommands(t *testing.T) {
|
||||
plugin := NewPlugin[NoData]("admin")
|
||||
|
||||
plugin.CommandGroup("admin_", func(group *CommandGroup[NoData]) {
|
||||
group.AddCommand(NewCommand("ban", func(ctx *MessageContext, db NoData) error { return nil }))
|
||||
})
|
||||
|
||||
if _, ok := plugin.commands["admin_ban"]; !ok {
|
||||
t.Fatal("expected plugin to register prefixed command")
|
||||
}
|
||||
if _, ok := plugin.commands["ban"]; ok {
|
||||
t.Fatal("expected plugin not to register unprefixed command")
|
||||
}
|
||||
|
||||
plugin.CommandGroup("ignored", nil)
|
||||
plugin.AddCommandGroup(nil)
|
||||
}
|
||||
|
||||
func TestPluginSkipsNilHandlers(t *testing.T) {
|
||||
plugin := NewPlugin[NoData]("nil")
|
||||
plugin.AddCommand(NewCommand[NoData]("command", nil))
|
||||
plugin.AddPayload(NewCommand[NoData]("payload", nil))
|
||||
plugin.AddUpdateHandler(tgapi.UpdateTypeEditedMessage, nil)
|
||||
|
||||
if len(plugin.commands) != 0 || len(plugin.payloads) != 0 || len(plugin.handlers) != 0 {
|
||||
t.Fatalf("nil handlers were registered: commands=%d payloads=%d updates=%d", len(plugin.commands), len(plugin.payloads), len(plugin.handlers))
|
||||
}
|
||||
}
|
||||
|
||||
@@ -8,11 +8,11 @@ import (
|
||||
)
|
||||
|
||||
// Policy defines a reusable authorization rule for the current update context.
|
||||
type Policy[T AppData] func(ctx *MsgContext, data T) error
|
||||
type Policy[T AppData] func(ctx *MessageContext, 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 {
|
||||
return NewMiddleware(name, func(ctx *MessageContext, data T) bool {
|
||||
if err := p(ctx, data); err != nil {
|
||||
ctx.emitPolicyChecked(PolicyCheckedEvent{
|
||||
Name: name,
|
||||
@@ -37,7 +37,7 @@ func RequirePolicy[T AppData](name string, p Policy[T]) Middleware[T] {
|
||||
|
||||
// AllPolicies composes policies that all must succeed.
|
||||
func AllPolicies[T AppData](policies ...Policy[T]) Policy[T] {
|
||||
return func(ctx *MsgContext, data T) error {
|
||||
return func(ctx *MessageContext, data T) error {
|
||||
for _, p := range policies {
|
||||
if err := p(ctx, data); err != nil {
|
||||
return err
|
||||
@@ -49,7 +49,7 @@ func AllPolicies[T AppData](policies ...Policy[T]) Policy[T] {
|
||||
|
||||
// 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 {
|
||||
return func(ctx *MessageContext, data T) error {
|
||||
var firstDeny error
|
||||
var internalErr error
|
||||
for _, p := range policies {
|
||||
@@ -79,7 +79,7 @@ func AnyPolicy[T AppData](policies ...Policy[T]) Policy[T] {
|
||||
|
||||
// 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 {
|
||||
return func(ctx *MessageContext, 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"))
|
||||
@@ -93,7 +93,7 @@ func NotPolicy[T AppData](policy Policy[T]) Policy[T] {
|
||||
|
||||
// RequirePrivateChat allows execution only in private chats.
|
||||
func RequirePrivateChat[T AppData]() Policy[T] {
|
||||
return func(ctx *MsgContext, data T) error {
|
||||
return func(ctx *MessageContext, data T) error {
|
||||
if ctx.Msg == nil || ctx.Msg.Chat == nil {
|
||||
return AsInternalError(errors.New("private-chat policy requires message chat context"))
|
||||
}
|
||||
@@ -108,7 +108,7 @@ func RequirePrivateChat[T AppData]() Policy[T] {
|
||||
|
||||
// RequireGroupChat allows execution only in group or supergroup chats.
|
||||
func RequireGroupChat[T AppData]() Policy[T] {
|
||||
return func(ctx *MsgContext, data T) error {
|
||||
return func(ctx *MessageContext, data T) error {
|
||||
if ctx.Msg == nil || ctx.Msg.Chat == nil {
|
||||
return AsInternalError(errors.New("group-chat policy requires message chat context"))
|
||||
}
|
||||
@@ -123,7 +123,7 @@ func RequireGroupChat[T AppData]() Policy[T] {
|
||||
|
||||
// RequireSupergroupChat allows execution only in supergroup chats.
|
||||
func RequireSupergroupChat[T AppData]() Policy[T] {
|
||||
return func(ctx *MsgContext, data T) error {
|
||||
return func(ctx *MessageContext, data T) error {
|
||||
if ctx.Msg == nil || ctx.Msg.Chat == nil {
|
||||
return AsInternalError(errors.New("supergroup-chat policy requires message chat context"))
|
||||
}
|
||||
@@ -138,12 +138,12 @@ func RequireSupergroupChat[T AppData]() Policy[T] {
|
||||
|
||||
// RequireChatAdmin allows execution only for chat administrators or owners.
|
||||
func RequireChatAdmin[T AppData]() Policy[T] {
|
||||
return func(ctx *MsgContext, data T) error {
|
||||
return func(ctx *MessageContext, 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{
|
||||
member, err := ctx.API.GetChatMemberWithContext(ctx.Context(), tgapi.GetChatMember{
|
||||
ChatID: ctx.ChatID,
|
||||
UserID: ctx.FromID,
|
||||
})
|
||||
@@ -161,12 +161,12 @@ func RequireChatAdmin[T AppData]() Policy[T] {
|
||||
|
||||
// RequireChatCreator allows execution only for the chat owner.
|
||||
func RequireChatCreator[T AppData]() Policy[T] {
|
||||
return func(ctx *MsgContext, data T) error {
|
||||
return func(ctx *MessageContext, 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{
|
||||
member, err := ctx.API.GetChatMemberWithContext(ctx.Context(), tgapi.GetChatMember{
|
||||
ChatID: ctx.ChatID,
|
||||
UserID: ctx.FromID,
|
||||
})
|
||||
@@ -184,19 +184,16 @@ func RequireChatCreator[T AppData]() Policy[T] {
|
||||
|
||||
// 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 {
|
||||
return func(ctx *MessageContext, 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))
|
||||
if ctx.botID == 0 {
|
||||
return AsInternalError(errors.New("bot ID is not set in context"))
|
||||
}
|
||||
|
||||
member, err := ctx.Api.GetChatMember(tgapi.GetChatMember{
|
||||
ChatID: ctx.ChatID,
|
||||
UserID: bot.ID,
|
||||
member, err := ctx.API.GetChatMemberWithContext(ctx.Context(), tgapi.GetChatMember{
|
||||
ChatID: ctx.ChatID, UserID: ctx.botID,
|
||||
})
|
||||
if err != nil {
|
||||
return AsInternalError(fmt.Errorf("failed to fetch bot member status: %w", err))
|
||||
@@ -212,7 +209,7 @@ func RequireBotAdmin[T AppData]() Policy[T] {
|
||||
|
||||
// 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 {
|
||||
return func(ctx *MessageContext, data T) error {
|
||||
if ctx.Update.CallbackQuery == nil {
|
||||
return AsInternalError(errors.New("callback-user policy requires callback query context"))
|
||||
}
|
||||
|
||||
+74
-37
@@ -10,7 +10,7 @@ import (
|
||||
"testing"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/slog"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
func TestRequirePolicyStopsExecutionOnDeniedPolicy(t *testing.T) {
|
||||
@@ -37,7 +37,7 @@ func TestRequirePolicyStopsExecutionOnDeniedPolicy(t *testing.T) {
|
||||
|
||||
api := tgapi.NewAPI(
|
||||
tgapi.NewAPIOpts("token").
|
||||
SetAPIUrl("https://example.test").
|
||||
SetAPIURL("https://example.test").
|
||||
SetHTTPClient(client),
|
||||
)
|
||||
defer func() {
|
||||
@@ -46,14 +46,14 @@ func TestRequirePolicyStopsExecutionOnDeniedPolicy(t *testing.T) {
|
||||
}
|
||||
}()
|
||||
|
||||
ctx := &MsgContext{
|
||||
Api: api,
|
||||
ctx := &MessageContext{
|
||||
API: api,
|
||||
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate}},
|
||||
Logger: slog.CreateLogger(),
|
||||
Logger: sneklog.NewLogger(),
|
||||
errorTemplate: "Error: %s",
|
||||
}
|
||||
|
||||
mw := RequirePolicy("deny", func(ctx *MsgContext, data NoData) error {
|
||||
mw := RequirePolicy("deny", func(ctx *MessageContext, data NoData) error {
|
||||
return AsUserError(errors.New("blocked"))
|
||||
})
|
||||
|
||||
@@ -69,11 +69,11 @@ func TestRequirePolicyStopsExecutionOnDeniedPolicy(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestRequirePrivateChatAllowsPrivateChat(t *testing.T) {
|
||||
ctx := &MsgContext{
|
||||
ctx := &MessageContext{
|
||||
Msg: &tgapi.Message{
|
||||
Chat: &tgapi.Chat{ID: 42, Type: tgapi.ChatTypePrivate},
|
||||
},
|
||||
Logger: slog.CreateLogger(),
|
||||
Logger: sneklog.NewLogger(),
|
||||
}
|
||||
|
||||
if err := RequirePrivateChat[NoData]()(ctx, NoData{}); err != nil {
|
||||
@@ -82,11 +82,11 @@ func TestRequirePrivateChatAllowsPrivateChat(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestRequirePrivateChatDeniesNonPrivateChat(t *testing.T) {
|
||||
ctx := &MsgContext{
|
||||
ctx := &MessageContext{
|
||||
Msg: &tgapi.Message{
|
||||
Chat: &tgapi.Chat{ID: -100, Type: tgapi.ChatTypeSupergroup},
|
||||
},
|
||||
Logger: slog.CreateLogger(),
|
||||
Logger: sneklog.NewLogger(),
|
||||
}
|
||||
|
||||
err := RequirePrivateChat[NoData]()(ctx, NoData{})
|
||||
@@ -127,7 +127,7 @@ func TestRequireChatAdminUsesNormalizedIDs(t *testing.T) {
|
||||
|
||||
api := tgapi.NewAPI(
|
||||
tgapi.NewAPIOpts("token").
|
||||
SetAPIUrl("https://example.test").
|
||||
SetAPIURL("https://example.test").
|
||||
SetHTTPClient(client),
|
||||
)
|
||||
defer func() {
|
||||
@@ -136,11 +136,11 @@ func TestRequireChatAdminUsesNormalizedIDs(t *testing.T) {
|
||||
}
|
||||
}()
|
||||
|
||||
ctx := &MsgContext{
|
||||
Api: api,
|
||||
ctx := &MessageContext{
|
||||
API: api,
|
||||
ChatID: -2001,
|
||||
FromID: 55,
|
||||
Logger: slog.CreateLogger(),
|
||||
Logger: sneklog.NewLogger(),
|
||||
}
|
||||
|
||||
if err := RequireChatAdmin[NoData]()(ctx, NoData{}); err != nil {
|
||||
@@ -157,18 +157,55 @@ func TestRequireChatAdminUsesNormalizedIDs(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestRequireChatAdminUsesMessageContextCancellation(t *testing.T) {
|
||||
api := tgapi.NewAPI(
|
||||
tgapi.NewAPIOpts("token").
|
||||
SetAPIURL("https://example.test").
|
||||
SetHTTPClient(&http.Client{Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||
if err := req.Context().Err(); err != nil {
|
||||
return nil, 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
|
||||
})}),
|
||||
)
|
||||
t.Cleanup(func() {
|
||||
if err := api.Close(); err != nil {
|
||||
t.Fatalf("Close returned error: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
requestCtx, cancel := context.WithCancel(context.Background())
|
||||
cancel()
|
||||
ctx := &MessageContext{
|
||||
API: api,
|
||||
ChatID: -2001,
|
||||
FromID: 55,
|
||||
Logger: sneklog.NewLogger(),
|
||||
ctx: requestCtx,
|
||||
}
|
||||
|
||||
err := RequireChatAdmin[NoData]()(ctx, NoData{})
|
||||
if !errors.Is(err, context.Canceled) || !IsInternalError(err) {
|
||||
t.Fatalf("RequireChatAdmin error = %v, want internal context.Canceled", err)
|
||||
}
|
||||
}
|
||||
|
||||
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 {
|
||||
func(ctx *MessageContext, data NoData) error { return nil },
|
||||
func(ctx *MessageContext, data NoData) error { return want },
|
||||
func(ctx *MessageContext, data NoData) error {
|
||||
t.Fatal("unexpected evaluation after first failure")
|
||||
return nil
|
||||
},
|
||||
)
|
||||
|
||||
err := policy(&MsgContext{Logger: slog.CreateLogger()}, NoData{})
|
||||
err := policy(&MessageContext{Logger: sneklog.NewLogger()}, NoData{})
|
||||
if !errors.Is(err, want) {
|
||||
t.Fatalf("expected first policy error, got %v", err)
|
||||
}
|
||||
@@ -176,11 +213,11 @@ func TestAllPoliciesReturnsFirstError(t *testing.T) {
|
||||
|
||||
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 },
|
||||
func(ctx *MessageContext, data NoData) error { return AsInternalError(errors.New("temporary")) },
|
||||
func(ctx *MessageContext, data NoData) error { return nil },
|
||||
)
|
||||
|
||||
if err := policy(&MsgContext{Logger: slog.CreateLogger()}, NoData{}); err != nil {
|
||||
if err := policy(&MessageContext{Logger: sneklog.NewLogger()}, NoData{}); err != nil {
|
||||
t.Fatalf("expected later success to allow access, got %v", err)
|
||||
}
|
||||
}
|
||||
@@ -188,11 +225,11 @@ func TestAnyPolicyAllowsLaterSuccessAfterInternalError(t *testing.T) {
|
||||
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 },
|
||||
func(ctx *MessageContext, data NoData) error { return AsUserError(errors.New("denied")) },
|
||||
func(ctx *MessageContext, data NoData) error { return internal },
|
||||
)
|
||||
|
||||
err := policy(&MsgContext{Logger: slog.CreateLogger()}, NoData{})
|
||||
err := policy(&MessageContext{Logger: sneklog.NewLogger()}, NoData{})
|
||||
if !errors.Is(err, internal) {
|
||||
t.Fatalf("expected internal error, got %v", err)
|
||||
}
|
||||
@@ -201,29 +238,29 @@ func TestAnyPolicyReturnsInternalErrorWhenNonePass(t *testing.T) {
|
||||
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")) },
|
||||
func(ctx *MessageContext, data NoData) error { return first },
|
||||
func(ctx *MessageContext, data NoData) error { return AsUserError(errors.New("second deny")) },
|
||||
)
|
||||
|
||||
err := policy(&MsgContext{Logger: slog.CreateLogger()}, NoData{})
|
||||
err := policy(&MessageContext{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 {
|
||||
inverted := NotPolicy(func(ctx *MessageContext, data NoData) error {
|
||||
return AsUserError(errors.New("denied"))
|
||||
})
|
||||
if err := inverted(&MsgContext{Logger: slog.CreateLogger()}, NoData{}); err != nil {
|
||||
if err := inverted(&MessageContext{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 {
|
||||
preserve := NotPolicy(func(ctx *MessageContext, data NoData) error {
|
||||
return internal
|
||||
})
|
||||
err := preserve(&MsgContext{Logger: slog.CreateLogger()}, NoData{})
|
||||
err := preserve(&MessageContext{Logger: sneklog.NewLogger()}, NoData{})
|
||||
if !errors.Is(err, internal) {
|
||||
t.Fatalf("expected internal error to be preserved, got %v", err)
|
||||
}
|
||||
@@ -232,15 +269,15 @@ func TestNotPolicyInvertsUserDenyButPreservesInternalErrors(t *testing.T) {
|
||||
func TestRequirePolicyEmitsObserverEvents(t *testing.T) {
|
||||
t.Run("allow", func(t *testing.T) {
|
||||
observer := &recordingObserver{}
|
||||
ctx := &MsgContext{
|
||||
Logger: slog.CreateLogger(),
|
||||
ctx := &MessageContext{
|
||||
Logger: sneklog.NewLogger(),
|
||||
ctx: context.Background(),
|
||||
observer: observer,
|
||||
FromID: 10,
|
||||
ChatID: 20,
|
||||
}
|
||||
|
||||
mw := RequirePolicy("allow", func(ctx *MsgContext, data NoData) error {
|
||||
mw := RequirePolicy("allow", func(ctx *MessageContext, data NoData) error {
|
||||
return nil
|
||||
})
|
||||
|
||||
@@ -257,14 +294,14 @@ func TestRequirePolicyEmitsObserverEvents(t *testing.T) {
|
||||
|
||||
t.Run("deny", func(t *testing.T) {
|
||||
observer := &recordingObserver{}
|
||||
ctx := &MsgContext{
|
||||
Logger: slog.CreateLogger(),
|
||||
ctx := &MessageContext{
|
||||
Logger: sneklog.NewLogger(),
|
||||
ctx: context.Background(),
|
||||
observer: observer,
|
||||
errorTemplate: "%s",
|
||||
}
|
||||
|
||||
mw := RequirePolicy("deny", func(ctx *MsgContext, data NoData) error {
|
||||
mw := RequirePolicy("deny", func(ctx *MessageContext, data NoData) error {
|
||||
return AsInternalError(errors.New("blocked"))
|
||||
})
|
||||
|
||||
|
||||
+93
-80
@@ -2,114 +2,121 @@ package laniakea
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"time"
|
||||
)
|
||||
|
||||
// RunnerFn is the function type for a runner. It receives a pointer to
|
||||
// the Bot and returns an error if execution fails.
|
||||
// RunnerFn is the legacy function type for a runner. It receives a pointer to
|
||||
// the Bot and returns an error if execution fails. New blocking or I/O work
|
||||
// should use ContextRunnerFn so runtime cancellation can stop the callback.
|
||||
//
|
||||
// Subject to change in v2: runner callbacks may require context.Context.
|
||||
type RunnerFn[T AppData] func(*Bot[T]) error
|
||||
|
||||
// ContextRunnerFn is a cancelable runner function.
|
||||
// The runtime context is canceled when polling or webhook execution stops.
|
||||
type ContextRunnerFn[T AppData] func(context.Context, *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.
|
||||
// Runners are configured using builder methods Async and Every. Once the
|
||||
// bot's runtime has started executing the runner, it 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.
|
||||
// - every=0, async=true: Run once in a goroutine (non-blocking, default).
|
||||
// - every=0, async=false: Run once synchronously (blocks runtime startup).
|
||||
// - every>0, async=true: Run repeatedly in a goroutine with the given interval.
|
||||
// - every>0, async=false: Invalid configuration — skipped with a 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
|
||||
name string // Human-readable name for logging
|
||||
async bool // If true, runs in a goroutine; else, runs synchronously
|
||||
every time.Duration // Interval between periodic executions; zero means one-shot
|
||||
fn RunnerFn[T] // The function to execute
|
||||
ctxFn ContextRunnerFn[T]
|
||||
}
|
||||
|
||||
func executeRunnerWithContext[T AppData](ctx context.Context, runner Runner[T], bot *Bot[T]) (err error) {
|
||||
defer func() {
|
||||
if recovered := recover(); recovered != nil {
|
||||
err = fmt.Errorf("runner %q panicked: %v", runner.name, recovered)
|
||||
}
|
||||
}()
|
||||
if runner.ctxFn != nil {
|
||||
return runner.ctxFn(ctx, bot)
|
||||
}
|
||||
if runner.fn == nil {
|
||||
return fmt.Errorf("runner %q has no function", runner.name)
|
||||
}
|
||||
return runner.fn(bot)
|
||||
}
|
||||
|
||||
// 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().
|
||||
// The default configuration is async=true and every=0, i.e. a one-shot
|
||||
// goroutine that fires once when the bot runtime starts. Use Async and Every
|
||||
// to customize this. Do not call builder methods concurrently or after the
|
||||
// bot runtime has begun executing runners.
|
||||
//
|
||||
// Subject to change in v2: NewContextRunner may become the primary constructor.
|
||||
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)
|
||||
}
|
||||
return Runner[T]{name: name, fn: fn, async: true, every: 0}
|
||||
}
|
||||
|
||||
// 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
|
||||
// NewContextRunner creates a runner whose callback observes runtime cancellation.
|
||||
// It is the preferred constructor for I/O, blocking, and periodic work.
|
||||
func NewContextRunner[T AppData](name string, fn ContextRunnerFn[T]) Runner[T] {
|
||||
return Runner[T]{name: name, ctxFn: fn, async: true, every: 0}
|
||||
}
|
||||
|
||||
// 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.
|
||||
// Note: periodic runners (Every > 0) require async=true and are skipped with
|
||||
// a warning when async=false.
|
||||
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.
|
||||
// Every sets the interval between repeated executions of a periodic runner.
|
||||
//
|
||||
// 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
|
||||
// A zero value (the default) keeps the runner one-shot. A positive value
|
||||
// schedules the runner to fire repeatedly with the given interval and
|
||||
// requires async=true; periodic sync runners are skipped with a warning.
|
||||
func (r Runner[T]) Every(timeout time.Duration) Runner[T] {
|
||||
r.every = 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.
|
||||
// Execution semantics by configuration:
|
||||
// - every=0, async=true: Runs once in a goroutine; runtime shutdown waits for it.
|
||||
// - every=0, async=false: Runs once synchronously; warns if slower than 2 seconds.
|
||||
// - every>0, async=true: Runs in a loop with the configured interval until ctx.Done().
|
||||
// - every>0, async=false: Skipped with a warning (invalid configuration).
|
||||
//
|
||||
// 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.
|
||||
// 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)
|
||||
if runner.every > 0 && !runner.async {
|
||||
bot.logger.Warnf("Runner %q is periodic but sync; skipping (use Async(true))\n", runner.name)
|
||||
continue
|
||||
}
|
||||
|
||||
if runner.onetime && runner.async {
|
||||
// One-time async: fire and forget
|
||||
if runner.every == 0 && runner.async {
|
||||
// One-time async: non-blocking startup; runtime shutdown waits for completion.
|
||||
bot.runnerOnceWG.Add(1)
|
||||
go func(r Runner[T]) {
|
||||
defer bot.runnerOnceWG.Done()
|
||||
startedAt := time.Now()
|
||||
err := r.fn(bot)
|
||||
err := executeRunnerWithContext(ctx, r, bot)
|
||||
bot.safeEmitEvent(ctx, RunnerFinishedEvent{
|
||||
Name: r.name,
|
||||
Duration: time.Since(startedAt),
|
||||
@@ -126,10 +133,10 @@ func (bot *Bot[T]) ExecRunners(ctx context.Context) {
|
||||
bot.logger.Warnf("Runner %s failed: %s\n", r.name, err)
|
||||
}
|
||||
}(runner)
|
||||
} else if runner.onetime && !runner.async {
|
||||
} else if runner.every == 0 && !runner.async {
|
||||
// One-time sync: block until done
|
||||
t := time.Now()
|
||||
err := runner.fn(bot)
|
||||
err := executeRunnerWithContext(ctx, runner, bot)
|
||||
elapsed := time.Since(t)
|
||||
bot.safeEmitEvent(ctx, RunnerFinishedEvent{
|
||||
Name: runner.name,
|
||||
@@ -149,39 +156,45 @@ func (bot *Bot[T]) ExecRunners(ctx context.Context) {
|
||||
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 {
|
||||
} else if runner.every > 0 && 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)
|
||||
ticker := time.NewTicker(r.every)
|
||||
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,
|
||||
}
|
||||
// When both ctx.Done() and ticker.C are ready at the same
|
||||
// time, Go's select picks one at random. Re-check ctx so a
|
||||
// late tick after cancellation does not fire one extra
|
||||
// invocation past shutdown.
|
||||
if ctx.Err() != nil {
|
||||
return
|
||||
}
|
||||
startedAt := time.Now()
|
||||
err := executeRunnerWithContext(ctx, r, 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,
|
||||
})
|
||||
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)
|
||||
}
|
||||
bot.logger.Warnf("Runner %s failed: %s\n", r.name, err)
|
||||
}
|
||||
}
|
||||
}(runner)
|
||||
}
|
||||
// Note: !onetime && !async is already skipped above
|
||||
}
|
||||
}
|
||||
|
||||
+66
-8
@@ -7,22 +7,22 @@ import (
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/slog"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
type runnerObserver struct {
|
||||
recordingObserver
|
||||
}
|
||||
|
||||
func TestExecRunnersRunsOnetimeSyncRunner(t *testing.T) {
|
||||
func TestExecRunnersRunsOnceSyncRunner(t *testing.T) {
|
||||
var calls atomic.Int32
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
runners: []Runner[NoData]{
|
||||
NewRunner("sync-once", func(*Bot[NoData]) error {
|
||||
calls.Add(1)
|
||||
return nil
|
||||
}).Onetime(true).Async(false),
|
||||
}).Async(false),
|
||||
},
|
||||
}
|
||||
|
||||
@@ -39,14 +39,14 @@ func TestExecRunnersStopsBackgroundRunnerOnCancel(t *testing.T) {
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
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),
|
||||
}).Every(5 * time.Millisecond),
|
||||
},
|
||||
}
|
||||
|
||||
@@ -71,12 +71,12 @@ func TestExecRunnersEmitObserverEvents(t *testing.T) {
|
||||
wantErr := errors.New("runner failed")
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
observer: observer,
|
||||
runners: []Runner[NoData]{
|
||||
NewRunner("sync-once", func(*Bot[NoData]) error {
|
||||
return wantErr
|
||||
}).Onetime(true).Async(false),
|
||||
}).Async(false),
|
||||
},
|
||||
}
|
||||
|
||||
@@ -95,3 +95,61 @@ func TestExecRunnersEmitObserverEvents(t *testing.T) {
|
||||
t.Fatalf("unexpected runner error event: %#v", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestExecRunnersRecoversRunnerPanic(t *testing.T) {
|
||||
observer := &runnerObserver{}
|
||||
bot := &Bot[NoData]{
|
||||
logger: sneklog.NewLogger(),
|
||||
observer: observer,
|
||||
runners: []Runner[NoData]{
|
||||
NewRunner("panic", func(*Bot[NoData]) error {
|
||||
panic("boom")
|
||||
}).Async(false),
|
||||
},
|
||||
}
|
||||
defer func() {
|
||||
if err := bot.logger.Close(); err != nil {
|
||||
t.Fatalf("Close returned error: %v", err)
|
||||
}
|
||||
}()
|
||||
|
||||
bot.ExecRunners(context.Background())
|
||||
|
||||
if len(observer.runners) != 1 || observer.runners[0].Err == nil {
|
||||
t.Fatalf("expected recovered panic in runner event, got %#v", observer.runners)
|
||||
}
|
||||
if len(observer.errors) != 1 || observer.errors[0].Err == nil {
|
||||
t.Fatalf("expected recovered panic in error event, got %#v", observer.errors)
|
||||
}
|
||||
}
|
||||
|
||||
func TestContextRunnerStopsActiveCallbackOnCancel(t *testing.T) {
|
||||
started := make(chan struct{})
|
||||
stopped := make(chan struct{})
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
bot := &Bot[NoData]{
|
||||
logger: sneklog.NewLogger(),
|
||||
runners: []Runner[NoData]{
|
||||
NewContextRunner("cancelable", func(ctx context.Context, _ *Bot[NoData]) error {
|
||||
close(started)
|
||||
<-ctx.Done()
|
||||
close(stopped)
|
||||
return ctx.Err()
|
||||
}),
|
||||
},
|
||||
}
|
||||
|
||||
bot.ExecRunners(ctx)
|
||||
select {
|
||||
case <-started:
|
||||
case <-time.After(time.Second):
|
||||
t.Fatal("context runner did not start")
|
||||
}
|
||||
cancel()
|
||||
bot.runnerOnceWG.Wait()
|
||||
select {
|
||||
case <-stopped:
|
||||
default:
|
||||
t.Fatal("context runner did not observe cancellation")
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,10 @@
|
||||
package laniakea
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"maps"
|
||||
"sync"
|
||||
)
|
||||
|
||||
@@ -10,61 +13,74 @@ 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
|
||||
name string
|
||||
scope SceneScope
|
||||
entry string
|
||||
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: "",
|
||||
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
|
||||
s.scope = scope
|
||||
return s
|
||||
}
|
||||
|
||||
// SetEntry sets the initial step entered by MsgContext.EnterScene.
|
||||
// SetEntry sets the initial step entered by MessageContext.EnterScene.
|
||||
func (s *Scene[T]) SetEntry(step string) *Scene[T] {
|
||||
s.Entry = step
|
||||
s.entry = step
|
||||
return s
|
||||
}
|
||||
|
||||
func (s *Scene[T]) setPluginName(name string) *Scene[T] {
|
||||
s.PluginName = name
|
||||
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] {
|
||||
if handler == nil {
|
||||
return s
|
||||
}
|
||||
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] {
|
||||
if handler == nil {
|
||||
return s
|
||||
}
|
||||
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] {
|
||||
if handler == nil {
|
||||
return s
|
||||
}
|
||||
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
|
||||
@@ -76,7 +92,15 @@ func (s *Scene[T]) executeCommand(cmd string, ctx *SceneContext, db T) (SceneRes
|
||||
if !ok {
|
||||
return SceneResult{}, false, nil
|
||||
}
|
||||
result, err := handler(ctx, db)
|
||||
result, err := callSceneHandler(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 := callSceneHandler(handler, ctx, db)
|
||||
return result, true, err
|
||||
}
|
||||
func (s *Scene[T]) executeStep(step string, ctx *SceneContext, db T) (SceneResult, bool, error) {
|
||||
@@ -84,53 +108,82 @@ func (s *Scene[T]) executeStep(step string, ctx *SceneContext, db T) (SceneResul
|
||||
if !ok {
|
||||
return SceneResult{}, false, nil
|
||||
}
|
||||
result, err := handler(ctx, db)
|
||||
result, err := callSceneHandler(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)
|
||||
result, err := callSceneHandler(s.message, ctx, db)
|
||||
return result, true, err
|
||||
}
|
||||
|
||||
func callSceneHandler[T any](handler SceneHandler[T], ctx *SceneContext, db T) (result SceneResult, err error) {
|
||||
if handler == nil {
|
||||
return SceneResult{}, ErrHandlerExecutorNil
|
||||
}
|
||||
defer func() {
|
||||
if recovered := recover(); recovered != nil {
|
||||
result = SceneResult{}
|
||||
err = fmt.Errorf("%w: %v", ErrHandlerPanic, recovered)
|
||||
}
|
||||
}()
|
||||
return handler(ctx, db)
|
||||
}
|
||||
|
||||
func (s *Scene[T]) clone() *Scene[T] {
|
||||
if s == nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
cloned := *s
|
||||
cloned.steps = make(map[string]SceneHandler[T], len(s.steps))
|
||||
cloned.commands = make(map[string]SceneHandler[T], len(s.commands))
|
||||
cloned.payloads = make(map[string]SceneHandler[T], len(s.payloads))
|
||||
|
||||
maps.Copy(cloned.steps, s.steps)
|
||||
maps.Copy(cloned.commands, s.commands)
|
||||
maps.Copy(cloned.payloads, s.payloads)
|
||||
|
||||
return &cloned
|
||||
}
|
||||
|
||||
// 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
|
||||
data []byte
|
||||
}
|
||||
|
||||
// SetData stores arbitrary opaque session data.
|
||||
func (s *SceneSession) SetData(data []byte) {
|
||||
s.Data = data
|
||||
s.data = bytes.Clone(data)
|
||||
}
|
||||
|
||||
// GetData returns the raw session data payload.
|
||||
func (s *SceneSession) GetData() []byte {
|
||||
return s.Data
|
||||
return bytes.Clone(s.data)
|
||||
}
|
||||
|
||||
// HasData reports whether the session has a non-empty data payload.
|
||||
func (s *SceneSession) HasData() bool {
|
||||
return len(s.Data) > 0
|
||||
return len(s.data) > 0
|
||||
}
|
||||
|
||||
// ClearData removes any stored session data.
|
||||
func (s *SceneSession) ClearData() {
|
||||
s.Data = nil
|
||||
s.data = nil
|
||||
}
|
||||
|
||||
// BindData unmarshals the stored JSON payload into v.
|
||||
func (s *SceneSession) BindData(v any) error {
|
||||
if len(s.Data) == 0 {
|
||||
if len(s.data) == 0 {
|
||||
return nil
|
||||
}
|
||||
return json.Unmarshal(s.Data, v)
|
||||
return json.Unmarshal(s.data, v)
|
||||
}
|
||||
|
||||
// SaveData marshals v as JSON and stores it in the session.
|
||||
@@ -139,7 +192,7 @@ func (s *SceneSession) SaveData(v any) error {
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
s.Data = data
|
||||
s.data = data
|
||||
return nil
|
||||
}
|
||||
|
||||
@@ -168,6 +221,7 @@ func (s *MemorySessionStore) Get(key string) (SceneSession, error) {
|
||||
s.mu.RLock()
|
||||
defer s.mu.RUnlock()
|
||||
if session, ok := s.store[key]; ok {
|
||||
session.data = bytes.Clone(session.data)
|
||||
return session, nil
|
||||
}
|
||||
return SceneSession{}, nil
|
||||
@@ -175,6 +229,7 @@ func (s *MemorySessionStore) Get(key string) (SceneSession, error) {
|
||||
|
||||
// Set stores session under key.
|
||||
func (s *MemorySessionStore) Set(key string, session SceneSession) error {
|
||||
session.data = bytes.Clone(session.data)
|
||||
s.mu.Lock()
|
||||
s.store[key] = session
|
||||
s.mu.Unlock()
|
||||
@@ -191,8 +246,10 @@ func (s *MemorySessionStore) Delete(key string) error {
|
||||
|
||||
// SceneResult describes how scene execution should proceed after a handler returns.
|
||||
type SceneResult struct {
|
||||
// Action controls the scene state transition.
|
||||
Action SceneAction
|
||||
Next string
|
||||
// Next names the destination step for SceneActionNext.
|
||||
Next string
|
||||
}
|
||||
|
||||
// SceneAction controls how the bot updates scene state after a handler returns.
|
||||
@@ -226,8 +283,7 @@ type sceneRuntime interface {
|
||||
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)
|
||||
findSceneSession(ctx *MessageContext) (string, SceneSession, error)
|
||||
}
|
||||
|
||||
type sceneMeta struct {
|
||||
|
||||
+2
-2
@@ -1,8 +1,8 @@
|
||||
package laniakea
|
||||
|
||||
// SceneContext wraps MsgContext with scene session state for scene handlers.
|
||||
// SceneContext wraps MessageContext with scene session state for scene handlers.
|
||||
type SceneContext struct {
|
||||
*MsgContext
|
||||
*MessageContext
|
||||
sess SceneSession
|
||||
key string
|
||||
}
|
||||
|
||||
+88
-34
@@ -1,39 +1,52 @@
|
||||
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
|
||||
func (bot *Bot[T]) tryHandleScene(ctx *MessageContext) (bool, error) {
|
||||
for _, scope := range bot.sceneScopePriority {
|
||||
key, ok := buildSceneKey(scope, ctx)
|
||||
if !ok {
|
||||
continue
|
||||
}
|
||||
return false, err
|
||||
}
|
||||
if session.Scene == "" {
|
||||
return false, nil
|
||||
}
|
||||
|
||||
unlock := bot.sceneLocks.lock([]string{key})
|
||||
session, err := bot.sessionStore.Get(key)
|
||||
if err != nil {
|
||||
unlock()
|
||||
return false, err
|
||||
}
|
||||
if session.Scene == "" {
|
||||
unlock()
|
||||
continue
|
||||
}
|
||||
|
||||
handled, err := bot.tryHandleSceneSession(ctx, key, session)
|
||||
unlock()
|
||||
return handled, err
|
||||
}
|
||||
return false, nil
|
||||
}
|
||||
|
||||
func (bot *Bot[T]) tryHandleSceneSession(ctx *MessageContext, key string, session SceneSession) (bool, error) {
|
||||
for _, plugin := range bot.plugins {
|
||||
scene, ok := plugin.scenes[session.Scene]
|
||||
if !ok {
|
||||
continue
|
||||
}
|
||||
if scene.PluginName != "" && scene.PluginName != plugin.name {
|
||||
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,
|
||||
MessageContext: ctx,
|
||||
sess: session,
|
||||
key: key,
|
||||
}
|
||||
|
||||
return bot.executeScene(sceneCtx, scene)
|
||||
@@ -42,7 +55,7 @@ func (bot *Bot[T]) tryHandleScene(ctx *MsgContext) (bool, error) {
|
||||
}
|
||||
|
||||
func (bot *Bot[T]) executeScene(ctx *SceneContext, scene *Scene[T]) (bool, error) {
|
||||
if ctx.MsgContext == nil || ctx.sess.Scene == "" {
|
||||
if ctx.MessageContext == nil || ctx.sess.Scene == "" {
|
||||
return false, nil
|
||||
}
|
||||
|
||||
@@ -67,14 +80,13 @@ func (bot *Bot[T]) executeScene(ctx *SceneContext, scene *Scene[T]) (bool, error
|
||||
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
|
||||
return false, bot.emitSceneError(ctx, scene, HandlerSceneCommandKind, cmd, 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)
|
||||
err = bot.emitSceneError(ctx, scene, HandlerSceneCommandKind, cmd, err)
|
||||
}
|
||||
if ok {
|
||||
bot.emitSceneTransition(ctx, scene, from, res)
|
||||
@@ -86,6 +98,40 @@ func (bot *Bot[T]) executeScene(ctx *SceneContext, scene *Scene[T]) (bool, error
|
||||
// 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)
|
||||
return false, bot.emitSceneError(ctx, scene, HandlerScenePayloadKind, cmd, err)
|
||||
}
|
||||
from := ctx.sess.Step
|
||||
ok, err := bot.applySceneResult(scene, ctx, res)
|
||||
bot.emitSceneFinished(ctx, scene, HandlerScenePayloadKind, cmd, startTime, err)
|
||||
if err != nil {
|
||||
err = 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 = ""
|
||||
@@ -97,14 +143,13 @@ func (bot *Bot[T]) executeScene(ctx *SceneContext, scene *Scene[T]) (bool, error
|
||||
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
|
||||
return false, bot.emitSceneError(ctx, scene, HandlerSceneStepKind, step, 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)
|
||||
err = bot.emitSceneError(ctx, scene, HandlerSceneStepKind, from, err)
|
||||
}
|
||||
if ok {
|
||||
bot.emitSceneTransition(ctx, scene, from, res)
|
||||
@@ -119,14 +164,13 @@ func (bot *Bot[T]) executeScene(ctx *SceneContext, scene *Scene[T]) (bool, error
|
||||
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
|
||||
return false, bot.emitSceneError(ctx, scene, HandlerSceneMessageKind, "message_fallback", 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)
|
||||
err = bot.emitSceneError(ctx, scene, HandlerSceneMessageKind, "message_fallback", err)
|
||||
}
|
||||
if ok {
|
||||
bot.emitSceneTransition(ctx, scene, from, res)
|
||||
@@ -141,7 +185,7 @@ func (bot *Bot[T]) emitSceneStarted(ctx *SceneContext, scene *Scene[T], kind Han
|
||||
bot.safeEmitEvent(ctx.Context(), HandlerStartedEvent{
|
||||
UpdateID: ctx.Update.UpdateID,
|
||||
UpdateType: ctx.Update.Type,
|
||||
Plugin: scene.PluginName,
|
||||
Plugin: scene.pluginName,
|
||||
HandlerKind: kind,
|
||||
HandlerName: name,
|
||||
FromID: ctx.FromID,
|
||||
@@ -153,7 +197,7 @@ func (bot *Bot[T]) emitSceneFinished(ctx *SceneContext, scene *Scene[T], kind Ha
|
||||
bot.safeEmitEvent(ctx.Context(), HandlerFinishedEvent{
|
||||
UpdateID: ctx.Update.UpdateID,
|
||||
UpdateType: ctx.Update.Type,
|
||||
Plugin: scene.PluginName,
|
||||
Plugin: scene.pluginName,
|
||||
HandlerKind: kind,
|
||||
HandlerName: name,
|
||||
FromID: ctx.FromID,
|
||||
@@ -164,11 +208,18 @@ func (bot *Bot[T]) emitSceneFinished(ctx *SceneContext, scene *Scene[T], kind Ha
|
||||
})
|
||||
}
|
||||
|
||||
func (bot *Bot[T]) emitSceneError(ctx *SceneContext, scene *Scene[T], kind HandlerEventKind, name string, err error) {
|
||||
type reportedSceneError struct {
|
||||
err error
|
||||
}
|
||||
|
||||
func (e *reportedSceneError) Error() string { return e.err.Error() }
|
||||
func (e *reportedSceneError) Unwrap() error { return e.err }
|
||||
|
||||
func (bot *Bot[T]) emitSceneError(ctx *SceneContext, scene *Scene[T], kind HandlerEventKind, name string, err error) error {
|
||||
bot.safeEmitEvent(ctx.Context(), ErrorEvent{
|
||||
UpdateID: ctx.Update.UpdateID,
|
||||
UpdateType: ctx.Update.Type,
|
||||
Plugin: scene.PluginName,
|
||||
Plugin: scene.pluginName,
|
||||
HandlerKind: kind,
|
||||
HandlerName: name,
|
||||
FromID: ctx.FromID,
|
||||
@@ -176,6 +227,7 @@ func (bot *Bot[T]) emitSceneError(ctx *SceneContext, scene *Scene[T], kind Handl
|
||||
Err: err,
|
||||
UserFacing: IsUserError(err),
|
||||
})
|
||||
return &reportedSceneError{err: err}
|
||||
}
|
||||
|
||||
func (bot *Bot[T]) emitSceneTransition(ctx *SceneContext, scene *Scene[T], from string, result SceneResult) {
|
||||
@@ -183,17 +235,19 @@ func (bot *Bot[T]) emitSceneTransition(ctx *SceneContext, scene *Scene[T], from
|
||||
return
|
||||
}
|
||||
|
||||
to := from
|
||||
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,
|
||||
Plugin: scene.pluginName,
|
||||
Scene: scene.name,
|
||||
From: from,
|
||||
To: to,
|
||||
Action: result.Action,
|
||||
@@ -229,10 +283,10 @@ func (bot *Bot[T]) applySceneResult(scene *Scene[T], ctx *SceneContext, result S
|
||||
case SceneActionPass:
|
||||
return false, nil
|
||||
default:
|
||||
return false, nil
|
||||
return false, fmt.Errorf("%w: %v", ErrInvalidSceneAction, result.Action)
|
||||
}
|
||||
}
|
||||
func buildSceneKey(scope SceneScope, ctx *MsgContext) (string, bool) {
|
||||
func buildSceneKey(scope SceneScope, ctx *MessageContext) (string, bool) {
|
||||
if ctx == nil {
|
||||
return "", false
|
||||
}
|
||||
|
||||
@@ -0,0 +1,70 @@
|
||||
package laniakea
|
||||
|
||||
import (
|
||||
"sort"
|
||||
"sync"
|
||||
)
|
||||
|
||||
type sceneLockEntry struct {
|
||||
mu sync.Mutex
|
||||
refs int
|
||||
}
|
||||
|
||||
type sceneKeyLocker struct {
|
||||
mu sync.Mutex
|
||||
entries map[string]*sceneLockEntry
|
||||
}
|
||||
|
||||
func (l *sceneKeyLocker) lock(keys []string) func() {
|
||||
keys = uniqueSortedStrings(keys)
|
||||
if len(keys) == 0 {
|
||||
return func() {}
|
||||
}
|
||||
|
||||
l.mu.Lock()
|
||||
if l.entries == nil {
|
||||
l.entries = make(map[string]*sceneLockEntry)
|
||||
}
|
||||
entries := make([]*sceneLockEntry, len(keys))
|
||||
for i, key := range keys {
|
||||
entry := l.entries[key]
|
||||
if entry == nil {
|
||||
entry = new(sceneLockEntry)
|
||||
l.entries[key] = entry
|
||||
}
|
||||
entry.refs++
|
||||
entries[i] = entry
|
||||
}
|
||||
l.mu.Unlock()
|
||||
|
||||
for _, entry := range entries {
|
||||
entry.mu.Lock()
|
||||
}
|
||||
|
||||
return func() {
|
||||
for i := len(entries) - 1; i >= 0; i-- {
|
||||
entries[i].mu.Unlock()
|
||||
}
|
||||
|
||||
l.mu.Lock()
|
||||
for i, key := range keys {
|
||||
entries[i].refs--
|
||||
if entries[i].refs == 0 {
|
||||
delete(l.entries, key)
|
||||
}
|
||||
}
|
||||
l.mu.Unlock()
|
||||
}
|
||||
}
|
||||
|
||||
func uniqueSortedStrings(values []string) []string {
|
||||
sort.Strings(values)
|
||||
result := values[:0]
|
||||
for _, value := range values {
|
||||
if value == "" || len(result) > 0 && result[len(result)-1] == value {
|
||||
continue
|
||||
}
|
||||
result = append(result, value)
|
||||
}
|
||||
return result
|
||||
}
|
||||
+417
-58
@@ -3,10 +3,13 @@ package laniakea
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"sync"
|
||||
"sync/atomic"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/tgapi"
|
||||
"git.scuroneko.dev/scuroneko/slog"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
type failingSessionStore struct {
|
||||
@@ -15,15 +18,15 @@ type failingSessionStore struct {
|
||||
deleteErr error
|
||||
}
|
||||
|
||||
func (s failingSessionStore) Get(key string) (SceneSession, error) {
|
||||
func (s failingSessionStore) Get(string) (SceneSession, error) {
|
||||
return SceneSession{}, s.getErr
|
||||
}
|
||||
|
||||
func (s failingSessionStore) Set(key string, session SceneSession) error {
|
||||
func (s failingSessionStore) Set(string, SceneSession) error {
|
||||
return s.setErr
|
||||
}
|
||||
|
||||
func (s failingSessionStore) Delete(key string) error {
|
||||
func (s failingSessionStore) Delete(string) error {
|
||||
return s.deleteErr
|
||||
}
|
||||
|
||||
@@ -36,8 +39,116 @@ func TestPluginAddSceneRegistersScene(t *testing.T) {
|
||||
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")
|
||||
if scene.pluginName != "wizard" {
|
||||
t.Fatalf("unexpected plugin name on scene: got %q want %q", scene.pluginName, "wizard")
|
||||
}
|
||||
}
|
||||
|
||||
func TestBotAddPluginsSkipsDuplicateSceneNames(t *testing.T) {
|
||||
first := NewPlugin[NoData]("first")
|
||||
first.Scene("shared")
|
||||
second := NewPlugin[NoData]("second")
|
||||
second.Scene("shared")
|
||||
|
||||
bot := &Bot[NoData]{logger: sneklog.NewLogger()}
|
||||
bot.AddPlugins(first, second)
|
||||
|
||||
if _, ok := bot.plugins[0].scenes["shared"]; !ok {
|
||||
t.Fatal("first registered scene was removed")
|
||||
}
|
||||
if _, ok := bot.plugins[1].scenes["shared"]; ok {
|
||||
t.Fatal("duplicate scene was registered")
|
||||
}
|
||||
}
|
||||
|
||||
func TestSceneUpdatesForSameSessionAreSerialized(t *testing.T) {
|
||||
entered := make(chan int, 2)
|
||||
releaseFirst := make(chan struct{})
|
||||
var calls atomic.Int64
|
||||
|
||||
plugin := NewPlugin[NoData]("wizard")
|
||||
plugin.Scene("counter").
|
||||
SetEntry("start").
|
||||
OnStep("start", func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||
var value int
|
||||
if err := ctx.BindData(&value); err != nil {
|
||||
return SceneResult{}, err
|
||||
}
|
||||
call := int(calls.Add(1))
|
||||
entered <- call
|
||||
if call == 1 {
|
||||
<-releaseFirst
|
||||
}
|
||||
value++
|
||||
if err := ctx.SaveData(value); err != nil {
|
||||
return SceneResult{}, err
|
||||
}
|
||||
return ctx.Stay(), nil
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: sneklog.NewLogger(),
|
||||
prefixes: []string{"/"},
|
||||
sessionStore: NewMemorySessionStore(),
|
||||
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||
}
|
||||
bot.AddPlugins(plugin)
|
||||
key := "user_id:42:chat_id:100"
|
||||
session := SceneSession{Scene: "counter", Step: "start"}
|
||||
if err := session.SaveData(0); err != nil {
|
||||
t.Fatalf("SaveData returned error: %v", err)
|
||||
}
|
||||
if err := bot.sessionStore.Set(key, session); err != nil {
|
||||
t.Fatalf("Set returned error: %v", err)
|
||||
}
|
||||
|
||||
update := func(id int) *tgapi.Update {
|
||||
return &tgapi.Update{
|
||||
UpdateID: id,
|
||||
Type: tgapi.UpdateTypeMessage,
|
||||
Message: &tgapi.Message{
|
||||
MessageID: id,
|
||||
Text: "increment",
|
||||
Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate},
|
||||
From: &tgapi.User{ID: 42},
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
var wg sync.WaitGroup
|
||||
wg.Add(2)
|
||||
go func() {
|
||||
defer wg.Done()
|
||||
bot.handle(context.Background(), update(1))
|
||||
}()
|
||||
if got := <-entered; got != 1 {
|
||||
t.Fatalf("first handler call = %d, want 1", got)
|
||||
}
|
||||
go func() {
|
||||
defer wg.Done()
|
||||
bot.handle(context.Background(), update(2))
|
||||
}()
|
||||
select {
|
||||
case call := <-entered:
|
||||
t.Fatalf("second handler entered before first completed: call %d", call)
|
||||
case <-time.After(50 * time.Millisecond):
|
||||
}
|
||||
close(releaseFirst)
|
||||
if got := <-entered; got != 2 {
|
||||
t.Fatalf("second handler call = %d, want 2", got)
|
||||
}
|
||||
wg.Wait()
|
||||
|
||||
got, err := bot.sessionStore.Get(key)
|
||||
if err != nil {
|
||||
t.Fatalf("Get returned error: %v", err)
|
||||
}
|
||||
var value int
|
||||
if err := got.BindData(&value); err != nil {
|
||||
t.Fatalf("BindData returned error: %v", err)
|
||||
}
|
||||
if value != 2 {
|
||||
t.Fatalf("session value = %d, want 2", value)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -45,7 +156,7 @@ func TestBotAddPluginsPreservesScenesAndHandlesThem(t *testing.T) {
|
||||
called := false
|
||||
|
||||
plugin := NewPlugin[NoData]("wizard")
|
||||
plugin.NewScene("signup").
|
||||
plugin.Scene("signup").
|
||||
SetEntry("start").
|
||||
OnStep("start", func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||
called = true
|
||||
@@ -56,7 +167,7 @@ func TestBotAddPluginsPreservesScenesAndHandlesThem(t *testing.T) {
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
prefixes: []string{"/"},
|
||||
sessionStore: NewMemorySessionStore(),
|
||||
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||
@@ -71,7 +182,7 @@ func TestBotAddPluginsPreservesScenesAndHandlesThem(t *testing.T) {
|
||||
t.Fatalf("unexpected scene entry: got %q want %q", sceneMeta.Entry, "start")
|
||||
}
|
||||
|
||||
enterCtx := &MsgContext{
|
||||
enterCtx := &MessageContext{
|
||||
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||
FromID: 42,
|
||||
sceneRuntime: bot,
|
||||
@@ -95,7 +206,7 @@ func TestBotAddPluginsPreservesScenesAndHandlesThem(t *testing.T) {
|
||||
t.Fatal("expected scene step handler to be called")
|
||||
}
|
||||
|
||||
lookupCtx := &MsgContext{
|
||||
lookupCtx := &MessageContext{
|
||||
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||
FromID: 42,
|
||||
}
|
||||
@@ -108,7 +219,7 @@ func TestBuildSceneKeyRejectsMissingContextFields(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
scope SceneScope
|
||||
ctx *MsgContext
|
||||
ctx *MessageContext
|
||||
}{
|
||||
{
|
||||
name: "nil context",
|
||||
@@ -118,17 +229,17 @@ func TestBuildSceneKeyRejectsMissingContextFields(t *testing.T) {
|
||||
{
|
||||
name: "missing message for chat scope",
|
||||
scope: SceneScopeChat,
|
||||
ctx: &MsgContext{},
|
||||
ctx: &MessageContext{},
|
||||
},
|
||||
{
|
||||
name: "missing from id for user scope",
|
||||
scope: SceneScopeUser,
|
||||
ctx: &MsgContext{},
|
||||
ctx: &MessageContext{},
|
||||
},
|
||||
{
|
||||
name: "missing from id for user chat scope",
|
||||
scope: SceneScopeUserChat,
|
||||
ctx: &MsgContext{
|
||||
ctx: &MessageContext{
|
||||
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||
},
|
||||
},
|
||||
@@ -146,16 +257,16 @@ func TestBuildSceneKeyRejectsMissingContextFields(t *testing.T) {
|
||||
func TestEnterSceneRejectsMissingEntryConfiguration(t *testing.T) {
|
||||
t.Run("empty entry", func(t *testing.T) {
|
||||
plugin := NewPlugin[NoData]("wizard")
|
||||
plugin.NewScene("signup")
|
||||
plugin.Scene("signup")
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
sessionStore: NewMemorySessionStore(),
|
||||
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||
}
|
||||
bot.AddPlugins(plugin)
|
||||
|
||||
ctx := &MsgContext{
|
||||
ctx := &MessageContext{
|
||||
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||
FromID: 42,
|
||||
sceneRuntime: bot,
|
||||
@@ -169,16 +280,16 @@ func TestEnterSceneRejectsMissingEntryConfiguration(t *testing.T) {
|
||||
|
||||
t.Run("missing entry step", func(t *testing.T) {
|
||||
plugin := NewPlugin[NoData]("wizard")
|
||||
plugin.NewScene("signup").SetEntry("start")
|
||||
plugin.Scene("signup").SetEntry("start")
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
sessionStore: NewMemorySessionStore(),
|
||||
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||
}
|
||||
bot.AddPlugins(plugin)
|
||||
|
||||
ctx := &MsgContext{
|
||||
ctx := &MessageContext{
|
||||
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||
FromID: 42,
|
||||
sceneRuntime: bot,
|
||||
@@ -192,7 +303,7 @@ func TestEnterSceneRejectsMissingEntryConfiguration(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestSceneContextMethodsRequireRuntime(t *testing.T) {
|
||||
ctx := &MsgContext{}
|
||||
ctx := &MessageContext{}
|
||||
|
||||
if err := ctx.EnterScene("signup"); !errors.Is(err, ErrSceneRuntimeNil) {
|
||||
t.Fatalf("expected ErrSceneRuntimeNil from EnterScene, got %v", err)
|
||||
@@ -210,7 +321,7 @@ func TestSceneCommandHandlerRunsBeforeStep(t *testing.T) {
|
||||
stepCalled := false
|
||||
|
||||
plugin := NewPlugin[NoData]("wizard")
|
||||
plugin.NewScene("signup").
|
||||
plugin.Scene("signup").
|
||||
SetEntry("start").
|
||||
OnStep("start", func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||
stepCalled = true
|
||||
@@ -231,14 +342,14 @@ func TestSceneCommandHandlerRunsBeforeStep(t *testing.T) {
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
prefixes: []string{"/"},
|
||||
sessionStore: NewMemorySessionStore(),
|
||||
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||
}
|
||||
bot.AddPlugins(plugin)
|
||||
|
||||
enterCtx := &MsgContext{
|
||||
enterCtx := &MessageContext{
|
||||
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||
FromID: 42,
|
||||
sceneRuntime: bot,
|
||||
@@ -269,7 +380,7 @@ func TestSceneCommandHandlerRunsBeforeStep(t *testing.T) {
|
||||
func TestSceneCommandObserverEmitsLifecycleEvents(t *testing.T) {
|
||||
observer := &recordingObserver{}
|
||||
plugin := NewPlugin[NoData]("wizard")
|
||||
plugin.NewScene("signup").
|
||||
plugin.Scene("signup").
|
||||
SetEntry("start").
|
||||
OnStep("start", func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||
return ctx.Stay(), nil
|
||||
@@ -279,7 +390,7 @@ func TestSceneCommandObserverEmitsLifecycleEvents(t *testing.T) {
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
prefixes: []string{"/"},
|
||||
sessionStore: NewMemorySessionStore(),
|
||||
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||
@@ -287,7 +398,7 @@ func TestSceneCommandObserverEmitsLifecycleEvents(t *testing.T) {
|
||||
}
|
||||
bot.AddPlugins(plugin)
|
||||
|
||||
enterCtx := &MsgContext{
|
||||
enterCtx := &MessageContext{
|
||||
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||
FromID: 42,
|
||||
sceneRuntime: bot,
|
||||
@@ -324,14 +435,14 @@ func TestSceneCommandObserverEmitsLifecycleEvents(t *testing.T) {
|
||||
func TestSceneStepObserverEmitsLifecycleEvents(t *testing.T) {
|
||||
observer := &recordingObserver{}
|
||||
plugin := NewPlugin[NoData]("wizard")
|
||||
plugin.NewScene("signup").
|
||||
plugin.Scene("signup").
|
||||
SetEntry("start").
|
||||
OnStep("start", func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||
return ctx.Stay(), nil
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
prefixes: []string{"/"},
|
||||
sessionStore: NewMemorySessionStore(),
|
||||
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||
@@ -339,7 +450,7 @@ func TestSceneStepObserverEmitsLifecycleEvents(t *testing.T) {
|
||||
}
|
||||
bot.AddPlugins(plugin)
|
||||
|
||||
enterCtx := &MsgContext{
|
||||
enterCtx := &MessageContext{
|
||||
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||
FromID: 42,
|
||||
sceneRuntime: bot,
|
||||
@@ -376,7 +487,7 @@ func TestSceneStepObserverEmitsLifecycleEvents(t *testing.T) {
|
||||
func TestSceneMessageObserverEmitsLifecycleEvents(t *testing.T) {
|
||||
observer := &recordingObserver{}
|
||||
plugin := NewPlugin[NoData]("wizard")
|
||||
scene := plugin.NewScene("signup").
|
||||
scene := plugin.Scene("signup").
|
||||
SetEntry("start").
|
||||
OnStep("start", func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||
return ctx.Stay(), nil
|
||||
@@ -386,7 +497,7 @@ func TestSceneMessageObserverEmitsLifecycleEvents(t *testing.T) {
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
prefixes: []string{"/"},
|
||||
sessionStore: NewMemorySessionStore(),
|
||||
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||
@@ -394,14 +505,14 @@ func TestSceneMessageObserverEmitsLifecycleEvents(t *testing.T) {
|
||||
}
|
||||
bot.AddPlugins(plugin)
|
||||
|
||||
key, ok := buildSceneKey(SceneScopeUserChat, &MsgContext{
|
||||
key, ok := buildSceneKey(SceneScopeUserChat, &MessageContext{
|
||||
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 {
|
||||
if err := bot.sessionStore.Set(key, SceneSession{Scene: scene.name}); err != nil {
|
||||
t.Fatalf("failed to seed scene session: %v", err)
|
||||
}
|
||||
|
||||
@@ -430,15 +541,213 @@ func TestSceneMessageObserverEmitsLifecycleEvents(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestScenePayloadHandlerRunsBeforeStep(t *testing.T) {
|
||||
payloadCalled := false
|
||||
stepCalled := false
|
||||
|
||||
plugin := NewPlugin[NoData]("wizard")
|
||||
plugin.Scene("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 := &MessageContext{
|
||||
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.Scene("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 := &MessageContext{
|
||||
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.Payload("ping", func(ctx *MessageContext, db NoData) error { return nil })
|
||||
plugin.Scene("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 := &MessageContext{
|
||||
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, &MessageContext{
|
||||
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 {
|
||||
plugin.Command("ping", func(ctx *MessageContext, db NoData) error {
|
||||
commandCalled = true
|
||||
return nil
|
||||
}, "ping")
|
||||
plugin.NewScene("signup").
|
||||
})
|
||||
plugin.Scene("signup").
|
||||
SetEntry("start").
|
||||
OnStep("start", func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||
if err := ctx.SaveData(struct {
|
||||
@@ -450,14 +759,14 @@ func TestScenePassDoesNotPersistSessionData(t *testing.T) {
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
prefixes: []string{"/"},
|
||||
sessionStore: NewMemorySessionStore(),
|
||||
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||
}
|
||||
bot.AddPlugins(plugin)
|
||||
|
||||
enterCtx := &MsgContext{
|
||||
enterCtx := &MessageContext{
|
||||
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||
FromID: 42,
|
||||
sceneRuntime: bot,
|
||||
@@ -466,7 +775,7 @@ func TestScenePassDoesNotPersistSessionData(t *testing.T) {
|
||||
t.Fatalf("EnterScene returned error: %v", err)
|
||||
}
|
||||
|
||||
key, ok := buildSceneKey(SceneScopeUserChat, &MsgContext{
|
||||
key, ok := buildSceneKey(SceneScopeUserChat, &MessageContext{
|
||||
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||
FromID: 42,
|
||||
})
|
||||
@@ -514,26 +823,26 @@ func TestSceneUnmatchedCommandFallsThroughWithoutRunningStep(t *testing.T) {
|
||||
stepCalled := false
|
||||
|
||||
plugin := NewPlugin[NoData]("wizard")
|
||||
plugin.NewScene("signup").
|
||||
plugin.Scene("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 {
|
||||
plugin.Command("ping", func(ctx *MessageContext, db NoData) error {
|
||||
commandCalled = true
|
||||
return nil
|
||||
}, "ping")
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
prefixes: []string{"/"},
|
||||
sessionStore: NewMemorySessionStore(),
|
||||
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||
}
|
||||
bot.AddPlugins(plugin)
|
||||
|
||||
enterCtx := &MsgContext{
|
||||
enterCtx := &MessageContext{
|
||||
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||
FromID: 42,
|
||||
sceneRuntime: bot,
|
||||
@@ -542,7 +851,7 @@ func TestSceneUnmatchedCommandFallsThroughWithoutRunningStep(t *testing.T) {
|
||||
t.Fatalf("EnterScene returned error: %v", err)
|
||||
}
|
||||
|
||||
key, ok := buildSceneKey(SceneScopeUserChat, &MsgContext{
|
||||
key, ok := buildSceneKey(SceneScopeUserChat, &MessageContext{
|
||||
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||
FromID: 42,
|
||||
})
|
||||
@@ -581,7 +890,7 @@ func TestSceneMessageFallbackRunsWhenNoCommandOrStepMatch(t *testing.T) {
|
||||
fallbackCalled := false
|
||||
|
||||
plugin := NewPlugin[NoData]("wizard")
|
||||
plugin.NewScene("signup").
|
||||
plugin.Scene("signup").
|
||||
SetEntry("start").
|
||||
OnStep("start", func(ctx *SceneContext, db NoData) (SceneResult, error) {
|
||||
return ctx.Stay(), nil
|
||||
@@ -595,14 +904,14 @@ func TestSceneMessageFallbackRunsWhenNoCommandOrStepMatch(t *testing.T) {
|
||||
})
|
||||
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
prefixes: []string{"/"},
|
||||
sessionStore: NewMemorySessionStore(),
|
||||
sceneScopePriority: []SceneScope{SceneScopeUserChat, SceneScopeChat, SceneScopeUser},
|
||||
}
|
||||
bot.AddPlugins(plugin)
|
||||
|
||||
enterCtx := &MsgContext{
|
||||
enterCtx := &MessageContext{
|
||||
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||
FromID: 42,
|
||||
sceneRuntime: bot,
|
||||
@@ -611,7 +920,7 @@ func TestSceneMessageFallbackRunsWhenNoCommandOrStepMatch(t *testing.T) {
|
||||
t.Fatalf("EnterScene returned error: %v", err)
|
||||
}
|
||||
|
||||
key, ok := buildSceneKey(SceneScopeUserChat, &MsgContext{
|
||||
key, ok := buildSceneKey(SceneScopeUserChat, &MessageContext{
|
||||
Msg: &tgapi.Message{Chat: &tgapi.Chat{ID: 100, Type: tgapi.ChatTypePrivate}},
|
||||
FromID: 42,
|
||||
})
|
||||
@@ -638,9 +947,39 @@ func TestSceneMessageFallbackRunsWhenNoCommandOrStepMatch(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestMemorySessionStoreDoesNotAliasSessionData(t *testing.T) {
|
||||
store := NewMemorySessionStore()
|
||||
input := []byte("initial")
|
||||
session := SceneSession{Scene: "signup"}
|
||||
session.SetData(input)
|
||||
|
||||
input[0] = 'X'
|
||||
if got := string(session.GetData()); got != "initial" {
|
||||
t.Fatalf("SetData retained caller slice: got %q", got)
|
||||
}
|
||||
if err := store.Set("user:1", session); err != nil {
|
||||
t.Fatalf("Set returned error: %v", err)
|
||||
}
|
||||
|
||||
first, err := store.Get("user:1")
|
||||
if err != nil {
|
||||
t.Fatalf("Get returned error: %v", err)
|
||||
}
|
||||
data := first.GetData()
|
||||
data[0] = 'X'
|
||||
|
||||
second, err := store.Get("user:1")
|
||||
if err != nil {
|
||||
t.Fatalf("second Get returned error: %v", err)
|
||||
}
|
||||
if got := string(second.GetData()); got != "initial" {
|
||||
t.Fatalf("Get exposed stored data for mutation: got %q", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestFindSceneSessionSupportsUserScopeWithoutMessage(t *testing.T) {
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
sessionStore: NewMemorySessionStore(),
|
||||
sceneScopePriority: []SceneScope{SceneScopeUser, SceneScopeChat, SceneScopeUserChat},
|
||||
}
|
||||
@@ -649,7 +988,7 @@ func TestFindSceneSessionSupportsUserScopeWithoutMessage(t *testing.T) {
|
||||
t.Fatalf("Set returned error: %v", err)
|
||||
}
|
||||
|
||||
key, session, err := bot.findSceneSession(&MsgContext{FromID: 42})
|
||||
key, session, err := bot.findSceneSession(&MessageContext{FromID: 42})
|
||||
if err != nil {
|
||||
t.Fatalf("findSceneSession returned error: %v", err)
|
||||
}
|
||||
@@ -667,12 +1006,12 @@ func TestSceneStoreErrorsPropagate(t *testing.T) {
|
||||
|
||||
t.Run("find scene session get error", func(t *testing.T) {
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
logger: sneklog.NewLogger(),
|
||||
sessionStore: failingSessionStore{getErr: getErr},
|
||||
sceneScopePriority: []SceneScope{SceneScopeUser},
|
||||
}
|
||||
|
||||
_, _, err := bot.findSceneSession(&MsgContext{FromID: 42})
|
||||
_, _, err := bot.findSceneSession(&MessageContext{FromID: 42})
|
||||
if !errors.Is(err, getErr) {
|
||||
t.Fatalf("expected getErr, got %v", err)
|
||||
}
|
||||
@@ -683,18 +1022,38 @@ func TestSceneStoreErrorsPropagate(t *testing.T) {
|
||||
return ctx.Stay(), nil
|
||||
})
|
||||
bot := &Bot[NoData]{
|
||||
logger: slog.CreateLogger(),
|
||||
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",
|
||||
MessageContext: &MessageContext{},
|
||||
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)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestSceneSkipsNilHandlers(t *testing.T) {
|
||||
scene := NewScene[NoData]("nil").
|
||||
OnStep("step", nil).
|
||||
OnCommand("command", nil).
|
||||
OnPayload("payload", nil).
|
||||
OnMessage(nil)
|
||||
|
||||
if len(scene.steps) != 0 || len(scene.commands) != 0 || len(scene.payloads) != 0 || scene.message != nil {
|
||||
t.Fatal("scene registered a nil handler")
|
||||
}
|
||||
}
|
||||
|
||||
func TestApplySceneResultRejectsUnknownAction(t *testing.T) {
|
||||
bot := &Bot[NoData]{sessionStore: NewMemorySessionStore()}
|
||||
_, err := bot.applySceneResult(NewScene[NoData]("scene"), &SceneContext{}, SceneResult{Action: SceneAction(255)})
|
||||
if !errors.Is(err, ErrInvalidSceneAction) {
|
||||
t.Fatalf("expected ErrInvalidSceneAction, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
+131
-48
@@ -10,7 +10,13 @@ import (
|
||||
"time"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||
"git.scuroneko.dev/scuroneko/slog"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
const (
|
||||
defaultMaxRetries = 3
|
||||
maximumResponseSize = 10 << 20
|
||||
minimumRetryDelay = 100 * time.Millisecond
|
||||
)
|
||||
|
||||
// APIOpts holds configuration options for initializing the Telegram API client.
|
||||
@@ -19,10 +25,14 @@ type APIOpts struct {
|
||||
token string
|
||||
client *http.Client
|
||||
useTestServer bool
|
||||
apiUrl string
|
||||
apiURL string
|
||||
|
||||
logFormat utils.LogFormat
|
||||
logFormatter *sneklog.Formatter
|
||||
|
||||
limiter *utils.RateLimiter
|
||||
dropOverflowLimit bool
|
||||
maxRetries int
|
||||
}
|
||||
|
||||
// NewAPIOpts creates a new APIOpts with default values.
|
||||
@@ -32,7 +42,8 @@ func NewAPIOpts(token string) *APIOpts {
|
||||
token: token,
|
||||
client: nil,
|
||||
useTestServer: false,
|
||||
apiUrl: "https://api.telegram.org",
|
||||
apiURL: "https://api.telegram.org",
|
||||
maxRetries: defaultMaxRetries,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -52,15 +63,27 @@ func (opts *APIOpts) UseTestServer(use bool) *APIOpts {
|
||||
return opts
|
||||
}
|
||||
|
||||
// SetAPIUrl overrides the default Telegram API URL.
|
||||
// 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
|
||||
func (opts *APIOpts) SetAPIURL(apiURL string) *APIOpts {
|
||||
if apiURL != "" {
|
||||
opts.apiURL = apiURL
|
||||
}
|
||||
return opts
|
||||
}
|
||||
|
||||
// SetLogFormat sets the output format used by API-managed loggers.
|
||||
func (opts *APIOpts) SetLogFormat(format utils.LogFormat) *APIOpts {
|
||||
opts.logFormat = format
|
||||
return opts
|
||||
}
|
||||
|
||||
// SetLogFormatter sets the formatter used by API-managed logger writers.
|
||||
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 {
|
||||
@@ -68,14 +91,24 @@ func (opts *APIOpts) SetLimiter(limiter *utils.RateLimiter) *APIOpts {
|
||||
return opts
|
||||
}
|
||||
|
||||
// SetLimiterDrop enables "drop mode" for rate limiting.
|
||||
// SetDropRateLimitOverflow 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 {
|
||||
func (opts *APIOpts) SetDropRateLimitOverflow(b bool) *APIOpts {
|
||||
opts.dropOverflowLimit = b
|
||||
return opts
|
||||
}
|
||||
|
||||
// SetMaxRetries sets the maximum number of retries after Telegram returns 429.
|
||||
// A non-positive value disables automatic retries. The default is 3.
|
||||
func (opts *APIOpts) SetMaxRetries(maxRetries int) *APIOpts {
|
||||
if maxRetries < 0 {
|
||||
maxRetries = 0
|
||||
}
|
||||
opts.maxRetries = maxRetries
|
||||
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
|
||||
@@ -85,24 +118,31 @@ func (opts *APIOpts) SetLimiterDrop(b bool) *APIOpts {
|
||||
type API struct {
|
||||
token string
|
||||
client *http.Client
|
||||
logger *slog.Logger
|
||||
logger *sneklog.Logger
|
||||
useTestServer bool
|
||||
apiUrl string
|
||||
apiURL string
|
||||
|
||||
pool *workerPool
|
||||
logFormat utils.LogFormat
|
||||
logFormatter *sneklog.Formatter
|
||||
|
||||
pool *workerPool
|
||||
// Limiter is the optional rate limiter applied before requests are sent.
|
||||
Limiter *utils.RateLimiter
|
||||
dropOverflowLimit bool
|
||||
maxRetries int
|
||||
}
|
||||
|
||||
// NewAPI creates a new API client from options.
|
||||
// Always call Close() when done to release resources.
|
||||
func NewAPI(opts *APIOpts) *API {
|
||||
l := utils.CreateLogger("API", utils.GetLoggerLevel())
|
||||
if opts == nil {
|
||||
l.Errorln("Set API options")
|
||||
_ = l.Close()
|
||||
return nil
|
||||
}
|
||||
logger := utils.CreateLogger(
|
||||
"API", utils.GetLoggerLevel(),
|
||||
opts.logFormat, opts.logFormatter,
|
||||
)
|
||||
logger.AddReplacer(opts.token, "<TOKEN>")
|
||||
|
||||
client := opts.client
|
||||
if client == nil {
|
||||
@@ -113,14 +153,19 @@ func NewAPI(opts *APIOpts) *API {
|
||||
pool.start()
|
||||
|
||||
return &API{
|
||||
token: opts.token,
|
||||
client: client,
|
||||
logger: l,
|
||||
useTestServer: opts.useTestServer,
|
||||
apiUrl: opts.apiUrl,
|
||||
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,
|
||||
maxRetries: opts.maxRetries,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -137,24 +182,35 @@ func (api *API) Close() error {
|
||||
|
||||
// GetLogger returns the internal logger for custom logging.
|
||||
// See https://core.telegram.org/bots/api
|
||||
func (api *API) GetLogger() *slog.Logger {
|
||||
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 Optional. The group has been migrated to a supergroup with the specified identifier. This
|
||||
// number may have more than 32 significant bits and some programming languages may have difficulty/silent
|
||||
// defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or
|
||||
// double-precision float type are safe for storing this identifier.
|
||||
MigrateToChatID *int64 `json:"migrate_to_chat_id,omitempty"`
|
||||
RetryAfter *int `json:"retry_after,omitempty"`
|
||||
// RetryAfter Optional. In case of exceeding flood control, the number of seconds left to wait before the
|
||||
// request can be repeated
|
||||
RetryAfter *int `json:"retry_after,omitempty"`
|
||||
}
|
||||
|
||||
// ApiResponse is the standard Telegram Bot API response structure.
|
||||
// TelegramResponse is the standard Telegram Bot API response structure.
|
||||
// Generic over Result type R.
|
||||
type ApiResponse[R any] struct {
|
||||
Ok bool `json:"ok"`
|
||||
Description string `json:"description,omitempty"`
|
||||
Result R `json:"result,omitempty"`
|
||||
ErrorCode int `json:"error_code,omitempty"`
|
||||
Parameters *ResponseParameters `json:"parameters,omitempty"`
|
||||
type TelegramResponse[R any] struct {
|
||||
// Ok reports whether the request succeeded.
|
||||
Ok bool `json:"ok"`
|
||||
// Description contains a human-readable result description when supplied by Telegram.
|
||||
Description string `json:"description,omitempty"`
|
||||
// Result contains the method-specific result for a successful response.
|
||||
Result R `json:"result,omitempty"`
|
||||
// ErrorCode is the Telegram API error code for an unsuccessful response.
|
||||
ErrorCode int `json:"error_code,omitempty"`
|
||||
// Parameters contains additional recovery metadata for an unsuccessful response.
|
||||
Parameters *ResponseParameters `json:"parameters,omitempty"`
|
||||
}
|
||||
|
||||
// TelegramRequest is a low-level Telegram API request wrapper.
|
||||
@@ -166,7 +222,7 @@ type ApiResponse[R any] struct {
|
||||
type TelegramRequest[R, P any] struct {
|
||||
method string
|
||||
params P
|
||||
chatId int64
|
||||
chatID int64
|
||||
}
|
||||
|
||||
// NewRequest creates a low-level TelegramRequest with no associated chat ID.
|
||||
@@ -176,8 +232,8 @@ func NewRequest[R, P any](method string, params P) TelegramRequest[R, P] {
|
||||
|
||||
// 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 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) {
|
||||
@@ -191,7 +247,7 @@ func (r TelegramRequest[R, P]) doRequest(ctx context.Context, api *API) (R, erro
|
||||
if api.useTestServer {
|
||||
methodPrefix = "/test"
|
||||
}
|
||||
url := fmt.Sprintf("%s/bot%s%s/%s", api.apiUrl, api.token, methodPrefix, r.method)
|
||||
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)
|
||||
@@ -201,10 +257,11 @@ func (r TelegramRequest[R, P]) doRequest(ctx context.Context, api *API) (R, erro
|
||||
req.Header.Set("Accept", "application/json")
|
||||
req.Header.Set("User-Agent", fmt.Sprintf("Laniakea/%s", utils.VersionString))
|
||||
|
||||
retries := 0
|
||||
for {
|
||||
// Apply rate limiting before making the request
|
||||
if api.Limiter != nil {
|
||||
if err := api.Limiter.Check(ctx, api.dropOverflowLimit, r.chatId); err != nil {
|
||||
if err := api.Limiter.Check(ctx, api.dropOverflowLimit, r.chatID); err != nil {
|
||||
return zero, err
|
||||
}
|
||||
}
|
||||
@@ -212,10 +269,10 @@ func (r TelegramRequest[R, P]) doRequest(ctx context.Context, api *API) (R, erro
|
||||
req.Body = io.NopCloser(buf)
|
||||
req.ContentLength = int64(len(reqData))
|
||||
|
||||
api.logger.Debugln("REQ", url, string(reqData))
|
||||
api.logger.Debugln("REQ", url, redactRequestLog(reqData))
|
||||
resp, err := api.client.Do(req)
|
||||
if err != nil {
|
||||
return zero, fmt.Errorf("HTTP request failed: %w", err)
|
||||
return zero, fmt.Errorf("HTTP request failed: %w", redactHTTPError(err, api.token))
|
||||
}
|
||||
|
||||
respData, err := readBody(resp.Body)
|
||||
@@ -224,7 +281,7 @@ func (r TelegramRequest[R, P]) doRequest(ctx context.Context, api *API) (R, erro
|
||||
return zero, fmt.Errorf("failed to read response body: %w", err)
|
||||
}
|
||||
|
||||
api.logger.Debugln("RES", r.method, string(respData))
|
||||
api.logger.Debugln("RES", responseLogSummary(r.method, len(respData)))
|
||||
|
||||
response, err := parseBody[R](respData)
|
||||
if err != nil {
|
||||
@@ -232,31 +289,45 @@ func (r TelegramRequest[R, P]) doRequest(ctx context.Context, api *API) (R, erro
|
||||
}
|
||||
|
||||
if !response.Ok {
|
||||
responseErr := &ResponseError{
|
||||
Code: response.ErrorCode,
|
||||
Description: response.Description,
|
||||
Parameters: response.Parameters,
|
||||
}
|
||||
|
||||
// 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)
|
||||
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)
|
||||
if r.chatID != 0 {
|
||||
api.Limiter.SetChatLock(r.chatID, after)
|
||||
} else {
|
||||
api.Limiter.SetGlobalLock(after)
|
||||
}
|
||||
}
|
||||
|
||||
if r.method == "getUpdates" {
|
||||
return zero, responseErr
|
||||
}
|
||||
if retries >= api.maxRetries {
|
||||
return zero, fmt.Errorf("%w after %d retries: %w", ErrRetryLimit, retries, responseErr)
|
||||
}
|
||||
retries++
|
||||
|
||||
// Wait and retry
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
return zero, ctx.Err()
|
||||
case <-time.After(time.Duration(after) * time.Second):
|
||||
case <-time.After(retryDelay(after)):
|
||||
continue // retry request
|
||||
}
|
||||
}
|
||||
|
||||
// Other API errors
|
||||
return zero, fmt.Errorf("[%d] %s", response.ErrorCode, response.Description)
|
||||
return zero, responseErr
|
||||
}
|
||||
|
||||
return response.Result, nil
|
||||
@@ -295,15 +366,27 @@ 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)
|
||||
data, err := io.ReadAll(io.LimitReader(body, maximumResponseSize+1))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if len(data) > maximumResponseSize {
|
||||
return nil, ErrResponseTooLarge
|
||||
}
|
||||
return data, nil
|
||||
}
|
||||
|
||||
// Internal helper that parses a typed Telegram API response body.
|
||||
func parseBody[R any](data []byte) (ApiResponse[R], error) {
|
||||
var resp ApiResponse[R]
|
||||
func retryDelay(retryAfter int) time.Duration {
|
||||
delay := time.Duration(retryAfter) * time.Second
|
||||
if delay < minimumRetryDelay {
|
||||
return minimumRetryDelay
|
||||
}
|
||||
return delay
|
||||
}
|
||||
|
||||
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)
|
||||
|
||||
@@ -0,0 +1,209 @@
|
||||
package tgapi
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestEditMessageTextMarshalsInputRichMessage(t *testing.T) {
|
||||
params := EditMessageText{
|
||||
ChatID: 1,
|
||||
MessageID: 2,
|
||||
RichMessage: &InputRichMessage{
|
||||
HTML: "<p>hi</p>",
|
||||
SkipEntityDetection: true,
|
||||
},
|
||||
}
|
||||
data, err := json.Marshal(params)
|
||||
if err != nil {
|
||||
t.Fatalf("Marshal returned error: %v", err)
|
||||
}
|
||||
got := string(data)
|
||||
for _, want := range []string{`"rich_message":{"html":`, `"skip_entity_detection":true`} {
|
||||
if !strings.Contains(got, want) {
|
||||
t.Fatalf("missing %s in editMessageText JSON: %s", want, got)
|
||||
}
|
||||
}
|
||||
if strings.Contains(got, `"blocks"`) {
|
||||
t.Fatalf("rich_message must be an InputRichMessage, not a block tree: %s", got)
|
||||
}
|
||||
if strings.Contains(got, `"text"`) {
|
||||
t.Fatalf("empty text must be omitted when editing rich content: %s", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSendRichMessageDraftMarshal(t *testing.T) {
|
||||
params := SendRichMessageDraft{
|
||||
ChatID: 1,
|
||||
DraftID: 7,
|
||||
RichMessage: InputRichMessage{Markdown: "*hi*"},
|
||||
}
|
||||
data, err := json.Marshal(params)
|
||||
if err != nil {
|
||||
t.Fatalf("Marshal returned error: %v", err)
|
||||
}
|
||||
got := string(data)
|
||||
for _, want := range []string{`"chat_id":1`, `"draft_id":7`, `"rich_message":{"markdown":"*hi*"}`} {
|
||||
if !strings.Contains(got, want) {
|
||||
t.Fatalf("missing %s in sendRichMessageDraft JSON: %s", want, got)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestInputRichMessageContentMarshal(t *testing.T) {
|
||||
content := InputRichMessageContent{
|
||||
RichMessage: InputRichMessage{HTML: "<p>hi</p>"},
|
||||
}
|
||||
data, err := json.Marshal(content)
|
||||
if err != nil {
|
||||
t.Fatalf("Marshal returned error: %v", err)
|
||||
}
|
||||
if got := string(data); !strings.Contains(got, `"rich_message":{"html":`) {
|
||||
t.Fatalf("unexpected InputRichMessageContent JSON: %s", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestInputRichMessageMediaMarshal(t *testing.T) {
|
||||
message := InputRichMessage{
|
||||
HTML: `<video src="tg://video?id=intro"></video>`,
|
||||
Media: []InputRichMessageMedia{{
|
||||
ID: "intro",
|
||||
Media: InputMedia{Type: InputMediaTypeVideo, Media: "attach://intro"},
|
||||
}},
|
||||
}
|
||||
data, err := json.Marshal(message)
|
||||
if err != nil {
|
||||
t.Fatalf("Marshal returned error: %v", err)
|
||||
}
|
||||
|
||||
var got struct {
|
||||
Media []struct {
|
||||
ID string `json:"id"`
|
||||
Media InputMedia `json:"media"`
|
||||
} `json:"media"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &got); err != nil {
|
||||
t.Fatalf("Unmarshal returned error: %v", err)
|
||||
}
|
||||
if len(got.Media) != 1 || got.Media[0].ID != "intro" {
|
||||
t.Fatalf("unexpected media: %+v", got.Media)
|
||||
}
|
||||
if got.Media[0].Media.Type != InputMediaTypeVideo || got.Media[0].Media.Media != "attach://intro" {
|
||||
t.Fatalf("unexpected embedded media: %+v", got.Media[0].Media)
|
||||
}
|
||||
}
|
||||
|
||||
func TestEphemeralMethodsMarshalReceiverUserID(t *testing.T) {
|
||||
cases := []struct {
|
||||
name string
|
||||
params any
|
||||
}{
|
||||
{"edit text", EditEphemeralMessageText{ChatID: 1, ReceiverUserID: 2, EphemeralMessageID: 3, Text: "updated"}},
|
||||
{"edit media", EditEphemeralMessageMedia{ChatID: 1, ReceiverUserID: 2, EphemeralMessageID: 3, Media: InputMedia{Type: InputMediaTypePhoto, Media: "photo-id"}}},
|
||||
{"edit caption", EditEphemeralMessageCaption{ChatID: 1, ReceiverUserID: 2, EphemeralMessageID: 3, Caption: "updated"}},
|
||||
{"edit markup", EditEphemeralMessageReplyMarkup{ChatID: 1, ReceiverUserID: 2, EphemeralMessageID: 3}},
|
||||
{"delete", DeleteEphemeralMessage{ChatID: 1, ReceiverUserID: 2, EphemeralMessageID: 3}},
|
||||
}
|
||||
|
||||
for _, tt := range cases {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
data, err := json.Marshal(tt.params)
|
||||
if err != nil {
|
||||
t.Fatalf("Marshal returned error: %v", err)
|
||||
}
|
||||
var fields map[string]json.RawMessage
|
||||
if err := json.Unmarshal(data, &fields); err != nil {
|
||||
t.Fatalf("Unmarshal returned error: %v", err)
|
||||
}
|
||||
if _, ok := fields["receiver_user_id"]; !ok {
|
||||
t.Fatalf("receiver_user_id is missing from %s", data)
|
||||
}
|
||||
if _, ok := fields["reciever_user_id"]; ok {
|
||||
t.Fatalf("misspelled receiver_user_id is present in %s", data)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestEphemeralSendParametersMarshal(t *testing.T) {
|
||||
cases := []struct {
|
||||
name string
|
||||
params any
|
||||
}{
|
||||
{"message", SendMessage{ChatID: 1, Text: "text", ReceiverUserID: 2, CallbackQueryID: "callback"}},
|
||||
{"animation", SendAnimation{ChatID: 1, Animation: "animation", ReceiverUserID: 2, CallbackQueryID: "callback"}},
|
||||
{"audio", SendAudio{ChatID: 1, Audio: "audio", ReceiverUserID: 2, CallbackQueryID: "callback"}},
|
||||
{"document", SendDocument{ChatID: 1, Document: "document", ReceiverUserID: 2, CallbackQueryID: "callback"}},
|
||||
{"photo", SendPhoto{ChatID: 1, Photo: "photo", ReceiverUserID: 2, CallbackQueryID: "callback"}},
|
||||
{"sticker", SendSticker{ChatID: 1, Sticker: "sticker", ReceiverUserID: 2, CallbackQueryID: "callback"}},
|
||||
{"video", SendVideo{ChatID: 1, Video: "video", ReceiverUserID: 2, CallbackQueryID: "callback"}},
|
||||
{"video note", SendVideoNote{ChatID: 1, VideoNote: "video-note", ReceiverUserID: 2, CallbackQueryID: "callback"}},
|
||||
{"voice", SendVoice{ChatID: 1, Voice: "voice", ReceiverUserID: 2, CallbackQueryID: "callback"}},
|
||||
{"contact", SendContact{ChatID: 1, PhoneNumber: "+10000000000", FirstName: "A", ReceiverUserID: 2, CallbackQueryID: "callback"}},
|
||||
{"location", SendLocation{ChatID: 1, Latitude: 1, Longitude: 2, ReceiverUserID: 2, CallbackQueryID: "callback"}},
|
||||
{"venue", SendVenue{ChatID: 1, Latitude: 1, Longitude: 2, Title: "Venue", Address: "Address", ReceiverUserID: 2, CallbackQueryID: "callback"}},
|
||||
}
|
||||
|
||||
for _, tt := range cases {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
data, err := json.Marshal(tt.params)
|
||||
if err != nil {
|
||||
t.Fatalf("Marshal returned error: %v", err)
|
||||
}
|
||||
if !strings.Contains(string(data), `"receiver_user_id":2`) || !strings.Contains(string(data), `"callback_query_id":"callback"`) {
|
||||
t.Fatalf("missing ephemeral parameters in %s", data)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestInputPollOptionMediaLinkMarshal(t *testing.T) {
|
||||
media := InputPollOptionMedia{Type: "link", URL: "https://example.com"}
|
||||
data, err := json.Marshal(media)
|
||||
if err != nil {
|
||||
t.Fatalf("Marshal returned error: %v", err)
|
||||
}
|
||||
got := string(data)
|
||||
if got != `{"type":"link","url":"https://example.com"}` {
|
||||
t.Fatalf("unexpected link media JSON: %s", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestPollMediaUnmarshalLink(t *testing.T) {
|
||||
var media PollMedia
|
||||
if err := json.Unmarshal([]byte(`{"link":{"url":"https://example.com"}}`), &media); err != nil {
|
||||
t.Fatalf("Unmarshal returned error: %v", err)
|
||||
}
|
||||
if media.Link == nil || media.Link.URL != "https://example.com" {
|
||||
t.Fatalf("unexpected poll media link: %+v", media.Link)
|
||||
}
|
||||
}
|
||||
|
||||
func TestChatJoinRequestUnmarshalQueryID(t *testing.T) {
|
||||
payload := `{"chat":{"id":1},"from":{"id":2,"first_name":"A"},"user_chat_id":2,"date":3,"query_id":"q42"}`
|
||||
var req ChatJoinRequest
|
||||
if err := json.Unmarshal([]byte(payload), &req); err != nil {
|
||||
t.Fatalf("Unmarshal returned error: %v", err)
|
||||
}
|
||||
if req.QueryID == nil || *req.QueryID != "q42" {
|
||||
t.Fatalf("unexpected query_id: %+v", req.QueryID)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAnswerChatJoinRequestQueryResultValues(t *testing.T) {
|
||||
if JoinRequestApprove != "approve" || JoinRequestDecline != "decline" || JoinRequestQueue != "queue" {
|
||||
t.Fatalf("unexpected join request query result values: %q %q %q",
|
||||
JoinRequestApprove, JoinRequestDecline, JoinRequestQueue)
|
||||
}
|
||||
}
|
||||
|
||||
func TestUserUnmarshalSupportsJoinRequestQueries(t *testing.T) {
|
||||
var user User
|
||||
if err := json.Unmarshal([]byte(`{"id":1,"first_name":"A","supports_join_request_queries":true}`), &user); err != nil {
|
||||
t.Fatalf("Unmarshal returned error: %v", err)
|
||||
}
|
||||
if user.SupportsJoinRequestQueries == nil || !*user.SupportsJoinRequestQueries {
|
||||
t.Fatalf("unexpected supports_join_request_queries: %+v", user.SupportsJoinRequestQueries)
|
||||
}
|
||||
}
|
||||
+42
-2
@@ -1,6 +1,7 @@
|
||||
package tgapi
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"io"
|
||||
"net/http"
|
||||
"strings"
|
||||
@@ -40,7 +41,7 @@ func TestAPILeavesAcceptEncodingToHTTPTransport(t *testing.T) {
|
||||
|
||||
api := NewAPI(
|
||||
NewAPIOpts("token").
|
||||
SetAPIUrl("https://example.test").
|
||||
SetAPIURL("https://example.test").
|
||||
SetHTTPClient(client),
|
||||
)
|
||||
defer func() {
|
||||
@@ -77,7 +78,7 @@ func TestAPICloseClosesIdleConnections(t *testing.T) {
|
||||
|
||||
api := NewAPI(
|
||||
NewAPIOpts("token").
|
||||
SetAPIUrl("https://example.test").
|
||||
SetAPIURL("https://example.test").
|
||||
SetHTTPClient(&http.Client{Transport: transport}),
|
||||
)
|
||||
|
||||
@@ -88,3 +89,42 @@ func TestAPICloseClosesIdleConnections(t *testing.T) {
|
||||
t.Fatal("expected Close to close idle HTTP connections")
|
||||
}
|
||||
}
|
||||
|
||||
func TestAPIStopsAfterConfiguredRetryLimit(t *testing.T) {
|
||||
calls := 0
|
||||
client := &http.Client{Transport: roundTripFunc(func(_ *http.Request) (*http.Response, error) {
|
||||
calls++
|
||||
return &http.Response{
|
||||
StatusCode: http.StatusOK,
|
||||
Body: io.NopCloser(strings.NewReader(
|
||||
`{"ok":false,"error_code":429,"description":"retry","parameters":{"retry_after":0}}`,
|
||||
)),
|
||||
}, nil
|
||||
})}
|
||||
|
||||
api := NewAPI(NewAPIOpts("token").
|
||||
SetAPIURL("https://example.test").
|
||||
SetHTTPClient(client).
|
||||
SetMaxRetries(2))
|
||||
defer func() { _ = api.Close() }()
|
||||
|
||||
_, err := api.GetMe()
|
||||
if !errors.Is(err, ErrRetryLimit) {
|
||||
t.Fatalf("expected ErrRetryLimit, got %v", err)
|
||||
}
|
||||
var responseErr *ResponseError
|
||||
if !errors.As(err, &responseErr) || responseErr.Code != http.StatusTooManyRequests {
|
||||
t.Fatalf("expected wrapped 429 ResponseError, got %v", err)
|
||||
}
|
||||
if calls != 3 {
|
||||
t.Fatalf("request count = %d, want 3", calls)
|
||||
}
|
||||
}
|
||||
|
||||
func TestReadBodyRejectsOversizedResponse(t *testing.T) {
|
||||
body := io.NopCloser(io.LimitReader(strings.NewReader(strings.Repeat("x", maximumResponseSize+1)), maximumResponseSize+1))
|
||||
_, err := readBody(body)
|
||||
if !errors.Is(err, ErrResponseTooLarge) {
|
||||
t.Fatalf("expected ErrResponseTooLarge, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
+595
-142
@@ -3,31 +3,72 @@ package tgapi
|
||||
import "context"
|
||||
|
||||
// SendPhoto holds parameters for the sendPhoto method.
|
||||
// Since: Bot API 1.0
|
||||
// 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"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||
// channel in the format @username
|
||||
ChatID int64 `json:"chat_id"`
|
||||
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||
// supergroups and private chats of bots with forum topic mode enabled only
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||
// sent; required if the message is sent to a direct messages chat
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||
|
||||
Photo string `json:"photo"`
|
||||
Caption string `json:"caption,omitempty"`
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// Photo Required. Photo to send. Pass a file_id as String to send a photo that exists on the Telegram
|
||||
// servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or
|
||||
// upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width
|
||||
// and height must not exceed 10000 in total. Width and height ratio must be at most 20. More information on
|
||||
// Sending Files »
|
||||
Photo string `json:"photo"`
|
||||
// Caption Optional. Photo caption (may also be used when resending photos by file_id), 0-1024 characters
|
||||
// after entities parsing
|
||||
Caption string `json:"caption,omitempty"`
|
||||
// ParseMode Optional. Mode for parsing entities in the photo caption. See formatting options for more
|
||||
// details.
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||
// can be specified instead of parse_mode
|
||||
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"`
|
||||
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media
|
||||
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||
// HasSpoiler Optional. Pass True if the photo needs to be covered with a spoiler animation
|
||||
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||
// DisableNotifications Optional. Sends the message silently. Users will receive a notification with no
|
||||
// sound.
|
||||
DisableNotifications bool `json:"disable_notification,omitempty"`
|
||||
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||
// balance.
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||
// chats only
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
|
||||
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||
// post, then that suggested post is automatically declined.
|
||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendPhoto sends a photo.
|
||||
// Since: Bot API 1.0
|
||||
// See https://core.telegram.org/bots/api#sendphoto
|
||||
func (api *API) SendPhoto(params SendPhoto) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendPhoto", params, params.ChatID)
|
||||
@@ -35,6 +76,7 @@ func (api *API) SendPhoto(params SendPhoto) (Message, error) {
|
||||
}
|
||||
|
||||
// SendPhotoWithContext is the context-aware variant of SendPhoto.
|
||||
// Since: Bot API 1.0
|
||||
// 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) {
|
||||
@@ -43,33 +85,78 @@ func (api *API) SendPhotoWithContext(ctx context.Context, params SendPhoto) (Mes
|
||||
}
|
||||
|
||||
// SendAudio holds parameters for the sendAudio method.
|
||||
// Since: Bot API 1.2
|
||||
// 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"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||
// channel in the format @username
|
||||
ChatID int64 `json:"chat_id"`
|
||||
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||
// supergroups and private chats of bots with forum topic mode enabled only
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||
// sent; required if the message is sent to a direct messages chat
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||
|
||||
Audio string `json:"audio"`
|
||||
Caption string `json:"caption,omitempty"`
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// Audio Required. Audio file to send. Pass a file_id as String to send an audio file that exists on the
|
||||
// Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the
|
||||
// Internet, or upload a new one using multipart/form-data. More information on Sending Files »
|
||||
Audio string `json:"audio"`
|
||||
// Caption Optional. Audio caption, 0-1024 characters after entities parsing
|
||||
Caption string `json:"caption,omitempty"`
|
||||
// ParseMode Optional. Mode for parsing entities in the audio caption. See formatting options for more
|
||||
// details.
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||
// can be specified instead of parse_mode
|
||||
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"`
|
||||
// Duration Optional. Duration of the audio in seconds
|
||||
Duration int `json:"duration,omitempty"`
|
||||
// Performer Optional. Performer
|
||||
Performer string `json:"performer,omitempty"`
|
||||
// Title Optional. Track name
|
||||
Title string `json:"title,omitempty"`
|
||||
// Thumbnail Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is
|
||||
// supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's
|
||||
// width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data.
|
||||
// Thumbnails can't be reused and can be only uploaded as a new file, so you can pass
|
||||
// “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under
|
||||
// <file_attach_name>. More information on Sending Files »
|
||||
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"`
|
||||
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||
// sound.
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||
// balance.
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||
// chats only
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
|
||||
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||
// post, then that suggested post is automatically declined.
|
||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendAudio sends an audio file.
|
||||
// Since: Bot API 1.2
|
||||
// See https://core.telegram.org/bots/api#sendaudio
|
||||
func (api *API) SendAudio(params SendAudio) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendAudio", params, params.ChatID)
|
||||
@@ -77,6 +164,7 @@ func (api *API) SendAudio(params SendAudio) (Message, error) {
|
||||
}
|
||||
|
||||
// SendAudioWithContext is the context-aware variant of SendAudio.
|
||||
// Since: Bot API 1.2
|
||||
// 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) {
|
||||
@@ -85,31 +173,76 @@ func (api *API) SendAudioWithContext(ctx context.Context, params SendAudio) (Mes
|
||||
}
|
||||
|
||||
// SendDocument holds parameters for the sendDocument method.
|
||||
// Since: Bot API 1.0
|
||||
// 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"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||
// channel in the format @username
|
||||
ChatID int64 `json:"chat_id"`
|
||||
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||
// supergroups and private chats of bots with forum topic mode enabled only
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||
// sent; required if the message is sent to a direct messages chat
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||
|
||||
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"`
|
||||
// Document Required. File to send. Pass a file_id as String to send a file that exists on the Telegram
|
||||
// servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or
|
||||
// upload a new one using multipart/form-data. More information on Sending Files »
|
||||
Document string `json:"document"`
|
||||
// Thumbnail Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is
|
||||
// supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's
|
||||
// width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data.
|
||||
// Thumbnails can't be reused and can be only uploaded as a new file, so you can pass
|
||||
// “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under
|
||||
// <file_attach_name>. More information on Sending Files »
|
||||
Thumbnail string `json:"thumbnail,omitempty"`
|
||||
// Caption Optional. Document caption (may also be used when resending documents by file_id), 0-1024
|
||||
// characters after entities parsing
|
||||
Caption string `json:"caption,omitempty"`
|
||||
// ParseMode Optional. Mode for parsing entities in the document caption. See formatting options for more
|
||||
// details.
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||
// can be specified instead of parse_mode
|
||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||
// DisableContentTypeDetection Optional. Disables automatic server-side content type detection for files
|
||||
// uploaded using multipart/form-data
|
||||
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"`
|
||||
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||
// sound.
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||
// balance.
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||
// chats only
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
|
||||
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||
// post, then that suggested post is automatically declined.
|
||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendDocument sends a document.
|
||||
// Since: Bot API 1.0
|
||||
// See https://core.telegram.org/bots/api#senddocument
|
||||
func (api *API) SendDocument(params SendDocument) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendDocument", params, params.ChatID)
|
||||
@@ -117,6 +250,7 @@ func (api *API) SendDocument(params SendDocument) (Message, error) {
|
||||
}
|
||||
|
||||
// SendDocumentWithContext is the context-aware variant of SendDocument.
|
||||
// Since: Bot API 1.0
|
||||
// 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) {
|
||||
@@ -125,39 +259,93 @@ func (api *API) SendDocumentWithContext(ctx context.Context, params SendDocument
|
||||
}
|
||||
|
||||
// SendVideo holds parameters for the sendVideo method.
|
||||
// Since: Bot API 1.0
|
||||
// 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"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||
// channel in the format @username
|
||||
ChatID int64 `json:"chat_id"`
|
||||
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||
// supergroups and private chats of bots with forum topic mode enabled only
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||
// sent; required if the message is sent to a direct messages chat
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||
|
||||
Video string `json:"video"`
|
||||
// Video Required. Video to send. Pass a file_id as String to send a video that exists on the Telegram
|
||||
// servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or
|
||||
// upload a new video using multipart/form-data. More information on Sending Files »
|
||||
Video string `json:"video"`
|
||||
// Thumbnail Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is
|
||||
// supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's
|
||||
// width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data.
|
||||
// Thumbnails can't be reused and can be only uploaded as a new file, so you can pass
|
||||
// “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under
|
||||
// <file_attach_name>. More information on Sending Files »
|
||||
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"`
|
||||
// Duration Optional. Duration of sent video in seconds
|
||||
Duration int `json:"duration,omitempty"`
|
||||
// Width Optional. Video width
|
||||
Width int `json:"width,omitempty"`
|
||||
// Height Optional. Video height
|
||||
Height int `json:"height,omitempty"`
|
||||
// Cover Optional. Cover for the video in the message. Pass a file_id to send a file that exists on the
|
||||
// Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass
|
||||
// “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name>
|
||||
// name. More information on Sending Files »
|
||||
Cover string `json:"cover,omitempty"`
|
||||
|
||||
StartTimestamp int `json:"start_timestamp,omitempty"`
|
||||
Caption string `json:"caption,omitempty"`
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// StartTimestamp Optional. Start timestamp for the video in the message
|
||||
StartTimestamp int `json:"start_timestamp,omitempty"`
|
||||
// Caption Optional. Video caption (may also be used when resending videos by file_id), 0-1024 characters
|
||||
// after entities parsing
|
||||
Caption string `json:"caption,omitempty"`
|
||||
// ParseMode Optional. Mode for parsing entities in the video caption. See formatting options for more
|
||||
// details.
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||
// can be specified instead of parse_mode
|
||||
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"`
|
||||
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media
|
||||
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||
// HasSpoiler Optional. Pass True if the video needs to be covered with a spoiler animation
|
||||
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||
// SupportsStreaming Optional. Pass True if the uploaded video is suitable for streaming
|
||||
SupportsStreaming bool `json:"supports_streaming,omitempty"`
|
||||
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||
// sound.
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||
// balance.
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||
// chats only
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
|
||||
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||
// post, then that suggested post is automatically declined.
|
||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendVideo sends a video.
|
||||
// Since: Bot API 1.0
|
||||
// See https://core.telegram.org/bots/api#sendvideo
|
||||
func (api *API) SendVideo(params SendVideo) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendVideo", params, params.ChatID)
|
||||
@@ -165,6 +353,7 @@ func (api *API) SendVideo(params SendVideo) (Message, error) {
|
||||
}
|
||||
|
||||
// SendVideoWithContext is the context-aware variant of SendVideo.
|
||||
// Since: Bot API 1.0
|
||||
// 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) {
|
||||
@@ -173,35 +362,83 @@ func (api *API) SendVideoWithContext(ctx context.Context, params SendVideo) (Mes
|
||||
}
|
||||
|
||||
// SendAnimation holds parameters for the sendAnimation method.
|
||||
// Since: Bot API 4.0
|
||||
// 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"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||
// channel in the format @username
|
||||
ChatID int64 `json:"chat_id"`
|
||||
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||
// supergroups and private chats of bots with forum topic mode enabled only
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||
// sent; required if the message is sent to a direct messages chat
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||
|
||||
// Animation Required. Animation to send. Pass a file_id as String to send an animation that exists on the
|
||||
// Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the
|
||||
// Internet, or upload a new animation using multipart/form-data. More information on Sending Files »
|
||||
Animation string `json:"animation"`
|
||||
// Thumbnail Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is
|
||||
// supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's
|
||||
// width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data.
|
||||
// Thumbnails can't be reused and can be only uploaded as a new file, so you can pass
|
||||
// “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under
|
||||
// <file_attach_name>. More information on Sending Files »
|
||||
Thumbnail string `json:"thumbnail,omitempty"`
|
||||
Duration int `json:"duration,omitempty"`
|
||||
Width int `json:"width,omitempty"`
|
||||
Height int `json:"height,omitempty"`
|
||||
// Duration Optional. Duration of sent animation in seconds
|
||||
Duration int `json:"duration,omitempty"`
|
||||
// Width Optional. Animation width
|
||||
Width int `json:"width,omitempty"`
|
||||
// Height Optional. Animation height
|
||||
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"`
|
||||
// Caption Optional. Animation caption (may also be used when resending animation by file_id), 0-1024
|
||||
// characters after entities parsing
|
||||
Caption string `json:"caption,omitempty"`
|
||||
// ParseMode Optional. Mode for parsing entities in the animation caption. See formatting options for more
|
||||
// details.
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||
// can be specified instead of parse_mode
|
||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media
|
||||
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||
// HasSpoiler Optional. Pass True if the animation needs to be covered with a spoiler animation
|
||||
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||
// sound.
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||
// balance.
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||
// chats only
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
|
||||
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||
// post, then that suggested post is automatically declined.
|
||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendAnimation sends an animation file (GIF or H.264/MPEG-4 AVC video without sound).
|
||||
// Since: Bot API 4.0
|
||||
// See https://core.telegram.org/bots/api#sendanimation
|
||||
func (api *API) SendAnimation(params SendAnimation) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendAnimation", params, params.ChatID)
|
||||
@@ -209,6 +446,7 @@ func (api *API) SendAnimation(params SendAnimation) (Message, error) {
|
||||
}
|
||||
|
||||
// SendAnimationWithContext is the context-aware variant of SendAnimation.
|
||||
// Since: Bot API 4.0
|
||||
// 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) {
|
||||
@@ -217,29 +455,66 @@ func (api *API) SendAnimationWithContext(ctx context.Context, params SendAnimati
|
||||
}
|
||||
|
||||
// SendVoice holds parameters for the sendVoice method.
|
||||
// Since: Bot API 1.2
|
||||
// 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"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||
// channel in the format @username
|
||||
ChatID int64 `json:"chat_id"`
|
||||
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||
// supergroups and private chats of bots with forum topic mode enabled only
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||
// sent; required if the message is sent to a direct messages chat
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||
|
||||
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"`
|
||||
// Voice Required. Audio file to send. Pass a file_id as String to send a file that exists on the Telegram
|
||||
// servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or
|
||||
// upload a new one using multipart/form-data. More information on Sending Files »
|
||||
Voice string `json:"voice"`
|
||||
// Caption Optional. Voice message caption, 0-1024 characters after entities parsing
|
||||
Caption string `json:"caption,omitempty"`
|
||||
// ParseMode Optional. Mode for parsing entities in the voice message caption. See formatting options for
|
||||
// more details.
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||
// can be specified instead of parse_mode
|
||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||
// Duration Optional. Duration of the voice message in seconds
|
||||
Duration int `json:"duration,omitempty"`
|
||||
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||
// sound.
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||
// balance.
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||
// chats only
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
|
||||
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||
// post, then that suggested post is automatically declined.
|
||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendVoice sends a voice note.
|
||||
// Since: Bot API 1.2
|
||||
// See https://core.telegram.org/bots/api#sendvoice
|
||||
func (api *API) SendVoice(params SendVoice) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendVoice", params, params.ChatID)
|
||||
@@ -247,6 +522,7 @@ func (api *API) SendVoice(params SendVoice) (Message, error) {
|
||||
}
|
||||
|
||||
// SendVoiceWithContext is the context-aware variant of SendVoice.
|
||||
// Since: Bot API 1.2
|
||||
// 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) {
|
||||
@@ -255,28 +531,67 @@ func (api *API) SendVoiceWithContext(ctx context.Context, params SendVoice) (Mes
|
||||
}
|
||||
|
||||
// SendVideoNote holds parameters for the sendVideoNote method.
|
||||
// Since: Bot API 3.0
|
||||
// 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"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||
// channel in the format @username
|
||||
ChatID int64 `json:"chat_id"`
|
||||
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||
// supergroups and private chats of bots with forum topic mode enabled only
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||
// sent; required if the message is sent to a direct messages chat
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||
|
||||
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"`
|
||||
// VideoNote Required. Video note to send. Pass a file_id as String to send a video note that exists on the
|
||||
// Telegram servers (recommended) or upload a new video using multipart/form-data. More information on
|
||||
// Sending Files ». Sending video notes by a URL is currently unsupported.
|
||||
VideoNote string `json:"video_note"`
|
||||
// Thumbnail Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is
|
||||
// supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's
|
||||
// width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data.
|
||||
// Thumbnails can't be reused and can be only uploaded as a new file, so you can pass
|
||||
// “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under
|
||||
// <file_attach_name>. More information on Sending Files »
|
||||
Thumbnail string `json:"thumbnail,omitempty"`
|
||||
// Duration Optional. Duration of sent video in seconds
|
||||
Duration int `json:"duration,omitempty"`
|
||||
// Length Optional. Video width and height, i.e. diameter of the video message
|
||||
Length int `json:"length,omitempty"`
|
||||
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||
// sound.
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||
// balance.
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||
// chats only
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
|
||||
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||
// post, then that suggested post is automatically declined.
|
||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendVideoNote sends a video note (rounded video message).
|
||||
// Since: Bot API 3.0
|
||||
// See https://core.telegram.org/bots/api#sendvideonote
|
||||
func (api *API) SendVideoNote(params SendVideoNote) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendVideoNote", params, params.ChatID)
|
||||
@@ -284,6 +599,7 @@ func (api *API) SendVideoNote(params SendVideoNote) (Message, error) {
|
||||
}
|
||||
|
||||
// SendVideoNoteWithContext is the context-aware variant of SendVideoNote.
|
||||
// Since: Bot API 3.0
|
||||
// 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) {
|
||||
@@ -292,30 +608,63 @@ func (api *API) SendVideoNoteWithContext(ctx context.Context, params SendVideoNo
|
||||
}
|
||||
|
||||
// SendPaidMedia holds parameters for the sendPaidMedia method.
|
||||
// Since: Bot API 7.6
|
||||
// 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"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||
// channel in the format @username. If the chat is a channel, all Telegram Star proceeds from this media
|
||||
// will be credited to the chat's balance. Otherwise, they will be credited to the bot's balance.
|
||||
ChatID int64 `json:"chat_id"`
|
||||
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||
// supergroups and private chats of bots with forum topic mode enabled only
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||
// sent; required if the message is sent to a direct messages chat
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// StarCount Required. The number of Telegram Stars that must be paid to buy access to the media; 1-25000
|
||||
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"`
|
||||
// Media Required. A JSON-serialized Array describing the media to be sent; up to 10 items
|
||||
Media []InputPaidMedia `json:"media"`
|
||||
// Payload Optional. Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user,
|
||||
// use it for your internal processes.
|
||||
Payload string `json:"payload,omitempty"`
|
||||
// Caption Optional. Media caption, 0-1024 characters after entities parsing
|
||||
Caption string `json:"caption,omitempty"`
|
||||
// ParseMode Optional. Mode for parsing entities in the media caption. See formatting options for more
|
||||
// details.
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||
// can be specified instead of parse_mode
|
||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media
|
||||
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||
// sound.
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||
// balance.
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
|
||||
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||
// post, then that suggested post is automatically declined.
|
||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendPaidMedia sends paid media.
|
||||
// Since: Bot API 7.6
|
||||
// See https://core.telegram.org/bots/api#sendpaidmedia
|
||||
func (api *API) SendPaidMedia(params SendPaidMedia) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendPaidMedia", params, params.ChatID)
|
||||
@@ -323,6 +672,7 @@ func (api *API) SendPaidMedia(params SendPaidMedia) (Message, error) {
|
||||
}
|
||||
|
||||
// SendPaidMediaWithContext is the context-aware variant of SendPaidMedia.
|
||||
// Since: Bot API 7.6
|
||||
// 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) {
|
||||
@@ -331,22 +681,41 @@ func (api *API) SendPaidMediaWithContext(ctx context.Context, params SendPaidMed
|
||||
}
|
||||
|
||||
// SendMediaGroup holds parameters for the sendMediaGroup method.
|
||||
// Since: Bot API 3.5
|
||||
// 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"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||
// channel in the format @username
|
||||
ChatID int64 `json:"chat_id"`
|
||||
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||
// supergroups and private chats of bots with forum topic mode enabled only
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the messages will be
|
||||
// sent; required if the messages are sent to a direct messages chat
|
||||
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"`
|
||||
// Media Required. A JSON-serialized Array describing messages to be sent, must include 2-10 items
|
||||
Media []InputMedia `json:"media"`
|
||||
// DisableNotification Optional. Sends messages silently. Users will receive a notification with no sound.
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
// ProtectContent Optional. Protects the contents of the sent messages from forwarding and saving
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||
// balance.
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||
// chats only
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
}
|
||||
|
||||
// SendMediaGroup sends a group of photos, videos, documents or audios as an album.
|
||||
// Since: Bot API 3.5
|
||||
// See https://core.telegram.org/bots/api#sendmediagroup
|
||||
func (api *API) SendMediaGroup(params SendMediaGroup) ([]Message, error) {
|
||||
req := NewRequestWithChatID[[]Message]("sendMediaGroup", params, params.ChatID)
|
||||
@@ -354,9 +723,93 @@ func (api *API) SendMediaGroup(params SendMediaGroup) ([]Message, error) {
|
||||
}
|
||||
|
||||
// SendMediaGroupWithContext is the context-aware variant of SendMediaGroup.
|
||||
// Since: Bot API 3.5
|
||||
// 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)
|
||||
}
|
||||
|
||||
// SendLivePhoto holds parameters for the sendLivePhoto method.
|
||||
// Since: Bot API 10.0
|
||||
// See https://core.telegram.org/bots/api#sendlivephoto
|
||||
type SendLivePhoto struct {
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
// ChatID Required. Unique identifier for the target chat or username of the target channel (in the format
|
||||
// @channelusername)
|
||||
ChatID int64 `json:"chat_id"`
|
||||
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||
// supergroups and private chats of bots with forum topic mode enabled only
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||
// sent; required if the message is sent to a direct messages chat
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
|
||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||
// LivePhoto Required. Live photo video to send. The video must be no longer than 10 seconds and must not
|
||||
// exceed 10 MB in size. Pass a file_id as String to send a video that exists on the Telegram servers
|
||||
// (recommended) or upload a new video using multipart/form-data. More information on Sending Files ».
|
||||
// Sending live photos by a URL is currently unsupported.
|
||||
LivePhoto string `json:"live_photo"`
|
||||
// Photo contains or identifies the associated photo.
|
||||
Photo string `json:"photo"`
|
||||
// Caption Optional. Video caption (may also be used when resending videos by file_id), 0-1024 characters
|
||||
// after entities parsing
|
||||
Caption string `json:"caption,omitempty"`
|
||||
// ParseMode Optional. Mode for parsing entities in the video caption. See formatting options for more
|
||||
// details.
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||
// can be specified instead of parse_mode
|
||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||
|
||||
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media
|
||||
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
|
||||
// HasSpoiler Optional. Pass True if the video needs to be covered with a spoiler animation
|
||||
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||
// sound.
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||
// balance.
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||
// chats only
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
|
||||
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||
// post, then that suggested post is automatically declined.
|
||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendLivePhoto sends a live photo.
|
||||
// Since: Bot API 10.0
|
||||
// See https://core.telegram.org/bots/api#sendlivephoto
|
||||
func (api *API) SendLivePhoto(params SendLivePhoto) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendLivePhoto", params, params.ChatID)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SendLivePhotoWithContext is the context-aware variant of SendLivePhoto.
|
||||
// Since: Bot API 10.0
|
||||
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||
// See https://core.telegram.org/bots/api#sendlivephoto
|
||||
func (api *API) SendLivePhotoWithContext(ctx context.Context, params SendLivePhoto) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendLivePhoto", params, params.ChatID)
|
||||
return req.DoWithContext(ctx, api)
|
||||
}
|
||||
|
||||
+583
-152
@@ -1,162 +1,346 @@
|
||||
package tgapi
|
||||
|
||||
// Animation represents an animation file (GIF or H.264/MPEG-4 AVC without sound).
|
||||
// Since: Bot API 4.0
|
||||
type Animation struct {
|
||||
FileID string `json:"file_id"`
|
||||
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||
FileID string `json:"file_id"`
|
||||
// FileUniqueID Unique identifier for this file, which is supposed to be the same over time and for
|
||||
// different bots. Can't be used to download or reuse the file.
|
||||
FileUniqueID string `json:"file_unique_id"`
|
||||
Width int `json:"width"`
|
||||
Height int `json:"height"`
|
||||
Duration int `json:"duration"`
|
||||
// Width Video width as defined by the sender
|
||||
Width int `json:"width"`
|
||||
// Height Video height as defined by the sender
|
||||
Height int `json:"height"`
|
||||
// Duration Duration of the video in seconds as defined by the sender
|
||||
Duration int `json:"duration"`
|
||||
|
||||
// Thumbnail Optional. Animation thumbnail as defined by the sender
|
||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||
FileName string `json:"file_name"`
|
||||
MimeType string `json:"mime_type"`
|
||||
FileSize int `json:"file_size"`
|
||||
// FileName Optional. Original animation filename as defined by the sender
|
||||
FileName string `json:"file_name"`
|
||||
// MimeType Optional. MIME type of the file as defined by the sender
|
||||
MimeType string `json:"mime_type"`
|
||||
// FileSize Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have
|
||||
// difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit
|
||||
// integer or double-precision float type are safe for storing this value.
|
||||
FileSize int `json:"file_size"`
|
||||
}
|
||||
|
||||
// Audio represents an audio file to be treated as music by the Telegram clients.
|
||||
// Since: Bot API 1.2
|
||||
// See https://core.telegram.org/bots/api#audio
|
||||
type Audio struct {
|
||||
FileID string `json:"file_id"`
|
||||
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||
FileID string `json:"file_id"`
|
||||
// FileUniqueID Unique identifier for this file, which is supposed to be the same over time and for
|
||||
// different bots. Can't be used to download or reuse the file.
|
||||
FileUniqueID string `json:"file_unique_id"`
|
||||
Duration int `json:"duration"`
|
||||
// Duration Duration of the audio in seconds as defined by the sender
|
||||
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"`
|
||||
// Performer Optional. Performer of the audio as defined by the sender or by audio tags
|
||||
Performer string `json:"performer,omitempty"`
|
||||
// Title Optional. Title of the audio as defined by the sender or by audio tags
|
||||
Title string `json:"title,omitempty"`
|
||||
// FileName Optional. Original filename as defined by the sender
|
||||
FileName string `json:"file_name,omitempty"` // Since: Bot API 5.0
|
||||
// MimeType Optional. MIME type of the file as defined by the sender
|
||||
MimeType string `json:"mime_type,omitempty"`
|
||||
// FileSize Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have
|
||||
// difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit
|
||||
// integer or double-precision float type are safe for storing this value.
|
||||
FileSize int64 `json:"file_size,omitempty"`
|
||||
// Thumbnail Optional. Thumbnail of the album cover to which the music file belongs
|
||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||
}
|
||||
|
||||
// Document represents a general file (as opposed to photos, voice messages and audio files).
|
||||
// Since: Bot API 1.0
|
||||
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"`
|
||||
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||
FileID string `json:"file_id"`
|
||||
// FileUniqueID Unique identifier for this file, which is supposed to be the same over time and for
|
||||
// different bots. Can't be used to download or reuse the file.
|
||||
FileUniqueID string `json:"file_unique_id"`
|
||||
// Thumbnail Optional. Document thumbnail as defined by the sender
|
||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||
// FileName Optional. Original filename as defined by the sender
|
||||
FileName string `json:"file_name"`
|
||||
// MimeType Optional. MIME type of the file as defined by the sender
|
||||
MimeType string `json:"mime_type"`
|
||||
// FileSize Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have
|
||||
// difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit
|
||||
// integer or double-precision float type are safe for storing this value.
|
||||
FileSize int `json:"file_size,omitempty"`
|
||||
}
|
||||
|
||||
// Story represents a story.
|
||||
// Since: Bot API 6.8
|
||||
type Story struct {
|
||||
// Chat Chat that posted the story
|
||||
Chat Chat `json:"chat"`
|
||||
ID int `json:"id"`
|
||||
// ID Unique identifier for the story in the chat
|
||||
ID int `json:"id"`
|
||||
}
|
||||
|
||||
// Video represents a video file.
|
||||
// Since: Bot API 1.0
|
||||
type Video struct {
|
||||
FileID string `json:"file_id"`
|
||||
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||
FileID string `json:"file_id"`
|
||||
// FileUniqueID Unique identifier for this file, which is supposed to be the same over time and for
|
||||
// different bots. Can't be used to download or reuse the file.
|
||||
FileUniqueID string `json:"file_unique_id"`
|
||||
Width int `json:"width"`
|
||||
Height int `json:"height"`
|
||||
Duration int `json:"duration"`
|
||||
// Width Video width as defined by the sender
|
||||
Width int `json:"width"`
|
||||
// Height Video height as defined by the sender
|
||||
Height int `json:"height"`
|
||||
// Duration Duration of the video in seconds as defined by the sender
|
||||
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"`
|
||||
// Thumbnail Optional. Video thumbnail
|
||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||
// Cover Optional. Available sizes of the cover of the video in the message
|
||||
Cover []PhotoSize `json:"cover,omitempty"` // Since: Bot API 8.3
|
||||
// StartTimestamp Optional. Timestamp in seconds from which the video will play in the message
|
||||
StartTimestamp int64 `json:"start_timestamp"` // Since: Bot API 8.3
|
||||
// Qualities Optional. List of available qualities of the video
|
||||
Qualities []VideoQuality `json:"qualities,omitempty"` // Since: Bot API 9.4
|
||||
// FileName Optional. Original filename as defined by the sender
|
||||
FileName string `json:"file_name,omitempty"`
|
||||
// MimeType Optional. MIME type of the file as defined by the sender
|
||||
MimeType string `json:"mime_type,omitempty"`
|
||||
// FileSize Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have
|
||||
// difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit
|
||||
// integer or double-precision float type are safe for storing this value.
|
||||
FileSize int64 `json:"file_size,omitempty"`
|
||||
}
|
||||
|
||||
// VideoQuality describes an alternative quality for a video.
|
||||
// Since: Bot API 9.4
|
||||
// See https://core.telegram.org/bots/api#videoquality
|
||||
type VideoQuality struct {
|
||||
FileID string `json:"file_id"`
|
||||
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||
FileID string `json:"file_id"`
|
||||
// FileUniqueID Unique identifier for this file, which is supposed to be the same over time and for
|
||||
// different bots. Can't be used to download or reuse the file.
|
||||
FileUniqueID string `json:"file_unique_id"`
|
||||
Width int `json:"width"`
|
||||
Height int `json:"height"`
|
||||
Codec string `json:"codec"`
|
||||
FileSize int64 `json:"file_size,omitempty"`
|
||||
// Width Video width
|
||||
Width int `json:"width"`
|
||||
// Height Video height
|
||||
Height int `json:"height"`
|
||||
// Codec Codec that was used to encode the video, for example, “h264”, “h265”, or “av01”
|
||||
Codec string `json:"codec"`
|
||||
// FileSize Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have
|
||||
// difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit
|
||||
// integer or double-precision float type are safe for storing this value.
|
||||
FileSize int64 `json:"file_size,omitempty"`
|
||||
}
|
||||
|
||||
// VideoNote represents a video message.
|
||||
// Since: Bot API 3.0
|
||||
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"`
|
||||
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||
FileID string `json:"file_id"`
|
||||
// FileUniqueID Unique identifier for this file, which is supposed to be the same over time and for
|
||||
// different bots. Can't be used to download or reuse the file.
|
||||
FileUniqueID string `json:"file_unique_id"`
|
||||
Duration int `json:"duration"`
|
||||
MimeType string `json:"mime_type,omitempty"`
|
||||
FileSize int `json:"file_size,omitempty"`
|
||||
// Length Video width and height (diameter of the video message) as defined by the sender
|
||||
Length int `json:"length"`
|
||||
// Duration Duration of the video in seconds as defined by the sender
|
||||
Duration int `json:"duration"`
|
||||
// Thumbnail Optional. Video thumbnail
|
||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||
// FileSize Optional. File size in bytes
|
||||
FileSize int64 `json:"file_size,omitempty"`
|
||||
}
|
||||
|
||||
// Voice represents a voice note.
|
||||
// Since: Bot API 1.2
|
||||
type Voice struct {
|
||||
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||
FileID string `json:"file_id"`
|
||||
// FileUniqueID Unique identifier for this file, which is supposed to be the same over time and for
|
||||
// different bots. Can't be used to download or reuse the file.
|
||||
FileUniqueID string `json:"file_unique_id"`
|
||||
// Duration Duration of the audio in seconds as defined by the sender
|
||||
Duration int `json:"duration"`
|
||||
// MimeType Optional. MIME type of the file as defined by the sender
|
||||
MimeType string `json:"mime_type,omitempty"`
|
||||
// FileSize Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have
|
||||
// difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit
|
||||
// integer or double-precision float type are safe for storing this value.
|
||||
FileSize int `json:"file_size,omitempty"`
|
||||
}
|
||||
|
||||
// PaidMediaInfo describes paid media.
|
||||
// Since: Bot API 7.6
|
||||
type PaidMediaInfo struct {
|
||||
StarCount int `json:"star_count"`
|
||||
// StarCount The number of Telegram Stars that must be paid to buy access to the media
|
||||
StarCount int `json:"star_count"`
|
||||
// PaidMedia Information about the paid media
|
||||
PaidMedia []PaidMedia `json:"paid_media"`
|
||||
}
|
||||
|
||||
// PaidMediaType represents the type of paid media.
|
||||
// Since: Bot API 7.6
|
||||
type PaidMediaType string
|
||||
|
||||
const (
|
||||
// PaidMediaPreviewType identifies a paid-media preview.
|
||||
PaidMediaPreviewType PaidMediaType = "preview"
|
||||
PaidMediaPhotoType PaidMediaType = "photo"
|
||||
PaidMediaVideoType PaidMediaType = "video"
|
||||
// PaidMediaPhotoType identifies a paid photo.
|
||||
PaidMediaPhotoType PaidMediaType = "photo"
|
||||
// PaidMediaVideoType identifies a paid video.
|
||||
PaidMediaVideoType PaidMediaType = "video"
|
||||
// PaidMediaLivePhotoType identifies a paid live photo.
|
||||
PaidMediaLivePhotoType PaidMediaType = "live_photo" // Since: Bot API 10.0
|
||||
)
|
||||
|
||||
// PaidMedia describes paid media content.
|
||||
// Since: Bot API 7.6
|
||||
type PaidMedia struct {
|
||||
// Type identifies the preview, photo, video, or live-photo variant.
|
||||
Type PaidMediaType `json:"type,omitempty"`
|
||||
|
||||
Width int `json:"width,omitempty"`
|
||||
Height int `json:"height,omitempty"`
|
||||
// Width Optional. Media width as defined by the sender
|
||||
Width int `json:"width,omitempty"`
|
||||
// Height Optional. Media height as defined by the sender
|
||||
Height int `json:"height,omitempty"`
|
||||
// Duration Optional. Duration of the media in seconds as defined by the sender
|
||||
Duration int `json:"duration,omitempty"`
|
||||
|
||||
// Photo The photo
|
||||
Photo []PhotoSize `json:"photo,omitempty"`
|
||||
|
||||
// Video The video
|
||||
Video *Video `json:"video,omitempty"`
|
||||
// LivePhoto The photo
|
||||
LivePhoto *LivePhoto `json:"live_photo,omitempty"` // Since: Bot API 10.0
|
||||
}
|
||||
|
||||
// Contact represents a phone contact.
|
||||
// Since: Bot API 1.0
|
||||
type Contact struct {
|
||||
// PhoneNumber Contact's phone number
|
||||
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"`
|
||||
// FirstName Contact's first name
|
||||
FirstName string `json:"first_name"`
|
||||
// LastName Optional. Contact's last name
|
||||
LastName string `json:"last_name,omitempty"`
|
||||
// UserID Optional. Contact's user identifier in Telegram. This number may have more than 32 significant
|
||||
// bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at
|
||||
// most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this
|
||||
// identifier.
|
||||
UserID int64 `json:"user_id,omitempty"`
|
||||
// Vcard Optional. Additional data about the contact in the form of a vCard
|
||||
Vcard string `json:"vcard,omitempty"`
|
||||
}
|
||||
|
||||
// Dice represents an animated emoji with a random value.
|
||||
// Since: Bot API 4.7
|
||||
type Dice struct {
|
||||
// Emoji Emoji on which the dice throw animation is based
|
||||
Emoji string `json:"emoji"`
|
||||
Value int `json:"value"`
|
||||
// Value Value of the dice, 1-6 for “”, “” and “” base emoji, 1-5 for “” and “” base
|
||||
// emoji, 1-64 for “” base emoji
|
||||
Value int `json:"value"`
|
||||
}
|
||||
|
||||
// PollOption contains information about one answer option in a poll.
|
||||
// Since: Bot API 4.2
|
||||
// See https://core.telegram.org/bots/api#polloption
|
||||
type PollOption struct {
|
||||
PersistentID string `json:"persistent_id"`
|
||||
Text string `json:"text"`
|
||||
// PersistentID Unique identifier of the option, persistent on option addition and deletion
|
||||
PersistentID string `json:"persistent_id"` // Since: Bot API 9.6
|
||||
// Text Option text, 1-100 characters
|
||||
Text string `json:"text"`
|
||||
// TextEntities Optional. Special entities that appear in the option text. Currently, only custom emoji
|
||||
// entities are allowed in poll option texts
|
||||
TextEntities []MessageEntity `json:"text_entities"`
|
||||
VoterCount int `json:"voter_count"`
|
||||
// Media Optional. Media added to the poll option
|
||||
Media *PollMedia `json:"media,omitempty"` // Since: Bot API 10.0
|
||||
// VoterCount Number of users who voted for this option; may be 0 if unknown
|
||||
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"`
|
||||
// AddedByUser Optional. User who added the option; omitted if the option wasn't added by a user after poll
|
||||
// creation
|
||||
AddedByUser *User `json:"added_by_user,omitempty"` // Since: Bot API 9.6
|
||||
// AddedByChat Optional. Chat that added the option; omitted if the option wasn't added by a chat after poll
|
||||
// creation
|
||||
AddedByChat *Chat `json:"added_by_chat,omitempty"` // Since: Bot API 9.6
|
||||
// AdditionDate Optional. Point in time (Unix timestamp) when the option was added; omitted if the option
|
||||
// existed in the original poll
|
||||
AdditionDate int `json:"addition_date,omitempty"` // Since: Bot API 9.6
|
||||
}
|
||||
|
||||
// InputPollOptionMedia describes the media to attach to a poll option.
|
||||
// For type "link" set URL instead of Media.
|
||||
// Since: Bot API 10.0
|
||||
// See https://core.telegram.org/bots/api#inputpolloptionmedia
|
||||
type InputPollOptionMedia struct {
|
||||
// Type identifies the poll-option media variant.
|
||||
Type string `json:"type"`
|
||||
// Media is the file_id or URL of the option media for non-link variants.
|
||||
Media string `json:"media,omitempty"`
|
||||
// URL contains the HTTP URL.
|
||||
URL string `json:"url,omitempty"` // Since: Bot API 10.1; for type "link"
|
||||
}
|
||||
|
||||
// InputPollOption contains information about one answer option in a poll to be sent.
|
||||
// Since: Bot API 7.3
|
||||
// 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"`
|
||||
// Text Option text, 1-100 characters
|
||||
Text string `json:"text"`
|
||||
// TextParseMode Optional. Mode for parsing entities in the text. See formatting options for more details.
|
||||
// Currently, only custom emoji entities are allowed.
|
||||
TextParseMode ParseMode `json:"text_parse_mode,omitempty"`
|
||||
// TextEntities Optional. A JSON-serialized list of special entities that appear in the poll option text. It
|
||||
// can be specified instead of text_parse_mode.
|
||||
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
||||
// Media Optional. Media added to the poll option
|
||||
Media *InputPollOptionMedia `json:"media,omitempty"` // Since: Bot API 10.0
|
||||
}
|
||||
|
||||
// InputPollMedia describes the media to attach to a poll or its explanation.
|
||||
// Since: Bot API 10.0
|
||||
// See https://core.telegram.org/bots/api#inputpollmedia
|
||||
type InputPollMedia struct {
|
||||
// Type identifies the poll-media variant.
|
||||
Type string `json:"type"`
|
||||
// Media is the file_id or URL of the poll media.
|
||||
Media string `json:"media"`
|
||||
}
|
||||
|
||||
// PollOptionAdded describes a service message about a poll option being added.
|
||||
// Since: Bot API 9.6
|
||||
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"`
|
||||
// PollMessage Optional. Message containing the poll to which the option was added, if known. Note that the
|
||||
// Message object in this field will not contain the reply_to_message field even if it itself is a reply.
|
||||
PollMessage *InaccessibleMessage `json:"poll_message,omitempty"`
|
||||
// OptionPersistentID Unique identifier of the added option
|
||||
OptionPersistentID string `json:"option_persistent_id"`
|
||||
// OptionText Option text
|
||||
OptionText string `json:"option_text"`
|
||||
// OptionTextEntities Optional. Special entities that appear in the option_text
|
||||
OptionTextEntities []MessageEntity `json:"option_text_entities,omitempty"`
|
||||
}
|
||||
|
||||
// PollOptionDeleted describes a service message about a poll option being deleted.
|
||||
// Since: Bot API 9.6
|
||||
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"`
|
||||
// PollMessage Optional. Message containing the poll from which the option was deleted, if known. Note that
|
||||
// the Message object in this field will not contain the reply_to_message field even if it itself is a
|
||||
// reply.
|
||||
PollMessage *InaccessibleMessage `json:"poll_message,omitempty"`
|
||||
// OptionPersistentID Unique identifier of the deleted option
|
||||
OptionPersistentID string `json:"option_persistent_id"`
|
||||
// OptionText Option text
|
||||
OptionText string `json:"option_text"`
|
||||
// OptionTextEntities Optional. Special entities that appear in the option_text
|
||||
OptionTextEntities []MessageEntity `json:"option_text_entities,omitempty"`
|
||||
}
|
||||
|
||||
// PollType represents the type of a poll.
|
||||
@@ -169,83 +353,230 @@ const (
|
||||
PollTypeQuiz PollType = "quiz"
|
||||
)
|
||||
|
||||
// PollAnswer represents an answer of a user in a poll.
|
||||
// PollAnswer represents an answer submitted by a poll voter.
|
||||
//
|
||||
// User and VoterChat remain value fields for v1 compatibility. Their pointer
|
||||
// representation is subject to change in v2; use VoterUser and VoterChatInfo
|
||||
// when presence matters.
|
||||
// Since: Bot API 4.6
|
||||
// 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"`
|
||||
// PollID identifies the poll.
|
||||
PollID string `json:"poll_id"`
|
||||
// VoterChat is the chat that changed the answer, when the voter is anonymous.
|
||||
VoterChat Chat `json:"voter_chat,omitempty"` // Since: Bot API 6.8
|
||||
// User is the user that changed the answer, when the voter is not anonymous.
|
||||
User User `json:"user,omitempty"`
|
||||
// OptionIDs contains the chosen option indices and is empty for a retracted vote.
|
||||
OptionIDs []int `json:"option_ids"`
|
||||
// OptionPersistentIDs contains the persistent identifiers of the chosen options.
|
||||
OptionPersistentIDs []string `json:"option_persistent_ids"` // Since: Bot API 9.6
|
||||
}
|
||||
|
||||
// VoterUser returns the non-anonymous voter when it is present.
|
||||
//
|
||||
// Since: Bot API 4.6
|
||||
func (a PollAnswer) VoterUser() (*User, bool) {
|
||||
if a.User.ID == 0 {
|
||||
return nil, false
|
||||
}
|
||||
return &a.User, true
|
||||
}
|
||||
|
||||
// VoterChatInfo returns the anonymous voter chat when it is present.
|
||||
//
|
||||
// Since: Bot API 6.8
|
||||
func (a PollAnswer) VoterChatInfo() (*Chat, bool) {
|
||||
if a.VoterChat.ID == 0 {
|
||||
return nil, false
|
||||
}
|
||||
return &a.VoterChat, true
|
||||
}
|
||||
|
||||
// Poll contains information about a poll.
|
||||
// Since: Bot API 4.2
|
||||
// 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"`
|
||||
// ID Unique poll identifier
|
||||
ID string `json:"id"`
|
||||
// Question Poll question, 1-300 characters
|
||||
Question string `json:"question"`
|
||||
// QuestionEntities Optional. Special entities that appear in the question. Currently, only custom emoji
|
||||
// entities are allowed in poll questions
|
||||
QuestionEntities []MessageEntity `json:"question_entities"` // Since: Bot API 7.3
|
||||
// Options List of poll options
|
||||
Options []PollOption `json:"options"`
|
||||
// TotalVoterCount Total number of users that voted in the poll
|
||||
TotalVoterCount int `json:"total_voter_count"`
|
||||
// IsClosed True, if the poll is closed
|
||||
IsClosed bool `json:"is_closed,omitempty"`
|
||||
// IsAnonymous True, if the poll is anonymous
|
||||
IsAnonymous bool `json:"is_anonymous,omitempty"`
|
||||
// Type Poll type, currently can be “regular” or “quiz”
|
||||
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"`
|
||||
// AllowsMultipleAnswers True, if the poll allows multiple answers
|
||||
AllowsMultipleAnswers bool `json:"allows_multiple_answers,omitempty"` // Since: Bot API 4.6
|
||||
// AllowsRevoting True, if the poll allows to change the chosen answer options
|
||||
AllowsRevoting bool `json:"allows_revoting,omitempty"` // Since: Bot API 9.6
|
||||
// MembersOnly True if voting is limited to users who have been members of the chat where the poll was
|
||||
// originally sent for more than 24 hours
|
||||
MembersOnly bool `json:"members_only,omitempty"` // Since: Bot API 10.0
|
||||
// CountryCodes Optional. A list of two-letter ISO 3166-1 alpha-2 country codes indicating the countries
|
||||
// from which users can vote in the poll. The country code “FT” is used for users with anonymous
|
||||
// numbers. If omitted, then users from any country can participate in the poll.
|
||||
CountryCodes []string `json:"country_codes,omitempty"` // Since: Bot API 10.0
|
||||
// CorrectOptionIDs Optional. Array of 0-based identifiers of the correct answer options. Available only for
|
||||
// polls in quiz mode which are closed or were sent (not forwarded) by the bot or to the private chat with
|
||||
// the bot.
|
||||
CorrectOptionIDs []int `json:"correct_option_ids,omitempty"` // Since: Bot API 9.6
|
||||
// Explanation Optional. Text that is shown when a user chooses an incorrect answer or taps on the lamp icon
|
||||
// in a quiz-style poll, 0-200 characters
|
||||
Explanation string `json:"explanation,omitempty"` // Since: Bot API 4.8
|
||||
// ExplanationEntities Optional. Special entities like usernames, URLs, bot commands, etc. that appear in
|
||||
// the explanation
|
||||
ExplanationEntities []MessageEntity `json:"explanation_entities,omitempty"` // Since: Bot API 4.8
|
||||
// ExplanationMedia Optional. Media added to the quiz explanation
|
||||
ExplanationMedia *PollMedia `json:"explanation_media,omitempty"` // Since: Bot API 10.0
|
||||
// OpenPeriod Optional. Amount of time in seconds the poll will be active after creation
|
||||
OpenPeriod int `json:"open_period,omitempty"` // Since: Bot API 4.8
|
||||
// CloseDate Optional. Point in time (Unix timestamp) when the poll will be automatically closed
|
||||
CloseDate int `json:"close_date,omitempty"` // Since: Bot API 4.8
|
||||
// Description Optional. Description of the poll; for polls inside the Message object only
|
||||
Description string `json:"description,omitempty"` // Since: Bot API 9.6
|
||||
// DescriptionEntities Optional. Special entities like usernames, URLs, bot commands, etc. that appear in
|
||||
// the description
|
||||
DescriptionEntities []MessageEntity `json:"description_entities,omitempty"` // Since: Bot API 9.6
|
||||
// Media Optional. Media added to the poll description; for polls inside the Message object only
|
||||
Media *PollMedia `json:"media,omitempty"` // Since: Bot API 10.0
|
||||
}
|
||||
|
||||
// Link represents an HTTP link.
|
||||
// Since: Bot API 10.1
|
||||
// See https://core.telegram.org/bots/api#link
|
||||
type Link struct {
|
||||
// URL contains the HTTP URL.
|
||||
URL string `json:"url"`
|
||||
}
|
||||
|
||||
// PollMedia represents media attached to a poll.
|
||||
// Since: Bot API 10.0
|
||||
type PollMedia struct {
|
||||
// Animation Optional. Media is an animation, information about the animation
|
||||
Animation *Animation `json:"animation,omitempty"`
|
||||
// Audio Optional. Media is an audio file, information about the file; currently, can't be received in a
|
||||
// poll option
|
||||
Audio *Audio `json:"audio,omitempty"`
|
||||
// Document Optional. Media is a general file, information about the file; currently, can't be received in a
|
||||
// poll option
|
||||
Document *Document `json:"document,omitempty"`
|
||||
// Link contains link media attached to the poll.
|
||||
Link *Link `json:"link,omitempty"` // Since: Bot API 10.1
|
||||
// LivePhoto Optional. Media is a live photo, information about the live photo
|
||||
LivePhoto *LivePhoto `json:"live_photo,omitempty"`
|
||||
// Location Optional. Media is a shared location, information about the location
|
||||
Location *Location `json:"location,omitempty"`
|
||||
// Photo Optional. Media is a photo, available sizes of the photo
|
||||
Photo []PhotoSize `json:"photo,omitempty"`
|
||||
// Sticker Optional. Media is a sticker, information about the sticker; currently, for poll options only
|
||||
Sticker *Sticker `json:"sticker,omitempty"`
|
||||
// Venue Optional. Media is a venue, information about the venue
|
||||
Venue *Venue `json:"venue,omitempty"`
|
||||
// Video Optional. Media is a video, information about the video
|
||||
Video *Video `json:"video,omitempty"`
|
||||
}
|
||||
|
||||
// ChecklistTask represents a single task in a checklist.
|
||||
// Since: Bot API 9.1
|
||||
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"`
|
||||
// ID Unique identifier of the task
|
||||
ID int `json:"id"`
|
||||
// Text Text of the task
|
||||
Text string `json:"text"`
|
||||
// TextEntities Optional. Special entities that appear in the task text
|
||||
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
||||
// CompletedByUser Optional. User that completed the task; omitted if the task wasn't completed by a user
|
||||
CompletedByUser *User `json:"completed_by_user,omitempty"`
|
||||
// CompletedByChat Optional. Chat that completed the task; omitted if the task wasn't completed by a chat
|
||||
CompletedByChat *Chat `json:"completed_by_chat,omitempty"`
|
||||
// CompletionDate Optional. Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't
|
||||
// completed
|
||||
CompletionDate int `json:"completion_date,omitempty"`
|
||||
}
|
||||
|
||||
// Checklist represents a checklist.
|
||||
// Since: Bot API 9.1
|
||||
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"`
|
||||
// Title Title of the checklist
|
||||
Title string `json:"title"`
|
||||
// TitleEntities Optional. Special entities that appear in the checklist title
|
||||
TitleEntities []MessageEntity `json:"title_entities,omitempty"`
|
||||
// Tasks List of tasks in the checklist
|
||||
Tasks []ChecklistTask `json:"tasks"`
|
||||
// OthersCanAddTasks Optional. True, if users other than the creator of the list can add tasks to the list
|
||||
OthersCanAddTasks bool `json:"others_can_add_tasks,omitempty"`
|
||||
// OthersCanMarkTasksAsDone Optional. True, if users other than the creator of the list can mark tasks as
|
||||
// done or not done
|
||||
OthersCanMarkTasksAsDone bool `json:"others_can_mark_tasks_as_done,omitempty"`
|
||||
}
|
||||
|
||||
// InputChecklistTask describes a task in a checklist.
|
||||
// Since: Bot API 9.1
|
||||
type InputChecklistTask struct {
|
||||
ID int `json:"id"`
|
||||
Text string `json:"text"`
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// ID Unique identifier of the task; must be positive and unique among all task identifiers currently
|
||||
// present in the checklist
|
||||
ID int `json:"id"`
|
||||
// Text Text of the task; 1-100 characters after entities parsing
|
||||
Text string `json:"text"`
|
||||
// ParseMode Optional. Mode for parsing entities in the text. See formatting options for more details.
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// TextEntities Optional. List of special entities that appear in the text, which can be specified instead
|
||||
// of parse_mode. Currently, only bold, italic, underline, strikethrough, spoiler, custom_emoji, and
|
||||
// date_time entities are allowed.
|
||||
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
||||
}
|
||||
|
||||
// InputChecklist represents a checklist to be sent.
|
||||
// Since: Bot API 9.1
|
||||
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"`
|
||||
// Title Title of the checklist; 1-255 characters after entities parsing
|
||||
Title string `json:"title"`
|
||||
// ParseMode Optional. Mode for parsing entities in the title. See formatting options for more details.
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// TitleEntities Optional. List of special entities that appear in the title, which can be specified instead
|
||||
// of parse_mode. Currently, only bold, italic, underline, strikethrough, spoiler, custom_emoji, and
|
||||
// date_time entities are allowed.
|
||||
TitleEntities []MessageEntity `json:"title_entities,omitempty"`
|
||||
// Tasks List of 1-30 tasks in the checklist
|
||||
Tasks []InputChecklistTask `json:"tasks"`
|
||||
// OtherCanAddTasks Optional. Pass True if other users can add tasks to the checklist
|
||||
// Subject to change in v2: the Go field name may be corrected to OthersCanAddTasks.
|
||||
OtherCanAddTasks bool `json:"others_can_add_tasks,omitempty"`
|
||||
// OtherCanMarkTasksAsDone Optional. Pass True if other users can mark tasks as done or not done in the
|
||||
// checklist
|
||||
// Subject to change in v2: the Go field name may be corrected to OthersCanMarkTasksAsDone.
|
||||
OtherCanMarkTasksAsDone bool `json:"others_can_mark_tasks_as_done,omitempty"`
|
||||
}
|
||||
|
||||
// ChecklistTaskDone describes a service message about checklist tasks being marked as done.
|
||||
// Since: Bot API 9.1
|
||||
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"`
|
||||
// ChecklistMessage is the checklist message when it is available.
|
||||
ChecklistMessage *Message `json:"checklist_message,omitempty"`
|
||||
// MarkedAsDoneTaskIDs Optional. Identifiers of the tasks that were marked as done
|
||||
MarkedAsDoneTaskIDs []int `json:"marked_as_done_task_ids,omitempty"`
|
||||
// MarkedAsNotDoneTaskIDs Optional. Identifiers of the tasks that were marked as not done
|
||||
MarkedAsNotDoneTaskIDs []int `json:"marked_as_not_done_task_ids,omitempty"`
|
||||
}
|
||||
|
||||
// ChecklistTasksAdded describes a service message about new checklist tasks being added.
|
||||
// Since: Bot API 9.1
|
||||
type ChecklistTasksAdded struct {
|
||||
ChecklistMessage *Message `json:"checklist_message,omitempty"`
|
||||
Tasks []ChecklistTask `json:"tasks"`
|
||||
// ChecklistMessage Optional. Message containing the checklist to which the tasks were added. Note that the
|
||||
// Message object in this field will not contain the reply_to_message field even if it itself is a reply.
|
||||
ChecklistMessage *Message `json:"checklist_message,omitempty"`
|
||||
// Tasks List of tasks added to the checklist
|
||||
Tasks []ChecklistTask `json:"tasks"`
|
||||
}
|
||||
|
||||
// InputMediaType represents the type of input media.
|
||||
@@ -262,29 +593,84 @@ const (
|
||||
InputMediaTypeVideo InputMediaType = "video"
|
||||
// InputMediaTypeAudio is an audio file.
|
||||
InputMediaTypeAudio InputMediaType = "audio"
|
||||
// InputMediaTypeVoiceNote is a voice message.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
InputMediaTypeVoiceNote InputMediaType = "voice_note"
|
||||
|
||||
// InputMediaTypeSticker is a sticker.
|
||||
InputMediaTypeSticker InputMediaType = "sticker"
|
||||
// InputMediaTypeLocation is a location.
|
||||
InputMediaTypeLocation InputMediaType = "location"
|
||||
// InputMediaTypeVenue is a venue.
|
||||
InputMediaTypeVenue InputMediaType = "venue"
|
||||
// InputMediaTypeLivePhoto is a live photo.
|
||||
InputMediaTypeLivePhoto InputMediaType = "live_photo" // Since: Bot API 10.0
|
||||
)
|
||||
|
||||
// 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.
|
||||
// Since: Bot API 4.0
|
||||
// See https://core.telegram.org/bots/api#inputmedia
|
||||
type InputMedia struct {
|
||||
Type InputMediaType `json:"type"`
|
||||
Media string `json:"media"`
|
||||
// Type identifies the concrete input-media variant.
|
||||
Type InputMediaType `json:"type"`
|
||||
// Media is a file_id, HTTP URL, or attach:// reference for the media.
|
||||
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"`
|
||||
// Caption is the optional media caption.
|
||||
Caption *string `json:"caption,omitempty"`
|
||||
// ParseMode selects how entities in Caption are parsed.
|
||||
ParseMode *ParseMode `json:"parse_mode,omitempty"`
|
||||
// CaptionEntities Optional. List of special entities that appear in the caption, which can be specified
|
||||
// instead of parse_mode
|
||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||
// ShowCaptionAboveMedia Optional. Pass True if the caption must be shown above the message media
|
||||
ShowCaptionAboveMedia *bool `json:"show_caption_above_media,omitempty"` // Since: Bot API 7.4
|
||||
// HasSpoiler requests that supported media be covered by a spoiler animation.
|
||||
HasSpoiler *bool `json:"has_spoiler,omitempty"` // Since: Bot API 6.4
|
||||
|
||||
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"`
|
||||
// Cover Optional. Cover for the video in the message. Pass a file_id to send a file that exists on the
|
||||
// Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass
|
||||
// “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name>
|
||||
// name. More information on Sending Files »
|
||||
Cover *string `json:"cover"` // Since: Bot API 8.3
|
||||
// StartTimestamp Optional. Start timestamp for the video in the message
|
||||
StartTimestamp *int `json:"start_timestamp"` // Since: Bot API 8.3
|
||||
// Width is the optional media width in pixels.
|
||||
Width *int `json:"width,omitempty"`
|
||||
// Height is the optional media height in pixels.
|
||||
Height *int `json:"height,omitempty"`
|
||||
// Duration is the optional duration of the media in seconds.
|
||||
Duration *int `json:"duration,omitempty"`
|
||||
// SupportsStreaming Optional. Pass True if the uploaded video is suitable for streaming
|
||||
SupportsStreaming *bool `json:"supports_streaming,omitempty"`
|
||||
|
||||
// Performer Optional. Performer of the audio
|
||||
Performer *string `json:"performer,omitempty"`
|
||||
Title *string `json:"title,omitempty"`
|
||||
// Title is the optional title of audio or venue media.
|
||||
Title *string `json:"title,omitempty"`
|
||||
|
||||
// Emoji Optional. Emoji associated with the sticker; only for just uploaded stickers
|
||||
Emoji *string `json:"emoji,omitempty"`
|
||||
|
||||
// Latitude Latitude of the location
|
||||
Latitude *float64 `json:"latitude,omitempty"`
|
||||
// Longitude Longitude of the location
|
||||
Longitude *float64 `json:"longitude,omitempty"`
|
||||
// Address Address of the venue
|
||||
Address *string `json:"address,omitempty"`
|
||||
// FoursquareID Optional. Foursquare identifier of the venue
|
||||
FoursquareID *string `json:"foursquare_id,omitempty"`
|
||||
// FoursquareType Optional. Foursquare type of the venue, if known. (For example,
|
||||
// “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
|
||||
FoursquareType *string `json:"foursquare_type,omitempty"`
|
||||
// GooglePlaceID Optional. Google Places identifier of the venue
|
||||
GooglePlaceID *string `json:"google_place_id,omitempty"`
|
||||
// GooglePlaceType Optional. Google Places type of the venue. (See supported types.)
|
||||
GooglePlaceType *string `json:"google_place_type,omitempty"`
|
||||
|
||||
// HorizontalAccuracy Optional. The radius of uncertainty for the location, measured in meters; 0-1500
|
||||
HorizontalAccuracy *float64 `json:"horizontal_accuracy,omitempty"`
|
||||
}
|
||||
|
||||
// InputPaidMediaType represents the type of paid media.
|
||||
@@ -295,28 +681,73 @@ const (
|
||||
InputPaidMediaTypeVideo InputPaidMediaType = "video"
|
||||
// InputPaidMediaTypePhoto represents a paid photo.
|
||||
InputPaidMediaTypePhoto InputPaidMediaType = "photo"
|
||||
// InputPaidMediaTypeLivePhoto represents a paid live photo.
|
||||
InputPaidMediaTypeLivePhoto InputPaidMediaType = "live_photo" // Since: Bot API 10.0
|
||||
)
|
||||
|
||||
// InputPaidMedia describes the paid media to be sent.
|
||||
// Since: Bot API 7.6
|
||||
// See https://core.telegram.org/bots/api#inputpaidmedia
|
||||
type InputPaidMedia struct {
|
||||
Type InputPaidMediaType `json:"type"`
|
||||
Media string `json:"media"`
|
||||
// Type identifies the concrete paid-media variant.
|
||||
Type InputPaidMediaType `json:"type"`
|
||||
// Media is a file_id, HTTP URL, or attach:// reference for the paid media.
|
||||
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"`
|
||||
// Cover Optional. Cover for the video in the message. Pass a file_id to send a file that exists on the
|
||||
// Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass
|
||||
// “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name>
|
||||
// name. More information on Sending Files »
|
||||
Cover *string `json:"cover,omitempty"` // Since: Bot API 8.3
|
||||
// StartTimestamp Optional. Start timestamp for the video in the message
|
||||
StartTimestamp *int64 `json:"start_timestamp,omitempty"` // Since: Bot API 8.3
|
||||
// Width Optional. Video width
|
||||
Width *int `json:"width,omitempty"`
|
||||
// Height Optional. Video height
|
||||
Height *int `json:"height,omitempty"`
|
||||
// Duration Optional. Video duration in seconds
|
||||
Duration *int `json:"duration,omitempty"`
|
||||
// SupportsStreaming Optional. Pass True if the uploaded video is suitable for streaming
|
||||
SupportsStreaming *bool `json:"supports_streaming,omitempty"`
|
||||
}
|
||||
|
||||
// PhotoSize represents one size of a photo or a file/sticker thumbnail.
|
||||
// Since: Bot API 1.0
|
||||
// See https://core.telegram.org/bots/api#photosize
|
||||
type PhotoSize struct {
|
||||
FileID string `json:"file_id"`
|
||||
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||
FileID string `json:"file_id"`
|
||||
// FileUniqueID Unique identifier for this file, which is supposed to be the same over time and for
|
||||
// different bots. Can't be used to download or reuse the file.
|
||||
FileUniqueID string `json:"file_unique_id"`
|
||||
Width int `json:"width"`
|
||||
Height int `json:"height"`
|
||||
FileSize int64 `json:"file_size,omitempty"`
|
||||
// Width Photo width
|
||||
Width int `json:"width"`
|
||||
// Height Photo height
|
||||
Height int `json:"height"`
|
||||
// FileSize Optional. File size in bytes
|
||||
FileSize int64 `json:"file_size,omitempty"`
|
||||
}
|
||||
|
||||
// LivePhoto represents a live photo (a photo with a short video attached).
|
||||
// Since: Bot API 10.0
|
||||
type LivePhoto struct {
|
||||
// Photo Optional. Available sizes of the corresponding static photo
|
||||
Photo []PhotoSize `json:"photo,omitempty"`
|
||||
// FileID Identifier for the video file which can be used to download or reuse the file
|
||||
FileID string `json:"file_id"`
|
||||
// FileUniqueID Unique identifier for the video file which is supposed to be the same over time and for
|
||||
// different bots. Can't be used to download or reuse the file.
|
||||
FileUniqueID string `json:"file_unique_id"`
|
||||
// Width Video width as defined by the sender
|
||||
Width int `json:"width"`
|
||||
// Height Video height as defined by the sender
|
||||
Height int `json:"height"`
|
||||
// Duration Duration of the video in seconds as defined by the sender
|
||||
Duration int `json:"duration"`
|
||||
// MIMEType Optional. MIME type of the file as defined by the sender
|
||||
MIMEType string `json:"mime_type,omitempty"`
|
||||
// FileSize Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have
|
||||
// difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit
|
||||
// integer or double-precision float type are safe for storing this value.
|
||||
FileSize int64 `json:"file_size,omitempty"`
|
||||
}
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
package tgapi
|
||||
|
||||
import "testing"
|
||||
|
||||
func TestPollAnswerVoterHelpers(t *testing.T) {
|
||||
userAnswer := PollAnswer{User: User{ID: 42}}
|
||||
user, ok := userAnswer.VoterUser()
|
||||
if !ok || user.ID != 42 {
|
||||
t.Fatalf("unexpected voter user: %#v, %v", user, ok)
|
||||
}
|
||||
if chat, ok := userAnswer.VoterChatInfo(); ok || chat != nil {
|
||||
t.Fatalf("unexpected voter chat: %#v, %v", chat, ok)
|
||||
}
|
||||
|
||||
chatAnswer := PollAnswer{VoterChat: Chat{ID: -100}}
|
||||
chat, ok := chatAnswer.VoterChatInfo()
|
||||
if !ok || chat.ID != -100 {
|
||||
t.Fatalf("unexpected voter chat: %#v, %v", chat, ok)
|
||||
}
|
||||
}
|
||||
+198
-26
@@ -3,14 +3,22 @@ package tgapi
|
||||
import "context"
|
||||
|
||||
// SetMyCommands holds parameters for the setMyCommands method.
|
||||
// Since: Bot API 4.7
|
||||
// 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"`
|
||||
// Commands Required. A JSON-serialized list of bot commands to be set as the list of the bot's commands. At
|
||||
// most 100 commands can be specified.
|
||||
Commands []BotCommand `json:"commands"`
|
||||
// Scope Optional. A JSON-serialized object, describing scope of users for which the commands are relevant.
|
||||
// Defaults to BotCommandScopeDefault.
|
||||
Scope *BotCommandScope `json:"scope,omitempty"`
|
||||
// Language Optional. A two-letter ISO 639-1 language code. If empty, commands will be applied to all users
|
||||
// from the given scope, for whose language there are no dedicated commands.
|
||||
Language string `json:"language_code,omitempty"`
|
||||
}
|
||||
|
||||
// SetMyCommands changes the list of the bot's commands.
|
||||
// Since: Bot API 4.7
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#setmycommands
|
||||
func (api *API) SetMyCommands(params SetMyCommands) (bool, error) {
|
||||
@@ -19,6 +27,7 @@ func (api *API) SetMyCommands(params SetMyCommands) (bool, error) {
|
||||
}
|
||||
|
||||
// SetMyCommandsWithContext is the context-aware variant of SetMyCommands.
|
||||
// Since: Bot API 4.7
|
||||
// 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) {
|
||||
@@ -27,13 +36,19 @@ func (api *API) SetMyCommandsWithContext(ctx context.Context, params SetMyComman
|
||||
}
|
||||
|
||||
// DeleteMyCommands holds parameters for the deleteMyCommands method.
|
||||
// Since: Bot API 5.3
|
||||
// See https://core.telegram.org/bots/api#deletemycommands
|
||||
type DeleteMyCommands struct {
|
||||
Scope *BotCommandScope `json:"scope,omitempty"`
|
||||
Language string `json:"language_code,omitempty"`
|
||||
// Scope Optional. A JSON-serialized object, describing scope of users for which the commands are relevant.
|
||||
// Defaults to BotCommandScopeDefault.
|
||||
Scope *BotCommandScope `json:"scope,omitempty"`
|
||||
// Language Optional. A two-letter ISO 639-1 language code. If empty, commands will be applied to all users
|
||||
// from the given scope, for whose language there are no dedicated commands.
|
||||
Language string `json:"language_code,omitempty"`
|
||||
}
|
||||
|
||||
// DeleteMyCommands deletes the list of the bot's commands for the given scope and user language.
|
||||
// Since: Bot API 5.3
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#deletemycommands
|
||||
func (api *API) DeleteMyCommands(params DeleteMyCommands) (bool, error) {
|
||||
@@ -42,6 +57,7 @@ func (api *API) DeleteMyCommands(params DeleteMyCommands) (bool, error) {
|
||||
}
|
||||
|
||||
// DeleteMyCommandsWithContext is the context-aware variant of DeleteMyCommands.
|
||||
// Since: Bot API 5.3
|
||||
// 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) {
|
||||
@@ -50,13 +66,17 @@ func (api *API) DeleteMyCommandsWithContext(ctx context.Context, params DeleteMy
|
||||
}
|
||||
|
||||
// GetMyCommands holds parameters for the getMyCommands method.
|
||||
// Since: Bot API 4.7
|
||||
// See https://core.telegram.org/bots/api#getmycommands
|
||||
type GetMyCommands struct {
|
||||
Scope *BotCommandScope `json:"scope,omitempty"`
|
||||
Language string `json:"language_code,omitempty"`
|
||||
// Scope Optional. A JSON-serialized object, describing scope of users. Defaults to BotCommandScopeDefault.
|
||||
Scope *BotCommandScope `json:"scope,omitempty"`
|
||||
// Language Optional. A two-letter ISO 639-1 language code or an empty string
|
||||
Language string `json:"language_code,omitempty"`
|
||||
}
|
||||
|
||||
// GetMyCommands returns the current list of the bot's commands for the given scope and user language.
|
||||
// Since: Bot API 4.7
|
||||
// See https://core.telegram.org/bots/api#getmycommands
|
||||
func (api *API) GetMyCommands(params GetMyCommands) ([]BotCommand, error) {
|
||||
req := NewRequest[[]BotCommand]("getMyCommands", params)
|
||||
@@ -64,6 +84,7 @@ func (api *API) GetMyCommands(params GetMyCommands) ([]BotCommand, error) {
|
||||
}
|
||||
|
||||
// GetMyCommandsWithContext is the context-aware variant of GetMyCommands.
|
||||
// Since: Bot API 4.7
|
||||
// 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) {
|
||||
@@ -72,13 +93,19 @@ func (api *API) GetMyCommandsWithContext(ctx context.Context, params GetMyComman
|
||||
}
|
||||
|
||||
// SetMyName holds parameters for the setMyName method.
|
||||
// Since: Bot API 6.7
|
||||
// See https://core.telegram.org/bots/api#setmyname
|
||||
type SetMyName struct {
|
||||
Name string `json:"name"`
|
||||
// Name Optional. New bot name; 0-64 characters. Pass an empty string to remove the dedicated name for the
|
||||
// given language.
|
||||
Name string `json:"name"`
|
||||
// Language Optional. A two-letter ISO 639-1 language code. If empty, the name will be shown to all users
|
||||
// for whose language there is no dedicated name.
|
||||
Language string `json:"language_code,omitempty"`
|
||||
}
|
||||
|
||||
// SetMyName changes the bot's name.
|
||||
// Since: Bot API 6.7
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#setmyname
|
||||
func (api *API) SetMyName(params SetMyName) (bool, error) {
|
||||
@@ -87,6 +114,7 @@ func (api *API) SetMyName(params SetMyName) (bool, error) {
|
||||
}
|
||||
|
||||
// SetMyNameWithContext is the context-aware variant of SetMyName.
|
||||
// Since: Bot API 6.7
|
||||
// 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) {
|
||||
@@ -95,12 +123,15 @@ func (api *API) SetMyNameWithContext(ctx context.Context, params SetMyName) (boo
|
||||
}
|
||||
|
||||
// GetMyName holds parameters for the getMyName method.
|
||||
// Since: Bot API 6.7
|
||||
// See https://core.telegram.org/bots/api#getmyname
|
||||
type GetMyName struct {
|
||||
// Language Optional. A two-letter ISO 639-1 language code or an empty string
|
||||
Language string `json:"language_code,omitempty"`
|
||||
}
|
||||
|
||||
// GetMyName returns the bot's name for the given language.
|
||||
// Since: Bot API 6.7
|
||||
// See https://core.telegram.org/bots/api#getmyname
|
||||
func (api *API) GetMyName(params GetMyName) (BotName, error) {
|
||||
req := NewRequest[BotName]("getMyName", params)
|
||||
@@ -108,6 +139,7 @@ func (api *API) GetMyName(params GetMyName) (BotName, error) {
|
||||
}
|
||||
|
||||
// GetMyNameWithContext is the context-aware variant of GetMyName.
|
||||
// Since: Bot API 6.7
|
||||
// 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) {
|
||||
@@ -116,13 +148,19 @@ func (api *API) GetMyNameWithContext(ctx context.Context, params GetMyName) (Bot
|
||||
}
|
||||
|
||||
// SetMyDescription holds parameters for the setMyDescription method.
|
||||
// Since: Bot API 6.6
|
||||
// See https://core.telegram.org/bots/api#setmydescription
|
||||
type SetMyDescription struct {
|
||||
// Description Optional. New bot description; 0-512 characters. Pass an empty string to remove the dedicated
|
||||
// description for the given language.
|
||||
Description string `json:"description"`
|
||||
Language string `json:"language_code,omitempty"`
|
||||
// Language Optional. A two-letter ISO 639-1 language code. If empty, the description will be applied to all
|
||||
// users for whose language there is no dedicated description.
|
||||
Language string `json:"language_code,omitempty"`
|
||||
}
|
||||
|
||||
// SetMyDescription changes the bot's description.
|
||||
// Since: Bot API 6.6
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#setmydescription
|
||||
func (api *API) SetMyDescription(params SetMyDescription) (bool, error) {
|
||||
@@ -131,6 +169,7 @@ func (api *API) SetMyDescription(params SetMyDescription) (bool, error) {
|
||||
}
|
||||
|
||||
// SetMyDescriptionWithContext is the context-aware variant of SetMyDescription.
|
||||
// Since: Bot API 6.6
|
||||
// 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) {
|
||||
@@ -139,12 +178,15 @@ func (api *API) SetMyDescriptionWithContext(ctx context.Context, params SetMyDes
|
||||
}
|
||||
|
||||
// GetMyDescription holds parameters for the getMyDescription method.
|
||||
// Since: Bot API 6.6
|
||||
// See https://core.telegram.org/bots/api#getmydescription
|
||||
type GetMyDescription struct {
|
||||
// Language Optional. A two-letter ISO 639-1 language code or an empty string
|
||||
Language string `json:"language_code,omitempty"`
|
||||
}
|
||||
|
||||
// GetMyDescription returns the bot's description for the given language.
|
||||
// Since: Bot API 6.6
|
||||
// See https://core.telegram.org/bots/api#getmydescription
|
||||
func (api *API) GetMyDescription(params GetMyDescription) (BotDescription, error) {
|
||||
req := NewRequest[BotDescription]("getMyDescription", params)
|
||||
@@ -152,6 +194,7 @@ func (api *API) GetMyDescription(params GetMyDescription) (BotDescription, error
|
||||
}
|
||||
|
||||
// GetMyDescriptionWithContext is the context-aware variant of GetMyDescription.
|
||||
// Since: Bot API 6.6
|
||||
// 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) {
|
||||
@@ -160,13 +203,19 @@ func (api *API) GetMyDescriptionWithContext(ctx context.Context, params GetMyDes
|
||||
}
|
||||
|
||||
// SetMyShortDescription holds parameters for the setMyShortDescription method.
|
||||
// Since: Bot API 6.6
|
||||
// See https://core.telegram.org/bots/api#setmyshortdescription
|
||||
type SetMyShortDescription struct {
|
||||
// ShortDescription Optional. New short description for the bot; 0-120 characters. Pass an empty string to
|
||||
// remove the dedicated short description for the given language.
|
||||
ShortDescription string `json:"short_description,omitempty"`
|
||||
Language string `json:"language_code,omitempty"`
|
||||
// Language Optional. A two-letter ISO 639-1 language code. If empty, the short description will be applied
|
||||
// to all users for whose language there is no dedicated short description.
|
||||
Language string `json:"language_code,omitempty"`
|
||||
}
|
||||
|
||||
// SetMyShortDescription changes the bot's short description.
|
||||
// Since: Bot API 6.6
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#setmyshortdescription
|
||||
func (api *API) SetMyShortDescription(params SetMyShortDescription) (bool, error) {
|
||||
@@ -175,6 +224,7 @@ func (api *API) SetMyShortDescription(params SetMyShortDescription) (bool, error
|
||||
}
|
||||
|
||||
// SetMyShortDescriptionWithContext is the context-aware variant of SetMyShortDescription.
|
||||
// Since: Bot API 6.6
|
||||
// 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) {
|
||||
@@ -183,12 +233,15 @@ func (api *API) SetMyShortDescriptionWithContext(ctx context.Context, params Set
|
||||
}
|
||||
|
||||
// GetMyShortDescription holds parameters for the getMyShortDescription method.
|
||||
// Since: Bot API 6.6
|
||||
// See https://core.telegram.org/bots/api#getmyshortdescription
|
||||
type GetMyShortDescription struct {
|
||||
// Language Optional. A two-letter ISO 639-1 language code or an empty string
|
||||
Language string `json:"language_code,omitempty"`
|
||||
}
|
||||
|
||||
// GetMyShortDescription returns the bot's short description for the given language.
|
||||
// Since: Bot API 6.6
|
||||
// See https://core.telegram.org/bots/api#getmyshortdescription
|
||||
func (api *API) GetMyShortDescription(params GetMyShortDescription) (BotShortDescription, error) {
|
||||
req := NewRequest[BotShortDescription]("getMyShortDescription", params)
|
||||
@@ -196,6 +249,7 @@ func (api *API) GetMyShortDescription(params GetMyShortDescription) (BotShortDes
|
||||
}
|
||||
|
||||
// GetMyShortDescriptionWithContext is the context-aware variant of GetMyShortDescription.
|
||||
// Since: Bot API 6.6
|
||||
// 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) {
|
||||
@@ -204,12 +258,15 @@ func (api *API) GetMyShortDescriptionWithContext(ctx context.Context, params Get
|
||||
}
|
||||
|
||||
// SetMyProfilePhoto holds parameters for the setMyProfilePhoto method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#setmyprofilephoto
|
||||
type SetMyProfilePhoto struct {
|
||||
// Photo Required. The new profile photo to set
|
||||
Photo InputProfilePhoto `json:"photo"`
|
||||
}
|
||||
|
||||
// SetMyProfilePhoto changes the bot's profile photo.
|
||||
// Since: Bot API 9.0
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#setmyprofilephoto
|
||||
func (api *API) SetMyProfilePhoto(params SetMyProfilePhoto) (bool, error) {
|
||||
@@ -218,6 +275,7 @@ func (api *API) SetMyProfilePhoto(params SetMyProfilePhoto) (bool, error) {
|
||||
}
|
||||
|
||||
// SetMyProfilePhotoWithContext is the context-aware variant of SetMyProfilePhoto.
|
||||
// Since: Bot API 9.0
|
||||
// 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) {
|
||||
@@ -226,6 +284,7 @@ func (api *API) SetMyProfilePhotoWithContext(ctx context.Context, params SetMyPr
|
||||
}
|
||||
|
||||
// RemoveMyProfilePhoto removes the bot's profile photo.
|
||||
// Since: Bot API 9.0
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#removemyprofilephoto
|
||||
func (api *API) RemoveMyProfilePhoto() (bool, error) {
|
||||
@@ -234,6 +293,7 @@ func (api *API) RemoveMyProfilePhoto() (bool, error) {
|
||||
}
|
||||
|
||||
// RemoveMyProfilePhotoWithContext is the context-aware variant of RemoveMyProfilePhoto.
|
||||
// Since: Bot API 9.0
|
||||
// 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) {
|
||||
@@ -242,13 +302,19 @@ func (api *API) RemoveMyProfilePhotoWithContext(ctx context.Context) (bool, erro
|
||||
}
|
||||
|
||||
// SetChatMenuButton holds parameters for the setChatMenuButton method.
|
||||
// Since: Bot API 6.0
|
||||
// See https://core.telegram.org/bots/api#setchatmenubutton
|
||||
type SetChatMenuButton struct {
|
||||
ChatID int64 `json:"chat_id,omitempty"`
|
||||
// ChatID Optional. Unique identifier for the target private chat. If not specified, the bot's default menu
|
||||
// button will be changed.
|
||||
ChatID int64 `json:"chat_id,omitempty"`
|
||||
// MenuButton Optional. A JSON-serialized object for the bot's new menu button. Defaults to
|
||||
// MenuButtonDefault.
|
||||
MenuButton *MenuButton `json:"menu_button,omitempty"`
|
||||
}
|
||||
|
||||
// SetChatMenuButton changes the menu button for a given chat or the default menu button.
|
||||
// Since: Bot API 6.0
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#setchatmenubutton
|
||||
func (api *API) SetChatMenuButton(params SetChatMenuButton) (bool, error) {
|
||||
@@ -257,6 +323,7 @@ func (api *API) SetChatMenuButton(params SetChatMenuButton) (bool, error) {
|
||||
}
|
||||
|
||||
// SetChatMenuButtonWithContext is the context-aware variant of SetChatMenuButton.
|
||||
// Since: Bot API 6.0
|
||||
// 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) {
|
||||
@@ -265,12 +332,16 @@ func (api *API) SetChatMenuButtonWithContext(ctx context.Context, params SetChat
|
||||
}
|
||||
|
||||
// GetChatMenuButton holds parameters for the getChatMenuButton method.
|
||||
// Since: Bot API 6.0
|
||||
// See https://core.telegram.org/bots/api#getchatmenubutton
|
||||
type GetChatMenuButton struct {
|
||||
// ChatID Optional. Unique identifier for the target private chat. If not specified, the bot's default menu
|
||||
// button will be returned.
|
||||
ChatID int64 `json:"chat_id,omitempty"`
|
||||
}
|
||||
|
||||
// GetChatMenuButton returns the current menu button for the given chat.
|
||||
// Since: Bot API 6.0
|
||||
// See https://core.telegram.org/bots/api#getchatmenubutton
|
||||
func (api *API) GetChatMenuButton(params GetChatMenuButton) (MenuButton, error) {
|
||||
req := NewRequest[MenuButton]("getChatMenuButton", params)
|
||||
@@ -278,6 +349,7 @@ func (api *API) GetChatMenuButton(params GetChatMenuButton) (MenuButton, error)
|
||||
}
|
||||
|
||||
// GetChatMenuButtonWithContext is the context-aware variant of GetChatMenuButton.
|
||||
// Since: Bot API 6.0
|
||||
// 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) {
|
||||
@@ -286,13 +358,19 @@ func (api *API) GetChatMenuButtonWithContext(ctx context.Context, params GetChat
|
||||
}
|
||||
|
||||
// SetMyDefaultAdministratorRights holds parameters for the setMyDefaultAdministratorRights method.
|
||||
// Since: Bot API 6.0
|
||||
// See https://core.telegram.org/bots/api#setmydefaultadministratorrights
|
||||
type SetMyDefaultAdministratorRights struct {
|
||||
Rights *ChatAdministratorRights `json:"rights"`
|
||||
ForChannels bool `json:"for_channels"`
|
||||
// Rights Optional. A JSON-serialized object describing new default administrator rights. If not specified,
|
||||
// the default administrator rights will be cleared.
|
||||
Rights *ChatAdministratorRights `json:"rights"`
|
||||
// ForChannels Optional. Pass True to change the default administrator rights of the bot in channels.
|
||||
// Otherwise, the default administrator rights of the bot for groups and supergroups will be changed.
|
||||
ForChannels bool `json:"for_channels"`
|
||||
}
|
||||
|
||||
// SetMyDefaultAdministratorRights changes the default administrator rights for the bot.
|
||||
// Since: Bot API 6.0
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#setmydefaultadministratorrights
|
||||
func (api *API) SetMyDefaultAdministratorRights(params SetMyDefaultAdministratorRights) (bool, error) {
|
||||
@@ -301,6 +379,7 @@ func (api *API) SetMyDefaultAdministratorRights(params SetMyDefaultAdministrator
|
||||
}
|
||||
|
||||
// SetMyDefaultAdministratorRightsWithContext is the context-aware variant of SetMyDefaultAdministratorRights.
|
||||
// Since: Bot API 6.0
|
||||
// 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) {
|
||||
@@ -309,12 +388,16 @@ func (api *API) SetMyDefaultAdministratorRightsWithContext(ctx context.Context,
|
||||
}
|
||||
|
||||
// GetMyDefaultAdministratorRights holds parameters for the getMyDefaultAdministratorRights method.
|
||||
// Since: Bot API 6.0
|
||||
// See https://core.telegram.org/bots/api#getmydefaultadministratorrights
|
||||
type GetMyDefaultAdministratorRights struct {
|
||||
// ForChannels Optional. Pass True to get default administrator rights of the bot in channels. Otherwise,
|
||||
// default administrator rights of the bot for groups and supergroups will be returned.
|
||||
ForChannels bool `json:"for_channels"`
|
||||
}
|
||||
|
||||
// GetMyDefaultAdministratorRights returns the current default administrator rights for the bot.
|
||||
// Since: Bot API 6.0
|
||||
// See https://core.telegram.org/bots/api#getmydefaultadministratorrights
|
||||
func (api *API) GetMyDefaultAdministratorRights(params GetMyDefaultAdministratorRights) (ChatAdministratorRights, error) {
|
||||
req := NewRequest[ChatAdministratorRights]("getMyDefaultAdministratorRights", params)
|
||||
@@ -322,6 +405,7 @@ func (api *API) GetMyDefaultAdministratorRights(params GetMyDefaultAdministrator
|
||||
}
|
||||
|
||||
// GetMyDefaultAdministratorRightsWithContext is the context-aware variant of GetMyDefaultAdministratorRights.
|
||||
// Since: Bot API 6.0
|
||||
// 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) {
|
||||
@@ -330,6 +414,7 @@ func (api *API) GetMyDefaultAdministratorRightsWithContext(ctx context.Context,
|
||||
}
|
||||
|
||||
// GetAvailableGifts returns the list of gifts that can be sent by the bot.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#getavailablegifts
|
||||
func (api *API) GetAvailableGifts() (Gifts, error) {
|
||||
req := NewRequest[Gifts]("getAvailableGifts", NoParams)
|
||||
@@ -337,6 +422,7 @@ func (api *API) GetAvailableGifts() (Gifts, error) {
|
||||
}
|
||||
|
||||
// GetAvailableGiftsWithContext is the context-aware variant of GetAvailableGifts.
|
||||
// Since: Bot API 9.0
|
||||
// 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) {
|
||||
@@ -345,18 +431,34 @@ func (api *API) GetAvailableGiftsWithContext(ctx context.Context) (Gifts, error)
|
||||
}
|
||||
|
||||
// SendGift holds parameters for the sendGift method.
|
||||
// Since: Bot API 9.0
|
||||
// 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"`
|
||||
// UserID Optional. Required if chat_id is not specified. Unique identifier of the target user who will
|
||||
// receive the gift.
|
||||
UserID int64 `json:"user_id,omitempty"`
|
||||
// ChatID Optional. Required if user_id is not specified. Unique identifier for the chat or username of the
|
||||
// channel (in the format @username) that will receive the gift.
|
||||
ChatID int64 `json:"chat_id,omitempty"`
|
||||
// GiftID Required. Identifier of the gift; limited gifts can't be sent to channel chats
|
||||
GiftID string `json:"gift_id"`
|
||||
// PayForUpgrade Optional. Pass True to pay for the gift upgrade from the bot's balance, thereby making the
|
||||
// upgrade free for the receiver
|
||||
PayForUpgrade bool `json:"pay_for_upgrade"`
|
||||
// Text Optional. Text that will be shown along with the gift; 0-128 characters
|
||||
Text string `json:"text"`
|
||||
// TextParseMode Optional. Mode for parsing entities in the text. See formatting options for more details.
|
||||
// Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”,
|
||||
// “custom_emoji”, and “date_time” are ignored.
|
||||
TextParseMode ParseMode `json:"text_parse_mode,omitempty"`
|
||||
// TextEntities Optional. A JSON-serialized list of special entities that appear in the gift text. It can be
|
||||
// specified instead of text_parse_mode. Entities other than “bold”, “italic”, “underline”,
|
||||
// “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored.
|
||||
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
||||
}
|
||||
|
||||
// SendGift sends a gift to the given user or chat.
|
||||
// Since: Bot API 9.0
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#sendgift
|
||||
func (api *API) SendGift(params SendGift) (bool, error) {
|
||||
@@ -365,6 +467,7 @@ func (api *API) SendGift(params SendGift) (bool, error) {
|
||||
}
|
||||
|
||||
// SendGiftWithContext is the context-aware variant of SendGift.
|
||||
// Since: Bot API 9.0
|
||||
// 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) {
|
||||
@@ -373,17 +476,32 @@ func (api *API) SendGiftWithContext(ctx context.Context, params SendGift) (bool,
|
||||
}
|
||||
|
||||
// GiftPremiumSubscription holds parameters for the giftPremiumSubscription method.
|
||||
// Since: Bot API 9.0
|
||||
// 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"`
|
||||
// UserID Required. Unique identifier of the target user who will receive a Telegram Premium subscription
|
||||
UserID int64 `json:"user_id"`
|
||||
// MonthCount Required. Number of months the Telegram Premium subscription will be active for the user; must
|
||||
// be one of 3, 6, or 12
|
||||
MonthCount int `json:"month_count"`
|
||||
// StarCount Required. Number of Telegram Stars to pay for the Telegram Premium subscription; must be 1000
|
||||
// for 3 months, 1500 for 6 months, and 2500 for 12 months
|
||||
StarCount int `json:"star_count"`
|
||||
// Text Optional. Text that will be shown along with the service message about the subscription; 0-128
|
||||
// characters
|
||||
Text string `json:"text,omitempty"`
|
||||
// TextParseMode Optional. Mode for parsing entities in the text. See formatting options for more details.
|
||||
// Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”,
|
||||
// “custom_emoji”, and “date_time” are ignored.
|
||||
TextParseMode ParseMode `json:"text_parse_mode,omitempty"`
|
||||
// TextEntities Optional. A JSON-serialized list of special entities that appear in the gift text. It can be
|
||||
// specified instead of text_parse_mode. Entities other than “bold”, “italic”, “underline”,
|
||||
// “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored.
|
||||
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
||||
}
|
||||
|
||||
// GiftPremiumSubscription gifts a Telegram Premium subscription to the user.
|
||||
// Since: Bot API 9.0
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#giftpremiumsubscription
|
||||
func (api *API) GiftPremiumSubscription(params GiftPremiumSubscription) (bool, error) {
|
||||
@@ -392,9 +510,63 @@ func (api *API) GiftPremiumSubscription(params GiftPremiumSubscription) (bool, e
|
||||
}
|
||||
|
||||
// GiftPremiumSubscriptionWithContext is the context-aware variant of GiftPremiumSubscription.
|
||||
// Since: Bot API 9.0
|
||||
// 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)
|
||||
}
|
||||
|
||||
// GetManagedBotAccessSettings holds parameters for the getManagedBotAccessSettings method.
|
||||
// Since: Bot API 10.0
|
||||
// See https://core.telegram.org/bots/api#getmanagedbotaccesssettings
|
||||
type GetManagedBotAccessSettings struct {
|
||||
// BotUserID identifies the managed bot.
|
||||
BotUserID int64 `json:"bot_user_id"`
|
||||
}
|
||||
|
||||
// GetManagedBotAccessSettings returns the access settings of a managed bot.
|
||||
// Since: Bot API 10.0
|
||||
// See https://core.telegram.org/bots/api#getmanagedbotaccesssettings
|
||||
func (api *API) GetManagedBotAccessSettings(params GetManagedBotAccessSettings) (BotAccessSettings, error) {
|
||||
req := NewRequest[BotAccessSettings]("getManagedBotAccessSettings", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// GetManagedBotAccessSettingsWithContext is the context-aware variant of GetManagedBotAccessSettings.
|
||||
// Since: Bot API 10.0
|
||||
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||
// See https://core.telegram.org/bots/api#getmanagedbotaccesssettings
|
||||
func (api *API) GetManagedBotAccessSettingsWithContext(ctx context.Context, params GetManagedBotAccessSettings) (BotAccessSettings, error) {
|
||||
req := NewRequest[BotAccessSettings]("getManagedBotAccessSettings", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
}
|
||||
|
||||
// SetManagedBotAccessSettings holds parameters for the setManagedBotAccessSettings method.
|
||||
// Since: Bot API 10.0
|
||||
// See https://core.telegram.org/bots/api#setmanagedbotaccesssettings
|
||||
type SetManagedBotAccessSettings struct {
|
||||
// BotUserID identifies the managed bot.
|
||||
BotUserID int64 `json:"bot_user_id"`
|
||||
// AccessSettings contains the access settings to apply to the managed bot.
|
||||
AccessSettings BotAccessSettings `json:"access_settings"`
|
||||
}
|
||||
|
||||
// SetManagedBotAccessSettings changes the access settings of a managed bot.
|
||||
// Since: Bot API 10.0
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#setmanagedbotaccesssettings
|
||||
func (api *API) SetManagedBotAccessSettings(params SetManagedBotAccessSettings) (bool, error) {
|
||||
req := NewRequest[bool]("setManagedBotAccessSettings", params)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
// SetManagedBotAccessSettingsWithContext is the context-aware variant of SetManagedBotAccessSettings.
|
||||
// Since: Bot API 10.0
|
||||
// It executes the same request but uses ctx for cancellation and deadlines.
|
||||
// See https://core.telegram.org/bots/api#setmanagedbotaccesssettings
|
||||
func (api *API) SetManagedBotAccessSettingsWithContext(ctx context.Context, params SetManagedBotAccessSettings) (bool, error) {
|
||||
req := NewRequest[bool]("setManagedBotAccessSettings", params)
|
||||
return req.DoWithContext(ctx, api)
|
||||
}
|
||||
|
||||
+48
-6
@@ -1,10 +1,16 @@
|
||||
package tgapi
|
||||
|
||||
// BotCommand represents a bot command.
|
||||
// Since: Bot API 4.7
|
||||
// See https://core.telegram.org/bots/api#botcommand
|
||||
type BotCommand struct {
|
||||
Command string `json:"command"`
|
||||
// Command Text of the command; 1-32 characters. Can contain only lowercase English letters, digits and
|
||||
// underscores.
|
||||
Command string `json:"command"`
|
||||
// Description Description of the command; 1-256 characters
|
||||
Description string `json:"description"`
|
||||
// IsEphemeral marks the command as visible only in ephemeral command contexts.
|
||||
IsEphemeral bool `json:"is_ephemeral,omitempty"` // Since: Bot API 10.2
|
||||
}
|
||||
|
||||
// BotCommandScopeType indicates the type of a command scope.
|
||||
@@ -28,25 +34,36 @@ const (
|
||||
)
|
||||
|
||||
// BotCommandScope represents the scope to which bot commands are applied.
|
||||
// Since: Bot API 5.3
|
||||
// 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"`
|
||||
// Type identifies the concrete command-scope variant.
|
||||
Type BotCommandScopeType `json:"type"`
|
||||
// ChatID Unique identifier for the target chat or username of the target supergroup in the format
|
||||
// @username. Channel direct messages chats and channel chats aren't supported.
|
||||
ChatID *int64 `json:"chat_id,omitempty"`
|
||||
// UserID Unique identifier of the target user
|
||||
UserID *int64 `json:"user_id,omitempty"`
|
||||
}
|
||||
|
||||
// BotName represents the bot's name.
|
||||
// Since: Bot API 6.7
|
||||
type BotName struct {
|
||||
// Name The bot's name
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
// BotDescription represents the bot's description.
|
||||
// Since: Bot API 6.6
|
||||
type BotDescription struct {
|
||||
// Description The bot's description
|
||||
Description string `json:"description"`
|
||||
}
|
||||
|
||||
// BotShortDescription represents the bot's short description.
|
||||
// Since: Bot API 6.6
|
||||
type BotShortDescription struct {
|
||||
// ShortDescription The bot's short description
|
||||
ShortDescription string `json:"short_description"`
|
||||
}
|
||||
|
||||
@@ -61,15 +78,25 @@ const (
|
||||
)
|
||||
|
||||
// InputProfilePhoto describes a profile photo to set.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#inputprofilephoto
|
||||
type InputProfilePhoto struct {
|
||||
// Type identifies the static-photo or animated-photo variant.
|
||||
Type InputProfilePhotoType `json:"type"`
|
||||
|
||||
// Photo The static profile photo. Profile photos can't be reused and can only be uploaded as a new file, so
|
||||
// you can pass “attach://<file_attach_name>” if the photo was uploaded using multipart/form-data under
|
||||
// <file_attach_name>. More information on Sending Files »
|
||||
// Static fields (for static photos)
|
||||
Photo *string `json:"photo,omitempty"`
|
||||
|
||||
// Animation The animated profile photo. Profile photos can't be reused and can only be uploaded as a new
|
||||
// file, so you can pass “attach://<file_attach_name>” if the photo was uploaded using
|
||||
// multipart/form-data under <file_attach_name>. More information on Sending Files »
|
||||
// Animated fields (for animated profile videos)
|
||||
Animation *string `json:"animation,omitempty"`
|
||||
Animation *string `json:"animation,omitempty"`
|
||||
// MainFrameTimestamp Optional. Timestamp in seconds of the frame that will be used as the static profile
|
||||
// photo. Defaults to 0.0.
|
||||
MainFrameTimestamp *float64 `json:"main_frame_timestamp,omitempty"`
|
||||
}
|
||||
|
||||
@@ -86,11 +113,26 @@ const (
|
||||
)
|
||||
|
||||
// MenuButton represents a menu button.
|
||||
// Since: Bot API 6.0
|
||||
// See https://core.telegram.org/bots/api#menubutton
|
||||
type MenuButton struct {
|
||||
// Type identifies the commands, web_app, or default menu-button variant.
|
||||
Type MenuButtonType `json:"type"`
|
||||
|
||||
// Text Text on the button
|
||||
// WebApp fields (for web_app button)
|
||||
Text *string `json:"text"`
|
||||
Text *string `json:"text"`
|
||||
// WebApp Description of the Web App that will be launched when the user presses the button. The Web App
|
||||
// will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery.
|
||||
// Alternatively, a t.me link to a Web App of the bot can be specified in the object instead of the Web
|
||||
// App's URL, in which case the Web App will be opened as if the user pressed the link.
|
||||
WebApp *WebAppInfo `json:"web_app"`
|
||||
}
|
||||
|
||||
// BotAccessSettings describes access settings of a managed bot.
|
||||
// Since: Bot API 10.0
|
||||
// See https://core.telegram.org/bots/api#botaccesssettings
|
||||
type BotAccessSettings struct {
|
||||
// AllowAllPrivateChats reports whether the managed bot may access all private chats of its owner.
|
||||
AllowAllPrivateChats bool `json:"allow_all_private_chats"`
|
||||
}
|
||||
|
||||
+228
-54
@@ -3,13 +3,18 @@ package tgapi
|
||||
import "context"
|
||||
|
||||
// VerifyUser holds parameters for the verifyUser method.
|
||||
// Since: Bot API 8.0
|
||||
// See https://core.telegram.org/bots/api#verifyuser
|
||||
type VerifyUser struct {
|
||||
UserID int64 `json:"user_id"`
|
||||
// UserID Required. Unique identifier of the target user
|
||||
UserID int64 `json:"user_id"`
|
||||
// CustomDescription Optional. Custom description for the verification; 0-70 characters. Must be empty if
|
||||
// the organization isn't allowed to provide a custom verification description.
|
||||
CustomDescription string `json:"custom_description,omitempty"`
|
||||
}
|
||||
|
||||
// VerifyUser verifies a user.
|
||||
// Since: Bot API 8.0
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#verifyuser
|
||||
func (api *API) VerifyUser(params VerifyUser) (bool, error) {
|
||||
@@ -18,6 +23,7 @@ func (api *API) VerifyUser(params VerifyUser) (bool, error) {
|
||||
}
|
||||
|
||||
// VerifyUserWithContext is the context-aware variant of VerifyUser.
|
||||
// Since: Bot API 8.0
|
||||
// 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) {
|
||||
@@ -26,13 +32,19 @@ func (api *API) VerifyUserWithContext(ctx context.Context, params VerifyUser) (b
|
||||
}
|
||||
|
||||
// VerifyChat holds parameters for the verifyChat method.
|
||||
// Since: Bot API 8.0
|
||||
// See https://core.telegram.org/bots/api#verifychat
|
||||
type VerifyChat struct {
|
||||
ChatID int64 `json:"chat_id"`
|
||||
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||
// channel in the format @username. Channel direct messages chats can't be verified.
|
||||
ChatID int64 `json:"chat_id"`
|
||||
// CustomDescription Optional. Custom description for the verification; 0-70 characters. Must be empty if
|
||||
// the organization isn't allowed to provide a custom verification description.
|
||||
CustomDescription string `json:"custom_description,omitempty"`
|
||||
}
|
||||
|
||||
// VerifyChat verifies a chat.
|
||||
// Since: Bot API 8.0
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#verifychat
|
||||
func (api *API) VerifyChat(params VerifyChat) (bool, error) {
|
||||
@@ -41,6 +53,7 @@ func (api *API) VerifyChat(params VerifyChat) (bool, error) {
|
||||
}
|
||||
|
||||
// VerifyChatWithContext is the context-aware variant of VerifyChat.
|
||||
// Since: Bot API 8.0
|
||||
// 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) {
|
||||
@@ -49,12 +62,15 @@ func (api *API) VerifyChatWithContext(ctx context.Context, params VerifyChat) (b
|
||||
}
|
||||
|
||||
// RemoveUserVerification holds parameters for the removeUserVerification method.
|
||||
// Since: Bot API 8.0
|
||||
// See https://core.telegram.org/bots/api#removeuserverification
|
||||
type RemoveUserVerification struct {
|
||||
// UserID Required. Unique identifier of the target user
|
||||
UserID int64 `json:"user_id"`
|
||||
}
|
||||
|
||||
// RemoveUserVerification removes a user's verification.
|
||||
// Since: Bot API 8.0
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#removeuserverification
|
||||
func (api *API) RemoveUserVerification(params RemoveUserVerification) (bool, error) {
|
||||
@@ -63,6 +79,7 @@ func (api *API) RemoveUserVerification(params RemoveUserVerification) (bool, err
|
||||
}
|
||||
|
||||
// RemoveUserVerificationWithContext is the context-aware variant of RemoveUserVerification.
|
||||
// Since: Bot API 8.0
|
||||
// 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) {
|
||||
@@ -71,12 +88,16 @@ func (api *API) RemoveUserVerificationWithContext(ctx context.Context, params Re
|
||||
}
|
||||
|
||||
// RemoveChatVerification holds parameters for the removeChatVerification method.
|
||||
// Since: Bot API 8.0
|
||||
// See https://core.telegram.org/bots/api#removechatverification
|
||||
type RemoveChatVerification struct {
|
||||
// ChatID Required. Unique identifier for the target chat or username of the target bot or channel in the
|
||||
// format @username
|
||||
ChatID int64 `json:"chat_id"`
|
||||
}
|
||||
|
||||
// RemoveChatVerification removes a chat's verification.
|
||||
// Since: Bot API 8.0
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#removechatverification
|
||||
func (api *API) RemoveChatVerification(params RemoveChatVerification) (bool, error) {
|
||||
@@ -85,6 +106,7 @@ func (api *API) RemoveChatVerification(params RemoveChatVerification) (bool, err
|
||||
}
|
||||
|
||||
// RemoveChatVerificationWithContext is the context-aware variant of RemoveChatVerification.
|
||||
// Since: Bot API 8.0
|
||||
// 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) {
|
||||
@@ -93,14 +115,21 @@ func (api *API) RemoveChatVerificationWithContext(ctx context.Context, params Re
|
||||
}
|
||||
|
||||
// ReadBusinessMessage holds parameters for the readBusinessMessage method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#readbusinessmessage
|
||||
type ReadBusinessMessage struct {
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection on behalf of which to read
|
||||
// the message
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageID int `json:"message_id"`
|
||||
// ChatID Required. Unique identifier of the chat in which the message was received. The chat must have been
|
||||
// active in the last 24 hours.
|
||||
ChatID int64 `json:"chat_id"`
|
||||
// MessageID Required. Unique identifier of the message to mark as read
|
||||
MessageID int `json:"message_id"`
|
||||
}
|
||||
|
||||
// ReadBusinessMessage marks a business message as read.
|
||||
// Since: Bot API 9.0
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#readbusinessmessage
|
||||
func (api *API) ReadBusinessMessage(params ReadBusinessMessage) (bool, error) {
|
||||
@@ -109,6 +138,7 @@ func (api *API) ReadBusinessMessage(params ReadBusinessMessage) (bool, error) {
|
||||
}
|
||||
|
||||
// ReadBusinessMessageWithContext is the context-aware variant of ReadBusinessMessage.
|
||||
// Since: Bot API 9.0
|
||||
// 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) {
|
||||
@@ -117,12 +147,15 @@ func (api *API) ReadBusinessMessageWithContext(ctx context.Context, params ReadB
|
||||
}
|
||||
|
||||
// GetBusinessConnection holds parameters for the getBusinessConnection method.
|
||||
// Since: Bot API 7.2
|
||||
// See https://core.telegram.org/bots/api#getbusinessconnection
|
||||
type GetBusinessConnection struct {
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
}
|
||||
|
||||
// GetBusinessConnection returns information about a business connection.
|
||||
// Since: Bot API 7.2
|
||||
// See https://core.telegram.org/bots/api#getbusinessconnection
|
||||
func (api *API) GetBusinessConnection(params GetBusinessConnection) (BusinessConnection, error) {
|
||||
req := NewRequest[BusinessConnection]("getBusinessConnection", params)
|
||||
@@ -130,6 +163,7 @@ func (api *API) GetBusinessConnection(params GetBusinessConnection) (BusinessCon
|
||||
}
|
||||
|
||||
// GetBusinessConnectionWithContext is the context-aware variant of GetBusinessConnection.
|
||||
// Since: Bot API 7.2
|
||||
// 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) {
|
||||
@@ -138,13 +172,19 @@ func (api *API) GetBusinessConnectionWithContext(ctx context.Context, params Get
|
||||
}
|
||||
|
||||
// DeleteBusinessMessages holds parameters for the deleteBusinessMessages method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#deletebusinessmessages
|
||||
type DeleteBusinessMessages struct {
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection on behalf of which to delete
|
||||
// the messages
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
MessageIDs []int `json:"message_ids"`
|
||||
// MessageIDs Required. A JSON-serialized list of 1-100 identifiers of messages to delete. All messages must
|
||||
// be from the same chat. See deleteMessage for limitations on which messages can be deleted.
|
||||
MessageIDs []int `json:"message_ids"`
|
||||
}
|
||||
|
||||
// DeleteBusinessMessages deletes business messages.
|
||||
// Since: Bot API 9.0
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#deletebusinessmessages
|
||||
func (api *API) DeleteBusinessMessages(params DeleteBusinessMessages) (bool, error) {
|
||||
@@ -153,6 +193,7 @@ func (api *API) DeleteBusinessMessages(params DeleteBusinessMessages) (bool, err
|
||||
}
|
||||
|
||||
// DeleteBusinessMessagesWithContext is the context-aware variant of DeleteBusinessMessages.
|
||||
// Since: Bot API 9.0
|
||||
// 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) {
|
||||
@@ -161,14 +202,19 @@ func (api *API) DeleteBusinessMessagesWithContext(ctx context.Context, params De
|
||||
}
|
||||
|
||||
// SetBusinessAccountName holds parameters for the setBusinessAccountName method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountname
|
||||
type SetBusinessAccountName struct {
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
FirstName string `json:"first_name"`
|
||||
LastName string `json:"last_name,omitempty"`
|
||||
// FirstName Required. The new value of the first name for the business account; 1-64 characters
|
||||
FirstName string `json:"first_name"`
|
||||
// LastName Optional. The new value of the last name for the business account; 0-64 characters
|
||||
LastName string `json:"last_name,omitempty"`
|
||||
}
|
||||
|
||||
// SetBusinessAccountName sets the first and last name of a business account.
|
||||
// Since: Bot API 9.0
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountname
|
||||
func (api *API) SetBusinessAccountName(params SetBusinessAccountName) (bool, error) {
|
||||
@@ -177,6 +223,7 @@ func (api *API) SetBusinessAccountName(params SetBusinessAccountName) (bool, err
|
||||
}
|
||||
|
||||
// SetBusinessAccountNameWithContext is the context-aware variant of SetBusinessAccountName.
|
||||
// Since: Bot API 9.0
|
||||
// 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) {
|
||||
@@ -185,13 +232,17 @@ func (api *API) SetBusinessAccountNameWithContext(ctx context.Context, params Se
|
||||
}
|
||||
|
||||
// SetBusinessAccountUsername holds parameters for the setBusinessAccountUsername method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountusername
|
||||
type SetBusinessAccountUsername struct {
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
Username string `json:"username,omitempty"`
|
||||
// Username Optional. The new value of the username for the business account; 0-32 characters
|
||||
Username string `json:"username,omitempty"`
|
||||
}
|
||||
|
||||
// SetBusinessAccountUsername sets the username of a business account.
|
||||
// Since: Bot API 9.0
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountusername
|
||||
func (api *API) SetBusinessAccountUsername(params SetBusinessAccountUsername) (bool, error) {
|
||||
@@ -200,6 +251,7 @@ func (api *API) SetBusinessAccountUsername(params SetBusinessAccountUsername) (b
|
||||
}
|
||||
|
||||
// SetBusinessAccountUsernameWithContext is the context-aware variant of SetBusinessAccountUsername.
|
||||
// Since: Bot API 9.0
|
||||
// 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) {
|
||||
@@ -208,13 +260,17 @@ func (api *API) SetBusinessAccountUsernameWithContext(ctx context.Context, param
|
||||
}
|
||||
|
||||
// SetBusinessAccountBio holds parameters for the setBusinessAccountBio method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountbio
|
||||
type SetBusinessAccountBio struct {
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
Bio string `json:"bio,omitempty"`
|
||||
// Bio Optional. The new value of the bio for the business account; 0-140 characters
|
||||
Bio string `json:"bio,omitempty"`
|
||||
}
|
||||
|
||||
// SetBusinessAccountBio sets the bio of a business account.
|
||||
// Since: Bot API 9.0
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountbio
|
||||
func (api *API) SetBusinessAccountBio(params SetBusinessAccountBio) (bool, error) {
|
||||
@@ -223,6 +279,7 @@ func (api *API) SetBusinessAccountBio(params SetBusinessAccountBio) (bool, error
|
||||
}
|
||||
|
||||
// SetBusinessAccountBioWithContext is the context-aware variant of SetBusinessAccountBio.
|
||||
// Since: Bot API 9.0
|
||||
// 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) {
|
||||
@@ -231,14 +288,20 @@ func (api *API) SetBusinessAccountBioWithContext(ctx context.Context, params Set
|
||||
}
|
||||
|
||||
// SetBusinessAccountProfilePhoto holds parameters for the setBusinessAccountProfilePhoto method.
|
||||
// Since: Bot API 9.0
|
||||
// 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"`
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
// Photo Required. The new profile photo to set
|
||||
Photo InputProfilePhoto `json:"photo,omitempty"`
|
||||
// IsPublic Optional. Pass True to set the public photo, which will be visible even if the main photo is
|
||||
// hidden by the business account's privacy settings. An account can have only one public photo.
|
||||
IsPublic bool `json:"is_public,omitempty"`
|
||||
}
|
||||
|
||||
// SetBusinessAccountProfilePhoto sets the profile photo of a business account.
|
||||
// Since: Bot API 9.0
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountprofilephoto
|
||||
func (api *API) SetBusinessAccountProfilePhoto(params SetBusinessAccountProfilePhoto) (bool, error) {
|
||||
@@ -247,6 +310,7 @@ func (api *API) SetBusinessAccountProfilePhoto(params SetBusinessAccountProfileP
|
||||
}
|
||||
|
||||
// SetBusinessAccountProfilePhotoWithContext is the context-aware variant of SetBusinessAccountProfilePhoto.
|
||||
// Since: Bot API 9.0
|
||||
// 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) {
|
||||
@@ -255,13 +319,19 @@ func (api *API) SetBusinessAccountProfilePhotoWithContext(ctx context.Context, p
|
||||
}
|
||||
|
||||
// RemoveBusinessAccountProfilePhoto holds parameters for the removeBusinessAccountProfilePhoto method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#removebusinessaccountprofilephoto
|
||||
type RemoveBusinessAccountProfilePhoto struct {
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
IsPublic bool `json:"is_public,omitempty"`
|
||||
// IsPublic Optional. Pass True to remove the public photo, which is visible even if the main photo is
|
||||
// hidden by the business account's privacy settings. After the main photo is removed, the previous profile
|
||||
// photo (if present) becomes the main photo.
|
||||
IsPublic bool `json:"is_public,omitempty"`
|
||||
}
|
||||
|
||||
// RemoveBusinessAccountProfilePhoto removes the profile photo of a business account.
|
||||
// Since: Bot API 9.0
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#removebusinessaccountprofilephoto
|
||||
func (api *API) RemoveBusinessAccountProfilePhoto(params RemoveBusinessAccountProfilePhoto) (bool, error) {
|
||||
@@ -270,6 +340,7 @@ func (api *API) RemoveBusinessAccountProfilePhoto(params RemoveBusinessAccountPr
|
||||
}
|
||||
|
||||
// RemoveBusinessAccountProfilePhotoWithContext is the context-aware variant of RemoveBusinessAccountProfilePhoto.
|
||||
// Since: Bot API 9.0
|
||||
// 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) {
|
||||
@@ -278,14 +349,20 @@ func (api *API) RemoveBusinessAccountProfilePhotoWithContext(ctx context.Context
|
||||
}
|
||||
|
||||
// SetBusinessAccountGiftSettings holds parameters for the setBusinessAccountGiftSettings method.
|
||||
// Since: Bot API 9.0
|
||||
// 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"`
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
// ShowGiftButton Required. Pass True if a button for sending a gift to the user or by the business account
|
||||
// must always be shown in the input field
|
||||
ShowGiftButton bool `json:"show_gift_button"`
|
||||
// AcceptedGiftTypes Required. Types of gifts accepted by the business account
|
||||
AcceptedGiftTypes AcceptedGiftTypes `json:"accepted_gift_types"`
|
||||
}
|
||||
|
||||
// SetBusinessAccountGiftSettings sets gift settings for a business account.
|
||||
// Since: Bot API 9.0
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#setbusinessaccountgiftsettings
|
||||
func (api *API) SetBusinessAccountGiftSettings(params SetBusinessAccountGiftSettings) (bool, error) {
|
||||
@@ -294,6 +371,7 @@ func (api *API) SetBusinessAccountGiftSettings(params SetBusinessAccountGiftSett
|
||||
}
|
||||
|
||||
// SetBusinessAccountGiftSettingsWithContext is the context-aware variant of SetBusinessAccountGiftSettings.
|
||||
// Since: Bot API 9.0
|
||||
// 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) {
|
||||
@@ -302,12 +380,15 @@ func (api *API) SetBusinessAccountGiftSettingsWithContext(ctx context.Context, p
|
||||
}
|
||||
|
||||
// GetBusinessAccountStarBalance holds parameters for the getBusinessAccountStarBalance method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#getbusinessaccountstarbalance
|
||||
type GetBusinessAccountStarBalance struct {
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
}
|
||||
|
||||
// GetBusinessAccountStarBalance returns the star balance of a business account.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#getbusinessaccountstarbalance
|
||||
func (api *API) GetBusinessAccountStarBalance(params GetBusinessAccountStarBalance) (StarAmount, error) {
|
||||
req := NewRequest[StarAmount]("getBusinessAccountStarBalance", params)
|
||||
@@ -315,6 +396,7 @@ func (api *API) GetBusinessAccountStarBalance(params GetBusinessAccountStarBalan
|
||||
}
|
||||
|
||||
// GetBusinessAccountStarBalanceWithContext is the context-aware variant of GetBusinessAccountStarBalance.
|
||||
// Since: Bot API 9.0
|
||||
// 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) {
|
||||
@@ -323,13 +405,17 @@ func (api *API) GetBusinessAccountStarBalanceWithContext(ctx context.Context, pa
|
||||
}
|
||||
|
||||
// TransferBusinessAccountStars holds parameters for the transferBusinessAccountStars method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#transferbusinessaccountstars
|
||||
type TransferBusinessAccountStars struct {
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
StarCount int `json:"star_count"`
|
||||
// StarCount Required. Number of Telegram Stars to transfer; 1-10000
|
||||
StarCount int `json:"star_count"`
|
||||
}
|
||||
|
||||
// TransferBusinessAccountStars transfers stars from a business account.
|
||||
// Since: Bot API 9.0
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#transferbusinessaccountstars
|
||||
func (api *API) TransferBusinessAccountStars(params TransferBusinessAccountStars) (bool, error) {
|
||||
@@ -338,6 +424,7 @@ func (api *API) TransferBusinessAccountStars(params TransferBusinessAccountStars
|
||||
}
|
||||
|
||||
// TransferBusinessAccountStarsWithContext is the context-aware variant of TransferBusinessAccountStars.
|
||||
// Since: Bot API 9.0
|
||||
// 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) {
|
||||
@@ -346,22 +433,40 @@ func (api *API) TransferBusinessAccountStarsWithContext(ctx context.Context, par
|
||||
}
|
||||
|
||||
// GetBusinessAccountGifts holds parameters for the getBusinessAccountGifts method.
|
||||
// Since: Bot API 9.0
|
||||
// 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"`
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
// ExcludeUnsaved Optional. Pass True to exclude gifts that aren't saved to the account's profile page
|
||||
ExcludeUnsaved bool `json:"exclude_unsaved,omitempty"`
|
||||
// ExcludeSaved Optional. Pass True to exclude gifts that are saved to the account's profile page
|
||||
ExcludeSaved bool `json:"exclude_saved,omitempty"`
|
||||
// ExcludeUnlimited Optional. Pass True to exclude gifts that can be purchased an unlimited number of times
|
||||
ExcludeUnlimited bool `json:"exclude_unlimited,omitempty"`
|
||||
// ExcludeLimitedUpgradable Optional. Pass True to exclude gifts that can be purchased a limited number of
|
||||
// times and can be upgraded to unique
|
||||
ExcludeLimitedUpgradable bool `json:"exclude_limited_upgradable,omitempty"`
|
||||
// ExcludeLimitedNonUpgradable Optional. Pass True to exclude gifts that can be purchased a limited number
|
||||
// of times and can't be upgraded to unique
|
||||
ExcludeLimitedNonUpgradable bool `json:"exclude_limited_non_upgradable,omitempty"`
|
||||
// ExcludeUnique Optional. Pass True to exclude unique gifts
|
||||
ExcludeUnique bool `json:"exclude_unique,omitempty"`
|
||||
// ExcludeFromBlockchain Optional. Pass True to exclude gifts that were assigned from the TON blockchain and
|
||||
// can't be resold or transferred in Telegram
|
||||
ExcludeFromBlockchain bool `json:"exclude_from_blockchain,omitempty"`
|
||||
// SortByPrice Optional. Pass True to sort results by gift price instead of send date. Sorting is applied
|
||||
// before pagination.
|
||||
SortByPrice bool `json:"sort_by_price,omitempty"`
|
||||
// Offset Optional. Offset of the first entry to return as received from the previous request; use empty
|
||||
// string to get the first chunk of results
|
||||
Offset string `json:"offset,omitempty"`
|
||||
// Limit Optional. The maximum number of gifts to be returned; 1-100. Defaults to 100.
|
||||
Limit int `json:"limit,omitempty"`
|
||||
}
|
||||
|
||||
// GetBusinessAccountGifts returns gifts owned by a business account.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#getbusinessaccountgifts
|
||||
func (api *API) GetBusinessAccountGifts(params GetBusinessAccountGifts) (OwnedGifts, error) {
|
||||
req := NewRequest[OwnedGifts]("getBusinessAccountGifts", params)
|
||||
@@ -369,6 +474,7 @@ func (api *API) GetBusinessAccountGifts(params GetBusinessAccountGifts) (OwnedGi
|
||||
}
|
||||
|
||||
// GetBusinessAccountGiftsWithContext is the context-aware variant of GetBusinessAccountGifts.
|
||||
// Since: Bot API 9.0
|
||||
// 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) {
|
||||
@@ -377,13 +483,17 @@ func (api *API) GetBusinessAccountGiftsWithContext(ctx context.Context, params G
|
||||
}
|
||||
|
||||
// ConvertGiftToStars holds parameters for the convertGiftToStars method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#convertgifttostars
|
||||
type ConvertGiftToStars struct {
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
OwnedGiftID string `json:"owned_gift_id"`
|
||||
// OwnedGiftID Required. Unique identifier of the regular gift that should be converted to Telegram Stars
|
||||
OwnedGiftID string `json:"owned_gift_id"`
|
||||
}
|
||||
|
||||
// ConvertGiftToStars converts a gift to Telegram Stars.
|
||||
// Since: Bot API 9.0
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#convertgifttostars
|
||||
func (api *API) ConvertGiftToStars(params ConvertGiftToStars) (bool, error) {
|
||||
@@ -392,6 +502,7 @@ func (api *API) ConvertGiftToStars(params ConvertGiftToStars) (bool, error) {
|
||||
}
|
||||
|
||||
// ConvertGiftToStarsWithContext is the context-aware variant of ConvertGiftToStars.
|
||||
// Since: Bot API 9.0
|
||||
// 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) {
|
||||
@@ -400,15 +511,24 @@ func (api *API) ConvertGiftToStarsWithContext(ctx context.Context, params Conver
|
||||
}
|
||||
|
||||
// UpgradeGift holds parameters for the upgradeGift method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#upgradegift
|
||||
type UpgradeGift struct {
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
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"`
|
||||
// OwnedGiftID Required. Unique identifier of the regular gift that should be upgraded to a unique one
|
||||
OwnedGiftID string `json:"owned_gift_id"`
|
||||
// KeepOriginalDetails Optional. Pass True to keep the original gift text, sender and receiver in the
|
||||
// upgraded gift
|
||||
KeepOriginalDetails bool `json:"keep_original_details,omitempty"`
|
||||
// StarCount Optional. The amount of Telegram Stars that will be paid for the upgrade from the business
|
||||
// account balance. If gift.prepaid_upgrade_star_count > 0, then pass 0, otherwise, the can_transfer_stars
|
||||
// business bot right is required and gift.upgrade_star_count must be passed.
|
||||
StarCount int `json:"star_count,omitempty"`
|
||||
}
|
||||
|
||||
// UpgradeGift upgrades a gift.
|
||||
// Since: Bot API 9.0
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#upgradegift
|
||||
func (api *API) UpgradeGift(params UpgradeGift) (bool, error) {
|
||||
@@ -417,6 +537,7 @@ func (api *API) UpgradeGift(params UpgradeGift) (bool, error) {
|
||||
}
|
||||
|
||||
// UpgradeGiftWithContext is the context-aware variant of UpgradeGift.
|
||||
// Since: Bot API 9.0
|
||||
// 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) {
|
||||
@@ -425,15 +546,23 @@ func (api *API) UpgradeGiftWithContext(ctx context.Context, params UpgradeGift)
|
||||
}
|
||||
|
||||
// TransferGift holds parameters for the transferGift method.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#transfergift
|
||||
type TransferGift struct {
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
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"`
|
||||
// OwnedGiftID Required. Unique identifier of the regular gift that should be transferred
|
||||
OwnedGiftID string `json:"owned_gift_id"`
|
||||
// NewOwnerChatID Required. Unique identifier of the chat which will own the gift. The chat must be active
|
||||
// in the last 24 hours.
|
||||
NewOwnerChatID int64 `json:"new_owner_chat_id"`
|
||||
// StarCount Optional. The amount of Telegram Stars that will be paid for the transfer from the business
|
||||
// account balance. If positive, then the can_transfer_stars business bot right is required.
|
||||
StarCount int `json:"star_count,omitempty"`
|
||||
}
|
||||
|
||||
// TransferGift transfers a gift to another chat.
|
||||
// Since: Bot API 9.0
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#transfergift
|
||||
func (api *API) TransferGift(params TransferGift) (bool, error) {
|
||||
@@ -442,6 +571,7 @@ func (api *API) TransferGift(params TransferGift) (bool, error) {
|
||||
}
|
||||
|
||||
// TransferGiftWithContext is the context-aware variant of TransferGift.
|
||||
// Since: Bot API 9.0
|
||||
// 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) {
|
||||
@@ -450,29 +580,45 @@ func (api *API) TransferGiftWithContext(ctx context.Context, params TransferGift
|
||||
}
|
||||
|
||||
// PostStory holds parameters for the postStory method.
|
||||
// Since: Bot API 7.2
|
||||
// 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"`
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
// Content Required. Content of the story
|
||||
Content InputStoryContent `json:"content"`
|
||||
// ActivePeriod Required. Period after which the story is moved to the archive, in seconds; must be one of 6
|
||||
// * 3600, 12 * 3600, 86400, or 2 * 86400
|
||||
ActivePeriod int `json:"active_period"`
|
||||
|
||||
Caption string `json:"caption,omitempty"`
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// Caption Optional. Caption of the story, 0-2048 characters after entities parsing
|
||||
Caption string `json:"caption,omitempty"`
|
||||
// ParseMode Optional. Mode for parsing entities in the story caption. See formatting options for more
|
||||
// details.
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||
// can be specified instead of parse_mode
|
||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||
Areas []StoryArea `json:"areas"`
|
||||
// Areas Optional. A JSON-serialized list of clickable areas to be shown on the story
|
||||
Areas []StoryArea `json:"areas"`
|
||||
|
||||
// PostToChatPage Optional. Pass True to keep the story accessible after it expires
|
||||
PostToChatPage bool `json:"post_to_chat_page,omitempty"`
|
||||
// ProtectContent Optional. Pass True if the content of the story must be protected from forwarding and
|
||||
// screenshotting
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
}
|
||||
|
||||
// PostStory posts a story with a photo.
|
||||
// Since: Bot API 7.2
|
||||
// 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.
|
||||
// PostStoryWithContext is the context-aware variant of PostStory.
|
||||
// Since: Bot API 7.2
|
||||
// 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) {
|
||||
@@ -481,17 +627,27 @@ func (api *API) PostStoryWithContext(ctx context.Context, params PostStory) (Sto
|
||||
}
|
||||
|
||||
// RepostStory holds parameters for the repostStory method.
|
||||
// Since: Bot API 7.2
|
||||
// See https://core.telegram.org/bots/api#repoststory
|
||||
type RepostStory struct {
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
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"`
|
||||
// FromChatID Required. Unique identifier of the chat which posted the story that should be reposted
|
||||
FromChatID int64 `json:"from_chat_id"`
|
||||
// FromStoryID Required. Unique identifier of the story that should be reposted
|
||||
FromStoryID int `json:"from_story_id"`
|
||||
// ActivePeriod Required. Period after which the story is moved to the archive, in seconds; must be one of 6
|
||||
// * 3600, 12 * 3600, 86400, or 2 * 86400
|
||||
ActivePeriod int `json:"active_period"`
|
||||
// PostToChatPage Optional. Pass True to keep the story accessible after it expires
|
||||
PostToChatPage bool `json:"post_to_chat_page,omitempty"`
|
||||
// ProtectContent Optional. Pass True if the content of the story must be protected from forwarding and
|
||||
// screenshotting
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
}
|
||||
|
||||
// RepostStory reposts a story from another chat.
|
||||
// Since: Bot API 7.2
|
||||
// Returns the reposted story.
|
||||
// See https://core.telegram.org/bots/api#repoststory
|
||||
func (api *API) RepostStory(params RepostStory) (Story, error) {
|
||||
@@ -500,6 +656,7 @@ func (api *API) RepostStory(params RepostStory) (Story, error) {
|
||||
}
|
||||
|
||||
// RepostStoryWithContext is the context-aware variant of RepostStory.
|
||||
// Since: Bot API 7.2
|
||||
// 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) {
|
||||
@@ -508,19 +665,30 @@ func (api *API) RepostStoryWithContext(ctx context.Context, params RepostStory)
|
||||
}
|
||||
|
||||
// EditStory holds parameters for the editStory method.
|
||||
// Since: Bot API 7.2
|
||||
// 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"`
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
// StoryID Required. Unique identifier of the story to edit
|
||||
StoryID int `json:"story_id"`
|
||||
// Content Required. Content of the story
|
||||
Content InputStoryContent `json:"content"`
|
||||
|
||||
Caption string `json:"caption,omitempty"`
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// Caption Optional. Caption of the story, 0-2048 characters after entities parsing
|
||||
Caption string `json:"caption,omitempty"`
|
||||
// ParseMode Optional. Mode for parsing entities in the story caption. See formatting options for more
|
||||
// details.
|
||||
ParseMode ParseMode `json:"parse_mode,omitempty"`
|
||||
// CaptionEntities Optional. A JSON-serialized list of special entities that appear in the caption, which
|
||||
// can be specified instead of parse_mode
|
||||
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
|
||||
Areas []StoryArea `json:"areas,omitempty"`
|
||||
// Areas Optional. A JSON-serialized list of clickable areas to be shown on the story
|
||||
Areas []StoryArea `json:"areas,omitempty"`
|
||||
}
|
||||
|
||||
// EditStory edits an existing story.
|
||||
// Since: Bot API 7.2
|
||||
// Returns the updated story.
|
||||
// See https://core.telegram.org/bots/api#editstory
|
||||
func (api *API) EditStory(params EditStory) (Story, error) {
|
||||
@@ -529,6 +697,7 @@ func (api *API) EditStory(params EditStory) (Story, error) {
|
||||
}
|
||||
|
||||
// EditStoryWithContext is the context-aware variant of EditStory.
|
||||
// Since: Bot API 7.2
|
||||
// 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) {
|
||||
@@ -537,13 +706,17 @@ func (api *API) EditStoryWithContext(ctx context.Context, params EditStory) (Sto
|
||||
}
|
||||
|
||||
// DeleteStory holds parameters for the deleteStory method.
|
||||
// Since: Bot API 7.2
|
||||
// See https://core.telegram.org/bots/api#deletestory
|
||||
type DeleteStory struct {
|
||||
// BusinessConnectionID Required. Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
StoryID int `json:"story_id"`
|
||||
// StoryID Required. Unique identifier of the story to delete
|
||||
StoryID int `json:"story_id"`
|
||||
}
|
||||
|
||||
// DeleteStory deletes a story.
|
||||
// Since: Bot API 7.2
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#deletestory
|
||||
func (api *API) DeleteStory(params DeleteStory) (bool, error) {
|
||||
@@ -552,6 +725,7 @@ func (api *API) DeleteStory(params DeleteStory) (bool, error) {
|
||||
}
|
||||
|
||||
// DeleteStoryWithContext is the context-aware variant of DeleteStory.
|
||||
// Since: Bot API 7.2
|
||||
// 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) {
|
||||
|
||||
+123
-43
@@ -1,71 +1,123 @@
|
||||
package tgapi
|
||||
|
||||
// BusinessIntro contains information about the business intro.
|
||||
// Since: Bot API 7.2
|
||||
// See https://core.telegram.org/bots/api#businessintro
|
||||
type BusinessIntro struct {
|
||||
Title string `json:"title,omitempty"`
|
||||
Message string `json:"message,omitempty"`
|
||||
// Title Optional. Title text of the business intro
|
||||
Title string `json:"title,omitempty"`
|
||||
// Message Optional. Message text of the business intro
|
||||
Message string `json:"message,omitempty"`
|
||||
// Sticker Optional. Sticker of the business intro
|
||||
Sticker *Sticker `json:"sticker,omitempty"`
|
||||
}
|
||||
|
||||
// BusinessLocation contains information about the business location.
|
||||
// Since: Bot API 7.2
|
||||
// See https://core.telegram.org/bots/api#businesslocation
|
||||
type BusinessLocation struct {
|
||||
Address string `json:"address"`
|
||||
// Address Address of the business
|
||||
Address string `json:"address"`
|
||||
// Location Optional. Location of the business
|
||||
Location *Location `json:"location,omitempty"`
|
||||
}
|
||||
|
||||
// BusinessOpeningHoursInterval represents an interval of opening hours.
|
||||
// Since: Bot API 7.2
|
||||
// See https://core.telegram.org/bots/api#businessopeninghoursinterval
|
||||
type BusinessOpeningHoursInterval struct {
|
||||
// OpeningMinute The minute's sequence number in a week, starting on Monday, marking the start of the time
|
||||
// interval during which the business is open; 0 - 7 * 24 * 60
|
||||
OpeningMinute int `json:"opening_minute"`
|
||||
// ClosingMinute The minute's sequence number in a week, starting on Monday, marking the end of the time
|
||||
// interval during which the business is open; 0 - 8 * 24 * 60
|
||||
ClosingMinute int `json:"closing_minute"`
|
||||
}
|
||||
|
||||
// BusinessOpeningHours represents the opening hours of a business.
|
||||
// Since: Bot API 7.2
|
||||
// See https://core.telegram.org/bots/api#businessopeninghours
|
||||
type BusinessOpeningHours struct {
|
||||
TimeZoneName string `json:"time_zone_name"`
|
||||
// TimeZoneName Unique name of the time zone for which the opening hours are defined
|
||||
TimeZoneName string `json:"time_zone_name"`
|
||||
// OpeningHours List of time intervals describing business opening hours
|
||||
OpeningHours []BusinessOpeningHoursInterval `json:"opening_hours"`
|
||||
}
|
||||
|
||||
// BusinessBotRights represents the rights of a business bot.
|
||||
// All fields are optional booleans that, when present, are always true.
|
||||
// Since: Bot API 9.0
|
||||
// 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"`
|
||||
// CanReply Optional. True, if the bot can send and edit messages in the private chats that had incoming
|
||||
// messages in the last 24 hours
|
||||
CanReply *bool `json:"can_reply,omitempty"`
|
||||
// CanReadMessages Optional. True, if the bot can mark incoming private messages as read
|
||||
CanReadMessages *bool `json:"can_read_messages,omitempty"`
|
||||
// CanDeleteSentMessages Optional. True, if the bot can delete messages sent by the bot
|
||||
CanDeleteSentMessages *bool `json:"can_delete_sent_messages,omitempty"`
|
||||
// CanDeleteAllMessages Optional. True, if the bot can delete all private messages in managed chats
|
||||
CanDeleteAllMessages *bool `json:"can_delete_all_messages,omitempty"`
|
||||
// CanEditName Optional. True, if the bot can edit the first and last name of the business account
|
||||
CanEditName *bool `json:"can_edit_name,omitempty"`
|
||||
// CanEditBio Optional. True, if the bot can edit the bio of the business account
|
||||
CanEditBio *bool `json:"can_edit_bio,omitempty"`
|
||||
// CanEditProfilePhoto Optional. True, if the bot can edit the profile photo of the business account
|
||||
CanEditProfilePhoto *bool `json:"can_edit_profile_photo,omitempty"`
|
||||
// CanEditUsername Optional. True, if the bot can edit the username of the business account
|
||||
CanEditUsername *bool `json:"can_edit_username,omitempty"`
|
||||
// CanChangeGiftSettings Optional. True, if the bot can change the privacy settings pertaining to gifts for
|
||||
// the business account
|
||||
CanChangeGiftSettings *bool `json:"can_change_gift_settings,omitempty"`
|
||||
// CanViewGiftsAndStars Optional. True, if the bot can view gifts and the amount of Telegram Stars owned by
|
||||
// the business account
|
||||
CanViewGiftsAndStars *bool `json:"can_view_gifts_and_stars,omitempty"`
|
||||
// CanConvertGiftsToStars Optional. True, if the bot can convert regular gifts owned by the business account
|
||||
// to Telegram Stars
|
||||
CanConvertGiftsToStars *bool `json:"can_convert_gifts_to_stars,omitempty"`
|
||||
// CanTransferAndUpgradeGifts Optional. True, if the bot can transfer and upgrade gifts owned by the
|
||||
// business account
|
||||
CanTransferAndUpgradeGifts *bool `json:"can_transfer_and_upgrade_gifts,omitempty"`
|
||||
CanTransferStars *bool `json:"can_transfer_stars,omitempty"`
|
||||
CanManageStories *bool `json:"can_manage_stories,omitempty"`
|
||||
// CanTransferStars Optional. True, if the bot can transfer Telegram Stars received by the business account
|
||||
// to its own account, or use them to upgrade and transfer gifts
|
||||
CanTransferStars *bool `json:"can_transfer_stars,omitempty"`
|
||||
// CanManageStories Optional. True, if the bot can post, edit and delete stories on behalf of the business
|
||||
// account
|
||||
CanManageStories *bool `json:"can_manage_stories,omitempty"`
|
||||
}
|
||||
|
||||
// BusinessConnection contains information about a business connection.
|
||||
// Since: Bot API 7.2
|
||||
// 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"`
|
||||
// ID Unique identifier of the business connection
|
||||
ID string `json:"id"`
|
||||
// User Business account user that created the business connection
|
||||
User User `json:"user"`
|
||||
// UserChatID Identifier of a private chat with the user who created the business connection. This number
|
||||
// may have more than 32 significant bits and some programming languages may have difficulty/silent defects
|
||||
// in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float
|
||||
// type are safe for storing this identifier.
|
||||
UserChatID int64 `json:"user_chat_id"`
|
||||
// Date Date the connection was established in Unix time
|
||||
Date int `json:"date"`
|
||||
// Rights Optional. Rights of the business bot
|
||||
Rights *BusinessBotRights `json:"rights,omitempty"`
|
||||
// IsEnabled True, if the connection is active
|
||||
IsEnabled bool `json:"is_enabled"`
|
||||
}
|
||||
|
||||
// BusinessMessagesDeleted is received when messages are deleted from a connected business account.
|
||||
// Since: Bot API 7.2
|
||||
// See https://core.telegram.org/bots/api#businessmessagesdeleted
|
||||
type BusinessMessagesDeleted struct {
|
||||
// BusinessConnectionID Unique identifier of the business connection
|
||||
BusinessConnectionID string `json:"business_connection_id"`
|
||||
Chat Chat `json:"chat"`
|
||||
MessageIDs []int `json:"message_ids"`
|
||||
// Chat Information about a chat in the business account. The bot may not have access to the chat or the
|
||||
// corresponding user.
|
||||
Chat Chat `json:"chat"`
|
||||
// MessageIDs The list of identifiers of deleted messages in the chat of the business account
|
||||
MessageIDs []int `json:"message_ids"`
|
||||
}
|
||||
|
||||
// InputStoryContentType indicates the type of input story content.
|
||||
@@ -79,28 +131,41 @@ const (
|
||||
)
|
||||
|
||||
// InputStoryContent represents the content of a story to be posted.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#inputstorycontent
|
||||
type InputStoryContent struct {
|
||||
// Type identifies the photo or video story-content variant.
|
||||
Type InputStoryContentType `json:"type"`
|
||||
|
||||
// Photo fields
|
||||
Photo *string `json:"photo,omitempty"`
|
||||
|
||||
// Video fields
|
||||
Video *string `json:"video,omitempty"`
|
||||
Duration *float64 `json:"duration,omitempty"`
|
||||
Video *string `json:"video,omitempty"`
|
||||
// Duration Optional. Precise duration of the video in seconds; 0-60
|
||||
Duration *float64 `json:"duration,omitempty"`
|
||||
// CoverFrameTimestamp Optional. Timestamp in seconds of the frame that will be used as the static cover for
|
||||
// the story. Defaults to 0.0.
|
||||
CoverFrameTimestamp *float64 `json:"cover_frame_timestamp,omitempty"`
|
||||
IsAnimation *bool `json:"is_animation,omitempty"`
|
||||
// IsAnimation Optional. Pass True if the video has no sound
|
||||
IsAnimation *bool `json:"is_animation,omitempty"`
|
||||
}
|
||||
|
||||
// StoryAreaPosition describes the position of a clickable area on a story.
|
||||
// Since: Bot API 9.0
|
||||
// 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"`
|
||||
// XPercentage The abscissa of the area's center, as a percentage of the media width
|
||||
XPercentage float64 `json:"x_percentage"`
|
||||
// YPercentage The ordinate of the area's center, as a percentage of the media height
|
||||
YPercentage float64 `json:"y_percentage"`
|
||||
// WidthPercentage The width of the area's rectangle, as a percentage of the media width
|
||||
WidthPercentage float64 `json:"width_percentage"`
|
||||
// HeightPercentage The height of the area's rectangle, as a percentage of the media height
|
||||
HeightPercentage float64 `json:"height_percentage"`
|
||||
// RotationAngle The clockwise rotation angle of the rectangle, in degrees; 0-360
|
||||
RotationAngle float64 `json:"rotation_angle"`
|
||||
// CornerRadiusPercentage The radius of the rectangle corner rounding, as a percentage of the media width
|
||||
CornerRadiusPercentage float64 `json:"corner_radius_percentage"`
|
||||
}
|
||||
|
||||
@@ -121,36 +186,51 @@ const (
|
||||
)
|
||||
|
||||
// StoryAreaType describes the type of a clickable area on a story.
|
||||
// Fields should be set according to the Type.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#storyareatype
|
||||
type StoryAreaType struct {
|
||||
// Type identifies the concrete story-area variant.
|
||||
Type StoryAreaTypeType `json:"type"`
|
||||
|
||||
// Latitude Location latitude in degrees
|
||||
// Location
|
||||
Latitude *float64 `json:"latitude,omitempty"`
|
||||
Longitude *float64 `json:"longitude,omitempty"`
|
||||
Address *LocationAddress `json:"address,omitempty"`
|
||||
Latitude *float64 `json:"latitude,omitempty"`
|
||||
// Longitude Location longitude in degrees
|
||||
Longitude *float64 `json:"longitude,omitempty"`
|
||||
// Address Optional. Address of the location
|
||||
Address *LocationAddress `json:"address,omitempty"`
|
||||
|
||||
// ReactionType Type of the reaction
|
||||
// Suggested reaction
|
||||
ReactionType *ReactionType `json:"reaction_type,omitempty"`
|
||||
IsDark *bool `json:"is_dark,omitempty"`
|
||||
IsFlipped *bool `json:"is_flipped,omitempty"`
|
||||
// IsDark Optional. Pass True if the reaction area has a dark background
|
||||
IsDark *bool `json:"is_dark,omitempty"`
|
||||
// IsFlipped Optional. Pass True if reaction area corner is flipped
|
||||
IsFlipped *bool `json:"is_flipped,omitempty"`
|
||||
|
||||
// URL HTTP or tg:// URL to be opened when the area is clicked
|
||||
// Link
|
||||
URL *string `json:"url,omitempty"`
|
||||
|
||||
// Temperature Temperature, in degree Celsius
|
||||
// Weather
|
||||
Temperature *float64 `json:"temperature,omitempty"`
|
||||
Emoji *string `json:"emoji,omitempty"`
|
||||
BackgroundColor *int `json:"background_color,omitempty"`
|
||||
Temperature *float64 `json:"temperature,omitempty"`
|
||||
// Emoji Emoji representing the weather
|
||||
Emoji *string `json:"emoji,omitempty"`
|
||||
// BackgroundColor A color of the area background in the ARGB format
|
||||
BackgroundColor *int `json:"background_color,omitempty"`
|
||||
|
||||
// Name Unique name of the gift
|
||||
// Unique gift
|
||||
Name *string `json:"name,omitempty"`
|
||||
}
|
||||
|
||||
// StoryArea represents a clickable area on a story.
|
||||
// Since: Bot API 9.0
|
||||
// See https://core.telegram.org/bots/api#storyarea
|
||||
type StoryArea struct {
|
||||
// Position Position of the area
|
||||
Position StoryAreaPosition `json:"position"`
|
||||
Type StoryAreaType `json:"type"`
|
||||
// Type Type of the area
|
||||
Type StoryAreaType `json:"type"`
|
||||
}
|
||||
|
||||
+449
-87
File diff suppressed because it is too large
Load Diff
+427
-140
@@ -1,16 +1,28 @@
|
||||
package tgapi
|
||||
|
||||
// Chat represents a chat (private, group, supergroup, channel).
|
||||
// Since: Bot API 1.0
|
||||
// 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"`
|
||||
// ID Unique identifier for this chat. This number may have more than 32 significant bits and some
|
||||
// programming languages may have difficulty/silent defects in interpreting it. But it has at most 52
|
||||
// significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this
|
||||
// identifier.
|
||||
ID int64 `json:"id"`
|
||||
// Type Type of the chat, can be either “private”, “group”, “supergroup” or “channel”
|
||||
Type ChatType `json:"type"`
|
||||
// Title Optional. Title, for supergroups, channels and group chats
|
||||
Title *string `json:"title,omitempty"`
|
||||
// Username Optional. Username, for private chats, supergroups and channels if available
|
||||
Username *string `json:"username,omitempty"`
|
||||
// FirstName Optional. First name of the other party in a private chat
|
||||
FirstName *string `json:"first_name,omitempty"`
|
||||
// LastName Optional. Last name of the other party in a private chat
|
||||
LastName *string `json:"last_name,omitempty"`
|
||||
// IsForum Optional. True, if the supergroup chat is a forum (has topics enabled)
|
||||
IsForum *bool `json:"is_forum,omitempty"` // Since: Bot API 6.3
|
||||
// IsDirectMessages Optional. True, if the chat is the direct messages chat of a channel
|
||||
IsDirectMessages *bool `json:"is_direct_messages,omitempty"` // Since: Bot API 9.2
|
||||
}
|
||||
|
||||
// ChatType represents the type of a chat.
|
||||
@@ -28,120 +40,258 @@ const (
|
||||
)
|
||||
|
||||
// ChatFullInfo contains full information about a chat.
|
||||
// Since: Bot API 7.5
|
||||
// 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"`
|
||||
// ID Unique identifier for this chat. This number may have more than 32 significant bits and some
|
||||
// programming languages may have difficulty/silent defects in interpreting it. But it has at most 52
|
||||
// significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this
|
||||
// identifier.
|
||||
ID int64 `json:"id"`
|
||||
// Type Type of the chat, can be either “private”, “group”, “supergroup” or “channel”
|
||||
Type ChatType `json:"type"`
|
||||
// Title Optional. Title, for supergroups, channels and group chats
|
||||
Title string `json:"title"`
|
||||
// Username Optional. Username, for private chats, supergroups and channels if available
|
||||
Username string `json:"username"`
|
||||
// FirstName Optional. First name of the other party in a private chat
|
||||
FirstName string `json:"first_name"`
|
||||
// LastName Optional. Last name of the other party in a private chat
|
||||
LastName string `json:"last_name"`
|
||||
// IsForum Optional. True, if the supergroup chat is a forum (has topics enabled)
|
||||
IsForum bool `json:"is_forum"`
|
||||
// IsDirectMessages Optional. True, if the chat is the direct messages chat of a channel
|
||||
IsDirectMessages bool `json:"is_direct_messages"`
|
||||
// AccentColorID Identifier of the accent color for the chat name and backgrounds of the chat photo, reply
|
||||
// header, and link preview. See accent colors for more details.
|
||||
AccentColorID int `json:"accent_color_id"`
|
||||
// MaxReactionCount The maximum number of reactions that can be set on a message in the chat
|
||||
MaxReactionCount int `json:"max_reaction_count"`
|
||||
// Photo Optional. Chat photo
|
||||
Photo *ChatPhoto `json:"photo,omitempty"`
|
||||
// ActiveUsernames Optional. If non-empty, the list of all active chat usernames; for private chats,
|
||||
// supergroups and channels
|
||||
ActiveUsernames []string `json:"active_usernames,omitempty"`
|
||||
// Birthdate Optional. For private chats, the date of birth of the user
|
||||
Birthdate *Birthdate `json:"birthdate,omitempty"`
|
||||
|
||||
BusinessIntro *BusinessIntro `json:"business_intro,omitempty"`
|
||||
BusinessLocation *BusinessLocation `json:"business_location,omitempty"`
|
||||
// BusinessIntro Optional. For private chats with business accounts, the intro of the business
|
||||
BusinessIntro *BusinessIntro `json:"business_intro,omitempty"`
|
||||
// BusinessLocation Optional. For private chats with business accounts, the location of the business
|
||||
BusinessLocation *BusinessLocation `json:"business_location,omitempty"`
|
||||
// BusinessOpeningHours Optional. For private chats with business accounts, the opening hours of the
|
||||
// business
|
||||
BusinessOpeningHours *BusinessOpeningHours `json:"business_opening_hours,omitempty"`
|
||||
|
||||
// PersonalChat Optional. For private chats, the personal channel of the user
|
||||
PersonalChat *Chat `json:"personal_chat,omitempty"`
|
||||
ParentChat *Chat `json:"parent_chat,omitempty"`
|
||||
// ParentChat Optional. Information about the corresponding channel chat; for direct messages chats only
|
||||
ParentChat *Chat `json:"parent_chat,omitempty"` // Since: Bot API 9.2
|
||||
|
||||
AvailableReaction []ReactionType `json:"available_reaction,omitempty"`
|
||||
// AvailableReaction Optional. List of available reactions allowed in the chat. If omitted, then all emoji
|
||||
// reactions are allowed.
|
||||
// Subject to change in v2: the Go field name may be pluralized to AvailableReactions.
|
||||
AvailableReaction []ReactionType `json:"available_reactions,omitempty"`
|
||||
|
||||
BackgroundCustomEmojiID *string `json:"background_custom_emoji_id,omitempty"`
|
||||
ProfileAccentColorID *int `json:"profile_accent_color_id,omitempty"`
|
||||
// BackgroundCustomEmojiID Optional. Custom emoji identifier of the emoji chosen by the chat for the reply
|
||||
// header and link preview background
|
||||
BackgroundCustomEmojiID *string `json:"background_custom_emoji_id,omitempty"`
|
||||
// ProfileAccentColorID Optional. Identifier of the accent color for the chat's profile background. See
|
||||
// profile accent colors for more details.
|
||||
ProfileAccentColorID *int `json:"profile_accent_color_id,omitempty"`
|
||||
// ProfileBackgroundCustomEmojiID Optional. Custom emoji identifier of the emoji chosen by the chat for its
|
||||
// profile background
|
||||
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"`
|
||||
// EmojiStatusCustomEmojiID Optional. Custom emoji identifier of the emoji status of the chat or the other
|
||||
// party in a private chat
|
||||
EmojiStatusCustomEmojiID *string `json:"emoji_status_custom_emoji_id,omitempty"`
|
||||
// EmojiStatusExpirationDate Optional. Expiration date of the emoji status of the chat or the other party in
|
||||
// a private chat, in Unix time, if any
|
||||
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"`
|
||||
// Bio Optional. Bio of the other party in a private chat
|
||||
Bio *string `json:"bio,omitempty"`
|
||||
// HasPrivateForwards Optional. True, if privacy settings of the other party in the private chat allows to
|
||||
// use tg://user?id=<user_id> links only in chats with the user
|
||||
HasPrivateForwards *bool `json:"has_private_forwards,omitempty"`
|
||||
// HasRestrictedVoiceAndVideoMessages Optional. True, if the privacy settings of the other party restrict
|
||||
// sending voice and video note messages in the private chat
|
||||
HasRestrictedVoiceAndVideoMessages *bool `json:"has_restricted_voice_and_video_messages,omitempty"`
|
||||
// JoinToSendMessages Optional. True, if users need to join the supergroup before they can send messages
|
||||
JoinToSendMessages *bool `json:"join_to_send_messages,omitempty"`
|
||||
// JoinByRequest Optional. True, if all users directly joining the supergroup without using an invite link
|
||||
// need to be approved by supergroup administrators
|
||||
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"`
|
||||
// Description Optional. Description, for groups, supergroups and channel chats
|
||||
Description *string `json:"description,omitempty"`
|
||||
// InviteLink Optional. Primary invite link, for groups, supergroups and channel chats
|
||||
InviteLink *string `json:"invite_link,omitempty"`
|
||||
// PinnedMessage Optional. The most recent pinned message (by sending date)
|
||||
PinnedMessage *Message `json:"pinned_message,omitempty"`
|
||||
// Permissions Optional. Default chat member permissions, for groups and supergroups
|
||||
Permissions *ChatPermissions `json:"permissions,omitempty"`
|
||||
// AcceptedGiftTypes Information about types of gifts that are accepted by the chat or by the corresponding
|
||||
// user for private chats
|
||||
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"`
|
||||
// CanSendPaidMedia Optional. True, if paid media messages can be sent or forwarded to the channel chat. The
|
||||
// field is available only for channel chats.
|
||||
CanSendPaidMedia *bool `json:"can_send_paid_media,omitempty"`
|
||||
// SlowModeDelay Optional. For supergroups, the minimum allowed delay between consecutive messages sent by
|
||||
// each unprivileged user; in seconds
|
||||
SlowModeDelay *int `json:"slow_mode_delay,omitempty"`
|
||||
// UnrestrictedBoostCount is the number of unrestricted boosts available to the chat.
|
||||
UnrestrictedBoostCount *int `json:"unrestricted_boost_count,omitempty"`
|
||||
// MessageAutoDeleteTime Optional. The time after which all messages sent to the chat will be automatically
|
||||
// deleted; in seconds
|
||||
MessageAutoDeleteTime *int `json:"message_auto_delete_time,omitempty"`
|
||||
// HasAggressiveAntiSpamEnabled Optional. True, if aggressive anti-spam checks are enabled in the
|
||||
// supergroup. The field is only available to chat administrators.
|
||||
HasAggressiveAntiSpamEnabled *bool `json:"has_aggressive_anti_spam_enabled,omitempty"`
|
||||
// HasHiddenMembers Optional. True, if non-administrators can only get the list of bots and administrators
|
||||
// in the chat
|
||||
HasHiddenMembers *bool `json:"has_hidden_members,omitempty"`
|
||||
// HasProtectedContent Optional. True, if messages from the chat can't be forwarded to other chats
|
||||
HasProtectedContent *bool `json:"has_protected_content,omitempty"`
|
||||
// HasVisibleHistory Optional. True, if new chat members will have access to old messages; available only to
|
||||
// chat administrators
|
||||
HasVisibleHistory *bool `json:"has_visible_history,omitempty"`
|
||||
// StickerSetName Optional. For supergroups, name of the group sticker set
|
||||
StickerSetName *string `json:"sticker_set_name,omitempty"`
|
||||
// CanSetStickerSet Optional. True, if the bot can change the group sticker set
|
||||
CanSetStickerSet *bool `json:"can_set_sticker_set,omitempty"`
|
||||
// CustomEmojiStickerSetName Optional. For supergroups, the name of the group's custom emoji sticker set.
|
||||
// Custom emoji from this set can be used by all users and bots in the group.
|
||||
CustomEmojiStickerSetName *string `json:"custom_emoji_sticker_set_name,omitempty"`
|
||||
// LinkedChatID Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for a
|
||||
// channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits
|
||||
// and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller
|
||||
// than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this
|
||||
// identifier.
|
||||
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"`
|
||||
// Location Optional. For supergroups, the location to which the supergroup is connected
|
||||
Location *ChatLocation `json:"location,omitempty"`
|
||||
// Rating Optional. For private chats, the rating of the user if any
|
||||
Rating *UserRating `json:"rating,omitempty"`
|
||||
// FirstProfileAudio Optional. For private chats, the first audio added to the profile of the user
|
||||
FirstProfileAudio *Audio `json:"first_profile_audio,omitempty"` // Since: Bot API 9.4
|
||||
// UniqueGiftColors Optional. The color scheme based on a unique gift that must be used for the chat's name,
|
||||
// message replies and link previews
|
||||
UniqueGiftColors *UniqueGiftColors `json:"unique_gift_colors,omitempty"` // Since: Bot API 9.3
|
||||
// PaidMessageStarCount Optional. The number of Telegram Stars a general user has to pay to send a message
|
||||
// to the chat
|
||||
PaidMessageStarCount *int `json:"paid_message_star_count,omitempty"` // Since: Bot API 9.3
|
||||
// GuardBot contains the guard bot visible to chat administrators.
|
||||
GuardBot *User `json:"guard_bot,omitempty"` // Since: Bot API 10.1; visible to chat administrators only
|
||||
// Community contains information about the affected community.
|
||||
Community *Community `json:"community,omitempty"` // Since: Bot API 10.2
|
||||
}
|
||||
|
||||
// ChatPhoto represents a chat photo.
|
||||
// Since: Bot API 3.1
|
||||
// See https://core.telegram.org/bots/api#chatphoto
|
||||
type ChatPhoto struct {
|
||||
SmallFileID string `json:"small_file_id"`
|
||||
// SmallFileID File identifier of small (160x160) chat photo. This file_id can be used only for photo
|
||||
// download and only for as long as the photo is not changed.
|
||||
SmallFileID string `json:"small_file_id"`
|
||||
// SmallFileUniqueID Unique file identifier of small (160x160) chat photo, which is supposed to be the same
|
||||
// over time and for different bots. Can't be used to download or reuse the file.
|
||||
SmallFileUniqueID string `json:"small_file_unique_id"`
|
||||
BigFileID string `json:"big_file_id"`
|
||||
BigFileUniqueID string `json:"big_file_unique_id"`
|
||||
// BigFileID File identifier of big (640x640) chat photo. This file_id can be used only for photo download
|
||||
// and only for as long as the photo is not changed.
|
||||
BigFileID string `json:"big_file_id"`
|
||||
// BigFileUniqueID Unique file identifier of big (640x640) chat photo, which is supposed to be the same over
|
||||
// time and for different bots. Can't be used to download or reuse the file.
|
||||
BigFileUniqueID string `json:"big_file_unique_id"`
|
||||
}
|
||||
|
||||
// ChatPermissions describes actions that a non‑administrator user is allowed to take in a chat.
|
||||
// Since: Bot API 4.4
|
||||
// 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"`
|
||||
// CanSendMessages Optional. True, if the user is allowed to send text messages, rich messages, contacts,
|
||||
// giveaways, giveaway winners, invoices, locations and venues
|
||||
CanSendMessages bool `json:"can_send_messages"`
|
||||
// CanSendAudios Optional. True, if the user is allowed to send audios
|
||||
CanSendAudios bool `json:"can_send_audios"` // Since: Bot API 6.5
|
||||
// CanSendDocuments Optional. True, if the user is allowed to send documents
|
||||
CanSendDocuments bool `json:"can_send_documents"` // Since: Bot API 6.5
|
||||
// CanSendPhotos Optional. True, if the user is allowed to send photos
|
||||
CanSendPhotos bool `json:"can_send_photos"` // Since: Bot API 6.5
|
||||
// CanSendVideos Optional. True, if the user is allowed to send videos
|
||||
CanSendVideos bool `json:"can_send_videos"` // Since: Bot API 6.5
|
||||
// CanSendVideoNotes Optional. True, if the user is allowed to send video notes
|
||||
CanSendVideoNotes bool `json:"can_send_video_notes"` // Since: Bot API 6.5
|
||||
// CanSendVoiceNotes Optional. True, if the user is allowed to send voice notes
|
||||
CanSendVoiceNotes bool `json:"can_send_voice_notes"` // Since: Bot API 6.5
|
||||
// CanSendPolls Optional. True, if the user is allowed to send polls and checklists
|
||||
CanSendPolls bool `json:"can_send_polls"`
|
||||
// CanSendOtherMessages Optional. True, if the user is allowed to send animations, games, stickers and use
|
||||
// inline bots
|
||||
CanSendOtherMessages bool `json:"can_send_other_messages"`
|
||||
// CanAddWebPagePreview Optional. True, if the user is allowed to add web page previews to their 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"`
|
||||
// CanReactToMessages Optional. True, if the user is allowed to react to messages. If omitted, defaults to
|
||||
// the value of can_send_messages.
|
||||
CanReactToMessages bool `json:"can_react_to_messages"` // Since: Bot API 10.0
|
||||
// CanEditTag Optional. True, if the user is allowed to edit their own tag. If omitted, defaults to the
|
||||
// value of can_pin_messages.
|
||||
CanEditTag bool `json:"can_edit_tag"` // Since: Bot API 9.5
|
||||
// CanChangeInfo Optional. True, if the user is allowed to change the chat title, photo and other settings.
|
||||
// Ignored in public supergroups.
|
||||
CanChangeInfo bool `json:"can_change_info"`
|
||||
// CanInviteUsers Optional. True, if the user is allowed to invite new users to the chat
|
||||
CanInviteUsers bool `json:"can_invite_users"`
|
||||
// CanPinMessages Optional. True, if the user is allowed to pin messages. Ignored in public supergroups.
|
||||
CanPinMessages bool `json:"can_pin_messages"`
|
||||
// CanManageTopics Optional. True, if the user is allowed to create forum topics. If omitted, defaults to
|
||||
// the value of can_pin_messages.
|
||||
CanManageTopics bool `json:"can_manage_topics"` // Since: Bot API 6.3
|
||||
}
|
||||
|
||||
// ChatLocation represents a location to which a chat is connected.
|
||||
// Since: Bot API 5.0
|
||||
// See https://core.telegram.org/bots/api#chatlocation
|
||||
type ChatLocation struct {
|
||||
// Location The location to which the supergroup is connected. Can't be a live location.
|
||||
Location Location `json:"location"`
|
||||
Address string `json:"address"`
|
||||
// Address Location address; 1-64 characters, as defined by the chat owner
|
||||
Address string `json:"address"`
|
||||
}
|
||||
|
||||
// ChatInviteLink represents an invite link for a chat.
|
||||
// Since: Bot API 5.1
|
||||
// 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"`
|
||||
// InviteLink The invite link. If the link was created by another chat administrator, then the second part
|
||||
// of the link will be replaced with “…”.
|
||||
InviteLink string `json:"invite_link"`
|
||||
// Creator Creator of the link
|
||||
Creator User `json:"creator"`
|
||||
// CreateJoinRequest True, if users joining the chat via the link need to be approved by chat administrators
|
||||
CreateJoinRequest bool `json:"creates_join_request"`
|
||||
// IsPrimary True, if the link is primary
|
||||
IsPrimary bool `json:"is_primary"`
|
||||
// IsRevoked True, if the link is revoked
|
||||
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"`
|
||||
// Name Optional. Invite link name
|
||||
Name *string `json:"name,omitempty"`
|
||||
// ExpireDate Optional. Point in time (Unix timestamp) when the link will expire or has been expired
|
||||
ExpireDate *int `json:"expire_date,omitempty"`
|
||||
// MemberLimit Optional. The maximum number of users that can be members of the chat simultaneously after
|
||||
// joining the chat via this invite link; 1-99999
|
||||
MemberLimit *int `json:"member_limit,omitempty"`
|
||||
// PendingJoinRequestCount Optional. Number of pending join requests created using this link
|
||||
PendingJoinRequestCount *int `json:"pending_join_request_count,omitempty"`
|
||||
// SubscriptionPeriod Optional. The number of seconds the subscription will be active for before the next
|
||||
// payment
|
||||
SubscriptionPeriod *int `json:"subscription_period,omitempty"`
|
||||
// SubscriptionPrice Optional. The amount of Telegram Stars a user must pay initially and after each
|
||||
// subsequent subscription period to be a member of the chat using the link
|
||||
SubscriptionPrice *int `json:"subscription_price,omitempty"`
|
||||
}
|
||||
|
||||
// ChatMemberStatusType indicates the status of a chat member.
|
||||
@@ -163,135 +313,272 @@ const (
|
||||
)
|
||||
|
||||
// ChatMember contains information about one member of a chat.
|
||||
// Since: Bot API 3.1
|
||||
// See https://core.telegram.org/bots/api#chatmember
|
||||
type ChatMember struct {
|
||||
// Status is the member's current status in the chat.
|
||||
Status ChatMemberStatusType `json:"status"`
|
||||
User User `json:"user"`
|
||||
Tag string `json:"tag,omitempty"`
|
||||
// User Information about the user
|
||||
User User `json:"user"`
|
||||
// Tag Optional. Tag of the member
|
||||
Tag string `json:"tag,omitempty"` // Since: Bot API 9.5
|
||||
|
||||
// IsAnonymous True, if the user's presence in the chat is hidden
|
||||
// Owner
|
||||
IsAnonymous *bool `json:"is_anonymous"`
|
||||
IsAnonymous *bool `json:"is_anonymous"`
|
||||
// CustomTitle Optional. Custom title for this user
|
||||
CustomTitle *string `json:"custom_title,omitempty"`
|
||||
|
||||
// CanBeEdited True, if the bot is allowed to edit administrator privileges of that user
|
||||
// Administrator
|
||||
CanBeEdited *bool `json:"can_be_edited,omitempty"`
|
||||
CanManageChat *bool `json:"can_manage_chat,omitempty"`
|
||||
CanDeleteMessages *bool `json:"can_delete_messages,omitempty"`
|
||||
CanBeEdited *bool `json:"can_be_edited,omitempty"`
|
||||
// CanManageChat True, if the administrator can access the chat event log, get boost list, see hidden
|
||||
// supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat
|
||||
// without paying Telegram Stars. Implied by any other administrator privilege.
|
||||
CanManageChat *bool `json:"can_manage_chat,omitempty"`
|
||||
// CanDeleteMessages True, if the administrator can delete messages of other users
|
||||
CanDeleteMessages *bool `json:"can_delete_messages,omitempty"`
|
||||
// CanManageVideoChats True, if the administrator can manage video chats
|
||||
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"`
|
||||
// CanRestrictMembers True, if the administrator can restrict, ban or unban chat members, or access
|
||||
// supergroup statistics
|
||||
CanRestrictMembers *bool `json:"can_restrict_members,omitempty"`
|
||||
// CanPromoteMembers True, if the administrator can add new administrators with a subset of their own
|
||||
// privileges or demote administrators that they have promoted, directly or indirectly (promoted by
|
||||
// administrators that were appointed by the user)
|
||||
CanPromoteMembers *bool `json:"can_promote_members,omitempty"`
|
||||
// CanChangeInfo True, if the user is allowed to change the chat title, photo and other settings
|
||||
CanChangeInfo *bool `json:"can_change_info,omitempty"`
|
||||
// CanInviteUsers True, if the user is allowed to invite new users to the chat
|
||||
CanInviteUsers *bool `json:"can_invite_users,omitempty"`
|
||||
// CanPostStories True, if the administrator can post stories to the chat
|
||||
CanPostStories *bool `json:"can_post_stories,omitempty"` // Since: Bot API 6.9
|
||||
// CanEditStories True, if the administrator can edit stories posted by other users, post stories to the
|
||||
// chat page, pin chat stories, and access the chat's story archive
|
||||
CanEditStories *bool `json:"can_edit_stories,omitempty"` // Since: Bot API 6.9
|
||||
// CanDeleteStories True, if the administrator can delete stories posted by other users
|
||||
CanDeleteStories *bool `json:"can_delete_stories,omitempty"` // Since: Bot API 6.9
|
||||
|
||||
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"`
|
||||
// CanPostMessages Optional. True, if the administrator can post messages in the channel, approve suggested
|
||||
// posts, or access channel statistics; for channels only
|
||||
CanPostMessages *bool `json:"can_post_messages,omitempty"`
|
||||
// CanEditMessages Optional. True, if the administrator can edit messages of other users and can pin
|
||||
// messages; for channels only
|
||||
CanEditMessages *bool `json:"can_edit_messages,omitempty"`
|
||||
// CanPinMessages reports whether the member may pin messages.
|
||||
CanPinMessages *bool `json:"can_pin_messages,omitempty"`
|
||||
// CanManageTopics reports whether the member may manage forum topics.
|
||||
CanManageTopics *bool `json:"can_manage_topics,omitempty"` // Since: Bot API 6.3
|
||||
// CanManageDirectMessages Optional. True, if the administrator can manage direct messages of the channel
|
||||
// and decline suggested posts; for channels only
|
||||
CanManageDirectMessages *bool `json:"can_manage_direct_messages,omitempty"` // Since: Bot API 9.1
|
||||
// CanManageTags Optional. True, if the administrator can edit the tags of regular members; for groups and
|
||||
// supergroups only. If omitted, defaults to the value of can_pin_messages.
|
||||
CanManageTags *bool `json:"can_manage_tags,omitempty"` // Since: Bot API 9.5
|
||||
|
||||
// UntilDate is the Unix time when restrictions expire; zero means forever.
|
||||
// Member
|
||||
UntilDate *int `json:"until_date,omitempty"`
|
||||
|
||||
// IsMember True, if the user is a member of the chat at the moment of the request
|
||||
// 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"`
|
||||
IsMember *bool `json:"is_member,omitempty"`
|
||||
// CanSendMessages True, if the user is allowed to send text messages, rich messages, contacts, giveaways,
|
||||
// giveaway winners, invoices, locations and venues
|
||||
CanSendMessages *bool `json:"can_send_messages,omitempty"`
|
||||
// CanSendAudios True, if the user is allowed to send audios
|
||||
CanSendAudios *bool `json:"can_send_audios,omitempty"` // Since: Bot API 6.5
|
||||
// CanSendDocuments True, if the user is allowed to send documents
|
||||
CanSendDocuments *bool `json:"can_send_documents,omitempty"` // Since: Bot API 6.5
|
||||
// CanSendPhotos True, if the user is allowed to send photos
|
||||
CanSendPhotos *bool `json:"can_send_photos,omitempty"` // Since: Bot API 6.5
|
||||
// CanSendVideos True, if the user is allowed to send videos
|
||||
CanSendVideos *bool `json:"can_send_videos,omitempty"` // Since: Bot API 6.5
|
||||
// CanSendVideoNotes True, if the user is allowed to send video notes
|
||||
CanSendVideoNotes *bool `json:"can_send_video_notes,omitempty"` // Since: Bot API 6.5
|
||||
// CanSendVoiceNotes True, if the user is allowed to send voice notes
|
||||
CanSendVoiceNotes *bool `json:"can_send_voice_notes,omitempty"` // Since: Bot API 6.5
|
||||
// CanSendPolls True, if the user is allowed to send polls and checklists
|
||||
CanSendPolls *bool `json:"can_send_polls,omitempty"`
|
||||
// CanSendOtherMessages True, if the user is allowed to send animations, games, stickers and use inline bots
|
||||
CanSendOtherMessages *bool `json:"can_send_other_messages,omitempty"`
|
||||
// CanAddWebPagePreview True, if the user is allowed to add web page previews to their messages
|
||||
CanAddWebPagePreview *bool `json:"can_add_web_page_previews,omitempty"`
|
||||
CanEditTag *bool `json:"can_edit_tag,omitempty"`
|
||||
// CanReactToMessages True, if the user is allowed to react to messages
|
||||
CanReactToMessages *bool `json:"can_react_to_messages,omitempty"` // Since: Bot API 10.0
|
||||
// CanEditTag True, if the user is allowed to edit their own tag
|
||||
CanEditTag *bool `json:"can_edit_tag,omitempty"` // Since: Bot API 9.5
|
||||
}
|
||||
|
||||
// ChatBoostSource describes the source of a chat boost.
|
||||
// Since: Bot API 7.0
|
||||
// See https://core.telegram.org/bots/api#chatboostsource
|
||||
type ChatBoostSource struct {
|
||||
// Source identifies the source variant: premium, gift_code, or giveaway.
|
||||
Source string `json:"source"`
|
||||
User User `json:"user"`
|
||||
// User is the user responsible for the boost when supplied by the source variant.
|
||||
User User `json:"user"`
|
||||
|
||||
// GiveawayMessageID Identifier of a message in the chat with the giveaway; the message could have been
|
||||
// deleted already. May be 0 if the message isn't sent yet.
|
||||
// Giveaway
|
||||
GiveawayMessageID *int `json:"giveaway_message_id,omitempty"`
|
||||
PrizeStarCount *int `json:"prize_star_count,omitempty"`
|
||||
IsUnclaimed *bool `json:"is_unclaimed,omitempty"`
|
||||
GiveawayMessageID *int `json:"giveaway_message_id,omitempty"`
|
||||
// PrizeStarCount Optional. The number of Telegram Stars to be split between giveaway winners; for Telegram
|
||||
// Star giveaways only
|
||||
PrizeStarCount *int `json:"prize_star_count,omitempty"`
|
||||
// IsUnclaimed Optional. True, if the giveaway was completed, but there was no user to win the prize
|
||||
IsUnclaimed *bool `json:"is_unclaimed,omitempty"`
|
||||
}
|
||||
|
||||
// ChatBoost represents a boost added to a chat.
|
||||
// Since: Bot API 7.0
|
||||
// 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"`
|
||||
// BoostID Unique identifier of the boost
|
||||
BoostID string `json:"boost_id"`
|
||||
// AddDate Point in time (Unix timestamp) when the chat was boosted
|
||||
AddDate int `json:"add_date"`
|
||||
// ExpirationDate Point in time (Unix timestamp) when the boost will automatically expire, unless the
|
||||
// booster's Telegram Premium subscription is prolonged
|
||||
ExpirationDate int `json:"expiration_date"`
|
||||
// Source Source of the added boost
|
||||
Source ChatBoostSource `json:"source"`
|
||||
}
|
||||
|
||||
// UserChatBoosts represents a list of boosts a user has given to a chat.
|
||||
// Since: Bot API 7.0
|
||||
// See https://core.telegram.org/bots/api#userchatboosts
|
||||
type UserChatBoosts struct {
|
||||
// Boosts The list of boosts added to the chat by the user
|
||||
Boosts []ChatBoost `json:"boosts"`
|
||||
}
|
||||
|
||||
// ChatBoostAdded describes a service message about a user boosting a chat.
|
||||
// Since: Bot API 7.1
|
||||
type ChatBoostAdded struct {
|
||||
// BoostCount Number of boosts added by the user
|
||||
BoostCount int `json:"boost_count"`
|
||||
}
|
||||
|
||||
// ChatBackground represents a chat background.
|
||||
// Since: Bot API 7.5
|
||||
type ChatBackground struct {
|
||||
// Type Type of the background
|
||||
Type BackgroundType `json:"type"`
|
||||
}
|
||||
|
||||
// ChatOwnerLeft describes a service message about a chat owner leaving.
|
||||
// Since: Bot API 9.4
|
||||
// See https://core.telegram.org/bots/api#chatownerleft
|
||||
type ChatOwnerLeft struct {
|
||||
// NewOwner Optional. The user who will become the new owner of the chat if the previous owner does not
|
||||
// return to the chat
|
||||
NewOwner *User `json:"new_owner,omitempty"`
|
||||
}
|
||||
|
||||
// ChatOwnerChanged describes a service message about a chat owner change.
|
||||
// Since: Bot API 9.4
|
||||
// See https://core.telegram.org/bots/api#chatownerchanged
|
||||
type ChatOwnerChanged struct {
|
||||
// NewOwner The new owner of the chat
|
||||
NewOwner User `json:"new_owner"`
|
||||
}
|
||||
|
||||
// ChatAdministratorRights represents the rights of an administrator in a chat.
|
||||
// Since: Bot API 6.0
|
||||
// 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"`
|
||||
// IsAnonymous True, if the user's presence in the chat is hidden
|
||||
IsAnonymous bool `json:"is_anonymous"`
|
||||
// CanManageChat True, if the administrator can access the chat event log, get boost list, see hidden
|
||||
// supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat
|
||||
// without paying Telegram Stars. Implied by any other administrator privilege.
|
||||
CanManageChat bool `json:"can_manage_chat"`
|
||||
// CanDeleteMessages True, if the administrator can delete messages of other users
|
||||
CanDeleteMessages bool `json:"can_delete_messages"`
|
||||
// CanManageVideoChats True, if the administrator can manage video chats
|
||||
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"`
|
||||
// CanRestrictMembers True, if the administrator can restrict, ban or unban chat members, or access
|
||||
// supergroup statistics
|
||||
CanRestrictMembers bool `json:"can_restrict_members"`
|
||||
// CanPromoteMembers True, if the administrator can add new administrators with a subset of their own
|
||||
// privileges or demote administrators that they have promoted, directly or indirectly (promoted by
|
||||
// administrators that were appointed by the user)
|
||||
CanPromoteMembers bool `json:"can_promote_members"`
|
||||
// CanChangeInfo True, if the user is allowed to change the chat title, photo and other settings
|
||||
CanChangeInfo bool `json:"can_change_info"`
|
||||
// CanInviteUsers True, if the user is allowed to invite new users to the chat
|
||||
CanInviteUsers bool `json:"can_invite_users"`
|
||||
// CanPostStories True, if the administrator can post stories to the chat
|
||||
CanPostStories bool `json:"can_post_stories"`
|
||||
// CanEditStories True, if the administrator can edit stories posted by other users, post stories to the
|
||||
// chat page, pin chat stories, and access the chat's story archive
|
||||
CanEditStories bool `json:"can_edit_stories"`
|
||||
// CanDeleteStories True, if the administrator can delete stories posted by other users
|
||||
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"`
|
||||
// CanPostMessages Optional. True, if the administrator can post messages in the channel, approve suggested
|
||||
// posts, or access channel statistics; for channels only
|
||||
CanPostMessages *bool `json:"can_post_messages,omitempty"`
|
||||
// CanEditMessages Optional. True, if the administrator can edit messages of other users and can pin
|
||||
// messages; for channels only
|
||||
CanEditMessages *bool `json:"can_edit_messages,omitempty"`
|
||||
// CanPinMessages Optional. True, if the user is allowed to pin messages; for groups and supergroups only
|
||||
CanPinMessages *bool `json:"can_pin_messages,omitempty"`
|
||||
// CanManageTopics Optional. True, if the user is allowed to create, rename, close, and reopen forum topics;
|
||||
// for supergroups only
|
||||
CanManageTopics *bool `json:"can_manage_topics,omitempty"`
|
||||
// CanManageDirectMessages Optional. True, if the administrator can manage direct messages of the channel
|
||||
// and decline suggested posts; for channels only
|
||||
CanManageDirectMessages *bool `json:"can_manage_direct_messages,omitempty"`
|
||||
CanManageTags *bool `json:"can_manage_tags,omitempty"`
|
||||
// CanManageTags Optional. True, if the administrator can edit the tags of regular members; for groups and
|
||||
// supergroups only. If omitted, defaults to the value of can_pin_messages.
|
||||
CanManageTags *bool `json:"can_manage_tags,omitempty"`
|
||||
}
|
||||
|
||||
// ChatBoostUpdated represents a boost added to a chat or changed.
|
||||
// Since: Bot API 7.0
|
||||
// See https://core.telegram.org/bots/api#chatboostupdated
|
||||
type ChatBoostUpdated struct {
|
||||
Chat Chat `json:"chat"`
|
||||
// Chat Chat which was boosted
|
||||
Chat Chat `json:"chat"`
|
||||
// Boost Information about the chat boost
|
||||
Boost ChatBoost `json:"boost"`
|
||||
}
|
||||
|
||||
// ChatBoostRemoved represents a boost removed from a chat.
|
||||
// Since: Bot API 7.0
|
||||
// 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"`
|
||||
// Chat Chat which was boosted
|
||||
Chat Chat `json:"chat"`
|
||||
// BoostID Unique identifier of the boost
|
||||
BoostID string `json:"boost_id"`
|
||||
// RemoveDate Point in time (Unix timestamp) when the boost was removed
|
||||
RemoveDate int `json:"remove_date"`
|
||||
// Source Source of the removed boost
|
||||
Source ChatBoostSource `json:"source"`
|
||||
}
|
||||
|
||||
// Community represents a group of chats.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type Community struct {
|
||||
// ID uniquely identifies the value within its containing object.
|
||||
ID int64 `json:"id"`
|
||||
// Name is the user-facing or reference name of the value.
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
// CommunityChatAdded describes a service message about a chat joining a community.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type CommunityChatAdded struct {
|
||||
// Community contains information about the affected community.
|
||||
Community Community `json:"community"`
|
||||
}
|
||||
|
||||
// CommunityChatRemoved describes a service message about a chat leaving a community.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type CommunityChatRemoved struct{}
|
||||
|
||||
+45
-4
@@ -1,9 +1,9 @@
|
||||
package tgapi
|
||||
|
||||
import "errors"
|
||||
|
||||
// ErrRateLimit reports that a request exceeded the configured rate limiter.
|
||||
var ErrRateLimit = errors.New("rate limit exceeded")
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
)
|
||||
|
||||
// ErrPoolUnexpected reports an unexpected result type returned from the worker pool.
|
||||
var ErrPoolUnexpected = errors.New("unexpected response from pool")
|
||||
@@ -13,3 +13,44 @@ 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")
|
||||
|
||||
// ErrPoolWorkerPanic reports a panic recovered while executing a worker-pool request.
|
||||
var ErrPoolWorkerPanic = errors.New("worker pool request panicked")
|
||||
|
||||
// ErrResponseTooLarge reports a Telegram API response larger than the safety limit.
|
||||
var ErrResponseTooLarge = errors.New("telegram API response is too large")
|
||||
|
||||
// ErrFileTooLarge reports a file download that exceeds the caller's limit.
|
||||
var ErrFileTooLarge = errors.New("telegram file exceeds size limit")
|
||||
|
||||
// ErrRichJSONDepth reports a rich-message JSON tree deeper than the decoder limit.
|
||||
var ErrRichJSONDepth = errors.New("rich-message JSON exceeds depth limit")
|
||||
|
||||
// ErrRichJSONNodes reports a rich-message JSON tree larger than the decoder limit.
|
||||
var ErrRichJSONNodes = errors.New("rich-message JSON exceeds node limit")
|
||||
|
||||
// ErrRetryLimit reports that a request exhausted its configured 429 retries.
|
||||
var ErrRetryLimit = errors.New("telegram retry limit reached")
|
||||
|
||||
// ErrRichMessageDraftUploadUnsupported reports a direct file upload attempted for a rich draft.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
var ErrRichMessageDraftUploadUnsupported = errors.New("sendRichMessageDraft does not support direct file uploads")
|
||||
|
||||
// ResponseError reports an unsuccessful Telegram API response.
|
||||
type ResponseError struct {
|
||||
// Code is the Telegram API error code.
|
||||
Code int
|
||||
// Description is the human-readable Telegram API error description.
|
||||
Description string
|
||||
// Parameters contains additional recovery metadata such as retry_after.
|
||||
Parameters *ResponseParameters
|
||||
}
|
||||
|
||||
// Error returns the Telegram API error code and description.
|
||||
func (e *ResponseError) Error() string {
|
||||
if e == nil {
|
||||
return "<nil>"
|
||||
}
|
||||
return fmt.Sprintf("[%d] %s", e.Code, e.Description)
|
||||
}
|
||||
|
||||
+59
-9
@@ -3,12 +3,16 @@ package tgapi
|
||||
import "context"
|
||||
|
||||
// BaseForumTopic contains common fields for forum topic operations that require a chat ID and a message thread ID.
|
||||
// Since: Bot API 6.3
|
||||
type BaseForumTopic struct {
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id"`
|
||||
// ChatID identifies the target supergroup.
|
||||
ChatID int64 `json:"chat_id"`
|
||||
// MessageThreadID identifies the target forum topic.
|
||||
MessageThreadID int `json:"message_thread_id"`
|
||||
}
|
||||
|
||||
// GetForumTopicIconStickers returns the list of custom emoji that can be used as a forum topic icon.
|
||||
// Since: Bot API 6.3
|
||||
// See https://core.telegram.org/bots/api#getforumtopiciconstickers
|
||||
func (api *API) GetForumTopicIconStickers() ([]Sticker, error) {
|
||||
req := NewRequest[[]Sticker]("getForumTopicIconStickers", NoParams)
|
||||
@@ -16,6 +20,7 @@ func (api *API) GetForumTopicIconStickers() ([]Sticker, error) {
|
||||
}
|
||||
|
||||
// GetForumTopicIconStickersWithContext is the context-aware variant of GetForumTopicIconStickers.
|
||||
// Since: Bot API 6.3
|
||||
// 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) {
|
||||
@@ -24,15 +29,25 @@ func (api *API) GetForumTopicIconStickersWithContext(ctx context.Context) ([]Sti
|
||||
}
|
||||
|
||||
// CreateForumTopic holds parameters for the createForumTopic method.
|
||||
// Since: Bot API 6.3
|
||||
// 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"`
|
||||
// ChatID Required. Unique identifier for the target chat or username of the target supergroup in the format
|
||||
// @username
|
||||
ChatID int64 `json:"chat_id"`
|
||||
// Name Required. Topic name, 1-128 characters
|
||||
Name string `json:"name"`
|
||||
// IconColor Optional. Color of the topic icon in RGB format. Currently, must be one of 7322096 (0x6FB9F0),
|
||||
// 16766590 (0xFFD67E), 13338331 (0xCB86DB), 9367192 (0x8EEE98), 16749490 (0xFF93B2), or 16478047
|
||||
// (0xFB6F5F).
|
||||
IconColor ForumTopicIconColor `json:"icon_color"`
|
||||
// IconCustomEmojiID Optional. Unique identifier of the custom emoji shown as the topic icon. Use
|
||||
// getForumTopicIconStickers to get all allowed custom emoji identifiers.
|
||||
IconCustomEmojiID string `json:"icon_custom_emoji_id"`
|
||||
}
|
||||
|
||||
// CreateForumTopic creates a topic in a forum supergroup.
|
||||
// Since: Bot API 6.3
|
||||
// Returns the created ForumTopic on success.
|
||||
// See https://core.telegram.org/bots/api#createforumtopic
|
||||
func (api *API) CreateForumTopic(params CreateForumTopic) (ForumTopic, error) {
|
||||
@@ -41,6 +56,7 @@ func (api *API) CreateForumTopic(params CreateForumTopic) (ForumTopic, error) {
|
||||
}
|
||||
|
||||
// CreateForumTopicWithContext is the context-aware variant of CreateForumTopic.
|
||||
// Since: Bot API 6.3
|
||||
// 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) {
|
||||
@@ -49,14 +65,21 @@ func (api *API) CreateForumTopicWithContext(ctx context.Context, params CreateFo
|
||||
}
|
||||
|
||||
// EditForumTopic holds parameters for the editForumTopic method.
|
||||
// Since: Bot API 6.3
|
||||
// See https://core.telegram.org/bots/api#editforumtopic
|
||||
type EditForumTopic struct {
|
||||
BaseForumTopic
|
||||
Name string `json:"name"`
|
||||
// Name Optional. New topic name, 0-128 characters. If not specified or empty, the current name of the topic
|
||||
// will be kept.
|
||||
Name string `json:"name"`
|
||||
// IconCustomEmojiID Optional. New unique identifier of the custom emoji shown as the topic icon. Use
|
||||
// getForumTopicIconStickers to get all allowed custom emoji identifiers. Pass an empty string to remove the
|
||||
// icon. If not specified, the current icon will be kept.
|
||||
IconCustomEmojiID string `json:"icon_custom_emoji_id"`
|
||||
}
|
||||
|
||||
// EditForumTopic edits name and icon of a forum topic.
|
||||
// Since: Bot API 6.3
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#editforumtopic
|
||||
func (api *API) EditForumTopic(params EditForumTopic) (bool, error) {
|
||||
@@ -65,6 +88,7 @@ func (api *API) EditForumTopic(params EditForumTopic) (bool, error) {
|
||||
}
|
||||
|
||||
// EditForumTopicWithContext is the context-aware variant of EditForumTopic.
|
||||
// Since: Bot API 6.3
|
||||
// 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) {
|
||||
@@ -73,6 +97,7 @@ func (api *API) EditForumTopicWithContext(ctx context.Context, params EditForumT
|
||||
}
|
||||
|
||||
// CloseForumTopic closes an open forum topic.
|
||||
// Since: Bot API 6.3
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#closeforumtopic
|
||||
func (api *API) CloseForumTopic(params BaseForumTopic) (bool, error) {
|
||||
@@ -81,6 +106,7 @@ func (api *API) CloseForumTopic(params BaseForumTopic) (bool, error) {
|
||||
}
|
||||
|
||||
// CloseForumTopicWithContext is the context-aware variant of CloseForumTopic.
|
||||
// Since: Bot API 6.3
|
||||
// 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) {
|
||||
@@ -89,6 +115,7 @@ func (api *API) CloseForumTopicWithContext(ctx context.Context, params BaseForum
|
||||
}
|
||||
|
||||
// ReopenForumTopic reopens a closed forum topic.
|
||||
// Since: Bot API 6.3
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#reopenforumtopic
|
||||
func (api *API) ReopenForumTopic(params BaseForumTopic) (bool, error) {
|
||||
@@ -97,6 +124,7 @@ func (api *API) ReopenForumTopic(params BaseForumTopic) (bool, error) {
|
||||
}
|
||||
|
||||
// ReopenForumTopicWithContext is the context-aware variant of ReopenForumTopic.
|
||||
// Since: Bot API 6.3
|
||||
// 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) {
|
||||
@@ -105,6 +133,7 @@ func (api *API) ReopenForumTopicWithContext(ctx context.Context, params BaseForu
|
||||
}
|
||||
|
||||
// DeleteForumTopic deletes a forum topic.
|
||||
// Since: Bot API 6.3
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#deleteforumtopic
|
||||
func (api *API) DeleteForumTopic(params BaseForumTopic) (bool, error) {
|
||||
@@ -113,6 +142,7 @@ func (api *API) DeleteForumTopic(params BaseForumTopic) (bool, error) {
|
||||
}
|
||||
|
||||
// DeleteForumTopicWithContext is the context-aware variant of DeleteForumTopic.
|
||||
// Since: Bot API 6.3
|
||||
// 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) {
|
||||
@@ -121,6 +151,7 @@ func (api *API) DeleteForumTopicWithContext(ctx context.Context, params BaseForu
|
||||
}
|
||||
|
||||
// UnpinAllForumTopicMessages clears the list of pinned messages in a forum topic.
|
||||
// Since: Bot API 6.3
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#unpinallforumtopicmessages
|
||||
func (api *API) UnpinAllForumTopicMessages(params BaseForumTopic) (bool, error) {
|
||||
@@ -129,6 +160,7 @@ func (api *API) UnpinAllForumTopicMessages(params BaseForumTopic) (bool, error)
|
||||
}
|
||||
|
||||
// UnpinAllForumTopicMessagesWithContext is the context-aware variant of UnpinAllForumTopicMessages.
|
||||
// Since: Bot API 6.3
|
||||
// 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) {
|
||||
@@ -137,18 +169,25 @@ func (api *API) UnpinAllForumTopicMessagesWithContext(ctx context.Context, param
|
||||
}
|
||||
|
||||
// BaseGeneralForumTopic contains common fields for general forum topic operations that require a chat ID.
|
||||
// Since: Bot API 6.4
|
||||
type BaseGeneralForumTopic struct {
|
||||
// ChatID identifies the target supergroup.
|
||||
ChatID int64 `json:"chat_id"`
|
||||
}
|
||||
|
||||
// EditGeneralForumTopic holds parameters for the editGeneralForumTopic method.
|
||||
// Since: Bot API 6.4
|
||||
// See https://core.telegram.org/bots/api#editgeneralforumtopic
|
||||
type EditGeneralForumTopic struct {
|
||||
ChatID int64 `json:"chat_id"`
|
||||
Name string `json:"name"`
|
||||
// ChatID Required. Unique identifier for the target chat or username of the target supergroup in the format
|
||||
// @username
|
||||
ChatID int64 `json:"chat_id"`
|
||||
// Name Required. New topic name, 1-128 characters
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
// EditGeneralForumTopic edits the name of the 'General' topic in a forum supergroup.
|
||||
// Since: Bot API 6.4
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#editgeneralforumtopic
|
||||
func (api *API) EditGeneralForumTopic(params EditGeneralForumTopic) (bool, error) {
|
||||
@@ -157,6 +196,7 @@ func (api *API) EditGeneralForumTopic(params EditGeneralForumTopic) (bool, error
|
||||
}
|
||||
|
||||
// EditGeneralForumTopicWithContext is the context-aware variant of EditGeneralForumTopic.
|
||||
// Since: Bot API 6.4
|
||||
// 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) {
|
||||
@@ -165,6 +205,7 @@ func (api *API) EditGeneralForumTopicWithContext(ctx context.Context, params Edi
|
||||
}
|
||||
|
||||
// CloseGeneralForumTopic closes the 'General' topic in a forum supergroup.
|
||||
// Since: Bot API 6.4
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#closegeneralforumtopic
|
||||
func (api *API) CloseGeneralForumTopic(params BaseGeneralForumTopic) (bool, error) {
|
||||
@@ -173,6 +214,7 @@ func (api *API) CloseGeneralForumTopic(params BaseGeneralForumTopic) (bool, erro
|
||||
}
|
||||
|
||||
// CloseGeneralForumTopicWithContext is the context-aware variant of CloseGeneralForumTopic.
|
||||
// Since: Bot API 6.4
|
||||
// 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) {
|
||||
@@ -181,6 +223,7 @@ func (api *API) CloseGeneralForumTopicWithContext(ctx context.Context, params Ba
|
||||
}
|
||||
|
||||
// ReopenGeneralForumTopic reopens the 'General' topic in a forum supergroup.
|
||||
// Since: Bot API 6.4
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#reopengeneralforumtopic
|
||||
func (api *API) ReopenGeneralForumTopic(params BaseGeneralForumTopic) (bool, error) {
|
||||
@@ -189,6 +232,7 @@ func (api *API) ReopenGeneralForumTopic(params BaseGeneralForumTopic) (bool, err
|
||||
}
|
||||
|
||||
// ReopenGeneralForumTopicWithContext is the context-aware variant of ReopenGeneralForumTopic.
|
||||
// Since: Bot API 6.4
|
||||
// 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) {
|
||||
@@ -197,6 +241,7 @@ func (api *API) ReopenGeneralForumTopicWithContext(ctx context.Context, params B
|
||||
}
|
||||
|
||||
// HideGeneralForumTopic hides the 'General' topic in a forum supergroup.
|
||||
// Since: Bot API 6.4
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#hidegeneralforumtopic
|
||||
func (api *API) HideGeneralForumTopic(params BaseGeneralForumTopic) (bool, error) {
|
||||
@@ -205,6 +250,7 @@ func (api *API) HideGeneralForumTopic(params BaseGeneralForumTopic) (bool, error
|
||||
}
|
||||
|
||||
// HideGeneralForumTopicWithContext is the context-aware variant of HideGeneralForumTopic.
|
||||
// Since: Bot API 6.4
|
||||
// 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) {
|
||||
@@ -213,6 +259,7 @@ func (api *API) HideGeneralForumTopicWithContext(ctx context.Context, params Bas
|
||||
}
|
||||
|
||||
// UnhideGeneralForumTopic unhides the 'General' topic in a forum supergroup.
|
||||
// Since: Bot API 6.4
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#unhidegeneralforumtopic
|
||||
func (api *API) UnhideGeneralForumTopic(params BaseGeneralForumTopic) (bool, error) {
|
||||
@@ -221,6 +268,7 @@ func (api *API) UnhideGeneralForumTopic(params BaseGeneralForumTopic) (bool, err
|
||||
}
|
||||
|
||||
// UnhideGeneralForumTopicWithContext is the context-aware variant of UnhideGeneralForumTopic.
|
||||
// Since: Bot API 6.4
|
||||
// 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) {
|
||||
@@ -229,6 +277,7 @@ func (api *API) UnhideGeneralForumTopicWithContext(ctx context.Context, params B
|
||||
}
|
||||
|
||||
// UnpinAllGeneralForumTopicMessages clears the list of pinned messages in the 'General' topic.
|
||||
// Since: Bot API 6.4
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#unpinallgeneralforumtopicmessages
|
||||
func (api *API) UnpinAllGeneralForumTopicMessages(params BaseGeneralForumTopic) (bool, error) {
|
||||
@@ -237,6 +286,7 @@ func (api *API) UnpinAllGeneralForumTopicMessages(params BaseGeneralForumTopic)
|
||||
}
|
||||
|
||||
// UnpinAllGeneralForumTopicMessagesWithContext is the context-aware variant of UnpinAllGeneralForumTopicMessages.
|
||||
// Since: Bot API 6.4
|
||||
// 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) {
|
||||
|
||||
+42
-10
@@ -1,17 +1,25 @@
|
||||
package tgapi
|
||||
|
||||
// ForumTopic represents a forum topic.
|
||||
// Since: Bot API 6.3
|
||||
// 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"`
|
||||
// MessageThreadID Unique identifier of the forum topic
|
||||
MessageThreadID int `json:"message_thread_id"`
|
||||
// Name Name of the topic
|
||||
Name string `json:"name"`
|
||||
// IconColor Color of the topic icon in RGB format
|
||||
IconColor int `json:"icon_color"`
|
||||
// IconCustomEmojiID Optional. Unique identifier of the custom emoji shown as the topic icon
|
||||
IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
|
||||
IsNameImplicit bool `json:"is_name_implicit,omitempty"`
|
||||
// IsNameImplicit Optional. True, if the name of the topic wasn't specified explicitly by its creator and
|
||||
// likely needs to be changed by the bot
|
||||
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.
|
||||
// Since: Bot API 6.3
|
||||
// See https://core.telegram.org/bots/api#forumtopiciconcolor
|
||||
type ForumTopicIconColor int
|
||||
|
||||
@@ -20,18 +28,42 @@ const (
|
||||
ForumTopicIconColorBlue ForumTopicIconColor = 7322096
|
||||
)
|
||||
|
||||
// ForumTopicCreated represents a service message about a new forum topic created.
|
||||
// Since: Bot API 6.3
|
||||
type ForumTopicCreated struct {
|
||||
Name string `json:"name"`
|
||||
IconColor int `json:"icon_color"`
|
||||
// Name Name of the topic
|
||||
Name string `json:"name"`
|
||||
// IconColor Color of the topic icon in RGB format
|
||||
IconColor int `json:"icon_color"`
|
||||
// IconCustomEmojiID Optional. Unique identifier of the custom emoji shown as the topic icon
|
||||
IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
|
||||
IsNameImplicit bool `json:"is_name_implicit,omitempty"`
|
||||
// IsNameImplicit Optional. True, if the name of the topic wasn't specified explicitly by its creator and
|
||||
// likely needs to be changed by the bot
|
||||
IsNameImplicit bool `json:"is_name_implicit,omitempty"`
|
||||
}
|
||||
|
||||
// ForumTopicEdited represents a service message about an edited forum topic.
|
||||
// Since: Bot API 6.4
|
||||
type ForumTopicEdited struct {
|
||||
Name string `json:"name,omitempty"`
|
||||
// Name Optional. New name of the topic, if it was edited
|
||||
Name string `json:"name,omitempty"`
|
||||
// IconCustomEmojiID Optional. New identifier of the custom emoji shown as the topic icon, if it was edited;
|
||||
// an empty string if the icon was removed
|
||||
IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
|
||||
}
|
||||
|
||||
// ForumTopicClosed represents a service message about a forum topic closed.
|
||||
// Since: Bot API 6.3
|
||||
type ForumTopicClosed struct{}
|
||||
|
||||
// ForumTopicReopened represents a service message about a forum topic reopened.
|
||||
// Since: Bot API 6.3
|
||||
type ForumTopicReopened struct{}
|
||||
|
||||
// GeneralForumTopicHidden represents a service message about the General forum topic hidden.
|
||||
// Since: Bot API 6.4
|
||||
type GeneralForumTopicHidden struct{}
|
||||
type GeneralForumTopicUnhidden struct {
|
||||
}
|
||||
|
||||
// GeneralForumTopicUnhidden represents a service message about the General forum topic unhidden.
|
||||
// Since: Bot API 6.4
|
||||
type GeneralForumTopicUnhidden struct{}
|
||||
|
||||
+61
-18
@@ -3,23 +3,44 @@ package tgapi
|
||||
import "context"
|
||||
|
||||
// SendGame holds parameters for the sendGame method.
|
||||
// Since: Bot API 2.2
|
||||
// See https://core.telegram.org/bots/api#sendgame
|
||||
type SendGame struct {
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
ChatID int64 `json:"chat_id"`
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
// ChatID Required. Unique identifier for the target chat or username of the target bot in the format
|
||||
// @username. Games can't be sent to channel direct messages chats and channel chats.
|
||||
ChatID int64 `json:"chat_id"`
|
||||
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||
// supergroups and private chats of bots with forum topic mode enabled only
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
|
||||
// GameShortName Required. Short name of the game, serves as the unique identifier for the game. Set up your
|
||||
// games via @BotFather.
|
||||
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"`
|
||||
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||
// sound.
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||
// balance.
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||
// chats only
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
// ReplyMarkup Optional. A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title'
|
||||
// button will be shown. If not empty, the first button must launch the game.
|
||||
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendGame sends a game message.
|
||||
// Since: Bot API 2.2
|
||||
// See https://core.telegram.org/bots/api#sendgame
|
||||
func (api *API) SendGame(params SendGame) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendGame", params, params.ChatID)
|
||||
@@ -27,6 +48,7 @@ func (api *API) SendGame(params SendGame) (Message, error) {
|
||||
}
|
||||
|
||||
// SendGameWithContext is the context-aware variant of SendGame.
|
||||
// Since: Bot API 2.2
|
||||
// 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) {
|
||||
@@ -35,18 +57,30 @@ func (api *API) SendGameWithContext(ctx context.Context, params SendGame) (Messa
|
||||
}
|
||||
|
||||
// SetGameScore holds parameters for the setGameScore method.
|
||||
// Since: Bot API 2.2
|
||||
// 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"`
|
||||
// UserID Required. User identifier
|
||||
UserID int64 `json:"user_id"`
|
||||
// Score Required. New score, must be non-negative
|
||||
Score int `json:"score"`
|
||||
// Force Optional. Pass True if the high score is allowed to decrease. This can be useful when fixing
|
||||
// mistakes or banning cheaters.
|
||||
Force bool `json:"force,omitempty"`
|
||||
// DisableEditMessage Optional. Pass True if the game message should not be automatically edited to include
|
||||
// the current scoreboard
|
||||
DisableEditMessage bool `json:"disable_edit_message,omitempty"`
|
||||
// ChatID Optional. Required if inline_message_id is not specified. Unique identifier for the target chat.
|
||||
ChatID int64 `json:"chat_id,omitempty"`
|
||||
// MessageID Optional. Required if inline_message_id is not specified. Identifier of the sent message.
|
||||
MessageID int `json:"message_id,omitempty"`
|
||||
// InlineMessageID Optional. Required if chat_id and message_id are not specified. Identifier of the inline
|
||||
// message.
|
||||
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||
}
|
||||
|
||||
// SetGameScore sets a user's score in a game message.
|
||||
// Since: Bot API 2.2
|
||||
// If inline_message_id is provided, returns a boolean success flag.
|
||||
// Otherwise returns the edited Message.
|
||||
// See https://core.telegram.org/bots/api#setgamescore
|
||||
@@ -63,6 +97,7 @@ func (api *API) SetGameScore(params SetGameScore) (Message, bool, error) {
|
||||
}
|
||||
|
||||
// SetGameScoreWithContext is the context-aware variant of SetGameScore.
|
||||
// Since: Bot API 2.2
|
||||
// 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) {
|
||||
@@ -78,15 +113,22 @@ func (api *API) SetGameScoreWithContext(ctx context.Context, params SetGameScore
|
||||
}
|
||||
|
||||
// GetGameHighScores holds parameters for the getGameHighScores method.
|
||||
// Since: Bot API 2.2
|
||||
// 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"`
|
||||
// UserID Required. Target user id
|
||||
UserID int64 `json:"user_id"`
|
||||
// ChatID Optional. Required if inline_message_id is not specified. Unique identifier for the target chat.
|
||||
ChatID int64 `json:"chat_id,omitempty"`
|
||||
// MessageID Optional. Required if inline_message_id is not specified. Identifier of the sent message.
|
||||
MessageID int `json:"message_id,omitempty"`
|
||||
// InlineMessageID Optional. Required if chat_id and message_id are not specified. Identifier of the inline
|
||||
// message.
|
||||
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||
}
|
||||
|
||||
// GetGameHighScores returns game high score data for a user.
|
||||
// Since: Bot API 2.2
|
||||
// See https://core.telegram.org/bots/api#getgamehighscores
|
||||
func (api *API) GetGameHighScores(params GetGameHighScores) ([]GameHighScore, error) {
|
||||
req := NewRequestWithChatID[[]GameHighScore]("getGameHighScores", params, params.ChatID)
|
||||
@@ -94,6 +136,7 @@ func (api *API) GetGameHighScores(params GetGameHighScores) ([]GameHighScore, er
|
||||
}
|
||||
|
||||
// GetGameHighScoresWithContext is the context-aware variant of GetGameHighScores.
|
||||
// Since: Bot API 2.2
|
||||
// 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) {
|
||||
|
||||
+25
-8
@@ -1,19 +1,36 @@
|
||||
package tgapi
|
||||
|
||||
// Game represents a game.
|
||||
// Since: Bot API 2.2
|
||||
type Game struct {
|
||||
Title string `json:"title"`
|
||||
Description string `json:"description"`
|
||||
Photo []PhotoSize `json:"photo"`
|
||||
Text string `json:"text,omitempty"`
|
||||
// Title Title of the game
|
||||
Title string `json:"title"`
|
||||
// Description Description of the game
|
||||
Description string `json:"description"`
|
||||
// Photo Photo that will be displayed in the game message in chats
|
||||
Photo []PhotoSize `json:"photo"`
|
||||
// Text Optional. Brief description of the game or high scores included in the game message. Can be
|
||||
// automatically edited to include current high scores for the game when the bot calls setGameScore, or
|
||||
// manually edited using editMessageText. 0-4096 characters.
|
||||
Text string `json:"text,omitempty"`
|
||||
// TextEntities Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc.
|
||||
TextEntities []MessageEntity `json:"text_entities,omitempty"`
|
||||
Animation *Animation `json:"animation,omitempty"`
|
||||
// Animation Optional. Animation that will be displayed in the game message in chats. Upload via BotFather.
|
||||
Animation *Animation `json:"animation,omitempty"`
|
||||
}
|
||||
|
||||
// CallbackGame is a placeholder for the future use of callback games.
|
||||
// Since: Bot API 2.2
|
||||
type CallbackGame struct{}
|
||||
|
||||
// GameHighScore represents one row in a game high score table.
|
||||
// Since: Bot API 2.2
|
||||
// See https://core.telegram.org/bots/api#gamehighscore
|
||||
type GameHighScore struct {
|
||||
Position int `json:"position"`
|
||||
User User `json:"user"`
|
||||
Score int `json:"score"`
|
||||
// Position Position in high score table for the game
|
||||
Position int `json:"position"`
|
||||
// User User
|
||||
User User `json:"user"`
|
||||
// Score Score
|
||||
Score int `json:"score"`
|
||||
}
|
||||
|
||||
+48
-15
@@ -3,17 +3,29 @@ package tgapi
|
||||
import "context"
|
||||
|
||||
// AnswerInlineQuery holds parameters for the answerInlineQuery method.
|
||||
// Since: Bot API 1.7
|
||||
// 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"`
|
||||
// InlineQueryID Required. Unique identifier for the answered query
|
||||
InlineQueryID string `json:"inline_query_id"`
|
||||
// Results Required. A JSON-serialized Array of results for the inline query
|
||||
Results []InlineQueryResult `json:"results"`
|
||||
// CacheTime Optional. The maximum amount of time in seconds that the result of the inline query may be
|
||||
// cached on the server. Defaults to 300.
|
||||
CacheTime int `json:"cache_time,omitempty"`
|
||||
// IsPersonal Optional. Pass True if results may be cached on the server side only for the user that sent
|
||||
// the query. By default, results may be returned to any user who sends the same query.
|
||||
IsPersonal bool `json:"is_personal,omitempty"`
|
||||
// NextOffset Optional. Pass the offset that a client should send in the next query with the same text to
|
||||
// receive more results. Pass an empty string if there are no more results or if you don't support
|
||||
// pagination. Offset length can't exceed 64 bytes.
|
||||
NextOffset string `json:"next_offset,omitempty"`
|
||||
// Button Optional. A JSON-serialized object describing a button to be shown above inline query results
|
||||
Button *InlineQueryResultsButton `json:"button,omitempty"`
|
||||
}
|
||||
|
||||
// AnswerInlineQuery sends answers to an inline query.
|
||||
// Since: Bot API 1.7
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#answerinlinequery
|
||||
func (api *API) AnswerInlineQuery(params AnswerInlineQuery) (bool, error) {
|
||||
@@ -22,6 +34,7 @@ func (api *API) AnswerInlineQuery(params AnswerInlineQuery) (bool, error) {
|
||||
}
|
||||
|
||||
// AnswerInlineQueryWithContext is the context-aware variant of AnswerInlineQuery.
|
||||
// Since: Bot API 1.7
|
||||
// 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) {
|
||||
@@ -30,13 +43,17 @@ func (api *API) AnswerInlineQueryWithContext(ctx context.Context, params AnswerI
|
||||
}
|
||||
|
||||
// AnswerWebAppQuery holds parameters for the answerWebAppQuery method.
|
||||
// Since: Bot API 8.0
|
||||
// See https://core.telegram.org/bots/api#answerwebappquery
|
||||
type AnswerWebAppQuery struct {
|
||||
WebAppQueryID string `json:"web_app_query_id"`
|
||||
Result InlineQueryResult `json:"result"`
|
||||
// WebAppQueryID Required. Unique identifier for the query to be answered
|
||||
WebAppQueryID string `json:"web_app_query_id"`
|
||||
// Result Required. A JSON-serialized object describing the message to be sent
|
||||
Result InlineQueryResult `json:"result"`
|
||||
}
|
||||
|
||||
// AnswerWebAppQuery sets the result of a Web App interaction.
|
||||
// Since: Bot API 8.0
|
||||
// See https://core.telegram.org/bots/api#answerwebappquery
|
||||
func (api *API) AnswerWebAppQuery(params AnswerWebAppQuery) (SentWebAppMessage, error) {
|
||||
req := NewRequest[SentWebAppMessage]("answerWebAppQuery", params)
|
||||
@@ -44,6 +61,7 @@ func (api *API) AnswerWebAppQuery(params AnswerWebAppQuery) (SentWebAppMessage,
|
||||
}
|
||||
|
||||
// AnswerWebAppQueryWithContext is the context-aware variant of AnswerWebAppQuery.
|
||||
// Since: Bot API 8.0
|
||||
// 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) {
|
||||
@@ -52,17 +70,25 @@ func (api *API) AnswerWebAppQueryWithContext(ctx context.Context, params AnswerW
|
||||
}
|
||||
|
||||
// SavePreparedInlineMessage holds parameters for the savePreparedInlineMessage method.
|
||||
// Since: Bot API 8.0
|
||||
// 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"`
|
||||
// UserID Required. Unique identifier of the target user that can use the prepared message
|
||||
UserID int64 `json:"user_id"`
|
||||
// Result Required. A JSON-serialized object describing the message to be sent
|
||||
Result InlineQueryResult `json:"result"`
|
||||
// AllowUserChats Optional. Pass True if the message can be sent to private chats with users
|
||||
AllowUserChats bool `json:"allow_user_chats,omitempty"`
|
||||
// AllowBotChats Optional. Pass True if the message can be sent to private chats with bots
|
||||
AllowBotChats bool `json:"allow_bot_chats,omitempty"`
|
||||
// AllowGroupChats Optional. Pass True if the message can be sent to group and supergroup chats
|
||||
AllowGroupChats bool `json:"allow_group_chats,omitempty"`
|
||||
// AllowChannelChats Optional. Pass True if the message can be sent to channel chats
|
||||
AllowChannelChats bool `json:"allow_channel_chats,omitempty"`
|
||||
}
|
||||
|
||||
// SavePreparedInlineMessage stores a prepared message for Mini App users.
|
||||
// Since: Bot API 8.0
|
||||
// See https://core.telegram.org/bots/api#savepreparedinlinemessage
|
||||
func (api *API) SavePreparedInlineMessage(params SavePreparedInlineMessage) (PreparedInlineMessage, error) {
|
||||
req := NewRequest[PreparedInlineMessage]("savePreparedInlineMessage", params)
|
||||
@@ -70,6 +96,7 @@ func (api *API) SavePreparedInlineMessage(params SavePreparedInlineMessage) (Pre
|
||||
}
|
||||
|
||||
// SavePreparedInlineMessageWithContext is the context-aware variant of SavePreparedInlineMessage.
|
||||
// Since: Bot API 8.0
|
||||
// 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) {
|
||||
@@ -78,13 +105,18 @@ func (api *API) SavePreparedInlineMessageWithContext(ctx context.Context, params
|
||||
}
|
||||
|
||||
// SavePreparedKeyboardButton holds parameters for the savePreparedKeyboardButton method.
|
||||
// Since: Bot API 8.0
|
||||
// See https://core.telegram.org/bots/api#savepreparedkeyboardbutton
|
||||
type SavePreparedKeyboardButton struct {
|
||||
UserID int64 `json:"user_id"`
|
||||
// UserID Required. Unique identifier of the target user that can use the button
|
||||
UserID int64 `json:"user_id"`
|
||||
// Button Required. A JSON-serialized object describing the button to be saved. The button must be of the
|
||||
// type request_users, request_chat, or request_managed_bot.
|
||||
Button KeyboardButton `json:"button"`
|
||||
}
|
||||
|
||||
// SavePreparedKeyboardButton stores a prepared keyboard button for Mini App users.
|
||||
// Since: Bot API 8.0
|
||||
// See https://core.telegram.org/bots/api#savepreparedkeyboardbutton
|
||||
func (api *API) SavePreparedKeyboardButton(params SavePreparedKeyboardButton) (PreparedKeyboardButton, error) {
|
||||
req := NewRequest[PreparedKeyboardButton]("savePreparedKeyboardButton", params)
|
||||
@@ -92,6 +124,7 @@ func (api *API) SavePreparedKeyboardButton(params SavePreparedKeyboardButton) (P
|
||||
}
|
||||
|
||||
// SavePreparedKeyboardButtonWithContext is the context-aware variant of SavePreparedKeyboardButton.
|
||||
// Since: Bot API 8.0
|
||||
// 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) {
|
||||
|
||||
+38
-5
@@ -1,32 +1,65 @@
|
||||
package tgapi
|
||||
|
||||
// InlineQueryResult is a JSON-serializable inline query result object.
|
||||
// Since: Bot API 1.7
|
||||
// See https://core.telegram.org/bots/api#inlinequeryresult
|
||||
type InlineQueryResult map[string]any
|
||||
|
||||
// InlineQueryResultsButton represents a button shown above inline query results.
|
||||
// Since: Bot API 6.3
|
||||
// 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"`
|
||||
// Text Label text on the button
|
||||
Text string `json:"text"`
|
||||
// WebApp Optional. Description of the Web App that will be launched when the user presses the button. The
|
||||
// Web App will be able to switch back to the inline mode using the method switchInlineQuery inside the Web
|
||||
// App.
|
||||
WebApp *WebAppInfo `json:"web_app,omitempty"`
|
||||
// StartParameter Optional. Deep-linking parameter for the /start message sent to the bot when a user
|
||||
// presses the button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed. Example: An inline bot that
|
||||
// sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results
|
||||
// accordingly. To do this, it displays a 'Connect your YouTube account' button above the results, or even
|
||||
// before showing any. The user presses the button, switches to a private chat with the bot and, in doing
|
||||
// so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer
|
||||
// a switch_inline button so that the user can easily return to the chat where they wanted to use the bot's
|
||||
// inline capabilities.
|
||||
StartParameter string `json:"start_parameter,omitempty"`
|
||||
}
|
||||
|
||||
// InputRichMessageContent represents the content of a rich message to be
|
||||
// sent as the result of an inline query. Use it as the input_message_content
|
||||
// value of an InlineQueryResult.
|
||||
// Since: Bot API 10.1
|
||||
// See https://core.telegram.org/bots/api#inputrichmessagecontent
|
||||
type InputRichMessageContent struct {
|
||||
// RichMessage contains structured rich-message content.
|
||||
RichMessage InputRichMessage `json:"rich_message"`
|
||||
}
|
||||
|
||||
// SentWebAppMessage describes an inline message sent by a Web App on behalf of a user.
|
||||
// Since: Bot API 8.0
|
||||
// See https://core.telegram.org/bots/api#sentwebappmessage
|
||||
type SentWebAppMessage struct {
|
||||
// InlineMessageID Optional. Identifier of the sent inline message. Available only if there is an inline
|
||||
// keyboard attached to the message.
|
||||
InlineMessageID string `json:"inline_message_id,omitempty"`
|
||||
}
|
||||
|
||||
// PreparedInlineMessage describes a prepared inline message.
|
||||
// Since: Bot API 8.0
|
||||
// See https://core.telegram.org/bots/api#preparedinlinemessage
|
||||
type PreparedInlineMessage struct {
|
||||
ID string `json:"id"`
|
||||
ExpirationDate int `json:"expiration_date"`
|
||||
// ID Unique identifier of the prepared message
|
||||
ID string `json:"id"`
|
||||
// ExpirationDate Expiration date of the prepared message, in Unix time. Expired prepared messages can no
|
||||
// longer be used.
|
||||
ExpirationDate int `json:"expiration_date"`
|
||||
}
|
||||
|
||||
// PreparedKeyboardButton describes a prepared keyboard button.
|
||||
// Since: Bot API 8.0
|
||||
// See https://core.telegram.org/bots/api#preparedkeyboardbutton
|
||||
type PreparedKeyboardButton struct {
|
||||
// ID Unique identifier of the keyboard button
|
||||
ID string `json:"id"`
|
||||
}
|
||||
|
||||
@@ -0,0 +1,86 @@
|
||||
package tgapi
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"net/url"
|
||||
"strings"
|
||||
)
|
||||
|
||||
const redactedLogValue = "<REDACTED>"
|
||||
|
||||
var sensitiveLogFields = map[string]struct{}{
|
||||
"callback_data": {},
|
||||
"credentials": {},
|
||||
"data": {},
|
||||
"invoice_payload": {},
|
||||
"payload": {},
|
||||
"provider_data": {},
|
||||
"provider_token": {},
|
||||
"secret": {},
|
||||
"secret_token": {},
|
||||
"token": {},
|
||||
"web_app_query_id": {},
|
||||
}
|
||||
|
||||
func redactRequestLog(data []byte) string {
|
||||
var value any
|
||||
if err := json.Unmarshal(data, &value); err != nil {
|
||||
return fmt.Sprintf("<invalid JSON omitted: %d bytes>", len(data))
|
||||
}
|
||||
redactLogValue(value)
|
||||
redacted, err := json.Marshal(value)
|
||||
if err != nil {
|
||||
return fmt.Sprintf("<unavailable JSON omitted: %d bytes>", len(data))
|
||||
}
|
||||
return string(redacted)
|
||||
}
|
||||
|
||||
func redactLogValue(value any) {
|
||||
switch value := value.(type) {
|
||||
case map[string]any:
|
||||
for key, item := range value {
|
||||
if _, sensitive := sensitiveLogFields[strings.ToLower(key)]; sensitive {
|
||||
value[key] = redactedLogValue
|
||||
continue
|
||||
}
|
||||
redactLogValue(item)
|
||||
}
|
||||
case []any:
|
||||
for _, item := range value {
|
||||
redactLogValue(item)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func responseLogSummary(method string, size int) string {
|
||||
return fmt.Sprintf("method=%s bytes=%d body=omitted", method, size)
|
||||
}
|
||||
|
||||
type redactedError struct {
|
||||
err error
|
||||
secret string
|
||||
}
|
||||
|
||||
func (e *redactedError) Error() string {
|
||||
return strings.ReplaceAll(e.err.Error(), e.secret, redactedLogValue)
|
||||
}
|
||||
|
||||
func (e *redactedError) Unwrap() error { return e.err }
|
||||
|
||||
func redactHTTPError(err error, token string) error {
|
||||
if err == nil || token == "" || !strings.Contains(err.Error(), token) {
|
||||
return err
|
||||
}
|
||||
|
||||
var urlErr *url.Error
|
||||
if !errors.As(err, &urlErr) {
|
||||
return &redactedError{err: err, secret: token}
|
||||
}
|
||||
|
||||
redactedURL := *urlErr
|
||||
redactedURL.URL = strings.ReplaceAll(redactedURL.URL, token, redactedLogValue)
|
||||
redactedURL.Err = &redactedError{err: urlErr.Err, secret: token}
|
||||
return &redactedURL
|
||||
}
|
||||
@@ -0,0 +1,68 @@
|
||||
package tgapi
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"net/url"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestRedactRequestLogRemovesSensitiveValues(t *testing.T) {
|
||||
const input = `{"secret_token":"webhook-secret","provider_token":"payment-token","nested":{"data":"passport-data","callback_data":"callback-secret"},"chat_id":42}`
|
||||
got := redactRequestLog([]byte(input))
|
||||
|
||||
for _, secret := range []string{"webhook-secret", "payment-token", "passport-data", "callback-secret"} {
|
||||
if strings.Contains(got, secret) {
|
||||
t.Errorf("redacted request contains %q: %s", secret, got)
|
||||
}
|
||||
}
|
||||
if !strings.Contains(got, `"chat_id":42`) {
|
||||
t.Errorf("redacted request lost non-sensitive field: %s", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRedactRequestLogOmitsInvalidJSON(t *testing.T) {
|
||||
const secret = "not-json-secret"
|
||||
got := redactRequestLog([]byte(secret))
|
||||
if strings.Contains(got, secret) {
|
||||
t.Fatalf("invalid JSON was logged verbatim: %s", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestResponseLogSummaryNeverContainsBody(t *testing.T) {
|
||||
const token = "managed-bot-token"
|
||||
got := responseLogSummary("getManagedBotToken", len(token))
|
||||
if strings.Contains(got, token) {
|
||||
t.Fatalf("response summary contains response body: %s", got)
|
||||
}
|
||||
if !strings.Contains(got, "body=omitted") {
|
||||
t.Fatalf("response summary does not explain omission: %s", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRedactHTTPErrorRemovesTokenAndPreservesCause(t *testing.T) {
|
||||
const token = "123456:secret-token"
|
||||
cause := errors.New("transport failed")
|
||||
original := &url.Error{
|
||||
Op: "Post",
|
||||
URL: "https://api.telegram.org/bot" + token + "/sendMessage",
|
||||
Err: fmt.Errorf("request for %s failed: %w", token, cause),
|
||||
}
|
||||
|
||||
got := redactHTTPError(original, token)
|
||||
if strings.Contains(got.Error(), token) {
|
||||
t.Fatalf("redacted HTTP error contains bot token: %v", got)
|
||||
}
|
||||
if !errors.Is(got, cause) {
|
||||
t.Fatalf("redacted HTTP error lost its cause: %v", got)
|
||||
}
|
||||
|
||||
var gotURLError *url.Error
|
||||
if !errors.As(got, &gotURLError) {
|
||||
t.Fatalf("redacted HTTP error lost url.Error type: %T", got)
|
||||
}
|
||||
if strings.Contains(gotURLError.Error(), token) {
|
||||
t.Fatalf("redacted url.Error contains bot token: %v", gotURLError)
|
||||
}
|
||||
}
|
||||
+1119
-228
File diff suppressed because it is too large
Load Diff
+902
-278
File diff suppressed because it is too large
Load Diff
+85
-15
@@ -4,6 +4,7 @@ import (
|
||||
"context"
|
||||
"fmt"
|
||||
"io"
|
||||
"math"
|
||||
"net/http"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||
@@ -12,9 +13,24 @@ import (
|
||||
// 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"`
|
||||
// Offset Optional. Identifier of the first update to be returned. Must be greater by one than the highest
|
||||
// among the identifiers of previously received updates. By default, updates starting with the earliest
|
||||
// unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with
|
||||
// an offset higher than its update_id. The negative offset can be specified to retrieve updates starting
|
||||
// from -offset update from the end of the updates queue. All previous updates will be forgotten.
|
||||
Offset *int `json:"offset,omitempty"`
|
||||
// Limit Optional. Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults
|
||||
// to 100.
|
||||
Limit *int `json:"limit,omitempty"`
|
||||
// Timeout Optional. Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be
|
||||
// positive, short polling should be used for testing purposes only.
|
||||
Timeout *int `json:"timeout,omitempty"`
|
||||
// AllowedUpdates Optional. A JSON-serialized list of the update types you want your bot to receive. For
|
||||
// example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these
|
||||
// types. See Update for a complete list of available update types. Specify an empty list to receive all
|
||||
// update types except chat_member, message_reaction, and message_reaction_count (default). If not
|
||||
// specified, the previous setting will be used. Please note that this parameter doesn't affect updates
|
||||
// created before the call to getUpdates, so unwanted updates may be received for a short period of time.
|
||||
AllowedUpdates []UpdateType `json:"allowed_updates,omitempty"`
|
||||
}
|
||||
|
||||
@@ -36,6 +52,7 @@ func (api *API) GetMeWithContext(ctx context.Context) (User, error) {
|
||||
// GetManagedBotToken holds parameters for the getManagedBotToken method.
|
||||
// See https://core.telegram.org/bots/api#getmanagedbottoken
|
||||
type GetManagedBotToken struct {
|
||||
// UserID Required. User identifier of the managed bot whose token will be returned
|
||||
UserID int64 `json:"user_id"`
|
||||
}
|
||||
|
||||
@@ -57,6 +74,7 @@ func (api *API) GetManagedBotTokenWithContext(ctx context.Context, params GetMan
|
||||
// ReplaceManagedBotToken holds parameters for the replaceManagedBotToken method.
|
||||
// See https://core.telegram.org/bots/api#replacemanagedbottoken
|
||||
type ReplaceManagedBotToken struct {
|
||||
// UserID Required. User identifier of the managed bot whose token will be replaced
|
||||
UserID int64 `json:"user_id"`
|
||||
}
|
||||
|
||||
@@ -79,7 +97,7 @@ func (api *API) ReplaceManagedBotTokenWithContext(ctx context.Context, params Re
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#logout
|
||||
func (api *API) LogOut() (bool, error) {
|
||||
req := NewRequest[bool, EmptyParams]("logOut", NoParams)
|
||||
req := NewRequest[bool]("logOut", NoParams)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
@@ -87,7 +105,7 @@ func (api *API) LogOut() (bool, error) {
|
||||
// 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)
|
||||
req := NewRequest[bool]("logOut", NoParams)
|
||||
return req.DoWithContext(ctx, api)
|
||||
}
|
||||
|
||||
@@ -95,7 +113,7 @@ func (api *API) LogOutWithContext(ctx context.Context) (bool, error) {
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#close
|
||||
func (api *API) CloseRemote() (bool, error) {
|
||||
req := NewRequest[bool, EmptyParams]("close", NoParams)
|
||||
req := NewRequest[bool]("close", NoParams)
|
||||
return req.Do(api)
|
||||
}
|
||||
|
||||
@@ -103,7 +121,7 @@ func (api *API) CloseRemote() (bool, error) {
|
||||
// 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)
|
||||
req := NewRequest[bool]("close", NoParams)
|
||||
return req.DoWithContext(ctx, api)
|
||||
}
|
||||
|
||||
@@ -126,12 +144,29 @@ func (api *API) GetUpdatesWithContext(ctx context.Context, params UpdateParams)
|
||||
// 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"`
|
||||
// URL Required. HTTPS URL to send updates to. Use an empty string to remove webhook integration.
|
||||
URL string `json:"url"`
|
||||
// IPAddress Optional. The fixed IP address which will be used to send webhook requests instead of the IP
|
||||
// address resolved through DNS
|
||||
IPAddress string `json:"ip_address,omitempty"`
|
||||
// MaxConnections Optional. The maximum allowed number of simultaneous HTTPS connections to the webhook for
|
||||
// update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and
|
||||
// higher values to increase your bot's throughput.
|
||||
MaxConnections int8 `json:"max_connections,omitempty"`
|
||||
// AllowedUpdates Optional. A JSON-serialized list of the update types you want your bot to receive. For
|
||||
// example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these
|
||||
// types. See Update for a complete list of available update types. Specify an empty list to receive all
|
||||
// update types except chat_member, message_reaction, and message_reaction_count (default). If not
|
||||
// specified, the previous setting will be used. Please note that this parameter doesn't affect updates
|
||||
// created before the call to the setWebhook, so unwanted updates may be received for a short period of
|
||||
// time.
|
||||
AllowedUpdates []UpdateType `json:"allowed_updates,omitempty"`
|
||||
// DropPendingUpdates Optional. Pass True to drop all pending updates
|
||||
DropPendingUpdates bool `json:"drop_pending_updates,omitempty"`
|
||||
// SecretToken Optional. A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in
|
||||
// every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header
|
||||
// is useful to ensure that the request comes from a webhook set by you.
|
||||
SecretToken string `json:"secret_token,omitempty"`
|
||||
}
|
||||
|
||||
// SetWebhook sets a webhook URL for incoming updates.
|
||||
@@ -155,6 +190,7 @@ func (api *API) SetWebhookWithContext(ctx context.Context, params SetWebhook) (b
|
||||
// DeleteWebhook holds parameters for the deleteWebhook method.
|
||||
// See https://core.telegram.org/bots/api#deletewebhook
|
||||
type DeleteWebhook struct {
|
||||
// DropPendingUpdates Optional. Pass True to drop all pending updates
|
||||
DropPendingUpdates bool `json:"drop_pending_updates,omitempty"`
|
||||
}
|
||||
|
||||
@@ -192,6 +228,7 @@ func (api *API) GetWebhookInfoWithContext(ctx context.Context) (WebhookInfo, err
|
||||
// GetFile holds parameters for the getFile method.
|
||||
// See https://core.telegram.org/bots/api#getfile
|
||||
type GetFile struct {
|
||||
// FileID Required. File identifier to get information about
|
||||
FileID string `json:"file_id"`
|
||||
}
|
||||
|
||||
@@ -213,6 +250,8 @@ func (api *API) GetFileWithContext(ctx context.Context, params GetFile) (File, e
|
||||
// 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.
|
||||
// This unbounded helper is retained for v1 compatibility and is subject to change in v2;
|
||||
// prefer GetFileByLinkLimit for untrusted or potentially large files.
|
||||
// See https://core.telegram.org/bots/api#file
|
||||
func (api *API) GetFileByLink(link string) ([]byte, error) {
|
||||
return api.getFileByLink(context.Background(), link)
|
||||
@@ -226,6 +265,37 @@ func (api *API) GetFileByLinkWithContext(ctx context.Context, link string) ([]by
|
||||
return api.getFileByLink(ctx, link)
|
||||
}
|
||||
|
||||
// GetFileByLinkLimit downloads at most maxBytes from Telegram's file server.
|
||||
// It returns ErrFileTooLarge when the response exceeds the limit.
|
||||
func (api *API) GetFileByLinkLimit(link string, maxBytes int64) ([]byte, error) {
|
||||
return api.GetFileByLinkLimitWithContext(context.Background(), link, maxBytes)
|
||||
}
|
||||
|
||||
// GetFileByLinkLimitWithContext is the context-aware variant of GetFileByLinkLimit.
|
||||
func (api *API) GetFileByLinkLimitWithContext(ctx context.Context, link string, maxBytes int64) ([]byte, error) {
|
||||
if maxBytes < 0 {
|
||||
return nil, fmt.Errorf("maximum file size must not be negative: %d", maxBytes)
|
||||
}
|
||||
body, err := api.openFileByLink(ctx, link)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer func() { _ = body.Close() }()
|
||||
|
||||
readLimit := maxBytes
|
||||
if readLimit < math.MaxInt64 {
|
||||
readLimit++
|
||||
}
|
||||
data, err := io.ReadAll(io.LimitReader(body, readLimit))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if int64(len(data)) > maxBytes {
|
||||
return nil, ErrFileTooLarge
|
||||
}
|
||||
return data, nil
|
||||
}
|
||||
|
||||
// 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
|
||||
@@ -256,7 +326,7 @@ func (api *API) openFileByLink(ctx context.Context, link string) (io.ReadCloser,
|
||||
if api.useTestServer {
|
||||
methodPrefix = "/test"
|
||||
}
|
||||
u := fmt.Sprintf("%s/file/bot%s%s/%s", api.apiUrl, api.token, methodPrefix, link)
|
||||
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 {
|
||||
@@ -266,7 +336,7 @@ func (api *API) openFileByLink(ctx context.Context, link string) (io.ReadCloser,
|
||||
|
||||
res, err := api.client.Do(req)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
return nil, redactHTTPError(err, api.token)
|
||||
}
|
||||
if res.StatusCode < http.StatusOK || res.StatusCode >= http.StatusMultipleChoices {
|
||||
defer func() {
|
||||
|
||||
+25
-5
@@ -2,6 +2,7 @@ package tgapi
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"io"
|
||||
"net/http"
|
||||
"strings"
|
||||
@@ -23,7 +24,7 @@ func TestGetFileByLinkUsesConfiguredAPIURL(t *testing.T) {
|
||||
|
||||
api := NewAPI(
|
||||
NewAPIOpts("token").
|
||||
SetAPIUrl("https://example.test").
|
||||
SetAPIURL("https://example.test").
|
||||
SetHTTPClient(client),
|
||||
)
|
||||
defer func() {
|
||||
@@ -47,7 +48,7 @@ func TestGetFileByLinkUsesConfiguredAPIURL(t *testing.T) {
|
||||
func TestOpenFileByLinkStreamsResponseBody(t *testing.T) {
|
||||
api := NewAPI(
|
||||
NewAPIOpts("token").
|
||||
SetAPIUrl("https://example.test").
|
||||
SetAPIURL("https://example.test").
|
||||
SetHTTPClient(&http.Client{
|
||||
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||
return &http.Response{
|
||||
@@ -94,7 +95,7 @@ func TestGetFileByLinkReturnsHTTPStatusError(t *testing.T) {
|
||||
|
||||
api := NewAPI(
|
||||
NewAPIOpts("token").
|
||||
SetAPIUrl("https://example.test").
|
||||
SetAPIURL("https://example.test").
|
||||
SetHTTPClient(client),
|
||||
)
|
||||
defer func() {
|
||||
@@ -109,6 +110,25 @@ func TestGetFileByLinkReturnsHTTPStatusError(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetFileByLinkLimitRejectsOversizedResponse(t *testing.T) {
|
||||
api := NewAPI(
|
||||
NewAPIOpts("token").
|
||||
SetAPIURL("https://example.test").
|
||||
SetHTTPClient(&http.Client{Transport: roundTripFunc(func(_ *http.Request) (*http.Response, error) {
|
||||
return &http.Response{
|
||||
StatusCode: http.StatusOK,
|
||||
Body: io.NopCloser(strings.NewReader("12345")),
|
||||
}, nil
|
||||
})}),
|
||||
)
|
||||
defer func() { _ = api.Close() }()
|
||||
|
||||
_, err := api.GetFileByLinkLimit("files/report.txt", 4)
|
||||
if !errors.Is(err, ErrFileTooLarge) {
|
||||
t.Fatalf("expected ErrFileTooLarge, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetUpdatesOmitsAllowedUpdatesWhenEmpty(t *testing.T) {
|
||||
var gotBody map[string]any
|
||||
|
||||
@@ -131,7 +151,7 @@ func TestGetUpdatesOmitsAllowedUpdatesWhenEmpty(t *testing.T) {
|
||||
|
||||
api := NewAPI(
|
||||
NewAPIOpts("token").
|
||||
SetAPIUrl("https://example.test").
|
||||
SetAPIURL("https://example.test").
|
||||
SetHTTPClient(client),
|
||||
)
|
||||
defer func() {
|
||||
@@ -174,7 +194,7 @@ func TestSetChatMenuButtonSendsStructuredMenuButton(t *testing.T) {
|
||||
|
||||
api := NewAPI(
|
||||
NewAPIOpts("token").
|
||||
SetAPIUrl("https://example.test").
|
||||
SetAPIURL("https://example.test").
|
||||
SetHTTPClient(client),
|
||||
)
|
||||
defer func() {
|
||||
|
||||
@@ -4,12 +4,12 @@ package tgapi
|
||||
type ParseMode string
|
||||
|
||||
const (
|
||||
// ParseMDV2 enables MarkdownV2 style parsing.
|
||||
ParseMDV2 ParseMode = "MarkdownV2"
|
||||
// ParseMarkdownV2 enables MarkdownV2 style parsing.
|
||||
ParseMarkdownV2 ParseMode = "MarkdownV2"
|
||||
// ParseHTML enables HTML style parsing.
|
||||
ParseHTML ParseMode = "HTML"
|
||||
// ParseMD enables legacy Markdown style parsing.
|
||||
ParseMD ParseMode = "Markdown"
|
||||
// ParseMarkdown enables legacy Markdown style parsing.
|
||||
ParseMarkdown ParseMode = "Markdown"
|
||||
// ParseNone disables parse_mode and leaves plain-text requests unannotated.
|
||||
ParseNone ParseMode = ""
|
||||
)
|
||||
|
||||
@@ -25,7 +25,7 @@ func TestParseModeStillSerializesExplicitModes(t *testing.T) {
|
||||
data, err := json.Marshal(SendMessage{
|
||||
ChatID: 42,
|
||||
Text: "hello",
|
||||
ParseMode: ParseMDV2,
|
||||
ParseMode: ParseMarkdownV2,
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("Marshal returned error: %v", err)
|
||||
|
||||
@@ -3,13 +3,17 @@ package tgapi
|
||||
import "context"
|
||||
|
||||
// SetPassportDataErrors holds parameters for the setPassportDataErrors method.
|
||||
// Since: Bot API 4.0
|
||||
// See https://core.telegram.org/bots/api#setpassportdataerrors
|
||||
type SetPassportDataErrors struct {
|
||||
UserID int64 `json:"user_id"`
|
||||
// UserID Required. User identifier
|
||||
UserID int64 `json:"user_id"`
|
||||
// Errors Required. A JSON-serialized Array describing the errors
|
||||
Errors []PassportElementError `json:"errors"`
|
||||
}
|
||||
|
||||
// SetPassportDataErrors informs a user about Telegram Passport data errors.
|
||||
// Since: Bot API 4.0
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#setpassportdataerrors
|
||||
func (api *API) SetPassportDataErrors(params SetPassportDataErrors) (bool, error) {
|
||||
@@ -18,6 +22,7 @@ func (api *API) SetPassportDataErrors(params SetPassportDataErrors) (bool, error
|
||||
}
|
||||
|
||||
// SetPassportDataErrorsWithContext is the context-aware variant of SetPassportDataErrors.
|
||||
// Since: Bot API 4.0
|
||||
// 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) {
|
||||
|
||||
+109
-33
@@ -1,64 +1,140 @@
|
||||
package tgapi
|
||||
|
||||
// PassportData contains information about Telegram Passport data shared with the bot.
|
||||
// Since: Bot API 4.0
|
||||
type PassportData struct {
|
||||
Data []EncryptedPassportElement `json:"data"`
|
||||
Credentials EncryptedCredentials `json:"credentials"`
|
||||
// Data Array with information about documents and other Telegram Passport elements that was shared with the
|
||||
// bot
|
||||
Data []EncryptedPassportElement `json:"data"`
|
||||
// Credentials Encrypted credentials required to decrypt the data
|
||||
Credentials EncryptedCredentials `json:"credentials"`
|
||||
}
|
||||
|
||||
// PassportFile represents a file uploaded to Telegram Passport.
|
||||
// Since: Bot API 4.0
|
||||
type PassportFile struct {
|
||||
FileID string `json:"file_id"`
|
||||
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||
FileID string `json:"file_id"`
|
||||
// FileUniqueID Unique identifier for this file, which is supposed to be the same over time and for
|
||||
// different bots. Can't be used to download or reuse the file.
|
||||
FileUniqueID string `json:"file_unique_id"`
|
||||
FileSize int64 `json:"file_size"`
|
||||
FileDate int64 `json:"file_date"`
|
||||
// FileSize File size in bytes
|
||||
FileSize int64 `json:"file_size"`
|
||||
// FileDate Unix time when the file was uploaded
|
||||
FileDate int64 `json:"file_date"`
|
||||
}
|
||||
|
||||
// PassportElementType represents the type of a Telegram Passport element.
|
||||
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"
|
||||
// PassportPersonalDetailsType identifies personal details.
|
||||
PassportPersonalDetailsType PassportElementType = "personal_details"
|
||||
// PassportPassportType identifies an international passport.
|
||||
PassportPassportType PassportElementType = "passport"
|
||||
// PassportDriverLicenseType identifies a driver license.
|
||||
PassportDriverLicenseType PassportElementType = "driver_license"
|
||||
// PassportIdentityCardType identifies an identity card.
|
||||
PassportIdentityCardType PassportElementType = "identity_card"
|
||||
// PassportInternalPassportType identifies an internal passport.
|
||||
PassportInternalPassportType PassportElementType = "internal_passport"
|
||||
// PassportAddressType identifies a residential address.
|
||||
PassportAddressType PassportElementType = "address"
|
||||
// PassportUtilityBillType identifies a utility bill.
|
||||
PassportUtilityBillType PassportElementType = "utility_bill"
|
||||
// PassportBankStatementType identifies a bank statement.
|
||||
PassportBankStatementType PassportElementType = "bank_statement"
|
||||
// PassportRentalAgreementType identifies a rental agreement.
|
||||
PassportRentalAgreementType PassportElementType = "rental_agreement"
|
||||
// PassportPassportRegistrationType identifies a passport registration.
|
||||
PassportPassportRegistrationType PassportElementType = "passport_registration"
|
||||
// PassportTemporaryRegistrationType identifies a temporary registration.
|
||||
PassportTemporaryRegistrationType PassportElementType = "temporary_registration"
|
||||
PassportPhoneNumberType PassportElementType = "phone_number"
|
||||
PassportEmailType PassportElementType = "email"
|
||||
// PassportPhoneNumberType identifies a phone number.
|
||||
PassportPhoneNumberType PassportElementType = "phone_number"
|
||||
// PassportEmailType identifies an email address.
|
||||
PassportEmailType PassportElementType = "email"
|
||||
)
|
||||
|
||||
// EncryptedPassportElement contains information about documents or other Telegram Passport elements.
|
||||
// Since: Bot API 4.0
|
||||
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 Element type. One of “personal_details”, “passport”, “driver_license”,
|
||||
// “identity_card”, “internal_passport”, “address”, “utility_bill”, “bank_statement”,
|
||||
// “rental_agreement”, “passport_registration”, “temporary_registration”, “phone_number”,
|
||||
// “email”.
|
||||
Type PassportElementType `json:"type"`
|
||||
// Data Optional. Base64-encoded encrypted Telegram Passport element data provided by the user; available
|
||||
// only for “personal_details”, “passport”, “driver_license”, “identity_card”,
|
||||
// “internal_passport” and “address” types. Can be decrypted and verified using the accompanying
|
||||
// EncryptedCredentials.
|
||||
Data string `json:"data,omitempty"`
|
||||
// PhoneNumber Optional. User's verified phone number; available only for “phone_number” type
|
||||
PhoneNumber string `json:"phone_number,omitempty"`
|
||||
// Email Optional. User's verified email address; available only for “email” type
|
||||
Email string `json:"email,omitempty"`
|
||||
// Files Optional. Array of encrypted files with documents provided by the user; available only for
|
||||
// “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and
|
||||
// “temporary_registration” types. Files can be decrypted and verified using the accompanying
|
||||
// EncryptedCredentials.
|
||||
Files []PassportFile `json:"files,omitempty"`
|
||||
// FrontSide Optional. Encrypted file with the front side of the document, provided by the user; available
|
||||
// only for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file
|
||||
// can be decrypted and verified using the accompanying EncryptedCredentials.
|
||||
FrontSide *PassportFile `json:"front_side,omitempty"`
|
||||
// ReverseSide Optional. Encrypted file with the reverse side of the document, provided by the user;
|
||||
// available only for “driver_license” and “identity_card”. The file can be decrypted and verified
|
||||
// using the accompanying EncryptedCredentials.
|
||||
ReverseSide *PassportFile `json:"reverse_side,omitempty"`
|
||||
// Selfie Optional. Encrypted file with the selfie of the user holding a document, provided by the user;
|
||||
// available if requested for “passport”, “driver_license”, “identity_card” and
|
||||
// “internal_passport”. The file can be decrypted and verified using the accompanying
|
||||
// EncryptedCredentials.
|
||||
Selfie *PassportFile `json:"selfie,omitempty"`
|
||||
// Translation Optional. Array of encrypted files with translated versions of documents provided by the
|
||||
// user; available if requested for “passport”, “driver_license”, “identity_card”,
|
||||
// “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”,
|
||||
// “passport_registration” and “temporary_registration” types. Files can be decrypted and verified
|
||||
// using the accompanying EncryptedCredentials.
|
||||
Translation *PassportFile `json:"translation,omitempty"`
|
||||
// Hash Base64-encoded element hash for using in PassportElementErrorUnspecified
|
||||
Hash string `json:"hash,omitempty"`
|
||||
}
|
||||
|
||||
// EncryptedCredentials contains data required for decrypting and authenticating EncryptedPassportElement.
|
||||
// Since: Bot API 4.0
|
||||
type EncryptedCredentials struct {
|
||||
Data string `json:"data"`
|
||||
Hash string `json:"hash"`
|
||||
// Data Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets
|
||||
// required for EncryptedPassportElement decryption and authentication
|
||||
Data string `json:"data"`
|
||||
// Hash Base64-encoded data hash for data authentication
|
||||
Hash string `json:"hash"`
|
||||
// Secret Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption
|
||||
Secret string `json:"secret"`
|
||||
}
|
||||
|
||||
// PassportElementError is a JSON-serializable passport element error object.
|
||||
// Since: Bot API 4.0
|
||||
// See https://core.telegram.org/bots/api#passportelementerror
|
||||
type PassportElementError struct {
|
||||
Source string `json:"source"`
|
||||
Type PassportElementType `json:"type"`
|
||||
// Source identifies the source of the passport validation error.
|
||||
Source string `json:"source"`
|
||||
// Type identifies the Telegram Passport element type with the error.
|
||||
Type PassportElementType `json:"type"`
|
||||
|
||||
// FieldName Name of the data field which has the error
|
||||
FieldName string `json:"field_name,omitempty"`
|
||||
DataHash string `json:"data_hash,omitempty"`
|
||||
// DataHash Base64-encoded data hash
|
||||
DataHash string `json:"data_hash,omitempty"`
|
||||
|
||||
FileHash string `json:"file_hash,omitempty"`
|
||||
// FileHash is the base64-encoded hash of the file that contains the error.
|
||||
FileHash string `json:"file_hash,omitempty"`
|
||||
// FileHashes List of base64-encoded file hashes
|
||||
FileHashes []string `json:"file_hashes,omitempty"`
|
||||
|
||||
// ElementHash Base64-encoded element hash
|
||||
ElementHash string `json:"element_hash,omitempty"`
|
||||
|
||||
// Message Error message
|
||||
Message string `json:"message"`
|
||||
}
|
||||
|
||||
+193
-56
@@ -3,45 +3,111 @@ package tgapi
|
||||
import "context"
|
||||
|
||||
// SendInvoice holds parameters for the sendInvoice method.
|
||||
// Since: Bot API 3.0
|
||||
// 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"`
|
||||
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||
// channel in the format @username
|
||||
ChatID int64 `json:"chat_id"`
|
||||
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||
// supergroups and private chats of bots with forum topic mode enabled only
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||
// sent; required if the message is sent to a direct messages chat
|
||||
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"`
|
||||
// Title Required. Product name, 1-32 characters
|
||||
Title string `json:"title"`
|
||||
// Description Required. Product description, 1-255 characters
|
||||
Description string `json:"description"`
|
||||
// Payload Required. Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use
|
||||
// it for your internal processes.
|
||||
Payload string `json:"payload"`
|
||||
// ProviderToken Optional. Payment provider token, obtained via @BotFather. Pass an empty string for
|
||||
// payments in Telegram Stars.
|
||||
ProviderToken string `json:"provider_token,omitempty"`
|
||||
// Currency Required. Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for
|
||||
// payments in Telegram Stars.
|
||||
Currency string `json:"currency"`
|
||||
// Prices Required. Price breakdown, a JSON-serialized list of components (e.g. product price, tax,
|
||||
// discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in
|
||||
// Telegram Stars.
|
||||
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"`
|
||||
// MaxTipAmount Optional. The maximum accepted amount for tips in the smallest units of the currency
|
||||
// (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See
|
||||
// the exp parameter in currencies.json, it shows the number of digits past the decimal point for each
|
||||
// currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars.
|
||||
MaxTipAmount int `json:"max_tip_amount,omitempty"`
|
||||
// SuggestedTipAmounts Optional. A JSON-serialized Array of suggested amounts of tips in the smallest units
|
||||
// of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The
|
||||
// suggested tip amounts must be positive, passed in a strictly increased order and must not exceed
|
||||
// max_tip_amount.
|
||||
SuggestedTipAmounts []int `json:"suggested_tip_amounts,omitempty"`
|
||||
// StartParameter Optional. Unique deep-linking parameter. If left empty, forwarded copies of the sent
|
||||
// message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using
|
||||
// the same invoice. If non-empty, forwarded copies of the sent message will have a URL button with a deep
|
||||
// link to the bot (instead of a Pay button), with the value used as the start parameter.
|
||||
StartParameter string `json:"start_parameter,omitempty"`
|
||||
// ProviderData Optional. JSON-serialized data about the invoice, which will be shared with the payment
|
||||
// provider. A detailed description of required fields should be provided by the payment provider.
|
||||
ProviderData string `json:"provider_data,omitempty"`
|
||||
// PhotoURL Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing
|
||||
// image for a service. People like it better when they see what they are paying for.
|
||||
PhotoURL string `json:"photo_url,omitempty"`
|
||||
// PhotoSize Optional. Photo size in bytes
|
||||
PhotoSize int `json:"photo_size,omitempty"`
|
||||
// PhotoWidth Optional. Photo width
|
||||
PhotoWidth int `json:"photo_width,omitempty"`
|
||||
// PhotoHeight Optional. Photo height
|
||||
PhotoHeight int `json:"photo_height,omitempty"`
|
||||
// NeedName Optional. Pass True if you require the user's full name to complete the order. Ignored for
|
||||
// payments in Telegram Stars.
|
||||
NeedName bool `json:"need_name,omitempty"`
|
||||
// NeedPhoneNumber Optional. Pass True if you require the user's phone number to complete the order. Ignored
|
||||
// for payments in Telegram Stars.
|
||||
NeedPhoneNumber bool `json:"need_phone_number,omitempty"`
|
||||
// NeedEmail Optional. Pass True if you require the user's email address to complete the order. Ignored for
|
||||
// payments in Telegram Stars.
|
||||
NeedEmail bool `json:"need_email,omitempty"`
|
||||
// NeedShippingAddress Optional. Pass True if you require the user's shipping address to complete the order.
|
||||
// Ignored for payments in Telegram Stars.
|
||||
NeedShippingAddress bool `json:"need_shipping_address,omitempty"`
|
||||
// SendPhoneToProvider Optional. Pass True if the user's phone number should be sent to the provider.
|
||||
// Ignored for payments in Telegram Stars.
|
||||
SendPhoneToProvider bool `json:"send_phone_number_to_provider,omitempty"`
|
||||
// SendEmailToProvider Optional. Pass True if the user's email address should be sent to the provider.
|
||||
// Ignored for payments in Telegram Stars.
|
||||
SendEmailToProvider bool `json:"send_email_to_provider,omitempty"`
|
||||
// IsFlexible Optional. Pass True if the final price depends on the shipping method. Ignored for payments in
|
||||
// Telegram Stars.
|
||||
IsFlexible bool `json:"is_flexible,omitempty"`
|
||||
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||
// sound.
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||
// balance.
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||
// chats only
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
|
||||
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||
// post, then that suggested post is automatically declined.
|
||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
// ReplyMarkup Optional. A JSON-serialized object for an inline keyboard. If empty, one 'Pay total price'
|
||||
// button will be shown. If not empty, the first button must be a Pay button.
|
||||
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendInvoice sends an invoice.
|
||||
// Since: Bot API 3.0
|
||||
// See https://core.telegram.org/bots/api#sendinvoice
|
||||
func (api *API) SendInvoice(params SendInvoice) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendInvoice", params, params.ChatID)
|
||||
@@ -49,6 +115,7 @@ func (api *API) SendInvoice(params SendInvoice) (Message, error) {
|
||||
}
|
||||
|
||||
// SendInvoiceWithContext is the context-aware variant of SendInvoice.
|
||||
// Since: Bot API 3.0
|
||||
// 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) {
|
||||
@@ -57,35 +124,84 @@ func (api *API) SendInvoiceWithContext(ctx context.Context, params SendInvoice)
|
||||
}
|
||||
|
||||
// CreateInvoiceLink holds parameters for the createInvoiceLink method.
|
||||
// Since: Bot API 6.1
|
||||
// See https://core.telegram.org/bots/api#createinvoicelink
|
||||
type CreateInvoiceLink struct {
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the link
|
||||
// will be created. For payments in Telegram Stars only.
|
||||
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"`
|
||||
// Title Required. Product name, 1-32 characters
|
||||
Title string `json:"title"`
|
||||
// Description Required. Product description, 1-255 characters
|
||||
Description string `json:"description"`
|
||||
// Payload Required. Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use
|
||||
// it for your internal processes.
|
||||
Payload string `json:"payload"`
|
||||
// ProviderToken Optional. Payment provider token, obtained via @BotFather. Pass an empty string for
|
||||
// payments in Telegram Stars.
|
||||
ProviderToken string `json:"provider_token,omitempty"`
|
||||
// Currency Required. Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for
|
||||
// payments in Telegram Stars.
|
||||
Currency string `json:"currency"`
|
||||
// Prices Required. Price breakdown, a JSON-serialized list of components (e.g. product price, tax,
|
||||
// discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in
|
||||
// Telegram Stars.
|
||||
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"`
|
||||
// SubscriptionPeriod Optional. The number of seconds the subscription will be active for before the next
|
||||
// payment. The currency must be set to “XTR” (Telegram Stars) if the parameter is used. Currently, it
|
||||
// must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot
|
||||
// at the same time, including multiple concurrent subscriptions from the same user. Subscription price must
|
||||
// no exceed 10000 Telegram Stars.
|
||||
SubscriptionPeriod int `json:"subscription_period,omitempty"`
|
||||
// MaxTipAmount Optional. The maximum accepted amount for tips in the smallest units of the currency
|
||||
// (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See
|
||||
// the exp parameter in currencies.json, it shows the number of digits past the decimal point for each
|
||||
// currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars.
|
||||
MaxTipAmount int `json:"max_tip_amount,omitempty"`
|
||||
// SuggestedTipAmounts Optional. A JSON-serialized Array of suggested amounts of tips in the smallest units
|
||||
// of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The
|
||||
// suggested tip amounts must be positive, passed in a strictly increased order and must not exceed
|
||||
// max_tip_amount.
|
||||
SuggestedTipAmounts []int `json:"suggested_tip_amounts,omitempty"`
|
||||
// ProviderData Optional. JSON-serialized data about the invoice, which will be shared with the payment
|
||||
// provider. A detailed description of required fields should be provided by the payment provider.
|
||||
ProviderData string `json:"provider_data,omitempty"`
|
||||
// PhotoURL Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing
|
||||
// image for a service.
|
||||
PhotoURL string `json:"photo_url,omitempty"`
|
||||
// PhotoSize Optional. Photo size in bytes
|
||||
PhotoSize int `json:"photo_size,omitempty"`
|
||||
// PhotoWidth Optional. Photo width
|
||||
PhotoWidth int `json:"photo_width,omitempty"`
|
||||
// PhotoHeight Optional. Photo height
|
||||
PhotoHeight int `json:"photo_height,omitempty"`
|
||||
// NeedName Optional. Pass True if you require the user's full name to complete the order. Ignored for
|
||||
// payments in Telegram Stars.
|
||||
NeedName bool `json:"need_name,omitempty"`
|
||||
// NeedPhoneNumber Optional. Pass True if you require the user's phone number to complete the order. Ignored
|
||||
// for payments in Telegram Stars.
|
||||
NeedPhoneNumber bool `json:"need_phone_number,omitempty"`
|
||||
// NeedEmail Optional. Pass True if you require the user's email address to complete the order. Ignored for
|
||||
// payments in Telegram Stars.
|
||||
NeedEmail bool `json:"need_email,omitempty"`
|
||||
// NeedShippingAddress Optional. Pass True if you require the user's shipping address to complete the order.
|
||||
// Ignored for payments in Telegram Stars.
|
||||
NeedShippingAddress bool `json:"need_shipping_address,omitempty"`
|
||||
// SendPhoneToProvider Optional. Pass True if the user's phone number should be sent to the provider.
|
||||
// Ignored for payments in Telegram Stars.
|
||||
SendPhoneToProvider bool `json:"send_phone_number_to_provider,omitempty"`
|
||||
// SendEmailToProvider Optional. Pass True if the user's email address should be sent to the provider.
|
||||
// Ignored for payments in Telegram Stars.
|
||||
SendEmailToProvider bool `json:"send_email_to_provider,omitempty"`
|
||||
// IsFlexible Optional. Pass True if the final price depends on the shipping method. Ignored for payments in
|
||||
// Telegram Stars.
|
||||
IsFlexible bool `json:"is_flexible,omitempty"`
|
||||
}
|
||||
|
||||
// CreateInvoiceLink creates an invoice link.
|
||||
// Since: Bot API 6.1
|
||||
// See https://core.telegram.org/bots/api#createinvoicelink
|
||||
func (api *API) CreateInvoiceLink(params CreateInvoiceLink) (string, error) {
|
||||
req := NewRequest[string]("createInvoiceLink", params)
|
||||
@@ -93,6 +209,7 @@ func (api *API) CreateInvoiceLink(params CreateInvoiceLink) (string, error) {
|
||||
}
|
||||
|
||||
// CreateInvoiceLinkWithContext is the context-aware variant of CreateInvoiceLink.
|
||||
// Since: Bot API 6.1
|
||||
// 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) {
|
||||
@@ -101,15 +218,24 @@ func (api *API) CreateInvoiceLinkWithContext(ctx context.Context, params CreateI
|
||||
}
|
||||
|
||||
// AnswerShippingQuery holds parameters for the answerShippingQuery method.
|
||||
// Since: Bot API 3.0
|
||||
// See https://core.telegram.org/bots/api#answershippingquery
|
||||
type AnswerShippingQuery struct {
|
||||
ShippingQueryID string `json:"shipping_query_id"`
|
||||
OK bool `json:"ok"`
|
||||
// ShippingQueryID Required. Unique identifier for the query to be answered
|
||||
ShippingQueryID string `json:"shipping_query_id"`
|
||||
// OK Required. Pass True if delivery to the specified address is possible and False if there are any
|
||||
// problems (for example, if delivery to the specified address is not possible)
|
||||
OK bool `json:"ok"`
|
||||
// ShippingOptions Optional. Required if ok is True. A JSON-serialized Array of available shipping options.
|
||||
ShippingOptions []ShippingOption `json:"shipping_options,omitempty"`
|
||||
ErrorMessage string `json:"error_message,omitempty"`
|
||||
// ErrorMessage Optional. Required if ok is False. Error message in human readable form that explains why it
|
||||
// is impossible to complete the order (e.g. “Sorry, delivery to your desired address is unavailable”).
|
||||
// Telegram will display this message to the user.
|
||||
ErrorMessage string `json:"error_message,omitempty"`
|
||||
}
|
||||
|
||||
// AnswerShippingQuery answers a shipping query.
|
||||
// Since: Bot API 3.0
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#answershippingquery
|
||||
func (api *API) AnswerShippingQuery(params AnswerShippingQuery) (bool, error) {
|
||||
@@ -118,6 +244,7 @@ func (api *API) AnswerShippingQuery(params AnswerShippingQuery) (bool, error) {
|
||||
}
|
||||
|
||||
// AnswerShippingQueryWithContext is the context-aware variant of AnswerShippingQuery.
|
||||
// Since: Bot API 3.0
|
||||
// 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) {
|
||||
@@ -126,14 +253,23 @@ func (api *API) AnswerShippingQueryWithContext(ctx context.Context, params Answe
|
||||
}
|
||||
|
||||
// AnswerPreCheckoutQuery holds parameters for the answerPreCheckoutQuery method.
|
||||
// Since: Bot API 3.0
|
||||
// See https://core.telegram.org/bots/api#answerprecheckoutquery
|
||||
type AnswerPreCheckoutQuery struct {
|
||||
// PreCheckoutQueryID Required. Unique identifier for the query to be answered
|
||||
PreCheckoutQueryID string `json:"pre_checkout_query_id"`
|
||||
OK bool `json:"ok"`
|
||||
ErrorMessage string `json:"error_message,omitempty"`
|
||||
// OK Required. Specify True if everything is alright (goods are available, etc.) and the bot is ready to
|
||||
// proceed with the order. Use False if there are any problems.
|
||||
OK bool `json:"ok"`
|
||||
// ErrorMessage Optional. Required if ok is False. Error message in human readable form that explains the
|
||||
// reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our
|
||||
// amazing black T-shirts while you were busy filling out your payment details. Please choose a different
|
||||
// color or garment!"). Telegram will display this message to the user.
|
||||
ErrorMessage string `json:"error_message,omitempty"`
|
||||
}
|
||||
|
||||
// AnswerPreCheckoutQuery answers a pre-checkout query.
|
||||
// Since: Bot API 3.0
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#answerprecheckoutquery
|
||||
func (api *API) AnswerPreCheckoutQuery(params AnswerPreCheckoutQuery) (bool, error) {
|
||||
@@ -142,6 +278,7 @@ func (api *API) AnswerPreCheckoutQuery(params AnswerPreCheckoutQuery) (bool, err
|
||||
}
|
||||
|
||||
// AnswerPreCheckoutQueryWithContext is the context-aware variant of AnswerPreCheckoutQuery.
|
||||
// Since: Bot API 3.0
|
||||
// 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) {
|
||||
|
||||
+109
-36
@@ -1,96 +1,169 @@
|
||||
package tgapi
|
||||
|
||||
// LabeledPrice represents a price portion.
|
||||
// Since: Bot API 3.0
|
||||
// See https://core.telegram.org/bots/api#labeledprice
|
||||
type LabeledPrice struct {
|
||||
Label string `json:"label"`
|
||||
Amount int `json:"amount"`
|
||||
// Label Portion label
|
||||
Label string `json:"label"`
|
||||
// Amount Price of the product in the smallest units of the currency (integer, not float/double). For
|
||||
// example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows
|
||||
// the number of digits past the decimal point for each currency (2 for the majority of currencies).
|
||||
Amount int `json:"amount"`
|
||||
}
|
||||
|
||||
// Invoice contains basic information about an invoice.
|
||||
// Since: Bot API 3.0
|
||||
type Invoice struct {
|
||||
Title string `json:"title"`
|
||||
Description string `json:"description"`
|
||||
// Title Product name
|
||||
Title string `json:"title"`
|
||||
// Description Product description
|
||||
Description string `json:"description"`
|
||||
// StartParameter Unique bot deep-linking parameter that can be used to generate this invoice
|
||||
StartParameter string `json:"start_parameter"`
|
||||
Currency string `json:"currency"`
|
||||
TotalAmount int `json:"total_amount"`
|
||||
// Currency Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars
|
||||
Currency string `json:"currency"`
|
||||
// TotalAmount Total price in the smallest units of the currency (integer, not float/double). For example,
|
||||
// for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number
|
||||
// of digits past the decimal point for each currency (2 for the majority of currencies).
|
||||
TotalAmount int `json:"total_amount"`
|
||||
}
|
||||
|
||||
// ShippingQuery represents an incoming shipping query.
|
||||
// Since: Bot API 3.0
|
||||
// See https://core.telegram.org/bots/api#shippingquery
|
||||
type ShippingQuery struct {
|
||||
ID string `json:"id"`
|
||||
From User `json:"from"`
|
||||
InvoicePayload string `json:"invoice_payload"`
|
||||
// ID Unique query identifier
|
||||
ID string `json:"id"`
|
||||
// From User who sent the query
|
||||
From User `json:"from"`
|
||||
// InvoicePayload Bot-specified invoice payload
|
||||
InvoicePayload string `json:"invoice_payload"`
|
||||
// ShippingAddress User specified shipping address
|
||||
ShippingAddress ShippingAddress `json:"shipping_address"`
|
||||
}
|
||||
|
||||
// ShippingAddress represents a shipping address.
|
||||
// Since: Bot API 3.0
|
||||
// See https://core.telegram.org/bots/api#shippingaddress
|
||||
type ShippingAddress struct {
|
||||
// CountryCode Two-letter ISO 3166-1 alpha-2 country code
|
||||
CountryCode string `json:"country_code"`
|
||||
State string `json:"state"`
|
||||
City string `json:"city"`
|
||||
// State State, if applicable
|
||||
State string `json:"state"`
|
||||
// City City
|
||||
City string `json:"city"`
|
||||
// StreetLine1 First line for the address
|
||||
StreetLine1 string `json:"street_line1"`
|
||||
// StreetLine2 Second line for the address
|
||||
StreetLine2 string `json:"street_line2"`
|
||||
PostCode string `json:"post_code"`
|
||||
// PostCode Address post code
|
||||
PostCode string `json:"post_code"`
|
||||
}
|
||||
|
||||
// OrderInfo represents information about an order.
|
||||
// Since: Bot API 3.0
|
||||
// See https://core.telegram.org/bots/api#orderinfo
|
||||
type OrderInfo struct {
|
||||
Name string `json:"name"`
|
||||
PhoneNumber string `json:"phone_number"`
|
||||
Email string `json:"email"`
|
||||
// Name Optional. User name
|
||||
Name string `json:"name"`
|
||||
// PhoneNumber Optional. User's phone number
|
||||
PhoneNumber string `json:"phone_number"`
|
||||
// Email Optional. User email
|
||||
Email string `json:"email"`
|
||||
// ShippingAddress Optional. User shipping address
|
||||
ShippingAddress ShippingAddress `json:"shipping_address"`
|
||||
}
|
||||
|
||||
// PreCheckoutQuery represents an incoming pre-checkout query.
|
||||
// Since: Bot API 3.0
|
||||
// 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"`
|
||||
// ID Unique query identifier
|
||||
ID string `json:"id"`
|
||||
// From User who sent the query
|
||||
From User `json:"from"`
|
||||
// Currency Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars
|
||||
Currency string `json:"currency"`
|
||||
// TotalAmount Total price in the smallest units of the currency (integer, not float/double). For example,
|
||||
// for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number
|
||||
// of digits past the decimal point for each currency (2 for the majority of currencies).
|
||||
TotalAmount int `json:"total_amount"`
|
||||
// InvoicePayload Bot-specified invoice payload
|
||||
InvoicePayload string `json:"invoice_payload"`
|
||||
// ShippingOptionID Optional. Identifier of the shipping option chosen by the user
|
||||
ShippingOptionID string `json:"shipping_option_id"`
|
||||
// OrderInfo Optional. Order information provided by the user
|
||||
OrderInfo *OrderInfo `json:"order_info,omitempty"`
|
||||
}
|
||||
|
||||
// PaidMediaPurchased represents a purchased paid media.
|
||||
// Since: Bot API 7.10
|
||||
// See https://core.telegram.org/bots/api#paidmediapurchased
|
||||
type PaidMediaPurchased struct {
|
||||
From User `json:"from"`
|
||||
// From User who purchased the media
|
||||
From User `json:"from"`
|
||||
// PaidMediaPayload Bot-specified paid media payload
|
||||
PaidMediaPayload string `json:"paid_media_payload"`
|
||||
}
|
||||
|
||||
// ShippingOption represents one shipping option.
|
||||
// Since: Bot API 3.0
|
||||
// See https://core.telegram.org/bots/api#shippingoption
|
||||
type ShippingOption struct {
|
||||
ID string `json:"id"`
|
||||
Title string `json:"title"`
|
||||
// ID Shipping option identifier
|
||||
ID string `json:"id"`
|
||||
// Title Option title
|
||||
Title string `json:"title"`
|
||||
// Prices List of price portions
|
||||
Prices []LabeledPrice `json:"prices"`
|
||||
}
|
||||
|
||||
// SuccessfulPayment contains basic information about a successful payment.
|
||||
// Since: Bot API 3.0
|
||||
type SuccessfulPayment struct {
|
||||
Currency string `json:"currency"`
|
||||
TotalAmount int `json:"total_amount"`
|
||||
// Currency Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars
|
||||
Currency string `json:"currency"`
|
||||
// TotalAmount Total price in the smallest units of the currency (integer, not float/double). For example,
|
||||
// for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number
|
||||
// of digits past the decimal point for each currency (2 for the majority of currencies).
|
||||
TotalAmount int `json:"total_amount"`
|
||||
// InvoicePayload Bot-specified invoice payload
|
||||
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"`
|
||||
// SubscriptionExpirationDate Optional. Expiration date of the subscription, in Unix time; for recurring
|
||||
// payments only
|
||||
SubscriptionExpirationDate int `json:"subscription_expiration_date,omitempty"` // Since: Bot API 8.0
|
||||
// IsRecurring Optional. True, if the payment is a recurring payment for a subscription
|
||||
IsRecurring bool `json:"is_recurring,omitempty"` // Since: Bot API 8.0
|
||||
// IsFirstRecurring Optional. True, if the payment is the first payment for a subscription
|
||||
IsFirstRecurring bool `json:"is_first_recurring,omitempty"` // Since: Bot API 8.0
|
||||
// ShippingOptionID Optional. Identifier of the shipping option chosen by the user
|
||||
ShippingOptionID string `json:"shipping_option_id,omitempty"`
|
||||
// OrderInfo Optional. Order information provided by the user
|
||||
OrderInfo *OrderInfo `json:"order_info,omitempty"`
|
||||
|
||||
// TelegramPaymentChargeID Telegram payment identifier
|
||||
TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
|
||||
ProviderPaymentChargeID string `json:"proviced_payment_charge_id"`
|
||||
// ProviderPaymentChargeID Provider payment identifier
|
||||
ProviderPaymentChargeID string `json:"provider_payment_charge_id"`
|
||||
}
|
||||
|
||||
// RefundedPayment contains basic information about a refunded payment.
|
||||
// Since: Bot API 7.7
|
||||
type RefundedPayment struct {
|
||||
Currency string `json:"currency"`
|
||||
TotalAmount int `json:"total_amount"`
|
||||
// Currency Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars. Currently,
|
||||
// always “XTR”.
|
||||
Currency string `json:"currency"`
|
||||
// TotalAmount Total refunded price in the smallest units of the currency (integer, not float/double). For
|
||||
// example, for a price of US$ 1.45, total_amount = 145. See the exp parameter in currencies.json, it shows
|
||||
// the number of digits past the decimal point for each currency (2 for the majority of currencies).
|
||||
TotalAmount int `json:"total_amount"`
|
||||
// InvoicePayload Bot-specified invoice payload
|
||||
InvoicePayload string `json:"invoice_payload"`
|
||||
|
||||
// TelegramPaymentChargeID Telegram payment identifier
|
||||
TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
|
||||
ProviderPaymentChargeID string `json:"proviced_payment_charge_id,omitempty"`
|
||||
// ProviderPaymentChargeID Optional. Provider payment identifier
|
||||
ProviderPaymentChargeID string `json:"provider_payment_charge_id,omitempty"`
|
||||
}
|
||||
|
||||
+11
-6
@@ -2,6 +2,7 @@ package tgapi
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"sync"
|
||||
)
|
||||
|
||||
@@ -126,10 +127,14 @@ func (p *workerPool) worker() {
|
||||
}
|
||||
|
||||
func (p *workerPool) executeEnvelope(envelope requestEnvelope) {
|
||||
value, err := envelope.doFunc(envelope.ctx)
|
||||
envelope.resultCh <- requestResult{
|
||||
value: value,
|
||||
err: err,
|
||||
}
|
||||
close(envelope.resultCh)
|
||||
result := requestResult{}
|
||||
defer func() {
|
||||
if recovered := recover(); recovered != nil {
|
||||
result.value = nil
|
||||
result.err = fmt.Errorf("%w: %v", ErrPoolWorkerPanic, recovered)
|
||||
}
|
||||
envelope.resultCh <- result
|
||||
close(envelope.resultCh)
|
||||
}()
|
||||
result.value, result.err = envelope.doFunc(envelope.ctx)
|
||||
}
|
||||
|
||||
@@ -18,6 +18,34 @@ func TestWorkerPoolSubmitAfterStop(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestWorkerPoolRecoversTaskPanicAndContinues(t *testing.T) {
|
||||
pool := newWorkerPool(1, 2)
|
||||
pool.start()
|
||||
defer pool.stop()
|
||||
|
||||
panicked, err := pool.submit(context.Background(), func(context.Context) (any, error) {
|
||||
panic("boom")
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("submit panic task returned error: %v", err)
|
||||
}
|
||||
result := <-panicked
|
||||
if !errors.Is(result.err, ErrPoolWorkerPanic) {
|
||||
t.Fatalf("expected ErrPoolWorkerPanic, got %v", result.err)
|
||||
}
|
||||
|
||||
continued, err := pool.submit(context.Background(), func(context.Context) (any, error) {
|
||||
return "ok", nil
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("submit follow-up returned error: %v", err)
|
||||
}
|
||||
result = <-continued
|
||||
if result.err != nil || result.value != "ok" {
|
||||
t.Fatalf("worker did not continue: %#v", result)
|
||||
}
|
||||
}
|
||||
|
||||
func TestWorkerPoolQueueFull(t *testing.T) {
|
||||
pool := newWorkerPool(1, 1)
|
||||
pool.start()
|
||||
|
||||
@@ -0,0 +1,617 @@
|
||||
package tgapi
|
||||
|
||||
import "encoding/json"
|
||||
|
||||
// RichBlock is a block in a structured rich message.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlock interface {
|
||||
isRichBlock()
|
||||
}
|
||||
|
||||
// RichBlockCaption is the caption of a media block or container.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockCaption struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// Credit contains attribution displayed with the block.
|
||||
Credit RichText
|
||||
}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (c RichBlockCaption) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Text RichText `json:"text"`
|
||||
Credit RichText `json:"credit,omitempty"`
|
||||
}{c.Text, c.Credit})
|
||||
}
|
||||
|
||||
// UnmarshalJSON implements json.Unmarshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (c *RichBlockCaption) UnmarshalJSON(data []byte) error {
|
||||
var raw struct {
|
||||
Text json.RawMessage `json:"text"`
|
||||
Credit json.RawMessage `json:"credit"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &raw); err != nil {
|
||||
return err
|
||||
}
|
||||
text, err := parseOptRichText(raw.Text)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
credit, err := parseOptRichText(raw.Credit)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
*c = RichBlockCaption{text, credit}
|
||||
return nil
|
||||
}
|
||||
|
||||
// RichBlockListItem is a single list item. Label is the ready-to-display
|
||||
// visible marker ("1.", "c.", "vii.", "•"): the server renders it itself
|
||||
// when parsing html/markdown.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockListItem struct {
|
||||
// Label contains the list-item label.
|
||||
Label string
|
||||
// Blocks contains the nested rich-message blocks.
|
||||
Blocks []RichBlock
|
||||
// HasCheckbox reports whether the list item includes a checkbox.
|
||||
HasCheckbox bool
|
||||
// IsChecked reports whether the list-item checkbox is checked.
|
||||
IsChecked bool
|
||||
// Value is the numeric marker value for an ordered list item.
|
||||
Value int // for ordered lists: numeric value of the marker
|
||||
// Type selects the ordered-list marker style: a, A, i, I, or 1.
|
||||
Type RichBlockListItemType // for ordered lists: "a", "A", "i", "I" or "1"
|
||||
}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (i RichBlockListItem) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Label string `json:"label"`
|
||||
Blocks []RichBlock `json:"blocks"`
|
||||
HasCheckbox bool `json:"has_checkbox,omitempty"`
|
||||
IsChecked bool `json:"is_checked,omitempty"`
|
||||
Value int `json:"value,omitempty"`
|
||||
Type RichBlockListItemType `json:"type,omitempty"`
|
||||
}{i.Label, i.Blocks, i.HasCheckbox, i.IsChecked, i.Value, i.Type})
|
||||
}
|
||||
|
||||
// UnmarshalJSON implements json.Unmarshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (i *RichBlockListItem) UnmarshalJSON(data []byte) error {
|
||||
var raw struct {
|
||||
Label string `json:"label"`
|
||||
Blocks json.RawMessage `json:"blocks"`
|
||||
HasCheckbox bool `json:"has_checkbox"`
|
||||
IsChecked bool `json:"is_checked"`
|
||||
Value int `json:"value"`
|
||||
Type RichBlockListItemType `json:"type"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &raw); err != nil {
|
||||
return err
|
||||
}
|
||||
blocks, err := unmarshalRichBlocks(raw.Blocks)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
*i = RichBlockListItem{raw.Label, blocks, raw.HasCheckbox, raw.IsChecked, raw.Value, raw.Type}
|
||||
return nil
|
||||
}
|
||||
|
||||
// RichBlockTableCell is a table cell. An empty Text means an invisible cell.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockTableCell struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// IsHeader marks the table cell as a header cell.
|
||||
IsHeader bool
|
||||
// ColSpan is the number of table columns spanned by the cell.
|
||||
ColSpan int
|
||||
// RowSpan is the number of table rows spanned by the cell.
|
||||
RowSpan int
|
||||
// Align is the horizontal alignment: left, center, or right.
|
||||
Align string // "left", "center" or "right"
|
||||
// VAlign is the vertical alignment: top, middle, or bottom.
|
||||
VAlign string // "top", "middle" or "bottom"
|
||||
}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (c RichBlockTableCell) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Text RichText `json:"text,omitempty"`
|
||||
IsHeader bool `json:"is_header,omitempty"`
|
||||
Colspan int `json:"colspan,omitempty"`
|
||||
Rowspan int `json:"rowspan,omitempty"`
|
||||
Align string `json:"align,omitempty"`
|
||||
VAlign string `json:"valign,omitempty"`
|
||||
}{c.Text, c.IsHeader, c.ColSpan, c.RowSpan, c.Align, c.VAlign})
|
||||
}
|
||||
|
||||
// UnmarshalJSON implements json.Unmarshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (c *RichBlockTableCell) UnmarshalJSON(data []byte) error {
|
||||
var raw struct {
|
||||
Text json.RawMessage `json:"text"`
|
||||
IsHeader bool `json:"is_header"`
|
||||
Colspan int `json:"colspan"`
|
||||
Rowspan int `json:"rowspan"`
|
||||
Align string `json:"align"`
|
||||
VAlign string `json:"valign"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &raw); err != nil {
|
||||
return err
|
||||
}
|
||||
text, err := parseOptRichText(raw.Text)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
*c = RichBlockTableCell{text, raw.IsHeader, raw.Colspan, raw.Rowspan, raw.Align, raw.VAlign}
|
||||
return nil
|
||||
}
|
||||
|
||||
// RichBlockWrap covers all blocks that have only a text field.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockWrap struct {
|
||||
// Tag identifies the rich-text formatting wrapper.
|
||||
Tag string
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
}
|
||||
|
||||
func (RichBlockWrap) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockWrap) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
}{b.Tag, b.Text})
|
||||
}
|
||||
|
||||
var richBlockWrapTags = map[string]bool{
|
||||
"paragraph": true, "footer": true, "thinking": true,
|
||||
}
|
||||
|
||||
// RichBlockSectionHeading is a section heading block.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockSectionHeading struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// Size is the heading level from 1 through 6, where 1 is largest.
|
||||
Size int // 1-6, 1 is the largest
|
||||
}
|
||||
|
||||
func (RichBlockSectionHeading) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockSectionHeading) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
Size int `json:"size"`
|
||||
}{"heading", b.Text, b.Size})
|
||||
}
|
||||
|
||||
// RichBlockPreformatted is a preformatted code block.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockPreformatted struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// Language identifies the programming language used for syntax highlighting.
|
||||
Language string
|
||||
}
|
||||
|
||||
func (RichBlockPreformatted) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockPreformatted) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
Language string `json:"language,omitempty"`
|
||||
}{"pre", b.Text, b.Language})
|
||||
}
|
||||
|
||||
// RichBlockQuotation is a block quotation with block-level content
|
||||
// (officially RichBlockBlockQuotation).
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockQuotation struct {
|
||||
// Blocks contains the nested rich-message blocks.
|
||||
Blocks []RichBlock
|
||||
// Credit contains attribution displayed with the block.
|
||||
Credit RichText
|
||||
}
|
||||
|
||||
func (RichBlockQuotation) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockQuotation) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Blocks []RichBlock `json:"blocks"`
|
||||
Credit RichText `json:"credit,omitempty"`
|
||||
}{"blockquote", b.Blocks, b.Credit})
|
||||
}
|
||||
|
||||
// RichBlockPullQuotation is a pull quotation with inline content.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockPullQuotation struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// Credit contains attribution displayed with the block.
|
||||
Credit RichText
|
||||
}
|
||||
|
||||
func (RichBlockPullQuotation) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockPullQuotation) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
Credit RichText `json:"credit,omitempty"`
|
||||
}{"pullquote", b.Text, b.Credit})
|
||||
}
|
||||
|
||||
// RichBlockList is a list block.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockList struct {
|
||||
// Items contains the list items.
|
||||
Items []RichBlockListItem
|
||||
}
|
||||
|
||||
func (RichBlockList) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockList) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Items []RichBlockListItem `json:"items"`
|
||||
}{"list", b.Items})
|
||||
}
|
||||
|
||||
// RichBlockCollage is a collage of media blocks.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockCollage struct {
|
||||
// Blocks contains the nested rich-message blocks.
|
||||
Blocks []RichBlock
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption
|
||||
}
|
||||
|
||||
func (RichBlockCollage) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockCollage) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Blocks []RichBlock `json:"blocks"`
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}{"collage", b.Blocks, b.Caption})
|
||||
}
|
||||
|
||||
// RichBlockSlideshow is a slideshow of media blocks.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockSlideshow struct {
|
||||
// Blocks contains the nested rich-message blocks.
|
||||
Blocks []RichBlock
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption
|
||||
}
|
||||
|
||||
func (RichBlockSlideshow) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockSlideshow) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Blocks []RichBlock `json:"blocks"`
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}{"slideshow", b.Blocks, b.Caption})
|
||||
}
|
||||
|
||||
// RichBlockDetails is an expandable block with an inline summary.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockDetails struct {
|
||||
// Summary contains the visible summary of a details block.
|
||||
Summary RichText
|
||||
// Blocks contains the nested rich-message blocks.
|
||||
Blocks []RichBlock
|
||||
// IsOpen requests the details block to be expanded initially.
|
||||
IsOpen bool
|
||||
}
|
||||
|
||||
func (RichBlockDetails) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockDetails) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Summary RichText `json:"summary"`
|
||||
Blocks []RichBlock `json:"blocks"`
|
||||
IsOpen bool `json:"is_open,omitempty"`
|
||||
}{"details", b.Summary, b.Blocks, b.IsOpen})
|
||||
}
|
||||
|
||||
// RichBlockTable is a table block.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockTable struct {
|
||||
// Cells contains the table rows and cells.
|
||||
Cells [][]RichBlockTableCell
|
||||
// IsBordered requests visible table borders.
|
||||
IsBordered bool
|
||||
// IsStriped requests alternating table row styling.
|
||||
IsStriped bool
|
||||
// Caption contains the media or block caption.
|
||||
Caption RichText
|
||||
}
|
||||
|
||||
func (RichBlockTable) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockTable) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Cells [][]RichBlockTableCell `json:"cells"`
|
||||
IsBordered bool `json:"is_bordered,omitempty"`
|
||||
IsStriped bool `json:"is_striped,omitempty"`
|
||||
Caption RichText `json:"caption,omitempty"`
|
||||
}{"table", b.Cells, b.IsBordered, b.IsStriped, b.Caption})
|
||||
}
|
||||
|
||||
// RichBlockMap is a location map block.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockMap struct {
|
||||
// Location contains the map location.
|
||||
Location Location
|
||||
// Zoom is the map zoom level in the range 13 through 20.
|
||||
Zoom int // 13-20
|
||||
// Width is the requested media or map width in pixels.
|
||||
Width int
|
||||
// Height is the requested media or map height in pixels.
|
||||
Height int
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption
|
||||
}
|
||||
|
||||
func (RichBlockMap) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockMap) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Location Location `json:"location"`
|
||||
Zoom int `json:"zoom"`
|
||||
Width int `json:"width"`
|
||||
Height int `json:"height"`
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}{"map", b.Location, b.Zoom, b.Width, b.Height, b.Caption})
|
||||
}
|
||||
|
||||
// RichBlockPhoto is a photo block.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockPhoto struct {
|
||||
// Photo contains or identifies the associated photo.
|
||||
Photo []PhotoSize
|
||||
// HasSpoiler reports whether the media is covered by a spoiler.
|
||||
HasSpoiler bool
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption
|
||||
}
|
||||
|
||||
func (RichBlockPhoto) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockPhoto) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Photo []PhotoSize `json:"photo"`
|
||||
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}{"photo", b.Photo, b.HasSpoiler, b.Caption})
|
||||
}
|
||||
|
||||
// RichBlockVideo is a video block.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockVideo struct {
|
||||
// Video contains the video rendered by the block.
|
||||
Video Video
|
||||
// HasSpoiler reports whether the media is covered by a spoiler.
|
||||
HasSpoiler bool
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption
|
||||
}
|
||||
|
||||
func (RichBlockVideo) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockVideo) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Video Video `json:"video"`
|
||||
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}{"video", b.Video, b.HasSpoiler, b.Caption})
|
||||
}
|
||||
|
||||
// RichBlockAudio is an audio block.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockAudio struct {
|
||||
// Audio contains the audio rendered by the block.
|
||||
Audio Audio
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption
|
||||
}
|
||||
|
||||
func (RichBlockAudio) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockAudio) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Audio Audio `json:"audio"`
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}{"audio", b.Audio, b.Caption})
|
||||
}
|
||||
|
||||
// RichBlockAnimation is an animation block.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockAnimation struct {
|
||||
// Animation contains the animation rendered by the block.
|
||||
Animation Animation
|
||||
// HasSpoiler reports whether the media is covered by a spoiler.
|
||||
HasSpoiler bool
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption
|
||||
}
|
||||
|
||||
func (RichBlockAnimation) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockAnimation) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Animation Animation `json:"animation"`
|
||||
HasSpoiler bool `json:"has_spoiler,omitempty"`
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}{"animation", b.Animation, b.HasSpoiler, b.Caption})
|
||||
}
|
||||
|
||||
// RichBlockVoiceNote is a voice note block.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockVoiceNote struct {
|
||||
// VoiceNote contains the voice note rendered by the block.
|
||||
VoiceNote Voice
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption
|
||||
}
|
||||
|
||||
func (RichBlockVoiceNote) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockVoiceNote) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
VoiceNote Voice `json:"voice_note"`
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}{"voice_note", b.VoiceNote, b.Caption})
|
||||
}
|
||||
|
||||
// RichBlockDivider is a horizontal divider block.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockDivider struct{}
|
||||
|
||||
func (RichBlockDivider) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockDivider) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
}{"divider"})
|
||||
}
|
||||
|
||||
// RichBlockMathematicalExpression is a block-level mathematical expression.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockMathematicalExpression struct {
|
||||
// Expression contains the mathematical expression source.
|
||||
Expression string
|
||||
}
|
||||
|
||||
func (RichBlockMathematicalExpression) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockMathematicalExpression) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Expression string `json:"expression"`
|
||||
}{"mathematical_expression", b.Expression})
|
||||
}
|
||||
|
||||
// RichBlockAnchor is a named anchor block that anchor links can point to.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichBlockAnchor struct {
|
||||
// Name is the user-facing or reference name of the value.
|
||||
Name string
|
||||
}
|
||||
|
||||
func (RichBlockAnchor) isRichBlock() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (b RichBlockAnchor) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Name string `json:"name"`
|
||||
}{"anchor", b.Name})
|
||||
}
|
||||
@@ -0,0 +1,427 @@
|
||||
package tgapi
|
||||
|
||||
// InputRichType identifies the JSON type of an input rich block.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichType string
|
||||
|
||||
const (
|
||||
// InputRichTypeParagraph identifies a paragraph block.
|
||||
InputRichTypeParagraph InputRichType = "paragraph"
|
||||
// InputRichTypeSectionHeading identifies a section-heading block.
|
||||
InputRichTypeSectionHeading InputRichType = "heading"
|
||||
// InputRichTypePre identifies a preformatted block.
|
||||
InputRichTypePre InputRichType = "pre"
|
||||
// InputRichTypeFooter identifies a footer block.
|
||||
InputRichTypeFooter InputRichType = "footer"
|
||||
// InputRichTypeDivider identifies a divider block.
|
||||
InputRichTypeDivider InputRichType = "divider"
|
||||
// InputRichTypeMathematicalExpression identifies a mathematical-expression block.
|
||||
InputRichTypeMathematicalExpression InputRichType = "mathematical_expression"
|
||||
// InputRichTypeAnchor identifies an anchor block.
|
||||
InputRichTypeAnchor InputRichType = "anchor"
|
||||
// InputRichTypeList identifies a list block.
|
||||
InputRichTypeList InputRichType = "list"
|
||||
// InputRichTypeBlockQuotation identifies a block-quotation block.
|
||||
InputRichTypeBlockQuotation InputRichType = "blockquote"
|
||||
// InputRichTypePullQuotation identifies a pull-quotation block.
|
||||
InputRichTypePullQuotation InputRichType = "pullquote"
|
||||
// InputRichTypeCollage identifies a collage block.
|
||||
InputRichTypeCollage InputRichType = "collage"
|
||||
// InputRichTypeSlideshow identifies a slideshow block.
|
||||
InputRichTypeSlideshow InputRichType = "slideshow"
|
||||
// InputRichTypeTable identifies a table block.
|
||||
InputRichTypeTable InputRichType = "table"
|
||||
// InputRichTypeDetails identifies an expandable details block.
|
||||
InputRichTypeDetails InputRichType = "details"
|
||||
// InputRichTypeMap identifies a map block.
|
||||
InputRichTypeMap InputRichType = "map"
|
||||
// InputRichTypeAnimation identifies an animation block.
|
||||
InputRichTypeAnimation InputRichType = "animation"
|
||||
// InputRichTypeAudio identifies an audio block.
|
||||
InputRichTypeAudio InputRichType = "audio"
|
||||
// InputRichTypePhoto identifies a photo block.
|
||||
InputRichTypePhoto InputRichType = "photo"
|
||||
// InputRichTypeVideo identifies a video block.
|
||||
InputRichTypeVideo InputRichType = "video"
|
||||
// InputRichTypeVoiceNote identifies a voice-note block.
|
||||
InputRichTypeVoiceNote InputRichType = "voice_note"
|
||||
// InputRichTypeThinking identifies a thinking block.
|
||||
InputRichTypeThinking InputRichType = "thinking"
|
||||
)
|
||||
|
||||
// InputRichBlock represents a block available to format an outgoing rich message.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlock interface {
|
||||
isInputRichBlock()
|
||||
}
|
||||
|
||||
// InputRichBlockParagraph is a text paragraph corresponding to the HTML <p> tag.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockParagraph struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText `json:"text"`
|
||||
}
|
||||
|
||||
func (InputRichBlockParagraph) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockSectionHeading is a section heading corresponding to an HTML <h1> through <h6> tag.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockSectionHeading struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText `json:"text"`
|
||||
// Size selects the section heading level from 1 through 6.
|
||||
Size uint8 `json:"size"`
|
||||
}
|
||||
|
||||
func (InputRichBlockSectionHeading) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockPreformatted is a preformatted text block corresponding to nested HTML <pre> and <code> tags.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockPreformatted struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText `json:"text"`
|
||||
// Language identifies the programming language used for syntax highlighting.
|
||||
Language string `json:"language,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockPreformatted) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockFooter is a footer corresponding to the HTML <footer> tag.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockFooter struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText `json:"text"`
|
||||
}
|
||||
|
||||
func (InputRichBlockFooter) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockDivider is a divider corresponding to the HTML <hr/> tag.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockDivider struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
}
|
||||
|
||||
func (InputRichBlockDivider) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockMath is a block containing a mathematical expression in LaTeX format,
|
||||
// corresponding to the custom HTML <tg-math-block> tag.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockMath struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Expression contains the mathematical expression source.
|
||||
Expression string `json:"expression"`
|
||||
}
|
||||
|
||||
func (InputRichBlockMath) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockAnchor is a block containing an anchor corresponding to an HTML <a> tag with a name attribute.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockAnchor struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Name is the user-facing or reference name of the value.
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
func (InputRichBlockAnchor) isInputRichBlock() {}
|
||||
|
||||
// RichBlockListItemType identifies an ordered-list label style.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type RichBlockListItemType string
|
||||
|
||||
const (
|
||||
// InputRichBlockListItemTypeLower uses lowercase letters.
|
||||
InputRichBlockListItemTypeLower RichBlockListItemType = "a"
|
||||
// InputRichBlockListItemTypeUpper uses uppercase letters.
|
||||
InputRichBlockListItemTypeUpper RichBlockListItemType = "A"
|
||||
// InputRichBlockListItemTypeRomanLow uses lowercase Roman numerals.
|
||||
InputRichBlockListItemTypeRomanLow RichBlockListItemType = "i"
|
||||
// InputRichBlockListItemTypeRomanUpper uses uppercase Roman numerals.
|
||||
InputRichBlockListItemTypeRomanUpper RichBlockListItemType = "I"
|
||||
// InputRichBlockListItemTypeDecimal uses decimal numbers.
|
||||
InputRichBlockListItemTypeDecimal RichBlockListItemType = "1"
|
||||
)
|
||||
|
||||
// InputRichBlockListItem represents an item in an input rich-message list.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockListItem struct {
|
||||
// Blocks contains the nested rich-message blocks.
|
||||
Blocks []InputRichBlock `json:"blocks"`
|
||||
// HasCheckbox reports whether the list item includes a checkbox.
|
||||
HasCheckbox bool `json:"has_checkbox,omitempty"`
|
||||
// IsChecked reports whether the list-item checkbox is checked.
|
||||
IsChecked bool `json:"is_checked,omitempty"`
|
||||
// Value sets the numeric marker value for an ordered list item.
|
||||
Value int `json:"value,omitempty"`
|
||||
// Type is the Bot API type discriminator.
|
||||
Type RichBlockListItemType `json:"type,omitempty"`
|
||||
}
|
||||
|
||||
// NewInputRichBlockListItem creates a list item containing blocks.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
func NewInputRichBlockListItem(blocks ...InputRichBlock) *InputRichBlockListItem {
|
||||
return &InputRichBlockListItem{Blocks: blocks}
|
||||
}
|
||||
|
||||
// SetCheckbox configures whether the list item has a checkbox.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
func (i *InputRichBlockListItem) SetCheckbox(hasCheckbox bool) *InputRichBlockListItem {
|
||||
i.HasCheckbox = hasCheckbox
|
||||
return i
|
||||
}
|
||||
|
||||
// Check marks the list item's checkbox as checked.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
func (i *InputRichBlockListItem) Check() *InputRichBlockListItem {
|
||||
i.IsChecked = true
|
||||
return i
|
||||
}
|
||||
|
||||
// SetValue sets the numeric value of an ordered-list item.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
func (i *InputRichBlockListItem) SetValue(val int) *InputRichBlockListItem {
|
||||
i.Value = val
|
||||
return i
|
||||
}
|
||||
|
||||
// SetType sets the label style of an ordered-list item.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
func (i *InputRichBlockListItem) SetType(t RichBlockListItemType) *InputRichBlockListItem {
|
||||
i.Type = t
|
||||
return i
|
||||
}
|
||||
|
||||
// InputRichBlockList is a list of input rich-message blocks.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockList struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Items contains the list items.
|
||||
Items []InputRichBlockListItem `json:"items"`
|
||||
}
|
||||
|
||||
func (InputRichBlockList) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockBlockQuotation is a block quotation in an input rich message.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockBlockQuotation struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Blocks contains the nested rich-message blocks.
|
||||
Blocks []InputRichBlock `json:"blocks"`
|
||||
// Credit contains attribution displayed with the block.
|
||||
Credit *RichText `json:"credit,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockBlockQuotation) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockPullQuotation is a centered quotation in an input rich message.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockPullQuotation struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText `json:"text"`
|
||||
// Credit contains attribution displayed with the block.
|
||||
Credit *RichText `json:"credit,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockPullQuotation) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockCollage is a collage in an input rich message.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockCollage struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Blocks contains the nested rich-message blocks.
|
||||
Blocks []InputRichBlock `json:"blocks"`
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockCollage) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockSlideshow is a slideshow in an input rich message.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockSlideshow struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Blocks contains the nested rich-message blocks.
|
||||
Blocks []InputRichBlock `json:"blocks"`
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockSlideshow) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockTable is a table in an input rich message.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockTable struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Cells contains the table rows and cells.
|
||||
Cells [][]RichBlockTableCell `json:"cells"`
|
||||
// IsBordered requests visible table borders.
|
||||
IsBordered bool `json:"is_bordered,omitempty"`
|
||||
// IsStriped requests alternating table row styling.
|
||||
IsStriped bool `json:"is_striped,omitempty"`
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichText `json:"caption,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockTable) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockDetails is an expandable block in an input rich message.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockDetails struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Summary contains the visible summary of a details block.
|
||||
Summary RichText `json:"summary"`
|
||||
// Blocks contains the nested rich-message blocks.
|
||||
Blocks []InputRichBlock `json:"blocks"`
|
||||
// IsOpen requests the details block to be expanded initially.
|
||||
IsOpen bool `json:"is_open,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockDetails) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockMap is a location map in an input rich message.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockMap struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Location contains the map location.
|
||||
Location Location `json:"location"`
|
||||
// Zoom sets the map zoom level.
|
||||
Zoom uint8 `json:"zoom,omitempty"`
|
||||
// Width is the requested media or map width in pixels.
|
||||
Width uint16 `json:"width,omitempty"`
|
||||
// Height is the requested media or map height in pixels.
|
||||
Height uint16 `json:"height,omitempty"`
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockMap) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockAnimation is an animation block corresponding to the HTML <video> tag.
|
||||
// The animation caption is ignored; use Caption instead.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockAnimation struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Animation contains the animation rendered by the block.
|
||||
Animation InputMedia `json:"animation"`
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockAnimation) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockAudio is a music-file block corresponding to the HTML <audio> tag.
|
||||
// The audio caption is ignored; use Caption instead.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockAudio struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Audio contains the audio rendered by the block.
|
||||
Audio InputMedia `json:"audio"`
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockAudio) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockPhoto is a photo block corresponding to the HTML <img> tag.
|
||||
// The photo caption is ignored; use Caption instead.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockPhoto struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Photo contains or identifies the associated photo.
|
||||
Photo InputMedia `json:"photo"`
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockPhoto) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockVideo is a video block corresponding to the HTML <video> tag.
|
||||
// The video caption is ignored; use Caption instead.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockVideo struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Video contains the video rendered by the block.
|
||||
Video InputMedia `json:"video"`
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockVideo) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockVoiceNote is a voice-note block corresponding to the HTML <audio> tag.
|
||||
// The voice-note caption is ignored; use Caption instead.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockVoiceNote struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// VoiceNote contains the voice note rendered by the block.
|
||||
VoiceNote InputMedia `json:"voice_note"`
|
||||
// Caption contains the media or block caption.
|
||||
Caption *RichBlockCaption `json:"caption,omitempty"`
|
||||
}
|
||||
|
||||
func (InputRichBlockVoiceNote) isInputRichBlock() {}
|
||||
|
||||
// InputRichBlockThinking is a block for displaying a thinking state.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
type InputRichBlockThinking struct {
|
||||
// Type is the Bot API type discriminator.
|
||||
Type InputRichType `json:"type"`
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText `json:"text"`
|
||||
}
|
||||
|
||||
func (InputRichBlockThinking) isInputRichBlock() {}
|
||||
@@ -0,0 +1,65 @@
|
||||
package tgapi
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestInputRichMediaBlocksMarshal(t *testing.T) {
|
||||
caption := RichBlockCaption{Text: RichTextPlain("caption")}
|
||||
cases := []struct {
|
||||
name string
|
||||
block InputRichBlock
|
||||
blockType InputRichType
|
||||
mediaKey string
|
||||
mediaType InputMediaType
|
||||
}{
|
||||
{"animation", InputRichBlockAnimation{Type: InputRichTypeAnimation, Animation: InputMedia{Type: InputMediaTypeAnimation, Media: "animation-id"}, Caption: &caption}, InputRichTypeAnimation, "animation", InputMediaTypeAnimation},
|
||||
{"audio", InputRichBlockAudio{Type: InputRichTypeAudio, Audio: InputMedia{Type: InputMediaTypeAudio, Media: "audio-id"}, Caption: &caption}, InputRichTypeAudio, "audio", InputMediaTypeAudio},
|
||||
{"photo", InputRichBlockPhoto{Type: InputRichTypePhoto, Photo: InputMedia{Type: InputMediaTypePhoto, Media: "photo-id"}, Caption: &caption}, InputRichTypePhoto, "photo", InputMediaTypePhoto},
|
||||
{"video", InputRichBlockVideo{Type: InputRichTypeVideo, Video: InputMedia{Type: InputMediaTypeVideo, Media: "video-id"}, Caption: &caption}, InputRichTypeVideo, "video", InputMediaTypeVideo},
|
||||
{"voice note", InputRichBlockVoiceNote{Type: InputRichTypeVoiceNote, VoiceNote: InputMedia{Type: InputMediaTypeVoiceNote, Media: "voice-id"}, Caption: &caption}, InputRichTypeVoiceNote, "voice_note", InputMediaTypeVoiceNote},
|
||||
}
|
||||
|
||||
for _, tt := range cases {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
data, err := json.Marshal(InputRichMessage{Blocks: []InputRichBlock{tt.block}})
|
||||
if err != nil {
|
||||
t.Fatalf("Marshal returned error: %v", err)
|
||||
}
|
||||
|
||||
var message struct {
|
||||
Blocks []map[string]json.RawMessage `json:"blocks"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &message); err != nil {
|
||||
t.Fatalf("Unmarshal returned error: %v", err)
|
||||
}
|
||||
if len(message.Blocks) != 1 {
|
||||
t.Fatalf("got %d blocks, want 1", len(message.Blocks))
|
||||
}
|
||||
|
||||
var blockType InputRichType
|
||||
if err := json.Unmarshal(message.Blocks[0]["type"], &blockType); err != nil {
|
||||
t.Fatalf("unmarshal block type: %v", err)
|
||||
}
|
||||
if blockType != tt.blockType {
|
||||
t.Errorf("block type = %q, want %q", blockType, tt.blockType)
|
||||
}
|
||||
|
||||
var media InputMedia
|
||||
if err := json.Unmarshal(message.Blocks[0][tt.mediaKey], &media); err != nil {
|
||||
t.Fatalf("unmarshal %s: %v", tt.mediaKey, err)
|
||||
}
|
||||
if media.Type != tt.mediaType {
|
||||
t.Errorf("media type = %q, want %q", media.Type, tt.mediaType)
|
||||
}
|
||||
if message.Blocks[0]["caption"] == nil {
|
||||
t.Error("caption is missing")
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestInputRichBlockMapImplementsInputRichBlock(t *testing.T) {
|
||||
var _ InputRichBlock = InputRichBlockMap{}
|
||||
}
|
||||
@@ -0,0 +1,418 @@
|
||||
package tgapi
|
||||
|
||||
import "encoding/json"
|
||||
|
||||
// RichText is a node of the rich formatted text tree: a plain string, an
|
||||
// array, or one of the typed objects below.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichText interface {
|
||||
isRichText()
|
||||
}
|
||||
|
||||
// RichTextPlain is a plain text leaf.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextPlain string
|
||||
|
||||
func (RichTextPlain) isRichText() {}
|
||||
|
||||
// RichTextArray is a concatenation of rich text nodes.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextArray []RichText
|
||||
|
||||
func (RichTextArray) isRichText() {}
|
||||
|
||||
// RichTextWrap covers all "pure" wrapper nodes with a single type.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextWrap struct {
|
||||
// Tag identifies the rich-text formatting wrapper.
|
||||
Tag string
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
}
|
||||
|
||||
func (RichTextWrap) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (w RichTextWrap) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
}{w.Tag, w.Text})
|
||||
}
|
||||
|
||||
var richTextWrapTags = map[string]bool{
|
||||
"bold": true, "italic": true, "underline": true,
|
||||
"strikethrough": true, "spoiler": true, "subscript": true,
|
||||
"superscript": true, "marked": true, "code": true,
|
||||
}
|
||||
|
||||
// RichTextURL is rich text linking to a URL.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextURL struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// URL contains the HTTP URL.
|
||||
URL string
|
||||
}
|
||||
|
||||
func (RichTextURL) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextURL) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
URL string `json:"url"`
|
||||
}{"url", v.Text, v.URL})
|
||||
}
|
||||
|
||||
// RichTextEmailAddress is rich text linking to an email address.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextEmailAddress struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// EmailAddress is the email address associated with the text.
|
||||
EmailAddress string
|
||||
}
|
||||
|
||||
func (RichTextEmailAddress) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextEmailAddress) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
EmailAddress string `json:"email_address"`
|
||||
}{"email_address", v.Text, v.EmailAddress})
|
||||
}
|
||||
|
||||
// RichTextPhoneNumber is rich text linking to a phone number.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextPhoneNumber struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// PhoneNumber is the phone number associated with the text.
|
||||
PhoneNumber string
|
||||
}
|
||||
|
||||
func (RichTextPhoneNumber) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextPhoneNumber) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
PhoneNumber string `json:"phone_number"`
|
||||
}{"phone_number", v.Text, v.PhoneNumber})
|
||||
}
|
||||
|
||||
// RichTextBankCardNumber is rich text marked as a bank card number.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextBankCardNumber struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// BankCardNumber is the bank card number associated with the text.
|
||||
BankCardNumber string
|
||||
}
|
||||
|
||||
func (RichTextBankCardNumber) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextBankCardNumber) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
BankCardNumber string `json:"bank_card_number"`
|
||||
}{"bank_card_number", v.Text, v.BankCardNumber})
|
||||
}
|
||||
|
||||
// RichTextMention is rich text mentioning a user by username.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextMention struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// Username is the username associated with the mention.
|
||||
Username string
|
||||
}
|
||||
|
||||
func (RichTextMention) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextMention) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
Username string `json:"username"`
|
||||
}{"mention", v.Text, v.Username})
|
||||
}
|
||||
|
||||
// RichTextHashtag is rich text marked as a hashtag.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextHashtag struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// Hashtag is the hashtag associated with the text.
|
||||
Hashtag string
|
||||
}
|
||||
|
||||
func (RichTextHashtag) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextHashtag) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
Hashtag string `json:"hashtag"`
|
||||
}{"hashtag", v.Text, v.Hashtag})
|
||||
}
|
||||
|
||||
// RichTextCashtag is rich text marked as a cashtag.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextCashtag struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// Cashtag is the cashtag associated with the text.
|
||||
Cashtag string
|
||||
}
|
||||
|
||||
func (RichTextCashtag) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextCashtag) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
Cashtag string `json:"cashtag"`
|
||||
}{"cashtag", v.Text, v.Cashtag})
|
||||
}
|
||||
|
||||
// RichTextBotCommand is rich text marked as a bot command.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextBotCommand struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// BotCommand is the bot command associated with the text.
|
||||
BotCommand string
|
||||
}
|
||||
|
||||
func (RichTextBotCommand) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextBotCommand) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
BotCommand string `json:"bot_command"`
|
||||
}{"bot_command", v.Text, v.BotCommand})
|
||||
}
|
||||
|
||||
// RichTextAnchorLink is rich text linking to a named anchor in the same message.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextAnchorLink struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// AnchorName names the anchor targeted by the link.
|
||||
AnchorName string
|
||||
}
|
||||
|
||||
func (RichTextAnchorLink) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextAnchorLink) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
AnchorName string `json:"anchor_name"`
|
||||
}{"anchor_link", v.Text, v.AnchorName})
|
||||
}
|
||||
|
||||
// RichTextReference is rich text marked as a named reference target.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextReference struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// Name is the user-facing or reference name of the value.
|
||||
Name string
|
||||
}
|
||||
|
||||
func (RichTextReference) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextReference) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
Name string `json:"name"`
|
||||
}{"reference", v.Text, v.Name})
|
||||
}
|
||||
|
||||
// RichTextReferenceLink is rich text linking to a named reference.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextReferenceLink struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// ReferenceName names the reference targeted by the link.
|
||||
ReferenceName string
|
||||
}
|
||||
|
||||
func (RichTextReferenceLink) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextReferenceLink) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
ReferenceName string `json:"reference_name"`
|
||||
}{"reference_link", v.Text, v.ReferenceName})
|
||||
}
|
||||
|
||||
// RichTextDateTime is rich text bound to a point in time with a display format.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextDateTime struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// UnixTime is the Unix timestamp associated with the text.
|
||||
UnixTime int64
|
||||
// DateTimeFormat controls how the associated Unix time is displayed.
|
||||
DateTimeFormat string
|
||||
}
|
||||
|
||||
func (RichTextDateTime) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextDateTime) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
UnixTime int64 `json:"unix_time"`
|
||||
DateTimeFormat string `json:"date_time_format"`
|
||||
}{"date_time", v.Text, v.UnixTime, v.DateTimeFormat})
|
||||
}
|
||||
|
||||
// RichTextTextMention is rich text mentioning a user without a username.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextTextMention struct {
|
||||
// Text contains the formatted or plain text content.
|
||||
Text RichText
|
||||
// User contains the user associated with the value.
|
||||
User User
|
||||
}
|
||||
|
||||
func (RichTextTextMention) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextTextMention) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Text RichText `json:"text"`
|
||||
User User `json:"user"`
|
||||
}{"text_mention", v.Text, v.User})
|
||||
}
|
||||
|
||||
// RichTextCustomEmoji is a custom emoji leaf with alternative text.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextCustomEmoji struct {
|
||||
// CustomEmojiID identifies the custom emoji.
|
||||
CustomEmojiID string
|
||||
// AlternativeText is shown when the custom emoji can't be rendered.
|
||||
AlternativeText string
|
||||
}
|
||||
|
||||
func (RichTextCustomEmoji) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextCustomEmoji) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
CustomEmojiID string `json:"custom_emoji_id"`
|
||||
AlternativeText string `json:"alternative_text"`
|
||||
}{"custom_emoji", v.CustomEmojiID, v.AlternativeText})
|
||||
}
|
||||
|
||||
// RichTextMathematicalExpression is an inline mathematical expression leaf.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextMathematicalExpression struct {
|
||||
// Expression contains the mathematical expression source.
|
||||
Expression string
|
||||
}
|
||||
|
||||
func (RichTextMathematicalExpression) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextMathematicalExpression) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Expression string `json:"expression"`
|
||||
}{"mathematical_expression", v.Expression})
|
||||
}
|
||||
|
||||
// RichTextAnchor is a named anchor leaf that anchor links can point to.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
type RichTextAnchor struct {
|
||||
// Name is the user-facing or reference name of the value.
|
||||
Name string
|
||||
}
|
||||
|
||||
func (RichTextAnchor) isRichText() {}
|
||||
|
||||
// MarshalJSON implements json.Marshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (v RichTextAnchor) MarshalJSON() ([]byte, error) {
|
||||
return json.Marshal(struct {
|
||||
Type string `json:"type"`
|
||||
Name string `json:"name"`
|
||||
}{"anchor", v.Name})
|
||||
}
|
||||
@@ -0,0 +1,85 @@
|
||||
package tgapi
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func roundtripRichText(t *testing.T, in RichText) {
|
||||
t.Helper()
|
||||
b, err := json.Marshal(in)
|
||||
if err != nil {
|
||||
t.Fatalf("marshal: %v", err)
|
||||
}
|
||||
out, err := UnmarshalRichText(b)
|
||||
if err != nil {
|
||||
t.Fatalf("unmarshal %s: %v", b, err)
|
||||
}
|
||||
b2, err := json.Marshal(out)
|
||||
if err != nil {
|
||||
t.Fatalf("remarshal: %v", err)
|
||||
}
|
||||
if string(b) != string(b2) {
|
||||
t.Fatalf("not stable:\n %s\n %s", b, b2)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRichTextRoundtrip(t *testing.T) {
|
||||
cases := []RichText{
|
||||
RichTextPlain("hello"),
|
||||
RichTextArray{RichTextPlain("a "), RichTextWrap{"bold", RichTextPlain("b")}, RichTextPlain(" c")},
|
||||
RichTextWrap{"bold", RichTextWrap{"italic", RichTextPlain("nested")}},
|
||||
RichTextURL{RichTextPlain("Anthropic"), "https://anthropic.com"},
|
||||
RichTextCustomEmoji{"5368324170671202286", "👍"},
|
||||
RichTextMathematicalExpression{"x^2 + y^2"},
|
||||
RichTextAnchor{"chapter-1"},
|
||||
RichTextDateTime{RichTextPlain("22:45 tomorrow"), 1647531900, "wDT"},
|
||||
RichTextTextMention{RichTextPlain("Bob"), User{ID: 42, FirstName: "Bob"}},
|
||||
RichTextAnchorLink{RichTextPlain("back to top"), ""},
|
||||
RichTextReference{RichTextPlain("ref"), "note-1"},
|
||||
// deep nesting
|
||||
RichTextWrap{"bold", RichTextArray{
|
||||
RichTextPlain("bold and "),
|
||||
RichTextWrap{"italic", RichTextWrap{"underline", RichTextPlain("deep")}},
|
||||
RichTextWrap{"spoiler", RichTextCustomEmoji{"1", "x"}},
|
||||
}},
|
||||
}
|
||||
for _, c := range cases {
|
||||
roundtripRichText(t, c)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRichTextPlainFormsAreBare(t *testing.T) {
|
||||
b, _ := json.Marshal(RichTextPlain("hi"))
|
||||
if string(b) != `"hi"` {
|
||||
t.Fatalf("string should be bare: %s", b)
|
||||
}
|
||||
b, _ = json.Marshal(RichTextArray{RichTextPlain("a"), RichTextPlain("b")})
|
||||
if string(b) != `["a","b"]` {
|
||||
t.Fatalf("array should be bare: %s", b)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRichTextLeafHasNoText(t *testing.T) {
|
||||
b, _ := json.Marshal(RichTextAnchor{"x"})
|
||||
var m map[string]any
|
||||
_ = json.Unmarshal(b, &m)
|
||||
if _, ok := m["text"]; ok {
|
||||
t.Fatalf("anchor must not have text field: %s", b)
|
||||
}
|
||||
}
|
||||
|
||||
func TestUnmarshalRichTextRejectsInvalidValues(t *testing.T) {
|
||||
tests := []string{
|
||||
`null`,
|
||||
`{"type":"date_time","text":"now","unix_time":"soon"}`,
|
||||
`{"type":"custom_emoji","custom_emoji_id":42}`,
|
||||
}
|
||||
for _, raw := range tests {
|
||||
t.Run(raw, func(t *testing.T) {
|
||||
if _, err := UnmarshalRichText([]byte(raw)); err == nil {
|
||||
t.Fatal("expected malformed rich text to be rejected")
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,602 @@
|
||||
package tgapi
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
)
|
||||
|
||||
const (
|
||||
maximumRichJSONDepth = 64
|
||||
maximumRichJSONNodes = 10_000
|
||||
)
|
||||
|
||||
// UnmarshalRichText parses a RichText tree from JSON: a string, an array, or
|
||||
// a typed object. Unknown object types that carry a text field are preserved
|
||||
// as RichTextWrap so their nested text remains usable; unmodeled fields are
|
||||
// discarded. The fallback representation is subject to change in v2 so unknown
|
||||
// fields can be preserved losslessly.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func UnmarshalRichText(data []byte) (RichText, error) {
|
||||
if err := validateRichJSON(data); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return unmarshalRichText(data)
|
||||
}
|
||||
|
||||
func unmarshalRichText(data []byte) (RichText, error) {
|
||||
if bytes.Equal(bytes.TrimSpace(data), []byte("null")) {
|
||||
return nil, fmt.Errorf("richtext: null is not a rich text value")
|
||||
}
|
||||
// 1. string
|
||||
var s string
|
||||
if err := json.Unmarshal(data, &s); err == nil {
|
||||
return RichTextPlain(s), nil
|
||||
}
|
||||
// 2. array
|
||||
var raw []json.RawMessage
|
||||
if err := json.Unmarshal(data, &raw); err == nil {
|
||||
arr := make(RichTextArray, len(raw))
|
||||
for i, it := range raw {
|
||||
rt, err := unmarshalRichText(it)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
arr[i] = rt
|
||||
}
|
||||
return arr, nil
|
||||
}
|
||||
// 3. object -> dispatch on type, grabbing the raw text along the way
|
||||
var head struct {
|
||||
Type string `json:"type"`
|
||||
Text json.RawMessage `json:"text"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &head); err != nil {
|
||||
return nil, fmt.Errorf("richtext: not a string, array or object: %w", err)
|
||||
}
|
||||
|
||||
// Recursively parse the nested text, if any.
|
||||
var inner RichText
|
||||
if len(head.Text) > 0 {
|
||||
var err error
|
||||
if inner, err = unmarshalRichText(head.Text); err != nil {
|
||||
return nil, fmt.Errorf("richtext %q: bad text: %w", head.Type, err)
|
||||
}
|
||||
}
|
||||
|
||||
if richTextWrapTags[head.Type] {
|
||||
return RichTextWrap{Tag: head.Type, Text: inner}, nil
|
||||
}
|
||||
|
||||
switch head.Type {
|
||||
case "url":
|
||||
var v struct {
|
||||
URL string `json:"url"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextURL{inner, v.URL}, nil
|
||||
case "email_address":
|
||||
var v struct {
|
||||
V string `json:"email_address"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextEmailAddress{inner, v.V}, nil
|
||||
case "phone_number":
|
||||
var v struct {
|
||||
V string `json:"phone_number"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextPhoneNumber{inner, v.V}, nil
|
||||
case "bank_card_number":
|
||||
var v struct {
|
||||
V string `json:"bank_card_number"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextBankCardNumber{inner, v.V}, nil
|
||||
case "mention":
|
||||
var v struct {
|
||||
V string `json:"username"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextMention{inner, v.V}, nil
|
||||
case "hashtag":
|
||||
var v struct {
|
||||
V string `json:"hashtag"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextHashtag{inner, v.V}, nil
|
||||
case "cashtag":
|
||||
var v struct {
|
||||
V string `json:"cashtag"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextCashtag{inner, v.V}, nil
|
||||
case "bot_command":
|
||||
var v struct {
|
||||
V string `json:"bot_command"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextBotCommand{inner, v.V}, nil
|
||||
case "anchor_link":
|
||||
var v struct {
|
||||
V string `json:"anchor_name"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextAnchorLink{inner, v.V}, nil
|
||||
case "reference":
|
||||
var v struct {
|
||||
V string `json:"name"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextReference{inner, v.V}, nil
|
||||
case "reference_link":
|
||||
var v struct {
|
||||
V string `json:"reference_name"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextReferenceLink{inner, v.V}, nil
|
||||
case "date_time":
|
||||
var v struct {
|
||||
UnixTime int64 `json:"unix_time"`
|
||||
DateTimeFormat string `json:"date_time_format"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextDateTime{inner, v.UnixTime, v.DateTimeFormat}, nil
|
||||
case "text_mention":
|
||||
var v struct {
|
||||
User User `json:"user"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextTextMention{inner, v.User}, nil
|
||||
|
||||
// --- leaves without text ---
|
||||
case "custom_emoji":
|
||||
var v struct {
|
||||
ID string `json:"custom_emoji_id"`
|
||||
Alt string `json:"alternative_text"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextCustomEmoji{v.ID, v.Alt}, nil
|
||||
case "mathematical_expression":
|
||||
var v struct {
|
||||
Expression string `json:"expression"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextMathematicalExpression{v.Expression}, nil
|
||||
case "anchor":
|
||||
var v struct {
|
||||
Name string `json:"name"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichTextAnchor{v.Name}, nil
|
||||
|
||||
default:
|
||||
// forward-compat: keep an unknown tag with a text field as
|
||||
// RichTextWrap; without text it is an error (the shape cannot be guessed).
|
||||
if inner != nil {
|
||||
return RichTextWrap{Tag: head.Type, Text: inner}, nil
|
||||
}
|
||||
return nil, fmt.Errorf("richtext: unknown type %q", head.Type)
|
||||
}
|
||||
}
|
||||
|
||||
// UnmarshalRichBlock parses a single RichBlock from JSON, dispatching on the
|
||||
// type tag. Unknown types that carry a text field are decoded as RichBlockWrap
|
||||
// so their nested text remains usable; unmodeled fields are discarded. The
|
||||
// fallback representation is subject to change in v2 for lossless round trips.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func UnmarshalRichBlock(data []byte) (RichBlock, error) {
|
||||
if err := validateRichJSON(data); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return unmarshalRichBlock(data)
|
||||
}
|
||||
|
||||
func unmarshalRichBlock(data []byte) (RichBlock, error) {
|
||||
var head struct {
|
||||
Type string `json:"type"`
|
||||
Text json.RawMessage `json:"text"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &head); err != nil {
|
||||
return nil, fmt.Errorf("richblock: %w", err)
|
||||
}
|
||||
|
||||
if richBlockWrapTags[head.Type] {
|
||||
text, err := parseOptRichText(head.Text)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("richblock %q: text: %w", head.Type, err)
|
||||
}
|
||||
return RichBlockWrap{Tag: head.Type, Text: text}, nil
|
||||
}
|
||||
|
||||
switch head.Type {
|
||||
case "heading":
|
||||
var v struct {
|
||||
Size int `json:"size"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
text, err := parseOptRichText(head.Text)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("richblock %q: text: %w", head.Type, err)
|
||||
}
|
||||
return RichBlockSectionHeading{text, v.Size}, nil
|
||||
|
||||
case "pre":
|
||||
var v struct {
|
||||
Language string `json:"language"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
text, err := parseOptRichText(head.Text)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("richblock %q: text: %w", head.Type, err)
|
||||
}
|
||||
return RichBlockPreformatted{text, v.Language}, nil
|
||||
|
||||
case "blockquote":
|
||||
var raw struct {
|
||||
Blocks json.RawMessage `json:"blocks"`
|
||||
Credit json.RawMessage `json:"credit"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &raw); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
blocks, err := unmarshalRichBlocks(raw.Blocks)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
credit, err := parseOptRichText(raw.Credit)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("richblock %q: credit: %w", head.Type, err)
|
||||
}
|
||||
return RichBlockQuotation{blocks, credit}, nil
|
||||
|
||||
case "pullquote":
|
||||
var raw struct {
|
||||
Credit json.RawMessage `json:"credit"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &raw); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
text, err := parseOptRichText(head.Text)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("richblock %q: text: %w", head.Type, err)
|
||||
}
|
||||
credit, err := parseOptRichText(raw.Credit)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("richblock %q: credit: %w", head.Type, err)
|
||||
}
|
||||
return RichBlockPullQuotation{text, credit}, nil
|
||||
|
||||
case "list":
|
||||
var v struct {
|
||||
Items []RichBlockListItem `json:"items"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichBlockList{v.Items}, nil
|
||||
|
||||
case "collage":
|
||||
var raw struct {
|
||||
Blocks json.RawMessage `json:"blocks"`
|
||||
Caption *RichBlockCaption `json:"caption"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &raw); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
blocks, err := unmarshalRichBlocks(raw.Blocks)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichBlockCollage{blocks, raw.Caption}, nil
|
||||
|
||||
case "slideshow":
|
||||
var raw struct {
|
||||
Blocks json.RawMessage `json:"blocks"`
|
||||
Caption *RichBlockCaption `json:"caption"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &raw); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
blocks, err := unmarshalRichBlocks(raw.Blocks)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichBlockSlideshow{blocks, raw.Caption}, nil
|
||||
|
||||
case "details":
|
||||
var raw struct {
|
||||
Summary json.RawMessage `json:"summary"`
|
||||
Blocks json.RawMessage `json:"blocks"`
|
||||
IsOpen bool `json:"is_open"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &raw); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
summary, err := parseOptRichText(raw.Summary)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("richblock %q: summary: %w", head.Type, err)
|
||||
}
|
||||
blocks, err := unmarshalRichBlocks(raw.Blocks)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichBlockDetails{summary, blocks, raw.IsOpen}, nil
|
||||
|
||||
case "table":
|
||||
var raw struct {
|
||||
Cells [][]RichBlockTableCell `json:"cells"`
|
||||
IsBordered bool `json:"is_bordered"`
|
||||
IsStriped bool `json:"is_striped"`
|
||||
Caption json.RawMessage `json:"caption"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &raw); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
caption, err := parseOptRichText(raw.Caption)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("richblock %q: caption: %w", head.Type, err)
|
||||
}
|
||||
return RichBlockTable{raw.Cells, raw.IsBordered, raw.IsStriped, caption}, nil
|
||||
|
||||
case "map":
|
||||
var v struct {
|
||||
Location Location `json:"location"`
|
||||
Zoom int `json:"zoom"`
|
||||
Width int `json:"width"`
|
||||
Height int `json:"height"`
|
||||
Caption *RichBlockCaption `json:"caption"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichBlockMap{v.Location, v.Zoom, v.Width, v.Height, v.Caption}, nil
|
||||
|
||||
case "photo":
|
||||
var v struct {
|
||||
Photo []PhotoSize `json:"photo"`
|
||||
HasSpoiler bool `json:"has_spoiler"`
|
||||
Caption *RichBlockCaption `json:"caption"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichBlockPhoto{v.Photo, v.HasSpoiler, v.Caption}, nil
|
||||
|
||||
case "video":
|
||||
var v struct {
|
||||
Video Video `json:"video"`
|
||||
HasSpoiler bool `json:"has_spoiler"`
|
||||
Caption *RichBlockCaption `json:"caption"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichBlockVideo{v.Video, v.HasSpoiler, v.Caption}, nil
|
||||
|
||||
case "audio":
|
||||
var v struct {
|
||||
Audio Audio `json:"audio"`
|
||||
Caption *RichBlockCaption `json:"caption"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichBlockAudio{v.Audio, v.Caption}, nil
|
||||
|
||||
case "animation":
|
||||
var v struct {
|
||||
Animation Animation `json:"animation"`
|
||||
HasSpoiler bool `json:"has_spoiler"`
|
||||
Caption *RichBlockCaption `json:"caption"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichBlockAnimation{v.Animation, v.HasSpoiler, v.Caption}, nil
|
||||
|
||||
case "voice_note":
|
||||
var v struct {
|
||||
VoiceNote Voice `json:"voice_note"`
|
||||
Caption *RichBlockCaption `json:"caption"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichBlockVoiceNote{v.VoiceNote, v.Caption}, nil
|
||||
|
||||
case "divider":
|
||||
return RichBlockDivider{}, nil
|
||||
|
||||
case "mathematical_expression":
|
||||
var v struct {
|
||||
Expression string `json:"expression"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichBlockMathematicalExpression{v.Expression}, nil
|
||||
|
||||
case "anchor":
|
||||
var v struct {
|
||||
Name string `json:"name"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &v); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return RichBlockAnchor{v.Name}, nil
|
||||
|
||||
default:
|
||||
// forward-compat: unknown type with text -> RichBlockWrap, without text -> error.
|
||||
if text, err := parseOptRichText(head.Text); err == nil && text != nil {
|
||||
return RichBlockWrap{Tag: head.Type, Text: text}, nil
|
||||
}
|
||||
return nil, fmt.Errorf("richblock: unknown type %q", head.Type)
|
||||
}
|
||||
}
|
||||
|
||||
// UnmarshalRichMessage parses a root RichMessage from JSON.
|
||||
//
|
||||
// For v1 compatibility, missing and null blocks are accepted as an empty
|
||||
// message. This permissive behavior is subject to change in v2; use
|
||||
// UnmarshalRichMessageStrict when validating untrusted input.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func UnmarshalRichMessage(data []byte) (RichMessage, error) {
|
||||
if err := validateRichJSON(data); err != nil {
|
||||
return RichMessage{}, err
|
||||
}
|
||||
return unmarshalRichMessage(data)
|
||||
}
|
||||
|
||||
func unmarshalRichMessage(data []byte) (RichMessage, error) {
|
||||
var raw struct {
|
||||
Blocks json.RawMessage `json:"blocks"`
|
||||
IsRTL bool `json:"is_rtl"`
|
||||
}
|
||||
if err := json.Unmarshal(data, &raw); err != nil {
|
||||
return RichMessage{}, fmt.Errorf("richmessage: %w", err)
|
||||
}
|
||||
blocks, err := unmarshalRichBlocks(raw.Blocks)
|
||||
if err != nil {
|
||||
return RichMessage{}, err
|
||||
}
|
||||
return RichMessage{blocks, raw.IsRTL}, nil
|
||||
}
|
||||
|
||||
// UnmarshalRichMessageStrict parses a RichMessage and requires a non-null blocks array.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func UnmarshalRichMessageStrict(data []byte) (RichMessage, error) {
|
||||
if err := validateRichJSON(data); err != nil {
|
||||
return RichMessage{}, err
|
||||
}
|
||||
var root map[string]json.RawMessage
|
||||
if err := json.Unmarshal(data, &root); err != nil {
|
||||
return RichMessage{}, fmt.Errorf("richmessage: %w", err)
|
||||
}
|
||||
blocks, ok := root["blocks"]
|
||||
if !ok || bytes.Equal(bytes.TrimSpace(blocks), []byte("null")) {
|
||||
return RichMessage{}, errors.New("richmessage: blocks must be a non-null array")
|
||||
}
|
||||
var rawBlocks []json.RawMessage
|
||||
if err := json.Unmarshal(blocks, &rawBlocks); err != nil {
|
||||
return RichMessage{}, errors.New("richmessage: blocks must be an array")
|
||||
}
|
||||
return unmarshalRichMessage(data)
|
||||
}
|
||||
|
||||
// UnmarshalJSON implements json.Unmarshaler.
|
||||
//
|
||||
// Since: Bot API 10.1
|
||||
func (m *RichMessage) UnmarshalJSON(data []byte) error {
|
||||
parsed, err := UnmarshalRichMessage(data)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
*m = parsed
|
||||
return nil
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Internal helpers
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
// Optional RichText fields treat absent and null values as nil.
|
||||
func parseOptRichText(raw json.RawMessage) (RichText, error) {
|
||||
if len(raw) == 0 || string(raw) == "null" {
|
||||
return nil, nil
|
||||
}
|
||||
return unmarshalRichText(raw)
|
||||
}
|
||||
|
||||
func unmarshalRichBlocks(raw json.RawMessage) ([]RichBlock, error) {
|
||||
if len(raw) == 0 || string(raw) == "null" {
|
||||
return nil, nil
|
||||
}
|
||||
var raws []json.RawMessage
|
||||
if err := json.Unmarshal(raw, &raws); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
blocks := make([]RichBlock, len(raws))
|
||||
for i, r := range raws {
|
||||
b, err := unmarshalRichBlock(r)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
blocks[i] = b
|
||||
}
|
||||
return blocks, nil
|
||||
}
|
||||
|
||||
func validateRichJSON(data []byte) error {
|
||||
decoder := json.NewDecoder(bytes.NewReader(data))
|
||||
depth := 0
|
||||
nodes := 0
|
||||
for {
|
||||
token, err := decoder.Token()
|
||||
if errors.Is(err, io.EOF) {
|
||||
return nil
|
||||
}
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
nodes++
|
||||
if nodes > maximumRichJSONNodes {
|
||||
return fmt.Errorf("%w: maximum %d", ErrRichJSONNodes, maximumRichJSONNodes)
|
||||
}
|
||||
delim, ok := token.(json.Delim)
|
||||
if !ok {
|
||||
continue
|
||||
}
|
||||
switch delim {
|
||||
case '{', '[':
|
||||
depth++
|
||||
if depth > maximumRichJSONDepth {
|
||||
return fmt.Errorf("%w: maximum %d", ErrRichJSONDepth, maximumRichJSONDepth)
|
||||
}
|
||||
case '}', ']':
|
||||
depth--
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,294 @@
|
||||
package tgapi
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func roundtripRichBlock(t *testing.T, in RichBlock) {
|
||||
t.Helper()
|
||||
b, err := json.Marshal(in)
|
||||
if err != nil {
|
||||
t.Fatalf("marshal: %v", err)
|
||||
}
|
||||
out, err := UnmarshalRichBlock(b)
|
||||
if err != nil {
|
||||
t.Fatalf("unmarshal %s: %v", b, err)
|
||||
}
|
||||
b2, err := json.Marshal(out)
|
||||
if err != nil {
|
||||
t.Fatalf("remarshal: %v", err)
|
||||
}
|
||||
if string(b) != string(b2) {
|
||||
t.Fatalf("not stable:\n %s\n %s", b, b2)
|
||||
}
|
||||
}
|
||||
|
||||
func par(s string) RichBlockWrap { return RichBlockWrap{"paragraph", RichTextPlain(s)} }
|
||||
|
||||
func TestRichBlockRoundtrip(t *testing.T) {
|
||||
cases := []RichBlock{
|
||||
// wrap blocks
|
||||
par("Hello, world"),
|
||||
RichBlockWrap{"footer", RichTextPlain("© 2024")},
|
||||
RichBlockWrap{"thinking", RichTextPlain("Let me reason step by step.")},
|
||||
|
||||
// heading
|
||||
RichBlockSectionHeading{RichTextWrap{"bold", RichTextPlain("Chapter 1")}, 1},
|
||||
RichBlockSectionHeading{RichTextPlain("smallest"), 6},
|
||||
|
||||
// preformatted
|
||||
RichBlockPreformatted{RichTextPlain(`fmt.Println("hi")`), "go"},
|
||||
RichBlockPreformatted{Text: RichTextPlain("no language")},
|
||||
|
||||
// quotations
|
||||
RichBlockQuotation{[]RichBlock{par("To be or not to be")}, RichTextPlain("Shakespeare")},
|
||||
RichBlockQuotation{Blocks: []RichBlock{par("anonymous"), par("second block")}},
|
||||
RichBlockPullQuotation{Text: RichTextPlain("Pull me")},
|
||||
RichBlockPullQuotation{RichTextPlain("Wisdom"), RichTextWrap{"italic", RichTextPlain("someone")}},
|
||||
|
||||
// list: label is the ready-made marker, numbering lives on the items
|
||||
RichBlockList{
|
||||
Items: []RichBlockListItem{
|
||||
{Label: "c.", Blocks: []RichBlock{par("item 3")}, Value: 3, Type: "a"},
|
||||
{Label: "vii.", Blocks: []RichBlock{par("item 7")}, Value: 7, Type: "i"},
|
||||
},
|
||||
},
|
||||
RichBlockList{
|
||||
Items: []RichBlockListItem{
|
||||
{Label: "•", Blocks: []RichBlock{par("todo")}, HasCheckbox: true},
|
||||
{Label: "•", Blocks: []RichBlock{par("done")}, HasCheckbox: true, IsChecked: true},
|
||||
},
|
||||
},
|
||||
|
||||
// collage and slideshow
|
||||
RichBlockCollage{
|
||||
Blocks: []RichBlock{RichBlockPhoto{Photo: []PhotoSize{{FileID: "abc123", Width: 100, Height: 100}}}},
|
||||
Caption: &RichBlockCaption{Text: RichTextPlain("A photo")},
|
||||
},
|
||||
RichBlockSlideshow{
|
||||
Blocks: []RichBlock{
|
||||
RichBlockVideo{Video: Video{FileID: "vid1", Width: 640, Height: 480, Duration: 10}},
|
||||
},
|
||||
},
|
||||
|
||||
// details
|
||||
RichBlockDetails{
|
||||
Summary: RichTextPlain("Spoiler"),
|
||||
Blocks: []RichBlock{par("Hidden content")},
|
||||
},
|
||||
RichBlockDetails{
|
||||
Summary: RichTextWrap{"bold", RichTextPlain("Open details")},
|
||||
Blocks: []RichBlock{RichBlockDivider{}, par("content")},
|
||||
IsOpen: true,
|
||||
},
|
||||
|
||||
// table: text cells, headers, spans, alignment, invisible cell
|
||||
RichBlockTable{
|
||||
Cells: [][]RichBlockTableCell{
|
||||
{
|
||||
{Text: RichTextPlain("Name"), IsHeader: true, Align: "center"},
|
||||
{Text: RichTextPlain("Score"), IsHeader: true, VAlign: "middle"},
|
||||
},
|
||||
{
|
||||
{Text: RichTextPlain("Alice"), ColSpan: 2},
|
||||
},
|
||||
{
|
||||
{}, // invisible cell
|
||||
{Text: RichTextPlain("42"), RowSpan: 2},
|
||||
},
|
||||
},
|
||||
IsBordered: true,
|
||||
Caption: RichTextPlain("Results"),
|
||||
},
|
||||
|
||||
// map
|
||||
RichBlockMap{
|
||||
Location: Location{Latitude: 55.7558, Longitude: 37.6173},
|
||||
Zoom: 13, Width: 800, Height: 400,
|
||||
Caption: &RichBlockCaption{Text: RichTextPlain("Moscow"), Credit: RichTextPlain("OpenStreetMap")},
|
||||
},
|
||||
|
||||
// media
|
||||
RichBlockPhoto{
|
||||
Photo: []PhotoSize{{FileID: "p1", Width: 1280, Height: 720}},
|
||||
HasSpoiler: true,
|
||||
Caption: &RichBlockCaption{Text: RichTextPlain("A cat"), Credit: RichTextWrap{"italic", RichTextPlain("photographer")}},
|
||||
},
|
||||
RichBlockVideo{Video: Video{FileID: "v1", Width: 1920, Height: 1080, Duration: 30}, HasSpoiler: true},
|
||||
RichBlockAudio{
|
||||
Audio: Audio{FileID: "a1", Duration: 60},
|
||||
Caption: &RichBlockCaption{Text: RichTextPlain("Podcast ep. 1")},
|
||||
},
|
||||
RichBlockAnimation{Animation: Animation{FileID: "g1", Width: 320, Height: 240, Duration: 2}},
|
||||
RichBlockVoiceNote{VoiceNote: Voice{FileID: "vn1", Duration: 5}},
|
||||
|
||||
// leaves
|
||||
RichBlockDivider{},
|
||||
RichBlockMathematicalExpression{Expression: "E = mc^2"},
|
||||
RichBlockAnchor{Name: "section-2"},
|
||||
}
|
||||
for _, c := range cases {
|
||||
roundtripRichBlock(t, c)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRichMessageRoundtrip(t *testing.T) {
|
||||
for _, msg := range []RichMessage{
|
||||
{
|
||||
Blocks: []RichBlock{
|
||||
RichBlockSectionHeading{RichTextPlain("Title"), 1},
|
||||
RichBlockWrap{"paragraph", RichTextArray{RichTextPlain("Some "), RichTextWrap{"bold", RichTextPlain("bold")}, RichTextPlain(" text")}},
|
||||
RichBlockDivider{},
|
||||
RichBlockList{
|
||||
Items: []RichBlockListItem{
|
||||
{Label: "1.", Blocks: []RichBlock{par("First")}, Value: 1, Type: "1"},
|
||||
{Label: "2.", Blocks: []RichBlock{par("Second")}, Value: 2, Type: "1"},
|
||||
},
|
||||
},
|
||||
RichBlockPhoto{
|
||||
Photo: []PhotoSize{{FileID: "img1", Width: 10, Height: 10}},
|
||||
Caption: &RichBlockCaption{Text: RichTextPlain("Fig. 1")},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
Blocks: []RichBlock{par("שלום")},
|
||||
IsRTL: true,
|
||||
},
|
||||
} {
|
||||
b, err := json.Marshal(msg)
|
||||
if err != nil {
|
||||
t.Fatalf("marshal: %v", err)
|
||||
}
|
||||
var out RichMessage
|
||||
if err := json.Unmarshal(b, &out); err != nil {
|
||||
t.Fatalf("unmarshal: %v", err)
|
||||
}
|
||||
b2, err := json.Marshal(out)
|
||||
if err != nil {
|
||||
t.Fatalf("remarshal: %v", err)
|
||||
}
|
||||
if string(b) != string(b2) {
|
||||
t.Fatalf("not stable:\n %s\n %s", b, b2)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestRichBlockTags(t *testing.T) {
|
||||
// tags per spec: heading, pre, blockquote, pullquote
|
||||
cases := map[string]RichBlock{
|
||||
"heading": RichBlockSectionHeading{RichTextPlain("h"), 2},
|
||||
"pre": RichBlockPreformatted{Text: RichTextPlain("x")},
|
||||
"blockquote": RichBlockQuotation{Blocks: []RichBlock{par("q")}},
|
||||
"pullquote": RichBlockPullQuotation{Text: RichTextPlain("p")},
|
||||
}
|
||||
for want, block := range cases {
|
||||
b, _ := json.Marshal(block)
|
||||
var m map[string]any
|
||||
_ = json.Unmarshal(b, &m)
|
||||
if m["type"] != want {
|
||||
t.Fatalf("expected type %q, got %s", want, b)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestRichBlockOptionalFieldsOmitted(t *testing.T) {
|
||||
// nil credit/caption and false flags must not appear in the JSON
|
||||
for _, c := range []struct {
|
||||
block RichBlock
|
||||
bad []string
|
||||
}{
|
||||
{RichBlockQuotation{Blocks: []RichBlock{par("q")}}, []string{"credit"}},
|
||||
{RichBlockPullQuotation{Text: RichTextPlain("p")}, []string{"credit"}},
|
||||
{RichBlockPhoto{Photo: []PhotoSize{{FileID: "p"}}}, []string{"caption", "has_spoiler"}},
|
||||
{RichBlockTable{Cells: [][]RichBlockTableCell{}}, []string{"caption", "is_bordered", "is_striped"}},
|
||||
{RichBlockDetails{Summary: RichTextPlain("s")}, []string{"is_open"}},
|
||||
} {
|
||||
b, _ := json.Marshal(c.block)
|
||||
for _, key := range c.bad {
|
||||
if strings.Contains(string(b), `"`+key+`"`) {
|
||||
t.Fatalf("%T: %q must be omitted: %s", c.block, key, b)
|
||||
}
|
||||
}
|
||||
}
|
||||
// same for RichMessage.is_rtl
|
||||
b, _ := json.Marshal(RichMessage{Blocks: []RichBlock{par("x")}})
|
||||
if strings.Contains(string(b), "is_rtl") {
|
||||
t.Fatalf("is_rtl must be omitted: %s", b)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRichBlockDividerHasNoContent(t *testing.T) {
|
||||
b, _ := json.Marshal(RichBlockDivider{})
|
||||
var m map[string]any
|
||||
_ = json.Unmarshal(b, &m)
|
||||
if len(m) != 1 {
|
||||
t.Fatalf("divider must only have type field: %s", b)
|
||||
}
|
||||
if m["type"] != "divider" {
|
||||
t.Fatalf("unexpected type: %s", b)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRichBlockUnknownTypeWithTextIsForwardCompat(t *testing.T) {
|
||||
raw := []byte(`{"type":"future_tag","text":"hello"}`)
|
||||
b, err := UnmarshalRichBlock(raw)
|
||||
if err != nil {
|
||||
t.Fatalf("forward-compat failed: %v", err)
|
||||
}
|
||||
w, ok := b.(RichBlockWrap)
|
||||
if !ok || w.Tag != "future_tag" {
|
||||
t.Fatalf("expected RichBlockWrap{future_tag}, got %T", b)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRichBlockUnknownTypeWithoutTextIsError(t *testing.T) {
|
||||
raw := []byte(`{"type":"mystery_leaf","value":42}`)
|
||||
_, err := UnmarshalRichBlock(raw)
|
||||
if err == nil {
|
||||
t.Fatal("expected error for unknown type without text")
|
||||
}
|
||||
}
|
||||
|
||||
func TestUnmarshalRichBlockRejectsMalformedFields(t *testing.T) {
|
||||
tests := []string{
|
||||
`{"type":"heading","size":"large","text":"hello"}`,
|
||||
`{"type":"blockquote","blocks":[],"credit":{"type":"date_time","text":"now","unix_time":"soon"}}`,
|
||||
`{"type":"table","cells":[],"caption":{"type":"date_time","text":"now","unix_time":"soon"}}`,
|
||||
}
|
||||
for _, raw := range tests {
|
||||
t.Run(raw, func(t *testing.T) {
|
||||
if _, err := UnmarshalRichBlock([]byte(raw)); err == nil {
|
||||
t.Fatal("expected malformed rich block to be rejected")
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestUnmarshalRichMessageStrict(t *testing.T) {
|
||||
for _, raw := range []string{`null`, `{}`, `{"blocks":null}`, `{"blocks":{}}`} {
|
||||
t.Run(raw, func(t *testing.T) {
|
||||
if _, err := UnmarshalRichMessageStrict([]byte(raw)); err == nil {
|
||||
t.Fatal("expected strict decoder error")
|
||||
}
|
||||
})
|
||||
}
|
||||
if _, err := UnmarshalRichMessageStrict([]byte(`{"blocks":[]}`)); err != nil {
|
||||
t.Fatalf("strict decoder rejected an empty blocks array: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRichJSONStructuralLimits(t *testing.T) {
|
||||
deep := strings.Repeat("[", maximumRichJSONDepth+1) + `"x"` + strings.Repeat("]", maximumRichJSONDepth+1)
|
||||
if _, err := UnmarshalRichText([]byte(deep)); !errors.Is(err, ErrRichJSONDepth) {
|
||||
t.Fatalf("expected ErrRichJSONDepth, got %v", err)
|
||||
}
|
||||
|
||||
wide := "[" + strings.Repeat("0,", maximumRichJSONNodes) + "0]"
|
||||
if _, err := UnmarshalRichText([]byte(wide)); !errors.Is(err, ErrRichJSONNodes) {
|
||||
t.Fatalf("expected ErrRichJSONNodes, got %v", err)
|
||||
}
|
||||
}
|
||||
+25
-4
@@ -3,13 +3,18 @@ package tgapi
|
||||
import "context"
|
||||
|
||||
// GetStarTransactions holds parameters for the getStarTransactions method.
|
||||
// Since: Bot API 7.5
|
||||
// See https://core.telegram.org/bots/api#getstartransactions
|
||||
type GetStarTransactions struct {
|
||||
// Offset Optional. Number of transactions to skip in the response
|
||||
Offset int `json:"offset,omitempty"`
|
||||
Limit int `json:"limit,omitempty"`
|
||||
// Limit Optional. The maximum number of transactions to be retrieved. Values between 1-100 are accepted.
|
||||
// Defaults to 100.
|
||||
Limit int `json:"limit,omitempty"`
|
||||
}
|
||||
|
||||
// GetMyStarBalance returns the bot's Telegram Star balance.
|
||||
// Since: Bot API 7.5
|
||||
// See https://core.telegram.org/bots/api#getmystarbalance
|
||||
func (api *API) GetMyStarBalance() (StarAmount, error) {
|
||||
req := NewRequest[StarAmount]("getMyStarBalance", NoParams)
|
||||
@@ -17,6 +22,7 @@ func (api *API) GetMyStarBalance() (StarAmount, error) {
|
||||
}
|
||||
|
||||
// GetMyStarBalanceWithContext is the context-aware variant of GetMyStarBalance.
|
||||
// Since: Bot API 7.5
|
||||
// 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) {
|
||||
@@ -25,6 +31,7 @@ func (api *API) GetMyStarBalanceWithContext(ctx context.Context) (StarAmount, er
|
||||
}
|
||||
|
||||
// GetStarTransactions returns Telegram Star transactions for the bot.
|
||||
// Since: Bot API 7.5
|
||||
// See https://core.telegram.org/bots/api#getstartransactions
|
||||
func (api *API) GetStarTransactions(params GetStarTransactions) (StarTransactions, error) {
|
||||
req := NewRequest[StarTransactions]("getStarTransactions", params)
|
||||
@@ -32,6 +39,7 @@ func (api *API) GetStarTransactions(params GetStarTransactions) (StarTransaction
|
||||
}
|
||||
|
||||
// GetStarTransactionsWithContext is the context-aware variant of GetStarTransactions.
|
||||
// Since: Bot API 7.5
|
||||
// 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) {
|
||||
@@ -40,13 +48,17 @@ func (api *API) GetStarTransactionsWithContext(ctx context.Context, params GetSt
|
||||
}
|
||||
|
||||
// RefundStarPayment holds parameters for the refundStarPayment method.
|
||||
// Since: Bot API 7.4
|
||||
// See https://core.telegram.org/bots/api#refundstarpayment
|
||||
type RefundStarPayment struct {
|
||||
UserID int64 `json:"user_id"`
|
||||
// UserID Required. Identifier of the user whose payment will be refunded
|
||||
UserID int64 `json:"user_id"`
|
||||
// TelegramPaymentChargeID Required. Telegram payment identifier
|
||||
TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
|
||||
}
|
||||
|
||||
// RefundStarPayment refunds a successful Telegram Stars payment.
|
||||
// Since: Bot API 7.4
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#refundstarpayment
|
||||
func (api *API) RefundStarPayment(params RefundStarPayment) (bool, error) {
|
||||
@@ -55,6 +67,7 @@ func (api *API) RefundStarPayment(params RefundStarPayment) (bool, error) {
|
||||
}
|
||||
|
||||
// RefundStarPaymentWithContext is the context-aware variant of RefundStarPayment.
|
||||
// Since: Bot API 7.4
|
||||
// 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) {
|
||||
@@ -63,14 +76,21 @@ func (api *API) RefundStarPaymentWithContext(ctx context.Context, params RefundS
|
||||
}
|
||||
|
||||
// EditUserStarSubscription holds parameters for the editUserStarSubscription method.
|
||||
// Since: Bot API 8.0
|
||||
// See https://core.telegram.org/bots/api#edituserstarsubscription
|
||||
type EditUserStarSubscription struct {
|
||||
UserID int64 `json:"user_id"`
|
||||
// UserID Required. Identifier of the user whose subscription will be edited
|
||||
UserID int64 `json:"user_id"`
|
||||
// TelegramPaymentChargeID Required. Telegram payment identifier for the subscription
|
||||
TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
|
||||
IsCanceled bool `json:"is_canceled"`
|
||||
// IsCanceled Required. Pass True to cancel extension of the user subscription; the subscription must be
|
||||
// active up to the end of the current subscription period. Pass False to allow the user to re-enable a
|
||||
// subscription that was previously canceled by the bot.
|
||||
IsCanceled bool `json:"is_canceled"`
|
||||
}
|
||||
|
||||
// EditUserStarSubscription cancels or re-enables a user star subscription extension.
|
||||
// Since: Bot API 8.0
|
||||
// Returns true on success.
|
||||
// See https://core.telegram.org/bots/api#edituserstarsubscription
|
||||
func (api *API) EditUserStarSubscription(params EditUserStarSubscription) (bool, error) {
|
||||
@@ -79,6 +99,7 @@ func (api *API) EditUserStarSubscription(params EditUserStarSubscription) (bool,
|
||||
}
|
||||
|
||||
// EditUserStarSubscriptionWithContext is the context-aware variant of EditUserStarSubscription.
|
||||
// Since: Bot API 8.0
|
||||
// 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) {
|
||||
|
||||
+20
-6
@@ -1,18 +1,32 @@
|
||||
package tgapi
|
||||
|
||||
// StarTransaction describes a Telegram Star transaction.
|
||||
// Since: Bot API 7.5
|
||||
// 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"`
|
||||
// ID Unique identifier of the transaction. Coincides with the identifier of the original transaction for
|
||||
// refund transactions. Coincides with SuccessfulPayment.telegram_payment_charge_id for successful incoming
|
||||
// payments from users.
|
||||
ID string `json:"id"`
|
||||
// Amount Integer amount of Telegram Stars transferred by the transaction
|
||||
Amount int `json:"amount"`
|
||||
// NanostarAmount Optional. The number of 1/1000000000 shares of Telegram Stars transferred by the
|
||||
// transaction; from 0 to 999999999
|
||||
NanostarAmount int `json:"nanostar_amount,omitempty"`
|
||||
// Date Date the transaction was created in Unix time
|
||||
Date int `json:"date"`
|
||||
// Source Optional. Source of an incoming transaction (e.g., a user purchasing goods or services, Fragment
|
||||
// refunding a failed withdrawal). Only for incoming transactions.
|
||||
Source map[string]any `json:"source,omitempty"`
|
||||
// Receiver Optional. Receiver of an outgoing transaction (e.g., a user for a purchase refund, Fragment for
|
||||
// a withdrawal). Only for outgoing transactions.
|
||||
Receiver map[string]any `json:"receiver,omitempty"`
|
||||
}
|
||||
|
||||
// StarTransactions contains a list of Telegram Star transactions.
|
||||
// Since: Bot API 7.5
|
||||
// See https://core.telegram.org/bots/api#startransactions
|
||||
type StarTransactions struct {
|
||||
// Transactions The list of transactions
|
||||
Transactions []StarTransaction `json:"transactions"`
|
||||
}
|
||||
|
||||
+170
-36
@@ -3,26 +3,59 @@ package tgapi
|
||||
import "context"
|
||||
|
||||
// SendSticker holds parameters for the sendSticker method.
|
||||
// Since: Bot API 1.3
|
||||
// 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"`
|
||||
// BusinessConnectionID Optional. Unique identifier of the business connection on behalf of which the
|
||||
// message will be sent
|
||||
BusinessConnectionID string `json:"business_connection_id,omitempty"`
|
||||
// ChatID Required. Unique identifier for the target chat or username of the target bot, supergroup or
|
||||
// channel in the format @username
|
||||
ChatID int64 `json:"chat_id"`
|
||||
// MessageThreadID Optional. Unique identifier for the target message thread (topic) of a forum; for forum
|
||||
// supergroups and private chats of bots with forum topic mode enabled only
|
||||
MessageThreadID int `json:"message_thread_id,omitempty"`
|
||||
// DirectMessagesTopicID Optional. Identifier of the direct messages topic to which the message will be
|
||||
// sent; required if the message is sent to a direct messages chat
|
||||
DirectMessagesTopicID int `json:"direct_messages_topic_id,omitempty"`
|
||||
// ReceiverUserID identifies the user who can see the ephemeral message.
|
||||
ReceiverUserID int64 `json:"receiver_user_id,omitempty"` // Since: Bot API 10.2
|
||||
// CallbackQueryID identifies the callback query that triggered an ephemeral response.
|
||||
CallbackQueryID string `json:"callback_query_id,omitempty"` // Since: Bot API 10.2
|
||||
|
||||
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"`
|
||||
// Sticker Required. Sticker to send. Pass a file_id as String to send a file that exists on the Telegram
|
||||
// servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the
|
||||
// Internet, or upload a new .WEBP, .TGS, or .WEBM sticker using multipart/form-data. More information on
|
||||
// Sending Files ». Video and animated stickers can't be sent via an HTTP URL.
|
||||
Sticker string `json:"sticker"`
|
||||
// Emoji Optional. Emoji associated with the sticker; only for just uploaded stickers
|
||||
Emoji string `json:"emoji,omitempty"`
|
||||
// DisableNotification Optional. Sends the message silently. Users will receive a notification with no
|
||||
// sound.
|
||||
DisableNotification bool `json:"disable_notification,omitempty"`
|
||||
// ProtectContent Optional. Protects the contents of the sent message from forwarding and saving
|
||||
ProtectContent bool `json:"protect_content,omitempty"`
|
||||
// AllowPaidBroadcast Optional. Pass True to allow up to 1000 messages per second, ignoring broadcasting
|
||||
// limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's
|
||||
// balance.
|
||||
AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"`
|
||||
// MessageEffectID Optional. Unique identifier of the message effect to be added to the message; for private
|
||||
// chats only
|
||||
MessageEffectID string `json:"message_effect_id,omitempty"`
|
||||
|
||||
// SuggestedPostParameters Optional. A JSON-serialized object containing the parameters of the suggested
|
||||
// post to send; for direct messages chats only. If the message is sent as a reply to another suggested
|
||||
// post, then that suggested post is automatically declined.
|
||||
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
// ReplyParameters Optional. Description of the message to reply to
|
||||
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
|
||||
// ReplyMarkup Optional. Additional interface options. A JSON-serialized object for an inline keyboard,
|
||||
// custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
|
||||
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
|
||||
}
|
||||
|
||||
// SendSticker sends a static .WEBP, animated .TGS, or video .WEBM sticker.
|
||||
// Since: Bot API 1.3
|
||||
// See https://core.telegram.org/bots/api#sendsticker
|
||||
func (api *API) SendSticker(params SendSticker) (Message, error) {
|
||||
req := NewRequestWithChatID[Message]("sendSticker", params, params.ChatID)
|
||||
@@ -30,6 +63,7 @@ func (api *API) SendSticker(params SendSticker) (Message, error) {
|
||||
}
|
||||
|
||||
// SendStickerWithContext is the context-aware variant of SendSticker.
|
||||
// Since: Bot API 1.3
|
||||
// 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) {
|
||||
@@ -38,12 +72,15 @@ func (api *API) SendStickerWithContext(ctx context.Context, params SendSticker)
|
||||
}
|
||||
|
||||
// GetStickerSet holds parameters for the getStickerSet method.
|
||||
// Since: Bot API 3.2
|
||||
// See https://core.telegram.org/bots/api#getstickerset
|
||||
type GetStickerSet struct {
|
||||
// Name Required. Name of the sticker set
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
// GetStickerSet returns a sticker set by its name.
|
||||
// Since: Bot API 3.2
|
||||
// See https://core.telegram.org/bots/api#getstickerset
|
||||
func (api *API) GetStickerSet(params GetStickerSet) (StickerSet, error) {
|
||||
req := NewRequest[StickerSet]("getStickerSet", params)
|
||||
@@ -51,6 +88,7 @@ func (api *API) GetStickerSet(params GetStickerSet) (StickerSet, error) {
|
||||
}
|
||||
|
||||
// GetStickerSetWithContext is the context-aware variant of GetStickerSet.
|
||||
// Since: Bot API 3.2
|
||||
// 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) {
|
||||
@@ -59,12 +97,16 @@ func (api *API) GetStickerSetWithContext(ctx context.Context, params GetStickerS
|
||||
}
|
||||
|
||||
// GetCustomEmojiStickers holds parameters for the getCustomEmojiStickers method.
|
||||
// Since: Bot API 6.2
|
||||
// See https://core.telegram.org/bots/api#getcustomemojistickers
|
||||
type GetCustomEmojiStickers struct {
|
||||
// CustomEmojiIDs Required. A JSON-serialized list of custom emoji identifiers. At most 200 custom emoji
|
||||
// identifiers can be specified.
|
||||
CustomEmojiIDs []string `json:"custom_emoji_ids"`
|
||||
}
|
||||
|
||||
// GetCustomEmojiStickers returns information about custom emoji stickers by their IDs.
|
||||
// Since: Bot API 6.2
|
||||
// See https://core.telegram.org/bots/api#getcustomemojistickers
|
||||
func (api *API) GetCustomEmojiStickers(params GetCustomEmojiStickers) ([]Sticker, error) {
|
||||
req := NewRequest[[]Sticker]("getCustomEmojiStickers", params)
|
||||
@@ -72,6 +114,7 @@ func (api *API) GetCustomEmojiStickers(params GetCustomEmojiStickers) ([]Sticker
|
||||
}
|
||||
|
||||
// GetCustomEmojiStickersWithContext is the context-aware variant of GetCustomEmojiStickers.
|
||||
// Since: Bot API 6.2
|
||||
// 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) {
|
||||
@@ -80,13 +123,17 @@ func (api *API) GetCustomEmojiStickersWithContext(ctx context.Context, params Ge
|
||||
}
|
||||
|
||||
// UploadStickerFile holds parameters for the uploadStickerFile method.
|
||||
// Since: Bot API 3.2
|
||||
// See https://core.telegram.org/bots/api#uploadstickerfile
|
||||
type UploadStickerFile struct {
|
||||
UserID int64 `json:"user_id"`
|
||||
// UserID Required. User identifier of sticker file owner
|
||||
UserID int64 `json:"user_id"`
|
||||
// StickerFormat Required. Format of the sticker, must be one of “static”, “animated”, “video”
|
||||
StickerFormat InputStickerFormat `json:"sticker_format"`
|
||||
}
|
||||
|
||||
// UploadStickerFile uploads a sticker file for later use in sticker set methods.
|
||||
// Since: Bot API 3.2
|
||||
// sticker is the file to upload.
|
||||
// See https://core.telegram.org/bots/api#uploadstickerfile
|
||||
func (api *API) UploadStickerFile(params UploadStickerFile, sticker UploaderFile) (File, error) {
|
||||
@@ -99,6 +146,7 @@ func (api *API) UploadStickerFile(params UploadStickerFile, sticker UploaderFile
|
||||
}
|
||||
|
||||
// UploadStickerFileWithContext is the context-aware variant of UploadStickerFile.
|
||||
// Since: Bot API 3.2
|
||||
// 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) {
|
||||
@@ -111,18 +159,31 @@ func (api *API) UploadStickerFileWithContext(ctx context.Context, params UploadS
|
||||
}
|
||||
|
||||
// CreateNewStickerSet holds parameters for the createNewStickerSet method.
|
||||
// Since: Bot API 3.2
|
||||
// See https://core.telegram.org/bots/api#createnewstickerset
|
||||
type CreateNewStickerSet struct {
|
||||
UserID int64 `json:"user_id"`
|
||||
Name string `json:"name"`
|
||||
Title string `json:"title"`
|
||||
// UserID Required. User identifier of created sticker set owner
|
||||
UserID int64 `json:"user_id"`
|
||||
// Name Required. Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can
|
||||
// contain only English letters, digits and underscores. Must begin with a letter, can't contain consecutive
|
||||
// underscores and must end in "_by_<bot_username>". <bot_username> is case insensitive. 1-64 characters.
|
||||
Name string `json:"name"`
|
||||
// Title Required. Sticker set title, 1-64 characters
|
||||
Title string `json:"title"`
|
||||
|
||||
Stickers []InputSticker `json:"stickers"`
|
||||
StickerType StickerType `json:"sticker_type,omitempty"`
|
||||
NeedsRepainting bool `json:"needs_repainting,omitempty"`
|
||||
// Stickers Required. A JSON-serialized list of 1-50 initial stickers to be added to the sticker set
|
||||
Stickers []InputSticker `json:"stickers"`
|
||||
// StickerType Optional. Type of stickers in the set, pass “regular”, “mask”, or “custom_emoji”.
|
||||
// By default, a regular sticker set is created.
|
||||
StickerType StickerType `json:"sticker_type,omitempty"`
|
||||
// NeedsRepainting Optional. Pass True if stickers in the sticker set must be repainted to the color of text
|
||||
// when used in messages, the accent color if used as emoji status, white on chat photos, or another
|
||||
// appropriate color based on context; for custom emoji sticker sets only
|
||||
NeedsRepainting bool `json:"needs_repainting,omitempty"`
|
||||
}
|
||||
|
||||
// CreateNewStickerSet creates a new sticker set owned by a user.
|
||||
// Since: Bot API 3.2
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#createnewstickerset
|
||||
func (api *API) CreateNewStickerSet(params CreateNewStickerSet) (bool, error) {
|
||||
@@ -131,6 +192,7 @@ func (api *API) CreateNewStickerSet(params CreateNewStickerSet) (bool, error) {
|
||||
}
|
||||
|
||||
// CreateNewStickerSetWithContext is the context-aware variant of CreateNewStickerSet.
|
||||
// Since: Bot API 3.2
|
||||
// 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) {
|
||||
@@ -139,14 +201,20 @@ func (api *API) CreateNewStickerSetWithContext(ctx context.Context, params Creat
|
||||
}
|
||||
|
||||
// AddStickerToSet holds parameters for the addStickerToSet method.
|
||||
// Since: Bot API 3.2
|
||||
// See https://core.telegram.org/bots/api#addstickertoset
|
||||
type AddStickerToSet struct {
|
||||
UserID int64 `json:"user_id"`
|
||||
Name string `json:"name"`
|
||||
// UserID Required. User identifier of sticker set owner
|
||||
UserID int64 `json:"user_id"`
|
||||
// Name Required. Sticker set name
|
||||
Name string `json:"name"`
|
||||
// Sticker Required. A JSON-serialized object with information about the added sticker. If exactly the same
|
||||
// sticker had already been added to the set, then the set isn't changed.
|
||||
Sticker InputSticker `json:"sticker"`
|
||||
}
|
||||
|
||||
// AddStickerToSet adds a new sticker to a set created by the bot.
|
||||
// Since: Bot API 3.2
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#addstickertoset
|
||||
func (api *API) AddStickerToSet(params AddStickerToSet) (bool, error) {
|
||||
@@ -155,6 +223,7 @@ func (api *API) AddStickerToSet(params AddStickerToSet) (bool, error) {
|
||||
}
|
||||
|
||||
// AddStickerToSetWithContext is the context-aware variant of AddStickerToSet.
|
||||
// Since: Bot API 3.2
|
||||
// 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) {
|
||||
@@ -163,13 +232,17 @@ func (api *API) AddStickerToSetWithContext(ctx context.Context, params AddSticke
|
||||
}
|
||||
|
||||
// SetStickerPositionInSet holds parameters for the setStickerPositionInSet method.
|
||||
// Since: Bot API 3.2
|
||||
// See https://core.telegram.org/bots/api#setstickerpositioninset
|
||||
type SetStickerPositionInSet struct {
|
||||
Sticker string `json:"sticker"`
|
||||
Position int `json:"position"`
|
||||
// Sticker Required. File identifier of the sticker
|
||||
Sticker string `json:"sticker"`
|
||||
// Position Required. New sticker position in the set, zero-based
|
||||
Position int `json:"position"`
|
||||
}
|
||||
|
||||
// SetStickerPositionInSet moves a sticker in a set to a specific position.
|
||||
// Since: Bot API 3.2
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#setstickerpositioninset
|
||||
func (api *API) SetStickerPositionInSet(params SetStickerPositionInSet) (bool, error) {
|
||||
@@ -178,6 +251,7 @@ func (api *API) SetStickerPositionInSet(params SetStickerPositionInSet) (bool, e
|
||||
}
|
||||
|
||||
// SetStickerPositionInSetWithContext is the context-aware variant of SetStickerPositionInSet.
|
||||
// Since: Bot API 3.2
|
||||
// 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) {
|
||||
@@ -186,12 +260,15 @@ func (api *API) SetStickerPositionInSetWithContext(ctx context.Context, params S
|
||||
}
|
||||
|
||||
// DeleteStickerFromSet holds parameters for the deleteStickerFromSet method.
|
||||
// Since: Bot API 3.2
|
||||
// See https://core.telegram.org/bots/api#deletestickerfromset
|
||||
type DeleteStickerFromSet struct {
|
||||
// Sticker Required. File identifier of the sticker
|
||||
Sticker string `json:"sticker"`
|
||||
}
|
||||
|
||||
// DeleteStickerFromSet deletes a sticker from a set created by the bot.
|
||||
// Since: Bot API 3.2
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#deletestickerfromset
|
||||
func (api *API) DeleteStickerFromSet(params DeleteStickerFromSet) (bool, error) {
|
||||
@@ -200,6 +277,7 @@ func (api *API) DeleteStickerFromSet(params DeleteStickerFromSet) (bool, error)
|
||||
}
|
||||
|
||||
// DeleteStickerFromSetWithContext is the context-aware variant of DeleteStickerFromSet.
|
||||
// Since: Bot API 3.2
|
||||
// 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) {
|
||||
@@ -208,15 +286,22 @@ func (api *API) DeleteStickerFromSetWithContext(ctx context.Context, params Dele
|
||||
}
|
||||
|
||||
// ReplaceStickerInSet holds parameters for the replaceStickerInSet method.
|
||||
// Since: Bot API 7.2
|
||||
// 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"`
|
||||
// UserID Required. User identifier of the sticker set owner
|
||||
UserID int64 `json:"user_id"`
|
||||
// Name Required. Sticker set name
|
||||
Name string `json:"name"`
|
||||
// OldSticker Required. File identifier of the replaced sticker
|
||||
OldSticker string `json:"old_sticker"`
|
||||
// Sticker Required. A JSON-serialized object with information about the added sticker. If exactly the same
|
||||
// sticker had already been added to the set, then the set remains unchanged.
|
||||
Sticker InputSticker `json:"sticker"`
|
||||
}
|
||||
|
||||
// ReplaceStickerInSet replaces an existing sticker in a set with a new one.
|
||||
// Since: Bot API 7.2
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#replacestickerinset
|
||||
func (api *API) ReplaceStickerInSet(params ReplaceStickerInSet) (bool, error) {
|
||||
@@ -225,6 +310,7 @@ func (api *API) ReplaceStickerInSet(params ReplaceStickerInSet) (bool, error) {
|
||||
}
|
||||
|
||||
// ReplaceStickerInSetWithContext is the context-aware variant of ReplaceStickerInSet.
|
||||
// Since: Bot API 7.2
|
||||
// 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) {
|
||||
@@ -233,13 +319,17 @@ func (api *API) ReplaceStickerInSetWithContext(ctx context.Context, params Repla
|
||||
}
|
||||
|
||||
// SetStickerEmojiList holds parameters for the setStickerEmojiList method.
|
||||
// Since: Bot API 6.6
|
||||
// See https://core.telegram.org/bots/api#setstickeremojilist
|
||||
type SetStickerEmojiList struct {
|
||||
Sticker string `json:"sticker"`
|
||||
// Sticker Required. File identifier of the sticker
|
||||
Sticker string `json:"sticker"`
|
||||
// EmojiList Required. A JSON-serialized list of 1-20 emoji associated with the sticker
|
||||
EmojiList []string `json:"emoji_list"`
|
||||
}
|
||||
|
||||
// SetStickerEmojiList changes the list of emoji associated with a sticker.
|
||||
// Since: Bot API 6.6
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#setstickeremojilist
|
||||
func (api *API) SetStickerEmojiList(params SetStickerEmojiList) (bool, error) {
|
||||
@@ -248,6 +338,7 @@ func (api *API) SetStickerEmojiList(params SetStickerEmojiList) (bool, error) {
|
||||
}
|
||||
|
||||
// SetStickerEmojiListWithContext is the context-aware variant of SetStickerEmojiList.
|
||||
// Since: Bot API 6.6
|
||||
// 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) {
|
||||
@@ -256,13 +347,18 @@ func (api *API) SetStickerEmojiListWithContext(ctx context.Context, params SetSt
|
||||
}
|
||||
|
||||
// SetStickerKeywords holds parameters for the setStickerKeywords method.
|
||||
// Since: Bot API 6.6
|
||||
// See https://core.telegram.org/bots/api#setstickerkeywords
|
||||
type SetStickerKeywords struct {
|
||||
Sticker string `json:"sticker"`
|
||||
// Sticker Required. File identifier of the sticker
|
||||
Sticker string `json:"sticker"`
|
||||
// Keywords Optional. A JSON-serialized list of 0-20 search keywords for the sticker with total length of up
|
||||
// to 64 characters
|
||||
Keywords []string `json:"keywords"`
|
||||
}
|
||||
|
||||
// SetStickerKeywords changes the keywords of a sticker.
|
||||
// Since: Bot API 6.6
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#setstickerkeywords
|
||||
func (api *API) SetStickerKeywords(params SetStickerKeywords) (bool, error) {
|
||||
@@ -271,6 +367,7 @@ func (api *API) SetStickerKeywords(params SetStickerKeywords) (bool, error) {
|
||||
}
|
||||
|
||||
// SetStickerKeywordsWithContext is the context-aware variant of SetStickerKeywords.
|
||||
// Since: Bot API 6.6
|
||||
// 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) {
|
||||
@@ -279,13 +376,18 @@ func (api *API) SetStickerKeywordsWithContext(ctx context.Context, params SetSti
|
||||
}
|
||||
|
||||
// SetStickerMaskPosition holds parameters for the setStickerMaskPosition method.
|
||||
// Since: Bot API 6.6
|
||||
// See https://core.telegram.org/bots/api#setstickermaskposition
|
||||
type SetStickerMaskPosition struct {
|
||||
Sticker string `json:"sticker"`
|
||||
// Sticker Required. File identifier of the sticker
|
||||
Sticker string `json:"sticker"`
|
||||
// MaskPosition Optional. A JSON-serialized object with the position where the mask should be placed on
|
||||
// faces. Omit the parameter to remove the mask position.
|
||||
MaskPosition *MaskPosition `json:"mask_position,omitempty"`
|
||||
}
|
||||
|
||||
// SetStickerMaskPosition changes the mask position of a mask sticker.
|
||||
// Since: Bot API 6.6
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#setstickermaskposition
|
||||
func (api *API) SetStickerMaskPosition(params SetStickerMaskPosition) (bool, error) {
|
||||
@@ -294,6 +396,7 @@ func (api *API) SetStickerMaskPosition(params SetStickerMaskPosition) (bool, err
|
||||
}
|
||||
|
||||
// SetStickerMaskPositionWithContext is the context-aware variant of SetStickerMaskPosition.
|
||||
// Since: Bot API 6.6
|
||||
// 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) {
|
||||
@@ -302,13 +405,17 @@ func (api *API) SetStickerMaskPositionWithContext(ctx context.Context, params Se
|
||||
}
|
||||
|
||||
// SetStickerSetTitle holds parameters for the setStickerSetTitle method.
|
||||
// Since: Bot API 6.6
|
||||
// See https://core.telegram.org/bots/api#setstickersettitle
|
||||
type SetStickerSetTitle struct {
|
||||
Name string `json:"name"`
|
||||
// Name Required. Sticker set name
|
||||
Name string `json:"name"`
|
||||
// Title Required. Sticker set title, 1-64 characters
|
||||
Title string `json:"title"`
|
||||
}
|
||||
|
||||
// SetStickerSetTitle sets the title of a sticker set created by the bot.
|
||||
// Since: Bot API 6.6
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#setstickersettitle
|
||||
func (api *API) SetStickerSetTitle(params SetStickerSetTitle) (bool, error) {
|
||||
@@ -317,6 +424,7 @@ func (api *API) SetStickerSetTitle(params SetStickerSetTitle) (bool, error) {
|
||||
}
|
||||
|
||||
// SetStickerSetTitleWithContext is the context-aware variant of SetStickerSetTitle.
|
||||
// Since: Bot API 6.6
|
||||
// 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) {
|
||||
@@ -325,15 +433,30 @@ func (api *API) SetStickerSetTitleWithContext(ctx context.Context, params SetSti
|
||||
}
|
||||
|
||||
// SetStickerSetThumbnail holds parameters for the setStickerSetThumbnail method.
|
||||
// Since: Bot API 6.6
|
||||
// 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"`
|
||||
// Name Required. Sticker set name
|
||||
Name string `json:"name"`
|
||||
// UserID Required. User identifier of the sticker set owner
|
||||
UserID int64 `json:"user_id"`
|
||||
// Thumbnail Optional. A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and
|
||||
// have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size
|
||||
// (see https://core.telegram.org/stickers#animation-requirements for animated sticker technical
|
||||
// requirements), or a .WEBM video with the thumbnail up to 32 kilobytes in size; see
|
||||
// https://core.telegram.org/stickers#video-requirements for video sticker technical requirements. Pass a
|
||||
// file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a
|
||||
// String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More
|
||||
// information on Sending Files ». Animated and video sticker set thumbnails can't be uploaded via HTTP
|
||||
// URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.
|
||||
Thumbnail string `json:"thumbnail"`
|
||||
// Format Required. Format of the thumbnail, must be one of “static” for a .WEBP or .PNG image,
|
||||
// “animated” for a .TGS animation, or “video” for a .WEBM video
|
||||
Format InputStickerFormat `json:"format"`
|
||||
}
|
||||
|
||||
// SetStickerSetThumbnail sets the thumbnail of a sticker set.
|
||||
// Since: Bot API 6.6
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#setstickersetthumbnail
|
||||
func (api *API) SetStickerSetThumbnail(params SetStickerSetThumbnail) (bool, error) {
|
||||
@@ -342,6 +465,7 @@ func (api *API) SetStickerSetThumbnail(params SetStickerSetThumbnail) (bool, err
|
||||
}
|
||||
|
||||
// SetStickerSetThumbnailWithContext is the context-aware variant of SetStickerSetThumbnail.
|
||||
// Since: Bot API 6.6
|
||||
// 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) {
|
||||
@@ -350,13 +474,18 @@ func (api *API) SetStickerSetThumbnailWithContext(ctx context.Context, params Se
|
||||
}
|
||||
|
||||
// SetCustomEmojiStickerSetThumbnail holds parameters for the setCustomEmojiStickerSetThumbnail method.
|
||||
// Since: Bot API 6.6
|
||||
// See https://core.telegram.org/bots/api#setcustomemojistickersetthumbnail
|
||||
type SetCustomEmojiStickerSetThumbnail struct {
|
||||
Name string `json:"name"`
|
||||
// Name Required. Sticker set name
|
||||
Name string `json:"name"`
|
||||
// CustomEmojiID Optional. Custom emoji identifier of a sticker from the sticker set; pass an empty string
|
||||
// to drop the thumbnail and use the first sticker as the thumbnail
|
||||
CustomEmojiID string `json:"custom_emoji_id,omitempty"`
|
||||
}
|
||||
|
||||
// SetCustomEmojiStickerSetThumbnail sets the thumbnail of a custom emoji sticker set.
|
||||
// Since: Bot API 6.6
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#setcustomemojistickersetthumbnail
|
||||
func (api *API) SetCustomEmojiStickerSetThumbnail(params SetCustomEmojiStickerSetThumbnail) (bool, error) {
|
||||
@@ -365,6 +494,7 @@ func (api *API) SetCustomEmojiStickerSetThumbnail(params SetCustomEmojiStickerSe
|
||||
}
|
||||
|
||||
// SetCustomEmojiStickerSetThumbnailWithContext is the context-aware variant of SetCustomEmojiStickerSetThumbnail.
|
||||
// Since: Bot API 6.6
|
||||
// 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) {
|
||||
@@ -373,12 +503,15 @@ func (api *API) SetCustomEmojiStickerSetThumbnailWithContext(ctx context.Context
|
||||
}
|
||||
|
||||
// DeleteStickerSet holds parameters for the deleteStickerSet method.
|
||||
// Since: Bot API 6.6
|
||||
// See https://core.telegram.org/bots/api#deletestickerset
|
||||
type DeleteStickerSet struct {
|
||||
// Name Required. Sticker set name
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
// DeleteStickerSet deletes a sticker set created by the bot.
|
||||
// Since: Bot API 6.6
|
||||
// Returns True on success.
|
||||
// See https://core.telegram.org/bots/api#deletestickerset
|
||||
func (api *API) DeleteStickerSet(params DeleteStickerSet) (bool, error) {
|
||||
@@ -387,6 +520,7 @@ func (api *API) DeleteStickerSet(params DeleteStickerSet) (bool, error) {
|
||||
}
|
||||
|
||||
// DeleteStickerSetWithContext is the context-aware variant of DeleteStickerSet.
|
||||
// Since: Bot API 6.6
|
||||
// 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) {
|
||||
|
||||
+69
-27
@@ -15,12 +15,20 @@ const (
|
||||
)
|
||||
|
||||
// MaskPosition describes the position on faces where a mask should be placed by default.
|
||||
// Since: Bot API 3.2
|
||||
// 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"`
|
||||
// Point The part of the face relative to which the mask should be placed. One of “forehead”,
|
||||
// “eyes”, “mouth”, or “chin”.
|
||||
Point MaskPositionPoint `json:"point"`
|
||||
// XShift Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For
|
||||
// example, choosing -1.0 will place mask just to the left of the default mask position.
|
||||
XShift float32 `json:"x_shift"`
|
||||
// YShift Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For
|
||||
// example, 1.0 will place the mask just below the default mask position.
|
||||
YShift float32 `json:"y_shift"`
|
||||
// Scale Mask scaling coefficient. For example, 2.0 means double size.
|
||||
Scale float32 `json:"scale"`
|
||||
}
|
||||
|
||||
// StickerType represents the type of a sticker.
|
||||
@@ -36,33 +44,56 @@ const (
|
||||
)
|
||||
|
||||
// Sticker represents a sticker.
|
||||
// Since: Bot API 1.0
|
||||
// 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"`
|
||||
// FileID Identifier for this file, which can be used to download or reuse the file
|
||||
FileID string `json:"file_id"`
|
||||
// FileUniqueID Unique identifier for this file, which is supposed to be the same over time and for
|
||||
// different bots. Can't be used to download or reuse the file.
|
||||
FileUniqueID string `json:"file_unique_id"`
|
||||
// Width Sticker width
|
||||
Width int `json:"width"`
|
||||
// Height Sticker height
|
||||
Height int `json:"height"`
|
||||
|
||||
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"`
|
||||
// Type Type of the sticker, currently one of “regular”, “mask”, “custom_emoji”. The type of the
|
||||
// sticker is independent from its format, which is determined by the fields is_animated and is_video.
|
||||
Type StickerType `json:"type"` // Since: Bot API 6.2
|
||||
// IsAnimated True, if the sticker is animated
|
||||
IsAnimated bool `json:"is_animated"` // Since: Bot API 4.4
|
||||
// IsVideo True, if the sticker is a video sticker
|
||||
IsVideo bool `json:"is_video"` // Since: Bot API 5.7
|
||||
// Thumbnail Optional. Sticker thumbnail in the .WEBP or .JPG format
|
||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"` // Since: Bot API 6.6
|
||||
// Emoji Optional. Emoji associated with the sticker
|
||||
Emoji *string `json:"emoji,omitempty"`
|
||||
// SetName Optional. Name of the sticker set to which the sticker belongs
|
||||
SetName *string `json:"set_name,omitempty"` // Since: Bot API 3.2
|
||||
// MaskPosition Optional. For mask stickers, the position where the mask should be placed
|
||||
MaskPosition *MaskPosition `json:"mask_position,omitempty"` // Since: Bot API 3.2
|
||||
// CustomEmojiID Optional. For custom emoji stickers, unique identifier of the custom emoji
|
||||
CustomEmojiID *string `json:"custom_emoji_id,omitempty"` // Since: Bot API 6.2
|
||||
// NeedRepainting reports whether Telegram must recolor the custom emoji sticker.
|
||||
NeedRepainting *bool `json:"need_repainting,omitempty"` // Since: Bot API 6.6
|
||||
// FileSize Optional. File size in bytes
|
||||
FileSize *int64 `json:"file_size,omitempty"`
|
||||
}
|
||||
|
||||
// StickerSet represents a sticker set.
|
||||
// Since: Bot API 3.2
|
||||
// See https://core.telegram.org/bots/api#stickerset
|
||||
type StickerSet struct {
|
||||
Name string `json:"name"`
|
||||
Title string `json:"title"`
|
||||
// Name Sticker set name
|
||||
Name string `json:"name"`
|
||||
// Title Sticker set title
|
||||
Title string `json:"title"`
|
||||
// StickerType Type of stickers in the set, currently one of “regular”, “mask”, “custom_emoji”
|
||||
StickerType StickerType `json:"sticker_type"`
|
||||
Stickers []Sticker `json:"stickers"`
|
||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||
// Stickers List of all set stickers
|
||||
Stickers []Sticker `json:"stickers"`
|
||||
// Thumbnail Optional. Sticker set thumbnail in the .WEBP, .TGS, or .WEBM format
|
||||
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
|
||||
}
|
||||
|
||||
// InputStickerFormat represents the format of an input sticker.
|
||||
@@ -78,11 +109,22 @@ const (
|
||||
)
|
||||
|
||||
// InputSticker describes a sticker to be added to a sticker set.
|
||||
// Since: Bot API 6.6
|
||||
// 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"`
|
||||
// Sticker The added sticker. Pass a file_id as a String to send a file that already exists on the Telegram
|
||||
// servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or pass
|
||||
// “attach://<file_attach_name>” to upload a new file using multipart/form-data under <file_attach_name>
|
||||
// name. Animated and video stickers can't be uploaded via HTTP URL. More information on Sending Files »
|
||||
Sticker string `json:"sticker"`
|
||||
// Format Format of the added sticker, must be one of “static” for a .WEBP or .PNG image, “animated”
|
||||
// for a .TGS animation, “video” for a .WEBM video
|
||||
Format InputStickerFormat `json:"format"`
|
||||
// EmojiList List of 1-20 emoji associated with the sticker
|
||||
EmojiList []string `json:"emoji_list"`
|
||||
// MaskPosition Optional. Position where the mask should be placed on faces. For “mask” stickers only.
|
||||
MaskPosition *MaskPosition `json:"mask_position,omitempty"`
|
||||
// Keywords Optional. List of 0-20 search keywords for the sticker with total length of up to 64 characters.
|
||||
// For “regular” and “custom_emoji” stickers only.
|
||||
Keywords []string `json:"keywords,omitempty"`
|
||||
}
|
||||
|
||||
+647
-205
File diff suppressed because it is too large
Load Diff
@@ -72,6 +72,18 @@ func TestUpdateUnmarshalSetsType(t *testing.T) {
|
||||
}`,
|
||||
want: UpdateTypeManagedBot,
|
||||
},
|
||||
{
|
||||
name: "subscription",
|
||||
body: `{
|
||||
"update_id": 6,
|
||||
"subscription": {
|
||||
"user": {"id": 13, "is_bot": false, "first_name": "Subscriber"},
|
||||
"invoice_payload": "monthly",
|
||||
"state": "active"
|
||||
}
|
||||
}`,
|
||||
want: UpdateTypeSubscription,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
@@ -89,6 +101,9 @@ func TestUpdateUnmarshalSetsType(t *testing.T) {
|
||||
if tt.want == UpdateTypeManagedBot && update.ManagedBot.Bot.ID != 12 {
|
||||
t.Fatalf("unexpected managed bot id: got %d want %d", update.ManagedBot.Bot.ID, 12)
|
||||
}
|
||||
if tt.want == UpdateTypeSubscription && update.Subscription.User.ID != 13 {
|
||||
t.Fatalf("unexpected subscription user id: got %d want %d", update.Subscription.User.ID, 13)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
+68
-45
@@ -4,6 +4,7 @@ import (
|
||||
"bytes"
|
||||
"context"
|
||||
"fmt"
|
||||
"io"
|
||||
"mime/multipart"
|
||||
"net/http"
|
||||
"path/filepath"
|
||||
@@ -11,7 +12,7 @@ import (
|
||||
"time"
|
||||
|
||||
"git.scuroneko.dev/scuroneko/laniakea/utils"
|
||||
"git.scuroneko.dev/scuroneko/slog"
|
||||
"git.scuroneko.dev/scuroneko/sneklog/v2"
|
||||
)
|
||||
|
||||
const (
|
||||
@@ -33,6 +34,8 @@ const (
|
||||
UploaderStickerType UploaderFileType = "sticker"
|
||||
// UploaderCertificateType is the multipart field name for webhook certificate uploads.
|
||||
UploaderCertificateType UploaderFileType = "certificate"
|
||||
// UploaderLivePhotoType is the multipart field name for live photo uploads.
|
||||
UploaderLivePhotoType UploaderFileType = "live_photo"
|
||||
)
|
||||
|
||||
// UploaderFileType represents the Telegram form field name for a file upload.
|
||||
@@ -59,23 +62,34 @@ func (f UploaderFile) SetType(t UploaderFileType) UploaderFile {
|
||||
return f
|
||||
}
|
||||
|
||||
// SetAttachName sets the multipart field name used by an attach:// reference.
|
||||
// The name must match the suffix of the corresponding InputMedia.Media value.
|
||||
//
|
||||
// Since: Bot API 10.2
|
||||
func (f UploaderFile) SetAttachName(name string) UploaderFile {
|
||||
f.field = UploaderFileType(name)
|
||||
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 *slog.Logger
|
||||
logger *sneklog.Logger
|
||||
}
|
||||
|
||||
// NewUploader creates a multipart uploader bound to an API client.
|
||||
func NewUploader(api *API) *Uploader {
|
||||
logger := utils.CreateLogger("UPLOADER", utils.GetLoggerLevel())
|
||||
if api == nil {
|
||||
logger.Errorln("api is nil")
|
||||
_ = logger.Close()
|
||||
return nil
|
||||
}
|
||||
logger := utils.CreateLogger(
|
||||
"UPLOADER", utils.GetLoggerLevel(),
|
||||
api.logFormat, api.logFormatter,
|
||||
)
|
||||
logger.AddReplacer(api.token, "<TOKEN>")
|
||||
return &Uploader{api, logger}
|
||||
}
|
||||
|
||||
@@ -85,7 +99,7 @@ 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() *slog.Logger { return u.logger }
|
||||
func (u *Uploader) GetLogger() *sneklog.Logger { return u.logger }
|
||||
|
||||
// UploaderRequest is a low-level multipart upload request wrapper.
|
||||
//
|
||||
@@ -97,18 +111,18 @@ type UploaderRequest[R, P any] struct {
|
||||
method string
|
||||
files []UploaderFile
|
||||
params P
|
||||
chatId int64
|
||||
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}
|
||||
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 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) {
|
||||
@@ -118,32 +132,31 @@ func (r UploaderRequest[R, P]) doRequest(ctx context.Context, up *Uploader) (R,
|
||||
if up.api.useTestServer {
|
||||
methodPrefix = "/test"
|
||||
}
|
||||
url := fmt.Sprintf("%s/bot%s%s/%s", up.api.apiUrl, up.api.token, methodPrefix, r.method)
|
||||
url := fmt.Sprintf("%s/bot%s%s/%s", up.api.apiURL, up.api.token, methodPrefix, r.method)
|
||||
|
||||
retries := 0
|
||||
for {
|
||||
if up.api.Limiter != nil {
|
||||
if err := up.api.Limiter.Check(ctx, up.api.dropOverflowLimit, r.chatId); err != 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)
|
||||
requestBody, contentType := prepareMultipartStream(r.files, r.params)
|
||||
req, err := http.NewRequestWithContext(ctx, "POST", url, requestBody)
|
||||
if err != nil {
|
||||
return zero, err
|
||||
}
|
||||
req, err := http.NewRequestWithContext(ctx, "POST", url, buf)
|
||||
if err != nil {
|
||||
return zero, err
|
||||
_ = requestBody.Close()
|
||||
return zero, fmt.Errorf("failed to create upload request: %w", 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)
|
||||
up.logger.Debugln("UPLOADER REQ", url)
|
||||
resp, err := up.api.client.Do(req)
|
||||
_ = requestBody.Close()
|
||||
if err != nil {
|
||||
return zero, err
|
||||
return zero, fmt.Errorf("HTTP upload request failed: %w", redactHTTPError(err, up.api.token))
|
||||
}
|
||||
|
||||
body, err := readBody(resp.Body)
|
||||
@@ -151,7 +164,7 @@ func (r UploaderRequest[R, P]) doRequest(ctx context.Context, up *Uploader) (R,
|
||||
if err != nil {
|
||||
return zero, err
|
||||
}
|
||||
up.logger.Debugln("UPLOADER RES", r.method, string(body))
|
||||
up.logger.Debugln("UPLOADER RES", responseLogSummary(r.method, len(body)))
|
||||
|
||||
response, err := parseBody[R](body)
|
||||
if err != nil {
|
||||
@@ -159,25 +172,34 @@ func (r UploaderRequest[R, P]) doRequest(ctx context.Context, up *Uploader) (R,
|
||||
}
|
||||
|
||||
if !response.Ok {
|
||||
responseErr := &ResponseError{
|
||||
Code: response.ErrorCode,
|
||||
Description: response.Description,
|
||||
Parameters: response.Parameters,
|
||||
}
|
||||
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)
|
||||
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)
|
||||
if r.chatID != 0 {
|
||||
up.api.Limiter.SetChatLock(r.chatID, after)
|
||||
} else {
|
||||
up.api.Limiter.SetGlobalLock(after)
|
||||
}
|
||||
}
|
||||
if retries >= up.api.maxRetries {
|
||||
return zero, fmt.Errorf("%w after %d retries: %w", ErrRetryLimit, retries, responseErr)
|
||||
}
|
||||
retries++
|
||||
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
return zero, ctx.Err()
|
||||
case <-time.After(time.Duration(after) * time.Second):
|
||||
continue // Повторяем запрос
|
||||
case <-time.After(retryDelay(after)):
|
||||
continue
|
||||
}
|
||||
}
|
||||
return zero, fmt.Errorf("[%d] %s", response.ErrorCode, response.Description)
|
||||
return zero, responseErr
|
||||
}
|
||||
return response.Result, nil
|
||||
}
|
||||
@@ -215,40 +237,41 @@ 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)
|
||||
func prepareMultipartStream[P any](files []UploaderFile, params P) (io.ReadCloser, string) {
|
||||
reader, writer := io.Pipe()
|
||||
multipartWriter := multipart.NewWriter(writer)
|
||||
contentType := multipartWriter.FormDataContentType()
|
||||
go func() {
|
||||
err := writeMultipart(multipartWriter, files, params)
|
||||
_ = writer.CloseWithError(err)
|
||||
}()
|
||||
return reader, contentType
|
||||
}
|
||||
|
||||
func writeMultipart[P any](w *multipart.Writer, files []UploaderFile, params P) error {
|
||||
for _, file := range files {
|
||||
fw, err := w.CreateFormFile(string(file.field), file.filename)
|
||||
if err != nil {
|
||||
_ = w.Close() // Закрываем, чтобы не было утечки
|
||||
return nil, "", err
|
||||
_ = w.Close()
|
||||
return err
|
||||
}
|
||||
|
||||
_, err = fw.Write(file.data)
|
||||
_, err = io.Copy(fw, bytes.NewReader(file.data))
|
||||
if err != nil {
|
||||
_ = w.Close()
|
||||
return nil, "", err
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
err := utils.Encode(w, params) // Предполагается, что это записывает в w
|
||||
err := utils.Encode(w, params)
|
||||
if err != nil {
|
||||
_ = w.Close()
|
||||
return nil, "", err
|
||||
return err
|
||||
}
|
||||
|
||||
err = w.Close() // ✅ ОБЯЗАТЕЛЬНО вызвать в конце — иначе запрос битый!
|
||||
if err != nil {
|
||||
return nil, "", err
|
||||
}
|
||||
|
||||
return buf, w.FormDataContentType(), nil
|
||||
return w.Close()
|
||||
}
|
||||
|
||||
// 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 {
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user