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

## @file\r
#\r
# This file is the main entry for UPT\r
#\r
# Copyright (c) 2011 - 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
'''\r
UPT\r
'''\r
\r
## import modules\r
#\r
import locale\r
import sys\r
encoding = locale.getdefaultlocale()[1]\r
if encoding:\r
    reload(sys)\r
    sys.setdefaultencoding(encoding)\r
from Core import FileHook\r
import os.path\r
from sys import platform\r
import platform as pf\r
from optparse import OptionParser\r
from traceback import format_exc\r
from platform import python_version\r
\r
from Logger import StringTable as ST\r
import Logger.Log as Logger\r
from Logger.StringTable import MSG_VERSION\r
from Logger.StringTable import MSG_DESCRIPTION\r
from Logger.StringTable import MSG_USAGE\r
from Logger.ToolError import FILE_NOT_FOUND\r
from Logger.ToolError import OPTION_MISSING\r
from Logger.ToolError import FILE_TYPE_MISMATCH\r
from Logger.ToolError import OPTION_CONFLICT\r
from Logger.ToolError import FatalError\r
from Logger.ToolError import UPT_ALREADY_INSTALLED_ERROR\r
from Common.MultipleWorkspace import MultipleWorkspace as mws\r
\r
import MkPkg\r
import InstallPkg\r
import RmPkg\r
import InventoryWs\r
import ReplacePkg\r
import TestInstall\r
from Library.Misc import GetWorkspace\r
from Library import GlobalData\r
from Core.IpiDb import IpiDatabase\r
from BuildVersion import gBUILD_VERSION\r
\r
## CheckConflictOption\r
#\r
# CheckConflictOption\r
#\r
def CheckConflictOption(Opt):\r
    if (Opt.PackFileToCreate or Opt.PackFileToInstall or Opt.PackFileToRemove or Opt.PackFileToReplace) \\r
    and Opt.InventoryWs:\r
        Logger.Error("UPT", OPTION_CONFLICT, ExtraData=ST.ERR_L_OA_EXCLUSIVE)\r
    elif Opt.PackFileToReplace and (Opt.PackFileToCreate or Opt.PackFileToInstall or Opt.PackFileToRemove):\r
        Logger.Error("UPT", OPTION_CONFLICT, ExtraData=ST.ERR_U_ICR_EXCLUSIVE)\r
    elif (Opt.PackFileToCreate and Opt.PackFileToInstall and Opt.PackFileToRemove):\r
        Logger.Error("UPT", OPTION_CONFLICT, ExtraData=ST.ERR_REQUIRE_I_C_R_OPTION)\r
    elif Opt.PackFileToCreate and Opt.PackFileToInstall:\r
        Logger.Error("UPT", OPTION_CONFLICT, ExtraData=ST.ERR_I_C_EXCLUSIVE)\r
    elif Opt.PackFileToInstall and Opt.PackFileToRemove:\r
        Logger.Error("UPT", OPTION_CONFLICT, ExtraData=ST.ERR_I_R_EXCLUSIVE)\r
    elif Opt.PackFileToCreate and  Opt.PackFileToRemove:\r
        Logger.Error("UPT", OPTION_CONFLICT, ExtraData=ST.ERR_C_R_EXCLUSIVE)\r
    elif Opt.TestDistFiles and (Opt.PackFileToCreate or Opt.PackFileToInstall \\r
                                or Opt.PackFileToRemove or Opt.PackFileToReplace):\r
        Logger.Error("UPT", OPTION_CONFLICT, ExtraData=ST.ERR_C_R_EXCLUSIVE)\r
\r
    if Opt.CustomPath and Opt.UseGuidedPkgPath:\r
        Logger.Warn("UPT", ST.WARN_CUSTOMPATH_OVERRIDE_USEGUIDEDPATH)\r
        Opt.UseGuidedPkgPath = False\r
\r
## SetLogLevel\r
#\r
def SetLogLevel(Opt):\r
    if Opt.opt_verbose:\r
        Logger.SetLevel(Logger.VERBOSE)\r
    elif Opt.opt_quiet:\r
        Logger.SetLevel(Logger.QUIET + 1)\r
    elif Opt.debug_level is not None:\r
        if Opt.debug_level < 0 or Opt.debug_level > 9:\r
            Logger.Warn("UPT", ST.ERR_DEBUG_LEVEL)\r
            Logger.SetLevel(Logger.INFO)\r
        else:\r
            Logger.SetLevel(Opt.debug_level + 1)\r
    elif Opt.opt_slient:\r
        Logger.SetLevel(Logger.SILENT)\r
    else:\r
        Logger.SetLevel(Logger.INFO)\r
\r
## Main\r
#\r
# Main\r
#\r
def Main():\r
    Logger.Initialize()\r
\r
    Parser = OptionParser(version=(MSG_VERSION + ' Build ' + gBUILD_VERSION), description=MSG_DESCRIPTION,\r
                          prog="UPT.exe", usage=MSG_USAGE)\r
\r
    Parser.add_option("-d", "--debug", action="store", type="int", dest="debug_level", help=ST.HLP_PRINT_DEBUG_INFO)\r
