toys/posix/ls.c

   1 /* ls.c - list files
   2  *
   3  * Copyright 2012 Andre Renaud <andre@bluewatersys.com>
   4  * Copyright 2012 Rob Landley <rob@landley.net>
   5  *
   6  * See http://opengroup.org/onlinepubs/9699919799/utilities/ls.html
   7
   8 USE_LS(NEWTOY(ls, USE_LS_COLOR("(color):;")USE_LS_SMACK("Z")"goACFHLRSacdfiklmnpqrstux1[-1Cglmnox][-cu][-ftS][-HL]", TOYFLAG_BIN|TOYFLAG_LOCALE))
   9
  10 config LS
  11   bool "ls"
  12   default y
  13   help
  14     usage: ls [-ACFHLRSacdfiklmnpqrstux1] [directory...]
  15     list files
  16
  17     what to show:
  18     -a  all files including .hidden             -c  use ctime for timestamps
  19     -d  directory, not contents                 -i  inode number
  20     -k  block sizes in kilobytes                -p  put a '/' after dir names
  21     -q  unprintable chars as '?'                -s  size (in blocks)
  22     -u  use access time for timestamps          -A  list all files but . and ..
  23     -H  follow command line symlinks            -L  follow symlinks
  24     -R  recursively list files in subdirs       -F  append /dir *exe @sym |FIFO
  25
  26     output formats:
  27     -1  list one file per line                  -C  columns (sorted vertically)
  28     -g  like -l but no owner                    -l  long (show full details)
  29     -m  comma separated                         -n  like -l but numeric uid/gid
  30     -o  like -l but no group                    -x  columns (horizontal sort)
  31
  32     sorting (default is alphabetical):
  33     -f  unsorted        -r  reverse     -t  timestamp   -S  size
  34
  35 config LS_SMACK
  36   bool
  37   default y
  38   depends on LS && TOYBOX_SMACK
  39   help
  40     usage: ls [-Z]
  41
  42     -Z  security context
  43
  44 config LS_COLOR
  45   bool "ls --color"
  46   default y
  47   depends on LS
  48   help
  49     usage: ls --color[=auto]
  50
  51     --color  device=yellow  symlink=turquoise/red  dir=blue  socket=purple
  52              files: exe=green  suid=red  suidfile=redback  stickydir=greenback
  53              =auto means detect if output is a tty.
  54 */
  55
  56 #define FOR_ls
  57 #include "toys.h"
  58
  59 // test sst output (suid/sticky in ls flaglist)
  60
  61 // ls -lR starts .: then ./subdir:
  62
  63 GLOBALS(
  64   char *color;
  65
  66   struct dirtree *files;
  67
  68   unsigned screen_width;
  69   int nl_title;
  70   char uid_buf[12], gid_buf[12];
  71 )
  72
  73 // Does two things: 1) Returns wcwidth(utf8) version of strlen,
  74 // 2) replaces unprintable characters input string with '?' wildcard char.
  75 int strwidth(char *s)
  76 {
  77   int total = 0, width, len;
  78   wchar_t c;
  79
  80   if (!CFG_TOYBOX_I18N) {
  81     total = strlen(s);
  82     if (toys.optflags & FLAG_q) for (; *s; s++) if (!isprint(*s)) *s = '?';
  83   } else while (*s) {
  84     len = mbrtowc(&c, s, MB_CUR_MAX, 0);
  85     if (len < 1 || (width = wcwidth(c)) < 0) {
  86       total++;
  87       if (toys.optflags & FLAG_q) *s = '?';
  88       s++;
  89     } else {
  90       s += len;
  91       total += width;
  92     }
  93   }
  94
  95   return total;
  96 }
  97
  98 void dlist_to_dirtree(struct dirtree *parent)
  99 {
 100   // Turn double_list into dirtree
 101   struct dirtree *dt = parent->child;
 102   if (dt) {
 103     dt->parent->next = NULL;
 104     while (dt) {
 105       dt->parent = parent;
 106       dt = dt->next;
 107     }
 108   }
 109 }
 110
 111 static char endtype(struct stat *st)
 112 {
 113   mode_t mode = st->st_mode;
 114   if ((toys.optflags&(FLAG_F|FLAG_p)) && S_ISDIR(mode)) return '/';
 115   if (toys.optflags & FLAG_F) {
 116     if (S_ISLNK(mode)) return '@';
 117     if (S_ISREG(mode) && (mode&0111)) return '*';
 118     if (S_ISFIFO(mode)) return '|';
 119     if (S_ISSOCK(mode)) return '=';
 120   }
 121   return 0;
 122 }
 123
 124 static char *getusername(uid_t uid)
 125 {
 126   struct passwd *pw = getpwuid(uid);
 127
 128   sprintf(TT.uid_buf, "%u", (unsigned)uid);
 129   return pw ? pw->pw_name : TT.uid_buf;
 130 }
 131
 132 static char *getgroupname(gid_t gid)
 133 {
 134   struct group *gr = getgrgid(gid);
 135
 136   sprintf(TT.gid_buf, "%u", (unsigned)gid);
 137   return gr ? gr->gr_name : TT.gid_buf;
 138 }
 139
 140 static int numlen(long long ll)
 141 {
 142   return snprintf(0, 0, "%llu", ll);
 143 }
 144
 145 // measure/print smack attributes
 146 // lr = 0 just measure, 1 left justified, 2 right justified
 147 static unsigned zmack(struct dirtree *dt, int pad, int lr)
 148 {
 149   char buf[SMACK_LABEL_LEN+1];
 150   int fd = openat(dirtree_parentfd(dt), dt->name, O_PATH|O_NOFOLLOW);
 151   ssize_t len = 1;
 152
 153   strcpy(buf, "?");
 154   if (fd != -1) {
 155     len = fgetxattr(fd, XATTR_NAME_SMACK, lr?buf:0, lr?SMACK_LABEL_LEN:0);
 156     close(fd);
 157
 158     if (len<1 || len>SMACK_LABEL_LEN) len = 0;
 159     else buf[len] = 0;
 160   }
 161   if (lr) printf(" %*s "+(lr==2), pad*((2*(lr==1))-1), buf);
 162
 163   return len;
 164 }
 165
 166 // Figure out size of printable entry fields for display indent/wrap
 167
 168 static void entrylen(struct dirtree *dt, unsigned *len)
 169 {
 170   struct stat *st = &(dt->st);
 171   unsigned flags = toys.optflags;
 172
 173   *len = strwidth(dt->name);
 174   if (endtype(st)) ++*len;
 175   if (flags & FLAG_m) ++*len;
 176
 177   len[1] = (flags & FLAG_i) ? numlen(st->st_ino) : 0;
 178   if (flags & (FLAG_l|FLAG_o|FLAG_n|FLAG_g)) {
 179     unsigned fn = flags & FLAG_n;
 180     len[2] = numlen(st->st_nlink);
 181     len[3] = fn ? numlen(st->st_uid) : strwidth(getusername(st->st_uid));
 182     len[4] = fn ? numlen(st->st_gid) : strwidth(getgroupname(st->st_gid));
 183     if (S_ISBLK(st->st_mode) || S_ISCHR(st->st_mode)) {
 184       // cheating slightly here: assuming minor is always 3 digits to avoid
 185       // tracking another column
 186       len[5] = numlen(major(st->st_rdev))+5;
 187     } else len[5] = numlen(st->st_size);
 188   }
 189
 190   len[6] = (flags & FLAG_s) ? numlen(st->st_blocks) : 0;
 191
 192   if (CFG_LS_SMACK && (flags & FLAG_Z)) len[7] = zmack(dt, 0, 0);
 193 }
 194
 195 static int compare(void *a, void *b)
 196 {
 197   struct dirtree *dta = *(struct dirtree **)a;
 198   struct dirtree *dtb = *(struct dirtree **)b;
 199   int ret = 0, reverse = (toys.optflags & FLAG_r) ? -1 : 1;
 200
 201   if (toys.optflags & FLAG_S) {
 202     if (dta->st.st_size > dtb->st.st_size) ret = -1;
 203     else if (dta->st.st_size < dtb->st.st_size) ret = 1;
 204   }
 205   if (toys.optflags & FLAG_t) {
 206     if (dta->st.st_mtime > dtb->st.st_mtime) ret = -1;
 207     else if (dta->st.st_mtime < dtb->st.st_mtime) ret = 1;
 208   }
 209   if (!ret) ret = strcmp(dta->name, dtb->name);
 210   return ret * reverse;
 211 }
 212
 213 // callback from dirtree_recurse() determining how to handle this entry.
 214
 215 static int filter(struct dirtree *new)
 216 {
 217   int flags = toys.optflags;
 218
 219   // Special case to handle enormous dirs without running out of memory.
 220   if (flags == (FLAG_1|FLAG_f)) {
 221     xprintf("%s\n", new->name);
 222     return 0;
 223   }
 224
 225   if (flags & FLAG_u) new->st.st_mtime = new->st.st_atime;
 226   if (flags & FLAG_c) new->st.st_mtime = new->st.st_ctime;
 227   if (flags & FLAG_k) new->st.st_blocks = (new->st.st_blocks + 1) / 2;
 228
 229   if (flags & (FLAG_a|FLAG_f)) return DIRTREE_SAVE;
 230   if (!(flags & FLAG_A) && new->name[0]=='.') return 0;
 231
 232   return dirtree_notdotdot(new) & DIRTREE_SAVE;
 233 }
 234
 235 // For column view, calculate horizontal position (for padding) and return
 236 // index of next entry to display.
 237
 238 static unsigned long next_column(unsigned long ul, unsigned long dtlen,
 239   unsigned columns, unsigned *xpos)
 240 {
 241   unsigned long transition;
 242   unsigned height, widecols;
 243
 244   // Horizontal sort is easy
 245   if (!(toys.optflags & FLAG_C)) {
 246     *xpos = ul % columns;
 247     return ul;
 248   }
 249
 250   // vertical sort
 251
 252   // For -x, calculate height of display, rounded up
 253   height = (dtlen+columns-1)/columns;
 254
 255   // Sanity check: does wrapping render this column count impossible
 256   // due to the right edge wrapping eating a whole row?
 257   if (height*columns - dtlen >= height) {
 258     *xpos = columns;
 259     return 0;
 260   }
 261
 262   // Uneven rounding goes along right edge
 263   widecols = dtlen % height;
 264   if (!widecols) widecols = height;
 265   transition = widecols * columns;
 266   if (ul < transition) {
 267     *xpos =  ul % columns;
 268     return (*xpos*height) + (ul/columns);
 269   }
 270
 271   ul -= transition;
 272   *xpos = ul % (columns-1);
 273
 274   return (*xpos*height) + widecols + (ul/(columns-1));
 275 }
 276
 277 int color_from_mode(mode_t mode)
 278 {
 279   int color = 0;
 280
 281   if (S_ISDIR(mode)) color = 256+34;
 282   else if (S_ISLNK(mode)) color = 256+36;
 283   else if (S_ISBLK(mode) || S_ISCHR(mode)) color = 256+33;
 284   else if (S_ISREG(mode) && (mode&0111)) color = 256+32;
 285   else if (S_ISFIFO(mode)) color = 33;
 286   else if (S_ISSOCK(mode)) color = 256+35;
 287
 288   return color;
 289 }
 290
 291 // Display a list of dirtree entries, according to current format
 292 // Output types -1, -l, -C, or stream
 293
 294 static void listfiles(int dirfd, struct dirtree *indir)
 295 {
 296   struct dirtree *dt, **sort = 0;
 297   unsigned long dtlen = 0, ul = 0;
 298   unsigned width, flags = toys.optflags, totals[8], len[8], totpad = 0,
 299     *colsizes = (unsigned *)(toybuf+260), columns = (sizeof(toybuf)-260)/4;
 300
 301   memset(totals, 0, sizeof(totals));
 302
 303   // Silently descend into single directory listed by itself on command line.
 304   // In this case only show dirname/total header when given -R.
 305   if (!indir->parent) {
 306     if (!(dt = indir->child)) return;
 307     if (S_ISDIR(dt->st.st_mode) && !dt->next && !(flags & FLAG_d)) {
 308       dt->extra = 1;
 309       listfiles(open(dt->name, 0), dt);
 310       return;
 311     }
 312   } else {
 313     // Read directory contents. We dup() the fd because this will close it.
 314     indir->data = dup(dirfd);
 315     dirtree_recurse(indir, filter, (flags&FLAG_L) ? DIRTREE_SYMFOLLOW : 0);
 316   }
 317
 318   // Copy linked list to array and sort it. Directories go in array because
 319   // we visit them in sorted order.
 320
 321   for (;;) {
 322     for (dt = indir->child; dt; dt = dt->next) {
 323       if (sort) sort[dtlen] = dt;
 324       dtlen++;
 325     }
 326     if (sort) break;
 327     sort = xmalloc(dtlen * sizeof(void *));
 328     dtlen = 0;
 329     continue;
 330   }
 331
 332   // Label directory if not top of tree, or if -R
 333   if (indir->parent && (!indir->extra || (flags & FLAG_R)))
 334   {
 335     char *path = dirtree_path(indir, 0);
 336
 337     if (TT.nl_title++) xputc('\n');
 338     xprintf("%s:\n", path);
 339     free(path);
 340   }
 341
 342   if (!(flags & FLAG_f)) {
 343     unsigned long long blocks = 0;
 344
 345     qsort(sort, dtlen, sizeof(void *), (void *)compare);
 346     for (ul = 0; ul<dtlen; ul++) {
 347       entrylen(sort[ul], len);
 348       for (width = 0; width<8; width++)
 349         if (len[width]>totals[width]) totals[width] = len[width];
 350       totpad = totals[1]+!!totals[1]+totals[6]+!!totals[6]+totals[7]+!!totals[7];
 351       blocks += sort[ul]->st.st_blocks;
 352     }
 353     if (flags & (FLAG_l|FLAG_o|FLAG_n|FLAG_g|FLAG_s) && indir->parent)
 354       xprintf("total %llu\n", blocks);
 355   }
 356
 357   // Find largest entry in each field for display alignment
 358   if (flags & (FLAG_C|FLAG_x)) {
 359
 360     // columns can't be more than toybuf can hold, or more than files,
 361     // or > 1/2 screen width (one char filename, one space).
 362     if (columns > TT.screen_width/2) columns = TT.screen_width/2;
 363     if (columns > dtlen) columns = dtlen;
 364
 365     // Try to fit as many columns as we can, dropping down by one each time
 366     for (;columns > 1; columns--) {
 367       unsigned c, totlen = columns;
 368
 369       memset(colsizes, 0, columns*sizeof(unsigned));
 370       for (ul=0; ul<dtlen; ul++) {
 371         entrylen(sort[next_column(ul, dtlen, columns, &c)], len);
 372         *len += totpad;
 373         if (c == columns) break;
 374         // Expand this column if necessary, break if that puts us over budget
 375         if (*len > colsizes[c]) {
 376           totlen += (*len)-colsizes[c];
 377           colsizes[c] = *len;
 378           if (totlen > TT.screen_width) break;
 379         }
 380       }
 381       // If everything fit, stop here
 382       if (ul == dtlen) break;
 383     }
 384   }
 385
 386   // Loop through again to produce output.
 387   memset(toybuf, ' ', 256);
 388   width = 0;
 389   for (ul = 0; ul<dtlen; ul++) {
 390     unsigned curcol, color = 0;
 391     unsigned long next = next_column(ul, dtlen, columns, &curcol);
 392     struct stat *st = &(sort[next]->st);
 393     mode_t mode = st->st_mode;
 394     char et = endtype(st);
 395
 396     // Skip directories at the top of the tree when -d isn't set
 397     if (S_ISDIR(mode) && !indir->parent && !(flags & FLAG_d)) continue;
 398     TT.nl_title=1;
 399
 400     // Handle padding and wrapping for display purposes
 401     entrylen(sort[next], len);
 402     if (ul) {
 403       if (flags & FLAG_m) xputc(',');
 404       if (flags & (FLAG_C|FLAG_x)) {
 405         if (!curcol) xputc('\n');
 406       } else if ((flags & FLAG_1) || width+1+*len > TT.screen_width) {
 407         xputc('\n');
 408         width = 0;
 409       } else {
 410         xputc(' ');
 411         width++;
 412       }
 413     }
 414     width += *len;
 415
 416     if (flags & FLAG_i)
 417       xprintf("%*lu ", totals[1], (unsigned long)st->st_ino);
 418     if (flags & FLAG_s)
 419       xprintf("%*lu ", totals[6], (unsigned long)st->st_blocks);
 420
 421     if (flags & (FLAG_l|FLAG_o|FLAG_n|FLAG_g)) {
 422       struct tm *tm;
 423       char perm[11], thyme[64], *usr, *upad, *grp, *grpad;
 424
 425       mode_to_string(mode, perm);
 426
 427       if (flags&FLAG_o) grp = grpad = toybuf+256;
 428       else {
 429         if (flags&FLAG_n) sprintf(grp = thyme, "%u", (unsigned)st->st_gid);
 430         else strwidth(grp = getgroupname(st->st_gid));
 431         grpad = toybuf+256-(totals[4]-len[4]);
 432       }
 433
 434       if (flags&FLAG_g) usr = upad = toybuf+256;
 435       else {
 436         upad = toybuf+255-(totals[3]-len[3]);
 437         if (flags&FLAG_n) sprintf(usr = TT.uid_buf, "%u", (unsigned)st->st_uid);
 438         else strwidth(usr = getusername(st->st_uid));
 439       }
 440
 441       // Coerce the st types into something we know we can print.
 442       printf("%s% *ld %s%s%s%s", perm, totals[2]+1, (long)st->st_nlink,
 443              usr, upad, grp, grpad);
 444
 445       if (CFG_LS_SMACK && (flags & FLAG_Z)) zmack(sort[next], totals[7], 1);
 446
 447       if (S_ISCHR(st->st_mode) || S_ISBLK(st->st_mode))
 448         printf("% *d,% 4d", totals[5]-4, major(st->st_rdev),minor(st->st_rdev));
 449       else printf("% *"PRId64, totals[5]+1, (int64_t)st->st_size);
 450
 451       tm = localtime(&(st->st_mtime));
 452       strftime(thyme, sizeof(thyme), "%F %H:%M", tm);
 453       xprintf(" %s ", thyme);
 454     } else if (CFG_LS_SMACK && (flags & FLAG_Z)) zmack(sort[next], totals[7],2);
 455
 456     if (flags & FLAG_color) {
 457       color = color_from_mode(st->st_mode);
 458       if (color) printf("\033[%d;%dm", color>>8, color&255);
 459     }
 460
 461     if (flags & FLAG_q) {
 462       char *p;
 463       for (p=sort[next]->name; *p; p++) fputc(isprint(*p) ? *p : '?', stdout);
 464     } else xprintf("%s", sort[next]->name);
 465     if (color) xprintf("\033[0m");
 466
 467     if ((flags & (FLAG_l|FLAG_o|FLAG_n|FLAG_g)) && S_ISLNK(mode)) {
 468       printf(" -> ");
 469       if (flags & FLAG_color) {
 470         struct stat st2;
 471
 472         if (fstatat(dirfd, sort[next]->symlink, &st2, 0)) color = 256+31;
 473         else color = color_from_mode(st2.st_mode);
 474
 475         if (color) printf("\033[%d;%dm", color>>8, color&255);
 476       }
 477
 478       printf("%s", sort[next]->symlink);
 479       if (color) printf("\033[0m");
 480     }
 481
 482     if (et) xputc(et);
 483
 484     // Pad columns
 485     if (flags & (FLAG_C|FLAG_x)) {
 486       curcol = colsizes[curcol]-(*len)-totpad;
 487       if (curcol < 255) xprintf("%s", toybuf+255-curcol);
 488     }
 489   }
 490
 491   if (width) xputc('\n');
 492
 493   // Free directory entries, recursing first if necessary.
 494
 495   for (ul = 0; ul<dtlen; free(sort[ul++])) {
 496     if ((flags & FLAG_d) || !S_ISDIR(sort[ul]->st.st_mode)
 497       || !dirtree_notdotdot(sort[ul])) continue;
 498
 499     // Recurse into dirs if at top of the tree or given -R
 500     if (!indir->parent || (flags & FLAG_R))
 501       listfiles(openat(dirfd, sort[ul]->name, 0), sort[ul]);
 502   }
 503   free(sort);
 504   if (dirfd != AT_FDCWD) close(dirfd);
 505 }
 506
 507 void ls_main(void)
 508 {
 509   char **s, *noargs[] = {".", 0};
 510   struct dirtree *dt;
 511
 512   TT.screen_width = 80;
 513   terminal_size(&TT.screen_width, NULL);
 514   if (TT.screen_width<2) TT.screen_width = 2;
 515
 516   // Do we have an implied -1
 517   if (!isatty(1)) {
 518     toys.optflags |= FLAG_1;
 519     if (TT.color) toys.optflags ^= FLAG_color;
 520   } else if (toys.optflags&(FLAG_l|FLAG_o|FLAG_n|FLAG_g))
 521     toys.optflags |= FLAG_1;
 522   else if (!(toys.optflags&(FLAG_1|FLAG_x|FLAG_m))) toys.optflags |= FLAG_C;
 523   // The optflags parsing infrastructure should really do this for us,
 524   // but currently it has "switch off when this is set", so "-dR" and "-Rd"
 525   // behave differently
 526   if (toys.optflags & FLAG_d) toys.optflags &= ~FLAG_R;
 527
 528   // Iterate through command line arguments, collecting directories and files.
 529   // Non-absolute paths are relative to current directory.
 530   TT.files = dirtree_add_node(0, 0, 0);
 531   for (s = *toys.optargs ? toys.optargs : noargs; *s; s++) {
 532     dt = dirtree_add_node(0, *s, !(toys.optflags & (FLAG_l|FLAG_d|FLAG_F))
 533       || (toys.optflags & (FLAG_L|FLAG_H)));
 534
 535     if (!dt) {
 536       toys.exitval = 1;
 537       continue;
 538     }
 539
 540     // Typecast means double_list->prev temporarirly goes in dirtree->parent
 541     dlist_add_nomalloc((void *)&TT.files->child, (struct double_list *)dt);
 542   }
 543
 544   // Turn double_list into dirtree
 545   dlist_to_dirtree(TT.files);
 546
 547   // Display the files we collected
 548   listfiles(AT_FDCWD, TT.files);
 549
 550   if (CFG_TOYBOX_FREE) free(TT.files);
 551 }