Undo last setting of blocking_io. I hadn't reviewed the code well enough;
[rsync.git] / log.c
1 /* 
2    Copyright (C) Andrew Tridgell 1998
3    
4    This program is free software; you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation; either version 2 of the License, or
7    (at your option) any later version.
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   logging and utility functions
21
22   tridge, May 1998
23   */
24 #include "rsync.h"
25
26 static FILE *logfile;
27 static int log_error_fd = -1;
28
29 static void logit(int priority, char *buf)
30 {
31         if (logfile) {
32                 fprintf(logfile,"%s [%d] %s", 
33                         timestring(time(NULL)), (int)getpid(), buf);
34                 fflush(logfile);
35         } else {
36                 syslog(priority, "%s", buf);
37         }
38 }
39
40 void log_open(void)
41 {
42         static int initialised;
43         int options = LOG_PID;
44         time_t t;
45         char *logf;
46
47         if (initialised) return;
48         initialised = 1;
49
50         /* this looks pointless, but it is needed in order for the
51            C library on some systems to fetch the timezone info
52            before the chroot */
53         t = time(NULL);
54         localtime(&t);
55
56         /* optionally use a log file instead of syslog */
57         logf = lp_log_file();
58         if (logf && *logf) {
59                 extern int orig_umask;
60                 int old_umask = umask(022 | orig_umask);
61                 logfile = fopen(logf, "a");
62                 umask(old_umask);
63                 return;
64         }
65
66 #ifdef LOG_NDELAY
67         options |= LOG_NDELAY;
68 #endif
69
70 #ifdef LOG_DAEMON
71         openlog("rsyncd", options, lp_syslog_facility());
72 #else
73         openlog("rsyncd", options);
74 #endif
75
76 #ifndef LOG_NDELAY
77         logit(LOG_INFO,"rsyncd started\n");
78 #endif
79 }
80
81 /* setup the error file descriptor - used when we are a server
82    that is receiving files */
83 void set_error_fd(int fd)
84 {
85         log_error_fd = fd;
86 }
87
88 /* this is the underlying (unformatted) rsync debugging function. Call
89    it with FINFO, FERROR or FLOG */
90 void rwrite(enum logcode code, char *buf, int len)
91 {
92         FILE *f=NULL;
93         extern int am_daemon;
94         extern int am_server;
95         extern int quiet;
96         /* recursion can happen with certain fatal conditions */
97
98         if (quiet && code == FINFO) return;
99
100         if (len < 0) exit_cleanup(RERR_MESSAGEIO);
101
102         buf[len] = 0;
103
104         if (code == FLOG) {
105                 if (am_daemon) logit(LOG_INFO, buf);
106                 return;
107         }
108
109         /* first try to pass it off the our sibling */
110         if (am_server && io_error_write(log_error_fd, code, buf, len)) {
111                 return;
112         }
113
114         /* then try to pass it to the other end */
115         if (am_server && io_multiplex_write(code, buf, len)) {
116                 return;
117         }
118
119         if (am_daemon) {
120                 static int depth;
121                 int priority = LOG_INFO;
122                 if (code == FERROR) priority = LOG_WARNING;
123
124                 if (depth) return;
125
126                 depth++;
127
128                 log_open();
129                 logit(priority, buf);
130
131                 depth--;
132                 return;
133         }
134
135         if (code == FERROR) {
136                 f = stderr;
137         } 
138
139         if (code == FINFO) {
140                 if (am_server) 
141                         f = stderr;
142                 else
143                         f = stdout;
144         } 
145
146         if (!f) exit_cleanup(RERR_MESSAGEIO);
147
148         if (fwrite(buf, len, 1, f) != 1) exit_cleanup(RERR_MESSAGEIO);
149
150         if (buf[len-1] == '\r' || buf[len-1] == '\n') fflush(f);
151 }
152                 
153
154 /* this is the rsync debugging function. Call it with FINFO, FERROR or FLOG */
155  void rprintf(enum logcode code, const char *format, ...)
156 {
157         va_list ap;  
158         char buf[1024];
159         int len;
160
161         va_start(ap, format);
162         len = vslprintf(buf, sizeof(buf), format, ap);
163         va_end(ap);
164
165         if (len > sizeof(buf)-1) exit_cleanup(RERR_MESSAGEIO);
166
167         rwrite(code, buf, len);
168 }
169
170 void rflush(enum logcode code)
171 {
172         FILE *f = NULL;
173         extern int am_daemon;
174         
175         if (am_daemon) {
176                 return;
177         }
178
179         if (code == FLOG) {
180                 return;
181         } 
182
183         if (code == FERROR) {
184                 f = stderr;
185         } 
186
187         if (code == FINFO) {
188                 extern int am_server;
189                 if (am_server) 
190                         f = stderr;
191                 else
192                         f = stdout;
193         } 
194
195         if (!f) exit_cleanup(RERR_MESSAGEIO);
196         fflush(f);
197 }
198
199
200
201 /* a generic logging routine for send/recv, with parameter
202    substitiution */
203 static void log_formatted(enum logcode code,
204                           char *format, char *op, struct file_struct *file,
205                           struct stats *initial_stats)
206 {
207         extern int module_id;
208         extern char *auth_user;
209         char buf[1024];
210         char buf2[1024];
211         char *p, *s, *n;
212         int l;
213         extern struct stats stats;              
214         extern int am_sender;
215         extern int am_daemon;
216         int64 b;
217
218         strlcpy(buf, format, sizeof(buf));
219         
220         for (s=&buf[0]; 
221              s && (p=strchr(s,'%')); ) {
222                 n = NULL;
223                 s = p + 1;
224
225                 switch (p[1]) {
226                 case 'h': if (am_daemon) n = client_name(0); break;
227                 case 'a': if (am_daemon) n = client_addr(0); break;
228                 case 'l': 
229                         slprintf(buf2,sizeof(buf2),"%.0f", 
230                                  (double)file->length); 
231                         n = buf2;
232                         break;
233                 case 'p': 
234                         slprintf(buf2,sizeof(buf2),"%d", 
235                                  (int)getpid()); 
236                         n = buf2;
237                         break;
238                 case 'o': n = op; break;
239                 case 'f': 
240                         slprintf(buf2, sizeof(buf2), "%s/%s", 
241                                  file->basedir?file->basedir:"", 
242                                  f_name(file));
243                         clean_fname(buf2);
244                         n = buf2; 
245                         if (*n == '/') n++;
246                         break;
247                 case 'm': n = lp_name(module_id); break;
248                 case 't': n = timestring(time(NULL)); break;
249                 case 'P': n = lp_path(module_id); break;
250                 case 'u': n = auth_user; break;
251                 case 'b': 
252                         if (am_sender) {
253                                 b = stats.total_written - 
254                                         initial_stats->total_written;
255                         } else {
256                                 b = stats.total_read - 
257                                         initial_stats->total_read;
258                         }
259                         slprintf(buf2,sizeof(buf2),"%.0f", (double)b); 
260                         n = buf2;
261                         break;
262                 case 'c': 
263                         if (!am_sender) {
264                                 b = stats.total_written - 
265                                         initial_stats->total_written;
266                         } else {
267                                 b = stats.total_read - 
268                                         initial_stats->total_read;
269                         }
270                         slprintf(buf2,sizeof(buf2),"%.0f", (double)b); 
271                         n = buf2;
272                         break;
273                 }
274
275                 if (!n) continue;
276
277                 l = strlen(n);
278
279                 if ((l-1) + ((int)(s - &buf[0])) > sizeof(buf)) {
280                         rprintf(FERROR,"buffer overflow expanding %%%c - exiting\n",
281                                 p[0]);
282                         exit_cleanup(RERR_MESSAGEIO);
283                 }
284
285                 if (l != 2) {
286                         memmove(s+(l-1), s+1, strlen(s+1)+1);
287                 }
288                 memcpy(p, n, l);
289
290                 s = p+l;
291         }
292
293         rprintf(code,"%s\n", buf);
294 }
295
296 /* log the outgoing transfer of a file */
297 void log_send(struct file_struct *file, struct stats *initial_stats)
298 {
299         extern int module_id;
300         extern int am_server;
301         extern char *log_format;
302
303         if (lp_transfer_logging(module_id)) {
304                 log_formatted(FLOG, lp_log_format(module_id), "send", file, initial_stats);
305         } else if (log_format && !am_server) {
306                 log_formatted(FINFO, log_format, "send", file, initial_stats);
307         }
308 }
309
310 /* log the incoming transfer of a file */
311 void log_recv(struct file_struct *file, struct stats *initial_stats)
312 {
313         extern int module_id;
314         extern int am_server;
315         extern char *log_format;
316
317         if (lp_transfer_logging(module_id)) {
318                 log_formatted(FLOG, lp_log_format(module_id), "recv", file, initial_stats);
319         } else if (log_format && !am_server) {
320                 log_formatted(FINFO, log_format, "recv", file, initial_stats);
321         }
322 }
323
324 /* called when the transfer is interrupted for some reason */
325 void log_exit(int code, const char *file, int line)
326 {
327         if (code == 0) {
328                 extern struct stats stats;              
329                 rprintf(FLOG,"wrote %.0f bytes  read %.0f bytes  total size %.0f\n",
330                         (double)stats.total_written,
331                         (double)stats.total_read,
332                         (double)stats.total_size);
333         } else {
334                 rprintf(FLOG,"transfer interrupted (code %d) at %s(%d)\n", 
335                         code, file, line);
336         }
337 }
338
339 /* log the incoming transfer of a file for interactive use, this
340    will be called at the end where the client was run 
341    
342    it i called when a file starts to be transferred
343 */
344 void log_transfer(struct file_struct *file, const char *fname)
345 {
346         extern int verbose;
347
348         if (!verbose) return;
349
350         rprintf(FINFO,"%s\n", fname);
351 }
352