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-2020 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. */
55 #ifdef HAVE_LINUX_XATTRS
56 #define XSTAT_ATTR "user.rsync.%stat"
58 #define XSTAT_ATTR "rsync.%stat"
61 static int stat_xattr(const char *fname, STRUCT_STAT *fst)
63 int mode, rdev_major, rdev_minor, uid, gid, len;
66 if (am_root >= 0 || IS_DEVICE(fst->st_mode) || IS_SPECIAL(fst->st_mode))
69 len = sys_lgetxattr(fname, XSTAT_ATTR, buf, sizeof buf - 1);
70 if (len >= (int)sizeof buf) {
75 if (errno == ENOTSUP || errno == ENOATTR)
77 if (errno == EPERM && S_ISLNK(fst->st_mode)) {
82 fprintf(stderr, "failed to read xattr %s for %s: %s\n",
83 XSTAT_ATTR, fname, strerror(errno));
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);
95 #if _S_IFLNK != 0120000
96 if ((mode & (_S_IFMT)) == 0120000)
97 mode = (mode & ~(_S_IFMT)) | _S_IFLNK;
101 fst->st_rdev = MAKEDEV(rdev_major, rdev_minor);
110 static int display_atimes = 0;
112 static void failed(char const *what, char const *where)
114 fprintf(stderr, PROGRAM ": %s %s: %s\n",
115 what, where, strerror(errno));
119 static void storetime(char *dest, size_t destsize, time_t t, int nsecs)
123 struct tm *mt = gmtime(&t);
125 len = snprintf(dest, destsize,
126 " %04d-%02d-%02d %02d:%02d:%02d",
127 (int)mt->tm_year + 1900,
133 if (nsecs >= 0 && len >= 0)
134 snprintf(dest + len, destsize - len, ".%09d", nsecs);
136 int has_nsecs = nsecs >= 0 ? 1 : 0;
137 int len = MIN(20 + 10*has_nsecs, (int)destsize - 1);
138 memset(dest, ' ', len);
143 static void list_file(const char *fname)
146 char permbuf[PERMSTRING_SIZE];
152 if (do_lstat(fname, &buf) < 0)
153 failed("stat", fname);
154 #ifdef SUPPORT_XATTRS
156 stat_xattr(fname, &buf);
159 /* The size of anything but a regular file is probably not
160 * worth thinking about. */
161 if (!S_ISREG(buf.st_mode))
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)) {
169 buf.st_mode &= ~0777;
171 buf.st_mtime = (time_t)0;
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);
178 failed("do_readlink", fname);
180 /* it's not nul-terminated */
186 permstring(permbuf, buf.st_mode);
189 nsecs = (int)buf.ST_MTIME_NSEC;
193 storetime(mtimebuf, sizeof mtimebuf, buf.st_mtime, nsecs);
195 storetime(atimebuf, sizeof atimebuf, S_ISDIR(buf.st_mode) ? 0 : buf.st_atime, -1);
199 /* TODO: Perhaps escape special characters in fname? */
200 printf("%s ", permbuf);
202 if (S_ISCHR(buf.st_mode) || S_ISBLK(buf.st_mode)) {
204 (long)major(buf.st_rdev),
205 (long)minor(buf.st_rdev));
207 printf("%15s", do_big_num(buf.st_size, 1, NULL));
209 printf(" %6ld.%-6ld %6ld%s%s %s%s\n",
210 (long)buf.st_uid, (long)buf.st_gid, (long)buf.st_nlink,
211 mtimebuf, atimebuf, fname, linkbuf);
214 static struct poptOption long_options[] = {
215 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
216 {"atimes", 'U', POPT_ARG_NONE, &display_atimes, 0, 0, 0},
217 {"link-times", 'l', POPT_ARG_NONE, &link_times, 0, 0, 0 },
218 {"link-owner", 'L', POPT_ARG_NONE, &link_owner, 0, 0, 0 },
219 #ifdef SUPPORT_XATTRS
220 {"fake-super", 'f', POPT_ARG_VAL, &am_root, -1, 0, 0 },
223 {"nsec", 's', POPT_ARG_NONE, &nsec_times, 0, 0, 0 },
225 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
229 static void NORETURN tls_usage(int ret)
231 FILE *F = ret ? stderr : stdout;
232 fprintf(F,"usage: " PROGRAM " [OPTIONS] FILE ...\n");
233 fprintf(F,"Trivial file listing program for portably checking rsync\n");
234 fprintf(F,"\nOptions:\n");
235 fprintf(F," -U, --atimes display access (last-used) times\n");
236 fprintf(F," -l, --link-times display the time on a symlink\n");
237 fprintf(F," -L, --link-owner display the owner+group on a symlink\n");
238 #ifdef SUPPORT_XATTRS
239 fprintf(F," -f, --fake-super display attributes including fake-super xattrs\n");
241 fprintf(F," -h, --help show this help\n");
246 main(int argc, char *argv[])
249 const char **extra_args;
252 pc = poptGetContext(PROGRAM, argc, (const char **)argv,
254 while ((opt = poptGetNextOpt(pc)) != -1) {
261 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
267 extra_args = poptGetArgs(pc);
268 if (!extra_args || *extra_args == NULL)
271 for (; *extra_args; extra_args++)
272 list_file(*extra_args);