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-2008 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 or section 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 sDefault structure
39 * The configuration file is processed sequentially for speed. For this
40 * reason, there is a fair bit of sequence-dependent code here - ie., code
41 * which assumes that certain things happen before others. In particular, the
42 * code which happens at the boundary between sections is delicately poised,
48 #define PTR_DIFF(p1, p2) ((ptrdiff_t)(((char *)(p1)) - (char *)(p2)))
49 #define strequal(a, b) (strcasecmp(a, b)==0)
50 #define BOOLSTR(b) ((b) ? "Yes" : "No")
51 typedef char pstring[1024];
52 #define pstrcpy(a, b) strlcpy((a), (b), sizeof (pstring))
58 #define DEFAULT_DONT_COMPRESS "*.gz *.zip *.z *.rpm *.deb *.iso *.bz2" \
59 " *.t[gb]z *.7z *.mp[34] *.mov *.avi *.ogg *.jpg *.jpeg"
61 /* the following are used by loadparm for option lists */
63 P_BOOL, P_BOOLREV, P_CHAR, P_INTEGER, P_OCTAL,
64 P_PATH, P_STRING, P_GSTRING, P_ENUM, P_SEP
68 P_LOCAL, P_GLOBAL, P_SEPARATOR, P_NONE
81 struct enum_list *enum_list;
86 #define GLOBAL_NAME "global"
89 /* some helpful bits */
90 #define iSECTION(i) ((section*)section_list.items)[i]
91 #define LP_SNUM_OK(i) ((i) >= 0 && (i) < (int)section_list.count)
94 * This structure describes global (ie., server-wide) parameters.
100 char *socket_options;
105 static global 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;
152 BOOL transfer_logging;
160 } global_and_section;
162 /* This is a default section used to prime a sections structure. In order
163 * to make these easy to keep sorted in the same way as the variables
164 * above, use the variable name in the leading comment, including a
165 * trailing ';' (to avoid a sorting problem with trailing digits). */
166 static section sDefault = {
167 /* auth_users; */ NULL,
170 /* dont_compress; */ DEFAULT_DONT_COMPRESS,
172 /* exclude_from; */ NULL,
174 /* gid; */ NOBODY_GROUP,
175 /* hosts_allow; */ NULL,
176 /* hosts_deny; */ NULL,
178 /* include_from; */ NULL,
179 /* incoming_chmod; */ NULL,
180 /* lock_file; */ DEFAULT_LOCK_FILE,
181 /* log_file; */ NULL,
182 /* log_format; */ "%o %h [%a] %m (%u) %f %l",
184 /* outgoing_chmod; */ NULL,
186 /* postxfer_exec; */ NULL,
187 /* prexfer_exec; */ NULL,
188 /* refuse_options; */ NULL,
189 /* secrets_file; */ NULL,
190 /* temp_dir; */ NULL,
191 /* uid; */ NOBODY_USER,
193 /* max_connections; */ 0,
194 /* max_verbosity; */ 1,
195 /* syslog_facility; */ LOG_DAEMON,
198 /* fake_super; */ False,
199 /* ignore_errors; */ False,
200 /* ignore_nonreadable; */ False,
202 /* munge_symlinks; */ (BOOL)-1,
203 /* numeric_ids; */ (BOOL)-1,
204 /* read_only; */ True,
205 /* strict_modes; */ True,
206 /* transfer_logging; */ False,
207 /* use_chroot; */ True,
208 /* write_only; */ False,
211 /* local variables */
212 static item_list section_list = EMPTY_ITEM_LIST;
213 static item_list section_stack = EMPTY_ITEM_LIST;
214 static int iSectionIndex = -1;
215 static BOOL bInGlobalSection = True;
217 #define NUMPARAMETERS (sizeof (parm_table) / sizeof (struct parm_struct))
219 static struct enum_list enum_facilities[] = {
221 { LOG_AUTH, "auth" },
224 { LOG_AUTHPRIV, "authpriv" },
227 { LOG_CRON, "cron" },
230 { LOG_DAEMON, "daemon" },
236 { LOG_KERN, "kern" },
242 { LOG_MAIL, "mail" },
245 { LOG_NEWS, "news" },
248 { LOG_AUTH, "security" },
251 { LOG_SYSLOG, "syslog" },
254 { LOG_USER, "user" },
257 { LOG_UUCP, "uucp" },
260 { LOG_LOCAL0, "local0" },
263 { LOG_LOCAL1, "local1" },
266 { LOG_LOCAL2, "local2" },
269 { LOG_LOCAL3, "local3" },
272 { LOG_LOCAL4, "local4" },
275 { LOG_LOCAL5, "local5" },
278 { LOG_LOCAL6, "local6" },
281 { LOG_LOCAL7, "local7" },
287 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
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, &sDefault.auth_users, NULL,0},
297 {"charset", P_STRING, P_LOCAL, &sDefault.charset, NULL,0},
298 {"comment", P_STRING, P_LOCAL, &sDefault.comment, NULL,0},
299 {"dont compress", P_STRING, P_LOCAL, &sDefault.dont_compress, NULL,0},
300 {"exclude from", P_STRING, P_LOCAL, &sDefault.exclude_from, NULL,0},
301 {"exclude", P_STRING, P_LOCAL, &sDefault.exclude, NULL,0},
302 {"fake super", P_BOOL, P_LOCAL, &sDefault.fake_super, NULL,0},
303 {"filter", P_STRING, P_LOCAL, &sDefault.filter, NULL,0},
304 {"gid", P_STRING, P_LOCAL, &sDefault.gid, NULL,0},
305 {"hosts allow", P_STRING, P_LOCAL, &sDefault.hosts_allow, NULL,0},
306 {"hosts deny", P_STRING, P_LOCAL, &sDefault.hosts_deny, NULL,0},
307 {"ignore errors", P_BOOL, P_LOCAL, &sDefault.ignore_errors, NULL,0},
308 {"ignore nonreadable",P_BOOL, P_LOCAL, &sDefault.ignore_nonreadable,NULL,0},
309 {"include from", P_STRING, P_LOCAL, &sDefault.include_from, NULL,0},
310 {"include", P_STRING, P_LOCAL, &sDefault.include, NULL,0},
311 {"incoming chmod", P_STRING, P_LOCAL, &sDefault.incoming_chmod, NULL,0},
312 {"list", P_BOOL, P_LOCAL, &sDefault.list, NULL,0},
313 {"lock file", P_STRING, P_LOCAL, &sDefault.lock_file, NULL,0},
314 {"log file", P_STRING, P_LOCAL, &sDefault.log_file, NULL,0},
315 {"log format", P_STRING, P_LOCAL, &sDefault.log_format, NULL,0},
316 {"max connections", P_INTEGER,P_LOCAL, &sDefault.max_connections, NULL,0},
317 {"max verbosity", P_INTEGER,P_LOCAL, &sDefault.max_verbosity, NULL,0},
318 {"munge symlinks", P_BOOL, P_LOCAL, &sDefault.munge_symlinks, NULL,0},
319 {"name", P_STRING, P_LOCAL, &sDefault.name, NULL,0},
320 {"numeric ids", P_BOOL, P_LOCAL, &sDefault.numeric_ids, NULL,0},
321 {"outgoing chmod", P_STRING, P_LOCAL, &sDefault.outgoing_chmod, NULL,0},
322 {"path", P_PATH, P_LOCAL, &sDefault.path, NULL,0},
324 {"post-xfer exec", P_STRING, P_LOCAL, &sDefault.postxfer_exec, NULL,0},
325 {"pre-xfer exec", P_STRING, P_LOCAL, &sDefault.prexfer_exec, NULL,0},
327 {"read only", P_BOOL, P_LOCAL, &sDefault.read_only, NULL,0},
328 {"refuse options", P_STRING, P_LOCAL, &sDefault.refuse_options, NULL,0},
329 {"secrets file", P_STRING, P_LOCAL, &sDefault.secrets_file, NULL,0},
330 {"strict modes", P_BOOL, P_LOCAL, &sDefault.strict_modes, NULL,0},
331 {"syslog facility", P_ENUM, P_LOCAL, &sDefault.syslog_facility,enum_facilities,0},
332 {"temp dir", P_PATH, P_LOCAL, &sDefault.temp_dir, NULL,0},
333 {"timeout", P_INTEGER,P_LOCAL, &sDefault.timeout, NULL,0},
334 {"transfer logging", P_BOOL, P_LOCAL, &sDefault.transfer_logging, NULL,0},
335 {"uid", P_STRING, P_LOCAL, &sDefault.uid, NULL,0},
336 {"use chroot", P_BOOL, P_LOCAL, &sDefault.use_chroot, NULL,0},
337 {"write only", P_BOOL, P_LOCAL, &sDefault.write_only, NULL,0},
338 {NULL, P_BOOL, P_NONE, NULL, NULL,0}
341 /* Initialise the global parameter structure. */
342 static void init_globals(void)
344 memset(&Globals, 0, sizeof Globals);
347 /* Initialise the sDefault parameter structure. */
348 static void init_locals(void)
350 /* Nothing needed yet... */
353 /* In this section all the functions that are used to access the
354 * parameters from the rest of the program are defined. */
356 #define FN_GLOBAL_STRING(fn_name, ptr) \
357 char *fn_name(void) {return *(char **)(ptr) ? *(char **)(ptr) : "";}
358 #define FN_GLOBAL_BOOL(fn_name, ptr) \
359 BOOL fn_name(void) {return *(BOOL *)(ptr);}
360 #define FN_GLOBAL_CHAR(fn_name, ptr) \
361 char fn_name(void) {return *(char *)(ptr);}
362 #define FN_GLOBAL_INTEGER(fn_name, ptr) \
363 int fn_name(void) {return *(int *)(ptr);}
365 #define FN_LOCAL_STRING(fn_name, val) \
366 char *fn_name(int i) {return LP_SNUM_OK(i) && iSECTION(i).val? iSECTION(i).val : (sDefault.val? sDefault.val : "");}
367 #define FN_LOCAL_BOOL(fn_name, val) \
368 BOOL fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : sDefault.val;}
369 #define FN_LOCAL_CHAR(fn_name, val) \
370 char fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : sDefault.val;}
371 #define FN_LOCAL_INTEGER(fn_name, val) \
372 int fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : sDefault.val;}
374 FN_GLOBAL_STRING(lp_bind_address, &Globals.bind_address)
375 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
376 FN_GLOBAL_STRING(lp_pid_file, &Globals.pid_file)
377 FN_GLOBAL_STRING(lp_socket_options, &Globals.socket_options)
379 FN_GLOBAL_INTEGER(lp_rsync_port, &Globals.rsync_port)
381 FN_LOCAL_STRING(lp_auth_users, auth_users)
382 FN_LOCAL_STRING(lp_charset, charset)
383 FN_LOCAL_STRING(lp_comment, comment)
384 FN_LOCAL_STRING(lp_dont_compress, dont_compress)
385 FN_LOCAL_STRING(lp_exclude, exclude)
386 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
387 FN_LOCAL_STRING(lp_filter, filter)
388 FN_LOCAL_STRING(lp_gid, gid)
389 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
390 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
391 FN_LOCAL_STRING(lp_include, include)
392 FN_LOCAL_STRING(lp_include_from, include_from)
393 FN_LOCAL_STRING(lp_incoming_chmod, incoming_chmod)
394 FN_LOCAL_STRING(lp_lock_file, lock_file)
395 FN_LOCAL_STRING(lp_log_file, log_file)
396 FN_LOCAL_STRING(lp_log_format, log_format)
397 FN_LOCAL_STRING(lp_name, name)
398 FN_LOCAL_STRING(lp_outgoing_chmod, outgoing_chmod)
399 FN_LOCAL_STRING(lp_path, path)
400 FN_LOCAL_STRING(lp_postxfer_exec, postxfer_exec)
401 FN_LOCAL_STRING(lp_prexfer_exec, prexfer_exec)
402 FN_LOCAL_STRING(lp_refuse_options, refuse_options)
403 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
404 FN_LOCAL_STRING(lp_temp_dir, temp_dir)
405 FN_LOCAL_STRING(lp_uid, uid)
407 FN_LOCAL_INTEGER(lp_max_connections, max_connections)
408 FN_LOCAL_INTEGER(lp_max_verbosity, max_verbosity)
409 FN_LOCAL_INTEGER(lp_syslog_facility, syslog_facility)
410 FN_LOCAL_INTEGER(lp_timeout, timeout)
412 FN_LOCAL_BOOL(lp_fake_super, fake_super)
413 FN_LOCAL_BOOL(lp_ignore_errors, ignore_errors)
414 FN_LOCAL_BOOL(lp_ignore_nonreadable, ignore_nonreadable)
415 FN_LOCAL_BOOL(lp_list, list)
416 FN_LOCAL_BOOL(lp_munge_symlinks, munge_symlinks)
417 FN_LOCAL_BOOL(lp_numeric_ids, numeric_ids)
418 FN_LOCAL_BOOL(lp_read_only, read_only)
419 FN_LOCAL_BOOL(lp_strict_modes, strict_modes)
420 FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
421 FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
422 FN_LOCAL_BOOL(lp_write_only, write_only)
424 /* Assign a copy of v to *s. Handles NULL strings. *v must
425 * be initialized when this is called, either to NULL or a malloc'd
428 * FIXME There is a small leak here in that sometimes the existing
429 * value will be dynamically allocated, and the old copy is lost.
430 * However, we can't always deallocate the old value, because in the
431 * case of sDefault, it points to a static string. It would be nice
432 * to have either all-strdup'd values, or to never need to free
434 static void string_set(char **s, const char *v)
440 if (!(*s = strdup(v)))
441 exit_cleanup(RERR_MALLOC);
444 /* Copy a section structure to another. */
445 static void copy_section(section *psectionDest, section *psectionSource)
449 for (i = 0; parm_table[i].label; i++) {
450 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
451 void *def_ptr = parm_table[i].ptr;
452 void *src_ptr = ((char *)psectionSource) + PTR_DIFF(def_ptr, &sDefault);
453 void *dest_ptr = ((char *)psectionDest) + PTR_DIFF(def_ptr, &sDefault);
455 switch (parm_table[i].type) {
458 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
464 *(int *)dest_ptr = *(int *)src_ptr;
468 *(char *)dest_ptr = *(char *)src_ptr;
473 string_set(dest_ptr, *(char **)src_ptr);
483 /* Initialise a section to the defaults. */
484 static void init_section(section *psection)
486 memset((char *)psection, 0, sizeof (section));
487 copy_section(psection, &sDefault);
490 /* Do a case-insensitive, whitespace-ignoring string compare. */
491 static int strwicmp(char *psz1, char *psz2)
493 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
494 /* appropriate value. */
504 /* sync the strings on first non-whitespace */
506 while (isSpace(psz1))
508 while (isSpace(psz2))
510 if (toUpper(psz1) != toUpper(psz2) || *psz1 == '\0' || *psz2 == '\0')
515 return *psz1 - *psz2;
518 /* Find a section by name. Otherwise works like get_section. */
519 static int getsectionbyname(char *name, section *psectionDest)
523 for (i = section_list.count - 1; i >= 0; i--) {
524 if (strwicmp(iSECTION(i).name, name) == 0) {
525 if (psectionDest != NULL)
526 copy_section(psectionDest, &iSECTION(i));
534 /* Add a new section to the sections array w/the default values. */
535 static int add_a_section(char *name)
540 /* it might already exist */
542 i = getsectionbyname(name, NULL);
547 i = section_list.count;
548 s = EXPAND_ITEM_LIST(§ion_list, section, 2);
552 string_set(&s->name, name);
557 /* Map a parameter's string representation to something we can use.
558 * Returns False if the parameter string is not recognised, else TRUE. */
559 static int map_parameter(char *parmname)
563 if (*parmname == '-')
566 for (iIndex = 0; parm_table[iIndex].label; iIndex++) {
567 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
571 rprintf(FLOG, "Unknown Parameter encountered: \"%s\"\n", parmname);
575 /* Set a boolean variable from the text value stored in the passed string.
576 * Returns True in success, False if the passed string does not correctly
577 * represent a boolean. */
578 static BOOL set_boolean(BOOL *pb, char *parmvalue)
580 if (strwicmp(parmvalue, "yes") == 0
581 || strwicmp(parmvalue, "true") == 0
582 || strwicmp(parmvalue, "1") == 0)
584 else if (strwicmp(parmvalue, "no") == 0
585 || strwicmp(parmvalue, "False") == 0
586 || strwicmp(parmvalue, "0") == 0)
589 rprintf(FLOG, "Badly formed boolean in configuration file: \"%s\".\n", parmvalue);
595 /* Process a parameter. */
596 static BOOL do_parameter(char *parmname, char *parmvalue)
599 void *parm_ptr=NULL; /* where we are going to store the result */
603 parmnum = map_parameter(parmname);
606 rprintf(FLOG, "IGNORING unknown parameter \"%s\"\n", parmname);
610 def_ptr = parm_table[parmnum].ptr;
612 if (bInGlobalSection)
615 if (parm_table[parmnum].class == P_GLOBAL) {
616 rprintf(FLOG, "Global parameter %s found in module section!\n", parmname);
619 parm_ptr = ((char *)&iSECTION(iSectionIndex)) + PTR_DIFF(def_ptr, &sDefault);
622 /* now switch on the type of variable it is */
623 switch (parm_table[parmnum].type) {
625 set_boolean(parm_ptr, parmvalue);
629 set_boolean(parm_ptr, parmvalue);
630 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
634 *(int *)parm_ptr = atoi(parmvalue);
638 *(char *)parm_ptr = *parmvalue;
642 sscanf(parmvalue, "%o", (int *)parm_ptr);
646 string_set(parm_ptr, parmvalue);
647 if ((cp = *(char**)parm_ptr) != NULL) {
648 int len = strlen(cp);
649 while (len > 1 && cp[len-1] == '/') len--;
655 string_set(parm_ptr, parmvalue);
659 strlcpy((char *)parm_ptr, parmvalue, sizeof (pstring));
663 for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
664 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
665 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
669 if (!parm_table[parmnum].enum_list[i].name) {
670 if (atoi(parmvalue) > 0)
671 *(int *)parm_ptr = atoi(parmvalue);
681 /* Process a new section (rsync module).
682 * Returns True on success, False on failure. */
683 static BOOL do_section(char *sectionname)
687 if (*sectionname == ']') { /* A special push/pop/reset directive from params.c */
688 bInGlobalSection = 1;
689 if (strcmp(sectionname+1, "push") == 0) {
690 global_and_section *gs = EXPAND_ITEM_LIST(§ion_stack, global_and_section, 2);
691 memcpy(&gs->g, &Globals, sizeof Globals);
692 memcpy(&gs->s, &sDefault, sizeof sDefault);
693 } else if (strcmp(sectionname+1, "pop") == 0
694 || strcmp(sectionname+1, "reset") == 0) {
695 global_and_section *gs = ((global_and_section *)section_stack.items) + section_stack.count - 1;
696 if (!section_stack.count)
698 memcpy(&Globals, &gs->g, sizeof Globals);
699 memcpy(&sDefault, &gs->s, sizeof sDefault);
700 if (sectionname[1] == 'p')
701 section_stack.count--;
707 isglobal = strwicmp(sectionname, GLOBAL_NAME) == 0;
709 /* if we were in a global section then do the local inits */
710 if (bInGlobalSection && !isglobal)
713 /* if we've just struck a global section, note the fact. */
714 bInGlobalSection = isglobal;
716 /* check for multiple global sections */
717 if (bInGlobalSection)
721 /* If we have a current section, tidy it up before moving on. */
722 if (iSectionIndex >= 0) {
723 /* Add any tidy work as needed ... */
729 if (strchr(sectionname, '/') != NULL) {
730 rprintf(FLOG, "Warning: invalid section name in configuration file: %s\n", sectionname);
734 if ((iSectionIndex = add_a_section(sectionname)) < 0) {
735 rprintf(FLOG, "Failed to add a new module\n");
736 bInGlobalSection = True;
743 /* Load the modules from the config file. Return True on success,
744 * False on failure. */
745 int lp_load(char *pszFname, int globals_only)
749 bInGlobalSection = True;
753 pstrcpy(n2, pszFname);
755 /* We get sections first, so have to start 'behind' to make up. */
757 return pm_process(n2, globals_only ? NULL : do_section, do_parameter);
760 /* Return the max number of modules (sections). */
761 int lp_num_modules(void)
763 return section_list.count;
766 /* Return the number of the module with the given name, or -1 if it doesn't
767 * exist. Note that this is a DIFFERENT ANIMAL from the internal function
768 * getsectionbyname()! This works ONLY if all sections have been loaded,
769 * and does not copy the found section. */
770 int lp_number(char *name)
774 for (i = section_list.count - 1; i >= 0; i--) {
775 if (strcmp(lp_name(i), name) == 0)