jt
2021-06-10 5d0d028456874576560552f5a5c4e8b801786f11
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
#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.Configuration;
using System.Diagnostics;
 
namespace log4net.Util
{
    /// <summary>
    /// 
    /// </summary>
    /// <param name="source"></param>
    /// <param name="e"></param>
    public delegate void LogReceivedEventHandler(object source, LogReceivedEventArgs e);
 
    /// <summary>
    /// Outputs log statements from within the log4net assembly.
    /// </summary>
    /// <remarks>
    /// <para>
    /// Log4net components cannot make log4net logging calls. However, it is
    /// sometimes useful for the user to learn about what log4net is
    /// doing.
    /// </para>
    /// <para>
    /// All log4net internal debug calls go to the standard output stream
    /// whereas internal error messages are sent to the standard error output 
    /// stream.
    /// </para>
    /// </remarks>
    /// <author>Nicko Cadell</author>
    /// <author>Gert Driesen</author>
    public sealed class LogLog
    {
        /// <summary>
        /// The event raised when an internal message has been received.
        /// </summary>
        public static event LogReceivedEventHandler LogReceived;
 
        private readonly Type source;
        private readonly DateTime timeStamp;
        private readonly string prefix;
        private readonly string message;
        private readonly Exception exception;
 
        /// <summary>
        /// The Type that generated the internal message.
        /// </summary>
        public Type Source
        {
            get { return source; }
        }
 
        /// <summary>
        /// The DateTime stamp of when the internal message was received.
        /// </summary>
        public DateTime TimeStamp
        {
            get { return timeStamp; }
        }
 
        /// <summary>
        /// A string indicating the severity of the internal message.
        /// </summary>
        /// <remarks>
        /// "log4net: ", 
        /// "log4net:ERROR ", 
        /// "log4net:WARN "
        /// </remarks>
        public string Prefix
        {
            get { return prefix; }
        }
 
        /// <summary>
        /// The internal log message.
        /// </summary>
        public string Message
        {
            get { return message; }
        }
 
        /// <summary>
        /// The Exception related to the message.
        /// </summary>
        /// <remarks>
        /// Optional. Will be null if no Exception was passed.
        /// </remarks>
        public Exception Exception
        {
            get { return exception; }
        }
 
        /// <summary>
        /// Formats Prefix, Source, and Message in the same format as the value
        /// sent to Console.Out and Trace.Write.
        /// </summary>
        /// <returns></returns>
        public override string ToString()
        {
            return Prefix + Source.Name + ": " + Message;
        }
 
        #region Private Instance Constructors
 
        /// <summary>
        /// Initializes a new instance of the <see cref="LogLog" /> class. 
        /// </summary>
        /// <param name="source"></param>
        /// <param name="prefix"></param>
        /// <param name="message"></param>
        /// <param name="exception"></param>
        public LogLog(Type source, string prefix, string message, Exception exception)
        {
            timeStamp = DateTime.Now;
            
            this.source = source;
            this.prefix = prefix;
            this.message = message;
            this.exception = exception;
        }
 
        #endregion Private Instance Constructors
 
        #region Static Constructor
 
        /// <summary>
        /// Static constructor that initializes logging by reading 
        /// settings from the application configuration file.
        /// </summary>
        /// <remarks>
        /// <para>
        /// The <c>log4net.Internal.Debug</c> application setting
        /// controls internal debugging. This setting should be set
        /// to <c>true</c> to enable debugging.
        /// </para>
        /// <para>
        /// The <c>log4net.Internal.Quiet</c> application setting
        /// suppresses all internal logging including error messages. 
        /// This setting should be set to <c>true</c> to enable message
        /// suppression.
        /// </para>
        /// </remarks>
        static LogLog()
        {
#if !NETCF
            try
            {
                InternalDebugging = OptionConverter.ToBoolean(SystemInfo.GetAppSetting("log4net.Internal.Debug"), false);
                QuietMode = OptionConverter.ToBoolean(SystemInfo.GetAppSetting("log4net.Internal.Quiet"), false);
                EmitInternalMessages = OptionConverter.ToBoolean(SystemInfo.GetAppSetting("log4net.Internal.Emit"), true);
            }
            catch(Exception ex)
            {
                // If an exception is thrown here then it looks like the config file does not
                // parse correctly.
                //
                // We will leave debug OFF and print an Error message
                Error(typeof(LogLog), "Exception while reading ConfigurationSettings. Check your .config file is well formed XML.", ex);
            }
#endif
        }
 
