__init__.py

# Copyright (c) 2008-2011, Michael Gorven, Stefano Rivera, Keegan Carruthers-Smith
# Released under terms of the MIT/X/Expat Licence. See COPYING for details.

from copy import copy
from datetime import timedelta
from inspect import getargspec, getmembers, ismethod
import logging
import re
from threading import Lock

from twisted.spread import pb
from twisted.web import resource
try:
    from twisted.plugin import pluginPackagePaths
except ImportError:
    # Not available in Twisted 2.5.0 in Ubuntu hardy
    # This is straight from twisted.plugin
    import os.path
    import sys
    def pluginPackagePaths(name):
        package = name.split('.')
        return [os.path.abspath(os.path.join(x, *package)) for x in sys.path
            if not os.path.exists(os.path.join(x, *package + ['__init__.py']))]

import ibid
from ibid.compat import json, defaultdict
from ibid.utils import url_regex

__path__ = pluginPackagePaths(__name__) + __path__

for cat, desc, weight in (
            ('account', u'bot accounts and permissions', None),
            ('admin', u'administrative functions', None),
            ('calculate', u'calculations', 0),
            ('convert', u'conversions', 0),
            ('debug', u'debugging me', None),
            ('decide', u'decisions', -2),
            ('development', u'software development', 10),
            ('fun', u'silly fun stuff', 0),
            ('game', u'games', -2),
            ('lookup', u'looking things up', -10),
            ('monitor', u'monitoring things', -2),
            ('remember', u'remembering things', -5),
            ('web', u'browsing the Internet', 0),
            ('message', u'delivering messages', -5),
            ('south africa', u'South African stuff', 10),
            ('sysadmin', u'System Administration', 5),
        ):
    if cat not in ibid.categories:
        ibid.categories[cat] = {
            'description': desc,
            'weight': weight,
        }

class Processor(object):
    """Base class for Ibid plugins.
    Processors receive events and (optionally) do things with them.

    Events are filtered in process() by to the following attributes:
    event_types: Only these types of events
    addressed: Require the bot to be addressed for public messages
    processed: Process events marked as already having been handled
    permission: The permission to check when calling @authorised handlers

    priority: Low priority Processors are handled first

    autoload: Load this Processor, when loading the plugin, even if not
    explicitly required in the configuration file
    """

    event_types = (u'message',)
    addressed = True
    processed = False
    priority = 0
    autoload = True
    _event_handlers = None
    _periodic_handlers = None

    __log = logging.getLogger('plugins')

    def __new__(cls, *args):
        if cls.processed and cls.priority == 0:
            cls.priority = 1500

        for name, option in options.items():
            new = copy(option)
            new.default = getattr(cls, name)
            setattr(cls, name, new)

        for attr, listname in (
                ('handler', 'event'),
                ('periodic', 'periodic')):
            listname = '_Processor__%s_handlers' % listname
            if not hasattr(cls, listname):
                setattr(cls, listname, [])
            handlers = getattr(cls, listname)

            for name, item in cls.__dict__.iteritems():
                if getattr(item, attr, False) and name not in handlers:
                    handlers.append(name)

        return super(Processor, cls).__new__(cls)

    def __init__(self, name):
        self.name = name
        self.setup()

    def setup(self):
        "Apply configuration. Called on every config reload"
        for name, method in getmembers(self, ismethod):
            if hasattr(method, 'interval_config_key'):
                method.im_func.interval = timedelta(
                        seconds=getattr(self, method.interval_config_key, 0))

    def shutdown(self):
        pass

    def process(self, event):
        "Process a single event"
        if event.type == 'clock':
            for method in self._get_periodic_handlers():
                self._run_periodic_handler(method, event)

        if event.type not in self.event_types:
            return

        if self.addressed and ('addressed' not in event or not event.addressed):
            return

        if not self.processed and event.processed:
            return

        found = False
        for method in self._get_event_handlers():
            args = None
            if not hasattr(method, 'pattern'):
                found = True
                args = ()
            elif hasattr(event, 'message'):
                found = True
                match = method.pattern.search(
                        event.message[method.message_version])
                if match is not None:
                    args = match.groups()
                    kwargs = match.groupdict()
                    if kwargs:
                        assert len(args) == len(kwargs), (
                            "Can't intermix named and positional arguments.")
                        # Convert the names from the %s__%d_ format to %s
                        args = {}
                        for name, value in kwargs.iteritems():
                            name = re.match(r'^(\S+?)(?:__\d+_)?$', name).group(1)
                            if args.get(name, None) is None:
                                args[name] = value
                            else:
                                assert value is None, (
                                    'named argument %s was matched more '
                                    'than once.' % name)
            if args is not None:
                if (not getattr(method, 'auth_required', False)
                        or auth_responses(event, self.permission)):
                    if isinstance(args, dict):
                        method(event, **args)
                    else:
                        method(event, *args)
                elif not getattr(method, 'auth_fallthrough', True):
                    event.processed = True

        if not found:
            raise RuntimeError(u'No handlers found in %s' % self)

        return event

    def _get_event_handlers(self):
        "Find all the handlers (regex matching and blind)"
        for handler in self._event_handlers or self.__event_handlers:
            yield getattr(self, handler)

    def _get_periodic_handlers(self):
        "Find all the periodic handlers"
        for handler in self._periodic_handlers or self.__periodic_handlers:
            yield getattr(self, handler)

    def _run_periodic_handler(self, method, event):
        "Run a periodic handler, if appropriate"
        if (method.interval.seconds > 0
                and not method.disabled
                and method.lock.acquire(0)):
            try:
                if method.last_called is None:
                    # First call, set up initial_delay
                    method.im_func.last_called = event.time
                elif event.time - method.last_called >= (
                        method.initial_delay or method.interval):
                    method.im_func.initial_delay = None
                    method.im_func.last_called = event.time
                    name = u'%s.%s' % (self.__class__.__name__, method.__name__)
                    try:
                        self.__log.debug(u'Running periodic event: %s', name)
                        method(event)
                        if method.failing:
                            self.__log.info(u'No longer failing: %s', name)
                            method.im_func.failing = False
                    except:
                        if not method.failing:
                            self.__log.exception(u'Periodic method failing: %s',
                                                 name)
                            method.im_func.failing = True
                        else:
                            self.__log.debug(u'Still failing: %s', name)

            finally:
                method.lock.release()

