mirror of https://github.com/miaowware/qrm2.git
323 lines
10 KiB
Python
323 lines
10 KiB
Python
#!/usr/bin/env python3
|
|
"""
|
|
qrm, a bot for Discord
|
|
---
|
|
Copyright (C) 2019-2023 classabbyamp, 0x5c
|
|
|
|
SPDX-License-Identifier: LiLiQ-Rplus-1.1
|
|
"""
|
|
|
|
|
|
import asyncio
|
|
import random
|
|
import sys
|
|
import traceback
|
|
from datetime import datetime, time
|
|
from types import SimpleNamespace
|
|
from pathlib import Path
|
|
|
|
import httpx
|
|
import pytz
|
|
|
|
import discord
|
|
from discord.ext import commands, tasks
|
|
|
|
import info
|
|
import common as cmn
|
|
import utils.connector as conn
|
|
from utils.resources_manager import ResourcesManager
|
|
|
|
import data.keys as keys
|
|
import data.options as opt
|
|
|
|
|
|
# --- Settings ---
|
|
|
|
exit_code = 1 # The default exit code. ?shutdown and ?restart will change it accordingly (fail-safe)
|
|
|
|
ext_dir = "exts" # The name of the directory where extensions are located.
|
|
plugin_dir = "data.plugins" # The name of the directory where plugins are located.
|
|
|
|
debug_mode = opt.debug # Separate assignement in-case we define an override (ternary operator goes here)
|
|
|
|
|
|
# --- Bot setup ---
|
|
|
|
# Loop/aiohttp stuff
|
|
loop = asyncio.get_event_loop()
|
|
connector = loop.run_until_complete(conn.new_connector())
|
|
|
|
# Defining the intents
|
|
intents = discord.Intents.none()
|
|
intents.guilds = True
|
|
intents.messages = True
|
|
intents.reactions = True
|
|
intents.message_content = True
|
|
|
|
member_cache = discord.MemberCacheFlags.from_intents(intents)
|
|
|
|
bot = commands.Bot(command_prefix=opt.prefix,
|
|
case_insensitive=True,
|
|
description=info.description, help_command=commands.MinimalHelpCommand(),
|
|
intents=intents,
|
|
member_cache_flags=member_cache,
|
|
loop=loop,
|
|
connector=connector)
|
|
|
|
# Simple way to access bot-wide stuff in extensions.
|
|
bot.qrm = SimpleNamespace()
|
|
|
|
# Let's store stuff here.
|
|
bot.qrm.connector = connector
|
|
bot.qrm.debug_mode = debug_mode
|
|
# TODO: Add code to close the client
|
|
bot.qrm.httpx_client = httpx.AsyncClient()
|
|
|
|
|
|
# --- Commands ---
|
|
|
|
@bot.command(name="restart", aliases=["rs"], category=cmn.BoltCats.ADMIN)
|
|
@commands.check(cmn.check_if_owner)
|
|
async def _restart_bot(ctx: commands.Context):
|
|
"""Restarts the bot."""
|
|
global exit_code
|
|
await cmn.add_react(ctx.message, cmn.emojis.check_mark)
|
|
print(f"[**] Restarting! Requested by {ctx.author}.")
|
|
exit_code = 42 # Signals to the wrapper script that the bot needs to be restarted.
|
|
await bot.close()
|
|
|
|
|
|
@bot.command(name="shutdown", aliases=["shut"], category=cmn.BoltCats.ADMIN)
|
|
@commands.check(cmn.check_if_owner)
|
|
async def _shutdown_bot(ctx: commands.Context):
|
|
"""Shuts down the bot."""
|
|
global exit_code
|
|
await cmn.add_react(ctx.message, cmn.emojis.check_mark)
|
|
print(f"[**] Shutting down! Requested by {ctx.author}.")
|
|
exit_code = 0 # Signals to the wrapper script that the bot should not be restarted.
|
|
await bot.close()
|
|
|
|
|
|
@bot.group(name="extctl", aliases=["ex"], case_insensitive=True, category=cmn.BoltCats.ADMIN)
|
|
@commands.check(cmn.check_if_owner)
|
|
async def _extctl(ctx: commands.Context):
|
|
"""Extension control commands.
|
|
Defaults to `list` if no subcommand specified"""
|
|
if ctx.invoked_subcommand is None:
|
|
cmd = _extctl_list
|
|
await ctx.invoke(cmd)
|
|
|
|
|
|
@_extctl.command(name="list", aliases=["ls"])
|
|
async def _extctl_list(ctx: commands.Context):
|
|
"""Lists loaded extensions."""
|
|
embed = cmn.embed_factory(ctx)
|
|
embed.title = "Loaded Extensions"
|
|
embed.description = "\n".join(
|
|
["‣ " + x.split(".")[-1] for x in bot.extensions.keys() if not x.startswith(plugin_dir)]
|
|
)
|
|
if plugins := ["‣ " + x.split(".")[-1] for x in bot.extensions.keys() if x.startswith(plugin_dir)]:
|
|
embed.add_field(name="Loaded Plugins", value="\n".join(plugins))
|
|
await ctx.send(embed=embed)
|
|
|
|
|
|
@_extctl.command(name="load", aliases=["ld"])
|
|
async def _extctl_load(ctx: commands.Context, extension: str):
|
|
"""Loads an extension."""
|
|
try:
|
|
bot.load_extension(ext_dir + "." + extension)
|
|
except discord.errors.ExtensionNotFound as e:
|
|
try:
|
|
bot.load_extension(plugin_dir + "." + extension)
|
|
except discord.errors.ExtensionNotFound:
|
|
raise e
|
|
await cmn.add_react(ctx.message, cmn.emojis.check_mark)
|
|
|
|
|
|
@_extctl.command(name="reload", aliases=["rl", "r", "relaod"])
|
|
async def _extctl_reload(ctx: commands.Context, extension: str):
|
|
"""Reloads an extension."""
|
|
if ctx.invoked_with == "relaod":
|
|
pika = bot.get_emoji(opt.pika)
|
|
if pika:
|
|
await cmn.add_react(ctx.message, pika)
|
|
try:
|
|
bot.reload_extension(ext_dir + "." + extension)
|
|
except discord.errors.ExtensionNotLoaded as e:
|
|
try:
|
|
bot.reload_extension(plugin_dir + "." + extension)
|
|
except discord.errors.ExtensionNotLoaded:
|
|
raise e
|
|
await cmn.add_react(ctx.message, cmn.emojis.check_mark)
|
|
|
|
|
|
@_extctl.command(name="unload", aliases=["ul"])
|
|
async def _extctl_unload(ctx: commands.Context, extension: str):
|
|
"""Unloads an extension."""
|
|
try:
|
|
bot.unload_extension(ext_dir + "." + extension)
|
|
except discord.errors.ExtensionNotLoaded as e:
|
|
try:
|
|
bot.unload_extension(plugin_dir + "." + extension)
|
|
except discord.errors.ExtensionNotLoaded:
|
|
raise e
|
|
await cmn.add_react(ctx.message, cmn.emojis.check_mark)
|
|
|
|
|
|
# --- Events ---
|
|
|
|
@bot.event
|
|
async def on_ready():
|
|
print(f"Logged in as: {bot.user} - {bot.user.id}")
|
|
print("------")
|
|
if opt.status_mode == "time":
|
|
_ensure_activity_time.start()
|
|
elif opt.status_mode == "random":
|
|
_ensure_activity_random.start()
|
|
else:
|
|
_ensure_activity_fixed.start()
|
|
|
|
|
|
@bot.event
|
|
async def on_message(message):
|
|
msg = message.content.lower()
|
|
for emoji, keywords in opt.msg_reacts.items():
|
|
if any([keyword in msg for keyword in keywords]):
|
|
await message.add_reaction(discord.utils.find(lambda x: x.id == emoji, bot.emojis))
|
|
|
|
await bot.process_commands(message)
|
|
|
|
|
|
@bot.event
|
|
async def on_command_error(ctx: commands.Context, err: commands.CommandError):
|
|
if isinstance(err, commands.UserInputError):
|
|
await cmn.add_react(ctx.message, cmn.emojis.warning)
|
|
await ctx.send_help(ctx.command)
|
|
elif isinstance(err, commands.CommandNotFound):
|
|
if ctx.invoked_with and ctx.invoked_with.startswith(("?", "!")):
|
|
return
|
|
else:
|
|
await cmn.add_react(ctx.message, cmn.emojis.question)
|
|
elif isinstance(err, commands.CheckFailure):
|
|
# Add handling of other subclasses of CheckFailure as needed.
|
|
if isinstance(err, commands.NotOwner):
|
|
await cmn.add_react(ctx.message, cmn.emojis.no_entry)
|
|
else:
|
|
await cmn.add_react(ctx.message, cmn.emojis.x)
|
|
elif isinstance(err, commands.DisabledCommand):
|
|
await cmn.add_react(ctx.message, cmn.emojis.bangbang)
|
|
elif isinstance(err, (commands.CommandInvokeError, commands.ConversionError)):
|
|
# Emulating discord.py's default beaviour.
|
|
print("Ignoring exception in command {}:".format(ctx.command), file=sys.stderr)
|
|
traceback.print_exception(type(err), err, err.__traceback__, file=sys.stderr)
|
|
|
|
embed = cmn.error_embed_factory(ctx, err.original, bot.qrm.debug_mode)
|
|
embed.description += f"\n`{type(err).__name__}`"
|
|
await cmn.add_react(ctx.message, cmn.emojis.warning)
|
|
await ctx.send(embed=embed)
|
|
else:
|
|
# Emulating discord.py's default beaviour. (safest bet)
|
|
print("Ignoring exception in command {}:".format(ctx.command), file=sys.stderr)
|
|
traceback.print_exception(type(err), err, err.__traceback__, file=sys.stderr)
|
|
await cmn.add_react(ctx.message, cmn.emojis.warning)
|
|
|
|
|
|
# --- Tasks ---
|
|
|
|
@tasks.loop(minutes=5)
|
|
async def _ensure_activity_time():
|
|
status = opt.statuses[0]
|
|
|
|
try:
|
|
tz = pytz.timezone(opt.status_tz)
|
|
except pytz.exceptions.UnknownTimeZoneError:
|
|
status = "with invalid timezones"
|
|
if opt.show_help:
|
|
status += f" | {opt.display_prefix}help"
|
|
await bot.change_presence(activity=discord.Game(name=status))
|
|
return
|
|
|
|
now = datetime.now(tz=tz).time()
|
|
|
|
for sts in opt.time_statuses:
|
|
start_time = time(hour=sts[1][0], minute=sts[1][1], tzinfo=tz)
|
|
end_time = time(hour=sts[2][0], minute=sts[2][1], tzinfo=tz)
|
|
if start_time < now <= end_time:
|
|
status = sts[0]
|
|
if opt.show_help:
|
|
status += f" | {opt.display_prefix}help"
|
|
|
|
await bot.change_presence(activity=discord.Game(name=status))
|
|
|
|
|
|
@tasks.loop(minutes=5)
|
|
async def _ensure_activity_random():
|
|
status = random.choice(opt.statuses)
|
|
if opt.show_help:
|
|
status += f" | {opt.display_prefix}help"
|
|
|
|
await bot.change_presence(activity=discord.Game(name=status))
|
|
|
|
|
|
@tasks.loop(minutes=5)
|
|
async def _ensure_activity_fixed():
|
|
status = opt.statuses[0]
|
|
if opt.show_help:
|
|
status += f" | {opt.display_prefix}help"
|
|
|
|
await bot.change_presence(activity=discord.Game(name=status))
|
|
|
|
|
|
# --- Run ---
|
|
|
|
resource_versions = {
|
|
"bandcharts": "v1",
|
|
"img": "v1",
|
|
"maps": "v1",
|
|
"morse": "v1",
|
|
"phonetics": "v1",
|
|
"qcodes": "v1",
|
|
"funetics": "v1",
|
|
"latex_template": "v1",
|
|
}
|
|
|
|
bot.qrm.rm = ResourcesManager(cmn.paths.resources, opt.resources_url, resource_versions)
|
|
|
|
for ext in opt.exts:
|
|
bot.load_extension(ext_dir + "." + ext)
|
|
|
|
# load all py files in plugin_dir
|
|
for plugin in (f.stem for f in Path(plugin_dir.replace(".", "/")).glob("*.py")):
|
|
bot.load_extension(plugin_dir + "." + plugin)
|
|
|
|
|
|
try:
|
|
bot.run(keys.discord_token)
|
|
|
|
except discord.LoginFailure as ex:
|
|
# Miscellaneous authentications errors: borked token and co
|
|
if bot.qrm.debug_mode:
|
|
raise
|
|
raise SystemExit("Error: Failed to authenticate: {}".format(ex))
|
|
|
|
except discord.ConnectionClosed as ex:
|
|
# When the connection to the gateway (websocket) is closed
|
|
if bot.qrm.debug_mode:
|
|
raise
|
|
raise SystemExit("Error: Discord gateway connection closed: [Code {}] {}".format(ex.code, ex.reason))
|
|
|
|
except ConnectionResetError as ex:
|
|
# More generic connection reset error
|
|
if bot.qrm.debug_mode:
|
|
raise
|
|
raise SystemExit("ConnectionResetError: {}".format(ex))
|
|
|
|
|
|
# --- Exit ---
|
|
# Codes for the wrapper shell script:
|
|
# 0 - Clean exit, don't restart
|
|
# 1 - Error exit, [restarting is up to the shell script]
|
|
# 42 - Clean exit, do restart
|
|
|
|
raise SystemExit(exit_code)
|