## @file | |
# This file is used to create/update/query/erase a meta file table | |
# | |
# Copyright (c) 2008 - 2016, Intel Corporation. All rights reserved.<BR> | |
# This program and the accompanying materials | |
# are licensed and made available under the terms and conditions of the BSD License | |
# which accompanies this distribution. The full text of the license may be found at | |
# http://opensource.org/licenses/bsd-license.php | |
# | |
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, | |
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. | |
# | |
## | |
# Import Modules | |
# | |
import uuid | |
import Common.EdkLogger as EdkLogger | |
from Common.BuildToolError import FORMAT_INVALID | |
from MetaDataTable import Table, TableFile | |
from MetaDataTable import ConvertToSqlString | |
from CommonDataClass.DataClass import MODEL_FILE_DSC, MODEL_FILE_DEC, MODEL_FILE_INF, \ | |
MODEL_FILE_OTHERS | |
from Common.DataType import * | |
class MetaFileTable(Table): | |
# TRICK: use file ID as the part before '.' | |
_ID_STEP_ = 0.00000001 | |
_ID_MAX_ = 0.99999999 | |
## Constructor | |
def __init__(self, Cursor, MetaFile, FileType, Temporary): | |
self.MetaFile = MetaFile | |
self._FileIndexTable = TableFile(Cursor) | |
self._FileIndexTable.Create(False) | |
FileId = self._FileIndexTable.GetFileId(MetaFile) | |
if not FileId: | |
FileId = self._FileIndexTable.InsertFile(MetaFile, FileType) | |
if Temporary: | |
TableName = "_%s_%s_%s" % (FileType, FileId, uuid.uuid4().hex) | |
else: | |
TableName = "_%s_%s" % (FileType, FileId) | |
#Table.__init__(self, Cursor, TableName, FileId, False) | |
Table.__init__(self, Cursor, TableName, FileId, Temporary) | |
self.Create(not self.IsIntegrity()) | |
def IsIntegrity(self): | |
try: | |
TimeStamp = self.MetaFile.TimeStamp | |
Result = self.Cur.execute("select ID from %s where ID<0" % (self.Table)).fetchall() | |
if not Result: | |
# update the timestamp in database | |
self._FileIndexTable.SetFileTimeStamp(self.IdBase, TimeStamp) | |
return False | |
if TimeStamp != self._FileIndexTable.GetFileTimeStamp(self.IdBase): | |
# update the timestamp in database | |
self._FileIndexTable.SetFileTimeStamp(self.IdBase, TimeStamp) | |
return False | |
except Exception, Exc: | |
EdkLogger.debug(EdkLogger.DEBUG_5, str(Exc)) | |
return False | |
return True | |
## Python class representation of table storing module data | |
class ModuleTable(MetaFileTable): | |
_ID_STEP_ = 0.00000001 | |
_ID_MAX_ = 0.99999999 | |
_COLUMN_ = ''' | |
ID REAL PRIMARY KEY, | |
Model INTEGER NOT NULL, | |
Value1 TEXT NOT NULL, | |
Value2 TEXT, | |
Value3 TEXT, | |
Scope1 TEXT, | |
Scope2 TEXT, | |
BelongsToItem REAL NOT NULL, | |
StartLine INTEGER NOT NULL, | |
StartColumn INTEGER NOT NULL, | |
EndLine INTEGER NOT NULL, | |
EndColumn INTEGER NOT NULL, | |
Enabled INTEGER DEFAULT 0 | |
''' | |
# used as table end flag, in case the changes to database is not committed to db file | |
_DUMMY_ = "-1, -1, '====', '====', '====', '====', '====', -1, -1, -1, -1, -1, -1" | |
## Constructor | |
def __init__(self, Cursor, MetaFile, Temporary): | |
MetaFileTable.__init__(self, Cursor, MetaFile, MODEL_FILE_INF, Temporary) | |
## Insert a record into table Inf | |
# | |
# @param Model: Model of a Inf item | |
# @param Value1: Value1 of a Inf item | |
# @param Value2: Value2 of a Inf item | |
# @param Value3: Value3 of a Inf item | |
# @param Scope1: Arch of a Inf item | |
# @param Scope2 Platform os a Inf item | |
# @param BelongsToItem: The item belongs to which another item | |
# @param StartLine: StartLine of a Inf item | |
# @param StartColumn: StartColumn of a Inf item | |
# @param EndLine: EndLine of a Inf item | |
# @param EndColumn: EndColumn of a Inf item | |
# @param Enabled: If this item enabled | |
# | |
def Insert(self, Model, Value1, Value2, Value3, Scope1='COMMON', Scope2='COMMON', | |
BelongsToItem=-1, StartLine=-1, StartColumn=-1, EndLine=-1, EndColumn=-1, Enabled=0): | |
(Value1, Value2, Value3, Scope1, Scope2) = ConvertToSqlString((Value1, Value2, Value3, Scope1, Scope2)) | |
return Table.Insert( | |
self, | |
Model, | |
Value1, | |
Value2, | |
Value3, | |
Scope1, | |
Scope2, | |
BelongsToItem, | |
StartLine, | |
StartColumn, | |
EndLine, | |
EndColumn, | |
Enabled | |
) | |
## Query table | |
# | |
# @param Model: The Model of Record | |
# @param Arch: The Arch attribute of Record | |
# @param Platform The Platform attribute of Record | |
# | |
# @retval: A recordSet of all found records | |
# | |
def Query(self, Model, Arch=None, Platform=None, BelongsToItem=None): | |
ConditionString = "Model=%s AND Enabled>=0" % Model | |
ValueString = "Value1,Value2,Value3,Scope1,Scope2,ID,StartLine" | |
if Arch != None and Arch != 'COMMON': | |
ConditionString += " AND (Scope1='%s' OR Scope1='COMMON')" % Arch | |
if Platform != None and Platform != 'COMMON': | |
ConditionString += " AND (Scope2='%s' OR Scope2='COMMON' OR Scope2='DEFAULT')" % Platform | |
if BelongsToItem != None: | |
ConditionString += " AND BelongsToItem=%s" % BelongsToItem | |
SqlCommand = "SELECT %s FROM %s WHERE %s" % (ValueString, self.Table, ConditionString) | |
return self.Exec(SqlCommand) | |
## Python class representation of table storing package data | |
class PackageTable(MetaFileTable): | |
_COLUMN_ = ''' | |
ID REAL PRIMARY KEY, | |
Model INTEGER NOT NULL, | |
Value1 TEXT NOT NULL, | |
Value2 TEXT, | |
Value3 TEXT, | |
Scope1 TEXT, | |
Scope2 TEXT, | |
BelongsToItem REAL NOT NULL, | |
StartLine INTEGER NOT NULL, | |
StartColumn INTEGER NOT NULL, | |
EndLine INTEGER NOT NULL, | |
EndColumn INTEGER NOT NULL, | |
Enabled INTEGER DEFAULT 0 | |
''' | |
# used as table end flag, in case the changes to database is not committed to db file | |
_DUMMY_ = "-1, -1, '====', '====', '====', '====', '====', -1, -1, -1, -1, -1, -1" | |
## Constructor | |
def __init__(self, Cursor, MetaFile, Temporary): | |
MetaFileTable.__init__(self, Cursor, MetaFile, MODEL_FILE_DEC, Temporary) | |
## Insert table | |
# | |
# Insert a record into table Dec | |
# | |
# @param Model: Model of a Dec item | |
# @param Value1: Value1 of a Dec item | |
# @param Value2: Value2 of a Dec item | |
# @param Value3: Value3 of a Dec item | |
# @param Scope1: Arch of a Dec item | |
# @param Scope2: Module type of a Dec item | |
# @param BelongsToItem: The item belongs to which another item | |
# @param StartLine: StartLine of a Dec item | |
# @param StartColumn: StartColumn of a Dec item | |
# @param EndLine: EndLine of a Dec item | |
# @param EndColumn: EndColumn of a Dec item | |
# @param Enabled: If this item enabled | |
# | |
def Insert(self, Model, Value1, Value2, Value3, Scope1='COMMON', Scope2='COMMON', | |
BelongsToItem=-1, StartLine=-1, StartColumn=-1, EndLine=-1, EndColumn=-1, Enabled=0): | |
(Value1, Value2, Value3, Scope1, Scope2) = ConvertToSqlString((Value1, Value2, Value3, Scope1, Scope2)) | |
return Table.Insert( | |
self, | |
Model, | |
Value1, | |
Value2, | |
Value3, | |
Scope1, | |
Scope2, | |
BelongsToItem, | |
StartLine, | |
StartColumn, | |
EndLine, | |
EndColumn, | |
Enabled | |
) | |
## Query table | |
# | |
# @param Model: The Model of Record | |
# @param Arch: The Arch attribute of Record | |
# | |
# @retval: A recordSet of all found records | |
# | |
def Query(self, Model, Arch=None): | |
ConditionString = "Model=%s AND Enabled>=0" % Model | |
ValueString = "Value1,Value2,Value3,Scope1,Scope2,ID,StartLine" | |
if Arch != None and Arch != 'COMMON': | |
ConditionString += " AND (Scope1='%s' OR Scope1='COMMON')" % Arch | |
SqlCommand = "SELECT %s FROM %s WHERE %s" % (ValueString, self.Table, ConditionString) | |
return self.Exec(SqlCommand) | |
def GetValidExpression(self, TokenSpaceGuid, PcdCName): | |
SqlCommand = "select Value1,StartLine from %s WHERE Value2='%s' and Value3='%s'" % (self.Table, TokenSpaceGuid, PcdCName) | |
self.Cur.execute(SqlCommand) | |
validateranges = [] | |
validlists = [] | |
expressions = [] | |
try: | |
for row in self.Cur: | |
comment = row[0] | |
LineNum = row[1] | |
comment = comment.strip("#") | |
comment = comment.strip() | |
oricomment = comment | |
if comment.startswith("@ValidRange"): | |
comment = comment.replace("@ValidRange", "", 1) | |
validateranges.append(comment.split("|")[1].strip()) | |
if comment.startswith("@ValidList"): | |
comment = comment.replace("@ValidList", "", 1) | |
validlists.append(comment.split("|")[1].strip()) | |
if comment.startswith("@Expression"): | |
comment = comment.replace("@Expression", "", 1) | |
expressions.append(comment.split("|")[1].strip()) | |
except Exception, Exc: | |
ValidType = "" | |
if oricomment.startswith("@ValidRange"): | |
ValidType = "@ValidRange" | |
if oricomment.startswith("@ValidList"): | |
ValidType = "@ValidList" | |
if oricomment.startswith("@Expression"): | |
ValidType = "@Expression" | |
EdkLogger.error('Parser', FORMAT_INVALID, "The syntax for %s of PCD %s.%s is incorrect" % (ValidType,TokenSpaceGuid, PcdCName), | |
ExtraData=oricomment,File=self.MetaFile, Line=LineNum) | |
return set(), set(), set() | |
return set(validateranges), set(validlists), set(expressions) | |
## Python class representation of table storing platform data | |
class PlatformTable(MetaFileTable): | |
_COLUMN_ = ''' | |
ID REAL PRIMARY KEY, | |
Model INTEGER NOT NULL, | |
Value1 TEXT NOT NULL, | |
Value2 TEXT, | |
Value3 TEXT, | |
Scope1 TEXT, | |
Scope2 TEXT, | |
Scope3 TEXT, | |
BelongsToItem REAL NOT NULL, | |
FromItem REAL NOT NULL, | |
StartLine INTEGER NOT NULL, | |
StartColumn INTEGER NOT NULL, | |
EndLine INTEGER NOT NULL, | |
EndColumn INTEGER NOT NULL, | |
Enabled INTEGER DEFAULT 0 | |
''' | |
# used as table end flag, in case the changes to database is not committed to db file | |
_DUMMY_ = "-1, -1, '====', '====', '====', '====', '====','====', -1, -1, -1, -1, -1, -1, -1" | |
## Constructor | |
def __init__(self, Cursor, MetaFile, Temporary): | |
MetaFileTable.__init__(self, Cursor, MetaFile, MODEL_FILE_DSC, Temporary) | |
## Insert table | |
# | |
# Insert a record into table Dsc | |
# | |
# @param Model: Model of a Dsc item | |
# @param Value1: Value1 of a Dsc item | |
# @param Value2: Value2 of a Dsc item | |
# @param Value3: Value3 of a Dsc item | |
# @param Scope1: Arch of a Dsc item | |
# @param Scope2: Module type of a Dsc item | |
# @param BelongsToItem: The item belongs to which another item | |
# @param FromItem: The item belongs to which dsc file | |
# @param StartLine: StartLine of a Dsc item | |
# @param StartColumn: StartColumn of a Dsc item | |
# @param EndLine: EndLine of a Dsc item | |
# @param EndColumn: EndColumn of a Dsc item | |
# @param Enabled: If this item enabled | |
# | |
def Insert(self, Model, Value1, Value2, Value3, Scope1='COMMON', Scope2='COMMON', Scope3=TAB_DEFAULT_STORES_DEFAULT,BelongsToItem=-1, | |
FromItem=-1, StartLine=-1, StartColumn=-1, EndLine=-1, EndColumn=-1, Enabled=1): | |
(Value1, Value2, Value3, Scope1, Scope2,Scope3) = ConvertToSqlString((Value1, Value2, Value3, Scope1, Scope2,Scope3)) | |
return Table.Insert( | |
self, | |
Model, | |
Value1, | |
Value2, | |
Value3, | |
Scope1, | |
Scope2, | |
Scope3, | |
BelongsToItem, | |
FromItem, | |
StartLine, | |
StartColumn, | |
EndLine, | |
EndColumn, | |
Enabled | |
) | |
## Query table | |
# | |
# @param Model: The Model of Record | |
# @param Scope1: Arch of a Dsc item | |
# @param Scope2: Module type of a Dsc item | |
# @param BelongsToItem: The item belongs to which another item | |
# @param FromItem: The item belongs to which dsc file | |
# | |
# @retval: A recordSet of all found records | |
# | |
def Query(self, Model, Scope1=None, Scope2=None, BelongsToItem=None, FromItem=None): | |
ConditionString = "Model=%s AND Enabled>0" % Model | |
ValueString = "Value1,Value2,Value3,Scope1,Scope2,Scope3,ID,StartLine" | |
if Scope1 != None and Scope1 != 'COMMON': | |
ConditionString += " AND (Scope1='%s' OR Scope1='COMMON')" % Scope1 | |
if Scope2 != None and Scope2 != 'COMMON': | |
# Cover the case that CodeBase is 'COMMON' for BuildOptions section | |
if '.' in Scope2: | |
Index = Scope2.index('.') | |
NewScope = 'COMMON'+ Scope2[Index:] | |
ConditionString += " AND (Scope2='%s' OR Scope2='COMMON' OR Scope2='DEFAULT' OR Scope2='%s')" % (Scope2, NewScope) | |
else: | |
ConditionString += " AND (Scope2='%s' OR Scope2='COMMON' OR Scope2='DEFAULT')" % Scope2 | |
if BelongsToItem != None: | |
ConditionString += " AND BelongsToItem=%s" % BelongsToItem | |
else: | |
ConditionString += " AND BelongsToItem<0" | |
if FromItem != None: | |
ConditionString += " AND FromItem=%s" % FromItem | |
SqlCommand = "SELECT %s FROM %s WHERE %s" % (ValueString, self.Table, ConditionString) | |
return self.Exec(SqlCommand) | |
## Factory class to produce different storage for different type of meta-file | |
class MetaFileStorage(object): | |
_FILE_TABLE_ = { | |
MODEL_FILE_INF : ModuleTable, | |
MODEL_FILE_DEC : PackageTable, | |
MODEL_FILE_DSC : PlatformTable, | |
MODEL_FILE_OTHERS : MetaFileTable, | |
} | |
_FILE_TYPE_ = { | |
".inf" : MODEL_FILE_INF, | |
".dec" : MODEL_FILE_DEC, | |
".dsc" : MODEL_FILE_DSC, | |
} | |
## Constructor | |
def __new__(Class, Cursor, MetaFile, FileType=None, Temporary=False): | |
# no type given, try to find one | |
if not FileType: | |
if MetaFile.Type in self._FILE_TYPE_: | |
FileType = Class._FILE_TYPE_[MetaFile.Type] | |
else: | |
FileType = MODEL_FILE_OTHERS | |
# don't pass the type around if it's well known | |
if FileType == MODEL_FILE_OTHERS: | |
Args = (Cursor, MetaFile, FileType, Temporary) | |
else: | |
Args = (Cursor, MetaFile, Temporary) | |
# create the storage object and return it to caller | |
return Class._FILE_TABLE_[FileType](*Args) | |