Made making modules that rely on certain capabilities being preset much easier to to write (CapabilityChecker)

src/privmsgs.py

@@ -105,7 +105,12 @@ def getKeywordArgs(irc, msg, d=None):
     return (args, d)
             
 
-            
+class CapabilityChecker(callbacks.Privmsg):
+    def callCommand(self, f, irc, msg, args):
+        if ircdb.checkCapability(msg.prefix, self.capability):
+            callbacks.Privmsg.callCommand(self, f, irc, msg, args)
+        else:
+            irc.error(msg, conf.replyNoCapability % self.capability)
     
 ###
 # Privmsg Callbacks.
@@ -124,7 +129,6 @@ class ChannelCommands(callbacks.Privmsg):
             irc.queueMsg(ircmsgs.op(channel, msg.nick))
         else:
             irc.error(msg, conf.replyNoCapability % capability)
-            return
 
     def halfop(self, irc, msg, args):
         """[<channel>]
@@ -139,7 +143,6 @@ class ChannelCommands(callbacks.Privmsg):
             irc.queueMsg(ircmsgs.halfop(channel, msg.nick))
         else:
             irc.error(msg, conf.replyNoCapability % capability)
-            return
 
     def voice(self, irc, msg, args):
         """[<channel>]
@@ -154,7 +157,6 @@ class ChannelCommands(callbacks.Privmsg):
             irc.queueMsg(ircmsgs.halfop(channel, msg.nick))
         else:
             irc.error(msg, conf.replyNoCapability % capability)
-            return
 
     def cycle(self, irc, msg, args):
         """[<channel>]
@@ -170,7 +172,6 @@ class ChannelCommands(callbacks.Privmsg):
             irc.queueMsg(ircmsgs.join(channel))
         else:
             irc.error(msg, conf.replyNoCapability % capability)
-            return
 
     def kban(self, irc, msg, args):
         """[<channel>] <nick> [<number of seconds to ban>]
@@ -197,7 +198,6 @@ class ChannelCommands(callbacks.Privmsg):
                 schedule.addEvent(f, time.time() + length)
         else:
             irc.error(msg, conf.replyNoCapability % capability)
-            return
 
     def lobotomize(self, irc, msg, args):
         """[<channel>]
@@ -212,10 +212,8 @@ class ChannelCommands(callbacks.Privmsg):
         if ircdb.checkCapability(msg.prefix, capability):
             ircdb.channels.getChannel(channel).lobotomized = True
             irc.reply(msg, conf.replySuccess)
-            return
         else:
             irc.error(msg, conf.replyNoCapability % capability)
-            return
 
     def unlobotomize(self, irc, msg, args):
         """[<channel>]
@@ -230,10 +228,8 @@ class ChannelCommands(callbacks.Privmsg):
         if ircdb.checkCapability(msg.prefix, capability):
             ircdb.channels.getChannel(channel).lobotomized = False
             irc.reply(msg, conf.replySuccess)
-            return
         else:
             irc.error(msg, conf.replyNoCapability % capability)
-            return
 
     def permban(self, irc, msg, args):
         """[<channel>] <nick|hostmask>
@@ -255,10 +251,8 @@ class ChannelCommands(callbacks.Privmsg):
             c.addBan(banmask)
             ircdb.channels.setChannel(channel, c)
             irc.reply(msg, conf.replySuccess)
-            return
         else:
             irc.error(msg, conf.replyNoCapability % capability)
-            return
 
     def unpermban(self, irc, msg, args):
         """[<channel>] <hostmask>
@@ -275,10 +269,8 @@ class ChannelCommands(callbacks.Privmsg):
             c.removeBan(banmask)
             ircdb.channels.setChannel(channel, c)
             irc.reply(msg, conf.replySuccess)
-            return
         else:
             irc.error(msg, conf.replyNoCapability % capability)
-            return
 
     def chanignore(self, irc, msg, args):
         """[<channel>] <nick|hostmask>
@@ -300,10 +292,8 @@ class ChannelCommands(callbacks.Privmsg):
             c.addIgnore(banmask)
             ircdb.channels.setChannel(channel, c)
             irc.reply(msg, conf.replySuccess)
-            return
         else:
             irc.error(msg, conf.replyNoCapability % capability)
-            return
 
     def unchanignore(self, irc, msg, args):
         """[<channel>] <hostmask>
