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))
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;
133 char *refuse_options;
138 /* This is a default service used to prime a services structure */
139 static service sDefault =
144 True, /* read only */
146 True, /* use chroot */
147 False, /* transfer logging */
150 NULL, /* hosts allow */
151 NULL, /* hosts deny */
152 NULL, /* auth users */
153 NULL, /* secrets file */
155 NULL, /* exclude from */
156 "%o %h [%a] %m (%u) %f %l", /* log format */
157 NULL, /* refuse options */
163 /* local variables */
164 static service **ServicePtrs = NULL;
165 static int iNumServices = 0;
166 static int iServiceIndex = 0;
167 static BOOL bInGlobalSection = True;
169 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
171 static struct enum_list enum_facilities[] = {
173 { LOG_AUTH, "auth" },
176 { LOG_AUTHPRIV, "authpriv" },
179 { LOG_CRON, "cron" },
182 { LOG_DAEMON, "daemon" },
188 { LOG_KERN, "kern" },
194 { LOG_MAIL, "mail" },
197 { LOG_NEWS, "news" },
200 { LOG_AUTH, "security" },
203 { LOG_SYSLOG, "syslog" },
206 { LOG_USER, "user" },
209 { LOG_UUCP, "uucp" },
212 { LOG_LOCAL0, "local0" },
215 { LOG_LOCAL1, "local1" },
218 { LOG_LOCAL2, "local2" },
221 { LOG_LOCAL3, "local3" },
224 { LOG_LOCAL4, "local4" },
227 { LOG_LOCAL5, "local5" },
230 { LOG_LOCAL6, "local6" },
233 { LOG_LOCAL7, "local7" },
238 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
239 static struct parm_struct parm_table[] =
241 {"max connections", P_INTEGER, P_GLOBAL, &Globals.max_connections,NULL, 0},
242 {"motd file", P_STRING, P_GLOBAL, &Globals.motd_file, NULL, 0},
243 {"lock file", P_STRING, P_GLOBAL, &Globals.lock_file, NULL, 0},
244 {"syslog facility", P_ENUM, P_GLOBAL, &Globals.syslog_facility, enum_facilities,0},
245 {"socket options", P_STRING, P_GLOBAL, &Globals.socket_options,NULL, 0},
246 {"log file", P_STRING, P_GLOBAL, &Globals.log_file, NULL, 0},
247 {"pid file", P_STRING, P_GLOBAL, &Globals.pid_file, NULL, 0},
249 {"timeout", P_INTEGER, P_LOCAL, &sDefault.timeout, NULL, 0},
250 {"name", P_STRING, P_LOCAL, &sDefault.name, NULL, 0},
251 {"comment", P_STRING, P_LOCAL, &sDefault.comment, NULL, 0},
252 {"path", P_STRING, P_LOCAL, &sDefault.path, NULL, 0},
253 {"read only", P_BOOL, P_LOCAL, &sDefault.read_only, NULL, 0},
254 {"list", P_BOOL, P_LOCAL, &sDefault.list, NULL, 0},
255 {"use chroot", P_BOOL, P_LOCAL, &sDefault.use_chroot, NULL, 0},
256 {"uid", P_STRING, P_LOCAL, &sDefault.uid, NULL, 0},
257 {"gid", P_STRING, P_LOCAL, &sDefault.gid, NULL, 0},
258 {"hosts allow", P_STRING, P_LOCAL, &sDefault.hosts_allow, NULL, 0},
259 {"hosts deny", P_STRING, P_LOCAL, &sDefault.hosts_deny, NULL, 0},
260 {"auth users", P_STRING, P_LOCAL, &sDefault.auth_users, NULL, 0},
261 {"secrets file", P_STRING, P_LOCAL, &sDefault.secrets_file,NULL, 0},
262 {"exclude", P_STRING, P_LOCAL, &sDefault.exclude, NULL, 0},
263 {"exclude from", P_STRING, P_LOCAL, &sDefault.exclude_from,NULL, 0},
264 {"transfer logging", P_BOOL, P_LOCAL, &sDefault.transfer_logging,NULL,0},
265 {"log format", P_STRING, P_LOCAL, &sDefault.log_format, NULL, 0},
266 {"refuse options", P_STRING, P_LOCAL, &sDefault.refuse_options,NULL, 0},
267 {NULL, P_BOOL, P_NONE, NULL, NULL, 0}
271 /***************************************************************************
272 Initialise the global parameter structure.
273 ***************************************************************************/
274 static void init_globals(void)
276 memset(&Globals, 0, sizeof(Globals));
278 Globals.syslog_facility = LOG_DAEMON;
280 Globals.lock_file = "/var/run/rsyncd.lock";
283 /***************************************************************************
284 Initialise the sDefault parameter structure.
285 ***************************************************************************/
286 static void init_locals(void)
292 In this section all the functions that are used to access the
293 parameters from the rest of the program are defined
296 #define FN_GLOBAL_STRING(fn_name,ptr) \
297 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
298 #define FN_GLOBAL_BOOL(fn_name,ptr) \
299 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
300 #define FN_GLOBAL_CHAR(fn_name,ptr) \
301 char fn_name(void) {return(*(char *)(ptr));}
302 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
303 int fn_name(void) {return(*(int *)(ptr));}
305 #define FN_LOCAL_STRING(fn_name,val) \
306 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
307 #define FN_LOCAL_BOOL(fn_name,val) \
308 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
309 #define FN_LOCAL_CHAR(fn_name,val) \
310 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
311 #define FN_LOCAL_INTEGER(fn_name,val) \
312 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
315 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
316 FN_GLOBAL_STRING(lp_lock_file, &Globals.lock_file)
317 FN_GLOBAL_STRING(lp_log_file, &Globals.log_file)
318 FN_GLOBAL_STRING(lp_pid_file, &Globals.pid_file)
319 FN_GLOBAL_STRING(lp_socket_options, &Globals.socket_options)
320 FN_GLOBAL_INTEGER(lp_max_connections, &Globals.max_connections)
321 FN_GLOBAL_INTEGER(lp_syslog_facility, &Globals.syslog_facility)
323 FN_LOCAL_STRING(lp_name, name)
324 FN_LOCAL_STRING(lp_comment, comment)
325 FN_LOCAL_STRING(lp_path, path)
326 FN_LOCAL_BOOL(lp_read_only, read_only)
327 FN_LOCAL_BOOL(lp_list, list)
328 FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
329 FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
330 FN_LOCAL_STRING(lp_uid, uid)
331 FN_LOCAL_STRING(lp_gid, gid)
332 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
333 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
334 FN_LOCAL_STRING(lp_auth_users, auth_users)
335 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
336 FN_LOCAL_STRING(lp_exclude, exclude)
337 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
338 FN_LOCAL_STRING(lp_log_format, log_format)
339 FN_LOCAL_STRING(lp_refuse_options, refuse_options)
340 FN_LOCAL_INTEGER(lp_timeout, timeout)
342 /* local prototypes */
343 static int strwicmp( char *psz1, char *psz2 );
344 static int map_parameter( char *parmname);
345 static BOOL set_boolean( BOOL *pb, char *parmvalue );
346 static int getservicebyname(char *name, service *pserviceDest);
347 static void copy_service( service *pserviceDest,
348 service *pserviceSource);
349 static BOOL do_parameter(char *parmname, char *parmvalue);
350 static BOOL do_section(char *sectionname);
353 /***************************************************************************
354 initialise a service to the defaults
355 ***************************************************************************/
356 static void init_service(service *pservice)
358 memset((char *)pservice,0,sizeof(service));
359 copy_service(pservice,&sDefault);
362 static void string_set(char **s, char *v)
369 if (!*s) exit_cleanup(RERR_MALLOC);
373 /***************************************************************************
374 add a new service to the services array initialising it with the given
376 ***************************************************************************/
377 static int add_a_service(service *pservice, char *name)
381 int num_to_alloc = iNumServices+1;
383 tservice = *pservice;
385 /* it might already exist */
388 i = getservicebyname(name,NULL);
395 ServicePtrs = (service **)Realloc(ServicePtrs,sizeof(service *)*num_to_alloc);
398 pSERVICE(iNumServices) = (service *)malloc(sizeof(service));
400 if (!ServicePtrs || !pSERVICE(iNumServices))
405 init_service(pSERVICE(i));
406 copy_service(pSERVICE(i),&tservice);
408 string_set(&iSERVICE(i).name,name);
413 /***************************************************************************
414 Do a case-insensitive, whitespace-ignoring string compare.
415 ***************************************************************************/
416 static int strwicmp(char *psz1, char *psz2)
418 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
419 /* appropriate value. */
429 /* sync the strings on first non-whitespace */
432 while (isspace(*psz1))
434 while (isspace(*psz2))
436 if (toupper(*psz1) != toupper(*psz2) || *psz1 == '\0' || *psz2 == '\0')
441 return (*psz1 - *psz2);
444 /***************************************************************************
445 Map a parameter's string representation to something we can use.
446 Returns False if the parameter string is not recognised, else TRUE.
447 ***************************************************************************/
448 static int map_parameter(char *parmname)
452 if (*parmname == '-')
455 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
456 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
459 rprintf(FERROR, "Unknown parameter encountered: \"%s\"\n", parmname);
464 /***************************************************************************
465 Set a boolean variable from the text value stored in the passed string.
466 Returns True in success, False if the passed string does not correctly
468 ***************************************************************************/
469 static BOOL set_boolean(BOOL *pb, char *parmvalue)
474 if (strwicmp(parmvalue, "yes") == 0 ||
475 strwicmp(parmvalue, "true") == 0 ||
476 strwicmp(parmvalue, "1") == 0)
479 if (strwicmp(parmvalue, "no") == 0 ||
480 strwicmp(parmvalue, "False") == 0 ||
481 strwicmp(parmvalue, "0") == 0)
485 rprintf(FERROR, "Badly formed boolean in configuration file: \"%s\".\n",
492 /***************************************************************************
493 Find a service by name. Otherwise works like get_service.
494 ***************************************************************************/
495 static int getservicebyname(char *name, service *pserviceDest)
499 for (iService = iNumServices - 1; iService >= 0; iService--)
500 if (strwicmp(iSERVICE(iService).name, name) == 0)
502 if (pserviceDest != NULL)
503 copy_service(pserviceDest, pSERVICE(iService));
512 /***************************************************************************
513 Copy a service structure to another
515 ***************************************************************************/
516 static void copy_service(service *pserviceDest,
517 service *pserviceSource)
521 for (i=0;parm_table[i].label;i++)
522 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
523 void *def_ptr = parm_table[i].ptr;
525 ((char *)pserviceSource) + PTR_DIFF(def_ptr,&sDefault);
527 ((char *)pserviceDest) + PTR_DIFF(def_ptr,&sDefault);
529 switch (parm_table[i].type)
533 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
539 *(int *)dest_ptr = *(int *)src_ptr;
543 *(char *)dest_ptr = *(char *)src_ptr;
547 string_set(dest_ptr,*(char **)src_ptr);
557 /***************************************************************************
558 Process a parameter for a particular service number. If snum < 0
559 then assume we are in the globals
560 ***************************************************************************/
561 static BOOL lp_do_parameter(int snum, char *parmname, char *parmvalue)
564 void *parm_ptr=NULL; /* where we are going to store the result */
567 parmnum = map_parameter(parmname);
571 rprintf(FERROR, "Ignoring unknown parameter \"%s\"\n", parmname);
575 def_ptr = parm_table[parmnum].ptr;
577 /* we might point at a service, the default service or a global */
581 if (parm_table[parmnum].class == P_GLOBAL) {
582 rprintf(FERROR, "Global parameter %s found in service section!\n",parmname);
585 parm_ptr = ((char *)pSERVICE(snum)) + PTR_DIFF(def_ptr,&sDefault);
588 /* now switch on the type of variable it is */
589 switch (parm_table[parmnum].type)
592 set_boolean(parm_ptr,parmvalue);
596 set_boolean(parm_ptr,parmvalue);
597 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
601 *(int *)parm_ptr = atoi(parmvalue);
605 *(char *)parm_ptr = *parmvalue;
609 sscanf(parmvalue,"%o",(int *)parm_ptr);
613 string_set(parm_ptr,parmvalue);
617 strlcpy((char *)parm_ptr,parmvalue,sizeof(pstring));
621 for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
622 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
623 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
627 if (!parm_table[parmnum].enum_list[i].name) {
628 if (atoi(parmvalue) > 0)
629 *(int *)parm_ptr = atoi(parmvalue);
639 /***************************************************************************
641 ***************************************************************************/
642 static BOOL do_parameter(char *parmname, char *parmvalue)
644 return lp_do_parameter(bInGlobalSection?-2:iServiceIndex, parmname, parmvalue);
647 /***************************************************************************
648 Process a new section (service). At this stage all sections are services.
649 Later we'll have special sections that permit server parameters to be set.
650 Returns True on success, False on failure.
651 ***************************************************************************/
652 static BOOL do_section(char *sectionname)
655 BOOL isglobal = (strwicmp(sectionname, GLOBAL_NAME) == 0);
658 /* if we were in a global section then do the local inits */
659 if (bInGlobalSection && !isglobal)
662 /* if we've just struck a global section, note the fact. */
663 bInGlobalSection = isglobal;
665 /* check for multiple global sections */
666 if (bInGlobalSection)
671 /* if we have a current service, tidy it up before moving on */
674 if (iServiceIndex >= 0)
677 /* if all is still well, move to the next record in the services array */
680 /* We put this here to avoid an odd message order if messages are */
681 /* issued by the post-processing of a previous section. */
683 if ((iServiceIndex=add_a_service(&sDefault,sectionname)) < 0)
685 rprintf(FERROR,"Failed to add a new service\n");
694 /***************************************************************************
695 Load the services array from the services file. Return True on success,
697 ***************************************************************************/
698 BOOL lp_load(char *pszFname, int globals_only)
705 bInGlobalSection = True;
709 pstrcpy(n2,pszFname);
711 /* We get sections first, so have to start 'behind' to make up */
713 bRetval = pm_process(n2, globals_only?NULL:do_section, do_parameter);
721 /***************************************************************************
722 return the max number of services
723 ***************************************************************************/
724 int lp_numservices(void)
726 return(iNumServices);
729 /***************************************************************************
730 Return the number of the service with the given name, or -1 if it doesn't
731 exist. Note that this is a DIFFERENT ANIMAL from the internal function
732 getservicebyname()! This works ONLY if all services have been loaded, and
733 does not copy the found service.
734 ***************************************************************************/
735 int lp_number(char *name)
739 for (iService = iNumServices - 1; iService >= 0; iService--)
740 if (strequal(lp_name(iService), name))