mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-11-22 15:17:00 +01:00
128 lines
4.9 KiB
Python
128 lines
4.9 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2023
|
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Lesser Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU Lesser Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Lesser Public License
|
|
# along with this program. If not, see [http://www.gnu.org/licenses/].
|
|
"""This module contains the ChatJoinRequestHandler class."""
|
|
|
|
from typing import FrozenSet, Optional
|
|
|
|
from telegram import Update
|
|
from telegram._utils.defaultvalue import DEFAULT_TRUE
|
|
from telegram._utils.types import RT, SCT, DVType
|
|
from telegram.ext._basehandler import BaseHandler
|
|
from telegram.ext._utils.types import CCT, HandlerCallback
|
|
|
|
|
|
class ChatJoinRequestHandler(BaseHandler[Update, CCT]):
|
|
"""BaseHandler class to handle Telegram updates that contain
|
|
:attr:`telegram.Update.chat_join_request`.
|
|
|
|
Note:
|
|
If neither of :paramref:`username` and the :paramref:`chat_id` are passed, this handler
|
|
accepts *any* join request. Otherwise, this handler accepts all requests to join chats
|
|
for which the chat ID is listed in :paramref:`chat_id` or the username is listed in
|
|
:paramref:`username`, or both.
|
|
|
|
.. versionadded:: 20.0
|
|
|
|
Warning:
|
|
When setting :paramref:`block` to :obj:`False`, you cannot rely on adding custom
|
|
attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info.
|
|
|
|
.. versionadded:: 13.8
|
|
|
|
Args:
|
|
callback (:term:`coroutine function`): The callback function for this handler. Will be
|
|
called when :meth:`check_update` has determined that an update should be processed by
|
|
this handler. Callback signature::
|
|
|
|
async def callback(update: Update, context: CallbackContext)
|
|
|
|
The return value of the callback is usually ignored except for the special case of
|
|
:class:`telegram.ext.ConversationHandler`.
|
|
chat_id (:obj:`int` | Collection[:obj:`int`], optional): Filters requests to allow only
|
|
those which are asking to join the specified chat ID(s).
|
|
|
|
.. versionadded:: 20.0
|
|
username (:obj:`str` | Collection[:obj:`str`], optional): Filters requests to allow only
|
|
those which are asking to join the specified username(s).
|
|
|
|
.. versionadded:: 20.0
|
|
block (:obj:`bool`, optional): Determines whether the return value of the callback should
|
|
be awaited before processing the next handler in
|
|
:meth:`telegram.ext.Application.process_update`. Defaults to :obj:`True`.
|
|
|
|
.. seealso:: :wiki:`Concurrency`
|
|
|
|
Attributes:
|
|
callback (:term:`coroutine function`): The callback function for this handler.
|
|
block (:obj:`bool`): Determines whether the callback will run in a blocking way..
|
|
|
|
"""
|
|
|
|
__slots__ = (
|
|
"_chat_ids",
|
|
"_usernames",
|
|
)
|
|
|
|
def __init__(
|
|
self,
|
|
callback: HandlerCallback[Update, CCT, RT],
|
|
chat_id: Optional[SCT[int]] = None,
|
|
username: Optional[SCT[str]] = None,
|
|
block: DVType[bool] = DEFAULT_TRUE,
|
|
):
|
|
super().__init__(callback, block=block)
|
|
|
|
self._chat_ids = self._parse_chat_id(chat_id)
|
|
self._usernames = self._parse_username(username)
|
|
|
|
@staticmethod
|
|
def _parse_chat_id(chat_id: Optional[SCT[int]]) -> FrozenSet[int]:
|
|
if chat_id is None:
|
|
return frozenset()
|
|
if isinstance(chat_id, int):
|
|
return frozenset({chat_id})
|
|
return frozenset(chat_id)
|
|
|
|
@staticmethod
|
|
def _parse_username(username: Optional[SCT[str]]) -> FrozenSet[str]:
|
|
if username is None:
|
|
return frozenset()
|
|
if isinstance(username, str):
|
|
return frozenset({username[1:] if username.startswith("@") else username})
|
|
return frozenset({usr[1:] if usr.startswith("@") else usr for usr in username})
|
|
|
|
def check_update(self, update: object) -> bool:
|
|
"""Determines whether an update should be passed to this handler's :attr:`callback`.
|
|
|
|
Args:
|
|
update (:class:`telegram.Update` | :obj:`object`): Incoming update.
|
|
|
|
Returns:
|
|
:obj:`bool`
|
|
|
|
"""
|
|
if isinstance(update, Update) and update.chat_join_request:
|
|
if not self._chat_ids and not self._usernames:
|
|
return True
|
|
if update.chat_join_request.chat.id in self._chat_ids:
|
|
return True
|
|
if update.chat_join_request.from_user.username in self._usernames:
|
|
return True
|
|
return False
|
|
return False
|