1/* $OpenBSD: ls.c,v 1.56 2023/10/07 13:29:08 schwarze Exp $ */ 2/* $NetBSD: ls.c,v 1.18 1996/07/09 09:16:29 mycroft Exp $ */ 3 4/* 5 * Copyright (c) 1989, 1993, 1994 6 * The Regents of the University of California. All rights reserved. 7 * 8 * This code is derived from software contributed to Berkeley by 9 * Michael Fischbein. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. Neither the name of the University nor the names of its contributors 20 * may be used to endorse or promote products derived from this software 21 * without specific prior written permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33 * SUCH DAMAGE. 34 */ 35 36#include <sys/types.h> 37#include <sys/stat.h> 38#include <sys/ioctl.h> 39 40#include <dirent.h> 41#include <err.h> 42#include <errno.h> 43#include <fts.h> 44#include <grp.h> 45#include <pwd.h> 46#include <stdio.h> 47#include <stdlib.h> 48#include <string.h> 49#include <unistd.h> 50#include <limits.h> 51#include <locale.h> 52#include <util.h> 53 54#include "ls.h" 55#include "extern.h" 56 57static void display(FTSENT *, FTSENT *); 58static int mastercmp(const FTSENT **, const FTSENT **); 59static void traverse(int, char **, int); 60 61static void (*printfcn)(DISPLAY *); 62static int (*sortfcn)(const FTSENT *, const FTSENT *); 63 64#define BY_NAME 0 65#define BY_SIZE 1 66#define BY_TIME 2 67 68long blocksize; /* block size units */ 69int termwidth; /* default terminal width */ 70int sortkey = BY_NAME; 71 72/* flags */ 73int f_accesstime; /* use time of last access */ 74int f_column; /* columnated format */ 75int f_columnacross; /* columnated format, sorted across */ 76int f_flags; /* show flags associated with a file */ 77int f_grouponly; /* long listing format without owner */ 78int f_humanval; /* show human-readable file sizes */ 79int f_inode; /* print inode */ 80int f_listdir; /* list actual directory, not contents */ 81int f_listdot; /* list files beginning with . */ 82int f_longform; /* long listing format */ 83int f_nonprint; /* show unprintables as ? */ 84int f_nosort; /* don't sort output */ 85int f_numericonly; /* don't expand uid to symbolic name */ 86int f_recursive; /* ls subdirectories also */ 87int f_reversesort; /* reverse whatever sort is used */ 88int f_sectime; /* print the real time for all files */ 89int f_singlecol; /* use single column output */ 90int f_size; /* list size in short listing */ 91int f_statustime; /* use time of last mode change */ 92int f_stream; /* stream format */ 93int f_type; /* add type character for non-regular files */ 94int f_typedir; /* add type character for directories */ 95 96int rval; 97 98int 99ls_main(int argc, char *argv[]) 100{ 101 static char dot[] = ".", *dotav[] = { dot, NULL }; 102 struct winsize win; 103 int ch, fts_options, notused; 104 int kflag = 0; 105 char *p; 106 107#ifndef SMALL 108 setlocale(LC_CTYPE, ""); 109#endif 110 111 /* Terminal defaults to -Cq, non-terminal defaults to -1. */ 112 if (isatty(STDOUT_FILENO)) { 113 f_column = f_nonprint = 1; 114 } else { 115 f_singlecol = 1; 116 } 117 118 termwidth = 0; 119 if ((p = getenv("COLUMNS")) != NULL) 120 termwidth = strtonum(p, 1, INT_MAX, NULL); 121 if (termwidth == 0 && ioctl(STDOUT_FILENO, TIOCGWINSZ, &win) == 0 && 122 win.ws_col > 0) 123 termwidth = win.ws_col; 124 if (termwidth == 0) 125 termwidth = 80; 126 127 if (pledge("stdio rpath getpw", NULL) == -1) 128 err(1, "pledge"); 129 130 /* Root is -A automatically. */ 131 if (!getuid()) 132 f_listdot = 1; 133 134 fts_options = FTS_PHYSICAL; 135 while ((ch = getopt(argc, argv, "1ACFHLRSTacdfghiklmnopqrstux")) != -1) { 136 switch (ch) { 137 /* 138 * The -1, -C and -l, -m, -n and -x options all override each 139 * other so shell aliasing works right. 140 */ 141 case '1': 142 f_singlecol = 1; 143 f_column = f_columnacross = f_longform = 0; 144 f_numericonly = f_stream = 0; 145 break; 146 case 'C': 147 f_column = 1; 148 f_columnacross = f_longform = f_numericonly = 0; 149 f_singlecol = f_stream = 0; 150 break; 151 case 'g': 152 f_longform = 1; 153 if (f_grouponly != -1) 154 f_grouponly = 1; 155 f_column = f_columnacross = f_singlecol = f_stream = 0; 156 break; 157 case 'l': 158 f_longform = 1; 159 f_grouponly = -1; /* -l always overrides -g */ 160 f_column = f_columnacross = f_singlecol = f_stream = 0; 161 break; 162 case 'm': 163 f_stream = 1; 164 f_column = f_columnacross = f_longform = 0; 165 f_numericonly = f_singlecol = 0; 166 break; 167 case 'x': 168 f_columnacross = 1; 169 f_column = f_longform = f_numericonly = 0; 170 f_singlecol = f_stream = 0; 171 break; 172 case 'n': 173 f_longform = 1; 174 f_numericonly = 1; 175 f_column = f_columnacross = f_singlecol = f_stream = 0; 176 break; 177 /* The -c and -u options override each other. */ 178 case 'c': 179 f_statustime = 1; 180 f_accesstime = 0; 181 break; 182 case 'u': 183 f_accesstime = 1; 184 f_statustime = 0; 185 break; 186 case 'F': 187 f_type = 1; 188 break; 189 case 'H': 190 fts_options |= FTS_COMFOLLOW; 191 break; 192 case 'L': 193 fts_options &= ~FTS_PHYSICAL; 194 fts_options |= FTS_LOGICAL; 195 break; 196 case 'R': 197 f_recursive = 1; 198 break; 199 case 'f': 200 f_nosort = 1; 201 /* FALLTHROUGH */ 202 case 'a': 203 fts_options |= FTS_SEEDOT; 204 /* FALLTHROUGH */ 205 case 'A': 206 f_listdot = 1; 207 break; 208 /* The -d option turns off the -R option. */ 209 case 'd': 210 f_listdir = 1; 211 f_recursive = 0; 212 break; 213 case 'h': 214 f_humanval = 1; 215 break; 216 case 'i': 217 f_inode = 1; 218 break; 219 case 'k': 220 blocksize = 1024; 221 kflag = 1; 222 break; 223 case 'o': 224 f_flags = 1; 225 break; 226 case 'p': 227 f_typedir = 1; 228 break; 229 case 'q': 230 f_nonprint = 1; 231 break; 232 case 'r': 233 f_reversesort = 1; 234 break; 235 case 'S': 236 sortkey = BY_SIZE; 237 break; 238 case 's': 239 f_size = 1; 240 break; 241 case 'T': 242 f_sectime = 1; 243 break; 244 case 't': 245 sortkey = BY_TIME; 246 break; 247 default: 248 usage(); 249 } 250 } 251 argc -= optind; 252 argv += optind; 253 254 /* 255 * If both -g and -l options, let -l take precedence. 256 * This preserves compatibility with the historic BSD ls -lg. 257 */ 258 if (f_grouponly == -1) 259 f_grouponly = 0; 260 261 /* 262 * If not -F, -i, -l, -p, -S, -s or -t options, don't require stat 263 * information. 264 */ 265 if (!f_longform && !f_inode && !f_size && !f_type && !f_typedir && 266 sortkey == BY_NAME) 267 fts_options |= FTS_NOSTAT; 268 269 /* 270 * If not -F, -d or -l options, follow any symbolic links listed on 271 * the command line. 272 */ 273 if (!f_longform && !f_listdir && !f_type) 274 fts_options |= FTS_COMFOLLOW; 275 276 /* If -l or -s, figure out block size. */ 277 if (f_longform || f_size) { 278 if (!kflag) 279 (void)getbsize(¬used, &blocksize); 280 blocksize /= 512; 281 } 282 283 /* Select a sort function. */ 284 if (f_reversesort) { 285 switch (sortkey) { 286 case BY_NAME: 287 sortfcn = revnamecmp; 288 break; 289 case BY_SIZE: 290 sortfcn = revsizecmp; 291 break; 292 case BY_TIME: 293 if (f_accesstime) 294 sortfcn = revacccmp; 295 else if (f_statustime) 296 sortfcn = revstatcmp; 297 else /* Use modification time. */ 298 sortfcn = revmodcmp; 299 break; 300 } 301 } else { 302 switch (sortkey) { 303 case BY_NAME: 304 sortfcn = namecmp; 305 break; 306 case BY_SIZE: 307 sortfcn = sizecmp; 308 break; 309 case BY_TIME: 310 if (f_accesstime) 311 sortfcn = acccmp; 312 else if (f_statustime) 313 sortfcn = statcmp; 314 else /* Use modification time. */ 315 sortfcn = modcmp; 316 break; 317 } 318 } 319 320 /* Select a print function. */ 321 if (f_singlecol) 322 printfcn = printscol; 323 else if (f_columnacross) 324 printfcn = printacol; 325 else if (f_longform) 326 printfcn = printlong; 327 else if (f_stream) 328 printfcn = printstream; 329 else 330 printfcn = printcol; 331 332 if (argc) 333 traverse(argc, argv, fts_options); 334 else 335 traverse(1, dotav, fts_options); 336 return (rval); 337} 338 339static int output; /* If anything output. */ 340 341/* 342 * Traverse() walks the logical directory structure specified by the argv list 343 * in the order specified by the mastercmp() comparison function. During the 344 * traversal it passes linked lists of structures to display() which represent 345 * a superset (may be exact set) of the files to be displayed. 346 */ 347static void 348traverse(int argc, char *argv[], int options) 349{ 350 FTS *ftsp; 351 FTSENT *p, *chp; 352 int ch_options, saved_errno; 353 354 if ((ftsp = 355 fts_open(argv, options, f_nosort ? NULL : mastercmp)) == NULL) 356 err(1, NULL); 357 358 /* 359 * We ignore errors from fts_children here since they will be 360 * replicated and signalled on the next call to fts_read() below. 361 */ 362 chp = fts_children(ftsp, 0); 363 if (chp != NULL) 364 display(NULL, chp); 365 if (f_listdir) 366 return; 367 368 /* 369 * If not recursing down this tree and don't need stat info, just get 370 * the names. 371 */ 372 ch_options = !f_recursive && options & FTS_NOSTAT ? FTS_NAMEONLY : 0; 373 374 while ((p = fts_read(ftsp)) != NULL) 375 switch (p->fts_info) { 376 case FTS_D: 377 if (p->fts_name[0] == '.' && 378 p->fts_level != FTS_ROOTLEVEL && !f_listdot) { 379 (void)fts_set(ftsp, p, FTS_SKIP); 380 break; 381 } 382 383 /* 384 * If already output something, put out a newline as 385 * a separator. If multiple arguments, precede each 386 * directory with its name. 387 */ 388 if (output) 389 (void)printf("\n%s:\n", p->fts_path); 390 else if (f_recursive || argc > 1) { 391 (void)printf("%s:\n", p->fts_path); 392 output = 1; 393 } 394 395 chp = fts_children(ftsp, ch_options); 396 saved_errno = errno; 397 display(p, chp); 398 399 /* 400 * On fts_children() returning error do recurse to see 401 * the error. 402 */ 403 if (!f_recursive && !(chp == NULL && saved_errno != 0)) 404 (void)fts_set(ftsp, p, FTS_SKIP); 405 break; 406 case FTS_DC: 407 warnx("%s: directory causes a cycle", p->fts_name); 408 break; 409 case FTS_DNR: 410 case FTS_ERR: 411 warnx("%s: %s", p->fts_name[0] == '\0' ? p->fts_path : 412 p->fts_name, strerror(p->fts_errno)); 413 rval = 1; 414 break; 415 } 416 if (errno) 417 err(1, "fts_read"); 418 419 fts_close(ftsp); 420} 421 422/* 423 * Display() takes a linked list of FTSENT structures and passes the list 424 * along with any other necessary information to the print function. P 425 * points to the parent directory of the display list. 426 */ 427static void 428display(FTSENT *p, FTSENT *list) 429{ 430 struct stat *sp; 431 DISPLAY d; 432 FTSENT *cur; 433 NAMES *np; 434 off_t maxsize; 435 nlink_t maxnlink; 436 unsigned long long btotal; 437 blkcnt_t maxblock; 438 ino_t maxinode; 439 unsigned int maxmajor, maxminor; 440 int bcfile, flen, glen, ulen, maxflags, maxgroup, maxuser, maxlen; 441 int entries, needstats; 442 int width; 443 const char *user, *group; 444 char nuser[12], ngroup[12]; 445 char *flags = NULL; 446 447 needstats = f_inode || f_longform || f_size; 448 flen = 0; 449 btotal = maxblock = maxinode = maxlen = maxnlink = 0; 450 bcfile = 0; 451 maxuser = maxgroup = maxflags = 0; 452 maxmajor = maxminor = 0; 453 maxsize = 0; 454 for (cur = list, entries = 0; cur != NULL; cur = cur->fts_link) { 455 if (cur->fts_info == FTS_ERR || cur->fts_info == FTS_NS) { 456 warnx("%s: %s", 457 cur->fts_name, strerror(cur->fts_errno)); 458 cur->fts_number = NO_PRINT; 459 rval = 1; 460 continue; 461 } 462 463 /* 464 * P is NULL if list is the argv list, to which different rules 465 * apply. 466 */ 467 if (p == NULL) { 468 /* Directories will be displayed later. */ 469 if (cur->fts_info == FTS_D && !f_listdir) { 470 cur->fts_number = NO_PRINT; 471 continue; 472 } 473 } else { 474 /* Only display dot file if -a/-A set. */ 475 if (cur->fts_name[0] == '.' && !f_listdot) { 476 cur->fts_number = NO_PRINT; 477 continue; 478 } 479 } 480 if ((width = mbsprint(cur->fts_name, 0)) > maxlen) 481 maxlen = width; 482 if (needstats) { 483 sp = cur->fts_statp; 484 if (sp->st_blocks > maxblock) 485 maxblock = sp->st_blocks; 486 if (sp->st_ino > maxinode) 487 maxinode = sp->st_ino; 488 if (sp->st_nlink > maxnlink) 489 maxnlink = sp->st_nlink; 490 if (sp->st_size > maxsize) 491 maxsize = sp->st_size; 492 493 btotal += sp->st_blocks; 494 if (f_longform) { 495 if (f_numericonly) { 496 snprintf(nuser, sizeof nuser, "%u", sp->st_uid); 497 snprintf(ngroup, sizeof nuser, "%u", sp->st_gid); 498 user = nuser; 499 group = ngroup; 500 } else { 501 user = user_from_uid(sp->st_uid, 0); 502 group = group_from_gid(sp->st_gid, 0); 503 } 504 if ((ulen = strlen(user)) > maxuser) 505 maxuser = ulen; 506 if ((glen = strlen(group)) > maxgroup) 507 maxgroup = glen; 508 if (f_flags) { 509 flags = fflagstostr(sp->st_flags); 510 if (*flags == '\0') 511 flags = "-"; 512 if ((flen = strlen(flags)) > maxflags) 513 maxflags = flen; 514 } else 515 flen = 0; 516 517 if ((np = malloc(sizeof(NAMES) + 518 ulen + 1 + glen + 1 + flen + 1)) == NULL) 519 err(1, NULL); 520 521 np->user = &np->data[0]; 522 (void)strlcpy(np->user, user, ulen + 1); 523 np->group = &np->data[ulen + 1]; 524 (void)strlcpy(np->group, group, glen + 1); 525 526 if (S_ISCHR(sp->st_mode) || 527 S_ISBLK(sp->st_mode)) { 528 bcfile = 1; 529 if (maxmajor < major(sp->st_rdev)) 530 maxmajor = major(sp->st_rdev); 531 if (maxminor < minor(sp->st_rdev)) 532 maxminor = minor(sp->st_rdev); 533 } 534 if (f_flags) { 535 np->flags = &np->data[ulen + 1 + glen + 1]; 536 (void)strlcpy(np->flags, flags, flen + 1); 537 if (*flags != '-') 538 free(flags); 539 } 540 cur->fts_pointer = np; 541 } 542 } 543 ++entries; 544 } 545 546 /* 547 * If there are no entries to display, we normally stop right 548 * here. However, we must continue if we have to display the 549 * total block count. In this case, we display the total only 550 * on the second (p != NULL) pass. 551 */ 552 if (!entries && (!(f_longform || f_size) || p == NULL)) 553 return; 554 555 d.list = list; 556 d.entries = entries; 557 d.maxlen = maxlen; 558 if (needstats) { 559 d.btotal = btotal; 560 d.s_block = snprintf(NULL, 0, "%llu", 561 (unsigned long long)maxblock); 562 d.s_flags = maxflags; 563 d.s_group = maxgroup; 564 d.s_inode = snprintf(NULL, 0, "%llu", 565 (unsigned long long)maxinode); 566 d.s_nlink = snprintf(NULL, 0, "%lu", 567 (unsigned long)maxnlink); 568 if (!f_humanval) 569 d.s_size = snprintf(NULL, 0, "%lld", 570 (long long)maxsize); 571 else 572 d.s_size = FMT_SCALED_STRSIZE-2; /* no - or '\0' */ 573 d.s_major = d.s_minor = 3; 574 if (bcfile) { 575 d.s_major = snprintf(NULL, 0, "%u", maxmajor); 576 d.s_minor = snprintf(NULL, 0, "%u", maxminor); 577 if (d.s_size <= d.s_major + 2 + d.s_minor) 578 d.s_size = d.s_major + 2 + d.s_minor; 579 else 580 d.s_major = d.s_size - 2 - d.s_minor; 581 } 582 d.s_user = maxuser; 583 } 584 585 printfcn(&d); 586 output = 1; 587 588 if (f_longform) 589 for (cur = list; cur != NULL; cur = cur->fts_link) 590 free(cur->fts_pointer); 591} 592 593/* 594 * Ordering for mastercmp: 595 * If ordering the argv (fts_level = FTS_ROOTLEVEL) return non-directories 596 * as larger than directories. Within either group, use the sort function. 597 * All other levels use the sort function. Error entries remain unsorted. 598 */ 599static int 600mastercmp(const FTSENT **a, const FTSENT **b) 601{ 602 int a_info, b_info; 603 604 a_info = (*a)->fts_info; 605 if (a_info == FTS_ERR) 606 return (0); 607 b_info = (*b)->fts_info; 608 if (b_info == FTS_ERR) 609 return (0); 610 611 if (a_info == FTS_NS || b_info == FTS_NS) { 612 if (b_info != FTS_NS) 613 return (1); 614 else if (a_info != FTS_NS) 615 return (-1); 616 else 617 return (namecmp(*a, *b)); 618 } 619 620 if (a_info != b_info && 621 (*a)->fts_level == FTS_ROOTLEVEL && !f_listdir) { 622 if (a_info == FTS_D) 623 return (1); 624 if (b_info == FTS_D) 625 return (-1); 626 } 627 return (sortfcn(*a, *b)); 628} 629