/src/gdbm/tools/gdbmshell.c

Source (jump to first uncovered line)
/* This file is part of GDBM, the GNU data base manager.
   Copyright (C) 1990-2025 Free Software Foundation, Inc.

   GDBM is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 3, or (at your option)
   any later version.

   GDBM is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with GDBM. If not, see <http://www.gnu.org/licenses/>.    */

#include "gdbmtool.h"
#include "gdbm.h"
#include "gram.h"

#include <errno.h>
#include <ctype.h>
#include <signal.h>
#include <pwd.h>
#include <sys/ioctl.h>
#include <sys/wait.h>
#include <sys/time.h>
#include <sys/resource.h>
#include <termios.h>
#include <stdarg.h>
#ifdef HAVE_LOCALE_H
# include <locale.h>
#endif
#include <assert.h>

static GDBM_FILE gdbm_file = NULL;   /* Database to operate upon */
static datum key_data;               /* Current key */
static datum return_data;            /* Current data */

/* Return values for handlers: */
enum
  {
    GDBMSHELL_OK,       /* Success */
    GDBMSHELL_GDBM_ERR, /* GDBM error */
    GDBMSHELL_SYNTAX,   /* Syntax error (invalid argument etc) */
    GDBMSHELL_ERR,      /* Other error */
    GDBMSHELL_CANCEL    /* Operation canceled */
  };

static void
datum_free (datum *dp)
{
  free (dp->dptr);
  dp->dptr = NULL;
}


int
gdbmshell_setopt (char *name, int opt, int val)
{
  if (gdbm_file)
    {
      if (gdbm_setopt (gdbm_file, opt, &val, sizeof (val)) == -1)
  {
    dberror (_("%s failed"), name);
    return 1;
  }
    }
  return 0;
}

static void
closedb (void)
{
  if (gdbm_file)
    {
      gdbm_close (gdbm_file);
      gdbm_file = NULL;
      variable_unset ("fd");
    }

  datum_free (&key_data);
  datum_free (&return_data);
}

static int
opendb (char *dbname, int fd)
{
  int cache_size = 0;
  int block_size = 0;
  int flags;
  int filemode;
  GDBM_FILE db;
  int n;

  switch (variable_get ("cachesize", VART_INT, (void**) &cache_size))
    {
    case VAR_OK:
    case VAR_ERR_NOTSET:
      break;
    default:
      abort ();
    }
  switch (variable_get ("blocksize", VART_INT, (void**) &block_size))
    {
    case VAR_OK:
    case VAR_ERR_NOTSET:
      break;
    default:
      abort ();
    }

  if (variable_get ("open", VART_INT, (void**) &flags) != VAR_OK)
    abort ();

  if (flags == GDBM_NEWDB)
    {
      if (interactive () && variable_is_true ("confirm") &&
    access (dbname, F_OK) == 0)
  {
    if (!getyn (_("database %s already exists; overwrite"), dbname))
      return GDBMSHELL_CANCEL;
  }
    }

  if (variable_get ("format", VART_INT, (void**) &n) != VAR_OK)
    abort ();

  flags |= n;

  if (!variable_is_true ("lock"))
    flags |= GDBM_NOLOCK;
  if (!variable_is_true ("mmap"))
    flags |= GDBM_NOMMAP;
  if (variable_is_true ("sync"))
    flags |= GDBM_SYNC;

  if (variable_get ("filemode", VART_INT, (void**) &filemode))
    abort ();

  if (fd > 0)
    db = gdbm_fd_open (fd, dbname, block_size, flags | GDBM_CLOERROR, NULL);
  else
    {
      char *name = tildexpand (dbname);
      db = gdbm_open (name, block_size, flags, filemode, NULL);
      free (name);
    }

  if (db == NULL)
    {
      dberror (_("cannot open database %s"), dbname);
      return GDBMSHELL_GDBM_ERR;
    }

  if (cache_size &&
      gdbm_setopt (db, GDBM_CACHESIZE, &cache_size, sizeof (int)) == -1)
    dberror (_("%s failed"), "GDBM_CACHESIZE");

  if (gdbm_file)
    gdbm_close (gdbm_file);

  gdbm_file = db;

  if (variable_is_true ("coalesce"))
    {
      gdbmshell_setopt ("GDBM_SETCOALESCEBLKS", GDBM_SETCOALESCEBLKS, 1);
    }
  if (variable_is_true ("centfree"))
    {
      gdbmshell_setopt ("GDBM_SETCENTFREE", GDBM_SETCENTFREE, 1);
    }

  return GDBMSHELL_OK;
}

static int
checkdb (void)
{
  if (!gdbm_file)
    {
      char *filename;
      int fd = -1;
      variable_get ("filename", VART_STRING, (void**) &filename);
      variable_get ("fd", VART_INT, (void**) &fd);
      return opendb (filename, fd);
    }
  return GDBMSHELL_OK;
}

static int
checkdb_begin (struct command_param *param GDBM_ARG_UNUSED,
         struct command_environ *cenv GDBM_ARG_UNUSED)
{
  return checkdb ();
}

static void
format_key_start (PAGERFILE *fp, bucket_element *elt)
{
  int size = SMALL < elt->key_size ? SMALL : elt->key_size;
  int i;

  for (i = 0; i < size; i++)
    {
      if (isprint (elt->key_start[i]))
  pager_printf (fp, "   %c", elt->key_start[i]);
      else
  pager_printf (fp, " %03o", elt->key_start[i]);
    }
}

static inline int
bucket_refcount (void)
{
  return 1 << (gdbm_file->header->dir_bits - gdbm_file->bucket->bucket_bits);
}

static inline int
bucket_dir_start (void)
{
  int d = gdbm_file->header->dir_bits - gdbm_file->bucket->bucket_bits;
  return (gdbm_file->bucket_dir >> d) << d;
}

static inline int
bucket_dir_sibling (void)
{
  int d = gdbm_file->header->dir_bits - gdbm_file->bucket->bucket_bits;
  return ((gdbm_file->bucket_dir >> d) ^ 1) << d;
}

/* Debug procedure to print the contents of the current hash bucket. */
static void
print_bucket (PAGERFILE *pager)
{
  int index;
  int hash_prefix;
  off_t adr = gdbm_file->dir[gdbm_file->bucket_dir];
  hash_bucket *bucket = gdbm_file->bucket;
  int start = bucket_dir_start ();
  int dircount = bucket_refcount ();

  hash_prefix = start << (GDBM_HASH_BITS - gdbm_file->header->dir_bits);

  pager_printf (pager, "******* ");
  pager_printf (pager, _("Bucket #%d"), gdbm_file->bucket_dir);
  pager_printf (pager, " **********\n\n");
  pager_printf (pager,
    _("address     = %lu\n"
      "depth       = %d\n"
      "hash prefix = %08x\n"
      "references  = %u"),
    (unsigned long) adr,
    bucket->bucket_bits,
    hash_prefix,
    dircount);
  if (dircount > 1)
    {
      pager_printf (pager, " (%d-%d)", start, start + dircount - 1);
    }
  pager_printf (pager, "\n");

  pager_printf (pager,
    _("count       = %d\n"
      "load factor = %3d\n"),
    bucket->count,
    bucket->count * 100 / gdbm_file->header->bucket_elems);

  pager_printf (pager, "%s", _("Hash Table:\n"));
  pager_printf (pager,
    _("    #    hash value     key size    data size     data adr home  key start\n"));
  for (index = 0; index < gdbm_file->header->bucket_elems; index++)
    {
      pager_printf (pager, " %4d  %12x  %11d  %11d  %11lu %4d", index,
        bucket->h_table[index].hash_value,
        bucket->h_table[index].key_size,
        bucket->h_table[index].data_size,
        (unsigned long) bucket->h_table[index].data_pointer,
        bucket->h_table[index].hash_value %
        gdbm_file->header->bucket_elems);
      if (bucket->h_table[index].key_size)
  {
    pager_printf (pager, " ");
    format_key_start (pager, &bucket->h_table[index]);
  }
      pager_printf (pager, "\n");
    }

  pager_printf (pager, _("\nAvail count = %d\n"), bucket->av_count);
  pager_printf (pager, _("Address           size\n"));
  for (index = 0; index < bucket->av_count; index++)
    pager_printf (pager, "%11lu%9d\n",
      (unsigned long) bucket->bucket_avail[index].av_adr,
      bucket->bucket_avail[index].av_size);
}

static void
av_table_display (avail_elem *av_table, int count, PAGERFILE *pager)
{
  int i;

  for (i = 0; i < count; i++)
    {
      pager_printf (pager, "  %15d   %10lu \n",
        av_table[i].av_size, (unsigned long) av_table[i].av_adr);
    }
}

static int
avail_list_print (avail_block *avblk, off_t n, void *data)
{
  PAGERFILE *pager = data;

  pager_putc (pager, '\n');
  if (n == 0)
    pager_writez (pager, _("header block"));
  else
    pager_printf (pager, _("block = %lu"), (unsigned long) n);
  pager_printf (pager, _("\nsize  = %d\ncount = %d\n"),
    avblk->size, avblk->count);
  av_table_display (avblk->av_table, avblk->count, pager);
  return 0;
}

static int
_gdbm_print_avail_list (PAGERFILE *fp, GDBM_FILE dbf)
{
  int rc = gdbm_avail_traverse (dbf, avail_list_print, fp);
  if (rc)
    dberror (_("%s failed"), "gdbm_avail_traverse");
  return GDBMSHELL_GDBM_ERR;
}

static void
_gdbm_print_bucket_cache (PAGERFILE *fp, GDBM_FILE dbf)
{
  if (dbf->cache_num)
    {
      int i;
      cache_elem *elem;

      pager_printf (fp,
  _("Bucket Cache (size %zu/%zu):\n  Index:         Address  Changed  Data_Hash \n"),
        dbf->cache_num, dbf->cache_size);
      for (elem = dbf->cache_mru, i = 0; elem; elem = elem->ca_next, i++)
  {
    pager_printf (fp, "  %5d:  %15lu %7s  %x\n",
      i,
      (unsigned long) elem->ca_adr,
      (elem->ca_changed ? _("True") : _("False")),
      elem->ca_data.hash_val);
  }
    }
  else
    pager_writeln (fp, _("Bucket cache is empty."));
}

static int
trimnl (char *str)
{
  int len = strlen (str);

  if (str[len - 1] == '\n')
    {
      str[--len] = 0;
      return 1;
    }
  return 0;
}

static int
get_screen_lines (void)
{
#ifdef TIOCGWINSZ
  if (isatty (1))
    {
      struct winsize ws;

      ws.ws_col = ws.ws_row = 0;
      if ((ioctl(1, TIOCGWINSZ, (char *) &ws) < 0) || ws.ws_row == 0)
  {
    const char *lines = getenv ("LINES");
    if (lines)
      ws.ws_row = strtol (lines, NULL, 10);
  }
      return ws.ws_row;
    }
#else
  const char *lines = getenv ("LINES");
  if (lines)
    return strtol (lines, NULL, 10);
#endif
  return -1;
}

/* Open database */
static int
open_handler (struct command_param *param,
        struct command_environ *cenv GDBM_ARG_UNUSED)
{
  char *filename;
  int fd = -1;
  int rc;

