[mirror_edk2.git] / BaseTools / Source / Python / UPT / Core / PackageFile.py

## @file\r
#\r
# PackageFile class represents the zip file of a distribution package.\r
#\r
# Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
#\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
#\r
\r
'''\r
PackageFile\r
'''\r
\r
##\r
# Import Modules\r
#\r
import os.path\r
import zipfile\r
import tempfile\r
import platform\r
\r
from Logger.ToolError import FILE_OPEN_FAILURE\r
from Logger.ToolError import FILE_CHECKSUM_FAILURE\r
from Logger.ToolError import FILE_NOT_FOUND\r
from Logger.ToolError import FILE_DECOMPRESS_FAILURE\r
from Logger.ToolError import FILE_UNKNOWN_ERROR\r
from Logger.ToolError import FILE_WRITE_FAILURE\r
from Logger.ToolError import FILE_COMPRESS_FAILURE\r
import Logger.Log as Logger\r
from Logger import StringTable as ST\r
from Library.Misc import CreateDirectory\r
from Library.Misc import RemoveDirectory\r
from Core.FileHook import __FileHookOpen__\r
from Common.MultipleWorkspace import MultipleWorkspace as mws\r
\r
\r
class PackageFile:\r
    def __init__(self, FileName, Mode="r"):\r
        self._FileName = FileName\r
        if Mode not in ["r", "w", "a"]:\r
            Mode = "r"\r
        try:\r
            self._ZipFile = zipfile.ZipFile(FileName, Mode, \\r
                                            zipfile.ZIP_DEFLATED)\r
            self._Files = {}\r
            for Filename in self._ZipFile.namelist():\r
                self._Files[os.path.normpath(Filename)] = Filename\r
        except BaseException as Xstr:\r
            Logger.Error("PackagingTool", FILE_OPEN_FAILURE,\r
                            ExtraData="%s (%s)" % (FileName, str(Xstr)))\r
\r
        BadFile = self._ZipFile.testzip()\r
        if BadFile is not None:\r
            Logger.Error("PackagingTool", FILE_CHECKSUM_FAILURE,\r
                            ExtraData="[%s] in %s" % (BadFile, FileName))\r
\r
    def GetZipFile(self):\r
        return self._ZipFile\r
\r
    ## Get file name\r
    #\r
    def __str__(self):\r
        return self._FileName\r
\r
    ## Extract the file\r
    #\r
    # @param To:  the destination file\r
    #\r
    def Unpack(self, ToDest):\r
        for FileN in self._ZipFile.namelist():\r
            ToFile = os.path.normpath(os.path.join(ToDest, FileN))\r
            Msg = "%s -> %s" % (FileN, ToFile)\r
            Logger.Info(Msg)\r
            self.Extract(FileN, ToFile)\r
\r
    ## Extract the file\r
    #\r
    # @param File:  the extracted file\r
    # @param ToFile:  the destination file\r
    #\r
    def UnpackFile(self, File, ToFile):\r
        File = File.replace('\\', '/')\r
        if File in self._ZipFile.namelist():\r
            Msg = "%s -> %s" % (File, ToFile)\r
            Logger.Info(Msg)\r
            self.Extract(File, ToFile)\r
            return ToFile\r
\r
        return ''\r
\r
    ## Extract the file\r
    #\r
    # @param Which:  the source path\r
    # @param ToDest:  the destination path\r
    #\r
    def Extract(self, Which, ToDest):\r
        Which = os.path.normpath(Which)\r
        if Which not in self._Files:\r
            Logger.Error("PackagingTool", FILE_NOT_FOUND,\r
                            ExtraData="[%s] in %s" % (Which, self._FileName))\r
        try:\r
            FileContent = self._ZipFile.read(self._Files[Which])\r
        except BaseException as Xstr:\r
            Logger.Error("PackagingTool", FILE_DECOMPRESS_FAILURE,\r
                            ExtraData="[%s] in %s (%s)" % (Which, \\r
                                                           self._FileName, \\r
                                                           str(Xstr)))\r
        try:\r
            CreateDirectory(os.path.dirname(ToDest))\r
            if os.path.exists(ToDest) and not os.access(ToDest, os.W_OK):\r
                Logger.Warn("PackagingTool", \\r
                            ST.WRN_FILE_NOT_OVERWRITTEN % ToDest)\r
                return\r
            else:\r
                ToFile = __FileHookOpen__(ToDest, 'wb')\r
        except BaseException as Xstr:\r
            Logger.Error("PackagingTool", FILE_OPEN_FAILURE,\r
                            ExtraData="%s (%s)" % (ToDest, str(Xstr)))\r