\r
    Parser.add_option("-v", "--verbose", action="store_true", dest="opt_verbose",\r
                      help=ST.HLP_PRINT_INFORMATIONAL_STATEMENT)\r
\r
    Parser.add_option("-s", "--silent", action="store_true", dest="opt_slient", help=ST.HLP_RETURN_NO_DISPLAY)\r
\r
    Parser.add_option("-q", "--quiet", action="store_true", dest="opt_quiet", help=ST.HLP_RETURN_AND_DISPLAY)\r
\r
    Parser.add_option("-i", "--install", action="append", type="string", dest="Install_Distribution_Package_File",\r
                      help=ST.HLP_SPECIFY_PACKAGE_NAME_INSTALL)\r
\r
    Parser.add_option("-c", "--create", action="store", type="string", dest="Create_Distribution_Package_File",\r
                      help=ST.HLP_SPECIFY_PACKAGE_NAME_CREATE)\r
\r
    Parser.add_option("-r", "--remove", action="store", type="string", dest="Remove_Distribution_Package_File",\r
                      help=ST.HLP_SPECIFY_PACKAGE_NAME_REMOVE)\r
\r
    Parser.add_option("-t", "--template", action="store", type="string", dest="Package_Information_Data_File",\r
                      help=ST.HLP_SPECIFY_TEMPLATE_NAME_CREATE)\r
\r
    Parser.add_option("-p", "--dec-filename", action="append", type="string", dest="EDK2_DEC_Filename",\r
                      help=ST.HLP_SPECIFY_DEC_NAME_CREATE)\r
\r
    Parser.add_option("-m", "--inf-filename", action="append", type="string", dest="EDK2_INF_Filename",\r
                      help=ST.HLP_SPECIFY_INF_NAME_CREATE)\r
\r
    Parser.add_option("-l", "--list", action="store_true", dest="List_Dist_Installed",\r
                      help=ST.HLP_LIST_DIST_INSTALLED)\r
\r
    Parser.add_option("-f", "--force", action="store_true", dest="Yes", help=ST.HLP_DISABLE_PROMPT)\r
\r
    Parser.add_option("-n", "--custom-path", action="store_true", dest="CustomPath", help=ST.HLP_CUSTOM_PATH_PROMPT)\r
\r
    Parser.add_option("-x", "--free-lock", action="store_true", dest="SkipLock", help=ST.HLP_SKIP_LOCK_CHECK)\r
\r
    Parser.add_option("-u", "--replace", action="store", type="string", dest="Replace_Distribution_Package_File",\r
                      help=ST.HLP_SPECIFY_PACKAGE_NAME_REPLACE)\r
\r
    Parser.add_option("-o", "--original", action="store", type="string", dest="Original_Distribution_Package_File",\r
                      help=ST.HLP_SPECIFY_PACKAGE_NAME_TO_BE_REPLACED)\r
\r
    Parser.add_option("--use-guided-paths", action="store_true", dest="Use_Guided_Paths", help=ST.HLP_USE_GUIDED_PATHS)\r
\r
    Parser.add_option("-j", "--test-install", action="append", type="string",\r
                      dest="Test_Install_Distribution_Package_Files", help=ST.HLP_TEST_INSTALL)\r
\r
    Opt = Parser.parse_args()[0]\r
\r
    Var2Var = [\r
        ("PackageInformationDataFile", Opt.Package_Information_Data_File),\r
        ("PackFileToInstall", Opt.Install_Distribution_Package_File),\r
        ("PackFileToCreate", Opt.Create_Distribution_Package_File),\r
        ("PackFileToRemove", Opt.Remove_Distribution_Package_File),\r
        ("PackageFileList", Opt.EDK2_DEC_Filename),\r
        ("ModuleFileList", Opt.EDK2_INF_Filename),\r
        ("InventoryWs", Opt.List_Dist_Installed),\r
        ("PackFileToReplace", Opt.Replace_Distribution_Package_File),\r
        ("PackFileToBeReplaced", Opt.Original_Distribution_Package_File),\r
        ("UseGuidedPkgPath", Opt.Use_Guided_Paths),\r
        ("TestDistFiles", Opt.Test_Install_Distribution_Package_Files)\r
    ]\r
\r
    for Var in Var2Var:\r
        setattr(Opt, Var[0], Var[1])\r
\r
    try:\r
        GlobalData.gWORKSPACE, GlobalData.gPACKAGE_PATH = GetWorkspace()\r
    except FatalError as XExcept:\r
        if Logger.GetLevel() <= Logger.DEBUG_9:\r
            Logger.Quiet(ST.MSG_PYTHON_ON % (python_version(), platform) + format_exc())\r
        return XExcept.args[0]\r
\r
    # Support WORKSPACE is a long path\r
    # Only works for windows system\r
    if pf.system() == 'Windows':\r
        Vol = 'B:'\r
        for Index in range(90, 65, -1):\r
            Vol = chr(Index) + ':'\r
            if not os.path.isdir(Vol):\r
                os.system('subst %s "%s"' % (Vol, GlobalData.gWORKSPACE))\r
                break\r
        GlobalData.gWORKSPACE = '%s\\' % Vol\r
