source/lib/tdb/tools/tdbtool.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Samba database functions
   4    Copyright (C) Andrew Tridgell              1999-2000
   5    Copyright (C) Paul `Rusty' Russell              2000
   6    Copyright (C) Jeremy Allison                    2000
   7    Copyright (C) Andrew Esh                        2001
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 2 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program; if not, write to the Free Software
  21    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22 */
  23
  24 #include "replace.h"
  25 #include "system/locale.h"
  26 #include "system/time.h"
  27 #include "system/filesys.h"
  28 #include "tdb.h"
  29
  30 static int do_command(void);
  31 const char *cmdname;
  32 char *arg1, *arg2;
  33 size_t arg1len, arg2len;
  34 int bIterate = 0;
  35 char *line;
  36 TDB_DATA iterate_kbuf;
  37 char cmdline[1024];
  38
  39 enum commands {
  40         CMD_CREATE_TDB,
  41         CMD_OPEN_TDB,
  42         CMD_ERASE,
  43         CMD_DUMP,
  44         CMD_INSERT,
  45         CMD_MOVE,
  46         CMD_STORE,
  47         CMD_SHOW,
  48         CMD_KEYS,
  49         CMD_HEXKEYS,
  50         CMD_DELETE,
  51         CMD_LIST_HASH_FREE,
  52         CMD_LIST_FREE,
  53         CMD_INFO,
  54         CMD_FIRST,
  55         CMD_NEXT,
  56         CMD_SYSTEM,
  57         CMD_QUIT,
  58         CMD_HELP
  59 };
  60
  61 typedef struct {
  62         const char *name;
  63         enum commands cmd;
  64 } COMMAND_TABLE;
  65
  66 COMMAND_TABLE cmd_table[] = {
  67         {"create",      CMD_CREATE_TDB},
  68         {"open",        CMD_OPEN_TDB},
  69         {"erase",       CMD_ERASE},
  70         {"dump",        CMD_DUMP},
  71         {"insert",      CMD_INSERT},
  72         {"move",        CMD_MOVE},
  73         {"store",       CMD_STORE},
  74         {"show",        CMD_SHOW},
  75         {"keys",        CMD_KEYS},
  76         {"hexkeys",     CMD_HEXKEYS},
  77         {"delete",      CMD_DELETE},
  78         {"list",        CMD_LIST_HASH_FREE},
  79         {"free",        CMD_LIST_FREE},
  80         {"info",        CMD_INFO},
  81         {"first",       CMD_FIRST},
  82         {"1",           CMD_FIRST},
  83         {"next",        CMD_NEXT},
  84         {"n",           CMD_NEXT},
  85         {"quit",        CMD_QUIT},
  86         {"q",           CMD_QUIT},
  87         {"!",           CMD_SYSTEM},
  88         {NULL,          CMD_HELP}
  89 };
  90
  91 /* a tdb tool for manipulating a tdb database */
  92
  93 static TDB_CONTEXT *tdb;
  94
  95 static int print_rec(TDB_CONTEXT *the_tdb, TDB_DATA key, TDB_DATA dbuf, void *state);
  96 static int print_key(TDB_CONTEXT *the_tdb, TDB_DATA key, TDB_DATA dbuf, void *state);
  97 static int print_hexkey(TDB_CONTEXT *the_tdb, TDB_DATA key, TDB_DATA dbuf, void *state);
  98
  99 static void print_asc(const char *buf,int len)
 100 {
 101         int i;
 102
 103         /* We're probably printing ASCII strings so don't try to display
 104            the trailing NULL character. */
 105
 106         if (buf[len - 1] == 0)
 107                 len--;
 108
 109         for (i=0;i<len;i++)
 110                 printf("%c",isprint(buf[i])?buf[i]:'.');
 111 }
 112
 113 static void print_data(const char *buf,int len)
 114 {
 115         int i=0;
 116         if (len<=0) return;
 117         printf("[%03X] ",i);
 118         for (i=0;i<len;) {
 119                 printf("%02X ",(int)buf[i]);
 120                 i++;
 121                 if (i%8 == 0) printf(" ");
 122                 if (i%16 == 0) {
 123                         print_asc(&buf[i-16],8); printf(" ");
 124                         print_asc(&buf[i-8],8); printf("\n");
 125                         if (i<len) printf("[%03X] ",i);
 126                 }
 127         }
 128         if (i%16) {
 129                 int n;
 130
 131                 n = 16 - (i%16);
 132                 printf(" ");
 133                 if (n>8) printf(" ");
 134                 while (n--) printf("   ");
 135
 136                 n = i%16;
 137                 if (n > 8) n = 8;
 138                 print_asc(&buf[i-(i%16)],n); printf(" ");
 139                 n = (i%16) - n;
 140                 if (n>0) print_asc(&buf[i-n],n);
 141                 printf("\n");
 142         }
 143 }
 144
 145 static void help(void)
 146 {
 147         printf("\n"
 148 "tdbtool: \n"
 149 "  create    dbname     : create a database\n"
 150 "  open      dbname     : open an existing database\n"
 151 "  erase                : erase the database\n"
 152 "  dump                 : dump the database as strings\n"
 153 "  keys                 : dump the database keys as strings\n"
 154 "  hexkeys              : dump the database keys as hex values\n"
 155 "  info                 : print summary info about the database\n"
 156 "  insert    key  data  : insert a record\n"
 157 "  move      key  file  : move a record to a destination tdb\n"
 158 "  store     key  data  : store a record (replace)\n"
 159 "  show      key        : show a record by key\n"
 160 "  delete    key        : delete a record by key\n"
 161 "  list                 : print the database hash table and freelist\n"
 162 "  free                 : print the database freelist\n"
 163 "  ! command            : execute system command\n"
 164 "  1 | first            : print the first record\n"
 165 "  n | next             : print the next record\n"
 166 "  q | quit             : terminate\n"
 167 "  \\n                   : repeat 'next' command\n"
 168 "\n");
 169 }
 170
 171 static void terror(const char *why)
 172 {
 173         printf("%s\n", why);
 174 }
 175
 176 static void create_tdb(const char *tdbname)
 177 {
 178         if (tdb) tdb_close(tdb);
 179         tdb = tdb_open(tdbname, 0, TDB_CLEAR_IF_FIRST,
 180                        O_RDWR | O_CREAT | O_TRUNC, 0600);
 181         if (!tdb) {
 182                 printf("Could not create %s: %s\n", tdbname, strerror(errno));
 183         }
 184 }
 185
 186 static void open_tdb(const char *tdbname)
 187 {
 188         if (tdb) tdb_close(tdb);
 189         tdb = tdb_open(tdbname, 0, 0, O_RDWR, 0600);
 190         if (!tdb) {
 191                 printf("Could not open %s: %s\n", tdbname, strerror(errno));
 192         }
 193 }
 194
 195 static void insert_tdb(char *keyname, size_t keylen, char* data, size_t datalen)
 196 {
 197         TDB_DATA key, dbuf;
 198
 199         if ((keyname == NULL) || (keylen == 0)) {
 200                 terror("need key");
 201                 return;
 202         }
 203
 204         key.dptr = (unsigned char *)keyname;
 205         key.dsize = keylen;
 206         dbuf.dptr = (unsigned char *)data;
 207         dbuf.dsize = datalen;
 208
 209         if (tdb_store(tdb, key, dbuf, TDB_INSERT) == -1) {
 210                 terror("insert failed");
 211         }
 212 }
 213
 214 static void store_tdb(char *keyname, size_t keylen, char* data, size_t datalen)
 215 {
 216         TDB_DATA key, dbuf;
 217
 218         if ((keyname == NULL) || (keylen == 0)) {
 219                 terror("need key");
 220                 return;
 221         }
 222
 223         if ((data == NULL) || (datalen == 0)) {
 224                 terror("need data");
 225                 return;
 226         }
 227
 228         key.dptr = (unsigned char *)keyname;
 229         key.dsize = keylen;
 230         dbuf.dptr = (unsigned char *)data;
 231         dbuf.dsize = datalen;
 232
 233         printf("Storing key:\n");
 234         print_rec(tdb, key, dbuf, NULL);
 235
 236         if (tdb_store(tdb, key, dbuf, TDB_REPLACE) == -1) {
 237                 terror("store failed");
 238         }
 239 }
 240
 241 static void show_tdb(char *keyname, size_t keylen)
 242 {
 243         TDB_DATA key, dbuf;
 244
 245         if ((keyname == NULL) || (keylen == 0)) {
 246                 terror("need key");
 247                 return;
 248         }
 249
 250         key.dptr = (unsigned char *)keyname;
 251         key.dsize = keylen;
 252
 253         dbuf = tdb_fetch(tdb, key);
 254         if (!dbuf.dptr) {
 255             terror("fetch failed");
 256             return;
 257         }
 258
 259         print_rec(tdb, key, dbuf, NULL);
 260
 261         free( dbuf.dptr );
 262
 263         return;
 264 }
 265
 266 static void delete_tdb(char *keyname, size_t keylen)
 267 {
 268         TDB_DATA key;
 269
 270         if ((keyname == NULL) || (keylen == 0)) {
 271                 terror("need key");
 272                 return;
 273         }
 274
 275         key.dptr = (unsigned char *)keyname;
 276         key.dsize = keylen;
 277
 278         if (tdb_delete(tdb, key) != 0) {
 279                 terror("delete failed");
 280         }
 281 }
 282
 283 static void move_rec(char *keyname, size_t keylen, char* tdbname)
 284 {
 285         TDB_DATA key, dbuf;
 286         TDB_CONTEXT *dst_tdb;
 287
 288         if ((keyname == NULL) || (keylen == 0)) {
 289                 terror("need key");
 290                 return;
 291         }
 292
 293         if ( !tdbname ) {
 294                 terror("need destination tdb name");
 295                 return;
 296         }
 297
 298         key.dptr = (unsigned char *)keyname;
 299         key.dsize = keylen;
 300
 301         dbuf = tdb_fetch(tdb, key);
 302         if (!dbuf.dptr) {
 303                 terror("fetch failed");
 304                 return;
 305         }
 306
 307         print_rec(tdb, key, dbuf, NULL);
 308
 309         dst_tdb = tdb_open(tdbname, 0, 0, O_RDWR, 0600);
 310         if ( !dst_tdb ) {
 311                 terror("unable to open destination tdb");
 312                 return;
 313         }
 314
 315         if ( tdb_store( dst_tdb, key, dbuf, TDB_REPLACE ) == -1 ) {
 316                 terror("failed to move record");
 317         }
 318         else
 319                 printf("record moved\n");
 320
 321         tdb_close( dst_tdb );
 322
 323         return;
 324 }
 325
 326 static int print_rec(TDB_CONTEXT *the_tdb, TDB_DATA key, TDB_DATA dbuf, void *state)
 327 {
 328         printf("\nkey %d bytes\n", (int)key.dsize);
 329         print_asc((const char *)key.dptr, key.dsize);
 330         printf("\ndata %d bytes\n", (int)dbuf.dsize);
 331         print_data((const char *)dbuf.dptr, dbuf.dsize);
 332         return 0;
 333 }
 334
 335 static int print_key(TDB_CONTEXT *the_tdb, TDB_DATA key, TDB_DATA dbuf, void *state)
 336 {
 337         printf("key %d bytes: ", (int)key.dsize);
 338         print_asc((const char *)key.dptr, key.dsize);
 339         printf("\n");
 340         return 0;
 341 }
 342
 343 static int print_hexkey(TDB_CONTEXT *the_tdb, TDB_DATA key, TDB_DATA dbuf, void *state)
 344 {
 345         printf("key %d bytes\n", (int)key.dsize);
 346         print_data((const char *)key.dptr, key.dsize);
 347         printf("\n");
 348         return 0;
 349 }
 350
 351 static int total_bytes;
 352
 353 static int traverse_fn(TDB_CONTEXT *the_tdb, TDB_DATA key, TDB_DATA dbuf, void *state)
 354 {
 355         total_bytes += dbuf.dsize;
 356         return 0;
 357 }
 358
 359 static void info_tdb(void)
 360 {
 361         int count;
 362         total_bytes = 0;
 363         if ((count = tdb_traverse(tdb, traverse_fn, NULL)) == -1)
 364                 printf("Error = %s\n", tdb_errorstr(tdb));
 365         else
 366                 printf("%d records totalling %d bytes\n", count, total_bytes);
 367 }
 368
 369 static char *tdb_getline(const char *prompt)
 370 {
 371         static char thisline[1024];
 372         char *p;
 373         fputs(prompt, stdout);
 374         thisline[0] = 0;
 375         p = fgets(thisline, sizeof(thisline)-1, stdin);
 376         if (p) p = strchr(p, '\n');
 377         if (p) *p = 0;
 378         return p?thisline:NULL;
 379 }
 380
 381 static int do_delete_fn(TDB_CONTEXT *the_tdb, TDB_DATA key, TDB_DATA dbuf,
 382                      void *state)
 383 {
 384     return tdb_delete(the_tdb, key);
 385 }
 386
 387 static void first_record(TDB_CONTEXT *the_tdb, TDB_DATA *pkey)
 388 {
 389         TDB_DATA dbuf;
 390         *pkey = tdb_firstkey(the_tdb);
 391
 392         dbuf = tdb_fetch(the_tdb, *pkey);
 393         if (!dbuf.dptr) terror("fetch failed");
 394         else {
 395                 print_rec(the_tdb, *pkey, dbuf, NULL);
 396         }
 397 }
 398
 399 static void next_record(TDB_CONTEXT *the_tdb, TDB_DATA *pkey)
 400 {
 401         TDB_DATA dbuf;
 402         *pkey = tdb_nextkey(the_tdb, *pkey);
 403
 404         dbuf = tdb_fetch(the_tdb, *pkey);
 405         if (!dbuf.dptr)
 406                 terror("fetch failed");
 407         else
 408                 print_rec(the_tdb, *pkey, dbuf, NULL);
 409 }
 410
 411 static int do_command(void)
 412 {
 413         COMMAND_TABLE *ctp = cmd_table;
 414         enum commands mycmd = CMD_HELP;
 415         int cmd_len;
 416
 417         if (cmdname && strlen(cmdname) == 0) {
 418             mycmd = CMD_NEXT;
 419         } else {
 420             while (ctp->name) {
 421                 cmd_len = strlen(ctp->name);
 422                 if (strncmp(ctp->name,cmdname,cmd_len) == 0) {
 423                         mycmd = ctp->cmd;
 424                         break;
 425                 }
 426                 ctp++;
 427             }
 428         }
 429
 430         switch (mycmd) {
 431         case CMD_CREATE_TDB:
 432             bIterate = 0;
 433             create_tdb(arg1);
 434             return 0;
 435         case CMD_OPEN_TDB:
 436             bIterate = 0;
 437             open_tdb(arg1);
 438             return 0;
 439         case CMD_SYSTEM:
 440             /* Shell command */
 441             system(arg1);
 442             return 0;
 443         case CMD_QUIT:
 444             return 1;
 445         default:
 446             /* all the rest require a open database */
 447             if (!tdb) {
 448                 bIterate = 0;
 449                 terror("database not open");
 450                 help();
 451                 return 0;
 452             }
 453             switch (mycmd) {
 454             case CMD_ERASE:
 455                 bIterate = 0;
 456                 tdb_traverse(tdb, do_delete_fn, NULL);
 457                 return 0;
 458             case CMD_DUMP:
 459                 bIterate = 0;
 460                 tdb_traverse(tdb, print_rec, NULL);
 461                 return 0;
 462             case CMD_INSERT:
 463                 bIterate = 0;
 464                 insert_tdb(arg1, arg1len,arg2,arg2len);
 465                 return 0;
 466             case CMD_MOVE:
 467                 bIterate = 0;
 468                 move_rec(arg1,arg1len,arg2);
 469                 return 0;
 470             case CMD_STORE:
 471                 bIterate = 0;
 472                 store_tdb(arg1,arg1len,arg2,arg2len);
 473                 return 0;
 474             case CMD_SHOW:
 475                 bIterate = 0;
 476                 show_tdb(arg1, arg1len);
 477                 return 0;
 478             case CMD_KEYS:
 479                 tdb_traverse(tdb, print_key, NULL);
 480                 return 0;
 481             case CMD_HEXKEYS:
 482                 tdb_traverse(tdb, print_hexkey, NULL);
 483                 return 0;
 484             case CMD_DELETE:
 485                 bIterate = 0;
 486                 delete_tdb(arg1,arg1len);
 487                 return 0;
 488             case CMD_LIST_HASH_FREE:
 489                 tdb_dump_all(tdb);
 490                 return 0;
 491             case CMD_LIST_FREE:
 492                 tdb_printfreelist(tdb);
 493                 return 0;
 494             case CMD_INFO:
 495                 info_tdb();
 496                 return 0;
 497             case CMD_FIRST:
 498                 bIterate = 1;
 499                 first_record(tdb, &iterate_kbuf);
 500                 return 0;
 501             case CMD_NEXT:
 502                if (bIterate)
 503                   next_record(tdb, &iterate_kbuf);
 504                 return 0;
 505             case CMD_HELP:
 506                 help();
 507                 return 0;
 508             case CMD_CREATE_TDB:
 509             case CMD_OPEN_TDB:
 510             case CMD_SYSTEM:
 511             case CMD_QUIT:
 512                 /*
 513                  * unhandled commands.  cases included here to avoid compiler
 514                  * warnings.
 515                  */
 516                 return 0;
 517             }
 518         }
 519
 520         return 0;
 521 }
 522
 523 static char *convert_string(char *instring, size_t *sizep)
 524 {
 525     size_t length = 0;
 526     char *outp, *inp;
 527     char temp[3];
 528
 529
 530     outp = inp = instring;
 531
 532     while (*inp) {
 533         if (*inp == '\\') {
 534             inp++;
 535             if (*inp && strchr("0123456789abcdefABCDEF",(int)*inp)) {
 536                 temp[0] = *inp++;
 537                 temp[1] = '\0';
 538                 if (*inp && strchr("0123456789abcdefABCDEF",(int)*inp)) {
 539                     temp[1] = *inp++;
 540                     temp[2] = '\0';
 541                 }
 542                 *outp++ = (char)strtol((const char *)temp,NULL,16);
 543             } else {
 544                 *outp++ = *inp++;
 545             }
 546         } else {
 547             *outp++ = *inp++;
 548         }
 549         length++;
 550     }
 551     *sizep = length;
 552     return instring;
 553 }
 554
 555 int main(int argc, char *argv[])
 556 {
 557     cmdname = "";
 558     arg1 = NULL;
 559     arg1len = 0;
 560     arg2 = NULL;
 561     arg2len = 0;
 562
 563     if (argv[1]) {
 564         cmdname = "open";
 565         arg1 = argv[1];
 566         do_command();
 567         cmdname =  "";
 568         arg1 = NULL;
 569     }
 570
 571     switch (argc) {
 572         case 1:
 573         case 2:
 574             /* Interactive mode */
 575             while ((cmdname = tdb_getline("tdb> "))) {
 576                 arg2 = arg1 = NULL;
 577                 if ((arg1 = strchr((const char *)cmdname,' ')) != NULL) {
 578                     arg1++;
 579                     arg2 = arg1;
 580                     while (*arg2) {
 581                         if (*arg2 == ' ') {
 582                             *arg2++ = '\0';
 583                             break;
 584                         }
 585                         if ((*arg2++ == '\\') && (*arg2 == ' ')) {
 586                             arg2++;
 587                         }
 588                     }
 589                 }
 590                 if (arg1) arg1 = convert_string(arg1,&arg1len);
 591                 if (arg2) arg2 = convert_string(arg2,&arg2len);
 592                 if (do_command()) break;
 593             }
 594             break;
 595         case 5:
 596             arg2 = convert_string(argv[4],&arg2len);
 597         case 4:
 598             arg1 = convert_string(argv[3],&arg1len);
 599         case 3:
 600             cmdname = argv[2];
 601         default:
 602             do_command();
 603             break;
 604     }
 605
 606     if (tdb) tdb_close(tdb);
 607
 608     return 0;
 609 }