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