X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=Tools%2FPython%2FMkFar.py;h=327c81a94a28e3033128fbb91ab7f5ed5ce64f43;hp=105f1f49dee16e1a152319d477bf2a7c8727be2a;hb=6e73f334d9fb98a532e602feee487f7310899060;hpb=d0f7ef3eb2c5dad621356b768d0ab4959decb6d3

diff --git a/Tools/Python/MkFar.py b/Tools/Python/MkFar.py
index 105f1f49de..327c81a94a 100755
--- a/Tools/Python/MkFar.py
+++ b/Tools/Python/MkFar.py
@@ -1,20 +1,38 @@
 #!/usr/bin/env python
 
-import os, sys, re, getopt, string, glob, xml.dom.minidom, pprint, zipfile, tempfile
+import os, sys, getopt, string, xml.dom.minidom, zipfile, md5
 from XmlRoutines import *
 from WorkspaceRoutines import *
 
+class Far:
+  """This class is used to collect arbitrarty data from the template file."""
+  def __init__(far):
+    """Assign the default values for the far fields."""
+    far.FileName = "output.far"
+    far.FarName=""
+    far.Version=""
+    far.License=""
+    far.Abstract=""
+    far.Description=""
+    far.Copyright=""
+    far.SpdFiles=[]
+    far.FpdFiles=[]
+    far.ExtraFiles=[]
+
+far = Far()
+
 def parseMsa(msaFile, spdDir):
 
   filelist = [msaFile]
 
   msaDir = os.path.dirname(msaFile)
 
-  msa = xml.dom.minidom.parse(inWorkspace(msaFile))
+  msa = xml.dom.minidom.parse(inWorkspace(os.path.join(spdDir, msaFile)))
 
   xmlPaths = [
-    "/ModuleSurfaceArea/SourceFiles/Filename" ]
-
+    "/ModuleSurfaceArea/SourceFiles/Filename",
+    "/ModuleSurfaceArea/NonProcessedFiles/Filename" ]
+    
   for xmlPath in xmlPaths:
     for f in XmlList(msa, xmlPath):
       filelist.append(str(os.path.join(msaDir, XmlElementData(f))))
@@ -23,8 +41,7 @@ def parseMsa(msaFile, spdDir):
 
 def parseSpd(spdFile):
 
-  filelist = [spdFile]
-  msaFileList = []
+  files = []
 
   spdDir = os.path.dirname(spdFile)
 
@@ -33,26 +50,73 @@ def parseSpd(spdFile):
   xmlPaths = [
     "/PackageSurfaceArea/LibraryClassDeclarations/LibraryClass/IncludeHeader",
     "/PackageSurfaceArea/IndustryStdIncludes/IndustryStdHeader/IncludeHeader",
-    "/PackageSurfaceArea/<PackageHeaders/IncludePkgHeader" ]
+    "/PackageSurfaceArea/PackageHeaders/IncludePkgHeader" ]
 
   for xmlPath in xmlPaths:
     for f in XmlList(spd, xmlPath):
-      filelist.append(str(os.path.join(spdDir, XmlElementData(f))))
+      files.append(str(XmlElementData(f)))
 
   for f in XmlList(spd, "/PackageSurfaceArea/MsaFiles/Filename"):
