1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
#!/usr/bin/env python
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.Description=""
far.Copyright=""
far.SpdFiles=""
far.FpdFile=""
far.ExtraFile=""
far = Far()
def parseMsa(msaFile, spdDir):
filelist = [msaFile]
msaDir = os.path.dirname(msaFile)
msa = xml.dom.minidom.parse(inWorkspace(os.path.join(spdDir, msaFile)))
xmlPaths = [
"/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))))
return filelist
def parseSpd(spdFile):
files = []
spdDir = os.path.dirname(spdFile)
spd = xml.dom.minidom.parse(inWorkspace(spdFile))
xmlPaths = [
"/PackageSurfaceArea/LibraryClassDeclarations/LibraryClass/IncludeHeader",
"/PackageSurfaceArea/IndustryStdIncludes/IndustryStdHeader/IncludeHeader",
"/PackageSurfaceArea/PackageHeaders/IncludePkgHeader" ]
for xmlPath in xmlPaths:
for f in XmlList(spd, xmlPath):
files.append(str(XmlElementData(f)))
for f in XmlList(spd, "/PackageSurfaceArea/MsaFiles/Filename"):
msaFile = str(XmlElementData(f))
files += parseMsa(msaFile, spdDir)
cwd = os.getcwd()
os.chdir(inWorkspace(spdDir))
for root, dirs, entries in os.walk("Include"):
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):
spd = xml.dom.minidom.parse(inWorkspace(spdFile))
return (XmlElement(spd, "/PackageSurfaceArea/SpdHeader/GuidValue"),
XmlElement(spd, "/PackageSurfaceArea/SpdHeader/Version"))
def makeFar(filelist, farname):
domImpl = xml.dom.minidom.getDOMImplementation()
man = domImpl.createDocument(None, "FrameworkArchiveManifest", None)
top_element = man.documentElement
top_element.appendChild(makeFarHeader(man))
packList = man.createElement("FarPackageList")
top_element.appendChild(packList)
platList = man.createElement("FarPlatformList")
top_element.appendChild(platList)
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:
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 = farFileNode(man, inWorkspace(infile))
zip.write(inWorkspace(infile), infile)
spdfilename.appendChild(man.createTextNode(infile))
package.appendChild(spdfilename)
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 = farFileNode(man, inWorkspace(os.path.join(spdDir, spdfile)))
zip.write(inWorkspace(os.path.join(spdDir, spdfile)), spdfile)
content.appendChild(man.createTextNode(spdfile))
packContents.appendChild(content)
elif extension == ".fpd":
platform = man.createElement("FarPlatform")
platList.appendChild(platform)
fpdfilename = farFileNode(man, inWorkspace(infile))
zip.write(inWorkspace(infile), infile)
platform.appendChild(fpdfilename)
fpdfilename.appendChild( man.createTextNode(infile) )
else:
content = farFileNode(man, inWorkspace(infile))
zip.write(inWorkspace(infile), infile)
content.appendChild(man.createTextNode(infile))
contents.appendChild(content)
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__':
# Create a pretty printer for dumping data structures in a readable form.
# pp = pprint.PrettyPrinter(indent=2)
# Process the command line args.
optlist, args = getopt.getopt(sys.argv[1:], 'hf:t:', [ 'template=', 'far=', 'help'])
for o, a in optlist:
if o in ["-h", "--help"]:
print """
Pass a list of .spd and .fpd files to be placed into a far for distribution.
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 treated as relative to the WORKSPACE
envirnonment variable which must be set to a valid workspace root directory.
""" % os.path.basename(sys.argv[0])
sys.exit()
if o in ["-t", "--template"]:
# The template file is processed first, so that command line options can
# override it.
templateName = a
execfile(templateName)
if o in ["-f", "--far"]:
far.FileName = a
if os.path.exists(far.FileName):
print "Error: File %s exists. Not overwriting." % far.FileName
sys.exit()
makeFar(args, far.FileName)
|
