1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
use super::Polling;
use crate::event_loop::{EventLoop, Webhook};
use crate::{contexts, errors};
use std::{future::Future, sync::Arc};
macro_rules! handlers {
(
$(
$(#[doc = $doc:literal])+
$name:ident: $context:path,
)+
) => {
$(
$(#[doc = $doc])+
pub fn $name<H, F>(&mut self, handler: H)
where
H: (Fn(Arc<$context>, Arc<S>) -> F)
+ Send
+ Sync
+ 'static,
F: Future<Output = ()> + Send + 'static,
{
let state = Arc::clone(&self.state);
self.inner
.$name(move |context| handler(context, Arc::clone(&state)));
}
)+
};
}
/// A stateful event loop.
#[allow(clippy::module_name_repetitions)]
#[must_use]
pub struct StatefulEventLoop<S> {
inner: EventLoop,
state: Arc<S>,
}
#[allow(clippy::use_self)] // https://github.com/rust-lang/rust-clippy/issues/4143
impl<S> StatefulEventLoop<S> {
pub(crate) fn new(inner: EventLoop, state: S) -> Self {
Self {
inner,
state: Arc::new(state),
}
}
/// Returns an `Arc` to the state.
#[must_use]
pub fn get_state(&self) -> Arc<S> {
Arc::clone(&self.state)
}
/// Turns this event loop into a stateless one. Handlers added on this event
/// loop are still kept.
// https://github.com/rust-lang/rust-clippy/issues/4979
#[allow(clippy::missing_const_for_fn)]
pub fn into_stateless(self) -> EventLoop {
self.inner
}
/// Turns this event loop into another with other state. Handlers added on
/// this event loop are still kept and will receive the previous state.
pub fn with_other_state<T>(self, other_state: T) -> StatefulEventLoop<T>
where
T: Send + Sync + 'static,
{
StatefulEventLoop {
inner: self.inner,
state: Arc::new(other_state),
}
}
/// Sets the bot's username.
///
/// The username is used when checking if a command such as
/// `/command@username` was directed to the bot.
pub fn username(&mut self, username: String) {
self.inner.username(username);
}
/// Fetches the bot's username.
///
/// The username is used when checking if a command such as
/// `/command@username` was directed to the bot.
// `StatefulEventLoop` can be constructed only if `S: Send + Sync`
#[allow(clippy::future_not_send)]
pub async fn fetch_username(&mut self) -> Result<(), errors::MethodCall> {
self.inner.fetch_username().await
}
/// Starts polling configuration.
pub fn polling(self) -> Polling<S> {
Polling::new(self.inner, Arc::clone(&self.state))
}
/// Starts webhook configuration.
///
/// See our [wiki] to learn how to use webhook with `tbot`.
///
/// [wiki]: https://gitlab.com/SnejUgal/tbot/wikis/How-to/How-to-use-webhooks
pub fn webhook(self, url: &str, port: u16) -> Webhook<'_> {
self.inner.webhook(url, port)
}
}
impl<S> StatefulEventLoop<S>
where
S: Send + Sync + 'static,
{
/// Registers a new handler for a command.
///
/// Note that commands such as `/command@username` will be completely
/// ignored unless you configure the event loop with your bot's username
/// with either [`username`] or [`fetch_username`].
///
/// [`username`]: Self::username
/// [`fetch_username`]: Self::fetch_username
pub fn command<H, F>(&mut self, command: &'static str, handler: H)
where
H: (Fn(Arc<contexts::Command>, Arc<S>) -> F) + Send + Sync + 'static,
F: Future<Output = ()> + Send + 'static,
{
let state = Arc::clone(&self.state);
self.inner.command(command, move |context| {
handler(context, Arc::clone(&state))
});
}
/// Registers a new handler for a command and sets its description.
///
/// Note that commands such as `/command@username` will be completely
/// ignored unless you configure the event loop with your bot's username
/// with either [`username`] or [`fetch_username`].
///
/// [`username`]: Self::username
/// [`fetch_username`]: Self::fetch_username
pub fn command_with_description<H, F>(
&mut self,
command: &'static str,
description: &'static str,
handler: H,
) where
H: (Fn(Arc<contexts::Command>, Arc<S>) -> F) + Send + Sync + 'static,
F: Future<Output = ()> + Send + 'static,
{
let state = Arc::clone(&self.state);
self.inner.command_with_description(
command,
description,
move |context| handler(context, Arc::clone(&state)),
);
}
/// Registers a new handler for a sequence of commands.
///
/// Note that commands such as `/command@username` will be completely
/// ignored unless you configure the event loop with your bot's username
/// with either [`username`] or [`fetch_username`].
///
/// [`username`]: Self::username
/// [`fetch_username`]: Self::fetch_username
pub fn commands<Cm, H, F>(&mut self, commands: Cm, handler: H)
where
Cm: IntoIterator<Item = &'static str>,
H: (Fn(Arc<contexts::Command>, Arc<S>) -> F) + Send + Sync + 'static,
F: Future<Output = ()> + Send + 'static,
{
let state = Arc::clone(&self.state);
self.inner.commands(commands, move |context| {
handler(context, Arc::clone(&state))
});
}
/// Registers a new handler for the `/start` command.
pub fn start<H, F>(&mut self, handler: H)
where
H: (Fn(Arc<contexts::Command>, Arc<S>) -> F) + Send + Sync + 'static,
F: Future<Output = ()> + Send + 'static,
{
self.command("start", handler);
}
/// Registers a new handler for the `/start` command and sets its
/// description.
pub fn start_with_description<H, F>(
&mut self,
description: &'static str,
handler: H,
) where
H: (Fn(Arc<contexts::Command>, Arc<S>) -> F) + Send + Sync + 'static,
F: Future<Output = ()> + Send + 'static,
{
self.command_with_description("start", description, handler);
}
/// Registers a new handler for the `/help` command.
pub fn help<H, F>(&mut self, handler: H)
where
H: (Fn(Arc<contexts::Command>, Arc<S>) -> F) + Send + Sync + 'static,
F: Future<Output = ()> + Send + 'static,
{
self.command("help", handler);
}
/// Registers a new handler for the `/help` command and sets its
/// description.
pub fn help_with_description<H, F>(
&mut self,
description: &'static str,
handler: H,
) where
H: (Fn(Arc<contexts::Command>, Arc<S>) -> F) + Send + Sync + 'static,
F: Future<Output = ()> + Send + 'static,
{
self.command_with_description("help", description, handler);
}
/// Registers a new handler for the `/settings` command.
pub fn settings<H, F>(&mut self, handler: H)
where
H: (Fn(Arc<contexts::Command>, Arc<S>) -> F) + Send + Sync + 'static,
F: Future<Output = ()> + Send + 'static,
{
self.command("settings", handler);
}
/// Registers a new handler for the `/settings` command and sets its
/// description.
pub fn settings_with_description<H, F>(
&mut self,
description: &'static str,
handler: H,
) where
H: (Fn(Arc<contexts::Command>, Arc<S>) -> F) + Send + Sync + 'static,
F: Future<Output = ()> + Send + 'static,
{
self.command_with_description("settings", description, handler);
}
/// Registers a new handler for an edited command.
pub fn edited_command<H, F>(&mut self, command: &'static str, handler: H)
where
H: (Fn(Arc<contexts::EditedCommand>, Arc<S>) -> F)
+ Send
+ Sync
+ 'static,
F: Future<Output = ()> + Send + 'static,
{
let state = Arc::clone(&self.state);
self.inner.edited_command(command, move |context| {
handler(context, Arc::clone(&state))
});
}
/// Registers a new handler for a sequence of edited commands.
pub fn edited_commands<Cm, H, F>(&mut self, commands: Cm, handler: H)
where
Cm: IntoIterator<Item = &'static str>,
H: (Fn(Arc<contexts::EditedCommand>, Arc<S>) -> F)
+ Send
+ Sync
+ 'static,
F: Future<Output = ()> + Send + 'static,
{
let state = Arc::clone(&self.state);
self.inner.edited_commands(commands, move |context| {
handler(context, Arc::clone(&state))
});
}
handlers! {
/// Registers a new handler for all incoming updates.
///
/// `any_update` handlers are spawned before specialized handlers,
/// for every update that could be deserialized (this means that
/// processing new updates on old versions of `tbot` is not possible
/// even via `any_update`).
///
/// Note “spawned”: every handler is executed using [`tokio::spawn`],
/// and `tbot` won't wait for them to finish. As such, `any_update` is
/// not suitable for running some code before every specialized handler.
///
/// Also, `any_update` does not affect [`unhandled`] in any way. It's
/// executed if a _specialized_ handler corresponding to the incoming
/// update wasn't registered.
///
/// Registering specialized handler is still preferred. if at least
/// one `any_update` handler is registered, `tbot` will have to clone
/// every update in order to execute these and specialized handlers.
///
/// [`unhandled`]: Self::unhandled
any_update: contexts::AnyUpdate,
/// Registers a new handler for animations.
animation: contexts::Animation,
/// Registers a new handler for audio.
audio: contexts::Audio,
/// Registers a new handler for changed auto-delete timers.
changed_auto_delete_timer: contexts::ChangedAutoDeleteTimer,
/// Registers a new handler for chat members' updated information.
chat_member: contexts::ChatMember,
/// Registers a new handler for chosen inline results.
chosen_inline: contexts::ChosenInline,
/// Registers a new handler for contacts.
contact: contexts::Contact,
/// Registers a new handler for connected websites.
connected_website: contexts::ConnectedWebsite,
/// Registers a new handler for created groups.
created_group: contexts::CreatedGroup,
/// Registers a new handler for data callbacks from chat messages.
message_data_callback: contexts::MessageDataCallback,
/// Registers a new handler for data callbacks from inline messages.
inline_data_callback: contexts::InlineDataCallback,
/// Registers a new handler for deleted chat photos.
deleted_chat_photo: contexts::DeletedChatPhoto,
/// Registers a new handler for dice.
dice: contexts::Dice,
/// Registers a new handler for documents.
document: contexts::Document,
/// Registers a new handler for edited animations.
edited_animation: contexts::EditedAnimation,
/// Registers a new handler for edited audio.
edited_audio: contexts::EditedAudio,
/// Registers a new handler for edited documents.
edited_document: contexts::EditedDocument,
/// Registers a new handler for edited locations.
edited_location: contexts::EditedLocation,
/// Registers a new handler for edited photos.
edited_photo: contexts::EditedPhoto,
/// Registers a new handler for edited text messages.
edited_text: contexts::EditedText,
/// Registers a new handler for edited videos.
edited_video: contexts::EditedVideo,
/// Registers a new handler for when a voice chat is ended.
ended_voice_chat: contexts::EndedVoiceChat,
/// Registers a new handler for game callbacks from chat messages.
message_game_callback: contexts::MessageGameCallback,
/// Registers a new handler for game callbacks from inline messages.
inline_game_callback: contexts::InlineGameCallback,
/// Registers a new handler for game messages.
game: contexts::Game,
/// Registers a new handler for inline queries.
inline: contexts::Inline,
/// Registers a new handler for when users are invited to a voice chat.
invited_voice_chat_participants: contexts::InvitedVoiceChatParticipants,
/// Registers a new handler for invoices.
invoice: contexts::Invoice,
/// Registers a new handler for left members.
left_member: contexts::LeftMember,
/// Registers a new handler for locations.
location: contexts::Location,
/// Registers a new handler for migrations.
migration: contexts::Migration,
/// Registers a new handler for the bot's update chat member status.
my_chat_member: contexts::MyChatMember,
/// Registers a new handler for new chat photos.
new_chat_photo: contexts::NewChatPhoto,
/// Registers a new handler for new chat titles.
new_chat_title: contexts::NewChatTitle,
/// Registers a new handler for new members.
new_members: contexts::NewMembers,
/// Registers a new handler for passport data.
passport: contexts::Passport,
/// Registers a new handler for successful payments.
payment: contexts::Payment,
/// Registers a new handler for photos.
photo: contexts::Photo,
/// Registers a new handler for pinned messages.
pinned_message: contexts::PinnedMessage,
/// Registers a new handler for poll messages.
poll: contexts::Poll,
/// Registers a new handler for pre-checkout queries.
pre_checkout: contexts::PreCheckout,
/// Registers a new handler for proximity alerts.
proximity_alert: contexts::ProximityAlert,
/// Registers a new handler for when a voice chat is scheduled.
scheduled_voice_chat: contexts::ScheduledVoiceChat,
/// Registers a new handler for shipping queries.
shipping: contexts::Shipping,
/// Registers a new handler for when a voice chat is started.
started_voice_chat: contexts::StartedVoiceChat,
/// Registers a new handler for stickers.
sticker: contexts::Sticker,
/// Registers a new handler for text messages.
text: contexts::Text,
/// Registers a new handler for unhandled updates.
///
/// Note that regisering [`any_update`] handlers does not affect
/// `unhandled` handlers in any way. An `unhandled` handler is spawned
/// if a _specialized_ handler corresponding to the incoming update was
/// not registered.
///
/// [`any_update`]: Self::any_update
unhandled: contexts::Unhandled,
/// Registers a new handler for new states of polls.
updated_poll: contexts::UpdatedPoll,
/// Registers a new handler for new answers in the poll.
poll_answer: contexts::PollAnswer,
/// Registers a new handler for venues.
venue: contexts::Venue,
/// Registers a new handler for videos.
video: contexts::Video,
/// Registers a new handler for video notes.
video_note: contexts::VideoNote,
/// Registers a new handler for voice messages.
voice: contexts::Voice,
}
}