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)-1)
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;
135 /* This is a default service used to prime a services structure */
136 static service sDefault =
141 True, /* read only */
143 True, /* use chroot */
144 False, /* transfer logging */
147 NULL, /* hosts allow */
148 NULL, /* hosts deny */
149 NULL, /* auth users */
150 NULL, /* secrets file */
152 NULL, /* exclude from */
157 /* local variables */
158 static service **ServicePtrs = NULL;
159 static int iNumServices = 0;
160 static int iServiceIndex = 0;
161 static BOOL bInGlobalSection = True;
163 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
165 static struct enum_list enum_facilities[] = {
167 { LOG_AUTH, "auth" },
170 { LOG_AUTHPRIV, "authpriv" },
173 { LOG_CRON, "cron" },
176 { LOG_DAEMON, "daemon" },
182 { LOG_KERN, "kern" },
188 { LOG_MAIL, "mail" },
191 { LOG_NEWS, "news" },
194 { LOG_AUTH, "security" },
197 { LOG_SYSLOG, "syslog" },
200 { LOG_USER, "user" },
203 { LOG_UUCP, "uucp" },
206 { LOG_LOCAL0, "local0" },
209 { LOG_LOCAL1, "local1" },
212 { LOG_LOCAL2, "local2" },
215 { LOG_LOCAL3, "local3" },
218 { LOG_LOCAL4, "local4" },
221 { LOG_LOCAL5, "local5" },
224 { LOG_LOCAL6, "local6" },
227 { LOG_LOCAL7, "local7" },
232 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
233 static struct parm_struct parm_table[] =
235 {"max connections", P_INTEGER, P_GLOBAL, &Globals.max_connections,NULL, 0},
236 {"motd file", P_STRING, P_GLOBAL, &Globals.motd_file, NULL, 0},
237 {"lock file", P_STRING, P_GLOBAL, &Globals.lock_file, NULL, 0},
238 {"syslog facility", P_ENUM, P_GLOBAL, &Globals.syslog_facility, enum_facilities,0},
239 {"socket options", P_STRING, P_GLOBAL, &Globals.socket_options,NULL, 0},
240 {"log file", P_STRING, P_GLOBAL, &Globals.log_file, NULL, 0},
241 {"pid file", P_STRING, P_GLOBAL, &Globals.pid_file, NULL, 0},
243 {"name", P_STRING, P_LOCAL, &sDefault.name, NULL, 0},
244 {"comment", P_STRING, P_LOCAL, &sDefault.comment, NULL, 0},
245 {"path", P_STRING, P_LOCAL, &sDefault.path, NULL, 0},
246 {"read only", P_BOOL, P_LOCAL, &sDefault.read_only, NULL, 0},
247 {"list", P_BOOL, P_LOCAL, &sDefault.list, NULL, 0},
248 {"use chroot", P_BOOL, P_LOCAL, &sDefault.use_chroot, NULL, 0},
249 {"uid", P_STRING, P_LOCAL, &sDefault.uid, NULL, 0},
250 {"gid", P_STRING, P_LOCAL, &sDefault.gid, NULL, 0},
251 {"hosts allow", P_STRING, P_LOCAL, &sDefault.hosts_allow, NULL, 0},
252 {"hosts deny", P_STRING, P_LOCAL, &sDefault.hosts_deny, NULL, 0},
253 {"auth users", P_STRING, P_LOCAL, &sDefault.auth_users, NULL, 0},
254 {"secrets file", P_STRING, P_LOCAL, &sDefault.secrets_file,NULL, 0},
255 {"exclude", P_STRING, P_LOCAL, &sDefault.exclude, NULL, 0},
256 {"exclude from", P_STRING, P_LOCAL, &sDefault.exclude_from,NULL, 0},
257 {"transfer logging", P_BOOL, P_LOCAL, &sDefault.transfer_logging,NULL,0},
258 {NULL, P_BOOL, P_NONE, NULL, NULL, 0}
262 /***************************************************************************
263 Initialise the global parameter structure.
264 ***************************************************************************/
265 static void init_globals(void)
267 memset(&Globals, 0, sizeof(Globals));
269 Globals.syslog_facility = LOG_DAEMON;
271 Globals.lock_file = "/var/run/rsyncd.lock";
274 /***************************************************************************
275 Initialise the sDefault parameter structure.
276 ***************************************************************************/
277 static void init_locals(void)
283 In this section all the functions that are used to access the
284 parameters from the rest of the program are defined
287 #define FN_GLOBAL_STRING(fn_name,ptr) \
288 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
289 #define FN_GLOBAL_BOOL(fn_name,ptr) \
290 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
291 #define FN_GLOBAL_CHAR(fn_name,ptr) \
292 char fn_name(void) {return(*(char *)(ptr));}
293 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
294 int fn_name(void) {return(*(int *)(ptr));}
296 #define FN_LOCAL_STRING(fn_name,val) \
297 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
298 #define FN_LOCAL_BOOL(fn_name,val) \
299 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
300 #define FN_LOCAL_CHAR(fn_name,val) \
301 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
302 #define FN_LOCAL_INTEGER(fn_name,val) \
303 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
306 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
307 FN_GLOBAL_STRING(lp_lock_file, &Globals.lock_file)
308 FN_GLOBAL_STRING(lp_log_file, &Globals.log_file)
309 FN_GLOBAL_STRING(lp_pid_file, &Globals.pid_file)
310 FN_GLOBAL_STRING(lp_socket_options, &Globals.socket_options)
311 FN_GLOBAL_INTEGER(lp_max_connections, &Globals.max_connections)
312 FN_GLOBAL_INTEGER(lp_syslog_facility, &Globals.syslog_facility)
314 FN_LOCAL_STRING(lp_name, name)
315 FN_LOCAL_STRING(lp_comment, comment)
316 FN_LOCAL_STRING(lp_path, path)
317 FN_LOCAL_BOOL(lp_read_only, read_only)
318 FN_LOCAL_BOOL(lp_list, list)
319 FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
320 FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
321 FN_LOCAL_STRING(lp_uid, uid)
322 FN_LOCAL_STRING(lp_gid, gid)
323 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
324 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
325 FN_LOCAL_STRING(lp_auth_users, auth_users)
326 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
327 FN_LOCAL_STRING(lp_exclude, exclude)
328 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
330 /* local prototypes */
331 static int strwicmp( char *psz1, char *psz2 );
332 static int map_parameter( char *parmname);
333 static BOOL set_boolean( BOOL *pb, char *parmvalue );
334 static int getservicebyname(char *name, service *pserviceDest);
335 static void copy_service( service *pserviceDest,
336 service *pserviceSource);
337 static BOOL do_parameter(char *parmname, char *parmvalue);
338 static BOOL do_section(char *sectionname);
341 /***************************************************************************
342 initialise a service to the defaults
343 ***************************************************************************/
344 static void init_service(service *pservice)
346 memset((char *)pservice,0,sizeof(service));
347 copy_service(pservice,&sDefault);
350 static void string_set(char **s, char *v)
357 if (!*s) exit_cleanup(1);
361 /***************************************************************************
362 add a new service to the services array initialising it with the given
364 ***************************************************************************/
365 static int add_a_service(service *pservice, char *name)
369 int num_to_alloc = iNumServices+1;
371 tservice = *pservice;
373 /* it might already exist */
376 i = getservicebyname(name,NULL);
383 ServicePtrs = (service **)Realloc(ServicePtrs,sizeof(service *)*num_to_alloc);
386 pSERVICE(iNumServices) = (service *)malloc(sizeof(service));
388 if (!ServicePtrs || !pSERVICE(iNumServices))
393 init_service(pSERVICE(i));
394 copy_service(pSERVICE(i),&tservice);
396 string_set(&iSERVICE(i).name,name);
401 /***************************************************************************
402 Do a case-insensitive, whitespace-ignoring string compare.
403 ***************************************************************************/
404 static int strwicmp(char *psz1, char *psz2)
406 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
407 /* appropriate value. */
417 /* sync the strings on first non-whitespace */
420 while (isspace(*psz1))
422 while (isspace(*psz2))
424 if (toupper(*psz1) != toupper(*psz2) || *psz1 == '\0' || *psz2 == '\0')
429 return (*psz1 - *psz2);
432 /***************************************************************************
433 Map a parameter's string representation to something we can use.
434 Returns False if the parameter string is not recognised, else TRUE.
435 ***************************************************************************/
436 static int map_parameter(char *parmname)
440 if (*parmname == '-')
443 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
444 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
447 rprintf(FERROR, "Unknown parameter encountered: \"%s\"\n", parmname);
452 /***************************************************************************
453 Set a boolean variable from the text value stored in the passed string.
454 Returns True in success, False if the passed string does not correctly
456 ***************************************************************************/
457 static BOOL set_boolean(BOOL *pb, char *parmvalue)
462 if (strwicmp(parmvalue, "yes") == 0 ||
463 strwicmp(parmvalue, "true") == 0 ||
464 strwicmp(parmvalue, "1") == 0)
467 if (strwicmp(parmvalue, "no") == 0 ||
468 strwicmp(parmvalue, "False") == 0 ||
469 strwicmp(parmvalue, "0") == 0)
473 rprintf(FERROR, "Badly formed boolean in configuration file: \"%s\".\n",
480 /***************************************************************************
481 Find a service by name. Otherwise works like get_service.
482 ***************************************************************************/
483 static int getservicebyname(char *name, service *pserviceDest)
487 for (iService = iNumServices - 1; iService >= 0; iService--)
488 if (strwicmp(iSERVICE(iService).name, name) == 0)
490 if (pserviceDest != NULL)
491 copy_service(pserviceDest, pSERVICE(iService));
500 /***************************************************************************
501 Copy a service structure to another
503 ***************************************************************************/
504 static void copy_service(service *pserviceDest,
505 service *pserviceSource)
509 for (i=0;parm_table[i].label;i++)
510 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
511 void *def_ptr = parm_table[i].ptr;
513 ((char *)pserviceSource) + PTR_DIFF(def_ptr,&sDefault);
515 ((char *)pserviceDest) + PTR_DIFF(def_ptr,&sDefault);
517 switch (parm_table[i].type)
521 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
527 *(int *)dest_ptr = *(int *)src_ptr;
531 *(char *)dest_ptr = *(char *)src_ptr;
535 string_set(dest_ptr,*(char **)src_ptr);
545 /***************************************************************************
546 Process a parameter for a particular service number. If snum < 0
547 then assume we are in the globals
548 ***************************************************************************/
549 static BOOL lp_do_parameter(int snum, char *parmname, char *parmvalue)
552 void *parm_ptr=NULL; /* where we are going to store the result */
555 parmnum = map_parameter(parmname);
559 rprintf(FERROR, "Ignoring unknown parameter \"%s\"\n", parmname);
563 def_ptr = parm_table[parmnum].ptr;
565 /* we might point at a service, the default service or a global */
569 if (parm_table[parmnum].class == P_GLOBAL) {
570 rprintf(FERROR, "Global parameter %s found in service section!\n",parmname);
573 parm_ptr = ((char *)pSERVICE(snum)) + PTR_DIFF(def_ptr,&sDefault);
576 /* now switch on the type of variable it is */
577 switch (parm_table[parmnum].type)
580 set_boolean(parm_ptr,parmvalue);
584 set_boolean(parm_ptr,parmvalue);
585 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
589 *(int *)parm_ptr = atoi(parmvalue);
593 *(char *)parm_ptr = *parmvalue;
597 sscanf(parmvalue,"%o",(int *)parm_ptr);
601 string_set(parm_ptr,parmvalue);
605 strlcpy((char *)parm_ptr,parmvalue,sizeof(pstring)-1);
609 for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
610 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
611 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
615 if (!parm_table[parmnum].enum_list[i].name) {
616 if (atoi(parmvalue) > 0)
617 *(int *)parm_ptr = atoi(parmvalue);
627 /***************************************************************************
629 ***************************************************************************/
630 static BOOL do_parameter(char *parmname, char *parmvalue)
632 return lp_do_parameter(bInGlobalSection?-2:iServiceIndex, parmname, parmvalue);
635 /***************************************************************************
636 Process a new section (service). At this stage all sections are services.
637 Later we'll have special sections that permit server parameters to be set.
638 Returns True on success, False on failure.
639 ***************************************************************************/
640 static BOOL do_section(char *sectionname)
643 BOOL isglobal = (strwicmp(sectionname, GLOBAL_NAME) == 0);
646 /* if we were in a global section then do the local inits */
647 if (bInGlobalSection && !isglobal)
650 /* if we've just struck a global section, note the fact. */
651 bInGlobalSection = isglobal;
653 /* check for multiple global sections */
654 if (bInGlobalSection)
659 /* if we have a current service, tidy it up before moving on */
662 if (iServiceIndex >= 0)
665 /* if all is still well, move to the next record in the services array */
668 /* We put this here to avoid an odd message order if messages are */
669 /* issued by the post-processing of a previous section. */
671 if ((iServiceIndex=add_a_service(&sDefault,sectionname)) < 0)
673 rprintf(FERROR,"Failed to add a new service\n");
682 /***************************************************************************
683 Load the services array from the services file. Return True on success,
685 ***************************************************************************/
686 BOOL lp_load(char *pszFname, int globals_only)
693 bInGlobalSection = True;
697 pstrcpy(n2,pszFname);
699 /* We get sections first, so have to start 'behind' to make up */
701 bRetval = pm_process(n2, globals_only?NULL:do_section, do_parameter);
709 /***************************************************************************
710 return the max number of services
711 ***************************************************************************/
712 int lp_numservices(void)
714 return(iNumServices);
717 /***************************************************************************
718 Return the number of the service with the given name, or -1 if it doesn't
719 exist. Note that this is a DIFFERENT ANIMAL from the internal function
720 getservicebyname()! This works ONLY if all services have been loaded, and
721 does not copy the found service.
722 ***************************************************************************/
723 int lp_number(char *name)
727 for (iService = iNumServices - 1; iService >= 0; iService--)
728 if (strequal(lp_name(iService), name))