Merge branch 'jn/glossary-revision'
[git] / ident.c
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
10 static struct strbuf git_default_name = STRBUF_INIT;
11 static struct strbuf git_default_email = STRBUF_INIT;
12 static char git_default_date[50];
13
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;
19
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
25
26 static void copy_gecos(const struct passwd *w, struct strbuf *name)
27 {
28         char *src;
29
30         /* Traditionally GECOS field had office phone numbers etc, separated
31          * with commas.  Also & stands for capitalized form of the login name.
32          */
33
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);
42                 }
43         }
44 }
45
46 static int add_mailname_host(struct strbuf *buf)
47 {
48         FILE *mailname;
49         struct strbuf mailnamebuf = STRBUF_INIT;
50
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;
57         }
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;
65         }
66         /* success! */
67         strbuf_addbuf(buf, &mailnamebuf);
68         strbuf_release(&mailnamebuf);
69         fclose(mailname);
70         return 0;
71 }
72
73 static void add_domainname(struct strbuf *out)
74 {
75         char buf[1024];
76         struct hostent *he;
77
78         if (gethostname(buf, sizeof(buf))) {
79                 warning("cannot get host name: %s", strerror(errno));
80                 strbuf_addstr(out, "(none)");
81                 return;
82         }
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);
89 }
90
91 static void copy_email(const struct passwd *pw, struct strbuf *email)
92 {
93         /*
94          * Make up a fake email address
95          * (name + '@' + hostname [+ '.' + domainname])
96          */
97         strbuf_addstr(email, pw->pw_name);
98         strbuf_addch(email, '@');
99
100         if (!add_mailname_host(email))
101                 return; /* read from "/etc/mailname" (Debian) */
102         add_domainname(email);
103 }
104
105 static const char *ident_default_name(void)
106 {
107         if (!git_default_name.len) {
108                 copy_gecos(xgetpwuid_self(), &git_default_name);
109                 strbuf_trim(&git_default_name);
110         }
111         return git_default_name.buf;
112 }
113
114 const char *ident_default_email(void)
115 {
116         if (!git_default_email.len) {
117                 const char *email = getenv("EMAIL");
118
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);
126         }
127         return git_default_email.buf;
128 }
129
130 static const char *ident_default_date(void)
131 {
132         if (!git_default_date[0])
133                 datestamp(git_default_date, sizeof(git_default_date));
134         return git_default_date;
135 }
136
137 static int crud(unsigned char c)
138 {
139         return  c <= 32  ||
140                 c == '.' ||
141                 c == ',' ||
142                 c == ':' ||
143                 c == ';' ||
144                 c == '<' ||
145                 c == '>' ||
146                 c == '"' ||
147                 c == '\\' ||
148                 c == '\'';
149 }
150
151 /*
152  * Copy over a string to the destination, but avoid special
153  * characters ('\n', '<' and '>') and remove crud at the end
154  */
155 static void strbuf_addstr_without_crud(struct strbuf *sb, const char *src)
156 {
157         size_t i, len;
158         unsigned char c;
159
160         /* Remove crud from the beginning.. */
161         while ((c = *src) != 0) {
162                 if (!crud(c))
163                         break;
164                 src++;
165         }
166
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;
174         }
175
176         /*
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.
181          */
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;
188                 }
189                 sb->buf[sb->len++] = c;
190         }
191         sb->buf[sb->len] = '\0';
192 }
193
194 /*
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).
200  */
201 int split_ident_line(struct ident_split *split, const char *line, int len)
202 {
203         const char *cp;
204         size_t span;
205         int status = -1;
206
207         memset(split, 0, sizeof(*split));
208
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;
214                 }
215         if (!split->mail_begin)
216                 return status;
217
218         for (cp = split->mail_begin - 2; line <= cp; cp--)
219                 if (!isspace(*cp)) {
220                         split->name_end = cp + 1;
221                         break;
222                 }
223         if (!split->name_end) {
224                 /* no human readable name */
225                 split->name_end = split->name_begin;
226         }
227
228         for (cp = split->mail_begin; cp < line + len; cp++)
229                 if (*cp == '>') {
230                         split->mail_end = cp;
231                         break;
232                 }
233         if (!split->mail_end)
234                 return status;
235
236         for (cp = split->mail_end + 1; cp < line + len && isspace(*cp); cp++)
237                 ;
238         if (line + len <= cp)
239                 goto person_only;
240         split->date_begin = cp;
241         span = strspn(cp, "0123456789");
242         if (!span)
243                 goto person_only;
244         split->date_end = split->date_begin + span;
245         for (cp = split->date_end; cp < line + len && isspace(*cp); cp++)
246                 ;
247         if (line + len <= cp || (*cp != '+' && *cp != '-'))
248                 goto person_only;
249         split->tz_begin = cp;
250         span = strspn(cp + 1, "0123456789");
251         if (!span)
252                 goto person_only;
253         split->tz_end = split->tz_begin + 1 + span;
254         return 0;
255
256 person_only:
257         split->date_begin = NULL;
258         split->date_end = NULL;
259         split->tz_begin = NULL;
260         split->tz_end = NULL;
261         return 0;
262 }
263
264 static const char *env_hint =
265 "\n"
266 "*** Please tell me who you are.\n"
267 "\n"
268 "Run\n"
269 "\n"
270 "  git config --global user.email \"you@example.com\"\n"
271 "  git config --global user.name \"Your Name\"\n"
272 "\n"
273 "to set your account\'s default identity.\n"
274 "Omit --global to set the identity only in this repository.\n"
275 "\n";
276
277 const char *fmt_ident(const char *name, const char *email,
278                       const char *date_str, int flag)
279 {
280         static struct strbuf ident = STRBUF_INIT;
281         char date[50];
282         int strict = (flag & IDENT_STRICT);
283         int want_date = !(flag & IDENT_NO_DATE);
284         int want_name = !(flag & IDENT_NO_NAME);
285
286         if (want_name && !name)
287                 name = ident_default_name();
288         if (!email)
289                 email = ident_default_email();
290
291         if (want_name && !*name) {
292                 struct passwd *pw;
293
294                 if (strict) {
295                         if (name == git_default_name.buf)
296                                 fputs(env_hint, stderr);
297                         die("empty ident name (for <%s>) not allowed", email);
298                 }
299                 pw = xgetpwuid_self();
300                 name = pw->pw_name;
301         }
302
303         if (strict && email == git_default_email.buf &&
304             strstr(email, "(none)")) {
305                 fputs(env_hint, stderr);
306                 die("unable to auto-detect email address (got '%s')", email);
307         }
308
309         if (want_date) {
310                 if (date_str && date_str[0]) {
311                         if (parse_date(date_str, date, sizeof(date)) < 0)
312                                 die("invalid date format: %s", date_str);
313                 }
314                 else
315                         strcpy(date, ident_default_date());
316         }
317
318         strbuf_reset(&ident);
319         if (want_name) {
320                 strbuf_addstr_without_crud(&ident, name);
321                 strbuf_addstr(&ident, " <");
322         }
323         strbuf_addstr_without_crud(&ident, email);
324         if (want_name)
325                         strbuf_addch(&ident, '>');
326         if (want_date) {
327                 strbuf_addch(&ident, ' ');
328                 strbuf_addstr_without_crud(&ident, date);
329         }
330         return ident.buf;
331 }
332
333 const char *fmt_name(const char *name, const char *email)
334 {
335         return fmt_ident(name, email, NULL, IDENT_STRICT | IDENT_NO_DATE);
336 }
337
338 const char *git_author_info(int flag)
339 {
340         if (getenv("GIT_AUTHOR_NAME"))
341                 author_ident_explicitly_given |= IDENT_NAME_GIVEN;
342         if (getenv("GIT_AUTHOR_EMAIL"))
343                 author_ident_explicitly_given |= IDENT_MAIL_GIVEN;
344         return fmt_ident(getenv("GIT_AUTHOR_NAME"),
345                          getenv("GIT_AUTHOR_EMAIL"),
346                          getenv("GIT_AUTHOR_DATE"),
347                          flag);
348 }
349
350 const char *git_committer_info(int flag)
351 {
352         if (getenv("GIT_COMMITTER_NAME"))
353                 committer_ident_explicitly_given |= IDENT_NAME_GIVEN;
354         if (getenv("GIT_COMMITTER_EMAIL"))
355                 committer_ident_explicitly_given |= IDENT_MAIL_GIVEN;
356         return fmt_ident(getenv("GIT_COMMITTER_NAME"),
357                          getenv("GIT_COMMITTER_EMAIL"),
358                          getenv("GIT_COMMITTER_DATE"),
359                          flag);
360 }
361
362 static int ident_is_sufficient(int user_ident_explicitly_given)
363 {
364 #ifndef WINDOWS
365         return (user_ident_explicitly_given & IDENT_MAIL_GIVEN);
366 #else
367         return (user_ident_explicitly_given == IDENT_ALL_GIVEN);
368 #endif
369 }
370
371 int committer_ident_sufficiently_given(void)
372 {
373         return ident_is_sufficient(committer_ident_explicitly_given);
374 }
375
376 int author_ident_sufficiently_given(void)
377 {
378         return ident_is_sufficient(author_ident_explicitly_given);
379 }
380
381 int git_ident_config(const char *var, const char *value, void *data)
382 {
383         if (!strcmp(var, "user.name")) {
384                 if (!value)
385                         return config_error_nonbool(var);
386                 strbuf_reset(&git_default_name);
387                 strbuf_addstr(&git_default_name, value);
388                 committer_ident_explicitly_given |= IDENT_NAME_GIVEN;
389                 author_ident_explicitly_given |= IDENT_NAME_GIVEN;
390                 return 0;
391         }
392
393         if (!strcmp(var, "user.email")) {
394                 if (!value)
395                         return config_error_nonbool(var);
396                 strbuf_reset(&git_default_email);
397                 strbuf_addstr(&git_default_email, value);
398                 committer_ident_explicitly_given |= IDENT_MAIL_GIVEN;
399                 author_ident_explicitly_given |= IDENT_MAIL_GIVEN;
400                 return 0;
401         }
402
403         return 0;
404 }