1 /* config.h - configuration abstraction structure */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2007 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
12 * A copy of this license is available in the file LICENSE in the
13 * top-level directory of the distribution or, alternatively, at
14 * <http://www.OpenLDAP.org/license.html>.
22 typedef struct ConfigTable {
28 unsigned int arg_type;
31 AttributeDescription *ad;
35 /* search entries are returned according to this order */
44 Cft_Misc /* backend/overlay defined */
47 #define ARGS_USERLAND 0x00000fff
49 /* types are enumerated, not a bitmask */
50 #define ARGS_TYPES 0x0000f000
51 #define ARG_INT 0x00001000
52 #define ARG_LONG 0x00002000
53 #define ARG_BER_LEN_T 0x00003000
54 #define ARG_ON_OFF 0x00004000
55 #define ARG_STRING 0x00005000
56 #define ARG_BERVAL 0x00006000
57 #define ARG_DN 0x00007000
59 #define ARGS_SYNTAX 0xffff0000
60 #define ARG_IGNORED 0x00080000
61 #define ARG_PRE_BI 0x00100000
62 #define ARG_PRE_DB 0x00200000
63 #define ARG_DB 0x00400000 /* Only applies to DB */
64 #define ARG_MAY_DB 0x00800000 /* May apply to DB */
65 #define ARG_PAREN 0x01000000
66 #define ARG_NONZERO 0x02000000
67 #define ARG_NO_INSERT 0x04000000 /* no arbitrary inserting */
68 #define ARG_NO_DELETE 0x08000000 /* no runtime deletes */
69 #define ARG_UNIQUE 0x10000000
70 #define ARG_QUOTE 0x20000000 /* wrap with quotes before parsing */
71 #define ARG_OFFSET 0x40000000
72 #define ARG_MAGIC 0x80000000
74 #define ARG_BAD_CONF 0xdead0000 /* overload return values */
76 /* This is a config entry's e_private data */
77 typedef struct CfEntryInfo {
78 struct CfEntryInfo *ce_parent;
79 struct CfEntryInfo *ce_sibs;
80 struct CfEntryInfo *ce_kids;
90 /* Check if the child is allowed to be LDAPAdd'd to the parent */
91 typedef int (ConfigLDAPadd)(
92 CfEntryInfo *parent, Entry *child, struct config_args_s *ca);
94 /* Let the object create children out of slapd.conf */
95 typedef int (ConfigCfAdd)(
96 Operation *op, SlapReply *rs, Entry *parent, struct config_args_s *ca );
98 typedef struct ConfigOCs {
101 ConfigTable *co_table;
102 ConfigLDAPadd *co_ldadd;
103 ConfigCfAdd *co_cfadd;
105 struct berval *co_name;
108 typedef int (ConfigDriver)(struct config_args_s *c);
110 typedef struct config_reply_s {
112 char msg[SLAP_TEXT_BUFLEN];
115 typedef struct config_args_s {
123 char log[MAXPATHLEN + STRLENOF(": line 18446744073709551615") + 1];
124 #define cr_msg reply.msg
127 int valx; /* multi-valued value index */
128 /* parsed first val for simple cases */
136 struct berval vdn_dn;
137 struct berval vdn_ndn;
140 /* return values for emit mode */
141 BerVarray rvalue_vals;
142 BerVarray rvalue_nvals;
143 #define SLAP_CONFIG_EMIT 0x2000 /* emit instead of set */
144 #define SLAP_CONFIG_ADD 0x4000 /* config file add vs LDAP add */
146 int type; /* ConfigTable.arg_type & ARGS_USERLAND */
150 Entry *ca_entry; /* entry being modified */
151 void *private; /* anything */
152 ConfigDriver *cleanup;
153 ConfigType table; /* which config table did we come from */
156 /* If lineno is zero, we have an actual LDAP Add request from a client.
157 * Otherwise, we're reading a config file or a config dir.
159 #define CONFIG_ONLINE_ADD(ca) (!((ca)->lineno))
161 #define value_int values.v_int
162 #define value_long values.v_long
163 #define value_ber_t values.v_ber_t
164 #define value_string values.v_string
165 #define value_bv values.v_bv
166 #define value_dn values.v_dn.vdn_dn
167 #define value_ndn values.v_dn.vdn_ndn
169 int config_register_schema(ConfigTable *ct, ConfigOCs *co);
170 int config_del_vals(ConfigTable *cf, ConfigArgs *c);
171 int config_get_vals(ConfigTable *ct, ConfigArgs *c);
172 int config_add_vals(ConfigTable *ct, ConfigArgs *c);
174 void init_config_argv( ConfigArgs *c );
175 int init_config_attrs(ConfigTable *ct);
176 int init_config_ocs( ConfigOCs *ocs );
177 int config_parse_vals(ConfigTable *ct, ConfigArgs *c, int valx);
178 int config_parse_add(ConfigTable *ct, ConfigArgs *c, int valx);
179 int read_config_file(const char *fname, int depth, ConfigArgs *cf,
182 ConfigTable * config_find_keyword(ConfigTable *ct, ConfigArgs *c);
183 Entry * config_build_entry( Operation *op, SlapReply *rs, CfEntryInfo *parent,
184 ConfigArgs *c, struct berval *rdn, ConfigOCs *main, ConfigOCs *extra );
186 int config_shadow( ConfigArgs *c, int flag );
187 #define config_slurp_shadow(c) config_shadow((c), SLAP_DBFLAG_SLURP_SHADOW)
188 #define config_sync_shadow(c) config_shadow((c), SLAP_DBFLAG_SYNC_SHADOW)
190 /* Make sure we don't exceed the bits reserved for userland */
191 #define config_check_userland(last) \
192 assert( ( ( (last) - 1 ) & ARGS_USERLAND ) == ( (last) - 1 ) );
194 #define SLAP_X_ORDERED_FMT "{%d}"
196 #endif /* CONFIG_H */