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_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.
105 char *socket_options
;
108 static global Globals
;
113 * This structure describes a single service.
124 BOOL transfer_logging
;
138 char *refuse_options
;
142 BOOL ignore_nonreadable
;
146 /* This is a default service used to prime a services structure */
147 static service sDefault
=
152 DEFAULT_LOCK_FILE
, /* lock file */
153 True
, /* read only */
155 True
, /* use chroot */
156 False
, /* transfer logging */
157 False
, /* ignore errors */
160 /* TODO: This causes problems on Debian, where it is called
161 * "nogroup". Debian patch this in their version of the
162 * package, but it would be nice to be consistent. Possibly
163 * other systems are different again.
165 * What is the best behaviour? Perhaps always using (gid_t)
169 NULL
, /* hosts allow */
170 NULL
, /* hosts deny */
171 NULL
, /* auth users */
172 NULL
, /* secrets file */
173 True
, /* strict modes */
175 NULL
, /* exclude from */
177 NULL
, /* include from */
178 "%o %h [%a] %m (%u) %f %l", /* log format */
179 NULL
, /* refuse options */
180 "*.gz *.tgz *.zip *.z *.rpm *.deb *.iso *.bz2 *.tbz", /* dont compress */
182 0, /* max connections */
183 False
/* ignore nonreadable */
188 /* local variables */
189 static service
**ServicePtrs
= NULL
;
190 static int iNumServices
= 0;
191 static int iServiceIndex
= 0;
192 static BOOL bInGlobalSection
= True
;
194 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
196 static struct enum_list enum_facilities
[] = {
198 { LOG_AUTH
, "auth" },
201 { LOG_AUTHPRIV
, "authpriv" },
204 { LOG_CRON
, "cron" },
207 { LOG_DAEMON
, "daemon" },
213 { LOG_KERN
, "kern" },
219 { LOG_MAIL
, "mail" },
222 { LOG_NEWS
, "news" },
225 { LOG_AUTH
, "security" },
228 { LOG_SYSLOG
, "syslog" },
231 { LOG_USER
, "user" },
234 { LOG_UUCP
, "uucp" },
237 { LOG_LOCAL0
, "local0" },
240 { LOG_LOCAL1
, "local1" },
243 { LOG_LOCAL2
, "local2" },
246 { LOG_LOCAL3
, "local3" },
249 { LOG_LOCAL4
, "local4" },
252 { LOG_LOCAL5
, "local5" },
255 { LOG_LOCAL6
, "local6" },
258 { LOG_LOCAL7
, "local7" },
263 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
264 static struct parm_struct parm_table
[] =
266 {"motd file", P_STRING
, P_GLOBAL
, &Globals
.motd_file
, NULL
, 0},
267 {"syslog facility", P_ENUM
, P_GLOBAL
, &Globals
.syslog_facility
, enum_facilities
,0},
268 {"socket options", P_STRING
, P_GLOBAL
, &Globals
.socket_options
,NULL
, 0},
269 {"log file", P_STRING
, P_GLOBAL
, &Globals
.log_file
, NULL
, 0},
270 {"pid file", P_STRING
, P_GLOBAL
, &Globals
.pid_file
, NULL
, 0},
272 {"timeout", P_INTEGER
, P_LOCAL
, &sDefault
.timeout
, NULL
, 0},
273 {"max connections", P_INTEGER
, P_LOCAL
, &sDefault
.max_connections
,NULL
, 0},
274 {"name", P_STRING
, P_LOCAL
, &sDefault
.name
, NULL
, 0},
275 {"comment", P_STRING
, P_LOCAL
, &sDefault
.comment
, NULL
, 0},
276 {"lock file", P_STRING
, P_LOCAL
, &sDefault
.lock_file
, NULL
, 0},
277 {"path", P_STRING
, P_LOCAL
, &sDefault
.path
, NULL
, 0},
278 {"read only", P_BOOL
, P_LOCAL
, &sDefault
.read_only
, NULL
, 0},
279 {"list", P_BOOL
, P_LOCAL
, &sDefault
.list
, NULL
, 0},
280 {"use chroot", P_BOOL
, P_LOCAL
, &sDefault
.use_chroot
, NULL
, 0},
281 {"ignore nonreadable",P_BOOL
, P_LOCAL
, &sDefault
.ignore_nonreadable
, NULL
, 0},
282 {"uid", P_STRING
, P_LOCAL
, &sDefault
.uid
, NULL
, 0},
283 {"gid", P_STRING
, P_LOCAL
, &sDefault
.gid
, NULL
, 0},
284 {"hosts allow", P_STRING
, P_LOCAL
, &sDefault
.hosts_allow
, NULL
, 0},
285 {"hosts deny", P_STRING
, P_LOCAL
, &sDefault
.hosts_deny
, NULL
, 0},
286 {"auth users", P_STRING
, P_LOCAL
, &sDefault
.auth_users
, NULL
, 0},
287 {"secrets file", P_STRING
, P_LOCAL
, &sDefault
.secrets_file
,NULL
, 0},
288 {"strict modes", P_BOOL
, P_LOCAL
, &sDefault
.strict_modes
,NULL
, 0},
289 {"exclude", P_STRING
, P_LOCAL
, &sDefault
.exclude
, NULL
, 0},
290 {"exclude from", P_STRING
, P_LOCAL
, &sDefault
.exclude_from
,NULL
, 0},
291 {"include", P_STRING
, P_LOCAL
, &sDefault
.include
, NULL
, 0},
292 {"include from", P_STRING
, P_LOCAL
, &sDefault
.include_from
,NULL
, 0},
293 {"transfer logging", P_BOOL
, P_LOCAL
, &sDefault
.transfer_logging
,NULL
,0},
294 {"ignore errors", P_BOOL
, P_LOCAL
, &sDefault
.ignore_errors
,NULL
,0},
295 {"log format", P_STRING
, P_LOCAL
, &sDefault
.log_format
, NULL
, 0},
296 {"refuse options", P_STRING
, P_LOCAL
, &sDefault
.refuse_options
,NULL
, 0},
297 {"dont compress", P_STRING
, P_LOCAL
, &sDefault
.dont_compress
,NULL
, 0},
298 {NULL
, P_BOOL
, P_NONE
, NULL
, NULL
, 0}
302 /***************************************************************************
303 Initialise the global parameter structure.
304 ***************************************************************************/
305 static void init_globals(void)
307 memset(&Globals
, 0, sizeof(Globals
));
309 Globals
.syslog_facility
= LOG_DAEMON
;
313 /***************************************************************************
314 Initialise the sDefault parameter structure.
315 ***************************************************************************/
316 static void init_locals(void)
322 In this section all the functions that are used to access the
323 parameters from the rest of the program are defined
326 #define FN_GLOBAL_STRING(fn_name,ptr) \
327 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
328 #define FN_GLOBAL_BOOL(fn_name,ptr) \
329 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
330 #define FN_GLOBAL_CHAR(fn_name,ptr) \
331 char fn_name(void) {return(*(char *)(ptr));}
332 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
333 int fn_name(void) {return(*(int *)(ptr));}
335 #define FN_LOCAL_STRING(fn_name,val) \
336 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
337 #define FN_LOCAL_BOOL(fn_name,val) \
338 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
339 #define FN_LOCAL_CHAR(fn_name,val) \
340 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
341 #define FN_LOCAL_INTEGER(fn_name,val) \
342 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
345 FN_GLOBAL_STRING(lp_motd_file
, &Globals
.motd_file
)
346 FN_GLOBAL_STRING(lp_log_file
, &Globals
.log_file
)
347 FN_GLOBAL_STRING(lp_pid_file
, &Globals
.pid_file
)
348 FN_GLOBAL_STRING(lp_socket_options
, &Globals
.socket_options
)
349 FN_GLOBAL_INTEGER(lp_syslog_facility
, &Globals
.syslog_facility
)
351 FN_LOCAL_STRING(lp_name
, name
)
352 FN_LOCAL_STRING(lp_comment
, comment
)
353 FN_LOCAL_STRING(lp_path
, path
)
354 FN_LOCAL_STRING(lp_lock_file
, lock_file
)
355 FN_LOCAL_BOOL(lp_read_only
, read_only
)
356 FN_LOCAL_BOOL(lp_list
, list
)
357 FN_LOCAL_BOOL(lp_use_chroot
, use_chroot
)
358 FN_LOCAL_BOOL(lp_transfer_logging
, transfer_logging
)
359 FN_LOCAL_BOOL(lp_ignore_errors
, ignore_errors
)
360 FN_LOCAL_BOOL(lp_ignore_nonreadable
, ignore_nonreadable
)
361 FN_LOCAL_STRING(lp_uid
, uid
)
362 FN_LOCAL_STRING(lp_gid
, gid
)
363 FN_LOCAL_STRING(lp_hosts_allow
, hosts_allow
)
364 FN_LOCAL_STRING(lp_hosts_deny
, hosts_deny
)
365 FN_LOCAL_STRING(lp_auth_users
, auth_users
)
366 FN_LOCAL_STRING(lp_secrets_file
, secrets_file
)
367 FN_LOCAL_BOOL(lp_strict_modes
, strict_modes
)
368 FN_LOCAL_STRING(lp_exclude
, exclude
)
369 FN_LOCAL_STRING(lp_exclude_from
, exclude_from
)
370 FN_LOCAL_STRING(lp_include
, include
)
371 FN_LOCAL_STRING(lp_include_from
, include_from
)
372 FN_LOCAL_STRING(lp_log_format
, log_format
)
373 FN_LOCAL_STRING(lp_refuse_options
, refuse_options
)
374 FN_LOCAL_STRING(lp_dont_compress
, dont_compress
)
375 FN_LOCAL_INTEGER(lp_timeout
, timeout
)
376 FN_LOCAL_INTEGER(lp_max_connections
, max_connections
)
378 /* local prototypes */
379 static int strwicmp( char *psz1
, char *psz2
);
380 static int map_parameter( char *parmname
);
381 static BOOL
set_boolean( BOOL
*pb
, char *parmvalue
);
382 static int getservicebyname(char *name
, service
*pserviceDest
);
383 static void copy_service( service
*pserviceDest
,
384 service
*pserviceSource
);
385 static BOOL
do_parameter(char *parmname
, char *parmvalue
);
386 static BOOL
do_section(char *sectionname
);
389 /***************************************************************************
390 initialise a service to the defaults
391 ***************************************************************************/
392 static void init_service(service
*pservice
)
394 memset((char *)pservice
,0,sizeof(service
));
395 copy_service(pservice
,&sDefault
);
400 * Assign a copy of @p v to @p *s. Handles NULL strings. @p *v must
401 * be initialized when this is called, either to NULL or a malloc'd
404 * @fixme There is a small leak here in that sometimes the existing
405 * value will be dynamically allocated, and the old copy is lost.
406 * However, we can't always deallocate the old value, because in the
407 * case of sDefault, it points to a static string. It would be nice
408 * to have either all-strdup'd values, or to never need to free
411 static void string_set(char **s
, const char *v
)
419 exit_cleanup(RERR_MALLOC
);
423 /***************************************************************************
424 add a new service to the services array initialising it with the given
426 ***************************************************************************/
427 static int add_a_service(service
*pservice
, char *name
)
431 int num_to_alloc
= iNumServices
+1;
433 tservice
= *pservice
;
435 /* it might already exist */
438 i
= getservicebyname(name
,NULL
);
445 ServicePtrs
= (service
**)Realloc(ServicePtrs
,sizeof(service
*)*num_to_alloc
);
448 pSERVICE(iNumServices
) = (service
*)malloc(sizeof(service
));
450 if (!ServicePtrs
|| !pSERVICE(iNumServices
))
455 init_service(pSERVICE(i
));
456 copy_service(pSERVICE(i
),&tservice
);
458 string_set(&iSERVICE(i
).name
,name
);
463 /***************************************************************************
464 Do a case-insensitive, whitespace-ignoring string compare.
465 ***************************************************************************/
466 static int strwicmp(char *psz1
, char *psz2
)
468 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
469 /* appropriate value. */
479 /* sync the strings on first non-whitespace */
482 while (isspace(* (unsigned char *) psz1
))
484 while (isspace(* (unsigned char *) psz2
))
486 if (toupper(* (unsigned char *) psz1
) != toupper(* (unsigned char *) psz2
)
487 || *psz1
== '\0' || *psz2
== '\0')
492 return (*psz1
- *psz2
);
495 /***************************************************************************
496 Map a parameter's string representation to something we can use.
497 Returns False if the parameter string is not recognised, else TRUE.
498 ***************************************************************************/
499 static int map_parameter(char *parmname
)
503 if (*parmname
== '-')
506 for (iIndex
= 0; parm_table
[iIndex
].label
; iIndex
++)
507 if (strwicmp(parm_table
[iIndex
].label
, parmname
) == 0)
510 rprintf(FERROR
, "Unknown Parameter encountered: \"%s\"\n", parmname
);
515 /***************************************************************************
516 Set a boolean variable from the text value stored in the passed string.
517 Returns True in success, False if the passed string does not correctly
519 ***************************************************************************/
520 static BOOL
set_boolean(BOOL
*pb
, char *parmvalue
)
525 if (strwicmp(parmvalue
, "yes") == 0 ||
526 strwicmp(parmvalue
, "true") == 0 ||
527 strwicmp(parmvalue
, "1") == 0)
530 if (strwicmp(parmvalue
, "no") == 0 ||
531 strwicmp(parmvalue
, "False") == 0 ||
532 strwicmp(parmvalue
, "0") == 0)
536 rprintf(FERROR
, "Badly formed boolean in configuration file: \"%s\".\n",
543 /***************************************************************************
544 Find a service by name. Otherwise works like get_service.
545 ***************************************************************************/
546 static int getservicebyname(char *name
, service
*pserviceDest
)
550 for (iService
= iNumServices
- 1; iService
>= 0; iService
--)
551 if (strwicmp(iSERVICE(iService
).name
, name
) == 0)
553 if (pserviceDest
!= NULL
)
554 copy_service(pserviceDest
, pSERVICE(iService
));
563 /***************************************************************************
564 Copy a service structure to another
566 ***************************************************************************/
567 static void copy_service(service
*pserviceDest
,
568 service
*pserviceSource
)
572 for (i
=0;parm_table
[i
].label
;i
++)
573 if (parm_table
[i
].ptr
&& parm_table
[i
].class == P_LOCAL
) {
574 void *def_ptr
= parm_table
[i
].ptr
;
576 ((char *)pserviceSource
) + PTR_DIFF(def_ptr
,&sDefault
);
578 ((char *)pserviceDest
) + PTR_DIFF(def_ptr
,&sDefault
);
580 switch (parm_table
[i
].type
)
584 *(BOOL
*)dest_ptr
= *(BOOL
*)src_ptr
;
590 *(int *)dest_ptr
= *(int *)src_ptr
;
594 *(char *)dest_ptr
= *(char *)src_ptr
;
598 string_set(dest_ptr
,*(char **)src_ptr
);
608 /***************************************************************************
609 Process a parameter for a particular service number. If snum < 0
610 then assume we are in the globals
611 ***************************************************************************/
612 static BOOL
lp_do_parameter(int snum
, char *parmname
, char *parmvalue
)
615 void *parm_ptr
=NULL
; /* where we are going to store the result */
618 parmnum
= map_parameter(parmname
);
622 rprintf(FERROR
, "IGNORING unknown parameter \"%s\"\n", parmname
);
626 def_ptr
= parm_table
[parmnum
].ptr
;
628 /* we might point at a service, the default service or a global */
632 if (parm_table
[parmnum
].class == P_GLOBAL
) {
633 rprintf(FERROR
, "Global parameter %s found in service section!\n",parmname
);
636 parm_ptr
= ((char *)pSERVICE(snum
)) + PTR_DIFF(def_ptr
,&sDefault
);
639 /* now switch on the type of variable it is */
640 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
);
668 strlcpy((char *)parm_ptr
,parmvalue
,sizeof(pstring
));
672 for (i
=0;parm_table
[parmnum
].enum_list
[i
].name
;i
++) {
673 if (strequal(parmvalue
, parm_table
[parmnum
].enum_list
[i
].name
)) {
674 *(int *)parm_ptr
= parm_table
[parmnum
].enum_list
[i
].value
;
678 if (!parm_table
[parmnum
].enum_list
[i
].name
) {
679 if (atoi(parmvalue
) > 0)
680 *(int *)parm_ptr
= atoi(parmvalue
);
690 /***************************************************************************
692 ***************************************************************************/
693 static BOOL
do_parameter(char *parmname
, char *parmvalue
)
695 return lp_do_parameter(bInGlobalSection
?-2:iServiceIndex
, parmname
, parmvalue
);
698 /***************************************************************************
699 Process a new section (service). At this stage all sections are services.
700 Later we'll have special sections that permit server parameters to be set.
701 Returns True on success, False on failure.
702 ***************************************************************************/
703 static BOOL
do_section(char *sectionname
)
706 BOOL isglobal
= (strwicmp(sectionname
, GLOBAL_NAME
) == 0);
709 /* if we were in a global section then do the local inits */
710 if (bInGlobalSection
&& !isglobal
)
713 /* if we've just struck a global section, note the fact. */
714 bInGlobalSection
= isglobal
;
716 /* check for multiple global sections */
717 if (bInGlobalSection
)
722 /* if we have a current service, tidy it up before moving on */
725 if (iServiceIndex
>= 0)
728 /* if all is still well, move to the next record in the services array */
731 /* We put this here to avoid an odd message order if messages are */
732 /* issued by the post-processing of a previous section. */
734 if ((iServiceIndex
=add_a_service(&sDefault
,sectionname
)) < 0)
736 rprintf(FERROR
,"Failed to add a new service\n");
745 /***************************************************************************
746 Load the services array from the services file. Return True on success,
748 ***************************************************************************/
749 BOOL
lp_load(char *pszFname
, int globals_only
)
751 extern int am_server
;
752 extern int am_daemon
;
759 bInGlobalSection
= True
;
764 pstrcpy(n2
,pszFname
);
765 else if (am_server
&& am_daemon
&& !am_root
)
766 pstrcpy(n2
,RSYNCD_USERCONF
);
768 pstrcpy(n2
,RSYNCD_SYSCONF
);
770 /* We get sections first, so have to start 'behind' to make up */
772 bRetval
= pm_process(n2
, globals_only
?NULL
:do_section
, do_parameter
);
778 /***************************************************************************
779 return the max number of services
780 ***************************************************************************/
781 int lp_numservices(void)
783 return(iNumServices
);
786 /***************************************************************************
787 Return the number of the service with the given name, or -1 if it doesn't
788 exist. Note that this is a DIFFERENT ANIMAL from the internal function
789 getservicebyname()! This works ONLY if all services have been loaded, and
790 does not copy the found service.
791 ***************************************************************************/
792 int lp_number(char *name
)
796 for (iService
= iNumServices
- 1; iService
>= 0; iService
--)
797 if (strequal(lp_name(iService
), name
))