Documentation/describe: improve one-line summary
[git.git] / ident.c
blob5ff1aadaaaa999df3bfecb07f84f259469b3a54d
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 struct strbuf git_default_name = STRBUF_INIT;
11 static struct strbuf git_default_email = STRBUF_INIT;
12 static struct strbuf git_default_date = STRBUF_INIT;
14 #define IDENT_NAME_GIVEN 01
15 #define IDENT_MAIL_GIVEN 02
16 #define IDENT_ALL_GIVEN (IDENT_NAME_GIVEN|IDENT_MAIL_GIVEN)
17 static int committer_ident_explicitly_given;
18 static int author_ident_explicitly_given;
20 #ifdef NO_GECOS_IN_PWENT
21 #define get_gecos(ignored) "&"
22 #else
23 #define get_gecos(struct_passwd) ((struct_passwd)->pw_gecos)
24 #endif
26 static void copy_gecos(const struct passwd *w, struct strbuf *name)
28 char *src;
30 /* Traditionally GECOS field had office phone numbers etc, separated
31 * with commas. Also & stands for capitalized form of the login name.
34 for (src = get_gecos(w); *src && *src != ','; src++) {
35 int ch = *src;
36 if (ch != '&')
37 strbuf_addch(name, ch);
38 else {
39 /* Sorry, Mr. McDonald... */
40 strbuf_addch(name, toupper(*w->pw_name));
41 strbuf_addstr(name, w->pw_name + 1);
46 static int add_mailname_host(struct strbuf *buf)
48 FILE *mailname;
49 struct strbuf mailnamebuf = STRBUF_INIT;
51 mailname = fopen("/etc/mailname", "r");
52 if (!mailname) {
53 if (errno != ENOENT)
54 warning("cannot open /etc/mailname: %s",
55 strerror(errno));
56 return -1;
58 if (strbuf_getline(&mailnamebuf, mailname, '\n') == EOF) {
59 if (ferror(mailname))
60 warning("cannot read /etc/mailname: %s",
61 strerror(errno));
62 strbuf_release(&mailnamebuf);
63 fclose(mailname);
64 return -1;
66 /* success! */
67 strbuf_addbuf(buf, &mailnamebuf);
68 strbuf_release(&mailnamebuf);
69 fclose(mailname);
70 return 0;
73 static void add_domainname(struct strbuf *out)
75 char buf[1024];
76 struct hostent *he;
78 if (gethostname(buf, sizeof(buf))) {
79 warning("cannot get host name: %s", strerror(errno));
80 strbuf_addstr(out, "(none)");
81 return;
83 if (strchr(buf, '.'))
84 strbuf_addstr(out, buf);
85 else if ((he = gethostbyname(buf)) && strchr(he->h_name, '.'))
86 strbuf_addstr(out, he->h_name);
87 else
88 strbuf_addf(out, "%s.(none)", buf);
91 static void copy_email(const struct passwd *pw, struct strbuf *email)
94 * Make up a fake email address
95 * (name + '@' + hostname [+ '.' + domainname])
97 strbuf_addstr(email, pw->pw_name);
98 strbuf_addch(email, '@');
100 if (!add_mailname_host(email))
101 return; /* read from "/etc/mailname" (Debian) */
102 add_domainname(email);
105 const char *ident_default_name(void)
107 if (!git_default_name.len) {
108 copy_gecos(xgetpwuid_self(), &git_default_name);
109 strbuf_trim(&git_default_name);
111 return git_default_name.buf;
114 const char *ident_default_email(void)
116 if (!git_default_email.len) {
117 const char *email = getenv("EMAIL");
119 if (email && email[0]) {
120 strbuf_addstr(&git_default_email, email);
121 committer_ident_explicitly_given |= IDENT_MAIL_GIVEN;
122 author_ident_explicitly_given |= IDENT_MAIL_GIVEN;
123 } else
124 copy_email(xgetpwuid_self(), &git_default_email);
125 strbuf_trim(&git_default_email);
127 return git_default_email.buf;
130 static const char *ident_default_date(void)
132 if (!git_default_date.len)
133 datestamp(&git_default_date);
134 return git_default_date.buf;
137 static int crud(unsigned char c)
139 return c <= 32 ||
140 c == '.' ||
141 c == ',' ||
142 c == ':' ||
143 c == ';' ||
144 c == '<' ||
145 c == '>' ||
146 c == '"' ||
147 c == '\\' ||
148 c == '\'';
152 * Copy over a string to the destination, but avoid special
153 * characters ('\n', '<' and '>') and remove crud at the end
155 static void strbuf_addstr_without_crud(struct strbuf *sb, const char *src)
157 size_t i, len;
158 unsigned char c;
160 /* Remove crud from the beginning.. */
161 while ((c = *src) != 0) {
162 if (!crud(c))
163 break;
164 src++;
167 /* Remove crud from the end.. */
168 len = strlen(src);
169 while (len > 0) {
170 c = src[len-1];
171 if (!crud(c))
172 break;
173 --len;
177 * Copy the rest to the buffer, but avoid the special
178 * characters '\n' '<' and '>' that act as delimiters on
179 * an identification line. We can only remove crud, never add it,
180 * so 'len' is our maximum.
182 strbuf_grow(sb, len);
183 for (i = 0; i < len; i++) {
184 c = *src++;
185 switch (c) {
186 case '\n': case '<': case '>':
187 continue;
189 sb->buf[sb->len++] = c;
191 sb->buf[sb->len] = '\0';
195 * Reverse of fmt_ident(); given an ident line, split the fields
196 * to allow the caller to parse it.
197 * Signal a success by returning 0, but date/tz fields of the result
198 * can still be NULL if the input line only has the name/email part
199 * (e.g. reading from a reflog entry).
201 int split_ident_line(struct ident_split *split, const char *line, int len)
203 const char *cp;
204 size_t span;
205 int status = -1;
207 memset(split, 0, sizeof(*split));
209 split->name_begin = line;
210 for (cp = line; *cp && cp < line + len; cp++)
211 if (*cp == '<') {
212 split->mail_begin = cp + 1;
213 break;
215 if (!split->mail_begin)
216 return status;
218 for (cp = split->mail_begin - 2; line <= cp; cp--)
219 if (!isspace(*cp)) {
220 split->name_end = cp + 1;
221 break;
223 if (!split->name_end) {
224 /* no human readable name */
225 split->name_end = split->name_begin;
228 for (cp = split->mail_begin; cp < line + len; cp++)
229 if (*cp == '>') {
230 split->mail_end = cp;
231 break;
233 if (!split->mail_end)
234 return status;
237 * Look from the end-of-line to find the trailing ">" of the mail
238 * address, even though we should already know it as split->mail_end.
239 * This can help in cases of broken idents with an extra ">" somewhere
240 * in the email address. Note that we are assuming the timestamp will
241 * never have a ">" in it.
243 * Note that we will always find some ">" before going off the front of
244 * the string, because will always hit the split->mail_end closing
245 * bracket.
247 for (cp = line + len - 1; *cp != '>'; cp--)
250 for (cp = cp + 1; cp < line + len && isspace(*cp); cp++)
252 if (line + len <= cp)
253 goto person_only;
254 split->date_begin = cp;
255 span = strspn(cp, "0123456789");
256 if (!span)
257 goto person_only;
258 split->date_end = split->date_begin + span;
259 for (cp = split->date_end; cp < line + len && isspace(*cp); cp++)
261 if (line + len <= cp || (*cp != '+' && *cp != '-'))
262 goto person_only;
263 split->tz_begin = cp;
264 span = strspn(cp + 1, "0123456789");
265 if (!span)
266 goto person_only;
267 split->tz_end = split->tz_begin + 1 + span;
268 return 0;
270 person_only:
271 split->date_begin = NULL;
272 split->date_end = NULL;
273 split->tz_begin = NULL;
274 split->tz_end = NULL;
275 return 0;
278 static const char *env_hint =
279 "\n"
280 "*** Please tell me who you are.\n"
281 "\n"
282 "Run\n"
283 "\n"
284 " git config --global user.email \"you@example.com\"\n"
285 " git config --global user.name \"Your Name\"\n"
286 "\n"
287 "to set your account\'s default identity.\n"
288 "Omit --global to set the identity only in this repository.\n"
289 "\n";
291 const char *fmt_ident(const char *name, const char *email,
292 const char *date_str, int flag)
294 static struct strbuf ident = STRBUF_INIT;
295 int strict = (flag & IDENT_STRICT);
296 int want_date = !(flag & IDENT_NO_DATE);
297 int want_name = !(flag & IDENT_NO_NAME);
299 if (want_name && !name)
300 name = ident_default_name();
301 if (!email)
302 email = ident_default_email();
304 if (want_name && !*name) {
305 struct passwd *pw;
307 if (strict) {
308 if (name == git_default_name.buf)
309 fputs(env_hint, stderr);
310 die("empty ident name (for <%s>) not allowed", email);
312 pw = xgetpwuid_self();
313 name = pw->pw_name;
316 if (strict && email == git_default_email.buf &&
317 strstr(email, "(none)")) {
318 fputs(env_hint, stderr);
319 die("unable to auto-detect email address (got '%s')", email);
322 strbuf_reset(&ident);
323 if (want_name) {
324 strbuf_addstr_without_crud(&ident, name);
325 strbuf_addstr(&ident, " <");
327 strbuf_addstr_without_crud(&ident, email);
328 if (want_name)
329 strbuf_addch(&ident, '>');
330 if (want_date) {
331 strbuf_addch(&ident, ' ');
332 if (date_str && date_str[0]) {
333 if (parse_date(date_str, &ident) < 0)
334 die("invalid date format: %s", date_str);
336 else
337 strbuf_addstr(&ident, ident_default_date());
340 return ident.buf;
343 const char *fmt_name(const char *name, const char *email)
345 return fmt_ident(name, email, NULL, IDENT_STRICT | IDENT_NO_DATE);
348 const char *git_author_info(int flag)
350 if (getenv("GIT_AUTHOR_NAME"))
351 author_ident_explicitly_given |= IDENT_NAME_GIVEN;
352 if (getenv("GIT_AUTHOR_EMAIL"))
353 author_ident_explicitly_given |= IDENT_MAIL_GIVEN;
354 return fmt_ident(getenv("GIT_AUTHOR_NAME"),
355 getenv("GIT_AUTHOR_EMAIL"),
356 getenv("GIT_AUTHOR_DATE"),
357 flag);
360 const char *git_committer_info(int flag)
362 if (getenv("GIT_COMMITTER_NAME"))
363 committer_ident_explicitly_given |= IDENT_NAME_GIVEN;
364 if (getenv("GIT_COMMITTER_EMAIL"))
365 committer_ident_explicitly_given |= IDENT_MAIL_GIVEN;
366 return fmt_ident(getenv("GIT_COMMITTER_NAME"),
367 getenv("GIT_COMMITTER_EMAIL"),
368 getenv("GIT_COMMITTER_DATE"),
369 flag);
372 static int ident_is_sufficient(int user_ident_explicitly_given)
374 #ifndef WINDOWS
375 return (user_ident_explicitly_given & IDENT_MAIL_GIVEN);
376 #else
377 return (user_ident_explicitly_given == IDENT_ALL_GIVEN);
378 #endif
381 int committer_ident_sufficiently_given(void)
383 return ident_is_sufficient(committer_ident_explicitly_given);
386 int author_ident_sufficiently_given(void)
388 return ident_is_sufficient(author_ident_explicitly_given);
391 int git_ident_config(const char *var, const char *value, void *data)
393 if (!strcmp(var, "user.name")) {
394 if (!value)
395 return config_error_nonbool(var);
396 strbuf_reset(&git_default_name);
397 strbuf_addstr(&git_default_name, value);
398 committer_ident_explicitly_given |= IDENT_NAME_GIVEN;
399 author_ident_explicitly_given |= IDENT_NAME_GIVEN;
400 return 0;
403 if (!strcmp(var, "user.email")) {
404 if (!value)
405 return config_error_nonbool(var);
406 strbuf_reset(&git_default_email);
407 strbuf_addstr(&git_default_email, value);
408 committer_ident_explicitly_given |= IDENT_MAIL_GIVEN;
409 author_ident_explicitly_given |= IDENT_MAIL_GIVEN;
410 return 0;
413 return 0;
416 static int buf_cmp(const char *a_begin, const char *a_end,
417 const char *b_begin, const char *b_end)
419 int a_len = a_end - a_begin;
420 int b_len = b_end - b_begin;
421 int min = a_len < b_len ? a_len : b_len;
422 int cmp;
424 cmp = memcmp(a_begin, b_begin, min);
425 if (cmp)
426 return cmp;
428 return a_len - b_len;
431 int ident_cmp(const struct ident_split *a,
432 const struct ident_split *b)
434 int cmp;
436 cmp = buf_cmp(a->mail_begin, a->mail_end,
437 b->mail_begin, b->mail_end);
438 if (cmp)
439 return cmp;
441 return buf_cmp(a->name_begin, a->name_end,
442 b->name_begin, b->name_end);