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.
104 char *socket_options;
107 static global Globals;
112 * This structure describes a single service.
132 /* This is a default service used to prime a services structure */
133 static service sDefault =
138 True, /* read only */
142 NULL, /* hosts allow */
143 NULL, /* hosts deny */
144 NULL, /* auth users */
145 NULL, /* secrets file */
147 NULL, /* exclude from */
152 /* local variables */
153 static service **ServicePtrs = NULL;
154 static int iNumServices = 0;
155 static int iServiceIndex = 0;
156 static BOOL bInGlobalSection = True;
158 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
160 static struct enum_list enum_facilities[] = {
162 { LOG_AUTH, "auth" },
165 { LOG_AUTHPRIV, "authpriv" },
168 { LOG_CRON, "cron" },
171 { LOG_DAEMON, "daemon" },
177 { LOG_KERN, "kern" },
183 { LOG_MAIL, "mail" },
186 { LOG_NEWS, "news" },
189 { LOG_AUTH, "security" },
192 { LOG_SYSLOG, "syslog" },
195 { LOG_USER, "user" },
198 { LOG_UUCP, "uucp" },
201 { LOG_LOCAL0, "local0" },
204 { LOG_LOCAL1, "local1" },
207 { LOG_LOCAL2, "local2" },
210 { LOG_LOCAL3, "local3" },
213 { LOG_LOCAL4, "local4" },
216 { LOG_LOCAL5, "local5" },
219 { LOG_LOCAL6, "local6" },
222 { LOG_LOCAL7, "local7" },
227 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
228 static struct parm_struct parm_table[] =
230 {"max connections", P_INTEGER, P_GLOBAL, &Globals.max_connections,NULL, 0},
231 {"motd file", P_STRING, P_GLOBAL, &Globals.motd_file, NULL, 0},
232 {"lock file", P_STRING, P_GLOBAL, &Globals.lock_file, NULL, 0},
233 {"syslog facility", P_ENUM, P_GLOBAL, &Globals.syslog_facility, enum_facilities,0},
234 {"socket options", P_STRING, P_GLOBAL, &Globals.socket_options,NULL, 0},
235 {"log file", P_STRING, P_GLOBAL, &Globals.log_file, NULL, 0},
237 {"name", P_STRING, P_LOCAL, &sDefault.name, NULL, 0},
238 {"comment", P_STRING, P_LOCAL, &sDefault.comment, NULL, 0},
239 {"path", P_STRING, P_LOCAL, &sDefault.path, NULL, 0},
240 {"read only", P_BOOL, P_LOCAL, &sDefault.read_only, NULL, 0},
241 {"list", P_BOOL, P_LOCAL, &sDefault.list, NULL, 0},
242 {"uid", P_STRING, P_LOCAL, &sDefault.uid, NULL, 0},
243 {"gid", P_STRING, P_LOCAL, &sDefault.gid, NULL, 0},
244 {"hosts allow", P_STRING, P_LOCAL, &sDefault.hosts_allow, NULL, 0},
245 {"hosts deny", P_STRING, P_LOCAL, &sDefault.hosts_deny, NULL, 0},
246 {"auth users", P_STRING, P_LOCAL, &sDefault.auth_users, NULL, 0},
247 {"secrets file", P_STRING, P_LOCAL, &sDefault.secrets_file,NULL, 0},
248 {"exclude", P_STRING, P_LOCAL, &sDefault.exclude, NULL, 0},
249 {"exclude from", P_STRING, P_LOCAL, &sDefault.exclude_from,NULL, 0},
250 {NULL, P_BOOL, P_NONE, NULL, NULL, 0}
254 /***************************************************************************
255 Initialise the global parameter structure.
256 ***************************************************************************/
257 static void init_globals(void)
259 memset(&Globals, 0, sizeof(Globals));
261 Globals.syslog_facility = LOG_DAEMON;
263 Globals.lock_file = "/var/run/rsyncd.lock";
266 /***************************************************************************
267 Initialise the sDefault parameter structure.
268 ***************************************************************************/
269 static void init_locals(void)
275 In this section all the functions that are used to access the
276 parameters from the rest of the program are defined
279 #define FN_GLOBAL_STRING(fn_name,ptr) \
280 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
281 #define FN_GLOBAL_BOOL(fn_name,ptr) \
282 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
283 #define FN_GLOBAL_CHAR(fn_name,ptr) \
284 char fn_name(void) {return(*(char *)(ptr));}
285 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
286 int fn_name(void) {return(*(int *)(ptr));}
288 #define FN_LOCAL_STRING(fn_name,val) \
289 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
290 #define FN_LOCAL_BOOL(fn_name,val) \
291 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
292 #define FN_LOCAL_CHAR(fn_name,val) \
293 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
294 #define FN_LOCAL_INTEGER(fn_name,val) \
295 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
298 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
299 FN_GLOBAL_STRING(lp_lock_file, &Globals.lock_file)
300 FN_GLOBAL_STRING(lp_log_file, &Globals.log_file)
301 FN_GLOBAL_STRING(lp_socket_options, &Globals.socket_options)
302 FN_GLOBAL_INTEGER(lp_max_connections, &Globals.max_connections)
303 FN_GLOBAL_INTEGER(lp_syslog_facility, &Globals.syslog_facility)
305 FN_LOCAL_STRING(lp_name, name)
306 FN_LOCAL_STRING(lp_comment, comment)
307 FN_LOCAL_STRING(lp_path, path)
308 FN_LOCAL_BOOL(lp_read_only, read_only)
309 FN_LOCAL_BOOL(lp_list, list)
310 FN_LOCAL_STRING(lp_uid, uid)
311 FN_LOCAL_STRING(lp_gid, gid)
312 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
313 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
314 FN_LOCAL_STRING(lp_auth_users, auth_users)
315 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
316 FN_LOCAL_STRING(lp_exclude, exclude)
317 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
319 /* local prototypes */
320 static int strwicmp( char *psz1, char *psz2 );
321 static int map_parameter( char *parmname);
322 static BOOL set_boolean( BOOL *pb, char *parmvalue );
323 static int getservicebyname(char *name, service *pserviceDest);
324 static void copy_service( service *pserviceDest,
325 service *pserviceSource);
326 static BOOL do_parameter(char *parmname, char *parmvalue);
327 static BOOL do_section(char *sectionname);
330 /***************************************************************************
331 initialise a service to the defaults
332 ***************************************************************************/
333 static void init_service(service *pservice)
335 memset((char *)pservice,0,sizeof(service));
336 copy_service(pservice,&sDefault);
339 static void string_set(char **s, char *v)
346 if (!*s) exit_cleanup(1);
350 /***************************************************************************
351 add a new service to the services array initialising it with the given
353 ***************************************************************************/
354 static int add_a_service(service *pservice, char *name)
358 int num_to_alloc = iNumServices+1;
360 tservice = *pservice;
362 /* it might already exist */
365 i = getservicebyname(name,NULL);
372 ServicePtrs = (service **)Realloc(ServicePtrs,sizeof(service *)*num_to_alloc);
375 pSERVICE(iNumServices) = (service *)malloc(sizeof(service));
377 if (!ServicePtrs || !pSERVICE(iNumServices))
382 init_service(pSERVICE(i));
383 copy_service(pSERVICE(i),&tservice);
385 string_set(&iSERVICE(i).name,name);
390 /***************************************************************************
391 Do a case-insensitive, whitespace-ignoring string compare.
392 ***************************************************************************/
393 static int strwicmp(char *psz1, char *psz2)
395 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
396 /* appropriate value. */
406 /* sync the strings on first non-whitespace */
409 while (isspace(*psz1))
411 while (isspace(*psz2))
413 if (toupper(*psz1) != toupper(*psz2) || *psz1 == '\0' || *psz2 == '\0')
418 return (*psz1 - *psz2);
421 /***************************************************************************
422 Map a parameter's string representation to something we can use.
423 Returns False if the parameter string is not recognised, else TRUE.
424 ***************************************************************************/
425 static int map_parameter(char *parmname)
429 if (*parmname == '-')
432 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
433 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
436 rprintf(FERROR, "Unknown parameter encountered: \"%s\"\n", parmname);
441 /***************************************************************************
442 Set a boolean variable from the text value stored in the passed string.
443 Returns True in success, False if the passed string does not correctly
445 ***************************************************************************/
446 static BOOL set_boolean(BOOL *pb, char *parmvalue)
451 if (strwicmp(parmvalue, "yes") == 0 ||
452 strwicmp(parmvalue, "true") == 0 ||
453 strwicmp(parmvalue, "1") == 0)
456 if (strwicmp(parmvalue, "no") == 0 ||
457 strwicmp(parmvalue, "False") == 0 ||
458 strwicmp(parmvalue, "0") == 0)
462 rprintf(FERROR, "Badly formed boolean in configuration file: \"%s\".\n",
469 /***************************************************************************
470 Find a service by name. Otherwise works like get_service.
471 ***************************************************************************/
472 static int getservicebyname(char *name, service *pserviceDest)
476 for (iService = iNumServices - 1; iService >= 0; iService--)
477 if (strwicmp(iSERVICE(iService).name, name) == 0)
479 if (pserviceDest != NULL)
480 copy_service(pserviceDest, pSERVICE(iService));
489 /***************************************************************************
490 Copy a service structure to another
492 ***************************************************************************/
493 static void copy_service(service *pserviceDest,
494 service *pserviceSource)
498 for (i=0;parm_table[i].label;i++)
499 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
500 void *def_ptr = parm_table[i].ptr;
502 ((char *)pserviceSource) + PTR_DIFF(def_ptr,&sDefault);
504 ((char *)pserviceDest) + PTR_DIFF(def_ptr,&sDefault);
506 switch (parm_table[i].type)
510 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
516 *(int *)dest_ptr = *(int *)src_ptr;
520 *(char *)dest_ptr = *(char *)src_ptr;
524 string_set(dest_ptr,*(char **)src_ptr);
534 /***************************************************************************
535 Process a parameter for a particular service number. If snum < 0
536 then assume we are in the globals
537 ***************************************************************************/
538 static BOOL lp_do_parameter(int snum, char *parmname, char *parmvalue)
541 void *parm_ptr=NULL; /* where we are going to store the result */
544 parmnum = map_parameter(parmname);
548 rprintf(FERROR, "Ignoring unknown parameter \"%s\"\n", parmname);
552 def_ptr = parm_table[parmnum].ptr;
554 /* we might point at a service, the default service or a global */
558 if (parm_table[parmnum].class == P_GLOBAL) {
559 rprintf(FERROR, "Global parameter %s found in service section!\n",parmname);
562 parm_ptr = ((char *)pSERVICE(snum)) + PTR_DIFF(def_ptr,&sDefault);
565 /* now switch on the type of variable it is */
566 switch (parm_table[parmnum].type)
569 set_boolean(parm_ptr,parmvalue);
573 set_boolean(parm_ptr,parmvalue);
574 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
578 *(int *)parm_ptr = atoi(parmvalue);
582 *(char *)parm_ptr = *parmvalue;
586 sscanf(parmvalue,"%o",(int *)parm_ptr);
590 string_set(parm_ptr,parmvalue);
594 strlcpy((char *)parm_ptr,parmvalue,sizeof(pstring)-1);
598 for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
599 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
600 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
604 if (!parm_table[parmnum].enum_list[i].name) {
605 if (atoi(parmvalue) > 0)
606 *(int *)parm_ptr = atoi(parmvalue);
616 /***************************************************************************
618 ***************************************************************************/
619 static BOOL do_parameter(char *parmname, char *parmvalue)
621 return lp_do_parameter(bInGlobalSection?-2:iServiceIndex, parmname, parmvalue);
624 /***************************************************************************
625 Process a new section (service). At this stage all sections are services.
626 Later we'll have special sections that permit server parameters to be set.
627 Returns True on success, False on failure.
628 ***************************************************************************/
629 static BOOL do_section(char *sectionname)
632 BOOL isglobal = (strwicmp(sectionname, GLOBAL_NAME) == 0);
635 /* if we were in a global section then do the local inits */
636 if (bInGlobalSection && !isglobal)
639 /* if we've just struck a global section, note the fact. */
640 bInGlobalSection = isglobal;
642 /* check for multiple global sections */
643 if (bInGlobalSection)
648 /* if we have a current service, tidy it up before moving on */
651 if (iServiceIndex >= 0)
654 /* if all is still well, move to the next record in the services array */
657 /* We put this here to avoid an odd message order if messages are */
658 /* issued by the post-processing of a previous section. */
660 if ((iServiceIndex=add_a_service(&sDefault,sectionname)) < 0)
662 rprintf(FERROR,"Failed to add a new service\n");
671 /***************************************************************************
672 Load the services array from the services file. Return True on success,
674 ***************************************************************************/
675 BOOL lp_load(char *pszFname, int globals_only)
682 bInGlobalSection = True;
686 pstrcpy(n2,pszFname);
688 /* We get sections first, so have to start 'behind' to make up */
690 bRetval = pm_process(n2, globals_only?NULL:do_section, do_parameter);
698 /***************************************************************************
699 return the max number of services
700 ***************************************************************************/
701 int lp_numservices(void)
703 return(iNumServices);
706 /***************************************************************************
707 Return the number of the service with the given name, or -1 if it doesn't
708 exist. Note that this is a DIFFERENT ANIMAL from the internal function
709 getservicebyname()! This works ONLY if all services have been loaded, and
710 does not copy the found service.
711 ***************************************************************************/
712 int lp_number(char *name)
716 for (iService = iNumServices - 1; iService >= 0; iService--)
717 if (strequal(lp_name(iService), name))