srp/diakonos
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

initial commit.

Browse Source
This commit is contained in:
Seraphim R. Pardee 2024-01-17 00:20:44 -05:00
commit df167f832c
33 changed files with 4105 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
README Normal file
View File

@ -0,0 +1,48 @@
diakonos
========
diakonos is a repository of in-house cogs for self-hosted RedBot instances. It gets its name from the Greek word for "deacon", "διάκονος."
Requirements
------------
diakonos has been tested and modified to ensure compatibility with:
- Python 3.11
- Red-DiscordBot 3.5.5
diakonos requires the following Python packages:
- feedparser
- beautifulsoup4
Installation
------------
For feature parity with our instances, the following internal RedBot cogs need to be enabled with the following command:
```
.load admin alias cleanup customcom downloader economy general mod modlog mutes trivia warnings
```
The following cogs from the following sources:
- `avatar` from https://github.com/skeith/MayuYukirin
- `compliment` from https://github.com/TrustyJAID/Trusty-cogs
- `dictionary` from https://github.com/aikaterna/aikaterna-cogs
- `disboardreminder` from https://github.com/phenom4n4n/phen-cogs
- `errorlogs` from https://github.com/Tobotimus/Tobo-Cogs
- `extendedmodlog` from https://github.com/TrustyJAID/Trusty-cogs
- `forcemention` from https://github.com/phenom4n4n/phen-cogs
- `hangman` from https://github.com/Flame442/FlameCogs
- `hunting` from https://github.com/vertyco/vrt-cogs
- `levelup` from https://github.com/vertyco/vrt-cogs
- `msgvote` from https://github.com/flapjax/FlapJack-Cogs
- `reactpoll` from https://github.com/flapjax/FlapJack-Cogs
- `rekt` from https://github.com/TrustyJAID/Trusty-cogs
- `remindme` from https://github.com/PhasecoreX/PCXCogs
- `say` from https://github.com/laggron42/Laggrons-Dumb-Cogs
- `seen` from https://github.com/aikaterna/aikaterna-cogs
- `smartreact` from https://github.com/flapjax/FlapJack-Cogs
- `starboard` from https://github.com/TrustyJAID/Trusty-cogs
- `userinfo` from https://github.com/flaree/flare-cogs
- `uwu` from https://github.com/PhasecoreX/PCXCogs
- `wikipedia` from https://github.com/PhasecoreX/PCXCogs
For the remaining cogs, provided within this repository:
```
.load autorole cherubim reactrole rss stickyroles
```

19
autorole/LICENSE Normal file
View File

@ -0,0 +1,19 @@
Copyright (c) 2017 TrustyJAID
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.

14
autorole/__init__.py Normal file
View File

@ -0,0 +1,14 @@
import json
from pathlib import Path
from .autorole import Autorole
with open(Path(__file__).parent / "info.json") as fp:
__red_end_user_data_statement__ = json.load(fp)["end_user_data_statement"]
def setup(bot):
n = Autorole(bot)
bot.add_cog(n)
# bot.add_listener(n._roler, "on_member_join")
# bot.add_listener(n._verify_json, "on_error")

470
autorole/autorole.py Normal file
View File

@ -0,0 +1,470 @@
import logging
import random
import string
from typing import Optional, cast
import discord
from redbot import VersionInfo, version_info
from redbot.core import Config, checks, commands
from redbot.core.i18n import Translator, cog_i18n
default_settings = {
"ENABLED": False,
"ROLE": [],
"AGREE_CHANNEL": None,
"AGREE_MSG": None,
"AGREE_KEY": None,
"DELETE_KEY": False,
}
log = logging.getLogger("red.Trusty-cogs.autorole")
_ = Translator("Autorole", __file__)
listener = getattr(commands.Cog, "listener", None) # red 3.0 backwards compatibility support
if listener is None: # thanks Sinbad
def listener(name=None):
return lambda x: x
@cog_i18n(_)
class Autorole(commands.Cog):
"""
Autorole commands. Rewritten for V3 from
https://github.com/Lunar-Dust/Dusty-Cogs/blob/master/autorole/autorole.py
"""
__author__ = ["Lunar-Dust", "TrustyJAID"]
__version__ = "1.3.2"
def __init__(self, bot):
self.bot = bot
self.config = Config.get_conf(self, 45463543548)
self.config.register_guild(**default_settings)
self.users = {}
def format_help_for_context(self, ctx: commands.Context) -> str:
"""
Thanks Sinbad!
"""
pre_processed = super().format_help_for_context(ctx)
return f"{pre_processed}\n\nCog Version: {self.__version__}"
async def red_delete_data_for_user(self, **kwargs):
"""
Nothing to delete
"""
return
async def _no_perms(self, channel: Optional[discord.TextChannel] = None) -> None:
m = _(
"It appears that you haven't given this "
"bot enough permissions to use autorole. "
'The bot requires the "Manage Roles" and '
'the "Manage Messages" permissions in'
"order to use autorole. You can change the "
'permissions in the "Roles" tab of the '
"guild settings."
)
if channel is None:
log.info(m)
return
if channel.permissions_for(channel.guild.me).send_messages:
await channel.send(m)
else:
log.info(m + _("\n I also don't have permission to speak in #") + channel.name)
async def get_colour(self, channel: discord.TextChannel) -> discord.Colour:
try:
return await self.bot.get_embed_colour(channel)
except AttributeError:
if await self.bot.db.guild(channel.guild).use_bot_color():
return channel.guild.me.colour
else:
return await self.bot.db.color()
@commands.Cog.listener()
async def on_message(self, message: discord.Message) -> None:
guild = message.guild
if not guild:
return
if version_info >= VersionInfo.from_str("3.4.0"):
if await self.bot.cog_disabled_in_guild(self, guild):
return
user = cast(discord.Member, message.author)
channel = message.channel
agree_channel = cast(
discord.TextChannel, guild.get_channel(await self.config.guild(guild).AGREE_CHANNEL())
)
if guild is None:
return
if agree_channel is None:
return
if channel.id != agree_channel.id:
return
if user.bot:
return
if user.id in self.users:
if not guild.me.guild_permissions.manage_roles:
await self._no_perms(agree_channel)
return
if self.users[user.id]["key"].lower() in message.content.lower():
perms = agree_channel.permissions_for(guild.me)
roles_id = await self.config.guild(guild).ROLE()
roles = [role for role in guild.roles if role.id in roles_id]
for role in roles:
await user.add_roles(role, reason=_("Agreed to the rules"))
if perms.manage_messages and await self.config.guild(guild).DELETE_KEY():
try:
await message.delete()
except Exception:
pass
if self.users[user.id]["message"].guild:
try:
await self.users[user.id]["message"].delete()
except Exception:
pass
elif perms.add_reactions:
await message.add_reaction("✅")
del self.users[user.id]
async def _agree_maker(self, member: discord.Member) -> None:
guild = member.guild
self.last_guild = guild
# await self._verify_json(None)
key = await self.config.guild(guild).AGREE_KEY()
if key is None:
key = "".join(random.choice(string.ascii_uppercase + string.digits) for _ in range(6))
# <3 Stackoverflow http://stackoverflow.com/questions/2257441/random-string-generation-with-upper-case-letters-and-digits-in-python/23728630#23728630
ch = cast(
discord.TextChannel, guild.get_channel(await self.config.guild(guild).AGREE_CHANNEL())
)
msg = await self.config.guild(guild).AGREE_MSG()
if msg is None:
msg = "{mention} please enter {key} in {channel}"
try:
msg = msg.format(
key=key,
member=member,
name=member.name,
mention=member.mention,
guild=guild.name,
channel=ch.mention,
)
except Exception:
log.error("Error formatting agreement message", exc_info=True)
try:
msg = await member.send(msg)
except discord.Forbidden:
msg = await ch.send(msg)
except discord.HTTPException:
return
self.users[member.id] = {"key": key, "message": msg}
async def _auto_give(self, member: discord.Member) -> None:
guild = member.guild
roles_id = await self.config.guild(guild).ROLE()
roles = [role for role in guild.roles if role.id in roles_id]
if not guild.me.guild_permissions.manage_roles:
await self._no_perms()
return
for role in roles:
await member.add_roles(role, reason=_("Joined the server"))
@commands.Cog.listener()
async def on_member_join(self, member: discord.Member) -> None:
if "h0nde" in member.name or "h0nda" in member.name:
await member.ban(reason="Anti-spam measure.")
guild = member.guild
if await self.config.guild(guild).ENABLED():
if await self.config.guild(guild).AGREE_CHANNEL() is not None:
await self._agree_maker(member)
elif member.guild.name != "BibleBot": # Immediately give the new user the role
await self._auto_give(member)
@commands.Cog.listener()
async def on_member_update(self, before: discord.Member, after: discord.Member) -> None:
if before.guild.name == "BibleBot":
if before.pending == True and after.pending == False:
await after.add_roles(before.guild.get_role(366901317924290562))
@commands.guild_only()
@commands.group(name="autorole")
@commands.bot_has_permissions(manage_roles=True)
async def autorole(self, ctx: commands.Context) -> None:
"""
Change settings for autorole
Requires the manage roles permission
"""
pass
@autorole.command(name="info")
async def autorole_info(self, ctx: commands.Context) -> None:
"""
Display current autorole info
"""
guild = ctx.message.guild
enabled = await self.config.guild(guild).ENABLED()
roles = await self.config.guild(guild).ROLE()
msg = await self.config.guild(guild).AGREE_MSG()
key = await self.config.guild(guild).AGREE_KEY()
ch_id = await self.config.guild(guild).AGREE_CHANNEL()
delete = await self.config.guild(guild).DELETE_KEY()
channel = guild.get_channel(ch_id)
chn_name = channel.name if channel is not None else "None"
chn_mention = channel.mention if channel is not None else "None"
role_name_str = ", ".join(role.mention for role in guild.roles if role.id in roles)
if not role_name_str:
role_name_str = "None"
if ctx.channel.permissions_for(ctx.me).embed_links:
embed = discord.Embed(colour=await self.get_colour(ctx.channel))
embed.set_author(name=_("Autorole settings for ") + guild.name)
embed.add_field(name=_("Current autorole state: "), value=str(enabled))
embed.add_field(name=_("Current Roles: "), value=str(role_name_str))
if msg:
embed.add_field(name=_("Agreement message: "), value=str(msg))
if key:
embed.add_field(name=_("Agreement key: "), value=str(key))
if channel:
embed.add_field(name=_("Agreement channel: "), value=str(chn_mention))
await ctx.send(embed=embed)
else:
send_msg = (
"```"
+ _("Current autorole state: ")
+ f"{enabled}\n"
+ _("Current Roles: ")
+ f"{role_name_str}\n"
+ _("Agreement message: ")
+ f"{msg}\n"
+ _("Agreement key: ")
+ f"{key}\n"
+ _("Delete Agreement: ")
+ f"{delete}\n"
+ _("Agreement channel: ")
+ f"{chn_name}"
+ "```"
)
await ctx.send(send_msg)
@autorole.command()
@checks.admin_or_permissions(manage_roles=True)
async def toggle(self, ctx: commands.Context) -> None:
"""
Enables/Disables autorole
"""
guild = ctx.message.guild
if await self.config.guild(guild).ROLE() is None:
msg = _("You haven't set a " "role to give to new users!")
await ctx.send(msg)
else:
if await self.config.guild(guild).ENABLED():
await self.config.guild(guild).ENABLED.set(False)
await ctx.send(_("Autorole is now disabled."))
else:
await self.config.guild(guild).ENABLED.set(True)
await ctx.send(_("Autorole is now enabled."))
@autorole.command(name="add", aliases=["role"])
@checks.admin_or_permissions(manage_roles=True)
async def role(self, ctx: commands.Context, *, role: discord.Role) -> None:
"""
Add a role for autorole to assign.
You can use this command multiple times to add multiple roles.
"""
guild = ctx.message.guild
roles = await self.config.guild(guild).ROLE()
if ctx.author.top_role < role:
msg = _(
" is higher than your highest role. "
"You can't assign autoroles higher than your own"
)
await ctx.send(role.name + msg)
if role.id in roles:
await ctx.send(role.name + _(" is already in the autorole list."))
return
if guild.me.top_role < role:
msg = _(" is higher than my highest role" " in the Discord hierarchy.")
await ctx.send(role.name + msg)
return
roles.append(role.id)
await self.config.guild(guild).ROLE.set(roles)
await ctx.send(role.name + _(" role added to the autorole."))
@autorole.command()
@checks.admin_or_permissions(manage_roles=True)
async def remove(self, ctx: commands.Context, *, role: discord.Role) -> None:
"""
Remove a role from the autorole.
"""
guild = ctx.message.guild
roles = await self.config.guild(guild).ROLE()
if role.id not in roles:
await ctx.send(role.name + _(" is not in the autorole list."))
return
roles.remove(role.id)
await self.config.guild(guild).ROLE.set(roles)
await ctx.send(role.name + _(" role removed from the autorole."))
@autorole.group()
@checks.admin_or_permissions(manage_roles=True)
async def agreement(self, ctx: commands.Context) -> None:
"""
Set the channel and message that will be used for accepting the rules.
`channel` is the channel they must type the key in to get the role.
`key` is the message they must type to gain access and must be in quotes.
`msg` is the message DM'd to them when they join.
`{key}` must be included in the message so a user knows what to type in the channel.
Optional additions to the message include:
`{channel}` Mentions the channel where they must include the agreement message.
`{mention}` Mentions the user incase they have DM permissions turned off this should be used.
`{name}` Says the member name if you don't want to ping them.
`{guild}` Says the servers current name.
Entering nothing will disable these.
"""
pass
@agreement.command(name="channel")
@checks.admin_or_permissions(manage_roles=True)
async def set_agreement_channel(
self, ctx: commands.Context, channel: discord.TextChannel = None
) -> None:
"""
Set the agreement channel
Entering nothing will clear this.
"""
guild = ctx.message.guild
if await self.config.guild(guild).ROLE() == []:
await ctx.send(_("No roles have been set for autorole."))
return
if not await self.config.guild(guild).ENABLED():
await ctx.send(_("Autorole has been disabled, enable it first."))
return
if channel is None:
await self.config.guild(guild).AGREE_CHANNEL.set(None)
await ctx.send(_("Agreement channel cleared"))
else:
await self.config.guild(guild).AGREE_CHANNEL.set(channel.id)
await ctx.send(_("Agreement channel set to ") + channel.mention)
@agreement.command(name="delete")
@checks.admin_or_permissions(manage_roles=True)
async def set_agreement_delete(self, ctx: commands.Context) -> None:
"""
Toggle automatically deleting the agreement message.
"""
delete_key = await self.config.guild(ctx.guild).DELETE_KEY()
await self.config.guild(ctx.guild).DELETE_KEY.set(not delete_key)
if delete_key:
await ctx.send(_("No longer automatically deleting agreement key."))
else:
await ctx.send(_("Automatically deleting agreement key."))
@agreement.command(name="key")
@checks.admin_or_permissions(manage_roles=True)
async def set_agreement_key(self, ctx: commands.Context, *, key: str = None) -> None:
"""
Set the agreement key
Entering nothing will clear this.
"""
guild = ctx.message.guild
if await self.config.guild(guild).ROLE() == []:
await ctx.send(_("No roles have been set for autorole."))
return
if not await self.config.guild(guild).ENABLED():
await ctx.send(_("Autorole has been disabled, enable it first."))
return
if key is None:
await self.config.guild(guild).AGREE_KEY.set(None)
await ctx.send(_("Agreement key cleared"))
else:
await self.config.guild(guild).AGREE_KEY.set(key)
await ctx.send(_("Agreement key set to ") + key)
@agreement.command(name="message", aliases=["msg"])
@checks.admin_or_permissions(manage_roles=True)
async def set_agreement_msg(self, ctx: commands.Context, *, message: str = None) -> None:
"""
Set the agreement message
`{key}` must be included in the message so a user knows what to type in the channel.
Optional additions to the message include:
`{channel}` Mentions the channel where they must include the agreement message.
`{mention}` Mentions the user incase they have DM permissions turned off this should be used.
`{name}` Says the member name if you don't want to ping them.
`{guild}` Says the servers current name.
Entering nothing will clear this.
"""
guild = ctx.message.guild
if await self.config.guild(guild).ROLE() == []:
await ctx.send(_("No roles have been set for autorole."))
return
if not await self.config.guild(guild).ENABLED():
await ctx.send(_("Autorole has been disabled, enable it first."))
return
if message is None:
await self.config.guild(guild).AGREE_MSG.set(None)
await ctx.send(_("Agreement message cleared"))
else:
await self.config.guild(guild).AGREE_MSG.set(message)
await ctx.send(_("Agreement message set to ") + message)
@agreement.command(name="setup")
@checks.admin_or_permissions(manage_roles=True)
async def agreement_setup(
self,
ctx: commands.Context,
channel: discord.TextChannel = None,
key: str = None,
*,
msg: str = None,
) -> None:
"""
Set the channel and message that will be used for accepting the rules.
`channel` is the channel they must type the key in to get the role.
`key` is the message they must type to gain access and must be in quotes.
`msg` is the message DM'd to them when they join.
`{key}` must be included in the message so a user knows what to type in the channel.
Optional additions to the message include:
`{channel}` Mentions the channel where they must include the agreement message.
`{mention}` Mentions the user incase they have DM permissions turned off this should be used.
`{name}` Says the member name if you don't want to ping them.
`{guild}` Says the servers current name.
Entering nothing will disable this.
"""
guild = ctx.message.guild
if await self.config.guild(guild).ROLE() == []:
await ctx.send(_("No roles have been set for autorole."))
return
if not await self.config.guild(guild).ENABLED():
await ctx.send(_("Autorole has been disabled, enable it first."))
return
if channel is None:
await self.config.guild(guild).AGREE_CHANNEL.set(None)
await self.config.guild(guild).AGREE_MSG.set(None)
await self.config.guild(guild).AGREE_KEY.set(None)
await ctx.send(_("Agreement channel cleared"))
else:
await self.config.guild(guild).AGREE_CHANNEL.set(channel.id)
await self.config.guild(guild).AGREE_MSG.set(msg)
await self.config.guild(guild).AGREE_KEY.set(key)
await ctx.send(_("Agreement channel set to ") + channel.mention)

