fgmeta/package.py

import os, subprocess
import sgprops
import hashlib # for MD5
import shutil # for copy2
import catalogTags

standardTagSet = frozenset(catalogTags.tags)
def isNonstandardTag(t):
    return t not in standardTagSet

thumbnailNames = ["thumbnail.png", "thumbnail.jpg"]

class VariantData:
    def __init__(self, path, node):
        #self._primary = primary
        self._path = path
        self._name = node.getValue("sim/description")
        if (not self._name):
            print "Missing description for " + path
            self._name = "Missing description:" + self.id

        # ratings

        # seperate thumbnails

    @property
    def name(self):
        return self._name

    @property
    def id(self):
        return self._path[:-8] # "remove -set.xml" (8 chars)

    @property
    def catalogNode(self):
        n = sgprops.Node("variant")
        n.addChild("id").value = self.id
        n.addChild("name").value = self.name
        return n

class PackageData:
    def __init__(self, path, scmRepo):
        self._path = path
        self._scm = scmRepo
        self._previousSCMRevision = None
        self._previousRevision = 0
        self._thumbnails = []
        self._variants = {}
        self._revision = 0
        self._md5 = None
        self._fileSize = 0
        self._primarySetXmlPath = None
        self._node = sgprops.Node("package")

    def setPreviousData(self, node):
        self._previousRevision = node.getValue("revision")
        self._previousMD5 = node.getValue("md5")
        self._previousSCMRevision = node.getValue("scm-revision")
        self._fileSize = int(node.getValue("file-size-bytes"))

    @property
    def id(self):
        return self._primarySetXmlPath

    @property
    def thumbnails(self):
        return self._thumbnails

    @property
    def path(self):
        return self._path

    @property
    def variants(self):
        return self._variants

    @property
    def scmRevision(self):
        currentRev = self._scm.scmRevisionForPath(self.path)
        if (currentRev is None):
            raise RuntimeError("Unable to query SCM revision of files")

        return currentRev

    @property
    def isSourceModified(self):
        if (self._previousSCMRevision == None):
            return True

        if (self._previousSCMRevision == self.scmRevision):
            return False

        return True

    def scanSetXmlFiles(self, includes):
        foundPrimary = False
        foundMultiple = False

        for f in os.listdir(self.path):
            if not f.endswith("-set.xml"):
                continue

            p = os.path.join(self.path, f)
            node = sgprops.readProps(p, includePaths = includes)
            if not node.hasChild("sim"):
                continue

            simNode = node.getChild("sim")
            # honour variosu exclusion flags
            if (simNode.getValue("exclude-from-catalog", False) or simNode.getValue("exclude-from-gui", False)):
                continue

            primary = simNode.getValue("variant-of", None)
            if primary:
                if not primary in self.variants:
                    self._variants[primary] = []
                self._variants[primary].append(VariantData(f, node))
                continue

            if foundPrimary:
                if not foundMultiple:
                    print "Multiple primary -set.xml files at:" + self.path
                    print "\t" + p
                    foundMultiple = True
                continue
            else:
                foundPrimary = True;
                self._primarySetXmlPath = f[:-8] # trim -set.xml

            self.parsePrimarySetNode(simNode)

            for n in thumbnailNames:
                if os.path.exists(os.path.join(self.path, n)):
                    self._thumbnails.append(n)

        if not foundPrimary:
            raise RuntimeError("No primary -set.xml found at:" + self.path)



    def parsePrimarySetNode(self, sim):

        # basic / mandatory values
        self._node.addChild('name').value = sim.getValue('description')

        longDesc = sim.getValue('long-description')
        if longDesc is not None:
            self._node.addChild('description').value = longDesc

        # copy all the standard values
        for p in ['status', 'author', 'license']:
            v = sim.getValue(p)
            if v is not None:
                self._node.addChild(p).value = v

        # ratings
        if sim.hasChild('rating'):
            pkgRatings = self._node.addChild('rating')
            for r in ['FDM', 'systems', 'cockpit', 'model']:
                pkgRatings.addChild(r).value = sim.getValue('rating/' + r, 0)

        # copy tags
        if sim.hasChild('tags'):
            for c in sim.getChild('tags').getChildren('tag'):
                if isNonstandardTag(c.value):
                    print "Skipping non-standard tag:", c.value, self.path
                else:
                    self._node.addChild('tag').value = c.value

        for t in sim.getChildren("thumbnail"):
            self._thumbnails.append(t.value)

    def validate(self):
        for t in self._thumbnails:
            if not os.path.exists(os.path.join(self.path, t)):
                raise RuntimeError("missing thumbnail:" + t);

    def generateZip(self, outDir, globalExcludePath):
        self._revision = self._previousRevision + 1

        baseName = os.path.basename(self.path)
        zipName = baseName + ".zip"
        zipFilePath = os.path.join(outDir, zipName)

        os.chdir(os.path.dirname(self.path))

        print "Creating zip", zipFilePath
        # anything we can do to make this faster?

        zipArgs = ['zip', '--quiet', '-r']
        if os.path.exists(globalExcludePath):
            zipArgs += [ "-x@" + globalExcludePath]

        excludePath = os.path.join(self.path, 'package-exclude.lst')
        if (os.path.exists(excludePath)):
            print self.id, "has zip exclude list"
            zipArgs += ["-x@" + excludePath]

        zipArgs += [zipFilePath, baseName]
        subprocess.call(zipArgs)

        zipFile = open(zipFilePath, 'r')
        self._md5 = hashlib.md5(zipFile.read()).hexdigest()
        self._fileSize = os.path.getsize(zipFilePath)

    def useExistingCatalogData(self):
        self._md5 = self._previousMD5

    def packageNode(self, mirrorUrls, thumbnailUrl):
        self._node.addChild("id").value = self.id
        self._node.getChild("md5", create = True).value = self._md5
        self._node.getChild("file-size-bytes", create = True).value = self._fileSize
        self._node.getChild("revision", create = True).value = int(self._revision)
        self._node.getChild("scm-revision", create = True).value = self.scmRevision

        baseName = os.path.basename(self.path)
        self._node.getChild("dir", create = True).value = baseName
        zipName = baseName + ".zip"

        for m in mirrorUrls:
            self._node.addChild("url").value = m + "/" + zipName

        for t in self._thumbnails:
            self._node.addChild("thumbnail-path").value = t
            self._node.addChild("thumbnail").value = thumbnailUrl + "/" + self.id + "_" + t

        for pr in self._variants:
            for vr in self._variants[pr]:
                self._node.addChild(vr.catalogNode)

        return self._node

    def extractThumbnails(self, thumbnailDir):
        for t in self._thumbnails:
            fullName = self.id + "_" + t
            shutil.copy2(os.path.join(self._path, t),
                         os.path.join(thumbnailDir, fullName)
                         )
            # TODO : verify image format, size and so on