1/* $NetBSD: shquote.c,v 1.8 2006/03/19 02:33:02 christos Exp $ */
2
3/*
4 * Copyright (c) 2001 Christopher G. Demetriou
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
17 * This product includes software developed for the
18 * NetBSD Project. See http://www.NetBSD.org/ for
19 * information about NetBSD.
20 * 4. The name of the author may not be used to endorse or promote products
21 * derived from this software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
24 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
25 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
27 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
28 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
32 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 *
34 * <<Id: LICENSE,v 1.2 2000/06/14 15:57:33 cgd Exp>>
35 */
36
37#include <sys/cdefs.h>
38#if defined(LIBC_SCCS) && !defined(lint)
39__RCSID("$NetBSD: shquote.c,v 1.8 2006/03/19 02:33:02 christos Exp $");
40#endif /* LIBC_SCCS and not lint */
41
42/*
43 * Define SHQUOTE_USE_MULTIBYTE if you want shquote() to handle multibyte
44 * characters using mbrtowc().
45 *
46 * Please DO NOT rip this #ifdef out of the code. It's also here to help
47 * portability.
48 */
49#undef SHQUOTE_USE_MULTIBYTE
50
51#include "netcompat.h"
52#include <stdlib.h>
53#include <string.h>
54#ifdef SHQUOTE_USE_MULTIBYTE
55#include <limits.h>
56#include <stdio.h>
57#include <wchar.h>
58#endif
59
60/*
61 * shquote():
62 *
63 * Requotes arguments so that they'll be interpreted properly by the
64 * shell (/bin/sh).
65 *
66 * Wraps single quotes around the string, and replaces single quotes
67 * in the string with the sequence:
68 * '\''
69 *
70 * Returns the number of characters required to hold the resulting quoted
71 * argument.
72 *
73 * The buffer supplied is filled in and NUL-terminated. If 'bufsize'
74 * indicates that the buffer is too short to hold the output string, the
75 * first (bufsize - 1) bytes of quoted argument are filled in and the
76 * buffer is NUL-terminated.
77 *
78 * Changes could be made to optimize the length of strings output by this
79 * function:
80 *
81 * * if there are no metacharacters or whitespace in the input,
82 * the output could be the input string.
83 */
84
85#ifdef SHQUOTE_USE_MULTIBYTE
86
87#define XLATE_OUTCH(x) wcrtomb(outch, (x), &mbso)
88#define XLATE_INCH() \
89 do { \
90 n = mbrtowc(&c, arg, MB_CUR_MAX, &mbsi); \
91 } while (/*LINTED const cond*/0)
92
93#else
94
95#define XLATE_OUTCH(x) (outch[0] = (x), 1)
96#define XLATE_INCH() \
97 do { \
98 n = ((c = *arg) != '\0') ? 1 : 0; \
99 } while (/*LINTED const cond*/0)
100
101#endif
102
103#define PUT(x) \
104 do { \
105 outchlen = XLATE_OUTCH(x); \
106 if (outchlen == (size_t)-1) \
107 goto bad; \
108 rv += outchlen; \
109 if (bufsize != 0) { \
110 if (bufsize < outchlen || \
111 (bufsize == outchlen && \
112 outch[outchlen - 1] != '\0')) { \
113 *buf = '\0'; \
114 bufsize = 0; \
115 } else { \
116 memcpy(buf, outch, outchlen); \
117 buf += outchlen; \
118 bufsize -= outchlen; \
119 } \
120 } \
121 } while (/*LINTED const cond*/0)
122
123size_t
124shquote(const char *arg, char *buf, size_t bufsize)
125{
126#ifdef SHQUOTE_USE_MULTIBYTE
127 char outch[MB_LEN_MAX];
128 mbstate_t mbsi, mbso;
129 wchar_t c, lastc;
130 size_t outchlen;
131#else
132 char outch[1];
133 char c, lastc;
134 size_t outchlen;
135#endif
136 size_t rv;
137 int n;
138
139 rv = 0;
140 lastc = 0;
141#ifdef SHQUOTE_USE_MULTIBYTE
142 memset(&mbsi, 0, sizeof mbsi);
143 memset(&mbso, 0, sizeof mbso);
144#endif
145
146 if (*arg != '\'')
147 PUT('\'');
148 for (;;) {
149 XLATE_INCH();
150 if (n <= 0)
151 break;
152 arg += n;
153 lastc = c;
154
155 if (c == '\'') {
156 if (rv != 0)
157 PUT('\'');
158 PUT('\\');
159 PUT('\'');
160 for (;;) {
161 XLATE_INCH();
162 if (n <= 0 || c != '\'')
163 break;
164 PUT('\\');
165 PUT('\'');
166 arg += n;
167 }
168 if (n > 0)
169 PUT('\'');
170 } else
171 PUT(c);
172 }
173 if (lastc != '\'')
174 PUT('\'');
175
176 /* Put multibyte or NUL terminator, but don't count the NUL. */
177 PUT('\0');
178 rv--;
179
180 return rv;
181
182bad:
183 /* A multibyte character encoding or decoding error occurred. */
184 return (size_t)-1;
185}
