#if EXTRA /* 2021.08.03 */ using Apewer; using Apewer.Source; using System; using System.Collections.Generic; using System.Data; using System.Data.SQLite; using System.Text; using System.Data.Common; //using Mono.Data.Sqlite; namespace Apewer.Source { /// 用于快速连接 SQLite 数据库的辅助。 public class Sqlite : IDatabase, IOrm, IDisposable { #region 变量定义。 private SQLiteConnection _db = null; private Timeout _timeout = new Timeout(); private string _connstring = ""; private string _path = ""; private string _pass = ""; private byte[] _passdata = BinaryUtility.EmptyBytes; #endregion #region this private void VarInit(string path, Timeout timeout, string pass, byte[] passData) { _path = (path == null) ? "" : path; _passdata = (passData == null) ? BinaryUtility.EmptyBytes : passData; _pass = (pass == null) ? "" : pass; _timeout = timeout; } /// 连接内存。 public Sqlite() => VarInit(Memory, new Timeout(), null, null); /// 连接指定文件。 public Sqlite(string path) => VarInit(path, new Timeout(), null, null); /// 连接指定文件。 private Sqlite(string path, byte[] passData) => VarInit(path, new Timeout(), null, passData); /// 连接指定文件。 public Sqlite(string path, string pass) => VarInit(path, new Timeout(), pass, null); /// 连接指定文件。 public Sqlite(string path, Timeout timeout) => VarInit(path, timeout, null, null); /// 连接指定文件。 private Sqlite(string path, Timeout timeout, byte[] pass) => VarInit(path, timeout, null, pass); /// 连接指定文件。 public Sqlite(string path, Timeout timeout, string pass) => VarInit(path, timeout, pass, null); #endregion #region 日志。 /// 获取或设置日志记录。 public Logger Logger { get; set; } private void LogError(string action, Exception ex, string addtion) { var logger = Logger; if (logger != null) logger.Error(this, "SQLite", action, ex.GetType().FullName, ex.Message, addtion); } private void LogError(string action, string message) { var logger = Logger; if (logger != null) logger.Error(this, "SQLite", action, message); } #endregion #region 实现接口。 /// 数据库是否已经连接。 public bool Online { get => _db != null && _db.State == ConnectionState.Open; } /// 连接数据库,若未连接则尝试连接。 /// 是否已连接。 public bool Connect() { if (_db == null) { _db = new SQLiteConnection(); _db.ConnectionString = ConnectionString; //if (string.IsNullOrEmpty(_connstring) && string.IsNullOrEmpty(_pass) && (_passdata.Length > 0)) //{ // _db.SetPassword(_pass); //} } else { if (_db.State == ConnectionState.Open) return true; } try { _db.Open(); switch (_db.State) { case ConnectionState.Open: return true; default: return false; } } catch (Exception ex) { LogError("Connection", ex, _db.ConnectionString); Close(); return false; } } /// 关闭连接,并释放对象所占用的系统资源。 public void Close() { if (_db != null) { //_db.Close(); _db.Dispose(); _db = null; } } /// 关闭连接,释放对象所占用的系统资源,并清除连接信息。 public void Dispose() { Close(); } /// 查询。 public IQuery Query(string sql) => Query(sql, null); /// 查询。 public IQuery Query(string sql, IEnumerable parameters) { if (string.IsNullOrEmpty(sql)) return Example.InvalidQueryStatement; const string table = "result"; var connected = Connect(); if (!connected) return Example.InvalidQueryConnection; var query = new Query(); try { var command = new SQLiteCommand(); command.Connection = _db; command.CommandTimeout = Timeout.Query; command.CommandText = sql; if (parameters != null) { foreach (var p in parameters) { if (p != null) command.Parameters.Add(p); } } using (var dataset = new DataSet()) { using (var da = new SQLiteDataAdapter(sql, _db)) { da.Fill(dataset, table); query.Table = dataset.Tables[table]; } } command.Dispose(); query.Success = true; } catch (Exception ex) { LogError("Query", ex, sql); query.Success = false; query.Exception = ex; } return query; } /// 执行单条 Transact-SQL 语句。 public IExecute Execute(string sql) => Execute(sql, null); /// 执行单条 Transact-SQL 语句,并加入参数。 public IExecute Execute(string sql, IEnumerable parameters) { if (string.IsNullOrEmpty(sql)) return Example.InvalidExecuteStatement; var connected = Connect(); if (!connected) return Example.InvalidExecuteConnection; var transaction = _db.BeginTransaction(); var execute = new Execute(); try { var command = new SQLiteCommand(); command.Connection = _db; command.Transaction = transaction; command.CommandTimeout = Timeout.Execute; command.CommandText = sql; if (parameters != null) { foreach (var p in parameters) { if (p != null) command.Parameters.Add(p); } } execute.Rows += command.ExecuteNonQuery(); transaction.Commit(); command.Dispose(); execute.Success = true; } catch (Exception ex) { try { transaction.Rollback(); } catch { } LogError("Execute", ex, sql); execute.Success = false; execute.Exception = ex; } try { transaction.Dispose(); } catch { } return execute; } #endregion #region 属性。 /// 获取当前的 SQLiteConnection 对象。 public IDbConnection Connection { get => _db; } /// 获取或设置超时。 public Timeout Timeout { get => _timeout; set => _timeout = value; } /// 获取或设置连接字符串,连接字符串非空时将忽略 Path 属性。数据库在线时无法设置。 public string ConnectionString { get { if (string.IsNullOrEmpty(_connstring)) { var temp = new StringBuilder(); temp.Append("data source='", _path, "'; version=3; "); if (!string.IsNullOrEmpty(_pass)) temp.Append("password=", _pass, "; "); return temp.ToString(); } else return _connstring; } set { if (Online) return; _connstring = string.IsNullOrEmpty(value) ? "" : value; } } /// 获取或设置数据库路径(文件或内存)。数据库在线时无法设置。 public string Path { get { return _path; } set { if (Online) return; _path = string.IsNullOrEmpty(value) ? "" : value; } } /// 获取或设置数据库密码。数据库在线时无法设置。 public string Password { get { return _pass; } set { if (Online) return; _pass = string.IsNullOrEmpty(value) ? "" : value; } } /// 获取或设置数据库密码。数据库在线时无法设置。 private byte[] PasswordData { get { return _passdata; } set { if (Online) return; _passdata = (value == null) ? BinaryUtility.EmptyBytes : value; } } /// 保存当前数据库到文件,若文件已存在则将重写文件。 public bool Save(string path) { if (!StorageUtility.CreateFile(path, 0, true)) { LogError("Save", TextUtility.Merge("创建文件 ", path, " 失败。")); return false; } var temp = new Sqlite(path); var result = Save(temp); temp.Close(); return result; } /// 保存当前数据库到文件,若文件已存在则将重写文件。 public bool Save(string path, string password) { if (!StorageUtility.CreateFile(path, 0, true)) { LogError("Save", TextUtility.Merge("创建文件 ", path, " 失败。")); return false; } var temp = new Sqlite(path, password); var result = Save(temp); temp.Close(); return result; } /// 保存当前数据库到目标数据库。 public bool Save(Sqlite destination) { var error = Backup(this, destination); return string.IsNullOrEmpty(error); } /// 加载文件到当前数据库。 public bool Load(string path) { var temp = new Sqlite(path); var result = Load(temp); temp.Close(); return result; } /// 加载文件到当前数据库。 public bool Load(string path, params byte[] pass) { var temp = new Sqlite(path, pass); var result = Load(temp); temp.Close(); return result; } /// 加载文件到当前数据库。 public bool Load(string path, string pass) { var temp = new Sqlite(path, pass); var result = Load(temp); temp.Close(); return result; } /// 加载源数据库到当前数据库。 public bool Load(Sqlite source) { var error = Backup(source, this); return string.IsNullOrEmpty(error); } #endregion #region ORM。 /// 查询数据库中的所有表名。 public List TableNames() { var list = new List(); if (Connect()) { var sql = "select name from sqlite_master where type='table' order by name; "; var query = (Query)Query(sql); for (int r = 0; r < query.Rows; r++) { var cell = query.Text(r, 0); if (TextUtility.IsBlank(cell)) continue; list.Add(cell); } query.Dispose(); } return list; } /// 查询数据库中的所有视图名。 public List ViewNames() { var list = new List(); if (Connect()) { var sql = "select name from sqlite_master where type='view' order by name; "; var query = (Query)Query(sql); for (int r = 0; r < query.Rows; r++) { var cell = query.Text(r, 0); if (TextUtility.IsBlank(cell)) continue; list.Add(cell); } query.Dispose(); } return list; } /// 查询表中的所有列名。 public List ColumnNames(string table) { var list = new List(); if (Connect()) { var t = TextUtility.AntiInject(table); var sql = TextUtility.Merge("pragma table_info('", TextUtility.AntiInject(t), "'); "); using (var query = Query(sql) as Query) { for (int r = 0; r < query.Rows; r++) { var cell = query.Text(r, "name"); if (TextUtility.IsBlank(cell)) continue; list.Add(cell); } } } return list; } /// 创建表,不修改已存在表。成功时返回空字符串,发生异常时返回异常信息。 public string Initialize(Record model) => model == null ? "参数无效。" : Initialize(model.GetType()); /// 创建表,不修改已存在表。成功时返回空字符串,发生异常时返回异常信息。 public string Initialize() where T : IRecord => Initialize(typeof(T)); /// 创建表,不修改已存在表。当现存表中缺少模型中属性对应的列时增加列。成功时返回空字符串,发生异常时返回异常信息。 public string Initialize(Type model) { var structure = null as TableStructure; try { structure = TableStructure.ParseModel(model); } catch (Exception exception) { return exception.Message; } // 连接数据库。 if (!Connect()) return "连接数据库失败。"; // 检查现存表。 var exists = false; var tables = TableNames(); if (tables.Count > 0) { var lower = structure.Table.ToLower(); foreach (var table in tables) { if (TextUtility.IsBlank(table)) continue; if (table.ToLower() == lower) { exists = true; break; } } } if (exists) { return TextUtility.Merge("指定的表已经存在。"); } else { var sqlcolumns = new List(); foreach (var column in structure.Columns.Values) { var type = GetColumnDeclaration(column); if (type == TextUtility.EmptyString) return TextUtility.Merge("类型 ", column.Type.ToString(), " 不受支持。"); sqlcolumns.Add(type); } var sql = TextUtility.Merge("create table [", structure.Table, "](", TextUtility.Join(", ", sqlcolumns), "); "); var execute = Execute(sql); if (execute.Success) return TextUtility.EmptyString; return execute.Error; } } /// 插入记录。成功时候返回空字符串,发生异常时返回异常信息。 public string Insert(IRecord record) { if (record == null) return "参数无效。"; record.FixProperties(); var structure = null as TableStructure; try { structure = TableStructure.ParseModel(record); } catch (Exception exception) { return exception.Message; } var parameters = structure.CreateDataParameters(record, CreateDataParameter); var sql = GenerateInsertStatement(structure.Table, (IEnumerable)parameters); var execute = Execute(sql, parameters); if (execute.Success && execute.Rows > 0) return TextUtility.EmptyString; return execute.Error; } /// 更新记录,实体中的 Created 和 Key 属性不被更新。成功时返回空字符串,发生异常时返回异常信息。 public string Update(IRecord record) { if (record == null) return "参数无效。"; record.FixProperties(); record.Updated = ClockUtility.LucidNow; var structure = null as TableStructure; try { structure = TableStructure.ParseModel(record); } catch (Exception exception) { return exception.Message; } var parameters = structure.CreateDataParameters(record, CreateDataParameter, "_created", "_key"); var sql = GenerateUpdateStatement(structure.Table, record.Key, parameters); var execute = Execute(sql, parameters); if (execute.Success && execute.Rows > 0) return TextUtility.EmptyString; return execute.Error; } /// 获取按指定语句查询到的所有记录。 public Result> Query(Type model, string sql) => OrmHelper.Query(this, model, sql); /// 获取按指定语句查询到的所有记录。 public Result> Query(string sql) where T : IRecord => OrmHelper.Query(this, sql); /// 查询多条记录。 public Result> Query(Type model, long flag = 0) => OrmHelper.Query(this, model, (tn) => { if (flag == 0) return $"select * from [{tn}]; "; return $"select * from [{tn}] where _flag={flag}; "; }); /// 查询多条记录。 public Result> Query(long flag = 0) where T : IRecord => OrmHelper.Query(this, (tn) => { if (flag == 0) return $"select * from [{tn}]; "; return $"select * from [{tn}] where _flag={flag}; "; }); /// 获取具有指定 Key 的记录。 public Result Get(Type model, string key, long flag = 0) => OrmHelper.Get(this, model, key, (tn, sk) => { if (flag == 0) return $"select * from [{tn}] where _key='{sk}' limit 1; "; return $"select * from [{tn}] where _flag={flag} and _key='{sk}' limit 1; "; }); /// 获取具有指定 Key 的记录。 public Result Get(string key, long flag) where T : IRecord => OrmHelper.Get(this, key, (tn, sk) => { if (flag == 0) return $"select * from [{tn}] where _key='{sk}' limit 1; "; return $"select * from [{tn}] where _flag={flag} and _key='{sk}' limit 1; "; }); /// 获取指定类型的主键,按 Flag 属性筛选。 public Result> Keys(Type model, long flag = 0) => OrmHelper.Keys(this, model, (tn) => { if (flag == 0) return $"select _key from [{tn}] where _flag={flag}; "; return $"select _key from [{tn}]; "; }); /// >获取指定类型的主键,按 Flag 属性筛选。 public Result> Keys(long flag = 0) where T : IRecord => Keys(typeof(T), flag); #endregion #region static /// 对文本转义,符合 SQL 安全性。可根据字段类型限制 UTF-8 字节数,默认为 0 时不限制字节数。 public static string Escape(string text, int bytes = 0) { if (text.IsEmpty()) return ""; var t = text ?? ""; t = t.Replace("\\", "\\\\"); t = t.Replace("'", "\\'"); t = t.Replace("\n", "\\n"); t = t.Replace("\r", "\\r"); t = t.Replace("\b", "\\b"); t = t.Replace("\t", "\\t"); t = t.Replace("\f", "\\f"); if (bytes > 5) { if (t.GetBytes(Encoding.UTF8).Length > bytes) { while (true) { t = t.Substring(0, t.Length - 1); if (t.GetBytes(Encoding.UTF8).Length <= (bytes - 4)) break; } t = t + " ..."; } } return t; } private static string GetColumnTypeName(ColumnType type) { switch (type) { case ColumnType.Binary: return "blob"; case ColumnType.Integer: return "integer"; case ColumnType.Float: return "float"; case ColumnType.VarChar: case ColumnType.VarChar255: case ColumnType.VarCharMax: return "varchar"; case ColumnType.Text: return "text"; case ColumnType.NVarChar: case ColumnType.NVarChar255: case ColumnType.NVarCharMax: return "nvarchar"; case ColumnType.NText: return "ntext"; default: return null; } } private static string GetColumnDeclaration(ColumnAttribute column) { var type = TextUtility.EmptyString; var length = NumberUtility.RestrictValue(column.Length, 0, 255).ToString(); switch (column.Type) { case ColumnType.Binary: type = "blob"; break; case ColumnType.Integer: type = "integer"; break; case ColumnType.Float: type = "real"; break; case ColumnType.VarChar: case ColumnType.VarChar255: type = TextUtility.Merge("varchar(", length, ")"); break; case ColumnType.VarCharMax: type = TextUtility.Merge("varchar(255)"); break; case ColumnType.Text: type = TextUtility.Merge("text"); break; case ColumnType.NVarChar: case ColumnType.NVarChar255: type = TextUtility.Merge("nvarchar(", length, ")"); break; case ColumnType.NVarCharMax: type = TextUtility.Merge("nvarchar(255)"); break; case ColumnType.NText: type = TextUtility.Merge("ntext"); break; default: return TextUtility.EmptyString; } return TextUtility.Merge("[", (object)column.Field, "] ", type); } /// 创建参数。 /// /// public static SQLiteParameter CreateDataParameter(Parameter parameter) { if (parameter == null) throw new InvalidOperationException("参数无效。"); return CreateDataParameter(parameter.Name, parameter.Type, parameter.Size, parameter.Value); } /// 创建参数。 public static SQLiteParameter CreateDataParameter(string name, ColumnType type, int size, object value) { var n = TextUtility.Trim(name); if (TextUtility.IsBlank(n)) return null; var t = GetColumnTypeName(type); var s = size; switch (type) { case ColumnType.VarChar: s = NumberUtility.RestrictValue(s, 0, 8000); break; case ColumnType.NVarChar: s = NumberUtility.RestrictValue(s, 0, 4000); break; case ColumnType.VarChar255: case ColumnType.VarCharMax: case ColumnType.NVarChar255: case ColumnType.NVarCharMax: s = NumberUtility.RestrictValue(s, 0, 255); break; default: s = 0; break; } var v = value; if (v is string && v != null && s > 0) { v = TextUtility.RestrictLength((string)v, s); } var p = new SQLiteParameter(); p.ParameterName = n; p.TypeName = t; p.Value = v; if (s > 0) p.Size = s; return p; } /// 创建参数。 public static SQLiteParameter CreateDataParameter(string name, string type, int size, object value) { var v = value; if (value is string && value != null && size > 0) { v = TextUtility.RestrictLength((string)value, size); } var p = new SQLiteParameter(); p.ParameterName = name; p.TypeName = type; p.Value = v; p.Size = size; return p; } /// 创建参数。 public static SQLiteParameter CreateDataParameter(string name, string type, object value) { var p = new SQLiteParameter(); p.ParameterName = name; p.TypeName = type; p.Value = value; return p; } /// 备份数据库,返回错误信息。 public static string Backup(Sqlite source, Sqlite destination) { if (source == null) return "SQLite Backup Failed: Invalid Source"; if (destination == null) return "SQLite Backup Failed: Invalid Destination"; if (!source.Connect()) return "SQLite Backup Failed: Invalid Source Connection"; if (!destination.Connect()) return "SQLite Backup Failed: Invalid Destination Connection"; try { source._db.BackupDatabase(destination._db, "main", "main", -1, null, 0); return ""; } catch (Exception ex) { return "SQLite Load Failed: " + ex.Message; } } /// 创建参数。 public static IDbDataParameter CreateParameter(string field, DbType type, int size, object value) { var p = new SQLiteParameter(); p.ParameterName = field; p.DbType = type; p.Size = size; p.Value = value; return p; } /// 创建参数。 public static IDbDataParameter CreateParameter(string field, DbType type, object value) { var p = new SQLiteParameter(); p.ParameterName = field; p.DbType = type; p.Value = value; return p; } /// 整理数据库,压缩未使用的空间。 public const string Vacuum = "vacuum"; /// 内存数据库的地址。 public const string Memory = ":memory:"; #endregion #region ORM private static string GetParameterName(string parameter) { var name = TextUtility.AntiInject(parameter, 255); if (name.StartsWith("@") && name.Length > 1) { name = name.Substring(1, name.Length - 1); } return name; } private static string GetParameterName(IDataParameter parameter) { var name = TextUtility.EmptyString; if (parameter != null) { name = GetParameterName(parameter.ParameterName); } return name; } private static List GetParametersNames(IEnumerable parameters) { var columns = new List(); if (parameters != null) { foreach (var parameter in parameters) { var name = GetParameterName(parameter); var isblank = TextUtility.IsBlank(name); if (isblank) continue; columns.Add(name); } } return columns; } private static string GenerateInsertStatement(string table, List columns) { var r = TextUtility.EmptyString; var t = TextUtility.AntiInject(table, 255); if (columns != null && !TextUtility.IsBlank(t)) { var count = 0; var names = new List(); var values = new List(); foreach (var column in columns) { //names.Add(TextGenerator.Merge("[", column, "]")); names.Add(TextUtility.Merge(column)); values.Add("@" + column); count += 1; } var sb = new StringBuilder(); if (count > 0) { sb.Append("insert into [", t, "](", TextUtility.Join(", ", names), ") "); sb.Append("values(", TextUtility.Join(", ", values), "); "); } r = sb.ToString(); } return r; } /// 生成 INSERT INTO 语句。表名必须有效,无有效参数时将获取空结果。 /// /// public static string GenerateInsertStatement(string table, IEnumerable parameters) { if (table == null) throw new ArgumentNullException(nameof(table)); var t = TextUtility.AntiInject(table, 255); if (TextUtility.IsBlank(t)) throw new ArgumentException("表名无效。", nameof(table)); var cs = GetParametersNames(parameters); if (cs.Count < 1) return TextUtility.EmptyString; return GenerateInsertStatement(t, cs); } private static string GenerateUpdateStatement(string table, string key, List columns) { var result = TextUtility.EmptyString; var t = TextUtility.AntiInject(table, 255); var k = TextUtility.AntiInject(key, 255); if (columns != null && !TextUtility.IsBlank(t) && !TextUtility.IsBlank(k)) { var items = new List(); foreach (var column in columns) { items.Add(TextUtility.Merge("[", column, "]=@", column)); } if (items.Count > 0) { result = TextUtility.Merge("update [", t, "] set ", TextUtility.Join(", ", items), " where [_key]='", k, "'; "); } } return result; } /// 生成 UPDATE 语句,键字段名为“_key”。表名必须有效,键值必须有效,无有效参数时将获取空结果。 /// /// public static string GenerateUpdateStatement(string table, string key, IEnumerable parameters) { if (table == null) throw new ArgumentNullException("argTable"); var t = TextUtility.AntiInject(table, 255); if (TextUtility.IsBlank(t)) throw new ArgumentException("表名无效。", nameof(table)); if (key == null) throw new ArgumentNullException("argKey"); var k = TextUtility.AntiInject(key, 255); if (TextUtility.IsBlank(k)) throw new ArgumentException("键值无效。", nameof(key)); var columns = GetParametersNames(parameters); if (columns.Count < 1) return TextUtility.EmptyString; return GenerateUpdateStatement(t, k, columns); } #endregion } } #endif