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_Z("Z")"goACFHLRSacdfiklmnpqrstux1[-Cxm1][-Cxml][-Cxmo][-Cxmg][-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_Z
  36   bool
  37   default y
  38   depends on LS && (TOYBOX_SELINUX || 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 static char endtype(struct stat *st)
  99 {
 100   mode_t mode = st->st_mode;
 101   if ((toys.optflags&(FLAG_F|FLAG_p)) && S_ISDIR(mode)) return '/';
 102   if (toys.optflags & FLAG_F) {
 103     if (S_ISLNK(mode)) return '@';
 104     if (S_ISREG(mode) && (mode&0111)) return '*';
 105     if (S_ISFIFO(mode)) return '|';
 106     if (S_ISSOCK(mode)) return '=';
 107   }
 108   return 0;
 109 }
 110
 111 static char *getusername(uid_t uid)
 112 {
 113   struct passwd *pw = getpwuid(uid);
 114
 115   sprintf(TT.uid_buf, "%u", (unsigned)uid);
 116   return pw ? pw->pw_name : TT.uid_buf;
 117 }
 118
 119 static char *getgroupname(gid_t gid)
 120 {
 121   struct group *gr = getgrgid(gid);
 122
 123   sprintf(TT.gid_buf, "%u", (unsigned)gid);
 124   return gr ? gr->gr_name : TT.gid_buf;
 125 }
 126
 127 static int numlen(long long ll)
 128 {
 129   return snprintf(0, 0, "%llu", ll);
 130 }
 131
 132 // measure/print SELinux/smack security label. (If pad=0, just measure.)
 133 static unsigned seclabel(struct dirtree *dt, int pad)
 134 {
 135   if (CFG_TOYBOX_SELINUX) {
 136     char* path = dirtree_path(dt, 0);
 137     char* label = 0;
 138     size_t len;
 139
 140     lgetfilecon(path, &label);
 141     if (!label) {
 142       label = strdup("?");
 143     }
 144
 145     len = strlen(label);
 146     if (pad) printf(" %*s "+(pad>0), pad, label);
 147
 148     free(label);
 149     free(path);
 150     return len;
 151   } else if (CFG_TOYBOX_SMACK) {
 152     int fd = openat(dirtree_parentfd(dt), dt->name, O_PATH|O_NOFOLLOW);
 153     char buf[SMACK_LABEL_LEN+1];
 154     ssize_t len = 1;
 155
 156     strcpy(buf, "?");
 157     if (fd != -1) {
 158       len = fgetxattr(fd, XATTR_NAME_SMACK, pad?buf:0, pad?SMACK_LABEL_LEN:0);
 159       close(fd);
 160
 161       if (len<1 || len>SMACK_LABEL_LEN) len = 0;
 162       else buf[len] = 0;
 163     }
 164     if (pad) printf(" %*s "+(pad>0), pad, buf);
 165
 166     return len;
 167   }
 168 }
 169
 170 // Figure out size of printable entry fields for display indent/wrap
 171
 172 static void entrylen(struct dirtree *dt, unsigned *len)
 173 {
 174   struct stat *st = &(dt->st);
 175   unsigned flags = toys.optflags;
 176
 177   *len = strwidth(dt->name);
 178   if (endtype(st)) ++*len;
 179   if (flags & FLAG_m) ++*len;
 180
 181   len[1] = (flags & FLAG_i) ? numlen(st->st_ino) : 0;
 182   if (flags & (FLAG_l|FLAG_o|FLAG_n|FLAG_g)) {
 183     unsigned fn = flags & FLAG_n;
 184     len[2] = numlen(st->st_nlink);
 185     len[3] = fn ? numlen(st->st_uid) : strwidth(getusername(st->st_uid));
 186     len[4] = fn ? numlen(st->st_gid) : strwidth(getgroupname(st->st_gid));
 187     if (S_ISBLK(st->st_mode) || S_ISCHR(st->st_mode)) {
 188       // cheating slightly here: assuming minor is always 3 digits to avoid
 189       // tracking another column
 190       len[5] = numlen(major(st->st_rdev))+5;
 191     } else len[5] = numlen(st->st_size);
 192   }
 193
 194   len[6] = (flags & FLAG_s) ? numlen(st->st_blocks) : 0;
 195   len[7] = (CFG_LS_Z && (flags & FLAG_Z)) ? seclabel(dt, 0) : 0;
 196 }
 197
 198 static int compare(void *a, void *b)
 199 {
 200   struct dirtree *dta = *(struct dirtree **)a;
 201   struct dirtree *dtb = *(struct dirtree **)b;
 202   int ret = 0, reverse = (toys.optflags & FLAG_r) ? -1 : 1;
 203
 204   if (toys.optflags & FLAG_S) {
 205     if (dta->st.st_size > dtb->st.st_size) ret = -1;
 206     else if (dta->st.st_size < dtb->st.st_size) ret = 1;
 207   }
 208   if (toys.optflags & FLAG_t) {
 209     if (dta->st.st_mtime > dtb->st.st_mtime) ret = -1;
 210     else if (dta->st.st_mtime < dtb->st.st_mtime) ret = 1;
 211   }
 212   if (!ret) ret = strcmp(dta->name, dtb->name);
 213   return ret * reverse;
 214 }
 215
 216 // callback from dirtree_recurse() determining how to handle this entry.
 217
 218 static int filter(struct dirtree *new)
 219 {
 220   int flags = toys.optflags;
 221
 222   // Special case to handle enormous dirs without running out of memory.
 223   if (flags == (FLAG_1|FLAG_f)) {
 224     xprintf("%s\n", new->name);
 225     return 0;
 226   }
 227
 228   if (flags & FLAG_u) new->st.st_mtime = new->st.st_atime;
 229   if (flags & FLAG_c) new->st.st_mtime = new->st.st_ctime;
 230   if (flags & FLAG_k) new->st.st_blocks = (new->st.st_blocks + 1) / 2;
 231
 232   if (flags & (FLAG_a|FLAG_f)) return DIRTREE_SAVE;
 233   if (!(flags & FLAG_A) && new->name[0]=='.') return 0;
 234
 235   return dirtree_notdotdot(new) & DIRTREE_SAVE;
 236 }
 237
 238 // For column view, calculate horizontal position (for padding) and return
 239 // index of next entry to display.
 240
 241 static unsigned long next_column(unsigned long ul, unsigned long dtlen,
 242   unsigned columns, unsigned *xpos)
 243 {
 244   unsigned long transition;
 245   unsigned height, widecols;
 246
 247   // Horizontal sort is easy
 248   if (!(toys.optflags & FLAG_C)) {
 249     *xpos = ul % columns;
 250     return ul;
 251   }
 252
 253   // vertical sort
 254
 255   // For -x, calculate height of display, rounded up
 256   height = (dtlen+columns-1)/columns;
 257
 258   // Sanity check: does wrapping render this column count impossible
 259   // due to the right edge wrapping eating a whole row?
 260   if (height*columns - dtlen >= height) {
 261     *xpos = columns;
 262     return 0;
 263   }
 264
 265   // Uneven rounding goes along right edge
 266   widecols = dtlen % height;
 267   if (!widecols) widecols = height;
 268   transition = widecols * columns;
 269   if (ul < transition) {
 270     *xpos =  ul % columns;
 271     return (*xpos*height) + (ul/columns);
 272   }
 273
 274   ul -= transition;
 275   *xpos = ul % (columns-1);
 276
 277   return (*xpos*height) + widecols + (ul/(columns-1));
 278 }
 279
 280 int color_from_mode(mode_t mode)
 281 {
 282   int color = 0;
 283
 284   if (S_ISDIR(mode)) color = 256+34;
 285   else if (S_ISLNK(mode)) color = 256+36;
 286   else if (S_ISBLK(mode) || S_ISCHR(mode)) color = 256+33;
 287   else if (S_ISREG(mode) && (mode&0111)) color = 256+32;
 288   else if (S_ISFIFO(mode)) color = 33;
 289   else if (S_ISSOCK(mode)) color = 256+35;
 290
 291   return color;
 292 }
 293
 294 // Display a list of dirtree entries, according to current format
 295 // Output types -1, -l, -C, or stream
 296
 297 static void listfiles(int dirfd, struct dirtree *indir)
 298 {
 299   struct dirtree *dt, **sort;
 300   unsigned long dtlen, ul = 0;
 301   unsigned width, flags = toys.optflags, totals[8], len[8], totpad = 0,
 302     *colsizes = (unsigned *)(toybuf+260), columns = (sizeof(toybuf)-260)/4;
 303
 304   memset(totals, 0, sizeof(totals));
 305
 306   // Silently descend into single directory listed by itself on command line.
 307   // In this case only show dirname/total header when given -R.
 308   if (!indir->parent) {
 309     if (!(dt = indir->child)) return;
 310     if (S_ISDIR(dt->st.st_mode) && !dt->next && !(flags & FLAG_d)) {
 311       dt->extra = 1;
 312       listfiles(open(dt->name, 0), dt);
 313
 314       return;
 315     }
 316   } else {
 317     // Read directory contents. We dup() the fd because this will close it.
 318     indir->data = dup(dirfd);
 319     dirtree_recurse(indir, filter, DIRTREE_SYMFOLLOW*!!(flags&FLAG_L));
 320   }
 321
 322   // Copy linked list to array and sort it. Directories go in array because
 323   // we visit them in sorted order too. (The nested loops let us measure and
 324   // fill with the same inner loop.)
 325   for (sort = 0;;sort = xmalloc(dtlen*sizeof(void *))) {
 326     for (dtlen = 0, dt = indir->child; dt; dt = dt->next, dtlen++)
 327       if (sort) sort[dtlen] = dt;
 328     if (sort) break;
 329   }
 330
 331   // Label directory if not top of tree, or if -R
 332   if (indir->parent && (!indir->extra || (flags & FLAG_R)))
 333   {
 334     char *path = dirtree_path(indir, 0);
 335
 336     if (TT.nl_title++) xputc('\n');
 337     xprintf("%s:\n", path);
 338     free(path);
 339   }
 340
 341   // Measure each entry to work out whitespace padding and total blocks
 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       blocks += sort[ul]->st.st_blocks;
 351     }
 352     totpad = totals[1]+!!totals[1]+totals[6]+!!totals[6]+totals[7]+!!totals[7];
 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_Z && (flags & FLAG_Z)) seclabel(sort[next], -(int)totals[7]);
 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("% *lld", totals[5]+1, (long long)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_Z && (flags & FLAG_Z)) seclabel(sort[next], totals[7]);
 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_start(0, 0);
 531   for (s = *toys.optargs ? toys.optargs : noargs; *s; s++) {
 532     dt = dirtree_start(*s, !(toys.optflags&(FLAG_l|FLAG_d|FLAG_F)) ||
 533                             (toys.optflags&(FLAG_L|FLAG_H)));
 534
 535     // note: double_list->prev temporarirly goes in dirtree->parent
 536     if (dt) dlist_add_nomalloc((void *)&TT.files->child, (void *)dt);
 537     else toys.exitval = 1;
 538   }
 539
 540   // Convert double_list into dirtree.
 541   dlist_terminate(TT.files->child);
 542   for (dt = TT.files->child; dt; dt = dt->next) dt->parent = TT.files;
 543
 544   // Display the files we collected
 545   listfiles(AT_FDCWD, TT.files);
 546
 547   if (CFG_TOYBOX_FREE) free(TT.files);
 548 }