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,
49 extern item_list dparam_list;
51 #define strequal(a, b) (strcasecmp(a, b)==0)
52 #define BOOLSTR(b) ((b) ? "Yes" : "No")
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,
64 P_OCTAL, P_PATH, P_STRING, P_ENUM
68 P_LOCAL, P_GLOBAL, 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)
92 #define SECTION_PTR(s, p) (((char*)(s)) + (ptrdiff_t)(((char *)(p)) - (char *)&sDefault))
95 * This structure describes global (ie., server-wide) parameters.
101 char *socket_options;
106 static global Globals;
109 * This structure describes a single section. Their order must match the
110 * initializers below, which you can accomplish by keeping each sub-section
111 * sorted. (e.g. in vim, just visually select each subsection and use !sort.)
126 char *incoming_chmod;
131 char *outgoing_chmod;
135 char *refuse_options;
147 BOOL ignore_nonreadable;
153 BOOL transfer_logging;
161 } global_and_section;
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 section sDefault = {
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 /* strict_modes; */ True,
207 /* transfer_logging; */ False,
208 /* use_chroot; */ True,
209 /* write_only; */ False,
212 /* local variables */
213 static item_list section_list = EMPTY_ITEM_LIST;
214 static item_list section_stack = EMPTY_ITEM_LIST;
215 static int iSectionIndex = -1;
216 static BOOL bInGlobalSection = True;
218 #define NUMPARAMETERS (sizeof (parm_table) / sizeof (struct parm_struct))
220 static struct enum_list enum_facilities[] = {
222 { LOG_AUTH, "auth" },
225 { LOG_AUTHPRIV, "authpriv" },
228 { LOG_CRON, "cron" },
231 { LOG_DAEMON, "daemon" },
237 { LOG_KERN, "kern" },
243 { LOG_MAIL, "mail" },
246 { LOG_NEWS, "news" },
249 { LOG_AUTH, "security" },
252 { LOG_SYSLOG, "syslog" },
255 { LOG_USER, "user" },
258 { LOG_UUCP, "uucp" },
261 { LOG_LOCAL0, "local0" },
264 { LOG_LOCAL1, "local1" },
267 { LOG_LOCAL2, "local2" },
270 { LOG_LOCAL3, "local3" },
273 { LOG_LOCAL4, "local4" },
276 { LOG_LOCAL5, "local5" },
279 { LOG_LOCAL6, "local6" },
282 { LOG_LOCAL7, "local7" },
288 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
289 static struct parm_struct parm_table[] =
291 {"address", P_STRING, P_GLOBAL,&Globals.bind_address, NULL,0},
292 {"motd file", P_STRING, P_GLOBAL,&Globals.motd_file, NULL,0},
293 {"pid file", P_STRING, P_GLOBAL,&Globals.pid_file, NULL,0},
294 {"port", P_INTEGER,P_GLOBAL,&Globals.rsync_port, NULL,0},
295 {"socket options", P_STRING, P_GLOBAL,&Globals.socket_options, NULL,0},
297 {"auth users", P_STRING, P_LOCAL, &sDefault.auth_users, NULL,0},
298 {"charset", P_STRING, P_LOCAL, &sDefault.charset, NULL,0},
299 {"comment", P_STRING, P_LOCAL, &sDefault.comment, NULL,0},
300 {"dont compress", P_STRING, P_LOCAL, &sDefault.dont_compress, NULL,0},
301 {"exclude from", P_STRING, P_LOCAL, &sDefault.exclude_from, NULL,0},
302 {"exclude", P_STRING, P_LOCAL, &sDefault.exclude, NULL,0},
303 {"fake super", P_BOOL, P_LOCAL, &sDefault.fake_super, NULL,0},
304 {"filter", P_STRING, P_LOCAL, &sDefault.filter, NULL,0},
305 {"gid", P_STRING, P_LOCAL, &sDefault.gid, NULL,0},
306 {"hosts allow", P_STRING, P_LOCAL, &sDefault.hosts_allow, NULL,0},
307 {"hosts deny", P_STRING, P_LOCAL, &sDefault.hosts_deny, NULL,0},
308 {"ignore errors", P_BOOL, P_LOCAL, &sDefault.ignore_errors, NULL,0},
309 {"ignore nonreadable",P_BOOL, P_LOCAL, &sDefault.ignore_nonreadable,NULL,0},
310 {"include from", P_STRING, P_LOCAL, &sDefault.include_from, NULL,0},
311 {"include", P_STRING, P_LOCAL, &sDefault.include, NULL,0},
312 {"incoming chmod", P_STRING, P_LOCAL, &sDefault.incoming_chmod, NULL,0},
313 {"list", P_BOOL, P_LOCAL, &sDefault.list, NULL,0},
314 {"lock file", P_STRING, P_LOCAL, &sDefault.lock_file, NULL,0},
315 {"log file", P_STRING, P_LOCAL, &sDefault.log_file, NULL,0},
316 {"log format", P_STRING, P_LOCAL, &sDefault.log_format, NULL,0},
317 {"max connections", P_INTEGER,P_LOCAL, &sDefault.max_connections, NULL,0},
318 {"max verbosity", P_INTEGER,P_LOCAL, &sDefault.max_verbosity, NULL,0},
319 {"munge symlinks", P_BOOL, P_LOCAL, &sDefault.munge_symlinks, NULL,0},
320 {"name", P_STRING, P_LOCAL, &sDefault.name, NULL,0},
321 {"numeric ids", P_BOOL, P_LOCAL, &sDefault.numeric_ids, NULL,0},
322 {"outgoing chmod", P_STRING, P_LOCAL, &sDefault.outgoing_chmod, NULL,0},
323 {"path", P_PATH, P_LOCAL, &sDefault.path, NULL,0},
325 {"post-xfer exec", P_STRING, P_LOCAL, &sDefault.postxfer_exec, NULL,0},
326 {"pre-xfer exec", P_STRING, P_LOCAL, &sDefault.prexfer_exec, NULL,0},
328 {"read only", P_BOOL, P_LOCAL, &sDefault.read_only, NULL,0},
329 {"refuse options", P_STRING, P_LOCAL, &sDefault.refuse_options, NULL,0},
330 {"secrets file", P_STRING, P_LOCAL, &sDefault.secrets_file, NULL,0},
331 {"strict modes", P_BOOL, P_LOCAL, &sDefault.strict_modes, NULL,0},
332 {"syslog facility", P_ENUM, P_LOCAL, &sDefault.syslog_facility,enum_facilities,0},
333 {"temp dir", P_PATH, P_LOCAL, &sDefault.temp_dir, NULL,0},
334 {"timeout", P_INTEGER,P_LOCAL, &sDefault.timeout, NULL,0},
335 {"transfer logging", P_BOOL, P_LOCAL, &sDefault.transfer_logging, NULL,0},
336 {"uid", P_STRING, P_LOCAL, &sDefault.uid, NULL,0},
337 {"use chroot", P_BOOL, P_LOCAL, &sDefault.use_chroot, NULL,0},
338 {"write only", P_BOOL, P_LOCAL, &sDefault.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 sDefault 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 : (sDefault.val? sDefault.val : "");}
368 #define FN_LOCAL_BOOL(fn_name, val) \
369 BOOL fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : sDefault.val;}
370 #define FN_LOCAL_CHAR(fn_name, val) \
371 char fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : sDefault.val;}
372 #define FN_LOCAL_INTEGER(fn_name, val) \
373 int fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : sDefault.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_strict_modes, strict_modes)
421 FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
422 FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
423 FN_LOCAL_BOOL(lp_write_only, write_only)
425 /* Assign a copy of v to *s. Handles NULL strings. *v must
426 * be initialized when this is called, either to NULL or a malloc'd
429 * FIXME There is a small leak here in that sometimes the existing
430 * value will be dynamically allocated, and the old copy is lost.
431 * However, we can't always deallocate the old value, because in the
432 * case of sDefault, it points to a static string. It would be nice
433 * to have either all-strdup'd values, or to never need to free
435 static void string_set(char **s, const char *v)
441 if (!(*s = strdup(v)))
442 exit_cleanup(RERR_MALLOC);
445 /* Copy a section structure to another. */
446 static void copy_section(section *psectionDest, section *psectionSource)
450 for (i = 0; parm_table[i].label; i++) {
451 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
452 void *def_ptr = parm_table[i].ptr;
453 void *src_ptr = SECTION_PTR(psectionSource, def_ptr);
454 void *dest_ptr = SECTION_PTR(psectionDest, def_ptr);
456 switch (parm_table[i].type) {
459 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
465 *(int *)dest_ptr = *(int *)src_ptr;
469 *(char *)dest_ptr = *(char *)src_ptr;
474 string_set(dest_ptr, *(char **)src_ptr);
484 /* Initialise a section to the defaults. */
485 static void init_section(section *psection)
487 memset((char *)psection, 0, sizeof (section));
488 copy_section(psection, &sDefault);
491 /* Do a case-insensitive, whitespace-ignoring string compare. */
492 static int strwicmp(char *psz1, char *psz2)
494 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
495 /* appropriate value. */
505 /* sync the strings on first non-whitespace */
507 while (isSpace(psz1))
509 while (isSpace(psz2))
511 if (toUpper(psz1) != toUpper(psz2) || *psz1 == '\0' || *psz2 == '\0')
516 return *psz1 - *psz2;
519 /* Find a section by name. Otherwise works like get_section. */
520 static int getsectionbyname(char *name, section *psectionDest)
524 for (i = section_list.count - 1; i >= 0; i--) {
525 if (strwicmp(iSECTION(i).name, name) == 0) {
526 if (psectionDest != NULL)
527 copy_section(psectionDest, &iSECTION(i));
535 /* Add a new section to the sections array w/the default values. */
536 static int add_a_section(char *name)
541 /* it might already exist */
543 i = getsectionbyname(name, NULL);
548 i = section_list.count;
549 s = EXPAND_ITEM_LIST(§ion_list, section, 2);
553 string_set(&s->name, name);
558 /* Map a parameter's string representation to something we can use.
559 * Returns False if the parameter string is not recognised, else TRUE. */
560 static int map_parameter(char *parmname)
564 if (*parmname == '-')
567 for (iIndex = 0; parm_table[iIndex].label; iIndex++) {
568 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
572 rprintf(FLOG, "Unknown Parameter encountered: \"%s\"\n", parmname);
576 /* Set a boolean variable from the text value stored in the passed string.
577 * Returns True in success, False if the passed string does not correctly
578 * represent a boolean. */
579 static BOOL set_boolean(BOOL *pb, char *parmvalue)
581 if (strwicmp(parmvalue, "yes") == 0
582 || strwicmp(parmvalue, "true") == 0
583 || strwicmp(parmvalue, "1") == 0)
585 else if (strwicmp(parmvalue, "no") == 0
586 || strwicmp(parmvalue, "False") == 0
587 || strwicmp(parmvalue, "0") == 0)
590 rprintf(FLOG, "Badly formed boolean in configuration file: \"%s\".\n", parmvalue);
596 /* Process a parameter. */
597 static BOOL do_parameter(char *parmname, char *parmvalue)
600 void *parm_ptr; /* where we are going to store the result */
604 parmnum = map_parameter(parmname);
607 rprintf(FLOG, "IGNORING unknown parameter \"%s\"\n", parmname);
611 def_ptr = parm_table[parmnum].ptr;
613 if (bInGlobalSection)
616 if (parm_table[parmnum].class == P_GLOBAL) {
617 rprintf(FLOG, "Global parameter %s found in module section!\n", parmname);
620 parm_ptr = SECTION_PTR(&iSECTION(iSectionIndex), def_ptr);
623 /* now switch on the type of variable it is */
624 switch (parm_table[parmnum].type) {
626 set_boolean(parm_ptr, parmvalue);
630 set_boolean(parm_ptr, parmvalue);
631 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
635 *(int *)parm_ptr = atoi(parmvalue);
639 *(char *)parm_ptr = *parmvalue;
643 sscanf(parmvalue, "%o", (int *)parm_ptr);
647 string_set(parm_ptr, parmvalue);
648 if ((cp = *(char**)parm_ptr) != NULL) {
649 int len = strlen(cp);
650 while (len > 1 && cp[len-1] == '/') len--;
656 string_set(parm_ptr, parmvalue);
660 for (i=0; parm_table[parmnum].enum_list[i].name; i++) {
661 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
662 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
666 if (!parm_table[parmnum].enum_list[i].name) {
667 if (atoi(parmvalue) > 0)
668 *(int *)parm_ptr = atoi(parmvalue);
676 /* Process a new section (rsync module).
677 * Returns True on success, False on failure. */
678 static BOOL do_section(char *sectionname)
682 if (*sectionname == ']') { /* A special push/pop/reset directive from params.c */
683 bInGlobalSection = 1;
684 if (strcmp(sectionname+1, "push") == 0) {
685 global_and_section *gs = EXPAND_ITEM_LIST(§ion_stack, global_and_section, 2);
686 memcpy(&gs->g, &Globals, sizeof Globals);
687 memcpy(&gs->s, &sDefault, sizeof sDefault);
688 } else if (strcmp(sectionname+1, "pop") == 0
689 || strcmp(sectionname+1, "reset") == 0) {
690 global_and_section *gs = ((global_and_section *)section_stack.items) + section_stack.count - 1;
691 if (!section_stack.count)
693 memcpy(&Globals, &gs->g, sizeof Globals);
694 memcpy(&sDefault, &gs->s, sizeof sDefault);
695 if (sectionname[1] == 'p')
696 section_stack.count--;
702 isglobal = strwicmp(sectionname, GLOBAL_NAME) == 0;
704 /* if we were in a global section then do the local inits */
705 if (bInGlobalSection && !isglobal) {
706 if (!section_list.count)
711 /* if we've just struck a global section, note the fact. */
712 bInGlobalSection = isglobal;
714 /* check for multiple global sections */
715 if (bInGlobalSection)
719 /* If we have a current section, tidy it up before moving on. */
720 if (iSectionIndex >= 0) {
721 /* Add any tidy work as needed ... */
727 if (strchr(sectionname, '/') != NULL) {
728 rprintf(FLOG, "Warning: invalid section name in configuration file: %s\n", sectionname);
732 if ((iSectionIndex = add_a_section(sectionname)) < 0) {
733 rprintf(FLOG, "Failed to add a new module\n");
734 bInGlobalSection = True;
741 /* Load the modules from the config file. Return True on success,
742 * False on failure. */
743 int lp_load(char *pszFname, int globals_only)
745 bInGlobalSection = True;
749 /* We get sections first, so have to start 'behind' to make up. */
751 return pm_process(pszFname, globals_only ? NULL : do_section, do_parameter);
754 BOOL set_dparams(int syntax_check_only)
756 char *equal, *val, **params = dparam_list.items;
759 for (j = 0; j < dparam_list.count; j++) {
760 equal = strchr(params[j], '='); /* options.c verified this */
762 if (syntax_check_only) {
763 if (map_parameter(params[j]) < 0) {
764 rprintf(FERROR, "Unknown parameter \"%s\"\n", params[j]);
769 for (val = equal+1; isSpace(val); val++) {}
770 do_parameter(params[j], val);
778 /* Return the max number of modules (sections). */
779 int lp_num_modules(void)
781 return section_list.count;
784 /* Return the number of the module with the given name, or -1 if it doesn't
785 * exist. Note that this is a DIFFERENT ANIMAL from the internal function
786 * getsectionbyname()! This works ONLY if all sections have been loaded,
787 * and does not copy the found section. */
788 int lp_number(char *name)
792 for (i = section_list.count - 1; i >= 0; i--) {
793 if (strcmp(lp_name(i), name) == 0)