loadparm.c

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