  closedb ();

  if (param->argc == 1)
    filename = PARAM_STRING (param, 0);
  else
    {
      variable_get ("filename", VART_STRING, (void**) &filename);
      variable_get ("fd", VART_INT, (void**) &fd);
    }

  if ((rc = opendb (filename, fd)) == GDBMSHELL_OK)
    {
      variable_set ("filename", VART_STRING, filename);
      if (fd >= 0)
  variable_set ("fd", VART_INT, &fd);
      else
  variable_unset ("fd");
    }
  return rc;
}

/* Close database */
static int
close_handler (struct command_param *param GDBM_ARG_UNUSED,
         struct command_environ *cenv GDBM_ARG_UNUSED)
{
  if (!gdbm_file)
    terror ("%s", _("nothing to close"));
  else
    closedb ();
  return GDBMSHELL_OK;
}

static char *
count_to_str (gdbm_count_t count, char *buf, size_t bufsize)
{
  char *p = buf + bufsize;

  *--p = 0;
  if (count == 0)
    *--p = '0';
  else
    while (count)
      {
  if (p == buf)
    return NULL;
  *--p = '0' + count % 10;
  count /= 10;
      }
  return p;
}

/* count - count items in the database */
static int
count_handler (struct command_param *param GDBM_ARG_UNUSED,
         struct command_environ *cenv)
{
  gdbm_count_t count;

  if (gdbm_count (gdbm_file, &count))
    {
      dberror (_("%s failed"), "gdbm_count");
      return GDBMSHELL_GDBM_ERR;
    }
  else
    {
      char buf[128];
      char *p = count_to_str (count, buf, sizeof buf);

      if (!p)
  terror ("%s", _("count buffer overflow"));
      else
  pager_printf (cenv->pager,
          ngettext ("There is %s item in the database.\n",
        "There are %s items in the database.\n",
        count),
          p);
    }
  return GDBMSHELL_OK;
}

/* delete KEY - delete a key*/
static int
delete_handler (struct command_param *param, struct command_environ *cenv)
{
  if (gdbm_delete (gdbm_file, PARAM_DATUM (param, 0)) != 0)
    {
      if (gdbm_errno == GDBM_ITEM_NOT_FOUND)
  {
    if (!gdbm_error_is_masked (gdbm_errno))
      terror ("%s", _("No such item found"));
  }
      else
  dberror ("%s", _("Can't delete"));
      return GDBMSHELL_GDBM_ERR;
    }
  return GDBMSHELL_OK;
}

/* fetch KEY - fetch a record by its key */
static int
fetch_handler (struct command_param *param, struct command_environ *cenv)
{
  return_data = gdbm_fetch (gdbm_file, PARAM_DATUM (param, 0));
  if (return_data.dptr != NULL)
    {
      datum_format (cenv->pager, &return_data, dsdef[DS_CONTENT]);
      pager_putc (cenv->pager, '\n');
      datum_free (&return_data);
      return GDBMSHELL_OK;
    }
  else if (gdbm_errno == GDBM_ITEM_NOT_FOUND)
    {
      if (!gdbm_error_is_masked (gdbm_errno))
  terror ("%s", _("No such item found"));
    }
  else
    dberror ("%s", _("Can't fetch data"));
  return GDBMSHELL_GDBM_ERR;
}

/* store KEY DATA - store data */
static int
store_handler (struct command_param *param,
         struct command_environ *cenv GDBM_ARG_UNUSED)
{
  if (gdbm_store (gdbm_file,
      PARAM_DATUM (param, 0), PARAM_DATUM (param, 1),
      GDBM_REPLACE) != 0)
    {
      dberror ("%s", _("Item not inserted"));
      return GDBMSHELL_GDBM_ERR;
    }
  return GDBMSHELL_OK;
}

/* first - begin iteration */

static int
firstkey_handler (struct command_param *param, struct command_environ *cenv)
{
  datum_free (&key_data);
  key_data = gdbm_firstkey (gdbm_file);
  if (key_data.dptr != NULL)
    {
      datum_format (cenv->pager, &key_data, dsdef[DS_KEY]);
      pager_putc (cenv->pager, '\n');

      return_data = gdbm_fetch (gdbm_file, key_data);
      datum_format (cenv->pager, &return_data, dsdef[DS_CONTENT]);
      pager_putc (cenv->pager, '\n');


      datum_free (&return_data);
      return GDBMSHELL_OK;
    }
  else if (gdbm_errno == GDBM_ITEM_NOT_FOUND)
    {
      if (!gdbm_error_is_masked (gdbm_errno))
  pager_writez (cenv->pager, _("No such item found.\n"));
    }
  else
    dberror ("%s", _("Can't find first key"));
  return GDBMSHELL_GDBM_ERR;
}

/* next [KEY] - next key */
static int
nextkey_handler (struct command_param *param, struct command_environ *cenv)
{
  if (param->argc == 1)
    {
      datum_free (&key_data);
      key_data.dptr = emalloc (PARAM_DATUM (param, 0).dsize);
      key_data.dsize = PARAM_DATUM (param, 0).dsize;
      memcpy (key_data.dptr, PARAM_DATUM (param, 0).dptr, key_data.dsize);
    }
  return_data = gdbm_nextkey (gdbm_file, key_data);
  if (return_data.dptr != NULL)
    {
      datum_free (&key_data);
      key_data = return_data;
      datum_format (cenv->pager, &key_data, dsdef[DS_KEY]);
      pager_putc (cenv->pager, '\n');

      return_data = gdbm_fetch (gdbm_file, key_data);
      datum_format (cenv->pager, &return_data, dsdef[DS_CONTENT]);
      pager_putc (cenv->pager, '\n');

      datum_free (&return_data);
      return GDBMSHELL_OK;
    }
  else if (gdbm_errno == GDBM_ITEM_NOT_FOUND)
    {
      if (!gdbm_error_is_masked (gdbm_errno))
  terror ("%s", _("No such item found"));
      datum_free (&key_data);
    }
  else
    dberror ("%s", _("Can't find next key"));
  return GDBMSHELL_GDBM_ERR;
}

/* reorganize */
static int
reorganize_handler (struct command_param *param GDBM_ARG_UNUSED,
        struct command_environ *cenv)
{
  if (gdbm_reorganize (gdbm_file))
    {
      dberror ("%s", _("Reorganization failed"));
      return GDBMSHELL_GDBM_ERR;
    }
  else
    pager_writeln (cenv->pager, _("Reorganization succeeded."));
  return GDBMSHELL_OK;
}

static void
err_printer (void *data GDBM_ARG_UNUSED, char const *fmt, ...)
{
  va_list ap;

  va_start (ap, fmt);
  vfprintf (stderr, fmt, ap);
  va_end (ap);
  fprintf (stderr, "\n");
}

/* recover summary verbose backup max-failed-keys=N max-failed-buckets=N max-failures=N */
static int
recover_handler (struct command_param *param, struct command_environ *cenv)
{
  gdbm_recovery rcvr;
  int flags = 0;
  int rc;
  char *p;
  int summary = 0;

  if (param->vararg)
    {
      struct gdbmarg *arg;
      int i;

      for (arg = param->vararg, i = 0; arg; arg = arg->next, i++)
  {
    if (arg->type == GDBM_ARG_STRING)
      {
        if (strcmp (arg->v.string, "verbose") == 0)
    {
      rcvr.errfun = err_printer;
      flags |= GDBM_RCVR_ERRFUN;
    }
        else if (strcmp (arg->v.string, "force") == 0)
    {
      flags |= GDBM_RCVR_FORCE;
    }
        else if (strcmp (arg->v.string, "summary") == 0)
    {
      summary = 1;
    }
        else if (strcmp (arg->v.string, "backup") == 0)
    {
      flags |= GDBM_RCVR_BACKUP;
    }
        else
    {
      lerror (&arg->loc, _("unrecognized argument: %s"), arg->v.string);
      return GDBMSHELL_SYNTAX;
    }
      }
    else if (arg->type == GDBM_ARG_KVPAIR)
      {
        if (arg->v.kvpair->type != KV_STRING)
    {
      lerror (&arg->loc, _("%s: bad argument type"), arg->v.kvpair->key);
      return GDBMSHELL_SYNTAX;
    }
        else if (arg->v.kvpair->next)
    {
      lerror (&arg->loc, _("unexpected compound statement"));
      return GDBMSHELL_SYNTAX;
    }

        if (strcmp (arg->v.kvpair->key, "max-failures") == 0)
    {
      rcvr.max_failures = strtoul (arg->v.kvpair->val.s, &p, 10);
      if (*p)
        {
          lerror (&arg->loc, _("not a number (stopped near %s)"), p);
          return GDBMSHELL_SYNTAX;
        }
      flags |= GDBM_RCVR_MAX_FAILURES;
    }
        else if (strcmp (arg->v.kvpair->key, "max-failed-keys") == 0)
    {
      rcvr.max_failed_keys = strtoul (arg->v.kvpair->val.s, &p, 10);
      if (*p)
        {
          lerror (&arg->loc, _("not a number (stopped near %s)"), p);
          return GDBMSHELL_SYNTAX;
        }
      flags |= GDBM_RCVR_MAX_FAILED_KEYS;
    }
        else if (strcmp (arg->v.kvpair->key, "max-failed-buckets") == 0)
    {
      rcvr.max_failures = strtoul (arg->v.kvpair->val.s, &p, 10);
      if (*p)
        {
          lerror (&arg->loc, _("not a number (stopped near %s)"), p);
          return GDBMSHELL_SYNTAX;
        }
      flags |= GDBM_RCVR_MAX_FAILED_BUCKETS;
    }
        else
    {
      lerror (&arg->loc, _("unrecognized argument: %s"), arg->v.kvpair->key);
      return GDBMSHELL_SYNTAX;
    }
      }
    else
      {
        lerror (&arg->loc, _("unexpected datum"));
        return GDBMSHELL_SYNTAX;
      }
  }
    }

  rc = gdbm_recover (gdbm_file, &rcvr, flags);

  if (rc == 0)
    {
      pager_writeln (cenv->pager, _("Recovery succeeded."));
      if (summary)
  {
    pager_printf (cenv->pager,
      _("Keys recovered: %lu, failed: %lu, duplicate: %lu\n"),
      (unsigned long) rcvr.recovered_keys,
      (unsigned long) rcvr.failed_keys,
      (unsigned long) rcvr.duplicate_keys);
    pager_printf (cenv->pager,
      _("Buckets recovered: %lu, failed: %lu\n"),
      (unsigned long) rcvr.recovered_buckets,
      (unsigned long) rcvr.failed_buckets);
  }

      if (rcvr.backup_name)
  {
    pager_printf (cenv->pager,
      _("Original database preserved in file %s"),
      rcvr.backup_name);
    free (rcvr.backup_name);
  }
      pager_putc (cenv->pager, '\n');
    }
  else
    {
      dberror ("%s", _("Recovery failed"));
      rc = GDBMSHELL_GDBM_ERR;
    }
  return rc;
}

/* avail - print available list */
static int
avail_handler (struct command_param *param GDBM_ARG_UNUSED,
         struct command_environ *cenv)
{
  return _gdbm_print_avail_list (cenv->pager, gdbm_file);
}

