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 * 4. 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 $
35 * $DragonFly: src/bin/ls/ls.c,v 1.16 2006/06/19 12:06:47 corecode Exp $
38 #include <sys/types.h>
40 #include <sys/ioctl.h>
64 * Upward approximation of the maximum number of characters needed to
65 * represent a value of integral type t as a string, excluding the
66 * NUL terminator, with provision for a sign.
68 #define STRBUF_SIZEOF(t) (1 + CHAR_BIT * sizeof(t) / 3 + 1)
71 * MAKENINES(n) turns n into (10**n)-1. This is useful for converting a width
72 * into a number that wide in decimal.
73 * XXX: Overflows are not considered.
75 #define MAKENINES(n) \
79 /* Use a loop as all values of n are small. */ \
80 for (i = 1; n > 0; i *= 10) \
85 static void display(const FTSENT
*, FTSENT
*);
86 static int mastercmp(const FTSENT
**, const FTSENT
**);
87 static void traverse(int, char **, int);
89 static void (*printfcn
)(const DISPLAY
*);
90 static int (*sortfcn
)(const FTSENT
*, const FTSENT
*);
92 long blocksize
; /* block size units */
93 int termwidth
= 80; /* default terminal width */
96 int f_accesstime
; /* use time of last access */
97 int f_flags
; /* show flags associated with a file */
98 int f_fsmid
; /* show FSMID associated with a file */
99 int f_humanval
; /* show human-readable file sizes */
100 int f_inode
; /* print inode */
101 static int f_kblocks
; /* print size in kilobytes */
102 static int f_listdir
; /* list actual directory, not contents */
103 static int f_listdot
; /* list files beginning with . */
104 int f_longform
; /* long listing format */
105 int f_nonprint
; /* show unprintables as ? */
106 static int f_nosort
; /* don't sort output */
107 int f_notabs
; /* don't use tab-separated multi-col output */
108 static int f_numericonly
; /* don't convert uid/gid to name */
109 int f_octal
; /* show unprintables as \xxx */
110 int f_octal_escape
; /* like f_octal but use C escapes if possible */
111 static int f_recursive
; /* ls subdirectories also */
112 static int f_reversesort
; /* reverse whatever sort is used */
113 int f_sectime
; /* print the real time for all files */
114 static int f_singlecol
; /* use single column output */
115 int f_size
; /* list size in short listing */
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 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");
167 /* Root is -A automatically. */
171 fts_options
= FTS_PHYSICAL
;
172 while ((ch
= getopt(argc
, argv
, "1ABCFGHLPRTWabcdfghiklmnopqrstuwxy"))
176 * The -1, -C, -x and -l options all override each other so
177 * shell aliasing works right.
190 f_sortacross
= f_longform
= f_singlecol
= 0;
203 #ifdef _ST_FSMID_PRESENT_
207 /* The -c and -u options override each other. */
221 fts_options
|= FTS_COMFOLLOW
;
224 if (setenv("CLICOLOR", "", 1) != 0)
225 warn("setenv: cannot set CLICOLOR");
228 fts_options
&= ~FTS_PHYSICAL
;
229 fts_options
|= FTS_LOGICAL
;
232 fts_options
&= ~FTS_COMFOLLOW
;
233 fts_options
&= ~FTS_LOGICAL
;
234 fts_options
|= FTS_PHYSICAL
;
240 fts_options
|= FTS_SEEDOT
;
245 /* The -d option turns off the -R option. */
253 case 'g': /* Compatibility with 4.3BSD. */
318 /* Enabling of colours is conditional on the environment. */
319 if (getenv("CLICOLOR") &&
320 (isatty(STDOUT_FILENO
) || getenv("CLICOLOR_FORCE")))
322 if (tgetent(termcapbuf
, getenv("TERM")) == 1) {
323 ansi_fgcol
= tgetstr("AF", &bp
);
324 ansi_bgcol
= tgetstr("AB", &bp
);
325 attrs_off
= tgetstr("me", &bp
);
326 enter_bold
= tgetstr("md", &bp
);
328 /* To switch colours off use 'op' if
329 * available, otherwise use 'oc', or
330 * don't do colours at all. */
331 ansi_coloff
= tgetstr("op", &bp
);
333 ansi_coloff
= tgetstr("oc", &bp
);
334 if (ansi_fgcol
&& ansi_bgcol
&& ansi_coloff
)
338 fprintf(stderr
, "Color support not compiled in.\n");
344 * We can't put tabs and color sequences together:
345 * column number will be incremented incorrectly
346 * for "stty oxtabs" mode.
349 signal(SIGINT
, colorquit
);
350 signal(SIGQUIT
, colorquit
);
351 parsecolors(getenv("LSCOLORS"));
356 * If not -F, -i, -l, -s or -t options, don't require stat
357 * information, unless in color mode in which case we do
358 * need this to determine which colors to display.
360 if (!f_inode
&& !f_longform
&& !f_size
&& !f_timesort
&& !f_type
365 fts_options
|= FTS_NOSTAT
;
368 * If not -F, -d or -l options, follow any symbolic links listed on
371 if (!f_longform
&& !f_listdir
&& !f_type
)
372 fts_options
|= FTS_COMFOLLOW
;
375 * If -W, show whiteout entries
379 fts_options
|= FTS_WHITEOUT
;
382 /* If -l or -s, figure out block size. */
383 if (f_longform
|| f_size
) {
387 getbsize(¬used
, &blocksize
);
391 /* Select a sort function. */
394 sortfcn
= revnamecmp
;
395 else if (f_accesstime
)
397 else if (f_statustime
)
398 sortfcn
= revstatcmp
;
399 else /* Use modification time. */
404 else if (f_accesstime
)
406 else if (f_statustime
)
408 else /* Use modification time. */
412 /* Select a print function. */
414 printfcn
= printscol
;
416 printfcn
= printlong
;
418 printfcn
= printstream
;
423 traverse(argc
, argv
, fts_options
);
425 traverse(1, dotav
, fts_options
);
429 static int output
; /* If anything output. */
432 * Traverse() walks the logical directory structure specified by the argv list
433 * in the order specified by the mastercmp() comparison function. During the
434 * traversal it passes linked lists of structures to display() which represent
435 * a superset (may be exact set) of the files to be displayed.
438 traverse(int argc
, char *argv
[], int options
)
442 int ch_options
, error
;
445 fts_open(argv
, options
, f_nosort
? NULL
: mastercmp
)) == NULL
)
449 * We ignore errors from fts_children here since they will be
450 * replicated and signalled on the next call to fts_read() below.
452 chp
= fts_children(ftsp
, 0);
461 * If not recursing down this tree and don't need stat info, just get
464 ch_options
= !f_recursive
&& options
& FTS_NOSTAT
? FTS_NAMEONLY
: 0;
466 while ((p
= fts_read(ftsp
)) != NULL
)
467 switch (p
->fts_info
) {
469 warnx("%s: directory causes a cycle", p
->fts_name
);
473 warnx("%s: %s", p
->fts_name
, strerror(p
->fts_errno
));
477 if (p
->fts_level
!= FTS_ROOTLEVEL
&&
478 p
->fts_name
[0] == '.' && !f_listdot
)
482 * If already output something, put out a newline as
483 * a separator. If multiple arguments, precede each
484 * directory with its name.
488 printname(p
->fts_path
);
490 } else if (argc
> 1) {
491 printname(p
->fts_path
);
495 chp
= fts_children(ftsp
, ch_options
);
498 if (!f_recursive
&& chp
!= NULL
)
499 fts_set(ftsp
, p
, FTS_SKIP
);
512 * Display() takes a linked list of FTSENT structures and passes the list
513 * along with any other necessary information to the print function. P
514 * points to the parent directory of the display list.
517 display(const FTSENT
*p
, FTSENT
*list
)
524 u_long btotal
, maxlen
;
528 int bcfile
, maxflags
;
531 size_t fsmidlen
, flen
, ulen
, glen
;
533 int entries
, needstats
;
534 const char *user
, *group
;
537 char buf
[STRBUF_SIZEOF(u_quad_t
) + 1];
538 char ngroup
[STRBUF_SIZEOF(uid_t
) + 1];
539 char nuser
[STRBUF_SIZEOF(gid_t
) + 1];
541 needstats
= f_inode
|| f_longform
|| f_size
;
544 initmax
= getenv("LS_COLWIDTHS");
545 /* Fields match -lios order. New ones should be added at the end. */
546 maxblock
= maxinode
= maxlen
= maxnlink
=
547 maxuser
= maxgroup
= maxflags
= maxsize
= 0;
548 if (initmax
!= NULL
&& *initmax
!= '\0') {
549 char *initmax2
, *jinitmax
;
552 /* Fill-in "::" as "0:0:0" for the sake of scanf. */
553 jinitmax
= malloc(strlen(initmax
) * 2 + 2);
554 if (jinitmax
== NULL
)
558 strcpy(initmax2
, "0:"), initmax2
+= 2;
560 *initmax2
++ = *initmax
, *initmax2
= '\0';
561 for (initmax
++; *initmax
!= '\0'; initmax
++) {
562 if (initmax
[-1] == ':' && initmax
[0] == ':') {
564 *initmax2
++ = initmax
[0];
567 *initmax2
++ = initmax
[0];
571 if (initmax2
[-1] == ':')
572 strcpy(initmax2
, "0");
574 ninitmax
= sscanf(jinitmax
,
575 " %llu : %lli : %u : %i : %i : %i : %llu : %lu ",
576 &maxinode
, &maxblock
, &maxnlink
, &maxuser
,
577 &maxgroup
, &maxflags
, &maxsize
, &maxlen
);
620 for (cur
= list
, entries
= 0; cur
; cur
= cur
->fts_link
) {
621 if (cur
->fts_info
== FTS_ERR
|| cur
->fts_info
== FTS_NS
) {
623 cur
->fts_name
, strerror(cur
->fts_errno
));
624 cur
->fts_number
= NO_PRINT
;
629 * P is NULL if list is the argv list, to which different rules
633 /* Directories will be displayed later. */
634 if (cur
->fts_info
== FTS_D
&& !f_listdir
) {
635 cur
->fts_number
= NO_PRINT
;
639 /* Only display dot file if -a/-A set. */
640 if (cur
->fts_name
[0] == '.' && !f_listdot
) {
641 cur
->fts_number
= NO_PRINT
;
645 if (cur
->fts_namelen
> maxlen
)
646 maxlen
= cur
->fts_namelen
;
647 if (f_octal
|| f_octal_escape
) {
648 u_long t
= len_octal(cur
->fts_name
, cur
->fts_namelen
);
655 if (sp
->st_blocks
> maxblock
)
656 maxblock
= sp
->st_blocks
;
657 if (sp
->st_ino
> maxinode
)
658 maxinode
= sp
->st_ino
;
659 if (sp
->st_nlink
> maxnlink
)
660 maxnlink
= sp
->st_nlink
;
661 if (sp
->st_size
> maxsize
)
662 maxsize
= sp
->st_size
;
664 btotal
+= sp
->st_blocks
;
667 snprintf(nuser
, sizeof(nuser
),
669 snprintf(ngroup
, sizeof(ngroup
),
674 user
= user_from_uid(sp
->st_uid
, 0);
675 group
= group_from_gid(sp
->st_gid
, 0);
677 if ((ulen
= strlen(user
)) > maxuser
)
679 if ((glen
= strlen(group
)) > maxgroup
)
682 flags
= fflagstostr(sp
->st_flags
);
683 if (flags
!= NULL
&& *flags
== '\0') {
688 err(1, "flagstostr");
689 flen
= strlen(flags
);
690 if (flen
> (size_t)maxflags
)
695 #ifdef _ST_FSMID_PRESENT_
697 fsmid
= sp
->st_fsmid
;
707 if ((np
= malloc(sizeof(NAMES
) +
708 ulen
+ glen
+ flen
+ fsmidlen
+ 4)) == NULL
)
711 np
->user
= &np
->data
[0];
712 strcpy(np
->user
, user
);
713 np
->group
= &np
->data
[ulen
+ 1];
714 strcpy(np
->group
, group
);
716 if (S_ISCHR(sp
->st_mode
) ||
717 S_ISBLK(sp
->st_mode
))
721 np
->flags
= &np
->data
[ulen
+ glen
+ 2];
722 strcpy(np
->flags
, flags
);
725 #ifdef _ST_FSMID_PRESENT_
727 np
->fsmid
= np
->data
+ ulen
+ glen
+ flen
+ 3;
728 snprintf(np
->fsmid
, fsmidlen
+ 1,
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
), "%lli", maxblock
);
754 d
.s_block
= strlen(buf
);
755 d
.s_flags
= maxflags
;
756 d
.s_group
= maxgroup
;
757 snprintf(buf
, sizeof(buf
), "%llu", 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
), "%llu", 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
**a
, const FTSENT
**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
));