-
-
Notifications
You must be signed in to change notification settings - Fork 323
/
MongoDataProvider.cs
329 lines (296 loc) · 12.1 KB
/
MongoDataProvider.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
325
326
327
328
329
using System;
using System.Collections.Generic;
using MongoDB.Bson;
using MongoDB.Bson.Serialization;
using MongoDB.Bson.Serialization.Conventions;
using MongoDB.Driver;
using Audit.Core;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
namespace Audit.MongoDB.Providers
{
/// <summary>
/// Mongo DB data access
/// </summary>
/// <remarks>
/// Settings:
/// - ConnectionString: Mongo connection string
/// - Database: Database name
/// - Collection: Collection name
/// - IgnoreElementNames: indicate whether the element names should be validated and fixed or not
/// </remarks>
public class MongoDataProvider : AuditDataProvider
{
static MongoDataProvider()
{
ConfigureBsonMapping();
}
private static void ConfigureBsonMapping()
{
var pack = new ConventionPack
{
new IgnoreIfNullConvention(true)
};
ConventionRegistry.Register("Ignore null properties for AuditEvent", pack, type => type == typeof(AuditEvent));
BsonClassMap.RegisterClassMap<AuditTarget>(cm =>
{
cm.AutoMap();
});
BsonClassMap.RegisterClassMap<AuditEvent>(cm =>
{
cm.AutoMap();
cm.MapExtraElementsField(c => c.CustomFields);
});
BsonClassMap.RegisterClassMap<AuditEventEnvironment>(cm =>
{
cm.AutoMap();
cm.MapExtraElementsField(c => c.CustomFields);
});
}
/// <summary>
/// Gets or sets the MongoDB connection string.
/// </summary>
public string ConnectionString { get; set; } = "mongodb://localhost:27017";
/// <summary>
/// Gets or sets the Settings for constructing the Mongo Client object.
/// When this property is not null, the ConnectionString setting is ignored.
/// </summary>
public MongoClientSettings ClientSettings { get; set; }
/// <summary>
/// Gets or sets the optional settings to use when getting the Database object.
/// </summary>
public MongoDatabaseSettings DatabaseSettings { get; set; }
/// <summary>
/// Gets or sets the MongoDB Database name.
/// </summary>
public string Database { get; set; } = "Audit";
/// <summary>
/// Gets or sets the MongoDB collection name.
/// </summary>
public string Collection { get; set; } = "Event";
/// <summary>
/// Gets or sets a value to indicate whether the element names should be validated/fixed or not.
/// If <c>true</c> the element names are not validated, use this when you know the element names will not contain invalid characters.
/// If <c>false</c> (default) the element names are validated and fixed to avoid containing invalid characters.
/// </summary>
public bool IgnoreElementNames { get; set; } = false;
/// <summary>
/// Gets or sets a value indicating whether the target object and extra fields should be serialized as Bson.
/// Default is false to serialize using the default JSON serializer from Audit.Core.Configuration.JsonAdapter
/// </summary>
/// <value><c>true</c> if should serialize as Bson; or <c>false</c> to serialize as Json.</value>
public bool SerializeAsBson { get; set; } = false;
public MongoDataProvider()
{
}
public MongoDataProvider(Action<ConfigurationApi.IMongoProviderConfigurator> config)
{
if (config != null)
{
var mongoConfig = new ConfigurationApi.MongoProviderConfigurator();
config.Invoke(mongoConfig);
Collection = mongoConfig._collection;
ConnectionString = mongoConfig._connectionString;
Database = mongoConfig._database;
SerializeAsBson = mongoConfig._serializeAsBson;
ClientSettings = mongoConfig._clientSettings;
DatabaseSettings = mongoConfig._databaseSettings;
}
}
public override object InsertEvent(AuditEvent auditEvent)
{
var db = GetDatabase();
var col = db.GetCollection<BsonDocument>(Collection);
SerializeExtraFields(auditEvent);
var doc = ParseBson(auditEvent);
if (!IgnoreElementNames)
{
FixDocumentElementNames(doc);
}
col.InsertOne(doc);
return (BsonObjectId)doc["_id"];
}
public override async Task<object> InsertEventAsync(AuditEvent auditEvent, CancellationToken cancellationToken = default)
{
var db = GetDatabase();
var col = db.GetCollection<BsonDocument>(Collection);
SerializeExtraFields(auditEvent);
var doc = ParseBson(auditEvent);
if (!IgnoreElementNames)
{
FixDocumentElementNames(doc);
}
await col.InsertOneAsync(doc, null, cancellationToken);
return (BsonObjectId)doc["_id"];
}
public override void ReplaceEvent(object eventId, AuditEvent auditEvent)
{
var db = GetDatabase();
var col = db.GetCollection<BsonDocument>(Collection);
SerializeExtraFields(auditEvent);
var doc = ParseBson(auditEvent);
if (!IgnoreElementNames)
{
FixDocumentElementNames(doc);
}
var filter = Builders<BsonDocument>.Filter.Eq("_id", (BsonObjectId)eventId);
col.ReplaceOne(filter, doc);
}
public override async Task ReplaceEventAsync(object eventId, AuditEvent auditEvent, CancellationToken cancellationToken = default)
{
var db = GetDatabase();
var col = db.GetCollection<BsonDocument>(Collection);
SerializeExtraFields(auditEvent);
var doc = ParseBson(auditEvent);
if (!IgnoreElementNames)
{
FixDocumentElementNames(doc);
}
var filter = Builders<BsonDocument>.Filter.Eq("_id", (BsonObjectId)eventId);
await col.ReplaceOneAsync(filter, doc, (ReplaceOptions)null, cancellationToken);
}
private void SerializeExtraFields(AuditEvent auditEvent)
{
foreach(var k in auditEvent.CustomFields.Keys.ToList())
{
auditEvent.CustomFields[k] = CloneValue(auditEvent.CustomFields[k], auditEvent);
}
}
public override object CloneValue<T>(T value, AuditEvent auditEvent)
{
if (value == null || value is string)
{
return value;
}
if (SerializeAsBson)
{
if (value is BsonDocument || value is BsonValue)
{
return value;
}
if (BsonTypeMapper.TryMapToBsonValue(value, out BsonValue bsonValue))
{
return bsonValue;
}
return value.ToBsonDocument(typeof(object));
}
return base.CloneValue(value, auditEvent);
}
protected virtual BsonDocument ParseBson(AuditEvent auditEvent)
{
if (SerializeAsBson)
{
return auditEvent.ToBsonDocument(auditEvent.GetType());
}
return BsonDocument.Parse(Core.Configuration.JsonAdapter.Serialize(auditEvent));
}
/// <summary>
/// Fixes the document Element Names (avoid using dots '.' and starting with '$').
/// </summary>
/// <param name="document">The document to fix.</param>
protected virtual void FixDocumentElementNames(BsonDocument document)
{
var toRename = new List<Tuple<string, BsonValue, string>>();
foreach (var elem in document)
{
if (elem.Name.Contains(".") || elem.Name.StartsWith("$"))
{
var value = elem.Value;
var name = elem.Name.Replace('.', '_');
if (name.StartsWith("$"))
{
name = "_" + name.Substring(1);
}
toRename.Add(new Tuple<string, BsonValue, string>(elem.Name, value, name));
}
if (elem.Value != null)
{
if (elem.Value.IsBsonDocument)
{
FixDocumentElementNames(elem.Value as BsonDocument);
}
else if (elem.Value.IsBsonArray)
{
foreach (var sub in (elem.Value as BsonArray))
{
if (sub.IsBsonDocument)
{
FixDocumentElementNames(sub as BsonDocument);
}
}
}
}
}
foreach (var x in toRename)
{
document.Remove(x.Item1);
document.Add(new BsonElement(x.Item3, x.Item2));
}
}
protected virtual IMongoDatabase GetDatabase()
{
var client = ClientSettings != null ? new MongoClient(ClientSettings) : new MongoClient(ConnectionString);
var db = client.GetDatabase(Database, DatabaseSettings);
return db;
}
public void TestConnection()
{
var db = GetDatabase();
var test = db.RunCommand((Command<BsonDocument>)"{ping:1}");
if (test["ok"].ToInt64() != 1)
{
throw new MongoException("Can't connect to Audit Mongo Database.");
}
}
public override T GetEvent<T>(object eventId)
{
var db = GetDatabase();
var filter = Builders<BsonDocument>.Filter.Eq("_id", (BsonObjectId)eventId);
var doc = db.GetCollection<BsonDocument>(Collection).Find(filter).FirstOrDefault();
return doc == null ? null : BsonSerializer.Deserialize<T>(doc);
}
public override async Task<T> GetEventAsync<T>(object eventId, CancellationToken cancellationToken = default)
{
var db = GetDatabase();
var filter = Builders<BsonDocument>.Filter.Eq("_id", (BsonObjectId)eventId);
var doc = await (await db.GetCollection<BsonDocument>(Collection).FindAsync(filter, null, cancellationToken)).FirstOrDefaultAsync(cancellationToken);
return doc == null ? null : BsonSerializer.Deserialize<T>(doc);
}
#region Events Query
/// <summary>
/// Returns an IQueryable that enables querying against the audit events stored on Azure Document DB.
/// </summary>
public IQueryable<AuditEvent> QueryEvents()
{
var db = GetDatabase();
return db.GetCollection<AuditEvent>(Collection).AsQueryable();
}
/// <summary>
/// Returns an IQueryable that enables querying against the audit events stored on Azure Document DB, for the audit event type given.
/// </summary>
/// <typeparam name="T">The AuditEvent type</typeparam>
public IQueryable<T> QueryEvents<T>() where T : AuditEvent
{
var db = GetDatabase();
return db.GetCollection<T>(Collection).AsQueryable();
}
/// <summary>
/// Returns a native mongo collection of audit events
/// </summary>
public IMongoCollection<AuditEvent> GetMongoCollection()
{
var db = GetDatabase();
return db.GetCollection<AuditEvent>(Collection);
}
/// <summary>
/// Returns a native mongo collection of audit events
/// </summary>
public IMongoCollection<T> GetMongoCollection<T>() where T : AuditEvent
{
var db = GetDatabase();
return db.GetCollection<T>(Collection);
}
#endregion
}
}