* and Karl Auer. Some of the changes are:
*
* Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
- * Copyright (C) 2003-2008 Wayne Davison <wayned@samba.org>
+ * Copyright (C) 2003-2009 Wayne Davison <wayned@samba.org>
*/
/* Load parameters.
*
* To add a parameter:
*
- * 1) add it to the global or section structure definition
+ * 1) add it to the global_vars or local_vars structure definition
* 2) add it to the parm_table
* 3) add it to the list of available functions (eg: using FN_GLOBAL_STRING())
- * 4) If it's a global then initialise it in init_globals. If a local module
- * (ie. section) parameter then initialise it in the sDefault structure
- *
+ * 4) initialise it in the Defaults static stucture
*
* Notes:
* The configuration file is processed sequentially for speed. For this
*/
#include "rsync.h"
-#include "ifuncs.h"
-#define PTR_DIFF(p1, p2) ((ptrdiff_t)(((char *)(p1)) - (char *)(p2)))
+#include "itypes.h"
+
+extern item_list dparam_list;
+
#define strequal(a, b) (strcasecmp(a, b)==0)
#define BOOLSTR(b) ((b) ? "Yes" : "No")
-typedef char pstring[1024];
-#define pstrcpy(a, b) strlcpy((a), (b), sizeof (pstring))
#ifndef LOG_DAEMON
#define LOG_DAEMON 0
/* the following are used by loadparm for option lists */
typedef enum {
- P_BOOL, P_BOOLREV, P_CHAR, P_INTEGER, P_OCTAL,
- P_PATH, P_STRING, P_GSTRING, P_ENUM, P_SEP
+ P_BOOL, P_BOOLREV, P_CHAR, P_INTEGER,
+ P_OCTAL, P_PATH, P_STRING, P_ENUM
} parm_type;
typedef enum {
- P_LOCAL, P_GLOBAL, P_SEPARATOR, P_NONE
+ P_LOCAL, P_GLOBAL, P_NONE
} parm_class;
struct enum_list {
#endif
/* some helpful bits */
-#define iSECTION(i) ((section*)section_list.items)[i]
+#define iSECTION(i) ((local_vars*)section_list.items)[i]
#define LP_SNUM_OK(i) ((i) >= 0 && (i) < (int)section_list.count)
+#define SECTION_PTR(s, p) (((char*)(s)) + (ptrdiff_t)(((char*)(p))-(char*)&Locals))
/*
* This structure describes global (ie., server-wide) parameters.
char *socket_options;
int rsync_port;
-} global;
+} global_vars;
-static global Globals;
+static global_vars Globals;
/*
* This structure describes a single section. Their order must match the
BOOL munge_symlinks;
BOOL numeric_ids;
BOOL read_only;
+ BOOL reverse_lookup;
BOOL strict_modes;
BOOL transfer_logging;
BOOL use_chroot;
BOOL write_only;
-} section;
+} local_vars;
+
+static local_vars Locals;
-/* This is a default section used to prime a sections structure. In order
+typedef struct {
+ global_vars g;
+ local_vars l;
+} all_vars;
+
+/* This is used to reset all values before a config read. In order
* to make these easy to keep sorted in the same way as the variables
* above, use the variable name in the leading comment, including a
* trailing ';' (to avoid a sorting problem with trailing digits). */
-static section sDefault = {
+static const all_vars Defaults = {
+ /* ==== global_vars ==== */
+ {
+ /* bind_address; */ NULL,
+ /* motd_file; */ NULL,
+ /* pid_file; */ NULL,
+ /* socket_options; */ NULL,
+
+ /* rsync_port; */ 0,
+ },
+
+ /* ==== local_vars ==== */
+ {
/* auth_users; */ NULL,
/* charset; */ NULL,
/* comment; */ NULL,
/* munge_symlinks; */ (BOOL)-1,
/* numeric_ids; */ (BOOL)-1,
/* read_only; */ True,
+ /* reverse_lookup; */ True,
/* strict_modes; */ True,
/* transfer_logging; */ False,
/* use_chroot; */ True,
/* write_only; */ False,
+ }
};
/* local variables */
static item_list section_list = EMPTY_ITEM_LIST;
+static item_list section_stack = EMPTY_ITEM_LIST;
static int iSectionIndex = -1;
static BOOL bInGlobalSection = True;
{ -1, NULL }
};
-
-/* note that we do not initialise the defaults union - it is not allowed in ANSI C */
static struct parm_struct parm_table[] =
{
{"address", P_STRING, P_GLOBAL,&Globals.bind_address, NULL,0},
{"port", P_INTEGER,P_GLOBAL,&Globals.rsync_port, NULL,0},
{"socket options", P_STRING, P_GLOBAL,&Globals.socket_options, NULL,0},
- {"auth users", P_STRING, P_LOCAL, &sDefault.auth_users, NULL,0},
- {"charset", P_STRING, P_LOCAL, &sDefault.charset, NULL,0},
- {"comment", P_STRING, P_LOCAL, &sDefault.comment, NULL,0},
- {"dont compress", P_STRING, P_LOCAL, &sDefault.dont_compress, NULL,0},
- {"exclude from", P_STRING, P_LOCAL, &sDefault.exclude_from, NULL,0},
- {"exclude", P_STRING, P_LOCAL, &sDefault.exclude, NULL,0},
- {"fake super", P_BOOL, P_LOCAL, &sDefault.fake_super, NULL,0},
- {"filter", P_STRING, P_LOCAL, &sDefault.filter, NULL,0},
- {"gid", P_STRING, P_LOCAL, &sDefault.gid, NULL,0},
- {"hosts allow", P_STRING, P_LOCAL, &sDefault.hosts_allow, NULL,0},
- {"hosts deny", P_STRING, P_LOCAL, &sDefault.hosts_deny, NULL,0},
- {"ignore errors", P_BOOL, P_LOCAL, &sDefault.ignore_errors, NULL,0},
- {"ignore nonreadable",P_BOOL, P_LOCAL, &sDefault.ignore_nonreadable,NULL,0},
- {"include from", P_STRING, P_LOCAL, &sDefault.include_from, NULL,0},
- {"include", P_STRING, P_LOCAL, &sDefault.include, NULL,0},
- {"incoming chmod", P_STRING, P_LOCAL, &sDefault.incoming_chmod, NULL,0},
- {"list", P_BOOL, P_LOCAL, &sDefault.list, NULL,0},
- {"lock file", P_STRING, P_LOCAL, &sDefault.lock_file, NULL,0},
- {"log file", P_STRING, P_LOCAL, &sDefault.log_file, NULL,0},
- {"log format", P_STRING, P_LOCAL, &sDefault.log_format, NULL,0},
- {"max connections", P_INTEGER,P_LOCAL, &sDefault.max_connections, NULL,0},
- {"max verbosity", P_INTEGER,P_LOCAL, &sDefault.max_verbosity, NULL,0},
- {"munge symlinks", P_BOOL, P_LOCAL, &sDefault.munge_symlinks, NULL,0},
- {"name", P_STRING, P_LOCAL, &sDefault.name, NULL,0},
- {"numeric ids", P_BOOL, P_LOCAL, &sDefault.numeric_ids, NULL,0},
- {"outgoing chmod", P_STRING, P_LOCAL, &sDefault.outgoing_chmod, NULL,0},
- {"path", P_PATH, P_LOCAL, &sDefault.path, NULL,0},
+ {"auth users", P_STRING, P_LOCAL, &Locals.auth_users, NULL,0},
+ {"charset", P_STRING, P_LOCAL, &Locals.charset, NULL,0},
+ {"comment", P_STRING, P_LOCAL, &Locals.comment, NULL,0},
+ {"dont compress", P_STRING, P_LOCAL, &Locals.dont_compress, NULL,0},
+ {"exclude from", P_STRING, P_LOCAL, &Locals.exclude_from, NULL,0},
+ {"exclude", P_STRING, P_LOCAL, &Locals.exclude, NULL,0},
+ {"fake super", P_BOOL, P_LOCAL, &Locals.fake_super, NULL,0},
+ {"filter", P_STRING, P_LOCAL, &Locals.filter, NULL,0},
+ {"gid", P_STRING, P_LOCAL, &Locals.gid, NULL,0},
+ {"hosts allow", P_STRING, P_LOCAL, &Locals.hosts_allow, NULL,0},
+ {"hosts deny", P_STRING, P_LOCAL, &Locals.hosts_deny, NULL,0},
+ {"ignore errors", P_BOOL, P_LOCAL, &Locals.ignore_errors, NULL,0},
+ {"ignore nonreadable",P_BOOL, P_LOCAL, &Locals.ignore_nonreadable, NULL,0},
+ {"include from", P_STRING, P_LOCAL, &Locals.include_from, NULL,0},
+ {"include", P_STRING, P_LOCAL, &Locals.include, NULL,0},
+ {"incoming chmod", P_STRING, P_LOCAL, &Locals.incoming_chmod, NULL,0},
+ {"list", P_BOOL, P_LOCAL, &Locals.list, NULL,0},
+ {"lock file", P_STRING, P_LOCAL, &Locals.lock_file, NULL,0},
+ {"log file", P_STRING, P_LOCAL, &Locals.log_file, NULL,0},
+ {"log format", P_STRING, P_LOCAL, &Locals.log_format, NULL,0},
+ {"max connections", P_INTEGER,P_LOCAL, &Locals.max_connections, NULL,0},
+ {"max verbosity", P_INTEGER,P_LOCAL, &Locals.max_verbosity, NULL,0},
+ {"munge symlinks", P_BOOL, P_LOCAL, &Locals.munge_symlinks, NULL,0},
+ {"name", P_STRING, P_LOCAL, &Locals.name, NULL,0},
+ {"numeric ids", P_BOOL, P_LOCAL, &Locals.numeric_ids, NULL,0},
+ {"outgoing chmod", P_STRING, P_LOCAL, &Locals.outgoing_chmod, NULL,0},
+ {"path", P_PATH, P_LOCAL, &Locals.path, NULL,0},
#ifdef HAVE_PUTENV
- {"post-xfer exec", P_STRING, P_LOCAL, &sDefault.postxfer_exec, NULL,0},
- {"pre-xfer exec", P_STRING, P_LOCAL, &sDefault.prexfer_exec, NULL,0},
+ {"post-xfer exec", P_STRING, P_LOCAL, &Locals.postxfer_exec, NULL,0},
+ {"pre-xfer exec", P_STRING, P_LOCAL, &Locals.prexfer_exec, NULL,0},
#endif
- {"read only", P_BOOL, P_LOCAL, &sDefault.read_only, NULL,0},
- {"refuse options", P_STRING, P_LOCAL, &sDefault.refuse_options, NULL,0},
- {"secrets file", P_STRING, P_LOCAL, &sDefault.secrets_file, NULL,0},
- {"strict modes", P_BOOL, P_LOCAL, &sDefault.strict_modes, NULL,0},
- {"syslog facility", P_ENUM, P_LOCAL, &sDefault.syslog_facility,enum_facilities,0},
- {"temp dir", P_PATH, P_LOCAL, &sDefault.temp_dir, NULL,0},
- {"timeout", P_INTEGER,P_LOCAL, &sDefault.timeout, NULL,0},
- {"transfer logging", P_BOOL, P_LOCAL, &sDefault.transfer_logging, NULL,0},
- {"uid", P_STRING, P_LOCAL, &sDefault.uid, NULL,0},
- {"use chroot", P_BOOL, P_LOCAL, &sDefault.use_chroot, NULL,0},
- {"write only", P_BOOL, P_LOCAL, &sDefault.write_only, NULL,0},
+ {"read only", P_BOOL, P_LOCAL, &Locals.read_only, NULL,0},
+ {"refuse options", P_STRING, P_LOCAL, &Locals.refuse_options, NULL,0},
+ {"reverse lookup", P_BOOL, P_LOCAL, &Locals.reverse_lookup, NULL,0},
+ {"secrets file", P_STRING, P_LOCAL, &Locals.secrets_file, NULL,0},
+ {"strict modes", P_BOOL, P_LOCAL, &Locals.strict_modes, NULL,0},
+ {"syslog facility", P_ENUM, P_LOCAL, &Locals.syslog_facility, enum_facilities,0},
+ {"temp dir", P_PATH, P_LOCAL, &Locals.temp_dir, NULL,0},
+ {"timeout", P_INTEGER,P_LOCAL, &Locals.timeout, NULL,0},
+ {"transfer logging", P_BOOL, P_LOCAL, &Locals.transfer_logging, NULL,0},
+ {"uid", P_STRING, P_LOCAL, &Locals.uid, NULL,0},
+ {"use chroot", P_BOOL, P_LOCAL, &Locals.use_chroot, NULL,0},
+ {"write only", P_BOOL, P_LOCAL, &Locals.write_only, NULL,0},
{NULL, P_BOOL, P_NONE, NULL, NULL,0}
};
-/* Initialise the global parameter structure. */
-static void init_globals(void)
+/* Initialise the Default all_vars structure. */
+static void reset_all_vars(void)
{
- memset(&Globals, 0, sizeof Globals);
-}
-
-/* Initialise the sDefault parameter structure. */
-static void init_locals(void)
-{
- /* Nothing needed yet... */
+ memcpy(&Globals, &Defaults.g, sizeof Globals);
+ memcpy(&Locals, &Defaults.l, sizeof Locals);
}
/* In this section all the functions that are used to access the
int fn_name(void) {return *(int *)(ptr);}
#define FN_LOCAL_STRING(fn_name, val) \
- char *fn_name(int i) {return LP_SNUM_OK(i) && iSECTION(i).val? iSECTION(i).val : (sDefault.val? sDefault.val : "");}
+ char *fn_name(int i) {return LP_SNUM_OK(i) && iSECTION(i).val? iSECTION(i).val : (Locals.val? Locals.val : "");}
#define FN_LOCAL_BOOL(fn_name, val) \
- BOOL fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : sDefault.val;}
+ BOOL fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : Locals.val;}
#define FN_LOCAL_CHAR(fn_name, val) \
- char fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : sDefault.val;}
+ char fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : Locals.val;}
#define FN_LOCAL_INTEGER(fn_name, val) \
- int fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : sDefault.val;}
+ int fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : Locals.val;}
FN_GLOBAL_STRING(lp_bind_address, &Globals.bind_address)
FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
FN_LOCAL_BOOL(lp_munge_symlinks, munge_symlinks)
FN_LOCAL_BOOL(lp_numeric_ids, numeric_ids)
FN_LOCAL_BOOL(lp_read_only, read_only)
+FN_LOCAL_BOOL(lp_reverse_lookup, reverse_lookup)
FN_LOCAL_BOOL(lp_strict_modes, strict_modes)
FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
* FIXME There is a small leak here in that sometimes the existing
* value will be dynamically allocated, and the old copy is lost.
* However, we can't always deallocate the old value, because in the
- * case of sDefault, it points to a static string. It would be nice
+ * case of Locals, it points to a static string. It would be nice
* to have either all-strdup'd values, or to never need to free
* memory. */
static void string_set(char **s, const char *v)
return;
}
if (!(*s = strdup(v)))
- exit_cleanup(RERR_MALLOC);
+ out_of_memory("string_set");
}
-/* Copy a section structure to another. */
-static void copy_section(section *psectionDest, section *psectionSource)
+/* Copy the local_vars, duplicating any strings in the source. */
+static void copy_section(local_vars *psectionDest, local_vars *psectionSource)
{
int i;
for (i = 0; parm_table[i].label; i++) {
if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
void *def_ptr = parm_table[i].ptr;
- void *src_ptr = ((char *)psectionSource) + PTR_DIFF(def_ptr, &sDefault);
- void *dest_ptr = ((char *)psectionDest) + PTR_DIFF(def_ptr, &sDefault);
+ void *src_ptr = SECTION_PTR(psectionSource, def_ptr);
+ void *dest_ptr = SECTION_PTR(psectionDest, def_ptr);
switch (parm_table[i].type) {
case P_BOOL:
}
/* Initialise a section to the defaults. */
-static void init_section(section *psection)
+static void init_section(local_vars *psection)
{
- memset((char *)psection, 0, sizeof (section));
- copy_section(psection, &sDefault);
+ memset(psection, 0, sizeof Locals);
+ copy_section(psection, &Locals);
}
/* Do a case-insensitive, whitespace-ignoring string compare. */
}
/* Find a section by name. Otherwise works like get_section. */
-static int getsectionbyname(char *name, section *psectionDest)
+static int getsectionbyname(char *name)
{
int i;
for (i = section_list.count - 1; i >= 0; i--) {
- if (strwicmp(iSECTION(i).name, name) == 0) {
- if (psectionDest != NULL)
- copy_section(psectionDest, &iSECTION(i));
+ if (strwicmp(iSECTION(i).name, name) == 0)
break;
- }
}
return i;
static int add_a_section(char *name)
{
int i;
- section *s;
+ local_vars *s;
/* it might already exist */
if (name) {
- i = getsectionbyname(name, NULL);
+ i = getsectionbyname(name);
if (i >= 0)
return i;
}
i = section_list.count;
- s = EXPAND_ITEM_LIST(§ion_list, section, 2);
+ s = EXPAND_ITEM_LIST(§ion_list, local_vars, 2);
init_section(s);
if (name)
static BOOL do_parameter(char *parmname, char *parmvalue)
{
int parmnum, i;
- void *parm_ptr=NULL; /* where we are going to store the result */
- void *def_ptr=NULL;
+ void *parm_ptr; /* where we are going to store the result */
+ void *def_ptr;
char *cp;
parmnum = map_parameter(parmname);
rprintf(FLOG, "Global parameter %s found in module section!\n", parmname);
return True;
}
- parm_ptr = ((char *)&iSECTION(iSectionIndex)) + PTR_DIFF(def_ptr, &sDefault);
+ parm_ptr = SECTION_PTR(&iSECTION(iSectionIndex), def_ptr);
}
/* now switch on the type of variable it is */
string_set(parm_ptr, parmvalue);
break;
- case P_GSTRING:
- strlcpy((char *)parm_ptr, parmvalue, sizeof (pstring));
- break;
-
case P_ENUM:
- for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
+ for (i=0; parm_table[parmnum].enum_list[i].name; i++) {
if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
*(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
break;
*(int *)parm_ptr = atoi(parmvalue);
}
break;
- case P_SEP:
- break;
}
return True;
* Returns True on success, False on failure. */
static BOOL do_section(char *sectionname)
{
- BOOL isglobal = strwicmp(sectionname, GLOBAL_NAME) == 0;
+ BOOL isglobal;
+
+ if (*sectionname == ']') { /* A special push/pop/reset directive from params.c */
+ bInGlobalSection = 1;
+ if (strcmp(sectionname+1, "push") == 0) {
+ all_vars *vp = EXPAND_ITEM_LIST(§ion_stack, all_vars, 2);
+ memcpy(&vp->g, &Globals, sizeof Globals);
+ memcpy(&vp->l, &Locals, sizeof Locals);
+ } else if (strcmp(sectionname+1, "pop") == 0
+ || strcmp(sectionname+1, "reset") == 0) {
+ all_vars *vp = ((all_vars*)section_stack.items) + section_stack.count - 1;
+ if (!section_stack.count)
+ return False;
+ memcpy(&Globals, &vp->g, sizeof Globals);
+ memcpy(&Locals, &vp->l, sizeof Locals);
+ if (sectionname[1] == 'p')
+ section_stack.count--;
+ } else
+ return False;
+ return True;
+ }
- /* if we were in a global section then do the local inits */
- if (bInGlobalSection && !isglobal)
- init_locals();
+ isglobal = strwicmp(sectionname, GLOBAL_NAME) == 0;
+
+ /* At the end of the global section, add any --dparam items. */
+ if (bInGlobalSection && !isglobal) {
+ if (!section_list.count)
+ set_dparams(0);
+ }
/* if we've just struck a global section, note the fact. */
bInGlobalSection = isglobal;
/* Load the modules from the config file. Return True on success,
* False on failure. */
-BOOL lp_load(char *pszFname, int globals_only)
+int lp_load(char *pszFname, int globals_only)
{
- pstring n2;
-
bInGlobalSection = True;
- init_globals();
-
- pstrcpy(n2, pszFname);
+ reset_all_vars();
/* We get sections first, so have to start 'behind' to make up. */
iSectionIndex = -1;
- return pm_process(n2, globals_only ? NULL : do_section, do_parameter);
+ return pm_process(pszFname, globals_only ? NULL : do_section, do_parameter);
+}
+
+BOOL set_dparams(int syntax_check_only)
+{
+ char *equal, *val, **params = dparam_list.items;
+ unsigned j;
+
+ for (j = 0; j < dparam_list.count; j++) {
+ equal = strchr(params[j], '='); /* options.c verified this */
+ *equal = '\0';
+ if (syntax_check_only) {
+ if (map_parameter(params[j]) < 0) {
+ rprintf(FERROR, "Unknown parameter \"%s\"\n", params[j]);
+ *equal = '=';
+ return False;
+ }
+ } else {
+ for (val = equal+1; isSpace(val); val++) {}
+ do_parameter(params[j], val);
+ }
+ *equal = '=';
+ }
+
+ return True;
}
/* Return the max number of modules (sections). */