1 /* $NetBSD: vis.c,v 1.74 2017/11/27 16:37:21 christos Exp $ */
4 * Copyright (c) 1989, 1993
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * Copyright (c) 1999, 2005 The NetBSD Foundation, Inc.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
39 * 1. Redistributions of source code must retain the above copyright
40 * notice, this list of conditions and the following disclaimer.
41 * 2. Redistributions in binary form must reproduce the above copyright
42 * notice, this list of conditions and the following disclaimer in the
43 * documentation and/or other materials provided with the distribution.
45 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
46 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
47 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
48 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
49 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
50 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
51 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
52 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
53 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
54 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
55 * POSSIBILITY OF SUCH DAMAGE.
58 #include <sys/cdefs.h>
59 #if defined(LIBC_SCCS) && !defined(lint)
60 __RCSID("$NetBSD: vis.c,v 1.74 2017/11/27 16:37:21 christos Exp $");
61 #endif /* LIBC_SCCS and not lint */
63 __FBSDID("$FreeBSD$");
64 #define _DIAGASSERT(x) assert(x)
67 #include "namespace.h"
68 #include <sys/types.h>
69 #include <sys/param.h>
79 __weak_alias(strvisx,_strvisx)
82 #if !HAVE_VIS || !HAVE_SVIS
89 * The reason for going through the trouble to deal with character encodings
90 * in vis(3), is that we use this to safe encode output of commands. This
91 * safe encoding varies depending on the character set. For example if we
92 * display ps output in French, we don't want to display French characters
96 static wchar_t *do_svis(wchar_t *, wint_t, int, wint_t, const wchar_t *);
101 #if defined(LC_C_LOCALE)
102 #define iscgraph(c) isgraph_l(c, LC_C_LOCALE)
104 /* Keep it simple for now, no locale stuff */
105 #define iscgraph(c) isgraph(c)
113 ol = setlocale(LC_CTYPE, "C");
116 setlocale(LC_CTYPE, ol);
122 #define ISGRAPH(flags, c) \
123 (((flags) & VIS_NOLOCALE) ? iscgraph(c) : iswgraph(c))
125 #define iswoctal(c) (((u_char)(c)) >= L'0' && ((u_char)(c)) <= L'7')
126 #define iswwhite(c) (c == L' ' || c == L'\t' || c == L'\n')
127 #define iswsafe(c) (c == L'\b' || c == BELL || c == L'\r')
128 #define xtoa(c) L"0123456789abcdef"[c]
129 #define XTOA(c) L"0123456789ABCDEF"[c]
133 static const wchar_t char_shell[] = L"'`\";&<>()|{}]\\$!^~";
134 static const wchar_t char_glob[] = L"*?[#";
136 #if !HAVE_NBTOOL_CONFIG_H
139 * On NetBSD MB_LEN_MAX is currently 32 which does not fit on any integer
140 * integral type and it is probably wrong, since currently the maximum
141 * number of bytes and character needs is 6. Until this is fixed, the
142 * loops below are using sizeof(uint64_t) - 1 instead of MB_LEN_MAX, and
143 * the assertion is commented out.
147 * On FreeBSD including <sys/systm.h> for CTASSERT only works in kernel
151 #define CTASSERT(x) _CTASSERT(x, __LINE__)
152 #define _CTASSERT(x, y) __CTASSERT(x, y)
153 #define __CTASSERT(x, y) typedef char __assert ## y[(x) ? 1 : -1]
155 #endif /* __FreeBSD__ */
156 CTASSERT(MB_LEN_MAX <= sizeof(uint64_t));
157 #endif /* !__NetBSD__ */
161 * This is do_hvis, for HTTP style (RFC 1808)
164 do_hvis(wchar_t *dst, wint_t c, int flags, wint_t nextc, const wchar_t *extra)
168 || c == L'$' || c == L'-' || c == L'_' || c == L'.' || c == L'+'
170 || c == L'!' || c == L'*' || c == L'\'' || c == L'(' || c == L')'
172 dst = do_svis(dst, c, flags, nextc, extra);
175 *dst++ = xtoa(((unsigned int)c >> 4) & 0xf);
176 *dst++ = xtoa((unsigned int)c & 0xf);
183 * This is do_mvis, for Quoted-Printable MIME (RFC 2045)
184 * NB: No handling of long lines or CRLF.
187 do_mvis(wchar_t *dst, wint_t c, int flags, wint_t nextc, const wchar_t *extra)
190 /* Space at the end of the line */
191 ((iswspace(c) && (nextc == L'\r' || nextc == L'\n')) ||
193 (!iswspace(c) && (c < 33 || (c > 60 && c < 62) || c > 126)) ||
194 /* Specific char to be escaped */
195 wcschr(L"#$@[\\]^`{|}~", c) != NULL)) {
197 *dst++ = XTOA(((unsigned int)c >> 4) & 0xf);
198 *dst++ = XTOA((unsigned int)c & 0xf);
200 dst = do_svis(dst, c, flags, nextc, extra);
205 * Output single byte of multibyte character.
208 do_mbyte(wchar_t *dst, wint_t c, int flags, wint_t nextc, int iswextra)
210 if (flags & VIS_CSTYLE) {
213 *dst++ = L'\\'; *dst++ = L'n';
216 *dst++ = L'\\'; *dst++ = L'r';
219 *dst++ = L'\\'; *dst++ = L'b';
222 *dst++ = L'\\'; *dst++ = L'a';
225 *dst++ = L'\\'; *dst++ = L'v';
228 *dst++ = L'\\'; *dst++ = L't';
231 *dst++ = L'\\'; *dst++ = L'f';
234 *dst++ = L'\\'; *dst++ = L's';
237 *dst++ = L'\\'; *dst++ = L'0';
238 if (iswoctal(nextc)) {
243 /* We cannot encode these characters in VIS_CSTYLE
244 * because they special meaning */
256 case L'$': /* vis(1) -l */
259 if (ISGRAPH(flags, c) && !iswoctal(c)) {
266 if (iswextra || ((c & 0177) == L' ') || (flags & VIS_OCTAL)) {
268 *dst++ = (u_char)(((u_int32_t)(u_char)c >> 6) & 03) + L'0';
269 *dst++ = (u_char)(((u_int32_t)(u_char)c >> 3) & 07) + L'0';
270 *dst++ = (c & 07) + L'0';
272 if ((flags & VIS_NOSLASH) == 0)
296 * This is do_vis, the central code of vis.
297 * dst: Pointer to the destination buffer
298 * c: Character to encode
300 * nextc: The character following 'c'
301 * extra: Pointer to the list of extra characters to be
302 * backslash-protected.
305 do_svis(wchar_t *dst, wint_t c, int flags, wint_t nextc, const wchar_t *extra)
307 int iswextra, i, shft;
310 iswextra = wcschr(extra, c) != NULL;
311 if (!iswextra && (ISGRAPH(flags, c) || iswwhite(c) ||
312 ((flags & VIS_SAFE) && iswsafe(c)))) {
317 /* See comment in istrsenvisx() output loop, below. */
319 for (i = sizeof(wmsk) - 1; i >= 0; i--) {
321 bmsk = (uint64_t)0xffLL << shft;
323 if ((c & wmsk) || i == 0)
324 dst = do_mbyte(dst, (wint_t)(
325 (uint64_t)(c & bmsk) >> shft),
326 flags, nextc, iswextra);
332 typedef wchar_t *(*visfun_t)(wchar_t *, wint_t, int, wint_t, const wchar_t *);
335 * Return the appropriate encoding function depending on the flags given.
340 if (flags & VIS_HTTPSTYLE)
342 if (flags & VIS_MIMESTYLE)
348 * Expand list of extra characters to not visually encode.
351 makeextralist(int flags, const char *src)
358 bzero(&mbstate, sizeof(mbstate));
360 if ((dst = calloc(len + MAXEXTRAS, sizeof(*dst))) == NULL)
363 if ((flags & VIS_NOLOCALE) || mbsrtowcs(dst, &src, len, &mbstate) == (size_t)-1) {
365 for (i = 0; i < len; i++)
366 dst[i] = (wchar_t)(u_char)src[i];
369 d = dst + wcslen(dst);
371 if (flags & VIS_GLOB)
372 for (s = char_glob; *s; *d++ = *s++)
375 if (flags & VIS_SHELL)
376 for (s = char_shell; *s; *d++ = *s++)
379 if (flags & VIS_SP) *d++ = L' ';
380 if (flags & VIS_TAB) *d++ = L'\t';
381 if (flags & VIS_NL) *d++ = L'\n';
382 if (flags & VIS_DQ) *d++ = L'"';
383 if ((flags & VIS_NOSLASH) == 0) *d++ = L'\\';
391 * The main internal function.
392 * All user-visible functions call this one.
395 istrsenvisx(char **mbdstp, size_t *dlen, const char *mbsrc, size_t mblength,
396 int flags, const char *mbextra, int *cerr_ptr)
398 wchar_t *dst, *src, *pdst, *psrc, *start, *extra;
403 int clen = 0, cerr, error = -1, i, shft;
405 ssize_t mbslength, maxolen;
408 _DIAGASSERT(mbdstp != NULL);
409 _DIAGASSERT(mbsrc != NULL || mblength == 0);
410 _DIAGASSERT(mbextra != NULL);
412 mbslength = (ssize_t)mblength;
414 * When inputing a single character, must also read in the
415 * next character for nextc, the look-ahead character.
421 * Input (mbsrc) is a char string considered to be multibyte
422 * characters. The input loop will read this string pulling
423 * one character, possibly multiple bytes, from mbsrc and
424 * converting each to wchar_t in src.
426 * The vis conversion will be done using the wide char
429 * This will then be converted back to a multibyte string to
430 * return to the caller.
433 /* Allocate space for the wide char strings */
434 psrc = pdst = extra = NULL;
436 if ((psrc = calloc(mbslength + 1, sizeof(*psrc))) == NULL)
438 if ((pdst = calloc((16 * mbslength) + 1, sizeof(*pdst))) == NULL)
440 if (*mbdstp == NULL) {
441 if ((mdst = calloc((16 * mbslength) + 1, sizeof(*mdst))) == NULL)
450 if (flags & VIS_NOLOCALE) {
451 /* Do one byte at a time conversion */
454 /* Use caller's multibyte conversion error flag. */
455 cerr = cerr_ptr ? *cerr_ptr : 0;
460 * Handle up to mblength characters (not bytes). We do not
461 * stop at NULs because we may be processing a block of data
462 * that includes NULs.
464 bzero(&mbstate, sizeof(mbstate));
465 while (mbslength > 0) {
466 /* Convert one multibyte character to wchar_t. */
468 clen = mbrtowc(src, mbsrc, MB_LEN_MAX, &mbstate);
469 if (cerr || clen < 0) {
470 /* Conversion error, process as a byte instead. */
471 *src = (wint_t)(u_char)*mbsrc;
477 * NUL in input gives 0 return value. process
478 * as single NUL byte and keep going.
482 /* Advance buffer character pointer. */
484 /* Advance input pointer by number of bytes read. */
486 /* Decrement input byte count. */
493 * In the single character input case, we will have actually
494 * processed two characters, c and nextc. Reset len back to
495 * just a single character.
500 /* Convert extra argument to list of characters for this mode. */
501 extra = makeextralist(flags, mbextra);
503 if (dlen && *dlen == 0) {
507 *mbdst = '\0'; /* can't create extra, return "" */
512 /* Look up which processing function to call. */
513 f = getvisfun(flags);
516 * Main processing loop.
517 * Call do_Xvis processing function one character at a time
518 * with next character available for look-ahead.
520 for (start = dst; len > 0; len--) {
522 dst = (*f)(dst, c, flags, len >= 1 ? *src : L'\0', extra);
529 /* Terminate the string in the buffer. */
534 * Convert wchar_t string back to multibyte output string.
535 * If we have hit a multi-byte conversion error on input,
536 * output byte-by-byte here. Else use wctomb().
539 maxolen = dlen ? *dlen : (wcslen(start) * MB_LEN_MAX + 1);
541 bzero(&mbstate, sizeof(mbstate));
542 for (dst = start; len > 0; len--) {
544 clen = wcrtomb(mbdst, *dst, &mbstate);
545 if (cerr || clen < 0) {
547 * Conversion error, process as a byte(s) instead.
548 * Examine each byte and higher-order bytes for
550 * 0x000000000000a264 -> a2 64
551 * 0x000000001f00a264 -> 1f 00 a2 64
555 for (i = sizeof(wmsk) - 1; i >= 0; i--) {
557 bmsk = (uint64_t)0xffLL << shft;
559 if ((*dst & wmsk) || i == 0)
560 mbdst[clen++] = (char)(
561 (uint64_t)(*dst & bmsk) >>
566 /* If this character would exceed our output limit, stop. */
567 if (olen + clen > (size_t)maxolen)
569 /* Advance output pointer by number of bytes written. */
571 /* Advance buffer character pointer. */
573 /* Incrment output character count. */
577 /* Terminate the output string. */
580 if (flags & VIS_NOLOCALE) {
581 /* Pass conversion error flag out. */
600 istrsenvisxl(char **mbdstp, size_t *dlen, const char *mbsrc,
601 int flags, const char *mbextra, int *cerr_ptr)
603 return istrsenvisx(mbdstp, dlen, mbsrc,
604 mbsrc != NULL ? strlen(mbsrc) : 0, flags, mbextra, cerr_ptr);
611 * The "svis" variants all take an "extra" arg that is a pointer
612 * to a NUL-terminated list of characters to be encoded, too.
613 * These functions are useful e. g. to encode strings in such a
614 * way so that they are not interpreted by a shell.
618 svis(char *mbdst, int c, int flags, int nextc, const char *mbextra)
626 ret = istrsenvisx(&mbdst, NULL, cc, 1, flags, mbextra, NULL);
633 snvis(char *mbdst, size_t dlen, int c, int flags, int nextc, const char *mbextra)
641 ret = istrsenvisx(&mbdst, &dlen, cc, 1, flags, mbextra, NULL);
648 strsvis(char *mbdst, const char *mbsrc, int flags, const char *mbextra)
650 return istrsenvisxl(&mbdst, NULL, mbsrc, flags, mbextra, NULL);
654 strsnvis(char *mbdst, size_t dlen, const char *mbsrc, int flags, const char *mbextra)
656 return istrsenvisxl(&mbdst, &dlen, mbsrc, flags, mbextra, NULL);
660 strsvisx(char *mbdst, const char *mbsrc, size_t len, int flags, const char *mbextra)
662 return istrsenvisx(&mbdst, NULL, mbsrc, len, flags, mbextra, NULL);
666 strsnvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags,
669 return istrsenvisx(&mbdst, &dlen, mbsrc, len, flags, mbextra, NULL);
673 strsenvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags,
674 const char *mbextra, int *cerr_ptr)
676 return istrsenvisx(&mbdst, &dlen, mbsrc, len, flags, mbextra, cerr_ptr);
682 * vis - visually encode characters
685 vis(char *mbdst, int c, int flags, int nextc)
693 ret = istrsenvisx(&mbdst, NULL, cc, 1, flags, "", NULL);
700 nvis(char *mbdst, size_t dlen, int c, int flags, int nextc)
708 ret = istrsenvisx(&mbdst, &dlen, cc, 1, flags, "", NULL);
715 * strvis - visually encode characters from src into dst
717 * Dst must be 4 times the size of src to account for possible
718 * expansion. The length of dst, not including the trailing NULL,
723 strvis(char *mbdst, const char *mbsrc, int flags)
725 return istrsenvisxl(&mbdst, NULL, mbsrc, flags, "", NULL);
729 strnvis(char *mbdst, size_t dlen, const char *mbsrc, int flags)
731 return istrsenvisxl(&mbdst, &dlen, mbsrc, flags, "", NULL);
735 stravis(char **mbdstp, const char *mbsrc, int flags)
738 return istrsenvisxl(mbdstp, NULL, mbsrc, flags, "", NULL);
742 * strvisx - visually encode characters from src into dst
744 * Dst must be 4 times the size of src to account for possible
745 * expansion. The length of dst, not including the trailing NULL,
748 * Strvisx encodes exactly len characters from src into dst.
749 * This is useful for encoding a block of data.
753 strvisx(char *mbdst, const char *mbsrc, size_t len, int flags)
755 return istrsenvisx(&mbdst, NULL, mbsrc, len, flags, "", NULL);
759 strnvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags)
761 return istrsenvisx(&mbdst, &dlen, mbsrc, len, flags, "", NULL);
765 strenvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags,
768 return istrsenvisx(&mbdst, &dlen, mbsrc, len, flags, "", cerr_ptr);