Use the new safe_fname() function.
[rsync.git] / receiver.c
1 /* -*- c-file-style: "linux" -*-
2
3    Copyright (C) 1996-2000 by Andrew Tridgell
4    Copyright (C) Paul Mackerras 1996
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 2 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with this program; if not, write to the Free Software
18    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 */
20
21 #include "rsync.h"
22
23 extern int verbose;
24 extern int recurse;
25 extern int delete_mode;
26 extern int delete_after;
27 extern int max_delete;
28 extern int csum_length;
29 extern struct stats stats;
30 extern int dry_run;
31 extern int read_batch;
32 extern int batch_gen_fd;
33 extern int am_server;
34 extern int relative_paths;
35 extern int keep_dirlinks;
36 extern int preserve_hard_links;
37 extern int preserve_perms;
38 extern int cvs_exclude;
39 extern int io_error;
40 extern char *tmpdir;
41 extern char *compare_dest;
42 extern int make_backups;
43 extern int do_progress;
44 extern char *backup_dir;
45 extern char *backup_suffix;
46 extern int backup_suffix_len;
47 extern int cleanup_got_literal;
48 extern int module_id;
49 extern int ignore_errors;
50 extern int orig_umask;
51 extern int keep_partial;
52 extern int checksum_seed;
53 extern int inplace;
54
55 extern struct exclude_list_struct server_exclude_list;
56
57
58 static void delete_one(char *fn, int is_dir)
59 {
60         if (!is_dir) {
61                 if (robust_unlink(fn) != 0) {
62                         rsyserr(FERROR, errno, "delete_one: unlink %s failed",
63                                 full_fname(fn));
64                 } else if (verbose)
65                         rprintf(FINFO, "deleting %s\n", safe_fname(fn));
66         } else {
67                 if (do_rmdir(fn) != 0) {
68                         if (errno == ENOTDIR && keep_dirlinks) {
69                                 delete_one(fn, 0);
70                                 return;
71                         }
72                         if (errno != ENOTEMPTY && errno != EEXIST) {
73                                 rsyserr(FERROR, errno,
74                                         "delete_one: rmdir %s failed",
75                                         full_fname(fn));
76                         }
77                 } else if (verbose) {
78                         rprintf(FINFO, "deleting directory %s\n",
79                                 safe_fname(fn));
80                 }
81         }
82 }
83
84
85 static int is_backup_file(char *fn)
86 {
87         int k = strlen(fn) - backup_suffix_len;
88         return k > 0 && strcmp(fn+k, backup_suffix) == 0;
89 }
90
91
92 /* This deletes any files on the receiving side that are not present
93  * on the sending side. */
94 void delete_files(struct file_list *flist)
95 {
96         struct file_list *local_file_list;
97         int i, j;
98         char *argv[1], fbuf[MAXPATHLEN];
99         static int deletion_count;
100
101         if (cvs_exclude)
102                 add_cvs_excludes();
103
104         if (io_error && !(lp_ignore_errors(module_id) || ignore_errors)) {
105                 rprintf(FINFO,"IO error encountered - skipping file deletion\n");
106                 return;
107         }
108
109         for (j = 0; j < flist->count; j++) {
110                 if (!(flist->files[j]->flags & FLAG_TOP_DIR)
111                     || !S_ISDIR(flist->files[j]->mode))
112                         continue;
113
114                 argv[0] = f_name_to(flist->files[j], fbuf);
115
116                 if (!(local_file_list = send_file_list(-1, 1, argv)))
117                         continue;
118
119                 if (verbose > 1)
120                         rprintf(FINFO, "deleting in %s\n", safe_fname(fbuf));
121
122                 for (i = local_file_list->count-1; i >= 0; i--) {
123                         if (max_delete && deletion_count > max_delete)
124                                 break;
125                         if (!local_file_list->files[i]->basename)
126                                 continue;
127                         if (flist_find(flist,local_file_list->files[i]) < 0) {
128                                 char *f = f_name(local_file_list->files[i]);
129                                 if (make_backups && (backup_dir || !is_backup_file(f))) {
130                                         make_backup(f);
131                                         if (verbose) {
132                                                 rprintf(FINFO, "deleting %s\n",
133                                                         safe_fname(f));
134                                         }
135                                 } else {
136                                         int mode = local_file_list->files[i]->mode;
137                                         delete_one(f, S_ISDIR(mode) != 0);
138                                 }
139                                 deletion_count++;
140                         }
141                 }
142                 flist_free(local_file_list);
143         }
144 }
145
146
147 /*
148  * get_tmpname() - create a tmp filename for a given filename
149  *
150  *   If a tmpdir is defined, use that as the directory to
151  *   put it in.  Otherwise, the tmp filename is in the same
152  *   directory as the given name.  Note that there may be no
153  *   directory at all in the given name!
154  *
155  *   The tmp filename is basically the given filename with a
156  *   dot prepended, and .XXXXXX appended (for mkstemp() to
157  *   put its unique gunk in).  Take care to not exceed
158  *   either the MAXPATHLEN or NAME_MAX, esp. the last, as
159  *   the basename basically becomes 8 chars longer. In that
160  *   case, the original name is shortened sufficiently to
161  *   make it all fit.
162  *
163  *   Of course, there's no real reason for the tmp name to
164  *   look like the original, except to satisfy us humans.
165  *   As long as it's unique, rsync will work.
166  */
167
168 static int get_tmpname(char *fnametmp, char *fname)
169 {
170         char *f;
171         int     length = 0;
172         int     maxname;
173
174         if (tmpdir) {
175                 /* Note: this can't overflow, so the return value is safe */
176                 length = strlcpy(fnametmp, tmpdir, MAXPATHLEN - 2);
177                 fnametmp[length++] = '/';
178                 fnametmp[length] = '\0';        /* always NULL terminated */
179         }
180
181         if ((f = strrchr(fname, '/')) != NULL) {
182                 ++f;
183                 if (!tmpdir) {
184                         length = f - fname;
185                         /* copy up to and including the slash */
186                         strlcpy(fnametmp, fname, length + 1);
187                 }
188         } else
189                 f = fname;
190         fnametmp[length++] = '.';
191         fnametmp[length] = '\0';                /* always NULL terminated */
192
193         maxname = MIN(MAXPATHLEN - 7 - length, NAME_MAX - 8);
194
195         if (maxname < 1) {
196                 rprintf(FERROR, "temporary filename too long: %s\n", fname);
197                 fnametmp[0] = '\0';
198                 return 0;
199         }
200
201         strlcpy(fnametmp + length, f, maxname);
202         strcat(fnametmp + length, ".XXXXXX");
203
204         return 1;
205 }
206
207
208 static int receive_data(int f_in, char *fname_r, int fd_r, OFF_T size_r,
209                         char *fname, int fd, OFF_T total_size)
210 {
211         static char file_sum1[MD4_SUM_LENGTH];
212         static char file_sum2[MD4_SUM_LENGTH];
213         struct map_struct *mapbuf;
214         struct sum_struct sum;
215         unsigned int len;
216         OFF_T offset = 0;
217         OFF_T offset2;
218         char *data;
219         int i;
220         char *map = NULL;
221
222         read_sum_head(f_in, &sum);
223
224         if (fd_r >= 0 && size_r > 0) {
225                 mapbuf = map_file(fd_r, size_r, sum.blength);
226                 if (verbose > 2) {
227                         rprintf(FINFO, "recv mapped %s of size %.0f\n",
228                                 safe_fname(fname_r), (double)size_r);
229                 }
230         } else
231                 mapbuf = NULL;
232
233         sum_init(checksum_seed);
234
235         while ((i = recv_token(f_in, &data)) != 0) {
236                 if (do_progress)
237                         show_progress(offset, total_size);
238
239                 if (i > 0) {
240                         if (verbose > 3) {
241                                 rprintf(FINFO,"data recv %d at %.0f\n",
242                                         i,(double)offset);
243                         }
244
245                         stats.literal_data += i;
246                         cleanup_got_literal = 1;
247
248                         sum_update(data,i);
249
250                         if (fd != -1 && write_file(fd,data,i) != i) {
251                                 rsyserr(FERROR, errno, "write failed on %s",
252                                         full_fname(fname));
253                                 exit_cleanup(RERR_FILEIO);
254                         }
255                         offset += i;
256                         continue;
257                 }
258
259                 i = -(i+1);
260                 offset2 = i*(OFF_T)sum.blength;
261                 len = sum.blength;
262                 if (i == (int)sum.count-1 && sum.remainder != 0)
263                         len = sum.remainder;
264
265                 stats.matched_data += len;
266
267                 if (verbose > 3)
268                         rprintf(FINFO,"chunk[%d] of size %d at %.0f offset=%.0f\n",
269                                 i,len,(double)offset2,(double)offset);
270
271                 if (mapbuf) {
272                         map = map_ptr(mapbuf,offset2,len);
273
274                         see_token(map, len);
275                         sum_update(map,len);
276                 }
277
278                 if (!inplace || offset != offset2) {
279                         if (fd != -1 && write_file(fd, map, len) != (int)len) {
280                                 rsyserr(FERROR, errno, "write failed on %s",
281                                         full_fname(fname));
282                                 exit_cleanup(RERR_FILEIO);
283                         }
284                 } else {
285                         flush_write_file(fd);
286                         if (do_lseek(fd,(OFF_T)len,SEEK_CUR) != offset+len) {
287                                 rprintf(FERROR, "lseek failed on %s: %s, %lli, %lli, %i\n",
288                                         full_fname(fname), strerror(errno),
289                                         do_lseek(fd, 0, SEEK_CUR),
290                                         offset + len, i);
291                                 exit_cleanup(RERR_FILEIO);
292                         }
293                 }
294                 offset += len;
295         }
296
297         flush_write_file(fd);
298
299 #ifdef HAVE_FTRUNCATE
300         if (inplace)
301                 ftruncate(fd, offset);
302 #endif
303
304         if (do_progress)
305                 end_progress(total_size);
306
307         if (fd != -1 && offset > 0 && sparse_end(fd) != 0) {
308                 rsyserr(FERROR, errno, "write failed on %s",
309                         full_fname(fname));
310                 exit_cleanup(RERR_FILEIO);
311         }
312
313         sum_end(file_sum1);
314
315         if (mapbuf)
316                 unmap_file(mapbuf);
317
318         read_buf(f_in,file_sum2,MD4_SUM_LENGTH);
319         if (verbose > 2)
320                 rprintf(FINFO,"got file_sum\n");
321         if (fd != -1 && memcmp(file_sum1, file_sum2, MD4_SUM_LENGTH) != 0)
322                 return 0;
323         return 1;
324 }
325
326
327 static void discard_receive_data(int f_in, OFF_T length)
328 {
329         receive_data(f_in, NULL, -1, 0, NULL, -1, length);
330 }
331
332
333 /**
334  * main routine for receiver process.
335  *
336  * Receiver process runs on the same host as the generator process. */
337 int recv_files(int f_in, struct file_list *flist, char *local_name)
338 {
339         int next_gen_i = -1;
340         int fd1,fd2;
341         STRUCT_STAT st;
342         char *fname, fbuf[MAXPATHLEN];
343         char template[MAXPATHLEN];
344         char fnametmp[MAXPATHLEN];
345         char *fnamecmp;
346         char fnamecmpbuf[MAXPATHLEN];
347         struct file_struct *file;
348         struct stats initial_stats;
349         int save_make_backups = make_backups;
350         int i, recv_ok, phase = 0;
351
352         if (verbose > 2)
353                 rprintf(FINFO,"recv_files(%d) starting\n",flist->count);
354
355         if (flist->hlink_pool) {
356                 pool_destroy(flist->hlink_pool);
357                 flist->hlink_pool = NULL;
358         }
359
360         while (1) {
361                 cleanup_disable();
362
363                 i = read_int(f_in);
364                 if (i == -1) {
365                         if (read_batch) {
366                                 if (next_gen_i != flist->count)
367                                         while (read_int(batch_gen_fd) != -1) {}
368                                 next_gen_i = -1;
369                         }
370
371                         if (phase)
372                                 break;
373
374                         phase = 1;
375                         csum_length = SUM_LENGTH;
376                         if (verbose > 2)
377                                 rprintf(FINFO, "recv_files phase=%d\n", phase);
378                         send_msg(MSG_DONE, "", 0);
379                         if (keep_partial)
380                                 make_backups = 0; /* prevents double backup */
381                         continue;
382                 }
383
384                 if (i < 0 || i >= flist->count) {
385                         rprintf(FERROR,"Invalid file index %d in recv_files (count=%d)\n",
386                                 i, flist->count);
387                         exit_cleanup(RERR_PROTOCOL);
388                 }
389
390                 file = flist->files[i];
391
392                 stats.current_file_index = i;
393                 stats.num_transferred_files++;
394                 stats.total_transferred_size += file->length;
395                 cleanup_got_literal = 0;
396
397                 if (local_name)
398                         fname = local_name;
399                 else
400                         fname = f_name_to(file, fbuf);
401
402                 if (dry_run) {
403                         if (!am_server && verbose) /* log the transfer */
404                                 rprintf(FINFO, "%s\n", safe_fname(fname));
405                         continue;
406                 }
407
408                 initial_stats = stats;
409
410                 if (verbose > 2)
411                         rprintf(FINFO, "recv_files(%s)\n", safe_fname(fname));
412
413                 fnamecmp = fname;
414
415                 if (read_batch) {
416                         while (i > next_gen_i) {
417                                 next_gen_i = read_int(batch_gen_fd);
418                                 if (next_gen_i == -1)
419                                         next_gen_i = flist->count;
420                         }
421                         if (i < next_gen_i) {
422                                 rprintf(FINFO, "skipping update for \"%s\"\n",
423                                         safe_fname(fname));
424                                 discard_receive_data(f_in, file->length);
425                                 continue;
426                         }
427                 }
428
429                 if (server_exclude_list.head
430                     && check_exclude(&server_exclude_list, fname,
431                                      S_ISDIR(file->mode)) < 0) {
432                         if (verbose) {
433                                 rprintf(FINFO,
434                                         "skipping server-excluded update for \"%s\"\n",
435                                         safe_fname(fname));
436                         }
437                         discard_receive_data(f_in, file->length);
438                         continue;
439                 }
440
441                 /* open the file */
442                 fd1 = do_open(fnamecmp, O_RDONLY, 0);
443
444                 if (fd1 == -1 && compare_dest != NULL) {
445                         /* try the file at compare_dest instead */
446                         pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
447                                  compare_dest, fname);
448                         fnamecmp = fnamecmpbuf;
449                         fd1 = do_open(fnamecmp, O_RDONLY, 0);
450                 }
451
452                 if (fd1 != -1 && do_fstat(fd1,&st) != 0) {
453                         rsyserr(FERROR, errno, "fstat %s failed",
454                                 full_fname(fnamecmp));
455                         discard_receive_data(f_in, file->length);
456                         close(fd1);
457                         continue;
458                 }
459
460                 if (fd1 != -1 && S_ISDIR(st.st_mode) && fnamecmp == fname) {
461                         /* this special handling for directories
462                          * wouldn't be necessary if robust_rename()
463                          * and the underlying robust_unlink could cope
464                          * with directories
465                          */
466                         rprintf(FERROR,"recv_files: %s is a directory\n",
467                                 full_fname(fnamecmp));
468                         discard_receive_data(f_in, file->length);
469                         close(fd1);
470                         continue;
471                 }
472
473                 if (fd1 != -1 && !S_ISREG(st.st_mode)) {
474                         close(fd1);
475                         fd1 = -1;
476                 }
477
478                 if (fd1 != -1 && !preserve_perms) {
479                         /* if the file exists already and we aren't preserving
480                          * permissions then act as though the remote end sent
481                          * us the file permissions we already have */
482                         file->mode = st.st_mode;
483                 }
484
485                 /* We now check to see if we are writing file "inplace" */
486                 if (inplace)  {
487                         fd2 = do_open(fnamecmp, O_WRONLY|O_CREAT, 0);
488                         if (fd2 == -1) {
489                                 rsyserr(FERROR, errno, "open %s failed",
490                                         full_fname(fnamecmp));
491                                 discard_receive_data(f_in, file->length);
492                                 if (fd1 != -1)
493                                         close(fd1);
494                                 continue;
495                         }
496                 } else {
497                         if (!get_tmpname(fnametmp,fname)) {
498                                 discard_receive_data(f_in, file->length);
499                                 if (fd1 != -1)
500                                         close(fd1);
501                                 continue;
502                         }
503
504                         strlcpy(template, fnametmp, sizeof template);
505
506                         /* we initially set the perms without the
507                          * setuid/setgid bits to ensure that there is no race
508                          * condition. They are then correctly updated after
509                          * the lchown. Thanks to snabb@epipe.fi for pointing
510                          * this out.  We also set it initially without group
511                          * access because of a similar race condition. */
512                         fd2 = do_mkstemp(fnametmp, file->mode & INITACCESSPERMS);
513
514                         /* in most cases parent directories will already exist
515                          * because their information should have been previously
516                          * transferred, but that may not be the case with -R */
517                         if (fd2 == -1 && relative_paths && errno == ENOENT
518                             && create_directory_path(fnametmp, orig_umask) == 0) {
519                                 strlcpy(fnametmp, template, sizeof fnametmp);
520                                 fd2 = do_mkstemp(fnametmp, file->mode & INITACCESSPERMS);
521                         }
522                         if (fd2 == -1) {
523                                 rsyserr(FERROR, errno, "mkstemp %s failed",
524                                         full_fname(fnametmp));
525                                 discard_receive_data(f_in, file->length);
526                                 if (fd1 != -1)
527                                         close(fd1);
528                                 continue;
529                         }
530
531                         cleanup_set(fnametmp, fname, file, fd1, fd2);
532                 }
533
534                 if (!am_server && verbose) /* log the transfer */
535                         rprintf(FINFO, "%s\n", safe_fname(fname));
536
537                 /* recv file data */
538                 recv_ok = receive_data(f_in, fnamecmp, fd1, st.st_size,
539                                        fname, fd2, file->length);
540
541                 log_recv(file, &initial_stats);
542
543                 if (fd1 != -1)
544                         close(fd1);
545                 if (close(fd2) < 0) {
546                         rsyserr(FERROR, errno, "close failed on %s",
547                                 full_fname(fnametmp));
548                         exit_cleanup(RERR_FILEIO);
549                 }
550
551                 if (recv_ok || keep_partial || inplace)
552                         finish_transfer(fname, fnametmp, file, recv_ok);
553                 else
554                         do_unlink(fnametmp);
555
556                 cleanup_disable();
557
558                 if (!recv_ok) {
559                         int msgtype = csum_length == SUM_LENGTH || read_batch ?
560                                 FERROR : FINFO;
561                         if (msgtype == FERROR || verbose) {
562                                 char *errstr, *redostr;
563                                 char *keptstr = keep_partial || inplace ?
564                                         "retain" : "discard";
565                                 if (msgtype == FERROR) {
566                                         errstr = "ERROR";
567                                         redostr = "";
568                                 } else {
569                                         errstr = "WARNING";
570                                         redostr = " (will try again)";
571                                 }
572                                 rprintf(msgtype,
573                                         "%s: %s failed verification -- update %sed%s.\n",
574                                         errstr, safe_fname(fname),
575                                         keptstr, redostr);
576                         }
577                         if (csum_length != SUM_LENGTH) {
578                                 char buf[4];
579                                 SIVAL(buf, 0, i);
580                                 send_msg(MSG_REDO, buf, 4);
581                         }
582                 }
583         }
584         make_backups = save_make_backups;
585
586         if (delete_after && recurse && !local_name && flist->count > 0)
587                 delete_files(flist);
588
589         if (verbose > 2)
590                 rprintf(FINFO,"recv_files finished\n");
591
592         return 0;
593 }