Limnoria/src/registry.py

#!/usr/bin/env python

###
# Copyright (c) 2004, Jeremiah Fincher
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
#   * Redistributions of source code must retain the above copyright notice,
#     this list of conditions, and the following disclaimer.
#   * Redistributions in binary form must reproduce the above copyright notice,
#     this list of conditions, and the following disclaimer in the
#     documentation and/or other materials provided with the distribution.
#   * Neither the name of the author of this software nor the name of
#     contributors to this software may be used to endorse or promote products
#     derived from this software without specific prior written consent.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
###

__revision__ = "$Id$"

import re
import copy
import sets
import time
import types
import textwrap

import fix
import utils

class RegistryException(Exception):
    pass

class InvalidRegistryFile(RegistryException):
    pass

class InvalidRegistryValue(RegistryException):
    pass

class NonExistentRegistryEntry(RegistryException):
    pass

_cache = {}
_lastModified = 0
def open(filename):
    """Initializes the module by loading the registry file into memory."""
    global _lastModified
    _cache.clear()
    fd = utils.nonCommentNonEmptyLines(file(filename))
    for (i, line) in enumerate(fd):
        line = line.rstrip('\r\n')
        try:
            (key, value) = re.split(r':\s*', line, 1)
        except ValueError:
            raise InvalidRegistryFile, 'Error unpacking line #%s' % (i+1)
        _cache[key.lower()] = value
    _lastModified = time.time()

def close(registry, filename, annotated=True):
    first = True
    helpCache = sets.Set()
    fd = file(filename, 'w')
    for (name, value) in registry.getValues(getChildren=True):
        if annotated and \
           hasattr(value,'help') and \
           value.help and \
           value.help not in helpCache:
            helpCache.add(value.help)
            lines = textwrap.wrap(value.help)
            for (i, line) in enumerate(lines):
                lines[i] = '# %s\n' % line
            lines.insert(0, '###\n')
            if first:
                first = False
            else:
                lines.insert(0, '\n')
            lines.append('###\n')
            fd.writelines(lines)
        fd.write('%s: %s\n' % (name, value))
    fd.close()


class Value(object):
    def __init__(self, default, help):
        self.default = default
        self.help = utils.normalizeWhitespace(help.strip())
        self.setValue(default)

    def set(self, s):
        """Override this with a function to convert a string to whatever type
        you want, and call self.setValue to set the value."""
        raise NotImplementedError

    def setValue(self, v):
        """Check conditions on the actual value type here.  I.e., if you're a
        IntegerLessThanOneHundred (all your values must be integers less than
        100) convert to an integer in set() and check that the integer is less
        than 100 in this method.  You *must* call this parent method in your
        own setValue."""
        self._lastModified = time.time()
        self.value = v
    
    def __str__(self):
        return repr(self())

    # This is simply prettier than naming this function get(self)
    def __call__(self):
        # TODO: Check _lastModified to see if stuff needs to be reloaded from
        # the _cache.
        return self.value
    
class Boolean(Value):
    def set(self, s):
        s = s.lower()
        if s in ('true', 'on', 'enable', 'enabled'):
            value = True
        elif s in ('false', 'off', 'disable', 'disabled'):
            value = False
        elif s == 'toggle':
            value = not self.value
        else:
            raise InvalidRegistryValue, 'Value must be True or False.'
        self.setValue(value)

    def setValue(self, v):
        Value.setValue(self, bool(v))

class Integer(Value):
    def set(self, s):
        try:
            self.setValue(int(s))
        except ValueError:
            raise InvalidRegistryValue, 'Value must be an integer.'

class PositiveInteger(Value):
    def set(self, s):
        try:
            self.setValue(int(s))
        except ValueError:
            raise InvalidRegistryValue, 'Value must be a positive integer.'

    def setValue(self, v):
        if v <= 0:
            raise InvalidRegistryValue, 'Value must be a positive integer.'
        Value.setValue(self, v)

class Float(Value):
    def set(self, s):
        try:
            self.setValue(float(s))
        except ValueError:
            raise InvalidRegistryValue, 'Value must be a float.'

    def setValue(self, v):
        try:
            Value.setValue(self, float(v))
        except ValueError:
            raise InvalidRegistryValue, 'Value must be a float.'

