-
Notifications
You must be signed in to change notification settings - Fork 43
/
welcomecount.py
188 lines (168 loc) · 7.61 KB
/
welcomecount.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
"""Module for the WelcomeCount Cog."""
# Copyright (c) 2017-2018 Tobotimus
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
import datetime
from typing import List
import discord
from redbot.core import Config, checks, commands
from redbot.core.utils.chat_formatting import box
__all__ = ["UNIQUE_ID", "WelcomeCount"]
UNIQUE_ID = 0x6F7951A4
_DEFAULT_WELCOME = (
"Welcome, {mention}, to {server}!\n\n" "{count} user{plural} joined today!"
)
class WelcomeCount(getattr(commands, "Cog", object)):
"""A special welcome cog which keeps a daily count of new users.
Idea came from Twentysix's version of Red on the official Red-DiscordBot
server.
"""
def __init__(self):
self.conf: Config = Config.get_conf(
self, identifier=UNIQUE_ID, force_registration=True
)
self.conf.register_channel(
enabled=False,
last_message=None,
delete_last_message=True,
welcome_msg=_DEFAULT_WELCOME,
)
self.conf.register_channel(
enabled=False, last_message=None, welcome_msg=_DEFAULT_WELCOME
)
self.conf.register_guild(count=0, day=None)
@commands.group(invoke_without_command=True)
@commands.guild_only()
@checks.admin_or_permissions(manage_guild=True)
async def wcount(self, ctx: commands.Context):
"""Manage settings for WelcomeCount."""
if not ctx.invoked_subcommand:
await ctx.send_help()
channel: discord.TextChannel = ctx.channel
settings = self.conf.channel(channel)
if await settings.enabled():
msg: str = await settings.welcome_msg()
delete_last: bool = await settings.delete_last_message()
await ctx.send(
box(
"Enabled in this channel.\n"
"Deletion of previous welcome message enabled: {0}\n"
"Welcome message: {1}"
"".format(delete_last, msg)
)
)
else:
await ctx.send(box("Disabled in this channel."))
@wcount.command(name="toggle", pass_context=True)
async def wcount_toggle(self, ctx: commands.Context):
"""Enable/disable welcome messages in this channel."""
channel: discord.TextChannel = ctx.channel
settings = self.conf.channel(channel)
now_enabled: bool = not await settings.enabled()
await settings.enabled.set(now_enabled)
await ctx.send(
"Welcome messages are now {0} in this channel."
"".format("enabled" if now_enabled else "disabled")
)
@wcount.command(name="message", pass_context=True, no_pm=True)
async def wcount_message(self, ctx: commands.Context, *, message: str):
"""Set the bot's welcome message.
This message can be formatted using these parameters:
mention - Mention the user who joined
username - The user's display name
server - The name of the server
count - The number of users who joined today.
plural - Empty if count is 1. 's' otherwise.
To format the welcome message with the above parameters, include them
in your message surrounded by curly braces {}.
"""
channel: discord.TextChannel = ctx.channel
settings = self.conf.channel(channel)
await settings.welcome_msg.set(message)
member: discord.Member = ctx.author
count: int = await self.conf.guild(ctx.guild).count()
params = {
"mention": member.mention,
"username": member.display_name,
"server": ctx.guild.name,
"count": count,
"plural": "" if count == 1 else "s",
}
await ctx.send("Welcome message set, sending a test message here...")
await ctx.send(message.format(**params))
@wcount.command(name="deletelast", pass_context=True)
async def wcount_deletelast(self, ctx: commands.Context):
"""Enable/disable deleting previous welcome message in this channel.
When enabled, the last message is deleted *only* if it was sent on
the same day as the new welcome message.
"""
channel: discord.TextChannel = ctx.channel
settings = self.conf.channel(channel)
now_deleting: bool = not await settings.delete_last_message()
await settings.delete_last_message.set(now_deleting)
await ctx.send(
"Deleting welcome messages are now {0} in this channel."
"".format("enabled" if now_deleting else "disabled")
)
# Events
@commands.Cog.listener()
async def on_member_join(self, member: discord.Member):
"""Send the welcome message and update the last message."""
guild: discord.Guild = member.guild
server_settings = self.conf.guild(guild)
today: datetime.date = datetime.date.today()
new_day: bool = False
if await server_settings.day() == str(today):
cur_count: int = await server_settings.count()
await server_settings.count.set(cur_count + 1)
else:
new_day = True
await server_settings.day.set(str(today))
await server_settings.count.set(1)
welcome_channels: List[discord.TextChannel] = []
# noinspection PyUnusedLocal
channel: discord.TextChannel
for channel in guild.channels:
if await self.conf.channel(channel).enabled():
welcome_channels.append(channel)
for channel in welcome_channels:
channel_settings = self.conf.channel(channel)
delete_last: bool = await channel_settings.delete_last_message()
if delete_last and not new_day:
last_message: int = await channel_settings.last_message()
try:
last_message: discord.Message = await channel.fetch_message(
last_message
)
except discord.HTTPException:
# Perhaps the message was deleted
pass
else:
await last_message.delete()
count: int = await server_settings.count()
params = {
"mention": member.mention,
"username": member.display_name,
"server": guild.name,
"count": count,
"plural": "" if count == 1 else "s",
}
welcome: str = await channel_settings.welcome_msg()
msg: discord.Message = await channel.send(welcome.format(**params))
await channel_settings.last_message.set(msg.id)