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.
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.
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.
16 /* This is based on loadparm.c from Samba, written by Andrew Tridgell
17 * and Karl Auer. Some of the changes are:
19 * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
20 * Copyright (C) 2003-2008 Wayne Davison <wayned@samba.org>
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.
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
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,
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))
58 #define DEFAULT_DONT_COMPRESS "*.gz *.zip *.z *.rpm *.deb *.iso *.bz2" \
59 " *.t[gb]z *.7z *.mp[34] *.mov *.avi *.ogg *.jpg *.jpeg"
61 /* the following are used by loadparm for option lists */
63 P_BOOL, P_BOOLREV, P_CHAR, P_INTEGER, P_OCTAL,
64 P_PATH, P_STRING, P_GSTRING, P_ENUM, P_SEP
68 P_LOCAL, P_GLOBAL, P_SEPARATOR, P_NONE
81 struct enum_list *enum_list;
86 #define GLOBAL_NAME "global"
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))
95 * This structure describes global (ie., server-wide) parameters.
101 char *socket_options;
106 static global Globals;
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.)
126 char *incoming_chmod;
131 char *outgoing_chmod;
135 char *refuse_options;
147 BOOL ignore_nonreadable;
153 BOOL transfer_logging;
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,
166 /* dont_compress; */ DEFAULT_DONT_COMPRESS,
168 /* exclude_from; */ NULL,
170 /* gid; */ NOBODY_GROUP,
171 /* hosts_allow; */ NULL,
172 /* hosts_deny; */ 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",
180 /* outgoing_chmod; */ 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,
189 /* max_connections; */ 0,
190 /* max_verbosity; */ 1,
191 /* syslog_facility; */ LOG_DAEMON,
194 /* fake_super; */ False,
195 /* ignore_errors; */ False,
196 /* ignore_nonreadable; */ False,
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,
207 /* local variables */
208 static service **ServicePtrs = NULL;
209 static int iNumServices = 0;
210 static int iServiceIndex = 0;
211 static BOOL bInGlobalSection = True;
213 #define NUMPARAMETERS (sizeof (parm_table) / sizeof (struct parm_struct))
215 static struct enum_list enum_facilities[] = {
217 { LOG_AUTH, "auth" },
220 { LOG_AUTHPRIV, "authpriv" },
223 { LOG_CRON, "cron" },
226 { LOG_DAEMON, "daemon" },
232 { LOG_KERN, "kern" },
238 { LOG_MAIL, "mail" },
241 { LOG_NEWS, "news" },
244 { LOG_AUTH, "security" },
247 { LOG_SYSLOG, "syslog" },
250 { LOG_USER, "user" },
253 { LOG_UUCP, "uucp" },
256 { LOG_LOCAL0, "local0" },
259 { LOG_LOCAL1, "local1" },
262 { LOG_LOCAL2, "local2" },
265 { LOG_LOCAL3, "local3" },
268 { LOG_LOCAL4, "local4" },
271 { LOG_LOCAL5, "local5" },
274 { LOG_LOCAL6, "local6" },
277 { LOG_LOCAL7, "local7" },
283 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
284 static struct parm_struct parm_table[] =
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},
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},
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},
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}
337 /* Initialise the global parameter structure. */
338 static void init_globals(void)
340 memset(&Globals, 0, sizeof Globals);
343 /* Initialise the sDefault parameter structure. */
344 static void init_locals(void)
346 /* Nothing needed yet... */
349 /* In this section all the functions that are used to access the
350 * parameters from the rest of the program are defined. */
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);}
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;}
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)
375 FN_GLOBAL_INTEGER(lp_rsync_port, &Globals.rsync_port)
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)
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)
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)
420 /* local prototypes */
421 static int strwicmp(char *psz1, char *psz2);
422 static int map_parameter(char *parmname);
423 static BOOL set_boolean(BOOL *pb, char *parmvalue);
424 static int getservicebyname(char *name, service *pserviceDest);
425 static void copy_service(service *pserviceDest, service *pserviceSource);
426 static BOOL do_parameter(char *parmname, char *parmvalue);
427 static BOOL do_section(char *sectionname);
429 /* Initialise a service to the defaults. */
430 static void init_service(service *pservice)
432 memset((char *)pservice, 0, sizeof (service));
433 copy_service(pservice, &sDefault);
436 /* Assign a copy of v to *s. Handles NULL strings. *v must
437 * be initialized when this is called, either to NULL or a malloc'd
440 * FIXME There is a small leak here in that sometimes the existing
441 * value will be dynamically allocated, and the old copy is lost.
442 * However, we can't always deallocate the old value, because in the
443 * case of sDefault, it points to a static string. It would be nice
444 * to have either all-strdup'd values, or to never need to free
446 static void string_set(char **s, const char *v)
452 if (!(*s = strdup(v)))
453 exit_cleanup(RERR_MALLOC);
456 /* Add a new service to the services array, with defaults set. */
457 static int add_a_service(service *pservice, char *name)
461 int num_to_alloc = iNumServices+1;
463 tservice = *pservice;
465 /* it might already exist */
467 i = getservicebyname(name, NULL);
473 ServicePtrs = realloc_array(ServicePtrs, service *, num_to_alloc);
476 pSERVICE(iNumServices) = new(service);
478 if (!ServicePtrs || !pSERVICE(iNumServices))
483 init_service(pSERVICE(i));
484 copy_service(pSERVICE(i), &tservice);
486 string_set(&iSERVICE(i).name, name);
491 /* Do a case-insensitive, whitespace-ignoring string compare. */
492 static int strwicmp(char *psz1, char *psz2)
494 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
495 /* appropriate value. */
505 /* sync the strings on first non-whitespace */
507 while (isSpace(psz1))
509 while (isSpace(psz2))
511 if (toUpper(psz1) != toUpper(psz2) || *psz1 == '\0' || *psz2 == '\0')
516 return *psz1 - *psz2;
519 /* Map a parameter's string representation to something we can use.
520 * Returns False if the parameter string is not recognised, else TRUE. */
521 static int map_parameter(char *parmname)
525 if (*parmname == '-')
528 for (iIndex = 0; parm_table[iIndex].label; iIndex++) {
529 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
533 rprintf(FLOG, "Unknown Parameter encountered: \"%s\"\n", parmname);
537 /* Set a boolean variable from the text value stored in the passed string.
538 * Returns True in success, False if the passed string does not correctly
539 * represent a boolean. */
540 static BOOL set_boolean(BOOL *pb, char *parmvalue)
542 if (strwicmp(parmvalue, "yes") == 0
543 || strwicmp(parmvalue, "true") == 0
544 || strwicmp(parmvalue, "1") == 0)
546 else if (strwicmp(parmvalue, "no") == 0
547 || strwicmp(parmvalue, "False") == 0
548 || strwicmp(parmvalue, "0") == 0)
551 rprintf(FLOG, "Badly formed boolean in configuration file: \"%s\".\n", parmvalue);
557 /* Find a service by name. Otherwise works like get_service. */
558 static int getservicebyname(char *name, service *pserviceDest)
562 for (i = iNumServices - 1; i >= 0; i--) {
563 if (strwicmp(iSERVICE(i).name, name) == 0) {
564 if (pserviceDest != NULL)
565 copy_service(pserviceDest, pSERVICE(i));
573 /* Copy a service structure to another. */
574 static void copy_service(service *pserviceDest, service *pserviceSource)
578 for (i = 0; parm_table[i].label; i++) {
579 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
580 void *def_ptr = parm_table[i].ptr;
581 void *src_ptr = ((char *)pserviceSource) + PTR_DIFF(def_ptr, &sDefault);
582 void *dest_ptr = ((char *)pserviceDest) + PTR_DIFF(def_ptr, &sDefault);
584 switch (parm_table[i].type) {
587 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
593 *(int *)dest_ptr = *(int *)src_ptr;
597 *(char *)dest_ptr = *(char *)src_ptr;
602 string_set(dest_ptr, *(char **)src_ptr);
612 /* Process a parameter. */
613 static BOOL lp_do_parameter(int snum, char *parmname, char *parmvalue)
616 void *parm_ptr=NULL; /* where we are going to store the result */
620 parmnum = map_parameter(parmname);
623 rprintf(FLOG, "IGNORING unknown parameter \"%s\"\n", parmname);
627 def_ptr = parm_table[parmnum].ptr;
629 /* we might point at a service, the default service or a global */
633 if (parm_table[parmnum].class == P_GLOBAL) {
634 rprintf(FLOG, "Global parameter %s found in service section!\n", parmname);
637 parm_ptr = ((char *)pSERVICE(snum)) + PTR_DIFF(def_ptr, &sDefault);
640 /* now switch on the type of variable it is */
641 switch (parm_table[parmnum].type) {
643 set_boolean(parm_ptr, parmvalue);
647 set_boolean(parm_ptr, parmvalue);
648 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
652 *(int *)parm_ptr = atoi(parmvalue);
656 *(char *)parm_ptr = *parmvalue;
660 sscanf(parmvalue, "%o", (int *)parm_ptr);
664 string_set(parm_ptr, parmvalue);
665 if ((cp = *(char**)parm_ptr) != NULL) {
666 int len = strlen(cp);
667 while (len > 1 && cp[len-1] == '/') len--;
673 string_set(parm_ptr, parmvalue);
677 strlcpy((char *)parm_ptr, parmvalue, sizeof (pstring));
681 for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
682 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
683 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
687 if (!parm_table[parmnum].enum_list[i].name) {
688 if (atoi(parmvalue) > 0)
689 *(int *)parm_ptr = atoi(parmvalue);
699 /* Process a parameter. */
700 static BOOL do_parameter(char *parmname, char *parmvalue)
702 return lp_do_parameter(bInGlobalSection?-2:iServiceIndex, parmname, parmvalue);
705 /* Process a new section (rsync module).
706 * Returns True on success, False on failure. */
707 static BOOL do_section(char *sectionname)
709 BOOL isglobal = strwicmp(sectionname, GLOBAL_NAME) == 0;
711 /* if we were in a global section then do the local inits */
712 if (bInGlobalSection && !isglobal)
715 /* if we've just struck a global section, note the fact. */
716 bInGlobalSection = isglobal;
718 /* check for multiple global sections */
719 if (bInGlobalSection)
723 /* If we have a current service, tidy it up before moving on. */
724 if (iServiceIndex >= 0) {
725 /* Add any tidy work as needed ... */
731 if (strchr(sectionname, '/') != NULL) {
732 rprintf(FLOG, "Warning: invalid section name in configuration file: %s\n", sectionname);
736 if ((iServiceIndex = add_a_service(&sDefault, sectionname)) < 0) {
737 rprintf(FLOG, "Failed to add a new module\n");
744 /* Load the services array from the services file. Return True on success,
745 * False on failure. */
746 BOOL lp_load(char *pszFname, int globals_only)
750 bInGlobalSection = True;
754 pstrcpy(n2, pszFname);
756 /* We get sections first, so have to start 'behind' to make up */
758 return pm_process(n2, globals_only ? NULL : do_section, do_parameter);
761 /* Return the max number of services. */
762 int lp_numservices(void)
767 /* Return the number of the service with the given name, or -1 if it doesn't
768 * exist. Note that this is a DIFFERENT ANIMAL from the internal function
769 * getservicebyname()! This works ONLY if all services have been loaded,
770 * and does not copy the found service. */
771 int lp_number(char *name)
775 for (i = iNumServices - 1; i >= 0; i--) {
776 if (strcmp(lp_name(i), name) == 0)