        #endregion Static Constructor
 
        #region Public Static Properties
 
        /// <summary>
        /// Gets or sets a value indicating whether log4net internal logging
        /// is enabled or disabled.
        /// </summary>
        /// <value>
        /// <c>true</c> if log4net internal logging is enabled, otherwise 
        /// <c>false</c>.
        /// </value>
        /// <remarks>
        /// <para>
        /// When set to <c>true</c>, internal debug level logging will be 
        /// displayed.
        /// </para>
        /// <para>
        /// This value can be set by setting the application setting 
        /// <c>log4net.Internal.Debug</c> in the application configuration
        /// file.
        /// </para>
        /// <para>
        /// The default value is <c>false</c>, i.e. debugging is
        /// disabled.
        /// </para>
        /// </remarks>
        /// <example>
        /// <para>
        /// The following example enables internal debugging using the 
        /// application configuration file :
        /// </para>
        /// <code lang="XML" escaped="true">
        /// <configuration>
        ///        <appSettings>
        ///            <add key="log4net.Internal.Debug" value="true" />
        ///        </appSettings>
        /// </configuration>
        /// </code>
        /// </example>
        public static bool InternalDebugging
        {
            get { return s_debugEnabled; }
            set { s_debugEnabled = value; }
        }
 
        /// <summary>
        /// Gets or sets a value indicating whether log4net should generate no output
        /// from internal logging, not even for errors. 
        /// </summary>
        /// <value>
        /// <c>true</c> if log4net should generate no output at all from internal 
        /// logging, otherwise <c>false</c>.
        /// </value>
        /// <remarks>
        /// <para>
        /// When set to <c>true</c> will cause internal logging at all levels to be 
        /// suppressed. This means that no warning or error reports will be logged. 
        /// This option overrides the <see cref="InternalDebugging"/> setting and 
        /// disables all debug also.
        /// </para>
        /// <para>This value can be set by setting the application setting
        /// <c>log4net.Internal.Quiet</c> in the application configuration file.
        /// </para>
        /// <para>
        /// The default value is <c>false</c>, i.e. internal logging is not
        /// disabled.
        /// </para>
        /// </remarks>
        /// <example>
        /// The following example disables internal logging using the 
        /// application configuration file :
        /// <code lang="XML" escaped="true">
        /// <configuration>
        ///        <appSettings>
        ///            <add key="log4net.Internal.Quiet" value="true" />
        ///        </appSettings>
        /// </configuration>
        /// </code>
        /// </example>
        public static bool QuietMode
        {
            get { return s_quietMode; }
            set { s_quietMode = value; }
        }
 
        /// <summary>
        /// 
        /// </summary>
        public static bool EmitInternalMessages
        {
            get { return s_emitInternalMessages; }
            set { s_emitInternalMessages = value; }
        }
 
        #endregion Public Static Properties
 
        #region Public Static Methods
 
        /// <summary>
        /// Raises the LogReceived event when an internal messages is received.
        /// </summary>
        /// <param name="source"></param>
        /// <param name="prefix"></param>
        /// <param name="message"></param>
        /// <param name="exception"></param>
        public static void OnLogReceived(Type source, string prefix, string message, Exception exception)
        {
            if (LogReceived != null)
            {
                LogReceived(null, new LogReceivedEventArgs(new LogLog(source, prefix, message, exception)));
            }
        }
 
        /// <summary>
        /// Test if LogLog.Debug is enabled for output.
        /// </summary>
        /// <value>
        /// <c>true</c> if Debug is enabled
        /// </value>
        /// <remarks>
        /// <para>
        /// Test if LogLog.Debug is enabled for output.
        /// </para>
        /// </remarks>
        public static bool IsDebugEnabled
        {
            get { return s_debugEnabled && !s_quietMode; }
        }
 
        /// <summary>
        /// Writes log4net internal debug messages to the 
        /// standard output stream.
        /// </summary>
        /// <param name="source"></param>
        /// <param name="message">The message to log.</param>
        /// <remarks>
        /// <para>
        ///    All internal debug messages are prepended with 
        ///    the string "log4net: ".
        /// </para>
        /// </remarks>
        public static void Debug(Type source, string message) 
        {
            if (IsDebugEnabled) 
            {
                if (EmitInternalMessages)
                {
                    EmitOutLine(PREFIX + message);
                }
 
                OnLogReceived(source, PREFIX, message, null);
            }
        }
 
