[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 - 2017, 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 != 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
    # 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
            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
\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
	1	## @file\r
	2	#\r
	3	# This file is the main entry for UPT \r
	4	#\r
	5	# Copyright (c) 2011 - 2017, Intel Corporation. All rights reserved.<BR>\r
	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
	22	import locale\r
	23	import sys\r
	24	encoding = locale.getdefaultlocale()[1]\r
	25	if encoding:\r
	26	reload(sys)\r
	27	sys.setdefaultencoding(encoding)\r
	28	from Core import FileHook\r
	29	import os.path\r
	30	from sys import platform\r
	31	import platform as pf\r
	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
	46	from Logger.ToolError import UPT_ALREADY_INSTALLED_ERROR\r
	47	from Common.MultipleWorkspace import MultipleWorkspace as mws\r
	48	\r
	49	import MkPkg\r
	50	import InstallPkg\r
	51	import RmPkg\r
	52	import InventoryWs\r
	53	import ReplacePkg\r
	54	import TestInstall\r
	55	from Library.Misc import GetWorkspace\r
	56	from Library import GlobalData\r
	57	from Core.IpiDb import IpiDatabase\r
	58	from BuildVersion import gBUILD_VERSION\r
	59	\r
	60	## CheckConflictOption\r
	61	#\r
	62	# CheckConflictOption\r
	63	#\r
	64	def CheckConflictOption(Opt):\r
	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
	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
	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
	81	\r
	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
	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
	93	elif Opt.debug_level != None:\r
	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
	111	Parser = OptionParser(version=(MSG_VERSION + ' Build ' + gBUILD_VERSION), description=MSG_DESCRIPTION,\r
	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
	123	Parser.add_option("-i", "--install", action="store", type="string", dest="Install_Distribution_Package_File",\r
	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
	141	Parser.add_option("-l", "--list", action="store_true", dest="List_Dist_Installed",\r
	142	help=ST.HLP_LIST_DIST_INSTALLED)\r
	143	\r
	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
	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
	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
	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
	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
	174	("TestDistFiles", Opt.Test_Install_Distribution_Package_Files)\r
	175	]\r
	176	\r
	177	for Var in Var2Var:\r
	178	setattr(Opt, Var[0], Var[1])\r
	179	\r
	180	try:\r
	181	GlobalData.gWORKSPACE, GlobalData.gPACKAGE_PATH = GetWorkspace()\r
	182	except FatalError, XExcept:\r
	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
	187	# Support WORKSPACE is a long path\r
	188	# Only works for windows system\r
	189	if pf.system() == 'Windows':\r
	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
	197	\r
	198	WorkspaceDir = GlobalData.gWORKSPACE\r
	199	\r
	200	SetLogLevel(Opt)\r
	201	\r
	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
	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
	231	if not Opt.PackFileToInstall.endswith('.dist'):\r
	232	Logger.Error("InstallPkg", FILE_TYPE_MISMATCH, ExtraData=ST.ERR_DIST_EXT_ERROR % Opt.PackFileToInstall)\r
	233	\r
	234	AbsPath = GetFullPathDist(Opt.PackFileToInstall, WorkspaceDir)\r
	235	if not AbsPath:\r
	236	Logger.Error("InstallPkg", FILE_NOT_FOUND, ST.ERR_INSTALL_DIST_NOT_FOUND % Opt.PackFileToInstall)\r
	237	\r
	238	Opt.PackFileToInstall = AbsPath\r
	239	setattr(Opt, 'PackageFile', Opt.PackFileToInstall)\r
	240	RunModule = InstallPkg.Main\r
	241	\r
	242	elif Opt.PackFileToRemove:\r
	243	if not Opt.PackFileToRemove.endswith('.dist'):\r
	244	Logger.Error("RemovePkg", FILE_TYPE_MISMATCH, ExtraData=ST.ERR_DIST_EXT_ERROR % Opt.PackFileToRemove)\r
	245	head, tail = os.path.split(Opt.PackFileToRemove)\r
	246	if head or not tail:\r
	247	Logger.Error("RemovePkg",\r
	248	FILE_TYPE_MISMATCH,\r
	249	ExtraData=ST.ERR_DIST_FILENAME_ONLY_FOR_REMOVE % Opt.PackFileToRemove)\r
	250	\r
	251	setattr(Opt, 'DistributionFile', Opt.PackFileToRemove)\r
	252	RunModule = RmPkg.Main\r
	253	elif Opt.InventoryWs:\r
	254	RunModule = InventoryWs.Main\r
	255	\r
	256	elif Opt.PackFileToBeReplaced and not Opt.PackFileToReplace:\r
	257	Logger.Error("ReplacePkg", OPTION_MISSING, ExtraData=ST.ERR_REQUIRE_U_OPTION)\r
	258	\r
	259	elif Opt.PackFileToReplace:\r
	260	if not Opt.PackFileToReplace.endswith('.dist'):\r
	261	Logger.Error("ReplacePkg", FILE_TYPE_MISMATCH, ExtraData=ST.ERR_DIST_EXT_ERROR % Opt.PackFileToReplace)\r
	262	if not Opt.PackFileToBeReplaced:\r
	263	Logger.Error("ReplacePkg", OPTION_MISSING, ExtraData=ST.ERR_REQUIRE_O_OPTION)\r
	264	if not Opt.PackFileToBeReplaced.endswith('.dist'):\r
	265	Logger.Error("ReplacePkg",\r
	266	FILE_TYPE_MISMATCH,\r
	267	ExtraData=ST.ERR_DIST_EXT_ERROR % Opt.PackFileToBeReplaced)\r
	268	\r
	269	head, tail = os.path.split(Opt.PackFileToBeReplaced)\r
	270	if head or not tail:\r
	271	Logger.Error("ReplacePkg",\r
	272	FILE_TYPE_MISMATCH,\r
	273	ExtraData=ST.ERR_DIST_FILENAME_ONLY_FOR_REPLACE_ORIG % Opt.PackFileToBeReplaced)\r
	274	\r
	275	AbsPath = GetFullPathDist(Opt.PackFileToReplace, WorkspaceDir)\r
	276	if not AbsPath:\r
	277	Logger.Error("ReplacePkg", FILE_NOT_FOUND, ST.ERR_REPLACE_DIST_NOT_FOUND % Opt.PackFileToReplace)\r
	278	\r
	279	Opt.PackFileToReplace = AbsPath\r
	280	RunModule = ReplacePkg.Main\r
	281	\r
	282	elif Opt.Test_Install_Distribution_Package_Files:\r
	283	for Dist in Opt.Test_Install_Distribution_Package_Files:\r
	284	if not Dist.endswith('.dist'):\r
	285	Logger.Error("TestInstall", FILE_TYPE_MISMATCH, ExtraData=ST.ERR_DIST_EXT_ERROR % Dist)\r
	286	\r
	287	setattr(Opt, 'DistFiles', Opt.Test_Install_Distribution_Package_Files)\r
	288	RunModule = TestInstall.Main\r
	289	\r
	290	else:\r
	291	Parser.print_usage()\r
	292	return OPTION_MISSING\r
	293	\r
	294	ReturnCode = RunModule(Opt)\r
	295	except FatalError, XExcept:\r
	296	ReturnCode = XExcept.args[0]\r
	297	if Logger.GetLevel() <= Logger.DEBUG_9:\r
	298	Logger.Quiet(ST.MSG_PYTHON_ON % (python_version(), platform) + \\r
	299	format_exc())\r
	300	finally:\r
	301	try:\r
	302	if ReturnCode != 0 and ReturnCode != UPT_ALREADY_INSTALLED_ERROR:\r
	303	Logger.Quiet(ST.MSG_RECOVER_START)\r
	304	GlobalData.gDB.RollBack()\r
	305	Mgr.rollback()\r
	306	Logger.Quiet(ST.MSG_RECOVER_DONE)\r
	307	else:\r
	308	GlobalData.gDB.Commit()\r
	309	Mgr.commit()\r
	310	except StandardError:\r
	311	Logger.Quiet(ST.MSG_RECOVER_FAIL)\r
	312	GlobalData.gDB.CloseDb()\r
	313	\r
	314	if pf.system() == 'Windows':\r
	315	os.system('subst %s /D' % GlobalData.gWORKSPACE.replace('\\',''))\r
	316	\r
	317	return ReturnCode\r
	318	\r
	319	## GetFullPathDist\r
	320	#\r
	321	# This function will check DistFile existence, if not absolute path, then try current working directory,\r
	322	# then $(WORKSPACE),and return the AbsPath. If file doesn't find, then return None\r
	323	#\r
	324	# @param DistFile: The distribution file in either relative path or absolute path\r
	325	# @param WorkspaceDir: Workspace Directory\r
	326	# @return AbsPath: The Absolute path of the distribution file if existed, None else\r
	327	#\r
	328	def GetFullPathDist(DistFile, WorkspaceDir):\r
	329	if os.path.isabs(DistFile):\r
	330	if not (os.path.exists(DistFile) and os.path.isfile(DistFile)):\r
	331	return None\r
	332	else:\r
	333	return DistFile\r
	334	else:\r
	335	AbsPath = os.path.normpath(os.path.join(os.getcwd(), DistFile))\r
	336	if not (os.path.exists(AbsPath) and os.path.isfile(AbsPath)):\r
	337	AbsPath = os.path.normpath(os.path.join(WorkspaceDir, DistFile))\r
	338	if not (os.path.exists(AbsPath) and os.path.isfile(AbsPath)):\r
	339	return None\r
	340	\r
	341	return AbsPath\r
	342	\r
	343	if __name__ == '__main__':\r
	344	RETVAL = Main()\r
	345	#\r
	346	# 0-127 is a safe return range, and 1 is a standard default error\r
	347	#\r
	348	if RETVAL < 0 or RETVAL > 127:\r
	349	RETVAL = 1\r
	350	sys.exit(RETVAL)\r