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;
141 char *refuse_options;
148 BOOL ignore_nonreadable;
152 /* This is a default service used to prime a services structure */
153 static service sDefault =
158 DEFAULT_LOCK_FILE, /* lock file */
159 True, /* read only */
160 False, /* write only */
162 True, /* use chroot */
163 False, /* transfer logging */
164 False, /* ignore errors */
165 NOBODY_USER,/* uid */
166 NOBODY_GROUP,/* gid */
167 NULL, /* hosts allow */
168 NULL, /* hosts deny */
169 NULL, /* auth users */
170 NULL, /* secrets file */
171 True, /* strict modes */
174 NULL, /* exclude from */
176 NULL, /* include from */
177 "%o %h [%a] %m (%u) %f %l", /* log format */
178 NULL, /* refuse options */
179 "*.gz *.tgz *.zip *.z *.rpm *.deb *.iso *.bz2 *.tbz", /* dont compress */
180 NULL, /* prexfer_exec */
181 NULL, /* postxfer_exec */
183 0, /* max connections */
184 1, /* max verbosity */
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 {"port", P_INTEGER, P_GLOBAL, &Globals.rsync_port, NULL, 0},
274 {"address", P_STRING, P_GLOBAL, &Globals.bind_address, NULL, 0},
276 {"timeout", P_INTEGER, P_LOCAL, &sDefault.timeout, NULL, 0},
277 {"max connections", P_INTEGER, P_LOCAL, &sDefault.max_connections,NULL, 0},
278 {"max verbosity", P_INTEGER, P_LOCAL, &sDefault.max_verbosity,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 {"filter", P_STRING, P_LOCAL, &sDefault.filter, NULL, 0},
296 {"exclude", P_STRING, P_LOCAL, &sDefault.exclude, NULL, 0},
297 {"exclude from", P_STRING, P_LOCAL, &sDefault.exclude_from,NULL, 0},
298 {"include", P_STRING, P_LOCAL, &sDefault.include, NULL, 0},
299 {"include from", P_STRING, P_LOCAL, &sDefault.include_from,NULL, 0},
300 {"transfer logging", P_BOOL, P_LOCAL, &sDefault.transfer_logging,NULL,0},
301 {"ignore errors", P_BOOL, P_LOCAL, &sDefault.ignore_errors,NULL,0},
302 {"log format", P_STRING, P_LOCAL, &sDefault.log_format, NULL, 0},
303 {"refuse options", P_STRING, P_LOCAL, &sDefault.refuse_options,NULL, 0},
304 {"dont compress", P_STRING, P_LOCAL, &sDefault.dont_compress,NULL, 0},
306 {"pre-xfer exec", P_STRING, P_LOCAL, &sDefault.prexfer_exec, NULL, 0},
307 {"post-xfer exec", P_STRING, P_LOCAL, &sDefault.postxfer_exec,NULL, 0},
309 {NULL, P_BOOL, P_NONE, NULL, NULL, 0}
313 /***************************************************************************
314 Initialise the global parameter structure.
315 ***************************************************************************/
316 static void init_globals(void)
318 memset(&Globals, 0, sizeof Globals);
320 Globals.syslog_facility = LOG_DAEMON;
324 /***************************************************************************
325 Initialise the sDefault parameter structure.
326 ***************************************************************************/
327 static void init_locals(void)
333 In this section all the functions that are used to access the
334 parameters from the rest of the program are defined
337 #define FN_GLOBAL_STRING(fn_name,ptr) \
338 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
339 #define FN_GLOBAL_BOOL(fn_name,ptr) \
340 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
341 #define FN_GLOBAL_CHAR(fn_name,ptr) \
342 char fn_name(void) {return(*(char *)(ptr));}
343 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
344 int fn_name(void) {return(*(int *)(ptr));}
346 #define FN_LOCAL_STRING(fn_name,val) \
347 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
348 #define FN_LOCAL_BOOL(fn_name,val) \
349 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
350 #define FN_LOCAL_CHAR(fn_name,val) \
351 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
352 #define FN_LOCAL_INTEGER(fn_name,val) \
353 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
356 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
357 FN_GLOBAL_STRING(lp_log_file, &Globals.log_file)
358 FN_GLOBAL_STRING(lp_pid_file, &Globals.pid_file)
359 FN_GLOBAL_STRING(lp_socket_options, &Globals.socket_options)
360 FN_GLOBAL_INTEGER(lp_syslog_facility, &Globals.syslog_facility)
361 FN_GLOBAL_INTEGER(lp_rsync_port, &Globals.rsync_port)
362 FN_GLOBAL_STRING(lp_bind_address, &Globals.bind_address)
364 FN_LOCAL_STRING(lp_name, name)
365 FN_LOCAL_STRING(lp_comment, comment)
366 FN_LOCAL_STRING(lp_path, path)
367 FN_LOCAL_STRING(lp_lock_file, lock_file)
368 FN_LOCAL_BOOL(lp_read_only, read_only)
369 FN_LOCAL_BOOL(lp_write_only, write_only)
370 FN_LOCAL_BOOL(lp_list, list)
371 FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
372 FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
373 FN_LOCAL_BOOL(lp_ignore_errors, ignore_errors)
374 FN_LOCAL_BOOL(lp_ignore_nonreadable, ignore_nonreadable)
375 FN_LOCAL_STRING(lp_uid, uid)
376 FN_LOCAL_STRING(lp_gid, gid)
377 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
378 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
379 FN_LOCAL_STRING(lp_auth_users, auth_users)
380 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
381 FN_LOCAL_BOOL(lp_strict_modes, strict_modes)
382 FN_LOCAL_STRING(lp_filter, filter)
383 FN_LOCAL_STRING(lp_exclude, exclude)
384 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
385 FN_LOCAL_STRING(lp_include, include)
386 FN_LOCAL_STRING(lp_include_from, include_from)
387 FN_LOCAL_STRING(lp_log_format, log_format)
388 FN_LOCAL_STRING(lp_refuse_options, refuse_options)
389 FN_LOCAL_STRING(lp_dont_compress, dont_compress)
390 FN_LOCAL_STRING(lp_prexfer_exec, prexfer_exec)
391 FN_LOCAL_STRING(lp_postxfer_exec, postxfer_exec)
392 FN_LOCAL_INTEGER(lp_timeout, timeout)
393 FN_LOCAL_INTEGER(lp_max_connections, max_connections)
394 FN_LOCAL_INTEGER(lp_max_verbosity, max_verbosity)
396 /* local prototypes */
397 static int strwicmp(char *psz1, char *psz2);
398 static int map_parameter(char *parmname);
399 static BOOL set_boolean(BOOL *pb, char *parmvalue);
400 static int getservicebyname(char *name, service *pserviceDest);
401 static void copy_service(service *pserviceDest, service *pserviceSource);
402 static BOOL do_parameter(char *parmname, char *parmvalue);
403 static BOOL do_section(char *sectionname);
406 /***************************************************************************
407 initialise a service to the defaults
408 ***************************************************************************/
409 static void init_service(service *pservice)
411 memset((char *)pservice,0,sizeof(service));
412 copy_service(pservice,&sDefault);
417 * Assign a copy of @p v to @p *s. Handles NULL strings. @p *v must
418 * be initialized when this is called, either to NULL or a malloc'd
421 * @fixme There is a small leak here in that sometimes the existing
422 * value will be dynamically allocated, and the old copy is lost.
423 * However, we can't always deallocate the old value, because in the
424 * case of sDefault, it points to a static string. It would be nice
425 * to have either all-strdup'd values, or to never need to free
428 static void string_set(char **s, const char *v)
436 exit_cleanup(RERR_MALLOC);
440 /***************************************************************************
441 add a new service to the services array initialising it with the given
443 ***************************************************************************/
444 static int add_a_service(service *pservice, char *name)
448 int num_to_alloc = iNumServices+1;
450 tservice = *pservice;
452 /* it might already exist */
455 i = getservicebyname(name,NULL);
462 ServicePtrs = realloc_array(ServicePtrs, service *, num_to_alloc);
465 pSERVICE(iNumServices) = new(service);
467 if (!ServicePtrs || !pSERVICE(iNumServices))
472 init_service(pSERVICE(i));
473 copy_service(pSERVICE(i),&tservice);
475 string_set(&iSERVICE(i).name,name);
480 /***************************************************************************
481 Do a case-insensitive, whitespace-ignoring string compare.
482 ***************************************************************************/
483 static int strwicmp(char *psz1, char *psz2)
485 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
486 /* appropriate value. */
496 /* sync the strings on first non-whitespace */
499 while (isspace(* (unsigned char *) psz1))
501 while (isspace(* (unsigned char *) psz2))
503 if (toupper(* (unsigned char *) psz1) != toupper(* (unsigned char *) psz2)
504 || *psz1 == '\0' || *psz2 == '\0')
509 return (*psz1 - *psz2);
512 /***************************************************************************
513 Map a parameter's string representation to something we can use.
514 Returns False if the parameter string is not recognised, else TRUE.
515 ***************************************************************************/
516 static int map_parameter(char *parmname)
520 if (*parmname == '-')
523 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
524 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
527 rprintf(FERROR, "Unknown Parameter encountered: \"%s\"\n", parmname);
532 /***************************************************************************
533 Set a boolean variable from the text value stored in the passed string.
534 Returns True in success, False if the passed string does not correctly
536 ***************************************************************************/
537 static BOOL set_boolean(BOOL *pb, char *parmvalue)
542 if (strwicmp(parmvalue, "yes") == 0 ||
543 strwicmp(parmvalue, "true") == 0 ||
544 strwicmp(parmvalue, "1") == 0)
547 if (strwicmp(parmvalue, "no") == 0 ||
548 strwicmp(parmvalue, "False") == 0 ||
549 strwicmp(parmvalue, "0") == 0)
553 rprintf(FERROR, "Badly formed boolean in configuration file: \"%s\".\n",
560 /***************************************************************************
561 Find a service by name. Otherwise works like get_service.
562 ***************************************************************************/
563 static int getservicebyname(char *name, service *pserviceDest)
567 for (iService = iNumServices - 1; iService >= 0; iService--)
568 if (strwicmp(iSERVICE(iService).name, name) == 0)
570 if (pserviceDest != NULL)
571 copy_service(pserviceDest, pSERVICE(iService));
580 /***************************************************************************
581 Copy a service structure to another
583 ***************************************************************************/
584 static void copy_service(service *pserviceDest,
585 service *pserviceSource)
589 for (i=0;parm_table[i].label;i++)
590 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
591 void *def_ptr = parm_table[i].ptr;
593 ((char *)pserviceSource) + PTR_DIFF(def_ptr,&sDefault);
595 ((char *)pserviceDest) + PTR_DIFF(def_ptr,&sDefault);
597 switch (parm_table[i].type)
601 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
607 *(int *)dest_ptr = *(int *)src_ptr;
611 *(char *)dest_ptr = *(char *)src_ptr;
616 string_set(dest_ptr,*(char **)src_ptr);
626 /***************************************************************************
627 Process a parameter for a particular service number. If snum < 0
628 then assume we are in the globals
629 ***************************************************************************/
630 static BOOL lp_do_parameter(int snum, char *parmname, char *parmvalue)
633 void *parm_ptr=NULL; /* where we are going to store the result */
637 parmnum = map_parameter(parmname);
641 rprintf(FERROR, "IGNORING unknown parameter \"%s\"\n", parmname);
645 def_ptr = parm_table[parmnum].ptr;
647 /* we might point at a service, the default service or a global */
651 if (parm_table[parmnum].class == P_GLOBAL) {
652 rprintf(FERROR, "Global parameter %s found in service section!\n",parmname);
655 parm_ptr = ((char *)pSERVICE(snum)) + PTR_DIFF(def_ptr,&sDefault);
658 /* now switch on the type of variable it is */
659 switch (parm_table[parmnum].type)
662 set_boolean(parm_ptr,parmvalue);
666 set_boolean(parm_ptr,parmvalue);
667 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
671 *(int *)parm_ptr = atoi(parmvalue);
675 *(char *)parm_ptr = *parmvalue;
679 sscanf(parmvalue,"%o",(int *)parm_ptr);
683 string_set(parm_ptr,parmvalue);
684 if ((cp = *(char**)parm_ptr) != NULL) {
685 int len = strlen(cp);
686 while (len > 1 && cp[len-1] == '/') len--;
692 string_set(parm_ptr,parmvalue);
696 strlcpy((char *)parm_ptr,parmvalue,sizeof(pstring));
700 for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
701 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
702 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
706 if (!parm_table[parmnum].enum_list[i].name) {
707 if (atoi(parmvalue) > 0)
708 *(int *)parm_ptr = atoi(parmvalue);
718 /***************************************************************************
720 ***************************************************************************/
721 static BOOL do_parameter(char *parmname, char *parmvalue)
723 return lp_do_parameter(bInGlobalSection?-2:iServiceIndex, parmname, parmvalue);
726 /***************************************************************************
727 Process a new section (service). At this stage all sections are services.
728 Later we'll have special sections that permit server parameters to be set.
729 Returns True on success, False on failure.
730 ***************************************************************************/
731 static BOOL do_section(char *sectionname)
734 BOOL isglobal = (strwicmp(sectionname, GLOBAL_NAME) == 0);
737 /* if we were in a global section then do the local inits */
738 if (bInGlobalSection && !isglobal)
741 /* if we've just struck a global section, note the fact. */
742 bInGlobalSection = isglobal;
744 /* check for multiple global sections */
745 if (bInGlobalSection)
750 /* if we have a current service, tidy it up before moving on */
753 if (iServiceIndex >= 0)
756 /* if all is still well, move to the next record in the services array */
759 /* We put this here to avoid an odd message order if messages are */
760 /* issued by the post-processing of a previous section. */
762 if ((iServiceIndex=add_a_service(&sDefault,sectionname)) < 0)
764 rprintf(FERROR,"Failed to add a new service\n");
773 /***************************************************************************
774 Load the services array from the services file. Return True on success,
776 ***************************************************************************/
777 BOOL lp_load(char *pszFname, int globals_only)
779 extern int am_server;
780 extern int am_daemon;
787 bInGlobalSection = True;
792 pstrcpy(n2,pszFname);
793 else if (am_server && am_daemon && !am_root)
794 pstrcpy(n2,RSYNCD_USERCONF);
796 pstrcpy(n2,RSYNCD_SYSCONF);
798 /* We get sections first, so have to start 'behind' to make up */
800 bRetval = pm_process(n2, globals_only?NULL:do_section, do_parameter);
806 /***************************************************************************
807 return the max number of services
808 ***************************************************************************/
809 int lp_numservices(void)
811 return(iNumServices);
814 /***************************************************************************
815 Return the number of the service with the given name, or -1 if it doesn't
816 exist. Note that this is a DIFFERENT ANIMAL from the internal function
817 getservicebyname()! This works ONLY if all services have been loaded, and
818 does not copy the found service.
819 ***************************************************************************/
820 int lp_number(char *name)
824 for (iService = iNumServices - 1; iService >= 0; iService--)
825 if (strcmp(lp_name(iService), name) == 0)