aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/Tango.BL/ActionLogs/DefaultActionLogManager.cs
blob: 0f5d6bd5156e6a237ce6bc29d772ea41ec54beb0 (plain)
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
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using Tango.BL.Entities;
using Tango.BL.Enumerations;
using Tango.BL.ValueObjects;
using Tango.Core;
using Tango.Core.ExtensionMethods;

namespace Tango.BL.ActionLogs
{
    /// <summary>
    /// Represents the default <see cref="IActionLogManager"/> implementation.
    /// </summary>
    /// <seealso cref="Tango.Core.ExtendedObject" />
    /// <seealso cref="Tango.BL.ActionLogs.IActionLogManager" />
    public class DefaultActionLogManager : ExtendedObject, IActionLogManager
    {
        /// <summary>
        /// Gets or sets the action log comparer used to compare related objects.
        /// </summary>
        public IActionLogComparer ActionLogComparer { get; set; }

        /// <summary>
        /// Gets or sets a value indicating whether to perform the logging operations asynchronously.
        /// </summary>
        public bool IsAsync { get; set; }

        /// <summary>
        /// Initializes a new instance of the <see cref="DefaultActionLogManager"/> class.
        /// </summary>
        public DefaultActionLogManager()
        {
            IsAsync = true;
            ActionLogComparer = new DefaultActionLogComparer();
        }

        /// <summary>
        /// Inserts a new action log (main entry point).
        /// </summary>
        /// <param name="type">The type.</param>
        /// <param name="userGuid">The user unique identifier.</param>
        /// <param name="relatedObjectName">Name of the related object.</param>
        /// <param name="relatedObjectGuid">The related object unique identifier.</param>
        /// <param name="diffference">The diffference node tree.</param>
        /// <param name="message">The message.</param>
        public void InsertLog(ActionLogType type, string userGuid, string relatedObjectName, string relatedObjectGuid, ActionLogDifference difference, string message = null)
        {
            Task task = new Task(() =>
            {
                using (ObservablesContext db = ObservablesContext.CreateDefault())
                {
                    try
                    {
                        ActionLog log = new ActionLog();
                        log.ActionType = type;
                        log.LastUpdated = DateTime.UtcNow;
                        log.UserGuid = userGuid;
                        log.RelatedObjectName = relatedObjectName;
                        log.RelatedObjectGuid = relatedObjectGuid;
                        log.Message = message;
                        log.DifferenceObject = difference;

                        db.ActionLogs.Add(log);

                        db.SaveChanges();

                        LogManager.Log($"Action log '{type}' inserted.");

                        if (difference != null && difference.Children.Count > 0)
                        {
                            Debug.WriteLine($"Action log differences:\n{difference.ToJsonString()}");
                        }
                    }
                    catch (Exception ex)
                    {
                        LogManager.Log(ex, $"Error inserting action log '{type}'.");
                    }
                }
            });

            if (IsAsync)
            {
                task.Start();
            }
            else
            {
                task.RunSynchronously();
            }
        }

        /// <summary>
        /// Inserts a new action log (comparison entry).
        /// </summary>
        /// <param name="type">The type.</param>
        /// <param name="userGuid">The user unique identifier.</param>
        /// <param name="relatedObjectName">Name of the related object.</param>
        /// <param name="relatedObjectBefore">The related object before the change.</param>
        /// <param name="relatedObjectAfter">The related object after the change.</param>
        /// <param name="message">The message.</param>
        public void InsertLog(ActionLogType type, string userGuid, string relatedObjectName, IActionLogComparable relatedObjectBefore, IActionLogComparable relatedObjectAfter, string message = null)
        {
            Task task = new Task(() => 
            {
                ActionLogDifference diff = new ActionLogDifference();

                bool insertWhenNoDifference = false;

                if (ActionLogComparer != null)
                {
                    try
                    {
                        diff = ActionLogComparer.Compare(relatedObjectBefore, relatedObjectAfter).Result;
                    }
                    catch (Exception ex)
                    {
                        insertWhenNoDifference = true;
                        LogManager.Log(ex, $"Error while comparing for action log '{type}'.");
                    }

                    if (diff.Children.Count > 0 || insertWhenNoDifference)
                    {
                        InsertLog(type, userGuid, relatedObjectName, GetRelatedObjectGuid(relatedObjectBefore, relatedObjectAfter), diff, message);
                    }
                    else
                    {
                        LogManager.Log($"Action log '{type}' was about to be inserted but skipped due to no differences.");
                    }
                }
                else
                {
                    Debug.WriteLine("No comparer defined for action log.");
                    InsertLog(type, userGuid, relatedObjectName, GetRelatedObjectGuid(relatedObjectBefore, relatedObjectAfter), diff, message);
                }
            });

            if (IsAsync)
            {
                task.Start();
            }
            else
            {
                task.RunSynchronously();
            }
        }

