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
 156 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
 157 static struct parm_struct parm_table[] =
 158 {
 159   {"max connections",  P_INTEGER, P_GLOBAL, &Globals.max_connections,NULL, 0},
 160   {"motd file",        P_STRING,  P_GLOBAL, &Globals.motd_file,    NULL,   0},
 161   {"lock file",        P_STRING,  P_GLOBAL, &Globals.lock_file,    NULL,   0},
 162   {"syslog facility",  P_INTEGER, P_GLOBAL, &Globals.syslog_facility, NULL,0},
 163   {"name",             P_STRING,  P_LOCAL,  &sDefault.name,        NULL,   0},
 164   {"comment",          P_STRING,  P_LOCAL,  &sDefault.comment,     NULL,   0},
 165   {"path",             P_STRING,  P_LOCAL,  &sDefault.path,        NULL,   0},
 166   {"read only",        P_BOOL,    P_LOCAL,  &sDefault.read_only,   NULL,   0},
 167   {"list",             P_BOOL,    P_LOCAL,  &sDefault.list,        NULL,   0},
 168   {"uid",              P_STRING,  P_LOCAL,  &sDefault.uid,         NULL,   0},
 169   {"gid",              P_STRING,  P_LOCAL,  &sDefault.gid,         NULL,   0},
 170   {"hosts allow",      P_STRING,  P_LOCAL,  &sDefault.hosts_allow, NULL,   0},
 171   {"hosts deny",       P_STRING,  P_LOCAL,  &sDefault.hosts_deny,  NULL,   0},
 172   {"auth users",       P_STRING,  P_LOCAL,  &sDefault.auth_users,  NULL,   0},
 173   {"secrets file",     P_STRING,  P_LOCAL,  &sDefault.secrets_file,NULL,   0},
 174   {NULL,               P_BOOL,    P_NONE,   NULL,                  NULL,   0}
 175 };
 176
 177
 178 /***************************************************************************
 179 Initialise the global parameter structure.
 180 ***************************************************************************/
 181 static void init_globals(void)
 182 {
 183 #ifdef LOG_DAEMON
 184         Globals.syslog_facility = LOG_DAEMON;
 185 #endif
 186         Globals.lock_file = "/var/run/rsyncd.lock";
 187 }
 188
 189 /***************************************************************************
 190 Initialise the sDefault parameter structure.
 191 ***************************************************************************/
 192 static void init_locals(void)
 193 {
 194 }
 195
 196
 197 /*
 198    In this section all the functions that are used to access the
 199    parameters from the rest of the program are defined
 200 */
 201
 202 #define FN_GLOBAL_STRING(fn_name,ptr) \
 203  char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
 204 #define FN_GLOBAL_BOOL(fn_name,ptr) \
 205  BOOL fn_name(void) {return(*(BOOL *)(ptr));}
 206 #define FN_GLOBAL_CHAR(fn_name,ptr) \
 207  char fn_name(void) {return(*(char *)(ptr));}
 208 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
 209  int fn_name(void) {return(*(int *)(ptr));}
 210
 211 #define FN_LOCAL_STRING(fn_name,val) \
 212  char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
 213 #define FN_LOCAL_BOOL(fn_name,val) \
 214  BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
 215 #define FN_LOCAL_CHAR(fn_name,val) \
 216  char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
 217 #define FN_LOCAL_INTEGER(fn_name,val) \
 218  int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
 219
 220
 221 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
 222 FN_GLOBAL_STRING(lp_lock_file, &Globals.lock_file)
 223 FN_GLOBAL_INTEGER(lp_max_connections, &Globals.max_connections)
 224 FN_GLOBAL_INTEGER(lp_syslog_facility, &Globals.syslog_facility)
 225 FN_LOCAL_STRING(lp_name, name)
 226 FN_LOCAL_STRING(lp_comment, comment)
 227 FN_LOCAL_STRING(lp_path, path)
 228 FN_LOCAL_BOOL(lp_read_only, read_only)
 229 FN_LOCAL_BOOL(lp_list, list)
 230 FN_LOCAL_STRING(lp_uid, uid)
 231 FN_LOCAL_STRING(lp_gid, gid)
 232 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
 233 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
 234 FN_LOCAL_STRING(lp_auth_users, auth_users)
 235 FN_LOCAL_STRING(lp_secrets_file, secrets_file)
 236
 237 /* local prototypes */
 238 static int    strwicmp( char *psz1, char *psz2 );
 239 static int    map_parameter( char *parmname);
 240 static BOOL   set_boolean( BOOL *pb, char *parmvalue );
 241 static int    getservicebyname(char *name, service *pserviceDest);
 242 static void   copy_service( service *pserviceDest,
 243                             service *pserviceSource);
 244 static BOOL   do_parameter(char *parmname, char *parmvalue);
 245 static BOOL   do_section(char *sectionname);
 246
 247
 248 /***************************************************************************
 249 initialise a service to the defaults
 250 ***************************************************************************/
 251 static void init_service(service *pservice)
 252 {
 253         bzero((char *)pservice,sizeof(service));
 254         copy_service(pservice,&sDefault);
 255 }
 256
 257 static void string_set(char **s, char *v)
 258 {
 259         if (!v) {
 260                 *s = NULL;
 261                 return;
 262         }
 263         *s = strdup(v);
 264         if (!*s) exit_cleanup(1);
 265 }
 266
 267
 268 /***************************************************************************
 269 add a new service to the services array initialising it with the given
 270 service
 271 ***************************************************************************/
 272 static int add_a_service(service *pservice, char *name)
 273 {
 274   int i;
 275   service tservice;
 276   int num_to_alloc = iNumServices+1;
 277
 278   tservice = *pservice;
 279
 280   /* it might already exist */
 281   if (name)
 282     {
 283       i = getservicebyname(name,NULL);
 284       if (i >= 0)
 285         return(i);
 286     }
 287
 288   i = iNumServices;
 289
 290   ServicePtrs = (service **)Realloc(ServicePtrs,sizeof(service *)*num_to_alloc);
 291   if (ServicePtrs)
 292           pSERVICE(iNumServices) = (service *)malloc(sizeof(service));
 293
 294   if (!ServicePtrs || !pSERVICE(iNumServices))
 295           return(-1);
 296
 297   iNumServices++;
 298
 299   init_service(pSERVICE(i));
 300   copy_service(pSERVICE(i),&tservice);
 301   if (name)
 302     string_set(&iSERVICE(i).name,name);
 303
 304   return(i);
 305 }
 306
 307 /***************************************************************************
 308 Do a case-insensitive, whitespace-ignoring string compare.
 309 ***************************************************************************/
 310 static int strwicmp(char *psz1, char *psz2)
 311 {
 312    /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
 313    /* appropriate value. */
 314    if (psz1 == psz2)
 315       return (0);
 316    else
 317       if (psz1 == NULL)
 318          return (-1);
 319       else
 320           if (psz2 == NULL)
 321               return (1);
 322
 323    /* sync the strings on first non-whitespace */
 324    while (1)
 325    {
 326       while (isspace(*psz1))
 327          psz1++;
 328       while (isspace(*psz2))
 329          psz2++;
 330       if (toupper(*psz1) != toupper(*psz2) || *psz1 == '\0' || *psz2 == '\0')
 331          break;
 332       psz1++;
 333       psz2++;
 334    }
 335    return (*psz1 - *psz2);
 336 }
 337
 338 /***************************************************************************
 339 Map a parameter's string representation to something we can use.
 340 Returns False if the parameter string is not recognised, else TRUE.
 341 ***************************************************************************/
 342 static int map_parameter(char *parmname)
 343 {
 344    int iIndex;
 345
 346    if (*parmname == '-')
 347      return(-1);
 348
 349    for (iIndex = 0; parm_table[iIndex].label; iIndex++)
 350       if (strwicmp(parm_table[iIndex].label, parmname) == 0)
 351          return(iIndex);
 352
 353    rprintf(FERROR, "Unknown parameter encountered: \"%s\"\n", parmname);
 354    return(-1);
 355 }
 356
 357
 358 /***************************************************************************
 359 Set a boolean variable from the text value stored in the passed string.
 360 Returns True in success, False if the passed string does not correctly
 361 represent a boolean.
 362 ***************************************************************************/
 363 static BOOL set_boolean(BOOL *pb, char *parmvalue)
 364 {
 365    BOOL bRetval;
 366
 367    bRetval = True;
 368    if (strwicmp(parmvalue, "yes") == 0 ||
 369        strwicmp(parmvalue, "true") == 0 ||
 370        strwicmp(parmvalue, "1") == 0)
 371       *pb = True;
 372    else
 373       if (strwicmp(parmvalue, "no") == 0 ||
 374           strwicmp(parmvalue, "False") == 0 ||
 375           strwicmp(parmvalue, "0") == 0)
 376          *pb = False;
 377       else
 378       {
 379          rprintf(FERROR, "Badly formed boolean in configuration file: \"%s\".\n",
 380                parmvalue);
 381          bRetval = False;
 382       }
 383    return (bRetval);
 384 }
 385
 386 /***************************************************************************
 387 Find a service by name. Otherwise works like get_service.
 388 ***************************************************************************/
 389 static int getservicebyname(char *name, service *pserviceDest)
 390 {
 391    int iService;
 392
 393    for (iService = iNumServices - 1; iService >= 0; iService--)
 394       if (strwicmp(iSERVICE(iService).name, name) == 0)
 395       {
 396          if (pserviceDest != NULL)
 397            copy_service(pserviceDest, pSERVICE(iService));
 398          break;
 399       }
 400
 401    return (iService);
 402 }
 403
 404
 405
 406 /***************************************************************************
 407 Copy a service structure to another
 408
 409 ***************************************************************************/
 410 static void copy_service(service *pserviceDest,
 411                          service *pserviceSource)
 412 {
 413   int i;
 414
 415   for (i=0;parm_table[i].label;i++)
 416     if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
 417         void *def_ptr = parm_table[i].ptr;
 418         void *src_ptr =
 419           ((char *)pserviceSource) + PTR_DIFF(def_ptr,&sDefault);
 420         void *dest_ptr =
 421           ((char *)pserviceDest) + PTR_DIFF(def_ptr,&sDefault);
 422
 423         switch (parm_table[i].type)
 424           {
 425           case P_BOOL:
 426           case P_BOOLREV:
 427             *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
 428             break;
 429
 430           case P_INTEGER:
 431           case P_ENUM:
 432           case P_OCTAL:
 433             *(int *)dest_ptr = *(int *)src_ptr;
 434             break;
 435
 436           case P_CHAR:
 437             *(char *)dest_ptr = *(char *)src_ptr;
 438             break;
 439
 440           case P_STRING:
 441             string_set(dest_ptr,*(char **)src_ptr);
 442             break;
 443
 444           default:
 445             break;
 446           }
 447       }
 448 }
 449
 450
 451 /***************************************************************************
 452 Process a parameter for a particular service number. If snum < 0
 453 then assume we are in the globals
 454 ***************************************************************************/
 455 static BOOL lp_do_parameter(int snum, char *parmname, char *parmvalue)
 456 {
 457    int parmnum, i;
 458    void *parm_ptr=NULL; /* where we are going to store the result */
 459    void *def_ptr=NULL;
 460
 461    parmnum = map_parameter(parmname);
 462
 463    if (parmnum < 0)
 464      {
 465        rprintf(FERROR, "Ignoring unknown parameter \"%s\"\n", parmname);
 466        return(True);
 467      }
 468
 469    def_ptr = parm_table[parmnum].ptr;
 470
 471    /* we might point at a service, the default service or a global */
 472    if (snum < 0) {
 473      parm_ptr = def_ptr;
 474    } else {
 475        if (parm_table[parmnum].class == P_GLOBAL) {
 476            rprintf(FERROR, "Global parameter %s found in service section!\n",parmname);
 477            return(True);
 478          }
 479        parm_ptr = ((char *)pSERVICE(snum)) + PTR_DIFF(def_ptr,&sDefault);
 480    }
 481
 482    /* now switch on the type of variable it is */
 483    switch (parm_table[parmnum].type)
 484      {
 485      case P_BOOL:
 486        set_boolean(parm_ptr,parmvalue);
 487        break;
 488
 489      case P_BOOLREV:
 490        set_boolean(parm_ptr,parmvalue);
 491        *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
 492        break;
 493
 494      case P_INTEGER:
 495        *(int *)parm_ptr = atoi(parmvalue);
 496        break;
 497
 498      case P_CHAR:
 499        *(char *)parm_ptr = *parmvalue;
 500        break;
 501
 502      case P_OCTAL:
 503        sscanf(parmvalue,"%o",(int *)parm_ptr);
 504        break;
 505
 506      case P_STRING:
 507        string_set(parm_ptr,parmvalue);
 508        break;
 509
 510      case P_GSTRING:
 511        strcpy((char *)parm_ptr,parmvalue);
 512        break;
 513
 514      case P_ENUM:
 515              for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
 516                      if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
 517                              *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
 518                              break;
 519                      }
 520              }
 521              break;
 522      case P_SEP:
 523              break;
 524      }
 525
 526    return(True);
 527 }
 528
 529 /***************************************************************************
 530 Process a parameter.
 531 ***************************************************************************/
 532 static BOOL do_parameter(char *parmname, char *parmvalue)
 533 {
 534    return lp_do_parameter(bInGlobalSection?-2:iServiceIndex, parmname, parmvalue);
 535 }
 536
 537 /***************************************************************************
 538 Process a new section (service). At this stage all sections are services.
 539 Later we'll have special sections that permit server parameters to be set.
 540 Returns True on success, False on failure.
 541 ***************************************************************************/
 542 static BOOL do_section(char *sectionname)
 543 {
 544    BOOL bRetval;
 545    BOOL isglobal = (strwicmp(sectionname, GLOBAL_NAME) == 0);
 546    bRetval = False;
 547
 548    /* if we were in a global section then do the local inits */
 549    if (bInGlobalSection && !isglobal)
 550      init_locals();
 551
 552    /* if we've just struck a global section, note the fact. */
 553    bInGlobalSection = isglobal;
 554
 555    /* check for multiple global sections */
 556    if (bInGlobalSection)
 557    {
 558      return(True);
 559    }
 560
 561    /* if we have a current service, tidy it up before moving on */
 562    bRetval = True;
 563
 564    if (iServiceIndex >= 0)
 565      bRetval = True;
 566
 567    /* if all is still well, move to the next record in the services array */
 568    if (bRetval)
 569      {
 570        /* We put this here to avoid an odd message order if messages are */
 571        /* issued by the post-processing of a previous section. */
 572
 573        if ((iServiceIndex=add_a_service(&sDefault,sectionname)) < 0)
 574          {
 575            rprintf(FERROR,"Failed to add a new service\n");
 576            return(False);
 577          }
 578      }
 579
 580    return (bRetval);
 581 }
 582
 583
 584 /***************************************************************************
 585 Load the services array from the services file. Return True on success,
 586 False on failure.
 587 ***************************************************************************/
 588 BOOL lp_load(char *pszFname)
 589 {
 590   pstring n2;
 591   BOOL bRetval;
 592
 593   bRetval = False;
 594
 595   bInGlobalSection = True;
 596
 597   init_globals();
 598
 599   pstrcpy(n2,pszFname);
 600
 601   /* We get sections first, so have to start 'behind' to make up */
 602   iServiceIndex = -1;
 603   bRetval = pm_process(n2, do_section, do_parameter);
 604
 605   bLoaded = True;
 606
 607   return (bRetval);
 608 }
 609
 610
 611 /***************************************************************************
 612 return the max number of services
 613 ***************************************************************************/
 614 int lp_numservices(void)
 615 {
 616   return(iNumServices);
 617 }
 618
 619 /***************************************************************************
 620 Return the number of the service with the given name, or -1 if it doesn't
 621 exist. Note that this is a DIFFERENT ANIMAL from the internal function
 622 getservicebyname()! This works ONLY if all services have been loaded, and
 623 does not copy the found service.
 624 ***************************************************************************/
 625 int lp_number(char *name)
 626 {
 627    int iService;
 628
 629    for (iService = iNumServices - 1; iService >= 0; iService--)
 630       if (strequal(lp_name(iService), name))
 631          break;
 632
 633    return (iService);
 634 }
 635