-    msaFile = str(os.path.join(spdDir, XmlElementData(f)))
-    filelist += parseMsa(msaFile, spdDir)
+    msaFile = str(XmlElementData(f))
+    files += parseMsa(msaFile, spdDir)
+
+  cwd = os.getcwd()
+  os.chdir(inWorkspace(spdDir))
+  for root, dirs, entries in os.walk("Include"):
+    # Some files need to be skipped.
+    for r in ["CVS", ".svn"]:
+      if r in dirs:
+        dirs.remove(r)
+    for entry in entries:
+      files.append(os.path.join(os.path.normpath(root), entry))
+  os.chdir(cwd)
+
+  return files
+
+def makeFarHeader(doc):
+
+  header = doc.createElement("FarHeader")
+  name = doc.createElement("FarName")
+  name.appendChild(doc.createTextNode(far.FarName))
+  header.appendChild(name)
+  guidVal = doc.createElement("GuidValue")
+  guidVal.appendChild(doc.createTextNode(genguid()))
+  header.appendChild(guidVal)
+  ver = doc.createElement("Version")
+  ver.appendChild(doc.createTextNode(far.Version))
+  header.appendChild(ver)
+  abstract = doc.createElement("Abstract")
+  abstract.appendChild(doc.createTextNode(far.Abstract))
+  header.appendChild(abstract)
+  desc = doc.createElement("Description")
+  desc.appendChild(doc.createTextNode(far.Description))
+  header.appendChild(desc)
+  copy = doc.createElement("Copyright")
+  copy.appendChild(doc.createTextNode(far.Copyright))
+  header.appendChild(copy)
+  lic = doc.createElement("License")
+  lic.appendChild(doc.createTextNode(far.License))
+  header.appendChild(lic)
+  spec = doc.createElement("Specification")
+  spec.appendChild(doc.createTextNode("FRAMEWORK_BUILD_PACKAGING_SPECIFICATION 0x00000052"))
+  header.appendChild(spec)
+
+  return header
+
+def getSpdGuidVersion(spdFile):
 
-  return filelist
+  spd = xml.dom.minidom.parse(inWorkspace(spdFile))
+
+  return (XmlElement(spd, "/PackageSurfaceArea/SpdHeader/GuidValue"),
+          XmlElement(spd, "/PackageSurfaceArea/SpdHeader/Version"))
 
-def makeFar(filelist, farname):
+def makeFar(files, farname):
 
   domImpl = xml.dom.minidom.getDOMImplementation()
   man = domImpl.createDocument(None, "FrameworkArchiveManifest", None)
   top_element = man.documentElement
 
-  header = man.createElement("FarHeader")
-  top_element.appendChild(header)
+  top_element.appendChild(makeFarHeader(man))
 
   packList = man.createElement("FarPackageList")
   top_element.appendChild(packList)
@@ -63,47 +127,82 @@ def makeFar(filelist, farname):
   contents = man.createElement("Contents")
   top_element.appendChild(contents)
 
+  exts = man.createElement("UserExtensions")
+  top_element.appendChild(exts)
+
   zip = zipfile.ZipFile(farname, "w")
-  for infile in filelist:
+  for infile in set(files):
     if not os.path.exists(inWorkspace(infile)):
       print "Skipping non-existent file '%s'." % infile
     (_, extension) = os.path.splitext(infile)
     if extension == ".spd":
       filelist = parseSpd(infile)
+      spdDir = os.path.dirname(infile)
+
+      (spdGuid, spdVersion) = getSpdGuidVersion(infile)
 
       package = man.createElement("FarPackage")
       packList.appendChild(package)
 
-      spdfilename = man.createElement("FarFilename")
+      spdfilename = farFileNode(man, inWorkspace(infile))
+      zip.write(inWorkspace(infile), infile)
+      spdfilename.appendChild(man.createTextNode(lean(infile)))
       package.appendChild(spdfilename)
 
-      spdfilename.appendChild( man.createTextNode(infile) )
+      guidValue = man.createElement("GuidValue")
+      guidValue.appendChild(man.createTextNode(spdGuid))
+      package.appendChild(guidValue)
+
+      version = man.createElement("Version")
+      version.appendChild(man.createTextNode(spdVersion))
+      package.appendChild(version)
+
+      defaultPath = man.createElement("DefaultPath")
+      defaultPath.appendChild(man.createTextNode(spdDir))
+      package.appendChild(defaultPath)
+
+      farPlatformList = man.createElement("FarPlatformList")
+      package.appendChild(farPlatformList)
+
+      packContents = man.createElement("Contents")
+      package.appendChild(packContents)
+
+      ue = man.createElement("UserExtensions")
+      package.appendChild(ue)
 
       for spdfile in filelist:
