### This file is part of KoFooBot and is licensed under BSD-license according to the   ###

### LICENSE file in the base directory.                                                ###

### Code in this file is contributed by:                                               ###

###    Krister Svanlund <krister.svanlund gmail.com>                                   ###

import irclib

import re

do_help_command = {'description': "Display this help or help for specific commands",

                   'arguments': [("", "Display general help and list commands availible to your level."),

                                 ("<command>", "Display help for a specific command."),

                                 ("commands", "Display a list of commands without description."),

                                 ("alias", "List all aliases currently inplace."),

                                 ("modules", "List all modules that are loaded and that can be loaded.")],

                   'public': False,

                   'level': 0}

def do_help(self, server, sender, target, args):

    print "Show help to %s." % irclib.nm_to_n(sender)

    sender_level = self.get_level(sender)

    if args:

        for command in args:

            m = re.match(r'level=([0-9]+)', command)

            if m:

                args.remove(m.group(0))

                try: sender_level = min(int(m.group(1)), sender_level)

                except: sender_level = 0

                print " + Showing help for level %d." % sender_level

    if args:

        for command in args:

            do_help_for(self, server, sender, target, command, sender_level)

    else:

        do_general_help(self, server, sender, target, sender_level)

    return True

def do_help_for(self, server, sender, target, command_name, sender_level):

    print "%s wants help for '%s'." % (irclib.nm_to_n(sender), command_name)

    if command_name in self.globals.bot_commands:

        command = self.globals.bot_commands[command_name]

        command_level = command.get('level', 0)

        command_description = command.get('long help', "")

        command_arguments = command.get('arguments', [])

        help_string = "Help for command \x02{0}\x02\n".format(command_name)

        if sender_level < command_level:

            self.respond(server, sender, target, "You are not allowed to use this command.")

            return

        if not type(command_arguments) is list:

            command_arguments = [command_arguments]

        if len(command_arguments) > 0:

            width = []

            for argument in command_arguments:

                if type(argument) is not tuple:

                    width.append(len(argument))

                else:

                    width.append(len(argument[0]))

            if width: width = max(width)

            else: width = 0

            for argument in command_arguments:

                if type(argument) is tuple:

                    help_string += " \x02Syntax:\x02 {0:{2}}  -  {1}\n".format(command_name+' '+argument[0], argument[1], width)

                else:

                    help_string += " \x02Syntax:\x02 {0} {1}\n".format(command_name, argument)

        else:

            help_string += " \x02Syntax:\x02 {0}\n".format(command_name)

        if command_description:

            help_string += " \x02Description:\x02 {0}\n".format(command_description)

        if command_level:

            help_string += " \x02Minimum level:\x02 {0}\n".format(command_level)

        self.respond(server, sender, target, help_string)

    elif command_name == 'alias':

        help_string = "Aliases defined at this point is\n"

        for alias, command in self.globals.bot_command_alias.iteritems():

            help_string += " \x02{0}\x02 -> {1}\n".format(alias, command)

        help_string += "End of alias list."

        self.respond(server, sender, target, help_string)

    elif command_name == 'modules':

        help_string = "The following modules are currently loaded: %s" % ", ".join(self.module_list)

        help_string += "\nThe following modules can be loaded: %s" % ", ".join([m for m in self.found_modules if m not in self.module_list])

        self.respond(server, sender, target, help_string)

    elif command_name == 'commands':

        commands = []

        for command_name, command in self.globals.bot_commands.iteritems():

            command_level = command.get('level', 0)

            if sender_level >= command_level:

                commands.append(command_name)

        help_string = "The following commands are available: %s" % ", ".join(commands)

        self.respond(server, sender, target, help_string)

    else:

        self.respond(server, sender, target, "There is no \x02%s\x02 command." % command_name)

def get_first(tos):

    if type(tos) is tuple or type(tos) is list:

        return tos[0]

    else:

        return tos

def do_general_help(self, server, sender, target, sender_level):

    help_string = "The commands availible are:\n"

    width = []

    print " + Figure out width."

    for cn, c in self.globals.bot_commands.iteritems():

        alw = []

        al = c.get('arguments', ())

        if type(al) is not list: al = [al]

        for a in al:

            if a:

                if type(a) is not tuple: a = (a, "")

                alw.append(len(a[0]))

        if alw: width.append(len(cn)+max(alw)+3)

        else: width.append(len(cn))

    if width: width = max(width)

    else: width = 0

    print "  + Width is %d." % width

    for command_name, command in self.globals.bot_commands.iteritems():

        command_arguments = command.get('arguments', "")

        if not type(command_arguments) is list:

            command_arguments = [command_arguments]

        for argument in command_arguments:

            command_level = command.get('level', 0)

            if type(argument) is tuple:

                command_description = argument[1]

                argument = argument[0]

            else:

                command_description = command.get('description', "")

            if command_description == "":

                continue

            command_public = command.get('public', False)

            if sender_level >= command_level:

                # Ex: *name arguments             description (>level)

                #     ^ ^       ^                                 ^-Minimum level to use command

                #     | |       |-Arguments for command

                #     | |-Command name

                #     |-Public command indicator

                help_string += "{public}{namearg:{width}} - {description} {level}\n".format(\

                    width = width,

                    public = (' ', '*')[command_public],

                    namearg = "\x02{0}\x02 {1}".format(command_name, argument),

                    description = command_description,

                    level = ('(>'+str(command_level)+')', '')[command_level is 0])

    help_string += "To see help for specific commands use \x02help command\x02."

    self.respond(server, sender, target, help_string)