class String(Value):
    def set(self, s):
        if not s:
            s = '""'
        elif s[0] != s[-1] or s[0] not in '\'"':
            s = repr(s)
        try:
            v = utils.safeEval(s)
            if not isinstance(v, basestring):
                raise ValueError
            self.value = v
        except ValueError: # This catches utils.safeEval(s) errors too.
            raise InvalidRegistryValue, 'Value must be a string.'

class NormalizedString(String):
    def set(self, s):
        s = utils.normalizeWhitespace(s.strip())
        String.set(self, s)

    def setValue(self, s):
        s = utils.normalizeWhitespace(s.strip())
        String.setValue(self, s)

class StringSurroundedBySpaces(String):
    def set(self, s):
        String.set(self, s)
        self.setValue(self.value)

    def setValue(self, v):
        if v.lstrip() == v:
            v= ' ' + v
        if v.rstrip() == v:
            v += ' '
        String.setValue(self, v)
            
class StringWithSpaceOnRight(String):
    def setValue(self, v):
        if v.rstrip() == v:
            v += ' '
        String.setValue(self, v)

class Regexp(Value):
    def set(self, s):
        try:
            if s:
                self.value = utils.perlReToPythonRe(s)
            else:
                self.value = None
            self.sr = s
        except ValueError, e:
            raise InvalidRegistryValue, 'Value must be a valid regexp: %s' % e

    def setValue(self, v):
        if v is None:
            self.sr = ''
            self.value = None
        else:
            raise InvalidRegistryValue, \
                  'Can\'t set to a regexp, there would be an inconsistency ' \
                  'between the regexp and the recorded string value.'

    def __str__(self):
        return self.sr
        
class SeparatedListOf(Value):
    Value = Value
    def splitter(self, s):
        """Override this with a function that takes a string and returns a list
        of strings."""
        raise NotImplementedError

    def joiner(self, L):
        """Override this to join the internal list for output."""
        raise NotImplementedError
    
    def set(self, s):
        L = self.splitter(s)
        for (i, s) in enumerate(L):
            v = self.Value(s, 'help does not matter here')
            L[i] = v()
        self.setValue(L)

    def setValue(self, v):
        Value.setValue(self, list(v))

    def __str__(self):
        return self.joiner(self.value)
        
class SpaceSeparatedListOfStrings(SeparatedListOf):
    Value = String
    def splitter(self, s):
        return s.split()
    joiner = ' '.join
    
class CommaSeparatedListOfStrings(SeparatedListOf):
    Value = String
    def splitter(self, s):
        return re.split(r'\s*,\s*', s)
    joiner = ', '.join
    
class CommaSeparatedSetOfStrings(CommaSeparatedListOfStrings):
    def setValue(self, v):
        CommaSeparatedListOfStrings.setValue(self, sets.Set(v))

class Group(object):
    def __init__(self):
        self.name = 'unset'
        self.values = {}
        self.children = {}
        self.originals = {}

    def __nonExistentEntry(self, attr):
        s = '%s is not a valid entry in %s' % (attr, self.name)
        raise NonExistentRegistryEntry, s

    def __getattr__(self, attr):
        original = attr
        attr = attr.lower()
        if attr in self.values:
            return self.values[attr]
        elif attr in self.children:
            return self.children[attr]
        else:
            self.__nonExistentEntry(original)
            
    def get(self, attr):
        return self.__getattr__(attr)
    
    def getChild(self, attr):
        return self.children[attr.lower()]

    def setName(self, name):
        self.name = name

    def getName(self):
        return self.name

    def register(self, name, value):
        original = name
        name = name.lower()
        self.values[name] = value
        self.originals[name] = original
        if _cache:
            fullname = '%s.%s' % (self.name, name)
            if fullname in _cache:
                value.set(_cache[fullname])

    def registerGroup(self, name, group=None):
        original = name
        name = name.lower()
        if name in self.children:
            return # Ignore redundant group inserts.
        if group is None:
            group = Group()
        self.children[name] = group
        self.originals[name] = original
        fullname = '%s.%s' % (self.name, name)
        group.setName(fullname)
        if _cache and fullname in _cache:
            group.set(_cache[fullname])

    def getValues(self, getChildren=False, fullNames=True):
        L = []
        items = self.values.items()
        # If getChildren=True, the group will insert itself into its getValues.
        if not getChildren: 
            for (name, child) in self.children.items():
                if hasattr(child, 'value'):
                    items.append((name, child))
        utils.sortBy(lambda (k, _): (k.lower(), len(k), k), items)
        for (name, value) in items:
            if fullNames:
                name = '%s.%s' % (self.getName(), self.originals[name])
            else:
                name = self.originals[name]
            L.append((name, value))
        if getChildren:
            items = self.children.items()
            utils.sortBy(lambda (k, _): (k.lower(), len(k), k), items)
            for (_, child) in items:
                L.extend(child.getValues(getChildren, fullNames))
        return L
        

