1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
9 /* A small freestanding program to build dbm databases from serial input. For
10 alias files, this program fulfils the function of the newaliases program used
11 by other mailers, but it can be used for other dbm data files too. It operates
12 by writing a new file or files, and then renaming; otherwise old entries can
13 never get flushed out.
15 This program is clever enough to cope with ndbm, which creates two files called
16 <name>.dir and <name>.pag, or with db, which creates a single file called
17 <name>.db. If native db is in use (USE_DB defined) or tdb is in use (USE_TDB
18 defined) there is no extension to the output filename. This is also handled. If
19 there are any other variants, the program won't cope.
21 The first argument to the program is the name of the serial file; the second
22 is the base name for the DBM file(s). When native db is in use, these must be
25 Input lines beginning with # are ignored, as are blank lines. Entries begin
26 with a key terminated by a colon or end of line or whitespace and continue with
27 indented lines. Keys may be quoted if they contain colons or whitespace or #
33 uschar * spool_directory = NULL; /* dummy for dbstuff.h */
35 /******************************************************************************/
36 /* dummies needed by Solaris build */
38 store_get_3(int size, BOOL tainted, const char *filename, int linenumber)
41 store_reset_3(void **ptr, int pool, const char *filename, int linenumber)
44 store_release_above_3(void *ptr, const char *func, int linenumber)
47 string_vformat_trc(gstring * g, const uschar * func, unsigned line,
48 unsigned size_limit, unsigned flags, const char *format, va_list ap)
51 string_sprintf_trc(const char * a, const uschar * b, unsigned c, ...)
53 BOOL split_spool_directory;
55 /******************************************************************************/
58 #define max_insize 20000
59 #define max_outsize 100000
61 /* This is global because it's defined in the headers and compilers grumble
62 if it is made static. */
64 const uschar *hex_digits = CUS"0123456789abcdef";
67 #ifdef STRERROR_FROM_ERRLIST
68 /* Some old-fashioned systems still around (e.g. SunOS4) don't have strerror()
69 in their libraries, but can provide the same facility by this simple
70 alternative function. */
75 if (n < 0 || n >= sys_nerr) return "unknown error number";
76 return sys_errlist[n];
78 #endif /* STRERROR_FROM_ERRLIST */
81 /* For Berkeley DB >= 2, we can define a function to be called in case of DB
82 errors. This should help with debugging strange DB problems, e.g. getting "File
83 exists" when you try to open a db file. The API changed at release 4.3. */
85 #if defined(USE_DB) && defined(DB_VERSION_STRING)
87 #if DB_VERSION_MAJOR > 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR >= 3)
88 dbfn_bdb_error_callback(const DB_ENV *dbenv, const char *pfx, const char *msg)
92 dbfn_bdb_error_callback(const char *pfx, char *msg)
96 printf("Berkeley DB error: %s\n", msg);
102 /*************************************************
103 * Interpret escape sequence *
104 *************************************************/
106 /* This function is copied from the main Exim code.
109 pp points a pointer to the initiating "\" in the string;
110 the pointer gets updated to point to the final character
111 Returns: the value of the character escape
115 string_interpret_escape(const uschar **pp)
118 const uschar *p = *pp;
120 if (ch == '\0') return **pp;
121 if (isdigit(ch) && ch != '8' && ch != '9')
124 if (isdigit(p[1]) && p[1] != '8' && p[1] != '9')
126 ch = ch * 8 + *(++p) - '0';
127 if (isdigit(p[1]) && p[1] != '8' && p[1] != '9')
128 ch = ch * 8 + *(++p) - '0';
133 case 'n': ch = '\n'; break;
134 case 'r': ch = '\r'; break;
135 case 't': ch = '\t'; break;
141 Ustrchr(hex_digits, tolower(*(++p))) - hex_digits;
142 if (isxdigit(p[1])) ch = ch * 16 +
143 Ustrchr(hex_digits, tolower(*(++p))) - hex_digits;
152 /*************************************************
154 *************************************************/
156 int main(int argc, char **argv)
164 BOOL lowercase = TRUE;
167 BOOL lastdup = FALSE;
168 #if !defined (USE_DB) && !defined(USE_TDB) && !defined(USE_GDBM)
174 EXIM_DATUM key, content;
176 uschar keybuffer[256];
177 uschar temp_dbmname[512];
178 uschar real_dbmname[512];
180 uschar *buffer = malloc(max_outsize);
181 uschar *line = malloc(max_insize);
185 if (Ustrcmp(argv[arg], "-nolc") == 0) lowercase = FALSE;
186 else if (Ustrcmp(argv[arg], "-nowarn") == 0) warn = FALSE;
187 else if (Ustrcmp(argv[arg], "-lastdup") == 0) lastdup = TRUE;
188 else if (Ustrcmp(argv[arg], "-noduperr") == 0) duperr = FALSE;
189 else if (Ustrcmp(argv[arg], "-nozero") == 0) add_zero = 0;
197 printf("usage: exim_dbmbuild [-nolc] <source file> <dbm base name>\n");
201 if (Ustrcmp(argv[arg], "-") == 0) f = stdin; else
203 f = fopen(argv[arg], "rb");
206 printf("exim_dbmbuild: unable to open %s: %s\n", argv[arg], strerror(errno));
211 /* By default Berkeley db does not put extensions on... which
214 #if defined(USE_DB) || defined(USE_TDB) || defined(USE_GDBM)
215 if (Ustrcmp(argv[arg], argv[arg+1]) == 0)
217 printf("exim_dbmbuild: input and output filenames are the same\n");
222 /* Check length of filename; allow for adding .dbmbuild_temp and .db or
225 if (strlen(argv[arg+1]) > sizeof(temp_dbmname) - 20)
227 printf("exim_dbmbuild: output filename is ridiculously long\n");
231 Ustrcpy(temp_dbmname, US argv[arg+1]);
232 Ustrcat(temp_dbmname, US".dbmbuild_temp");
234 Ustrcpy(dirname, temp_dbmname);
235 if ((bptr = Ustrrchr(dirname, '/')))
238 Ustrcpy(dirname, US".");
240 /* It is apparently necessary to open with O_RDWR for this to work
241 with gdbm-1.7.3, though no reading is actually going to be done. */
243 EXIM_DBOPEN(temp_dbmname, dirname, O_RDWR|O_CREAT|O_EXCL, 0644, &d);
247 printf("exim_dbmbuild: unable to create %s: %s\n", temp_dbmname,
253 /* Unless using native db calls, see if we have created <name>.db; if not,
254 assume .dir & .pag */
256 #if !defined(USE_DB) && !defined(USE_TDB) && !defined(USE_GDBM)
257 sprintf(CS real_dbmname, "%s.db", temp_dbmname);
258 is_db = Ustat(real_dbmname, &statbuf) == 0;
261 /* Now do the business */
266 while (Ufgets(line, max_insize, f) != NULL)
269 int len = Ustrlen(line);
273 if (len >= max_insize - 1 && p[-1] != '\n')
275 printf("Overlong line read: max permitted length is %d\n", max_insize - 1);
280 if (line[0] == '#') continue;
281 while (p > line && isspace(p[-1])) p--;
283 if (line[0] == 0) continue;
285 /* A continuation line is valid only if there was a previous first
288 if (isspace(line[0]))
293 printf("Unexpected continuation line ignored\n%s\n\n", line);
296 while (isspace(*s)) s++;
299 if (bptr - buffer + p - s >= max_outsize - 1)
301 printf("Continued set of lines is too long: max permitted length is %d\n",
311 /* A first line must have a name followed by a colon or whitespace or
312 end of line, but first finish with a previous line. The key is lower
313 cased by default - this is what the newaliases program for sendmail does.
314 However, there's an option not to do this. */
324 EXIM_DATUM_INIT(content);
325 EXIM_DATUM_DATA(content) = CS buffer;
326 EXIM_DATUM_SIZE(content) = bptr - buffer + add_zero;
328 switch(rc = EXIM_DBPUTB(d, key, content))
334 case EXIM_DBPUTB_DUP:
335 if (warn) fprintf(stderr, "** Duplicate key \"%s\"\n", keybuffer);
337 if(duperr) yield = 1;
338 if (lastdup) EXIM_DBPUT(d, key, content);
342 fprintf(stderr, "Error %d while writing key %s: errno=%d\n", rc,
351 EXIM_DATUM_INIT(key);
352 EXIM_DATUM_DATA(key) = CS keybuffer;
354 /* Deal with quoted keys. Escape sequences always make one character
355 out of several, so we can re-build in place. */
361 while (*s != 0 && *s != '\"')
364 ? string_interpret_escape((const uschar **)&s)
368 if (*s != 0) s++; /* Past terminating " */
369 EXIM_DATUM_SIZE(key) = t - keystart + add_zero;
374 while (*s != 0 && *s != ':' && !isspace(*s)) s++;
375 EXIM_DATUM_SIZE(key) = s - keystart + add_zero;
378 if (EXIM_DATUM_SIZE(key) > 256)
380 printf("Keys longer than 255 characters cannot be handled\n");
387 for (i = 0; i < EXIM_DATUM_SIZE(key) - add_zero; i++)
388 keybuffer[i] = tolower(keystart[i]);
390 for (i = 0; i < EXIM_DATUM_SIZE(key) - add_zero; i++)
391 keybuffer[i] = keystart[i];
396 while (isspace(*s))s++;
400 while (isspace(*s))s++;
414 EXIM_DATUM_INIT(content);
415 EXIM_DATUM_DATA(content) = CS buffer;
416 EXIM_DATUM_SIZE(content) = bptr - buffer + add_zero;
418 switch(rc = EXIM_DBPUTB(d, key, content))
424 case EXIM_DBPUTB_DUP:
425 if (warn) fprintf(stderr, "** Duplicate key \"%s\"\n", keybuffer);
427 if (duperr) yield = 1;
428 if (lastdup) EXIM_DBPUT(d, key, content);
432 fprintf(stderr, "Error %d while writing key %s: errno=%d\n", rc,
439 /* Close files, rename or abandon the temporary files, and exit */
446 /* If successful, output the number of entries and rename the temporary
449 if (yield == 0 || yield == 1)
451 printf("%d entr%s written\n", count, (count == 1)? "y" : "ies");
454 printf("%d duplicate key%s \n", dupcount, (dupcount > 1)? "s" : "");
457 #if defined(USE_DB) || defined(USE_TDB) || defined(USE_GDBM)
458 Ustrcpy(real_dbmname, temp_dbmname);
459 Ustrcpy(buffer, US argv[arg+1]);
460 if (Urename(real_dbmname, buffer) != 0)
462 printf("Unable to rename %s as %s\n", real_dbmname, buffer);
467 /* Rename a single .db file */
471 sprintf(CS real_dbmname, "%s.db", temp_dbmname);
472 sprintf(CS buffer, "%s.db", argv[arg+1]);
473 if (Urename(real_dbmname, buffer) != 0)
475 printf("Unable to rename %s as %s\n", real_dbmname, buffer);
480 /* Rename .dir and .pag files */
484 sprintf(CS real_dbmname, "%s.dir", temp_dbmname);
485 sprintf(CS buffer, "%s.dir", argv[arg+1]);
486 if (Urename(real_dbmname, buffer) != 0)
488 printf("Unable to rename %s as %s\n", real_dbmname, buffer);
492 sprintf(CS real_dbmname, "%s.pag", temp_dbmname);
493 sprintf(CS buffer, "%s.pag", argv[arg+1]);
494 if (Urename(real_dbmname, buffer) != 0)
496 printf("Unable to rename %s as %s\n", real_dbmname, buffer);
501 #endif /* USE_DB || USE_TDB || USE_GDBM */
504 /* Otherwise unlink the temporary files. */
508 printf("dbmbuild abandoned\n");
509 #if defined(USE_DB) || defined(USE_TDB) || defined(USE_GDBM)
510 /* We created it, so safe to delete despite the name coming from outside */
511 /* coverity[tainted_string] */
512 Uunlink(temp_dbmname);
516 sprintf(CS real_dbmname, "%s.db", temp_dbmname);
517 Uunlink(real_dbmname);
521 sprintf(CS real_dbmname, "%s.dir", temp_dbmname);
522 Uunlink(real_dbmname);
523 sprintf(CS real_dbmname, "%s.pag", temp_dbmname);
524 Uunlink(real_dbmname);
526 #endif /* USE_DB || USE_TDB */
532 /* End of exim_dbmbuild.c */