\r
    WorkspaceDir = GlobalData.gWORKSPACE\r
\r
    SetLogLevel(Opt)\r
\r
    Mgr = FileHook.RecoverMgr(WorkspaceDir)\r
    FileHook.SetRecoverMgr(Mgr)\r
\r
    GlobalData.gDB = IpiDatabase(os.path.normpath(os.path.join(WorkspaceDir, \\r
                                                               "Conf/DistributionPackageDatabase.db")), WorkspaceDir)\r
    GlobalData.gDB.InitDatabase(Opt.SkipLock)\r
\r
    #\r
    # Make sure the Db will get closed correctly\r
    #\r
    try:\r
        ReturnCode = 0\r
        CheckConflictOption(Opt)\r
\r
        RunModule = None\r
        if Opt.PackFileToCreate:\r
            if Opt.PackageInformationDataFile:\r
                if not os.path.exists(Opt.PackageInformationDataFile):\r
                    if not os.path.exists(os.path.join(WorkspaceDir, Opt.PackageInformationDataFile)):\r
                        Logger.Error("\nUPT", FILE_NOT_FOUND, ST.ERR_NO_TEMPLATE_FILE % Opt.PackageInformationDataFile)\r
                    else:\r
                        Opt.PackageInformationDataFile = os.path.join(WorkspaceDir, Opt.PackageInformationDataFile)\r
            else:\r
                Logger.Error("UPT", OPTION_MISSING, ExtraData=ST.ERR_REQUIRE_T_OPTION)\r
            if not Opt.PackFileToCreate.endswith('.dist'):\r
                Logger.Error("CreatePkg", FILE_TYPE_MISMATCH, ExtraData=ST.ERR_DIST_EXT_ERROR % Opt.PackFileToCreate)\r
            RunModule = MkPkg.Main\r
\r
        elif Opt.PackFileToInstall:\r
            AbsPath = []\r
            for Item in Opt.PackFileToInstall:\r
                if not Item.endswith('.dist'):\r
                    Logger.Error("InstallPkg", FILE_TYPE_MISMATCH, ExtraData=ST.ERR_DIST_EXT_ERROR % Item)\r
\r
                AbsPath.append(GetFullPathDist(Item, WorkspaceDir))\r
                if not AbsPath:\r
                    Logger.Error("InstallPkg", FILE_NOT_FOUND, ST.ERR_INSTALL_DIST_NOT_FOUND % Item)\r
\r
            Opt.PackFileToInstall = AbsPath\r
            setattr(Opt, 'PackageFile', Opt.PackFileToInstall)\r
            RunModule = InstallPkg.Main\r
\r
        elif Opt.PackFileToRemove:\r
            if not Opt.PackFileToRemove.endswith('.dist'):\r
                Logger.Error("RemovePkg", FILE_TYPE_MISMATCH, ExtraData=ST.ERR_DIST_EXT_ERROR % Opt.PackFileToRemove)\r
            head, tail = os.path.split(Opt.PackFileToRemove)\r
            if head or not tail:\r
                Logger.Error("RemovePkg",\r
                             FILE_TYPE_MISMATCH,\r
                             ExtraData=ST.ERR_DIST_FILENAME_ONLY_FOR_REMOVE % Opt.PackFileToRemove)\r
\r
            setattr(Opt, 'DistributionFile', Opt.PackFileToRemove)\r
            RunModule = RmPkg.Main\r
        elif Opt.InventoryWs:\r
            RunModule = InventoryWs.Main\r
\r
        elif Opt.PackFileToBeReplaced and not Opt.PackFileToReplace:\r
            Logger.Error("ReplacePkg", OPTION_MISSING, ExtraData=ST.ERR_REQUIRE_U_OPTION)\r
\r
        elif Opt.PackFileToReplace:\r
            if not Opt.PackFileToReplace.endswith('.dist'):\r
                Logger.Error("ReplacePkg", FILE_TYPE_MISMATCH, ExtraData=ST.ERR_DIST_EXT_ERROR % Opt.PackFileToReplace)\r
            if not Opt.PackFileToBeReplaced:\r
                Logger.Error("ReplacePkg", OPTION_MISSING, ExtraData=ST.ERR_REQUIRE_O_OPTION)\r
            if not Opt.PackFileToBeReplaced.endswith('.dist'):\r
                Logger.Error("ReplacePkg",\r
                             FILE_TYPE_MISMATCH,\r
                             ExtraData=ST.ERR_DIST_EXT_ERROR % Opt.PackFileToBeReplaced)\r
\r
            head, tail = os.path.split(Opt.PackFileToBeReplaced)\r
            if head or not tail:\r
                Logger.Error("ReplacePkg",\r
                             FILE_TYPE_MISMATCH,\r
                             ExtraData=ST.ERR_DIST_FILENAME_ONLY_FOR_REPLACE_ORIG % Opt.PackFileToBeReplaced)\r
