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;
139 /* This is a default service used to prime a services structure */
140 static service sDefault =
145 True, /* read only */
147 True, /* use chroot */
148 False, /* transfer logging */
151 NULL, /* hosts allow */
152 NULL, /* hosts deny */
153 NULL, /* auth users */
154 NULL, /* secrets file */
156 NULL, /* exclude from */
157 "%o %h [%a] %m (%u) %f %l", /* log format */
158 NULL, /* refuse options */
159 "*.gz *.tgz *.zip *.z *.rpm *.deb", /* dont compress */
165 /* local variables */
166 static service **ServicePtrs = NULL;
167 static int iNumServices = 0;
168 static int iServiceIndex = 0;
169 static BOOL bInGlobalSection = True;
171 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
173 static struct enum_list enum_facilities[] = {
175 { LOG_AUTH, "auth" },
178 { LOG_AUTHPRIV, "authpriv" },
181 { LOG_CRON, "cron" },
184 { LOG_DAEMON, "daemon" },
190 { LOG_KERN, "kern" },
196 { LOG_MAIL, "mail" },
199 { LOG_NEWS, "news" },
202 { LOG_AUTH, "security" },
205 { LOG_SYSLOG, "syslog" },
208 { LOG_USER, "user" },
211 { LOG_UUCP, "uucp" },
214 { LOG_LOCAL0, "local0" },
217 { LOG_LOCAL1, "local1" },
220 { LOG_LOCAL2, "local2" },
223 { LOG_LOCAL3, "local3" },
226 { LOG_LOCAL4, "local4" },
229 { LOG_LOCAL5, "local5" },
232 { LOG_LOCAL6, "local6" },
235 { LOG_LOCAL7, "local7" },
240 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
241 static struct parm_struct parm_table[] =
243 {"max connections", P_INTEGER, P_GLOBAL, &Globals.max_connections,NULL, 0},
244 {"motd file", P_STRING, P_GLOBAL, &Globals.motd_file, NULL, 0},
245 {"lock file", P_STRING, P_GLOBAL, &Globals.lock_file, NULL, 0},
246 {"syslog facility", P_ENUM, P_GLOBAL, &Globals.syslog_facility, enum_facilities,0},
247 {"socket options", P_STRING, P_GLOBAL, &Globals.socket_options,NULL, 0},
248 {"log file", P_STRING, P_GLOBAL, &Globals.log_file, NULL, 0},
249 {"pid file", P_STRING, P_GLOBAL, &Globals.pid_file, NULL, 0},
251 {"timeout", P_INTEGER, P_LOCAL, &sDefault.timeout, NULL, 0},
252 {"name", P_STRING, P_LOCAL, &sDefault.name, NULL, 0},
253 {"comment", P_STRING, P_LOCAL, &sDefault.comment, NULL, 0},
254 {"path", P_STRING, P_LOCAL, &sDefault.path, NULL, 0},
255 {"read only", P_BOOL, P_LOCAL, &sDefault.read_only, NULL, 0},
256 {"list", P_BOOL, P_LOCAL, &sDefault.list, NULL, 0},
257 {"use chroot", P_BOOL, P_LOCAL, &sDefault.use_chroot, NULL, 0},
258 {"uid", P_STRING, P_LOCAL, &sDefault.uid, NULL, 0},
259 {"gid", P_STRING, P_LOCAL, &sDefault.gid, NULL, 0},
260 {"hosts allow", P_STRING, P_LOCAL, &sDefault.hosts_allow, NULL, 0},
261 {"hosts deny", P_STRING, P_LOCAL, &sDefault.hosts_deny, NULL, 0},
262 {"auth users", P_STRING, P_LOCAL, &sDefault.auth_users, NULL, 0},
263 {"secrets file", P_STRING, P_LOCAL, &sDefault.secrets_file,NULL, 0},
264 {"exclude", P_STRING, P_LOCAL, &sDefault.exclude, NULL, 0},
265 {"exclude from", P_STRING, P_LOCAL, &sDefault.exclude_from,NULL, 0},
266 {"transfer logging", P_BOOL, P_LOCAL, &sDefault.transfer_logging,NULL,0},
267 {"log format", P_STRING, P_LOCAL, &sDefault.log_format, NULL, 0},
268 {"refuse options", P_STRING, P_LOCAL, &sDefault.refuse_options,NULL, 0},
269 {"dont compress", P_STRING, P_LOCAL, &sDefault.dont_compress,NULL, 0},
270 {NULL, P_BOOL, P_NONE, NULL, NULL, 0}
274 /***************************************************************************
275 Initialise the global parameter structure.
276 ***************************************************************************/
277 static void init_globals(void)
279 memset(&Globals, 0, sizeof(Globals));
281 Globals.syslog_facility = LOG_DAEMON;
283 Globals.lock_file = "/var/run/rsyncd.lock";
286 /***************************************************************************
287 Initialise the sDefault parameter structure.
288 ***************************************************************************/
289 static void init_locals(void)
295 In this section all the functions that are used to access the
296 parameters from the rest of the program are defined
299 #define FN_GLOBAL_STRING(fn_name,ptr) \
300 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
301 #define FN_GLOBAL_BOOL(fn_name,ptr) \
302 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
303 #define FN_GLOBAL_CHAR(fn_name,ptr) \
304 char fn_name(void) {return(*(char *)(ptr));}
305 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
306 int fn_name(void) {return(*(int *)(ptr));}
308 #define FN_LOCAL_STRING(fn_name,val) \
309 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
310 #define FN_LOCAL_BOOL(fn_name,val) \
311 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
312 #define FN_LOCAL_CHAR(fn_name,val) \
313 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
314 #define FN_LOCAL_INTEGER(fn_name,val) \
315 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
318 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
319 FN_GLOBAL_STRING(lp_lock_file, &Globals.lock_file)
320 FN_GLOBAL_STRING(lp_log_file, &Globals.log_file)
321 FN_GLOBAL_STRING(lp_pid_file, &Globals.pid_file)
322 FN_GLOBAL_STRING(lp_socket_options, &Globals.socket_options)
323 FN_GLOBAL_INTEGER(lp_max_connections, &Globals.max_connections)
324 FN_GLOBAL_INTEGER(lp_syslog_facility, &Globals.syslog_facility)
326 FN_LOCAL_STRING(lp_name, name)
327 FN_LOCAL_STRING(lp_comment, comment)
328 FN_LOCAL_STRING(lp_path, path)
329 FN_LOCAL_BOOL(lp_read_only, read_only)
330 FN_LOCAL_BOOL(lp_list, list)
331 FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
332 FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
333 FN_LOCAL_STRING(lp_uid, uid)
334 FN_LOCAL_STRING(lp_gid, gid)
335 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
336 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
337 FN_LOCAL_STRING(lp_auth_users, auth_users)
338 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
339 FN_LOCAL_STRING(lp_exclude, exclude)
340 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
341 FN_LOCAL_STRING(lp_log_format, log_format)
342 FN_LOCAL_STRING(lp_refuse_options, refuse_options)
343 FN_LOCAL_STRING(lp_dont_compress, dont_compress)
344 FN_LOCAL_INTEGER(lp_timeout, timeout)
346 /* local prototypes */
347 static int strwicmp( char *psz1, char *psz2 );
348 static int map_parameter( char *parmname);
349 static BOOL set_boolean( BOOL *pb, char *parmvalue );
350 static int getservicebyname(char *name, service *pserviceDest);
351 static void copy_service( service *pserviceDest,
352 service *pserviceSource);
353 static BOOL do_parameter(char *parmname, char *parmvalue);
354 static BOOL do_section(char *sectionname);
357 /***************************************************************************
358 initialise a service to the defaults
359 ***************************************************************************/
360 static void init_service(service *pservice)
362 memset((char *)pservice,0,sizeof(service));
363 copy_service(pservice,&sDefault);
366 static void string_set(char **s, char *v)
373 if (!*s) exit_cleanup(RERR_MALLOC);
377 /***************************************************************************
378 add a new service to the services array initialising it with the given
380 ***************************************************************************/
381 static int add_a_service(service *pservice, char *name)
385 int num_to_alloc = iNumServices+1;
387 tservice = *pservice;
389 /* it might already exist */
392 i = getservicebyname(name,NULL);
399 ServicePtrs = (service **)Realloc(ServicePtrs,sizeof(service *)*num_to_alloc);
402 pSERVICE(iNumServices) = (service *)malloc(sizeof(service));
404 if (!ServicePtrs || !pSERVICE(iNumServices))
409 init_service(pSERVICE(i));
410 copy_service(pSERVICE(i),&tservice);
412 string_set(&iSERVICE(i).name,name);
417 /***************************************************************************
418 Do a case-insensitive, whitespace-ignoring string compare.
419 ***************************************************************************/
420 static int strwicmp(char *psz1, char *psz2)
422 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
423 /* appropriate value. */
433 /* sync the strings on first non-whitespace */
436 while (isspace(*psz1))
438 while (isspace(*psz2))
440 if (toupper(*psz1) != toupper(*psz2) || *psz1 == '\0' || *psz2 == '\0')
445 return (*psz1 - *psz2);
448 /***************************************************************************
449 Map a parameter's string representation to something we can use.
450 Returns False if the parameter string is not recognised, else TRUE.
451 ***************************************************************************/
452 static int map_parameter(char *parmname)
456 if (*parmname == '-')
459 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
460 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
463 rprintf(FERROR, "Unknown parameter encountered: \"%s\"\n", parmname);
468 /***************************************************************************
469 Set a boolean variable from the text value stored in the passed string.
470 Returns True in success, False if the passed string does not correctly
472 ***************************************************************************/
473 static BOOL set_boolean(BOOL *pb, char *parmvalue)
478 if (strwicmp(parmvalue, "yes") == 0 ||
479 strwicmp(parmvalue, "true") == 0 ||
480 strwicmp(parmvalue, "1") == 0)
483 if (strwicmp(parmvalue, "no") == 0 ||
484 strwicmp(parmvalue, "False") == 0 ||
485 strwicmp(parmvalue, "0") == 0)
489 rprintf(FERROR, "Badly formed boolean in configuration file: \"%s\".\n",
496 /***************************************************************************
497 Find a service by name. Otherwise works like get_service.
498 ***************************************************************************/
499 static int getservicebyname(char *name, service *pserviceDest)
503 for (iService = iNumServices - 1; iService >= 0; iService--)
504 if (strwicmp(iSERVICE(iService).name, name) == 0)
506 if (pserviceDest != NULL)
507 copy_service(pserviceDest, pSERVICE(iService));
516 /***************************************************************************
517 Copy a service structure to another
519 ***************************************************************************/
520 static void copy_service(service *pserviceDest,
521 service *pserviceSource)
525 for (i=0;parm_table[i].label;i++)
526 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
527 void *def_ptr = parm_table[i].ptr;
529 ((char *)pserviceSource) + PTR_DIFF(def_ptr,&sDefault);
531 ((char *)pserviceDest) + PTR_DIFF(def_ptr,&sDefault);
533 switch (parm_table[i].type)
537 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
543 *(int *)dest_ptr = *(int *)src_ptr;
547 *(char *)dest_ptr = *(char *)src_ptr;
551 string_set(dest_ptr,*(char **)src_ptr);
561 /***************************************************************************
562 Process a parameter for a particular service number. If snum < 0
563 then assume we are in the globals
564 ***************************************************************************/
565 static BOOL lp_do_parameter(int snum, char *parmname, char *parmvalue)
568 void *parm_ptr=NULL; /* where we are going to store the result */
571 parmnum = map_parameter(parmname);
575 rprintf(FERROR, "Ignoring unknown parameter \"%s\"\n", parmname);
579 def_ptr = parm_table[parmnum].ptr;
581 /* we might point at a service, the default service or a global */
585 if (parm_table[parmnum].class == P_GLOBAL) {
586 rprintf(FERROR, "Global parameter %s found in service section!\n",parmname);
589 parm_ptr = ((char *)pSERVICE(snum)) + PTR_DIFF(def_ptr,&sDefault);
592 /* now switch on the type of variable it is */
593 switch (parm_table[parmnum].type)
596 set_boolean(parm_ptr,parmvalue);
600 set_boolean(parm_ptr,parmvalue);
601 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
605 *(int *)parm_ptr = atoi(parmvalue);
609 *(char *)parm_ptr = *parmvalue;
613 sscanf(parmvalue,"%o",(int *)parm_ptr);
617 string_set(parm_ptr,parmvalue);
621 strlcpy((char *)parm_ptr,parmvalue,sizeof(pstring));
625 for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
626 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
627 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
631 if (!parm_table[parmnum].enum_list[i].name) {
632 if (atoi(parmvalue) > 0)
633 *(int *)parm_ptr = atoi(parmvalue);
643 /***************************************************************************
645 ***************************************************************************/
646 static BOOL do_parameter(char *parmname, char *parmvalue)
648 return lp_do_parameter(bInGlobalSection?-2:iServiceIndex, parmname, parmvalue);
651 /***************************************************************************
652 Process a new section (service). At this stage all sections are services.
653 Later we'll have special sections that permit server parameters to be set.
654 Returns True on success, False on failure.
655 ***************************************************************************/
656 static BOOL do_section(char *sectionname)
659 BOOL isglobal = (strwicmp(sectionname, GLOBAL_NAME) == 0);
662 /* if we were in a global section then do the local inits */
663 if (bInGlobalSection && !isglobal)
666 /* if we've just struck a global section, note the fact. */
667 bInGlobalSection = isglobal;
669 /* check for multiple global sections */
670 if (bInGlobalSection)
675 /* if we have a current service, tidy it up before moving on */
678 if (iServiceIndex >= 0)
681 /* if all is still well, move to the next record in the services array */
684 /* We put this here to avoid an odd message order if messages are */
685 /* issued by the post-processing of a previous section. */
687 if ((iServiceIndex=add_a_service(&sDefault,sectionname)) < 0)
689 rprintf(FERROR,"Failed to add a new service\n");
698 /***************************************************************************
699 Load the services array from the services file. Return True on success,
701 ***************************************************************************/
702 BOOL lp_load(char *pszFname, int globals_only)
709 bInGlobalSection = True;
713 pstrcpy(n2,pszFname);
715 /* We get sections first, so have to start 'behind' to make up */
717 bRetval = pm_process(n2, globals_only?NULL:do_section, do_parameter);
725 /***************************************************************************
726 return the max number of services
727 ***************************************************************************/
728 int lp_numservices(void)
730 return(iNumServices);
733 /***************************************************************************
734 Return the number of the service with the given name, or -1 if it doesn't
735 exist. Note that this is a DIFFERENT ANIMAL from the internal function
736 getservicebyname()! This works ONLY if all services have been loaded, and
737 does not copy the found service.
738 ***************************************************************************/
739 int lp_number(char *name)
743 for (iService = iNumServices - 1; iService >= 0; iService--)
744 if (strequal(lp_name(iService), name))