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
|
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using System.Windows.Threading;
namespace Tango.Logging
{
/// <summary>
/// Represents an <see cref="ILogger"/> file logger.
/// </summary>
/// <seealso cref="Tango.Logging.ILogger" />
public class FileLogger : ILogger
{
private DateTime _logFileTimeDate;
private System.Timers.Timer _removal_timer;
private int _writeCount;
private int _fileExtensionIndex;
private const int FILE_SIZE_CHECK_COUNT = 100;
public const string FILE_SET_EXTENSION = "__";
/// <summary>
/// Gets the logs folder.
/// </summary>
public static String DefaultLogsFolder { get; private set; }
/// <summary>
/// Gets or sets the log file.
/// </summary>
public String LogFile { get; private set; }
/// <summary>
/// Gets the tag name which will be appended to the file.
/// </summary>
public String Tag { get; private set; }
/// <summary>
/// Gets or sets the log file folder.
/// </summary>
public String Folder { get; private set; }
/// <summary>
/// Gets or sets a value indicating whether [enable automatic log removal].
/// </summary>
public bool EnableAutoLogRemoval { get; set; }
/// <summary>
/// Gets or sets the automatic log removal period.
/// </summary>
public TimeSpan AutoLogRemovalPeriod { get; set; }
private TimeSpan _autoLogRemovalCheckPeriod;
/// <summary>
/// Gets or sets the automatic log removal check period.
/// </summary>
public TimeSpan AutoLogRemovalCheckPeriod
{
get { return _autoLogRemovalCheckPeriod; }
set
{
_autoLogRemovalCheckPeriod = value;
if (_removal_timer != null)
{
_removal_timer.Interval = _autoLogRemovalCheckPeriod.TotalMilliseconds;
}
}
}
/// <summary>
/// Gets or sets a value indicating whether [enable maximum file size limit].
/// </summary>
public bool EnableMaxFileSizeLimit { get; set; }
/// <summary>
/// Gets or sets the maximum file size limit.
/// </summary>
public long MaxFileSizeLimit { get; set; }
public String GetFileSetExtension(int index)
{
return FILE_SET_EXTENSION + index;
}
/// <summary>
/// Initializes the <see cref="FileLogger"/> class.
/// </summary>
static FileLogger()
{
DefaultLogsFolder = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), "Twine", "Tango", "Logs", Path.GetFileNameWithoutExtension(AppDomain.CurrentDomain.FriendlyName));
}
/// <summary>
/// Initializes a new instance of the <see cref="FileLogger"/> class.
/// </summary>
public FileLogger()
{
_isEnabled = true;
Tag = Path.GetFileNameWithoutExtension(AppDomain.CurrentDomain.FriendlyName);
Folder = DefaultLogsFolder;
Directory.CreateDirectory(Folder);
_logFileTimeDate = DateTime.Now;
LogFile = CreateLogFileName();
EnableAutoLogRemoval = false;
AutoLogRemovalCheckPeriod = TimeSpan.FromHours(1);
AutoLogRemovalPeriod = TimeSpan.FromDays(7);
_removal_timer = new System.Timers.Timer();
_removal_timer.Interval = AutoLogRemovalCheckPeriod.TotalMilliseconds;
_removal_timer.Elapsed += _removal_timer_Elapsed;
_removal_timer.Start();
EnableMaxFileSizeLimit = false;
MaxFileSizeLimit = 1000000 * 10; //10 MB
}
/// <summary>
/// Initializes a new instance of the <see cref="FileLogger"/> class.
/// </summary>
/// <param name="folder">Logs folder path.</param>
/// <param name="tag">The tag name which will be appended to the file name.</param>
public FileLogger(String folder, String tag)
: this()
{
Folder = folder;
Tag = tag;
Directory.CreateDirectory(Folder);
LogFile = CreateLogFileName();
}
/// <summary>
/// Called when a new library trace is available.
/// </summary>
/// <param name="output">The output.</param>
public void OnLog(LogItemBase output)
{
try
{
if (DateTime.Now.Date > _logFileTimeDate.Date)
{
_fileExtensionIndex = 0;
_writeCount = 0;
_logFileTimeDate = DateTime.Now;
CreateNewLogFile();
}
else if (EnableMaxFileSizeLimit && ++_writeCount > FILE_SIZE_CHECK_COUNT)
{
if (new FileInfo(LogFile).Length > MaxFileSizeLimit)
{
if (_fileExtensionIndex == 0)
{
_fileExtensionIndex = 1;
string oldPath = LogFile;
LogFile = CreateLogFileName();
File.Move(oldPath, LogFile);
}
_fileExtensionIndex++;
CreateNewLogFile();
_writeCount = 0;
}
}
File.AppendAllText(LogFile, output.ToString() + Environment.NewLine);
}
catch
{
Debug.WriteLine("Error Writing To Log File!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!");
}
}
private bool _isEnabled;
/// <summary>
/// Gets or sets a value indicating whether this <see cref="ILogger" /> is enabled.
/// </summary>
public bool Enabled
{
get
{
return _isEnabled;
}
set
{
_isEnabled = value;
}
}
/// <summary>
/// Creates the name of the log file.
/// </summary>
/// <returns></returns>
private String CreateLogFileName()
{
return Path.Combine(Folder, string.Format("{1}-{0:dd-MM-yyyy_HH-mm-ss}{2}.log", _logFileTimeDate, Tag, EnableMaxFileSizeLimit && _fileExtensionIndex > 0 ? GetFileSetExtension(_fileExtensionIndex) : String.Empty));
}
private void CreateNewLogFile()
{
File.AppendAllText(LogFile, Environment.NewLine + Environment.NewLine + "### This log file continues on the next log file ###" + Environment.NewLine);
LogFile = CreateLogFileName();
File.AppendAllText(LogFile, "### This log file is a continuation of a previous log file ###" + Environment.NewLine + Environment.NewLine);
}
#region Auto Log Removal
/// <summary>
/// Handles the Elapsed event of the _removal_timer control.
/// </summary>
/// <param name="sender">The source of the event.</param>
/// <param name="e">The <see cref="System.Timers.ElapsedEventArgs"/> instance containing the event data.</param>
private void _removal_timer_Elapsed(object sender, System.Timers.ElapsedEventArgs e)
{
if (EnableAutoLogRemoval)
{
RemoveOldLogFiles();
}
}
/// <summary>
/// Removes the old files.
/// </summary>
public void RemoveOldLogFiles()
{
try
{
if (Directory.Exists(Folder))
{
DateTime removalDateTime = DateTime.Now - AutoLogRemovalPeriod;
string[] fileEntries = Directory.GetFiles(Folder, "*.log");
foreach (string fileName in fileEntries)
{
try
{
FileInfo fi = new FileInfo(fileName);
if (fi != null && fi.LastWriteTime < removalDateTime)
{
File.Delete(fi.FullName);
}
}
catch (Exception ex)
{
Debug.WriteLine(ex);
}
}
}
}
catch (Exception ex)
{
Debug.WriteLine(ex);
}
}
#endregion
}
}
|
