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 */
111 } colors[C_NUMCOLORS];
114 static size_t padding_for_month[12];
115 static size_t month_max_size = 0;
118 printscol(const DISPLAY *dp)
122 for (p = dp->list; p; p = p->fts_link) {
125 (void)printaname(p, dp->s_inode, dp->s_block);
131 * print name in current style
134 printname(const char *name)
136 if (f_octal || f_octal_escape)
137 return prn_octal(name);
139 return prn_printable(name);
141 return prn_normal(name);
149 case 0: return (nl_langinfo(ABMON_1));
150 case 1: return (nl_langinfo(ABMON_2));
151 case 2: return (nl_langinfo(ABMON_3));
152 case 3: return (nl_langinfo(ABMON_4));
153 case 4: return (nl_langinfo(ABMON_5));
154 case 5: return (nl_langinfo(ABMON_6));
155 case 6: return (nl_langinfo(ABMON_7));
156 case 7: return (nl_langinfo(ABMON_8));
157 case 8: return (nl_langinfo(ABMON_9));
158 case 9: return (nl_langinfo(ABMON_10));
159 case 10: return (nl_langinfo(ABMON_11));
160 case 11: return (nl_langinfo(ABMON_12));
163 /* should never happen */
168 mbswidth(const char *month)
171 size_t width, donelen, clen, w;
174 while ((clen = mbrtowc(&wc, month + donelen, MB_LEN_MAX, NULL)) != 0) {
175 if (clen == (size_t)-1 || clen == (size_t)-2)
178 if ((w = wcwidth(wc)) == (size_t)-1)
187 compute_abbreviated_month_size(void)
191 size_t months_width[12];
193 for (i = 0; i < 12; i++) {
194 width = mbswidth(get_abmon(i));
195 if (width == (size_t)-1) {
199 months_width[i] = width;
200 if (width > month_max_size)
201 month_max_size = width;
204 for (i = 0; i < 12; i++)
205 padding_for_month[i] = month_max_size - months_width[i];
209 printlong(const DISPLAY *dp)
216 int color_printed = 0;
219 if ((dp->list == NULL || dp->list->fts_level != FTS_ROOTLEVEL) &&
220 (f_longform || f_size)) {
221 (void)printf("total %lu\n", howmany(dp->btotal, blocksize));
224 for (p = dp->list; p; p = p->fts_link) {
229 (void)printf("%*ju ",
230 dp->s_inode, (uintmax_t)sp->st_ino);
232 (void)printf("%*jd ",
233 dp->s_block, howmany(sp->st_blocks, blocksize));
234 strmode(sp->st_mode, buf);
237 (void)printf("%s %*ju %-*s %-*s ", buf, dp->s_nlink,
238 (uintmax_t)sp->st_nlink, dp->s_user, np->user, dp->s_group,
241 (void)printf("%-*s ", dp->s_flags, np->flags);
243 (void)printf("%-*s ", dp->s_label, np->label);
244 if (S_ISCHR(sp->st_mode) || S_ISBLK(sp->st_mode))
245 printdev(dp->s_size, sp->st_rdev);
247 printsize(dp->s_size, sp->st_size);
249 printtime(sp->st_atime);
250 else if (f_birthtime)
251 printtime(sp->st_birthtime);
252 else if (f_statustime)
253 printtime(sp->st_ctime);
255 printtime(sp->st_mtime);
258 color_printed = colortype(sp->st_mode);
260 (void)printname(p->fts_name);
262 if (f_color && color_printed)
266 (void)printtype(sp->st_mode);
267 if (S_ISLNK(sp->st_mode))
274 printstream(const DISPLAY *dp)
279 for (p = dp->list, chcnt = 0; p; p = p->fts_link) {
280 if (p->fts_number == NO_PRINT)
282 /* XXX strlen does not take octal escapes into account. */
283 if (strlen(p->fts_name) + chcnt +
284 (p->fts_link ? 2 : 0) >= (unsigned)termwidth) {
288 chcnt += printaname(p, dp->s_inode, dp->s_block);
299 printcol(const DISPLAY *dp)
301 static FTSENT **array;
302 static int lastentries = -1;
323 * Have to do random access in the linked list -- build a table
326 if (dp->entries > lastentries) {
328 realloc(array, dp->entries * sizeof(FTSENT *))) == NULL) {
333 lastentries = dp->entries;
336 for (p = dp->list, num = 0; p; p = p->fts_link)
337 if (p->fts_number != NO_PRINT)
340 colwidth = dp->maxlen;
342 colwidth += dp->s_inode + 1;
344 colwidth += dp->s_block + 1;
348 colwidth = (colwidth + tabwidth) & ~(tabwidth - 1);
349 if (termwidth < 2 * colwidth) {
353 numcols = termwidth / colwidth;
354 numrows = num / numcols;
358 if ((dp->list == NULL || dp->list->fts_level != FTS_ROOTLEVEL) &&
359 (f_longform || f_size)) {
360 (void)printf("total %lu\n", howmany(dp->btotal, blocksize));
364 for (row = 0; row < numrows; ++row) {
368 for (col = 0, chcnt = 0; col < numcols; ++col) {
369 chcnt += printaname(array[base], dp->s_inode,
377 while ((cnt = ((chcnt + tabwidth) & ~(tabwidth - 1)))
379 if (f_sortacross && col + 1 >= numcols)
381 (void)putchar(f_notabs ? ' ' : '\t');
391 * print [inode] [size] name
392 * return # of characters printed, no trailing characters.
395 printaname(const FTSENT *p, u_long inodefield, u_long sizefield)
400 int color_printed = 0;
406 chcnt += printf("%*ju ",
407 (int)inodefield, (uintmax_t)sp->st_ino);
409 chcnt += printf("%*jd ",
410 (int)sizefield, howmany(sp->st_blocks, blocksize));
413 color_printed = colortype(sp->st_mode);
415 chcnt += printname(p->fts_name);
417 if (f_color && color_printed)
421 chcnt += printtype(sp->st_mode);
426 * Print device special file major and minor numbers.
429 printdev(size_t width, dev_t dev)
432 (void)printf("%#*jx ", (u_int)width, (uintmax_t)dev);
436 ls_strftime(char *str, size_t len, const char *fmt, const struct tm *tm)
438 char *posb, nfmt[BUFSIZ];
439 const char *format = fmt;
442 if ((posb = strstr(fmt, "%b")) != NULL) {
443 if (month_max_size == 0) {
444 compute_abbreviated_month_size();
446 if (month_max_size > 0) {
447 snprintf(nfmt, sizeof(nfmt), "%.*s%s%*s%s",
448 (int)(posb - fmt), fmt,
449 get_abmon(tm->tm_mon),
450 (int)padding_for_month[tm->tm_mon],
456 ret = strftime(str, len, format, tm);
461 printtime(time_t ftime)
464 static time_t now = 0;
466 static int d_first = -1;
469 d_first = (*nl_langinfo(D_MD_ORDER) == 'd');
473 #define SIXMONTHS ((365 / 2) * 86400)
474 if (f_timeformat) /* user specified format */
475 format = f_timeformat;
477 /* mmm dd hh:mm:ss yyyy || dd mmm hh:mm:ss yyyy */
478 format = d_first ? "%e %b %T %Y" : "%b %e %T %Y";
479 else if (ftime + SIXMONTHS > now && ftime < now + SIXMONTHS)
480 /* mmm dd hh:mm || dd mmm hh:mm */
481 format = d_first ? "%e %b %R" : "%b %e %R";
483 /* mmm dd yyyy || dd mmm yyyy */
484 format = d_first ? "%e %b %Y" : "%b %e %Y";
485 ls_strftime(longstring, sizeof(longstring), format, localtime(&ftime));
486 fputs(longstring, stdout);
491 printtype(u_int mode)
495 if ((mode & S_IFMT) == S_IFDIR) {
502 switch (mode & S_IFMT) {
521 if (mode & (S_IXUSR | S_IXGRP | S_IXOTH)) {
541 (void)write(STDOUT_FILENO, &tmp, 1);
546 printcolor_termcap(Colors c)
551 tputs(enter_bold, 1, putch);
552 if (colors[c].underline)
553 tputs(enter_underline, 1, putch);
555 if (colors[c].num[0] != -1) {
556 ansiseq = tgoto(ansi_fgcol, 0, colors[c].num[0]);
558 tputs(ansiseq, 1, putch);
560 if (colors[c].num[1] != -1) {
561 ansiseq = tgoto(ansi_bgcol, 0, colors[c].num[1]);
563 tputs(ansiseq, 1, putch);
568 printcolor_ansi(Colors c)
575 if (colors[c].underline)
577 if (colors[c].num[0] != -1)
578 printf(";3%d", colors[c].num[0]);
579 if (colors[c].num[1] != -1)
580 printf(";4%d", colors[c].num[1]);
591 printcolor_termcap(c);
595 endcolor_termcap(int sig)
598 tputs(ansi_coloff, 1, sig ? writech : putch);
599 tputs(attrs_off, 1, sig ? writech : putch);
616 endcolor_termcap(sig);
620 colortype(mode_t mode)
622 switch (mode & S_IFMT) {
649 if (mode & (S_IXUSR | S_IXGRP | S_IXOTH)) {
652 else if (mode & S_ISGID)
662 parsecolors(const char *cs)
668 short legacy_warn = 0;
671 cs = ""; /* LSCOLORS not set */
673 for (i = 0; i < (int)C_NUMCOLORS; i++) {
674 colors[i].bold = false;
675 colors[i].underline = false;
677 if (len <= 2 * (size_t)i) {
678 c[0] = defcolors[2 * i];
679 c[1] = defcolors[2 * i + 1];
682 c[1] = cs[2 * i + 1];
684 for (j = 0; j < 2; j++) {
685 /* Legacy colours used 0-7 */
686 if (c[j] >= '0' && c[j] <= '7') {
687 colors[i].num[j] = c[j] - '0';
689 warnx("LSCOLORS should use "
690 "characters a-h instead of 0-9 ("
691 "see the manual page)");
694 } else if (c[j] >= 'a' && c[j] <= 'h')
695 colors[i].num[j] = c[j] - 'a';
696 else if (c[j] >= 'A' && c[j] <= 'H') {
697 colors[i].num[j] = c[j] - 'A';
699 colors[i].underline = true;
701 colors[i].bold = true;
702 } else if (tolower((unsigned char)c[j]) == 'x') {
703 if (j == 1 && c[j] == 'X')
704 colors[i].underline = true;
705 colors[i].num[j] = -1;
707 warnx("invalid character '%c' in LSCOLORS"
709 colors[i].num[j] = -1;
720 (void)signal(sig, SIG_DFL);
721 (void)kill(getpid(), sig);
727 printlink(const FTSENT *p)
730 char name[MAXPATHLEN + 1];
731 char path[MAXPATHLEN + 1];
733 if (p->fts_level == FTS_ROOTLEVEL)
734 (void)snprintf(name, sizeof(name), "%s", p->fts_name);
736 (void)snprintf(name, sizeof(name),
737 "%s/%s", p->fts_parent->fts_accpath, p->fts_name);
738 if ((lnklen = readlink(name, path, sizeof(path) - 1)) == -1) {
739 (void)fprintf(stderr, "\nls: %s: %s\n", name, strerror(errno));
743 (void)printf(" -> ");
744 (void)printname(path);
748 printsize(size_t width, off_t bytes)
753 * Reserve one space before the size and allocate room for
756 char buf[HUMANVALSTR_LEN - 1 + 1];
758 humanize_number(buf, sizeof(buf), (int64_t)bytes, "",
759 HN_AUTOSCALE, HN_B | HN_NOSPACE | HN_DECIMAL);
760 (void)printf("%*s ", (u_int)width, buf);
761 } else if (f_thousands) { /* with commas */
762 /* This format assignment needed to work round gcc bug. */
763 const char *format = "%*j'd ";
764 (void)printf(format, (u_int)width, bytes);
766 (void)printf("%*jd ", (u_int)width, bytes);
770 * Add a + after the standard rwxrwxrwx mode if the file has an
771 * ACL. strmode() reserves space at the end of the string.
774 aclmode(char *buf, const FTSENT *p)
776 char name[MAXPATHLEN + 1];
778 static dev_t previous_dev = NODEV;
779 static int supports_acls = -1;
780 static int type = ACL_TYPE_ACCESS;
784 * XXX: ACLs are not supported on whiteouts and device files
787 if (S_ISCHR(p->fts_statp->st_mode) || S_ISBLK(p->fts_statp->st_mode) ||
788 S_ISWHT(p->fts_statp->st_mode))
791 if (previous_dev == p->fts_statp->st_dev && supports_acls == 0)
794 if (p->fts_level == FTS_ROOTLEVEL)
795 snprintf(name, sizeof(name), "%s", p->fts_name);
797 snprintf(name, sizeof(name), "%s/%s",
798 p->fts_parent->fts_accpath, p->fts_name);
800 if (previous_dev != p->fts_statp->st_dev) {
801 previous_dev = p->fts_statp->st_dev;
804 ret = lpathconf(name, _PC_ACL_NFS4);
806 type = ACL_TYPE_NFS4;
808 } else if (ret < 0 && errno != EINVAL) {
812 if (supports_acls == 0) {
813 ret = lpathconf(name, _PC_ACL_EXTENDED);
815 type = ACL_TYPE_ACCESS;
817 } else if (ret < 0 && errno != EINVAL) {
823 if (supports_acls == 0)
825 facl = acl_get_link_np(name, type);
830 if (acl_is_trivial_np(facl, &trivial)) {