-
-
Notifications
You must be signed in to change notification settings - Fork 48
Expand file tree
/
Copy pathmessage_handler.py
More file actions
173 lines (134 loc) · 6.48 KB
/
message_handler.py
File metadata and controls
173 lines (134 loc) · 6.48 KB
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
# Hydrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-2023 Dan <https://github.com/delivrance>
# Copyright (C) 2023-present Hydrogram <https://hydrogram.org>
#
# This file is part of Hydrogram.
#
# Hydrogram is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Hydrogram 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 General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with Hydrogram. If not, see <http://www.gnu.org/licenses/>.
from __future__ import annotations
from inspect import iscoroutinefunction
from typing import TYPE_CHECKING, Callable
import hydrogram
from hydrogram.types import Identifier, Listener, ListenerTypes, Message
from .handler import Handler
if TYPE_CHECKING:
from hydrogram.filters import Filter
class MessageHandler(Handler):
"""The Message handler class. Used to handle new messages.
It is intended to be used with :meth:`~hydrogram.Client.add_handler`
For a nicer way to register this handler, have a look at the
:meth:`~hydrogram.Client.on_message` decorator.
Parameters:
callback (``Callable``):
Pass a function that will be called when a new Message arrives. It takes *(client, message)*
as positional arguments (look at the section below for a detailed description).
filters (:obj:`Filters`):
Pass one or more filters to allow only a subset of messages to be passed
in your callback function.
Other parameters:
client (:obj:`~hydrogram.Client`):
The Client itself, useful when you want to call other API methods inside the message handler.
message (:obj:`~hydrogram.types.Message`):
The received message.
"""
def __init__(self, callback: Callable, filters: Filter | None = None):
self.original_callback = callback
super().__init__(self.resolve_future_or_callback, filters)
@staticmethod
async def check_if_has_matching_listener(
client: hydrogram.Client, message: Message
) -> tuple[bool, Listener | None]:
"""
Checks if the message has a matching listener.
Parameters:
client (:obj:`~hydrogram.Client`):
The Client object to check with.
message (:obj:`~hydrogram.types.Message`):
The Message object to check with.
Returns:
``tuple``: A tuple of two elements, the first one is whether the message has a matching listener or not,
the second one is the matching listener if exists.
"""
from_user = message.from_user
from_user_id = from_user.id if from_user else None
from_user_username = from_user.username if from_user else None
message_id = getattr(message, "id", getattr(message, "message_id", None))
data = Identifier(
message_id=message_id,
chat_id=[message.chat.id, message.chat.username],
from_user_id=[from_user_id, from_user_username],
)
listener = client.get_listener_matching_with_data(data, ListenerTypes.MESSAGE)
listener_does_match = False
if listener:
filters = listener.filters
if callable(filters):
if iscoroutinefunction(filters.__call__):
listener_does_match = await filters(client, message)
else:
listener_does_match = await client.loop.run_in_executor(
None, filters, client, message
)
else:
listener_does_match = True
return listener_does_match, listener
async def check(self, client: hydrogram.Client, message: Message) -> bool:
"""
Checks if the message has a matching listener or handler and its filters does match with the Message.
Parameters:
client (:obj:`~hydrogram.Client`):
The Client object to check with.
message (:obj:`~hydrogram.types.Message`):
The Message object to check with.
Returns:
``bool``: Whether the message has a matching listener or handler and its filters does match with the Message.
"""
listener_does_match = (await self.check_if_has_matching_listener(client, message))[0]
if callable(self.filters):
if iscoroutinefunction(self.filters.__call__):
handler_does_match = await self.filters(client, message)
else:
handler_does_match = await client.loop.run_in_executor(
None, self.filters, client, message
)
else:
handler_does_match = True
# let handler get the chance to handle if listener
# exists but its filters doesn't match
return listener_does_match or handler_does_match
async def resolve_future_or_callback(self, client: hydrogram.Client, message: Message, *args):
"""
Resolves the future or calls the callback of the listener if the message has a matching listener.
Parameters:
client (:obj:`~hydrogram.Client`):
The Client object to resolve or call with.
message (:obj:`~hydrogram.types.Message`):
The Message object to resolve or call with.
args (``tuple``):
Arguments to call the callback with.
"""
listener_does_match, listener = await self.check_if_has_matching_listener(client, message)
if listener and listener_does_match:
client.remove_listener(listener)
if listener.future and not listener.future.done():
listener.future.set_result(message)
raise hydrogram.StopPropagation
if listener.callback:
if iscoroutinefunction(listener.callback):
await listener.callback(client, message, *args)
else:
listener.callback(client, message, *args)
raise hydrogram.StopPropagation
raise ValueError("Listener must have either a future or a callback")
await self.original_callback(client, message, *args)