mail_conf_time.c

[詳解]

/*++
/* NAME
/*  mail_conf_time 3
/* SUMMARY
/*  time interval configuration parameter support
/* SYNOPSIS
/*  #include <mail_conf.h>
/*
/*  int get_mail_conf_time(name, defval, min, max);
/*  const char *name;
/*  const char *defval;
/*  int min;
/*  int max;
/*
/*  void    set_mail_conf_time(name, value)
/*  const char *name;
/*  const char *value;
/*
/*  void    set_mail_conf_time_int(name, value)
/*  const char *name;
/*  int     value;
/*
/*  void    get_mail_conf_time_table(table)
/*  const CONFIG_TIME_TABLE *table;
/* AUXILIARY FUNCTIONS
/*  int get_mail_conf_time2(name1, name2, defval, def_unit, min, max);
/*  const char *name1;
/*  const char *name2;
/*  int defval;
/*  int def_unit;
/*  int min;
/*  int max;
/*
/*  void    check_mail_conf_time(name, intval, min, max)
/*  const char *name;
/*  int intval;
/*  int min;
/*  int max;
/* DESCRIPTION
/*  This module implements configuration parameter support
/*  for time interval values. The conversion routines understand
/*  one-letter suffixes to specify an explicit time unit: s
/*  (seconds), m (minutes), h (hours), d (days) or w (weeks).
/*  Internally, time is represented in seconds.
/*
/*  get_mail_conf_time() looks up the named entry in the global
/*  configuration dictionary. The default value is returned
/*  when no value was found. \fIdef_unit\fR supplies the default
/*  time unit for numbers numbers specified without explicit unit.
/*  \fImin\fR is zero or specifies a lower limit on the integer
/*  value or string length; \fImax\fR is zero or specifies an
/*  upper limit on the integer value or string length.
/*
/*  set_mail_conf_time() updates the named entry in the global
/*  configuration dictionary. This has no effect on values that
/*  have been looked up earlier via the get_mail_conf_XXX() routines.
/*
/*  get_mail_conf_time_table() and get_mail_conf_time_fn_table() initialize
/*  lists of variables, as directed by their table arguments. A table
/*  must be terminated by a null entry.
/*
/*  check_mail_conf_time() terminates the program with a fatal
/*  runtime error when the time does not meet its requirements.
/* DIAGNOSTICS
/*  Fatal errors: malformed numerical value, unknown time unit.
/* BUGS
/*  Values and defaults are given in any unit; upper and lower
/*  bounds are given in seconds.
/* SEE ALSO
/*  config(3) general configuration
/*  mail_conf_str(3) string-valued configuration parameters
/* LICENSE
/* .ad
/* .fi
/*  The Secure Mailer license must be distributed with this software.
/* AUTHOR(S)
/*  Wietse Venema
/*  IBM T.J. Watson Research
/*  P.O. Box 704
/*  Yorktown Heights, NY 10598, USA
/*
/*  Wietse Venema
/*  Google, Inc.
/*  111 8th Avenue
/*  New York, NY 10011, USA
/*--*/

/* System library. */

#include <sys_defs.h>
#include <stdlib.h>
#include <stdio.h>          /* BUFSIZ */
#include <ctype.h>

/* Utility library. */

#include <msg.h>
#include <mymalloc.h>
#include <dict.h>
#include <stringops.h>

/* Global library. */

#include "conv_time.h"
#include "mail_conf.h"

/* convert_mail_conf_time - look up and convert integer parameter value */

static int convert_mail_conf_time(const char *name, int *intval, int def_unit)
{
    const char *strval;

    if ((strval = mail_conf_lookup_eval(name)) == 0)
    return (0);
    if (conv_time(strval, intval, def_unit) == 0)
    msg_fatal("parameter %s: bad time value or unit: %s", name, strval);
    return (1);
}

/* check_mail_conf_time - validate integer value */

