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