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) initialise it in the Defaults static stucture
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,
47 extern item_list dparam_list;
49 #define strequal(a, b) (strcasecmp(a, b)==0)
50 #define BOOLSTR(b) ((b) ? "Yes" : "No")
56 #define DEFAULT_DONT_COMPRESS "*.gz *.zip *.z *.rpm *.deb *.iso *.bz2" \
57 " *.t[gb]z *.7z *.mp[34] *.mov *.avi *.ogg *.jpg *.jpeg"
59 /* the following are used by loadparm for option lists */
61 P_BOOL, P_BOOLREV, P_CHAR, P_INTEGER,
62 P_OCTAL, P_PATH, P_STRING, P_ENUM
66 P_LOCAL, P_GLOBAL, P_NONE
79 struct enum_list *enum_list;
84 #define GLOBAL_NAME "global"
87 /* some helpful bits */
88 #define iSECTION(i) ((local_vars*)section_list.items)[i]
89 #define LP_SNUM_OK(i) ((i) >= 0 && (i) < (int)section_list.count)
90 #define SECTION_PTR(s, p) (((char*)(s)) + (ptrdiff_t)(((char*)(p))-(char*)&Locals))
93 * This structure describes global (ie., server-wide) parameters.
104 static global_vars Globals;
107 * This structure describes a single section. Their order must match the
108 * initializers below, which you can accomplish by keeping each sub-section
109 * sorted. (e.g. in vim, just visually select each subsection and use !sort.)
124 char *incoming_chmod;
129 char *outgoing_chmod;
133 char *refuse_options;
145 BOOL ignore_nonreadable;
152 BOOL transfer_logging;
157 static local_vars Locals;
164 /* This is used to reset all values before a config read. In order
165 * to make these easy to keep sorted in the same way as the variables
166 * above, use the variable name in the leading comment, including a
167 * trailing ';' (to avoid a sorting problem with trailing digits). */
168 static const all_vars Defaults = {
169 /* ==== global_vars ==== */
171 /* bind_address; */ NULL,
172 /* motd_file; */ NULL,
173 /* pid_file; */ NULL,
174 /* socket_options; */ NULL,
179 /* ==== local_vars ==== */
181 /* auth_users; */ NULL,
184 /* dont_compress; */ DEFAULT_DONT_COMPRESS,
186 /* exclude_from; */ NULL,
188 /* gid; */ NOBODY_GROUP,
189 /* hosts_allow; */ NULL,
190 /* hosts_deny; */ NULL,
192 /* include_from; */ NULL,
193 /* incoming_chmod; */ NULL,
194 /* lock_file; */ DEFAULT_LOCK_FILE,
195 /* log_file; */ NULL,
196 /* log_format; */ "%o %h [%a] %m (%u) %f %l",
198 /* outgoing_chmod; */ NULL,
200 /* postxfer_exec; */ NULL,
201 /* prexfer_exec; */ NULL,
202 /* refuse_options; */ NULL,
203 /* secrets_file; */ NULL,
204 /* temp_dir; */ NULL,
205 /* uid; */ NOBODY_USER,
207 /* max_connections; */ 0,
208 /* max_verbosity; */ 1,
209 /* syslog_facility; */ LOG_DAEMON,
212 /* fake_super; */ False,
213 /* ignore_errors; */ False,
214 /* ignore_nonreadable; */ False,
216 /* munge_symlinks; */ (BOOL)-1,
217 /* numeric_ids; */ (BOOL)-1,
218 /* read_only; */ True,
219 /* reverse_lookup; */ True,
220 /* strict_modes; */ True,
221 /* transfer_logging; */ False,
222 /* use_chroot; */ True,
223 /* write_only; */ False,
227 /* local variables */
228 static item_list section_list = EMPTY_ITEM_LIST;
229 static item_list section_stack = EMPTY_ITEM_LIST;
230 static int iSectionIndex = -1;
231 static BOOL bInGlobalSection = True;
233 #define NUMPARAMETERS (sizeof (parm_table) / sizeof (struct parm_struct))
235 static struct enum_list enum_facilities[] = {
237 { LOG_AUTH, "auth" },
240 { LOG_AUTHPRIV, "authpriv" },
243 { LOG_CRON, "cron" },
246 { LOG_DAEMON, "daemon" },
252 { LOG_KERN, "kern" },
258 { LOG_MAIL, "mail" },
261 { LOG_NEWS, "news" },
264 { LOG_AUTH, "security" },
267 { LOG_SYSLOG, "syslog" },
270 { LOG_USER, "user" },
273 { LOG_UUCP, "uucp" },
276 { LOG_LOCAL0, "local0" },
279 { LOG_LOCAL1, "local1" },
282 { LOG_LOCAL2, "local2" },
285 { LOG_LOCAL3, "local3" },
288 { LOG_LOCAL4, "local4" },
291 { LOG_LOCAL5, "local5" },
294 { LOG_LOCAL6, "local6" },
297 { LOG_LOCAL7, "local7" },
302 static struct parm_struct parm_table[] =
304 {"address", P_STRING, P_GLOBAL,&Globals.bind_address, NULL,0},
305 {"motd file", P_STRING, P_GLOBAL,&Globals.motd_file, NULL,0},
306 {"pid file", P_STRING, P_GLOBAL,&Globals.pid_file, NULL,0},
307 {"port", P_INTEGER,P_GLOBAL,&Globals.rsync_port, NULL,0},
308 {"socket options", P_STRING, P_GLOBAL,&Globals.socket_options, NULL,0},
310 {"auth users", P_STRING, P_LOCAL, &Locals.auth_users, NULL,0},
311 {"charset", P_STRING, P_LOCAL, &Locals.charset, NULL,0},
312 {"comment", P_STRING, P_LOCAL, &Locals.comment, NULL,0},
313 {"dont compress", P_STRING, P_LOCAL, &Locals.dont_compress, NULL,0},
314 {"exclude from", P_STRING, P_LOCAL, &Locals.exclude_from, NULL,0},
315 {"exclude", P_STRING, P_LOCAL, &Locals.exclude, NULL,0},
316 {"fake super", P_BOOL, P_LOCAL, &Locals.fake_super, NULL,0},
317 {"filter", P_STRING, P_LOCAL, &Locals.filter, NULL,0},
318 {"gid", P_STRING, P_LOCAL, &Locals.gid, NULL,0},
319 {"hosts allow", P_STRING, P_LOCAL, &Locals.hosts_allow, NULL,0},
320 {"hosts deny", P_STRING, P_LOCAL, &Locals.hosts_deny, NULL,0},
321 {"ignore errors", P_BOOL, P_LOCAL, &Locals.ignore_errors, NULL,0},
322 {"ignore nonreadable",P_BOOL, P_LOCAL, &Locals.ignore_nonreadable, NULL,0},
323 {"include from", P_STRING, P_LOCAL, &Locals.include_from, NULL,0},
324 {"include", P_STRING, P_LOCAL, &Locals.include, NULL,0},
325 {"incoming chmod", P_STRING, P_LOCAL, &Locals.incoming_chmod, NULL,0},
326 {"list", P_BOOL, P_LOCAL, &Locals.list, NULL,0},
327 {"lock file", P_STRING, P_LOCAL, &Locals.lock_file, NULL,0},
328 {"log file", P_STRING, P_LOCAL, &Locals.log_file, NULL,0},
329 {"log format", P_STRING, P_LOCAL, &Locals.log_format, NULL,0},
330 {"max connections", P_INTEGER,P_LOCAL, &Locals.max_connections, NULL,0},
331 {"max verbosity", P_INTEGER,P_LOCAL, &Locals.max_verbosity, NULL,0},
332 {"munge symlinks", P_BOOL, P_LOCAL, &Locals.munge_symlinks, NULL,0},
333 {"name", P_STRING, P_LOCAL, &Locals.name, NULL,0},
334 {"numeric ids", P_BOOL, P_LOCAL, &Locals.numeric_ids, NULL,0},
335 {"outgoing chmod", P_STRING, P_LOCAL, &Locals.outgoing_chmod, NULL,0},
336 {"path", P_PATH, P_LOCAL, &Locals.path, NULL,0},
338 {"post-xfer exec", P_STRING, P_LOCAL, &Locals.postxfer_exec, NULL,0},
339 {"pre-xfer exec", P_STRING, P_LOCAL, &Locals.prexfer_exec, NULL,0},
341 {"read only", P_BOOL, P_LOCAL, &Locals.read_only, NULL,0},
342 {"refuse options", P_STRING, P_LOCAL, &Locals.refuse_options, NULL,0},
343 {"reverse lookup", P_BOOL, P_LOCAL, &Locals.reverse_lookup, NULL,0},
344 {"secrets file", P_STRING, P_LOCAL, &Locals.secrets_file, NULL,0},
345 {"strict modes", P_BOOL, P_LOCAL, &Locals.strict_modes, NULL,0},
346 {"syslog facility", P_ENUM, P_LOCAL, &Locals.syslog_facility, enum_facilities,0},
347 {"temp dir", P_PATH, P_LOCAL, &Locals.temp_dir, NULL,0},
348 {"timeout", P_INTEGER,P_LOCAL, &Locals.timeout, NULL,0},
349 {"transfer logging", P_BOOL, P_LOCAL, &Locals.transfer_logging, NULL,0},
350 {"uid", P_STRING, P_LOCAL, &Locals.uid, NULL,0},
351 {"use chroot", P_BOOL, P_LOCAL, &Locals.use_chroot, NULL,0},
352 {"write only", P_BOOL, P_LOCAL, &Locals.write_only, NULL,0},
353 {NULL, P_BOOL, P_NONE, NULL, NULL,0}
356 /* Initialise the Default all_vars structure. */
357 static void reset_all_vars(void)
359 memcpy(&Globals, &Defaults.g, sizeof Globals);
360 memcpy(&Locals, &Defaults.l, sizeof Locals);
363 /* In this section all the functions that are used to access the
364 * parameters from the rest of the program are defined. */
366 #define FN_GLOBAL_STRING(fn_name, ptr) \
367 char *fn_name(void) {return *(char **)(ptr) ? *(char **)(ptr) : "";}
368 #define FN_GLOBAL_BOOL(fn_name, ptr) \
369 BOOL fn_name(void) {return *(BOOL *)(ptr);}
370 #define FN_GLOBAL_CHAR(fn_name, ptr) \
371 char fn_name(void) {return *(char *)(ptr);}
372 #define FN_GLOBAL_INTEGER(fn_name, ptr) \
373 int fn_name(void) {return *(int *)(ptr);}
375 #define FN_LOCAL_STRING(fn_name, val) \
376 char *fn_name(int i) {return LP_SNUM_OK(i) && iSECTION(i).val? iSECTION(i).val : (Locals.val? Locals.val : "");}
377 #define FN_LOCAL_BOOL(fn_name, val) \
378 BOOL fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : Locals.val;}
379 #define FN_LOCAL_CHAR(fn_name, val) \
380 char fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : Locals.val;}
381 #define FN_LOCAL_INTEGER(fn_name, val) \
382 int fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : Locals.val;}
384 FN_GLOBAL_STRING(lp_bind_address, &Globals.bind_address)
385 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
386 FN_GLOBAL_STRING(lp_pid_file, &Globals.pid_file)
387 FN_GLOBAL_STRING(lp_socket_options, &Globals.socket_options)
389 FN_GLOBAL_INTEGER(lp_rsync_port, &Globals.rsync_port)
391 FN_LOCAL_STRING(lp_auth_users, auth_users)
392 FN_LOCAL_STRING(lp_charset, charset)
393 FN_LOCAL_STRING(lp_comment, comment)
394 FN_LOCAL_STRING(lp_dont_compress, dont_compress)
395 FN_LOCAL_STRING(lp_exclude, exclude)
396 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
397 FN_LOCAL_STRING(lp_filter, filter)
398 FN_LOCAL_STRING(lp_gid, gid)
399 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
400 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
401 FN_LOCAL_STRING(lp_include, include)
402 FN_LOCAL_STRING(lp_include_from, include_from)
403 FN_LOCAL_STRING(lp_incoming_chmod, incoming_chmod)
404 FN_LOCAL_STRING(lp_lock_file, lock_file)
405 FN_LOCAL_STRING(lp_log_file, log_file)
406 FN_LOCAL_STRING(lp_log_format, log_format)
407 FN_LOCAL_STRING(lp_name, name)
408 FN_LOCAL_STRING(lp_outgoing_chmod, outgoing_chmod)
409 FN_LOCAL_STRING(lp_path, path)
410 FN_LOCAL_STRING(lp_postxfer_exec, postxfer_exec)
411 FN_LOCAL_STRING(lp_prexfer_exec, prexfer_exec)
412 FN_LOCAL_STRING(lp_refuse_options, refuse_options)
413 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
414 FN_LOCAL_STRING(lp_temp_dir, temp_dir)
415 FN_LOCAL_STRING(lp_uid, uid)
417 FN_LOCAL_INTEGER(lp_max_connections, max_connections)
418 FN_LOCAL_INTEGER(lp_max_verbosity, max_verbosity)
419 FN_LOCAL_INTEGER(lp_syslog_facility, syslog_facility)
420 FN_LOCAL_INTEGER(lp_timeout, timeout)
422 FN_LOCAL_BOOL(lp_fake_super, fake_super)
423 FN_LOCAL_BOOL(lp_ignore_errors, ignore_errors)
424 FN_LOCAL_BOOL(lp_ignore_nonreadable, ignore_nonreadable)
425 FN_LOCAL_BOOL(lp_list, list)
426 FN_LOCAL_BOOL(lp_munge_symlinks, munge_symlinks)
427 FN_LOCAL_BOOL(lp_numeric_ids, numeric_ids)
428 FN_LOCAL_BOOL(lp_read_only, read_only)
429 FN_LOCAL_BOOL(lp_reverse_lookup, reverse_lookup)
430 FN_LOCAL_BOOL(lp_strict_modes, strict_modes)
431 FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
432 FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
433 FN_LOCAL_BOOL(lp_write_only, write_only)
435 /* Assign a copy of v to *s. Handles NULL strings. *v must
436 * be initialized when this is called, either to NULL or a malloc'd
439 * FIXME There is a small leak here in that sometimes the existing
440 * value will be dynamically allocated, and the old copy is lost.
441 * However, we can't always deallocate the old value, because in the
442 * case of Locals, it points to a static string. It would be nice
443 * to have either all-strdup'd values, or to never need to free
445 static void string_set(char **s, const char *v)
451 if (!(*s = strdup(v)))
452 out_of_memory("string_set");
455 /* Copy the local_vars, duplicating any strings in the source. */
456 static void copy_section(local_vars *psectionDest, local_vars *psectionSource)
460 for (i = 0; parm_table[i].label; i++) {
461 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
462 void *def_ptr = parm_table[i].ptr;
463 void *src_ptr = SECTION_PTR(psectionSource, def_ptr);
464 void *dest_ptr = SECTION_PTR(psectionDest, def_ptr);
466 switch (parm_table[i].type) {
469 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
475 *(int *)dest_ptr = *(int *)src_ptr;
479 *(char *)dest_ptr = *(char *)src_ptr;
484 string_set(dest_ptr, *(char **)src_ptr);
494 /* Initialise a section to the defaults. */
495 static void init_section(local_vars *psection)
497 memset(psection, 0, sizeof Locals);
498 copy_section(psection, &Locals);
501 /* Do a case-insensitive, whitespace-ignoring string compare. */
502 static int strwicmp(char *psz1, char *psz2)
504 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
505 /* appropriate value. */
515 /* sync the strings on first non-whitespace */
517 while (isSpace(psz1))
519 while (isSpace(psz2))
521 if (toUpper(psz1) != toUpper(psz2) || *psz1 == '\0' || *psz2 == '\0')
526 return *psz1 - *psz2;
529 /* Find a section by name. Otherwise works like get_section. */
530 static int getsectionbyname(char *name)
534 for (i = section_list.count - 1; i >= 0; i--) {
535 if (strwicmp(iSECTION(i).name, name) == 0)
542 /* Add a new section to the sections array w/the default values. */
543 static int add_a_section(char *name)
548 /* it might already exist */
550 i = getsectionbyname(name);
555 i = section_list.count;
556 s = EXPAND_ITEM_LIST(§ion_list, local_vars, 2);
560 string_set(&s->name, name);
565 /* Map a parameter's string representation to something we can use.
566 * Returns False if the parameter string is not recognised, else TRUE. */
567 static int map_parameter(char *parmname)
571 if (*parmname == '-')
574 for (iIndex = 0; parm_table[iIndex].label; iIndex++) {
575 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
579 rprintf(FLOG, "Unknown Parameter encountered: \"%s\"\n", parmname);
583 /* Set a boolean variable from the text value stored in the passed string.
584 * Returns True in success, False if the passed string does not correctly
585 * represent a boolean. */
586 static BOOL set_boolean(BOOL *pb, char *parmvalue)
588 if (strwicmp(parmvalue, "yes") == 0
589 || strwicmp(parmvalue, "true") == 0
590 || strwicmp(parmvalue, "1") == 0)
592 else if (strwicmp(parmvalue, "no") == 0
593 || strwicmp(parmvalue, "False") == 0
594 || strwicmp(parmvalue, "0") == 0)
597 rprintf(FLOG, "Badly formed boolean in configuration file: \"%s\".\n", parmvalue);
603 /* Process a parameter. */
604 static BOOL do_parameter(char *parmname, char *parmvalue)
607 void *parm_ptr; /* where we are going to store the result */
611 parmnum = map_parameter(parmname);
614 rprintf(FLOG, "IGNORING unknown parameter \"%s\"\n", parmname);
618 def_ptr = parm_table[parmnum].ptr;
620 if (bInGlobalSection)
623 if (parm_table[parmnum].class == P_GLOBAL) {
624 rprintf(FLOG, "Global parameter %s found in module section!\n", parmname);
627 parm_ptr = SECTION_PTR(&iSECTION(iSectionIndex), def_ptr);
630 /* now switch on the type of variable it is */
631 switch (parm_table[parmnum].type) {
633 set_boolean(parm_ptr, parmvalue);
637 set_boolean(parm_ptr, parmvalue);
638 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
642 *(int *)parm_ptr = atoi(parmvalue);
646 *(char *)parm_ptr = *parmvalue;
650 sscanf(parmvalue, "%o", (int *)parm_ptr);
654 string_set(parm_ptr, parmvalue);
655 if ((cp = *(char**)parm_ptr) != NULL) {
656 int len = strlen(cp);
657 while (len > 1 && cp[len-1] == '/') len--;
663 string_set(parm_ptr, parmvalue);
667 for (i=0; parm_table[parmnum].enum_list[i].name; i++) {
668 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
669 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
673 if (!parm_table[parmnum].enum_list[i].name) {
674 if (atoi(parmvalue) > 0)
675 *(int *)parm_ptr = atoi(parmvalue);
683 /* Process a new section (rsync module).
684 * Returns True on success, False on failure. */
685 static BOOL do_section(char *sectionname)
689 if (*sectionname == ']') { /* A special push/pop/reset directive from params.c */
690 bInGlobalSection = 1;
691 if (strcmp(sectionname+1, "push") == 0) {
692 all_vars *vp = EXPAND_ITEM_LIST(§ion_stack, all_vars, 2);
693 memcpy(&vp->g, &Globals, sizeof Globals);
694 memcpy(&vp->l, &Locals, sizeof Locals);
695 } else if (strcmp(sectionname+1, "pop") == 0
696 || strcmp(sectionname+1, "reset") == 0) {
697 all_vars *vp = ((all_vars*)section_stack.items) + section_stack.count - 1;
698 if (!section_stack.count)
700 memcpy(&Globals, &vp->g, sizeof Globals);
701 memcpy(&Locals, &vp->l, sizeof Locals);
702 if (sectionname[1] == 'p')
703 section_stack.count--;
709 isglobal = strwicmp(sectionname, GLOBAL_NAME) == 0;
711 /* At the end of the global section, add any --dparam items. */
712 if (bInGlobalSection && !isglobal) {
713 if (!section_list.count)
717 /* if we've just struck a global section, note the fact. */
718 bInGlobalSection = isglobal;
720 /* check for multiple global sections */
721 if (bInGlobalSection)
725 /* If we have a current section, tidy it up before moving on. */
726 if (iSectionIndex >= 0) {
727 /* Add any tidy work as needed ... */
733 if (strchr(sectionname, '/') != NULL) {
734 rprintf(FLOG, "Warning: invalid section name in configuration file: %s\n", sectionname);
738 if ((iSectionIndex = add_a_section(sectionname)) < 0) {
739 rprintf(FLOG, "Failed to add a new module\n");
740 bInGlobalSection = True;
747 /* Load the modules from the config file. Return True on success,
748 * False on failure. */
749 int lp_load(char *pszFname, int globals_only)
751 bInGlobalSection = True;
755 /* We get sections first, so have to start 'behind' to make up. */
757 return pm_process(pszFname, globals_only ? NULL : do_section, do_parameter);
760 BOOL set_dparams(int syntax_check_only)
762 char *equal, *val, **params = dparam_list.items;
765 for (j = 0; j < dparam_list.count; j++) {
766 equal = strchr(params[j], '='); /* options.c verified this */
768 if (syntax_check_only) {
769 if (map_parameter(params[j]) < 0) {
770 rprintf(FERROR, "Unknown parameter \"%s\"\n", params[j]);
775 for (val = equal+1; isSpace(val); val++) {}
776 do_parameter(params[j], val);
784 /* Return the max number of modules (sections). */
785 int lp_num_modules(void)
787 return section_list.count;
790 /* Return the number of the module with the given name, or -1 if it doesn't
791 * exist. Note that this is a DIFFERENT ANIMAL from the internal function
792 * getsectionbyname()! This works ONLY if all sections have been loaded,
793 * and does not copy the found section. */
794 int lp_number(char *name)
798 for (i = section_list.count - 1; i >= 0; i--) {
799 if (strcmp(lp_name(i), name) == 0)