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-2007 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 read_only = 1;
  47 int list_only = 0;
  48 int preserve_perms = 0;
  49
  50 #ifdef SUPPORT_XATTRS
  51
  52 #ifdef HAVE_LINUX_XATTRS
  53 #define XSTAT_ATTR "user.rsync.%stat"
  54 #else
  55 #define XSTAT_ATTR "rsync.%stat"
  56 #endif
  57
  58 static int stat_xattr(const char *fname, STRUCT_STAT *fst)
  59 {
  60         int mode, rdev_major, rdev_minor, uid, gid, len;
  61         char buf[256];
  62
  63         if (am_root >= 0 || IS_DEVICE(fst->st_mode) || IS_SPECIAL(fst->st_mode))
  64                 return -1;
  65
  66         len = sys_lgetxattr(fname, XSTAT_ATTR, buf, sizeof buf - 1);
  67         if (len >= (int)sizeof buf) {
  68                 len = -1;
  69                 errno = ERANGE;
  70         }
  71         if (len < 0) {
  72                 if (errno == ENOTSUP || errno == ENOATTR)
  73                         return -1;
  74                 if (errno == EPERM && S_ISLNK(fst->st_mode)) {
  75                         fst->st_uid = 0;
  76                         fst->st_gid = 0;
  77                         return 0;
  78                 }
  79                 fprintf(stderr, "failed to read xattr %s for %s: %s\n",
  80                         XSTAT_ATTR, fname, strerror(errno));
  81                 return -1;
  82         }
  83         buf[len] = '\0';
  84
  85         if (sscanf(buf, "%o %d,%d %d:%d",
  86                    &mode, &rdev_major, &rdev_minor, &uid, &gid) != 5) {
  87                 fprintf(stderr, "Corrupt %s xattr attached to %s: \"%s\"\n",
  88                         XSTAT_ATTR, fname, buf);
  89                 exit(1);
  90         }
  91
  92         fst->st_mode = from_wire_mode(mode);
  93         fst->st_rdev = MAKEDEV(rdev_major, rdev_minor);
  94         fst->st_uid = uid;
  95         fst->st_gid = gid;
  96
  97         return 0;
  98 }
  99
 100 #endif
 101
 102 static void failed(char const *what, char const *where)
 103 {
 104         fprintf(stderr, PROGRAM ": %s %s: %s\n",
 105                 what, where, strerror(errno));
 106         exit(1);
 107 }
 108
 109 static void list_file(const char *fname)
 110 {
 111         STRUCT_STAT buf;
 112         char permbuf[PERMSTRING_SIZE];
 113         struct tm *mt;
 114         char datebuf[50];
 115         char linkbuf[4096];
 116
 117         if (do_lstat(fname, &buf) < 0)
 118                 failed("stat", fname);
 119 #ifdef SUPPORT_XATTRS
 120         if (am_root < 0)
 121                 stat_xattr(fname, &buf);
 122 #endif
 123
 124         /* The size of anything but a regular file is probably not
 125          * worth thinking about. */
 126         if (!S_ISREG(buf.st_mode))
 127                 buf.st_size = 0;
 128
 129         /* On some BSD platforms the mode bits of a symlink are
 130          * undefined.  Also it tends not to be possible to reset a
 131          * symlink's mtime, so we have to ignore it too. */
 132         if (S_ISLNK(buf.st_mode)) {
 133                 int len;
 134                 buf.st_mode &= ~0777;
 135                 buf.st_mtime = (time_t)0;
 136                 buf.st_uid = buf.st_gid = 0;
 137                 strlcpy(linkbuf, " -> ", sizeof linkbuf);
 138                 /* const-cast required for silly UNICOS headers */
 139                 len = readlink((char *) fname, linkbuf+4, sizeof(linkbuf) - 4);
 140                 if (len == -1)
 141                         failed("readlink", fname);
 142                 else
 143                         /* it's not nul-terminated */
 144                         linkbuf[4+len] = 0;
 145         } else {
 146                 linkbuf[0] = 0;
 147         }
 148
 149         permstring(permbuf, buf.st_mode);
 150
 151         if (buf.st_mtime) {
 152                 mt = gmtime(&buf.st_mtime);
 153
 154                 snprintf(datebuf, sizeof datebuf,
 155                         "%04d-%02d-%02d %02d:%02d:%02d",
 156                         (int)mt->tm_year + 1900,
 157                         (int)mt->tm_mon + 1,
 158                         (int)mt->tm_mday,
 159                         (int)mt->tm_hour,
 160                         (int)mt->tm_min,
 161                         (int)mt->tm_sec);
 162         } else
 163                 strlcpy(datebuf, "                   ", sizeof datebuf);
 164
 165         /* TODO: Perhaps escape special characters in fname? */
 166
 167         printf("%s ", permbuf);
 168         if (S_ISCHR(buf.st_mode) || S_ISBLK(buf.st_mode)) {
 169                 printf("%5ld,%6ld",
 170                     (long)major(buf.st_rdev),
 171                     (long)minor(buf.st_rdev));
 172         } else /* NB: use double for size since it might not fit in a long. */
 173                 printf("%12.0f", (double)buf.st_size);
 174         printf(" %6ld.%-6ld %6ld %s %s%s\n",
 175                (long)buf.st_uid, (long)buf.st_gid, (long)buf.st_nlink,
 176                datebuf, fname, linkbuf);
 177 }
 178
 179 static struct poptOption long_options[] = {
 180   /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
 181 #ifdef SUPPORT_XATTRS
 182   {"fake-super",      'f', POPT_ARG_VAL,    &am_root, -1, 0, 0 },
 183 #endif
 184   {"help",            'h', POPT_ARG_NONE,   0, 'h', 0, 0 },
 185   {0,0,0,0,0,0,0}
 186 };
 187
 188 static void tls_usage(int ret)
 189 {
 190   FILE *F = ret ? stderr : stdout;
 191   fprintf(F,"usage: " PROGRAM " [OPTIONS] FILE ...\n");
 192   fprintf(F,"Trivial file listing program for portably checking rsync\n");
 193   fprintf(F,"\nOptions:\n");
 194 #ifdef SUPPORT_XATTRS
 195   fprintf(F," -f, --fake-super            display attributes including fake-super xattrs\n");
 196 #endif
 197   fprintf(F," -h, --help                  show this help\n");
 198   exit(ret);
 199 }
 200
 201 int
 202 main(int argc, char *argv[])
 203 {
 204         poptContext pc;
 205         const char **extra_args;
 206         int opt;
 207
 208         pc = poptGetContext(PROGRAM, argc, (const char **)argv,
 209                             long_options, 0);
 210         while ((opt = poptGetNextOpt(pc)) != -1) {
 211                 switch (opt) {
 212                 case 'h':
 213                         tls_usage(0);
 214                 default:
 215                         fprintf(stderr,
 216                                 "%s: %s\n",
 217                                 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
 218                                 poptStrerror(opt));
 219                         tls_usage(1);
 220                 }
 221         }
 222
 223         extra_args = poptGetArgs(pc);
 224         if (!extra_args || *extra_args == NULL)
 225                 tls_usage(1);
 226
 227         for (; *extra_args; extra_args++)
 228                 list_file(*extra_args);
 229         poptFreeContext(pc);
 230
 231         return 0;
 232 }