/* print current bucket */
static int
print_current_bucket_handler (struct command_param *param,
            struct command_environ *cenv)
{
  if (!gdbm_file->bucket)
    pager_writeln (cenv->pager, _("no current bucket"));
  else
    print_bucket (cenv->pager);
  return GDBMSHELL_OK;
}

int
getnum (int *pnum, char *arg, char **endp)
{
  char *p;
  unsigned long x = strtoul (arg, &p, 10);
  if (*p && !isspace (*p))
    {
      terror (_("not a number (stopped near %s)"), p);
      return 1;
    }
  while (*p && isspace (*p))
    p++;
  if (endp)
    *endp = p;
  else if (*p)
    {
      terror (_("not a number (stopped near %s)"), p);
      return 1;
    }
  *pnum = x;
  return 0;
}

static int
get_bucket_num (int *pnum, char *arg, struct locus const *loc)
{
  int n;

  if (getnum (&n, arg, NULL))
    return GDBMSHELL_SYNTAX;

  if (n >= GDBM_DIR_COUNT (gdbm_file))
    {
      lerror (loc,
        _("bucket number out of range (0..%lu)"),
        GDBM_DIR_COUNT (gdbm_file));
      return GDBMSHELL_SYNTAX;
    }
  *pnum = n;
  return GDBMSHELL_OK;
}

/* bucket NUM - print a bucket and set it as a current one.
   Uses print_current_bucket_handler */
static int
print_bucket_begin (struct command_param *param,
        struct command_environ *cenv GDBM_ARG_UNUSED)
{
  int rc;
  int n = -1;

  if ((rc = checkdb ()) != GDBMSHELL_OK)
    return rc;

  if (param->argc == 1)
    {
      if ((rc = get_bucket_num (&n, PARAM_STRING (param, 0),
        PARAM_LOCPTR (param, 0))) != GDBMSHELL_OK)
  return rc;
    }
  else if (!gdbm_file->bucket)
    n = 0;

  if (n != -1)
    {
      if (_gdbm_get_bucket (gdbm_file, n))
  {
    dberror (_("%s failed"), "_gdbm_get_bucket");
    return GDBMSHELL_GDBM_ERR;
  }
    }

  return GDBMSHELL_OK;
}

static int
print_sibling_bucket_begin (struct command_param *param,
          struct command_environ *cenv GDBM_ARG_UNUSED)
{
  int rc, n0, n, bucket_bits;

  if ((rc = checkdb ()) != GDBMSHELL_OK)
    return rc;
  if (!gdbm_file->bucket)
    {
      fprintf (stderr, _("no current bucket\n"));
      return GDBMSHELL_ERR;
    }

  n0 = gdbm_file->bucket_dir;
  bucket_bits = gdbm_file->bucket->bucket_bits;
  n = bucket_dir_sibling ();

  if (n > GDBM_DIR_COUNT (gdbm_file))
    {
      fprintf (stderr, _("no sibling\n"));
      return GDBMSHELL_ERR;
    }

  if (_gdbm_get_bucket (gdbm_file, n))
    {
      dberror (_("%s failed"), "_gdbm_get_bucket");
      return GDBMSHELL_GDBM_ERR;
    }

  if (bucket_bits != gdbm_file->bucket->bucket_bits)
    {
      fprintf (stderr, _("no sibling\n"));
      if (_gdbm_get_bucket (gdbm_file, n0))
  {
    dberror (_("%s failed"), "_gdbm_get_bucket");
    return GDBMSHELL_GDBM_ERR;
  }
      return GDBMSHELL_ERR;
    }

  return GDBMSHELL_OK;
}

/* dir - print hash directory */
static size_t
bucket_count (void)
{
  size_t count = 0;

  if (gdbm_bucket_count (gdbm_file, &count))
    {
      dberror ("%s", "gdbm_bucket_count");
    }
  return count;
}

static int
print_dir_handler (struct command_param *param GDBM_ARG_UNUSED,
       struct command_environ *cenv)
{
  int i;

  pager_writeln (cenv->pager, _("Hash table directory."));
  pager_printf (cenv->pager,
    _("  Size =  %d.  Capacity = %lu.  Bits = %d,  Buckets = %zu.\n\n"),
    gdbm_file->header->dir_size,
    GDBM_DIR_COUNT (gdbm_file),
    gdbm_file->header->dir_bits,
    bucket_count ());

  pager_printf (cenv->pager, "#%11s  %8s  %s\n",
    _("Index"), _("Hash Pfx"), _("Bucket address"));
  for (i = 0; i < GDBM_DIR_COUNT (gdbm_file); i++)
    pager_printf (cenv->pager, "  %10d: %08x %12lu\n",
      i,
      i << (GDBM_HASH_BITS - gdbm_file->header->dir_bits),
      (unsigned long) gdbm_file->dir[i]);

  return GDBMSHELL_OK;
}

/* header - print file handler */
static int
print_header_handler (struct command_param *param GDBM_ARG_UNUSED,
          struct command_environ *cenv)
{
  PAGERFILE *pager = cenv->pager;
  char const *type;

  switch (gdbm_file->header->header_magic)
    {
    case GDBM_OMAGIC:
      type = "GDBM (old)";
      break;

    case GDBM_MAGIC:
      type = "GDBM (standard)";
      break;

    case GDBM_NUMSYNC_MAGIC:
      type = "GDBM (numsync)";
      break;

    default:
      abort ();
    }

  pager_printf (pager, _("\nFile Header: \n\n"));
  pager_printf (pager, _("  type            = %s\n"), type);
  pager_printf (pager, _("  directory start = %lu\n"),
    (unsigned long) gdbm_file->header->dir);
  pager_printf (pager, _("  directory size  = %d\n"), gdbm_file->header->dir_size);
  pager_printf (pager, _("  directory depth = %d\n"), gdbm_file->header->dir_bits);
  pager_printf (pager, _("  block size      = %d\n"), gdbm_file->header->block_size);
  pager_printf (pager, _("  bucket elems    = %d\n"), gdbm_file->header->bucket_elems);
  pager_printf (pager, _("  bucket size     = %d\n"), gdbm_file->header->bucket_size);
  pager_printf (pager, _("  header magic    = %x\n"), gdbm_file->header->header_magic);
  pager_printf (pager, _("  next block      = %lu\n"),
     (unsigned long) gdbm_file->header->next_block);

  pager_printf (pager, _("  avail size      = %d\n"), gdbm_file->avail->size);
  pager_printf (pager, _("  avail count     = %d\n"), gdbm_file->avail->count);
  pager_printf (pager, _("  avail next block= %lu\n"),
     (unsigned long) gdbm_file->avail->next_block);

  if (gdbm_file->xheader)
    {
      pager_printf (pager, _("\nExtended Header: \n\n"));
      pager_printf (pager, _("      version = %d\n"), gdbm_file->xheader->version);
      pager_printf (pager, _("      numsync = %u\n"), gdbm_file->xheader->numsync);
    }

  return GDBMSHELL_OK;
}

static int
sync_handler (struct command_param *param GDBM_ARG_UNUSED,
        struct command_environ *cenv GDBM_ARG_UNUSED)
{
  if (gdbm_sync (gdbm_file))
    {
      dberror ("%s", "gdbm_sync");
      return GDBMSHELL_GDBM_ERR;
    }
  return GDBMSHELL_OK;
}

static int
upgrade_handler (struct command_param *param GDBM_ARG_UNUSED,
     struct command_environ *cenv GDBM_ARG_UNUSED)
{
  if (gdbm_convert (gdbm_file, GDBM_NUMSYNC))
    {
      dberror ("%s", "gdbm_convert");
      return GDBMSHELL_GDBM_ERR;
    }
  return GDBMSHELL_OK;
}

static int
downgrade_handler (struct command_param *param GDBM_ARG_UNUSED,
       struct command_environ *cenv GDBM_ARG_UNUSED)
{
  if (gdbm_convert (gdbm_file, 0))
    {
      dberror ("%s", "gdbm_convert");
      return GDBMSHELL_GDBM_ERR;
    }
  return GDBMSHELL_OK;
}

struct snapshot_status_info
{
  char const *code;
  char const *descr;
  void (*fn) (PAGERFILE *, char const *, char const *);
};

#define MODBUFSIZE 10

static char *
decode_mode (mode_t mode, char *buf)
{
  char *s = buf;
  *s++ = mode & S_IRUSR ? 'r' : '-';
  *s++ = mode & S_IWUSR ? 'w' : '-';
  *s++ = (mode & S_ISUID
         ? (mode & S_IXUSR ? 's' : 'S')
         : (mode & S_IXUSR ? 'x' : '-'));
  *s++ = mode & S_IRGRP ? 'r' : '-';
  *s++ = mode & S_IWGRP ? 'w' : '-';
  *s++ = (mode & S_ISGID
         ? (mode & S_IXGRP ? 's' : 'S')
         : (mode & S_IXGRP ? 'x' : '-'));
  *s++ = mode & S_IROTH ? 'r' : '-';
  *s++ = mode & S_IWOTH ? 'w' : '-';
  *s++ = (mode & S_ISVTX
         ? (mode & S_IXOTH ? 't' : 'T')
         : (mode & S_IXOTH ? 'x' : '-'));
  *s = '\0';
  return buf;
}

struct error_entry
{
  const char *msg;
  int gdbm_err;
  int sys_err;
};

static void
error_push (struct error_entry *stk, int *tos, int maxstk, char const *text,
      int gdbm_err, int sys_err)
{
  if (*tos == maxstk)
    abort ();
  stk += *tos;
  ++ *tos;
  stk->msg = text;
  stk->gdbm_err = gdbm_err;
  stk->sys_err = sys_err;
}

static void
print_snapshot (char const *snapname, PAGERFILE *fp)
{
  struct stat st;
  char buf[MODBUFSIZE];

  if (stat (snapname, &st) == 0)
    {
# define MAXERRS 4
      struct error_entry errs[MAXERRS];
      int errn = 0;
      int i;

      switch (st.st_mode & ~S_IFREG)
  {
  case S_IRUSR:
  case S_IWUSR:
    break;

  default:
    error_push (errs, &errn, ARRAY_SIZE (errs), N_("bad file mode"),
          0, 0);
  }

      pager_printf (fp, "%s: ", snapname);
      pager_printf (fp, "%03o %s ", st.st_mode & 0777,
        decode_mode (st.st_mode, buf));
#if HAVE_STRUCT_STAT_ST_MTIM
      pager_printf (fp, "%ld.%09ld", st.st_mtim.tv_sec, st.st_mtim.tv_nsec);
#else
      pager_printf (fp, "%ld [%s]", st.st_mtime, _("insufficient precision"));
#endif
      if (S_ISREG (st.st_mode))
  {
    GDBM_FILE dbf;

    dbf = gdbm_open (snapname, 0, GDBM_READER, 0, NULL);
    if (dbf)
      {
        if (dbf->xheader)
    pager_printf (fp, " %u", dbf->xheader->numsync);
        else
    /* TRANSLATORS: Stands for "Not Available". */
    pager_printf (fp, " %s", _("N/A"));
        gdbm_close (dbf);
      }
    else if (gdbm_check_syserr (gdbm_errno))
      {
        if (errno == EACCES)
    pager_printf (fp, " ?");
        else
    error_push (errs, &errn, ARRAY_SIZE (errs),
          N_("can't open database"),
          gdbm_errno, errno);
      }
    else
      error_push (errs, &errn, ARRAY_SIZE (errs),
      N_("can't open database"),
      gdbm_errno, 0);
  }
      else
  error_push (errs, &errn, ARRAY_SIZE (errs),
        N_("not a regular file"),
        0, 0);
      pager_putc (fp, '\n');
      for (i = 0; i < errn; i++)
  {
    pager_printf (fp, "%s: %s: %s", snapname, _("ERROR"), gettext (errs[i].msg));
    if (errs[i].gdbm_err)
      pager_printf (fp, ": %s", gdbm_strerror (errs[i].gdbm_err));
    if (errs[i].sys_err)
      pager_printf (fp, ": %s", strerror (errs[i].sys_err));
    pager_putc (fp, '\n');
  }
    }
  else
    {
      pager_printf (fp, _("%s: ERROR: can't stat: %s"),
        snapname, strerror (errno));
      return;
    }
}

