commit: rephrase the error when user did not touch templated log message
[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 #else
9 static inline void debug_mm(const char *format, ...) {}
10 #endif
11
12 const char *git_mailmap_file;
13
14 struct mailmap_info {
15         char *name;
16         char *email;
17 };
18
19 struct mailmap_entry {
20         /* name and email for the simple mail-only case */
21         char *name;
22         char *email;
23
24         /* name and email for the complex mail and name matching case */
25         struct string_list namemap;
26 };
27
28 static void free_mailmap_info(void *p, const char *s)
29 {
30         struct mailmap_info *mi = (struct mailmap_info *)p;
31         debug_mm("mailmap: -- complex: '%s' -> '%s' <%s>\n", s, mi->name, mi->email);
32         free(mi->name);
33         free(mi->email);
34 }
35
36 static void free_mailmap_entry(void *p, const char *s)
37 {
38         struct mailmap_entry *me = (struct mailmap_entry *)p;
39         debug_mm("mailmap: removing entries for <%s>, with %d sub-entries\n", s, me->namemap.nr);
40         debug_mm("mailmap: - simple: '%s' <%s>\n", me->name, me->email);
41         free(me->name);
42         free(me->email);
43
44         me->namemap.strdup_strings = 1;
45         string_list_clear_func(&me->namemap, free_mailmap_info);
46 }
47
48 static void add_mapping(struct string_list *map,
49                         char *new_name, char *new_email, char *old_name, char *old_email)
50 {
51         struct mailmap_entry *me;
52         int index;
53         char *p;
54
55         if (old_email)
56                 for (p = old_email; *p; p++)
57                         *p = tolower(*p);
58         if (new_email)
59                 for (p = new_email; *p; p++)
60                         *p = tolower(*p);
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         } else {
71                 /* create mailmap entry */
72                 struct string_list_item *item = string_list_insert_at_index(map, index, old_email);
73                 item->util = xcalloc(1, sizeof(struct mailmap_entry));
74                 ((struct mailmap_entry *)item->util)->namemap.strdup_strings = 1;
75         }
76         me = (struct mailmap_entry *)map->items[index].util;
77
78         if (old_name == NULL) {
79                 debug_mm("mailmap: adding (simple) entry for %s at index %d\n", old_email, index);
80                 /* Replace current name and new email for simple entry */
81                 if (new_name) {
82                         free(me->name);
83                         me->name = xstrdup(new_name);
84                 }
85                 if (new_email) {
86                         free(me->email);
87                         me->email = xstrdup(new_email);
88                 }
89         } else {
90                 struct mailmap_info *mi = xcalloc(1, sizeof(struct mailmap_info));
91                 debug_mm("mailmap: adding (complex) entry for %s at index %d\n", old_email, index);
92                 if (new_name)
93                         mi->name = xstrdup(new_name);
94                 if (new_email)
95                         mi->email = xstrdup(new_email);
96                 string_list_insert(&me->namemap, old_name)->util = mi;
97         }
98
99         debug_mm("mailmap:  '%s' <%s> -> '%s' <%s>\n",
100                  old_name, old_email, new_name, new_email);
101 }
102
103 static char *parse_name_and_email(char *buffer, char **name,
104                 char **email, int allow_empty_email)
105 {
106         char *left, *right, *nstart, *nend;
107         *name = *email = NULL;
108
109         if ((left = strchr(buffer, '<')) == NULL)
110                 return NULL;
111         if ((right = strchr(left+1, '>')) == NULL)
112                 return NULL;
113         if (!allow_empty_email && (left+1 == right))
114                 return NULL;
115
116         /* remove whitespace from beginning and end of name */
117         nstart = buffer;
118         while (isspace(*nstart) && nstart < left)
119                 ++nstart;
120         nend = left-1;
121         while (isspace(*nend) && nend > nstart)
122                 --nend;
123
124         *name = (nstart < nend ? nstart : NULL);
125         *email = left+1;
126         *(nend+1) = '\0';
127         *right++ = '\0';
128
129         return (*right == '\0' ? NULL : right);
130 }
131
132 static int read_single_mailmap(struct string_list *map, const char *filename, char **repo_abbrev)
133 {
134         char buffer[1024];
135         FILE *f = (filename == NULL ? NULL : fopen(filename, "r"));
136
137         if (f == NULL)
138                 return 1;
139         while (fgets(buffer, sizeof(buffer), f) != NULL) {
140                 char *name1 = NULL, *email1 = NULL, *name2 = NULL, *email2 = NULL;
141                 if (buffer[0] == '#') {
142                         static const char abbrev[] = "# repo-abbrev:";
143                         int abblen = sizeof(abbrev) - 1;
144                         int len = strlen(buffer);
145
146                         if (!repo_abbrev)
147                                 continue;
148
149                         if (len && buffer[len - 1] == '\n')
150                                 buffer[--len] = 0;
151                         if (!strncmp(buffer, abbrev, abblen)) {
152                                 char *cp;
153
154                                 if (repo_abbrev)
155                                         free(*repo_abbrev);
156                                 *repo_abbrev = xmalloc(len);
157
158                                 for (cp = buffer + abblen; isspace(*cp); cp++)
159                                         ; /* nothing */
160                                 strcpy(*repo_abbrev, cp);
161                         }
162                         continue;
163                 }
164                 if ((name2 = parse_name_and_email(buffer, &name1, &email1, 0)) != NULL)
165                         parse_name_and_email(name2, &name2, &email2, 1);
166
167                 if (email1)
168                         add_mapping(map, name1, email1, name2, email2);
169         }
170         fclose(f);
171         return 0;
172 }
173
174 int read_mailmap(struct string_list *map, char **repo_abbrev)
175 {
176         map->strdup_strings = 1;
177         /* each failure returns 1, so >1 means both calls failed */
178         return read_single_mailmap(map, ".mailmap", repo_abbrev) +
179                read_single_mailmap(map, git_mailmap_file, repo_abbrev) > 1;
180 }
181
182 void clear_mailmap(struct string_list *map)
183 {
184         debug_mm("mailmap: clearing %d entries...\n", map->nr);
185         map->strdup_strings = 1;
186         string_list_clear_func(map, free_mailmap_entry);
187         debug_mm("mailmap: cleared\n");
188 }
189
190 int map_user(struct string_list *map,
191              char *email, int maxlen_email, char *name, int maxlen_name)
192 {
193         char *p;
194         struct string_list_item *item;
195         struct mailmap_entry *me;
196         char buf[1024], *mailbuf;
197         int i;
198
199         /* figure out space requirement for email */
200         p = strchr(email, '>');
201         if (!p) {
202                 /* email passed in might not be wrapped in <>, but end with a \0 */
203                 p = memchr(email, '\0', maxlen_email);
204                 if (!p)
205                         return 0;
206         }
207         if (p - email + 1 < sizeof(buf))
208                 mailbuf = buf;
209         else
210                 mailbuf = xmalloc(p - email + 1);
211
212         /* downcase the email address */
213         for (i = 0; i < p - email; i++)
214                 mailbuf[i] = tolower(email[i]);
215         mailbuf[i] = 0;
216
217         debug_mm("map_user: map '%s' <%s>\n", name, mailbuf);
218         item = string_list_lookup(map, mailbuf);
219         if (item != NULL) {
220                 me = (struct mailmap_entry *)item->util;
221                 if (me->namemap.nr) {
222                         /* The item has multiple items, so we'll look up on name too */
223                         /* If the name is not found, we choose the simple entry      */
224                         struct string_list_item *subitem = string_list_lookup(&me->namemap, name);
225                         if (subitem)
226                                 item = subitem;
227                 }
228         }
229         if (mailbuf != buf)
230                 free(mailbuf);
231         if (item != NULL) {
232                 struct mailmap_info *mi = (struct mailmap_info *)item->util;
233                 if (mi->name == NULL && (mi->email == NULL || maxlen_email == 0)) {
234                         debug_mm("map_user:  -- (no simple mapping)\n");
235                         return 0;
236                 }
237                 if (maxlen_email && mi->email)
238                         strlcpy(email, mi->email, maxlen_email);
239                 if (maxlen_name && mi->name)
240                         strlcpy(name, mi->name, maxlen_name);
241                 debug_mm("map_user:  to '%s' <%s>\n", name, mi->email ? mi->email : "");
242                 return 1;
243         }
244         debug_mm("map_user:  --\n");
245         return 0;
246 }