]> git.sur5r.net Git - openldap/blob - servers/slapd/config.h
Merge remote-tracking branch 'origin/mdb.master' into OPENLDAP_REL_ENG_2_5
[openldap] / servers / slapd / config.h
1 /* config.h - configuration abstraction structure */
2 /* $OpenLDAP$ */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4  *
5  * Copyright 1998-2014 The OpenLDAP Foundation.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted only as authorized by the OpenLDAP
10  * Public License.
11  *
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>.
15  */
16
17 #ifndef CONFIG_H
18 #define CONFIG_H
19
20 #include<ac/string.h>
21
22 LDAP_BEGIN_DECL
23
24 typedef struct ConfigTable {
25         const char *name;
26         const char *what;
27         int min_args;
28         int max_args;
29         int length;
30         unsigned int arg_type;
31         void *arg_item;
32         const char *attribute;
33         AttributeDescription *ad;
34         void *notify;
35 } ConfigTable;
36
37 /* search entries are returned according to this order */
38 typedef enum {
39         Cft_Abstract = 0,
40         Cft_Global,
41         Cft_Module,
42         Cft_Schema,
43         Cft_Backend,
44         Cft_Database,
45         Cft_Overlay,
46         Cft_Misc        /* backend/overlay defined */
47 } ConfigType;
48
49 #define ARGS_USERLAND   0x00000fff
50
51 /* types are enumerated, not a bitmask */
52 #define ARGS_TYPES      0x0000f000
53 #define ARG_INT         0x00001000
54 #define ARG_LONG        0x00002000
55 #define ARG_BER_LEN_T   0x00003000
56 #define ARG_ON_OFF      0x00004000
57 #define ARG_STRING      0x00005000
58 #define ARG_BERVAL      0x00006000
59 #define ARG_DN          0x00007000
60 #define ARG_UINT        0x00008000
61 #define ARG_ATDESC      0x00009000
62 #define ARG_ULONG       0x0000a000
63
64 #define ARGS_SYNTAX     0xffff0000
65 #define ARG_IGNORED     0x00080000
66 #define ARG_PRE_BI      0x00100000
67 #define ARG_PRE_DB      0x00200000
68 #define ARG_DB          0x00400000      /* Only applies to DB */
69 #define ARG_MAY_DB      0x00800000      /* May apply to DB */
70 #define ARG_PAREN       0x01000000
71 #define ARG_NONZERO     0x02000000
72 #define ARG_NO_INSERT   0x04000000      /* no arbitrary inserting */
73 #define ARG_NO_DELETE   0x08000000      /* no runtime deletes */
74 #define ARG_UNIQUE      0x10000000
75 #define ARG_QUOTE       0x20000000      /* wrap with quotes before parsing */
76 #define ARG_OFFSET      0x40000000
77 #define ARG_MAGIC       0x80000000
78
79 #define ARG_BAD_CONF    0xdead0000      /* overload return values */
80
81 /* This is a config entry's e_private data */
82 typedef struct CfEntryInfo {
83         struct CfEntryInfo *ce_parent;
84         struct CfEntryInfo *ce_sibs;
85         struct CfEntryInfo *ce_kids;
86         Entry *ce_entry;
87         ConfigType ce_type;
88         BackendInfo *ce_bi;
89         BackendDB *ce_be;
90         void *ce_private;
91 } CfEntryInfo;
92
93 struct config_args_s;
94
95 /* Check if the child is allowed to be LDAPAdd'd to the parent */
96 typedef int (ConfigLDAPadd)(
97         CfEntryInfo *parent, Entry *child, struct config_args_s *ca);
98
99 /* Let the object create children out of slapd.conf */
100 typedef int (ConfigCfAdd)(
101         Operation *op, SlapReply *rs, Entry *parent, struct config_args_s *ca );
102
103 #ifdef SLAP_CONFIG_DELETE
104 /* Called when deleting a Cft_Misc Child object from cn=config */
105 typedef int (ConfigLDAPdel)(
106         CfEntryInfo *ce, Operation *op );
107 #endif
108
109 typedef struct ConfigOCs {
110         const char *co_def;
111         ConfigType co_type;
112         ConfigTable *co_table;
113         ConfigLDAPadd *co_ldadd;
114         ConfigCfAdd *co_cfadd;
115 #ifdef SLAP_CONFIG_DELETE
116         ConfigLDAPdel *co_lddel;
117 #endif
118         ObjectClass *co_oc;
119         struct berval *co_name;
120 } ConfigOCs;
121
122 typedef int (ConfigDriver)(struct config_args_s *c);
123
124 struct config_reply_s {
125         int err;
126         char msg[SLAP_TEXT_BUFLEN];
127 };
128
129 typedef struct config_args_s {
130         int argc;
131         char **argv;
132         int argv_size;
133         char *line;
134         char *tline;
135         const char *fname;
136         int lineno;
137         char log[MAXPATHLEN + STRLENOF(": line ") + LDAP_PVT_INTTYPE_CHARS(unsigned long)];
138 #define cr_msg reply.msg
139         ConfigReply reply;
140         int depth;
141         int valx;       /* multi-valued value index */
142         /* parsed first val for simple cases */
143         union {
144                 int v_int;
145                 unsigned v_uint;
146                 long v_long;
147                 size_t v_ulong;
148                 ber_len_t v_ber_t;
149                 char *v_string;
150                 struct berval v_bv;
151                 struct {
152                         struct berval vdn_dn;
153                         struct berval vdn_ndn;
154                 } v_dn;
155                 AttributeDescription *v_ad;
156         } values;
157         /* return values for emit mode */
158         BerVarray rvalue_vals;
159         BerVarray rvalue_nvals;
160 #define SLAP_CONFIG_EMIT        0x2000  /* emit instead of set */
161 #define SLAP_CONFIG_ADD         0x4000  /* config file add vs LDAP add */
162         int op;
163         int type;       /* ConfigTable.arg_type & ARGS_USERLAND */
164         Operation *ca_op;
165         BackendDB *be;
166         BackendInfo *bi;
167         Entry *ca_entry;        /* entry being modified */
168         void *ca_private;       /* anything */
169         ConfigDriver *cleanup;
170         ConfigType table;       /* which config table did we come from */
171 } ConfigArgs;
172
173 /* If lineno is zero, we have an actual LDAP Add request from a client.
174  * Otherwise, we're reading a config file or a config dir.
175  */
176 #define CONFIG_ONLINE_ADD(ca)   (!((ca)->lineno))
177
178 #define value_int values.v_int
179 #define value_uint values.v_uint
180 #define value_long values.v_long
181 #define value_ulong values.v_ulong
182 #define value_ber_t values.v_ber_t
183 #define value_string values.v_string
184 #define value_bv values.v_bv
185 #define value_dn values.v_dn.vdn_dn
186 #define value_ndn values.v_dn.vdn_ndn
187 #define value_ad values.v_ad
188
189 int config_fp_parse_line(ConfigArgs *c);
190
191 int config_register_schema(ConfigTable *ct, ConfigOCs *co);
192 int config_del_vals(ConfigTable *cf, ConfigArgs *c);
193 int config_get_vals(ConfigTable *ct, ConfigArgs *c);
194 int config_add_vals(ConfigTable *ct, ConfigArgs *c);
195
196 void init_config_argv( ConfigArgs *c );
197 int init_config_attrs(ConfigTable *ct);
198 int init_config_ocs( ConfigOCs *ocs );
199 int config_parse_vals(ConfigTable *ct, ConfigArgs *c, int valx);
200 int config_parse_add(ConfigTable *ct, ConfigArgs *c, int valx);
201 int read_config_file(const char *fname, int depth, ConfigArgs *cf,
202         ConfigTable *cft );
203
204 ConfigTable * config_find_keyword(ConfigTable *ct, ConfigArgs *c);
205 Entry * config_build_entry( Operation *op, SlapReply *rs, CfEntryInfo *parent,
206         ConfigArgs *c, struct berval *rdn, ConfigOCs *main, ConfigOCs *extra );
207
208 Listener *config_check_my_url(const char *url, LDAPURLDesc *lud);
209 int config_shadow( ConfigArgs *c, slap_mask_t flag );
210 #define config_slurp_shadow(c)  config_shadow((c), SLAP_DBFLAG_SLURP_SHADOW)
211 #define config_sync_shadow(c)   config_shadow((c), SLAP_DBFLAG_SYNC_SHADOW)
212
213         /* Make sure we don't exceed the bits reserved for userland */
214 #define config_check_userland(last) \
215         assert( ( ( (last) - 1 ) & ARGS_USERLAND ) == ( (last) - 1 ) );
216
217 #define SLAP_X_ORDERED_FMT      "{%d}"
218
219 LDAP_SLAPD_V (slap_verbmasks *) slap_ldap_response_code;
220 extern int slap_ldap_response_code_register( struct berval *bv, int err );
221
222 LDAP_SLAPD_V (ConfigTable) olcDatabaseDummy[];
223
224 LDAP_END_DECL
225
226 #endif /* CONFIG_H */