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;
136 /* This is a default service used to prime a services structure */
137 static service sDefault =
142 True, /* read only */
144 True, /* use chroot */
145 False, /* transfer logging */
148 NULL, /* hosts allow */
149 NULL, /* hosts deny */
150 NULL, /* auth users */
151 NULL, /* secrets file */
153 NULL, /* exclude from */
154 "%o %h [%a] %f %l", /* log format */
159 /* local variables */
160 static service **ServicePtrs = NULL;
161 static int iNumServices = 0;
162 static int iServiceIndex = 0;
163 static BOOL bInGlobalSection = True;
165 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
167 static struct enum_list enum_facilities[] = {
169 { LOG_AUTH, "auth" },
172 { LOG_AUTHPRIV, "authpriv" },
175 { LOG_CRON, "cron" },
178 { LOG_DAEMON, "daemon" },
184 { LOG_KERN, "kern" },
190 { LOG_MAIL, "mail" },
193 { LOG_NEWS, "news" },
196 { LOG_AUTH, "security" },
199 { LOG_SYSLOG, "syslog" },
202 { LOG_USER, "user" },
205 { LOG_UUCP, "uucp" },
208 { LOG_LOCAL0, "local0" },
211 { LOG_LOCAL1, "local1" },
214 { LOG_LOCAL2, "local2" },
217 { LOG_LOCAL3, "local3" },
220 { LOG_LOCAL4, "local4" },
223 { LOG_LOCAL5, "local5" },
226 { LOG_LOCAL6, "local6" },
229 { LOG_LOCAL7, "local7" },
234 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
235 static struct parm_struct parm_table[] =
237 {"max connections", P_INTEGER, P_GLOBAL, &Globals.max_connections,NULL, 0},
238 {"motd file", P_STRING, P_GLOBAL, &Globals.motd_file, NULL, 0},
239 {"lock file", P_STRING, P_GLOBAL, &Globals.lock_file, NULL, 0},
240 {"syslog facility", P_ENUM, P_GLOBAL, &Globals.syslog_facility, enum_facilities,0},
241 {"socket options", P_STRING, P_GLOBAL, &Globals.socket_options,NULL, 0},
242 {"log file", P_STRING, P_GLOBAL, &Globals.log_file, NULL, 0},
243 {"pid file", P_STRING, P_GLOBAL, &Globals.pid_file, NULL, 0},
245 {"name", P_STRING, P_LOCAL, &sDefault.name, NULL, 0},
246 {"comment", P_STRING, P_LOCAL, &sDefault.comment, NULL, 0},
247 {"path", P_STRING, P_LOCAL, &sDefault.path, NULL, 0},
248 {"read only", P_BOOL, P_LOCAL, &sDefault.read_only, NULL, 0},
249 {"list", P_BOOL, P_LOCAL, &sDefault.list, NULL, 0},
250 {"use chroot", P_BOOL, P_LOCAL, &sDefault.use_chroot, NULL, 0},
251 {"uid", P_STRING, P_LOCAL, &sDefault.uid, NULL, 0},
252 {"gid", P_STRING, P_LOCAL, &sDefault.gid, NULL, 0},
253 {"hosts allow", P_STRING, P_LOCAL, &sDefault.hosts_allow, NULL, 0},
254 {"hosts deny", P_STRING, P_LOCAL, &sDefault.hosts_deny, NULL, 0},
255 {"auth users", P_STRING, P_LOCAL, &sDefault.auth_users, NULL, 0},
256 {"secrets file", P_STRING, P_LOCAL, &sDefault.secrets_file,NULL, 0},
257 {"exclude", P_STRING, P_LOCAL, &sDefault.exclude, NULL, 0},
258 {"exclude from", P_STRING, P_LOCAL, &sDefault.exclude_from,NULL, 0},
259 {"transfer logging", P_BOOL, P_LOCAL, &sDefault.transfer_logging,NULL,0},
260 {"log format", P_STRING, P_LOCAL, &sDefault.log_format, NULL, 0},
261 {NULL, P_BOOL, P_NONE, NULL, NULL, 0}
265 /***************************************************************************
266 Initialise the global parameter structure.
267 ***************************************************************************/
268 static void init_globals(void)
270 memset(&Globals, 0, sizeof(Globals));
272 Globals.syslog_facility = LOG_DAEMON;
274 Globals.lock_file = "/var/run/rsyncd.lock";
277 /***************************************************************************
278 Initialise the sDefault parameter structure.
279 ***************************************************************************/
280 static void init_locals(void)
286 In this section all the functions that are used to access the
287 parameters from the rest of the program are defined
290 #define FN_GLOBAL_STRING(fn_name,ptr) \
291 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
292 #define FN_GLOBAL_BOOL(fn_name,ptr) \
293 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
294 #define FN_GLOBAL_CHAR(fn_name,ptr) \
295 char fn_name(void) {return(*(char *)(ptr));}
296 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
297 int fn_name(void) {return(*(int *)(ptr));}
299 #define FN_LOCAL_STRING(fn_name,val) \
300 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
301 #define FN_LOCAL_BOOL(fn_name,val) \
302 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
303 #define FN_LOCAL_CHAR(fn_name,val) \
304 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
305 #define FN_LOCAL_INTEGER(fn_name,val) \
306 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
309 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
310 FN_GLOBAL_STRING(lp_lock_file, &Globals.lock_file)
311 FN_GLOBAL_STRING(lp_log_file, &Globals.log_file)
312 FN_GLOBAL_STRING(lp_pid_file, &Globals.pid_file)
313 FN_GLOBAL_STRING(lp_socket_options, &Globals.socket_options)
314 FN_GLOBAL_INTEGER(lp_max_connections, &Globals.max_connections)
315 FN_GLOBAL_INTEGER(lp_syslog_facility, &Globals.syslog_facility)
317 FN_LOCAL_STRING(lp_name, name)
318 FN_LOCAL_STRING(lp_comment, comment)
319 FN_LOCAL_STRING(lp_path, path)
320 FN_LOCAL_BOOL(lp_read_only, read_only)
321 FN_LOCAL_BOOL(lp_list, list)
322 FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
323 FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
324 FN_LOCAL_STRING(lp_uid, uid)
325 FN_LOCAL_STRING(lp_gid, gid)
326 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
327 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
328 FN_LOCAL_STRING(lp_auth_users, auth_users)
329 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
330 FN_LOCAL_STRING(lp_exclude, exclude)
331 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
332 FN_LOCAL_STRING(lp_log_format, log_format)
334 /* local prototypes */
335 static int strwicmp( char *psz1, char *psz2 );
336 static int map_parameter( char *parmname);
337 static BOOL set_boolean( BOOL *pb, char *parmvalue );
338 static int getservicebyname(char *name, service *pserviceDest);
339 static void copy_service( service *pserviceDest,
340 service *pserviceSource);
341 static BOOL do_parameter(char *parmname, char *parmvalue);
342 static BOOL do_section(char *sectionname);
345 /***************************************************************************
346 initialise a service to the defaults
347 ***************************************************************************/
348 static void init_service(service *pservice)
350 memset((char *)pservice,0,sizeof(service));
351 copy_service(pservice,&sDefault);
354 static void string_set(char **s, char *v)
361 if (!*s) exit_cleanup(1);
365 /***************************************************************************
366 add a new service to the services array initialising it with the given
368 ***************************************************************************/
369 static int add_a_service(service *pservice, char *name)
373 int num_to_alloc = iNumServices+1;
375 tservice = *pservice;
377 /* it might already exist */
380 i = getservicebyname(name,NULL);
387 ServicePtrs = (service **)Realloc(ServicePtrs,sizeof(service *)*num_to_alloc);
390 pSERVICE(iNumServices) = (service *)malloc(sizeof(service));
392 if (!ServicePtrs || !pSERVICE(iNumServices))
397 init_service(pSERVICE(i));
398 copy_service(pSERVICE(i),&tservice);
400 string_set(&iSERVICE(i).name,name);
405 /***************************************************************************
406 Do a case-insensitive, whitespace-ignoring string compare.
407 ***************************************************************************/
408 static int strwicmp(char *psz1, char *psz2)
410 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
411 /* appropriate value. */
421 /* sync the strings on first non-whitespace */
424 while (isspace(*psz1))
426 while (isspace(*psz2))
428 if (toupper(*psz1) != toupper(*psz2) || *psz1 == '\0' || *psz2 == '\0')
433 return (*psz1 - *psz2);
436 /***************************************************************************
437 Map a parameter's string representation to something we can use.
438 Returns False if the parameter string is not recognised, else TRUE.
439 ***************************************************************************/
440 static int map_parameter(char *parmname)
444 if (*parmname == '-')
447 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
448 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
451 rprintf(FERROR, "Unknown parameter encountered: \"%s\"\n", parmname);
456 /***************************************************************************
457 Set a boolean variable from the text value stored in the passed string.
458 Returns True in success, False if the passed string does not correctly
460 ***************************************************************************/
461 static BOOL set_boolean(BOOL *pb, char *parmvalue)
466 if (strwicmp(parmvalue, "yes") == 0 ||
467 strwicmp(parmvalue, "true") == 0 ||
468 strwicmp(parmvalue, "1") == 0)
471 if (strwicmp(parmvalue, "no") == 0 ||
472 strwicmp(parmvalue, "False") == 0 ||
473 strwicmp(parmvalue, "0") == 0)
477 rprintf(FERROR, "Badly formed boolean in configuration file: \"%s\".\n",
484 /***************************************************************************
485 Find a service by name. Otherwise works like get_service.
486 ***************************************************************************/
487 static int getservicebyname(char *name, service *pserviceDest)
491 for (iService = iNumServices - 1; iService >= 0; iService--)
492 if (strwicmp(iSERVICE(iService).name, name) == 0)
494 if (pserviceDest != NULL)
495 copy_service(pserviceDest, pSERVICE(iService));
504 /***************************************************************************
505 Copy a service structure to another
507 ***************************************************************************/
508 static void copy_service(service *pserviceDest,
509 service *pserviceSource)
513 for (i=0;parm_table[i].label;i++)
514 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
515 void *def_ptr = parm_table[i].ptr;
517 ((char *)pserviceSource) + PTR_DIFF(def_ptr,&sDefault);
519 ((char *)pserviceDest) + PTR_DIFF(def_ptr,&sDefault);
521 switch (parm_table[i].type)
525 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
531 *(int *)dest_ptr = *(int *)src_ptr;
535 *(char *)dest_ptr = *(char *)src_ptr;
539 string_set(dest_ptr,*(char **)src_ptr);
549 /***************************************************************************
550 Process a parameter for a particular service number. If snum < 0
551 then assume we are in the globals
552 ***************************************************************************/
553 static BOOL lp_do_parameter(int snum, char *parmname, char *parmvalue)
556 void *parm_ptr=NULL; /* where we are going to store the result */
559 parmnum = map_parameter(parmname);
563 rprintf(FERROR, "Ignoring unknown parameter \"%s\"\n", parmname);
567 def_ptr = parm_table[parmnum].ptr;
569 /* we might point at a service, the default service or a global */
573 if (parm_table[parmnum].class == P_GLOBAL) {
574 rprintf(FERROR, "Global parameter %s found in service section!\n",parmname);
577 parm_ptr = ((char *)pSERVICE(snum)) + PTR_DIFF(def_ptr,&sDefault);
580 /* now switch on the type of variable it is */
581 switch (parm_table[parmnum].type)
584 set_boolean(parm_ptr,parmvalue);
588 set_boolean(parm_ptr,parmvalue);
589 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
593 *(int *)parm_ptr = atoi(parmvalue);
597 *(char *)parm_ptr = *parmvalue;
601 sscanf(parmvalue,"%o",(int *)parm_ptr);
605 string_set(parm_ptr,parmvalue);
609 strlcpy((char *)parm_ptr,parmvalue,sizeof(pstring)-1);
613 for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
614 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
615 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
619 if (!parm_table[parmnum].enum_list[i].name) {
620 if (atoi(parmvalue) > 0)
621 *(int *)parm_ptr = atoi(parmvalue);
631 /***************************************************************************
633 ***************************************************************************/
634 static BOOL do_parameter(char *parmname, char *parmvalue)
636 return lp_do_parameter(bInGlobalSection?-2:iServiceIndex, parmname, parmvalue);
639 /***************************************************************************
640 Process a new section (service). At this stage all sections are services.
641 Later we'll have special sections that permit server parameters to be set.
642 Returns True on success, False on failure.
643 ***************************************************************************/
644 static BOOL do_section(char *sectionname)
647 BOOL isglobal = (strwicmp(sectionname, GLOBAL_NAME) == 0);
650 /* if we were in a global section then do the local inits */
651 if (bInGlobalSection && !isglobal)
654 /* if we've just struck a global section, note the fact. */
655 bInGlobalSection = isglobal;
657 /* check for multiple global sections */
658 if (bInGlobalSection)
663 /* if we have a current service, tidy it up before moving on */
666 if (iServiceIndex >= 0)
669 /* if all is still well, move to the next record in the services array */
672 /* We put this here to avoid an odd message order if messages are */
673 /* issued by the post-processing of a previous section. */
675 if ((iServiceIndex=add_a_service(&sDefault,sectionname)) < 0)
677 rprintf(FERROR,"Failed to add a new service\n");
686 /***************************************************************************
687 Load the services array from the services file. Return True on success,
689 ***************************************************************************/
690 BOOL lp_load(char *pszFname, int globals_only)
697 bInGlobalSection = True;
701 pstrcpy(n2,pszFname);
703 /* We get sections first, so have to start 'behind' to make up */
705 bRetval = pm_process(n2, globals_only?NULL:do_section, do_parameter);
713 /***************************************************************************
714 return the max number of services
715 ***************************************************************************/
716 int lp_numservices(void)
718 return(iNumServices);
721 /***************************************************************************
722 Return the number of the service with the given name, or -1 if it doesn't
723 exist. Note that this is a DIFFERENT ANIMAL from the internal function
724 getservicebyname()! This works ONLY if all services have been loaded, and
725 does not copy the found service.
726 ***************************************************************************/
727 int lp_number(char *name)
731 for (iService = iNumServices - 1; iService >= 0; iService--)
732 if (strequal(lp_name(iService), name))