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