🌐 AI搜索 & 代理 主页
blob: fe884d24521f91a0f1f30b3cf5f08734bab7bd31 [file] [log] [blame]
Junio C Hamano6fb737b2005-07-08 06:58:321#include "cache.h"
2#include "quote.h"
Jeff King37e81612011-09-13 21:58:083#include "argv-array.h"
Junio C Hamano6fb737b2005-07-08 06:58:324
Dmitry Potapov5b8e6f82008-06-27 20:46:425int quote_path_fully = 1;
6
Christian Couder44cd91e2015-10-07 22:05:507static inline int need_bs_quote(char c)
8{
9 return (c == '\'' || c == '!');
10}
11
Junio C Hamano6fb737b2005-07-08 06:58:3212/* Help to copy the thing properly quoted for the shell safety.
H. Peter Anvin77d604c2005-10-10 21:46:1013 * any single quote is replaced with '\'', any exclamation point
14 * is replaced with '\!', and the whole thing is enclosed in a
Christian Couderca9da0d2015-10-07 22:05:4915 * single quote pair.
Junio C Hamano6fb737b2005-07-08 06:58:3216 *
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'
H. Peter Anvin77d604c2005-10-10 21:46:1022 * a!b ==> a'\!'b ==> 'a'\!'b'
Junio C Hamano6fb737b2005-07-08 06:58:3223 */
Pierre Habouzit7a33bcb2007-09-19 22:42:1324void sq_quote_buf(struct strbuf *dst, const char *src)
Junio C Hamano6fb737b2005-07-08 06:58:3225{
Pierre Habouzit7a33bcb2007-09-19 22:42:1326 char *to_free = NULL;
Junio C Hamano6fb737b2005-07-08 06:58:3227
Pierre Habouzit7a33bcb2007-09-19 22:42:1328 if (dst->buf == src)
Pierre Habouzitb315c5c2007-09-27 10:58:2329 to_free = strbuf_detach(dst, NULL);
Pierre Habouzit7a33bcb2007-09-19 22:42:1330
31 strbuf_addch(dst, '\'');
32 while (*src) {
Johannes Sixtc2015b32007-11-04 20:26:2233 size_t len = strcspn(src, "'!");
Pierre Habouzit7a33bcb2007-09-19 22:42:1334 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, '\'');
Junio C Hamano6fb737b2005-07-08 06:58:3240 }
41 }
Pierre Habouzit7a33bcb2007-09-19 22:42:1342 strbuf_addch(dst, '\'');
43 free(to_free);
H. Peter Anvin77d604c2005-10-10 21:46:1044}
45
Christian Couderb319ce42007-12-03 04:51:5046void sq_quote_argv(struct strbuf *dst, const char** argv, size_t maxlen)
Christian Couder7cf67202006-08-31 06:42:1147{
Christian Couder7cf67202006-08-31 06:42:1148 int i;
Christian Couder7cf67202006-08-31 06:42:1149
Christian Couder7cf67202006-08-31 06:42:1150 /* Copy into destination buffer. */
Christian Couderb319ce42007-12-03 04:51:5051 strbuf_grow(dst, 255);
52 for (i = 0; argv[i]; ++i) {
Pierre Habouzit7a33bcb2007-09-19 22:42:1353 strbuf_addch(dst, ' ');
54 sq_quote_buf(dst, argv[i]);
55 if (maxlen && dst->len > maxlen)
56 die("Too many or long arguments");
Christian Couder7cf67202006-08-31 06:42:1157 }
Christian Couder86257aa2006-09-11 04:59:2258}
59
Junio C Hamano758e9152010-01-12 06:31:0660static char *sq_dequote_step(char *arg, char **next)
Linus Torvalds35eb2d32005-10-23 21:30:4561{
62 char *dst = arg;
63 char *src = arg;
64 char c;
65
66 if (*src != '\'')
67 return NULL;
68 for (;;) {
69 c = *++src;
70 if (!c)
71 return NULL;
72 if (c != '\'') {
73 *dst++ = c;
74 continue;
75 }
76 /* We stepped out of sq */
77 switch (*++src) {
78 case '\0':
79 *dst = 0;
Christian Couderebbc0882009-03-29 09:44:4480 if (next)
81 *next = NULL;
Linus Torvalds35eb2d32005-10-23 21:30:4582 return arg;
83 case '\\':
84 c = *++src;
85 if (need_bs_quote(c) && *++src == '\'') {
86 *dst++ = c;
87 continue;
88 }
89 /* Fallthrough */
90 default:
Christian Couderebbc0882009-03-29 09:44:4491 if (!next || !isspace(*src))
92 return NULL;
93 do {
94 c = *++src;
95 } while (isspace(c));
96 *dst = 0;
97 *next = src;
98 return arg;
Linus Torvalds35eb2d32005-10-23 21:30:4599 }
100 }
101}
102
Christian Couderebbc0882009-03-29 09:44:44103char *sq_dequote(char *arg)
104{
105 return sq_dequote_step(arg, NULL);
106}
107
Jeff King37e81612011-09-13 21:58:08108static int sq_dequote_to_argv_internal(char *arg,
109 const char ***argv, int *nr, int *alloc,
110 struct argv_array *array)
Christian Coudereaa759b2009-03-29 09:44:52111{
112 char *next = arg;
113
114 if (!*arg)
115 return 0;
116 do {
117 char *dequoted = sq_dequote_step(next, &next);
118 if (!dequoted)
119 return -1;
Jeff King37e81612011-09-13 21:58:08120 if (argv) {
121 ALLOC_GROW(*argv, *nr + 1, *alloc);
122 (*argv)[(*nr)++] = dequoted;
123 }
124 if (array)
125 argv_array_push(array, dequoted);
Christian Coudereaa759b2009-03-29 09:44:52126 } while (next);
127
128 return 0;
129}
130
Jeff King37e81612011-09-13 21:58:08131int sq_dequote_to_argv(char *arg, const char ***argv, int *nr, int *alloc)
132{
133 return sq_dequote_to_argv_internal(arg, argv, nr, alloc, NULL);
134}
135
136int sq_dequote_to_argv_array(char *arg, struct argv_array *array)
137{
138 return sq_dequote_to_argv_internal(arg, NULL, NULL, NULL, array);
139}
140
Pierre Habouzit663af342007-09-19 22:42:15141/* 1 means: quote as octal
142 * 0 means: quote as octal if (quote_path_fully)
143 * -1 means: never quote
144 * c: quote as "\\c"
145 */
146#define X8(x) x, x, x, x, x, x, x, x
147#define X16(x) X8(x), X8(x)
148static signed char const sq_lookup[256] = {
149 /* 0 1 2 3 4 5 6 7 */
150 /* 0x00 */ 1, 1, 1, 1, 1, 1, 1, 'a',
151 /* 0x08 */ 'b', 't', 'n', 'v', 'f', 'r', 1, 1,
152 /* 0x10 */ X16(1),
153 /* 0x20 */ -1, -1, '"', -1, -1, -1, -1, -1,
154 /* 0x28 */ X16(-1), X16(-1), X16(-1),
155 /* 0x58 */ -1, -1, -1, -1,'\\', -1, -1, -1,
156 /* 0x60 */ X16(-1), X8(-1),
157 /* 0x78 */ -1, -1, -1, -1, -1, -1, -1, 1,
158 /* 0x80 */ /* set to 0 */
159};
160
Junio C Hamanof3fa1832007-11-08 23:35:32161static inline int sq_must_quote(char c)
162{
Pierre Habouzit663af342007-09-19 22:42:15163 return sq_lookup[(unsigned char)c] + quote_path_fully > 0;
164}
165
166/* returns the longest prefix not needing a quote up to maxlen if positive.
167 This stops at the first \0 because it's marked as a character needing an
168 escape */
169static size_t next_quote_pos(const char *s, ssize_t maxlen)
170{
171 size_t len;
172 if (maxlen < 0) {
173 for (len = 0; !sq_must_quote(s[len]); len++);
174 } else {
175 for (len = 0; len < maxlen && !sq_must_quote(s[len]); len++);
176 }
177 return len;
178}
179
Junio C Hamano4f6fbcd2005-10-15 04:54:47180/*
181 * C-style name quoting.
182 *
Pierre Habouzit663af342007-09-19 22:42:15183 * (1) if sb and fp are both NULL, inspect the input name and counts the
184 * number of bytes that are needed to hold c_style quoted version of name,
185 * counting the double quotes around it but not terminating NUL, and
186 * returns it.
187 * However, if name does not need c_style quoting, it returns 0.
Junio C Hamano4f6fbcd2005-10-15 04:54:47188 *
Pierre Habouzit663af342007-09-19 22:42:15189 * (2) if sb or fp are not NULL, it emits the c_style quoted version
190 * of name, enclosed with double quotes if asked and needed only.
191 * Return value is the same as in (1).
Junio C Hamano4f6fbcd2005-10-15 04:54:47192 */
Pierre Habouzit663af342007-09-19 22:42:15193static size_t quote_c_style_counted(const char *name, ssize_t maxlen,
194 struct strbuf *sb, FILE *fp, int no_dq)
Junio C Hamano4f6fbcd2005-10-15 04:54:47195{
196#undef EMIT
Pierre Habouzit663af342007-09-19 22:42:15197#define EMIT(c) \
198 do { \
199 if (sb) strbuf_addch(sb, (c)); \
200 if (fp) fputc((c), fp); \
201 count++; \
202 } while (0)
203#define EMITBUF(s, l) \
204 do { \
205 if (sb) strbuf_add(sb, (s), (l)); \
206 if (fp) fwrite((s), (l), 1, fp); \
207 count += (l); \
208 } while (0)
Junio C Hamano4f6fbcd2005-10-15 04:54:47209
Pierre Habouzit663af342007-09-19 22:42:15210 size_t len, count = 0;
211 const char *p = name;
Junio C Hamano4f6fbcd2005-10-15 04:54:47212
Pierre Habouzit663af342007-09-19 22:42:15213 for (;;) {
214 int ch;
Junio C Hamano4f6fbcd2005-10-15 04:54:47215
Pierre Habouzit663af342007-09-19 22:42:15216 len = next_quote_pos(p, maxlen);
Jeff King84249812010-02-01 13:39:03217 if (len == maxlen || (maxlen < 0 && !p[len]))
Pavel Roskin50e7b062005-12-21 20:35:48218 break;
Junio C Hamano4f6fbcd2005-10-15 04:54:47219
Pierre Habouzit663af342007-09-19 22:42:15220 if (!no_dq && p == name)
221 EMIT('"');
222
223 EMITBUF(p, len);
224 EMIT('\\');
225 p += len;
226 ch = (unsigned char)*p++;
Jeff King84249812010-02-01 13:39:03227 if (maxlen >= 0)
228 maxlen -= len + 1;
Pierre Habouzit663af342007-09-19 22:42:15229 if (sq_lookup[ch] >= ' ') {
230 EMIT(sq_lookup[ch]);
231 } else {
232 EMIT(((ch >> 6) & 03) + '0');
233 EMIT(((ch >> 3) & 07) + '0');
234 EMIT(((ch >> 0) & 07) + '0');
Junio C Hamano4f6fbcd2005-10-15 04:54:47235 }
Junio C Hamano4f6fbcd2005-10-15 04:54:47236 }
Pierre Habouzit663af342007-09-19 22:42:15237
238 EMITBUF(p, len);
239 if (p == name) /* no ending quote needed */
240 return 0;
241
Junio C Hamano4f6fbcd2005-10-15 04:54:47242 if (!no_dq)
243 EMIT('"');
Pierre Habouzit663af342007-09-19 22:42:15244 return count;
Junio C Hamano4f6fbcd2005-10-15 04:54:47245}
246
Pierre Habouzit663af342007-09-19 22:42:15247size_t quote_c_style(const char *name, struct strbuf *sb, FILE *fp, int nodq)
Junio C Hamano9ef2b3c2005-11-29 06:55:25248{
Pierre Habouzit663af342007-09-19 22:42:15249 return quote_c_style_counted(name, -1, sb, fp, nodq);
250}
251
Junio C Hamanod5625092007-12-27 01:13:36252void quote_two_c_style(struct strbuf *sb, const char *prefix, const char *path, int nodq)
253{
254 if (quote_c_style(prefix, NULL, NULL, 0) ||
255 quote_c_style(path, NULL, NULL, 0)) {
256 if (!nodq)
257 strbuf_addch(sb, '"');
258 quote_c_style(prefix, sb, NULL, 1);
259 quote_c_style(path, sb, NULL, 1);
260 if (!nodq)
261 strbuf_addch(sb, '"');
262 } else {
263 strbuf_addstr(sb, prefix);
264 strbuf_addstr(sb, path);
265 }
266}
267
Pierre Habouzit663af342007-09-19 22:42:15268void write_name_quoted(const char *name, FILE *fp, int terminator)
269{
270 if (terminator) {
271 quote_c_style(name, NULL, fp, 0);
272 } else {
273 fputs(name, fp);
274 }
275 fputc(terminator, fp);
276}
277
Jiang Xine9a820c2013-06-25 15:53:46278void write_name_quoted_relative(const char *name, const char *prefix,
Clemens Buchacherb167cff2010-06-03 13:36:31279 FILE *fp, int terminator)
280{
281 struct strbuf sb = STRBUF_INIT;
282
Jiang Xinad66df22013-06-25 15:53:44283 name = relative_path(name, prefix, &sb);
Clemens Buchacherb167cff2010-06-03 13:36:31284 write_name_quoted(name, fp, terminator);
285
286 strbuf_release(&sb);
287}
288
Dmitry Potapova734d0b2008-03-07 02:30:58289/* quote path as relative to the given prefix */
Jiang Xin39598f92013-06-25 15:53:45290char *quote_path_relative(const char *in, const char *prefix,
291 struct strbuf *out)
Dmitry Potapova734d0b2008-03-07 02:30:58292{
Clemens Buchacherb167cff2010-06-03 13:36:31293 struct strbuf sb = STRBUF_INIT;
Jiang Xinad66df22013-06-25 15:53:44294 const char *rel = relative_path(in, prefix, &sb);
Clemens Buchacherb167cff2010-06-03 13:36:31295 strbuf_reset(out);
296 quote_c_style_counted(rel, strlen(rel), out, NULL, 0);
297 strbuf_release(&sb);
Dmitry Potapova734d0b2008-03-07 02:30:58298
Dmitry Potapova734d0b2008-03-07 02:30:58299 return out->buf;
300}
301
Junio C Hamano4f6fbcd2005-10-15 04:54:47302/*
303 * C-style name unquoting.
304 *
Pierre Habouzit7fb10112007-09-19 22:42:14305 * Quoted should point at the opening double quote.
306 * + Returns 0 if it was able to unquote the string properly, and appends the
307 * result in the strbuf `sb'.
308 * + Returns -1 in case of error, and doesn't touch the strbuf. Though note
309 * that this function will allocate memory in the strbuf, so calling
310 * strbuf_release is mandatory whichever result unquote_c_style returns.
311 *
312 * Updates endp pointer to point at one past the ending double quote if given.
Junio C Hamano4f6fbcd2005-10-15 04:54:47313 */
Pierre Habouzit7fb10112007-09-19 22:42:14314int unquote_c_style(struct strbuf *sb, const char *quoted, const char **endp)
Junio C Hamano4f6fbcd2005-10-15 04:54:47315{
Pierre Habouzit7fb10112007-09-19 22:42:14316 size_t oldlen = sb->len, len;
317 int ch, ac;
Junio C Hamano4f6fbcd2005-10-15 04:54:47318
319 if (*quoted++ != '"')
Pierre Habouzit7fb10112007-09-19 22:42:14320 return -1;
Junio C Hamano4f6fbcd2005-10-15 04:54:47321
Pierre Habouzit7fb10112007-09-19 22:42:14322 for (;;) {
323 len = strcspn(quoted, "\"\\");
324 strbuf_add(sb, quoted, len);
325 quoted += len;
Junio C Hamano4f6fbcd2005-10-15 04:54:47326
Pierre Habouzit7fb10112007-09-19 22:42:14327 switch (*quoted++) {
328 case '"':
329 if (endp)
Pierre Habouzitc8744d62008-03-06 21:28:19330 *endp = quoted;
Pierre Habouzit7fb10112007-09-19 22:42:14331 return 0;
332 case '\\':
333 break;
334 default:
335 goto error;
336 }
Junio C Hamano4f6fbcd2005-10-15 04:54:47337
Pierre Habouzit7fb10112007-09-19 22:42:14338 switch ((ch = *quoted++)) {
339 case 'a': ch = '\a'; break;
340 case 'b': ch = '\b'; break;
341 case 'f': ch = '\f'; break;
342 case 'n': ch = '\n'; break;
343 case 'r': ch = '\r'; break;
344 case 't': ch = '\t'; break;
345 case 'v': ch = '\v'; break;
346
347 case '\\': case '"':
348 break; /* verbatim */
349
350 /* octal values with first digit over 4 overflow */
351 case '0': case '1': case '2': case '3':
Junio C Hamano4f6fbcd2005-10-15 04:54:47352 ac = ((ch - '0') << 6);
Pierre Habouzit7fb10112007-09-19 22:42:14353 if ((ch = *quoted++) < '0' || '7' < ch)
354 goto error;
Junio C Hamano4f6fbcd2005-10-15 04:54:47355 ac |= ((ch - '0') << 3);
Pierre Habouzit7fb10112007-09-19 22:42:14356 if ((ch = *quoted++) < '0' || '7' < ch)
357 goto error;
Junio C Hamano4f6fbcd2005-10-15 04:54:47358 ac |= (ch - '0');
359 ch = ac;
360 break;
361 default:
Pierre Habouzit7fb10112007-09-19 22:42:14362 goto error;
Junio C Hamano4f6fbcd2005-10-15 04:54:47363 }
Pierre Habouzit7fb10112007-09-19 22:42:14364 strbuf_addch(sb, ch);
Junio C Hamano4f6fbcd2005-10-15 04:54:47365 }
366
Pierre Habouzit7fb10112007-09-19 22:42:14367 error:
368 strbuf_setlen(sb, oldlen);
369 return -1;
Junio C Hamano4f6fbcd2005-10-15 04:54:47370}
371
Junio C Hamano9f613dd2006-09-15 20:30:02372/* quoting as a string literal for other languages */
373
Nguyễn Thái Ngọc Duy10d01672013-07-30 08:31:25374void perl_quote_buf(struct strbuf *sb, const char *src)
Junio C Hamano9f613dd2006-09-15 20:30:02375{
376 const char sq = '\'';
377 const char bq = '\\';
378 char c;
379
Nguyễn Thái Ngọc Duy10d01672013-07-30 08:31:25380 strbuf_addch(sb, sq);
Junio C Hamano9f613dd2006-09-15 20:30:02381 while ((c = *src++)) {
382 if (c == sq || c == bq)
Nguyễn Thái Ngọc Duy10d01672013-07-30 08:31:25383 strbuf_addch(sb, bq);
384 strbuf_addch(sb, c);
Junio C Hamano9f613dd2006-09-15 20:30:02385 }
Nguyễn Thái Ngọc Duy10d01672013-07-30 08:31:25386 strbuf_addch(sb, sq);
Junio C Hamano9f613dd2006-09-15 20:30:02387}
388
Nguyễn Thái Ngọc Duy10d01672013-07-30 08:31:25389void python_quote_buf(struct strbuf *sb, const char *src)
Junio C Hamano9f613dd2006-09-15 20:30:02390{
391 const char sq = '\'';
392 const char bq = '\\';
393 const char nl = '\n';
394 char c;
395
Nguyễn Thái Ngọc Duy10d01672013-07-30 08:31:25396 strbuf_addch(sb, sq);
Junio C Hamano9f613dd2006-09-15 20:30:02397 while ((c = *src++)) {
398 if (c == nl) {
Nguyễn Thái Ngọc Duy10d01672013-07-30 08:31:25399 strbuf_addch(sb, bq);
400 strbuf_addch(sb, 'n');
Junio C Hamano9f613dd2006-09-15 20:30:02401 continue;
402 }
403 if (c == sq || c == bq)
Nguyễn Thái Ngọc Duy10d01672013-07-30 08:31:25404 strbuf_addch(sb, bq);
405 strbuf_addch(sb, c);
Junio C Hamano9f613dd2006-09-15 20:30:02406 }
Nguyễn Thái Ngọc Duy10d01672013-07-30 08:31:25407 strbuf_addch(sb, sq);
Junio C Hamano9f613dd2006-09-15 20:30:02408}
Shawn O. Pearce5558e552007-01-28 07:39:13409
Nguyễn Thái Ngọc Duy10d01672013-07-30 08:31:25410void tcl_quote_buf(struct strbuf *sb, const char *src)
Shawn O. Pearce5558e552007-01-28 07:39:13411{
412 char c;
413
Nguyễn Thái Ngọc Duy10d01672013-07-30 08:31:25414 strbuf_addch(sb, '"');
Shawn O. Pearce5558e552007-01-28 07:39:13415 while ((c = *src++)) {
416 switch (c) {
417 case '[': case ']':
418 case '{': case '}':
419 case '$': case '\\': case '"':
Nguyễn Thái Ngọc Duy10d01672013-07-30 08:31:25420 strbuf_addch(sb, '\\');
Shawn O. Pearce5558e552007-01-28 07:39:13421 default:
Nguyễn Thái Ngọc Duy10d01672013-07-30 08:31:25422 strbuf_addch(sb, c);
Shawn O. Pearce5558e552007-01-28 07:39:13423 break;
424 case '\f':
Nguyễn Thái Ngọc Duy10d01672013-07-30 08:31:25425 strbuf_addstr(sb, "\\f");
Shawn O. Pearce5558e552007-01-28 07:39:13426 break;
427 case '\r':
Nguyễn Thái Ngọc Duy10d01672013-07-30 08:31:25428 strbuf_addstr(sb, "\\r");
Shawn O. Pearce5558e552007-01-28 07:39:13429 break;
430 case '\n':
Nguyễn Thái Ngọc Duy10d01672013-07-30 08:31:25431 strbuf_addstr(sb, "\\n");
Shawn O. Pearce5558e552007-01-28 07:39:13432 break;
433 case '\t':
Nguyễn Thái Ngọc Duy10d01672013-07-30 08:31:25434 strbuf_addstr(sb, "\\t");
Shawn O. Pearce5558e552007-01-28 07:39:13435 break;
436 case '\v':
Nguyễn Thái Ngọc Duy10d01672013-07-30 08:31:25437 strbuf_addstr(sb, "\\v");
Shawn O. Pearce5558e552007-01-28 07:39:13438 break;
439 }
440 }
Nguyễn Thái Ngọc Duy10d01672013-07-30 08:31:25441 strbuf_addch(sb, '"');
Shawn O. Pearce5558e552007-01-28 07:39:13442}