now support integers or strings for syslog facility
[rsync.git] / loadparm.c
1 /* This is based on loadparm.c from Samba, written by Andrew Tridgell
2    and Karl Auer */
3
4 /* 
5    This program is free software; you can redistribute it and/or modify
6    it under the terms of the GNU General Public License as published by
7    the Free Software Foundation; either version 2 of the License, or
8    (at your option) any later version.
9    
10    This program is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13    GNU General Public License for more details.
14    
15    You should have received a copy of the GNU General Public License
16    along with this program; if not, write to the Free Software
17    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 */
19
20 /*
21  *  Load parameters.
22  *
23  *  This module provides suitable callback functions for the params
24  *  module. It builds the internal table of service details which is
25  *  then used by the rest of the server.
26  *
27  * To add a parameter:
28  *
29  * 1) add it to the global or service structure definition
30  * 2) add it to the parm_table
31  * 3) add it to the list of available functions (eg: using FN_GLOBAL_STRING())
32  * 4) If it's a global then initialise it in init_globals. If a local
33  *    (ie. service) parameter then initialise it in the sDefault structure
34  *  
35  *
36  * Notes:
37  *   The configuration file is processed sequentially for speed. It is NOT
38  *   accessed randomly as happens in 'real' Windows. For this reason, there
39  *   is a fair bit of sequence-dependent code here - ie., code which assumes
40  *   that certain things happen before others. In particular, the code which
41  *   happens at the boundary between sections is delicately poised, so be
42  *   careful!
43  *
44  */
45
46 #include "rsync.h"
47 #define BOOL int
48 #define False 0
49 #define True 1
50 #define Realloc realloc
51 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((char *)(p1)) - (char *)(p2)))
52 #define strequal(a,b) (strcasecmp(a,b)==0)
53 #define BOOLSTR(b) ((b) ? "Yes" : "No")
54 typedef char pstring[1024];
55 #define pstrcpy(a,b) strlcpy(a,b,sizeof(pstring)-1)
56
57 /* the following are used by loadparm for option lists */
58 typedef enum
59 {
60         P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,
61         P_STRING,P_GSTRING,P_ENUM,P_SEP
62 } parm_type;
63
64 typedef enum
65 {
66         P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
67 } parm_class;
68
69 struct enum_list {
70         int value;
71         char *name;
72 };
73
74 struct parm_struct
75 {
76         char *label;
77         parm_type type;
78         parm_class class;
79         void *ptr;
80         struct enum_list *enum_list;
81         unsigned flags;
82 };
83
84 static BOOL bLoaded = False;
85
86 #ifndef GLOBAL_NAME
87 #define GLOBAL_NAME "global"
88 #endif
89
90 /* some helpful bits */
91 #define pSERVICE(i) ServicePtrs[i]
92 #define iSERVICE(i) (*pSERVICE(i))
93 #define LP_SNUM_OK(iService) (((iService) >= 0) && ((iService) < iNumServices))
94
95 /* 
96  * This structure describes global (ie., server-wide) parameters.
97  */
98 typedef struct
99 {
100         char *motd_file;
101         char *lock_file;
102         int syslog_facility;
103         int max_connections;
104 } global;
105
106 static global Globals;
107
108
109
110 /* 
111  * This structure describes a single service. 
112  */
113 typedef struct
114 {
115         char *name;
116         char *path;
117         char *comment;
118         BOOL read_only;
119         BOOL list;
120         char *uid;
121         char *gid;
122         char *hosts_allow;
123         char *hosts_deny;
124         char *auth_users;
125         char *secrets_file;
126 } service;
127
128
129 /* This is a default service used to prime a services structure */
130 static service sDefault = 
131 {
132         NULL,    /* name */
133         NULL,    /* path */
134         NULL,    /* comment */
135         True,    /* read only */
136         True,    /* list */
137         "nobody",/* uid */
138         "nobody",/* gid */
139         NULL,    /* hosts allow */
140         NULL,    /* hosts deny */
141         NULL,    /* auth users */
142         NULL,    /* secrets file */
143 };
144
145
146
147 /* local variables */
148 static service **ServicePtrs = NULL;
149 static int iNumServices = 0;
150 static int iServiceIndex = 0;
151 static BOOL bInGlobalSection = True;
152
153 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
154
155 static struct enum_list enum_facilities[] = {
156 #ifdef LOG_AUTH
157         { LOG_AUTH, "auth" },
158 #endif
159 #ifdef LOG_AUTHPRIV
160         { LOG_AUTHPRIV, "authpriv" },
161 #endif
162 #ifdef LOG_CRON
163         { LOG_CRON, "cron" },
164 #endif
165 #ifdef LOG_DAEMON
166         { LOG_DAEMON, "daemon" },
167 #endif
168 #ifdef LOG_FTP
169         { LOG_FTP, "ftp" },
170 #endif
171 #ifdef LOG_KERN
172         { LOG_KERN, "kern" },
173 #endif
174 #ifdef LOG_LPR
175         { LOG_LPR, "lpr" },
176 #endif
177 #ifdef LOG_MAIL
178         { LOG_MAIL, "mail" },
179 #endif
180 #ifdef LOG_NEWS
181         { LOG_NEWS, "news" },
182 #endif
183 #ifdef LOG_AUTH
184         { LOG_AUTH, "security" },               
185 #endif
186 #ifdef LOG_SYSLOG
187         { LOG_SYSLOG, "syslog" },
188 #endif
189 #ifdef LOG_USER
190         { LOG_USER, "user" },
191 #endif
192 #ifdef LOG_UUCP
193         { LOG_UUCP, "uucp" },
194 #endif
195 #ifdef LOG_LOCAL0
196         { LOG_LOCAL0, "local0" },
197 #endif
198 #ifdef LOG_LOCAL1
199         { LOG_LOCAL1, "local1" },
200 #endif
201 #ifdef LOG_LOCAL2
202         { LOG_LOCAL2, "local2" },
203 #endif
204 #ifdef LOG_LOCAL3
205         { LOG_LOCAL3, "local3" },
206 #endif
207 #ifdef LOG_LOCAL4
208         { LOG_LOCAL4, "local4" },
209 #endif
210 #ifdef LOG_LOCAL5
211         { LOG_LOCAL5, "local5" },
212 #endif
213 #ifdef LOG_LOCAL6
214         { LOG_LOCAL6, "local6" },
215 #endif
216 #ifdef LOG_LOCAL7
217         { LOG_LOCAL7, "local7" },
218 #endif
219         { -1, NULL }};
220
221
222 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
223 static struct parm_struct parm_table[] =
224 {
225   {"max connections",  P_INTEGER, P_GLOBAL, &Globals.max_connections,NULL, 0},
226   {"motd file",        P_STRING,  P_GLOBAL, &Globals.motd_file,    NULL,   0},
227   {"lock file",        P_STRING,  P_GLOBAL, &Globals.lock_file,    NULL,   0},
228   {"syslog facility",  P_ENUM,    P_GLOBAL, &Globals.syslog_facility, enum_facilities,0},
229   {"name",             P_STRING,  P_LOCAL,  &sDefault.name,        NULL,   0},
230   {"comment",          P_STRING,  P_LOCAL,  &sDefault.comment,     NULL,   0},
231   {"path",             P_STRING,  P_LOCAL,  &sDefault.path,        NULL,   0},
232   {"read only",        P_BOOL,    P_LOCAL,  &sDefault.read_only,   NULL,   0},
233   {"list",             P_BOOL,    P_LOCAL,  &sDefault.list,        NULL,   0},
234   {"uid",              P_STRING,  P_LOCAL,  &sDefault.uid,         NULL,   0},
235   {"gid",              P_STRING,  P_LOCAL,  &sDefault.gid,         NULL,   0},
236   {"hosts allow",      P_STRING,  P_LOCAL,  &sDefault.hosts_allow, NULL,   0},
237   {"hosts deny",       P_STRING,  P_LOCAL,  &sDefault.hosts_deny,  NULL,   0},
238   {"auth users",       P_STRING,  P_LOCAL,  &sDefault.auth_users,  NULL,   0},
239   {"secrets file",     P_STRING,  P_LOCAL,  &sDefault.secrets_file,NULL,   0},
240   {NULL,               P_BOOL,    P_NONE,   NULL,                  NULL,   0}
241 };
242
243
244 /***************************************************************************
245 Initialise the global parameter structure.
246 ***************************************************************************/
247 static void init_globals(void)
248 {
249 #ifdef LOG_DAEMON
250         Globals.syslog_facility = LOG_DAEMON;
251 #endif
252         Globals.lock_file = "/var/run/rsyncd.lock";
253 }
254
255 /***************************************************************************
256 Initialise the sDefault parameter structure.
257 ***************************************************************************/
258 static void init_locals(void)
259 {
260 }
261
262
263 /*
264    In this section all the functions that are used to access the 
265    parameters from the rest of the program are defined 
266 */
267
268 #define FN_GLOBAL_STRING(fn_name,ptr) \
269  char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
270 #define FN_GLOBAL_BOOL(fn_name,ptr) \
271  BOOL fn_name(void) {return(*(BOOL *)(ptr));}
272 #define FN_GLOBAL_CHAR(fn_name,ptr) \
273  char fn_name(void) {return(*(char *)(ptr));}
274 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
275  int fn_name(void) {return(*(int *)(ptr));}
276
277 #define FN_LOCAL_STRING(fn_name,val) \
278  char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
279 #define FN_LOCAL_BOOL(fn_name,val) \
280  BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
281 #define FN_LOCAL_CHAR(fn_name,val) \
282  char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
283 #define FN_LOCAL_INTEGER(fn_name,val) \
284  int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
285
286
287 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
288 FN_GLOBAL_STRING(lp_lock_file, &Globals.lock_file)
289 FN_GLOBAL_INTEGER(lp_max_connections, &Globals.max_connections)
290 FN_GLOBAL_INTEGER(lp_syslog_facility, &Globals.syslog_facility)
291 FN_LOCAL_STRING(lp_name, name)
292 FN_LOCAL_STRING(lp_comment, comment)
293 FN_LOCAL_STRING(lp_path, path)
294 FN_LOCAL_BOOL(lp_read_only, read_only)
295 FN_LOCAL_BOOL(lp_list, list)
296 FN_LOCAL_STRING(lp_uid, uid)
297 FN_LOCAL_STRING(lp_gid, gid)
298 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
299 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
300 FN_LOCAL_STRING(lp_auth_users, auth_users)
301 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
302
303 /* local prototypes */
304 static int    strwicmp( char *psz1, char *psz2 );
305 static int    map_parameter( char *parmname);
306 static BOOL   set_boolean( BOOL *pb, char *parmvalue );
307 static int    getservicebyname(char *name, service *pserviceDest);
308 static void   copy_service( service *pserviceDest, 
309                             service *pserviceSource);
310 static BOOL   do_parameter(char *parmname, char *parmvalue);
311 static BOOL   do_section(char *sectionname);
312
313
314 /***************************************************************************
315 initialise a service to the defaults
316 ***************************************************************************/
317 static void init_service(service *pservice)
318 {
319         bzero((char *)pservice,sizeof(service));
320         copy_service(pservice,&sDefault);
321 }
322
323 static void string_set(char **s, char *v)
324 {
325         if (!v) {
326                 *s = NULL;
327                 return;
328         }
329         *s = strdup(v);
330         if (!*s) exit_cleanup(1);
331 }
332
333
334 /***************************************************************************
335 add a new service to the services array initialising it with the given 
336 service
337 ***************************************************************************/
338 static int add_a_service(service *pservice, char *name)
339 {
340   int i;
341   service tservice;
342   int num_to_alloc = iNumServices+1;
343
344   tservice = *pservice;
345
346   /* it might already exist */
347   if (name) 
348     {
349       i = getservicebyname(name,NULL);
350       if (i >= 0)
351         return(i);
352     }
353
354   i = iNumServices;
355
356   ServicePtrs = (service **)Realloc(ServicePtrs,sizeof(service *)*num_to_alloc);
357   if (ServicePtrs)
358           pSERVICE(iNumServices) = (service *)malloc(sizeof(service));
359
360   if (!ServicePtrs || !pSERVICE(iNumServices))
361           return(-1);
362
363   iNumServices++;
364
365   init_service(pSERVICE(i));
366   copy_service(pSERVICE(i),&tservice);
367   if (name)
368     string_set(&iSERVICE(i).name,name);  
369
370   return(i);
371 }
372
373 /***************************************************************************
374 Do a case-insensitive, whitespace-ignoring string compare.
375 ***************************************************************************/
376 static int strwicmp(char *psz1, char *psz2)
377 {
378    /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
379    /* appropriate value. */
380    if (psz1 == psz2)
381       return (0);
382    else
383       if (psz1 == NULL)
384          return (-1);
385       else
386           if (psz2 == NULL)
387               return (1);
388
389    /* sync the strings on first non-whitespace */
390    while (1)
391    {
392       while (isspace(*psz1))
393          psz1++;
394       while (isspace(*psz2))
395          psz2++;
396       if (toupper(*psz1) != toupper(*psz2) || *psz1 == '\0' || *psz2 == '\0')
397          break;
398       psz1++;
399       psz2++;
400    }
401    return (*psz1 - *psz2);
402 }
403
404 /***************************************************************************
405 Map a parameter's string representation to something we can use. 
406 Returns False if the parameter string is not recognised, else TRUE.
407 ***************************************************************************/
408 static int map_parameter(char *parmname)
409 {
410    int iIndex;
411
412    if (*parmname == '-')
413      return(-1);
414
415    for (iIndex = 0; parm_table[iIndex].label; iIndex++) 
416       if (strwicmp(parm_table[iIndex].label, parmname) == 0)
417          return(iIndex);
418
419    rprintf(FERROR, "Unknown parameter encountered: \"%s\"\n", parmname);
420    return(-1);
421 }
422
423
424 /***************************************************************************
425 Set a boolean variable from the text value stored in the passed string.
426 Returns True in success, False if the passed string does not correctly 
427 represent a boolean.
428 ***************************************************************************/
429 static BOOL set_boolean(BOOL *pb, char *parmvalue)
430 {
431    BOOL bRetval;
432
433    bRetval = True;
434    if (strwicmp(parmvalue, "yes") == 0 ||
435        strwicmp(parmvalue, "true") == 0 ||
436        strwicmp(parmvalue, "1") == 0)
437       *pb = True;
438    else
439       if (strwicmp(parmvalue, "no") == 0 ||
440           strwicmp(parmvalue, "False") == 0 ||
441           strwicmp(parmvalue, "0") == 0)
442          *pb = False;
443       else
444       {
445          rprintf(FERROR, "Badly formed boolean in configuration file: \"%s\".\n",
446                parmvalue);
447          bRetval = False;
448       }
449    return (bRetval);
450 }
451
452 /***************************************************************************
453 Find a service by name. Otherwise works like get_service.
454 ***************************************************************************/
455 static int getservicebyname(char *name, service *pserviceDest)
456 {
457    int iService;
458
459    for (iService = iNumServices - 1; iService >= 0; iService--)
460       if (strwicmp(iSERVICE(iService).name, name) == 0) 
461       {
462          if (pserviceDest != NULL)
463            copy_service(pserviceDest, pSERVICE(iService));
464          break;
465       }
466
467    return (iService);
468 }
469
470
471
472 /***************************************************************************
473 Copy a service structure to another
474
475 ***************************************************************************/
476 static void copy_service(service *pserviceDest, 
477                          service *pserviceSource)
478 {
479   int i;
480
481   for (i=0;parm_table[i].label;i++)
482     if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
483         void *def_ptr = parm_table[i].ptr;
484         void *src_ptr = 
485           ((char *)pserviceSource) + PTR_DIFF(def_ptr,&sDefault);
486         void *dest_ptr = 
487           ((char *)pserviceDest) + PTR_DIFF(def_ptr,&sDefault);
488
489         switch (parm_table[i].type)
490           {
491           case P_BOOL:
492           case P_BOOLREV:
493             *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
494             break;
495
496           case P_INTEGER:
497           case P_ENUM:
498           case P_OCTAL:
499             *(int *)dest_ptr = *(int *)src_ptr;
500             break;
501
502           case P_CHAR:
503             *(char *)dest_ptr = *(char *)src_ptr;
504             break;
505
506           case P_STRING:
507             string_set(dest_ptr,*(char **)src_ptr);
508             break;
509
510           default:
511             break;
512           }
513       }
514 }
515
516
517 /***************************************************************************
518 Process a parameter for a particular service number. If snum < 0
519 then assume we are in the globals
520 ***************************************************************************/
521 static BOOL lp_do_parameter(int snum, char *parmname, char *parmvalue)
522 {
523    int parmnum, i;
524    void *parm_ptr=NULL; /* where we are going to store the result */
525    void *def_ptr=NULL;
526
527    parmnum = map_parameter(parmname);
528
529    if (parmnum < 0)
530      {
531        rprintf(FERROR, "Ignoring unknown parameter \"%s\"\n", parmname);
532        return(True);
533      }
534
535    def_ptr = parm_table[parmnum].ptr;
536
537    /* we might point at a service, the default service or a global */
538    if (snum < 0) {
539      parm_ptr = def_ptr;
540    } else {
541        if (parm_table[parmnum].class == P_GLOBAL) {
542            rprintf(FERROR, "Global parameter %s found in service section!\n",parmname);
543            return(True);
544          }
545        parm_ptr = ((char *)pSERVICE(snum)) + PTR_DIFF(def_ptr,&sDefault);
546    }
547
548    /* now switch on the type of variable it is */
549    switch (parm_table[parmnum].type)
550      {
551      case P_BOOL:
552        set_boolean(parm_ptr,parmvalue);
553        break;
554
555      case P_BOOLREV:
556        set_boolean(parm_ptr,parmvalue);
557        *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
558        break;
559
560      case P_INTEGER:
561        *(int *)parm_ptr = atoi(parmvalue);
562        break;
563
564      case P_CHAR:
565        *(char *)parm_ptr = *parmvalue;
566        break;
567
568      case P_OCTAL:
569        sscanf(parmvalue,"%o",(int *)parm_ptr);
570        break;
571
572      case P_STRING:
573        string_set(parm_ptr,parmvalue);
574        break;
575
576      case P_GSTRING:
577        strcpy((char *)parm_ptr,parmvalue);
578        break;
579
580      case P_ENUM:
581              for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
582                      if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
583                              *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
584                              break;
585                      }
586              }
587              if (!parm_table[parmnum].enum_list[i].name) {
588                      *(int *)parm_ptr = atoi(parmvalue);
589              }
590              break;
591      case P_SEP:
592              break;
593      }
594
595    return(True);
596 }
597
598 /***************************************************************************
599 Process a parameter.
600 ***************************************************************************/
601 static BOOL do_parameter(char *parmname, char *parmvalue)
602 {
603    return lp_do_parameter(bInGlobalSection?-2:iServiceIndex, parmname, parmvalue);
604 }
605
606 /***************************************************************************
607 Process a new section (service). At this stage all sections are services.
608 Later we'll have special sections that permit server parameters to be set.
609 Returns True on success, False on failure.
610 ***************************************************************************/
611 static BOOL do_section(char *sectionname)
612 {
613    BOOL bRetval;
614    BOOL isglobal = (strwicmp(sectionname, GLOBAL_NAME) == 0);
615    bRetval = False;
616
617    /* if we were in a global section then do the local inits */
618    if (bInGlobalSection && !isglobal)
619      init_locals();
620
621    /* if we've just struck a global section, note the fact. */
622    bInGlobalSection = isglobal;   
623
624    /* check for multiple global sections */
625    if (bInGlobalSection)
626    {
627      return(True);
628    }
629
630    /* if we have a current service, tidy it up before moving on */
631    bRetval = True;
632
633    if (iServiceIndex >= 0)
634      bRetval = True;
635
636    /* if all is still well, move to the next record in the services array */
637    if (bRetval)
638      {
639        /* We put this here to avoid an odd message order if messages are */
640        /* issued by the post-processing of a previous section. */
641
642        if ((iServiceIndex=add_a_service(&sDefault,sectionname)) < 0)
643          {
644            rprintf(FERROR,"Failed to add a new service\n");
645            return(False);
646          }
647      }
648
649    return (bRetval);
650 }
651
652
653 /***************************************************************************
654 Load the services array from the services file. Return True on success, 
655 False on failure.
656 ***************************************************************************/
657 BOOL lp_load(char *pszFname)
658 {
659   pstring n2;
660   BOOL bRetval;
661  
662   bRetval = False;
663
664   bInGlobalSection = True;
665   
666   init_globals();
667
668   pstrcpy(n2,pszFname);
669
670   /* We get sections first, so have to start 'behind' to make up */
671   iServiceIndex = -1;
672   bRetval = pm_process(n2, do_section, do_parameter);
673   
674   bLoaded = True;
675
676   return (bRetval);
677 }
678
679
680 /***************************************************************************
681 return the max number of services
682 ***************************************************************************/
683 int lp_numservices(void)
684 {
685   return(iNumServices);
686 }
687
688 /***************************************************************************
689 Return the number of the service with the given name, or -1 if it doesn't
690 exist. Note that this is a DIFFERENT ANIMAL from the internal function
691 getservicebyname()! This works ONLY if all services have been loaded, and
692 does not copy the found service.
693 ***************************************************************************/
694 int lp_number(char *name)
695 {
696    int iService;
697
698    for (iService = iNumServices - 1; iService >= 0; iService--)
699       if (strequal(lp_name(iService), name)) 
700          break;
701
702    return (iService);
703 }
704