Clean up comments for Doxygen.
[rsync.git] / tls.c
1 /* -*- c-file-style: "linux" -*-
2  *
3  * Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
4  * 
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License version
7  * 2 as published by the Free Software Foundation.
8  * 
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  * 
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 /**
20  * @file tls.c
21  *
22  * Trivial @c ls for comparing two directories after running an rsync.
23  *
24  * The problem with using the system's own ls is that some features
25  * have little quirks that make directories look different when for
26  * our purposes they're the same -- for example, the BSD braindamage
27  * about setting the mode on symlinks based on your current umask.
28  *
29  * All the filenames must be given on the command line -- tls does not
30  * even read directories, let alone recurse.  The typical usage is
31  * "find|sort|xargs tls".
32  *
33  * The format is not exactly the same as any particular Unix ls(1).
34  *
35  * A key requirement for this program is that the output be "very
36  * reproducible."  So we mask away information that can accidentally
37  * change.
38  **/
39
40
41 #include "rsync.h"
42
43 #define PROGRAM "tls"
44
45 /* These are to make syscall.o shut up. */
46 int dry_run = 0;
47 int read_only = 1;
48 int list_only = 0;
49
50
51 static void failed (char const *what,
52                     char const *where)
53 {
54         fprintf (stderr, PROGRAM ": %s %s: %s\n",
55                  what, where, strerror (errno));
56         exit (1);
57 }
58
59
60
61 static void list_file (const char *fname)
62 {
63         STRUCT_STAT buf;
64         char permbuf[PERMSTRING_SIZE];
65         struct tm *mt;
66         char datebuf[50];
67         char linkbuf[4096];
68
69         if (do_lstat(fname, &buf) == -1)
70                 failed ("stat", fname);
71
72         /* The size of anything but a regular file is probably not
73          * worth thinking about. */
74         if (!S_ISREG(buf.st_mode))
75                 buf.st_size = 0;
76
77         /* On some BSD platforms the mode bits of a symlink are
78          * undefined.  Also it tends not to be possible to reset a
79          * symlink's mtime, so we have to ignore it too. */
80         if (S_ISLNK(buf.st_mode)) {
81                 int len;
82                 buf.st_mode &= ~0777;
83                 buf.st_mtime = (time_t)0;
84                 buf.st_uid = buf.st_gid = 0;
85                 strcpy(linkbuf, " -> ");
86                 /* const-cast required for silly UNICOS headers */
87                 len = readlink((char *) fname, linkbuf+4, sizeof(linkbuf) - 4);
88                 if (len == -1) 
89                         failed("readlink", fname);
90                 else
91                         /* it's not nul-terminated */
92                         linkbuf[4+len] = 0;
93         } else {
94                 linkbuf[0] = 0;
95         }
96
97         permstring(permbuf, buf.st_mode);
98
99         if (buf.st_mtime) {
100                 mt = gmtime(&buf.st_mtime);
101                 
102                 sprintf(datebuf, "%04d-%02d-%02d %02d:%02d:%02d",
103                         mt->tm_year + 1900,
104                         mt->tm_mon + 1,
105                         mt->tm_mday,
106                         mt->tm_hour,
107                         mt->tm_min,
108                         mt->tm_sec);
109         } else {
110                 strcpy(datebuf, "                   ");
111         }
112         
113         /* TODO: Perhaps escape special characters in fname? */
114         
115         
116         /* NB: need to pass size as a double because it might be be
117          * too large for a long. */
118         printf("%s %12.0f %6d.%-6d %6d %s %s%s\n",
119                permbuf, (double) buf.st_size,
120                buf.st_uid, buf.st_gid,
121                buf.st_nlink,
122                datebuf, fname, linkbuf);
123 }
124
125
126 int main (int argc, char *argv[])
127 {
128         if (argc < 2) {
129                 fprintf (stderr, "usage: " PROGRAM " DIR ...\n"
130                          "Trivial file listing program for portably checking rsync\n");
131                 return 1;
132         }
133
134         for (argv++; *argv; argv++) {
135                 list_file (*argv);
136         }
137
138         return 0;
139 }