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