2 * Trivial ls for comparing two directories after running an rsync.
4 * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
5 * Copyright (C) 2003-2019 Wayne Davison
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.
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.
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.
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.
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".
31 * The format is not exactly the same as any particular Unix ls(1).
33 * A key requirement for this program is that the output be "very
34 * reproducible." So we mask away information that can accidentally
39 #include "lib/sysxattrs.h"
43 /* These are to make syscall.o shut up. */
52 int preserve_perms = 0;
53 int preserve_executability = 0;
54 int preallocate_files = 0;
59 #ifdef HAVE_LINUX_XATTRS
60 #define XSTAT_ATTR "user.rsync.%stat"
62 #define XSTAT_ATTR "rsync.%stat"
65 static int stat_xattr(const char *fname, STRUCT_STAT *fst)
67 int mode, rdev_major, rdev_minor, uid, gid, len;
70 if (am_root >= 0 || IS_DEVICE(fst->st_mode) || IS_SPECIAL(fst->st_mode))
73 len = sys_lgetxattr(fname, XSTAT_ATTR, buf, sizeof buf - 1);
74 if (len >= (int)sizeof buf) {
79 if (errno == ENOTSUP || errno == ENOATTR)
81 if (errno == EPERM && S_ISLNK(fst->st_mode)) {
86 fprintf(stderr, "failed to read xattr %s for %s: %s\n",
87 XSTAT_ATTR, fname, strerror(errno));
92 if (sscanf(buf, "%o %d,%d %d:%d",
93 &mode, &rdev_major, &rdev_minor, &uid, &gid) != 5) {
94 fprintf(stderr, "Corrupt %s xattr attached to %s: \"%s\"\n",
95 XSTAT_ATTR, fname, buf);
99 #if _S_IFLNK != 0120000
100 if ((mode & (_S_IFMT)) == 0120000)
101 mode = (mode & ~(_S_IFMT)) | _S_IFLNK;
105 fst->st_rdev = MAKEDEV(rdev_major, rdev_minor);
114 static void failed(char const *what, char const *where)
116 fprintf(stderr, PROGRAM ": %s %s: %s\n",
117 what, where, strerror(errno));
121 static void list_file(const char *fname)
124 char permbuf[PERMSTRING_SIZE];
129 if (do_lstat(fname, &buf) < 0)
130 failed("stat", fname);
131 #ifdef SUPPORT_XATTRS
133 stat_xattr(fname, &buf);
136 /* The size of anything but a regular file is probably not
137 * worth thinking about. */
138 if (!S_ISREG(buf.st_mode))
141 /* On some BSD platforms the mode bits of a symlink are
142 * undefined. Also it tends not to be possible to reset a
143 * symlink's mtime, so we default to ignoring it too. */
144 if (S_ISLNK(buf.st_mode)) {
146 buf.st_mode &= ~0777;
148 buf.st_mtime = (time_t)0;
150 buf.st_uid = buf.st_gid = 0;
151 strlcpy(linkbuf, " -> ", sizeof linkbuf);
152 /* const-cast required for silly UNICOS headers */
153 len = do_readlink((char *) fname, linkbuf+4, sizeof(linkbuf) - 4);
155 failed("do_readlink", fname);
157 /* it's not nul-terminated */
163 permstring(permbuf, buf.st_mode);
167 mt = gmtime(&buf.st_mtime);
169 len = snprintf(datebuf, sizeof datebuf,
170 "%04d-%02d-%02d %02d:%02d:%02d",
171 (int)mt->tm_year + 1900,
179 snprintf(datebuf + len, sizeof datebuf - len,
180 ".%09d", (int)buf.ST_MTIME_NSEC);
184 int len = MIN(19 + 9*nsec_times, (int)sizeof datebuf - 1);
185 memset(datebuf, ' ', len);
189 /* TODO: Perhaps escape special characters in fname? */
191 printf("%s ", permbuf);
192 if (S_ISCHR(buf.st_mode) || S_ISBLK(buf.st_mode)) {
194 (long)major(buf.st_rdev),
195 (long)minor(buf.st_rdev));
197 printf("%15s", do_big_num(buf.st_size, 1, NULL));
198 printf(" %6ld.%-6ld %6ld %s %s%s\n",
199 (long)buf.st_uid, (long)buf.st_gid, (long)buf.st_nlink,
200 datebuf, fname, linkbuf);
203 static struct poptOption long_options[] = {
204 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
205 {"link-times", 'l', POPT_ARG_NONE, &link_times, 0, 0, 0 },
206 {"link-owner", 'L', POPT_ARG_NONE, &link_owner, 0, 0, 0 },
207 #ifdef SUPPORT_XATTRS
208 {"fake-super", 'f', POPT_ARG_VAL, &am_root, -1, 0, 0 },
211 {"nsec", 's', POPT_ARG_NONE, &nsec_times, 0, 0, 0 },
213 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
217 static void NORETURN tls_usage(int ret)
219 FILE *F = ret ? stderr : stdout;
220 fprintf(F,"usage: " PROGRAM " [OPTIONS] FILE ...\n");
221 fprintf(F,"Trivial file listing program for portably checking rsync\n");
222 fprintf(F,"\nOptions:\n");
223 fprintf(F," -l, --link-times display the time on a symlink\n");
224 fprintf(F," -L, --link-owner display the owner+group on a symlink\n");
225 #ifdef SUPPORT_XATTRS
226 fprintf(F," -f, --fake-super display attributes including fake-super xattrs\n");
228 fprintf(F," -h, --help show this help\n");
233 main(int argc, char *argv[])
236 const char **extra_args;
239 pc = poptGetContext(PROGRAM, argc, (const char **)argv,
241 while ((opt = poptGetNextOpt(pc)) != -1) {
248 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
254 extra_args = poptGetArgs(pc);
255 if (!extra_args || *extra_args == NULL)
258 for (; *extra_args; extra_args++)
259 list_file(*extra_args);