for-each-ref, quote: convert *_quote_print -> *_quote_buf
[git] / quote.c
1 #include "cache.h"
2 #include "quote.h"
3 #include "argv-array.h"
4
5 int quote_path_fully = 1;
6
7 /* Help to copy the thing properly quoted for the shell safety.
8  * any single quote is replaced with '\'', any exclamation point
9  * is replaced with '\!', and the whole thing is enclosed in a
10  *
11  * E.g.
12  *  original     sq_quote     result
13  *  name     ==> name      ==> 'name'
14  *  a b      ==> a b       ==> 'a b'
15  *  a'b      ==> a'\''b    ==> 'a'\''b'
16  *  a!b      ==> a'\!'b    ==> 'a'\!'b'
17  */
18 static inline int need_bs_quote(char c)
19 {
20         return (c == '\'' || c == '!');
21 }
22
23 void sq_quote_buf(struct strbuf *dst, const char *src)
24 {
25         char *to_free = NULL;
26
27         if (dst->buf == src)
28                 to_free = strbuf_detach(dst, NULL);
29
30         strbuf_addch(dst, '\'');
31         while (*src) {
32                 size_t len = strcspn(src, "'!");
33                 strbuf_add(dst, src, len);
34                 src += len;
35                 while (need_bs_quote(*src)) {
36                         strbuf_addstr(dst, "'\\");
37                         strbuf_addch(dst, *src++);
38                         strbuf_addch(dst, '\'');
39                 }
40         }
41         strbuf_addch(dst, '\'');
42         free(to_free);
43 }
44
45 void sq_quote_print(FILE *stream, const char *src)
46 {
47         char c;
48
49         fputc('\'', stream);
50         while ((c = *src++)) {
51                 if (need_bs_quote(c)) {
52                         fputs("'\\", stream);
53                         fputc(c, stream);
54                         fputc('\'', stream);
55                 } else {
56                         fputc(c, stream);
57                 }
58         }
59         fputc('\'', stream);
60 }
61
62 void sq_quote_argv(struct strbuf *dst, const char** argv, size_t maxlen)
63 {
64         int i;
65
66         /* Copy into destination buffer. */
67         strbuf_grow(dst, 255);
68         for (i = 0; argv[i]; ++i) {
69                 strbuf_addch(dst, ' ');
70                 sq_quote_buf(dst, argv[i]);
71                 if (maxlen && dst->len > maxlen)
72                         die("Too many or long arguments");
73         }
74 }
75
76 static char *sq_dequote_step(char *arg, char **next)
77 {
78         char *dst = arg;
79         char *src = arg;
80         char c;
81
82         if (*src != '\'')
83                 return NULL;
84         for (;;) {
85                 c = *++src;
86                 if (!c)
87                         return NULL;
88                 if (c != '\'') {
89                         *dst++ = c;
90                         continue;
91                 }
92                 /* We stepped out of sq */
93                 switch (*++src) {
94                 case '\0':
95                         *dst = 0;
96                         if (next)
97                                 *next = NULL;
98                         return arg;
99                 case '\\':
100                         c = *++src;
101                         if (need_bs_quote(c) && *++src == '\'') {
102                                 *dst++ = c;
103                                 continue;
104                         }
105                 /* Fallthrough */
106                 default:
107                         if (!next || !isspace(*src))
108                                 return NULL;
109                         do {
110                                 c = *++src;
111                         } while (isspace(c));
112                         *dst = 0;
113                         *next = src;
114                         return arg;
115                 }
116         }
117 }
118
119 char *sq_dequote(char *arg)
120 {
121         return sq_dequote_step(arg, NULL);
122 }
123
124 static int sq_dequote_to_argv_internal(char *arg,
125                                        const char ***argv, int *nr, int *alloc,
126                                        struct argv_array *array)
127 {
128         char *next = arg;
129
130         if (!*arg)
131                 return 0;
132         do {
133                 char *dequoted = sq_dequote_step(next, &next);
134                 if (!dequoted)
135                         return -1;
136                 if (argv) {
137                         ALLOC_GROW(*argv, *nr + 1, *alloc);
138                         (*argv)[(*nr)++] = dequoted;
139                 }
140                 if (array)
141                         argv_array_push(array, dequoted);
142         } while (next);
143
144         return 0;
145 }
146
147 int sq_dequote_to_argv(char *arg, const char ***argv, int *nr, int *alloc)
148 {
149         return sq_dequote_to_argv_internal(arg, argv, nr, alloc, NULL);
150 }
151
152 int sq_dequote_to_argv_array(char *arg, struct argv_array *array)
153 {
154         return sq_dequote_to_argv_internal(arg, NULL, NULL, NULL, array);
155 }
156
157 /* 1 means: quote as octal
158  * 0 means: quote as octal if (quote_path_fully)
159  * -1 means: never quote
160  * c: quote as "\\c"
161  */
162 #define X8(x)   x, x, x, x, x, x, x, x
163 #define X16(x)  X8(x), X8(x)
164 static signed char const sq_lookup[256] = {
165         /*           0    1    2    3    4    5    6    7 */
166         /* 0x00 */   1,   1,   1,   1,   1,   1,   1, 'a',
167         /* 0x08 */ 'b', 't', 'n', 'v', 'f', 'r',   1,   1,
168         /* 0x10 */ X16(1),
169         /* 0x20 */  -1,  -1, '"',  -1,  -1,  -1,  -1,  -1,
170         /* 0x28 */ X16(-1), X16(-1), X16(-1),
171         /* 0x58 */  -1,  -1,  -1,  -1,'\\',  -1,  -1,  -1,
172         /* 0x60 */ X16(-1), X8(-1),
173         /* 0x78 */  -1,  -1,  -1,  -1,  -1,  -1,  -1,   1,
174         /* 0x80 */ /* set to 0 */
175 };
176
177 static inline int sq_must_quote(char c)
178 {
179         return sq_lookup[(unsigned char)c] + quote_path_fully > 0;
180 }
181
182 /* returns the longest prefix not needing a quote up to maxlen if positive.
183    This stops at the first \0 because it's marked as a character needing an
184    escape */
185 static size_t next_quote_pos(const char *s, ssize_t maxlen)
186 {
187         size_t len;
188         if (maxlen < 0) {
189                 for (len = 0; !sq_must_quote(s[len]); len++);
190         } else {
191                 for (len = 0; len < maxlen && !sq_must_quote(s[len]); len++);
192         }
193         return len;
194 }
195
196 /*
197  * C-style name quoting.
198  *
199  * (1) if sb and fp are both NULL, inspect the input name and counts the
200  *     number of bytes that are needed to hold c_style quoted version of name,
201  *     counting the double quotes around it but not terminating NUL, and
202  *     returns it.
203  *     However, if name does not need c_style quoting, it returns 0.
204  *
205  * (2) if sb or fp are not NULL, it emits the c_style quoted version
206  *     of name, enclosed with double quotes if asked and needed only.
207  *     Return value is the same as in (1).
208  */
209 static size_t quote_c_style_counted(const char *name, ssize_t maxlen,
210                                     struct strbuf *sb, FILE *fp, int no_dq)
211 {
212 #undef EMIT
213 #define EMIT(c)                                 \
214         do {                                        \
215                 if (sb) strbuf_addch(sb, (c));          \
216                 if (fp) fputc((c), fp);                 \
217                 count++;                                \
218         } while (0)
219 #define EMITBUF(s, l)                           \
220         do {                                        \
221                 if (sb) strbuf_add(sb, (s), (l));       \
222                 if (fp) fwrite((s), (l), 1, fp);        \
223                 count += (l);                           \
224         } while (0)
225
226         size_t len, count = 0;
227         const char *p = name;
228
229         for (;;) {
230                 int ch;
231
232                 len = next_quote_pos(p, maxlen);
233                 if (len == maxlen || (maxlen < 0 && !p[len]))
234                         break;
235
236                 if (!no_dq && p == name)
237                         EMIT('"');
238
239                 EMITBUF(p, len);
240                 EMIT('\\');
241                 p += len;
242                 ch = (unsigned char)*p++;
243                 if (maxlen >= 0)
244                         maxlen -= len + 1;
245                 if (sq_lookup[ch] >= ' ') {
246                         EMIT(sq_lookup[ch]);
247                 } else {
248                         EMIT(((ch >> 6) & 03) + '0');
249                         EMIT(((ch >> 3) & 07) + '0');
250                         EMIT(((ch >> 0) & 07) + '0');
251                 }
252         }
253
254         EMITBUF(p, len);
255         if (p == name)   /* no ending quote needed */
256                 return 0;
257
258         if (!no_dq)
259                 EMIT('"');
260         return count;
261 }
262
263 size_t quote_c_style(const char *name, struct strbuf *sb, FILE *fp, int nodq)
264 {
265         return quote_c_style_counted(name, -1, sb, fp, nodq);
266 }
267
268 void quote_two_c_style(struct strbuf *sb, const char *prefix, const char *path, int nodq)
269 {
270         if (quote_c_style(prefix, NULL, NULL, 0) ||
271             quote_c_style(path, NULL, NULL, 0)) {
272                 if (!nodq)
273                         strbuf_addch(sb, '"');
274                 quote_c_style(prefix, sb, NULL, 1);
275                 quote_c_style(path, sb, NULL, 1);
276                 if (!nodq)
277                         strbuf_addch(sb, '"');
278         } else {
279                 strbuf_addstr(sb, prefix);
280                 strbuf_addstr(sb, path);
281         }
282 }
283
284 void write_name_quoted(const char *name, FILE *fp, int terminator)
285 {
286         if (terminator) {
287                 quote_c_style(name, NULL, fp, 0);
288         } else {
289                 fputs(name, fp);
290         }
291         fputc(terminator, fp);
292 }
293
294 void write_name_quotedpfx(const char *pfx, size_t pfxlen,
295                           const char *name, FILE *fp, int terminator)
296 {
297         int needquote = 0;
298
299         if (terminator) {
300                 needquote = next_quote_pos(pfx, pfxlen) < pfxlen
301                         || name[next_quote_pos(name, -1)];
302         }
303         if (needquote) {
304                 fputc('"', fp);
305                 quote_c_style_counted(pfx, pfxlen, NULL, fp, 1);
306                 quote_c_style(name, NULL, fp, 1);
307                 fputc('"', fp);
308         } else {
309                 fwrite(pfx, pfxlen, 1, fp);
310                 fputs(name, fp);
311         }
312         fputc(terminator, fp);
313 }
314
315 void write_name_quoted_relative(const char *name, const char *prefix,
316                                 FILE *fp, int terminator)
317 {
318         struct strbuf sb = STRBUF_INIT;
319
320         name = relative_path(name, prefix, &sb);
321         write_name_quoted(name, fp, terminator);
322
323         strbuf_release(&sb);
324 }
325
326 /* quote path as relative to the given prefix */
327 char *quote_path_relative(const char *in, const char *prefix,
328                           struct strbuf *out)
329 {
330         struct strbuf sb = STRBUF_INIT;
331         const char *rel = relative_path(in, prefix, &sb);
332         strbuf_reset(out);
333         quote_c_style_counted(rel, strlen(rel), out, NULL, 0);
334         strbuf_release(&sb);
335
336         return out->buf;
337 }
338
339 /*
340  * C-style name unquoting.
341  *
342  * Quoted should point at the opening double quote.
343  * + Returns 0 if it was able to unquote the string properly, and appends the
344  *   result in the strbuf `sb'.
345  * + Returns -1 in case of error, and doesn't touch the strbuf. Though note
346  *   that this function will allocate memory in the strbuf, so calling
347  *   strbuf_release is mandatory whichever result unquote_c_style returns.
348  *
349  * Updates endp pointer to point at one past the ending double quote if given.
350  */
351 int unquote_c_style(struct strbuf *sb, const char *quoted, const char **endp)
352 {
353         size_t oldlen = sb->len, len;
354         int ch, ac;
355
356         if (*quoted++ != '"')
357                 return -1;
358
359         for (;;) {
360                 len = strcspn(quoted, "\"\\");
361                 strbuf_add(sb, quoted, len);
362                 quoted += len;
363
364                 switch (*quoted++) {
365                   case '"':
366                         if (endp)
367                                 *endp = quoted;
368                         return 0;
369                   case '\\':
370                         break;
371                   default:
372                         goto error;
373                 }
374
375                 switch ((ch = *quoted++)) {
376                 case 'a': ch = '\a'; break;
377                 case 'b': ch = '\b'; break;
378                 case 'f': ch = '\f'; break;
379                 case 'n': ch = '\n'; break;
380                 case 'r': ch = '\r'; break;
381                 case 't': ch = '\t'; break;
382                 case 'v': ch = '\v'; break;
383
384                 case '\\': case '"':
385                         break; /* verbatim */
386
387                 /* octal values with first digit over 4 overflow */
388                 case '0': case '1': case '2': case '3':
389                                         ac = ((ch - '0') << 6);
390                         if ((ch = *quoted++) < '0' || '7' < ch)
391                                 goto error;
392                                         ac |= ((ch - '0') << 3);
393                         if ((ch = *quoted++) < '0' || '7' < ch)
394                                 goto error;
395                                         ac |= (ch - '0');
396                                         ch = ac;
397                                         break;
398                                 default:
399                         goto error;
400                         }
401                 strbuf_addch(sb, ch);
402                 }
403
404   error:
405         strbuf_setlen(sb, oldlen);
406         return -1;
407 }
408
409 /* quoting as a string literal for other languages */
410
411 void perl_quote_buf(struct strbuf *sb, const char *src)
412 {
413         const char sq = '\'';
414         const char bq = '\\';
415         char c;
416
417         strbuf_addch(sb, sq);
418         while ((c = *src++)) {
419                 if (c == sq || c == bq)
420                         strbuf_addch(sb, bq);
421                 strbuf_addch(sb, c);
422         }
423         strbuf_addch(sb, sq);
424 }
425
426 void python_quote_buf(struct strbuf *sb, const char *src)
427 {
428         const char sq = '\'';
429         const char bq = '\\';
430         const char nl = '\n';
431         char c;
432
433         strbuf_addch(sb, sq);
434         while ((c = *src++)) {
435                 if (c == nl) {
436                         strbuf_addch(sb, bq);
437                         strbuf_addch(sb, 'n');
438                         continue;
439                 }
440                 if (c == sq || c == bq)
441                         strbuf_addch(sb, bq);
442                 strbuf_addch(sb, c);
443         }
444         strbuf_addch(sb, sq);
445 }
446
447 void tcl_quote_buf(struct strbuf *sb, const char *src)
448 {
449         char c;
450
451         strbuf_addch(sb, '"');
452         while ((c = *src++)) {
453                 switch (c) {
454                 case '[': case ']':
455                 case '{': case '}':
456                 case '$': case '\\': case '"':
457                         strbuf_addch(sb, '\\');
458                 default:
459                         strbuf_addch(sb, c);
460                         break;
461                 case '\f':
462                         strbuf_addstr(sb, "\\f");
463                         break;
464                 case '\r':
465                         strbuf_addstr(sb, "\\r");
466                         break;
467                 case '\n':
468                         strbuf_addstr(sb, "\\n");
469                         break;
470                 case '\t':
471                         strbuf_addstr(sb, "\\t");
472                         break;
473                 case '\v':
474                         strbuf_addstr(sb, "\\v");
475                         break;
476                 }
477         }
478         strbuf_addch(sb, '"');
479 }