@@ -320,10 +310,8 @@ class ChannelCommands(callbacks.Privmsg):
             c.removeIgnore(banmask)
             ircdb.channels.setChannel(channel, c)
             irc.reply(msg, conf.replySuccess)
-            return
         else:
             irc.error(msg, conf.replyNoCapability % capability)
-            return
 
     def addchancapability(self, irc, msg, args):
         """[<channel>] <name|hostmask> <capability>
@@ -343,13 +331,10 @@ class ChannelCommands(callbacks.Privmsg):
                 u.addCapability(capability)
                 ircdb.users.setUser(name, u)
                 irc.reply(msg, conf.replySuccess)
-                return
             except KeyError:
                 irc.error(msg, conf.replyNoUser)
-                return
         else:
             irc.error(msg, conf.replyNoCapability % neededcapability)
-            return
 
     def removechancapability(self, irc, msg, args):
         """[<channel>] <name|hostmask> <capability>
@@ -423,14 +408,11 @@ class ChannelCommands(callbacks.Privmsg):
                 c.addCapability(capability, value)
                 ircdb.channels.setChannel(channel, c)
                 irc.reply(msg, conf.replySuccess)
-                return
             else:
                 s = 'Value of the capability must be True or False'
                 irc.error(msg, s)
-                return
         else:
             irc.error(msg, conf.replyNoCapability % neededcapability)
-            return
 
     def unsetchancapability(self, irc, msg, args):
         """[<chanel>] <capability>
@@ -449,37 +431,28 @@ class ChannelCommands(callbacks.Privmsg):
             c.removeCapability(capability)
             ircdb.channels.setChannel(channel, c)
             irc.reply(msg, conf.replySuccess)
-            return
         else:
             irc.error(msg, conf.replyNoCapability % neededcapability)
-            return
 
 
-class AdminCommands(callbacks.Privmsg):
+class AdminCommands(CapabilityChecker):
+    capability = 'admin'
     def join(self, irc, msg, args):
         """<channel> [<channel> ...]
 
         Tell the bot to join the whitespace-separated list of channels
         you give it.
         """
-        if ircdb.checkCapability(msg.prefix, 'admin'):
         irc.queueMsg(ircmsgs.joins(args))
         for channel in args:
             irc.queueMsg(ircmsgs.who(channel))
-        else:
-            irc.error(msg, conf.replyNoCapability % 'admin')
-            return
 
     def nick(self, irc, msg, args):
         """<nick>
 
         Changes the bot's nick to <nick>."""
         nick = getArgs(args)
-        if ircdb.checkCapability(msg.prefix, 'admin'):
         irc.queueMsg(ircmsgs.nick(nick))
-        else:
-            irc.error(msg, conf.replyNoCapability % 'admin')
-            return
 
     def part(self, irc, msg, args):
         """<channel> [<channel> ...]
@@ -487,11 +460,7 @@ class AdminCommands(callbacks.Privmsg):
         Tells the bot to part the whitespace-separated list of channels
         you give it.
         """
-        if ircdb.checkCapability(msg.prefix, 'admin'):
         irc.queueMsg(ircmsgs.parts(args, msg.nick))
-        else:
-            irc.error(msg, conf.replyNoCapability % 'admin')
-            return
 
     def disable(self, irc, msg, args):
         """<command>
@@ -499,7 +468,6 @@ class AdminCommands(callbacks.Privmsg):
         Disables the command <command> for all non-owner users.
         """
         command = getArgs(args)
-        if ircdb.checkCapability(msg.prefix, 'admin'):
         if command in ('enable', 'identify'):
             irc.error(msg, 'You can\'t disable %s!' % command)
         else:
@@ -510,10 +478,6 @@ class AdminCommands(callbacks.Privmsg):
             capability = ircdb.makeAntiCapability(command)
             conf.defaultCapabilities.add(capability)
             irc.reply(msg, conf.replySuccess)
