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
|
/*
* Copyright (C) 2009, Google Inc.
* Copyright (C) 2009, Yann Simon <yann.simon.fr@gmail.com>
* Copyright (C) 2011, Matthias Sohn <matthias.sohn@sap.com> and others
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0 which is available at
* https://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package org.eclipse.jgit.lib;
import org.eclipse.jgit.lib.Config.SectionParser;
import org.eclipse.jgit.util.SystemReader;
/**
* The standard "user" configuration parameters.
*/
public class UserConfig {
/** Key for {@link Config#get(SectionParser)}. */
public static final Config.SectionParser<UserConfig> KEY = UserConfig::new;
private String authorName;
private String authorEmail;
private String committerName;
private String committerEmail;
private boolean isAuthorNameImplicit;
private boolean isAuthorEmailImplicit;
private boolean isCommitterNameImplicit;
private boolean isCommitterEmailImplicit;
private UserConfig(Config rc) {
authorName = getNameInternal(rc, Constants.GIT_AUTHOR_NAME_KEY);
if (authorName == null) {
authorName = getDefaultUserName();
isAuthorNameImplicit = true;
}
authorEmail = getEmailInternal(rc, Constants.GIT_AUTHOR_EMAIL_KEY);
if (authorEmail == null) {
authorEmail = getDefaultEmail();
isAuthorEmailImplicit = true;
}
committerName = getNameInternal(rc, Constants.GIT_COMMITTER_NAME_KEY);
if (committerName == null) {
committerName = getDefaultUserName();
isCommitterNameImplicit = true;
}
committerEmail = getEmailInternal(rc, Constants.GIT_COMMITTER_EMAIL_KEY);
if (committerEmail == null) {
committerEmail = getDefaultEmail();
isCommitterEmailImplicit = true;
}
}
/**
* Get the author name as defined in the git variables and configurations.
*
* @return the author name as defined in the git variables and
* configurations. If no name could be found, try to use the system
* user name instead.
*/
public String getAuthorName() {
return authorName;
}
/**
* Get the committer name as defined in the git variables and
* configurations.
*
* @return the committer name as defined in the git variables and
* configurations. If no name could be found, try to use the system
* user name instead.
*/
public String getCommitterName() {
return committerName;
}
/**
* Get the author email as defined in git variables and configurations.
*
* @return the author email as defined in git variables and configurations.
* If no email could be found, try to propose one default with the
* user name and the host name.
*/
public String getAuthorEmail() {
return authorEmail;
}
/**
* Get the committer email as defined in git variables and configurations.
*
* @return the committer email as defined in git variables and
* configurations. If no email could be found, try to propose one
* default with the user name and the host name.
*/
public String getCommitterEmail() {
return committerEmail;
}
/**
* Whether the author name was not explicitly configured but constructed
* from information the system has about the logged on user
*
* @return true if the author name was not explicitly configured but
* constructed from information the system has about the logged on
* user
*/
public boolean isAuthorNameImplicit() {
return isAuthorNameImplicit;
}
/**
* Whether the author email was not explicitly configured but constructed
* from information the system has about the logged on user
*
* @return true if the author email was not explicitly configured but
* constructed from information the system has about the logged on
* user
*/
public boolean isAuthorEmailImplicit() {
return isAuthorEmailImplicit;
}
/**
* Whether the committer name was not explicitly configured but constructed
* from information the system has about the logged on user
*
* @return true if the committer name was not explicitly configured but
* constructed from information the system has about the logged on
* user
*/
public boolean isCommitterNameImplicit() {
return isCommitterNameImplicit;
}
/**
* Whether the author email was not explicitly configured but constructed
* from information the system has about the logged on user
*
* @return true if the author email was not explicitly configured but
* constructed from information the system has about the logged on
* user
*/
public boolean isCommitterEmailImplicit() {
return isCommitterEmailImplicit;
}
private static String getNameInternal(Config rc, String envKey) {
// try to get the user name for the system property GIT_XXX_NAME
String username = system().getenv(envKey);
if (username == null) {
// try to get the user name from the local and global
// configurations.
username = rc.getString("user", null, "name"); //$NON-NLS-1$ //$NON-NLS-2$
}
return stripInvalidCharacters(username);
}
/**
* @return try to get user name of the logged on user from the operating
* system
*/
private static String getDefaultUserName() {
// get the system user name
String username = system().getProperty(Constants.OS_USER_NAME_KEY);
if (username == null)
username = Constants.UNKNOWN_USER_DEFAULT;
return username;
}
private static String getEmailInternal(Config rc, String envKey) {
// try to get the email for the system property GIT_XXX_EMAIL
String email = system().getenv(envKey);
if (email == null) {
// try to get the email from the local and global configurations.
email = rc.getString("user", null, "email"); //$NON-NLS-1$ //$NON-NLS-2$
}
return stripInvalidCharacters(email);
}
private static String stripInvalidCharacters(String s) {
return s == null ? null : s.replaceAll("<|>|\n", ""); //$NON-NLS-1$//$NON-NLS-2$
}
/**
* @return try to construct email for logged on user using system
* information
*/
private static String getDefaultEmail() {
// try to construct an email
String username = getDefaultUserName();
return username + "@" + system().getHostname(); //$NON-NLS-1$
}
private static SystemReader system() {
return SystemReader.getInstance();
}
}
|