* 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"
+#include "itypes.h"
extern item_list dparam_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 *)&sDefault))
+#define SECTION_PTR(s, p) (((char*)(s)) + (ptrdiff_t)(((char*)(p))-(char*)&Vars.l))
-/*
- * This structure describes global (ie., server-wide) parameters.
- */
+/* This structure describes global (ie., server-wide) parameters. */
typedef struct {
char *bind_address;
char *motd_file;
char *socket_options;
int rsync_port;
-} global;
-
-static global Globals;
+} global_vars;
-/*
- * This structure describes a single section. Their order must match the
+/* This structure describes a single section. Their order must match the
* initializers below, which you can accomplish by keeping each sub-section
* sorted. (e.g. in vim, just visually select each subsection and use !sort.)
- */
+ * NOTE: the char* variables MUST all remain at the start of the stuct! */
typedef struct {
char *auth_users;
char *charset;
char *secrets_file;
char *temp_dir;
char *uid;
+/* NOTE: update this macro if the last char* variable changes! */
+#define LOCAL_STRING_COUNT() (offsetof(local_vars, uid) / sizeof (char*) + 1)
int max_connections;
int max_verbosity;
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;
+/* This structure describes the global variables (g) as well as the globally
+ * specified values of the local variables (l), which are used when modules
+ * don't specify their own values. */
typedef struct {
- global g;
- section s;
-} global_and_section;
+ global_vars g;
+ local_vars l;
+} all_vars;
-/* This is a default section used to prime a sections structure. In order
- * to make these easy to keep sorted in the same way as the variables
+/* The application defaults for all the variables. "Defaults" is
+ * used to re-initialize "Vars" before each config-file read.
+ *
+ * In order to keep these sorted in the same way as the structure
* 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,
/* exclude; */ NULL,
/* exclude_from; */ NULL,
/* filter; */ NULL,
- /* gid; */ NOBODY_GROUP,
+ /* gid; */ NULL,
/* hosts_allow; */ NULL,
/* hosts_deny; */ NULL,
/* include; */ NULL,
/* refuse_options; */ NULL,
/* secrets_file; */ NULL,
/* temp_dir; */ NULL,
- /* uid; */ NOBODY_USER,
+ /* uid; */ NULL,
/* max_connections; */ 0,
/* max_verbosity; */ 1,
/* 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 */
+/* The currently configured values for all the variables. */
+static all_vars Vars;
+
+/* Stack of "Vars" values used by the &include directive. */
+static item_list Vars_stack = EMPTY_ITEM_LIST;
+
+/* The array of section values that holds all the defined modules. */
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},
- {"motd file", P_STRING, P_GLOBAL,&Globals.motd_file, NULL,0},
- {"pid file", P_STRING, P_GLOBAL,&Globals.pid_file, 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},
+ {"address", P_STRING, P_GLOBAL,&Vars.g.bind_address, NULL,0},
+ {"motd file", P_STRING, P_GLOBAL,&Vars.g.motd_file, NULL,0},
+ {"pid file", P_STRING, P_GLOBAL,&Vars.g.pid_file, NULL,0},
+ {"port", P_INTEGER,P_GLOBAL,&Vars.g.rsync_port, NULL,0},
+ {"socket options", P_STRING, P_GLOBAL,&Vars.g.socket_options, NULL,0},
+
+ {"auth users", P_STRING, P_LOCAL, &Vars.l.auth_users, NULL,0},
+ {"charset", P_STRING, P_LOCAL, &Vars.l.charset, NULL,0},
+ {"comment", P_STRING, P_LOCAL, &Vars.l.comment, NULL,0},
+ {"dont compress", P_STRING, P_LOCAL, &Vars.l.dont_compress, NULL,0},
+ {"exclude from", P_STRING, P_LOCAL, &Vars.l.exclude_from, NULL,0},
+ {"exclude", P_STRING, P_LOCAL, &Vars.l.exclude, NULL,0},
+ {"fake super", P_BOOL, P_LOCAL, &Vars.l.fake_super, NULL,0},
+ {"filter", P_STRING, P_LOCAL, &Vars.l.filter, NULL,0},
+ {"gid", P_STRING, P_LOCAL, &Vars.l.gid, NULL,0},
+ {"hosts allow", P_STRING, P_LOCAL, &Vars.l.hosts_allow, NULL,0},
+ {"hosts deny", P_STRING, P_LOCAL, &Vars.l.hosts_deny, NULL,0},
+ {"ignore errors", P_BOOL, P_LOCAL, &Vars.l.ignore_errors, NULL,0},
+ {"ignore nonreadable",P_BOOL, P_LOCAL, &Vars.l.ignore_nonreadable, NULL,0},
+ {"include from", P_STRING, P_LOCAL, &Vars.l.include_from, NULL,0},
+ {"include", P_STRING, P_LOCAL, &Vars.l.include, NULL,0},
+ {"incoming chmod", P_STRING, P_LOCAL, &Vars.l.incoming_chmod, NULL,0},
+ {"list", P_BOOL, P_LOCAL, &Vars.l.list, NULL,0},
+ {"lock file", P_STRING, P_LOCAL, &Vars.l.lock_file, NULL,0},
+ {"log file", P_STRING, P_LOCAL, &Vars.l.log_file, NULL,0},
+ {"log format", P_STRING, P_LOCAL, &Vars.l.log_format, NULL,0},
+ {"max connections", P_INTEGER,P_LOCAL, &Vars.l.max_connections, NULL,0},
+ {"max verbosity", P_INTEGER,P_LOCAL, &Vars.l.max_verbosity, NULL,0},
+ {"munge symlinks", P_BOOL, P_LOCAL, &Vars.l.munge_symlinks, NULL,0},
+ {"name", P_STRING, P_LOCAL, &Vars.l.name, NULL,0},
+ {"numeric ids", P_BOOL, P_LOCAL, &Vars.l.numeric_ids, NULL,0},
+ {"outgoing chmod", P_STRING, P_LOCAL, &Vars.l.outgoing_chmod, NULL,0},
+ {"path", P_PATH, P_LOCAL, &Vars.l.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, &Vars.l.postxfer_exec, NULL,0},
+ {"pre-xfer exec", P_STRING, P_LOCAL, &Vars.l.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, &Vars.l.read_only, NULL,0},
+ {"refuse options", P_STRING, P_LOCAL, &Vars.l.refuse_options, NULL,0},
+ {"reverse lookup", P_BOOL, P_LOCAL, &Vars.l.reverse_lookup, NULL,0},
+ {"secrets file", P_STRING, P_LOCAL, &Vars.l.secrets_file, NULL,0},
+ {"strict modes", P_BOOL, P_LOCAL, &Vars.l.strict_modes, NULL,0},
+ {"syslog facility", P_ENUM, P_LOCAL, &Vars.l.syslog_facility, enum_facilities,0},
+ {"temp dir", P_PATH, P_LOCAL, &Vars.l.temp_dir, NULL,0},
+ {"timeout", P_INTEGER,P_LOCAL, &Vars.l.timeout, NULL,0},
+ {"transfer logging", P_BOOL, P_LOCAL, &Vars.l.transfer_logging, NULL,0},
+ {"uid", P_STRING, P_LOCAL, &Vars.l.uid, NULL,0},
+ {"use chroot", P_BOOL, P_LOCAL, &Vars.l.use_chroot, NULL,0},
+ {"write only", P_BOOL, P_LOCAL, &Vars.l.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(&Vars, &Defaults, sizeof Vars);
}
/* 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 : (Vars.l.val? Vars.l.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 : Vars.l.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 : Vars.l.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 : Vars.l.val;}
-FN_GLOBAL_STRING(lp_bind_address, &Globals.bind_address)
-FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
-FN_GLOBAL_STRING(lp_pid_file, &Globals.pid_file)
-FN_GLOBAL_STRING(lp_socket_options, &Globals.socket_options)
+FN_GLOBAL_STRING(lp_bind_address, &Vars.g.bind_address)
+FN_GLOBAL_STRING(lp_motd_file, &Vars.g.motd_file)
+FN_GLOBAL_STRING(lp_pid_file, &Vars.g.pid_file)
+FN_GLOBAL_STRING(lp_socket_options, &Vars.g.socket_options)
-FN_GLOBAL_INTEGER(lp_rsync_port, &Globals.rsync_port)
+FN_GLOBAL_INTEGER(lp_rsync_port, &Vars.g.rsync_port)
FN_LOCAL_STRING(lp_auth_users, auth_users)
FN_LOCAL_STRING(lp_charset, charset)
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)
FN_LOCAL_BOOL(lp_write_only, write_only)
-/* Assign a copy of v to *s. Handles NULL strings. *v must
- * be initialized when this is called, either to NULL or a malloc'd
- * string.
- *
- * 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
- * to have either all-strdup'd values, or to never need to free
- * memory. */
-static void string_set(char **s, const char *v)
+/* Assign a copy of v to *s. Handles NULL strings. We don't worry
+ * about overwriting a malloc'd string because the long-running
+ * (port-listening) daemon only loads the config file once, and the
+ * per-job (forked or xinitd-ran) daemon only re-reads the file at
+ * the start, so any lost memory is inconsequential. */
+static inline void string_set(char **s, const char *v)
{
- if (!v) {
+ if (!v)
*s = NULL;
- return;
- }
- if (!(*s = strdup(v)))
- exit_cleanup(RERR_MALLOC);
+ else if (!(*s = strdup(v)))
+ out_of_memory("string_set");
}
-/* Copy a section structure to another. */
-static void copy_section(section *psectionDest, section *psectionSource)
+/* Copy the local_vars, strdup'ing any strings. NOTE: this depends on
+ * the structure starting with a contiguous list of the char* variables,
+ * and having an accurate count in the LOCAL_STRING_COUNT() macro. */
+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 = SECTION_PTR(psectionSource, def_ptr);
- void *dest_ptr = SECTION_PTR(psectionDest, def_ptr);
-
- switch (parm_table[i].type) {
- case P_BOOL:
- case P_BOOLREV:
- *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
- break;
-
- case P_INTEGER:
- case P_ENUM:
- case P_OCTAL:
- *(int *)dest_ptr = *(int *)src_ptr;
- break;
+ int count = LOCAL_STRING_COUNT();
+ char **strings = (char**)psectionDest;
- case P_CHAR:
- *(char *)dest_ptr = *(char *)src_ptr;
- break;
-
- case P_PATH:
- case P_STRING:
- string_set(dest_ptr, *(char **)src_ptr);
- break;
-
- default:
- break;
- }
- }
+ memcpy(psectionDest, psectionSource, sizeof psectionDest[0]);
+ while (count--) {
+ if (strings[count] && !(strings[count] = strdup(strings[count])))
+ out_of_memory("copy_section");
}
}
/* 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 (local_vars));
+ copy_section(psection, &Vars.l);
}
/* 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)
if (*sectionname == ']') { /* A special push/pop/reset directive from params.c */
bInGlobalSection = 1;
if (strcmp(sectionname+1, "push") == 0) {
- global_and_section *gs = EXPAND_ITEM_LIST(§ion_stack, global_and_section, 2);
- memcpy(&gs->g, &Globals, sizeof Globals);
- memcpy(&gs->s, &sDefault, sizeof sDefault);
+ all_vars *vp = EXPAND_ITEM_LIST(&Vars_stack, all_vars, 2);
+ memcpy(vp, &Vars, sizeof Vars);
} else if (strcmp(sectionname+1, "pop") == 0
|| strcmp(sectionname+1, "reset") == 0) {
- global_and_section *gs = ((global_and_section *)section_stack.items) + section_stack.count - 1;
- if (!section_stack.count)
+ all_vars *vp = ((all_vars*)Vars_stack.items) + Vars_stack.count - 1;
+ if (!Vars_stack.count)
return False;
- memcpy(&Globals, &gs->g, sizeof Globals);
- memcpy(&sDefault, &gs->s, sizeof sDefault);
+ memcpy(&Vars, vp, sizeof Vars);
if (sectionname[1] == 'p')
- section_stack.count--;
+ Vars_stack.count--;
} else
return False;
return True;
isglobal = strwicmp(sectionname, GLOBAL_NAME) == 0;
- /* if we were in a global section then do the local inits */
+ /* At the end of the global section, add any --dparam items. */
if (bInGlobalSection && !isglobal) {
if (!section_list.count)
set_dparams(0);
- init_locals();
}
/* if we've just struck a global section, note the fact. */
{
bInGlobalSection = True;
- init_globals();
+ reset_all_vars();
/* We get sections first, so have to start 'behind' to make up. */
iSectionIndex = -1;
*equal = '\0';
if (syntax_check_only) {
if (map_parameter(params[j]) < 0) {
- rprintf(FCLIENT, "Unknown parameter \"%s\"\n", params[j]);
+ rprintf(FERROR, "Unknown parameter \"%s\"\n", params[j]);
*equal = '=';
return False;
}
Matt McCutchen's Web Site / rsync / rsync.git / blobdiff