Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 388 lines (347 sloc) 8.559 kB
6fb737b [PATCH] Make sq_expand() available as sq_quote().
Junio C Hamano authored
1 #include "cache.h"
2 #include "quote.h"
3
4 /* Help to copy the thing properly quoted for the shell safety.
77d604c Enhanced sq_quote()
H. Peter Anvin authored
5 * any single quote is replaced with '\'', any exclamation point
6 * is replaced with '\!', and the whole thing is enclosed in a
6fb737b [PATCH] Make sq_expand() available as sq_quote().
Junio C Hamano authored
7 *
8 * E.g.
9 * original sq_quote result
10 * name ==> name ==> 'name'
11 * a b ==> a b ==> 'a b'
12 * a'b ==> a'\''b ==> 'a'\''b'
77d604c Enhanced sq_quote()
H. Peter Anvin authored
13 * a!b ==> a'\!'b ==> 'a'\!'b'
6fb737b [PATCH] Make sq_expand() available as sq_quote().
Junio C Hamano authored
14 */
35eb2d3 Add git-shell.
Linus Torvalds authored
15 static inline int need_bs_quote(char c)
16 {
17 return (c == '\'' || c == '!');
18 }
19
7a33bcb @MadCoder sq_quote_argv and add_to_string rework with strbuf's.
MadCoder authored
20 void sq_quote_buf(struct strbuf *dst, const char *src)
77d604c Enhanced sq_quote()
H. Peter Anvin authored
21 {
7a33bcb @MadCoder sq_quote_argv and add_to_string rework with strbuf's.
MadCoder authored
22 char *to_free = NULL;
23
24 if (dst->buf == src)
b315c5c @MadCoder strbuf change: be sure ->buf is never ever NULL.
MadCoder authored
25 to_free = strbuf_detach(dst, NULL);
7a33bcb @MadCoder sq_quote_argv and add_to_string rework with strbuf's.
MadCoder authored
26
27 strbuf_addch(dst, '\'');
28 while (*src) {
c2015b3 Fix an infinite loop in sq_quote_buf().
Johannes Sixt authored
29 size_t len = strcspn(src, "'!");
7a33bcb @MadCoder sq_quote_argv and add_to_string rework with strbuf's.
MadCoder authored
30 strbuf_add(dst, src, len);
31 src += len;
32 while (need_bs_quote(*src)) {
33 strbuf_addstr(dst, "'\\");
34 strbuf_addch(dst, *src++);
35 strbuf_addch(dst, '\'');
6fb737b [PATCH] Make sq_expand() available as sq_quote().
Junio C Hamano authored
36 }
37 }
7a33bcb @MadCoder sq_quote_argv and add_to_string rework with strbuf's.
MadCoder authored
38 strbuf_addch(dst, '\'');
39 free(to_free);
77d604c Enhanced sq_quote()
H. Peter Anvin authored
40 }
41
575ba9d @matled GIT_TRACE: show which built-in/external commands are executed
matled authored
42 void sq_quote_print(FILE *stream, const char *src)
43 {
44 char c;
45
46 fputc('\'', stream);
47 while ((c = *src++)) {
48 if (need_bs_quote(c)) {
49 fputs("'\\", stream);
50 fputc(c, stream);
51 fputc('\'', stream);
52 } else {
53 fputc(c, stream);
54 }
55 }
56 fputc('\'', stream);
57 }
58
b319ce4 @chriscool Trace and quote with argv: get rid of unneeded count argument.
chriscool authored
59 void sq_quote_argv(struct strbuf *dst, const char** argv, size_t maxlen)
7cf6720 @chriscool Trace into open fd and refactor tracing code.
chriscool authored
60 {
61 int i;
62
63 /* Copy into destination buffer. */
b319ce4 @chriscool Trace and quote with argv: get rid of unneeded count argument.
chriscool authored
64 strbuf_grow(dst, 255);
65 for (i = 0; argv[i]; ++i) {
7a33bcb @MadCoder sq_quote_argv and add_to_string rework with strbuf's.
MadCoder authored
66 strbuf_addch(dst, ' ');
67 sq_quote_buf(dst, argv[i]);
68 if (maxlen && dst->len > maxlen)
69 die("Too many or long arguments");
7cf6720 @chriscool Trace into open fd and refactor tracing code.
chriscool authored
70 }
86257aa @chriscool Move add_to_string to "quote.c" and make it extern.
chriscool authored
71 }
72
35eb2d3 Add git-shell.
Linus Torvalds authored
73 char *sq_dequote(char *arg)
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;
93 return arg;
94 case '\\':
95 c = *++src;
96 if (need_bs_quote(c) && *++src == '\'') {
97 *dst++ = c;
98 continue;
99 }
100 /* Fallthrough */
101 default:
102 return NULL;
103 }
104 }
105 }
106
663af34 @MadCoder Full rework of quote_c_style and write_name_quoted.
MadCoder authored
107 /* 1 means: quote as octal
108 * 0 means: quote as octal if (quote_path_fully)
109 * -1 means: never quote
110 * c: quote as "\\c"
111 */
112 #define X8(x) x, x, x, x, x, x, x, x
113 #define X16(x) X8(x), X8(x)
114 static signed char const sq_lookup[256] = {
115 /* 0 1 2 3 4 5 6 7 */
116 /* 0x00 */ 1, 1, 1, 1, 1, 1, 1, 'a',
117 /* 0x08 */ 'b', 't', 'n', 'v', 'f', 'r', 1, 1,
118 /* 0x10 */ X16(1),
119 /* 0x20 */ -1, -1, '"', -1, -1, -1, -1, -1,
120 /* 0x28 */ X16(-1), X16(-1), X16(-1),
121 /* 0x58 */ -1, -1, -1, -1,'\\', -1, -1, -1,
122 /* 0x60 */ X16(-1), X8(-1),
123 /* 0x78 */ -1, -1, -1, -1, -1, -1, -1, 1,
124 /* 0x80 */ /* set to 0 */
125 };
126
f3fa183 @gitster Style: place opening brace of a function definition at column 1
gitster authored
127 static inline int sq_must_quote(char c)
128 {
663af34 @MadCoder Full rework of quote_c_style and write_name_quoted.
MadCoder authored
129 return sq_lookup[(unsigned char)c] + quote_path_fully > 0;
130 }
131
132 /* returns the longest prefix not needing a quote up to maxlen if positive.
133 This stops at the first \0 because it's marked as a character needing an
134 escape */
135 static size_t next_quote_pos(const char *s, ssize_t maxlen)
136 {
137 size_t len;
138 if (maxlen < 0) {
139 for (len = 0; !sq_must_quote(s[len]); len++);
140 } else {
141 for (len = 0; len < maxlen && !sq_must_quote(s[len]); len++);
142 }
143 return len;
144 }
145
4f6fbcd Functions to quote and unquote pathnames in C-style.
Junio C Hamano authored
146 /*
147 * C-style name quoting.
148 *
663af34 @MadCoder Full rework of quote_c_style and write_name_quoted.
MadCoder authored
149 * (1) if sb and fp are both NULL, inspect the input name and counts the
150 * number of bytes that are needed to hold c_style quoted version of name,
151 * counting the double quotes around it but not terminating NUL, and
152 * returns it.
153 * However, if name does not need c_style quoting, it returns 0.
4f6fbcd Functions to quote and unquote pathnames in C-style.
Junio C Hamano authored
154 *
663af34 @MadCoder Full rework of quote_c_style and write_name_quoted.
MadCoder authored
155 * (2) if sb or fp are not NULL, it emits the c_style quoted version
156 * of name, enclosed with double quotes if asked and needed only.
157 * Return value is the same as in (1).
4f6fbcd Functions to quote and unquote pathnames in C-style.
Junio C Hamano authored
158 */
663af34 @MadCoder Full rework of quote_c_style and write_name_quoted.
MadCoder authored
159 static size_t quote_c_style_counted(const char *name, ssize_t maxlen,
160 struct strbuf *sb, FILE *fp, int no_dq)
4f6fbcd Functions to quote and unquote pathnames in C-style.
Junio C Hamano authored
161 {
162 #undef EMIT
663af34 @MadCoder Full rework of quote_c_style and write_name_quoted.
MadCoder authored
163 #define EMIT(c) \
164 do { \
165 if (sb) strbuf_addch(sb, (c)); \
166 if (fp) fputc((c), fp); \
167 count++; \
168 } while (0)
169 #define EMITBUF(s, l) \
170 do { \
171 if (sb) strbuf_add(sb, (s), (l)); \
172 if (fp) fwrite((s), (l), 1, fp); \
173 count += (l); \
174 } while (0)
175
176 size_t len, count = 0;
177 const char *p = name;
4f6fbcd Functions to quote and unquote pathnames in C-style.
Junio C Hamano authored
178
663af34 @MadCoder Full rework of quote_c_style and write_name_quoted.
MadCoder authored
179 for (;;) {
180 int ch;
4f6fbcd Functions to quote and unquote pathnames in C-style.
Junio C Hamano authored
181
663af34 @MadCoder Full rework of quote_c_style and write_name_quoted.
MadCoder authored
182 len = next_quote_pos(p, maxlen);
183 if (len == maxlen || !p[len])
50e7b06 @proski [PATCH] quote.c: Make loop control more readable.
proski authored
184 break;
663af34 @MadCoder Full rework of quote_c_style and write_name_quoted.
MadCoder authored
185
186 if (!no_dq && p == name)
187 EMIT('"');
188
189 EMITBUF(p, len);
190 EMIT('\\');
191 p += len;
192 ch = (unsigned char)*p++;
193 if (sq_lookup[ch] >= ' ') {
194 EMIT(sq_lookup[ch]);
195 } else {
196 EMIT(((ch >> 6) & 03) + '0');
197 EMIT(((ch >> 3) & 07) + '0');
198 EMIT(((ch >> 0) & 07) + '0');
4f6fbcd Functions to quote and unquote pathnames in C-style.
Junio C Hamano authored
199 }
200 }
663af34 @MadCoder Full rework of quote_c_style and write_name_quoted.
MadCoder authored
201
202 EMITBUF(p, len);
203 if (p == name) /* no ending quote needed */
204 return 0;
205
4f6fbcd Functions to quote and unquote pathnames in C-style.
Junio C Hamano authored
206 if (!no_dq)
207 EMIT('"');
663af34 @MadCoder Full rework of quote_c_style and write_name_quoted.
MadCoder authored
208 return count;
209 }
4f6fbcd Functions to quote and unquote pathnames in C-style.
Junio C Hamano authored
210
663af34 @MadCoder Full rework of quote_c_style and write_name_quoted.
MadCoder authored
211 size_t quote_c_style(const char *name, struct strbuf *sb, FILE *fp, int nodq)
212 {
213 return quote_c_style_counted(name, -1, sb, fp, nodq);
4f6fbcd Functions to quote and unquote pathnames in C-style.
Junio C Hamano authored
214 }
215
663af34 @MadCoder Full rework of quote_c_style and write_name_quoted.
MadCoder authored
216 void write_name_quoted(const char *name, FILE *fp, int terminator)
9ef2b3c write_name_quoted(): make one of the path a counted string.
Junio C Hamano authored
217 {
663af34 @MadCoder Full rework of quote_c_style and write_name_quoted.
MadCoder authored
218 if (terminator) {
219 quote_c_style(name, NULL, fp, 0);
220 } else {
221 fputs(name, fp);
222 }
223 fputc(terminator, fp);
224 }
225
226 extern void write_name_quotedpfx(const char *pfx, size_t pfxlen,
227 const char *name, FILE *fp, int terminator)
228 {
229 int needquote = 0;
230
231 if (terminator) {
232 needquote = next_quote_pos(pfx, pfxlen) < pfxlen
233 || name[next_quote_pos(name, -1)];
234 }
235 if (needquote) {
236 fputc('"', fp);
237 quote_c_style_counted(pfx, pfxlen, NULL, fp, 1);
238 quote_c_style(name, NULL, fp, 1);
239 fputc('"', fp);
240 } else {
241 fwrite(pfx, pfxlen, 1, fp);
242 fputs(name, fp);
243 }
244 fputc(terminator, fp);
9ef2b3c write_name_quoted(): make one of the path a counted string.
Junio C Hamano authored
245 }
246
4f6fbcd Functions to quote and unquote pathnames in C-style.
Junio C Hamano authored
247 /*
248 * C-style name unquoting.
249 *
7fb1011 @MadCoder Rework unquote_c_style to work on a strbuf.
MadCoder authored
250 * Quoted should point at the opening double quote.
251 * + Returns 0 if it was able to unquote the string properly, and appends the
252 * result in the strbuf `sb'.
253 * + Returns -1 in case of error, and doesn't touch the strbuf. Though note
254 * that this function will allocate memory in the strbuf, so calling
255 * strbuf_release is mandatory whichever result unquote_c_style returns.
256 *
257 * Updates endp pointer to point at one past the ending double quote if given.
4f6fbcd Functions to quote and unquote pathnames in C-style.
Junio C Hamano authored
258 */
7fb1011 @MadCoder Rework unquote_c_style to work on a strbuf.
MadCoder authored
259 int unquote_c_style(struct strbuf *sb, const char *quoted, const char **endp)
4f6fbcd Functions to quote and unquote pathnames in C-style.
Junio C Hamano authored
260 {
7fb1011 @MadCoder Rework unquote_c_style to work on a strbuf.
MadCoder authored
261 size_t oldlen = sb->len, len;
262 int ch, ac;
4f6fbcd Functions to quote and unquote pathnames in C-style.
Junio C Hamano authored
263
264 if (*quoted++ != '"')
7fb1011 @MadCoder Rework unquote_c_style to work on a strbuf.
MadCoder authored
265 return -1;
266
267 for (;;) {
268 len = strcspn(quoted, "\"\\");
269 strbuf_add(sb, quoted, len);
270 quoted += len;
4f6fbcd Functions to quote and unquote pathnames in C-style.
Junio C Hamano authored
271
7fb1011 @MadCoder Rework unquote_c_style to work on a strbuf.
MadCoder authored
272 switch (*quoted++) {
273 case '"':
274 if (endp)
275 *endp = quoted + 1;
276 return 0;
277 case '\\':
278 break;
279 default:
280 goto error;
281 }
282
283 switch ((ch = *quoted++)) {
284 case 'a': ch = '\a'; break;
285 case 'b': ch = '\b'; break;
286 case 'f': ch = '\f'; break;
287 case 'n': ch = '\n'; break;
288 case 'r': ch = '\r'; break;
289 case 't': ch = '\t'; break;
290 case 'v': ch = '\v'; break;
291
292 case '\\': case '"':
293 break; /* verbatim */
294
295 /* octal values with first digit over 4 overflow */
296 case '0': case '1': case '2': case '3':
4f6fbcd Functions to quote and unquote pathnames in C-style.
Junio C Hamano authored
297 ac = ((ch - '0') << 6);
7fb1011 @MadCoder Rework unquote_c_style to work on a strbuf.
MadCoder authored
298 if ((ch = *quoted++) < '0' || '7' < ch)
299 goto error;
4f6fbcd Functions to quote and unquote pathnames in C-style.
Junio C Hamano authored
300 ac |= ((ch - '0') << 3);
7fb1011 @MadCoder Rework unquote_c_style to work on a strbuf.
MadCoder authored
301 if ((ch = *quoted++) < '0' || '7' < ch)
302 goto error;
4f6fbcd Functions to quote and unquote pathnames in C-style.
Junio C Hamano authored
303 ac |= (ch - '0');
304 ch = ac;
305 break;
306 default:
7fb1011 @MadCoder Rework unquote_c_style to work on a strbuf.
MadCoder authored
307 goto error;
4f6fbcd Functions to quote and unquote pathnames in C-style.
Junio C Hamano authored
308 }
7fb1011 @MadCoder Rework unquote_c_style to work on a strbuf.
MadCoder authored
309 strbuf_addch(sb, ch);
4f6fbcd Functions to quote and unquote pathnames in C-style.
Junio C Hamano authored
310 }
311
7fb1011 @MadCoder Rework unquote_c_style to work on a strbuf.
MadCoder authored
312 error:
313 strbuf_setlen(sb, oldlen);
314 return -1;
4f6fbcd Functions to quote and unquote pathnames in C-style.
Junio C Hamano authored
315 }
316
9f613dd Add git-for-each-ref: helper for language bindings
Junio C Hamano authored
317 /* quoting as a string literal for other languages */
318
319 void perl_quote_print(FILE *stream, const char *src)
320 {
321 const char sq = '\'';
322 const char bq = '\\';
323 char c;
324
325 fputc(sq, stream);
326 while ((c = *src++)) {
327 if (c == sq || c == bq)
328 fputc(bq, stream);
329 fputc(c, stream);
330 }
331 fputc(sq, stream);
332 }
333
334 void python_quote_print(FILE *stream, const char *src)
335 {
336 const char sq = '\'';
337 const char bq = '\\';
338 const char nl = '\n';
339 char c;
340
341 fputc(sq, stream);
342 while ((c = *src++)) {
343 if (c == nl) {
344 fputc(bq, stream);
345 fputc('n', stream);
346 continue;
347 }
348 if (c == sq || c == bq)
349 fputc(bq, stream);
350 fputc(c, stream);
351 }
352 fputc(sq, stream);
353 }
5558e55 @spearce Teach for-each-ref about a little language called Tcl.
spearce authored
354
355 void tcl_quote_print(FILE *stream, const char *src)
356 {
357 char c;
358
359 fputc('"', stream);
360 while ((c = *src++)) {
361 switch (c) {
362 case '[': case ']':
363 case '{': case '}':
364 case '$': case '\\': case '"':
365 fputc('\\', stream);
366 default:
367 fputc(c, stream);
368 break;
369 case '\f':
370 fputs("\\f", stream);
371 break;
372 case '\r':
373 fputs("\\r", stream);
374 break;
375 case '\n':
376 fputs("\\n", stream);
377 break;
378 case '\t':
379 fputs("\\t", stream);
380 break;
381 case '\v':
382 fputs("\\v", stream);
383 break;
384 }
385 }
386 fputc('"', stream);
387 }
Something went wrong with that request. Please try again.