Sync EDKII BaseTools to BaseTools project r1971

[mirror_edk2.git] / BaseTools / Source / Python / PackagingTool / PackageFile.py

## @file\r
#\r
# PackageFile class represents the zip file of a distribution package.\r
#\r
# Copyright (c) 2007, Intel Corporation. All rights reserved.<BR>\r
# This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
# which accompanies this distribution.  The full text of the license may be found at\r
# http://opensource.org/licenses/bsd-license.php\r
#\r
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
#\r
\r
##\r
# Import Modules\r
#\r
import os\r
import sys\r
import zipfile\r
import tempfile\r
\r
from Common import EdkLogger\r
from Common.Misc import *\r
from Common.BuildToolError import *\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, zipfile.ZIP_DEFLATED)\r
            self._Files = {}\r
            for F in self._ZipFile.namelist():\r
                self._Files[os.path.normpath(F)] = F\r
        except BaseException, X:\r
            EdkLogger.error("PackagingTool", FILE_OPEN_FAILURE, \r
                            ExtraData="%s (%s)" % (FileName, str(X)))\r
\r
        BadFile = self._ZipFile.testzip()\r
        if BadFile != None:\r
            EdkLogger.error("PackagingTool", FILE_CHECKSUM_FAILURE, \r
                            ExtraData="[%s] in %s" % (BadFile, FileName))\r
\r
    def __str__(self):\r
        return self._FileName\r
\r
    def Unpack(self, To):\r
        for F in self._ZipFile.namelist():\r
            ToFile = os.path.normpath(os.path.join(To, F))\r
            print F, "->", ToFile\r
            self.Extract(F, ToFile)\r
    \r
    def UnpackFile(self, File, ToFile):\r
        File = File.replace('\\', '/')\r
        if File in self._ZipFile.namelist():\r
            print File, "->", ToFile\r
            self.Extract(File, ToFile)\r
            \r
            return ToFile\r
        \r
        return ''\r
    \r
    def Extract(self, Which, To):\r
        Which = os.path.normpath(Which)\r
        if Which not in self._Files:\r
            EdkLogger.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, X:\r
            EdkLogger.error("PackagingTool", FILE_DECOMPRESS_FAILURE, \r
                            ExtraData="[%s] in %s (%s)" % (Which, self._FileName, str(X)))\r
        try:\r
            CreateDirectory(os.path.dirname(To))\r
            ToFile = open(To, "wb")\r
        except BaseException, X:\r
            EdkLogger.error("PackagingTool", FILE_OPEN_FAILURE, \r
                            ExtraData="%s (%s)" % (To, str(X)))\r
\r
        try:\r
            ToFile.write(FileContent)\r
            ToFile.close()\r
        except BaseException, X:\r
            EdkLogger.error("PackagingTool", FILE_WRITE_FAILURE, \r
                            ExtraData="%s (%s)" % (To, str(X)))\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 F in Files:\r
            F = os.path.normpath(F)\r
            if F not in self._Files:\r
                EdkLogger.error("PackagingTool", FILE_NOT_FOUND, \r
                                ExtraData="%s is not in %s!" % (F, self._FileName))\r
            #os.remove(os.path.join(TmpDir, F))  # no need to really remove file\r
            self._Files.pop(F)\r
        self._ZipFile.close()\r
\r
        self._ZipFile = zipfile.ZipFile(self._FileName, "w", 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
    def Pack(self, Top):\r
        if not os.path.isdir(Top):\r
            EdkLogger.error("PackagingTool", FILE_UNKNOWN_ERROR, "%s is not a directory!" %Top)\r
\r
        FilesToPack = []\r
        ParentDir = os.path.dirname(Top)\r
        BaseDir = os.path.basename(Top)\r
        Cwd = os.getcwd()\r
        os.chdir(ParentDir)\r
        for Root, Dirs, Files in os.walk(BaseDir):\r
            if 'CVS' in Dirs:\r
                Dirs.remove('CVS')\r
            if '.svn' in Dirs:\r
                Dirs.remove('.svn')\r
            for F in Files:\r
                FilesToPack.append(os.path.join(Root, F))\r
        self.PackFiles(FilesToPack)\r
        os.chdir(Cwd)\r
\r
    def PackFiles(self, Files):\r
        for F in Files:\r
            try:\r
                print "packing ...", F\r
                self._ZipFile.write(F)\r
            except BaseException, X:\r
                EdkLogger.error("PackagingTool", FILE_COMPRESS_FAILURE, \r
                                ExtraData="%s (%s)" % (F, str(X)))\r
\r
    def PackFile(self, File, ArcName=None):\r
        try:\r
            print "packing ...", File\r
            self._ZipFile.write(File, ArcName)\r
        except BaseException, X:\r
            EdkLogger.error("PackagingTool", FILE_COMPRESS_FAILURE,\r
                            ExtraData="%s (%s)" % (File, str(X)))\r
\r
    def PackData(self, Data, ArcName):\r
        try:\r
            self._ZipFile.writestr(ArcName, Data)\r
        except BaseException, X:\r
            EdkLogger.error("PackagingTool", FILE_COMPRESS_FAILURE,\r
                            ExtraData="%s (%s)" % (ArcName, str(X)))\r
\r
    def Close(self):\r
        self._ZipFile.close()\r
\r
if __name__ == '__main__':\r
    pass\r
\r