tls.c

   1 /*
   2  * Trivial ls for comparing two directories after running an rsync.
   3  *
   4  * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
   5  * Copyright (C) 2003-2022 Wayne Davison
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
  20  */
  21
  22 /* The problem with using the system's own ls is that some features
  23  * have little quirks that make directories look different when for
  24  * our purposes they're the same -- for example, the BSD braindamage
  25  * about setting the mode on symlinks based on your current umask.
  26  *
  27  * All the filenames must be given on the command line -- tls does not
  28  * even read directories, let alone recurse.  The typical usage is
  29  * "find|sort|xargs tls".
  30  *
  31  * The format is not exactly the same as any particular Unix ls(1).
  32  *
  33  * A key requirement for this program is that the output be "very
  34  * reproducible."  So we mask away information that can accidentally
  35  * change. */
  36
  37 #include "rsync.h"
  38 #include <popt.h>
  39 #include "lib/sysxattrs.h"
  40
  41 #define PROGRAM "tls"
  42
  43 /* These are to make syscall.o shut up. */
  44 int dry_run = 0;
  45 int am_root = 0;
  46 int am_sender = 1;
  47 int read_only = 1;
  48 int list_only = 0;
  49 int link_times = 0;
  50 int link_owner = 0;
  51 int nsec_times = 0;
  52
  53 #ifdef SUPPORT_XATTRS
  54
  55 #ifdef HAVE_LINUX_XATTRS
  56 #define XSTAT_ATTR "user.rsync.%stat"
  57 #else
  58 #define XSTAT_ATTR "rsync.%stat"
  59 #endif
  60
  61 static int stat_xattr(const char *fname, STRUCT_STAT *fst)
  62 {
  63         unsigned int mode;
  64         int rdev_major, rdev_minor, uid, gid, len;
  65         char buf[256];
  66
  67         if (am_root >= 0 || IS_DEVICE(fst->st_mode) || IS_SPECIAL(fst->st_mode))
  68                 return -1;
  69
  70         len = sys_lgetxattr(fname, XSTAT_ATTR, buf, sizeof buf - 1);
  71         if (len >= (int)sizeof buf) {
  72                 len = -1;
  73                 errno = ERANGE;
  74         }
  75         if (len < 0) {
  76                 if (errno == ENOTSUP || errno == ENOATTR)
  77                         return -1;
  78                 if (errno == EPERM && S_ISLNK(fst->st_mode)) {
  79                         fst->st_uid = 0;
  80                         fst->st_gid = 0;
  81                         return 0;
  82                 }
  83                 fprintf(stderr, "failed to read xattr %s for %s: %s\n",
  84                         XSTAT_ATTR, fname, strerror(errno));
  85                 return -1;
  86         }
  87         buf[len] = '\0';
  88
  89         if (sscanf(buf, "%o %d,%d %d:%d",
  90                    &mode, &rdev_major, &rdev_minor, &uid, &gid) != 5) {
  91                 fprintf(stderr, "Corrupt %s xattr attached to %s: \"%s\"\n",
  92                         XSTAT_ATTR, fname, buf);
  93                 exit(1);
  94         }
  95
  96 #if _S_IFLNK != 0120000
  97         if ((mode & (_S_IFMT)) == 0120000)
  98                 mode = (mode & ~(_S_IFMT)) | _S_IFLNK;
  99 #endif
 100         fst->st_mode = mode;
 101
 102         fst->st_rdev = MAKEDEV(rdev_major, rdev_minor);
 103         fst->st_uid = uid;
 104         fst->st_gid = gid;
 105
 106         return 0;
 107 }
 108
 109 #endif
 110
 111 static int display_atimes = 0;
 112 #ifdef SUPPORT_CRTIMES
 113 static int display_crtimes = 0;
 114 #endif
 115
 116 static void failed(char const *what, char const *where)
 117 {
 118         fprintf(stderr, PROGRAM ": %s %s: %s\n",
 119                 what, where, strerror(errno));
 120         exit(1);
 121 }
 122
 123 static void storetime(char *dest, size_t destsize, time_t t, int nsecs)
 124 {
 125         if (t) {
 126                 int len;
 127                 struct tm *mt = gmtime(&t);
 128
 129                 len = snprintf(dest, destsize,
 130                         " %04d-%02d-%02d %02d:%02d:%02d",
 131                         (int)mt->tm_year + 1900,
 132                         (int)mt->tm_mon + 1,
 133                         (int)mt->tm_mday,
 134                         (int)mt->tm_hour,
 135                         (int)mt->tm_min,
 136                         (int)mt->tm_sec);
 137                 if (nsecs >= 0 && len >= 0)
 138                         snprintf(dest + len, destsize - len, ".%09d", nsecs);
 139         } else {
 140                 int has_nsecs = nsecs >= 0 ? 1 : 0;
 141                 int len = MIN(20 + 10*has_nsecs, (int)destsize - 1);
 142                 memset(dest, ' ', len);
 143                 dest[len] = '\0';
 144         }
 145 }
 146
 147 static void list_file(const char *fname)
 148 {
 149         STRUCT_STAT buf;
 150 #ifdef SUPPORT_CRTIMES
 151         time_t crtime = 0;
 152 #endif
 153         char permbuf[PERMSTRING_SIZE];
 154         char mtimebuf[50];
 155         char atimebuf[50];
 156         char crtimebuf[50];
 157         char linkbuf[4096];
 158         int nsecs;
 159
 160         if (do_lstat(fname, &buf) < 0)
 161                 failed("stat", fname);
 162 #ifdef SUPPORT_CRTIMES
 163         if (display_crtimes && (crtime = get_create_time(fname, &buf)) == 0)
 164                 failed("get_create_time", fname);
 165 #endif
 166 #ifdef SUPPORT_XATTRS
 167         if (am_root < 0)
 168                 stat_xattr(fname, &buf);
 169 #endif
 170
 171         /* The size of anything but a regular file is probably not
 172          * worth thinking about. */
 173         if (!S_ISREG(buf.st_mode))
 174                 buf.st_size = 0;
 175
 176         /* On some BSD platforms the mode bits of a symlink are
 177          * undefined.  Also it tends not to be possible to reset a
 178          * symlink's mtime, so we default to ignoring it too. */
 179         if (S_ISLNK(buf.st_mode)) {
 180                 int len;
 181                 buf.st_mode &= ~0777;
 182                 if (!link_times)
 183                         buf.st_mtime = (time_t)0;
 184                 if (!link_owner)
 185                         buf.st_uid = buf.st_gid = 0;
 186                 strlcpy(linkbuf, " -> ", sizeof linkbuf);
 187                 /* const-cast required for silly UNICOS headers */
 188                 len = do_readlink((char*)fname, linkbuf+4, sizeof linkbuf - 4);
 189                 if (len == -1)
 190                         failed("do_readlink", fname);
 191                 else
 192                         /* it's not nul-terminated */
 193                         linkbuf[4+len] = 0;
 194         } else {
 195                 linkbuf[0] = '\0';
 196         }
 197
 198         permstring(permbuf, buf.st_mode);
 199 #ifdef ST_MTIME_NSEC
 200         if (nsec_times)
 201                 nsecs = (int)buf.ST_MTIME_NSEC;
 202         else
 203 #endif
 204                 nsecs = -1;
 205         storetime(mtimebuf, sizeof mtimebuf, buf.st_mtime, nsecs);
 206         if (display_atimes)
 207                 storetime(atimebuf, sizeof atimebuf, S_ISDIR(buf.st_mode) ? 0 : buf.st_atime, -1);
 208         else
 209                 atimebuf[0] = '\0';
 210 #ifdef SUPPORT_CRTIMES
 211         if (display_crtimes)
 212                 storetime(crtimebuf, sizeof crtimebuf, crtime, -1);
 213         else
 214 #endif
 215                 crtimebuf[0] = '\0';
 216
 217         /* TODO: Perhaps escape special characters in fname? */
 218         printf("%s ", permbuf);
 219
 220         if (S_ISCHR(buf.st_mode) || S_ISBLK(buf.st_mode)) {
 221                 printf("%5ld,%6ld", (long)major(buf.st_rdev), (long)minor(buf.st_rdev));
 222         } else
 223                 printf("%15s", do_big_num(buf.st_size, 1, NULL));
 224
 225         printf(" %6ld.%-6ld %6ld%s%s%s %s%s\n",
 226                (long)buf.st_uid, (long)buf.st_gid, (long)buf.st_nlink,
 227                mtimebuf, atimebuf, crtimebuf, fname, linkbuf);
 228 }
 229
 230 static struct poptOption long_options[] = {
 231   /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
 232   {"atimes",          'U', POPT_ARG_NONE,   &display_atimes, 0, 0, 0},
 233 #ifdef SUPPORT_CRTIMES
 234   {"crtimes",         'N', POPT_ARG_NONE,   &display_crtimes, 0, 0, 0},
 235 #endif
 236   {"link-times",      'l', POPT_ARG_NONE,   &link_times, 0, 0, 0 },
 237   {"link-owner",      'L', POPT_ARG_NONE,   &link_owner, 0, 0, 0 },
 238 #ifdef SUPPORT_XATTRS
 239   {"fake-super",      'f', POPT_ARG_VAL,    &am_root, -1, 0, 0 },
 240 #endif
 241 #ifdef ST_MTIME_NSEC
 242   {"nsec",            's', POPT_ARG_NONE,   &nsec_times, 0, 0, 0 },
 243 #endif
 244   {"help",            'h', POPT_ARG_NONE,   0, 'h', 0, 0 },
 245   {0,0,0,0,0,0,0}
 246 };
 247
 248 static void NORETURN tls_usage(int ret)
 249 {
 250   FILE *F = ret ? stderr : stdout;
 251   fprintf(F,"usage: " PROGRAM " [OPTIONS] FILE ...\n");
 252   fprintf(F,"Trivial file listing program for portably checking rsync\n");
 253   fprintf(F,"\nOptions:\n");
 254   fprintf(F," -U, --atimes                display access (last-used) times\n");
 255 #ifdef SUPPORT_CRTIMES
 256   fprintf(F," -N, --crtimes               display create times (newness)\n");
 257 #endif
 258   fprintf(F," -l, --link-times            display the time on a symlink\n");
 259   fprintf(F," -L, --link-owner            display the owner+group on a symlink\n");
 260 #ifdef SUPPORT_XATTRS
 261   fprintf(F," -f, --fake-super            display attributes including fake-super xattrs\n");
 262 #endif
 263   fprintf(F," -h, --help                  show this help\n");
 264   exit(ret);
 265 }
 266
 267 int
 268 main(int argc, char *argv[])
 269 {
 270         poptContext pc;
 271         const char **extra_args;
 272         int opt;
 273
 274         pc = poptGetContext(PROGRAM, argc, (const char **)argv, long_options, 0);
 275         while ((opt = poptGetNextOpt(pc)) != -1) {
 276                 switch (opt) {
 277                 case 'h':
 278                         tls_usage(0);
 279                 default:
 280                         fprintf(stderr, "%s: %s\n",
 281                                 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
 282                                 poptStrerror(opt));
 283                         tls_usage(1);
 284                 }
 285         }
 286
 287         extra_args = poptGetArgs(pc);
 288         if (!extra_args || *extra_args == NULL)
 289                 tls_usage(1);
 290
 291         for (; *extra_args; extra_args++)
 292                 list_file(*extra_args);
 293         poptFreeContext(pc);
 294
 295         return 0;
 296 }