print.c revision 90150 
1/*
2 * Copyright (c) 1989, 1993, 1994
3 *	The Regents of the University of California.  All rights reserved.
4 *
5 * This code is derived from software contributed to Berkeley by
6 * Michael Fischbein.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
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. All advertising materials mentioning features or use of this software
17 *    must display the following acknowledgement:
18 *	This product includes software developed by the University of
19 *	California, Berkeley and its contributors.
20 * 4. Neither the name of the University nor the names of its contributors
21 *    may be used to endorse or promote products derived from this software
22 *    without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * SUCH DAMAGE.
35 */
36
37#ifndef lint
38#if 0
39static char sccsid[] = "@(#)print.c	8.4 (Berkeley) 4/17/94";
40#else
41static const char rcsid[] =
42  "$FreeBSD: head/bin/ls/print.c 90150 2002-02-03 19:11:32Z markm $";
43#endif
44#endif /* not lint */
45
46#include <sys/param.h>
47#include <sys/stat.h>
48
49#include <err.h>
50#include <errno.h>
51#include <fts.h>
52#include <grp.h>
53#include <math.h>
54#include <langinfo.h>
55#include <pwd.h>
56#include <stdio.h>
57#include <stdlib.h>
58#include <string.h>
59#include <unistd.h>
60#ifdef COLORLS
61#include <ctype.h>
62#include <termcap.h>
63#include <signal.h>
64#endif
65
66#include "ls.h"
67#include "extern.h"
68
69static int	printaname(FTSENT *, u_long, u_long);
70static void	printlink(FTSENT *);
71static void	printtime(time_t);
72static int	printtype(u_int);
73static void	printsize(size_t, off_t);
74#ifdef COLORLS
75static void	endcolor(int);
76static int	colortype(mode_t);
77#endif
78
79#define	IS_NOPRINT(p)	((p)->fts_number == NO_PRINT)
80
81#define KILO_SZ(n) (n)
82#define MEGA_SZ(n) ((n) * (n))
83#define GIGA_SZ(n) ((n) * (n) * (n))
84#define TERA_SZ(n) ((n) * (n) * (n) * (n))
85#define PETA_SZ(n) ((n) * (n) * (n) * (n) * (n))
86
87#define KILO_2_SZ (KILO_SZ(1024ULL))
88#define MEGA_2_SZ (MEGA_SZ(1024ULL))
89#define GIGA_2_SZ (GIGA_SZ(1024ULL))
90#define TERA_2_SZ (TERA_SZ(1024ULL))
91#define PETA_2_SZ (PETA_SZ(1024ULL))
92
93static unsigned long long vals_base2[] = {1, KILO_2_SZ, MEGA_2_SZ, GIGA_2_SZ, TERA_2_SZ, PETA_2_SZ};
94
95typedef enum {
96	NONE, KILO, MEGA, GIGA, TERA, PETA, UNIT_MAX
97} unit_t;
98static unit_t unit_adjust(off_t *);
99
100static int unitp[] = {NONE, KILO, MEGA, GIGA, TERA, PETA};
101
102#ifdef COLORLS
103/* Most of these are taken from <sys/stat.h> */
104typedef enum Colors {
105	C_DIR,			/* directory */
106	C_LNK,			/* symbolic link */
107	C_SOCK,			/* socket */
108	C_FIFO,			/* pipe */
109	C_EXEC,			/* executable */
110	C_BLK,			/* block special */
111	C_CHR,			/* character special */
112	C_SUID,			/* setuid executable */
113	C_SGID,			/* setgid executable */
114	C_WSDIR,		/* directory writeble to others, with sticky
115				 * bit */
116	C_WDIR,			/* directory writeble to others, without
117				 * sticky bit */
118	C_NUMCOLORS		/* just a place-holder */
119} Colors;
120
121static const char *defcolors = "exfxcxdxbxegedabagacad";
122
123/* colors for file types */
124static struct {
125	int	num[2];
126	int	bold;
127} colors[C_NUMCOLORS];
128#endif
129
130void
131printscol(DISPLAY *dp)
132{
133	FTSENT *p;
134
135	for (p = dp->list; p; p = p->fts_link) {
136		if (IS_NOPRINT(p))
137			continue;
138		(void)printaname(p, dp->s_inode, dp->s_block);
139		(void)putchar('\n');
140	}
141}
142
143/*
144 * print name in current style
145 */
146static int
147printname(const char *name)
148{
149	if (f_octal || f_octal_escape)
150		return prn_octal(name);
151	else if (f_nonprint)
152		return prn_printable(name);
153	else
154		return printf("%s", name);
155}
156
157void
158printlong(DISPLAY *dp)
159{
160	struct stat *sp;
161	FTSENT *p;
162	NAMES *np;
163	char buf[20];
164#ifdef COLORLS
165	int color_printed = 0;
166#endif
167
168	if (dp->list->fts_level != FTS_ROOTLEVEL && (f_longform || f_size))
169		(void)printf("total %lu\n", howmany(dp->btotal, blocksize));
170
171	for (p = dp->list; p; p = p->fts_link) {
172		if (IS_NOPRINT(p))
173			continue;
174		sp = p->fts_statp;
175		if (f_inode)
176			(void)printf("%*lu ", dp->s_inode, (u_long)sp->st_ino);
177		if (f_size)
178			(void)printf("%*lld ",
179			    dp->s_block, howmany(sp->st_blocks, blocksize));
180		strmode(sp->st_mode, buf);
181		np = p->fts_pointer;
182		(void)printf("%s %*u %-*s  %-*s  ", buf, dp->s_nlink,
183		    sp->st_nlink, dp->s_user, np->user, dp->s_group,
184		    np->group);
185		if (f_flags)
186			(void)printf("%-*s ", dp->s_flags, np->flags);
187		if (f_lomac)
188			(void)printf("%-*s ", dp->s_lattr, np->lattr);
189		if (S_ISCHR(sp->st_mode) || S_ISBLK(sp->st_mode))
190			if (minor(sp->st_rdev) > 255 || minor(sp->st_rdev) < 0)
191				(void)printf("%3d, 0x%08x ",
192				    major(sp->st_rdev),
193				    (u_int)minor(sp->st_rdev));
194			else
195				(void)printf("%3d, %3d ",
196				    major(sp->st_rdev), minor(sp->st_rdev));
197		else if (dp->bcfile)
198			(void)printf("%*s%*lld ",
199			    8 - dp->s_size, "", dp->s_size, sp->st_size);
200		else
201			printsize(dp->s_size, sp->st_size);
202		if (f_accesstime)
203			printtime(sp->st_atime);
204		else if (f_statustime)
205			printtime(sp->st_ctime);
206		else
207			printtime(sp->st_mtime);
208#ifdef COLORLS
209		if (f_color)
210			color_printed = colortype(sp->st_mode);
211#endif
212		(void)printname(p->fts_name);
213#ifdef COLORLS
214		if (f_color && color_printed)
215			endcolor(0);
216#endif
217		if (f_type)
218			(void)printtype(sp->st_mode);
219		if (S_ISLNK(sp->st_mode))
220			printlink(p);
221		(void)putchar('\n');
222	}
223}
224
225void
226printcol(DISPLAY *dp)
227{
228	extern int termwidth;
229	static FTSENT **array;
230	static int lastentries = -1;
231	FTSENT *p;
232	int base;
233	int chcnt;
234	int cnt;
235	int col;
236	int colwidth;
237	int endcol;
238	int num;
239	int numcols;
240	int numrows;
241	int row;
242	int tabwidth;
243
244	if (f_notabs)
245		tabwidth = 1;
246	else
247		tabwidth = 8;
248
249	/*
250	 * Have to do random access in the linked list -- build a table
251	 * of pointers.
252	 */
253	if (dp->entries > lastentries) {
254		lastentries = dp->entries;
255		if ((array =
256		    realloc(array, dp->entries * sizeof(FTSENT *))) == NULL) {
257			warn(NULL);
258			printscol(dp);
259		}
260	}
261	for (p = dp->list, num = 0; p; p = p->fts_link)
262		if (p->fts_number != NO_PRINT)
263			array[num++] = p;
264
265	colwidth = dp->maxlen;
266	if (f_inode)
267		colwidth += dp->s_inode + 1;
268	if (f_size)
269		colwidth += dp->s_block + 1;
270	if (f_type)
271		colwidth += 1;
272
273	colwidth = (colwidth + tabwidth) & ~(tabwidth - 1);
274	if (termwidth < 2 * colwidth) {
275		printscol(dp);
276		return;
277	}
278	numcols = termwidth / colwidth;
279	numrows = num / numcols;
280	if (num % numcols)
281		++numrows;
282
283	if (dp->list->fts_level != FTS_ROOTLEVEL && (f_longform || f_size))
284		(void)printf("total %lu\n", howmany(dp->btotal, blocksize));
285	for (row = 0; row < numrows; ++row) {
286		endcol = colwidth;
287		for (base = row, chcnt = col = 0; col < numcols; ++col) {
288			chcnt += printaname(array[base], dp->s_inode,
289			    dp->s_block);
290			if ((base += numrows) >= num)
291				break;
292			while ((cnt = ((chcnt + tabwidth) & ~(tabwidth - 1)))
293			    <= endcol) {
294				(void)putchar(f_notabs ? ' ' : '\t');
295				chcnt = cnt;
296			}
297			endcol += colwidth;
298		}
299		(void)putchar('\n');
300	}
301}
302
303/*
304 * print [inode] [size] name
305 * return # of characters printed, no trailing characters.
306 */
307static int
308printaname(FTSENT *p, u_long inodefield, u_long sizefield)
309{
310	struct stat *sp;
311	int chcnt;
312#ifdef COLORLS
313	int color_printed = 0;
314#endif
315
316	sp = p->fts_statp;
317	chcnt = 0;
318	if (f_inode)
319		chcnt += printf("%*lu ", (int)inodefield, (u_long)sp->st_ino);
320	if (f_size)
321		chcnt += printf("%*lld ",
322		    (int)sizefield, howmany(sp->st_blocks, blocksize));
323#ifdef COLORLS
324	if (f_color)
325		color_printed = colortype(sp->st_mode);
326#endif
327	chcnt += printname(p->fts_name);
328#ifdef COLORLS
329	if (f_color && color_printed)
330		endcolor(0);
331#endif
332	if (f_type)
333		chcnt += printtype(sp->st_mode);
334	return (chcnt);
335}
336
337static void
338printtime(time_t ftime)
339{
340	char longstring[80];
341	static time_t now;
342	const char *format;
343	static int d_first = -1;
344
345	if (d_first < 0)
346		d_first = (*nl_langinfo(D_MD_ORDER) == 'd');
347	if (now == 0)
348		now = time(NULL);
349
350#define	SIXMONTHS	((365 / 2) * 86400)
351	if (f_sectime)
352		/* mmm dd hh:mm:ss yyyy || dd mmm hh:mm:ss yyyy */
353		format = d_first ? "%e %b %T %Y " : "%b %e %T %Y ";
354	else if (ftime + SIXMONTHS > now && ftime < now + SIXMONTHS)
355		/* mmm dd hh:mm || dd mmm hh:mm */
356		format = d_first ? "%e %b %R " : "%b %e %R ";
357	else
358		/* mmm dd  yyyy || dd mmm  yyyy */
359		format = d_first ? "%e %b  %Y " : "%b %e  %Y ";
360	strftime(longstring, sizeof(longstring), format, localtime(&ftime));
361	fputs(longstring, stdout);
362}
363
364static int
365printtype(u_int mode)
366{
367	switch (mode & S_IFMT) {
368	case S_IFDIR:
369		(void)putchar('/');
370		return (1);
371	case S_IFIFO:
372		(void)putchar('|');
373		return (1);
374	case S_IFLNK:
375		(void)putchar('@');
376		return (1);
377	case S_IFSOCK:
378		(void)putchar('=');
379		return (1);
380	case S_IFWHT:
381		(void)putchar('%');
382		return (1);
383	default:
384	}
385	if (mode & (S_IXUSR | S_IXGRP | S_IXOTH)) {
386		(void)putchar('*');
387		return (1);
388	}
389	return (0);
390}
391
392#ifdef COLORLS
393static int
394putch(int c)
395{
396	(void)putchar(c);
397	return 0;
398}
399
400static int
401writech(int c)
402{
403	char tmp = c;
404
405	(void)write(STDOUT_FILENO, &tmp, 1);
406	return 0;
407}
408
409static void
410printcolor(Colors c)
411{
412	char *ansiseq;
413
414	if (colors[c].bold)
415		tputs(enter_bold, 1, putch);
416
417	if (colors[c].num[0] != -1) {
418		ansiseq = tgoto(ansi_fgcol, 0, colors[c].num[0]);
419		if (ansiseq)
420			tputs(ansiseq, 1, putch);
421	}
422	if (colors[c].num[1] != -1) {
423		ansiseq = tgoto(ansi_bgcol, 0, colors[c].num[1]);
424		if (ansiseq)
425			tputs(ansiseq, 1, putch);
426	}
427}
428
429static void
430endcolor(int sig)
431{
432	tputs(ansi_coloff, 1, sig ? writech : putch);
433	tputs(attrs_off, 1, sig ? writech : putch);
434}
435
436static int
437colortype(mode_t mode)
438{
439	switch (mode & S_IFMT) {
440	case S_IFDIR:
441		if (mode & S_IWOTH)
442			if (mode & S_ISTXT)
443				printcolor(C_WSDIR);
444			else
445				printcolor(C_WDIR);
446		else
447			printcolor(C_DIR);
448		return (1);
449	case S_IFLNK:
450		printcolor(C_LNK);
451		return (1);
452	case S_IFSOCK:
453		printcolor(C_SOCK);
454		return (1);
455	case S_IFIFO:
456		printcolor(C_FIFO);
457		return (1);
458	case S_IFBLK:
459		printcolor(C_BLK);
460		return (1);
461	case S_IFCHR:
462		printcolor(C_CHR);
463		return (1);
464	}
465	if (mode & (S_IXUSR | S_IXGRP | S_IXOTH)) {
466		if (mode & S_ISUID)
467			printcolor(C_SUID);
468		else if (mode & S_ISGID)
469			printcolor(C_SGID);
470		else
471			printcolor(C_EXEC);
472		return (1);
473	}
474	return (0);
475}
476
477void
478parsecolors(const char *cs)
479{
480	int i;
481	int j;
482	int len;
483	char c[2];
484	short legacy_warn = 0;
485
486	if (cs == NULL)
487		cs = "";	/* LSCOLORS not set */
488	len = strlen(cs);
489	for (i = 0; i < C_NUMCOLORS; i++) {
490		colors[i].bold = 0;
491
492		if (len <= 2 * i) {
493			c[0] = defcolors[2 * i];
494			c[1] = defcolors[2 * i + 1];
495		} else {
496			c[0] = cs[2 * i];
497			c[1] = cs[2 * i + 1];
498		}
499		for (j = 0; j < 2; j++) {
500			/* Legacy colours used 0-7 */
501			if (c[j] >= '0' && c[j] <= '7') {
502				colors[i].num[j] = c[j] - '0';
503				if (!legacy_warn) {
504					fprintf(stderr,
505					    "warn: LSCOLORS should use "
506					    "characters a-h instead of 0-9 ("
507					    "see the manual page)\n");
508				}
509				legacy_warn = 1;
510			} else if (c[j] >= 'a' && c[j] <= 'h')
511				colors[i].num[j] = c[j] - 'a';
512			else if (c[j] >= 'A' && c[j] <= 'H') {
513				colors[i].num[j] = c[j] - 'A';
514				colors[i].bold = 1;
515			} else if (tolower((unsigned char)c[j] == 'x'))
516				colors[i].num[j] = -1;
517			else {
518				fprintf(stderr,
519				    "error: invalid character '%c' in LSCOLORS"
520				    " env var\n", c[j]);
521				colors[i].num[j] = -1;
522			}
523		}
524	}
525}
526
527void
528colorquit(int sig)
529{
530	endcolor(sig);
531
532	(void)signal(sig, SIG_DFL);
533	(void)kill(getpid(), sig);
534}
535
536#endif /* COLORLS */
537
538static void
539printlink(FTSENT *p)
540{
541	int lnklen;
542	char name[MAXPATHLEN + 1];
543	char path[MAXPATHLEN + 1];
544
545	if (p->fts_level == FTS_ROOTLEVEL)
546		(void)snprintf(name, sizeof(name), "%s", p->fts_name);
547	else
548		(void)snprintf(name, sizeof(name),
549		    "%s/%s", p->fts_parent->fts_accpath, p->fts_name);
550	if ((lnklen = readlink(name, path, sizeof(path) - 1)) == -1) {
551		(void)fprintf(stderr, "\nls: %s: %s\n", name, strerror(errno));
552		return;
553	}
554	path[lnklen] = '\0';
555	(void)printf(" -> ");
556	(void)printname(path);
557}
558
559static void
560printsize(size_t width, off_t bytes)
561{
562	unit_t unit;
563
564	if (f_humanval) {
565		unit = unit_adjust(&bytes);
566
567		if (bytes == 0)
568			(void)printf("%*s ", width, "0B");
569		else
570			(void)printf("%*lld%c ", width - 1, bytes,
571			    "BKMGTPE"[unit]);
572	} else
573		(void)printf("%*lld ", width, bytes);
574}
575
576/*
577 * Output in "human-readable" format.  Uses 3 digits max and puts
578 * unit suffixes at the end.  Makes output compact and easy to read,
579 * especially on huge disks.
580 *
581 */
582unit_t
583unit_adjust(off_t *val)
584{
585	double abval;
586	unit_t unit;
587	unsigned int unit_sz;
588
589	abval = fabs((double)*val);
590
591	unit_sz = abval ? ilogb(abval) / 10 : 0;
592
593	if (unit_sz >= UNIT_MAX) {
594		unit = NONE;
595	} else {
596		unit = unitp[unit_sz];
597		*val /= (double)vals_base2[unit_sz];
598	}
599
600	return (unit);
601}
602