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