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