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

8 9
#include "common.h"

10 11 12
#include "git2/attr.h"
#include "git2/blob.h"
#include "git2/index.h"
13
#include "git2/sys/filter.h"
14

15
#include "futils.h"
16 17 18 19
#include "hash.h"
#include "filter.h"
#include "repository.h"

20 21 22 23 24 25 26 27 28 29 30
typedef enum {
	GIT_CRLF_UNDEFINED,
	GIT_CRLF_BINARY,
	GIT_CRLF_TEXT,
	GIT_CRLF_TEXT_INPUT,
	GIT_CRLF_TEXT_CRLF,
	GIT_CRLF_AUTO,
	GIT_CRLF_AUTO_INPUT,
	GIT_CRLF_AUTO_CRLF,
} git_crlf_t;

31
struct crlf_attrs {
32 33 34
	int attr_action; /* the .gitattributes setting */
	int crlf_action; /* the core.autocrlf setting */

35
	int auto_crlf;
36
	int safe_crlf;
37
	int core_eol;
38 39 40 41 42 43
};

struct crlf_filter {
	git_filter f;
};

44
static git_crlf_t check_crlf(const char *value)
45
{
46
	if (GIT_ATTR_IS_TRUE(value))
47
		return GIT_CRLF_TEXT;
48
	else if (GIT_ATTR_IS_FALSE(value))
49
		return GIT_CRLF_BINARY;
50
	else if (GIT_ATTR_IS_UNSPECIFIED(value))
51 52 53 54
		;
	else if (strcmp(value, "input") == 0)
		return GIT_CRLF_TEXT_INPUT;
	else if (strcmp(value, "auto") == 0)
55 56
		return GIT_CRLF_AUTO;

57
	return GIT_CRLF_UNDEFINED;
58 59
}

60
static git_configmap_value check_eol(const char *value)
61
{
62
	if (GIT_ATTR_IS_UNSPECIFIED(value))
63 64
		;
	else if (strcmp(value, "lf") == 0)
65
		return GIT_EOL_LF;
66
	else if (strcmp(value, "crlf") == 0)
67 68 69 70 71
		return GIT_EOL_CRLF;

	return GIT_EOL_UNSET;
}

72
static int has_cr_in_index(const git_filter_source *src)
73
{
74 75
	git_repository *repo = git_filter_source_repo(src);
	const char *path = git_filter_source_path(src);
76 77 78 79
	git_index *index;
	const git_index_entry *entry;
	git_blob *blob;
	const void *blobcontent;
80
	git_object_size_t blobsize;
81 82
	bool found_cr;

83 84 85
	if (!path)
		return false;

86
	if (git_repository_index__weakptr(&index, repo) < 0) {
87
		git_error_clear();
88 89 90
		return false;
	}

91 92
	if (!(entry = git_index_get_bypath(index, path, 0)) &&
		!(entry = git_index_get_bypath(index, path, 1)))
93 94 95 96 97
		return false;

	if (!S_ISREG(entry->mode)) /* don't crlf filter non-blobs */
		return true;

98
	if (git_blob_lookup(&blob, repo, &entry->id) < 0)
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
		return false;

	blobcontent = git_blob_rawcontent(blob);
	blobsize    = git_blob_rawsize(blob);
	if (!git__is_sizet(blobsize))
		blobsize = (size_t)-1;

	found_cr = (blobcontent != NULL &&
		blobsize > 0 &&
		memchr(blobcontent, '\r', (size_t)blobsize) != NULL);

	git_blob_free(blob);
	return found_cr;
}

114
static int text_eol_is_crlf(struct crlf_attrs *ca)
115
{
116 117 118
	if (ca->auto_crlf == GIT_AUTO_CRLF_TRUE)
		return 1;
	else if (ca->auto_crlf == GIT_AUTO_CRLF_INPUT)
119 120
		return 0;

121 122 123 124
	if (ca->core_eol == GIT_EOL_CRLF)
		return 1;
	if (ca->core_eol == GIT_EOL_UNSET && GIT_EOL_NATIVE == GIT_EOL_CRLF)
		return 1;
125

126 127
	return 0;
}
128

