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