path: root/src/lib/Server/Plugin.py

'''This module provides the baseclass for Bcfg2 Server Plugins'''
__revision__ = '$Revision$'

import lxml.etree
import os
import stat
import syslog

from lxml.etree import XML, XMLSyntaxError

class PluginInitError(Exception):
    '''Error raised in cases of Plugin initialization errors'''
    pass

class PluginExecutionError(Exception):
    '''Error raised in case of Plugin execution errors'''
    pass

class Plugin(object):
    '''This is the base class for all Bcfg2 Server plugins. Several attributes must be defined
    in the subclass:
    __name__ : the name of the plugin
    __version__ : a version string
    __author__ : the author/contact for the plugin

    Plugins can provide three basic types of functionality:
      - Structure creation (overloading BuildStructures)
      - Configuration entry binding (overloading HandlesEntry, or loads the Entries table)
      - Data collection (overloading GetProbes/ReceiveData)
    '''
    __name__ = 'Plugin'
    __version__ = '$Id$'
    __author__ = 'bcfg-dev@mcs.anl.gov'
    __rmi__ = []

    def __init__(self, core, datastore):
        object.__init__(self)
        self.Entries = {}
        self.core = core
        self.data = "%s/%s" % (datastore, self.__name__)

    def LogError(self, msg):
        '''Log error message tagged with Plugin name'''
        syslog.syslog(syslog.LOG_ERR, "%s: %s" % (self.__name__, msg))

    def BuildStructures(self, metadata):
        '''Build a set of structures tailored to the client metadata'''
        return []

    def GetProbes(self, metadata):
        '''Return a set of probes for execution on client'''
        return []

    def ReceiveData(self, metadata, data):
        '''Receive probe results pertaining to client'''
        pass

# the rest of the file contains classes for coherent file caching

class FileBacked(object):
    '''This object caches file data in memory.
    HandleEvent is called whenever fam registers an event.
    Index can parse the data into member data as required.
    This object is meant to be used as a part of DirectoryBacked.'''
    
    def __init__(self, name):
        object.__init__(self)
        self.data = ''
        self.name = name
        self.mtime = 0
        #self.readonce = 0
        #self.HandleEvent()

    def HandleEvent(self, event=None):
        '''Read file upon update'''
        oldmtime = self.mtime
        try:
            self.mtime = os.stat(self.name)[stat.ST_MTIME]
        except OSError:
            syslog.syslog(syslog.LOG_ERR, "Failed to stat file %s" % (self.name))
            
        try:
            self.data = file(self.name).read()
            self.Index()
        except IOError:
            syslog.syslog(syslog.LOG_ERR, "Failed to read file %s" % (self.name))
            
    def Index(self):
        '''Update local data structures based on current file state'''
        pass

class DirectoryBacked(object):
    '''This object is a coherent cache for a filesystem hierarchy of files.'''
    __child__ = FileBacked

    def __init__(self, name, fam):
        object.__init__(self)
        self.name = name
        self.fam = fam
        self.entries = {}
        self.inventory = False
        fam.AddMonitor(name, self)

    def __getitem__(self, key):
        return self.entries[key]

    def __iter__(self):
        return self.entries.iteritems()

    def AddEntry(self, name):
        '''Add new entry to data structures upon file creation'''
        if name == '':
            syslog.syslog(syslog.LOG_INFO, "got add for empty name")
        elif self.entries.has_key(name):
            syslog.syslog(syslog.LOG_INFO, "got multiple adds for %s" % name)
        else:
            if ((name[-1] == '~') or (name[:2] == '.#') or (name[-4:] == '.swp') or (name in ['SCCS', '.svn'])):
                return
            self.entries[name] = self.__child__('%s/%s' % (self.name, name))
            self.entries[name].HandleEvent()

    def HandleEvent(self, event):
        '''Propagate fam events to underlying objects'''
        action = event.code2str()
        if event.filename == '':
            syslog.syslog(syslog.LOG_INFO, "Got event for blank filename")
            return
        if action == 'exists':
            if event.filename != self.name:
                self.AddEntry(event.filename)
        elif action == 'created':
            self.AddEntry(event.filename)
        elif action == 'changed':
            if self.entries.has_key(event.filename):
                self.entries[event.filename].HandleEvent(event)
        elif action == 'deleted':
            if self.entries.has_key(event.filename):
                del self.entries[event.filename]
        elif action in ['endExist']:
            pass
        else:
            print "Got unknown event %s %s %s" % (event.requestID, event.code2str(), event.filename)

class XMLFileBacked(FileBacked):
    '''This object is a coherent cache for an XML file to be used as a part of DirectoryBacked.'''
    __identifier__ = 'name'

    def __init__(self, filename):
        self.label = "dummy"
        self.entries = []
        FileBacked.__init__(self, filename)

    def Index(self):
        '''Build local data structures'''
        try:
            xdata = XML(self.data)
        except XMLSyntaxError:
            syslog.syslog(syslog.LOG_ERR, "Failed to parse %s"%(self.name))
            return
        self.label = xdata.attrib[self.__identifier__]
        self.entries = xdata.getchildren()

    def __iter__(self):
        return iter(self.entries)