        /// <summary>
        /// Inserts a new action log (comparison entry).
        /// </summary>
        /// <param name="type">The type.</param>
        /// <param name="user">The user.</param>
        /// <param name="relatedObjectName">Name of the related object.</param>
        /// <param name="relatedObjectBefore">The related object before the change.</param>
        /// <param name="relatedObjectAfter">The related object after the change.</param>
        /// <param name="message">The message.</param>
        public void InsertLog(ActionLogType type, User user, string relatedObjectName, IActionLogComparable relatedObjectBefore, IActionLogComparable relatedObjectAfter, string message = null)
        {
            InsertLog(type, user.Guid, relatedObjectName, relatedObjectBefore, relatedObjectAfter, message);
        }

        /// <summary>
        /// Inserts a new action log (deletion/creation entry).
        /// </summary>
        /// <param name="type">The type.</param>
        /// <param name="user">The user.</param>
        /// <param name="relatedObjectName">Name of the related object.</param>
        /// <param name="relatedObject">The related object.</param>
        /// <param name="message">The message.</param>
        /// <param name="serializeRelatedObject">if set to <c>true</c> will create a one way difference tree (use when the related object was deleted and needs to be monitored).</param>
        public void InsertLog(ActionLogType type, User user, string relatedObjectName, IActionLogComparable relatedObject, string message = null, bool serializeRelatedObject = false)
        {
            if (serializeRelatedObject)
            {
                InsertLog(type, user.Guid, relatedObjectName, relatedObject, null, message);
            }
            else
            {
                InsertLog(type, user.Guid, relatedObjectName, relatedObject?.Guid, message);
            }
        }

        /// <summary>
        /// Inserts a new action log (creation entry).
        /// </summary>
        /// <param name="type">The type.</param>
        /// <param name="userGuid">The user unique identifier.</param>
        /// <param name="relatedObjectName">Name of the related object.</param>
        /// <param name="relatedObjectGuid">The related object unique identifier.</param>
        /// <param name="message">The message.</param>
        public void InsertLog(ActionLogType type, string userGuid, string relatedObjectName, string relatedObjectGuid, string message = null)
        {
            InsertLog(type, userGuid, relatedObjectName, relatedObjectGuid, null, message);
        }

        /// <summary>
        /// Inserts a new action log (nutral entry).
        /// </summary>
        /// <param name="type">The type.</param>
        /// <param name="userGuid">The user unique identifier.</param>
        /// <param name="message">The message.</param>
        public void InsertLog(ActionLogType type, string userGuid, string message = null)
        {
            InsertLog(type, userGuid, null, null, message);
        }

        /// <summary>
        /// Inserts a new action log (nutral entry).
        /// </summary>
        /// <param name="type">The type.</param>
        /// <param name="user">The user.</param>
        /// <param name="message">The message.</param>
        public void InsertLog(ActionLogType type, User user, string message = null)
        {
            InsertLog(type, user.Guid, message);
        }

        /// <summary>
        /// Gets the related object unique identifier.
        /// </summary>
        /// <param name="before">The before.</param>
        /// <param name="after">The after.</param>
        /// <returns></returns>
        private String GetRelatedObjectGuid(IActionLogComparable before, IActionLogComparable after)
        {
            if (before != null)
            {
                return before.Guid;
            }

            if (after != null)
            {
                return after.Guid;
            }

            return null;
        }
    }
}