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-2020 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         int mode, rdev_major, rdev_minor, uid, gid, len;
  64         char buf[256];
  65
  66         if (am_root >= 0 || IS_DEVICE(fst->st_mode) || IS_SPECIAL(fst->st_mode))
  67                 return -1;
  68
  69         len = sys_lgetxattr(fname, XSTAT_ATTR, buf, sizeof buf - 1);
  70         if (len >= (int)sizeof buf) {
  71                 len = -1;
  72                 errno = ERANGE;
  73         }
  74         if (len < 0) {
  75                 if (errno == ENOTSUP || errno == ENOATTR)
  76                         return -1;
  77                 if (errno == EPERM && S_ISLNK(fst->st_mode)) {
  78                         fst->st_uid = 0;
  79                         fst->st_gid = 0;
  80                         return 0;
  81                 }
  82                 fprintf(stderr, "failed to read xattr %s for %s: %s\n",
  83                         XSTAT_ATTR, fname, strerror(errno));
  84                 return -1;
  85         }
  86         buf[len] = '\0';
  87
  88         if (sscanf(buf, "%o %d,%d %d:%d",
  89                    &mode, &rdev_major, &rdev_minor, &uid, &gid) != 5) {
  90                 fprintf(stderr, "Corrupt %s xattr attached to %s: \"%s\"\n",
  91                         XSTAT_ATTR, fname, buf);
  92                 exit(1);
  93         }
  94
  95 #if _S_IFLNK != 0120000
  96         if ((mode & (_S_IFMT)) == 0120000)
  97                 mode = (mode & ~(_S_IFMT)) | _S_IFLNK;
  98 #endif
  99         fst->st_mode = mode;
 100
 101         fst->st_rdev = MAKEDEV(rdev_major, rdev_minor);
 102         fst->st_uid = uid;
 103         fst->st_gid = gid;
 104
 105         return 0;
 106 }
 107
 108 #endif
 109
 110 static int display_atimes = 0;
 111
 112 static void failed(char const *what, char const *where)
 113 {
 114         fprintf(stderr, PROGRAM ": %s %s: %s\n",
 115                 what, where, strerror(errno));
 116         exit(1);
 117 }
 118
 119 static void storetime(char *dest, size_t destsize, time_t t, int nsecs)
 120 {
 121         if (t) {
 122                 int len;
 123                 struct tm *mt = gmtime(&t);
 124
 125                 len = snprintf(dest, destsize,
 126                         " %04d-%02d-%02d %02d:%02d:%02d",
 127                         (int)mt->tm_year + 1900,
 128                         (int)mt->tm_mon + 1,
 129                         (int)mt->tm_mday,
 130                         (int)mt->tm_hour,
 131                         (int)mt->tm_min,
 132                         (int)mt->tm_sec);
 133                 if (nsecs >= 0 && len >= 0)
 134                         snprintf(dest + len, destsize - len, ".%09d", nsecs);
 135         } else {
 136                 int has_nsecs = nsecs >= 0 ? 1 : 0;
 137                 int len = MIN(20 + 10*has_nsecs, (int)destsize - 1);
 138                 memset(dest, ' ', len);
 139                 dest[len] = '\0';
 140         }
 141 }
 142
 143 static void list_file(const char *fname)
 144 {
 145         STRUCT_STAT buf;
 146         char permbuf[PERMSTRING_SIZE];
 147         char mtimebuf[50];
 148         char atimebuf[50];
 149         char linkbuf[4096];
 150         int nsecs;
 151
 152         if (do_lstat(fname, &buf) < 0)
 153                 failed("stat", fname);
 154 #ifdef SUPPORT_XATTRS
 155         if (am_root < 0)
 156                 stat_xattr(fname, &buf);
 157 #endif
 158
 159         /* The size of anything but a regular file is probably not
 160          * worth thinking about. */
 161         if (!S_ISREG(buf.st_mode))
 162                 buf.st_size = 0;
 163
 164         /* On some BSD platforms the mode bits of a symlink are
 165          * undefined.  Also it tends not to be possible to reset a
 166          * symlink's mtime, so we default to ignoring it too. */
 167         if (S_ISLNK(buf.st_mode)) {
 168                 int len;
 169                 buf.st_mode &= ~0777;
 170                 if (!link_times)
 171                         buf.st_mtime = (time_t)0;
 172                 if (!link_owner)
 173                         buf.st_uid = buf.st_gid = 0;
 174                 strlcpy(linkbuf, " -> ", sizeof linkbuf);
 175                 /* const-cast required for silly UNICOS headers */
 176                 len = do_readlink((char*)fname, linkbuf+4, sizeof linkbuf - 4);
 177                 if (len == -1)
 178                         failed("do_readlink", fname);
 179                 else
 180                         /* it's not nul-terminated */
 181                         linkbuf[4+len] = 0;
 182         } else {
 183                 linkbuf[0] = '\0';
 184         }
 185
 186         permstring(permbuf, buf.st_mode);
 187 #ifdef ST_MTIME_NSEC
 188         if (nsec_times)
 189                 nsecs = (int)buf.ST_MTIME_NSEC;
 190         else
 191 #endif
 192                 nsecs = -1;
 193         storetime(mtimebuf, sizeof mtimebuf, buf.st_mtime, nsecs);
 194         if (display_atimes)
 195                 storetime(atimebuf, sizeof atimebuf, S_ISDIR(buf.st_mode) ? 0 : buf.st_atime, -1);
 196         else
 197                 atimebuf[0] = '\0';
 198
 199         /* TODO: Perhaps escape special characters in fname? */
 200         printf("%s ", permbuf);
 201
 202         if (S_ISCHR(buf.st_mode) || S_ISBLK(buf.st_mode)) {
 203                 printf("%5ld,%6ld", (long)major(buf.st_rdev), (long)minor(buf.st_rdev));
 204         } else
 205                 printf("%15s", do_big_num(buf.st_size, 1, NULL));
 206
 207         printf(" %6ld.%-6ld %6ld%s%s %s%s\n",
 208                (long)buf.st_uid, (long)buf.st_gid, (long)buf.st_nlink,
 209                mtimebuf, atimebuf, fname, linkbuf);
 210 }
 211
 212 static struct poptOption long_options[] = {
 213   /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
 214   {"atimes",          'U', POPT_ARG_NONE,   &display_atimes, 0, 0, 0},
 215   {"link-times",      'l', POPT_ARG_NONE,   &link_times, 0, 0, 0 },
 216   {"link-owner",      'L', POPT_ARG_NONE,   &link_owner, 0, 0, 0 },
 217 #ifdef SUPPORT_XATTRS
 218   {"fake-super",      'f', POPT_ARG_VAL,    &am_root, -1, 0, 0 },
 219 #endif
 220 #ifdef ST_MTIME_NSEC
 221   {"nsec",            's', POPT_ARG_NONE,   &nsec_times, 0, 0, 0 },
 222 #endif
 223   {"help",            'h', POPT_ARG_NONE,   0, 'h', 0, 0 },
 224   {0,0,0,0,0,0,0}
 225 };
 226
 227 static void NORETURN tls_usage(int ret)
 228 {
 229   FILE *F = ret ? stderr : stdout;
 230   fprintf(F,"usage: " PROGRAM " [OPTIONS] FILE ...\n");
 231   fprintf(F,"Trivial file listing program for portably checking rsync\n");
 232   fprintf(F,"\nOptions:\n");
 233   fprintf(F," -U, --atimes                display access (last-used) times\n");
 234   fprintf(F," -l, --link-times            display the time on a symlink\n");
 235   fprintf(F," -L, --link-owner            display the owner+group on a symlink\n");
 236 #ifdef SUPPORT_XATTRS
 237   fprintf(F," -f, --fake-super            display attributes including fake-super xattrs\n");
 238 #endif
 239   fprintf(F," -h, --help                  show this help\n");
 240   exit(ret);
 241 }
 242
 243 int
 244 main(int argc, char *argv[])
 245 {
 246         poptContext pc;
 247         const char **extra_args;
 248         int opt;
 249
 250         pc = poptGetContext(PROGRAM, argc, (const char **)argv, long_options, 0);
 251         while ((opt = poptGetNextOpt(pc)) != -1) {
 252                 switch (opt) {
 253                 case 'h':
 254                         tls_usage(0);
 255                 default:
 256                         fprintf(stderr, "%s: %s\n",
 257                                 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
 258                                 poptStrerror(opt));
 259                         tls_usage(1);
 260                 }
 261         }
 262
 263         extra_args = poptGetArgs(pc);
 264         if (!extra_args || *extra_args == NULL)
 265                 tls_usage(1);
 266
 267         for (; *extra_args; extra_args++)
 268                 list_file(*extra_args);
 269         poptFreeContext(pc);
 270
 271         return 0;
 272 }