        /// <summary>
        /// Writes log4net internal debug messages to the 
        /// standard output stream.
        /// </summary>
        /// <param name="source">The Type that generated this message.</param>
        /// <param name="message">The message to log.</param>
        /// <param name="exception">An exception to log.</param>
        /// <remarks>
        /// <para>
        ///    All internal debug messages are prepended with 
        ///    the string "log4net: ".
        /// </para>
        /// </remarks>
        public static void Debug(Type source, string message, Exception exception) 
        {
            if (IsDebugEnabled) 
            {
                if (EmitInternalMessages)
                {
                    EmitOutLine(PREFIX + message);
                    if (exception != null)
                    {
                        EmitOutLine(exception.ToString());
                    }
                }
 
                OnLogReceived(source, PREFIX, message, exception);
            }
        }
  
        /// <summary>
        /// Test if LogLog.Warn is enabled for output.
        /// </summary>
        /// <value>
        /// <c>true</c> if Warn is enabled
        /// </value>
        /// <remarks>
        /// <para>
        /// Test if LogLog.Warn is enabled for output.
        /// </para>
        /// </remarks>
        public static bool IsWarnEnabled
        {
            get { return !s_quietMode; }
        }
 
        /// <summary>
        /// Writes log4net internal warning messages to the 
        /// standard error stream.
        /// </summary>
        /// <param name="source">The Type that generated this message.</param>
        /// <param name="message">The message to log.</param>
        /// <remarks>
        /// <para>
        ///    All internal warning messages are prepended with 
        ///    the string "log4net:WARN ".
        /// </para>
        /// </remarks>
        public static void Warn(Type source, string message) 
        {
            if (IsWarnEnabled)
            {
                if (EmitInternalMessages)
                {
                    EmitErrorLine(WARN_PREFIX + message);
                }
 
                OnLogReceived(source, WARN_PREFIX, message, null);
            }
        }  
 
        /// <summary>
        /// Writes log4net internal warning messages to the 
        /// standard error stream.
        /// </summary>
        /// <param name="source">The Type that generated this message.</param>
        /// <param name="message">The message to log.</param>
        /// <param name="exception">An exception to log.</param>
        /// <remarks>
        /// <para>
        ///    All internal warning messages are prepended with 
        ///    the string "log4net:WARN ".
        /// </para>
        /// </remarks>
        public static void Warn(Type source, string message, Exception exception) 
        {
            if (IsWarnEnabled)
            {
                if (EmitInternalMessages)
                {
                    EmitErrorLine(WARN_PREFIX + message);
                    if (exception != null)
                    {
                        EmitErrorLine(exception.ToString());
                    }
                }
 
                OnLogReceived(source, WARN_PREFIX, message, exception);
            }
        } 
 
        /// <summary>
        /// Test if LogLog.Error is enabled for output.
        /// </summary>
        /// <value>
        /// <c>true</c> if Error is enabled
        /// </value>
        /// <remarks>
        /// <para>
        /// Test if LogLog.Error is enabled for output.
        /// </para>
        /// </remarks>
        public static bool IsErrorEnabled
        {
            get { return !s_quietMode; }
        }
 
        /// <summary>
        /// Writes log4net internal error messages to the 
        /// standard error stream.
        /// </summary>
        /// <param name="source">The Type that generated this message.</param>
        /// <param name="message">The message to log.</param>
        /// <remarks>
        /// <para>
        ///    All internal error messages are prepended with 
        ///    the string "log4net:ERROR ".
        /// </para>
        /// </remarks>
        public static void Error(Type source, string message) 
        {
            if (IsErrorEnabled)
            {
                if (EmitInternalMessages)
                {
                    EmitErrorLine(ERR_PREFIX + message);
                }
 
                OnLogReceived(source, ERR_PREFIX, message, null);
            }
        }  
 
        /// <summary>
        /// Writes log4net internal error messages to the 
        /// standard error stream.
        /// </summary>
        /// <param name="source">The Type that generated this message.</param>
        /// <param name="message">The message to log.</param>
        /// <param name="exception">An exception to log.</param>
        /// <remarks>
        /// <para>
        ///    All internal debug messages are prepended with 
        ///    the string "log4net:ERROR ".
        /// </para>
        /// </remarks>
        public static void Error(Type source, string message, Exception exception) 
        {
            if (IsErrorEnabled)
            {
                if (EmitInternalMessages)
                {
                    EmitErrorLine(ERR_PREFIX + message);
                    if (exception != null)
                    {
                        EmitErrorLine(exception.ToString());
                    }
                }
 
                OnLogReceived(source, ERR_PREFIX, message, exception);
            }
        }  
 
