major rewrite to python3

README.md

@@ -80,7 +80,12 @@ Todo.
 * Add logfile entry containing current online users in the irc-channel
 
 
-v0.2.x (latest) 
+v0.3.0 (2015-04-24) 
+
+* Major rewrite to python3 and separating code into modules.
+
+
+v0.2.2 (2015-04-24) 
 
 * Fixed loggin of ACTION.
 * Logging as utf-8 to logfile in json format.

main.py

@@ -0,0 +1,179 @@
+#! /usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""
+An IRC bot that answers random questions, keeps a log from the IRC-chat, easy to integrate in a webpage and montores a phpBB forum for latest topics by loggin in to the forum and checking the RSS-feed.
+
+You need to install additional modules.
+
+# Install needed modules in local directory
+pip3 install --target modules/ feedparser
+pip3 install --target modules/ beautifulsoup4
+
+You start the program like this, including the path to the locally installed modules.
+
+# Run
+PYTHONPATH=modules marvin
+
+# To get help
+PYTHONPATH=modules marvin --help
+
+# Example
+PYTHONPATH=modules python3 main.py --server=irc.bsnet.se --channel=#db-o-webb
+PYTHONPATH=modules python3 main.py --server=irc.bsnet.se --port=6667 --channel=#db-o-webb --nick=marvin --ident=secret
+
+"""
+
+
+import sys
+import getopt
+import os
+import json
+import marvin
+import marvin_actions
+
+
+#
+# General stuff about this program
+#
+PROGRAM = "marvin"
+AUTHOR = "Mikael Roos"
+EMAIL = "[email protected]"
+VERSION = "0.3.0"
+MSG_USAGE = """{program} - Act as an IRC bot and do useful things. By {author} ({email}), version {version}.
+
+Usage:
+  {program} [options]
+  
+Options:
+  -h --help     Display this help message.
+  -v --version  Print version and exit.
+
+GitHub: https://github.com/mosbth/irc2phpbb
+Issues: https://github.com/mosbth/irc2phpbb/issues
+""".format(program=PROGRAM, author=AUTHOR, email=EMAIL, version=VERSION)
+MSG_VERSION = "{program} version {version}.".format(program=PROGRAM, version=VERSION)
+MSG_USAGE_SHORT = "Use {program} --help to get usage.\n".format(program=PROGRAM)
+
+
+def printUsage(exitStatus):
+    """
+    Print usage information about the script and exit.
+    """
+    print(MSG_USAGE)
+    sys.exit(exitStatus)
+
+
+def printVersion():
+    """
+    Print version information and exit.
+    """
+    print(MSG_VERSION)
+    sys.exit(0)
+
+
+def mergeOptionsWithConfigFile(options, configFile):
+    """
+    Read information from config file.
+    """
+    if os.path.isfile(configFile):
+        with open(configFile) as f:
+            data = json.load(f)
+
+        options.update(data)
+        res = json.dumps(options, sort_keys=True, indent=4, separators=(',', ': '))
+
+        print("Read configuration from config file '{file}'. Current configuration is:\n{config}".format(config=res, file=configFile))
+
+    else:
+        print("Config file '{file}' is not readable, skipping.".format(file=configFile))
+
+    return options
+
+
+def parseOptions():
+    """
+    Merge default options with incoming options and arguments and return them as a dictionary.
+    """
+
+    # Default options to start with
+    options = marvin.getConfig()
+
+    # Read from config file if available
+    options.update(mergeOptionsWithConfigFile(options, "marvin_config.json"))
+
+    # Switch through all options, commandline options overwrites.
+    try:
+        opts, args = getopt.getopt(sys.argv[1:], "hv", [
+            "help",
+            "version",
+            "config=",
+            "server=",
+            "port=",
+            "channel=",
+            "nick=",
+            "realname=",
+            "ident="
+        ])
+
+        for opt, arg in opts:
+            if opt in ("-h", "--help"):
+                printUsage(0)
+
+            elif opt in ("-v", "--version"):
+                printVersion()
+
+            elif opt in ("--config"):
+                options = mergeOptionsWithConfigFile(options, arg)
+
+            elif opt in ("--server"):
+                options["server"] = arg
+
+            elif opt in ("--port"):
+                options["port"] = arg
+
+            elif opt in ("--channel"):
+                options["channel"] = arg
+
+            elif opt in ("--nick"):
+                options["nick"] = arg
+
+            elif opt in ("--realname"):
+                options["realname"] = arg
+
+            elif opt in ("--ident"):
+                options["ident"] = arg
+
+            else:
+                assert False, "Unhandled option"
+
+        if len(args):
+            assert False, "To many arguments, unknown argument."
+
+    except Exception as err:
+        print(err)
+        print(MSG_USAGE_SHORT)
+        sys.exit(1)
+
+    res = json.dumps(options, sort_keys=True, indent=4, separators=(',', ': '))
+    print("Configuration updated after cli options:\n{config}".format(config=res))
+
+    return options
+
+
+def main():
+    """
+    Main function to carry out the work.
+    """
+    options = parseOptions()
+    marvin.setConfig(options)
+    actions = marvin_actions.getAllActions()
+    marvin.registerActions(actions)
+    marvin.connectToServer()
+    marvin.mainLoop()
+
+    sys.exit(0)
+
+
+if __name__ == "__main__":
+    main()