2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1989, 1993, 1994
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 static char sccsid[] = "@(#)print.c 8.4 (Berkeley) 4/17/94";
40 #include <sys/cdefs.h>
41 __FBSDID("$FreeBSD$");
43 #include <sys/param.h>
69 static int printaname(const FTSENT *, u_long, u_long);
70 static void printdev(size_t, dev_t);
71 static void printlink(const FTSENT *);
72 static void printtime(time_t);
73 static int printtype(u_int);
74 static void printsize(size_t, off_t);
76 static void endcolor_termcap(int);
77 static void endcolor_ansi(void);
78 static void endcolor(int);
79 static int colortype(mode_t);
81 static void aclmode(char *, const FTSENT *);
83 #define IS_NOPRINT(p) ((p)->fts_number == NO_PRINT)
86 /* Most of these are taken from <sys/stat.h> */
88 C_DIR, /* directory */
89 C_LNK, /* symbolic link */
92 C_EXEC, /* executable */
93 C_BLK, /* block special */
94 C_CHR, /* character special */
95 C_SUID, /* setuid executable */
96 C_SGID, /* setgid executable */
97 C_WSDIR, /* directory writeble to others, with sticky
99 C_WDIR, /* directory writeble to others, without
101 C_NUMCOLORS /* just a place-holder */
104 static const char *defcolors = "exfxcxdxbxegedabagacad";
106 /* colors for file types */
110 } colors[C_NUMCOLORS];
113 static size_t padding_for_month[12];
114 static size_t month_max_size = 0;
117 printscol(const DISPLAY *dp)
121 for (p = dp->list; p; p = p->fts_link) {
124 (void)printaname(p, dp->s_inode, dp->s_block);
130 * print name in current style
133 printname(const char *name)
135 if (f_octal || f_octal_escape)
136 return prn_octal(name);
138 return prn_printable(name);
140 return prn_normal(name);
148 case 0: return (nl_langinfo(ABMON_1));
149 case 1: return (nl_langinfo(ABMON_2));
150 case 2: return (nl_langinfo(ABMON_3));
151 case 3: return (nl_langinfo(ABMON_4));
152 case 4: return (nl_langinfo(ABMON_5));
153 case 5: return (nl_langinfo(ABMON_6));
154 case 6: return (nl_langinfo(ABMON_7));
155 case 7: return (nl_langinfo(ABMON_8));
156 case 8: return (nl_langinfo(ABMON_9));
157 case 9: return (nl_langinfo(ABMON_10));
158 case 10: return (nl_langinfo(ABMON_11));
159 case 11: return (nl_langinfo(ABMON_12));
162 /* should never happen */
167 mbswidth(const char *month)
170 size_t width, donelen, clen, w;
173 while ((clen = mbrtowc(&wc, month + donelen, MB_LEN_MAX, NULL)) != 0) {
174 if (clen == (size_t)-1 || clen == (size_t)-2)
177 if ((w = wcwidth(wc)) == (size_t)-1)
186 compute_abbreviated_month_size(void)
190 size_t months_width[12];
192 for (i = 0; i < 12; i++) {
193 width = mbswidth(get_abmon(i));
194 if (width == (size_t)-1) {
198 months_width[i] = width;
199 if (width > month_max_size)
200 month_max_size = width;
203 for (i = 0; i < 12; i++)
204 padding_for_month[i] = month_max_size - months_width[i];
208 printlong(const DISPLAY *dp)
215 int color_printed = 0;
218 if ((dp->list == NULL || dp->list->fts_level != FTS_ROOTLEVEL) &&
219 (f_longform || f_size)) {
220 (void)printf("total %lu\n", howmany(dp->btotal, blocksize));
223 for (p = dp->list; p; p = p->fts_link) {
228 (void)printf("%*ju ",
229 dp->s_inode, (uintmax_t)sp->st_ino);
231 (void)printf("%*jd ",
232 dp->s_block, howmany(sp->st_blocks, blocksize));
233 strmode(sp->st_mode, buf);
236 (void)printf("%s %*ju %-*s %-*s ", buf, dp->s_nlink,
237 (uintmax_t)sp->st_nlink, dp->s_user, np->user, dp->s_group,
240 (void)printf("%-*s ", dp->s_flags, np->flags);
242 (void)printf("%-*s ", dp->s_label, np->label);
243 if (S_ISCHR(sp->st_mode) || S_ISBLK(sp->st_mode))
244 printdev(dp->s_size, sp->st_rdev);
246 printsize(dp->s_size, sp->st_size);
248 printtime(sp->st_atime);
249 else if (f_birthtime)
250 printtime(sp->st_birthtime);
251 else if (f_statustime)
252 printtime(sp->st_ctime);
254 printtime(sp->st_mtime);
257 color_printed = colortype(sp->st_mode);
259 (void)printname(p->fts_name);
261 if (f_color && color_printed)
265 (void)printtype(sp->st_mode);
266 if (S_ISLNK(sp->st_mode))
273 printstream(const DISPLAY *dp)
278 for (p = dp->list, chcnt = 0; p; p = p->fts_link) {
279 if (p->fts_number == NO_PRINT)
281 /* XXX strlen does not take octal escapes into account. */
282 if (strlen(p->fts_name) + chcnt +
283 (p->fts_link ? 2 : 0) >= (unsigned)termwidth) {
287 chcnt += printaname(p, dp->s_inode, dp->s_block);
298 printcol(const DISPLAY *dp)
300 static FTSENT **array;
301 static int lastentries = -1;
322 * Have to do random access in the linked list -- build a table
325 if (dp->entries > lastentries) {
327 realloc(array, dp->entries * sizeof(FTSENT *))) == NULL) {
332 lastentries = dp->entries;
335 for (p = dp->list, num = 0; p; p = p->fts_link)
336 if (p->fts_number != NO_PRINT)
339 colwidth = dp->maxlen;
341 colwidth += dp->s_inode + 1;
343 colwidth += dp->s_block + 1;
347 colwidth = (colwidth + tabwidth) & ~(tabwidth - 1);
348 if (termwidth < 2 * colwidth) {
352 numcols = termwidth / colwidth;
353 numrows = num / numcols;
357 if ((dp->list == NULL || dp->list->fts_level != FTS_ROOTLEVEL) &&
358 (f_longform || f_size)) {
359 (void)printf("total %lu\n", howmany(dp->btotal, blocksize));
363 for (row = 0; row < numrows; ++row) {
367 for (col = 0, chcnt = 0; col < numcols; ++col) {
368 chcnt += printaname(array[base], dp->s_inode,
376 while ((cnt = ((chcnt + tabwidth) & ~(tabwidth - 1)))
378 if (f_sortacross && col + 1 >= numcols)
380 (void)putchar(f_notabs ? ' ' : '\t');
390 * print [inode] [size] name
391 * return # of characters printed, no trailing characters.
394 printaname(const FTSENT *p, u_long inodefield, u_long sizefield)
399 int color_printed = 0;
405 chcnt += printf("%*ju ",
406 (int)inodefield, (uintmax_t)sp->st_ino);
408 chcnt += printf("%*jd ",
409 (int)sizefield, howmany(sp->st_blocks, blocksize));
412 color_printed = colortype(sp->st_mode);
414 chcnt += printname(p->fts_name);
416 if (f_color && color_printed)
420 chcnt += printtype(sp->st_mode);
425 * Print device special file major and minor numbers.
428 printdev(size_t width, dev_t dev)
431 (void)printf("%#*jx ", (u_int)width, (uintmax_t)dev);
435 ls_strftime(char *str, size_t len, const char *fmt, const struct tm *tm)
437 char *posb, nfmt[BUFSIZ];
438 const char *format = fmt;
441 if ((posb = strstr(fmt, "%b")) != NULL) {
442 if (month_max_size == 0) {
443 compute_abbreviated_month_size();
445 if (month_max_size > 0) {
446 snprintf(nfmt, sizeof(nfmt), "%.*s%s%*s%s",
447 (int)(posb - fmt), fmt,
448 get_abmon(tm->tm_mon),
449 (int)padding_for_month[tm->tm_mon],
455 ret = strftime(str, len, format, tm);
460 printtime(time_t ftime)
463 static time_t now = 0;
465 static int d_first = -1;
468 d_first = (*nl_langinfo(D_MD_ORDER) == 'd');
472 #define SIXMONTHS ((365 / 2) * 86400)
473 if (f_timeformat) /* user specified format */
474 format = f_timeformat;
476 /* mmm dd hh:mm:ss yyyy || dd mmm hh:mm:ss yyyy */
477 format = d_first ? "%e %b %T %Y" : "%b %e %T %Y";
478 else if (ftime + SIXMONTHS > now && ftime < now + SIXMONTHS)
479 /* mmm dd hh:mm || dd mmm hh:mm */
480 format = d_first ? "%e %b %R" : "%b %e %R";
482 /* mmm dd yyyy || dd mmm yyyy */
483 format = d_first ? "%e %b %Y" : "%b %e %Y";
484 ls_strftime(longstring, sizeof(longstring), format, localtime(&ftime));
485 fputs(longstring, stdout);
490 printtype(u_int mode)
494 if ((mode & S_IFMT) == S_IFDIR) {
501 switch (mode & S_IFMT) {
520 if (mode & (S_IXUSR | S_IXGRP | S_IXOTH)) {
540 (void)write(STDOUT_FILENO, &tmp, 1);
545 printcolor_termcap(Colors c)
550 tputs(enter_bold, 1, putch);
552 if (colors[c].num[0] != -1) {
553 ansiseq = tgoto(ansi_fgcol, 0, colors[c].num[0]);
555 tputs(ansiseq, 1, putch);
557 if (colors[c].num[1] != -1) {
558 ansiseq = tgoto(ansi_bgcol, 0, colors[c].num[1]);
560 tputs(ansiseq, 1, putch);
565 printcolor_ansi(Colors c)
572 if (colors[c].num[0] != -1)
573 printf(";3%d", colors[c].num[0]);
574 if (colors[c].num[1] != -1)
575 printf(";4%d", colors[c].num[1]);
586 printcolor_termcap(c);
590 endcolor_termcap(int sig)
593 tputs(ansi_coloff, 1, sig ? writech : putch);
594 tputs(attrs_off, 1, sig ? writech : putch);
611 endcolor_termcap(sig);
615 colortype(mode_t mode)
617 switch (mode & S_IFMT) {
644 if (mode & (S_IXUSR | S_IXGRP | S_IXOTH)) {
647 else if (mode & S_ISGID)
657 parsecolors(const char *cs)
663 short legacy_warn = 0;
666 cs = ""; /* LSCOLORS not set */
668 for (i = 0; i < (int)C_NUMCOLORS; i++) {
671 if (len <= 2 * (size_t)i) {
672 c[0] = defcolors[2 * i];
673 c[1] = defcolors[2 * i + 1];
676 c[1] = cs[2 * i + 1];
678 for (j = 0; j < 2; j++) {
679 /* Legacy colours used 0-7 */
680 if (c[j] >= '0' && c[j] <= '7') {
681 colors[i].num[j] = c[j] - '0';
683 warnx("LSCOLORS should use "
684 "characters a-h instead of 0-9 ("
685 "see the manual page)");
688 } else if (c[j] >= 'a' && c[j] <= 'h')
689 colors[i].num[j] = c[j] - 'a';
690 else if (c[j] >= 'A' && c[j] <= 'H') {
691 colors[i].num[j] = c[j] - 'A';
693 } else if (tolower((unsigned char)c[j]) == 'x')
694 colors[i].num[j] = -1;
696 warnx("invalid character '%c' in LSCOLORS"
698 colors[i].num[j] = -1;
709 (void)signal(sig, SIG_DFL);
710 (void)kill(getpid(), sig);
716 printlink(const FTSENT *p)
719 char name[MAXPATHLEN + 1];
720 char path[MAXPATHLEN + 1];
722 if (p->fts_level == FTS_ROOTLEVEL)
723 (void)snprintf(name, sizeof(name), "%s", p->fts_name);
725 (void)snprintf(name, sizeof(name),
726 "%s/%s", p->fts_parent->fts_accpath, p->fts_name);
727 if ((lnklen = readlink(name, path, sizeof(path) - 1)) == -1) {
728 (void)fprintf(stderr, "\nls: %s: %s\n", name, strerror(errno));
732 (void)printf(" -> ");
733 (void)printname(path);
737 printsize(size_t width, off_t bytes)
742 * Reserve one space before the size and allocate room for
745 char buf[HUMANVALSTR_LEN - 1 + 1];
747 humanize_number(buf, sizeof(buf), (int64_t)bytes, "",
748 HN_AUTOSCALE, HN_B | HN_NOSPACE | HN_DECIMAL);
749 (void)printf("%*s ", (u_int)width, buf);
750 } else if (f_thousands) { /* with commas */
751 /* This format assignment needed to work round gcc bug. */
752 const char *format = "%*j'd ";
753 (void)printf(format, (u_int)width, bytes);
755 (void)printf("%*jd ", (u_int)width, bytes);
759 * Add a + after the standard rwxrwxrwx mode if the file has an
760 * ACL. strmode() reserves space at the end of the string.
763 aclmode(char *buf, const FTSENT *p)
765 char name[MAXPATHLEN + 1];
767 static dev_t previous_dev = NODEV;
768 static int supports_acls = -1;
769 static int type = ACL_TYPE_ACCESS;
773 * XXX: ACLs are not supported on whiteouts and device files
776 if (S_ISCHR(p->fts_statp->st_mode) || S_ISBLK(p->fts_statp->st_mode) ||
777 S_ISWHT(p->fts_statp->st_mode))
780 if (previous_dev == p->fts_statp->st_dev && supports_acls == 0)
783 if (p->fts_level == FTS_ROOTLEVEL)
784 snprintf(name, sizeof(name), "%s", p->fts_name);
786 snprintf(name, sizeof(name), "%s/%s",
787 p->fts_parent->fts_accpath, p->fts_name);
789 if (previous_dev != p->fts_statp->st_dev) {
790 previous_dev = p->fts_statp->st_dev;
793 ret = lpathconf(name, _PC_ACL_NFS4);
795 type = ACL_TYPE_NFS4;
797 } else if (ret < 0 && errno != EINVAL) {
801 if (supports_acls == 0) {
802 ret = lpathconf(name, _PC_ACL_EXTENDED);
804 type = ACL_TYPE_ACCESS;
806 } else if (ret < 0 && errno != EINVAL) {
812 if (supports_acls == 0)
814 facl = acl_get_link_np(name, type);
819 if (acl_is_trivial_np(facl, &trivial)) {