def cmd_help(self, data):
all_data = data.message.strip().split()
if len(all_data) < 2:
all_plugin_names = [plugin for plugin in list(GS.bot_plugins)]
all_plugin_metadata = [{
"name":
plugin_name,
"metadata":
GS.bot_plugins[plugin_name].metadata
} for plugin_name in all_plugin_names]
all_core_plugin_names = [
(plugin_info["name"],
plugin_info["metadata"][C_PLUGIN_INFO][P_PLUGIN_NAME])
for plugin_info in all_plugin_metadata
if plugin_info["metadata"].getboolean(C_PLUGIN_TYPE,
P_CORE_PLUGIN)
]
all_extension_plugin_names = [
(plugin_info["name"],
plugin_info["metadata"][C_PLUGIN_INFO][P_PLUGIN_NAME])
for plugin_info in all_plugin_metadata
if plugin_info["metadata"].getboolean(C_PLUGIN_TYPE,
P_EXT_PLUGIN)
]
GS.gui_service.open_box()
content = GS.gui_service.make_content(
f'<font color="{GS.cfg[C_PGUI_SETTINGS][P_TXT_HEAD_COL]}">##### </font>'
f'<b>{rutils.get_bot_name()} General Help Commands</b>'
f'<font color="{GS.cfg[C_PGUI_SETTINGS][P_TXT_HEAD_COL]}"> #####</font>'
)
GS.gui_service.append_row(content)
content = GS.gui_service.make_content(
f'<font color="{GS.cfg[C_PGUI_SETTINGS][P_TXT_HEAD_COL]}">##### </font>'
f'<b>Core Plugins</b>'
f'<font color="{GS.cfg[C_PGUI_SETTINGS][P_TXT_HEAD_COL]}"> #####</font>'
)
GS.gui_service.append_row(content)
for x, plugin_info in enumerate(all_core_plugin_names):
content = GS.gui_service.make_content(
f'<font color="{GS.cfg[C_PGUI_SETTINGS][P_TXT_SUBHEAD_COL]}">!help {plugin_info[0].strip()}</font> - Displays help information for the <font color="{GS.cfg[C_PGUI_SETTINGS][P_TXT_IND_COL]}">{plugin_info[1]}</font> plugin.',
text_type='header',
text_align="left")
GS.gui_service.append_row(content)
content = GS.gui_service.make_content(
f'<font color="{GS.cfg[C_PGUI_SETTINGS][P_TXT_HEAD_COL]}">##### </font>'
f'<b>Extension Plugins</b>'
f'<font color="{GS.cfg[C_PGUI_SETTINGS][P_TXT_HEAD_COL]}"> #####</font>'
)
GS.gui_service.append_row(content)
for x, plugin_info in enumerate(all_extension_plugin_names):
content = GS.gui_service.make_content(
f'<font color="{GS.cfg[C_PGUI_SETTINGS][P_TXT_SUBHEAD_COL]}">!help {plugin_info[0].strip()}</font> - Displays help information for the <font color="{GS.cfg[C_PGUI_SETTINGS][P_TXT_IND_COL]}">{plugin_info[1].strip()}</font> plugin.',
text_type='header',
text_align="left")
GS.gui_service.append_row(content)
GS.gui_service.close_box()
GS.gui_service.display_box(channel=rutils.get_my_channel())
log(INFO,
f"Displayed general help screen in the channel.",
origin=L_COMMAND,
print_mode=PrintMode.VERBOSE_PRINT.value)
return
plugin_name = all_data[1]
plugin_help_data = PluginUtilityService.process_help(
db_cursor=get_memory_db().cursor(), plugin_name=plugin_name)
if plugin_help_data:
plugin_metadata = GS.bot_plugins[plugin_name].metadata
GS.gui_service.open_box()
all_help_lines = [
msg.strip() for msg in plugin_help_data.split('<br>')
]
content = GS.gui_service.make_content(
f'<font color="red">##### </font>'
f'<b>{rutils.get_bot_name()} Help Commands - [{plugin_name}]</b>'
f'<font color="red"> #####</font>')
GS.gui_service.append_row(content)
content = GS.gui_service.make_content(
f'Plugin Version: {plugin_metadata[C_PLUGIN_INFO][P_PLUGIN_VERS]}<br>',
text_color='cyan')
GS.gui_service.append_row(content)
for x, help_item in enumerate(all_help_lines):
item_parts = help_item.rsplit(':', 1)
if len(item_parts) > 1:
content = GS.gui_service.make_content(
f'<font color="yellow">{item_parts[0]}</font>:{item_parts[1]}',
text_type='header',
text_align="left")
else:
content = GS.gui_service.make_content(f'{help_item}',
text_type='header',
text_align="left")
GS.gui_service.append_row(content)
GS.gui_service.close_box()
GS.gui_service.display_box(channel=rutils.get_my_channel())
log(INFO,
f"Displayed help screen for {plugin_name} in the channel.",
origin=L_COMMAND,
print_mode=PrintMode.VERBOSE_PRINT.value)
def process(self, text):
message = text.message.strip()
message_parse = message[1:].split(' ', 1)
command = message_parse[0]
if command == "sleep":
if not privileges.plugin_privilege_checker(text, command,
self.plugin_name):
return
sleep_time = float(text.message[1:].split(' ', 1)[1].strip())
RS.tick_rate = sleep_time
sleep(sleep_time)
RS.tick_rate = float(GS.cfg[C_MAIN_SETTINGS][P_CMD_TICK_RATE])
elif command == "version":
if not privileges.plugin_privilege_checker(text, command,
self.plugin_name):
return
GS.gui_service.quick_gui(
f"{rutils.get_bot_name()} is on version {rutils.get_version()}",
text_type='header',
box_align='left')
elif command == "about":
if not privileges.plugin_privilege_checker(text, command,
self.plugin_name):
return
GS.gui_service.quick_gui(
f"{rutils.get_about()}<br>{rutils.get_bot_name()} is on version {rutils.get_version()}",
text_type='header',
box_align='left')
elif command == "uptime":
if not privileges.plugin_privilege_checker(text, command,
self.plugin_name):
return
GS.gui_service.quick_gui(
rutils.check_up_time(),
text_type='header',
box_align='left',
ignore_whisper=True,
user=GS.mumble_inst.users[text.actor]['name'])
elif command == "exit":
if not privileges.plugin_privilege_checker(text, command,
self.plugin_name):
return
dprint("Stopping all threads...")
rutils.exit_bot()
log(INFO, "JJ Mumble Bot is being shut down.")
log(INFO, "######################################")
elif command == "reboot":
import os
import sys
if not privileges.plugin_privilege_checker(text, command,
self.plugin_name):
return
rutils.exit_bot()
log(INFO, "JJ Mumble Bot is being rebooted.", origin=L_STARTUP)
os.execv(sys.executable, ['python3'] + sys.argv) # nosec
elif command == "safereboot":
import os
import sys
if not privileges.plugin_privilege_checker(text, command,
self.plugin_name):
return
rutils.exit_bot()
log(INFO,
"JJ Mumble Bot is being rebooted in safe mode.",
origin=L_STARTUP)
os.execv(sys.executable,
['python3'] + sys.argv + ['-safe']) # nosec
elif command == "refresh":
if not privileges.plugin_privilege_checker(text, command,
self.plugin_name):
return
rutils.refresh_plugins()
elif command == "help":
if not privileges.plugin_privilege_checker(text, command,
self.plugin_name):
return
message = text.message.strip()
message_parse = message[1:].split(' ', 2)
if len(message_parse) < 2:
return
plugin_name = message_parse[1]
plugin_help_data = PluginUtilityService.process_help(
db_cursor=get_memory_db().cursor(), plugin_name=plugin_name)
if plugin_help_data:
GS.gui_service.open_box()
all_help_lines = [
msg.strip() for msg in plugin_help_data.split('<br>')
]
content = GS.gui_service.make_content(
f'<font color="red">##### </font>'
f'<b>{rutils.get_bot_name()} Help Commands - [{plugin_name}]</b>'
f'<font color="red"> #####</font>')
GS.gui_service.append_row(content)
content = GS.gui_service.make_content(
f'Plugin Version: {self.metadata[C_PLUGIN_INFO][P_PLUGIN_VERS]}<br>',
text_color='cyan')
GS.gui_service.append_row(content)
for i, item in enumerate(all_help_lines):
item_parts = item.split(':', 1)
if len(item_parts) > 1:
content = GS.gui_service.make_content(
f'<font color="yellow">{item_parts[0]}</font>:{item_parts[1]}',
text_type='header',
text_align="left")
else:
content = GS.gui_service.make_content(
f'{item}', text_type='header', text_align="left")
GS.gui_service.append_row(content)
GS.gui_service.close_box()
GS.gui_service.display_box(channel=rutils.get_my_channel())
dprint(
f"Displayed help screen for {plugin_name} in the channel.")
log(INFO,
f"Displayed help screen for {plugin_name} in the channel.",
origin=L_COMMAND)
elif command == "alias":
if not privileges.plugin_privilege_checker(text, command,
self.plugin_name):
return
message = text.message.strip()
message_parse = message[1:].split(' ', 2)
if len(message_parse) < 2:
return
alias_name = message_parse[1]
if aliases.add_to_aliases(alias_name, message_parse[2]):
GS.gui_service.quick_gui(
f"Registered new alias: [{alias_name}] - [{message_parse[2]}]",
text_type='header',
box_align='left',
ignore_whisper=True,
user=GS.mumble_inst.users[text.actor]['name'])
elif aliases.set_alias(alias_name, message_parse[2]):
GS.gui_service.quick_gui(
f"Registered alias: [{alias_name}] - [{message_parse[2]}]",
text_type='header',
box_align='left',
ignore_whisper=True,
user=GS.mumble_inst.users[text.actor]['name'])
elif command == "aliases":
if not privileges.plugin_privilege_checker(text, command,
self.plugin_name):
return
aliases_list = aliases.get_all_aliases()
if len(aliases_list) == 0:
cur_text = f"<font color='{GS.cfg[C_PGUI_SETTINGS][P_TXT_HEAD_COL]}'>Registered Aliases: None</font>"
else:
cur_text = f"<font color='{GS.cfg[C_PGUI_SETTINGS][P_TXT_HEAD_COL]}'>Registered Aliases:</font>"
for i, alias in enumerate(aliases_list):
cur_text += f"<br><font color={GS.cfg[C_PGUI_SETTINGS][P_TXT_IND_COL]}>[{alias[0]}]</font> - " \
f"[{BeautifulSoup(alias[1], 'html.parser').get_text()}] "
if i % 50 == 0 and i != 0:
GS.gui_service.quick_gui(
cur_text,
text_type='header',
box_align='left',
text_align='left',
ignore_whisper=True,
user=GS.mumble_inst.users[text.actor]['name'])
cur_text = ""
GS.gui_service.quick_gui(
cur_text,
text_type='header',
box_align='left',
text_align='left',
ignore_whisper=True,
user=GS.mumble_inst.users[text.actor]['name'])
elif command == "removealias":
if not privileges.plugin_privilege_checker(text, command,
self.plugin_name):
return
message = text.message.strip()
message_parse = message[1:].split(' ', 2)
if len(message_parse) < 2:
return
alias_name = message_parse[1]
if aliases.remove_from_aliases(alias_name):
GS.gui_service.quick_gui(
f'Removed [{alias_name}] from registered aliases.',
text_type='header',
box_align='left',
ignore_whisper=True,
user=GS.mumble_inst.users[text.actor]['name'])
else:
GS.gui_service.quick_gui(
f'Could not remove [{alias_name}] from registered aliases.',
text_type='header',
box_align='left',
ignore_whisper=True,
user=GS.mumble_inst.users[text.actor]['name'])
elif command == "clearaliases":
if not privileges.plugin_privilege_checker(text, command,
self.plugin_name):
return
if aliases.clear_aliases():
GS.gui_service.quick_gui(
'Cleared all registered aliases.',
text_type='header',
box_align='left',
ignore_whisper=True,
user=GS.mumble_inst.users[text.actor]['name'])
else:
GS.gui_service.quick_gui(
'The registered aliases could not be cleared.',
text_type='header',
box_align='left',
ignore_whisper=True,
user=GS.mumble_inst.users[text.actor]['name'])
elif command == "clearhistory":
if not privileges.plugin_privilege_checker(text, command,
self.plugin_name):
return
GS.cmd_history.queue_storage.clear()
GS.gui_service.quick_gui(
f'<font color="{GS.cfg[C_PGUI_SETTINGS][P_TXT_HEAD_COL]}">Cleared command history.</font>',
text_type='header',
box_align='left',
text_align='left',
ignore_whisper=True,
user=GS.mumble_inst.users[text.actor]['name'])
elif command == "history":
if not privileges.plugin_privilege_checker(text, command,
self.plugin_name):
return
cur_text = f"<font color='{GS.cfg[C_PGUI_SETTINGS][P_TXT_HEAD_COL]}'>Command History:</font>"
for i, item in enumerate(GS.cmd_history.queue_storage):
cur_text += f"<br><font color={GS.cfg[C_PGUI_SETTINGS][P_TXT_IND_COL]}>[{i}]</font> - {item}"
if i % 50 == 0 and i != 0:
GS.gui_service.quick_gui(
cur_text,
text_type='header',
box_align='left',
text_align='left',
ignore_whisper=True,
user=GS.mumble_inst.users[text.actor]['name'])
cur_text = ""
GS.gui_service.quick_gui(
cur_text,
text_type='header',
box_align='left',
text_align='left',
ignore_whisper=True,
user=GS.mumble_inst.users[text.actor]['name'])