]> git.ipfire.org Git - thirdparty/git.git/blame - mailmap.c
mailmap: fix some documentation loose-ends for mailmap.blob
[thirdparty/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__)
8#else
9static inline void debug_mm(const char *format, ...) {}
10#endif
11
d551a488 12const char *git_mailmap_file;
08610900 13const char *git_mailmap_blob;
0925ce4d
MSO
14
15struct mailmap_info {
16 char *name;
17 char *email;
18};
19
20struct mailmap_entry {
21 /* name and email for the simple mail-only case */
22 char *name;
23 char *email;
24
25 /* name and email for the complex mail and name matching case */
26 struct string_list namemap;
27};
28
29static void free_mailmap_info(void *p, const char *s)
30{
31 struct mailmap_info *mi = (struct mailmap_info *)p;
32 debug_mm("mailmap: -- complex: '%s' -> '%s' <%s>\n", s, mi->name, mi->email);
33 free(mi->name);
34 free(mi->email);
35}
36
37static void free_mailmap_entry(void *p, const char *s)
38{
39 struct mailmap_entry *me = (struct mailmap_entry *)p;
40 debug_mm("mailmap: removing entries for <%s>, with %d sub-entries\n", s, me->namemap.nr);
41 debug_mm("mailmap: - simple: '%s' <%s>\n", me->name, me->email);
42 free(me->name);
43 free(me->email);
44
45 me->namemap.strdup_strings = 1;
46 string_list_clear_func(&me->namemap, free_mailmap_info);
47}
48
49static void add_mapping(struct string_list *map,
50 char *new_name, char *new_email, char *old_name, char *old_email)
51{
52 struct mailmap_entry *me;
53 int index;
bf637803
JS
54 char *p;
55
56 if (old_email)
57 for (p = old_email; *p; p++)
58 *p = tolower(*p);
59 if (new_email)
60 for (p = new_email; *p; p++)
61 *p = tolower(*p);
62
0925ce4d
MSO
63 if (old_email == NULL) {
64 old_email = new_email;
65 new_email = NULL;
66 }
67
68 if ((index = string_list_find_insert_index(map, old_email, 1)) < 0) {
69 /* mailmap entry exists, invert index value */
70 index = -1 - index;
71 } else {
72 /* create mailmap entry */
aadceea6 73 struct string_list_item *item = string_list_insert_at_index(map, index, old_email);
74b531f6 74 item->util = xcalloc(1, sizeof(struct mailmap_entry));
0925ce4d
MSO
75 ((struct mailmap_entry *)item->util)->namemap.strdup_strings = 1;
76 }
77 me = (struct mailmap_entry *)map->items[index].util;
78
79 if (old_name == NULL) {
80 debug_mm("mailmap: adding (simple) entry for %s at index %d\n", old_email, index);
81 /* Replace current name and new email for simple entry */
d8d2eb7d
JM
82 if (new_name) {
83 free(me->name);
0925ce4d 84 me->name = xstrdup(new_name);
d8d2eb7d
JM
85 }
86 if (new_email) {
87 free(me->email);
0925ce4d 88 me->email = xstrdup(new_email);
d8d2eb7d 89 }
0925ce4d 90 } else {
74b531f6 91 struct mailmap_info *mi = xcalloc(1, sizeof(struct mailmap_info));
0925ce4d
MSO
92 debug_mm("mailmap: adding (complex) entry for %s at index %d\n", old_email, index);
93 if (new_name)
94 mi->name = xstrdup(new_name);
95 if (new_email)
96 mi->email = xstrdup(new_email);
78a395d3 97 string_list_insert(&me->namemap, old_name)->util = mi;
0925ce4d
MSO
98 }
99
100 debug_mm("mailmap: '%s' <%s> -> '%s' <%s>\n",
101 old_name, old_email, new_name, new_email);
102}
103
5288dd58
BS
104static char *parse_name_and_email(char *buffer, char **name,
105 char **email, int allow_empty_email)
0925ce4d
MSO
106{
107 char *left, *right, *nstart, *nend;
2af202be 108 *name = *email = NULL;
0925ce4d
MSO
109
110 if ((left = strchr(buffer, '<')) == NULL)
111 return NULL;
112 if ((right = strchr(left+1, '>')) == NULL)
113 return NULL;
5288dd58 114 if (!allow_empty_email && (left+1 == right))
0925ce4d
MSO
115 return NULL;
116
117 /* remove whitespace from beginning and end of name */
118 nstart = buffer;
119 while (isspace(*nstart) && nstart < left)
120 ++nstart;
121 nend = left-1;
3174bc5c 122 while (nend > nstart && isspace(*nend))
0925ce4d
MSO
123 --nend;
124
125 *name = (nstart < nend ? nstart : NULL);
126 *email = left+1;
127 *(nend+1) = '\0';
128 *right++ = '\0';
129
130 return (*right == '\0' ? NULL : right);
131}
132
7c8ce308
JK
133static void read_mailmap_line(struct string_list *map, char *buffer,
134 char **repo_abbrev)
135{
136 char *name1 = NULL, *email1 = NULL, *name2 = NULL, *email2 = NULL;
137 if (buffer[0] == '#') {
138 static const char abbrev[] = "# repo-abbrev:";
139 int abblen = sizeof(abbrev) - 1;
140 int len = strlen(buffer);
141
142 if (!repo_abbrev)
143 return;
144
145 if (len && buffer[len - 1] == '\n')
146 buffer[--len] = 0;
147 if (!strncmp(buffer, abbrev, abblen)) {
148 char *cp;
149
150 if (repo_abbrev)
151 free(*repo_abbrev);
152 *repo_abbrev = xmalloc(len);
153
154 for (cp = buffer + abblen; isspace(*cp); cp++)
155 ; /* nothing */
156 strcpy(*repo_abbrev, cp);
157 }
158 return;
159 }
160 if ((name2 = parse_name_and_email(buffer, &name1, &email1, 0)) != NULL)
161 parse_name_and_email(name2, &name2, &email2, 1);
162
163 if (email1)
164 add_mapping(map, name1, email1, name2, email2);
165}
166
167static int read_mailmap_file(struct string_list *map, const char *filename,
168 char **repo_abbrev)
7c1c6782
JH
169{
170 char buffer[1024];
938a60d6
JK
171 FILE *f;
172
173 if (!filename)
174 return 0;
175
176 f = fopen(filename, "r");
177 if (!f) {
178 if (errno == ENOENT)
179 return 0;
180 return error("unable to open mailmap at %s: %s",
181 filename, strerror(errno));
182 }
7c1c6782 183
7c8ce308
JK
184 while (fgets(buffer, sizeof(buffer), f) != NULL)
185 read_mailmap_line(map, buffer, repo_abbrev);
7c1c6782
JH
186 fclose(f);
187 return 0;
188}
189
08610900
JK
190static void read_mailmap_buf(struct string_list *map,
191 const char *buf, unsigned long len,
192 char **repo_abbrev)
193{
194 while (len) {
195 const char *end = strchrnul(buf, '\n');
196 unsigned long linelen = end - buf + 1;
197 char *line = xmemdupz(buf, linelen);
198
199 read_mailmap_line(map, line, repo_abbrev);
200
201 free(line);
202 buf += linelen;
203 len -= linelen;
204 }
205}
206
207static int read_mailmap_blob(struct string_list *map,
208 const char *name,
209 char **repo_abbrev)
210{
211 unsigned char sha1[20];
212 char *buf;
213 unsigned long size;
214 enum object_type type;
215
216 if (!name)
938a60d6 217 return 0;
08610900 218 if (get_sha1(name, sha1) < 0)
938a60d6 219 return 0;
08610900
JK
220
221 buf = read_sha1_file(sha1, &type, &size);
222 if (!buf)
938a60d6 223 return error("unable to read mailmap object at %s", name);
08610900 224 if (type != OBJ_BLOB)
938a60d6 225 return error("mailmap is not a blob: %s", name);
08610900
JK
226
227 read_mailmap_buf(map, buf, size, repo_abbrev);
228
229 free(buf);
230 return 0;
231}
232
d551a488
MSO
233int read_mailmap(struct string_list *map, char **repo_abbrev)
234{
938a60d6 235 int err = 0;
0925ce4d 236 map->strdup_strings = 1;
938a60d6
JK
237 err |= read_mailmap_file(map, ".mailmap", repo_abbrev);
238 err |= read_mailmap_blob(map, git_mailmap_blob, repo_abbrev);
239 err |= read_mailmap_file(map, git_mailmap_file, repo_abbrev);
240 return err;
d551a488
MSO
241}
242
0925ce4d
MSO
243void clear_mailmap(struct string_list *map)
244{
245 debug_mm("mailmap: clearing %d entries...\n", map->nr);
246 map->strdup_strings = 1;
247 string_list_clear_func(map, free_mailmap_entry);
248 debug_mm("mailmap: cleared\n");
249}
250
251int map_user(struct string_list *map,
252 char *email, int maxlen_email, char *name, int maxlen_name)
7c1c6782 253{
f026358e 254 char *end_of_email;
c455c87c 255 struct string_list_item *item;
0925ce4d 256 struct mailmap_entry *me;
7c1c6782
JH
257 char buf[1024], *mailbuf;
258 int i;
259
0925ce4d 260 /* figure out space requirement for email */
f026358e
JH
261 end_of_email = strchr(email, '>');
262 if (!end_of_email) {
0925ce4d 263 /* email passed in might not be wrapped in <>, but end with a \0 */
f026358e
JH
264 end_of_email = memchr(email, '\0', maxlen_email);
265 if (!end_of_email)
0925ce4d
MSO
266 return 0;
267 }
f026358e 268 if (end_of_email - email + 1 < sizeof(buf))
7c1c6782
JH
269 mailbuf = buf;
270 else
f026358e 271 mailbuf = xmalloc(end_of_email - email + 1);
7c1c6782
JH
272
273 /* downcase the email address */
f026358e 274 for (i = 0; i < end_of_email - email; i++)
7c1c6782
JH
275 mailbuf[i] = tolower(email[i]);
276 mailbuf[i] = 0;
0925ce4d
MSO
277
278 debug_mm("map_user: map '%s' <%s>\n", name, mailbuf);
e8c8b713 279 item = string_list_lookup(map, mailbuf);
0925ce4d
MSO
280 if (item != NULL) {
281 me = (struct mailmap_entry *)item->util;
282 if (me->namemap.nr) {
283 /* The item has multiple items, so we'll look up on name too */
284 /* If the name is not found, we choose the simple entry */
e8c8b713 285 struct string_list_item *subitem = string_list_lookup(&me->namemap, name);
0925ce4d
MSO
286 if (subitem)
287 item = subitem;
288 }
289 }
7c1c6782
JH
290 if (mailbuf != buf)
291 free(mailbuf);
292 if (item != NULL) {
0925ce4d
MSO
293 struct mailmap_info *mi = (struct mailmap_info *)item->util;
294 if (mi->name == NULL && (mi->email == NULL || maxlen_email == 0)) {
295 debug_mm("map_user: -- (no simple mapping)\n");
296 return 0;
297 }
298 if (maxlen_email && mi->email)
299 strlcpy(email, mi->email, maxlen_email);
f026358e
JH
300 else
301 *end_of_email = '\0';
0925ce4d
MSO
302 if (maxlen_name && mi->name)
303 strlcpy(name, mi->name, maxlen_name);
304 debug_mm("map_user: to '%s' <%s>\n", name, mi->email ? mi->email : "");
7c1c6782
JH
305 return 1;
306 }
0925ce4d 307 debug_mm("map_user: --\n");
7c1c6782
JH
308 return 0;
309}