using System.Data;
using System.Diagnostics;
using System.Reflection;
using System.Text;
using Dapper;
namespace CrupestApi.Commons.Crud;
///
/// Contains all you need to manipulate a table.
///
public class TableInfo
{
private readonly IColumnTypeProvider _columnTypeProvider;
private readonly Lazy> _lazyColumnNameList;
private readonly ILogger _logger;
public TableInfo(Type entityType, IColumnTypeProvider columnTypeProvider, ILogger logger)
: this(entityType.Name, entityType, columnTypeProvider, logger)
{
}
public TableInfo(string tableName, Type entityType, IColumnTypeProvider columnTypeProvider, ILogger logger)
{
_columnTypeProvider = columnTypeProvider;
_logger = logger;
TableName = tableName;
EntityType = entityType;
var properties = entityType.GetProperties();
var columnInfos = new List();
bool hasId = false;
ColumnInfo? primaryKeyColumn = null;
ColumnInfo? keyColumn = null;
List nonColumnProperties = new();
foreach (var property in properties)
{
if (CheckPropertyIsColumn(property))
{
var columnInfo = new ColumnInfo(this, property, _columnTypeProvider);
columnInfos.Add(columnInfo);
if (columnInfo.IsPrimaryKey)
{
primaryKeyColumn = columnInfo;
}
if (columnInfo.ColumnName.Equals("id", StringComparison.OrdinalIgnoreCase))
{
hasId = true;
}
if (columnInfo.IsSpecifiedAsKey)
{
if (keyColumn is not null)
{
throw new Exception("Already exists a key column.");
}
keyColumn = columnInfo;
}
}
else
{
nonColumnProperties.Add(property);
}
}
if (primaryKeyColumn is null)
{
if (hasId) throw new Exception("A column named id already exists but is not primary key.");
primaryKeyColumn = CreateAutoIdColumn();
columnInfos.Add(primaryKeyColumn);
}
if (keyColumn is null)
{
keyColumn = primaryKeyColumn;
}
Columns = columnInfos;
PrimaryKeyColumn = primaryKeyColumn;
KeyColumn = keyColumn;
NonColumnProperties = nonColumnProperties;
CheckValidity();
_lazyColumnNameList = new Lazy>(() => Columns.Select(c => c.ColumnName).ToList());
}
private ColumnInfo CreateAutoIdColumn()
{
return new ColumnInfo(this,
new ColumnAttribute
{
ColumnName = "Id",
NotNull = true,
IsPrimaryKey = true,
IsAutoIncrement = true,
},
typeof(long), _columnTypeProvider);
}
public Type EntityType { get; }
public string TableName { get; }
public IReadOnlyList Columns { get; }
public IReadOnlyList PropertyColumns => Columns.Where(c => c.PropertyInfo is not null).ToList();
public ColumnInfo PrimaryKeyColumn { get; }
///
/// Maybe not the primary key. But acts as primary key.
///
///
public ColumnInfo KeyColumn { get; }
public IReadOnlyList ColumnProperties => PropertyColumns.Select(c => c.PropertyInfo!).ToList();
public IReadOnlyList NonColumnProperties { get; }
public IReadOnlyList ColumnNameList => _lazyColumnNameList.Value;
protected bool CheckPropertyIsColumn(PropertyInfo property)
{
var columnAttribute = property.GetCustomAttribute();
if (columnAttribute is null) return false;
return true;
}
public ColumnInfo GetColumn(string columnName)
{
foreach (var column in Columns)
{
if (column.ColumnName.Equals(columnName, StringComparison.OrdinalIgnoreCase))
{
return column;
}
}
throw new KeyNotFoundException("No such column with given name.");
}
public void CheckValidity()
{
// Check if there is only one primary key.
bool hasPrimaryKey = false;
bool hasKey = false;
foreach (var column in Columns)
{
if (column.IsPrimaryKey)
{
if (hasPrimaryKey) throw new Exception("More than one columns are primary key.");
hasPrimaryKey = true;
}
if (column.IsSpecifiedAsKey)
{
if (hasKey) throw new Exception("More than one columns are specified as key column.");
}
}
if (!hasPrimaryKey) throw new Exception("No column is primary key.");
// Check two columns have the same sql name.
HashSet sqlNameSet = new HashSet();
foreach (var column in Columns)
{
if (sqlNameSet.Contains(column.ColumnName))
throw new Exception($"Two columns have the same sql name '{column.ColumnName}'.");
sqlNameSet.Add(column.ColumnName);
}
}
public string GenerateCreateIndexSql(string? dbProviderId = null)
{
var sb = new StringBuilder();
foreach (var column in Columns)
{
if (column.Index == ColumnIndexType.None) continue;
sb.Append($"CREATE {(column.Index == ColumnIndexType.Unique ? "UNIQUE" : "")} INDEX {TableName}_{column.ColumnName}_index ON {TableName} ({column.ColumnName});\n");
}
return sb.ToString();
}
public string GenerateCreateTableSql(bool createIndex = true, string? dbProviderId = null)
{
var tableName = TableName;
var columnSql = string.Join(",\n", Columns.Select(c => c.GenerateCreateTableColumnString(dbProviderId)));
var sql = $@"
CREATE TABLE {tableName}(
{columnSql}
);
";
if (createIndex)
{
sql += GenerateCreateIndexSql(dbProviderId);
}
return sql;
}
public bool CheckExistence(IDbConnection connection)
{
var tableName = TableName;
var count = connection.QuerySingle(
@"SELECT count(*) FROM sqlite_schema WHERE type = 'table' AND tbl_name = @TableName;",
new { TableName = tableName });
if (count == 0)
{
return false;
}
else if (count > 1)
{
throw new Exception($"More than 1 table has name {tableName}. What happened?");
}
else
{
return true;
}
}
public void CheckColumnName(string columnName)
{
if (!ColumnNameList.Contains(columnName))
{
throw new ArgumentException($"Column {columnName} is not in the table.");
}
}
public void CheckRelatedColumns(IClause? clause)
{
if (clause is not null)
{
var relatedColumns = clause.GetRelatedColumns();
foreach (var column in relatedColumns)
{
CheckColumnName(column);
}
}
}
///
/// If you call this manually, it's your duty to call hooks.
///
///
public (string sql, ParamList parameters) GenerateSelectSql(string? selectWhat, IWhereClause? whereClause, IOrderByClause? orderByClause = null, int? skip = null, int? limit = null, string? dbProviderId = null)
{
CheckRelatedColumns(whereClause);
CheckRelatedColumns(orderByClause);
var parameters = new ParamList();
StringBuilder result = new StringBuilder()
.Append($"SELECT {selectWhat ?? "*"} FROM ")
.Append(TableName);
if (whereClause is not null)
{
result.Append(' ');
var (whereSql, whereParameters) = whereClause.GenerateSql(dbProviderId);
parameters.AddRange(whereParameters);
result.Append(whereSql);
}
if (orderByClause is not null)
{
result.Append(' ');
var (orderBySql, orderByParameters) = orderByClause.GenerateSql(dbProviderId);
parameters.AddRange(orderByParameters);
result.Append(orderBySql);
}
if (limit is not null)
{
result.Append(" LIMIT @Limit");
parameters.Add("Limit", limit.Value);
}
if (skip is not null)
{
result.Append(" OFFSET @Skip");
parameters.Add("Skip", skip.Value);
}
result.Append(';');
return (result.ToString(), parameters);
}
///
/// If you call this manually, it's your duty to call hooks.
///
///
public (string sql, ParamList parameters) GenerateInsertSql(IInsertClause insertClause, string? dbProviderId = null)
{
CheckRelatedColumns(insertClause);
var parameters = new ParamList();
var result = new StringBuilder()
.Append("INSERT INTO ")
.Append(TableName)
.Append(" (")
.Append(insertClause.GenerateColumnListSql(dbProviderId))
.Append(") VALUES (");
var (valueSql, valueParameters) = insertClause.GenerateValueListSql(dbProviderId);
result.Append(valueSql).Append(");");
parameters.AddRange(valueParameters);
return (result.ToString(), parameters);
}
///
/// If you call this manually, it's your duty to call hooks.
///
///
public (string sql, ParamList parameters) GenerateUpdateSql(IWhereClause? whereClause, IUpdateClause updateClause)
{
CheckRelatedColumns(whereClause);
CheckRelatedColumns(updateClause);
var parameters = new ParamList();
StringBuilder sb = new StringBuilder("UPDATE ");
sb.Append(TableName);
sb.Append(" SET ");
var (updateSql, updateParameters) = updateClause.GenerateSql();
sb.Append(updateSql);
parameters.AddRange(updateParameters);
if (whereClause is not null)
{
sb.Append(" WHERE ");
var (whereSql, whereParameters) = whereClause.GenerateSql();
sb.Append(whereSql);
parameters.AddRange(whereParameters);
}
sb.Append(';');
return (sb.ToString(), parameters);
}
///
/// If you call this manually, it's your duty to call hooks.
///
///
public (string sql, ParamList parameters) GenerateDeleteSql(IWhereClause? whereClause)
{
CheckRelatedColumns(whereClause);
var parameters = new ParamList();
StringBuilder sb = new StringBuilder("DELETE FROM ");
sb.Append(TableName);
if (whereClause is not null)
{
sb.Append(" WHERE ");
var (whereSql, whereParameters) = whereClause.GenerateSql();
parameters.AddRange(whereParameters);
sb.Append(whereSql);
}
sb.Append(';');
return (sb.ToString(), parameters);
}
private DynamicParameters ConvertParameters(ParamList parameters)
{
var result = new DynamicParameters();
foreach (var param in parameters)
{
if (param.Value is null || param.Value is DbNullValue)
{
result.Add(param.Name, null);
continue;
}
var columnName = param.ColumnName;
IColumnTypeInfo typeInfo;
if (columnName is not null)
{
typeInfo = GetColumn(columnName).ColumnType;
}
else
{
typeInfo = _columnTypeProvider.Get(param.Value.GetType());
}
result.Add(param.Name, typeInfo.ConvertToDatabase(param.Value), typeInfo.DbType);
}
return result;
}
///
/// ConvertParameters. Select. Call hooks.
///
public virtual List SelectDynamic(IDbConnection dbConnection, string? what = null, IWhereClause? where = null, IOrderByClause? orderBy = null, int? skip = null, int? limit = null)
{
var (sql, parameters) = GenerateSelectSql(what, where, orderBy, skip, limit);
var queryResult = dbConnection.Query(sql, ConvertParameters(parameters));
return queryResult.ToList();
}
public virtual int SelectCount(IDbConnection dbConnection, IWhereClause? where = null, IOrderByClause? orderBy = null, int? skip = null, int? limit = null)
{
var (sql, parameters) = GenerateSelectSql("COUNT(*)", where, orderBy, skip, limit);
return dbConnection.QuerySingle(sql, parameters);
}
public virtual TResult MapDynamicTo(dynamic d)
{
var result = Activator.CreateInstance();
Type dynamicType = d.GetType();
Type resultType = typeof(TResult);
foreach (var column in Columns)
{
var dynamicProperty = dynamicType.GetProperty(column.ColumnName);
// TODO: Maybe we can do better to get result property in case ColumnName is set to another value.
var resultProperty = resultType.GetProperty(column.ColumnName);
if (dynamicProperty is not null && resultProperty is not null)
{
resultProperty.SetValue(result, dynamicProperty.GetValue(d));
}
}
return result;
}
///
/// Select and call hooks.
///
public virtual List Select(IDbConnection dbConnection, string? what = null, IWhereClause? where = null, IOrderByClause? orderBy = null, int? skip = null, int? limit = null)
{
List queryResult = SelectDynamic(dbConnection, what, where, orderBy, skip, limit).ToList();
return queryResult.Select(MapDynamicTo).ToList();
}
public IInsertClause ConvertEntityToInsertClause(object entity)
{
Debug.Assert(EntityType.IsInstanceOfType(entity));
var result = new InsertClause();
foreach (var column in PropertyColumns)
{
var value = column.PropertyInfo!.GetValue(entity);
result.Add(column.ColumnName, value);
}
return result;
}
///
/// Insert a entity and call hooks.
///
/// The key of insert entity.
public object Insert(IDbConnection dbConnection, IInsertClause insert)
{
object? key = null;
var realInsert = InsertClause.Create();
foreach (var column in Columns)
{
InsertItem? item = insert.Items.SingleOrDefault(i => i.ColumnName == column.ColumnName);
var value = item?.Value;
if (column.IsGenerated && value is not null)
{
throw new Exception($"The column '{column.ColumnName}' is auto generated. You can't specify it explicitly.");
}
if (value is null)
{
value = column.InvokeDefaultValueGenerator();
}
if (value is null && column.IsAutoIncrement)
{
continue;
}
if (value is null)
{
value = DbNullValue.Instance;
}
column.InvokeValidator(value);
if (value is DbNullValue)
{
if (column.IsNotNull)
{
throw new Exception($"Column '{column.ColumnName}' is not nullable. Please specify a non-null value.");
}
realInsert.Add(column.ColumnName, null);
}
else
{
realInsert.Add(column.ColumnName, value);
}
if (item?.ColumnName == KeyColumn.ColumnName)
{
key = item.Value;
}
}
var (sql, parameters) = GenerateInsertSql(insert);
dbConnection.Execute(sql, ConvertParameters(parameters));
return key ?? throw new Exception("No key???");
}
public object Insert(IDbConnection dbConnection, object entity)
{
Debug.Assert(EntityType.IsInstanceOfType(entity));
var insert = ConvertEntityToInsertClause(entity);
return Insert(dbConnection, insert);
}
///
/// Upgrade a entity and call hooks.
///
/// The key of insert entity.
public virtual int Update(IDbConnection dbConnection, IWhereClause? where, IUpdateClause update)
{
var realUpdate = UpdateClause.Create();
foreach (var column in Columns)
{
UpdateItem? item = update.Items.FirstOrDefault(i => i.ColumnName == column.ColumnName);
object? value = item?.Value;
if (value is not null)
{
if (column.IsNoUpdate)
{
throw new Exception($"The column '{column.ColumnName}' can't be update.");
}
column.InvokeValidator(value);
realUpdate.Add(column.ColumnName, value);
}
}
var (sql, parameters) = GenerateUpdateSql(where, realUpdate);
return dbConnection.Execute(sql, ConvertParameters(parameters));
}
public virtual int Delete(IDbConnection dbConnection, IWhereClause? where)
{
var (sql, parameters) = GenerateDeleteSql(where);
return dbConnection.Execute(sql, ConvertParameters(parameters));
}
}
public interface ITableInfoFactory
{
TableInfo Get(Type type);
}
public class TableInfoFactory : ITableInfoFactory
{
private readonly Dictionary _cache = new Dictionary();
private readonly IColumnTypeProvider _columnTypeProvider;
private readonly ILoggerFactory _loggerFactory;
public TableInfoFactory(IColumnTypeProvider columnTypeProvider, ILoggerFactory loggerFactory)
{
_columnTypeProvider = columnTypeProvider;
_loggerFactory = loggerFactory;
}
// This is thread-safe.
public TableInfo Get(Type type)
{
lock (_cache)
{
if (_cache.TryGetValue(type, out var tableInfo))
{
return tableInfo;
}
else
{
tableInfo = new TableInfo(type, _columnTypeProvider, _loggerFactory.CreateLogger());
_cache.Add(type, tableInfo);
return tableInfo;
}
}
}
}