source4/lib/ldb/include/ldb.h

   1 /*
   2    ldb database library
   3
   4    Copyright (C) Andrew Tridgell  2004
   5    Copyright (C) Stefan Metzmacher  2004
   6
   7      ** NOTE! The following LGPL license applies to the ldb
   8      ** library. This does NOT imply that all of Samba is released
   9      ** under the LGPL
  10
  11    This library is free software; you can redistribute it and/or
  12    modify it under the terms of the GNU Lesser General Public
  13    License as published by the Free Software Foundation; either
  14    version 2 of the License, or (at your option) any later version.
  15
  16    This library is distributed in the hope that it will be useful,
  17    but WITHOUT ANY WARRANTY; without even the implied warranty of
  18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19    Lesser General Public License for more details.
  20
  21    You should have received a copy of the GNU Lesser General Public
  22    License along with this library; if not, write to the Free Software
  23    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  24 */
  25
  26 /*
  27  *  Name: ldb
  28  *
  29  *  Component: ldb header
  30  *
  31  *  Description: defines for base ldb API
  32  *
  33  *  Author: Andrew Tridgell
  34  *  Author: Stefan Metzmacher
  35  */
  36
  37 #ifndef _LDB_H_
  38 #define _LDB_H_ 1
  39
  40 /*
  41   major restrictions as compared to normal LDAP:
  42
  43      - no async calls.
  44      - each record must have a unique key field
  45      - the key must be representable as a NULL terminated C string and may not
  46        contain a comma or braces
  47
  48   major restrictions as compared to tdb:
  49
  50      - no explicit locking calls
  51
  52 */
  53
  54 /*
  55   an individual lump of data in a result comes in this format. The
  56   pointer will usually be to a UTF-8 string if the application is
  57   sensible, but it can be to anything you like, including binary data
  58   blobs of arbitrary size.
  59 */
  60 struct ldb_val {
  61         unsigned int length;
  62         void *data;
  63 };
  64
  65 /* these flags are used in ldd_message_element.flags fields. The
  66    LDA_FLAGS_MOD_* flags are used in ldap_modify() calls to specify
  67    whether attributes are being added, deleted or modified */
  68 #define LDB_FLAG_MOD_MASK  0x3
  69 #define LDB_FLAG_MOD_ADD     1
  70 #define LDB_FLAG_MOD_REPLACE 2
  71 #define LDB_FLAG_MOD_DELETE  3
  72
  73
  74 /*
  75   results are given back as arrays of ldb_message_element
  76 */
  77 struct ldb_message_element {
  78         unsigned int flags;
  79         char *name;
  80         unsigned int num_values;
  81         struct ldb_val *values;
  82 };
  83
  84
  85 /*
  86   a ldb_message represents all or part of a record. It can contain an arbitrary
  87   number of elements.
  88 */
  89 struct ldb_message {
  90         char *dn;
  91         unsigned int num_elements;
  92         struct ldb_message_element *elements;
  93         void *private_data; /* private to the backend */
  94 };
  95
  96 enum ldb_changetype {
  97         LDB_CHANGETYPE_NONE=0,
  98         LDB_CHANGETYPE_ADD,
  99         LDB_CHANGETYPE_DELETE,
 100         LDB_CHANGETYPE_MODIFY
 101 };
 102
 103 /*
 104   a ldif record - from ldif_read
 105 */
 106 struct ldb_ldif {
 107         enum ldb_changetype changetype;
 108         struct ldb_message *msg;
 109 };
 110
 111 enum ldb_scope {LDB_SCOPE_DEFAULT=-1,
 112                 LDB_SCOPE_BASE=0,
 113                 LDB_SCOPE_ONELEVEL=1,
 114                 LDB_SCOPE_SUBTREE=2};
 115
 116 struct ldb_context;
 117
 118 /*
 119   the fuction type for the callback used in traversing the database
 120 */
 121 typedef int (*ldb_traverse_fn)(struct ldb_context *, const struct ldb_message *);
 122
 123
 124 struct ldb_module;
 125
 126 /* debugging uses one of the following levels */
 127 enum ldb_debug_level {LDB_DEBUG_FATAL, LDB_DEBUG_ERROR,
 128                       LDB_DEBUG_WARNING, LDB_DEBUG_TRACE};
 129
 130 /*
 131   the user can optionally supply a debug function. The function
 132   is based on the vfprintf() style of interface, but with the addition
 133   of a severity level
 134 */
 135 struct ldb_debug_ops {
 136         void (*debug)(void *context, enum ldb_debug_level level,
 137                       const char *fmt, va_list ap);
 138         void *context;
 139 };
 140
 141 #define LDB_FLG_RDONLY 1
 142
 143 /*
 144  connect to a database. The URL can either be one of the following forms
 145    ldb://path
 146    ldapi://path
 147
 148    flags is made up of LDB_FLG_*
 149
 150    the options are passed uninterpreted to the backend, and are
 151    backend specific
 152 */
 153 struct ldb_context *ldb_connect(const char *url, unsigned int flags,
 154                                 const char *options[]);
 155
 156 /*
 157   close the connection to the database
 158 */
 159 int ldb_close(struct ldb_context *ldb);
 160
 161
 162 /*
 163   search the database given a LDAP-like search expression
 164
 165   return the number of records found, or -1 on error
 166 */
 167 int ldb_search(struct ldb_context *ldb,
 168                const char *base,
 169                enum ldb_scope scope,
 170                const char *expression,
 171                const char * const *attrs, struct ldb_message ***res);
 172
 173 /*
 174    free a set of messages returned by ldb_search
 175 */
 176 int ldb_search_free(struct ldb_context *ldb, struct ldb_message **msgs);
 177
 178
 179 /*
 180   add a record to the database. Will fail if a record with the given class and key
 181   already exists
 182 */
 183 int ldb_add(struct ldb_context *ldb,
 184             const struct ldb_message *message);
 185
 186 /*
 187   modify the specified attributes of a record
 188 */
 189 int ldb_modify(struct ldb_context *ldb,
 190                const struct ldb_message *message);
 191
 192 /*
 193   rename a record in the database
 194 */
 195 int ldb_rename(struct ldb_context *ldb, const char *olddn, const char *newdn);
 196
 197 /*
 198   delete a record from the database
 199 */
 200 int ldb_delete(struct ldb_context *ldb, const char *dn);
 201
 202
 203 /*
 204   return extended error information from the last call
 205 */
 206 const char *ldb_errstring(struct ldb_context *ldb);
 207
 208 /*
 209   casefold a string (should be UTF8, but at the moment it isn't)
 210 */
 211 char *ldb_casefold(struct ldb_context *ldb, const char *s);
 212
 213 /*
 214   ldif manipulation functions
 215 */
 216 int ldb_ldif_write(struct ldb_context *ldb,
 217                    int (*fprintf_fn)(void *, const char *, ...),
 218                    void *private_data,
 219                    const struct ldb_ldif *ldif);
 220 void ldb_ldif_read_free(struct ldb_context *ldb, struct ldb_ldif *);
 221 struct ldb_ldif *ldb_ldif_read(struct ldb_context *ldb,
 222                                int (*fgetc_fn)(void *), void *private_data);
 223 struct ldb_ldif *ldb_ldif_read_file(struct ldb_context *ldb, FILE *f);
 224 struct ldb_ldif *ldb_ldif_read_string(struct ldb_context *ldb, const char *s);
 225 int ldb_ldif_write_file(struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg);
 226
 227
 228 /* useful functions for ldb_message structure manipulation */
 229
 230 int ldb_dn_cmp(const char *dn1, const char *dn2);
 231 int ldb_attr_cmp(const char *dn1, const char *dn2);
 232
 233 /* create an empty message */
 234 struct ldb_message *ldb_msg_new(void *mem_ctx);
 235
 236 /* find an element within an message */
 237 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg,
 238                                                  const char *attr_name);
 239
 240 /* compare two ldb_val values - return 0 on match */
 241 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2);
 242
 243 /* find a value within an ldb_message_element */
 244 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el,
 245                                  struct ldb_val *val);
 246
 247 /* add a new empty element to a ldb_message */
 248 int ldb_msg_add_empty(struct ldb_context *ldb,
 249                       struct ldb_message *msg, const char *attr_name, int flags);
 250
 251 /* add a element to a ldb_message */
 252 int ldb_msg_add(struct ldb_context *ldb,
 253                 struct ldb_message *msg,
 254                 const struct ldb_message_element *el,
 255                 int flags);
 256 int ldb_msg_add_value(struct ldb_context *ldb,
 257                       struct ldb_message *msg,
 258                       const char *attr_name,
 259                       const struct ldb_val *val);
 260 int ldb_msg_add_string(struct ldb_context *ldb, struct ldb_message *msg,
 261                        const char *attr_name, char *str);
 262
 263 /* compare two message elements - return 0 on match */
 264 int ldb_msg_element_compare(struct ldb_message_element *el1,
 265                             struct ldb_message_element *el2);
 266
 267 /* find elements in a message and convert to a specific type, with
 268    a give default value if not found. Assumes that elements are
 269    single valued */
 270 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name);
 271 int ldb_msg_find_int(const struct ldb_message *msg,
 272                      const char *attr_name,
 273                      int default_value);
 274 unsigned int ldb_msg_find_uint(const struct ldb_message *msg,
 275                                const char *attr_name,
 276                                unsigned int default_value);
 277 int64_t ldb_msg_find_int64(const struct ldb_message *msg,
 278                            const char *attr_name,
 279                            int64_t default_value);
 280 uint64_t ldb_msg_find_uint64(const struct ldb_message *msg,
 281                              const char *attr_name,
 282                              uint64_t default_value);
 283 double ldb_msg_find_double(const struct ldb_message *msg,
 284                            const char *attr_name,
 285                            double default_value);
 286 const char *ldb_msg_find_string(const struct ldb_message *msg,
 287                                 const char *attr_name,
 288                                 const char *default_value);
 289
 290 void ldb_msg_sort_elements(struct ldb_message *msg);
 291
 292 void ldb_msg_free(struct ldb_context *ldb, struct ldb_message *msg);
 293
 294 struct ldb_message *ldb_msg_copy(struct ldb_context *ldb,
 295                                  const struct ldb_message *msg);
 296
 297 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb,
 298                                          const struct ldb_message *msg);
 299
 300
 301 struct ldb_val ldb_val_dup(void *mem_ctx, const struct ldb_val *v);
 302
 303 #ifndef PRINTF_ATTRIBUTE
 304 #define PRINTF_ATTRIBUTE(a,b)
 305 #endif
 306
 307 /*
 308   this allows the user to set a debug function for error reporting
 309 */
 310 int ldb_set_debug(struct ldb_context *ldb,
 311                   void (*debug)(void *context, enum ldb_debug_level level,
 312                                 const char *fmt, va_list ap),
 313                   void *context);
 314
 315 /* this sets up debug to print messages on stderr */
 316 int ldb_set_debug_stderr(struct ldb_context *ldb);
 317
 318 #endif