3 #include "run-command.h"
6 * convert.c - convert a file when checking it out and checking it in.
8 * This should use the pathname to decide on whether it wants to do some
9 * more interesting conversions (automatic gzip/unzip, general format
10 * conversions etc etc), but by default it just does automatic CRLF<->LF
11 * translation when the "auto_crlf" option is set.
14 #define CRLF_GUESS (-1)
20 /* CR, LF and CRLF counts */
21 unsigned cr, lf, crlf;
23 /* These are just approximations! */
24 unsigned printable, nonprintable;
27 static void gather_stats(const char *buf, unsigned long size, struct text_stat *stats)
31 memset(stats, 0, sizeof(*stats));
33 for (i = 0; i < size; i++) {
34 unsigned char c = buf[i];
37 if (i+1 < size && buf[i+1] == '\n')
47 stats->nonprintable++;
50 /* BS, HT, ESC and FF */
51 case '\b': case '\t': case '\033': case '\014':
55 stats->nonprintable++;
64 * The same heuristics as diff.c::mmfile_is_binary()
66 static int is_binary(unsigned long size, struct text_stat *stats)
69 if ((stats->printable >> 7) < stats->nonprintable)
72 * Other heuristics? Average line length might be relevant,
73 * as might LF vs CR vs CRLF counts..
75 * NOTE! It might be normal to have a low ratio of CRLF to LF
76 * (somebody starts with a LF-only file and edits it with an editor
77 * that adds CRLF only to lines that are added..). But do we
78 * want to support CR-only? Probably not.
83 static int crlf_to_git(const char *path, const char *src, size_t len,
84 struct strbuf *buf, int action)
86 struct text_stat stats;
89 if ((action == CRLF_BINARY) || !auto_crlf || !len)
92 gather_stats(src, len, &stats);
93 /* No CR? Nothing to convert, regardless. */
97 if (action == CRLF_GUESS) {
99 * We're currently not going to even try to convert stuff
100 * that has bare CR characters. Does anybody do that crazy
103 if (stats.cr != stats.crlf)
107 * And add some heuristics for binary vs text, of course...
109 if (is_binary(len, &stats))
113 strbuf_grow(buf, len);
115 if (action == CRLF_GUESS) {
117 * If we guessed, we already know we rejected a file with
118 * lone CR, and we can strip a CR without looking at what
122 unsigned char c = *src++;
128 unsigned char c = *src++;
129 if (! (c == '\r' && (1 < len && *src == '\n')))
133 strbuf_setlen(buf, dst - buf->buf);
137 static int crlf_to_worktree(const char *path, const char *src, size_t len,
138 struct strbuf *buf, int action)
140 char *to_free = NULL;
141 struct text_stat stats;
143 if ((action == CRLF_BINARY) || (action == CRLF_INPUT) ||
150 gather_stats(src, len, &stats);
152 /* No LF? Nothing to convert, regardless. */
156 /* Was it already in CRLF format? */
157 if (stats.lf == stats.crlf)
160 if (action == CRLF_GUESS) {
161 /* If we have any bare CR characters, we're not going to touch it */
162 if (stats.cr != stats.crlf)
165 if (is_binary(len, &stats))
169 /* are we "faking" in place editing ? */
171 to_free = strbuf_detach(buf);
173 strbuf_grow(buf, len + stats.lf - stats.crlf);
175 const char *nl = memchr(src, '\n', len);
178 if (nl > src && nl[-1] == '\r') {
179 strbuf_add(buf, src, nl + 1 - src);
181 strbuf_add(buf, src, nl - src);
182 strbuf_addstr(buf, "\r\n");
187 strbuf_add(buf, src, len);
193 static int filter_buffer(const char *path, const char *src,
194 unsigned long size, const char *cmd)
197 * Spawn cmd and feed the buffer contents through its stdin.
199 struct child_process child_process;
201 int write_err, status;
203 memset(&child_process, 0, sizeof(child_process));
205 if (pipe(pipe_feed) < 0) {
206 error("cannot create pipe to run external filter %s", cmd);
210 child_process.pid = fork();
211 if (child_process.pid < 0) {
212 error("cannot fork to run external filter %s", cmd);
217 if (!child_process.pid) {
218 dup2(pipe_feed[0], 0);
221 execlp("sh", "sh", "-c", cmd, NULL);
226 write_err = (write_in_full(pipe_feed[1], src, size) < 0);
227 if (close(pipe_feed[1]))
230 error("cannot feed the input to external filter %s", cmd);
232 status = finish_command(&child_process);
234 error("external filter %s failed %d", cmd, -status);
235 return (write_err || status);
238 static int apply_filter(const char *path, const char *src, size_t len,
239 struct strbuf *dst, const char *cmd)
242 * Create a pipeline to have the command filter the buffer's
245 * (child --> cmd) --> us
249 struct child_process child_process;
255 memset(&child_process, 0, sizeof(child_process));
257 if (pipe(pipe_feed) < 0) {
258 error("cannot create pipe to run external filter %s", cmd);
263 child_process.pid = fork();
264 if (child_process.pid < 0) {
265 error("cannot fork to run external filter %s", cmd);
270 if (!child_process.pid) {
271 dup2(pipe_feed[1], 1);
274 exit(filter_buffer(path, src, len, cmd));
278 strbuf_init(&nbuf, 0);
279 if (strbuf_read(&nbuf, pipe_feed[0], len) < 0) {
280 error("read from external filter %s failed", cmd);
283 if (close(pipe_feed[0])) {
284 ret = error("read from external filter %s failed", cmd);
287 status = finish_command(&child_process);
289 ret = error("external filter %s failed %d", cmd, -status);
296 strbuf_release(&nbuf);
301 static struct convert_driver {
303 struct convert_driver *next;
306 } *user_convert, **user_convert_tail;
308 static int read_convert_config(const char *var, const char *value)
310 const char *ep, *name;
312 struct convert_driver *drv;
315 * External conversion drivers are configured using
316 * "filter.<name>.variable".
318 if (prefixcmp(var, "filter.") || (ep = strrchr(var, '.')) == var + 6)
322 for (drv = user_convert; drv; drv = drv->next)
323 if (!strncmp(drv->name, name, namelen) && !drv->name[namelen])
327 drv = xcalloc(1, sizeof(struct convert_driver));
328 namebuf = xmalloc(namelen + 1);
329 memcpy(namebuf, name, namelen);
330 namebuf[namelen] = 0;
333 *user_convert_tail = drv;
334 user_convert_tail = &(drv->next);
340 * filter.<name>.smudge and filter.<name>.clean specifies
345 * The command-line will not be interpolated in any way.
348 if (!strcmp("smudge", ep)) {
350 return error("%s: lacks value", var);
351 drv->smudge = strdup(value);
355 if (!strcmp("clean", ep)) {
357 return error("%s: lacks value", var);
358 drv->clean = strdup(value);
364 static void setup_convert_check(struct git_attr_check *check)
366 static struct git_attr *attr_crlf;
367 static struct git_attr *attr_ident;
368 static struct git_attr *attr_filter;
371 attr_crlf = git_attr("crlf", 4);
372 attr_ident = git_attr("ident", 5);
373 attr_filter = git_attr("filter", 6);
374 user_convert_tail = &user_convert;
375 git_config(read_convert_config);
377 check[0].attr = attr_crlf;
378 check[1].attr = attr_ident;
379 check[2].attr = attr_filter;
382 static int count_ident(const char *cp, unsigned long size)
385 * "$Id: 0000000000000000000000000000000000000000 $" <=> "$Id$"
397 if (memcmp("Id", cp, 2))
408 * "$Id: ... "; scan up to the closing dollar sign and discard.
422 static int ident_to_git(const char *path, const char *src, size_t len,
423 struct strbuf *buf, int ident)
427 if (!ident || !count_ident(src, len))
430 strbuf_grow(buf, len);
433 dollar = memchr(src, '$', len);
436 memcpy(dst, src, dollar + 1 - src);
437 dst += dollar + 1 - src;
438 len -= dollar + 1 - src;
441 if (len > 3 && !memcmp(src, "Id:", 3)) {
442 dollar = memchr(src + 3, '$', len - 3);
445 memcpy(dst, "Id$", 3);
447 len -= dollar + 1 - src;
451 memcpy(dst, src, len);
452 strbuf_setlen(buf, dst + len - buf->buf);
456 static int ident_to_worktree(const char *path, const char *src, size_t len,
457 struct strbuf *buf, int ident)
459 unsigned char sha1[20];
460 char *to_free = NULL, *dollar;
466 cnt = count_ident(src, len);
470 /* are we "faking" in place editing ? */
472 to_free = strbuf_detach(buf);
473 hash_sha1_file(src, len, "blob", sha1);
475 strbuf_grow(buf, len + cnt * 43);
477 /* step 1: run to the next '$' */
478 dollar = memchr(src, '$', len);
481 strbuf_add(buf, src, dollar + 1 - src);
482 len -= dollar + 1 - src;
485 /* step 2: does it looks like a bit like Id:xxx$ or Id$ ? */
486 if (len < 3 || memcmp("Id", src, 2))
489 /* step 3: skip over Id$ or Id:xxxxx$ */
493 } else if (src[2] == ':') {
495 * It's possible that an expanded Id has crept its way into the
496 * repository, we cope with that by stripping the expansion out
498 dollar = memchr(src + 3, '$', len - 3);
500 /* incomplete keyword, no more '$', so just quit the loop */
504 len -= dollar + 1 - src;
507 /* it wasn't a "Id$" or "Id:xxxx$" */
511 /* step 4: substitute */
512 strbuf_addstr(buf, "Id: ");
513 strbuf_add(buf, sha1_to_hex(sha1), 40);
514 strbuf_addstr(buf, " $");
516 strbuf_add(buf, src, len);
522 static int git_path_check_crlf(const char *path, struct git_attr_check *check)
524 const char *value = check->value;
526 if (ATTR_TRUE(value))
528 else if (ATTR_FALSE(value))
530 else if (ATTR_UNSET(value))
532 else if (!strcmp(value, "input"))
537 static struct convert_driver *git_path_check_convert(const char *path,
538 struct git_attr_check *check)
540 const char *value = check->value;
541 struct convert_driver *drv;
543 if (ATTR_TRUE(value) || ATTR_FALSE(value) || ATTR_UNSET(value))
545 for (drv = user_convert; drv; drv = drv->next)
546 if (!strcmp(value, drv->name))
551 static int git_path_check_ident(const char *path, struct git_attr_check *check)
553 const char *value = check->value;
555 return !!ATTR_TRUE(value);
558 int convert_to_git(const char *path, const char *src, size_t len, struct strbuf *dst)
560 struct git_attr_check check[3];
561 int crlf = CRLF_GUESS;
562 int ident = 0, ret = 0;
565 setup_convert_check(check);
566 if (!git_checkattr(path, ARRAY_SIZE(check), check)) {
567 struct convert_driver *drv;
568 crlf = git_path_check_crlf(path, check + 0);
569 ident = git_path_check_ident(path, check + 1);
570 drv = git_path_check_convert(path, check + 2);
571 if (drv && drv->clean)
575 ret |= apply_filter(path, src, len, dst, filter);
580 ret |= crlf_to_git(path, src, len, dst, crlf);
585 return ret | ident_to_git(path, src, len, dst, ident);
588 int convert_to_working_tree(const char *path, const char *src, size_t len, struct strbuf *dst)
590 struct git_attr_check check[3];
591 int crlf = CRLF_GUESS;
592 int ident = 0, ret = 0;
595 setup_convert_check(check);
596 if (!git_checkattr(path, ARRAY_SIZE(check), check)) {
597 struct convert_driver *drv;
598 crlf = git_path_check_crlf(path, check + 0);
599 ident = git_path_check_ident(path, check + 1);
600 drv = git_path_check_convert(path, check + 2);
601 if (drv && drv->smudge)
602 filter = drv->smudge;
605 ret |= ident_to_worktree(path, src, len, dst, ident);
610 ret |= crlf_to_worktree(path, src, len, dst, crlf);
615 return ret | apply_filter(path, src, len, dst, filter);