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