dr.botzo/modules/Help.py

"""
Help - handle !help commands by interrogating modules for help text
Copyright (C) 2011  Mike Bloy <mike@bloy.org>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
"""

import re
import sqlite3

from Module import Module

__author__ = "Mike Bloy <mike@bloy.org>"
__date__ = "2011-01-08"

class Help(Module):

    def __init__(self, irc, config, server):
        """
        Upon creation, determine the save file location
        """

        Module.__init__(self, irc, config, server)

        self.helpre = re.compile('^!help(\s+(\S+)(\s+(.+))?)?\s*$')

    def do(self, connection, event, nick, userhost, what, admin_unlocked):
        """look for karma strings at the start of messages"""

        match = self.helpre.search(what)
        if match:
            (module, key) = match.group(2,4)
            if (module == None):
                return self.handle_help_descriptions()
            elif (key == None):
                return self.handle_help_module(module)
            else:
                return self.handle_help_detail(module, key)

    def handle_help_descriptions(self):
        message = "General Help:\n"
        for module in self.irc.modlist:
            description = module.help_description()
            if description:
                message += "  %s - %s\n" % (module.__class__.__name__,
                                           description) 
        return message

    def handle_help_module(self, modname):
        module = self.find_module(modname)
        if module:
            helptext = module.help_summary()
            if helptext:
                return "%s - %s" % (modname, helptext)
            else:
                return "no help available for module %s" % (modname)
        else:
            return "no module named '%s' is loaded" % (modname)

    def handle_help_detail(self, modname, key):
        module = self.find_module(modname)
        if module:
            helptext = module.help_detail(key)
            if helptext:
                return "%s (%s) - %s" % (modname, key, helptext)
            else:
                return "no help available for module '%s', command '%s'" % (modname, key)
        else:
            return "no module named '%s' is loaded" % (modname)
            
        return "asked for help on module %s detail %s" % (modname, key)

    def find_module(self, modname):
        for module in self.irc.modlist:
            if modname == module.__class__.__name__:
                return module
        return None

if __name__ == "__main__":
    print "Hello World"

# vi:tabstop=4:expandtab:autoindent