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.)
138 char *refuse_options;
148 BOOL ignore_nonreadable;
152 BOOL transfer_logging;
158 /* This is a default service used to prime a services structure. In order
159 * to make these easy to keep sorted in the same way as the variables
160 * above, use the variable name in the leading comment, including a
161 * trailing ';' (to avoid a sorting problem with trailing digits). */
162 static service sDefault =
164 /* auth_users; */ NULL,
166 /* dont_compress; */ "*.gz *.tgz *.zip *.z *.rpm *.deb *.iso *.bz2 *.tbz",
168 /* exclude_from; */ NULL,
170 /* gid; */ NOBODY_GROUP,
171 /* hosts_allow; */ NULL,
172 /* hosts_deny; */ NULL,
174 /* include_from; */ NULL,
175 /* lock_file; */ DEFAULT_LOCK_FILE,
176 /* log_format; */ "%o %h [%a] %m (%u) %f %l",
179 /* postxfer_exec; */ NULL,
180 /* prexfer_exec; */ NULL,
181 /* refuse_options; */ NULL,
182 /* secrets_file; */ NULL,
183 /* temp_dir; */ NULL,
184 /* uid; */ NOBODY_USER,
186 /* max_connections; */ 0,
187 /* max_verbosity; */ 1,
190 /* ignore_errors; */ False,
191 /* ignore_nonreadable; */ False,
193 /* read_only; */ True,
194 /* strict_modes; */ True,
195 /* transfer_logging; */ False,
196 /* use_chroot; */ True,
197 /* write_only; */ False,
202 /* local variables */
203 static service **ServicePtrs = NULL;
204 static int iNumServices = 0;
205 static int iServiceIndex = 0;
206 static BOOL bInGlobalSection = True;
208 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
210 static struct enum_list enum_facilities[] = {
212 { LOG_AUTH, "auth" },
215 { LOG_AUTHPRIV, "authpriv" },
218 { LOG_CRON, "cron" },
221 { LOG_DAEMON, "daemon" },
227 { LOG_KERN, "kern" },
233 { LOG_MAIL, "mail" },
236 { LOG_NEWS, "news" },
239 { LOG_AUTH, "security" },
242 { LOG_SYSLOG, "syslog" },
245 { LOG_USER, "user" },
248 { LOG_UUCP, "uucp" },
251 { LOG_LOCAL0, "local0" },
254 { LOG_LOCAL1, "local1" },
257 { LOG_LOCAL2, "local2" },
260 { LOG_LOCAL3, "local3" },
263 { LOG_LOCAL4, "local4" },
266 { LOG_LOCAL5, "local5" },
269 { LOG_LOCAL6, "local6" },
272 { LOG_LOCAL7, "local7" },
277 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
278 static struct parm_struct parm_table[] =
280 {"address", P_STRING, P_GLOBAL,&Globals.bind_address, NULL,0},
281 {"log file", P_STRING, P_GLOBAL,&Globals.log_file, NULL,0},
282 {"motd file", P_STRING, P_GLOBAL,&Globals.motd_file, NULL,0},
283 {"pid file", P_STRING, P_GLOBAL,&Globals.pid_file, NULL,0},
284 {"port", P_INTEGER,P_GLOBAL,&Globals.rsync_port, NULL,0},
285 {"socket options", P_STRING, P_GLOBAL,&Globals.socket_options, NULL,0},
286 {"syslog facility", P_ENUM, P_GLOBAL,&Globals.syslog_facility,enum_facilities,0},
288 {"auth users", P_STRING, P_LOCAL, &sDefault.auth_users, NULL,0},
289 {"comment", P_STRING, P_LOCAL, &sDefault.comment, NULL,0},
290 {"dont compress", P_STRING, P_LOCAL, &sDefault.dont_compress, NULL,0},
291 {"exclude from", P_STRING, P_LOCAL, &sDefault.exclude_from, NULL,0},
292 {"exclude", P_STRING, P_LOCAL, &sDefault.exclude, NULL,0},
293 {"filter", P_STRING, P_LOCAL, &sDefault.filter, NULL,0},
294 {"gid", P_STRING, P_LOCAL, &sDefault.gid, NULL,0},
295 {"hosts allow", P_STRING, P_LOCAL, &sDefault.hosts_allow, NULL,0},
296 {"hosts deny", P_STRING, P_LOCAL, &sDefault.hosts_deny, NULL,0},
297 {"ignore errors", P_BOOL, P_LOCAL, &sDefault.ignore_errors, NULL,0},
298 {"ignore nonreadable",P_BOOL, P_LOCAL, &sDefault.ignore_nonreadable,NULL,0},
299 {"include from", P_STRING, P_LOCAL, &sDefault.include_from, NULL,0},
300 {"include", P_STRING, P_LOCAL, &sDefault.include, NULL,0},
301 {"list", P_BOOL, P_LOCAL, &sDefault.list, NULL,0},
302 {"lock file", P_STRING, P_LOCAL, &sDefault.lock_file, NULL,0},
303 {"log format", P_STRING, P_LOCAL, &sDefault.log_format, NULL,0},
304 {"max connections", P_INTEGER,P_LOCAL, &sDefault.max_connections, NULL,0},
305 {"max verbosity", P_INTEGER,P_LOCAL, &sDefault.max_verbosity, NULL,0},
306 {"name", P_STRING, P_LOCAL, &sDefault.name, NULL,0},
307 {"path", P_PATH, P_LOCAL, &sDefault.path, NULL,0},
309 {"post-xfer exec", P_STRING, P_LOCAL, &sDefault.postxfer_exec, NULL,0},
310 {"pre-xfer exec", P_STRING, P_LOCAL, &sDefault.prexfer_exec, NULL,0},
312 {"read only", P_BOOL, P_LOCAL, &sDefault.read_only, NULL,0},
313 {"refuse options", P_STRING, P_LOCAL, &sDefault.refuse_options, NULL,0},
314 {"secrets file", P_STRING, P_LOCAL, &sDefault.secrets_file, NULL,0},
315 {"strict modes", P_BOOL, P_LOCAL, &sDefault.strict_modes, NULL,0},
316 {"temp dir", P_PATH, P_LOCAL, &sDefault.temp_dir, NULL,0},
317 {"timeout", P_INTEGER,P_LOCAL, &sDefault.timeout, NULL,0},
318 {"transfer logging", P_BOOL, P_LOCAL, &sDefault.transfer_logging, NULL,0},
319 {"uid", P_STRING, P_LOCAL, &sDefault.uid, NULL,0},
320 {"use chroot", P_BOOL, P_LOCAL, &sDefault.use_chroot, NULL,0},
321 {"write only", P_BOOL, P_LOCAL, &sDefault.write_only, NULL,0},
322 {NULL, P_BOOL, P_NONE, NULL, NULL,0}
326 /***************************************************************************
327 Initialise the global parameter structure.
328 ***************************************************************************/
329 static void init_globals(void)
331 memset(&Globals, 0, sizeof Globals);
333 Globals.syslog_facility = LOG_DAEMON;
337 /***************************************************************************
338 Initialise the sDefault parameter structure.
339 ***************************************************************************/
340 static void init_locals(void)
346 In this section all the functions that are used to access the
347 parameters from the rest of the program are defined
350 #define FN_GLOBAL_STRING(fn_name,ptr) \
351 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
352 #define FN_GLOBAL_BOOL(fn_name,ptr) \
353 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
354 #define FN_GLOBAL_CHAR(fn_name,ptr) \
355 char fn_name(void) {return(*(char *)(ptr));}
356 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
357 int fn_name(void) {return(*(int *)(ptr));}
359 #define FN_LOCAL_STRING(fn_name,val) \
360 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
361 #define FN_LOCAL_BOOL(fn_name,val) \
362 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
363 #define FN_LOCAL_CHAR(fn_name,val) \
364 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
365 #define FN_LOCAL_INTEGER(fn_name,val) \
366 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
369 FN_GLOBAL_STRING(lp_bind_address, &Globals.bind_address)
370 FN_GLOBAL_STRING(lp_log_file, &Globals.log_file)
371 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
372 FN_GLOBAL_STRING(lp_pid_file, &Globals.pid_file)
373 FN_GLOBAL_STRING(lp_socket_options, &Globals.socket_options)
375 FN_GLOBAL_INTEGER(lp_rsync_port, &Globals.rsync_port)
376 FN_GLOBAL_INTEGER(lp_syslog_facility, &Globals.syslog_facility)
378 FN_LOCAL_STRING(lp_auth_users, auth_users)
379 FN_LOCAL_STRING(lp_comment, comment)
380 FN_LOCAL_STRING(lp_dont_compress, dont_compress)
381 FN_LOCAL_STRING(lp_exclude, exclude)
382 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
383 FN_LOCAL_STRING(lp_filter, filter)
384 FN_LOCAL_STRING(lp_gid, gid)
385 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
386 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
387 FN_LOCAL_STRING(lp_include, include)
388 FN_LOCAL_STRING(lp_include_from, include_from)
389 FN_LOCAL_STRING(lp_lock_file, lock_file)
390 FN_LOCAL_STRING(lp_log_format, log_format)
391 FN_LOCAL_STRING(lp_name, name)
392 FN_LOCAL_STRING(lp_path, path)
393 FN_LOCAL_STRING(lp_postxfer_exec, postxfer_exec)
394 FN_LOCAL_STRING(lp_prexfer_exec, prexfer_exec)
395 FN_LOCAL_STRING(lp_refuse_options, refuse_options)
396 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
397 FN_LOCAL_STRING(lp_temp_dir, temp_dir)
398 FN_LOCAL_STRING(lp_uid, uid)
400 FN_LOCAL_INTEGER(lp_max_connections, max_connections)
401 FN_LOCAL_INTEGER(lp_max_verbosity, max_verbosity)
402 FN_LOCAL_INTEGER(lp_timeout, timeout)
404 FN_LOCAL_BOOL(lp_ignore_errors, ignore_errors)
405 FN_LOCAL_BOOL(lp_ignore_nonreadable, ignore_nonreadable)
406 FN_LOCAL_BOOL(lp_list, list)
407 FN_LOCAL_BOOL(lp_read_only, read_only)
408 FN_LOCAL_BOOL(lp_strict_modes, strict_modes)
409 FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
410 FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
411 FN_LOCAL_BOOL(lp_write_only, write_only)
413 /* local prototypes */
414 static int strwicmp(char *psz1, char *psz2);
415 static int map_parameter(char *parmname);
416 static BOOL set_boolean(BOOL *pb, char *parmvalue);
417 static int getservicebyname(char *name, service *pserviceDest);
418 static void copy_service(service *pserviceDest, service *pserviceSource);
419 static BOOL do_parameter(char *parmname, char *parmvalue);
420 static BOOL do_section(char *sectionname);
423 /***************************************************************************
424 initialise a service to the defaults
425 ***************************************************************************/
426 static void init_service(service *pservice)
428 memset((char *)pservice,0,sizeof(service));
429 copy_service(pservice,&sDefault);
434 * Assign a copy of @p v to @p *s. Handles NULL strings. @p *v must
435 * be initialized when this is called, either to NULL or a malloc'd
438 * @fixme There is a small leak here in that sometimes the existing
439 * value will be dynamically allocated, and the old copy is lost.
440 * However, we can't always deallocate the old value, because in the
441 * case of sDefault, it points to a static string. It would be nice
442 * to have either all-strdup'd values, or to never need to free
445 static void string_set(char **s, const char *v)
453 exit_cleanup(RERR_MALLOC);
457 /***************************************************************************
458 add a new service to the services array initialising it with the given
460 ***************************************************************************/
461 static int add_a_service(service *pservice, char *name)
465 int num_to_alloc = iNumServices+1;
467 tservice = *pservice;
469 /* it might already exist */
472 i = getservicebyname(name,NULL);
479 ServicePtrs = realloc_array(ServicePtrs, service *, num_to_alloc);
482 pSERVICE(iNumServices) = new(service);
484 if (!ServicePtrs || !pSERVICE(iNumServices))
489 init_service(pSERVICE(i));
490 copy_service(pSERVICE(i),&tservice);
492 string_set(&iSERVICE(i).name,name);
497 /***************************************************************************
498 Do a case-insensitive, whitespace-ignoring string compare.
499 ***************************************************************************/
500 static int strwicmp(char *psz1, char *psz2)
502 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
503 /* appropriate value. */
513 /* sync the strings on first non-whitespace */
516 while (isspace(* (unsigned char *) psz1))
518 while (isspace(* (unsigned char *) psz2))
520 if (toupper(* (unsigned char *) psz1) != toupper(* (unsigned char *) psz2)
521 || *psz1 == '\0' || *psz2 == '\0')
526 return (*psz1 - *psz2);
529 /***************************************************************************
530 Map a parameter's string representation to something we can use.
531 Returns False if the parameter string is not recognised, else TRUE.
532 ***************************************************************************/
533 static int map_parameter(char *parmname)
537 if (*parmname == '-')
540 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
541 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
544 rprintf(FERROR, "Unknown Parameter encountered: \"%s\"\n", parmname);
549 /***************************************************************************
550 Set a boolean variable from the text value stored in the passed string.
551 Returns True in success, False if the passed string does not correctly
553 ***************************************************************************/
554 static BOOL set_boolean(BOOL *pb, char *parmvalue)
559 if (strwicmp(parmvalue, "yes") == 0 ||
560 strwicmp(parmvalue, "true") == 0 ||
561 strwicmp(parmvalue, "1") == 0)
564 if (strwicmp(parmvalue, "no") == 0 ||
565 strwicmp(parmvalue, "False") == 0 ||
566 strwicmp(parmvalue, "0") == 0)
570 rprintf(FERROR, "Badly formed boolean in configuration file: \"%s\".\n",
577 /***************************************************************************
578 Find a service by name. Otherwise works like get_service.
579 ***************************************************************************/
580 static int getservicebyname(char *name, service *pserviceDest)
584 for (iService = iNumServices - 1; iService >= 0; iService--)
585 if (strwicmp(iSERVICE(iService).name, name) == 0)
587 if (pserviceDest != NULL)
588 copy_service(pserviceDest, pSERVICE(iService));
597 /***************************************************************************
598 Copy a service structure to another
600 ***************************************************************************/
601 static void copy_service(service *pserviceDest,
602 service *pserviceSource)
606 for (i=0;parm_table[i].label;i++)
607 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
608 void *def_ptr = parm_table[i].ptr;
610 ((char *)pserviceSource) + PTR_DIFF(def_ptr,&sDefault);
612 ((char *)pserviceDest) + PTR_DIFF(def_ptr,&sDefault);
614 switch (parm_table[i].type)
618 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
624 *(int *)dest_ptr = *(int *)src_ptr;
628 *(char *)dest_ptr = *(char *)src_ptr;
633 string_set(dest_ptr,*(char **)src_ptr);
643 /***************************************************************************
644 Process a parameter for a particular service number. If snum < 0
645 then assume we are in the globals
646 ***************************************************************************/
647 static BOOL lp_do_parameter(int snum, char *parmname, char *parmvalue)
650 void *parm_ptr=NULL; /* where we are going to store the result */
654 parmnum = map_parameter(parmname);
658 rprintf(FERROR, "IGNORING unknown parameter \"%s\"\n", parmname);
662 def_ptr = parm_table[parmnum].ptr;
664 /* we might point at a service, the default service or a global */
668 if (parm_table[parmnum].class == P_GLOBAL) {
669 rprintf(FERROR, "Global parameter %s found in service section!\n",parmname);
672 parm_ptr = ((char *)pSERVICE(snum)) + PTR_DIFF(def_ptr,&sDefault);
675 /* now switch on the type of variable it is */
676 switch (parm_table[parmnum].type)
679 set_boolean(parm_ptr,parmvalue);
683 set_boolean(parm_ptr,parmvalue);
684 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
688 *(int *)parm_ptr = atoi(parmvalue);
692 *(char *)parm_ptr = *parmvalue;
696 sscanf(parmvalue,"%o",(int *)parm_ptr);
700 string_set(parm_ptr,parmvalue);
701 if ((cp = *(char**)parm_ptr) != NULL) {
702 int len = strlen(cp);
703 while (len > 1 && cp[len-1] == '/') len--;
709 string_set(parm_ptr,parmvalue);
713 strlcpy((char *)parm_ptr,parmvalue,sizeof(pstring));
717 for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
718 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
719 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
723 if (!parm_table[parmnum].enum_list[i].name) {
724 if (atoi(parmvalue) > 0)
725 *(int *)parm_ptr = atoi(parmvalue);
735 /***************************************************************************
737 ***************************************************************************/
738 static BOOL do_parameter(char *parmname, char *parmvalue)
740 return lp_do_parameter(bInGlobalSection?-2:iServiceIndex, parmname, parmvalue);
743 /***************************************************************************
744 Process a new section (service). At this stage all sections are services.
745 Later we'll have special sections that permit server parameters to be set.
746 Returns True on success, False on failure.
747 ***************************************************************************/
748 static BOOL do_section(char *sectionname)
751 BOOL isglobal = (strwicmp(sectionname, GLOBAL_NAME) == 0);
754 /* if we were in a global section then do the local inits */
755 if (bInGlobalSection && !isglobal)
758 /* if we've just struck a global section, note the fact. */
759 bInGlobalSection = isglobal;
761 /* check for multiple global sections */
762 if (bInGlobalSection)
767 /* if we have a current service, tidy it up before moving on */
770 if (iServiceIndex >= 0)
773 /* if all is still well, move to the next record in the services array */
776 /* We put this here to avoid an odd message order if messages are */
777 /* issued by the post-processing of a previous section. */
779 if ((iServiceIndex=add_a_service(&sDefault,sectionname)) < 0)
781 rprintf(FERROR,"Failed to add a new service\n");
790 /***************************************************************************
791 Load the services array from the services file. Return True on success,
793 ***************************************************************************/
794 BOOL lp_load(char *pszFname, int globals_only)
796 extern int am_server;
797 extern int am_daemon;
804 bInGlobalSection = True;
809 pstrcpy(n2,pszFname);
810 else if (am_server && am_daemon && !am_root)
811 pstrcpy(n2,RSYNCD_USERCONF);
813 pstrcpy(n2,RSYNCD_SYSCONF);
815 /* We get sections first, so have to start 'behind' to make up */
817 bRetval = pm_process(n2, globals_only?NULL:do_section, do_parameter);
823 /***************************************************************************
824 return the max number of services
825 ***************************************************************************/
826 int lp_numservices(void)
828 return(iNumServices);
831 /***************************************************************************
832 Return the number of the service with the given name, or -1 if it doesn't
833 exist. Note that this is a DIFFERENT ANIMAL from the internal function
834 getservicebyname()! This works ONLY if all services have been loaded, and
835 does not copy the found service.
836 ***************************************************************************/
837 int lp_number(char *name)
841 for (iService = iNumServices - 1; iService >= 0; iService--)
842 if (strcmp(lp_name(iService), name) == 0)