def handleMessage(self, message: psclient.Message):
"""Handles incoming messages from the server
Args:
message (psclient.Message): the Message object to handle
"""
if message.type in prefs.getPref('blacklistedTypes'): return
formatted: Union[str, HTML] = message.raw
if message.type == 'chat' and message.senderName and message.body and message.room:
time: str = f"[{str(datetime.utcfromtimestamp(int(message.time)).time())}] " if message.time else ""
toPrint = [
f"({message.room.id}) {time}{message.senderName.strip()}: {message.body}"
]
if '|raw|' in message.body:
split = message.body.split('|raw|')
toPrint[0] = toPrint[0].replace(message.body, split[0])
for item in split[1:]:
toPrint.append(formatHTML(item))
return [printf(item) for item in toPrint]
if message.type == 'pm' and message.senderName:
if message.sender and message.sender.id != message.connection.this.id:
formatted = f"(PM from {message.senderName.strip()}) {message.body}"
if message.type in ['join', 'leave'
] and message.room and message.senderName:
if prefs.getPref("showjoins"):
formatted = f"{message.senderName.strip()} {'joined' if message.type == 'join' else 'left'} {message.room.id}"
if message.type in ['raw', 'html', 'uhtml'] and message.raw:
index = 3 if message.type == 'uhtml' else 2
split = message.raw.split('|', index)
formatted = formatHTML(
f"{(split[index - 1] + ': ') if message.type == 'uhtml' else ''}{split[index]}"
)
printf(formatted)
def testPrefs() -> None:
"""Tests preferences
"""
prefs.PREFS_PATH = pathlib.Path('prefs.json').resolve()
prefs.setPref("test", 1)
assert prefs.getPref("test") == 1
prefs.setPref("test2", ["hIIII", '3 21', 2])
assert prefs.getPref("test") == 1
assert prefs.getPref("test2") == ["hIIII", '3 21', 2]
def mainLoop(*args: psclient.PSConnection) -> None:
"""Gets run when we connect to PS!
"""
if not args: return
conn: psclient.PSConnection = args[0]
hasAutojoined: bool = False
while True:
if conn.isLoggedIn and not hasAutojoined:
autojoins = prefs.getPref("autojoins")
if autojoins:
for room in autojoins:
conn.roomList.add(psclient.Room(room, conn))
hasAutojoined = True
printf("Logged in!")
command: Union[str, None] = None
try:
interface.handleMessage(messageQueue.get(block=False))
except queue.Empty:
pass
try:
command = inputQueue.get(block=False)
except queue.Empty:
interface.isBusy = False
if not command: continue
if command[:len(interface.commandChar)] == interface.commandChar:
split = command[len(interface.commandChar):].split(' ', 1)
if split[0].lower() in interface.commands.keys():
interface.commands[split[0].lower()](
split[1] if len(split) > 1 else '') # invoke the command
continue
printf(f"Unknown command '{interface.commandChar}{split[0]}'")
continue
interface.send(command)
interface.isBusy = False
def unloadPlugin(self, plugin: str) -> None:
"""Unloads a plugin
Args:
plugin (str): the name of the plugin to unload
"""
plugin = plugin.lower().replace(' ', '')
if not plugin: return logError("You must specify a plugin.")
if plugin not in self.loadedPlugins:
return logError("That plugin isn't loaded!")
try:
commands = importlib.import_module(plugin).commands # type: ignore
for command in commands:
if command in self.commands: del self.commands[command]
self.loadedPlugins.remove(plugin)
except ModuleNotFoundError:
return logError(f"No plugin named {plugin} was found.")
except Exception as err:
return logError(err)
pluginSettings: list = prefs.getPref("plugins")
if pluginSettings and plugin in pluginSettings:
pluginSettings.remove(plugin)
prefs.setPref("plugins", pluginSettings)
return printf(f"Plugin {plugin} unloaded!")
def loadPlugin(self, plugin: str) -> None:
"""Loads a plugin
Args:
plugin (str): the name of the plugin to load
"""
plugin = plugin.lower().replace(' ', '')
if not plugin: return logError("You must specify a plugin.")
if plugin in self.loadedPlugins:
return logError("That plugin is already loaded.")
pluginsPath: str = str(pathlib.Path('plugins').resolve())
if pluginsPath not in sys.path: sys.path.append(pluginsPath)
try:
self.commands.update(
importlib.import_module(plugin).commands) # type: ignore
self.loadedPlugins.add(plugin)
except ModuleNotFoundError:
return logError(f"No plugin named {plugin} was found.")
except AttributeError:
return logError("The plugin file is invalid." + \
f"Check that you have the latest version and that the file 'plugins/{plugin}.py' is correctly formatted")
except Exception as err:
return logError(err)
pluginSettings: list = prefs.getPref("plugins")
if not pluginSettings: pluginSettings = []
if plugin not in pluginSettings:
pluginSettings.append(plugin)
prefs.setPref("plugins", pluginSettings)
return printf(f"Plugin {plugin} loaded!")
def configure(self, isAdvanced: str) -> None:
"""Configures preferences
Args:
isAdvanced (str): 'advanced' means we show advanced settings
"""
# pylint: disable=unused-argument
preferences: dict = {
"username": "******",
"password": "******",
"autojoins":
"The rooms you want to automatically join upon logging in"
}
advancedPreferences: dict = {
"commandchar":
"The character to use before commands ('%' is recommended)",
"prompt":
"The prompt to use. If you don't know what you're doing, it's best to set this to '{room}> '"
}
loopDict = preferences if isAdvanced != 'advanced' else dict(
preferences, **advancedPreferences)
for pref in loopDict:
isPassword: bool = pref == "password"
currentValue: str = "******" if prefs.getPref(
pref) and isPassword else str(prefs.getPref(pref))
value: Any = inputDialog(
title=f"Configure {pref}",
text=f"{loopDict[pref]} (currently: {currentValue})",
password=isPassword).run()
if not value: continue
if pref == "autojoins":
value = [psclient.toID(room) for room in value.split(',')]
prefs.setPref(pref, value)
prefs.setPref(
"showjoins",
yesNoDialog(title="Configure showjoins",
text="Display join/leave messages?").run())
def __init__(self, connection: psclient.PSConnection) -> None:
self.connection: psclient.PSConnection = connection
self.roomContext: str = '' # is an ID
self.promptString: str = prefs.getPref("prompt") or "{room}> "
self.prompt: PromptSession = PromptSession(self.getPrompt())
self.commandChar: str = prefs.getPref("commandchar")
self.commands: Dict[str, Any] = {
"room": self.switchRoomContext,
"eval": self.eval,
"loadplugin": self.loadPlugin,
"load": self.loadPlugin,
"unload": self.unloadPlugin,
"unloadplugin": self.unloadPlugin,
"exit": self.exit,
"bye": self.exit,
"configure": self.configure
}
self.loadedPlugins: set = set()
plugins: list = prefs.getPref("plugins")
if plugins and isinstance(plugins, list):
for plugin in plugins:
self.loadPlugin(plugin)
self.isBusy: bool = False
except queue.Empty:
interface.isBusy = False
if not command: continue
if command[:len(interface.commandChar)] == interface.commandChar:
split = command[len(interface.commandChar):].split(' ', 1)
if split[0].lower() in interface.commands.keys():
interface.commands[split[0].lower()](
split[1] if len(split) > 1 else '') # invoke the command
continue
printf(f"Unknown command '{interface.commandChar}{split[0]}'")
continue
interface.send(command)
interface.isBusy = False
if __name__ == '__main__':
showdownConnection: psclient.PSConnection = psclient.PSConnection(
prefs.getPref("username"),
prefs.getPref("password"),
onParsedMessage=messageListener,
onOpenThread=mainLoop)
client: psclient.PSClient = psclient.PSClient(showdownConnection)
interface: PSInterface = PSInterface(showdownConnection)
if len(sys.argv) > 1 and sys.argv[1] in ['--config', '--configure']:
interface.configure("advanced" if len(sys.argv) > 2
and sys.argv[2] == '--advanced' else "")
sys.exit()
inputThread = threading.Thread(target=inputListener)
inputThread.start()
client.connect()
