[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 char git_default_date[50];

#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, char *name, size_t sz)
{
	char *src, *dst;
	size_t len, nlen;

	nlen = strlen(w->pw_name);

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

	for (len = 0, dst = name, src = get_gecos(w); len < sz; src++) {
		int ch = *src;
		if (ch != '&') {
			*dst++ = ch;
			if (ch == 0 || ch == ',')
				break;
			len++;
			continue;
		}
		if (len + nlen < sz) {
			/* Sorry, Mr. McDonald... */
			*dst++ = toupper(*w->pw_name);
			memcpy(dst, w->pw_name + 1, nlen - 1);
			dst += nlen - 1;
			len += nlen;
		}
	}
	if (len < sz)
		name[len] = 0;
	else
		die("Your parents must have hated you!");

}

static int add_mailname_host(char *buf, size_t len)
{
	FILE *mailname;

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

static void add_domainname(char *buf, size_t len)
{
	struct hostent *he;
	size_t namelen;
	const char *domainname;

	if (gethostname(buf, len)) {
		warning("cannot get host name: %s", strerror(errno));
		strlcpy(buf, "(none)", len);
		return;
	}
	namelen = strlen(buf);
	if (memchr(buf, '.', namelen))
		return;

	he = gethostbyname(buf);
	buf[namelen++] = '.';
	buf += namelen;
	len -= namelen;
	if (he && (domainname = strchr(he->h_name, '.')))
		strlcpy(buf, domainname + 1, len);
	else
		strlcpy(buf, "(none)", len);
}

static void copy_email(const struct passwd *pw)
{
	/*
	 * Make up a fake email address
	 * (name + '@' + hostname [+ '.' + domainname])
	 */
	size_t len = strlen(pw->pw_name);
	if (len > sizeof(git_default_email)/2)
		die("Your sysadmin must hate you!");
	memcpy(git_default_email, pw->pw_name, len);
	git_default_email[len++] = '@';

	if (!add_mailname_host(git_default_email + len,
				sizeof(git_default_email) - len))
		return;	/* read from "/etc/mailname" (Debian) */
	add_domainname(git_default_email + len,
			sizeof(git_default_email) - len);
}

static void setup_ident(const char **name, const char **emailp)
{
	struct passwd *pw = NULL;

	/* Get the name ("gecos") */
	if (!*name && !git_default_name[0]) {
		pw = getpwuid(getuid());
		if (!pw)
			die("You don't exist. Go away!");
		copy_gecos(pw, git_default_name, sizeof(git_default_name));
	}
	if (!*name)
		*name = git_default_name;

	if (!*emailp && !git_default_email[0]) {
		const char *email = getenv("EMAIL");

		if (email && email[0]) {
			strlcpy(git_default_email, email,
				sizeof(git_default_email));
			user_ident_explicitly_given |= IDENT_MAIL_GIVEN;
		} else {
			if (!pw)
				pw = getpwuid(getuid());
			if (!pw)
				die("You don't exist. Go away!");
			copy_email(pw);
		}
	}
	if (!*emailp)
		*emailp = git_default_email;

	/* And set the default date */
	if (!git_default_date[0])
		datestamp(git_default_date, sizeof(git_default_date));
}

static int add_raw(char *buf, size_t size, int offset, const char *str)
{
	size_t len = strlen(str);
	if (offset + len > size)
		return size;
	memcpy(buf + offset, str, len);
	return offset + len;
}

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 int copy(char *buf, size_t size, int offset, 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
	 */
	for (i = 0; i < len; i++) {
		c = *src++;
		switch (c) {
		case '\n': case '<': case '>':
			continue;
		}
		if (offset >= size)
			return size;
		buf[offset++] = c;
	}
	return offset;
}

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 char buffer[1000];
	char date[50];
	int i;
	int error_on_no_name = (flag & IDENT_ERROR_ON_NO_NAME);
	int warn_on_no_name = (flag & IDENT_WARN_ON_NO_NAME);
	int name_addr_only = (flag & IDENT_NO_DATE);

	setup_ident(&name, &email);

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

		if ((warn_on_no_name || error_on_no_name) &&
		    name == git_default_name && env_hint) {
			fputs(env_hint, stderr);
			env_hint = NULL; /* warn only once */
		}
		if (error_on_no_name)
			die("empty ident %s <%s> not allowed", name, email);
		pw = getpwuid(getuid());
		if (!pw)
			die("You don't exist. Go away!");
		strlcpy(git_default_name, pw->pw_name,
			sizeof(git_default_name));
		name = git_default_name;
	}

	strcpy(date, git_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);
	}

	i = copy(buffer, sizeof(buffer), 0, name);
	i = add_raw(buffer, sizeof(buffer), i, " <");
	i = copy(buffer, sizeof(buffer), i, email);
	if (!name_addr_only) {
		i = add_raw(buffer, sizeof(buffer), i,  "> ");
		i = copy(buffer, sizeof(buffer), i, date);
	} else {
		i = add_raw(buffer, sizeof(buffer), i, ">");
	}
	if (i >= sizeof(buffer))
		die("Impossibly long personal identifier");
	buffer[i] = 0;
	return buffer;
}

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
}
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
e1b10391	10	static char git_default_date[50];
6aa33f40	11
590e081d RG	12	#ifdef NO_GECOS_IN_PWENT
	13	#define get_gecos(ignored) "&"
	14	#else
	15	#define get_gecos(struct_passwd) ((struct_passwd)->pw_gecos)
	16	#endif
	17