\r
            AbsPath = GetFullPathDist(Opt.PackFileToReplace, WorkspaceDir)\r
            if not AbsPath:\r
                Logger.Error("ReplacePkg", FILE_NOT_FOUND, ST.ERR_REPLACE_DIST_NOT_FOUND % Opt.PackFileToReplace)\r
\r
            Opt.PackFileToReplace = AbsPath\r
            RunModule = ReplacePkg.Main\r
\r
        elif Opt.Test_Install_Distribution_Package_Files:\r
            for Dist in Opt.Test_Install_Distribution_Package_Files:\r
                if not Dist.endswith('.dist'):\r
                    Logger.Error("TestInstall", FILE_TYPE_MISMATCH, ExtraData=ST.ERR_DIST_EXT_ERROR % Dist)\r
\r
            setattr(Opt, 'DistFiles', Opt.Test_Install_Distribution_Package_Files)\r
            RunModule = TestInstall.Main\r
\r
        else:\r
            Parser.print_usage()\r
            return OPTION_MISSING\r
\r
        ReturnCode = RunModule(Opt)\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(), platform) + \\r
                         format_exc())\r
    finally:\r
        try:\r
            if ReturnCode != 0 and ReturnCode != UPT_ALREADY_INSTALLED_ERROR:\r
                Logger.Quiet(ST.MSG_RECOVER_START)\r
                GlobalData.gDB.RollBack()\r
                Mgr.rollback()\r
                Logger.Quiet(ST.MSG_RECOVER_DONE)\r
            else:\r
                GlobalData.gDB.Commit()\r
                Mgr.commit()\r
        except Exception:\r
            Logger.Quiet(ST.MSG_RECOVER_FAIL)\r
        GlobalData.gDB.CloseDb()\r
\r
        if pf.system() == 'Windows':\r
            os.system('subst %s /D' % GlobalData.gWORKSPACE.replace('\\', ''))\r
\r
    return ReturnCode\r
\r
## GetFullPathDist\r
#\r
#  This function will check DistFile existence, if not absolute path, then try current working directory,\r
#  then $(WORKSPACE),and return the AbsPath. If file doesn't find, then return None\r
#\r
# @param DistFile:       The distribution file in either relative path or absolute path\r
# @param WorkspaceDir:   Workspace Directory\r
# @return AbsPath:       The Absolute path of the distribution file if existed, None else\r
#\r
def GetFullPathDist(DistFile, WorkspaceDir):\r
    if os.path.isabs(DistFile):\r
        if not (os.path.exists(DistFile) and os.path.isfile(DistFile)):\r
            return None\r
        else:\r
            return DistFile\r
    else:\r
        AbsPath = os.path.normpath(os.path.join(os.getcwd(), DistFile))\r
        if not (os.path.exists(AbsPath) and os.path.isfile(AbsPath)):\r
            AbsPath = os.path.normpath(os.path.join(WorkspaceDir, DistFile))\r
            if not (os.path.exists(AbsPath) and os.path.isfile(AbsPath)):\r
                return None\r
\r
        return AbsPath\r
\r
if __name__ == '__main__':\r
    RETVAL = Main()\r
    #\r
    # 0-127 is a safe return range, and 1 is a standard default error\r
    #\r
    if RETVAL < 0 or RETVAL > 127:\r
        RETVAL = 1\r
    sys.exit(RETVAL)\r
Commit	Line	Data
4234283c LG	1	## @file\r
4234283c LG	2	#\r
f7496d71	3	# This file is the main entry for UPT\r
4234283c	4	#\r
f7496d71	5	# Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
4234283c	6	#\r
f7496d71 LG	7	# This program and the accompanying materials are licensed and made available\r
	8	# under the terms and conditions of the BSD License which accompanies this\r
	9	# distribution. The full text of the license may be found at\r
4234283c LG	10	# http://opensource.org/licenses/bsd-license.php\r
	11	#\r
	12	# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	13	# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	14	#\r
	15	\r
	16	'''\r
	17	UPT\r
	18	'''\r
	19	\r
	20	## import modules\r
	21	#\r
09e27ac5	22	import locale\r
4234283c	23	import sys\r
1ccc4d89 LG	24	encoding = locale.getdefaultlocale()[1]\r
	25	if encoding:\r
	26	reload(sys)\r
	27	sys.setdefaultencoding(encoding)\r
09e27ac5	28	from Core import FileHook\r
4234283c	29	import os.path\r
4234283c	30	from sys import platform\r
421ccda3	31	import platform as pf\r
4234283c LG	32	from optparse import OptionParser\r
	33	from traceback import format_exc\r
	34	from platform import python_version\r
	35	\r
	36	from Logger import StringTable as ST\r
	37	import Logger.Log as Logger\r
	38	from Logger.StringTable import MSG_VERSION\r
	39	from Logger.StringTable import MSG_DESCRIPTION\r
	40	from Logger.StringTable import MSG_USAGE\r
	41	from Logger.ToolError import FILE_NOT_FOUND\r
	42	from Logger.ToolError import OPTION_MISSING\r
	43	from Logger.ToolError import FILE_TYPE_MISMATCH\r
	44	from Logger.ToolError import OPTION_CONFLICT\r
	45	from Logger.ToolError import FatalError\r