129
static git_configmap_value output_eol(struct crlf_attrs *ca)
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
{
	switch (ca->crlf_action) {
	case GIT_CRLF_BINARY:
		return GIT_EOL_UNSET;
	case GIT_CRLF_TEXT_CRLF:
		return GIT_EOL_CRLF;
	case GIT_CRLF_TEXT_INPUT:
		return GIT_EOL_LF;
	case GIT_CRLF_UNDEFINED:
	case GIT_CRLF_AUTO_CRLF:
		return GIT_EOL_CRLF;
	case GIT_CRLF_AUTO_INPUT:
		return GIT_EOL_LF;
	case GIT_CRLF_TEXT:
	case GIT_CRLF_AUTO:
		return text_eol_is_crlf(ca) ? GIT_EOL_CRLF : GIT_EOL_LF;
	}

	/* TODO: warn when available */
	return ca->core_eol;
}

GIT_INLINE(int) check_safecrlf(
	struct crlf_attrs *ca,
	const git_filter_source *src,
	git_buf_text_stats *stats)
{
	const char *filename = git_filter_source_path(src);

	if (!ca->safe_crlf)
		return 0;

	if (output_eol(ca) == GIT_EOL_LF) {
		/*
		 * CRLFs would not be restored by checkout:
		 * check if we'd remove CRLFs
		 */
		if (stats->crlf) {
			if (ca->safe_crlf == GIT_SAFE_CRLF_WARN) {
				/* TODO: issue a warning when available */
			} else {
				if (filename && *filename)
172 173
					git_error_set(
						GIT_ERROR_FILTER, "CRLF would be replaced by LF in '%s'",
174 175
						filename);
				else
176 177
					git_error_set(
						GIT_ERROR_FILTER, "CRLF would be replaced by LF");
178

179 180
				return -1;
			}
181
		}
182
	} else if (output_eol(ca) == GIT_EOL_CRLF) {
183
		/*
184 185
		 * CRLFs would be added by checkout:
		 * check if we have "naked" LFs
186
		 */
187 188 189 190 191
		if (stats->crlf != stats->lf) {
			if (ca->safe_crlf == GIT_SAFE_CRLF_WARN) {
				/* TODO: issue a warning when available */
			} else {
				if (filename && *filename)
192 193
					git_error_set(
						GIT_ERROR_FILTER, "LF would be replaced by CRLF in '%s'",
194 195
						filename);
				else
196 197
					git_error_set(
						GIT_ERROR_FILTER, "LF would be replaced by CRLF");
198

199 200
				return -1;
			}
201 202 203
		}
	}

204
	return 0;
Ben Straub committed
205 206
}

207 208 209 210 211
static int crlf_apply_to_odb(
	struct crlf_attrs *ca,
	git_buf *to,
	const git_buf *from,
	const git_filter_source *src)
Ben Straub committed
212
{
213 214 215
	git_buf_text_stats stats;
	bool is_binary;
	int error;
Ben Straub committed
216

217 218 219
	/* Binary attribute? Empty file? Nothing to do */
	if (ca->crlf_action == GIT_CRLF_BINARY || !git_buf_len(from))
		return GIT_PASSTHROUGH;
Ben Straub committed
220

221
	is_binary = git_buf_gather_text_stats(&stats, from, false);
222

223 224 225 226 227 228
	/* Heuristics to see if we can skip the conversion.
	 * Straight from Core Git.
	 */
	if (ca->crlf_action == GIT_CRLF_AUTO ||
		ca->crlf_action == GIT_CRLF_AUTO_INPUT ||
		ca->crlf_action == GIT_CRLF_AUTO_CRLF) {
Ben Straub committed
229

230 231 232 233 234 235 236 237 238
		if (is_binary)
			return GIT_PASSTHROUGH;

		/*
		 * If the file in the index has any CR in it, do not convert.
		 * This is the new safer autocrlf handling.
		 */
		if (has_cr_in_index(src))
			return GIT_PASSTHROUGH;
Ben Straub committed
239 240
	}

241 242 243 244 245 246 247 248
	if ((error = check_safecrlf(ca, src, &stats)) < 0)
		return error;

	/* If there are no CR characters to filter out, then just pass */
	if (!stats.crlf)
		return GIT_PASSTHROUGH;

	/* Actually drop the carriage returns */
249
	return git_buf_crlf_to_lf(to, from);
Ben Straub committed
250 251
}

