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