-
Notifications
You must be signed in to change notification settings - Fork 6
/
send_introduction_reminders.py
322 lines (277 loc) · 13.1 KB
/
send_introduction_reminders.py
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
"""Contains cog classes for any send_introduction_reminders interactions."""
from collections.abc import Sequence
__all__: Sequence[str] = ("SendIntroductionRemindersTaskCog",)
import functools
import logging
from logging import Logger
from typing import Final, override
import discord
import emoji
from discord import ui
from discord.ext import tasks
from discord.ui import View
from django.core.exceptions import ValidationError
import utils
from config import settings
from db.core.models import (
IntroductionReminderOptOutMember,
SentOneOffIntroductionReminderMember,
)
from exceptions import DiscordMemberNotInMainGuildError, GuestRoleDoesNotExistError
from utils import TeXBot, TeXBotBaseCog
from utils.error_capture_decorators import (
ErrorCaptureDecorators,
capture_guild_does_not_exist_error,
)
logger: Final[Logger] = logging.getLogger("TeX-Bot")
class SendIntroductionRemindersTaskCog(TeXBotBaseCog):
"""Cog class that defines the send_introduction_reminders task."""
@override
def __init__(self, bot: TeXBot) -> None:
"""Start all task managers when this cog is initialised."""
if settings["SEND_INTRODUCTION_REMINDERS"]:
if settings["SEND_INTRODUCTION_REMINDERS"] == "interval":
SentOneOffIntroductionReminderMember.objects.all().delete()
self.send_introduction_reminders.start()
super().__init__(bot)
@override
def cog_unload(self) -> None:
"""
Unload hook that ends all running tasks whenever the tasks cog is unloaded.
This may be run dynamically or when the bot closes.
"""
self.send_introduction_reminders.cancel()
@TeXBotBaseCog.listener()
async def on_ready(self) -> None:
"""Add OptOutIntroductionRemindersView to the bot's list of permanent views."""
self.bot.add_view(
self.OptOutIntroductionRemindersView(self.bot),
)
@tasks.loop(**settings["SEND_INTRODUCTION_REMINDERS_INTERVAL"])
@functools.partial(
ErrorCaptureDecorators.capture_error_and_close,
error_type=GuestRoleDoesNotExistError,
close_func=ErrorCaptureDecorators.critical_error_close_func,
)
@capture_guild_does_not_exist_error
async def send_introduction_reminders(self) -> None:
"""
Recurring task to send an introduction reminder message to Discord members' DMs.
The introduction reminder suggests that the Discord member should send a message to
introduce themselves to your group's Discord guild.
See README.md for the full list of conditions for when these
reminders are sent.
"""
# NOTE: Shortcut accessors are placed at the top of the function, so that the exceptions they raise are displayed before any further errors may be sent
main_guild: discord.Guild = self.bot.main_guild
member: discord.Member
for member in main_guild.members:
if utils.is_member_inducted(member) or member.bot:
continue
if not member.joined_at:
logger.error(
(
"Member with ID: %s could not be checked whether to send "
"introduction_reminder, because their %s attribute "
"was None."
),
member.id,
repr("joined_at"),
)
continue
member_needs_one_off_reminder: bool = (
settings["SEND_INTRODUCTION_REMINDERS"] == "once"
and not await (
await SentOneOffIntroductionReminderMember.objects.afilter(
discord_id=member.id,
)
).aexists()
)
member_needs_recurring_reminder: bool = (
settings["SEND_INTRODUCTION_REMINDERS"] == "interval"
)
member_recently_joined: bool = (
discord.utils.utcnow() - member.joined_at
) <= settings["SEND_INTRODUCTION_REMINDERS_DELAY"]
member_opted_out_from_reminders: bool = await (
await IntroductionReminderOptOutMember.objects.afilter(
discord_id=member.id,
)
).aexists()
member_needs_reminder: bool = (
(member_needs_one_off_reminder or member_needs_recurring_reminder)
and not member_recently_joined
and not member_opted_out_from_reminders
)
if not member_needs_reminder:
continue
async for message in member.history():
# noinspection PyUnresolvedReferences
MESSAGE_CONTAINS_OPT_IN_OUT_BUTTON: bool = bool(
bool(message.components)
and isinstance(message.components[0], discord.ActionRow)
and isinstance(message.components[0].children[0], discord.Button)
and message.components[0].children[0].custom_id == "opt_out_introduction_reminders_button" # noqa: COM812, E501
)
if MESSAGE_CONTAINS_OPT_IN_OUT_BUTTON:
await message.edit(view=None)
if member not in main_guild.members: # HACK: Caching errors can cause the member to no longer be part of the guild at this point, so this check must be performed before sending that member a message # noqa: FIX004
logger.info(
(
"Member with ID: %s does not need to be sent a reminder "
"because they have left the server."
),
member.id,
)
continue
try:
await member.send(
content=(
"Hey! It seems like you joined "
f"the {self.bot.group_short_name} Discord server "
"but have not yet introduced yourself.\n"
"You will only get access to the rest of the server after sending "
"an introduction message."
),
view=(
self.OptOutIntroductionRemindersView(self.bot)
if settings["SEND_INTRODUCTION_REMINDERS"] == "interval"
else None # type: ignore[arg-type]
),
)
except discord.Forbidden:
logger.info(
"Failed to open DM channel with user, %s, "
"so no induction reminder was sent.",
member,
)
await SentOneOffIntroductionReminderMember.objects.acreate(
discord_id=member.id,
)
class OptOutIntroductionRemindersView(View):
"""
A discord.View containing a button to opt-in/out of introduction reminders.
This discord.View contains a single button that can change the state of whether the
member will be sent reminders to send an introduction message in
your group's Discord guild.
The view object will be sent to the member's DMs after a delay period after
joining your group's Discord guild.
"""
@override
def __init__(self, bot: TeXBot) -> None:
"""Initialise a new discord.View, to opt-in/out of introduction reminders."""
self.bot: TeXBot = bot # NOTE: See https://github.com/CSSUoB/TeX-Bot-Py-V2/issues/261
super().__init__(timeout=None)
async def send_error(self, interaction: discord.Interaction, error_code: str | None = None, message: str | None = None, logging_message: str | BaseException | None = None) -> None: # noqa: E501
"""
Construct & format an error message from the given details.
The constructed error message is then sent as the response
to the given interaction.
"""
await TeXBotBaseCog.send_error(
self.bot,
interaction,
interaction_name="opt_out_introduction_reminders",
error_code=error_code,
message=message,
logging_message=logging_message,
)
@ui.button( # type: ignore[misc]
label="Opt-out of introduction reminders",
custom_id="opt_out_introduction_reminders_button",
style=discord.ButtonStyle.red,
emoji=discord.PartialEmoji.from_str(
emoji.emojize(":no_good:", language="alias"),
),
)
async def opt_out_introduction_reminders_button_callback(self, button: discord.Button, interaction: discord.Interaction) -> None: # noqa: E501
"""
Set the opt-in/out flag depending on the status of the button.
This function is attached as a button's callback, so will run whenever the button
is pressed.
"""
BUTTON_WILL_MAKE_OPT_OUT: Final[bool] = bool(
button.style == discord.ButtonStyle.red
or str(button.emoji) == emoji.emojize(":no_good:", language="alias")
or (button.label and "Opt-out" in button.label) # noqa: COM812
)
BUTTON_WILL_MAKE_OPT_IN: Final[bool] = bool(
button.style == discord.ButtonStyle.green
or str(button.emoji) == emoji.emojize(
":raised_hand:",
language="alias",
)
or (button.label and "Opt back in" in button.label) # noqa: COM812
)
INCOMPATIBLE_BUTTONS: Final[bool] = bool(
(BUTTON_WILL_MAKE_OPT_OUT and BUTTON_WILL_MAKE_OPT_IN)
or (not BUTTON_WILL_MAKE_OPT_OUT and not BUTTON_WILL_MAKE_OPT_IN) # noqa: COM812
)
if INCOMPATIBLE_BUTTONS:
INCOMPATIBLE_BUTTONS_MESSAGE: Final[str] = "Conflicting buttons pressed"
raise ValueError(INCOMPATIBLE_BUTTONS_MESSAGE)
del BUTTON_WILL_MAKE_OPT_IN
if not interaction.user:
await self.send_error(interaction)
return
try:
interaction_member: discord.Member = await self.bot.get_main_guild_member(
interaction.user,
)
except DiscordMemberNotInMainGuildError:
await self.send_error(
interaction,
message=(
f"You must be a member "
f"of the {self.bot.group_short_name} Discord server "
f"""to opt{
"-out of" if BUTTON_WILL_MAKE_OPT_OUT else " back in to"
} introduction reminders."""
),
)
return
if BUTTON_WILL_MAKE_OPT_OUT:
try:
await IntroductionReminderOptOutMember.objects.acreate(
discord_id=interaction_member.id,
)
except ValidationError as create_introduction_reminder_opt_out_member_error:
error_is_already_exists: bool = (
"hashed_member_id" in create_introduction_reminder_opt_out_member_error.message_dict # noqa: E501
and any(
"already exists" in error
for error
in create_introduction_reminder_opt_out_member_error.message_dict[
"hashed_member_id"
]
)
)
if not error_is_already_exists:
raise
button.style = discord.ButtonStyle.green
button.label = "Opt back in to introduction reminders"
button.emoji = discord.PartialEmoji.from_str(
emoji.emojize(":raised_hand:", language="alias"),
)
await interaction.response.edit_message(view=self)
else:
try:
introduction_reminder_opt_out_member: IntroductionReminderOptOutMember = (
await IntroductionReminderOptOutMember.objects.aget( # type: ignore[assignment]
discord_id=interaction_member.id,
)
)
except IntroductionReminderOptOutMember.DoesNotExist:
pass
else:
await introduction_reminder_opt_out_member.adelete()
button.style = discord.ButtonStyle.red
button.label = "Opt-out of introduction reminders"
button.emoji = discord.PartialEmoji.from_str(
emoji.emojize(":no_good:", language="alias"),
)
await interaction.response.edit_message(view=self)
@send_introduction_reminders.before_loop
async def before_tasks(self) -> None:
"""Pre-execution hook, preventing any tasks from executing before the bot is ready."""
await self.bot.wait_until_ready()