3 #include "run-command.h"
7 * convert.c - convert a file when checking it out and checking it in.
9 * This should use the pathname to decide on whether it wants to do some
10 * more interesting conversions (automatic gzip/unzip, general format
11 * conversions etc etc), but by default it just does automatic CRLF<->LF
12 * translation when the "text" attribute or "auto_crlf" option is set.
25 /* NUL, CR, LF and CRLF counts */
26 unsigned nul, cr, lf, crlf;
28 /* These are just approximations! */
29 unsigned printable, nonprintable;
32 static void gather_stats(const char *buf, unsigned long size, struct text_stat *stats)
36 memset(stats, 0, sizeof(*stats));
38 for (i = 0; i < size; i++) {
39 unsigned char c = buf[i];
42 if (i+1 < size && buf[i+1] == '\n')
52 stats->nonprintable++;
55 /* BS, HT, ESC and FF */
56 case '\b': case '\t': case '\033': case '\014':
63 stats->nonprintable++;
70 /* If file ends with EOF then don't count this EOF as non-printable. */
71 if (size >= 1 && buf[size-1] == '\032')
72 stats->nonprintable--;
76 * The same heuristics as diff.c::mmfile_is_binary()
78 static int is_binary(unsigned long size, struct text_stat *stats)
83 if ((stats->printable >> 7) < stats->nonprintable)
86 * Other heuristics? Average line length might be relevant,
87 * as might LF vs CR vs CRLF counts..
89 * NOTE! It might be normal to have a low ratio of CRLF to LF
90 * (somebody starts with a LF-only file and edits it with an editor
91 * that adds CRLF only to lines that are added..). But do we
92 * want to support CR-only? Probably not.
97 static enum eol output_eol(enum crlf_action crlf_action)
99 switch (crlf_action) {
112 if (auto_crlf == AUTO_CRLF_TRUE)
114 else if (auto_crlf == AUTO_CRLF_INPUT)
116 else if (core_eol == EOL_UNSET)
122 static void check_safe_crlf(const char *path, enum crlf_action crlf_action,
123 struct text_stat *stats, enum safe_crlf checksafe)
128 if (output_eol(crlf_action) == EOL_LF) {
130 * CRLFs would not be restored by checkout:
131 * check if we'd remove CRLFs
134 if (checksafe == SAFE_CRLF_WARN)
135 warning("CRLF will be replaced by LF in %s.\nThe file will have its original line endings in your working directory.", path);
136 else /* i.e. SAFE_CRLF_FAIL */
137 die("CRLF would be replaced by LF in %s.", path);
139 } else if (output_eol(crlf_action) == EOL_CRLF) {
141 * CRLFs would be added by checkout:
142 * check if we have "naked" LFs
144 if (stats->lf != stats->crlf) {
145 if (checksafe == SAFE_CRLF_WARN)
146 warning("LF will be replaced by CRLF in %s.\nThe file will have its original line endings in your working directory.", path);
147 else /* i.e. SAFE_CRLF_FAIL */
148 die("LF would be replaced by CRLF in %s", path);
153 static int has_cr_in_index(const char *path)
157 enum object_type type;
160 struct index_state *istate = &the_index;
163 pos = index_name_pos(istate, path, len);
166 * We might be in the middle of a merge, in which
167 * case we would read stage #2 (ours).
171 (pos < 0 && i < istate->cache_nr &&
172 !strcmp(istate->cache[i]->name, path));
174 if (ce_stage(istate->cache[i]) == 2)
179 data = read_sha1_file(istate->cache[pos]->sha1, &type, &sz);
180 if (!data || type != OBJ_BLOB) {
185 has_cr = memchr(data, '\r', sz) != NULL;
190 static int crlf_to_git(const char *path, const char *src, size_t len,
192 enum crlf_action crlf_action, enum safe_crlf checksafe)
194 struct text_stat stats;
197 if (crlf_action == CRLF_BINARY ||
198 (crlf_action == CRLF_GUESS && auto_crlf == AUTO_CRLF_FALSE) || !len)
201 gather_stats(src, len, &stats);
203 if (crlf_action == CRLF_AUTO || crlf_action == CRLF_GUESS) {
205 * We're currently not going to even try to convert stuff
206 * that has bare CR characters. Does anybody do that crazy
209 if (stats.cr != stats.crlf)
213 * And add some heuristics for binary vs text, of course...
215 if (is_binary(len, &stats))
218 if (crlf_action == CRLF_GUESS) {
220 * If the file in the index has any CR in it, do not convert.
221 * This is the new safer autocrlf handling.
223 if (has_cr_in_index(path))
228 check_safe_crlf(path, crlf_action, &stats, checksafe);
230 /* Optimization: No CR? Nothing to convert, regardless. */
234 /* only grow if not in place */
235 if (strbuf_avail(buf) + buf->len < len)
236 strbuf_grow(buf, len - buf->len);
238 if (crlf_action == CRLF_AUTO || crlf_action == CRLF_GUESS) {
240 * If we guessed, we already know we rejected a file with
241 * lone CR, and we can strip a CR without looking at what
245 unsigned char c = *src++;
251 unsigned char c = *src++;
252 if (! (c == '\r' && (1 < len && *src == '\n')))
256 strbuf_setlen(buf, dst - buf->buf);
260 static int crlf_to_worktree(const char *path, const char *src, size_t len,
261 struct strbuf *buf, enum crlf_action crlf_action)
263 char *to_free = NULL;
264 struct text_stat stats;
266 if (!len || output_eol(crlf_action) != EOL_CRLF)
269 gather_stats(src, len, &stats);
271 /* No LF? Nothing to convert, regardless. */
275 /* Was it already in CRLF format? */
276 if (stats.lf == stats.crlf)
279 if (crlf_action == CRLF_AUTO || crlf_action == CRLF_GUESS) {
280 if (crlf_action == CRLF_GUESS) {
281 /* If we have any CR or CRLF line endings, we do not touch it */
282 /* This is the new safer autocrlf-handling */
283 if (stats.cr > 0 || stats.crlf > 0)
287 /* If we have any bare CR characters, we're not going to touch it */
288 if (stats.cr != stats.crlf)
291 if (is_binary(len, &stats))
295 /* are we "faking" in place editing ? */
297 to_free = strbuf_detach(buf, NULL);
299 strbuf_grow(buf, len + stats.lf - stats.crlf);
301 const char *nl = memchr(src, '\n', len);
304 if (nl > src && nl[-1] == '\r') {
305 strbuf_add(buf, src, nl + 1 - src);
307 strbuf_add(buf, src, nl - src);
308 strbuf_addstr(buf, "\r\n");
313 strbuf_add(buf, src, len);
319 struct filter_params {
326 static int filter_buffer(int in, int out, void *data)
329 * Spawn cmd and feed the buffer contents through its stdin.
331 struct child_process child_process;
332 struct filter_params *params = (struct filter_params *)data;
333 int write_err, status;
334 const char *argv[] = { NULL, NULL };
336 /* apply % substitution to cmd */
337 struct strbuf cmd = STRBUF_INIT;
338 struct strbuf path = STRBUF_INIT;
339 struct strbuf_expand_dict_entry dict[] = {
344 /* quote the path to preserve spaces, etc. */
345 sq_quote_buf(&path, params->path);
346 dict[0].value = path.buf;
348 /* expand all %f with the quoted path */
349 strbuf_expand(&cmd, params->cmd, strbuf_expand_dict_cb, &dict);
350 strbuf_release(&path);
354 memset(&child_process, 0, sizeof(child_process));
355 child_process.argv = argv;
356 child_process.use_shell = 1;
357 child_process.in = -1;
358 child_process.out = out;
360 if (start_command(&child_process))
361 return error("cannot fork to run external filter %s", params->cmd);
363 write_err = (write_in_full(child_process.in, params->src, params->size) < 0);
364 if (close(child_process.in))
367 error("cannot feed the input to external filter %s", params->cmd);
369 status = finish_command(&child_process);
371 error("external filter %s failed %d", params->cmd, status);
373 strbuf_release(&cmd);
374 return (write_err || status);
377 static int apply_filter(const char *path, const char *src, size_t len,
378 struct strbuf *dst, const char *cmd)
381 * Create a pipeline to have the command filter the buffer's
384 * (child --> cmd) --> us
387 struct strbuf nbuf = STRBUF_INIT;
389 struct filter_params params;
394 memset(&async, 0, sizeof(async));
395 async.proc = filter_buffer;
396 async.data = ¶ms;
404 if (start_async(&async))
405 return 0; /* error was already reported */
407 if (strbuf_read(&nbuf, async.out, len) < 0) {
408 error("read from external filter %s failed", cmd);
411 if (close(async.out)) {
412 error("read from external filter %s failed", cmd);
415 if (finish_async(&async)) {
416 error("external filter %s failed", cmd);
421 strbuf_swap(dst, &nbuf);
423 strbuf_release(&nbuf);
427 static struct convert_driver {
429 struct convert_driver *next;
432 } *user_convert, **user_convert_tail;
434 static int read_convert_config(const char *var, const char *value, void *cb)
436 const char *ep, *name;
438 struct convert_driver *drv;
441 * External conversion drivers are configured using
442 * "filter.<name>.variable".
444 if (prefixcmp(var, "filter.") || (ep = strrchr(var, '.')) == var + 6)
448 for (drv = user_convert; drv; drv = drv->next)
449 if (!strncmp(drv->name, name, namelen) && !drv->name[namelen])
452 drv = xcalloc(1, sizeof(struct convert_driver));
453 drv->name = xmemdupz(name, namelen);
454 *user_convert_tail = drv;
455 user_convert_tail = &(drv->next);
461 * filter.<name>.smudge and filter.<name>.clean specifies
466 * The command-line will not be interpolated in any way.
469 if (!strcmp("smudge", ep))
470 return git_config_string(&drv->smudge, var, value);
472 if (!strcmp("clean", ep))
473 return git_config_string(&drv->clean, var, value);
478 static void setup_convert_check(struct git_attr_check *check)
480 static struct git_attr *attr_text;
481 static struct git_attr *attr_crlf;
482 static struct git_attr *attr_eol;
483 static struct git_attr *attr_ident;
484 static struct git_attr *attr_filter;
487 attr_text = git_attr("text");
488 attr_crlf = git_attr("crlf");
489 attr_eol = git_attr("eol");
490 attr_ident = git_attr("ident");
491 attr_filter = git_attr("filter");
492 user_convert_tail = &user_convert;
493 git_config(read_convert_config, NULL);
495 check[0].attr = attr_crlf;
496 check[1].attr = attr_ident;
497 check[2].attr = attr_filter;
498 check[3].attr = attr_eol;
499 check[4].attr = attr_text;
502 static int count_ident(const char *cp, unsigned long size)
505 * "$Id: 0000000000000000000000000000000000000000 $" <=> "$Id$"
517 if (memcmp("Id", cp, 2))
528 * "$Id: ... "; scan up to the closing dollar sign and discard.
544 static int ident_to_git(const char *path, const char *src, size_t len,
545 struct strbuf *buf, int ident)
549 if (!ident || !count_ident(src, len))
552 /* only grow if not in place */
553 if (strbuf_avail(buf) + buf->len < len)
554 strbuf_grow(buf, len - buf->len);
557 dollar = memchr(src, '$', len);
560 memcpy(dst, src, dollar + 1 - src);
561 dst += dollar + 1 - src;
562 len -= dollar + 1 - src;
565 if (len > 3 && !memcmp(src, "Id:", 3)) {
566 dollar = memchr(src + 3, '$', len - 3);
569 if (memchr(src + 3, '\n', dollar - src - 3)) {
570 /* Line break before the next dollar. */
574 memcpy(dst, "Id$", 3);
576 len -= dollar + 1 - src;
580 memcpy(dst, src, len);
581 strbuf_setlen(buf, dst + len - buf->buf);
585 static int ident_to_worktree(const char *path, const char *src, size_t len,
586 struct strbuf *buf, int ident)
588 unsigned char sha1[20];
589 char *to_free = NULL, *dollar, *spc;
595 cnt = count_ident(src, len);
599 /* are we "faking" in place editing ? */
601 to_free = strbuf_detach(buf, NULL);
602 hash_sha1_file(src, len, "blob", sha1);
604 strbuf_grow(buf, len + cnt * 43);
606 /* step 1: run to the next '$' */
607 dollar = memchr(src, '$', len);
610 strbuf_add(buf, src, dollar + 1 - src);
611 len -= dollar + 1 - src;
614 /* step 2: does it looks like a bit like Id:xxx$ or Id$ ? */
615 if (len < 3 || memcmp("Id", src, 2))
618 /* step 3: skip over Id$ or Id:xxxxx$ */
622 } else if (src[2] == ':') {
624 * It's possible that an expanded Id has crept its way into the
625 * repository, we cope with that by stripping the expansion out.
626 * This is probably not a good idea, since it will cause changes
627 * on checkout, which won't go away by stash, but let's keep it
630 dollar = memchr(src + 3, '$', len - 3);
632 /* incomplete keyword, no more '$', so just quit the loop */
636 if (memchr(src + 3, '\n', dollar - src - 3)) {
637 /* Line break before the next dollar. */
641 spc = memchr(src + 4, ' ', dollar - src - 4);
642 if (spc && spc < dollar-1) {
643 /* There are spaces in unexpected places.
644 * This is probably an id from some other
645 * versioning system. Keep it for now.
650 len -= dollar + 1 - src;
653 /* it wasn't a "Id$" or "Id:xxxx$" */
657 /* step 4: substitute */
658 strbuf_addstr(buf, "Id: ");
659 strbuf_add(buf, sha1_to_hex(sha1), 40);
660 strbuf_addstr(buf, " $");
662 strbuf_add(buf, src, len);
668 static int git_path_check_crlf(const char *path, struct git_attr_check *check)
670 const char *value = check->value;
672 if (ATTR_TRUE(value))
674 else if (ATTR_FALSE(value))
676 else if (ATTR_UNSET(value))
678 else if (!strcmp(value, "input"))
680 else if (!strcmp(value, "auto"))
685 static int git_path_check_eol(const char *path, struct git_attr_check *check)
687 const char *value = check->value;
689 if (ATTR_UNSET(value))
691 else if (!strcmp(value, "lf"))
693 else if (!strcmp(value, "crlf"))
698 static struct convert_driver *git_path_check_convert(const char *path,
699 struct git_attr_check *check)
701 const char *value = check->value;
702 struct convert_driver *drv;
704 if (ATTR_TRUE(value) || ATTR_FALSE(value) || ATTR_UNSET(value))
706 for (drv = user_convert; drv; drv = drv->next)
707 if (!strcmp(value, drv->name))
712 static int git_path_check_ident(const char *path, struct git_attr_check *check)
714 const char *value = check->value;
716 return !!ATTR_TRUE(value);
719 static enum crlf_action input_crlf_action(enum crlf_action text_attr, enum eol eol_attr)
721 if (text_attr == CRLF_BINARY)
723 if (eol_attr == EOL_LF)
725 if (eol_attr == EOL_CRLF)
730 int convert_to_git(const char *path, const char *src, size_t len,
731 struct strbuf *dst, enum safe_crlf checksafe)
733 struct git_attr_check check[5];
734 enum crlf_action crlf_action = CRLF_GUESS;
735 enum eol eol_attr = EOL_UNSET;
736 int ident = 0, ret = 0;
737 const char *filter = NULL;
739 setup_convert_check(check);
740 if (!git_checkattr(path, ARRAY_SIZE(check), check)) {
741 struct convert_driver *drv;
742 crlf_action = git_path_check_crlf(path, check + 4);
743 if (crlf_action == CRLF_GUESS)
744 crlf_action = git_path_check_crlf(path, check + 0);
745 ident = git_path_check_ident(path, check + 1);
746 drv = git_path_check_convert(path, check + 2);
747 eol_attr = git_path_check_eol(path, check + 3);
748 if (drv && drv->clean)
752 ret |= apply_filter(path, src, len, dst, filter);
757 crlf_action = input_crlf_action(crlf_action, eol_attr);
758 ret |= crlf_to_git(path, src, len, dst, crlf_action, checksafe);
763 return ret | ident_to_git(path, src, len, dst, ident);
766 static int convert_to_working_tree_internal(const char *path, const char *src,
767 size_t len, struct strbuf *dst,
770 struct git_attr_check check[5];
771 enum crlf_action crlf_action = CRLF_GUESS;
772 enum eol eol_attr = EOL_UNSET;
773 int ident = 0, ret = 0;
774 const char *filter = NULL;
776 setup_convert_check(check);
777 if (!git_checkattr(path, ARRAY_SIZE(check), check)) {
778 struct convert_driver *drv;
779 crlf_action = git_path_check_crlf(path, check + 4);
780 if (crlf_action == CRLF_GUESS)
781 crlf_action = git_path_check_crlf(path, check + 0);
782 ident = git_path_check_ident(path, check + 1);
783 drv = git_path_check_convert(path, check + 2);
784 eol_attr = git_path_check_eol(path, check + 3);
785 if (drv && drv->smudge)
786 filter = drv->smudge;
789 ret |= ident_to_worktree(path, src, len, dst, ident);
795 * CRLF conversion can be skipped if normalizing, unless there
796 * is a smudge filter. The filter might expect CRLFs.
798 if (filter || !normalizing) {
799 crlf_action = input_crlf_action(crlf_action, eol_attr);
800 ret |= crlf_to_worktree(path, src, len, dst, crlf_action);
806 return ret | apply_filter(path, src, len, dst, filter);
809 int convert_to_working_tree(const char *path, const char *src, size_t len, struct strbuf *dst)
811 return convert_to_working_tree_internal(path, src, len, dst, 0);
814 int renormalize_buffer(const char *path, const char *src, size_t len, struct strbuf *dst)
816 int ret = convert_to_working_tree_internal(path, src, len, dst, 1);
821 return ret | convert_to_git(path, src, len, dst, 0);