4 * create git identifier lines of the form "name <email> date"
6 * Copyright (C) 2005 Linus Torvalds
8 #include "git-compat-util.h"
16 static struct strbuf git_default_name
= STRBUF_INIT
;
17 static struct strbuf git_default_email
= STRBUF_INIT
;
18 static struct strbuf git_default_date
= STRBUF_INIT
;
19 static struct strbuf git_author_name
= STRBUF_INIT
;
20 static struct strbuf git_author_email
= STRBUF_INIT
;
21 static struct strbuf git_committer_name
= STRBUF_INIT
;
22 static struct strbuf git_committer_email
= STRBUF_INIT
;
23 static int default_email_is_bogus
;
24 static int default_name_is_bogus
;
26 static int ident_use_config_only
;
28 #define IDENT_NAME_GIVEN 01
29 #define IDENT_MAIL_GIVEN 02
30 #define IDENT_ALL_GIVEN (IDENT_NAME_GIVEN|IDENT_MAIL_GIVEN)
31 static int committer_ident_explicitly_given
;
32 static int author_ident_explicitly_given
;
33 static int ident_config_given
;
35 #ifdef NO_GECOS_IN_PWENT
36 #define get_gecos(ignored) "&"
38 #define get_gecos(struct_passwd) ((struct_passwd)->pw_gecos)
41 static struct passwd
*xgetpwuid_self(int *is_bogus
)
46 pw
= getpwuid(getuid());
48 static struct passwd fallback
;
49 fallback
.pw_name
= "unknown";
50 #ifndef NO_GECOS_IN_PWENT
51 fallback
.pw_gecos
= "Unknown";
60 static void copy_gecos(const struct passwd
*w
, struct strbuf
*name
)
64 /* Traditionally GECOS field had office phone numbers etc, separated
65 * with commas. Also & stands for capitalized form of the login name.
68 for (src
= get_gecos(w
); *src
&& *src
!= ','; src
++) {
71 strbuf_addch(name
, ch
);
73 /* Sorry, Mr. McDonald... */
74 strbuf_addch(name
, toupper(*w
->pw_name
));
75 strbuf_addstr(name
, w
->pw_name
+ 1);
80 static int add_mailname_host(struct strbuf
*buf
)
83 struct strbuf mailnamebuf
= STRBUF_INIT
;
85 mailname
= fopen_or_warn("/etc/mailname", "r");
89 if (strbuf_getline(&mailnamebuf
, mailname
) == EOF
) {
91 warning_errno("cannot read /etc/mailname");
92 strbuf_release(&mailnamebuf
);
97 strbuf_addbuf(buf
, &mailnamebuf
);
98 strbuf_release(&mailnamebuf
);
103 static int canonical_name(const char *host
, struct strbuf
*out
)
108 struct addrinfo hints
, *ai
;
109 memset (&hints
, '\0', sizeof (hints
));
110 hints
.ai_flags
= AI_CANONNAME
;
111 if (!getaddrinfo(host
, NULL
, &hints
, &ai
)) {
112 if (ai
&& ai
->ai_canonname
&& strchr(ai
->ai_canonname
, '.')) {
113 strbuf_addstr(out
, ai
->ai_canonname
);
119 struct hostent
*he
= gethostbyname(host
);
120 if (he
&& strchr(he
->h_name
, '.')) {
121 strbuf_addstr(out
, he
->h_name
);
129 static void add_domainname(struct strbuf
*out
, int *is_bogus
)
131 char buf
[HOST_NAME_MAX
+ 1];
133 if (xgethostname(buf
, sizeof(buf
))) {
134 warning_errno("cannot get host name");
135 strbuf_addstr(out
, "(none)");
139 if (strchr(buf
, '.'))
140 strbuf_addstr(out
, buf
);
141 else if (canonical_name(buf
, out
) < 0) {
142 strbuf_addf(out
, "%s.(none)", buf
);
147 static void copy_email(const struct passwd
*pw
, struct strbuf
*email
,
151 * Make up a fake email address
152 * (name + '@' + hostname [+ '.' + domainname])
154 strbuf_addstr(email
, pw
->pw_name
);
155 strbuf_addch(email
, '@');
157 if (!add_mailname_host(email
))
158 return; /* read from "/etc/mailname" (Debian) */
159 add_domainname(email
, is_bogus
);
162 const char *ident_default_name(void)
164 if (!(ident_config_given
& IDENT_NAME_GIVEN
) && !git_default_name
.len
) {
165 copy_gecos(xgetpwuid_self(&default_name_is_bogus
), &git_default_name
);
166 strbuf_trim(&git_default_name
);
168 return git_default_name
.buf
;
171 const char *ident_default_email(void)
173 if (!(ident_config_given
& IDENT_MAIL_GIVEN
) && !git_default_email
.len
) {
174 const char *email
= getenv("EMAIL");
176 if (email
&& email
[0]) {
177 strbuf_addstr(&git_default_email
, email
);
178 committer_ident_explicitly_given
|= IDENT_MAIL_GIVEN
;
179 author_ident_explicitly_given
|= IDENT_MAIL_GIVEN
;
180 } else if ((email
= query_user_email()) && email
[0]) {
181 strbuf_addstr(&git_default_email
, email
);
184 copy_email(xgetpwuid_self(&default_email_is_bogus
),
185 &git_default_email
, &default_email_is_bogus
);
186 strbuf_trim(&git_default_email
);
188 return git_default_email
.buf
;
191 static const char *ident_default_date(void)
193 if (!git_default_date
.len
)
194 datestamp(&git_default_date
);
195 return git_default_date
.buf
;
198 void reset_ident_date(void)
200 strbuf_reset(&git_default_date
);
203 static int crud(unsigned char c
)
216 static int has_non_crud(const char *str
)
218 for (; *str
; str
++) {
226 * Copy over a string to the destination, but avoid special
227 * characters ('\n', '<' and '>') and remove crud at the end
229 static void strbuf_addstr_without_crud(struct strbuf
*sb
, const char *src
)
234 /* Remove crud from the beginning.. */
235 while ((c
= *src
) != 0) {
241 /* Remove crud from the end.. */
251 * Copy the rest to the buffer, but avoid the special
252 * characters '\n' '<' and '>' that act as delimiters on
253 * an identification line. We can only remove crud, never add it,
254 * so 'len' is our maximum.
256 strbuf_grow(sb
, len
);
257 for (i
= 0; i
< len
; i
++) {
260 case '\n': case '<': case '>':
263 sb
->buf
[sb
->len
++] = c
;
265 sb
->buf
[sb
->len
] = '\0';
269 * Reverse of fmt_ident(); given an ident line, split the fields
270 * to allow the caller to parse it.
271 * Signal a success by returning 0, but date/tz fields of the result
272 * can still be NULL if the input line only has the name/email part
273 * (e.g. reading from a reflog entry).
275 int split_ident_line(struct ident_split
*split
, const char *line
, int len
)
281 memset(split
, 0, sizeof(*split
));
283 split
->name_begin
= line
;
284 for (cp
= line
; *cp
&& cp
< line
+ len
; cp
++)
286 split
->mail_begin
= cp
+ 1;
289 if (!split
->mail_begin
)
292 for (cp
= split
->mail_begin
- 2; line
<= cp
; cp
--)
294 split
->name_end
= cp
+ 1;
297 if (!split
->name_end
) {
298 /* no human readable name */
299 split
->name_end
= split
->name_begin
;
302 for (cp
= split
->mail_begin
; cp
< line
+ len
; cp
++)
304 split
->mail_end
= cp
;
307 if (!split
->mail_end
)
311 * Look from the end-of-line to find the trailing ">" of the mail
312 * address, even though we should already know it as split->mail_end.
313 * This can help in cases of broken idents with an extra ">" somewhere
314 * in the email address. Note that we are assuming the timestamp will
315 * never have a ">" in it.
317 * Note that we will always find some ">" before going off the front of
318 * the string, because will always hit the split->mail_end closing
321 for (cp
= line
+ len
- 1; *cp
!= '>'; cp
--)
324 for (cp
= cp
+ 1; cp
< line
+ len
&& isspace(*cp
); cp
++)
326 if (line
+ len
<= cp
)
328 split
->date_begin
= cp
;
329 span
= strspn(cp
, "0123456789");
332 split
->date_end
= split
->date_begin
+ span
;
333 for (cp
= split
->date_end
; cp
< line
+ len
&& isspace(*cp
); cp
++)
335 if (line
+ len
<= cp
|| (*cp
!= '+' && *cp
!= '-'))
337 split
->tz_begin
= cp
;
338 span
= strspn(cp
+ 1, "0123456789");
341 split
->tz_end
= split
->tz_begin
+ 1 + span
;
345 split
->date_begin
= NULL
;
346 split
->date_end
= NULL
;
347 split
->tz_begin
= NULL
;
348 split
->tz_end
= NULL
;
353 * Returns the difference between the new and old length of the ident line.
355 static ssize_t
rewrite_ident_line(const char *person
, size_t len
,
357 struct string_list
*mailmap
)
359 size_t namelen
, maillen
;
362 struct ident_split ident
;
364 if (split_ident_line(&ident
, person
, len
))
367 mail
= ident
.mail_begin
;
368 maillen
= ident
.mail_end
- ident
.mail_begin
;
369 name
= ident
.name_begin
;
370 namelen
= ident
.name_end
- ident
.name_begin
;
372 if (map_user(mailmap
, &mail
, &maillen
, &name
, &namelen
)) {
373 struct strbuf namemail
= STRBUF_INIT
;
376 strbuf_addf(&namemail
, "%.*s <%.*s>",
377 (int)namelen
, name
, (int)maillen
, mail
);
379 strbuf_splice(buf
, ident
.name_begin
- buf
->buf
,
380 ident
.mail_end
- ident
.name_begin
+ 1,
381 namemail
.buf
, namemail
.len
);
382 newlen
= namemail
.len
;
384 strbuf_release(&namemail
);
386 return newlen
- (ident
.mail_end
- ident
.name_begin
);
392 void apply_mailmap_to_header(struct strbuf
*buf
, const char **header
,
393 struct string_list
*mailmap
)
395 size_t buf_offset
= 0;
401 const char *person
, *line
;
403 int found_header
= 0;
405 line
= buf
->buf
+ buf_offset
;
406 if (!*line
|| *line
== '\n')
407 return; /* End of headers */
409 for (i
= 0; header
[i
]; i
++)
410 if (skip_prefix(line
, header
[i
], &person
)) {
411 const char *endp
= strchrnul(person
, '\n');
413 buf_offset
+= endp
- line
;
414 buf_offset
+= rewrite_ident_line(person
, endp
- person
, buf
, mailmap
);
419 buf_offset
= strchrnul(line
, '\n') - buf
->buf
;
420 if (buf
->buf
[buf_offset
] == '\n')
426 static void ident_env_hint(enum want_ident whose_ident
)
428 switch (whose_ident
) {
429 case WANT_AUTHOR_IDENT
:
430 fputs(_("Author identity unknown\n"), stderr
);
432 case WANT_COMMITTER_IDENT
:
433 fputs(_("Committer identity unknown\n"), stderr
);
440 "*** Please tell me who you are.\n"
444 " git config --global user.email \"you@example.com\"\n"
445 " git config --global user.name \"Your Name\"\n"
447 "to set your account\'s default identity.\n"
448 "Omit --global to set the identity only in this repository.\n"
452 const char *fmt_ident(const char *name
, const char *email
,
453 enum want_ident whose_ident
, const char *date_str
, int flag
)
456 static struct strbuf ident_pool
[2] = { STRBUF_INIT
, STRBUF_INIT
};
457 int strict
= (flag
& IDENT_STRICT
);
458 int want_date
= !(flag
& IDENT_NO_DATE
);
459 int want_name
= !(flag
& IDENT_NO_NAME
);
461 struct strbuf
*ident
= &ident_pool
[index
];
462 index
= (index
+ 1) % ARRAY_SIZE(ident_pool
);
465 if (whose_ident
== WANT_AUTHOR_IDENT
&& git_author_email
.len
)
466 email
= git_author_email
.buf
;
467 else if (whose_ident
== WANT_COMMITTER_IDENT
&& git_committer_email
.len
)
468 email
= git_committer_email
.buf
;
471 if (strict
&& ident_use_config_only
472 && !(ident_config_given
& IDENT_MAIL_GIVEN
)) {
473 ident_env_hint(whose_ident
);
474 die(_("no email was given and auto-detection is disabled"));
476 email
= ident_default_email();
477 if (strict
&& default_email_is_bogus
) {
478 ident_env_hint(whose_ident
);
479 die(_("unable to auto-detect email address (got '%s')"), email
);
484 int using_default
= 0;
486 if (whose_ident
== WANT_AUTHOR_IDENT
&& git_author_name
.len
)
487 name
= git_author_name
.buf
;
488 else if (whose_ident
== WANT_COMMITTER_IDENT
&&
489 git_committer_name
.len
)
490 name
= git_committer_name
.buf
;
493 if (strict
&& ident_use_config_only
494 && !(ident_config_given
& IDENT_NAME_GIVEN
)) {
495 ident_env_hint(whose_ident
);
496 die(_("no name was given and auto-detection is disabled"));
498 name
= ident_default_name();
500 if (strict
&& default_name_is_bogus
) {
501 ident_env_hint(whose_ident
);
502 die(_("unable to auto-detect name (got '%s')"), name
);
509 ident_env_hint(whose_ident
);
510 die(_("empty ident name (for <%s>) not allowed"), email
);
512 pw
= xgetpwuid_self(NULL
);
515 if (strict
&& !has_non_crud(name
))
516 die(_("name consists only of disallowed characters: %s"), name
);
521 strbuf_addstr_without_crud(ident
, name
);
522 strbuf_addstr(ident
, " <");
524 strbuf_addstr_without_crud(ident
, email
);
526 strbuf_addch(ident
, '>');
528 strbuf_addch(ident
, ' ');
529 if (date_str
&& date_str
[0]) {
530 if (parse_date(date_str
, ident
) < 0)
531 die(_("invalid date format: %s"), date_str
);
534 strbuf_addstr(ident
, ident_default_date());
540 const char *fmt_name(enum want_ident whose_ident
)
545 switch (whose_ident
) {
546 case WANT_BLANK_IDENT
:
548 case WANT_AUTHOR_IDENT
:
549 name
= getenv("GIT_AUTHOR_NAME");
550 email
= getenv("GIT_AUTHOR_EMAIL");
552 case WANT_COMMITTER_IDENT
:
553 name
= getenv("GIT_COMMITTER_NAME");
554 email
= getenv("GIT_COMMITTER_EMAIL");
557 return fmt_ident(name
, email
, whose_ident
, NULL
,
558 IDENT_STRICT
| IDENT_NO_DATE
);
561 const char *git_author_info(int flag
)
563 if (getenv("GIT_AUTHOR_NAME"))
564 author_ident_explicitly_given
|= IDENT_NAME_GIVEN
;
565 if (getenv("GIT_AUTHOR_EMAIL"))
566 author_ident_explicitly_given
|= IDENT_MAIL_GIVEN
;
567 return fmt_ident(getenv("GIT_AUTHOR_NAME"),
568 getenv("GIT_AUTHOR_EMAIL"),
570 getenv("GIT_AUTHOR_DATE"),
574 const char *git_committer_info(int flag
)
576 if (getenv("GIT_COMMITTER_NAME"))
577 committer_ident_explicitly_given
|= IDENT_NAME_GIVEN
;
578 if (getenv("GIT_COMMITTER_EMAIL"))
579 committer_ident_explicitly_given
|= IDENT_MAIL_GIVEN
;
580 return fmt_ident(getenv("GIT_COMMITTER_NAME"),
581 getenv("GIT_COMMITTER_EMAIL"),
582 WANT_COMMITTER_IDENT
,
583 getenv("GIT_COMMITTER_DATE"),
587 static int ident_is_sufficient(int user_ident_explicitly_given
)
590 return (user_ident_explicitly_given
& IDENT_MAIL_GIVEN
);
592 return (user_ident_explicitly_given
== IDENT_ALL_GIVEN
);
596 int committer_ident_sufficiently_given(void)
598 return ident_is_sufficient(committer_ident_explicitly_given
);
601 int author_ident_sufficiently_given(void)
603 return ident_is_sufficient(author_ident_explicitly_given
);
606 static int set_ident(const char *var
, const char *value
)
608 if (!strcmp(var
, "author.name")) {
610 return config_error_nonbool(var
);
611 strbuf_reset(&git_author_name
);
612 strbuf_addstr(&git_author_name
, value
);
613 author_ident_explicitly_given
|= IDENT_NAME_GIVEN
;
614 ident_config_given
|= IDENT_NAME_GIVEN
;
618 if (!strcmp(var
, "author.email")) {
620 return config_error_nonbool(var
);
621 strbuf_reset(&git_author_email
);
622 strbuf_addstr(&git_author_email
, value
);
623 author_ident_explicitly_given
|= IDENT_MAIL_GIVEN
;
624 ident_config_given
|= IDENT_MAIL_GIVEN
;
628 if (!strcmp(var
, "committer.name")) {
630 return config_error_nonbool(var
);
631 strbuf_reset(&git_committer_name
);
632 strbuf_addstr(&git_committer_name
, value
);
633 committer_ident_explicitly_given
|= IDENT_NAME_GIVEN
;
634 ident_config_given
|= IDENT_NAME_GIVEN
;
638 if (!strcmp(var
, "committer.email")) {
640 return config_error_nonbool(var
);
641 strbuf_reset(&git_committer_email
);
642 strbuf_addstr(&git_committer_email
, value
);
643 committer_ident_explicitly_given
|= IDENT_MAIL_GIVEN
;
644 ident_config_given
|= IDENT_MAIL_GIVEN
;
648 if (!strcmp(var
, "user.name")) {
650 return config_error_nonbool(var
);
651 strbuf_reset(&git_default_name
);
652 strbuf_addstr(&git_default_name
, value
);
653 committer_ident_explicitly_given
|= IDENT_NAME_GIVEN
;
654 author_ident_explicitly_given
|= IDENT_NAME_GIVEN
;
655 ident_config_given
|= IDENT_NAME_GIVEN
;
659 if (!strcmp(var
, "user.email")) {
661 return config_error_nonbool(var
);
662 strbuf_reset(&git_default_email
);
663 strbuf_addstr(&git_default_email
, value
);
664 committer_ident_explicitly_given
|= IDENT_MAIL_GIVEN
;
665 author_ident_explicitly_given
|= IDENT_MAIL_GIVEN
;
666 ident_config_given
|= IDENT_MAIL_GIVEN
;
673 int git_ident_config(const char *var
, const char *value
,
674 const struct config_context
*ctx UNUSED
,
677 if (!strcmp(var
, "user.useconfigonly")) {
678 ident_use_config_only
= git_config_bool(var
, value
);
682 return set_ident(var
, value
);
685 static void set_env_if(const char *key
, const char *value
, int *given
, int bit
)
687 if ((*given
& bit
) || getenv(key
))
688 return; /* nothing to do */
689 setenv(key
, value
, 0);
693 void prepare_fallback_ident(const char *name
, const char *email
)
695 set_env_if("GIT_AUTHOR_NAME", name
,
696 &author_ident_explicitly_given
, IDENT_NAME_GIVEN
);
697 set_env_if("GIT_AUTHOR_EMAIL", email
,
698 &author_ident_explicitly_given
, IDENT_MAIL_GIVEN
);
699 set_env_if("GIT_COMMITTER_NAME", name
,
700 &committer_ident_explicitly_given
, IDENT_NAME_GIVEN
);
701 set_env_if("GIT_COMMITTER_EMAIL", email
,
702 &committer_ident_explicitly_given
, IDENT_MAIL_GIVEN
);
705 static int buf_cmp(const char *a_begin
, const char *a_end
,
706 const char *b_begin
, const char *b_end
)
708 int a_len
= a_end
- a_begin
;
709 int b_len
= b_end
- b_begin
;
710 int min
= a_len
< b_len
? a_len
: b_len
;
713 cmp
= memcmp(a_begin
, b_begin
, min
);
717 return a_len
- b_len
;
720 int ident_cmp(const struct ident_split
*a
,
721 const struct ident_split
*b
)
725 cmp
= buf_cmp(a
->mail_begin
, a
->mail_end
,
726 b
->mail_begin
, b
->mail_end
);
730 return buf_cmp(a
->name_begin
, a
->name_end
,
731 b
->name_begin
, b
->name_end
);