Logo Search packages:      
Sourcecode: ibid version File versions  Download package

campfire.py

# Copyright (c) 2009-2010, Stefano Rivera
# Released under terms of the MIT/X/Expat Licence. See COPYING for details.

import logging

from campfirewords import CampfireClient

import ibid
from ibid.config import BoolOption, IntOption, Option, ListOption
from ibid.event import Event
from ibid.source import IbidSourceFactory

class CampfireBot(CampfireClient):

    def __init__(self, factory):
        self.factory = factory
        CampfireClient.__init__(self, self.factory.subdomain,
                                self.factory.token,
                                self.factory.rooms,
                                self.factory.secure,
                                self.factory.keepalive_timeout)

    def _create_event(self, type, user_id, user_name, room_id, room_name):
        event = Event(self.factory.name, type)
        if user_id is not None:
            # user_id is an int. simplejson may have returned a str() if
            # user_name and room_name don't contain non-ASCII chars.
            user_id = unicode(user_id)
            user_name = unicode(user_name)
            event.sender['connection'] = user_id
            event.sender['id'] = user_id
            event.sender['nick'] = user_name
        event.channel = unicode(room_name)
        event.public = True
        event.source = self.factory.name
        return event

    def _message_event(self, body, type=u'message', **kwargs):
        event = self._create_event(type, **kwargs)
        event.message = unicode(body)
        self.factory.log.debug(u'Received %s from %s in %s: %s', type,
                               kwargs['user_name'], kwargs['room_name'], body)
        ibid.dispatcher.dispatch(event).addCallback(self.respond)

    def _state_event(self, state, **kwargs):
        event = self._create_event(u'state', **kwargs)
        event.state = state
        self.factory.log.debug(u'%s in %s is now %s', kwargs['user_name'],
                               kwargs['room_name'], state)
        ibid.dispatcher.dispatch(event).addCallback(self.respond)

    def handle_Text(self, **kwargs):
        self._message_event(**kwargs)

    def handle_TopicChange(self, **kwargs):
        self._message_event(type=u'topic', **kwargs)

    def handle_Leave(self, **kwargs):
        self._state_event(state=u'offline', **kwargs)

    def handle_Enter(self, **kwargs):
        self._state_event(state=u'online', **kwargs)

    def joined_room(self, room_info):
        self._message_event(type=u'topic', body=room_info['topic'],
                            user_id=None, user_name=None,
                            room_id=room_info['id'],
                            room_name=room_info['name'])

    def send(self, response):
        message = response['reply']
        if response.get('action', False):
            message = u'*%s*' % message
        elif response.get('topic', False):
            self.topic(response['target'], message)
            return

        if '\n' in message:
            self.say(response['target'], message, type='PasteMessage')
        else:
            self.say(response['target'], message)

    def respond(self, event):
        for response in event.responses:
            self.send(response)

    def join(self, room_name):
        return self.join_room(self._locate_room(room_name))

    def leave(self, room_name):
        return self.leave_room(self._locate_room(room_name))

class SourceFactory(IbidSourceFactory):

    auth = ('implicit',)
    supports = ('action', 'multiline', 'topic')

    subdomain = Option('subdomain', 'Campfire subdomain')
    secure = BoolOption('secure', 'Use https (paid accounts only)', False)
    token = Option('token', 'Campfire token')
    rooms = ListOption('rooms', 'Rooms to join', [])
    keepalive_timeout = IntOption('keepalive_timeout',
            'Stream keepalive timeout. '
            'Campfire sends a keepalive every <5 seconds', 30)

    def __init__(self, name):
        super(SourceFactory, self).__init__(name)
        self.log = logging.getLogger('source.%s' % self.name)
        self.client = CampfireBot(self)

    def setServiceParent(self, service):
        self.client.connect()

    def disconnect(self):
        self.client.disconnect()
        return True

    def url(self):
        protocol = self.secure and 'https' or 'http'
        return '%s://%s.campfirenow.com/' % (protocol, self.subdomain)

    def send(self, response):
        return self.client.send(response)

    def join(self, room_name):
        return self.client.join(room_name)

    def leave(self, room_name):
        return self.client.leave(room_name)

    def truncation_point(self, response, event=None):
        return None

# vi: set et sta sw=4 ts=4:

Generated by  Doxygen 1.6.0   Back to index