# This is a bit yucky, but necessary since ibid.config imports Processor
from ibid.config import BoolOption, IntOption
options = {
    'addressed': BoolOption('addressed',
        u'Only process events if bot was addressed'),
    'processed': BoolOption('processed',
        u"Process events even if they've already been processed"),
    'priority': IntOption('priority', u'Processor priority'),
}

def handler(function):
    "Wrapper: Handle all events"
    function.handler = True
    function.message_version = 'clean'
    return function

def _match_sub_selectors(regex):
    selector_patterns = {
        'alpha'   : r'[a-zA-Z]+',
        'any'     : r'.+',
        'chunk'   : r'\S+',
        'digits'  : r'\d+',
        'number'  : r'\d*\.?\d+',
        'url'     : url_regex(),
        'word'    : r'\w+',
    }

    regex = regex.replace(' ', r'(?:\s+)')

    name_count = defaultdict(int)
    def selector_to_re(match):
        name    = match.group(1)
        pattern = match.group(2)

        if name is None:
            return '(%s)' % selector_patterns[pattern]

        # Prevent conflicts when reusing a name
        name_count[name] += 1
        name = '%s__%d_' % (name, name_count[name])

        return '(?P<%s>%s)' % (name, selector_patterns[pattern])

    regex = re.sub(r'{(?:(\w+):)?(%s)}' % '|'.join(selector_patterns.keys()),
                   selector_to_re, regex)

    if not regex.startswith('^'):
        regex = '^' + regex
    if not regex.endswith('$'):
        regex = regex + '$'

    return regex

def match(regex, version='clean', simple=True):
    "Wrapper: Handle all events where the message matches the regex"
    if simple:
        regex = _match_sub_selectors(regex)

    pattern = re.compile(regex, re.I | re.UNICODE | re.DOTALL)
    def wrap(function):
        function.handler = True
        function.pattern = pattern
        function.message_version = version
        return function
    return wrap

def auth_responses(event, permission):
    """Mark an event as having required authorisation, and return True if the
    event sender has permission.
    """
    if not ibid.auth.authorise(event, permission):
        event.complain = u'notauthed'
        return False

    return True

def authorise(fallthrough=True):
    """Require the permission specified in Processer.permission for the sender
    On failure, flags the event for Complain to respond appropriatly.
    If fallthrough=False, set the processed Flag to bypass later plugins.
    """
    def wrap(function):
        function.auth_required = True
        function.auth_fallthrough = fallthrough
        return function
    return wrap

def periodic(interval=0, config_key=None, initial_delay=60):
    """Wrapper: Run this handler every interval seconds
    If a config_key is provided, the interval will be set in Processor.setup()
    """
    def wrap(function):
        function.periodic = True
        function.disabled = False
        function.lock = Lock()
        function.last_called = None
        function.interval = timedelta(seconds=interval)
        function.initial_delay = timedelta(seconds=initial_delay)
        if config_key is not None:
            function.interval_config_key = config_key
        function.failing = False
        return function
    return wrap

from ibid.source.http import templates

class RPC(pb.Referenceable, resource.Resource):
    isLeaf = True

    def __init__(self):
        ibid.rpc[self.features[0]] = self
        self.form = templates.get_template('plugin_form.html')
        self.list = templates.get_template('plugin_functions.html')

    def get_function(self, request):
        method = request.postpath[0]

        if hasattr(self, 'remote_%s' % method):
            return getattr(self, 'remote_%s' % method)

        return None

    def render_POST(self, request):
        args = []
        for arg in request.postpath[1:]:
            try:
                arg = json.loads(arg)
            except ValueError, e:
                pass
            args.append(arg)

        kwargs = {}
        for key, value in request.args.items():
            try:
                value = json.loads(value[0])
            except ValueError, e:
                value = value[0]
            kwargs[key] = value

        function = self.get_function(request)
        if not function:
            return "Not found"

        try:
            result = function(*args, **kwargs)
            return json.dumps(result)
        except Exception, e:
            return json.dumps({'exception': True, 'message': unicode(e)})

    def render_GET(self, request):
        function = self.get_function(request)
        if not function:
            functions = []
            for name, method in getmembers(self, ismethod):
                if name.startswith('remote_'):
                    functions.append(name.replace('remote_', '', 1))

            return self.list.render(object=self.features[0], functions=functions) \
                    .encode('utf-8')

        args, varargs, varkw, defaults = getargspec(function)
        del args[0]
        if len(args) == 0 or len(request.postpath) > 1 or len(request.args) > 0:
            return self.render_POST(request)

        return self.form.render(args=args).encode('utf-8')

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