af0c61ae	46	from Logger.ToolError import UPT_ALREADY_INSTALLED_ERROR\r
fb0f8067	47	from Common.MultipleWorkspace import MultipleWorkspace as mws\r
421ccda3	48	\r
4234283c LG	49	import MkPkg\r
	50	import InstallPkg\r
	51	import RmPkg\r
421ccda3 HC	52	import InventoryWs\r
421ccda3 HC	53	import ReplacePkg\r
6cf99034	54	import TestInstall\r
421ccda3	55	from Library.Misc import GetWorkspace\r
4234283c LG	56	from Library import GlobalData\r
4234283c LG	57	from Core.IpiDb import IpiDatabase\r
2bcc713e	58	from BuildVersion import gBUILD_VERSION\r
4234283c	59	\r
4234283c LG	60	## CheckConflictOption\r
	61	#\r
	62	# CheckConflictOption\r
	63	#\r
	64	def CheckConflictOption(Opt):\r
421ccda3 HC	65	if (Opt.PackFileToCreate or Opt.PackFileToInstall or Opt.PackFileToRemove or Opt.PackFileToReplace) \\r
	66	and Opt.InventoryWs:\r
	67	Logger.Error("UPT", OPTION_CONFLICT, ExtraData=ST.ERR_L_OA_EXCLUSIVE)\r
	68	elif Opt.PackFileToReplace and (Opt.PackFileToCreate or Opt.PackFileToInstall or Opt.PackFileToRemove):\r
	69	Logger.Error("UPT", OPTION_CONFLICT, ExtraData=ST.ERR_U_ICR_EXCLUSIVE)\r
	70	elif (Opt.PackFileToCreate and Opt.PackFileToInstall and Opt.PackFileToRemove):\r
4234283c LG	71	Logger.Error("UPT", OPTION_CONFLICT, ExtraData=ST.ERR_REQUIRE_I_C_R_OPTION)\r
	72	elif Opt.PackFileToCreate and Opt.PackFileToInstall:\r
	73	Logger.Error("UPT", OPTION_CONFLICT, ExtraData=ST.ERR_I_C_EXCLUSIVE)\r
	74	elif Opt.PackFileToInstall and Opt.PackFileToRemove:\r
	75	Logger.Error("UPT", OPTION_CONFLICT, ExtraData=ST.ERR_I_R_EXCLUSIVE)\r
	76	elif Opt.PackFileToCreate and Opt.PackFileToRemove:\r
	77	Logger.Error("UPT", OPTION_CONFLICT, ExtraData=ST.ERR_C_R_EXCLUSIVE)\r
6cf99034 HC	78	elif Opt.TestDistFiles and (Opt.PackFileToCreate or Opt.PackFileToInstall \\r
	79	or Opt.PackFileToRemove or Opt.PackFileToReplace):\r
	80	Logger.Error("UPT", OPTION_CONFLICT, ExtraData=ST.ERR_C_R_EXCLUSIVE)\r
4234283c	81	\r
421ccda3 HC	82	if Opt.CustomPath and Opt.UseGuidedPkgPath:\r
	83	Logger.Warn("UPT", ST.WARN_CUSTOMPATH_OVERRIDE_USEGUIDEDPATH)\r
	84	Opt.UseGuidedPkgPath = False\r
	85	\r
4234283c LG	86	## SetLogLevel\r
	87	#\r
	88	def SetLogLevel(Opt):\r
	89	if Opt.opt_verbose:\r
	90	Logger.SetLevel(Logger.VERBOSE)\r
	91	elif Opt.opt_quiet:\r
	92	Logger.SetLevel(Logger.QUIET + 1)\r
4231a819	93	elif Opt.debug_level is not None:\r
4234283c LG	94	if Opt.debug_level < 0 or Opt.debug_level > 9:\r
	95	Logger.Warn("UPT", ST.ERR_DEBUG_LEVEL)\r
	96	Logger.SetLevel(Logger.INFO)\r
	97	else:\r
	98	Logger.SetLevel(Opt.debug_level + 1)\r
	99	elif Opt.opt_slient:\r
	100	Logger.SetLevel(Logger.SILENT)\r
	101	else:\r
	102	Logger.SetLevel(Logger.INFO)\r
	103	\r
	104	## Main\r
	105	#\r
	106	# Main\r
	107	#\r
	108	def Main():\r
	109	Logger.Initialize()\r
	110	\r
45258285	111	Parser = OptionParser(version=(MSG_VERSION + ' Build ' + gBUILD_VERSION), description=MSG_DESCRIPTION,\r
4234283c LG	112	prog="UPT.exe", usage=MSG_USAGE)\r
	113	\r
	114	Parser.add_option("-d", "--debug", action="store", type="int", dest="debug_level", help=ST.HLP_PRINT_DEBUG_INFO)\r
	115	\r
	116	Parser.add_option("-v", "--verbose", action="store_true", dest="opt_verbose",\r
	117	help=ST.HLP_PRINT_INFORMATIONAL_STATEMENT)\r
	118	\r
	119	Parser.add_option("-s", "--silent", action="store_true", dest="opt_slient", help=ST.HLP_RETURN_NO_DISPLAY)\r
	120	\r
	121	Parser.add_option("-q", "--quiet", action="store_true", dest="opt_quiet", help=ST.HLP_RETURN_AND_DISPLAY)\r
	122	\r