void    check_mail_conf_time(const char *name, int intval, int min, int max)
{
    if (min && intval < min)
    msg_fatal("invalid %s: %d (min %d)", name, intval, min);
    if (max && intval > max)
    msg_fatal("invalid %s: %d (max %d)", name, intval, max);
}

/* get_def_time_unit - extract time unit from default value */

static int get_def_time_unit(const char *name, const char *defval)
{
    const char *cp;

    for (cp = mail_conf_eval(defval); /* void */ ; cp++) {
    if (*cp == 0)
        msg_panic("parameter %s: missing time unit in default value: %s",
              name, defval);
    if (ISALPHA(*cp)) {
#if 0
        if (cp[1] != 0)
        msg_panic("parameter %s: bad time unit in default value: %s",
              name, defval);
#endif
        return (*cp);
    }
    }
}

/* get_mail_conf_time - evaluate integer-valued configuration variable */

int     get_mail_conf_time(const char *name, const char *defval, int min, int max)
{
    int     intval;
    int     def_unit;

    def_unit = get_def_time_unit(name, defval);
    if (convert_mail_conf_time(name, &intval, def_unit) == 0)
    set_mail_conf_time(name, defval);
    if (convert_mail_conf_time(name, &intval, def_unit) == 0)
    msg_panic("get_mail_conf_time: parameter not found: %s", name);
    check_mail_conf_time(name, intval, min, max);
    return (intval);
}

/* get_mail_conf_time2 - evaluate integer-valued configuration variable */

int     get_mail_conf_time2(const char *name1, const char *name2,
                     int defval, int def_unit, int min, int max)
{
    int     intval;
    char   *name;

    name = concatenate(name1, name2, (char *) 0);
    if (convert_mail_conf_time(name, &intval, def_unit) == 0)
    set_mail_conf_time_int(name, defval);
    if (convert_mail_conf_time(name, &intval, def_unit) == 0)
    msg_panic("get_mail_conf_time2: parameter not found: %s", name);
    check_mail_conf_time(name, intval, min, max);
    myfree(name);
    return (intval);
}

/* set_mail_conf_time - update integer-valued configuration dictionary entry */

void    set_mail_conf_time(const char *name, const char *value)
{
    mail_conf_update(name, value);
}

/* set_mail_conf_time_int - update integer-valued configuration dictionary entry */

void    set_mail_conf_time_int(const char *name, int value)
{
    char    buf[BUFSIZ];        /* yeah! crappy code! */

    sprintf(buf, "%ds", value);         /* yeah! more crappy code! */
    mail_conf_update(name, buf);
}

/* get_mail_conf_time_table - look up table of integers */

void    get_mail_conf_time_table(const CONFIG_TIME_TABLE *table)
{
    while (table->name) {
    table->target[0] = get_mail_conf_time(table->name, table->defval,
                          table->min, table->max);
    table++;
    }
}

#ifdef TEST

 /*
  * Stand-alone driver program for regression testing.
  */
#include <vstream.h>

int     main(int unused_argc, char **unused_argv)
{
    static int seconds;
    static int minutes;
    static int hours;
    static int days;
    static int weeks;
    static const CONFIG_TIME_TABLE time_table[] = {
    "seconds", "10s", &seconds, 0, 0,
    "minutes", "10m", &minutes, 0, 0,
    "hours", "10h", &hours, 0, 0,
    "days", "10d", &days, 0, 0,
    "weeks", "10w", &weeks, 0, 0,
    0,
    };

    get_mail_conf_time_table(time_table);
    vstream_printf("10 seconds = %d\n", seconds);
    vstream_printf("10 minutes = %d\n", minutes);
    vstream_printf("10 hours = %d\n", hours);
    vstream_printf("10 days = %d\n", days);
    vstream_printf("10 weeks = %d\n", weeks);
    vstream_fflush(VSTREAM_OUT);
    return (0);
}

#endif