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
#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.Text;
using System.Xml;
 
using log4net.Core;
using log4net.Util;
 
namespace log4net.Layout
{
    /// <summary>
    /// Layout that formats the log events as XML elements.
    /// </summary>
    /// <remarks>
    /// <para>
    /// The output of the <see cref="XmlLayout" /> consists of a series of 
    /// log4net:event elements. It does not output a complete well-formed XML 
    /// file. The output is designed to be included as an <em>external entity</em>
    /// in a separate file to form a correct XML file.
    /// </para>
    /// <para>
    /// For example, if <c>abc</c> is the name of the file where
    /// the <see cref="XmlLayout" /> output goes, then a well-formed XML file would 
    /// be:
    /// </para>
    /// <code lang="XML">
    /// &lt;?xml version="1.0" ?&gt;
    /// 
    /// &lt;!DOCTYPE log4net:events SYSTEM "log4net-events.dtd" [&lt;!ENTITY data SYSTEM "abc"&gt;]&gt;
    ///
    /// &lt;log4net:events version="1.2" xmlns:log4net="http://logging.apache.org/log4net/schemas/log4net-events-1.2&gt;
    ///     &amp;data;
    /// &lt;/log4net:events&gt;
    /// </code>
    /// <para>
    /// This approach enforces the independence of the <see cref="XmlLayout" /> 
    /// and the appender where it is embedded.
    /// </para>
    /// <para>
    /// The <c>version</c> attribute helps components to correctly
    /// interpret output generated by <see cref="XmlLayout" />. The value of 
    /// this attribute should be "1.2" for release 1.2 and later.
    /// </para>
    /// <para>
    /// Alternatively the <c>Header</c> and <c>Footer</c> properties can be
    /// configured to output the correct XML header, open tag and close tag.
    /// When setting the <c>Header</c> and <c>Footer</c> properties it is essential
    /// that the underlying data store not be appendable otherwise the data
    /// will become invalid XML.
    /// </para>
    /// </remarks>
    /// <author>Nicko Cadell</author>
    /// <author>Gert Driesen</author>
    public class XmlLayout : XmlLayoutBase
    {
        #region Public Instance Constructors
 
        /// <summary>
        /// Constructs an XmlLayout
        /// </summary>
        public XmlLayout() : base()
        {
        }
 
        /// <summary>
        /// Constructs an XmlLayout.
        /// </summary>
        /// <remarks>
        /// <para>
        /// The <b>LocationInfo</b> option takes a boolean value. By
        /// default, it is set to false which means there will be no location
        /// information output by this layout. If the the option is set to
        /// true, then the file name and line number of the statement
        /// at the origin of the log statement will be output. 
        /// </para>
        /// <para>
        /// If you are embedding this layout within an SmtpAppender
        /// then make sure to set the <b>LocationInfo</b> option of that 
        /// appender as well.
        /// </para>
        /// </remarks>
        public XmlLayout(bool locationInfo) :  base(locationInfo)
        {
        }
 
        #endregion Public Instance Constructors
 
        #region Public Instance Properties
 
        /// <summary>
        /// The prefix to use for all element names
        /// </summary>
        /// <remarks>
        /// <para>
        /// The default prefix is <b>log4net</b>. Set this property
        /// to change the prefix. If the prefix is set to an empty string
        /// then no prefix will be written.
        /// </para>
        /// </remarks>
        public string Prefix
        {
            get { return m_prefix; }
            set { m_prefix = value; }
        }
 
        
        /// <summary>
        /// Set whether or not to base64 encode the message.
        /// </summary>
        /// <remarks>
        /// <para>
        /// By default the log message will be written as text to the xml
        /// output. This can cause problems when the message contains binary
        /// data. By setting this to true the contents of the message will be
        /// base64 encoded. If this is set then invalid character replacement
        /// (see <see cref="XmlLayoutBase.InvalidCharReplacement"/>) will not be performed
        /// on the log message.
        /// </para>
        /// </remarks>
        public bool Base64EncodeMessage
        {
            get {return m_base64Message;}
            set {m_base64Message=value;}
        }
 
        /// <summary>
        /// Set whether or not to base64 encode the property values.
        /// </summary>
        /// <remarks>
        /// <para>
        /// By default the properties will be written as text to the xml
        /// output. This can cause problems when one or more properties contain
        /// binary data. By setting this to true the values of the properties
        /// will be base64 encoded. If this is set then invalid character replacement
        /// (see <see cref="XmlLayoutBase.InvalidCharReplacement"/>) will not be performed
        /// on the property values.
        /// </para>
        /// </remarks>
        public bool Base64EncodeProperties
        {
            get {return m_base64Properties;}
            set {m_base64Properties=value;}
        }
 
 
        #endregion Public Instance Properties
 
        #region Implementation of IOptionHandler
 
        /// <summary>
        /// Initialize layout options
        /// </summary>
        /// <remarks>
        /// <para>
        /// This is part of the <see cref="IOptionHandler"/> delayed object
        /// activation scheme. The <see cref="ActivateOptions"/> method must 
        /// be called on this object after the configuration properties have
        /// been set. Until <see cref="ActivateOptions"/> is called this
        /// object is in an undefined state and must not be used. 
        /// </para>
        /// <para>
        /// If any of the configuration properties are modified then 
        /// <see cref="ActivateOptions"/> must be called again.
        /// </para>
        /// <para>
        /// Builds a cache of the element names
        /// </para>
        /// </remarks>
        override public void ActivateOptions() 
        {
            base.ActivateOptions();
 
            // Cache the full element names including the prefix
            if (m_prefix != null && m_prefix.Length > 0)
            {
                m_elmEvent = m_prefix + ":" + ELM_EVENT;
                m_elmMessage = m_prefix + ":" + ELM_MESSAGE;
                m_elmProperties = m_prefix + ":" + ELM_PROPERTIES;
                m_elmData = m_prefix + ":" + ELM_DATA;
                m_elmException = m_prefix + ":" + ELM_EXCEPTION;
                m_elmLocation = m_prefix + ":" + ELM_LOCATION;
            }
        }
 
        #endregion Implementation of IOptionHandler
 
        #region Override implementation of XMLLayoutBase
 
