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