-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
EnvironmentUserLayoutRenderer.cs
136 lines (122 loc) · 4.8 KB
/
EnvironmentUserLayoutRenderer.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
//
// Copyright (c) 2004-2019 Jaroslaw Kowalski <jaak@jkowalski.net>, Kim Christensen, Julian Verdurmen
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
//
// * Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
//
// * Neither the name of Jaroslaw Kowalski nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
// THE POSSIBILITY OF SUCH DAMAGE.
//
#if !NETSTANDARD1_0 && !SILVERLIGHT
namespace NLog.LayoutRenderers
{
using System;
using System.ComponentModel;
using System.Text;
using NLog.Common;
using NLog.Config;
using NLog.Internal;
/// <summary>
/// Thread identity information (username).
/// </summary>
[LayoutRenderer("environment-user")]
[ThreadSafe]
public class EnvironmentUserLayoutRenderer : LayoutRenderer, IStringValueRenderer
{
/// <summary>
/// Initializes a new instance of the <see cref="EnvironmentUserLayoutRenderer" /> class.
/// </summary>
public EnvironmentUserLayoutRenderer()
{
UserName = true;
Domain = false;
}
/// <summary>
/// Gets or sets a value indicating whether username should be included.
/// </summary>
/// <docgen category='Rendering Options' order='10' />
[DefaultValue(true)]
public bool UserName { get; set; }
/// <summary>
/// Gets or sets a value indicating whether domain name should be included.
/// </summary>
/// <docgen category='Rendering Options' order='10' />
[DefaultValue(false)]
public bool Domain { get; set; }
/// <summary>
/// Gets or sets the default value to be used when the User is not set.
/// </summary>
/// <docgen category='Rendering Options' order='10' />
[DefaultValue("UserUnknown")]
public string DefaultUser { get; set; } = "UserUnknown";
/// <summary>
/// Gets or sets the default value to be used when the Domain is not set.
/// </summary>
/// <docgen category='Rendering Options' order='10' />
[DefaultValue("DomainUnknown")]
public string DefaultDomain { get; set; } = "DomainUnknown";
/// <inheritdoc/>
protected override void Append(StringBuilder builder, LogEventInfo logEvent)
{
builder.Append(GetStringValue());
}
/// <inheritdoc/>
string IStringValueRenderer.GetFormattedString(LogEventInfo logEvent) => GetStringValue();
private string GetStringValue()
{
if (UserName)
{
return Domain ? string.Concat(GetDomainName(), "\\", GetUserName()) : GetUserName();
}
else
{
return Domain ? GetDomainName() : string.Empty;
}
}
string GetUserName()
{
return GetValueSafe(() => Environment.UserName, DefaultUser);
}
string GetDomainName()
{
return GetValueSafe(() => Environment.UserDomainName, DefaultDomain);
}
private string GetValueSafe(Func<string> getValue, string defaultValue)
{
try
{
var value = getValue();
return string.IsNullOrEmpty(value) ? (defaultValue ?? string.Empty) : value;
}
catch (Exception ex)
{
InternalLogger.Warn(ex, "Failed to lookup Environment-User. Fallback value={0}", defaultValue);
return defaultValue ?? string.Empty;
}
}
}
}
#endif