class GroupWithValue(Group):
    def __init__(self, value):
        Group.__init__(self)
        self.value = value
        self.help = value.help
        self.default = value.default

    def set(self, s):
        self.value.set(s)

    def setValue(self, v):
        self.value.setValue(v)

    def __call__(self):
        return self.value()

    def __str__(self):
        return str(self.value)

    def getValues(self, getChildren=False, fullNames=True):
        L = Group.getValues(self, getChildren, fullNames)
        if getChildren:
            L.insert(0, (self.getName(), self))
        return L


class GroupWithDefault(GroupWithValue):
    def __init__(self, value):
        class X(value.__class__):
            """This class exists to differentiate those values that have been
            changed from their default to those that haven't."""
            def set(self, *args):
                self.__class__ = value.__class__
                self.set(*args)
            def setValue(self, *args):
                self.__class__ = value.__class__
                self.setValue(*args)
        self.X = X
        GroupWithValue.__init__(self, value)
        
    def __makeChild(self, attr, s):
        #print '***', attr, ':', repr(s)
        v = copy.copy(self.value)
        v.set(s)
        v.__class__ = self.X
        self.register(attr, v)
        return v

    def __getattr__(self, attr):
        try:
            v = GroupWithValue.__getattr__(self, attr)
            if v.__class__ is self.X:
                raise NonExistentRegistryEntry 
        except NonExistentRegistryEntry:
            v = self.__makeChild(attr, str(self))
        return v

    def setName(self, name):
        GroupWithValue.setName(self, name)
        for (k, v) in _cache.iteritems():
            if k.startswith(self.name):
                (_, group) = rsplit(k, '.', 1)
                self.__makeChild(group, v)

    def getValues(self, getChildren=False, fullNames=True):
        L = GroupWithValue.getValues(self, getChildren, fullNames)
        L = [v for v in L if v[1].__class__ is not self.X]
        return L


if __name__ == '__main__':
    import sys
    sys.setrecursionlimit(40)
    supybot = Group()
    supybot.setName('supybot')
    supybot.register('throttleTime', Float(1, """Determines the minimum
    number of seconds the bot will wait between sending messages to the server.
    """))
    supybot.registerGroup('plugins')
    supybot.plugins.registerGroup('topic')
    supybot.plugins.topic.registerGroup('separator',
      GroupWithDefault(StringSurroundedBySpaces(' || ',
      'Determines what separator the bot uses to separate topic entries.')))
    supybot.plugins.topic.separator.get('#supybot').set(' |||| ')
    supybot.plugins.topic.separator.set(' <> ')

    supybot.throttleTime.set(10)

    supybot.registerGroup('log')
    supybot.log.registerGroup('stdout',
                              GroupWithValue(Boolean(False,
                                                     """Help for stdout.""")))
    supybot.log.stdout.register('colorized', Boolean(False,
                                                     'Help colorized'))
    supybot.log.stdout.setValue(True)

    for (k, v) in supybot.getValues():
        print '%s: %s' % (k, v)

    print
    print 'Asking children'
    print

    for (k, v) in supybot.getValues(getChildren=True):
        print '%s: %s' % (k, v)

    print supybot.throttleTime.help
    print supybot.plugins.topic.separator.help
    

# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: