1 /* $Cambridge: exim/src/src/buildconfig.c,v 1.16 2010/06/06 02:46:13 pdp Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2009 */
8 /* See the file NOTICE for conditions of use and distribution. */
11 /*************************************************
12 * Build configuration header for Exim *
13 *************************************************/
15 /* This auxiliary program builds the file config.h by the following
18 First, it determines the size of off_t and time_t variables, and generates
19 macro code to define OFF_T_FMT and TIME_T_FMT as suitable formats, if they are
20 not already defined in the system-specific header file.
22 Then it reads Makefile, looking for certain OS-specific definitions which it
23 uses to define some specific macros. Finally, it reads the defaults file
26 The defaults file contains normal C #define statements for various macros; if
27 the name of a macro is found in the environment, the environment value replaces
28 the default. If the default #define does not contain any value, then that macro
29 is not copied to the created file unless there is some value in the
32 This program is compiled and run as part of the Make process and is not
33 normally called independently. */
40 #include <sys/types.h>
54 static char *db_opts[] = { "", "USE_DB", "USE_GDBM", "USE_TDB" };
56 static int have_ipv6 = 0;
57 static int have_iconv = 0;
59 static char errno_quota[256];
60 static char ostype[256];
63 /* If any entry is an initial substring of another, the longer one must
66 static have_item have_list[] = {
67 { "HAVE_IPV6", &have_ipv6 },
68 { "HAVE_ICONV", &have_iconv },
72 static save_item save_list[] = {
73 { "ERRNO_QUOTA", errno_quota },
80 /* Subroutine to check a string for precisely one instance of "%s". If not,
84 check_percent_ess(char *value, char *name)
87 char *p = strstr(value, "%s");
88 if (p != NULL) OK = strstr(p+2, "%s") == NULL;
91 printf("\n*** \"%s\" (%s) must contain precisely one occurrence of\n"
92 "*** \"%%s\". Please review your build-time configuration.\n\n/", value,
102 main(int argc, char **argv)
104 off_t test_off_t = 0;
105 time_t test_time_t = 0;
108 int last_initial = 'A';
111 int in_local_makefile = 0;
112 int use_which_db = 0;
113 int use_which_db_in_local_makefile = 0;
114 int support_crypteq = 0;
119 printf("*** Buildconfig: called with incorrect arguments\n");
123 new = fopen("config.h", "wb");
126 printf("*** Buildconfig: failed to open config.h for output\n");
130 printf("Building configuration file config.h\n");
132 fprintf(new, "/*************************************************\n");
133 fprintf(new, "* Configuration header for Exim *\n");
134 fprintf(new, "*************************************************/\n\n");
136 fprintf(new, "/* This file was automatically generated from Makefile and "
137 "config.h.defaults,\n");
138 fprintf(new, "using values specified in the configuration file Local/Makefile.\n");
139 fprintf(new, "Do not edit it. Instead, edit Local/Makefile and "
140 "rerun make. */\n\n");
142 /* First, deal with the printing format for off_t variables. We assume that if
143 the size of off_t is greater than 4, "%lld" will be available as a format for
144 printing long long variables, and there will be support for the long long type.
145 This assumption is known to be OK for the common operating systems. */
147 fprintf(new, "#ifndef OFF_T_FMT\n");
148 if (sizeof(test_off_t) > 4)
150 fprintf(new, "#define OFF_T_FMT \"%%lld\"\n");
151 fprintf(new, "#define LONGLONG_T long long int\n");
155 fprintf(new, "#define OFF_T_FMT \"%%ld\"\n");
156 fprintf(new, "#define LONGLONG_T long int\n");
158 fprintf(new, "#endif\n\n");
160 /* Now do the same thing for time_t variables. If the length is greater than
161 4, we want to assume long long support (even if off_t was less than 4). If the
162 length is 4 or less, we can leave LONGLONG_T to whatever was defined above for
165 fprintf(new, "#ifndef TIME_T_FMT\n");
166 if (sizeof(test_time_t) > 4)
168 fprintf(new, "#define TIME_T_FMT \"%%lld\"\n");
169 fprintf(new, "#undef LONGLONG_T\n");
170 fprintf(new, "#define LONGLONG_T long long int\n");
174 fprintf(new, "#define TIME_T_FMT \"%%ld\"\n");
176 fprintf(new, "#endif\n\n");
178 /* Now search the makefile for certain settings */
180 base = fopen("Makefile", "rb");
183 printf("*** Buildconfig: failed to open Makefile\n");
188 errno_quota[0] = 0; /* no over-riding value set */
189 ostype[0] = 0; /* just in case */
192 while (fgets(buffer, sizeof(buffer), base) != NULL)
197 char *p = buffer + (int)strlen(buffer);
199 while (p > buffer && isspace((unsigned char)p[-1])) p--;
202 while (isspace((unsigned char)*p)) p++;
204 /* Notice when we hit the user's makefile */
206 if (strcmp(p, "# From Local/Makefile") == 0)
208 in_local_makefile = 1;
212 /* Remember the last DB option setting. If we hit two in the user's
213 Makefile, complain. */
215 for (i = 1; i < sizeof(db_opts)/sizeof(char *); i++)
217 int len = (int)strlen(db_opts[i]);
218 if (strncmp(p, db_opts[i], len) == 0 && (p[len] == ' ' || p[len] == '='))
220 if (in_local_makefile)
222 if (use_which_db_in_local_makefile)
224 printf("*** Only one of USE_DB, USE_GDBM, or USE_TDB should be "
225 "defined in Local/Makefile\n");
228 use_which_db_in_local_makefile = 1;
234 if (i < sizeof(db_opts)/sizeof(char *)) continue;
236 /* Items where we just save a boolean */
238 for (h = have_list; h->name != NULL; h++)
240 int len = (int)strlen(h->name);
241 if (strncmp(p, h->name, len) == 0)
244 while (isspace((unsigned char)*p)) p++;
247 printf("*** Buildconfig: syntax error in Makefile line %d\n", linecount);
250 while (isspace((unsigned char)*p)) p++;
251 if (strcmp(p, "YES") == 0 || strcmp(p, "yes") == 0) *(h->flag) = 1;
252 else *(h->flag) = 0; /* Must reset in case multiple instances */
257 if (h->name != NULL) continue;
259 /* Items where we save the complete string */
261 for (s = save_list; s->name != NULL; s++)
263 int len = (int)strlen(s->name);
264 if (strncmp(p, s->name, len) == 0)
267 while (isspace((unsigned char)*p)) p++;
270 printf("*** Buildconfig: syntax error in Makefile line %d\n", linecount);
273 while (isspace((unsigned char)*p)) p++;
279 fprintf(new, "#define HAVE_IPV6 %s\n",
280 have_ipv6? "TRUE" : "FALSE");
282 fprintf(new, "#define HAVE_ICONV %s\n",
283 have_iconv? "TRUE" : "FALSE");
285 if (errno_quota[0] != 0)
286 fprintf(new, "\n#define ERRNO_QUOTA %s\n", errno_quota);
288 if (strcmp(cc, "gcc") == 0 &&
289 (strstr(ostype, "IRIX") != NULL || strstr(ostype, "AIX") != NULL))
291 fprintf(new, "\n/* This switch includes the code to fix the inet_ntoa() */");
292 fprintf(new, "\n/* bug when using gcc on an IRIX or AIX system. */");
293 fprintf(new, "\n#define USE_INET_NTOA_FIX");
300 /* Now handle the macros listed in the defaults */
302 base = fopen("../src/config.h.defaults", "rb");
305 printf("*** Buildconfig: failed to open ../src/config.h.defaults\n");
310 while (fgets(buffer, sizeof(buffer), base) != NULL)
318 while (*p == ' ' || *p == '\t') p++;
320 if (strncmp(p, "#define ", 8) != 0) continue;
323 while (*p == ' ' || *p == '\t') p++;
325 if (*p < last_initial) fprintf(new, "\n");
328 while (*p && (isalnum((unsigned char)*p) || *p == '_')) *q++ = *p++;
331 /* USE_DB, USE_GDBM, and USE_TDB are special cases. We want to have only
332 one of them set. The scan of the Makefile has saved which was the last one
335 for (i = 1; i < sizeof(db_opts)/sizeof(char *); i++)
337 if (strcmp(name, db_opts[i]) == 0)
339 if (use_which_db == i)
340 fprintf(new, "#define %s %.*syes\n", db_opts[i],
341 21 - (int)strlen(db_opts[i]), " ");
343 fprintf(new, "/* %s not set */\n", name);
347 if (i < sizeof(db_opts)/sizeof(char *)) continue;
349 /* EXIM_USER is a special case. We look in the environment for EXIM_USER or
350 EXIM_UID (the latter for backward compatibility with Exim 3). If the value is
351 not numeric, we look up the user, and default the GID if found. Otherwise,
352 EXIM_GROUP or EXIM_GID must be in the environment. */
354 if (strcmp(name, "EXIM_UID") == 0)
360 char *username = NULL;
361 char *groupname = NULL;
363 char *user = getenv("EXIM_USER");
364 char *group = getenv("EXIM_GROUP");
366 if (user == NULL) user = getenv("EXIM_UID");
367 if (group == NULL) group = getenv("EXIM_GID");
371 printf("\n*** EXIM_USER has not been defined in any of the Makefiles in "
372 "the\n \"Local\" directory. Please review your build-time "
373 "configuration.\n\n");
377 while (isspace((unsigned char)(*user))) user++;
380 printf("\n*** EXIM_USER is defined as an empty string in one of the "
381 "files\n in the \"Local\" directory. Please review your build-time"
382 "\n configuration.\n\n");
386 for (s = user; *s != 0; s++)
388 if (iscntrl((unsigned char)(*s)))
390 printf("\n*** EXIM_USER contains the control character 0x%02X in one "
391 "of the files\n in the \"Local\" directory. Please review your "
392 "build-time\n configuration.\n\n", *s);
397 /* Numeric uid given */
399 if (user[strspn(user, "0123456789")] == 0)
401 uid = (uid_t)atoi(user);
404 /* User name given. Normally, we look up the uid right away. However,
405 people building binary distributions sometimes want to retain the name till
406 runtime. This is supported if the name begins "ref:". */
408 else if (strncmp(user, "ref:", 4) == 0)
411 while (isspace(*user)) user++;
419 struct passwd *pw = getpwnam(user);
422 printf("\n*** User \"%s\" (specified in one of the Makefiles) does not "
423 "exist.\n Please review your build-time configuration.\n\n",
433 /* Use explicit group if set. */
437 while (isspace((unsigned char)(*group))) group++;
440 printf("\n*** EXIM_GROUP is defined as an empty string in one of "
441 "the files in the\n \"Local\" directory. ");
444 printf("If you want the Exim group to be taken from the\n "
445 "password data for the Exim user, just remove the EXIM_GROUP "
446 "setting.\n Otherwise, p");
448 else printf("EXIM_USER is defined numerically, so there is no"
449 "\n default for EXIM_GROUP and you must set it explicitly.\n P");
450 printf("lease review your build-time configuration.\n\n");
454 for (s = group; *s != 0; s++)
456 if (iscntrl((unsigned char)(*s)))
458 printf("\n*** EXIM_GROUP contains the control character 0x%02X in one "
459 "of the files\n in the \"Local\" directory. Please review your "
460 "build-time\n configuration.\n\n", *s);
465 /* Group name given. This may be by reference or to be looked up now,
468 if (strncmp(group, "ref:", 4) == 0)
471 while (isspace(*group)) group++;
475 else if (username != NULL)
480 else if (group[strspn(group, "0123456789")] == 0)
482 gid = (gid_t)atoi(group);
487 struct group *gr = getgrnam(group);
490 printf("\n*** Group \"%s\" (specified in one of the Makefiles) does "
491 "not exist.\n Please review your build-time configuration.\n\n",
499 /* Else trouble unless found in passwd file with user */
503 printf("\n*** No group set for Exim. Please review your build-time "
504 "configuration.\n\n");
508 /* security sanity checks
509 if ref: is being used, we can never be sure, but we can take reasonable
510 steps to filter out the most obvious ones. */
512 if ((!uid_not_set && uid == 0) ||
513 (strcmp(username, "root") == 0) ||
514 (strcmp(username, "toor") == 0) )
516 printf("\n*** Exim's internal user must not be root.\n\n");
520 /* Output user and group names or uid/gid. When names are set, uid/gid
521 are set to zero but will be replaced at runtime. */
523 if (username != NULL)
524 fprintf(new, "#define EXIM_USERNAME \"%s\"\n", username);
525 if (groupname != NULL)
526 fprintf(new, "#define EXIM_GROUPNAME \"%s\"\n", groupname);
528 fprintf(new, "#define EXIM_UID %d\n", (int)uid);
529 fprintf(new, "#define EXIM_GID %d\n", (int)gid);
533 /* CONFIGURE_OWNER and CONFIGURE_GROUP are special cases. We look in the
534 environment for first. If the value is not numeric, we look up the user or
535 group. A lot of this code is similar to that for EXIM_USER, but it's easier
536 to keep it separate. */
538 if (strcmp(name, "CONFIGURE_OWNER") == 0 ||
539 strcmp(name, "CONFIGURE_GROUP") == 0)
541 int isgroup = name[10] == 'G';
545 char *username = NULL;
546 char *user = getenv(name);
548 if (user == NULL) user = "";
549 while (isspace((unsigned char)(*user))) user++;
552 fprintf(new, "/* %s not set */\n", name);
556 for (s = user; *s != 0; s++)
558 if (iscntrl((unsigned char)(*s)))
560 printf("\n*** %s contains the control character 0x%02X in "
561 "one of the files\n in the \"Local\" directory. Please review "
562 "your build-time\n configuration.\n\n", name, *s);
567 /* Numeric uid given */
569 if (user[strspn(user, "0123456789")] == 0)
572 gid = (gid_t)atoi(user);
574 uid = (uid_t)atoi(user);
577 /* Name given. Normally, we look up the uid or gid right away. However,
578 people building binary distributions sometimes want to retain the name till
579 runtime. This is supported if the name begins "ref:". */
581 else if (strncmp(user, "ref:", 4) == 0)
584 while (isspace(*user)) user++;
590 struct group *gr = getgrnam(user);
593 printf("\n*** Group \"%s\" (specified in one of the Makefiles) does not "
594 "exist.\n Please review your build-time configuration.\n\n",
603 struct passwd *pw = getpwnam(user);
606 printf("\n*** User \"%s\" (specified in one of the Makefiles) does not "
607 "exist.\n Please review your build-time configuration.\n\n",
614 /* Output user and group names or uid/gid. When names are set, uid/gid
615 are set to zero but will be replaced at runtime. */
617 if (username != NULL)
620 fprintf(new, "#define CONFIGURE_GROUPNAME \"%s\"\n", username);
622 fprintf(new, "#define CONFIGURE_OWNERNAME \"%s\"\n", username);
626 fprintf(new, "#define CONFIGURE_GROUP %d\n", (int)gid);
628 fprintf(new, "#define CONFIGURE_OWNER %d\n", (int)uid);
632 /* FIXED_NEVER_USERS is another special case. Look up the uid values and
633 create suitable initialization data for a vector. */
635 if (strcmp(name, "FIXED_NEVER_USERS") == 0)
637 char *list = getenv("FIXED_NEVER_USERS");
640 fprintf(new, "#define FIXED_NEVER_USERS 0\n");
648 while (*p != 0) if (*p++ == ':') count++;
650 vector = malloc((count+1) * sizeof(uid_t));
651 vector[0] = (uid_t)count;
653 for (i = 1, j = 0; i <= count; list++, i++)
658 while (*list != 0 && *list != ':') list++;
659 strncpy(name, p, list-p);
666 else if (name[strspn(name, "0123456789")] == 0)
668 vector[j++] = (uid_t)atoi(name);
672 struct passwd *pw = getpwnam(name);
675 printf("\n*** User \"%s\" (specified for FIXED_NEVER_USERS in one of the Makefiles) does not "
676 "exist.\n Please review your build-time configuration.\n\n",
680 vector[j++] = pw->pw_uid;
683 fprintf(new, "#define FIXED_NEVER_USERS %d", j);
684 for (i = 0; i < j; i++) fprintf(new, ", %d", (unsigned int)vector[i]);
690 /* WITH_CONTENT_SCAN is another special case: it must be set if either it or
691 WITH_OLD_DEMIME is set. */
693 if (strcmp(name, "WITH_CONTENT_SCAN") == 0)
695 char *wcs = getenv("WITH_CONTENT_SCAN");
696 char *wod = getenv("WITH_OLD_DEMIME");
697 char *dcc = getenv("EXPERIMENTAL_DCC");
698 if (wcs != NULL || wod != NULL || dcc != NULL)
699 fprintf(new, "#define WITH_CONTENT_SCAN yes\n");
700 else fprintf(new, "/* WITH_CONTENT_SCAN not set */\n");
704 /* Otherwise, check whether a value exists in the environment. Remember if
705 it is an AUTH setting or SUPPORT_CRYPTEQ. */
707 if ((value = getenv(name)) != NULL)
710 len = 21 - (int)strlen(name);
712 if (strncmp(name, "AUTH_", 5) == 0) have_auth = 1;
713 if (strncmp(name, "SUPPORT_CRYPTEQ", 15) == 0) support_crypteq = 1;
715 /* The text value of LDAP_LIB_TYPE refers to a macro that gets set. */
717 if (strcmp(name, "LDAP_LIB_TYPE") == 0)
719 if (strcmp(value, "NETSCAPE") == 0 ||
720 strcmp(value, "UMICHIGAN") == 0 ||
721 strcmp(value, "OPENLDAP1") == 0 ||
722 strcmp(value, "OPENLDAP2") == 0 ||
723 strcmp(value, "SOLARIS") == 0 ||
724 strcmp(value, "SOLARIS7") == 0) /* Compatibility */
726 fprintf(new, "#define LDAP_LIB_%s\n", value);
730 printf("\n*** LDAP_LIB_TYPE=%s is not a recognized LDAP library type."
731 "\n*** Please review your build-time configuration.\n\n", value);
736 else if (strcmp(name, "RADIUS_LIB_TYPE") == 0)
738 if (strcmp(value, "RADIUSCLIENT") == 0 ||
739 strcmp(value, "RADIUSCLIENTNEW") == 0 ||
740 strcmp(value, "RADLIB") == 0)
742 fprintf(new, "#define RADIUS_LIB_%s\n", value);
746 printf("\n*** RADIUS_LIB_TYPE=%s is not a recognized RADIUS library type."
747 "\n*** Please review your build-time configuration.\n\n", value);
752 /* Other macros get set to the environment value. */
756 fprintf(new, "#define %s ", name);
757 while(len-- > 0) fputc(' ', new);
759 /* LOG_FILE_PATH is now messy because it can be a path containing %s or
760 it can be "syslog" or ":syslog" or "syslog:path" or even "path:syslog". */
762 if (strcmp(name, "LOG_FILE_PATH") == 0)
768 char *sss = strchr(ss, ':');
771 strncpy(buffer, ss, sss-ss);
772 buffer[sss-ss] = 0; /* For empty case */
774 else strcpy(buffer, ss);
775 pp = buffer + (int)strlen(buffer);
776 while (pp > buffer && isspace((unsigned char)pp[-1])) pp--;
778 if (buffer[0] != 0 && strcmp(buffer, "syslog") != 0)
779 check_percent_ess(buffer, name);
780 if (sss == NULL) break;
782 while (isspace((unsigned char)*ss)) ss++;
784 fprintf(new, "\"%s\"\n", value);
787 /* Timezone values and HEADERS_CHARSET get quoted */
789 else if (strcmp(name, "TIMEZONE_DEFAULT") == 0||
790 strcmp(name, "HEADERS_CHARSET") == 0)
791 fprintf(new, "\"%s\"\n", value);
793 /* For others, quote any paths and don't quote anything else */
797 if (value[0] == '/') fprintf(new, "\"%s\"\n", value);
798 else fprintf(new, "%s\n", value);
803 /* Value not defined in the environment; use the default */
808 while (*p == ' ' || *p == '\t') p++;
809 if (*p != '\n') fputs(buffer, new); else
812 if (strcmp(name, "BIN_DIRECTORY") == 0 ||
813 strcmp(name, "CONFIGURE_FILE") == 0)
815 printf("\n*** %s has not been defined in any of the Makefiles in the\n"
816 " \"Local\" directory. "
817 "Please review your build-time configuration.\n\n", name);
821 if (strcmp(name, "TIMEZONE_DEFAULT") == 0)
823 char *tz = getenv("TZ");
824 fprintf(new, "#define TIMEZONE_DEFAULT ");
825 if (tz == NULL) fprintf(new, "NULL\n"); else
826 fprintf(new, "\"%s\"\n", tz);
829 else fprintf(new, "/* %s not set */\n", name);
836 /* If any AUTH macros were defined, ensure that SUPPORT_CRYPTEQ is also
841 if (!support_crypteq) fprintf(new, "/* Force SUPPORT_CRYPTEQ for AUTH */\n"
842 "#define SUPPORT_CRYPTEQ\n");
847 fprintf(new, "\n/* End of config.h */\n");
852 /* End of buildconfig.c */