1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2009 */
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 #
34 #define max_insize 20000
35 #define max_outsize 100000
37 /* This is global because it's defined in the headers and compilers grumble
38 if it is made static. */
40 const uschar *hex_digits = CUS"0123456789abcdef";
43 #ifdef STRERROR_FROM_ERRLIST
44 /* Some old-fashioned systems still around (e.g. SunOS4) don't have strerror()
45 in their libraries, but can provide the same facility by this simple
46 alternative function. */
51 if (n < 0 || n >= sys_nerr) return "unknown error number";
52 return sys_errlist[n];
54 #endif /* STRERROR_FROM_ERRLIST */
57 /* For Berkeley DB >= 2, we can define a function to be called in case of DB
58 errors. This should help with debugging strange DB problems, e.g. getting "File
59 exists" when you try to open a db file. The API changed at release 4.3. */
61 #if defined(USE_DB) && defined(DB_VERSION_STRING)
63 #if DB_VERSION_MAJOR > 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR >= 3)
64 dbfn_bdb_error_callback(const DB_ENV *dbenv, const char *pfx, const char *msg)
68 dbfn_bdb_error_callback(const char *pfx, char *msg)
72 printf("Berkeley DB error: %s\n", msg);
78 /*************************************************
79 * Interpret escape sequence *
80 *************************************************/
82 /* This function is copied from the main Exim code.
85 pp points a pointer to the initiating "\" in the string;
86 the pointer gets updated to point to the final character
87 Returns: the value of the character escape
91 string_interpret_escape(uschar **pp)
96 if (isdigit(ch) && ch != '8' && ch != '9')
99 if (isdigit(p[1]) && p[1] != '8' && p[1] != '9')
101 ch = ch * 8 + *(++p) - '0';
102 if (isdigit(p[1]) && p[1] != '8' && p[1] != '9')
103 ch = ch * 8 + *(++p) - '0';
108 case 'n': ch = '\n'; break;
109 case 'r': ch = '\r'; break;
110 case 't': ch = '\t'; break;
116 Ustrchr(hex_digits, tolower(*(++p))) - hex_digits;
117 if (isxdigit(p[1])) ch = ch * 16 +
118 Ustrchr(hex_digits, tolower(*(++p))) - hex_digits;
127 /*************************************************
129 *************************************************/
131 int main(int argc, char **argv)
139 BOOL lowercase = TRUE;
142 BOOL lastdup = FALSE;
143 #if !defined (USE_DB) && !defined(USE_TDB) && !defined(USE_GDBM)
149 EXIM_DATUM key, content;
151 uschar keybuffer[256];
152 uschar temp_dbmname[512];
153 uschar real_dbmname[512];
154 uschar *buffer = malloc(max_outsize);
155 uschar *line = malloc(max_insize);
159 if (Ustrcmp(argv[arg], "-nolc") == 0) lowercase = FALSE;
160 else if (Ustrcmp(argv[arg], "-nowarn") == 0) warn = FALSE;
161 else if (Ustrcmp(argv[arg], "-lastdup") == 0) lastdup = TRUE;
162 else if (Ustrcmp(argv[arg], "-noduperr") == 0) duperr = FALSE;
163 else if (Ustrcmp(argv[arg], "-nozero") == 0) add_zero = 0;
171 printf("usage: exim_dbmbuild [-nolc] <source file> <dbm base name>\n");
175 if (Ustrcmp(argv[arg], "-") == 0) f = stdin; else
177 f = fopen(argv[arg], "rb");
180 printf("exim_dbmbuild: unable to open %s: %s\n", argv[arg], strerror(errno));
185 /* By default Berkeley db does not put extensions on... which
188 #if defined(USE_DB) || defined(USE_TDB) || defined(USE_GDBM)
189 if (Ustrcmp(argv[arg], argv[arg+1]) == 0)
191 printf("exim_dbmbuild: input and output filenames are the same\n");
196 /* Check length of filename; allow for adding .dbmbuild_temp and .db or
199 if (strlen(argv[arg+1]) > sizeof(temp_dbmname) - 20)
201 printf("exim_dbmbuild: output filename is ridiculously long\n");
205 Ustrcpy(temp_dbmname, argv[arg+1]);
206 Ustrcat(temp_dbmname, ".dbmbuild_temp");
208 /* It is apparently necessary to open with O_RDWR for this to work
209 with gdbm-1.7.3, though no reading is actually going to be done. */
211 EXIM_DBOPEN(temp_dbmname, O_RDWR|O_CREAT|O_EXCL, 0644, &d);
215 printf("exim_dbmbuild: unable to create %s: %s\n", temp_dbmname,
221 /* Unless using native db calls, see if we have created <name>.db; if not,
222 assume .dir & .pag */
224 #if !defined(USE_DB) && !defined(USE_TDB) && !defined(USE_GDBM)
225 sprintf(CS real_dbmname, "%s.db", temp_dbmname);
226 is_db = Ustat(real_dbmname, &statbuf) == 0;
229 /* Now do the business */
234 while (Ufgets(line, max_insize, f) != NULL)
237 int len = Ustrlen(line);
241 if (len >= max_insize - 1 && p[-1] != '\n')
243 printf("Overlong line read: max permitted length is %d\n", max_insize - 1);
248 if (line[0] == '#') continue;
249 while (p > line && isspace(p[-1])) p--;
251 if (line[0] == 0) continue;
253 /* A continuation line is valid only if there was a previous first
256 if (isspace(line[0]))
261 printf("Unexpected continuation line ignored\n%s\n\n", line);
264 while (isspace(*s)) s++;
267 if (bptr - buffer + p - s >= max_outsize - 1)
269 printf("Continued set of lines is too long: max permitted length is %d\n",
279 /* A first line must have a name followed by a colon or whitespace or
280 end of line, but first finish with a previous line. The key is lower
281 cased by default - this is what the newaliases program for sendmail does.
282 However, there's an option not to do this. */
292 EXIM_DATUM_INIT(content);
293 EXIM_DATUM_DATA(content) = CS buffer;
294 EXIM_DATUM_SIZE(content) = bptr - buffer + add_zero;
296 switch(rc = EXIM_DBPUTB(d, key, content))
302 case EXIM_DBPUTB_DUP:
303 if (warn) fprintf(stderr, "** Duplicate key \"%s\"\n",
306 if(duperr) yield = 1;
307 if (lastdup) EXIM_DBPUT(d, key, content);
311 fprintf(stderr, "Error %d while writing key %s: errno=%d\n", rc,
320 EXIM_DATUM_INIT(key);
321 EXIM_DATUM_DATA(key) = CS keybuffer;
323 /* Deal with quoted keys. Escape sequences always make one character
324 out of several, so we can re-build in place. */
330 while (*s != 0 && *s != '\"')
332 if (*s == '\\') *t++ = string_interpret_escape(&s);
336 if (*s != 0) s++; /* Past terminating " */
337 EXIM_DATUM_SIZE(key) = t - keystart + add_zero;
342 while (*s != 0 && *s != ':' && !isspace(*s)) s++;
343 EXIM_DATUM_SIZE(key) = s - keystart + add_zero;
346 if (EXIM_DATUM_SIZE(key) > 256)
348 printf("Keys longer than 255 characters cannot be handled\n");
356 for (i = 0; i < EXIM_DATUM_SIZE(key) - add_zero; i++)
357 keybuffer[i] = tolower(keystart[i]);
361 for (i = 0; i < EXIM_DATUM_SIZE(key) - add_zero; i++)
362 keybuffer[i] = keystart[i];
368 while (isspace(*s))s++;
372 while (isspace(*s))s++;
386 EXIM_DATUM_INIT(content);
387 EXIM_DATUM_DATA(content) = CS buffer;
388 EXIM_DATUM_SIZE(content) = bptr - buffer + add_zero;
390 switch(rc = EXIM_DBPUTB(d, key, content))
396 case EXIM_DBPUTB_DUP:
397 if (warn) fprintf(stderr, "** Duplicate key \"%s\"\n", keybuffer);
399 if (duperr) yield = 1;
400 if (lastdup) EXIM_DBPUT(d, key, content);
404 fprintf(stderr, "Error %d while writing key %s: errno=%d\n", rc,
411 /* Close files, rename or abandon the temporary files, and exit */
418 /* If successful, output the number of entries and rename the temporary
421 if (yield == 0 || yield == 1)
423 printf("%d entr%s written\n", count, (count == 1)? "y" : "ies");
426 printf("%d duplicate key%s \n", dupcount, (dupcount > 1)? "s" : "");
429 #if defined(USE_DB) || defined(USE_TDB) || defined(USE_GDBM)
430 Ustrcpy(real_dbmname, temp_dbmname);
431 Ustrcpy(buffer, argv[arg+1]);
432 if (Urename(real_dbmname, buffer) != 0)
434 printf("Unable to rename %s as %s\n", real_dbmname, buffer);
439 /* Rename a single .db file */
443 sprintf(CS real_dbmname, "%s.db", temp_dbmname);
444 sprintf(CS buffer, "%s.db", argv[arg+1]);
445 if (Urename(real_dbmname, buffer) != 0)
447 printf("Unable to rename %s as %s\n", real_dbmname, buffer);
452 /* Rename .dir and .pag files */
456 sprintf(CS real_dbmname, "%s.dir", temp_dbmname);
457 sprintf(CS buffer, "%s.dir", argv[arg+1]);
458 if (Urename(real_dbmname, buffer) != 0)
460 printf("Unable to rename %s as %s\n", real_dbmname, buffer);
464 sprintf(CS real_dbmname, "%s.pag", temp_dbmname);
465 sprintf(CS buffer, "%s.pag", argv[arg+1]);
466 if (Urename(real_dbmname, buffer) != 0)
468 printf("Unable to rename %s as %s\n", real_dbmname, buffer);
473 #endif /* USE_DB || USE_TDB || USE_GDBM */
476 /* Otherwise unlink the temporary files. */
480 printf("dbmbuild abandoned\n");
481 #if defined(USE_DB) || defined(USE_TDB) || defined(USE_GDBM)
482 Uunlink(temp_dbmname);
486 sprintf(CS real_dbmname, "%s.db", temp_dbmname);
487 Uunlink(real_dbmname);
491 sprintf(CS real_dbmname, "%s.dir", temp_dbmname);
492 Uunlink(real_dbmname);
493 sprintf(CS real_dbmname, "%s.pag", temp_dbmname);
494 Uunlink(real_dbmname);
496 #endif /* USE_DB || USE_TDB */
502 /* End of exim_dbmbuild.c */