3 #include "run-command.h"
9 * convert.c - convert a file when checking it out and checking it in.
11 * This should use the pathname to decide on whether it wants to do some
12 * more interesting conversions (automatic gzip/unzip, general format
13 * conversions etc etc), but by default it just does automatic CRLF<->LF
14 * translation when the "text" attribute or "auto_crlf" option is set.
17 /* Stat bits: When BIN is set, the txt bits are unset */
18 #define CONVERT_STAT_BITS_TXT_LF 0x1
19 #define CONVERT_STAT_BITS_TXT_CRLF 0x2
20 #define CONVERT_STAT_BITS_BIN 0x4
34 /* NUL, CR, LF and CRLF counts */
35 unsigned nul
, lonecr
, lonelf
, crlf
;
37 /* These are just approximations! */
38 unsigned printable
, nonprintable
;
41 static void gather_stats(const char *buf
, unsigned long size
, struct text_stat
*stats
)
45 memset(stats
, 0, sizeof(*stats
));
47 for (i
= 0; i
< size
; i
++) {
48 unsigned char c
= buf
[i
];
50 if (i
+1 < size
&& buf
[i
+1] == '\n') {
63 stats
->nonprintable
++;
66 /* BS, HT, ESC and FF */
67 case '\b': case '\t': case '\033': case '\014':
74 stats
->nonprintable
++;
81 /* If file ends with EOF then don't count this EOF as non-printable. */
82 if (size
>= 1 && buf
[size
-1] == '\032')
83 stats
->nonprintable
--;
87 * The same heuristics as diff.c::mmfile_is_binary()
88 * We treat files with bare CR as binary
90 static int convert_is_binary(unsigned long size
, const struct text_stat
*stats
)
96 if ((stats
->printable
>> 7) < stats
->nonprintable
)
101 static unsigned int gather_convert_stats(const char *data
, unsigned long size
)
103 struct text_stat stats
;
107 gather_stats(data
, size
, &stats
);
108 if (convert_is_binary(size
, &stats
))
109 ret
|= CONVERT_STAT_BITS_BIN
;
111 ret
|= CONVERT_STAT_BITS_TXT_CRLF
;
113 ret
|= CONVERT_STAT_BITS_TXT_LF
;
118 static const char *gather_convert_stats_ascii(const char *data
, unsigned long size
)
120 unsigned int convert_stats
= gather_convert_stats(data
, size
);
122 if (convert_stats
& CONVERT_STAT_BITS_BIN
)
124 switch (convert_stats
) {
125 case CONVERT_STAT_BITS_TXT_LF
:
127 case CONVERT_STAT_BITS_TXT_CRLF
:
129 case CONVERT_STAT_BITS_TXT_LF
| CONVERT_STAT_BITS_TXT_CRLF
:
136 const char *get_cached_convert_stats_ascii(const char *path
)
140 void *data
= read_blob_data_from_cache(path
, &sz
);
141 ret
= gather_convert_stats_ascii(data
, sz
);
146 const char *get_wt_convert_stats_ascii(const char *path
)
148 const char *ret
= "";
149 struct strbuf sb
= STRBUF_INIT
;
150 if (strbuf_read_file(&sb
, path
, 0) >= 0)
151 ret
= gather_convert_stats_ascii(sb
.buf
, sb
.len
);
156 static int text_eol_is_crlf(void)
158 if (auto_crlf
== AUTO_CRLF_TRUE
)
160 else if (auto_crlf
== AUTO_CRLF_INPUT
)
162 if (core_eol
== EOL_CRLF
)
164 if (core_eol
== EOL_UNSET
&& EOL_NATIVE
== EOL_CRLF
)
169 static enum eol
output_eol(enum crlf_action crlf_action
)
171 switch (crlf_action
) {
176 case CRLF_TEXT_INPUT
:
181 case CRLF_AUTO_INPUT
:
186 return text_eol_is_crlf() ? EOL_CRLF
: EOL_LF
;
188 warning("Illegal crlf_action %d\n", (int)crlf_action
);
192 static void check_safe_crlf(const char *path
, enum crlf_action crlf_action
,
193 struct text_stat
*old_stats
, struct text_stat
*new_stats
,
194 enum safe_crlf checksafe
)
196 if (old_stats
->crlf
&& !new_stats
->crlf
) {
198 * CRLFs would not be restored by checkout
200 if (checksafe
== SAFE_CRLF_WARN
)
201 warning(_("CRLF will be replaced by LF in %s.\n"
202 "The file will have its original line"
203 " endings in your working directory."), path
);
204 else /* i.e. SAFE_CRLF_FAIL */
205 die(_("CRLF would be replaced by LF in %s."), path
);
206 } else if (old_stats
->lonelf
&& !new_stats
->lonelf
) {
208 * CRLFs would be added by checkout
210 if (checksafe
== SAFE_CRLF_WARN
)
211 warning(_("LF will be replaced by CRLF in %s.\n"
212 "The file will have its original line"
213 " endings in your working directory."), path
);
214 else /* i.e. SAFE_CRLF_FAIL */
215 die(_("LF would be replaced by CRLF in %s"), path
);
219 static int has_cr_in_index(const char *path
)
225 data
= read_blob_data_from_cache(path
, &sz
);
228 has_cr
= memchr(data
, '\r', sz
) != NULL
;
233 static int will_convert_lf_to_crlf(size_t len
, struct text_stat
*stats
,
234 enum crlf_action crlf_action
)
236 if (output_eol(crlf_action
) != EOL_CRLF
)
238 /* No "naked" LF? Nothing to convert, regardless. */
242 if (crlf_action
== CRLF_AUTO
|| crlf_action
== CRLF_AUTO_INPUT
|| crlf_action
== CRLF_AUTO_CRLF
) {
243 /* If we have any CR or CRLF line endings, we do not touch it */
244 /* This is the new safer autocrlf-handling */
245 if (stats
->lonecr
|| stats
->crlf
)
248 if (convert_is_binary(len
, stats
))
255 static int crlf_to_git(const char *path
, const char *src
, size_t len
,
257 enum crlf_action crlf_action
, enum safe_crlf checksafe
)
259 struct text_stat stats
;
261 int convert_crlf_into_lf
;
263 if (crlf_action
== CRLF_BINARY
||
268 * If we are doing a dry-run and have no source buffer, there is
269 * nothing to analyze; we must assume we would convert.
274 gather_stats(src
, len
, &stats
);
275 /* Optimization: No CRLF? Nothing to convert, regardless. */
276 convert_crlf_into_lf
= !!stats
.crlf
;
278 if (crlf_action
== CRLF_AUTO
|| crlf_action
== CRLF_AUTO_INPUT
|| crlf_action
== CRLF_AUTO_CRLF
) {
279 if (convert_is_binary(len
, &stats
))
282 * If the file in the index has any CR in it, do not convert.
283 * This is the new safer autocrlf handling.
285 if (checksafe
== SAFE_CRLF_RENORMALIZE
)
286 checksafe
= SAFE_CRLF_FALSE
;
287 else if (has_cr_in_index(path
))
288 convert_crlf_into_lf
= 0;
290 if (checksafe
&& len
) {
291 struct text_stat new_stats
;
292 memcpy(&new_stats
, &stats
, sizeof(new_stats
));
293 /* simulate "git add" */
294 if (convert_crlf_into_lf
) {
295 new_stats
.lonelf
+= new_stats
.crlf
;
298 /* simulate "git checkout" */
299 if (will_convert_lf_to_crlf(len
, &new_stats
, crlf_action
)) {
300 new_stats
.crlf
+= new_stats
.lonelf
;
301 new_stats
.lonelf
= 0;
303 check_safe_crlf(path
, crlf_action
, &stats
, &new_stats
, checksafe
);
305 if (!convert_crlf_into_lf
)
309 * At this point all of our source analysis is done, and we are sure we
310 * would convert. If we are in dry-run mode, we can give an answer.
315 /* only grow if not in place */
316 if (strbuf_avail(buf
) + buf
->len
< len
)
317 strbuf_grow(buf
, len
- buf
->len
);
319 if (crlf_action
== CRLF_AUTO
|| crlf_action
== CRLF_AUTO_INPUT
|| crlf_action
== CRLF_AUTO_CRLF
) {
321 * If we guessed, we already know we rejected a file with
322 * lone CR, and we can strip a CR without looking at what
326 unsigned char c
= *src
++;
332 unsigned char c
= *src
++;
333 if (! (c
== '\r' && (1 < len
&& *src
== '\n')))
337 strbuf_setlen(buf
, dst
- buf
->buf
);
341 static int crlf_to_worktree(const char *path
, const char *src
, size_t len
,
342 struct strbuf
*buf
, enum crlf_action crlf_action
)
344 char *to_free
= NULL
;
345 struct text_stat stats
;
347 if (!len
|| output_eol(crlf_action
) != EOL_CRLF
)
350 gather_stats(src
, len
, &stats
);
351 if (!will_convert_lf_to_crlf(len
, &stats
, crlf_action
))
354 /* are we "faking" in place editing ? */
356 to_free
= strbuf_detach(buf
, NULL
);
358 strbuf_grow(buf
, len
+ stats
.lonelf
);
360 const char *nl
= memchr(src
, '\n', len
);
363 if (nl
> src
&& nl
[-1] == '\r') {
364 strbuf_add(buf
, src
, nl
+ 1 - src
);
366 strbuf_add(buf
, src
, nl
- src
);
367 strbuf_addstr(buf
, "\r\n");
372 strbuf_add(buf
, src
, len
);
378 struct filter_params
{
386 static int filter_buffer_or_fd(int in
, int out
, void *data
)
389 * Spawn cmd and feed the buffer contents through its stdin.
391 struct child_process child_process
= CHILD_PROCESS_INIT
;
392 struct filter_params
*params
= (struct filter_params
*)data
;
393 int write_err
, status
;
394 const char *argv
[] = { NULL
, NULL
};
396 /* apply % substitution to cmd */
397 struct strbuf cmd
= STRBUF_INIT
;
398 struct strbuf path
= STRBUF_INIT
;
399 struct strbuf_expand_dict_entry dict
[] = {
404 /* quote the path to preserve spaces, etc. */
405 sq_quote_buf(&path
, params
->path
);
406 dict
[0].value
= path
.buf
;
408 /* expand all %f with the quoted path */
409 strbuf_expand(&cmd
, params
->cmd
, strbuf_expand_dict_cb
, &dict
);
410 strbuf_release(&path
);
414 child_process
.argv
= argv
;
415 child_process
.use_shell
= 1;
416 child_process
.in
= -1;
417 child_process
.out
= out
;
419 if (start_command(&child_process
))
420 return error("cannot fork to run external filter '%s'", params
->cmd
);
422 sigchain_push(SIGPIPE
, SIG_IGN
);
425 write_err
= (write_in_full(child_process
.in
,
426 params
->src
, params
->size
) < 0);
430 write_err
= copy_fd(params
->fd
, child_process
.in
);
431 if (write_err
== COPY_WRITE_ERROR
&& errno
== EPIPE
)
435 if (close(child_process
.in
))
438 error("cannot feed the input to external filter '%s'", params
->cmd
);
440 sigchain_pop(SIGPIPE
);
442 status
= finish_command(&child_process
);
444 error("external filter '%s' failed %d", params
->cmd
, status
);
446 strbuf_release(&cmd
);
447 return (write_err
|| status
);
450 static int apply_single_file_filter(const char *path
, const char *src
, size_t len
, int fd
,
451 struct strbuf
*dst
, const char *cmd
)
454 * Create a pipeline to have the command filter the buffer's
457 * (child --> cmd) --> us
460 struct strbuf nbuf
= STRBUF_INIT
;
462 struct filter_params params
;
464 memset(&async
, 0, sizeof(async
));
465 async
.proc
= filter_buffer_or_fd
;
466 async
.data
= ¶ms
;
475 if (start_async(&async
))
476 return 0; /* error was already reported */
478 if (strbuf_read(&nbuf
, async
.out
, len
) < 0) {
479 err
= error("read from external filter '%s' failed", cmd
);
481 if (close(async
.out
)) {
482 err
= error("read from external filter '%s' failed", cmd
);
484 if (finish_async(&async
)) {
485 err
= error("external filter '%s' failed", cmd
);
489 strbuf_swap(dst
, &nbuf
);
491 strbuf_release(&nbuf
);
495 #define CAP_CLEAN (1u<<0)
496 #define CAP_SMUDGE (1u<<1)
499 struct hashmap_entry ent
; /* must be the first member! */
500 unsigned int supported_capabilities
;
502 struct child_process process
;
505 static int cmd_process_map_initialized
;
506 static struct hashmap cmd_process_map
;
508 static int cmd2process_cmp(const struct cmd2process
*e1
,
509 const struct cmd2process
*e2
,
512 return strcmp(e1
->cmd
, e2
->cmd
);
515 static struct cmd2process
*find_multi_file_filter_entry(struct hashmap
*hashmap
, const char *cmd
)
517 struct cmd2process key
;
518 hashmap_entry_init(&key
, strhash(cmd
));
520 return hashmap_get(hashmap
, &key
, NULL
);
523 static int packet_write_list(int fd
, const char *line
, ...)
527 va_start(args
, line
);
531 if (strlen(line
) > LARGE_PACKET_DATA_MAX
)
533 err
= packet_write_fmt_gently(fd
, "%s\n", line
);
536 line
= va_arg(args
, const char*);
539 return packet_flush_gently(fd
);
542 static void read_multi_file_filter_status(int fd
, struct strbuf
*status
)
544 struct strbuf
**pair
;
547 line
= packet_read_line(fd
, NULL
);
550 pair
= strbuf_split_str(line
, '=', 2);
551 if (pair
[0] && pair
[0]->len
&& pair
[1]) {
552 /* the last "status=<foo>" line wins */
553 if (!strcmp(pair
[0]->buf
, "status=")) {
554 strbuf_reset(status
);
555 strbuf_addbuf(status
, pair
[1]);
558 strbuf_list_free(pair
);
562 static void kill_multi_file_filter(struct hashmap
*hashmap
, struct cmd2process
*entry
)
567 entry
->process
.clean_on_exit
= 0;
568 kill(entry
->process
.pid
, SIGTERM
);
569 finish_command(&entry
->process
);
571 hashmap_remove(hashmap
, entry
, NULL
);
575 static void stop_multi_file_filter(struct child_process
*process
)
577 sigchain_push(SIGPIPE
, SIG_IGN
);
578 /* Closing the pipe signals the filter to initiate a shutdown. */
581 sigchain_pop(SIGPIPE
);
582 /* Finish command will wait until the shutdown is complete. */
583 finish_command(process
);
586 static struct cmd2process
*start_multi_file_filter(struct hashmap
*hashmap
, const char *cmd
)
589 struct cmd2process
*entry
;
590 struct child_process
*process
;
591 const char *argv
[] = { cmd
, NULL
};
592 struct string_list cap_list
= STRING_LIST_INIT_NODUP
;
594 const char *cap_name
;
596 entry
= xmalloc(sizeof(*entry
));
598 entry
->supported_capabilities
= 0;
599 process
= &entry
->process
;
601 child_process_init(process
);
602 process
->argv
= argv
;
603 process
->use_shell
= 1;
606 process
->clean_on_exit
= 1;
607 process
->clean_on_exit_handler
= stop_multi_file_filter
;
609 if (start_command(process
)) {
610 error("cannot fork to run external filter '%s'", cmd
);
614 hashmap_entry_init(entry
, strhash(cmd
));
616 sigchain_push(SIGPIPE
, SIG_IGN
);
618 err
= packet_write_list(process
->in
, "git-filter-client", "version=2", NULL
);
622 err
= strcmp(packet_read_line(process
->out
, NULL
), "git-filter-server");
624 error("external filter '%s' does not support filter protocol version 2", cmd
);
627 err
= strcmp(packet_read_line(process
->out
, NULL
), "version=2");
630 err
= packet_read_line(process
->out
, NULL
) != NULL
;
634 err
= packet_write_list(process
->in
, "capability=clean", "capability=smudge", NULL
);
637 cap_buf
= packet_read_line(process
->out
, NULL
);
640 string_list_split_in_place(&cap_list
, cap_buf
, '=', 1);
642 if (cap_list
.nr
!= 2 || strcmp(cap_list
.items
[0].string
, "capability"))
645 cap_name
= cap_list
.items
[1].string
;
646 if (!strcmp(cap_name
, "clean")) {
647 entry
->supported_capabilities
|= CAP_CLEAN
;
648 } else if (!strcmp(cap_name
, "smudge")) {
649 entry
->supported_capabilities
|= CAP_SMUDGE
;
652 "external filter '%s' requested unsupported filter capability '%s'",
657 string_list_clear(&cap_list
, 0);
661 sigchain_pop(SIGPIPE
);
663 if (err
|| errno
== EPIPE
) {
664 error("initialization for external filter '%s' failed", cmd
);
665 kill_multi_file_filter(hashmap
, entry
);
669 hashmap_add(hashmap
, entry
);
673 static int apply_multi_file_filter(const char *path
, const char *src
, size_t len
,
674 int fd
, struct strbuf
*dst
, const char *cmd
,
675 const unsigned int wanted_capability
)
678 struct cmd2process
*entry
;
679 struct child_process
*process
;
680 struct strbuf nbuf
= STRBUF_INIT
;
681 struct strbuf filter_status
= STRBUF_INIT
;
682 const char *filter_type
;
684 if (!cmd_process_map_initialized
) {
685 cmd_process_map_initialized
= 1;
686 hashmap_init(&cmd_process_map
, (hashmap_cmp_fn
) cmd2process_cmp
, 0);
689 entry
= find_multi_file_filter_entry(&cmd_process_map
, cmd
);
695 entry
= start_multi_file_filter(&cmd_process_map
, cmd
);
699 process
= &entry
->process
;
701 if (!(wanted_capability
& entry
->supported_capabilities
))
704 if (CAP_CLEAN
& wanted_capability
)
705 filter_type
= "clean";
706 else if (CAP_SMUDGE
& wanted_capability
)
707 filter_type
= "smudge";
709 die("unexpected filter type");
711 sigchain_push(SIGPIPE
, SIG_IGN
);
713 assert(strlen(filter_type
) < LARGE_PACKET_DATA_MAX
- strlen("command=\n"));
714 err
= packet_write_fmt_gently(process
->in
, "command=%s\n", filter_type
);
718 err
= strlen(path
) > LARGE_PACKET_DATA_MAX
- strlen("pathname=\n");
720 error("path name too long for external filter");
724 err
= packet_write_fmt_gently(process
->in
, "pathname=%s\n", path
);
728 err
= packet_flush_gently(process
->in
);
733 err
= write_packetized_from_fd(fd
, process
->in
);
735 err
= write_packetized_from_buf(src
, len
, process
->in
);
739 read_multi_file_filter_status(process
->out
, &filter_status
);
740 err
= strcmp(filter_status
.buf
, "success");
744 err
= read_packetized_to_strbuf(process
->out
, &nbuf
) < 0;
748 read_multi_file_filter_status(process
->out
, &filter_status
);
749 err
= strcmp(filter_status
.buf
, "success");
752 sigchain_pop(SIGPIPE
);
754 if (err
|| errno
== EPIPE
) {
755 if (!strcmp(filter_status
.buf
, "error")) {
756 /* The filter signaled a problem with the file. */
757 } else if (!strcmp(filter_status
.buf
, "abort")) {
759 * The filter signaled a permanent problem. Don't try to filter
760 * files with the same command for the lifetime of the current
763 entry
->supported_capabilities
&= ~wanted_capability
;
766 * Something went wrong with the protocol filter.
767 * Force shutdown and restart if another blob requires filtering.
769 error("external filter '%s' failed", cmd
);
770 kill_multi_file_filter(&cmd_process_map
, entry
);
773 strbuf_swap(dst
, &nbuf
);
775 strbuf_release(&nbuf
);
779 static struct convert_driver
{
781 struct convert_driver
*next
;
786 } *user_convert
, **user_convert_tail
;
788 static int apply_filter(const char *path
, const char *src
, size_t len
,
789 int fd
, struct strbuf
*dst
, struct convert_driver
*drv
,
790 const unsigned int wanted_capability
)
792 const char *cmd
= NULL
;
800 if ((CAP_CLEAN
& wanted_capability
) && !drv
->process
&& drv
->clean
)
802 else if ((CAP_SMUDGE
& wanted_capability
) && !drv
->process
&& drv
->smudge
)
806 return apply_single_file_filter(path
, src
, len
, fd
, dst
, cmd
);
807 else if (drv
->process
&& *drv
->process
)
808 return apply_multi_file_filter(path
, src
, len
, fd
, dst
, drv
->process
, wanted_capability
);
813 static int read_convert_config(const char *var
, const char *value
, void *cb
)
815 const char *key
, *name
;
817 struct convert_driver
*drv
;
820 * External conversion drivers are configured using
821 * "filter.<name>.variable".
823 if (parse_config_key(var
, "filter", &name
, &namelen
, &key
) < 0 || !name
)
825 for (drv
= user_convert
; drv
; drv
= drv
->next
)
826 if (!strncmp(drv
->name
, name
, namelen
) && !drv
->name
[namelen
])
829 drv
= xcalloc(1, sizeof(struct convert_driver
));
830 drv
->name
= xmemdupz(name
, namelen
);
831 *user_convert_tail
= drv
;
832 user_convert_tail
= &(drv
->next
);
836 * filter.<name>.smudge and filter.<name>.clean specifies
841 * The command-line will not be interpolated in any way.
844 if (!strcmp("smudge", key
))
845 return git_config_string(&drv
->smudge
, var
, value
);
847 if (!strcmp("clean", key
))
848 return git_config_string(&drv
->clean
, var
, value
);
850 if (!strcmp("process", key
))
851 return git_config_string(&drv
->process
, var
, value
);
853 if (!strcmp("required", key
)) {
854 drv
->required
= git_config_bool(var
, value
);
861 static int count_ident(const char *cp
, unsigned long size
)
864 * "$Id: 0000000000000000000000000000000000000000 $" <=> "$Id$"
876 if (memcmp("Id", cp
, 2))
887 * "$Id: ... "; scan up to the closing dollar sign and discard.
903 static int ident_to_git(const char *path
, const char *src
, size_t len
,
904 struct strbuf
*buf
, int ident
)
908 if (!ident
|| (src
&& !count_ident(src
, len
)))
914 /* only grow if not in place */
915 if (strbuf_avail(buf
) + buf
->len
< len
)
916 strbuf_grow(buf
, len
- buf
->len
);
919 dollar
= memchr(src
, '$', len
);
922 memmove(dst
, src
, dollar
+ 1 - src
);
923 dst
+= dollar
+ 1 - src
;
924 len
-= dollar
+ 1 - src
;
927 if (len
> 3 && !memcmp(src
, "Id:", 3)) {
928 dollar
= memchr(src
+ 3, '$', len
- 3);
931 if (memchr(src
+ 3, '\n', dollar
- src
- 3)) {
932 /* Line break before the next dollar. */
936 memcpy(dst
, "Id$", 3);
938 len
-= dollar
+ 1 - src
;
942 memmove(dst
, src
, len
);
943 strbuf_setlen(buf
, dst
+ len
- buf
->buf
);
947 static int ident_to_worktree(const char *path
, const char *src
, size_t len
,
948 struct strbuf
*buf
, int ident
)
950 unsigned char sha1
[20];
951 char *to_free
= NULL
, *dollar
, *spc
;
957 cnt
= count_ident(src
, len
);
961 /* are we "faking" in place editing ? */
963 to_free
= strbuf_detach(buf
, NULL
);
964 hash_sha1_file(src
, len
, "blob", sha1
);
966 strbuf_grow(buf
, len
+ cnt
* 43);
968 /* step 1: run to the next '$' */
969 dollar
= memchr(src
, '$', len
);
972 strbuf_add(buf
, src
, dollar
+ 1 - src
);
973 len
-= dollar
+ 1 - src
;
976 /* step 2: does it looks like a bit like Id:xxx$ or Id$ ? */
977 if (len
< 3 || memcmp("Id", src
, 2))
980 /* step 3: skip over Id$ or Id:xxxxx$ */
984 } else if (src
[2] == ':') {
986 * It's possible that an expanded Id has crept its way into the
987 * repository, we cope with that by stripping the expansion out.
988 * This is probably not a good idea, since it will cause changes
989 * on checkout, which won't go away by stash, but let's keep it
992 dollar
= memchr(src
+ 3, '$', len
- 3);
994 /* incomplete keyword, no more '$', so just quit the loop */
998 if (memchr(src
+ 3, '\n', dollar
- src
- 3)) {
999 /* Line break before the next dollar. */
1003 spc
= memchr(src
+ 4, ' ', dollar
- src
- 4);
1004 if (spc
&& spc
< dollar
-1) {
1005 /* There are spaces in unexpected places.
1006 * This is probably an id from some other
1007 * versioning system. Keep it for now.
1012 len
-= dollar
+ 1 - src
;
1015 /* it wasn't a "Id$" or "Id:xxxx$" */
1019 /* step 4: substitute */
1020 strbuf_addstr(buf
, "Id: ");
1021 strbuf_add(buf
, sha1_to_hex(sha1
), 40);
1022 strbuf_addstr(buf
, " $");
1024 strbuf_add(buf
, src
, len
);
1030 static enum crlf_action
git_path_check_crlf(struct git_attr_check
*check
)
1032 const char *value
= check
->value
;
1034 if (ATTR_TRUE(value
))
1036 else if (ATTR_FALSE(value
))
1038 else if (ATTR_UNSET(value
))
1040 else if (!strcmp(value
, "input"))
1041 return CRLF_TEXT_INPUT
;
1042 else if (!strcmp(value
, "auto"))
1044 return CRLF_UNDEFINED
;
1047 static enum eol
git_path_check_eol(struct git_attr_check
*check
)
1049 const char *value
= check
->value
;
1051 if (ATTR_UNSET(value
))
1053 else if (!strcmp(value
, "lf"))
1055 else if (!strcmp(value
, "crlf"))
1060 static struct convert_driver
*git_path_check_convert(struct git_attr_check
*check
)
1062 const char *value
= check
->value
;
1063 struct convert_driver
*drv
;
1065 if (ATTR_TRUE(value
) || ATTR_FALSE(value
) || ATTR_UNSET(value
))
1067 for (drv
= user_convert
; drv
; drv
= drv
->next
)
1068 if (!strcmp(value
, drv
->name
))
1073 static int git_path_check_ident(struct git_attr_check
*check
)
1075 const char *value
= check
->value
;
1077 return !!ATTR_TRUE(value
);
1081 struct convert_driver
*drv
;
1082 enum crlf_action attr_action
; /* What attr says */
1083 enum crlf_action crlf_action
; /* When no attr is set, use core.autocrlf */
1087 static const char *conv_attr_name
[] = {
1088 "crlf", "ident", "filter", "eol", "text",
1090 #define NUM_CONV_ATTRS ARRAY_SIZE(conv_attr_name)
1092 static void convert_attrs(struct conv_attrs
*ca
, const char *path
)
1095 static struct git_attr_check ccheck
[NUM_CONV_ATTRS
];
1097 if (!ccheck
[0].attr
) {
1098 for (i
= 0; i
< NUM_CONV_ATTRS
; i
++)
1099 ccheck
[i
].attr
= git_attr(conv_attr_name
[i
]);
1100 user_convert_tail
= &user_convert
;
1101 git_config(read_convert_config
, NULL
);
1104 if (!git_check_attr(path
, NUM_CONV_ATTRS
, ccheck
)) {
1105 ca
->crlf_action
= git_path_check_crlf(ccheck
+ 4);
1106 if (ca
->crlf_action
== CRLF_UNDEFINED
)
1107 ca
->crlf_action
= git_path_check_crlf(ccheck
+ 0);
1108 ca
->attr_action
= ca
->crlf_action
;
1109 ca
->ident
= git_path_check_ident(ccheck
+ 1);
1110 ca
->drv
= git_path_check_convert(ccheck
+ 2);
1111 if (ca
->crlf_action
!= CRLF_BINARY
) {
1112 enum eol eol_attr
= git_path_check_eol(ccheck
+ 3);
1113 if (ca
->crlf_action
== CRLF_AUTO
&& eol_attr
== EOL_LF
)
1114 ca
->crlf_action
= CRLF_AUTO_INPUT
;
1115 else if (ca
->crlf_action
== CRLF_AUTO
&& eol_attr
== EOL_CRLF
)
1116 ca
->crlf_action
= CRLF_AUTO_CRLF
;
1117 else if (eol_attr
== EOL_LF
)
1118 ca
->crlf_action
= CRLF_TEXT_INPUT
;
1119 else if (eol_attr
== EOL_CRLF
)
1120 ca
->crlf_action
= CRLF_TEXT_CRLF
;
1122 ca
->attr_action
= ca
->crlf_action
;
1125 ca
->crlf_action
= CRLF_UNDEFINED
;
1128 if (ca
->crlf_action
== CRLF_TEXT
)
1129 ca
->crlf_action
= text_eol_is_crlf() ? CRLF_TEXT_CRLF
: CRLF_TEXT_INPUT
;
1130 if (ca
->crlf_action
== CRLF_UNDEFINED
&& auto_crlf
== AUTO_CRLF_FALSE
)
1131 ca
->crlf_action
= CRLF_BINARY
;
1132 if (ca
->crlf_action
== CRLF_UNDEFINED
&& auto_crlf
== AUTO_CRLF_TRUE
)
1133 ca
->crlf_action
= CRLF_AUTO_CRLF
;
1134 if (ca
->crlf_action
== CRLF_UNDEFINED
&& auto_crlf
== AUTO_CRLF_INPUT
)
1135 ca
->crlf_action
= CRLF_AUTO_INPUT
;
1138 int would_convert_to_git_filter_fd(const char *path
)
1140 struct conv_attrs ca
;
1142 convert_attrs(&ca
, path
);
1147 * Apply a filter to an fd only if the filter is required to succeed.
1148 * We must die if the filter fails, because the original data before
1149 * filtering is not available.
1151 if (!ca
.drv
->required
)
1154 return apply_filter(path
, NULL
, 0, -1, NULL
, ca
.drv
, CAP_CLEAN
);
1157 const char *get_convert_attr_ascii(const char *path
)
1159 struct conv_attrs ca
;
1161 convert_attrs(&ca
, path
);
1162 switch (ca
.attr_action
) {
1163 case CRLF_UNDEFINED
:
1169 case CRLF_TEXT_INPUT
:
1170 return "text eol=lf";
1171 case CRLF_TEXT_CRLF
:
1172 return "text eol=crlf";
1175 case CRLF_AUTO_CRLF
:
1176 return "text=auto eol=crlf";
1177 case CRLF_AUTO_INPUT
:
1178 return "text=auto eol=lf";
1183 int convert_to_git(const char *path
, const char *src
, size_t len
,
1184 struct strbuf
*dst
, enum safe_crlf checksafe
)
1187 struct conv_attrs ca
;
1189 convert_attrs(&ca
, path
);
1191 ret
|= apply_filter(path
, src
, len
, -1, dst
, ca
.drv
, CAP_CLEAN
);
1192 if (!ret
&& ca
.drv
&& ca
.drv
->required
)
1193 die("%s: clean filter '%s' failed", path
, ca
.drv
->name
);
1199 ret
|= crlf_to_git(path
, src
, len
, dst
, ca
.crlf_action
, checksafe
);
1204 return ret
| ident_to_git(path
, src
, len
, dst
, ca
.ident
);
1207 void convert_to_git_filter_fd(const char *path
, int fd
, struct strbuf
*dst
,
1208 enum safe_crlf checksafe
)
1210 struct conv_attrs ca
;
1211 convert_attrs(&ca
, path
);
1214 assert(ca
.drv
->clean
|| ca
.drv
->process
);
1216 if (!apply_filter(path
, NULL
, 0, fd
, dst
, ca
.drv
, CAP_CLEAN
))
1217 die("%s: clean filter '%s' failed", path
, ca
.drv
->name
);
1219 crlf_to_git(path
, dst
->buf
, dst
->len
, dst
, ca
.crlf_action
, checksafe
);
1220 ident_to_git(path
, dst
->buf
, dst
->len
, dst
, ca
.ident
);
1223 static int convert_to_working_tree_internal(const char *path
, const char *src
,
1224 size_t len
, struct strbuf
*dst
,
1227 int ret
= 0, ret_filter
= 0;
1228 struct conv_attrs ca
;
1230 convert_attrs(&ca
, path
);
1232 ret
|= ident_to_worktree(path
, src
, len
, dst
, ca
.ident
);
1238 * CRLF conversion can be skipped if normalizing, unless there
1239 * is a smudge or process filter (even if the process filter doesn't
1240 * support smudge). The filters might expect CRLFs.
1242 if ((ca
.drv
&& (ca
.drv
->smudge
|| ca
.drv
->process
)) || !normalizing
) {
1243 ret
|= crlf_to_worktree(path
, src
, len
, dst
, ca
.crlf_action
);
1250 ret_filter
= apply_filter(path
, src
, len
, -1, dst
, ca
.drv
, CAP_SMUDGE
);
1251 if (!ret_filter
&& ca
.drv
&& ca
.drv
->required
)
1252 die("%s: smudge filter %s failed", path
, ca
.drv
->name
);
1254 return ret
| ret_filter
;
1257 int convert_to_working_tree(const char *path
, const char *src
, size_t len
, struct strbuf
*dst
)
1259 return convert_to_working_tree_internal(path
, src
, len
, dst
, 0);
1262 int renormalize_buffer(const char *path
, const char *src
, size_t len
, struct strbuf
*dst
)
1264 int ret
= convert_to_working_tree_internal(path
, src
, len
, dst
, 1);
1269 return ret
| convert_to_git(path
, src
, len
, dst
, SAFE_CRLF_RENORMALIZE
);
1272 /*****************************************************************
1274 * Streaming conversion support
1276 *****************************************************************/
1278 typedef int (*filter_fn
)(struct stream_filter
*,
1279 const char *input
, size_t *isize_p
,
1280 char *output
, size_t *osize_p
);
1281 typedef void (*free_fn
)(struct stream_filter
*);
1283 struct stream_filter_vtbl
{
1288 struct stream_filter
{
1289 struct stream_filter_vtbl
*vtbl
;
1292 static int null_filter_fn(struct stream_filter
*filter
,
1293 const char *input
, size_t *isize_p
,
1294 char *output
, size_t *osize_p
)
1299 return 0; /* we do not keep any states */
1301 if (*osize_p
< count
)
1304 memmove(output
, input
, count
);
1311 static void null_free_fn(struct stream_filter
*filter
)
1313 ; /* nothing -- null instances are shared */
1316 static struct stream_filter_vtbl null_vtbl
= {
1321 static struct stream_filter null_filter_singleton
= {
1325 int is_null_stream_filter(struct stream_filter
*filter
)
1327 return filter
== &null_filter_singleton
;
1335 struct lf_to_crlf_filter
{
1336 struct stream_filter filter
;
1337 unsigned has_held
:1;
1341 static int lf_to_crlf_filter_fn(struct stream_filter
*filter
,
1342 const char *input
, size_t *isize_p
,
1343 char *output
, size_t *osize_p
)
1345 size_t count
, o
= 0;
1346 struct lf_to_crlf_filter
*lf_to_crlf
= (struct lf_to_crlf_filter
*)filter
;
1349 * We may be holding onto the CR to see if it is followed by a
1350 * LF, in which case we would need to go to the main loop.
1351 * Otherwise, just emit it to the output stream.
1353 if (lf_to_crlf
->has_held
&& (lf_to_crlf
->held
!= '\r' || !input
)) {
1354 output
[o
++] = lf_to_crlf
->held
;
1355 lf_to_crlf
->has_held
= 0;
1358 /* We are told to drain */
1365 if (count
|| lf_to_crlf
->has_held
) {
1369 if (lf_to_crlf
->has_held
) {
1371 lf_to_crlf
->has_held
= 0;
1374 for (i
= 0; o
< *osize_p
&& i
< count
; i
++) {
1379 } else if (was_cr
) {
1381 * Previous round saw CR and it is not followed
1382 * by a LF; emit the CR before processing the
1383 * current character.
1389 * We may have consumed the last output slot,
1390 * in which case we need to break out of this
1391 * loop; hold the current character before
1394 if (*osize_p
<= o
) {
1395 lf_to_crlf
->has_held
= 1;
1396 lf_to_crlf
->held
= ch
;
1397 continue; /* break but increment i */
1412 if (!lf_to_crlf
->has_held
&& was_cr
) {
1413 lf_to_crlf
->has_held
= 1;
1414 lf_to_crlf
->held
= '\r';
1420 static void lf_to_crlf_free_fn(struct stream_filter
*filter
)
1425 static struct stream_filter_vtbl lf_to_crlf_vtbl
= {
1426 lf_to_crlf_filter_fn
,
1430 static struct stream_filter
*lf_to_crlf_filter(void)
1432 struct lf_to_crlf_filter
*lf_to_crlf
= xcalloc(1, sizeof(*lf_to_crlf
));
1434 lf_to_crlf
->filter
.vtbl
= &lf_to_crlf_vtbl
;
1435 return (struct stream_filter
*)lf_to_crlf
;
1441 #define FILTER_BUFFER 1024
1442 struct cascade_filter
{
1443 struct stream_filter filter
;
1444 struct stream_filter
*one
;
1445 struct stream_filter
*two
;
1446 char buf
[FILTER_BUFFER
];
1450 static int cascade_filter_fn(struct stream_filter
*filter
,
1451 const char *input
, size_t *isize_p
,
1452 char *output
, size_t *osize_p
)
1454 struct cascade_filter
*cas
= (struct cascade_filter
*) filter
;
1456 size_t sz
= *osize_p
;
1457 size_t to_feed
, remaining
;
1460 * input -- (one) --> buf -- (two) --> output
1462 while (filled
< sz
) {
1463 remaining
= sz
- filled
;
1465 /* do we already have something to feed two with? */
1466 if (cas
->ptr
< cas
->end
) {
1467 to_feed
= cas
->end
- cas
->ptr
;
1468 if (stream_filter(cas
->two
,
1469 cas
->buf
+ cas
->ptr
, &to_feed
,
1470 output
+ filled
, &remaining
))
1472 cas
->ptr
+= (cas
->end
- cas
->ptr
) - to_feed
;
1473 filled
= sz
- remaining
;
1477 /* feed one from upstream and have it emit into our buffer */
1478 to_feed
= input
? *isize_p
: 0;
1479 if (input
&& !to_feed
)
1481 remaining
= sizeof(cas
->buf
);
1482 if (stream_filter(cas
->one
,
1484 cas
->buf
, &remaining
))
1486 cas
->end
= sizeof(cas
->buf
) - remaining
;
1489 size_t fed
= *isize_p
- to_feed
;
1494 /* do we know that we drained one completely? */
1495 if (input
|| cas
->end
)
1498 /* tell two to drain; we have nothing more to give it */
1500 remaining
= sz
- filled
;
1501 if (stream_filter(cas
->two
,
1503 output
+ filled
, &remaining
))
1505 if (remaining
== (sz
- filled
))
1506 break; /* completely drained two */
1507 filled
= sz
- remaining
;
1513 static void cascade_free_fn(struct stream_filter
*filter
)
1515 struct cascade_filter
*cas
= (struct cascade_filter
*)filter
;
1516 free_stream_filter(cas
->one
);
1517 free_stream_filter(cas
->two
);
1521 static struct stream_filter_vtbl cascade_vtbl
= {
1526 static struct stream_filter
*cascade_filter(struct stream_filter
*one
,
1527 struct stream_filter
*two
)
1529 struct cascade_filter
*cascade
;
1531 if (!one
|| is_null_stream_filter(one
))
1533 if (!two
|| is_null_stream_filter(two
))
1536 cascade
= xmalloc(sizeof(*cascade
));
1539 cascade
->end
= cascade
->ptr
= 0;
1540 cascade
->filter
.vtbl
= &cascade_vtbl
;
1541 return (struct stream_filter
*)cascade
;
1547 #define IDENT_DRAINING (-1)
1548 #define IDENT_SKIPPING (-2)
1549 struct ident_filter
{
1550 struct stream_filter filter
;
1553 char ident
[45]; /* ": x40 $" */
1556 static int is_foreign_ident(const char *str
)
1560 if (!skip_prefix(str
, "$Id: ", &str
))
1562 for (i
= 0; str
[i
]; i
++) {
1563 if (isspace(str
[i
]) && str
[i
+1] != '$')
1569 static void ident_drain(struct ident_filter
*ident
, char **output_p
, size_t *osize_p
)
1571 size_t to_drain
= ident
->left
.len
;
1573 if (*osize_p
< to_drain
)
1574 to_drain
= *osize_p
;
1576 memcpy(*output_p
, ident
->left
.buf
, to_drain
);
1577 strbuf_remove(&ident
->left
, 0, to_drain
);
1578 *output_p
+= to_drain
;
1579 *osize_p
-= to_drain
;
1581 if (!ident
->left
.len
)
1585 static int ident_filter_fn(struct stream_filter
*filter
,
1586 const char *input
, size_t *isize_p
,
1587 char *output
, size_t *osize_p
)
1589 struct ident_filter
*ident
= (struct ident_filter
*)filter
;
1590 static const char head
[] = "$Id";
1593 /* drain upon eof */
1594 switch (ident
->state
) {
1596 strbuf_add(&ident
->left
, head
, ident
->state
);
1597 case IDENT_SKIPPING
:
1599 case IDENT_DRAINING
:
1600 ident_drain(ident
, &output
, osize_p
);
1605 while (*isize_p
|| (ident
->state
== IDENT_DRAINING
)) {
1608 if (ident
->state
== IDENT_DRAINING
) {
1609 ident_drain(ident
, &output
, osize_p
);
1618 if (ident
->state
== IDENT_SKIPPING
) {
1620 * Skipping until '$' or LF, but keeping them
1621 * in case it is a foreign ident.
1623 strbuf_addch(&ident
->left
, ch
);
1624 if (ch
!= '\n' && ch
!= '$')
1626 if (ch
== '$' && !is_foreign_ident(ident
->left
.buf
)) {
1627 strbuf_setlen(&ident
->left
, sizeof(head
) - 1);
1628 strbuf_addstr(&ident
->left
, ident
->ident
);
1630 ident
->state
= IDENT_DRAINING
;
1634 if (ident
->state
< sizeof(head
) &&
1635 head
[ident
->state
] == ch
) {
1641 strbuf_add(&ident
->left
, head
, ident
->state
);
1642 if (ident
->state
== sizeof(head
) - 1) {
1643 if (ch
!= ':' && ch
!= '$') {
1644 strbuf_addch(&ident
->left
, ch
);
1650 strbuf_addch(&ident
->left
, ch
);
1651 ident
->state
= IDENT_SKIPPING
;
1653 strbuf_addstr(&ident
->left
, ident
->ident
);
1654 ident
->state
= IDENT_DRAINING
;
1659 strbuf_addch(&ident
->left
, ch
);
1660 ident
->state
= IDENT_DRAINING
;
1665 static void ident_free_fn(struct stream_filter
*filter
)
1667 struct ident_filter
*ident
= (struct ident_filter
*)filter
;
1668 strbuf_release(&ident
->left
);
1672 static struct stream_filter_vtbl ident_vtbl
= {
1677 static struct stream_filter
*ident_filter(const unsigned char *sha1
)
1679 struct ident_filter
*ident
= xmalloc(sizeof(*ident
));
1681 xsnprintf(ident
->ident
, sizeof(ident
->ident
),
1682 ": %s $", sha1_to_hex(sha1
));
1683 strbuf_init(&ident
->left
, 0);
1684 ident
->filter
.vtbl
= &ident_vtbl
;
1686 return (struct stream_filter
*)ident
;
1690 * Return an appropriately constructed filter for the path, or NULL if
1691 * the contents cannot be filtered without reading the whole thing
1694 * Note that you would be crazy to set CRLF, smuge/clean or ident to a
1695 * large binary blob you would want us not to slurp into the memory!
1697 struct stream_filter
*get_stream_filter(const char *path
, const unsigned char *sha1
)
1699 struct conv_attrs ca
;
1700 struct stream_filter
*filter
= NULL
;
1702 convert_attrs(&ca
, path
);
1703 if (ca
.drv
&& (ca
.drv
->process
|| ca
.drv
->smudge
|| ca
.drv
->clean
))
1706 if (ca
.crlf_action
== CRLF_AUTO
|| ca
.crlf_action
== CRLF_AUTO_CRLF
)
1710 filter
= ident_filter(sha1
);
1712 if (output_eol(ca
.crlf_action
) == EOL_CRLF
)
1713 filter
= cascade_filter(filter
, lf_to_crlf_filter());
1715 filter
= cascade_filter(filter
, &null_filter_singleton
);
1720 void free_stream_filter(struct stream_filter
*filter
)
1722 filter
->vtbl
->free(filter
);
1725 int stream_filter(struct stream_filter
*filter
,
1726 const char *input
, size_t *isize_p
,
1727 char *output
, size_t *osize_p
)
1729 return filter
->vtbl
->filter(filter
, input
, isize_p
, output
, osize_p
);