\r
        try:\r
            ToFile.write(FileContent)\r
            ToFile.close()\r
        except BaseException as Xstr:\r
            Logger.Error("PackagingTool", FILE_WRITE_FAILURE,\r
                            ExtraData="%s (%s)" % (ToDest, str(Xstr)))\r
\r
    ## Remove the file\r
    #\r
    # @param Files:  the removed files\r
    #\r
    def Remove(self, Files):\r
        TmpDir = os.path.join(tempfile.gettempdir(), ".packaging")\r
        if os.path.exists(TmpDir):\r
            RemoveDirectory(TmpDir, True)\r
\r
        os.mkdir(TmpDir)\r
        self.Unpack(TmpDir)\r
        for SinF in Files:\r
            SinF = os.path.normpath(SinF)\r
            if SinF not in self._Files:\r
                Logger.Error("PackagingTool", FILE_NOT_FOUND,\r
                                ExtraData="%s is not in %s!" % \\r
                                (SinF, self._FileName))\r
            self._Files.pop(SinF)\r
        self._ZipFile.close()\r
\r
        self._ZipFile = zipfile.ZipFile(self._FileName, "w", \\r
                                        zipfile.ZIP_DEFLATED)\r
        Cwd = os.getcwd()\r
        os.chdir(TmpDir)\r
        self.PackFiles(self._Files)\r
        os.chdir(Cwd)\r
        RemoveDirectory(TmpDir, True)\r
\r
    ## Pack the files under Top directory, the directory shown in the zipFile start from BaseDir,\r
    # BaseDir should be the parent directory of the Top directory, for example,\r
    # Pack(Workspace\Dir1, Workspace) will pack files under Dir1, and the path in the zipfile will\r
    # start from Workspace\r
    #\r
    # @param Top:  the top directory\r
    # @param BaseDir:  the base directory\r
    #\r
    def Pack(self, Top, BaseDir):\r
        if not os.path.isdir(Top):\r
            Logger.Error("PackagingTool", FILE_UNKNOWN_ERROR, \\r
                         "%s is not a directory!" %Top)\r
\r
        FilesToPack = []\r
        Cwd = os.getcwd()\r
        os.chdir(BaseDir)\r
        RelaDir = Top[Top.upper().find(BaseDir.upper()).\\r
                      join(len(BaseDir).join(1)):]\r
\r
        for Root, Dirs, Files in os.walk(RelaDir):\r
            if 'CVS' in Dirs:\r
                Dirs.remove('CVS')\r
            if '.svn' in Dirs:\r
                Dirs.remove('.svn')\r
\r
            for Dir in Dirs:\r
                if Dir.startswith('.'):\r
                    Dirs.remove(Dir)\r
            for File1 in Files:\r
                if File1.startswith('.'):\r
                    continue\r
                ExtName = os.path.splitext(File1)[1]\r
                #\r
                # skip '.dec', '.inf', '.dsc', '.fdf' files\r
                #\r
                if ExtName.lower() in ['.dec', '.inf', '.dsc', '.fdf']:\r
                    continue\r
                FilesToPack.append(os.path.join(Root, File1))\r
        self.PackFiles(FilesToPack)\r
        os.chdir(Cwd)\r
\r
    ## Pack the file\r
    #\r
    # @param Files:  the files to pack\r
    #\r
    def PackFiles(self, Files):\r
        for File in Files:\r
            Cwd = os.getcwd()\r
            os.chdir(mws.getWs(mws.WORKSPACE, File))\r
            self.PackFile(File)\r
            os.chdir(Cwd)\r
\r
    ## Pack the file\r
    #\r
    # @param File:  the files to pack\r
    # @param ArcName:  the Arc Name\r
    #\r
    def PackFile(self, File, ArcName=None):\r
        try:\r
            #\r
            # avoid packing same file multiple times\r
            #\r
            if platform.system() != 'Windows':\r
                File = File.replace('\\', '/')\r
            ZipedFilesNameList = self._ZipFile.namelist()\r
            for ZipedFile in ZipedFilesNameList:\r
                if File == os.path.normpath(ZipedFile):\r
                    return\r
            Logger.Info("packing ..." + File)\r
            self._ZipFile.write(File, ArcName)\r
        except BaseException as Xstr:\r
            Logger.Error("PackagingTool", FILE_COMPRESS_FAILURE,\r
                            ExtraData="%s (%s)" % (File, str(Xstr)))\r
