forked from apache/logging-log4net
-
Notifications
You must be signed in to change notification settings - Fork 0
/
RollingFileAppender.cs
1781 lines (1607 loc) · 54.8 KB
/
RollingFileAppender.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
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#region Apache License
//
// Licensed to the Apache Software Foundation (ASF) under one or more
// contributor license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright ownership.
// The ASF licenses this file to you under the Apache License, Version 2.0
// (the "License"); you may not use this file except in compliance with
// the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#endregion
using System;
using System.Collections;
using System.Globalization;
using System.IO;
using log4net.Util;
using log4net.Core;
using System.Threading;
using System.Collections.Generic;
namespace log4net.Appender
{
#if CONFIRM_WIN32_FILE_SHAREMODES
// The following sounds good, and I though it was the case, but after
// further testing on Windows I have not been able to confirm it.
/// On the Windows platform if another process has a write lock on the file
/// that is to be deleted, but allows shared read access to the file then the
/// file can be moved, but cannot be deleted. If the other process also allows
/// shared delete access to the file then the file will be deleted once that
/// process closes the file. If it is necessary to open the log file or any
/// of the backup files outside of this appender for either read or
/// write access please ensure that read and delete share modes are enabled.
#endif
/// <summary>
/// Appender that rolls log files based on size or date or both.
/// </summary>
/// <remarks>
/// <para>
/// RollingFileAppender can roll log files based on size or date or both
/// depending on the setting of the <see cref="RollingStyle"/> property.
/// When set to <see cref="RollingMode.Size"/> the log file will be rolled
/// once its size exceeds the <see cref="MaximumFileSize"/>.
/// When set to <see cref="RollingMode.Date"/> the log file will be rolled
/// once the date boundary specified in the <see cref="DatePattern"/> property
/// is crossed.
/// When set to <see cref="RollingMode.Composite"/> the log file will be
/// rolled once the date boundary specified in the <see cref="DatePattern"/> property
/// is crossed, but within a date boundary the file will also be rolled
/// once its size exceeds the <see cref="MaximumFileSize"/>.
/// When set to <see cref="RollingMode.Once"/> the log file will be rolled when
/// the appender is configured. This effectively means that the log file can be
/// rolled once per program execution.
/// </para>
/// <para>
/// A of few additional optional features have been added:
/// <list type="bullet">
/// <item>Attach date pattern for current log file <see cref="StaticLogFileName"/></item>
/// <item>Backup number increments for newer files <see cref="CountDirection"/></item>
/// <item>Infinite number of backups by file size <see cref="MaxSizeRollBackups"/></item>
/// </list>
/// </para>
///
/// <note>
/// <para>
/// For large or infinite numbers of backup files a <see cref="CountDirection"/>
/// greater than zero is highly recommended, otherwise all the backup files need
/// to be renamed each time a new backup is created.
/// </para>
/// <para>
/// When Date/Time based rolling is used setting <see cref="StaticLogFileName"/>
/// to <see langword="true"/> will reduce the number of file renamings to few or none.
/// </para>
/// </note>
///
/// <note type="caution">
/// <para>
/// Changing <see cref="StaticLogFileName"/> or <see cref="CountDirection"/> without clearing
/// the log file directory of backup files will cause unexpected and unwanted side effects.
/// </para>
/// </note>
///
/// <para>
/// If Date/Time based rolling is enabled this appender will attempt to roll existing files
/// in the directory without a Date/Time tag based on the last write date of the base log file.
/// The appender only rolls the log file when a message is logged. If Date/Time based rolling
/// is enabled then the appender will not roll the log file at the Date/Time boundary but
/// at the point when the next message is logged after the boundary has been crossed.
/// </para>
///
/// <para>
/// The <see cref="RollingFileAppender"/> extends the <see cref="FileAppender"/> and
/// has the same behavior when opening the log file.
/// The appender will first try to open the file for writing when <see cref="ActivateOptions"/>
/// is called. This will typically be during configuration.
/// If the file cannot be opened for writing the appender will attempt
/// to open the file again each time a message is logged to the appender.
/// If the file cannot be opened for writing when a message is logged then
/// the message will be discarded by this appender.
/// </para>
/// <para>
/// When rolling a backup file necessitates deleting an older backup file the
/// file to be deleted is moved to a temporary name before being deleted.
/// </para>
///
/// <note type="caution">
/// <para>
/// A maximum number of backup files when rolling on date/time boundaries is not supported.
/// </para>
/// </note>
/// </remarks>
/// <author>Nicko Cadell</author>
/// <author>Gert Driesen</author>
/// <author>Aspi Havewala</author>
/// <author>Douglas de la Torre</author>
/// <author>Edward Smit</author>
public class RollingFileAppender : FileAppender
{
#region Public Enums
/// <summary>
/// Style of rolling to use
/// </summary>
/// <remarks>
/// <para>
/// Style of rolling to use
/// </para>
/// </remarks>
public enum RollingMode
{
/// <summary>
/// Roll files once per program execution
/// </summary>
/// <remarks>
/// <para>
/// Roll files once per program execution.
/// Well really once each time this appender is
/// configured.
/// </para>
/// <para>
/// Setting this option also sets <c>AppendToFile</c> to
/// <c>false</c> on the <c>RollingFileAppender</c>, otherwise
/// this appender would just be a normal file appender.
/// </para>
/// </remarks>
Once = 0,
/// <summary>
/// Roll files based only on the size of the file
/// </summary>
Size = 1,
/// <summary>
/// Roll files based only on the date
/// </summary>
Date = 2,
/// <summary>
/// Roll files based on both the size and date of the file
/// </summary>
Composite = 3
}
#endregion
#region Protected Enums
/// <summary>
/// The code assumes that the following 'time' constants are in a increasing sequence.
/// </summary>
/// <remarks>
/// <para>
/// The code assumes that the following 'time' constants are in a increasing sequence.
/// </para>
/// </remarks>
protected enum RollPoint
{
/// <summary>
/// Roll the log not based on the date
/// </summary>
InvalidRollPoint =-1,
/// <summary>
/// Roll the log for each minute
/// </summary>
TopOfMinute = 0,
/// <summary>
/// Roll the log for each hour
/// </summary>
TopOfHour = 1,
/// <summary>
/// Roll the log twice a day (midday and midnight)
/// </summary>
HalfDay = 2,
/// <summary>
/// Roll the log each day (midnight)
/// </summary>
TopOfDay = 3,
/// <summary>
/// Roll the log each week
/// </summary>
TopOfWeek = 4,
/// <summary>
/// Roll the log each month
/// </summary>
TopOfMonth = 5
}
#endregion Protected Enums
#region Public Instance Constructors
/// <summary>
/// Initializes a new instance of the <see cref="RollingFileAppender" /> class.
/// </summary>
/// <remarks>
/// <para>
/// Default constructor.
/// </para>
/// </remarks>
public RollingFileAppender()
{
}
/// <summary>
/// Cleans up all resources used by this appender.
/// </summary>
~RollingFileAppender()
{
#if !NETCF
if (m_mutexForRolling != null)
{
#if NET_4_0 || MONO_4_0 || NETSTANDARD1_3
m_mutexForRolling.Dispose();
#else
m_mutexForRolling.Close();
#endif
m_mutexForRolling = null;
}
#endif
}
#endregion Public Instance Constructors
#region Public Instance Properties
#if !NET_1_0 && !CLI_1_0 && !NETCF
/// <summary>
/// Gets or sets the strategy for determining the current date and time. The default
/// implementation is to use LocalDateTime which internally calls through to DateTime.Now.
/// DateTime.UtcNow may be used on frameworks newer than .NET 1.0 by specifying
/// <see cref="RollingFileAppender.UniversalDateTime"/>.
/// </summary>
/// <value>
/// An implementation of the <see cref="RollingFileAppender.IDateTime"/> interface which returns the current date and time.
/// </value>
/// <remarks>
/// <para>
/// Gets or sets the <see cref="RollingFileAppender.IDateTime"/> used to return the current date and time.
/// </para>
/// <para>
/// There are two built strategies for determining the current date and time,
/// <see cref="RollingFileAppender.LocalDateTime"/>
/// and <see cref="RollingFileAppender.UniversalDateTime"/>.
/// </para>
/// <para>
/// The default strategy is <see cref="RollingFileAppender.LocalDateTime"/>.
/// </para>
/// </remarks>
#else
/// <summary>
/// Gets or sets the strategy for determining the current date and time. The default
/// implementation is to use LocalDateTime which internally calls through to DateTime.Now.
/// </summary>
/// <value>
/// An implementation of the <see cref="RollingFileAppender.IDateTime"/> interface which returns the current date and time.
/// </value>
/// <remarks>
/// <para>
/// Gets or sets the <see cref="RollingFileAppender.IDateTime"/> used to return the current date and time.
/// </para>
/// <para>
/// The default strategy is <see cref="RollingFileAppender.LocalDateTime"/>.
/// </para>
/// </remarks>
#endif
public IDateTime DateTimeStrategy
{
get { return m_dateTime; }
set { m_dateTime = value; }
}
/// <summary>
/// Gets or sets the date pattern to be used for generating file names
/// when rolling over on date.
/// </summary>
/// <value>
/// The date pattern to be used for generating file names when rolling
/// over on date.
/// </value>
/// <remarks>
/// <para>
/// Takes a string in the same format as expected by
/// <see cref="log4net.DateFormatter.SimpleDateFormatter" />.
/// </para>
/// <para>
/// This property determines the rollover schedule when rolling over
/// on date.
/// </para>
/// </remarks>
public string DatePattern
{
get { return m_datePattern; }
set { m_datePattern = value; }
}
/// <summary>
/// Gets or sets the maximum number of backup files that are kept before
/// the oldest is erased.
/// </summary>
/// <value>
/// The maximum number of backup files that are kept before the oldest is
/// erased.
/// </value>
/// <remarks>
/// <para>
/// If set to zero, then there will be no backup files and the log file
/// will be truncated when it reaches <see cref="MaxFileSize"/>.
/// </para>
/// <para>
/// If a negative number is supplied then no deletions will be made. Note
/// that this could result in very slow performance as a large number of
/// files are rolled over unless <see cref="CountDirection"/> is used.
/// </para>
/// <para>
/// The maximum applies to <b>each</b> time based group of files and
/// <b>not</b> the total.
/// </para>
/// </remarks>
public int MaxSizeRollBackups
{
get { return m_maxSizeRollBackups; }
set { m_maxSizeRollBackups = value; }
}
/// <summary>
/// Gets or sets the maximum size that the output file is allowed to reach
/// before being rolled over to backup files.
/// </summary>
/// <value>
/// The maximum size in bytes that the output file is allowed to reach before being
/// rolled over to backup files.
/// </value>
/// <remarks>
/// <para>
/// This property is equivalent to <see cref="MaximumFileSize"/> except
/// that it is required for differentiating the setter taking a
/// <see cref="long"/> argument from the setter taking a <see cref="string"/>
/// argument.
/// </para>
/// <para>
/// The default maximum file size is 10MB (10*1024*1024).
/// </para>
/// </remarks>
public long MaxFileSize
{
get { return m_maxFileSize; }
set { m_maxFileSize = value; }
}
/// <summary>
/// Gets or sets the maximum size that the output file is allowed to reach
/// before being rolled over to backup files.
/// </summary>
/// <value>
/// The maximum size that the output file is allowed to reach before being
/// rolled over to backup files.
/// </value>
/// <remarks>
/// <para>
/// This property allows you to specify the maximum size with the
/// suffixes "KB", "MB" or "GB" so that the size is interpreted being
/// expressed respectively in kilobytes, megabytes or gigabytes.
/// </para>
/// <para>
/// For example, the value "10KB" will be interpreted as 10240 bytes.
/// </para>
/// <para>
/// The default maximum file size is 10MB.
/// </para>
/// <para>
/// If you have the option to set the maximum file size programmatically
/// consider using the <see cref="MaxFileSize"/> property instead as this
/// allows you to set the size in bytes as a <see cref="Int64"/>.
/// </para>
/// </remarks>
public string MaximumFileSize
{
get { return m_maxFileSize.ToString(NumberFormatInfo.InvariantInfo); }
set { m_maxFileSize = OptionConverter.ToFileSize(value, m_maxFileSize + 1); }
}
/// <summary>
/// Gets or sets the rolling file count direction.
/// </summary>
/// <value>
/// The rolling file count direction.
/// </value>
/// <remarks>
/// <para>
/// Indicates if the current file is the lowest numbered file or the
/// highest numbered file.
/// </para>
/// <para>
/// By default newer files have lower numbers (<see cref="CountDirection" /> < 0),
/// i.e. log.1 is most recent, log.5 is the 5th backup, etc...
/// </para>
/// <para>
/// <see cref="CountDirection" /> >= 0 does the opposite i.e.
/// log.1 is the first backup made, log.5 is the 5th backup made, etc.
/// For infinite backups use <see cref="CountDirection" /> >= 0 to reduce
/// rollover costs.
/// </para>
/// <para>The default file count direction is -1.</para>
/// </remarks>
public int CountDirection
{
get { return m_countDirection; }
set { m_countDirection = value; }
}
/// <summary>
/// Gets or sets the rolling style.
/// </summary>
/// <value>The rolling style.</value>
/// <remarks>
/// <para>
/// The default rolling style is <see cref="RollingMode.Composite" />.
/// </para>
/// <para>
/// When set to <see cref="RollingMode.Once"/> this appender's
/// <see cref="FileAppender.AppendToFile"/> property is set to <c>false</c>, otherwise
/// the appender would append to a single file rather than rolling
/// the file each time it is opened.
/// </para>
/// </remarks>
public RollingMode RollingStyle
{
get { return m_rollingStyle; }
set
{
m_rollingStyle = value;
switch (m_rollingStyle)
{
case RollingMode.Once:
m_rollDate = false;
m_rollSize = false;
this.AppendToFile = false;
break;
case RollingMode.Size:
m_rollDate = false;
m_rollSize = true;
break;
case RollingMode.Date:
m_rollDate = true;
m_rollSize = false;
break;
case RollingMode.Composite:
m_rollDate = true;
m_rollSize = true;
break;
}
}
}
/// <summary>
/// Gets or sets a value indicating whether to preserve the file name extension when rolling.
/// </summary>
/// <value>
/// <c>true</c> if the file name extension should be preserved.
/// </value>
/// <remarks>
/// <para>
/// By default file.log is rolled to file.log.yyyy-MM-dd or file.log.curSizeRollBackup.
/// However, under Windows the new file name will loose any program associations as the
/// extension is changed. Optionally file.log can be renamed to file.yyyy-MM-dd.log or
/// file.curSizeRollBackup.log to maintain any program associations.
/// </para>
/// </remarks>
public bool PreserveLogFileNameExtension
{
get { return m_preserveLogFileNameExtension; }
set { m_preserveLogFileNameExtension = value; }
}
/// <summary>
/// Gets or sets a value indicating whether to always log to
/// the same file.
/// </summary>
/// <value>
/// <c>true</c> if always should be logged to the same file, otherwise <c>false</c>.
/// </value>
/// <remarks>
/// <para>
/// By default file.log is always the current file. Optionally
/// file.log.yyyy-mm-dd for current formatted datePattern can by the currently
/// logging file (or file.log.curSizeRollBackup or even
/// file.log.yyyy-mm-dd.curSizeRollBackup).
/// </para>
/// <para>
/// This will make time based rollovers with a large number of backups
/// much faster as the appender it won't have to rename all the backups!
/// </para>
/// </remarks>
public bool StaticLogFileName
{
get { return m_staticLogFileName; }
set { m_staticLogFileName = value; }
}
#endregion Public Instance Properties
#region Private Static Fields
/// <summary>
/// The fully qualified type of the RollingFileAppender class.
/// </summary>
/// <remarks>
/// Used by the internal logger to record the Type of the
/// log message.
/// </remarks>
private readonly static Type declaringType = typeof(RollingFileAppender);
#endregion Private Static Fields
#region Override implementation of FileAppender
/// <summary>
/// Sets the quiet writer being used.
/// </summary>
/// <remarks>
/// This method can be overridden by sub classes.
/// </remarks>
/// <param name="writer">the writer to set</param>
override protected void SetQWForFiles(TextWriter writer)
{
QuietWriter = new CountingQuietTextWriter(writer, ErrorHandler);
}
/// <summary>
/// Write out a logging event.
/// </summary>
/// <param name="loggingEvent">the event to write to file.</param>
/// <remarks>
/// <para>
/// Handles append time behavior for RollingFileAppender. This checks
/// if a roll over either by date (checked first) or time (checked second)
/// is need and then appends to the file last.
/// </para>
/// </remarks>
override protected void Append(LoggingEvent loggingEvent)
{
AdjustFileBeforeAppend();
base.Append(loggingEvent);
}
/// <summary>
/// Write out an array of logging events.
/// </summary>
/// <param name="loggingEvents">the events to write to file.</param>
/// <remarks>
/// <para>
/// Handles append time behavior for RollingFileAppender. This checks
/// if a roll over either by date (checked first) or time (checked second)
/// is need and then appends to the file last.
/// </para>
/// </remarks>
override protected void Append(LoggingEvent[] loggingEvents)
{
AdjustFileBeforeAppend();
base.Append(loggingEvents);
}
/// <summary>
/// Performs any required rolling before outputting the next event
/// </summary>
/// <remarks>
/// <para>
/// Handles append time behavior for RollingFileAppender. This checks
/// if a roll over either by date (checked first) or time (checked second)
/// is need and then appends to the file last.
/// </para>
/// </remarks>
virtual protected void AdjustFileBeforeAppend()
{
// reuse the file appenders locking model to lock the rolling
#if !NETCF
try
{
// if rolling should be locked, acquire the lock
if (m_mutexForRolling != null)
{
m_mutexForRolling.WaitOne();
}
#endif
if (m_rollDate)
{
DateTime n = m_dateTime.Now;
if (n >= m_nextCheck)
{
m_now = n;
m_nextCheck = NextCheckDate(m_now, m_rollPoint);
RollOverTime(true);
}
}
if (m_rollSize)
{
if ((File != null) && ((CountingQuietTextWriter)QuietWriter).Count >= m_maxFileSize)
{
RollOverSize();
}
}
#if !NETCF
}
finally
{
// if rolling should be locked, release the lock
if (m_mutexForRolling != null)
{
m_mutexForRolling.ReleaseMutex();
}
}
#endif
}
/// <summary>
/// Creates and opens the file for logging. If <see cref="StaticLogFileName"/>
/// is false then the fully qualified name is determined and used.
/// </summary>
/// <param name="fileName">the name of the file to open</param>
/// <param name="append">true to append to existing file</param>
/// <remarks>
/// <para>This method will ensure that the directory structure
/// for the <paramref name="fileName"/> specified exists.</para>
/// </remarks>
override protected void OpenFile(string fileName, bool append)
{
lock(this)
{
fileName = GetNextOutputFileName(fileName);
// Calculate the current size of the file
long currentCount = 0;
if (append)
{
using(SecurityContext.Impersonate(this))
{
if (System.IO.File.Exists(fileName))
{
currentCount = (new FileInfo(fileName)).Length;
}
}
}
else
{
if (LogLog.IsErrorEnabled)
{
// Internal check that the file is not being overwritten
// If not Appending to an existing file we should have rolled the file out of the
// way. Therefore we should not be over-writing an existing file.
// The only exception is if we are not allowed to roll the existing file away.
if (m_maxSizeRollBackups != 0 && FileExists(fileName))
{
LogLog.Error(declaringType, "RollingFileAppender: INTERNAL ERROR. Append is False but OutputFile ["+fileName+"] already exists.");
}
}
}
if (!m_staticLogFileName)
{
m_scheduledFilename = fileName;
}
// Open the file (call the base class to do it)
base.OpenFile(fileName, append);
// Set the file size onto the counting writer
((CountingQuietTextWriter)QuietWriter).Count = currentCount;
}
}
/// <summary>
/// Get the current output file name
/// </summary>
/// <param name="fileName">the base file name</param>
/// <returns>the output file name</returns>
/// <remarks>
/// The output file name is based on the base fileName specified.
/// If <see cref="StaticLogFileName"/> is set then the output
/// file name is the same as the base file passed in. Otherwise
/// the output file depends on the date pattern, on the count
/// direction or both.
/// </remarks>
protected string GetNextOutputFileName(string fileName)
{
if (!m_staticLogFileName)
{
fileName = fileName.Trim();
if (m_rollDate)
{
fileName = CombinePath(fileName, m_now.ToString(m_datePattern, System.Globalization.DateTimeFormatInfo.InvariantInfo));
}
if (m_countDirection >= 0)
{
fileName = CombinePath(fileName, "." + m_curSizeRollBackups);
}
}
return fileName;
}
#endregion
#region Initialize Options
/// <summary>
/// Determines curSizeRollBackups (only within the current roll point)
/// </summary>
private void DetermineCurSizeRollBackups()
{
m_curSizeRollBackups = 0;
string fullPath = null;
string fileName = null;
using(SecurityContext.Impersonate(this))
{
fullPath = System.IO.Path.GetFullPath(m_baseFileName);
fileName = System.IO.Path.GetFileName(fullPath);
}
IList<FileInfo> arrayFiles = GetExistingFiles(fullPath);
InitializeRollBackups(fileName, arrayFiles);
LogLog.Debug(declaringType, "curSizeRollBackups starts at ["+m_curSizeRollBackups+"]");
}
/// <summary>
/// Generates a wildcard pattern that can be used to find all files
/// that are similar to the base file name.
/// </summary>
/// <param name="baseFileName"></param>
/// <returns></returns>
private string GetWildcardPatternForFile(string baseFileName)
{
if (m_preserveLogFileNameExtension)
{
return Path.GetFileNameWithoutExtension(baseFileName) + "*" + Path.GetExtension(baseFileName);
}
else
{
return baseFileName + '*';
}
}
/// <summary>
/// Builds a list of filenames for all files matching the base filename plus a file
/// pattern.
/// </summary>
/// <param name="baseFilePath"></param>
/// <returns></returns>
private List<FileInfo> GetExistingFiles(string baseFilePath)
{
List<FileInfo> alFiles = new List<FileInfo>();
string directory = null;
using(SecurityContext.Impersonate(this))
{
string fullPath = Path.GetFullPath(baseFilePath);
directory = Path.GetDirectoryName(fullPath);
if (Directory.Exists(directory))
{
string baseFileName = Path.GetFileName(fullPath);
DirectoryInfo directoryInfo = new DirectoryInfo(directory);
FileInfo[] files = directoryInfo.GetFiles(GetWildcardPatternForFile(baseFileName));
if (files != null)
{
for (int i = 0; i < files.Length; i++)
{
string curFileName = files[i].Name;
if (curFileName.StartsWith(Path.GetFileNameWithoutExtension(baseFileName)))
{
alFiles.Add(files[i]);
}
}
}
}
}
LogLog.Debug(declaringType, "Searched for existing files in ["+directory+"]");
return alFiles;
}
/// <summary>
/// Initiates a roll over if needed for crossing a date boundary since the last run.
/// </summary>
private void RollOverIfDateBoundaryCrossing()
{
if (m_staticLogFileName && m_rollDate)
{
if (FileExists(m_baseFileName))
{
DateTime last;
using(SecurityContext.Impersonate(this)) {
#if !NET_1_0 && !CLI_1_0 && !NETCF
if (DateTimeStrategy is UniversalDateTime)
{
last = System.IO.File.GetLastWriteTimeUtc(m_baseFileName);
}
else
{
#endif
last = System.IO.File.GetLastWriteTime(m_baseFileName);
#if !NET_1_0 && !CLI_1_0 && !NETCF
}
#endif
}
LogLog.Debug(declaringType, "["+last.ToString(m_datePattern,System.Globalization.DateTimeFormatInfo.InvariantInfo)+"] vs. ["+m_now.ToString(m_datePattern,System.Globalization.DateTimeFormatInfo.InvariantInfo)+"]");
if (!(last.ToString(m_datePattern,System.Globalization.DateTimeFormatInfo.InvariantInfo).Equals(m_now.ToString(m_datePattern, System.Globalization.DateTimeFormatInfo.InvariantInfo))))
{
m_scheduledFilename = CombinePath(m_baseFileName, last.ToString(m_datePattern, System.Globalization.DateTimeFormatInfo.InvariantInfo));
LogLog.Debug(declaringType, "Initial roll over to ["+m_scheduledFilename+"]");
RollOverTime(false);
LogLog.Debug(declaringType, "curSizeRollBackups after rollOver at ["+m_curSizeRollBackups+"]");
}
}
}
}
/// <summary>
/// Initializes based on existing conditions at time of <see cref="ActivateOptions"/>.
/// </summary>
/// <remarks>
/// <para>
/// Initializes based on existing conditions at time of <see cref="ActivateOptions"/>.
/// The following is done
/// <list type="bullet">
/// <item>determine curSizeRollBackups (only within the current roll point)</item>
/// <item>initiates a roll over if needed for crossing a date boundary since the last run.</item>
/// </list>
/// </para>
/// </remarks>
protected void ExistingInit()
{
DetermineCurSizeRollBackups();
RollOverIfDateBoundaryCrossing();
// If file exists and we are not appending then roll it out of the way
if (AppendToFile == false)
{
bool fileExists = false;
string fileName = GetNextOutputFileName(m_baseFileName);
using(SecurityContext.Impersonate(this))
{
fileExists = System.IO.File.Exists(fileName);
}
if (fileExists)
{
if (m_maxSizeRollBackups == 0)
{
LogLog.Debug(declaringType, "Output file ["+fileName+"] already exists. MaxSizeRollBackups is 0; cannot roll. Overwriting existing file.");
}
else
{
LogLog.Debug(declaringType, "Output file ["+fileName+"] already exists. Not appending to file. Rolling existing file out of the way.");
RollOverRenameFiles(fileName);
}
}
}
}
/// <summary>
/// Does the work of bumping the 'current' file counter higher
/// to the highest count when an incremental file name is seen.
/// The highest count is either the first file (when count direction
/// is greater than 0) or the last file (when count direction less than 0).
/// In either case, we want to know the highest count that is present.
/// </summary>
/// <param name="baseFile"></param>
/// <param name="curFileName"></param>
private void InitializeFromOneFile(string baseFile, string curFileName)
{
if (curFileName.StartsWith(Path.GetFileNameWithoutExtension(baseFile)) == false)
{
// This is not a log file, so ignore
return;
}
if (curFileName.Equals(baseFile))
{
// Base log file is not an incremented logfile (.1 or .2, etc)
return;
}
// Only look for files in the current roll point
if (m_rollDate && !m_staticLogFileName)
{
string date = m_dateTime.Now.ToString(m_datePattern, System.Globalization.DateTimeFormatInfo.InvariantInfo);
string prefix = m_preserveLogFileNameExtension ? Path.GetFileNameWithoutExtension(baseFile) + date : baseFile + date;
string suffix = m_preserveLogFileNameExtension ? Path.GetExtension(baseFile) : "";
if (!curFileName.StartsWith(prefix) || !curFileName.EndsWith(suffix))
{
LogLog.Debug(declaringType, "Ignoring file ["+curFileName+"] because it is from a different date period");
return;
}
}
try
{
// Bump the counter up to the highest count seen so far
int backup = GetBackUpIndex(curFileName);
// caution: we might get a false positive when certain
// date patterns such as yyyyMMdd are used...those are
// valid number but aren't the kind of back up index
// we're looking for
if (backup > m_curSizeRollBackups)
{
if (0 == m_maxSizeRollBackups)
{
// Stay at zero when zero backups are desired
}
else if (-1 == m_maxSizeRollBackups)
{
// Infinite backups, so go as high as the highest value
m_curSizeRollBackups = backup;
}
else
{
// Backups limited to a finite number
if (m_countDirection >= 0)
{
// Go with the highest file when counting up
m_curSizeRollBackups = backup;
}
else
{
// Clip to the limit when counting down
if (backup <= m_maxSizeRollBackups)
{
m_curSizeRollBackups = backup;
}
}
}
LogLog.Debug(declaringType, "File name [" + curFileName + "] moves current count to [" + m_curSizeRollBackups + "]");
}
}
catch(FormatException)
{
// This happens when file.log -> file.log.yyyy-MM-dd which is normal
// when staticLogFileName == false
LogLog.Debug(declaringType, "Encountered a backup file not ending in .x ["+curFileName+"]");
}
}
/// <summary>
/// Attempts to extract a number from the end of the file name that indicates
/// the number of the times the file has been rolled over.
/// </summary>
/// <remarks>
/// Certain date pattern extensions like yyyyMMdd will be parsed as valid backup indexes.
/// </remarks>