252
static int crlf_apply_to_workdir(
253 254 255
	struct crlf_attrs *ca,
	git_buf *to,
	const git_buf *from)
Ben Straub committed
256
{
257 258
	git_buf_text_stats stats;
	bool is_binary;
Ben Straub committed
259 260

	/* Empty file? Nothing to do. */
261
	if (git_buf_len(from) == 0 || output_eol(ca) != GIT_EOL_CRLF)
Edward Thomson committed
262
		return GIT_PASSTHROUGH;
263

264
	is_binary = git_buf_gather_text_stats(&stats, from, false);
265

266
	/* If there are no LFs, or all LFs are part of a CRLF, nothing to do */
267 268 269 270
	if (stats.lf == 0 || stats.lf == stats.crlf)
		return GIT_PASSTHROUGH;

	if (ca->crlf_action == GIT_CRLF_AUTO ||
271 272
		ca->crlf_action == GIT_CRLF_AUTO_INPUT ||
		ca->crlf_action == GIT_CRLF_AUTO_CRLF) {
273 274

		/* If we have any existing CR or CRLF line endings, do nothing */
275
		if (stats.cr > 0)
276 277 278 279 280 281 282
			return GIT_PASSTHROUGH;

		/* Don't filter binary files */
		if (is_binary)
			return GIT_PASSTHROUGH;
	}

283
	return git_buf_lf_to_crlf(to, from);
Ben Straub committed
284 285
}

286 287 288 289
static int convert_attrs(
	struct crlf_attrs *ca,
	const char **attr_values,
	const git_filter_source *src)