-                return
-        else:
-            irc.error(msg, conf.replyNoCapability % 'admin')
-            return
 
     def enable(self, irc, msg, args):
         """<command>
@@ -522,17 +486,11 @@ class AdminCommands(callbacks.Privmsg):
         """
         command = getArgs(args)
         anticapability = ircdb.makeAntiCapability(command)
-        if ircdb.checkCapability(msg.prefix, 'admin'):
         if anticapability in conf.defaultCapabilities:
             conf.defaultCapabilities.remove(anticapability)
             irc.reply(msg, conf.replySuccess)
-                return
         else:
             irc.error(msg, 'That command wasn\'t disabled.')
-                return
-        else:
-            irc.error(msg, conf.replyNoCapability % 'admin')
-            return
 
     def addcapability(self, irc, msg, args):
         """<name|hostmask> <capability>
@@ -541,7 +499,6 @@ class AdminCommands(callbacks.Privmsg):
         currently maps) the specified capability <capability>
         """
         (name, capability) = getArgs(args, 2)
-        if ircdb.checkCapability(msg.prefix, 'admin'):
         # This next check to make sure 'admin's can't hand out 'owner'.
         if ircdb.checkCapability(msg.prefix, capability) or \
            '!' in capability:
@@ -550,17 +507,11 @@ class AdminCommands(callbacks.Privmsg):
                 u.addCapability(capability)
                 ircdb.users.setUser(name, u)
                 irc.reply(msg, conf.replySuccess)
-                    return
             except KeyError:
                 irc.error(msg, conf.replyNoUser)
-                    return
         else:
             s = 'You can\'t add capabilities you don\'t have.'
             irc.error(msg, s)
-               return
-        else:
-            irc.error(msg, conf.replyNoCapability % 'admin')
-            return
 
     def removecapability(self, irc, msg, args):
         """<name|hostmask> <capability>
@@ -569,7 +520,6 @@ class AdminCommands(callbacks.Privmsg):
         <hostmask> currently maps) the specified capability <capability>
         """
         (name, capability) = getArgs(args, 2)
-        if ircdb.checkCapability(msg.prefix, 'admin'):
         if ircdb.checkCapability(msg.prefix, capability) or \
            '!' in capability:
             try:
@@ -582,8 +532,6 @@ class AdminCommands(callbacks.Privmsg):
         else:
             s = 'You can\'t remove capabilities you don\'t have.'
             irc.error(msg, s)
-        else:
-            irc.error(msg, conf.replyNoCapability % 'admin')
 
     def setprefixchar(self, irc, msg, args):
         """<prefixchars>
@@ -591,26 +539,21 @@ class AdminCommands(callbacks.Privmsg):
         Sets the prefix chars by which the bot can be addressed.
         """
         s = getArgs(args)
-        if ircdb.checkCapability(msg.prefix, 'admin'):
         if s.translate(string.ascii, string.ascii_letters) == '':
             irc.error(msg, 'Prefixes cannot contain letters.')
         else:
             conf.prefixChars = s
             irc.reply(msg, conf.replySuccess)
-        else:
-            irc.error(msg, conf.replyNoCapability % 'admin')
 
 
-class OwnerCommands(callbacks.Privmsg):
+class OwnerCommands(CapabilityChecker):
+    capability = 'owner'
     def __init__(self):
         callbacks.Privmsg.__init__(self)
-        setattr(self.__class__, 'eval', self._eval)
-        #setattr(self.__class__, 'import', self._import)
         setattr(self.__class__, 'exec', self._exec)
 
-    def _eval(self, irc, msg, args):
+    def eval(self, irc, msg, args):
         """<string to be evaluated by the Python interpreter>"""
-        if ircdb.checkCapability(msg.prefix, 'owner'):
         if conf.allowEval:
             s = getArgs(args)
             try:
@@ -619,8 +562,6 @@ class OwnerCommands(callbacks.Privmsg):
                 irc.reply(msg, debug.exnToString(e))
         else:
             irc.error(msg, conf.replyEvalNotAllowed)
