spawner.py

#!/usr/bin/env python
# Copyright (C) 2012 Buttinsky Developers.
# See 'COPYING' for copying permission.

from gevent.monkey import patch_all
patch_all()

import json
import os
import sys
from functools import partial

from gevent import queue

from event_loops import gevent_client
from configobj import ConfigObj

from protocols import irc, http
from behaviors import simple_response, address_check, custom_irc_protocol
from modules import reporter_handler
from stack import Layer

import gevent.pool
group = gevent.pool.Group()
#TODO : hpfeeds import to be removed when report_handler is ready
import modules.reporting.hpfeeds_logger as hpfeeds
import modules.sources.hpfeeds_sink as hpfeeds_sink

from SimpleXMLRPCServer import SimpleXMLRPCServer


def singleton(cls):
    instances = {}

    def getinstance():
        if cls not in instances:
            instances[cls] = cls()
        return instances[cls]
    return getinstance


@singleton
class MonitorList(object):

    def __init__(self):
        self.__stackList = {}
        self.__settingList = {}
        self.__fileList = {}

    def addStack(self, identifier, stack):
        self.__stackList[identifier] = stack

    def addSetting(self, identifier, setting):
        self.__settingList[identifier] = setting

    def addFile(self, identifier, filename):
        self.__fileList[identifier] = filename

    def getStack(self, identifier=None):
        if not identifier:
            return self.__stackList
        stack = None
        try:
            stack = self.__stackList[identifier]
        except (IndexError, KeyError):
            pass
        return stack

    def getSetting(self, identifier=None):
        if not identifier:
            return self.__settingList
        setting = None
        try:
            setting = self.__settingList[identifier]
        except IndexError:
            pass
        return setting

    def getFile(self, identifier=None):
        if not identifier:
            return self.__fileList
        filename = None
        try:
            filename = self.__fileList[identifier]
        except IndexError:
            pass
        return filename

    def removeStack(self, identifier):
        stack = self.getStack(identifier)
        if stack:
            del self.__stackList[identifier]
        return stack

    def removeSetting(self, identifier):
        setting = self.getSetting(identifier)
        if setting:
            del self.__settingList[identifier]
        return setting

    def removeFile(self, identifier):
        filename = self.getFile(identifier)
        if filename:
            del self.__fileList[identifier]
        return filename


CONFIG_MONITOR = 0
STOP_MONITOR = 1
RESTART_MONITOR = 2


class MonitorSpawner(object):

    def __init__(self, queue):
        self.messageQueue = queue
        self.ml = MonitorList()

    def work(self):
        try:
            g = gevent.spawn(self.listen)
            g.join()
        finally:
            g.kill()

    def listen(self):
        while True:
            data = self.messageQueue.get()
            msg_type = data[0]
            identifier = data[1]

            if msg_type == STOP_MONITOR or msg_type == RESTART_MONITOR:
                stack = self.ml.removeStack(identifier)
                setting = self.ml.removeSetting(identifier)
                filename = self.ml.removeFile(identifier)
                if stack:
                    stack.disconnect()
                    group.killone(stack.connect)
                    if msg_type == RESTART_MONITOR:
                        self.spawnMonitor(identifier, setting, filename)
                continue

            if msg_type == CONFIG_MONITOR:
                self.spawnMonitor(identifier, data[2], data[3])

    def spawnMonitor(self, identifier, config, filename):
        net_settings = config["network"]
        client = gevent_client.Client(net_settings["host"],
                                      net_settings["port"],
                                      net_settings["protocol_type"],
                                      net_settings["proxy_type"],
                                      net_settings["proxy_host"],
                                      net_settings["proxy_port"])
        # layer_network <-> layer_log <-> layer_protocol <-> layer_behavior
        layer_network = Layer(gevent_client.Layer1(client))

        log_plugins = [
            p.strip() for p in config["log"]["plugins"].split(",")]
        layer_log = Layer(reporter_handler.ReporterHandler(log_plugins),
                          layer_network)

        if config["protocol"]["plugin"] == "IRC":
            protocol = irc.IRCProtocol()
        elif config["protocol"]["plugin"] == "HTTP":
            protocol = http.HTTPProtocol()

        if config["behavior"]["plugin"] == "simple_response":
            behavior = simple_response.SimpleResponse()
        elif config["behavior"]["plugin"] == "custom_irc_protocol":
            behavior = custom_irc_protocol.CustomIRCProtocol()
        elif config["behavior"]["plugin"] == "address_check":
            behavior = address_check.AddressCheck()

        layer_protocol = Layer(protocol, layer_log)
        layer_behavior = Layer(behavior, layer_protocol)
        layer_behavior.settings(config)
        layer_protocol.settings(config)

        layer_log.setUpper(layer_protocol)
        layer_network.setUpper(layer_log)
        layer_protocol.setUpper(layer_behavior)

        client.setLayer1(layer_network)
        g = group.spawn(client.connect)
        g.link(partial(self.onException, identifier))
        self.ml.addStack(identifier, client)
        self.ml.addSetting(identifier, config)
        self.ml.addFile(identifier, filename)

    def onException(self, identifier, greenlet):
        setting = self.ml.removeSetting(identifier)
        reconnAttempts = 3
        try:
            reconnAttempts = int(setting["network"]["reconn_attempts"])
        except KeyError:
            pass

        attempts = 0
        try:
            attempts = setting["attempts"]
        except KeyError:
            pass

        if attempts < reconnAttempts:
            setting["attempts"] = attempts + 1
            self.ml.addSetting(identifier, setting)
            self.messageQueue.put([RESTART_MONITOR, identifier])
        else:
            self.messageQueue.put([STOP_MONITOR, identifier])


