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

dc.py

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

from time import sleep
import logging

import dcwords

from twisted.internet import reactor
from twisted.internet import protocol
from twisted.application import internet

import ibid
from ibid.config import Option, IntOption, FloatOption
from ibid.source import IbidSourceFactory
from ibid.event import Event
from ibid.utils import ibid_version

class DCBot(dcwords.DCClient):
    version = ibid_version() or 'dev'
    client = 'Ibid'

    def connectionMade(self):
        self.keepalive = True
        self.ping_interval = self.factory.ping_interval
        self.pong_timeout = self.factory.pong_timeout

        self.my_nickname = self.factory.nick
        self.my_password = self.factory.password
        self.my_interest = self.factory.interest
        self.my_speed = self.factory.speed
        self.my_email = self.factory.email
        self.my_sharesize = self.factory.sharesize
        self.my_slots = self.factory.slots

        dcwords.DCClient.connectionMade(self)

        self.factory.resetDelay()
        self.factory.send = self.send
        self.factory.proto = self

        self.auth_callbacks = {}

        self.factory.log.info(u"Connected")

    def connectionLost(self, reason):
        self.factory.log.info(u"Disconnected (%s)", reason)

        event = Event(self.factory.name, u'source')
        event.status = u'disconnected'
        ibid.dispatcher.dispatch(event)

        dcwords.DCClient.connectionLost(self, reason)

    def signedOn(self):
        names = ibid.config.plugins['core']['names']
        if self.my_nickname not in names:
            self.factory.log.info(u'Adding "%s" to plugins.core.names', self.my_nickname)
            names.append(self.my_nickname)
            ibid.config.plugins['core']['names'] = names
            ibid.reloader.reload_config()

        event = Event(self.factory.name, u'source')
        event.status = u'connected'
        ibid.dispatcher.dispatch(event)

        event = Event(self.factory.name, u'source')
        event.channel = u'$public'
        event.status = u'joined'
        ibid.dispatcher.dispatch(event)

        self.factory.log.info(u"Signed on")

    def _create_event(self, type, user):
        event = Event(self.factory.name, type)
        event.sender['connection'] = user
        event.sender['id'] = user
        event.sender['nick'] = user
        event.channel = u'$public'
        event.public = True
        return event

    def _state_event(self, user, action):
        event = self._create_event(u'state', user)
        event.state = action
        ibid.dispatcher.dispatch(event).addCallback(self.respond)

    def _message_event(self, msgtype, user, private, msg):
        event = self._create_event(msgtype, user)
        event.message = msg
        self.factory.log.debug(u'Received %s from %s in %s: %s',
                msgtype, event.sender['id'], private and u'private' or u'public', event.message)

        if private:
            event.addressed = True
            event.public = False
            event.channel = event.sender['connection']
        else:
            event.public = True

        ibid.dispatcher.dispatch(event).addCallback(self.respond)

    def privmsg(self, user, private, msg):
        self._message_event(u'message', user, private, msg)

    def userJoined(self, user):
        self._state_event(user, u'online')

    def userQuit(self, user):
        self._state_event(user, u'offline')

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

    def send(self, response):
        message = response['reply']

        if message:
            for prefix in self.factory.banned_prefixes:
                if message.startswith(prefix):
                    self.factory.log.info(u'Suppressed banned response: %s', message)
                    return

        target = response['target']
        if target == '$public':
            target = None

        if response.get('topic', False):
            self.topic(message)
            self.factory.log.debug(u'Set topic to %s', message)
        elif response.get('action', False):
            if self.factory.action_prefix and target is None:
                self.say(target, u'%s %s' % (self.factory.action_prefix, message))
            elif self.factory.action_prefix:
                self.say(target, u'*%s*' % message)
            else:
                self.say(target, message)

            self.factory.log.debug(u"Sent action to %s: %s", target, message)
        else:
            self.say(target, message)
            self.factory.log.debug(u"Sent privmsg to %s: %s", target, message)

    def authenticate(self, nick, callback):
        self.auth_callbacks[nick] = callback
        self.sendLine('$GetNickList')

    def dc_OpList(self, params):
        dcwords.DCClient.dc_OpList(self, params)
        done = []
        for nick, callback in self.auth_callbacks.iteritems():
            if nick in self.hub_users and self.hub_users[nick].op is True:
                callback(nick, True)
            else:
                callback(nick, False)
            done.append(nick)
        for nick in done:
            del self.auth_callbacks[nick]

class SourceFactory(protocol.ReconnectingClientFactory, IbidSourceFactory):
    protocol = DCBot

    supports = ['multiline', 'topic']
    auth = ('op',)

    port = IntOption('port', 'Server port number', 411)
    server = Option('server', 'Server hostname')
    nick = Option('nick', 'DC nick', ibid.config['botname'])
    password = Option('password', 'Password', None)
    interest = Option('interest', 'User Description', '')
    speed = Option('speed', 'Bandwidth', '1kbps')
    email = Option('email', 'eMail Address', 'http://ibid.omnia.za.net/')
    sharesize = IntOption('sharesize', 'DC Share Size (bytes)', 0)
    slots = IntOption('slots', 'DC Open Slots', 0)
    action_prefix = Option('action_prefix', 'Command for actions (i.e. +me)', None)
    banned_prefixes = Option('banned_prefixes', 'Prefixes not allowed in bot responses, i.e. !', '')
    max_message_length = IntOption('max_message_length',
            'Maximum length of messages', 490)
    ping_interval = FloatOption('ping_interval', 'Seconds idle before sending a PING', 60)
    pong_timeout = FloatOption('pong_timeout', 'Seconds to wait for PONG', 300)
    # ReconnectingClient uses this:
    maxDelay = IntOption('max_delay', 'Max seconds to wait inbetween reconnects', 900)
    factor = FloatOption('delay_factor', 'Factor to multiply delay inbetween reconnects by', 2)

    def __init__(self, name):
        IbidSourceFactory.__init__(self, name)
        self.log = logging.getLogger('source.%s' % self.name)
        self._auth = {}

    def setup(self):
        if self.action_prefix is None and 'action' in self.supports:
            self.supports.remove('action')
        if self.action_prefix is not None and 'action' not in self.supports:
            self.supports.append('action')

    def setServiceParent(self, service):
        if service:
            internet.TCPClient(self.server, self.port, self).setServiceParent(service)
        else:
            reactor.connectTCP(self.server, self.port, self)

    def connect(self):
        return self.setServiceParent(None)

    def disconnect(self):
        self.stopTrying()
        self.stopFactory()
        if hasattr(self, 'proto'):
            self.proto.transport.loseConnection()
        return True

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

    def _dc_auth_callback(self, nick, result):
        self._auth[nick] = result

    def auth_op(self, event, credential):
        nick = event.sender['nick']
        if nick in self.proto.hub_users and self.proto.hub_users[nick].op in (True, False):
            return self.proto.hub_users[nick].op

        reactor.callFromThread(self.proto.authenticate, nick, self._dc_auth_callback)
        for i in xrange(150):
            if nick in self._auth:
                break
            sleep(0.1)

        if nick in self._auth:
            result = self._auth[nick]
            del self._auth[nick]
            return result

    def url(self):
        return u'dc://%s@%s:%s' % (self.nick, self.server, self.port)

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

Generated by  Doxygen 1.6.0   Back to index