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.
129 /* This is a default service used to prime a services structure */
130 static service sDefault =
135 True, /* read only */
139 NULL, /* hosts allow */
140 NULL, /* hosts deny */
141 NULL, /* auth users */
142 NULL, /* secrets file */
147 /* local variables */
148 static service **ServicePtrs = NULL;
149 static int iNumServices = 0;
150 static int iServiceIndex = 0;
151 static BOOL bInGlobalSection = True;
153 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
155 static struct enum_list enum_facilities[] = {
157 { LOG_AUTH, "auth" },
160 { LOG_AUTHPRIV, "authpriv" },
163 { LOG_CRON, "cron" },
166 { LOG_DAEMON, "daemon" },
172 { LOG_KERN, "kern" },
178 { LOG_MAIL, "mail" },
181 { LOG_NEWS, "news" },
184 { LOG_AUTH, "security" },
187 { LOG_SYSLOG, "syslog" },
190 { LOG_USER, "user" },
193 { LOG_UUCP, "uucp" },
196 { LOG_LOCAL0, "local0" },
199 { LOG_LOCAL1, "local1" },
202 { LOG_LOCAL2, "local2" },
205 { LOG_LOCAL3, "local3" },
208 { LOG_LOCAL4, "local4" },
211 { LOG_LOCAL5, "local5" },
214 { LOG_LOCAL6, "local6" },
217 { LOG_LOCAL7, "local7" },
222 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
223 static struct parm_struct parm_table[] =
225 {"max connections", P_INTEGER, P_GLOBAL, &Globals.max_connections,NULL, 0},
226 {"motd file", P_STRING, P_GLOBAL, &Globals.motd_file, NULL, 0},
227 {"lock file", P_STRING, P_GLOBAL, &Globals.lock_file, NULL, 0},
228 {"syslog facility", P_ENUM, P_GLOBAL, &Globals.syslog_facility, enum_facilities,0},
230 {"name", P_STRING, P_LOCAL, &sDefault.name, NULL, 0},
231 {"comment", P_STRING, P_LOCAL, &sDefault.comment, NULL, 0},
232 {"path", P_STRING, P_LOCAL, &sDefault.path, NULL, 0},
233 {"read only", P_BOOL, P_LOCAL, &sDefault.read_only, NULL, 0},
234 {"list", P_BOOL, P_LOCAL, &sDefault.list, NULL, 0},
235 {"uid", P_STRING, P_LOCAL, &sDefault.uid, NULL, 0},
236 {"gid", P_STRING, P_LOCAL, &sDefault.gid, NULL, 0},
237 {"hosts allow", P_STRING, P_LOCAL, &sDefault.hosts_allow, NULL, 0},
238 {"hosts deny", P_STRING, P_LOCAL, &sDefault.hosts_deny, NULL, 0},
239 {"auth users", P_STRING, P_LOCAL, &sDefault.auth_users, NULL, 0},
240 {"secrets file", P_STRING, P_LOCAL, &sDefault.secrets_file,NULL, 0},
241 {NULL, P_BOOL, P_NONE, NULL, NULL, 0}
245 /***************************************************************************
246 Initialise the global parameter structure.
247 ***************************************************************************/
248 static void init_globals(void)
251 Globals.syslog_facility = LOG_DAEMON;
253 Globals.lock_file = "/var/run/rsyncd.lock";
256 /***************************************************************************
257 Initialise the sDefault parameter structure.
258 ***************************************************************************/
259 static void init_locals(void)
265 In this section all the functions that are used to access the
266 parameters from the rest of the program are defined
269 #define FN_GLOBAL_STRING(fn_name,ptr) \
270 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
271 #define FN_GLOBAL_BOOL(fn_name,ptr) \
272 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
273 #define FN_GLOBAL_CHAR(fn_name,ptr) \
274 char fn_name(void) {return(*(char *)(ptr));}
275 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
276 int fn_name(void) {return(*(int *)(ptr));}
278 #define FN_LOCAL_STRING(fn_name,val) \
279 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
280 #define FN_LOCAL_BOOL(fn_name,val) \
281 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
282 #define FN_LOCAL_CHAR(fn_name,val) \
283 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
284 #define FN_LOCAL_INTEGER(fn_name,val) \
285 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
288 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
289 FN_GLOBAL_STRING(lp_lock_file, &Globals.lock_file)
290 FN_GLOBAL_INTEGER(lp_max_connections, &Globals.max_connections)
291 FN_GLOBAL_INTEGER(lp_syslog_facility, &Globals.syslog_facility)
292 FN_LOCAL_STRING(lp_name, name)
293 FN_LOCAL_STRING(lp_comment, comment)
294 FN_LOCAL_STRING(lp_path, path)
295 FN_LOCAL_BOOL(lp_read_only, read_only)
296 FN_LOCAL_BOOL(lp_list, list)
297 FN_LOCAL_STRING(lp_uid, uid)
298 FN_LOCAL_STRING(lp_gid, gid)
299 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
300 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
301 FN_LOCAL_STRING(lp_auth_users, auth_users)
302 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
304 /* local prototypes */
305 static int strwicmp( char *psz1, char *psz2 );
306 static int map_parameter( char *parmname);
307 static BOOL set_boolean( BOOL *pb, char *parmvalue );
308 static int getservicebyname(char *name, service *pserviceDest);
309 static void copy_service( service *pserviceDest,
310 service *pserviceSource);
311 static BOOL do_parameter(char *parmname, char *parmvalue);
312 static BOOL do_section(char *sectionname);
315 /***************************************************************************
316 initialise a service to the defaults
317 ***************************************************************************/
318 static void init_service(service *pservice)
320 bzero((char *)pservice,sizeof(service));
321 copy_service(pservice,&sDefault);
324 static void string_set(char **s, char *v)
331 if (!*s) exit_cleanup(1);
335 /***************************************************************************
336 add a new service to the services array initialising it with the given
338 ***************************************************************************/
339 static int add_a_service(service *pservice, char *name)
343 int num_to_alloc = iNumServices+1;
345 tservice = *pservice;
347 /* it might already exist */
350 i = getservicebyname(name,NULL);
357 ServicePtrs = (service **)Realloc(ServicePtrs,sizeof(service *)*num_to_alloc);
359 pSERVICE(iNumServices) = (service *)malloc(sizeof(service));
361 if (!ServicePtrs || !pSERVICE(iNumServices))
366 init_service(pSERVICE(i));
367 copy_service(pSERVICE(i),&tservice);
369 string_set(&iSERVICE(i).name,name);
374 /***************************************************************************
375 Do a case-insensitive, whitespace-ignoring string compare.
376 ***************************************************************************/
377 static int strwicmp(char *psz1, char *psz2)
379 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
380 /* appropriate value. */
390 /* sync the strings on first non-whitespace */
393 while (isspace(*psz1))
395 while (isspace(*psz2))
397 if (toupper(*psz1) != toupper(*psz2) || *psz1 == '\0' || *psz2 == '\0')
402 return (*psz1 - *psz2);
405 /***************************************************************************
406 Map a parameter's string representation to something we can use.
407 Returns False if the parameter string is not recognised, else TRUE.
408 ***************************************************************************/
409 static int map_parameter(char *parmname)
413 if (*parmname == '-')
416 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
417 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
420 rprintf(FERROR, "Unknown parameter encountered: \"%s\"\n", parmname);
425 /***************************************************************************
426 Set a boolean variable from the text value stored in the passed string.
427 Returns True in success, False if the passed string does not correctly
429 ***************************************************************************/
430 static BOOL set_boolean(BOOL *pb, char *parmvalue)
435 if (strwicmp(parmvalue, "yes") == 0 ||
436 strwicmp(parmvalue, "true") == 0 ||
437 strwicmp(parmvalue, "1") == 0)
440 if (strwicmp(parmvalue, "no") == 0 ||
441 strwicmp(parmvalue, "False") == 0 ||
442 strwicmp(parmvalue, "0") == 0)
446 rprintf(FERROR, "Badly formed boolean in configuration file: \"%s\".\n",
453 /***************************************************************************
454 Find a service by name. Otherwise works like get_service.
455 ***************************************************************************/
456 static int getservicebyname(char *name, service *pserviceDest)
460 for (iService = iNumServices - 1; iService >= 0; iService--)
461 if (strwicmp(iSERVICE(iService).name, name) == 0)
463 if (pserviceDest != NULL)
464 copy_service(pserviceDest, pSERVICE(iService));
473 /***************************************************************************
474 Copy a service structure to another
476 ***************************************************************************/
477 static void copy_service(service *pserviceDest,
478 service *pserviceSource)
482 for (i=0;parm_table[i].label;i++)
483 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
484 void *def_ptr = parm_table[i].ptr;
486 ((char *)pserviceSource) + PTR_DIFF(def_ptr,&sDefault);
488 ((char *)pserviceDest) + PTR_DIFF(def_ptr,&sDefault);
490 switch (parm_table[i].type)
494 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
500 *(int *)dest_ptr = *(int *)src_ptr;
504 *(char *)dest_ptr = *(char *)src_ptr;
508 string_set(dest_ptr,*(char **)src_ptr);
518 /***************************************************************************
519 Process a parameter for a particular service number. If snum < 0
520 then assume we are in the globals
521 ***************************************************************************/
522 static BOOL lp_do_parameter(int snum, char *parmname, char *parmvalue)
525 void *parm_ptr=NULL; /* where we are going to store the result */
528 parmnum = map_parameter(parmname);
532 rprintf(FERROR, "Ignoring unknown parameter \"%s\"\n", parmname);
536 def_ptr = parm_table[parmnum].ptr;
538 /* we might point at a service, the default service or a global */
542 if (parm_table[parmnum].class == P_GLOBAL) {
543 rprintf(FERROR, "Global parameter %s found in service section!\n",parmname);
546 parm_ptr = ((char *)pSERVICE(snum)) + PTR_DIFF(def_ptr,&sDefault);
549 /* now switch on the type of variable it is */
550 switch (parm_table[parmnum].type)
553 set_boolean(parm_ptr,parmvalue);
557 set_boolean(parm_ptr,parmvalue);
558 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
562 *(int *)parm_ptr = atoi(parmvalue);
566 *(char *)parm_ptr = *parmvalue;
570 sscanf(parmvalue,"%o",(int *)parm_ptr);
574 string_set(parm_ptr,parmvalue);
578 strcpy((char *)parm_ptr,parmvalue);
582 for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
583 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
584 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
588 if (!parm_table[parmnum].enum_list[i].name) {
589 if (atoi(parmvalue) > 0)
590 *(int *)parm_ptr = atoi(parmvalue);
600 /***************************************************************************
602 ***************************************************************************/
603 static BOOL do_parameter(char *parmname, char *parmvalue)
605 return lp_do_parameter(bInGlobalSection?-2:iServiceIndex, parmname, parmvalue);
608 /***************************************************************************
609 Process a new section (service). At this stage all sections are services.
610 Later we'll have special sections that permit server parameters to be set.
611 Returns True on success, False on failure.
612 ***************************************************************************/
613 static BOOL do_section(char *sectionname)
616 BOOL isglobal = (strwicmp(sectionname, GLOBAL_NAME) == 0);
619 /* if we were in a global section then do the local inits */
620 if (bInGlobalSection && !isglobal)
623 /* if we've just struck a global section, note the fact. */
624 bInGlobalSection = isglobal;
626 /* check for multiple global sections */
627 if (bInGlobalSection)
632 /* if we have a current service, tidy it up before moving on */
635 if (iServiceIndex >= 0)
638 /* if all is still well, move to the next record in the services array */
641 /* We put this here to avoid an odd message order if messages are */
642 /* issued by the post-processing of a previous section. */
644 if ((iServiceIndex=add_a_service(&sDefault,sectionname)) < 0)
646 rprintf(FERROR,"Failed to add a new service\n");
655 /***************************************************************************
656 Load the services array from the services file. Return True on success,
658 ***************************************************************************/
659 BOOL lp_load(char *pszFname)
666 bInGlobalSection = True;
670 pstrcpy(n2,pszFname);
672 /* We get sections first, so have to start 'behind' to make up */
674 bRetval = pm_process(n2, do_section, do_parameter);
682 /***************************************************************************
683 return the max number of services
684 ***************************************************************************/
685 int lp_numservices(void)
687 return(iNumServices);
690 /***************************************************************************
691 Return the number of the service with the given name, or -1 if it doesn't
692 exist. Note that this is a DIFFERENT ANIMAL from the internal function
693 getservicebyname()! This works ONLY if all services have been loaded, and
694 does not copy the found service.
695 ***************************************************************************/
696 int lp_number(char *name)
700 for (iService = iNumServices - 1; iService >= 0; iService--)
701 if (strequal(lp_name(iService), name))