]>
jfr.im git - erebus.git/blob - modlib.py
1 # Erebus IRC bot - Author: John Runyon
2 # module helper functions, see modules/modtest.py for usage
3 # This file is released into the public domain; see http://unlicense.org/
6 def __init__(self
, desc
):
9 return False #object will test to False
11 return '<modlib.error %r>' % self
.errormsg
13 return str(self
.errormsg
)
16 # default (global) access levels
24 # (channel) access levels
30 PUBLIC
= 0 #anyone (use glevel to control auth-needed)
33 WRONGARGS
= "Wrong number of arguments."
35 def __init__(self
, name
):
42 self
.name
= (name
.split("."))[-1]
44 def modstart(self
, parent
):
46 for cmd
, func
in self
.hooks
.iteritems():
47 self
.parent
.hook(cmd
, func
)
48 self
.parent
.hook("%s.%s" % (self
.name
, cmd
), func
)
49 for num
, func
in self
.numhooks
.iteritems():
50 self
.parent
.hooknum(num
, func
)
51 for chan
, func
in self
.chanhooks
.iteritems():
52 self
.parent
.hookchan(chan
, func
)
54 for func
, args
, kwargs
in self
.helps
:
56 self
.mod('help').reghelp(func
, *args
, **kwargs
)
60 def modstop(self
, parent
):
61 for cmd
, func
in self
.hooks
.iteritems():
62 self
.parent
.unhook(cmd
, func
)
63 self
.parent
.unhook("%s.%s" % (self
.name
, cmd
), func
)
64 for num
, func
in self
.numhooks
.iteritems():
65 self
.parent
.unhooknum(num
, func
)
66 for chan
, func
in self
.chanhooks
.iteritems():
67 self
.parent
.unhookchan(chan
, func
)
69 for func
, args
, kwargs
in self
.helps
:
71 self
.mod('help').dereghelp(func
, *args
, **kwargs
)
76 def hooknum(self
, num
):
78 self
.numhooks
[str(num
)] = func
79 if self
.parent
is not None:
80 self
.parent
.hooknum(str(num
), func
)
84 def hookchan(self
, chan
, glevel
=ANYONE
, clevel
=PUBLIC
):
86 self
.chanhooks
[chan
] = func
87 if self
.parent
is not None:
88 self
.parent
.hookchan(chan
, func
)
92 def hook(self
, cmd
=None, needchan
=True, glevel
=ANYONE
, clevel
=PUBLIC
):
93 _cmd
= cmd
#save this since it gets wiped out...
95 cmd
= _cmd
#...and restore it
97 cmd
= func
.__name
__ # default to function name
98 if isinstance(cmd
, basestring
):
101 func
.needchan
= needchan
102 func
.reqglevel
= glevel
103 func
.reqclevel
= clevel
108 if self
.parent
is not None:
109 self
.parent
.hook(c
, func
)
110 self
.parent
.hook("%s.%s" % (self
.name
, c
), func
)
114 def mod(self
, modname
):
115 if self
.parent
is not None:
116 return self
.parent
.module(modname
)
118 return error('unknown parent')
120 def argsEQ(self
, num
):
122 def checkargs(bot
, user
, chan
, realtarget
, *args
):
124 return func(bot
, user
, chan
, realtarget
, *args
)
126 bot
.msg(user
, self
.WRONGARGS
)
127 checkargs
.__name
__ = func
.__name
__
128 checkargs
.__module
__ = func
.__module
__
132 def argsGE(self
, num
):
134 def checkargs(bot
, user
, chan
, realtarget
, *args
):
136 return func(bot
, user
, chan
, realtarget
, *args
)
138 bot
.msg(user
, self
.WRONGARGS
)
139 checkargs
.__name
__ = func
.__name
__
140 checkargs
.__module
__ = func
.__module
__
144 def help(self
, *args
, **kwargs
):
145 """help(syntax, shorthelp, longhelp?, more lines longhelp?, cmd=...?)
147 help("<user> <pass>", "login")
148 ^ Help will only be one line. Command name determined based on function name.
149 help("<user> <level>", "add a user", cmd=("adduser", "useradd"))
150 ^ Help will be listed under ADDUSER; USERADD will say "alias for adduser"
151 help(None, "do stuff", "This command is really complicated.")
152 ^ Command takes no args. Short description (in overall HELP listing) is "do stuff".
153 Long description (HELP <command>) will say "<command> - do stuff", newline, "This command is really complicated."
156 if self
.parent
is not None:
158 self
.mod('help').reghelp(func
, *args
, **kwargs
)
161 self
.helps
.append((func
,args
,kwargs
))