source: collective.imstransport/trunk/collective/imstransport/utilities/bb/imsbbreader.py @ 335

from collective.imstransport.utilities.imsinterchange import IMSReader
from collective.imstransport.utilities.packagingio import ZipfileReader
from collective.imstransport.utilities.bb.bbreader import BBReader
from zope.component import getUtility
from collective.imstransport.utilities.interfaces import IIMSObjectCreator
from xml.parsers.expat import ExpatError
from collective.imstransport.IMS_exceptions import ManifestError
import re

class IMSBBReader(IMSReader):
    """ Create objects from IMS manifest. """

    def readPackage(self, file, context):
        """ Read the manifest """
        source = ZipfileReader(file)
        objDict = {}
        if not source:
             return False, 'Internal error. No source object specified'
        bbreader = BBReader()
        manifest = source.readManifest()
        if not manifest:
            raise ManifestError, 'Could not locate manifest file "imsmanifest.xml" in the zip archive.'
        try:
            doc = bbreader.parseManifest(manifest)
        except ExpatError, e:
            raise ManifestError, str(e)
        tocpages = []
        orgs = bbreader.readOrganizations(doc)
        resources = bbreader.readResources(doc)
        for x in resources:
            resid, restype, bbfile, bbtitle, bbase = bbreader.readResourceAttributes(x)
            if restype == 'resource/x-bb-document':
                metadata = {}
                # read the data file
                if bbfile:
                    dataxml = source.readFile(bbfile)
                    resnode = bbreader.parseDataFile(dataxml)
                    metadata = bbreader.readMetadata(resnode)
                files = bbreader.readFiles(x)
                # If the resource is a file
                if files:
                    hash = resid
                    objDict[hash] = metadata
                    excludeFromNav = True
                    file = '%s/%s' %(bbase, files[0])
                    type = self.determineType(objDict[hash], files[0])
                    id = self.createIdFromFile(files[0])
                    path = '%s' %bbase
                    if orgs.has_key(resid):
                        title = orgs[resid]
                    else:
                        title = id
                    self.applyCoreMetadata(objDict, hash, id, path, excludeFromNav, type, title, file=file)
                # If the resource is a document
                else:
                    hash = resid 
                    objDict[hash] = metadata
                    excludeFromNav = True
                    type = 'Document'
                    id = resid
                    path = ''
                    if orgs.has_key(resid):
                        title = orgs[resid]
                    else:
                        title = id
                    self.applyCoreMetadata(objDict, hash, id, path, excludeFromNav, type, title)
            # The resource is a table of contents page.
            elif restype == 'course/x-bb-coursetoc':
                hash = resid
                objDict[hash] = {}
                excludeFromNav = False
                tocpages.append(resid)
                type = 'Document'
                path = ''
                id = resid
                if orgs.has_key(resid):
                    title = re.sub('(((?<=[a-z])[A-Z])|([A-Z](?![A-Z]|$)))', ' \\1', orgs[resid].split('.')[1])
                else:
                    title = id
                self.applyCoreMetadata(objDict, hash, id, path, excludeFromNav, type, title)

            # Build table of contents pages
        for z in tocpages:
            text = '<table>'
            tocitems = bbreader.readTocItem(doc, z)
            for titem in tocitems:
                met = objDict[titem]
                path = met['path']
                if path:
                    linkpath = '%s/%s' %(path, objDict[titem]['id'])
                else:
                    linkpath = objDict[titem]['id']
                text += "<tr><td><a href='%s/view'>%s</a></td></tr>" %(linkpath, objDict[titem]['title'])
            text += '</table>'
            objDict[z]['text'] = text
                
        objcreator = getUtility(IIMSObjectCreator)
        objcreator.createObjects(objDict, context, source)

    def applyCoreMetadata(self, objDict, hash, id, path, excludeFromNav, type, title, file=None, text=None):
        """ Helper function for applying metadata """
        objDict[hash]['id'] = id
        objDict[hash]['path'] = path
        objDict[hash]['excludeFromNav'] = excludeFromNav
        if not (objDict[hash].has_key('type') and objDict[hash]['type']):
            objDict[hash]['type'] = type
        if not (objDict[hash].has_key('title') and objDict[hash]['title']):
            objDict[hash]['title'] = title
        if file:
            objDict[hash]['file'] =  file
        if text:
            objDict[hash]['text'] = text