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