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 as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
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.
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.
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.
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
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
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)
57 /* the following are used by loadparm for option lists */
60 P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,
61 P_STRING,P_GSTRING,P_ENUM,P_SEP
66 P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
80 struct enum_list *enum_list;
84 static BOOL bLoaded = False;
87 #define GLOBAL_NAME "global"
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))
96 * This structure describes global (ie., server-wide) parameters.
104 static global Globals;
109 * This structure describes a single service.
125 /* This is a default service used to prime a services structure */
126 static service sDefault =
131 True, /* read only */
135 NULL, /* hosts allow */
136 NULL, /* hosts deny */
141 /* local variables */
142 static service **ServicePtrs = NULL;
143 static int iNumServices = 0;
144 static int iServiceIndex = 0;
145 static BOOL bInGlobalSection = True;
147 #define NUMPARAMETERS (sizeof(parm_table) / sizeof(struct parm_struct))
150 /* note that we do not initialise the defaults union - it is not allowed in ANSI C */
151 static struct parm_struct parm_table[] =
153 {"motd file", P_STRING, P_GLOBAL, &Globals.motd_file, NULL, 0},
154 {"syslog facility", P_INTEGER, P_GLOBAL, &Globals.syslog_facility, NULL,0},
155 {"name", P_STRING, P_LOCAL, &sDefault.name, NULL, 0},
156 {"comment", P_STRING, P_LOCAL, &sDefault.comment, NULL, 0},
157 {"path", P_STRING, P_LOCAL, &sDefault.path, NULL, 0},
158 {"read only", P_BOOL, P_LOCAL, &sDefault.read_only, NULL, 0},
159 {"list", P_BOOL, P_LOCAL, &sDefault.list, NULL, 0},
160 {"uid", P_STRING, P_LOCAL, &sDefault.uid, NULL, 0},
161 {"gid", P_STRING, P_LOCAL, &sDefault.gid, NULL, 0},
162 {"hosts allow", P_STRING, P_LOCAL, &sDefault.hosts_allow, NULL, 0},
163 {"hosts deny", P_STRING, P_LOCAL, &sDefault.hosts_deny, NULL, 0},
164 {NULL, P_BOOL, P_NONE, NULL, NULL, 0}
168 /***************************************************************************
169 Initialise the global parameter structure.
170 ***************************************************************************/
171 static void init_globals(void)
174 Globals.syslog_facility = LOG_DAEMON;
178 /***************************************************************************
179 Initialise the sDefault parameter structure.
180 ***************************************************************************/
181 static void init_locals(void)
187 In this section all the functions that are used to access the
188 parameters from the rest of the program are defined
191 #define FN_GLOBAL_STRING(fn_name,ptr) \
192 char *fn_name(void) {return(*(char **)(ptr) ? *(char **)(ptr) : "");}
193 #define FN_GLOBAL_BOOL(fn_name,ptr) \
194 BOOL fn_name(void) {return(*(BOOL *)(ptr));}
195 #define FN_GLOBAL_CHAR(fn_name,ptr) \
196 char fn_name(void) {return(*(char *)(ptr));}
197 #define FN_GLOBAL_INTEGER(fn_name,ptr) \
198 int fn_name(void) {return(*(int *)(ptr));}
200 #define FN_LOCAL_STRING(fn_name,val) \
201 char *fn_name(int i) {return((LP_SNUM_OK(i)&&pSERVICE(i)->val)?pSERVICE(i)->val : (sDefault.val?sDefault.val:""));}
202 #define FN_LOCAL_BOOL(fn_name,val) \
203 BOOL fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
204 #define FN_LOCAL_CHAR(fn_name,val) \
205 char fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
206 #define FN_LOCAL_INTEGER(fn_name,val) \
207 int fn_name(int i) {return(LP_SNUM_OK(i)? pSERVICE(i)->val : sDefault.val);}
210 FN_GLOBAL_STRING(lp_motd_file, &Globals.motd_file)
211 FN_GLOBAL_INTEGER(lp_syslog_facility, &Globals.syslog_facility)
212 FN_LOCAL_STRING(lp_name, name)
213 FN_LOCAL_STRING(lp_comment, comment)
214 FN_LOCAL_STRING(lp_path, path)
215 FN_LOCAL_BOOL(lp_read_only, read_only)
216 FN_LOCAL_BOOL(lp_list, list)
217 FN_LOCAL_STRING(lp_uid, uid)
218 FN_LOCAL_STRING(lp_gid, gid)
219 FN_LOCAL_STRING(lp_hosts_allow, hosts_allow)
220 FN_LOCAL_STRING(lp_hosts_deny, hosts_deny)
222 /* local prototypes */
223 static int strwicmp( char *psz1, char *psz2 );
224 static int map_parameter( char *parmname);
225 static BOOL set_boolean( BOOL *pb, char *parmvalue );
226 static int getservicebyname(char *name, service *pserviceDest);
227 static void copy_service( service *pserviceDest,
228 service *pserviceSource);
229 static BOOL do_parameter(char *parmname, char *parmvalue);
230 static BOOL do_section(char *sectionname);
233 /***************************************************************************
234 initialise a service to the defaults
235 ***************************************************************************/
236 static void init_service(service *pservice)
238 bzero((char *)pservice,sizeof(service));
239 copy_service(pservice,&sDefault);
242 static void string_set(char **s, char *v)
249 if (!*s) exit_cleanup(1);
253 /***************************************************************************
254 add a new service to the services array initialising it with the given
256 ***************************************************************************/
257 static int add_a_service(service *pservice, char *name)
261 int num_to_alloc = iNumServices+1;
263 tservice = *pservice;
265 /* it might already exist */
268 i = getservicebyname(name,NULL);
275 ServicePtrs = (service **)Realloc(ServicePtrs,sizeof(service *)*num_to_alloc);
277 pSERVICE(iNumServices) = (service *)malloc(sizeof(service));
279 if (!ServicePtrs || !pSERVICE(iNumServices))
284 init_service(pSERVICE(i));
285 copy_service(pSERVICE(i),&tservice);
287 string_set(&iSERVICE(i).name,name);
292 /***************************************************************************
293 Do a case-insensitive, whitespace-ignoring string compare.
294 ***************************************************************************/
295 static int strwicmp(char *psz1, char *psz2)
297 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
298 /* appropriate value. */
308 /* sync the strings on first non-whitespace */
311 while (isspace(*psz1))
313 while (isspace(*psz2))
315 if (toupper(*psz1) != toupper(*psz2) || *psz1 == '\0' || *psz2 == '\0')
320 return (*psz1 - *psz2);
323 /***************************************************************************
324 Map a parameter's string representation to something we can use.
325 Returns False if the parameter string is not recognised, else TRUE.
326 ***************************************************************************/
327 static int map_parameter(char *parmname)
331 if (*parmname == '-')
334 for (iIndex = 0; parm_table[iIndex].label; iIndex++)
335 if (strwicmp(parm_table[iIndex].label, parmname) == 0)
338 rprintf(FERROR, "Unknown parameter encountered: \"%s\"\n", parmname);
343 /***************************************************************************
344 Set a boolean variable from the text value stored in the passed string.
345 Returns True in success, False if the passed string does not correctly
347 ***************************************************************************/
348 static BOOL set_boolean(BOOL *pb, char *parmvalue)
353 if (strwicmp(parmvalue, "yes") == 0 ||
354 strwicmp(parmvalue, "true") == 0 ||
355 strwicmp(parmvalue, "1") == 0)
358 if (strwicmp(parmvalue, "no") == 0 ||
359 strwicmp(parmvalue, "False") == 0 ||
360 strwicmp(parmvalue, "0") == 0)
364 rprintf(FERROR, "Badly formed boolean in configuration file: \"%s\".\n",
371 /***************************************************************************
372 Find a service by name. Otherwise works like get_service.
373 ***************************************************************************/
374 static int getservicebyname(char *name, service *pserviceDest)
378 for (iService = iNumServices - 1; iService >= 0; iService--)
379 if (strwicmp(iSERVICE(iService).name, name) == 0)
381 if (pserviceDest != NULL)
382 copy_service(pserviceDest, pSERVICE(iService));
391 /***************************************************************************
392 Copy a service structure to another
394 ***************************************************************************/
395 static void copy_service(service *pserviceDest,
396 service *pserviceSource)
400 for (i=0;parm_table[i].label;i++)
401 if (parm_table[i].ptr && parm_table[i].class == P_LOCAL) {
402 void *def_ptr = parm_table[i].ptr;
404 ((char *)pserviceSource) + PTR_DIFF(def_ptr,&sDefault);
406 ((char *)pserviceDest) + PTR_DIFF(def_ptr,&sDefault);
408 switch (parm_table[i].type)
412 *(BOOL *)dest_ptr = *(BOOL *)src_ptr;
418 *(int *)dest_ptr = *(int *)src_ptr;
422 *(char *)dest_ptr = *(char *)src_ptr;
426 string_set(dest_ptr,*(char **)src_ptr);
436 /***************************************************************************
437 Process a parameter for a particular service number. If snum < 0
438 then assume we are in the globals
439 ***************************************************************************/
440 static BOOL lp_do_parameter(int snum, char *parmname, char *parmvalue)
443 void *parm_ptr=NULL; /* where we are going to store the result */
446 parmnum = map_parameter(parmname);
450 rprintf(FERROR, "Ignoring unknown parameter \"%s\"\n", parmname);
454 def_ptr = parm_table[parmnum].ptr;
456 /* we might point at a service, the default service or a global */
460 if (parm_table[parmnum].class == P_GLOBAL) {
461 rprintf(FERROR, "Global parameter %s found in service section!\n",parmname);
464 parm_ptr = ((char *)pSERVICE(snum)) + PTR_DIFF(def_ptr,&sDefault);
467 /* now switch on the type of variable it is */
468 switch (parm_table[parmnum].type)
471 set_boolean(parm_ptr,parmvalue);
475 set_boolean(parm_ptr,parmvalue);
476 *(BOOL *)parm_ptr = ! *(BOOL *)parm_ptr;
480 *(int *)parm_ptr = atoi(parmvalue);
484 *(char *)parm_ptr = *parmvalue;
488 sscanf(parmvalue,"%o",(int *)parm_ptr);
492 string_set(parm_ptr,parmvalue);
496 strcpy((char *)parm_ptr,parmvalue);
500 for (i=0;parm_table[parmnum].enum_list[i].name;i++) {
501 if (strequal(parmvalue, parm_table[parmnum].enum_list[i].name)) {
502 *(int *)parm_ptr = parm_table[parmnum].enum_list[i].value;
514 /***************************************************************************
516 ***************************************************************************/
517 static BOOL do_parameter(char *parmname, char *parmvalue)
519 return lp_do_parameter(bInGlobalSection?-2:iServiceIndex, parmname, parmvalue);
522 /***************************************************************************
523 Process a new section (service). At this stage all sections are services.
524 Later we'll have special sections that permit server parameters to be set.
525 Returns True on success, False on failure.
526 ***************************************************************************/
527 static BOOL do_section(char *sectionname)
530 BOOL isglobal = (strwicmp(sectionname, GLOBAL_NAME) == 0);
533 /* if we were in a global section then do the local inits */
534 if (bInGlobalSection && !isglobal)
537 /* if we've just struck a global section, note the fact. */
538 bInGlobalSection = isglobal;
540 /* check for multiple global sections */
541 if (bInGlobalSection)
546 /* if we have a current service, tidy it up before moving on */
549 if (iServiceIndex >= 0)
552 /* if all is still well, move to the next record in the services array */
555 /* We put this here to avoid an odd message order if messages are */
556 /* issued by the post-processing of a previous section. */
558 if ((iServiceIndex=add_a_service(&sDefault,sectionname)) < 0)
560 rprintf(FERROR,"Failed to add a new service\n");
569 /***************************************************************************
570 Load the services array from the services file. Return True on success,
572 ***************************************************************************/
573 BOOL lp_load(char *pszFname)
580 bInGlobalSection = True;
584 pstrcpy(n2,pszFname);
586 /* We get sections first, so have to start 'behind' to make up */
588 bRetval = pm_process(n2, do_section, do_parameter);
596 /***************************************************************************
597 return the max number of services
598 ***************************************************************************/
599 int lp_numservices(void)
601 return(iNumServices);
604 /***************************************************************************
605 Return the number of the service with the given name, or -1 if it doesn't
606 exist. Note that this is a DIFFERENT ANIMAL from the internal function
607 getservicebyname()! This works ONLY if all services have been loaded, and
608 does not copy the found service.
609 ***************************************************************************/
610 int lp_number(char *name)
614 for (iService = iNumServices - 1; iService >= 0; iService--)
615 if (strequal(lp_name(iService), name))