1 /* This is based on loadparm.c from Samba, written by Andrew Tridgell
6 * Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 * This module provides suitable callback functions for the params
29 * module. It builds the internal table of service details which is
30 * then used by the rest of the server.
34 * 1) add it to the global or service structure definition
35 * 2) add it to the parm_table
36 * 3) add it to the list of available functions (eg: using FN_GLOBAL_STRING())
37 * 4) If it's a global then initialise it in init_globals. If a local
38 * (ie. service) parameter then initialise it in the sDefault structure
42 * The configuration file is processed sequentially for speed. It is NOT
43 * accessed randomly as happens in 'real' Windows. For this reason, there
44 * is a fair bit of sequence-dependent code here - ie., code which assumes
45 * that certain things happen before others. In particular, the code which
46 * happens at the boundary between sections is delicately poised, so be
51 /* TODO: Parameter to set debug level on server. */
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))
60 /* 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
69 P_LOCAL
,P_GLOBAL
,P_SEPARATOR
,P_NONE
83 struct enum_list
*enum_list
;
88 #define GLOBAL_NAME "global"
91 /* some helpful bits */
92 #define pSERVICE(i) ServicePtrs[i]
93 #define iSERVICE(i) (*pSERVICE(i))
94 #define LP_SNUM_OK(iService) (((iService) >= 0) && ((iService) < iNumServices))
97 * This structure describes global (ie., server-wide) parameters.
104 char *socket_options
;
111 static global Globals
;
115 * This structure describes a single service.
127 BOOL transfer_logging
;
142 char *refuse_options
;
146 BOOL ignore_nonreadable
;
150 /* This is a default service used to prime a services structure */
151 static service sDefault
=
156 DEFAULT_LOCK_FILE
, /* lock file */
157 True
, /* read only */
158 False
, /* write only */
160 True
, /* use chroot */
161 False
, /* transfer logging */
162 False
, /* ignore errors */
165 /* TODO: This causes problems on Debian, where it is called
166 * "nogroup". Debian patch this in their version of the
167 * package, but it would be nice to be consistent. Possibly
168 * other systems are different again.
170 * What is the best behaviour? Perhaps always using (gid_t)
174 NULL
, /* hosts allow */
175 NULL
, /* hosts deny */
176 NULL
, /* auth users */
177 NULL
, /* secrets file */
178 True
, /* strict modes */
181 NULL
, /* exclude from */
183 NULL
, /* include from */
184 "%o %h [%a] %m (%u) %f %l", /* log format */
185 NULL
, /* refuse options */
186 "*.gz *.tgz *.zip *.z *.rpm *.deb *.iso *.bz2 *.tbz", /* dont compress */
188 0, /* max connections */
189 False
/* ignore nonreadable */
194 /* local variables */
195 static service
**ServicePtrs
= NULL
;
196 static int iNumServices
= 0;
197 static int iServiceIndex
= 0;
198 static BOOL bInGlobalSection
= True
;
200 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
202 static struct enum_list enum_facilities
[] = {
204 { LOG_AUTH
, "auth" },
207 { LOG_AUTHPRIV
, "authpriv" },
210 { LOG_CRON
, "cron" },
213 { LOG_DAEMON
, "daemon" },
219 { LOG_KERN
, "kern" },
225 { LOG_MAIL
, "mail" },
228 { LOG_NEWS
, "news" },
231 { LOG_AUTH
, "security" },
234 { LOG_SYSLOG
, "syslog" },
237 { LOG_USER
, "user" },
240 { LOG_UUCP
, "uucp" },
243 { LOG_LOCAL0
, "local0" },
246 { LOG_LOCAL1
, "local1" },
249 { LOG_LOCAL2
, "local2" },
252 { LOG_LOCAL3
, "local3" },
255 { LOG_LOCAL4
, "local4" },
258 { LOG_LOCAL5
, "local5" },
261 { LOG_LOCAL6
, "local6" },
264 { LOG_LOCAL7
, "local7" },
269 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
270 static struct parm_struct parm_table
[] =
272 {"motd file", P_STRING
, P_GLOBAL
, &Globals
.motd_file
, NULL
, 0},
273 {"syslog facility", P_ENUM
, P_GLOBAL
, &Globals
.syslog_facility
, enum_facilities
,0},
274 {"socket options", P_STRING
, P_GLOBAL
, &Globals
.socket_options
,NULL
, 0},
275 {"log file", P_STRING
, P_GLOBAL
, &Globals
.log_file
, NULL
, 0},
276 {"pid file", P_STRING
, P_GLOBAL
, &Globals
.pid_file
, NULL
, 0},
277 {"max verbosity", P_INTEGER
, P_GLOBAL
, &Globals
.max_verbosity
, NULL
, 0},
278 {"port", P_INTEGER
, P_GLOBAL
, &Globals
.rsync_port
, NULL
, 0},
279 {"address", P_STRING
, P_GLOBAL
, &Globals
.bind_address
, NULL
, 0},
281 {"timeout", P_INTEGER
, P_LOCAL
, &sDefault
.timeout
, NULL
, 0},
282 {"max connections", P_INTEGER
, P_LOCAL
, &sDefault
.max_connections
,NULL
, 0},
283 {"name", P_STRING
, P_LOCAL
, &sDefault
.name
, NULL
, 0},
284 {"comment", P_STRING
, P_LOCAL
, &sDefault
.comment
, NULL
, 0},
285 {"lock file", P_STRING
, P_LOCAL
, &sDefault
.lock_file
, NULL
, 0},
286 {"path", P_PATH
, P_LOCAL
, &sDefault
.path
, NULL
, 0},
287 {"read only", P_BOOL
, P_LOCAL
, &sDefault
.read_only
, NULL
, 0},
288 {"write only", P_BOOL
, P_LOCAL
, &sDefault
.write_only
, NULL
, 0},
289 {"list", P_BOOL
, P_LOCAL
, &sDefault
.list
, NULL
, 0},
290 {"use chroot", P_BOOL
, P_LOCAL
, &sDefault
.use_chroot
, NULL
, 0},
291 {"ignore nonreadable",P_BOOL
, P_LOCAL
, &sDefault
.ignore_nonreadable
, NULL
, 0},
292 {"uid", P_STRING
, P_LOCAL
, &sDefault
.uid
, NULL
, 0},
293 {"gid", P_STRING
, P_LOCAL
, &sDefault
.gid
, NULL
, 0},
294 {"hosts allow", P_STRING
, P_LOCAL
, &sDefault
.hosts_allow
, NULL
, 0},
295 {"hosts deny", P_STRING
, P_LOCAL
, &sDefault
.hosts_deny
, NULL
, 0},
296 {"auth users", P_STRING
, P_LOCAL
, &sDefault
.auth_users
, NULL
, 0},
297 {"secrets file", P_STRING
, P_LOCAL
, &sDefault
.secrets_file
,NULL
, 0},
298 {"strict modes", P_BOOL
, P_LOCAL
, &sDefault
.strict_modes
,NULL
, 0},
299 {"filter", P_STRING
, P_LOCAL
, &sDefault
.filter
, NULL
, 0},
300 {"exclude", P_STRING
, P_LOCAL
, &sDefault
.exclude
, NULL
, 0},
301 {"exclude from", P_STRING
, P_LOCAL
, &sDefault
.exclude_from
,NULL
, 0},
302 {"include", P_STRING
, P_LOCAL
, &sDefault
.include
, NULL
, 0},
303 {"include from", P_STRING
, P_LOCAL
, &sDefault
.include_from
,NULL
, 0},
304 {"transfer logging", P_BOOL
, P_LOCAL
, &sDefault
.transfer_logging
,NULL
,0},
305 {"ignore errors", P_BOOL
, P_LOCAL
, &sDefault
.ignore_errors
,NULL
,0},
306 {"log format", P_STRING
, P_LOCAL
, &sDefault
.log_format
, NULL
, 0},
307 {"refuse options", P_STRING
, P_LOCAL
, &sDefault
.refuse_options
,NULL
, 0},
308 {"dont compress", P_STRING
, P_LOCAL
, &sDefault
.dont_compress
,NULL
, 0},
309 {NULL
, P_BOOL
, P_NONE
, NULL
, NULL
, 0}
313 /***************************************************************************
314 Initialise the global parameter structure.
315 ***************************************************************************/
316 static void init_globals(void)
318 memset(&Globals
, 0, sizeof Globals
);
320 Globals
.syslog_facility
= LOG_DAEMON
;
322 Globals
.max_verbosity
= 1;
325 /***************************************************************************
326 Initialise the sDefault parameter structure.
327 ***************************************************************************/
328 static void init_locals(void)
334 In this section all the functions that are used to access the
335 parameters from the rest of the program are defined
338 #define FN_GLOBAL_STRING(fn_name,ptr) \
339 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
340 #define FN_GLOBAL_BOOL(fn_name,ptr) \
341 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
342 #define FN_GLOBAL_CHAR(fn_name,ptr) \
343 char fn_name(void) {return(*(char *)(ptr));}
344 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
345 int fn_name(void) {return(*(int *)(ptr));}
347 #define FN_LOCAL_STRING(fn_name,val) \
348 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
349 #define FN_LOCAL_BOOL(fn_name,val) \
350 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
351 #define FN_LOCAL_CHAR(fn_name,val) \
352 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
353 #define FN_LOCAL_INTEGER(fn_name,val) \
354 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
357 FN_GLOBAL_STRING(lp_motd_file
, &Globals
.motd_file
)
358 FN_GLOBAL_STRING(lp_log_file
, &Globals
.log_file
)
359 FN_GLOBAL_STRING(lp_pid_file
, &Globals
.pid_file
)
360 FN_GLOBAL_STRING(lp_socket_options
, &Globals
.socket_options
)
361 FN_GLOBAL_INTEGER(lp_syslog_facility
, &Globals
.syslog_facility
)
362 FN_GLOBAL_INTEGER(lp_max_verbosity
, &Globals
.max_verbosity
)
363 FN_GLOBAL_INTEGER(lp_rsync_port
, &Globals
.rsync_port
)
364 FN_GLOBAL_STRING(lp_bind_address
, &Globals
.bind_address
)
366 FN_LOCAL_STRING(lp_name
, name
)
367 FN_LOCAL_STRING(lp_comment
, comment
)
368 FN_LOCAL_STRING(lp_path
, path
)
369 FN_LOCAL_STRING(lp_lock_file
, lock_file
)
370 FN_LOCAL_BOOL(lp_read_only
, read_only
)
371 FN_LOCAL_BOOL(lp_write_only
, write_only
)
372 FN_LOCAL_BOOL(lp_list
, list
)
373 FN_LOCAL_BOOL(lp_use_chroot
, use_chroot
)
374 FN_LOCAL_BOOL(lp_transfer_logging
, transfer_logging
)
375 FN_LOCAL_BOOL(lp_ignore_errors
, ignore_errors
)
376 FN_LOCAL_BOOL(lp_ignore_nonreadable
, ignore_nonreadable
)
377 FN_LOCAL_STRING(lp_uid
, uid
)
378 FN_LOCAL_STRING(lp_gid
, gid
)
379 FN_LOCAL_STRING(lp_hosts_allow
, hosts_allow
)
380 FN_LOCAL_STRING(lp_hosts_deny
, hosts_deny
)
381 FN_LOCAL_STRING(lp_auth_users
, auth_users
)
382 FN_LOCAL_STRING(lp_secrets_file
, secrets_file
)
383 FN_LOCAL_BOOL(lp_strict_modes
, strict_modes
)
384 FN_LOCAL_STRING(lp_filter
, filter
)
385 FN_LOCAL_STRING(lp_exclude
, exclude
)
386 FN_LOCAL_STRING(lp_exclude_from
, exclude_from
)
387 FN_LOCAL_STRING(lp_include
, include
)
388 FN_LOCAL_STRING(lp_include_from
, include_from
)
389 FN_LOCAL_STRING(lp_log_format
, log_format
)
390 FN_LOCAL_STRING(lp_refuse_options
, refuse_options
)
391 FN_LOCAL_STRING(lp_dont_compress
, dont_compress
)
392 FN_LOCAL_INTEGER(lp_timeout
, timeout
)
393 FN_LOCAL_INTEGER(lp_max_connections
, max_connections
)
395 /* local prototypes */
396 static int strwicmp(char *psz1
, char *psz2
);
397 static int map_parameter(char *parmname
);
398 static BOOL
set_boolean(BOOL
*pb
, char *parmvalue
);
399 static int getservicebyname(char *name
, service
*pserviceDest
);
400 static void copy_service(service
*pserviceDest
, service
*pserviceSource
);
401 static BOOL
do_parameter(char *parmname
, char *parmvalue
);
402 static BOOL
do_section(char *sectionname
);
405 /***************************************************************************
406 initialise a service to the defaults
407 ***************************************************************************/
408 static void init_service(service
*pservice
)
410 memset((char *)pservice
,0,sizeof(service
));
411 copy_service(pservice
,&sDefault
);
416 * Assign a copy of @p v to @p *s. Handles NULL strings. @p *v must
417 * be initialized when this is called, either to NULL or a malloc'd
420 * @fixme There is a small leak here in that sometimes the existing
421 * value will be dynamically allocated, and the old copy is lost.
422 * However, we can't always deallocate the old value, because in the
423 * case of sDefault, it points to a static string. It would be nice
424 * to have either all-strdup'd values, or to never need to free
427 static void string_set(char **s
, const char *v
)
435 exit_cleanup(RERR_MALLOC
);
439 /***************************************************************************
440 add a new service to the services array initialising it with the given
442 ***************************************************************************/
443 static int add_a_service(service
*pservice
, char *name
)
447 int num_to_alloc
= iNumServices
+1;
449 tservice
= *pservice
;
451 /* it might already exist */
454 i
= getservicebyname(name
,NULL
);
461 ServicePtrs
= realloc_array(ServicePtrs
, service
*, num_to_alloc
);
464 pSERVICE(iNumServices
) = new(service
);
466 if (!ServicePtrs
|| !pSERVICE(iNumServices
))
471 init_service(pSERVICE(i
));
472 copy_service(pSERVICE(i
),&tservice
);
474 string_set(&iSERVICE(i
).name
,name
);
479 /***************************************************************************
480 Do a case-insensitive, whitespace-ignoring string compare.
481 ***************************************************************************/
482 static int strwicmp(char *psz1
, char *psz2
)
484 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
485 /* appropriate value. */
495 /* sync the strings on first non-whitespace */
498 while (isspace(* (unsigned char *) psz1
))
500 while (isspace(* (unsigned char *) psz2
))
502 if (toupper(* (unsigned char *) psz1
) != toupper(* (unsigned char *) psz2
)
503 || *psz1
== '\0' || *psz2
== '\0')
508 return (*psz1
- *psz2
);
511 /***************************************************************************
512 Map a parameter's string representation to something we can use.
513 Returns False if the parameter string is not recognised, else TRUE.
514 ***************************************************************************/
515 static int map_parameter(char *parmname
)
519 if (*parmname
== '-')
522 for (iIndex
= 0; parm_table
[iIndex
].label
; iIndex
++)
523 if (strwicmp(parm_table
[iIndex
].label
, parmname
) == 0)
526 rprintf(FERROR
, "Unknown Parameter encountered: \"%s\"\n", parmname
);
531 /***************************************************************************
532 Set a boolean variable from the text value stored in the passed string.
533 Returns True in success, False if the passed string does not correctly
535 ***************************************************************************/
536 static BOOL
set_boolean(BOOL
*pb
, char *parmvalue
)
541 if (strwicmp(parmvalue
, "yes") == 0 ||
542 strwicmp(parmvalue
, "true") == 0 ||
543 strwicmp(parmvalue
, "1") == 0)
546 if (strwicmp(parmvalue
, "no") == 0 ||
547 strwicmp(parmvalue
, "False") == 0 ||
548 strwicmp(parmvalue
, "0") == 0)
552 rprintf(FERROR
, "Badly formed boolean in configuration file: \"%s\".\n",
559 /***************************************************************************
560 Find a service by name. Otherwise works like get_service.
561 ***************************************************************************/
562 static int getservicebyname(char *name
, service
*pserviceDest
)
566 for (iService
= iNumServices
- 1; iService
>= 0; iService
--)
567 if (strwicmp(iSERVICE(iService
).name
, name
) == 0)
569 if (pserviceDest
!= NULL
)
570 copy_service(pserviceDest
, pSERVICE(iService
));
579 /***************************************************************************
580 Copy a service structure to another
582 ***************************************************************************/
583 static void copy_service(service
*pserviceDest
,
584 service
*pserviceSource
)
588 for (i
=0;parm_table
[i
].label
;i
++)
589 if (parm_table
[i
].ptr
&& parm_table
[i
].class == P_LOCAL
) {
590 void *def_ptr
= parm_table
[i
].ptr
;
592 ((char *)pserviceSource
) + PTR_DIFF(def_ptr
,&sDefault
);
594 ((char *)pserviceDest
) + PTR_DIFF(def_ptr
,&sDefault
);
596 switch (parm_table
[i
].type
)
600 *(BOOL
*)dest_ptr
= *(BOOL
*)src_ptr
;
606 *(int *)dest_ptr
= *(int *)src_ptr
;
610 *(char *)dest_ptr
= *(char *)src_ptr
;
615 string_set(dest_ptr
,*(char **)src_ptr
);
625 /***************************************************************************
626 Process a parameter for a particular service number. If snum < 0
627 then assume we are in the globals
628 ***************************************************************************/
629 static BOOL
lp_do_parameter(int snum
, char *parmname
, char *parmvalue
)
632 void *parm_ptr
=NULL
; /* where we are going to store the result */
636 parmnum
= map_parameter(parmname
);
640 rprintf(FERROR
, "IGNORING unknown parameter \"%s\"\n", parmname
);
644 def_ptr
= parm_table
[parmnum
].ptr
;
646 /* we might point at a service, the default service or a global */
650 if (parm_table
[parmnum
].class == P_GLOBAL
) {
651 rprintf(FERROR
, "Global parameter %s found in service section!\n",parmname
);
654 parm_ptr
= ((char *)pSERVICE(snum
)) + PTR_DIFF(def_ptr
,&sDefault
);
657 /* now switch on the type of variable it is */
658 switch (parm_table
[parmnum
].type
)
661 set_boolean(parm_ptr
,parmvalue
);
665 set_boolean(parm_ptr
,parmvalue
);
666 *(BOOL
*)parm_ptr
= ! *(BOOL
*)parm_ptr
;
670 *(int *)parm_ptr
= atoi(parmvalue
);
674 *(char *)parm_ptr
= *parmvalue
;
678 sscanf(parmvalue
,"%o",(int *)parm_ptr
);
682 string_set(parm_ptr
,parmvalue
);
683 if ((cp
= *(char**)parm_ptr
) != NULL
) {
684 int len
= strlen(cp
);
685 while (len
> 1 && cp
[len
-1] == '/') len
--;
691 string_set(parm_ptr
,parmvalue
);
695 strlcpy((char *)parm_ptr
,parmvalue
,sizeof(pstring
));
699 for (i
=0;parm_table
[parmnum
].enum_list
[i
].name
;i
++) {
700 if (strequal(parmvalue
, parm_table
[parmnum
].enum_list
[i
].name
)) {
701 *(int *)parm_ptr
= parm_table
[parmnum
].enum_list
[i
].value
;
705 if (!parm_table
[parmnum
].enum_list
[i
].name
) {
706 if (atoi(parmvalue
) > 0)
707 *(int *)parm_ptr
= atoi(parmvalue
);
717 /***************************************************************************
719 ***************************************************************************/
720 static BOOL
do_parameter(char *parmname
, char *parmvalue
)
722 return lp_do_parameter(bInGlobalSection
?-2:iServiceIndex
, parmname
, parmvalue
);
725 /***************************************************************************
726 Process a new section (service). At this stage all sections are services.
727 Later we'll have special sections that permit server parameters to be set.
728 Returns True on success, False on failure.
729 ***************************************************************************/
730 static BOOL
do_section(char *sectionname
)
733 BOOL isglobal
= (strwicmp(sectionname
, GLOBAL_NAME
) == 0);
736 /* if we were in a global section then do the local inits */
737 if (bInGlobalSection
&& !isglobal
)
740 /* if we've just struck a global section, note the fact. */
741 bInGlobalSection
= isglobal
;
743 /* check for multiple global sections */
744 if (bInGlobalSection
)
749 /* if we have a current service, tidy it up before moving on */
752 if (iServiceIndex
>= 0)
755 /* if all is still well, move to the next record in the services array */
758 /* We put this here to avoid an odd message order if messages are */
759 /* issued by the post-processing of a previous section. */
761 if ((iServiceIndex
=add_a_service(&sDefault
,sectionname
)) < 0)
763 rprintf(FERROR
,"Failed to add a new service\n");
772 /***************************************************************************
773 Load the services array from the services file. Return True on success,
775 ***************************************************************************/
776 BOOL
lp_load(char *pszFname
, int globals_only
)
778 extern int am_server
;
779 extern int am_daemon
;
786 bInGlobalSection
= True
;
791 pstrcpy(n2
,pszFname
);
792 else if (am_server
&& am_daemon
&& !am_root
)
793 pstrcpy(n2
,RSYNCD_USERCONF
);
795 pstrcpy(n2
,RSYNCD_SYSCONF
);
797 /* We get sections first, so have to start 'behind' to make up */
799 bRetval
= pm_process(n2
, globals_only
?NULL
:do_section
, do_parameter
);
805 /***************************************************************************
806 return the max number of services
807 ***************************************************************************/
808 int lp_numservices(void)
810 return(iNumServices
);
813 /***************************************************************************
814 Return the number of the service with the given name, or -1 if it doesn't
815 exist. Note that this is a DIFFERENT ANIMAL from the internal function
816 getservicebyname()! This works ONLY if all services have been loaded, and
817 does not copy the found service.
818 ***************************************************************************/
819 int lp_number(char *name
)
823 for (iService
= iNumServices
- 1; iService
>= 0; iService
--)
824 if (strcmp(lp_name(iService
), name
) == 0)