searchbot-discord/extensions/developer.py

501 lines
17 KiB
Python
Raw Normal View History

2020-02-22 21:42:46 +00:00
# -*- coding: utf-8 -*-
2020-03-28 18:29:57 +00:00
# Developer Cog
# Provides functions only usable for developers
2020-02-22 21:42:46 +00:00
2020-03-28 18:29:18 +00:00
# XXX A lot of the code in this cog is from an old bot I used to develop on.
# As such, it may have lots of bad things and weird stuff.
# Here be dragons and all that.
2020-02-22 21:42:46 +00:00
'''Developer Cog'''
import collections
from contextlib import redirect_stdout
2020-04-06 16:26:15 +00:00
import datetime
import inspect
2020-04-06 16:26:15 +00:00
import io
import os
import random
import subprocess
2020-04-06 16:26:15 +00:00
import textwrap
import time
import traceback
import aiohttp
import discord
from discord.ext import commands
2020-03-02 23:37:34 +00:00
from extensions.utils import online
2020-02-22 21:42:46 +00:00
class Developer(commands.Cog):
"""Provides various resources for developers."""
def __init__(self, bot):
2020-03-02 18:11:15 +00:00
# Main Stuff
2020-02-22 21:42:46 +00:00
self.bot = bot
self.request = bot.request
2020-03-02 23:37:34 +00:00
self.online = bot.online
2020-03-02 18:11:15 +00:00
self.emoji = "\U0001F3D7"
# Repl/Eval Stuff
self.repl_sessions = {}
self.repl_embeds = {}
self._eval = {}
def _cleanup_code(self, content):
"""Automatically removes code blocks from the code."""
2020-03-02 20:47:58 +00:00
# remove ```py\n```
if content.startswith('```') and content.endswith('```'):
return '\n'.join(content.split('\n')[1:-1])
# remove `foo`
return content.strip('` \n')
def _get_syntax_error(self, err):
"""Returns SyntaxError formatted for repl reply."""
2020-03-02 20:47:58 +00:00
return '```py\n{0.text}{1:>{0.offset}}\n{2}: {0}```'.format(
err,
'^',
type(err).__name__)
@commands.group(name='shell',
2020-02-29 20:26:57 +00:00
aliases=['ipython', 'repl', 'longexec'],
invoke_without_command=True)
async def repl(self, ctx, *, name: str = None):
"""Head on impact with an interactive python shell."""
# TODO Minimize local variables
# TODO Minimize branches
session = ctx.message.channel.id
embed = discord.Embed(
description="_Enter code to execute or evaluate. "
"`exit()` or `quit` to exit._",
timestamp=datetime.datetime.now())
embed.set_footer(
text="Interactive Python Shell",
icon_url="https://upload.wikimedia.org/wikipedia/commons/thumb"
"/c/c3/Python-logo-notext.svg/1024px-Python-logo-notext.svg.png")
if name is not None:
embed.title = name.strip(" ")
history = collections.OrderedDict()
variables = {
'ctx': ctx,
'bot': self.bot,
'message': ctx.message,
'server': ctx.message.guild,
'channel': ctx.message.channel,
'author': ctx.message.author,
'discord': discord,
'_': None
}
if session in self.repl_sessions:
error_embed = discord.Embed(
color=15746887,
description="**Error**: "
"_Shell is already running in channel._")
await ctx.send(embed=error_embed)
return
shell = await ctx.send(embed=embed)
self.repl_sessions[session] = shell
self.repl_embeds[shell] = embed
while True:
response = await self.bot.wait_for(
'message',
check=lambda m: m.content.startswith(
'`') and m.author == ctx.author and m.channel == ctx.channel
)
cleaned = self._cleanup_code(response.content)
shell = self.repl_sessions[session]
# Regular Bot Method
try:
await ctx.message.channel.fetch_message(
self.repl_sessions[session].id)
except discord.NotFound:
new_shell = await ctx.send(embed=self.repl_embeds[shell])
self.repl_sessions[session] = new_shell
embed = self.repl_embeds[shell]
del self.repl_embeds[shell]
self.repl_embeds[new_shell] = embed
shell = self.repl_sessions[session]
try:
await response.delete()
except discord.Forbidden:
pass
if len(self.repl_embeds[shell].fields) >= 7:
self.repl_embeds[shell].remove_field(0)
if cleaned in ('quit', 'exit', 'exit()'):
self.repl_embeds[shell].color = 16426522
if self.repl_embeds[shell].title is not discord.Embed.Empty:
history_string = "History for {}\n\n\n".format(
self.repl_embeds[shell].title)
else:
history_string = "History for latest session\n\n\n"
for item in history.keys():
history_string += ">>> {}\n{}\n\n".format(
item,
history[item])
2020-03-02 23:37:34 +00:00
haste_url = await self.online.hastebin(history_string)
return_msg = "[`Leaving shell session. "\
"History hosted on hastebin.`]({})".format(
haste_url)
self.repl_embeds[shell].add_field(
name="`>>> {}`".format(cleaned),
value=return_msg,
inline=False)
await self.repl_sessions[session].edit(
embed=self.repl_embeds[shell])
del self.repl_embeds[shell]
del self.repl_sessions[session]
return
executor = exec
if cleaned.count('\n') == 0:
# single statement, potentially 'eval'
try:
code = compile(cleaned, '<repl session>', 'eval')
except SyntaxError:
pass
else:
executor = eval
if executor is exec:
try:
code = compile(cleaned, '<repl session>', 'exec')
except SyntaxError as err:
self.repl_embeds[shell].color = 15746887
return_msg = self._get_syntax_error(err)
history[cleaned] = return_msg
if len(cleaned) > 800:
cleaned = "<Too big to be printed>"
if len(return_msg) > 800:
2020-03-02 23:37:34 +00:00
haste_url = await self.online.hastebin(return_msg)
return_msg = "[`SyntaxError too big to be printed. "\
"Hosted on hastebin.`]({})".format(
haste_url)
self.repl_embeds[shell].add_field(
name="`>>> {}`".format(cleaned),
value=return_msg,
inline=False)
await self.repl_sessions[session].edit(
embed=self.repl_embeds[shell])
continue
variables['message'] = response
fmt = None
stdout = io.StringIO()
try:
with redirect_stdout(stdout):
result = executor(code, variables)
if inspect.isawaitable(result):
result = await result
except Exception as err:
self.repl_embeds[shell].color = 15746887
value = stdout.getvalue()
fmt = '```py\n{}{}\n```'.format(
value,
traceback.format_exc())
else:
self.repl_embeds[shell].color = 4437377
value = stdout.getvalue()
if result is not None:
fmt = '```py\n{}{}\n```'.format(
value,
result)
2020-02-22 21:42:46 +00:00
variables['_'] = result
elif value:
fmt = '```py\n{}\n```'.format(value)
2020-02-22 21:42:46 +00:00
history[cleaned] = fmt
2020-02-22 21:42:46 +00:00
if len(cleaned) > 800:
cleaned = "<Too big to be printed>"
2020-02-22 21:42:46 +00:00
try:
if fmt is not None:
if len(fmt) >= 800:
2020-03-02 23:37:34 +00:00
haste_url = await self.online.hastebin(fmt)
self.repl_embeds[shell].add_field(
name="`>>> {}`".format(cleaned),
value="[`Content too big to be printed. "
"Hosted on hastebin.`]({})".format(
haste_url),
inline=False)
2020-02-22 21:42:46 +00:00
await self.repl_sessions[session].edit(
embed=self.repl_embeds[shell])
else:
self.repl_embeds[shell].add_field(
name="`>>> {}`".format(cleaned),
value=fmt,
inline=False)
await self.repl_sessions[session].edit(
embed=self.repl_embeds[shell])
else:
self.repl_embeds[shell].add_field(
name="`>>> {}`".format(cleaned),
value="`Empty response, assumed successful.`",
inline=False)
await self.repl_sessions[session].edit(
embed=self.repl_embeds[shell])
except discord.Forbidden:
pass
except discord.HTTPException as err:
error_embed = discord.Embed(
color=15746887,
description='**Error**: _{}_'.format(err))
await ctx.send(embed=error_embed)
@repl.command(name='jump',
aliases=['hop', 'pull', 'recenter', 'whereditgo'])
async def repljump(self, ctx):
"""Brings the shell back down so you can see it again."""
session = ctx.message.channel.id
if session not in self.repl_sessions:
error_embed = discord.Embed(
color=15746887,
description="**Error**: _No shell running in channel._")
await ctx.send(embed=error_embed)
return
shell = self.repl_sessions[session]
embed = self.repl_embeds[shell]
try:
await ctx.message.delete()
except discord.Forbidden:
pass
2020-02-22 21:42:46 +00:00
try:
await shell.delete()
except discord.errors.NotFound:
pass
new_shell = await ctx.send(embed=embed)
self.repl_sessions[session] = new_shell
del self.repl_embeds[shell]
self.repl_embeds[new_shell] = embed
@repl.command(name='clear',
aliases=['clean', 'purge', 'cleanup',
'ohfuckme', 'deletthis'])
async def replclear(self, ctx):
"""Clears the fields of the shell and resets the color."""
session = ctx.message.channel.id
if session not in self.repl_sessions:
error_embed = discord.Embed(
color=15746887,
description="**Error**: _No shell running in channel._")
await ctx.send(embed=error_embed)
return
shell = self.repl_sessions[session]
self.repl_embeds[shell].color = discord.Color.default()
self.repl_embeds[shell].clear_fields()
try:
await ctx.message.delete()
except discord.Forbidden:
pass
await shell.edit(embed=self.repl_embeds[shell])
@commands.command(name='eval')
async def eval_cmd(self, ctx, *, code: str):
"""Evaluates Python code."""
2020-02-22 21:42:46 +00:00
if self._eval.get('env') is None:
self._eval['env'] = {}
if self._eval.get('count') is None:
self._eval['count'] = 0
codebyspace = code.split(" ")
print(codebyspace)
silent = False
if codebyspace[0] == "--silent" or codebyspace[0] == "-s":
silent = True
codebyspace = codebyspace[1:]
code = " ".join(codebyspace)
self._eval['env'].update({
'self': self.bot,
'ctx': ctx,
'message': ctx.message,
'channel': ctx.message.channel,
'guild': ctx.message.guild,
'author': ctx.message.author,
})
# let's make this safe to work with
code = code.replace('```py\n', '').replace('```', '').replace('`', '')
_code = (
'async def func(self):\n try:\n{}\n '
'finally:\n self._eval[\'env\'].update(locals())').format(
textwrap.indent(code, ' '))
before = time.monotonic()
# noinspection PyBroadException
try:
exec(_code, self._eval['env'])
func = self._eval['env']['func']
output = await func(self)
if output is not None:
output = repr(output)
except Exception as e:
output = '{}: {}'.format(type(e).__name__, e)
after = time.monotonic()
self._eval['count'] += 1
count = self._eval['count']
code = code.split('\n')
if len(code) == 1:
_in = 'In [{}]: {}'.format(count, code[0])
else:
_first_line = code[0]
_rest = code[1:]
_rest = '\n'.join(_rest)
_countlen = len(str(count)) + 2
_rest = textwrap.indent(_rest, '...: ')
_rest = textwrap.indent(_rest, ' ' * _countlen)
_in = 'In [{}]: {}\n{}'.format(count, _first_line, _rest)
message = '```py\n{}'.format(_in)
if output is not None:
message += '\nOut[{}]: {}'.format(count, output)
ms = int(round((after - before) * 1000))
if ms > 100: # noticeable delay
message += '\n# {} ms\n```'.format(ms)
else:
message += '\n```'
try:
if ctx.author.id == self.bot.user.id:
await ctx.message.edit(content=message)
else:
if not silent:
await ctx.send(message)
except discord.HTTPException:
if not silent:
with aiohttp.ClientSession() as sesh:
async with sesh.post(
"https://hastebin.com/documents/",
data=output,
headers={"Content-Type": "text/plain"}) as r:
r = await r.json()
embed = discord.Embed(
description=(
"[View output - click]"
"(https://hastebin.com/raw/{})").format(
r["key"]))
await ctx.send(embed=embed)
@commands.command(aliases=['sys', 'sh'])
async def system(self, ctx, *, command: str):
"""Runs system commands."""
2020-02-29 20:26:57 +00:00
message = await ctx.send('<a:loading:393852367751086090> Processing...')
result = []
try:
process = subprocess.Popen(command.split(
' '), stdout=subprocess.PIPE, stderr=subprocess.PIPE)
result = process.communicate()
except FileNotFoundError:
stderr = f'Command not found: {command}'
embed = discord.Embed(
title="Command output"
)
if len(result) >= 1 and result[0] in [None, b'']:
stdout = 'No output.'
if len(result) >= 2 and result[0] in [None, b'']:
stderr = 'No output.'
if len(result) >= 1 and result[0] not in [None, b'']:
stdout = result[0].decode('utf-8')
if len(result) >= 2 and result[1] not in [None, b'']:
stderr = result[1].decode('utf-8')
string = ""
if len(result) >= 1:
if (len(result[0]) >= 1024):
stdout = result[0].decode('utf-8')
string = string + f'[[STDOUT]]\n{stdout}'
2020-03-02 23:37:34 +00:00
link = await self.online.hastebin(string)
await message.edit(
content=f":x: Content too long. {link}",
embed=None)
return
if len(result) >= 2:
if (len(result[1]) >= 1024):
stdout = result[0].decode('utf-8')
string = string + f'[[STDERR]]\n{stdout}'
2020-03-02 23:37:34 +00:00
link = await self.online.hastebin(string)
await message.edit(
content=f":x: Content too long. {link}",
embed=None)
return
embed.add_field(
name="stdout",
value=f'```{stdout}```' if 'stdout' in locals() else 'No output.',
inline=False)
embed.add_field(
name="stderr",
value=f'```{stderr}```' if 'stderr' in locals() else 'No output.',
inline=False)
await message.edit(content='', embed=embed)
2020-02-22 21:42:46 +00:00
@commands.command()
2020-02-27 19:09:44 +00:00
async def error(self, ctx):
"""Makes the bot error out."""
2020-02-27 19:09:44 +00:00
3 / 0
2020-02-22 21:42:46 +00:00
async def cog_check(self, ctx):
2020-03-02 23:49:42 +00:00
return commands.is_owner()(ctx.command)
2020-02-22 21:42:46 +00:00
2020-02-22 21:42:46 +00:00
def setup(bot):
bot.add_cog(Developer(bot))