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                         free(*repo_abbrev);
 157                         *repo_abbrev = xmalloc(len);
 158
 159                         for (cp = buffer + abblen; isspace(*cp); cp++)
 160                                 ; /* nothing */
 161                         strcpy(*repo_abbrev, cp);
 162                 }
 163                 return;
 164         }
 165         if ((name2 = parse_name_and_email(buffer, &name1, &email1, 0)) != NULL)
 166                 parse_name_and_email(name2, &name2, &email2, 1);
 167
 168         if (email1)
 169                 add_mapping(map, name1, email1, name2, email2);
 170 }
 171
 172 static int read_mailmap_file(struct string_list *map, const char *filename,
 173                              char **repo_abbrev)
 174 {
 175         char buffer[1024];
 176         FILE *f;
 177
 178         if (!filename)
 179                 return 0;
 180
 181         f = fopen(filename, "r");
 182         if (!f) {
 183                 if (errno == ENOENT)
 184                         return 0;
 185                 return error("unable to open mailmap at %s: %s",
 186                              filename, strerror(errno));
 187         }
 188
 189         while (fgets(buffer, sizeof(buffer), f) != NULL)
 190                 read_mailmap_line(map, buffer, repo_abbrev);
 191         fclose(f);
 192         return 0;
 193 }
 194
 195 static void read_mailmap_string(struct string_list *map, char *buf,
 196                                 char **repo_abbrev)
 197 {
 198         while (*buf) {
 199                 char *end = strchrnul(buf, '\n');
 200
 201                 if (*end)
 202                         *end++ = '\0';
 203
 204                 read_mailmap_line(map, buf, repo_abbrev);
 205                 buf = end;
 206         }
 207 }
 208
 209 static int read_mailmap_blob(struct string_list *map,
 210                              const char *name,
 211                              char **repo_abbrev)
 212 {
 213         unsigned char sha1[20];
 214         char *buf;
 215         unsigned long size;
 216         enum object_type type;
 217
 218         if (!name)
 219                 return 0;
 220         if (get_sha1(name, sha1) < 0)
 221                 return 0;
 222
 223         buf = read_sha1_file(sha1, &type, &size);
 224         if (!buf)
 225                 return error("unable to read mailmap object at %s", name);
 226         if (type != OBJ_BLOB)
 227                 return error("mailmap is not a blob: %s", name);
 228
 229         read_mailmap_string(map, buf, repo_abbrev);
 230
 231         free(buf);
 232         return 0;
 233 }
 234
 235 int read_mailmap(struct string_list *map, char **repo_abbrev)
 236 {
 237         int err = 0;
 238
 239         map->strdup_strings = 1;
 240         map->cmp = strcasecmp;
 241
 242         if (!git_mailmap_blob && is_bare_repository())
 243                 git_mailmap_blob = "HEAD:.mailmap";
 244
 245         err |= read_mailmap_file(map, ".mailmap", repo_abbrev);
 246         err |= read_mailmap_blob(map, git_mailmap_blob, repo_abbrev);
 247         err |= read_mailmap_file(map, git_mailmap_file, repo_abbrev);
 248         return err;
 249 }
 250
 251 void clear_mailmap(struct string_list *map)
 252 {
 253         debug_mm("mailmap: clearing %d entries...\n", map->nr);
 254         map->strdup_strings = 1;
 255         string_list_clear_func(map, free_mailmap_entry);
 256         debug_mm("mailmap: cleared\n");
 257 }
 258
 259 /*
 260  * Look for an entry in map that match string[0:len]; string[len]
 261  * does not have to be NUL (but it could be).
 262  */
 263 static struct string_list_item *lookup_prefix(struct string_list *map,
 264                                               const char *string, size_t len)
 265 {
 266         int i = string_list_find_insert_index(map, string, 1);
 267         if (i < 0) {
 268                 /* exact match */
 269                 i = -1 - i;
 270                 if (!string[len])
 271                         return &map->items[i];
 272                 /*
 273                  * that map entry matches exactly to the string, including
 274                  * the cruft at the end beyond "len".  That is not a match
 275                  * with string[0:len] that we are looking for.
 276                  */
 277         } else if (!string[len]) {
 278                 /*
 279                  * asked with the whole string, and got nothing.  No
 280                  * matching entry can exist in the map.
 281                  */
 282                 return NULL;
 283         }
 284
 285         /*
 286          * i is at the exact match to an overlong key, or location the
 287          * overlong key would be inserted, which must come after the
 288          * real location of the key if one exists.
 289          */
 290         while (0 <= --i && i < map->nr) {
 291                 int cmp = strncasecmp(map->items[i].string, string, len);
 292                 if (cmp < 0)
 293                         /*
 294                          * "i" points at a key definitely below the prefix;
 295                          * the map does not have string[0:len] in it.
 296                          */
 297                         break;
 298                 else if (!cmp && !map->items[i].string[len])
 299                         /* found it */
 300                         return &map->items[i];
 301                 /*
 302                  * otherwise, the string at "i" may be string[0:len]
 303                  * followed by a string that sorts later than string[len:];
 304                  * keep trying.
 305                  */
 306         }
 307         return NULL;
 308 }
 309
 310 int map_user(struct string_list *map,
 311              const char **email, size_t *emaillen,
 312              const char **name, size_t *namelen)
 313 {
 314         struct string_list_item *item;
 315         struct mailmap_entry *me;
 316
 317         debug_mm("map_user: map '%.*s' <%.*s>\n",
 318                  (int)*namelen, debug_str(*name),
 319                  (int)*emaillen, debug_str(*email));
 320
 321         item = lookup_prefix(map, *email, *emaillen);
 322         if (item != NULL) {
 323                 me = (struct mailmap_entry *)item->util;
 324                 if (me->namemap.nr) {
 325                         /*
 326                          * The item has multiple items, so we'll look up on
 327                          * name too. If the name is not found, we choose the
 328                          * simple entry.
 329                          */
 330                         struct string_list_item *subitem;
 331                         subitem = lookup_prefix(&me->namemap, *name, *namelen);
 332                         if (subitem)
 333                                 item = subitem;
 334                 }
 335         }
 336         if (item != NULL) {
 337                 struct mailmap_info *mi = (struct mailmap_info *)item->util;
 338                 if (mi->name == NULL && mi->email == NULL) {
 339                         debug_mm("map_user:  -- (no simple mapping)\n");
 340                         return 0;
 341                 }
 342                 if (mi->email) {
 343                                 *email = mi->email;
 344                                 *emaillen = strlen(*email);
 345                 }
 346                 if (mi->name) {
 347                                 *name = mi->name;
 348                                 *namelen = strlen(*name);
 349                 }
 350                 debug_mm("map_user:  to '%.*s' <%.*s>\n",
 351                          (int)*namelen, debug_str(*name),
 352                          (int)*emaillen, debug_str(*email));
 353                 return 1;
 354         }
 355         debug_mm("map_user:  --\n");
 356         return 0;
 357 }