-        content = man.createElement("FarFilename")
-        content.appendChild( man.createTextNode(spdfile))
-        contents.appendChild(content)
+        content = farFileNode(man, inWorkspace(os.path.join(spdDir, spdfile))) 
+        zip.write(inWorkspace(os.path.join(spdDir, spdfile)), spdfile)
+        content.appendChild(man.createTextNode(lean(spdfile)))
+        packContents.appendChild(content)
 
     elif extension == ".fpd":
-      filelist = [infile]
 
       platform = man.createElement("FarPlatform")
       platList.appendChild(platform)
 
-      fpdfilename = man.createElement("FarFilename")
+      fpdfilename = farFileNode(man, inWorkspace(infile))
+      zip.write(inWorkspace(infile), infile)
       platform.appendChild(fpdfilename)
-
-      fpdfilename.appendChild( man.createTextNode(infile) )
+      fpdfilename.appendChild(man.createTextNode(lean(infile)))
 
     else:
-      filelist = []
+      content = farFileNode(man, inWorkspace(infile))
+      zip.write(inWorkspace(infile), infile)
+      content.appendChild(man.createTextNode(lean(infile)))
+      contents.appendChild(content)
 
-    for f in set(filelist):
-      zip.write(inWorkspace(f), f)
   zip.writestr("FrameworkArchiveManifest.xml", man.toprettyxml(2*" "))
   zip.close()
   return
 
+def farFileNode(doc, filename):
+  content = doc.createElement("FarFilename")
+  f=open(filename, "rb")
+  content.setAttribute("Md5sum", md5.md5(f.read()).hexdigest())
+  f.close()
+  return content
+
 # This acts like the main() function for the script, unless it is 'import'ed
 # into another script.
 if __name__ == '__main__':
@@ -111,12 +210,10 @@ if __name__ == '__main__':
   # Create a pretty printer for dumping data structures in a readable form.
   # pp = pprint.PrettyPrinter(indent=2)
 
-  # Default name for far file.
-  farName = "output.far"
-
   # Process the command line args.
-  optlist, args = getopt.getopt(sys.argv[1:], 'hf:', [ 'far=', 'help'])
+  optlist, args = getopt.getopt(sys.argv[1:], 'hf:t:', [ 'template=', 'far=', 'help'])
 
+  # First pass through the options list.
   for o, a in optlist:
     if o in ["-h", "--help"]:
       print """
@@ -125,12 +222,29 @@ You may give the name of the far with a -f or --far option. For example:
 
   %s --far library.far MdePkg/MdePkg.spd
 
-The file paths of .spd and .fpd are relative to the WORKSPACE envirnonment
-which must be set to a valid workspace root directory.
+The file paths of .spd and .fpd are treated as relative to the WORKSPACE
+environment variable which must be set to a valid workspace root directory.
 """ % os.path.basename(sys.argv[0])
 
       sys.exit()
+      optlist.remove((o,a))
+    if o in ["-t", "--template"]:
+      # The template file is processed first, so that command line options can
+      # override it.
+      templateName = a
+      execfile(templateName)
+      optlist.remove((o,a))
+
+  # Second pass through the options list. These can override the first pass.
+  for o, a in optlist:
+    print o, a
     if o in ["-f", "--far"]:
-      farName = a
+      far.FileName = a
+
+  # Let's err on the side of caution and not let people blow away data 
+  # accidentally.
+  if os.path.exists(far.FileName):
+    print "Error: File %s exists. Not overwriting." % far.FileName
+    sys.exit()
 
-  makeFar(args, farName)
+  makeFar(far.SpdFiles + far.FpdFiles + far.ExtraFiles + args, far.FileName)