import irclib

import time

### These settings will be added to the bot settings prefixed with the module name,  ###

### for example the following will add the setting 'test_example' and it will be set ###

### to "Default value" if it doesn't exist in the settings since before.             ###

test_settings = { 'example': "Default value" }

### A list with module names which this module requires. ###

test_requires = []

### A list with functions in this module to be added to the bot as a helper while    ###

### this module is loaded.                                                           ###

test_helpers = ['a_simple_helper']

### A command struct with all the variables used. ###

### command1 has to be a function in the module.  ###

do_command1_command = {'description': "A short description",

                       'long help': "The long help for this command. Should contain everything the user needs to know.",

                       'arguments': [("argument1 <required> [optional]",  "This is an optional argument specific help string"),

                                     "argument2 [<optional variable>]"],

                       'public': True,

                       'level': 0}

### An alias is a simple system for expanding shorter strings into longer string or set ###

### of strings. The replacement is straightforward and occurs before any other parsing. ###

test_alias = {'c1': 'command1 argument1',

              'c':  'command1'}

### Time between calling update function in seconds. ###

update_test_delay = 60

update_test_time_left = 0

def init_test(bot, server, sender = None):

    """Do things to initate the module and return True if

       successfull otherwise False."""

    print " + Initiate Test module."

    return True

def unload_test(bot, server, sender = None):

    """Do something on unloading the module."""

    print " + Unload Test module."

    return True

def update_test(bot, server):

    """Do this every iteration in the main-loop."""

    print " * [%s] Update." % time.strftime('%H:%M:%S')

def test_join_part_handler(bot, server, channel, join):

    """Do this on joining or parting from a channel."""

    if join:

        print " + Joined channel '%s'." % channel

    else:

        print " + Parted channel '%s'." % channel

def test_public_msg_handler(bot, server, sender, target, msg, action = False):

    """Do this on public messages from channels."""

    print " + Got public message from '%s' to '%s': %s" % (irclib.nm_to_n(sender), target, msg)

def test_private_msg_handler(bot, server, sender, msg, action = False):

    """Do this on private messages from sender."""

    print " + Got private message from '%s': %s" % (irclib.nm_to_n(sender), msg)

def test_public_notice_handler(bot, server, sender, target, msg):

    """Do this on private notice from sender."""

    print " + Got public notice from '%s' to '%s': %s" % (irclib.nm_to_n(sender), target, msg)

def test_private_notice_handler(bot, server, sender, msg):

    """Do this on private notice from sender."""

    print " + Got private notice from '%s': %s" % (irclib.nm_to_n(sender), msg)

def test_ctcp_handler(bot, server, sender, msg):

    """Do this on ctcp request from sender."""

    print " + CTCP from '%s': %s" % (irclib.nm_to_n(sender), msg)

def do_command1(bot, server, sender, target, args):

    """For this command to be callable the do_command1_command

       dictionary has to be defined.

       Arguments:

         bot    - The bot object

         server - The server object

         sender - The one issuing the command

         target - To who the command is issued, either a

                  channel or the bot nickname.

         args   - A list of arguments to the command."""

    print "----- Test Command -----"

def a_simple_helper(the, args, you, want):

    """This function has no specific syntax it will just get added to the bot as a helper."""

    print "----- This will help you -----"