56636814	123	Parser.add_option("-i", "--install", action="append", type="string", dest="Install_Distribution_Package_File",\r
4234283c LG	124	help=ST.HLP_SPECIFY_PACKAGE_NAME_INSTALL)\r
	125	\r
	126	Parser.add_option("-c", "--create", action="store", type="string", dest="Create_Distribution_Package_File",\r
	127	help=ST.HLP_SPECIFY_PACKAGE_NAME_CREATE)\r
	128	\r
	129	Parser.add_option("-r", "--remove", action="store", type="string", dest="Remove_Distribution_Package_File",\r
	130	help=ST.HLP_SPECIFY_PACKAGE_NAME_REMOVE)\r
	131	\r
	132	Parser.add_option("-t", "--template", action="store", type="string", dest="Package_Information_Data_File",\r
	133	help=ST.HLP_SPECIFY_TEMPLATE_NAME_CREATE)\r
	134	\r
	135	Parser.add_option("-p", "--dec-filename", action="append", type="string", dest="EDK2_DEC_Filename",\r
	136	help=ST.HLP_SPECIFY_DEC_NAME_CREATE)\r
	137	\r
	138	Parser.add_option("-m", "--inf-filename", action="append", type="string", dest="EDK2_INF_Filename",\r
	139	help=ST.HLP_SPECIFY_INF_NAME_CREATE)\r
	140	\r
421ccda3 HC	141	Parser.add_option("-l", "--list", action="store_true", dest="List_Dist_Installed",\r
	142	help=ST.HLP_LIST_DIST_INSTALLED)\r
	143	\r
4234283c LG	144	Parser.add_option("-f", "--force", action="store_true", dest="Yes", help=ST.HLP_DISABLE_PROMPT)\r
	145	\r
	146	Parser.add_option("-n", "--custom-path", action="store_true", dest="CustomPath", help=ST.HLP_CUSTOM_PATH_PROMPT)\r
	147	\r
	148	Parser.add_option("-x", "--free-lock", action="store_true", dest="SkipLock", help=ST.HLP_SKIP_LOCK_CHECK)\r
	149	\r
421ccda3 HC	150	Parser.add_option("-u", "--replace", action="store", type="string", dest="Replace_Distribution_Package_File",\r
	151	help=ST.HLP_SPECIFY_PACKAGE_NAME_REPLACE)\r
	152	\r
	153	Parser.add_option("-o", "--original", action="store", type="string", dest="Original_Distribution_Package_File",\r
	154	help=ST.HLP_SPECIFY_PACKAGE_NAME_TO_BE_REPLACED)\r
	155	\r
	156	Parser.add_option("--use-guided-paths", action="store_true", dest="Use_Guided_Paths", help=ST.HLP_USE_GUIDED_PATHS)\r
	157	\r
6cf99034 HC	158	Parser.add_option("-j", "--test-install", action="append", type="string",\r
	159	dest="Test_Install_Distribution_Package_Files", help=ST.HLP_TEST_INSTALL)\r
	160	\r
4234283c LG	161	Opt = Parser.parse_args()[0]\r
	162	\r
	163	Var2Var = [\r
	164	("PackageInformationDataFile", Opt.Package_Information_Data_File),\r
	165	("PackFileToInstall", Opt.Install_Distribution_Package_File),\r
	166	("PackFileToCreate", Opt.Create_Distribution_Package_File),\r
	167	("PackFileToRemove", Opt.Remove_Distribution_Package_File),\r
	168	("PackageFileList", Opt.EDK2_DEC_Filename),\r
421ccda3 HC	169	("ModuleFileList", Opt.EDK2_INF_Filename),\r
	170	("InventoryWs", Opt.List_Dist_Installed),\r
	171	("PackFileToReplace", Opt.Replace_Distribution_Package_File),\r
	172	("PackFileToBeReplaced", Opt.Original_Distribution_Package_File),\r
	173	("UseGuidedPkgPath", Opt.Use_Guided_Paths),\r
6cf99034	174	("TestDistFiles", Opt.Test_Install_Distribution_Package_Files)\r
4234283c	175	]\r
421ccda3	176	\r
4234283c LG	177	for Var in Var2Var:\r
	178	setattr(Opt, Var[0], Var[1])\r
	179	\r
	180	try:\r
fb0f8067	181	GlobalData.gWORKSPACE, GlobalData.gPACKAGE_PATH = GetWorkspace()\r
5b0671c1	182	except FatalError as XExcept:\r
4234283c LG	183	if Logger.GetLevel() <= Logger.DEBUG_9:\r
	184	Logger.Quiet(ST.MSG_PYTHON_ON % (python_version(), platform) + format_exc())\r
	185	return XExcept.args[0]\r
	186	\r
