?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
remote: simplify remote_is_configured()
[git.git] / convert.c
blob4bb4ec1d836e695a86f309b276fd07e300885c57
1 #include "cache.h"
2 #include "attr.h"
3 #include "run-command.h"
4 #include "quote.h"
5 #include "sigchain.h"
6
7 /*
8 * convert.c - convert a file when checking it out and checking it in.
9 *
10 * This should use the pathname to decide on whether it wants to do some
11 * more interesting conversions (automatic gzip/unzip, general format
12 * conversions etc etc), but by default it just does automatic CRLF<->LF
13 * translation when the "text" attribute or "auto_crlf" option is set.
14 */
15
16 /* Stat bits: When BIN is set, the txt bits are unset */
17 #define CONVERT_STAT_BITS_TXT_LF 0x1
18 #define CONVERT_STAT_BITS_TXT_CRLF 0x2
19 #define CONVERT_STAT_BITS_BIN 0x4
20
21 enum crlf_action {
22 CRLF_GUESS = -1,
23 CRLF_BINARY = 0,
24 CRLF_TEXT,
25 CRLF_INPUT,
26 CRLF_CRLF,
27 CRLF_AUTO
28 };
29
30 struct text_stat {
31 /* NUL, CR, LF and CRLF counts */
32 unsigned nul, cr, lf, crlf;
33
34 /* These are just approximations! */
35 unsigned printable, nonprintable;
36 };
37
38 static void gather_stats(const char *buf, unsigned long size, struct text_stat *stats)
39 {
40 unsigned long i;
41
42 memset(stats, 0, sizeof(*stats));
43
44 for (i = 0; i < size; i++) {
45 unsigned char c = buf[i];
46 if (c == '\r') {
47 stats->cr++;
48 if (i+1 < size && buf[i+1] == '\n')
49 stats->crlf++;
50 continue;
51 }
52 if (c == '\n') {
53 stats->lf++;
54 continue;
55 }
56 if (c == 127)
57 /* DEL */
58 stats->nonprintable++;
59 else if (c < 32) {
60 switch (c) {
61 /* BS, HT, ESC and FF */
62 case '\b': case '\t': case '\033': case '\014':
63 stats->printable++;
64 break;
65 case 0:
66 stats->nul++;
67 /* fall through */
68 default:
69 stats->nonprintable++;
70 }
71 }
72 else
73 stats->printable++;
74 }
75
76 /* If file ends with EOF then don't count this EOF as non-printable. */
77 if (size >= 1 && buf[size-1] == '\032')
78 stats->nonprintable--;
79 }
80
81 /*
82 * The same heuristics as diff.c::mmfile_is_binary()
83 * We treat files with bare CR as binary
84 */
85 static int convert_is_binary(unsigned long size, const struct text_stat *stats)
86 {
87 if (stats->cr != stats->crlf)
88 return 1;
89 if (stats->nul)
90 return 1;
91 if ((stats->printable >> 7) < stats->nonprintable)
92 return 1;
93 return 0;
94 }
95
96 static unsigned int gather_convert_stats(const char *data, unsigned long size)
97 {
98 struct text_stat stats;
99 if (!data || !size)
100 return 0;
101 gather_stats(data, size, &stats);
102 if (convert_is_binary(size, &stats))
103 return CONVERT_STAT_BITS_BIN;
104 else if (stats.crlf && stats.crlf == stats.lf)
105 return CONVERT_STAT_BITS_TXT_CRLF;
106 else if (stats.crlf && stats.lf)
107 return CONVERT_STAT_BITS_TXT_CRLF | CONVERT_STAT_BITS_TXT_LF;
108 else if (stats.lf)
109 return CONVERT_STAT_BITS_TXT_LF;
110 else
111 return 0;
112 }
113
114 static const char *gather_convert_stats_ascii(const char *data, unsigned long size)
115 {
116 unsigned int convert_stats = gather_convert_stats(data, size);
117
118 if (convert_stats & CONVERT_STAT_BITS_BIN)
119 return "-text";
120 switch (convert_stats) {
121 case CONVERT_STAT_BITS_TXT_LF:
122 return "lf";
123 case CONVERT_STAT_BITS_TXT_CRLF:
124 return "crlf";
125 case CONVERT_STAT_BITS_TXT_LF | CONVERT_STAT_BITS_TXT_CRLF:
126 return "mixed";
127 default:
128 return "none";
129 }
130 }
131
132 const char *get_cached_convert_stats_ascii(const char *path)
133 {
134 const char *ret;
135 unsigned long sz;
136 void *data = read_blob_data_from_cache(path, &sz);
137 ret = gather_convert_stats_ascii(data, sz);
138 free(data);
139 return ret;
140 }
141
142 const char *get_wt_convert_stats_ascii(const char *path)
143 {
144 const char *ret = "";
145 struct strbuf sb = STRBUF_INIT;
146 if (strbuf_read_file(&sb, path, 0) >= 0)
147 ret = gather_convert_stats_ascii(sb.buf, sb.len);
148 strbuf_release(&sb);
149 return ret;
150 }
151
152 static enum eol output_eol(enum crlf_action crlf_action)
153 {
154 switch (crlf_action) {
155 case CRLF_BINARY:
156 return EOL_UNSET;
157 case CRLF_CRLF:
158 return EOL_CRLF;
159 case CRLF_INPUT:
160 return EOL_LF;
161 case CRLF_GUESS:
162 if (!auto_crlf)
163 return EOL_UNSET;
164 /* fall through */
165 case CRLF_TEXT:
166 case CRLF_AUTO:
167 if (auto_crlf == AUTO_CRLF_TRUE)
168 return EOL_CRLF;
169 else if (auto_crlf == AUTO_CRLF_INPUT)
170 return EOL_LF;
171 else if (core_eol == EOL_UNSET)
172 return EOL_NATIVE;
173 }
174 return core_eol;
175 }
176
177 static void check_safe_crlf(const char *path, enum crlf_action crlf_action,
178 struct text_stat *stats, enum safe_crlf checksafe)
179 {
180 if (!checksafe)
181 return;
182
183 if (output_eol(crlf_action) == EOL_LF) {
184 /*
185 * CRLFs would not be restored by checkout:
186 * check if we'd remove CRLFs
187 */
188 if (stats->crlf) {
189 if (checksafe == SAFE_CRLF_WARN)
190 warning("CRLF will be replaced by LF in %s.\nThe file will have its original line endings in your working directory.", path);
191 else /* i.e. SAFE_CRLF_FAIL */
192 die("CRLF would be replaced by LF in %s.", path);
193 }
194 } else if (output_eol(crlf_action) == EOL_CRLF) {
195 /*
196 * CRLFs would be added by checkout:
197 * check if we have "naked" LFs
198 */
199 if (stats->lf != stats->crlf) {
200 if (checksafe == SAFE_CRLF_WARN)
201 warning("LF will be replaced by CRLF in %s.\nThe file will have its original line endings in your working directory.", path);
202 else /* i.e. SAFE_CRLF_FAIL */
203 die("LF would be replaced by CRLF in %s", path);
204 }
205 }
206 }
207
208 static int has_cr_in_index(const char *path)
209 {
210 unsigned long sz;
211 void *data;
212 int has_cr;
213
214 data = read_blob_data_from_cache(path, &sz);
215 if (!data)
216 return 0;
217 has_cr = memchr(data, '\r', sz) != NULL;
218 free(data);
219 return has_cr;
220 }
221
222 static int crlf_to_git(const char *path, const char *src, size_t len,
223 struct strbuf *buf,
224 enum crlf_action crlf_action, enum safe_crlf checksafe)
225 {
226 struct text_stat stats;
227 char *dst;
228
229 if (crlf_action == CRLF_BINARY ||
230 (crlf_action == CRLF_GUESS && auto_crlf == AUTO_CRLF_FALSE) ||
231 (src && !len))
232 return 0;
233
234 /*
235 * If we are doing a dry-run and have no source buffer, there is
236 * nothing to analyze; we must assume we would convert.
237 */
238 if (!buf && !src)
239 return 1;
240
241 gather_stats(src, len, &stats);
242
243 if (crlf_action == CRLF_AUTO || crlf_action == CRLF_GUESS) {
244 if (convert_is_binary(len, &stats))
245 return 0;
246
247 if (crlf_action == CRLF_GUESS) {
248 /*
249 * If the file in the index has any CR in it, do not convert.
250 * This is the new safer autocrlf handling.
251 */
252 if (has_cr_in_index(path))
253 return 0;
254 }
255 }
256
257 check_safe_crlf(path, crlf_action, &stats, checksafe);
258
259 /* Optimization: No CR? Nothing to convert, regardless. */
260 if (!stats.cr)
261 return 0;
262
263 /*
264 * At this point all of our source analysis is done, and we are sure we
265 * would convert. If we are in dry-run mode, we can give an answer.
266 */
267 if (!buf)
268 return 1;
269
270 /* only grow if not in place */
271 if (strbuf_avail(buf) + buf->len < len)
272 strbuf_grow(buf, len - buf->len);
273 dst = buf->buf;
274 if (crlf_action == CRLF_AUTO || crlf_action == CRLF_GUESS) {
275 /*
276 * If we guessed, we already know we rejected a file with
277 * lone CR, and we can strip a CR without looking at what
278 * follow it.
279 */
280 do {
281 unsigned char c = *src++;
282 if (c != '\r')
283 *dst++ = c;
284 } while (--len);
285 } else {
286 do {
287 unsigned char c = *src++;
288 if (! (c == '\r' && (1 < len && *src == '\n')))
289 *dst++ = c;
290 } while (--len);
291 }
292 strbuf_setlen(buf, dst - buf->buf);
293 return 1;
294 }
295
296 static int crlf_to_worktree(const char *path, const char *src, size_t len,
297 struct strbuf *buf, enum crlf_action crlf_action)
298 {
299 char *to_free = NULL;
300 struct text_stat stats;
301
302 if (!len || output_eol(crlf_action) != EOL_CRLF)
303 return 0;
304
305 gather_stats(src, len, &stats);
306
307 /* No LF? Nothing to convert, regardless. */
308 if (!stats.lf)
309 return 0;
310
311 /* Was it already in CRLF format? */
312 if (stats.lf == stats.crlf)
313 return 0;
314
315 if (crlf_action == CRLF_AUTO || crlf_action == CRLF_GUESS) {
316 if (crlf_action == CRLF_GUESS) {
317 /* If we have any CR or CRLF line endings, we do not touch it */
318 /* This is the new safer autocrlf-handling */
319 if (stats.cr > 0 || stats.crlf > 0)
320 return 0;
321 }
322
323 if (convert_is_binary(len, &stats))
324 return 0;
325 }
326
327 /* are we "faking" in place editing ? */
328 if (src == buf->buf)
329 to_free = strbuf_detach(buf, NULL);
330
331 strbuf_grow(buf, len + stats.lf - stats.crlf);
332 for (;;) {
333 const char *nl = memchr(src, '\n', len);
334 if (!nl)
335 break;
336 if (nl > src && nl[-1] == '\r') {
337 strbuf_add(buf, src, nl + 1 - src);
338 } else {
339 strbuf_add(buf, src, nl - src);
340 strbuf_addstr(buf, "\r\n");
341 }
342 len -= nl + 1 - src;
343 src = nl + 1;
344 }
345 strbuf_add(buf, src, len);
346
347 free(to_free);
348 return 1;
349 }
350
351 struct filter_params {
352 const char *src;
353 unsigned long size;
354 int fd;
355 const char *cmd;
356 const char *path;
357 };
358
359 static int filter_buffer_or_fd(int in, int out, void *data)
360 {
361 /*
362 * Spawn cmd and feed the buffer contents through its stdin.
363 */
364 struct child_process child_process = CHILD_PROCESS_INIT;
365 struct filter_params *params = (struct filter_params *)data;
366 int write_err, status;
367 const char *argv[] = { NULL, NULL };
368
369 /* apply % substitution to cmd */
370 struct strbuf cmd = STRBUF_INIT;
371 struct strbuf path = STRBUF_INIT;
372 struct strbuf_expand_dict_entry dict[] = {
373 { "f", NULL, },
374 { NULL, NULL, },
375 };
376
377 /* quote the path to preserve spaces, etc. */
378 sq_quote_buf(&path, params->path);
379 dict[0].value = path.buf;
380
381 /* expand all %f with the quoted path */
382 strbuf_expand(&cmd, params->cmd, strbuf_expand_dict_cb, &dict);
383 strbuf_release(&path);
384
385 argv[0] = cmd.buf;
386
387 child_process.argv = argv;
388 child_process.use_shell = 1;
389 child_process.in = -1;
390 child_process.out = out;
391
392 if (start_command(&child_process))
393 return error("cannot fork to run external filter %s", params->cmd);
394
395 sigchain_push(SIGPIPE, SIG_IGN);
396
397 if (params->src) {
398 write_err = (write_in_full(child_process.in,
399 params->src, params->size) < 0);
400 if (errno == EPIPE)
401 write_err = 0;
402 } else {
403 write_err = copy_fd(params->fd, child_process.in);
404 if (write_err == COPY_WRITE_ERROR && errno == EPIPE)
405 write_err = 0;
406 }
407
408 if (close(child_process.in))
409 write_err = 1;
410 if (write_err)
411 error("cannot feed the input to external filter %s", params->cmd);
412
413 sigchain_pop(SIGPIPE);
414
415 status = finish_command(&child_process);
416 if (status)
417 error("external filter %s failed %d", params->cmd, status);
418
419 strbuf_release(&cmd);
420 return (write_err || status);
421 }
422
423 static int apply_filter(const char *path, const char *src, size_t len, int fd,
424 struct strbuf *dst, const char *cmd)
425 {
426 /*
427 * Create a pipeline to have the command filter the buffer's
428 * contents.
429 *
430 * (child --> cmd) --> us
431 */
432 int ret = 1;
433 struct strbuf nbuf = STRBUF_INIT;
434 struct async async;
435 struct filter_params params;
436
437 if (!cmd)
438 return 0;
439
440 if (!dst)
441 return 1;
442
443 memset(&async, 0, sizeof(async));
444 async.proc = filter_buffer_or_fd;
445 async.data = &params;
446 async.out = -1;
447 params.src = src;
448 params.size = len;
449 params.fd = fd;
450 params.cmd = cmd;
451 params.path = path;
452
453 fflush(NULL);
454 if (start_async(&async))
455 return 0; /* error was already reported */
456
457 if (strbuf_read(&nbuf, async.out, len) < 0) {
458 error("read from external filter %s failed", cmd);
459 ret = 0;
460 }
461 if (close(async.out)) {
462 error("read from external filter %s failed", cmd);
463 ret = 0;
464 }
465 if (finish_async(&async)) {
466 error("external filter %s failed", cmd);
467 ret = 0;
468 }
469
470 if (ret) {
471 strbuf_swap(dst, &nbuf);
472 }
473 strbuf_release(&nbuf);
474 return ret;
475 }
476
477 static struct convert_driver {
478 const char *name;
479 struct convert_driver *next;
480 const char *smudge;
481 const char *clean;
482 int required;
483 } *user_convert, **user_convert_tail;
484
485 static int read_convert_config(const char *var, const char *value, void *cb)
486 {
487 const char *key, *name;
488 int namelen;
489 struct convert_driver *drv;
490
491 /*
492 * External conversion drivers are configured using
493 * "filter.<name>.variable".
494 */
495 if (parse_config_key(var, "filter", &name, &namelen, &key) < 0 || !name)
496 return 0;
497 for (drv = user_convert; drv; drv = drv->next)
498 if (!strncmp(drv->name, name, namelen) && !drv->name[namelen])
499 break;
500 if (!drv) {
501 drv = xcalloc(1, sizeof(struct convert_driver));
502 drv->name = xmemdupz(name, namelen);
503 *user_convert_tail = drv;
504 user_convert_tail = &(drv->next);
505 }
506
507 /*
508 * filter.<name>.smudge and filter.<name>.clean specifies
509 * the command line:
510 *
511 * command-line
512 *
513 * The command-line will not be interpolated in any way.
514 */
515
516 if (!strcmp("smudge", key))
517 return git_config_string(&drv->smudge, var, value);
518
519 if (!strcmp("clean", key))
520 return git_config_string(&drv->clean, var, value);
521
522 if (!strcmp("required", key)) {
523 drv->required = git_config_bool(var, value);
524 return 0;
525 }
526
527 return 0;
528 }
529
530 static int count_ident(const char *cp, unsigned long size)
531 {
532 /*
533 * "$Id: 0000000000000000000000000000000000000000 $" <=> "$Id$"
534 */
535 int cnt = 0;
536 char ch;
537
538 while (size) {
539 ch = *cp++;
540 size--;
541 if (ch != '$')
542 continue;
543 if (size < 3)
544 break;
545 if (memcmp("Id", cp, 2))
546 continue;
547 ch = cp[2];
548 cp += 3;
549 size -= 3;
550 if (ch == '$')
551 cnt++; /* $Id$ */
552 if (ch != ':')
553 continue;
554
555 /*
556 * "$Id: ... "; scan up to the closing dollar sign and discard.
557 */
558 while (size) {
559 ch = *cp++;
560 size--;
561 if (ch == '$') {
562 cnt++;
563 break;
564 }
565 if (ch == '\n')
566 break;
567 }
568 }
569 return cnt;
570 }
571
572 static int ident_to_git(const char *path, const char *src, size_t len,
573 struct strbuf *buf, int ident)
574 {
575 char *dst, *dollar;
576
577 if (!ident || (src && !count_ident(src, len)))
578 return 0;
579
580 if (!buf)
581 return 1;
582
583 /* only grow if not in place */
584 if (strbuf_avail(buf) + buf->len < len)
585 strbuf_grow(buf, len - buf->len);
586 dst = buf->buf;
587 for (;;) {
588 dollar = memchr(src, '$', len);
589 if (!dollar)
590 break;
591 memmove(dst, src, dollar + 1 - src);
592 dst += dollar + 1 - src;
593 len -= dollar + 1 - src;
594 src = dollar + 1;
595
596 if (len > 3 && !memcmp(src, "Id:", 3)) {
597 dollar = memchr(src + 3, '$', len - 3);
598 if (!dollar)
599 break;
600 if (memchr(src + 3, '\n', dollar - src - 3)) {
601 /* Line break before the next dollar. */
602 continue;
603 }
604
605 memcpy(dst, "Id$", 3);
606 dst += 3;
607 len -= dollar + 1 - src;
608 src = dollar + 1;
609 }
610 }
611 memmove(dst, src, len);
612 strbuf_setlen(buf, dst + len - buf->buf);
613 return 1;
614 }
615
616 static int ident_to_worktree(const char *path, const char *src, size_t len,
617 struct strbuf *buf, int ident)
618 {
619 unsigned char sha1[20];
620 char *to_free = NULL, *dollar, *spc;
621 int cnt;
622
623 if (!ident)
624 return 0;
625
626 cnt = count_ident(src, len);
627 if (!cnt)
628 return 0;
629
630 /* are we "faking" in place editing ? */
631 if (src == buf->buf)
632 to_free = strbuf_detach(buf, NULL);
633 hash_sha1_file(src, len, "blob", sha1);
634
635 strbuf_grow(buf, len + cnt * 43);
636 for (;;) {
637 /* step 1: run to the next '$' */
638 dollar = memchr(src, '$', len);
639 if (!dollar)
640 break;
641 strbuf_add(buf, src, dollar + 1 - src);
642 len -= dollar + 1 - src;
643 src = dollar + 1;
644
645 /* step 2: does it looks like a bit like Id:xxx$ or Id$ ? */
646 if (len < 3 || memcmp("Id", src, 2))
647 continue;
648
649 /* step 3: skip over Id$ or Id:xxxxx$ */
650 if (src[2] == '$') {
651 src += 3;
652 len -= 3;
653 } else if (src[2] == ':') {
654 /*
655 * It's possible that an expanded Id has crept its way into the
656 * repository, we cope with that by stripping the expansion out.
657 * This is probably not a good idea, since it will cause changes
658 * on checkout, which won't go away by stash, but let's keep it
659 * for git-style ids.
660 */
661 dollar = memchr(src + 3, '$', len - 3);
662 if (!dollar) {
663 /* incomplete keyword, no more '$', so just quit the loop */
664 break;
665 }
666
667 if (memchr(src + 3, '\n', dollar - src - 3)) {
668 /* Line break before the next dollar. */
669 continue;
670 }
671
672 spc = memchr(src + 4, ' ', dollar - src - 4);
673 if (spc && spc < dollar-1) {
674 /* There are spaces in unexpected places.
675 * This is probably an id from some other
676 * versioning system. Keep it for now.
677 */
678 continue;
679 }
680
681 len -= dollar + 1 - src;
682 src = dollar + 1;
683 } else {
684 /* it wasn't a "Id$" or "Id:xxxx$" */
685 continue;
686 }
687
688 /* step 4: substitute */
689 strbuf_addstr(buf, "Id: ");
690 strbuf_add(buf, sha1_to_hex(sha1), 40);
691 strbuf_addstr(buf, " $");
692 }
693 strbuf_add(buf, src, len);
694
695 free(to_free);
696 return 1;
697 }
698
699 static enum crlf_action git_path_check_crlf(const char *path, struct git_attr_check *check)
700 {
701 const char *value = check->value;
702
703 if (ATTR_TRUE(value))
704 return CRLF_TEXT;
705 else if (ATTR_FALSE(value))
706 return CRLF_BINARY;
707 else if (ATTR_UNSET(value))
708 ;
709 else if (!strcmp(value, "input"))
710 return CRLF_INPUT;
711 else if (!strcmp(value, "auto"))
712 return CRLF_AUTO;
713 return CRLF_GUESS;
714 }
715
716 static enum eol git_path_check_eol(const char *path, struct git_attr_check *check)
717 {
718 const char *value = check->value;
719
720 if (ATTR_UNSET(value))
721 ;
722 else if (!strcmp(value, "lf"))
723 return EOL_LF;
724 else if (!strcmp(value, "crlf"))
725 return EOL_CRLF;
726 return EOL_UNSET;
727 }
728
729 static struct convert_driver *git_path_check_convert(const char *path,
730 struct git_attr_check *check)
731 {
732 const char *value = check->value;
733 struct convert_driver *drv;
734
735 if (ATTR_TRUE(value) || ATTR_FALSE(value) || ATTR_UNSET(value))
736 return NULL;
737 for (drv = user_convert; drv; drv = drv->next)
738 if (!strcmp(value, drv->name))
739 return drv;
740 return NULL;
741 }
742
743 static int git_path_check_ident(const char *path, struct git_attr_check *check)
744 {
745 const char *value = check->value;
746
747 return !!ATTR_TRUE(value);
748 }
749
750 static enum crlf_action input_crlf_action(enum crlf_action text_attr, enum eol eol_attr)
751 {
752 if (text_attr == CRLF_BINARY)
753 return CRLF_BINARY;
754 if (eol_attr == EOL_LF)
755 return CRLF_INPUT;
756 if (eol_attr == EOL_CRLF)
757 return CRLF_CRLF;
758 return text_attr;
759 }
760
761 struct conv_attrs {
762 struct convert_driver *drv;
763 enum crlf_action crlf_action;
764 enum eol eol_attr;
765 int ident;
766 };
767
768 static const char *conv_attr_name[] = {
769 "crlf", "ident", "filter", "eol", "text",
770 };
771 #define NUM_CONV_ATTRS ARRAY_SIZE(conv_attr_name)
772
773 static void convert_attrs(struct conv_attrs *ca, const char *path)
774 {
775 int i;
776 static struct git_attr_check ccheck[NUM_CONV_ATTRS];
777
778 if (!ccheck[0].attr) {
779 for (i = 0; i < NUM_CONV_ATTRS; i++)
780 ccheck[i].attr = git_attr(conv_attr_name[i]);
781 user_convert_tail = &user_convert;
782 git_config(read_convert_config, NULL);
783 }
784
785 if (!git_check_attr(path, NUM_CONV_ATTRS, ccheck)) {
786 ca->crlf_action = git_path_check_crlf(path, ccheck + 4);
787 if (ca->crlf_action == CRLF_GUESS)
788 ca->crlf_action = git_path_check_crlf(path, ccheck + 0);
789 ca->ident = git_path_check_ident(path, ccheck + 1);
790 ca->drv = git_path_check_convert(path, ccheck + 2);
791 ca->eol_attr = git_path_check_eol(path, ccheck + 3);
792 } else {
793 ca->drv = NULL;
794 ca->crlf_action = CRLF_GUESS;
795 ca->eol_attr = EOL_UNSET;
796 ca->ident = 0;
797 }
798 }
799
800 int would_convert_to_git_filter_fd(const char *path)
801 {
802 struct conv_attrs ca;
803
804 convert_attrs(&ca, path);
805 if (!ca.drv)
806 return 0;
807
808 /*
809 * Apply a filter to an fd only if the filter is required to succeed.
810 * We must die if the filter fails, because the original data before
811 * filtering is not available.
812 */
813 if (!ca.drv->required)
814 return 0;
815
816 return apply_filter(path, NULL, 0, -1, NULL, ca.drv->clean);
817 }
818
819 const char *get_convert_attr_ascii(const char *path)
820 {
821 struct conv_attrs ca;
822 enum crlf_action crlf_action;
823
824 convert_attrs(&ca, path);
825 crlf_action = input_crlf_action(ca.crlf_action, ca.eol_attr);
826 switch (crlf_action) {
827 case CRLF_GUESS:
828 return "";
829 case CRLF_BINARY:
830 return "-text";
831 case CRLF_TEXT:
832 return "text";
833 case CRLF_INPUT:
834 return "text eol=lf";
835 case CRLF_CRLF:
836 return "text=auto eol=crlf";
837 case CRLF_AUTO:
838 return "text=auto";
839 }
840 return "";
841 }
842
843 int convert_to_git(const char *path, const char *src, size_t len,
844 struct strbuf *dst, enum safe_crlf checksafe)
845 {
846 int ret = 0;
847 const char *filter = NULL;
848 int required = 0;
849 struct conv_attrs ca;
850
851 convert_attrs(&ca, path);
852 if (ca.drv) {
853 filter = ca.drv->clean;
854 required = ca.drv->required;
855 }
856
857 ret |= apply_filter(path, src, len, -1, dst, filter);
858 if (!ret && required)
859 die("%s: clean filter '%s' failed", path, ca.drv->name);
860
861 if (ret && dst) {
862 src = dst->buf;
863 len = dst->len;
864 }
865 ca.crlf_action = input_crlf_action(ca.crlf_action, ca.eol_attr);
866 ret |= crlf_to_git(path, src, len, dst, ca.crlf_action, checksafe);
867 if (ret && dst) {
868 src = dst->buf;
869 len = dst->len;
870 }
871 return ret | ident_to_git(path, src, len, dst, ca.ident);
872 }
873
874 void convert_to_git_filter_fd(const char *path, int fd, struct strbuf *dst,
875 enum safe_crlf checksafe)
876 {
877 struct conv_attrs ca;
878 convert_attrs(&ca, path);
879
880 assert(ca.drv);
881 assert(ca.drv->clean);
882
883 if (!apply_filter(path, NULL, 0, fd, dst, ca.drv->clean))
884 die("%s: clean filter '%s' failed", path, ca.drv->name);
885
886 ca.crlf_action = input_crlf_action(ca.crlf_action, ca.eol_attr);
887 crlf_to_git(path, dst->buf, dst->len, dst, ca.crlf_action, checksafe);
888 ident_to_git(path, dst->buf, dst->len, dst, ca.ident);
889 }
890
891 static int convert_to_working_tree_internal(const char *path, const char *src,
892 size_t len, struct strbuf *dst,
893 int normalizing)
894 {
895 int ret = 0, ret_filter = 0;
896 const char *filter = NULL;
897 int required = 0;
898 struct conv_attrs ca;
899
900 convert_attrs(&ca, path);
901 if (ca.drv) {
902 filter = ca.drv->smudge;
903 required = ca.drv->required;
904 }
905
906 ret |= ident_to_worktree(path, src, len, dst, ca.ident);
907 if (ret) {
908 src = dst->buf;
909 len = dst->len;
910 }
911 /*
912 * CRLF conversion can be skipped if normalizing, unless there
913 * is a smudge filter. The filter might expect CRLFs.
914 */
915 if (filter || !normalizing) {
916 ca.crlf_action = input_crlf_action(ca.crlf_action, ca.eol_attr);
917 ret |= crlf_to_worktree(path, src, len, dst, ca.crlf_action);
918 if (ret) {
919 src = dst->buf;
920 len = dst->len;
921 }
922 }
923
924 ret_filter = apply_filter(path, src, len, -1, dst, filter);
925 if (!ret_filter && required)
926 die("%s: smudge filter %s failed", path, ca.drv->name);
927
928 return ret | ret_filter;
929 }
930
931 int convert_to_working_tree(const char *path, const char *src, size_t len, struct strbuf *dst)
932 {
933 return convert_to_working_tree_internal(path, src, len, dst, 0);
934 }
935
936 int renormalize_buffer(const char *path, const char *src, size_t len, struct strbuf *dst)
937 {
938 int ret = convert_to_working_tree_internal(path, src, len, dst, 1);
939 if (ret) {
940 src = dst->buf;
941 len = dst->len;
942 }
943 return ret | convert_to_git(path, src, len, dst, SAFE_CRLF_FALSE);
944 }
945
946 /*****************************************************************
947 *
948 * Streaming conversion support
949 *
950 *****************************************************************/
951
952 typedef int (*filter_fn)(struct stream_filter *,
953 const char *input, size_t *isize_p,
954 char *output, size_t *osize_p);
955 typedef void (*free_fn)(struct stream_filter *);
956
957 struct stream_filter_vtbl {
958 filter_fn filter;
959 free_fn free;
960 };
961
962 struct stream_filter {
963 struct stream_filter_vtbl *vtbl;
964 };
965
966 static int null_filter_fn(struct stream_filter *filter,
967 const char *input, size_t *isize_p,
968 char *output, size_t *osize_p)
969 {
970 size_t count;
971
972 if (!input)
973 return 0; /* we do not keep any states */
974 count = *isize_p;
975 if (*osize_p < count)
976 count = *osize_p;
977 if (count) {
978 memmove(output, input, count);
979 *isize_p -= count;
980 *osize_p -= count;
981 }
982 return 0;
983 }
984
985 static void null_free_fn(struct stream_filter *filter)
986 {
987 ; /* nothing -- null instances are shared */
988 }
989
990 static struct stream_filter_vtbl null_vtbl = {
991 null_filter_fn,
992 null_free_fn,
993 };
994
995 static struct stream_filter null_filter_singleton = {
996 &null_vtbl,
997 };
998
999 int is_null_stream_filter(struct stream_filter *filter)
1000 {
1001 return filter == &null_filter_singleton;
1002 }
1003
1004
1005 /*
1006 * LF-to-CRLF filter
1007 */
1008
1009 struct lf_to_crlf_filter {
1010 struct stream_filter filter;
1011 unsigned has_held:1;
1012 char held;
1013 };
1014
1015 static int lf_to_crlf_filter_fn(struct stream_filter *filter,
1016 const char *input, size_t *isize_p,
1017 char *output, size_t *osize_p)
1018 {
1019 size_t count, o = 0;
1020 struct lf_to_crlf_filter *lf_to_crlf = (struct lf_to_crlf_filter *)filter;
1021
1022 /*
1023 * We may be holding onto the CR to see if it is followed by a
1024 * LF, in which case we would need to go to the main loop.
1025 * Otherwise, just emit it to the output stream.
1026 */
1027 if (lf_to_crlf->has_held && (lf_to_crlf->held != '\r' || !input)) {
1028 output[o++] = lf_to_crlf->held;
1029 lf_to_crlf->has_held = 0;
1030 }
1031
1032 /* We are told to drain */
1033 if (!input) {
1034 *osize_p -= o;
1035 return 0;
1036 }
1037
1038 count = *isize_p;
1039 if (count || lf_to_crlf->has_held) {
1040 size_t i;
1041 int was_cr = 0;
1042
1043 if (lf_to_crlf->has_held) {
1044 was_cr = 1;
1045 lf_to_crlf->has_held = 0;
1046 }
1047
1048 for (i = 0; o < *osize_p && i < count; i++) {
1049 char ch = input[i];
1050
1051 if (ch == '\n') {
1052 output[o++] = '\r';
1053 } else if (was_cr) {
1054 /*
1055 * Previous round saw CR and it is not followed
1056 * by a LF; emit the CR before processing the
1057 * current character.
1058 */
1059 output[o++] = '\r';
1060 }
1061
1062 /*
1063 * We may have consumed the last output slot,
1064 * in which case we need to break out of this
1065 * loop; hold the current character before
1066 * returning.
1067 */
1068 if (*osize_p <= o) {
1069 lf_to_crlf->has_held = 1;
1070 lf_to_crlf->held = ch;
1071 continue; /* break but increment i */
1072 }
1073
1074 if (ch == '\r') {
1075 was_cr = 1;
1076 continue;
1077 }
1078
1079 was_cr = 0;
1080 output[o++] = ch;
1081 }
1082
1083 *osize_p -= o;
1084 *isize_p -= i;
1085
1086 if (!lf_to_crlf->has_held && was_cr) {
1087 lf_to_crlf->has_held = 1;
1088 lf_to_crlf->held = '\r';
1089 }
1090 }
1091 return 0;
1092 }
1093
1094 static void lf_to_crlf_free_fn(struct stream_filter *filter)
1095 {
1096 free(filter);
1097 }
1098
1099 static struct stream_filter_vtbl lf_to_crlf_vtbl = {
1100 lf_to_crlf_filter_fn,
1101 lf_to_crlf_free_fn,
1102 };
1103
1104 static struct stream_filter *lf_to_crlf_filter(void)
1105 {
1106 struct lf_to_crlf_filter *lf_to_crlf = xcalloc(1, sizeof(*lf_to_crlf));
1107
1108 lf_to_crlf->filter.vtbl = &lf_to_crlf_vtbl;
1109 return (struct stream_filter *)lf_to_crlf;
1110 }
1111
1112 /*
1113 * Cascade filter
1114 */
1115 #define FILTER_BUFFER 1024
1116 struct cascade_filter {
1117 struct stream_filter filter;
1118 struct stream_filter *one;
1119 struct stream_filter *two;
1120 char buf[FILTER_BUFFER];
1121 int end, ptr;
1122 };
1123
1124 static int cascade_filter_fn(struct stream_filter *filter,
1125 const char *input, size_t *isize_p,
1126 char *output, size_t *osize_p)
1127 {
1128 struct cascade_filter *cas = (struct cascade_filter *) filter;
1129 size_t filled = 0;
1130 size_t sz = *osize_p;
1131 size_t to_feed, remaining;
1132
1133 /*
1134 * input -- (one) --> buf -- (two) --> output
1135 */
1136 while (filled < sz) {
1137 remaining = sz - filled;
1138
1139 /* do we already have something to feed two with? */
1140 if (cas->ptr < cas->end) {
1141 to_feed = cas->end - cas->ptr;
1142 if (stream_filter(cas->two,
1143 cas->buf + cas->ptr, &to_feed,
1144 output + filled, &remaining))
1145 return -1;
1146 cas->ptr += (cas->end - cas->ptr) - to_feed;
1147 filled = sz - remaining;
1148 continue;
1149 }
1150
1151 /* feed one from upstream and have it emit into our buffer */
1152 to_feed = input ? *isize_p : 0;
1153 if (input && !to_feed)
1154 break;
1155 remaining = sizeof(cas->buf);
1156 if (stream_filter(cas->one,
1157 input, &to_feed,
1158 cas->buf, &remaining))
1159 return -1;
1160 cas->end = sizeof(cas->buf) - remaining;
1161 cas->ptr = 0;
1162 if (input) {
1163 size_t fed = *isize_p - to_feed;
1164 *isize_p -= fed;
1165 input += fed;
1166 }
1167
1168 /* do we know that we drained one completely? */
1169 if (input || cas->end)
1170 continue;
1171
1172 /* tell two to drain; we have nothing more to give it */
1173 to_feed = 0;
1174 remaining = sz - filled;
1175 if (stream_filter(cas->two,
1176 NULL, &to_feed,
1177 output + filled, &remaining))
1178 return -1;
1179 if (remaining == (sz - filled))
1180 break; /* completely drained two */
1181 filled = sz - remaining;
1182 }
1183 *osize_p -= filled;
1184 return 0;
1185 }
1186
1187 static void cascade_free_fn(struct stream_filter *filter)
1188 {
1189 struct cascade_filter *cas = (struct cascade_filter *)filter;
1190 free_stream_filter(cas->one);
1191 free_stream_filter(cas->two);
1192 free(filter);
1193 }
1194
1195 static struct stream_filter_vtbl cascade_vtbl = {
1196 cascade_filter_fn,
1197 cascade_free_fn,
1198 };
1199
1200 static struct stream_filter *cascade_filter(struct stream_filter *one,
1201 struct stream_filter *two)
1202 {
1203 struct cascade_filter *cascade;
1204
1205 if (!one || is_null_stream_filter(one))
1206 return two;
1207 if (!two || is_null_stream_filter(two))
1208 return one;
1209
1210 cascade = xmalloc(sizeof(*cascade));
1211 cascade->one = one;
1212 cascade->two = two;
1213 cascade->end = cascade->ptr = 0;
1214 cascade->filter.vtbl = &cascade_vtbl;
1215 return (struct stream_filter *)cascade;
1216 }
1217
1218 /*
1219 * ident filter
1220 */
1221 #define IDENT_DRAINING (-1)
1222 #define IDENT_SKIPPING (-2)
1223 struct ident_filter {
1224 struct stream_filter filter;
1225 struct strbuf left;
1226 int state;
1227 char ident[45]; /* ": x40 $" */
1228 };
1229
1230 static int is_foreign_ident(const char *str)
1231 {
1232 int i;
1233
1234 if (!skip_prefix(str, "$Id: ", &str))
1235 return 0;
1236 for (i = 0; str[i]; i++) {
1237 if (isspace(str[i]) && str[i+1] != '$')
1238 return 1;
1239 }
1240 return 0;
1241 }
1242
1243 static void ident_drain(struct ident_filter *ident, char **output_p, size_t *osize_p)
1244 {
1245 size_t to_drain = ident->left.len;
1246
1247 if (*osize_p < to_drain)
1248 to_drain = *osize_p;
1249 if (to_drain) {
1250 memcpy(*output_p, ident->left.buf, to_drain);
1251 strbuf_remove(&ident->left, 0, to_drain);
1252 *output_p += to_drain;
1253 *osize_p -= to_drain;
1254 }
1255 if (!ident->left.len)
1256 ident->state = 0;
1257 }
1258
1259 static int ident_filter_fn(struct stream_filter *filter,
1260 const char *input, size_t *isize_p,
1261 char *output, size_t *osize_p)
1262 {
1263 struct ident_filter *ident = (struct ident_filter *)filter;
1264 static const char head[] = "$Id";
1265
1266 if (!input) {
1267 /* drain upon eof */
1268 switch (ident->state) {
1269 default:
1270 strbuf_add(&ident->left, head, ident->state);
1271 case IDENT_SKIPPING:
1272 /* fallthru */
1273 case IDENT_DRAINING:
1274 ident_drain(ident, &output, osize_p);
1275 }
1276 return 0;
1277 }
1278
1279 while (*isize_p || (ident->state == IDENT_DRAINING)) {
1280 int ch;
1281
1282 if (ident->state == IDENT_DRAINING) {
1283 ident_drain(ident, &output, osize_p);
1284 if (!*osize_p)
1285 break;
1286 continue;
1287 }
1288
1289 ch = *(input++);
1290 (*isize_p)--;
1291
1292 if (ident->state == IDENT_SKIPPING) {
1293 /*
1294 * Skipping until '$' or LF, but keeping them
1295 * in case it is a foreign ident.
1296 */
1297 strbuf_addch(&ident->left, ch);
1298 if (ch != '\n' && ch != '$')
1299 continue;
1300 if (ch == '$' && !is_foreign_ident(ident->left.buf)) {
1301 strbuf_setlen(&ident->left, sizeof(head) - 1);
1302 strbuf_addstr(&ident->left, ident->ident);
1303 }
1304 ident->state = IDENT_DRAINING;
1305 continue;
1306 }
1307
1308 if (ident->state < sizeof(head) &&
1309 head[ident->state] == ch) {
1310 ident->state++;
1311 continue;
1312 }
1313
1314 if (ident->state)
1315 strbuf_add(&ident->left, head, ident->state);
1316 if (ident->state == sizeof(head) - 1) {
1317 if (ch != ':' && ch != '$') {
1318 strbuf_addch(&ident->left, ch);
1319 ident->state = 0;
1320 continue;
1321 }
1322
1323 if (ch == ':') {
1324 strbuf_addch(&ident->left, ch);
1325 ident->state = IDENT_SKIPPING;
1326 } else {
1327 strbuf_addstr(&ident->left, ident->ident);
1328 ident->state = IDENT_DRAINING;
1329 }
1330 continue;
1331 }
1332
1333 strbuf_addch(&ident->left, ch);
1334 ident->state = IDENT_DRAINING;
1335 }
1336 return 0;
1337 }
1338
1339 static void ident_free_fn(struct stream_filter *filter)
1340 {
1341 struct ident_filter *ident = (struct ident_filter *)filter;
1342 strbuf_release(&ident->left);
1343 free(filter);
1344 }
1345
1346 static struct stream_filter_vtbl ident_vtbl = {
1347 ident_filter_fn,
1348 ident_free_fn,
1349 };
1350
1351 static struct stream_filter *ident_filter(const unsigned char *sha1)
1352 {
1353 struct ident_filter *ident = xmalloc(sizeof(*ident));
1354
1355 xsnprintf(ident->ident, sizeof(ident->ident),
1356 ": %s $", sha1_to_hex(sha1));
1357 strbuf_init(&ident->left, 0);
1358 ident->filter.vtbl = &ident_vtbl;
1359 ident->state = 0;
1360 return (struct stream_filter *)ident;
1361 }
1362
1363 /*
1364 * Return an appropriately constructed filter for the path, or NULL if
1365 * the contents cannot be filtered without reading the whole thing
1366 * in-core.
1367 *
1368 * Note that you would be crazy to set CRLF, smuge/clean or ident to a
1369 * large binary blob you would want us not to slurp into the memory!
1370 */
1371 struct stream_filter *get_stream_filter(const char *path, const unsigned char *sha1)
1372 {
1373 struct conv_attrs ca;
1374 enum crlf_action crlf_action;
1375 struct stream_filter *filter = NULL;
1376
1377 convert_attrs(&ca, path);
1378
1379 if (ca.drv && (ca.drv->smudge || ca.drv->clean))
1380 return filter;
1381
1382 if (ca.ident)
1383 filter = ident_filter(sha1);
1384
1385 crlf_action = input_crlf_action(ca.crlf_action, ca.eol_attr);
1386
1387 if ((crlf_action == CRLF_BINARY) || (crlf_action == CRLF_INPUT) ||
1388 (crlf_action == CRLF_GUESS && auto_crlf == AUTO_CRLF_FALSE))
1389 filter = cascade_filter(filter, &null_filter_singleton);
1390
1391 else if (output_eol(crlf_action) == EOL_CRLF &&
1392 !(crlf_action == CRLF_AUTO || crlf_action == CRLF_GUESS))
1393 filter = cascade_filter(filter, lf_to_crlf_filter());
1394
1395 return filter;
1396 }
1397
1398 void free_stream_filter(struct stream_filter *filter)
1399 {
1400 filter->vtbl->free(filter);
1401 }
1402
1403 int stream_filter(struct stream_filter *filter,
1404 const char *input, size_t *isize_p,
1405 char *output, size_t *osize_p)
1406 {
1407 return filter->vtbl->filter(filter, input, isize_p, output, osize_p);
1408 }
The Best VCS Around