b0732115	18	static void copy_gecos(const struct passwd w, char name, size_t sz)
e9bacb4f JH	19	{
e9bacb4f JH	20	char src, dst;
b0732115	21	size_t len, nlen;
e9bacb4f JH	22
	23	nlen = strlen(w->pw_name);
	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
590e081d	29	for (len = 0, dst = name, src = get_gecos(w); len < sz; src++) {
e9bacb4f JH	30	int ch = *src;
	31	if (ch != '&') {
	32	*dst++ = ch;
	33	if (ch == 0 \|\| ch == ',')
	34	break;
	35	len++;
	36	continue;
	37	}
	38	if (len + nlen < sz) {
	39	/* Sorry, Mr. McDonald... */
	40	dst++ = toupper(w->pw_name);
	41	memcpy(dst, w->pw_name + 1, nlen - 1);
	42	dst += nlen - 1;
c0336ff2	43	len += nlen;
e9bacb4f JH	44	}
	45	}
	46	if (len < sz)
	47	name[len] = 0;
	48	else
	49	die("Your parents must have hated you!");
	50
	51	}
	52
8a55caa8 JN	53	static int add_mailname_host(char *buf, size_t len)
	54	{
	55	FILE *mailname;
	56
	57	mailname = fopen("/etc/mailname", "r");
	58	if (!mailname) {
	59	if (errno != ENOENT)
	60	warning("cannot open /etc/mailname: %s",
	61	strerror(errno));
	62	return -1;
	63	}
	64	if (!fgets(buf, len, mailname)) {
	65	if (ferror(mailname))
	66	warning("cannot read /etc/mailname: %s",
	67	strerror(errno));
	68	fclose(mailname);
	69	return -1;
	70	}
	71	/* success! */
	72	fclose(mailname);
	73	return 0;
	74	}
	75
	76	static void add_domainname(char *buf, size_t len)
	77	{
	78	struct hostent *he;
	79	size_t namelen;
	80	const char *domainname;
	81
	82	if (gethostname(buf, len)) {
	83	warning("cannot get host name: %s", strerror(errno));
	84	strlcpy(buf, "(none)", len);
	85	return;
	86	}
	87	namelen = strlen(buf);
	88	if (memchr(buf, '.', namelen))
	89	return;
	90
	91	he = gethostbyname(buf);
	92	buf[namelen++] = '.';
	93	buf += namelen;
	94	len -= namelen;
	95	if (he && (domainname = strchr(he->h_name, '.')))
	96	strlcpy(buf, domainname + 1, len);
	97	else
	98	strlcpy(buf, "(none)", len);
	99	}
	100