        /// <summary>
        /// Does the actual writing of the XML.
        /// </summary>
        /// <param name="writer">The writer to use to output the event to.</param>
        /// <param name="loggingEvent">The event to write.</param>
        /// <remarks>
        /// <para>
        /// Override the base class <see cref="XmlLayoutBase.FormatXml"/> method
        /// to write the <see cref="LoggingEvent"/> to the <see cref="XmlWriter"/>.
        /// </para>
        /// </remarks>
        override protected void FormatXml(XmlWriter writer, LoggingEvent loggingEvent)
        {
            writer.WriteStartElement(m_elmEvent);
            writer.WriteAttributeString(ATTR_LOGGER, loggingEvent.LoggerName);
 
#if NET_2_0 || NETCF_2_0 || MONO_2_0
            writer.WriteAttributeString(ATTR_TIMESTAMP, XmlConvert.ToString(loggingEvent.TimeStamp, XmlDateTimeSerializationMode.Local));
#else
            writer.WriteAttributeString(ATTR_TIMESTAMP, XmlConvert.ToString(loggingEvent.TimeStamp));
#endif
 
            writer.WriteAttributeString(ATTR_LEVEL, loggingEvent.Level.DisplayName);
            writer.WriteAttributeString(ATTR_THREAD, loggingEvent.ThreadName);
 
            if (loggingEvent.Domain != null && loggingEvent.Domain.Length > 0)
            {
                writer.WriteAttributeString(ATTR_DOMAIN, loggingEvent.Domain);
            }
            if (loggingEvent.Identity != null && loggingEvent.Identity.Length > 0)
            {
                writer.WriteAttributeString(ATTR_IDENTITY, loggingEvent.Identity);
            }
            if (loggingEvent.UserName != null && loggingEvent.UserName.Length > 0)
            {
                writer.WriteAttributeString(ATTR_USERNAME, loggingEvent.UserName);
            }
    
            // Append the message text
            writer.WriteStartElement(m_elmMessage);
            if (!this.Base64EncodeMessage)
            {
                Transform.WriteEscapedXmlString(writer, loggingEvent.RenderedMessage, this.InvalidCharReplacement);
            }
            else
            {
                byte[] messageBytes = Encoding.UTF8.GetBytes(loggingEvent.RenderedMessage);
                string base64Message = Convert.ToBase64String(messageBytes, 0, messageBytes.Length);
                Transform.WriteEscapedXmlString(writer, base64Message,this.InvalidCharReplacement);
            }
            writer.WriteEndElement();
 
            PropertiesDictionary properties = loggingEvent.GetProperties();
 
            // Append the properties text
            if (properties.Count > 0)
            {
                writer.WriteStartElement(m_elmProperties);
                foreach(System.Collections.DictionaryEntry entry in properties)
                {
                    writer.WriteStartElement(m_elmData);
                    writer.WriteAttributeString(ATTR_NAME, Transform.MaskXmlInvalidCharacters((string)entry.Key,this.InvalidCharReplacement));
 
                    // Use an ObjectRenderer to convert the object to a string
                    string valueStr =null;
                    if (!this.Base64EncodeProperties)
                    {
                        valueStr = Transform.MaskXmlInvalidCharacters(loggingEvent.Repository.RendererMap.FindAndRender(entry.Value),this.InvalidCharReplacement);
                    }
                    else
                    {
                        byte[] propertyValueBytes = Encoding.UTF8.GetBytes(loggingEvent.Repository.RendererMap.FindAndRender(entry.Value));
                        valueStr = Convert.ToBase64String(propertyValueBytes, 0, propertyValueBytes.Length);
                    }
                    writer.WriteAttributeString(ATTR_VALUE, valueStr);
 
                    writer.WriteEndElement();
                }
                writer.WriteEndElement();
            }
 
            string exceptionStr = loggingEvent.GetExceptionString();
            if (exceptionStr != null && exceptionStr.Length > 0)
            {
                // Append the stack trace line
                writer.WriteStartElement(m_elmException);
                Transform.WriteEscapedXmlString(writer, exceptionStr,this.InvalidCharReplacement);
                writer.WriteEndElement();
            }
 
            if (LocationInfo)
            { 
                LocationInfo locationInfo = loggingEvent.LocationInformation;
 
                writer.WriteStartElement(m_elmLocation);
                writer.WriteAttributeString(ATTR_CLASS, locationInfo.ClassName);
                writer.WriteAttributeString(ATTR_METHOD, locationInfo.MethodName);
                writer.WriteAttributeString(ATTR_FILE, locationInfo.FileName);
                writer.WriteAttributeString(ATTR_LINE, locationInfo.LineNumber);
                writer.WriteEndElement();
            }
 
            writer.WriteEndElement();
        }
 
        #endregion Override implementation of XMLLayoutBase
 
        #region Private Instance Fields
  
        /// <summary>
        /// The prefix to use for all generated element names
        /// </summary>
        private string m_prefix = PREFIX;
 
        private string m_elmEvent = ELM_EVENT;
        private string m_elmMessage = ELM_MESSAGE;
        private string m_elmData = ELM_DATA;
        private string m_elmProperties = ELM_PROPERTIES;
        private string m_elmException = ELM_EXCEPTION;
        private string m_elmLocation = ELM_LOCATION;
 
        private bool m_base64Message=false;
        private bool m_base64Properties=false;
 
        #endregion Private Instance Fields
 
        #region Private Static Fields
 
        private const string PREFIX = "log4net";
 
        private const string ELM_EVENT = "event";
        private const string ELM_MESSAGE = "message";
        private const string ELM_PROPERTIES = "properties";
        private const string ELM_GLOBAL_PROPERTIES = "global-properties";
        private const string ELM_DATA = "data";
        private const string ELM_EXCEPTION = "exception";
        private const string ELM_LOCATION = "locationInfo";
 
        private const string ATTR_LOGGER = "logger";
        private const string ATTR_TIMESTAMP = "timestamp";
        private const string ATTR_LEVEL = "level";
        private const string ATTR_THREAD = "thread";
        private const string ATTR_DOMAIN = "domain";
        private const string ATTR_IDENTITY = "identity";
        private const string ATTR_USERNAME = "username";
        private const string ATTR_CLASS = "class";
        private const string ATTR_METHOD = "method";
        private const string ATTR_FILE = "file";
        private const string ATTR_LINE = "line";
        private const string ATTR_NAME = "name";
        private const string ATTR_VALUE = "value";
 
 
        #endregion Private Static Fields
    }
}