gajim-plural/common/hub.py

#!/usr/bin/env python
##	common/hub.py
##
## Gajim Team:
## 	- Yann Le Boulanger <asterix@crans.org>
## 	- Vincent Hanquez <tab@tuxfamily.org>
## 	- David Ferlier <david@yazzy.org>
##
##	Copyright (C) 2003 Gajim Team
##
## 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; version 2 only.
##
## 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.
##

import Queue
import common.plugin
import common.thread

""" Hub definitions """

class GajimHub:
    def __init__(self):
        self.queues = {}
        """ {event1:[queue1, queue2]} """
        self.events = {}
        self.queueIn = self.newQueue('in', 100)
    # END __init__

    def newQueue(self, name, size):
        """ Creates a new queue """
        qu = Queue.Queue(size)
        self.queues[name] = qu
        return qu
    # END newQueue
	
    def newPlugin(self, name):
        """Creates a new Plugin """
        qu = self.newQueue(name, 100)
        pl = common.plugin.GajimPlugin(name, qu, self.queueIn)
        return pl
    # END newPlugin

    def register(self, name, event):
        """ Records a plugin from an event """
        qu = self.queues[name]
	if self.events.has_key(event) :
		self.events[event].append(qu)
	else :
		self.events[event] = [qu]
    # END register

    def sendPlugin(self, event, data):
        """ Sends an event to registered plugins
		NOTIFY : ('NOTIFY', (user, status, message))
		MSG : ('MSG', (user, msg))
		ROSTER : ('ROSTER', {jid:{'status':_, 'name':_, 'show':_, 'groups':[], 'online':_, 'ask':_, 'sub':_} ,jid:{}})
		SUBSCRIBED : ('SUBSCRIBED', {'jid':_, 'nom':_, 'server':_, 'resource':_, 'status':_, 'show':_})"""

        if self.events.has_key(event):
            for i in self.events[event]:
                i.put((event, data))
    # END sendPlugin
# END GajimHub