        #endregion Public Static Methods
 
        /// <summary>
        /// Writes output to the standard output stream.  
        /// </summary>
        /// <param name="message">The message to log.</param>
        /// <remarks>
        /// <para>
        /// Writes to both Console.Out and System.Diagnostics.Trace.
        /// Note that the System.Diagnostics.Trace is not supported
        /// on the Compact Framework.
        /// </para>
        /// <para>
        /// If the AppDomain is not configured with a config file then
        /// the call to System.Diagnostics.Trace may fail. This is only
        /// an issue if you are programmatically creating your own AppDomains.
        /// </para>
        /// </remarks>
        private static void EmitOutLine(string message)
        {
            try
            {
#if NETCF
                Console.WriteLine(message);
                //System.Diagnostics.Debug.WriteLine(message);
#else
                Console.Out.WriteLine(message);
                Trace.WriteLine(message);
#endif
            }
            catch
            {
                // Ignore exception, what else can we do? Not really a good idea to propagate back to the caller
            }
        }
 
        /// <summary>
        /// Writes output to the standard error stream.  
        /// </summary>
        /// <param name="message">The message to log.</param>
        /// <remarks>
        /// <para>
        /// Writes to both Console.Error and System.Diagnostics.Trace.
        /// Note that the System.Diagnostics.Trace is not supported
        /// on the Compact Framework.
        /// </para>
        /// <para>
        /// If the AppDomain is not configured with a config file then
        /// the call to System.Diagnostics.Trace may fail. This is only
        /// an issue if you are programmatically creating your own AppDomains.
        /// </para>
        /// </remarks>
        private static void EmitErrorLine(string message)
        {
            try
            {
#if NETCF
                Console.WriteLine(message);
                //System.Diagnostics.Debug.WriteLine(message);
#else
                Console.Error.WriteLine(message);
                Trace.WriteLine(message);
#endif
            }
            catch
            {
                // Ignore exception, what else can we do? Not really a good idea to propagate back to the caller
            }
        }
 
        #region Private Static Fields
 
        /// <summary>
        ///  Default debug level
        /// </summary>
        private static bool s_debugEnabled = false;
 
        /// <summary>
        /// In quietMode not even errors generate any output.
        /// </summary>
        private static bool s_quietMode = false;
 
        private static bool s_emitInternalMessages = true;
 
        private const string PREFIX            = "log4net: ";
        private const string ERR_PREFIX        = "log4net:ERROR ";
        private const string WARN_PREFIX    = "log4net:WARN ";
 
        #endregion Private Static Fields
 
        /// <summary>
        /// Subscribes to the LogLog.LogReceived event and stores messages
        /// to the supplied IList instance.
        /// </summary>
        public class LogReceivedAdapter : IDisposable
        {
            private readonly IList items;
            private readonly LogReceivedEventHandler handler;
 
            /// <summary>
            /// 
            /// </summary>
            /// <param name="items"></param>
            public LogReceivedAdapter(IList items)
            {
                this.items = items;
 
                handler = new LogReceivedEventHandler(LogLog_LogReceived);
 
                LogReceived += handler;
            }
 
            void LogLog_LogReceived(object source, LogReceivedEventArgs e)
            {
                items.Add(e.LogLog);
            }
 
            /// <summary>
            /// 
            /// </summary>
            public IList Items
            {
                get { return items; }
            }
 
            /// <summary>
            /// 
            /// </summary>
            public void Dispose()
            {
                LogReceived -= handler;
            }
        }
    }
 
    /// <summary>
    /// 
    /// </summary>
    public class LogReceivedEventArgs : EventArgs
    {
        private readonly LogLog loglog;
 
        /// <summary>
        /// 
        /// </summary>
        /// <param name="loglog"></param>
        public LogReceivedEventArgs(LogLog loglog)
        {
            this.loglog = loglog;
        }
 
        /// <summary>
        /// 
        /// </summary>
        public LogLog LogLog
        {
            get { return loglog; }
        }
    }
}