?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
docs: adjust for the recent rename of `pu` to `seen`
[git/debian.git] / ident.c
blobe666ee4e598eb7de70b524bd56c7d04a27549971
1 /*
2 * ident.c
3 *
4 * create git identifier lines of the form "name <email> date"
5 *
6 * Copyright (C) 2005 Linus Torvalds
7 */
8 #include "cache.h"
9 #include "config.h"
10
11 static struct strbuf git_default_name = STRBUF_INIT;
12 static struct strbuf git_default_email = STRBUF_INIT;
13 static struct strbuf git_default_date = STRBUF_INIT;
14 static struct strbuf git_author_name = STRBUF_INIT;
15 static struct strbuf git_author_email = STRBUF_INIT;
16 static struct strbuf git_committer_name = STRBUF_INIT;
17 static struct strbuf git_committer_email = STRBUF_INIT;
18 static int default_email_is_bogus;
19 static int default_name_is_bogus;
20
21 static int ident_use_config_only;
22
23 #define IDENT_NAME_GIVEN 01
24 #define IDENT_MAIL_GIVEN 02
25 #define IDENT_ALL_GIVEN (IDENT_NAME_GIVEN|IDENT_MAIL_GIVEN)
26 static int committer_ident_explicitly_given;
27 static int author_ident_explicitly_given;
28 static int ident_config_given;
29
30 #ifdef NO_GECOS_IN_PWENT
31 #define get_gecos(ignored) "&"
32 #else
33 #define get_gecos(struct_passwd) ((struct_passwd)->pw_gecos)
34 #endif
35
36 static struct passwd *xgetpwuid_self(int *is_bogus)
37 {
38 struct passwd *pw;
39
40 errno = 0;
41 pw = getpwuid(getuid());
42 if (!pw) {
43 static struct passwd fallback;
44 fallback.pw_name = "unknown";
45 #ifndef NO_GECOS_IN_PWENT
46 fallback.pw_gecos = "Unknown";
47 #endif
48 pw = &fallback;
49 if (is_bogus)
50 *is_bogus = 1;
51 }
52 return pw;
53 }
54
55 static void copy_gecos(const struct passwd *w, struct strbuf *name)
56 {
57 char *src;
58
59 /* Traditionally GECOS field had office phone numbers etc, separated
60 * with commas. Also & stands for capitalized form of the login name.
61 */
62
63 for (src = get_gecos(w); *src && *src != ','; src++) {
64 int ch = *src;
65 if (ch != '&')
66 strbuf_addch(name, ch);
67 else {
68 /* Sorry, Mr. McDonald... */
69 strbuf_addch(name, toupper(*w->pw_name));
70 strbuf_addstr(name, w->pw_name + 1);
71 }
72 }
73 }
74
75 static int add_mailname_host(struct strbuf *buf)
76 {
77 FILE *mailname;
78 struct strbuf mailnamebuf = STRBUF_INIT;
79
80 mailname = fopen_or_warn("/etc/mailname", "r");
81 if (!mailname)
82 return -1;
83
84 if (strbuf_getline(&mailnamebuf, mailname) == EOF) {
85 if (ferror(mailname))
86 warning_errno("cannot read /etc/mailname");
87 strbuf_release(&mailnamebuf);
88 fclose(mailname);
89 return -1;
90 }
91 /* success! */
92 strbuf_addbuf(buf, &mailnamebuf);
93 strbuf_release(&mailnamebuf);
94 fclose(mailname);
95 return 0;
96 }
97
98 static int canonical_name(const char *host, struct strbuf *out)
99 {
100 int status = -1;
101
102 #ifndef NO_IPV6
103 struct addrinfo hints, *ai;
104 memset (&hints, '\0', sizeof (hints));
105 hints.ai_flags = AI_CANONNAME;
106 if (!getaddrinfo(host, NULL, &hints, &ai)) {
107 if (ai && ai->ai_canonname && strchr(ai->ai_canonname, '.')) {
108 strbuf_addstr(out, ai->ai_canonname);
109 status = 0;
110 }
111 freeaddrinfo(ai);
112 }
113 #else
114 struct hostent *he = gethostbyname(host);
115 if (he && strchr(he->h_name, '.')) {
116 strbuf_addstr(out, he->h_name);
117 status = 0;
118 }
119 #endif /* NO_IPV6 */
120
121 return status;
122 }
123
124 static void add_domainname(struct strbuf *out, int *is_bogus)
125 {
126 char buf[HOST_NAME_MAX + 1];
127
128 if (xgethostname(buf, sizeof(buf))) {
129 warning_errno("cannot get host name");
130 strbuf_addstr(out, "(none)");
131 *is_bogus = 1;
132 return;
133 }
134 if (strchr(buf, '.'))
135 strbuf_addstr(out, buf);
136 else if (canonical_name(buf, out) < 0) {
137 strbuf_addf(out, "%s.(none)", buf);
138 *is_bogus = 1;
139 }
140 }
141
142 static void copy_email(const struct passwd *pw, struct strbuf *email,
143 int *is_bogus)
144 {
145 /*
146 * Make up a fake email address
147 * (name + '@' + hostname [+ '.' + domainname])
148 */
149 strbuf_addstr(email, pw->pw_name);
150 strbuf_addch(email, '@');
151
152 if (!add_mailname_host(email))
153 return; /* read from "/etc/mailname" (Debian) */
154 add_domainname(email, is_bogus);
155 }
156
157 const char *ident_default_name(void)
158 {
159 if (!(ident_config_given & IDENT_NAME_GIVEN) && !git_default_name.len) {
160 copy_gecos(xgetpwuid_self(&default_name_is_bogus), &git_default_name);
161 strbuf_trim(&git_default_name);
162 }
163 return git_default_name.buf;
164 }
165
166 const char *ident_default_email(void)
167 {
168 if (!(ident_config_given & IDENT_MAIL_GIVEN) && !git_default_email.len) {
169 const char *email = getenv("EMAIL");
170
171 if (email && email[0]) {
172 strbuf_addstr(&git_default_email, email);
173 committer_ident_explicitly_given |= IDENT_MAIL_GIVEN;
174 author_ident_explicitly_given |= IDENT_MAIL_GIVEN;
175 } else if ((email = query_user_email()) && email[0]) {
176 strbuf_addstr(&git_default_email, email);
177 free((char *)email);
178 } else
179 copy_email(xgetpwuid_self(&default_email_is_bogus),
180 &git_default_email, &default_email_is_bogus);
181 strbuf_trim(&git_default_email);
182 }
183 return git_default_email.buf;
184 }
185
186 static const char *ident_default_date(void)
187 {
188 if (!git_default_date.len)
189 datestamp(&git_default_date);
190 return git_default_date.buf;
191 }
192
193 void reset_ident_date(void)
194 {
195 strbuf_reset(&git_default_date);
196 }
197
198 static int crud(unsigned char c)
199 {
200 return c <= 32 ||
201 c == '.' ||
202 c == ',' ||
203 c == ':' ||
204 c == ';' ||
205 c == '<' ||
206 c == '>' ||
207 c == '"' ||
208 c == '\\' ||
209 c == '\'';
210 }
211
212 static int has_non_crud(const char *str)
213 {
214 for (; *str; str++) {
215 if (!crud(*str))
216 return 1;
217 }
218 return 0;
219 }
220
221 /*
222 * Copy over a string to the destination, but avoid special
223 * characters ('\n', '<' and '>') and remove crud at the end
224 */
225 static void strbuf_addstr_without_crud(struct strbuf *sb, const char *src)
226 {
227 size_t i, len;
228 unsigned char c;
229
230 /* Remove crud from the beginning.. */
231 while ((c = *src) != 0) {
232 if (!crud(c))
233 break;
234 src++;
235 }
236
237 /* Remove crud from the end.. */
238 len = strlen(src);
239 while (len > 0) {
240 c = src[len-1];
241 if (!crud(c))
242 break;
243 --len;
244 }
245
246 /*
247 * Copy the rest to the buffer, but avoid the special
248 * characters '\n' '<' and '>' that act as delimiters on
249 * an identification line. We can only remove crud, never add it,
250 * so 'len' is our maximum.
251 */
252 strbuf_grow(sb, len);
253 for (i = 0; i < len; i++) {
254 c = *src++;
255 switch (c) {
256 case '\n': case '<': case '>':
257 continue;
258 }
259 sb->buf[sb->len++] = c;
260 }
261 sb->buf[sb->len] = '\0';
262 }
263
264 /*
265 * Reverse of fmt_ident(); given an ident line, split the fields
266 * to allow the caller to parse it.
267 * Signal a success by returning 0, but date/tz fields of the result
268 * can still be NULL if the input line only has the name/email part
269 * (e.g. reading from a reflog entry).
270 */
271 int split_ident_line(struct ident_split *split, const char *line, int len)
272 {
273 const char *cp;
274 size_t span;
275 int status = -1;
276
277 memset(split, 0, sizeof(*split));
278
279 split->name_begin = line;
280 for (cp = line; *cp && cp < line + len; cp++)
281 if (*cp == '<') {
282 split->mail_begin = cp + 1;
283 break;
284 }
285 if (!split->mail_begin)
286 return status;
287
288 for (cp = split->mail_begin - 2; line <= cp; cp--)
289 if (!isspace(*cp)) {
290 split->name_end = cp + 1;
291 break;
292 }
293 if (!split->name_end) {
294 /* no human readable name */
295 split->name_end = split->name_begin;
296 }
297
298 for (cp = split->mail_begin; cp < line + len; cp++)
299 if (*cp == '>') {
300 split->mail_end = cp;
301 break;
302 }
303 if (!split->mail_end)
304 return status;
305
306 /*
307 * Look from the end-of-line to find the trailing ">" of the mail
308 * address, even though we should already know it as split->mail_end.
309 * This can help in cases of broken idents with an extra ">" somewhere
310 * in the email address. Note that we are assuming the timestamp will
311 * never have a ">" in it.
312 *
313 * Note that we will always find some ">" before going off the front of
314 * the string, because will always hit the split->mail_end closing
315 * bracket.
316 */
317 for (cp = line + len - 1; *cp != '>'; cp--)
318 ;
319
320 for (cp = cp + 1; cp < line + len && isspace(*cp); cp++)
321 ;
322 if (line + len <= cp)
323 goto person_only;
324 split->date_begin = cp;
325 span = strspn(cp, "0123456789");
326 if (!span)
327 goto person_only;
328 split->date_end = split->date_begin + span;
329 for (cp = split->date_end; cp < line + len && isspace(*cp); cp++)
330 ;
331 if (line + len <= cp || (*cp != '+' && *cp != '-'))
332 goto person_only;
333 split->tz_begin = cp;
334 span = strspn(cp + 1, "0123456789");
335 if (!span)
336 goto person_only;
337 split->tz_end = split->tz_begin + 1 + span;
338 return 0;
339
340 person_only:
341 split->date_begin = NULL;
342 split->date_end = NULL;
343 split->tz_begin = NULL;
344 split->tz_end = NULL;
345 return 0;
346 }
347
348 static const char *env_hint =
349 N_("\n"
350 "*** Please tell me who you are.\n"
351 "\n"
352 "Run\n"
353 "\n"
354 " git config --global user.email \"you@example.com\"\n"
355 " git config --global user.name \"Your Name\"\n"
356 "\n"
357 "to set your account\'s default identity.\n"
358 "Omit --global to set the identity only in this repository.\n"
359 "\n");
360
361 const char *fmt_ident(const char *name, const char *email,
362 enum want_ident whose_ident, const char *date_str, int flag)
363 {
364 static struct strbuf ident = STRBUF_INIT;
365 int strict = (flag & IDENT_STRICT);
366 int want_date = !(flag & IDENT_NO_DATE);
367 int want_name = !(flag & IDENT_NO_NAME);
368
369 if (!email) {
370 if (whose_ident == WANT_AUTHOR_IDENT && git_author_email.len)
371 email = git_author_email.buf;
372 else if (whose_ident == WANT_COMMITTER_IDENT && git_committer_email.len)
373 email = git_committer_email.buf;
374 }
375 if (!email) {
376 if (strict && ident_use_config_only
377 && !(ident_config_given & IDENT_MAIL_GIVEN)) {
378 fputs(_(env_hint), stderr);
379 die(_("no email was given and auto-detection is disabled"));
380 }
381 email = ident_default_email();
382 if (strict && default_email_is_bogus) {
383 fputs(_(env_hint), stderr);
384 die(_("unable to auto-detect email address (got '%s')"), email);
385 }
386 }
387
388 if (want_name) {
389 int using_default = 0;
390 if (!name) {
391 if (whose_ident == WANT_AUTHOR_IDENT && git_author_name.len)
392 name = git_author_name.buf;
393 else if (whose_ident == WANT_COMMITTER_IDENT &&
394 git_committer_name.len)
395 name = git_committer_name.buf;
396 }
397 if (!name) {
398 if (strict && ident_use_config_only
399 && !(ident_config_given & IDENT_NAME_GIVEN)) {
400 fputs(_(env_hint), stderr);
401 die(_("no name was given and auto-detection is disabled"));
402 }
403 name = ident_default_name();
404 using_default = 1;
405 if (strict && default_name_is_bogus) {
406 fputs(_(env_hint), stderr);
407 die(_("unable to auto-detect name (got '%s')"), name);
408 }
409 }
410 if (!*name) {
411 struct passwd *pw;
412 if (strict) {
413 if (using_default)
414 fputs(_(env_hint), stderr);
415 die(_("empty ident name (for <%s>) not allowed"), email);
416 }
417 pw = xgetpwuid_self(NULL);
418 name = pw->pw_name;
419 }
420 if (strict && !has_non_crud(name))
421 die(_("name consists only of disallowed characters: %s"), name);
422 }
423
424 strbuf_reset(&ident);
425 if (want_name) {
426 strbuf_addstr_without_crud(&ident, name);
427 strbuf_addstr(&ident, " <");
428 }
429 strbuf_addstr_without_crud(&ident, email);
430 if (want_name)
431 strbuf_addch(&ident, '>');
432 if (want_date) {
433 strbuf_addch(&ident, ' ');
434 if (date_str && date_str[0]) {
435 if (parse_date(date_str, &ident) < 0)
436 die(_("invalid date format: %s"), date_str);
437 }
438 else
439 strbuf_addstr(&ident, ident_default_date());
440 }
441
442 return ident.buf;
443 }
444
445 const char *fmt_name(enum want_ident whose_ident)
446 {
447 char *name = NULL;
448 char *email = NULL;
449
450 switch (whose_ident) {
451 case WANT_BLANK_IDENT:
452 break;
453 case WANT_AUTHOR_IDENT:
454 name = getenv("GIT_AUTHOR_NAME");
455 email = getenv("GIT_AUTHOR_EMAIL");
456 break;
457 case WANT_COMMITTER_IDENT:
458 name = getenv("GIT_COMMITTER_NAME");
459 email = getenv("GIT_COMMITTER_EMAIL");
460 break;
461 }
462 return fmt_ident(name, email, whose_ident, NULL,
463 IDENT_STRICT | IDENT_NO_DATE);
464 }
465
466 const char *git_author_info(int flag)
467 {
468 if (getenv("GIT_AUTHOR_NAME"))
469 author_ident_explicitly_given |= IDENT_NAME_GIVEN;
470 if (getenv("GIT_AUTHOR_EMAIL"))
471 author_ident_explicitly_given |= IDENT_MAIL_GIVEN;
472 return fmt_ident(getenv("GIT_AUTHOR_NAME"),
473 getenv("GIT_AUTHOR_EMAIL"),
474 WANT_AUTHOR_IDENT,
475 getenv("GIT_AUTHOR_DATE"),
476 flag);
477 }
478
479 const char *git_committer_info(int flag)
480 {
481 if (getenv("GIT_COMMITTER_NAME"))
482 committer_ident_explicitly_given |= IDENT_NAME_GIVEN;
483 if (getenv("GIT_COMMITTER_EMAIL"))
484 committer_ident_explicitly_given |= IDENT_MAIL_GIVEN;
485 return fmt_ident(getenv("GIT_COMMITTER_NAME"),
486 getenv("GIT_COMMITTER_EMAIL"),
487 WANT_COMMITTER_IDENT,
488 getenv("GIT_COMMITTER_DATE"),
489 flag);
490 }
491
492 static int ident_is_sufficient(int user_ident_explicitly_given)
493 {
494 #ifndef WINDOWS
495 return (user_ident_explicitly_given & IDENT_MAIL_GIVEN);
496 #else
497 return (user_ident_explicitly_given == IDENT_ALL_GIVEN);
498 #endif
499 }
500
501 int committer_ident_sufficiently_given(void)
502 {
503 return ident_is_sufficient(committer_ident_explicitly_given);
504 }
505
506 int author_ident_sufficiently_given(void)
507 {
508 return ident_is_sufficient(author_ident_explicitly_given);
509 }
510
511 static int set_ident(const char *var, const char *value)
512 {
513 if (!strcmp(var, "author.name")) {
514 if (!value)
515 return config_error_nonbool(var);
516 strbuf_reset(&git_author_name);
517 strbuf_addstr(&git_author_name, value);
518 author_ident_explicitly_given |= IDENT_NAME_GIVEN;
519 ident_config_given |= IDENT_NAME_GIVEN;
520 return 0;
521 }
522
523 if (!strcmp(var, "author.email")) {
524 if (!value)
525 return config_error_nonbool(var);
526 strbuf_reset(&git_author_email);
527 strbuf_addstr(&git_author_email, value);
528 author_ident_explicitly_given |= IDENT_MAIL_GIVEN;
529 ident_config_given |= IDENT_MAIL_GIVEN;
530 return 0;
531 }
532
533 if (!strcmp(var, "committer.name")) {
534 if (!value)
535 return config_error_nonbool(var);
536 strbuf_reset(&git_committer_name);
537 strbuf_addstr(&git_committer_name, value);
538 committer_ident_explicitly_given |= IDENT_NAME_GIVEN;
539 ident_config_given |= IDENT_NAME_GIVEN;
540 return 0;
541 }
542
543 if (!strcmp(var, "committer.email")) {
544 if (!value)
545 return config_error_nonbool(var);
546 strbuf_reset(&git_committer_email);
547 strbuf_addstr(&git_committer_email, value);
548 committer_ident_explicitly_given |= IDENT_MAIL_GIVEN;
549 ident_config_given |= IDENT_MAIL_GIVEN;
550 return 0;
551 }
552
553 if (!strcmp(var, "user.name")) {
554 if (!value)
555 return config_error_nonbool(var);
556 strbuf_reset(&git_default_name);
557 strbuf_addstr(&git_default_name, value);
558 committer_ident_explicitly_given |= IDENT_NAME_GIVEN;
559 author_ident_explicitly_given |= IDENT_NAME_GIVEN;
560 ident_config_given |= IDENT_NAME_GIVEN;
561 return 0;
562 }
563
564 if (!strcmp(var, "user.email")) {
565 if (!value)
566 return config_error_nonbool(var);
567 strbuf_reset(&git_default_email);
568 strbuf_addstr(&git_default_email, value);
569 committer_ident_explicitly_given |= IDENT_MAIL_GIVEN;
570 author_ident_explicitly_given |= IDENT_MAIL_GIVEN;
571 ident_config_given |= IDENT_MAIL_GIVEN;
572 return 0;
573 }
574
575 return 0;
576 }
577
578 int git_ident_config(const char *var, const char *value, void *data)
579 {
580 if (!strcmp(var, "user.useconfigonly")) {
581 ident_use_config_only = git_config_bool(var, value);
582 return 0;
583 }
584
585 return set_ident(var, value);
586 }
587
588 static void set_env_if(const char *key, const char *value, int *given, int bit)
589 {
590 if ((*given & bit) || getenv(key))
591 return; /* nothing to do */
592 setenv(key, value, 0);
593 *given |= bit;
594 }
595
596 void prepare_fallback_ident(const char *name, const char *email)
597 {
598 set_env_if("GIT_AUTHOR_NAME", name,
599 &author_ident_explicitly_given, IDENT_NAME_GIVEN);
600 set_env_if("GIT_AUTHOR_EMAIL", email,
601 &author_ident_explicitly_given, IDENT_MAIL_GIVEN);
602 set_env_if("GIT_COMMITTER_NAME", name,
603 &committer_ident_explicitly_given, IDENT_NAME_GIVEN);
604 set_env_if("GIT_COMMITTER_EMAIL", email,
605 &committer_ident_explicitly_given, IDENT_MAIL_GIVEN);
606 }
607
608 static int buf_cmp(const char *a_begin, const char *a_end,
609 const char *b_begin, const char *b_end)
610 {
611 int a_len = a_end - a_begin;
612 int b_len = b_end - b_begin;
613 int min = a_len < b_len ? a_len : b_len;
614 int cmp;
615
616 cmp = memcmp(a_begin, b_begin, min);
617 if (cmp)
618 return cmp;
619
620 return a_len - b_len;
621 }
622
623 int ident_cmp(const struct ident_split *a,
624 const struct ident_split *b)
625 {
626 int cmp;
627
628 cmp = buf_cmp(a->mail_begin, a->mail_end,
629 b->mail_begin, b->mail_end);
630 if (cmp)
631 return cmp;
632
633 return buf_cmp(a->name_begin, a->name_end,
634 b->name_begin, b->name_end);
635 }
git for Debian