Clarify the short description of --chmod.
[rsync/rsync.git] / 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 /*
93   free a sums struct
94   */
95 void free_sums(struct sum_struct *s)
96 {
97         if (s->sums) free(s->sums);
98         free(s);
99 }
100
101 /* This is only called when we aren't preserving permissions.  Figure out what
102  * the permissions should be and return them merged back into the mode. */
103 mode_t dest_mode(mode_t flist_mode, mode_t stat_mode, int exists)
104 {
105         int new_mode;
106         /* If the file already exists, we'll return the local permissions,
107          * possibly tweaked by the --executability option. */
108         if (exists) {
109                 new_mode = (flist_mode & ~CHMOD_BITS) | (stat_mode & CHMOD_BITS);
110                 if (preserve_executability && S_ISREG(flist_mode)) {
111                         /* If the source file is executable, grant execute
112                          * rights to everyone who can read, but ONLY if the
113                          * file isn't already executable. */
114                         if (!(flist_mode & 0111))
115                                 new_mode &= ~0111;
116                         else if (!(stat_mode & 0111))
117                                 new_mode |= (new_mode & 0444) >> 2;
118                 }
119         } else {
120                 /* Apply the umask and turn off special permissions. */
121                 new_mode = flist_mode & (~CHMOD_BITS | (ACCESSPERMS & ~orig_umask));
122         }
123         if (daemon_chmod_modes && !S_ISLNK(flist_mode))
124                 new_mode = tweak_mode(new_mode, daemon_chmod_modes);
125         return new_mode;
126 }
127
128 int set_file_attrs(char *fname, struct file_struct *file, STRUCT_STAT *st,
129                    int flags)
130 {
131         int updated = 0;
132         STRUCT_STAT st2;
133         int change_uid, change_gid;
134
135         if (!st) {
136                 if (dry_run)
137                         return 1;
138                 if (link_stat(fname, &st2, 0) < 0) {
139                         rsyserr(FERROR, errno, "stat %s failed",
140                                 full_fname(fname));
141                         return 0;
142                 }
143                 st = &st2;
144                 if (!preserve_perms && S_ISDIR(file->mode)
145                  && st->st_mode & S_ISGID) {
146                         /* We just created this directory and its setgid
147                          * bit is on, so make sure it stays on. */
148                         file->mode |= S_ISGID;
149                 }
150         }
151
152         if (!preserve_times || (S_ISDIR(st->st_mode) && omit_dir_times))
153                 flags |= ATTRS_SKIP_MTIME;
154         if (!(flags & ATTRS_SKIP_MTIME)
155             && cmp_time(st->st_mtime, file->modtime) != 0) {
156                 int ret = set_modtime(fname, file->modtime, st->st_mode);
157                 if (ret < 0) {
158                         rsyserr(FERROR, errno, "failed to set times on %s",
159                                 full_fname(fname));
160                         return 0;
161                 }
162                 if (ret == 0) /* ret == 1 if symlink could not be set */
163                         updated = 1;
164         }
165
166         change_uid = am_root && preserve_uid && st->st_uid != file->uid;
167         change_gid = preserve_gid && file->gid != GID_NONE
168                 && st->st_gid != file->gid;
169 #if !defined HAVE_LCHOWN && !defined CHOWN_MODIFIES_SYMLINK
170         if (S_ISLNK(st->st_mode))
171                 ;
172         else
173 #endif
174         if (change_uid || change_gid) {
175                 if (verbose > 2) {
176                         if (change_uid) {
177                                 rprintf(FINFO,
178                                         "set uid of %s from %ld to %ld\n",
179                                         fname,
180                                         (long)st->st_uid, (long)file->uid);
181                         }
182                         if (change_gid) {
183                                 rprintf(FINFO,
184                                         "set gid of %s from %ld to %ld\n",
185                                         fname,
186                                         (long)st->st_gid, (long)file->gid);
187                         }
188                 }
189                 if (do_lchown(fname,
190                     change_uid ? file->uid : st->st_uid,
191                     change_gid ? file->gid : st->st_gid) != 0) {
192                         /* shouldn't have attempted to change uid or gid
193                          * unless have the privilege */
194                         rsyserr(FERROR, errno, "%s %s failed",
195                             change_uid ? "chown" : "chgrp",
196                             full_fname(fname));
197                         return 0;
198                 }
199                 /* a lchown had been done - we have to re-stat if the
200                  * destination had the setuid or setgid bits set due
201                  * to the side effect of the chown call */
202                 if (st->st_mode & (S_ISUID | S_ISGID)) {
203                         link_stat(fname, st,
204                                   keep_dirlinks && S_ISDIR(st->st_mode));
205                 }
206                 updated = 1;
207         }
208
209 #ifdef HAVE_CHMOD
210         if ((st->st_mode & CHMOD_BITS) != (file->mode & CHMOD_BITS)) {
211                 int ret = do_chmod(fname, file->mode);
212                 if (ret < 0) {
213                         rsyserr(FERROR, errno,
214                                 "failed to set permissions on %s",
215                                 full_fname(fname));
216                         return 0;
217                 }
218                 if (ret == 0) /* ret == 1 if symlink could not be set */
219                         updated = 1;
220         }
221 #endif
222
223         if (verbose > 1 && flags & ATTRS_REPORT) {
224                 if (updated)
225                         rprintf(FCLIENT, "%s\n", fname);
226                 else
227                         rprintf(FCLIENT, "%s is uptodate\n", fname);
228         }
229         return updated;
230 }
231
232 RETSIGTYPE sig_int(UNUSED(int val))
233 {
234         /* KLUGE: if the user hits Ctrl-C while ssh is prompting
235          * for a password, then our cleanup's sending of a SIGUSR1
236          * signal to all our children may kill ssh before it has a
237          * chance to restore the tty settings (i.e. turn echo back
238          * on).  By sleeping for a short time, ssh gets a bigger
239          * chance to do the right thing.  If child processes are
240          * not ssh waiting for a password, then this tiny delay
241          * shouldn't hurt anything. */
242         msleep(400);
243         exit_cleanup(RERR_SIGNAL);
244 }
245
246 /* Finish off a file transfer: renaming the file and setting the file's
247  * attributes (e.g. permissions, ownership, etc.).  If partialptr is not
248  * NULL and the robust_rename() call is forced to copy the temp file, we
249  * stage the file into the partial-dir and then rename it into place. */
250 void finish_transfer(char *fname, char *fnametmp, char *partialptr,
251                      struct file_struct *file, int ok_to_set_time,
252                      int overwriting_basis)
253 {
254         int ret;
255
256         if (inplace) {
257                 if (verbose > 2)
258                         rprintf(FINFO, "finishing %s\n", fname);
259                 fnametmp = fname;
260                 goto do_set_file_attrs;
261         }
262
263         if (make_backups && overwriting_basis && !make_backup(fname))
264                 return;
265
266         /* Change permissions before putting the file into place. */
267         set_file_attrs(fnametmp, file, NULL,
268                        ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
269
270         /* move tmp file over real file */
271         if (verbose > 2)
272                 rprintf(FINFO, "renaming %s to %s\n", fnametmp, fname);
273         ret = robust_rename(fnametmp, fname, partialptr,
274                             file->mode & INITACCESSPERMS);
275         if (ret < 0) {
276                 rsyserr(FERROR, errno, "%s %s -> \"%s\"",
277                         ret == -2 ? "copy" : "rename",
278                         full_fname(fnametmp), fname);
279                 do_unlink(fnametmp);
280                 return;
281         }
282         if (ret == 0) {
283                 /* The file was moved into place (not copied), so it's done. */
284                 return;
285         }
286         /* The file was copied, so tweak the perms of the copied file.  If it
287          * was copied to partialptr, move it into its final destination. */
288         fnametmp = partialptr ? partialptr : fname;
289
290   do_set_file_attrs:
291         set_file_attrs(fnametmp, file, NULL,
292                        ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
293
294         if (partialptr) {
295                 if (do_rename(fnametmp, fname) < 0) {
296                         rsyserr(FERROR, errno, "rename %s -> \"%s\"",
297                                 full_fname(fnametmp), fname);
298                 } else
299                         handle_partial_dir(partialptr, PDIR_DELETE);
300         }
301 }
302
303 const char *who_am_i(void)
304 {
305         if (am_starting_up)
306                 return am_server ? "server" : "client";
307         return am_sender ? "sender" : am_generator ? "generator" : "receiver";
308 }