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