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 version 3 as
  10  * published by the Free Software Foundation.
  11  *
  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.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, visit the http://fsf.org website.
  19  */
  20
  21 #include "rsync.h"
  22 #if defined HAVE_LIBCHARSET_H && defined HAVE_LOCALE_CHARSET
  23 #include <libcharset.h>
  24 #elif defined HAVE_LANGINFO_H && defined HAVE_NL_LANGINFO
  25 #include <langinfo.h>
  26 #endif
  27
  28 extern int verbose;
  29 extern int dry_run;
  30 extern int preserve_acls;
  31 extern int preserve_xattrs;
  32 extern int preserve_perms;
  33 extern int preserve_executability;
  34 extern int preserve_times;
  35 extern int omit_dir_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->count) {
 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->count + 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->count && 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 + first_flist->ndx_start,
 202                         first_flist->prev->ndx_start + first_flist->ndx_start
 203                         + first_flist->prev->count - 1, iflags, who_am_i());
 204                 exit_cleanup(RERR_PROTOCOL);
 205         }
 206         cur_flist = flist;
 207
 208         if (iflags & ITEM_BASIS_TYPE_FOLLOWS)
 209                 fnamecmp_type = read_byte(f_in);
 210         *type_ptr = fnamecmp_type;
 211
 212         if (iflags & ITEM_XNAME_FOLLOWS) {
 213                 if ((len = read_vstring(f_in, buf, MAXPATHLEN)) < 0)
 214                         exit_cleanup(RERR_PROTOCOL);
 215         } else {
 216                 *buf = '\0';
 217                 len = -1;
 218         }
 219         *len_ptr = len;
 220
 221         if (iflags & ITEM_TRANSFER) {
 222                 int i = ndx - cur_flist->ndx_start;
 223                 if (!S_ISREG(cur_flist->files[i]->mode)) {
 224                         rprintf(FERROR,
 225                                 "received request to transfer non-regular file: %d [%s]\n",
 226                                 ndx, who_am_i());
 227                         exit_cleanup(RERR_PROTOCOL);
 228                 }
 229         }
 230
 231         *iflag_ptr = iflags;
 232         return ndx;
 233 }
 234
 235 /*
 236   free a sums struct
 237   */
 238 void free_sums(struct sum_struct *s)
 239 {
 240         if (s->sums) free(s->sums);
 241         free(s);
 242 }
 243
 244 /* This is only called when we aren't preserving permissions.  Figure out what
 245  * the permissions should be and return them merged back into the mode. */
 246 mode_t dest_mode(mode_t flist_mode, mode_t stat_mode, int dflt_perms,
 247                  int exists)
 248 {
 249         int new_mode;
 250         /* If the file already exists, we'll return the local permissions,
 251          * possibly tweaked by the --executability option. */
 252         if (exists) {
 253                 new_mode = (flist_mode & ~CHMOD_BITS) | (stat_mode & CHMOD_BITS);
 254                 if (preserve_executability && S_ISREG(flist_mode)) {
 255                         /* If the source file is executable, grant execute
 256                          * rights to everyone who can read, but ONLY if the
 257                          * file isn't already executable. */
 258                         if (!(flist_mode & 0111))
 259                                 new_mode &= ~0111;
 260                         else if (!(stat_mode & 0111))
 261                                 new_mode |= (new_mode & 0444) >> 2;
 262                 }
 263         } else {
 264                 /* Apply destination default permissions and turn
 265                  * off special permissions. */
 266                 new_mode = flist_mode & (~CHMOD_BITS | dflt_perms);
 267         }
 268         return new_mode;
 269 }
 270
 271 int set_file_attrs(const char *fname, struct file_struct *file, statx *sxp,
 272                    const char *fnamecmp, int flags)
 273 {
 274         int updated = 0;
 275         statx sx2;
 276         int change_uid, change_gid;
 277         mode_t new_mode = file->mode;
 278
 279         if (!sxp) {
 280                 if (dry_run)
 281                         return 1;
 282                 if (link_stat(fname, &sx2.st, 0) < 0) {
 283                         rsyserr(FERROR, errno, "stat %s failed",
 284                                 full_fname(fname));
 285                         return 0;
 286                 }
 287 #ifdef SUPPORT_ACLS
 288                 sx2.acc_acl = sx2.def_acl = NULL;
 289 #endif
 290 #ifdef SUPPORT_XATTRS
 291                 sx2.xattr = NULL;
 292 #endif
 293                 if (!preserve_perms && S_ISDIR(new_mode)
 294                  && sx2.st.st_mode & S_ISGID) {
 295                         /* We just created this directory and its setgid
 296                          * bit is on, so make sure it stays on. */
 297                         new_mode |= S_ISGID;
 298                 }
 299                 sxp = &sx2;
 300         }
 301
 302 #ifdef SUPPORT_ACLS
 303         if (preserve_acls && !S_ISLNK(file->mode) && !ACL_READY(*sxp))
 304                 get_acl(fname, sxp);
 305 #endif
 306
 307 #ifdef SUPPORT_XATTRS
 308         if (preserve_xattrs && fnamecmp)
 309                 set_xattr(fname, file, fnamecmp, sxp);
 310         if (am_root < 0)
 311                 set_stat_xattr(fname, file);
 312 #endif
 313
 314         if (!preserve_times || (S_ISDIR(sxp->st.st_mode) && omit_dir_times))
 315                 flags |= ATTRS_SKIP_MTIME;
 316         if (!(flags & ATTRS_SKIP_MTIME)
 317             && cmp_time(sxp->st.st_mtime, file->modtime) != 0) {
 318                 int ret = set_modtime(fname, file->modtime, sxp->st.st_mode);
 319                 if (ret < 0) {
 320                         rsyserr(FERROR, errno, "failed to set times on %s",
 321                                 full_fname(fname));
 322                         goto cleanup;
 323                 }
 324                 if (ret == 0) /* ret == 1 if symlink could not be set */
 325                         updated = 1;
 326         }
 327
 328         change_uid = am_root && uid_ndx && sxp->st.st_uid != (uid_t)F_OWNER(file);
 329         change_gid = gid_ndx && !(file->flags & FLAG_SKIP_GROUP)
 330                   && sxp->st.st_gid != (gid_t)F_GROUP(file);
 331 #if !defined HAVE_LCHOWN && !defined CHOWN_MODIFIES_SYMLINK
 332         if (S_ISLNK(sxp->st.st_mode))
 333                 ;
 334         else
 335 #endif
 336         if (change_uid || change_gid) {
 337                 if (verbose > 2) {
 338                         if (change_uid) {
 339                                 rprintf(FINFO,
 340                                         "set uid of %s from %u to %u\n",
 341                                         fname, (unsigned)sxp->st.st_uid, F_OWNER(file));
 342                         }
 343                         if (change_gid) {
 344                                 rprintf(FINFO,
 345                                         "set gid of %s from %u to %u\n",
 346                                         fname, (unsigned)sxp->st.st_gid, F_GROUP(file));
 347                         }
 348                 }
 349                 if (am_root < 0) {
 350                         ;
 351                 } else if (do_lchown(fname,
 352                     change_uid ? (uid_t)F_OWNER(file) : sxp->st.st_uid,
 353                     change_gid ? (gid_t)F_GROUP(file) : sxp->st.st_gid) != 0) {
 354                         /* shouldn't have attempted to change uid or gid
 355                          * unless have the privilege */
 356                         rsyserr(FERROR, errno, "%s %s failed",
 357                             change_uid ? "chown" : "chgrp",
 358                             full_fname(fname));
 359                         goto cleanup;
 360                 } else
 361                 /* a lchown had been done - we have to re-stat if the
 362                  * destination had the setuid or setgid bits set due
 363                  * to the side effect of the chown call */
 364                 if (sxp->st.st_mode & (S_ISUID | S_ISGID)) {
 365                         link_stat(fname, &sxp->st,
 366                                   keep_dirlinks && S_ISDIR(sxp->st.st_mode));
 367                 }
 368                 updated = 1;
 369         }
 370
 371         if (daemon_chmod_modes && !S_ISLNK(new_mode))
 372                 new_mode = tweak_mode(new_mode, daemon_chmod_modes);
 373
 374 #ifdef SUPPORT_ACLS
 375         /* It's OK to call set_acl() now, even for a dir, as the generator
 376          * will enable owner-writability using chmod, if necessary.
 377          *
 378          * If set_acl() changes permission bits in the process of setting
 379          * an access ACL, it changes sxp->st.st_mode so we know whether we
 380          * need to chmod(). */
 381         if (preserve_acls && !S_ISLNK(new_mode) && set_acl(fname, file, sxp) == 0)
 382                 updated = 1;
 383 #endif
 384
 385 #ifdef HAVE_CHMOD
 386         if (!BITS_EQUAL(sxp->st.st_mode, new_mode, CHMOD_BITS)) {
 387                 int ret = am_root < 0 ? 0 : do_chmod(fname, new_mode);
 388                 if (ret < 0) {
 389                         rsyserr(FERROR, errno,
 390                                 "failed to set permissions on %s",
 391                                 full_fname(fname));
 392                         goto cleanup;
 393                 }
 394                 if (ret == 0) /* ret == 1 if symlink could not be set */
 395                         updated = 1;
 396         }
 397 #endif
 398
 399         if (verbose > 1 && flags & ATTRS_REPORT) {
 400                 if (updated)
 401                         rprintf(FCLIENT, "%s\n", fname);
 402                 else
 403                         rprintf(FCLIENT, "%s is uptodate\n", fname);
 404         }
 405   cleanup:
 406         if (sxp == &sx2) {
 407 #ifdef SUPPORT_ACLS
 408                 if (preserve_acls)
 409                         free_acl(&sx2);
 410 #endif
 411 #ifdef SUPPORT_XATTRS
 412                 if (preserve_xattrs)
 413                         free_xattr(&sx2);
 414 #endif
 415         }
 416         return updated;
 417 }
 418
 419 RETSIGTYPE sig_int(UNUSED(int val))
 420 {
 421         /* KLUGE: if the user hits Ctrl-C while ssh is prompting
 422          * for a password, then our cleanup's sending of a SIGUSR1
 423          * signal to all our children may kill ssh before it has a
 424          * chance to restore the tty settings (i.e. turn echo back
 425          * on).  By sleeping for a short time, ssh gets a bigger
 426          * chance to do the right thing.  If child processes are
 427          * not ssh waiting for a password, then this tiny delay
 428          * shouldn't hurt anything. */
 429         msleep(400);
 430         exit_cleanup(RERR_SIGNAL);
 431 }
 432
 433 /* Finish off a file transfer: renaming the file and setting the file's
 434  * attributes (e.g. permissions, ownership, etc.).  If partialptr is not
 435  * NULL and the robust_rename() call is forced to copy the temp file, we
 436  * stage the file into the partial-dir and then rename it into place. */
 437 void finish_transfer(const char *fname, const char *fnametmp,
 438                      const char *fnamecmp, const char *partialptr,
 439                      struct file_struct *file, int ok_to_set_time,
 440                      int overwriting_basis)
 441 {
 442         int ret;
 443
 444         if (inplace) {
 445                 if (verbose > 2)
 446                         rprintf(FINFO, "finishing %s\n", fname);
 447                 fnametmp = fname;
 448                 goto do_set_file_attrs;
 449         }
 450
 451         if (make_backups > 0 && overwriting_basis && !make_backup(fname))
 452                 return;
 453
 454         /* Change permissions before putting the file into place. */
 455         set_file_attrs(fnametmp, file, NULL, fnamecmp,
 456                        ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
 457
 458         /* move tmp file over real file */
 459         if (verbose > 2)
 460                 rprintf(FINFO, "renaming %s to %s\n", fnametmp, fname);
 461         ret = robust_rename(fnametmp, fname, partialptr,
 462                             file->mode & INITACCESSPERMS);
 463         if (ret < 0) {
 464                 rsyserr(FERROR, errno, "%s %s -> \"%s\"",
 465                         ret == -2 ? "copy" : "rename",
 466                         full_fname(fnametmp), fname);
 467                 do_unlink(fnametmp);
 468                 return;
 469         }
 470         if (ret == 0) {
 471                 /* The file was moved into place (not copied), so it's done. */
 472                 return;
 473         }
 474         /* The file was copied, so tweak the perms of the copied file.  If it
 475          * was copied to partialptr, move it into its final destination. */
 476         fnametmp = partialptr ? partialptr : fname;
 477
 478   do_set_file_attrs:
 479         set_file_attrs(fnametmp, file, NULL, fnamecmp,
 480                        ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
 481
 482         if (partialptr) {
 483                 if (do_rename(fnametmp, fname) < 0) {
 484                         rsyserr(FERROR, errno, "rename %s -> \"%s\"",
 485                                 full_fname(fnametmp), fname);
 486                 } else
 487                         handle_partial_dir(partialptr, PDIR_DELETE);
 488         }
 489 }
 490
 491 struct file_list *flist_for_ndx(int ndx)
 492 {
 493         struct file_list *flist = cur_flist;
 494
 495         if (!flist && !(flist = first_flist))
 496                 return NULL;
 497
 498         while (ndx < flist->ndx_start) {
 499                 if (flist == first_flist)
 500                         return NULL;
 501                 flist = flist->prev;
 502         }
 503         while (ndx >= flist->ndx_start + flist->count) {
 504                 if (!(flist = flist->next))
 505                         return NULL;
 506         }
 507         return flist;
 508 }
 509
 510 const char *who_am_i(void)
 511 {
 512         if (am_starting_up)
 513                 return am_server ? "server" : "client";
 514         return am_sender ? "sender" : am_generator ? "generator" : "receiver";
 515 }