\r
    ## Write data to the packed file\r
    #\r
    # @param Data:  data to write\r
    # @param ArcName:  the Arc Name\r
    #\r
    def PackData(self, Data, ArcName):\r
        try:\r
            if os.path.splitext(ArcName)[1].lower() == '.pkg':\r
                Data = Data.encode('utf_8')\r
            self._ZipFile.writestr(ArcName, Data)\r
        except BaseException as Xstr:\r
            Logger.Error("PackagingTool", FILE_COMPRESS_FAILURE,\r
                            ExtraData="%s (%s)" % (ArcName, str(Xstr)))\r
\r
    ## Close file\r
    #\r
    #\r
    def Close(self):\r
        self._ZipFile.close()\r
\r
\r
\r
Commit	Line	Data
4234283c LG	1	## @file\r
	2	#\r
	3	# PackageFile class represents the zip file of a distribution package.\r
	4	#\r
f7496d71	5	# Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
4234283c	6	#\r
2e351cbe	7	# SPDX-License-Identifier: BSD-2-Clause-Patent\r
4234283c LG	8	#\r
	9	\r
	10	'''\r
	11	PackageFile\r
	12	'''\r
	13	\r
	14	##\r
	15	# Import Modules\r
	16	#\r
	17	import os.path\r
	18	import zipfile\r
	19	import tempfile\r
	20	import platform\r
	21	\r
	22	from Logger.ToolError import FILE_OPEN_FAILURE\r
	23	from Logger.ToolError import FILE_CHECKSUM_FAILURE\r
	24	from Logger.ToolError import FILE_NOT_FOUND\r
	25	from Logger.ToolError import FILE_DECOMPRESS_FAILURE\r
	26	from Logger.ToolError import FILE_UNKNOWN_ERROR\r
	27	from Logger.ToolError import FILE_WRITE_FAILURE\r
	28	from Logger.ToolError import FILE_COMPRESS_FAILURE\r
	29	import Logger.Log as Logger\r
	30	from Logger import StringTable as ST\r
	31	from Library.Misc import CreateDirectory\r
	32	from Library.Misc import RemoveDirectory\r
421ccda3	33	from Core.FileHook import __FileHookOpen__\r
fb0f8067	34	from Common.MultipleWorkspace import MultipleWorkspace as mws\r
4234283c LG	35	\r
	36	\r
	37	class PackageFile:\r
	38	def __init__(self, FileName, Mode="r"):\r
	39	self._FileName = FileName\r
	40	if Mode not in ["r", "w", "a"]:\r
	41	Mode = "r"\r
	42	try:\r
	43	self._ZipFile = zipfile.ZipFile(FileName, Mode, \\r
	44	zipfile.ZIP_DEFLATED)\r
	45	self._Files = {}\r
	46	for Filename in self._ZipFile.namelist():\r
	47	self._Files[os.path.normpath(Filename)] = Filename\r
5b0671c1	48	except BaseException as Xstr:\r
f7496d71	49	Logger.Error("PackagingTool", FILE_OPEN_FAILURE,\r
4234283c LG	50	ExtraData="%s (%s)" % (FileName, str(Xstr)))\r
	51	\r
	52	BadFile = self._ZipFile.testzip()\r
4231a819	53	if BadFile is not None:\r
f7496d71	54	Logger.Error("PackagingTool", FILE_CHECKSUM_FAILURE,\r
4234283c	55	ExtraData="[%s] in %s" % (BadFile, FileName))\r
f7496d71	56	\r
4234283c LG	57	def GetZipFile(self):\r
4234283c LG	58	return self._ZipFile\r
f7496d71 LG	59	\r
f7496d71 LG	60	## Get file name\r
4234283c LG	61	#\r
	62	def __str__(self):\r
	63	return self._FileName\r
f7496d71	64	\r
4234283c	65	## Extract the file\r
f7496d71 LG	66	#\r
f7496d71 LG	67	# @param To: the destination file\r
4234283c LG	68	#\r
	69	def Unpack(self, ToDest):\r
	70	for FileN in self._ZipFile.namelist():\r
	71	ToFile = os.path.normpath(os.path.join(ToDest, FileN))\r
	72	Msg = "%s -> %s" % (FileN, ToFile)\r
	73	Logger.Info(Msg)\r
	74	self.Extract(FileN, ToFile)\r