0b952a98	101	static void copy_email(const struct passwd *pw)
6aa33f40	102	{
01754769 JH	103	/*
	104	* Make up a fake email address
	105	* (name + '@' + hostname [+ '.' + domainname])
	106	*/
b0732115	107	size_t len = strlen(pw->pw_name);
e1b10391	108	if (len > sizeof(git_default_email)/2)
7a868a84	109	die("Your sysadmin must hate you!");
e1b10391 LT	110	memcpy(git_default_email, pw->pw_name, len);
e1b10391 LT	111	git_default_email[len++] = '@';
8a55caa8 JN	112
	113	if (!add_mailname_host(git_default_email + len,
	114	sizeof(git_default_email) - len))
	115	return; /* read from "/etc/mailname" (Debian) */
	116	add_domainname(git_default_email + len,
	117	sizeof(git_default_email) - len);
01754769 JH	118	}
01754769 JH	119
d855e4d3	120	static void setup_ident(const char name, const char emailp)
01754769 JH	121	{
	122	struct passwd *pw = NULL;
	123
	124	/* Get the name ("gecos") */
d855e4d3	125	if (!*name && !git_default_name[0]) {
01754769 JH	126	pw = getpwuid(getuid());
	127	if (!pw)
	128	die("You don't exist. Go away!");
	129	copy_gecos(pw, git_default_name, sizeof(git_default_name));
	130	}
d855e4d3 JN	131	if (!*name)
d855e4d3 JN	132	*name = git_default_name;
01754769	133
d855e4d3	134	if (!*emailp && !git_default_email[0]) {
46f74f00 MK	135	const char *email = getenv("EMAIL");
46f74f00 MK	136
99178c83	137	if (email && email[0]) {
46f74f00 MK	138	strlcpy(git_default_email, email,
46f74f00 MK	139	sizeof(git_default_email));
99178c83 JH	140	user_ident_explicitly_given \|= IDENT_MAIL_GIVEN;
99178c83 JH	141	} else {
46f74f00 MK	142	if (!pw)
	143	pw = getpwuid(getuid());
	144	if (!pw)
	145	die("You don't exist. Go away!");
	146	copy_email(pw);
	147	}
01754769	148	}
d855e4d3 JN	149	if (!*emailp)
d855e4d3 JN	150	*emailp = git_default_email;
01754769	151
6aa33f40	152	/* And set the default date */
01754769 JH	153	if (!git_default_date[0])
01754769 JH	154	datestamp(git_default_date, sizeof(git_default_date));
6aa33f40 LT	155	}
6aa33f40 LT	156
b0732115	157	static int add_raw(char buf, size_t size, int offset, const char str)
6aa33f40	158	{
b0732115	159	size_t len = strlen(str);
6aa33f40 LT	160	if (offset + len > size)
	161	return size;
	162	memcpy(buf + offset, str, len);
	163	return offset + len;
	164	}
	165
	166	static int crud(unsigned char c)
	167	{
f64c81d4 AR	168	return c <= 32 \|\|
	169	c == '.' \|\|
	170	c == ',' \|\|
	171	c == ':' \|\|
	172	c == ';' \|\|
	173	c == '<' \|\|
	174	c == '>' \|\|
	175	c == '"' \|\|
d404bf02	176	c == '\\' \|\|
f64c81d4	177	c == '\'';
6aa33f40 LT	178	}
	179
	180	/*
	181	* Copy over a string to the destination, but avoid special
	182	* characters ('\n', '<' and '>') and remove crud at the end
	183	*/
b0732115	184	static int copy(char buf, size_t size, int offset, const char src)
6aa33f40	185	{
b0732115	186	size_t i, len;
6aa33f40 LT	187	unsigned char c;
	188
	189	/* Remove crud from the beginning.. */
	190	while ((c = *src) != 0) {
	191	if (!crud(c))
	192	break;
	193	src++;
	194	}
	195
	196	/* Remove crud from the end.. */
	197	len = strlen(src);
	198	while (len > 0) {
	199	c = src[len-1];
	200	if (!crud(c))
	201	break;
	202	--len;
	203	}
	204
	205	/*
	206	* Copy the rest to the buffer, but avoid the special
82f9d58a	207	* characters '\n' '<' and '>' that act as delimiters on
790296fd	208	* an identification line
6aa33f40 LT	209	*/
	210	for (i = 0; i < len; i++) {
	211	c = *src++;
	212	switch (c) {
	213	case '\n': case '<': case '>':
	214	continue;
	215	}
	216	if (offset >= size)
	217	return size;
	218	buf[offset++] = c;
	219	}
	220	return offset;
	221	}
	222
749be728	223	static const char *env_hint =
d5cc2de9	224	"\n"
6c293d40	225	"*** Please tell me who you are.\n"
d5cc2de9 HWN	226	"\n"
	227	"Run\n"
	228	"\n"