27
autorole/info.json Normal file
View File

@ -0,0 +1,27 @@
{
"author" : [
"Lunar Dust",
"TrustyJAID"
],
"description" : "Automatically apply roles when a user joins the server.",
"disabled" : false,
"end_user_data_statement" : "This cog does not persistently store data or metadata about users.",
"hidden" : true,
"install_msg" : "Thanks for installing.",
"max_bot_version" : "0.0.0",
"min_bot_version" : "3.1.8",
"min_python_version" : [
3,
7,
2
],
"name" : "Autorole",
"permissions" : [
"manage_roles"
],
"required_cogs" : {},
"requirements" : [],
"short" : "Automatically apply a role to new users",
"tags" : [],
"type" : "COG"
}

249
autorole/locales/messages.pot Normal file
View File

@ -0,0 +1,249 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) YEAR ORGANIZATION
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"POT-Creation-Date: 2018-12-20 10:32-0700\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: redgettext 2.1\n"
#: autorole.py:20
#, docstring
msgid ""
"\n"
" Autorole commands. Rewritten for V3 from \n"
" https://github.com/Lunar-Dust/Dusty-Cogs/blob/master/autorole/autorole.py\n"
" "
msgstr ""
#: autorole.py:32
msgid "It appears that you haven't given this bot enough permissions to use autorole. The bot requires the \"Manage Roles\" and the \"Manage Messages\" permissions inorder to use autorole. You can change the permissions in the \"Roles\" tab of the guild settings."
msgstr ""
#: autorole.py:45
msgid ""
"\n"
" I also don't have permission to speak in #"
msgstr ""
#: autorole.py:79
msgid "Agreed to the rules"
msgstr ""
#: autorole.py:125
msgid "Joined the server"
msgstr ""
#: autorole.py:139
#, docstring
msgid ""
"\n"
" Change settings for autorole\n"
"\n"
" Requires the manage roles permission\n"
" "
msgstr ""
#: autorole.py:159
msgid "Autorole settings for "
msgstr ""
#: autorole.py:160 autorole.py:172
msgid "Current autorole state: "
msgstr ""
#: autorole.py:161 autorole.py:173
msgid "Current Roles: "
msgstr ""
#: autorole.py:163 autorole.py:174
msgid "Agreement message: "
msgstr ""
#: autorole.py:165 autorole.py:175
msgid "Agreement key: "
msgstr ""
#: autorole.py:167 autorole.py:176
msgid "Agreement channel: "
msgstr ""
#: autorole.py:183
#, docstring
msgid ""
"\n"
" Enables/Disables autorole\n"
" "
msgstr ""
#: autorole.py:188
msgid "You haven't set a role to give to new users!"
msgstr ""
#: autorole.py:194
msgid "Autorole is now disabled."
msgstr ""
#: autorole.py:197
msgid "Autorole is now enabled."
msgstr ""
#: autorole.py:202
#, docstring
msgid ""
"\n"
" Add a role for autorole to assign.\n"
" \n"
" You can use this command multiple times to add multiple roles.\n"
" "
msgstr ""
#: autorole.py:210
msgid " is higher than your highest role. You can't assign autoroles higher than your own"
msgstr ""
#: autorole.py:214
msgid " is already in the autorole list."
msgstr ""
#: autorole.py:217
msgid " is higher than my highest role in the Discord hierarchy."
msgstr ""
#: autorole.py:223
msgid " role added to the autorole."
msgstr ""
#: autorole.py:228
#, docstring
msgid ""
"\n"
" Remove a role from the autorole.\n"
" "
msgstr ""
#: autorole.py:234
msgid " is not in the autorole list."
msgstr ""
#: autorole.py:238
msgid " role removed from the autorole."
msgstr ""
#: autorole.py:244
#, docstring
msgid ""
"\n"
" Set the channel and message that will be used for accepting the rules.\n"
" \n"
" `channel` is the channel they must type the key in to get the role.\n"
" `key` is the message they must type to gain access and must be in quotes.\n"
" `msg` is the message DM'd to them when they join.\n"
"\n"
" `{key}` must be included in the message so a user knows what to type in the channel.\n"
" \n"
" Optional additions to the message include:\n"
" `{channel}` Mentions the channel where they must include the agreement message.\n"
" `{mention}` Mentions the user incase they have DM permissions turned off this should be used.\n"
" `{name}` Says the member name if you don't want to ping them.\n"
" `{guild}` Says the servers current name.\n"
" \n"
" Entering nothing will disable these.\n"
" "
msgstr ""
#: autorole.py:269
#, docstring
msgid ""
"\n"
" Set the agreement channel\n"
"\n"
" Entering nothing will clear this.\n"
" "
msgstr ""
#: autorole.py:276 autorole.py:299 autorole.py:328 autorole.py:367
msgid "No roles have been set for autorole."
msgstr ""
#: autorole.py:279 autorole.py:302 autorole.py:331 autorole.py:370
msgid "Autorole has been disabled, enable it first."
msgstr ""
#: autorole.py:283 autorole.py:376
msgid "Agreement channel cleared"
msgstr ""
#: autorole.py:286 autorole.py:381
msgid "Agreement channel set to "
msgstr ""
#: autorole.py:291
#, docstring
msgid ""
"\n"
" Set the agreement key\n"
"\n"
" Entering nothing will clear this.\n"
" "
msgstr ""
#: autorole.py:306
msgid "Agreement key cleared"
msgstr ""
#: autorole.py:309 autorole.py:338
msgid "Agreement key set to "
msgstr ""
#: autorole.py:314
#, docstring
msgid ""
"\n"
" Set the agreement message\n"
" `{key}` must be included in the message so a user knows what to type in the channel.\n"
"\n"
" Optional additions to the message include:\n"
" `{channel}` Mentions the channel where they must include the agreement message.\n"
" `{mention}` Mentions the user incase they have DM permissions turned off this should be used.\n"
" `{name}` Says the member name if you don't want to ping them.\n"
" `{guild}` Says the servers current name.\n"
"\n"
" Entering nothing will clear this.\n"
" "
msgstr ""
#: autorole.py:335
msgid "Agreement message cleared"
msgstr ""
#: autorole.py:348
#, docstring
msgid ""
"\n"
" Set the channel and message that will be used for accepting the rules.\n"
" \n"
" `channel` is the channel they must type the key in to get the role.\n"
" `key` is the message they must type to gain access and must be in quotes.\n"
" `msg` is the message DM'd to them when they join.\n"
"\n"
" `{key}` must be included in the message so a user knows what to type in the channel.\n"
" \n"
" Optional additions to the message include:\n"
" `{channel}` Mentions the channel where they must include the agreement message.\n"
" `{mention}` Mentions the user incase they have DM permissions turned off this should be used.\n"
" `{name}` Says the member name if you don't want to ping them.\n"
" `{guild}` Says the servers current name.\n"
" \n"
" Entering nothing will disable this.\n"
" "
msgstr ""

