Andrew's git - gitweb.git/blob

   1/*
   2 * ident.c
   3 *
   4 * create git identifier lines of the form "name <email> date"
   5 *
   6 * Copyright (C) 2005 Linus Torvalds
   7 */
   8#include "cache.h"
   9
  10static struct strbuf git_default_name = STRBUF_INIT;
  11static struct strbuf git_default_email = STRBUF_INIT;
  12static char git_default_date[50];
  13int user_ident_explicitly_given;
  14
  15#ifdef NO_GECOS_IN_PWENT
  16#define get_gecos(ignored) "&"
  17#else
  18#define get_gecos(struct_passwd) ((struct_passwd)->pw_gecos)
  19#endif
  20
  21static void copy_gecos(const struct passwd *w, struct strbuf *name)
  22{
  23        char *src;
  24
  25        /* Traditionally GECOS field had office phone numbers etc, separated
  26         * with commas.  Also & stands for capitalized form of the login name.
  27         */
  28
  29        for (src = get_gecos(w); *src && *src != ','; src++) {
  30                int ch = *src;
  31                if (ch != '&')
  32                        strbuf_addch(name, ch);
  33                else {
  34                        /* Sorry, Mr. McDonald... */
  35                        strbuf_addch(name, toupper(*w->pw_name));
  36                        strbuf_addstr(name, w->pw_name + 1);
  37                }
  38        }
  39}
  40
  41static int add_mailname_host(struct strbuf *buf)
  42{
  43        FILE *mailname;
  44
  45        mailname = fopen("/etc/mailname", "r");
  46        if (!mailname) {
  47                if (errno != ENOENT)
  48                        warning("cannot open /etc/mailname: %s",
  49                                strerror(errno));
  50                return -1;
  51        }
  52        if (strbuf_getline(buf, mailname, '\n') == EOF) {
  53                if (ferror(mailname))
  54                        warning("cannot read /etc/mailname: %s",
  55                                strerror(errno));
  56                fclose(mailname);
  57                return -1;
  58        }
  59        /* success! */
  60        fclose(mailname);
  61        return 0;
  62}
  63
  64static void add_domainname(struct strbuf *out)
  65{
  66        char buf[1024];
  67        struct hostent *he;
  68        const char *domainname;
  69
  70        if (gethostname(buf, sizeof(buf))) {
  71                warning("cannot get host name: %s", strerror(errno));
  72                strbuf_addstr(out, "(none)");
  73                return;
  74        }
  75        strbuf_addstr(out, buf);
  76        if (strchr(buf, '.'))
  77                return;
  78
  79        he = gethostbyname(buf);
  80        strbuf_addch(out, '.');
  81        if (he && (domainname = strchr(he->h_name, '.')))
  82                strbuf_addstr(out, domainname + 1);
  83        else
  84                strbuf_addstr(out, "(none)");
  85}
  86
  87static void copy_email(const struct passwd *pw, struct strbuf *email)
  88{
  89        /*
  90         * Make up a fake email address
  91         * (name + '@' + hostname [+ '.' + domainname])
  92         */
  93        strbuf_addstr(email, pw->pw_name);
  94        strbuf_addch(email, '@');
  95
  96        if (!add_mailname_host(email))
  97                return; /* read from "/etc/mailname" (Debian) */
  98        add_domainname(email);
  99}
 100
 101const char *ident_default_name(void)
 102{
 103        if (!git_default_name.len)
 104                copy_gecos(xgetpwuid_self(), &git_default_name);
 105        return git_default_name.buf;
 106}
 107
 108const char *ident_default_email(void)
 109{
 110        if (!git_default_email.len) {
 111                const char *email = getenv("EMAIL");
 112
 113                if (email && email[0]) {
 114                        strbuf_addstr(&git_default_email, email);
 115                        user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
 116                } else
 117                        copy_email(xgetpwuid_self(), &git_default_email);
 118        }
 119        return git_default_email.buf;
 120}
 121
 122const char *ident_default_date(void)
 123{
 124        if (!git_default_date[0])
 125                datestamp(git_default_date, sizeof(git_default_date));
 126        return git_default_date;
 127}
 128
 129static int add_raw(char *buf, size_t size, int offset, const char *str)
 130{
 131        size_t len = strlen(str);
 132        if (offset + len > size)
 133                return size;
 134        memcpy(buf + offset, str, len);
 135        return offset + len;
 136}
 137
 138static int crud(unsigned char c)
 139{
 140        return  c <= 32  ||
 141                c == '.' ||
 142                c == ',' ||
 143                c == ':' ||
 144                c == ';' ||
 145                c == '<' ||
 146                c == '>' ||
 147                c == '"' ||
 148                c == '\\' ||
 149                c == '\'';
 150}
 151
 152/*
 153 * Copy over a string to the destination, but avoid special
 154 * characters ('\n', '<' and '>') and remove crud at the end
 155 */
 156static int copy(char *buf, size_t size, int offset, const char *src)
 157{
 158        size_t i, len;
 159        unsigned char c;
 160
 161        /* Remove crud from the beginning.. */
 162        while ((c = *src) != 0) {
 163                if (!crud(c))
 164                        break;
 165                src++;
 166        }
 167
 168        /* Remove crud from the end.. */
 169        len = strlen(src);
 170        while (len > 0) {
 171                c = src[len-1];
 172                if (!crud(c))
 173                        break;
 174                --len;
 175        }
 176
 177        /*
 178         * Copy the rest to the buffer, but avoid the special
 179         * characters '\n' '<' and '>' that act as delimiters on
 180         * an identification line
 181         */
 182        for (i = 0; i < len; i++) {
 183                c = *src++;
 184                switch (c) {
 185                case '\n': case '<': case '>':
 186                        continue;
 187                }
 188                if (offset >= size)
 189                        return size;
 190                buf[offset++] = c;
 191        }
 192        return offset;
 193}
 194
 195/*
 196 * Reverse of fmt_ident(); given an ident line, split the fields
 197 * to allow the caller to parse it.
 198 * Signal a success by returning 0, but date/tz fields of the result
 199 * can still be NULL if the input line only has the name/email part
 200 * (e.g. reading from a reflog entry).
 201 */
 202int split_ident_line(struct ident_split *split, const char *line, int len)
 203{
 204        const char *cp;
 205        size_t span;
 206        int status = -1;
 207
 208        memset(split, 0, sizeof(*split));
 209
 210        split->name_begin = line;
 211        for (cp = line; *cp && cp < line + len; cp++)
 212                if (*cp == '<') {
 213                        split->mail_begin = cp + 1;
 214                        break;
 215                }
 216        if (!split->mail_begin)
 217                return status;
 218
 219        for (cp = split->mail_begin - 2; line < cp; cp--)
 220                if (!isspace(*cp)) {
 221                        split->name_end = cp + 1;
 222                        break;
 223                }
 224        if (!split->name_end)
 225                return status;
 226
 227        for (cp = split->mail_begin; cp < line + len; cp++)
 228                if (*cp == '>') {
 229                        split->mail_end = cp;
 230                        break;
 231                }
 232        if (!split->mail_end)
 233                return status;
 234
 235        for (cp = split->mail_end + 1; cp < line + len && isspace(*cp); cp++)
 236                ;
 237        if (line + len <= cp)
 238                goto person_only;
 239        split->date_begin = cp;
 240        span = strspn(cp, "0123456789");
 241        if (!span)
 242                goto person_only;
 243        split->date_end = split->date_begin + span;
 244        for (cp = split->date_end; cp < line + len && isspace(*cp); cp++)
 245                ;
 246        if (line + len <= cp || (*cp != '+' && *cp != '-'))
 247                goto person_only;
 248        split->tz_begin = cp;
 249        span = strspn(cp + 1, "0123456789");
 250        if (!span)
 251                goto person_only;
 252        split->tz_end = split->tz_begin + 1 + span;
 253        return 0;
 254
 255person_only:
 256        split->date_begin = NULL;
 257        split->date_end = NULL;
 258        split->tz_begin = NULL;
 259        split->tz_end = NULL;
 260        return 0;
 261}
 262
 263static const char *env_hint =
 264"\n"
 265"*** Please tell me who you are.\n"
 266"\n"
 267"Run\n"
 268"\n"
 269"  git config --global user.email \"you@example.com\"\n"
 270"  git config --global user.name \"Your Name\"\n"
 271"\n"
 272"to set your account\'s default identity.\n"
 273"Omit --global to set the identity only in this repository.\n"
 274"\n";
 275
 276const char *fmt_ident(const char *name, const char *email,
 277                      const char *date_str, int flag)
 278{
 279        static char buffer[1000];
 280        char date[50];
 281        int i;
 282        int error_on_no_name = (flag & IDENT_ERROR_ON_NO_NAME);
 283        int name_addr_only = (flag & IDENT_NO_DATE);
 284
 285        if (!name)
 286                name = ident_default_name();
 287        if (!email)
 288                email = ident_default_email();
 289
 290        if (!*name) {
 291                struct passwd *pw;
 292
 293                if (error_on_no_name) {
 294                        if (name == git_default_name.buf)
 295                                fputs(env_hint, stderr);
 296                        die("empty ident %s <%s> not allowed", name, email);
 297                }
 298                pw = xgetpwuid_self();
 299                name = pw->pw_name;
 300        }
 301
 302        strcpy(date, ident_default_date());
 303        if (!name_addr_only && date_str && date_str[0]) {
 304                if (parse_date(date_str, date, sizeof(date)) < 0)
 305                        die("invalid date format: %s", date_str);
 306        }
 307
 308        i = copy(buffer, sizeof(buffer), 0, name);
 309        i = add_raw(buffer, sizeof(buffer), i, " <");
 310        i = copy(buffer, sizeof(buffer), i, email);
 311        if (!name_addr_only) {
 312                i = add_raw(buffer, sizeof(buffer), i,  "> ");
 313                i = copy(buffer, sizeof(buffer), i, date);
 314        } else {
 315                i = add_raw(buffer, sizeof(buffer), i, ">");
 316        }
 317        if (i >= sizeof(buffer))
 318                die("Impossibly long personal identifier");
 319        buffer[i] = 0;
 320        return buffer;
 321}
 322
 323const char *fmt_name(const char *name, const char *email)
 324{
 325        return fmt_ident(name, email, NULL, IDENT_ERROR_ON_NO_NAME | IDENT_NO_DATE);
 326}
 327
 328const char *git_author_info(int flag)
 329{
 330        return fmt_ident(getenv("GIT_AUTHOR_NAME"),
 331                         getenv("GIT_AUTHOR_EMAIL"),
 332                         getenv("GIT_AUTHOR_DATE"),
 333                         flag);
 334}
 335
 336const char *git_committer_info(int flag)
 337{
 338        if (getenv("GIT_COMMITTER_NAME"))
 339                user_ident_explicitly_given |= IDENT_NAME_GIVEN;
 340        if (getenv("GIT_COMMITTER_EMAIL"))
 341                user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
 342        return fmt_ident(getenv("GIT_COMMITTER_NAME"),
 343                         getenv("GIT_COMMITTER_EMAIL"),
 344                         getenv("GIT_COMMITTER_DATE"),
 345                         flag);
 346}
 347
 348int user_ident_sufficiently_given(void)
 349{
 350#ifndef WINDOWS
 351        return (user_ident_explicitly_given & IDENT_MAIL_GIVEN);
 352#else
 353        return (user_ident_explicitly_given == IDENT_ALL_GIVEN);
 354#endif
 355}
 356
 357int git_ident_config(const char *var, const char *value, void *data)
 358{
 359        if (!strcmp(var, "user.name")) {
 360                if (!value)
 361                        return config_error_nonbool(var);
 362                strbuf_reset(&git_default_name);
 363                strbuf_addstr(&git_default_name, value);
 364                user_ident_explicitly_given |= IDENT_NAME_GIVEN;
 365                return 0;
 366        }
 367
 368        if (!strcmp(var, "user.email")) {
 369                if (!value)
 370                        return config_error_nonbool(var);
 371                strbuf_reset(&git_default_email);
 372                strbuf_addstr(&git_default_email, value);
 373                user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
 374                return 0;
 375        }
 376
 377        return 0;
 378}