1 /* This is based on loadparm.c from Samba, written by Andrew Tridgell
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 2 of the License, or
8 (at your option) any later version.
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.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 * This module provides suitable callback functions for the params
24 * module. It builds the internal table of service details which is
25 * then used by the rest of the server.
29 * 1) add it to the global or service structure definition
30 * 2) add it to the parm_table
31 * 3) add it to the list of available functions (eg: using FN_GLOBAL_STRING())
32 * 4) If it's a global then initialise it in init_globals. If a local
33 * (ie. service) parameter then initialise it in the sDefault structure
37 * The configuration file is processed sequentially for speed. It is NOT
38 * accessed randomly as happens in 'real' Windows. For this reason, there
39 * is a fair bit of sequence-dependent code here - ie., code which assumes
40 * that certain things happen before others. In particular, the code which
41 * happens at the boundary between sections is delicately poised, so be
50 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((char *)(p1)) - (char *)(p2)))
51 #define strequal(a,b) (strcasecmp(a,b)==0)
52 #define BOOLSTR(b) ((b) ? "Yes" : "No")
53 typedef char pstring[1024];
54 #define pstrcpy(a,b) strlcpy(a,b,sizeof(pstring))
56 /* the following are used by loadparm for option lists */
59 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,
60 P_STRING,P_GSTRING,P_ENUM,P_SEP
65 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
79 struct enum_list *enum_list;
83 static BOOL bLoaded = False;
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.
105 char *socket_options;
108 static global Globals;
113 * This structure describes a single service.
123 BOOL transfer_logging;
137 /* This is a default service used to prime a services structure */
138 static service sDefault =
143 True, /* read only */
145 True, /* use chroot */
146 False, /* transfer logging */
149 NULL, /* hosts allow */
150 NULL, /* hosts deny */
151 NULL, /* auth users */
152 NULL, /* secrets file */
154 NULL, /* exclude from */
155 "%o %h [%a] %m (%u) %f %l", /* log format */
161 /* local variables */
162 static service **ServicePtrs = NULL;
163 static int iNumServices = 0;
164 static int iServiceIndex = 0;
165 static BOOL bInGlobalSection = True;
167 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
169 static struct enum_list enum_facilities[] = {
171 { LOG_AUTH, "auth" },
174 { LOG_AUTHPRIV, "authpriv" },
177 { LOG_CRON, "cron" },
180 { LOG_DAEMON, "daemon" },
186 { LOG_KERN, "kern" },
192 { LOG_MAIL, "mail" },
195 { LOG_NEWS, "news" },
198 { LOG_AUTH, "security" },
201 { LOG_SYSLOG, "syslog" },
204 { LOG_USER, "user" },
207 { LOG_UUCP, "uucp" },
210 { LOG_LOCAL0, "local0" },
213 { LOG_LOCAL1, "local1" },
216 { LOG_LOCAL2, "local2" },
219 { LOG_LOCAL3, "local3" },
222 { LOG_LOCAL4, "local4" },
225 { LOG_LOCAL5, "local5" },
228 { LOG_LOCAL6, "local6" },
231 { LOG_LOCAL7, "local7" },
236 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
237 static struct parm_struct parm_table[] =
239 {"max connections", P_INTEGER, P_GLOBAL, &Globals.max_connections,NULL, 0},
240 {"motd file", P_STRING, P_GLOBAL, &Globals.motd_file, NULL, 0},
241 {"lock file", P_STRING, P_GLOBAL, &Globals.lock_file, NULL, 0},
242 {"syslog facility", P_ENUM, P_GLOBAL, &Globals.syslog_facility, enum_facilities,0},
243 {"socket options", P_STRING, P_GLOBAL, &Globals.socket_options,NULL, 0},
244 {"log file", P_STRING, P_GLOBAL, &Globals.log_file, NULL, 0},
245 {"pid file", P_STRING, P_GLOBAL, &Globals.pid_file, NULL, 0},
247 {"timeout", P_INTEGER, P_LOCAL, &sDefault.timeout, NULL, 0},
248 {"name", P_STRING, P_LOCAL, &sDefault.name, NULL, 0},
249 {"comment", P_STRING, P_LOCAL, &sDefault.comment, NULL, 0},
250 {"path", P_STRING, P_LOCAL, &sDefault.path, NULL, 0},
251 {"read only", P_BOOL, P_LOCAL, &sDefault.read_only, NULL, 0},
252 {"list", P_BOOL, P_LOCAL, &sDefault.list, NULL, 0},
253 {"use chroot", P_BOOL, P_LOCAL, &sDefault.use_chroot, NULL, 0},
254 {"uid", P_STRING, P_LOCAL, &sDefault.uid, NULL, 0},
255 {"gid", P_STRING, P_LOCAL, &sDefault.gid, NULL, 0},
256 {"hosts allow", P_STRING, P_LOCAL, &sDefault.hosts_allow, NULL, 0},
257 {"hosts deny", P_STRING, P_LOCAL, &sDefault.hosts_deny, NULL, 0},
258 {"auth users", P_STRING, P_LOCAL, &sDefault.auth_users, NULL, 0},
259 {"secrets file", P_STRING, P_LOCAL, &sDefault.secrets_file,NULL, 0},
260 {"exclude", P_STRING, P_LOCAL, &sDefault.exclude, NULL, 0},
261 {"exclude from", P_STRING, P_LOCAL, &sDefault.exclude_from,NULL, 0},
262 {"transfer logging", P_BOOL, P_LOCAL, &sDefault.transfer_logging,NULL,0},
263 {"log format", P_STRING, P_LOCAL, &sDefault.log_format, NULL, 0},
264 {NULL, P_BOOL, P_NONE, NULL, NULL, 0}
268 /***************************************************************************
269 Initialise the global parameter structure.
270 ***************************************************************************/
271 static void init_globals(void)
273 memset(&Globals, 0, sizeof(Globals));
275 Globals.syslog_facility = LOG_DAEMON;
277 Globals.lock_file = "/var/run/rsyncd.lock";
280 /***************************************************************************
281 Initialise the sDefault parameter structure.
282 ***************************************************************************/
283 static void init_locals(void)
289 In this section all the functions that are used to access the
290 parameters from the rest of the program are defined
293 #define FN_GLOBAL_STRING(fn_name,ptr) \
294 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
295 #define FN_GLOBAL_BOOL(fn_name,ptr) \
296 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
297 #define FN_GLOBAL_CHAR(fn_name,ptr) \
298 char fn_name(void) {return(*(char *)(ptr));}
299 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
300 int fn_name(void) {return(*(int *)(ptr));}
302 #define FN_LOCAL_STRING(fn_name,val) \
303 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
304 #define FN_LOCAL_BOOL(fn_name,val) \
305 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
306 #define FN_LOCAL_CHAR(fn_name,val) \
307 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
308 #define FN_LOCAL_INTEGER(fn_name,val) \
309 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
312 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
313 FN_GLOBAL_STRING(lp_lock_file, &Globals.lock_file)
314 FN_GLOBAL_STRING(lp_log_file, &Globals.log_file)
315 FN_GLOBAL_STRING(lp_pid_file, &Globals.pid_file)
316 FN_GLOBAL_STRING(lp_socket_options, &Globals.socket_options)
317 FN_GLOBAL_INTEGER(lp_max_connections, &Globals.max_connections)
318 FN_GLOBAL_INTEGER(lp_syslog_facility, &Globals.syslog_facility)
320 FN_LOCAL_STRING(lp_name, name)
321 FN_LOCAL_STRING(lp_comment, comment)
322 FN_LOCAL_STRING(lp_path, path)
323 FN_LOCAL_BOOL(lp_read_only, read_only)
324 FN_LOCAL_BOOL(lp_list, list)
325 FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
326 FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
327 FN_LOCAL_STRING(lp_uid, uid)
328 FN_LOCAL_STRING(lp_gid, gid)
329 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
330 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
331 FN_LOCAL_STRING(lp_auth_users, auth_users)
332 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
333 FN_LOCAL_STRING(lp_exclude, exclude)
334 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
335 FN_LOCAL_STRING(lp_log_format, log_format)
336 FN_LOCAL_INTEGER(lp_timeout, timeout)
338 /* local prototypes */
339 static int strwicmp( char *psz1, char *psz2 );
340 static int map_parameter( char *parmname);
341 static BOOL set_boolean( BOOL *pb, char *parmvalue );
342 static int getservicebyname(char *name, service *pserviceDest);
343 static void copy_service( service *pserviceDest,
344 service *pserviceSource);
345 static BOOL do_parameter(char *parmname, char *parmvalue);
346 static BOOL do_section(char *sectionname);
349 /***************************************************************************
350 initialise a service to the defaults
351 ***************************************************************************/
352 static void init_service(service *pservice)
354 memset((char *)pservice,0,sizeof(service));
355 copy_service(pservice,&sDefault);
358 static void string_set(char **s, char *v)
365 if (!*s) exit_cleanup(RERR_MALLOC);
369 /***************************************************************************
370 add a new service to the services array initialising it with the given
372 ***************************************************************************/
373 static int add_a_service(service *pservice, char *name)
377 int num_to_alloc = iNumServices+1;
379 tservice = *pservice;
381 /* it might already exist */
384 i = getservicebyname(name,NULL);
391 ServicePtrs = (service **)Realloc(ServicePtrs,sizeof(service *)*num_to_alloc);
394 pSERVICE(iNumServices) = (service *)malloc(sizeof(service));
396 if (!ServicePtrs || !pSERVICE(iNumServices))
401 init_service(pSERVICE(i));
402 copy_service(pSERVICE(i),&tservice);
404 string_set(&iSERVICE(i).name,name);
409 /***************************************************************************
410 Do a case-insensitive, whitespace-ignoring string compare.
411 ***************************************************************************/
412 static int strwicmp(char *psz1, char *psz2)
414 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
415 /* appropriate value. */
425 /* sync the strings on first non-whitespace */
428 while (isspace(*psz1))
430 while (isspace(*psz2))
432 if (toupper(*psz1) != toupper(*psz2) || *psz1 == '\0' || *psz2 == '\0')
437 return (*psz1 - *psz2);
440 /***************************************************************************
441 Map a parameter's string representation to something we can use.
442 Returns False if the parameter string is not recognised, else TRUE.
443 ***************************************************************************/
444 static int map_parameter(char *parmname)
448 if (*parmname == '-')
451 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
452 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
455 rprintf(FERROR, "Unknown parameter encountered: \"%s\"\n", parmname);
460 /***************************************************************************
461 Set a boolean variable from the text value stored in the passed string.
462 Returns True in success, False if the passed string does not correctly
464 ***************************************************************************/
465 static BOOL set_boolean(BOOL *pb, char *parmvalue)
470 if (strwicmp(parmvalue, "yes") == 0 ||
471 strwicmp(parmvalue, "true") == 0 ||
472 strwicmp(parmvalue, "1") == 0)
475 if (strwicmp(parmvalue, "no") == 0 ||
476 strwicmp(parmvalue, "False") == 0 ||
477 strwicmp(parmvalue, "0") == 0)
481 rprintf(FERROR, "Badly formed boolean in configuration file: \"%s\".\n",
488 /***************************************************************************
489 Find a service by name. Otherwise works like get_service.
490 ***************************************************************************/
491 static int getservicebyname(char *name, service *pserviceDest)
495 for (iService = iNumServices - 1; iService >= 0; iService--)
496 if (strwicmp(iSERVICE(iService).name, name) == 0)
498 if (pserviceDest != NULL)
499 copy_service(pserviceDest, pSERVICE(iService));
508 /***************************************************************************
509 Copy a service structure to another
511 ***************************************************************************/
512 static void copy_service(service *pserviceDest,
513 service *pserviceSource)
517 for (i=0;parm_table[i].label;i++)
518 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
519 void *def_ptr = parm_table[i].ptr;
521 ((char *)pserviceSource) + PTR_DIFF(def_ptr,&sDefault);
523 ((char *)pserviceDest) + PTR_DIFF(def_ptr,&sDefault);
525 switch (parm_table[i].type)
529 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
535 *(int *)dest_ptr = *(int *)src_ptr;
539 *(char *)dest_ptr = *(char *)src_ptr;
543 string_set(dest_ptr,*(char **)src_ptr);
553 /***************************************************************************
554 Process a parameter for a particular service number. If snum < 0
555 then assume we are in the globals
556 ***************************************************************************/
557 static BOOL lp_do_parameter(int snum, char *parmname, char *parmvalue)
560 void *parm_ptr=NULL; /* where we are going to store the result */
563 parmnum = map_parameter(parmname);
567 rprintf(FERROR, "Ignoring unknown parameter \"%s\"\n", parmname);
571 def_ptr = parm_table[parmnum].ptr;
573 /* we might point at a service, the default service or a global */
577 if (parm_table[parmnum].class == P_GLOBAL) {
578 rprintf(FERROR, "Global parameter %s found in service section!\n",parmname);
581 parm_ptr = ((char *)pSERVICE(snum)) + PTR_DIFF(def_ptr,&sDefault);
584 /* now switch on the type of variable it is */
585 switch (parm_table[parmnum].type)
588 set_boolean(parm_ptr,parmvalue);
592 set_boolean(parm_ptr,parmvalue);
593 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
597 *(int *)parm_ptr = atoi(parmvalue);
601 *(char *)parm_ptr = *parmvalue;
605 sscanf(parmvalue,"%o",(int *)parm_ptr);
609 string_set(parm_ptr,parmvalue);
613 strlcpy((char *)parm_ptr,parmvalue,sizeof(pstring));
617 for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
618 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
619 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
623 if (!parm_table[parmnum].enum_list[i].name) {
624 if (atoi(parmvalue) > 0)
625 *(int *)parm_ptr = atoi(parmvalue);
635 /***************************************************************************
637 ***************************************************************************/
638 static BOOL do_parameter(char *parmname, char *parmvalue)
640 return lp_do_parameter(bInGlobalSection?-2:iServiceIndex, parmname, parmvalue);
643 /***************************************************************************
644 Process a new section (service). At this stage all sections are services.
645 Later we'll have special sections that permit server parameters to be set.
646 Returns True on success, False on failure.
647 ***************************************************************************/
648 static BOOL do_section(char *sectionname)
651 BOOL isglobal = (strwicmp(sectionname, GLOBAL_NAME) == 0);
654 /* if we were in a global section then do the local inits */
655 if (bInGlobalSection && !isglobal)
658 /* if we've just struck a global section, note the fact. */
659 bInGlobalSection = isglobal;
661 /* check for multiple global sections */
662 if (bInGlobalSection)
667 /* if we have a current service, tidy it up before moving on */
670 if (iServiceIndex >= 0)
673 /* if all is still well, move to the next record in the services array */
676 /* We put this here to avoid an odd message order if messages are */
677 /* issued by the post-processing of a previous section. */
679 if ((iServiceIndex=add_a_service(&sDefault,sectionname)) < 0)
681 rprintf(FERROR,"Failed to add a new service\n");
690 /***************************************************************************
691 Load the services array from the services file. Return True on success,
693 ***************************************************************************/
694 BOOL lp_load(char *pszFname, int globals_only)
701 bInGlobalSection = True;
705 pstrcpy(n2,pszFname);
707 /* We get sections first, so have to start 'behind' to make up */
709 bRetval = pm_process(n2, globals_only?NULL:do_section, do_parameter);
717 /***************************************************************************
718 return the max number of services
719 ***************************************************************************/
720 int lp_numservices(void)
722 return(iNumServices);
725 /***************************************************************************
726 Return the number of the service with the given name, or -1 if it doesn't
727 exist. Note that this is a DIFFERENT ANIMAL from the internal function
728 getservicebyname()! This works ONLY if all services have been loaded, and
729 does not copy the found service.
730 ***************************************************************************/
731 int lp_number(char *name)
735 for (iService = iNumServices - 1; iService >= 0; iService--)
736 if (strequal(lp_name(iService), name))