source: ndgCommon/trunk/ndg/common/src/lib/ndgresources.py @ 6499

'''
Utility class providing access to various static resource files - e.g. 
xqueries and xsd schema docs

 @author: C Byrom, Tessella, Feb 09
'''
import pkg_resources
import re, logging
from ndg.common.src.models.ndgObject import ndgObject as no

# these are the different schemas needed to validate atom docs - NB, the main
# one is molesAtom1.0 - this imports the others
ATOM_MOLES_SCHEMA = "molesAtom1.0"
MOLES_SCHEMA = "moles2.0"
ATOM_SCHEMA = "atom1.0"

class ndgResources(object):
    
    def __init__(self, directory='xmldb/'):
        ''' 
        Loads up resources from the internal package directory
        @keyword directory: root directory from which to retrieve docs from.
        Default is 'xmldb/'
        '''
        logging.debug("Initialising ndgResources")
        self.__loadResources(directory)

        # provide mapping between ndgObject URI doc type name and xquery name
        # TODO: if we're going to replace the old moles1.3 entirely with the
        # atom based format, will need to implement atom2dif, atom2dc and atom2iso
        # queries
                '''
                no.DIF2stubISO:'dif2stubISO',
                                                   no.ISO2DIF:'ISO2DIF',
                                                   no.ISO2DC:'ISO2DC'
                                                   '''
        self.knownQueries={no.DIF_DOC_TYPE:'moles2dif',
                           no.DC_DOC_TYPE:'moles2DC',
                           no.ISO_DOC_TYPE:'moles2iso19139',
                           no.NDGB0_DOC_TYPE:'moles',
                           no.NDGB1_DOC_TYPE:'molesObjectType',
                           no.MDIP_DOC_TYPE:'moles2mdip', 
                           no.NDGA0_DOC_TYPE:'csml',
                           no.NUMSIM_DOC_TYPE:'numsim', 
                           no.ATOM_DOC_TYPE:'atom', 
                           no.ATOM_BACKUP_DOC_TYPE:'atom', 
                           no.ASSOCIATED_ATOM_DOC_TYPE:'atomTypeList',
                           no.BROWSE_DC_DOC_TYPE:'DIF2DC',
                           no.BROWSE_DIF_DOC_TYPE:'dif'
                                                   
                                                   }
        logging.debug("ndgResources initialised")


    def __loadResources(self, directory):
        '''
        Load the various resources
        @keyword directory: root directory from which to retrieve docs from.
        '''
        xqueryDir = directory + 'xquery'
        files=pkg_resources.resource_listdir('ndg.common', xqueryDir)
        # this next bit to get rid of .svn and anything else in testing
        self.xq = {}
        for f in files:
            if f.endswith('.xq'):
                self.xq[re.sub('.xq\Z','',f)] = \
                    pkg_resources.resource_string('ndg.common','%s/%s'%(xqueryDir,f))

        schemaDir = directory + 'schema'
        files=pkg_resources.resource_listdir('ndg.common', schemaDir)
        self.xsd = {}
        for f in files:
            if f.endswith('.xsd'):
                self.xsd[re.sub('.xsd\Z','',f)] = \
                    pkg_resources.resource_string('ndg.common','%s/%s'%(schemaDir, f))
                          
        # add the various xquery libraries, too
        self.xqlib = {}
        for dir in ['Vocabs', 'Utilities', 'StubB']:
            xqueryLibDir = xqueryDir + '/lib/' + dir
            files = pkg_resources.resource_listdir('ndg.common', xqueryLibDir)
            for f in files:
                if f.endswith('.xquery'): 
                    fullPath = '%s/%s'%(xqueryLibDir,f)
                    partPath = '/%s/%s' %(dir, f)
                    self.xqlib[partPath] = pkg_resources.resource_string('ndg.common', fullPath)
        
        # also add the organisation data files - NB, this class should be generalised
        # to make more sense...
        resourceDir = directory + 'resources'
        files = pkg_resources.resource_listdir('ndg.common', resourceDir)
        self.resources = {}
        for f in files:
            if f.endswith('.xml'): 
                self.resources[f] = \
                    pkg_resources.resource_string('ndg.common','%s/%s' %(resourceDir, f))

        # lastly, add the indexes
        self.indexes = {}
        for dir in ['eXist']:
            indexDir = directory + 'indexing' + '/' + dir
            files = pkg_resources.resource_listdir('ndg.common', indexDir)
            for f in files:
                if f.endswith('.xconf'): 
                    self.indexes[f] = \
                        pkg_resources.resource_string('ndg.common','%s/%s'%(indexDir,f))
        
        
    def createXQuery(self, key, targetCollection, repositoryID, localID):
        ''' 
        Return an actual xquery targetted for a specific localID, repositoryID and
        targetCollection 
        @param key: name of xquery to use
        @param targetCollection: target collection to use with xquery
        @param repositoryID: ID of the repository to use with the xquery
        @param localID: local ID of doc to lookup with xquery 
        @raise ValueError: if key is not a valid xquery
        @return xquery as a string
        '''
        logging.debug("Setting up %s xquery" %key)
        if not self.xq.has_key(key):
            raise ValueError("Unrecognised xquery type: '%s'" %key)
        
        xq=self.xq[key]
        xq=xq.replace('RepositoryID',repositoryID)
        xq=xq.replace('LocalID',localID)
        xq=xq.replace('TargetCollection',targetCollection)
        logging.debug("Xquery set up - returning")
        return xq