[moira.git] / server / query.h

/* $Header$
 *
 * Structures and constants used in the query dispatch table
 */

/* Query Types */
enum query_type {RETRIEVE, UPDATE, APPEND, DELETE, SPECIAL};

/* Query Definition Structure */
struct query
{
    char *name;			/* query name */
    char *shortname;		/* abbreviated query name (must be 4 chars) */
    enum query_type type;	/* query type */
    char *rvar;			/* range variable */
    char *rtable;		/* range table */
    char *tlist;		/* target list */
    char **fields;		/* input and output variable names (for help) */
    int  vcnt;			/* variable count */
    char *qual;			/* format string for "where" clause */
    int  argc;			/* number of args for qualifier */
    struct validate *validate;	/* validation support */
    int	 acl;			/* hint as to query ACL for this query */
    int  everybody;		/* is the default user on this ACL? */
};

/* Query Validation Structure */
struct validate
{
    /* object validation (e.g., user, filesys, type) */
    struct valobj *valobj;	/* array of object validation descriptors */
    int objcnt;			/* size of array */
    /* row validation - retrieve (exists = any(rvar.field where qual)) */
    char *field;		/* field to check for */
    char *qual;			/* format string for "where" clause */
    int  argc;			/* number of args used in qual */
    /* values field containing current max object id */
    char *object_id;
    /* routine to verify access permission on objects */
    int (*acs_rtn)();
    /* pre-processing routine (var setup only) */
    int (*pre_rtn)();
    /* post-processing routine */
    int (*post_rtn)();
};
	
/* Validated Object Types */
enum vo_type {V_NAME, V_ID, V_TYPE, V_TYPEDATA, V_DATE, 
	      V_SORT, V_RENAME, V_CHAR, V_LOCK, V_WILD, V_UPWILD};

/* Validated Object Definition */
struct valobj
{
    enum vo_type type;
    int index;			/* index of object to validate */
    char *table;		/* table containing object */
    char *namefield;		/* table's fieldname for object */
    char *idfield;		/* table's corresponding id field (if any) */
    int error;
};

/* Used to setup static argv, maximum argc and argument lengths */
#define QMAXARGS	20
#define QMAXARGSIZE	513
Commit	Line	Data
0236bb42	1	/* $Header$
	2	*
	3	* Structures and constants used in the query dispatch table
	4	*/
	5
	6	/* Query Types */
	7	enum query_type {RETRIEVE, UPDATE, APPEND, DELETE, SPECIAL};
	8
	9	/* Query Definition Structure */
	10	struct query
	11	{
	12	char name; / query name */
	13	char shortname; / abbreviated query name (must be 4 chars) */
	14	enum query_type type; /* query type */
	15	char rvar; / range variable */
	16	char rtable; / range table */
	17	char tlist; / target list */
	18	char *fields; / input and output variable names (for help) */
	19	int vcnt; /* variable count */
	20	char qual; / format string for "where" clause */
	21	int argc; /* number of args for qualifier */
	22	struct validate validate; / validation support */
	23	int acl; /* hint as to query ACL for this query */
	24	int everybody; /* is the default user on this ACL? */
	25	};
	26
	27	/* Query Validation Structure */
	28	struct validate
	29	{
	30	/* object validation (e.g., user, filesys, type) */
	31	struct valobj valobj; / array of object validation descriptors */
	32	int objcnt; /* size of array */
	33	/* row validation - retrieve (exists = any(rvar.field where qual)) */
	34	char field; / field to check for */
	35	char qual; / format string for "where" clause */
	36	int argc; /* number of args used in qual */
	37	/* values field containing current max object id */
	38	char *object_id;
	39	/* routine to verify access permission on objects */
	40	int (*acs_rtn)();
	41	/* pre-processing routine (var setup only) */
	42	int (*pre_rtn)();
	43	/* post-processing routine */
	44	int (*post_rtn)();
	45	};
	46
	47	/* Validated Object Types */
	48	enum vo_type {V_NAME, V_ID, V_TYPE, V_TYPEDATA, V_DATE,
4d50019a	49	V_SORT, V_RENAME, V_CHAR, V_LOCK, V_WILD, V_UPWILD};
0236bb42	50
	51	/* Validated Object Definition */
	52	struct valobj
	53	{
	54	enum vo_type type;
	55	int index; /* index of object to validate */
	56	char table; / table containing object */
	57	char namefield; / table's fieldname for object */
	58	char idfield; / table's corresponding id field (if any) */
	59	int error;
	60	};
	61
	62	/* Used to setup static argv, maximum argc and argument lengths */
	63	#define QMAXARGS 20
	64	#define QMAXARGSIZE 513
	65