Annotation of embedaddon/rsync/tls.c, revision 1.1.1.4

1.1       misho       1: /*
                      2:  * Trivial ls for comparing two directories after running an rsync.
                      3:  *
                      4:  * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
1.1.1.4 ! misho       5:  * Copyright (C) 2003-2020 Wayne Davison
1.1       misho       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;
1.1.1.2   misho      46: int am_sender = 1;
1.1       misho      47: int read_only = 1;
                     48: int list_only = 0;
                     49: int link_times = 0;
                     50: int link_owner = 0;
1.1.1.2   misho      51: int nsec_times = 0;
1.1       misho      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: 
1.1.1.4 ! misho     110: static int display_atimes = 0;
        !           111: #ifdef SUPPORT_CRTIMES
        !           112: static int display_crtimes = 0;
        !           113: #endif
        !           114: 
1.1       misho     115: static void failed(char const *what, char const *where)
                    116: {
                    117:        fprintf(stderr, PROGRAM ": %s %s: %s\n",
                    118:                what, where, strerror(errno));
                    119:        exit(1);
                    120: }
                    121: 
1.1.1.4 ! misho     122: static void storetime(char *dest, size_t destsize, time_t t, int nsecs)
        !           123: {
        !           124:        if (t) {
        !           125:                int len;
        !           126:                struct tm *mt = gmtime(&t);
        !           127: 
        !           128:                len = snprintf(dest, destsize,
        !           129:                        " %04d-%02d-%02d %02d:%02d:%02d",
        !           130:                        (int)mt->tm_year + 1900,
        !           131:                        (int)mt->tm_mon + 1,
        !           132:                        (int)mt->tm_mday,
        !           133:                        (int)mt->tm_hour,
        !           134:                        (int)mt->tm_min,
        !           135:                        (int)mt->tm_sec);
        !           136:                if (nsecs >= 0 && len >= 0)
        !           137:                        snprintf(dest + len, destsize - len, ".%09d", nsecs);
        !           138:        } else {
        !           139:                int has_nsecs = nsecs >= 0 ? 1 : 0;
        !           140:                int len = MIN(20 + 10*has_nsecs, (int)destsize - 1);
        !           141:                memset(dest, ' ', len);
        !           142:                dest[len] = '\0';
        !           143:        }
        !           144: }
        !           145: 
1.1       misho     146: static void list_file(const char *fname)
                    147: {
                    148:        STRUCT_STAT buf;
1.1.1.4 ! misho     149: #ifdef SUPPORT_CRTIMES
        !           150:        time_t crtime = 0;
        !           151: #endif
1.1       misho     152:        char permbuf[PERMSTRING_SIZE];
1.1.1.4 ! misho     153:        char mtimebuf[50];
        !           154:        char atimebuf[50];
        !           155:        char crtimebuf[50];
1.1       misho     156:        char linkbuf[4096];
1.1.1.4 ! misho     157:        int nsecs;
1.1       misho     158: 
                    159:        if (do_lstat(fname, &buf) < 0)
                    160:                failed("stat", fname);
1.1.1.4 ! misho     161: #ifdef SUPPORT_CRTIMES
        !           162:        if (display_crtimes && (crtime = get_create_time(fname)) == 0)
        !           163:                failed("get_create_time", fname);
        !           164: #endif
1.1       misho     165: #ifdef SUPPORT_XATTRS
                    166:        if (am_root < 0)
                    167:                stat_xattr(fname, &buf);
                    168: #endif
                    169: 
                    170:        /* The size of anything but a regular file is probably not
                    171:         * worth thinking about. */
                    172:        if (!S_ISREG(buf.st_mode))
                    173:                buf.st_size = 0;
                    174: 
                    175:        /* On some BSD platforms the mode bits of a symlink are
                    176:         * undefined.  Also it tends not to be possible to reset a
                    177:         * symlink's mtime, so we default to ignoring it too. */
                    178:        if (S_ISLNK(buf.st_mode)) {
                    179:                int len;
                    180:                buf.st_mode &= ~0777;
                    181:                if (!link_times)
                    182:                        buf.st_mtime = (time_t)0;
                    183:                if (!link_owner)
                    184:                        buf.st_uid = buf.st_gid = 0;
                    185:                strlcpy(linkbuf, " -> ", sizeof linkbuf);
                    186:                /* const-cast required for silly UNICOS headers */
1.1.1.4 ! misho     187:                len = do_readlink((char*)fname, linkbuf+4, sizeof linkbuf - 4);
1.1       misho     188:                if (len == -1)
1.1.1.2   misho     189:                        failed("do_readlink", fname);
1.1       misho     190:                else
                    191:                        /* it's not nul-terminated */
                    192:                        linkbuf[4+len] = 0;
                    193:        } else {
1.1.1.4 ! misho     194:                linkbuf[0] = '\0';
1.1       misho     195:        }
                    196: 
                    197:        permstring(permbuf, buf.st_mode);
1.1.1.2   misho     198: #ifdef ST_MTIME_NSEC
1.1.1.4 ! misho     199:        if (nsec_times)
        !           200:                nsecs = (int)buf.ST_MTIME_NSEC;
        !           201:        else
