quote.con commit git-svn: handle our top-level path being deleted and later re-added (12a6d75)
   1#include "cache.h"
   2#include "quote.h"
   3
   4/* Help to copy the thing properly quoted for the shell safety.
   5 * any single quote is replaced with '\'', any exclamation point
   6 * is replaced with '\!', and the whole thing is enclosed in a
   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'
  13 *  a!b      ==> a'\!'b    ==> 'a'\!'b'
  14 */
  15static inline int need_bs_quote(char c)
  16{
  17        return (c == '\'' || c == '!');
  18}
  19
  20void sq_quote_buf(struct strbuf *dst, const char *src)
  21{
  22        char *to_free = NULL;
  23
  24        if (dst->buf == src)
  25                to_free = strbuf_detach(dst, NULL);
  26
  27        strbuf_addch(dst, '\'');
  28        while (*src) {
  29                size_t len = strcspn(src, "'!");
  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, '\'');
  36                }
  37        }
  38        strbuf_addch(dst, '\'');
  39        free(to_free);
  40}
  41
  42void 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
  59void sq_quote_argv(struct strbuf *dst, const char** argv, size_t maxlen)
  60{
  61        int i;
  62
  63        /* Copy into destination buffer. */
  64        strbuf_grow(dst, 255);
  65        for (i = 0; argv[i]; ++i) {
  66                strbuf_addch(dst, ' ');
  67                sq_quote_buf(dst, argv[i]);
  68                if (maxlen && dst->len > maxlen)
  69                        die("Too many or long arguments");
  70        }
  71}
  72
  73char *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
 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)
 114static 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
 127static inline int sq_must_quote(char c)
 128{
 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 */
 135static 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
 146/*
 147 * C-style name quoting.
 148 *
 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.
 154 *
 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).
 158 */
 159static size_t quote_c_style_counted(const char *name, ssize_t maxlen,
 160                                    struct strbuf *sb, FILE *fp, int no_dq)
 161{
 162#undef EMIT
 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;
 178
 179        for (;;) {
 180                int ch;
 181
 182                len = next_quote_pos(p, maxlen);
 183                if (len == maxlen || !p[len])
 184                        break;
 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');
 199                }
 200        }
 201
 202        EMITBUF(p, len);
 203        if (p == name)   /* no ending quote needed */
 204                return 0;
 205
 206        if (!no_dq)
 207                EMIT('"');
 208        return count;
 209}
 210
 211size_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);
 214}
 215
 216void write_name_quoted(const char *name, FILE *fp, int terminator)
 217{
 218        if (terminator) {
 219                quote_c_style(name, NULL, fp, 0);
 220        } else {
 221                fputs(name, fp);
 222        }
 223        fputc(terminator, fp);
 224}
 225
 226extern 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);
 245}
 246
 247/*
 248 * C-style name unquoting.
 249 *
 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.
 258 */
 259int unquote_c_style(struct strbuf *sb, const char *quoted, const char **endp)
 260{
 261        size_t oldlen = sb->len, len;
 262        int ch, ac;
 263
 264        if (*quoted++ != '"')
 265                return -1;
 266
 267        for (;;) {
 268                len = strcspn(quoted, "\"\\");
 269                strbuf_add(sb, quoted, len);
 270                quoted += len;
 271
 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':
 297                                        ac = ((ch - '0') << 6);
 298                        if ((ch = *quoted++) < '0' || '7' < ch)
 299                                goto error;
 300                                        ac |= ((ch - '0') << 3);
 301                        if ((ch = *quoted++) < '0' || '7' < ch)
 302                                goto error;
 303                                        ac |= (ch - '0');
 304                                        ch = ac;
 305                                        break;
 306                                default:
 307                        goto error;
 308                        }
 309                strbuf_addch(sb, ch);
 310                }
 311
 312  error:
 313        strbuf_setlen(sb, oldlen);
 314        return -1;
 315}
 316
 317/* quoting as a string literal for other languages */
 318
 319void 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
 334void 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}
 354
 355void 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}