2 * This program is free software; you can redistribute it and/or modify
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.
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.
12 * You should have received a copy of the GNU General Public License along
13 * with this program; if not, visit the http://fsf.org website.
16 /* This is based on loadparm.c from Samba, written by Andrew Tridgell
17 * and Karl Auer. Some of the changes are:
19 * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
20 * Copyright (C) 2003-2009 Wayne Davison <wayned@samba.org>
25 * This module provides suitable callback functions for the params
26 * module. It builds the internal table of section details which is
27 * then used by the rest of the server.
31 * 1) add it to the global_vars or local_vars structure definition
32 * 2) add it to the parm_table
33 * 3) add it to the list of available functions (eg: using FN_GLOBAL_STRING())
34 * 4) If it's a global then initialise it in init_globals. If a local module
35 * (ie. section) parameter then initialise it in the Locals structure
38 * The configuration file is processed sequentially for speed. For this
39 * reason, there is a fair bit of sequence-dependent code here - ie., code
40 * which assumes that certain things happen before others. In particular, the
41 * code which happens at the boundary between sections is delicately poised,
48 extern item_list dparam_list;
50 #define strequal(a, b) (strcasecmp(a, b)==0)
51 #define BOOLSTR(b) ((b) ? "Yes" : "No")
57 #define DEFAULT_DONT_COMPRESS "*.gz *.zip *.z *.rpm *.deb *.iso *.bz2" \
58 " *.t[gb]z *.7z *.mp[34] *.mov *.avi *.ogg *.jpg *.jpeg"
60 /* the following are used by loadparm for option lists */
62 P_BOOL, P_BOOLREV, P_CHAR, P_INTEGER,
63 P_OCTAL, P_PATH, P_STRING, P_ENUM
67 P_LOCAL, P_GLOBAL, P_NONE
80 struct enum_list *enum_list;
85 #define GLOBAL_NAME "global"
88 /* some helpful bits */
89 #define iSECTION(i) ((local_vars*)section_list.items)[i]
90 #define LP_SNUM_OK(i) ((i) >= 0 && (i) < (int)section_list.count)
91 #define SECTION_PTR(s, p) (((char*)(s)) + (ptrdiff_t)(((char*)(p))-(char*)&Locals))
94 * This structure describes global (ie., server-wide) parameters.
100 char *socket_options;
105 static global_vars Globals;
108 * This structure describes a single section. Their order must match the
109 * initializers below, which you can accomplish by keeping each sub-section
110 * sorted. (e.g. in vim, just visually select each subsection and use !sort.)
125 char *incoming_chmod;
130 char *outgoing_chmod;
134 char *refuse_options;
146 BOOL ignore_nonreadable;
153 BOOL transfer_logging;
163 /* This is a default section used to prime a sections structure. In order
164 * to make these easy to keep sorted in the same way as the variables
165 * above, use the variable name in the leading comment, including a
166 * trailing ';' (to avoid a sorting problem with trailing digits). */
167 static local_vars Locals = {
168 /* auth_users; */ NULL,
171 /* dont_compress; */ DEFAULT_DONT_COMPRESS,
173 /* exclude_from; */ NULL,
175 /* gid; */ NOBODY_GROUP,
176 /* hosts_allow; */ NULL,
177 /* hosts_deny; */ NULL,
179 /* include_from; */ NULL,
180 /* incoming_chmod; */ NULL,
181 /* lock_file; */ DEFAULT_LOCK_FILE,
182 /* log_file; */ NULL,
183 /* log_format; */ "%o %h [%a] %m (%u) %f %l",
185 /* outgoing_chmod; */ NULL,
187 /* postxfer_exec; */ NULL,
188 /* prexfer_exec; */ NULL,
189 /* refuse_options; */ NULL,
190 /* secrets_file; */ NULL,
191 /* temp_dir; */ NULL,
192 /* uid; */ NOBODY_USER,
194 /* max_connections; */ 0,
195 /* max_verbosity; */ 1,
196 /* syslog_facility; */ LOG_DAEMON,
199 /* fake_super; */ False,
200 /* ignore_errors; */ False,
201 /* ignore_nonreadable; */ False,
203 /* munge_symlinks; */ (BOOL)-1,
204 /* numeric_ids; */ (BOOL)-1,
205 /* read_only; */ True,
206 /* reverse_lookup; */ True,
207 /* strict_modes; */ True,
208 /* transfer_logging; */ False,
209 /* use_chroot; */ True,
210 /* write_only; */ False,
213 /* local variables */
214 static item_list section_list = EMPTY_ITEM_LIST;
215 static item_list section_stack = EMPTY_ITEM_LIST;
216 static int iSectionIndex = -1;
217 static BOOL bInGlobalSection = True;
219 #define NUMPARAMETERS (sizeof (parm_table) / sizeof (struct parm_struct))
221 static struct enum_list enum_facilities[] = {
223 { LOG_AUTH, "auth" },
226 { LOG_AUTHPRIV, "authpriv" },
229 { LOG_CRON, "cron" },
232 { LOG_DAEMON, "daemon" },
238 { LOG_KERN, "kern" },
244 { LOG_MAIL, "mail" },
247 { LOG_NEWS, "news" },
250 { LOG_AUTH, "security" },
253 { LOG_SYSLOG, "syslog" },
256 { LOG_USER, "user" },
259 { LOG_UUCP, "uucp" },
262 { LOG_LOCAL0, "local0" },
265 { LOG_LOCAL1, "local1" },
268 { LOG_LOCAL2, "local2" },
271 { LOG_LOCAL3, "local3" },
274 { LOG_LOCAL4, "local4" },
277 { LOG_LOCAL5, "local5" },
280 { LOG_LOCAL6, "local6" },
283 { LOG_LOCAL7, "local7" },
288 static struct parm_struct parm_table[] =
290 {"address", P_STRING, P_GLOBAL,&Globals.bind_address, NULL,0},
291 {"motd file", P_STRING, P_GLOBAL,&Globals.motd_file, NULL,0},
292 {"pid file", P_STRING, P_GLOBAL,&Globals.pid_file, NULL,0},
293 {"port", P_INTEGER,P_GLOBAL,&Globals.rsync_port, NULL,0},
294 {"socket options", P_STRING, P_GLOBAL,&Globals.socket_options, NULL,0},
296 {"auth users", P_STRING, P_LOCAL, &Locals.auth_users, NULL,0},
297 {"charset", P_STRING, P_LOCAL, &Locals.charset, NULL,0},
298 {"comment", P_STRING, P_LOCAL, &Locals.comment, NULL,0},
299 {"dont compress", P_STRING, P_LOCAL, &Locals.dont_compress, NULL,0},
300 {"exclude from", P_STRING, P_LOCAL, &Locals.exclude_from, NULL,0},
301 {"exclude", P_STRING, P_LOCAL, &Locals.exclude, NULL,0},
302 {"fake super", P_BOOL, P_LOCAL, &Locals.fake_super, NULL,0},
303 {"filter", P_STRING, P_LOCAL, &Locals.filter, NULL,0},
304 {"gid", P_STRING, P_LOCAL, &Locals.gid, NULL,0},
305 {"hosts allow", P_STRING, P_LOCAL, &Locals.hosts_allow, NULL,0},
306 {"hosts deny", P_STRING, P_LOCAL, &Locals.hosts_deny, NULL,0},
307 {"ignore errors", P_BOOL, P_LOCAL, &Locals.ignore_errors, NULL,0},
308 {"ignore nonreadable",P_BOOL, P_LOCAL, &Locals.ignore_nonreadable, NULL,0},
309 {"include from", P_STRING, P_LOCAL, &Locals.include_from, NULL,0},
310 {"include", P_STRING, P_LOCAL, &Locals.include, NULL,0},
311 {"incoming chmod", P_STRING, P_LOCAL, &Locals.incoming_chmod, NULL,0},
312 {"list", P_BOOL, P_LOCAL, &Locals.list, NULL,0},
313 {"lock file", P_STRING, P_LOCAL, &Locals.lock_file, NULL,0},
314 {"log file", P_STRING, P_LOCAL, &Locals.log_file, NULL,0},
315 {"log format", P_STRING, P_LOCAL, &Locals.log_format, NULL,0},
316 {"max connections", P_INTEGER,P_LOCAL, &Locals.max_connections, NULL,0},
317 {"max verbosity", P_INTEGER,P_LOCAL, &Locals.max_verbosity, NULL,0},
318 {"munge symlinks", P_BOOL, P_LOCAL, &Locals.munge_symlinks, NULL,0},
319 {"name", P_STRING, P_LOCAL, &Locals.name, NULL,0},
320 {"numeric ids", P_BOOL, P_LOCAL, &Locals.numeric_ids, NULL,0},
321 {"outgoing chmod", P_STRING, P_LOCAL, &Locals.outgoing_chmod, NULL,0},
322 {"path", P_PATH, P_LOCAL, &Locals.path, NULL,0},
324 {"post-xfer exec", P_STRING, P_LOCAL, &Locals.postxfer_exec, NULL,0},
325 {"pre-xfer exec", P_STRING, P_LOCAL, &Locals.prexfer_exec, NULL,0},
327 {"read only", P_BOOL, P_LOCAL, &Locals.read_only, NULL,0},
328 {"refuse options", P_STRING, P_LOCAL, &Locals.refuse_options, NULL,0},
329 {"reverse lookup", P_BOOL, P_LOCAL, &Locals.reverse_lookup, NULL,0},
330 {"secrets file", P_STRING, P_LOCAL, &Locals.secrets_file, NULL,0},
331 {"strict modes", P_BOOL, P_LOCAL, &Locals.strict_modes, NULL,0},
332 {"syslog facility", P_ENUM, P_LOCAL, &Locals.syslog_facility, enum_facilities,0},
333 {"temp dir", P_PATH, P_LOCAL, &Locals.temp_dir, NULL,0},
334 {"timeout", P_INTEGER,P_LOCAL, &Locals.timeout, NULL,0},
335 {"transfer logging", P_BOOL, P_LOCAL, &Locals.transfer_logging, NULL,0},
336 {"uid", P_STRING, P_LOCAL, &Locals.uid, NULL,0},
337 {"use chroot", P_BOOL, P_LOCAL, &Locals.use_chroot, NULL,0},
338 {"write only", P_BOOL, P_LOCAL, &Locals.write_only, NULL,0},
339 {NULL, P_BOOL, P_NONE, NULL, NULL,0}
342 /* Initialise the global parameter structure. */
343 static void init_globals(void)
345 memset(&Globals, 0, sizeof Globals);
348 /* Initialise the Locals parameter structure. */
349 static void init_locals(void)
351 /* Nothing needed yet... */
354 /* In this section all the functions that are used to access the
355 * parameters from the rest of the program are defined. */
357 #define FN_GLOBAL_STRING(fn_name, ptr) \
358 char *fn_name(void) {return *(char **)(ptr) ? *(char **)(ptr) : "";}
359 #define FN_GLOBAL_BOOL(fn_name, ptr) \
360 BOOL fn_name(void) {return *(BOOL *)(ptr);}
361 #define FN_GLOBAL_CHAR(fn_name, ptr) \
362 char fn_name(void) {return *(char *)(ptr);}
363 #define FN_GLOBAL_INTEGER(fn_name, ptr) \
364 int fn_name(void) {return *(int *)(ptr);}
366 #define FN_LOCAL_STRING(fn_name, val) \
367 char *fn_name(int i) {return LP_SNUM_OK(i) && iSECTION(i).val? iSECTION(i).val : (Locals.val? Locals.val : "");}
368 #define FN_LOCAL_BOOL(fn_name, val) \
369 BOOL fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : Locals.val;}
370 #define FN_LOCAL_CHAR(fn_name, val) \
371 char fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : Locals.val;}
372 #define FN_LOCAL_INTEGER(fn_name, val) \
373 int fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : Locals.val;}
375 FN_GLOBAL_STRING(lp_bind_address, &Globals.bind_address)
376 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
377 FN_GLOBAL_STRING(lp_pid_file, &Globals.pid_file)
378 FN_GLOBAL_STRING(lp_socket_options, &Globals.socket_options)
380 FN_GLOBAL_INTEGER(lp_rsync_port, &Globals.rsync_port)
382 FN_LOCAL_STRING(lp_auth_users, auth_users)
383 FN_LOCAL_STRING(lp_charset, charset)
384 FN_LOCAL_STRING(lp_comment, comment)
385 FN_LOCAL_STRING(lp_dont_compress, dont_compress)
386 FN_LOCAL_STRING(lp_exclude, exclude)
387 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
388 FN_LOCAL_STRING(lp_filter, filter)
389 FN_LOCAL_STRING(lp_gid, gid)
390 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
391 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
392 FN_LOCAL_STRING(lp_include, include)
393 FN_LOCAL_STRING(lp_include_from, include_from)
394 FN_LOCAL_STRING(lp_incoming_chmod, incoming_chmod)
395 FN_LOCAL_STRING(lp_lock_file, lock_file)
396 FN_LOCAL_STRING(lp_log_file, log_file)
397 FN_LOCAL_STRING(lp_log_format, log_format)
398 FN_LOCAL_STRING(lp_name, name)
399 FN_LOCAL_STRING(lp_outgoing_chmod, outgoing_chmod)
400 FN_LOCAL_STRING(lp_path, path)
401 FN_LOCAL_STRING(lp_postxfer_exec, postxfer_exec)
402 FN_LOCAL_STRING(lp_prexfer_exec, prexfer_exec)
403 FN_LOCAL_STRING(lp_refuse_options, refuse_options)
404 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
405 FN_LOCAL_STRING(lp_temp_dir, temp_dir)
406 FN_LOCAL_STRING(lp_uid, uid)
408 FN_LOCAL_INTEGER(lp_max_connections, max_connections)
409 FN_LOCAL_INTEGER(lp_max_verbosity, max_verbosity)
410 FN_LOCAL_INTEGER(lp_syslog_facility, syslog_facility)
411 FN_LOCAL_INTEGER(lp_timeout, timeout)
413 FN_LOCAL_BOOL(lp_fake_super, fake_super)
414 FN_LOCAL_BOOL(lp_ignore_errors, ignore_errors)
415 FN_LOCAL_BOOL(lp_ignore_nonreadable, ignore_nonreadable)
416 FN_LOCAL_BOOL(lp_list, list)
417 FN_LOCAL_BOOL(lp_munge_symlinks, munge_symlinks)
418 FN_LOCAL_BOOL(lp_numeric_ids, numeric_ids)
419 FN_LOCAL_BOOL(lp_read_only, read_only)
420 FN_LOCAL_BOOL(lp_reverse_lookup, reverse_lookup)
421 FN_LOCAL_BOOL(lp_strict_modes, strict_modes)
422 FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
423 FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
424 FN_LOCAL_BOOL(lp_write_only, write_only)
426 /* Assign a copy of v to *s. Handles NULL strings. *v must
427 * be initialized when this is called, either to NULL or a malloc'd
430 * FIXME There is a small leak here in that sometimes the existing
431 * value will be dynamically allocated, and the old copy is lost.
432 * However, we can't always deallocate the old value, because in the
433 * case of Locals, it points to a static string. It would be nice
434 * to have either all-strdup'd values, or to never need to free
436 static void string_set(char **s, const char *v)
442 if (!(*s = strdup(v)))
443 out_of_memory("string_set");
446 /* Copy the local_vars, duplicating any strings in the source. */
447 static void copy_section(local_vars *psectionDest, local_vars *psectionSource)
451 for (i = 0; parm_table[i].label; i++) {
452 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
453 void *def_ptr = parm_table[i].ptr;
454 void *src_ptr = SECTION_PTR(psectionSource, def_ptr);
455 void *dest_ptr = SECTION_PTR(psectionDest, def_ptr);
457 switch (parm_table[i].type) {
460 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
466 *(int *)dest_ptr = *(int *)src_ptr;
470 *(char *)dest_ptr = *(char *)src_ptr;
475 string_set(dest_ptr, *(char **)src_ptr);
485 /* Initialise a section to the defaults. */
486 static void init_section(local_vars *psection)
488 memset(psection, 0, sizeof Locals);
489 copy_section(psection, &Locals);
492 /* Do a case-insensitive, whitespace-ignoring string compare. */
493 static int strwicmp(char *psz1, char *psz2)
495 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
496 /* appropriate value. */
506 /* sync the strings on first non-whitespace */
508 while (isSpace(psz1))
510 while (isSpace(psz2))
512 if (toUpper(psz1) != toUpper(psz2) || *psz1 == '\0' || *psz2 == '\0')
517 return *psz1 - *psz2;
520 /* Find a section by name. Otherwise works like get_section. */
521 static int getsectionbyname(char *name)
525 for (i = section_list.count - 1; i >= 0; i--) {
526 if (strwicmp(iSECTION(i).name, name) == 0)
533 /* Add a new section to the sections array w/the default values. */
534 static int add_a_section(char *name)
539 /* it might already exist */
541 i = getsectionbyname(name);
546 i = section_list.count;
547 s = EXPAND_ITEM_LIST(§ion_list, local_vars, 2);
551 string_set(&s->name, name);
556 /* Map a parameter's string representation to something we can use.
557 * Returns False if the parameter string is not recognised, else TRUE. */
558 static int map_parameter(char *parmname)
562 if (*parmname == '-')
565 for (iIndex = 0; parm_table[iIndex].label; iIndex++) {
566 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
570 rprintf(FLOG, "Unknown Parameter encountered: \"%s\"\n", parmname);
574 /* Set a boolean variable from the text value stored in the passed string.
575 * Returns True in success, False if the passed string does not correctly
576 * represent a boolean. */
577 static BOOL set_boolean(BOOL *pb, char *parmvalue)
579 if (strwicmp(parmvalue, "yes") == 0
580 || strwicmp(parmvalue, "true") == 0
581 || strwicmp(parmvalue, "1") == 0)
583 else if (strwicmp(parmvalue, "no") == 0
584 || strwicmp(parmvalue, "False") == 0
585 || strwicmp(parmvalue, "0") == 0)
588 rprintf(FLOG, "Badly formed boolean in configuration file: \"%s\".\n", parmvalue);
594 /* Process a parameter. */
595 static BOOL do_parameter(char *parmname, char *parmvalue)
598 void *parm_ptr; /* where we are going to store the result */
602 parmnum = map_parameter(parmname);
605 rprintf(FLOG, "IGNORING unknown parameter \"%s\"\n", parmname);
609 def_ptr = parm_table[parmnum].ptr;
611 if (bInGlobalSection)
614 if (parm_table[parmnum].class == P_GLOBAL) {
615 rprintf(FLOG, "Global parameter %s found in module section!\n", parmname);
618 parm_ptr = SECTION_PTR(&iSECTION(iSectionIndex), def_ptr);
621 /* now switch on the type of variable it is */
622 switch (parm_table[parmnum].type) {
624 set_boolean(parm_ptr, parmvalue);
628 set_boolean(parm_ptr, parmvalue);
629 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
633 *(int *)parm_ptr = atoi(parmvalue);
637 *(char *)parm_ptr = *parmvalue;
641 sscanf(parmvalue, "%o", (int *)parm_ptr);
645 string_set(parm_ptr, parmvalue);
646 if ((cp = *(char**)parm_ptr) != NULL) {
647 int len = strlen(cp);
648 while (len > 1 && cp[len-1] == '/') len--;
654 string_set(parm_ptr, parmvalue);
658 for (i=0; parm_table[parmnum].enum_list[i].name; i++) {
659 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
660 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
664 if (!parm_table[parmnum].enum_list[i].name) {
665 if (atoi(parmvalue) > 0)
666 *(int *)parm_ptr = atoi(parmvalue);
674 /* Process a new section (rsync module).
675 * Returns True on success, False on failure. */
676 static BOOL do_section(char *sectionname)
680 if (*sectionname == ']') { /* A special push/pop/reset directive from params.c */
681 bInGlobalSection = 1;
682 if (strcmp(sectionname+1, "push") == 0) {
683 all_vars *vp = EXPAND_ITEM_LIST(§ion_stack, all_vars, 2);
684 memcpy(&vp->g, &Globals, sizeof Globals);
685 memcpy(&vp->l, &Locals, sizeof Locals);
686 } else if (strcmp(sectionname+1, "pop") == 0
687 || strcmp(sectionname+1, "reset") == 0) {
688 all_vars *vp = ((all_vars*)section_stack.items) + section_stack.count - 1;
689 if (!section_stack.count)
691 memcpy(&Globals, &vp->g, sizeof Globals);
692 memcpy(&Locals, &vp->l, sizeof Locals);
693 if (sectionname[1] == 'p')
694 section_stack.count--;
700 isglobal = strwicmp(sectionname, GLOBAL_NAME) == 0;
702 /* if we were in a global section then do the local inits */
703 if (bInGlobalSection && !isglobal) {
704 if (!section_list.count)
709 /* if we've just struck a global section, note the fact. */
710 bInGlobalSection = isglobal;
712 /* check for multiple global sections */
713 if (bInGlobalSection)
717 /* If we have a current section, tidy it up before moving on. */
718 if (iSectionIndex >= 0) {
719 /* Add any tidy work as needed ... */
725 if (strchr(sectionname, '/') != NULL) {
726 rprintf(FLOG, "Warning: invalid section name in configuration file: %s\n", sectionname);
730 if ((iSectionIndex = add_a_section(sectionname)) < 0) {
731 rprintf(FLOG, "Failed to add a new module\n");
732 bInGlobalSection = True;
739 /* Load the modules from the config file. Return True on success,
740 * False on failure. */
741 int lp_load(char *pszFname, int globals_only)
743 bInGlobalSection = True;
747 /* We get sections first, so have to start 'behind' to make up. */
749 return pm_process(pszFname, globals_only ? NULL : do_section, do_parameter);
752 BOOL set_dparams(int syntax_check_only)
754 char *equal, *val, **params = dparam_list.items;
757 for (j = 0; j < dparam_list.count; j++) {
758 equal = strchr(params[j], '='); /* options.c verified this */
760 if (syntax_check_only) {
761 if (map_parameter(params[j]) < 0) {
762 rprintf(FERROR, "Unknown parameter \"%s\"\n", params[j]);
767 for (val = equal+1; isSpace(val); val++) {}
768 do_parameter(params[j], val);
776 /* Return the max number of modules (sections). */
777 int lp_num_modules(void)
779 return section_list.count;
782 /* Return the number of the module with the given name, or -1 if it doesn't
783 * exist. Note that this is a DIFFERENT ANIMAL from the internal function
784 * getsectionbyname()! This works ONLY if all sections have been loaded,
785 * and does not copy the found section. */
786 int lp_number(char *name)
790 for (i = section_list.count - 1; i >= 0; i--) {
791 if (strcmp(lp_name(i), name) == 0)