1.1.1.2   misho     202: #endif
1.1.1.4 ! misho     203:                nsecs = -1;
        !           204:        storetime(mtimebuf, sizeof mtimebuf, buf.st_mtime, nsecs);
        !           205:        if (display_atimes)
        !           206:                storetime(atimebuf, sizeof atimebuf, S_ISDIR(buf.st_mode) ? 0 : buf.st_atime, -1);
        !           207:        else
        !           208:                atimebuf[0] = '\0';
        !           209: #ifdef SUPPORT_CRTIMES
        !           210:        if (display_crtimes)
        !           211:                storetime(crtimebuf, sizeof crtimebuf, crtime, -1);
        !           212:        else
        !           213: #endif
        !           214:                crtimebuf[0] = '\0';
1.1       misho     215: 
                    216:        /* TODO: Perhaps escape special characters in fname? */
                    217:        printf("%s ", permbuf);
1.1.1.4 ! misho     218: 
1.1       misho     219:        if (S_ISCHR(buf.st_mode) || S_ISBLK(buf.st_mode)) {
1.1.1.4 ! misho     220:                printf("%5ld,%6ld", (long)major(buf.st_rdev), (long)minor(buf.st_rdev));
1.1.1.2   misho     221:        } else
                    222:                printf("%15s", do_big_num(buf.st_size, 1, NULL));
1.1.1.4 ! misho     223: 
        !           224:        printf(" %6ld.%-6ld %6ld%s%s%s %s%s\n",
1.1       misho     225:               (long)buf.st_uid, (long)buf.st_gid, (long)buf.st_nlink,
1.1.1.4 ! misho     226:               mtimebuf, atimebuf, crtimebuf, fname, linkbuf);
1.1       misho     227: }
                    228: 
                    229: static struct poptOption long_options[] = {
                    230:   /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
1.1.1.4 ! misho     231:   {"atimes",          'U', POPT_ARG_NONE,   &display_atimes, 0, 0, 0},
        !           232: #ifdef SUPPORT_CRTIMES
        !           233:   {"crtimes",         'N', POPT_ARG_NONE,   &display_crtimes, 0, 0, 0},
        !           234: #endif
1.1       misho     235:   {"link-times",      'l', POPT_ARG_NONE,   &link_times, 0, 0, 0 },
                    236:   {"link-owner",      'L', POPT_ARG_NONE,   &link_owner, 0, 0, 0 },
                    237: #ifdef SUPPORT_XATTRS
                    238:   {"fake-super",      'f', POPT_ARG_VAL,    &am_root, -1, 0, 0 },
                    239: #endif
1.1.1.2   misho     240: #ifdef ST_MTIME_NSEC
                    241:   {"nsec",            's', POPT_ARG_NONE,   &nsec_times, 0, 0, 0 },
                    242: #endif
1.1       misho     243:   {"help",            'h', POPT_ARG_NONE,   0, 'h', 0, 0 },
                    244:   {0,0,0,0,0,0,0}
                    245: };
                    246: 
1.1.1.4 ! misho     247: static void NORETURN tls_usage(int ret)
1.1       misho     248: {
                    249:   FILE *F = ret ? stderr : stdout;
                    250:   fprintf(F,"usage: " PROGRAM " [OPTIONS] FILE ...\n");
                    251:   fprintf(F,"Trivial file listing program for portably checking rsync\n");
                    252:   fprintf(F,"\nOptions:\n");
1.1.1.4 ! misho     253:   fprintf(F," -U, --atimes                display access (last-used) times\n");
        !           254: #ifdef SUPPORT_CRTIMES
        !           255:   fprintf(F," -N, --crtimes               display create times (newness)\n");
        !           256: #endif
1.1       misho     257:   fprintf(F," -l, --link-times            display the time on a symlink\n");
                    258:   fprintf(F," -L, --link-owner            display the owner+group on a symlink\n");
                    259: #ifdef SUPPORT_XATTRS
                    260:   fprintf(F," -f, --fake-super            display attributes including fake-super xattrs\n");
                    261: #endif
                    262:   fprintf(F," -h, --help                  show this help\n");
                    263:   exit(ret);
                    264: }
                    265: 
                    266: int
                    267: main(int argc, char *argv[])
                    268: {
                    269:        poptContext pc;
                    270:        const char **extra_args;
                    271:        int opt;
                    272: 
1.1.1.4 ! misho     273:        pc = poptGetContext(PROGRAM, argc, (const char **)argv, long_options, 0);
1.1       misho     274:        while ((opt = poptGetNextOpt(pc)) != -1) {
                    275:                switch (opt) {
                    276:                case 'h':
                    277:                        tls_usage(0);
                    278:                default:
1.1.1.4 ! misho     279:                        fprintf(stderr, "%s: %s\n",
1.1       misho     280:                                poptBadOption(pc, POPT_BADOPTION_NOALIAS),
                    281:                                poptStrerror(opt));
                    282:                        tls_usage(1);
                    283:                }
                    284:        }
                    285: 
                    286:        extra_args = poptGetArgs(pc);
                    287:        if (!extra_args || *extra_args == NULL)
                    288:                tls_usage(1);
                    289: 
                    290:        for (; *extra_args; extra_args++)
                    291:                list_file(*extra_args);
                    292:        poptFreeContext(pc);
                    293: 
                    294:        return 0;
                    295: }

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>