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