signature.c 6.72 KB
Newer Older
1
/*
Edward Thomson committed
2
 * Copyright (C) the libgit2 contributors. All rights reserved.
3
 *
Vicent Marti committed
4 5
 * This file is part of libgit2, distributed under the GNU GPL v2 with
 * a Linking Exception. For full terms see the included COPYING file.
6 7 8
 */

#include "common.h"
9
#include "signature.h"
10
#include "repository.h"
11
#include "git2/common.h"
12
#include "posix.h"
13

14
void git_signature_free(git_signature *sig)
15
{
16
	if (sig == NULL)
17 18
		return;

19
	git__free(sig->name);
20
	sig->name = NULL;
21
	git__free(sig->email);
22
	sig->email = NULL;
23
	git__free(sig);
24 25
}

26 27
static int signature_error(const char *msg)
{
28
	giterr_set(GITERR_INVALID, "Failed to parse signature - %s", msg);
29 30 31
	return -1;
}

32
static bool contains_angle_brackets(const char *input)
33
{
34
	return strchr(input, '<') != NULL || strchr(input, '>') != NULL;
35 36
}

37
static char *extract_trimmed(const char *ptr, size_t len)
38
{
39
	while (len && git__isspace(ptr[0])) {
40 41
		ptr++; len--;
	}
42

43
	while (len && git__isspace(ptr[len - 1])) {
44 45 46 47
		len--;
	}

	return git__substrdup(ptr, len);
48 49
}

50
int git_signature_new(git_signature **sig_out, const char *name, const char *email, git_time_t time, int offset)
51
{
52
	git_signature *p = NULL;
53

54 55
	assert(name && email);

56 57
	*sig_out = NULL;

58 59 60 61 62 63
	if (contains_angle_brackets(name) ||
		contains_angle_brackets(email)) {
		return signature_error(
			"Neither `name` nor `email` should contain angle brackets chars.");
	}

64 65
	p = git__calloc(1, sizeof(git_signature));
	GITERR_CHECK_ALLOC(p);
66

67 68 69
	p->name = extract_trimmed(name, strlen(name));
	p->email = extract_trimmed(email, strlen(email));

70 71 72
	if (p->name == NULL || p->email == NULL)
		return -1; /* oom */

73
	if (p->name[0] == '\0' || p->email[0] == '\0') {
74
		git_signature_free(p);
75
		return signature_error("Signature cannot have an empty name or email");
76
	}
77

78 79
	p->when.time = time;
	p->when.offset = offset;
80

81
	*sig_out = p;
82
	return 0;
83 84
}

85
int git_signature_dup(git_signature **dest, const git_signature *source)
86
{
87
	git_signature *signature;
88

89 90 91 92 93 94 95 96
	if (source == NULL)
		return 0;

	signature = git__calloc(1, sizeof(git_signature));
	GITERR_CHECK_ALLOC(signature);

	signature->name = git__strdup(source->name);
	GITERR_CHECK_ALLOC(signature->name);
97

98 99
	signature->email = git__strdup(source->email);
	GITERR_CHECK_ALLOC(signature->email);
100

101 102
	signature->when.time = source->when.time;
	signature->when.offset = source->when.offset;
103

104 105 106
	*dest = signature;

	return 0;
107 108
}

109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
int git_signature__pdup(git_signature **dest, const git_signature *source, git_pool *pool)
{
	git_signature *signature;

	if (source == NULL)
		return 0;

	signature = git_pool_mallocz(pool, sizeof(git_signature));
	GITERR_CHECK_ALLOC(signature);

	signature->name = git_pool_strdup(pool, source->name);
	GITERR_CHECK_ALLOC(signature->name);

	signature->email = git_pool_strdup(pool, source->email);
	GITERR_CHECK_ALLOC(signature->email);

	signature->when.time = source->when.time;
	signature->when.offset = source->when.offset;

	*dest = signature;

	return 0;
}

133
int git_signature_now(git_signature **sig_out, const char *name, const char *email)
134 135
{
	time_t now;
136
	time_t offset;
137
	struct tm *utc_tm;
138
	git_signature *sig;
139
	struct tm _utc;
140

141 142
	*sig_out = NULL;

143 144 145 146 147 148 149 150
	/*
	 * Get the current time as seconds since the epoch and
	 * transform that into a tm struct containing the time at
	 * UTC. Give that to mktime which considers it a local time
	 * (tm_isdst = -1 asks it to take DST into account) and gives
	 * us that time as seconds since the epoch. The difference
	 * between its return value and 'now' is our offset to UTC.
	 */
151
	time(&now);
152
	utc_tm = p_gmtime_r(&now, &_utc);
153
	utc_tm->tm_isdst = -1;
154
	offset = (time_t)difftime(now, mktime(utc_tm));
155
	offset /= 60;
156

157 158
	if (git_signature_new(&sig, name, email, now, (int)offset) < 0)
		return -1;
159 160 161

	*sig_out = sig;

162 163 164
	return 0;
}