f7496d71	75	\r
4234283c	76	## Extract the file\r
f7496d71 LG	77	#\r
	78	# @param File: the extracted file\r
	79	# @param ToFile: the destination file\r
4234283c LG	80	#\r
	81	def UnpackFile(self, File, ToFile):\r
	82	File = File.replace('\\', '/')\r
	83	if File in self._ZipFile.namelist():\r
	84	Msg = "%s -> %s" % (File, ToFile)\r
	85	Logger.Info(Msg)\r
	86	self.Extract(File, ToFile)\r
	87	return ToFile\r
f7496d71	88	\r
4234283c	89	return ''\r
f7496d71	90	\r
4234283c	91	## Extract the file\r
f7496d71 LG	92	#\r
	93	# @param Which: the source path\r
	94	# @param ToDest: the destination path\r
4234283c LG	95	#\r
	96	def Extract(self, Which, ToDest):\r
	97	Which = os.path.normpath(Which)\r
	98	if Which not in self._Files:\r
	99	Logger.Error("PackagingTool", FILE_NOT_FOUND,\r
	100	ExtraData="[%s] in %s" % (Which, self._FileName))\r
	101	try:\r
	102	FileContent = self._ZipFile.read(self._Files[Which])\r
5b0671c1	103	except BaseException as Xstr:\r
f7496d71	104	Logger.Error("PackagingTool", FILE_DECOMPRESS_FAILURE,\r
4234283c LG	105	ExtraData="[%s] in %s (%s)" % (Which, \\r
	106	self._FileName, \\r
	107	str(Xstr)))\r
	108	try:\r
	109	CreateDirectory(os.path.dirname(ToDest))\r
	110	if os.path.exists(ToDest) and not os.access(ToDest, os.W_OK):\r
	111	Logger.Warn("PackagingTool", \\r
	112	ST.WRN_FILE_NOT_OVERWRITTEN % ToDest)\r
	113	return\r
421ccda3 HC	114	else:\r
421ccda3 HC	115	ToFile = __FileHookOpen__(ToDest, 'wb')\r
5b0671c1	116	except BaseException as Xstr:\r
f7496d71	117	Logger.Error("PackagingTool", FILE_OPEN_FAILURE,\r
4234283c LG	118	ExtraData="%s (%s)" % (ToDest, str(Xstr)))\r
	119	\r
	120	try:\r
	121	ToFile.write(FileContent)\r
	122	ToFile.close()\r
5b0671c1	123	except BaseException as Xstr:\r
f7496d71	124	Logger.Error("PackagingTool", FILE_WRITE_FAILURE,\r
4234283c LG	125	ExtraData="%s (%s)" % (ToDest, str(Xstr)))\r
	126	\r
	127	## Remove the file\r
f7496d71 LG	128	#\r
f7496d71 LG	129	# @param Files: the removed files\r
4234283c LG	130	#\r
	131	def Remove(self, Files):\r
	132	TmpDir = os.path.join(tempfile.gettempdir(), ".packaging")\r
	133	if os.path.exists(TmpDir):\r
	134	RemoveDirectory(TmpDir, True)\r
	135	\r
	136	os.mkdir(TmpDir)\r
	137	self.Unpack(TmpDir)\r
	138	for SinF in Files:\r
	139	SinF = os.path.normpath(SinF)\r
	140	if SinF not in self._Files:\r
f7496d71	141	Logger.Error("PackagingTool", FILE_NOT_FOUND,\r
4234283c LG	142	ExtraData="%s is not in %s!" % \\r
	143	(SinF, self._FileName))\r
	144	self._Files.pop(SinF)\r
	145	self._ZipFile.close()\r
	146	\r
	147	self._ZipFile = zipfile.ZipFile(self._FileName, "w", \\r
	148	zipfile.ZIP_DEFLATED)\r
	149	Cwd = os.getcwd()\r
	150	os.chdir(TmpDir)\r
	151	self.PackFiles(self._Files)\r
	152	os.chdir(Cwd)\r
	153	RemoveDirectory(TmpDir, True)\r
	154	\r
	155	## Pack the files under Top directory, the directory shown in the zipFile start from BaseDir,\r