class ButtinskyXMLRPCServer(object):

    def __init__(self, messageQueue):
        self.ml = MonitorList()
        self.queue = messageQueue

    def load_sink(self):
        hpfeeds_sink.HPFeedsSink()

    def load(self, identifier, filename):
        if self.ml.getStack(identifier):
            raise Exception("Identifier " + identifier + " already exist")
        json_data = open('settings/' + filename)
        data = json.load(json_data)
        config = data["config"]
        self.queue.put([CONFIG_MONITOR, identifier, config, filename])
        json_data.close()
        return filename + " loaded with identifier: " + identifier

    def create(self, filename, config):
        path = "settings/" + filename
        if os.path.isfile(path):
            raise Exception("File " + path + " already exist")
        f = open(path, 'wb')
        f.write(config)
        f.close()
        return filename + " created"

    def status(self):
        status = self.ml.getFile()
        root = "settings/"
        status[""] = list()
        for path, _subdirs, files in os.walk(root):
            for name in files:
                filename = os.path.join(path, name).split(root)[1]
                if filename not in status.values():
                    status[""].append(filename)
        return status

    def stop(self, identifier):
        if not self.ml.getStack(identifier):
            raise Exception("Identifier " + identifier + " does not exist")
        self.queue.put([STOP_MONITOR, identifier, None])
        return identifier + " stopped"

    def restart(self, identifier):
        if not self.ml.getStack(identifier):
            raise Exception("Identifier " + identifier + " does not exist")
        self.queue.put([RESTART_MONITOR, identifier, None])
        return identifier + " restarted"

    def list(self, filename):
        with open("settings/" + filename, "rb") as f:
            content = f.read()
        return content

    def delete(self, filename):
        os.remove("settings/" + filename)
        return filename + " deleted"

    def echo(self, msg):
        return "Msg recvd: " + msg

if __name__ == '__main__':
    if not os.path.isfile("conf/buttinsky.cfg"):
        sys.exit("Modify and rename conf/buttinsky.cfg.dist to conf/buttinsky.cfg.")
    hpfeeds_logger = hpfeeds.HPFeedsLogger()
    messageQueue = queue.Queue()
    gevent.spawn(MonitorSpawner(messageQueue).work)
    buttinsky_config = ConfigObj("conf/buttinsky.cfg")
    hostname = buttinsky_config["xmlrpc"]["server"]
    port = int(buttinsky_config["xmlrpc"]["port"])
    server = SimpleXMLRPCServer((hostname, port))
    print "Listening on port 8000..."
    server.register_instance(ButtinskyXMLRPCServer(messageQueue))
    if buttinsky_config["hpfeeds"]["enabled"] == "True":
        gevent.spawn(ButtinskyXMLRPCServer(messageQueue).load_sink)
    try:
        server.serve_forever()
    except KeyboardInterrupt:
        print "Quitting... Bye!"