165 166 167
int git_signature_default(git_signature **out, git_repository *repo)
{
	int error;
168
	git_config *cfg;
169 170
	const char *user_name, *user_email;

171
	if ((error = git_repository_config_snapshot(&cfg, repo)) < 0)
172 173 174 175 176 177 178 179 180 181
		return error;

	if (!(error = git_config_get_string(&user_name, cfg, "user.name")) &&
		!(error = git_config_get_string(&user_email, cfg, "user.email")))
		error = git_signature_now(out, user_name, user_email);

	git_config_free(cfg);
	return error;
}

182
int git_signature__parse(git_signature *sig, const char **buffer_out,
183
		const char *buffer_end, const char *header, char ender)
184
{
185
	const char *buffer = *buffer_out;
186
	const char *email_start, *email_end;
187

188
	memset(sig, 0, sizeof(git_signature));
189

190
	if ((buffer_end = memchr(buffer, ender, buffer_end - buffer)) == NULL)
191
		return signature_error("no newline given");
192

193 194
	if (header) {
		const size_t header_len = strlen(header);
195

196
		if (buffer + header_len >= buffer_end || memcmp(buffer, header, header_len) != 0)
197
			return signature_error("expected prefix doesn't match actual");
198

199 200
		buffer += header_len;
	}
201

202 203
	email_start = git__memrchr(buffer, '<', buffer_end - buffer);
	email_end = git__memrchr(buffer, '>', buffer_end - buffer);
204

205
	if (!email_start || !email_end || email_end <= email_start)
206
		return signature_error("malformed e-mail");
207

208
	email_start += 1;
Vicent Marti committed
209
	sig->name = extract_trimmed(buffer, email_start - buffer - 1);
210
	sig->email = extract_trimmed(email_start, email_end - email_start);
211

212 213 214 215
	/* Do we even have a time at the end of the signature? */
	if (email_end + 2 < buffer_end) {
		const char *time_start = email_end + 2;
		const char *time_end;
216

217 218
		if (git__strtol64(&sig->when.time, time_start, &time_end, 10) < 0)
			return signature_error("invalid Unix timestamp");
219

Vicent Marti committed
220
		/* do we have a timezone? */
221 222 223 224 225 226
		if (time_end + 1 < buffer_end) {
			int offset, hours, mins;
			const char *tz_start, *tz_end;

			tz_start = time_end + 1;

nulltoken committed
227
			if ((tz_start[0] != '-' && tz_start[0] != '+') ||
228 229 230 231
				git__strtol32(&offset, tz_start + 1, &tz_end, 10) < 0) {
				//malformed timezone, just assume it's zero
				offset = 0;
			}
232 233 234

			hours = offset / 100;
			mins = offset % 100;
235

236 237 238 239 240 241 242 243 244 245
			/*
			 * only store timezone if it's not overflowing;
			 * see http://www.worldtimezone.com/faq.html
			 */
			if (hours < 14 && mins < 59) {
				sig->when.offset = (hours * 60) + mins;
				if (tz_start[0] == '-')
					sig->when.offset = -sig->when.offset;
			}
		}
246
	}
247

248
	*buffer_out = buffer_end + 1;
249
	return 0;
250 251
}

252 253 254 255 256
void git_signature__writebuf(git_buf *buf, const char *header, const git_signature *sig)
{
	int offset, hours, mins;
	char sign;

257 258
	assert(buf && sig);

259 260 261 262 263 264 265 266 267 268 269 270 271
	offset = sig->when.offset;
	sign = (sig->when.offset < 0) ? '-' : '+';

	if (offset < 0)
		offset = -offset;

	hours = offset / 60;
	mins = offset % 60;

	git_buf_printf(buf, "%s%s <%s> %u %c%02d%02d\n",
			header ? header : "", sig->name, sig->email,
			(unsigned)sig->when.time, sign, hours, mins);
}
272

273 274 275 276 277 278 279 280 281 282 283
bool git_signature__equal(const git_signature *one, const git_signature *two)
{
	assert(one && two);

	return
		git__strcmp(one->name, two->name) == 0 &&
		git__strcmp(one->email, two->email) == 0 &&
		one->when.time == two->when.time &&
		one->when.offset == two->when.offset;
}