Reorder the static functions to avoid the need for forward declarations.
[rsync/rsync.git] / 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-2008 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 service 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 service 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
35  *    (ie. service) 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 "ifuncs.h"
48 #define PTR_DIFF(p1, p2) ((ptrdiff_t)(((char *)(p1)) - (char *)(p2)))
49 #define strequal(a, b) (strcasecmp(a, b)==0)
50 #define BOOLSTR(b) ((b) ? "Yes" : "No")
51 typedef char pstring[1024];
52 #define pstrcpy(a, b) strlcpy((a), (b), sizeof (pstring))
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, P_OCTAL,
64         P_PATH, P_STRING, P_GSTRING, P_ENUM, P_SEP
65 } parm_type;
66
67 typedef enum {
68         P_LOCAL, P_GLOBAL, P_SEPARATOR, 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 pSERVICE(i) ServicePtrs[i]
91 #define iSERVICE(i) (*pSERVICE(i))
92 #define LP_SNUM_OK(iService) (((iService) >= 0) && ((iService) < iNumServices))
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 service.  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 strict_modes;
153         BOOL transfer_logging;
154         BOOL use_chroot;
155         BOOL write_only;
156 } service;
157
158 /* This is a default service used to prime a services structure.  In order
159  * to make these easy to keep sorted in the same way as the variables
160  * above, use the variable name in the leading comment, including a
161  * trailing ';' (to avoid a sorting problem with trailing digits). */
162 static service sDefault = {
163  /* auth_users; */              NULL,
164  /* charset; */                 NULL,
165  /* comment; */                 NULL,
166  /* dont_compress; */           DEFAULT_DONT_COMPRESS,
167  /* exclude; */                 NULL,
168  /* exclude_from; */            NULL,
169  /* filter; */                  NULL,
170  /* gid; */                     NOBODY_GROUP,
171  /* hosts_allow; */             NULL,
172  /* hosts_deny; */              NULL,
173  /* include; */                 NULL,
174  /* include_from; */            NULL,
175  /* incoming_chmod; */          NULL,
176  /* lock_file; */               DEFAULT_LOCK_FILE,
177  /* log_file; */                NULL,
178  /* log_format; */              "%o %h [%a] %m (%u) %f %l",
179  /* name; */                    NULL,
180  /* outgoing_chmod; */          NULL,
181  /* path; */                    NULL,
182  /* postxfer_exec; */           NULL,
183  /* prexfer_exec; */            NULL,
184  /* refuse_options; */          NULL,
185  /* secrets_file; */            NULL,
186  /* temp_dir; */                NULL,
187  /* uid; */                     NOBODY_USER,
188
189  /* max_connections; */         0,
190  /* max_verbosity; */           1,
191  /* syslog_facility; */         LOG_DAEMON,
192  /* timeout; */                 0,
193
194  /* fake_super; */              False,
195  /* ignore_errors; */           False,
196  /* ignore_nonreadable; */      False,
197  /* list; */                    True,
198  /* munge_symlinks; */          (BOOL)-1,
199  /* numeric_ids; */             (BOOL)-1,
200  /* read_only; */               True,
201  /* strict_modes; */            True,
202  /* transfer_logging; */        False,
203  /* use_chroot; */              True,
204  /* write_only; */              False,
205 };
206
207 /* local variables */
208 static service **ServicePtrs = NULL;
209 static int iNumServices = 0;
210 static int iServiceIndex = 0;
211 static BOOL bInGlobalSection = True;
212
213 #define NUMPARAMETERS (sizeof (parm_table) / sizeof (struct parm_struct))
214
215 static struct enum_list enum_facilities[] = {
216 #ifdef LOG_AUTH
217         { LOG_AUTH, "auth" },
218 #endif
219 #ifdef LOG_AUTHPRIV
220         { LOG_AUTHPRIV, "authpriv" },
221 #endif
222 #ifdef LOG_CRON
223         { LOG_CRON, "cron" },
224 #endif
225 #ifdef LOG_DAEMON
226         { LOG_DAEMON, "daemon" },
227 #endif
228 #ifdef LOG_FTP
229         { LOG_FTP, "ftp" },
230 #endif
231 #ifdef LOG_KERN
232         { LOG_KERN, "kern" },
233 #endif
234 #ifdef LOG_LPR
235         { LOG_LPR, "lpr" },
236 #endif
237 #ifdef LOG_MAIL
238         { LOG_MAIL, "mail" },
239 #endif
240 #ifdef LOG_NEWS
241         { LOG_NEWS, "news" },
242 #endif
243 #ifdef LOG_AUTH
244         { LOG_AUTH, "security" },
245 #endif
246 #ifdef LOG_SYSLOG
247         { LOG_SYSLOG, "syslog" },
248 #endif
249 #ifdef LOG_USER
250         { LOG_USER, "user" },
251 #endif
252 #ifdef LOG_UUCP
253         { LOG_UUCP, "uucp" },
254 #endif
255 #ifdef LOG_LOCAL0
256         { LOG_LOCAL0, "local0" },
257 #endif
258 #ifdef LOG_LOCAL1
259         { LOG_LOCAL1, "local1" },
260 #endif
261 #ifdef LOG_LOCAL2
262         { LOG_LOCAL2, "local2" },
263 #endif
264 #ifdef LOG_LOCAL3
265         { LOG_LOCAL3, "local3" },
266 #endif
267 #ifdef LOG_LOCAL4
268         { LOG_LOCAL4, "local4" },
269 #endif
270 #ifdef LOG_LOCAL5
271         { LOG_LOCAL5, "local5" },
272 #endif
273 #ifdef LOG_LOCAL6
274         { LOG_LOCAL6, "local6" },
275 #endif
276 #ifdef LOG_LOCAL7
277         { LOG_LOCAL7, "local7" },
278 #endif
279         { -1, NULL }
280 };
281
282
283 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
284 static struct parm_struct parm_table[] =
285 {
286  {"address",           P_STRING, P_GLOBAL,&Globals.bind_address,       NULL,0},
287  {"motd file",         P_STRING, P_GLOBAL,&Globals.motd_file,          NULL,0},
288  {"pid file",          P_STRING, P_GLOBAL,&Globals.pid_file,           NULL,0},
289  {"port",              P_INTEGER,P_GLOBAL,&Globals.rsync_port,         NULL,0},
290  {"socket options",    P_STRING, P_GLOBAL,&Globals.socket_options,     NULL,0},
291
292  {"auth users",        P_STRING, P_LOCAL, &sDefault.auth_users,        NULL,0},
293  {"charset",           P_STRING, P_LOCAL, &sDefault.charset,           NULL,0},
294  {"comment",           P_STRING, P_LOCAL, &sDefault.comment,           NULL,0},
295  {"dont compress",     P_STRING, P_LOCAL, &sDefault.dont_compress,     NULL,0},
296  {"exclude from",      P_STRING, P_LOCAL, &sDefault.exclude_from,      NULL,0},
297  {"exclude",           P_STRING, P_LOCAL, &sDefault.exclude,           NULL,0},
298  {"fake super",        P_BOOL,   P_LOCAL, &sDefault.fake_super,        NULL,0},
299  {"filter",            P_STRING, P_LOCAL, &sDefault.filter,            NULL,0},
300  {"gid",               P_STRING, P_LOCAL, &sDefault.gid,               NULL,0},
301  {"hosts allow",       P_STRING, P_LOCAL, &sDefault.hosts_allow,       NULL,0},
302  {"hosts deny",        P_STRING, P_LOCAL, &sDefault.hosts_deny,        NULL,0},
303  {"ignore errors",     P_BOOL,   P_LOCAL, &sDefault.ignore_errors,     NULL,0},
304  {"ignore nonreadable",P_BOOL,   P_LOCAL, &sDefault.ignore_nonreadable,NULL,0},
305  {"include from",      P_STRING, P_LOCAL, &sDefault.include_from,      NULL,0},
306  {"include",           P_STRING, P_LOCAL, &sDefault.include,           NULL,0},
307  {"incoming chmod",    P_STRING, P_LOCAL, &sDefault.incoming_chmod,    NULL,0},
308  {"list",              P_BOOL,   P_LOCAL, &sDefault.list,              NULL,0},
309  {"lock file",         P_STRING, P_LOCAL, &sDefault.lock_file,         NULL,0},
310  {"log file",          P_STRING, P_LOCAL, &sDefault.log_file,          NULL,0},
311  {"log format",        P_STRING, P_LOCAL, &sDefault.log_format,        NULL,0},
312  {"max connections",   P_INTEGER,P_LOCAL, &sDefault.max_connections,   NULL,0},
313  {"max verbosity",     P_INTEGER,P_LOCAL, &sDefault.max_verbosity,     NULL,0},
314  {"munge symlinks",    P_BOOL,   P_LOCAL, &sDefault.munge_symlinks,    NULL,0},
315  {"name",              P_STRING, P_LOCAL, &sDefault.name,              NULL,0},
316  {"numeric ids",       P_BOOL,   P_LOCAL, &sDefault.numeric_ids,       NULL,0},
317  {"outgoing chmod",    P_STRING, P_LOCAL, &sDefault.outgoing_chmod,    NULL,0},
318  {"path",              P_PATH,   P_LOCAL, &sDefault.path,              NULL,0},
319 #ifdef HAVE_PUTENV
320  {"post-xfer exec",    P_STRING, P_LOCAL, &sDefault.postxfer_exec,     NULL,0},
321  {"pre-xfer exec",     P_STRING, P_LOCAL, &sDefault.prexfer_exec,      NULL,0},
322 #endif
323  {"read only",         P_BOOL,   P_LOCAL, &sDefault.read_only,         NULL,0},
324  {"refuse options",    P_STRING, P_LOCAL, &sDefault.refuse_options,    NULL,0},
325  {"secrets file",      P_STRING, P_LOCAL, &sDefault.secrets_file,      NULL,0},
326  {"strict modes",      P_BOOL,   P_LOCAL, &sDefault.strict_modes,      NULL,0},
327  {"syslog facility",   P_ENUM,   P_LOCAL, &sDefault.syslog_facility,enum_facilities,0},
328  {"temp dir",          P_PATH,   P_LOCAL, &sDefault.temp_dir,          NULL,0},
329  {"timeout",           P_INTEGER,P_LOCAL, &sDefault.timeout,           NULL,0},
330  {"transfer logging",  P_BOOL,   P_LOCAL, &sDefault.transfer_logging,  NULL,0},
331  {"uid",               P_STRING, P_LOCAL, &sDefault.uid,               NULL,0},
332  {"use chroot",        P_BOOL,   P_LOCAL, &sDefault.use_chroot,        NULL,0},
333  {"write only",        P_BOOL,   P_LOCAL, &sDefault.write_only,        NULL,0},
334  {NULL,                P_BOOL,   P_NONE,  NULL,                        NULL,0}
335 };
336
337 /* Initialise the global parameter structure. */
338 static void init_globals(void)
339 {
340         memset(&Globals, 0, sizeof Globals);
341 }
342
343 /* Initialise the sDefault parameter structure. */
344 static void init_locals(void)
345 {
346         /* Nothing needed yet... */
347 }
348
349 /* In this section all the functions that are used to access the
350  * parameters from the rest of the program are defined. */
351
352 #define FN_GLOBAL_STRING(fn_name, ptr) \
353  char *fn_name(void) {return *(char **)(ptr) ? *(char **)(ptr) : "";}
354 #define FN_GLOBAL_BOOL(fn_name, ptr) \
355  BOOL fn_name(void) {return *(BOOL *)(ptr);}
356 #define FN_GLOBAL_CHAR(fn_name, ptr) \
357  char fn_name(void) {return *(char *)(ptr);}
358 #define FN_GLOBAL_INTEGER(fn_name, ptr) \
359  int fn_name(void) {return *(int *)(ptr);}
360
361 #define FN_LOCAL_STRING(fn_name, val) \
362  char *fn_name(int i) {return LP_SNUM_OK(i) && pSERVICE(i)->val? pSERVICE(i)->val : (sDefault.val? sDefault.val : "");}
363 #define FN_LOCAL_BOOL(fn_name, val) \
364  BOOL fn_name(int i) {return LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val;}
365 #define FN_LOCAL_CHAR(fn_name, val) \
366  char fn_name(int i) {return LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val;}
367 #define FN_LOCAL_INTEGER(fn_name, val) \
368  int fn_name(int i) {return LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val;}
369
370 FN_GLOBAL_STRING(lp_bind_address, &Globals.bind_address)
371 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
372 FN_GLOBAL_STRING(lp_pid_file, &Globals.pid_file)
373 FN_GLOBAL_STRING(lp_socket_options, &Globals.socket_options)
374
375 FN_GLOBAL_INTEGER(lp_rsync_port, &Globals.rsync_port)
376
377 FN_LOCAL_STRING(lp_auth_users, auth_users)
378 FN_LOCAL_STRING(lp_charset, charset)
379 FN_LOCAL_STRING(lp_comment, comment)
380 FN_LOCAL_STRING(lp_dont_compress, dont_compress)
381 FN_LOCAL_STRING(lp_exclude, exclude)
382 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
383 FN_LOCAL_STRING(lp_filter, filter)
384 FN_LOCAL_STRING(lp_gid, gid)
385 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
386 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
387 FN_LOCAL_STRING(lp_include, include)
388 FN_LOCAL_STRING(lp_include_from, include_from)
389 FN_LOCAL_STRING(lp_incoming_chmod, incoming_chmod)
390 FN_LOCAL_STRING(lp_lock_file, lock_file)
391 FN_LOCAL_STRING(lp_log_file, log_file)
392 FN_LOCAL_STRING(lp_log_format, log_format)
393 FN_LOCAL_STRING(lp_name, name)
394 FN_LOCAL_STRING(lp_outgoing_chmod, outgoing_chmod)
395 FN_LOCAL_STRING(lp_path, path)
396 FN_LOCAL_STRING(lp_postxfer_exec, postxfer_exec)
397 FN_LOCAL_STRING(lp_prexfer_exec, prexfer_exec)
398 FN_LOCAL_STRING(lp_refuse_options, refuse_options)
399 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
400 FN_LOCAL_STRING(lp_temp_dir, temp_dir)
401 FN_LOCAL_STRING(lp_uid, uid)
402
403 FN_LOCAL_INTEGER(lp_max_connections, max_connections)
404 FN_LOCAL_INTEGER(lp_max_verbosity, max_verbosity)
405 FN_LOCAL_INTEGER(lp_syslog_facility, syslog_facility)
406 FN_LOCAL_INTEGER(lp_timeout, timeout)
407
408 FN_LOCAL_BOOL(lp_fake_super, fake_super)
409 FN_LOCAL_BOOL(lp_ignore_errors, ignore_errors)
410 FN_LOCAL_BOOL(lp_ignore_nonreadable, ignore_nonreadable)
411 FN_LOCAL_BOOL(lp_list, list)
412 FN_LOCAL_BOOL(lp_munge_symlinks, munge_symlinks)
413 FN_LOCAL_BOOL(lp_numeric_ids, numeric_ids)
414 FN_LOCAL_BOOL(lp_read_only, read_only)
415 FN_LOCAL_BOOL(lp_strict_modes, strict_modes)
416 FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
417 FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
418 FN_LOCAL_BOOL(lp_write_only, write_only)
419
420 /* Assign a copy of v to *s.  Handles NULL strings.  *v must
421  * be initialized when this is called, either to NULL or a malloc'd
422  * string.
423  *
424  * FIXME There is a small leak here in that sometimes the existing
425  * value will be dynamically allocated, and the old copy is lost.
426  * However, we can't always deallocate the old value, because in the
427  * case of sDefault, it points to a static string.  It would be nice
428  * to have either all-strdup'd values, or to never need to free
429  * memory. */
430 static void string_set(char **s, const char *v)
431 {
432         if (!v) {
433                 *s = NULL;
434                 return;
435         }
436         if (!(*s = strdup(v)))
437                 exit_cleanup(RERR_MALLOC);
438 }
439
440 /* Copy a service structure to another. */
441 static void copy_service(service *pserviceDest, service *pserviceSource)
442 {
443         int i;
444
445         for (i = 0; parm_table[i].label; i++) {
446                 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
447                         void *def_ptr = parm_table[i].ptr;
448                         void *src_ptr = ((char *)pserviceSource) + PTR_DIFF(def_ptr, &sDefault);
449                         void *dest_ptr = ((char *)pserviceDest) + PTR_DIFF(def_ptr, &sDefault);
450
451                         switch (parm_table[i].type) {
452                         case P_BOOL:
453                         case P_BOOLREV:
454                                 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
455                                 break;
456
457                         case P_INTEGER:
458                         case P_ENUM:
459                         case P_OCTAL:
460                                 *(int *)dest_ptr = *(int *)src_ptr;
461                                 break;
462
463                         case P_CHAR:
464                                 *(char *)dest_ptr = *(char *)src_ptr;
465                                 break;
466
467                         case P_PATH:
468                         case P_STRING:
469                                 string_set(dest_ptr, *(char **)src_ptr);
470                                 break;
471
472                         default:
473                                 break;
474                         }
475                 }
476         }
477 }
478
479 /* Initialise a service to the defaults. */
480 static void init_service(service *pservice)
481 {
482         memset((char *)pservice, 0, sizeof (service));
483         copy_service(pservice, &sDefault);
484 }
485
486 /* Do a case-insensitive, whitespace-ignoring string compare. */
487 static int strwicmp(char *psz1, char *psz2)
488 {
489         /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
490         /* appropriate value. */
491         if (psz1 == psz2)
492                 return 0;
493
494         if (psz1 == NULL)
495                 return -1;
496
497         if (psz2 == NULL)
498                 return 1;
499
500         /* sync the strings on first non-whitespace */
501         while (1) {
502                 while (isSpace(psz1))
503                         psz1++;
504                 while (isSpace(psz2))
505                         psz2++;
506                 if (toUpper(psz1) != toUpper(psz2) || *psz1 == '\0' || *psz2 == '\0')
507                         break;
508                 psz1++;
509                 psz2++;
510         }
511         return *psz1 - *psz2;
512 }
513
514 /* Find a service by name. Otherwise works like get_service. */
515 static int getservicebyname(char *name, service *pserviceDest)
516 {
517         int i;
518
519         for (i = iNumServices - 1; i >= 0; i--) {
520                 if (strwicmp(iSERVICE(i).name, name) == 0) {
521                         if (pserviceDest != NULL)
522                                 copy_service(pserviceDest, pSERVICE(i));
523                         break;
524                 }
525         }
526
527         return i;
528 }
529
530 /* Add a new service to the services array, with defaults set. */
531 static int add_a_service(char *name)
532 {
533         int i;
534         int num_to_alloc = iNumServices+1;
535
536         /* it might already exist */
537         if (name) {
538                 i = getservicebyname(name, NULL);
539                 if (i >= 0)
540                         return i;
541         }
542
543         i = iNumServices;
544         ServicePtrs = realloc_array(ServicePtrs, service *, num_to_alloc);
545
546         if (ServicePtrs)
547                 pSERVICE(iNumServices) = new(service);
548
549         if (!ServicePtrs || !pSERVICE(iNumServices))
550                 return -1;
551
552         iNumServices++;
553
554         init_service(pSERVICE(i));
555         if (name)
556                 string_set(&iSERVICE(i).name, name);
557
558         return i;
559 }
560
561 /* Map a parameter's string representation to something we can use.
562  * Returns False if the parameter string is not recognised, else TRUE. */
563 static int map_parameter(char *parmname)
564 {
565         int iIndex;
566
567         if (*parmname == '-')
568                 return -1;
569
570         for (iIndex = 0; parm_table[iIndex].label; iIndex++) {
571                 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
572                         return iIndex;
573         }
574
575         rprintf(FLOG, "Unknown Parameter encountered: \"%s\"\n", parmname);
576         return -1;
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 static BOOL set_boolean(BOOL *pb, char *parmvalue)
583 {
584         if (strwicmp(parmvalue, "yes") == 0
585          || strwicmp(parmvalue, "true") == 0
586          || strwicmp(parmvalue, "1") == 0)
587                 *pb = True;
588         else if (strwicmp(parmvalue, "no") == 0
589               || strwicmp(parmvalue, "False") == 0
590               || strwicmp(parmvalue, "0") == 0)
591                 *pb = False;
592         else {
593                 rprintf(FLOG, "Badly formed boolean in configuration file: \"%s\".\n", parmvalue);
594                 return False;
595         }
596         return True;
597 }
598
599 /* Process a parameter. */
600 static BOOL do_parameter(char *parmname, char *parmvalue)
601 {
602         int parmnum, i;
603         void *parm_ptr=NULL; /* where we are going to store the result */
604         void *def_ptr=NULL;
605         char *cp;
606
607         parmnum = map_parameter(parmname);
608
609         if (parmnum < 0) {
610                 rprintf(FLOG, "IGNORING unknown parameter \"%s\"\n", parmname);
611                 return True;
612         }
613
614         def_ptr = parm_table[parmnum].ptr;
615
616         if (bInGlobalSection)
617                 parm_ptr = def_ptr;
618         else {
619                 if (parm_table[parmnum].class == P_GLOBAL) {
620                         rprintf(FLOG, "Global parameter %s found in service section!\n", parmname);
621                         return True;
622                 }
623                 parm_ptr = ((char *)pSERVICE(iServiceIndex)) + PTR_DIFF(def_ptr, &sDefault);
624         }
625
626         /* now switch on the type of variable it is */
627         switch (parm_table[parmnum].type) {
628         case P_BOOL:
629                 set_boolean(parm_ptr, parmvalue);
630                 break;
631
632         case P_BOOLREV:
633                 set_boolean(parm_ptr, parmvalue);
634                 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
635                 break;
636
637         case P_INTEGER:
638                 *(int *)parm_ptr = atoi(parmvalue);
639                 break;
640
641         case P_CHAR:
642                 *(char *)parm_ptr = *parmvalue;
643                 break;
644
645         case P_OCTAL:
646                 sscanf(parmvalue, "%o", (int *)parm_ptr);
647                 break;
648
649         case P_PATH:
650                 string_set(parm_ptr, parmvalue);
651                 if ((cp = *(char**)parm_ptr) != NULL) {
652                         int len = strlen(cp);
653                         while (len > 1 && cp[len-1] == '/') len--;
654                         cp[len] = '\0';
655                 }
656                 break;
657
658         case P_STRING:
659                 string_set(parm_ptr, parmvalue);
660                 break;
661
662         case P_GSTRING:
663                 strlcpy((char *)parm_ptr, parmvalue, sizeof (pstring));
664                 break;
665
666         case P_ENUM:
667                 for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
668                         if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
669                                 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
670                                 break;
671                         }
672                 }
673                 if (!parm_table[parmnum].enum_list[i].name) {
674                         if (atoi(parmvalue) > 0)
675                                 *(int *)parm_ptr = atoi(parmvalue);
676                 }
677                 break;
678         case P_SEP:
679                 break;
680         }
681
682         return True;
683 }
684
685 /* Process a new section (rsync module).
686  * Returns True on success, False on failure. */
687 static BOOL do_section(char *sectionname)
688 {
689         BOOL isglobal = strwicmp(sectionname, GLOBAL_NAME) == 0;
690
691         /* if we were in a global section then do the local inits */
692         if (bInGlobalSection && !isglobal)
693                 init_locals();
694
695         /* if we've just struck a global section, note the fact. */
696         bInGlobalSection = isglobal;
697
698         /* check for multiple global sections */
699         if (bInGlobalSection)
700                 return True;
701
702 #if 0
703         /* If we have a current service, tidy it up before moving on. */
704         if (iServiceIndex >= 0) {
705                 /* Add any tidy work as needed ... */
706                 if (problem)
707                         return False;
708         }
709 #endif
710
711         if (strchr(sectionname, '/') != NULL) {
712                 rprintf(FLOG, "Warning: invalid section name in configuration file: %s\n", sectionname);
713                 return False;
714         }
715
716         if ((iServiceIndex = add_a_service(sectionname)) < 0) {
717                 rprintf(FLOG, "Failed to add a new module\n");
718                 bInGlobalSection = True;
719                 return False;
720         }
721
722         return True;
723 }
724
725 /* Load the services array from the services file. Return True on success,
726  * False on failure. */
727 BOOL lp_load(char *pszFname, int globals_only)
728 {
729         pstring n2;
730
731         bInGlobalSection = True;
732
733         init_globals();
734
735         pstrcpy(n2, pszFname);
736
737         /* We get sections first, so have to start 'behind' to make up */
738         iServiceIndex = -1;
739         return pm_process(n2, globals_only ? NULL : do_section, do_parameter);
740 }
741
742 /* Return the max number of services. */
743 int lp_numservices(void)
744 {
745         return iNumServices;
746 }
747
748 /* Return the number of the service with the given name, or -1 if it doesn't
749  * exist. Note that this is a DIFFERENT ANIMAL from the internal function
750  * getservicebyname()! This works ONLY if all services have been loaded,
751  * and does not copy the found service. */
752 int lp_number(char *name)
753 {
754         int i;
755
756         for (i = iNumServices - 1; i >= 0; i--) {
757                 if (strcmp(lp_name(i), name) == 0)
758                         break;
759         }
760
761         return i;
762 }