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
|
import logging
import random
import discord
from discord.ext import commands
from bot.bot import Bot
from bot.constants import Colours, ERROR_REPLIES, Icons, Roles
from bot.utils.decorators import whitelist_override
log = logging.getLogger(__name__)
class BookmarkForm(discord.ui.Modal):
"""The form where a user can fill in a custom title for their bookmark & submit it."""
bookmark_title = discord.ui.TextInput(
label="Choose a title for your bookmark (optional)",
placeholder="Type your bookmark title here",
default="Bookmark",
max_length=50,
min_length=0,
required=False,
)
def __init__(self, message: discord.Message):
super().__init__(timeout=1000, title="Name your bookmark")
self.message = message
async def on_submit(self, interaction: discord.Interaction) -> None:
"""Sends the bookmark embed to the user with the newly chosen title."""
title = self.bookmark_title.value or self.bookmark_title.default
try:
await self.dm_bookmark(interaction, self.message, title)
except discord.Forbidden:
await interaction.response.send_message(
embed=Bookmark.build_error_embed("Enable your DMs to receive the bookmark."),
ephemeral=True,
)
return
await interaction.response.send_message(
embed=Bookmark.build_success_reply_embed(self.message),
ephemeral=True,
)
async def dm_bookmark(
self,
interaction: discord.Interaction,
target_message: discord.Message,
title: str,
) -> None:
"""
Sends the target_message as a bookmark to the interaction user's DMs.
Raises ``discord.Forbidden`` if the user's DMs are closed.
"""
embed = Bookmark.build_bookmark_dm(target_message, title)
message_url_view = discord.ui.View().add_item(
discord.ui.Button(label="View Message", url=target_message.jump_url)
)
await interaction.user.send(embed=embed, view=message_url_view)
log.info(f"{interaction.user} bookmarked {target_message.jump_url} with title {title!r}")
class Bookmark(commands.Cog):
"""Creates personal bookmarks by relaying a message link to the user's DMs."""
def __init__(self, bot: Bot):
self.bot = bot
self.book_mark_context_menu = discord.app_commands.ContextMenu(
name="Bookmark",
callback=self._bookmark_context_menu_callback,
)
self.bot.tree.add_command(self.book_mark_context_menu, guild=discord.Object(bot.guild_id))
@staticmethod
def build_success_reply_embed(target_message: discord.Message) -> discord.Embed:
"""Build the ephemeral reply embed to the bookmark requester."""
return discord.Embed(
description=(
f"A bookmark for [this message]({target_message.jump_url}) has been successfully sent your way."
),
colour=Colours.soft_green,
)
@staticmethod
def build_bookmark_dm(target_message: discord.Message, title: str) -> discord.Embed:
"""Build the embed that is DM'd to the bookmark requester."""
embed = discord.Embed(title=title, description=target_message.content, colour=Colours.soft_green)
embed.set_author(
name=target_message.author,
icon_url=target_message.author.display_avatar.url,
)
embed.set_thumbnail(url=Icons.bookmark)
return embed
@staticmethod
def build_error_embed(message: str) -> discord.Embed:
"""Builds an error embed for a given message."""
return discord.Embed(
title=random.choice(ERROR_REPLIES),
description=message,
colour=Colours.soft_red,
)
async def _bookmark_context_menu_callback(self, interaction: discord.Interaction, message: discord.Message) -> None:
"""The callback that will be invoked upon using the bookmark's context menu command."""
permissions = interaction.channel.permissions_for(interaction.user)
if not permissions.read_messages:
log.info(
f"{interaction.user} tried to bookmark a message in #{interaction.channel} but doesn't have permission."
)
embed = self.build_error_embed("You don't have permission to view this channel.")
await interaction.response.send_message(embed=embed)
return
bookmark_title_form = BookmarkForm(message=message)
await interaction.response.send_modal(bookmark_title_form)
@commands.group(name="bookmark", aliases=("bm", "pin"), invoke_without_command=True)
@commands.guild_only()
@whitelist_override(roles=(Roles.everyone,))
@commands.cooldown(1, 30, commands.BucketType.channel)
async def bookmark(self, ctx: commands.Context) -> None:
"""Teach the invoker how to use the new context-menu based command for a smooth migration."""
await ctx.send(
embed=self.build_error_embed(
"The bookmark text command has been replaced with a context menu command!\n\n"
"To bookmark a message simply right-click (press and hold on mobile) "
"on a message, open the 'Apps' menu, and click 'Bookmark'."
)
)
@bookmark.command(name="delete", aliases=("del", "rm"), root_aliases=("unbm", "unbookmark", "dmdelete", "dmdel"))
@whitelist_override(bypass_defaults=True, allow_dm=True)
async def delete_bookmark(
self,
ctx: commands.Context,
) -> None:
"""
Delete the Sir-Lancebot message that the command invocation is replying to.
This command allows deleting any message sent by Sir-Lancebot in the user's DM channel with the bot.
The command invocation must be a reply to the message that is to be deleted.
"""
target_message: discord.Message | None = getattr(ctx.message.reference, "resolved", None)
if target_message is None:
raise commands.UserInputError("You must reply to the message from Sir-Lancebot you wish to delete.")
if not isinstance(ctx.channel, discord.DMChannel):
raise commands.UserInputError("You can only run this command your own DMs!")
if target_message.channel != ctx.channel:
raise commands.UserInputError("You can only delete messages in your own DMs!")
if target_message.author != self.bot.user:
raise commands.UserInputError("You can only delete messages sent by Sir Lancebot!")
await target_message.delete()
async def setup(bot: Bot) -> None:
"""Load the Bookmark cog."""
await bot.add_cog(Bookmark(bot))
|
