lib/listfile.c

   1 /* listfile.c -- display a long listing of a file
   2    Copyright (C) 1991, 1993, 2000 Free Software Foundation, Inc.
   3
   4    This program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 2, or (at your option)
   7    any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program; if not, write to the Free Software
  16    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
  17    USA.
  18 */
  19
  20 #if HAVE_CONFIG_H
  21 # include <config.h>
  22 #endif
  23
  24 #ifndef __GNUC__
  25 # if HAVE_ALLOCA_H
  26 #  include <alloca.h>
  27 # else
  28 #  ifdef _AIX
  29  #  pragma alloca
  30 #  else
  31 #   ifdef _WIN32
  32 #    include <malloc.h>
  33 #    include <io.h>
  34 #   else
  35 #    ifndef alloca
  36 char *alloca ();
  37 #    endif
  38 #   endif
  39 #  endif
  40 # endif
  41 #endif
  42
  43 #include <sys/types.h>
  44 #include <sys/stat.h>
  45 #include <stdio.h>
  46 #include <pwd.h>
  47 #include <grp.h>
  48 #include <time.h>
  49 #include <errno.h>
  50 #include "human.h"
  51 #include "xalloc.h"
  52 #include "pathmax.h"
  53 #include "error.h"
  54 #include "filemode.h"
  55
  56 #include "listfile.h"
  57
  58 #if HAVE_STRING_H || STDC_HEADERS
  59 #include <string.h>
  60 #else
  61 #include <strings.h>
  62 #endif
  63
  64
  65 /* The presence of unistd.h is assumed by gnulib these days, so we
  66  * might as well assume it too.
  67  */
  68 #include <unistd.h> /* for readlink() */
  69
  70
  71 #if STDC_HEADERS
  72 # include <stdlib.h>
  73 #else
  74 char *getenv ();
  75 extern int errno;
  76 #endif
  77
  78 /* Since major is a function on SVR4, we can't use `ifndef major'.  */
  79 #ifdef MAJOR_IN_MKDEV
  80 #include <sys/mkdev.h>
  81 #define HAVE_MAJOR
  82 #endif
  83 #ifdef MAJOR_IN_SYSMACROS
  84 #include <sys/sysmacros.h>
  85 #define HAVE_MAJOR
  86 #endif
  87
  88 #ifdef STAT_MACROS_BROKEN
  89 #undef S_ISCHR
  90 #undef S_ISBLK
  91 #undef S_ISLNK
  92 #endif
  93
  94 #ifndef S_ISCHR
  95 #define S_ISCHR(m) (((m) & S_IFMT) == S_IFCHR)
  96 #endif
  97 #ifndef S_ISBLK
  98 #define S_ISBLK(m) (((m) & S_IFMT) == S_IFBLK)
  99 #endif
 100 #if defined(S_IFLNK) && !defined(S_ISLNK)
 101 #define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
 102 #endif
 103
 104 /* Get or fake the disk device blocksize.
 105    Usually defined by sys/param.h (if at all).  */
 106 #ifndef DEV_BSIZE
 107 # ifdef BSIZE
 108 #  define DEV_BSIZE BSIZE
 109 # else /* !BSIZE */
 110 #  define DEV_BSIZE 4096
 111 # endif /* !BSIZE */
 112 #endif /* !DEV_BSIZE */
 113
 114 /* Extract or fake data from a `struct stat'.
 115    ST_BLKSIZE: Preferred I/O blocksize for the file, in bytes.
 116    ST_NBLOCKS: Number of blocks in the file, including indirect blocks.
 117    ST_NBLOCKSIZE: Size of blocks used when calculating ST_NBLOCKS.  */
 118 #ifndef HAVE_STRUCT_STAT_ST_BLOCKS
 119 # define ST_BLKSIZE(statbuf) DEV_BSIZE
 120 # if defined(_POSIX_SOURCE) || !defined(BSIZE) /* fileblocks.c uses BSIZE.  */
 121 #  define ST_NBLOCKS(statbuf) \
 122   (S_ISREG ((statbuf).st_mode) \
 123    || S_ISDIR ((statbuf).st_mode) \
 124    ? (statbuf).st_size / ST_NBLOCKSIZE + ((statbuf).st_size % ST_NBLOCKSIZE != 0) : 0)
 125 # else /* !_POSIX_SOURCE && BSIZE */
 126 #  define ST_NBLOCKS(statbuf) \
 127   (S_ISREG ((statbuf).st_mode) \
 128    || S_ISDIR ((statbuf).st_mode) \
 129    ? st_blocks ((statbuf).st_size) : 0)
 130 # endif /* !_POSIX_SOURCE && BSIZE */
 131 #else /* HAVE_STRUCT_STAT_ST_BLOCKS */
 132 /* Some systems, like Sequents, return st_blksize of 0 on pipes. */
 133 # define ST_BLKSIZE(statbuf) ((statbuf).st_blksize > 0 \
 134                                ? (statbuf).st_blksize : DEV_BSIZE)
 135 # if defined(hpux) || defined(__hpux__) || defined(__hpux)
 136 /* HP-UX counts st_blocks in 1024-byte units.
 137    This loses when mixing HP-UX and BSD filesystems with NFS.  */
 138 #  define ST_NBLOCKSIZE 1024
 139 # else /* !hpux */
 140 #  if defined(_AIX) && defined(_I386)
 141 /* AIX PS/2 counts st_blocks in 4K units.  */
 142 #   define ST_NBLOCKSIZE (4 * 1024)
 143 #  else /* not AIX PS/2 */
 144 #   if defined(_CRAY)
 145 #    define ST_NBLOCKS(statbuf) \
 146   (S_ISREG ((statbuf).st_mode) \
 147    || S_ISDIR ((statbuf).st_mode) \
 148    ? (statbuf).st_blocks * ST_BLKSIZE(statbuf)/ST_NBLOCKSIZE : 0)
 149 #   endif /* _CRAY */
 150 #  endif /* not AIX PS/2 */
 151 # endif /* !hpux */
 152 #endif /* HAVE_STRUCT_STAT_ST_BLOCKS */
 153
 154 #ifndef ST_NBLOCKS
 155 # define ST_NBLOCKS(statbuf) \
 156   (S_ISREG ((statbuf).st_mode) \
 157    || S_ISDIR ((statbuf).st_mode) \
 158    ? (statbuf).st_blocks : 0)
 159 #endif
 160
 161 #ifndef ST_NBLOCKSIZE
 162 # define ST_NBLOCKSIZE 512
 163 #endif
 164
 165 #ifndef _POSIX_VERSION
 166 struct passwd *getpwuid ();
 167 struct group *getgrgid ();
 168 #endif
 169
 170 #ifdef major                    /* Might be defined in sys/types.h.  */
 171 #define HAVE_MAJOR
 172 #endif
 173 #ifndef HAVE_MAJOR
 174 #define major(dev)  (((dev) >> 8) & 0xff)
 175 #define minor(dev)  ((dev) & 0xff)
 176 #endif
 177 #undef HAVE_MAJOR
 178
 179
 180 char * get_link_name (char *name, char *relname);
 181 static void print_name_with_quoting (register char *p, FILE *stream);
 182
 183 extern char * getgroup (gid_t gid);
 184 extern char * getuser (uid_t uid);
 185
 186
 187 /* NAME is the name to print.
 188    RELNAME is the path to access it from the current directory.
 189    STATP is the results of stat or lstat on it.
 190    Use CURRENT_TIME to decide whether to print yyyy or hh:mm.
 191    Use OUTPUT_BLOCK_SIZE to determine how to print file block counts
 192    and sizes.
 193    STREAM is the stdio stream to print on.  */
 194
 195 void
 196 list_file (char *name,
 197            char *relname,
 198            struct stat *statp,
 199            time_t current_time,
 200            int output_block_size,
 201            FILE *stream)
 202 {
 203   char modebuf[11];
 204   struct tm const *when_local;
 205   char const *user_name;
 206   char const *group_name;
 207   char hbuf[LONGEST_HUMAN_READABLE + 1];
 208
 209 #if HAVE_ST_DM_MODE
 210   /* Cray DMF: look at the file's migrated, not real, status */
 211   mode_string (statp->st_dm_mode, modebuf);
 212 #else
 213   mode_string (statp->st_mode, modebuf);
 214 #endif
 215   modebuf[10] = '\0';
 216
 217   fprintf (stream, "%6s ",
 218            human_readable ((uintmax_t) statp->st_ino, hbuf,
 219                            human_ceiling,
 220                            1, 1));
 221
 222   fprintf (stream, "%4s ",
 223            human_readable ((uintmax_t) ST_NBLOCKS (*statp), hbuf,
 224                            human_ceiling,
 225                            ST_NBLOCKSIZE, output_block_size));
 226
 227
 228   /* The space between the mode and the number of links is the POSIX
 229      "optional alternate access method flag".  */
 230   fprintf (stream, "%s %3lu ", modebuf, (unsigned long) statp->st_nlink);
 231
 232   user_name = getuser (statp->st_uid);
 233   if (user_name)
 234     fprintf (stream, "%-8s ", user_name);
 235   else
 236     fprintf (stream, "%-8lu ", (unsigned long) statp->st_uid);
 237
 238   group_name = getgroup (statp->st_gid);
 239   if (group_name)
 240     fprintf (stream, "%-8s ", group_name);
 241   else
 242     fprintf (stream, "%-8lu ", (unsigned long) statp->st_gid);
 243
 244   if (S_ISCHR (statp->st_mode) || S_ISBLK (statp->st_mode))
 245 #ifdef HAVE_ST_RDEV
 246     fprintf (stream, "%3lu, %3lu ",
 247              (unsigned long) major (statp->st_rdev),
 248              (unsigned long) minor (statp->st_rdev));
 249 #else
 250     fprintf (stream, "         ");
 251 #endif
 252   else
 253     fprintf (stream, "%8s ",
 254              human_readable ((uintmax_t) statp->st_size, hbuf,
 255                              human_ceiling,
 256                              1,
 257                              output_block_size < 0 ? output_block_size : 1));
 258
 259   if ((when_local = localtime (&statp->st_mtime)))
 260     {
 261       char init_bigbuf[256];
 262       char *buf = init_bigbuf;
 263       size_t bufsize = sizeof init_bigbuf;
 264
 265       /* Use strftime rather than ctime, because the former can produce
 266          locale-dependent names for the month (%b).
 267
 268          Output the year if the file is fairly old or in the future.
 269          POSIX says the cutoff is 6 months old;
 270          approximate this by 6*30 days.
 271          Allow a 1 hour slop factor for what is considered "the future",
 272          to allow for NFS server/client clock disagreement.  */
 273       char const *fmt =
 274         ((current_time - 6 * 30 * 24 * 60 * 60 <= statp->st_mtime
 275           && statp->st_mtime <= current_time + 60 * 60)
 276          ? "%b %e %H:%M"
 277          : "%b %e  %Y");
 278
 279       while (!strftime (buf, bufsize, fmt, when_local))
 280         buf = (char *) alloca (bufsize *= 2);
 281
 282       fprintf (stream, "%s ", buf);
 283     }
 284   else
 285     {
 286       /* The time cannot be represented as a local time;
 287          print it as a huge integer number of seconds.  */
 288       int width = 12;
 289
 290       if (statp->st_mtime < 0)
 291         {
 292           char const *num = human_readable (- (uintmax_t) statp->st_mtime,
 293                                             hbuf, human_ceiling, 1, 1);
 294           int sign_width = width - strlen (num);
 295           fprintf (stream, "%*s%s ",
 296                    sign_width < 0 ? 0 : sign_width, "-", num);
 297         }
 298       else
 299         fprintf (stream, "%*s ", width,
 300                  human_readable ((uintmax_t) statp->st_mtime, hbuf,
 301                                  human_ceiling,
 302                                  1, 1));
 303     }
 304
 305   print_name_with_quoting (name, stream);
 306
 307 #ifdef S_ISLNK
 308   if (S_ISLNK (statp->st_mode))
 309     {
 310       char *linkname = get_link_name (name, relname);
 311
 312       if (linkname)
 313         {
 314           fputs (" -> ", stream);
 315           print_name_with_quoting (linkname, stream);
 316           free (linkname);
 317         }
 318     }
 319 #endif
 320   putc ('\n', stream);
 321 }
 322
 323 static void
 324 print_name_with_quoting (register char *p, FILE *stream)
 325 {
 326   register unsigned char c;
 327
 328   while ((c = *p++) != '\0')
 329     {
 330       switch (c)
 331         {
 332         case '\\':
 333           fprintf (stream, "\\\\");
 334           break;
 335
 336         case '\n':
 337           fprintf (stream, "\\n");
 338           break;
 339
 340         case '\b':
 341           fprintf (stream, "\\b");
 342           break;
 343
 344         case '\r':
 345           fprintf (stream, "\\r");
 346           break;
 347
 348         case '\t':
 349           fprintf (stream, "\\t");
 350           break;
 351
 352         case '\f':
 353           fprintf (stream, "\\f");
 354           break;
 355
 356         case ' ':
 357           fprintf (stream, "\\ ");
 358           break;
 359
 360         case '"':
 361           fprintf (stream, "\\\"");
 362           break;
 363
 364         default:
 365           if (c > 040 && c < 0177)
 366             putc (c, stream);
 367           else
 368             fprintf (stream, "\\%03o", (unsigned int) c);
 369         }
 370     }
 371 }
 372
 373 #ifdef S_ISLNK
 374 char *
 375 get_link_name (char *name, char *relname)
 376 {
 377   register char *linkname;
 378   register int linklen;
 379
 380   /* st_size is wrong for symlinks on AIX, and on
 381      mount points with some automounters.
 382      So allocate a pessimistic PATH_MAX + 1 bytes.  */
 383 #define LINK_BUF PATH_MAX
 384   linkname = (char *) xmalloc (LINK_BUF + 1);
 385   linklen = readlink (relname, linkname, LINK_BUF);
 386   if (linklen < 0)
 387     {
 388       error (0, errno, "%s", name);
 389       free (linkname);
 390       return 0;
 391     }
 392   linkname[linklen] = '\0';
 393   return linkname;
 394 }
 395 #endif