BaseTools: Clean up source files

[mirror_edk2.git] / BaseTools / Source / Python / UPT / ReplacePkg.py

## @file\r
# Replace distribution package.\r
#\r
# Copyright (c) 2014 - 2018, Intel Corporation. All rights reserved.<BR>\r
#\r
# This program and the accompanying materials are licensed and made available\r
# under the terms and conditions of the BSD License which accompanies this\r
# 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
Replace a distribution package\r
"""\r
##\r
# Import Modules\r
#\r
from shutil import rmtree\r
from traceback import format_exc\r
from platform import python_version\r
from sys import platform\r
from Logger import StringTable as ST\r
from Logger.ToolError import UNKNOWN_ERROR\r
from Logger.ToolError import FatalError\r
from Logger.ToolError import ABORT_ERROR\r
from Logger.ToolError import CODE_ERROR\r
from Logger.ToolError import UPT_ALREADY_INSTALLED_ERROR\r
import Logger.Log as Logger\r
\r
from Core.DependencyRules import DependencyRules\r
from Library import GlobalData\r
from InstallPkg import UnZipDp\r
from InstallPkg import InstallDp\r
from RmPkg import GetInstalledDpInfo\r
from RmPkg import RemoveDist\r
\r
## Tool entrance method\r
#\r
# This method mainly dispatch specific methods per the command line options.\r
# If no error found, return zero value so the caller of this tool can know\r
# if it's executed successfully or not.\r
#\r
# @param  Options: command Options\r
#\r
def Main(Options = None):\r
    ContentZipFile, DistFile = None, None\r
    try:\r
        DataBase = GlobalData.gDB\r
        WorkspaceDir = GlobalData.gWORKSPACE\r
        Dep = DependencyRules(DataBase)\r
        DistPkg, ContentZipFile, DpPkgFileName, DistFile = UnZipDp(WorkspaceDir, Options.PackFileToReplace)\r
\r
        StoredDistFile, OrigDpGuid, OrigDpVersion = GetInstalledDpInfo(Options.PackFileToBeReplaced, \\r
                                                                       Dep, DataBase, WorkspaceDir)\r
\r
        #\r
        # check dependency\r
        #\r
        CheckReplaceDpx(Dep, DistPkg, OrigDpGuid, OrigDpVersion)\r
\r
        #\r
        # Remove the old distribution\r
        #\r
        RemoveDist(OrigDpGuid, OrigDpVersion, StoredDistFile, DataBase, WorkspaceDir, Options.Yes)\r
\r
        #\r
        # Install the new distribution\r
        #\r
        InstallDp(DistPkg, DpPkgFileName, ContentZipFile, Options, Dep, WorkspaceDir, DataBase)\r
        ReturnCode = 0\r
\r
    except FatalError as XExcept:\r
        ReturnCode = XExcept.args[0]\r
        if Logger.GetLevel() <= Logger.DEBUG_9:\r
            Logger.Quiet(ST.MSG_PYTHON_ON % (python_version(),\r
                platform) + format_exc())\r
    except KeyboardInterrupt:\r
        ReturnCode = ABORT_ERROR\r
        if Logger.GetLevel() <= Logger.DEBUG_9:\r
            Logger.Quiet(ST.MSG_PYTHON_ON % (python_version(),\r
                platform) + format_exc())\r
    except:\r
        ReturnCode = CODE_ERROR\r
        Logger.Error(\r
                    "\nReplacePkg",\r
                    CODE_ERROR,\r
                    ST.ERR_UNKNOWN_FATAL_REPLACE_ERR % (Options.PackFileToReplace, Options.PackFileToBeReplaced),\r
                    ExtraData=ST.MSG_SEARCH_FOR_HELP,\r
                    RaiseError=False\r
                    )\r
        Logger.Quiet(ST.MSG_PYTHON_ON % (python_version(),\r
            platform) + format_exc())\r
\r
    finally:\r
        Logger.Quiet(ST.MSG_REMOVE_TEMP_FILE_STARTED)\r
        if DistFile:\r
            DistFile.Close()\r
        if ContentZipFile:\r
            ContentZipFile.Close()\r
        for TempDir in GlobalData.gUNPACK_DIR:\r
            rmtree(TempDir)\r
        GlobalData.gUNPACK_DIR = []\r
        Logger.Quiet(ST.MSG_REMOVE_TEMP_FILE_DONE)\r
\r
    if ReturnCode == 0:\r
        Logger.Quiet(ST.MSG_FINISH)\r
\r
    return ReturnCode\r
\r
def CheckReplaceDpx(Dep, DistPkg, OrigDpGuid, OrigDpVersion):\r
    NewDpPkgList = []\r
    for PkgInfo in DistPkg.PackageSurfaceArea:\r
        Guid, Version = PkgInfo[0], PkgInfo[1]\r
        NewDpPkgList.append((Guid, Version))\r
\r
    NewDpInfo = "%s %s" % (DistPkg.Header.GetGuid(), DistPkg.Header.GetVersion())\r
    OrigDpInfo = "%s %s" % (OrigDpGuid, OrigDpVersion)\r
\r
    #\r
    # check whether new distribution is already installed and not replacing itself\r
    #\r
    if (NewDpInfo != OrigDpInfo):\r
        if Dep.CheckDpExists(DistPkg.Header.GetGuid(), DistPkg.Header.GetVersion()):\r
            Logger.Error("\nReplacePkg", UPT_ALREADY_INSTALLED_ERROR,\r
                ST.WRN_DIST_PKG_INSTALLED,\r
                ExtraData=ST.MSG_REPLACE_ALREADY_INSTALLED_DP)\r
\r
    #\r
    # check whether the original distribution could be replaced by new distribution\r
    #\r
    Logger.Verbose(ST.MSG_CHECK_DP_FOR_REPLACE%(NewDpInfo, OrigDpInfo))\r
    DepInfoResult = Dep.CheckDpDepexForReplace(OrigDpGuid, OrigDpVersion, NewDpPkgList)\r
    Replaceable = DepInfoResult[0]\r
    if not Replaceable:\r
        Logger.Error("\nReplacePkg", UNKNOWN_ERROR,\r
            ST.ERR_PACKAGE_NOT_MATCH_DEPENDENCY)\r
\r
    #\r
    # check whether new distribution could be installed by dependency rule\r
    #\r
    Logger.Verbose(ST.MSG_CHECK_DP_FOR_INSTALL%str(NewDpInfo))\r
    if not Dep.ReplaceCheckNewDpDepex(DistPkg, OrigDpGuid, OrigDpVersion):\r
        Logger.Error("\nReplacePkg", UNKNOWN_ERROR,\r
            ST.ERR_PACKAGE_NOT_MATCH_DEPENDENCY,\r
            ExtraData=DistPkg.Header.Name)\r
\r