19
cherubim/LICENSE Normal file
View File

@ -0,0 +1,19 @@
Copyright (c) 2019-2023 Seraphim R. Pardee and contributors
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.

26
cherubim/__init__.py Normal file
View File

@ -0,0 +1,26 @@
from .autoprayer import AutoPrayer
from .suggestionbox import SuggestionBox
from .custom_reactions import CustomReactions
from .entrycontrolresponder import EntryControlResponder
from .fun import Fun
from .standards import Standards
from ..reactrole.reactrole import ReactRole
from .quotes import Quotes
async def setup(bot):
await bot.add_cog(AutoPrayer(bot))
await bot.add_cog(SuggestionBox(bot))
await bot.add_cog(CustomReactions())
await bot.add_cog(Fun())
await bot.add_cog(Standards(bot))
await bot.add_cog(ReactRole(bot))
ecr = EntryControlResponder()
await bot.add_cog(ecr)
await bot.add_cog(Quotes(bot))

102
cherubim/autoprayer.py Normal file
View File

@ -0,0 +1,102 @@
import asyncio
import os
from datetime import datetime
import discord
from redbot.core import commands, checks, Config
class AutoPrayer(commands.Cog):
def __init__(self, bot):
self.bot = bot
self.config = Config.get_conf(self, identifier=(3322665 + 2))
default_guild = {
"channels_enabled": [],
"duration": 300,
"threshold": 3,
"bot": False,
"pray": "🙏"
}
self.config.register_guild(**default_guild)
@commands.group(name="autoprayer", pass_context=True, no_pm=True)
@checks.admin_or_permissions(manage_guild=True)
async def autoprayer(self, ctx):
"""autoprayer cog settings"""
#if ctx.invoked_subcommand is None:
# await ctx.send_help()
pass
@autoprayer.command(name="on", pass_context=True, no_pm=True)
async def _autoprayer_on(self, ctx):
"""Turn on autoprayer mode in the current channel"""
guild_group = self.config.guild(ctx.guild)
async with guild_group.channels_enabled() as channels_enabled:
channel = ctx.message.channel
if channel.id in channels_enabled:
await ctx.send("AutoPrayer is already on in this channel.")
else:
channels_enabled.append(channel.id)
await ctx.send("AutoPrayer is now on in this channel.")
@autoprayer.command(name="off", pass_context=True, no_pm=True)
async def _autoprayer_off(self, ctx):
"""Turn off autoprayer mode in the current channel"""
guild_group = self.config.guild(ctx.guild)
async with guild_group.channels_enabled() as channels_enabled:
channel = ctx.message.channel
if channel.id not in channels_enabled:
await ctx.send("AutoPrayer is already off in this channel.")
else:
channels_enabled.remove(channel.id)
await ctx.send("AutoPrayer is now off in this channel.")
@autoprayer.command(name="bot", pass_context=True, no_pm=True)
async def _autoprayer_bot(self, ctx):
"""Turn on/off reactions to bot's own messages"""
await self.config.guild(ctx.guild).bot.set(not await self.config.guild(ctx.guild).bot())
if await self.config.guild(ctx.guild).bot():
await ctx.send("Reactions to bot messages turned on.")
else:
await ctx.send("Reactions to bot messages turned off.")
def is_command(self, msg):
return msg.content.startswith("--")
@commands.Cog.listener()
async def on_message(self, message):
try:
guild_group = self.config.guild(message.guild)
async with guild_group.channels_enabled() as channels_enabled:
if message.channel.id not in channels_enabled:
return
is_bot = await guild_group.bot()
if message.author == self.bot.user and not is_bot:
return
if self.is_command(message):
return
try:
if message.guild.id == 636984073226813449:
pray = [x for x in message.guild.emojis if x.name == "lightacandle"][0]
elif message.guild.name == "Orthodox Christian Women":
pray = [x for x in message.guild.emojis if x.name == "Candle"][0]
else:
pray = await guild_group.get_raw("pray")
await message.add_reaction(pray)
except discord.errors.HTTPException:
# Implement a non-spammy way to alert users in future
pass
except:
pass

182
cherubim/custom_reactions.py Normal file
View File

@ -0,0 +1,182 @@
from redbot.core import commands, checks, Config
import discord
import json
def json_to_embed(data):
embed = discord.Embed()
embed.type = "rich"
if "title" in data.keys():
embed.title = data["title"]
if "url" in data.keys():
embed.url = data["url"]
if "description" in data.keys():
embed.description = data["description"]
if "color" in data.keys():
embed.colour = data["color"]
if "author" in data.keys():
name = "None"
url = discord.Embed.Empty
icon_url = discord.Embed.Empty
if "name" in data["author"].keys():
name = data["author"]["name"]
if "url" in data["author"].keys():
url = data["author"]["url"]
if "icon_url" in data["author"].keys():
icon_url = data["author"]["icon_url"]
embed.set_author(name=name, url=url, icon_url=icon_url)
if "footer" in data.keys():
text = discord.Embed.Empty
icon_url = discord.Embed.Empty
if "text" in data["footer"].keys():
text = data["footer"]["text"]
if "icon_url" in data["footer"].keys():
icon_url = data["footer"]["icon_url"]
embed.set_footer(text=text, icon_url=icon_url)
if "image" in data.keys():
embed.set_image(url=data["image"])
if "thumbnail" in data.keys():
embed.set_thumbnail(url=data["thumbnail"])
if "fields" in data.keys():
for field in data["fields"]:
name = "None"
value = "None"
inline = True
if "name" in field:
name = field["name"]
if "value" in field:
value = field["value"]
if "inline" in field:
inline = field["inline"]
embed.add_field(name=name, value=value, inline=inline)
return embed
class CustomReactions(commands.Cog):
def __init__(self):
self.config = Config.get_conf(self, identifier=(3322665 + 3))
default_guild = {
"custom_reactions": []
}
self.config.register_guild(**default_guild)
@commands.command()
@checks.admin_or_permissions(manage_guild=True)
async def acr(self, ctx, cr_name: str, *, cr_value: str):
group = self.config.guild(ctx.guild)
async with group.custom_reactions() as custom_reactions:
sent = False
item = None
try:
json_obj = json.loads(cr_value)
name = cr_name
embed = json_to_embed(json_obj)
item = {
"name": name,
"value": cr_value
}
await ctx.send(f"Created reaction {name}, response:", embed=embed)
sent = True
except:
item = None
await ctx.send("Failed to create the embed, make sure your JSON is valid as well as any URLs.")
if sent:
custom_reactions.append(item)
@commands.command()
@checks.admin_or_permissions(manage_guild=True)
async def ecr(self, ctx, cr_name: str, *, cr_value: str):
group = self.config.guild(ctx.guild)
async with group.custom_reactions() as custom_reactions:
sent = False
item = None
existing_reaction = [x for x in custom_reactions if x["name"] == cr_name]
if existing_reaction:
custom_reactions.remove(existing_reaction[0])
try:
json_obj = json.loads(cr_value)
name = cr_name
embed = json_to_embed(json_obj)
item = {
"name": name,
"value": cr_value
}
await ctx.send(f"Edited reaction {name}, response:", embed=embed)
sent = True
except:
item = None
await ctx.send("Failed to create the embed, make sure your JSON is valid as well as any URLs.")
if sent:
custom_reactions.append(item)
@commands.command()
@checks.admin_or_permissions(manage_guild=True)
async def dcr(self, ctx, cr_name: str):
group = self.config.guild(ctx.guild)
async with group.custom_reactions() as custom_reactions:
sent = False
item = None
existing_reaction = [x for x in custom_reactions if x["name"] == cr_name]
if existing_reaction:
custom_reactions.remove(existing_reaction[0])
await ctx.send(f"Deleted `{cr_name}`.")
else:
await ctx.send(f"I don't have a reaction named `{cr_name}`. Are you sure it exists?")
@commands.Cog.listener()
async def on_message(self, message):
try:
group = self.config.guild(message.guild)
async with group.custom_reactions() as custom_reactions:
names = [x["name"] for x in custom_reactions]
if message.content in names:
index = names.index(message.content)
json_obj = json.loads(custom_reactions[index]["value"])
await message.channel.send(embed=json_to_embed(json_obj))
except Exception:
pass

