1 /* $NetBSD: db.c,v 1.12 2004/01/05 23:23:34 jmmv Exp $ */ 2 3 /*- 4 * Copyright (c) 2002 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Luke Mewburn of Wasabi Systems. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. All advertising materials mentioning features or use of this software 19 * must display the following acknowledgement: 20 * This product includes software developed by the NetBSD 21 * Foundation, Inc. and its contributors. 22 * 4. Neither the name of The NetBSD Foundation nor the names of its 23 * contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 36 * POSSIBILITY OF SUCH DAMAGE. 37 */ 38 39 #include <sys/cdefs.h> 40 #ifndef lint 41 #ifdef __RCSID 42 __RCSID("$NetBSD: db.c,v 1.12 2004/01/05 23:23:34 jmmv Exp $"); 43 #endif /* __RCSID */ 44 #endif /* not lint */ 45 46 #include <db.h> 47 #include <ctype.h> 48 #include <err.h> 49 #include <fcntl.h> 50 #include <stdio.h> 51 #include <stdlib.h> 52 #include <string.h> 53 #include <unistd.h> 54 #include <vis.h> 55 56 57 typedef enum { 58 F_WRITE = 1<<0, 59 F_DELETE = 1<<1, 60 F_SHOW_KEY = 1<<2, 61 F_SHOW_VALUE = 1<<3, 62 F_QUIET = 1<<10, 63 F_IGNORECASE = 1<<11, 64 F_ENDIAN_BIG = 1<<12, 65 F_ENDIAN_LITTLE = 1<<13, 66 F_NO_NUL = 1<<14, 67 F_CREATENEW = 1<<20, 68 F_DUPLICATES = 1<<21, 69 F_REPLACE = 1<<22, 70 F_ENCODE_KEY = 1<<23, 71 F_ENCODE_VAL = 1<<24, 72 F_DECODE_KEY = 1<<25, 73 F_DECODE_VAL = 1<<26, 74 } flags_t; 75 76 int main(int, char *[]); 77 void db_print(DBT *, DBT *); 78 int db_dump(void); 79 int db_del(char *); 80 int db_get(char *); 81 int db_put(char *, char *); 82 int parseline(FILE *, const char *, char **, char **); 83 int encode_data(size_t, char *, char **); 84 int decode_data(char *, char **); 85 void parse_encode_decode_arg(const char *, int); 86 int parse_encode_option(char **); 87 void usage(void); 88 89 flags_t flags = 0; 90 DB *db; 91 char *outputsep = "\t"; 92 int encflags = 0; 93 char *extra_echars = NULL; 94 95 int 96 main(int argc, char *argv[]) 97 { 98 struct { 99 char *file; 100 char *type; 101 DBTYPE dbtype; 102 void *info; 103 int flags; 104 mode_t mode; 105 } oi; 106 BTREEINFO btreeinfo; 107 HASHINFO hashinfo; 108 FILE *infp; 109 const char *infile, *fieldsep; 110 char *p, *key, *val; 111 int ch, rv; 112 113 setprogname(argv[0]); 114 115 infile = NULL; 116 fieldsep = " "; 117 infp = NULL; 118 memset(&oi, 0, sizeof(oi)); 119 oi.mode = 0644; 120 121 /* parse arguments */ 122 while ( (ch = getopt(argc, argv, 123 "CDdE:F:f:iKm:NO:qRS:T:U:VwX:")) != -1) { 124 switch (ch) { 125 126 case 'C': 127 flags |= F_CREATENEW; 128 break; 129 130 case 'D': 131 flags |= F_DUPLICATES; 132 break; 133 134 case 'd': 135 flags |= F_DELETE; 136 break; 137 138 case 'E': 139 if (! optarg[0] || optarg[1]) 140 goto badendian; 141 switch (toupper((int)optarg[0])) { 142 case 'B': 143 flags |= F_ENDIAN_BIG; 144 break; 145 case 'L': 146 flags |= F_ENDIAN_LITTLE; 147 break; 148 case 'H': 149 flags &= ~(F_ENDIAN_BIG | F_ENDIAN_LITTLE); 150 break; 151 default: 152 badendian: 153 errx(1, "Bad endian `%s'", optarg); 154 } 155 break; 156 157 case 'F': 158 if (! optarg[0] || optarg[1]) 159 errx(1, "Invalid field separator `%s'", 160 optarg); 161 fieldsep = optarg; 162 break; 163 164 case 'f': 165 infile = optarg; 166 break; 167 168 case 'i': 169 flags |= F_IGNORECASE; 170 break; 171 172 case 'K': 173 flags |= F_SHOW_KEY; 174 break; 175 176 case 'm': 177 oi.mode = (int)strtol(optarg, &p, 8); 178 if (p == optarg || *p != '\0') 179 errx(1, "Invalid octal number `%s'", optarg); 180 break; 181 182 case 'N': 183 flags |= F_NO_NUL; 184 break; 185 186 case 'O': 187 outputsep = optarg; 188 break; 189 190 case 'q': 191 flags |= F_QUIET; 192 break; 193 194 case 'R': 195 flags |= F_REPLACE; 196 break; 197 198 case 'S': 199 parse_encode_decode_arg(optarg, 1 /* encode */); 200 if (! (flags & (F_ENCODE_KEY | F_ENCODE_VAL))) 201 errx(1, "Invalid encoding argument `%s'", 202 optarg); 203 break; 204 205 case 'T': 206 encflags = parse_encode_option(&optarg); 207 if (! encflags) 208 errx(1, "Invalid encoding option `%s'", 209 optarg); 210 break; 211 212 case 'U': 213 parse_encode_decode_arg(optarg, 0 /* decode */); 214 if (! (flags & (F_DECODE_KEY | F_DECODE_VAL))) 215 errx(1, "Invalid decoding argument `%s'", 216 optarg); 217 break; 218 219 case 'V': 220 flags |= F_SHOW_VALUE; 221 break; 222 223 case 'w': 224 flags |= F_WRITE; 225 break; 226 227 case 'X': 228 extra_echars = optarg; 229 break; 230 231 default: 232 usage(); 233 234 } 235 } 236 argc -= optind; 237 argv += optind; 238 239 /* validate arguments */ 240 if (argc < 2) 241 usage(); 242 oi.type = argv[0]; 243 oi.file = argv[1]; 244 argc -= 2; 245 argv += 2; 246 247 if (flags & F_WRITE) { 248 if (flags & (F_SHOW_KEY | F_SHOW_VALUE | F_DELETE)) 249 usage(); 250 if ((!infile && argc < 2) || (argc % 2)) 251 usage(); 252 oi.flags = O_RDWR | O_CREAT | O_EXLOCK; 253 if (flags & F_CREATENEW) 254 flags |= O_TRUNC; 255 } else if (flags & F_DELETE) { 256 if (flags & (F_SHOW_KEY | F_SHOW_VALUE | F_WRITE)) 257 usage(); 258 if (!infile && argc < 1) 259 usage(); 260 oi.flags = O_RDWR | O_CREAT | O_EXLOCK; 261 } else { 262 if (! (flags & (F_SHOW_KEY | F_SHOW_VALUE))) 263 flags |= (F_SHOW_KEY | F_SHOW_VALUE); 264 oi.flags = O_RDONLY | O_SHLOCK; 265 } 266 267 /* validate oi.type */ 268 if (strcmp(oi.type, "btree") == 0) { 269 memset(&btreeinfo, 0, sizeof(btreeinfo)); 270 if (flags & F_ENDIAN_BIG) 271 btreeinfo.lorder = 4321; 272 else if (flags & F_ENDIAN_LITTLE) 273 btreeinfo.lorder = 1234; 274 if (flags & F_DUPLICATES) 275 btreeinfo.flags = R_DUP; 276 btreeinfo.cachesize = 1024 * 1024; 277 oi.info = &btreeinfo; 278 oi.dbtype = DB_BTREE; 279 } else if (strcmp(oi.type, "hash") == 0) { 280 memset(&hashinfo, 0, sizeof(hashinfo)); 281 if (flags & F_ENDIAN_BIG) 282 hashinfo.lorder = 4321; 283 else if (flags & F_ENDIAN_LITTLE) 284 hashinfo.lorder = 1234; 285 hashinfo.cachesize = 1024 * 1024; 286 oi.info = &hashinfo; 287 oi.dbtype = DB_HASH; 288 } else { 289 warnx("Unknown database type `%s'", oi.type); 290 usage(); 291 } 292 293 if (infile) { 294 if (strcmp(infile, "-") == 0) 295 infp = stdin; 296 else if ((infp = fopen(infile, "r")) == NULL) 297 err(1, "Opening input file `%s'", infile); 298 } 299 300 /* open database */ 301 db = dbopen(oi.file, oi.flags, oi.mode, oi.dbtype, oi.info); 302 if (db == NULL) 303 err(1, "Opening database `%s'", oi.file); 304 305 306 /* manipulate database */ 307 rv = 0; 308 if (flags & F_WRITE) { /* write entries */ 309 for (ch = 0; ch < argc; ch += 2) 310 if ((rv = db_put(argv[ch], argv[ch+1]))) 311 goto cleanup; 312 if (infp) { 313 while (parseline(infp, fieldsep, &key, &val)) { 314 if ((rv = db_put(key, val))) 315 goto cleanup; 316 } 317 if (ferror(infp)) { 318 warnx("Reading `%s'", infile); 319 goto cleanup; 320 } 321 } 322 } else if (!infp && argc == 0) { /* read all */ 323 db_dump(); 324 } else { /* read/delete specific */ 325 int (*dbop)(char *); 326 327 if (flags & F_DELETE) 328 dbop = db_del; 329 else 330 dbop = db_get; 331 for (ch = 0; ch < argc; ch++) { 332 if ((rv = dbop(argv[ch]))) 333 goto cleanup; 334 } 335 if (infp) { 336 while (parseline(infp, fieldsep, &key, NULL)) { 337 if ((rv = dbop(key))) 338 goto cleanup; 339 } 340 if (ferror(infp)) { 341 warnx("Reading `%s'", infile); 342 goto cleanup; 343 } 344 } 345 } 346 347 /* close database */ 348 cleanup: 349 if (db->close(db) == -1) 350 err(1, "Closing database `%s'", oi.file); 351 if (infp) 352 fclose(infp); 353 return (rv); 354 } 355 356 void 357 db_print(DBT *key, DBT *val) 358 { 359 360 int len; 361 char *data; 362 363 if (flags & F_SHOW_KEY) { 364 if (flags & F_ENCODE_KEY) 365 len = encode_data(key->size - 1, (char *)key->data, 366 &data); 367 else { 368 len = (int)key->size; 369 data = (char *)key->data; 370 } 371 printf("%.*s", len, data); 372 } 373 if ((flags & F_SHOW_KEY) && (flags & F_SHOW_VALUE)) 374 printf("%s", outputsep); 375 if (flags & F_SHOW_VALUE) { 376 if (flags & F_ENCODE_VAL) 377 len = encode_data(val->size - 1, (char *)val->data, 378 &data); 379 else { 380 len = (int)val->size; 381 data = (char *)val->data; 382 } 383 printf("%.*s", len, data); 384 } 385 printf("\n"); 386 } 387 388 int 389 db_dump(void) 390 { 391 DBT key, val; 392 int rv; 393 394 while ((rv = db->seq(db, &key, &val, R_NEXT)) == 0) 395 db_print(&key, &val); 396 if (rv == -1) 397 warn("Error dumping database"); 398 return (rv == 1 ? 0 : 1); 399 } 400 401 static void 402 db_makekey(DBT *key, char *keystr, int downcase, int decode) 403 { 404 char *p, *ks; 405 int klen; 406 407 memset(key, 0, sizeof(*key)); 408 if (decode) { 409 if ((klen = decode_data(keystr, &ks)) == -1) 410 errx(1, "Invalid escape sequence in `%s'", 411 keystr); 412 } else { 413 klen = strlen(keystr); 414 ks = keystr; 415 } 416 key->data = ks; 417 key->size = klen + (flags & F_NO_NUL ? 0 : 1); 418 if (downcase && flags & F_IGNORECASE) { 419 for (p = ks; *p; p++) 420 if (isupper((int)*p)) 421 *p = tolower((int)*p); 422 } 423 } 424 425 int 426 db_del(char *keystr) 427 { 428 DBT key; 429 int r = 0; 430 431 db_makekey(&key, keystr, 1, (flags & F_DECODE_KEY ? 1 : 0)); 432 switch (db->del(db, &key, 0)) { 433 case -1: 434 warn("Error deleting key `%s'", keystr); 435 r = 1; 436 break; 437 case 0: 438 if (! (flags & F_QUIET)) 439 printf("Deleted key `%s'\n", keystr); 440 break; 441 case 1: 442 warnx("Key `%s' does not exist", keystr); 443 r = 1; 444 break; 445 } 446 if (flags & F_DECODE_KEY) 447 free(key.data); 448 return (r); 449 } 450 451 int 452 db_get(char *keystr) 453 { 454 DBT key, val; 455 int r = 0; 456 457 db_makekey(&key, keystr, 1, (flags & F_DECODE_KEY ? 1 : 0)); 458 switch (db->get(db, &key, &val, 0)) { 459 case -1: 460 warn("Error reading key `%s'", keystr); 461 r = 1; 462 break; 463 case 0: 464 db_print(&key, &val); 465 break; 466 case 1: 467 if (! (flags & F_QUIET)) { 468 warnx("Unknown key `%s'", keystr); 469 r = 1; 470 } 471 break; 472 } 473 if (flags & F_DECODE_KEY) 474 free(key.data); 475 return (r); 476 } 477 478 int 479 db_put(char *keystr, char *valstr) 480 { 481 DBT key, val; 482 int r = 0; 483 484 db_makekey(&key, keystr, 1, (flags & F_DECODE_KEY ? 1 : 0)); 485 db_makekey(&val, valstr, 0, (flags & F_DECODE_VAL ? 1 : 0)); 486 switch (db->put(db, &key, &val, 487 (flags & F_REPLACE) ? 0 : R_NOOVERWRITE)) { 488 case -1: 489 warn("Error writing key `%s'", keystr); 490 r = 1; 491 break; 492 case 0: 493 if (! (flags & F_QUIET)) 494 printf("Added key `%s'\n", keystr); 495 break; 496 case 1: 497 if (! (flags & F_QUIET)) 498 warnx("Key `%s' already exists", keystr); 499 r = 1; 500 break; 501 } 502 if (flags & F_DECODE_KEY) 503 free(key.data); 504 if (flags & F_DECODE_VAL) 505 free(val.data); 506 return (r); 507 } 508 509 int 510 parseline(FILE *fp, const char *sep, char **kp, char **vp) 511 { 512 size_t len; 513 char *key, *val; 514 515 key = fgetln(fp, &len); 516 if (key == NULL) /* end of file, or error */ 517 return (0); 518 519 if (key[len-1] == '\n') /* check for \n at EOL */ 520 key[--len] = '\0'; 521 else 522 return (0); 523 524 *kp = key; 525 if (vp == NULL) /* don't split if don't want value */ 526 return (1); 527 if ((val = strchr(key, sep[0])) == NULL) 528 val = key + len; 529 else 530 *val++ = '\0'; 531 *vp = val; 532 return (1); 533 } 534 535 int 536 encode_data(size_t len, char *data, char **edata) 537 { 538 static char *buf = NULL; 539 char *nbuf; 540 static size_t buflen = 0; 541 size_t elen; 542 543 elen = 1 + (len * 4); 544 if (elen > buflen) { 545 if ((nbuf = realloc(buf, elen)) == NULL) 546 err(1, "Cannot allocate encoding buffer"); 547 buf = nbuf; 548 buflen = elen; 549 } 550 *edata = buf; 551 if (extra_echars) { 552 return (strsvisx(buf, data, len, encflags, extra_echars)); 553 } else { 554 return (strvisx(buf, data, len, encflags)); 555 } 556 } 557 558 int 559 decode_data(char *data, char **ddata) 560 { 561 char *buf; 562 563 if ((buf = malloc(strlen(data) + 1)) == NULL) 564 err(1, "Cannot allocate decoding buffer"); 565 *ddata = buf; 566 return (strunvis(buf, data)); 567 } 568 569 void 570 parse_encode_decode_arg(const char *arg, int encode) 571 { 572 if (! arg[0] || arg[1]) 573 return; 574 if (arg[0] == 'k' || arg[0] == 'b') { 575 if (encode) 576 flags |= F_ENCODE_KEY; 577 else 578 flags |= F_DECODE_KEY; 579 } 580 if (arg[0] == 'v' || arg[0] == 'b') { 581 if (encode) 582 flags |= F_ENCODE_VAL; 583 else 584 flags |= F_DECODE_VAL; 585 } 586 return; 587 } 588 589 int 590 parse_encode_option(char **arg) 591 { 592 int r = 0; 593 594 for(; **arg; (*arg)++) { 595 switch (**arg) { 596 case 'b': 597 r |= VIS_NOSLASH; 598 break; 599 case 'c': 600 r |= VIS_CSTYLE; 601 break; 602 case 'o': 603 r |= VIS_OCTAL; 604 break; 605 case 's': 606 r |= VIS_SAFE; 607 break; 608 case 't': 609 r |= VIS_TAB; 610 break; 611 case 'w': 612 r |= VIS_WHITE; 613 break; 614 default: 615 return (0); 616 break; 617 } 618 } 619 return (r); 620 } 621 622 void 623 usage(void) 624 { 625 const char *p = getprogname(); 626 627 fprintf(stderr, 628 "usage: %s [-KiNqV] [-E end] [-f inf] [-O str] [-S chr] [-T str] [-X str]\n" 629 " type dbfile [key [...]]\n" 630 " %s -d [-iNq] [-E end] [-f inf] [-U chr] type dbfile [key [...]]\n" 631 " %s -w [-CDiNqR] [-E end] [-F sep] [-f inf] [-m mod] [-U chr]\n" 632 " type dbfile [key val [...]]\n" 633 ,p ,p ,p ); 634 fprintf(stderr, 635 "Supported modes:\n" 636 "\t\tread keys [default]\n" 637 "\t-d\tdelete keys\n" 638 "\t-w\twrite (add) keys/values\n" 639 "Supported options:\n" 640 "\t-C\tcreate empty (truncated) database\n" 641 "\t-D\tallow duplicates\n" 642 "\t-E end\tdatabase endian: `B'ig, `L'ittle, `H'ost [default: H]\n" 643 "\t-F sep\tfield separator character [default: ' ']\n" 644 "\t-f inf\tfile of keys (read|delete) or keys/vals (write)\n" 645 "\t-i\tignore case of key by converting to lower case\n" 646 "\t-K\tprint key\n" 647 "\t-m mod\tmode of created database [default: 0644]\n" 648 "\t-N\tdon't NUL terminate key\n" 649 "\t-O str\toutput field separator string [default: '\\t']\n" 650 "\t-q\tquiet operation (missing keys aren't errors)\n" 651 "\t-R\treplace existing keys\n" 652 "\t-S chr\titems to strvis(3) encode: 'k'ey, 'v'alue, 'b'oth\n" 653 "\t-T str\toptions to control -S encoding like vis(1) options\n" 654 "\t-U chr\titems to strunvis(3) decode: 'k'ey, 'v'alue, 'b'oth\n" 655 "\t-V\tprint value\n" 656 "\t-X str\textra characters to encode with -S\n" 657 ); 658 exit(1); 659 } 660