static void
snapshot_print_fn (PAGERFILE *fp, char const *sa, char const *sb)
{
  print_snapshot (sa, fp);
  print_snapshot (sb, fp);
}

static void
snapshot_err_fn (PAGERFILE *fp, char const *sa, char const *sb)
{
  switch (errno)
    {
    default:
      print_snapshot (sa, fp);
      print_snapshot (sb, fp);
      break;

    case EINVAL:
      pager_printf (fp, "%s.\n",
        _("Invalid arguments in call to gdbm_latest_snapshot"));
      break;

    case ENOSYS:
      pager_printf (fp, "%s.\n",
        _("Function is not implemented: GDBM is built without crash-tolerance support"));
      break;
    }
}

static struct snapshot_status_info snapshot_status_info[] = {
  [GDBM_SNAPSHOT_OK] = {
    "GDBM_SNAPSHOT_OK",
    N_("Selected the most recent snapshot")
  },
  [GDBM_SNAPSHOT_BAD] = {
    "GDBM_SNAPSHOT_BAD",
    N_("Neither snapshot is readable"),
    snapshot_print_fn
  },
  [GDBM_SNAPSHOT_ERR] = {
    "GDBM_SNAPSHOT_ERR",
    N_("Error selecting snapshot"),
    snapshot_err_fn
  },
  [GDBM_SNAPSHOT_SAME] = {
    "GDBM_SNAPSHOT_SAME",
    N_("Snapshot modes and dates are the same"),
    snapshot_print_fn
  },
  [GDBM_SNAPSHOT_SUSPICIOUS] = {
    "GDBM_SNAPSHOT_SUSPICIOUS",
    N_("Snapshot sync counters differ by more than 1"),
    snapshot_print_fn
  }
};

static int
snapshot_handler (struct command_param *param, struct command_environ *cenv)
{
  char *sa = tildexpand (PARAM_STRING (param, 0));
  char *sb = tildexpand (PARAM_STRING (param, 1));
  char const *sel;
  int rc = gdbm_latest_snapshot (sa, sb, &sel);
  int res;

  if (rc >= 0 && rc < ARRAY_SIZE (snapshot_status_info))
    {
      pager_printf (cenv->pager,
        "%s: %s.\n",
        snapshot_status_info[rc].code,
        gettext (snapshot_status_info[rc].descr));
      if (snapshot_status_info[rc].fn)
  snapshot_status_info[rc].fn (cenv->pager, sa, sb);
      if (rc == GDBM_SNAPSHOT_OK)
  print_snapshot (sel, cenv->pager);
      res = GDBMSHELL_OK;
    }
  else
    {
      terror (_("unexpected error code: %d"), rc);
      res = GDBMSHELL_ERR;
    }

  free (sa);
  free (sb);
  return res;
}


/* hash KEY - hash the key */
static int
hash_handler (struct command_param *param GDBM_ARG_UNUSED,
        struct command_environ *cenv)
{
  if (gdbm_file)
    {
      int hashval, bucket, off;
      _gdbm_hash_key (gdbm_file, PARAM_DATUM (param, 0),
           &hashval, &bucket, &off);
      pager_printf (cenv->pager, _("hash value = %x, bucket #%u, slot %u"),
        hashval,
        hashval >> (GDBM_HASH_BITS - gdbm_file->header->dir_bits),
        hashval % gdbm_file->header->bucket_elems);
    }
  else
    pager_printf (cenv->pager, _("hash value = %x"),
      _gdbm_hash (PARAM_DATUM (param, 0)));
  pager_writez (cenv->pager, ".\n");
  return GDBMSHELL_OK;
}

/* cache - print the bucket cache */
static int
print_cache_handler (struct command_param *param GDBM_ARG_UNUSED,
         struct command_environ *cenv)
{
  _gdbm_print_bucket_cache (cenv->pager, gdbm_file);
  return GDBMSHELL_OK;
}

/* version - print GDBM version */
static int
print_version_handler (struct command_param *param GDBM_ARG_UNUSED,
           struct command_environ *cenv)
{
  pager_printf (cenv->pager, "%s\n", gdbm_version);
  return GDBMSHELL_OK;
}

/* list - List all entries */
static int
list_begin (struct command_param *param GDBM_ARG_UNUSED,
      struct command_environ *cenv GDBM_ARG_UNUSED)
{
  int rc;

  if ((rc = checkdb ()) == GDBMSHELL_OK)
    {
      if (param->argc)
  {
    if (strcmp (PARAM_STRING (param, 0), "bucket"))
      {
        fprintf (stderr, _("unrecognized parameter: %s\n"),
           PARAM_STRING (param, 0));
        return GDBMSHELL_ERR;
      }

    if (!gdbm_file->bucket)
      {
        fprintf (stderr, "%s", _("select bucket first\n"));
        return GDBMSHELL_ERR;
      }
  }
    }

  return rc;
}

static int
list_bucket_keys (struct command_environ *cenv)
{
  int rc = GDBMSHELL_OK;
  int i;
  hash_bucket *bucket = gdbm_file->bucket;

  for (i = 0; i < bucket->count; i++)
    {
      if (bucket->h_table[i].hash_value != -1)
  {
    datum key, content;

    key.dptr = _gdbm_read_entry (gdbm_file, i);
    if (!key.dptr)
      {
        dberror (_("error reading entry %d"),i);
        rc = GDBMSHELL_GDBM_ERR;
      }
    key.dsize = bucket->h_table[i].key_size;

    content = gdbm_fetch (gdbm_file, key);
    if (!content.dptr)
      {
        dberror ("%s", "gdbm_fetch");
        terror ("%s", _("the key was:"));
        datum_format_file (stderr, &key, dsdef[DS_KEY]);
        rc = GDBMSHELL_GDBM_ERR;
      }
    else
      {
        datum_format (cenv->pager, &key, dsdef[DS_KEY]);
        pager_putc (cenv->pager, ' ');
        datum_format (cenv->pager, &content, dsdef[DS_CONTENT]);
        pager_putc (cenv->pager, '\n');
      }
    free (content.dptr);
  }
    }
  return rc;
}

static int
list_all_keys (struct command_environ *cenv)
{
  datum key;
  datum data;
  int rc = GDBMSHELL_OK;

  key = gdbm_firstkey (gdbm_file);
  if (!key.dptr && gdbm_errno != GDBM_ITEM_NOT_FOUND)
    {
      dberror ("%s", "gdbm_firstkey");
      return GDBMSHELL_GDBM_ERR;
    }
  while (key.dptr)
    {
      datum nextkey;

      data = gdbm_fetch (gdbm_file, key);
      if (!data.dptr)
   {
     dberror ("%s", "gdbm_fetch");
     terror ("%s", _("the key was:"));
     datum_format_file (stderr, &key, dsdef[DS_KEY]);
     rc = GDBMSHELL_GDBM_ERR;
   }
      else
   {
     datum_format (cenv->pager, &key, dsdef[DS_KEY]);
     pager_putc (cenv->pager, ' ');
     datum_format (cenv->pager, &data, dsdef[DS_CONTENT]);
     pager_putc (cenv->pager, '\n');
     free (data.dptr);
   }
      nextkey = gdbm_nextkey (gdbm_file, key);
      free (key.dptr);
      key = nextkey;
    }
  if (gdbm_errno != GDBM_ITEM_NOT_FOUND)
    {
      dberror ("%s", "gdbm_nextkey");
      rc = GDBMSHELL_GDBM_ERR;
    }
  return rc;
}

static int
list_handler (struct command_param *param GDBM_ARG_UNUSED,
        struct command_environ *cenv)
{
  if (param->argc)
    return list_bucket_keys (cenv);
  else
    return list_all_keys (cenv);
}

/* An entry describing colliding elements in a bucket. */
struct collision_entry
{
  int hash_value;         /* Hash value. */
  int nindex;             /* Number of element indices in index[] array.
           When gathering collision statistics, this
           field keeps index of the bucket element with
           that hash value.  In this case, index is
           NULL. */
  int *index;             /* Indices of colliding elements.  It points to
           the index array of the collision structure that
           holds this entry. */
};

/* The collision structure describes collisions in a bucket. */
struct collision
{
  struct collision_entry *entries; /* Actual collision statistics. */
  int nentries;                    /* Number of elements in entries[] */
  int maxentries;                  /* Capacity of the entries array. */
  int total;                       /* Total number of colliding elements. */
  int index[1];                    /* Storage for element indices in
              entries. */
};

/* Allocate a new collision structure. */
static struct collision *
collision_alloc (int maxentries)
{
  struct collision *ret;

  ret = calloc (1, sizeof (ret[0]) + (maxentries - 1) * sizeof (ret->index[0]));
  ret->entries = calloc (maxentries, sizeof (ret->entries[0]));
  ret->maxentries = maxentries;
  ret->nentries = 0;
  return ret;
}

/* Free a collision object. */
static void
collision_free (struct collision *col)
{
  free (col->entries);
  free (col);
}

/* Add a new entry to the collision object being built. */
static void
collision_add (struct collision *col, int i, int hash_value)
{
  struct collision_entry *ent;

  assert (col->nentries < col->maxentries);
  ent = &col->entries[col->nentries];
  ent->index = NULL;
  ent->nindex = i;
  ent->hash_value = hash_value;
  col->nentries++;
}

/* Compare two collision entries. */
static int
colcmp (const void *a, const void *b)
{
  struct collision_entry const *ac = a;
  struct collision_entry const *bc = b;
  int d = ac->hash_value - bc->hash_value;
  if (d == 0)
    d = ac->nindex - bc->nindex;
  return d;
}