421ccda3	187	# Support WORKSPACE is a long path\r
c03f5b2c	188	# Only works for windows system\r
421ccda3	189	if pf.system() == 'Windows':\r
c03f5b2c HC	190	Vol = 'B:'\r
	191	for Index in range(90, 65, -1):\r
	192	Vol = chr(Index) + ':'\r
	193	if not os.path.isdir(Vol):\r
	194	os.system('subst %s "%s"' % (Vol, GlobalData.gWORKSPACE))\r
	195	break\r
	196	GlobalData.gWORKSPACE = '%s\\' % Vol\r
421ccda3	197	\r
4234283c LG	198	WorkspaceDir = GlobalData.gWORKSPACE\r
	199	\r
	200	SetLogLevel(Opt)\r
	201	\r
421ccda3 HC	202	Mgr = FileHook.RecoverMgr(WorkspaceDir)\r
	203	FileHook.SetRecoverMgr(Mgr)\r
	204	\r
	205	GlobalData.gDB = IpiDatabase(os.path.normpath(os.path.join(WorkspaceDir, \\r
	206	"Conf/DistributionPackageDatabase.db")), WorkspaceDir)\r
4234283c LG	207	GlobalData.gDB.InitDatabase(Opt.SkipLock)\r
	208	\r
	209	#\r
	210	# Make sure the Db will get closed correctly\r
	211	#\r
	212	try:\r
	213	ReturnCode = 0\r
	214	CheckConflictOption(Opt)\r
	215	\r
	216	RunModule = None\r
	217	if Opt.PackFileToCreate:\r
	218	if Opt.PackageInformationDataFile:\r
	219	if not os.path.exists(Opt.PackageInformationDataFile):\r
	220	if not os.path.exists(os.path.join(WorkspaceDir, Opt.PackageInformationDataFile)):\r
	221	Logger.Error("\nUPT", FILE_NOT_FOUND, ST.ERR_NO_TEMPLATE_FILE % Opt.PackageInformationDataFile)\r
	222	else:\r
	223	Opt.PackageInformationDataFile = os.path.join(WorkspaceDir, Opt.PackageInformationDataFile)\r
	224	else:\r
	225	Logger.Error("UPT", OPTION_MISSING, ExtraData=ST.ERR_REQUIRE_T_OPTION)\r
	226	if not Opt.PackFileToCreate.endswith('.dist'):\r
	227	Logger.Error("CreatePkg", FILE_TYPE_MISMATCH, ExtraData=ST.ERR_DIST_EXT_ERROR % Opt.PackFileToCreate)\r
	228	RunModule = MkPkg.Main\r
	229	\r
	230	elif Opt.PackFileToInstall:\r
56636814 HC	231	AbsPath = []\r
	232	for Item in Opt.PackFileToInstall:\r
	233	if not Item.endswith('.dist'):\r
	234	Logger.Error("InstallPkg", FILE_TYPE_MISMATCH, ExtraData=ST.ERR_DIST_EXT_ERROR % Item)\r
	235	\r
	236	AbsPath.append(GetFullPathDist(Item, WorkspaceDir))\r
	237	if not AbsPath:\r
	238	Logger.Error("InstallPkg", FILE_NOT_FOUND, ST.ERR_INSTALL_DIST_NOT_FOUND % Item)\r
4234283c	239	\r
421ccda3	240	Opt.PackFileToInstall = AbsPath\r
4234283c LG	241	setattr(Opt, 'PackageFile', Opt.PackFileToInstall)\r
	242	RunModule = InstallPkg.Main\r
	243	\r
	244	elif Opt.PackFileToRemove:\r
	245	if not Opt.PackFileToRemove.endswith('.dist'):\r
	246	Logger.Error("RemovePkg", FILE_TYPE_MISMATCH, ExtraData=ST.ERR_DIST_EXT_ERROR % Opt.PackFileToRemove)\r
	247	head, tail = os.path.split(Opt.PackFileToRemove)\r
	248	if head or not tail:\r
	249	Logger.Error("RemovePkg",\r
	250	FILE_TYPE_MISMATCH,\r
	251	ExtraData=ST.ERR_DIST_FILENAME_ONLY_FOR_REMOVE % Opt.PackFileToRemove)\r
	252	\r
	253	setattr(Opt, 'DistributionFile', Opt.PackFileToRemove)\r
	254	RunModule = RmPkg.Main\r
