git.sur5r.net Git - openldap/blob - 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-2008 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
  62 #define ARGS_SYNTAX     0xffff0000
  63 #define ARG_IGNORED     0x00080000
  64 #define ARG_PRE_BI      0x00100000
  65 #define ARG_PRE_DB      0x00200000
  66 #define ARG_DB          0x00400000      /* Only applies to DB */
  67 #define ARG_MAY_DB      0x00800000      /* May apply to DB */
  68 #define ARG_PAREN       0x01000000
  69 #define ARG_NONZERO     0x02000000
  70 #define ARG_NO_INSERT   0x04000000      /* no arbitrary inserting */
  71 #define ARG_NO_DELETE   0x08000000      /* no runtime deletes */
  72 #define ARG_UNIQUE      0x10000000
  73 #define ARG_QUOTE       0x20000000      /* wrap with quotes before parsing */
  74 #define ARG_OFFSET      0x40000000
  75 #define ARG_MAGIC       0x80000000
  76
  77 #define ARG_BAD_CONF    0xdead0000      /* overload return values */
  78
  79 /* This is a config entry's e_private data */
  80 typedef struct CfEntryInfo {
  81         struct CfEntryInfo *ce_parent;
  82         struct CfEntryInfo *ce_sibs;
  83         struct CfEntryInfo *ce_kids;
  84         Entry *ce_entry;
  85         ConfigType ce_type;
  86         BackendInfo *ce_bi;
  87         BackendDB *ce_be;
  88         void *ce_private;
  89 } CfEntryInfo;
  90
  91 struct config_args_s;
  92
  93 /* Check if the child is allowed to be LDAPAdd'd to the parent */
  94 typedef int (ConfigLDAPadd)(
  95         CfEntryInfo *parent, Entry *child, struct config_args_s *ca);
  96
  97 /* Let the object create children out of slapd.conf */
  98 typedef int (ConfigCfAdd)(
  99         Operation *op, SlapReply *rs, Entry *parent, struct config_args_s *ca );
 100
 101 typedef struct ConfigOCs {
 102         const char *co_def;
 103         ConfigType co_type;
 104         ConfigTable *co_table;
 105         ConfigLDAPadd *co_ldadd;
 106         ConfigCfAdd *co_cfadd;
 107         ObjectClass *co_oc;
 108         struct berval *co_name;
 109 } ConfigOCs;
 110
 111 typedef int (ConfigDriver)(struct config_args_s *c);
 112
 113 struct config_reply_s {
 114         int err;
 115         char msg[SLAP_TEXT_BUFLEN];
 116 };
 117
 118 typedef struct config_args_s {
 119         int argc;
 120         char **argv;
 121         int argv_size;
 122         char *line;
 123         char *tline;
 124         const char *fname;
 125         int lineno;
 126         char log[MAXPATHLEN + STRLENOF(": line ") + LDAP_PVT_INTTYPE_CHARS(unsigned long)];
 127 #define cr_msg reply.msg
 128         ConfigReply reply;
 129         int depth;
 130         int valx;       /* multi-valued value index */
 131         /* parsed first val for simple cases */
 132         union {
 133                 int v_int;
 134                 unsigned v_uint;
 135                 long v_long;
 136                 ber_len_t v_ber_t;
 137                 char *v_string;
 138                 struct berval v_bv;
 139                 struct {
 140                         struct berval vdn_dn;
 141                         struct berval vdn_ndn;
 142                 } v_dn;
 143         } values;
 144         /* return values for emit mode */
 145         BerVarray rvalue_vals;
 146         BerVarray rvalue_nvals;
 147 #define SLAP_CONFIG_EMIT        0x2000  /* emit instead of set */
 148 #define SLAP_CONFIG_ADD         0x4000  /* config file add vs LDAP add */
 149         int op;
 150         int type;       /* ConfigTable.arg_type & ARGS_USERLAND */
 151         Operation *ca_op;
 152         BackendDB *be;
 153         BackendInfo *bi;
 154         Entry *ca_entry;        /* entry being modified */
 155         void *ca_private;       /* anything */
 156         ConfigDriver *cleanup;
 157         ConfigType table;       /* which config table did we come from */
 158 } ConfigArgs;
 159
 160 /* If lineno is zero, we have an actual LDAP Add request from a client.
 161  * Otherwise, we're reading a config file or a config dir.
 162  */
 163 #define CONFIG_ONLINE_ADD(ca)   (!((ca)->lineno))
 164
 165 #define value_int values.v_int
 166 #define value_uint values.v_uint
 167 #define value_long values.v_long
 168 #define value_ber_t values.v_ber_t
 169 #define value_string values.v_string
 170 #define value_bv values.v_bv
 171 #define value_dn values.v_dn.vdn_dn
 172 #define value_ndn values.v_dn.vdn_ndn
 173
 174 int config_register_schema(ConfigTable *ct, ConfigOCs *co);
 175 int config_del_vals(ConfigTable *cf, ConfigArgs *c);
 176 int config_get_vals(ConfigTable *ct, ConfigArgs *c);
 177 int config_add_vals(ConfigTable *ct, ConfigArgs *c);
 178
 179 void init_config_argv( ConfigArgs *c );
 180 int init_config_attrs(ConfigTable *ct);
 181 int init_config_ocs( ConfigOCs *ocs );
 182 int config_parse_vals(ConfigTable *ct, ConfigArgs *c, int valx);
 183 int config_parse_add(ConfigTable *ct, ConfigArgs *c, int valx);
 184 int read_config_file(const char *fname, int depth, ConfigArgs *cf,
 185         ConfigTable *cft );
 186
 187 ConfigTable * config_find_keyword(ConfigTable *ct, ConfigArgs *c);
 188 Entry * config_build_entry( Operation *op, SlapReply *rs, CfEntryInfo *parent,
 189         ConfigArgs *c, struct berval *rdn, ConfigOCs *main, ConfigOCs *extra );
 190
 191 int config_shadow( ConfigArgs *c, int flag );
 192 #define config_slurp_shadow(c)  config_shadow((c), SLAP_DBFLAG_SLURP_SHADOW)
 193 #define config_sync_shadow(c)   config_shadow((c), SLAP_DBFLAG_SYNC_SHADOW)
 194
 195         /* Make sure we don't exceed the bits reserved for userland */
 196 #define config_check_userland(last) \
 197         assert( ( ( (last) - 1 ) & ARGS_USERLAND ) == ( (last) - 1 ) );
 198
 199 #define SLAP_X_ORDERED_FMT      "{%d}"
 200
 201 extern slap_verbmasks *slap_ldap_response_code;
 202 extern int slap_ldap_response_code_register( struct berval *bv, int err );
 203
 204 LDAP_END_DECL
 205
 206 #endif /* CONFIG_H */