2 * Copyright (c) 1989, 1993, 1994
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of the University nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * @(#) Copyright (c) 1989, 1993, 1994 The Regents of the University of California. All rights reserved.
33 * @(#)ls.c 8.5 (Berkeley) 4/2/94
34 * $FreeBSD: src/bin/ls/ls.c,v 1.78 2004/06/08 09:30:10 das Exp $
37 #include <sys/types.h>
39 #include <sys/ioctl.h>
63 * Upward approximation of the maximum number of characters needed to
64 * represent a value of integral type t as a string, excluding the
65 * NUL terminator, with provision for a sign.
67 #define STRBUF_SIZEOF(t) (1 + CHAR_BIT * sizeof(t) / 3 + 1)
70 * MAKENINES(n) turns n into (10**n)-1. This is useful for converting a width
71 * into a number that wide in decimal.
72 * XXX: Overflows are not considered.
74 #define MAKENINES(n) \
78 /* Use a loop as all values of n are small. */ \
79 for (i = 1; n > 0; i *= 10) \
84 static void display(const FTSENT *, FTSENT *);
85 static int mastercmp(const FTSENT * const *, const FTSENT * const *);
86 static void traverse(int, char **, int);
88 static void (*printfcn)(const DISPLAY *);
89 static int (*sortfcn)(const FTSENT *, const FTSENT *);
91 long blocksize; /* block size units */
92 int termwidth = 80; /* default terminal width */
95 int f_accesstime; /* use time of last access */
96 int f_flags; /* show flags associated with a file */
97 int f_fsmid; /* show FSMID associated with a file */
98 int f_humanval; /* show human-readable file sizes */
99 int f_inode; /* print inode */
100 static int f_kblocks; /* print size in kilobytes */
101 static int f_listdir; /* list actual directory, not contents */
102 static int f_listdot; /* list files beginning with . */
103 int f_longform; /* long listing format */
104 int f_nonprint; /* show unprintables as ? */
105 static int f_nosort; /* don't sort output */
106 int f_notabs; /* don't use tab-separated multi-col output */
107 static int f_numericonly; /* don't convert uid/gid to name */
108 int f_octal; /* show unprintables as \xxx */
109 int f_octal_escape; /* like f_octal but use C escapes if possible */
110 static int f_recursive; /* ls subdirectories also */
111 static int f_reversesort; /* reverse whatever sort is used */
112 int f_sectime; /* print the real time for all files */
113 static int f_singlecol; /* use single column output */
114 int f_size; /* list size in short listing */
115 int f_slash; /* similar to f_type, but only for dirs */
116 int f_sortsize; /* Sort by size */
117 int f_sortacross; /* sort across rows, not down columns */
118 int f_statustime; /* use time of last mode change */
119 static int f_stream; /* stream the output, separate with commas */
120 static int f_timesort; /* sort by time vice name */
121 int f_type; /* add type character for non-regular files */
122 static int f_whiteout; /* show whiteout entries */
124 int f_color; /* add type in color for non-regular files */
126 char *ansi_bgcol; /* ANSI sequence to set background colour */
127 char *ansi_fgcol; /* ANSI sequence to set foreground colour */
128 char *ansi_coloff; /* ANSI sequence to reset colours */
129 char *attrs_off; /* ANSI sequence to turn off attributes */
130 char *enter_bold; /* ANSI sequence to set color to bold mode */
136 main(int argc, char *argv[])
138 static char dot[] = ".", *dotav[] = {dot, NULL};
140 int ch, fts_options, notused;
143 char termcapbuf[1024]; /* termcap definition buffer */
144 char tcapbuf[512]; /* capability buffer */
148 setlocale(LC_ALL, "");
150 /* Terminal defaults to -Cq, non-terminal defaults to -1. */
151 if (isatty(STDOUT_FILENO)) {
153 if ((p = getenv("COLUMNS")) != NULL && *p != '\0')
155 else if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &win) != -1 &&
157 termwidth = win.ws_col;
161 /* retrieve environment variable, in case of explicit -C */
162 p = getenv("COLUMNS");
168 * Root is -A automatically. Turn off if -I specified.
173 fts_options = FTS_PHYSICAL;
174 while ((ch = getopt(argc, argv, "1ABCFGHILPSRTWabcdfghiklmnopqrstuwxy"))
178 * The -1, -C, -x and -l options all override each other so
179 * shell aliasing works right.
192 f_sortacross = f_longform = f_singlecol = 0;
205 #ifdef _ST_FSMID_PRESENT_
209 /* The -c and -u options override each other. */
223 fts_options |= FTS_COMFOLLOW;
229 if (setenv("CLICOLOR", "", 1) != 0)
230 warn("setenv: cannot set CLICOLOR");
233 fts_options &= ~FTS_PHYSICAL;
234 fts_options |= FTS_LOGICAL;
237 fts_options &= ~FTS_COMFOLLOW;
238 fts_options &= ~FTS_LOGICAL;
239 fts_options |= FTS_PHYSICAL;
251 fts_options |= FTS_SEEDOT;
256 /* The -d option turns off the -R option. */
261 case 'g': /* Compatibility with 4.3BSD. */
326 /* Enabling of colours is conditional on the environment. */
327 if (getenv("CLICOLOR") &&
328 (isatty(STDOUT_FILENO) || getenv("CLICOLOR_FORCE")))
330 if (tgetent(termcapbuf, getenv("TERM")) == 1) {
331 ansi_fgcol = tgetstr("AF", &bp);
332 ansi_bgcol = tgetstr("AB", &bp);
333 attrs_off = tgetstr("me", &bp);
334 enter_bold = tgetstr("md", &bp);
336 /* To switch colours off use 'op' if
337 * available, otherwise use 'oc', or
338 * don't do colours at all. */
339 ansi_coloff = tgetstr("op", &bp);
341 ansi_coloff = tgetstr("oc", &bp);
342 if (ansi_fgcol && ansi_bgcol && ansi_coloff)
346 fprintf(stderr, "Color support not compiled in.\n");
352 * We can't put tabs and color sequences together:
353 * column number will be incremented incorrectly
354 * for "stty oxtabs" mode.
357 signal(SIGINT, colorquit);
358 signal(SIGQUIT, colorquit);
359 parsecolors(getenv("LSCOLORS"));
364 * If not -F, -i, -l, -s, -S or -t options, don't require stat
365 * information, unless in color mode in which case we do
366 * need this to determine which colors to display.
368 if (!f_inode && !f_longform && !f_size && !f_sortsize && !f_timesort
374 fts_options |= FTS_NOSTAT;
377 * If not -F, -d or -l options, follow any symbolic links listed on
380 if (!f_longform && !f_listdir && !f_type)
381 fts_options |= FTS_COMFOLLOW;
384 * If -W, show whiteout entries
388 fts_options |= FTS_WHITEOUT;
391 /* If -l or -s, figure out block size. */
392 if (f_longform || f_size) {
396 getbsize(¬used, &blocksize);
400 /* Select a sort function. */
403 sortfcn = revnamecmp;
404 else if (f_accesstime)
407 sortfcn = revsizecmp;
408 else if (f_statustime)
409 sortfcn = revstatcmp;
410 else /* Use modification time. */
415 else if (f_accesstime)
419 else if (f_statustime)
421 else /* Use modification time. */
425 /* Select a print function. */
427 printfcn = printscol;
429 printfcn = printlong;
431 printfcn = printstream;
436 traverse(argc, argv, fts_options);
438 traverse(1, dotav, fts_options);
442 static int output; /* If anything output. */
445 * Traverse() walks the logical directory structure specified by the argv list
446 * in the order specified by the mastercmp() comparison function. During the
447 * traversal it passes linked lists of structures to display() which represent
448 * a superset (may be exact set) of the files to be displayed.
451 traverse(int argc, char *argv[], int options)
455 int ch_options, error;
458 fts_open(argv, options, f_nosort ? NULL : mastercmp)) == NULL)
462 * We ignore errors from fts_children here since they will be
463 * replicated and signalled on the next call to fts_read() below.
465 chp = fts_children(ftsp, 0);
474 * If not recursing down this tree and don't need stat info, just get
477 ch_options = !f_recursive && options & FTS_NOSTAT ? FTS_NAMEONLY : 0;
479 while ((p = fts_read(ftsp)) != NULL)
480 switch (p->fts_info) {
482 warnx("%s: directory causes a cycle", p->fts_name);
486 warnx("%s: %s", p->fts_name, strerror(p->fts_errno));
490 if (p->fts_level != FTS_ROOTLEVEL &&
491 p->fts_name[0] == '.' && !f_listdot)
495 * If already output something, put out a newline as
496 * a separator. If multiple arguments, precede each
497 * directory with its name.
501 printname(p->fts_path);
503 } else if (argc > 1) {
504 printname(p->fts_path);
508 chp = fts_children(ftsp, ch_options);
511 if (!f_recursive && chp != NULL)
512 fts_set(ftsp, p, FTS_SKIP);
525 * Display() takes a linked list of FTSENT structures and passes the list
526 * along with any other necessary information to the print function. P
527 * points to the parent directory of the display list.
530 display(const FTSENT *p, FTSENT *list)
537 u_long btotal, maxlen;
541 int bcfile, maxflags;
544 size_t fsmidlen, flen, ulen, glen;
546 int entries, needstats;
547 const char *user, *group;
549 #ifdef _ST_FSMID_PRESENT_
552 char buf[STRBUF_SIZEOF(u_quad_t) + 1];
553 char ngroup[STRBUF_SIZEOF(uid_t) + 1];
554 char nuser[STRBUF_SIZEOF(gid_t) + 1];
556 needstats = f_inode || f_longform || f_size;
558 initmax = getenv("LS_COLWIDTHS");
559 /* Fields match -lios order. New ones should be added at the end. */
560 maxblock = maxinode = maxlen = maxnlink =
561 maxuser = maxgroup = maxflags = maxsize = 0;
562 if (initmax != NULL && *initmax != '\0') {
563 char *initmax2, *jinitmax;
566 /* Fill-in "::" as "0:0:0" for the sake of scanf. */
567 jinitmax = malloc(strlen(initmax) * 2 + 2);
568 if (jinitmax == NULL)
572 strcpy(initmax2, "0:"), initmax2 += 2;
574 *initmax2++ = *initmax, *initmax2 = '\0';
575 for (initmax++; *initmax != '\0'; initmax++) {
576 if (initmax[-1] == ':' && initmax[0] == ':') {
578 *initmax2++ = initmax[0];
581 *initmax2++ = initmax[0];
585 if (initmax2[-1] == ':')
586 strcpy(initmax2, "0");
588 ninitmax = sscanf(jinitmax,
589 " %ju : %jd : %u : %i : %i : %i : %jd : %lu ",
590 &maxinode, &maxblock, &maxnlink, &maxuser,
591 &maxgroup, &maxflags, &maxsize, &maxlen);
634 for (cur = list, entries = 0; cur; cur = cur->fts_link) {
635 if (cur->fts_info == FTS_ERR || cur->fts_info == FTS_NS) {
637 cur->fts_name, strerror(cur->fts_errno));
638 cur->fts_number = NO_PRINT;
643 * P is NULL if list is the argv list, to which different rules
647 /* Directories will be displayed later. */
648 if (cur->fts_info == FTS_D && !f_listdir) {
649 cur->fts_number = NO_PRINT;
653 /* Only display dot file if -a/-A set. */
654 if (cur->fts_name[0] == '.' && !f_listdot) {
655 cur->fts_number = NO_PRINT;
659 if (cur->fts_namelen > maxlen)
660 maxlen = cur->fts_namelen;
661 if (f_octal || f_octal_escape) {
662 u_long t = len_octal(cur->fts_name, cur->fts_namelen);
669 if (sp->st_blocks > maxblock)
670 maxblock = sp->st_blocks;
671 if (sp->st_ino > maxinode)
672 maxinode = sp->st_ino;
673 if (sp->st_nlink > maxnlink)
674 maxnlink = sp->st_nlink;
675 if (sp->st_size > maxsize)
676 maxsize = sp->st_size;
678 btotal += sp->st_blocks;
681 snprintf(nuser, sizeof(nuser),
683 snprintf(ngroup, sizeof(ngroup),
688 user = user_from_uid(sp->st_uid, 0);
689 group = group_from_gid(sp->st_gid, 0);
691 if ((ulen = strlen(user)) > maxuser)
693 if ((glen = strlen(group)) > maxgroup)
696 flags = fflagstostr(sp->st_flags);
697 if (flags != NULL && *flags == '\0') {
702 err(1, "flagstostr");
703 flen = strlen(flags);
704 if (flen > (size_t)maxflags)
709 #ifdef _ST_FSMID_PRESENT_
711 fsmid = sp->st_fsmid;
721 if ((np = malloc(sizeof(NAMES) +
722 ulen + glen + flen + fsmidlen + 4)) == NULL)
725 np->user = &np->data[0];
726 strcpy(np->user, user);
727 np->group = &np->data[ulen + 1];
728 strcpy(np->group, group);
730 if (S_ISCHR(sp->st_mode) ||
731 S_ISBLK(sp->st_mode))
735 np->flags = &np->data[ulen + glen + 2];
736 strcpy(np->flags, flags);
739 #ifdef _ST_FSMID_PRESENT_
741 np->fsmid = np->data + ulen + glen + flen + 3;
742 snprintf(np->fsmid, fsmidlen + 1,
743 "%016jx", (intmax_t)fsmid);
746 cur->fts_pointer = np;
753 * If there are no entries to display, we normally stop right
754 * here. However, we must continue if we have to display the
755 * total block count. In this case, we display the total only
756 * on the second (p != NULL) pass.
758 if (!entries && (!(f_longform || f_size) || p == NULL))
767 snprintf(buf, sizeof(buf), "%ji", (intmax_t)maxblock);
768 d.s_block = strlen(buf);
769 d.s_flags = maxflags;
770 d.s_group = maxgroup;
771 snprintf(buf, sizeof(buf), "%ju", (uintmax_t)maxinode);
772 d.s_inode = strlen(buf);
773 snprintf(buf, sizeof(buf), "%u", maxnlink);
774 d.s_nlink = strlen(buf);
775 snprintf(buf, sizeof(buf), "%jd", (intmax_t)maxsize);
776 d.s_size = strlen(buf);
783 for (cur = list; cur; cur = cur->fts_link)
784 free(cur->fts_pointer);
788 * Ordering for mastercmp:
789 * If ordering the argv (fts_level = FTS_ROOTLEVEL) return non-directories
790 * as larger than directories. Within either group, use the sort function.
791 * All other levels use the sort function. Error entries remain unsorted.
794 mastercmp(const FTSENT * const *a, const FTSENT * const *b)
798 a_info = (*a)->fts_info;
799 if (a_info == FTS_ERR)
801 b_info = (*b)->fts_info;
802 if (b_info == FTS_ERR)
805 if (a_info == FTS_NS || b_info == FTS_NS)
806 return (namecmp(*a, *b));
808 if (a_info != b_info &&
809 (*a)->fts_level == FTS_ROOTLEVEL && !f_listdir) {
815 return (sortfcn(*a, *b));