290 291
{
	int error;
292

293 294
	memset(ca, 0, sizeof(struct crlf_attrs));

295 296 297 298 299 300
	if ((error = git_repository__configmap_lookup(&ca->auto_crlf,
		 git_filter_source_repo(src), GIT_CONFIGMAP_AUTO_CRLF)) < 0 ||
		(error = git_repository__configmap_lookup(&ca->safe_crlf,
		 git_filter_source_repo(src), GIT_CONFIGMAP_SAFE_CRLF)) < 0 ||
		(error = git_repository__configmap_lookup(&ca->core_eol,
		 git_filter_source_repo(src), GIT_CONFIGMAP_EOL)) < 0)
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
		return error;

	/* downgrade FAIL to WARN if ALLOW_UNSAFE option is used */
	if ((git_filter_source_flags(src) & GIT_FILTER_ALLOW_UNSAFE) &&
		ca->safe_crlf == GIT_SAFE_CRLF_FAIL)
		ca->safe_crlf = GIT_SAFE_CRLF_WARN;

	if (attr_values) {
		/* load the text attribute */
		ca->crlf_action = check_crlf(attr_values[2]); /* text */

		if (ca->crlf_action == GIT_CRLF_UNDEFINED)
			ca->crlf_action = check_crlf(attr_values[0]); /* crlf */

		if (ca->crlf_action != GIT_CRLF_BINARY) {
			/* load the eol attribute */
			int eol_attr = check_eol(attr_values[1]);

			if (ca->crlf_action == GIT_CRLF_AUTO && eol_attr == GIT_EOL_LF)
				ca->crlf_action = GIT_CRLF_AUTO_INPUT;
			else if (ca->crlf_action == GIT_CRLF_AUTO && eol_attr == GIT_EOL_CRLF)
				ca->crlf_action = GIT_CRLF_AUTO_CRLF;
			else if (eol_attr == GIT_EOL_LF)
				ca->crlf_action = GIT_CRLF_TEXT_INPUT;
			else if (eol_attr == GIT_EOL_CRLF)
				ca->crlf_action = GIT_CRLF_TEXT_CRLF;
		}
328

329
		ca->attr_action = ca->crlf_action;
330
	} else {
331
		ca->crlf_action = GIT_CRLF_UNDEFINED;
332
	}
333

334 335 336 337 338 339 340 341
	if (ca->crlf_action == GIT_CRLF_TEXT)
		ca->crlf_action = text_eol_is_crlf(ca) ? GIT_CRLF_TEXT_CRLF : GIT_CRLF_TEXT_INPUT;
	if (ca->crlf_action == GIT_CRLF_UNDEFINED && ca->auto_crlf == GIT_AUTO_CRLF_FALSE)
		ca->crlf_action = GIT_CRLF_BINARY;
	if (ca->crlf_action == GIT_CRLF_UNDEFINED && ca->auto_crlf == GIT_AUTO_CRLF_TRUE)
		ca->crlf_action = GIT_CRLF_AUTO_CRLF;
	if (ca->crlf_action == GIT_CRLF_UNDEFINED && ca->auto_crlf == GIT_AUTO_CRLF_INPUT)
		ca->crlf_action = GIT_CRLF_AUTO_INPUT;
342

343 344
	return 0;
}
345

346 347 348 349 350 351 352
static int crlf_check(
	git_filter *self,
	void **payload, /* points to NULL ptr on entry, may be set */
	const git_filter_source *src,
	const char **attr_values)
{
	struct crlf_attrs ca;
353

354
	GIT_UNUSED(self);
355

356
	convert_attrs(&ca, attr_values, src);
357

358 359
	if (ca.crlf_action == GIT_CRLF_BINARY)
		return GIT_PASSTHROUGH;
360

361
	*payload = git__malloc(sizeof(ca));
362
	GIT_ERROR_CHECK_ALLOC(*payload);
363
	memcpy(*payload, &ca, sizeof(ca));
364

365 366 367 368
	return 0;
}

static int crlf_apply(
369 370 371
	git_filter *self,
	void **payload, /* may be read and/or set */
	git_buf *to,
372
	const git_buf *from,
373 374
	const git_filter_source *src)
{
375 376 377
	/* initialize payload in case `check` was bypassed */
	if (!*payload) {
		int error = crlf_check(self, payload, src, NULL);
378

379
		if (error < 0)
380 381
			return error;
	}
382

383
	if (git_filter_source_mode(src) == GIT_FILTER_SMUDGE)
384 385 386
		return crlf_apply_to_workdir(*payload, to, from);
	else
		return crlf_apply_to_odb(*payload, to, from, src);
387 388
}

389 390 391
static void crlf_cleanup(
	git_filter *self,
	void       *payload)
392
{
393 394
	GIT_UNUSED(self);
	git__free(payload);
395 396
}

397
git_filter *git_crlf_filter_new(void)
398
{
399
	struct crlf_filter *f = git__calloc(1, sizeof(struct crlf_filter));
Jacques Germishuys committed
400 401
	if (f == NULL)
		return NULL;
402

403
	f->f.version = GIT_FILTER_VERSION;
404 405
	f->f.attributes = "crlf eol text";
	f->f.initialize = NULL;
Russell Belfer committed
406
	f->f.shutdown = git_filter_free;
407 408 409
	f->f.check    = crlf_check;
	f->f.apply    = crlf_apply;
	f->f.cleanup  = crlf_cleanup;
410

411
	return (git_filter *)f;
412
}