[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"

static struct strbuf git_default_name = STRBUF_INIT;
static struct strbuf git_default_email = STRBUF_INIT;
static char git_default_date[50];
int user_ident_explicitly_given;

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

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;

	mailname = fopen("/etc/mailname", "r");
	if (!mailname) {
		if (errno != ENOENT)
			warning("cannot open /etc/mailname: %s",
				strerror(errno));
		return -1;
	}
	if (strbuf_getline(buf, mailname, '\n') == EOF) {
		if (ferror(mailname))
			warning("cannot read /etc/mailname: %s",
				strerror(errno));
		fclose(mailname);
		return -1;
	}
	/* success! */
	fclose(mailname);
	return 0;
}

static void add_domainname(struct strbuf *out)
{
	char buf[1024];
	struct hostent *he;

	if (gethostname(buf, sizeof(buf))) {
		warning("cannot get host name: %s", strerror(errno));
		strbuf_addstr(out, "(none)");
		return;
	}
	if (strchr(buf, '.'))
		strbuf_addstr(out, buf);
	else if ((he = gethostbyname(buf)) && strchr(he->h_name, '.'))
		strbuf_addstr(out, he->h_name);
	else
		strbuf_addf(out, "%s.(none)", buf);
}

static void copy_email(const struct passwd *pw, struct strbuf *email)
{
	/*
	 * 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);
}

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

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

		if (email && email[0]) {
			strbuf_addstr(&git_default_email, email);
			user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
		} else
			copy_email(xgetpwuid_self(), &git_default_email);
	}
	return git_default_email.buf;
}

const char *ident_default_date(void)
{
	if (!git_default_date[0])
		datestamp(git_default_date, sizeof(git_default_date));
	return git_default_date;
}

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

/*
 * 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)
		return status;

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

	for (cp = split->mail_end + 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"
"*** 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,
		      const char *date_str, int flag)
{
	static struct strbuf ident = STRBUF_INIT;
	char date[50];
	int error_on_no_name = (flag & IDENT_ERROR_ON_NO_NAME);
	int name_addr_only = (flag & IDENT_NO_DATE);

	if (!name)
		name = ident_default_name();
	if (!email)
		email = ident_default_email();

	if (!*name) {
		struct passwd *pw;

		if (error_on_no_name) {
			if (name == git_default_name.buf)
				fputs(env_hint, stderr);
			die("empty ident %s <%s> not allowed", name, email);
		}
		pw = xgetpwuid_self();
		name = pw->pw_name;
	}

	strcpy(date, ident_default_date());
	if (!name_addr_only && date_str && date_str[0]) {
		if (parse_date(date_str, date, sizeof(date)) < 0)
			die("invalid date format: %s", date_str);
	}

	strbuf_reset(&ident);
	strbuf_addstr_without_crud(&ident, name);
	strbuf_addstr(&ident, " <");
	strbuf_addstr_without_crud(&ident, email);
	strbuf_addch(&ident, '>');
	if (!name_addr_only) {
		strbuf_addch(&ident, ' ');
		strbuf_addstr_without_crud(&ident, date);
	}
	return ident.buf;
}

const char *fmt_name(const char *name, const char *email)
{
	return fmt_ident(name, email, NULL, IDENT_ERROR_ON_NO_NAME | IDENT_NO_DATE);
}

const char *git_author_info(int flag)
{
	return fmt_ident(getenv("GIT_AUTHOR_NAME"),
			 getenv("GIT_AUTHOR_EMAIL"),
			 getenv("GIT_AUTHOR_DATE"),
			 flag);
}

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

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

int git_ident_config(const char *var, const char *value, void *data)
{
	if (!strcmp(var, "user.name")) {
		if (!value)
			return config_error_nonbool(var);
		strbuf_reset(&git_default_name);
		strbuf_addstr(&git_default_name, value);
		user_ident_explicitly_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);
		user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
		return 0;
	}

	return 0;
}
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"
	9
8587ead7 JK	10	static struct strbuf git_default_name = STRBUF_INIT;
8587ead7 JK	11	static struct strbuf git_default_email = STRBUF_INIT;
e1b10391	12	static char git_default_date[50];
2d4b4fce	13	int user_ident_explicitly_given;
6aa33f40	14
590e081d RG	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
8587ead7	21	static void copy_gecos(const struct passwd w, struct strbuf name)
e9bacb4f	22	{
8587ead7	23	char *src;
e9bacb4f JH	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
8587ead7	29	for (src = get_gecos(w); src && src != ','; src++) {
e9bacb4f	30	int ch = *src;
8587ead7 JK	31	if (ch != '&')
	32	strbuf_addch(name, ch);
	33	else {
e9bacb4f	34	/* Sorry, Mr. McDonald... */
8587ead7 JK	35	strbuf_addch(name, toupper(*w->pw_name));
8587ead7 JK	36	strbuf_addstr(name, w->pw_name + 1);
e9bacb4f JH	37	}
e9bacb4f JH	38	}
e9bacb4f JH	39	}
e9bacb4f JH	40
8587ead7	41	static int add_mailname_host(struct strbuf *buf)
8a55caa8 JN	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	}
8587ead7	52	if (strbuf_getline(buf, mailname, '\n') == EOF) {
8a55caa8 JN	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
8587ead7	64	static void add_domainname(struct strbuf *out)
8a55caa8	65	{
8587ead7	66	char buf[1024];
8a55caa8	67	struct hostent *he;
8a55caa8	68
8587ead7	69	if (gethostname(buf, sizeof(buf))) {
8a55caa8	70	warning("cannot get host name: %s", strerror(errno));
8587ead7	71	strbuf_addstr(out, "(none)");
8a55caa8 JN	72	return;
8a55caa8 JN	73	}
8587ead7	74	if (strchr(buf, '.'))
f8254d32 JK	75	strbuf_addstr(out, buf);
	76	else if ((he = gethostbyname(buf)) && strchr(he->h_name, '.'))
	77	strbuf_addstr(out, he->h_name);
8a55caa8	78	else
f8254d32	79	strbuf_addf(out, "%s.(none)", buf);
8a55caa8 JN	80	}
8a55caa8 JN	81
8587ead7	82	static void copy_email(const struct passwd pw, struct strbuf email)
6aa33f40	83	{
01754769 JH	84	/*
	85	* Make up a fake email address
	86	* (name + '@' + hostname [+ '.' + domainname])
	87	*/
8587ead7 JK	88	strbuf_addstr(email, pw->pw_name);
	89	strbuf_addch(email, '@');
	90
	91	if (!add_mailname_host(email))
8a55caa8	92	return; /* read from "/etc/mailname" (Debian) */
8587ead7	93	add_domainname(email);
01754769 JH	94	}
01754769 JH	95
bcb2b004	96	const char *ident_default_name(void)
01754769	97	{
2f705875 JK	98	if (!git_default_name.len)
2f705875 JK	99	copy_gecos(xgetpwuid_self(), &git_default_name);
8587ead7	100	return git_default_name.buf;
bcb2b004	101	}
01754769	102
bcb2b004 JK	103	const char *ident_default_email(void)
bcb2b004 JK	104	{
8587ead7	105	if (!git_default_email.len) {
46f74f00 MK	106	const char *email = getenv("EMAIL");
46f74f00 MK	107
99178c83	108	if (email && email[0]) {
8587ead7	109	strbuf_addstr(&git_default_email, email);
99178c83	110	user_ident_explicitly_given \|= IDENT_MAIL_GIVEN;
2f705875 JK	111	} else
2f705875 JK	112	copy_email(xgetpwuid_self(), &git_default_email);
01754769	113	}
8587ead7	114	return git_default_email.buf;
bcb2b004	115	}
01754769	116
bcb2b004 JK	117	const char *ident_default_date(void)
bcb2b004 JK	118	{
01754769 JH	119	if (!git_default_date[0])
01754769 JH	120	datestamp(git_default_date, sizeof(git_default_date));
bcb2b004	121	return git_default_date;
6aa33f40 LT	122	}
6aa33f40 LT	123
6aa33f40 LT	124	static int crud(unsigned char c)
6aa33f40 LT	125	{
f64c81d4 AR	126	return c <= 32 \|\|
	127	c == '.' \|\|
	128	c == ',' \|\|
	129	c == ':' \|\|
	130	c == ';' \|\|
	131	c == '<' \|\|
	132	c == '>' \|\|
	133	c == '"' \|\|
d404bf02	134	c == '\\' \|\|
f64c81d4	135	c == '\'';
6aa33f40 LT	136	}
	137
	138	/*
	139	* Copy over a string to the destination, but avoid special
	140	* characters ('\n', '<' and '>') and remove crud at the end
	141	*/
c96f0c8d	142	static void strbuf_addstr_without_crud(struct strbuf sb, const char src)
6aa33f40	143	{
b0732115	144	size_t i, len;
6aa33f40 LT	145	unsigned char c;
	146
	147	/* Remove crud from the beginning.. */
	148	while ((c = *src) != 0) {
	149	if (!crud(c))
	150	break;
	151	src++;
	152	}
	153
	154	/* Remove crud from the end.. */
	155	len = strlen(src);
	156	while (len > 0) {
	157	c = src[len-1];
	158	if (!crud(c))
	159	break;
	160	--len;
	161	}
	162
	163	/*
	164	* Copy the rest to the buffer, but avoid the special
82f9d58a	165	* characters '\n' '<' and '>' that act as delimiters on
c96f0c8d JK	166	* an identification line. We can only remove crud, never add it,
c96f0c8d JK	167	* so 'len' is our maximum.
6aa33f40	168	*/
c96f0c8d	169	strbuf_grow(sb, len);
6aa33f40 LT	170	for (i = 0; i < len; i++) {
	171	c = *src++;
	172	switch (c) {
	173	case '\n': case '<': case '>':
	174	continue;
	175	}
c96f0c8d	176	sb->buf[sb->len++] = c;
6aa33f40	177	}
c96f0c8d	178	sb->buf[sb->len] = '\0';
6aa33f40 LT	179	}
6aa33f40 LT	180
4b340cfa JH	181	/*
	182	* Reverse of fmt_ident(); given an ident line, split the fields
	183	* to allow the caller to parse it.
	184	* Signal a success by returning 0, but date/tz fields of the result
	185	* can still be NULL if the input line only has the name/email part
	186	* (e.g. reading from a reflog entry).
	187	*/
	188	int split_ident_line(struct ident_split split, const char line, int len)
	189	{
	190	const char *cp;
	191	size_t span;
	192	int status = -1;
	193
	194	memset(split, 0, sizeof(*split));
	195
	196	split->name_begin = line;
	197	for (cp = line; *cp && cp < line + len; cp++)
	198	if (*cp == '<') {
	199	split->mail_begin = cp + 1;
	200	break;
	201	}
	202	if (!split->mail_begin)
	203	return status;
	204
	205	for (cp = split->mail_begin - 2; line < cp; cp--)
	206	if (!isspace(*cp)) {
	207	split->name_end = cp + 1;
	208	break;
	209	}
	210	if (!split->name_end)
	211	return status;
	212
	213	for (cp = split->mail_begin; cp < line + len; cp++)
	214	if (*cp == '>') {
	215	split->mail_end = cp;
	216	break;
	217	}
	218	if (!split->mail_end)
	219	return status;
	220
	221	for (cp = split->mail_end + 1; cp < line + len && isspace(*cp); cp++)
	222	;
	223	if (line + len <= cp)
	224	goto person_only;
	225	split->date_begin = cp;
	226	span = strspn(cp, "0123456789");
	227	if (!span)
	228	goto person_only;
	229	split->date_end = split->date_begin + span;
	230	for (cp = split->date_end; cp < line + len && isspace(*cp); cp++)
	231	;
	232	if (line + len <= cp \|\| (cp != '+' && cp != '-'))
	233	goto person_only;
	234	split->tz_begin = cp;
	235	span = strspn(cp + 1, "0123456789");
	236	if (!span)
	237	goto person_only;
	238	split->tz_end = split->tz_begin + 1 + span;
	239	return 0;
	240
	241	person_only:
	242	split->date_begin = NULL;
	243	split->date_end = NULL;
	244	split->tz_begin = NULL;
245	split->tz_end = NULL;
246	return 0;
247	}
248
749be728	249	static const char *env_hint =
d5cc2de9	250	"\n"
6c293d40	251	"*** Please tell me who you are.\n"
d5cc2de9 HWN	252	"\n"
	253	"Run\n"
	254	"\n"
8e7425da	255	" git config --global user.email \"you@example.com\"\n"
180787c4	256	" git config --global user.name \"Your Name\"\n"
d5cc2de9	257	"\n"
180787c4 SP	258	"to set your account\'s default identity.\n"
180787c4 SP	259	"Omit --global to set the identity only in this repository.\n"
d5cc2de9	260	"\n";
749be728	261
774751a8 JH	262	const char fmt_ident(const char name, const char *email,
774751a8 JH	263	const char *date_str, int flag)
6aa33f40	264	{
c96f0c8d	265	static struct strbuf ident = STRBUF_INIT;
6aa33f40	266	char date[50];
774751a8	267	int error_on_no_name = (flag & IDENT_ERROR_ON_NO_NAME);
774751a8	268	int name_addr_only = (flag & IDENT_NO_DATE);
6aa33f40	269
bcb2b004 JK	270	if (!name)
	271	name = ident_default_name();
	272	if (!email)
	273	email = ident_default_email();
dfdd309e	274
749be728	275	if (!*name) {
cb280e10 JH	276	struct passwd *pw;
cb280e10 JH	277
b9f0ac17	278	if (error_on_no_name) {
8587ead7	279	if (name == git_default_name.buf)
b9f0ac17	280	fputs(env_hint, stderr);
749be728	281	die("empty ident %s <%s> not allowed", name, email);
b9f0ac17	282	}
2f705875	283	pw = xgetpwuid_self();
060d4bb3	284	name = pw->pw_name;
749be728	285	}
dfdd309e	286
bcb2b004	287	strcpy(date, ident_default_date());
4579bb41 JK	288	if (!name_addr_only && date_str && date_str[0]) {
	289	if (parse_date(date_str, date, sizeof(date)) < 0)
	290	die("invalid date format: %s", date_str);
	291	}
6aa33f40	292
c96f0c8d JK	293	strbuf_reset(&ident);
	294	strbuf_addstr_without_crud(&ident, name);
	295	strbuf_addstr(&ident, " <");
	296	strbuf_addstr_without_crud(&ident, email);
	297	strbuf_addch(&ident, '>');
d9ccfe77	298	if (!name_addr_only) {
c96f0c8d JK	299	strbuf_addch(&ident, ' ');
c96f0c8d JK	300	strbuf_addstr_without_crud(&ident, date);
d9ccfe77	301	}
c96f0c8d	302	return ident.buf;
6aa33f40	303	}
d289d136	304
d9ccfe77 JH	305	const char fmt_name(const char name, const char *email)
d9ccfe77 JH	306	{
774751a8	307	return fmt_ident(name, email, NULL, IDENT_ERROR_ON_NO_NAME \| IDENT_NO_DATE);
d9ccfe77 JH	308	}
d9ccfe77 JH	309
774751a8	310	const char *git_author_info(int flag)
d289d136	311	{
798123af	312	return fmt_ident(getenv("GIT_AUTHOR_NAME"),
c7d77dab	313	getenv("GIT_AUTHOR_EMAIL"),
749be728	314	getenv("GIT_AUTHOR_DATE"),
774751a8	315	flag);
d289d136 EB	316	}
d289d136 EB	317
774751a8	318	const char *git_committer_info(int flag)
d289d136	319	{
91c38a21 JH	320	if (getenv("GIT_COMMITTER_NAME"))
	321	user_ident_explicitly_given \|= IDENT_NAME_GIVEN;
	322	if (getenv("GIT_COMMITTER_EMAIL"))
	323	user_ident_explicitly_given \|= IDENT_MAIL_GIVEN;
798123af	324	return fmt_ident(getenv("GIT_COMMITTER_NAME"),
c7d77dab	325	getenv("GIT_COMMITTER_EMAIL"),
749be728	326	getenv("GIT_COMMITTER_DATE"),
774751a8	327	flag);
d289d136	328	}
5aeb3a3a JH	329
	330	int user_ident_sufficiently_given(void)
	331	{
	332	#ifndef WINDOWS
	333	return (user_ident_explicitly_given & IDENT_MAIL_GIVEN);
	334	#else
	335	return (user_ident_explicitly_given == IDENT_ALL_GIVEN);
	336	#endif
	337	}
9597921b JK	338
	339	int git_ident_config(const char var, const char value, void *data)
	340	{
	341	if (!strcmp(var, "user.name")) {
	342	if (!value)
	343	return config_error_nonbool(var);
8587ead7 JK	344	strbuf_reset(&git_default_name);
8587ead7 JK	345	strbuf_addstr(&git_default_name, value);
9597921b JK	346	user_ident_explicitly_given \|= IDENT_NAME_GIVEN;
	347	return 0;
	348	}
	349
	350	if (!strcmp(var, "user.email")) {
	351	if (!value)
	352	return config_error_nonbool(var);
8587ead7 JK	353	strbuf_reset(&git_default_email);
8587ead7 JK	354	strbuf_addstr(&git_default_email, value);
9597921b JK	355	user_ident_explicitly_given \|= IDENT_MAIL_GIVEN;
	356	return 0;
	357	}
	358
	359	return 0;
	360	}