mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-12-08 18:32:32 -05:00
Owner cog / Version command / doc link update / OAUTH (#203)
* Version command (#183) * reword. replace link with link to our doc * Move all owner commands to a separate plugin (#188) * Move all owner commands to their own plugin. * Move all initial cog loading to Owner plugin * Final fix of initial cog loading * don't allow people to unload the owner plugin without reloading it * make sure we modify the cog registry like we're supposed to * log the functionname too Message updates, grammar, politeness etc Get right names in logging formatter Ignore cogs.owner if we find it * add version back in add reload docstring Heh, woops...little security bug here * Add in globals and bot to locals * pass exception to the logger * Bot will now generate OAUTH URL from the supplied endpoint (#196) * Formatting changes, revert uptime * Store the oauth_url internally, provide it if the owner uses `!join`
This commit is contained in:
Will
395
cogs/owner.py
Normal file
395
cogs/owner.py
Normal file
@@ -0,0 +1,395 @@
|
||||
import discord
|
||||
from discord.ext import commands
|
||||
from cogs.utils import checks
|
||||
from __main__ import set_cog, send_cmd_help, settings
|
||||
|
||||
import importlib
|
||||
import traceback
|
||||
import logging
|
||||
import asyncio
|
||||
import threading
|
||||
import datetime
|
||||
import glob
|
||||
import os
|
||||
import time
|
||||
|
||||
log = logging.getLogger("red.owner")
|
||||
|
||||
|
||||
class CogNotFoundError(Exception):
|
||||
pass
|
||||
|
||||
|
||||
class CogLoadError(Exception):
|
||||
pass
|
||||
|
||||
|
||||
class NoSetupError(CogLoadError):
|
||||
pass
|
||||
|
||||
|
||||
class CogUnloadError(Exception):
|
||||
pass
|
||||
|
||||
|
||||
class OwnerUnloadWithoutReloadError(CogUnloadError):
|
||||
pass
|
||||
|
||||
|
||||
class Owner:
|
||||
"""All owner-only commands that relate to debug bot operations.
|
||||
"""
|
||||
|
||||
def __init__(self, bot):
|
||||
self.bot = bot
|
||||
self.setowner_lock = False
|
||||
|
||||
@commands.command()
|
||||
@checks.is_owner()
|
||||
async def load(self, *, module: str):
|
||||
"""Loads a module
|
||||
|
||||
Example: load mod"""
|
||||
module = module.strip()
|
||||
if "cogs." not in module:
|
||||
module = "cogs." + module
|
||||
try:
|
||||
self._load_cog(module)
|
||||
except CogNotFoundError:
|
||||
await self.bot.say("That module could not be found.")
|
||||
except CogLoadError as e:
|
||||
log.exception(e)
|
||||
traceback.print_exc()
|
||||
await self.bot.say("There was an issue loading the module."
|
||||
" Check your logs for more information.")
|
||||
except Exception as e:
|
||||
log.exception(e)
|
||||
traceback.print_exc()
|
||||
await self.bot.say('Module was found and possibly loaded but '
|
||||
'something went wrong.'
|
||||
' Check your logs for more information.')
|
||||
else:
|
||||
set_cog(module, True)
|
||||
await self.bot.say("Module enabled.")
|
||||
|
||||
@commands.command()
|
||||
@checks.is_owner()
|
||||
async def unload(self, *, module: str):
|
||||
"""Unloads a module
|
||||
|
||||
Example: unload mod"""
|
||||
module = module.strip()
|
||||
if "cogs." not in module:
|
||||
module = "cogs." + module
|
||||
if not self._does_cogfile_exist(module):
|
||||
await self.bot.say("That module file doesn't exist. I will not"
|
||||
" turn off autoloading at start just in case"
|
||||
" this isn't supposed to happen.")
|
||||
else:
|
||||
set_cog(module, False)
|
||||
try: # No matter what we should try to unload it
|
||||
self._unload_cog(module)
|
||||
except OwnerUnloadWithoutReloadError:
|
||||
await self.bot.say("I cannot allow you to unload the Owner plugin"
|
||||
" unless you are in the process of reloading.")
|
||||
except CogUnloadError as e:
|
||||
log.exception(e)
|
||||
traceback.print_exc()
|
||||
await self.bot.say('Unable to safely disable that module.')
|
||||
else:
|
||||
await self.bot.say("Module disabled.")
|
||||
|
||||
@checks.is_owner()
|
||||
@commands.command(name="reload")
|
||||
async def _reload(self, module):
|
||||
"""Reloads a module
|
||||
|
||||
Example: reload audio"""
|
||||
if "cogs." not in module:
|
||||
module = "cogs." + module
|
||||
|
||||
try:
|
||||
self._unload_cog(module, reloading=True)
|
||||
except:
|
||||
pass
|
||||
|
||||
try:
|
||||
self._load_cog(module)
|
||||
except CogNotFoundError:
|
||||
await self.bot.say("That module cannot be found.")
|
||||
except NoSetupError:
|
||||
await self.bot.say("That module does not have a setup function.")
|
||||
except CogLoadError as e:
|
||||
log.exception(e)
|
||||
traceback.print_exc()
|
||||
await self.bot.say("That module could not be loaded. Check your"
|
||||
" logs for more information.")
|
||||
else:
|
||||
set_cog(module, True)
|
||||
await self.bot.say("Module reloaded.")
|
||||
|
||||
@commands.command(pass_context=True, hidden=True)
|
||||
@checks.is_owner()
|
||||
async def debug(self, ctx, *, code):
|
||||
"""Evaluates code
|
||||
|
||||
Modified function, originally made by Rapptz"""
|
||||
code = code.strip('` ')
|
||||
python = '```py\n{}\n```'
|
||||
result = None
|
||||
|
||||
local_vars = locals().copy()
|
||||
local_vars['bot'] = self.bot
|
||||
|
||||
try:
|
||||
result = eval(code, globals(), local_vars)
|
||||
except Exception as e:
|
||||
await self.bot.say(python.format(type(e).__name__ + ': ' + str(e)))
|
||||
return
|
||||
|
||||
if asyncio.iscoroutine(result):
|
||||
result = await result
|
||||
|
||||
result = python.format(result)
|
||||
if not ctx.message.channel.is_private:
|
||||
censor = (settings.email, settings.password)
|
||||
r = "[EXPUNGED]"
|
||||
for w in censor:
|
||||
if w != "":
|
||||
result = result.replace(w, r)
|
||||
result = result.replace(w.lower(), r)
|
||||
result = result.replace(w.upper(), r)
|
||||
await self.bot.say(result)
|
||||
|
||||
@commands.group(name="set", pass_context=True)
|
||||
async def _set(self, ctx):
|
||||
"""Changes Red's global settings."""
|
||||
if ctx.invoked_subcommand is None:
|
||||
await send_cmd_help(ctx)
|
||||
return
|
||||
|
||||
@_set.command(pass_context=True)
|
||||
async def owner(self, ctx):
|
||||
"""Sets owner"""
|
||||
if settings.owner != "id_here":
|
||||
await self.bot.say("Owner ID has already been set.")
|
||||
return
|
||||
|
||||
if self.setowner_lock:
|
||||
await self.bot.say("A set owner command is already pending.")
|
||||
return
|
||||
|
||||
await self.bot.say("Confirm in the console that you're the owner.")
|
||||
self.setowner_lock = True
|
||||
t = threading.Thread(target=self._wait_for_answer,
|
||||
args=(ctx.message.author,))
|
||||
t.start()
|
||||
|
||||
@_set.command()
|
||||
@checks.is_owner()
|
||||
async def prefix(self, *prefixes):
|
||||
"""Sets prefixes
|
||||
|
||||
Must be separated by a space. Enclose in double
|
||||
quotes if a prefix contains spaces."""
|
||||
if prefixes == ():
|
||||
await self.bot.say("Example: setprefix [ ! ^ .")
|
||||
return
|
||||
|
||||
self.bot.command_prefix = sorted(prefixes, reverse=True)
|
||||
settings.prefixes = sorted(prefixes, reverse=True)
|
||||
log.debug("Setting prefixes to:\n\t{}".format(settings.prefixes))
|
||||
|
||||
if len(prefixes) > 1:
|
||||
await self.bot.say("Prefixes set")
|
||||
else:
|
||||
await self.bot.say("Prefix set")
|
||||
|
||||
@_set.command(pass_context=True)
|
||||
@checks.is_owner()
|
||||
async def name(self, ctx, *, name):
|
||||
"""Sets Red's name"""
|
||||
name = name.strip()
|
||||
if name == "":
|
||||
await send_cmd_help(ctx)
|
||||
await self.bot.edit_profile(settings.password, username=name)
|
||||
await self.bot.say("Done.")
|
||||
|
||||
@_set.command(pass_context=True)
|
||||
@checks.is_owner()
|
||||
async def status(self, ctx, *, status=None):
|
||||
"""Sets Red's status
|
||||
|
||||
Leaving this empty will clear it."""
|
||||
|
||||
if status:
|
||||
status = status.strip()
|
||||
await self.bot.change_status(discord.Game(name=status))
|
||||
log.debug('Status set to "{}" by owner'.format(status))
|
||||
else:
|
||||
await self.bot.change_status(None)
|
||||
log.debug('status cleared by owner')
|
||||
await self.bot.say("Done.")
|
||||
|
||||
@_set.command()
|
||||
@checks.is_owner()
|
||||
async def avatar(self, url):
|
||||
"""Sets Red's avatar"""
|
||||
try:
|
||||
async with self.bot.session.get(url) as r:
|
||||
data = await r.read()
|
||||
await self.bot.edit_profile(settings.password, avatar=data)
|
||||
await self.bot.say("Done.")
|
||||
log.debug("changed avatar")
|
||||
except Exception as e:
|
||||
await self.bot.say("Error, check your logs for more information.")
|
||||
log.exception(e)
|
||||
traceback.print_exc()
|
||||
|
||||
@_set.command(name="token")
|
||||
@checks.is_owner()
|
||||
async def _token(self, token):
|
||||
"""Sets Red's login token"""
|
||||
if len(token) < 50:
|
||||
await self.bot.say("Invalid token.")
|
||||
else:
|
||||
settings.login_type = "token"
|
||||
settings.email = token
|
||||
settings.password = ""
|
||||
await self.bot.say("Token set. Restart me.")
|
||||
log.debug("Just converted to a bot account.")
|
||||
|
||||
@commands.command()
|
||||
@checks.is_owner()
|
||||
async def shutdown(self):
|
||||
"""Shuts down Red"""
|
||||
await self.bot.logout()
|
||||
|
||||
@commands.command()
|
||||
@checks.is_owner()
|
||||
async def join(self, invite_url: discord.Invite=None):
|
||||
"""Joins new server"""
|
||||
if hasattr(self.bot.user, 'bot') and self.bot.user.bot is True:
|
||||
# Check to ensure they're using updated discord.py
|
||||
msg = ("I have a **BOT** tag, so I must be invited with an OAuth2"
|
||||
" link:\nFor more information: "
|
||||
"https://twentysix26.github.io/"
|
||||
"Red-Docs/red_guide_bot_accounts/#bot-invites")
|
||||
await self.bot.say(msg)
|
||||
if hasattr(self.bot, 'oauth_url'):
|
||||
await self.bot.whisper("Here's my OAUTH2 link:\n{}".format(
|
||||
self.bot.oauth_url))
|
||||
return
|
||||
|
||||
if invite_url is None:
|
||||
await self.bot.say("I need a Discord Invite link for the "
|
||||
"server you want me to join.")
|
||||
return
|
||||
|
||||
try:
|
||||
await self.bot.accept_invite(invite_url)
|
||||
await self.bot.say("Server joined.")
|
||||
log.debug("We just joined {}".format(invite_url))
|
||||
except discord.NotFound:
|
||||
await self.bot.say("The invite was invalid or expired.")
|
||||
except discord.HTTPException:
|
||||
await self.bot.say("I wasn't able to accept the invite."
|
||||
" Try again.")
|
||||
|
||||
@commands.command(pass_context=True)
|
||||
@checks.is_owner()
|
||||
async def leave(self, ctx):
|
||||
"""Leaves server"""
|
||||
message = ctx.message
|
||||
|
||||
await self.bot.say("Are you sure you want me to leave this server?"
|
||||
" Type yes to confirm.")
|
||||
response = await self.bot.wait_for_message(author=message.author)
|
||||
|
||||
if response.content.lower().strip() == "yes":
|
||||
await self.bot.say("Alright. Bye :wave:")
|
||||
log.debug('Leaving "{}"'.format(message.server.name))
|
||||
await self.bot.leave_server(message.server)
|
||||
else:
|
||||
await self.bot.say("Ok I'll stay here then.")
|
||||
|
||||
@commands.command()
|
||||
async def uptime(self):
|
||||
"""Shows Red's uptime"""
|
||||
up = abs(self.bot.uptime - int(time.perf_counter()))
|
||||
up = str(datetime.timedelta(seconds=up))
|
||||
await self.bot.say("`Uptime: {}`".format(up))
|
||||
|
||||
@commands.command()
|
||||
async def version(self):
|
||||
"""Shows Red's current version"""
|
||||
response = self.bot.loop.run_in_executor(None, self._get_version)
|
||||
result = await asyncio.wait_for(response, timeout=10)
|
||||
await self.bot.say(result)
|
||||
|
||||
def _load_cog(self, cogname):
|
||||
if not self._does_cogfile_exist(cogname):
|
||||
raise CogNotFoundError(cogname)
|
||||
try:
|
||||
mod_obj = importlib.import_module(cogname)
|
||||
importlib.reload(mod_obj)
|
||||
self.bot.load_extension(mod_obj.__name__)
|
||||
except discord.ClientException:
|
||||
raise NoSetupError
|
||||
except SyntaxError as e:
|
||||
raise CogLoadError(*e.args)
|
||||
|
||||
def _unload_cog(self, cogname, reloading=False):
|
||||
if not reloading and cogname == "cogs.owner":
|
||||
raise OwnerUnloadWithoutReloadError(
|
||||
"Can't unload the owner plugin :P")
|
||||
try:
|
||||
self.bot.unload_extension(cogname)
|
||||
except:
|
||||
raise CogUnloadError
|
||||
|
||||
def _list_cogs(self):
|
||||
cogs = glob.glob("cogs/*.py")
|
||||
clean = []
|
||||
for c in cogs:
|
||||
c = c.replace("/", "\\") # Linux fix
|
||||
clean.append("cogs." + c.split("\\")[1].replace(".py", ""))
|
||||
return clean
|
||||
|
||||
def _does_cogfile_exist(self, module):
|
||||
if "cogs." not in module:
|
||||
module = "cogs." + module
|
||||
if module not in self._list_cogs():
|
||||
return False
|
||||
return True
|
||||
|
||||
def _wait_for_answer(self, author):
|
||||
print(author.name + " requested to be set as owner. If this is you, "
|
||||
"type 'yes'. Otherwise press enter.")
|
||||
print()
|
||||
print("*DO NOT* set anyone else as owner.")
|
||||
|
||||
choice = "None"
|
||||
while choice.lower() != "yes" and choice == "None":
|
||||
choice = input("> ")
|
||||
|
||||
if choice == "yes":
|
||||
settings.owner = author.id
|
||||
print(author.name + " has been set as owner.")
|
||||
self.setowner_lock = False
|
||||
self.owner.hidden = True
|
||||
else:
|
||||
print("setowner request has been ignored.")
|
||||
self.setowner_lock = False
|
||||
|
||||
def _get_version(self):
|
||||
getversion = os.popen(r'git show -s HEAD --format="%cr|%s|%h"')
|
||||
getversion = getversion.read()
|
||||
version = getversion.split('|')
|
||||
return 'Last updated: ``{}``\nCommit: ``{}``\nHash: ``{}``'.format(
|
||||
*version)
|
||||
|
||||
|
||||
def setup(bot):
|
||||
n = Owner(bot)
|
||||
bot.add_cog(n)
|
||||
Reference in New Issue
Block a user