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_humanval
; /* show human-readable file sizes */
98 int f_inode
; /* print inode */
99 static int f_kblocks
; /* print size in kilobytes */
100 static int f_listdir
; /* list actual directory, not contents */
101 static int f_listdot
; /* list files beginning with . */
102 int f_longform
; /* long listing format */
103 int f_nanotime
; /* include nanotime in long 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 static int f_sizesort
; /* Sort by size */
116 int f_slash
; /* similar to f_type, but only for dirs */
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 const char *f_timeformat
; /* user-specified time format */
121 static int f_timesort
; /* sort by time vice name */
122 int f_type
; /* add type character for non-regular files */
123 static int f_whiteout
; /* show whiteout entries */
125 int f_color
; /* add type in color for non-regular files */
127 char *ansi_bgcol
; /* ANSI sequence to set background colour */
128 char *ansi_fgcol
; /* ANSI sequence to set foreground colour */
129 char *ansi_coloff
; /* ANSI sequence to reset colours */
130 char *attrs_off
; /* ANSI sequence to turn off attributes */
131 char *enter_bold
; /* ANSI sequence to set color to bold mode */
137 main(int argc
, char *argv
[])
139 static char dot
[] = ".", *dotav
[] = {dot
, NULL
};
141 int ch
, fts_options
, notused
;
143 const char nanotime_format
[] = "%Y-%m-%d %H:%M:%S";
145 char termcapbuf
[1024]; /* termcap definition buffer */
146 char tcapbuf
[512]; /* capability buffer */
150 setlocale(LC_ALL
, "");
152 /* Terminal defaults to -Cq, non-terminal defaults to -1. */
153 if (isatty(STDOUT_FILENO
)) {
155 if ((p
= getenv("COLUMNS")) != NULL
&& *p
!= '\0')
157 else if (ioctl(STDOUT_FILENO
, TIOCGWINSZ
, &win
) != -1 &&
159 termwidth
= win
.ws_col
;
163 /* retrieve environment variable, in case of explicit -C */
164 p
= getenv("COLUMNS");
170 * Root is -A automatically. Turn off if -I specified.
175 fts_options
= FTS_PHYSICAL
;
176 while ((ch
= getopt(argc
, argv
,
177 "1ABCD:FGHILPRSTW_abcdfghiklmnopqrstuwx")) != -1) {
180 * The -1, -C, -x and -l options all override each other so
181 * shell aliasing works right.
194 f_sortacross
= f_longform
= f_singlecol
= 0;
206 /* The -c and -u options override each other. */
216 f_timeformat
= optarg
;
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
;
244 /* The -t and -S options override each other. */
257 fts_options
|= FTS_SEEDOT
;
262 /* The -d option turns off the -R option. */
267 case 'g': /* Compatibility with 4.3BSD. */
323 f_timeformat
= nanotime_format
;
333 /* Enabling of colours is conditional on the environment. */
334 if (getenv("CLICOLOR") &&
335 (isatty(STDOUT_FILENO
) || getenv("CLICOLOR_FORCE")))
337 if (tgetent(termcapbuf
, getenv("TERM")) == 1) {
338 ansi_fgcol
= tgetstr("AF", &bp
);
339 ansi_bgcol
= tgetstr("AB", &bp
);
340 attrs_off
= tgetstr("me", &bp
);
341 enter_bold
= tgetstr("md", &bp
);
343 /* To switch colours off use 'op' if
344 * available, otherwise use 'oc', or
345 * don't do colours at all. */
346 ansi_coloff
= tgetstr("op", &bp
);
348 ansi_coloff
= tgetstr("oc", &bp
);
349 if (ansi_fgcol
&& ansi_bgcol
&& ansi_coloff
)
353 fprintf(stderr
, "Color support not compiled in.\n");
359 * We can't put tabs and color sequences together:
360 * column number will be incremented incorrectly
361 * for "stty oxtabs" mode.
364 signal(SIGINT
, colorquit
);
365 signal(SIGQUIT
, colorquit
);
366 parsecolors(getenv("LSCOLORS"));
371 * If not -F, -i, -l, -s, -S or -t options, don't require stat
372 * information, unless in color mode in which case we do
373 * need this to determine which colors to display.
375 if (!f_inode
&& !f_longform
&& !f_size
&& !f_timesort
&&
376 !f_sizesort
&& !f_type
381 fts_options
|= FTS_NOSTAT
;
384 * If not -F, -d or -l options, follow any symbolic links listed on
387 if (!f_longform
&& !f_listdir
&& !f_type
)
388 fts_options
|= FTS_COMFOLLOW
;
391 * If -W, show whiteout entries
395 fts_options
|= FTS_WHITEOUT
;
398 /* If -l or -s, figure out block size. */
399 if (f_longform
|| f_size
) {
403 getbsize(¬used
, &blocksize
);
407 /* Select a sort function. */
409 if (!f_timesort
&& !f_sizesort
)
410 sortfcn
= revnamecmp
;
412 sortfcn
= revsizecmp
;
413 else if (f_accesstime
)
415 else if (f_statustime
)
416 sortfcn
= revstatcmp
;
417 else /* Use modification time. */
420 if (!f_timesort
&& !f_sizesort
)
424 else if (f_accesstime
)
426 else if (f_statustime
)
428 else /* Use modification time. */
432 /* Select a print function. */
434 printfcn
= printscol
;
436 printfcn
= printlong
;
438 printfcn
= printstream
;
443 traverse(argc
, argv
, fts_options
);
445 traverse(1, dotav
, fts_options
);
449 static int output
; /* If anything output. */
452 * Traverse() walks the logical directory structure specified by the argv list
453 * in the order specified by the mastercmp() comparison function. During the
454 * traversal it passes linked lists of structures to display() which represent
455 * a superset (may be exact set) of the files to be displayed.
458 traverse(int argc
, char *argv
[], int options
)
462 int ch_options
, error
;
465 fts_open(argv
, options
, f_nosort
? NULL
: mastercmp
)) == NULL
)
469 * We ignore errors from fts_children here since they will be
470 * replicated and signalled on the next call to fts_read() below.
472 chp
= fts_children(ftsp
, 0);
481 * If not recursing down this tree and don't need stat info, just get
484 ch_options
= !f_recursive
&& options
& FTS_NOSTAT
? FTS_NAMEONLY
: 0;
486 while ((p
= fts_read(ftsp
)) != NULL
)
487 switch (p
->fts_info
) {
489 warnx("%s: directory causes a cycle", p
->fts_name
);
493 warnx("%s: %s", p
->fts_name
, strerror(p
->fts_errno
));
497 if (p
->fts_level
!= FTS_ROOTLEVEL
&&
498 p
->fts_name
[0] == '.' && !f_listdot
)
502 * If already output something, put out a newline as
503 * a separator. If multiple arguments, precede each
504 * directory with its name.
508 printname(p
->fts_path
);
510 } else if (argc
> 1) {
511 printname(p
->fts_path
);
515 chp
= fts_children(ftsp
, ch_options
);
518 if (!f_recursive
&& chp
!= NULL
)
519 fts_set(ftsp
, p
, FTS_SKIP
);
532 * Display() takes a linked list of FTSENT structures and passes the list
533 * along with any other necessary information to the print function. P
534 * points to the parent directory of the display list.
537 display(const FTSENT
*p
, FTSENT
*list
)
544 u_long btotal
, maxlen
;
548 int bcfile
, maxflags
;
551 size_t flen
, ulen
, glen
;
553 int entries
, needstats
;
554 const char *user
, *group
;
556 char buf
[STRBUF_SIZEOF(u_quad_t
) + 1];
557 char ngroup
[STRBUF_SIZEOF(uid_t
) + 1];
558 char nuser
[STRBUF_SIZEOF(gid_t
) + 1];
560 needstats
= f_inode
|| f_longform
|| f_size
;
562 initmax
= getenv("LS_COLWIDTHS");
563 /* Fields match -lios order. New ones should be added at the end. */
564 maxblock
= maxinode
= maxlen
= maxnlink
=
565 maxuser
= maxgroup
= maxflags
= maxsize
= 0;
566 if (initmax
!= NULL
&& *initmax
!= '\0') {
567 char *initmax2
, *jinitmax
;
570 /* Fill-in "::" as "0:0:0" for the sake of scanf. */
571 jinitmax
= malloc(strlen(initmax
) * 2 + 2);
572 if (jinitmax
== NULL
)
576 strcpy(initmax2
, "0:"), initmax2
+= 2;
578 *initmax2
++ = *initmax
, *initmax2
= '\0';
579 for (initmax
++; *initmax
!= '\0'; initmax
++) {
580 if (initmax
[-1] == ':' && initmax
[0] == ':') {
582 *initmax2
++ = initmax
[0];
585 *initmax2
++ = initmax
[0];
589 if (initmax2
[-1] == ':')
590 strcpy(initmax2
, "0");
592 ninitmax
= sscanf(jinitmax
,
593 " %ju : %jd : %u : %i : %i : %i : %jd : %lu ",
594 &maxinode
, &maxblock
, &maxnlink
, &maxuser
,
595 &maxgroup
, &maxflags
, &maxsize
, &maxlen
);
638 for (cur
= list
, entries
= 0; cur
; cur
= cur
->fts_link
) {
639 if (cur
->fts_info
== FTS_ERR
|| cur
->fts_info
== FTS_NS
) {
641 cur
->fts_name
, strerror(cur
->fts_errno
));
642 cur
->fts_number
= NO_PRINT
;
647 * P is NULL if list is the argv list, to which different rules
651 /* Directories will be displayed later. */
652 if (cur
->fts_info
== FTS_D
&& !f_listdir
) {
653 cur
->fts_number
= NO_PRINT
;
657 /* Only display dot file if -a/-A set. */
658 if (cur
->fts_name
[0] == '.' && !f_listdot
) {
659 cur
->fts_number
= NO_PRINT
;
663 if (cur
->fts_namelen
> maxlen
)
664 maxlen
= cur
->fts_namelen
;
665 if (f_octal
|| f_octal_escape
) {
666 u_long t
= len_octal(cur
->fts_name
, cur
->fts_namelen
);
673 if (sp
->st_blocks
> maxblock
)
674 maxblock
= sp
->st_blocks
;
675 if (sp
->st_ino
> maxinode
)
676 maxinode
= sp
->st_ino
;
677 if (sp
->st_nlink
> maxnlink
)
678 maxnlink
= sp
->st_nlink
;
679 if (sp
->st_size
> maxsize
)
680 maxsize
= sp
->st_size
;
682 btotal
+= sp
->st_blocks
;
685 snprintf(nuser
, sizeof(nuser
),
687 snprintf(ngroup
, sizeof(ngroup
),
692 user
= user_from_uid(sp
->st_uid
, 0);
693 group
= group_from_gid(sp
->st_gid
, 0);
695 if ((ulen
= strlen(user
)) > maxuser
)
697 if ((glen
= strlen(group
)) > maxgroup
)
700 flags
= fflagstostr(sp
->st_flags
);
701 if (flags
!= NULL
&& *flags
== '\0') {
706 err(1, "flagstostr");
707 flen
= strlen(flags
);
708 if (flen
> (size_t)maxflags
)
714 if ((np
= malloc(sizeof(NAMES
) +
715 ulen
+ glen
+ flen
+ 3)) == NULL
)
718 np
->user
= &np
->data
[0];
719 strcpy(np
->user
, user
);
720 np
->group
= &np
->data
[ulen
+ 1];
721 strcpy(np
->group
, group
);
723 if (S_ISCHR(sp
->st_mode
) ||
724 S_ISBLK(sp
->st_mode
))
728 np
->flags
= &np
->data
[ulen
+ glen
+ 2];
729 strcpy(np
->flags
, flags
);
732 cur
->fts_pointer
= np
;
739 * If there are no entries to display, we normally stop right
740 * here. However, we must continue if we have to display the
741 * total block count. In this case, we display the total only
742 * on the second (p != NULL) pass.
744 if (!entries
&& (!(f_longform
|| f_size
) || p
== NULL
))
753 snprintf(buf
, sizeof(buf
), "%ji", (intmax_t)maxblock
);
754 d
.s_block
= strlen(buf
);
755 d
.s_flags
= maxflags
;
756 d
.s_group
= maxgroup
;
757 snprintf(buf
, sizeof(buf
), "%ju", (uintmax_t)maxinode
);
758 d
.s_inode
= strlen(buf
);
759 snprintf(buf
, sizeof(buf
), "%u", maxnlink
);
760 d
.s_nlink
= strlen(buf
);
761 snprintf(buf
, sizeof(buf
), "%jd", (intmax_t)maxsize
);
762 d
.s_size
= strlen(buf
);
769 for (cur
= list
; cur
; cur
= cur
->fts_link
)
770 free(cur
->fts_pointer
);
774 * Ordering for mastercmp:
775 * If ordering the argv (fts_level = FTS_ROOTLEVEL) return non-directories
776 * as larger than directories. Within either group, use the sort function.
777 * All other levels use the sort function. Error entries remain unsorted.
780 mastercmp(const FTSENT
* const *a
, const FTSENT
* const *b
)
784 a_info
= (*a
)->fts_info
;
785 if (a_info
== FTS_ERR
)
787 b_info
= (*b
)->fts_info
;
788 if (b_info
== FTS_ERR
)
791 if (a_info
== FTS_NS
|| b_info
== FTS_NS
)
792 return (namecmp(*a
, *b
));
794 if (a_info
!= b_info
&&
795 (*a
)->fts_level
== FTS_ROOTLEVEL
&& !f_listdir
) {
801 return (sortfcn(*a
, *b
));