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

[Core] Settings as Bot class attribute (#486)

Browse Source 
And pep8
This commit is contained in:
Will 2016-11-22 17:10:42 -05:00 committed by Twentysix
parent aef46f3820
commit 84ce5c3a8b
2 changed files with 82 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
cogs/utils/settings.py
View File

@ -4,11 +4,17 @@ import os
default_path = "data/red/settings.json" default_path = "data/red/settings.json"
class Settings: class Settings:
def __init__(self,path=default_path):
def __init__(self, path=default_path):
self.path = path self.path = path
self.check_folders() self.check_folders()
self.default_settings = {"EMAIL" : "EmailHere", "PASSWORD" : "", "OWNER" : "id_here", "PREFIXES" : [], "default":{"ADMIN_ROLE" : "Transistor", "MOD_ROLE" : "Process"}, "LOGIN_TYPE" : "email"} self.default_settings = {
"EMAIL": "EmailHere", "PASSWORD": "", "OWNER": "id_here",
"PREFIXES": [],
"default": {"ADMIN_ROLE": "Transistor", "MOD_ROLE": "Process"},
"LOGIN_TYPE": "email"}
if not dataIO.is_valid_json(self.path): if not dataIO.is_valid_json(self.path):
self.bot_settings = self.default_settings self.bot_settings = self.default_settings
self.save_settings() self.save_settings()
@ -18,7 +24,8 @@ class Settings:
for key in self.default_settings.keys(): for key in self.default_settings.keys():
if key not in current.keys(): if key not in current.keys():
current[key] = self.default_settings[key] current[key] = self.default_settings[key]
print("Adding " + str(key) + " field to red settings.json") print("Adding " + str(key) +
" field to red settings.json")
dataIO.save_json(self.path, current) dataIO.save_json(self.path, current)
self.bot_settings = dataIO.load_json(self.path) self.bot_settings = dataIO.load_json(self.path)
if "default" not in self.bot_settings: if "default" not in self.bot_settings:
@ -32,14 +39,14 @@ class Settings:
os.makedirs(folder) os.makedirs(folder)
def save_settings(self): def save_settings(self):
dataIO.save_json(self.path,self.bot_settings) dataIO.save_json(self.path, self.bot_settings)
def update_old_settings(self): def update_old_settings(self):
mod = self.bot_settings["MOD_ROLE"] mod = self.bot_settings["MOD_ROLE"]
admin = self.bot_settings["ADMIN_ROLE"] admin = self.bot_settings["ADMIN_ROLE"]
del self.bot_settings["MOD_ROLE"] del self.bot_settings["MOD_ROLE"]
del self.bot_settings["ADMIN_ROLE"] del self.bot_settings["ADMIN_ROLE"]
self.bot_settings["default"] = {"MOD_ROLE":mod,"ADMIN_ROLE":admin} self.bot_settings["default"] = {"MOD_ROLE": mod, "ADMIN_ROLE": admin}
self.save_settings() self.save_settings()
@property @property
@ -47,7 +54,7 @@ class Settings:
return self.bot_settings["OWNER"] return self.bot_settings["OWNER"]
@owner.setter @owner.setter
def owner(self,value): def owner(self, value):
self.bot_settings["OWNER"] = value self.bot_settings["OWNER"] = value
self.save_settings() self.save_settings()
@ -56,7 +63,7 @@ class Settings:
return self.bot_settings["EMAIL"] return self.bot_settings["EMAIL"]
@email.setter @email.setter
def email(self,value): def email(self, value):
self.bot_settings["EMAIL"] = value self.bot_settings["EMAIL"] = value
self.save_settings() self.save_settings()
@ -65,7 +72,7 @@ class Settings:
return self.bot_settings["PASSWORD"] return self.bot_settings["PASSWORD"]
@password.setter @password.setter
def password(self,value): def password(self, value):
self.bot_settings["PASSWORD"] = value self.bot_settings["PASSWORD"] = value
self.save_settings() self.save_settings()
@ -74,8 +81,8 @@ class Settings:
return self.bot_settings["PREFIXES"] return self.bot_settings["PREFIXES"]
@prefixes.setter @prefixes.setter
def prefixes(self,value): def prefixes(self, value):
assert isinstance(value,list) assert isinstance(value, list)
self.bot_settings["PREFIXES"] = value self.bot_settings["PREFIXES"] = value
self.save_settings() self.save_settings()
@ -83,10 +90,10 @@ class Settings:
def default_admin(self): def default_admin(self):
if "default" not in self.bot_settings: if "default" not in self.bot_settings:
self.update_old_settings() self.update_old_settings()
return self.bot_settings["default"].get("ADMIN_ROLE","") return self.bot_settings["default"].get("ADMIN_ROLE", "")
@default_admin.setter @default_admin.setter
def default_admin(self,value): def default_admin(self, value):
if "default" not in self.bot_settings: if "default" not in self.bot_settings:
self.update_old_settings() self.update_old_settings()
self.bot_settings["default"]["ADMIN_ROLE"] = value self.bot_settings["default"]["ADMIN_ROLE"] = value
@ -96,10 +103,10 @@ class Settings:
def default_mod(self): def default_mod(self):
if "default" not in self.bot_settings: if "default" not in self.bot_settings:
self.update_old_settings() self.update_old_settings()
return self.bot_settings["default"].get("MOD_ROLE","") return self.bot_settings["default"].get("MOD_ROLE", "")
@default_mod.setter @default_mod.setter
def default_mod(self,value): def default_mod(self, value):
if "default" not in self.bot_settings: if "default" not in self.bot_settings:
self.update_old_settings() self.update_old_settings()
self.bot_settings["default"]["MOD_ROLE"] = value self.bot_settings["default"]["MOD_ROLE"] = value
@ -108,60 +115,62 @@ class Settings:
@property @property
def servers(self): def servers(self):
ret = {} ret = {}
server_ids = list(filter(lambda x: str(x).isdigit(),self.bot_settings)) server_ids = list(
filter(lambda x: str(x).isdigit(), self.bot_settings))
for server in server_ids: for server in server_ids:
ret.update({server:self.bot_settings[server]}) ret.update({server: self.bot_settings[server]})
return ret return ret
@property @property
def login_type(self): def login_type(self):
return self.bot_settings["LOGIN_TYPE"] return self.bot_settings["LOGIN_TYPE"]
@login_type.setter @login_type.setter
def login_type(self,value): def login_type(self, value):
self.bot_settings["LOGIN_TYPE"] = value self.bot_settings["LOGIN_TYPE"] = value
self.save_settings() self.save_settings()
def get_server(self,server): def get_server(self, server):
if server is None: if server is None:
return self.bot_settings["default"].copy() return self.bot_settings["default"].copy()
assert isinstance(server,discord.Server) assert isinstance(server, discord.Server)
return self.bot_settings.get(server.id,self.bot_settings["default"]).copy() return self.bot_settings.get(server.id,
self.bot_settings["default"]).copy()
def get_server_admin(self,server): def get_server_admin(self, server):
if server is None: if server is None:
return self.default_admin return self.default_admin
assert isinstance(server,discord.Server) assert isinstance(server, discord.Server)
if server.id not in self.bot_settings: if server.id not in self.bot_settings:
return self.default_admin return self.default_admin
return self.bot_settings[server.id].get("ADMIN_ROLE","") return self.bot_settings[server.id].get("ADMIN_ROLE", "")
def set_server_admin(self,server,value): def set_server_admin(self, server, value):
if server is None: if server is None:
return return
assert isinstance(server,discord.Server) assert isinstance(server, discord.Server)
if server.id not in self.bot_settings: if server.id not in self.bot_settings:
self.add_server(server.id) self.add_server(server.id)
self.bot_settings[server.id]["ADMIN_ROLE"] = value self.bot_settings[server.id]["ADMIN_ROLE"] = value
self.save_settings() self.save_settings()
def get_server_mod(self,server): def get_server_mod(self, server):
if server is None: if server is None:
return self.default_mod return self.default_mod
assert isinstance(server,discord.Server) assert isinstance(server, discord.Server)
if server.id not in self.bot_settings: if server.id not in self.bot_settings:
return self.default_mod return self.default_mod
return self.bot_settings[server.id].get("MOD_ROLE","") return self.bot_settings[server.id].get("MOD_ROLE", "")
def set_server_mod(self,server,value): def set_server_mod(self, server, value):
if server is None: if server is None:
return return
assert isinstance(server,discord.Server) assert isinstance(server, discord.Server)
if server.id not in self.bot_settings: if server.id not in self.bot_settings:
self.add_server(server.id) self.add_server(server.id)
self.bot_settings[server.id]["MOD_ROLE"] = value self.bot_settings[server.id]["MOD_ROLE"] = value
self.save_settings() self.save_settings()
def add_server(self,sid): def add_server(self, sid):
self.bot_settings[sid] = self.bot_settings["default"].copy() self.bot_settings[sid] = self.bot_settings["default"].copy()
self.save_settings() self.save_settings()

63
red.py
View File

@ -31,12 +31,16 @@ from cogs.utils.chat_formatting import inline
from collections import Counter from collections import Counter
# #
# Red, a Discord bot by Twentysix, based on discord.py and its command extension # Red, a Discord bot by Twentysix, based on discord.py and its command
# extension.
#
# https://github.com/Twentysix26/ # https://github.com/Twentysix26/
# #
# #
# red.py and cogs/utils/checks.py both contain some modified functions originally made by Rapptz # red.py and cogs/utils/checks.py both contain some modified functions
# https://github.com/Rapptz/RoboDanny/tree/async # originally made by Rapptz.
#
# https://github.com/Rapptz/RoboDanny/
# #
description = "Red - A multifunction Discord bot by Twentysix" description = "Red - A multifunction Discord bot by Twentysix"
@ -47,6 +51,7 @@ class Bot(commands.Bot):
self.counter = Counter() self.counter = Counter()
self.uptime = datetime.datetime.now() self.uptime = datetime.datetime.now()
self._message_modifiers = [] self._message_modifiers = []
self.settings = Settings()
super().__init__(*args, **kwargs) super().__init__(*args, **kwargs)
async def send_message(self, *args, **kwargs): async def send_message(self, *args, **kwargs):
@ -174,7 +179,7 @@ bot = Bot(command_prefix=["_"], formatter=formatter,
send_cmd_help = bot.send_cmd_help # Backwards send_cmd_help = bot.send_cmd_help # Backwards
user_allowed = bot.user_allowed # compatibility user_allowed = bot.user_allowed # compatibility
settings = Settings() settings = bot.settings
@bot.event @bot.event
@ -245,6 +250,7 @@ async def on_command_error(error, ctx):
else: else:
logger.exception(type(error).__name__, exc_info=error) logger.exception(type(error).__name__, exc_info=error)
async def get_oauth_url(): async def get_oauth_url():
try: try:
data = await bot.application_info() data = await bot.application_info()
@ -252,6 +258,7 @@ async def get_oauth_url():
return "Couldn't retrieve invite link.Error: {}".format(e) return "Couldn't retrieve invite link.Error: {}".format(e)
return discord.utils.oauth_url(data.id) return discord.utils.oauth_url(data.id)
async def set_bot_owner(): async def set_bot_owner():
try: try:
data = await bot.application_info() data = await bot.application_info()
@ -294,8 +301,8 @@ def check_configs():
"process.") "process.")
exit(1) exit(1)
print("\nChoose a prefix. A prefix is what you type before a command.\n" print("\nChoose a prefix. A prefix is what you type before a command."
"A typical prefix would be the exclamation mark.\n" "\nA typical prefix would be the exclamation mark.\n"
"Can be multiple characters. You will be able to change it " "Can be multiple characters. You will be able to change it "
"later and add more of them.\nChoose your prefix:") "later and add more of them.\nChoose your prefix:")
confirmation = False confirmation = False
@ -303,48 +310,52 @@ def check_configs():
new_prefix = ensure_reply("\nPrefix> ").strip() new_prefix = ensure_reply("\nPrefix> ").strip()
print("\nAre you sure you want {0} as your prefix?\nYou " print("\nAre you sure you want {0} as your prefix?\nYou "
"will be able to issue commands like this: {0}help" "will be able to issue commands like this: {0}help"
"\nType yes to confirm or no to change it".format(new_prefix)) "\nType yes to confirm or no to change it".format(
new_prefix))
confirmation = get_answer() confirmation = get_answer()
settings.prefixes = [new_prefix] settings.prefixes = [new_prefix]
if settings.login_type == "email": if settings.login_type == "email":
print("\nOnce you're done with the configuration, you will have to type " print("\nOnce you're done with the configuration, you will have to"
"'{}set owner' *in Discord's chat*\nto set yourself as owner.\n" " type '{}set owner' *in Discord's chat*\nto set yourself as"
"Press enter to continue".format(new_prefix)) " owner.\nPress enter to continue".format(new_prefix))
settings.owner = input("") # Shh, they will never know it's here settings.owner = input("") # Shh, they will never know it's here
if settings.owner == "": if settings.owner == "":
settings.owner = "id_here" settings.owner = "id_here"
if not settings.owner.isdigit() or len(settings.owner) < 17: if not settings.owner.isdigit() or len(settings.owner) < 17:
if settings.owner != "id_here": if settings.owner != "id_here":
print("\nERROR: What you entered is not a valid ID. Set " print("\nERROR: What you entered is not a valid ID. Set "
"yourself as owner later with {}set owner".format(new_prefix)) "yourself as owner later with {}set owner".format(
new_prefix))
settings.owner = "id_here" settings.owner = "id_here"
else: else:
settings.owner = "id_here" settings.owner = "id_here"
print("\nInput the admin role's name. Anyone with this role in Discord will be " print("\nInput the admin role's name. Anyone with this role in Discord"
"able to use the bot's admin commands") " will be able to use the bot's admin commands")
print("Leave blank for default name (Transistor)") print("Leave blank for default name (Transistor)")
settings.default_admin = input("\nAdmin role> ") settings.default_admin = input("\nAdmin role> ")
if settings.default_admin == "": if settings.default_admin == "":
settings.default_admin = "Transistor" settings.default_admin = "Transistor"
print("\nInput the moderator role's name. Anyone with this role in Discord will " print("\nInput the moderator role's name. Anyone with this role in"
"be able to use the bot's mod commands") " Discord will be able to use the bot's mod commands")
print("Leave blank for default name (Process)") print("Leave blank for default name (Process)")
settings.default_mod = input("\nModerator role> ") settings.default_mod = input("\nModerator role> ")
if settings.default_mod == "": if settings.default_mod == "":
settings.default_mod = "Process" settings.default_mod = "Process"
print("\nThe configuration is done. Leave this window always open to keep " print("\nThe configuration is done. Leave this window always open to"
"Red online.\nAll commands will have to be issued through Discord's " " keep Red online.\nAll commands will have to be issued through"
"chat, *this window will now be read only*.\nPress enter to continue") " Discord's chat, *this window will now be read only*.\nPress"
" enter to continue")
input("\n") input("\n")
if not os.path.isfile("data/red/cogs.json"): if not os.path.isfile("data/red/cogs.json"):
print("Creating new cogs.json...") print("Creating new cogs.json...")
dataIO.save_json("data/red/cogs.json", {}) dataIO.save_json("data/red/cogs.json", {})
def set_logger(): def set_logger():
global logger global logger
logger = logging.getLogger("discord") logger = logging.getLogger("discord")
@ -377,12 +388,14 @@ def set_logger():
logger.addHandler(fhandler) logger.addHandler(fhandler)
logger.addHandler(stdout_handler) logger.addHandler(stdout_handler)
def ensure_reply(msg): def ensure_reply(msg):
choice = "" choice = ""
while choice == "": while choice == "":
choice = input(msg) choice = input(msg)
return choice return choice
def get_answer(): def get_answer():
choices = ("yes", "y", "no", "n") choices = ("yes", "y", "no", "n")
c = "" c = ""
@ -393,11 +406,13 @@ def get_answer():
else: else:
return False return False
def set_cog(cog, value): def set_cog(cog, value):
data = dataIO.load_json("data/red/cogs.json") data = dataIO.load_json("data/red/cogs.json")
data[cog] = value data[cog] = value
dataIO.save_json("data/red/cogs.json", data) dataIO.save_json("data/red/cogs.json", data)
def load_cogs(): def load_cogs():
no_prompt = "--no-prompt" in sys.argv[1:] no_prompt = "--no-prompt" in sys.argv[1:]
@ -500,11 +515,11 @@ if __name__ == '__main__':
error = True error = True
logger.error(traceback.format_exc()) logger.error(traceback.format_exc())
choice = input("Invalid login credentials. " choice = input("Invalid login credentials. "
"If they worked before Discord might be having temporary " "If they worked before Discord might be having temporary "
"technical issues.\nIn this case, press enter and " "technical issues.\nIn this case, press enter and "
"try again later.\nOtherwise you can type 'reset' to " "try again later.\nOtherwise you can type 'reset' to "
"delete the current configuration and redo the setup process " "delete the current configuration and redo the setup process "
"again the next start.\n> ") "again the next start.\n> ")
if choice.strip() == "reset": if choice.strip() == "reset":
shutil.copy('data/red/settings.json', shutil.copy('data/red/settings.json',
'data/red/settings-{}.bak'.format(int(time.time()))) 'data/red/settings-{}.bak'.format(int(time.time())))