1 /* $OpenBSD: ls.c,v 1.53 2020/07/06 00:55:05 millert 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 57 static void display(FTSENT *, FTSENT *); 58 static int mastercmp(const FTSENT **, const FTSENT **); 59 static void traverse(int, char **, int); 60 61 static void (*printfcn)(DISPLAY *); 62 static int (*sortfcn)(const FTSENT *, const FTSENT *); 63 64 #define BY_NAME 0 65 #define BY_SIZE 1 66 #define BY_TIME 2 67 68 long blocksize; /* block size units */ 69 int termwidth; /* default terminal width */ 70 int sortkey = BY_NAME; 71 72 /* flags */ 73 int f_accesstime; /* use time of last access */ 74 int f_column; /* columnated format */ 75 int f_columnacross; /* columnated format, sorted across */ 76 int f_flags; /* show flags associated with a file */ 77 int f_grouponly; /* long listing format without owner */ 78 int f_humanval; /* show human-readable file sizes */ 79 int f_inode; /* print inode */ 80 int f_listdir; /* list actual directory, not contents */ 81 int f_listdot; /* list files beginning with . */ 82 int f_longform; /* long listing format */ 83 int f_nonprint; /* show unprintables as ? */ 84 int f_nosort; /* don't sort output */ 85 int f_numericonly; /* don't expand uid to symbolic name */ 86 int f_recursive; /* ls subdirectories also */ 87 int f_reversesort; /* reverse whatever sort is used */ 88 int f_sectime; /* print the real time for all files */ 89 int f_singlecol; /* use single column output */ 90 int f_size; /* list size in short listing */ 91 int f_statustime; /* use time of last mode change */ 92 int f_stream; /* stream format */ 93 int f_type; /* add type character for non-regular files */ 94 int f_typedir; /* add type character for directories */ 95 96 int rval; 97 98 int 99 ls_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 339 static 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 */ 347 static void 348 traverse(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 display(NULL, fts_children(ftsp, 0)); 359 if (f_listdir) 360 return; 361 362 /* 363 * If not recursing down this tree and don't need stat info, just get 364 * the names. 365 */ 366 ch_options = !f_recursive && options & FTS_NOSTAT ? FTS_NAMEONLY : 0; 367 368 while ((p = fts_read(ftsp)) != NULL) 369 switch (p->fts_info) { 370 case FTS_D: 371 if (p->fts_name[0] == '.' && 372 p->fts_level != FTS_ROOTLEVEL && !f_listdot) { 373 (void)fts_set(ftsp, p, FTS_SKIP); 374 break; 375 } 376 377 /* 378 * If already output something, put out a newline as 379 * a separator. If multiple arguments, precede each 380 * directory with its name. 381 */ 382 if (output) 383 (void)printf("\n%s:\n", p->fts_path); 384 else if (f_recursive || argc > 1) { 385 (void)printf("%s:\n", p->fts_path); 386 output = 1; 387 } 388 389 chp = fts_children(ftsp, ch_options); 390 saved_errno = errno; 391 display(p, chp); 392 393 /* 394 * On fts_children() returning error do recurse to see 395 * the error. 396 */ 397 if (!f_recursive && !(chp == NULL && saved_errno != 0)) 398 (void)fts_set(ftsp, p, FTS_SKIP); 399 break; 400 case FTS_DC: 401 warnx("%s: directory causes a cycle", p->fts_name); 402 break; 403 case FTS_DNR: 404 case FTS_ERR: 405 warnx("%s: %s", p->fts_name[0] == '\0' ? p->fts_path : 406 p->fts_name, strerror(p->fts_errno)); 407 rval = 1; 408 break; 409 } 410 if (errno) 411 err(1, "fts_read"); 412 413 fts_close(ftsp); 414 } 415 416 /* 417 * Display() takes a linked list of FTSENT structures and passes the list 418 * along with any other necessary information to the print function. P 419 * points to the parent directory of the display list. 420 */ 421 static void 422 display(FTSENT *p, FTSENT *list) 423 { 424 struct stat *sp; 425 DISPLAY d; 426 FTSENT *cur; 427 NAMES *np; 428 off_t maxsize; 429 nlink_t maxnlink; 430 unsigned long long btotal; 431 blkcnt_t maxblock; 432 ino_t maxinode; 433 int bcfile, flen, glen, ulen, maxflags, maxgroup, maxuser, maxlen; 434 int entries, needstats; 435 int width; 436 const char *user, *group; 437 char nuser[12], ngroup[12]; 438 char buf[21]; /* 64 bits == 20 digits */ 439 char *flags = NULL; 440 441 /* 442 * If list is NULL there are two possibilities: that the parent 443 * directory p has no children, or that fts_children() returned an 444 * error. We ignore the error case since it will be replicated 445 * on the next call to fts_read() on the post-order visit to the 446 * directory p, and will be signalled in traverse(). 447 */ 448 if (list == NULL) 449 return; 450 451 needstats = f_inode || f_longform || f_size; 452 flen = 0; 453 btotal = maxblock = maxinode = maxlen = maxnlink = 0; 454 bcfile = 0; 455 maxuser = maxgroup = maxflags = 0; 456 maxsize = 0; 457 for (cur = list, entries = 0; cur != NULL; cur = cur->fts_link) { 458 if (cur->fts_info == FTS_ERR || cur->fts_info == FTS_NS) { 459 warnx("%s: %s", 460 cur->fts_name, strerror(cur->fts_errno)); 461 cur->fts_number = NO_PRINT; 462 rval = 1; 463 continue; 464 } 465 466 /* 467 * P is NULL if list is the argv list, to which different rules 468 * apply. 469 */ 470 if (p == NULL) { 471 /* Directories will be displayed later. */ 472 if (cur->fts_info == FTS_D && !f_listdir) { 473 cur->fts_number = NO_PRINT; 474 continue; 475 } 476 } else { 477 /* Only display dot file if -a/-A set. */ 478 if (cur->fts_name[0] == '.' && !f_listdot) { 479 cur->fts_number = NO_PRINT; 480 continue; 481 } 482 } 483 if ((width = mbsprint(cur->fts_name, 0)) > maxlen) 484 maxlen = width; 485 if (needstats) { 486 sp = cur->fts_statp; 487 if (sp->st_blocks > maxblock) 488 maxblock = sp->st_blocks; 489 if (sp->st_ino > maxinode) 490 maxinode = sp->st_ino; 491 if (sp->st_nlink > maxnlink) 492 maxnlink = sp->st_nlink; 493 if (sp->st_size > maxsize) 494 maxsize = sp->st_size; 495 496 btotal += sp->st_blocks; 497 if (f_longform) { 498 if (f_numericonly) { 499 snprintf(nuser, sizeof nuser, "%u", sp->st_uid); 500 snprintf(ngroup, sizeof nuser, "%u", sp->st_gid); 501 user = nuser; 502 group = ngroup; 503 } else { 504 user = user_from_uid(sp->st_uid, 0); 505 group = group_from_gid(sp->st_gid, 0); 506 } 507 if ((ulen = strlen(user)) > maxuser) 508 maxuser = ulen; 509 if ((glen = strlen(group)) > maxgroup) 510 maxgroup = glen; 511 if (f_flags) { 512 flags = fflagstostr(sp->st_flags); 513 if (*flags == '\0') 514 flags = "-"; 515 if ((flen = strlen(flags)) > maxflags) 516 maxflags = flen; 517 } else 518 flen = 0; 519 520 if ((np = malloc(sizeof(NAMES) + 521 ulen + 1 + glen + 1 + flen + 1)) == NULL) 522 err(1, NULL); 523 524 np->user = &np->data[0]; 525 (void)strlcpy(np->user, user, ulen + 1); 526 np->group = &np->data[ulen + 1]; 527 (void)strlcpy(np->group, group, glen + 1); 528 529 if (S_ISCHR(sp->st_mode) || 530 S_ISBLK(sp->st_mode)) 531 bcfile = 1; 532 533 if (f_flags) { 534 np->flags = &np->data[ulen + 1 + glen + 1]; 535 (void)strlcpy(np->flags, flags, flen + 1); 536 if (*flags != '-') 537 free(flags); 538 } 539 cur->fts_pointer = np; 540 } 541 } 542 ++entries; 543 } 544 545 if (!entries) 546 return; 547 548 d.list = list; 549 d.entries = entries; 550 d.maxlen = maxlen; 551 if (needstats) { 552 d.bcfile = bcfile; 553 d.btotal = btotal; 554 (void)snprintf(buf, sizeof(buf), "%llu", 555 (unsigned long long)maxblock); 556 d.s_block = strlen(buf); 557 d.s_flags = maxflags; 558 d.s_group = maxgroup; 559 (void)snprintf(buf, sizeof(buf), "%llu", 560 (unsigned long long)maxinode); 561 d.s_inode = strlen(buf); 562 (void)snprintf(buf, sizeof(buf), "%lu", 563 (unsigned long)maxnlink); 564 d.s_nlink = strlen(buf); 565 if (!f_humanval) { 566 (void)snprintf(buf, sizeof(buf), "%lld", 567 (long long)maxsize); 568 d.s_size = strlen(buf); 569 } else 570 d.s_size = FMT_SCALED_STRSIZE-2; /* no - or '\0' */ 571 d.s_user = maxuser; 572 } 573 574 printfcn(&d); 575 output = 1; 576 577 if (f_longform) 578 for (cur = list; cur != NULL; cur = cur->fts_link) 579 free(cur->fts_pointer); 580 } 581 582 /* 583 * Ordering for mastercmp: 584 * If ordering the argv (fts_level = FTS_ROOTLEVEL) return non-directories 585 * as larger than directories. Within either group, use the sort function. 586 * All other levels use the sort function. Error entries remain unsorted. 587 */ 588 static int 589 mastercmp(const FTSENT **a, const FTSENT **b) 590 { 591 int a_info, b_info; 592 593 a_info = (*a)->fts_info; 594 if (a_info == FTS_ERR) 595 return (0); 596 b_info = (*b)->fts_info; 597 if (b_info == FTS_ERR) 598 return (0); 599 600 if (a_info == FTS_NS || b_info == FTS_NS) { 601 if (b_info != FTS_NS) 602 return (1); 603 else if (a_info != FTS_NS) 604 return (-1); 605 else 606 return (namecmp(*a, *b)); 607 } 608 609 if (a_info != b_info && 610 (*a)->fts_level == FTS_ROOTLEVEL && !f_listdir) { 611 if (a_info == FTS_D) 612 return (1); 613 if (b_info == FTS_D) 614 return (-1); 615 } 616 return (sortfcn(*a, *b)); 617 } 618