1 /* This is based on loadparm.c from Samba, written by Andrew Tridgell
6 * Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 * This module provides suitable callback functions for the params
29 * module. It builds the internal table of service details which is
30 * then used by the rest of the server.
34 * 1) add it to the global or service structure definition
35 * 2) add it to the parm_table
36 * 3) add it to the list of available functions (eg: using FN_GLOBAL_STRING())
37 * 4) If it's a global then initialise it in init_globals. If a local
38 * (ie. service) parameter then initialise it in the sDefault structure
42 * The configuration file is processed sequentially for speed. It is NOT
43 * accessed randomly as happens in 'real' Windows. For this reason, there
44 * is a fair bit of sequence-dependent code here - ie., code which assumes
45 * that certain things happen before others. In particular, the code which
46 * happens at the boundary between sections is delicately poised, so be
51 /* TODO: Parameter to set debug level on server. */
54 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((char *)(p1)) - (char *)(p2)))
55 #define strequal(a,b) (strcasecmp(a,b)==0)
56 #define BOOLSTR(b) ((b) ? "Yes" : "No")
57 typedef char pstring[1024];
58 #define pstrcpy(a,b) strlcpy(a,b,sizeof(pstring))
60 /* the following are used by loadparm for option lists */
63 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,
64 P_PATH,P_STRING,P_GSTRING,P_ENUM,P_SEP
69 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
83 struct enum_list *enum_list;
88 #define GLOBAL_NAME "global"
91 /* some helpful bits */
92 #define pSERVICE(i) ServicePtrs[i]
93 #define iSERVICE(i) (*pSERVICE(i))
94 #define LP_SNUM_OK(iService) (((iService) >= 0) && ((iService) < iNumServices))
97 * This structure describes global (ie., server-wide) parameters.
104 char *socket_options;
109 static global Globals;
113 * This structure describes a single service.
125 BOOL transfer_logging;
139 char *refuse_options;
143 BOOL ignore_nonreadable;
147 /* This is a default service used to prime a services structure */
148 static service sDefault =
153 DEFAULT_LOCK_FILE, /* lock file */
154 True, /* read only */
155 False, /* write only */
157 True, /* use chroot */
158 False, /* transfer logging */
159 False, /* ignore errors */
162 /* TODO: This causes problems on Debian, where it is called
163 * "nogroup". Debian patch this in their version of the
164 * package, but it would be nice to be consistent. Possibly
165 * other systems are different again.
167 * What is the best behaviour? Perhaps always using (gid_t)
171 NULL, /* hosts allow */
172 NULL, /* hosts deny */
173 NULL, /* auth users */
174 NULL, /* secrets file */
175 True, /* strict modes */
177 NULL, /* exclude from */
179 NULL, /* include from */
180 "%o %h [%a] %m (%u) %f %l", /* log format */
181 NULL, /* refuse options */
182 "*.gz *.tgz *.zip *.z *.rpm *.deb *.iso *.bz2 *.tbz", /* dont compress */
184 0, /* max connections */
185 False /* ignore nonreadable */
190 /* local variables */
191 static service **ServicePtrs = NULL;
192 static int iNumServices = 0;
193 static int iServiceIndex = 0;
194 static BOOL bInGlobalSection = True;
196 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
198 static struct enum_list enum_facilities[] = {
200 { LOG_AUTH, "auth" },
203 { LOG_AUTHPRIV, "authpriv" },
206 { LOG_CRON, "cron" },
209 { LOG_DAEMON, "daemon" },
215 { LOG_KERN, "kern" },
221 { LOG_MAIL, "mail" },
224 { LOG_NEWS, "news" },
227 { LOG_AUTH, "security" },
230 { LOG_SYSLOG, "syslog" },
233 { LOG_USER, "user" },
236 { LOG_UUCP, "uucp" },
239 { LOG_LOCAL0, "local0" },
242 { LOG_LOCAL1, "local1" },
245 { LOG_LOCAL2, "local2" },
248 { LOG_LOCAL3, "local3" },
251 { LOG_LOCAL4, "local4" },
254 { LOG_LOCAL5, "local5" },
257 { LOG_LOCAL6, "local6" },
260 { LOG_LOCAL7, "local7" },
265 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
266 static struct parm_struct parm_table[] =
268 {"motd file", P_STRING, P_GLOBAL, &Globals.motd_file, NULL, 0},
269 {"syslog facility", P_ENUM, P_GLOBAL, &Globals.syslog_facility, enum_facilities,0},
270 {"socket options", P_STRING, P_GLOBAL, &Globals.socket_options,NULL, 0},
271 {"log file", P_STRING, P_GLOBAL, &Globals.log_file, NULL, 0},
272 {"pid file", P_STRING, P_GLOBAL, &Globals.pid_file, NULL, 0},
273 {"max verbosity", P_INTEGER, P_GLOBAL, &Globals.max_verbosity, NULL, 0},
275 {"timeout", P_INTEGER, P_LOCAL, &sDefault.timeout, NULL, 0},
276 {"max connections", P_INTEGER, P_LOCAL, &sDefault.max_connections,NULL, 0},
277 {"name", P_STRING, P_LOCAL, &sDefault.name, NULL, 0},
278 {"comment", P_STRING, P_LOCAL, &sDefault.comment, NULL, 0},
279 {"lock file", P_STRING, P_LOCAL, &sDefault.lock_file, NULL, 0},
280 {"path", P_PATH, P_LOCAL, &sDefault.path, NULL, 0},
281 {"read only", P_BOOL, P_LOCAL, &sDefault.read_only, NULL, 0},
282 {"write only", P_BOOL, P_LOCAL, &sDefault.write_only, NULL, 0},
283 {"list", P_BOOL, P_LOCAL, &sDefault.list, NULL, 0},
284 {"use chroot", P_BOOL, P_LOCAL, &sDefault.use_chroot, NULL, 0},
285 {"ignore nonreadable",P_BOOL, P_LOCAL, &sDefault.ignore_nonreadable, NULL, 0},
286 {"uid", P_STRING, P_LOCAL, &sDefault.uid, NULL, 0},
287 {"gid", P_STRING, P_LOCAL, &sDefault.gid, NULL, 0},
288 {"hosts allow", P_STRING, P_LOCAL, &sDefault.hosts_allow, NULL, 0},
289 {"hosts deny", P_STRING, P_LOCAL, &sDefault.hosts_deny, NULL, 0},
290 {"auth users", P_STRING, P_LOCAL, &sDefault.auth_users, NULL, 0},
291 {"secrets file", P_STRING, P_LOCAL, &sDefault.secrets_file,NULL, 0},
292 {"strict modes", P_BOOL, P_LOCAL, &sDefault.strict_modes,NULL, 0},
293 {"exclude", P_STRING, P_LOCAL, &sDefault.exclude, NULL, 0},
294 {"exclude from", P_STRING, P_LOCAL, &sDefault.exclude_from,NULL, 0},
295 {"include", P_STRING, P_LOCAL, &sDefault.include, NULL, 0},
296 {"include from", P_STRING, P_LOCAL, &sDefault.include_from,NULL, 0},
297 {"transfer logging", P_BOOL, P_LOCAL, &sDefault.transfer_logging,NULL,0},
298 {"ignore errors", P_BOOL, P_LOCAL, &sDefault.ignore_errors,NULL,0},
299 {"log format", P_STRING, P_LOCAL, &sDefault.log_format, NULL, 0},
300 {"refuse options", P_STRING, P_LOCAL, &sDefault.refuse_options,NULL, 0},
301 {"dont compress", P_STRING, P_LOCAL, &sDefault.dont_compress,NULL, 0},
302 {NULL, P_BOOL, P_NONE, NULL, NULL, 0}
306 /***************************************************************************
307 Initialise the global parameter structure.
308 ***************************************************************************/
309 static void init_globals(void)
311 memset(&Globals, 0, sizeof Globals);
313 Globals.syslog_facility = LOG_DAEMON;
315 Globals.max_verbosity = 1;
318 /***************************************************************************
319 Initialise the sDefault parameter structure.
320 ***************************************************************************/
321 static void init_locals(void)
327 In this section all the functions that are used to access the
328 parameters from the rest of the program are defined
331 #define FN_GLOBAL_STRING(fn_name,ptr) \
332 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
333 #define FN_GLOBAL_BOOL(fn_name,ptr) \
334 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
335 #define FN_GLOBAL_CHAR(fn_name,ptr) \
336 char fn_name(void) {return(*(char *)(ptr));}
337 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
338 int fn_name(void) {return(*(int *)(ptr));}
340 #define FN_LOCAL_STRING(fn_name,val) \
341 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
342 #define FN_LOCAL_BOOL(fn_name,val) \
343 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
344 #define FN_LOCAL_CHAR(fn_name,val) \
345 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
346 #define FN_LOCAL_INTEGER(fn_name,val) \
347 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
350 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
351 FN_GLOBAL_STRING(lp_log_file, &Globals.log_file)
352 FN_GLOBAL_STRING(lp_pid_file, &Globals.pid_file)
353 FN_GLOBAL_STRING(lp_socket_options, &Globals.socket_options)
354 FN_GLOBAL_INTEGER(lp_syslog_facility, &Globals.syslog_facility)
355 FN_GLOBAL_INTEGER(lp_max_verbosity, &Globals.max_verbosity)
357 FN_LOCAL_STRING(lp_name, name)
358 FN_LOCAL_STRING(lp_comment, comment)
359 FN_LOCAL_STRING(lp_path, path)
360 FN_LOCAL_STRING(lp_lock_file, lock_file)
361 FN_LOCAL_BOOL(lp_read_only, read_only)
362 FN_LOCAL_BOOL(lp_write_only, write_only)
363 FN_LOCAL_BOOL(lp_list, list)
364 FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
365 FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
366 FN_LOCAL_BOOL(lp_ignore_errors, ignore_errors)
367 FN_LOCAL_BOOL(lp_ignore_nonreadable, ignore_nonreadable)
368 FN_LOCAL_STRING(lp_uid, uid)
369 FN_LOCAL_STRING(lp_gid, gid)
370 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
371 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
372 FN_LOCAL_STRING(lp_auth_users, auth_users)
373 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
374 FN_LOCAL_BOOL(lp_strict_modes, strict_modes)
375 FN_LOCAL_STRING(lp_exclude, exclude)
376 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
377 FN_LOCAL_STRING(lp_include, include)
378 FN_LOCAL_STRING(lp_include_from, include_from)
379 FN_LOCAL_STRING(lp_log_format, log_format)
380 FN_LOCAL_STRING(lp_refuse_options, refuse_options)
381 FN_LOCAL_STRING(lp_dont_compress, dont_compress)
382 FN_LOCAL_INTEGER(lp_timeout, timeout)
383 FN_LOCAL_INTEGER(lp_max_connections, max_connections)
385 /* local prototypes */
386 static int strwicmp(char *psz1, char *psz2);
387 static int map_parameter(char *parmname);
388 static BOOL set_boolean(BOOL *pb, char *parmvalue);
389 static int getservicebyname(char *name, service *pserviceDest);
390 static void copy_service(service *pserviceDest, service *pserviceSource);
391 static BOOL do_parameter(char *parmname, char *parmvalue);
392 static BOOL do_section(char *sectionname);
395 /***************************************************************************
396 initialise a service to the defaults
397 ***************************************************************************/
398 static void init_service(service *pservice)
400 memset((char *)pservice,0,sizeof(service));
401 copy_service(pservice,&sDefault);
406 * Assign a copy of @p v to @p *s. Handles NULL strings. @p *v must
407 * be initialized when this is called, either to NULL or a malloc'd
410 * @fixme There is a small leak here in that sometimes the existing
411 * value will be dynamically allocated, and the old copy is lost.
412 * However, we can't always deallocate the old value, because in the
413 * case of sDefault, it points to a static string. It would be nice
414 * to have either all-strdup'd values, or to never need to free
417 static void string_set(char **s, const char *v)
425 exit_cleanup(RERR_MALLOC);
429 /***************************************************************************
430 add a new service to the services array initialising it with the given
432 ***************************************************************************/
433 static int add_a_service(service *pservice, char *name)
437 int num_to_alloc = iNumServices+1;
439 tservice = *pservice;
441 /* it might already exist */
444 i = getservicebyname(name,NULL);
451 ServicePtrs = realloc_array(ServicePtrs, service *, num_to_alloc);
454 pSERVICE(iNumServices) = new(service);
456 if (!ServicePtrs || !pSERVICE(iNumServices))
461 init_service(pSERVICE(i));
462 copy_service(pSERVICE(i),&tservice);
464 string_set(&iSERVICE(i).name,name);
469 /***************************************************************************
470 Do a case-insensitive, whitespace-ignoring string compare.
471 ***************************************************************************/
472 static int strwicmp(char *psz1, char *psz2)
474 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
475 /* appropriate value. */
485 /* sync the strings on first non-whitespace */
488 while (isspace(* (unsigned char *) psz1))
490 while (isspace(* (unsigned char *) psz2))
492 if (toupper(* (unsigned char *) psz1) != toupper(* (unsigned char *) psz2)
493 || *psz1 == '\0' || *psz2 == '\0')
498 return (*psz1 - *psz2);
501 /***************************************************************************
502 Map a parameter's string representation to something we can use.
503 Returns False if the parameter string is not recognised, else TRUE.
504 ***************************************************************************/
505 static int map_parameter(char *parmname)
509 if (*parmname == '-')
512 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
513 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
516 rprintf(FERROR, "Unknown Parameter encountered: \"%s\"\n", parmname);
521 /***************************************************************************
522 Set a boolean variable from the text value stored in the passed string.
523 Returns True in success, False if the passed string does not correctly
525 ***************************************************************************/
526 static BOOL set_boolean(BOOL *pb, char *parmvalue)
531 if (strwicmp(parmvalue, "yes") == 0 ||
532 strwicmp(parmvalue, "true") == 0 ||
533 strwicmp(parmvalue, "1") == 0)
536 if (strwicmp(parmvalue, "no") == 0 ||
537 strwicmp(parmvalue, "False") == 0 ||
538 strwicmp(parmvalue, "0") == 0)
542 rprintf(FERROR, "Badly formed boolean in configuration file: \"%s\".\n",
549 /***************************************************************************
550 Find a service by name. Otherwise works like get_service.
551 ***************************************************************************/
552 static int getservicebyname(char *name, service *pserviceDest)
556 for (iService = iNumServices - 1; iService >= 0; iService--)
557 if (strwicmp(iSERVICE(iService).name, name) == 0)
559 if (pserviceDest != NULL)
560 copy_service(pserviceDest, pSERVICE(iService));
569 /***************************************************************************
570 Copy a service structure to another
572 ***************************************************************************/
573 static void copy_service(service *pserviceDest,
574 service *pserviceSource)
578 for (i=0;parm_table[i].label;i++)
579 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
580 void *def_ptr = parm_table[i].ptr;
582 ((char *)pserviceSource) + PTR_DIFF(def_ptr,&sDefault);
584 ((char *)pserviceDest) + PTR_DIFF(def_ptr,&sDefault);
586 switch (parm_table[i].type)
590 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
596 *(int *)dest_ptr = *(int *)src_ptr;
600 *(char *)dest_ptr = *(char *)src_ptr;
605 string_set(dest_ptr,*(char **)src_ptr);
615 /***************************************************************************
616 Process a parameter for a particular service number. If snum < 0
617 then assume we are in the globals
618 ***************************************************************************/
619 static BOOL lp_do_parameter(int snum, char *parmname, char *parmvalue)
622 void *parm_ptr=NULL; /* where we are going to store the result */
626 parmnum = map_parameter(parmname);
630 rprintf(FERROR, "IGNORING unknown parameter \"%s\"\n", parmname);
634 def_ptr = parm_table[parmnum].ptr;
636 /* we might point at a service, the default service or a global */
640 if (parm_table[parmnum].class == P_GLOBAL) {
641 rprintf(FERROR, "Global parameter %s found in service section!\n",parmname);
644 parm_ptr = ((char *)pSERVICE(snum)) + PTR_DIFF(def_ptr,&sDefault);
647 /* now switch on the type of variable it is */
648 switch (parm_table[parmnum].type)
651 set_boolean(parm_ptr,parmvalue);
655 set_boolean(parm_ptr,parmvalue);
656 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
660 *(int *)parm_ptr = atoi(parmvalue);
664 *(char *)parm_ptr = *parmvalue;
668 sscanf(parmvalue,"%o",(int *)parm_ptr);
672 string_set(parm_ptr,parmvalue);
673 if ((cp = *(char**)parm_ptr) != NULL) {
674 int len = strlen(cp);
675 while (len > 1 && cp[len-1] == '/') len--;
681 string_set(parm_ptr,parmvalue);
685 strlcpy((char *)parm_ptr,parmvalue,sizeof(pstring));
689 for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
690 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
691 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
695 if (!parm_table[parmnum].enum_list[i].name) {
696 if (atoi(parmvalue) > 0)
697 *(int *)parm_ptr = atoi(parmvalue);
707 /***************************************************************************
709 ***************************************************************************/
710 static BOOL do_parameter(char *parmname, char *parmvalue)
712 return lp_do_parameter(bInGlobalSection?-2:iServiceIndex, parmname, parmvalue);
715 /***************************************************************************
716 Process a new section (service). At this stage all sections are services.
717 Later we'll have special sections that permit server parameters to be set.
718 Returns True on success, False on failure.
719 ***************************************************************************/
720 static BOOL do_section(char *sectionname)
723 BOOL isglobal = (strwicmp(sectionname, GLOBAL_NAME) == 0);
726 /* if we were in a global section then do the local inits */
727 if (bInGlobalSection && !isglobal)
730 /* if we've just struck a global section, note the fact. */
731 bInGlobalSection = isglobal;
733 /* check for multiple global sections */
734 if (bInGlobalSection)
739 /* if we have a current service, tidy it up before moving on */
742 if (iServiceIndex >= 0)
745 /* if all is still well, move to the next record in the services array */
748 /* We put this here to avoid an odd message order if messages are */
749 /* issued by the post-processing of a previous section. */
751 if ((iServiceIndex=add_a_service(&sDefault,sectionname)) < 0)
753 rprintf(FERROR,"Failed to add a new service\n");
762 /***************************************************************************
763 Load the services array from the services file. Return True on success,
765 ***************************************************************************/
766 BOOL lp_load(char *pszFname, int globals_only)
768 extern int am_server;
769 extern int am_daemon;
776 bInGlobalSection = True;
781 pstrcpy(n2,pszFname);
782 else if (am_server && am_daemon && !am_root)
783 pstrcpy(n2,RSYNCD_USERCONF);
785 pstrcpy(n2,RSYNCD_SYSCONF);
787 /* We get sections first, so have to start 'behind' to make up */
789 bRetval = pm_process(n2, globals_only?NULL:do_section, do_parameter);
795 /***************************************************************************
796 return the max number of services
797 ***************************************************************************/
798 int lp_numservices(void)
800 return(iNumServices);
803 /***************************************************************************
804 Return the number of the service with the given name, or -1 if it doesn't
805 exist. Note that this is a DIFFERENT ANIMAL from the internal function
806 getservicebyname()! This works ONLY if all services have been loaded, and
807 does not copy the found service.
808 ***************************************************************************/
809 int lp_number(char *name)
813 for (iService = iNumServices - 1; iService >= 0; iService--)
814 if (strequal(lp_name(iService), name))