1 /* This is based on loadparm.c from Samba, written by Andrew Tridgell
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
21 * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
27 * This module provides suitable callback functions for the params
28 * module. It builds the internal table of service details which is
29 * then used by the rest of the server.
33 * 1) add it to the global or service structure definition
34 * 2) add it to the parm_table
35 * 3) add it to the list of available functions (eg: using FN_GLOBAL_STRING())
36 * 4) If it's a global then initialise it in init_globals. If a local
37 * (ie. service) parameter then initialise it in the sDefault structure
41 * The configuration file is processed sequentially for speed. It is NOT
42 * accessed randomly as happens in 'real' Windows. For this reason, there
43 * is a fair bit of sequence-dependent code here - ie., code which assumes
44 * that certain things happen before others. In particular, the code which
45 * happens at the boundary between sections is delicately poised, so be
50 /* TODO: Parameter to set debug level on server. */
53 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((char *)(p1)) - (char *)(p2)))
54 #define strequal(a,b) (strcasecmp(a,b)==0)
55 #define BOOLSTR(b) ((b) ? "Yes" : "No")
56 typedef char pstring[1024];
57 #define pstrcpy(a,b) strlcpy(a,b,sizeof(pstring))
63 /* the following are used by loadparm for option lists */
66 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,
67 P_PATH,P_STRING,P_GSTRING,P_ENUM,P_SEP
72 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
86 struct enum_list *enum_list;
91 #define GLOBAL_NAME "global"
94 /* some helpful bits */
95 #define pSERVICE(i) ServicePtrs[i]
96 #define iSERVICE(i) (*pSERVICE(i))
97 #define LP_SNUM_OK(iService) (((iService) >= 0) && ((iService) < iNumServices))
100 * This structure describes global (ie., server-wide) parameters.
107 char *socket_options;
112 static global Globals;
116 * This structure describes a single service. Their order must match the
117 * initializers below, which you can accomplish by keeping each sub-section
118 * sorted. (e.g. in vim, just visually select each subsection and use !sort.)
133 char *incoming_chmod;
138 char *outgoing_chmod;
142 char *refuse_options;
154 BOOL ignore_nonreadable;
158 BOOL transfer_logging;
164 /* This is a default service used to prime a services structure. In order
165 * to make these easy to keep sorted in the same way as the variables
166 * above, use the variable name in the leading comment, including a
167 * trailing ';' (to avoid a sorting problem with trailing digits). */
168 static service sDefault =
170 /* auth_users; */ NULL,
172 /* dont_compress; */ "*.gz *.tgz *.zip *.z *.rpm *.deb *.iso *.bz2 *.tbz",
174 /* exclude_from; */ NULL,
176 /* gid; */ NOBODY_GROUP,
177 /* hosts_allow; */ NULL,
178 /* hosts_deny; */ NULL,
180 /* include_from; */ NULL,
181 /* incoming_chmod; */ NULL,
182 /* lock_file; */ DEFAULT_LOCK_FILE,
183 /* log_file; */ NULL,
184 /* log_format; */ "%o %h [%a] %m (%u) %f %l",
186 /* outgoing_chmod; */ NULL,
188 /* postxfer_exec; */ NULL,
189 /* prexfer_exec; */ NULL,
190 /* refuse_options; */ NULL,
191 /* secrets_file; */ NULL,
192 /* temp_dir; */ NULL,
193 /* uid; */ NOBODY_USER,
195 /* max_connections; */ 0,
196 /* max_verbosity; */ 1,
197 /* syslog_facility; */ LOG_DAEMON,
200 /* fake_super; */ False,
201 /* ignore_errors; */ False,
202 /* ignore_nonreadable; */ False,
204 /* read_only; */ True,
205 /* strict_modes; */ True,
206 /* transfer_logging; */ False,
207 /* use_chroot; */ True,
208 /* write_only; */ False,
213 /* local variables */
214 static service **ServicePtrs = NULL;
215 static int iNumServices = 0;
216 static int iServiceIndex = 0;
217 static BOOL bInGlobalSection = True;
219 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
221 static struct enum_list enum_facilities[] = {
223 { LOG_AUTH, "auth" },
226 { LOG_AUTHPRIV, "authpriv" },
229 { LOG_CRON, "cron" },
232 { LOG_DAEMON, "daemon" },
238 { LOG_KERN, "kern" },
244 { LOG_MAIL, "mail" },
247 { LOG_NEWS, "news" },
250 { LOG_AUTH, "security" },
253 { LOG_SYSLOG, "syslog" },
256 { LOG_USER, "user" },
259 { LOG_UUCP, "uucp" },
262 { LOG_LOCAL0, "local0" },
265 { LOG_LOCAL1, "local1" },
268 { LOG_LOCAL2, "local2" },
271 { LOG_LOCAL3, "local3" },
274 { LOG_LOCAL4, "local4" },
277 { LOG_LOCAL5, "local5" },
280 { LOG_LOCAL6, "local6" },
283 { LOG_LOCAL7, "local7" },
288 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
289 static struct parm_struct parm_table[] =
291 {"address", P_STRING, P_GLOBAL,&Globals.bind_address, NULL,0},
292 {"motd file", P_STRING, P_GLOBAL,&Globals.motd_file, NULL,0},
293 {"pid file", P_STRING, P_GLOBAL,&Globals.pid_file, NULL,0},
294 {"port", P_INTEGER,P_GLOBAL,&Globals.rsync_port, NULL,0},
295 {"socket options", P_STRING, P_GLOBAL,&Globals.socket_options, NULL,0},
297 {"auth users", P_STRING, P_LOCAL, &sDefault.auth_users, NULL,0},
298 {"comment", P_STRING, P_LOCAL, &sDefault.comment, NULL,0},
299 {"dont compress", P_STRING, P_LOCAL, &sDefault.dont_compress, NULL,0},
300 {"exclude from", P_STRING, P_LOCAL, &sDefault.exclude_from, NULL,0},
301 {"exclude", P_STRING, P_LOCAL, &sDefault.exclude, NULL,0},
302 {"fake super", P_BOOL, P_LOCAL, &sDefault.fake_super, NULL,0},
303 {"filter", P_STRING, P_LOCAL, &sDefault.filter, NULL,0},
304 {"gid", P_STRING, P_LOCAL, &sDefault.gid, NULL,0},
305 {"hosts allow", P_STRING, P_LOCAL, &sDefault.hosts_allow, NULL,0},
306 {"hosts deny", P_STRING, P_LOCAL, &sDefault.hosts_deny, NULL,0},
307 {"ignore errors", P_BOOL, P_LOCAL, &sDefault.ignore_errors, NULL,0},
308 {"ignore nonreadable",P_BOOL, P_LOCAL, &sDefault.ignore_nonreadable,NULL,0},
309 {"include from", P_STRING, P_LOCAL, &sDefault.include_from, NULL,0},
310 {"include", P_STRING, P_LOCAL, &sDefault.include, NULL,0},
311 {"incoming chmod", P_STRING, P_LOCAL, &sDefault.incoming_chmod, NULL,0},
312 {"list", P_BOOL, P_LOCAL, &sDefault.list, NULL,0},
313 {"lock file", P_STRING, P_LOCAL, &sDefault.lock_file, NULL,0},
314 {"log file", P_STRING, P_LOCAL, &sDefault.log_file, NULL,0},
315 {"log format", P_STRING, P_LOCAL, &sDefault.log_format, NULL,0},
316 {"max connections", P_INTEGER,P_LOCAL, &sDefault.max_connections, NULL,0},
317 {"max verbosity", P_INTEGER,P_LOCAL, &sDefault.max_verbosity, NULL,0},
318 {"name", P_STRING, P_LOCAL, &sDefault.name, NULL,0},
319 {"outgoing chmod", P_STRING, P_LOCAL, &sDefault.outgoing_chmod, NULL,0},
320 {"path", P_PATH, P_LOCAL, &sDefault.path, NULL,0},
322 {"post-xfer exec", P_STRING, P_LOCAL, &sDefault.postxfer_exec, NULL,0},
323 {"pre-xfer exec", P_STRING, P_LOCAL, &sDefault.prexfer_exec, NULL,0},
325 {"read only", P_BOOL, P_LOCAL, &sDefault.read_only, NULL,0},
326 {"refuse options", P_STRING, P_LOCAL, &sDefault.refuse_options, NULL,0},
327 {"secrets file", P_STRING, P_LOCAL, &sDefault.secrets_file, NULL,0},
328 {"strict modes", P_BOOL, P_LOCAL, &sDefault.strict_modes, NULL,0},
329 {"syslog facility", P_ENUM, P_LOCAL, &sDefault.syslog_facility,enum_facilities,0},
330 {"temp dir", P_PATH, P_LOCAL, &sDefault.temp_dir, NULL,0},
331 {"timeout", P_INTEGER,P_LOCAL, &sDefault.timeout, NULL,0},
332 {"transfer logging", P_BOOL, P_LOCAL, &sDefault.transfer_logging, NULL,0},
333 {"uid", P_STRING, P_LOCAL, &sDefault.uid, NULL,0},
334 {"use chroot", P_BOOL, P_LOCAL, &sDefault.use_chroot, NULL,0},
335 {"write only", P_BOOL, P_LOCAL, &sDefault.write_only, NULL,0},
336 {NULL, P_BOOL, P_NONE, NULL, NULL,0}
340 /***************************************************************************
341 * Initialise the global parameter structure.
342 ***************************************************************************/
343 static void init_globals(void)
345 memset(&Globals, 0, sizeof Globals);
348 /***************************************************************************
349 * Initialise the sDefault parameter structure.
350 ***************************************************************************/
351 static void init_locals(void)
357 In this section all the functions that are used to access the
358 parameters from the rest of the program are defined
361 #define FN_GLOBAL_STRING(fn_name,ptr) \
362 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
363 #define FN_GLOBAL_BOOL(fn_name,ptr) \
364 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
365 #define FN_GLOBAL_CHAR(fn_name,ptr) \
366 char fn_name(void) {return(*(char *)(ptr));}
367 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
368 int fn_name(void) {return(*(int *)(ptr));}
370 #define FN_LOCAL_STRING(fn_name,val) \
371 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
372 #define FN_LOCAL_BOOL(fn_name,val) \
373 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
374 #define FN_LOCAL_CHAR(fn_name,val) \
375 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
376 #define FN_LOCAL_INTEGER(fn_name,val) \
377 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
380 FN_GLOBAL_STRING(lp_bind_address, &Globals.bind_address)
381 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
382 FN_GLOBAL_STRING(lp_pid_file, &Globals.pid_file)
383 FN_GLOBAL_STRING(lp_socket_options, &Globals.socket_options)
385 FN_GLOBAL_INTEGER(lp_rsync_port, &Globals.rsync_port)
387 FN_LOCAL_STRING(lp_auth_users, auth_users)
388 FN_LOCAL_STRING(lp_comment, comment)
389 FN_LOCAL_STRING(lp_dont_compress, dont_compress)
390 FN_LOCAL_STRING(lp_exclude, exclude)
391 FN_LOCAL_STRING(lp_exclude_from, exclude_from)
392 FN_LOCAL_STRING(lp_filter, filter)
393 FN_LOCAL_STRING(lp_gid, gid)
394 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
395 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
396 FN_LOCAL_STRING(lp_include, include)
397 FN_LOCAL_STRING(lp_include_from, include_from)
398 FN_LOCAL_STRING(lp_incoming_chmod, incoming_chmod)
399 FN_LOCAL_STRING(lp_lock_file, lock_file)
400 FN_LOCAL_STRING(lp_log_file, log_file)
401 FN_LOCAL_STRING(lp_log_format, log_format)
402 FN_LOCAL_STRING(lp_name, name)
403 FN_LOCAL_STRING(lp_outgoing_chmod, outgoing_chmod)
404 FN_LOCAL_STRING(lp_path, path)
405 FN_LOCAL_STRING(lp_postxfer_exec, postxfer_exec)
406 FN_LOCAL_STRING(lp_prexfer_exec, prexfer_exec)
407 FN_LOCAL_STRING(lp_refuse_options, refuse_options)
408 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
409 FN_LOCAL_INTEGER(lp_syslog_facility, syslog_facility)
410 FN_LOCAL_STRING(lp_temp_dir, temp_dir)
411 FN_LOCAL_STRING(lp_uid, uid)
413 FN_LOCAL_INTEGER(lp_max_connections, max_connections)
414 FN_LOCAL_INTEGER(lp_max_verbosity, max_verbosity)
415 FN_LOCAL_INTEGER(lp_timeout, timeout)
417 FN_LOCAL_BOOL(lp_fake_super, fake_super)
418 FN_LOCAL_BOOL(lp_ignore_errors, ignore_errors)
419 FN_LOCAL_BOOL(lp_ignore_nonreadable, ignore_nonreadable)
420 FN_LOCAL_BOOL(lp_list, list)
421 FN_LOCAL_BOOL(lp_read_only, read_only)
422 FN_LOCAL_BOOL(lp_strict_modes, strict_modes)
423 FN_LOCAL_BOOL(lp_transfer_logging, transfer_logging)
424 FN_LOCAL_BOOL(lp_use_chroot, use_chroot)
425 FN_LOCAL_BOOL(lp_write_only, write_only)
427 /* local prototypes */
428 static int strwicmp(char *psz1, char *psz2);
429 static int map_parameter(char *parmname);
430 static BOOL set_boolean(BOOL *pb, char *parmvalue);
431 static int getservicebyname(char *name, service *pserviceDest);
432 static void copy_service(service *pserviceDest, service *pserviceSource);
433 static BOOL do_parameter(char *parmname, char *parmvalue);
434 static BOOL do_section(char *sectionname);
437 /***************************************************************************
438 * initialise a service to the defaults
439 ***************************************************************************/
440 static void init_service(service *pservice)
442 memset((char *)pservice,0,sizeof(service));
443 copy_service(pservice,&sDefault);
448 * Assign a copy of @p v to @p *s. Handles NULL strings. @p *v must
449 * be initialized when this is called, either to NULL or a malloc'd
452 * @fixme There is a small leak here in that sometimes the existing
453 * value will be dynamically allocated, and the old copy is lost.
454 * However, we can't always deallocate the old value, because in the
455 * case of sDefault, it points to a static string. It would be nice
456 * to have either all-strdup'd values, or to never need to free
459 static void string_set(char **s, const char *v)
467 exit_cleanup(RERR_MALLOC);
471 /***************************************************************************
472 * add a new service to the services array initialising it with the given
474 ***************************************************************************/
475 static int add_a_service(service *pservice, char *name)
479 int num_to_alloc = iNumServices+1;
481 tservice = *pservice;
483 /* it might already exist */
486 i = getservicebyname(name,NULL);
493 ServicePtrs = realloc_array(ServicePtrs, service *, num_to_alloc);
496 pSERVICE(iNumServices) = new(service);
498 if (!ServicePtrs || !pSERVICE(iNumServices))
503 init_service(pSERVICE(i));
504 copy_service(pSERVICE(i),&tservice);
506 string_set(&iSERVICE(i).name,name);
511 /***************************************************************************
512 * Do a case-insensitive, whitespace-ignoring string compare.
513 ***************************************************************************/
514 static int strwicmp(char *psz1, char *psz2)
516 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
517 /* appropriate value. */
527 /* sync the strings on first non-whitespace */
530 while (isSpace(psz1))
532 while (isSpace(psz2))
534 if (toUpper(psz1) != toUpper(psz2) || *psz1 == '\0' || *psz2 == '\0')
539 return (*psz1 - *psz2);
542 /***************************************************************************
543 * Map a parameter's string representation to something we can use.
544 * Returns False if the parameter string is not recognised, else TRUE.
545 ***************************************************************************/
546 static int map_parameter(char *parmname)
550 if (*parmname == '-')
553 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
554 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
557 rprintf(FERROR, "Unknown Parameter encountered: \"%s\"\n", parmname);
562 /***************************************************************************
563 * Set a boolean variable from the text value stored in the passed string.
564 * Returns True in success, False if the passed string does not correctly
565 * represent a boolean.
566 ***************************************************************************/
567 static BOOL set_boolean(BOOL *pb, char *parmvalue)
572 if (strwicmp(parmvalue, "yes") == 0 ||
573 strwicmp(parmvalue, "true") == 0 ||
574 strwicmp(parmvalue, "1") == 0)
577 if (strwicmp(parmvalue, "no") == 0 ||
578 strwicmp(parmvalue, "False") == 0 ||
579 strwicmp(parmvalue, "0") == 0)
583 rprintf(FERROR, "Badly formed boolean in configuration file: \"%s\".\n",
590 /***************************************************************************
591 * Find a service by name. Otherwise works like get_service.
592 ***************************************************************************/
593 static int getservicebyname(char *name, service *pserviceDest)
597 for (iService = iNumServices - 1; iService >= 0; iService--)
598 if (strwicmp(iSERVICE(iService).name, name) == 0)
600 if (pserviceDest != NULL)
601 copy_service(pserviceDest, pSERVICE(iService));
610 /***************************************************************************
611 * Copy a service structure to another
612 ***************************************************************************/
613 static void copy_service(service *pserviceDest,
614 service *pserviceSource)
618 for (i=0;parm_table[i].label;i++)
619 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
620 void *def_ptr = parm_table[i].ptr;
622 ((char *)pserviceSource) + PTR_DIFF(def_ptr,&sDefault);
624 ((char *)pserviceDest) + PTR_DIFF(def_ptr,&sDefault);
626 switch (parm_table[i].type)
630 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
636 *(int *)dest_ptr = *(int *)src_ptr;
640 *(char *)dest_ptr = *(char *)src_ptr;
645 string_set(dest_ptr,*(char **)src_ptr);
655 /***************************************************************************
656 * Process a parameter for a particular service number. If snum < 0
657 * then assume we are in the globals
658 ***************************************************************************/
659 static BOOL lp_do_parameter(int snum, char *parmname, char *parmvalue)
662 void *parm_ptr=NULL; /* where we are going to store the result */
666 parmnum = map_parameter(parmname);
670 rprintf(FERROR, "IGNORING unknown parameter \"%s\"\n", parmname);
674 def_ptr = parm_table[parmnum].ptr;
676 /* we might point at a service, the default service or a global */
680 if (parm_table[parmnum].class == P_GLOBAL) {
681 rprintf(FERROR, "Global parameter %s found in service section!\n",parmname);
684 parm_ptr = ((char *)pSERVICE(snum)) + PTR_DIFF(def_ptr,&sDefault);
687 /* now switch on the type of variable it is */
688 switch (parm_table[parmnum].type)
691 set_boolean(parm_ptr,parmvalue);
695 set_boolean(parm_ptr,parmvalue);
696 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
700 *(int *)parm_ptr = atoi(parmvalue);
704 *(char *)parm_ptr = *parmvalue;
708 sscanf(parmvalue,"%o",(int *)parm_ptr);
712 string_set(parm_ptr,parmvalue);
713 if ((cp = *(char**)parm_ptr) != NULL) {
714 int len = strlen(cp);
715 while (len > 1 && cp[len-1] == '/') len--;
721 string_set(parm_ptr,parmvalue);
725 strlcpy((char *)parm_ptr,parmvalue,sizeof(pstring));
729 for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
730 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
731 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
735 if (!parm_table[parmnum].enum_list[i].name) {
736 if (atoi(parmvalue) > 0)
737 *(int *)parm_ptr = atoi(parmvalue);
747 /***************************************************************************
748 * Process a parameter.
749 ***************************************************************************/
750 static BOOL do_parameter(char *parmname, char *parmvalue)
752 return lp_do_parameter(bInGlobalSection?-2:iServiceIndex, parmname, parmvalue);
755 /***************************************************************************
756 * Process a new section (service). At this stage all sections are services.
757 * Later we'll have special sections that permit server parameters to be set.
758 * Returns True on success, False on failure.
759 ***************************************************************************/
760 static BOOL do_section(char *sectionname)
763 BOOL isglobal = (strwicmp(sectionname, GLOBAL_NAME) == 0);
766 /* if we were in a global section then do the local inits */
767 if (bInGlobalSection && !isglobal)
770 /* if we've just struck a global section, note the fact. */
771 bInGlobalSection = isglobal;
773 /* check for multiple global sections */
774 if (bInGlobalSection)
779 /* if we have a current service, tidy it up before moving on */
782 if (iServiceIndex >= 0)
785 /* if all is still well, move to the next record in the services array */
788 /* We put this here to avoid an odd message order if messages are */
789 /* issued by the post-processing of a previous section. */
791 if ((iServiceIndex=add_a_service(&sDefault,sectionname)) < 0)
793 rprintf(FERROR,"Failed to add a new service\n");
802 /***************************************************************************
803 * Load the services array from the services file. Return True on success,
805 ***************************************************************************/
806 BOOL lp_load(char *pszFname, int globals_only)
808 extern int am_server;
815 bInGlobalSection = True;
820 pstrcpy(n2,pszFname);
821 else if (am_server && am_root <= 0)
822 pstrcpy(n2,RSYNCD_USERCONF);
824 pstrcpy(n2,RSYNCD_SYSCONF);
826 /* We get sections first, so have to start 'behind' to make up */
828 bRetval = pm_process(n2, globals_only?NULL:do_section, do_parameter);
834 /***************************************************************************
835 * return the max number of services
836 ***************************************************************************/
837 int lp_numservices(void)
839 return(iNumServices);
842 /***************************************************************************
843 * Return the number of the service with the given name, or -1 if it doesn't
844 * exist. Note that this is a DIFFERENT ANIMAL from the internal function
845 * getservicebyname()! This works ONLY if all services have been loaded, and
846 * does not copy the found service.
847 ***************************************************************************/
848 int lp_number(char *name)
852 for (iService = iNumServices - 1; iService >= 0; iService--)
853 if (strcmp(lp_name(iService), name) == 0)