Document diff.external and mergetool.<tool>.path
[git/debian.git] / ident.c
blob892d77ac9366978fcb172e0d258410f271631012
1 /*
2 * ident.c
4 * create git identifier lines of the form "name <email> date"
6 * Copyright (C) 2005 Linus Torvalds
7 */
8 #include "cache.h"
10 static char git_default_date[50];
12 static void copy_gecos(const struct passwd *w, char *name, size_t sz)
14 char *src, *dst;
15 size_t len, nlen;
17 nlen = strlen(w->pw_name);
19 /* Traditionally GECOS field had office phone numbers etc, separated
20 * with commas. Also & stands for capitalized form of the login name.
23 for (len = 0, dst = name, src = w->pw_gecos; len < sz; src++) {
24 int ch = *src;
25 if (ch != '&') {
26 *dst++ = ch;
27 if (ch == 0 || ch == ',')
28 break;
29 len++;
30 continue;
32 if (len + nlen < sz) {
33 /* Sorry, Mr. McDonald... */
34 *dst++ = toupper(*w->pw_name);
35 memcpy(dst, w->pw_name + 1, nlen - 1);
36 dst += nlen - 1;
39 if (len < sz)
40 name[len] = 0;
41 else
42 die("Your parents must have hated you!");
46 static void copy_email(const struct passwd *pw)
49 * Make up a fake email address
50 * (name + '@' + hostname [+ '.' + domainname])
52 size_t len = strlen(pw->pw_name);
53 if (len > sizeof(git_default_email)/2)
54 die("Your sysadmin must hate you!");
55 memcpy(git_default_email, pw->pw_name, len);
56 git_default_email[len++] = '@';
57 gethostname(git_default_email + len, sizeof(git_default_email) - len);
58 if (!strchr(git_default_email+len, '.')) {
59 struct hostent *he = gethostbyname(git_default_email + len);
60 char *domainname;
62 len = strlen(git_default_email);
63 git_default_email[len++] = '.';
64 if (he && (domainname = strchr(he->h_name, '.')))
65 strlcpy(git_default_email + len, domainname + 1,
66 sizeof(git_default_email) - len);
67 else
68 strlcpy(git_default_email + len, "(none)",
69 sizeof(git_default_email) - len);
73 static void setup_ident(void)
75 struct passwd *pw = NULL;
77 /* Get the name ("gecos") */
78 if (!git_default_name[0]) {
79 pw = getpwuid(getuid());
80 if (!pw)
81 die("You don't exist. Go away!");
82 copy_gecos(pw, git_default_name, sizeof(git_default_name));
85 if (!git_default_email[0]) {
86 const char *email = getenv("EMAIL");
88 if (email && email[0])
89 strlcpy(git_default_email, email,
90 sizeof(git_default_email));
91 else {
92 if (!pw)
93 pw = getpwuid(getuid());
94 if (!pw)
95 die("You don't exist. Go away!");
96 copy_email(pw);
100 /* And set the default date */
101 if (!git_default_date[0])
102 datestamp(git_default_date, sizeof(git_default_date));
105 static int add_raw(char *buf, size_t size, int offset, const char *str)
107 size_t len = strlen(str);
108 if (offset + len > size)
109 return size;
110 memcpy(buf + offset, str, len);
111 return offset + len;
114 static int crud(unsigned char c)
116 return c <= 32 ||
117 c == '.' ||
118 c == ',' ||
119 c == ':' ||
120 c == ';' ||
121 c == '<' ||
122 c == '>' ||
123 c == '"' ||
124 c == '\'';
128 * Copy over a string to the destination, but avoid special
129 * characters ('\n', '<' and '>') and remove crud at the end
131 static int copy(char *buf, size_t size, int offset, const char *src)
133 size_t i, len;
134 unsigned char c;
136 /* Remove crud from the beginning.. */
137 while ((c = *src) != 0) {
138 if (!crud(c))
139 break;
140 src++;
143 /* Remove crud from the end.. */
144 len = strlen(src);
145 while (len > 0) {
146 c = src[len-1];
147 if (!crud(c))
148 break;
149 --len;
153 * Copy the rest to the buffer, but avoid the special
154 * characters '\n' '<' and '>' that act as delimiters on
155 * a identification line
157 for (i = 0; i < len; i++) {
158 c = *src++;
159 switch (c) {
160 case '\n': case '<': case '>':
161 continue;
163 if (offset >= size)
164 return size;
165 buf[offset++] = c;
167 return offset;
170 static const char au_env[] = "GIT_AUTHOR_NAME";
171 static const char co_env[] = "GIT_COMMITTER_NAME";
172 static const char *env_hint =
173 "\n"
174 "*** Your name cannot be determined from your system services (gecos).\n"
175 "\n"
176 "Run\n"
177 "\n"
178 " git config --global user.email \"you@example.com\"\n"
179 " git config --global user.name \"Your Name\"\n"
180 "\n"
181 "to set your account\'s default identity.\n"
182 "Omit --global to set the identity only in this repository.\n"
183 "\n";
185 const char *fmt_ident(const char *name, const char *email,
186 const char *date_str, int flag)
188 static char buffer[1000];
189 char date[50];
190 int i;
191 int error_on_no_name = (flag & IDENT_ERROR_ON_NO_NAME);
192 int warn_on_no_name = (flag & IDENT_WARN_ON_NO_NAME);
193 int name_addr_only = (flag & IDENT_NO_DATE);
195 setup_ident();
196 if (!name)
197 name = git_default_name;
198 if (!email)
199 email = git_default_email;
201 if (!*name) {
202 struct passwd *pw;
204 if ((warn_on_no_name || error_on_no_name) &&
205 name == git_default_name && env_hint) {
206 fprintf(stderr, env_hint, au_env, co_env);
207 env_hint = NULL; /* warn only once, for "git-var -l" */
209 if (error_on_no_name)
210 die("empty ident %s <%s> not allowed", name, email);
211 pw = getpwuid(getuid());
212 if (!pw)
213 die("You don't exist. Go away!");
214 strlcpy(git_default_name, pw->pw_name,
215 sizeof(git_default_name));
216 name = git_default_name;
219 strcpy(date, git_default_date);
220 if (!name_addr_only && date_str)
221 parse_date(date_str, date, sizeof(date));
223 i = copy(buffer, sizeof(buffer), 0, name);
224 i = add_raw(buffer, sizeof(buffer), i, " <");
225 i = copy(buffer, sizeof(buffer), i, email);
226 if (!name_addr_only) {
227 i = add_raw(buffer, sizeof(buffer), i, "> ");
228 i = copy(buffer, sizeof(buffer), i, date);
229 } else {
230 i = add_raw(buffer, sizeof(buffer), i, ">");
232 if (i >= sizeof(buffer))
233 die("Impossibly long personal identifier");
234 buffer[i] = 0;
235 return buffer;
238 const char *fmt_name(const char *name, const char *email)
240 return fmt_ident(name, email, NULL, IDENT_ERROR_ON_NO_NAME | IDENT_NO_DATE);
243 const char *git_author_info(int flag)
245 return fmt_ident(getenv("GIT_AUTHOR_NAME"),
246 getenv("GIT_AUTHOR_EMAIL"),
247 getenv("GIT_AUTHOR_DATE"),
248 flag);
251 const char *git_committer_info(int flag)
253 return fmt_ident(getenv("GIT_COMMITTER_NAME"),
254 getenv("GIT_COMMITTER_EMAIL"),
255 getenv("GIT_COMMITTER_DATE"),
256 flag);