help: drop prepend function in favor of xstrfmt
[git/git.git] / mailmap.c
CommitLineData
7c1c6782 1#include "cache.h"
c455c87c 2#include "string-list.h"
fe5d30b6 3#include "mailmap.h"
7c1c6782 4
0925ce4d
MSO
5#define DEBUG_MAILMAP 0
6#if DEBUG_MAILMAP
7#define debug_mm(...) fprintf(stderr, __VA_ARGS__)
fbfba7ad 8#define debug_str(X) ((X) ? (X) : "(none)")
0925ce4d
MSO
9#else
10static inline void debug_mm(const char *format, ...) {}
fbfba7ad 11static inline const char *debug_str(const char *s) { return s; }
0925ce4d
MSO
12#endif
13
d551a488 14const char *git_mailmap_file;
08610900 15const char *git_mailmap_blob;
0925ce4d
MSO
16
17struct mailmap_info {
18 char *name;
19 char *email;
20};
21
22struct mailmap_entry {
23 /* name and email for the simple mail-only case */
24 char *name;
25 char *email;
26
27 /* name and email for the complex mail and name matching case */
28 struct string_list namemap;
29};
30
31static void free_mailmap_info(void *p, const char *s)
32{
33 struct mailmap_info *mi = (struct mailmap_info *)p;
bd237945
JH
34 debug_mm("mailmap: -- complex: '%s' -> '%s' <%s>\n",
35 s, debug_str(mi->name), debug_str(mi->email));
0925ce4d
MSO
36 free(mi->name);
37 free(mi->email);
38}
39
40static void free_mailmap_entry(void *p, const char *s)
41{
42 struct mailmap_entry *me = (struct mailmap_entry *)p;
bd237945
JH
43 debug_mm("mailmap: removing entries for <%s>, with %d sub-entries\n",
44 s, me->namemap.nr);
45 debug_mm("mailmap: - simple: '%s' <%s>\n",
46 debug_str(me->name), debug_str(me->email));
fbfba7ad 47
0925ce4d
MSO
48 free(me->name);
49 free(me->email);
50
51 me->namemap.strdup_strings = 1;
52 string_list_clear_func(&me->namemap, free_mailmap_info);
53}
54
de2f95eb
JH
55/*
56 * On some systems (e.g. MinGW 4.0), string.h has _only_ inline
57 * definition of strcasecmp and no non-inline implementation is
58 * supplied anywhere, which is, eh, "unusual"; we cannot take an
59 * address of such a function to store it in namemap.cmp. This is
60 * here as a workaround---do not assign strcasecmp directly to
61 * namemap.cmp until we know no systems that matter have such an
62 * "unusual" string.h.
63 */
64static int namemap_cmp(const char *a, const char *b)
65{
66 return strcasecmp(a, b);
67}
68
0925ce4d 69static void add_mapping(struct string_list *map,
bd237945
JH
70 char *new_name, char *new_email,
71 char *old_name, char *old_email)
0925ce4d
MSO
72{
73 struct mailmap_entry *me;
63226218 74 struct string_list_item *item;
bf637803 75
0925ce4d
MSO
76 if (old_email == NULL) {
77 old_email = new_email;
78 new_email = NULL;
79 }
80
63226218
SB
81 item = string_list_insert(map, old_email);
82 if (item->util) {
83 me = (struct mailmap_entry *)item->util;
0925ce4d 84 } else {
97e751be
JH
85 me = xcalloc(1, sizeof(struct mailmap_entry));
86 me->namemap.strdup_strings = 1;
de2f95eb 87 me->namemap.cmp = namemap_cmp;
97e751be 88 item->util = me;
0925ce4d 89 }
0925ce4d
MSO
90
91 if (old_name == NULL) {
63226218
SB
92 debug_mm("mailmap: adding (simple) entry for '%s'\n", old_email);
93
0925ce4d 94 /* Replace current name and new email for simple entry */
d8d2eb7d
JM
95 if (new_name) {
96 free(me->name);
0925ce4d 97 me->name = xstrdup(new_name);
d8d2eb7d
JM
98 }
99 if (new_email) {
100 free(me->email);
0925ce4d 101 me->email = xstrdup(new_email);
d8d2eb7d 102 }
0925ce4d 103 } else {
74b531f6 104 struct mailmap_info *mi = xcalloc(1, sizeof(struct mailmap_info));
63226218 105 debug_mm("mailmap: adding (complex) entry for '%s'\n", old_email);
0925ce4d
MSO
106 if (new_name)
107 mi->name = xstrdup(new_name);
108 if (new_email)
109 mi->email = xstrdup(new_email);
78a395d3 110 string_list_insert(&me->namemap, old_name)->util = mi;
0925ce4d
MSO
111 }
112
113 debug_mm("mailmap: '%s' <%s> -> '%s' <%s>\n",
bd237945
JH
114 debug_str(old_name), old_email,
115 debug_str(new_name), debug_str(new_email));
0925ce4d
MSO
116}
117
5288dd58 118static char *parse_name_and_email(char *buffer, char **name,
bd237945 119 char **email, int allow_empty_email)
0925ce4d
MSO
120{
121 char *left, *right, *nstart, *nend;
2af202be 122 *name = *email = NULL;
0925ce4d
MSO
123
124 if ((left = strchr(buffer, '<')) == NULL)
125 return NULL;
126 if ((right = strchr(left+1, '>')) == NULL)
127 return NULL;
5288dd58 128 if (!allow_empty_email && (left+1 == right))
0925ce4d
MSO
129 return NULL;
130
131 /* remove whitespace from beginning and end of name */
132 nstart = buffer;
133 while (isspace(*nstart) && nstart < left)
134 ++nstart;
135 nend = left-1;
3174bc5c 136 while (nend > nstart && isspace(*nend))
0925ce4d
MSO
137 --nend;
138
8c381151 139 *name = (nstart <= nend ? nstart : NULL);
0925ce4d
MSO
140 *email = left+1;
141 *(nend+1) = '\0';
142 *right++ = '\0';
143
144 return (*right == '\0' ? NULL : right);
145}
146
7c8ce308
JK
147static void read_mailmap_line(struct string_list *map, char *buffer,
148 char **repo_abbrev)
149{
150 char *name1 = NULL, *email1 = NULL, *name2 = NULL, *email2 = NULL;
151 if (buffer[0] == '#') {
152 static const char abbrev[] = "# repo-abbrev:";
153 int abblen = sizeof(abbrev) - 1;
154 int len = strlen(buffer);
155
156 if (!repo_abbrev)
157 return;
158
159 if (len && buffer[len - 1] == '\n')
160 buffer[--len] = 0;
161 if (!strncmp(buffer, abbrev, abblen)) {
162 char *cp;
163
c9ba31f5 164 free(*repo_abbrev);
7c8ce308
JK
165 *repo_abbrev = xmalloc(len);
166
167 for (cp = buffer + abblen; isspace(*cp); cp++)
168 ; /* nothing */
169 strcpy(*repo_abbrev, cp);
170 }
171 return;
172 }
173 if ((name2 = parse_name_and_email(buffer, &name1, &email1, 0)) != NULL)
174 parse_name_and_email(name2, &name2, &email2, 1);
175
176 if (email1)
177 add_mapping(map, name1, email1, name2, email2);
178}
179
180static int read_mailmap_file(struct string_list *map, const char *filename,
181 char **repo_abbrev)
7c1c6782
JH
182{
183 char buffer[1024];
938a60d6
JK
184 FILE *f;
185
186 if (!filename)
187 return 0;
188
189 f = fopen(filename, "r");
190 if (!f) {
191 if (errno == ENOENT)
192 return 0;
193 return error("unable to open mailmap at %s: %s",
194 filename, strerror(errno));
195 }
7c1c6782 196
7c8ce308
JK
197 while (fgets(buffer, sizeof(buffer), f) != NULL)
198 read_mailmap_line(map, buffer, repo_abbrev);
7c1c6782
JH
199 fclose(f);
200 return 0;
201}
202
f972a165
JK
203static void read_mailmap_string(struct string_list *map, char *buf,
204 char **repo_abbrev)
08610900 205{
f972a165
JK
206 while (*buf) {
207 char *end = strchrnul(buf, '\n');
08610900 208
f972a165
JK
209 if (*end)
210 *end++ = '\0';
08610900 211
f972a165
JK
212 read_mailmap_line(map, buf, repo_abbrev);
213 buf = end;
08610900
JK
214 }
215}
216
217static int read_mailmap_blob(struct string_list *map,
218 const char *name,
219 char **repo_abbrev)
220{
221 unsigned char sha1[20];
222 char *buf;
223 unsigned long size;
224 enum object_type type;
225
226 if (!name)
938a60d6 227 return 0;
08610900 228 if (get_sha1(name, sha1) < 0)
938a60d6 229 return 0;
08610900
JK
230
231 buf = read_sha1_file(sha1, &type, &size);
232 if (!buf)
938a60d6 233 return error("unable to read mailmap object at %s", name);
08610900 234 if (type != OBJ_BLOB)
938a60d6 235 return error("mailmap is not a blob: %s", name);
08610900 236
f972a165 237 read_mailmap_string(map, buf, repo_abbrev);
08610900
JK
238
239 free(buf);
240 return 0;
241}
242
d551a488
MSO
243int read_mailmap(struct string_list *map, char **repo_abbrev)
244{
938a60d6 245 int err = 0;
8c473cec 246
0925ce4d 247 map->strdup_strings = 1;
de2f95eb 248 map->cmp = namemap_cmp;
8c473cec
JK
249
250 if (!git_mailmap_blob && is_bare_repository())
251 git_mailmap_blob = "HEAD:.mailmap";
252
938a60d6
JK
253 err |= read_mailmap_file(map, ".mailmap", repo_abbrev);
254 err |= read_mailmap_blob(map, git_mailmap_blob, repo_abbrev);
255 err |= read_mailmap_file(map, git_mailmap_file, repo_abbrev);
256 return err;
d551a488
MSO
257}
258
0925ce4d
MSO
259void clear_mailmap(struct string_list *map)
260{
261 debug_mm("mailmap: clearing %d entries...\n", map->nr);
262 map->strdup_strings = 1;
263 string_list_clear_func(map, free_mailmap_entry);
264 debug_mm("mailmap: cleared\n");
265}
266
388c7f8a
JH
267/*
268 * Look for an entry in map that match string[0:len]; string[len]
269 * does not have to be NUL (but it could be).
270 */
271static struct string_list_item *lookup_prefix(struct string_list *map,
272 const char *string, size_t len)
273{
274 int i = string_list_find_insert_index(map, string, 1);
275 if (i < 0) {
276 /* exact match */
277 i = -1 - i;
278 if (!string[len])
279 return &map->items[i];
280 /*
281 * that map entry matches exactly to the string, including
282 * the cruft at the end beyond "len". That is not a match
283 * with string[0:len] that we are looking for.
284 */
285 } else if (!string[len]) {
286 /*
287 * asked with the whole string, and got nothing. No
288 * matching entry can exist in the map.
289 */
290 return NULL;
291 }
292
293 /*
294 * i is at the exact match to an overlong key, or location the
295 * overlong key would be inserted, which must come after the
296 * real location of the key if one exists.
297 */
298 while (0 <= --i && i < map->nr) {
299 int cmp = strncasecmp(map->items[i].string, string, len);
300 if (cmp < 0)
301 /*
302 * "i" points at a key definitely below the prefix;
303 * the map does not have string[0:len] in it.
304 */
305 break;
306 else if (!cmp && !map->items[i].string[len])
307 /* found it */
308 return &map->items[i];
309 /*
310 * otherwise, the string at "i" may be string[0:len]
311 * followed by a string that sorts later than string[len:];
312 * keep trying.
313 */
314 }
315 return NULL;
316}
317
0925ce4d 318int map_user(struct string_list *map,
bd237945
JH
319 const char **email, size_t *emaillen,
320 const char **name, size_t *namelen)
7c1c6782 321{
c455c87c 322 struct string_list_item *item;
0925ce4d 323 struct mailmap_entry *me;
388c7f8a 324
ea02ffa3 325 debug_mm("map_user: map '%.*s' <%.*s>\n",
bd237945
JH
326 (int)*namelen, debug_str(*name),
327 (int)*emaillen, debug_str(*email));
388c7f8a 328
ea02ffa3 329 item = lookup_prefix(map, *email, *emaillen);
0925ce4d
MSO
330 if (item != NULL) {
331 me = (struct mailmap_entry *)item->util;
332 if (me->namemap.nr) {
bd237945
JH
333 /*
334 * The item has multiple items, so we'll look up on
335 * name too. If the name is not found, we choose the
336 * simple entry.
337 */
ea02ffa3
AP
338 struct string_list_item *subitem;
339 subitem = lookup_prefix(&me->namemap, *name, *namelen);
0925ce4d
MSO
340 if (subitem)
341 item = subitem;
342 }
343 }
7c1c6782 344 if (item != NULL) {
0925ce4d 345 struct mailmap_info *mi = (struct mailmap_info *)item->util;
ea02ffa3 346 if (mi->name == NULL && mi->email == NULL) {
0925ce4d
MSO
347 debug_mm("map_user: -- (no simple mapping)\n");
348 return 0;
349 }
ea02ffa3
AP
350 if (mi->email) {
351 *email = mi->email;
352 *emaillen = strlen(*email);
353 }
354 if (mi->name) {
355 *name = mi->name;
356 *namelen = strlen(*name);
357 }
bd237945
JH
358 debug_mm("map_user: to '%.*s' <%.*s>\n",
359 (int)*namelen, debug_str(*name),
360 (int)*emaillen, debug_str(*email));
7c1c6782
JH
361 return 1;
362 }
0925ce4d 363 debug_mm("map_user: --\n");
7c1c6782
JH
364 return 0;
365}