Edm0nd/edmond/bot.py

210 lines
7.9 KiB
Python
Raw Normal View History

import importlib
2020-10-09 23:37:35 +02:00
import json
import os
import time
import signal
import sys
import traceback
from pathlib import Path
from typing import Any, Iterable, Optional
2022-08-15 13:35:42 +02:00
import irc.client
from irc.client import Connection, Event, NickMask
2020-10-08 18:46:45 +02:00
from edmond.log import Logger
from edmond.plugin import Plugin
2020-10-08 18:46:45 +02:00
class Bot(irc.client.SimpleIRCClient, Logger):
"""Main class for the IRC bot: handles connection and manages available plugins."""
2020-10-08 18:46:45 +02:00
2020-11-01 19:23:42 +01:00
CHANNELS_RUNTIME_KEY = "_channels"
def __init__(self, config: dict, logger):
2020-10-08 18:46:45 +02:00
super().__init__()
self.config: dict = config
2020-10-08 18:46:45 +02:00
self.logger = logger
self.plugins: list[Plugin] = []
self.values: dict[str, Any] = {}
2022-08-15 13:35:42 +02:00
self.storage: dict[str, Any] = self.get_storage()
self.done: bool = False
2020-10-08 18:46:45 +02:00
@property
def nick(self) -> str:
2020-11-01 19:29:51 +01:00
"""Nickname validated by the server, or the configured nick."""
if self.connection.is_connected():
return self.connection.get_nickname()
2020-10-08 18:46:45 +02:00
return self.config["nick"]
@property
def names(self) -> Iterable[str]:
2020-11-01 19:29:51 +01:00
"""Collection of names the bot should identify with."""
return (self.nick, *self.config["alternative_nicks"])
2020-11-01 19:23:42 +01:00
@property
def channels(self) -> list[str]:
2020-11-01 19:23:42 +01:00
"""List of joined channels."""
if self.CHANNELS_RUNTIME_KEY not in self.values:
self.values[self.CHANNELS_RUNTIME_KEY] = []
return self.values[self.CHANNELS_RUNTIME_KEY]
2022-08-15 13:35:42 +02:00
def get_storage(self) -> dict:
2020-10-09 23:37:35 +02:00
"""Load data from storage."""
try:
with open(self.config["storage_file"], "rt") as storage_file:
storage = json.load(storage_file)
self.log_d("Loaded storage file.")
return storage
except (OSError, json.decoder.JSONDecodeError) as exc:
self.log_e(f"Could not load storage file: {exc}")
self.log_w(
"If it's not the first time Edm0nd is run, you may lose"
" data when closing the program."
)
2020-10-09 23:37:35 +02:00
return {}
2022-08-15 13:35:42 +02:00
def save_storage(self) -> None:
2020-10-09 23:37:35 +02:00
"""Save storage data to disk."""
try:
with open(self.config["storage_file"], "wt") as storage_file:
json.dump(self.storage, storage_file, indent=2, sort_keys=True)
self.log_d("Saved storage file.")
2022-07-05 23:35:58 +02:00
except OSError as exc:
2020-10-09 23:37:35 +02:00
self.log_e(f"Could not save storage file: {exc}")
def on_welcome(self, connection: Connection, event: Event):
2020-11-01 19:29:51 +01:00
"""Handle a successful connection to a server."""
2020-10-08 18:46:45 +02:00
self.log_i(f"Connected to server {event.source}.")
2020-10-09 12:19:58 +02:00
self.run_plugin_callbacks(event)
2020-10-08 18:46:45 +02:00
for channel in self.config["channels"]:
connection.join(channel)
def on_join(self, connection: Connection, event: Event):
2020-11-01 19:29:51 +01:00
"""Handle someone, possibly the bot, joining a channel."""
if event.source.nick == self.nick:
self.log_i(f"Joined {event.target}.")
2020-11-01 19:23:42 +01:00
self.channels.append(event.target)
self.run_plugin_callbacks(event)
2020-10-08 18:46:45 +02:00
def on_part(self, connection: Connection, event: Event):
2020-11-01 19:29:51 +01:00
"""Handle someone, possibly the bot, leaving a channel."""
if event.source.nick == self.nick:
self.log_i(f"Left {event.target} (args: {event.arguments[0]}).")
2020-11-01 19:23:42 +01:00
self.channels.remove(event.target)
self.run_plugin_callbacks(event)
2020-10-08 18:46:45 +02:00
def on_pubmsg(self, connection: Connection, event: Event):
2020-11-01 19:29:51 +01:00
"""Handle a message received in a channel."""
2020-10-08 18:46:45 +02:00
channel = event.target
nick = NickMask(event.source).nick
message = event.arguments[0]
self.log_d(f"Message in {channel} from {nick}: {message}")
self.run_plugin_callbacks(event)
2020-10-08 18:46:45 +02:00
def on_privmsg(self, connection: Connection, event: Event):
"""Handle a message received privately, usually like a channel msg."""
2020-10-08 18:46:45 +02:00
nick = NickMask(event.source).nick
target = event.target
message = event.arguments[0]
self.log_d(f"Private message from {nick} to {target}: {message}")
self.run_plugin_callbacks(event)
2020-10-08 18:46:45 +02:00
def on_ping(self, connection: Connection, event: Event):
2020-11-01 19:27:12 +01:00
"""Handle a ping; can be used as a random event timer."""
self.log_d(f"Received ping from {event.target}.")
self.run_plugin_callbacks(event)
2020-10-08 18:46:45 +02:00
def run(self):
"""Connect the bot to server, join channels and start responding."""
2020-10-08 18:46:45 +02:00
self.log_i("Starting Edmond.")
self.load_plugins()
2020-11-06 12:24:16 +01:00
self.log_i("Connecting to server.")
2020-10-08 18:46:45 +02:00
self.connect(self.config["host"], self.config["port"], self.nick)
signal.signal(signal.SIGTERM, self.handle_sigterm)
2020-10-08 18:46:45 +02:00
try:
self.start()
except KeyboardInterrupt:
2021-06-11 11:28:22 +02:00
self.log_i("Caught keyboard interrupt.")
except Exception as exc:
2022-05-19 14:12:20 +02:00
self.log_c(f"Caught unhandled exception: {exc}")
_, _, exc_traceback = sys.exc_info()
for line in traceback.format_tb(exc_traceback):
self.log_d(line.rstrip())
2021-06-11 11:28:22 +02:00
finally:
self.cleanup()
def load_plugins(self):
"""Load all installed plugins."""
2020-11-06 12:24:16 +01:00
self.log_i("Loading plugins.")
plugin_files = os.listdir(Path(__file__).parent / "plugins")
plugin_names = map(
lambda f: os.path.splitext(f)[0],
filter(
lambda f: f.endswith(".py") and f != "__init__.py",
plugin_files,
),
)
for plugin_name in plugin_names:
module = importlib.import_module(f"edmond.plugins.{plugin_name}")
are_dependencies_ok = getattr(module, "DEPENDENCIES_FOUND", True)
if not are_dependencies_ok:
self.log_e(f"Dependencies not found for plugin {plugin_name}.")
continue
# Get plugin class name from its module name.
class_name = (
"".join(map(lambda w: w.capitalize(), plugin_name.split("_")))
+ "Plugin"
)
plugin_class = getattr(module, class_name)
self.plugins.append(plugin_class(self))
2020-10-09 12:19:58 +02:00
self.values[plugin_name] = {}
self.log_d(f"Loaded {class_name}.")
def get_plugin(self, name: str) -> Optional[Plugin]:
"""Get a loaded plugin by its name (e.g. 'mood'), or None."""
matching_plugins = filter(
lambda plugin: plugin.name == name,
self.plugins,
)
return next(matching_plugins, None)
def say(self, target: str, message: str) -> None:
"""Send message to target after a slight delay."""
message = message.replace("\n", " ").replace("\r", " ")
time.sleep(self.config["speak_delay"])
self.log_d(f"Sending to {target}: {message}")
try:
if message.startswith("/me "):
self.connection.action(target, message[4:])
else:
self.connection.privmsg(target, message)
except irc.client.MessageTooLong:
self.log_e("Could not send, message is too long.")
def run_plugin_callbacks(self, event: Event) -> None:
2020-10-09 23:37:35 +02:00
"""Run appropriate callbacks for each plugin."""
etype = event.type
ready_plugins = filter(lambda p: p.is_ready, self.plugins)
plugins = sorted(ready_plugins, key=lambda p: p.priority, reverse=True)
2020-11-03 16:22:57 +01:00
for plugin in plugins:
callbacks = plugin.callbacks
if etype not in callbacks:
continue
if callbacks[etype](event):
break
def handle_sigterm(self, *args):
"""Handle SIGTERM (keyboard interrupt, systemd stop, etc)."""
self.cleanup()
exit("Exiting after received SIGTERM.")
def cleanup(self) -> None:
"""Save the storage file and close the connection. Run only once."""
if self.done:
return
self.log_i("Stopping Edmond.")
2022-08-15 14:11:14 +02:00
self.save_storage()
if self.connection.is_connected():
self.connection.close()
self.done = True