Commit | Line | Data |
---|---|---|
0f78b815 WD |
1 | /* |
2 | * This program is free software; you can redistribute it and/or modify | |
8e41b68e WD |
3 | * it under the terms of the GNU General Public License as published by |
4 | * the Free Software Foundation; either version 3 of the License, or | |
5 | * (at your option) any later version. | |
0f78b815 WD |
6 | * |
7 | * This program is distributed in the hope that it will be useful, | |
8 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
9 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
10 | * GNU General Public License for more details. | |
3d2e458a | 11 | * |
e7c67065 | 12 | * You should have received a copy of the GNU General Public License along |
4fd842f9 | 13 | * with this program; if not, visit the http://fsf.org website. |
3d2e458a MP |
14 | */ |
15 | ||
8880d8ec WD |
16 | /* This is based on loadparm.c from Samba, written by Andrew Tridgell |
17 | * and Karl Auer. Some of the changes are: | |
0f78b815 WD |
18 | * |
19 | * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org> | |
b3bf9b9d | 20 | * Copyright (C) 2003-2009 Wayne Davison <wayned@samba.org> |
0f78b815 | 21 | */ |
0b76cd63 | 22 | |
8880d8ec | 23 | /* Load parameters. |
0b76cd63 AT |
24 | * |
25 | * This module provides suitable callback functions for the params | |
b583594a | 26 | * module. It builds the internal table of section details which is |
0b76cd63 AT |
27 | * then used by the rest of the server. |
28 | * | |
29 | * To add a parameter: | |
30 | * | |
aef68d78 | 31 | * 1) add it to the global_vars or local_vars structure definition |
0b76cd63 AT |
32 | * 2) add it to the parm_table |
33 | * 3) add it to the list of available functions (eg: using FN_GLOBAL_STRING()) | |
243e9a36 | 34 | * 4) initialise it in the Defaults static stucture |
0b76cd63 AT |
35 | * |
36 | * Notes: | |
8880d8ec WD |
37 | * The configuration file is processed sequentially for speed. For this |
38 | * reason, there is a fair bit of sequence-dependent code here - ie., code | |
39 | * which assumes that certain things happen before others. In particular, the | |
40 | * code which happens at the boundary between sections is delicately poised, | |
41 | * so be careful! | |
0b76cd63 AT |
42 | */ |
43 | ||
44 | #include "rsync.h" | |
5dd14f0c | 45 | #include "itypes.h" |
2206abf8 WD |
46 | |
47 | extern item_list dparam_list; | |
48 | ||
8880d8ec | 49 | #define strequal(a, b) (strcasecmp(a, b)==0) |
0b76cd63 | 50 | #define BOOLSTR(b) ((b) ? "Yes" : "No") |
0b76cd63 | 51 | |
d20ce6e1 WD |
52 | #ifndef LOG_DAEMON |
53 | #define LOG_DAEMON 0 | |
54 | #endif | |
55 | ||
4319cc56 | 56 | #define DEFAULT_DONT_COMPRESS "*.gz *.zip *.z *.rpm *.deb *.iso *.bz2" \ |
aff48500 WD |
57 | " *.t[gb]z *.7z *.mp[34] *.mov *.avi *.ogg *.jpg *.jpeg *.png" \ |
58 | " *.lzo *.rzip *.lzma *.rar *.ace *.gpg *.xz *.txz *.lz *.tlz" | |
4319cc56 | 59 | |
0b76cd63 | 60 | /* the following are used by loadparm for option lists */ |
8880d8ec | 61 | typedef enum { |
fcd613d6 WD |
62 | P_BOOL, P_BOOLREV, P_CHAR, P_INTEGER, |
63 | P_OCTAL, P_PATH, P_STRING, P_ENUM | |
0b76cd63 AT |
64 | } parm_type; |
65 | ||
8880d8ec | 66 | typedef enum { |
fcd613d6 | 67 | P_LOCAL, P_GLOBAL, P_NONE |
0b76cd63 AT |
68 | } parm_class; |
69 | ||
70 | struct enum_list { | |
71 | int value; | |
72 | char *name; | |
73 | }; | |
74 | ||
8880d8ec | 75 | struct parm_struct { |
0b76cd63 AT |
76 | char *label; |
77 | parm_type type; | |
78 | parm_class class; | |
79 | void *ptr; | |
80 | struct enum_list *enum_list; | |
81 | unsigned flags; | |
82 | }; | |
83 | ||
0b76cd63 AT |
84 | #ifndef GLOBAL_NAME |
85 | #define GLOBAL_NAME "global" | |
86 | #endif | |
87 | ||
88 | /* some helpful bits */ | |
aef68d78 | 89 | #define iSECTION(i) ((local_vars*)section_list.items)[i] |
c9604e21 | 90 | #define LP_SNUM_OK(i) ((i) >= 0 && (i) < (int)section_list.count) |
78921390 | 91 | #define SECTION_PTR(s, p) (((char*)(s)) + (ptrdiff_t)(((char*)(p))-(char*)&Vars.l)) |
0b76cd63 | 92 | |
43eb865f | 93 | /* This structure describes global (ie., server-wide) parameters. */ |
8880d8ec | 94 | typedef struct { |
d17c9a44 | 95 | char *bind_address; |
d17c9a44 | 96 | char *motd_file; |
8638dd48 | 97 | char *pid_file; |
a6801c39 | 98 | char *socket_options; |
d17c9a44 | 99 | |
0c56b1ad | 100 | int rsync_port; |
aef68d78 | 101 | } global_vars; |
0b76cd63 | 102 | |
43eb865f | 103 | /* This structure describes a single section. Their order must match the |
d17c9a44 | 104 | * initializers below, which you can accomplish by keeping each sub-section |
e0a18ce3 | 105 | * sorted. (e.g. in vim, just visually select each subsection and use !sort.) |
43eb865f | 106 | * NOTE: the char* variables MUST all remain at the start of the stuct! */ |
8880d8ec | 107 | typedef struct { |
d17c9a44 | 108 | char *auth_users; |
0b52f94d | 109 | char *charset; |
0b76cd63 | 110 | char *comment; |
d17c9a44 WD |
111 | char *dont_compress; |
112 | char *exclude; | |
113 | char *exclude_from; | |
114 | char *filter; | |
8ef4ffd6 | 115 | char *gid; |
56c473b7 AT |
116 | char *hosts_allow; |
117 | char *hosts_deny; | |
cd64343a DD |
118 | char *include; |
119 | char *include_from; | |
882d8c1c | 120 | char *incoming_chmod; |
d17c9a44 | 121 | char *lock_file; |
d20ce6e1 | 122 | char *log_file; |
e08bfe12 | 123 | char *log_format; |
d17c9a44 | 124 | char *name; |
aaccaa88 | 125 | char *outgoing_chmod; |
d17c9a44 | 126 | char *path; |
bec617b9 | 127 | char *postxfer_exec; |
d17c9a44 WD |
128 | char *prexfer_exec; |
129 | char *refuse_options; | |
130 | char *secrets_file; | |
18cad449 | 131 | char *temp_dir; |
d17c9a44 | 132 | char *uid; |
43eb865f WD |
133 | /* NOTE: update this macro if the last char* variable changes! */ |
134 | #define LOCAL_STRING_COUNT() (offsetof(local_vars, uid) / sizeof (char*) + 1) | |
d17c9a44 | 135 | |
5e71c444 | 136 | int max_connections; |
59b0e7a8 | 137 | int max_verbosity; |
d20ce6e1 | 138 | int syslog_facility; |
d17c9a44 WD |
139 | int timeout; |
140 | ||
9439c0cb | 141 | BOOL fake_super; |
bf4170ad | 142 | BOOL forward_lookup; |
d17c9a44 | 143 | BOOL ignore_errors; |
60cb2f90 | 144 | BOOL ignore_nonreadable; |
d17c9a44 | 145 | BOOL list; |
9585b276 | 146 | BOOL munge_symlinks; |
0b52f94d | 147 | BOOL numeric_ids; |
d17c9a44 | 148 | BOOL read_only; |
11ef77b7 | 149 | BOOL reverse_lookup; |
d17c9a44 WD |
150 | BOOL strict_modes; |
151 | BOOL transfer_logging; | |
152 | BOOL use_chroot; | |
153 | BOOL write_only; | |
aef68d78 | 154 | } local_vars; |
0b76cd63 | 155 | |
78921390 WD |
156 | /* This structure describes the global variables (g) as well as the globally |
157 | * specified values of the local variables (l), which are used when modules | |
158 | * don't specify their own values. */ | |
8a3ddcfc | 159 | typedef struct { |
aef68d78 WD |
160 | global_vars g; |
161 | local_vars l; | |
162 | } all_vars; | |
8a3ddcfc | 163 | |
78921390 WD |
164 | /* The application defaults for all the variables. "Defaults" is |
165 | * used to re-initialize "Vars" before each config-file read. | |
166 | * | |
167 | * In order to keep these sorted in the same way as the structure | |
e0a18ce3 WD |
168 | * above, use the variable name in the leading comment, including a |
169 | * trailing ';' (to avoid a sorting problem with trailing digits). */ | |
243e9a36 WD |
170 | static const all_vars Defaults = { |
171 | /* ==== global_vars ==== */ | |
172 | { | |
173 | /* bind_address; */ NULL, | |
174 | /* motd_file; */ NULL, | |
175 | /* pid_file; */ NULL, | |
176 | /* socket_options; */ NULL, | |
177 | ||
178 | /* rsync_port; */ 0, | |
179 | }, | |
180 | ||
181 | /* ==== local_vars ==== */ | |
182 | { | |
e0a18ce3 | 183 | /* auth_users; */ NULL, |
0b52f94d WD |
184 | /* charset; */ NULL, |
185 | /* comment; */ NULL, | |
4319cc56 | 186 | /* dont_compress; */ DEFAULT_DONT_COMPRESS, |
e0a18ce3 WD |
187 | /* exclude; */ NULL, |
188 | /* exclude_from; */ NULL, | |
189 | /* filter; */ NULL, | |
7f367bb1 | 190 | /* gid; */ NULL, |
e0a18ce3 WD |
191 | /* hosts_allow; */ NULL, |
192 | /* hosts_deny; */ NULL, | |
193 | /* include; */ NULL, | |
194 | /* include_from; */ NULL, | |
882d8c1c | 195 | /* incoming_chmod; */ NULL, |
e0a18ce3 | 196 | /* lock_file; */ DEFAULT_LOCK_FILE, |
d20ce6e1 | 197 | /* log_file; */ NULL, |
e0a18ce3 WD |
198 | /* log_format; */ "%o %h [%a] %m (%u) %f %l", |
199 | /* name; */ NULL, | |
aaccaa88 | 200 | /* outgoing_chmod; */ NULL, |
e0a18ce3 WD |
201 | /* path; */ NULL, |
202 | /* postxfer_exec; */ NULL, | |
203 | /* prexfer_exec; */ NULL, | |
204 | /* refuse_options; */ NULL, | |
205 | /* secrets_file; */ NULL, | |
206 | /* temp_dir; */ NULL, | |
7f367bb1 | 207 | /* uid; */ NULL, |
e0a18ce3 WD |
208 | |
209 | /* max_connections; */ 0, | |
210 | /* max_verbosity; */ 1, | |
d20ce6e1 | 211 | /* syslog_facility; */ LOG_DAEMON, |
e0a18ce3 WD |
212 | /* timeout; */ 0, |
213 | ||
9439c0cb | 214 | /* fake_super; */ False, |
bf4170ad | 215 | /* forward_lookup; */ True, |
e0a18ce3 WD |
216 | /* ignore_errors; */ False, |
217 | /* ignore_nonreadable; */ False, | |
218 | /* list; */ True, | |
9585b276 | 219 | /* munge_symlinks; */ (BOOL)-1, |
0b52f94d | 220 | /* numeric_ids; */ (BOOL)-1, |
e0a18ce3 | 221 | /* read_only; */ True, |
11ef77b7 | 222 | /* reverse_lookup; */ True, |
e0a18ce3 WD |
223 | /* strict_modes; */ True, |
224 | /* transfer_logging; */ False, | |
225 | /* use_chroot; */ True, | |
226 | /* write_only; */ False, | |
243e9a36 | 227 | } |
0b76cd63 AT |
228 | }; |
229 | ||
78921390 WD |
230 | /* The currently configured values for all the variables. */ |
231 | static all_vars Vars; | |
232 | ||
233 | /* Stack of "Vars" values used by the &include directive. */ | |
234 | static item_list Vars_stack = EMPTY_ITEM_LIST; | |
235 | ||
236 | /* The array of section values that holds all the defined modules. */ | |
c9604e21 | 237 | static item_list section_list = EMPTY_ITEM_LIST; |
78921390 | 238 | |
b583594a | 239 | static int iSectionIndex = -1; |
0b76cd63 AT |
240 | static BOOL bInGlobalSection = True; |
241 | ||
8880d8ec | 242 | #define NUMPARAMETERS (sizeof (parm_table) / sizeof (struct parm_struct)) |
0b76cd63 | 243 | |
09e13ae2 AT |
244 | static struct enum_list enum_facilities[] = { |
245 | #ifdef LOG_AUTH | |
246 | { LOG_AUTH, "auth" }, | |
247 | #endif | |
248 | #ifdef LOG_AUTHPRIV | |
249 | { LOG_AUTHPRIV, "authpriv" }, | |
250 | #endif | |
251 | #ifdef LOG_CRON | |
252 | { LOG_CRON, "cron" }, | |
253 | #endif | |
254 | #ifdef LOG_DAEMON | |
255 | { LOG_DAEMON, "daemon" }, | |
256 | #endif | |
257 | #ifdef LOG_FTP | |
258 | { LOG_FTP, "ftp" }, | |
259 | #endif | |
260 | #ifdef LOG_KERN | |
261 | { LOG_KERN, "kern" }, | |
262 | #endif | |
263 | #ifdef LOG_LPR | |
264 | { LOG_LPR, "lpr" }, | |
265 | #endif | |
266 | #ifdef LOG_MAIL | |
267 | { LOG_MAIL, "mail" }, | |
268 | #endif | |
269 | #ifdef LOG_NEWS | |
270 | { LOG_NEWS, "news" }, | |
271 | #endif | |
272 | #ifdef LOG_AUTH | |
6464bdbe | 273 | { LOG_AUTH, "security" }, |
09e13ae2 AT |
274 | #endif |
275 | #ifdef LOG_SYSLOG | |
276 | { LOG_SYSLOG, "syslog" }, | |
277 | #endif | |
278 | #ifdef LOG_USER | |
279 | { LOG_USER, "user" }, | |
280 | #endif | |
281 | #ifdef LOG_UUCP | |
282 | { LOG_UUCP, "uucp" }, | |
283 | #endif | |
284 | #ifdef LOG_LOCAL0 | |
285 | { LOG_LOCAL0, "local0" }, | |
286 | #endif | |
287 | #ifdef LOG_LOCAL1 | |
288 | { LOG_LOCAL1, "local1" }, | |
289 | #endif | |
290 | #ifdef LOG_LOCAL2 | |
291 | { LOG_LOCAL2, "local2" }, | |
292 | #endif | |
293 | #ifdef LOG_LOCAL3 | |
294 | { LOG_LOCAL3, "local3" }, | |
295 | #endif | |
296 | #ifdef LOG_LOCAL4 | |
297 | { LOG_LOCAL4, "local4" }, | |
298 | #endif | |
299 | #ifdef LOG_LOCAL5 | |
300 | { LOG_LOCAL5, "local5" }, | |
301 | #endif | |
302 | #ifdef LOG_LOCAL6 | |
303 | { LOG_LOCAL6, "local6" }, | |
304 | #endif | |
305 | #ifdef LOG_LOCAL7 | |
306 | { LOG_LOCAL7, "local7" }, | |
307 | #endif | |
8880d8ec WD |
308 | { -1, NULL } |
309 | }; | |
09e13ae2 | 310 | |
0b76cd63 AT |
311 | static struct parm_struct parm_table[] = |
312 | { | |
78921390 WD |
313 | {"address", P_STRING, P_GLOBAL,&Vars.g.bind_address, NULL,0}, |
314 | {"motd file", P_STRING, P_GLOBAL,&Vars.g.motd_file, NULL,0}, | |
315 | {"pid file", P_STRING, P_GLOBAL,&Vars.g.pid_file, NULL,0}, | |
316 | {"port", P_INTEGER,P_GLOBAL,&Vars.g.rsync_port, NULL,0}, | |
317 | {"socket options", P_STRING, P_GLOBAL,&Vars.g.socket_options, NULL,0}, | |
318 | ||
319 | {"auth users", P_STRING, P_LOCAL, &Vars.l.auth_users, NULL,0}, | |
320 | {"charset", P_STRING, P_LOCAL, &Vars.l.charset, NULL,0}, | |
321 | {"comment", P_STRING, P_LOCAL, &Vars.l.comment, NULL,0}, | |
322 | {"dont compress", P_STRING, P_LOCAL, &Vars.l.dont_compress, NULL,0}, | |
323 | {"exclude from", P_STRING, P_LOCAL, &Vars.l.exclude_from, NULL,0}, | |
324 | {"exclude", P_STRING, P_LOCAL, &Vars.l.exclude, NULL,0}, | |
325 | {"fake super", P_BOOL, P_LOCAL, &Vars.l.fake_super, NULL,0}, | |
326 | {"filter", P_STRING, P_LOCAL, &Vars.l.filter, NULL,0}, | |
bf4170ad | 327 | {"forward lookup", P_BOOL, P_LOCAL, &Vars.l.forward_lookup, NULL,0}, |
78921390 WD |
328 | {"gid", P_STRING, P_LOCAL, &Vars.l.gid, NULL,0}, |
329 | {"hosts allow", P_STRING, P_LOCAL, &Vars.l.hosts_allow, NULL,0}, | |
330 | {"hosts deny", P_STRING, P_LOCAL, &Vars.l.hosts_deny, NULL,0}, | |
331 | {"ignore errors", P_BOOL, P_LOCAL, &Vars.l.ignore_errors, NULL,0}, | |
332 | {"ignore nonreadable",P_BOOL, P_LOCAL, &Vars.l.ignore_nonreadable, NULL,0}, | |
333 | {"include from", P_STRING, P_LOCAL, &Vars.l.include_from, NULL,0}, | |
334 | {"include", P_STRING, P_LOCAL, &Vars.l.include, NULL,0}, | |
335 | {"incoming chmod", P_STRING, P_LOCAL, &Vars.l.incoming_chmod, NULL,0}, | |
336 | {"list", P_BOOL, P_LOCAL, &Vars.l.list, NULL,0}, | |
337 | {"lock file", P_STRING, P_LOCAL, &Vars.l.lock_file, NULL,0}, | |
338 | {"log file", P_STRING, P_LOCAL, &Vars.l.log_file, NULL,0}, | |
339 | {"log format", P_STRING, P_LOCAL, &Vars.l.log_format, NULL,0}, | |
340 | {"max connections", P_INTEGER,P_LOCAL, &Vars.l.max_connections, NULL,0}, | |
341 | {"max verbosity", P_INTEGER,P_LOCAL, &Vars.l.max_verbosity, NULL,0}, | |
342 | {"munge symlinks", P_BOOL, P_LOCAL, &Vars.l.munge_symlinks, NULL,0}, | |
343 | {"name", P_STRING, P_LOCAL, &Vars.l.name, NULL,0}, | |
344 | {"numeric ids", P_BOOL, P_LOCAL, &Vars.l.numeric_ids, NULL,0}, | |
345 | {"outgoing chmod", P_STRING, P_LOCAL, &Vars.l.outgoing_chmod, NULL,0}, | |
346 | {"path", P_PATH, P_LOCAL, &Vars.l.path, NULL,0}, | |
bec617b9 | 347 | #ifdef HAVE_PUTENV |
78921390 WD |
348 | {"post-xfer exec", P_STRING, P_LOCAL, &Vars.l.postxfer_exec, NULL,0}, |
349 | {"pre-xfer exec", P_STRING, P_LOCAL, &Vars.l.prexfer_exec, NULL,0}, | |
bec617b9 | 350 | #endif |
78921390 WD |
351 | {"read only", P_BOOL, P_LOCAL, &Vars.l.read_only, NULL,0}, |
352 | {"refuse options", P_STRING, P_LOCAL, &Vars.l.refuse_options, NULL,0}, | |
353 | {"reverse lookup", P_BOOL, P_LOCAL, &Vars.l.reverse_lookup, NULL,0}, | |
354 | {"secrets file", P_STRING, P_LOCAL, &Vars.l.secrets_file, NULL,0}, | |
355 | {"strict modes", P_BOOL, P_LOCAL, &Vars.l.strict_modes, NULL,0}, | |
356 | {"syslog facility", P_ENUM, P_LOCAL, &Vars.l.syslog_facility, enum_facilities,0}, | |
357 | {"temp dir", P_PATH, P_LOCAL, &Vars.l.temp_dir, NULL,0}, | |
358 | {"timeout", P_INTEGER,P_LOCAL, &Vars.l.timeout, NULL,0}, | |
359 | {"transfer logging", P_BOOL, P_LOCAL, &Vars.l.transfer_logging, NULL,0}, | |
360 | {"uid", P_STRING, P_LOCAL, &Vars.l.uid, NULL,0}, | |
361 | {"use chroot", P_BOOL, P_LOCAL, &Vars.l.use_chroot, NULL,0}, | |
362 | {"write only", P_BOOL, P_LOCAL, &Vars.l.write_only, NULL,0}, | |
d17c9a44 | 363 | {NULL, P_BOOL, P_NONE, NULL, NULL,0} |
0b76cd63 AT |
364 | }; |
365 | ||
243e9a36 WD |
366 | /* Initialise the Default all_vars structure. */ |
367 | static void reset_all_vars(void) | |
0b76cd63 | 368 | { |
78921390 | 369 | memcpy(&Vars, &Defaults, sizeof Vars); |
0b76cd63 AT |
370 | } |
371 | ||
0a9fbe17 WD |
372 | /* Expand %VAR% references. Any unknown vars or unrecognized |
373 | * syntax leaves the raw chars unchanged. */ | |
374 | static char *expand_vars(char *str) | |
375 | { | |
376 | char *buf, *t, *f; | |
377 | int bufsize; | |
378 | ||
379 | if (strchr(str, '%') == NULL) | |
380 | return str; | |
381 | ||
382 | bufsize = strlen(str) + 2048; | |
383 | if ((buf = new_array(char, bufsize+1)) == NULL) /* +1 for trailing '\0' */ | |
384 | out_of_memory("expand_vars"); | |
385 | ||
386 | for (t = buf, f = str; bufsize && *f; ) { | |
387 | if (*f == '%' && *++f != '%') { | |
388 | char *percent = strchr(f, '%'); | |
389 | if (percent) { | |
390 | char *val; | |
391 | *percent = '\0'; | |
392 | val = getenv(f); | |
393 | *percent = '%'; | |
394 | if (val) { | |
395 | int len = strlcpy(t, val, bufsize+1); | |
396 | if (len > bufsize) | |
397 | break; | |
398 | bufsize -= len; | |
399 | t += len; | |
400 | f = percent + 1; | |
401 | continue; | |
402 | } | |
403 | } | |
404 | f--; | |
405 | } | |
406 | *t++ = *f++; | |
407 | bufsize--; | |
408 | } | |
409 | *t = '\0'; | |
410 | ||
411 | if (*f) { | |
412 | rprintf(FLOG, "Overflowed buf in expand_vars() trying to expand: %s\n", str); | |
413 | exit_cleanup(RERR_MALLOC); | |
414 | } | |
415 | ||
416 | if (bufsize && (buf = realloc(buf, t - buf + 1)) == NULL) | |
417 | out_of_memory("expand_vars"); | |
418 | ||
419 | return buf; | |
420 | } | |
421 | ||
8880d8ec WD |
422 | /* In this section all the functions that are used to access the |
423 | * parameters from the rest of the program are defined. */ | |
424 | ||
425 | #define FN_GLOBAL_STRING(fn_name, ptr) \ | |
0a9fbe17 | 426 | char *fn_name(void) {return expand_vars(*(char **)(ptr) ? *(char **)(ptr) : "");} |
8880d8ec WD |
427 | #define FN_GLOBAL_BOOL(fn_name, ptr) \ |
428 | BOOL fn_name(void) {return *(BOOL *)(ptr);} | |
429 | #define FN_GLOBAL_CHAR(fn_name, ptr) \ | |
430 | char fn_name(void) {return *(char *)(ptr);} | |
431 | #define FN_GLOBAL_INTEGER(fn_name, ptr) \ | |
432 | int fn_name(void) {return *(int *)(ptr);} | |
433 | ||
434 | #define FN_LOCAL_STRING(fn_name, val) \ | |
0a9fbe17 | 435 | char *fn_name(int i) {return expand_vars(LP_SNUM_OK(i) && iSECTION(i).val ? iSECTION(i).val : Vars.l.val ? Vars.l.val : "");} |
8880d8ec | 436 | #define FN_LOCAL_BOOL(fn_name, val) \ |
78921390 | 437 | BOOL fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : Vars.l.val;} |
8880d8ec | 438 | #define FN_LOCAL_CHAR(fn_name, val) \ |
78921390 | 439 | char fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : Vars.l.val;} |
8880d8ec | 440 | #define FN_LOCAL_INTEGER(fn_name, val) \ |
78921390 | 441 | int fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : Vars.l.val;} |
0b76cd63 | 442 | |
78921390 WD |
443 | FN_GLOBAL_STRING(lp_bind_address, &Vars.g.bind_address) |
444 | FN_GLOBAL_STRING(lp_motd_file, &Vars.g.motd_file) | |
445 | FN_GLOBAL_STRING(lp_pid_file, &Vars.g.pid_file) | |
446 | FN_GLOBAL_STRING(lp_socket_options, &Vars.g.socket_options) | |
d17c9a44 | 447 | |
78921390 | 448 | FN_GLOBAL_INTEGER(lp_rsync_port, &Vars.g.rsync_port) |
a6801c39 | 449 | |
d17c9a44 | 450 | FN_LOCAL_STRING(lp_auth_users, auth_users) |
0b52f94d | 451 | FN_LOCAL_STRING(lp_charset, charset) |
0b76cd63 | 452 | FN_LOCAL_STRING(lp_comment, comment) |
d17c9a44 WD |
453 | FN_LOCAL_STRING(lp_dont_compress, dont_compress) |
454 | FN_LOCAL_STRING(lp_exclude, exclude) | |
455 | FN_LOCAL_STRING(lp_exclude_from, exclude_from) | |
456 | FN_LOCAL_STRING(lp_filter, filter) | |
8ef4ffd6 | 457 | FN_LOCAL_STRING(lp_gid, gid) |
56c473b7 AT |
458 | FN_LOCAL_STRING(lp_hosts_allow, hosts_allow) |
459 | FN_LOCAL_STRING(lp_hosts_deny, hosts_deny) | |
cd64343a DD |
460 | FN_LOCAL_STRING(lp_include, include) |
461 | FN_LOCAL_STRING(lp_include_from, include_from) | |
882d8c1c | 462 | FN_LOCAL_STRING(lp_incoming_chmod, incoming_chmod) |
d17c9a44 | 463 | FN_LOCAL_STRING(lp_lock_file, lock_file) |
d20ce6e1 | 464 | FN_LOCAL_STRING(lp_log_file, log_file) |
e08bfe12 | 465 | FN_LOCAL_STRING(lp_log_format, log_format) |
d17c9a44 | 466 | FN_LOCAL_STRING(lp_name, name) |
aaccaa88 | 467 | FN_LOCAL_STRING(lp_outgoing_chmod, outgoing_chmod) |
d17c9a44 | 468 | FN_LOCAL_STRING(lp_path, path) |
bec617b9 | 469 | FN_LOCAL_STRING(lp_postxfer_exec, postxfer_exec) |
d17c9a44 WD |
470 | FN_LOCAL_STRING(lp_prexfer_exec, prexfer_exec) |
471 | FN_LOCAL_STRING(lp_refuse_options, refuse_options) | |
472 | FN_LOCAL_STRING(lp_secrets_file, secrets_file) | |
18cad449 | 473 | FN_LOCAL_STRING(lp_temp_dir, temp_dir) |
d17c9a44 WD |
474 | FN_LOCAL_STRING(lp_uid, uid) |
475 | ||
5e71c444 | 476 | FN_LOCAL_INTEGER(lp_max_connections, max_connections) |
59b0e7a8 | 477 | FN_LOCAL_INTEGER(lp_max_verbosity, max_verbosity) |
0b52f94d | 478 | FN_LOCAL_INTEGER(lp_syslog_facility, syslog_facility) |
d17c9a44 WD |
479 | FN_LOCAL_INTEGER(lp_timeout, timeout) |
480 | ||
9439c0cb | 481 | FN_LOCAL_BOOL(lp_fake_super, fake_super) |
bf4170ad | 482 | FN_LOCAL_BOOL(lp_forward_lookup, forward_lookup) |
d17c9a44 WD |
483 | FN_LOCAL_BOOL(lp_ignore_errors, ignore_errors) |
484 | FN_LOCAL_BOOL(lp_ignore_nonreadable, ignore_nonreadable) | |
485 | FN_LOCAL_BOOL(lp_list, list) | |
9585b276 | 486 | FN_LOCAL_BOOL(lp_munge_symlinks, munge_symlinks) |
0b52f94d | 487 | FN_LOCAL_BOOL(lp_numeric_ids, numeric_ids) |
d17c9a44 | 488 | FN_LOCAL_BOOL(lp_read_only, read_only) |
11ef77b7 | 489 | FN_LOCAL_BOOL(lp_reverse_lookup, reverse_lookup) |
d17c9a44 WD |
490 | FN_LOCAL_BOOL(lp_strict_modes, strict_modes) |
491 | FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging) | |
492 | FN_LOCAL_BOOL(lp_use_chroot, use_chroot) | |
493 | FN_LOCAL_BOOL(lp_write_only, write_only) | |
0b76cd63 | 494 | |
43eb865f WD |
495 | /* Assign a copy of v to *s. Handles NULL strings. We don't worry |
496 | * about overwriting a malloc'd string because the long-running | |
497 | * (port-listening) daemon only loads the config file once, and the | |
498 | * per-job (forked or xinitd-ran) daemon only re-reads the file at | |
499 | * the start, so any lost memory is inconsequential. */ | |
500 | static inline void string_set(char **s, const char *v) | |
0b76cd63 | 501 | { |
43eb865f | 502 | if (!v) |
0b76cd63 | 503 | *s = NULL; |
43eb865f | 504 | else if (!(*s = strdup(v))) |
b53c202e | 505 | out_of_memory("string_set"); |
0b76cd63 AT |
506 | } |
507 | ||
43eb865f WD |
508 | /* Copy the local_vars, strdup'ing any strings. NOTE: this depends on |
509 | * the structure starting with a contiguous list of the char* variables, | |
510 | * and having an accurate count in the LOCAL_STRING_COUNT() macro. */ | |
aef68d78 | 511 | static void copy_section(local_vars *psectionDest, local_vars *psectionSource) |
0b76cd63 | 512 | { |
43eb865f WD |
513 | int count = LOCAL_STRING_COUNT(); |
514 | char **strings = (char**)psectionDest; | |
515 | ||
516 | memcpy(psectionDest, psectionSource, sizeof psectionDest[0]); | |
517 | while (count--) { | |
518 | if (strings[count] && !(strings[count] = strdup(strings[count]))) | |
519 | out_of_memory("copy_section"); | |
36828dae WD |
520 | } |
521 | } | |
0b76cd63 | 522 | |
b583594a | 523 | /* Initialise a section to the defaults. */ |
aef68d78 | 524 | static void init_section(local_vars *psection) |
36828dae | 525 | { |
78921390 WD |
526 | memset(psection, 0, sizeof (local_vars)); |
527 | copy_section(psection, &Vars.l); | |
0b76cd63 AT |
528 | } |
529 | ||
8880d8ec | 530 | /* Do a case-insensitive, whitespace-ignoring string compare. */ |
0b76cd63 AT |
531 | static int strwicmp(char *psz1, char *psz2) |
532 | { | |
8880d8ec WD |
533 | /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */ |
534 | /* appropriate value. */ | |
535 | if (psz1 == psz2) | |
536 | return 0; | |
537 | ||
538 | if (psz1 == NULL) | |
539 | return -1; | |
540 | ||
541 | if (psz2 == NULL) | |
542 | return 1; | |
543 | ||
544 | /* sync the strings on first non-whitespace */ | |
545 | while (1) { | |
546 | while (isSpace(psz1)) | |
547 | psz1++; | |
548 | while (isSpace(psz2)) | |
549 | psz2++; | |
550 | if (toUpper(psz1) != toUpper(psz2) || *psz1 == '\0' || *psz2 == '\0') | |
551 | break; | |
552 | psz1++; | |
553 | psz2++; | |
554 | } | |
555 | return *psz1 - *psz2; | |
0b76cd63 AT |
556 | } |
557 | ||
b583594a | 558 | /* Find a section by name. Otherwise works like get_section. */ |
b53c202e | 559 | static int getsectionbyname(char *name) |
36828dae WD |
560 | { |
561 | int i; | |
562 | ||
c9604e21 | 563 | for (i = section_list.count - 1; i >= 0; i--) { |
b53c202e | 564 | if (strwicmp(iSECTION(i).name, name) == 0) |
36828dae | 565 | break; |
36828dae WD |
566 | } |
567 | ||
568 | return i; | |
569 | } | |
570 | ||
b583594a WD |
571 | /* Add a new section to the sections array w/the default values. */ |
572 | static int add_a_section(char *name) | |
36828dae WD |
573 | { |
574 | int i; | |
aef68d78 | 575 | local_vars *s; |
36828dae WD |
576 | |
577 | /* it might already exist */ | |
578 | if (name) { | |
b53c202e | 579 | i = getsectionbyname(name); |
36828dae WD |
580 | if (i >= 0) |
581 | return i; | |
582 | } | |
583 | ||
c9604e21 | 584 | i = section_list.count; |
aef68d78 | 585 | s = EXPAND_ITEM_LIST(§ion_list, local_vars, 2); |
36828dae | 586 | |
c9604e21 | 587 | init_section(s); |
36828dae | 588 | if (name) |
c9604e21 | 589 | string_set(&s->name, name); |
36828dae WD |
590 | |
591 | return i; | |
592 | } | |
593 | ||
8880d8ec WD |
594 | /* Map a parameter's string representation to something we can use. |
595 | * Returns False if the parameter string is not recognised, else TRUE. */ | |
0b76cd63 AT |
596 | static int map_parameter(char *parmname) |
597 | { | |
8880d8ec | 598 | int iIndex; |
0b76cd63 | 599 | |
8880d8ec WD |
600 | if (*parmname == '-') |
601 | return -1; | |
0b76cd63 | 602 | |
8880d8ec WD |
603 | for (iIndex = 0; parm_table[iIndex].label; iIndex++) { |
604 | if (strwicmp(parm_table[iIndex].label, parmname) == 0) | |
605 | return iIndex; | |
606 | } | |
0b76cd63 | 607 | |
8880d8ec WD |
608 | rprintf(FLOG, "Unknown Parameter encountered: \"%s\"\n", parmname); |
609 | return -1; | |
0b76cd63 AT |
610 | } |
611 | ||
8880d8ec WD |
612 | /* Set a boolean variable from the text value stored in the passed string. |
613 | * Returns True in success, False if the passed string does not correctly | |
614 | * represent a boolean. */ | |
0b76cd63 AT |
615 | static BOOL set_boolean(BOOL *pb, char *parmvalue) |
616 | { | |
8880d8ec WD |
617 | if (strwicmp(parmvalue, "yes") == 0 |
618 | || strwicmp(parmvalue, "true") == 0 | |
619 | || strwicmp(parmvalue, "1") == 0) | |
620 | *pb = True; | |
621 | else if (strwicmp(parmvalue, "no") == 0 | |
622 | || strwicmp(parmvalue, "False") == 0 | |
623 | || strwicmp(parmvalue, "0") == 0) | |
624 | *pb = False; | |
625 | else { | |
626 | rprintf(FLOG, "Badly formed boolean in configuration file: \"%s\".\n", parmvalue); | |
627 | return False; | |
628 | } | |
629 | return True; | |
0b76cd63 AT |
630 | } |
631 | ||
8880d8ec | 632 | /* Process a parameter. */ |
36828dae | 633 | static BOOL do_parameter(char *parmname, char *parmvalue) |
0b76cd63 | 634 | { |
8880d8ec | 635 | int parmnum, i; |
fcd613d6 WD |
636 | void *parm_ptr; /* where we are going to store the result */ |
637 | void *def_ptr; | |
8880d8ec WD |
638 | char *cp; |
639 | ||
640 | parmnum = map_parameter(parmname); | |
641 | ||
642 | if (parmnum < 0) { | |
643 | rprintf(FLOG, "IGNORING unknown parameter \"%s\"\n", parmname); | |
644 | return True; | |
645 | } | |
646 | ||
647 | def_ptr = parm_table[parmnum].ptr; | |
648 | ||
36828dae | 649 | if (bInGlobalSection) |
8880d8ec WD |
650 | parm_ptr = def_ptr; |
651 | else { | |
652 | if (parm_table[parmnum].class == P_GLOBAL) { | |
b583594a | 653 | rprintf(FLOG, "Global parameter %s found in module section!\n", parmname); |
8880d8ec WD |
654 | return True; |
655 | } | |
fcd613d6 | 656 | parm_ptr = SECTION_PTR(&iSECTION(iSectionIndex), def_ptr); |
8880d8ec WD |
657 | } |
658 | ||
659 | /* now switch on the type of variable it is */ | |
0a9fbe17 WD |
660 | switch (parm_table[parmnum].type) { |
661 | case P_PATH: | |
662 | case P_STRING: | |
663 | /* delay expansion of vars */ | |
664 | break; | |
665 | default: | |
666 | /* expand any %VARS% now */ | |
667 | parmvalue = expand_vars(parmvalue); | |
668 | break; | |
669 | } | |
670 | ||
8880d8ec WD |
671 | switch (parm_table[parmnum].type) { |
672 | case P_BOOL: | |
673 | set_boolean(parm_ptr, parmvalue); | |
674 | break; | |
675 | ||
676 | case P_BOOLREV: | |
677 | set_boolean(parm_ptr, parmvalue); | |
678 | *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr; | |
679 | break; | |
680 | ||
681 | case P_INTEGER: | |
682 | *(int *)parm_ptr = atoi(parmvalue); | |
683 | break; | |
684 | ||
685 | case P_CHAR: | |
686 | *(char *)parm_ptr = *parmvalue; | |
687 | break; | |
688 | ||
689 | case P_OCTAL: | |
690 | sscanf(parmvalue, "%o", (int *)parm_ptr); | |
691 | break; | |
692 | ||
693 | case P_PATH: | |
694 | string_set(parm_ptr, parmvalue); | |
695 | if ((cp = *(char**)parm_ptr) != NULL) { | |
696 | int len = strlen(cp); | |
697 | while (len > 1 && cp[len-1] == '/') len--; | |
698 | cp[len] = '\0'; | |
699 | } | |
700 | break; | |
701 | ||
702 | case P_STRING: | |
703 | string_set(parm_ptr, parmvalue); | |
704 | break; | |
705 | ||
8880d8ec | 706 | case P_ENUM: |
fcd613d6 | 707 | for (i=0; parm_table[parmnum].enum_list[i].name; i++) { |
8880d8ec WD |
708 | if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) { |
709 | *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value; | |
710 | break; | |
711 | } | |
712 | } | |
713 | if (!parm_table[parmnum].enum_list[i].name) { | |
714 | if (atoi(parmvalue) > 0) | |
715 | *(int *)parm_ptr = atoi(parmvalue); | |
716 | } | |
717 | break; | |
8880d8ec WD |
718 | } |
719 | ||
720 | return True; | |
0b76cd63 AT |
721 | } |
722 | ||
8880d8ec WD |
723 | /* Process a new section (rsync module). |
724 | * Returns True on success, False on failure. */ | |
0b76cd63 AT |
725 | static BOOL do_section(char *sectionname) |
726 | { | |
8a3ddcfc WD |
727 | BOOL isglobal; |
728 | ||
729 | if (*sectionname == ']') { /* A special push/pop/reset directive from params.c */ | |
730 | bInGlobalSection = 1; | |
731 | if (strcmp(sectionname+1, "push") == 0) { | |
78921390 WD |
732 | all_vars *vp = EXPAND_ITEM_LIST(&Vars_stack, all_vars, 2); |
733 | memcpy(vp, &Vars, sizeof Vars); | |
8a3ddcfc WD |
734 | } else if (strcmp(sectionname+1, "pop") == 0 |
735 | || strcmp(sectionname+1, "reset") == 0) { | |
78921390 WD |
736 | all_vars *vp = ((all_vars*)Vars_stack.items) + Vars_stack.count - 1; |
737 | if (!Vars_stack.count) | |
8a3ddcfc | 738 | return False; |
78921390 | 739 | memcpy(&Vars, vp, sizeof Vars); |
8a3ddcfc | 740 | if (sectionname[1] == 'p') |
78921390 | 741 | Vars_stack.count--; |
8a3ddcfc WD |
742 | } else |
743 | return False; | |
744 | return True; | |
745 | } | |
746 | ||
747 | isglobal = strwicmp(sectionname, GLOBAL_NAME) == 0; | |
8880d8ec | 748 | |
243e9a36 | 749 | /* At the end of the global section, add any --dparam items. */ |
2206abf8 WD |
750 | if (bInGlobalSection && !isglobal) { |
751 | if (!section_list.count) | |
752 | set_dparams(0); | |
2206abf8 | 753 | } |
0b76cd63 | 754 | |
8880d8ec WD |
755 | /* if we've just struck a global section, note the fact. */ |
756 | bInGlobalSection = isglobal; | |
0b76cd63 | 757 | |
8880d8ec WD |
758 | /* check for multiple global sections */ |
759 | if (bInGlobalSection) | |
760 | return True; | |
761 | ||
762 | #if 0 | |
b583594a WD |
763 | /* If we have a current section, tidy it up before moving on. */ |
764 | if (iSectionIndex >= 0) { | |
8880d8ec WD |
765 | /* Add any tidy work as needed ... */ |
766 | if (problem) | |
767 | return False; | |
768 | } | |
769 | #endif | |
770 | ||
771 | if (strchr(sectionname, '/') != NULL) { | |
772 | rprintf(FLOG, "Warning: invalid section name in configuration file: %s\n", sectionname); | |
773 | return False; | |
774 | } | |
775 | ||
b583594a | 776 | if ((iSectionIndex = add_a_section(sectionname)) < 0) { |
8880d8ec | 777 | rprintf(FLOG, "Failed to add a new module\n"); |
36828dae | 778 | bInGlobalSection = True; |
8880d8ec WD |
779 | return False; |
780 | } | |
781 | ||
782 | return True; | |
783 | } | |
784 | ||
b583594a | 785 | /* Load the modules from the config file. Return True on success, |
8880d8ec | 786 | * False on failure. */ |
8a3ddcfc | 787 | int lp_load(char *pszFname, int globals_only) |
0b76cd63 | 788 | { |
f9e940ef | 789 | bInGlobalSection = True; |
6464bdbe | 790 | |
243e9a36 | 791 | reset_all_vars(); |
0b76cd63 | 792 | |
b583594a WD |
793 | /* We get sections first, so have to start 'behind' to make up. */ |
794 | iSectionIndex = -1; | |
fcd613d6 | 795 | return pm_process(pszFname, globals_only ? NULL : do_section, do_parameter); |
0b76cd63 AT |
796 | } |
797 | ||
2206abf8 WD |
798 | BOOL set_dparams(int syntax_check_only) |
799 | { | |
800 | char *equal, *val, **params = dparam_list.items; | |
801 | unsigned j; | |
802 | ||
803 | for (j = 0; j < dparam_list.count; j++) { | |
804 | equal = strchr(params[j], '='); /* options.c verified this */ | |
805 | *equal = '\0'; | |
806 | if (syntax_check_only) { | |
807 | if (map_parameter(params[j]) < 0) { | |
582831a4 | 808 | rprintf(FERROR, "Unknown parameter \"%s\"\n", params[j]); |
2206abf8 WD |
809 | *equal = '='; |
810 | return False; | |
811 | } | |
812 | } else { | |
813 | for (val = equal+1; isSpace(val); val++) {} | |
814 | do_parameter(params[j], val); | |
815 | } | |
816 | *equal = '='; | |
817 | } | |
818 | ||
819 | return True; | |
820 | } | |
821 | ||
b583594a WD |
822 | /* Return the max number of modules (sections). */ |
823 | int lp_num_modules(void) | |
0b76cd63 | 824 | { |
c9604e21 | 825 | return section_list.count; |
0b76cd63 AT |
826 | } |
827 | ||
b583594a | 828 | /* Return the number of the module with the given name, or -1 if it doesn't |
8880d8ec | 829 | * exist. Note that this is a DIFFERENT ANIMAL from the internal function |
b583594a WD |
830 | * getsectionbyname()! This works ONLY if all sections have been loaded, |
831 | * and does not copy the found section. */ | |
0b76cd63 AT |
832 | int lp_number(char *name) |
833 | { | |
8880d8ec | 834 | int i; |
0b76cd63 | 835 | |
c9604e21 | 836 | for (i = section_list.count - 1; i >= 0; i--) { |
8880d8ec WD |
837 | if (strcmp(lp_name(i), name) == 0) |
838 | break; | |
839 | } | |
0b76cd63 | 840 | |
8880d8ec | 841 | return i; |
0b76cd63 | 842 | } |