Make the two "wrap-bytes" sections simpler and more similar.
[rsync/rsync.git] / compat.c
1 /*
2  * Compatibility routines for older rsync protocol versions.
3  *
4  * Copyright (C) Andrew Tridgell 1996
5  * Copyright (C) Paul Mackerras 1996
6  * Copyright (C) 2004-2009 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 3 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, visit the http://fsf.org website.
20  */
21
22 #include "rsync.h"
23
24 int remote_protocol = 0;
25 int file_extra_cnt = 0; /* count of file-list extras that everyone gets */
26 int inc_recurse = 0;
27
28 extern int am_server;
29 extern int am_sender;
30 extern int local_server;
31 extern int inplace;
32 extern int recurse;
33 extern int use_qsort;
34 extern int allow_inc_recurse;
35 extern int append_mode;
36 extern int fuzzy_basis;
37 extern int read_batch;
38 extern int delay_updates;
39 extern int checksum_seed;
40 extern int basis_dir_cnt;
41 extern int prune_empty_dirs;
42 extern int protocol_version;
43 extern int protect_args;
44 extern int preserve_uid;
45 extern int preserve_gid;
46 extern int preserve_acls;
47 extern int preserve_xattrs;
48 extern int need_messages_from_generator;
49 extern int delete_mode, delete_before, delete_during, delete_after;
50 extern char *shell_cmd;
51 extern char *partial_dir;
52 extern char *dest_option;
53 extern char *files_from;
54 extern char *filesfrom_host;
55 extern filter_rule_list filter_list;
56 extern int need_unsorted_flist;
57 #ifdef ICONV_OPTION
58 extern iconv_t ic_send, ic_recv;
59 extern char *iconv_opt;
60 #endif
61
62 /* These index values are for the file-list's extra-attribute array. */
63 int uid_ndx, gid_ndx, acls_ndx, xattrs_ndx, unsort_ndx;
64
65 int receiver_symlink_times = 0; /* receiver can set the time on a symlink */
66 int sender_symlink_iconv = 0;   /* sender should convert symlink content */
67
68 #ifdef ICONV_OPTION
69 int filesfrom_convert = 0;
70 #endif
71
72 #define CF_INC_RECURSE   (1<<0)
73 #define CF_SYMLINK_TIMES (1<<1)
74 #define CF_SYMLINK_ICONV (1<<2)
75
76 static const char *client_info;
77
78 /* The server makes sure that if either side only supports a pre-release
79  * version of a protocol, that both sides must speak a compatible version
80  * of that protocol for it to be advertised as available. */
81 static void check_sub_protocol(void)
82 {
83         char *dot;
84         int their_protocol, their_sub;
85 #if SUBPROTOCOL_VERSION != 0
86         int our_sub = protocol_version < PROTOCOL_VERSION ? 0 : SUBPROTOCOL_VERSION;
87 #else
88         int our_sub = 0;
89 #endif
90
91         /* client_info starts with VER.SUB string if client is a pre-release. */
92         if (!(their_protocol = atoi(client_info))
93          || !(dot = strchr(client_info, '.'))
94          || !(their_sub = atoi(dot+1))) {
95 #if SUBPROTOCOL_VERSION != 0
96                 if (our_sub)
97                         protocol_version--;
98 #endif
99                 return;
100         }
101
102         if (their_protocol < protocol_version) {
103                 if (their_sub)
104                         protocol_version = their_protocol - 1;
105                 return;
106         }
107
108         if (their_protocol > protocol_version)
109                 their_sub = 0; /* 0 == final version of older protocol */
110         if (their_sub != our_sub)
111                 protocol_version--;
112 }
113
114 void set_allow_inc_recurse(void)
115 {
116         client_info = shell_cmd ? shell_cmd : "";
117
118         if (!recurse || use_qsort)
119                 allow_inc_recurse = 0;
120         else if (!am_sender
121          && (delete_before || delete_after
122           || delay_updates || prune_empty_dirs))
123                 allow_inc_recurse = 0;
124         else if (am_server && !local_server
125          && (strchr(client_info, 'i') == NULL))
126                 allow_inc_recurse = 0;
127 }
128
129 void setup_protocol(int f_out,int f_in)
130 {
131         if (am_sender)
132                 file_extra_cnt += PTR_EXTRA_CNT;
133         else
134                 file_extra_cnt++;
135         if (preserve_uid)
136                 uid_ndx = ++file_extra_cnt;
137         if (preserve_gid)
138                 gid_ndx = ++file_extra_cnt;
139         if (preserve_acls && !am_sender)
140                 acls_ndx = ++file_extra_cnt;
141         if (preserve_xattrs)
142                 xattrs_ndx = ++file_extra_cnt;
143
144         if (am_server)
145                 set_allow_inc_recurse();
146
147         if (remote_protocol == 0) {
148                 if (am_server && !local_server)
149                         check_sub_protocol();
150                 if (!read_batch)
151                         write_int(f_out, protocol_version);
152                 remote_protocol = read_int(f_in);
153                 if (protocol_version > remote_protocol)
154                         protocol_version = remote_protocol;
155         }
156         if (read_batch && remote_protocol > protocol_version) {
157                 rprintf(FERROR, "The protocol version in the batch file is too new (%d > %d).\n",
158                         remote_protocol, protocol_version);
159                 exit_cleanup(RERR_PROTOCOL);
160         }
161
162         if (DEBUG_GTE(PROTO, 1)) {
163                 rprintf(FINFO, "(%s) Protocol versions: remote=%d, negotiated=%d\n",
164                         am_server? "Server" : "Client", remote_protocol, protocol_version);
165         }
166         if (remote_protocol < MIN_PROTOCOL_VERSION
167          || remote_protocol > MAX_PROTOCOL_VERSION) {
168                 rprintf(FERROR,"protocol version mismatch -- is your shell clean?\n");
169                 rprintf(FERROR,"(see the rsync man page for an explanation)\n");
170                 exit_cleanup(RERR_PROTOCOL);
171         }
172         if (remote_protocol < OLD_PROTOCOL_VERSION) {
173                 rprintf(FINFO,"%s is very old version of rsync, upgrade recommended.\n",
174                         am_server? "Client" : "Server");
175         }
176         if (protocol_version < MIN_PROTOCOL_VERSION) {
177                 rprintf(FERROR, "--protocol must be at least %d on the %s.\n",
178                         MIN_PROTOCOL_VERSION, am_server? "Server" : "Client");
179                 exit_cleanup(RERR_PROTOCOL);
180         }
181         if (protocol_version > PROTOCOL_VERSION) {
182                 rprintf(FERROR, "--protocol must be no more than %d on the %s.\n",
183                         PROTOCOL_VERSION, am_server? "Server" : "Client");
184                 exit_cleanup(RERR_PROTOCOL);
185         }
186         if (read_batch)
187                 check_batch_flags();
188
189         if (protocol_version < 30) {
190                 if (append_mode == 1)
191                         append_mode = 2;
192                 if (preserve_acls && !local_server) {
193                         rprintf(FERROR,
194                             "--acls requires protocol 30 or higher"
195                             " (negotiated %d).\n",
196                             protocol_version);
197                         exit_cleanup(RERR_PROTOCOL);
198                 }
199                 if (preserve_xattrs && !local_server) {
200                         rprintf(FERROR,
201                             "--xattrs requires protocol 30 or higher"
202                             " (negotiated %d).\n",
203                             protocol_version);
204                         exit_cleanup(RERR_PROTOCOL);
205                 }
206         }
207
208         if (delete_mode && !(delete_before+delete_during+delete_after)) {
209                 if (protocol_version < 30)
210                         delete_before = 1;
211                 else
212                         delete_during = 1;
213         }
214
215         if (protocol_version < 29) {
216                 if (fuzzy_basis) {
217                         rprintf(FERROR,
218                             "--fuzzy requires protocol 29 or higher"
219                             " (negotiated %d).\n",
220                             protocol_version);
221                         exit_cleanup(RERR_PROTOCOL);
222                 }
223
224                 if (basis_dir_cnt && inplace) {
225                         rprintf(FERROR,
226                             "%s with --inplace requires protocol 29 or higher"
227                             " (negotiated %d).\n",
228                             dest_option, protocol_version);
229                         exit_cleanup(RERR_PROTOCOL);
230                 }
231
232                 if (basis_dir_cnt > 1) {
233                         rprintf(FERROR,
234                             "Using more than one %s option requires protocol"
235                             " 29 or higher (negotiated %d).\n",
236                             dest_option, protocol_version);
237                         exit_cleanup(RERR_PROTOCOL);
238                 }
239
240                 if (prune_empty_dirs) {
241                         rprintf(FERROR,
242                             "--prune-empty-dirs requires protocol 29 or higher"
243                             " (negotiated %d).\n",
244                             protocol_version);
245                         exit_cleanup(RERR_PROTOCOL);
246                 }
247         } else if (protocol_version >= 30) {
248                 int compat_flags;
249                 if (am_server) {
250                         compat_flags = allow_inc_recurse ? CF_INC_RECURSE : 0;
251 #ifdef CAN_SET_SYMLINK_TIMES
252                         compat_flags |= CF_SYMLINK_TIMES;
253 #endif
254 #ifdef ICONV_OPTION
255                         compat_flags |= CF_SYMLINK_ICONV;
256 #endif
257                         write_byte(f_out, compat_flags);
258                 } else {
259                         compat_flags = read_byte(f_in);
260                 }
261                 /* The inc_recurse var MUST be set to 0 or 1. */
262                 inc_recurse = compat_flags & CF_INC_RECURSE ? 1 : 0;
263                 if (am_sender) {
264                         receiver_symlink_times = am_server
265                             ? strchr(client_info, 'L') != NULL
266                             : !!(compat_flags & CF_SYMLINK_TIMES);
267                 }
268 #ifdef CAN_SET_SYMLINK_TIMES
269                 else
270                         receiver_symlink_times = 1;
271 #endif
272 #ifdef ICONV_OPTION
273                 sender_symlink_iconv = iconv_opt && (am_server
274                     ? local_server || strchr(client_info, 's') != NULL
275                     : !!(compat_flags & CF_SYMLINK_ICONV));
276 #endif
277                 if (inc_recurse && !allow_inc_recurse) {
278                         /* This should only be able to happen in a batch. */
279                         fprintf(stderr,
280                             "Incompatible options specified for inc-recursive %s.\n",
281                             read_batch ? "batch file" : "connection");
282                         exit_cleanup(RERR_SYNTAX);
283                 }
284                 need_messages_from_generator = 1;
285 #ifdef CAN_SET_SYMLINK_TIMES
286         } else if (!am_sender) {
287                 receiver_symlink_times = 1;
288 #endif
289         }
290
291         if (need_unsorted_flist && (!am_sender || inc_recurse))
292                 unsort_ndx = ++file_extra_cnt;
293
294         if (partial_dir && *partial_dir != '/' && (!am_server || local_server)) {
295                 int rflags = FILTRULE_NO_PREFIXES | FILTRULE_DIRECTORY;
296                 if (!am_sender || protocol_version >= 30)
297                         rflags |= FILTRULE_PERISHABLE;
298                 parse_filter_str(&filter_list, partial_dir, rule_template(rflags), 0);
299         }
300
301
302 #ifdef ICONV_OPTION
303         if (protect_args && files_from) {
304                 if (am_sender)
305                         filesfrom_convert = filesfrom_host && ic_send != (iconv_t)-1;
306                 else
307                         filesfrom_convert = !filesfrom_host && ic_recv != (iconv_t)-1;
308         }
309 #endif
310
311         if (am_server) {
312                 if (!checksum_seed)
313                         checksum_seed = time(NULL);
314                 write_int(f_out, checksum_seed);
315         } else {
316                 checksum_seed = read_int(f_in);
317         }
318 }