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