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.
105 char *socket_options;
111 static global Globals;
115 * This structure describes a single service. Their order must match the
116 * initializers below, which you can accomplish by keeping each sub-section
117 * sorted. (e.g. in vim, just visually select each subsection and use !sort.)
132 char *incoming_chmod;
136 char *outgoing_chmod;
140 char *refuse_options;
150 BOOL ignore_nonreadable;
154 BOOL transfer_logging;
160 /* This is a default service used to prime a services structure. In order
161 * to make these easy to keep sorted in the same way as the variables
162 * above, use the variable name in the leading comment, including a
163 * trailing ';' (to avoid a sorting problem with trailing digits). */
164 static service sDefault =
166 /* auth_users; */ NULL,
168 /* dont_compress; */ "*.gz *.tgz *.zip *.z *.rpm *.deb *.iso *.bz2 *.tbz",
170 /* exclude_from; */ NULL,
172 /* gid; */ NOBODY_GROUP,
173 /* hosts_allow; */ NULL,
174 /* hosts_deny; */ NULL,
176 /* include_from; */ NULL,
177 /* incoming_chmod; */ NULL,
178 /* lock_file; */ DEFAULT_LOCK_FILE,
179 /* log_format; */ "%o %h [%a] %m (%u) %f %l",
181 /* outgoing_chmod; */ NULL,
183 /* postxfer_exec; */ NULL,
184 /* prexfer_exec; */ NULL,
185 /* refuse_options; */ NULL,
186 /* secrets_file; */ NULL,
187 /* temp_dir; */ NULL,
188 /* uid; */ NOBODY_USER,
190 /* max_connections; */ 0,
191 /* max_verbosity; */ 1,
194 /* ignore_errors; */ False,
195 /* ignore_nonreadable; */ False,
197 /* read_only; */ True,
198 /* strict_modes; */ True,
199 /* transfer_logging; */ False,
200 /* use_chroot; */ True,
201 /* write_only; */ False,
206 /* local variables */
207 static service **ServicePtrs = NULL;
208 static int iNumServices = 0;
209 static int iServiceIndex = 0;
210 static BOOL bInGlobalSection = True;
212 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
214 static struct enum_list enum_facilities[] = {
216 { LOG_AUTH, "auth" },
219 { LOG_AUTHPRIV, "authpriv" },
222 { LOG_CRON, "cron" },
225 { LOG_DAEMON, "daemon" },
231 { LOG_KERN, "kern" },
237 { LOG_MAIL, "mail" },
240 { LOG_NEWS, "news" },
243 { LOG_AUTH, "security" },
246 { LOG_SYSLOG, "syslog" },
249 { LOG_USER, "user" },
252 { LOG_UUCP, "uucp" },
255 { LOG_LOCAL0, "local0" },
258 { LOG_LOCAL1, "local1" },
261 { LOG_LOCAL2, "local2" },
264 { LOG_LOCAL3, "local3" },
267 { LOG_LOCAL4, "local4" },
270 { LOG_LOCAL5, "local5" },
273 { LOG_LOCAL6, "local6" },
276 { LOG_LOCAL7, "local7" },
281 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
282 static struct parm_struct parm_table[] =
284 {"address", P_STRING, P_GLOBAL,&Globals.bind_address, NULL,0},
285 {"log file", P_STRING, P_GLOBAL,&Globals.log_file, NULL,0},
286 {"motd file", P_STRING, P_GLOBAL,&Globals.motd_file, NULL,0},
287 {"pid file", P_STRING, P_GLOBAL,&Globals.pid_file, NULL,0},
288 {"port", P_INTEGER,P_GLOBAL,&Globals.rsync_port, NULL,0},
289 {"socket options", P_STRING, P_GLOBAL,&Globals.socket_options, NULL,0},
290 {"syslog facility", P_ENUM, P_GLOBAL,&Globals.syslog_facility,enum_facilities,0},
292 {"auth users", P_STRING, P_LOCAL, &sDefault.auth_users, NULL,0},
293 {"comment", P_STRING, P_LOCAL, &sDefault.comment, NULL,0},
294 {"dont compress", P_STRING, P_LOCAL, &sDefault.dont_compress, NULL,0},
295 {"exclude from", P_STRING, P_LOCAL, &sDefault.exclude_from, NULL,0},
296 {"exclude", P_STRING, P_LOCAL, &sDefault.exclude, NULL,0},
297 {"filter", P_STRING, P_LOCAL, &sDefault.filter, NULL,0},
298 {"gid", P_STRING, P_LOCAL, &sDefault.gid, NULL,0},
299 {"hosts allow", P_STRING, P_LOCAL, &sDefault.hosts_allow, NULL,0},
300 {"hosts deny", P_STRING, P_LOCAL, &sDefault.hosts_deny, NULL,0},
301 {"ignore errors", P_BOOL, P_LOCAL, &sDefault.ignore_errors, NULL,0},
302 {"ignore nonreadable",P_BOOL, P_LOCAL, &sDefault.ignore_nonreadable,NULL,0},
303 {"include from", P_STRING, P_LOCAL, &sDefault.include_from, NULL,0},
304 {"include", P_STRING, P_LOCAL, &sDefault.include, NULL,0},
305 {"incoming chmod", P_STRING, P_LOCAL, &sDefault.incoming_chmod, NULL,0},
306 {"list", P_BOOL, P_LOCAL, &sDefault.list, NULL,0},
307 {"lock file", P_STRING, P_LOCAL, &sDefault.lock_file, NULL,0},
308 {"log format", P_STRING, P_LOCAL, &sDefault.log_format, NULL,0},
309 {"max connections", P_INTEGER,P_LOCAL, &sDefault.max_connections, NULL,0},
310 {"max verbosity", P_INTEGER,P_LOCAL, &sDefault.max_verbosity, NULL,0},
311 {"name", P_STRING, P_LOCAL, &sDefault.name, NULL,0},
312 {"outgoing chmod", P_STRING, P_LOCAL, &sDefault.outgoing_chmod, NULL,0},
313 {"path", P_PATH, P_LOCAL, &sDefault.path, NULL,0},
315 {"post-xfer exec", P_STRING, P_LOCAL, &sDefault.postxfer_exec, NULL,0},
316 {"pre-xfer exec", P_STRING, P_LOCAL, &sDefault.prexfer_exec, NULL,0},
318 {"read only", P_BOOL, P_LOCAL, &sDefault.read_only, NULL,0},
319 {"refuse options", P_STRING, P_LOCAL, &sDefault.refuse_options, NULL,0},
320 {"secrets file", P_STRING, P_LOCAL, &sDefault.secrets_file, NULL,0},
321 {"strict modes", P_BOOL, P_LOCAL, &sDefault.strict_modes, NULL,0},
322 {"temp dir", P_PATH, P_LOCAL, &sDefault.temp_dir, NULL,0},
323 {"timeout", P_INTEGER,P_LOCAL, &sDefault.timeout, NULL,0},
324 {"transfer logging", P_BOOL, P_LOCAL, &sDefault.transfer_logging, NULL,0},
325 {"uid", P_STRING, P_LOCAL, &sDefault.uid, NULL,0},
326 {"use chroot", P_BOOL, P_LOCAL, &sDefault.use_chroot, NULL,0},
327 {"write only", P_BOOL, P_LOCAL, &sDefault.write_only, NULL,0},
328 {NULL, P_BOOL, P_NONE, NULL, NULL,0}
332 /***************************************************************************
333 Initialise the global parameter structure.
334 ***************************************************************************/
335 static void init_globals(void)
337 memset(&Globals, 0, sizeof Globals);
339 Globals.syslog_facility = LOG_DAEMON;
343 /***************************************************************************
344 Initialise the sDefault parameter structure.
345 ***************************************************************************/
346 static void init_locals(void)
352 In this section all the functions that are used to access the
353 parameters from the rest of the program are defined
356 #define FN_GLOBAL_STRING(fn_name,ptr) \
357 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
358 #define FN_GLOBAL_BOOL(fn_name,ptr) \
359 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
360 #define FN_GLOBAL_CHAR(fn_name,ptr) \
361 char fn_name(void) {return(*(char *)(ptr));}
362 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
363 int fn_name(void) {return(*(int *)(ptr));}
365 #define FN_LOCAL_STRING(fn_name,val) \
366 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
367 #define FN_LOCAL_BOOL(fn_name,val) \
368 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
369 #define FN_LOCAL_CHAR(fn_name,val) \
370 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
371 #define FN_LOCAL_INTEGER(fn_name,val) \
372 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
375 FN_GLOBAL_STRING(lp_bind_address, &Globals.bind_address)
376 FN_GLOBAL_STRING(lp_log_file, &Globals.log_file)
377 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
378 FN_GLOBAL_STRING(lp_pid_file, &Globals.pid_file)
379 FN_GLOBAL_STRING(lp_socket_options, &Globals.socket_options)
381 FN_GLOBAL_INTEGER(lp_rsync_port, &Globals.rsync_port)
382 FN_GLOBAL_INTEGER(lp_syslog_facility, &Globals.syslog_facility)
384 FN_LOCAL_STRING(lp_auth_users, auth_users)
385 FN_LOCAL_STRING(lp_comment, comment)
386 FN_LOCAL_STRING(lp_dont_compress, dont_compress)
387 FN_LOCAL_STRING(lp_exclude, exclude)
388 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
389 FN_LOCAL_STRING(lp_filter, filter)
390 FN_LOCAL_STRING(lp_gid, gid)
391 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
392 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
393 FN_LOCAL_STRING(lp_include, include)
394 FN_LOCAL_STRING(lp_include_from, include_from)
395 FN_LOCAL_STRING(lp_incoming_chmod, incoming_chmod)
396 FN_LOCAL_STRING(lp_lock_file, lock_file)
397 FN_LOCAL_STRING(lp_log_format, log_format)
398 FN_LOCAL_STRING(lp_name, name)
399 FN_LOCAL_STRING(lp_outgoing_chmod, outgoing_chmod)
400 FN_LOCAL_STRING(lp_path, path)
401 FN_LOCAL_STRING(lp_postxfer_exec, postxfer_exec)
402 FN_LOCAL_STRING(lp_prexfer_exec, prexfer_exec)
403 FN_LOCAL_STRING(lp_refuse_options, refuse_options)
404 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
405 FN_LOCAL_STRING(lp_temp_dir, temp_dir)
406 FN_LOCAL_STRING(lp_uid, uid)
408 FN_LOCAL_INTEGER(lp_max_connections, max_connections)
409 FN_LOCAL_INTEGER(lp_max_verbosity, max_verbosity)
410 FN_LOCAL_INTEGER(lp_timeout, timeout)
412 FN_LOCAL_BOOL(lp_ignore_errors, ignore_errors)
413 FN_LOCAL_BOOL(lp_ignore_nonreadable, ignore_nonreadable)
414 FN_LOCAL_BOOL(lp_list, list)
415 FN_LOCAL_BOOL(lp_read_only, read_only)
416 FN_LOCAL_BOOL(lp_strict_modes, strict_modes)
417 FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
418 FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
419 FN_LOCAL_BOOL(lp_write_only, write_only)
421 /* local prototypes */
422 static int strwicmp(char *psz1, char *psz2);
423 static int map_parameter(char *parmname);
424 static BOOL set_boolean(BOOL *pb, char *parmvalue);
425 static int getservicebyname(char *name, service *pserviceDest);
426 static void copy_service(service *pserviceDest, service *pserviceSource);
427 static BOOL do_parameter(char *parmname, char *parmvalue);
428 static BOOL do_section(char *sectionname);
431 /***************************************************************************
432 initialise a service to the defaults
433 ***************************************************************************/
434 static void init_service(service *pservice)
436 memset((char *)pservice,0,sizeof(service));
437 copy_service(pservice,&sDefault);
442 * Assign a copy of @p v to @p *s. Handles NULL strings. @p *v must
443 * be initialized when this is called, either to NULL or a malloc'd
446 * @fixme There is a small leak here in that sometimes the existing
447 * value will be dynamically allocated, and the old copy is lost.
448 * However, we can't always deallocate the old value, because in the
449 * case of sDefault, it points to a static string. It would be nice
450 * to have either all-strdup'd values, or to never need to free
453 static void string_set(char **s, const char *v)
461 exit_cleanup(RERR_MALLOC);
465 /***************************************************************************
466 add a new service to the services array initialising it with the given
468 ***************************************************************************/
469 static int add_a_service(service *pservice, char *name)
473 int num_to_alloc = iNumServices+1;
475 tservice = *pservice;
477 /* it might already exist */
480 i = getservicebyname(name,NULL);
487 ServicePtrs = realloc_array(ServicePtrs, service *, num_to_alloc);
490 pSERVICE(iNumServices) = new(service);
492 if (!ServicePtrs || !pSERVICE(iNumServices))
497 init_service(pSERVICE(i));
498 copy_service(pSERVICE(i),&tservice);
500 string_set(&iSERVICE(i).name,name);
505 /***************************************************************************
506 Do a case-insensitive, whitespace-ignoring string compare.
507 ***************************************************************************/
508 static int strwicmp(char *psz1, char *psz2)
510 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
511 /* appropriate value. */
521 /* sync the strings on first non-whitespace */
524 while (isspace(* (unsigned char *) psz1))
526 while (isspace(* (unsigned char *) psz2))
528 if (toupper(* (unsigned char *) psz1) != toupper(* (unsigned char *) psz2)
529 || *psz1 == '\0' || *psz2 == '\0')
534 return (*psz1 - *psz2);
537 /***************************************************************************
538 Map a parameter's string representation to something we can use.
539 Returns False if the parameter string is not recognised, else TRUE.
540 ***************************************************************************/
541 static int map_parameter(char *parmname)
545 if (*parmname == '-')
548 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
549 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
552 rprintf(FERROR, "Unknown Parameter encountered: \"%s\"\n", parmname);
557 /***************************************************************************
558 Set a boolean variable from the text value stored in the passed string.
559 Returns True in success, False if the passed string does not correctly
561 ***************************************************************************/
562 static BOOL set_boolean(BOOL *pb, char *parmvalue)
567 if (strwicmp(parmvalue, "yes") == 0 ||
568 strwicmp(parmvalue, "true") == 0 ||
569 strwicmp(parmvalue, "1") == 0)
572 if (strwicmp(parmvalue, "no") == 0 ||
573 strwicmp(parmvalue, "False") == 0 ||
574 strwicmp(parmvalue, "0") == 0)
578 rprintf(FERROR, "Badly formed boolean in configuration file: \"%s\".\n",
585 /***************************************************************************
586 Find a service by name. Otherwise works like get_service.
587 ***************************************************************************/
588 static int getservicebyname(char *name, service *pserviceDest)
592 for (iService = iNumServices - 1; iService >= 0; iService--)
593 if (strwicmp(iSERVICE(iService).name, name) == 0)
595 if (pserviceDest != NULL)
596 copy_service(pserviceDest, pSERVICE(iService));
605 /***************************************************************************
606 Copy a service structure to another
608 ***************************************************************************/
609 static void copy_service(service *pserviceDest,
610 service *pserviceSource)
614 for (i=0;parm_table[i].label;i++)
615 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
616 void *def_ptr = parm_table[i].ptr;
618 ((char *)pserviceSource) + PTR_DIFF(def_ptr,&sDefault);
620 ((char *)pserviceDest) + PTR_DIFF(def_ptr,&sDefault);
622 switch (parm_table[i].type)
626 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
632 *(int *)dest_ptr = *(int *)src_ptr;
636 *(char *)dest_ptr = *(char *)src_ptr;
641 string_set(dest_ptr,*(char **)src_ptr);
651 /***************************************************************************
652 Process a parameter for a particular service number. If snum < 0
653 then assume we are in the globals
654 ***************************************************************************/
655 static BOOL lp_do_parameter(int snum, char *parmname, char *parmvalue)
658 void *parm_ptr=NULL; /* where we are going to store the result */
662 parmnum = map_parameter(parmname);
666 rprintf(FERROR, "IGNORING unknown parameter \"%s\"\n", parmname);
670 def_ptr = parm_table[parmnum].ptr;
672 /* we might point at a service, the default service or a global */
676 if (parm_table[parmnum].class == P_GLOBAL) {
677 rprintf(FERROR, "Global parameter %s found in service section!\n",parmname);
680 parm_ptr = ((char *)pSERVICE(snum)) + PTR_DIFF(def_ptr,&sDefault);
683 /* now switch on the type of variable it is */
684 switch (parm_table[parmnum].type)
687 set_boolean(parm_ptr,parmvalue);
691 set_boolean(parm_ptr,parmvalue);
692 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
696 *(int *)parm_ptr = atoi(parmvalue);
700 *(char *)parm_ptr = *parmvalue;
704 sscanf(parmvalue,"%o",(int *)parm_ptr);
708 string_set(parm_ptr,parmvalue);
709 if ((cp = *(char**)parm_ptr) != NULL) {
710 int len = strlen(cp);
711 while (len > 1 && cp[len-1] == '/') len--;
717 string_set(parm_ptr,parmvalue);
721 strlcpy((char *)parm_ptr,parmvalue,sizeof(pstring));
725 for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
726 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
727 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
731 if (!parm_table[parmnum].enum_list[i].name) {
732 if (atoi(parmvalue) > 0)
733 *(int *)parm_ptr = atoi(parmvalue);
743 /***************************************************************************
745 ***************************************************************************/
746 static BOOL do_parameter(char *parmname, char *parmvalue)
748 return lp_do_parameter(bInGlobalSection?-2:iServiceIndex, parmname, parmvalue);
751 /***************************************************************************
752 Process a new section (service). At this stage all sections are services.
753 Later we'll have special sections that permit server parameters to be set.
754 Returns True on success, False on failure.
755 ***************************************************************************/
756 static BOOL do_section(char *sectionname)
759 BOOL isglobal = (strwicmp(sectionname, GLOBAL_NAME) == 0);
762 /* if we were in a global section then do the local inits */
763 if (bInGlobalSection && !isglobal)
766 /* if we've just struck a global section, note the fact. */
767 bInGlobalSection = isglobal;
769 /* check for multiple global sections */
770 if (bInGlobalSection)
775 /* if we have a current service, tidy it up before moving on */
778 if (iServiceIndex >= 0)
781 /* if all is still well, move to the next record in the services array */
784 /* We put this here to avoid an odd message order if messages are */
785 /* issued by the post-processing of a previous section. */
787 if ((iServiceIndex=add_a_service(&sDefault,sectionname)) < 0)
789 rprintf(FERROR,"Failed to add a new service\n");
798 /***************************************************************************
799 Load the services array from the services file. Return True on success,
801 ***************************************************************************/
802 BOOL lp_load(char *pszFname, int globals_only)
804 extern int am_server;
805 extern int am_daemon;
812 bInGlobalSection = True;
817 pstrcpy(n2,pszFname);
818 else if (am_server && am_daemon && !am_root)
819 pstrcpy(n2,RSYNCD_USERCONF);
821 pstrcpy(n2,RSYNCD_SYSCONF);
823 /* We get sections first, so have to start 'behind' to make up */
825 bRetval = pm_process(n2, globals_only?NULL:do_section, do_parameter);
831 /***************************************************************************
832 return the max number of services
833 ***************************************************************************/
834 int lp_numservices(void)
836 return(iNumServices);
839 /***************************************************************************
840 Return the number of the service with the given name, or -1 if it doesn't
841 exist. Note that this is a DIFFERENT ANIMAL from the internal function
842 getservicebyname()! This works ONLY if all services have been loaded, and
843 does not copy the found service.
844 ***************************************************************************/
845 int lp_number(char *name)
849 for (iService = iNumServices - 1; iService >= 0; iService--)
850 if (strcmp(lp_name(iService), name) == 0)