15
cherubim/entrycontrolresponder.py Executable file
View File

@ -0,0 +1,15 @@
from redbot.core import commands
import discord
import os
dir_path = os.path.dirname(__file__)
class EntryControlResponder(commands.Cog):
@commands.Cog.listener()
async def on_message(self, message):
if message.guild:
if message.guild.id == 858664948266958908 and ("entry-" in message.channel.name or "ticket-" in message.channel.name):
if message.author.id == 557628352828014614 and len(message.embeds) > 0:
if "welcome to our server!" in message.embeds[0].description:
embedToSend = discord.Embed(description="**1. Are you an Orthodox Christian? If yes, are you Eastern or Oriental Orthodox? Are you a catechumen or a baptised member? If no, are you another sort of Christian?**\n\n**2. What is your reason for joining the server?**\n\n**3. What is your biological gender?**\n\n**4. Which of these best describes where you live? \"UK and Ireland\", \"Europe\", \"Americas\", \"Asia\", \"Africa\", \"Australia and NZ\"**\n\n**5. Are you married, and/or do you have any children?**\n\n**6. On a scale of 0 to totally addicted, how do you feel about knitting?**")
await message.channel.send(embed=embedToSend)

32
cherubim/fun.py Normal file
View File

@ -0,0 +1,32 @@
from redbot.core import commands
import discord
import os
dir_path = os.path.dirname(__file__)
class Fun(commands.Cog):
@commands.command()
async def dab(self, ctx, item: str=None):
img = discord.File(f"{dir_path}/horsedabbing.jpg")
if item:
await ctx.send(f"{ctx.author.mention} dabs on {item}.", file=img)
else:
await ctx.send(f"{ctx.author.mention} dabs.", file=img)
@commands.command()
async def slap(self, ctx, item: str=None):
if item:
if item == "<@186046294286925824>":
item = "a random, poor, innocent angel of God"
await ctx.send(f"{ctx.author.mention} slaps {item} with a fish. :fish:")
else:
await ctx.send(f"{ctx.author.mention} didn't target anything and accidentally slapped themselves with a fish. :fish:")
@commands.command()
async def kill(self, ctx, item: str=None):
if item:
await ctx.send(f"{item} :gun:")
else:
await ctx.send("How am I supposed to kill nothing?!")

BIN
cherubim/horsedabbing.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 7.9 KiB

20
cherubim/imgperms.py Normal file
View File

@ -0,0 +1,20 @@
from redbot.core import commands
import discord
import os
dir_path = os.path.dirname(__file__)
class ImgPerms(commands.Cog):
@commands.command()
async def giveimg(self, ctx, user: discord.Member):
if ctx.guild.id == 362503610006765568:
if len([x for x in ctx.author.roles if x.id == 794373197713375302]) > 0:
await user.add_roles([x for x in ctx.guild.roles if x.id == 366885935289204736][0])
await ctx.send(f"Given image perms to {user.mention}.")
@commands.command()
async def takeimg(self, ctx, user: discord.Member):
if ctx.guild.id == 362503610006765568:
if len([x for x in ctx.author.roles if x.id == 794373197713375302]) > 0:
await user.remove_roles([x for x in ctx.guild.roles if x.id == 366885935289204736][0])
await ctx.send(f"Taken image perms to {user.mention}.")

9
cherubim/info.json Normal file
View File

@ -0,0 +1,9 @@
{
"AUTHOR" : "Elliott Pardee (vypr#0001)",
"NAME" : "cherubim",
"SHORT" : "A full-stack cog for Cherubim.",
"DESCRIPTION" : "A full-stack cog for Cherubim.",
"TAGS" : ["cherubim", "custom"],
"REQUIREMENTS" : ["tabulate", "requests"],
"HIDDEN" : false
}

79
cherubim/quotes.py Executable file
View File

@ -0,0 +1,79 @@
import asyncio
import os
import random
from datetime import datetime
from re import split
from typing import final
import discord
from redbot.core import commands, checks, Config
class Quotes(commands.Cog):
def __init__(self, bot):
self.bot = bot
self.config = Config.get_conf(self, identifier=(3322665 + 55673))
default_guild = {
"quotes": {},
}
self.config.register_guild(**default_guild)
@commands.command(name="quote", pass_context=True, no_pm=True)
async def quote(self, ctx, user: discord.Member=None, value: int=None):
guild_group = self.config.guild(ctx.guild)
if user is None:
user = ctx.author
async with guild_group.quotes() as quotes:
if str(user.id) in quotes:
quote = None
if value is None:
quote = random.choice(quotes[str(user.id)])
else:
value = value - 1
if -1 < value < len(quotes[str(user.id)]):
quote = quotes[str(user.id)][value]
if quote is not None:
split_paragraphs = quote["text"].split("\n")
for idx in range(len(split_paragraphs)):
split_paragraphs[idx] = f"> {split_paragraphs[idx]}"
final_quote = "\n".join(split_paragraphs)
link = quote["link"]
await ctx.send(f"{user.display_name}:\n\n{final_quote}\n\nContext: <{link}>")
else:
await ctx.send("There are no quotes associated with this user.")
@commands.Cog.listener()
async def on_reaction_add(self, reaction, user):
guild_group = self.config.guild(reaction.message.guild)
reacts_needed = 4
async with guild_group.quotes() as quotes:
if reaction.emoji == "⭐":
users_reacted_count = 0
users_reacted = await reaction.users().flatten()
for user in users_reacted:
if user.id != reaction.message.author.id:
users_reacted_count += 1
if users_reacted_count >= reacts_needed:
msg = reaction.message
final_obj = {
"text": msg.content,
"link": msg.jump_url
}
if str(msg.author.id) in quotes:
if final_obj not in quotes[str(msg.author.id)]:
quotes[str(msg.author.id)].append(final_obj)
else:
quotes[str(msg.author.id)] = [final_obj]

18
cherubim/standards.py Normal file
View File

@ -0,0 +1,18 @@
from redbot.core import commands
import discord
import asyncio
import os
dir_path = os.path.dirname(__file__)
class Standards(commands.Cog):
def __init__(self, bot):
self.bot = bot
# todo: update joining logic
async def on_member_update(self, member):
pass
# todo: update leaving logic
async def on_member_remove(self, member):
pass

174
cherubim/suggestionbox.py Normal file
View File

@ -0,0 +1,174 @@
import os
import asyncio # noqa: F401
import datetime
import discord
from redbot.core import commands, checks, Config
class SuggestionBox(commands.Cog):
"""custom cog for a configurable suggestion box"""
def __init__(self, bot):
self.bot = bot
self.config = Config.get_conf(self, identifier=(3322665 + 1))
self.usercache = []
default_guild = {
"inactive": True,
"channels_enabled": [],
"cleanup": False,
"anonymous": True,
"blocked_ids": []
}
self.config.register_guild(**default_guild)
@commands.group(name="setsuggest", pass_context=True, no_pm=True)
@checks.admin_or_permissions(manage_guild=True)
async def setsuggest(self, ctx):
"""configuration settings"""
pass
@setsuggest.command(name="on", pass_context=True, no_pm=True)
async def _setsuggest_on(self, ctx):
"""Turn on SuggestionBox in the current channel"""
guild_group = self.config.guild(ctx.guild)
async with guild_group.channels_enabled() as channels_enabled:
channel = ctx.message.channel
if channel.id in channels_enabled:
await ctx.send("SuggestionBox is already on in this channel.")
else:
channels_enabled.append(channel.id)
await ctx.send("SuggestionBox is now on in this channel.")
@setsuggest.command(name="off", pass_context=True, no_pm=True)
async def _setsuggest_off(self, ctx):
"""Turn off SuggestionBox in the current channel"""
guild_group = self.config.guild(ctx.guild)
async with guild_group.channels_enabled() as channels_enabled:
channel = ctx.message.channel
if channel.id not in channels_enabled:
await ctx.send("SuggestionBox is already off in this channel.")
else:
channels_enabled.remove(channel.id)
await ctx.send("SuggestionBox is now off in this channel.")
@setsuggest.command(name="block", pass_context=True, no_pm=True)
async def block(self, ctx, user: discord.Member):
"""Blocks a user from making suggestions."""
guild = ctx.guild
group = self.config.guild(guild)
async with group.blocked_ids() as blocked_ids:
if user.id in blocked_ids:
await ctx.send("This user is already in the block list, did you mean to `--setsuggest unblock`?")
else:
blocked_ids.append(user.id)
await ctx.send("User blocked.")
@setsuggest.command(name="unblock", pass_context=True, no_pm=True)
async def unblock(self, ctx, user: discord.Member):
"""Unblocks a user from making suggestions."""
guild = ctx.guild
group = self.config.guild(guild)
async with group.blocked_ids() as blocked_ids:
if user.id not in blocked_ids:
await ctx.send("This user isn't in the block list, did you mean to `--setsuggest block`?")
else:
blocked_ids.remove(user.id)
await ctx.send("User unblocked.")
@setsuggest.command(name="anonymous", pass_context=True, no_pm=True)
async def anonymous(self, ctx):
"""Toggles whether or not the suggestions are anonymous."""
guild = ctx.guild
current_val = await self.config.guild(guild).anonymous()
current_val = not current_val
if current_val:
await ctx.send("Suggestions are now anonymous.")
else:
await ctx.send("Suggestions are no longer anonymous.")
await self.config.guild(guild).anonymous.set(current_val)
@commands.command(name="suggest", pass_context=True)
async def makesuggestion(self, ctx):
"make a suggestion by following the prompts"
author = ctx.message.author
guild = ctx.guild
group = self.config.guild(guild)
async with group.blocked_ids() as blocked_ids:
if author.id in self.usercache:
return await ctx.send("Finish making your prior suggestion "
"before making an additional one")
if author.id in blocked_ids:
return await ctx.send("You are blocked from making suggestions.")
await ctx.send("I will message you to collect your suggestion.")
self.usercache.append(author.id)
dm = await author.send("Please respond to this message with your suggestion.\nYour "
"suggestion should be a single message (one image allowed).")
def check_message(m):
return m.channel == dm.channel and m.author == author
try:
message = await self.bot.wait_for("message", check=check_message, timeout=120)
except asyncio.TimeoutError:
message = None
if message is None:
await author.send("I can't wait forever, try again when ready.")
self.usercache.remove(author.id)
else:
await self.send_suggest(message, guild)
await author.send("Your suggestion was submitted.")
async def send_suggest(self, message, guild):
author = guild.get_member(message.author.id)
group = self.config.guild(guild)
suggestion = message.clean_content
avatar = author.avatar_url if author.avatar \
else author.default_avatar_url
em = discord.Embed(description=suggestion,
color=discord.Color.purple())
if len(message.attachments) > 0:
item = message.attachments[0]
if any(ext in item.url or item.url.endswith(ext) for ext in [".jpg", ".jpg?", ".png", ".png?", ".gif", ".gif?", ".jpeg", ".jpeg?"]):
em.set_image(url=item.url)
anonymous = await group.anonymous()
async with group.channels_enabled() as channels_enabled:
if anonymous:
em.set_author(name='Anonymous / ' + datetime.date.today().strftime("%B %d, %Y"))
else:
em.set_author(name=author.name + "#" + author.discriminator + " / " + datetime.date.today().strftime("%B %d, %Y"), icon_url=avatar)
em.set_footer(text="Vote on whether or not you'd like to see this implemented!")
for channel in channels_enabled:
where = guild.get_channel(channel)
if where is not None:
await where.send(embed=em)
self.usercache.remove(author.id)