-        else:
-            irc.error(msg, conf.replyNoCapability % 'owner')
 
     '''
     def _import(self, irc, msg, args):
@@ -642,7 +583,6 @@ class OwnerCommands(callbacks.Privmsg):
 
     def _exec(self, irc, msg, args):
         """<code to exec>"""
-        if ircdb.checkCapability(msg.prefix, 'owner'):
         if conf.allowEval:
             s = getArgs(args)
             try:
@@ -652,32 +592,24 @@ class OwnerCommands(callbacks.Privmsg):
                 irc.reply(msg, debug.exnToString(e))
         else:
             irc.error(msg, conf.replyEvalNotAllowed)
-        else:
-            irc.error(msg, conf.replyNoCapability % 'owner')
 
     def setdefaultcapability(self, irc, msg, args):
         """<capability>
 
         Sets the default capability to be allowed for any command.
         """
-        if ircdb.checkCapability(msg.prefix, 'owner'):
         capability = getArgs(args)
         conf.defaultCapabilities[capability] = True
         irc.reply(msg, conf.replySuccess)
-        else:
-            irc.error(msg, conf.replyNoCapability % 'owner')
 
     def unsetdefaultcapability(self, irc, msg, args):
         """<capability>
 
         Unsets the default capability for any command.
         """
-        if ircdb.checkCapability(msg.prefix, 'owner'):
         capability = getArgs(args)
         del conf.defaultCapabilities[capability]
         irc.reply(msg, conf.replySuccess)
-        else:
-            irc.error(msg, conf.replyNoCapability % 'owner')
 
     def settrace(self, irc, msg, args):
         """takes no arguments
@@ -685,28 +617,21 @@ class OwnerCommands(callbacks.Privmsg):
         Starts the function-tracing debug mode; beware that this makes *huge*
         logfiles.
         """
-        if ircdb.checkCapability(msg.prefix, 'owner'):
         sys.settrace(debug.tracer)
         irc.reply(msg, conf.replySuccess)
-        else:
-            irc.error(msg, conf.replyNoCapability % 'owner')
 
     def unsettrace(self, irc, msg, args):
         """takes no arguments
 
         Stops the function-tracing debug mode."""
-        if ircdb.checkCapability(msg.prefix, 'owner'):
         sys.settrace(None)
         irc.reply(msg, conf.replySuccess)
-        else:
-            irc.error(msg, conf.replyNoCapability % 'owner')
 
     def ircquote(self, irc, msg, args):
         """<string to be sent to the server>
 
         Sends the raw string given to the server.
         """
-        if ircdb.checkCapability(msg.prefix, 'owner'):
         s = getArgs(args)
         try:
             m = ircmsgs.IrcMsg(s)
@@ -714,15 +639,12 @@ class OwnerCommands(callbacks.Privmsg):
         except Exception:
             debug.recoverableException()
             irc.error(msg, conf.replyError)
-        else:
-            irc.error(msg, conf.replyNoCapability % 'owner')
 
     def quit(self, irc, msg, args):
         """[<int return value>]
 
         Exits the program with the given return value (the default is 0)
         """
-        if ircdb.checkCapability(msg.prefix, 'owner'):
         try:
             i = int(args[0])
         except (ValueError, IndexError):
@@ -732,19 +654,14 @@ class OwnerCommands(callbacks.Privmsg):
         for irc in world.ircs:
             irc.die()
         debug.exit(i)
-        else:
-            irc.error(msg, conf.replyNoCapability % 'owner')
 
     def flush(self, irc, msg, args):
         """takes no arguments
 
         Runs all the periodic flushers in world.flushers.
         """
-        if ircdb.checkCapability(msg.prefix, 'owner'):
         world.flush()
         irc.reply(msg, conf.replySuccess)
-        else:
-            irc.error(msg, conf.replyNoCapability % 'owner')
             
     '''
     def reload(self, irc, msg, args):
@@ -759,7 +676,6 @@ class OwnerCommands(callbacks.Privmsg):
                         except Exception, e:
                             m = '%s: %s' % (name, debug.exnToString(e))
                             irc.reply(msg, m)
-                            return
             else:
                 try:
                     module = sys.modules[module]
@@ -768,10 +684,8 @@ class OwnerCommands(callbacks.Privmsg):
                     return
                 world.superReload(module)
             irc.reply(msg, conf.replySuccess)
