1 /* $NetBSD: vis.c,v 1.83 2023/08/12 12:48:52 riastradh 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.83 2023/08/12 12:48:52 riastradh Exp $");
61 #endif /* LIBC_SCCS and not lint */
63 #include "namespace.h"
64 #include <sys/types.h>
65 #include <sys/param.h>
76 __weak_alias(strvisx,_strvisx)
79 #if !HAVE_VIS || !HAVE_SVIS
85 #define _DIAGASSERT(x) assert(x)
88 * The reason for going through the trouble to deal with character encodings
89 * in vis(3), is that we use this to safe encode output of commands. This
90 * safe encoding varies depending on the character set. For example if we
91 * display ps output in French, we don't want to display French characters
95 static wchar_t *do_svis(wchar_t *, wint_t, int, wint_t, const wchar_t *);
100 #if defined(LC_C_LOCALE)
101 #define iscgraph(c) isgraph_l(c, LC_C_LOCALE)
103 /* Keep it simple for now, no locale stuff */
104 #define iscgraph(c) isgraph(c)
112 ol = setlocale(LC_CTYPE, "C");
115 setlocale(LC_CTYPE, ol);
121 #define ISGRAPH(flags, c) \
122 (((flags) & VIS_NOLOCALE) ? iscgraph(c) : iswgraph(c))
124 #define iswoctal(c) (((u_char)(c)) >= L'0' && ((u_char)(c)) <= L'7')
125 #define iswwhite(c) (c == L' ' || c == L'\t' || c == L'\n')
126 #define iswsafe(c) (c == L'\b' || c == BELL || c == L'\r')
127 #define xtoa(c) L"0123456789abcdef"[c]
128 #define XTOA(c) L"0123456789ABCDEF"[c]
132 static const wchar_t char_shell[] = L"'`\";&<>()|{}]\\$!^~";
133 static const wchar_t char_glob[] = L"*?[#";
135 #if !HAVE_NBTOOL_CONFIG_H
138 * On NetBSD MB_LEN_MAX is currently 32 which does not fit on any integer
139 * integral type and it is probably wrong, since currently the maximum
140 * number of bytes and character needs is 6. Until this is fixed, the
141 * loops below are using sizeof(uint64_t) - 1 instead of MB_LEN_MAX, and
142 * the assertion is commented out.
146 * On FreeBSD including <sys/systm.h> for CTASSERT only works in kernel
150 #define CTASSERT(x) _CTASSERT(x, __LINE__)
151 #define _CTASSERT(x, y) __CTASSERT(x, y)
152 #define __CTASSERT(x, y) typedef char __assert ## y[(x) ? 1 : -1]
154 #endif /* __FreeBSD__ */
155 CTASSERT(MB_LEN_MAX <= sizeof(uint64_t));
156 #endif /* !__NetBSD__ */
160 * This is do_hvis, for HTTP style (RFC 1808)
163 do_hvis(wchar_t *dst, wint_t c, int flags, wint_t nextc, const wchar_t *extra)
167 || c == L'$' || c == L'-' || c == L'_' || c == L'.' || c == L'+'
169 || c == L'!' || c == L'*' || c == L'\'' || c == L'(' || c == L')'
171 dst = do_svis(dst, c, flags, nextc, extra);
174 *dst++ = xtoa(((unsigned int)c >> 4) & 0xf);
175 *dst++ = xtoa((unsigned int)c & 0xf);
182 * This is do_mvis, for Quoted-Printable MIME (RFC 2045)
183 * NB: No handling of long lines or CRLF.
186 do_mvis(wchar_t *dst, wint_t c, int flags, wint_t nextc, const wchar_t *extra)
189 /* Space at the end of the line */
190 ((iswspace(c) && (nextc == L'\r' || nextc == L'\n')) ||
192 (!iswspace(c) && (c < 33 || (c > 60 && c < 62) || c > 126)) ||
193 /* Specific char to be escaped */
194 wcschr(L"#$@[\\]^`{|}~", c) != NULL)) {
196 *dst++ = XTOA(((unsigned int)c >> 4) & 0xf);
197 *dst++ = XTOA((unsigned int)c & 0xf);
199 dst = do_svis(dst, c, flags, nextc, extra);
204 * Output single byte of multibyte character.
207 do_mbyte(wchar_t *dst, wint_t c, int flags, wint_t nextc, int iswextra)
209 if (flags & VIS_CSTYLE) {
212 *dst++ = L'\\'; *dst++ = L'n';
215 *dst++ = L'\\'; *dst++ = L'r';
218 *dst++ = L'\\'; *dst++ = L'b';
221 *dst++ = L'\\'; *dst++ = L'a';
224 *dst++ = L'\\'; *dst++ = L'v';
227 *dst++ = L'\\'; *dst++ = L't';
230 *dst++ = L'\\'; *dst++ = L'f';
233 *dst++ = L'\\'; *dst++ = L's';
236 *dst++ = L'\\'; *dst++ = L'0';
237 if (iswoctal(nextc)) {
242 /* We cannot encode these characters in VIS_CSTYLE
243 * because they special meaning */
255 case L'$': /* vis(1) -l */
258 if (ISGRAPH(flags, c) && !iswoctal(c)) {
265 if (iswextra || ((c & 0177) == L' ') || (flags & VIS_OCTAL)) {
267 *dst++ = (u_char)(((u_int32_t)(u_char)c >> 6) & 03) + L'0';
268 *dst++ = (u_char)(((u_int32_t)(u_char)c >> 3) & 07) + L'0';
269 *dst++ = (c & 07) + L'0';
271 if ((flags & VIS_NOSLASH) == 0)
295 * This is do_vis, the central code of vis.
296 * dst: Pointer to the destination buffer
297 * c: Character to encode
299 * nextc: The character following 'c'
300 * extra: Pointer to the list of extra characters to be
301 * backslash-protected.
304 do_svis(wchar_t *dst, wint_t c, int flags, wint_t nextc, const wchar_t *extra)
306 int iswextra, i, shft;
309 iswextra = wcschr(extra, c) != NULL;
310 if (!iswextra && (ISGRAPH(flags, c) || iswwhite(c) ||
311 ((flags & VIS_SAFE) && iswsafe(c)))) {
316 /* See comment in istrsenvisx() output loop, below. */
318 for (i = sizeof(wmsk) - 1; i >= 0; i--) {
320 bmsk = (uint64_t)0xffLL << shft;
322 if ((c & wmsk) || i == 0)
323 dst = do_mbyte(dst, (wint_t)(
324 (uint64_t)(c & bmsk) >> shft),
325 flags, nextc, iswextra);
331 typedef wchar_t *(*visfun_t)(wchar_t *, wint_t, int, wint_t, const wchar_t *);
334 * Return the appropriate encoding function depending on the flags given.
339 if (flags & VIS_HTTPSTYLE)
341 if (flags & VIS_MIMESTYLE)
347 * Expand list of extra characters to not visually encode.
350 makeextralist(int flags, const char *src)
357 bzero(&mbstate, sizeof(mbstate));
359 if ((dst = calloc(len + MAXEXTRAS, sizeof(*dst))) == NULL)
362 memset(&mbstate, 0, sizeof(mbstate));
363 if ((flags & VIS_NOLOCALE)
364 || mbsrtowcs(dst, &src, len, &mbstate) == (size_t)-1) {
366 for (i = 0; i < len; i++)
367 dst[i] = (wchar_t)(u_char)src[i];
370 d = dst + wcslen(dst);
372 if (flags & VIS_GLOB)
373 for (s = char_glob; *s; *d++ = *s++)
376 if (flags & VIS_SHELL)
377 for (s = char_shell; *s; *d++ = *s++)
380 if (flags & VIS_SP) *d++ = L' ';
381 if (flags & VIS_TAB) *d++ = L'\t';
382 if (flags & VIS_NL) *d++ = L'\n';
383 if (flags & VIS_DQ) *d++ = L'"';
384 if ((flags & VIS_NOSLASH) == 0) *d++ = L'\\';
392 * The main internal function.
393 * All user-visible functions call this one.
396 istrsenvisx(char **mbdstp, size_t *dlen, const char *mbsrc, size_t mblength,
397 int flags, const char *mbextra, int *cerr_ptr)
399 char mbbuf[MB_LEN_MAX];
400 wchar_t *dst, *src, *pdst, *psrc, *start, *extra;
405 int clen = 0, cerr, error = -1, i, shft;
406 char *mbdst, *mbwrite, *mdst;
411 _DIAGASSERT(mbdstp != NULL);
412 _DIAGASSERT(mbsrc != NULL || mblength == 0);
413 _DIAGASSERT(mbextra != NULL);
415 mbslength = mblength;
417 * When inputing a single character, must also read in the
418 * next character for nextc, the look-ahead character.
424 * Input (mbsrc) is a char string considered to be multibyte
425 * characters. The input loop will read this string pulling
426 * one character, possibly multiple bytes, from mbsrc and
427 * converting each to wchar_t in src.
429 * The vis conversion will be done using the wide char
432 * This will then be converted back to a multibyte string to
433 * return to the caller.
437 * Guarantee the arithmetic on input to calloc won't overflow.
439 if (mbslength > (SIZE_MAX - 1)/16) {
444 /* Allocate space for the wide char strings */
445 psrc = pdst = extra = NULL;
447 if ((psrc = calloc(mbslength + 1, sizeof(*psrc))) == NULL)
449 if ((pdst = calloc((16 * mbslength) + 1, sizeof(*pdst))) == NULL)
451 if (*mbdstp == NULL) {
452 if ((mdst = calloc((16 * mbslength) + 1, sizeof(*mdst))) == NULL)
461 if (flags & VIS_NOLOCALE) {
462 /* Do one byte at a time conversion */
465 /* Use caller's multibyte conversion error flag. */
466 cerr = cerr_ptr ? *cerr_ptr : 0;
471 * Handle up to mblength characters (not bytes). We do not
472 * stop at NULs because we may be processing a block of data
473 * that includes NULs.
475 memset(&mbstate, 0, sizeof(mbstate));
476 while (mbslength > 0) {
477 /* Convert one multibyte character to wchar_t. */
479 clen = mbrtowc(src, mbsrc,
480 (mbslength < MB_LEN_MAX
484 assert(clen < 0 || (size_t)clen <= mbslength);
485 assert(clen <= MB_LEN_MAX);
487 if (cerr || clen < 0) {
488 /* Conversion error, process as a byte instead. */
489 *src = (wint_t)(u_char)*mbsrc;
495 * NUL in input gives 0 return value. process
496 * as single NUL byte and keep going.
501 * Let n := MIN(mbslength, MB_LEN_MAX). We have:
504 * mbrtowc(..., n, &mbstate) <= n,
505 * by the contract of mbrtowc
508 * (a) mbrtowc(..., n, &mbstate), in which case
509 * clen <= n <= mbslength; or
510 * (b) 1, in which case clen = 1 <= mbslength.
513 assert((size_t)clen <= mbslength);
514 /* Advance buffer character pointer. */
516 /* Advance input pointer by number of bytes read. */
518 /* Decrement input byte count. */
525 * In the single character input case, we will have actually
526 * processed two characters, c and nextc. Reset len back to
527 * just a single character.
532 /* Convert extra argument to list of characters for this mode. */
533 extra = makeextralist(flags, mbextra);
535 if (dlen && *dlen == 0) {
539 *mbdst = '\0'; /* can't create extra, return "" */
544 /* Look up which processing function to call. */
545 f = getvisfun(flags);
548 * Main processing loop.
549 * Call do_Xvis processing function one character at a time
550 * with next character available for look-ahead.
552 for (start = dst; len > 0; len--) {
554 dst = (*f)(dst, c, flags, len >= 1 ? *src : L'\0', extra);
561 /* Terminate the string in the buffer. */
566 * Convert wchar_t string back to multibyte output string.
567 * If we have hit a multi-byte conversion error on input,
568 * output byte-by-byte here. Else use wctomb().
578 if (len > (SIZE_MAX - 1)/MB_LEN_MAX) {
582 maxolen = len*MB_LEN_MAX + 1;
585 memset(&mbstate, 0, sizeof(mbstate));
586 for (dst = start; len > 0; len--) {
589 * If we have at least MB_CUR_MAX bytes in the buffer,
590 * we'll just do the conversion in-place into mbdst. We
591 * need to be a little more conservative when we get to
592 * the end of the buffer, as we may not have MB_CUR_MAX
593 * bytes but we may not need it.
595 if (maxolen - olen > MB_CUR_MAX)
599 clen = wcrtomb(mbwrite, *dst, &mbstate);
600 if (clen > 0 && mbwrite != mbdst) {
602 * Don't break past our output limit, noting
603 * that maxolen includes the nul terminator so
604 * we can't write past maxolen - 1 here.
606 if (olen + clen >= maxolen) {
611 memcpy(mbdst, mbwrite, clen);
614 if (cerr || clen < 0) {
616 * Conversion error, process as a byte(s) instead.
617 * Examine each byte and higher-order bytes for
619 * 0x000000000000a264 -> a2 64
620 * 0x000000001f00a264 -> 1f 00 a2 64
624 for (i = sizeof(wmsk) - 1; i >= 0; i--) {
626 bmsk = (uint64_t)0xffLL << shft;
628 if ((*dst & wmsk) || i == 0) {
629 if (olen + clen + 1 >= maxolen) {
634 mbdst[clen++] = (char)(
635 (uint64_t)(*dst & bmsk) >>
643 * We'll be dereferencing mbdst[clen] after this to write the
644 * nul terminator; the above paths should have checked for a
645 * possible overflow already.
647 assert(olen + clen < maxolen);
649 /* Advance output pointer by number of bytes written. */
651 /* Advance buffer character pointer. */
653 /* Incrment output character count. */
657 /* Terminate the output string. */
658 assert(olen < maxolen);
661 if (flags & VIS_NOLOCALE) {
662 /* Pass conversion error flag out. */
681 istrsenvisxl(char **mbdstp, size_t *dlen, const char *mbsrc,
682 int flags, const char *mbextra, int *cerr_ptr)
684 return istrsenvisx(mbdstp, dlen, mbsrc,
685 mbsrc != NULL ? strlen(mbsrc) : 0, flags, mbextra, cerr_ptr);
692 * The "svis" variants all take an "extra" arg that is a pointer
693 * to a NUL-terminated list of characters to be encoded, too.
694 * These functions are useful e. g. to encode strings in such a
695 * way so that they are not interpreted by a shell.
699 svis(char *mbdst, int c, int flags, int nextc, const char *mbextra)
707 ret = istrsenvisx(&mbdst, NULL, cc, 1, flags, mbextra, NULL);
714 snvis(char *mbdst, size_t dlen, int c, int flags, int nextc, const char *mbextra)
722 ret = istrsenvisx(&mbdst, &dlen, cc, 1, flags, mbextra, NULL);
729 strsvis(char *mbdst, const char *mbsrc, int flags, const char *mbextra)
731 return istrsenvisxl(&mbdst, NULL, mbsrc, flags, mbextra, NULL);
735 strsnvis(char *mbdst, size_t dlen, const char *mbsrc, int flags, const char *mbextra)
737 return istrsenvisxl(&mbdst, &dlen, mbsrc, flags, mbextra, NULL);
741 strsvisx(char *mbdst, const char *mbsrc, size_t len, int flags, const char *mbextra)
743 return istrsenvisx(&mbdst, NULL, mbsrc, len, flags, mbextra, NULL);
747 strsnvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags,
750 return istrsenvisx(&mbdst, &dlen, mbsrc, len, flags, mbextra, NULL);
754 strsenvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags,
755 const char *mbextra, int *cerr_ptr)
757 return istrsenvisx(&mbdst, &dlen, mbsrc, len, flags, mbextra, cerr_ptr);
763 * vis - visually encode characters
766 vis(char *mbdst, int c, int flags, int nextc)
774 ret = istrsenvisx(&mbdst, NULL, cc, 1, flags, "", NULL);
781 nvis(char *mbdst, size_t dlen, int c, int flags, int nextc)
789 ret = istrsenvisx(&mbdst, &dlen, cc, 1, flags, "", NULL);
796 * strvis - visually encode characters from src into dst
798 * Dst must be 4 times the size of src to account for possible
799 * expansion. The length of dst, not including the trailing NULL,
804 strvis(char *mbdst, const char *mbsrc, int flags)
806 return istrsenvisxl(&mbdst, NULL, mbsrc, flags, "", NULL);
810 strnvis(char *mbdst, size_t dlen, const char *mbsrc, int flags)
812 return istrsenvisxl(&mbdst, &dlen, mbsrc, flags, "", NULL);
816 stravis(char **mbdstp, const char *mbsrc, int flags)
819 return istrsenvisxl(mbdstp, NULL, mbsrc, flags, "", NULL);
823 * strvisx - visually encode characters from src into dst
825 * Dst must be 4 times the size of src to account for possible
826 * expansion. The length of dst, not including the trailing NULL,
829 * Strvisx encodes exactly len characters from src into dst.
830 * This is useful for encoding a block of data.
834 strvisx(char *mbdst, const char *mbsrc, size_t len, int flags)
836 return istrsenvisx(&mbdst, NULL, mbsrc, len, flags, "", NULL);
840 strnvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags)
842 return istrsenvisx(&mbdst, &dlen, mbsrc, len, flags, "", NULL);
846 strenvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags,
849 return istrsenvisx(&mbdst, &dlen, mbsrc, len, flags, "", cerr_ptr);