rsync.c

   1 /*
   2  * Routines common to more than one of the rsync processes.
   3  *
   4  * Copyright (C) 1996 Andrew Tridgell
   5  * Copyright (C) 1996 Paul Mackerras
   6  * Copyright (C) 2003-2007 Wayne Davison
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 3 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, visit the http://fsf.org website.
  20  */
  21
  22 #include "rsync.h"
  23 #if defined HAVE_LIBCHARSET_H && defined HAVE_LOCALE_CHARSET
  24 #include <libcharset.h>
  25 #elif defined HAVE_LANGINFO_H && defined HAVE_NL_LANGINFO
  26 #include <langinfo.h>
  27 #endif
  28
  29 extern int verbose;
  30 extern int dry_run;
  31 extern int preserve_acls;
  32 extern int preserve_xattrs;
  33 extern int preserve_perms;
  34 extern int preserve_executability;
  35 extern int preserve_times;
  36 extern int am_root;
  37 extern int am_server;
  38 extern int am_sender;
  39 extern int am_generator;
  40 extern int am_starting_up;
  41 extern int allow_8bit_chars;
  42 extern int protocol_version;
  43 extern int uid_ndx;
  44 extern int gid_ndx;
  45 extern int inc_recurse;
  46 extern int inplace;
  47 extern int flist_eof;
  48 extern int keep_dirlinks;
  49 extern int make_backups;
  50 extern struct file_list *cur_flist, *first_flist, *dir_flist;
  51 extern struct chmod_mode_struct *daemon_chmod_modes;
  52 #ifdef ICONV_OPTION
  53 extern char *iconv_opt;
  54 #endif
  55
  56 #ifdef ICONV_CONST
  57 iconv_t ic_chck = (iconv_t)-1;
  58 #ifdef ICONV_OPTION
  59 iconv_t ic_send = (iconv_t)-1, ic_recv = (iconv_t)-1;
  60 int ic_ndx;
  61 #endif
  62
  63 static const char *default_charset(void)
  64 {
  65 #if defined HAVE_LIBCHARSET_H && defined HAVE_LOCALE_CHARSET
  66         return locale_charset();
  67 #elif defined HAVE_LANGINFO_H && defined HAVE_NL_LANGINFO
  68         return nl_langinfo(CODESET);
  69 #else
  70         return ""; /* Works with (at the very least) gnu iconv... */
  71 #endif
  72 }
  73
  74 void setup_iconv()
  75 {
  76         const char *defset = default_charset();
  77 # ifdef ICONV_OPTION
  78         const char *charset;
  79         char *cp;
  80 #endif
  81
  82         if (!am_server && !allow_8bit_chars) {
  83
  84                 /* It's OK if this fails... */
  85                 ic_chck = iconv_open(defset, defset);
  86
  87                 if (verbose > 3) {
  88                         if (ic_chck == (iconv_t)-1) {
  89                                 rprintf(FINFO,
  90                                         "note: iconv_open(\"%s\", \"%s\") failed (%d)"
  91                                         " -- using isprint() instead of iconv().\n",
  92                                         defset, defset, errno);
  93                         } else {
  94                                 rprintf(FINFO,
  95                                         "note: iconv_open(\"%s\", \"%s\") succeeded.\n",
  96                                         defset, defset);
  97                         }
  98                 }
  99         }
 100
 101 # ifdef ICONV_OPTION
 102         if (!iconv_opt)
 103                 return;
 104
 105         if ((cp = strchr(iconv_opt, ',')) != NULL) {
 106                 if (am_server) /* A local transfer needs this. */
 107                         iconv_opt = cp + 1;
 108                 else
 109                         *cp = '\0';
 110         }
 111
 112         if (!*iconv_opt || (*iconv_opt == '.' && iconv_opt[1] == '\0'))
 113                 charset = defset;
 114         else
 115                 charset = iconv_opt;
 116
 117         if ((ic_send = iconv_open(UTF8_CHARSET, charset)) == (iconv_t)-1) {
 118                 rprintf(FERROR, "iconv_open(\"%s\", \"%s\") failed\n",
 119                         UTF8_CHARSET, charset);
 120                 exit_cleanup(RERR_UNSUPPORTED);
 121         }
 122
 123         if ((ic_recv = iconv_open(charset, UTF8_CHARSET)) == (iconv_t)-1) {
 124                 rprintf(FERROR, "iconv_open(\"%s\", \"%s\") failed\n",
 125                         charset, UTF8_CHARSET);
 126                 exit_cleanup(RERR_UNSUPPORTED);
 127         }
 128
 129         if (!am_sender || inc_recurse)
 130                 ic_ndx = ++file_extra_cnt;
 131
 132         if (verbose > 1) {
 133                 rprintf(FINFO, "%s charset: %s\n",
 134                         am_server ? "server" : "client",
 135                         *charset ? charset : "[LOCALE]");
 136         }
 137 # endif
 138 }
 139 #endif
 140
 141 int read_ndx_and_attrs(int f_in, int *iflag_ptr, uchar *type_ptr,
 142                        char *buf, int *len_ptr)
 143 {
 144         int len, iflags = 0;
 145         struct file_list *flist;
 146         uchar fnamecmp_type = FNAMECMP_FNAME;
 147         int ndx;
 148
 149   read_loop:
 150         while (1) {
 151                 ndx = read_ndx(f_in);
 152
 153                 if (ndx >= 0)
 154                         break;
 155                 if (ndx == NDX_DONE)
 156                         return ndx;
 157                 if (!inc_recurse || am_sender)
 158                         goto invalid_ndx;
 159                 if (ndx == NDX_FLIST_EOF) {
 160                         flist_eof = 1;
 161                         send_msg(MSG_FLIST_EOF, "", 0, 0);
 162                         continue;
 163                 }
 164                 ndx = NDX_FLIST_OFFSET - ndx;
 165                 if (ndx < 0 || ndx >= dir_flist->used) {
 166                         ndx = NDX_FLIST_OFFSET - ndx;
 167                         rprintf(FERROR,
 168                                 "[%s] Invalid dir index: %d (%d - %d)\n",
 169                                 who_am_i(), ndx, NDX_FLIST_OFFSET,
 170                                 NDX_FLIST_OFFSET - dir_flist->used + 1);
 171                         exit_cleanup(RERR_PROTOCOL);
 172                 }
 173
 174                 /* Send everything read from f_in to msg_fd_out. */
 175                 send_msg_int(MSG_FLIST, ndx);
 176                 start_flist_forward(f_in);
 177                 if (verbose > 3) {
 178                         rprintf(FINFO, "[%s] receiving flist for dir %d\n",
 179                                 who_am_i(), ndx);
 180                 }
 181                 flist = recv_file_list(f_in);
 182                 flist->parent_ndx = ndx;
 183                 stop_flist_forward();
 184         }
 185
 186         iflags = protocol_version >= 29 ? read_shortint(f_in)
 187                    : ITEM_TRANSFER | ITEM_MISSING_DATA;
 188
 189         /* Honor the old-style keep-alive indicator. */
 190         if (protocol_version < 30
 191          && ndx == cur_flist->used && iflags == ITEM_IS_NEW) {
 192                 if (am_sender)
 193                         maybe_send_keepalive();
 194                 goto read_loop;
 195         }
 196
 197         if (!(flist = flist_for_ndx(ndx))) {
 198           invalid_ndx:
 199                 rprintf(FERROR,
 200                         "Invalid file index: %d (%d - %d) with iflags %x [%s]\n",
 201                         ndx, first_flist->ndx_start - 1, first_flist->prev->ndx_end,
 202                         iflags, who_am_i());
 203                 exit_cleanup(RERR_PROTOCOL);
 204         }
 205         cur_flist = flist;
 206
 207         if (iflags & ITEM_BASIS_TYPE_FOLLOWS)
 208                 fnamecmp_type = read_byte(f_in);
 209         *type_ptr = fnamecmp_type;
 210
 211         if (iflags & ITEM_XNAME_FOLLOWS) {
 212                 if ((len = read_vstring(f_in, buf, MAXPATHLEN)) < 0)
 213                         exit_cleanup(RERR_PROTOCOL);
 214         } else {
 215                 *buf = '\0';
 216                 len = -1;
 217         }
 218         *len_ptr = len;
 219
 220         if (iflags & ITEM_TRANSFER) {
 221                 int i = ndx - cur_flist->ndx_start;
 222                 if (i < 0 || !S_ISREG(cur_flist->files[i]->mode)) {
 223                         rprintf(FERROR,
 224                                 "received request to transfer non-regular file: %d [%s]\n",
 225                                 ndx, who_am_i());
 226                         exit_cleanup(RERR_PROTOCOL);
 227                 }
 228         }
 229
 230         *iflag_ptr = iflags;
 231         return ndx;
 232 }
 233
 234 /*
 235   free a sums struct
 236   */
 237 void free_sums(struct sum_struct *s)
 238 {
 239         if (s->sums) free(s->sums);
 240         free(s);
 241 }
 242
 243 /* This is only called when we aren't preserving permissions.  Figure out what
 244  * the permissions should be and return them merged back into the mode. */
 245 mode_t dest_mode(mode_t flist_mode, mode_t stat_mode, int dflt_perms,
 246                  int exists)
 247 {
 248         int new_mode;
 249         /* If the file already exists, we'll return the local permissions,
 250          * possibly tweaked by the --executability option. */
 251         if (exists) {
 252                 new_mode = (flist_mode & ~CHMOD_BITS) | (stat_mode & CHMOD_BITS);
 253                 if (preserve_executability && S_ISREG(flist_mode)) {
 254                         /* If the source file is executable, grant execute
 255                          * rights to everyone who can read, but ONLY if the
 256                          * file isn't already executable. */
 257                         if (!(flist_mode & 0111))
 258                                 new_mode &= ~0111;
 259                         else if (!(stat_mode & 0111))
 260                                 new_mode |= (new_mode & 0444) >> 2;
 261                 }
 262         } else {
 263                 /* Apply destination default permissions and turn
 264                  * off special permissions. */
 265                 new_mode = flist_mode & (~CHMOD_BITS | dflt_perms);
 266         }
 267         return new_mode;
 268 }
 269
 270 int set_file_attrs(const char *fname, struct file_struct *file, statx *sxp,
 271                    const char *fnamecmp, int flags)
 272 {
 273         int updated = 0;
 274         statx sx2;
 275         int change_uid, change_gid;
 276         mode_t new_mode = file->mode;
 277
 278         if (!sxp) {
 279                 if (dry_run)
 280                         return 1;
 281                 if (link_stat(fname, &sx2.st, 0) < 0) {
 282                         rsyserr(FERROR, errno, "stat %s failed",
 283                                 full_fname(fname));
 284                         return 0;
 285                 }
 286 #ifdef SUPPORT_ACLS
 287                 sx2.acc_acl = sx2.def_acl = NULL;
 288 #endif
 289 #ifdef SUPPORT_XATTRS
 290                 sx2.xattr = NULL;
 291 #endif
 292                 if (!preserve_perms && S_ISDIR(new_mode)
 293                  && sx2.st.st_mode & S_ISGID) {
 294                         /* We just created this directory and its setgid
 295                          * bit is on, so make sure it stays on. */
 296                         new_mode |= S_ISGID;
 297                 }
 298                 sxp = &sx2;
 299         }
 300
 301 #ifdef SUPPORT_ACLS
 302         if (preserve_acls && !S_ISLNK(file->mode) && !ACL_READY(*sxp))
 303                 get_acl(fname, sxp);
 304 #endif
 305
 306 #ifdef SUPPORT_XATTRS
 307         if (preserve_xattrs && fnamecmp)
 308                 set_xattr(fname, file, fnamecmp, sxp);
 309         if (am_root < 0)
 310                 set_stat_xattr(fname, file);
 311 #endif
 312
 313         if (!preserve_times || (S_ISDIR(sxp->st.st_mode) && preserve_times == 1))
 314                 flags |= ATTRS_SKIP_MTIME;
 315         if (!(flags & ATTRS_SKIP_MTIME)
 316             && cmp_time(sxp->st.st_mtime, file->modtime) != 0) {
 317                 int ret = set_modtime(fname, file->modtime, sxp->st.st_mode);
 318                 if (ret < 0) {
 319                         rsyserr(FERROR, errno, "failed to set times on %s",
 320                                 full_fname(fname));
 321                         goto cleanup;
 322                 }
 323                 if (ret == 0) /* ret == 1 if symlink could not be set */
 324                         updated = 1;
 325         }
 326
 327         change_uid = am_root && uid_ndx && sxp->st.st_uid != (uid_t)F_OWNER(file);
 328         change_gid = gid_ndx && !(file->flags & FLAG_SKIP_GROUP)
 329                   && sxp->st.st_gid != (gid_t)F_GROUP(file);
 330 #if !defined HAVE_LCHOWN && !defined CHOWN_MODIFIES_SYMLINK
 331         if (S_ISLNK(sxp->st.st_mode))
 332                 ;
 333         else
 334 #endif
 335         if (change_uid || change_gid) {
 336                 if (verbose > 2) {
 337                         if (change_uid) {
 338                                 rprintf(FINFO,
 339                                         "set uid of %s from %u to %u\n",
 340                                         fname, (unsigned)sxp->st.st_uid, F_OWNER(file));
 341                         }
 342                         if (change_gid) {
 343                                 rprintf(FINFO,
 344                                         "set gid of %s from %u to %u\n",
 345                                         fname, (unsigned)sxp->st.st_gid, F_GROUP(file));
 346                         }
 347                 }
 348                 if (am_root < 0) {
 349                         ;
 350                 } else if (do_lchown(fname,
 351                     change_uid ? (uid_t)F_OWNER(file) : sxp->st.st_uid,
 352                     change_gid ? (gid_t)F_GROUP(file) : sxp->st.st_gid) != 0) {
 353                         /* shouldn't have attempted to change uid or gid
 354                          * unless have the privilege */
 355                         rsyserr(FERROR, errno, "%s %s failed",
 356                             change_uid ? "chown" : "chgrp",
 357                             full_fname(fname));
 358                         goto cleanup;
 359                 } else
 360                 /* a lchown had been done - we have to re-stat if the
 361                  * destination had the setuid or setgid bits set due
 362                  * to the side effect of the chown call */
 363                 if (sxp->st.st_mode & (S_ISUID | S_ISGID)) {
 364                         link_stat(fname, &sxp->st,
 365                                   keep_dirlinks && S_ISDIR(sxp->st.st_mode));
 366                 }
 367                 updated = 1;
 368         }
 369
 370         if (daemon_chmod_modes && !S_ISLNK(new_mode))
 371                 new_mode = tweak_mode(new_mode, daemon_chmod_modes);
 372
 373 #ifdef SUPPORT_ACLS
 374         /* It's OK to call set_acl() now, even for a dir, as the generator
 375          * will enable owner-writability using chmod, if necessary.
 376          *
 377          * If set_acl() changes permission bits in the process of setting
 378          * an access ACL, it changes sxp->st.st_mode so we know whether we
 379          * need to chmod(). */
 380         if (preserve_acls && !S_ISLNK(new_mode) && set_acl(fname, file, sxp) == 0)
 381                 updated = 1;
 382 #endif
 383
 384 #ifdef HAVE_CHMOD
 385         if (!BITS_EQUAL(sxp->st.st_mode, new_mode, CHMOD_BITS)) {
 386                 int ret = am_root < 0 ? 0 : do_chmod(fname, new_mode);
 387                 if (ret < 0) {
 388                         rsyserr(FERROR, errno,
 389                                 "failed to set permissions on %s",
 390                                 full_fname(fname));
 391                         goto cleanup;
 392                 }
 393                 if (ret == 0) /* ret == 1 if symlink could not be set */
 394                         updated = 1;
 395         }
 396 #endif
 397
 398         if (verbose > 1 && flags & ATTRS_REPORT) {
 399                 if (updated)
 400                         rprintf(FCLIENT, "%s\n", fname);
 401                 else
 402                         rprintf(FCLIENT, "%s is uptodate\n", fname);
 403         }
 404   cleanup:
 405         if (sxp == &sx2) {
 406 #ifdef SUPPORT_ACLS
 407                 if (preserve_acls)
 408                         free_acl(&sx2);
 409 #endif
 410 #ifdef SUPPORT_XATTRS
 411                 if (preserve_xattrs)
 412                         free_xattr(&sx2);
 413 #endif
 414         }
 415         return updated;
 416 }
 417
 418 RETSIGTYPE sig_int(UNUSED(int val))
 419 {
 420         /* KLUGE: if the user hits Ctrl-C while ssh is prompting
 421          * for a password, then our cleanup's sending of a SIGUSR1
 422          * signal to all our children may kill ssh before it has a
 423          * chance to restore the tty settings (i.e. turn echo back
 424          * on).  By sleeping for a short time, ssh gets a bigger
 425          * chance to do the right thing.  If child processes are
 426          * not ssh waiting for a password, then this tiny delay
 427          * shouldn't hurt anything. */
 428         msleep(400);
 429         exit_cleanup(RERR_SIGNAL);
 430 }
 431
 432 /* Finish off a file transfer: renaming the file and setting the file's
 433  * attributes (e.g. permissions, ownership, etc.).  If partialptr is not
 434  * NULL and the robust_rename() call is forced to copy the temp file, we
 435  * stage the file into the partial-dir and then rename it into place. */
 436 void finish_transfer(const char *fname, const char *fnametmp,
 437                      const char *fnamecmp, const char *partialptr,
 438                      struct file_struct *file, int ok_to_set_time,
 439                      int overwriting_basis)
 440 {
 441         int ret;
 442
 443         if (inplace) {
 444                 if (verbose > 2)
 445                         rprintf(FINFO, "finishing %s\n", fname);
 446                 fnametmp = fname;
 447                 goto do_set_file_attrs;
 448         }
 449
 450         if (make_backups > 0 && overwriting_basis && !make_backup(fname))
 451                 return;
 452
 453         /* Change permissions before putting the file into place. */
 454         set_file_attrs(fnametmp, file, NULL, fnamecmp,
 455                        ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
 456
 457         /* move tmp file over real file */
 458         if (verbose > 2)
 459                 rprintf(FINFO, "renaming %s to %s\n", fnametmp, fname);
 460         ret = robust_rename(fnametmp, fname, partialptr,
 461                             file->mode & INITACCESSPERMS);
 462         if (ret < 0) {
 463                 rsyserr(FERROR, errno, "%s %s -> \"%s\"",
 464                         ret == -2 ? "copy" : "rename",
 465                         full_fname(fnametmp), fname);
 466                 do_unlink(fnametmp);
 467                 return;
 468         }
 469         if (ret == 0) {
 470                 /* The file was moved into place (not copied), so it's done. */
 471                 return;
 472         }
 473         /* The file was copied, so tweak the perms of the copied file.  If it
 474          * was copied to partialptr, move it into its final destination. */
 475         fnametmp = partialptr ? partialptr : fname;
 476
 477   do_set_file_attrs:
 478         set_file_attrs(fnametmp, file, NULL, fnamecmp,
 479                        ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
 480
 481         if (partialptr) {
 482                 if (do_rename(fnametmp, fname) < 0) {
 483                         rsyserr(FERROR, errno, "rename %s -> \"%s\"",
 484                                 full_fname(fnametmp), fname);
 485                 } else
 486                         handle_partial_dir(partialptr, PDIR_DELETE);
 487         }
 488 }
 489
 490 struct file_list *flist_for_ndx(int ndx)
 491 {
 492         struct file_list *flist = cur_flist;
 493
 494         if (!flist && !(flist = first_flist))
 495                 return NULL;
 496
 497         while (ndx < flist->ndx_start-1) {
 498                 if (flist == first_flist)
 499                         return NULL;
 500                 flist = flist->prev;
 501         }
 502         while (ndx > flist->ndx_end) {
 503                 if (!(flist = flist->next))
 504                         return NULL;
 505         }
 506         return flist;
 507 }
 508
 509 const char *who_am_i(void)
 510 {
 511         if (am_starting_up)
 512                 return am_server ? "server" : "client";
 513         return am_sender ? "sender" : am_generator ? "generator" : "receiver";
 514 }