-            return
         else:
             irc.error(msg, conf.replyNoCapability % 'owner')
-            return
     '''
 
     def set(self, irc, msg, args):
@@ -781,39 +695,27 @@ class OwnerCommands(callbacks.Privmsg):
         include "noflush" which, if set to true value, will prevent the
         periodic flushing that normally occurs.
         """
-        if ircdb.checkCapability(msg.prefix, 'owner'):
         (name, value) = getArgs(args, optional=1)
         world.tempvars[name] = value
         irc.reply(msg, conf.replySuccess)
-            return
-        else:
-            irc.error(msg, conf.replyNoCapability % 'owner')
-            return
 
     def unset(self, irc, msg, args):
         """<name>
 
         Unsets the value of variables set via the 'set' command.
         """
-        if ircdb.checkCapability(msg.prefix, 'owner'):
         name = getArgs(args)
         try:
             del world.tempvars[name]
+            irc.reply(msg, conf.replySuccess)
         except KeyError:
             irc.error(msg, 'That variable wasn\'t set.')
-                return
-            irc.reply(msg, conf.replySuccess)
-            return
-        else:
-            irc.error(msg, conf.replyNoCapability % 'owner')
-            return
 
     def load(self, irc, msg, args):
         """<plugin>
 
         Loads the plugin <plugin> from the plugins/ directory.
         """
-        if ircdb.checkCapability(msg.prefix, 'owner'):
         plugin = getArgs(args)
         try:
             moduleInfo = imp.find_module(plugin)
@@ -824,9 +726,6 @@ class OwnerCommands(callbacks.Privmsg):
         callback = module.Class()
         irc.addCallback(callback)
         irc.reply(msg, conf.replySuccess)
-        else:
-            irc.error(msg, conf.replyNoCapability % 'owner')
-            return
 
     def unload(self, irc, msg, args):
         """<callback name>
@@ -834,7 +733,6 @@ class OwnerCommands(callbacks.Privmsg):
         Unloads the callback by name; use the 'list' command to see a list
         of the currently loaded callbacks.
         """
-        if ircdb.checkCapability(msg.prefix, 'owner'):
         name = getArgs(args)
         numCallbacks = len(irc.callbacks)
         callbacks = irc.removeCallback(name)
@@ -844,8 +742,6 @@ class OwnerCommands(callbacks.Privmsg):
             irc.reply(msg, conf.replySuccess)
         else:
             irc.error(msg, 'There was no callback %s' % name)
-        else:
-            irc.error(msg, conf.replyNoCapability % 'owner')
 
 
 class UserCommands(callbacks.Privmsg):
@@ -972,10 +868,9 @@ class UserCommands(callbacks.Privmsg):
             name = getArgs(args)
         try:
             user = ircdb.users.getUser(name)
+            irc.reply(msg, repr(user.hostmasks))
         except KeyError:
             irc.error(msg, conf.replyNoUser)
-            return
-        irc.reply(msg, repr(user.hostmasks))
 
     def capabilities(self, irc, msg, args):
         """[<name>]
@@ -993,10 +888,9 @@ class UserCommands(callbacks.Privmsg):
             name = getArgs(args)
         try:
             user = ircdb.users.getUser(name)
+            irc.reply(msg, '[%s]' % ', '.join(user.capabilities))
         except KeyError:
             irc.error(msg, conf.replyNoUser)
-            return
-        irc.reply(msg, '[%s]' % ', '.join(user.capabilities))
 
     def identify(self, irc, msg, args):
         """<name> <password>
@@ -1014,10 +908,8 @@ class UserCommands(callbacks.Privmsg):
             u.setAuth(msg.prefix)
             ircdb.users.setUser(name, u)
             irc.reply(msg, conf.replySuccess)
-            return
         else:
             irc.error(msg, conf.replyIncorrectAuth)
-            return
 
     def unidentify(self, irc, msg, args):
         """takes no arguments
@@ -1169,4 +1061,5 @@ standardPrivmsgModules = (OwnerCommands,
                           ChannelCommands,
                           UserCommands,
                           MiscCommands)
+
 # vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: