[thirdparty/git.git] / ident.c

/*
 * ident.c
 *
 * create git identifier lines of the form "name <email> date"
 *
 * Copyright (C) 2005 Linus Torvalds
 */
#include "cache.h"
#include "config.h"

static struct strbuf git_default_name = STRBUF_INIT;
static struct strbuf git_default_email = STRBUF_INIT;
static struct strbuf git_default_date = STRBUF_INIT;
static struct strbuf git_author_name = STRBUF_INIT;
static struct strbuf git_author_email = STRBUF_INIT;
static struct strbuf git_committer_name = STRBUF_INIT;
static struct strbuf git_committer_email = STRBUF_INIT;
static int default_email_is_bogus;
static int default_name_is_bogus;

static int ident_use_config_only;

#define IDENT_NAME_GIVEN 01
#define IDENT_MAIL_GIVEN 02
#define IDENT_ALL_GIVEN (IDENT_NAME_GIVEN|IDENT_MAIL_GIVEN)
static int committer_ident_explicitly_given;
static int author_ident_explicitly_given;
static int ident_config_given;

#ifdef NO_GECOS_IN_PWENT
#define get_gecos(ignored) "&"
#else
#define get_gecos(struct_passwd) ((struct_passwd)->pw_gecos)
#endif

static struct passwd *xgetpwuid_self(int *is_bogus)
{
	struct passwd *pw;

	errno = 0;
	pw = getpwuid(getuid());
	if (!pw) {
		static struct passwd fallback;
		fallback.pw_name = "unknown";
#ifndef NO_GECOS_IN_PWENT
		fallback.pw_gecos = "Unknown";
#endif
		pw = &fallback;
		if (is_bogus)
			*is_bogus = 1;
	}
	return pw;
}

static void copy_gecos(const struct passwd *w, struct strbuf *name)
{
	char *src;

	/* Traditionally GECOS field had office phone numbers etc, separated
	 * with commas.  Also & stands for capitalized form of the login name.
	 */

	for (src = get_gecos(w); *src && *src != ','; src++) {
		int ch = *src;
		if (ch != '&')
			strbuf_addch(name, ch);
		else {
			/* Sorry, Mr. McDonald... */
			strbuf_addch(name, toupper(*w->pw_name));
			strbuf_addstr(name, w->pw_name + 1);
		}
	}
}

static int add_mailname_host(struct strbuf *buf)
{
	FILE *mailname;
	struct strbuf mailnamebuf = STRBUF_INIT;

	mailname = fopen_or_warn("/etc/mailname", "r");
	if (!mailname)
		return -1;

	if (strbuf_getline(&mailnamebuf, mailname) == EOF) {
		if (ferror(mailname))
			warning_errno("cannot read /etc/mailname");
		strbuf_release(&mailnamebuf);
		fclose(mailname);
		return -1;
	}
	/* success! */
	strbuf_addbuf(buf, &mailnamebuf);
	strbuf_release(&mailnamebuf);
	fclose(mailname);
	return 0;
}

static int canonical_name(const char *host, struct strbuf *out)
{
	int status = -1;

#ifndef NO_IPV6
	struct addrinfo hints, *ai;
	memset (&hints, '\0', sizeof (hints));
	hints.ai_flags = AI_CANONNAME;
	if (!getaddrinfo(host, NULL, &hints, &ai)) {
		if (ai && ai->ai_canonname && strchr(ai->ai_canonname, '.')) {
			strbuf_addstr(out, ai->ai_canonname);
			status = 0;
		}
		freeaddrinfo(ai);
	}
#else
	struct hostent *he = gethostbyname(host);
	if (he && strchr(he->h_name, '.')) {
		strbuf_addstr(out, he->h_name);
		status = 0;
	}
#endif /* NO_IPV6 */

	return status;
}

static void add_domainname(struct strbuf *out, int *is_bogus)
{
	char buf[HOST_NAME_MAX + 1];

	if (xgethostname(buf, sizeof(buf))) {
		warning_errno("cannot get host name");
		strbuf_addstr(out, "(none)");
		*is_bogus = 1;
		return;
	}
	if (strchr(buf, '.'))
		strbuf_addstr(out, buf);
	else if (canonical_name(buf, out) < 0) {
		strbuf_addf(out, "%s.(none)", buf);
		*is_bogus = 1;
	}
}

static void copy_email(const struct passwd *pw, struct strbuf *email,
		       int *is_bogus)
{
	/*
	 * Make up a fake email address
	 * (name + '@' + hostname [+ '.' + domainname])
	 */
	strbuf_addstr(email, pw->pw_name);
	strbuf_addch(email, '@');

	if (!add_mailname_host(email))
		return;	/* read from "/etc/mailname" (Debian) */
	add_domainname(email, is_bogus);
}

const char *ident_default_name(void)
{
	if (!(ident_config_given & IDENT_NAME_GIVEN) && !git_default_name.len) {
		copy_gecos(xgetpwuid_self(&default_name_is_bogus), &git_default_name);
		strbuf_trim(&git_default_name);
	}
	return git_default_name.buf;
}

const char *ident_default_email(void)
{
	if (!(ident_config_given & IDENT_MAIL_GIVEN) && !git_default_email.len) {
		const char *email = getenv("EMAIL");

		if (email && email[0]) {
			strbuf_addstr(&git_default_email, email);
			committer_ident_explicitly_given |= IDENT_MAIL_GIVEN;
			author_ident_explicitly_given |= IDENT_MAIL_GIVEN;
		} else if ((email = query_user_email()) && email[0]) {
			strbuf_addstr(&git_default_email, email);
			free((char *)email);
		} else
			copy_email(xgetpwuid_self(&default_email_is_bogus),
				   &git_default_email, &default_email_is_bogus);
		strbuf_trim(&git_default_email);
	}
	return git_default_email.buf;
}

static const char *ident_default_date(void)
{
	if (!git_default_date.len)
		datestamp(&git_default_date);
	return git_default_date.buf;
}

void reset_ident_date(void)
{
	strbuf_reset(&git_default_date);
}

static int crud(unsigned char c)
{
	return  c <= 32  ||
		c == '.' ||
		c == ',' ||
		c == ':' ||
		c == ';' ||
		c == '<' ||
		c == '>' ||
		c == '"' ||
		c == '\\' ||
		c == '\'';
}

static int has_non_crud(const char *str)
{
	for (; *str; str++) {
		if (!crud(*str))
			return 1;
	}
	return 0;
}

/*
 * Copy over a string to the destination, but avoid special
 * characters ('\n', '<' and '>') and remove crud at the end
 */
static void strbuf_addstr_without_crud(struct strbuf *sb, const char *src)
{
	size_t i, len;
	unsigned char c;

	/* Remove crud from the beginning.. */
	while ((c = *src) != 0) {
		if (!crud(c))
			break;
		src++;
	}

	/* Remove crud from the end.. */
	len = strlen(src);
	while (len > 0) {
		c = src[len-1];
		if (!crud(c))
			break;
		--len;
	}

	/*
	 * Copy the rest to the buffer, but avoid the special
	 * characters '\n' '<' and '>' that act as delimiters on
	 * an identification line. We can only remove crud, never add it,
	 * so 'len' is our maximum.
	 */
	strbuf_grow(sb, len);
	for (i = 0; i < len; i++) {
		c = *src++;
		switch (c) {
		case '\n': case '<': case '>':
			continue;
		}
		sb->buf[sb->len++] = c;
	}
	sb->buf[sb->len] = '\0';
}

/*
 * Reverse of fmt_ident(); given an ident line, split the fields
 * to allow the caller to parse it.
 * Signal a success by returning 0, but date/tz fields of the result
 * can still be NULL if the input line only has the name/email part
 * (e.g. reading from a reflog entry).
 */
int split_ident_line(struct ident_split *split, const char *line, int len)
{
	const char *cp;
	size_t span;
	int status = -1;

	memset(split, 0, sizeof(*split));

	split->name_begin = line;
	for (cp = line; *cp && cp < line + len; cp++)
		if (*cp == '<') {
			split->mail_begin = cp + 1;
			break;
		}
	if (!split->mail_begin)
		return status;

	for (cp = split->mail_begin - 2; line <= cp; cp--)
		if (!isspace(*cp)) {
			split->name_end = cp + 1;
			break;
		}
	if (!split->name_end) {
		/* no human readable name */
		split->name_end = split->name_begin;
	}

	for (cp = split->mail_begin; cp < line + len; cp++)
		if (*cp == '>') {
			split->mail_end = cp;
			break;
		}
	if (!split->mail_end)
		return status;

	/*
	 * Look from the end-of-line to find the trailing ">" of the mail
	 * address, even though we should already know it as split->mail_end.
	 * This can help in cases of broken idents with an extra ">" somewhere
	 * in the email address.  Note that we are assuming the timestamp will
	 * never have a ">" in it.
	 *
	 * Note that we will always find some ">" before going off the front of
	 * the string, because will always hit the split->mail_end closing
	 * bracket.
	 */
	for (cp = line + len - 1; *cp != '>'; cp--)
		;

	for (cp = cp + 1; cp < line + len && isspace(*cp); cp++)
		;
	if (line + len <= cp)
		goto person_only;
	split->date_begin = cp;
	span = strspn(cp, "0123456789");
	if (!span)
		goto person_only;
	split->date_end = split->date_begin + span;
	for (cp = split->date_end; cp < line + len && isspace(*cp); cp++)
		;
	if (line + len <= cp || (*cp != '+' && *cp != '-'))
		goto person_only;
	split->tz_begin = cp;
	span = strspn(cp + 1, "0123456789");
	if (!span)
		goto person_only;
	split->tz_end = split->tz_begin + 1 + span;
	return 0;

person_only:
	split->date_begin = NULL;
	split->date_end = NULL;
	split->tz_begin = NULL;
	split->tz_end = NULL;
	return 0;
}

static const char *env_hint =
N_("\n"
   "*** Please tell me who you are.\n"
   "\n"
   "Run\n"
   "\n"
   "  git config --global user.email \"you@example.com\"\n"
   "  git config --global user.name \"Your Name\"\n"
   "\n"
   "to set your account\'s default identity.\n"
   "Omit --global to set the identity only in this repository.\n"
   "\n");

const char *fmt_ident(const char *name, const char *email,
		      enum want_ident whose_ident, const char *date_str, int flag)
{
	static struct strbuf ident = STRBUF_INIT;
	int strict = (flag & IDENT_STRICT);
	int want_date = !(flag & IDENT_NO_DATE);
	int want_name = !(flag & IDENT_NO_NAME);

	if (!email) {
		if (whose_ident == WANT_AUTHOR_IDENT && git_author_email.len)
			email = git_author_email.buf;
		else if (whose_ident == WANT_COMMITTER_IDENT && git_committer_email.len)
			email = git_committer_email.buf;
	}
	if (!email) {
		if (strict && ident_use_config_only
		    && !(ident_config_given & IDENT_MAIL_GIVEN)) {
			fputs(_(env_hint), stderr);
			die(_("no email was given and auto-detection is disabled"));
		}
		email = ident_default_email();
		if (strict && default_email_is_bogus) {
			fputs(_(env_hint), stderr);
			die(_("unable to auto-detect email address (got '%s')"), email);
		}
	}

	if (want_name) {
		int using_default = 0;
		if (!name) {
			if (whose_ident == WANT_AUTHOR_IDENT && git_author_name.len)
				name = git_author_name.buf;
			else if (whose_ident == WANT_COMMITTER_IDENT &&
					git_committer_name.len)
				name = git_committer_name.buf;
		}
		if (!name) {
			if (strict && ident_use_config_only
			    && !(ident_config_given & IDENT_NAME_GIVEN)) {
				fputs(_(env_hint), stderr);
				die(_("no name was given and auto-detection is disabled"));
			}
			name = ident_default_name();
			using_default = 1;
			if (strict && default_name_is_bogus) {
				fputs(_(env_hint), stderr);
				die(_("unable to auto-detect name (got '%s')"), name);
			}
		}
		if (!*name) {
			struct passwd *pw;
			if (strict) {
				if (using_default)
					fputs(_(env_hint), stderr);
				die(_("empty ident name (for <%s>) not allowed"), email);
			}
			pw = xgetpwuid_self(NULL);
			name = pw->pw_name;
		}
		if (strict && !has_non_crud(name))
			die(_("name consists only of disallowed characters: %s"), name);
	}

	strbuf_reset(&ident);
	if (want_name) {
		strbuf_addstr_without_crud(&ident, name);
		strbuf_addstr(&ident, " <");
	}
	strbuf_addstr_without_crud(&ident, email);
	if (want_name)
			strbuf_addch(&ident, '>');
	if (want_date) {
		strbuf_addch(&ident, ' ');
		if (date_str && date_str[0]) {
			if (parse_date(date_str, &ident) < 0)
				die(_("invalid date format: %s"), date_str);
		}
		else
			strbuf_addstr(&ident, ident_default_date());
	}

	return ident.buf;
}

const char *fmt_name(enum want_ident whose_ident)
{
	char *name = NULL;
	char *email = NULL;

	switch (whose_ident) {
	case WANT_BLANK_IDENT:
		break;
	case WANT_AUTHOR_IDENT:
		name = getenv("GIT_AUTHOR_NAME");
		email = getenv("GIT_AUTHOR_EMAIL");
		break;
	case WANT_COMMITTER_IDENT:
		name = getenv("GIT_COMMITTER_NAME");
		email = getenv("GIT_COMMITTER_EMAIL");
		break;
	}
	return fmt_ident(name, email, whose_ident, NULL,
			IDENT_STRICT | IDENT_NO_DATE);
}

const char *git_author_info(int flag)
{
	if (getenv("GIT_AUTHOR_NAME"))
		author_ident_explicitly_given |= IDENT_NAME_GIVEN;
	if (getenv("GIT_AUTHOR_EMAIL"))
		author_ident_explicitly_given |= IDENT_MAIL_GIVEN;
	return fmt_ident(getenv("GIT_AUTHOR_NAME"),
			 getenv("GIT_AUTHOR_EMAIL"),
			 WANT_AUTHOR_IDENT,
			 getenv("GIT_AUTHOR_DATE"),
			 flag);
}

const char *git_committer_info(int flag)
{
	if (getenv("GIT_COMMITTER_NAME"))
		committer_ident_explicitly_given |= IDENT_NAME_GIVEN;
	if (getenv("GIT_COMMITTER_EMAIL"))
		committer_ident_explicitly_given |= IDENT_MAIL_GIVEN;
	return fmt_ident(getenv("GIT_COMMITTER_NAME"),
			 getenv("GIT_COMMITTER_EMAIL"),
			 WANT_COMMITTER_IDENT,
			 getenv("GIT_COMMITTER_DATE"),
			 flag);
}

static int ident_is_sufficient(int user_ident_explicitly_given)
{
#ifndef WINDOWS
	return (user_ident_explicitly_given & IDENT_MAIL_GIVEN);
#else
	return (user_ident_explicitly_given == IDENT_ALL_GIVEN);
#endif
}

int committer_ident_sufficiently_given(void)
{
	return ident_is_sufficient(committer_ident_explicitly_given);
}

int author_ident_sufficiently_given(void)
{
	return ident_is_sufficient(author_ident_explicitly_given);
}

static int set_ident(const char *var, const char *value)
{
	if (!strcmp(var, "author.name")) {
		if (!value)
			return config_error_nonbool(var);
		strbuf_reset(&git_author_name);
		strbuf_addstr(&git_author_name, value);
		author_ident_explicitly_given |= IDENT_NAME_GIVEN;
		ident_config_given |= IDENT_NAME_GIVEN;
		return 0;
	}

	if (!strcmp(var, "author.email")) {
		if (!value)
			return config_error_nonbool(var);
		strbuf_reset(&git_author_email);
		strbuf_addstr(&git_author_email, value);
		author_ident_explicitly_given |= IDENT_MAIL_GIVEN;
		ident_config_given |= IDENT_MAIL_GIVEN;
		return 0;
	}

	if (!strcmp(var, "committer.name")) {
		if (!value)
			return config_error_nonbool(var);
		strbuf_reset(&git_committer_name);
		strbuf_addstr(&git_committer_name, value);
		committer_ident_explicitly_given |= IDENT_NAME_GIVEN;
		ident_config_given |= IDENT_NAME_GIVEN;
		return 0;
	}

	if (!strcmp(var, "committer.email")) {
		if (!value)
			return config_error_nonbool(var);
		strbuf_reset(&git_committer_email);
		strbuf_addstr(&git_committer_email, value);
		committer_ident_explicitly_given |= IDENT_MAIL_GIVEN;
		ident_config_given |= IDENT_MAIL_GIVEN;
		return 0;
	}

	if (!strcmp(var, "user.name")) {
		if (!value)
			return config_error_nonbool(var);
		strbuf_reset(&git_default_name);
		strbuf_addstr(&git_default_name, value);
		committer_ident_explicitly_given |= IDENT_NAME_GIVEN;
		author_ident_explicitly_given |= IDENT_NAME_GIVEN;
		ident_config_given |= IDENT_NAME_GIVEN;
		return 0;
	}

	if (!strcmp(var, "user.email")) {
		if (!value)
			return config_error_nonbool(var);
		strbuf_reset(&git_default_email);
		strbuf_addstr(&git_default_email, value);
		committer_ident_explicitly_given |= IDENT_MAIL_GIVEN;
		author_ident_explicitly_given |= IDENT_MAIL_GIVEN;
		ident_config_given |= IDENT_MAIL_GIVEN;
		return 0;
	}

	return 0;
}

int git_ident_config(const char *var, const char *value, void *data)
{
	if (!strcmp(var, "user.useconfigonly")) {
		ident_use_config_only = git_config_bool(var, value);
		return 0;
	}

	return set_ident(var, value);
}

static void set_env_if(const char *key, const char *value, int *given, int bit)
{
	if ((*given & bit) || getenv(key))
		return; /* nothing to do */
	setenv(key, value, 0);
	*given |= bit;
}

void prepare_fallback_ident(const char *name, const char *email)
{
	set_env_if("GIT_AUTHOR_NAME", name,
		   &author_ident_explicitly_given, IDENT_NAME_GIVEN);
	set_env_if("GIT_AUTHOR_EMAIL", email,
		   &author_ident_explicitly_given, IDENT_MAIL_GIVEN);
	set_env_if("GIT_COMMITTER_NAME", name,
		   &committer_ident_explicitly_given, IDENT_NAME_GIVEN);
	set_env_if("GIT_COMMITTER_EMAIL", email,
		   &committer_ident_explicitly_given, IDENT_MAIL_GIVEN);
}

static int buf_cmp(const char *a_begin, const char *a_end,
		   const char *b_begin, const char *b_end)
{
	int a_len = a_end - a_begin;
	int b_len = b_end - b_begin;
	int min = a_len < b_len ? a_len : b_len;
	int cmp;

	cmp = memcmp(a_begin, b_begin, min);
	if (cmp)
		return cmp;

	return a_len - b_len;
}

int ident_cmp(const struct ident_split *a,
	      const struct ident_split *b)
{
	int cmp;

	cmp = buf_cmp(a->mail_begin, a->mail_end,
		      b->mail_begin, b->mail_end);
	if (cmp)
		return cmp;

	return buf_cmp(a->name_begin, a->name_end,
		       b->name_begin, b->name_end);
}
Commit	Line	Data
6aa33f40 LT	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"
b2141fc1	9	#include "config.h"
6aa33f40	10
8587ead7 JK	11	static struct strbuf git_default_name = STRBUF_INIT;
8587ead7 JK	12	static struct strbuf git_default_email = STRBUF_INIT;
c33ddc2e	13	static struct strbuf git_default_date = STRBUF_INIT;
39ab4d09 WH	14	static struct strbuf git_author_name = STRBUF_INIT;
	15	static struct strbuf git_author_email = STRBUF_INIT;
	16	static struct strbuf git_committer_name = STRBUF_INIT;
	17	static struct strbuf git_committer_email = STRBUF_INIT;
19ce497c	18	static int default_email_is_bogus;
92bcbb9b	19	static int default_name_is_bogus;
45280230	20
4d5c2956 DA	21	static int ident_use_config_only;
4d5c2956 DA	22
45280230 JK	23	#define IDENT_NAME_GIVEN 01
	24	#define IDENT_MAIL_GIVEN 02
	25	#define IDENT_ALL_GIVEN (IDENT_NAME_GIVEN\|IDENT_MAIL_GIVEN)
d6991cee JK	26	static int committer_ident_explicitly_given;
d6991cee JK	27	static int author_ident_explicitly_given;
4d5c2956	28	static int ident_config_given;
6aa33f40	29
590e081d RG	30	#ifdef NO_GECOS_IN_PWENT
	31	#define get_gecos(ignored) "&"
	32	#else
	33	#define get_gecos(struct_passwd) ((struct_passwd)->pw_gecos)
	34	#endif
	35
92bcbb9b	36	static struct passwd xgetpwuid_self(int is_bogus)
e850194c JK	37	{
	38	struct passwd *pw;
	39
	40	errno = 0;
	41	pw = getpwuid(getuid());
92bcbb9b JK	42	if (!pw) {
	43	static struct passwd fallback;
	44	fallback.pw_name = "unknown";
	45	#ifndef NO_GECOS_IN_PWENT
	46	fallback.pw_gecos = "Unknown";
	47	#endif
	48	pw = &fallback;
	49	if (is_bogus)
	50	*is_bogus = 1;
	51	}
e850194c JK	52	return pw;
	53	}
	54
8587ead7	55	static void copy_gecos(const struct passwd w, struct strbuf name)
e9bacb4f	56	{
8587ead7	57	char *src;
e9bacb4f JH	58
	59	/* Traditionally GECOS field had office phone numbers etc, separated
	60	* with commas. Also & stands for capitalized form of the login name.
	61	*/
	62
8587ead7	63	for (src = get_gecos(w); src && src != ','; src++) {
e9bacb4f	64	int ch = *src;
8587ead7 JK	65	if (ch != '&')
	66	strbuf_addch(name, ch);
	67	else {
e9bacb4f	68	/* Sorry, Mr. McDonald... */
8587ead7 JK	69	strbuf_addch(name, toupper(*w->pw_name));
8587ead7 JK	70	strbuf_addstr(name, w->pw_name + 1);
e9bacb4f JH	71	}
e9bacb4f JH	72	}
e9bacb4f JH	73	}
e9bacb4f JH	74
8587ead7	75	static int add_mailname_host(struct strbuf *buf)
8a55caa8 JN	76	{
8a55caa8 JN	77	FILE *mailname;
dc342a25	78	struct strbuf mailnamebuf = STRBUF_INIT;
8a55caa8	79
e9d983f1 NTND	80	mailname = fopen_or_warn("/etc/mailname", "r");
e9d983f1 NTND	81	if (!mailname)
8a55caa8	82	return -1;
e9d983f1	83
1f3b1efd	84	if (strbuf_getline(&mailnamebuf, mailname) == EOF) {
8a55caa8	85	if (ferror(mailname))
a26f4ed6	86	warning_errno("cannot read /etc/mailname");
dc342a25	87	strbuf_release(&mailnamebuf);
8a55caa8 JN	88	fclose(mailname);
	89	return -1;
	90	}
	91	/* success! */
dc342a25 JN	92	strbuf_addbuf(buf, &mailnamebuf);
dc342a25 JN	93	strbuf_release(&mailnamebuf);
8a55caa8 JN	94	fclose(mailname);
	95	return 0;
	96	}
	97
00bce77f EP	98	static int canonical_name(const char host, struct strbuf out)
	99	{
	100	int status = -1;
	101
	102	#ifndef NO_IPV6
	103	struct addrinfo hints, *ai;
	104	memset (&hints, '\0', sizeof (hints));
	105	hints.ai_flags = AI_CANONNAME;
	106	if (!getaddrinfo(host, NULL, &hints, &ai)) {
c375a7ef	107	if (ai && ai->ai_canonname && strchr(ai->ai_canonname, '.')) {
00bce77f EP	108	strbuf_addstr(out, ai->ai_canonname);
	109	status = 0;
	110	}
	111	freeaddrinfo(ai);
	112	}
	113	#else
58d29ece	114	struct hostent *he = gethostbyname(host);
00bce77f EP	115	if (he && strchr(he->h_name, '.')) {
	116	strbuf_addstr(out, he->h_name);
	117	status = 0;
	118	}
	119	#endif /* NO_IPV6 */
	120
	121	return status;
	122	}
	123
19ce497c	124	static void add_domainname(struct strbuf out, int is_bogus)
8a55caa8	125	{
da25bdb7	126	char buf[HOST_NAME_MAX + 1];
8a55caa8	127
5781a9a2	128	if (xgethostname(buf, sizeof(buf))) {
a26f4ed6	129	warning_errno("cannot get host name");
8587ead7	130	strbuf_addstr(out, "(none)");
19ce497c	131	*is_bogus = 1;
8a55caa8 JN	132	return;
8a55caa8 JN	133	}
8587ead7	134	if (strchr(buf, '.'))
f8254d32	135	strbuf_addstr(out, buf);
5498c57c	136	else if (canonical_name(buf, out) < 0) {
f8254d32	137	strbuf_addf(out, "%s.(none)", buf);
19ce497c JK	138	*is_bogus = 1;
19ce497c JK	139	}
8a55caa8 JN	140	}
8a55caa8 JN	141
19ce497c JK	142	static void copy_email(const struct passwd pw, struct strbuf email,
19ce497c JK	143	int *is_bogus)
6aa33f40	144	{
01754769 JH	145	/*
	146	* Make up a fake email address
	147	* (name + '@' + hostname [+ '.' + domainname])
	148	*/
8587ead7 JK	149	strbuf_addstr(email, pw->pw_name);
	150	strbuf_addch(email, '@');
	151
	152	if (!add_mailname_host(email))
8a55caa8	153	return; /* read from "/etc/mailname" (Debian) */
19ce497c	154	add_domainname(email, is_bogus);
01754769 JH	155	}
01754769 JH	156
9830534e	157	const char *ident_default_name(void)
01754769	158	{
94425552	159	if (!(ident_config_given & IDENT_NAME_GIVEN) && !git_default_name.len) {
92bcbb9b	160	copy_gecos(xgetpwuid_self(&default_name_is_bogus), &git_default_name);
be641abd	161	strbuf_trim(&git_default_name);
01754769	162	}
8587ead7	163	return git_default_name.buf;
bcb2b004	164	}
01754769	165
bcb2b004 JK	166	const char *ident_default_email(void)
bcb2b004 JK	167	{
94425552	168	if (!(ident_config_given & IDENT_MAIL_GIVEN) && !git_default_email.len) {
46f74f00 MK	169	const char *email = getenv("EMAIL");
46f74f00 MK	170
99178c83	171	if (email && email[0]) {
8587ead7	172	strbuf_addstr(&git_default_email, email);
d6991cee JK	173	committer_ident_explicitly_given \|= IDENT_MAIL_GIVEN;
d6991cee JK	174	author_ident_explicitly_given \|= IDENT_MAIL_GIVEN;
501afcb8 JS	175	} else if ((email = query_user_email()) && email[0]) {
	176	strbuf_addstr(&git_default_email, email);
	177	free((char *)email);
2f705875	178	} else
92bcbb9b JK	179	copy_email(xgetpwuid_self(&default_email_is_bogus),
92bcbb9b JK	180	&git_default_email, &default_email_is_bogus);
be641abd	181	strbuf_trim(&git_default_email);
01754769	182	}
8587ead7	183	return git_default_email.buf;
6aa33f40 LT	184	}
6aa33f40 LT	185
dad148c3	186	static const char *ident_default_date(void)
6aa33f40	187	{
c33ddc2e JK	188	if (!git_default_date.len)
	189	datestamp(&git_default_date);
	190	return git_default_date.buf;
6aa33f40 LT	191	}
6aa33f40 LT	192
4d9c7e6f JK	193	void reset_ident_date(void)
	194	{
	195	strbuf_reset(&git_default_date);
	196	}
	197
6aa33f40 LT	198	static int crud(unsigned char c)
6aa33f40 LT	199	{
f64c81d4 AR	200	return c <= 32 \|\|
	201	c == '.' \|\|
	202	c == ',' \|\|
	203	c == ':' \|\|
	204	c == ';' \|\|
	205	c == '<' \|\|
	206	c == '>' \|\|
	207	c == '"' \|\|
d404bf02	208	c == '\\' \|\|
f64c81d4	209	c == '\'';
6aa33f40 LT	210	}
6aa33f40 LT	211
13b9a24e JK	212	static int has_non_crud(const char *str)
	213	{
	214	for (; *str; str++) {
	215	if (!crud(*str))
	216	return 1;
	217	}
	218	return 0;
	219	}
	220
6aa33f40 LT	221	/*
	222	* Copy over a string to the destination, but avoid special
	223	* characters ('\n', '<' and '>') and remove crud at the end
	224	*/
c96f0c8d	225	static void strbuf_addstr_without_crud(struct strbuf sb, const char src)
6aa33f40	226	{
b0732115	227	size_t i, len;
6aa33f40 LT	228	unsigned char c;
	229
	230	/* Remove crud from the beginning.. */
	231	while ((c = *src) != 0) {
	232	if (!crud(c))
	233	break;
	234	src++;
	235	}
	236
	237	/* Remove crud from the end.. */
	238	len = strlen(src);
	239	while (len > 0) {
	240	c = src[len-1];
	241	if (!crud(c))
	242	break;
	243	--len;
	244	}
	245
	246	/*
	247	* Copy the rest to the buffer, but avoid the special
82f9d58a	248	* characters '\n' '<' and '>' that act as delimiters on
c96f0c8d JK	249	* an identification line. We can only remove crud, never add it,
c96f0c8d JK	250	* so 'len' is our maximum.
6aa33f40	251	*/
c96f0c8d	252	strbuf_grow(sb, len);
6aa33f40 LT	253	for (i = 0; i < len; i++) {
	254	c = *src++;
	255	switch (c) {
	256	case '\n': case '<': case '>':
	257	continue;
	258	}
c96f0c8d	259	sb->buf[sb->len++] = c;
6aa33f40	260	}
c96f0c8d	261	sb->buf[sb->len] = '\0';
6aa33f40 LT	262	}
6aa33f40 LT	263
4b340cfa JH	264	/*
	265	* Reverse of fmt_ident(); given an ident line, split the fields
	266	* to allow the caller to parse it.
	267	* Signal a success by returning 0, but date/tz fields of the result
	268	* can still be NULL if the input line only has the name/email part
	269	* (e.g. reading from a reflog entry).
	270	*/
	271	int split_ident_line(struct ident_split split, const char line, int len)
	272	{
	273	const char *cp;
	274	size_t span;
	275	int status = -1;
	276
	277	memset(split, 0, sizeof(*split));
	278
	279	split->name_begin = line;
	280	for (cp = line; *cp && cp < line + len; cp++)
	281	if (*cp == '<') {
	282	split->mail_begin = cp + 1;
	283	break;
	284	}
	285	if (!split->mail_begin)
	286	return status;
	287
d9955fd6	288	for (cp = split->mail_begin - 2; line <= cp; cp--)
4b340cfa JH	289	if (!isspace(*cp)) {
	290	split->name_end = cp + 1;
	291	break;
	292	}
e27ddb64 JH	293	if (!split->name_end) {
	294	/* no human readable name */
	295	split->name_end = split->name_begin;
	296	}
4b340cfa JH	297
	298	for (cp = split->mail_begin; cp < line + len; cp++)
	299	if (*cp == '>') {
	300	split->mail_end = cp;
	301	break;
	302	}
	303	if (!split->mail_end)
	304	return status;
	305
03818a4a JK	306	/*
	307	* Look from the end-of-line to find the trailing ">" of the mail
	308	* address, even though we should already know it as split->mail_end.
	309	* This can help in cases of broken idents with an extra ">" somewhere
	310	* in the email address. Note that we are assuming the timestamp will
	311	* never have a ">" in it.
	312	*
	313	* Note that we will always find some ">" before going off the front of
	314	* the string, because will always hit the split->mail_end closing
	315	* bracket.
	316	*/
	317	for (cp = line + len - 1; *cp != '>'; cp--)
	318	;
	319
	320	for (cp = cp + 1; cp < line + len && isspace(*cp); cp++)
4b340cfa JH	321	;
	322	if (line + len <= cp)
	323	goto person_only;
	324	split->date_begin = cp;
	325	span = strspn(cp, "0123456789");
	326	if (!span)
	327	goto person_only;
	328	split->date_end = split->date_begin + span;
	329	for (cp = split->date_end; cp < line + len && isspace(*cp); cp++)
	330	;
	331	if (line + len <= cp \|\| (cp != '+' && cp != '-'))
	332	goto person_only;
	333	split->tz_begin = cp;
	334	span = strspn(cp + 1, "0123456789");
	335	if (!span)
	336	goto person_only;
	337	split->tz_end = split->tz_begin + 1 + span;
	338	return 0;
	339
	340	person_only:
	341	split->date_begin = NULL;
	342	split->date_end = NULL;
	343	split->tz_begin = NULL;
	344	split->tz_end = NULL;
	345	return 0;
	346	}
	347
749be728	348	static const char *env_hint =
166e55e3 VA	349	N_("\n"
	350	"*** Please tell me who you are.\n"
	351	"\n"
	352	"Run\n"
	353	"\n"
	354	" git config --global user.email \"you@example.com\"\n"
	355	" git config --global user.name \"Your Name\"\n"
	356	"\n"
	357	"to set your account\'s default identity.\n"
	358	"Omit --global to set the identity only in this repository.\n"
	359	"\n");
749be728	360
774751a8	361	const char fmt_ident(const char name, const char *email,
39ab4d09	362	enum want_ident whose_ident, const char *date_str, int flag)
6aa33f40	363	{
c96f0c8d	364	static struct strbuf ident = STRBUF_INIT;
f9bc573f	365	int strict = (flag & IDENT_STRICT);
359b27ad	366	int want_date = !(flag & IDENT_NO_DATE);
c15e1987	367	int want_name = !(flag & IDENT_NO_NAME);
6aa33f40	368
39ab4d09 WH	369	if (!email) {
	370	if (whose_ident == WANT_AUTHOR_IDENT && git_author_email.len)
	371	email = git_author_email.buf;
	372	else if (whose_ident == WANT_COMMITTER_IDENT && git_committer_email.len)
	373	email = git_committer_email.buf;
	374	}
862e80a4 JK	375	if (!email) {
	376	if (strict && ident_use_config_only
	377	&& !(ident_config_given & IDENT_MAIL_GIVEN)) {
	378	fputs(_(env_hint), stderr);
	379	die(_("no email was given and auto-detection is disabled"));
	380	}
	381	email = ident_default_email();
	382	if (strict && default_email_is_bogus) {
	383	fputs(_(env_hint), stderr);
	384	die(_("unable to auto-detect email address (got '%s')"), email);
	385	}
	386	}
	387
59f92959 JK	388	if (want_name) {
59f92959 JK	389	int using_default = 0;
39ab4d09 WH	390	if (!name) {
	391	if (whose_ident == WANT_AUTHOR_IDENT && git_author_name.len)
	392	name = git_author_name.buf;
	393	else if (whose_ident == WANT_COMMITTER_IDENT &&
	394	git_committer_name.len)
	395	name = git_committer_name.buf;
	396	}
59f92959	397	if (!name) {
734c7789	398	if (strict && ident_use_config_only
d3c06c19	399	&& !(ident_config_given & IDENT_NAME_GIVEN)) {
166e55e3	400	fputs(_(env_hint), stderr);
afb6c30b	401	die(_("no name was given and auto-detection is disabled"));
d3c06c19	402	}
59f92959 JK	403	name = ident_default_name();
	404	using_default = 1;
	405	if (strict && default_name_is_bogus) {
166e55e3	406	fputs(_(env_hint), stderr);
afb6c30b	407	die(_("unable to auto-detect name (got '%s')"), name);
59f92959 JK	408	}
	409	}
	410	if (!*name) {
	411	struct passwd *pw;
	412	if (strict) {
	413	if (using_default)
166e55e3	414	fputs(_(env_hint), stderr);
afb6c30b	415	die(_("empty ident name (for <%s>) not allowed"), email);
59f92959 JK	416	}
	417	pw = xgetpwuid_self(NULL);
	418	name = pw->pw_name;
749be728	419	}
13b9a24e JK	420	if (strict && !has_non_crud(name))
13b9a24e JK	421	die(_("name consists only of disallowed characters: %s"), name);
92bcbb9b JK	422	}
92bcbb9b JK	423
c96f0c8d	424	strbuf_reset(&ident);
c15e1987 JK	425	if (want_name) {
	426	strbuf_addstr_without_crud(&ident, name);
	427	strbuf_addstr(&ident, " <");
d9ccfe77	428	}
c96f0c8d	429	strbuf_addstr_without_crud(&ident, email);
c15e1987 JK	430	if (want_name)
c15e1987 JK	431	strbuf_addch(&ident, '>');
359b27ad	432	if (want_date) {
c96f0c8d	433	strbuf_addch(&ident, ' ');
c33ddc2e JK	434	if (date_str && date_str[0]) {
c33ddc2e JK	435	if (parse_date(date_str, &ident) < 0)
afb6c30b	436	die(_("invalid date format: %s"), date_str);
c33ddc2e JK	437	}
	438	else
	439	strbuf_addstr(&ident, ident_default_date());
d9ccfe77	440	}
c33ddc2e	441
c96f0c8d	442	return ident.buf;
6aa33f40	443	}
d289d136	444
39ab4d09	445	const char *fmt_name(enum want_ident whose_ident)
d9ccfe77	446	{
39ab4d09 WH	447	char *name = NULL;
	448	char *email = NULL;
	449
	450	switch (whose_ident) {
	451	case WANT_BLANK_IDENT:
	452	break;
	453	case WANT_AUTHOR_IDENT:
	454	name = getenv("GIT_AUTHOR_NAME");
	455	email = getenv("GIT_AUTHOR_EMAIL");
	456	break;
	457	case WANT_COMMITTER_IDENT:
	458	name = getenv("GIT_COMMITTER_NAME");
	459	email = getenv("GIT_COMMITTER_EMAIL");
	460	break;
	461	}
	462	return fmt_ident(name, email, whose_ident, NULL,
	463	IDENT_STRICT \| IDENT_NO_DATE);
d9ccfe77 JH	464	}
d9ccfe77 JH	465
774751a8	466	const char *git_author_info(int flag)
d289d136	467	{
d6991cee JK	468	if (getenv("GIT_AUTHOR_NAME"))
	469	author_ident_explicitly_given \|= IDENT_NAME_GIVEN;
	470	if (getenv("GIT_AUTHOR_EMAIL"))
	471	author_ident_explicitly_given \|= IDENT_MAIL_GIVEN;
798123af	472	return fmt_ident(getenv("GIT_AUTHOR_NAME"),
c7d77dab	473	getenv("GIT_AUTHOR_EMAIL"),
39ab4d09	474	WANT_AUTHOR_IDENT,
749be728	475	getenv("GIT_AUTHOR_DATE"),
774751a8	476	flag);
d289d136 EB	477	}
d289d136 EB	478
774751a8	479	const char *git_committer_info(int flag)
d289d136	480	{
91c38a21	481	if (getenv("GIT_COMMITTER_NAME"))
d6991cee	482	committer_ident_explicitly_given \|= IDENT_NAME_GIVEN;
91c38a21	483	if (getenv("GIT_COMMITTER_EMAIL"))
d6991cee	484	committer_ident_explicitly_given \|= IDENT_MAIL_GIVEN;
798123af	485	return fmt_ident(getenv("GIT_COMMITTER_NAME"),
c7d77dab	486	getenv("GIT_COMMITTER_EMAIL"),
39ab4d09	487	WANT_COMMITTER_IDENT,
749be728	488	getenv("GIT_COMMITTER_DATE"),
774751a8	489	flag);
d289d136	490	}
5aeb3a3a	491
d6991cee	492	static int ident_is_sufficient(int user_ident_explicitly_given)
5aeb3a3a JH	493	{
	494	#ifndef WINDOWS
	495	return (user_ident_explicitly_given & IDENT_MAIL_GIVEN);
	496	#else
	497	return (user_ident_explicitly_given == IDENT_ALL_GIVEN);
	498	#endif
	499	}
9597921b	500
d6991cee JK	501	int committer_ident_sufficiently_given(void)
	502	{
	503	return ident_is_sufficient(committer_ident_explicitly_given);
	504	}
	505
	506	int author_ident_sufficiently_given(void)
	507	{
	508	return ident_is_sufficient(author_ident_explicitly_given);
	509	}
	510
39ab4d09	511	static int set_ident(const char var, const char value)
9597921b	512	{
39ab4d09 WH	513	if (!strcmp(var, "author.name")) {
	514	if (!value)
	515	return config_error_nonbool(var);
	516	strbuf_reset(&git_author_name);
	517	strbuf_addstr(&git_author_name, value);
	518	author_ident_explicitly_given \|= IDENT_NAME_GIVEN;
	519	ident_config_given \|= IDENT_NAME_GIVEN;
	520	return 0;
	521	}
	522
	523	if (!strcmp(var, "author.email")) {
	524	if (!value)
	525	return config_error_nonbool(var);
	526	strbuf_reset(&git_author_email);
	527	strbuf_addstr(&git_author_email, value);
	528	author_ident_explicitly_given \|= IDENT_MAIL_GIVEN;
	529	ident_config_given \|= IDENT_MAIL_GIVEN;
	530	return 0;
	531	}
	532
	533	if (!strcmp(var, "committer.name")) {
	534	if (!value)
	535	return config_error_nonbool(var);
	536	strbuf_reset(&git_committer_name);
	537	strbuf_addstr(&git_committer_name, value);
	538	committer_ident_explicitly_given \|= IDENT_NAME_GIVEN;
	539	ident_config_given \|= IDENT_NAME_GIVEN;
	540	return 0;
	541	}
	542
	543	if (!strcmp(var, "committer.email")) {
	544	if (!value)
	545	return config_error_nonbool(var);
	546	strbuf_reset(&git_committer_email);
	547	strbuf_addstr(&git_committer_email, value);
	548	committer_ident_explicitly_given \|= IDENT_MAIL_GIVEN;
	549	ident_config_given \|= IDENT_MAIL_GIVEN;
4d5c2956 DA	550	return 0;
	551	}
	552
9597921b JK	553	if (!strcmp(var, "user.name")) {
	554	if (!value)
	555	return config_error_nonbool(var);
8587ead7 JK	556	strbuf_reset(&git_default_name);
8587ead7 JK	557	strbuf_addstr(&git_default_name, value);
d6991cee JK	558	committer_ident_explicitly_given \|= IDENT_NAME_GIVEN;
d6991cee JK	559	author_ident_explicitly_given \|= IDENT_NAME_GIVEN;
4d5c2956	560	ident_config_given \|= IDENT_NAME_GIVEN;
9597921b JK	561	return 0;
	562	}
	563
	564	if (!strcmp(var, "user.email")) {
	565	if (!value)
	566	return config_error_nonbool(var);
8587ead7 JK	567	strbuf_reset(&git_default_email);
8587ead7 JK	568	strbuf_addstr(&git_default_email, value);
d6991cee JK	569	committer_ident_explicitly_given \|= IDENT_MAIL_GIVEN;
d6991cee JK	570	author_ident_explicitly_given \|= IDENT_MAIL_GIVEN;
4d5c2956	571	ident_config_given \|= IDENT_MAIL_GIVEN;
9597921b JK	572	return 0;
	573	}
	574
	575	return 0;
	576	}
662cc30c	577
39ab4d09 WH	578	int git_ident_config(const char var, const char value, void *data)
	579	{
	580	if (!strcmp(var, "user.useconfigonly")) {
	581	ident_use_config_only = git_config_bool(var, value);
	582	return 0;
	583	}
	584
	585	return set_ident(var, value);
	586	}
	587
fd5a5847 JS	588	static void set_env_if(const char key, const char value, int *given, int bit)
fd5a5847 JS	589	{
0640897d	590	if ((*given & bit) \|\| getenv(key))
fd5a5847 JS	591	return; /* nothing to do */
	592	setenv(key, value, 0);
	593	*given \|= bit;
	594	}
	595
	596	void prepare_fallback_ident(const char name, const char email)
	597	{
	598	set_env_if("GIT_AUTHOR_NAME", name,
	599	&author_ident_explicitly_given, IDENT_NAME_GIVEN);
	600	set_env_if("GIT_AUTHOR_EMAIL", email,
	601	&author_ident_explicitly_given, IDENT_MAIL_GIVEN);
	602	set_env_if("GIT_COMMITTER_NAME", name,
	603	&committer_ident_explicitly_given, IDENT_NAME_GIVEN);
	604	set_env_if("GIT_COMMITTER_EMAIL", email,
	605	&committer_ident_explicitly_given, IDENT_MAIL_GIVEN);
	606	}
	607
662cc30c JK	608	static int buf_cmp(const char a_begin, const char a_end,
	609	const char b_begin, const char b_end)
	610	{
	611	int a_len = a_end - a_begin;
	612	int b_len = b_end - b_begin;
	613	int min = a_len < b_len ? a_len : b_len;
	614	int cmp;
	615
	616	cmp = memcmp(a_begin, b_begin, min);
	617	if (cmp)
	618	return cmp;
	619
	620	return a_len - b_len;
	621	}
	622
	623	int ident_cmp(const struct ident_split *a,
	624	const struct ident_split *b)
	625	{
	626	int cmp;
	627
	628	cmp = buf_cmp(a->mail_begin, a->mail_end,
	629	b->mail_begin, b->mail_end);
	630	if (cmp)
	631	return cmp;
	632
	633	return buf_cmp(a->name_begin, a->name_end,
	634	b->name_begin, b->name_end);
	635	}