class SingleXMLFileBacked(XMLFileBacked):
    '''This object is a coherent cache for an independent XML File.'''
    def __init__(self, filename, fam):
        XMLFileBacked.__init__(self, filename)
        fam.AddMonitor(filename, self)

class StructFile(XMLFileBacked):
    '''This file contains a set of structure file formatting logic'''
    def __init__(self, name):
        XMLFileBacked.__init__(self, name)
        self.fragments = {}

    def Index(self):
        '''Build internal data structures'''
        try:
            xdata = lxml.etree.XML(self.data)
        except lxml.etree.XMLSyntaxError:
            syslog.syslog(syslog.LOG_ERR, "Failed to parse file %s" % self.name)
            return
        self.fragments = {}
        work = {lambda x:True: xdata.getchildren()}
        while work:
            (predicate, worklist) = work.popitem()
            self.fragments[predicate] = [item for item in worklist if item.tag != 'Group'
                                         and not isinstance(item, lxml.etree._Comment)]
            for group in [item for item in worklist if item.tag == 'Group']:
                # if only python had forceable early-binding
                newpred = eval("lambda x:'%s' in x.groups and predicate(x)" % (group.get('name')),
                               {'predicate':predicate})
                work[newpred] = group.getchildren()

    def Match(self, metadata):
        '''Return matching fragments of independant'''
        return reduce(lambda x, y:x+y, [frag for (pred, frag) in self.fragments.iteritems()
                                       if pred(metadata)])

class LNode:
    '''LNodes provide lists of things available at a particular group intersection'''
    raw = {'Client':"lambda x:'%s' == x.hostname and predicate(x)",
           'Group':"lambda x:'%s' in x.groups and predicate(x)"}
    __leaf__ = './Child'
    
    def __init__(self, data, plist, parent=None):
        self.data = data
        self.contents = {}
        if parent == None:
            self.predicate = lambda x:True
        else:
            predicate = parent.predicate
            if data.tag in self.raw.keys():
                self.predicate = eval(self.raw[data.tag] % (data.get('name')), {'predicate':predicate})
            else:
                print data.tag
                raise Exception
        mytype = self.__class__
        self.children = [mytype(child, plist, self) for child in data.getchildren()
                         if child.tag in ['Group', 'Client']]
        for leaf in data.findall(self.__leaf__):
            self.contents[leaf.get('name')] = leaf.attrib
            if leaf.get('name') not in plist:
                plist.append(leaf.get('name'))

    def Match(self, metadata, data):
        '''Return a dictionary of package mappings'''
        if self.predicate(metadata):
            data.update(self.contents)
            for child in self.children:
                child.Match(metadata, data)

class XMLSrc(XMLFileBacked):
    '''XMLSrc files contain a LNode hierarchy that returns matching entries'''
    __node__ = LNode

    def __init__(self, filename):
        XMLFileBacked.__init__(self, filename)
        self.names = []
        self.cache = None
        self.pnode = None
        self.priority = '1000'
    
    def Index(self):
        self.names = []
        xdata = XML(self.data)
        self.pnode = self.__node__(xdata, self.names)
        self.cache = None
        self.priority = xdata.attrib['priority']

    def Cache(self, metadata):
        '''Build a package dict for a given host'''
        if self.cache == None or self.cache[0] != metadata:
            cache = (metadata, {})
            if self.pnode == None:
                syslog.syslog(syslog.LOG_ERR,
                              "Cache method called early for %s; forcing data load" % (self.name))
                self.HandleEvent()
                return
            self.pnode.Match(metadata, cache[1])
            self.cache = cache

class XMLPrioDir(Plugin, DirectoryBacked):
    '''This is a generator that handles package assignments'''
    __name__ = 'XMLPrioDir'
    __child__ = XMLSrc
    __element__ = 'Dummy'

    def __init__(self, core, datastore):
        Plugin.__init__(self, core, datastore)
        self.Entries[self.__element__] = {}
        try:
            DirectoryBacked.__init__(self, self.data, self.core.fam)
        except OSError:
            self.LogError("Failed to load %s indices" % (self.__element__.lower()))
            raise PluginInitError

    def HandleEvent(self, event):
        '''Handle events and update dispatch table'''
        DirectoryBacked.HandleEvent(self, event)
        for src in self.entries.values():
            for child in src.names:
                self.Entries[self.__element__][child] = self.BindEntry

    def BindEntry(self, entry, metadata):
        '''Check package lists of package entries'''
        [src.Cache(metadata) for src in self.entries.values()]
        name = entry.get('name')
        if not src.cache:
            self.LogError("Called before data loaded")
            raise PluginExecutionError
        matching = [src for src in self.entries.values()
                    if src.cache[1].has_key(name)]
        if len(matching) == 0:
            raise PluginExecutionError
        elif len(matching) == 1:
            index = 0
        else:
            prio = [int(src.priority) for src in matching]
            if prio.count(max(prio)) > 1:
                self.LogError("Found multiple %s sources with same priority for %s, pkg %s" %
                              (self.__element__.lower(), metadata.hostname, entry.get('name')))
                raise PluginExecutionError
            index = prio.index(max(prio))

        data = matching[index].cache[1][name]
        [entry.attrib.__setitem__(key, data[key]) for key in data.keys()]