[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};

/* Tables */
enum tables {NO_TABLE, USERS_TABLE, KRBMAP_TABLE, MACHINE_TABLE,
	     HOSTALIAS_TABLE, SUBNET_TABLE, CLUSTER_TABLE, MCMAP_TABLE,
	     SVC_TABLE, LIST_TABLE, IMEMBERS_TABLE, SERVERS_TABLE,
	     SERVERHOSTS_TABLE, FILESYS_TABLE, FSGROUP_TABLE, NFSPHYS_TABLE,
	     QUOTA_TABLE, ZEPHYR_TABLE, HOSTACCESS_TABLE, STRINGS_TABLE,
	     SERVICES_TABLE, PRINTCAP_TABLE, PALLADIUM_TABLE, CAPACLS_TABLE,
	     ALIAS_TABLE, NUMVALUES_TABLE, TBLSTATS_TABLE, INCREMENTAL_TABLE};

/* 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 */
    enum tables 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 */
    char *sort;			/* fields to sort on */
    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_RENAME, V_CHAR, V_LOCK, V_WILD, V_UPWILD,
              V_RLOCK, V_LEN, V_NUM};

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


/* prototypes from cache.dc */
void flush_cache(void);
int name_to_id(char *name, enum tables type, int *id);
int id_to_name(int id, enum tables type, char **name);
int cache_entry(char *name, enum tables type, int id);
void flush_name(char *name, enum tables type);
void cache_commit(void);
void cache_abort(void);

/* prototypes from increment.dc */
void incremental_before(enum tables table, char *qualx, char **argv);
void incremental_clear_before(void);
void incremental_after(enum tables table, char *qualx, char **argv);
void incremental_clear_after(void);

/* prototypes from qfollow.dc */
int set_pobox_modtime(struct query *q, char *argv[], client *cl);

/* prototypes from qrtn.dc */
int check_query_access(struct query *q, char *argv[], client *cl);
int set_next_object_id(char *objectx, enum tables table, int limit);

/* prototypes from qsubs.c */
void list_queries(int version, int (*action)(), char *actarg);
void help_query(struct query *q, int (*action)(), char *actarg);
struct query *get_query_by_name(char *name, int version);
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
03c05291	9	/* Tables */
	10	enum tables {NO_TABLE, USERS_TABLE, KRBMAP_TABLE, MACHINE_TABLE,
	11	HOSTALIAS_TABLE, SUBNET_TABLE, CLUSTER_TABLE, MCMAP_TABLE,
	12	SVC_TABLE, LIST_TABLE, IMEMBERS_TABLE, SERVERS_TABLE,
	13	SERVERHOSTS_TABLE, FILESYS_TABLE, FSGROUP_TABLE, NFSPHYS_TABLE,
	14	QUOTA_TABLE, ZEPHYR_TABLE, HOSTACCESS_TABLE, STRINGS_TABLE,
	15	SERVICES_TABLE, PRINTCAP_TABLE, PALLADIUM_TABLE, CAPACLS_TABLE,
	16	ALIAS_TABLE, NUMVALUES_TABLE, TBLSTATS_TABLE, INCREMENTAL_TABLE};
	17
0236bb42	18	/* Query Definition Structure */
	19	struct query
	20	{
	21	char name; / query name */
	22	char shortname; / abbreviated query name (must be 4 chars) */
	23	enum query_type type; /* query type */
	24	char rvar; / range variable */
03c05291	25	enum tables rtable; /* range table */
0236bb42	26	char tlist; / target list */
	27	char *fields; / input and output variable names (for help) */
	28	int vcnt; /* variable count */
	29	char qual; / format string for "where" clause */
	30	int argc; /* number of args for qualifier */
68b5b948	31	char sort; / fields to sort on */
0236bb42	32	struct validate validate; / validation support */
	33	int acl; /* hint as to query ACL for this query */
	34	int everybody; /* is the default user on this ACL? */
	35	};
	36
	37	/* Query Validation Structure */
	38	struct validate
	39	{
	40	/* object validation (e.g., user, filesys, type) */
	41	struct valobj valobj; / array of object validation descriptors */
	42	int objcnt; /* size of array */
	43	/* row validation - retrieve (exists = any(rvar.field where qual)) */
	44	char field; / field to check for */
	45	char qual; / format string for "where" clause */
	46	int argc; /* number of args used in qual */
	47	/* values field containing current max object id */
	48	char *object_id;
	49	/* routine to verify access permission on objects */
	50	int (*acs_rtn)();
	51	/* pre-processing routine (var setup only) */
	52	int (*pre_rtn)();
	53	/* post-processing routine */
	54	int (*post_rtn)();
	55	};
	56
	57	/* Validated Object Types */
	58	enum vo_type {V_NAME, V_ID, V_TYPE, V_TYPEDATA, V_DATE,
68b5b948	59	V_RENAME, V_CHAR, V_LOCK, V_WILD, V_UPWILD,
f0e5d2fe	60	V_RLOCK, V_LEN, V_NUM};
0236bb42	61
	62	/* Validated Object Definition */
	63	struct valobj
	64	{
	65	enum vo_type type;
	66	int index; /* index of object to validate */
03c05291	67	enum tables table; /* table containing object */
0236bb42	68	char namefield; / table's fieldname for object */
	69	char idfield; / table's corresponding id field (if any) */
	70	int error;
	71	};
03c05291	72
	73
	74	/* prototypes from cache.dc */
	75	void flush_cache(void);
	76	int name_to_id(char name, enum tables type, int id);
	77	int id_to_name(int id, enum tables type, char **name);
	78	int cache_entry(char *name, enum tables type, int id);
	79	void flush_name(char *name, enum tables type);
	80	void cache_commit(void);
	81	void cache_abort(void);
	82
	83	/* prototypes from increment.dc */
	84	void incremental_before(enum tables table, char qualx, char *argv);
	85	void incremental_clear_before(void);
	86	void incremental_after(enum tables table, char qualx, char *argv);
	87	void incremental_clear_after(void);
	88
	89	/* prototypes from qfollow.dc */
	90	int set_pobox_modtime(struct query q, char argv[], client *cl);
	91
	92	/* prototypes from qrtn.dc */
	93	int check_query_access(struct query q, char argv[], client *cl);
	94	int set_next_object_id(char *objectx, enum tables table, int limit);
	95
	96	/* prototypes from qsubs.c */
960b073b	97	void list_queries(int version, int (action)(), char actarg);
960b073b	98	void help_query(struct query q, int (action)(), char *actarg);
03c05291	99	struct query get_query_by_name(char name, int version);