2 ** Copyright (c) 1999-2002 Proofpoint, Inc. and its suppliers.
3 ** All rights reserved.
5 ** By using this file, you agree to the terms and conditions set
6 ** forth in the LICENSE file which can be found at the top level of
7 ** the sendmail distribution.
11 SM_RCSID("@(#)$Id: smdb.c,v 8.59 2013-11-22 20:51:49 ca Exp $")
18 #include <sendmail/sendmail.h>
19 #include <libsmdb/smdb.h>
21 static bool smdb_lockfile __P((int, int));
24 ** SMDB_MALLOC_DATABASE -- Allocates a database structure.
30 ** A pointer to an allocated SMDB_DATABASE structure or
31 ** NULL if it couldn't allocate the memory.
35 smdb_malloc_database()
39 db = (SMDB_DATABASE *) malloc(sizeof(SMDB_DATABASE));
42 (void) memset(db, '\0', sizeof(SMDB_DATABASE));
48 ** SMDB_FREE_DATABASE -- Unallocates a database structure.
51 ** database -- a SMDB_DATABASE pointer to deallocate.
58 smdb_free_database(database)
59 SMDB_DATABASE *database;
66 ** SMDB_LOCKFILE -- lock a file using flock or (shudder) fcntl locking
69 ** fd -- the file descriptor of the file.
70 ** type -- type of the lock. Bits can be:
71 ** LOCK_EX -- exclusive lock.
72 ** LOCK_NB -- non-blocking.
75 ** true if the lock was acquired.
80 smdb_lockfile(fd, type)
90 (void) memset(&lfd, '\0', sizeof lfd);
91 if (bitset(LOCK_UN, type))
93 else if (bitset(LOCK_EX, type))
98 if (bitset(LOCK_NB, type))
103 while ((i = fcntl(fd, action, &lfd)) < 0 && errno == EINTR)
110 ** On SunOS, if you are testing using -oQ/tmp/mqueue or
111 ** -oA/tmp/aliases or anything like that, and /tmp is mounted
112 ** as type "tmp" (that is, served from swap space), the
113 ** previous fcntl will fail with "Invalid argument" errors.
114 ** Since this is fairly common during testing, we will assume
115 ** that this indicates that the lock is successfully grabbed.
118 if (save_errno == EINVAL)
121 if (!bitset(LOCK_NB, type) ||
122 (save_errno != EACCES && save_errno != EAGAIN))
125 int omode = fcntl(fd, F_GETFL, NULL);
126 int euid = (int) geteuid();
128 syslog(LOG_ERR, "cannot lockf(%s%s, fd=%d, type=%o, omode=%o, euid=%d)",
129 filename, ext, fd, type, omode, euid);
134 #else /* !HASFLOCK */
136 while ((i = flock(fd, type)) < 0 && errno == EINTR)
142 if (!bitset(LOCK_NB, type) || save_errno != EWOULDBLOCK)
145 int omode = fcntl(fd, F_GETFL, NULL);
146 int euid = (int) geteuid();
148 syslog(LOG_ERR, "cannot flock(%s%s, fd=%d, type=%o, omode=%o, euid=%d)",
149 filename, ext, fd, type, omode, euid);
154 #endif /* !HASFLOCK */
160 ** SMDB_OPEN_DATABASE -- Opens a database.
162 ** This opens a database. If type is SMDB_DEFAULT it tries to
163 ** use available DB types. If a specific type is given it will
164 ** try to open a database of that type.
167 ** database -- A pointer to a SMDB_DATABASE pointer where the
168 ** opened database will be stored. This should
170 ** db_name -- The name of the database to open. Do not include
171 ** the file name extension.
172 ** mode -- The mode to set on the database file or files.
173 ** mode_mask -- Mode bits that must match on an opened database.
174 ** sff -- Flags to safefile.
175 ** type -- The type of database to open. Supported types
176 ** vary depending on what was compiled in.
177 ** user_info -- Information on the user to use for file
179 ** params -- Params specific to the database being opened.
180 ** Only supports some DB hash options right now
181 ** (see smdb_db_open() for details).
184 ** SMDBE_OK -- Success.
185 ** Anything else is an error. Look up more info about the
186 ** error in the comments for the specific open() used.
191 const char *t2f_type;
192 smdb_open_func *t2f_open_fun;
194 typedef struct type2func_s type2func_t;
195 static type2func_t type2func[] = {
196 { SMDB_TYPE_HASH, smdb_db_open },
197 { SMDB_TYPE_BTREE, smdb_db_open },
198 { SMDB_TYPE_NDBM, smdb_ndbm_open},
199 { SMDB_TYPE_CDB, smdb_cdb_open },
204 smdb_open_database(database, db_name, mode, mode_mask, sff, type, user_info,
206 SMDB_DATABASE **database;
212 SMDB_USER_INFO *user_info;
213 SMDB_DBPARAMS *params;
215 bool type_was_default;
217 const char *smdb_type;
218 smdb_open_func *smdb_open_fun;
220 result = SMDBE_UNSUPPORTED_DB_TYPE;
221 type_was_default = SMDB_IS_TYPE_DEFAULT(type);
222 for (i = 0; (smdb_type = type2func[i].t2f_type) != NULL; i++)
224 if (!type_was_default && strcmp(type, smdb_type) != 0)
226 smdb_open_fun = type2func[i].t2f_open_fun;
227 if (smdb_open_fun == NULL)
229 if (type_was_default)
232 return SMDBE_UNSUPPORTED_DB_TYPE;
234 result = (*smdb_open_fun)(database, db_name, mode, mode_mask, sff,
235 (char *)smdb_type, user_info, params);
236 if (!((result == ENOENT
242 && type_was_default))
245 return SMDBE_UNKNOWN_DB_TYPE;
252 ** SMDB_ADD_EXTENSION -- Adds an extension to a file name.
254 ** Just adds a . followed by a string to a db_name if there
255 ** is room and the db_name does not already have that extension.
258 ** full_name -- The final file name.
259 ** max_full_name_len -- The max length for full_name.
260 ** db_name -- The name of the db.
261 ** extension -- The extension to add.
264 ** SMDBE_OK -- Success.
265 ** Anything else is an error. Look up more info about the
266 ** error in the comments for the specific open() used.
270 smdb_add_extension(full_name, max_full_name_len, db_name, extension)
272 int max_full_name_len;
279 if (full_name == NULL || db_name == NULL || extension == NULL)
280 return SMDBE_INVALID_PARAMETER;
282 extension_len = strlen(extension);
283 db_name_len = strlen(db_name);
285 if (extension_len + db_name_len + 2 > max_full_name_len)
286 return SMDBE_DB_NAME_TOO_LONG;
288 if (db_name_len < extension_len + 1 ||
289 db_name[db_name_len - extension_len - 1] != '.' ||
290 strcmp(&db_name[db_name_len - extension_len], extension) != 0)
291 (void) sm_snprintf(full_name, max_full_name_len, "%s.%s",
294 (void) sm_strlcpy(full_name, db_name, max_full_name_len);
299 ** SMDB_LOCK_FILE -- Locks the database file.
301 ** Locks the actual database file.
304 ** lock_fd -- The resulting descriptor for the locked file.
305 ** db_name -- The name of the database without extension.
306 ** mode -- The open mode.
307 ** sff -- Flags to safefile.
308 ** extension -- The extension for the file.
311 ** SMDBE_OK -- Success, otherwise errno.
315 smdb_lock_file(lock_fd, db_name, mode, sff, extension)
323 char file_name[MAXPATHLEN];
325 result = smdb_add_extension(file_name, sizeof file_name, db_name,
327 if (result != SMDBE_OK)
330 *lock_fd = safeopen(file_name, mode & ~O_TRUNC, DBMMODE, sff);
337 ** SMDB_UNLOCK_FILE -- Unlocks a file
342 ** lock_fd -- The descriptor for the locked file.
345 ** SMDBE_OK -- Success, otherwise errno.
349 smdb_unlock_file(lock_fd)
354 result = close(lock_fd);
361 ** SMDB_LOCK_MAP -- Locks a database.
364 ** database -- database description.
365 ** type -- type of the lock. Bits can be:
366 ** LOCK_EX -- exclusive lock.
367 ** LOCK_NB -- non-blocking.
370 ** SMDBE_OK -- Success, otherwise errno.
374 smdb_lock_map(database, type)
375 SMDB_DATABASE *database;
380 fd = database->smdb_lockfd(database);
382 return SMDBE_NOT_FOUND;
383 if (!smdb_lockfile(fd, type))
384 return SMDBE_LOCK_NOT_GRANTED;
388 ** SMDB_UNLOCK_MAP -- Unlocks a database
391 ** database -- database description.
394 ** SMDBE_OK -- Success, otherwise errno.
398 smdb_unlock_map(database)
399 SMDB_DATABASE *database;
403 fd = database->smdb_lockfd(database);
405 return SMDBE_NOT_FOUND;
406 if (!smdb_lockfile(fd, LOCK_UN))
407 return SMDBE_LOCK_NOT_HELD;
411 ** SMDB_SETUP_FILE -- Gets db file ready for use.
413 ** Makes sure permissions on file are safe and creates it if it
417 ** db_name -- The name of the database without extension.
418 ** extension -- The extension.
419 ** sff -- Flags to safefile.
420 ** mode_mask -- Mode bits that must match.
421 ** user_info -- Information on the user to use for file
423 ** stat_info -- A place to put the stat info for the file.
425 ** SMDBE_OK -- Success, otherwise errno.
429 smdb_setup_file(db_name, extension, mode_mask, sff, user_info, stat_info)
434 SMDB_USER_INFO *user_info;
435 struct stat *stat_info;
439 char db_file_name[MAXPATHLEN];
441 result = smdb_add_extension(db_file_name, sizeof db_file_name, db_name,
443 if (result != SMDBE_OK)
446 st = safefile(db_file_name, user_info->smdbu_id,
447 user_info->smdbu_group_id, user_info->smdbu_name,
448 sff, mode_mask, stat_info);
455 ** SMDB_FILECHANGED -- Checks to see if a file changed.
457 ** Compares the passed in stat_info with a current stat on
458 ** the passed in file descriptor. Check filechanged for
462 ** db_name -- The name of the database without extension.
463 ** extension -- The extension.
464 ** db_fd -- A file descriptor for the database file.
465 ** stat_info -- An old stat_info.
467 ** SMDBE_OK -- Success, otherwise errno.
471 smdb_filechanged(db_name, extension, db_fd, stat_info)
475 struct stat *stat_info;
478 char db_file_name[MAXPATHLEN];
480 result = smdb_add_extension(db_file_name, sizeof db_file_name, db_name,
482 if (result != SMDBE_OK)
484 return filechanged(db_file_name, db_fd, stat_info);
488 ** SMDB_PRINT_AVAILABLE_TYPES -- Prints the names of the available types.
498 smdb_print_available_types(ext)
501 # define PEXT1 ((ext) ? ":" : "")
502 # define PEXT2(x) ((ext) ? x : "")
505 printf("%s%s%s\n", SMDB_TYPE_NDBM, PEXT1, PEXT2(SMNDB_DIR_FILE_EXTENSION));
508 /* # if SMDB1_FILE_EXTENSION == SMDB2_FILE_EXTENSION */
509 printf("%s%s%s\n", SMDB_TYPE_HASH, PEXT1, PEXT2(SMDB1_FILE_EXTENSION));
510 printf("%s%s%s\n", SMDB_TYPE_BTREE, PEXT1, PEXT2(SMDB1_FILE_EXTENSION));
513 printf("%s%s%s\n", SMDB_TYPE_CDB, PEXT1, PEXT2(SMCDB_FILE_EXTENSION));
515 #ifdef SMDB_TYPE_IMPL
516 printf("%s%s%s\n", SMDB_TYPE_IMPL, PEXT1, "");
521 ** SMDB_IS_DB_TYPE -- Does a name match an available DB type?
524 ** type -- The name of the database type.
531 smdb_is_db_type(db_type)
535 if (strcmp(db_type, SMDB_TYPE_NDBM) == 0)
539 if (strcmp(db_type, SMDB_TYPE_HASH) == 0)
541 if (strcmp(db_type, SMDB_TYPE_BTREE) == 0)
545 if (strcmp(db_type, SMDB_TYPE_CDB) == 0)
553 ** SMDB_DB_DEFINITION -- Given a database type, return database definition
555 ** Reads though a structure making an association with the database
556 ** type and the required cpp define from sendmail/README.
557 ** List size is dynamic and must be NULL terminated.
560 ** type -- The name of the database type.
563 ** definition for type, otherwise NULL.
572 static dbtype DatabaseDefs[] =
574 { SMDB_TYPE_HASH, "NEWDB" },
575 { SMDB_TYPE_BTREE, "NEWDB" },
576 { SMDB_TYPE_NDBM, "NDBM" },
577 { SMDB_TYPE_CDB, "CDB" },
582 smdb_db_definition(type)
585 dbtype *ptr = DatabaseDefs;
587 while (ptr != NULL && ptr->type != NULL)
589 if (strcmp(type, ptr->type) == 0)