661
reactrole/LICENSE Normal file
View File

@ -0,0 +1,661 @@
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
our General Public Licenses are intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.
The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.
An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU Affero General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the work with which it is combined will remain governed by version
3 of the GNU General Public License.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU Affero General Public License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU Affero General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU Affero General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU Affero General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU AGPL, see
<http://www.gnu.org/licenses/>.

6
reactrole/__init__.py Normal file
View File

@ -0,0 +1,6 @@
from .reactrole import ReactRole
async def setup(bot):
cog = ReactRole(bot)
await bot.add_cog(cog)

17
reactrole/info.json Normal file
View File

@ -0,0 +1,17 @@
{
"author": [
"Bobloy"
],
"min_bot_version": "3.4.0",
"description": "Cog to prevent reactions on specific messages from certain users",
"hidden": false,
"end_user_data_statement": "This cog does not store any End User Data",
"tags": [
"react",
"reaction",
"restrict",
"tools",
"utils",
"bobloy"
]
}

389
reactrole/reactrole.py Normal file
View File

@ -0,0 +1,389 @@
"""
From https://github.com/bobloy/Fox-V3, derived from the reactrestrict cog.
This being included may be in violation of the AGPL. Please contact me
at me [at] srp [dot] life if this is the case. Please forgive me.
This program is free software: you can redistribute it and/or modify it under
the terms of the GNU Affero General 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 Affero General Public License for more details.
You should have received a copy of the GNU General Public License along with this program.
If not, see <https://www.gnu.org/licenses/>.
"""
import asyncio
from typing import List, Union
import discord
from redbot.core import Config, checks, commands
from redbot.core.bot import Red
class ReactRoleCombo:
def __init__(self, message_id, role_id, emoji=None, is_custom_emoji=False):
self.message_id = message_id
self.role_id = role_id
self.emoji = emoji
self.is_custom_emoji = is_custom_emoji
def __eq__(self, other: "ReactRoleCombo"):
return (
self.message_id == other.message_id and
self.role_id == other.role_id and
self.emoji == other.emoji
)
def to_json(self):
return {
'message_id': self.message_id,
'role_id': self.role_id,
'emoji': self.emoji,
'is_custom_emoji': self.is_custom_emoji
}
@classmethod
def from_json(cls, data):
return cls(
data['message_id'],
data['role_id'],
data['emoji'],
data['is_custom_emoji']
)
class ReactRole(commands.Cog):
"""
This cog enables role assignment/removal based on reactions to specific
messages.
"""
def __init__(self, red: Red):
self.bot = red
self.config = Config.get_conf(self, 3203948230954902384,
force_registration=True)
self.config.register_global(
registered_combos=[]
)
async def combo_list(self) -> List[ReactRoleCombo]:
"""
Returns a list of reactrole combos.
:return:
"""
cmd = self.config.registered_combos()
return [ReactRoleCombo.from_json(data) for data in await cmd]
async def set_combo_list(self, combo_list: List[ReactRoleCombo]):
"""
Helper method to set the list of reactrole combos.
:param combo_list:
:return:
"""
raw = [combo.to_json() for combo in combo_list]
await self.config.registered_combos.set(raw)
async def is_registered(self, message_id: int) -> bool:
"""
Determines if a message ID has been registered.
:param message_id:
:return:
"""
return any(message_id == combo.message_id
for combo in await self.combo_list())
async def add_reactrole(self, message_id: int, emoji: Union[str, int], role: discord.Role):
"""
Adds a react|role combo.
:param int message_id:
:param str or int emoji:
:param discord.Role role:
"""
is_custom = True
if isinstance(emoji, str):
is_custom = False
combo = ReactRoleCombo(message_id, role.id, emoji=emoji, is_custom_emoji=is_custom)
current_combos = await self.combo_list()
if combo not in current_combos:
current_combos.append(combo)
await self.set_combo_list(current_combos)
async def remove_react(self, message_id: int, emoji: Union[int, str]):
"""
Removes a given reaction.
:param int message_id:
:param str or int emoji:
:return:
"""
current_combos = await self.combo_list()
to_keep = [c for c in current_combos
if not (c.message_id == message_id and c.emoji == emoji)]
if to_keep != current_combos:
await self.set_combo_list(to_keep)
async def has_reactrole_combo(self, message_id: int, emoji: Union[str, int])\
-> (bool, List[ReactRoleCombo]):
"""
Determines if there is an existing react|role combo for a given message
and emoji ID.
:param int message_id:
:param str or int emoji:
:return:
"""
if not await self.is_registered(message_id):
return False, []
combos = await self.combo_list()
ret = [c for c in combos
if c.message_id == message_id and c.emoji == emoji]
return len(ret) > 0, ret
def _get_member(self, channel_id: int, user_id: int) -> discord.Member:
"""
Tries to get a member with the given user ID from the guild that has
the given channel ID.
:param int channel_id:
:param int user_id:
:rtype:
discord.Member
:raises LookupError:
If no such channel or member can be found.
"""
channel = self.bot.get_channel(channel_id)
try:
member = channel.guild.get_member(user_id)
except AttributeError as e:
raise LookupError("No channel found.") from e
if member is None:
raise LookupError("No member found.")
return member
def _get_role(self, guild: discord.Guild, role_id: int) -> discord.Role:
"""
Gets a role object from the given guild with the given ID.
:param discord.Guild guild:
:param int role_id:
:rtype:
discord.Role
:raises LookupError:
If no such role exists.
"""
role = discord.utils.get(guild.roles, id=role_id)
if role is None:
raise LookupError("No role found.")
return role
async def _get_message(self, ctx: commands.Context, message_id: int)\
-> Union[discord.Message, None]:
"""
Tries to find a message by ID in the current guild context.
:param ctx:
:param message_id:
:return:
"""
for channel in ctx.guild.channels:
try:
return await channel.fetch_message(message_id)
except discord.NotFound:
pass
except AttributeError: # VoiceChannel object has no attribute 'get_message'
pass
return None
async def _wait_for_emoji(self, ctx: commands.Context):
"""
Asks the user to react to this message and returns the emoji string if unicode
or ID if custom.
:param ctx:
:raises asyncio.TimeoutError:
If the user does not respond in time.
:return:
"""
message = await ctx.send("Please react to this message with the reaction you"
" would like to add/remove, you have 20 seconds to"
" respond.")
def _wait_check(react, user):
msg = react.message
return msg.id == message.id and user.id == ctx.author.id
reaction, _ = await ctx.bot.wait_for('reaction_add', check=_wait_check, timeout=20)
try:
ret = reaction.emoji.id
except AttributeError:
# The emoji is unicode
ret = reaction.emoji
return ret, reaction.emoji
@commands.group()
@checks.guildowner_or_permissions(manage_roles=True)
async def reactrole(self, ctx: commands.Context):
"""
Base command for this cog. Check help for the commands list.
"""
pass
@reactrole.command()
async def add(self, ctx: commands.Context, message_id: int, *, role: discord.Role):
"""
Adds a reaction|role combination to a registered message, don't use
quotes for the role name.
"""
message = await self._get_message(ctx, message_id)
if message is None:
await ctx.send("That message doesn't seem to exist.")
return
try:
emoji, actual_emoji = await self._wait_for_emoji(ctx)
except asyncio.TimeoutError:
await ctx.send("You didn't respond in time, please redo this command.")
return
try:
await message.add_reaction(actual_emoji)
except discord.HTTPException:
await ctx.send("I can't add that emoji because I'm not in the guild that"
" owns it.")
return
# noinspection PyTypeChecker
await self.add_reactrole(message_id, emoji, role)
await ctx.send("React|Role combo added.")
@reactrole.command()
async def remove(self, ctx: commands.Context, message_id: int):
"""
Removes all roles associated with a given reaction.
"""
try:
emoji, actual_emoji = await self._wait_for_emoji(ctx)
except asyncio.TimeoutError:
await ctx.send("You didn't respond in time, please redo this command.")
return
# noinspection PyTypeChecker
await self.remove_react(message_id, emoji)
await ctx.send("Reaction removed.")
@commands.Cog.listener()
async def on_raw_reaction_add(self, payload):
"""
Event handler for long term reaction watching.
:param discord.PartialEmoji emoji:
:param int message_id:
:param int channel_id:
:param int user_id:
:return:
"""
message_id = payload.message_id if payload.message_id else None
channel_id = payload.channel_id if payload.channel_id else None
user_id = payload.user_id if payload.user_id else None
emoji = payload.emoji if payload.emoji else None
if emoji.is_custom_emoji():
emoji_id = emoji.id
else:
emoji_id = emoji.name
has_reactrole, combos = await self.has_reactrole_combo(message_id, emoji_id)
if not has_reactrole:
return
try:
member = self._get_member(channel_id, user_id)
except LookupError:
return
if member.bot:
return
try:
roles = [self._get_role(member.guild, c.role_id) for c in combos]
except LookupError:
return
try:
await member.add_roles(*roles)
except discord.Forbidden:
pass
@commands.Cog.listener()
async def on_raw_reaction_remove(self, payload):
"""
Event handler for long term reaction watching.
:param discord.PartialEmoji emoji:
:param int message_id:
:param int channel_id:
:param int user_id:
:return:
"""
message_id = payload.message_id if payload.message_id else None
channel_id = payload.channel_id if payload.channel_id else None
user_id = payload.user_id if payload.user_id else None
emoji = payload.emoji if payload.emoji else None
if emoji.is_custom_emoji():
emoji_id = emoji.id
else:
emoji_id = emoji.name
has_reactrole, combos = await self.has_reactrole_combo(message_id, emoji_id)
if not has_reactrole:
return
try:
member = self._get_member(channel_id, user_id)
except LookupError:
return
if member.bot:
return
try:
roles = [self._get_role(member.guild, c.role_id) for c in combos]
except LookupError:
return
try:
await member.remove_roles(*roles)
except discord.Forbidden:
pass