8e7425da	229	" git config --global user.email \"you@example.com\"\n"
180787c4	230	" git config --global user.name \"Your Name\"\n"
d5cc2de9	231	"\n"
180787c4 SP	232	"to set your account\'s default identity.\n"
180787c4 SP	233	"Omit --global to set the identity only in this repository.\n"
d5cc2de9	234	"\n";
749be728	235
774751a8 JH	236	const char fmt_ident(const char name, const char *email,
774751a8 JH	237	const char *date_str, int flag)
6aa33f40 LT	238	{
	239	static char buffer[1000];
	240	char date[50];
	241	int i;
774751a8 JH	242	int error_on_no_name = (flag & IDENT_ERROR_ON_NO_NAME);
	243	int warn_on_no_name = (flag & IDENT_WARN_ON_NO_NAME);
	244	int name_addr_only = (flag & IDENT_NO_DATE);
6aa33f40	245
d855e4d3	246	setup_ident(&name, &email);
dfdd309e	247
749be728	248	if (!*name) {
cb280e10 JH	249	struct passwd *pw;
cb280e10 JH	250
774751a8	251	if ((warn_on_no_name \|\| error_on_no_name) &&
cb280e10	252	name == git_default_name && env_hint) {
8b770a2a	253	fputs(env_hint, stderr);
c27b3925	254	env_hint = NULL; /* warn only once */
749be728	255	}
774751a8	256	if (error_on_no_name)
749be728	257	die("empty ident %s <%s> not allowed", name, email);
cb280e10 JH	258	pw = getpwuid(getuid());
	259	if (!pw)
	260	die("You don't exist. Go away!");
	261	strlcpy(git_default_name, pw->pw_name,
	262	sizeof(git_default_name));
	263	name = git_default_name;
749be728	264	}
dfdd309e	265
e1b10391	266	strcpy(date, git_default_date);
4579bb41 JK	267	if (!name_addr_only && date_str && date_str[0]) {
	268	if (parse_date(date_str, date, sizeof(date)) < 0)
	269	die("invalid date format: %s", date_str);
	270	}
6aa33f40 LT	271
	272	i = copy(buffer, sizeof(buffer), 0, name);
	273	i = add_raw(buffer, sizeof(buffer), i, " <");
	274	i = copy(buffer, sizeof(buffer), i, email);
d9ccfe77 JH	275	if (!name_addr_only) {
	276	i = add_raw(buffer, sizeof(buffer), i, "> ");
	277	i = copy(buffer, sizeof(buffer), i, date);
	278	} else {
	279	i = add_raw(buffer, sizeof(buffer), i, ">");
	280	}
6aa33f40 LT	281	if (i >= sizeof(buffer))
	282	die("Impossibly long personal identifier");
	283	buffer[i] = 0;
	284	return buffer;
	285	}
d289d136	286
d9ccfe77 JH	287	const char fmt_name(const char name, const char *email)
d9ccfe77 JH	288	{
774751a8	289	return fmt_ident(name, email, NULL, IDENT_ERROR_ON_NO_NAME \| IDENT_NO_DATE);
d9ccfe77 JH	290	}
d9ccfe77 JH	291
774751a8	292	const char *git_author_info(int flag)
d289d136	293	{
798123af	294	return fmt_ident(getenv("GIT_AUTHOR_NAME"),
c7d77dab	295	getenv("GIT_AUTHOR_EMAIL"),
749be728	296	getenv("GIT_AUTHOR_DATE"),
774751a8	297	flag);
d289d136 EB	298	}
d289d136 EB	299
774751a8	300	const char *git_committer_info(int flag)
d289d136	301	{
91c38a21 JH	302	if (getenv("GIT_COMMITTER_NAME"))
	303	user_ident_explicitly_given \|= IDENT_NAME_GIVEN;
	304	if (getenv("GIT_COMMITTER_EMAIL"))
	305	user_ident_explicitly_given \|= IDENT_MAIL_GIVEN;
798123af	306	return fmt_ident(getenv("GIT_COMMITTER_NAME"),
c7d77dab	307	getenv("GIT_COMMITTER_EMAIL"),
749be728	308	getenv("GIT_COMMITTER_DATE"),
774751a8	309	flag);
d289d136	310	}
5aeb3a3a JH	311
	312	int user_ident_sufficiently_given(void)
	313	{
	314	#ifndef WINDOWS
	315	return (user_ident_explicitly_given & IDENT_MAIL_GIVEN);
	316	#else
	317	return (user_ident_explicitly_given == IDENT_ALL_GIVEN);
	318	#endif
	319	}