/* Return collision statistics for the given bucket. */
static struct collision *
get_bucket_collisions (hash_bucket *bucket)
{
  int i, n;
  struct collision *c;

  /*
   * Create a collision object and gather information about used bucket
   * elements.
   */
  c = collision_alloc (gdbm_file->header->bucket_elems);
  for (i = 0; i < gdbm_file->header->bucket_elems; i++)
    {
      if (bucket->h_table[i].hash_value != -1)
  {
    collision_add (c, i, bucket->h_table[i].hash_value);
  }
    }
  if (c->nentries == 0)
    {
      /* No elements used: return NULL. */
      collision_free (c);
      return NULL;
    }

  /* Sort entries by their hash value. */
  qsort (c->entries, c->nentries, sizeof (c->entries[0]), colcmp);

  /*
   * Coalesce entries having same hash_value and remove those with
   * unique hash_value.
   */
  for (i = n = 0; i < c->nentries; )
    {
      int j;
      int hash_value = c->entries[i].hash_value;
      for (j = 1; i+j < c->nentries; j++)
  if (c->entries[i+j].hash_value != hash_value)
    break;
      if (j == 1)
  {
    /* Skip entries with unique hash values. */
    for (j = i+1; j < c->nentries; j++)
      if (c->entries[j].hash_value == c->entries[j+1].hash_value)
        break;
    if (j < c->nentries)
      {
        /* Remove entries */
        memmove (&c->entries[i], &c->entries[j],
           (c->nentries - j) * sizeof (c->entries[0]));
      }
    c->nentries -= j - i;
  }
      else
  {
    int k;

    /* Gather colliding indices. */
    c->entries[i].index = &c->index[n];
    c->entries[i].index[0] = c->entries[i].nindex;
    for (k = 1; k < j; k++)
      c->entries[i].index[k] = c->entries[i+k].nindex;
    c->entries[i].nindex = j;
    n += j;

    /* Remove unneeded entries. */
    if (i + j < c->nentries)
      memmove (&c->entries[i+1], &c->entries[i+j],
         (c->nentries - (i + j)) * sizeof (c->entries[0]));
    c->nentries -= j - 1;
    c->total += j;

    /* Increase collision index. */
    i++;
  }
    }

  return c;
}

static int
print_current_bucket_collisions_internal (struct command_environ *cenv)
{
  int rc = 0;
  struct collision *c = get_bucket_collisions (gdbm_file->bucket);
  if (c)
    {
      PAGERFILE *pager = cenv->pager;
      int i, j;

      pager_printf (pager, "******* ");
      pager_printf (pager, _("Bucket #%d, collisions: %d"),
        gdbm_file->bucket_dir,
        c->nentries);
      pager_printf (pager, " **********\n\n");

      for (i = 0; i < c->nentries; i++)
  {
    pager_printf (pager, "* Hash %8x, %d:\n\n",
      c->entries[i].hash_value,
      c->entries[i].nindex);
    for (j = 0; j < c->entries[i].nindex; j++)
      {
        datum key;
        int elem_loc = c->entries[i].index[j];

        key.dsize = gdbm_file->bucket->h_table[elem_loc].key_size;
        key.dptr = _gdbm_read_entry (gdbm_file, elem_loc);
        if (!key.dptr)
    {
      dberror ("%s", _("error reading entry"));
      collision_free (c);
      return -1;
    }
        pager_printf (pager, "Location: %d\n", elem_loc);
        datum_format (pager, &key, dsdef[DS_KEY]);
        pager_putc (pager, '\n');
        pager_putc (pager, '\n');
        if (pager_error (pager))
    {
      if (errno != EPIPE)
        dberror ("output error: %s", strerror (errno));
      rc = -1;
      break;
    }
      }
  }
      collision_free (c);
    }
  return rc;
}

static void
print_current_bucket_collisions (struct command_environ *cenv)
{
  print_current_bucket_collisions_internal (cenv);
}

static int
get_bucket_numbers (struct command_param *param, int *ret_from, int *ret_to)
{
  int n_from = -1, n_to = -1;
  int rc;

  switch (param->argc)
    {
    case 2:
      if ((rc = get_bucket_num (&n_to, PARAM_STRING (param, 1),
        PARAM_LOCPTR (param, 1))) != GDBMSHELL_OK)
  return rc;
    case 1:
      if ((rc = get_bucket_num (&n_from, PARAM_STRING (param, 0),
        PARAM_LOCPTR (param, 0))) != GDBMSHELL_OK)
  return rc;
      break;
    case 0:
      break;
    }

  if (n_from != -1)
    {
      if (n_to == -1)
  n_to = n_from;
    }

  *ret_from = n_from;
  *ret_to = n_to;

  return GDBMSHELL_OK;
}

static int
collisions_handler (struct command_param *param,
        struct command_environ *cenv)
{
  int n_from = -1, n_to = -1;
  int rc;

  if ((rc = get_bucket_numbers (param, &n_from, &n_to)) != GDBMSHELL_OK)
    return rc;

  if (n_from != -1)
    {
      int i;

      for (i = n_from; i <= n_to; i++)
  {
    if (_gdbm_get_bucket (gdbm_file, i))
      {
        dberror (_("%s(%d) failed"), "_gdbm_get_bucket", i);
        return GDBMSHELL_GDBM_ERR;
      }
    if (print_current_bucket_collisions_internal (cenv))
      break;
  }
    }
  else if (!gdbm_file->bucket)
    pager_writeln (cenv->pager, _("no current bucket"));
  else
    print_current_bucket_collisions (cenv);
  return GDBMSHELL_OK;
}

/* quit - quit the program */
static int
quit_handler (struct command_param *param GDBM_ARG_UNUSED,
        struct command_environ *cenv GDBM_ARG_UNUSED)
{
  input_context_drain ();
  if (input_context_push (instream_null_create ()))
    exit (EXIT_FATAL);
  return GDBMSHELL_OK;
}

/* export FILE [truncate] - export to a flat file format */
static int
export_handler (struct command_param *param,
    struct command_environ *cenv GDBM_ARG_UNUSED)
{
  int format = GDBM_DUMP_FMT_ASCII;
  int flags = GDBM_WRCREAT;
  int i;
  int filemode;
  int rc = GDBMSHELL_OK;

  for (i = 1; i < param->argc; i++)
    {
      if (strcmp (PARAM_STRING (param, i), "truncate") == 0)
   flags = GDBM_NEWDB;
      else if (strcmp (PARAM_STRING (param, i), "binary") == 0)
   format = GDBM_DUMP_FMT_BINARY;
      else if (strcmp (PARAM_STRING (param, i), "ascii") == 0)
   format = GDBM_DUMP_FMT_ASCII;
      else
   {
     lerror (PARAM_LOCPTR (param, i),
       _("unrecognized argument: %s"), PARAM_STRING (param, i));
     return GDBMSHELL_SYNTAX;
   }
    }

  if (variable_get ("filemode", VART_INT, (void**) &filemode))
    abort ();
  if (gdbm_dump (gdbm_file, PARAM_STRING (param, 0), format, flags, filemode))
    {
      dberror ("%s", _("error dumping database"));
      rc = GDBMSHELL_GDBM_ERR;
    }
  return rc;
}

/* import FILE [replace] [nometa] - import from a flat file */
static int
import_handler (struct command_param *param,
    struct command_environ *cenv GDBM_ARG_UNUSED)
{
  int flag = GDBM_INSERT;
  unsigned long err_line;
  int meta_mask = 0;
  int i;
  int rc = GDBMSHELL_OK;
  char *file_name;

  for (i = 1; i < param->argc; i++)
    {
      if (strcmp (PARAM_STRING (param, i), "replace") == 0)
   flag = GDBM_REPLACE;
      else if (strcmp (PARAM_STRING (param, i), "nometa") == 0)
   meta_mask = GDBM_META_MASK_MODE | GDBM_META_MASK_OWNER;
      else
   {
     lerror (PARAM_LOCPTR (param, i),
       _("unrecognized argument: %s"),
       PARAM_STRING (param, i));
     return GDBMSHELL_SYNTAX;
   }
    }

  rc = gdbm_load (&gdbm_file, PARAM_STRING (param, 0), flag,
       meta_mask, &err_line);
  if (rc && gdbm_errno == GDBM_NO_DBNAME)
    {
      char *save_mode;

      variable_get ("open", VART_STRING, (void**) &save_mode);
      save_mode = estrdup (save_mode);
      variable_set ("open", VART_STRING, "newdb");

      rc = checkdb ();
      variable_set ("open", VART_STRING, save_mode);
      free (save_mode);

      if (rc)
   return rc;

      rc = gdbm_load (&gdbm_file, PARAM_STRING (param, 0), flag,
           meta_mask, &err_line);
    }
  if (rc)
    {
      switch (gdbm_errno)
   {
   case GDBM_ERR_FILE_OWNER:
   case GDBM_ERR_FILE_MODE:
     dberror ("%s", _("error restoring metadata"));
     break;

   default:
     if (err_line)
       dberror ("%s:%lu", PARAM_STRING (param, 0), err_line);
     else
       dberror (_("cannot load from %s"), PARAM_STRING (param, 0));
   }
      return GDBMSHELL_GDBM_ERR;
    }

  if (gdbm_setopt (gdbm_file, GDBM_GETDBNAME, &file_name, sizeof (file_name)))
    {
      dberror ("%s", "GDBM_GETDBNAME");
      rc = GDBMSHELL_GDBM_ERR;
    }
  else
    {
      variable_set ("filename", VART_STRING, file_name);
      variable_unset ("fd");
    }
  return rc;
}

/* status - print current program status */
static int
status_handler (struct command_param *param GDBM_ARG_UNUSED,
    struct command_environ *cenv)
{
  char *file_name;

  variable_get ("filename", VART_STRING, (void**) &file_name);
  pager_printf (cenv->pager, _("Database file: %s\n"), file_name);
  if (gdbm_file)
    pager_writeln (cenv->pager, _("Database is open"));
  else
    pager_writeln (cenv->pager, _("Database is not open"));
  dsprint (cenv->pager, DS_KEY, dsdef[DS_KEY]);
  dsprint (cenv->pager, DS_CONTENT, dsdef[DS_CONTENT]);
  return GDBMSHELL_OK;
}

#if GDBM_DEBUG_ENABLE
static int
debug_flag_printer (void *data, int flag, char const *tok)
{
  FILE *fp = data;
  fprintf (fp, " %s", tok);
  return 0;
}
#endif

static int
debug_handler (struct command_param *param, struct command_environ *cenv)
{
#if GDBM_DEBUG_ENABLE
  if (param->vararg)
    {
      struct gdbmarg *arg;
      int i;

      for (arg = param->vararg, i = 0; arg; arg = arg->next, i++)
  {
    if (arg->type == GDBM_ARG_STRING)
      {
        int flag;
        int negate;
        char const *tok = arg->v.string;

        if (tok[0] == '-')
    {
      ++tok;
      negate = 1;
    }
        else if (tok[0] == '+')
    {
      ++tok;
      negate = 0;
    }
        else
    negate = 0;

        flag = gdbm_debug_token (tok);
        if (flag)
    {
      if (negate)
        gdbm_debug_flags &= ~flag;
      else
        gdbm_debug_flags |= flag;
    }
        else
    lerror (&arg->loc, _("unknown debug flag: %s"), tok);
      }
    else
      lerror (&arg->loc, _("invalid type of argument %d"), i);
  }
    }
  else
    {
      pager_writez (cenv->pager, _("Debug flags:"));
      if (gdbm_debug_flags)
  {
    gdbm_debug_parse_state (debug_flag_printer, cenv->pager);
  }
      else
  pager_printf (cenv->pager, " %s", _("none"));
      pager_putc (cenv->pager, '\n');
    }
#else
  terror ("%s", _("compiled without debug support"));
#endif
  return GDBMSHELL_OK;
}

static int
shell_handler (struct command_param *param,
         struct command_environ *cenv GDBM_ARG_UNUSED)
{
  char *argv[4];
  pid_t pid, rc;
  int status;

  argv[0] = getenv ("$SHELL");
  if (!argv[0])
    argv[0] = "/bin/sh";
  if (param->vararg)
    {
      argv[1] = "-c";
      argv[2] = param->vararg->v.string;
      argv[3] = NULL;
    }
  else
    {
      argv[1] = NULL;
    }

  pid = fork ();
  if (pid == -1)
    {
      terror ("fork: %s", strerror (errno));
      return GDBMSHELL_ERR;
    }
  if (pid == 0)
    {
      execv (argv[0], argv);
      perror (argv[0]);
      _exit (127);
    }

  rc = waitpid (pid, &status, 0);
  if (rc == -1)
    {
      terror ("waitpid: %s", strerror (errno));
      rc = GDBMSHELL_ERR;
    }
  else if (!interactive ())
    {
      if (WIFEXITED (status))
  {
    if (WEXITSTATUS (status) != 0)
      terror (_("command failed with status %d"), WEXITSTATUS (status));
  }
      else if (WIFSIGNALED (status))
  terror (_("command terminated on signal %d"), WTERMSIG (status));
    }
  return rc;
}

static int
source_handler (struct command_param *param,
    struct command_environ *cenv GDBM_ARG_UNUSED)
{
  char *fname = tildexpand (PARAM_STRING (param, 0));
  instream_t istr = instream_file_create (fname);
  free (fname);
  if (istr && input_context_push (istr) == 0)
    {
      yyparse ();
      input_context_drain ();
      yylex_destroy ();
    }
  return GDBMSHELL_OK;
}

static int
perror_handler (struct command_param *param, struct command_environ *cenv)
{
  int n;

  if (param->argc)
    {
      if (getnum (&n, PARAM_STRING (param, 0), NULL))
  return GDBMSHELL_SYNTAX;
    }
  else if ((n = checkdb ()) != GDBMSHELL_OK)
    {
      return n;
    }
  else
    {
      n = gdbm_last_errno (gdbm_file);
    }
  pager_printf (cenv->pager,
    "GDBM error code %d: \"%s\"\n", n, gdbm_strerror (n));
  if (gdbm_check_syserr (n))
    {
      if (param->argc)
  pager_printf (cenv->pager, "Examine errno.\n");
      else
  pager_printf (cenv->pager, "System error code %d: \"%s\"\n",
          gdbm_last_syserr (gdbm_file),
          strerror (gdbm_last_syserr (gdbm_file)));
    }
  return GDBMSHELL_OK;
}

struct history_param
{
  int from;
  int count;
};

static int
input_history_begin (struct command_param *param,
         struct command_environ *cenv GDBM_ARG_UNUSED)
{
  struct history_param *p;
  int hlen = input_history_size ();
  int from = 0, count = hlen;

  if (hlen == -1)
    {
      /* TRANSLATORS: %s is the stream name */
      terror (_("input history is not available for %s input stream"),
        input_stream_name ());
      return GDBMSHELL_ERR;
    }

  switch (param->argc)
    {
    case 1:
      if (getnum (&count, param->argv[0]->v.string, NULL))
  return 1;
      if (count > hlen)
  count = hlen;
      else
  from = hlen - count;
      break;

    case 2:
      if (getnum (&from, param->argv[0]->v.string, NULL))
  return 1;
      if (from)
  --from;
      if (getnum (&count, param->argv[1]->v.string, NULL))
  return GDBMSHELL_OK;

      if (count > hlen)
  count = hlen;
    }
  p = emalloc (sizeof *p);
  p->from = from;
  p->count = count;
  cenv->data = p;
  return GDBMSHELL_OK;
}

static int
input_history_handler (struct command_param *param GDBM_ARG_UNUSED,
           struct command_environ *cenv)
{
  struct history_param *p = cenv->data;
  int i;

  for (i = 0; i < p->count; i++)
    {
      const char *s = input_history_get (p->from + i);
      if (!s)
  break;
      pager_printf (cenv->pager, "%4d) %s\n", p->from + i + 1, s);
    }
  return GDBMSHELL_OK;
}


static int help_handler (struct command_param *, struct command_environ *);

struct argdef
{
  char *name;
  int type;
  int ds;
};

#define NARGS 10

enum command_repeat_type
  {
    REPEAT_NEVER,
    REPEAT_ALWAYS,
    REPEAT_NOARG
  };

struct command
{
  char *name;           /* Command name */
  size_t len;           /* Name length */
  int tok;
  int (*begin) (struct command_param *param, struct command_environ *cenv);
  int (*handler) (struct command_param *param, struct command_environ *cenv);
  void (*end) (void *data);
  struct argdef args[NARGS];
  char *argdoc[NARGS];
  int variadic;
  enum command_repeat_type repeat;
  char *doc;
};

static struct command command_tab[] = {
  {
    .name = "count",
    .doc = N_("count (number of entries)"),
    .tok = T_CMD,
    .begin = checkdb_begin,
    .handler = count_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "delete",
    .args = {
      { N_("KEY"), GDBM_ARG_DATUM, DS_KEY },
      { NULL }
    },
    .doc = N_("delete a record"),
    .tok = T_CMD,
    .begin = checkdb_begin,
    .handler = delete_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "export",
    .args = {
      { N_("FILE"), GDBM_ARG_STRING },
      { "[truncate]", GDBM_ARG_STRING },
      { "[binary|ascii]", GDBM_ARG_STRING },
      { NULL }
    },
    .doc = N_("export"),
    .tok = T_CMD,
    .begin = checkdb_begin,
    .handler = export_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "fetch",
    .args = {
      { N_("KEY"), GDBM_ARG_DATUM, DS_KEY },
      { NULL }
    },
    .doc = N_("fetch record"),
    .tok = T_CMD,
    .begin = checkdb_begin,
    .handler = fetch_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "import",
    .args = {
      { N_("FILE"), GDBM_ARG_STRING },
      { "[replace]", GDBM_ARG_STRING },
      { "[nometa]" , GDBM_ARG_STRING },
      { NULL }
    },
    .doc = N_("import"),
    .tok = T_CMD,
    .handler = import_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "list",
    .args = {
      { "[bucket]", GDBM_ARG_STRING },
      { NULL },
    },
    .doc = N_("list"),
    .tok = T_CMD,
    .begin = list_begin,
    .handler = list_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "next",
    .args = {
      { N_("[KEY]"), GDBM_ARG_DATUM, DS_KEY },
      { NULL }
    },
    .doc = N_("continue iteration: get next key and datum"),
    .tok = T_CMD,
    .begin = checkdb_begin,
    .handler = nextkey_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NOARG,
  },
  {
    .name = "store",
    .args = {
      { N_("KEY"), GDBM_ARG_DATUM, DS_KEY },
      { N_("DATA"), GDBM_ARG_DATUM, DS_CONTENT },
      { NULL }
    },
    .doc = N_("store"),
    .tok = T_CMD,
    .begin = checkdb_begin,
    .handler = store_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "first",
    .doc = N_("begin iteration: get first key and datum"),
    .tok = T_CMD,
    .begin = checkdb_begin,
    .handler = firstkey_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "reorganize",
    .doc = N_("reorganize"),
    .tok = T_CMD,
    .begin = checkdb_begin,
    .handler = reorganize_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "recover",
    .argdoc = {
      "[verbose]",
      "[summary]",
      "[backup]",
      "[force]",
      "[max-failed-keys=N]",
      "[max-failed-buckets=N]",
      "[max-failures=N]",
      NULL
    },
    .doc = N_("recover the database"),
    .tok = T_CMD,
    .begin = checkdb_begin,
    .handler = recover_handler,
    .variadic = TRUE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "avail",
    .doc = N_("print avail list"),
    .tok = T_CMD,
    .begin = checkdb_begin,
    .handler = avail_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "bucket",
    .args = {
      { N_("[NUMBER]"), GDBM_ARG_STRING },
      { NULL }
    },
    .doc = N_("print a bucket"),
    .tok = T_CMD,
    .begin = print_bucket_begin,
    .handler = print_current_bucket_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "current",
    .doc = N_("print current bucket"),
    .tok = T_CMD,
    .begin = checkdb_begin,
    .handler = print_current_bucket_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "sibling",
    .doc = N_("print sibling bucket"),
    .tok = T_CMD,
    .begin = print_sibling_bucket_begin,
    .handler = print_current_bucket_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "dir",
    .doc = N_("print hash directory"),
    .tok = T_CMD,
    .begin = checkdb_begin,
    .handler = print_dir_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "header",
    .doc = N_("print database file header"),
    .tok = T_CMD,
    .begin = checkdb_begin,
    .handler = print_header_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "hash",
    .args = {
      { N_("KEY"), GDBM_ARG_DATUM, DS_KEY },
      { NULL }
    },
    .doc = N_("hash value of key"),
    .tok = T_CMD,
    .handler = hash_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "cache",
    .doc = N_("print the bucket cache"),
    .tok = T_CMD,
    .begin = checkdb_begin,
    .handler = print_cache_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "status",
    .doc = N_("print current program status"),
    .tok = T_CMD,
    .handler = status_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "sync",
    .doc = N_("Synchronize the database with disk copy"),
    .tok = T_CMD,
    .begin = checkdb_begin,
    .handler = sync_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "upgrade",
    .doc = N_("Upgrade the database to extended format"),
    .tok = T_CMD,
    .begin = checkdb_begin,
    .handler = upgrade_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "downgrade",
    .doc = N_("Downgrade the database to standard format"),
    .tok = T_CMD,
    .begin = checkdb_begin,
    .handler = downgrade_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "snapshot",
    .args = {
      { "FILE", GDBM_ARG_STRING },
      { "FILE", GDBM_ARG_STRING },
      { NULL }
    },
    .doc = N_("analyze two database snapshots"),
    .tok = T_CMD,
    .handler = snapshot_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "version",
    .doc = N_("print version of gdbm"),
    .tok = T_CMD,
    .handler = print_version_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "help",
    .doc = N_("print this help list"),
    .tok = T_CMD,
    .handler = help_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "quit",
    .doc = N_("quit the program"),
    .tok = T_CMD,
    .handler = quit_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "set",
    .argdoc = {
      "[VAR=VALUE...]",
      NULL
    },
    .doc = N_("set or list variables"),
    .tok = T_SET,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "unset",
    .argdoc = {
      "VAR...",
      NULL
    },
    .doc = N_("unset variables"),
    .tok = T_UNSET,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "define",
    .argdoc = {
      "key|content",
      "{ FIELD-LIST }",
      NULL
    },
    .doc = N_("define datum structure"),
    .tok = T_DEF,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "source",
    .args = {
      { "FILE", GDBM_ARG_STRING },
      { NULL }
    },
    .doc = N_("source command script"),
    .tok = T_CMD,
    .handler = source_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "close",
    .doc = N_("close the database"),
    .tok = T_CMD,
    .handler = close_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "open",
    .args = {
      { "[FILE]", GDBM_ARG_STRING },
      { NULL }
    },
    .doc = N_("open new database"),
    .tok = T_CMD,
    .handler = open_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "history",
    .args = {
      { N_("[FROM]"), GDBM_ARG_STRING },
      { N_("[COUNT]"), GDBM_ARG_STRING },
      { NULL }
    },
    .doc = N_("show input history"),
    .tok = T_CMD,
    .begin = input_history_begin,
    .handler = input_history_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "debug",
    .doc = N_("query/set debug level"),
    .argdoc = {
#if GDBM_DEBUG_ENABLE
      "[[+-]err]",
      "[[+-]open]",
      "[[+-]store]",
      "[[+-]read]",
      "[[+-]lookup]",
      "[[+-]all]",
#endif
      NULL
    },
    .tok = T_CMD,
    .handler = debug_handler,
    .variadic = TRUE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "shell",
    .doc = N_("invoke the shell"),
    .tok = T_SHELL,
    .handler = shell_handler,
    .variadic = TRUE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "perror",
    .args = {
      { "[CODE]", GDBM_ARG_STRING },
      { NULL }
    },
    .doc = N_("describe GDBM error code"),
    .tok = T_CMD,
    .handler = perror_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  {
    .name = "collisions",
    .args = {
      { N_("[BUCKET]"), GDBM_ARG_STRING },
      { N_("[BUCKET]"), GDBM_ARG_STRING },
      { NULL }
    },
    .doc = N_("find colliding entries in buckets"),
    .tok = T_CMD,
    .begin = checkdb_begin,
    .handler = collisions_handler,
    .variadic = FALSE,
    .repeat = REPEAT_NEVER,
  },
  { NULL }
};

static int commands_sorted;

static int
cmdcmp (const void *a, const void *b)
{
  struct command const *ac = a;
  struct command const *bc = b;
  return strcmp (ac->name, bc->name);
}

/* Generator function for command completion.  STATE lets us know whether
   to start from scratch; without any state (i.e. STATE == 0), then we
   start at the top of the list. */
char *
command_generator (const char *text, int state)
{
  const char *name;
  static int len;
  static struct command *cmd;

  /* If this is a new word to complete, initialize now.  This includes
     saving the length of TEXT for efficiency, and initializing the index
     variable to 0. */
  if (!state)
    {
      cmd = command_tab;
      len = strlen (text);
    }

  if (!cmd || !cmd->name)
    return NULL;

  /* Return the next name which partially matches from the command list. */
  while ((name = cmd->name))
    {
      cmd++;
      if (strncmp (name, text, len) == 0)
  return strdup (name);
    }

  /* If no names matched, then return NULL. */
  return NULL;
}

/* ? - help handler */
static ssize_t
pwriter (void *data, char const *buf, size_t len)
{
  return pager_write ((PAGERFILE*)data, buf, len);
}

WORDWRAP_FILE
wordwrap_pager_open (PAGERFILE *pager)
{
  return wordwrap_open (pager_fileno (pager), pwriter, pager);
}

#define CMDCOLS 30

static int
help_handler (struct command_param *param GDBM_ARG_UNUSED,
        struct command_environ *cenv)
{
  struct command *cmd;
  WORDWRAP_FILE wf;