201
rss/LICENSE Normal file
View File

@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2020-present Michael Hall
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

29
rss/__init__.py Normal file
View File

@ -0,0 +1,29 @@
# Copyright 2017-present Michael Hall
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import warnings
from .core import RSS
warnings.filterwarnings("once", category=DeprecationWarning, module="feedparser")
__red_end_user_data_statement__ = (
"This cog does not persistently store data or metadata about users."
)
async def setup(bot):
cog = RSS(bot)
bot.add_cog(cog)
cog.init()

63
rss/cleanup.py Normal file
View File

@ -0,0 +1,63 @@
# Copyright 2017-present Michael Hall
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import html.parser
import re
__all__ = ["html_to_text"]
WhitespaceHandler = re.compile("<p>|<br>|<br />|<li>", flags=re.MULTILINE)
# The below is semi-safe for use here,
# wouldn't reccomend copying this without understanding it.
# html cleanup is taken from https://stackoverflow.com/a/7778368
# with some modifications made to better suit the needs of this.
class HTMLTextExtractor(html.parser.HTMLParser): # https://stackoverflow.com/a/7778368
def __init__(self):
super().__init__()
self.result = []
def handle_data(self, d):
self.result.append(d)
def get_text(self):
return "".join(self.result)
def html_to_text(html_data): # https://stackoverflow.com/a/7778368
"""Converts HTML to plain text (stripping tags and converting entities).
>>> html_to_text('<a href="#">Demo<!--...--> <em>(&not; \u0394&#x03b7;&#956;&#x03CE;)</em></a>')
'Demo (\xac \u0394\u03b7\u03bc\u03ce)'
"Plain text" doesn't mean result can safely be used as-is in HTML.
>>> html_to_text('&lt;script&gt;alert("Hello");&lt;/script&gt;')
'<script>alert("Hello");</script>'
Always use html.escape to sanitize text before using in an HTML context!
HTMLParser will do its best to make sense of invalid HTML.
>>> html_to_text('x < y &lt z <!--b')
'x < y < z '
Unrecognized named entities are included as-is. '&apos;' is recognized,
despite being XML only.
>>> html_to_text('&nosuchentity; &apos; ')
"&nosuchentity; ' "
"""
html_data = WhitespaceHandler.sub("\n", html_data)
s = HTMLTextExtractor()
s.feed(html_data)
return s.get_text()

70
rss/converters.py Normal file
View File

@ -0,0 +1,70 @@
# Copyright 2017-present Michael Hall
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import annotations
from typing import NamedTuple, Optional
import discord
from redbot.core import commands
def _tristate(arg: str) -> Optional[bool]:
if arg.lower() in ("true", "yes"):
return True
if arg.lower() in ("false", "no"):
return False
if arg.lower() in ("none", "default"):
return None
raise commands.BadArgument(
f'"{arg}" is not a valid setting.'
' Valid settings are "true" or "false", or "default" to '
"remove the setting"
)
class TriState:
def __init__(self, state):
self.state = state
@classmethod
async def convert(cls, ctx, arg):
return cls(_tristate(arg))
_role_converter = commands.RoleConverter()
class NonEveryoneRole(discord.Role):
@classmethod
async def convert(cls, ctx: commands.Context, arg: str) -> discord.Role:
role: discord.Role = await _role_converter.convert(ctx, arg)
if role.is_default():
raise commands.BadArgument("You can't set this for the everyone role")
return role
class FieldAndTerm(NamedTuple):
field: str
term: str
@classmethod
async def convert(cls, ctx: commands.Context, arg: str) -> FieldAndTerm:
try:
field, term = arg.casefold().split(maxsplit=1)
except ValueError:
raise commands.BadArgument("Must provide a field and a term to match")
return cls(field, term)

819
rss/core.py Normal file
View File

