Sync EDKII BaseTools to BaseTools project r2065.

[mirror_edk2.git] / BaseTools / Source / Python / PackagingTool / DependencyRules.py

## @file\r
# This file is for installed package information database operations\r
#\r
# Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
# This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
# which accompanies this 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
# Import Modules\r
#\r
import sqlite3\r
import os\r
\r
import Common.EdkLogger as EdkLogger\r
import IpiDb\r
\r
(DEPEX_CHECK_SUCCESS, DEPEX_CHECK_MODULE_NOT_FOUND, \\r
DEPEX_CHECK_PACKAGE_NOT_FOUND, DEPEX_CHECK_DP_NOT_FOUND) = (0, 1, 2, 3)\r
\r
## IpiDb\r
#\r
# This class represents the installed package information database\r
# Add/Remove/Get installed distribution package information here.\r
# \r
# \r
# @param object:      Inherited from object class\r
# @param DbPath:      A string for the path of the database\r
#\r
# @var Conn:          Connection of the database\r
# @var Cur:           Cursor of the connection\r
#\r
class DependencyRules(object):\r
    def __init__(self, Db):\r
        self.IpiDb = Db\r
    \r
    ## Check whether a module exists in current workspace.\r
    #\r
    # @param Guid:  \r
    # @param Version:\r
    #\r
    def CheckModuleExists(self, Guid, Version, ReturnCode = DEPEX_CHECK_SUCCESS):\r
        EdkLogger.verbose("\nCheck module exists in workspace started ...")\r
        ModuleList = []\r
        ModuleList = self.IpiDb.GetModInPackage(Guid, Version)\r
        ModuleList.extend(self.IpiDb.GetStandaloneModule(Guid, Version))\r
        EdkLogger.verbose("Check module exists in workspace ... DONE!")\r
        if len(ModuleList) > 0:\r
            return True\r
        else:\r
            ReturnCode = DEPEX_CHECK_MODULE_NOT_FOUND\r
            return False\r
        \r
\r
    ## Check whether a module depex satisfied by current workspace.\r
    #\r
    # @param ModuleObj:  \r
    # @param DpObj:\r
    #\r
    def CheckModuleDepexSatisfied(self, ModuleObj, DpObj = None, ReturnCode = DEPEX_CHECK_SUCCESS):\r
        EdkLogger.verbose("\nCheck module depex met by workspace started ...")\r
        for Dep in ModuleObj.PackageDependencies:\r
            Exist = self.CheckPackageExists(Dep.PackageGuid, Dep.PackageVersion, ReturnCode)\r
            if not Exist:\r
                if DpObj == None:\r
                    ReturnCode = DEPEX_CHECK_PACKAGE_NOT_FOUND\r
                    return False\r
                for GuidVerPair in DpObj.PackageSurfaceArea.keys():\r
                    if Dep.PackageGuid == GuidVerPair[0]:\r
                        if Dep.PackageVersion == None or len(Dep.PackageVersion) == 0:\r
                            break\r
                        if Dep.PackageVersion == GuidVerPair[1]:\r
                            break\r
                        else:\r
                            ReturnCode = DEPEX_CHECK_PACKAGE_NOT_FOUND\r
                            return False\r
                else:\r
                    ReturnCode = DEPEX_CHECK_PACKAGE_NOT_FOUND\r
                    return False\r
        return True\r
        \r
        EdkLogger.verbose("Check module depex met by workspace ... DONE!")\r
    \r
    ## Check whether a package exists in current workspace.\r
    #\r
    # @param Guid:  \r
    # @param Version:\r
    #\r
    def CheckPackageExists(self, Guid, Version, ReturnCode = DEPEX_CHECK_SUCCESS):\r
        EdkLogger.verbose("\nCheck package exists in workspace started ...")\r
        PkgList = []\r
        PkgList = self.IpiDb.GetPackage(Guid, Version)\r
        if len(PkgList) > 0:\r
            return True\r
        else:\r
            ReturnCode = DEPEX_CHECK_PACKAGE_NOT_FOUND\r
            return False\r
        \r
        EdkLogger.verbose("Check package exists in workspace ... DONE!")\r
        \r
    ## Check whether a package depex satisfied by current workspace.\r
    #\r
    # @param ModuleObj:  \r
    # @param DpObj:\r
    #\r
    def CheckPackageDepexSatisfied(self, PkgObj, DpObj = None, ReturnCode = DEPEX_CHECK_SUCCESS):\r
        \r
        for ModKey in PkgObj.Modules.keys():\r
            ModObj = PkgObj.Modules[ModKey]\r
            if self.CheckModuleDepexSatisfied(ModObj, DpObj, ReturnCode):\r
                continue\r
            else:\r
                return False\r
        return True\r
        \r
    ## Check whether a DP exists in current workspace.\r
    #\r
    # @param Guid:  \r
    # @param Version:\r
    #\r
    def CheckDpExists(self, Guid, Version, ReturnCode = DEPEX_CHECK_SUCCESS):\r
        EdkLogger.verbose("\nCheck DP exists in workspace started ...")\r
        DpList = []\r
        DpList = self.IpiDb.GetDp(Guid, Version)\r
        if len(DpList) > 0:\r
            return True\r
        else:\r
            ReturnCode = DEPEX_CHECK_DP_NOT_FOUND\r
            return False\r
        \r
        EdkLogger.verbose("Check DP exists in workspace ... DONE!")\r
        \r
    ## Check whether a DP depex satisfied by current workspace.\r
    #\r
    # @param ModuleObj:  \r
    # @param DpObj:\r
    #\r
    def CheckDpDepexSatisfied(self, DpObj, ReturnCode = DEPEX_CHECK_SUCCESS):\r
        \r
        for PkgKey in DpObj.PackageSurfaceArea.keys():\r
            PkgObj = DpObj.PackageSurfaceArea[PkgKey]\r
            if self.CheckPackageDepexSatisfied(PkgObj, DpObj, ReturnCode):\r
                continue\r
            else:\r
                return False\r
            \r
        for ModKey in DpObj.ModuleSurfaceArea.keys():\r
            ModObj = PkgObj.ModuleSurfaceArea[ModKey]\r
            if self.CheckModuleDepexSatisfied(ModObj, DpObj, ReturnCode):\r
                continue\r
            else:\r
                return False\r
        \r
        return True\r
    \r
    ## Check whether a DP depex satisfied by current workspace.\r
    #\r
    # @param ModuleObj:  \r
    # @param DpObj:\r
    #\r
    def CheckDpDepexForRemove(self, DpGuid, DpVersion, ReturnCode = DEPEX_CHECK_SUCCESS):\r
        \r
        # Get mod list that is dependent on pkg installed from this DP.\r
        ModList = self.IpiDb.GetDpDependentModuleList(DpGuid, DpVersion)\r
        \r
        if len(ModList) > 0:\r
            return False\r
        \r
        return True\r
##\r
#\r
# This acts like the main() function for the script, unless it is 'import'ed into another\r
# script.\r
#\r
if __name__ == '__main__':\r
    EdkLogger.Initialize()\r
    EdkLogger.SetLevel(EdkLogger.DEBUG_0)\r
\r
\r