capture_list: add plugin

This commit is contained in:
dece 2021-06-06 19:02:19 +02:00
parent 7f5ed39722
commit 93d59ff30b
4 changed files with 51 additions and 4 deletions

View file

@ -28,6 +28,11 @@
"capture_sentence": "Catch!",
"captured_sentence": "Well done {winner}, you got that {thing}!"
},
"capturelist": {
"commands": ["collection"],
"reply": "{target} captured {num} things : {things}",
"empty_reply": "{target} did not capture anything yet!"
},
"common": {
"command_suffix": "please",
"handling_conditions": {

View file

@ -95,9 +95,15 @@ class Plugin:
"""Set a value in the plugin runtime dict."""
self.bot.values[self.name][key] = value
def get_storage_value(self, key, default=None):
"""Get a value from the plugin persistent storage."""
return self.bot.storage.get(self.name, {}).get(key, default)
def get_storage_value(self, key, default=None, ns=None):
"""Get a value from the plugin persistent storage.
This will get the value from the plugin namespace, but it is possible to
get storage values from other plugins using their name as `ns`.
"""
if ns is None:
ns = self.name
return self.bot.storage.get(ns, {}).get(key, default)
def set_storage_value(self, key, value):
"""Set a value in the plugin persistent storage."""

View file

@ -0,0 +1,36 @@
from edmond.plugin import Plugin
class CaptureListPlugin(Plugin):
REQUIRED_CONFIGS = ["commands", "reply", "empty_reply"]
def __init__(self, bot):
super().__init__(bot)
def on_welcome(self, _):
if not self.bot.get_plugin("capture"):
self.bot.log_w("Capture plugin is not available.")
self.is_ready = False
def on_pubmsg(self, event):
if not self.should_handle_command(event.arguments[0]):
return False
collec_target = self.command.content or event.source.nick
collections = self.get_storage_value(
"collections",
default={},
ns="capture"
)
collection = collections.get(collec_target, [])
if collection:
reply = self.config["reply"].format(
target=collec_target,
num=len(collection),
things="".join(collection)
)
else:
reply = self.config["empty_reply"].format(target=collec_target)
self.bot.say(event.target, reply)
return True

View file

@ -28,7 +28,7 @@ class YoutubeParserPlugin(Plugin):
def on_welcome(self, _):
if not (self.youtube_plugin and self.youtube_plugin.is_ready):
self.log_w("Youtube plugin is not available.")
self.bot.log_w("Youtube plugin is not available.")
self.is_ready = False
def on_pubmsg(self, event):