move loading to plugin, issue w/ disabled plugins

pull/74/head
Mallory Hancock 2019-09-27 18:18:19 -07:00
parent 80dcc75a58
commit 8d01f70a5c
2 changed files with 55 additions and 42 deletions

View File

@ -1,8 +1,6 @@
from collections import OrderedDict
from datetime import datetime, timezone
import imp
import logging
import os
import ssl
import time
@ -46,7 +44,7 @@ class Bot(irc.bot.SingleServerIRCBot):
'disable': 'disable a plugin'
}
self.internal_commands = {self.cmd_prefix + k: v for k,v in self.internal_commands.items()}
self.load_plugins()
plugin.load_plugins(self.plugin_dir, use_prefix=self.use_prefix_for_plugins, cmd_prefix=self.cmd_prefix)
class Message:
def __init__(self, bot, channel, nick, botnick, ops, logger, action, privmsg, notice, cmd=None, arg=None, text=None, nick_list=None):
@ -89,33 +87,6 @@ class Bot(irc.bot.SingleServerIRCBot):
self.logger.setLevel(level)
self.logger.info('Logging started!')
def load_plugins(self):
# clear plugin list to ensure no old plugins remain
self.logger.info('clearing plugin cache')
plugin.clear_plugins()
# ensure plugin folder exists
self.logger.info('checking plugin directory')
if not os.path.exists(self.plugin_dir):
self.logger.info('plugin directory {} not found, creating'.format(self.plugin_dir))
os.makedirs(self.plugin_dir)
# load all plugins
for m in os.listdir(self.plugin_dir):
if m.endswith('.py'):
try:
name = m[:-3]
self.logger.info('loading plugin {}'.format(name))
fp, pathname, description = imp.find_module(name, [self.plugin_dir])
imp.load_module(name, fp, pathname, description)
except Exception:
self.logger.exception('could not load plugin')
# gather all commands and listeners
if self.use_prefix_for_plugins: # use prefixes if needed
plugin.cmds = {self.cmd_prefix + k: v for k,v in plugin.cmds.items()}
for cmd in plugin.cmds:
self.logger.debug('adding command {}'.format(cmd))
for lstnr in plugin.lstnrs:
self.logger.debug('adding listener {}'.format(lstnr))
def on_welcome(self, c, e):
if self.ns_pass:
self.logger.info('identifying with nickserv')
@ -142,7 +113,7 @@ class Bot(irc.bot.SingleServerIRCBot):
helpout = OrderedDict(sorted(cmds.items()))
for h in helpout:
self.connection.privmsg(nick, '{} -- {}'.format(h, helpout[h]))
time.sleep(.5)
time.sleep(.1)
self.connection.privmsg(nick, 'List of listeners: {}'.format(', '.join([l for l in plugin.lstnrs])))
return None
@ -164,7 +135,7 @@ class Bot(irc.bot.SingleServerIRCBot):
self.call_help(nick, op)
elif cmd == self.cmd_prefix + 'reload' and op:
self.logger.info('reloading plugins per request of {}'.format(nick))
self.load_plugins()
plugin.load_plugins(self.plugin_dir, use_prefix=self.use_prefix_for_plugins, cmd_prefix=self.cmd_prefix)
output = self.output_message('Plugins reloaded')
elif cmd == self.cmd_prefix + 'enable' and op:
if arg in plugin.plugins:
@ -308,7 +279,7 @@ class TwitchBot(Bot):
port = 6667
self.logger.info('Joining Twitch Server')
irc.bot.SingleServerIRCBot.__init__(self, [(server, port, 'oauth:'+token)], nickname, nickname)
self.load_plugins()
plugin.load_plugins(self.plugin_dir)
def on_welcome(self, c, e):
self.logger.info('requesting permissions')

View File

@ -1,5 +1,7 @@
from enum import Enum
from functools import wraps
import importlib
import os
from .log import logger
@ -23,6 +25,7 @@ class Output:
except AttributeError:
return msg
class _BasePlugin:
enabled = True
logger = logger
@ -39,6 +42,7 @@ class Listener(_BasePlugin):
self.name = name
if run:
self.run = run
self._add_listener()
def __str__(self):
return self.name
@ -46,7 +50,7 @@ class Listener(_BasePlugin):
def run(self):
pass
def add_listener(self):
def _add_listener(self):
lstnrs[self.name] = self
plugins[self.name] = self
@ -58,6 +62,7 @@ class Command(_BasePlugin):
self.ops = kwargs.get('ops', False)
self.ops_msg = kwargs.get('ops_msg', '')
self.run = kwargs.get('run', self.run)
self._add_command()
def __str__(self):
return self.cmd
@ -65,15 +70,15 @@ class Command(_BasePlugin):
def run(self, msg):
pass
def enable_ops(self, ops_msg):
def _enable_ops(self, ops_msg):
self.ops = True
self.ops_msg = ops_msg
def update_plugin(self, **kwargs):
def _update_plugin(self, **kwargs):
self.help_text = kwargs.get('help_text', 'N/A')
self.run = kwargs.get('run', self.run)
def add_command(self):
def _add_command(self):
cmds[self.cmd] = self
plugins[self.cmd] = self
@ -86,23 +91,60 @@ def message(msg):
def _add_command(command, help_text, func):
if command not in cmds:
Command(command, help_text=help_text, run=func).add_command()
Command(command, help_text=help_text, run=func)
else:
cmds[command].update_plugin(help_text=help_text, run=func)
cmds[command]._update_plugin(help_text=help_text, run=func)
def _ops_plugin(command, ops_msg, func):
if command not in cmds:
Command(command, ops=True, ops_msg=ops_msg).add_command()
Command(command, ops=True, ops_msg=ops_msg)
else:
cmds[command].enable_ops(ops_msg)
cmds[command]._enable_ops(ops_msg)
def _add_listener(name, func):
Listener(name, run=func).add_listener()
Listener(name, run=func)
def clear_plugins():
cmds.clear()
lstnrs.clear()
def load_plugins(plugin_dir, use_prefix=False, cmd_prefix='!'):
# i'm not sure why i need this but i do
global cmds
global plugins
global lstnrs
#check for all the disabled plugins so that we don't re-enable them
disabled_plugins = [i for i in plugins if not plugins[i].enabled]
logger.debug(disabled_plugins)
# clear plugin list to ensure no old plugins remain
logger.info('clearing plugin cache')
clear_plugins()
# ensure plugin folder exists
logger.info('checking plugin directory')
if not os.path.exists(plugin_dir):
logger.info('plugin directory {} not found, creating'.format(plugin_dir))
os.makedirs(plugin_dir)
# load all plugins
for m in os.listdir(plugin_dir):
if m.endswith('.py'):
try:
name = m[:-3]
logger.info('loading plugin {}'.format(name))
spec = importlib.machinery.PathFinder().find_spec(name, [plugin_dir])
spec.loader.load_module()
except Exception:
logger.exception('could not load plugin')
# gather all commands and listeners
if use_prefix: # use prefixes if needed
cmds = {cmd_prefix + k: v for k,v in cmds.items()}
for p in plugins:
if p in disabled_plugins:
plugins[p].disable()
for cmd in cmds:
logger.debug('adding command {}'.format(cmd))
for lstnr in lstnrs:
logger.debug('adding listener {}'.format(lstnr))
def command(command, help_text='N/A'):
@wraps(command)
def register_for_command(func):