@ -0,0 +1,819 @@
# Copyright 2017-present Michael Hall
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import annotations
import asyncio
import logging
import string
import urllib.parse
from datetime import datetime
from functools import partial
from types import MappingProxyType
from typing import Any, Dict, Generator, List, Optional, cast
import aiohttp
import discord
import feedparser
from bs4 import BeautifulSoup as bs4
from redbot.core import checks, commands
from redbot.core.config import Config
from redbot.core.utils.chat_formatting import box, pagify
from .cleanup import html_to_text
from .converters import FieldAndTerm, NonEveryoneRole, TriState
log = logging.getLogger("red.sinbadcogs.rss")
DONT_HTML_SCRUB = ["link", "source", "updated", "updated_parsed"]
USABLE_FIELDS = [
"author",
"author_detail",
"description",
"comments",
"content",
"contributors",
"created",
"updated",
"updated_parsed",
"link",
"name",
"published",
"published_parsed",
"publisher",
"publisher_detail",
"source",
"summary",
"summary_detail",
"tags",
"title",
"title_detail",
]
USABLE_TEXT_FIELDS = [
f
for f in USABLE_FIELDS
if f
not in ("published", "published_parsed", "updated", "updated_parsed", "created",)
]
def debug_exc_log(lg: logging.Logger, exc: Exception, msg: str = "Exception in RSS"):
if lg.getEffectiveLevel() <= logging.DEBUG:
lg.exception(msg, exc_info=exc)
class RSS(commands.Cog):
"""
An RSS cog.
"""
__author__ = "mikeshardmind(Sinbad)"
__version__ = "2021.03"
async def red_delete_data_for_user(self, **kwargs):
""" Nothing to delete """
return
def format_help_for_context(self, ctx):
pre_processed = super().format_help_for_context(ctx)
return f"{pre_processed}\nCog Version: {self.__version__}"
def __init__(self, bot, *args, **kwargs):
super().__init__(*args, **kwargs)
self.bot = bot
self.config = Config.get_conf(
self, identifier=78631113035100160, force_registration=True
)
self.config.register_channel(feeds={})
self.session = aiohttp.ClientSession()
self.bg_loop_task: Optional[asyncio.Task] = None
def init(self):
self.bg_loop_task = asyncio.create_task(self.bg_loop())
def done_callback(fut: asyncio.Future):
try:
fut.exception()
except asyncio.CancelledError:
pass
except asyncio.InvalidStateError as exc:
log.exception(
"We somehow have a done callback when not done?", exc_info=exc
)
except Exception as exc:
log.exception("Unexpected exception in rss: ", exc_info=exc)
self.bg_loop_task.add_done_callback(done_callback)
def cog_unload(self):
if self.bg_loop_task:
self.bg_loop_task.cancel()
asyncio.create_task(self.session.close())
async def should_embed(self, channel: discord.TextChannel) -> bool:
ret: bool = await self.bot.embed_requested(channel, channel.guild.me)
return ret
async def fetch_feed(self, url: str) -> Optional[feedparser.FeedParserDict]:
timeout = aiohttp.client.ClientTimeout(total=15)
try:
async with self.session.get(url, timeout=timeout) as response:
data = await response.read()
except (aiohttp.ClientError, asyncio.TimeoutError):
return None
except Exception as exc:
debug_exc_log(
log,
exc,
f"Unexpected exception type {type(exc)} encountered for feed url: {url}",
)
return None
ret = feedparser.parse(data)
self.bot.dispatch(
# dispatch is versioned.
# To remain compatible, accept kwargs and check version
#
# version: 1
# response_regerator: Callable[[], feedparser.FeedParserDict]
# bozo: Whether this was already a junk response.
#
# This may be dispatched any time a feed is fetched,
# and if you use this, you should compare with prior info
# The response regeneration exists to remove potential
# of consumers accidentally breaking the cog by mutating
# a response which has not been consumed by the cog yet.
# re-parsing is faster than a deepcopy, and prevents needing it
# should nothing be using the listener.
"sinbadcogs_rss_fetch",
listener_version=1,
response_regenerator=partial(feedparser.parse, data),
bozo=ret.bozo,
)
if ret.bozo:
log.debug(f"Feed url: {url} is invalid.")
return None
return ret
@staticmethod
def process_entry_time(x):
if "published_parsed" in x:
return tuple(x.get("published_parsed"))[:5]
if "updated_parsed" in x:
return tuple(x.get("updated_parsed"))[:5]
return (0,)
async def find_feeds(self, site: str) -> List[str]:
"""
Attempts to find feeds on a page
"""
async with self.session.get(site) as response:
data = await response.read()
possible_feeds = set()
html = bs4(data)
feed_urls = html.findAll("link", rel="alternate")
if len(feed_urls) > 1:
for f in feed_urls:
if t := f.get("type", None):
if "rss" in t or "xml" in t:
if href := f.get("href", None):
possible_feeds.add(href)
parsed_url = urllib.parse.urlparse(site)
scheme, hostname = parsed_url.scheme, parsed_url.hostname
if scheme and hostname:
base = "://".join((scheme, hostname))
atags = html.findAll("a")
for a in atags:
if href := a.get("href", None):
if "xml" in href or "rss" in href or "feed" in href:
possible_feeds.add(base + href)
return [site for site in possible_feeds if await self.fetch_feed(site)]
async def format_and_send(
self,
*,
destination: discord.TextChannel,
response: feedparser.FeedParserDict,
feed_name: str,
feed_settings: dict,
embed_default: bool,
force: bool = False,
) -> Optional[List[int]]:
"""
Formats and sends,
returns the integer timestamp of latest entry in the feed which was sent
"""
use_embed = feed_settings.get("embed_override", None)
if use_embed is None:
use_embed = embed_default
assert isinstance(response.entries, list), "mypy" # nosec
match_rule = feed_settings.get("match_req", [])
def meets_rule(entry):
if not match_rule:
return True
field_name, term = match_rule
d = getattr(entry, field_name, None)
if not d:
return False
elif isinstance(d, list):
for item in d:
if term in item:
return True
return False
elif isinstance(d, str):
return term in d.casefold()
return False
if force:
_to_send = next(filter(meets_rule, response.entries), None)
if not _to_send:
return None
to_send = [_to_send]
else:
last = feed_settings.get("last", None)
last = tuple((last or (0,))[:5])
to_send = sorted(
[
e
for e in response.entries
if self.process_entry_time(e) > last and meets_rule(e)
],
key=self.process_entry_time,
)
last_sent = None
roles = feed_settings.get("role_mentions", [])
for entry in to_send:
color = destination.guild.me.color
kwargs = self.format_post(
entry, use_embed, color, feed_settings.get("template", None), roles
)
try:
r = discord.http.Route(
"POST", "/channels/{channel_id}/messages", channel_id=destination.id
)
if em := kwargs.pop("embed", None):
assert isinstance(em, discord.Embed), "mypy" # nosec
kwargs["embed"] = em.to_dict()
kwargs["allowed_mentions"] = {"parse": [], "roles": roles}
await self.bot.http.request(r, json=kwargs)
except discord.HTTPException as exc:
debug_exc_log(log, exc, "Exception while sending feed.")
self.bot.dispatch(
# If you want to use this, make your listener accept
# what you need from this + **kwargs to not break if I add more
# This listener is versioned.
# you should not mutate the feedparser classes.
#
# version: 1
# destination: discord.TextChannel
# feed_name: str
# feedparser_entry: feedparser.FeedParserDict
# feed_settings: MappingProxy
# forced_update: bool
"sinbadcogs_rss_send_fail",
listener_version=1,
destination=destination,
feed_name=feed_name,
feedparser_entry=entry,
feed_settings=MappingProxyType(feed_settings),
forced_update=force,
)
else:
self.bot.dispatch(
# If you want to use this, make your listener accept
# what you need from this + **kwargs to not break if I add more
# This listener is versioned.
# you should not mutate the feedparser classes.
#
# version: 1
# destination: discord.TextChannel
# feed_name: str
# feedparser_entry: feedparser.FeedParserDict
# feed_settings: MappingProxy
# forced_update: bool
"sinbadcogs_rss_send",
listener_version=1,
destination=destination,
feed_name=feed_name,
feedparser_entry=entry,
feed_settings=MappingProxyType(feed_settings),
forced_update=force,
)
finally:
last_sent = list(self.process_entry_time(entry))
return last_sent
def format_post(self, entry, embed: bool, color, template=None, roles=[]) -> dict:
if template is None:
if embed:
_template = "[$title]($link)"
else:
_template = "$title: <$link>"
else:
_template = template
template = string.Template(_template)
data = {k: getattr(entry, k, None) for k in USABLE_FIELDS}
def maybe_clean(key, val):
if isinstance(val, str) and key not in DONT_HTML_SCRUB:
return html_to_text(val)
return val
escaped_usable_fields = {k: maybe_clean(k, v) for k, v in data.items() if v}
content = template.safe_substitute(**escaped_usable_fields)
if embed:
if len(content) > 1980:
content = content[:1900] + "... (Feed data too long)"
timestamp = datetime(*self.process_entry_time(entry))
embed_data = discord.Embed(
description=content, color=color, timestamp=timestamp
)
embed_data.set_footer(text="Published ")
data = {"embed": embed_data}
if roles:
data["content"] = " ".join((f"<@&{rid}>" for rid in roles))
return data
else:
if roles:
mention_string = " ".join((f"<@&{rid}>" for rid in roles)) + "\n"
else:
mention_string = ""
if len(content) > 1900:
content = content[:1900] + "... (Feed data too long)"
return {"content": mention_string + content if mention_string else content}
async def handle_response_from_loop(
self,
*,
response: Optional[feedparser.FeedParserDict],
channel: discord.TextChannel,
feed: dict,
should_embed: bool,
feed_name: str,
):
if not response:
return
try:
last = await self.format_and_send(
feed_name=feed_name,
destination=channel,
response=response,
feed_settings=feed,
embed_default=should_embed,
)
except Exception as exc:
debug_exc_log(log, exc)
else:
if last:
await self.config.channel(channel).feeds.set_raw(
feed_name, "last", value=last
)
async def do_feeds(self):
feeds_fetched: Dict[str, Any] = {}
default_embed_settings: Dict[discord.Guild, bool] = {}
channel_data = await self.config.all_channels()
for channel_id, data in channel_data.items():
channel = self.bot.get_channel(channel_id)
if not channel:
continue
if channel.guild not in default_embed_settings:
should_embed = await self.should_embed(channel)
default_embed_settings[channel.guild] = should_embed
else:
should_embed = default_embed_settings[channel.guild]
for feed_name, feed in data["feeds"].items():
url = feed.get("url", None)
if not url:
continue
if url in feeds_fetched:
response = feeds_fetched[url]
else:
response = await self.fetch_feed(url)
feeds_fetched[url] = response
await self.handle_response_from_loop(
response=response,
channel=channel,
feed=feed,
feed_name=feed_name,
should_embed=should_embed,
)
async def bg_loop(self):
await self.bot.wait_until_ready()
while await asyncio.sleep(300, True):
await self.do_feeds()
# commands go here
@checks.mod_or_permissions(manage_channels=True)
@commands.guild_only()
@commands.group()
async def rss(self, ctx: commands.GuildContext):
"""
Configuration for rss
"""
pass
@commands.cooldown(5, 60, commands.BucketType.guild)
@rss.command(name="find")
async def find_feed_command(self, ctx: commands.Context, *, url: str):
"""
Attempt to find feeds intelligently on a given site.
This only works on pages that link their RSS feeds.
"""
try:
possible_results = await self.find_feeds(url)
except aiohttp.ClientError as exc:
debug_exc_log(log, exc)
await ctx.send("Something went wrong when accessing that url.")
else:
output = (
"\n".join(("Possible feeds:", *possible_results))
if possible_results
else "No feeds found."
)
for page in pagify(output):
await ctx.send(box(page))
@rss.command(name="force")
async def rss_force(self, ctx, feed, channel: Optional[discord.TextChannel] = None):
"""
Forces the latest update for a feed to post.
"""
channel = channel or ctx.channel
feeds = await self.config.channel(channel).feeds()
url = None
if feed in feeds:
url = feeds[feed].get("url", None)
if url is None:
return await ctx.send("No such feed.")
response = await self.fetch_feed(url)
if response:
should_embed = await self.should_embed(ctx.channel)
try:
await self.format_and_send(
feed_name=feed,
destination=channel,
response=response,
feed_settings=feeds[feed],
embed_default=should_embed,
force=True,
)
except Exception:
await ctx.send("There was an error with that.")
else:
await ctx.tick()
else:
await ctx.send("Could not fetch feed.")
@commands.cooldown(3, 60, type=commands.BucketType.user)
@rss.command()
async def addfeed(
self,
ctx: commands.GuildContext,
name: str,
url: str,
channel: Optional[discord.TextChannel] = None,
):
"""
Adds a feed to the current, or a provided channel
"""
channel = channel or ctx.channel
async with self.config.channel(channel).feeds() as feeds:
if name in feeds:
return await ctx.send("That name is already in use.")
response = await self.fetch_feed(url)
if response is None:
return await ctx.send(
f"That didn't seem to be a valid rss feed. "
f"(Syntax: {ctx.prefix}{ctx.command.signature})"
)
else:
feeds.update(
{
name: {
"url": url,
"template": None,
"embed_override": None,
"last": list(ctx.message.created_at.timetuple()[:6]),
}
}
)
await ctx.tick()
@rss.command(name="list")
async def list_feeds(
self, ctx: commands.GuildContext, channel: Optional[discord.TextChannel] = None
):
"""
Lists the current feeds for the current channel, or a provided one.
"""
channel = channel or ctx.channel
data = await self.config.channel(channel).feeds()
if not data:
return await ctx.send("No feeds here.")
if await ctx.embed_requested():
output = "\n".join(
(
"{name}: {url}".format(name=k, url=v.get("url", "broken feed"))
for k, v in data.items()
)
)
page_gen = cast(Generator[str, None, None], pagify(output))
try:
for page in page_gen:
await ctx.send(
embed=discord.Embed(
description=page, color=(await ctx.embed_color())
)
)
finally:
page_gen.close()
else:
output = "\n".join(
(
"{name}: <{url}>".format(name=k, url=v.get("url", "broken feed"))
for k, v in data.items()
)
)
page_gen = cast(Generator[str, None, None], pagify(output))
try:
for page in page_gen:
await ctx.send(page)
finally:
page_gen.close()
@rss.command(name="remove")
async def remove_feed(
self, ctx, name: str, channel: Optional[discord.TextChannel] = None
):
"""
removes a feed from the current channel, or from a provided channel
If the feed is currently being fetched, there may still be a final update
after this.
"""
channel = channel or ctx.channel
async with self.config.channel(channel).feeds() as feeds:
if name not in feeds:
await ctx.send(f"No feed named {name} in {channel.mention}.")
return
del feeds[name]
await ctx.tick()
@rss.command(name="embed")
async def set_embed(
self,
ctx,
name: str,
setting: TriState,
channel: Optional[discord.TextChannel] = None,
):
"""
Sets if a specific feed should
use an embed,
not use an embed,
or (default) use the bot setting to determine embed usage.
Valid Settings for this are:
True
False
Default
"""
channel = channel or ctx.channel
async with self.config.channel(channel).feeds() as feeds:
if name not in feeds:
await ctx.send(f"No feed named {name} in {channel.mention}.")
return
feeds[name]["embed_override"] = setting.state
await ctx.tick()
@rss.command(name="template")
async def set_template(
self,
ctx,
name,
channel: Optional[discord.TextChannel] = None,
*,
template: str = None,
):
"""
Sets formatting for the specified feed in this, or a provided channel
The following have special meaning based on their content in the RSS feed data.
Any not used will remain.
$author
$author_detail
$description
$comments
$content
$contributors
$updated
$updated_parsed
$link
$name
$published
$published_parsed
$publisher
$publisher_detail
$source
$summary
$summary_detail
$tags
$title
$title_detail
"""
if not template:
return await ctx.send_help()
channel = channel or ctx.channel
template = template.replace("\\t", "\t")
template = template.replace("\\n", "\n")
async with self.config.channel(channel).feeds() as feeds:
if name not in feeds:
await ctx.send(f"No feed named {name} in {channel.mention}.")
return
feeds[name]["template"] = template
await ctx.tick()
@rss.command(name="resettemplate")
async def reset_template(
self, ctx, name, channel: Optional[discord.TextChannel] = None
):
"""
Resets the template in use for a specific feed in this, or a provided channel
"""
channel = channel or ctx.channel
async with self.config.channel(channel).feeds() as feeds:
if name not in feeds:
await ctx.send(f"No feed named {name} in {channel.mention}.")
return
del feeds[name]["template"]
await ctx.tick()
@rss.command(
name="matchreq", usage="<feedname> [channel] <field name> <match term>"
)
async def rss_set_match_req(
self,
ctx: commands.GuildContext,
feed_name: str,
channel: Optional[discord.TextChannel] = None,
*,
field_and_term: FieldAndTerm,
):
"""
Sets a term which must appear in the given field for a feed to be published.
"""
channel = channel or ctx.channel
if field_and_term.field not in USABLE_TEXT_FIELDS:
raise commands.BadArgument(
f"Field must be one of: {', '.join(USABLE_TEXT_FIELDS)}"
)
async with self.config.channel(channel).feeds() as feeds:
if feed_name not in feeds:
await ctx.send(f"No feed named {feed_name} in {channel.mention}.")
return
feeds[feed_name]["match_req"] = list(field_and_term)
await ctx.tick()
@rss.command(name="removematchreq")
async def feed_remove_match_req(
self,
ctx: commands.GuildContext,
feed_name: str,
channel: Optional[discord.TextChannel] = None,
):
"""
Remove the reqs on a feed update.
"""
channel = channel or ctx.channel
async with self.config.channel(channel).feeds() as feeds:
if feed_name not in feeds:
await ctx.send(f"No feed named {feed_name} in {channel.mention}.")
return
feeds[feed_name].pop("match_req", None)
await ctx.tick()
@checks.admin_or_permissions(manage_guild=True)
@rss.command(name="rolementions")
async def feedset_mentions(
self,
ctx: commands.GuildContext,
name: str,
channel: Optional[discord.TextChannel] = None,
*non_everyone_roles: NonEveryoneRole,
):
"""
Sets the roles which are mentioned when this feed updates.
This will clear the setting if none.
"""
roles = set(non_everyone_roles)
if len(roles) > 4:
return await ctx.send(
"I'm judging you hard here. "
"Fix your notification roles, "
"don't mention this many (exiting without changes)."
)
if roles and max(roles) > ctx.author.top_role and ctx.author != ctx.guild.owner:
return await ctx.send(
"I'm not letting you set a role mention for a role above your own."
)
channel = channel or ctx.channel
async with self.config.channel(channel).feeds() as feeds:
if name not in feeds:
await ctx.send(f"No feed named {name} in {channel.mention}.")
return
feeds[name]["role_mentions"] = [r.id for r in roles]
if roles:
await ctx.send("I've set those roles to be mentioned.")
else:
await ctx.send("Roles won't be mentioned.")
await ctx.tick()

