CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-12-08 18:32:32 -05:00
Code Issues Packages Projects Releases Wiki Activity

[Core] CLI flags, env vars login, revamped setup, in. selfbot support, etc (#513)

Browse Source 
Startup flags: can be started and configured without ever doing the interactive setup
Changed default settings format so that all unset values are None
Removed new cogs prompt
Removed `LOGIN_TYPE` from settings.json. It now defaults to token and fallbacks to email/password
Smarter initial setup: only asks for the settings that are actually missing
For the first installation all default cogs are loaded
Startup flag that allows settings to be memory-only
Initial selfbot support
Only reset login credentials (on confirmation) instead of deleting the whole file in case of login failure
Revamped main screen
Made sure that nothing blows up when you run Red on Windows without `chcp 65001`
Possibility of setting credentials in the environment variables `RED_TOKEN` / `RED_EMAIL` `RED_PASSWORD`. They will take priority over the configuration stored on disk.
This commit is contained in:
Twentysix
2016-12-11 00:16:20 +01:00
committed by GitHub
parent 8d83a5ae3a
commit 27bdce7f32
4 changed files with 306 additions and 190 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
cogs/mod.py
View File

@@ -1378,7 +1378,7 @@ def setup(bot):
global logger
check_folders()
check_files()
logger = logging.getLogger("mod")
logger = logging.getLogger("red.mod")
# Prevents the logger from being loaded again in case of module reload
if logger.level == 0:
logger.setLevel(logging.INFO)

33
cogs/owner.py
View File

@@ -225,13 +225,16 @@ class Owner:
result = str(result)
if not ctx.message.channel.is_private:
censor = (self.bot.settings.email, self.bot.settings.password)
censor = (self.bot.settings.email,
self.bot.settings.password,
self.bot.settings.token)
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)
if w is None or w == "":
continue
result = result.replace(w, r)
result = result.replace(w.lower(), r)
result = result.replace(w.upper(), r)
result = list(pagify(result, shorten_by=16))
@@ -263,11 +266,16 @@ class Owner:
@_set.command(pass_context=True)
async def owner(self, ctx):
"""Sets owner"""
if self.bot.settings.no_prompt is True:
await self.bot.say("Console interaction is disabled. Start Red "
"without the `--no-prompt` flag to use this "
"command.")
return
if self.setowner_lock:
await self.bot.say("A set owner command is already pending.")
return
if self.bot.settings.owner != "id_here":
if self.bot.settings.owner is not None:
await self.bot.say(
"The owner is already set. Remember that setting the owner "
"to someone else other than who hosts the bot has security "
@@ -294,6 +302,7 @@ class Owner:
return
self.bot.settings.prefixes = sorted(prefixes, reverse=True)
self.bot.settings.save_settings()
log.debug("Setting global prefixes to:\n\t{}"
"".format(self.bot.settings.prefixes))
@@ -315,6 +324,7 @@ class Owner:
if prefixes == ():
self.bot.settings.set_server_prefixes(server, [])
self.bot.settings.save_settings()
current_p = ", ".join(self.bot.settings.prefixes)
await self.bot.say("Server prefixes reset. Current prefixes: "
"`{}`".format(current_p))
@@ -322,6 +332,7 @@ class Owner:
prefixes = sorted(prefixes, reverse=True)
self.bot.settings.set_server_prefixes(server, prefixes)
self.bot.settings.save_settings()
log.debug("Setting server's {} prefixes to:\n\t{}"
"".format(server.id, self.bot.settings.prefixes))
@@ -472,9 +483,8 @@ class Owner:
if len(token) < 50:
await self.bot.say("Invalid token.")
else:
self.bot.settings.login_type = "token"
self.bot.settings.email = token
self.bot.settings.password = ""
self.bot.settings.token = token
self.bot.settings.save_settings()
await self.bot.say("Token set. Restart me.")
log.debug("Token changed.")
@@ -645,7 +655,7 @@ class Owner:
@commands.command(pass_context=True)
async def contact(self, ctx, *, message : str):
"""Sends message to the owner"""
if self.bot.settings.owner == "id_here":
if self.bot.settings.owner is None:
await self.bot.say("I have no owner set.")
return
owner = discord.utils.get(self.bot.get_all_members(),
@@ -684,7 +694,7 @@ class Owner:
py_version = "[{}.{}.{}]({})".format(*os.sys.version_info[:3],
python_url)
owner_set = self.bot.settings.owner != "id_here"
owner_set = self.bot.settings.owner is not None
owner = self.bot.settings.owner if owner_set else None
if owner:
owner = discord.utils.get(self.bot.get_all_members(), id=owner)
@@ -782,6 +792,7 @@ class Owner:
if choice == "yes":
self.bot.settings.owner = author.id
self.bot.settings.save_settings()
print(author.name + " has been set as owner.")
self.setowner_lock = False
self.owner.hidden = True

136
cogs/utils/settings.py
View File

@@ -1,6 +1,9 @@
from .dataIO import dataIO
from copy import deepcopy
import discord
import os
import argparse
default_path = "data/red/settings.json"
@@ -11,14 +14,19 @@ class Settings:
self.path = path
self.check_folders()
self.default_settings = {
"EMAIL": "EmailHere", "PASSWORD": "", "OWNER": "id_here",
"TOKEN": None,
"EMAIL": None,
"PASSWORD": None,
"OWNER": None,
"PREFIXES": [],
"default": {"ADMIN_ROLE": "Transistor",
"MOD_ROLE": "Process",
"PREFIXES": []},
"LOGIN_TYPE": "email"}
"PREFIXES": []}
}
self.memory_only = False
if not dataIO.is_valid_json(self.path):
self.bot_settings = self.default_settings
self.bot_settings = deepcopy(self.default_settings)
self.save_settings()
else:
current = dataIO.load_json(self.path)
@@ -30,8 +38,58 @@ class Settings:
" field to red settings.json")
dataIO.save_json(self.path, current)
self.bot_settings = dataIO.load_json(self.path)
if "default" not in self.bot_settings:
self.update_old_settings()
self.update_old_settings_v1()
if "LOGIN_TYPE" in self.bot_settings:
self.update_old_settings_v2()
self.parse_cmd_arguments()
def parse_cmd_arguments(self):
parser = argparse.ArgumentParser(description="Red - Discord Bot")
parser.add_argument("--owner", help="ID of the owner. Only who hosts "
"Red should be owner, this has "
"security implications")
parser.add_argument("--prefix", "-p", action="append",
help="Global prefix. Can be multiple")
parser.add_argument("--admin-role", help="Role seen as admin role by "
"Red")
parser.add_argument("--mod-role", help="Role seen as mod role by Red")
parser.add_argument("--no-prompt",
action="store_true",
help="Disables console inputs. Features requiring "
"console interaction could be disabled as a "
"result")
parser.add_argument("--self-bot",
action='store_true',
help="Specifies if Red should log in as selfbot")
parser.add_argument("--memory-only",
action="store_true",
help="Arguments passed and future edits to the "
"settings will not be saved to disk")
parser.add_argument("--debug",
action="store_true",
help="Enables debug mode")
args = parser.parse_args()
if args.owner:
self.owner = args.owner
if args.prefix:
self.prefixes = sorted(args.prefix, reverse=True)
if args.admin_role:
self.default_admin = args.admin_role
if args.mod_role:
self.default_mod = args.mod_role
self.no_prompt = args.no_prompt
self.self_bot = args.self_bot
self.memory_only = args.memory_only
self.debug = args.debug
self.save_settings()
def check_folders(self):
folders = ("data", os.path.dirname(self.path), "cogs", "cogs/utils")
@@ -41,16 +99,35 @@ class Settings:
os.makedirs(folder)
def save_settings(self):
dataIO.save_json(self.path, self.bot_settings)
if not self.memory_only:
dataIO.save_json(self.path, self.bot_settings)
def update_old_settings(self):
def update_old_settings_v1(self):
# This converts the old settings format
mod = self.bot_settings["MOD_ROLE"]
admin = self.bot_settings["ADMIN_ROLE"]
del self.bot_settings["MOD_ROLE"]
del self.bot_settings["ADMIN_ROLE"]
self.bot_settings["default"] = {"MOD_ROLE": mod,
"ADMIN_ROLE": admin,
"PREFIXES" : []}
"PREFIXES": []
}
self.save_settings()
def update_old_settings_v2(self):
# The joys of backwards compatibility
settings = self.bot_settings
if settings["EMAIL"] == "EmailHere":
settings["EMAIL"] = None
if settings["PASSWORD"] == "":
settings["PASSWORD"] = None
if settings["LOGIN_TYPE"] == "token":
settings["TOKEN"] = settings["EMAIL"]
settings["EMAIL"] = None
settings["PASSWORD"] = None
else:
settings["TOKEN"] = None
del settings["LOGIN_TYPE"]
self.save_settings()
@property
@@ -60,25 +137,42 @@ class Settings:
@owner.setter
def owner(self, value):
self.bot_settings["OWNER"] = value
self.save_settings()
@property
def token(self):
return os.environ.get("RED_TOKEN", self.bot_settings["TOKEN"])
@token.setter
def token(self, value):
self.bot_settings["TOKEN"] = value
self.bot_settings["EMAIL"] = None
self.bot_settings["PASSWORD"] = None
@property
def email(self):
return self.bot_settings["EMAIL"]
return os.environ.get("RED_EMAIL", self.bot_settings["EMAIL"])
@email.setter
def email(self, value):
self.bot_settings["EMAIL"] = value
self.save_settings()
self.bot_settings["TOKEN"] = None
@property
def password(self):
return self.bot_settings["PASSWORD"]
return os.environ.get("RED_PASSWORD", self.bot_settings["PASSWORD"])
@password.setter
def password(self, value):
self.bot_settings["PASSWORD"] = value
self.save_settings()
@property
def login_credentials(self):
if self.token:
return (self.token,)
elif self.email and self.password:
return (self.email, self.password)
else:
return tuple()
@property
def prefixes(self):
@@ -88,7 +182,6 @@ class Settings:
def prefixes(self, value):
assert isinstance(value, list)
self.bot_settings["PREFIXES"] = value
self.save_settings()
@property
def default_admin(self):
@@ -101,20 +194,18 @@ class Settings:
if "default" not in self.bot_settings:
self.update_old_settings()
self.bot_settings["default"]["ADMIN_ROLE"] = value
self.save_settings()
@property
def default_mod(self):
if "default" not in self.bot_settings:
self.update_old_settings()
self.update_old_settings_v1()
return self.bot_settings["default"].get("MOD_ROLE", "")
@default_mod.setter
def default_mod(self, value):
if "default" not in self.bot_settings:
self.update_old_settings()
self.update_old_settings_v1()
self.bot_settings["default"]["MOD_ROLE"] = value
self.save_settings()
@property
def servers(self):
@@ -125,15 +216,6 @@ class Settings:
ret.update({server: self.bot_settings[server]})
return ret
@property
def login_type(self):
return self.bot_settings["LOGIN_TYPE"]
@login_type.setter
def login_type(self, value):
self.bot_settings["LOGIN_TYPE"] = value
self.save_settings()
def get_server(self, server):
if server is None:
return self.bot_settings["default"].copy()