src/modpython.py

   1 #!/usr/bin/python
   2
   3
   4 # TODO notes:
   5 #
   6 # - impliment handle_* functions for everything x3 has register fetaures for
   7 # - impliment script load/unload for user scripts.
   8 #       - load a script via this script.
   9 #       - script calls functions from here to set its functions up for calling on various actions
  10 # - provide helper functions for subscripts to save settings attached to users/chanels
  11 # - provide helper functions for scripts to do common things like msg a person or a channel,
  12 #   reply, etc.
  13
  14 import _svc
  15 import plugins
  16
  17 import math
  18
  19 import sys
  20
  21
  22 class irc:
  23     """Used to interact with the world of IRC from module scripts"""
  24
  25     # some defaults to make shorthand easy
  26     caller = ''
  27     target = ''
  28     service = ''
  29
  30     def __init__(self, service = None, caller = None, target = None):
  31         """ Constructor """
  32         self.caller = caller   #the person who sent the command/message
  33         self.service = service #the service who saw the message
  34         self.target = target   #the channel message was in (if public)
  35
  36     def send_target_privmsg(self, source, target, message):
  37         _svc.send_target_privmsg(source, target,  "%s "%(message))
  38
  39     def reply(self, message):
  40         """ Send a private reply to the user using convenience values"""
  41         #print "DEBUG: sending a message from %s to %s: %s"%(self.service, self.caller, message)
  42         if(len(self.target)):
  43             self.send_target_privmsg(self.service, self.target, "%s: %s"%(self.caller, message))
  44         else:
  45             self.send_target_privmsg(self.service, self.caller, message)
  46
  47 class handler:
  48     """ Main hub of python system. Handle callbacks from c. """
  49
  50     def __init__(self):
  51         #print "DEBUG: constructor for handler initing"
  52         self.plugins = plugins_(self)
  53         if(not self.plugins):
  54             print "DEBUG: unable to make self.plugins!?!"
  55         self.newplugins = plugins.load()
  56
  57     def init(self, irc): # not to be confused with __init__!
  58         """ This gets called once all the objects are up and running. Otherwise,
  59         were not done initing this own instance to be able to start calling it """
  60         #print "DEBUG: in handler.init()"
  61         self.plugins.init()
  62         return 0
  63
  64     def join(self, irc, channel, nick):
  65         #user = _svc.get_user(nick)
  66         #print "DEBUG: handler.join()"
  67         return self.plugins.callhandler("join", irc, [channel, nick], [channel, nick])
  68
  69     def server_link(self, server):
  70         for plugin in self.newplugins:
  71             if plugin.server_link(server):
  72                 return 1
  73         return 0
  74
  75     def new_user(self, irc, nick, ident, hostname, info):
  76         # we may filter on all the user fields, but we only pass the nick because
  77         # the plugin can get the rest itself
  78         return self.plugins.callhandler("new_user", irc, [nick, ident, hostname, info], [nick])
  79
  80     def nick_change(self, irc, nick, old_nick):
  81         return self.plugins.callhandler("nick_change", irc, [nick, old_nick], [nick, old_nick])
  82
  83     def cmd_run(self, irc, cmd):
  84         #print "DEBUG: handler.cmd_run: %s"%cmd
  85         eval(cmd)
  86         return 0
  87
  88     def addhook(self, event, method, filter=[None], data=None):
  89         self.plugins.addhook(event, method, filter, data)
  90         return 0
  91
  92     def addcommand(self, plugin, command, method):
  93         self.addhook("command", method, [plugin, command])
  94
  95     def cmd_command(self, irc, plugin, cmd, args):
  96         #print "DEBUG: handel.cmd_command; %s %s; args= %s"%(plugin, cmd, args)
  97         return self.plugins.callhandler("command", irc, [plugin, cmd], [args])
  98
  99     def load(self, irc, plugin):
 100         return self.plugins.load(plugin)
 101
 102 class plugins_:
 103     """Class to handle loading/unloading of plugins"""
 104     loaded_plugins = {}
 105     hooks = []
 106
 107     class hook:
 108         """ This is a request from a plugin to be called on an event """
 109         event = ""     # Event to be called on (eg "join")
 110         method = None  # Method to call
 111         filter = None  # Arguments to filter
 112         data = ""      # plugin-supplied data for plugin use
 113
 114         def __init__(self, event, method, filter, data):
 115             self.event = event
 116             self.method = method
 117             self.filter = filter
 118             self.data = data
 119
 120         def event_is(self, event, evdata):
 121             if(self.event == event):
 122                 for i in range(len(self.filter)):
 123                     if( self.filter[i] != None
 124                       and self.filter[i] != evdata[i]): # should be case insensitive? or how to compare?
 125                         #print "DEBUG: rejecting event, %s is not %s"%(self.filter[i], evdata[i])
 126                         return False
 127                 return True
 128             else:
 129                 return False
 130
 131         def trigger(self, irc, args):
 132             #print "DEBUG: Triggering %s event. with '%s' arguments."%(self.event, args)
 133             self.method(irc, *args)
 134
 135     def __init__(self, handler):
 136         """ Constructor """
 137         #print "DEBUG: constructor for plugins initing"
 138         self.handler = handler
 139
 140     def init(self):
 141         #print "DEBUG: in plugins.init()"
 142         self.load("annoy")
 143         self.load("hangman")
 144
 145     def addhook(self, event, method, filter=[None], data=None):
 146         #print "DEBUG: Adding hook for %s."%event
 147         self.hooks.append(self.hook(event, method, filter, data))
 148
 149     def findhooksforevent(self, event, data):
 150         ret = []
 151         #print "DEBUG: findhooksforevent() looking..."
 152         for hook in self.hooks:
 153             #print "DEBUG: looking at a %s hook..."%hook.event
 154             if(hook.event_is(event, data)):
 155                 ret.append(hook)
 156         return ret
 157
 158     def callhandler(self, event, irc, filter, args):
 159         for hook in self.findhooksforevent(event, filter):
 160             if(hook.trigger(irc, args)):
 161                 return 1
 162         return 0
 163
 164     def load(self, name):
 165         """ Loads a plugin by name """
 166         mod_name = "plugins.%s"%name
 167         need_reload = False
 168         if(sys.modules.has_key(mod_name)):
 169             need_reload = True
 170         #TODO: try to catch compile errors etc.
 171
 172         if(need_reload == False):
 173             __import__(mod_name)
 174         module = sys.modules[mod_name]
 175         if(need_reload == True):
 176             reload(module) # to ensure its read fresh
 177         Class = module.Class
 178         pluginObj = Class(self.handler, irc())
 179         self.loaded_plugins[mod_name] = pluginObj
 180         return True
 181