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