421ccda3 HC	255	elif Opt.InventoryWs:\r
	256	RunModule = InventoryWs.Main\r
	257	\r
	258	elif Opt.PackFileToBeReplaced and not Opt.PackFileToReplace:\r
	259	Logger.Error("ReplacePkg", OPTION_MISSING, ExtraData=ST.ERR_REQUIRE_U_OPTION)\r
	260	\r
	261	elif Opt.PackFileToReplace:\r
	262	if not Opt.PackFileToReplace.endswith('.dist'):\r
	263	Logger.Error("ReplacePkg", FILE_TYPE_MISMATCH, ExtraData=ST.ERR_DIST_EXT_ERROR % Opt.PackFileToReplace)\r
	264	if not Opt.PackFileToBeReplaced:\r
	265	Logger.Error("ReplacePkg", OPTION_MISSING, ExtraData=ST.ERR_REQUIRE_O_OPTION)\r
	266	if not Opt.PackFileToBeReplaced.endswith('.dist'):\r
	267	Logger.Error("ReplacePkg",\r
	268	FILE_TYPE_MISMATCH,\r
	269	ExtraData=ST.ERR_DIST_EXT_ERROR % Opt.PackFileToBeReplaced)\r
	270	\r
	271	head, tail = os.path.split(Opt.PackFileToBeReplaced)\r
	272	if head or not tail:\r
	273	Logger.Error("ReplacePkg",\r
	274	FILE_TYPE_MISMATCH,\r
	275	ExtraData=ST.ERR_DIST_FILENAME_ONLY_FOR_REPLACE_ORIG % Opt.PackFileToBeReplaced)\r
	276	\r
	277	AbsPath = GetFullPathDist(Opt.PackFileToReplace, WorkspaceDir)\r
	278	if not AbsPath:\r
	279	Logger.Error("ReplacePkg", FILE_NOT_FOUND, ST.ERR_REPLACE_DIST_NOT_FOUND % Opt.PackFileToReplace)\r
	280	\r
	281	Opt.PackFileToReplace = AbsPath\r
	282	RunModule = ReplacePkg.Main\r
	283	\r
6cf99034 HC	284	elif Opt.Test_Install_Distribution_Package_Files:\r
	285	for Dist in Opt.Test_Install_Distribution_Package_Files:\r
	286	if not Dist.endswith('.dist'):\r
	287	Logger.Error("TestInstall", FILE_TYPE_MISMATCH, ExtraData=ST.ERR_DIST_EXT_ERROR % Dist)\r
	288	\r
	289	setattr(Opt, 'DistFiles', Opt.Test_Install_Distribution_Package_Files)\r
	290	RunModule = TestInstall.Main\r
	291	\r
4234283c LG	292	else:\r
	293	Parser.print_usage()\r
	294	return OPTION_MISSING\r
	295	\r
	296	ReturnCode = RunModule(Opt)\r
5b0671c1	297	except FatalError as XExcept:\r
4234283c LG	298	ReturnCode = XExcept.args[0]\r
	299	if Logger.GetLevel() <= Logger.DEBUG_9:\r
	300	Logger.Quiet(ST.MSG_PYTHON_ON % (python_version(), platform) + \\r
	301	format_exc())\r
	302	finally:\r
421ccda3	303	try:\r
af0c61ae	304	if ReturnCode != 0 and ReturnCode != UPT_ALREADY_INSTALLED_ERROR:\r
421ccda3 HC	305	Logger.Quiet(ST.MSG_RECOVER_START)\r
	306	GlobalData.gDB.RollBack()\r
	307	Mgr.rollback()\r
	308	Logger.Quiet(ST.MSG_RECOVER_DONE)\r
	309	else:\r
	310	GlobalData.gDB.Commit()\r
	311	Mgr.commit()\r
92beb1e4	312	except Exception:\r
421ccda3	313	Logger.Quiet(ST.MSG_RECOVER_FAIL)\r
4234283c	314	GlobalData.gDB.CloseDb()\r
c03f5b2c	315	\r
421ccda3	316	if pf.system() == 'Windows':\r
ccaa7754	317	os.system('subst %s /D' % GlobalData.gWORKSPACE.replace('\\', ''))\r
4234283c LG	318	\r
	319	return ReturnCode\r
	320	\r
421ccda3 HC	321	## GetFullPathDist\r
	322	#\r
	323	# This function will check DistFile existence, if not absolute path, then try current working directory,\r
	324	# then $(WORKSPACE),and return the AbsPath. If file doesn't find, then return None\r
	325	#\r
	326	# @param DistFile: The distribution file in either relative path or absolute path\r
	327	# @param WorkspaceDir: Workspace Directory\r
	328	# @return AbsPath: The Absolute path of the distribution file if existed, None else\r
	329	#\r
	330	def GetFullPathDist(DistFile, WorkspaceDir):\r
	331	if os.path.isabs(DistFile):\r
	332	if not (os.path.exists(DistFile) and os.path.isfile(DistFile)):\r
	333	return None\r
	334	else:\r
	335	return DistFile\r
	336	else:\r
	337	AbsPath = os.path.normpath(os.path.join(os.getcwd(), DistFile))\r
	338	if not (os.path.exists(AbsPath) and os.path.isfile(AbsPath)):\r
	339	AbsPath = os.path.normpath(os.path.join(WorkspaceDir, DistFile))\r
	340	if not (os.path.exists(AbsPath) and os.path.isfile(AbsPath)):\r
	341	return None\r
	342	\r
	343	return AbsPath\r
	344	\r
4234283c LG	345	if __name__ == '__main__':\r
	346	RETVAL = Main()\r
	347	#\r
	348	# 0-127 is a safe return range, and 1 is a standard default error\r
	349	#\r
	350	if RETVAL < 0 or RETVAL > 127:\r
	351	RETVAL = 1\r
	352	sys.exit(RETVAL)\r