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*)&Vars.l))
92 /* This structure describes global (ie., server-wide) parameters. */
102 /* This structure describes a single section. Their order must match the
103 * initializers below, which you can accomplish by keeping each sub-section
104 * sorted. (e.g. in vim, just visually select each subsection and use !sort.)
105 * NOTE: the char* variables MUST all remain at the start of the stuct! */
119 char *incoming_chmod;
124 char *outgoing_chmod;
128 char *refuse_options;
132 /* NOTE: update this macro if the last char* variable changes! */
133 #define LOCAL_STRING_COUNT() (offsetof(local_vars, uid) / sizeof (char*) + 1)
142 BOOL ignore_nonreadable;
149 BOOL transfer_logging;
154 /* This structure describes the global variables (g) as well as the globally
155 * specified values of the local variables (l), which are used when modules
156 * don't specify their own values. */
162 /* The application defaults for all the variables. "Defaults" is
163 * used to re-initialize "Vars" before each config-file read.
165 * In order to keep these sorted in the same way as the structure
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,
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,
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 /* The currently configured values for all the variables. */
228 static all_vars Vars;
230 /* Stack of "Vars" values used by the &include directive. */
231 static item_list Vars_stack = EMPTY_ITEM_LIST;
233 /* The array of section values that holds all the defined modules. */
234 static item_list section_list = EMPTY_ITEM_LIST;
236 static int iSectionIndex = -1;
237 static BOOL bInGlobalSection = True;
239 #define NUMPARAMETERS (sizeof (parm_table) / sizeof (struct parm_struct))
241 static struct enum_list enum_facilities[] = {
243 { LOG_AUTH, "auth" },
246 { LOG_AUTHPRIV, "authpriv" },
249 { LOG_CRON, "cron" },
252 { LOG_DAEMON, "daemon" },
258 { LOG_KERN, "kern" },
264 { LOG_MAIL, "mail" },
267 { LOG_NEWS, "news" },
270 { LOG_AUTH, "security" },
273 { LOG_SYSLOG, "syslog" },
276 { LOG_USER, "user" },
279 { LOG_UUCP, "uucp" },
282 { LOG_LOCAL0, "local0" },
285 { LOG_LOCAL1, "local1" },
288 { LOG_LOCAL2, "local2" },
291 { LOG_LOCAL3, "local3" },
294 { LOG_LOCAL4, "local4" },
297 { LOG_LOCAL5, "local5" },
300 { LOG_LOCAL6, "local6" },
303 { LOG_LOCAL7, "local7" },
308 static struct parm_struct parm_table[] =
310 {"address", P_STRING, P_GLOBAL,&Vars.g.bind_address, NULL,0},
311 {"motd file", P_STRING, P_GLOBAL,&Vars.g.motd_file, NULL,0},
312 {"pid file", P_STRING, P_GLOBAL,&Vars.g.pid_file, NULL,0},
313 {"port", P_INTEGER,P_GLOBAL,&Vars.g.rsync_port, NULL,0},
314 {"socket options", P_STRING, P_GLOBAL,&Vars.g.socket_options, NULL,0},
316 {"auth users", P_STRING, P_LOCAL, &Vars.l.auth_users, NULL,0},
317 {"charset", P_STRING, P_LOCAL, &Vars.l.charset, NULL,0},
318 {"comment", P_STRING, P_LOCAL, &Vars.l.comment, NULL,0},
319 {"dont compress", P_STRING, P_LOCAL, &Vars.l.dont_compress, NULL,0},
320 {"exclude from", P_STRING, P_LOCAL, &Vars.l.exclude_from, NULL,0},
321 {"exclude", P_STRING, P_LOCAL, &Vars.l.exclude, NULL,0},
322 {"fake super", P_BOOL, P_LOCAL, &Vars.l.fake_super, NULL,0},
323 {"filter", P_STRING, P_LOCAL, &Vars.l.filter, NULL,0},
324 {"gid", P_STRING, P_LOCAL, &Vars.l.gid, NULL,0},
325 {"hosts allow", P_STRING, P_LOCAL, &Vars.l.hosts_allow, NULL,0},
326 {"hosts deny", P_STRING, P_LOCAL, &Vars.l.hosts_deny, NULL,0},
327 {"ignore errors", P_BOOL, P_LOCAL, &Vars.l.ignore_errors, NULL,0},
328 {"ignore nonreadable",P_BOOL, P_LOCAL, &Vars.l.ignore_nonreadable, NULL,0},
329 {"include from", P_STRING, P_LOCAL, &Vars.l.include_from, NULL,0},
330 {"include", P_STRING, P_LOCAL, &Vars.l.include, NULL,0},
331 {"incoming chmod", P_STRING, P_LOCAL, &Vars.l.incoming_chmod, NULL,0},
332 {"list", P_BOOL, P_LOCAL, &Vars.l.list, NULL,0},
333 {"lock file", P_STRING, P_LOCAL, &Vars.l.lock_file, NULL,0},
334 {"log file", P_STRING, P_LOCAL, &Vars.l.log_file, NULL,0},
335 {"log format", P_STRING, P_LOCAL, &Vars.l.log_format, NULL,0},
336 {"max connections", P_INTEGER,P_LOCAL, &Vars.l.max_connections, NULL,0},
337 {"max verbosity", P_INTEGER,P_LOCAL, &Vars.l.max_verbosity, NULL,0},
338 {"munge symlinks", P_BOOL, P_LOCAL, &Vars.l.munge_symlinks, NULL,0},
339 {"name", P_STRING, P_LOCAL, &Vars.l.name, NULL,0},
340 {"numeric ids", P_BOOL, P_LOCAL, &Vars.l.numeric_ids, NULL,0},
341 {"outgoing chmod", P_STRING, P_LOCAL, &Vars.l.outgoing_chmod, NULL,0},
342 {"path", P_PATH, P_LOCAL, &Vars.l.path, NULL,0},
344 {"post-xfer exec", P_STRING, P_LOCAL, &Vars.l.postxfer_exec, NULL,0},
345 {"pre-xfer exec", P_STRING, P_LOCAL, &Vars.l.prexfer_exec, NULL,0},
347 {"read only", P_BOOL, P_LOCAL, &Vars.l.read_only, NULL,0},
348 {"refuse options", P_STRING, P_LOCAL, &Vars.l.refuse_options, NULL,0},
349 {"reverse lookup", P_BOOL, P_LOCAL, &Vars.l.reverse_lookup, NULL,0},
350 {"secrets file", P_STRING, P_LOCAL, &Vars.l.secrets_file, NULL,0},
351 {"strict modes", P_BOOL, P_LOCAL, &Vars.l.strict_modes, NULL,0},
352 {"syslog facility", P_ENUM, P_LOCAL, &Vars.l.syslog_facility, enum_facilities,0},
353 {"temp dir", P_PATH, P_LOCAL, &Vars.l.temp_dir, NULL,0},
354 {"timeout", P_INTEGER,P_LOCAL, &Vars.l.timeout, NULL,0},
355 {"transfer logging", P_BOOL, P_LOCAL, &Vars.l.transfer_logging, NULL,0},
356 {"uid", P_STRING, P_LOCAL, &Vars.l.uid, NULL,0},
357 {"use chroot", P_BOOL, P_LOCAL, &Vars.l.use_chroot, NULL,0},
358 {"write only", P_BOOL, P_LOCAL, &Vars.l.write_only, NULL,0},
359 {NULL, P_BOOL, P_NONE, NULL, NULL,0}
362 /* Initialise the Default all_vars structure. */
363 static void reset_all_vars(void)
365 memcpy(&Vars, &Defaults, sizeof Vars);
368 /* In this section all the functions that are used to access the
369 * parameters from the rest of the program are defined. */
371 #define FN_GLOBAL_STRING(fn_name, ptr) \
372 char *fn_name(void) {return *(char **)(ptr) ? *(char **)(ptr) : "";}
373 #define FN_GLOBAL_BOOL(fn_name, ptr) \
374 BOOL fn_name(void) {return *(BOOL *)(ptr);}
375 #define FN_GLOBAL_CHAR(fn_name, ptr) \
376 char fn_name(void) {return *(char *)(ptr);}
377 #define FN_GLOBAL_INTEGER(fn_name, ptr) \
378 int fn_name(void) {return *(int *)(ptr);}
380 #define FN_LOCAL_STRING(fn_name, val) \
381 char *fn_name(int i) {return LP_SNUM_OK(i) && iSECTION(i).val? iSECTION(i).val : (Vars.l.val? Vars.l.val : "");}
382 #define FN_LOCAL_BOOL(fn_name, val) \
383 BOOL fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : Vars.l.val;}
384 #define FN_LOCAL_CHAR(fn_name, val) \
385 char fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : Vars.l.val;}
386 #define FN_LOCAL_INTEGER(fn_name, val) \
387 int fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : Vars.l.val;}
389 FN_GLOBAL_STRING(lp_bind_address, &Vars.g.bind_address)
390 FN_GLOBAL_STRING(lp_motd_file, &Vars.g.motd_file)
391 FN_GLOBAL_STRING(lp_pid_file, &Vars.g.pid_file)
392 FN_GLOBAL_STRING(lp_socket_options, &Vars.g.socket_options)
394 FN_GLOBAL_INTEGER(lp_rsync_port, &Vars.g.rsync_port)
396 FN_LOCAL_STRING(lp_auth_users, auth_users)
397 FN_LOCAL_STRING(lp_charset, charset)
398 FN_LOCAL_STRING(lp_comment, comment)
399 FN_LOCAL_STRING(lp_dont_compress, dont_compress)
400 FN_LOCAL_STRING(lp_exclude, exclude)
401 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
402 FN_LOCAL_STRING(lp_filter, filter)
403 FN_LOCAL_STRING(lp_gid, gid)
404 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
405 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
406 FN_LOCAL_STRING(lp_include, include)
407 FN_LOCAL_STRING(lp_include_from, include_from)
408 FN_LOCAL_STRING(lp_incoming_chmod, incoming_chmod)
409 FN_LOCAL_STRING(lp_lock_file, lock_file)
410 FN_LOCAL_STRING(lp_log_file, log_file)
411 FN_LOCAL_STRING(lp_log_format, log_format)
412 FN_LOCAL_STRING(lp_name, name)
413 FN_LOCAL_STRING(lp_outgoing_chmod, outgoing_chmod)
414 FN_LOCAL_STRING(lp_path, path)
415 FN_LOCAL_STRING(lp_postxfer_exec, postxfer_exec)
416 FN_LOCAL_STRING(lp_prexfer_exec, prexfer_exec)
417 FN_LOCAL_STRING(lp_refuse_options, refuse_options)
418 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
419 FN_LOCAL_STRING(lp_temp_dir, temp_dir)
420 FN_LOCAL_STRING(lp_uid, uid)
422 FN_LOCAL_INTEGER(lp_max_connections, max_connections)
423 FN_LOCAL_INTEGER(lp_max_verbosity, max_verbosity)
424 FN_LOCAL_INTEGER(lp_syslog_facility, syslog_facility)
425 FN_LOCAL_INTEGER(lp_timeout, timeout)
427 FN_LOCAL_BOOL(lp_fake_super, fake_super)
428 FN_LOCAL_BOOL(lp_ignore_errors, ignore_errors)
429 FN_LOCAL_BOOL(lp_ignore_nonreadable, ignore_nonreadable)
430 FN_LOCAL_BOOL(lp_list, list)
431 FN_LOCAL_BOOL(lp_munge_symlinks, munge_symlinks)
432 FN_LOCAL_BOOL(lp_numeric_ids, numeric_ids)
433 FN_LOCAL_BOOL(lp_read_only, read_only)
434 FN_LOCAL_BOOL(lp_reverse_lookup, reverse_lookup)
435 FN_LOCAL_BOOL(lp_strict_modes, strict_modes)
436 FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
437 FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
438 FN_LOCAL_BOOL(lp_write_only, write_only)
440 /* Assign a copy of v to *s. Handles NULL strings. We don't worry
441 * about overwriting a malloc'd string because the long-running
442 * (port-listening) daemon only loads the config file once, and the
443 * per-job (forked or xinitd-ran) daemon only re-reads the file at
444 * the start, so any lost memory is inconsequential. */
445 static inline void string_set(char **s, const char *v)
449 else if (!(*s = strdup(v)))
450 out_of_memory("string_set");
453 /* Copy the local_vars, strdup'ing any strings. NOTE: this depends on
454 * the structure starting with a contiguous list of the char* variables,
455 * and having an accurate count in the LOCAL_STRING_COUNT() macro. */
456 static void copy_section(local_vars *psectionDest, local_vars *psectionSource)
458 int count = LOCAL_STRING_COUNT();
459 char **strings = (char**)psectionDest;
461 memcpy(psectionDest, psectionSource, sizeof psectionDest[0]);
463 if (strings[count] && !(strings[count] = strdup(strings[count])))
464 out_of_memory("copy_section");
468 /* Initialise a section to the defaults. */
469 static void init_section(local_vars *psection)
471 memset(psection, 0, sizeof (local_vars));
472 copy_section(psection, &Vars.l);
475 /* Do a case-insensitive, whitespace-ignoring string compare. */
476 static int strwicmp(char *psz1, char *psz2)
478 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
479 /* appropriate value. */
489 /* sync the strings on first non-whitespace */
491 while (isSpace(psz1))
493 while (isSpace(psz2))
495 if (toUpper(psz1) != toUpper(psz2) || *psz1 == '\0' || *psz2 == '\0')
500 return *psz1 - *psz2;
503 /* Find a section by name. Otherwise works like get_section. */
504 static int getsectionbyname(char *name)
508 for (i = section_list.count - 1; i >= 0; i--) {
509 if (strwicmp(iSECTION(i).name, name) == 0)
516 /* Add a new section to the sections array w/the default values. */
517 static int add_a_section(char *name)
522 /* it might already exist */
524 i = getsectionbyname(name);
529 i = section_list.count;
530 s = EXPAND_ITEM_LIST(§ion_list, local_vars, 2);
534 string_set(&s->name, name);
539 /* Map a parameter's string representation to something we can use.
540 * Returns False if the parameter string is not recognised, else TRUE. */
541 static int map_parameter(char *parmname)
545 if (*parmname == '-')
548 for (iIndex = 0; parm_table[iIndex].label; iIndex++) {
549 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
553 rprintf(FLOG, "Unknown Parameter encountered: \"%s\"\n", parmname);
557 /* Set a boolean variable from the text value stored in the passed string.
558 * Returns True in success, False if the passed string does not correctly
559 * represent a boolean. */
560 static BOOL set_boolean(BOOL *pb, char *parmvalue)
562 if (strwicmp(parmvalue, "yes") == 0
563 || strwicmp(parmvalue, "true") == 0
564 || strwicmp(parmvalue, "1") == 0)
566 else if (strwicmp(parmvalue, "no") == 0
567 || strwicmp(parmvalue, "False") == 0
568 || strwicmp(parmvalue, "0") == 0)
571 rprintf(FLOG, "Badly formed boolean in configuration file: \"%s\".\n", parmvalue);
577 /* Process a parameter. */
578 static BOOL do_parameter(char *parmname, char *parmvalue)
581 void *parm_ptr; /* where we are going to store the result */
585 parmnum = map_parameter(parmname);
588 rprintf(FLOG, "IGNORING unknown parameter \"%s\"\n", parmname);
592 def_ptr = parm_table[parmnum].ptr;
594 if (bInGlobalSection)
597 if (parm_table[parmnum].class == P_GLOBAL) {
598 rprintf(FLOG, "Global parameter %s found in module section!\n", parmname);
601 parm_ptr = SECTION_PTR(&iSECTION(iSectionIndex), def_ptr);
604 /* now switch on the type of variable it is */
605 switch (parm_table[parmnum].type) {
607 set_boolean(parm_ptr, parmvalue);
611 set_boolean(parm_ptr, parmvalue);
612 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
616 *(int *)parm_ptr = atoi(parmvalue);
620 *(char *)parm_ptr = *parmvalue;
624 sscanf(parmvalue, "%o", (int *)parm_ptr);
628 string_set(parm_ptr, parmvalue);
629 if ((cp = *(char**)parm_ptr) != NULL) {
630 int len = strlen(cp);
631 while (len > 1 && cp[len-1] == '/') len--;
637 string_set(parm_ptr, parmvalue);
641 for (i=0; parm_table[parmnum].enum_list[i].name; i++) {
642 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
643 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
647 if (!parm_table[parmnum].enum_list[i].name) {
648 if (atoi(parmvalue) > 0)
649 *(int *)parm_ptr = atoi(parmvalue);
657 /* Process a new section (rsync module).
658 * Returns True on success, False on failure. */
659 static BOOL do_section(char *sectionname)
663 if (*sectionname == ']') { /* A special push/pop/reset directive from params.c */
664 bInGlobalSection = 1;
665 if (strcmp(sectionname+1, "push") == 0) {
666 all_vars *vp = EXPAND_ITEM_LIST(&Vars_stack, all_vars, 2);
667 memcpy(vp, &Vars, sizeof Vars);
668 } else if (strcmp(sectionname+1, "pop") == 0
669 || strcmp(sectionname+1, "reset") == 0) {
670 all_vars *vp = ((all_vars*)Vars_stack.items) + Vars_stack.count - 1;
671 if (!Vars_stack.count)
673 memcpy(&Vars, vp, sizeof Vars);
674 if (sectionname[1] == 'p')
681 isglobal = strwicmp(sectionname, GLOBAL_NAME) == 0;
683 /* At the end of the global section, add any --dparam items. */
684 if (bInGlobalSection && !isglobal) {
685 if (!section_list.count)
689 /* if we've just struck a global section, note the fact. */
690 bInGlobalSection = isglobal;
692 /* check for multiple global sections */
693 if (bInGlobalSection)
697 /* If we have a current section, tidy it up before moving on. */
698 if (iSectionIndex >= 0) {
699 /* Add any tidy work as needed ... */
705 if (strchr(sectionname, '/') != NULL) {
706 rprintf(FLOG, "Warning: invalid section name in configuration file: %s\n", sectionname);
710 if ((iSectionIndex = add_a_section(sectionname)) < 0) {
711 rprintf(FLOG, "Failed to add a new module\n");
712 bInGlobalSection = True;
719 /* Load the modules from the config file. Return True on success,
720 * False on failure. */
721 int lp_load(char *pszFname, int globals_only)
723 bInGlobalSection = True;
727 /* We get sections first, so have to start 'behind' to make up. */
729 return pm_process(pszFname, globals_only ? NULL : do_section, do_parameter);
732 BOOL set_dparams(int syntax_check_only)
734 char *equal, *val, **params = dparam_list.items;
737 for (j = 0; j < dparam_list.count; j++) {
738 equal = strchr(params[j], '='); /* options.c verified this */
740 if (syntax_check_only) {
741 if (map_parameter(params[j]) < 0) {
742 rprintf(FERROR, "Unknown parameter \"%s\"\n", params[j]);
747 for (val = equal+1; isSpace(val); val++) {}
748 do_parameter(params[j], val);
756 /* Return the max number of modules (sections). */
757 int lp_num_modules(void)
759 return section_list.count;
762 /* Return the number of the module with the given name, or -1 if it doesn't
763 * exist. Note that this is a DIFFERENT ANIMAL from the internal function
764 * getsectionbyname()! This works ONLY if all sections have been loaded,
765 * and does not copy the found section. */
766 int lp_number(char *name)
770 for (i = section_list.count - 1; i >= 0; i--) {
771 if (strcmp(lp_name(i), name) == 0)