ls.c revision 1.58
1/*	$NetBSD: ls.c,v 1.58 2005/10/26 02:24:22 jschauma Exp $	*/
2
3/*
4 * Copyright (c) 1989, 1993, 1994
5 *	The Regents of the University of California.  All rights reserved.
6 *
7 * This code is derived from software contributed to Berkeley by
8 * Michael Fischbein.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
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.
21 *
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
32 * SUCH DAMAGE.
33 */
34
35#include <sys/cdefs.h>
36#ifndef lint
37__COPYRIGHT("@(#) Copyright (c) 1989, 1993, 1994\n\
38	The Regents of the University of California.  All rights reserved.\n");
39#endif /* not lint */
40
41#ifndef lint
42#if 0
43static char sccsid[] = "@(#)ls.c	8.7 (Berkeley) 8/5/94";
44#else
45__RCSID("$NetBSD: ls.c,v 1.58 2005/10/26 02:24:22 jschauma Exp $");
46#endif
47#endif /* not lint */
48
49#include <sys/types.h>
50#include <sys/stat.h>
51#include <sys/ioctl.h>
52
53#include <dirent.h>
54#include <err.h>
55#include <errno.h>
56#include <fts.h>
57#include <locale.h>
58#include <stdio.h>
59#include <stdlib.h>
60#include <string.h>
61#include <unistd.h>
62#include <termios.h>
63#include <pwd.h>
64#include <grp.h>
65
66#include "ls.h"
67#include "extern.h"
68
69static void	 display(FTSENT *, FTSENT *);
70static int	 mastercmp(const FTSENT **, const FTSENT **);
71static void	 traverse(int, char **, int);
72
73static void (*printfcn)(DISPLAY *);
74static int (*sortfcn)(const FTSENT *, const FTSENT *);
75
76#define	BY_NAME 0
77#define	BY_SIZE 1
78#define	BY_TIME	2
79
80long blocksize;			/* block size units */
81int termwidth = 80;		/* default terminal width */
82int sortkey = BY_NAME;
83int rval = EXIT_SUCCESS;	/* exit value - set if error encountered */
84
85/* flags */
86int f_accesstime;		/* use time of last access */
87int f_column;			/* columnated format */
88int f_columnacross;		/* columnated format, sorted across */
89int f_flags;			/* show flags associated with a file */
90int f_grouponly;		/* long listing without owner */
91int f_humanize;			/* humanize the size field */
92int f_inode;			/* print inode */
93int f_listdir;			/* list actual directory, not contents */
94int f_listdot;			/* list files beginning with . */
95int f_longform;			/* long listing format */
96int f_nonprint;			/* show unprintables as ? */
97int f_nosort;			/* don't sort output */
98int f_numericonly;		/* don't convert uid/gid to name */
99int f_octal;			/* print octal escapes for nongraphic characters */
100int f_octal_escape;		/* like f_octal but use C escapes if possible */
101int f_recursive;		/* ls subdirectories also */
102int f_reversesort;		/* reverse whatever sort is used */
103int f_sectime;			/* print the real time for all files */
104int f_singlecol;		/* use single column output */
105int f_size;			/* list size in short listing */
106int f_statustime;		/* use time of last mode change */
107int f_stream;			/* stream format */
108int f_type;			/* add type character for non-regular files */
109int f_typedir;			/* add type character for directories */
110int f_whiteout;			/* show whiteout entries */
111
112int
113ls_main(int argc, char *argv[])
114{
115	static char dot[] = ".", *dotav[] = { dot, NULL };
116	struct winsize win;
117	int ch, fts_options;
118	int kflag = 0;
119	const char *p;
120
121	setprogname(argv[0]);
122	setlocale(LC_ALL, "");
123
124	/* Terminal defaults to -Cq, non-terminal defaults to -1. */
125	if (isatty(STDOUT_FILENO)) {
126		if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &win) == 0 &&
127		    win.ws_col > 0)
128			termwidth = win.ws_col;
129		f_column = f_nonprint = 1;
130	} else
131		f_singlecol = 1;
132
133	/* Root is -A automatically. */
134	if (!getuid())
135		f_listdot = 1;
136
137	fts_options = FTS_PHYSICAL;
138	while ((ch = getopt(argc, argv, "1ABCFLRSTWabcdfghiklmnopqrstuwx")) != -1) {
139		switch (ch) {
140		/*
141		 * The -1, -C, -l, -m and -x options all override each other so
142		 * shell aliasing works correctly.
143		 */
144		case '1':
145			f_singlecol = 1;
146			f_column = f_columnacross = f_longform = f_stream = 0;
147			break;
148		case 'C':
149			f_column = 1;
150			f_columnacross = f_longform = f_singlecol = f_stream =
151			    0;
152			break;
153		case 'g':
154			if (f_grouponly != -1)
155				f_grouponly = 1;
156			f_longform = 1;
157			f_column = f_columnacross = f_singlecol = f_stream = 0;
158			break;
159		case 'l':
160			f_longform = 1;
161			f_column = f_columnacross = f_singlecol = f_stream = 0;
162			/* Never let -g take precedence over -l. */
163			f_grouponly = -1;
164			break;
165		case 'm':
166			f_stream = 1;
167			f_column = f_columnacross = f_longform = f_singlecol =
168			    0;
169			break;
170		case 'x':
171			f_columnacross = 1;
172			f_column = f_longform = f_singlecol = f_stream = 0;
173			break;
174		/* The -c and -u options override each other. */
175		case 'c':
176			f_statustime = 1;
177			f_accesstime = 0;
178			break;
179		case 'u':
180			f_accesstime = 1;
181			f_statustime = 0;
182			break;
183		case 'F':
184			f_type = 1;
185			break;
186		case 'L':
187			fts_options &= ~FTS_PHYSICAL;
188			fts_options |= FTS_LOGICAL;
189			break;
190		case 'R':
191			f_recursive = 1;
192			break;
193		case 'a':
194			fts_options |= FTS_SEEDOT;
195			/* FALLTHROUGH */
196		case 'A':
197			f_listdot = 1;
198			break;
199		/* The -B option turns off the -b, -q and -w options. */
200		case 'B':
201			f_nonprint = 0;
202			f_octal = 1;
203			f_octal_escape = 0;
204			break;
205		/* The -b option turns off the -B, -q and -w options. */
206		case 'b':
207			f_nonprint = 0;
208			f_octal = 0;
209			f_octal_escape = 1;
210			break;
211		/* The -d option turns off the -R option. */
212		case 'd':
213			f_listdir = 1;
214			f_recursive = 0;
215			break;
216		case 'f':
217			f_nosort = 1;
218			break;
219		case 'i':
220			f_inode = 1;
221			break;
222		case 'k':
223			blocksize = 1024;
224			kflag = 1;
225			break;
226		/* The -h option forces all sizes to be measured in bytes. */
227		case 'h':
228			f_humanize = 1;
229			break;
230		case 'n':
231			f_numericonly = 1;
232			break;
233		case 'o':
234			f_flags = 1;
235			break;
236		case 'p':
237			f_typedir = 1;
238			break;
239		/* The -q option turns off the -B, -b and -w options. */
240		case 'q':
241			f_nonprint = 1;
242			f_octal = 0;
243			f_octal_escape = 0;
244			break;
245		case 'r':
246			f_reversesort = 1;
247			break;
248		case 'S':
249			sortkey = BY_SIZE;
250			break;
251		case 's':
252			f_size = 1;
253			break;
254		case 'T':
255			f_sectime = 1;
256			break;
257		case 't':
258			sortkey = BY_TIME;
259			break;
260		case 'W':
261			f_whiteout = 1;
262			break;
263		/* The -w option turns off the -B, -b and -q options. */
264		case 'w':
265			f_nonprint = 0;
266			f_octal = 0;
267			f_octal_escape = 0;
268			break;
269		default:
270		case '?':
271			usage();
272		}
273	}
274	argc -= optind;
275	argv += optind;
276
277	if (f_column || f_columnacross || f_stream) {
278		if ((p = getenv("COLUMNS")) != NULL)
279			termwidth = atoi(p);
280	}
281
282	/*
283	 * If both -g and -l options, let -l take precedence.
284	 */
285	if (f_grouponly == -1)
286		f_grouponly = 0;
287
288	/*
289	 * If not -F, -i, -l, -p, -S, -s or -t options, don't require stat
290	 * information.
291	 */
292	if (!f_inode && !f_longform && !f_size && !f_type && !f_typedir &&
293	    sortkey == BY_NAME)
294		fts_options |= FTS_NOSTAT;
295
296	/*
297	 * If not -F, -d or -l options, follow any symbolic links listed on
298	 * the command line.
299	 */
300	if (!f_longform && !f_listdir && !f_type)
301		fts_options |= FTS_COMFOLLOW;
302
303	/*
304	 * If -W, show whiteout entries
305	 */
306#ifdef FTS_WHITEOUT
307	if (f_whiteout)
308		fts_options |= FTS_WHITEOUT;
309#endif
310
311	/* If -l or -s, figure out block size. */
312	if (f_inode || f_longform || f_size) {
313		if (!kflag)
314			(void)getbsize(NULL, &blocksize);
315		blocksize /= 512;
316	}
317
318	/* Select a sort function. */
319	if (f_reversesort) {
320		switch (sortkey) {
321		case BY_NAME:
322			sortfcn = revnamecmp;
323			break;
324		case BY_SIZE:
325			sortfcn = revsizecmp;
326			break;
327		case BY_TIME:
328			if (f_accesstime)
329				sortfcn = revacccmp;
330			else if (f_statustime)
331				sortfcn = revstatcmp;
332			else /* Use modification time. */
333				sortfcn = revmodcmp;
334			break;
335		}
336	} else {
337		switch (sortkey) {
338		case BY_NAME:
339			sortfcn = namecmp;
340			break;
341		case BY_SIZE:
342			sortfcn = sizecmp;
343			break;
344		case BY_TIME:
345			if (f_accesstime)
346				sortfcn = acccmp;
347			else if (f_statustime)
348				sortfcn = statcmp;
349			else /* Use modification time. */
350				sortfcn = modcmp;
351			break;
352		}
353	}
354
355	/* Select a print function. */
356	if (f_singlecol)
357		printfcn = printscol;
358	else if (f_columnacross)
359		printfcn = printacol;
360	else if (f_longform)
361		printfcn = printlong;
362	else if (f_stream)
363		printfcn = printstream;
364	else
365		printfcn = printcol;
366
367	if (argc)
368		traverse(argc, argv, fts_options);
369	else
370		traverse(1, dotav, fts_options);
371	exit(rval);
372	/* NOTREACHED */
373}
374
375static int output;			/* If anything output. */
376
377/*
378 * Traverse() walks the logical directory structure specified by the argv list
379 * in the order specified by the mastercmp() comparison function.  During the
380 * traversal it passes linked lists of structures to display() which represent
381 * a superset (may be exact set) of the files to be displayed.
382 */
383static void
384traverse(int argc, char *argv[], int options)
385{
386	FTS *ftsp;
387	FTSENT *p, *chp;
388	int ch_options;
389
390	if ((ftsp =
391	    fts_open(argv, options, f_nosort ? NULL : mastercmp)) == NULL)
392		err(EXIT_FAILURE, NULL);
393
394	display(NULL, fts_children(ftsp, 0));
395	if (f_listdir)
396		return;
397
398	/*
399	 * If not recursing down this tree and don't need stat info, just get
400	 * the names.
401	 */
402	ch_options = !f_recursive && options & FTS_NOSTAT ? FTS_NAMEONLY : 0;
403
404	while ((p = fts_read(ftsp)) != NULL)
405		switch (p->fts_info) {
406		case FTS_DC:
407			warnx("%s: directory causes a cycle", p->fts_name);
408			break;
409		case FTS_DNR:
410		case FTS_ERR:
411			warnx("%s: %s", p->fts_name, strerror(p->fts_errno));
412			rval = EXIT_FAILURE;
413			break;
414		case FTS_D:
415			if (p->fts_level != FTS_ROOTLEVEL &&
416			    p->fts_name[0] == '.' && !f_listdot)
417				break;
418
419			/*
420			 * If already output something, put out a newline as
421			 * a separator.  If multiple arguments, precede each
422			 * directory with its name.
423			 */
424			if (output)
425				(void)printf("\n%s:\n", p->fts_path);
426			else if (argc > 1) {
427				(void)printf("%s:\n", p->fts_path);
428				output = 1;
429			}
430
431			chp = fts_children(ftsp, ch_options);
432			display(p, chp);
433
434			if (!f_recursive && chp != NULL)
435				(void)fts_set(ftsp, p, FTS_SKIP);
436			break;
437		}
438	if (errno)
439		err(EXIT_FAILURE, "fts_read");
440}
441
442/*
443 * Display() takes a linked list of FTSENT structures and passes the list
444 * along with any other necessary information to the print function.  P
445 * points to the parent directory of the display list.
446 */
447static void
448display(FTSENT *p, FTSENT *list)
449{
450	struct stat *sp;
451	DISPLAY d;
452	FTSENT *cur;
453	NAMES *np;
454	u_int64_t btotal, stotal, maxblock, maxsize;
455	int maxinode, maxnlink, maxmajor, maxminor;
456	int bcfile, entries, flen, glen, ulen, maxflags, maxgroup, maxlen;
457	int maxuser, needstats;
458	const char *user, *group;
459	char buf[21];		/* 64 bits == 20 digits, +1 for NUL */
460	char nuser[12], ngroup[12];
461	char *flags = NULL;
462
463#ifdef __GNUC__
464	/* This outrageous construct just to shut up a GCC warning. */
465	(void) &maxsize;
466#endif
467
468	/*
469	 * If list is NULL there are two possibilities: that the parent
470	 * directory p has no children, or that fts_children() returned an
471	 * error.  We ignore the error case since it will be replicated
472	 * on the next call to fts_read() on the post-order visit to the
473	 * directory p, and will be signalled in traverse().
474	 */
475	if (list == NULL)
476		return;
477
478	needstats = f_inode || f_longform || f_size;
479	flen = 0;
480	maxinode = maxnlink = 0;
481	bcfile = 0;
482	maxuser = maxgroup = maxflags = maxlen = 0;
483	btotal = stotal = maxblock = maxsize = 0;
484	maxmajor = maxminor = 0;
485	for (cur = list, entries = 0; cur; cur = cur->fts_link) {
486		if (cur->fts_info == FTS_ERR || cur->fts_info == FTS_NS) {
487			warnx("%s: %s",
488			    cur->fts_name, strerror(cur->fts_errno));
489			cur->fts_number = NO_PRINT;
490			rval = EXIT_FAILURE;
491			continue;
492		}
493
494		/*
495		 * P is NULL if list is the argv list, to which different rules
496		 * apply.
497		 */
498		if (p == NULL) {
499			/* Directories will be displayed later. */
500			if (cur->fts_info == FTS_D && !f_listdir) {
501				cur->fts_number = NO_PRINT;
502				continue;
503			}
504		} else {
505			/* Only display dot file if -a/-A set. */
506			if (cur->fts_name[0] == '.' && !f_listdot) {
507				cur->fts_number = NO_PRINT;
508				continue;
509			}
510		}
511		if (cur->fts_namelen > maxlen)
512			maxlen = cur->fts_namelen;
513		if (needstats) {
514			sp = cur->fts_statp;
515			if (sp->st_blocks > maxblock)
516				maxblock = sp->st_blocks;
517			if (sp->st_ino > maxinode)
518				maxinode = sp->st_ino;
519			if (sp->st_nlink > maxnlink)
520				maxnlink = sp->st_nlink;
521			if (sp->st_size > maxsize)
522				maxsize = sp->st_size;
523			if (S_ISCHR(sp->st_mode) || S_ISBLK(sp->st_mode)) {
524				bcfile = 1;
525				if (major(sp->st_rdev) > maxmajor)
526					maxmajor = major(sp->st_rdev);
527				if (minor(sp->st_rdev) > maxminor)
528					maxminor = minor(sp->st_rdev);
529			}
530
531			btotal += sp->st_blocks;
532			stotal += sp->st_size;
533			if (f_longform) {
534				if (f_numericonly ||
535				    (user = user_from_uid(sp->st_uid, 0)) ==
536				    NULL) {
537					(void)snprintf(nuser, sizeof(nuser),
538					    "%u", sp->st_uid);
539					user = nuser;
540				}
541				if (f_numericonly ||
542				    (group = group_from_gid(sp->st_gid, 0)) ==
543				    NULL) {
544					(void)snprintf(ngroup, sizeof(ngroup),
545					    "%u", sp->st_gid);
546					group = ngroup;
547				}
548				if ((ulen = strlen(user)) > maxuser)
549					maxuser = ulen;
550				if ((glen = strlen(group)) > maxgroup)
551					maxgroup = glen;
552				if (f_flags) {
553					flags =
554					    flags_to_string(sp->st_flags, "-");
555					if ((flen = strlen(flags)) > maxflags)
556						maxflags = flen;
557				} else
558					flen = 0;
559
560				if ((np = malloc(sizeof(NAMES) +
561				    ulen + glen + flen + 3)) == NULL)
562					err(EXIT_FAILURE, NULL);
563
564				np->user = &np->data[0];
565				(void)strcpy(np->user, user);
566				np->group = &np->data[ulen + 1];
567				(void)strcpy(np->group, group);
568
569				if (f_flags) {
570					np->flags = &np->data[ulen + glen + 2];
571				  	(void)strcpy(np->flags, flags);
572				}
573				cur->fts_pointer = np;
574			}
575		}
576		++entries;
577	}
578
579	if (!entries)
580		return;
581
582	d.list = list;
583	d.entries = entries;
584	d.maxlen = maxlen;
585	if (needstats) {
586		d.btotal = btotal;
587		d.stotal = stotal;
588		if (f_humanize) {
589			d.s_block = 4; /* min buf length for humanize_number */
590		} else {
591			(void)snprintf(buf, sizeof(buf), "%llu",
592			    (long long)howmany(maxblock, blocksize));
593			d.s_block = strlen(buf);
594		}
595		d.s_flags = maxflags;
596		d.s_group = maxgroup;
597		(void)snprintf(buf, sizeof(buf), "%u", maxinode);
598		d.s_inode = strlen(buf);
599		(void)snprintf(buf, sizeof(buf), "%u", maxnlink);
600		d.s_nlink = strlen(buf);
601		if (f_humanize) {
602			d.s_size = 4; /* min buf length for humanize_number */
603		} else {
604			(void)snprintf(buf, sizeof(buf), "%llu",
605			    (long long)maxsize);
606			d.s_size = strlen(buf);
607		}
608		d.s_user = maxuser;
609		if (bcfile) {
610			(void)snprintf(buf, sizeof(buf), "%u", maxmajor);
611			d.s_major = strlen(buf);
612			(void)snprintf(buf, sizeof(buf), "%u", maxminor);
613			d.s_minor = strlen(buf);
614			if (d.s_major + d.s_minor + 2 > d.s_size)
615				d.s_size = d.s_major + d.s_minor + 2;
616			else if (d.s_size - d.s_minor - 2 > d.s_major)
617				d.s_major = d.s_size - d.s_minor - 2;
618		} else {
619			d.s_major = 0;
620			d.s_minor = 0;
621		}
622	}
623
624	printfcn(&d);
625	output = 1;
626
627	if (f_longform)
628		for (cur = list; cur; cur = cur->fts_link)
629			free(cur->fts_pointer);
630}
631
632/*
633 * Ordering for mastercmp:
634 * If ordering the argv (fts_level = FTS_ROOTLEVEL) return non-directories
635 * as larger than directories.  Within either group, use the sort function.
636 * All other levels use the sort function.  Error entries remain unsorted.
637 */
638static int
639mastercmp(const FTSENT **a, const FTSENT **b)
640{
641	int a_info, b_info;
642
643	a_info = (*a)->fts_info;
644	if (a_info == FTS_ERR)
645		return (0);
646	b_info = (*b)->fts_info;
647	if (b_info == FTS_ERR)
648		return (0);
649
650	if (a_info == FTS_NS || b_info == FTS_NS) {
651		if (b_info != FTS_NS)
652			return (1);
653		else if (a_info != FTS_NS)
654			return (-1);
655		else
656			return (namecmp(*a, *b));
657	}
658
659	if (a_info != b_info && !f_listdir &&
660	    (*a)->fts_level == FTS_ROOTLEVEL) {
661		if (a_info == FTS_D)
662			return (1);
663		else if (b_info == FTS_D)
664			return (-1);
665	}
666	return (sortfcn(*a, *b));
667}
668