  pager_flush (cenv->pager);
  wf = wordwrap_pager_open (cenv->pager);

  for (cmd = command_tab; cmd->name; cmd++)
    {
      int i;
      int n;

      wordwrap_set_left_margin (wf, 1);
      wordwrap_set_right_margin (wf, 0);
      n = strlen (cmd->name);
      wordwrap_write (wf, cmd->name, n);

      wordwrap_set_left_margin (wf, n + 2);
      for (i = 0; i < NARGS && cmd->args[i].name; i++)
  {
    wordwrap_printf (wf, " %s", gettext (cmd->args[i].name));
  }
      for (i = 0; cmd->argdoc[i]; i++)
  {
    wordwrap_printf (wf, " %s", gettext (cmd->argdoc[i]));
  }

      wordwrap_set_right_margin (wf, 0);
      wordwrap_set_left_margin (wf, CMDCOLS);

      wordwrap_printf (wf, " %s", gettext (cmd->doc));
      wordwrap_flush (wf);
    }
  wordwrap_close (wf);
  return 0;
}

int
command_lookup (const char *str, struct locus *loc, struct command **pcmd)
{
  enum { fcom_init, fcom_found, fcom_ambig, fcom_abort } state = fcom_init;
  struct command *cmd, *found = NULL;
  size_t len = strlen (str);

  for (cmd = command_tab; state != fcom_abort && cmd->name; cmd++)
    {
      size_t n = len < cmd->len ? len : cmd->len;
      if (memcmp (cmd->name, str, n) == 0 && str[n] == 0)
  {
    switch (state)
      {
      case fcom_init:
        found = cmd;
        state = fcom_found;
        break;

      case fcom_found:
        if (!interactive ())
    {
      state = fcom_abort;
      found = NULL;
      continue;
    }
        fprintf (stderr, "ambiguous command: %s\n", str);
        fprintf (stderr, "    %s\n", found->name);
        found = NULL;
        state = fcom_ambig;
        /* fall through */
      case fcom_ambig:
        fprintf (stderr, "    %s\n", cmd->name);
        break;

      case fcom_abort:
        /* should not happen */
        abort ();
      }
  }
    }

  if (state == fcom_init)
    lerror (loc, interactive () ? _("Invalid command. Try ? for help.") :
          _("Unknown command"));
  if (!found)
    return T_BOGUS;

  *pcmd = found;
  return found->tok;
}

struct gdbmarg *
gdbmarg_string (char *string, struct locus *loc)
{
  struct gdbmarg *arg = ecalloc (1, sizeof (*arg));
  arg->next = NULL;
  arg->type = GDBM_ARG_STRING;
  arg->ref = 1;
  if (loc)
    arg->loc = *loc;
  arg->v.string = string;
  return arg;
}

struct gdbmarg *
gdbmarg_datum (datum *dat, struct locus *loc)
{
  struct gdbmarg *arg = ecalloc (1, sizeof (*arg));
  arg->next = NULL;
  arg->type = GDBM_ARG_DATUM;
  arg->ref = 1;
  if (loc)
    arg->loc = *loc;
  arg->v.dat = *dat;
  return arg;
}

struct gdbmarg *
gdbmarg_kvpair (struct kvpair *kvp, struct locus *loc)
{
  struct gdbmarg *arg = ecalloc (1, sizeof (*arg));
  arg->next = NULL;
  arg->type = GDBM_ARG_KVPAIR;
  arg->ref = 1;
  if (loc)
    arg->loc = *loc;
  arg->v.kvpair = kvp;
  return arg;
}

struct slist *
slist_new_s (char *s)
{
  struct slist *lp = emalloc (sizeof (*lp));
  lp->next = NULL;
  lp->str = s;
  return lp;
}

struct slist *
slist_new (char const *s)
{
  return slist_new_s (estrdup (s));
}

struct slist *
slist_new_l (char const *s, size_t l)
{
  char *copy = emalloc (l + 1);
  memcpy (copy, s, l);
  copy[l] = 0;
  return slist_new_s (copy);
}

void
slist_free (struct slist *lp)
{
  while (lp)
    {
      struct slist *next = lp->next;
      free (lp->str);
      free (lp);
      lp = next;
    }
}

void
slist_insert (struct slist **where, struct slist *what)
{
  if (*where)
    {
      while (what->next)
  what = what->next;
      what->next = (*where)->next;
      (*where)->next = what;
    }
  else
    what->next = NULL;
  *where = what;
}

struct kvpair *
kvpair_string (struct locus *loc, char *val)
{
  struct kvpair *p = ecalloc (1, sizeof (*p));
  p->type = KV_STRING;
  if (loc)
    p->loc = *loc;
  p->val.s = val;
  return p;
}

struct kvpair *
kvpair_list (struct locus *loc, struct slist *s)
{
  struct kvpair *p = ecalloc (1, sizeof (*p));
  p->type = KV_LIST;
  if (loc)
    p->loc = *loc;
  p->val.l = s;
  return p;
}

void
kvlist_free (struct kvpair *kvp)
{
  while (kvp)
    {
      struct kvpair *next = kvp->next;
      free (kvp->key);
      switch (kvp->type)
  {
  case KV_STRING:
    free (kvp->val.s);
    break;

  case KV_LIST:
    slist_free (kvp->val.l);
    break;
  }
      free (kvp);
      kvp = next;
    }
}

struct kvpair *
kvlist_find (struct kvpair *kv, char const *tag)
{
  for (; kv; kv = kv->next)
    if (kv->key && strcmp (kv->key, tag) == 0)
      break;
  return kv;
}

int
gdbmarg_free (struct gdbmarg *arg)
{
  if (arg && --arg->ref == 0)
    {
      switch (arg->type)
  {
  case GDBM_ARG_STRING:
    free (arg->v.string);
    break;

  case GDBM_ARG_KVPAIR:
    kvlist_free (arg->v.kvpair);
    break;

  case GDBM_ARG_DATUM:
    free (arg->v.dat.dptr);
    break;
  }
      free (arg);
      return 0;
    }
  return 1;
}

void
gdbmarg_destroy (struct gdbmarg **parg)
{
  if (parg && gdbmarg_free (*parg))
    *parg = NULL;
}

void
gdbmarglist_init (struct gdbmarglist *lst, struct gdbmarg *arg)
{
  if (arg)
    arg->next = NULL;
  lst->head = lst->tail = arg;
}

void
gdbmarglist_add (struct gdbmarglist *lst, struct gdbmarg *arg)
{
  arg->next = NULL;
  if (lst->tail)
    lst->tail->next = arg;
  else
    lst->head = arg;
  lst->tail = arg;
}

void
gdbmarglist_free (struct gdbmarglist *lst)
{
  struct gdbmarg *arg;

  for (arg = lst->head; arg; )
    {
      struct gdbmarg *next = arg->next;
      gdbmarg_free (arg);
      arg = next;
    }
  lst->head = lst->tail = NULL;
}

static void
param_expand (struct command_param *p)
{
  if (p->argc == p->argmax)
    p->argv = e2nrealloc (p->argv, &p->argmax, sizeof (p->argv[0]));
}

static void
param_free_argv (struct command_param *p)
{
  size_t i;

  for (i = 0; i < p->argc; i++)
    gdbmarg_destroy (&p->argv[i]);
  p->argc = 0;
}

static void
param_free (struct command_param *p)
{
  param_free_argv (p);
  free (p->argv);
  p->argv = NULL;
  p->argmax = 0;
}

static struct gdbmarg *coerce (struct gdbmarg *arg, struct argdef *def);

static int
param_push_arg (struct command_param *p, struct gdbmarg *arg,
    struct argdef *def)
{
  param_expand (p);
  if ((p->argv[p->argc] = coerce (arg, def)) == NULL)
    {
      return 1;
    }
  p->argc++;
  return 0;
}

static void
param_term (struct command_param *p)
{
  param_expand (p);
  p->argv[p->argc] = NULL;
}

typedef struct gdbmarg *(*coerce_type_t) (struct gdbmarg *arg,
            struct argdef *def);

struct gdbmarg *
coerce_ref (struct gdbmarg *arg, struct argdef *def)
{
  ++arg->ref;
  return arg;
}

struct gdbmarg *
coerce_k2d (struct gdbmarg *arg, struct argdef *def)
{
  datum d;

  if (datum_scan (&d, dsdef[def->ds], arg->v.kvpair))
    return NULL;
  return gdbmarg_datum (&d, &arg->loc);
}

struct gdbmarg *
coerce_s2d (struct gdbmarg *arg, struct argdef *def)
{
  datum d;
  struct kvpair kvp;

  memset (&kvp, 0, sizeof (kvp));
  kvp.type = KV_STRING;
  kvp.val.s = arg->v.string;

  if (datum_scan (&d, dsdef[def->ds], &kvp))
    return NULL;
  return gdbmarg_datum (&d, &arg->loc);
}

#define coerce_fail NULL

coerce_type_t coerce_tab[GDBM_ARG_MAX][GDBM_ARG_MAX] = {
  /*             s            d            k */
  /* s */  { coerce_ref,  coerce_fail, coerce_fail },
  /* d */  { coerce_s2d,  coerce_ref,  coerce_k2d },
  /* k */  { coerce_fail, coerce_fail, coerce_ref }
};

char *argtypestr[] = { "string", "datum", "k/v pair" };

static struct gdbmarg *
coerce (struct gdbmarg *arg, struct argdef *def)
{
  if (!coerce_tab[def->type][arg->type])
    {
      lerror (&arg->loc, _("cannot coerce %s to %s"),
        argtypestr[arg->type], argtypestr[def->type]);
      return NULL;
    }
  return coerce_tab[def->type][arg->type] (arg, def);
}

static struct command *last_cmd;
static struct gdbmarglist last_args;
static char *last_pipeline;

int
run_last_command (void)
{
  if (interactive ())
    {
      if (last_cmd)
  {
    switch (last_cmd->repeat)
      {
      case REPEAT_NEVER:
        break;
      case REPEAT_NOARG:
        gdbmarglist_free (&last_args);
        /* FALLTHROUGH */
      case REPEAT_ALWAYS:
        return run_command (last_cmd, &last_args, last_pipeline);

      default:
        abort ();
      }
  }
    }
  return 0;
}

static void
format_arg (struct gdbmarg *arg, struct argdef *def, FILE *fp)
{
  switch (arg->type)
    {
    case GDBM_ARG_STRING:
      fprintf (fp, " %s", arg->v.string);
      break;

    case GDBM_ARG_DATUM:
      if (def && def->type == GDBM_ARG_DATUM)
  {
    fputc (' ', fp);
    datum_format_file (fp, &arg->v.dat, dsdef[def->ds]);
  }
      else
  /* Shouldn't happen */
  terror ("%s:%d: INTERNAL ERROR: unexpected data type in arglist",
    __FILE__, __LINE__);
      break;

    case GDBM_ARG_KVPAIR:
      {
  struct kvpair *kvp = arg->v.kvpair;
  fprintf (fp, " %s ", kvp->key);
  switch (kvp->type)
    {
    case KV_STRING:
      fprintf (fp, "%s", kvp->val.s);
      break;

    case KV_LIST:
      {
        struct slist *p = kvp->val.l;
        fprintf (fp, "%s", p->str);
        while ((p = p->next) != NULL)
    fprintf (fp, ", %s", p->str);
      }
    }
      }
    }
}

struct timing
{
  struct timeval real;
  struct timeval user;
  struct timeval sys;
};

void
timing_start (struct timing *t)
{
  struct rusage r;
  gettimeofday (&t->real, NULL);
  getrusage (RUSAGE_SELF, &r);
  t->user  = r.ru_utime;
  t->sys = r.ru_stime;
}

static inline struct timeval
timeval_sub (struct timeval a, struct timeval b)
{
  struct timeval diff;

  diff.tv_sec = a.tv_sec - b.tv_sec;
  diff.tv_usec = a.tv_usec - b.tv_usec;
  if (diff.tv_usec < 0)
    {
      --diff.tv_sec;
      diff.tv_usec += 1000000;
    }

  return diff;
}

void
timing_stop (struct timing *t)
{
  struct rusage r;
  struct timeval now;

  gettimeofday (&now, NULL);
  getrusage (RUSAGE_SELF, &r);
  t->real = timeval_sub (now, t->real);
  t->user = timeval_sub (r.ru_utime, t->user);
  t->sys = timeval_sub (r.ru_stime, t->sys);
}

#ifndef HAVE_GETLINE
ssize_t
getline (char **pbuf, size_t *psize, FILE *fp)
{
  char *buf = *pbuf;
  size_t size = *psize;
  ssize_t off = 0;

  do
    {
      if (!buf || size == 0 || off == size - 1)
  {
    buf = e2nrealloc (buf, &size, 1);
  }
      if (!fgets (buf + off, size - off, fp))
  {
    if (off == 0)
      off = -1;
    break;
  }
      off += strlen (buf + off);
    }
  while (buf[off - 1] != '\n');

  *pbuf = buf;
  *psize = size;
  return off;
}
#endif

static int
argsprep (struct command *cmd, struct gdbmarglist *arglist,
    struct command_param *param)
{
  int i;
  struct gdbmarg *arg = arglist ? arglist->head : NULL;