f7496d71 LG	156	# BaseDir should be the parent directory of the Top directory, for example,\r
f7496d71 LG	157	# Pack(Workspace\Dir1, Workspace) will pack files under Dir1, and the path in the zipfile will\r
4234283c	158	# start from Workspace\r
f7496d71 LG	159	#\r
	160	# @param Top: the top directory\r
	161	# @param BaseDir: the base directory\r
4234283c LG	162	#\r
	163	def Pack(self, Top, BaseDir):\r
	164	if not os.path.isdir(Top):\r
	165	Logger.Error("PackagingTool", FILE_UNKNOWN_ERROR, \\r
	166	"%s is not a directory!" %Top)\r
	167	\r
	168	FilesToPack = []\r
	169	Cwd = os.getcwd()\r
	170	os.chdir(BaseDir)\r
	171	RelaDir = Top[Top.upper().find(BaseDir.upper()).\\r
f7496d71	172	join(len(BaseDir).join(1)):]\r
4234283c LG	173	\r
	174	for Root, Dirs, Files in os.walk(RelaDir):\r
	175	if 'CVS' in Dirs:\r
	176	Dirs.remove('CVS')\r
	177	if '.svn' in Dirs:\r
	178	Dirs.remove('.svn')\r
f7496d71	179	\r
4234283c LG	180	for Dir in Dirs:\r
	181	if Dir.startswith('.'):\r
	182	Dirs.remove(Dir)\r
	183	for File1 in Files:\r
	184	if File1.startswith('.'):\r
	185	continue\r
	186	ExtName = os.path.splitext(File1)[1]\r
	187	#\r
	188	# skip '.dec', '.inf', '.dsc', '.fdf' files\r
	189	#\r
	190	if ExtName.lower() in ['.dec', '.inf', '.dsc', '.fdf']:\r
	191	continue\r
	192	FilesToPack.append(os.path.join(Root, File1))\r
	193	self.PackFiles(FilesToPack)\r
	194	os.chdir(Cwd)\r
	195	\r
	196	## Pack the file\r
f7496d71 LG	197	#\r
f7496d71 LG	198	# @param Files: the files to pack\r
4234283c LG	199	#\r
4234283c LG	200	def PackFiles(self, Files):\r
fb0f8067 HC	201	for File in Files:\r
	202	Cwd = os.getcwd()\r
	203	os.chdir(mws.getWs(mws.WORKSPACE, File))\r
	204	self.PackFile(File)\r
	205	os.chdir(Cwd)\r
4234283c LG	206	\r
4234283c LG	207	## Pack the file\r
f7496d71 LG	208	#\r
	209	# @param File: the files to pack\r
	210	# @param ArcName: the Arc Name\r
4234283c LG	211	#\r
	212	def PackFile(self, File, ArcName=None):\r
	213	try:\r
	214	#\r
	215	# avoid packing same file multiple times\r
	216	#\r
	217	if platform.system() != 'Windows':\r
f7496d71	218	File = File.replace('\\', '/')\r
4234283c LG	219	ZipedFilesNameList = self._ZipFile.namelist()\r
	220	for ZipedFile in ZipedFilesNameList:\r
	221	if File == os.path.normpath(ZipedFile):\r
	222	return\r
	223	Logger.Info("packing ..." + File)\r
	224	self._ZipFile.write(File, ArcName)\r
5b0671c1	225	except BaseException as Xstr:\r
4234283c LG	226	Logger.Error("PackagingTool", FILE_COMPRESS_FAILURE,\r
	227	ExtraData="%s (%s)" % (File, str(Xstr)))\r
	228	\r
	229	## Write data to the packed file\r
f7496d71 LG	230	#\r
	231	# @param Data: data to write\r
	232	# @param ArcName: the Arc Name\r
4234283c LG	233	#\r
	234	def PackData(self, Data, ArcName):\r
	235	try:\r
421ccda3 HC	236	if os.path.splitext(ArcName)[1].lower() == '.pkg':\r
421ccda3 HC	237	Data = Data.encode('utf_8')\r
4234283c	238	self._ZipFile.writestr(ArcName, Data)\r
5b0671c1	239	except BaseException as Xstr:\r
4234283c LG	240	Logger.Error("PackagingTool", FILE_COMPRESS_FAILURE,\r
	241	ExtraData="%s (%s)" % (ArcName, str(Xstr)))\r
	242	\r
	243	## Close file\r
f7496d71	244	#\r
4234283c LG	245	#\r
	246	def Close(self):\r
	247	self._ZipFile.close()\r
	248	\r
	249	\r
	250	\r