loadparm.c

   1 /*
   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.
   6  *
   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.
  11  *
  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.
  14  */
  15
  16 /* This is based on loadparm.c from Samba, written by Andrew Tridgell
  17  * and Karl Auer.  Some of the changes are:
  18  *
  19  * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
  20  * Copyright (C) 2003-2018 Wayne Davison <wayned@samba.org>
  21  */
  22
  23 /* Load parameters.
  24  *
  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.
  28  *
  29  * To add a parameter:
  30  *
  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
  35  *
  36  * Notes:
  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,
  41  *   so be careful!
  42  */
  43
  44 #include "rsync.h"
  45 #include "itypes.h"
  46
  47 extern item_list dparam_list;
  48
  49 #define strequal(a, b) (strcasecmp(a, b)==0)
  50 #define BOOLSTR(b) ((b) ? "Yes" : "No")
  51
  52 #ifndef LOG_DAEMON
  53 #define LOG_DAEMON 0
  54 #endif
  55
  56 #define DEFAULT_DONT_COMPRESS "*.gz *.zip *.z *.rpm *.deb *.iso *.bz2" \
  57         " *.t[gb]z *.7z *.mp[34] *.mov *.avi *.ogg *.jpg *.jpeg *.png" \
  58         " *.lzo *.rzip *.lzma *.rar *.ace *.gpg *.xz *.txz *.lz *.tlz"
  59
  60 /* the following are used by loadparm for option lists */
  61 typedef enum {
  62         P_BOOL, P_BOOLREV, P_CHAR, P_INTEGER,
  63         P_OCTAL, P_PATH, P_STRING, P_ENUM
  64 } parm_type;
  65
  66 typedef enum {
  67         P_LOCAL, P_GLOBAL, P_NONE
  68 } parm_class;
  69
  70 struct enum_list {
  71         int value;
  72         char *name;
  73 };
  74
  75 struct parm_struct {
  76         char *label;
  77         parm_type type;
  78         parm_class class;
  79         void *ptr;
  80         struct enum_list *enum_list;
  81         unsigned flags;
  82 };
  83
  84 #ifndef GLOBAL_NAME
  85 #define GLOBAL_NAME "global"
  86 #endif
  87
  88 /* some helpful bits */
  89 #define iSECTION(i) ((local_vars*)section_list.items)[i]
  90 #define LP_SNUM_OK(i) ((i) >= 0 && (i) < (int)section_list.count)
  91 #define SECTION_PTR(s, p) (((char*)(s)) + (ptrdiff_t)(((char*)(p))-(char*)&Vars.l))
  92
  93 /* This structure describes global (ie., server-wide) parameters. */
  94 typedef struct {
  95         char *bind_address;
  96         char *daemon_chroot;
  97         char *daemon_gid;
  98         char *daemon_uid;
  99         char *motd_file;
 100         char *pid_file;
 101         char *socket_options;
 102
 103         int listen_backlog;
 104         int rsync_port;
 105 } global_vars;
 106
 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.)
 110  * NOTE: the char* variables MUST all remain at the start of the stuct! */
 111 typedef struct {
 112         char *auth_users;
 113         char *charset;
 114         char *comment;
 115         char *dont_compress;
 116         char *exclude;
 117         char *exclude_from;
 118         char *filter;
 119         char *gid;
 120         char *hosts_allow;
 121         char *hosts_deny;
 122         char *include;
 123         char *include_from;
 124         char *incoming_chmod;
 125         char *lock_file;
 126         char *log_file;
 127         char *log_format;
 128         char *name;
 129         char *outgoing_chmod;
 130         char *path;
 131         char *postxfer_exec;
 132         char *prexfer_exec;
 133         char *refuse_options;
 134         char *secrets_file;
 135         char *syslog_tag;
 136         char *temp_dir;
 137         char *uid;
 138
 139         int max_connections;
 140         int max_verbosity;
 141         int syslog_facility;
 142         int timeout;
 143
 144         BOOL fake_super;
 145         BOOL forward_lookup;
 146         BOOL ignore_errors;
 147         BOOL ignore_nonreadable;
 148         BOOL list;
 149         BOOL munge_symlinks;
 150         BOOL numeric_ids;
 151         BOOL read_only;
 152         BOOL reverse_lookup;
 153         BOOL strict_modes;
 154         BOOL transfer_logging;
 155         BOOL use_chroot;
 156         BOOL write_only;
 157 } local_vars;
 158
 159 /* This structure describes the global variables (g) as well as the globally
 160  * specified values of the local variables (l), which are used when modules
 161  * don't specify their own values. */
 162 typedef struct {
 163         global_vars g;
 164         local_vars l;
 165 } all_vars;
 166
 167 /* The application defaults for all the variables.  "Defaults" is
 168  * used to re-initialize "Vars" before each config-file read.
 169  *
 170  * In order to keep these sorted in the same way as the structure
 171  * above, use the variable name in the leading comment, including a
 172  * trailing ';' (to avoid a sorting problem with trailing digits). */
 173 static const all_vars Defaults = {
 174  /* ==== global_vars ==== */
 175  {
 176  /* bind_address; */            NULL,
 177  /* daemon_chroot; */           NULL,
 178  /* daemon_gid; */              NULL,
 179  /* daemon_uid; */              NULL,
 180  /* motd_file; */               NULL,
 181  /* pid_file; */                NULL,
 182  /* socket_options; */          NULL,
 183
 184  /* listen_backlog; */          5,
 185  /* rsync_port; */              0,
 186  },
 187
 188  /* ==== local_vars ==== */
 189  {
 190  /* auth_users; */              NULL,
 191  /* charset; */                 NULL,
 192  /* comment; */                 NULL,
 193  /* dont_compress; */           DEFAULT_DONT_COMPRESS,
 194  /* exclude; */                 NULL,
 195  /* exclude_from; */            NULL,
 196  /* filter; */                  NULL,
 197  /* gid; */                     NULL,
 198  /* hosts_allow; */             NULL,
 199  /* hosts_deny; */              NULL,
 200  /* include; */                 NULL,
 201  /* include_from; */            NULL,
 202  /* incoming_chmod; */          NULL,
 203  /* lock_file; */               DEFAULT_LOCK_FILE,
 204  /* log_file; */                NULL,
 205  /* log_format; */              "%o %h [%a] %m (%u) %f %l",
 206  /* name; */                    NULL,
 207  /* outgoing_chmod; */          NULL,
 208  /* path; */                    NULL,
 209  /* postxfer_exec; */           NULL,
 210  /* prexfer_exec; */            NULL,
 211  /* refuse_options; */          NULL,
 212  /* secrets_file; */            NULL,
 213  /* syslog_tag; */              "rsyncd",
 214  /* temp_dir; */                NULL,
 215  /* uid; */                     NULL,
 216
 217  /* max_connections; */         0,
 218  /* max_verbosity; */           1,
 219  /* syslog_facility; */         LOG_DAEMON,
 220  /* timeout; */                 0,
 221
 222  /* fake_super; */              False,
 223  /* forward_lookup; */          True,
 224  /* ignore_errors; */           False,
 225  /* ignore_nonreadable; */      False,
 226  /* list; */                    True,
 227  /* munge_symlinks; */          (BOOL)-1,
 228  /* numeric_ids; */             (BOOL)-1,
 229  /* read_only; */               True,
 230  /* reverse_lookup; */          True,
 231  /* strict_modes; */            True,
 232  /* transfer_logging; */        False,
 233  /* use_chroot; */              True,
 234  /* write_only; */              False,
 235  }
 236 };
 237
 238 /* The currently configured values for all the variables. */
 239 static all_vars Vars;
 240
 241 /* Stack of "Vars" values used by the &include directive. */
 242 static item_list Vars_stack = EMPTY_ITEM_LIST;
 243
 244 /* The array of section values that holds all the defined modules. */
 245 static item_list section_list = EMPTY_ITEM_LIST;
 246
 247 static int iSectionIndex = -1;
 248 static BOOL bInGlobalSection = True;
 249
 250 #define NUMPARAMETERS (sizeof (parm_table) / sizeof (struct parm_struct))
 251
 252 static struct enum_list enum_facilities[] = {
 253 #ifdef LOG_AUTH
 254         { LOG_AUTH, "auth" },
 255 #endif
 256 #ifdef LOG_AUTHPRIV
 257         { LOG_AUTHPRIV, "authpriv" },
 258 #endif
 259 #ifdef LOG_CRON
 260         { LOG_CRON, "cron" },
 261 #endif
 262 #ifdef LOG_DAEMON
 263         { LOG_DAEMON, "daemon" },
 264 #endif
 265 #ifdef LOG_FTP
 266         { LOG_FTP, "ftp" },
 267 #endif
 268 #ifdef LOG_KERN
 269         { LOG_KERN, "kern" },
 270 #endif
 271 #ifdef LOG_LPR
 272         { LOG_LPR, "lpr" },
 273 #endif
 274 #ifdef LOG_MAIL
 275         { LOG_MAIL, "mail" },
 276 #endif
 277 #ifdef LOG_NEWS
 278         { LOG_NEWS, "news" },
 279 #endif
 280 #ifdef LOG_AUTH
 281         { LOG_AUTH, "security" },
 282 #endif
 283 #ifdef LOG_SYSLOG
 284         { LOG_SYSLOG, "syslog" },
 285 #endif
 286 #ifdef LOG_USER
 287         { LOG_USER, "user" },
 288 #endif
 289 #ifdef LOG_UUCP
 290         { LOG_UUCP, "uucp" },
 291 #endif
 292 #ifdef LOG_LOCAL0
 293         { LOG_LOCAL0, "local0" },
 294 #endif
 295 #ifdef LOG_LOCAL1
 296         { LOG_LOCAL1, "local1" },
 297 #endif
 298 #ifdef LOG_LOCAL2
 299         { LOG_LOCAL2, "local2" },
 300 #endif
 301 #ifdef LOG_LOCAL3
 302         { LOG_LOCAL3, "local3" },
 303 #endif
 304 #ifdef LOG_LOCAL4
 305         { LOG_LOCAL4, "local4" },
 306 #endif
 307 #ifdef LOG_LOCAL5
 308         { LOG_LOCAL5, "local5" },
 309 #endif
 310 #ifdef LOG_LOCAL6
 311         { LOG_LOCAL6, "local6" },
 312 #endif
 313 #ifdef LOG_LOCAL7
 314         { LOG_LOCAL7, "local7" },
 315 #endif
 316         { -1, NULL }
 317 };
 318
 319 static struct parm_struct parm_table[] =
 320 {
 321  {"address",           P_STRING, P_GLOBAL,&Vars.g.bind_address,        NULL,0},
 322  {"daemon chroot",     P_STRING, P_GLOBAL,&Vars.g.daemon_chroot,       NULL,0},
 323  {"daemon gid",        P_STRING, P_GLOBAL,&Vars.g.daemon_gid,          NULL,0},
 324  {"daemon uid",        P_STRING, P_GLOBAL,&Vars.g.daemon_uid,          NULL,0},
 325  {"listen backlog",    P_INTEGER,P_GLOBAL,&Vars.g.listen_backlog,      NULL,0},
 326  {"motd file",         P_STRING, P_GLOBAL,&Vars.g.motd_file,           NULL,0},
 327  {"pid file",          P_STRING, P_GLOBAL,&Vars.g.pid_file,            NULL,0},
 328  {"port",              P_INTEGER,P_GLOBAL,&Vars.g.rsync_port,          NULL,0},
 329  {"socket options",    P_STRING, P_GLOBAL,&Vars.g.socket_options,      NULL,0},
 330
 331  {"auth users",        P_STRING, P_LOCAL, &Vars.l.auth_users,          NULL,0},
 332  {"charset",           P_STRING, P_LOCAL, &Vars.l.charset,             NULL,0},
 333  {"comment",           P_STRING, P_LOCAL, &Vars.l.comment,             NULL,0},
 334  {"dont compress",     P_STRING, P_LOCAL, &Vars.l.dont_compress,       NULL,0},
 335  {"exclude from",      P_STRING, P_LOCAL, &Vars.l.exclude_from,        NULL,0},
 336  {"exclude",           P_STRING, P_LOCAL, &Vars.l.exclude,             NULL,0},
 337  {"fake super",        P_BOOL,   P_LOCAL, &Vars.l.fake_super,          NULL,0},
 338  {"filter",            P_STRING, P_LOCAL, &Vars.l.filter,              NULL,0},
 339  {"forward lookup",    P_BOOL,   P_LOCAL, &Vars.l.forward_lookup,      NULL,0},
 340  {"gid",               P_STRING, P_LOCAL, &Vars.l.gid,                 NULL,0},
 341  {"hosts allow",       P_STRING, P_LOCAL, &Vars.l.hosts_allow,         NULL,0},
 342  {"hosts deny",        P_STRING, P_LOCAL, &Vars.l.hosts_deny,          NULL,0},
 343  {"ignore errors",     P_BOOL,   P_LOCAL, &Vars.l.ignore_errors,       NULL,0},
 344  {"ignore nonreadable",P_BOOL,   P_LOCAL, &Vars.l.ignore_nonreadable,  NULL,0},
 345  {"include from",      P_STRING, P_LOCAL, &Vars.l.include_from,        NULL,0},
 346  {"include",           P_STRING, P_LOCAL, &Vars.l.include,             NULL,0},
 347  {"incoming chmod",    P_STRING, P_LOCAL, &Vars.l.incoming_chmod,      NULL,0},
 348  {"list",              P_BOOL,   P_LOCAL, &Vars.l.list,                NULL,0},
 349  {"lock file",         P_STRING, P_LOCAL, &Vars.l.lock_file,           NULL,0},
 350  {"log file",          P_STRING, P_LOCAL, &Vars.l.log_file,            NULL,0},
 351  {"log format",        P_STRING, P_LOCAL, &Vars.l.log_format,          NULL,0},
 352  {"max connections",   P_INTEGER,P_LOCAL, &Vars.l.max_connections,     NULL,0},
 353  {"max verbosity",     P_INTEGER,P_LOCAL, &Vars.l.max_verbosity,       NULL,0},
 354  {"munge symlinks",    P_BOOL,   P_LOCAL, &Vars.l.munge_symlinks,      NULL,0},
 355  {"name",              P_STRING, P_LOCAL, &Vars.l.name,                NULL,0},
 356  {"numeric ids",       P_BOOL,   P_LOCAL, &Vars.l.numeric_ids,         NULL,0},
 357  {"outgoing chmod",    P_STRING, P_LOCAL, &Vars.l.outgoing_chmod,      NULL,0},
 358  {"path",              P_PATH,   P_LOCAL, &Vars.l.path,                NULL,0},
 359 #ifdef HAVE_PUTENV
 360  {"post-xfer exec",    P_STRING, P_LOCAL, &Vars.l.postxfer_exec,       NULL,0},
 361  {"pre-xfer exec",     P_STRING, P_LOCAL, &Vars.l.prexfer_exec,        NULL,0},
 362 #endif
 363  {"read only",         P_BOOL,   P_LOCAL, &Vars.l.read_only,           NULL,0},
 364  {"refuse options",    P_STRING, P_LOCAL, &Vars.l.refuse_options,      NULL,0},
 365  {"reverse lookup",    P_BOOL,   P_LOCAL, &Vars.l.reverse_lookup,      NULL,0},
 366  {"secrets file",      P_STRING, P_LOCAL, &Vars.l.secrets_file,        NULL,0},
 367  {"strict modes",      P_BOOL,   P_LOCAL, &Vars.l.strict_modes,        NULL,0},
 368  {"syslog facility",   P_ENUM,   P_LOCAL, &Vars.l.syslog_facility,     enum_facilities,0},
 369  {"syslog tag",        P_STRING, P_LOCAL, &Vars.l.syslog_tag,          NULL,0},
 370  {"temp dir",          P_PATH,   P_LOCAL, &Vars.l.temp_dir,            NULL,0},
 371  {"timeout",           P_INTEGER,P_LOCAL, &Vars.l.timeout,             NULL,0},
 372  {"transfer logging",  P_BOOL,   P_LOCAL, &Vars.l.transfer_logging,    NULL,0},
 373  {"uid",               P_STRING, P_LOCAL, &Vars.l.uid,                 NULL,0},
 374  {"use chroot",        P_BOOL,   P_LOCAL, &Vars.l.use_chroot,          NULL,0},
 375  {"write only",        P_BOOL,   P_LOCAL, &Vars.l.write_only,          NULL,0},
 376  {NULL,                P_BOOL,   P_NONE,  NULL,                        NULL,0}
 377 };
 378
 379 /* Initialise the Default all_vars structure. */
 380 static void reset_all_vars(void)
 381 {
 382         memcpy(&Vars, &Defaults, sizeof Vars);
 383 }
 384
 385 /* Expand %VAR% references.  Any unknown vars or unrecognized
 386  * syntax leaves the raw chars unchanged. */
 387 static char *expand_vars(char *str)
 388 {
 389         char *buf, *t, *f;
 390         int bufsize;
 391
 392         if (!str || !strchr(str, '%'))
 393                 return str;
 394
 395         bufsize = strlen(str) + 2048;
 396         if ((buf = new_array(char, bufsize+1)) == NULL) /* +1 for trailing '\0' */
 397                 out_of_memory("expand_vars");
 398
 399         for (t = buf, f = str; bufsize && *f; ) {
 400                 if (*f == '%' && *++f != '%') {
 401                         char *percent = strchr(f, '%');
 402                         if (percent) {
 403                                 char *val;
 404                                 *percent = '\0';
 405                                 val = getenv(f);
 406                                 *percent = '%';
 407                                 if (val) {
 408                                         int len = strlcpy(t, val, bufsize+1);
 409                                         if (len > bufsize)
 410                                                 break;
 411                                         bufsize -= len;
 412                                         t += len;
 413                                         f = percent + 1;
 414                                         continue;
 415                                 }
 416                         }
 417                         f--;
 418                 }
 419                 *t++ = *f++;
 420                 bufsize--;
 421         }
 422         *t = '\0';
 423
 424         if (*f) {
 425                 rprintf(FLOG, "Overflowed buf in expand_vars() trying to expand: %s\n", str);
 426                 exit_cleanup(RERR_MALLOC);
 427         }
 428
 429         if (bufsize && (buf = realloc(buf, t - buf + 1)) == NULL)
 430                 out_of_memory("expand_vars");
 431
 432         return buf;
 433 }
 434
 435 /* In this section all the functions that are used to access the
 436  * parameters from the rest of the program are defined. */
 437
 438 #define FN_GLOBAL_STRING(fn_name, ptr) \
 439  char *fn_name(void) {return expand_vars(*(char **)(ptr) ? *(char **)(ptr) : "");}
 440 #define FN_GLOBAL_BOOL(fn_name, ptr) \
 441  BOOL fn_name(void) {return *(BOOL *)(ptr);}
 442 #define FN_GLOBAL_CHAR(fn_name, ptr) \
 443  char fn_name(void) {return *(char *)(ptr);}
 444 #define FN_GLOBAL_INTEGER(fn_name, ptr) \
 445  int fn_name(void) {return *(int *)(ptr);}
 446
 447 #define FN_LOCAL_STRING(fn_name, val) \
 448  char *fn_name(int i) {return expand_vars(LP_SNUM_OK(i) && iSECTION(i).val ? iSECTION(i).val : Vars.l.val ? Vars.l.val : "");}
 449 #define FN_LOCAL_BOOL(fn_name, val) \
 450  BOOL fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : Vars.l.val;}
 451 #define FN_LOCAL_CHAR(fn_name, val) \
 452  char fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : Vars.l.val;}
 453 #define FN_LOCAL_INTEGER(fn_name, val) \
 454  int fn_name(int i) {return LP_SNUM_OK(i)? iSECTION(i).val : Vars.l.val;}
 455
 456 FN_GLOBAL_STRING(lp_bind_address, &Vars.g.bind_address)
 457 FN_GLOBAL_STRING(lp_daemon_chroot, &Vars.g.daemon_chroot)
 458 FN_GLOBAL_STRING(lp_daemon_gid, &Vars.g.daemon_gid)
 459 FN_GLOBAL_STRING(lp_daemon_uid, &Vars.g.daemon_uid)
 460 FN_GLOBAL_STRING(lp_motd_file, &Vars.g.motd_file)
 461 FN_GLOBAL_STRING(lp_pid_file, &Vars.g.pid_file)
 462 FN_GLOBAL_STRING(lp_socket_options, &Vars.g.socket_options)
 463
 464 FN_GLOBAL_INTEGER(lp_listen_backlog, &Vars.g.listen_backlog)
 465 FN_GLOBAL_INTEGER(lp_rsync_port, &Vars.g.rsync_port)
 466
 467 FN_LOCAL_STRING(lp_auth_users, auth_users)
 468 FN_LOCAL_STRING(lp_charset, charset)
 469 FN_LOCAL_STRING(lp_comment, comment)
 470 FN_LOCAL_STRING(lp_dont_compress, dont_compress)
 471 FN_LOCAL_STRING(lp_exclude, exclude)
 472 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
 473 FN_LOCAL_STRING(lp_filter, filter)
 474 FN_LOCAL_STRING(lp_gid, gid)
 475 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
 476 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
 477 FN_LOCAL_STRING(lp_include, include)
 478 FN_LOCAL_STRING(lp_include_from, include_from)
 479 FN_LOCAL_STRING(lp_incoming_chmod, incoming_chmod)
 480 FN_LOCAL_STRING(lp_lock_file, lock_file)
 481 FN_LOCAL_STRING(lp_log_file, log_file)
 482 FN_LOCAL_STRING(lp_log_format, log_format)
 483 FN_LOCAL_STRING(lp_name, name)
 484 FN_LOCAL_STRING(lp_outgoing_chmod, outgoing_chmod)
 485 FN_LOCAL_STRING(lp_path, path)
 486 FN_LOCAL_STRING(lp_postxfer_exec, postxfer_exec)
 487 FN_LOCAL_STRING(lp_prexfer_exec, prexfer_exec)
 488 FN_LOCAL_STRING(lp_refuse_options, refuse_options)
 489 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
 490 FN_LOCAL_STRING(lp_syslog_tag, syslog_tag)
 491 FN_LOCAL_STRING(lp_temp_dir, temp_dir)
 492 FN_LOCAL_STRING(lp_uid, uid)
 493
 494 FN_LOCAL_INTEGER(lp_max_connections, max_connections)
 495 FN_LOCAL_INTEGER(lp_max_verbosity, max_verbosity)
 496 FN_LOCAL_INTEGER(lp_syslog_facility, syslog_facility)
 497 FN_LOCAL_INTEGER(lp_timeout, timeout)
 498
 499 FN_LOCAL_BOOL(lp_fake_super, fake_super)
 500 FN_LOCAL_BOOL(lp_forward_lookup, forward_lookup)
 501 FN_LOCAL_BOOL(lp_ignore_errors, ignore_errors)
 502 FN_LOCAL_BOOL(lp_ignore_nonreadable, ignore_nonreadable)
 503 FN_LOCAL_BOOL(lp_list, list)
 504 FN_LOCAL_BOOL(lp_munge_symlinks, munge_symlinks)
 505 FN_LOCAL_BOOL(lp_numeric_ids, numeric_ids)
 506 FN_LOCAL_BOOL(lp_read_only, read_only)
 507 FN_LOCAL_BOOL(lp_reverse_lookup, reverse_lookup)
 508 FN_LOCAL_BOOL(lp_strict_modes, strict_modes)
 509 FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
 510 FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
 511 FN_LOCAL_BOOL(lp_write_only, write_only)
 512
 513 /* Assign a copy of v to *s.  Handles NULL strings.  We don't worry
 514  * about overwriting a malloc'd string because the long-running
 515  * (port-listening) daemon only loads the config file once, and the
 516  * per-job (forked or xinitd-ran) daemon only re-reads the file at
 517  * the start, so any lost memory is inconsequential. */
 518 static inline void string_set(char **s, const char *v)
 519 {
 520         if (!v)
 521                 *s = NULL;
 522         else if (!(*s = strdup(v)))
 523                 out_of_memory("string_set");
 524 }
 525
 526 /* Copy local_vars into a new section. No need to strdup since we don't free. */
 527 static void copy_section(local_vars *psectionDest, local_vars *psectionSource)
 528 {
 529         memcpy(psectionDest, psectionSource, sizeof psectionDest[0]);
 530 }
 531
 532 /* Initialise a section to the defaults. */
 533 static void init_section(local_vars *psection)
 534 {
 535         memset(psection, 0, sizeof (local_vars));
 536         copy_section(psection, &Vars.l);
 537 }
 538
 539 /* Do a case-insensitive, whitespace-ignoring string compare. */
 540 static int strwicmp(char *psz1, char *psz2)
 541 {
 542         /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
 543         /* appropriate value. */
 544         if (psz1 == psz2)
 545                 return 0;
 546
 547         if (psz1 == NULL)
 548                 return -1;
 549
 550         if (psz2 == NULL)
 551                 return 1;
 552
 553         /* sync the strings on first non-whitespace */
 554         while (1) {
 555                 while (isSpace(psz1))
 556                         psz1++;
 557                 while (isSpace(psz2))
 558                         psz2++;
 559                 if (toUpper(psz1) != toUpper(psz2) || *psz1 == '\0' || *psz2 == '\0')
 560                         break;
 561                 psz1++;
 562                 psz2++;
 563         }
 564         return *psz1 - *psz2;
 565 }
 566
 567 /* Find a section by name. Otherwise works like get_section. */
 568 static int getsectionbyname(char *name)
 569 {
 570         int i;
 571
 572         for (i = section_list.count - 1; i >= 0; i--) {
 573                 if (strwicmp(iSECTION(i).name, name) == 0)
 574                         break;
 575         }
 576
 577         return i;
 578 }
 579
 580 /* Add a new section to the sections array w/the default values. */
 581 static int add_a_section(char *name)
 582 {
 583         int i;
 584         local_vars *s;
 585
 586         /* it might already exist */
 587         if (name) {
 588                 i = getsectionbyname(name);
 589                 if (i >= 0)
 590                         return i;
 591         }
 592
 593         i = section_list.count;
 594         s = EXPAND_ITEM_LIST(&section_list, local_vars, 2);
 595
 596         init_section(s);
 597         if (name)
 598                 string_set(&s->name, name);
 599
 600         return i;
 601 }
 602
 603 /* Map a parameter's string representation to something we can use.
 604  * Returns False if the parameter string is not recognised, else TRUE. */
 605 static int map_parameter(char *parmname)
 606 {
 607         int iIndex;
 608
 609         if (*parmname == '-')
 610                 return -1;
 611
 612         for (iIndex = 0; parm_table[iIndex].label; iIndex++) {
 613                 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
 614                         return iIndex;
 615         }
 616
 617         rprintf(FLOG, "Unknown Parameter encountered: \"%s\"\n", parmname);
 618         return -1;
 619 }
 620
 621 /* Set a boolean variable from the text value stored in the passed string.
 622  * Returns True in success, False if the passed string does not correctly
 623  * represent a boolean. */
 624 static BOOL set_boolean(BOOL *pb, char *parmvalue)
 625 {
 626         if (strwicmp(parmvalue, "yes") == 0
 627          || strwicmp(parmvalue, "true") == 0
 628          || strwicmp(parmvalue, "1") == 0)
 629                 *pb = True;
 630         else if (strwicmp(parmvalue, "no") == 0
 631               || strwicmp(parmvalue, "False") == 0
 632               || strwicmp(parmvalue, "0") == 0)
 633                 *pb = False;
 634         else {
 635                 rprintf(FLOG, "Badly formed boolean in configuration file: \"%s\".\n", parmvalue);
 636                 return False;
 637         }
 638         return True;
 639 }
 640
 641 /* Process a parameter. */
 642 static BOOL do_parameter(char *parmname, char *parmvalue)
 643 {
 644         int parmnum, i;
 645         void *parm_ptr; /* where we are going to store the result */
 646         void *def_ptr;
 647         char *cp;
 648
 649         parmnum = map_parameter(parmname);
 650
 651         if (parmnum < 0) {
 652                 rprintf(FLOG, "IGNORING unknown parameter \"%s\"\n", parmname);
 653                 return True;
 654         }
 655
 656         def_ptr = parm_table[parmnum].ptr;
 657
 658         if (bInGlobalSection)
 659                 parm_ptr = def_ptr;
 660         else {
 661                 if (parm_table[parmnum].class == P_GLOBAL) {
 662                         rprintf(FLOG, "Global parameter %s found in module section!\n", parmname);
 663                         return True;
 664                 }
 665                 parm_ptr = SECTION_PTR(&iSECTION(iSectionIndex), def_ptr);
 666         }
 667
 668         /* now switch on the type of variable it is */
 669         switch (parm_table[parmnum].type) {
 670         case P_PATH:
 671         case P_STRING:
 672                 /* delay expansion of %VAR% strings */
 673                 break;
 674         default:
 675                 /* expand any %VAR% strings now */
 676                 parmvalue = expand_vars(parmvalue);
 677                 break;
 678         }
 679
 680         switch (parm_table[parmnum].type) {
 681         case P_BOOL:
 682                 set_boolean(parm_ptr, parmvalue);
 683                 break;
 684
 685         case P_BOOLREV:
 686                 set_boolean(parm_ptr, parmvalue);
 687                 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
 688                 break;
 689
 690         case P_INTEGER:
 691                 *(int *)parm_ptr = atoi(parmvalue);
 692                 break;
 693
 694         case P_CHAR:
 695                 *(char *)parm_ptr = *parmvalue;
 696                 break;
 697
 698         case P_OCTAL:
 699                 sscanf(parmvalue, "%o", (int *)parm_ptr);
 700                 break;
 701
 702         case P_PATH:
 703                 string_set(parm_ptr, parmvalue);
 704                 if ((cp = *(char**)parm_ptr) != NULL) {
 705                         int len = strlen(cp);
 706                         while (len > 1 && cp[len-1] == '/') len--;
 707                         cp[len] = '\0';
 708                 }
 709                 break;
 710
 711         case P_STRING:
 712                 string_set(parm_ptr, parmvalue);
 713                 break;
 714
 715         case P_ENUM:
 716                 for (i=0; parm_table[parmnum].enum_list[i].name; i++) {
 717                         if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
 718                                 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
 719                                 break;
 720                         }
 721                 }
 722                 if (!parm_table[parmnum].enum_list[i].name) {
 723                         if (atoi(parmvalue) > 0)
 724                                 *(int *)parm_ptr = atoi(parmvalue);
 725                 }
 726                 break;
 727         }
 728
 729         return True;
 730 }
 731
 732 /* Process a new section (rsync module).
 733  * Returns True on success, False on failure. */
 734 static BOOL do_section(char *sectionname)
 735 {
 736         BOOL isglobal;
 737
 738         if (*sectionname == ']') { /* A special push/pop/reset directive from params.c */
 739                 bInGlobalSection = 1;
 740                 if (strcmp(sectionname+1, "push") == 0) {
 741                         all_vars *vp = EXPAND_ITEM_LIST(&Vars_stack, all_vars, 2);
 742                         memcpy(vp, &Vars, sizeof Vars);
 743                 } else if (strcmp(sectionname+1, "pop") == 0
 744                  || strcmp(sectionname+1, "reset") == 0) {
 745                         all_vars *vp = ((all_vars*)Vars_stack.items) + Vars_stack.count - 1;
 746                         if (!Vars_stack.count)
 747                                 return False;
 748                         memcpy(&Vars, vp, sizeof Vars);
 749                         if (sectionname[1] == 'p')
 750                                 Vars_stack.count--;
 751                 } else
 752                         return False;
 753                 return True;
 754         }
 755
 756         isglobal = strwicmp(sectionname, GLOBAL_NAME) == 0;
 757
 758         /* At the end of the global section, add any --dparam items. */
 759         if (bInGlobalSection && !isglobal) {
 760                 if (!section_list.count)
 761                         set_dparams(0);
 762         }
 763
 764         /* if we've just struck a global section, note the fact. */
 765         bInGlobalSection = isglobal;
 766
 767         /* check for multiple global sections */
 768         if (bInGlobalSection)
 769                 return True;
 770
 771 #if 0
 772         /* If we have a current section, tidy it up before moving on. */
 773         if (iSectionIndex >= 0) {
 774                 /* Add any tidy work as needed ... */
 775                 if (problem)
 776                         return False;
 777         }
 778 #endif
 779
 780         if (strchr(sectionname, '/') != NULL) {
 781                 rprintf(FLOG, "Warning: invalid section name in configuration file: %s\n", sectionname);
 782                 return False;
 783         }
 784
 785         if ((iSectionIndex = add_a_section(sectionname)) < 0) {
 786                 rprintf(FLOG, "Failed to add a new module\n");
 787                 bInGlobalSection = True;
 788                 return False;
 789         }
 790
 791         return True;
 792 }
 793
 794 /* Load the modules from the config file. Return True on success,
 795  * False on failure. */
 796 int lp_load(char *pszFname, int globals_only)
 797 {
 798         bInGlobalSection = True;
 799
 800         reset_all_vars();
 801
 802         /* We get sections first, so have to start 'behind' to make up. */
 803         iSectionIndex = -1;
 804         return pm_process(pszFname, globals_only ? NULL : do_section, do_parameter);
 805 }
 806
 807 BOOL set_dparams(int syntax_check_only)
 808 {
 809         char *equal, *val, **params = dparam_list.items;
 810         unsigned j;
 811
 812         for (j = 0; j < dparam_list.count; j++) {
 813                 equal = strchr(params[j], '='); /* options.c verified this */
 814                 *equal = '\0';
 815                 if (syntax_check_only) {
 816                         if (map_parameter(params[j]) < 0) {
 817                                 rprintf(FERROR, "Unknown parameter \"%s\"\n", params[j]);
 818                                 *equal = '=';
 819                                 return False;
 820                         }
 821                 } else {
 822                         for (val = equal+1; isSpace(val); val++) {}
 823                         do_parameter(params[j], val);
 824                 }
 825                 *equal = '=';
 826         }
 827
 828         return True;
 829 }
 830
 831 /* Return the max number of modules (sections). */
 832 int lp_num_modules(void)
 833 {
 834         return section_list.count;
 835 }
 836
 837 /* Return the number of the module with the given name, or -1 if it doesn't
 838  * exist. Note that this is a DIFFERENT ANIMAL from the internal function
 839  * getsectionbyname()! This works ONLY if all sections have been loaded,
 840  * and does not copy the found section. */
 841 int lp_number(char *name)
 842 {
 843         int i;
 844
 845         for (i = section_list.count - 1; i >= 0; i--) {
 846                 if (strcmp(lp_name(i), name) == 0)
 847                         break;
 848         }
 849
 850         return i;
 851 }