  for (i = 0; cmd->args[i].name && arg; i++, arg = arg->next)
    {
      if (param_push_arg (param, arg, &cmd->args[i]))
  return 1;
    }

  for (; cmd->args[i].name; i++)
    {
      char *argname = cmd->args[i].name;
      char *argbuf = NULL;
      size_t argsize =0;
      ssize_t n;
      struct gdbmarg *t;

      if (*argname == '[')
  /* Optional argument */
  break;

      if (!interactive ())
  {
    terror (_("%s: not enough arguments"), cmd->name);
    return 1;
  }
      printf ("%s? ", argname);
      fflush (stdout);
      errno = 0;
      if ((n = getline (&argbuf, &argsize, stdin)) < 0)
  {
    terror ("%s", errno ? strerror (errno) : _("unexpected eof"));
    return 1;
  }

      trimnl (argbuf);

      t = gdbmarg_string (argbuf, &yylloc);
      if (param_push_arg (param, t, &cmd->args[i]))
  {
    gdbmarg_free (t);
    return 1;
  }
    }

  if (arg && !cmd->variadic)
    {
      terror (_("%s: too many arguments"), cmd->name);
      return 1;
    }

  param_term (param);
  param->vararg = arg;

  return 0;
}

int
run_command (struct command *cmd, struct gdbmarglist *arglist, char *pipeline)
{
  int i;
  char *pager = NULL;
  struct command_param param = HANDLER_PARAM_INITIALIZER;
  struct command_environ cenv = COMMAND_ENVIRON_INITIALIZER;
  int rc = 0;
  struct timing tm;

  if (argsprep (cmd, arglist, &param))
    rc = GDBMSHELL_ERR;
  else
    {
      if (interactive ())
  variable_get ("pager", VART_STRING, (void**) &pager);
      else
  pager = NULL;

      /* Prepare for calling the handler */

      if (variable_is_true ("trace"))
  {
    fprintf (stderr, "+ %s", cmd->name);
    for (i = 0; i < param.argc; i++)
      {
        format_arg (param.argv[i], &cmd->args[i], stderr);
      }

    if (param.vararg)
      {
        struct gdbmarg *arg;
        for (arg = param.vararg; arg; arg = arg->next)
    format_arg (arg, NULL, stderr);
      }
    fputc ('\n', stderr);
  }

      rc = 0;
      if (!(cmd->begin && (rc = cmd->begin (&param, &cenv)) != 0))
  {
    if (pipeline)
      cenv.pager = pager_create (pipeline);
    else
      cenv.pager = pager_open (stdout, get_screen_lines (), pager);

    timing_start (&tm);
    rc = cmd->handler (&param, &cenv);
    timing_stop (&tm);
    if (cmd->end)
      cmd->end (cenv.data);
    else if (cenv.data)
      free (cenv.data);

    if (variable_is_true ("timing"))
      {
        pager_printf (cenv.pager,
          "[%s r=%lu.%06lu u=%lu.%06lu s=%lu.%06lu]\n",
          cmd->name,
          tm.real.tv_sec, tm.real.tv_usec,
          tm.user.tv_sec, tm.user.tv_usec,
          tm.sys.tv_sec, tm.sys.tv_usec);
      }

    pager_close (cenv.pager);
  }
    }

  param_free (&param);

  switch (rc)
    {
    case GDBMSHELL_OK:
      last_cmd = cmd;
      if (arglist->head != last_args.head)
  {
    gdbmarglist_free (&last_args);
    last_args = *arglist;
  }
      free (last_pipeline);
      last_pipeline = NULL;
      rc = 0;
      break;

    case GDBMSHELL_GDBM_ERR:
      gdbmarglist_free (arglist);
      if (variable_has_errno ("errorexit", gdbm_errno))
  rc = 1;
      else
  rc = 0;
      break;

    default:
      gdbmarglist_free (arglist);
      free (pipeline);
      rc = 0;
    }

  return rc;
}

int
gdbmshell_run (int (*init) (void *, instream_t *), void *data)
{
  int rc;
  int i;
  instream_t instream;

  if (!commands_sorted)
    {
      /* Initialize .len fields */
      for (i = 0; command_tab[i].name; i++)
  command_tab[i].len = strlen (command_tab[i].name);
      /* Sort the entries by name. */
      qsort (command_tab, i, sizeof (command_tab[0]), cmdcmp);
      commands_sorted = 1;
    }

  /* Initialize variables. */
  dsdef[DS_KEY] = dsegm_new_field (datadef_lookup ("string"), NULL, 1);
  dsdef[DS_CONTENT] = dsegm_new_field (datadef_lookup ("string"), NULL, 1);

  variables_init ();
  variable_set ("open", VART_STRING, "wrcreat");
  variable_set ("pager", VART_STRING, getenv ("PAGER"));

  last_cmd = NULL;
  gdbmarglist_init (&last_args, NULL);

  lex_trace (0);

  rc = init (data, &instream);
  if (rc == 0)
    {
      rc = input_context_push (instream);
      if (rc == 0)
  {
    struct sigaction act, old_act;

    act.sa_flags = 0;
    sigemptyset(&act.sa_mask);
    act.sa_handler = SIG_IGN;
    sigaction (SIGPIPE, &act, &old_act);
    /* Welcome message. */
    if (instream_interactive (instream) && !variable_is_true ("quiet"))
      printf (_("\nWelcome to the gdbm tool.  Type ? for help.\n\n"));
    rc = yyparse ();
    input_context_drain ();
    yylex_destroy ();
    closedb ();
    sigaction (SIGPIPE, &old_act, NULL);
  }
      else
  instream_close (instream);
    }

  gdbmarglist_free (&last_args);

  for (i = 0; i < DS_MAX; i++)
    {
      dsegm_list_free (dsdef[i]);
      dsdef[i] = NULL;
    }

  variables_free ();

  return rc;
}

static int
init (void *data, instream_t *pinstr)
{
  *pinstr = data;
  return 0;
}

int
gdbmshell (instream_t input)
{
  return gdbmshell_run (init, input);
}

Coverage Report

Created: 2025-08-29 06:34