-
-
Notifications
You must be signed in to change notification settings - Fork 323
/
SqlDataProvider.cs
324 lines (290 loc) · 11.8 KB
/
SqlDataProvider.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
using System;
using System.Linq;
using Audit.Core;
using System.Threading.Tasks;
using System.Collections.Generic;
using System.Threading;
using Microsoft.Data.SqlClient;
using Microsoft.EntityFrameworkCore;
namespace Audit.SqlServer.Providers
{
/// <summary>
/// SQL Server data access
/// </summary>
/// <remarks>
/// Settings:
/// - ConnectionString: SQL connection string
/// - TableName: Table name (default is 'Event')
/// - JsonColumnName: Column name where the JSON will be stored (default is 'Data')
/// - IdColumnName: Column name with the primary key (default is 'EventId')
/// - LastUpdatedDateColumnName: datetime column to update when replacing events (NULL to ignore)
/// - Schema: The Schema Name to use
/// - CustomColumns: A collection of custom columns to be added when saving the audit event
/// </remarks>
public class SqlDataProvider : AuditDataProvider
{
/// <summary>
/// The SQL connection string
/// </summary>
public Setting<string> ConnectionString { get; set; }
/// <summary>
/// The SQL events Table Name
/// </summary>
public Setting<string> TableName { get; set; } = "Event";
/// <summary>
/// The Column Name that stores the JSON
/// </summary>
public Setting<string> JsonColumnName { get; set; }
/// <summary>
/// The Column Name that stores the Last Updated Date (NULL to ignore)
/// </summary>
public Setting<string> LastUpdatedDateColumnName { get; set; }
/// <summary>
/// The Column Name that is the primary ley
/// </summary>
public Setting<string> IdColumnName { get; set; }
/// <summary>
/// The Schema Name to use (NULL to ignore)
/// </summary>
public Setting<string> Schema { get; set; }
/// <summary>
/// A collection of custom columns to be added when saving the audit event
/// </summary>
public List<CustomColumn> CustomColumns { get; set; } = new List<CustomColumn>();
/// <summary>
/// The DbContext options builder, to provide custom database options for the DbContext
/// </summary>
[CLSCompliant(false)]
public Setting<DbContextOptions> DbContextOptions { get; set; }
public SqlDataProvider()
{
}
[CLSCompliant(false)]
public SqlDataProvider(Action<Configuration.ISqlServerProviderConfigurator> config)
{
var sqlConfig = new Configuration.SqlServerProviderConfigurator();
if (config != null)
{
config.Invoke(sqlConfig);
ConnectionString = sqlConfig._connectionString;
IdColumnName = sqlConfig._idColumnName;
JsonColumnName = sqlConfig._jsonColumnName;
LastUpdatedDateColumnName = sqlConfig._lastUpdatedColumnName;
Schema = sqlConfig._schema;
TableName = sqlConfig._tableName;
CustomColumns = sqlConfig._customColumns;
DbContextOptions = sqlConfig._dbContextOptions;
}
}
public override object InsertEvent(AuditEvent auditEvent)
{
var parameters = GetParametersForInsert(auditEvent);
using var ctx = CreateContext(auditEvent);
var cmdText = GetInsertCommandText(auditEvent);
var result = ctx.FakeIdSet.FromSqlRaw(cmdText, parameters);
return result.ToList().FirstOrDefault()?.Id;
}
public override async Task<object> InsertEventAsync(AuditEvent auditEvent, CancellationToken cancellationToken = default)
{
var parameters = GetParametersForInsert(auditEvent);
await using var ctx = CreateContext(auditEvent);
var cmdText = GetInsertCommandText(auditEvent);
var result = ctx.FakeIdSet.FromSqlRaw(cmdText, parameters);
return (await result.ToListAsync(cancellationToken)).FirstOrDefault()?.Id;
}
public override void ReplaceEvent(object eventId, AuditEvent auditEvent)
{
var parameters = GetParametersForReplace(eventId, auditEvent);
using var ctx = CreateContext(auditEvent);
var cmdText = GetReplaceCommandText(auditEvent);
ctx.Database.ExecuteSqlRaw(cmdText, parameters);
}
public override async Task ReplaceEventAsync(object eventId, AuditEvent auditEvent, CancellationToken cancellationToken = default)
{
var parameters = GetParametersForReplace(eventId, auditEvent);
await using var ctx = CreateContext(auditEvent);
var cmdText = GetReplaceCommandText(auditEvent);
await ctx.Database.ExecuteSqlRawAsync(cmdText, parameters, cancellationToken);
}
public override T GetEvent<T>(object eventId)
{
if (JsonColumnName.GetDefault() == null)
{
return null;
}
using var ctx = CreateContext(null);
var cmdText = GetSelectCommandText(null);
var result = ctx.FakeIdSet.FromSqlRaw(cmdText, new SqlParameter("@eventId", eventId));
var json = result.FirstOrDefault()?.Id;
if (json != null)
{
return AuditEvent.FromJson<T>(json);
}
return null;
}
public override async Task<T> GetEventAsync<T>(object eventId, CancellationToken cancellationToken = default)
{
if (JsonColumnName.GetDefault() == null)
{
return null;
}
await using var ctx = CreateContext(null);
var cmdText = GetSelectCommandText(null);
var result = ctx.FakeIdSet.FromSqlRaw(cmdText, new SqlParameter("@eventId", eventId));
var json = (await result.FirstOrDefaultAsync(cancellationToken))?.Id;
if (json != null)
{
return AuditEvent.FromJson<T>(json);
}
return null;
}
protected internal string GetFullTableName(AuditEvent auditEvent)
{
var schema = Schema.GetValue(auditEvent);
var table = TableName.GetValue(auditEvent);
return schema != null ? $"[{schema}].[{table}]" : $"[{table}]";
}
protected string GetInsertCommandText(AuditEvent auditEvent)
{
return string.Format("INSERT INTO {0} ({1}) OUTPUT CONVERT(NVARCHAR(MAX), INSERTED.[{2}]) AS [Id] VALUES ({3})",
GetFullTableName(auditEvent),
GetColumnsForInsert(auditEvent),
IdColumnName.GetValue(auditEvent),
GetValuesForInsert(auditEvent));
}
private string GetColumnsForInsert(AuditEvent auditEvent)
{
var columns = new List<string>();
var jsonColumnName = JsonColumnName.GetValue(auditEvent);
if (jsonColumnName != null)
{
columns.Add(jsonColumnName);
}
if (CustomColumns != null)
{
foreach (var column in CustomColumns)
{
if (column.Guard == null || column.Guard.Invoke(auditEvent))
{
columns.Add(column.Name);
}
}
}
return string.Join(", ", columns.Select(c => $"[{c}]"));
}
private string GetValuesForInsert(AuditEvent auditEvent)
{
var values = new List<string>();
if (JsonColumnName.GetValue(auditEvent) != null)
{
values.Add("@json");
}
if (CustomColumns != null)
{
int i = 0;
foreach (var column in CustomColumns)
{
if (column.Guard == null || column.Guard.Invoke(auditEvent))
{
values.Add($"@c{i}");
i++;
}
}
}
return string.Join(", ", values);
}
protected SqlParameter[] GetParametersForInsert(AuditEvent auditEvent)
{
var parameters = new List<SqlParameter>();
if (JsonColumnName.GetValue(auditEvent) != null)
{
parameters.Add(new SqlParameter("@json", auditEvent.ToJson()));
}
if (CustomColumns != null)
{
int i = 0;
foreach (var column in CustomColumns)
{
if (column.Guard == null || column.Guard.Invoke(auditEvent))
{
parameters.Add(new SqlParameter($"@c{i}", column.Value.Invoke(auditEvent) ?? DBNull.Value));
i++;
}
}
}
return parameters.ToArray();
}
protected SqlParameter[] GetParametersForReplace(object eventId, AuditEvent auditEvent)
{
var parameters = new List<SqlParameter>();
if (JsonColumnName.GetValue(auditEvent) != null)
{
parameters.Add(new SqlParameter("@json", auditEvent.ToJson()));
}
parameters.Add(new SqlParameter("@eventId", eventId));
if (CustomColumns != null)
{
int i = 0;
foreach (var column in CustomColumns)
{
if (column.Guard == null || column.Guard.Invoke(auditEvent))
{
parameters.Add(new SqlParameter($"@c{i}", column.Value.Invoke(auditEvent) ?? DBNull.Value));
i++;
}
}
}
return parameters.ToArray();
}
protected string GetReplaceCommandText(AuditEvent auditEvent)
{
var cmdText = string.Format("UPDATE {0} SET {1} WHERE [{2}] = @eventId",
GetFullTableName(auditEvent),
GetSetForUpdate(auditEvent),
IdColumnName.GetValue(auditEvent));
return cmdText;
}
private string GetSetForUpdate(AuditEvent auditEvent)
{
var jsonColumnName = JsonColumnName.GetValue(auditEvent);
var ludColumn = LastUpdatedDateColumnName.GetValue(auditEvent);
var sets = new List<string>();
if (jsonColumnName != null)
{
sets.Add($"[{jsonColumnName}] = @json");
}
if (ludColumn != null)
{
sets.Add($"[{ludColumn}] = GETUTCDATE()");
}
if (CustomColumns != null)
{
int i = 0;
foreach (var column in CustomColumns)
{
if (column.Guard == null || column.Guard.Invoke(auditEvent))
{
sets.Add($"[{column.Name}] = @c{i}");
i++;
}
}
}
return string.Join(", ", sets);
}
protected string GetSelectCommandText(AuditEvent auditEvent)
{
var cmdText = string.Format("SELECT [{0}] As [Id] FROM {1} WHERE [{2}] = @eventId",
JsonColumnName.GetValue(auditEvent),
GetFullTableName(auditEvent),
IdColumnName.GetValue(auditEvent));
return cmdText;
}
private AuditContext CreateContext(AuditEvent auditEvent)
{
var ctxOptions = DbContextOptions.GetValue(auditEvent);
return ctxOptions != null
? new AuditContext(ConnectionString.GetValue(auditEvent), ctxOptions)
: new AuditContext(ConnectionString.GetValue(auditEvent));
}
}
}