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 "namespace.h"
59 #include <sys/types.h>
60 #include <sys/param.h>
70 __weak_alias(strvisx
,_strvisx
)
73 #if !HAVE_VIS || !HAVE_SVIS
80 * The reason for going through the trouble to deal with character encodings
81 * in vis(3), is that we use this to safe encode output of commands. This
82 * safe encoding varies depending on the character set. For example if we
83 * display ps output in French, we don't want to display French characters
87 static wchar_t *do_svis(wchar_t *, wint_t, int, wint_t, const wchar_t *);
92 #if defined(LC_C_LOCALE)
93 #define iscgraph(c) isgraph_l(c, LC_C_LOCALE)
95 /* Keep it simple for now, no locale stuff */
96 #define iscgraph(c) isgraph(c)
104 ol
= setlocale(LC_CTYPE
, "C");
107 setlocale(LC_CTYPE
, ol
);
113 #define ISGRAPH(flags, c) \
114 (((flags) & VIS_NOLOCALE) ? iscgraph(c) : iswgraph(c))
116 #define iswoctal(c) (((u_char)(c)) >= L'0' && ((u_char)(c)) <= L'7')
117 #define iswwhite(c) (c == L' ' || c == L'\t' || c == L'\n')
118 #define iswsafe(c) (c == L'\b' || c == BELL || c == L'\r')
119 #define xtoa(c) L"0123456789abcdef"[c]
120 #define XTOA(c) L"0123456789ABCDEF"[c]
124 static const wchar_t char_shell
[] = L
"'`\";&<>()|{}]\\$!^~";
125 static const wchar_t char_glob
[] = L
"*?[#";
127 #if !HAVE_NBTOOL_CONFIG_H
130 * On NetBSD MB_LEN_MAX is currently 32 which does not fit on any integer
131 * integral type and it is probably wrong, since currently the maximum
132 * number of bytes and character needs is 6. Until this is fixed, the
133 * loops below are using sizeof(uint64_t) - 1 instead of MB_LEN_MAX, and
134 * the assertion is commented out.
136 #if defined(__FreeBSD__) || defined(__DragonFly__)
138 * On FreeBSD and DragonFly, including <sys/systm.h> for CTASSERT only
139 * works in kernel mode.
142 #define CTASSERT(x) _CTASSERT(x, __LINE__)
143 #define _CTASSERT(x, y) __CTASSERT(x, y)
144 #define __CTASSERT(x, y) typedef char __assert ## y[(x) ? 1 : -1]
146 #endif /* __FreeBSD__ || __DragonFly__ */
147 CTASSERT(MB_LEN_MAX
<= sizeof(uint64_t));
148 #endif /* !__NetBSD__ */
152 * This is do_hvis, for HTTP style (RFC 1808)
155 do_hvis(wchar_t *dst
, wint_t c
, int flags
, wint_t nextc
, const wchar_t *extra
)
159 || c
== L
'$' || c
== L
'-' || c
== L
'_' || c
== L
'.' || c
== L
'+'
161 || c
== L
'!' || c
== L
'*' || c
== L
'\'' || c
== L
'(' || c
== L
')'
163 dst
= do_svis(dst
, c
, flags
, nextc
, extra
);
166 *dst
++ = xtoa(((unsigned int)c
>> 4) & 0xf);
167 *dst
++ = xtoa((unsigned int)c
& 0xf);
174 * This is do_mvis, for Quoted-Printable MIME (RFC 2045)
175 * NB: No handling of long lines or CRLF.
178 do_mvis(wchar_t *dst
, wint_t c
, int flags
, wint_t nextc
, const wchar_t *extra
)
181 /* Space at the end of the line */
182 ((iswspace(c
) && (nextc
== L
'\r' || nextc
== L
'\n')) ||
184 (!iswspace(c
) && (c
< 33 || (c
> 60 && c
< 62) || c
> 126)) ||
185 /* Specific char to be escaped */
186 wcschr(L
"#$@[\\]^`{|}~", c
) != NULL
)) {
188 *dst
++ = XTOA(((unsigned int)c
>> 4) & 0xf);
189 *dst
++ = XTOA((unsigned int)c
& 0xf);
191 dst
= do_svis(dst
, c
, flags
, nextc
, extra
);
196 * Output single byte of multibyte character.
199 do_mbyte(wchar_t *dst
, wint_t c
, int flags
, wint_t nextc
, int iswextra
)
201 if (flags
& VIS_CSTYLE
) {
204 *dst
++ = L
'\\'; *dst
++ = L
'n';
207 *dst
++ = L
'\\'; *dst
++ = L
'r';
210 *dst
++ = L
'\\'; *dst
++ = L
'b';
213 *dst
++ = L
'\\'; *dst
++ = L
'a';
216 *dst
++ = L
'\\'; *dst
++ = L
'v';
219 *dst
++ = L
'\\'; *dst
++ = L
't';
222 *dst
++ = L
'\\'; *dst
++ = L
'f';
225 *dst
++ = L
'\\'; *dst
++ = L
's';
228 *dst
++ = L
'\\'; *dst
++ = L
'0';
229 if (iswoctal(nextc
)) {
234 /* We cannot encode these characters in VIS_CSTYLE
235 * because they special meaning */
251 case L
'$': /* vis(1) -l */
254 if (ISGRAPH(flags
, c
) && !iswoctal(c
)) {
261 if (iswextra
|| ((c
& 0177) == L
' ') || (flags
& VIS_OCTAL
)) {
263 *dst
++ = (u_char
)(((u_int32_t
)(u_char
)c
>> 6) & 03) + L
'0';
264 *dst
++ = (u_char
)(((u_int32_t
)(u_char
)c
>> 3) & 07) + L
'0';
265 *dst
++ = (c
& 07) + L
'0';
267 if ((flags
& VIS_NOSLASH
) == 0)
291 * This is do_vis, the central code of vis.
292 * dst: Pointer to the destination buffer
293 * c: Character to encode
295 * nextc: The character following 'c'
296 * extra: Pointer to the list of extra characters to be
297 * backslash-protected.
300 do_svis(wchar_t *dst
, wint_t c
, int flags
, wint_t nextc
, const wchar_t *extra
)
302 int iswextra
, i
, shft
;
305 iswextra
= wcschr(extra
, c
) != NULL
;
306 if (((flags
& VIS_ALL
) == 0) &&
308 (ISGRAPH(flags
, c
) || iswwhite(c
) ||
309 ((flags
& VIS_SAFE
) && iswsafe(c
)))) {
314 /* See comment in istrsenvisx() output loop, below. */
316 for (i
= sizeof(wmsk
) - 1; i
>= 0; i
--) {
318 bmsk
= (uint64_t)0xffLL
<< shft
;
320 if ((c
& wmsk
) || i
== 0)
321 dst
= do_mbyte(dst
, (wint_t)(
322 (uint64_t)(c
& bmsk
) >> shft
),
323 flags
, nextc
, iswextra
);
329 typedef wchar_t *(*visfun_t
)(wchar_t *, wint_t, int, wint_t, const wchar_t *);
332 * Return the appropriate encoding function depending on the flags given.
337 if (flags
& VIS_HTTPSTYLE
)
339 if (flags
& VIS_MIMESTYLE
)
345 * Expand list of extra characters to not visually encode.
348 makeextralist(int flags
, const char *src
)
355 if ((dst
= calloc(len
+ MAXEXTRAS
, sizeof(*dst
))) == NULL
)
358 if ((flags
& VIS_NOLOCALE
) || mbstowcs(dst
, src
, len
) == (size_t)-1) {
360 for (i
= 0; i
< len
; i
++)
361 dst
[i
] = (wchar_t)(u_char
)src
[i
];
364 d
= dst
+ wcslen(dst
);
366 if (flags
& VIS_GLOB
)
367 for (s
= char_glob
; *s
; *d
++ = *s
++)
370 if (flags
& VIS_SHELL
)
371 for (s
= char_shell
; *s
; *d
++ = *s
++)
374 if (flags
& VIS_SP
) *d
++ = L
' ';
375 if (flags
& VIS_TAB
) *d
++ = L
'\t';
376 if (flags
& VIS_NL
) *d
++ = L
'\n';
377 if (flags
& VIS_DQ
) *d
++ = L
'"';
378 if ((flags
& VIS_NOSLASH
) == 0) *d
++ = L
'\\';
386 * The main internal function.
387 * All user-visible functions call this one.
390 istrsenvisx(char **mbdstp
, size_t *dlen
, const char *mbsrc
, size_t mblength
,
391 int flags
, const char *mbextra
, int *cerr_ptr
)
393 wchar_t *dst
, *src
, *pdst
, *psrc
, *start
, *extra
;
398 int clen
= 0, cerr
, error
= -1, i
, shft
;
400 ssize_t mbslength
, maxolen
;
402 _DIAGASSERT(mbdstp
!= NULL
);
403 _DIAGASSERT(mbsrc
!= NULL
|| mblength
== 0);
404 _DIAGASSERT(mbextra
!= NULL
);
406 mbslength
= (ssize_t
)mblength
;
408 * When inputing a single character, must also read in the
409 * next character for nextc, the look-ahead character.
415 * Input (mbsrc) is a char string considered to be multibyte
416 * characters. The input loop will read this string pulling
417 * one character, possibly multiple bytes, from mbsrc and
418 * converting each to wchar_t in src.
420 * The vis conversion will be done using the wide char
423 * This will then be converted back to a multibyte string to
424 * return to the caller.
427 /* Allocate space for the wide char strings */
428 psrc
= pdst
= extra
= NULL
;
430 if ((psrc
= calloc(mbslength
+ 1, sizeof(*psrc
))) == NULL
)
432 if ((pdst
= calloc((16 * mbslength
) + 1, sizeof(*pdst
))) == NULL
)
434 if (*mbdstp
== NULL
) {
435 if ((mdst
= calloc((16 * mbslength
) + 1, sizeof(*mdst
))) == NULL
)
444 if (flags
& VIS_NOLOCALE
) {
445 /* Do one byte at a time conversion */
448 /* Use caller's multibyte conversion error flag. */
449 cerr
= cerr_ptr
? *cerr_ptr
: 0;
454 * Handle up to mblength characters (not bytes). We do not
455 * stop at NULs because we may be processing a block of data
456 * that includes NULs.
458 while (mbslength
> 0) {
459 /* Convert one multibyte character to wchar_t. */
461 clen
= mbtowc(src
, mbsrc
, MB_LEN_MAX
);
462 if (cerr
|| clen
< 0) {
463 /* Conversion error, process as a byte instead. */
464 *src
= (wint_t)(u_char
)*mbsrc
;
470 * NUL in input gives 0 return value. process
471 * as single NUL byte and keep going.
475 /* Advance buffer character pointer. */
477 /* Advance input pointer by number of bytes read. */
479 /* Decrement input byte count. */
486 * In the single character input case, we will have actually
487 * processed two characters, c and nextc. Reset len back to
488 * just a single character.
493 /* Convert extra argument to list of characters for this mode. */
494 extra
= makeextralist(flags
, mbextra
);
496 if (dlen
&& *dlen
== 0) {
500 *mbdst
= '\0'; /* can't create extra, return "" */
505 /* Look up which processing function to call. */
506 f
= getvisfun(flags
);
509 * Main processing loop.
510 * Call do_Xvis processing function one character at a time
511 * with next character available for look-ahead.
513 for (start
= dst
; len
> 0; len
--) {
515 dst
= (*f
)(dst
, c
, flags
, len
>= 1 ? *src
: L
'\0', extra
);
522 /* Terminate the string in the buffer. */
527 * Convert wchar_t string back to multibyte output string.
528 * If we have hit a multi-byte conversion error on input,
529 * output byte-by-byte here. Else use wctomb().
532 maxolen
= dlen
? *dlen
: (wcslen(start
) * MB_LEN_MAX
+ 1);
534 for (dst
= start
; len
> 0; len
--) {
536 clen
= wctomb(mbdst
, *dst
);
537 if (cerr
|| clen
< 0) {
539 * Conversion error, process as a byte(s) instead.
540 * Examine each byte and higher-order bytes for
542 * 0x000000000000a264 -> a2 64
543 * 0x000000001f00a264 -> 1f 00 a2 64
547 for (i
= sizeof(wmsk
) - 1; i
>= 0; i
--) {
549 bmsk
= (uint64_t)0xffLL
<< shft
;
551 if ((*dst
& wmsk
) || i
== 0)
552 mbdst
[clen
++] = (char)(
553 (uint64_t)(*dst
& bmsk
) >>
558 /* If this character would exceed our output limit, stop. */
559 if (olen
+ clen
> (size_t)maxolen
)
561 /* Advance output pointer by number of bytes written. */
563 /* Advance buffer character pointer. */
565 /* Incrment output character count. */
569 /* Terminate the output string. */
572 if (flags
& VIS_NOLOCALE
) {
573 /* Pass conversion error flag out. */
592 istrsenvisxl(char **mbdstp
, size_t *dlen
, const char *mbsrc
,
593 int flags
, const char *mbextra
, int *cerr_ptr
)
595 return istrsenvisx(mbdstp
, dlen
, mbsrc
,
596 mbsrc
!= NULL
? strlen(mbsrc
) : 0, flags
, mbextra
, cerr_ptr
);
603 * The "svis" variants all take an "extra" arg that is a pointer
604 * to a NUL-terminated list of characters to be encoded, too.
605 * These functions are useful e. g. to encode strings in such a
606 * way so that they are not interpreted by a shell.
610 svis(char *mbdst
, int c
, int flags
, int nextc
, const char *mbextra
)
618 ret
= istrsenvisx(&mbdst
, NULL
, cc
, 1, flags
, mbextra
, NULL
);
625 snvis(char *mbdst
, size_t dlen
, int c
, int flags
, int nextc
, const char *mbextra
)
633 ret
= istrsenvisx(&mbdst
, &dlen
, cc
, 1, flags
, mbextra
, NULL
);
640 strsvis(char *mbdst
, const char *mbsrc
, int flags
, const char *mbextra
)
642 return istrsenvisxl(&mbdst
, NULL
, mbsrc
, flags
, mbextra
, NULL
);
646 strsnvis(char *mbdst
, size_t dlen
, const char *mbsrc
, int flags
, const char *mbextra
)
648 return istrsenvisxl(&mbdst
, &dlen
, mbsrc
, flags
, mbextra
, NULL
);
652 strsvisx(char *mbdst
, const char *mbsrc
, size_t len
, int flags
, const char *mbextra
)
654 return istrsenvisx(&mbdst
, NULL
, mbsrc
, len
, flags
, mbextra
, NULL
);
658 strsnvisx(char *mbdst
, size_t dlen
, const char *mbsrc
, size_t len
, int flags
,
661 return istrsenvisx(&mbdst
, &dlen
, mbsrc
, len
, flags
, mbextra
, NULL
);
665 strsenvisx(char *mbdst
, size_t dlen
, const char *mbsrc
, size_t len
, int flags
,
666 const char *mbextra
, int *cerr_ptr
)
668 return istrsenvisx(&mbdst
, &dlen
, mbsrc
, len
, flags
, mbextra
, cerr_ptr
);
674 * vis - visually encode characters
677 vis(char *mbdst
, int c
, int flags
, int nextc
)
685 ret
= istrsenvisx(&mbdst
, NULL
, cc
, 1, flags
, "", NULL
);
692 nvis(char *mbdst
, size_t dlen
, int c
, int flags
, int nextc
)
700 ret
= istrsenvisx(&mbdst
, &dlen
, cc
, 1, flags
, "", NULL
);
707 * strvis - visually encode characters from src into dst
709 * Dst must be 4 times the size of src to account for possible
710 * expansion. The length of dst, not including the trailing NULL,
715 strvis(char *mbdst
, const char *mbsrc
, int flags
)
717 return istrsenvisxl(&mbdst
, NULL
, mbsrc
, flags
, "", NULL
);
721 strnvis(char *dst
, const char *src
, size_t len
, int flag
)
723 return istrsenvisxl(&dst
, &len
, src
, flag
, "", NULL
);
727 stravis(char **mbdstp
, const char *mbsrc
, int flags
)
730 return istrsenvisxl(mbdstp
, NULL
, mbsrc
, flags
, "", NULL
);
734 * strvisx - visually encode characters from src into dst
736 * Dst must be 4 times the size of src to account for possible
737 * expansion. The length of dst, not including the trailing NULL,
740 * Strvisx encodes exactly len characters from src into dst.
741 * This is useful for encoding a block of data.
745 strvisx(char *mbdst
, const char *mbsrc
, size_t len
, int flags
)
747 return istrsenvisx(&mbdst
, NULL
, mbsrc
, len
, flags
, "", NULL
);
751 strnvisx(char *mbdst
, size_t dlen
, const char *mbsrc
, size_t len
, int flags
)
753 return istrsenvisx(&mbdst
, &dlen
, mbsrc
, len
, flags
, "", NULL
);
757 strenvisx(char *mbdst
, size_t dlen
, const char *mbsrc
, size_t len
, int flags
,
760 return istrsenvisx(&mbdst
, &dlen
, mbsrc
, len
, flags
, "", cerr_ptr
);