19
rss/info.json Normal file
View File

@ -0,0 +1,19 @@
{
"author": [
"mikeshardmind(Sinbad)"
],
"name": "RSS",
"disabled": false,
"short": "rss cog",
"description": "An RSS cog.",
"tags": [
"rss"
],
"hidden": false,
"requirements": [
"feedparser>=6.0.0b1",
"beautifulsoup4"
],
"min_bot_version": "3.4.0",
"end_user_data_statement": "This cog does not persistently store data or metadata about users."
}

19
stickyroles/LICENSE Normal file
View File

@ -0,0 +1,19 @@
Copyright (c) 2017 TrustyJAID
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.

11
stickyroles/__init__.py Normal file
View File

@ -0,0 +1,11 @@
import json
from pathlib import Path
from .stickyroles import StickyRoles
with open(Path(__file__).parent / "info.json") as fp:
__red_end_user_data_statement__ = json.load(fp)["end_user_data_statement"]
async def setup(bot):
await bot.add_cog(StickyRoles(bot))

30
stickyroles/info.json Normal file
View File

@ -0,0 +1,30 @@
{
"author" : [
"Twentysix",
"TrustyJAID"
],
"description" : "With this cog you can specify which roles you want to be reapplied on join. This is particularly useful to fight \"role evasion\".",
"disabled" : false,
"end_user_data_statement" : "This cog stores User ID's for the purposes of re-assigning roles when the user re-joins a server.\nUser ID's may be stored in the bots log information.",
"hidden" : false,
"install_msg" : "The command group is `[p]stickyroles`. Remember that role names are case sensitive. If a user with the roles you specified with `[p]stickyroles add` leaves the server and comes back those roles will be reapplied to them. Make sure that Red has appropriate permissions.",
"max_bot_version" : "0.0.0",
"min_bot_version" : "3.1.8",
"min_python_version" : [
3,
7,
2
],
"name" : "StickyRoles",
"permissions" : [
"manage_roles"
],
"required_cogs" : {},
"requirements" : [],
"short" : "Reapplies specific roles on join",
"tags" : [
"utility",
"mod"
],
"type" : "COG"
}

95
stickyroles/locales/messages.pot Normal file
View File

@ -0,0 +1,95 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) YEAR ORGANIZATION
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"POT-Creation-Date: 2018-12-14 20:19-0700\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: redgettext 2.1\n"
#: stickyroles.py:16
#, docstring
msgid ""
"Reapplies specific roles on join. Rewritten for V3 from \n"
" https://github.com/Twentysix26/26-Cogs/blob/master/stickyroles/stickyroles.py"
msgstr ""
#: stickyroles.py:29
#, docstring
msgid "Adds / removes roles to be reapplied on join"
msgstr ""
#: stickyroles.py:34
#, docstring
msgid "Adds role to be reapplied on join"
msgstr ""
#: stickyroles.py:38
msgid "I don't have enough permissions to add that role. Remember to take role hierarchy in consideration."
msgstr ""
#: stickyroles.py:44
msgid " is already in the sticky roles."
msgstr ""
#: stickyroles.py:48
msgid "That role will now be reapplied on join."
msgstr ""
#: stickyroles.py:52
#, docstring
msgid "Removes role to be reapplied on join"
msgstr ""
#: stickyroles.py:56
msgid "That role was never added in the first place."
msgstr ""
#: stickyroles.py:60
msgid "That role won't be reapplied on join."
msgstr ""
#: stickyroles.py:64
#, docstring
msgid "Removes all sticky roles"
msgstr ""
#: stickyroles.py:68
msgid "All sticky roles have been removed."
msgstr ""
#: stickyroles.py:72
#, docstring
msgid "Lists sticky roles"
msgstr ""
#: stickyroles.py:78
msgid ""
"Sticky roles:\n"
"\n"
msgstr ""
#: stickyroles.py:80
msgid "No sticky roles. Add some with "
msgstr ""
#: stickyroles.py:128
msgid "Failed to add roles"
msgstr ""
#: stickyroles.py:129
msgid "I lack permissions to do that."
msgstr ""
#: stickyroles.py:132
msgid "Failed to add roles to "
msgstr ""

173
stickyroles/stickyroles.py Normal file
View File

@ -0,0 +1,173 @@
import logging
from typing import Literal
import discord
from redbot import VersionInfo, version_info
from redbot.core import Config, checks, commands
from redbot.core.i18n import Translator, cog_i18n
_ = Translator("StickyRoles", __file__)
log = logging.getLogger("red.trusty-cogs.stickyroles")
@cog_i18n(_)
class StickyRoles(commands.Cog):
"""
Reapplies specific roles on join. Rewritten for V3 from
https://github.com/Twentysix26/26-Cogs/blob/master/stickyroles/stickyroles.py
"""
__author__ = ["Twentysix", "TrustyJAID"]
__version__ = "2.0.1"
def __init__(self, bot):
self.bot = bot
self.config = Config.get_conf(self, 1358454876)
self.config.register_guild(sticky_roles=[], to_reapply={})
def format_help_for_context(self, ctx: commands.Context) -> str:
"""
Thanks Sinbad!
"""
pre_processed = super().format_help_for_context(ctx)
return f"{pre_processed}\n\nCog Version: {self.__version__}"
async def red_delete_data_for_user(
self,
*,
requester: Literal["discord_deleted_user", "owner", "user", "user_strict"],
user_id: int,
):
"""
Method for finding users data inside the cog and deleting it.
"""
all_guilds = await self.config.all_guilds()
for guild_id, data in all_guilds.items():
if str(user_id) in data["to_reapply"]:
del data["to_reapply"][str(user_id)]
await self.config.guild_from_id(guild_id).to_reapply.set(data["to_reapply"])
@commands.group(aliases=["stickyrole"])
@checks.admin()
async def stickyroles(self, ctx: commands.Context) -> None:
"""Adds / removes roles to be reapplied on join"""
pass
@stickyroles.command()
async def add(self, ctx: commands.Context, *, role: discord.Role) -> None:
"""Adds role to be reapplied on join"""
guild = ctx.message.guild
sticky_roles = await self.config.guild(guild).sticky_roles()
if not guild.me.top_role.position > role.position:
msg = _(
"I don't have enough permissions to add that "
"role. Remember to take role hierarchy in "
"consideration."
)
await ctx.send(msg)
return
if role.id in sticky_roles:
await ctx.send(role.name + _(" is already in the sticky roles."))
return
sticky_roles.append(role.id)
await self.config.guild(guild).sticky_roles.set(sticky_roles)
await ctx.send(_("That role will now be reapplied on join."))
@stickyroles.command()
async def remove(self, ctx: commands.Context, *, role: discord.Role) -> None:
"""Removes role to be reapplied on join"""
guild = ctx.message.guild
sticky_roles = await self.config.guild(guild).sticky_roles()
if role.id not in sticky_roles:
await ctx.send(_("That role was never added in the first place."))
return
sticky_roles.remove(role.id)
await self.config.guild(guild).sticky_roles.set(sticky_roles)
await ctx.send(_("That role won't be reapplied on join."))
@stickyroles.command()
async def clear(self, ctx: commands.Context) -> None:
"""Removes all sticky roles"""
guild = ctx.message.guild
await self.config.guild(guild).sticky_roles.clear()
await self.config.guild(guild).to_reapply.clear()
await ctx.send(_("All sticky roles have been removed."))
@stickyroles.command(name="list")
async def _list(self, ctx: commands.Context):
"""Lists sticky roles"""
guild = ctx.message.guild
roles = await self.config.guild(guild).sticky_roles()
roles = [guild.get_role(r) for r in await self.config.guild(guild).sticky_roles()]
roles = [r.name for r in roles if r is not None]
if roles:
await ctx.send(_("Sticky roles:\n\n") + ", ".join(roles))
else:
msg = _("No sticky roles. Add some with ") + "`{}stickyroles add`".format(ctx.prefix)
await ctx.send(msg)
@commands.Cog.listener()
async def on_member_remove(self, member: discord.Member):
guild = member.guild
if version_info >= VersionInfo.from_str("3.4.0"):
if await self.bot.cog_disabled_in_guild(self, guild):
return
sticky_roles = await self.config.guild(guild).sticky_roles()
to_reapply = await self.config.guild(guild).to_reapply()
if sticky_roles is None:
return
save = False
for role in member.roles:
if role.id in sticky_roles:
if str(member.id) not in to_reapply:
to_reapply[str(member.id)] = []
to_reapply[str(member.id)].append(role.id)
save = True
if save:
await self.config.guild(guild).to_reapply.set(to_reapply)
@commands.Cog.listener()
async def on_member_join(self, member: discord.Member):
guild = member.guild
if version_info >= VersionInfo.from_str("3.4.0"):
if await self.bot.cog_disabled_in_guild(self, guild):
return
sticky_roles = await self.config.guild(guild).sticky_roles()
to_reapply = await self.config.guild(guild).to_reapply()
if to_reapply is None:
return
if str(member.id) not in to_reapply:
return
to_add = []
for role_id in to_reapply[str(member.id)]:
if role_id not in sticky_roles:
continue
role = discord.utils.get(guild.roles, id=role_id)
if role:
to_add.append(role)
del to_reapply[str(member.id)]
if to_add:
try:
await member.add_roles(*to_add, reason="Sticky roles")
except discord.Forbidden:
log.info(
_("Failed to add roles")
+ _("I lack permissions to do that.")
+ "{} ({})\n{}\n".format(member, member.id, to_add)
)
except discord.HTTPException:
msg = _("Failed to add roles to ") + "{} ({})\n{}".format(
member, member.id, to_add
)
log.exception(msg)
await self.config.guild(guild).to_reapply.set(to_reapply)