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, 2004, 2005, 2006 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 2 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, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
  21  */
  22
  23 #include "rsync.h"
  24 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
  25 #include <iconv.h>
  26 #endif
  27 #if defined HAVE_LIBCHARSET_H && defined HAVE_LOCALE_CHARSET
  28 #include <libcharset.h>
  29 #elif defined HAVE_LANGINFO_H && defined HAVE_NL_LANGINFO
  30 #include <langinfo.h>
  31 #endif
  32
  33 extern int verbose;
  34 extern int dry_run;
  35 extern int preserve_perms;
  36 extern int preserve_executability;
  37 extern int preserve_times;
  38 extern int omit_dir_times;
  39 extern int am_root;
  40 extern int am_server;
  41 extern int am_sender;
  42 extern int am_generator;
  43 extern int am_starting_up;
  44 extern int allow_8bit_chars;
  45 extern int preserve_uid;
  46 extern int preserve_gid;
  47 extern int inplace;
  48 extern int keep_dirlinks;
  49 extern int make_backups;
  50 extern mode_t orig_umask;
  51 extern struct stats stats;
  52 extern struct chmod_mode_struct *daemon_chmod_modes;
  53
  54 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
  55 iconv_t ic_chck = (iconv_t)-1;
  56
  57 static const char *default_charset(void)
  58 {
  59 #if defined HAVE_LIBCHARSET_H && defined HAVE_LOCALE_CHARSET
  60         return locale_charset();
  61 #elif defined HAVE_LANGINFO_H && defined HAVE_NL_LANGINFO
  62         return nl_langinfo(CODESET);
  63 #else
  64         return ""; /* Works with (at the very least) gnu iconv... */
  65 #endif
  66 }
  67
  68 void setup_iconv()
  69 {
  70         if (!am_server && !allow_8bit_chars) {
  71                 const char *defset = default_charset();
  72
  73                 /* It's OK if this fails... */
  74                 ic_chck = iconv_open(defset, defset);
  75
  76                 if (verbose > 3) {
  77                         if (ic_chck == (iconv_t)-1) {
  78                                 rprintf(FINFO,
  79                                         "note: iconv_open(\"%s\", \"%s\") failed (%d)"
  80                                         " -- using isprint() instead of iconv().\n",
  81                                         defset, defset, errno);
  82                         } else {
  83                                 rprintf(FINFO,
  84                                         "note: iconv_open(\"%s\", \"%s\") succeeded.\n",
  85                                         defset, defset);
  86                         }
  87                 }
  88         }
  89 }
  90 #endif
  91
  92 /* This is used by sender.c with a valid f_out, and by receive.c with
  93  * f_out = -1. */
  94 int read_item_attrs(int f_in, int f_out, int ndx, uchar *type_ptr,
  95                     char *buf, int *len_ptr)
  96 {
  97         int len;
  98         uchar fnamecmp_type = FNAMECMP_FNAME;
  99         int iflags = protocol_version >= 29 ? read_shortint(f_in)
 100                    : ITEM_TRANSFER | ITEM_MISSING_DATA;
 101
 102         /* Handle the new keep-alive (no-op) packet. */
 103         if (ndx == the_file_list->count && iflags == ITEM_IS_NEW)
 104                 ;
 105         else if (ndx < 0 || ndx >= the_file_list->count) {
 106                 rprintf(FERROR, "Invalid file index: %d (count=%d) [%s]\n",
 107                         ndx, the_file_list->count, who_am_i());
 108                 exit_cleanup(RERR_PROTOCOL);
 109         } else if (iflags == ITEM_IS_NEW) {
 110                 rprintf(FERROR, "Invalid itemized flag word: %x [%s]\n",
 111                         iflags, who_am_i());
 112                 exit_cleanup(RERR_PROTOCOL);
 113         }
 114
 115         if (iflags & ITEM_BASIS_TYPE_FOLLOWS)
 116                 fnamecmp_type = read_byte(f_in);
 117         *type_ptr = fnamecmp_type;
 118
 119         if (iflags & ITEM_XNAME_FOLLOWS) {
 120                 if ((len = read_vstring(f_in, buf, MAXPATHLEN)) < 0)
 121                         exit_cleanup(RERR_PROTOCOL);
 122         } else {
 123                 *buf = '\0';
 124                 len = -1;
 125         }
 126         *len_ptr = len;
 127
 128         if (iflags & ITEM_TRANSFER) {
 129                 if (!S_ISREG(the_file_list->files[ndx]->mode)) {
 130                         rprintf(FERROR,
 131                                 "received request to transfer non-regular file: %d [%s]\n",
 132                                 ndx, who_am_i());
 133                         exit_cleanup(RERR_PROTOCOL);
 134                 }
 135         } else if (f_out >= 0) {
 136                 write_ndx_and_attrs(f_out, ndx, iflags,
 137                                     fnamecmp_type, buf, len);
 138         }
 139
 140         return iflags;
 141 }
 142
 143 /*
 144   free a sums struct
 145   */
 146 void free_sums(struct sum_struct *s)
 147 {
 148         if (s->sums) free(s->sums);
 149         free(s);
 150 }
 151
 152 /* This is only called when we aren't preserving permissions.  Figure out what
 153  * the permissions should be and return them merged back into the mode. */
 154 mode_t dest_mode(mode_t flist_mode, mode_t stat_mode, int exists)
 155 {
 156         int new_mode;
 157         /* If the file already exists, we'll return the local permissions,
 158          * possibly tweaked by the --executability option. */
 159         if (exists) {
 160                 new_mode = (flist_mode & ~CHMOD_BITS) | (stat_mode & CHMOD_BITS);
 161                 if (preserve_executability && S_ISREG(flist_mode)) {
 162                         /* If the source file is executable, grant execute
 163                          * rights to everyone who can read, but ONLY if the
 164                          * file isn't already executable. */
 165                         if (!(flist_mode & 0111))
 166                                 new_mode &= ~0111;
 167                         else if (!(stat_mode & 0111))
 168                                 new_mode |= (new_mode & 0444) >> 2;
 169                 }
 170         } else {
 171                 /* Apply the umask and turn off special permissions. */
 172                 new_mode = flist_mode & (~CHMOD_BITS | (ACCESSPERMS & ~orig_umask));
 173         }
 174         return new_mode;
 175 }
 176
 177 int set_file_attrs(char *fname, struct file_struct *file, STRUCT_STAT *st,
 178                    int flags)
 179 {
 180         int updated = 0;
 181         STRUCT_STAT st2;
 182         int change_uid, change_gid;
 183         mode_t new_mode = file->mode;
 184
 185         if (!st) {
 186                 if (dry_run)
 187                         return 1;
 188                 if (link_stat(fname, &st2, 0) < 0) {
 189                         rsyserr(FERROR, errno, "stat %s failed",
 190                                 full_fname(fname));
 191                         return 0;
 192                 }
 193                 st = &st2;
 194                 if (!preserve_perms && S_ISDIR(new_mode)
 195                  && st->st_mode & S_ISGID) {
 196                         /* We just created this directory and its setgid
 197                          * bit is on, so make sure it stays on. */
 198                         new_mode |= S_ISGID;
 199                 }
 200         }
 201
 202         if (!preserve_times || (S_ISDIR(st->st_mode) && omit_dir_times))
 203                 flags |= ATTRS_SKIP_MTIME;
 204         if (!(flags & ATTRS_SKIP_MTIME)
 205             && cmp_time(st->st_mtime, file->modtime) != 0) {
 206                 int ret = set_modtime(fname, file->modtime, st->st_mode);
 207                 if (ret < 0) {
 208                         rsyserr(FERROR, errno, "failed to set times on %s",
 209                                 full_fname(fname));
 210                         return 0;
 211                 }
 212                 if (ret == 0) /* ret == 1 if symlink could not be set */
 213                         updated = 1;
 214         }
 215
 216         change_uid = am_root && preserve_uid && st->st_uid != file->uid;
 217         change_gid = preserve_gid && file->gid != GID_NONE
 218                 && st->st_gid != file->gid;
 219 #if !defined HAVE_LCHOWN && !defined CHOWN_MODIFIES_SYMLINK
 220         if (S_ISLNK(st->st_mode))
 221                 ;
 222         else
 223 #endif
 224         if (change_uid || change_gid) {
 225                 if (verbose > 2) {
 226                         if (change_uid) {
 227                                 rprintf(FINFO,
 228                                         "set uid of %s from %ld to %ld\n",
 229                                         fname,
 230                                         (long)st->st_uid, (long)file->uid);
 231                         }
 232                         if (change_gid) {
 233                                 rprintf(FINFO,
 234                                         "set gid of %s from %ld to %ld\n",
 235                                         fname,
 236                                         (long)st->st_gid, (long)file->gid);
 237                         }
 238                 }
 239                 if (do_lchown(fname,
 240                     change_uid ? file->uid : st->st_uid,
 241                     change_gid ? file->gid : st->st_gid) != 0) {
 242                         /* shouldn't have attempted to change uid or gid
 243                          * unless have the privilege */
 244                         rsyserr(FERROR, errno, "%s %s failed",
 245                             change_uid ? "chown" : "chgrp",
 246                             full_fname(fname));
 247                         return 0;
 248                 }
 249                 /* a lchown had been done - we have to re-stat if the
 250                  * destination had the setuid or setgid bits set due
 251                  * to the side effect of the chown call */
 252                 if (st->st_mode & (S_ISUID | S_ISGID)) {
 253                         link_stat(fname, st,
 254                                   keep_dirlinks && S_ISDIR(st->st_mode));
 255                 }
 256                 updated = 1;
 257         }
 258
 259         if (daemon_chmod_modes && !S_ISLNK(new_mode))
 260                 new_mode = tweak_mode(new_mode, daemon_chmod_modes);
 261 #ifdef HAVE_CHMOD
 262         if ((st->st_mode & CHMOD_BITS) != (new_mode & CHMOD_BITS)) {
 263                 int ret = do_chmod(fname, new_mode);
 264                 if (ret < 0) {
 265                         rsyserr(FERROR, errno,
 266                                 "failed to set permissions on %s",
 267                                 full_fname(fname));
 268                         return 0;
 269                 }
 270                 if (ret == 0) /* ret == 1 if symlink could not be set */
 271                         updated = 1;
 272         }
 273 #endif
 274
 275         if (verbose > 1 && flags & ATTRS_REPORT) {
 276                 if (updated)
 277                         rprintf(FCLIENT, "%s\n", fname);
 278                 else
 279                         rprintf(FCLIENT, "%s is uptodate\n", fname);
 280         }
 281         return updated;
 282 }
 283
 284 RETSIGTYPE sig_int(UNUSED(int val))
 285 {
 286         /* KLUGE: if the user hits Ctrl-C while ssh is prompting
 287          * for a password, then our cleanup's sending of a SIGUSR1
 288          * signal to all our children may kill ssh before it has a
 289          * chance to restore the tty settings (i.e. turn echo back
 290          * on).  By sleeping for a short time, ssh gets a bigger
 291          * chance to do the right thing.  If child processes are
 292          * not ssh waiting for a password, then this tiny delay
 293          * shouldn't hurt anything. */
 294         msleep(400);
 295         exit_cleanup(RERR_SIGNAL);
 296 }
 297
 298 /* Finish off a file transfer: renaming the file and setting the file's
 299  * attributes (e.g. permissions, ownership, etc.).  If partialptr is not
 300  * NULL and the robust_rename() call is forced to copy the temp file, we
 301  * stage the file into the partial-dir and then rename it into place. */
 302 void finish_transfer(char *fname, char *fnametmp, char *partialptr,
 303                      struct file_struct *file, int ok_to_set_time,
 304                      int overwriting_basis)
 305 {
 306         int ret;
 307
 308         if (inplace) {
 309                 if (verbose > 2)
 310                         rprintf(FINFO, "finishing %s\n", fname);
 311                 fnametmp = fname;
 312                 goto do_set_file_attrs;
 313         }
 314
 315         if (make_backups && overwriting_basis && !make_backup(fname))
 316                 return;
 317
 318         /* Change permissions before putting the file into place. */
 319         set_file_attrs(fnametmp, file, NULL,
 320                        ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
 321
 322         /* move tmp file over real file */
 323         if (verbose > 2)
 324                 rprintf(FINFO, "renaming %s to %s\n", fnametmp, fname);
 325         ret = robust_rename(fnametmp, fname, partialptr,
 326                             file->mode & INITACCESSPERMS);
 327         if (ret < 0) {
 328                 rsyserr(FERROR, errno, "%s %s -> \"%s\"",
 329                         ret == -2 ? "copy" : "rename",
 330                         full_fname(fnametmp), fname);
 331                 do_unlink(fnametmp);
 332                 return;
 333         }
 334         if (ret == 0) {
 335                 /* The file was moved into place (not copied), so it's done. */
 336                 return;
 337         }
 338         /* The file was copied, so tweak the perms of the copied file.  If it
 339          * was copied to partialptr, move it into its final destination. */
 340         fnametmp = partialptr ? partialptr : fname;
 341
 342   do_set_file_attrs:
 343         set_file_attrs(fnametmp, file, NULL,
 344                        ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
 345
 346         if (partialptr) {
 347                 if (do_rename(fnametmp, fname) < 0) {
 348                         rsyserr(FERROR, errno, "rename %s -> \"%s\"",
 349                                 full_fname(fnametmp), fname);
 350                 } else
 351                         handle_partial_dir(partialptr, PDIR_DELETE);
 352         }
 353 }
 354
 355 const char *who_am_i(void)
 356 {
 357         if (am_starting_up)
 358                 return am_server ? "server" : "client";
 359         return am_sender ? "sender" : am_generator ? "generator" : "receiver";
 360 }