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 Realloc realloc
51 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((char *)(p1)) - (char *)(p2)))
52 #define strequal(a,b) (strcasecmp(a,b)==0)
53 #define BOOLSTR(b) ((b) ? "Yes" : "No")
54 typedef char pstring[1024];
55 #define pstrcpy(a,b) strlcpy(a,b,sizeof(pstring)-1)
57 /* the following are used by loadparm for option lists */
60 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,
61 P_STRING,P_GSTRING,P_ENUM,P_SEP
66 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
80 struct enum_list *enum_list;
84 static BOOL bLoaded = False;
87 #define GLOBAL_NAME "global"
90 /* some helpful bits */
91 #define pSERVICE(i) ServicePtrs[i]
92 #define iSERVICE(i) (*pSERVICE(i))
93 #define LP_SNUM_OK(iService) (((iService) >= 0) && ((iService) < iNumServices))
96 * This structure describes global (ie., server-wide) parameters.
106 static global Globals;
111 * This structure describes a single service.
131 /* This is a default service used to prime a services structure */
132 static service sDefault =
137 True, /* read only */
141 NULL, /* hosts allow */
142 NULL, /* hosts deny */
143 NULL, /* auth users */
144 NULL, /* secrets file */
146 NULL, /* exclude from */
151 /* local variables */
152 static service **ServicePtrs = NULL;
153 static int iNumServices = 0;
154 static int iServiceIndex = 0;
155 static BOOL bInGlobalSection = True;
157 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
159 static struct enum_list enum_facilities[] = {
161 { LOG_AUTH, "auth" },
164 { LOG_AUTHPRIV, "authpriv" },
167 { LOG_CRON, "cron" },
170 { LOG_DAEMON, "daemon" },
176 { LOG_KERN, "kern" },
182 { LOG_MAIL, "mail" },
185 { LOG_NEWS, "news" },
188 { LOG_AUTH, "security" },
191 { LOG_SYSLOG, "syslog" },
194 { LOG_USER, "user" },
197 { LOG_UUCP, "uucp" },
200 { LOG_LOCAL0, "local0" },
203 { LOG_LOCAL1, "local1" },
206 { LOG_LOCAL2, "local2" },
209 { LOG_LOCAL3, "local3" },
212 { LOG_LOCAL4, "local4" },
215 { LOG_LOCAL5, "local5" },
218 { LOG_LOCAL6, "local6" },
221 { LOG_LOCAL7, "local7" },
226 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
227 static struct parm_struct parm_table[] =
229 {"max connections", P_INTEGER, P_GLOBAL, &Globals.max_connections,NULL, 0},
230 {"motd file", P_STRING, P_GLOBAL, &Globals.motd_file, NULL, 0},
231 {"lock file", P_STRING, P_GLOBAL, &Globals.lock_file, NULL, 0},
232 {"syslog facility", P_ENUM, P_GLOBAL, &Globals.syslog_facility, enum_facilities,0},
234 {"name", P_STRING, P_LOCAL, &sDefault.name, NULL, 0},
235 {"comment", P_STRING, P_LOCAL, &sDefault.comment, NULL, 0},
236 {"path", P_STRING, P_LOCAL, &sDefault.path, NULL, 0},
237 {"read only", P_BOOL, P_LOCAL, &sDefault.read_only, NULL, 0},
238 {"list", P_BOOL, P_LOCAL, &sDefault.list, NULL, 0},
239 {"uid", P_STRING, P_LOCAL, &sDefault.uid, NULL, 0},
240 {"gid", P_STRING, P_LOCAL, &sDefault.gid, NULL, 0},
241 {"hosts allow", P_STRING, P_LOCAL, &sDefault.hosts_allow, NULL, 0},
242 {"hosts deny", P_STRING, P_LOCAL, &sDefault.hosts_deny, NULL, 0},
243 {"auth users", P_STRING, P_LOCAL, &sDefault.auth_users, NULL, 0},
244 {"secrets file", P_STRING, P_LOCAL, &sDefault.secrets_file,NULL, 0},
245 {"exclude", P_STRING, P_LOCAL, &sDefault.exclude, NULL, 0},
246 {"exclude from", P_STRING, P_LOCAL, &sDefault.exclude_from,NULL, 0},
247 {NULL, P_BOOL, P_NONE, NULL, NULL, 0}
251 /***************************************************************************
252 Initialise the global parameter structure.
253 ***************************************************************************/
254 static void init_globals(void)
256 memset(&Globals, 0, sizeof(Globals));
258 Globals.syslog_facility = LOG_DAEMON;
260 Globals.lock_file = "/var/run/rsyncd.lock";
263 /***************************************************************************
264 Initialise the sDefault parameter structure.
265 ***************************************************************************/
266 static void init_locals(void)
272 In this section all the functions that are used to access the
273 parameters from the rest of the program are defined
276 #define FN_GLOBAL_STRING(fn_name,ptr) \
277 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
278 #define FN_GLOBAL_BOOL(fn_name,ptr) \
279 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
280 #define FN_GLOBAL_CHAR(fn_name,ptr) \
281 char fn_name(void) {return(*(char *)(ptr));}
282 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
283 int fn_name(void) {return(*(int *)(ptr));}
285 #define FN_LOCAL_STRING(fn_name,val) \
286 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
287 #define FN_LOCAL_BOOL(fn_name,val) \
288 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
289 #define FN_LOCAL_CHAR(fn_name,val) \
290 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
291 #define FN_LOCAL_INTEGER(fn_name,val) \
292 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
295 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
296 FN_GLOBAL_STRING(lp_lock_file, &Globals.lock_file)
297 FN_GLOBAL_INTEGER(lp_max_connections, &Globals.max_connections)
298 FN_GLOBAL_INTEGER(lp_syslog_facility, &Globals.syslog_facility)
299 FN_LOCAL_STRING(lp_name, name)
300 FN_LOCAL_STRING(lp_comment, comment)
301 FN_LOCAL_STRING(lp_path, path)
302 FN_LOCAL_BOOL(lp_read_only, read_only)
303 FN_LOCAL_BOOL(lp_list, list)
304 FN_LOCAL_STRING(lp_uid, uid)
305 FN_LOCAL_STRING(lp_gid, gid)
306 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
307 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
308 FN_LOCAL_STRING(lp_auth_users, auth_users)
309 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
310 FN_LOCAL_STRING(lp_exclude, exclude)
311 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
313 /* local prototypes */
314 static int strwicmp( char *psz1, char *psz2 );
315 static int map_parameter( char *parmname);
316 static BOOL set_boolean( BOOL *pb, char *parmvalue );
317 static int getservicebyname(char *name, service *pserviceDest);
318 static void copy_service( service *pserviceDest,
319 service *pserviceSource);
320 static BOOL do_parameter(char *parmname, char *parmvalue);
321 static BOOL do_section(char *sectionname);
324 /***************************************************************************
325 initialise a service to the defaults
326 ***************************************************************************/
327 static void init_service(service *pservice)
329 bzero((char *)pservice,sizeof(service));
330 copy_service(pservice,&sDefault);
333 static void string_set(char **s, char *v)
340 if (!*s) exit_cleanup(1);
344 /***************************************************************************
345 add a new service to the services array initialising it with the given
347 ***************************************************************************/
348 static int add_a_service(service *pservice, char *name)
352 int num_to_alloc = iNumServices+1;
354 tservice = *pservice;
356 /* it might already exist */
359 i = getservicebyname(name,NULL);
366 ServicePtrs = (service **)Realloc(ServicePtrs,sizeof(service *)*num_to_alloc);
368 pSERVICE(iNumServices) = (service *)malloc(sizeof(service));
370 if (!ServicePtrs || !pSERVICE(iNumServices))
375 init_service(pSERVICE(i));
376 copy_service(pSERVICE(i),&tservice);
378 string_set(&iSERVICE(i).name,name);
383 /***************************************************************************
384 Do a case-insensitive, whitespace-ignoring string compare.
385 ***************************************************************************/
386 static int strwicmp(char *psz1, char *psz2)
388 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
389 /* appropriate value. */
399 /* sync the strings on first non-whitespace */
402 while (isspace(*psz1))
404 while (isspace(*psz2))
406 if (toupper(*psz1) != toupper(*psz2) || *psz1 == '\0' || *psz2 == '\0')
411 return (*psz1 - *psz2);
414 /***************************************************************************
415 Map a parameter's string representation to something we can use.
416 Returns False if the parameter string is not recognised, else TRUE.
417 ***************************************************************************/
418 static int map_parameter(char *parmname)
422 if (*parmname == '-')
425 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
426 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
429 rprintf(FERROR, "Unknown parameter encountered: \"%s\"\n", parmname);
434 /***************************************************************************
435 Set a boolean variable from the text value stored in the passed string.
436 Returns True in success, False if the passed string does not correctly
438 ***************************************************************************/
439 static BOOL set_boolean(BOOL *pb, char *parmvalue)
444 if (strwicmp(parmvalue, "yes") == 0 ||
445 strwicmp(parmvalue, "true") == 0 ||
446 strwicmp(parmvalue, "1") == 0)
449 if (strwicmp(parmvalue, "no") == 0 ||
450 strwicmp(parmvalue, "False") == 0 ||
451 strwicmp(parmvalue, "0") == 0)
455 rprintf(FERROR, "Badly formed boolean in configuration file: \"%s\".\n",
462 /***************************************************************************
463 Find a service by name. Otherwise works like get_service.
464 ***************************************************************************/
465 static int getservicebyname(char *name, service *pserviceDest)
469 for (iService = iNumServices - 1; iService >= 0; iService--)
470 if (strwicmp(iSERVICE(iService).name, name) == 0)
472 if (pserviceDest != NULL)
473 copy_service(pserviceDest, pSERVICE(iService));
482 /***************************************************************************
483 Copy a service structure to another
485 ***************************************************************************/
486 static void copy_service(service *pserviceDest,
487 service *pserviceSource)
491 for (i=0;parm_table[i].label;i++)
492 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
493 void *def_ptr = parm_table[i].ptr;
495 ((char *)pserviceSource) + PTR_DIFF(def_ptr,&sDefault);
497 ((char *)pserviceDest) + PTR_DIFF(def_ptr,&sDefault);
499 switch (parm_table[i].type)
503 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
509 *(int *)dest_ptr = *(int *)src_ptr;
513 *(char *)dest_ptr = *(char *)src_ptr;
517 string_set(dest_ptr,*(char **)src_ptr);
527 /***************************************************************************
528 Process a parameter for a particular service number. If snum < 0
529 then assume we are in the globals
530 ***************************************************************************/
531 static BOOL lp_do_parameter(int snum, char *parmname, char *parmvalue)
534 void *parm_ptr=NULL; /* where we are going to store the result */
537 parmnum = map_parameter(parmname);
541 rprintf(FERROR, "Ignoring unknown parameter \"%s\"\n", parmname);
545 def_ptr = parm_table[parmnum].ptr;
547 /* we might point at a service, the default service or a global */
551 if (parm_table[parmnum].class == P_GLOBAL) {
552 rprintf(FERROR, "Global parameter %s found in service section!\n",parmname);
555 parm_ptr = ((char *)pSERVICE(snum)) + PTR_DIFF(def_ptr,&sDefault);
558 /* now switch on the type of variable it is */
559 switch (parm_table[parmnum].type)
562 set_boolean(parm_ptr,parmvalue);
566 set_boolean(parm_ptr,parmvalue);
567 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
571 *(int *)parm_ptr = atoi(parmvalue);
575 *(char *)parm_ptr = *parmvalue;
579 sscanf(parmvalue,"%o",(int *)parm_ptr);
583 string_set(parm_ptr,parmvalue);
587 strlcpy((char *)parm_ptr,parmvalue,sizeof(pstring)-1);
591 for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
592 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
593 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
597 if (!parm_table[parmnum].enum_list[i].name) {
598 if (atoi(parmvalue) > 0)
599 *(int *)parm_ptr = atoi(parmvalue);
609 /***************************************************************************
611 ***************************************************************************/
612 static BOOL do_parameter(char *parmname, char *parmvalue)
614 return lp_do_parameter(bInGlobalSection?-2:iServiceIndex, parmname, parmvalue);
617 /***************************************************************************
618 Process a new section (service). At this stage all sections are services.
619 Later we'll have special sections that permit server parameters to be set.
620 Returns True on success, False on failure.
621 ***************************************************************************/
622 static BOOL do_section(char *sectionname)
625 BOOL isglobal = (strwicmp(sectionname, GLOBAL_NAME) == 0);
628 /* if we were in a global section then do the local inits */
629 if (bInGlobalSection && !isglobal)
632 /* if we've just struck a global section, note the fact. */
633 bInGlobalSection = isglobal;
635 /* check for multiple global sections */
636 if (bInGlobalSection)
641 /* if we have a current service, tidy it up before moving on */
644 if (iServiceIndex >= 0)
647 /* if all is still well, move to the next record in the services array */
650 /* We put this here to avoid an odd message order if messages are */
651 /* issued by the post-processing of a previous section. */
653 if ((iServiceIndex=add_a_service(&sDefault,sectionname)) < 0)
655 rprintf(FERROR,"Failed to add a new service\n");
664 /***************************************************************************
665 Load the services array from the services file. Return True on success,
667 ***************************************************************************/
668 BOOL lp_load(char *pszFname, int globals_only)
675 bInGlobalSection = True;
679 pstrcpy(n2,pszFname);
681 /* We get sections first, so have to start 'behind' to make up */
683 bRetval = pm_process(n2, globals_only?NULL:do_section, do_parameter);
691 /***************************************************************************
692 return the max number of services
693 ***************************************************************************/
694 int lp_numservices(void)
696 return(iNumServices);
699 /***************************************************************************
700 Return the number of the service with the given name, or -1 if it doesn't
701 exist. Note that this is a DIFFERENT ANIMAL from the internal function
702 getservicebyname()! This works ONLY if all services have been loaded, and
703 does not copy the found service.
704 ***************************************************************************/
705 int lp_number(char *name)
709 for (iService = iNumServices - 1; iService >= 0; iService--)
710 if (strequal(lp_name(iService), name))