ident.c

   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
  10 static char git_default_date[50];
  11
  12 static void copy_gecos(const struct passwd *w, char *name, size_t sz)
  13 {
  14         char *src, *dst;
  15         size_t len, nlen;
  16
  17         nlen = strlen(w->pw_name);
  18
  19         /* Traditionally GECOS field had office phone numbers etc, separated
  20          * with commas.  Also & stands for capitalized form of the login name.
  21          */
  22
  23         for (len = 0, dst = name, src = w->pw_gecos; len < sz; src++) {
  24                 int ch = *src;
  25                 if (ch != '&') {
  26                         *dst++ = ch;
  27                         if (ch == 0 || ch == ',')
  28                                 break;
  29                         len++;
  30                         continue;
  31                 }
  32                 if (len + nlen < sz) {
  33                         /* Sorry, Mr. McDonald... */
  34                         *dst++ = toupper(*w->pw_name);
  35                         memcpy(dst, w->pw_name + 1, nlen - 1);
  36                         dst += nlen - 1;
  37                 }
  38         }
  39         if (len < sz)
  40                 name[len] = 0;
  41         else
  42                 die("Your parents must have hated you!");
  43
  44 }
  45
  46 static void copy_email(const struct passwd *pw)
  47 {
  48         /*
  49          * Make up a fake email address
  50          * (name + '@' + hostname [+ '.' + domainname])
  51          */
  52         size_t len = strlen(pw->pw_name);
  53         if (len > sizeof(git_default_email)/2)
  54                 die("Your sysadmin must hate you!");
  55         memcpy(git_default_email, pw->pw_name, len);
  56         git_default_email[len++] = '@';
  57         gethostname(git_default_email + len, sizeof(git_default_email) - len);
  58         if (!strchr(git_default_email+len, '.')) {
  59                 struct hostent *he = gethostbyname(git_default_email + len);
  60                 char *domainname;
  61
  62                 len = strlen(git_default_email);
  63                 git_default_email[len++] = '.';
  64                 if (he && (domainname = strchr(he->h_name, '.')))
  65                         strlcpy(git_default_email + len, domainname + 1,
  66                                 sizeof(git_default_email) - len);
  67                 else
  68                         strlcpy(git_default_email + len, "(none)",
  69                                 sizeof(git_default_email) - len);
  70         }
  71 }
  72
  73 static void setup_ident(void)
  74 {
  75         struct passwd *pw = NULL;
  76
  77         /* Get the name ("gecos") */
  78         if (!git_default_name[0]) {
  79                 pw = getpwuid(getuid());
  80                 if (!pw)
  81                         die("You don't exist. Go away!");
  82                 copy_gecos(pw, git_default_name, sizeof(git_default_name));
  83         }
  84
  85         if (!git_default_email[0]) {
  86                 const char *email = getenv("EMAIL");
  87
  88                 if (email && email[0]) {
  89                         strlcpy(git_default_email, email,
  90                                 sizeof(git_default_email));
  91                         user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
  92                 } else {
  93                         if (!pw)
  94                                 pw = getpwuid(getuid());
  95                         if (!pw)
  96                                 die("You don't exist. Go away!");
  97                         copy_email(pw);
  98                 }
  99         }
 100
 101         /* And set the default date */
 102         if (!git_default_date[0])
 103                 datestamp(git_default_date, sizeof(git_default_date));
 104 }
 105
 106 static int add_raw(char *buf, size_t size, int offset, const char *str)
 107 {
 108         size_t len = strlen(str);
 109         if (offset + len > size)
 110                 return size;
 111         memcpy(buf + offset, str, len);
 112         return offset + len;
 113 }
 114
 115 static int crud(unsigned char c)
 116 {
 117         return  c <= 32  ||
 118                 c == '.' ||
 119                 c == ',' ||
 120                 c == ':' ||
 121                 c == ';' ||
 122                 c == '<' ||
 123                 c == '>' ||
 124                 c == '"' ||
 125                 c == '\\' ||
 126                 c == '\'';
 127 }
 128
 129 /*
 130  * Copy over a string to the destination, but avoid special
 131  * characters ('\n', '<' and '>') and remove crud at the end
 132  */
 133 static int copy(char *buf, size_t size, int offset, const char *src)
 134 {
 135         size_t i, len;
 136         unsigned char c;
 137
 138         /* Remove crud from the beginning.. */
 139         while ((c = *src) != 0) {
 140                 if (!crud(c))
 141                         break;
 142                 src++;
 143         }
 144
 145         /* Remove crud from the end.. */
 146         len = strlen(src);
 147         while (len > 0) {
 148                 c = src[len-1];
 149                 if (!crud(c))
 150                         break;
 151                 --len;
 152         }
 153
 154         /*
 155          * Copy the rest to the buffer, but avoid the special
 156          * characters '\n' '<' and '>' that act as delimiters on
 157          * an identification line
 158          */
 159         for (i = 0; i < len; i++) {
 160                 c = *src++;
 161                 switch (c) {
 162                 case '\n': case '<': case '>':
 163                         continue;
 164                 }
 165                 if (offset >= size)
 166                         return size;
 167                 buf[offset++] = c;
 168         }
 169         return offset;
 170 }
 171
 172 static const char *env_hint =
 173 "\n"
 174 "*** Please tell me who you are.\n"
 175 "\n"
 176 "Run\n"
 177 "\n"
 178 "  git config --global user.email \"you@example.com\"\n"
 179 "  git config --global user.name \"Your Name\"\n"
 180 "\n"
 181 "to set your account\'s default identity.\n"
 182 "Omit --global to set the identity only in this repository.\n"
 183 "\n";
 184
 185 const char *fmt_ident(const char *name, const char *email,
 186                       const char *date_str, int flag)
 187 {
 188         static char buffer[1000];
 189         char date[50];
 190         int i;
 191         int error_on_no_name = (flag & IDENT_ERROR_ON_NO_NAME);
 192         int warn_on_no_name = (flag & IDENT_WARN_ON_NO_NAME);
 193         int name_addr_only = (flag & IDENT_NO_DATE);
 194
 195         setup_ident();
 196         if (!name)
 197                 name = git_default_name;
 198         if (!email)
 199                 email = git_default_email;
 200
 201         if (!*name) {
 202                 struct passwd *pw;
 203
 204                 if ((warn_on_no_name || error_on_no_name) &&
 205                     name == git_default_name && env_hint) {
 206                         fputs(env_hint, stderr);
 207                         env_hint = NULL; /* warn only once */
 208                 }
 209                 if (error_on_no_name)
 210                         die("empty ident %s <%s> not allowed", name, email);
 211                 pw = getpwuid(getuid());
 212                 if (!pw)
 213                         die("You don't exist. Go away!");
 214                 strlcpy(git_default_name, pw->pw_name,
 215                         sizeof(git_default_name));
 216                 name = git_default_name;
 217         }
 218
 219         strcpy(date, git_default_date);
 220         if (!name_addr_only && date_str)
 221                 parse_date(date_str, date, sizeof(date));
 222
 223         i = copy(buffer, sizeof(buffer), 0, name);
 224         i = add_raw(buffer, sizeof(buffer), i, " <");
 225         i = copy(buffer, sizeof(buffer), i, email);
 226         if (!name_addr_only) {
 227                 i = add_raw(buffer, sizeof(buffer), i,  "> ");
 228                 i = copy(buffer, sizeof(buffer), i, date);
 229         } else {
 230                 i = add_raw(buffer, sizeof(buffer), i, ">");
 231         }
 232         if (i >= sizeof(buffer))
 233                 die("Impossibly long personal identifier");
 234         buffer[i] = 0;
 235         return buffer;
 236 }
 237
 238 const char *fmt_name(const char *name, const char *email)
 239 {
 240         return fmt_ident(name, email, NULL, IDENT_ERROR_ON_NO_NAME | IDENT_NO_DATE);
 241 }
 242
 243 const char *git_author_info(int flag)
 244 {
 245         return fmt_ident(getenv("GIT_AUTHOR_NAME"),
 246                          getenv("GIT_AUTHOR_EMAIL"),
 247                          getenv("GIT_AUTHOR_DATE"),
 248                          flag);
 249 }
 250
 251 const char *git_committer_info(int flag)
 252 {
 253         if (getenv("GIT_COMMITTER_NAME"))
 254                 user_ident_explicitly_given |= IDENT_NAME_GIVEN;
 255         if (getenv("GIT_COMMITTER_EMAIL"))
 256                 user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
 257         return fmt_ident(getenv("GIT_COMMITTER_NAME"),
 258                          getenv("GIT_COMMITTER_EMAIL"),
 259                          getenv("GIT_COMMITTER_DATE"),
 260                          flag);
 261 }
 262
 263 int user_ident_sufficiently_given(void)
 264 {
 265 #ifndef WINDOWS
 266         return (user_ident_explicitly_given & IDENT_MAIL_GIVEN);
 267 #else
 268         return (user_ident_explicitly_given == IDENT_ALL_GIVEN);
 269 #endif
 270 }