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;
110 static global Globals;
114 * This structure describes a single service.
126 BOOL transfer_logging;
140 char *refuse_options;
144 BOOL ignore_nonreadable;
148 /* This is a default service used to prime a services structure */
149 static service sDefault =
154 DEFAULT_LOCK_FILE, /* lock file */
155 True, /* read only */
156 False, /* write only */
158 True, /* use chroot */
159 False, /* transfer logging */
160 False, /* ignore errors */
163 /* TODO: This causes problems on Debian, where it is called
164 * "nogroup". Debian patch this in their version of the
165 * package, but it would be nice to be consistent. Possibly
166 * other systems are different again.
168 * What is the best behaviour? Perhaps always using (gid_t)
172 NULL, /* hosts allow */
173 NULL, /* hosts deny */
174 NULL, /* auth users */
175 NULL, /* secrets file */
176 True, /* strict modes */
178 NULL, /* exclude from */
180 NULL, /* include from */
181 "%o %h [%a] %m (%u) %f %l", /* log format */
182 NULL, /* refuse options */
183 "*.gz *.tgz *.zip *.z *.rpm *.deb *.iso *.bz2 *.tbz", /* dont compress */
185 0, /* max connections */
186 False /* ignore nonreadable */
191 /* local variables */
192 static service **ServicePtrs = NULL;
193 static int iNumServices = 0;
194 static int iServiceIndex = 0;
195 static BOOL bInGlobalSection = True;
197 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
199 static struct enum_list enum_facilities[] = {
201 { LOG_AUTH, "auth" },
204 { LOG_AUTHPRIV, "authpriv" },
207 { LOG_CRON, "cron" },
210 { LOG_DAEMON, "daemon" },
216 { LOG_KERN, "kern" },
222 { LOG_MAIL, "mail" },
225 { LOG_NEWS, "news" },
228 { LOG_AUTH, "security" },
231 { LOG_SYSLOG, "syslog" },
234 { LOG_USER, "user" },
237 { LOG_UUCP, "uucp" },
240 { LOG_LOCAL0, "local0" },
243 { LOG_LOCAL1, "local1" },
246 { LOG_LOCAL2, "local2" },
249 { LOG_LOCAL3, "local3" },
252 { LOG_LOCAL4, "local4" },
255 { LOG_LOCAL5, "local5" },
258 { LOG_LOCAL6, "local6" },
261 { LOG_LOCAL7, "local7" },
266 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
267 static struct parm_struct parm_table[] =
269 {"motd file", P_STRING, P_GLOBAL, &Globals.motd_file, NULL, 0},
270 {"syslog facility", P_ENUM, P_GLOBAL, &Globals.syslog_facility, enum_facilities,0},
271 {"socket options", P_STRING, P_GLOBAL, &Globals.socket_options,NULL, 0},
272 {"log file", P_STRING, P_GLOBAL, &Globals.log_file, NULL, 0},
273 {"pid file", P_STRING, P_GLOBAL, &Globals.pid_file, NULL, 0},
274 {"max verbosity", P_INTEGER, P_GLOBAL, &Globals.max_verbosity, NULL, 0},
275 {"port", P_INTEGER, P_GLOBAL, &Globals.rsync_port, NULL, 0},
277 {"timeout", P_INTEGER, P_LOCAL, &sDefault.timeout, NULL, 0},
278 {"max connections", P_INTEGER, P_LOCAL, &sDefault.max_connections,NULL, 0},
279 {"name", P_STRING, P_LOCAL, &sDefault.name, NULL, 0},
280 {"comment", P_STRING, P_LOCAL, &sDefault.comment, NULL, 0},
281 {"lock file", P_STRING, P_LOCAL, &sDefault.lock_file, NULL, 0},
282 {"path", P_PATH, P_LOCAL, &sDefault.path, NULL, 0},
283 {"read only", P_BOOL, P_LOCAL, &sDefault.read_only, NULL, 0},
284 {"write only", P_BOOL, P_LOCAL, &sDefault.write_only, NULL, 0},
285 {"list", P_BOOL, P_LOCAL, &sDefault.list, NULL, 0},
286 {"use chroot", P_BOOL, P_LOCAL, &sDefault.use_chroot, NULL, 0},
287 {"ignore nonreadable",P_BOOL, P_LOCAL, &sDefault.ignore_nonreadable, NULL, 0},
288 {"uid", P_STRING, P_LOCAL, &sDefault.uid, NULL, 0},
289 {"gid", P_STRING, P_LOCAL, &sDefault.gid, NULL, 0},
290 {"hosts allow", P_STRING, P_LOCAL, &sDefault.hosts_allow, NULL, 0},
291 {"hosts deny", P_STRING, P_LOCAL, &sDefault.hosts_deny, NULL, 0},
292 {"auth users", P_STRING, P_LOCAL, &sDefault.auth_users, NULL, 0},
293 {"secrets file", P_STRING, P_LOCAL, &sDefault.secrets_file,NULL, 0},
294 {"strict modes", P_BOOL, P_LOCAL, &sDefault.strict_modes,NULL, 0},
295 {"exclude", P_STRING, P_LOCAL, &sDefault.exclude, NULL, 0},
296 {"exclude from", P_STRING, P_LOCAL, &sDefault.exclude_from,NULL, 0},
297 {"include", P_STRING, P_LOCAL, &sDefault.include, NULL, 0},
298 {"include from", P_STRING, P_LOCAL, &sDefault.include_from,NULL, 0},
299 {"transfer logging", P_BOOL, P_LOCAL, &sDefault.transfer_logging,NULL,0},
300 {"ignore errors", P_BOOL, P_LOCAL, &sDefault.ignore_errors,NULL,0},
301 {"log format", P_STRING, P_LOCAL, &sDefault.log_format, NULL, 0},
302 {"refuse options", P_STRING, P_LOCAL, &sDefault.refuse_options,NULL, 0},
303 {"dont compress", P_STRING, P_LOCAL, &sDefault.dont_compress,NULL, 0},
304 {NULL, P_BOOL, P_NONE, NULL, NULL, 0}
308 /***************************************************************************
309 Initialise the global parameter structure.
310 ***************************************************************************/
311 static void init_globals(void)
313 memset(&Globals, 0, sizeof Globals);
315 Globals.syslog_facility = LOG_DAEMON;
317 Globals.max_verbosity = 1;
320 /***************************************************************************
321 Initialise the sDefault parameter structure.
322 ***************************************************************************/
323 static void init_locals(void)
329 In this section all the functions that are used to access the
330 parameters from the rest of the program are defined
333 #define FN_GLOBAL_STRING(fn_name,ptr) \
334 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
335 #define FN_GLOBAL_BOOL(fn_name,ptr) \
336 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
337 #define FN_GLOBAL_CHAR(fn_name,ptr) \
338 char fn_name(void) {return(*(char *)(ptr));}
339 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
340 int fn_name(void) {return(*(int *)(ptr));}
342 #define FN_LOCAL_STRING(fn_name,val) \
343 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
344 #define FN_LOCAL_BOOL(fn_name,val) \
345 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
346 #define FN_LOCAL_CHAR(fn_name,val) \
347 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
348 #define FN_LOCAL_INTEGER(fn_name,val) \
349 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
352 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
353 FN_GLOBAL_STRING(lp_log_file, &Globals.log_file)
354 FN_GLOBAL_STRING(lp_pid_file, &Globals.pid_file)
355 FN_GLOBAL_STRING(lp_socket_options, &Globals.socket_options)
356 FN_GLOBAL_INTEGER(lp_syslog_facility, &Globals.syslog_facility)
357 FN_GLOBAL_INTEGER(lp_max_verbosity, &Globals.max_verbosity)
358 FN_GLOBAL_INTEGER(lp_rsync_port, &Globals.rsync_port)
360 FN_LOCAL_STRING(lp_name, name)
361 FN_LOCAL_STRING(lp_comment, comment)
362 FN_LOCAL_STRING(lp_path, path)
363 FN_LOCAL_STRING(lp_lock_file, lock_file)
364 FN_LOCAL_BOOL(lp_read_only, read_only)
365 FN_LOCAL_BOOL(lp_write_only, write_only)
366 FN_LOCAL_BOOL(lp_list, list)
367 FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
368 FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
369 FN_LOCAL_BOOL(lp_ignore_errors, ignore_errors)
370 FN_LOCAL_BOOL(lp_ignore_nonreadable, ignore_nonreadable)
371 FN_LOCAL_STRING(lp_uid, uid)
372 FN_LOCAL_STRING(lp_gid, gid)
373 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
374 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
375 FN_LOCAL_STRING(lp_auth_users, auth_users)
376 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
377 FN_LOCAL_BOOL(lp_strict_modes, strict_modes)
378 FN_LOCAL_STRING(lp_exclude, exclude)
379 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
380 FN_LOCAL_STRING(lp_include, include)
381 FN_LOCAL_STRING(lp_include_from, include_from)
382 FN_LOCAL_STRING(lp_log_format, log_format)
383 FN_LOCAL_STRING(lp_refuse_options, refuse_options)
384 FN_LOCAL_STRING(lp_dont_compress, dont_compress)
385 FN_LOCAL_INTEGER(lp_timeout, timeout)
386 FN_LOCAL_INTEGER(lp_max_connections, max_connections)
388 /* local prototypes */
389 static int strwicmp(char *psz1, char *psz2);
390 static int map_parameter(char *parmname);
391 static BOOL set_boolean(BOOL *pb, char *parmvalue);
392 static int getservicebyname(char *name, service *pserviceDest);
393 static void copy_service(service *pserviceDest, service *pserviceSource);
394 static BOOL do_parameter(char *parmname, char *parmvalue);
395 static BOOL do_section(char *sectionname);
398 /***************************************************************************
399 initialise a service to the defaults
400 ***************************************************************************/
401 static void init_service(service *pservice)
403 memset((char *)pservice,0,sizeof(service));
404 copy_service(pservice,&sDefault);
409 * Assign a copy of @p v to @p *s. Handles NULL strings. @p *v must
410 * be initialized when this is called, either to NULL or a malloc'd
413 * @fixme There is a small leak here in that sometimes the existing
414 * value will be dynamically allocated, and the old copy is lost.
415 * However, we can't always deallocate the old value, because in the
416 * case of sDefault, it points to a static string. It would be nice
417 * to have either all-strdup'd values, or to never need to free
420 static void string_set(char **s, const char *v)
428 exit_cleanup(RERR_MALLOC);
432 /***************************************************************************
433 add a new service to the services array initialising it with the given
435 ***************************************************************************/
436 static int add_a_service(service *pservice, char *name)
440 int num_to_alloc = iNumServices+1;
442 tservice = *pservice;
444 /* it might already exist */
447 i = getservicebyname(name,NULL);
454 ServicePtrs = realloc_array(ServicePtrs, service *, num_to_alloc);
457 pSERVICE(iNumServices) = new(service);
459 if (!ServicePtrs || !pSERVICE(iNumServices))
464 init_service(pSERVICE(i));
465 copy_service(pSERVICE(i),&tservice);
467 string_set(&iSERVICE(i).name,name);
472 /***************************************************************************
473 Do a case-insensitive, whitespace-ignoring string compare.
474 ***************************************************************************/
475 static int strwicmp(char *psz1, char *psz2)
477 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
478 /* appropriate value. */
488 /* sync the strings on first non-whitespace */
491 while (isspace(* (unsigned char *) psz1))
493 while (isspace(* (unsigned char *) psz2))
495 if (toupper(* (unsigned char *) psz1) != toupper(* (unsigned char *) psz2)
496 || *psz1 == '\0' || *psz2 == '\0')
501 return (*psz1 - *psz2);
504 /***************************************************************************
505 Map a parameter's string representation to something we can use.
506 Returns False if the parameter string is not recognised, else TRUE.
507 ***************************************************************************/
508 static int map_parameter(char *parmname)
512 if (*parmname == '-')
515 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
516 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
519 rprintf(FERROR, "Unknown Parameter encountered: \"%s\"\n", parmname);
524 /***************************************************************************
525 Set a boolean variable from the text value stored in the passed string.
526 Returns True in success, False if the passed string does not correctly
528 ***************************************************************************/
529 static BOOL set_boolean(BOOL *pb, char *parmvalue)
534 if (strwicmp(parmvalue, "yes") == 0 ||
535 strwicmp(parmvalue, "true") == 0 ||
536 strwicmp(parmvalue, "1") == 0)
539 if (strwicmp(parmvalue, "no") == 0 ||
540 strwicmp(parmvalue, "False") == 0 ||
541 strwicmp(parmvalue, "0") == 0)
545 rprintf(FERROR, "Badly formed boolean in configuration file: \"%s\".\n",
552 /***************************************************************************
553 Find a service by name. Otherwise works like get_service.
554 ***************************************************************************/
555 static int getservicebyname(char *name, service *pserviceDest)
559 for (iService = iNumServices - 1; iService >= 0; iService--)
560 if (strwicmp(iSERVICE(iService).name, name) == 0)
562 if (pserviceDest != NULL)
563 copy_service(pserviceDest, pSERVICE(iService));
572 /***************************************************************************
573 Copy a service structure to another
575 ***************************************************************************/
576 static void copy_service(service *pserviceDest,
577 service *pserviceSource)
581 for (i=0;parm_table[i].label;i++)
582 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
583 void *def_ptr = parm_table[i].ptr;
585 ((char *)pserviceSource) + PTR_DIFF(def_ptr,&sDefault);
587 ((char *)pserviceDest) + PTR_DIFF(def_ptr,&sDefault);
589 switch (parm_table[i].type)
593 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
599 *(int *)dest_ptr = *(int *)src_ptr;
603 *(char *)dest_ptr = *(char *)src_ptr;
608 string_set(dest_ptr,*(char **)src_ptr);
618 /***************************************************************************
619 Process a parameter for a particular service number. If snum < 0
620 then assume we are in the globals
621 ***************************************************************************/
622 static BOOL lp_do_parameter(int snum, char *parmname, char *parmvalue)
625 void *parm_ptr=NULL; /* where we are going to store the result */
629 parmnum = map_parameter(parmname);
633 rprintf(FERROR, "IGNORING unknown parameter \"%s\"\n", parmname);
637 def_ptr = parm_table[parmnum].ptr;
639 /* we might point at a service, the default service or a global */
643 if (parm_table[parmnum].class == P_GLOBAL) {
644 rprintf(FERROR, "Global parameter %s found in service section!\n",parmname);
647 parm_ptr = ((char *)pSERVICE(snum)) + PTR_DIFF(def_ptr,&sDefault);
650 /* now switch on the type of variable it is */
651 switch (parm_table[parmnum].type)
654 set_boolean(parm_ptr,parmvalue);
658 set_boolean(parm_ptr,parmvalue);
659 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
663 *(int *)parm_ptr = atoi(parmvalue);
667 *(char *)parm_ptr = *parmvalue;
671 sscanf(parmvalue,"%o",(int *)parm_ptr);
675 string_set(parm_ptr,parmvalue);
676 if ((cp = *(char**)parm_ptr) != NULL) {
677 int len = strlen(cp);
678 while (len > 1 && cp[len-1] == '/') len--;
684 string_set(parm_ptr,parmvalue);
688 strlcpy((char *)parm_ptr,parmvalue,sizeof(pstring));
692 for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
693 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
694 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
698 if (!parm_table[parmnum].enum_list[i].name) {
699 if (atoi(parmvalue) > 0)
700 *(int *)parm_ptr = atoi(parmvalue);
710 /***************************************************************************
712 ***************************************************************************/
713 static BOOL do_parameter(char *parmname, char *parmvalue)
715 return lp_do_parameter(bInGlobalSection?-2:iServiceIndex, parmname, parmvalue);
718 /***************************************************************************
719 Process a new section (service). At this stage all sections are services.
720 Later we'll have special sections that permit server parameters to be set.
721 Returns True on success, False on failure.
722 ***************************************************************************/
723 static BOOL do_section(char *sectionname)
726 BOOL isglobal = (strwicmp(sectionname, GLOBAL_NAME) == 0);
729 /* if we were in a global section then do the local inits */
730 if (bInGlobalSection && !isglobal)
733 /* if we've just struck a global section, note the fact. */
734 bInGlobalSection = isglobal;
736 /* check for multiple global sections */
737 if (bInGlobalSection)
742 /* if we have a current service, tidy it up before moving on */
745 if (iServiceIndex >= 0)
748 /* if all is still well, move to the next record in the services array */
751 /* We put this here to avoid an odd message order if messages are */
752 /* issued by the post-processing of a previous section. */
754 if ((iServiceIndex=add_a_service(&sDefault,sectionname)) < 0)
756 rprintf(FERROR,"Failed to add a new service\n");
765 /***************************************************************************
766 Load the services array from the services file. Return True on success,
768 ***************************************************************************/
769 BOOL lp_load(char *pszFname, int globals_only)
771 extern int am_server;
772 extern int am_daemon;
779 bInGlobalSection = True;
784 pstrcpy(n2,pszFname);
785 else if (am_server && am_daemon && !am_root)
786 pstrcpy(n2,RSYNCD_USERCONF);
788 pstrcpy(n2,RSYNCD_SYSCONF);
790 /* We get sections first, so have to start 'behind' to make up */
792 bRetval = pm_process(n2, globals_only?NULL:do_section, do_parameter);
798 /***************************************************************************
799 return the max number of services
800 ***************************************************************************/
801 int lp_numservices(void)
803 return(iNumServices);
806 /***************************************************************************
807 Return the number of the service with the given name, or -1 if it doesn't
808 exist. Note that this is a DIFFERENT ANIMAL from the internal function
809 getservicebyname()! This works ONLY if all services have been loaded, and
810 does not copy the found service.
811 ***************************************************************************/
812 int lp_number(char *name)
816 for (iService = iNumServices - 1; iService >= 0; iService--)
817 if (strcmp(lp_name(iService), name) == 0)