1 #define NO_THE_INDEX_COMPATIBILITY_MACROS
5 #include "run-command.h"
9 #include "sub-process.h"
12 * convert.c - convert a file when checking it out and checking it in.
14 * This should use the pathname to decide on whether it wants to do some
15 * more interesting conversions (automatic gzip/unzip, general format
16 * conversions etc etc), but by default it just does automatic CRLF<->LF
17 * translation when the "text" attribute or "auto_crlf" option is set.
20 /* Stat bits: When BIN is set, the txt bits are unset */
21 #define CONVERT_STAT_BITS_TXT_LF 0x1
22 #define CONVERT_STAT_BITS_TXT_CRLF 0x2
23 #define CONVERT_STAT_BITS_BIN 0x4
37 /* NUL, CR, LF and CRLF counts */
38 unsigned nul, lonecr, lonelf, crlf;
40 /* These are just approximations! */
41 unsigned printable, nonprintable;
44 static void gather_stats(const char *buf, unsigned long size, struct text_stat *stats)
48 memset(stats, 0, sizeof(*stats));
50 for (i = 0; i < size; i++) {
51 unsigned char c = buf[i];
53 if (i+1 < size && buf[i+1] == '\n') {
66 stats->nonprintable++;
69 /* BS, HT, ESC and FF */
70 case '\b': case '\t': case '\033': case '\014':
77 stats->nonprintable++;
84 /* If file ends with EOF then don't count this EOF as non-printable. */
85 if (size >= 1 && buf[size-1] == '\032')
86 stats->nonprintable--;
90 * The same heuristics as diff.c::mmfile_is_binary()
91 * We treat files with bare CR as binary
93 static int convert_is_binary(unsigned long size, const struct text_stat *stats)
99 if ((stats->printable >> 7) < stats->nonprintable)
104 static unsigned int gather_convert_stats(const char *data, unsigned long size)
106 struct text_stat stats;
110 gather_stats(data, size, &stats);
111 if (convert_is_binary(size, &stats))
112 ret |= CONVERT_STAT_BITS_BIN;
114 ret |= CONVERT_STAT_BITS_TXT_CRLF;
116 ret |= CONVERT_STAT_BITS_TXT_LF;
121 static const char *gather_convert_stats_ascii(const char *data, unsigned long size)
123 unsigned int convert_stats = gather_convert_stats(data, size);
125 if (convert_stats & CONVERT_STAT_BITS_BIN)
127 switch (convert_stats) {
128 case CONVERT_STAT_BITS_TXT_LF:
130 case CONVERT_STAT_BITS_TXT_CRLF:
132 case CONVERT_STAT_BITS_TXT_LF | CONVERT_STAT_BITS_TXT_CRLF:
139 const char *get_cached_convert_stats_ascii(const struct index_state *istate,
144 void *data = read_blob_data_from_index(istate, path, &sz);
145 ret = gather_convert_stats_ascii(data, sz);
150 const char *get_wt_convert_stats_ascii(const char *path)
152 const char *ret = "";
153 struct strbuf sb = STRBUF_INIT;
154 if (strbuf_read_file(&sb, path, 0) >= 0)
155 ret = gather_convert_stats_ascii(sb.buf, sb.len);
160 static int text_eol_is_crlf(void)
162 if (auto_crlf == AUTO_CRLF_TRUE)
164 else if (auto_crlf == AUTO_CRLF_INPUT)
166 if (core_eol == EOL_CRLF)
168 if (core_eol == EOL_UNSET && EOL_NATIVE == EOL_CRLF)
173 static enum eol output_eol(enum crlf_action crlf_action)
175 switch (crlf_action) {
180 case CRLF_TEXT_INPUT:
185 case CRLF_AUTO_INPUT:
190 return text_eol_is_crlf() ? EOL_CRLF : EOL_LF;
192 warning("Illegal crlf_action %d\n", (int)crlf_action);
196 static void check_safe_crlf(const char *path, enum crlf_action crlf_action,
197 struct text_stat *old_stats, struct text_stat *new_stats,
198 enum safe_crlf checksafe)
200 if (old_stats->crlf && !new_stats->crlf ) {
202 * CRLFs would not be restored by checkout
204 if (checksafe == SAFE_CRLF_WARN)
205 warning(_("CRLF will be replaced by LF in %s.\n"
206 "The file will have its original line"
207 " endings in your working directory."), path);
208 else /* i.e. SAFE_CRLF_FAIL */
209 die(_("CRLF would be replaced by LF in %s."), path);
210 } else if (old_stats->lonelf && !new_stats->lonelf ) {
212 * CRLFs would be added by checkout
214 if (checksafe == SAFE_CRLF_WARN)
215 warning(_("LF will be replaced by CRLF in %s.\n"
216 "The file will have its original line"
217 " endings in your working directory."), path);
218 else /* i.e. SAFE_CRLF_FAIL */
219 die(_("LF would be replaced by CRLF in %s"), path);
223 static int has_cr_in_index(const struct index_state *istate, const char *path)
229 data = read_blob_data_from_index(istate, path, &sz);
232 has_cr = memchr(data, '\r', sz) != NULL;
237 static int will_convert_lf_to_crlf(size_t len, struct text_stat *stats,
238 enum crlf_action crlf_action)
240 if (output_eol(crlf_action) != EOL_CRLF)
242 /* No "naked" LF? Nothing to convert, regardless. */
246 if (crlf_action == CRLF_AUTO || crlf_action == CRLF_AUTO_INPUT || crlf_action == CRLF_AUTO_CRLF) {
247 /* If we have any CR or CRLF line endings, we do not touch it */
248 /* This is the new safer autocrlf-handling */
249 if (stats->lonecr || stats->crlf)
252 if (convert_is_binary(len, stats))
259 static int crlf_to_git(const struct index_state *istate,
260 const char *path, const char *src, size_t len,
262 enum crlf_action crlf_action, enum safe_crlf checksafe)
264 struct text_stat stats;
266 int convert_crlf_into_lf;
268 if (crlf_action == CRLF_BINARY ||
273 * If we are doing a dry-run and have no source buffer, there is
274 * nothing to analyze; we must assume we would convert.
279 gather_stats(src, len, &stats);
280 /* Optimization: No CRLF? Nothing to convert, regardless. */
281 convert_crlf_into_lf = !!stats.crlf;
283 if (crlf_action == CRLF_AUTO || crlf_action == CRLF_AUTO_INPUT || crlf_action == CRLF_AUTO_CRLF) {
284 if (convert_is_binary(len, &stats))
287 * If the file in the index has any CR in it, do not
288 * convert. This is the new safer autocrlf handling,
289 * unless we want to renormalize in a merge or
292 if ((checksafe != SAFE_CRLF_RENORMALIZE) &&
293 has_cr_in_index(istate, path))
294 convert_crlf_into_lf = 0;
296 if ((checksafe == SAFE_CRLF_WARN ||
297 (checksafe == SAFE_CRLF_FAIL)) && len) {
298 struct text_stat new_stats;
299 memcpy(&new_stats, &stats, sizeof(new_stats));
300 /* simulate "git add" */
301 if (convert_crlf_into_lf) {
302 new_stats.lonelf += new_stats.crlf;
305 /* simulate "git checkout" */
306 if (will_convert_lf_to_crlf(len, &new_stats, crlf_action)) {
307 new_stats.crlf += new_stats.lonelf;
308 new_stats.lonelf = 0;
310 check_safe_crlf(path, crlf_action, &stats, &new_stats, checksafe);
312 if (!convert_crlf_into_lf)
316 * At this point all of our source analysis is done, and we are sure we
317 * would convert. If we are in dry-run mode, we can give an answer.
322 /* only grow if not in place */
323 if (strbuf_avail(buf) + buf->len < len)
324 strbuf_grow(buf, len - buf->len);
326 if (crlf_action == CRLF_AUTO || crlf_action == CRLF_AUTO_INPUT || crlf_action == CRLF_AUTO_CRLF) {
328 * If we guessed, we already know we rejected a file with
329 * lone CR, and we can strip a CR without looking at what
333 unsigned char c = *src++;
339 unsigned char c = *src++;
340 if (! (c == '\r' && (1 < len && *src == '\n')))
344 strbuf_setlen(buf, dst - buf->buf);
348 static int crlf_to_worktree(const char *path, const char *src, size_t len,
349 struct strbuf *buf, enum crlf_action crlf_action)
351 char *to_free = NULL;
352 struct text_stat stats;
354 if (!len || output_eol(crlf_action) != EOL_CRLF)
357 gather_stats(src, len, &stats);
358 if (!will_convert_lf_to_crlf(len, &stats, crlf_action))
361 /* are we "faking" in place editing ? */
363 to_free = strbuf_detach(buf, NULL);
365 strbuf_grow(buf, len + stats.lonelf);
367 const char *nl = memchr(src, '\n', len);
370 if (nl > src && nl[-1] == '\r') {
371 strbuf_add(buf, src, nl + 1 - src);
373 strbuf_add(buf, src, nl - src);
374 strbuf_addstr(buf, "\r\n");
379 strbuf_add(buf, src, len);
385 struct filter_params {
393 static int filter_buffer_or_fd(int in, int out, void *data)
396 * Spawn cmd and feed the buffer contents through its stdin.
398 struct child_process child_process = CHILD_PROCESS_INIT;
399 struct filter_params *params = (struct filter_params *)data;
400 int write_err, status;
401 const char *argv[] = { NULL, NULL };
403 /* apply % substitution to cmd */
404 struct strbuf cmd = STRBUF_INIT;
405 struct strbuf path = STRBUF_INIT;
406 struct strbuf_expand_dict_entry dict[] = {
411 /* quote the path to preserve spaces, etc. */
412 sq_quote_buf(&path, params->path);
413 dict[0].value = path.buf;
415 /* expand all %f with the quoted path */
416 strbuf_expand(&cmd, params->cmd, strbuf_expand_dict_cb, &dict);
417 strbuf_release(&path);
421 child_process.argv = argv;
422 child_process.use_shell = 1;
423 child_process.in = -1;
424 child_process.out = out;
426 if (start_command(&child_process))
427 return error("cannot fork to run external filter '%s'", params->cmd);
429 sigchain_push(SIGPIPE, SIG_IGN);
432 write_err = (write_in_full(child_process.in,
433 params->src, params->size) < 0);
437 write_err = copy_fd(params->fd, child_process.in);
438 if (write_err == COPY_WRITE_ERROR && errno == EPIPE)
442 if (close(child_process.in))
445 error("cannot feed the input to external filter '%s'", params->cmd);
447 sigchain_pop(SIGPIPE);
449 status = finish_command(&child_process);
451 error("external filter '%s' failed %d", params->cmd, status);
453 strbuf_release(&cmd);
454 return (write_err || status);
457 static int apply_single_file_filter(const char *path, const char *src, size_t len, int fd,
458 struct strbuf *dst, const char *cmd)
461 * Create a pipeline to have the command filter the buffer's
464 * (child --> cmd) --> us
467 struct strbuf nbuf = STRBUF_INIT;
469 struct filter_params params;
471 memset(&async, 0, sizeof(async));
472 async.proc = filter_buffer_or_fd;
473 async.data = ¶ms;
482 if (start_async(&async))
483 return 0; /* error was already reported */
485 if (strbuf_read(&nbuf, async.out, len) < 0) {
486 err = error("read from external filter '%s' failed", cmd);
488 if (close(async.out)) {
489 err = error("read from external filter '%s' failed", cmd);
491 if (finish_async(&async)) {
492 err = error("external filter '%s' failed", cmd);
496 strbuf_swap(dst, &nbuf);
498 strbuf_release(&nbuf);
502 #define CAP_CLEAN (1u<<0)
503 #define CAP_SMUDGE (1u<<1)
504 #define CAP_DELAY (1u<<2)
507 struct subprocess_entry subprocess; /* must be the first member! */
508 unsigned int supported_capabilities;
511 static int subprocess_map_initialized;
512 static struct hashmap subprocess_map;
514 static int start_multi_file_filter_fn(struct subprocess_entry *subprocess)
516 static int versions[] = {2, 0};
517 static struct subprocess_capability capabilities[] = {
518 { "clean", CAP_CLEAN },
519 { "smudge", CAP_SMUDGE },
520 { "delay", CAP_DELAY },
523 struct cmd2process *entry = (struct cmd2process *)subprocess;
524 return subprocess_handshake(subprocess, "git-filter", versions, NULL,
526 &entry->supported_capabilities);
529 static void handle_filter_error(const struct strbuf *filter_status,
530 struct cmd2process *entry,
531 const unsigned int wanted_capability) {
532 if (!strcmp(filter_status->buf, "error"))
533 ; /* The filter signaled a problem with the file. */
534 else if (!strcmp(filter_status->buf, "abort") && wanted_capability) {
536 * The filter signaled a permanent problem. Don't try to filter
537 * files with the same command for the lifetime of the current
540 entry->supported_capabilities &= ~wanted_capability;
543 * Something went wrong with the protocol filter.
544 * Force shutdown and restart if another blob requires filtering.
546 error("external filter '%s' failed", entry->subprocess.cmd);
547 subprocess_stop(&subprocess_map, &entry->subprocess);
552 static int apply_multi_file_filter(const char *path, const char *src, size_t len,
553 int fd, struct strbuf *dst, const char *cmd,
554 const unsigned int wanted_capability,
555 struct delayed_checkout *dco)
559 struct cmd2process *entry;
560 struct child_process *process;
561 struct strbuf nbuf = STRBUF_INIT;
562 struct strbuf filter_status = STRBUF_INIT;
563 const char *filter_type;
565 if (!subprocess_map_initialized) {
566 subprocess_map_initialized = 1;
567 hashmap_init(&subprocess_map, cmd2process_cmp, NULL, 0);
570 entry = (struct cmd2process *)subprocess_find_entry(&subprocess_map, cmd);
576 entry = xmalloc(sizeof(*entry));
577 entry->supported_capabilities = 0;
579 if (subprocess_start(&subprocess_map, &entry->subprocess, cmd, start_multi_file_filter_fn)) {
584 process = &entry->subprocess.process;
586 if (!(entry->supported_capabilities & wanted_capability))
589 if (wanted_capability & CAP_CLEAN)
590 filter_type = "clean";
591 else if (wanted_capability & CAP_SMUDGE)
592 filter_type = "smudge";
594 die("unexpected filter type");
596 sigchain_push(SIGPIPE, SIG_IGN);
598 assert(strlen(filter_type) < LARGE_PACKET_DATA_MAX - strlen("command=\n"));
599 err = packet_write_fmt_gently(process->in, "command=%s\n", filter_type);
603 err = strlen(path) > LARGE_PACKET_DATA_MAX - strlen("pathname=\n");
605 error("path name too long for external filter");
609 err = packet_write_fmt_gently(process->in, "pathname=%s\n", path);
613 if ((entry->supported_capabilities & CAP_DELAY) &&
614 dco && dco->state == CE_CAN_DELAY) {
616 err = packet_write_fmt_gently(process->in, "can-delay=1\n");
621 err = packet_flush_gently(process->in);
626 err = write_packetized_from_fd(fd, process->in);
628 err = write_packetized_from_buf(src, len, process->in);
632 err = subprocess_read_status(process->out, &filter_status);
636 if (can_delay && !strcmp(filter_status.buf, "delayed")) {
637 string_list_insert(&dco->filters, cmd);
638 string_list_insert(&dco->paths, path);
640 /* The filter got the blob and wants to send us a response. */
641 err = strcmp(filter_status.buf, "success");
645 err = read_packetized_to_strbuf(process->out, &nbuf) < 0;
649 err = subprocess_read_status(process->out, &filter_status);
653 err = strcmp(filter_status.buf, "success");
657 sigchain_pop(SIGPIPE);
660 handle_filter_error(&filter_status, entry, wanted_capability);
662 strbuf_swap(dst, &nbuf);
663 strbuf_release(&nbuf);
668 int async_query_available_blobs(const char *cmd, struct string_list *available_paths)
672 struct cmd2process *entry;
673 struct child_process *process;
674 struct strbuf filter_status = STRBUF_INIT;
676 assert(subprocess_map_initialized);
677 entry = (struct cmd2process *)subprocess_find_entry(&subprocess_map, cmd);
679 error("external filter '%s' is not available anymore although "
680 "not all paths have been filtered", cmd);
683 process = &entry->subprocess.process;
684 sigchain_push(SIGPIPE, SIG_IGN);
686 err = packet_write_fmt_gently(
687 process->in, "command=list_available_blobs\n");
691 err = packet_flush_gently(process->in);
695 while ((line = packet_read_line(process->out, NULL))) {
697 if (skip_prefix(line, "pathname=", &path))
698 string_list_insert(available_paths, xstrdup(path));
700 ; /* ignore unknown keys */
703 err = subprocess_read_status(process->out, &filter_status);
707 err = strcmp(filter_status.buf, "success");
710 sigchain_pop(SIGPIPE);
713 handle_filter_error(&filter_status, entry, 0);
717 static struct convert_driver {
719 struct convert_driver *next;
724 } *user_convert, **user_convert_tail;
726 static int apply_filter(const char *path, const char *src, size_t len,
727 int fd, struct strbuf *dst, struct convert_driver *drv,
728 const unsigned int wanted_capability,
729 struct delayed_checkout *dco)
731 const char *cmd = NULL;
739 if ((wanted_capability & CAP_CLEAN) && !drv->process && drv->clean)
741 else if ((wanted_capability & CAP_SMUDGE) && !drv->process && drv->smudge)
745 return apply_single_file_filter(path, src, len, fd, dst, cmd);
746 else if (drv->process && *drv->process)
747 return apply_multi_file_filter(path, src, len, fd, dst,
748 drv->process, wanted_capability, dco);
753 static int read_convert_config(const char *var, const char *value, void *cb)
755 const char *key, *name;
757 struct convert_driver *drv;
760 * External conversion drivers are configured using
761 * "filter.<name>.variable".
763 if (parse_config_key(var, "filter", &name, &namelen, &key) < 0 || !name)
765 for (drv = user_convert; drv; drv = drv->next)
766 if (!strncmp(drv->name, name, namelen) && !drv->name[namelen])
769 drv = xcalloc(1, sizeof(struct convert_driver));
770 drv->name = xmemdupz(name, namelen);
771 *user_convert_tail = drv;
772 user_convert_tail = &(drv->next);
776 * filter.<name>.smudge and filter.<name>.clean specifies
781 * The command-line will not be interpolated in any way.
784 if (!strcmp("smudge", key))
785 return git_config_string(&drv->smudge, var, value);
787 if (!strcmp("clean", key))
788 return git_config_string(&drv->clean, var, value);
790 if (!strcmp("process", key))
791 return git_config_string(&drv->process, var, value);
793 if (!strcmp("required", key)) {
794 drv->required = git_config_bool(var, value);
801 static int count_ident(const char *cp, unsigned long size)
804 * "$Id: 0000000000000000000000000000000000000000 $" <=> "$Id$"
816 if (memcmp("Id", cp, 2))
827 * "$Id: ... "; scan up to the closing dollar sign and discard.
843 static int ident_to_git(const char *path, const char *src, size_t len,
844 struct strbuf *buf, int ident)
848 if (!ident || (src && !count_ident(src, len)))
854 /* only grow if not in place */
855 if (strbuf_avail(buf) + buf->len < len)
856 strbuf_grow(buf, len - buf->len);
859 dollar = memchr(src, '$', len);
862 memmove(dst, src, dollar + 1 - src);
863 dst += dollar + 1 - src;
864 len -= dollar + 1 - src;
867 if (len > 3 && !memcmp(src, "Id:", 3)) {
868 dollar = memchr(src + 3, '$', len - 3);
871 if (memchr(src + 3, '\n', dollar - src - 3)) {
872 /* Line break before the next dollar. */
876 memcpy(dst, "Id$", 3);
878 len -= dollar + 1 - src;
882 memmove(dst, src, len);
883 strbuf_setlen(buf, dst + len - buf->buf);
887 static int ident_to_worktree(const char *path, const char *src, size_t len,
888 struct strbuf *buf, int ident)
890 unsigned char sha1[20];
891 char *to_free = NULL, *dollar, *spc;
897 cnt = count_ident(src, len);
901 /* are we "faking" in place editing ? */
903 to_free = strbuf_detach(buf, NULL);
904 hash_sha1_file(src, len, "blob", sha1);
906 strbuf_grow(buf, len + cnt * 43);
908 /* step 1: run to the next '$' */
909 dollar = memchr(src, '$', len);
912 strbuf_add(buf, src, dollar + 1 - src);
913 len -= dollar + 1 - src;
916 /* step 2: does it looks like a bit like Id:xxx$ or Id$ ? */
917 if (len < 3 || memcmp("Id", src, 2))
920 /* step 3: skip over Id$ or Id:xxxxx$ */
924 } else if (src[2] == ':') {
926 * It's possible that an expanded Id has crept its way into the
927 * repository, we cope with that by stripping the expansion out.
928 * This is probably not a good idea, since it will cause changes
929 * on checkout, which won't go away by stash, but let's keep it
932 dollar = memchr(src + 3, '$', len - 3);
934 /* incomplete keyword, no more '$', so just quit the loop */
938 if (memchr(src + 3, '\n', dollar - src - 3)) {
939 /* Line break before the next dollar. */
943 spc = memchr(src + 4, ' ', dollar - src - 4);
944 if (spc && spc < dollar-1) {
945 /* There are spaces in unexpected places.
946 * This is probably an id from some other
947 * versioning system. Keep it for now.
952 len -= dollar + 1 - src;
955 /* it wasn't a "Id$" or "Id:xxxx$" */
959 /* step 4: substitute */
960 strbuf_addstr(buf, "Id: ");
961 strbuf_add(buf, sha1_to_hex(sha1), 40);
962 strbuf_addstr(buf, " $");
964 strbuf_add(buf, src, len);
970 static enum crlf_action git_path_check_crlf(struct attr_check_item *check)
972 const char *value = check->value;
974 if (ATTR_TRUE(value))
976 else if (ATTR_FALSE(value))
978 else if (ATTR_UNSET(value))
980 else if (!strcmp(value, "input"))
981 return CRLF_TEXT_INPUT;
982 else if (!strcmp(value, "auto"))
984 return CRLF_UNDEFINED;
987 static enum eol git_path_check_eol(struct attr_check_item *check)
989 const char *value = check->value;
991 if (ATTR_UNSET(value))
993 else if (!strcmp(value, "lf"))
995 else if (!strcmp(value, "crlf"))
1000 static struct convert_driver *git_path_check_convert(struct attr_check_item *check)
1002 const char *value = check->value;
1003 struct convert_driver *drv;
1005 if (ATTR_TRUE(value) || ATTR_FALSE(value) || ATTR_UNSET(value))
1007 for (drv = user_convert; drv; drv = drv->next)
1008 if (!strcmp(value, drv->name))
1013 static int git_path_check_ident(struct attr_check_item *check)
1015 const char *value = check->value;
1017 return !!ATTR_TRUE(value);
1021 struct convert_driver *drv;
1022 enum crlf_action attr_action; /* What attr says */
1023 enum crlf_action crlf_action; /* When no attr is set, use core.autocrlf */
1027 static void convert_attrs(struct conv_attrs *ca, const char *path)
1029 static struct attr_check *check;
1032 check = attr_check_initl("crlf", "ident", "filter",
1033 "eol", "text", NULL);
1034 user_convert_tail = &user_convert;
1035 git_config(read_convert_config, NULL);
1038 if (!git_check_attr(path, check)) {
1039 struct attr_check_item *ccheck = check->items;
1040 ca->crlf_action = git_path_check_crlf(ccheck + 4);
1041 if (ca->crlf_action == CRLF_UNDEFINED)
1042 ca->crlf_action = git_path_check_crlf(ccheck + 0);
1043 ca->ident = git_path_check_ident(ccheck + 1);
1044 ca->drv = git_path_check_convert(ccheck + 2);
1045 if (ca->crlf_action != CRLF_BINARY) {
1046 enum eol eol_attr = git_path_check_eol(ccheck + 3);
1047 if (ca->crlf_action == CRLF_AUTO && eol_attr == EOL_LF)
1048 ca->crlf_action = CRLF_AUTO_INPUT;
1049 else if (ca->crlf_action == CRLF_AUTO && eol_attr == EOL_CRLF)
1050 ca->crlf_action = CRLF_AUTO_CRLF;
1051 else if (eol_attr == EOL_LF)
1052 ca->crlf_action = CRLF_TEXT_INPUT;
1053 else if (eol_attr == EOL_CRLF)
1054 ca->crlf_action = CRLF_TEXT_CRLF;
1058 ca->crlf_action = CRLF_UNDEFINED;
1062 /* Save attr and make a decision for action */
1063 ca->attr_action = ca->crlf_action;
1064 if (ca->crlf_action == CRLF_TEXT)
1065 ca->crlf_action = text_eol_is_crlf() ? CRLF_TEXT_CRLF : CRLF_TEXT_INPUT;
1066 if (ca->crlf_action == CRLF_UNDEFINED && auto_crlf == AUTO_CRLF_FALSE)
1067 ca->crlf_action = CRLF_BINARY;
1068 if (ca->crlf_action == CRLF_UNDEFINED && auto_crlf == AUTO_CRLF_TRUE)
1069 ca->crlf_action = CRLF_AUTO_CRLF;
1070 if (ca->crlf_action == CRLF_UNDEFINED && auto_crlf == AUTO_CRLF_INPUT)
1071 ca->crlf_action = CRLF_AUTO_INPUT;
1074 int would_convert_to_git_filter_fd(const char *path)
1076 struct conv_attrs ca;
1078 convert_attrs(&ca, path);
1083 * Apply a filter to an fd only if the filter is required to succeed.
1084 * We must die if the filter fails, because the original data before
1085 * filtering is not available.
1087 if (!ca.drv->required)
1090 return apply_filter(path, NULL, 0, -1, NULL, ca.drv, CAP_CLEAN, NULL);
1093 const char *get_convert_attr_ascii(const char *path)
1095 struct conv_attrs ca;
1097 convert_attrs(&ca, path);
1098 switch (ca.attr_action) {
1099 case CRLF_UNDEFINED:
1105 case CRLF_TEXT_INPUT:
1106 return "text eol=lf";
1107 case CRLF_TEXT_CRLF:
1108 return "text eol=crlf";
1111 case CRLF_AUTO_CRLF:
1112 return "text=auto eol=crlf";
1113 case CRLF_AUTO_INPUT:
1114 return "text=auto eol=lf";
1119 int convert_to_git(const struct index_state *istate,
1120 const char *path, const char *src, size_t len,
1121 struct strbuf *dst, enum safe_crlf checksafe)
1124 struct conv_attrs ca;
1126 convert_attrs(&ca, path);
1128 ret |= apply_filter(path, src, len, -1, dst, ca.drv, CAP_CLEAN, NULL);
1129 if (!ret && ca.drv && ca.drv->required)
1130 die("%s: clean filter '%s' failed", path, ca.drv->name);
1136 if (checksafe != SAFE_CRLF_KEEP_CRLF) {
1137 ret |= crlf_to_git(istate, path, src, len, dst, ca.crlf_action, checksafe);
1143 return ret | ident_to_git(path, src, len, dst, ca.ident);
1146 void convert_to_git_filter_fd(const struct index_state *istate,
1147 const char *path, int fd, struct strbuf *dst,
1148 enum safe_crlf checksafe)
1150 struct conv_attrs ca;
1151 convert_attrs(&ca, path);
1154 assert(ca.drv->clean || ca.drv->process);
1156 if (!apply_filter(path, NULL, 0, fd, dst, ca.drv, CAP_CLEAN, NULL))
1157 die("%s: clean filter '%s' failed", path, ca.drv->name);
1159 crlf_to_git(istate, path, dst->buf, dst->len, dst, ca.crlf_action, checksafe);
1160 ident_to_git(path, dst->buf, dst->len, dst, ca.ident);
1163 static int convert_to_working_tree_internal(const char *path, const char *src,
1164 size_t len, struct strbuf *dst,
1165 int normalizing, struct delayed_checkout *dco)
1167 int ret = 0, ret_filter = 0;
1168 struct conv_attrs ca;
1170 convert_attrs(&ca, path);
1172 ret |= ident_to_worktree(path, src, len, dst, ca.ident);
1178 * CRLF conversion can be skipped if normalizing, unless there
1179 * is a smudge or process filter (even if the process filter doesn't
1180 * support smudge). The filters might expect CRLFs.
1182 if ((ca.drv && (ca.drv->smudge || ca.drv->process)) || !normalizing) {
1183 ret |= crlf_to_worktree(path, src, len, dst, ca.crlf_action);
1190 ret_filter = apply_filter(
1191 path, src, len, -1, dst, ca.drv, CAP_SMUDGE, dco);
1192 if (!ret_filter && ca.drv && ca.drv->required)
1193 die("%s: smudge filter %s failed", path, ca.drv->name);
1195 return ret | ret_filter;
1198 int async_convert_to_working_tree(const char *path, const char *src,
1199 size_t len, struct strbuf *dst,
1202 return convert_to_working_tree_internal(path, src, len, dst, 0, dco);
1205 int convert_to_working_tree(const char *path, const char *src, size_t len, struct strbuf *dst)
1207 return convert_to_working_tree_internal(path, src, len, dst, 0, NULL);
1210 int renormalize_buffer(const struct index_state *istate, const char *path,
1211 const char *src, size_t len, struct strbuf *dst)
1213 int ret = convert_to_working_tree_internal(path, src, len, dst, 1, NULL);
1218 return ret | convert_to_git(istate, path, src, len, dst, SAFE_CRLF_RENORMALIZE);
1221 /*****************************************************************
1223 * Streaming conversion support
1225 *****************************************************************/
1227 typedef int (*filter_fn)(struct stream_filter *,
1228 const char *input, size_t *isize_p,
1229 char *output, size_t *osize_p);
1230 typedef void (*free_fn)(struct stream_filter *);
1232 struct stream_filter_vtbl {
1237 struct stream_filter {
1238 struct stream_filter_vtbl *vtbl;
1241 static int null_filter_fn(struct stream_filter *filter,
1242 const char *input, size_t *isize_p,
1243 char *output, size_t *osize_p)
1248 return 0; /* we do not keep any states */
1250 if (*osize_p < count)
1253 memmove(output, input, count);
1260 static void null_free_fn(struct stream_filter *filter)
1262 ; /* nothing -- null instances are shared */
1265 static struct stream_filter_vtbl null_vtbl = {
1270 static struct stream_filter null_filter_singleton = {
1274 int is_null_stream_filter(struct stream_filter *filter)
1276 return filter == &null_filter_singleton;
1284 struct lf_to_crlf_filter {
1285 struct stream_filter filter;
1286 unsigned has_held:1;
1290 static int lf_to_crlf_filter_fn(struct stream_filter *filter,
1291 const char *input, size_t *isize_p,
1292 char *output, size_t *osize_p)
1294 size_t count, o = 0;
1295 struct lf_to_crlf_filter *lf_to_crlf = (struct lf_to_crlf_filter *)filter;
1298 * We may be holding onto the CR to see if it is followed by a
1299 * LF, in which case we would need to go to the main loop.
1300 * Otherwise, just emit it to the output stream.
1302 if (lf_to_crlf->has_held && (lf_to_crlf->held != '\r' || !input)) {
1303 output[o++] = lf_to_crlf->held;
1304 lf_to_crlf->has_held = 0;
1307 /* We are told to drain */
1314 if (count || lf_to_crlf->has_held) {
1318 if (lf_to_crlf->has_held) {
1320 lf_to_crlf->has_held = 0;
1323 for (i = 0; o < *osize_p && i < count; i++) {
1328 } else if (was_cr) {
1330 * Previous round saw CR and it is not followed
1331 * by a LF; emit the CR before processing the
1332 * current character.
1338 * We may have consumed the last output slot,
1339 * in which case we need to break out of this
1340 * loop; hold the current character before
1343 if (*osize_p <= o) {
1344 lf_to_crlf->has_held = 1;
1345 lf_to_crlf->held = ch;
1346 continue; /* break but increment i */
1361 if (!lf_to_crlf->has_held && was_cr) {
1362 lf_to_crlf->has_held = 1;
1363 lf_to_crlf->held = '\r';
1369 static void lf_to_crlf_free_fn(struct stream_filter *filter)
1374 static struct stream_filter_vtbl lf_to_crlf_vtbl = {
1375 lf_to_crlf_filter_fn,
1379 static struct stream_filter *lf_to_crlf_filter(void)
1381 struct lf_to_crlf_filter *lf_to_crlf = xcalloc(1, sizeof(*lf_to_crlf));
1383 lf_to_crlf->filter.vtbl = &lf_to_crlf_vtbl;
1384 return (struct stream_filter *)lf_to_crlf;
1390 #define FILTER_BUFFER 1024
1391 struct cascade_filter {
1392 struct stream_filter filter;
1393 struct stream_filter *one;
1394 struct stream_filter *two;
1395 char buf[FILTER_BUFFER];
1399 static int cascade_filter_fn(struct stream_filter *filter,
1400 const char *input, size_t *isize_p,
1401 char *output, size_t *osize_p)
1403 struct cascade_filter *cas = (struct cascade_filter *) filter;
1405 size_t sz = *osize_p;
1406 size_t to_feed, remaining;
1409 * input -- (one) --> buf -- (two) --> output
1411 while (filled < sz) {
1412 remaining = sz - filled;
1414 /* do we already have something to feed two with? */
1415 if (cas->ptr < cas->end) {
1416 to_feed = cas->end - cas->ptr;
1417 if (stream_filter(cas->two,
1418 cas->buf + cas->ptr, &to_feed,
1419 output + filled, &remaining))
1421 cas->ptr += (cas->end - cas->ptr) - to_feed;
1422 filled = sz - remaining;
1426 /* feed one from upstream and have it emit into our buffer */
1427 to_feed = input ? *isize_p : 0;
1428 if (input && !to_feed)
1430 remaining = sizeof(cas->buf);
1431 if (stream_filter(cas->one,
1433 cas->buf, &remaining))
1435 cas->end = sizeof(cas->buf) - remaining;
1438 size_t fed = *isize_p - to_feed;
1443 /* do we know that we drained one completely? */
1444 if (input || cas->end)
1447 /* tell two to drain; we have nothing more to give it */
1449 remaining = sz - filled;
1450 if (stream_filter(cas->two,
1452 output + filled, &remaining))
1454 if (remaining == (sz - filled))
1455 break; /* completely drained two */
1456 filled = sz - remaining;
1462 static void cascade_free_fn(struct stream_filter *filter)
1464 struct cascade_filter *cas = (struct cascade_filter *)filter;
1465 free_stream_filter(cas->one);
1466 free_stream_filter(cas->two);
1470 static struct stream_filter_vtbl cascade_vtbl = {
1475 static struct stream_filter *cascade_filter(struct stream_filter *one,
1476 struct stream_filter *two)
1478 struct cascade_filter *cascade;
1480 if (!one || is_null_stream_filter(one))
1482 if (!two || is_null_stream_filter(two))
1485 cascade = xmalloc(sizeof(*cascade));
1488 cascade->end = cascade->ptr = 0;
1489 cascade->filter.vtbl = &cascade_vtbl;
1490 return (struct stream_filter *)cascade;
1496 #define IDENT_DRAINING (-1)
1497 #define IDENT_SKIPPING (-2)
1498 struct ident_filter {
1499 struct stream_filter filter;
1502 char ident[45]; /* ": x40 $" */
1505 static int is_foreign_ident(const char *str)
1509 if (!skip_prefix(str, "$Id: ", &str))
1511 for (i = 0; str[i]; i++) {
1512 if (isspace(str[i]) && str[i+1] != '$')
1518 static void ident_drain(struct ident_filter *ident, char **output_p, size_t *osize_p)
1520 size_t to_drain = ident->left.len;
1522 if (*osize_p < to_drain)
1523 to_drain = *osize_p;
1525 memcpy(*output_p, ident->left.buf, to_drain);
1526 strbuf_remove(&ident->left, 0, to_drain);
1527 *output_p += to_drain;
1528 *osize_p -= to_drain;
1530 if (!ident->left.len)
1534 static int ident_filter_fn(struct stream_filter *filter,
1535 const char *input, size_t *isize_p,
1536 char *output, size_t *osize_p)
1538 struct ident_filter *ident = (struct ident_filter *)filter;
1539 static const char head[] = "$Id";
1542 /* drain upon eof */
1543 switch (ident->state) {
1545 strbuf_add(&ident->left, head, ident->state);
1546 case IDENT_SKIPPING:
1548 case IDENT_DRAINING:
1549 ident_drain(ident, &output, osize_p);
1554 while (*isize_p || (ident->state == IDENT_DRAINING)) {
1557 if (ident->state == IDENT_DRAINING) {
1558 ident_drain(ident, &output, osize_p);
1567 if (ident->state == IDENT_SKIPPING) {
1569 * Skipping until '$' or LF, but keeping them
1570 * in case it is a foreign ident.
1572 strbuf_addch(&ident->left, ch);
1573 if (ch != '\n' && ch != '$')
1575 if (ch == '$' && !is_foreign_ident(ident->left.buf)) {
1576 strbuf_setlen(&ident->left, sizeof(head) - 1);
1577 strbuf_addstr(&ident->left, ident->ident);
1579 ident->state = IDENT_DRAINING;
1583 if (ident->state < sizeof(head) &&
1584 head[ident->state] == ch) {
1590 strbuf_add(&ident->left, head, ident->state);
1591 if (ident->state == sizeof(head) - 1) {
1592 if (ch != ':' && ch != '$') {
1593 strbuf_addch(&ident->left, ch);
1599 strbuf_addch(&ident->left, ch);
1600 ident->state = IDENT_SKIPPING;
1602 strbuf_addstr(&ident->left, ident->ident);
1603 ident->state = IDENT_DRAINING;
1608 strbuf_addch(&ident->left, ch);
1609 ident->state = IDENT_DRAINING;
1614 static void ident_free_fn(struct stream_filter *filter)
1616 struct ident_filter *ident = (struct ident_filter *)filter;
1617 strbuf_release(&ident->left);
1621 static struct stream_filter_vtbl ident_vtbl = {
1626 static struct stream_filter *ident_filter(const unsigned char *sha1)
1628 struct ident_filter *ident = xmalloc(sizeof(*ident));
1630 xsnprintf(ident->ident, sizeof(ident->ident),
1631 ": %s $", sha1_to_hex(sha1));
1632 strbuf_init(&ident->left, 0);
1633 ident->filter.vtbl = &ident_vtbl;
1635 return (struct stream_filter *)ident;
1639 * Return an appropriately constructed filter for the path, or NULL if
1640 * the contents cannot be filtered without reading the whole thing
1643 * Note that you would be crazy to set CRLF, smuge/clean or ident to a
1644 * large binary blob you would want us not to slurp into the memory!
1646 struct stream_filter *get_stream_filter(const char *path, const unsigned char *sha1)
1648 struct conv_attrs ca;
1649 struct stream_filter *filter = NULL;
1651 convert_attrs(&ca, path);
1652 if (ca.drv && (ca.drv->process || ca.drv->smudge || ca.drv->clean))
1655 if (ca.crlf_action == CRLF_AUTO || ca.crlf_action == CRLF_AUTO_CRLF)
1659 filter = ident_filter(sha1);
1661 if (output_eol(ca.crlf_action) == EOL_CRLF)
1662 filter = cascade_filter(filter, lf_to_crlf_filter());
1664 filter = cascade_filter(filter, &null_filter_singleton);
1669 void free_stream_filter(struct stream_filter *filter)
1671 filter->vtbl->free(filter);
1674 int stream_filter(struct stream_filter *filter,
1675 const char *input, size_t *isize_p,
1676 char *output, size_t *osize_p)
1678 return filter->vtbl->filter(filter, input, isize_p, output, osize_p);