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;
135 char *refuse_options;
141 /* This is a default service used to prime a services structure */
142 static service sDefault =
147 True, /* read only */
149 True, /* use chroot */
150 False, /* transfer logging */
153 NULL, /* hosts allow */
154 NULL, /* hosts deny */
155 NULL, /* auth users */
156 NULL, /* secrets file */
158 NULL, /* exclude from */
160 NULL, /* include from */
161 "%o %h [%a] %m (%u) %f %l", /* log format */
162 NULL, /* refuse options */
163 "*.gz *.tgz *.zip *.z *.rpm *.deb", /* dont compress */
169 /* local variables */
170 static service **ServicePtrs = NULL;
171 static int iNumServices = 0;
172 static int iServiceIndex = 0;
173 static BOOL bInGlobalSection = True;
175 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
177 static struct enum_list enum_facilities[] = {
179 { LOG_AUTH, "auth" },
182 { LOG_AUTHPRIV, "authpriv" },
185 { LOG_CRON, "cron" },
188 { LOG_DAEMON, "daemon" },
194 { LOG_KERN, "kern" },
200 { LOG_MAIL, "mail" },
203 { LOG_NEWS, "news" },
206 { LOG_AUTH, "security" },
209 { LOG_SYSLOG, "syslog" },
212 { LOG_USER, "user" },
215 { LOG_UUCP, "uucp" },
218 { LOG_LOCAL0, "local0" },
221 { LOG_LOCAL1, "local1" },
224 { LOG_LOCAL2, "local2" },
227 { LOG_LOCAL3, "local3" },
230 { LOG_LOCAL4, "local4" },
233 { LOG_LOCAL5, "local5" },
236 { LOG_LOCAL6, "local6" },
239 { LOG_LOCAL7, "local7" },
244 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
245 static struct parm_struct parm_table[] =
247 {"max connections", P_INTEGER, P_GLOBAL, &Globals.max_connections,NULL, 0},
248 {"motd file", P_STRING, P_GLOBAL, &Globals.motd_file, NULL, 0},
249 {"lock file", P_STRING, P_GLOBAL, &Globals.lock_file, NULL, 0},
250 {"syslog facility", P_ENUM, P_GLOBAL, &Globals.syslog_facility, enum_facilities,0},
251 {"socket options", P_STRING, P_GLOBAL, &Globals.socket_options,NULL, 0},
252 {"log file", P_STRING, P_GLOBAL, &Globals.log_file, NULL, 0},
253 {"pid file", P_STRING, P_GLOBAL, &Globals.pid_file, NULL, 0},
255 {"timeout", P_INTEGER, P_LOCAL, &sDefault.timeout, NULL, 0},
256 {"name", P_STRING, P_LOCAL, &sDefault.name, NULL, 0},
257 {"comment", P_STRING, P_LOCAL, &sDefault.comment, NULL, 0},
258 {"path", P_STRING, P_LOCAL, &sDefault.path, NULL, 0},
259 {"read only", P_BOOL, P_LOCAL, &sDefault.read_only, NULL, 0},
260 {"list", P_BOOL, P_LOCAL, &sDefault.list, NULL, 0},
261 {"use chroot", P_BOOL, P_LOCAL, &sDefault.use_chroot, NULL, 0},
262 {"uid", P_STRING, P_LOCAL, &sDefault.uid, NULL, 0},
263 {"gid", P_STRING, P_LOCAL, &sDefault.gid, NULL, 0},
264 {"hosts allow", P_STRING, P_LOCAL, &sDefault.hosts_allow, NULL, 0},
265 {"hosts deny", P_STRING, P_LOCAL, &sDefault.hosts_deny, NULL, 0},
266 {"auth users", P_STRING, P_LOCAL, &sDefault.auth_users, NULL, 0},
267 {"secrets file", P_STRING, P_LOCAL, &sDefault.secrets_file,NULL, 0},
268 {"exclude", P_STRING, P_LOCAL, &sDefault.exclude, NULL, 0},
269 {"exclude from", P_STRING, P_LOCAL, &sDefault.exclude_from,NULL, 0},
270 {"include", P_STRING, P_LOCAL, &sDefault.include, NULL, 0},
271 {"include from", P_STRING, P_LOCAL, &sDefault.include_from,NULL, 0},
272 {"transfer logging", P_BOOL, P_LOCAL, &sDefault.transfer_logging,NULL,0},
273 {"log format", P_STRING, P_LOCAL, &sDefault.log_format, NULL, 0},
274 {"refuse options", P_STRING, P_LOCAL, &sDefault.refuse_options,NULL, 0},
275 {"dont compress", P_STRING, P_LOCAL, &sDefault.dont_compress,NULL, 0},
276 {NULL, P_BOOL, P_NONE, NULL, NULL, 0}
280 /***************************************************************************
281 Initialise the global parameter structure.
282 ***************************************************************************/
283 static void init_globals(void)
285 memset(&Globals, 0, sizeof(Globals));
287 Globals.syslog_facility = LOG_DAEMON;
289 Globals.lock_file = "/var/run/rsyncd.lock";
292 /***************************************************************************
293 Initialise the sDefault parameter structure.
294 ***************************************************************************/
295 static void init_locals(void)
301 In this section all the functions that are used to access the
302 parameters from the rest of the program are defined
305 #define FN_GLOBAL_STRING(fn_name,ptr) \
306 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
307 #define FN_GLOBAL_BOOL(fn_name,ptr) \
308 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
309 #define FN_GLOBAL_CHAR(fn_name,ptr) \
310 char fn_name(void) {return(*(char *)(ptr));}
311 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
312 int fn_name(void) {return(*(int *)(ptr));}
314 #define FN_LOCAL_STRING(fn_name,val) \
315 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
316 #define FN_LOCAL_BOOL(fn_name,val) \
317 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
318 #define FN_LOCAL_CHAR(fn_name,val) \
319 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
320 #define FN_LOCAL_INTEGER(fn_name,val) \
321 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
324 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
325 FN_GLOBAL_STRING(lp_lock_file, &Globals.lock_file)
326 FN_GLOBAL_STRING(lp_log_file, &Globals.log_file)
327 FN_GLOBAL_STRING(lp_pid_file, &Globals.pid_file)
328 FN_GLOBAL_STRING(lp_socket_options, &Globals.socket_options)
329 FN_GLOBAL_INTEGER(lp_max_connections, &Globals.max_connections)
330 FN_GLOBAL_INTEGER(lp_syslog_facility, &Globals.syslog_facility)
332 FN_LOCAL_STRING(lp_name, name)
333 FN_LOCAL_STRING(lp_comment, comment)
334 FN_LOCAL_STRING(lp_path, path)
335 FN_LOCAL_BOOL(lp_read_only, read_only)
336 FN_LOCAL_BOOL(lp_list, list)
337 FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
338 FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
339 FN_LOCAL_STRING(lp_uid, uid)
340 FN_LOCAL_STRING(lp_gid, gid)
341 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
342 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
343 FN_LOCAL_STRING(lp_auth_users, auth_users)
344 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
345 FN_LOCAL_STRING(lp_exclude, exclude)
346 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
347 FN_LOCAL_STRING(lp_include, include)
348 FN_LOCAL_STRING(lp_include_from, include_from)
349 FN_LOCAL_STRING(lp_log_format, log_format)
350 FN_LOCAL_STRING(lp_refuse_options, refuse_options)
351 FN_LOCAL_STRING(lp_dont_compress, dont_compress)
352 FN_LOCAL_INTEGER(lp_timeout, timeout)
354 /* local prototypes */
355 static int strwicmp( char *psz1, char *psz2 );
356 static int map_parameter( char *parmname);
357 static BOOL set_boolean( BOOL *pb, char *parmvalue );
358 static int getservicebyname(char *name, service *pserviceDest);
359 static void copy_service( service *pserviceDest,
360 service *pserviceSource);
361 static BOOL do_parameter(char *parmname, char *parmvalue);
362 static BOOL do_section(char *sectionname);
365 /***************************************************************************
366 initialise a service to the defaults
367 ***************************************************************************/
368 static void init_service(service *pservice)
370 memset((char *)pservice,0,sizeof(service));
371 copy_service(pservice,&sDefault);
374 static void string_set(char **s, char *v)
381 if (!*s) exit_cleanup(RERR_MALLOC);
385 /***************************************************************************
386 add a new service to the services array initialising it with the given
388 ***************************************************************************/
389 static int add_a_service(service *pservice, char *name)
393 int num_to_alloc = iNumServices+1;
395 tservice = *pservice;
397 /* it might already exist */
400 i = getservicebyname(name,NULL);
407 ServicePtrs = (service **)Realloc(ServicePtrs,sizeof(service *)*num_to_alloc);
410 pSERVICE(iNumServices) = (service *)malloc(sizeof(service));
412 if (!ServicePtrs || !pSERVICE(iNumServices))
417 init_service(pSERVICE(i));
418 copy_service(pSERVICE(i),&tservice);
420 string_set(&iSERVICE(i).name,name);
425 /***************************************************************************
426 Do a case-insensitive, whitespace-ignoring string compare.
427 ***************************************************************************/
428 static int strwicmp(char *psz1, char *psz2)
430 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
431 /* appropriate value. */
441 /* sync the strings on first non-whitespace */
444 while (isspace(*psz1))
446 while (isspace(*psz2))
448 if (toupper(*psz1) != toupper(*psz2) || *psz1 == '\0' || *psz2 == '\0')
453 return (*psz1 - *psz2);
456 /***************************************************************************
457 Map a parameter's string representation to something we can use.
458 Returns False if the parameter string is not recognised, else TRUE.
459 ***************************************************************************/
460 static int map_parameter(char *parmname)
464 if (*parmname == '-')
467 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
468 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
471 rprintf(FERROR, "Unknown Parameter encountered: \"%s\"\n", parmname);
476 /***************************************************************************
477 Set a boolean variable from the text value stored in the passed string.
478 Returns True in success, False if the passed string does not correctly
480 ***************************************************************************/
481 static BOOL set_boolean(BOOL *pb, char *parmvalue)
486 if (strwicmp(parmvalue, "yes") == 0 ||
487 strwicmp(parmvalue, "true") == 0 ||
488 strwicmp(parmvalue, "1") == 0)
491 if (strwicmp(parmvalue, "no") == 0 ||
492 strwicmp(parmvalue, "False") == 0 ||
493 strwicmp(parmvalue, "0") == 0)
497 rprintf(FERROR, "Badly formed boolean in configuration file: \"%s\".\n",
504 /***************************************************************************
505 Find a service by name. Otherwise works like get_service.
506 ***************************************************************************/
507 static int getservicebyname(char *name, service *pserviceDest)
511 for (iService = iNumServices - 1; iService >= 0; iService--)
512 if (strwicmp(iSERVICE(iService).name, name) == 0)
514 if (pserviceDest != NULL)
515 copy_service(pserviceDest, pSERVICE(iService));
524 /***************************************************************************
525 Copy a service structure to another
527 ***************************************************************************/
528 static void copy_service(service *pserviceDest,
529 service *pserviceSource)
533 for (i=0;parm_table[i].label;i++)
534 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
535 void *def_ptr = parm_table[i].ptr;
537 ((char *)pserviceSource) + PTR_DIFF(def_ptr,&sDefault);
539 ((char *)pserviceDest) + PTR_DIFF(def_ptr,&sDefault);
541 switch (parm_table[i].type)
545 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
551 *(int *)dest_ptr = *(int *)src_ptr;
555 *(char *)dest_ptr = *(char *)src_ptr;
559 string_set(dest_ptr,*(char **)src_ptr);
569 /***************************************************************************
570 Process a parameter for a particular service number. If snum < 0
571 then assume we are in the globals
572 ***************************************************************************/
573 static BOOL lp_do_parameter(int snum, char *parmname, char *parmvalue)
576 void *parm_ptr=NULL; /* where we are going to store the result */
579 parmnum = map_parameter(parmname);
583 rprintf(FERROR, "IGNORING unknown parameter \"%s\"\n", parmname);
587 def_ptr = parm_table[parmnum].ptr;
589 /* we might point at a service, the default service or a global */
593 if (parm_table[parmnum].class == P_GLOBAL) {
594 rprintf(FERROR, "Global parameter %s found in service section!\n",parmname);
597 parm_ptr = ((char *)pSERVICE(snum)) + PTR_DIFF(def_ptr,&sDefault);
600 /* now switch on the type of variable it is */
601 switch (parm_table[parmnum].type)
604 set_boolean(parm_ptr,parmvalue);
608 set_boolean(parm_ptr,parmvalue);
609 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
613 *(int *)parm_ptr = atoi(parmvalue);
617 *(char *)parm_ptr = *parmvalue;
621 sscanf(parmvalue,"%o",(int *)parm_ptr);
625 string_set(parm_ptr,parmvalue);
629 strlcpy((char *)parm_ptr,parmvalue,sizeof(pstring));
633 for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
634 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
635 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
639 if (!parm_table[parmnum].enum_list[i].name) {
640 if (atoi(parmvalue) > 0)
641 *(int *)parm_ptr = atoi(parmvalue);
651 /***************************************************************************
653 ***************************************************************************/
654 static BOOL do_parameter(char *parmname, char *parmvalue)
656 return lp_do_parameter(bInGlobalSection?-2:iServiceIndex, parmname, parmvalue);
659 /***************************************************************************
660 Process a new section (service). At this stage all sections are services.
661 Later we'll have special sections that permit server parameters to be set.
662 Returns True on success, False on failure.
663 ***************************************************************************/
664 static BOOL do_section(char *sectionname)
667 BOOL isglobal = (strwicmp(sectionname, GLOBAL_NAME) == 0);
670 /* if we were in a global section then do the local inits */
671 if (bInGlobalSection && !isglobal)
674 /* if we've just struck a global section, note the fact. */
675 bInGlobalSection = isglobal;
677 /* check for multiple global sections */
678 if (bInGlobalSection)
683 /* if we have a current service, tidy it up before moving on */
686 if (iServiceIndex >= 0)
689 /* if all is still well, move to the next record in the services array */
692 /* We put this here to avoid an odd message order if messages are */
693 /* issued by the post-processing of a previous section. */
695 if ((iServiceIndex=add_a_service(&sDefault,sectionname)) < 0)
697 rprintf(FERROR,"Failed to add a new service\n");
706 /***************************************************************************
707 Load the services array from the services file. Return True on success,
709 ***************************************************************************/
710 BOOL lp_load(char *pszFname, int globals_only)
717 bInGlobalSection = True;
721 pstrcpy(n2,pszFname);
723 /* We get sections first, so have to start 'behind' to make up */
725 bRetval = pm_process(n2, globals_only?NULL:do_section, do_parameter);
733 /***************************************************************************
734 return the max number of services
735 ***************************************************************************/
736 int lp_numservices(void)
738 return(iNumServices);
741 /***************************************************************************
742 Return the number of the service with the given name, or -1 if it doesn't
743 exist. Note that this is a DIFFERENT ANIMAL from the internal function
744 getservicebyname()! This works ONLY if all services have been loaded, and
745 does not copy the found service.
746 ***************************************************************************/
747 int lp_number(char *name)
751 for (iService = iNumServices - 1; iService >= 0; iService--)
752 if (strequal(lp_name(iService), name))