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