[hcoop/debian/exim4.git] / src / lookupapi.h

/*************************************************
*     Exim - an Internet mail transport agent    *
*************************************************/

/* Copyright (c) University of Cambridge 1995 - 2015 */
/* See the file NOTICE for conditions of use and distribution. */


/* The "type" field in each item is a set of bit flags:

  lookup_querystyle     => this is a query-style lookup,
                             else single-key (+ file) style
  lookup_absfile        => an absolute file name is required,
                             (for single-key style only)
*/

typedef struct lookup_info {
  uschar *name;                   /* e.g. "lsearch" */
  int type;                       /* query/singlekey/abs-file */
  void *(*open)(                  /* open function */
    uschar *,                     /* file name for those that have one */
    uschar **);                   /* for error message */
  BOOL (*check)(                  /* file checking function */
    void *,                       /* handle */
    uschar *,                     /* file name */
    int,                          /* modemask for file checking */
    uid_t *,                      /* owners for file checking */
    gid_t *,                      /* owngroups for file checking */
    uschar **);                   /* for error messages */
  int (*find)(                    /* find function */
    void *,                       /* handle */
    uschar *,                     /* file name or NULL */
    const uschar *,               /* key or query */
    int,                          /* length of key or query */
    uschar **,                    /* for returning answer */
    uschar **,                    /* for error message */
    uint *);                      /* cache TTL, seconds */
  void (*close)(                  /* close function */
    void *);                      /* handle */
  void (*tidy)(void);             /* tidy function */
  uschar *(*quote)(               /* quoting function */
    uschar *,                     /* string to quote */
    uschar *);                    /* additional data from quote name */
  void (*version_report)(         /* diagnostic function */
    FILE *);                      /* fh to write to */
} lookup_info;

/* This magic number is used by the following lookup_module_info structure
   for checking API compatibility. It used to be equivalent to the string"LMM3" */
#define LOOKUP_MODULE_INFO_MAGIC 0x4c4d4933
/* Version 2 adds: version_report */
/* Version 3 change: non/cache becomes TTL in seconds */

typedef struct lookup_module_info {
  uint magic;
  lookup_info **lookups;
  uint lookupcount;
} lookup_module_info;

/* End of lookupapi.h */
Commit	Line	Data
420a0d19 CE	1	/*************************************************
	2	* Exim - an Internet mail transport agent *
	3	*************************************************/
	4
2813c06e	5	/* Copyright (c) University of Cambridge 1995 - 2015 */
420a0d19 CE	6	/* See the file NOTICE for conditions of use and distribution. */
	7
	8
	9	/* The "type" field in each item is a set of bit flags:
	10
	11	lookup_querystyle => this is a query-style lookup,
	12	else single-key (+ file) style
	13	lookup_absfile => an absolute file name is required,
	14	(for single-key style only)
	15	*/
	16
	17	typedef struct lookup_info {
	18	uschar name; / e.g. "lsearch" */
	19	int type; /* query/singlekey/abs-file */
	20	void (open)( /* open function */
	21	uschar , / file name for those that have one */
	22	uschar *); / for error message */
	23	BOOL (check)( / file checking function */
	24	void , / handle */
	25	uschar , / file name */
	26	int, /* modemask for file checking */
	27	uid_t , / owners for file checking */
	28	gid_t , / owngroups for file checking */
	29	uschar *); / for error messages */
	30	int (find)( / find function */
	31	void , / handle */
	32	uschar , / file name or NULL */
2813c06e	33	const uschar , / key or query */
420a0d19 CE	34	int, /* length of key or query */
	35	uschar *, / for returning answer */
	36	uschar *, / for error message */
2813c06e	37	uint ); / cache TTL, seconds */
420a0d19 CE	38	void (close)( / close function */
	39	void ); / handle */
	40	void (tidy)(void); / tidy function */
	41	uschar (quote)( /* quoting function */
	42	uschar , / string to quote */
	43	uschar ); / additional data from quote name */
	44	void (version_report)( / diagnostic function */
	45	FILE ); / fh to write to */
	46	} lookup_info;
	47
	48	/* This magic number is used by the following lookup_module_info structure
2813c06e CE	49	for checking API compatibility. It used to be equivalent to the string"LMM3" */
2813c06e CE	50	#define LOOKUP_MODULE_INFO_MAGIC 0x4c4d4933
420a0d19	51	/* Version 2 adds: version_report */
2813c06e	52	/* Version 3 change: non/cache becomes TTL in seconds */
420a0d19 CE	53
	54	typedef struct lookup_module_info {
	55	uint magic;
	56	lookup_info **lookups;
	57	uint lookupcount;
	58	} lookup_module_info;
	59
	60	/* End of lookupapi.h */