jsb.lib.channelbase

provide a base class for channels.

class jsb.lib.channelbase.ChannelBase(id, botname=None, type='notset')

Bases: jsb.lib.persist.Persist

Base class for all channel objects.

delpass(type='IRC')

delete password.

gae_create()

getpass(type='IRC')

get password based of type.

parse(event, wavelet=None)

parse an event for channel related data and constuct the channel with it. Overload this.

setpass(type, key)

set channel password based on type.

CODE

# jsb/channelbase.py
#
#

""" provide a base class for channels. """

jsb imports

from jsb.utils.name import stripname
from jsb.utils.lazydict import LazyDict
from jsb.lib.persist import Persist
from jsb.lib.datadir import getdatadir
from jsb.utils.trace import whichmodule
from jsb.lib.errors import NoChannelProvided, NoChannelSet

basic imports

import time
import os
import logging

classes

class ChannelBase(Persist):

    """ Base class for all channel objects. """

    def __init__(self, id, botname=None, type="notset"):
        if not id: raise NoChannelSet()
        if not botname: Persist.__init__(self, getdatadir() + os.sep + 'channels' + os.sep + stripname(id))
        else: Persist.__init__(self, getdatadir() + os.sep + 'fleet' + os.sep + stripname(botname) + os.sep + 'channels' + os.sep + stripname(id))
        self.id = id
        self.type = type
        self.lastmodified = time.time()
        self.data.id = id
        self.data.enable = self.data.enable or False
        self.data.ops = self.data.ops or []
        self.data.silentcommands = self.data.silentcommands or []
        self.data.allowcommands = self.data.allowcommands or []
        self.data.feeds = self.data.feeds or []
        self.data.forwards = self.data.forwards or []
        self.data.allowwatch = self.data.allowwatch or []
        self.data.watched = self.data.watched or []
        self.data.passwords = self.data.passwords or {}
        self.data.cc = self.data.cc or ""
        self.data.nick = self.data.nick or "jsb"
        self.data.key = self.data.key or ""
        self.data.denyplug = self.data.denyplug or []
        self.data.createdfrom = whichmodule()
        self.data.cacheindex = 0
        self.data.tokens = self.data.tokens or []
        self.data.webchannels = self.data.webchannels or []

    def setpass(self, type, key):
        """ set channel password based on type. """
        self.data.passwords[type] = key
        self.save()

    def getpass(self, type='IRC'):
        """ get password based of type. """
        try:
            return self.data.passwords[type]
        except KeyError: return

    def delpass(self, type='IRC'):
        """ delete password. """
        try:
            del self.data.passwords[type]
            self.save()
            return True
        except KeyError: return

    def parse(self, event, wavelet=None):
        """
            parse an event for channel related data and constuct the
            channel with it. Overload this.

        """
        pass

    def gae_create(self):
        try:
            from google.appengine.api import channel
            id = self.id.split("_", 1)[0]
        except ImportError: return (None, None)
        #webchan = id + "_" + str(time.time())
        webchan = id + "_" + str(time.time())
        logging.warn("trying to create channel for %s" % webchan)
        token = channel.create_channel(webchan)
        #if token and token not in self.data.tokens:
        #    self.data.tokens.insert(0, token)
        #    self.data.tokens = self.data.tokens[:10]
        if webchan not in self.data.webchannels:
            self.data.webchannels.insert(0, webchan)
        self.data.webchannels = self.data.webchannels[:2]
        self.save()
        return (webchan, token)