3 * Copyright 2012 Andre Renaud <andre@bluewatersys.com>
4 * Copyright 2012 Rob Landley <rob@landley.net>
6 * See http://opengroup.org/onlinepubs/9699919799/utilities/ls.html
8 USE_LS(NEWTOY(ls, USE_LS_COLOR("(color):;")"ZgoACFHLRSacdfiklmnpqrstux1[-Cxm1][-Cxml][-Cxmo][-Cxmg][-cu][-ftS][-HL]", TOYFLAG_BIN|TOYFLAG_LOCALE))
14 usage: ls [-ACFHLRSZacdfiklmnpqrstux1] [directory...]
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
28 -1 list one file per line -C columns (sorted vertically)
29 -g like -l but no owner -l long (show full details)
30 -m comma separated -n like -l but numeric uid/gid
31 -o like -l but no group -x columns (horizontal sort)
33 sorting (default is alphabetical):
34 -f unsorted -r reverse -t timestamp -S size
41 usage: ls --color[=auto]
43 --color device=yellow symlink=turquoise/red dir=blue socket=purple
44 files: exe=green suid=red suidfile=redback stickydir=greenback
45 =auto means detect if output is a tty.
51 // test sst output (suid/sticky in ls flaglist)
53 // ls -lR starts .: then ./subdir:
58 struct dirtree *files, *singledir;
60 unsigned screen_width;
62 char uid_buf[12], gid_buf[12];
65 // Does two things: 1) Returns wcwidth(utf8) version of strlen,
66 // 2) replaces unprintable characters input string with '?' wildcard char.
69 int total = 0, width, len;
72 if (!CFG_TOYBOX_I18N) {
74 if (toys.optflags & FLAG_q) for (; *s; s++) if (!isprint(*s)) *s = '?';
76 len = mbrtowc(&c, s, MB_CUR_MAX, 0);
77 if (len < 1 || (width = wcwidth(c)) < 0) {
79 if (toys.optflags & FLAG_q) *s = '?';
90 static char endtype(struct stat *st)
92 mode_t mode = st->st_mode;
93 if ((toys.optflags&(FLAG_F|FLAG_p)) && S_ISDIR(mode)) return '/';
94 if (toys.optflags & FLAG_F) {
95 if (S_ISLNK(mode)) return '@';
96 if (S_ISREG(mode) && (mode&0111)) return '*';
97 if (S_ISFIFO(mode)) return '|';
98 if (S_ISSOCK(mode)) return '=';
103 static char *getusername(uid_t uid)
105 struct passwd *pw = getpwuid(uid);
107 sprintf(TT.uid_buf, "%u", (unsigned)uid);
108 return pw ? pw->pw_name : TT.uid_buf;
111 static char *getgroupname(gid_t gid)
113 struct group *gr = getgrgid(gid);
115 sprintf(TT.gid_buf, "%u", (unsigned)gid);
116 return gr ? gr->gr_name : TT.gid_buf;
119 static int numlen(long long ll)
121 return snprintf(0, 0, "%llu", ll);
124 // Figure out size of printable entry fields for display indent/wrap
126 static void entrylen(struct dirtree *dt, unsigned *len)
128 struct stat *st = &(dt->st);
129 unsigned flags = toys.optflags;
131 *len = strwidth(dt->name);
132 if (endtype(st)) ++*len;
133 if (flags & FLAG_m) ++*len;
135 len[1] = (flags & FLAG_i) ? numlen(st->st_ino) : 0;
136 if (flags & (FLAG_l|FLAG_o|FLAG_n|FLAG_g)) {
137 unsigned fn = flags & FLAG_n;
138 len[2] = numlen(st->st_nlink);
139 len[3] = fn ? numlen(st->st_uid) : strwidth(getusername(st->st_uid));
140 len[4] = fn ? numlen(st->st_gid) : strwidth(getgroupname(st->st_gid));
141 if (S_ISBLK(st->st_mode) || S_ISCHR(st->st_mode)) {
142 // cheating slightly here: assuming minor is always 3 digits to avoid
143 // tracking another column
144 len[5] = numlen(major(st->st_rdev))+5;
145 } else len[5] = numlen(st->st_size);
148 len[6] = (flags & FLAG_s) ? numlen(st->st_blocks) : 0;
149 len[7] = (flags & FLAG_Z) ? strwidth((char *)dt->extra) : 0;
152 static int compare(void *a, void *b)
154 struct dirtree *dta = *(struct dirtree **)a;
155 struct dirtree *dtb = *(struct dirtree **)b;
156 int ret = 0, reverse = (toys.optflags & FLAG_r) ? -1 : 1;
158 if (toys.optflags & FLAG_S) {
159 if (dta->st.st_size > dtb->st.st_size) ret = -1;
160 else if (dta->st.st_size < dtb->st.st_size) ret = 1;
162 if (toys.optflags & FLAG_t) {
163 if (dta->st.st_mtime > dtb->st.st_mtime) ret = -1;
164 else if (dta->st.st_mtime < dtb->st.st_mtime) ret = 1;
166 if (!ret) ret = strcmp(dta->name, dtb->name);
167 return ret * reverse;
170 // callback from dirtree_recurse() determining how to handle this entry.
172 static int filter(struct dirtree *new)
174 int flags = toys.optflags;
176 // Special case to handle enormous dirs without running out of memory.
177 if (flags == (FLAG_1|FLAG_f)) {
178 xprintf("%s\n", new->name);
182 if (flags & FLAG_Z) {
183 if (!CFG_TOYBOX_LSM_NONE) {
186 // Why not just openat(O_PATH|(O_NOFOLLOW*!!(toys.optflags&FLAG_L))) and
187 // lsm_fget_context() on that filehandle? Because the kernel is broken,
188 // and won't let us read this "metadata" from the filehandle unless we
189 // have permission to read the data. We _can_ read the same data in
190 // by path, we just can't do it through an O_PATH filehandle, because
191 // reasons. So as a bug workaround for the broken kernel, we do it
194 // The O_NONBLOCK is there to avoid triggering automounting (there's
195 // a rush of nostalgia for you) on directories we don't descend into,
196 // which O_PATH would have done for us but see "the kernel is broken".
197 if (S_ISSOCK(new->st.st_mode) ||
198 (S_ISLNK(new->st.st_mode) && !(toys.optflags & FLAG_L)) ||
199 -1 == (fd = openat(dirtree_parentfd(new), new->name,
200 O_RDONLY|O_NONBLOCK|O_NOATIME)))
204 // Wouldn't it be nice if the lsm functions worked like openat(),
205 // fchmodat(), mknodat(), readlinkat() so we could do this without
206 // even O_PATH? But no, this is 1990's tech.
207 path = dirtree_path(new, 0);
208 lsm_lget_context(path, (char **)&new->extra);
211 lsm_fget_context(fd, (char **)&new->extra);
215 if (CFG_TOYBOX_LSM_NONE || !new->extra) new->extra = (long)xstrdup("?");
218 if (flags & FLAG_u) new->st.st_mtime = new->st.st_atime;
219 if (flags & FLAG_c) new->st.st_mtime = new->st.st_ctime;
220 if (flags & FLAG_k) new->st.st_blocks = (new->st.st_blocks + 1) / 2;
222 if (flags & (FLAG_a|FLAG_f)) return DIRTREE_SAVE;
223 if (!(flags & FLAG_A) && new->name[0]=='.') return 0;
225 return dirtree_notdotdot(new) & DIRTREE_SAVE;
228 // For column view, calculate horizontal position (for padding) and return
229 // index of next entry to display.
231 static unsigned long next_column(unsigned long ul, unsigned long dtlen,
232 unsigned columns, unsigned *xpos)
234 unsigned long transition;
235 unsigned height, widecols;
237 // Horizontal sort is easy
238 if (!(toys.optflags & FLAG_C)) {
239 *xpos = ul % columns;
245 // For -x, calculate height of display, rounded up
246 height = (dtlen+columns-1)/columns;
248 // Sanity check: does wrapping render this column count impossible
249 // due to the right edge wrapping eating a whole row?
250 if (height*columns - dtlen >= height) {
255 // Uneven rounding goes along right edge
256 widecols = dtlen % height;
257 if (!widecols) widecols = height;
258 transition = widecols * columns;
259 if (ul < transition) {
260 *xpos = ul % columns;
261 return (*xpos*height) + (ul/columns);
265 *xpos = ul % (columns-1);
267 return (*xpos*height) + widecols + (ul/(columns-1));
270 int color_from_mode(mode_t mode)
274 if (S_ISDIR(mode)) color = 256+34;
275 else if (S_ISLNK(mode)) color = 256+36;
276 else if (S_ISBLK(mode) || S_ISCHR(mode)) color = 256+33;
277 else if (S_ISREG(mode) && (mode&0111)) color = 256+32;
278 else if (S_ISFIFO(mode)) color = 33;
279 else if (S_ISSOCK(mode)) color = 256+35;
284 // Display a list of dirtree entries, according to current format
285 // Output types -1, -l, -C, or stream
287 static void listfiles(int dirfd, struct dirtree *indir)
289 struct dirtree *dt, **sort;
290 unsigned long dtlen, ul = 0;
291 unsigned width, flags = toys.optflags, totals[8], len[8], totpad = 0,
292 *colsizes = (unsigned *)(toybuf+260), columns = (sizeof(toybuf)-260)/4;
294 memset(totals, 0, sizeof(totals));
296 // Top level directory was already populated by main()
297 if (!indir->parent) {
298 // Silently descend into single directory listed by itself on command line.
299 // In this case only show dirname/total header when given -R.
301 if (S_ISDIR(dt->st.st_mode) && !dt->next && !(flags&(FLAG_d|FLAG_R))) {
302 listfiles(open(dt->name, 0), TT.singledir = dt);
307 // Do preprocessing (Dirtree didn't populate, so callback wasn't called.)
308 for (;dt; dt = dt->next) filter(dt);
309 if (flags == (FLAG_1|FLAG_f)) return;
311 // Read directory contents. We dup() the fd because this will close it.
312 // This reads/saves contents to display later, except for in "ls -1f" mode.
313 indir->data = dup(dirfd);
314 dirtree_recurse(indir, filter, DIRTREE_SYMFOLLOW*!!(flags&FLAG_L));
317 // Copy linked list to array and sort it. Directories go in array because
318 // we visit them in sorted order too. (The nested loops let us measure and
319 // fill with the same inner loop.)
320 for (sort = 0;;sort = xmalloc(dtlen*sizeof(void *))) {
321 for (dtlen = 0, dt = indir->child; dt; dt = dt->next, dtlen++)
322 if (sort) sort[dtlen] = dt;
326 // Label directory if not top of tree, or if -R
327 if (indir->parent && (TT.singledir!=indir || (flags&FLAG_R)))
329 char *path = dirtree_path(indir, 0);
331 if (TT.nl_title++) xputc('\n');
332 xprintf("%s:\n", path);
336 // Measure each entry to work out whitespace padding and total blocks
337 if (!(flags & FLAG_f)) {
338 unsigned long long blocks = 0;
340 qsort(sort, dtlen, sizeof(void *), (void *)compare);
341 for (ul = 0; ul<dtlen; ul++) {
342 entrylen(sort[ul], len);
343 for (width = 0; width<8; width++)
344 if (len[width]>totals[width]) totals[width] = len[width];
345 blocks += sort[ul]->st.st_blocks;
347 totpad = totals[1]+!!totals[1]+totals[6]+!!totals[6]+totals[7]+!!totals[7];
348 if ((flags&(FLAG_l|FLAG_o|FLAG_n|FLAG_g|FLAG_s)) && indir->parent)
349 xprintf("total %llu\n", blocks);
352 // Find largest entry in each field for display alignment
353 if (flags & (FLAG_C|FLAG_x)) {
355 // columns can't be more than toybuf can hold, or more than files,
356 // or > 1/2 screen width (one char filename, one space).
357 if (columns > TT.screen_width/2) columns = TT.screen_width/2;
358 if (columns > dtlen) columns = dtlen;
360 // Try to fit as many columns as we can, dropping down by one each time
361 for (;columns > 1; columns--) {
362 unsigned c, totlen = columns;
364 memset(colsizes, 0, columns*sizeof(unsigned));
365 for (ul=0; ul<dtlen; ul++) {
366 entrylen(sort[next_column(ul, dtlen, columns, &c)], len);
368 if (c == columns) break;
369 // Expand this column if necessary, break if that puts us over budget
370 if (*len > colsizes[c]) {
371 totlen += (*len)-colsizes[c];
373 if (totlen > TT.screen_width) break;
376 // If everything fit, stop here
377 if (ul == dtlen) break;
381 // Loop through again to produce output.
382 memset(toybuf, ' ', 256);
384 for (ul = 0; ul<dtlen; ul++) {
385 unsigned curcol, color = 0;
386 unsigned long next = next_column(ul, dtlen, columns, &curcol);
387 struct stat *st = &(sort[next]->st);
388 mode_t mode = st->st_mode;
389 char et = endtype(st);
391 // Skip directories at the top of the tree when -d isn't set
392 if (S_ISDIR(mode) && !indir->parent && !(flags & FLAG_d)) continue;
395 // Handle padding and wrapping for display purposes
396 entrylen(sort[next], len);
398 if (flags & FLAG_m) xputc(',');
399 if (flags & (FLAG_C|FLAG_x)) {
400 if (!curcol) xputc('\n');
401 } else if ((flags & FLAG_1) || width+1+*len > TT.screen_width) {
412 xprintf("%*lu ", totals[1], (unsigned long)st->st_ino);
414 xprintf("%*lu ", totals[6], (unsigned long)st->st_blocks);
416 if (flags & (FLAG_l|FLAG_o|FLAG_n|FLAG_g)) {
418 char perm[11], thyme[64], *usr, *upad, *grp, *grpad;
420 mode_to_string(mode, perm);
422 if (flags&FLAG_o) grp = grpad = toybuf+256;
424 if (flags&FLAG_n) sprintf(grp = thyme, "%u", (unsigned)st->st_gid);
425 else strwidth(grp = getgroupname(st->st_gid));
426 grpad = toybuf+256-(totals[4]-len[4]);
429 if (flags&FLAG_g) usr = upad = toybuf+256;
431 upad = toybuf+255-(totals[3]-len[3]);
432 if (flags&FLAG_n) sprintf(usr = TT.uid_buf, "%u", (unsigned)st->st_uid);
433 else strwidth(usr = getusername(st->st_uid));
436 // Coerce the st types into something we know we can print.
437 printf("%s% *ld %s%s%s%s", perm, totals[2]+1, (long)st->st_nlink,
438 usr, upad, grp, grpad);
441 printf("%*s ", -(int)totals[7], (char *)sort[next]->extra);
443 if (S_ISCHR(st->st_mode) || S_ISBLK(st->st_mode))
444 printf("% *d,% 4d", totals[5]-4, major(st->st_rdev),minor(st->st_rdev));
445 else printf("% *lld", totals[5]+1, (long long)st->st_size);
447 tm = localtime(&(st->st_mtime));
448 strftime(thyme, sizeof(thyme), "%F %H:%M", tm);
449 xprintf(" %s ", thyme);
450 } else if (flags & FLAG_Z)
451 printf("%*s ", (int)totals[7], (char *)sort[next]->extra);
453 if (flags & FLAG_color) {
454 color = color_from_mode(st->st_mode);
455 if (color) printf("\033[%d;%dm", color>>8, color&255);
458 if (flags & FLAG_q) {
460 for (p=sort[next]->name; *p; p++) fputc(isprint(*p) ? *p : '?', stdout);
461 } else xprintf("%s", sort[next]->name);
462 if (color) xprintf("\033[0m");
464 if ((flags & (FLAG_l|FLAG_o|FLAG_n|FLAG_g)) && S_ISLNK(mode)) {
466 if (flags & FLAG_color) {
469 if (fstatat(dirfd, sort[next]->symlink, &st2, 0)) color = 256+31;
470 else color = color_from_mode(st2.st_mode);
472 if (color) printf("\033[%d;%dm", color>>8, color&255);
475 printf("%s", sort[next]->symlink);
476 if (color) printf("\033[0m");
482 if (flags & (FLAG_C|FLAG_x)) {
483 curcol = colsizes[curcol]-(*len)-totpad;
484 if (curcol < 255) xprintf("%s", toybuf+255-curcol);
488 if (width) xputc('\n');
490 // Free directory entries, recursing first if necessary.
492 for (ul = 0; ul<dtlen; free(sort[ul++])) {
493 if ((flags & FLAG_d) || !S_ISDIR(sort[ul]->st.st_mode)) continue;
495 // Recurse into dirs if at top of the tree or given -R
496 if (!indir->parent || ((flags&FLAG_R) && dirtree_notdotdot(sort[ul])))
497 listfiles(openat(dirfd, sort[ul]->name, 0), sort[ul]);
498 free((void *)sort[ul]->extra);
501 if (dirfd != AT_FDCWD) close(dirfd);
506 char **s, *noargs[] = {".", 0};
509 TT.screen_width = 80;
510 terminal_size(&TT.screen_width, NULL);
511 if (TT.screen_width<2) TT.screen_width = 2;
513 // Do we have an implied -1
515 toys.optflags |= FLAG_1;
516 if (TT.color) toys.optflags ^= FLAG_color;
517 } else if (toys.optflags&(FLAG_l|FLAG_o|FLAG_n|FLAG_g))
518 toys.optflags |= FLAG_1;
519 else if (!(toys.optflags&(FLAG_1|FLAG_x|FLAG_m))) toys.optflags |= FLAG_C;
520 // The optflags parsing infrastructure should really do this for us,
521 // but currently it has "switch off when this is set", so "-dR" and "-Rd"
522 // behave differently
523 if (toys.optflags & FLAG_d) toys.optflags &= ~FLAG_R;
525 // Iterate through command line arguments, collecting directories and files.
526 // Non-absolute paths are relative to current directory.
527 TT.files = dirtree_start(0, 0);
528 for (s = *toys.optargs ? toys.optargs : noargs; *s; s++) {
529 dt = dirtree_start(*s, !(toys.optflags&(FLAG_l|FLAG_d|FLAG_F)) ||
530 (toys.optflags&(FLAG_L|FLAG_H)));
532 // note: double_list->prev temporarirly goes in dirtree->parent
533 if (dt) dlist_add_nomalloc((void *)&TT.files->child, (void *)dt);
534 else toys.exitval = 1;
537 // Convert double_list into dirtree.
538 dlist_terminate(TT.files->child);
539 for (dt = TT.files->child; dt; dt = dt->next) dt->parent = TT.files;
541 // Display the files we collected
542 listfiles(AT_FDCWD, TT.files);
544 if (CFG_TOYBOX_FREE) free(TT.files);