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